yosys-master
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Public Member Functions | Static Public Member Functions | Data Fields
CdPass Struct Reference
+ Inheritance diagram for CdPass:
+ Collaboration diagram for CdPass:

Public Member Functions

 CdPass ()
 
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 1274 of file select.cc.

Constructor & Destructor Documentation

CdPass::CdPass ( )
inline

Definition at line 1275 of file select.cc.

1275 : Pass("cd", "a shortcut for 'select -module <name>'") { }
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.

147 {
148  std::vector<std::string> args;
149 
150  std::string cmd_buf = command;
151  std::string tok = next_token(cmd_buf, " \t\r\n");
152 
153  if (tok.empty() || tok[0] == '#')
154  return;
155 
156  if (tok[0] == '!') {
157  cmd_buf = command.substr(command.find('!') + 1);
158  while (!cmd_buf.empty() && (cmd_buf.back() == ' ' || cmd_buf.back() == '\t' ||
159  cmd_buf.back() == '\r' || cmd_buf.back() == '\n'))
160  cmd_buf.resize(cmd_buf.size()-1);
161  log_header("Shell command: %s\n", cmd_buf.c_str());
162  int retCode = run_command(cmd_buf);
163  if (retCode != 0)
164  log_cmd_error("Shell command returned error code %d.\n", retCode);
165  return;
166  }
167 
168  while (!tok.empty()) {
169  if (tok == "#")
170  break;
171  if (tok.back() == ';') {
172  int num_semikolon = 0;
173  while (!tok.empty() && tok.back() == ';')
174  tok.resize(tok.size()-1), num_semikolon++;
175  if (!tok.empty())
176  args.push_back(tok);
177  call(design, args);
178  args.clear();
179  if (num_semikolon == 2)
180  call(design, "clean");
181  if (num_semikolon == 3)
182  call(design, "clean -purge");
183  } else
184  args.push_back(tok);
185  tok = next_token(cmd_buf, " \t\r\n");
186  }
187 
188  call(design, args);
189 }
next_token
static std::string next_token(bool pass_newline=false)
Definition: preproc.cc:96
log_header
void log_header(const char *format,...)
Definition: log.cc:188
run_command
int run_command(const std::string &command, std::function< void(const std::string &)> process_line)
Definition: yosys.cc:195
log_cmd_error
void log_cmd_error(const char *format,...)
Definition: log.cc:211
Pass::call
static void call(RTLIL::Design *design, std::string command)
Definition: register.cc:146

+ 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.

192 {
193  if (args.size() == 0 || args[0][0] == '#')
194  return;
195 
196  if (echo_mode) {
197  log("%s", create_prompt(design, 0));
198  for (size_t i = 0; i < args.size(); i++)
199  log("%s%s", i ? " " : "", args[i].c_str());
200  log("\n");
201  }
202 
203  if (pass_register.count(args[0]) == 0)
204  log_cmd_error("No such command: %s (type 'help' for a command overview)\n", args[0].c_str());
205 
206  size_t orig_sel_stack_pos = design->selection_stack.size();
207  auto state = pass_register[args[0]]->pre_execute();
208  pass_register[args[0]]->execute(args, design);
209  pass_register[args[0]]->post_execute(state);
210  while (design->selection_stack.size() > orig_sel_stack_pos)
211  design->selection_stack.pop_back();
212 
213  design->check();
214 }
echo_mode
bool echo_mode
Definition: register.cc:30
RTLIL::Design::selection_stack
std::vector< RTLIL::Selection > selection_stack
Definition: rtlil.h:509
create_prompt
const char * create_prompt(RTLIL::Design *design, int recursion_counter)
Definition: yosys.cc:400
RTLIL::Design::check
void check()
Definition: rtlil.cc:357
log_cmd_error
void log_cmd_error(const char *format,...)
Definition: log.cc:211
log
void log(const char *format,...)
Definition: log.cc:180
pass_register
std::map< std::string, Pass * > pass_register
Definition: register.cc:35

+ 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.

241 {
242  std::string backup_selected_active_module = design->selected_active_module;
243  design->selected_active_module = module->name.str();
244  design->selection_stack.push_back(RTLIL::Selection(false));
245  design->selection_stack.back().select(module);
246 
247  Pass::call(design, command);
248 
249  design->selection_stack.pop_back();
250  design->selected_active_module = backup_selected_active_module;
251 }
RTLIL::IdString::str
std::string str() const
Definition: rtlil.h:182
RTLIL::Design::selection_stack
std::vector< RTLIL::Selection > selection_stack
Definition: rtlil.h:509
RTLIL::Module::name
RTLIL::IdString name
Definition: rtlil.h:599
RTLIL::Design::selected_active_module
std::string selected_active_module
Definition: rtlil.h:511
Pass::call
static void call(RTLIL::Design *design, std::string command)
Definition: register.cc:146

+ 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.

