Struct llhd::ir::Module

pub struct Module { /* fields omitted */ }

A module.

This is the root node of an LLHD intermediate representation. Contains Function, Process, and Entity declarations and definitions.

Implementations

impl Module

pub fn new() -> Self

Create a new empty module.

pub fn dump(&self) -> ModuleDumper<'_>

Dump the module in human-readable form.

pub fn add_unit(&mut self, data: UnitData) -> UnitId

Add a unit to the module.

pub fn remove_unit(&mut self, unit: UnitId)

Remove a unit from the module.

pub fn declare(&mut self, name: UnitName, sig: Signature) -> DeclId

Declare an external unit.

pub fn add_decl(&mut self, data: DeclData) -> DeclId

Declare an external unit.

pub fn remove_decl(&mut self, decl: DeclId)

Remove a declaration from the module.

pub fn units<'a>(&'a self) -> impl Iterator<Item = Unit<'a>> + 'a

Return an iterator over the units in this module.

pub fn units_mut<'a>(&'a mut self) -> impl Iterator<Item = UnitBuilder<'a>> + 'a

Return a mutable iterator over the units in this module.

pub fn par_units<'a>(&'a self) -> impl ParallelIterator<Item = Unit<'a>> + 'a

Return a parallel iterator over the units in this module.

pub fn par_units_mut<'a>(
    &'a mut self
) -> impl ParallelIterator<Item = UnitBuilder<'a>> + 'a

Return a parallel mutable iterator over the units in this module.

pub fn functions<'a>(&'a self) -> impl Iterator<Item = Unit<'a>> + 'a

Return an iterator over the functions in this module.

pub fn processes<'a>(&'a self) -> impl Iterator<Item = Unit<'a>> + 'a

Return an iterator over the processes in this module.

pub fn entities<'a>(&'a self) -> impl Iterator<Item = Unit<'a>> + 'a

Return an iterator over the entities in this module.

pub fn decls<'a>(&'a self) -> impl Iterator<Item = DeclId> + 'a

Return an iterator over the external unit declarations in this module.

pub fn unit(&self, unit: UnitId) -> Unit<'_>

Return an unit in the module.

pub fn unit_mut(&mut self, unit: UnitId) -> UnitBuilder<'_>

Return a mutable unit in the module.

pub fn symbols<'a>(
    &'a self
) -> impl Iterator<Item = (&UnitName, LinkedUnit, &Signature)> + 'a

Return an iterator over the symbols in the module.

pub fn local_symbols<'a>(
    &'a self
) -> impl Iterator<Item = (&UnitName, LinkedUnit, &Signature)> + 'a

Return an iterator over the local symbols in the module.

pub fn global_symbols<'a>(
    &'a self
) -> impl Iterator<Item = (&UnitName, LinkedUnit, &Signature)> + 'a

Return an iterator over the global symbols in the module.

pub fn is_linked(&self) -> bool

Check whether the module is internally linked.

Adding or modifying a unit invalidates the linkage within the module.

pub fn link(&mut self)

Locally link the module.

pub fn verify(&self)

Panic if the module is not well-formed.

pub fn lookup_ext_unit(
    &self,
    ext_unit: ExtUnit,
    within: UnitId
) -> Option<LinkedUnit>

Lookup what an external unit links to.

The module must be linked for this to work.

pub fn set_location_hint(&mut self, mod_unit: UnitId, loc: usize)

Add a location hint to a unit.

Annotates the byte offset of a unit in the input file.

pub fn location_hint(&self, mod_unit: UnitId) -> Option<usize>

Get the location hint associated with a unit.

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

Trait Implementations

impl<'de> Deserialize<'de> for Module

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

Deserialize this value from the given Serde deserializer.

impl Index<DeclId> for Module

type Output = DeclData

The returned type after indexing.

fn index(&self, idx: DeclId) -> &DeclData

Performs the indexing (container[index]) operation.

impl Index<UnitId> for Module

type Output = UnitData

The returned type after indexing.

fn index(&self, idx: UnitId) -> &UnitData

Performs the indexing (container[index]) operation.

impl IndexMut<DeclId> for Module

fn index_mut(&mut self, idx: DeclId) -> &mut DeclData

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

impl IndexMut<UnitId> for Module

fn index_mut(&mut self, idx: UnitId) -> &mut UnitData

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

impl Serialize for Module

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

Serialize this value into the given Serde serializer.