DesignPass Struct Reference

Inheritance diagram for DesignPass:

Collaboration diagram for DesignPass:

Public Member Functions
	DesignPass ()
virtual	~DesignPass ()
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 30 of file design.cc.

Constructor & Destructor Documentation

DesignPass::DesignPass ( )

inline

Definition at line 31 of file design.cc.

: Pass("design", "save, restore and reset current design") { }

virtual DesignPass::~DesignPass ( )

inlinevirtual

Definition at line 32 of file design.cc.

                          {
        for (auto &it : saved_designs)
            delete it.second;
        saved_designs.clear();
        for (auto &it : pushed_designs)
            delete it;
        pushed_designs.clear();
    }

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

inlinevirtual

Implements Pass.

Definition at line 86 of file design.cc.

    {
        bool got_mode = false;
        bool reset_mode = false;
        bool push_mode = false;
        bool pop_mode = false;
        RTLIL::Design *copy_from_design = NULL, *copy_to_design = NULL;
        std::string save_name, load_name, as_name;
        std::vector<RTLIL::Module*> copy_src_modules;

        size_t argidx;
        for (argidx = 1; argidx < args.size(); argidx++)
        {
            std::string arg = args[argidx];
            if (!got_mode && args[argidx] == "-reset") {
                got_mode = true;
                reset_mode = true;
                continue;
            }
            if (!got_mode && args[argidx] == "-push") {
                got_mode = true;
                push_mode = true;
                continue;
            }
            if (!got_mode && args[argidx] == "-pop") {
                got_mode = true;
                pop_mode = true;
                continue;
            }
            if (!got_mode && args[argidx] == "-save" && argidx+1 < args.size()) {
                got_mode = true;
                save_name = args[++argidx];
                continue;
            }
            if (!got_mode && args[argidx] == "-stash" && argidx+1 < args.size()) {
                got_mode = true;
                save_name = args[++argidx];
                reset_mode = true;
                continue;
            }
            if (!got_mode && args[argidx] == "-load" && argidx+1 < args.size()) {
                got_mode = true;
                load_name = args[++argidx];
                if (saved_designs.count(load_name) == 0)
                    log_cmd_error("No saved design '%s' found!\n", load_name.c_str());
                continue;
            }
            if (!got_mode && args[argidx] == "-copy-from" && argidx+1 < args.size()) {
                got_mode = true;
                if (saved_designs.count(args[++argidx]) == 0)
                    log_cmd_error("No saved design '%s' found!\n", args[argidx].c_str());
                copy_from_design = saved_designs.at(args[argidx]);
                copy_to_design = design;
                continue;
            }
            if (!got_mode && args[argidx] == "-copy-to" && argidx+1 < args.size()) {
                got_mode = true;
                if (saved_designs.count(args[++argidx]) == 0)
                    saved_designs[args[argidx]] = new RTLIL::Design;
                copy_to_design = saved_designs.at(args[argidx]);
                copy_from_design = design;
                continue;
            }
            if (copy_from_design != NULL && args[argidx] == "-as" && argidx+1 < args.size()) {
                got_mode = true;
                as_name = args[++argidx];
                continue;
            }
            break;
        }

        if (copy_from_design != NULL)
        {
            if (copy_from_design != design && argidx == args.size())
                cmd_error(args, argidx, "Missing selection.");

            RTLIL::Selection sel = design->selection_stack.back();
            if (argidx != args.size()) {
                handle_extra_select_args(this, args, argidx, args.size(), copy_from_design);
                sel = copy_from_design->selection_stack.back();
                copy_from_design->selection_stack.pop_back();
                argidx = args.size();
            }

            for (auto &it : copy_from_design->modules_) {
                if (sel.selected_whole_module(it.first)) {
                    copy_src_modules.push_back(it.second);
                    continue;
                }
                if (sel.selected_module(it.first))
                    log_cmd_error("Module %s is only partly selected.\n", RTLIL::id2cstr(it.first));
            }
        }

        extra_args(args, argidx, design, false);

        if (!got_mode)
            cmd_error(args, argidx, "Missing mode argument.");

        if (pop_mode && pushed_designs.empty())
            log_cmd_error("No pushed designs.\n");

        if (copy_to_design != NULL)
        {
            if (!as_name.empty() && copy_src_modules.size() > 1)
                log_cmd_error("Only one module can be selected in combination with -as.\n");

            for (auto mod : copy_src_modules)
            {
                std::string trg_name = as_name.empty() ? mod->name.str() : RTLIL::escape_id(as_name);

                if (copy_to_design->modules_.count(trg_name))
                    delete copy_to_design->modules_.at(trg_name);
                copy_to_design->modules_[trg_name] = mod->clone();
                copy_to_design->modules_[trg_name]->name = trg_name;
                copy_to_design->modules_[trg_name]->design = copy_to_design;
            }
        }

        if (!save_name.empty() || push_mode)
        {
            RTLIL::Design *design_copy = new RTLIL::Design;

            for (auto &it : design->modules_)
                design_copy->add(it.second->clone());

            design_copy->selection_stack = design->selection_stack;
            design_copy->selection_vars = design->selection_vars;
            design_copy->selected_active_module = design->selected_active_module;

            if (saved_designs.count(save_name))
                delete saved_designs.at(save_name);

            if (push_mode)
                pushed_designs.push_back(design_copy);
            else
                saved_designs[save_name] = design_copy;
        }

        if (reset_mode || !load_name.empty() || push_mode || pop_mode)
        {
            for (auto &it : design->modules_)
                delete it.second;
            design->modules_.clear();

            design->selection_stack.clear();
            design->selection_vars.clear();
            design->selected_active_module.clear();

            design->selection_stack.push_back(RTLIL::Selection());
        }

        if (!load_name.empty() || pop_mode)
        {
            RTLIL::Design *saved_design = pop_mode ? pushed_designs.back() : saved_designs.at(load_name);

            if (pop_mode)
                pushed_designs.pop_back();

            for (auto &it : saved_design->modules_)
                design->add(it.second->clone());

            design->selection_stack = saved_design->selection_stack;
            design->selection_vars = saved_design->selection_vars;
            design->selected_active_module = saved_design->selected_active_module;
        }
    }

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 DesignPass::help ( )

inlinevirtual

Reimplemented from Pass.

Definition at line 40 of file design.cc.

    {
        //   |---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|
        log("\n");
        log("    design -reset\n");
        log("\n");
        log("Clear the current design.\n");
        log("\n");
        log("\n");
        log("    design -save <name>\n");
        log("\n");
        log("Save the current design under the given name.\n");
        log("\n");
        log("\n");
        log("    design -stash <name>\n");
        log("\n");
        log("Save the current design under the given name and then clear the current design.\n");
        log("\n");
        log("\n");
        log("    design -push\n");
        log("\n");
        log("Push the current design to the stack and then clear the current design.\n");
        log("\n");
        log("\n");
        log("    design -pop\n");
        log("\n");
        log("Reset the current design and pop the last design from the stack.\n");
        log("\n");
        log("\n");
        log("    design -load <name>\n");
        log("\n");
        log("Reset the current design and load the design previously saved under the given\n");
        log("name.\n");
        log("\n");
        log("\n");
        log("    design -copy-from <name> [-as <new_mod_name>] <selection>\n");
        log("\n");
        log("Copy modules from the specified design into the current one. The selection is\n");
        log("evaluated in the other design.\n");
        log("\n");
        log("\n");
        log("    design -copy-to <name> [-as <new_mod_name>] [selection]\n");
        log("\n");
        log("Copy modules from the current design into the soecified one.\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:

• design.cc