Merge pull request #389 from pllab/passes-update

Feed sanity check flag during optimization to subpasses

Author: mdko

pyrtl/passes.py

@@ -31,9 +31,12 @@ def optimize(update_working_block=True, block=None, skip_sanity_check=False):
     """
     Return an optimized version of a synthesized hardware block.
 
-    :param Boolean update_working_block: Don't copy the block and optimize the
-        new block
+    :param bool update_working_block: Don't copy the block and optimize the
+        new block (defaults to True)
     :param Block block: the block to optimize (defaults to working block)
+    :param bool skip_sanity_check: Don't perform sanity checks on the block
+        before/during/after the optimization passes (defaults to False).
+        Sanity checks will always be performed if in debug mode.
 
     Note:
     optimize works on all hardware designs, both synthesized and non synthesized
@@ -45,8 +48,8 @@ def optimize(update_working_block=True, block=None, skip_sanity_check=False):
     with set_working_block(block, no_sanity_check=True):
         if (not skip_sanity_check) or _get_debug_mode():
             block.sanity_check()
-        _remove_wire_nets(block)
-        _remove_slice_nets(block)
+        _remove_wire_nets(block, skip_sanity_check)
+        _remove_slice_nets(block, skip_sanity_check)
         constant_propagation(block, True)
         _remove_unlistened_nets(block)
         common_subexp_elimination(block)
@@ -73,7 +76,7 @@ def find_producer(self, item):
             return item
 
 
-def _remove_wire_nets(block):
+def _remove_wire_nets(block, skip_sanity_check=False):
     """ Remove all wire nodes from the block. """
 
     wire_src_dict = _ProducerList()
@@ -100,10 +103,11 @@ def _remove_wire_nets(block):
     for dead_wirevector in wire_removal_set:
         block.remove_wirevector(dead_wirevector)
 
-    block.sanity_check()
+    if (not skip_sanity_check) or _get_debug_mode():
+        block.sanity_check()
 
 
-def _remove_slice_nets(block):
+def _remove_slice_nets(block, skip_sanity_check=False):
     """ Remove all unneeded slice nodes from the block.
 
     Unneeded here means that the source and destination wires of a slice net are exactly
@@ -161,7 +165,8 @@ def is_net_slicing_entire_wire(net):
         del block.wirevector_by_name[dead_wirevector.name]
         block.wirevector_set.remove(dead_wirevector)
 
-    block.sanity_check()
+    if (not skip_sanity_check) or _get_debug_mode():
+        block.sanity_check()
 
 
 def constant_propagation(block, silence_unexpected_net_warnings=False):