Merge pull request #12795 from ethereum/morePopRemovalInPeepholeOptimizer

chriseth · web-flow · commit 430ecb6e16c3 · 2022-03-17T12:22:48.000+01:00
More pop removal in peephole optimizer.
diff --git a/Changelog.md b/Changelog.md
@@ -4,6 +4,7 @@ Language Features:
 
 
 Compiler Features:
+ * Peephole Optimizer: Remove operations without side effects before simple terminations.
 
 
 Bugfixes:
diff --git a/libevmasm/PeepholeOptimiser.cpp b/libevmasm/PeepholeOptimiser.cpp
@@ -146,6 +146,35 @@ struct OpStop: SimplePeepholeOptimizerMethod<OpStop>
 	}
 };
 
+struct OpReturnRevert: SimplePeepholeOptimizerMethod<OpReturnRevert>
+{
+	static bool applySimple(
+		AssemblyItem const& _op,
+		AssemblyItem const& _push,
+		AssemblyItem const& _pushOrDup,
+		AssemblyItem const& _returnRevert,
+		std::back_insert_iterator<AssemblyItems> _out
+	)
+	{
+		if (
+			(_returnRevert == Instruction::RETURN || _returnRevert == Instruction::REVERT) &&
+			_push.type() == Push &&
+			(_pushOrDup.type() == Push || _pushOrDup == dupInstruction(1))
+		)
+			if (
+				(_op.type() == Operation && !instructionInfo(_op.instruction()).sideEffects) ||
+				_op.type() == Push
+			)
+			{
+					*_out = _push;
+					*_out = _pushOrDup;
+					*_out = _returnRevert;
+					return true;
+			}
+		return false;
+	}
+};
+
 struct DoubleSwap: SimplePeepholeOptimizerMethod<DoubleSwap>
 {
 	static size_t applySimple(AssemblyItem const& _s1, AssemblyItem const& _s2, std::back_insert_iterator<AssemblyItems>)
@@ -459,7 +488,7 @@ bool PeepholeOptimiser::optimise()
 	while (state.i < m_items.size())
 		applyMethods(
 			state,
-			PushPop(), OpPop(), OpStop(), DoublePush(), DoubleSwap(), CommutativeSwap(), SwapComparison(),
+			PushPop(), OpPop(), OpStop(), OpReturnRevert(), DoublePush(), DoubleSwap(), CommutativeSwap(), SwapComparison(),
 			DupSwap(), IsZeroIsZeroJumpI(), EqIsZeroJumpI(), DoubleJump(), JumpToNext(), UnreachableCode(),
 			TagConjunctions(), TruthyAnd(), Identity()
 		);
diff --git a/test/cmdlineTests/function_debug_info_via_yul/output b/test/cmdlineTests/function_debug_info_via_yul/output
@@ -13,7 +13,7 @@
         },
         "calldata_array_index_access_uint256_dyn_calldata":
         {
-          "entryPoint": 145,
+          "entryPoint": 144,
           "parameterSlots": 2,
           "returnSlots": 1
         }
