llvm-wrap 0.2.5

A safer wrapper for the LLVM C API bindings in Rust, based on llvm-sys
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158

//! A wrapper around a `LLVMModuleRef` for a specific context

use super::*;
use super::c_api::*;

use llvm_sys::bit_writer::LLVMWriteBitcodeToFile;
use std::path::Path;

/// A wrapper around a `LLVMModuleRef` for a specific context
pub struct Module {
    pub(crate) module: Option<LLVMModuleRef>,
}

impl Module {
    /// Add a function to the module
    pub fn add_function<S>(&self, name: S, ty: Type) -> Value where S: AsRef<str> {
        Value {
            value: unsafe {
                LLVMAddFunction(self.module.unwrap(), into_c(name).as_ptr(), ty.ty)
            }
        }
    }

    /// Add a global to the module
    pub fn add_global<S>(&self, name: S, ty: Type) -> Value where S: AsRef<str> {
        Value {
            value: unsafe {
                LLVMAddGlobal(self.module.unwrap(), ty.ty, into_c(name).as_ptr())
            }
        }
    }

    /// Get the function with the given name
    pub fn get_function<S>(&self, name: S) -> Value where S: AsRef<str> {
        Value {
            value: unsafe {
                LLVMGetNamedFunction(self.module.unwrap(), into_c(name).as_ptr())
            }
        }
    }

    /// Get the global with the given name
    pub fn get_global<S>(&self, name: S) -> Value where S: AsRef<str> {
        Value {
            value: unsafe {
                LLVMGetNamedGlobal(self.module.unwrap(), into_c(name).as_ptr())
            }
        }
    }

    /// Sets the target triple for this module
    pub fn set_triple<S>(&self, triple: S) where S: AsRef<str> {
        unsafe {
            LLVMSetTarget(self.module.unwrap(), into_c(triple).as_ptr())
        }
    }

    /// Sets the data layout for this module
    pub fn set_data_layout(&self, data: &target::TargetData) {
        unsafe {
            LLVMSetDataLayout(self.module.unwrap(), into_c(data.to_string()).as_ptr())
        }
    }

    /// Returns an iterator over all functions in the module
    pub fn functions(&self) -> iter::Functions {
        iter::Functions {
            pointer: Value {
                value: unsafe {
                    LLVMGetFirstFunction(self.module.unwrap())
                }
            }
        }
    }

    /// Returns an iterator over all globals in the module
    pub fn globals(&self) -> iter::Globals {
        iter::Globals {
            pointer: Value {
                value: unsafe {
                    LLVMGetFirstGlobal(self.module.unwrap())
                }
            }
        }
    }

    /// Dump the contents of the module to stderr
    pub fn dump(&self) {
        unsafe {
            LLVMDumpModule(self.module.unwrap());
        }
    }

    /// Write module IR to a file
    pub fn write_llvm_ir<P>(&self, path: P) where P: AsRef<Path> {
        unsafe {
            if LLVMPrintModuleToFile(
                self.module.unwrap(),
                into_c(path.as_ref()
                    .to_str()
                    .expect("path could not be converted to string")
                ).as_ptr(),
                vec![into_c("could not output LLVM IR for module").as_ptr() as *mut i8].as_mut_ptr(),
            ) != 0 {
                panic!("failed to write LLVM IR to file");
            }
        }
    }

    /// Write module bitcode to a file
    pub fn write_bitcode<P>(&self, path: P) where P: AsRef<Path> {
        unsafe {
            if LLVMWriteBitcodeToFile(
                self.module.unwrap(),
                into_c(path.as_ref()
                    .to_str()
                    .expect("path could not be converted to string")
                ).as_ptr()
            ) != 0 {
                panic!("failed to write bitcode to file");
            }
        }
    }

    /// Returns the internal module reference
    pub fn inner(&self) -> LLVMModuleRef {
        self.module.unwrap()
    }

    /// Destroys the wrapper, returning the internal module reference
    pub unsafe fn into_inner(mut self) -> LLVMModuleRef {
        self.module.take().unwrap()
    }
}

impl Deref for Module {
    type Target = LLVMModuleRef;

    fn deref(&self) -> &LLVMModuleRef {
        self.module.as_ref().unwrap()
    }
}

impl Drop for Module {
    fn drop(&mut self) {
        if let Some(module) = self.module {
            unsafe {
                LLVMDisposeModule(module);
            }
        }
    }
}

impl Debug for Module {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "Module")
    }
}