ShowPass Struct Reference

Inheritance diagram for ShowPass:

Collaboration diagram for ShowPass:

Public Member Functions
	ShowPass ()
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 548 of file show.cc.

Constructor & Destructor Documentation

ShowPass::ShowPass ( )

inline

Definition at line 549 of file show.cc.

: Pass("show", "generate schematics using graphviz") { }

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

inlinevirtual

Implements Pass.

Definition at line 619 of file show.cc.

    {
        log_header("Generating Graphviz representation of design.\n");
        log_push();

        std::vector<std::pair<std::string, RTLIL::Selection>> color_selections;
        std::vector<std::pair<std::string, RTLIL::Selection>> label_selections;

        std::string format;
        std::string viewer_exe;
        std::string prefix = stringf("%s/.yosys_show", getenv("HOME") ? getenv("HOME") : ".");
        std::vector<std::string> libfiles;
        std::vector<RTLIL::Design*> libs;
        uint32_t colorSeed = 0;
        bool flag_width = false;
        bool flag_signed = false;
        bool flag_stretch = false;
        bool flag_pause = false;
        bool flag_enum = false;
        bool flag_abbeviate = true;
        bool flag_notitle = false;

        size_t argidx;
        for (argidx = 1; argidx < args.size(); argidx++)
        {
            std::string arg = args[argidx];
            if (arg == "-viewer" && argidx+1 < args.size()) {
                viewer_exe = args[++argidx];
                continue;
            }
            if (arg == "-lib" && argidx+1 < args.size()) {
                libfiles.push_back(args[++argidx]);
                continue;
            }
            if (arg == "-prefix" && argidx+1 < args.size()) {
                prefix = args[++argidx];
                continue;
            }
            if (arg == "-color" && argidx+2 < args.size()) {
                std::pair<std::string, RTLIL::Selection> data;
                data.first = args[++argidx], argidx++;
                handle_extra_select_args(this, args, argidx, argidx+1, design);
                data.second = design->selection_stack.back();
                design->selection_stack.pop_back();
                color_selections.push_back(data);
                continue;
            }
            if (arg == "-label" && argidx+2 < args.size()) {
                std::pair<std::string, RTLIL::Selection> data;
                data.first = args[++argidx], argidx++;
                handle_extra_select_args(this, args, argidx, argidx+1, design);
                data.second = design->selection_stack.back();
                design->selection_stack.pop_back();
                label_selections.push_back(data);
                continue;
            }
            if (arg == "-colors" && argidx+1 < args.size()) {
                colorSeed = atoi(args[++argidx].c_str());
                for (int i = 0; i < 100; i++)
                    colorSeed = ShowWorker::xorshift32(colorSeed);
                continue;
            }
            if (arg == "-format" && argidx+1 < args.size()) {
                format = args[++argidx];
                continue;
            }
            if (arg == "-width") {
                flag_width= true;
                continue;
            }
            if (arg == "-signed") {
                flag_signed= true;
                continue;
            }
            if (arg == "-stretch") {
                flag_stretch= true;
                continue;
            }
            if (arg == "-pause") {
                flag_pause= true;
                continue;
            }
            if (arg == "-enum") {
                flag_enum = true;
                flag_abbeviate = false;
                continue;
            }
            if (arg == "-long") {
                flag_enum = false;
                flag_abbeviate = false;
                continue;
            }
            if (arg == "-notitle") {
                flag_notitle = true;
                continue;
            }
            break;
        }
        extra_args(args, argidx, design);

        if (format != "ps") {
            int modcount = 0;
            for (auto &mod_it : design->modules_) {
                if (mod_it.second->get_bool_attribute("\\blackbox"))
                    continue;
                if (mod_it.second->cells_.empty() && mod_it.second->connections().empty())
                    continue;
                if (design->selected_module(mod_it.first))
                    modcount++;
            }
            if (modcount > 1)
                log_cmd_error("For formats different than 'ps' only one module must be selected.\n");
        }

        for (auto filename : libfiles) {
            std::ifstream f;
            f.open(filename.c_str());
            if (f.fail())
                log_error("Can't open lib file `%s'.\n", filename.c_str());
            RTLIL::Design *lib = new RTLIL::Design;
            Frontend::frontend_call(lib, &f, filename, (filename.size() > 3 && filename.substr(filename.size()-3) == ".il") ? "ilang" : "verilog");
            libs.push_back(lib);
        }

        if (libs.size() > 0)
            log_header("Continuing show pass.\n");

        std::string dot_file = stringf("%s.dot", prefix.c_str());
        std::string out_file = stringf("%s.%s", prefix.c_str(), format.empty() ? "svg" : format.c_str());

        log("Writing dot description to `%s'.\n", dot_file.c_str());
        FILE *f = fopen(dot_file.c_str(), "w");
        if (f == NULL) {
            for (auto lib : libs)
                delete lib;
            log_cmd_error("Can't open dot file `%s' for writing.\n", dot_file.c_str());
        }
        ShowWorker worker(f, design, libs, colorSeed, flag_width, flag_signed, flag_stretch, flag_enum, flag_abbeviate, flag_notitle, color_selections, label_selections);
        fclose(f);

        for (auto lib : libs)
            delete lib;

        if (worker.page_counter == 0)
            log_cmd_error("Nothing there to show.\n");

        if (format != "dot" && !format.empty()) {
            std::string cmd = stringf("dot -T%s -o '%s' '%s'", format.c_str(), out_file.c_str(), dot_file.c_str());
            log("Exec: %s\n", cmd.c_str());
            if (run_command(cmd) != 0)
                log_cmd_error("Shell command failed!\n");
        }

        if (!viewer_exe.empty()) {
            std::string cmd = stringf("%s '%s' &", viewer_exe.c_str(), out_file.c_str());
            log("Exec: %s\n", cmd.c_str());
            if (run_command(cmd) != 0)
                log_cmd_error("Shell command failed!\n");
        } else
        if (format.empty()) {
            std::string cmd = stringf("fuser -s '%s' || xdot '%s' < '%s' &", dot_file.c_str(), dot_file.c_str(), dot_file.c_str());
            log("Exec: %s\n", cmd.c_str());
            if (run_command(cmd) != 0)
                log_cmd_error("Shell command failed!\n");
        }

        if (flag_pause) {
        #ifdef YOSYS_ENABLE_READLINE
            char *input = NULL;
            while ((input = readline("Press ENTER to continue (or type 'shell' to open a shell)> ")) != NULL) {
                if (input[strspn(input, " \t\r\n")] == 0)
                    break;
                char *p = input + strspn(input, " \t\r\n");
                if (!strcmp(p, "shell")) {
                    Pass::call(design, "shell");
                    break;
                }
            }
        #else
            log_cmd_error("This version of yosys is built without readline support => 'show -pause' is not available.\n");
        #endif
        }

        log_pop();
    }

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

inlinevirtual

Reimplemented from Pass.

Definition at line 550 of file show.cc.

    {
        //   |---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|
        log("\n");
        log("    show [options] [selection]\n");
        log("\n");
        log("Create a graphviz DOT file for the selected part of the design and compile it\n");
        log("to a graphics file (usually SVG or PostScript).\n");
        log("\n");
        log("    -viewer <viewer>\n");
        log("        Run the specified command with the graphics file as parameter.\n");
        log("\n");
        log("    -format <format>\n");
        log("        Generate a graphics file in the specified format.\n");
        log("        Usually <format> is 'svg' or 'ps'.\n");
        log("\n");
        log("    -lib <verilog_or_ilang_file>\n");
        log("        Use the specified library file for determining whether cell ports are\n");
        log("        inputs or outputs. This option can be used multiple times to specify\n");
        log("        more than one library.\n");
        log("\n");
        log("    -prefix <prefix>\n");
        log("        generate <prefix>.* instead of ~/.yosys_show.*\n");
        log("\n");
        log("    -color <color> <object>\n");
        log("        assign the specified color to the specified object. The object can be\n");
        log("        a single selection wildcard expressions or a saved set of objects in\n");
        log("        the @<name> syntax (see \"help select\" for details).\n");
        log("\n");
        log("    -label <text> <object>\n");
        log("        assign the specified label text to the specified object. The object can\n");
        log("        be a single selection wildcard expressions or a saved set of objects in\n");
        log("        the @<name> syntax (see \"help select\" for details).\n");
        log("\n");
        log("    -colors <seed>\n");
        log("        Randomly assign colors to the wires. The integer argument is the seed\n");
        log("        for the random number generator. Change the seed value if the colored\n");
        log("        graph still is ambigous. A seed of zero deactivates the coloring.\n");
        log("\n");
        log("    -width\n");
        log("        annotate busses with a label indicating the width of the bus.\n");
        log("\n");
        log("    -signed\n");
        log("        mark ports (A, B) that are declarted as signed (using the [AB]_SIGNED\n");
        log("        cell parameter) with an asterisk next to the port name.\n");
        log("\n");
        log("    -stretch\n");
        log("        stretch the graph so all inputs are on the left side and all outputs\n");
        log("        (including inout ports) are on the right side.\n");
        log("\n");
        log("    -pause\n");
        log("        wait for the use to press enter to before returning\n");
        log("\n");
        log("    -enum\n");
        log("        enumerate objects with internal ($-prefixed) names\n");
        log("\n");
        log("    -long\n");
        log("        do not abbeviate objects with internal ($-prefixed) names\n");
        log("\n");
        log("    -notitle\n");
        log("        do not add the module name as graph title to the dot file\n");
        log("\n");
        log("When no <format> is specified, 'dot' is used. When no <format> and <viewer> is\n");
        log("specified, 'xdot' is used to display the schematic.\n");
        log("\n");
        log("The generated output files are '~/.yosys_show.dot' and '~/.yosys_show.<format>',\n");
        log("unless another prefix is specified using -prefix <prefix>.\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:

• show.cc