VTR flow: Allow to run experiments with custom ODIN II config (Python)

This set of changes introduces ability to modify the VTR flow through
providing a custom default script. Also, fixes the problem of disable
xml option crashing in odin.py and a problem with run_vtr_task.py 
followed by the name of the script. Changes to Python scripts.

Signed-off-by: Georgiy Krylov <[email protected]>

Author: georgkrylov

doc/src/vtr/run_vtr_flow.rst

@@ -173,3 +173,13 @@ Detailed Command-line Options
     Tells ODIN II to connect the first cin in an adder/subtractor chain
     to a global gnd/vdd net. Instead of creating a dummy adder to generate
     the input signal of the first cin port of the chain.
+
+.. option:: -odin_xml <path_to_custom_xml>
+
+    Tells VTR flow to use a custom ODIN II configuration value. The default
+    behavior is to use the vtr_flow/misc/basic_odin_config_split.xml. 
+    Instead, an alternative config file might be supplied, compare the 
+    default and vtr_flow/misc/custom_odin_config_no_mults.xml for usage 
+    scenarios. This option is needed for running the entire VTR flow with 
+    additional parameters for ODIN II that are provided from within the 
+    .xml file.

vtr_flow/misc/custom_odin_config_no_mults.xml

@@ -0,0 +1,42 @@
+<!-- 
+	This file specifies a way of hard-coding odin arguments to run a complete vtr flow
+	Hard-coded values can modify the "XXX", "YYY" etc.
+	The tags marked as required should be persisted for the run_vtr_flow.py to succeed
+-->
+<!-- required-->
+<config>
+	<!-- required-->
+	<verilog_files>
+		<!-- Way of specifying multiple files in a project, required -->
+		<verilog_file>XXX</verilog_file>
+	</verilog_files>
+	<!-- required-->
+	<output>
+		<!-- These are the output flags for the project, required -->
+		<output_type>blif</output_type>
+		<!-- required-->
+		<output_path_and_name>ZZZ</output_path_and_name>
+		<target>
+			<!-- This is the target device the output is being built for, required -->
+			<arch_file>YYY</arch_file>
+		</target>
+	</output>
+	<!-- required-->
+	<optimizations>
+		<!-- optional-->
+		<mix_soft_hard_blocks mults_ratio="0.0"></mix_soft_hard_blocks>+
+		<!-- required-->
+		<multiply size="MMM" fixed="1" fracture="0" padding="-1"/> 
+		<!-- required-->
+		<memory split_memory_width="1" split_memory_depth="PPP"/> 
+		<!-- required-->
+		<adder size="0" threshold_size="AAA"/>
+	</optimizations>
+	<!-- required-->
+	<debug_outputs>
+		<!-- Various debug options, all optional -->
+		<debug_output_path>.</debug_output_path>
+		<output_ast_graphs>1</output_ast_graphs>
+		<output_netlist_graphs>1</output_netlist_graphs>
+	</debug_outputs>
+</config>

vtr_flow/scripts/python_libs/vtr/flow.py

@@ -43,6 +43,7 @@ def run(
     vpr_args=None,
     keep_intermediate_files=True,
     keep_result_files=True,
+    odin_config=None,
     min_hard_mult_size=3,
     min_hard_adder_size=1,
     check_equivalent=False,
@@ -182,6 +183,7 @@ def run(
             command_runner=command_runner,
             temp_dir=temp_dir,
             odin_args=odin_args,
+            odin_config=odin_config,
             min_hard_mult_size=min_hard_mult_size,
             min_hard_adder_size=min_hard_adder_size,
         )

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

@@ -82,43 +82,46 @@ def run(
 
     if odin_config is None:
         odin_base_config = str(paths.odin_cfg_path)
+    else:
+        odin_base_config = str(Path(odin_config).resolve())
+
+    # Copy the config file
+    odin_config = "odin_config.xml"
+    odin_config_full_path = str(temp_dir / odin_config)
+    shutil.copyfile(odin_base_config, odin_config_full_path)
+
+    # Update the config file
+    file_replace(
+        odin_config_full_path,
+        {
+            "XXX": circuit_file.name,
+            "YYY": architecture_file.name,
+            "ZZZ": output_netlist.name,
+            "PPP": determine_memory_addr_width(str(architecture_file)),
+            "MMM": min_hard_mult_size,
+            "AAA": min_hard_adder_size,
+        },
+    )
 
-        # Copy the config file
-        odin_config = "odin_config.xml"
-        odin_config_full_path = str(temp_dir / odin_config)
-        shutil.copyfile(odin_base_config, odin_config_full_path)
-
-        # Update the config file
-        file_replace(
-            odin_config_full_path,
-            {
-                "XXX": circuit_file.name,
-                "YYY": architecture_file.name,
-                "ZZZ": output_netlist.name,
-                "PPP": determine_memory_addr_width(str(architecture_file)),
-                "MMM": min_hard_mult_size,
-                "AAA": min_hard_adder_size,
-            },
-        )
-    disable_odin_xml = False
-    if "disable_odin_xml" in odin_args:
-        disable_odin_xml = True
-        del odin_args["disable_odin_xml"]
+    cmd = [odin_exec]
     use_odin_simulation = False
+
     if "use_odin_simulation" in odin_args:
         use_odin_simulation = True
         del odin_args["use_odin_simulation"]
 
-    cmd = [odin_exec, "-c", odin_config]
     for arg, value in odin_args.items():
         if isinstance(value, bool) and value:
             cmd += ["--" + arg]
         elif isinstance(value, (str, int, float)):
             cmd += ["--" + arg, str(value)]
         else:
             pass
+
     cmd += ["-U0"]
-    if disable_odin_xml:
+
+    if "disable_odin_xml" in odin_args:
+        del odin_args["disable_odin_xml"]
         cmd += [
             "-a",
             architecture_file.name,
@@ -127,6 +130,8 @@ def run(
             "-o",
             output_netlist.name,
         ]
+    else:
+        cmd += ["-c", odin_config]
 
     command_runner.run_system_command(
         cmd, temp_dir=temp_dir, log_filename=log_filename, indent_depth=1

vtr_flow/scripts/run_vtr_flow.py

@@ -314,6 +314,12 @@ def vtr_command_argparser(prog=None):
         type=int,
         help="Tells ODIN II the minimum adder size that should be implemented using hard adder.",
     )
+    odin.add_argument(
+        "-odin_xml",
+        default=None,
+        dest="odin_config",
+        help="Supplies Odin with a custom config file for optimizations.",
+    )
     #
     # VPR arguments
     #
@@ -421,6 +427,7 @@ def vtr_command_main(arg_list, prog=None):
             keep_result_files=args.keep_result_files,
             min_hard_mult_size=args.min_hard_mult_size,
             min_hard_adder_size=args.min_hard_adder_size,
+            odin_config=args.odin_config,
             check_equivalent=args.check_equivalent,
             check_incremental_sta_consistency=args.check_incremental_sta_consistency,
             use_old_abc_script=args.use_old_abc_script,

vtr_flow/scripts/run_vtr_task.py

@@ -283,7 +283,8 @@ def run_tasks(
 
         if args.parse:
             print("\nParsing test results...")
-            print("scripts/parse_vtr_task.py -l {}".format(args.list_file[0]))
+            if len(args.list_file) > 0:
+                print("scripts/parse_vtr_task.py -l {}".format(args.list_file[0]))
             parse_tasks(configs, jobs)
 
         if args.create_golden: