Skip to content

Commit

Permalink
Formatting and fixes.
Browse files Browse the repository at this point in the history
  • Loading branch information
@fcarreiro
fcarreiro committed Mar 11, 2024
1 parent 07dd821 commit bec0963
Show file tree
Hide file tree
Showing 11 changed files with 175 additions and 161 deletions.
22 changes: 0 additions & 22 deletions avm-transpiler/src/opcodes.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,27 +2,20 @@
/// Keep updated with TS and yellow paper!
#[derive(Copy, Clone)]
pub enum AvmOpcode {
// Compute
// Compute - Arithmetic
ADD,
SUB,
MUL,
DIV,
// Compute - Comparators
EQ,
LT,
LTE,
// Compute - Bitwise
AND,
OR,
XOR,
NOT,
SHL,
SHR,
// Compute - Type Conversions
CAST,

// Execution Environment
ADDRESS,
STORAGEADDRESS,
ORIGIN,
Expand All @@ -32,7 +25,6 @@ pub enum AvmOpcode {
FEEPERL2GAS,
FEEPERDAGAS,
CONTRACTCALLDEPTH,
// Execution Environment - Globals
CHAINID,
VERSION,
BLOCKNUMBER,
Expand All @@ -41,25 +33,17 @@ pub enum AvmOpcode {
BLOCKL1GASLIMIT,
BLOCKL2GASLIMIT,
BLOCKDAGASLIMIT,
// Execution Environment - Calldata
CALLDATACOPY,

// Machine State
// Machine State - Gas
L1GASLEFT,
L2GASLEFT,
DAGASLEFT,
// Machine State - Internal Control Flow
JUMP,
JUMPI,
INTERNALCALL,
INTERNALRETURN,
// Machine State - Memory
SET,
MOV,
CMOV,

// World State
SLOAD, // Public Storage
SSTORE, // Public Storage
NOTEHASHEXISTS, // Notes & Nullifiers
Expand All @@ -68,19 +52,13 @@ pub enum AvmOpcode {
EMITNULLIFIER, // Notes & Nullifiers
L1TOL2MSGEXISTS, // Messages
HEADERMEMBER, // Archive tree & Headers

// Accrued Substate
EMITUNENCRYPTEDLOG,
SENDL2TOL1MSG,

// Control Flow - Contract Calls
CALL,
STATICCALL,
DELEGATECALL,
RETURN,
REVERT,

// Gadgets
KECCAK,
POSEIDON,
SHA256,
Expand Down
39 changes: 36 additions & 3 deletions yarn-project/simulator/src/avm/avm_memory_types.ts
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import { toBufferBE } from '@aztec/foundation/bigint-buffer';
import { Fr } from '@aztec/foundation/fields';
import { DebugLogger, createDebugLogger } from '@aztec/foundation/log';

import { strict as assert } from 'assert';

Expand Down Expand Up @@ -28,6 +29,10 @@ export abstract class MemoryValue {
public toFr(): Fr {
return new Fr(this.toBigInt());
}

public toString(): string {
return `${this.constructor.name}(0x${this.toBigInt().toString(16)})`;
}
}

/** IntegralValue gathers the common operations for all integral memory types. */
Expand Down Expand Up @@ -189,6 +194,8 @@ export enum TypeTag {

// TODO: Consider automatic conversion when getting undefined values.
export class TaggedMemory {
static readonly log: DebugLogger = createDebugLogger('aztec:avm_simulator:memory');

// FIXME: memory should be 2^32, but TS doesn't allow for arrays that big.
static readonly MAX_MEMORY_SIZE = Number((1n << 32n) - 2n);
private _mem: MemoryValue[];
Expand All @@ -200,25 +207,29 @@ export class TaggedMemory {

public get(offset: number): MemoryValue {
assert(offset < TaggedMemory.MAX_MEMORY_SIZE);
return this.getAs<MemoryValue>(offset);
const value = this.getAs<MemoryValue>(offset);
return value;
}

public getAs<T>(offset: number): T {
assert(offset < TaggedMemory.MAX_MEMORY_SIZE);
const word = this._mem[offset];
TaggedMemory.log(`get(${offset}) = ${word}`);
return word as T;
}

public getSlice(offset: number, size: number): MemoryValue[] {
assert(offset < TaggedMemory.MAX_MEMORY_SIZE);
assert(offset + size < TaggedMemory.MAX_MEMORY_SIZE);
return this._mem.slice(offset, offset + size);
const value = this._mem.slice(offset, offset + size);
TaggedMemory.log(`getSlice(${offset}, ${size}) = ${value}`);
return value;
}

public getSliceAs<T>(offset: number, size: number): T[] {
assert(offset < TaggedMemory.MAX_MEMORY_SIZE);
assert(offset + size < TaggedMemory.MAX_MEMORY_SIZE);
return this._mem.slice(offset, offset + size) as T[];
return this.getSlice(offset, size) as T[];
}

public getSliceTags(offset: number, size: number): TypeTag[] {
Expand All @@ -230,6 +241,7 @@ export class TaggedMemory {
public set(offset: number, v: MemoryValue) {
assert(offset < TaggedMemory.MAX_MEMORY_SIZE);
this._mem[offset] = v;
TaggedMemory.log(`set(${offset}, ${v})`);
}

public setSlice(offset: number, vs: MemoryValue[]) {
Expand All @@ -240,6 +252,7 @@ export class TaggedMemory {
this._mem.length = offset + vs.length;
}
this._mem.splice(offset, vs.length, ...vs);
TaggedMemory.log(`setSlice(${offset}, ${vs})`);
}

public getTag(offset: number): TypeTag {
Expand Down Expand Up @@ -327,4 +340,24 @@ export class TaggedMemory {
throw new Error(`${TypeTag[tag]} is not a valid integral type.`);
}
}

// Does not truncate. Type constructor will check that it fits.
public static buildFromTagOrDie(v: bigint | number, tag: TypeTag): MemoryValue {
switch (tag) {
case TypeTag.UINT8:
return new Uint8(v);
case TypeTag.UINT16:
return new Uint16(v);
case TypeTag.UINT32:
return new Uint32(v);
case TypeTag.UINT64:
return new Uint64(v);
case TypeTag.UINT128:
return new Uint128(v);
case TypeTag.FIELD:
return new Field(v);
default:
throw new Error(`${TypeTag[tag]} is not a valid integral type.`);
}
}
}
2 changes: 1 addition & 1 deletion yarn-project/simulator/src/avm/avm_simulator.test.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ import { encodeToBytecode } from './serialization/bytecode_serialization.js';
function getAvmTestContractBytecode(functionName: string): Buffer {
const artifact = AvmTestContractArtifact.functions.find(f => f.name === functionName)!;
assert(
!!artifact.bytecode,
!!artifact?.bytecode,
`No bytecode found for function ${functionName}. Try re-running bootstraph.sh on the repository root.`,
);
return Buffer.from(artifact.bytecode, 'base64');
Expand Down
13 changes: 10 additions & 3 deletions yarn-project/simulator/src/avm/avm_simulator.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,13 @@ import type { Instruction } from './opcodes/index.js';
import { decodeFromBytecode } from './serialization/bytecode_serialization.js';

export class AvmSimulator {
private log: DebugLogger = createDebugLogger('aztec:avm_simulator');
private log: DebugLogger;

constructor(private context: AvmContext) {}
constructor(private context: AvmContext) {
this.log = createDebugLogger(
`aztec:avm_simulator:core(f:${context.environment.temporaryFunctionSelector.toString()})`,
);
}

/**
* Fetch the bytecode and execute it in the current context.
Expand Down Expand Up @@ -52,7 +56,10 @@ export class AvmSimulator {
// continuing until the machine state signifies a halt
while (!this.context.machineState.halted) {
const instruction = instructions[this.context.machineState.pc];
assert(!!instruction); // This should never happen
assert(
!!instruction,
'AVM attempted to execute non-existent instruction. This should never happen (invalid bytecode or AVM simulator bug)!',
);

this.log.debug(`@${this.context.machineState.pc} ${instruction.toString()}`);
// Execute the instruction.
Expand Down
2 changes: 2 additions & 0 deletions yarn-project/simulator/src/avm/opcodes/arithmetic.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ export class Add extends ThreeOperandInstruction {
}

async execute(context: AvmContext): Promise<void> {
context.machineState.memory.checkTags(this.inTag, this.aOffset, this.bOffset);

const a = context.machineState.memory.get(this.aOffset);
const b = context.machineState.memory.get(this.bOffset);

Expand Down
10 changes: 4 additions & 6 deletions yarn-project/simulator/src/avm/opcodes/comparators.ts
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import type { AvmContext } from '../avm_context.js';
import { TaggedMemory } from '../avm_memory_types.js';
import { Opcode } from '../serialization/instruction_serialization.js';
import { ThreeOperandInstruction } from './instruction_impl.js';

Expand All @@ -16,8 +17,7 @@ export class Eq extends ThreeOperandInstruction {
const a = context.machineState.memory.get(this.aOffset);
const b = context.machineState.memory.get(this.bOffset);

// Result will be of the same type as 'a'.
const dest = a.build(a.equals(b) ? 1n : 0n);
const dest = TaggedMemory.buildFromTagOrDie(a.equals(b) ? 1n : 0n, this.inTag);
context.machineState.memory.set(this.dstOffset, dest);

context.machineState.incrementPc();
Expand All @@ -38,8 +38,7 @@ export class Lt extends ThreeOperandInstruction {
const a = context.machineState.memory.get(this.aOffset);
const b = context.machineState.memory.get(this.bOffset);

// Result will be of the same type as 'a'.
const dest = a.build(a.lt(b) ? 1n : 0n);
const dest = TaggedMemory.buildFromTagOrDie(a.lt(b) ? 1n : 0n, this.inTag);
context.machineState.memory.set(this.dstOffset, dest);

context.machineState.incrementPc();
Expand All @@ -60,8 +59,7 @@ export class Lte extends ThreeOperandInstruction {
const a = context.machineState.memory.get(this.aOffset);
const b = context.machineState.memory.get(this.bOffset);

// Result will be of the same type as 'a'.
const dest = a.build(a.equals(b) || a.lt(b) ? 1n : 0n);
const dest = TaggedMemory.buildFromTagOrDie(a.lt(b) || a.equals(b) ? 1n : 0n, this.inTag);
context.machineState.memory.set(this.dstOffset, dest);

context.machineState.incrementPc();
Expand Down
72 changes: 3 additions & 69 deletions yarn-project/simulator/src/avm/opcodes/control_flow.test.ts
View file
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
import { Fr } from '@aztec/foundation/fields';

import { AvmContext } from '../avm_context.js';
import { Field, Uint16 } from '../avm_memory_types.js';
import { Uint16 } from '../avm_memory_types.js';
import { InstructionExecutionError } from '../errors.js';
import { initContext } from '../fixtures/index.js';
import { InternalCall, InternalReturn, Jump, JumpI, Return, Revert } from './control_flow.js';
import { InternalCall, InternalReturn, Jump, JumpI } from './control_flow.js';

describe('Control Flow Opcodes', () => {
let context: AvmContext;
Expand Down Expand Up @@ -82,7 +80,7 @@ describe('Control Flow Opcodes', () => {
});
});

describe('INTERNALCALL and RETURN', () => {
describe('INTERNALCALL and INTERNALRETURN', () => {
it('INTERNALCALL Should (de)serialize correctly', () => {
const buf = Buffer.from([
InternalCall.opcode, // opcode
Expand Down Expand Up @@ -151,68 +149,4 @@ describe('Control Flow Opcodes', () => {
}
});
});

describe('RETURN', () => {
it('Should (de)serialize correctly', () => {
const buf = Buffer.from([
Return.opcode, // opcode
0x01, // indirect
...Buffer.from('12345678', 'hex'), // returnOffset
...Buffer.from('a2345678', 'hex'), // copySize
]);
const inst = new Return(/*indirect=*/ 0x01, /*returnOffset=*/ 0x12345678, /*copySize=*/ 0xa2345678);

expect(Return.deserialize(buf)).toEqual(inst);
expect(inst.serialize()).toEqual(buf);
});

it('Should return data from the return opcode', async () => {
const returnData = [new Fr(1n), new Fr(2n), new Fr(3n)];

context.machineState.memory.set(0, new Field(1n));
context.machineState.memory.set(1, new Field(2n));
context.machineState.memory.set(2, new Field(3n));

const instruction = new Return(/*indirect=*/ 0, /*returnOffset=*/ 0, returnData.length);
await instruction.execute(context);

expect(context.machineState.halted).toBe(true);
expect(context.machineState.getResults()).toEqual({
reverted: false,
output: returnData,
});
});
});

describe('REVERT', () => {
it('Should (de)serialize correctly', () => {
const buf = Buffer.from([
Revert.opcode, // opcode
0x01, // indirect
...Buffer.from('12345678', 'hex'), // returnOffset
...Buffer.from('a2345678', 'hex'), // retSize
]);
const inst = new Revert(/*indirect=*/ 0x01, /*returnOffset=*/ 0x12345678, /*retSize=*/ 0xa2345678);

expect(Revert.deserialize(buf)).toEqual(inst);
expect(inst.serialize()).toEqual(buf);
});

it('Should return data and revert from the revert opcode', async () => {
const returnData = [new Fr(1n), new Fr(2n), new Fr(3n)];

context.machineState.memory.set(0, new Field(1n));
context.machineState.memory.set(1, new Field(2n));
context.machineState.memory.set(2, new Field(3n));

const instruction = new Revert(/*indirect=*/ 0, /*returnOffset=*/ 0, returnData.length);
await instruction.execute(context);

expect(context.machineState.halted).toBe(true);
expect(context.machineState.getResults()).toEqual({
reverted: true,
output: returnData,
});
});
});
});
Loading

0 comments on commit bec0963

Please sign in to comment.