Enhance documentation.

2023-10-03 13:03:40 +00:00 · 2021-11-23 10:42:18 +01:00 · 2021-11-23 10:42:18 +01:00 · 0e7a065a78
commit 0e7a065a78
parent bd321b9f1f
31 changed files with 35 additions and 30 deletions
--- a/libyul/optimiser/UnusedStoreBase.h
+++ b/libyul/optimiser/UnusedStoreBase.h
@ -36,6 +36,11 @@ struct Dialect;
 /**
 * Base class for both UnusedAssignEliminator and UnusedStoreEliminator.
 *
+ * The class tracks the state of abstract "stores" (assignments or mstore/sstore
+ * statements) across the control-flow. It is the job of the derived class to create
+ * the stores and track references, but the base class adjusts their "used state" at
+ * control-flow splits and joins.
+ *
 * Prerequisite: Disambiguator, ForLoopInitRewriter.
 */
 class UnusedStoreBase: public ASTWalker
--- a/test/libyul/yulOptimizerTests/unusedAssignEliminator/for.yul
+++ b/test/libyul/yulOptimizerTests/unusedAssignEliminator/for.yul
@ -8,7 +8,7 @@
    }
 }
 // ----
-// step: redundantAssignEliminator
+// step: unusedAssignEliminator
 //
 // {
 //     let a := 2
--- a/test/libyul/yulOptimizerTests/unusedAssignEliminator/for_branch.yul
+++ b/test/libyul/yulOptimizerTests/unusedAssignEliminator/for_branch.yul
@ -14,7 +14,7 @@
    mstore(x, 0)
 }
 // ----
-// step: redundantAssignEliminator
+// step: unusedAssignEliminator
 //
 // {
 //     let x
--- a/test/libyul/yulOptimizerTests/unusedAssignEliminator/for_break.yul
+++ b/test/libyul/yulOptimizerTests/unusedAssignEliminator/for_break.yul
@ -13,7 +13,7 @@
    mstore(x, 0x42)
 }
 // ----
-// step: redundantAssignEliminator
+// step: unusedAssignEliminator
 //
 // {
 //     let x
--- a/test/libyul/yulOptimizerTests/unusedAssignEliminator/for_continue.yul
+++ b/test/libyul/yulOptimizerTests/unusedAssignEliminator/for_continue.yul
@ -16,7 +16,7 @@
    x := 3
 }
 // ----
-// step: redundantAssignEliminator
+// step: unusedAssignEliminator
 //
 // {
 //     let x
--- a/test/libyul/yulOptimizerTests/unusedAssignEliminator/for_continue_2.yul
+++ b/test/libyul/yulOptimizerTests/unusedAssignEliminator/for_continue_2.yul
@ -13,7 +13,7 @@
    mstore(x, 0x42)
 }
 // ----
-// step: redundantAssignEliminator
+// step: unusedAssignEliminator
 //
 // {
 //     let x
--- a/test/libyul/yulOptimizerTests/unusedAssignEliminator/for_continue_3.yul
+++ b/test/libyul/yulOptimizerTests/unusedAssignEliminator/for_continue_3.yul
@ -12,7 +12,7 @@
    }
 }
 // ----
-// step: redundantAssignEliminator
+// step: unusedAssignEliminator
 //
 // {
 //     let x
--- a/test/libyul/yulOptimizerTests/unusedAssignEliminator/for_decl_inside_break_continue.yul
+++ b/test/libyul/yulOptimizerTests/unusedAssignEliminator/for_decl_inside_break_continue.yul
@ -19,7 +19,7 @@
    mstore(x, 0x42)
 }
 // ----
-// step: redundantAssignEliminator
+// step: unusedAssignEliminator
 //
 // {
 //     let x := 1
--- a/test/libyul/yulOptimizerTests/unusedAssignEliminator/for_deep_noremove.yul
+++ b/test/libyul/yulOptimizerTests/unusedAssignEliminator/for_deep_noremove.yul
@ -26,7 +26,7 @@
    x := 13
 }
 // ----
-// step: redundantAssignEliminator
+// step: unusedAssignEliminator
 //
 // {
 //     let x := 1
--- a/test/libyul/yulOptimizerTests/unusedAssignEliminator/for_deep_simple.yul
+++ b/test/libyul/yulOptimizerTests/unusedAssignEliminator/for_deep_simple.yul
@ -19,7 +19,7 @@
    }
 }
 // ----
