Struct falcon::il::Instruction

pub struct Instruction { /* fields omitted */ }

An Instruction represents location, and non-semantical information about an Operation.

An instruction gives location to an Operation.

Methods are provided to create individual instructions, as all uses cases cannot be seen beforehand. However, it is generally poor-form to create an Instruction manually. You should use the methods on Block which correspond to the Operation you wish to create, and the Instruction will be created automatically.

Methods

impl Instruction

fn new(index: u64, operation: Operation) -> Instruction

Create a new instruction with the given index and operation.

Warning

You almost never want to call this function. You should use the methods on il::Block which correspond to the operation you wish to append to that block.

fn assign(index: u64, dst: Scalar, src: Expression) -> Instruction

Create a new Assign instruction.

Warning

You almost never want to call this function. You should use the assign method on il::Block instead.

fn store(
    instruction_index: u64,
    dst: Array,
    dst_index: Expression,
    src: Expression
) -> Instruction

Create a new Store instruction.

Warning

You almost never want to call this function. You should use the store method on il::Block instead.

fn load(
    instruction_index: u64,
    dst: Scalar,
    src_index: Expression,
    src: Array
) -> Instruction

Create a new Load instruction.

Warning

You almost never want to call this function. You should use the load method on il::Block instead.

fn brc(index: u64, target: Expression, condition: Expression) -> Instruction

Create a new Brc instruction.

Warning

You almost never want to call this function. You should use the brc method on il::Block instead.

fn raise(index: u64, expr: Expression) -> Instruction

Create a new Raise instruction.

Warning

You almost never want to call this function. You should use the raise method on il::Block instead.

fn is_assign(&self) -> bool

Returns true if the Operation for this Instruction is Operation::Assign

fn is_store(&self) -> bool

Returns true if the Operation for this Instruction is Operation::Store

fn is_load(&self) -> bool

Returns true if the Operation for this Instruction is Operation::Load

fn is_brc(&self) -> bool

Returns true if the Operation for this Instruction is Operation::Brc

fn is_raise(&self) -> bool

Returns true if the Operation for this Instruction is Operation::Raise

fn operation(&self) -> &Operation

Get the Operation for this Instruction

fn operation_mut(&mut self) -> &mut Operation

Get a mutable reference to the Operation for this Instruction

fn index(&self) -> u64

Get the index for this Instruction.

An Instruction index is assigned by its parent Block and uniquely identifies the Instruction within the Block. Instruction indices need not be continuous, nor in order.

fn comment(&self) -> &Option<String>

Get the optional comment for this Instruction

fn set_comment(&mut self, comment: Option<String>)

Set the optional comment for this Instruction

fn address(&self) -> Option<u64>

Get the optional address for this Instruction

An Instruction will typically have an address if one was given by a translator. It is not uncommon for there to be a mixture of Instructions with and without comments. For example, applying SSA to a Function will cause Phi instructions to be inserted, and these instructions will not have addresses.

fn set_address(&mut self, address: Option<u64>)

Set the optional address for this Instruction

fn variable_written(&self) -> Option<&Variable>

Get the Variable which will be written by this Instruction.

This is a convenience function around Operation::variable_written.

fn variable_written_mut(&mut self) -> Option<&mut Variable>

Get a mutable reference to the Variable which will be written by this Instruction.

This is a convenience function around Operation::variable_written_mut.

fn variables_read(&self) -> Vec<&Variable>

Get a Vec of each Variable read by this Instruction.

This is a convenience function around Operation::variables_read.

fn variables_read_mut(&mut self) -> Vec<&mut Variable>

Get a Vec of mutable references for each Variable read by this Instruction.

This is a convenience function around Operation::variables_read_mut.

Trait Implementations

impl Clone for Instruction

fn clone(&self) -> Instruction

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Instruction

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Eq for Instruction

impl Hash for Instruction

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

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].

impl Ord for Instruction

fn cmp(&self, __arg_0: &Instruction) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

impl PartialEq for Instruction

fn eq(&self, __arg_0: &Instruction) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, __arg_0: &Instruction) -> bool

This method tests for !=.

impl PartialOrd for Instruction

fn partial_cmp(&self, __arg_0: &Instruction) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, __arg_0: &Instruction) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, __arg_0: &Instruction) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, __arg_0: &Instruction) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, __arg_0: &Instruction) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Display for Instruction

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.