Rename "singleton" pass to "uniquify"

This commit is contained in:
Clifford Wolf 2017-08-20 12:31:50 +02:00
parent d38a64b1cf
commit ca53fba44a
3 changed files with 22 additions and 21 deletions

View File

@ -1,5 +1,5 @@
OBJS += passes/hierarchy/hierarchy.o OBJS += passes/hierarchy/hierarchy.o
OBJS += passes/hierarchy/singleton.o OBJS += passes/hierarchy/uniquify.o
OBJS += passes/hierarchy/submod.o OBJS += passes/hierarchy/submod.o

View File

@ -22,28 +22,28 @@
USING_YOSYS_NAMESPACE USING_YOSYS_NAMESPACE
PRIVATE_NAMESPACE_BEGIN PRIVATE_NAMESPACE_BEGIN
struct SingletonPass : public Pass { struct UniquifyPass : public Pass {
SingletonPass() : Pass("singleton", "create singleton modules") { } UniquifyPass() : Pass("uniquify", "create unique copies of modules") { }
virtual void help() virtual void help()
{ {
// |---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---| // |---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|
log("\n"); log("\n");
log(" singleton [selection]\n"); log(" uniquify [selection]\n");
log("\n"); log("\n");
log("By default, a module that is instantiated by several other modules is only\n"); log("By default, a module that is instantiated by several other modules is only\n");
log("kept once in the design. This preserves the original modularity of the design\n"); log("kept once in the design. This preserves the original modularity of the design\n");
log("and reduces the overall size of the design in memory. But it prevents certain\n"); log("and reduces the overall size of the design in memory. But it prevents certain\n");
log("optimizations and other operations on the design. This pass creates singleton\n"); log("optimizations and other operations on the design. This pass creates unique\n");
log("modules for all selected cells. The created modules are marked with the\n"); log("modules for all selected cells. The created modules are marked with the\n");
log("'singleton' attribute.\n"); log("'unique' attribute.\n");
log("\n"); log("\n");
log("This commands only operates on modules that by themself have the 'singleton'\n"); log("This commands only operates on modules that by themself have the 'unique'\n");
log("attribute set (the 'top' module is a singleton implicitly).\n"); log("attribute set (the 'top' module is unique implicitly).\n");
log("\n"); log("\n");
} }
virtual void execute(std::vector<std::string> args, RTLIL::Design *design) virtual void execute(std::vector<std::string> args, RTLIL::Design *design)
{ {
log_header(design, "Executing SINGLETON pass (creating singleton modules).\n"); log_header(design, "Executing UNIQUIFY pass (creating unique copies of modules).\n");
size_t argidx; size_t argidx;
for (argidx = 1; argidx < args.size(); argidx++) for (argidx = 1; argidx < args.size(); argidx++)
@ -56,7 +56,7 @@ struct SingletonPass : public Pass {
extra_args(args, argidx, design); extra_args(args, argidx, design);
bool did_something = true; bool did_something = true;
int singleton_cnt = 0; int count = 0;
while (did_something) while (did_something)
{ {
@ -64,12 +64,13 @@ struct SingletonPass : public Pass {
for (auto module : design->selected_modules()) for (auto module : design->selected_modules())
{ {
if (!module->get_bool_attribute("\\singleton") && !module->get_bool_attribute("\\top")) if (!module->get_bool_attribute("\\unique") && !module->get_bool_attribute("\\top"))
continue; continue;
for (auto cell : module->selected_cells()) for (auto cell : module->selected_cells())
{ {
auto tmod = design->module(cell->type); Module *tmod = design->module(cell->type);
IdString newname = module->name.str() + "." + log_id(cell->name);
if (tmod == nullptr) if (tmod == nullptr)
continue; continue;
@ -77,25 +78,25 @@ struct SingletonPass : public Pass {
if (tmod->get_bool_attribute("\\blackbox")) if (tmod->get_bool_attribute("\\blackbox"))
continue; continue;
if (tmod->get_bool_attribute("\\singleton")) if (tmod->get_bool_attribute("\\unique") && newname == tmod->name)
continue; continue;
cell->type = module->name.str() + "." + log_id(cell->name); log("Creating module %s from %s.\n", log_id(newname), log_id(tmod));
log("Creating singleton '%s'.\n", log_id(cell->type));
auto smod = tmod->clone(); auto smod = tmod->clone();
smod->name = cell->type; smod->name = newname;
smod->set_bool_attribute("\\singleton"); cell->type = newname;
smod->set_bool_attribute("\\unique");
design->add(smod); design->add(smod);
did_something = true; did_something = true;
singleton_cnt++; count++;
} }
} }
} }
log("Created %d singleton modules.\n", singleton_cnt); log("Created %d unique modules.\n", count);
} }
} SingletonPass; } UniquifyPass;
PRIVATE_NAMESPACE_END PRIVATE_NAMESPACE_END

View File

@ -526,7 +526,7 @@ struct SimInstance
void writeback(pool<Module*> &wbmods) void writeback(pool<Module*> &wbmods)
{ {
if (wbmods.count(module)) if (wbmods.count(module))
log_error("Instance %s of module %s is not unique: Writeback not possible. (Fix by running 'singleton'.)\n", hiername().c_str(), log_id(module)); log_error("Instance %s of module %s is not unique: Writeback not possible. (Fix by running 'uniquify'.)\n", hiername().c_str(), log_id(module));
wbmods.insert(module); wbmods.insert(module);