# pylint:disable=import-outside-toplevel
from typing import Optional, Union
from archinfo import Arch
from .optimization_pass import OptimizationPassStage
from .stack_canary_simplifier import StackCanarySimplifier
from .base_ptr_save_simplifier import BasePointerSaveSimplifier
from .expr_op_swapper import ExprOpSwapper
from .ite_region_converter import ITERegionConverter
from .ite_expr_converter import ITEExprConverter
from .lowered_switch_simplifier import LoweredSwitchSimplifier
from .multi_simplifier import MultiSimplifier
from .div_simplifier import DivSimplifier
from .mod_simplifier import ModSimplifier
from .return_duplicator_low import ReturnDuplicatorLow
from .return_duplicator_high import ReturnDuplicatorHigh
from .const_derefs import ConstantDereferencesSimplifier
from .register_save_area_simplifier import RegisterSaveAreaSimplifier
from .ret_addr_save_simplifier import RetAddrSaveSimplifier
from .x86_gcc_getpc_simplifier import X86GccGetPcSimplifier
from .flip_boolean_cmp import FlipBooleanCmp
from .ret_deduplicator import ReturnDeduplicator
from .win_stack_canary_simplifier import WinStackCanarySimplifier
from .cross_jump_reverter import CrossJumpReverter
from .code_motion import CodeMotionOptimization
from .switch_default_case_duplicator import SwitchDefaultCaseDuplicator
from .inlined_string_transformation_simplifier import InlinedStringTransformationSimplifier
# order matters!
_all_optimization_passes = [
(RegisterSaveAreaSimplifier, True),
(StackCanarySimplifier, True),
(WinStackCanarySimplifier, True),
(BasePointerSaveSimplifier, True),
(DivSimplifier, True),
(MultiSimplifier, True),
(ModSimplifier, True),
(ConstantDereferencesSimplifier, True),
(RetAddrSaveSimplifier, True),
(X86GccGetPcSimplifier, True),
(ITERegionConverter, True),
(ITEExprConverter, True),
(ExprOpSwapper, True),
(ReturnDuplicatorHigh, True),
(SwitchDefaultCaseDuplicator, True),
(LoweredSwitchSimplifier, False),
(ReturnDuplicatorLow, True),
(ReturnDeduplicator, True),
(CodeMotionOptimization, True),
(CrossJumpReverter, True),
(FlipBooleanCmp, True),
(InlinedStringTransformationSimplifier, True),
]
# these passes may duplicate code to remove gotos or improve the structure of the graph
DUPLICATING_OPTS = [ReturnDuplicatorLow, ReturnDuplicatorHigh, CrossJumpReverter]
# these passes may destroy blocks by merging them into semantically equivalent blocks
CONDENSING_OPTS = [CodeMotionOptimization, ReturnDeduplicator]
[docs]def get_optimization_passes(arch, platform):
if isinstance(arch, Arch):
arch = arch.name
if platform is not None:
platform = platform.lower()
if platform == "win32":
platform = "windows" # sigh
passes = []
for pass_, _ in _all_optimization_passes:
if (pass_.ARCHES is None or arch in pass_.ARCHES) and (
pass_.PLATFORMS is None or platform is None or platform in pass_.PLATFORMS
):
passes.append(pass_)
return passes
[docs]def get_default_optimization_passes(
arch: Union[Arch, str], platform: Optional[str], enable_opts=None, disable_opts=None
):
if isinstance(arch, Arch):
arch = arch.name
if platform is not None:
platform = platform.lower()
if platform == "win32":
platform = "windows" # sigh
passes = []
enable_opts = enable_opts or []
disable_opts = disable_opts or []
for pass_, default in _all_optimization_passes:
if (not default and pass_ not in enable_opts) or pass_ in disable_opts:
continue
if (pass_.ARCHES is None or arch in pass_.ARCHES) and (
pass_.PLATFORMS is None or platform is None or platform in pass_.PLATFORMS
):
passes.append(pass_)
return passes
[docs]def register_optimization_pass(opt_pass, enable_by_default: bool):
_all_optimization_passes.append((opt_pass, enable_by_default))