chore(avm): refactor AVM Simulator and fix issues #4424
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,18 @@ | ||
| // import { AztecAddress, Fr } from '@aztec/circuits.js'; | ||
| // import { initContext } from './fixtures/index.js'; | ||
|
|
||
| describe('Avm Context', () => { | ||
| it('New call should fork context correctly', () => { | ||
| // const context = initContext(); | ||
| // const newAddress = AztecAddress.random(); | ||
| // const newCalldata = [new Fr(1), new Fr(2)]; | ||
| // const newContext = context.createNestedContractCallContext(newAddress, newCalldata); | ||
| }); | ||
|
|
||
| it('New static call should fork context correctly', () => { | ||
| // const context = initContext(); | ||
| // const newAddress = AztecAddress.random(); | ||
| // const newCalldata = [new Fr(1), new Fr(2)]; | ||
| // const newContext = context.createNestedContractStaticCallContext(newAddress, newCalldata); | ||
| }); | ||
| }); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,140 +1,63 @@ | ||
| import { AztecAddress } from '@aztec/circuits.js'; | ||
| import { Fr } from '@aztec/foundation/fields'; | ||
|
|
||
| import { AvmExecutionEnvironment } from './avm_execution_environment.js'; | ||
| import { AvmMachineState } from './avm_machine_state.js'; | ||
| import { AvmWorldStateJournal } from './journal/journal.js'; | ||
|
|
||
| /** | ||
| * An execution context includes the information necessary to initiate AVM | ||
| * execution along with all state maintained by the AVM throughout execution. | ||
| */ | ||
| export class AvmContext { | ||
| /** | ||
| * Create a new AVM context | ||
| * @param worldState - Manages mutable state during execution - (caching, fetching) | ||
| * @param environment - Contains constant variables provided by the kernel | ||
| * @param machineState - VM state that is modified on an instruction-by-instruction basis | ||
| * @returns new AvmContext instance | ||
| */ | ||
| constructor( | ||
| public worldState: AvmWorldStateJournal, | ||
| public environment: AvmExecutionEnvironment, | ||
| public machineState: AvmMachineState, | ||
| ) {} | ||
|
|
||
| /** | ||
| * Prepare a new AVM context that will be ready for an external/nested call | ||
| * - Fork the world state journal | ||
| * - Derive a machine state from the current state | ||
| * - E.g., gas metering is preserved but pc is reset | ||
| * - Derive an execution environment from the caller/parent | ||
| * - Alter both address and storageAddress | ||
| * | ||
| * @param address - The contract instance to initialize a context for | ||
| * @param calldata - Data/arguments for nested call | ||
| * @returns new AvmContext instance | ||
| */ | ||
| public createNestedContractCallContext(address: AztecAddress, calldata: Fr[]): AvmContext { | ||
| const newExecutionEnvironment = this.environment.deriveEnvironmentForNestedCall(address, calldata); | ||
| const forkedWorldState = this.worldState.fork(); | ||
| const machineState = AvmMachineState.fromState(this.machineState); | ||
| return new AvmContext(forkedWorldState, newExecutionEnvironment, machineState); | ||
| } | ||
|
|
||
| /** | ||
| * Prepare a new AVM context that will be ready for an external/nested static call | ||
| * - Fork the world state journal | ||
| * - Derive a machine state from the current state | ||
| * - E.g., gas metering is preserved but pc is reset | ||
| * - Derive an execution environment from the caller/parent | ||
| * - Alter both address and storageAddress | ||
| * | ||
| * @param address - The contract instance to initialize a context for | ||
| * @param calldata - Data/arguments for nested call | ||
| * @returns new AvmContext instance | ||
| */ | ||
| public createNestedContractStaticCallContext(address: AztecAddress, calldata: Fr[]): AvmContext { | ||
| const newExecutionEnvironment = this.environment.deriveEnvironmentForNestedStaticCall(address, calldata); | ||
| const forkedWorldState = this.worldState.fork(); | ||
| const machineState = AvmMachineState.fromState(this.machineState); | ||
| return new AvmContext(forkedWorldState, newExecutionEnvironment, machineState); | ||
|
There was a problem hiding this comment. Nested context needs to take in args for l1/l2/daGas as they aren't derived from the parent context but are actually arguments to the call/staticcall instructions. |
||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,69 +1,93 @@ | ||
| import { Fr } from '@aztec/circuits.js'; | ||
|
|
||
| import { TaggedMemory } from './avm_memory_types.js'; | ||
| import { AvmContractCallResults } from './avm_message_call_result.js'; | ||
|
|
||
| /** | ||
| * A few fields of machine state are initialized from AVM session inputs or call instruction arguments | ||
| */ | ||
| export type InitialAvmMachineState = { | ||
| l1GasLeft: number; | ||
| l2GasLeft: number; | ||
| daGasLeft: number; | ||
| }; | ||
|
|
||
| /** | ||
| * Avm state modified on an instruction-per-instruction basis. | ||
| */ | ||
| export class AvmMachineState { | ||
| public l1GasLeft: number; | ||
| /** gas remaining of the gas allocated for a contract call */ | ||
| public l2GasLeft: number; | ||
| public daGasLeft: number; | ||
| /** program counter */ | ||
| public pc: number = 0; | ||
|
|
||
| /** | ||
| * On INTERNALCALL, internal call stack is pushed to with the current pc + 1 | ||
| * On INTERNALRETURN, value is popped from the internal call stack and assigned to the pc. | ||
| */ | ||
| public internalCallStack: number[] = []; | ||
|
|
||
| /** Memory accessible to user code */ | ||
| public readonly memory: TaggedMemory = new TaggedMemory(); | ||
|
|
||
| /** | ||
| * Signals that execution should end. | ||
| * AvmContext execution continues executing instructions until the machine state signals "halted" | ||
| * */ | ||
| public halted: boolean = false; | ||
| /** Signals that execution has reverted normally (this does not cover exceptional halts) */ | ||
| private reverted: boolean = false; | ||
| /** Output data must NOT be modified once it is set */ | ||
| private output: Fr[] = []; | ||
|
|
||
| constructor(l1GasLeft: number, l2GasLeft: number, daGasLeft: number) { | ||
| this.l1GasLeft = l1GasLeft; | ||
| this.l2GasLeft = l2GasLeft; | ||
| this.daGasLeft = daGasLeft; | ||
| } | ||
|
|
||
| public static fromState(state: InitialAvmMachineState): AvmMachineState { | ||
| return new AvmMachineState(state.l1GasLeft, state.l2GasLeft, state.daGasLeft); | ||
| } | ||
|
|
||
| /** | ||
| * Most instructions just increment PC before they complete | ||
| */ | ||
| public incrementPc() { | ||
| this.pc++; | ||
| } | ||
|
|
||
| /** | ||
| * Halt as successful | ||
| * Output data must NOT be modified once it is set | ||
| * @param output | ||
| */ | ||
| public return(output: Fr[]) { | ||
| this.halted = true; | ||
| this.output = output; | ||
| } | ||
|
|
||
| /** | ||
| * Halt as reverted | ||
| * Output data must NOT be modified once it is set | ||
| * @param output | ||
| */ | ||
| public revert(output: Fr[]) { | ||
| this.halted = true; | ||
| this.reverted = true; | ||
| this.output = output; | ||
| } | ||
|
|
||
| /** | ||
| * Get a summary of execution results for a halted machine state | ||
| * @returns summary of execution results | ||
| */ | ||
| public getResults(): AvmContractCallResults { | ||
| if (!this.halted) { | ||
| throw new Error('Execution results are not ready! Execution is ongoing.'); | ||
| } | ||
| return new AvmContractCallResults(this.reverted, this.output); | ||
| } | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Gas metering actually is not preserved. You allocate gas to a nested context via the call instruction's gas argument.