inkwell 0.9.0

Inkwell aims to help you pen your own programming languages by safely wrapping 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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265

use inkwell::context::Context;
use inkwell::values::InstructionOpcode;

#[test]
fn test_basic_block_ordering() {
    let context = Context::create();
    let module = context.create_module("test");
    let builder = context.create_builder();

    assert!(builder.get_insert_block().is_none());

    let i128_type = context.i128_type();
    let fn_type = i128_type.fn_type(&[], false);

    let function = module.add_function("testing", fn_type, None);

    assert!(function.get_first_basic_block().is_none());

    let basic_block = context.append_basic_block(function, "entry");
    let basic_block4 = context.insert_basic_block_after(basic_block, "block4");
    let basic_block2 = context.insert_basic_block_after(basic_block, "block2");
    let basic_block3 = context.prepend_basic_block(basic_block4, "block3");

    for basic_blocks in [function.get_basic_blocks(), function.get_basic_block_iter().collect()] {
        assert_eq!(basic_blocks.len(), 4);
        assert_eq!(basic_blocks[0], basic_block);
        assert_eq!(basic_blocks[1], basic_block2);
        assert_eq!(basic_blocks[2], basic_block3);
        assert_eq!(basic_blocks[3], basic_block4);
    }

    assert!(basic_block3.move_before(basic_block2).is_ok());
    assert!(basic_block.move_after(basic_block4).is_ok());

    let basic_block5 = context.prepend_basic_block(basic_block, "block5");

    for basic_blocks in [function.get_basic_blocks(), function.get_basic_block_iter().collect()] {
        assert_eq!(basic_blocks.len(), 5);
        assert_eq!(basic_blocks[0], basic_block3);
        assert_eq!(basic_blocks[1], basic_block2);
        assert_eq!(basic_blocks[2], basic_block4);
        assert_eq!(basic_blocks[3], basic_block5);
        assert_eq!(basic_blocks[4], basic_block);

        assert_ne!(basic_blocks[0], basic_block);
        assert_ne!(basic_blocks[1], basic_block3);
        assert_ne!(basic_blocks[2], basic_block2);
        assert_ne!(basic_blocks[3], basic_block4);
        assert_ne!(basic_blocks[4], basic_block5);
    }

    context.append_basic_block(function, "block6");

    let bb1 = function.get_first_basic_block().unwrap();
    let bb4 = basic_block5.get_previous_basic_block().unwrap();

    assert_eq!(bb1, basic_block3);
    assert_eq!(bb4, basic_block4);
    assert!(basic_block3.get_previous_basic_block().is_none());

    unsafe {
        assert!(bb4.delete().is_ok());
    }

    let bb2 = basic_block5.get_previous_basic_block().unwrap();

    assert_eq!(bb2, basic_block2);

    let bb3 = function.get_first_basic_block().unwrap();

    assert_eq!(bb3, basic_block3);
    assert_eq!(basic_block.get_name().to_str(), Ok("entry"));
    assert_eq!(basic_block2.get_name().to_str(), Ok("block2"));
    assert_eq!(basic_block3.get_name().to_str(), Ok("block3"));
    assert_eq!(basic_block5.get_name().to_str(), Ok("block5"));
}

#[test]
fn test_get_basic_blocks() {
    let context = Context::create();
    let module = context.create_module("test");

    let bool_type = context.bool_type();
    let fn_type = bool_type.fn_type(&[], false);

    let function = module.add_function("testing", fn_type, None);

    assert_eq!(function.get_name().to_str(), Ok("testing"));
    assert_eq!(fn_type.get_return_type().unwrap().into_int_type().get_bit_width(), 1);

    assert!(function.get_last_basic_block().is_none());
    assert_eq!(function.get_basic_blocks().len(), 0);
    assert_eq!(function.get_basic_block_iter().count(), 0);

    let basic_block = context.append_basic_block(function, "entry");

    let last_basic_block = function
        .get_last_basic_block()
        .expect("Did not find expected basic block");

    assert_eq!(last_basic_block, basic_block);

    for basic_blocks in [function.get_basic_blocks(), function.get_basic_block_iter().collect()] {
        assert_eq!(basic_blocks.len(), 1);
        assert_eq!(basic_blocks[0], basic_block);
    }
}

#[test]
fn test_get_terminator() {
    let context = Context::create();
    let module = context.create_module("test");
    let builder = context.create_builder();

    let void_type = context.void_type();
    let fn_type = void_type.fn_type(&[], false);

    let function = module.add_function("testing", fn_type, None);
    let basic_block = context.append_basic_block(function, "entry");

    builder.position_at_end(basic_block);

    // REVIEW: What's the difference between a terminator and last instruction?
    assert!(basic_block.get_terminator().is_none());
    assert!(basic_block.get_first_instruction().is_none());
    assert!(basic_block.get_last_instruction().is_none());

    builder.build_return(None).unwrap();

    assert_eq!(
        basic_block.get_terminator().unwrap().get_opcode(),
        InstructionOpcode::Return
    );
    assert_eq!(
        basic_block.get_first_instruction().unwrap().get_opcode(),
        InstructionOpcode::Return
    );
    assert_eq!(
        basic_block.get_last_instruction().unwrap().get_opcode(),
        InstructionOpcode::Return
    );
    assert_eq!(basic_block.get_last_instruction(), basic_block.get_terminator());
}

#[test]
fn test_no_parent() {
    let context = Context::create();
    let module = context.create_module("test");

    let void_type = context.void_type();
    let fn_type = void_type.fn_type(&[], false);

    let function = module.add_function("testing", fn_type, None);
    let basic_block = context.append_basic_block(function, "entry");
    let basic_block2 = context.append_basic_block(function, "next");

    assert_eq!(basic_block.get_parent().unwrap(), function);
    assert_eq!(basic_block.get_next_basic_block().unwrap(), basic_block2);

    assert!(basic_block.remove_from_function().is_ok());

    assert!(basic_block.get_next_basic_block().is_none());
    assert!(basic_block2.get_previous_basic_block().is_none());

    assert!(basic_block.remove_from_function().is_err());
    assert!(basic_block.remove_from_function().is_err());

    assert!(basic_block.get_parent().is_none());
}

#[test]
fn test_rauw() {
    let context = Context::create();
    let builder = context.create_builder();
    let module = context.create_module("my_mod");
    let void_type = context.void_type();
    let fn_type = void_type.fn_type(&[], false);
    let fn_val = module.add_function("my_fn", fn_type, None);
    let entry = context.append_basic_block(fn_val, "entry");
    let bb1 = context.append_basic_block(fn_val, "bb1");
    let bb2 = context.append_basic_block(fn_val, "bb2");
    builder.position_at_end(entry);
    let branch_inst = builder.build_unconditional_branch(bb1).unwrap();

    bb1.replace_all_uses_with(&bb1); // no-op
    bb1.replace_all_uses_with(&bb2);

    assert_eq!(branch_inst.get_operand(0).unwrap().unwrap_block(), bb2);
}

#[test]
fn test_get_first_use() {
    let context = Context::create();
    let module = context.create_module("ivs");
    let builder = context.create_builder();
    let void_type = context.void_type();
    let fn_type = void_type.fn_type(&[], false);
    let fn_val = module.add_function("my_fn", fn_type, None);
    let entry = context.append_basic_block(fn_val, "entry");
    let bb1 = context.append_basic_block(fn_val, "bb1");
    let bb2 = context.append_basic_block(fn_val, "bb2");
    builder.position_at_end(entry);
    let branch_inst = builder.build_unconditional_branch(bb1).unwrap();

    assert!(bb2.get_first_use().is_none());
    assert!(bb1.get_first_use().is_some());
    assert_eq!(bb1.get_first_use().unwrap().get_user(), branch_inst);
    assert!(bb1.get_first_use().unwrap().get_next_use().is_none());
}

#[test]
fn test_get_address() {
    let context = Context::create();
    let module = context.create_module("my_mod");
    let void_type = context.void_type();
    let fn_type = void_type.fn_type(&[], false);
    let fn_val = module.add_function("my_fn", fn_type, None);
    let entry_bb = context.append_basic_block(fn_val, "entry");
    let next_bb = context.append_basic_block(fn_val, "next");

    assert!(unsafe { entry_bb.get_address() }.is_none());
    assert!(unsafe { next_bb.get_address() }.is_some());
}

#[test]
fn test_append_existing_basic_block_legacy() {
    let context = Context::create();
    let module = context.create_module("existing_bb_legacy");
    let void_type = context.void_type();
    let fn_type = void_type.fn_type(&[], false);

    let function = module.add_function("f", fn_type, None);

    // Create two orphan blocks (no parent).
    let bb1 = context.insert_basic_block_after(context.append_basic_block(function, "tmp"), "bb1");
    let bb2 = context.append_basic_block(function, "bb2");

    // Remove them from the function to make them orphans.
    assert!(bb1.remove_from_function().is_ok());
    assert!(bb2.remove_from_function().is_ok());

    assert!(bb1.get_parent().is_none());
    assert!(bb2.get_parent().is_none());

    let initial_blocks = function.get_basic_blocks();
    assert_eq!(initial_blocks.len(), 1);

    function.append_existing_basic_block(bb1);

    let blocks = function.get_basic_blocks();
    assert_eq!(blocks.len(), 2);
    assert_eq!(blocks[0].get_name().to_str(), Ok("tmp"));
    assert_eq!(blocks[1].get_name().to_str(), Ok("bb1"));
    assert_eq!(blocks[1].get_parent().unwrap(), function);

    function.append_existing_basic_block(bb2);

    let blocks2 = function.get_basic_blocks();
    assert_eq!(blocks2.len(), 3);
    assert_eq!(blocks2[2].get_name().to_str(), Ok("bb2"));
    assert_eq!(blocks2[2].get_parent().unwrap(), function);

    let collected: Vec<_> = function.get_basic_block_iter().collect();
    assert_eq!(collected, blocks2);
}