-// step: redundantAssignEliminator
+// step: unusedAssignEliminator
 //
 // {
 //     for { } 1 { }
--- a/test/libyul/yulOptimizerTests/unusedAssignEliminator/for_multi_break.yul
+++ b/test/libyul/yulOptimizerTests/unusedAssignEliminator/for_multi_break.yul
@ -35,7 +35,7 @@
    mstore(x, 0x42)
 }
 // ----
-// step: redundantAssignEliminator
+// step: unusedAssignEliminator
 //
 // {
 //     let x := 1
--- a/test/libyul/yulOptimizerTests/unusedAssignEliminator/for_nested.yul
+++ b/test/libyul/yulOptimizerTests/unusedAssignEliminator/for_nested.yul
@ -32,7 +32,7 @@
    mstore(x, 0x42)
 }
 // ----
-// step: redundantAssignEliminator
+// step: unusedAssignEliminator
 //
 // {
 //     let x := 1
--- a/test/libyul/yulOptimizerTests/unusedAssignEliminator/for_rerun.yul
+++ b/test/libyul/yulOptimizerTests/unusedAssignEliminator/for_rerun.yul
@ -11,7 +11,7 @@
    x := 3
 }
 // ----
-// step: redundantAssignEliminator
+// step: unusedAssignEliminator
 //
 // {
 //     let x
--- a/test/libyul/yulOptimizerTests/unusedAssignEliminator/for_stmnts_after_break_continue.yul
+++ b/test/libyul/yulOptimizerTests/unusedAssignEliminator/for_stmnts_after_break_continue.yul
@ -23,7 +23,7 @@
    mstore(x, 0x42)
 }
 // ----
-// step: redundantAssignEliminator
+// step: unusedAssignEliminator
 //
 // {
 //     let x := 1
--- a/test/libyul/yulOptimizerTests/unusedAssignEliminator/function.yul
+++ b/test/libyul/yulOptimizerTests/unusedAssignEliminator/function.yul
@ -12,7 +12,7 @@
    r := 2
 }
 // ----
-// step: redundantAssignEliminator
+// step: unusedAssignEliminator
 //
 // {
 //     let r
--- a/test/libyul/yulOptimizerTests/unusedAssignEliminator/if.yul
+++ b/test/libyul/yulOptimizerTests/unusedAssignEliminator/if.yul
@ -10,7 +10,7 @@
    mstore(0, d)
 }
 // ----
-// step: redundantAssignEliminator
+// step: unusedAssignEliminator
 //
 // {
 //     let c
--- a/test/libyul/yulOptimizerTests/unusedAssignEliminator/if_overwrite_all_branches.yul
+++ b/test/libyul/yulOptimizerTests/unusedAssignEliminator/if_overwrite_all_branches.yul
@ -11,7 +11,7 @@
    mstore(0, d)
 }
 // ----
-// step: redundantAssignEliminator
+// step: unusedAssignEliminator
 //
 // {
 //     let c
--- a/test/libyul/yulOptimizerTests/unusedAssignEliminator/if_used_in_one_branch.yul
+++ b/test/libyul/yulOptimizerTests/unusedAssignEliminator/if_used_in_one_branch.yul
@ -11,7 +11,7 @@
    mstore(0, d)
 }
 // ----
-// step: redundantAssignEliminator
+// step: unusedAssignEliminator
 //
 // {
 //     let c
--- a/test/libyul/yulOptimizerTests/unusedAssignEliminator/leave.yul
+++ b/test/libyul/yulOptimizerTests/unusedAssignEliminator/leave.yul
@ -21,7 +21,7 @@
    }
 }
 // ----
-// step: redundantAssignEliminator
+// step: unusedAssignEliminator
 //
 // {
 //     function f(a, b) -> x
--- a/test/libyul/yulOptimizerTests/unusedAssignEliminator/multi_assign.yul
+++ b/test/libyul/yulOptimizerTests/unusedAssignEliminator/multi_assign.yul
@ -9,7 +9,7 @@
    y := 4
 }
 // ----
-// step: redundantAssignEliminator
+// step: unusedAssignEliminator
 //
 // {
 //     function f() -> a, b
--- a/test/libyul/yulOptimizerTests/unusedAssignEliminator/multivar.yul
+++ b/test/libyul/yulOptimizerTests/unusedAssignEliminator/multivar.yul
@ -6,7 +6,7 @@
    a := b
 }
 // ----
