Struct BasicBlockNode 

pub struct BasicBlockNode { /* private fields */ }

Block for a linear sequence of operations (i.e., no branching or loops).

Executes its operations in order. Fails if any of the operations fails.

A basic block is composed of operation batches, operation batches are composed of operation groups, operation groups encode the VM’s operations and immediate values. These values are created according to these rules:

• A basic block contains one or more batches.
• A batch contains exactly 8 groups.
• A group contains exactly 9 operations or 1 immediate value.
• NOOPs are used to fill a group or batch when necessary.
• An immediate value follows the operation that requires it, using the next available group in the batch. If there are no batches available in the group, then both the operation and its immediate are moved to the next batch.

Example: 8 pushes result in two operation batches:

• First batch: First group with 7 push opcodes and 2 zero-paddings packed together, followed by 7 groups with their respective immediate values.
• Second batch: First group with the last push opcode and 8 zero-paddings packed together, followed by one immediate and 6 padding groups.

The hash of a basic block is:

hash(batches, domain=BASIC_BLOCK_DOMAIN)

Where batches is the concatenation of each batch in the basic block, and each batch is 8 field elements (512 bits).

Implementations

impl BasicBlockNode

Constants

pub const DOMAIN: BaseElement = ZERO

The domain of the basic block node (used for control block hashing).

impl BasicBlockNode

Constructors

pub fn new( operations: Vec<Operation>, decorators: Vec<(usize, DecoratorId)>, ) -> Result<BasicBlockNode, MastForestError>

Returns a new BasicBlockNode instantiated with the specified operations and decorators.

Returns an error if:

• operations vector is empty.

pub fn new_unsafe( operations: Vec<Operation>, decorators: Vec<(usize, DecoratorId)>, digest: Word, ) -> BasicBlockNode

Returns a new BasicBlockNode from values that are assumed to be correct. Should only be used when the source of the inputs is trusted (e.g. deserialization).

impl BasicBlockNode

Public accessors

pub fn op_batches(&self) -> &[OpBatch]

Returns a reference to the operation batches in this basic block.

pub fn num_op_batches(&self) -> usize

Returns the number of operation batches in this basic block.

pub fn num_op_groups(&self) -> usize

Returns the total number of operation groups in this basic block.

Then number of operation groups is computed as follows:

• For all batches but the last one we set the number of groups to 8, regardless of the actual number of groups in the batch. The reason for this is that when operation batches are concatenated together each batch contributes 8 elements to the hash.
• For the last batch, we take the number of actual groups and round it up to the next power of two. The reason for rounding is that the VM always executes a number of operation groups which is a power of two.

pub fn num_operations(&self) -> u32

Returns the number of operations in this basic block.

pub fn indexed_decorator_iter(&self) -> DecoratorOpLinkIterator<'_>

Returns a DecoratorOpLinkIterator which allows us to iterate through the decorator list of this basic block node while executing operation batches of this basic block node.

This iterator is intended for e.g. processor consumption, as such a component iterates differently through block operations: contrarily to e.g. the implementation of MastNodeErrorContext this does not include the before_enter or after_exit decorators.

pub fn raw_decorator_iter(&self) -> RawDecoratorOpLinkIterator<'_>

Returns an iterator which allows us to iterate through the decorator list of this basic block node with op indexes aligned to the “raw” (un-padded)) op batches of the basic block node.

Though this adjusts the indexation of op-indexed decorators, this iterator returns all decorators of the BasicBlockNode in the order in which they appear in the program. This includes before_enter, op-indexed decorators, and after_exit`.

pub fn operations(&self) -> impl Iterator<Item = &Operation>

Returns an iterator over the operations in the order in which they appear in the program.

pub fn raw_operations(&self) -> impl Iterator<Item = &Operation>

Returns an iterator over the un-padded operations in the order in which they appear in the program.

pub fn num_operations_and_decorators(&self) -> u32

Returns the total number of operations and decorators in this basic block.

pub fn iter(&self) -> impl Iterator<Item = OperationOrDecorator<'_>>

Returns an iterator over all operations and decorator, in the order in which they appear in the program.

impl BasicBlockNode

Mutators

pub fn set_decorators(&mut self, decorator_list: Vec<(usize, DecoratorId)>)

Used to initialize decorators for the BasicBlockNode. Replaces the existing decorators with the given [‘DecoratorList’].

Trait Implementations

impl Clone for BasicBlockNode

fn clone(&self) -> BasicBlockNode

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BasicBlockNode

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl From<BasicBlockNode> for MastNode

fn from(v: BasicBlockNode) -> MastNode

Converts to this type from the input type.

impl MastNodeErrorContext for BasicBlockNode

fn decorators(&self) -> impl Iterator<Item = (usize, DecoratorId)>

This iterator returns all decorators of the BasicBlockNode in the order in which they appear in the program. This includes before_enter, op-indexed decorators, and after_exit.

fn get_assembly_op<'m>( &self, mast_forest: &'m MastForest, target_op_idx: Option<usize>, ) -> Option<&'m AssemblyOp>

Returns the AssemblyOp associated with this node and operation (if provided), if any.

impl MastNodeExt for BasicBlockNode

fn digest(&self) -> Word

Returns a commitment to this basic block.

fn append_before_enter(&mut self, decorator_ids: &[DecoratorId])

Sets the provided list of decorators to be executed before this node.

fn append_after_exit(&mut self, decorator_ids: &[DecoratorId])

Sets the provided list of decorators to be executed after this node.

fn remove_decorators(&mut self)

Removes all decorators from this node.

fn before_enter(&self) -> &[DecoratorId]

Returns the decorators to be executed before this node is executed.

fn after_exit(&self) -> &[DecoratorId]

Returns the decorators to be executed after this node is executed.

fn to_display<'a>( &'a self, mast_forest: &'a MastForest, ) -> Box<dyn Display + 'a>

Returns a display formatter for this node.

fn to_pretty_print<'a>( &'a self, mast_forest: &'a MastForest, ) -> Box<dyn PrettyPrint + 'a>

Returns a pretty printer for this node.

fn remap_children( &self, _remapping: &BTreeMap<MastNodeId, MastNodeId>, ) -> BasicBlockNode

Remap the node children to their new positions indicated by the given Remapping.

fn has_children(&self) -> bool

Returns true if the this node has children.

fn append_children_to(&self, _target: &mut Vec<MastNodeId>)

Appends the NodeIds of the children of this node, if any, to the vector.

fn for_each_child<F>(&self, _f: F)

where F: FnMut(MastNodeId),

Executes the given closure for each child of this node.

fn domain(&self) -> BaseElement

Returns the domain of this node.

impl PartialEq for BasicBlockNode

fn eq(&self, other: &BasicBlockNode) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryInto<BasicBlockNode> for MastNode

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into( self, ) -> Result<BasicBlockNode, <MastNode as TryInto<BasicBlockNode>>::Error>

Performs the conversion.

impl Eq for BasicBlockNode

impl StructuralPartialEq for BasicBlockNode