Struct llhd::ir::UnitBuilder

pub struct UnitBuilder<'a> { /* fields omitted */ }

A mutable function, process, or entity.

Implementations

impl<'a> UnitBuilder<'a>

pub fn new(unit: UnitId, data: &'a mut UnitData) -> Self

Create a new builder for a unit.

pub fn new_anonymous(data: &'a mut UnitData) -> Self

Create a new builder for a unit that has not yet been added to a module.

pub fn finish(self) -> Unit<'a>

Finish building and make the unit immutable again.

pub fn data(&mut self) -> &mut UnitData

Get the unit’s mutable data.

pub fn unit(&'a self) -> Unit<'a>

Return the unit being built.

pub fn ins(&mut self) -> InstBuilder<'a, '_>

Add a new instruction using an InstBuilder.

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

Add a new instruction.

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

Delete an instruction.

Removes the instruction from the layout, data flwo graph, and control flow graph, and deletes it. The Inst is no longer valid afterwards.

pub fn block(&mut self) -> Block

Create a new BB.

pub fn named_block(&mut self, name: impl Into<String>) -> Block

Create a new named BB.

pub fn delete_block(&mut self, bb: Block)

Delete a block.

Removes the block, and all its instructions, from the layout and control flow graph, deletes it. The Block is no longer valid afterwards.

pub fn insert_at_end(&mut self)

Append all following instructions at the end of the unit.

pub fn insert_at_beginning(&mut self)

Prepend all following instructions at the beginning of the unit.

pub fn append_to(&mut self, bb: Block)

Append all following instructions to the end of bb.

pub fn prepend_to(&mut self, bb: Block)

Prepend all following instructions to the beginning of bb.

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

Insert all following instructions after inst.

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

Insert all following instructions before inst.

pub fn add_extern(&mut self, name: UnitName, sig: Signature) -> ExtUnit

Import an external unit for use within this unit.

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

Remove an instruction if its value is not being read.

Returns true if the instruction was removed.

impl<'a> UnitBuilder<'a>

Control Flow Graph

pub fn set_block_name(&mut self, bb: Block, name: String)

Set the name of a BB.

pub fn clear_block_name(&mut self, bb: Block) -> Option<String>

Clear the name of a BB.

pub fn set_anonymous_block_hint(&mut self, bb: Block, hint: u32)

Set the anonymous name hint of a BB.

pub fn clear_anonymous_block_hint(&mut self, bb: Block) -> Option<u32>

Clear the anonymous name hint of a BB.

impl<'a> UnitBuilder<'a>

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 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 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 replace_value_within_inst(
    &mut self,
    from: Value,
    to: Value,
    inst: Inst
) -> usize

Replace the uses of a value with another, in a single instruction.

Returns how many uses were replaced.

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 replace_block_within_inst(
    &mut self,
    from: Block,
    to: Block,
    inst: Inst
) -> usize

Replace all uses of a block with another, in a single instruction.

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 removed.

pub fn remove_block_from_inst(&mut self, block: Block, inst: Inst) -> usize

Remove all uses of a block, from a single instruction.

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

Returns how many blocks were removed.

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.

impl<'a> UnitBuilder<'a>

Basic Block Layout

The following functions are used to modify the basic block layout.

pub fn append_block(&mut self, bb: Block)

Append a BB to the end of the function.

pub fn prepend_block(&mut self, bb: Block)

Prepend a BB to the beginning of a function.

This effectively makes bb the new entry block.

pub fn insert_block_after(&mut self, bb: Block, after: Block)

Insert a BB after another BB.

pub fn insert_block_before(&mut self, bb: Block, before: Block)

Insert a BB before another BB.

pub fn remove_block(&mut self, bb: Block)

Remove a BB from the function.

pub fn swap_blocks(&mut self, bb0: Block, bb1: Block)

Swap the position of two BBs.

impl<'a> UnitBuilder<'a>

Instruction Layout

The following functions are used to modify the instruction layout within a block.

pub fn append_inst(&mut self, inst: Inst, bb: Block)

Append an instruction to the end of a BB.

pub fn prepend_inst(&mut self, inst: Inst, bb: Block)

Prepend an instruction to the beginning of a BB.

pub fn insert_inst_after(&mut self, inst: Inst, after: Inst)

Insert an instruction after another instruction.

pub fn insert_inst_before(&mut self, inst: Inst, before: Inst)

Insert an instruction before another instruction.

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

Remove an instruction from the function.

Methods from Deref<Target = Unit<'a>>

pub fn kind(&self) -> UnitKind

Get the kind of this unit.

Trait Implementations

impl<'a> Borrow<Unit<'a>> for UnitBuilder<'a>

fn borrow(&self) -> &Unit<'a>

Immutably borrows from an owned value.

impl<'a> Deref for UnitBuilder<'a>

type Target = Unit<'a>

The resulting type after dereferencing.

fn deref(&self) -> &Unit<'a>

Dereferences the value.

impl Index<Block> for UnitBuilder<'_>

type Output = BlockData

The returned type after indexing.

fn index(&self, idx: Block) -> &BlockData

Performs the indexing (container[index]) operation.

impl Index<ExtUnit> for UnitBuilder<'_>

type Output = ExtUnitData

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl Index<Inst> for UnitBuilder<'_>

type Output = InstData

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl Index<Value> for UnitBuilder<'_>

type Output = ValueData

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl IndexMut<Block> for UnitBuilder<'_>

fn index_mut(&mut self, idx: Block) -> &mut BlockData

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

impl IndexMut<ExtUnit> for UnitBuilder<'_>

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

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

impl IndexMut<Inst> for UnitBuilder<'_>

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

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

impl IndexMut<Value> for UnitBuilder<'_>

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

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