Merge pull request #343 from byuccl/move_configure_method

Moved configure_vivado_synth_tools to flow_utils.py

bfasst/ninja_flows/flow.py

@@ -1,7 +1,6 @@
 """Base class for all ninja flows"""
 import abc
 
-from bfasst.ninja_tools.vivado.synth.vivado_synth import VivadoSynth
 from bfasst.paths import BUILD_DIR, DESIGNS_PATH
 
 
@@ -28,8 +27,3 @@ def add_ninja_deps(self):
     @abc.abstractmethod
     def get_top_level_flow_path(self) -> str:
         """Get the path to the top level flow file for this flow"""
-
-    def configure_vivado_synth_tool(self, design, flow_args, ooc=False):
-        if isinstance(flow_args, dict) and "synth" in flow_args:
-            return VivadoSynth(design, flow_args["synth"], ooc)
-        return VivadoSynth(design, ooc=ooc)

bfasst/ninja_flows/ninja_flow_manager.py

@@ -31,6 +31,8 @@ def __init__(self):
 
     def create_flows(self, flow_name, designs, flow_args=None):
         """Create the ninja flows for the given designs."""
+        if flow_args is None:
+            flow_args = {}
         self.flow_name = flow_name
         self.flows = []
         self.designs = []

bfasst/ninja_flows/vivado.py

@@ -2,6 +2,8 @@
 from bfasst.ninja_flows.flow import Flow
 from bfasst.ninja_tools.vivado.impl.vivado_impl import VivadoImpl
 from bfasst.paths import NINJA_FLOWS_PATH
+from bfasst.ninja_tools.vivado.synth.vivado_synth import VivadoSynth
+from bfasst.utils.general import ensure
 
 
 class Vivado(Flow):
@@ -10,7 +12,7 @@ class Vivado(Flow):
     def __init__(self, design, flow_args=None, ooc=False):
         super().__init__(design)
         self.ooc = ooc
-        self.vivado_synth_tool = self.configure_vivado_synth_tool(design, flow_args, ooc)
+        self.vivado_synth_tool = VivadoSynth(design, ensure(flow_args, {}).get("synth"), ooc)
         self.vivado_impl_tool = VivadoImpl(design, ooc)
 
     def create_rule_snippets(self):

bfasst/ninja_flows/vivado_bit_analysis.py

@@ -7,14 +7,16 @@
 from bfasst.ninja_tools.rev_bit.xray import Xray as XrevTool
 from bfasst.ninja_tools.transform.netlist_cleanup import NetlistCleanupTool
 from bfasst.ninja_tools.transform.netlist_phys_to_logical import NetlistPhysToLogicalTool
+from bfasst.ninja_tools.vivado.synth.vivado_synth import VivadoSynth
+from bfasst.utils.general import ensure
 
 
 class VivadoBitAnalysis(Flow):
     """Flow to reverse a netlist from a bitstream using x-ray."""
 
     def __init__(self, design, flow_args=None):
         super().__init__(design)
-        self.vivado_synth_tool = self.configure_vivado_synth_tool(design, flow_args)
+        self.vivado_synth_tool = VivadoSynth(design, ensure(flow_args, {}).get("synth"))
         self.vivado_impl_tool = VivadoImpl(design)
         self.xrev_tool = XrevTool(design)
         self.netlist_cleanup_tool = NetlistCleanupTool(design)

bfasst/ninja_flows/vivado_conformal.py

@@ -6,14 +6,16 @@
 from bfasst.ninja_tools.rev_bit.xray import Xray
 from bfasst.paths import NINJA_FLOWS_PATH
 from bfasst.types import Vendor
+from bfasst.ninja_tools.vivado.synth.vivado_synth import VivadoSynth
+from bfasst.utils.general import ensure
 
 
 class VivadoConformal(Flow):
     """Run vivado, phys_netlist, reverse with xray, then compare with conformal."""
 
     def __init__(self, design, flow_args=None):
         super().__init__(design)
-        self.vivado_synth_tool = self.configure_vivado_synth_tool(design, flow_args)
+        self.vivado_synth_tool = VivadoSynth(design, ensure(flow_args, {}).get("synth"))
         self.vivado_impl_tool = VivadoImpl(design)
         self.xrev_tool = Xray(design)
         self.conformal_tool = Conformal(design)

bfasst/ninja_flows/vivado_phys_netlist.py

@@ -4,14 +4,16 @@
 from bfasst.ninja_tools.vivado.impl.vivado_impl import VivadoImpl
 from bfasst.ninja_tools.transform.phys_netlist import PhysNetlist
 from bfasst.paths import NINJA_FLOWS_PATH
+from bfasst.ninja_tools.vivado.synth.vivado_synth import VivadoSynth
+from bfasst.utils.general import ensure
 
 
 class VivadoPhysNetlist(Flow):
     """Creates a Vivado netlist that has only physical primitives."""
 
     def __init__(self, design, flow_args=None):
         super().__init__(design)
-        self.vivado_synth_tool = self.configure_vivado_synth_tool(design, flow_args)
+        self.vivado_synth_tool = VivadoSynth(design, ensure(flow_args, {}).get("synth"))
         self.vivado_impl_tool = VivadoImpl(design)
         self.phys_netlist_tool = PhysNetlist(design)
 

bfasst/ninja_flows/vivado_phys_netlist_cmp.py

@@ -6,14 +6,16 @@
 from bfasst.ninja_tools.rev_bit.xray import Xray
 from bfasst.ninja_tools.transform.phys_netlist import PhysNetlist
 from bfasst.paths import NINJA_FLOWS_PATH
+from bfasst.ninja_tools.vivado.synth.vivado_synth import VivadoSynth
+from bfasst.utils.general import ensure
 
 
 class VivadoPhysNetlistCmp(Flow):
     """Structural Comparison of physical netlist and reversed netlist"""
 
     def __init__(self, design, flow_args=None):
         super().__init__(design)
-        self.vivado_synth_tool = self.configure_vivado_synth_tool(design, flow_args)
+        self.vivado_synth_tool = VivadoSynth(design, ensure(flow_args, {}).get("synth"))
         self.vivado_impl_tool = VivadoImpl(design)
         self.phys_netlist_tool = PhysNetlist(design)
         self.xray_tool = Xray(design)

bfasst/ninja_flows/vivado_phys_netlist_xrev.py

@@ -6,14 +6,16 @@
 from bfasst.ninja_tools.rev_bit.xray import Xray
 from bfasst.ninja_tools.transform.phys_netlist import PhysNetlist
 from bfasst.paths import NINJA_FLOWS_PATH
+from bfasst.ninja_tools.vivado.synth.vivado_synth import VivadoSynth
+from bfasst.utils.general import ensure
 
 
 class VivadoPhysNetlistXrev(Flow):
     """Flow that combines vivado phys netlist and xray/f2b reversal."""
 
     def __init__(self, design, flow_args=None):
         super().__init__(design)
-        self.vivado_synth_tool = self.configure_vivado_synth_tool(design, flow_args)
+        self.vivado_synth_tool = VivadoSynth(design, ensure(flow_args, {}).get("synth"))
         self.vivado_impl_tool = VivadoImpl(design)
         self.phys_netlist_tool = PhysNetlist(design)
         self.xrev_tool = Xray(design)

bfasst/ninja_flows/vivado_structural_error_injection.py

@@ -9,6 +9,8 @@
 from bfasst.ninja_tools.transform.error_injector import ErrorInjector
 from bfasst.ninja_tools.transform.phys_netlist import PhysNetlist
 from bfasst.paths import NINJA_FLOWS_PATH
+from bfasst.ninja_tools.vivado.synth.vivado_synth import VivadoSynth
+from bfasst.utils.general import ensure
 
 from bfasst.ninja_utils.error_injector import ErrorType
 
@@ -19,7 +21,7 @@ class VivadoStructuralErrorInjection(Flow):
     def __init__(self, design, flow_args=None):
         super().__init__(design)
         random.seed(0)
-        self.vivado_synth_tool = self.configure_vivado_synth_tool(design, flow_args)
+        self.vivado_synth_tool = VivadoSynth(design, ensure(flow_args, {}).get("synth"))
         self.vivado_impl_tool = VivadoImpl(design)
         self.phys_netlist_tool = PhysNetlist(design)
         self.xrev_tool = Xray(design)

bfasst/ninja_flows/vivado_yosys_impl.py

@@ -4,14 +4,16 @@
 from bfasst.ninja_tools.compare.yosys.yosys import Yosys
 from bfasst.ninja_tools.rev_bit.xray import Xray
 from bfasst.paths import NINJA_FLOWS_PATH
+from bfasst.ninja_tools.vivado.synth.vivado_synth import VivadoSynth
+from bfasst.utils.general import ensure
 
 
 class VivadoYosysImpl(Flow):
     """Flow to compare reversed netlist to original using yosys."""
 
     def __init__(self, design, flow_args=None):
         super().__init__(design)
-        self.vivado_synth_tool = self.configure_vivado_synth_tool(design, flow_args)
+        self.vivado_synth_tool = VivadoSynth(design, ensure(flow_args, {}).get("synth"))
         self.vivado_impl_tool = VivadoImpl(design)
         self.xrev_tool = Xray(design)
         self.yosys_tool = Yosys(design)

bfasst/utils/general.py

@@ -235,3 +235,10 @@ def ensure_tuple(x):
     if isinstance(x, list):
         return tuple(x)
     return (x,)
+
+
+def ensure(x, y):
+    """Compensates for how python deals with default reference objects"""
+    if x is None:
+        return y
+    return x