Frontend Struct Reference

#include <register.h>

Inheritance diagram for Frontend:

Collaboration diagram for Frontend:

Public Member Functions
	Frontend (std::string name, std::string short_help="** document me **")
virtual void	run_register ()
virtual	~Frontend ()
virtual void	execute (std::vector< std::string > args, RTLIL::Design *design) YS_OVERRIDE YS_FINAL
virtual void	execute (std::istream *&f, std::string filename, std::vector< std::string > args, RTLIL::Design *design)=0
void	extra_args (std::istream *&f, std::string &filename, std::vector< std::string > args, size_t argidx)
virtual void	help ()
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)

Static Public Member Functions
static void	frontend_call (RTLIL::Design *design, std::istream *f, std::string filename, std::string command)
static void	frontend_call (RTLIL::Design *design, std::istream *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	frontend_name
std::string	pass_name
std::string	short_help
int	call_counter
int64_t	runtime_ns
Pass *	next_queued_pass

Static Public Attributes
static FILE *	current_script_file = NULL
static std::string	last_here_document
static std::vector< std::string >	next_args

Detailed Description

Definition at line 66 of file register.h.

Constructor & Destructor Documentation

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

Definition at line 266 of file register.cc.

                                                       :
        Pass(name.rfind("=", 0) == 0 ? name.substr(1) : "read_" + name, short_help),
        frontend_name(name.rfind("=", 0) == 0 ? name.substr(1) : name)
{
}

Frontend::~Frontend ( )

virtual

Definition at line 281 of file register.cc.

{
}

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:

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

virtual

Implements Pass.

Definition at line 285 of file register.cc.

{
    log_assert(next_args.empty());
    do {
        std::istream *f = NULL;
        next_args.clear();
        auto state = pre_execute();
        execute(f, std::string(), args, design);
        post_execute(state);
        args = next_args;
        delete f;
    } while (!args.empty());
}

Here is the call graph for this function:

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

pure virtual

Implemented in LibertyFrontend, VerilogFrontend, IlangFrontend, and WriteFileFrontend.

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 Frontend::extra_args	(	std::istream *&	f,
		std::string &	filename,
		std::vector< std::string >	args,
		size_t	argidx
	)

Definition at line 302 of file register.cc.

{
    bool called_with_fp = f != NULL;

    next_args.clear();
    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 (f != NULL)
            cmd_error(args, argidx, "Extra filename argument in direct file mode.");

        filename = arg;
        if (filename == "<<" && argidx+1 < args.size())
            filename += args[++argidx];
        if (filename.substr(0, 2) == "<<") {
            if (Frontend::current_script_file == NULL)
                log_error("Unexpected here document '%s' outside of script!\n", filename.c_str());
            if (filename.size() <= 2)
                log_error("Missing EOT marker in here document!\n");
            std::string eot_marker = filename.substr(2);
            last_here_document.clear();
            while (1) {
                std::string buffer;
                char block[4096];
                while (1) {
                    if (fgets(block, 4096, Frontend::current_script_file) == NULL)
                        log_error("Unexpected end of file in here document '%s'!\n", filename.c_str());
                    buffer += block;
                    if (buffer.size() > 0 && (buffer[buffer.size() - 1] == '\n' || buffer[buffer.size() - 1] == '\r'))
                        break;
                }
                size_t indent = buffer.find_first_not_of(" \t\r\n");
                if (indent != std::string::npos && buffer.substr(indent, eot_marker.size()) == eot_marker)
                    break;
                last_here_document += buffer;
            }
            f = new std::istringstream(last_here_document);
        } else {
            if (filename.substr(0, 2) == "+/")
                filename = proc_share_dirname() + filename.substr(1);
            std::ifstream *ff = new std::ifstream;
            ff->open(filename.c_str());
            if (ff->fail())
                delete ff;
            else
                f = ff;
        }
        if (f == NULL)
            log_cmd_error("Can't open input file `%s' for reading: %s\n", filename.c_str(), strerror(errno));

        for (size_t i = argidx+1; i < args.size(); i++)
            if (args[i].substr(0, 1) == "-")
                cmd_error(args, i, "Found option, expected arguments.");

        if (argidx+1 < args.size()) {
            next_args.insert(next_args.begin(), args.begin(), args.begin()+argidx);
            next_args.insert(next_args.begin()+argidx, args.begin()+argidx+1, args.end());
            args.erase(args.begin()+argidx+1, args.end());
        }
        break;
    }
    if (f == NULL)
        cmd_error(args, argidx, "No filename given.");

    if (called_with_fp)
        args.push_back(filename);
    args[0] = pass_name;
    // cmd_log_args(args);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void Frontend::frontend_call ( RTLIL::Design *  design, std::istream *  f, std::string  filename, std::string  command  )

static

Definition at line 375 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);
    frontend_call(design, f, filename, args);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void Frontend::frontend_call ( RTLIL::Design *  design, std::istream *  f, std::string  filename, std::vector< std::string >  args  )

static

Definition at line 385 of file register.cc.

{
    if (args.size() == 0)
        return;
    if (frontend_register.count(args[0]) == 0)
        log_cmd_error("No such frontend: %s\n", args[0].c_str());

    if (f != NULL) {
        auto state = frontend_register[args[0]]->pre_execute();
        frontend_register[args[0]]->execute(f, filename, args, design);
        frontend_register[args[0]]->post_execute(state);
    } else if (filename == "-") {
        std::istream *f_cin = &std::cin;
        auto state = frontend_register[args[0]]->pre_execute();
        frontend_register[args[0]]->execute(f_cin, "<stdin>", args, design);
        frontend_register[args[0]]->post_execute(state);
    } else {
        if (!filename.empty())
            args.push_back(filename);
        frontend_register[args[0]]->execute(args, design);
    }

    design->check();
}

Here is the call graph for this function:

void Pass::help ( )

virtualinherited

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

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 Frontend::run_register ( )

virtual

Reimplemented from Pass.

Definition at line 272 of file register.cc.

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

    log_assert(frontend_register.count(frontend_name) == 0);
    frontend_register[frontend_name] = this;
}

Field Documentation

int Pass::call_counter

inherited

Definition at line 36 of file register.h.

FILE * Frontend::current_script_file = NULL

static

Definition at line 69 of file register.h.

std::string Frontend::frontend_name

Definition at line 72 of file register.h.

std::string Frontend::last_here_document

static

Definition at line 70 of file register.h.

std::vector< std::string > Frontend::next_args

static

Definition at line 79 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 files:

• register.h
• register.cc