test_nested_frame_state_access()

Documentation for tests/benchmark/compute/instruction/test_storage.py::test_nested_frame_state_access@814481c0.

Generate fixtures for these test cases for Amsterdam with:

fill -v tests/benchmark/compute/instruction/test_storage.py::test_nested_frame_state_access --gas-benchmark-values 1

Benchmark warm state access from the bottom of a deep frame stack.

Source code in tests/benchmark/compute/instruction/test_storage.py

@pytest.mark.parametrize("revert", [True, False])
@pytest.mark.parametrize("depth", [1, pytest.param(None, id="max")])
@pytest.mark.parametrize(
    "opcode",
    [
        Op.SLOAD,
        Op.SSTORE,
        Op.TLOAD,
        Op.TSTORE,
    ],
)
def test_nested_frame_state_access(
    benchmark_test: BenchmarkTestFiller,
    pre: Alloc,
    fork: Fork,
    tx_gas_limit: int,
    gas_benchmark_value: int,
    depth: int | None,
    opcode: Op,
    revert: bool,
) -> None:
    """Benchmark warm state access from the bottom of a deep frame stack."""
    match opcode:
        case Op.SLOAD:
            body = Op.POP(Op.SLOAD(Op.PUSH0))
        case Op.SSTORE:
            body = Op.SSTORE(Op.GAS, Op.GAS)
        case Op.TLOAD:
            body = Op.POP(Op.TLOAD(Op.GAS))
        case Op.TSTORE:
            body = Op.TSTORE(Op.GAS, Op.GAS)
        case _:
            raise ValueError(f"Unsupported opcode: {opcode}")

    # A leaf that runs out of gas returns no data, unlike one that reverts.
    epilogue = (
        Op.REVERT(
            0,
            32,
            # gas accounting
            old_memory_size=0,
            new_memory_size=32,
        )
        if revert
        else Op.RETURN(
            0,
            32,
            # gas accounting
            old_memory_size=0,
            new_memory_size=32,
        )
    )
    leaf_code = (
        WhileGas(body=body, fork=fork, extra_gas=epilogue.gas_cost(fork))
        + epilogue
    )
    leaf_address = pre.deploy_contract(code=leaf_code)

    descend = Op.MSTORE(0, Op.SUB(Op.CALLDATALOAD(0), 1)) + Conditional(
        condition=Op.CALL(
            gas=Op.GAS,
            address=Op.ADDRESS,
            args_offset=0,
            args_size=32,
            address_warm=True,
        ),
        if_false=Op.REVERT(0, 0),
    )
    invoke_leaf = Op.CALL(
        gas=Op.GAS, address=leaf_address, address_warm=False
    ) + Conditional(
        condition=Op.RETURNDATASIZE, if_false=Op.REVERT(Op.PUSH0, Op.PUSH0)
    )

    frame_code = Conditional(
        condition=Op.CALLDATALOAD(0),
        if_true=descend,
        if_false=invoke_leaf,
    )
    entry_address = pre.deploy_contract(code=frame_code)

    frame_gas = frame_code.gas_cost(fork)
    leaf_gas = leaf_code.gas_cost(fork)
    leaf_state_gas = leaf_code.state_cost(fork)

    def deepest_frame(execution_gas: int) -> int:
        """Return the deepest frame that can still afford the leaf call."""
        leaf_call_gas = frame_gas + math.ceil(leaf_gas * 64 / 63)
        frames = 0
        while True:
            forwarded_gas = execution_gas - frame_gas
            forwarded_gas -= forwarded_gas // 64
            if forwarded_gas < leaf_call_gas:
                return frames
            execution_gas = forwarded_gas
            frames += 1

    intrinsic_gas = fork.transaction_intrinsic_cost_calculator()(
        calldata=b"\xff" * 32,
        return_cost_deducted_prior_execution=True,
    )

    txs = []
    remaining_gas = gas_benchmark_value
    while remaining_gas > 0:
        execution_gas = min(tx_gas_limit, remaining_gas)
        remaining_gas -= execution_gas
        reservoir_gas = (
            leaf_state_gas
            if fork.state_gas_reservoir_enabled()
            and execution_gas == tx_gas_limit
            else 0
        )
        txs.append(
            Transaction(
                to=entry_address,
                gas_limit=execution_gas + reservoir_gas,
                data=Hash(
                    deepest_frame(execution_gas - intrinsic_gas)
                    if depth is None
                    else depth
                ),
                sender=pre.fund_eoa(),
            )
        )

    benchmark_test(
        target_opcode=opcode,
        skip_gas_used_validation=True,
        expected_receipt_status=1,
        blocks=[Block(txs=txs)],
    )

Parametrized Test Cases

This test generates 16 parametrized test cases across 3 forks.