Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add missing dependencies and extra info to optimizer step docs #15054

Open
wants to merge 5 commits into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
41 changes: 41 additions & 0 deletions docs/cheatsheet.rst
Expand Up @@ -168,3 +168,44 @@ Modifiers
- ``override``: States that this function, modifier or public state variable changes
the behavior of a function or modifier in a base contract.

Optimizer Step Dependencies
===========================

=========================================== =============================================================== ===========================================
Step Steps that should run before Steps that should run after
=========================================== =============================================================== ===========================================
:ref:`a <ssa-transform>` ExpressionSplitter, CommonSubexpressionEliminator UnusedAssignEliminator
:ref:`C <conditional-simplifier>` SSATransform, DeadCodeEliminator
:ref:`c <common-subexpression-eliminator>` ExpressionSplitter, SSATransform [#]_ UnusedPruner, UnusedAssignEliminator
:ref:`D <dead-code-eliminator>`
:ref:`d <var-decl-initializer>`
:ref:`E <equal-store-eliminator>` ExpressionSplitter, SSATransform, CommonSubexpressionEliminator
:ref:`e <expression-inliner>`
:ref:`F <function-specializer>` LiteralRematerialiser
:ref:`f <block-flattener>`
:ref:`g <function-grouper>`
:ref:`h <function-hoister>`
:ref:`I <for-loop-condition-into-body>` StructuralSimplifier
:ref:`i <full-inliner>` FunctionHoister, ExpressionSplitter
:ref:`j <expression-joiner>`
:ref:`L <load-resolver>` SSATransform
:ref:`l <circular-references-pruner>`
:ref:`M <loop-invariant-code-motion>` ExpressionSplitter, SSATransform, ForLoopConditionIntoBody
:ref:`m <rematerialiser>`
:ref:`n <control-flow-simplifier>`
:ref:`O <for-loop-condition-out-of-body>` LiteralRematerialiser
:ref:`o <for-loop-init-rewriter>`
:ref:`p <unused-function-parameter-pruner>` LiteralRematerialiser FullInliner, UnusedPruner
:ref:`r <unused-assign-eliminator>`
:ref:`S <unused-store-eliminator>` SSATransform
:ref:`s <expression-simplifier>` ExpressionSplitter, SSATransform, CommonSubexpressionEliminator
:ref:`T <literal-rematerialiser>`
:ref:`t <structural-simplifier>` LiteralRematerialiser
:ref:`U <conditional-unsimplifier>`
:ref:`u <unused-pruner>`
:ref:`V <ssa-reverser>` CommonSubexpressionEliminator, UnusedPruner
:ref:`v <equivalent-function-combiner>` UnusedPruner
:ref:`x <expression-splitter>` ForLoopConditionIntoBody
=========================================== =============================================================== ===========================================

.. [#] It is enough if SSATransform was used once at any point before running the step.