Inheritance diagram for AbcPass:

Collaboration diagram for AbcPass:

Public Member Functions
	AbcPass ()

virtual void	help ()

virtual void	execute (std::vector< std::string > args, RTLIL::Design *design)

pre_post_exec_state_t	pre_execute ()

void	post_execute (pre_post_exec_state_t state)

void	cmd_log_args (const std::vector< std::string > &args)

void	cmd_error (const std::vector< std::string > &args, size_t argidx, std::string msg)

void	extra_args (std::vector< std::string > args, size_t argidx, RTLIL::Design *design, bool select=true)

virtual void	run_register ()

Static Public Member Functions
static void	call (RTLIL::Design *design, std::string command)

static void	call (RTLIL::Design *design, std::vector< std::string > args)

static void	call_on_selection (RTLIL::Design *design, const RTLIL::Selection &selection, std::string command)

static void	call_on_selection (RTLIL::Design *design, const RTLIL::Selection &selection, std::vector< std::string > args)

static void	call_on_module (RTLIL::Design design, RTLIL::Module module, std::string command)

static void	call_on_module (RTLIL::Design design, RTLIL::Module module, std::vector< std::string > args)

static void	init_register ()

static void	done_register ()

Data Fields
std::string	pass_name

std::string	short_help

int	call_counter

int64_t	runtime_ns

Pass *	next_queued_pass

Detailed Description

Definition at line 997 of file abc.cc.

Constructor & Destructor Documentation

AbcPass::AbcPass ( )

inline

Definition at line 998 of file abc.cc.

998 : Pass("abc", "use ABC for technology mapping") { }

Pass::Pass

Pass(std::string name, std::string short_help="** document me **")

Definition: register.cc:40

Member Function Documentation

void Pass::call	(	RTLIL::Design *	design,
		std::string	command
	)

staticinherited

Definition at line 146 of file register.cc.

 {
     std::vector<std::string> args;
 
     std::string cmd_buf = command;
     std::string tok = next_token(cmd_buf, " \t\r\n");
 
     if (tok.empty() || tok[0] == '#')
         return;
 
     if (tok[0] == '!') {
         cmd_buf = command.substr(command.find('!') + 1);
         while (!cmd_buf.empty() && (cmd_buf.back() == ' ' || cmd_buf.back() == '\t' ||
                 cmd_buf.back() == '\r' || cmd_buf.back() == '\n'))
             cmd_buf.resize(cmd_buf.size()-1);
         log_header("Shell command: %s\n", cmd_buf.c_str());
         int retCode = run_command(cmd_buf);
         if (retCode != 0)
             log_cmd_error("Shell command returned error code %d.\n", retCode);
         return;
     }
 
     while (!tok.empty()) {
         if (tok == "#")
             break;
         if (tok.back() == ';') {
             int num_semikolon = 0;
             while (!tok.empty() && tok.back() == ';')
                 tok.resize(tok.size()-1), num_semikolon++;
             if (!tok.empty())
                 args.push_back(tok);
             call(design, args);
             args.clear();
             if (num_semikolon == 2)
                 call(design, "clean");
             if (num_semikolon == 3)
                 call(design, "clean -purge");
         } else
             args.push_back(tok);
         tok = next_token(cmd_buf, " \t\r\n");
     }
 
     call(design, args);
 }

Here is the call graph for this function:

Here is the caller graph for this function:

void Pass::call	(	RTLIL::Design *	design,
		std::vector< std::string >	args
	)

staticinherited

Definition at line 191 of file register.cc.

 {
     if (args.size() == 0 || args[0][0] == '#')
         return;
 
     if (echo_mode) {
         log("%s", create_prompt(design, 0));
         for (size_t i = 0; i < args.size(); i++)
             log("%s%s", i ? " " : "", args[i].c_str());
         log("\n");
     }
 
     if (pass_register.count(args[0]) == 0)
         log_cmd_error("No such command: %s (type 'help' for a command overview)\n", args[0].c_str());
 
     size_t orig_sel_stack_pos = design->selection_stack.size();
     auto state = pass_register[args[0]]->pre_execute();
     pass_register[args[0]]->execute(args, design);
     pass_register[args[0]]->post_execute(state);
     while (design->selection_stack.size() > orig_sel_stack_pos)
         design->selection_stack.pop_back();
 
     design->check();
 }

Here is the call graph for this function:

void Pass::call_on_module	(	RTLIL::Design *	design,
		RTLIL::Module *	module,
		std::string	command
	)

staticinherited

