Struct llvm_ir::module::Module

pub struct Module {
    pub name: String,
    pub source_file_name: String,
    pub data_layout: String,
    pub target_triple: Option<String>,
    pub functions: Vec<Function>,
    pub global_vars: Vec<GlobalVariable>,
    pub global_aliases: Vec<GlobalAlias>,
    pub named_struct_types: HashMap<String, Option<Arc<RwLock<Type>>>>,
    pub inline_assembly: String,
}

See LLVM 10 docs on Module Structure

Fields

name: String

The name of the module

source_file_name: String

See LLVM 10 docs on Source Filename

data_layout: String

See LLVM 10 docs on Data Layout

target_triple: Option<String>

See LLVM 10 docs on Target Triple

functions: Vec<Function>

Functions which are defined (not just declared) in this Module. See LLVM 10 docs on Functions

global_vars: Vec<GlobalVariable>

See LLVM 10 docs on Global Variables

global_aliases: Vec<GlobalAlias>

See LLVM 10 docs on Global Aliases

named_struct_types: HashMap<String, Option<Arc<RwLock<Type>>>>

Structure types can be "identified", meaning named. This map holds the named structure types in this Module. See LLVM 10 docs on Structure Type. A None value indicates an opaque type; see LLVM 10 docs on Opaque Structure Types. Note that this map is from struct name to Type::StructType variant, not to Type::NamedStructType variant (which would be redundant).

Arc<RwLock<_>> is used rather than Rc<RefCell<_>> so that Module can remain Sync. This is important because it allows multiple threads to simultaneously access a single (immutable) Module.

inline_assembly: String

See LLVM 10 docs on Module-Level Inline Assembly

Implementations

impl Module

pub fn get_func_by_name(&self, name: &str) -> Option<&Function>

Get the Function having the given Name (if any). Note that Functions are named with Strings and not Names.

pub fn from_bc_path(path: impl AsRef<Path>) -> Result<Self, String>

Parse the LLVM bitcode (.bc) file at the given path to create a Module

Trait Implementations

impl Clone for Module

fn clone(&self) -> Module

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Module

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

Formats the value using the given formatter.