Module arch

Traits and constructs for the OpenVM architecture.

Re-exports

• pub use openvm_instructions as instructions;
• pub use segment::*;
• pub use vm::*;

Modules

• hasher
• segment
  Runtime execution and segmentation
• vm
  Top level VirtualMachine constructor and API.

Structs

• AdapterAirContext
• AdapterRuntimeContext
• BasicAdapterInterface
  The most common adapter interface. Performs NUM_READS batch reads of size READ_SIZE and NUM_WRITES batch writes of size WRITE_SIZE.
• DynAdapterInterface
  An interface that is fully determined during runtime. This should only be used as a last resort when static compile-time guarantees cannot be made.
• DynArray
  Newtype to implement From.
• ExecutionBridge
• ExecutionBridgeInteractor
• ExecutionBus
• ExecutionState
• FlatInterface
  Similar to BasicAdapterInterface, but it flattens the reads and writes into a single flat array for each
• ImmInstruction
• MemoryConfig
• MinimalInstruction
• SystemBase
  Base system chips. The following don’t execute instructions, but are essential for the VM architecture.
• SystemConfig
  System-level configuration for the virtual machine. Contains all configuration parameters that are managed by the architecture, including configuration for continuations support.
• SystemPort
  SystemPort combines system resources needed by most extensions
• SystemTraceHeights
• VecHeapAdapterInterface
• VecHeapTwoReadsAdapterInterface
• VmAirWrapper
• VmChipComplex
  The minimum collection of chips that any VM must have.
• VmChipWrapper
• VmComplexTraceHeights
• VmInventory
• VmInventoryBuilder
  Builder for processing unit. Processing units extend an existing system unit.
• VmInventoryTraceHeights

Enums

• ChipId
• ExecutionError
• PcIncOrSet
• SystemExecutor
• SystemPeriphery
• VmInventoryError

Constants

• BOUNDARY_AIR_ID
  AIR ID of the Memory Boundary AIR.
• CONNECTOR_AIR_ID
• MERKLE_AIR_ID
  If VM has continuations enabled, all AIRs of MemoryController are added after ConnectorChip. Merkle AIR commits start/final memory states.
• POSEIDON2_WIDTH
  Width of Poseidon2 VM uses.
• PROGRAM_AIR_ID
  Global AIR ID in the VM circuit verifying key.
• PROGRAM_CACHED_TRACE_INDEX
  ProgramAir is the first AIR so its cached trace should be the first main trace.
• PUBLIC_VALUES_AIR_ID
  If PublicValuesAir is enabled, its AIR ID is 2. PublicValuesAir is always disabled when continuations is enabled.

Traits

• AnyEnum
  A helper trait for downcasting types that may be enums.
• InstructionExecutor
• PhantomSubExecutor
  Phantom sub-instructions affect the runtime of the VM and the trace matrix values. However they all have no AIR constraints besides advancing the pc by DEFAULT_PC_STEP.
• VmAdapterAir
• VmAdapterChip
  The adapter owns all memory accesses and timestamp changes. The adapter AIR should also own ExecutionBridge and MemoryBridge.
• VmAdapterInterface
  The interface between primitive AIR and machine adapter AIR.
• VmConfig
• VmCoreAir
• VmCoreChip
  Trait to be implemented on primitive chip to integrate with the machine.
• VmExtension
  Configuration for a processor extension.

Functions

• generate_air_proof_input
  Generates an AIR proof input of the chip with the given height, if any.
• vm_poseidon2_config
  Returns a Poseidon2 config for the VM.

Type Aliases

• Result
• SystemComplex
  The base VmChipComplex with only system chips.