Definition at line 240 of file register.cc.

 {
     std::string backup_selected_active_module = design->selected_active_module;
     design->selected_active_module = module->name.str();
     design->selection_stack.push_back(RTLIL::Selection(false));
     design->selection_stack.back().select(module);
 
     Pass::call(design, command);
 
     design->selection_stack.pop_back();
     design->selected_active_module = backup_selected_active_module;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

void Pass::call_on_module	(	RTLIL::Design *	design,
		RTLIL::Module *	module,
		std::vector< std::string >	args
	)

staticinherited

Definition at line 253 of file register.cc.

 {
     std::string backup_selected_active_module = design->selected_active_module;
     design->selected_active_module = module->name.str();
     design->selection_stack.push_back(RTLIL::Selection(false));
     design->selection_stack.back().select(module);
 
     Pass::call(design, args);
 
     design->selection_stack.pop_back();
     design->selected_active_module = backup_selected_active_module;
 }

Here is the call graph for this function:

void Pass::call_on_selection	(	RTLIL::Design *	design,
		const RTLIL::Selection &	selection,
		std::string	command
	)

staticinherited

Definition at line 216 of file register.cc.

 {
     std::string backup_selected_active_module = design->selected_active_module;
     design->selected_active_module.clear();
     design->selection_stack.push_back(selection);
 
     Pass::call(design, command);
 
     design->selection_stack.pop_back();
     design->selected_active_module = backup_selected_active_module;
 }

Here is the call graph for this function:

void Pass::call_on_selection	(	RTLIL::Design *	design,
		const RTLIL::Selection &	selection,
		std::vector< std::string >	args
	)

staticinherited

Definition at line 228 of file register.cc.

 {
     std::string backup_selected_active_module = design->selected_active_module;
     design->selected_active_module.clear();
     design->selection_stack.push_back(selection);
 
     Pass::call(design, args);
 
     design->selection_stack.pop_back();
     design->selected_active_module = backup_selected_active_module;
 }

Here is the call graph for this function:

void Pass::cmd_error	(	const std::vector< std::string > &	args,
		size_t	argidx,
		std::string	msg
	)

inherited

Definition at line 110 of file register.cc.

 {
     std::string command_text;
     int error_pos = 0;
 
     for (size_t i = 0; i < args.size(); i++) {
         if (i < argidx)
             error_pos += args[i].size() + 1;
         command_text = command_text + (command_text.empty() ? "" : " ") + args[i];
     }
 
     log("\nSyntax error in command `%s':\n", command_text.c_str());
     help();
 
     log_cmd_error("Command syntax error: %s\n> %s\n> %*s^\n",
             msg.c_str(), command_text.c_str(), error_pos, "");
 }

Here is the call graph for this function:

Here is the caller graph for this function:

void Pass::cmd_log_args ( const std::vector< std::string > & args )

inherited

Definition at line 100 of file register.cc.

 {
     if (args.size() <= 1)
         return;
     log("Full command line:");
     for (size_t i = 0; i < args.size(); i++)
         log(" %s", args[i].c_str());
     log("\n");
 }

Here is the call graph for this function:

void Pass::done_register ( )

staticinherited

Definition at line 62 of file register.cc.

 {
     frontend_register.clear();
     pass_register.clear();
     backend_register.clear();
     log_assert(first_queued_pass == NULL);
 }

Here is the caller graph for this function:

virtual void AbcPass::execute	(	std::vector< std::string >	args,
		RTLIL::Design *	design
	)

inlinevirtual

Implements Pass.

Definition at line 1099 of file abc.cc.

     {
         log_header("Executing ABC pass (technology mapping using ABC).\n");
         log_push();
 
         std::string exe_file = proc_self_dirname() + "yosys-abc";
         std::string script_file, liberty_file, constr_file, clk_str, delay_target;
         bool fast_mode = false, dff_mode = false, keepff = false, cleanup = true;
         int lut_mode = 0;
 
 #ifdef _WIN32
         if (!check_file_exists(exe_file + ".exe") && check_file_exists(proc_self_dirname() + "..\\yosys-abc.exe"))
             exe_file = proc_self_dirname() + "..\\yosys-abc";
 #endif
 
         size_t argidx;
         char pwd [PATH_MAX];
         if (!getcwd(pwd, sizeof(pwd))) {
             log_cmd_error("getcwd failed: %s\n", strerror(errno));
             log_abort();
         }
         for (argidx = 1; argidx < args.size(); argidx++) {
             std::string arg = args[argidx];
             if (arg == "-exe" && argidx+1 < args.size()) {
                 exe_file = args[++argidx];
                 continue;
             }
             if (arg == "-script" && argidx+1 < args.size()) {
                 script_file = args[++argidx];
                 if (!script_file.empty() && script_file[0] != '/' && script_file[0] != '+')
                     script_file = std::string(pwd) + "/" + script_file;
                 continue;
             }
             if (arg == "-liberty" && argidx+1 < args.size()) {
                 liberty_file = args[++argidx];
                 if (!liberty_file.empty() && liberty_file[0] != '/')
                     liberty_file = std::string(pwd) + "/" + liberty_file;
                 continue;
             }
             if (arg == "-constr" && argidx+1 < args.size()) {
                 constr_file = args[++argidx];
                 if (!constr_file.empty() && constr_file[0] != '/')
                     constr_file = std::string(pwd) + "/" + constr_file;
                 continue;
             }
             if (arg == "-D" && argidx+1 < args.size()) {
                 delay_target = "-D " + args[++argidx];
                 continue;
             }
             if (arg == "-lut" && argidx+1 < args.size()) {
                 lut_mode = atoi(args[++argidx].c_str());
                 continue;
             }
             if (arg == "-fast") {
                 fast_mode = true;
                 continue;
             }
             if (arg == "-dff") {
                 dff_mode = true;
                 continue;
             }
             if (arg == "-clk" && argidx+1 < args.size()) {
                 clk_str = args[++argidx];
                 continue;
             }
             if (arg == "-keepff") {
                 keepff = true;
                 continue;
             }
             if (arg == "-nocleanup") {
                 cleanup = false;
                 continue;
             }
             break;
         }
         extra_args(args, argidx, design);
 
         if (lut_mode != 0 && !liberty_file.empty())
             log_cmd_error("Got -lut and -liberty! This two options are exclusive.\n");
         if (!constr_file.empty() && liberty_file.empty())
             log_cmd_error("Got -constr but no -liberty!\n");
 
         for (auto &mod_it : design->modules_)
             if (design->selected(mod_it.second)) {
                 if (mod_it.second->processes.size() > 0)
                     log("Skipping module %s as it contains processes.\n", mod_it.second->name.c_str());
                 else
                     abc_module(design, mod_it.second, script_file, exe_file, liberty_file, constr_file, cleanup, lut_mode, dff_mode, clk_str, keepff, delay_target, fast_mode);
             }
 
         assign_map.clear();
         signal_list.clear();
         signal_map.clear();
 
         log_pop();
     }

Here is the call graph for this function:

void Pass::extra_args	(	std::vector< std::string >	args,
		size_t	argidx,
		RTLIL::Design *	design,
		bool	select = `true`
	)

inherited

Definition at line 128 of file register.cc.

 {
     for (; argidx < args.size(); argidx++)
     {
         std::string arg = args[argidx];
 
         if (arg.substr(0, 1) == "-")
             cmd_error(args, argidx, "Unknown option or option in arguments.");
 
         if (!select)
             cmd_error(args, argidx, "Extra argument.");
 
         handle_extra_select_args(this, args, argidx, args.size(), design);
         break;
     }
     // cmd_log_args(args);
 }

Here is the call graph for this function:

virtual void AbcPass::help ( )

inlinevirtual

Reimplemented from Pass.

Definition at line 999 of file abc.cc.

     {
         //   |---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|
         log("\n");
         log("    abc [options] [selection]\n");
         log("\n");
         log("This pass uses the ABC tool [1] for technology mapping of yosys's internal gate\n");
         log("library to a target architecture.\n");
         log("\n");
         log("    -exe <command>\n");
         log("        use the specified command name instead of \"yosys-abc\" to execute ABC.\n");
         log("        This can e.g. be used to call a specific version of ABC or a wrapper.\n");
         log("\n");
         log("    -script <file>\n");
         log("        use the specified ABC script file instead of the default script.\n");
         log("\n");
         log("        if <file> starts with a plus sign (+), then the rest of the filename\n");
         log("        string is interprated as the command string to be passed to ABC. the\n");
         log("        leading plus sign is removed and all commas (,) in the string are\n");
         log("        replaced with blanks before the string is passed to ABC.\n");
         log("\n");
         log("        if no -script parameter is given, the following scripts are used:\n");
         log("\n");
         log("        for -liberty without -constr:\n");
         log("%s\n", fold_abc_cmd(ABC_COMMAND_LIB).c_str());
         log("\n");
         log("        for -liberty with -constr:\n");
         log("%s\n", fold_abc_cmd(ABC_COMMAND_CTR).c_str());
         log("\n");
         log("        for -lut:\n");
         log("%s\n", fold_abc_cmd(ABC_COMMAND_LUT).c_str());
         log("\n");
         log("        otherwise:\n");
         log("%s\n", fold_abc_cmd(ABC_COMMAND_DFL).c_str());
         log("\n");
         log("    -fast\n");
         log("        use different default scripts that are slightly faster (at the cost\n");
         log("        of output quality):\n");
         log("\n");
         log("        for -liberty without -constr:\n");
         log("%s\n", fold_abc_cmd(ABC_FAST_COMMAND_LIB).c_str());
         log("\n");
         log("        for -liberty with -constr:\n");
         log("%s\n", fold_abc_cmd(ABC_FAST_COMMAND_CTR).c_str());
         log("\n");
         log("        for -lut:\n");
         log("%s\n", fold_abc_cmd(ABC_FAST_COMMAND_LUT).c_str());
         log("\n");
         log("        otherwise:\n");
         log("%s\n", fold_abc_cmd(ABC_FAST_COMMAND_DFL).c_str());
         log("\n");
         log("    -liberty <file>\n");
         log("        generate netlists for the specified cell library (using the liberty\n");
         log("        file format).\n");
         log("\n");
         log("    -constr <file>\n");
         log("        pass this file with timing constraints to ABC. use with -liberty.\n");
         log("\n");
         log("        a constr file contains two lines:\n");
         log("            set_driving_cell <cell_name>\n");
         log("            set_load <floating_point_number>\n");
         log("\n");
         log("        the set_driving_cell statement defines which cell type is assumed to\n");
         log("        drive the primary inputs and the set_load statement sets the load in\n");
         log("        femtofarads for each primary output.\n");
         log("\n");
         log("    -D <picoseconds>\n");
         log("        set delay target. the string {D} in the default scripts above is\n");
         log("        replaced by this option when used, and an empty string otherwise.\n");
         log("\n");
         log("    -lut <width>\n");
         log("        generate netlist using luts of (max) the specified width.\n");
         log("\n");
         log("    -dff\n");
         log("        also pass $_DFF_?_ cells through ABC (only one clock domain, if many\n");
         log("        clock domains are present in a module, the one with the largest number\n");
         log("        of $_DFF_?_ cells in it is used)\n");
         log("\n");
         log("    -clk [!]<signal-name>\n");
         log("        use the specified clock domain. (when this option is used in combination\n");
         log("        with -dff, then it falls back to the automatic dection of clock domain\n");
         log("        if the specified clock is not found in a module.)\n");
         log("\n");
         log("    -keepff\n");
         log("        set the \"keep\" attribute on flip-flop output wires. (and thus preserve\n");
         log("        them, for example for equivialence checking.)\n");
         log("\n");
         log("    -nocleanup\n");
         log("        when this option is used, the temporary files created by this pass\n");
         log("        are not removed. this is useful for debugging.\n");
         log("\n");
         log("When neither -liberty nor -lut is used, the Yosys standard cell library is\n");
         log("loaded into ABC before the ABC script is executed.\n");
         log("\n");
         log("This pass does not operate on modules with unprocessed processes in it.\n");
         log("(I.e. the 'proc' pass should be used first to convert processes to netlists.)\n");
         log("\n");
         log("[1] http://www.eecs.berkeley.edu/~alanmi/abc/\n");
         log("\n");
     }

Here is the call graph for this function:

void Pass::init_register ( )

staticinherited

Definition at line 54 of file register.cc.

 {
     while (first_queued_pass) {
         first_queued_pass->run_register();
         first_queued_pass = first_queued_pass->next_queued_pass;
     }
 }

Here is the call graph for this function:

Here is the caller graph for this function:

void Pass::post_execute ( Pass::pre_post_exec_state_t state )

inherited

Definition at line 84 of file register.cc.

 {
     int64_t time_ns = PerformanceTimer::query() - state.begin_ns;
     runtime_ns += time_ns;
     current_pass = state.parent_pass;
     if (current_pass)
         current_pass->runtime_ns -= time_ns;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

Pass::pre_post_exec_state_t Pass::pre_execute ( )

inherited

Definition at line 74 of file register.cc.

 {
     pre_post_exec_state_t state;
     call_counter++;
     state.begin_ns = PerformanceTimer::query();
     state.parent_pass = current_pass;
     current_pass = this;
     return state;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

void Pass::run_register ( )

virtualinherited

Reimplemented in Backend, and Frontend.

Definition at line 48 of file register.cc.

 {
     log_assert(pass_register.count(pass_name) == 0);
     pass_register[pass_name] = this;
 }

Here is the caller graph for this function:

Field Documentation

int Pass::call_counter

inherited

Definition at line 36 of file register.h.

Pass* Pass::next_queued_pass

inherited

Definition at line 60 of file register.h.

std::string Pass::pass_name

inherited

Definition at line 29 of file register.h.

int64_t Pass::runtime_ns

inherited

Definition at line 37 of file register.h.

std::string Pass::short_help

inherited

Definition at line 29 of file register.h.

The documentation for this struct was generated from the following file:

abc.cc

Public Member Functions

Static Public Member Functions

Data Fields

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation