Enum Instr

#[non_exhaustive]
pub enum Instr<Id>
where
    Id: SiteId,
{
    Ctrl(CtrlInstr<Id>),
    Gfa(FieldInstr),
    Usonic(UsonicInstr),
    Reserved(ReservedInstr),
}

Complete AluVM instruction set for the Ultrasonic virtual machine, which includes the following architectures:

• Base ALU control architecture
• GFA256 (256-bit Galois-field arithmetics).
• USONIC

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Ctrl(CtrlInstr<Id>)

Control flow instructions (base ALU ISA)..

Gfa(FieldInstr)

GFA256` (256-bit Galois-field arithmetics).

Usonic(UsonicInstr)

USONIC ISA.

Reserved(ReservedInstr)

Reserved instruction for future use in core ALU ISAs.

Trait Implementations

impl<Id> Bytecode<Id> for Instr<Id>

where Id: SiteId,

fn op_range() -> RangeInclusive<u8>

Returns the range of instruction bytecodes covered by a set of operations.

fn opcode_byte(&self) -> u8

Returns byte representing instruction code (without its arguments).

fn code_byte_len(&self) -> u16

Returns the number of bytes used by the instruction and its arguments when serialized into the code segment.

fn external_ref(&self) -> Option<Id>

If the instruction calls or references any external program, returns a reference to it.

fn encode_operands<W>( &self, writer: &mut W, ) -> Result<(), <W as BytecodeWrite<Id>>::Error>

where W: BytecodeWrite<Id>,

Writes an instruction operands as bytecode, omitting opcode byte.

fn decode_operands<R>( reader: &mut R, opcode: u8, ) -> Result<Instr<Id>, CodeEofError>

where Instr<Id>: Sized, R: BytecodeRead<Id>,

Reads an instruction operands from bytecode, provided the opcode byte.

fn encode_instr<W>( &self, writer: &mut W, ) -> Result<(), <W as BytecodeWrite<Id>>::Error>

where W: BytecodeWrite<Id>,

Write an instruction as bytecode.

fn decode_instr<R>(reader: &mut R) -> Result<Self, CodeEofError>

where Self: Sized, R: BytecodeRead<Id>,

Reads an instruction from bytecode.

impl<Id> Clone for Instr<Id>

where Id: Clone + SiteId,

fn clone(&self) -> Instr<Id>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Id> Debug for Instr<Id>

where Id: Debug + SiteId,

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

Formats the value using the given formatter.

impl<Id> Display for Instr<Id>

where Id: SiteId,

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

Formats the value using the given formatter.

impl<Id> From<CtrlInstr<Id>> for Instr<Id>

where Id: SiteId,

fn from(v: CtrlInstr<Id>) -> Instr<Id>

Converts to this type from the input type.

impl<Id> From<FieldInstr> for Instr<Id>

where Id: SiteId,

fn from(v: FieldInstr) -> Instr<Id>

Converts to this type from the input type.

impl<Id> From<Instr<Id>> for Instr<Id>

where Id: SiteId,

fn from(instr: Instr<Id>) -> Instr<Id>

Converts to this type from the input type.

impl<Id> From<ReservedInstr> for Instr<Id>

where Id: SiteId,

fn from(v: ReservedInstr) -> Instr<Id>

Converts to this type from the input type.

impl<Id> From<UsonicInstr> for Instr<Id>

where Id: SiteId,

fn from(v: UsonicInstr) -> Instr<Id>

Converts to this type from the input type.

impl<Id> Hash for Instr<Id>

where Id: Hash + SiteId,

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<Id> Instruction<Id> for Instr<Id>

where Id: SiteId,

const ISA_EXT: &'static [&'static str]

The names of the ISA extension set these instructions cover.

type Core = UsonicCore

Extensions to the AluVM core unit provided by this instruction set.

type Context<'ctx> = VmContext<'ctx>

Context: external data which are accessible to the ISA.

fn is_goto_target(&self) -> bool

Whether the instruction can be used as a goto-target.

fn local_goto_pos(&mut self) -> GotoTarget<'_>

If an instruction is a jump operation inside the library, it should return its goto target position number.

fn remote_goto_pos(&mut self) -> Option<&mut Site<Id>>

If an instruction is a jump operation into an external library, it should return its remote target.

fn src_regs( &self, ) -> BTreeSet<<<Instr<Id> as Instruction<Id>>::Core as CoreExt>::Reg>

List of registers which value is taken into account by the instruction.

fn dst_regs( &self, ) -> BTreeSet<<<Instr<Id> as Instruction<Id>>::Core as CoreExt>::Reg>

List of registers which value may be changed by the instruction.

fn op_data_bytes(&self) -> u16

The size of the data coming as an instruction operand (i.e., except data coming from registers or read from outside the instruction operands).

fn ext_data_bytes(&self) -> u16

The size of the data read by the instruction from outside the registers (except data coming as a parameter).

fn exec( &self, site: Site<Id>, core: &mut Core<Id, <Instr<Id> as Instruction<Id>>::Core>, context: &<Instr<Id> as Instruction<Id>>::Context<'_>, ) -> ExecStep<Site<Id>>

Executes the given instruction taking all registers as input and output.

fn isa_ext() -> Confined<BTreeSet<IsaId>, amplify::::collection::confinement::TinyOrdSet::{constant#0}, amplify::::collection::confinement::TinyOrdSet::{constant#1}>

Convert the set of ISA extensions from Self::ISA_EXT into a set of IsaId.

fn regs(&self) -> BTreeSet<<Self::Core as CoreExt>::Reg>

Lists all registers which are used by the instruction.

fn src_reg_bytes(&self) -> u16

The number of bytes in the source registers.

fn dst_reg_bytes(&self) -> u16

The number of bytes in the destination registers.

fn base_complexity(&self) -> u64

Computes base (non-adjusted) complexity of the instruction.

fn complexity(&self) -> u64

Returns computational complexity of the instruction.

impl<Id> PartialEq for Instr<Id>

where Id: PartialEq + SiteId,

fn eq(&self, other: &Instr<Id>) -> 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<Id> Copy for Instr<Id>

where Id: Copy + SiteId,

impl<Id> Eq for Instr<Id>

where Id: Eq + SiteId,

impl<Id> StructuralPartialEq for Instr<Id>

where Id: SiteId,