[Infra]: add "decode_names" to Yosys+Odin-II's options to use hierarchical naming style

	 instead of node-type-encoded naming, when extracting names from Yosys
	 coarse-grained BLIF file

Signed-off-by: Seyed Alireza Damghani <[email protected]>

Author: sdamghan

ODIN_II/SRC/BLIFReader.cpp

@@ -483,7 +483,10 @@ void BLIF::Reader::create_hard_block_nodes(hard_block_models* models) {
             output_nets_hash->add(name, new_net);
         }
 
-        if (!configuration.coarsen || new_node->type == SPRAM || new_node->type == DPRAM) {
+        if (!configuration.coarsen
+            || !configuration.decode_names
+            || new_node->type == SPRAM
+            || new_node->type == DPRAM) {
             // Name the node subcircuit_name~hard_block_number so that the name is unique.
             odin_sprintf(buffer, "%s~%ld", subcircuit_name, hard_block_number++);
             new_node->name = make_full_ref_name(buffer, NULL, NULL, NULL, -1);

ODIN_II/SRC/include/config_t.h

@@ -17,6 +17,7 @@ struct config_t {
     bool fflegalize;     // Legalize DFFs by making them rising edge
     bool coarsen;        // Specify if the input BLIF is coarse-grain
     bool show_yosys_log; // Print Yosys logs into the standard output stream
+    bool decode_names;   // Extracting hierarchical information from Yosys coarse-grained BLIF file for signal naming
 
     bool output_ast_graphs;     // switch that outputs ast graphs per node for use with GRaphViz tools
     bool output_netlist_graphs; // switch that outputs netlist graphs per node for use with GraphViz tools

ODIN_II/SRC/include/odin_types.h

@@ -113,6 +113,7 @@ struct global_args_t {
     argparse::ArgValue<bool> fflegalize;     // makes flip-flops rising edge sensitive
     argparse::ArgValue<bool> coarsen;        // tells Odin-II that the input blif is coarse-grain
     argparse::ArgValue<bool> show_yosys_log; // Show Yosys output logs into the standard output stream
+    argparse::ArgValue<bool> decode_names;   // Extracting hierarchical information from Yosys coarse-grained BLIF file for signal naming
 
     argparse::ArgValue<std::string> adder_def; //DEPRECATED
 

ODIN_II/SRC/odin_ii.cpp

@@ -533,6 +533,12 @@ void get_options(int argc, char** argv) {
         .help("TCL file")
         .metavar("TCL_FILE");
 
+    ext_elaborator_group.add_argument(global_args.decode_names, "--decode_names")
+        .help("Enable extracting hierarchical information from Yosys coarse-grained BLIF file for signal naming")
+        .default_value("false")
+        .action(argparse::Action::STORE_TRUE)
+        .metavar("DECODE_NAMES");
+
     auto& other_grp = parser.add_argument_group("other options");
 
     other_grp.add_argument(global_args.show_help, "-h")
@@ -752,6 +758,10 @@ void get_options(int argc, char** argv) {
         configuration.elaborator_type = elaborator_e::_YOSYS;
     }
 
+    if (global_args.decode_names.provenance() == argparse::Provenance::SPECIFIED) {
+        configuration.decode_names = global_args.decode_names;
+    }
+
     if (global_args.write_netlist_as_dot.provenance() == argparse::Provenance::SPECIFIED) {
         configuration.output_netlist_graphs = global_args.write_netlist_as_dot;
     }
@@ -809,6 +819,7 @@ void set_default_config() {
     configuration.coarsen = false;
     configuration.fflegalize = false;
     configuration.show_yosys_log = false;
+    configuration.decode_names = false;
     configuration.tcl_file = "";
     configuration.output_file_type = file_type_e::_BLIF;
     configuration.elaborator_type = elaborator_e::_ODIN;

vtr_flow/scripts/python_libs/vtr/odin/odin.py

@@ -87,7 +87,7 @@ def init_config_file(
     config_file.write(odin_config_full_path)
 
 
-# pylint: disable=too-many-arguments, too-many-locals
+# pylint: disable=too-many-arguments, too-many-locals, too-many-branches
 def run(
     architecture_file,
     circuit_file,
@@ -190,6 +190,11 @@ def run(
     cmd = [odin_exec]
     use_odin_simulation = False
 
+    # handling the Odin-II decode_name flag for Yosys coarse-grained BLIFs
+    if not odin_args["encode_names"]:
+        odin_args["decode_names"] = True
+    del odin_args["encode_names"]
+
     if "use_odin_simulation" in odin_args:
         use_odin_simulation = True
         del odin_args["use_odin_simulation"]
@@ -245,4 +250,4 @@ def run(
         )
 
 
-# pylint: enable=too-many-arguments, too-many-locals
+# pylint: enable=too-many-arguments, too-many-locals, too-many-branches

vtr_flow/scripts/run_vtr_flow.py

@@ -360,6 +360,14 @@ def vtr_command_argparser(prog=None):
         help="Make flip-flops rising edge for coarse-grain input BLIFs in the techmap"
         + "(Odin-II synthesis flow generates rising edge FFs by default)",
     )
+    odin.add_argument(
+        "-encode_names",
+        default=False,
+        action="store_true",
+        dest="encode_names",
+        help="Enable Odin-II utilization of operation-type-encoded naming style for Yosys"
+        + " coarse-grained RTLIL nodes",
+    )
     #
     # YOSYS arguments
     #
@@ -673,6 +681,7 @@ def process_odin_args(args):
     odin_args["adder_type"] = args.adder_type
     odin_args["top_module"] = args.top_module
     odin_args["elaborator"] = args.elaborator
+    odin_args["encode_names"] = args.encode_names
 
     if args.adder_cin_global:
         odin_args["adder_cin_global"] = True