Inheritance diagram for BlifBackend:

Collaboration diagram for BlifBackend:

Public Member Functions
	BlifBackend ()

virtual void	help ()

virtual void	execute (std::ostream &f, std::string filename, std::vector< std::string > args, RTLIL::Design design)

virtual void	run_register ()

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

void	extra_args (std::ostream *&f, std::string &filename, std::vector< std::string > args, size_t argidx)

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

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)

Static Public Member Functions
static void	backend_call (RTLIL::Design design, std::ostream f, std::string filename, std::string command)

static void	backend_call (RTLIL::Design design, std::ostream f, std::string filename, std::vector< std::string > args)

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	backend_name

std::string	pass_name

std::string	short_help

int	call_counter

int64_t	runtime_ns

Pass *	next_queued_pass

Detailed Description

Definition at line 292 of file blif.cc.

Constructor & Destructor Documentation

BlifBackend::BlifBackend ( )

inline

Definition at line 293 of file blif.cc.

293 : Backend("blif", "write design to BLIF file") { }

Backend::Backend

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

Definition: register.cc:410

Member Function Documentation

void Backend::backend_call	(	RTLIL::Design *	design,
		std::ostream *	f,
		std::string	filename,
		std::string	command
	)

staticinherited

Definition at line 479 of file register.cc.

 {
     std::vector<std::string> args;
     char *s = strdup(command.c_str());
     for (char *p = strtok(s, " \t\r\n"); p; p = strtok(NULL, " \t\r\n"))
         args.push_back(p);
     free(s);
     backend_call(design, f, filename, args);
 }

Here is the call graph for this function:

Here is the caller graph for this function:

void Backend::backend_call	(	RTLIL::Design *	design,
		std::ostream *	f,
		std::string	filename,
		std::vector< std::string >	args
	)

staticinherited

Definition at line 489 of file register.cc.

 {
     if (args.size() == 0)
         return;
     if (backend_register.count(args[0]) == 0)
         log_cmd_error("No such backend: %s\n", args[0].c_str());
 
     size_t orig_sel_stack_pos = design->selection_stack.size();
 
     if (f != NULL) {
         auto state = backend_register[args[0]]->pre_execute();
         backend_register[args[0]]->execute(f, filename, args, design);
         backend_register[args[0]]->post_execute(state);
     } else if (filename == "-") {
         std::ostream *f_cout = &std::cout;
         auto state = backend_register[args[0]]->pre_execute();
         backend_register[args[0]]->execute(f_cout, "<stdout>", args, design);
         backend_register[args[0]]->post_execute(state);
     } else {
         if (!filename.empty())
             args.push_back(filename);
         backend_register[args[0]]->execute(args, design);
     }
 
     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	(	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:

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

virtualinherited

Implements Pass.

Definition at line 429 of file register.cc.

 {
     std::ostream *f = NULL;
     auto state = pre_execute();
     execute(f, std::string(), args, design);
     post_execute(state);
     if (f != &std::cout)
         delete f;
 }

Here is the call graph for this function:

virtual void BlifBackend::execute	(	std::ostream *&	f,
		std::string	filename,
		std::vector< std::string >	args,
		RTLIL::Design *	design
	)

inlinevirtual

Implements Backend.

Definition at line 346 of file blif.cc.

     {
         std::string top_module_name;
         std::string buf_type, buf_in, buf_out;
         std::string true_type, true_out;
         std::string false_type, false_out;
         BlifDumperConfig config;
 
         log_header("Executing BLIF backend.\n");
 
         size_t argidx;
         for (argidx = 1; argidx < args.size(); argidx++)
         {
             if (args[argidx] == "-top" && argidx+1 < args.size()) {
                 top_module_name = args[++argidx];
                 continue;
             }
             if (args[argidx] == "-buf" && argidx+3 < args.size()) {
                 config.buf_type = args[++argidx];
                 config.buf_in = args[++argidx];
                 config.buf_out = args[++argidx];
                 continue;
             }
             if (args[argidx] == "-unbuf" && argidx+3 < args.size()) {
                 RTLIL::IdString unbuf_type = RTLIL::escape_id(args[++argidx]);
                 RTLIL::IdString unbuf_in = RTLIL::escape_id(args[++argidx]);
                 RTLIL::IdString unbuf_out = RTLIL::escape_id(args[++argidx]);
                 config.unbuf_types[unbuf_type] = std::pair<RTLIL::IdString, RTLIL::IdString>(unbuf_in, unbuf_out);
                 continue;
             }
             if (args[argidx] == "-true" && argidx+2 < args.size()) {
                 config.true_type = args[++argidx];
                 config.true_out = args[++argidx];
                 continue;
             }
             if (args[argidx] == "-false" && argidx+2 < args.size()) {
                 config.false_type = args[++argidx];
                 config.false_out = args[++argidx];
                 continue;
             }
             if (args[argidx] == "-undef" && argidx+2 < args.size()) {
                 config.undef_type = args[++argidx];
                 config.undef_out = args[++argidx];
                 continue;
             }
             if (args[argidx] == "-icells") {
                 config.icells_mode = true;
                 continue;
             }
             if (args[argidx] == "-gates") {
                 config.gates_mode = true;
                 continue;
             }
             if (args[argidx] == "-conn") {
                 config.conn_mode = true;
                 continue;
             }
             if (args[argidx] == "-param") {
                 config.param_mode = true;
                 continue;
             }
             if (args[argidx] == "-blackbox") {
                 config.blackbox_mode = true;
                 continue;
             }
             if (args[argidx] == "-impltf") {
                 config.impltf_mode = true;
                 continue;
             }
             break;
         }
         extra_args(f, filename, args, argidx);
 
         if (top_module_name.empty())
             for (auto & mod_it:design->modules_)
                 if (mod_it.second->get_bool_attribute("\\top"))
                     top_module_name = mod_it.first.str();
 
         *f << stringf("# Generated by %s\n", yosys_version_str);
 
         std::vector<RTLIL::Module*> mod_list;
 
         for (auto module_it : design->modules_)
         {
             RTLIL::Module *module = module_it.second;
             if (module->get_bool_attribute("\\blackbox") && !config.blackbox_mode)
                 continue;
 
             if (module->processes.size() != 0)
                 log_error("Found unmapped processes in module %s: unmapped processes are not supported in BLIF backend!\n", RTLIL::id2cstr(module->name));
             if (module->memories.size() != 0)
                 log_error("Found munmapped emories in module %s: unmapped memories are not supported in BLIF backend!\n", RTLIL::id2cstr(module->name));
 
             if (module->name == RTLIL::escape_id(top_module_name)) {
                 BlifDumper::dump(*f, module, design, config);
                 top_module_name.clear();
                 continue;
             }
 
             mod_list.push_back(module);
         }
 
         if (!top_module_name.empty())
             log_error("Can't find top module `%s'!\n", top_module_name.c_str());
 
         for (auto module : mod_list)
             BlifDumper::dump(*f, module, design, config);
     }

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:

void Backend::extra_args	(	std::ostream *&	f,
		std::string &	filename,
		std::vector< std::string >	args,
		size_t	argidx
	)

inherited

Definition at line 439 of file register.cc.

 {
     bool called_with_fp = f != NULL;
 
     for (; argidx < args.size(); argidx++)
     {
         std::string arg = args[argidx];
 
         if (arg.substr(0, 1) == "-" && arg != "-")
             cmd_error(args, argidx, "Unknown option or option in arguments.");
         if (f != NULL)
             cmd_error(args, argidx, "Extra filename argument in direct file mode.");
 
         if (arg == "-") {
             filename = "<stdout>";
             f = &std::cout;
             continue;
         }
 
         filename = arg;
         std::ofstream *ff = new std::ofstream;
         ff->open(filename.c_str(), std::ofstream::trunc);
         if (ff->fail()) {
             delete ff;
             log_cmd_error("Can't open output file `%s' for writing: %s\n", filename.c_str(), strerror(errno));
         }
         f = ff;
     }
 
     if (called_with_fp)
         args.push_back(filename);
     args[0] = pass_name;
     // cmd_log_args(args);
 
     if (f == NULL) {
         filename = "<stdout>";
         f = &std::cout;
     }
 }

Here is the call graph for this function:

Here is the caller graph for this function:

virtual void BlifBackend::help ( )

inlinevirtual

Reimplemented from Pass.

Definition at line 294 of file blif.cc.

     {
         //   |---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|
         log("\n");
         log("    write_blif [options] [filename]\n");
         log("\n");
         log("Write the current design to an BLIF file.\n");
         log("\n");
         log("    -top top_module\n");
         log("        set the specified module as design top module\n");
         log("\n");
         log("    -buf <cell-type> <in-port> <out-port>\n");
         log("        use cells of type <cell-type> with the specified port names for buffers\n");
         log("\n");
         log("    -unbuf <cell-type> <in-port> <out-port>\n");
         log("        replace buffer cells with the specified name and port names with\n");
         log("        a .names statement that models a buffer\n");
         log("\n");
         log("    -true <cell-type> <out-port>\n");
         log("    -false <cell-type> <out-port>\n");
         log("    -undef <cell-type> <out-port>\n");
         log("        use the specified cell types to drive nets that are constant 1, 0, or\n");
         log("        undefined. when '-' is used as <cell-type>, then <out-port> specifies\n");
         log("        the wire name to be used for the constant signal and no cell driving\n");
         log("        that wire is generated.\n");
         log("\n");
         log("The following options can be useful when the generated file is not going to be\n");
         log("read by a BLIF parser but a custom tool. It is recommended to not name the output\n");
         log("file *.blif when any of this options is used.\n");
         log("\n");
         log("    -icells\n");
         log("        do not translate Yosys's internal gates to generic BLIF logic\n");
         log("        functions. Instead create .subckt or .gate lines for all cells.\n");
         log("\n");
         log("    -gates\n");
         log("        print .gate instead of .subckt lines for all cells that are not\n");
         log("        instantiations of other modules from this design.\n");
         log("\n");
         log("    -conn\n");
         log("        do not generate buffers for connected wires. instead use the\n");
         log("        non-standard .conn statement.\n");
         log("\n");
         log("    -param\n");
         log("        use the non-standard .param statement to write module parameters\n");
         log("\n");
         log("    -blackbox\n");
         log("        write blackbox cells with .blackbox statement.\n");
         log("\n");
         log("    -impltf\n");
         log("        do not write definitions for the $true, $false and $undef wires.\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 Backend::run_register ( )

virtualinherited

Reimplemented from Pass.

Definition at line 416 of file register.cc.

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

Field Documentation

std::string Backend::backend_name

inherited

Definition at line 88 of file register.h.

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:

blif.cc

Public Member Functions

Static Public Member Functions

Data Fields

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation