Crate brillig_vm

The Brillig VM is a specialized VM which allows the ACVM to perform custom non-determinism.

Brillig bytecode is distinct from regular ACIR in that it does not generate constraints.

Re-exports

• pub use acir::brillig;

Modules

• arithmetic 🔒
  Implementations for binary field operations and binary integer operations.
• black_box 🔒
  Implementations for VM native black box functions.
• cast 🔒
  Implementation for the cast operation.
• memory 🔒
  Implementation of the VM’s memory

Structs

• BrilligProfilingSample
  A sample for an executed opcode
• Memory
  The VM’s memory. Memory is internally represented as a vector of values. We grow the memory when values past the end are set, extending with 0s.
• VM
  VM encapsulates the state of the Brillig VM during execution.

Enums

• FailureReason
  Represents the reason why the Brillig VM failed during execution.
• MemoryValue
  A single typed value in the Brillig VM’s memory.
• VMStatus
  Represents the current execution status of the Brillig VM.

Constants

• FUZZING_COMPARISON_FALSE_STATE 🔒
  A state that represents a false comparison as part of a feature
• FUZZING_COMPARISON_LOG_RANGE_START_STATE 🔒
  The start of the range of the states that represent logarithm of the difference between the comparison arguments as part of a feature
• FUZZING_COMPARISON_TRUE_STATE 🔒
  A state that represents a true comparison as part of a feature
• MEMORY_ADDRESSING_BIT_SIZE
  The bit size used for addressing memory within the Brillig VM.

Functions

• vector_element_size 🔒
  Returns the total number of field elements required to represent the elements in the vector in memory.

Type Aliases

• Branch
  A tuple of the current opcode position and the next opcode position or state
• BranchToFeatureMap
  A map for translating encountered branching logic to features for fuzzing
• BrilligProfilingSamples
  All samples for each opcode that was executed
• ErrorCallStack
  The error call stack contains the opcode indexes of the call stack at the time of failure, plus the index of the opcode that failed.
• NextOpcodePositionOrState
  The position of the next opcode that will be executed in the bytecode or an id of a specific state produced by the opcode
• OpcodePosition
  The position of an opcode that is currently being executed in the bytecode
• UniqueFeatureIndex
  The index of a unique feature in the fuzzing trace