254 {
255  std::string backup_selected_active_module = design->selected_active_module;
256  design->selected_active_module = module->name.str();
257  design->selection_stack.push_back(RTLIL::Selection(false));
258  design->selection_stack.back().select(module);
259 
260  Pass::call(design, args);
261 
262  design->selection_stack.pop_back();
263  design->selected_active_module = backup_selected_active_module;
264 }
RTLIL::IdString::str
std::string str() const
Definition: rtlil.h:182
RTLIL::Design::selection_stack
std::vector< RTLIL::Selection > selection_stack
Definition: rtlil.h:509
RTLIL::Module::name
RTLIL::IdString name
Definition: rtlil.h:599
RTLIL::Design::selected_active_module
std::string selected_active_module
Definition: rtlil.h:511
Pass::call
static void call(RTLIL::Design *design, std::string command)
Definition: register.cc:146

+ 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.

217 {
218  std::string backup_selected_active_module = design->selected_active_module;
219  design->selected_active_module.clear();
220  design->selection_stack.push_back(selection);
221 
222  Pass::call(design, command);
223 
224  design->selection_stack.pop_back();
225  design->selected_active_module = backup_selected_active_module;
226 }
RTLIL::Design::selection_stack
std::vector< RTLIL::Selection > selection_stack
Definition: rtlil.h:509
RTLIL::Design::selected_active_module
std::string selected_active_module
Definition: rtlil.h:511
Pass::call
static void call(RTLIL::Design *design, std::string command)
Definition: register.cc:146

+ 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.

229 {
230  std::string backup_selected_active_module = design->selected_active_module;
231  design->selected_active_module.clear();
232  design->selection_stack.push_back(selection);
233 
234  Pass::call(design, args);
235 
236  design->selection_stack.pop_back();
237  design->selected_active_module = backup_selected_active_module;
238 }
RTLIL::Design::selection_stack
std::vector< RTLIL::Selection > selection_stack
Definition: rtlil.h:509
RTLIL::Design::selected_active_module
std::string selected_active_module
Definition: rtlil.h:511
Pass::call
static void call(RTLIL::Design *design, std::string command)
Definition: register.cc:146

+ 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.

111 {
112  std::string command_text;
113  int error_pos = 0;
114 
115  for (size_t i = 0; i < args.size(); i++) {
116  if (i < argidx)
117  error_pos += args[i].size() + 1;
118  command_text = command_text + (command_text.empty() ? "" : " ") + args[i];
119  }
120 
121  log("\nSyntax error in command `%s':\n", command_text.c_str());
122  help();
123 
124  log_cmd_error("Command syntax error: %s\n> %s\n> %*s^\n",
125  msg.c_str(), command_text.c_str(), error_pos, "");
126 }
Pass::help
virtual void help()
Definition: register.cc:93
log_cmd_error
void log_cmd_error(const char *format,...)
Definition: log.cc:211
log
void log(const char *format,...)
Definition: log.cc:180

+ 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.

101 {
102  if (args.size() <= 1)
103  return;
104  log("Full command line:");
105  for (size_t i = 0; i < args.size(); i++)
106  log(" %s", args[i].c_str());
107  log("\n");
108 }
log
void log(const char *format,...)
Definition: log.cc:180

+ Here is the call graph for this function:

void Pass::done_register ( )
staticinherited

Definition at line 62 of file register.cc.

63 {
64  frontend_register.clear();
65  pass_register.clear();
66  backend_register.clear();
67  log_assert(first_queued_pass == NULL);
68 }
frontend_register
std::map< std::string, Frontend * > frontend_register
Definition: register.cc:34
first_queued_pass
Pass * first_queued_pass
Definition: register.cc:31
log_assert
#define log_assert(_assert_expr_)
Definition: log.h:85
NULL
#define NULL
Definition: NumberlikeArray.hh:6
pass_register
std::map< std::string, Pass * > pass_register
Definition: register.cc:35
backend_register
std::map< std::string, Backend * > backend_register
Definition: register.cc:36

+ Here is the caller graph for this function:

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

Implements Pass.

Definition at line 1296 of file select.cc.

1297  {
1298  if (args.size() != 2)
1299  log_cmd_error("Invalid number of arguments.\n");
1300 
1301  if (args[1] == "..") {
1302  design->selection_stack.back() = RTLIL::Selection(true);
1303  design->selected_active_module = std::string();
1304  return;
1305  }
1306 
1307  std::string modname = RTLIL::escape_id(args[1]);
1308 
1309  if (design->modules_.count(modname) == 0 && !design->selected_active_module.empty()) {
1310  RTLIL::Module *module = NULL;
1311  if (design->modules_.count(design->selected_active_module) > 0)
1312  module = design->modules_.at(design->selected_active_module);
1313  if (module != NULL && module->cells_.count(modname) > 0)
1314  modname = module->cells_.at(modname)->type.str();
1315  }
1316 
1317  if (design->modules_.count(modname) > 0) {
1318  design->selected_active_module = modname;
1319  design->selection_stack.back() = RTLIL::Selection();
1320  select_filter_active_mod(design, design->selection_stack.back());
1321  design->selection_stack.back().optimize(design);
1322  return;
1323  }
1324 
1325  log_cmd_error("No such module `%s' found!\n", RTLIL::unescape_id(modname).c_str());
1326  }
select_filter_active_mod
static void select_filter_active_mod(RTLIL::Design *design, RTLIL::Selection &sel)
Definition: select.cc:538
RTLIL::Design::selection_stack
std::vector< RTLIL::Selection > selection_stack
Definition: rtlil.h:509
RTLIL::unescape_id
static std::string unescape_id(std::string str)
Definition: rtlil.h:257
module
RTLIL::Module * module
Definition: abc.cc:94
RTLIL::escape_id
static std::string escape_id(std::string str)
Definition: rtlil.h:251
log_cmd_error
void log_cmd_error(const char *format,...)
Definition: log.cc:211
RTLIL::Design::modules_
std::map< RTLIL::IdString, RTLIL::Module * > modules_
Definition: rtlil.h:507
NULL
#define NULL
Definition: NumberlikeArray.hh:6
RTLIL::Module::cells_
std::map< RTLIL::IdString, RTLIL::Cell * > cells_
Definition: rtlil.h:596
RTLIL::Design::selected_active_module
std::string selected_active_module
Definition: rtlil.h:511

+ 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.

129 {
130  for (; argidx < args.size(); argidx++)
131  {
132  std::string arg = args[argidx];
133 
134  if (arg.substr(0, 1) == "-")
135  cmd_error(args, argidx, "Unknown option or option in arguments.");
136 
137  if (!select)
138  cmd_error(args, argidx, "Extra argument.");
139 
140  handle_extra_select_args(this, args, argidx, args.size(), design);
141  break;
142  }
143  // cmd_log_args(args);
144 }
Pass::cmd_error
void cmd_error(const std::vector< std::string > &args, size_t argidx, std::string msg)
Definition: register.cc:110
handle_extra_select_args
void handle_extra_select_args(Pass *pass, std::vector< std::string > args, size_t argidx, size_t args_size, RTLIL::Design *design)
Definition: select.cc:803

+ Here is the call graph for this function:

virtual void CdPass::help ( )
inlinevirtual

Reimplemented from Pass.

Definition at line 1276 of file select.cc.

1277  {
1278  // |---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|
1279  log("\n");
1280  log(" cd <modname>\n");
1281  log("\n");
1282  log("This is just a shortcut for 'select -module <modname>'.\n");
1283  log("\n");
1284  log("\n");
1285  log(" cd <cellname>\n");
1286  log("\n");
1287  log("When no module with the specified name is found, but there is a cell\n");
1288  log("with the specified name in the current module, then this is equivialent\n");
1289  log("to 'cd <celltype>'.\n");
1290  log("\n");
1291  log(" cd ..\n");
1292  log("\n");
1293  log("This is just a shortcut for 'select -clear'.\n");
1294  log("\n");
1295  }
log
void log(const char *format,...)
Definition: log.cc:180

+ Here is the call graph for this function:

void Pass::init_register ( )
staticinherited

Definition at line 54 of file register.cc.

55 {
56  while (first_queued_pass) {
57  first_queued_pass->run_register();
58  first_queued_pass = first_queued_pass->next_queued_pass;
59  }
60 }
first_queued_pass
Pass * first_queued_pass
Definition: register.cc:31
Pass::next_queued_pass
Pass * next_queued_pass
Definition: register.h:60
Pass::run_register
virtual void run_register()
Definition: register.cc:48

+ 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.

85 {
86  int64_t time_ns = PerformanceTimer::query() - state.begin_ns;
87  runtime_ns += time_ns;
88  current_pass = state.parent_pass;
89  if (current_pass)
90  current_pass->runtime_ns -= time_ns;
91 }
PerformanceTimer::query
static int64_t query()
Definition: log.h:151
Pass::runtime_ns
int64_t runtime_ns
Definition: register.h:37
current_pass
Pass * current_pass
Definition: register.cc:32
Pass::pre_post_exec_state_t::parent_pass
Pass * parent_pass
Definition: register.h:40
Pass::pre_post_exec_state_t::begin_ns
int64_t begin_ns
Definition: register.h:41

+ 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.

75 {
76  pre_post_exec_state_t state;
77  call_counter++;
78  state.begin_ns = PerformanceTimer::query();
79  state.parent_pass = current_pass;
80  current_pass = this;
81  return state;
82 }
PerformanceTimer::query
static int64_t query()
Definition: log.h:151
current_pass
Pass * current_pass
Definition: register.cc:32
Pass::call_counter
int call_counter
Definition: register.h:36

+ 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.

49 {
50  log_assert(pass_register.count(pass_name) == 0);
51  pass_register[pass_name] = this;
52 }
Pass::pass_name
std::string pass_name
Definition: register.h:29
log_assert
#define log_assert(_assert_expr_)
Definition: log.h:85
pass_register
std::map< std::string, Pass * > pass_register
Definition: register.cc:35

+ 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: