[Infra]: Adding include_list_add and include_dir (both optional) to task config file

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

Author: sdamghan

vtr_flow/scripts/python_libs/vtr/flow.py

@@ -34,6 +34,7 @@ def run(
     architecture_file,
     circuit_file,
     power_tech_file=None,
+    include_files=None,
     start_stage=VtrStage.ODIN,
     end_stage=VtrStage.VPR,
     command_runner=vtr.CommandRunner(),
@@ -167,6 +168,15 @@ def run(
     shutil.copy(str(circuit_file), str(circuit_copy))
     shutil.copy(str(architecture_file), str(architecture_copy))
 
+    # Extract includes path
+    for include in include_files:
+        include_paths = str(include).split(" ")
+        # Copy given additional Verilog files
+        for include_path in include_paths:
+            include_file = vtr.util.verify_file(include_path, "Circuit")
+            include_copy = temp_dir / include_file.name
+            shutil.copy(str(include_path), str(include_copy))
+
     # There are multiple potential paths for the netlist to reach a tool
     # We initialize it here to the user specified circuit and let downstream
     # stages update it
@@ -179,6 +189,7 @@ def run(
         vtr.odin.run(
             architecture_copy,
             next_stage_netlist,
+            include_files,
             output_netlist=post_odin_netlist,
             command_runner=command_runner,
             temp_dir=temp_dir,

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

@@ -4,13 +4,70 @@
 import shutil
 from collections import OrderedDict
 from pathlib import Path
+import xml.etree.ElementTree as ET
 from vtr import file_replace, determine_memory_addr_width, verify_file, CommandRunner, paths
 
+# pylint: disable=too-many-arguments, too-many-locals
+def init_config_file(
+    odin_config_full_path,
+    include_files,
+    circuit_file,
+    architecture_file,
+    output_netlist,
+    memory_addr_width,
+    min_hard_mult_size,
+    min_hard_adder_size,
+):
+
+    """initializing the raw odin config file"""
+    # Update the config file
+    file_replace(
+        odin_config_full_path,
+        {
+            "YYY": architecture_file,
+            "ZZZ": output_netlist,
+            "PPP": memory_addr_width,
+            "MMM": min_hard_mult_size,
+            "AAA": min_hard_adder_size,
+        },
+    )
+
+    circuit_list = []
+    if include_files:
+        # Extract includes path
+        for include in include_files:
+            include_paths = str(include).split(" ")
+            for include_path in include_paths:
+                include_file = verify_file(include_path, "Circuit")
+                circuit_list.append(include_file.name)
+
+    # append the main circuit design as the last one
+    circuit_list.append(circuit_file.name)
+
+    # loading the given config file
+    config_file = ET.parse(odin_config_full_path)
+    root = config_file.getroot()
+
+    # based on the base condfig file
+    verilog_files_tag = root.find("verilog_files")
+    # remove the template line XXX, verilog_files_tag [0] is a comment
+    verilog_files_tag.remove(verilog_files_tag[0])
+    for circuit in circuit_list:
+        verilog_file = ET.SubElement(verilog_files_tag, "verilog_file")
+        verilog_file.tail = "\n\n\t" if (circuit == circuit_list[-1]) else "\n\n\t\t"
+        verilog_file.text = circuit
+
+    # update the config file with new values
+    config_file.write(odin_config_full_path)
+
+    return circuit_list
+
 
 # pylint: disable=too-many-arguments, too-many-locals
 def run(
     architecture_file,
     circuit_file,
+    include_files,
     output_netlist,
     command_runner=CommandRunner(),
     temp_dir=Path("."),
@@ -90,17 +147,15 @@ def run(
     odin_config_full_path = str(temp_dir / odin_config)
     shutil.copyfile(odin_base_config, odin_config_full_path)
 
-    # Update the config file
-    file_replace(
+    circuit_list = init_config_file(
         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,
-        },
+        include_files,
+        circuit_file,
+        architecture_file.name,
+        output_netlist.name,
+        determine_memory_addr_width(str(architecture_file)),
+        min_hard_mult_size,
+        min_hard_adder_size,
     )
 
     cmd = [odin_exec]
@@ -126,7 +181,7 @@ def run(
             "-a",
             architecture_file.name,
             "-V",
-            circuit_file.name,
+            circuit_list,
             "-o",
             output_netlist.name,
         ]

vtr_flow/scripts/python_libs/vtr/task.py

@@ -33,6 +33,8 @@ def __init__(
         circuit_list_add,
         arch_list_add,
         parse_file,
+        includes_dir=None,
+        include_list_add=None,
         second_parse_file=None,
         script_path=None,
         script_params=None,
@@ -53,6 +55,8 @@ def __init__(
         self.arch_dir = archs_dir
         self.circuits = circuit_list_add
         self.archs = arch_list_add
+        self.include_dir = includes_dir
+        self.includes = include_list_add
         self.parse_file = parse_file
         self.second_parse_file = second_parse_file
         self.script_path = script_path
@@ -82,6 +86,7 @@ def __init__(
         task_name,
         arch,
         circuit,
+        include,
         script_params,
         work_dir,
         run_command,
@@ -92,6 +97,7 @@ def __init__(
         self._task_name = task_name
         self._arch = arch
         self._circuit = circuit
+        self._include = include
         self._script_params = script_params
         self._run_command = run_command
         self._parse_command = parse_command
@@ -117,6 +123,12 @@ def circuit(self):
         """
         return self._circuit
 
+    def include(self):
+        """
+        return the include circuits file name of the job
+        """
+        return self._include
+
     def script_params(self):
         """
         return the script parameter of the job
@@ -174,6 +186,7 @@ def load_task_config(config_file):
     unique_keys = set(
         [
             "circuits_dir",
+            "includes_dir",
             "archs_dir",
             "additional_files",
             "parse_file",
@@ -238,6 +251,7 @@ def load_task_config(config_file):
         key_values["script_params_common"] = split(key_values["script_params_common"])
 
     check_required_fields(config_file, required_keys, key_values)
+    check_include_fields(config_file, key_values)
 
     # Useful meta-data about the config
     config_dir = str(Path(config_file).parent)
@@ -261,6 +275,19 @@ def check_required_fields(config_file, required_keys, key_values):
             )
 
 
+def check_include_fields(config_file, key_values):
+    """
+    Check that includes_dir exist in case of specified include_list_add
+    """
+    if "include_list_add" in key_values:
+        if "includes_dir" not in key_values:
+            raise VtrError(
+                "Missing required key '{key}' in config file {file}".format(
+                    key="includes_dir", file=config_file
+                )
+            )
+
+
 def shorten_task_names(configs, common_task_prefix):
     """
     Shorten the task names of the configs by remove the common task prefix.
@@ -316,6 +343,18 @@ def create_jobs(args, configs, after_run=False):
             # Collect any extra script params from the config file
             cmd = [abs_circuit_filepath, abs_arch_filepath]
 
+            includes = ""
+            if config.includes:
+                cmd += ["-include"]
+                for include in config.includes:
+                    abs_include_filepath = resolve_vtr_source_file(
+                        config, include, config.include_dir
+                    )
+                    delimiter = " " if (include != config.includes[-1]) else ""
+                    includes = includes + abs_include_filepath + delimiter
+
+            cmd += [includes]
+
             # Check if additional architectural data files are present
             if config.additional_files_list_add:
                 for additional_file in config.additional_files_list_add:
@@ -401,6 +440,7 @@ def create_jobs(args, configs, after_run=False):
                             args,
                             config,
                             circuit,
+                            includes,
                             arch,
                             value,
                             cmd,
@@ -418,6 +458,7 @@ def create_jobs(args, configs, after_run=False):
                         args,
                         config,
                         circuit,
+                        includes,
                         arch,
                         None,
                         cmd,
@@ -437,6 +478,7 @@ def create_job(
     args,
     config,
     circuit,
+    include,
     arch,
     param,
     cmd,
@@ -501,6 +543,7 @@ def create_job(
         config.task_name,
         arch,
         circuit,
+        include,
         param_string,
         work_dir + "/" + param_string,
         current_cmd,

vtr_flow/scripts/run_vtr_flow.py

@@ -322,6 +322,13 @@ def vtr_command_argparser(prog=None):
         dest="odin_config",
         help="Supplies Odin with a custom config file for optimizations.",
     )
+    odin.add_argument(
+        "-include",
+        nargs="*",
+        default=None,
+        dest="include_list_file",
+        help="List of additional Verilog files to each circuit.",
+    )
     #
     # VPR arguments
     #
@@ -423,6 +430,7 @@ def vtr_command_main(arg_list, prog=None):
             Path(args.architecture_file),
             Path(args.circuit_file),
             power_tech_file=args.power_tech,
+            include_files=args.include_list_file,
             temp_dir=temp_dir,
             start_stage=args.start,
             end_stage=args.end,