#include <register.h>

Inherited by AbcPass, AddPass, AlumaccPass, Backend, CdPass, CleanPass, ConnectPass, ConnwrappersPass, CopyPass, CoverPass, DeletePass, DesignPass, Dff2dffePass, DfflibmapPass, DumpPass, EchoPass, EvalPass, ExposePass, ExtractPass, FlattenPass, FreducePass, Frontend, FsmDetectPass, FsmExpandPass, FsmExportPass, FsmExtractPass, FsmInfoPass, FsmMapPass, FsmOptPass, FsmPass, FsmRecodePass, HelpPass, HierarchyPass, HilomapPass, IopadmapPass, LogPass, LsPass, MaccmapPass, MemoryCollectPass, MemoryDffPass, MemoryMapPass, MemoryPass, MemorySharePass, MemoryUnpackPass, MiterPass, MyPass, OptCleanPass, OptConstPass, OptMuxtreePass, OptPass, OptReducePass, OptRmdffPass, OptSharePass, PluginPass, ProcArstPass, ProcCleanPass, ProcDffPass, ProcInitPass, ProcMuxPass, ProcPass, ProcRmdeadPass, RenamePass, SatPass, ScatterPass, SccPass, ScriptPass, SelectPass, SetattrPass, SetparamPass, SetundefPass, SharePass, ShellPass, ShowPass, SimplemapPass, SplicePass, SplitnetsPass, StatPass, StubnetsPass, SubmodPass, SynthPass, SynthXilinxPass, TechmapPass, TeePass, Test1Pass, Test2Pass, TestAbcloopPass, TestCellPass, TracePass, VerificPass, VerilogDefaults, Vhdl2verilogPass, and WreducePass.

Collaboration diagram for Pass:

Data Structures
struct	pre_post_exec_state_t

Public Member Functions
	Pass (std::string name, std::string short_help=" document me ")

virtual	~Pass ()

virtual void	help ()

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

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 27 of file register.h.

Constructor & Destructor Documentation

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

Definition at line 40 of file register.cc.

                                                : pass_name(name), short_help(short_help)
 {
     next_queued_pass = first_queued_pass;
     first_queued_pass = this;
     call_counter = 0;
     runtime_ns = 0;
 }

Pass::~Pass ( )

virtual

Definition at line 70 of file register.cc.

71 {

72 }

Member Function Documentation

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

static

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
	)

static

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
	)

static

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
	)

static

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
	)

static

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
	)

static

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
	)

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 )

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 ( )

static

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 Pass::execute	(	std::vector< std::string >	args,
		RTLIL::Design *	design
	)

pure virtual

Implemented in SharePass, LsPass, CdPass, AbcPass, FlattenPass, SelectPass, OptConstPass, VerificPass, ScriptPass, SatPass, ShellPass, TechmapPass, FreducePass, MemorySharePass, EchoPass, ShowPass, HelpPass, AlumaccPass, TestCellPass, DumpPass, DfflibmapPass, SimplemapPass, ExtractPass, OptMuxtreePass, FsmExtractPass, CleanPass, EvalPass, MaccmapPass, HierarchyPass, ProcDffPass, OptReducePass, FsmOptPass, MemoryMapPass, FsmMapPass, VerilogDefaults, WreducePass, OptCleanPass, OptSharePass, MiterPass, SubmodPass, SplicePass, ProcMuxPass, TestAbcloopPass, FsmExpandPass, ExposePass, SccPass, ProcArstPass, Dff2dffePass, MemoryCollectPass, MemoryDffPass, StatPass, ConnwrappersPass, OptRmdffPass, ProcCleanPass, SetparamPass, FsmExportPass, FsmDetectPass, FsmRecodePass, AddPass, MemoryUnpackPass, SynthXilinxPass, StubnetsPass, ProcInitPass, SplitnetsPass, Backend, SynthPass, CoverPass, DesignPass, SetundefPass, RenamePass, ConnectPass, SetattrPass, ProcRmdeadPass, HilomapPass, Frontend, Vhdl2verilogPass, PluginPass, TracePass, IopadmapPass, FsmPass, OptPass, LogPass, ProcPass, Test2Pass, TeePass, MemoryPass, ScatterPass, FsmInfoPass, DeletePass, CopyPass, Test1Pass, and MyPass.

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

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:

void Pass::help ( )

virtual

Reimplemented in SharePass, LsPass, CdPass, FlattenPass, VerilogBackend, BtorBackend, AbcPass, ScriptPass, OptConstPass, ShellPass, SelectPass, SatPass, VerificPass, TechmapPass, FreducePass, MemorySharePass, EchoPass, ShowPass, AlumaccPass, HelpPass, TestCellPass, DumpPass, DfflibmapPass, SimplemapPass, LibertyFrontend, OptMuxtreePass, IlangBackend, FsmExtractPass, CleanPass, MaccmapPass, EvalPass, ProcDffPass, ExtractPass, OptReducePass, MemoryMapPass, FsmOptPass, FsmMapPass, WreducePass, HierarchyPass, OptCleanPass, TestAutotbBackend, VerilogDefaults, BlifBackend, OptSharePass, SubmodPass, ProcMuxPass, MiterPass, FsmExpandPass, TestAbcloopPass, SplicePass, ExposePass, Dff2dffePass, SccPass, ProcArstPass, MemoryCollectPass, MemoryDffPass, StatPass, ConnwrappersPass, OptRmdffPass, ProcCleanPass, SetparamPass, FsmDetectPass, FsmRecodePass, FsmExportPass, SpiceBackend, MemoryUnpackPass, EdifBackend, ProcInitPass, AddPass, SplitnetsPass, ProcRmdeadPass, SetattrPass, TracePass, SetundefPass, HilomapPass, PluginPass, RenamePass, IntersynthBackend, ConnectPass, VerilogFrontend, SynthPass, DesignPass, SynthXilinxPass, IlangFrontend, Vhdl2verilogPass, CoverPass, IopadmapPass, FsmInfoPass, LogPass, ScatterPass, TeePass, FsmPass, MemoryPass, OptPass, ProcPass, CopyPass, WriteFileFrontend, and DeletePass.

Definition at line 93 of file register.cc.

 {
     log("\n");
     log("No help message for command `%s'.\n", pass_name.c_str());
     log("\n");
 }

Here is the call graph for this function:

Here is the caller graph for this function:

void Pass::init_register ( )

static

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 )

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 ( )

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 ( )

virtual

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

Definition at line 36 of file register.h.

Pass* Pass::next_queued_pass

Definition at line 60 of file register.h.

std::string Pass::pass_name

Definition at line 29 of file register.h.

int64_t Pass::runtime_ns

Definition at line 37 of file register.h.

std::string Pass::short_help

Definition at line 29 of file register.h.

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

Data Structures

Public Member Functions

Static Public Member Functions

Data Fields

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation