Morley.Michelson.Optimizer

Optimizer for typed instructions.

It's quite experimental and incomplete.

Documentation

optimize :: Instr inp out -> Instr inp out

Optimize a typed instruction by replacing some sequences of instructions with smaller equivalent sequences. Applies default set of rewrite rules.

optimizeWithConf :: OptimizerConf -> Instr inp out -> Instr inp out

Optimize a typed instruction using a custom set of rules. The set is divided into several stages, as applying some rules can prevent others to be performed.

If any stage resulted in optimizations, we apply it again until we reach fixpoint, but no more than ocMaxIterations times.

optimizeVerboseWithConf :: OptimizerConf -> Instr inp out -> ([OptimizerStageStats], Instr inp out)

Returns some optimizer statistics in addition to optimized instruction. Mostly useful for testing and debugging.

defaultOptimizerConf :: OptimizerConf

Default config - all commonly useful rules will be applied to all the code.

defaultRules :: Ruleset

Default optimization rules.

defaultRulesAndPushPack :: Ruleset

We do not enable pushPack rule by default because it is potentially dangerous. There are various code processing functions that may depend on constants, e. g. string transformations.

newtype Rule

Type of a single rewrite rule, wrapped in `newtype`. It takes an instruction and tries to optimize its head (first few instructions). If optimization succeeds, it returns Just the optimized instruction, otherwise it returns Nothing.

Constructors

Rule

Fields

• unRule :: forall inp out. Instr inp out -> Maybe (Instr inp out)

data OptimizerConf

Constructors

OptimizerConf

Fields

• ocGotoValues :: Bool
• ocRuleset :: Ruleset
• ocMaxIterations :: Word

Instances

Default OptimizerConf

Defined in Morley.Michelson.Optimizer

Methods

def :: OptimizerConf

ocGotoValuesL :: Lens' OptimizerConf Bool

Ruleset manipulation

data OptimizationStage

Optimization stages. Stages are run in first to last order, each stage has an Int argument, which allows splitting each stage into sub-stages, which will run lowest index to highest. All default rules use sub-stage 0.

Constructors

OptimizationStagePrepare Int

OptimizationStageMain Int

Main optimisation stage, except rules that would interfere with other rules.

OptimizationStageMainExtended Int

All main stage rules.

OptimizationStageFixup Int

Post main stage fixups.

OptimizationStageRollAdjacent Int

Main stage rules unroll DROP n, PAIR n, etc into their primitive counterparts to simplify some optimisations. This stages coalesces them back.

Instances

Eq OptimizationStage

Defined in Morley.Michelson.Optimizer.Internal.Ruleset

Methods

(==) :: OptimizationStage -> OptimizationStage -> Bool

(/=) :: OptimizationStage -> OptimizationStage -> Bool

Ord OptimizationStage

Defined in Morley.Michelson.Optimizer.Internal.Ruleset

Methods

compare :: OptimizationStage -> OptimizationStage -> Ordering

(<) :: OptimizationStage -> OptimizationStage -> Bool

(<=) :: OptimizationStage -> OptimizationStage -> Bool

(>) :: OptimizationStage -> OptimizationStage -> Bool

(>=) :: OptimizationStage -> OptimizationStage -> Bool

max :: OptimizationStage -> OptimizationStage -> OptimizationStage

min :: OptimizationStage -> OptimizationStage -> OptimizationStage

Buildable OptimizationStage

Defined in Morley.Michelson.Optimizer.Internal.Ruleset

Methods

build :: OptimizationStage -> Doc

buildList :: [OptimizationStage] -> Doc

data Ruleset

A set of optimization stages. Rules at the same sub-stage are applied in arbitrary order. See OptimizationStage for explanation of sub-stages.

Default ruleset is empty.

Instances

Monoid Ruleset

Defined in Morley.Michelson.Optimizer.Internal.Ruleset

Methods

mempty :: Ruleset

mappend :: Ruleset -> Ruleset -> Ruleset

mconcat :: [Ruleset] -> Ruleset

Semigroup Ruleset

Defined in Morley.Michelson.Optimizer.Internal.Ruleset

Methods

(<>) :: Ruleset -> Ruleset -> Ruleset

sconcat :: NonEmpty Ruleset -> Ruleset

stimes :: Integral b => b -> Ruleset -> Ruleset

Default Ruleset

Defined in Morley.Michelson.Optimizer.Internal.Ruleset

Methods

def :: Ruleset

rulesAtPrio :: OptimizationStage -> Ruleset -> [Rule]

Get rules for a given priority as a list.

insertRuleAtPrio :: OptimizationStage -> Rule -> Ruleset -> Ruleset

Insert a single rule at a given priority without touching other rules.

clearRulesAtPrio :: OptimizationStage -> Ruleset -> Ruleset

Remove the stage with the given priority.

alterRulesAtPrio :: ([Rule] -> [Rule]) -> OptimizationStage -> Ruleset -> Ruleset

Alter all stage rules for a given priority.

data OptimizerStageStats

Constructors

OptimizerStageStats

Fields

• ossStage :: OptimizationStage
• ossNumIterations :: Word
• ossNumInstrs :: Word

Instances

Buildable OptimizerStageStats

Defined in Morley.Michelson.Optimizer

Methods

build :: OptimizerStageStats -> Doc

buildList :: [OptimizerStageStats] -> Doc