refactor[venom]: refactor module structure (#4295)

this commit refactors venom's analysis/ and passes/ module structure so
that you can import analyses and passes directly from
`vyper.venom.analysis` and `vyper.venom.passes` directly instead of
needing to know the module names.

this commit also removes the `stack_reorder.py` file, which is dead code.

tests/unit/compiler/venom/test_algebraic_optimizer.py

@@ -1,11 +1,9 @@
 import pytest
 
-from vyper.venom.analysis.analysis import IRAnalysesCache
+from vyper.venom.analysis import IRAnalysesCache
 from vyper.venom.basicblock import IRBasicBlock, IRLabel
 from vyper.venom.context import IRContext
-from vyper.venom.passes.algebraic_optimization import AlgebraicOptimizationPass
-from vyper.venom.passes.make_ssa import MakeSSA
-from vyper.venom.passes.remove_unused_variables import RemoveUnusedVariablesPass
+from vyper.venom.passes import AlgebraicOptimizationPass, MakeSSA, RemoveUnusedVariablesPass
 
 
 @pytest.mark.parametrize("iszero_count", range(5))

tests/unit/compiler/venom/test_branch_optimizer.py

@@ -1,9 +1,7 @@
-from vyper.venom.analysis.analysis import IRAnalysesCache
-from vyper.venom.analysis.dfg import DFGAnalysis
+from vyper.venom.analysis import DFGAnalysis, IRAnalysesCache
 from vyper.venom.basicblock import IRBasicBlock, IRLabel
 from vyper.venom.context import IRContext
-from vyper.venom.passes.branch_optimization import BranchOptimizationPass
-from vyper.venom.passes.make_ssa import MakeSSA
+from vyper.venom.passes import BranchOptimizationPass, MakeSSA
 
 
 def test_simple_jump_case():

tests/unit/compiler/venom/test_dominator_tree.py

@@ -2,12 +2,11 @@
 
 from vyper.exceptions import CompilerPanic
 from vyper.utils import OrderedSet
-from vyper.venom.analysis.analysis import IRAnalysesCache
-from vyper.venom.analysis.dominators import DominatorTreeAnalysis
+from vyper.venom.analysis import DominatorTreeAnalysis, IRAnalysesCache
 from vyper.venom.basicblock import IRBasicBlock, IRInstruction, IRLabel, IRLiteral, IRVariable
 from vyper.venom.context import IRContext
 from vyper.venom.function import IRFunction
-from vyper.venom.passes.make_ssa import MakeSSA
+from vyper.venom.passes import MakeSSA
 
 
 def _add_bb(

tests/unit/compiler/venom/test_duplicate_operands.py

@@ -1,8 +1,8 @@
 from vyper.compiler.settings import OptimizationLevel
 from vyper.venom import generate_assembly_experimental
-from vyper.venom.analysis.analysis import IRAnalysesCache
+from vyper.venom.analysis import IRAnalysesCache
 from vyper.venom.context import IRContext
-from vyper.venom.passes.store_expansion import StoreExpansionPass
+from vyper.venom.passes import StoreExpansionPass
 
 
 def test_duplicate_operands():

tests/unit/compiler/venom/test_make_ssa.py

@@ -1,7 +1,7 @@
-from vyper.venom.analysis.analysis import IRAnalysesCache
+from vyper.venom.analysis import IRAnalysesCache
 from vyper.venom.basicblock import IRBasicBlock, IRLabel
 from vyper.venom.context import IRContext
-from vyper.venom.passes.make_ssa import MakeSSA
+from vyper.venom.passes import MakeSSA
 
 
 def test_phi_case():

tests/unit/compiler/venom/test_multi_entry_block.py

@@ -1,8 +1,7 @@
-from vyper.venom.analysis.analysis import IRAnalysesCache
-from vyper.venom.analysis.cfg import CFGAnalysis
+from vyper.venom.analysis import CFGAnalysis, IRAnalysesCache
 from vyper.venom.context import IRContext
 from vyper.venom.function import IRBasicBlock, IRLabel
-from vyper.venom.passes.normalization import NormalizationPass
+from vyper.venom.passes import NormalizationPass
 
 
 def test_multi_entry_block_1():

tests/unit/compiler/venom/test_sccp.py

@@ -1,11 +1,10 @@
 import pytest
 
 from vyper.exceptions import StaticAssertionException
-from vyper.venom.analysis.analysis import IRAnalysesCache
+from vyper.venom.analysis import IRAnalysesCache
 from vyper.venom.basicblock import IRBasicBlock, IRLabel, IRLiteral, IRVariable
 from vyper.venom.context import IRContext
-from vyper.venom.passes.make_ssa import MakeSSA
-from vyper.venom.passes.sccp import SCCP
+from vyper.venom.passes import SCCP, MakeSSA
 from vyper.venom.passes.sccp.sccp import LatticeEnum
 
 

tests/unit/compiler/venom/test_simplify_cfg.py

@@ -1,8 +1,7 @@
-from vyper.venom.analysis.analysis import IRAnalysesCache
+from vyper.venom.analysis import IRAnalysesCache
 from vyper.venom.basicblock import IRBasicBlock, IRLabel, IRLiteral
 from vyper.venom.context import IRContext
-from vyper.venom.passes.sccp import SCCP
-from vyper.venom.passes.simplify_cfg import SimplifyCFGPass
+from vyper.venom.passes import SCCP, SimplifyCFGPass
 
 
 def test_phi_reduction_after_block_pruning():

tests/unit/compiler/venom/test_stack_reorder.py

@@ -1,7 +1,7 @@
 from vyper.venom import generate_assembly_experimental
-from vyper.venom.analysis.analysis import IRAnalysesCache
+from vyper.venom.analysis import IRAnalysesCache
 from vyper.venom.context import IRContext
-from vyper.venom.passes.store_expansion import StoreExpansionPass
+from vyper.venom.passes import StoreExpansionPass
 
 
 def test_stack_reorder():

vyper/venom/__init__.py

@@ -9,16 +9,18 @@
 from vyper.venom.context import IRContext
 from vyper.venom.function import IRFunction
 from vyper.venom.ir_node_to_venom import ir_node_to_venom
-from vyper.venom.passes.algebraic_optimization import AlgebraicOptimizationPass
-from vyper.venom.passes.branch_optimization import BranchOptimizationPass
-from vyper.venom.passes.dft import DFTPass
-from vyper.venom.passes.make_ssa import MakeSSA
-from vyper.venom.passes.mem2var import Mem2Var
-from vyper.venom.passes.remove_unused_variables import RemoveUnusedVariablesPass
-from vyper.venom.passes.sccp import SCCP
-from vyper.venom.passes.simplify_cfg import SimplifyCFGPass
-from vyper.venom.passes.store_elimination import StoreElimination
-from vyper.venom.passes.store_expansion import StoreExpansionPass
+from vyper.venom.passes import (
+    SCCP,
+    AlgebraicOptimizationPass,
+    BranchOptimizationPass,
+    DFTPass,
+    MakeSSA,
+    Mem2Var,
+    RemoveUnusedVariablesPass,
+    SimplifyCFGPass,
+    StoreElimination,
+    StoreExpansionPass,
+)
 from vyper.venom.venom_to_assembly import VenomCompiler
 
 DEFAULT_OPT_LEVEL = OptimizationLevel.default()

vyper/venom/analysis/__init__.py

@@ -0,0 +1,6 @@
+from .analysis import IRAnalysesCache, IRAnalysis
+from .cfg import CFGAnalysis
+from .dfg import DFGAnalysis
+from .dominators import DominatorTreeAnalysis
+from .equivalent_vars import VarEquivalenceAnalysis
+from .liveness import LivenessAnalysis

vyper/venom/analysis/cfg.py

@@ -1,5 +1,5 @@
 from vyper.utils import OrderedSet
-from vyper.venom.analysis.analysis import IRAnalysis
+from vyper.venom.analysis import IRAnalysis
 from vyper.venom.basicblock import CFG_ALTERING_INSTRUCTIONS
 
 
@@ -32,8 +32,7 @@ def analyze(self) -> None:
                 in_bb.add_cfg_out(bb)
 
     def invalidate(self):
-        from vyper.venom.analysis.dominators import DominatorTreeAnalysis
-        from vyper.venom.analysis.liveness import LivenessAnalysis
+        from vyper.venom.analysis import DominatorTreeAnalysis, LivenessAnalysis
 
         self.analyses_cache.invalidate_analysis(DominatorTreeAnalysis)
         self.analyses_cache.invalidate_analysis(LivenessAnalysis)

vyper/venom/analysis/dominators.py

@@ -1,7 +1,6 @@
 from vyper.exceptions import CompilerPanic
 from vyper.utils import OrderedSet
-from vyper.venom.analysis.analysis import IRAnalysis
-from vyper.venom.analysis.cfg import CFGAnalysis
+from vyper.venom.analysis import CFGAnalysis, IRAnalysis
 from vyper.venom.basicblock import IRBasicBlock
 from vyper.venom.function import IRFunction
 

vyper/venom/analysis/equivalent_vars.py

@@ -1,5 +1,4 @@
-from vyper.venom.analysis.analysis import IRAnalysis
-from vyper.venom.analysis.dfg import DFGAnalysis
+from vyper.venom.analysis import DFGAnalysis, IRAnalysis
 from vyper.venom.basicblock import IRVariable
 
 

vyper/venom/analysis/liveness.py

@@ -2,8 +2,7 @@
 
 from vyper.exceptions import CompilerPanic
 from vyper.utils import OrderedSet
-from vyper.venom.analysis.analysis import IRAnalysis
-from vyper.venom.analysis.cfg import CFGAnalysis
+from vyper.venom.analysis import CFGAnalysis, IRAnalysis
 from vyper.venom.basicblock import IRBasicBlock, IRVariable
 
 

vyper/venom/passes/__init__.py

@@ -0,0 +1,11 @@
+from .algebraic_optimization import AlgebraicOptimizationPass
+from .branch_optimization import BranchOptimizationPass
+from .dft import DFTPass
+from .make_ssa import MakeSSA
+from .mem2var import Mem2Var
+from .normalization import NormalizationPass
+from .remove_unused_variables import RemoveUnusedVariablesPass
+from .sccp import SCCP
+from .simplify_cfg import SimplifyCFGPass
+from .store_elimination import StoreElimination
+from .store_expansion import StoreExpansionPass

vyper/venom/passes/algebraic_optimization.py

@@ -1,5 +1,4 @@
-from vyper.venom.analysis.dfg import DFGAnalysis
-from vyper.venom.analysis.liveness import LivenessAnalysis
+from vyper.venom.analysis import DFGAnalysis, LivenessAnalysis
 from vyper.venom.basicblock import IRInstruction, IRLabel, IRLiteral, IROperand
 from vyper.venom.passes.base_pass import IRPass
 

vyper/venom/passes/base_pass.py

@@ -1,4 +1,4 @@
-from vyper.venom.analysis.analysis import IRAnalysesCache
+from vyper.venom.analysis import IRAnalysesCache
 from vyper.venom.function import IRFunction
 
 

vyper/venom/passes/branch_optimization.py

@@ -1,4 +1,4 @@
-from vyper.venom.analysis.dfg import DFGAnalysis
+from vyper.venom.analysis import DFGAnalysis
 from vyper.venom.passes.base_pass import IRPass
 
 

vyper/venom/passes/dft.py

@@ -1,5 +1,5 @@
 from vyper.utils import OrderedSet
-from vyper.venom.analysis.dfg import DFGAnalysis
+from vyper.venom.analysis import DFGAnalysis
 from vyper.venom.basicblock import IRBasicBlock, IRInstruction, IRVariable
 from vyper.venom.function import IRFunction
 from vyper.venom.passes.base_pass import IRPass

vyper/venom/passes/make_ssa.py

@@ -1,7 +1,5 @@
 from vyper.utils import OrderedSet
-from vyper.venom.analysis.cfg import CFGAnalysis
-from vyper.venom.analysis.dominators import DominatorTreeAnalysis
-from vyper.venom.analysis.liveness import LivenessAnalysis
+from vyper.venom.analysis import CFGAnalysis, DominatorTreeAnalysis, LivenessAnalysis
 from vyper.venom.basicblock import IRBasicBlock, IRInstruction, IROperand, IRVariable
 from vyper.venom.passes.base_pass import IRPass
 

vyper/venom/passes/mem2var.py

@@ -1,6 +1,4 @@
-from vyper.venom.analysis.cfg import CFGAnalysis
-from vyper.venom.analysis.dfg import DFGAnalysis
-from vyper.venom.analysis.liveness import LivenessAnalysis
+from vyper.venom.analysis import CFGAnalysis, DFGAnalysis, LivenessAnalysis
 from vyper.venom.basicblock import IRInstruction, IRVariable
 from vyper.venom.function import IRFunction
 from vyper.venom.passes.base_pass import IRPass

vyper/venom/passes/normalization.py

@@ -1,5 +1,5 @@
 from vyper.exceptions import CompilerPanic
-from vyper.venom.analysis.cfg import CFGAnalysis
+from vyper.venom.analysis import CFGAnalysis
 from vyper.venom.basicblock import IRBasicBlock, IRLabel
 from vyper.venom.passes.base_pass import IRPass
 

vyper/venom/passes/remove_unused_variables.py

@@ -1,6 +1,5 @@
 from vyper.utils import OrderedSet
-from vyper.venom.analysis.dfg import DFGAnalysis
-from vyper.venom.analysis.liveness import LivenessAnalysis
+from vyper.venom.analysis import DFGAnalysis, LivenessAnalysis
 from vyper.venom.basicblock import IRInstruction
 from vyper.venom.passes.base_pass import IRPass
 

vyper/venom/passes/sccp/sccp.py

@@ -5,9 +5,7 @@
 
 from vyper.exceptions import CompilerPanic, StaticAssertionException
 from vyper.utils import OrderedSet
-from vyper.venom.analysis.analysis import IRAnalysesCache
-from vyper.venom.analysis.cfg import CFGAnalysis
-from vyper.venom.analysis.dominators import DominatorTreeAnalysis
+from vyper.venom.analysis import CFGAnalysis, DominatorTreeAnalysis, IRAnalysesCache
 from vyper.venom.basicblock import (
     IRBasicBlock,
     IRInstruction,

vyper/venom/passes/simplify_cfg.py

@@ -1,6 +1,6 @@
 from vyper.exceptions import CompilerPanic
 from vyper.utils import OrderedSet
-from vyper.venom.analysis.cfg import CFGAnalysis
+from vyper.venom.analysis import CFGAnalysis
 from vyper.venom.basicblock import IRBasicBlock, IRLabel
 from vyper.venom.passes.base_pass import IRPass
 

vyper/venom/passes/store_elimination.py

@@ -1,6 +1,4 @@
-from vyper.venom.analysis.cfg import CFGAnalysis
-from vyper.venom.analysis.dfg import DFGAnalysis
-from vyper.venom.analysis.liveness import LivenessAnalysis
+from vyper.venom.analysis import CFGAnalysis, DFGAnalysis, LivenessAnalysis
 from vyper.venom.basicblock import IRVariable
 from vyper.venom.passes.base_pass import IRPass
 

vyper/venom/passes/store_expansion.py

@@ -1,5 +1,4 @@
-from vyper.venom.analysis.dfg import DFGAnalysis
-from vyper.venom.analysis.liveness import LivenessAnalysis
+from vyper.venom.analysis import DFGAnalysis, LivenessAnalysis
 from vyper.venom.basicblock import IRInstruction, IRLiteral, IRVariable
 from vyper.venom.passes.base_pass import IRPass
 

vyper/venom/venom_to_assembly.py

@@ -10,9 +10,7 @@
     optimize_assembly,
 )
 from vyper.utils import MemoryPositions, OrderedSet
-from vyper.venom.analysis.analysis import IRAnalysesCache
-from vyper.venom.analysis.equivalent_vars import VarEquivalenceAnalysis
-from vyper.venom.analysis.liveness import LivenessAnalysis
+from vyper.venom.analysis import IRAnalysesCache, LivenessAnalysis, VarEquivalenceAnalysis
 from vyper.venom.basicblock import (
     IRBasicBlock,
     IRInstruction,
@@ -22,7 +20,7 @@
     IRVariable,
 )
 from vyper.venom.context import IRContext
-from vyper.venom.passes.normalization import NormalizationPass
+from vyper.venom.passes import NormalizationPass
 from vyper.venom.stack_model import StackModel
 
 DEBUG_SHOW_COST = False