Struct llhd::ir::DataFlowGraph

pub struct DataFlowGraph { /* fields omitted */ }

A data flow graph.

This is the main container for instructions, values, and the relationship between them. Every Function, Process, and Entity has an associated data flow graph.

Methods

impl DataFlowGraph

pub fn new() -> Self

Create a new data flow graph.

pub fn add_placeholder(&mut self, ty: Type) -> Value

Add a placeholder value.

This function is intended to be used when constructing PHI nodes.

pub fn remove_placeholder(&mut self, value: Value)

Remove a placeholder value.

pub fn is_placeholder(&self, value: Value) -> bool

Check if a value is a placeholder.

pub fn add_inst(&mut self, data: InstData, ty: Type) -> Inst

Add an instruction.

pub fn remove_inst(&mut self, inst: Inst)

Remove an instruction.

pub fn has_result(&self, inst: Inst) -> bool

Returns whether an instruction produces a result.

pub fn inst_result(&self, inst: Inst) -> Value

Returns the result of an instruction.

pub fn arg_value(&self, arg: Arg) -> Value

Returns the value of an argument.

pub fn value_type(&self, value: Value) -> Type

Returns the type of a value.

pub fn inst_type(&self, inst: Inst) -> Type

Returns the type of an instruction.

pub fn get_value_inst(&self, value: Value) -> Option<Inst>

Return the instruction that produces value.

pub fn value_inst(&self, value: Value) -> Inst

Return the instruction that produces value, or panic.

pub fn get_name(&self, value: Value) -> Option<&str>

Return the name of a value.

pub fn set_name(&mut self, value: Value, name: String)

Set the name of a value.

pub fn clear_name(&mut self, value: Value) -> Option<String>

Clear the name of a value.

pub fn get_anonymous_hint(&self, value: Value) -> Option<u32>

Return the anonymous name hint of a value.

pub fn set_anonymous_hint(&mut self, value: Value, hint: u32)

Set the anonymous name hint of a value.

pub fn clear_anonymous_hint(&mut self, value: Value) -> Option<u32>

Clear the anonymous name hint of a value.

pub fn replace_use(&mut self, from: Value, to: Value) -> usize

Replace all uses of a value with another.

Returns how many uses were replaced.

pub fn uses(&self, value: Value) -> impl Iterator<Item = (Inst, usize)>

Iterate over all uses of a value.

pub fn has_uses(&self, value: Value) -> bool

Check if a value is used.

pub fn has_one_use(&self, value: Value) -> bool

Check if a value has exactly one use.

pub fn replace_block_use(&mut self, from: Block, to: Block) -> usize

Replace all uses of a block with another.

Returns how many blocks were replaced.

pub fn remove_block_use(&mut self, block: Block) -> usize

Remove all uses of a block.

Replaces all uses of the block with an invalid block placeholder, and removes phi node entries for the block.

Returns how many blocks were replaced.

pub fn get_const(&self, value: Value) -> Option<Value>

Resolve a constant value.

Returns None if the value is not constant. Note that this does not perform constant folding. Rather, the value must resolve to an instruction which produces a constant value.

pub fn get_const_time(&self, value: Value) -> Option<&TimeValue>

Resolve a constant time value.

Returns None if the value is not constant. Note that this does not perform constant folding. Rather, the value must resolve to an instruction which produces a constant value.

pub fn get_const_int(&self, value: Value) -> Option<&IntValue>

Resolve a constant integer value.

Returns None if the value is not constant. Note that this does not perform constant folding. Rather, the value must resolve to an instruction which produces a constant value.

pub fn get_const_array(&self, value: Value) -> Option<ArrayValue>

Resolve a constant array value.

Returns None if the value is not constant. Note that this does not perform constant folding. Rather, the value must resolve to an instruction which produces a constant value.

pub fn get_const_struct(&self, value: Value) -> Option<StructValue>

Resolve a constant struct value.

Returns None if the value is not constant. Note that this does not perform constant folding. Rather, the value must resolve to an instruction which produces a constant value.

pub fn set_location_hint(&mut self, inst: Inst, loc: usize)

Add a location hint to an instruction.

Annotates the byte offset of an instruction in the input file.

pub fn location_hint(&self, inst: Inst) -> Option<usize>

Get the location hint associated with an instruction.

Returns the byte offset of the instruction in the input file, or None if there is no hint for the instruction.

Trait Implementations

impl Default for DataFlowGraph

fn default() -> DataFlowGraph

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for DataFlowGraph

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Index<ExtUnit> for DataFlowGraph

type Output = ExtUnitData

The returned type after indexing.

fn index(&self, idx: ExtUnit) -> &ExtUnitData

Performs the indexing (container[index]) operation.

impl Index<Inst> for DataFlowGraph

type Output = InstData

The returned type after indexing.

fn index(&self, idx: Inst) -> &InstData

Performs the indexing (container[index]) operation.

impl Index<Value> for DataFlowGraph

type Output = ValueData

The returned type after indexing.

fn index(&self, idx: Value) -> &ValueData

Performs the indexing (container[index]) operation.

impl IndexMut<ExtUnit> for DataFlowGraph

fn index_mut(&mut self, idx: ExtUnit) -> &mut ExtUnitData

Performs the mutable indexing (container[index]) operation.

impl IndexMut<Inst> for DataFlowGraph

fn index_mut(&mut self, idx: Inst) -> &mut InstData

Performs the mutable indexing (container[index]) operation.

impl IndexMut<Value> for DataFlowGraph

fn index_mut(&mut self, idx: Value) -> &mut ValueData

Performs the mutable indexing (container[index]) operation.

impl Serialize for DataFlowGraph

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.