diff --git a/test/cmdlineTests/viair_subobject_optimization/output b/test/cmdlineTests/viair_subobject_optimization/output
@@ -125,7 +125,6 @@ sub_0: assembly {
       eq
       tag_4
       jumpi
-      pop
       0x00
       dup1
       revert
diff --git a/test/libsolidity/semanticTests/abiEncoderV2/abi_encode_v2_in_function_inherited_in_v1_contract.sol b/test/libsolidity/semanticTests/abiEncoderV2/abi_encode_v2_in_function_inherited_in_v1_contract.sol
@@ -32,6 +32,6 @@ contract C is B {
 // compileViaYul: also
 // ----
 // test() -> 77
-// gas irOptimized: 119911
+// gas irOptimized: 119711
 // gas legacy: 155093
 // gas legacyOptimized: 111550
diff --git a/test/libsolidity/semanticTests/array/constant_var_as_array_length.sol b/test/libsolidity/semanticTests/array/constant_var_as_array_length.sol
@@ -11,7 +11,7 @@ contract C {
 // compileViaYul: also
 // ----
 // constructor(): 1, 2, 3 ->
-// gas irOptimized: 142856
+// gas irOptimized: 142640
 // gas legacy: 183490
 // gas legacyOptimized: 151938
 // a(uint256): 0 -> 1
diff --git a/test/libsolidity/semanticTests/array/fixed_arrays_as_return_type.sol b/test/libsolidity/semanticTests/array/fixed_arrays_as_return_type.sol
@@ -21,6 +21,6 @@ contract B {
 // compileViaYul: also
 // ----
 // f() -> 2, 3, 4, 5, 6, 1000, 1001, 1002, 1003, 1004
-// gas irOptimized: 128110
+// gas irOptimized: 127910
 // gas legacy: 234719
 // gas legacyOptimized: 132639
diff --git a/test/libsolidity/semanticTests/array/function_array_cross_calls.sol b/test/libsolidity/semanticTests/array/function_array_cross_calls.sol
@@ -45,6 +45,6 @@ contract C {
 // compileViaYul: also
 // ----
 // test() -> 5, 6, 7
-// gas irOptimized: 292702
+// gas irOptimized: 292502
 // gas legacy: 452136
 // gas legacyOptimized: 284945
diff --git a/test/libsolidity/semanticTests/array/reusing_memory.sol b/test/libsolidity/semanticTests/array/reusing_memory.sol
@@ -26,6 +26,6 @@ contract Main {
 // compileViaYul: also
 // ----
 // f(uint256): 0x34 -> 0x46bddb1178e94d7f2892ff5f366840eb658911794f2c3a44c450aa2c505186c1
-// gas irOptimized: 113398
+// gas irOptimized: 113198
 // gas legacy: 126596
 // gas legacyOptimized: 113823
diff --git a/test/libsolidity/semanticTests/constructor/bytes_in_constructors_packer.sol b/test/libsolidity/semanticTests/constructor/bytes_in_constructors_packer.sol
@@ -26,6 +26,6 @@ contract Creator {
 // compileViaYul: also
 // ----
 // f(uint256,bytes): 7, 0x40, 78, "abcdefghijklmnopqrstuvwxyzabcdef", "ghijklmnopqrstuvwxyzabcdefghijkl", "mnopqrstuvwxyz" -> 7, "h"
-// gas irOptimized: 295403
+// gas irOptimized: 293203
 // gas legacy: 428711
 // gas legacyOptimized: 297922
diff --git a/test/libsolidity/semanticTests/constructor/bytes_in_constructors_unpacker.sol b/test/libsolidity/semanticTests/constructor/bytes_in_constructors_unpacker.sol
@@ -10,7 +10,7 @@ contract Test {
 // compileViaYul: also
 // ----
 // constructor(): 7, 0x40, 78, "abcdefghijklmnopqrstuvwxyzabcdef", "ghijklmnopqrstuvwxyzabcdefghijkl", "mnopqrstuvwxyz" ->
-// gas irOptimized: 286205
+// gas irOptimized: 283829
 // gas legacy: 309607
 // gas legacyOptimized: 260566
 // m_x() -> 7
diff --git a/test/libsolidity/semanticTests/constructor_with_params_diamond_inheritance.sol b/test/libsolidity/semanticTests/constructor_with_params_diamond_inheritance.sol
@@ -23,7 +23,7 @@ contract D is B, C {
 // compileViaYul: also
 // ----
 // constructor(): 2, 0 ->
-// gas irOptimized: 158225
+// gas irOptimized: 156071
 // gas legacy: 170665
 // gas legacyOptimized: 145396
 // i() -> 2
diff --git a/test/libsolidity/semanticTests/events/event_emit_from_other_contract.sol b/test/libsolidity/semanticTests/events/event_emit_from_other_contract.sol
@@ -17,7 +17,7 @@ contract C {
 // compileViaYul: also
 // ----
 // constructor() ->
-// gas irOptimized: 173316
+// gas irOptimized: 173094
 // gas legacy: 250376
 // gas legacyOptimized: 174522
 // deposit(bytes32), 18 wei: 0x1234 ->
diff --git a/test/libsolidity/semanticTests/externalContracts/deposit_contract.sol b/test/libsolidity/semanticTests/externalContracts/deposit_contract.sol
@@ -178,7 +178,7 @@ contract DepositContract is IDepositContract, ERC165 {
 // compileViaYul: also
 // ----
 // constructor()
-// gas irOptimized: 1532125
+// gas irOptimized: 1529797
 // gas legacy: 2435803
 // gas legacyOptimized: 1775425
 // supportsInterface(bytes4): 0x0 -> 0
diff --git a/test/libsolidity/semanticTests/externalContracts/prbmath_unsigned.sol b/test/libsolidity/semanticTests/externalContracts/prbmath_unsigned.sol
@@ -50,7 +50,7 @@ contract test {
 // compileViaYul: also
 // ----
 // constructor()
-// gas irOptimized: 1783505
+// gas irOptimized: 1780841
 // gas legacy: 2248594
 // gas legacyOptimized: 1749096
 // div(uint256,uint256): 3141592653589793238, 88714123 -> 35412542528203691288251815328
diff --git a/test/libsolidity/semanticTests/externalContracts/ramanujan_pi.sol b/test/libsolidity/semanticTests/externalContracts/ramanujan_pi.sol
@@ -35,7 +35,7 @@ contract test {
 // compileViaYul: also
 // ----
 // constructor()
-// gas irOptimized: 456094
+// gas irOptimized: 455866
 // gas legacy: 671453
 // gas legacyOptimized: 480242
 // prb_pi() -> 3141592656369545286
diff --git a/test/libsolidity/semanticTests/functionCall/creation_function_call_with_args.sol b/test/libsolidity/semanticTests/functionCall/creation_function_call_with_args.sol
@@ -17,7 +17,7 @@ contract D {
 // compileViaYul: also
 // ----
 // constructor(): 2 ->
-// gas irOptimized: 200649
+// gas irOptimized: 200217
 // gas legacy: 245842
 // gas legacyOptimized: 195676
 // f() -> 2
diff --git a/test/libsolidity/semanticTests/functionCall/creation_function_call_with_salt.sol b/test/libsolidity/semanticTests/functionCall/creation_function_call_with_salt.sol
@@ -18,7 +18,7 @@ contract D {
 // compileViaYul: also
 // ----
 // constructor(): 2 ->
-// gas irOptimized: 200812
+// gas irOptimized: 200380
 // gas legacy: 246202
 // gas legacyOptimized: 195914
 // f() -> 2
diff --git a/test/libsolidity/semanticTests/functionCall/external_call_to_nonexisting.sol b/test/libsolidity/semanticTests/functionCall/external_call_to_nonexisting.sol
@@ -25,7 +25,7 @@ contract C {
 // compileViaYul: also
 // ----
 // constructor(), 1 ether ->
-// gas irOptimized: 304151
+// gas irOptimized: 303935
 // gas legacy: 464030
 // gas legacyOptimized: 304049
 // f(uint256): 0 -> FAILURE
diff --git a/test/libsolidity/semanticTests/functionCall/failed_create.sol b/test/libsolidity/semanticTests/functionCall/failed_create.sol
@@ -18,7 +18,7 @@ contract C {
 // compileViaYul: also
 // ----
 // constructor(), 20 wei
-// gas irOptimized: 214971
+// gas irOptimized: 212583
 // gas legacy: 294335
 // gas legacyOptimized: 174279
 // f(uint256): 20 -> 1370859564726510389319704988634906228201275401179
diff --git a/test/libsolidity/semanticTests/functionCall/gas_and_value_basic.sol b/test/libsolidity/semanticTests/functionCall/gas_and_value_basic.sol
@@ -41,7 +41,7 @@ contract test {
 // compileViaYul: also
 // ----
 // constructor(), 20 wei ->
-// gas irOptimized: 275142
+// gas irOptimized: 270609
 // gas legacy: 402654
 // gas legacyOptimized: 274470
 // sendAmount(uint256): 5 -> 5
diff --git a/test/libsolidity/semanticTests/functionCall/gas_and_value_brace_syntax.sol b/test/libsolidity/semanticTests/functionCall/gas_and_value_brace_syntax.sol
@@ -40,7 +40,7 @@ contract test {
 // compileViaYul: also
 // ----
 // constructor(), 20 wei ->
-// gas irOptimized: 275142
+// gas irOptimized: 270609
 // gas legacy: 402654
 // gas legacyOptimized: 274470
 // sendAmount(uint256): 5 -> 5
diff --git a/test/libsolidity/semanticTests/functionCall/send_zero_ether.sol b/test/libsolidity/semanticTests/functionCall/send_zero_ether.sol
@@ -19,7 +19,7 @@ contract Main {
 // compileViaYul: also
 // ----
 // constructor(), 20 wei ->
-// gas irOptimized: 100480
+// gas irOptimized: 100264
 // gas legacy: 116691
 // gas legacyOptimized: 100361
 // s() -> true
diff --git a/test/libsolidity/semanticTests/immutable/multi_creation.sol b/test/libsolidity/semanticTests/immutable/multi_creation.sol
@@ -29,7 +29,7 @@ contract C {
 // compileViaYul: also
 // ----
 // f() -> 3, 7, 5
-// gas irOptimized: 126536
+// gas irOptimized: 126136
 // gas legacy: 151334
 // gas legacyOptimized: 125166
 // x() -> 7
diff --git a/test/libsolidity/semanticTests/immutable/use_scratch.sol b/test/libsolidity/semanticTests/immutable/use_scratch.sol
@@ -17,7 +17,7 @@ contract C {
 // compileViaYul: also
 // ----
 // constructor(): 3 ->
-// gas irOptimized: 129602
+// gas irOptimized: 127454
 // gas legacy: 209361
 // gas legacyOptimized: 139324
 // f() -> 84, 23
diff --git a/test/libsolidity/semanticTests/inheritance/inherited_function_calldata_memory_interface.sol b/test/libsolidity/semanticTests/inheritance/inherited_function_calldata_memory_interface.sol
@@ -25,6 +25,6 @@ contract B {
 // compileViaYul: also
 // ----
 // g() -> 42
-// gas irOptimized: 102144
+// gas irOptimized: 101944
 // gas legacy: 185053
 // gas legacyOptimized: 114598
diff --git a/test/libsolidity/semanticTests/inheritance/value_for_constructor.sol b/test/libsolidity/semanticTests/inheritance/value_for_constructor.sol
@@ -42,7 +42,7 @@ contract Main {
 // compileViaYul: also
 // ----
 // constructor(), 22 wei ->
-// gas irOptimized: 280056
+// gas irOptimized: 277680
 // gas legacy: 402045
 // gas legacyOptimized: 266772
 // getFlag() -> true
diff --git a/test/libsolidity/semanticTests/isoltestTesting/balance_other_contract.sol b/test/libsolidity/semanticTests/isoltestTesting/balance_other_contract.sol
@@ -18,7 +18,7 @@ contract ClientReceipt {
 // compileViaYul: also
 // ----
 // constructor(), 2000 wei ->
-// gas irOptimized: 183976
+// gas irOptimized: 183544
 // gas legacy: 235195
 // gas legacyOptimized: 176766
 // balance -> 1500
diff --git a/test/libsolidity/semanticTests/salted_create/salted_create_with_value.sol b/test/libsolidity/semanticTests/salted_create/salted_create_with_value.sol
@@ -22,6 +22,6 @@ contract A {
 // compileViaYul: also
 // ----
 // f(), 10 ether -> 3007, 3008, 3009
-// gas irOptimized: 272431
+// gas irOptimized: 271831
 // gas legacy: 422501
 // gas legacyOptimized: 287472
diff --git a/test/libsolidity/semanticTests/smoke/constructor.sol b/test/libsolidity/semanticTests/smoke/constructor.sol
@@ -14,7 +14,7 @@ contract C {
 // compileViaYul: also
 // ----
 // constructor(), 2 wei: 3 ->
-// gas irOptimized: 109775
+// gas irOptimized: 107627
 // gas legacy: 151416
 // gas legacyOptimized: 108388
 // state() -> 3
diff --git a/test/libsolidity/semanticTests/state/blockhash_basic.sol b/test/libsolidity/semanticTests/state/blockhash_basic.sol
@@ -14,7 +14,7 @@ contract C {
 // compileViaYul: also
 // ----
 // constructor()
-// gas irOptimized: 113738
+// gas irOptimized: 111584
 // gas legacy: 155081
 // gas legacyOptimized: 107997
 // genesisHash() -> 0x3737373737373737373737373737373737373737373737373737373737373737
diff --git a/test/libsolidity/semanticTests/various/address_code.sol b/test/libsolidity/semanticTests/various/address_code.sol
@@ -17,7 +17,7 @@ contract C {
 // compileViaYul: also
 // ----
 // constructor() ->
-// gas irOptimized: 194717
+// gas irOptimized: 192317
 // gas legacy: 240889
 // gas legacyOptimized: 155314
 // initCode() -> 0x20, 0
diff --git a/test/libsolidity/semanticTests/various/contract_binary_dependencies.sol b/test/libsolidity/semanticTests/various/contract_binary_dependencies.sol
@@ -21,4 +21,4 @@ contract C {
 // compileViaYul: also
 // ----
 // constructor() ->
-// gas irOptimized: 101495
+// gas irOptimized: 101063
diff --git a/test/libsolidity/semanticTests/various/senders_balance.sol b/test/libsolidity/semanticTests/various/senders_balance.sol
@@ -19,7 +19,7 @@ contract D {
 // compileViaYul: also
 // ----
 // constructor(), 27 wei ->
-// gas irOptimized: 175589
+// gas irOptimized: 175157
 // gas legacy: 222977
 // gas legacyOptimized: 169779
 // f() -> 27
diff --git a/test/libsolidity/semanticTests/various/staticcall_for_view_and_pure.sol b/test/libsolidity/semanticTests/various/staticcall_for_view_and_pure.sol
@@ -38,10 +38,10 @@ contract D {
 // f() -> 0x1 # This should work, next should throw #
 // gas legacy: 103716
 // fview() -> FAILURE
-// gas irOptimized: 98438622
+// gas irOptimized: 98438619
 // gas legacy: 98438801
 // gas legacyOptimized: 98438594
 // fpure() -> FAILURE
-// gas irOptimized: 98438622
+// gas irOptimized: 98438619
 // gas legacy: 98438801
 // gas legacyOptimized: 98438595
diff --git a/test/libsolidity/semanticTests/various/value_complex.sol b/test/libsolidity/semanticTests/various/value_complex.sol
@@ -22,7 +22,7 @@ contract test {
 // compileViaYul: also
 // ----
 // constructor(), 20 wei ->
-// gas irOptimized: 190491
+// gas irOptimized: 190275
 // gas legacy: 265006
 // gas legacyOptimized: 182842
 // sendAmount(uint256): 5 -> 8
diff --git a/test/libsolidity/semanticTests/various/value_insane.sol b/test/libsolidity/semanticTests/various/value_insane.sol
@@ -21,7 +21,7 @@ contract test {
 // compileViaYul: also
 // ----
 // constructor(), 20 wei ->
-// gas irOptimized: 192213
+// gas irOptimized: 191991
 // gas legacy: 266728
 // gas legacyOptimized: 184762
 // sendAmount(uint256): 5 -> 8

Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@ Language Features:`
`4`	`4`
`5`	`5`
`6`	`6`	`Compiler Features:`
	`7`	`+ * Peephole Optimizer: Remove operations without side effects before simple terminations.`
`7`	`8`
`8`	`9`
`9`	`10`	`Bugfixes:`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@`
`13`	`13`	`},`
`14`	`14`	`"calldata_array_index_access_uint256_dyn_calldata":`
`15`	`15`	`{`
`16`		`- "entryPoint": 145,`
	`16`	`+ "entryPoint": 144,`
`17`	`17`	`"parameterSlots": 2,`
`18`	`18`	`"returnSlots": 1`
`19`	`19`	`}`
-Original file line number
+Diff line change
       eq
       tag_4
       jumpi
 -      pop
 x00
       dup1
       revert