-// step: redundantAssignEliminator
+// step: unusedAssignEliminator
 //
 // {
 //     let a := 2
--- a/test/libyul/yulOptimizerTests/unusedAssignEliminator/non_movable.yul
+++ b/test/libyul/yulOptimizerTests/unusedAssignEliminator/non_movable.yul
@ -4,7 +4,7 @@
    a := mload(0)
 }
 // ----
-// step: redundantAssignEliminator
+// step: unusedAssignEliminator
 //
 // {
 //     let a
--- a/test/libyul/yulOptimizerTests/unusedAssignEliminator/remove_break.yul
+++ b/test/libyul/yulOptimizerTests/unusedAssignEliminator/remove_break.yul
@ -12,7 +12,7 @@
    }
 }
 // ----
-// step: redundantAssignEliminator
+// step: unusedAssignEliminator
 //
 // {
 //     let i := 0
--- a/test/libyul/yulOptimizerTests/unusedAssignEliminator/remove_continue.yul
+++ b/test/libyul/yulOptimizerTests/unusedAssignEliminator/remove_continue.yul
@ -13,7 +13,7 @@
 }

 // ----
-// step: redundantAssignEliminator
+// step: unusedAssignEliminator
 //
 // {
 //     let i := 0
--- a/test/libyul/yulOptimizerTests/unusedAssignEliminator/scopes.yul
+++ b/test/libyul/yulOptimizerTests/unusedAssignEliminator/scopes.yul
@ -7,7 +7,7 @@
    }
 }
 // ----
-// step: redundantAssignEliminator
+// step: unusedAssignEliminator
 //
 // {
 //     let a
--- a/test/libyul/yulOptimizerTests/unusedAssignEliminator/simple.yul
+++ b/test/libyul/yulOptimizerTests/unusedAssignEliminator/simple.yul
@ -4,6 +4,6 @@
    a := 2
 }
 // ----
-// step: redundantAssignEliminator
+// step: unusedAssignEliminator
 //
 // { let a }
--- a/test/libyul/yulOptimizerTests/unusedAssignEliminator/switch_overwrite_in_all.yul
+++ b/test/libyul/yulOptimizerTests/unusedAssignEliminator/switch_overwrite_in_all.yul
@ -8,7 +8,7 @@
    mstore(x, 0)
 }
 // ----
-// step: redundantAssignEliminator
+// step: unusedAssignEliminator
 //
 // {
 //     let x
--- a/test/libyul/yulOptimizerTests/unusedAssignEliminator/switch_overwrite_in_one.yul
+++ b/test/libyul/yulOptimizerTests/unusedAssignEliminator/switch_overwrite_in_one.yul
@ -7,7 +7,7 @@
    mstore(x, 0)
 }
 // ----
-// step: redundantAssignEliminator
+// step: unusedAssignEliminator
 //
 // {
 //     let x
--- a/test/libyul/yulOptimizerTests/unusedAssignEliminator/switch_overwrite_use_combination.yul
+++ b/test/libyul/yulOptimizerTests/unusedAssignEliminator/switch_overwrite_use_combination.yul
@ -8,7 +8,7 @@
    mstore(x, 0)
 }
 // ----
-// step: redundantAssignEliminator
+// step: unusedAssignEliminator
 //
 // {
 //     let x
--- a/test/libyul/yulOptimizerTests/unusedAssignEliminator/switch_unused.yul
+++ b/test/libyul/yulOptimizerTests/unusedAssignEliminator/switch_unused.yul
@ -6,7 +6,7 @@
    case 0 { mstore(0, 1) }
 }
 // ----
-// step: redundantAssignEliminator
+// step: unusedAssignEliminator
 //
 // {
 //     let x
--- a/test/yulPhaser/Chromosome.cpp
+++ b/test/yulPhaser/Chromosome.cpp
@ -138,7 +138,7 @@ BOOST_AUTO_TEST_CASE(output_operator_should_create_concise_and_unambiguous_strin

 	BOOST_TEST(chromosome.length() == allSteps.size());
 	BOOST_TEST(chromosome.optimisationSteps() == allSteps);
-	BOOST_TEST(toString(chromosome) == "flcCUnDvejsxIOoighFTLMRrmVatpud");
+	BOOST_TEST(toString(chromosome) == "flcCUnDvejsxIOoighFTLMRmVatrpud");
 }

 BOOST_AUTO_TEST_CASE(optimisationSteps_should_translate_chromosomes_genes_to_optimisation_step_names)