[OCaml] Expose Llvm_bitwriter.write_bitcode_to_memory_buffer.
[oota-llvm.git] / test / Bindings / Ocaml / vmcore.ml
1 (* RUN: rm -rf %t.builddir
2  * RUN: mkdir -p %t.builddir
3  * RUN: cp %s %t.builddir
4  * RUN: %ocamlcomp -warn-error A llvm.%cma llvm_analysis.%cma llvm_bitwriter.%cma %t.builddir/vmcore.ml -o %t
5  * RUN: %t %t.bc
6  * RUN: llvm-dis < %t.bc > %t.ll
7  * RUN: FileCheck %s < %t.ll
8  * Do a second pass for things that shouldn't be anywhere.
9  * RUN: FileCheck -check-prefix=CHECK-NOWHERE %s < %t.ll
10  * XFAIL: vg_leak
11  *)
12
13 (* Note: It takes several seconds for ocamlopt to link an executable with
14          libLLVMCore.a, so it's better to write a big test than a bunch of
15          little ones. *)
16
17 open Llvm
18 open Llvm_bitwriter
19
20
21 (* Tiny unit test framework - really just to help find which line is busted *)
22 let exit_status = ref 0
23 let suite_name = ref ""
24 let group_name = ref ""
25 let case_num = ref 0
26 let print_checkpoints = false
27 let context = global_context ()
28 let i1_type = Llvm.i1_type context
29 let i8_type = Llvm.i8_type context
30 let i16_type = Llvm.i16_type context
31 let i32_type = Llvm.i32_type context
32 let i64_type = Llvm.i64_type context
33 let void_type = Llvm.void_type context
34 let float_type = Llvm.float_type context
35 let double_type = Llvm.double_type context
36 let fp128_type = Llvm.fp128_type context
37
38 let group name =
39   group_name := !suite_name ^ "/" ^ name;
40   case_num := 0;
41   if print_checkpoints then
42     prerr_endline ("  " ^ name ^ "...")
43
44 let insist cond =
45   incr case_num;
46   if not cond then
47     exit_status := 10;
48   match print_checkpoints, cond with
49   | false, true -> ()
50   | false, false ->
51       prerr_endline ("FAILED: " ^ !suite_name ^ "/" ^ !group_name ^ " #" ^ (string_of_int !case_num))
52   | true, true ->
53       prerr_endline ("    " ^ (string_of_int !case_num))
54   | true, false ->
55       prerr_endline ("    " ^ (string_of_int !case_num) ^ " FAIL")
56
57 let suite name f =
58   suite_name := name;
59   if print_checkpoints then
60     prerr_endline (name ^ ":");
61   f ()
62
63
64 (*===-- Fixture -----------------------------------------------------------===*)
65
66 let filename = Sys.argv.(1)
67 let m = create_module context filename
68
69
70 (*===-- Conversion --------------------------------------------------------===*)
71
72 let test_conversion () =
73   insist ("i32" = (string_of_lltype i32_type));
74   let c = const_int i32_type 42 in
75   insist ("i32 42" = (string_of_llvalue c))
76
77
78 (*===-- Target ------------------------------------------------------------===*)
79
80 let test_target () =
81   begin group "triple";
82     let trip = "i686-apple-darwin8" in
83     set_target_triple trip m;
84     insist (trip = target_triple m)
85   end;
86
87   begin group "layout";
88     let layout = "e" in
89     set_data_layout layout m;
90     insist (layout = data_layout m)
91   end
92   (* CHECK: target datalayout = "e"
93    * CHECK: target triple = "i686-apple-darwin8"
94    *)
95
96
97 (*===-- Constants ---------------------------------------------------------===*)
98
99 let test_constants () =
100   (* CHECK: const_int{{.*}}i32{{.*}}-1
101    *)
102   group "int";
103   let c = const_int i32_type (-1) in
104   ignore (define_global "const_int" c m);
105   insist (i32_type = type_of c);
106   insist (is_constant c);
107   insist (Some (-1L) = int64_of_const c);
108
109   (* CHECK: const_sext_int{{.*}}i64{{.*}}-1
110    *)
111   group "sext int";
112   let c = const_int i64_type (-1) in
113   ignore (define_global "const_sext_int" c m);
114   insist (i64_type = type_of c);
115   insist (Some (-1L) = int64_of_const c);
116
117   (* CHECK: const_zext_int64{{.*}}i64{{.*}}4294967295
118    *)
119   group "zext int64";
120   let c = const_of_int64 i64_type (Int64.of_string "4294967295") false in
121   ignore (define_global "const_zext_int64" c m);
122   insist (i64_type = type_of c);
123   insist (Some 4294967295L = int64_of_const c);
124
125   (* CHECK: const_int_string{{.*}}i32{{.*}}-1
126    *)
127   group "int string";
128   let c = const_int_of_string i32_type "-1" 10 in
129   ignore (define_global "const_int_string" c m);
130   insist (i32_type = type_of c);
131   insist (None = (string_of_const c));
132   insist (None = float_of_const c);
133   insist (Some (-1L) = int64_of_const c);
134
135   (* CHECK: const_int64{{.*}}i64{{.*}}9223372036854775807
136    *)
137   group "max int64";
138   let c = const_of_int64 i64_type 9223372036854775807L true in
139   ignore (define_global "const_int64" c m) ;
140   insist (i64_type = type_of c);
141   insist (Some 9223372036854775807L = int64_of_const c);
142
143   if Sys.word_size = 64; then begin
144     group "long int";
145     let c = const_int i64_type (1 lsl 61) in
146     insist (c = const_of_int64 i64_type (Int64.of_int (1 lsl 61)) false)
147   end;
148
149   (* CHECK: @const_string = global {{.*}}c"cruel\00world"
150    *)
151   group "string";
152   let c = const_string context "cruel\000world" in
153   ignore (define_global "const_string" c m);
154   insist ((array_type i8_type 11) = type_of c);
155   insist ((Some "cruel\000world") = (string_of_const c));
156
157   (* CHECK: const_stringz{{.*}}"hi\00again\00"
158    *)
159   group "stringz";
160   let c = const_stringz context "hi\000again" in
161   ignore (define_global "const_stringz" c m);
162   insist ((array_type i8_type 9) = type_of c);
163
164   (* CHECK: const_single{{.*}}2.75
165    * CHECK: const_double{{.*}}3.1459
166    * CHECK: const_double_string{{.*}}2
167    * CHECK: const_fake_fp128{{.*}}0xL00000000000000004000000000000000
168    * CHECK: const_fp128_string{{.*}}0xLF3CB1CCF26FBC178452FB4EC7F91973F
169    *)
170   begin group "real";
171     let cs = const_float float_type 2.75 in
172     ignore (define_global "const_single" cs m);
173     insist (float_type = type_of cs);
174     insist (float_of_const cs = Some 2.75);
175
176     let cd = const_float double_type 3.1459 in
177     ignore (define_global "const_double" cd m);
178     insist (double_type = type_of cd);
179     insist (float_of_const cd = Some 3.1459);
180
181     let cd = const_float_of_string double_type "2" in
182     ignore (define_global "const_double_string" cd m);
183     insist (double_type = type_of cd);
184     insist (float_of_const cd = Some 2.);
185
186     let cd = const_float fp128_type 2. in
187     ignore (define_global "const_fake_fp128" cd m);
188     insist (fp128_type = type_of cd);
189     insist (float_of_const cd = Some 2.);
190
191     let cd = const_float_of_string fp128_type "1e400" in
192     ignore (define_global "const_fp128_string" cd m);
193     insist (fp128_type = type_of cd);
194     insist (float_of_const cd = None);
195   end;
196
197   let one = const_int i16_type 1 in
198   let two = const_int i16_type 2 in
199   let three = const_int i32_type 3 in
200   let four = const_int i32_type 4 in
201
202   (* CHECK: const_array{{.*}}[i32 3, i32 4]
203    *)
204   group "array";
205   let c = const_array i32_type [| three; four |] in
206   ignore (define_global "const_array" c m);
207   insist ((array_type i32_type 2) = (type_of c));
208   insist (three = (const_element c 0));
209   insist (four = (const_element c 1));
210
211   (* CHECK: const_vector{{.*}}<i16 1, i16 2{{.*}}>
212    *)
213   group "vector";
214   let c = const_vector [| one; two; one; two;
215                           one; two; one; two |] in
216   ignore (define_global "const_vector" c m);
217   insist ((vector_type i16_type 8) = (type_of c));
218
219   (* CHECK: const_structure{{.*.}}i16 1, i16 2, i32 3, i32 4
220    *)
221   group "structure";
222   let c = const_struct context [| one; two; three; four |] in
223   ignore (define_global "const_structure" c m);
224   insist ((struct_type context [| i16_type; i16_type; i32_type; i32_type |])
225         = (type_of c));
226
227   (* CHECK: const_null{{.*}}zeroinit
228    *)
229   group "null";
230   let c = const_null (packed_struct_type context [| i1_type; i8_type; i64_type;
231                                                     double_type |]) in
232   ignore (define_global "const_null" c m);
233
234   (* CHECK: const_all_ones{{.*}}-1
235    *)
236   group "all ones";
237   let c = const_all_ones i64_type in
238   ignore (define_global "const_all_ones" c m);
239
240   group "pointer null"; begin
241     (* CHECK: const_pointer_null = global i64* null
242      *)
243     let c = const_pointer_null (pointer_type i64_type) in
244     ignore (define_global "const_pointer_null" c m);
245   end;
246
247   (* CHECK: const_undef{{.*}}undef
248    *)
249   group "undef";
250   let c = undef i1_type in
251   ignore (define_global "const_undef" c m);
252   insist (i1_type = type_of c);
253   insist (is_undef c);
254
255   group "constant arithmetic";
256   (* CHECK: @const_neg = global i64 sub
257    * CHECK: @const_nsw_neg = global i64 sub nsw
258    * CHECK: @const_nuw_neg = global i64 sub nuw
259    * CHECK: @const_fneg = global double fsub
260    * CHECK: @const_not = global i64 xor
261    * CHECK: @const_add = global i64 add
262    * CHECK: @const_nsw_add = global i64 add nsw
263    * CHECK: @const_nuw_add = global i64 add nuw
264    * CHECK: @const_fadd = global double fadd
265    * CHECK: @const_sub = global i64 sub
266    * CHECK: @const_nsw_sub = global i64 sub nsw
267    * CHECK: @const_nuw_sub = global i64 sub nuw
268    * CHECK: @const_fsub = global double fsub
269    * CHECK: @const_mul = global i64 mul
270    * CHECK: @const_nsw_mul = global i64 mul nsw
271    * CHECK: @const_nuw_mul = global i64 mul nuw
272    * CHECK: @const_fmul = global double fmul
273    * CHECK: @const_udiv = global i64 udiv
274    * CHECK: @const_sdiv = global i64 sdiv
275    * CHECK: @const_exact_sdiv = global i64 sdiv exact
276    * CHECK: @const_fdiv = global double fdiv
277    * CHECK: @const_urem = global i64 urem
278    * CHECK: @const_srem = global i64 srem
279    * CHECK: @const_frem = global double frem
280    * CHECK: @const_and = global i64 and
281    * CHECK: @const_or = global i64 or
282    * CHECK: @const_xor = global i64 xor
283    * CHECK: @const_icmp = global i1 icmp sle
284    * CHECK: @const_fcmp = global i1 fcmp ole
285    *)
286   let void_ptr = pointer_type i8_type in
287   let five = const_int i64_type 5 in
288   let ffive = const_uitofp five double_type in
289   let foldbomb_gv = define_global "FoldBomb" (const_null i8_type) m in
290   let foldbomb = const_ptrtoint foldbomb_gv i64_type in
291   let ffoldbomb = const_uitofp foldbomb double_type in
292   ignore (define_global "const_neg" (const_neg foldbomb) m);
293   ignore (define_global "const_nsw_neg" (const_nsw_neg foldbomb) m);
294   ignore (define_global "const_nuw_neg" (const_nuw_neg foldbomb) m);
295   ignore (define_global "const_fneg" (const_fneg ffoldbomb) m);
296   ignore (define_global "const_not" (const_not foldbomb) m);
297   ignore (define_global "const_add" (const_add foldbomb five) m);
298   ignore (define_global "const_nsw_add" (const_nsw_add foldbomb five) m);
299   ignore (define_global "const_nuw_add" (const_nuw_add foldbomb five) m);
300   ignore (define_global "const_fadd" (const_fadd ffoldbomb ffive) m);
301   ignore (define_global "const_sub" (const_sub foldbomb five) m);
302   ignore (define_global "const_nsw_sub" (const_nsw_sub foldbomb five) m);
303   ignore (define_global "const_nuw_sub" (const_nuw_sub foldbomb five) m);
304   ignore (define_global "const_fsub" (const_fsub ffoldbomb ffive) m);
305   ignore (define_global "const_mul" (const_mul foldbomb five) m);
306   ignore (define_global "const_nsw_mul" (const_nsw_mul foldbomb five) m);
307   ignore (define_global "const_nuw_mul" (const_nuw_mul foldbomb five) m);
308   ignore (define_global "const_fmul" (const_fmul ffoldbomb ffive) m);
309   ignore (define_global "const_udiv" (const_udiv foldbomb five) m);
310   ignore (define_global "const_sdiv" (const_sdiv foldbomb five) m);
311   ignore (define_global "const_exact_sdiv" (const_exact_sdiv foldbomb five) m);
312   ignore (define_global "const_fdiv" (const_fdiv ffoldbomb ffive) m);
313   ignore (define_global "const_urem" (const_urem foldbomb five) m);
314   ignore (define_global "const_srem" (const_srem foldbomb five) m);
315   ignore (define_global "const_frem" (const_frem ffoldbomb ffive) m);
316   ignore (define_global "const_and" (const_and foldbomb five) m);
317   ignore (define_global "const_or" (const_or foldbomb five) m);
318   ignore (define_global "const_xor" (const_xor foldbomb five) m);
319   ignore (define_global "const_icmp" (const_icmp Icmp.Sle foldbomb five) m);
320   ignore (define_global "const_fcmp" (const_fcmp Fcmp.Ole ffoldbomb ffive) m);
321
322   group "constant casts";
323   (* CHECK: const_trunc{{.*}}trunc
324    * CHECK: const_sext{{.*}}sext
325    * CHECK: const_zext{{.*}}zext
326    * CHECK: const_fptrunc{{.*}}fptrunc
327    * CHECK: const_fpext{{.*}}fpext
328    * CHECK: const_uitofp{{.*}}uitofp
329    * CHECK: const_sitofp{{.*}}sitofp
330    * CHECK: const_fptoui{{.*}}fptoui
331    * CHECK: const_fptosi{{.*}}fptosi
332    * CHECK: const_ptrtoint{{.*}}ptrtoint
333    * CHECK: const_inttoptr{{.*}}inttoptr
334    * CHECK: const_bitcast{{.*}}bitcast
335    * CHECK: const_intcast{{.*}}zext
336    *)
337   let i128_type = integer_type context 128 in
338   ignore (define_global "const_trunc" (const_trunc (const_add foldbomb five)
339                                                i8_type) m);
340   ignore (define_global "const_sext" (const_sext foldbomb i128_type) m);
341   ignore (define_global "const_zext" (const_zext foldbomb i128_type) m);
342   ignore (define_global "const_fptrunc" (const_fptrunc ffoldbomb float_type) m);
343   ignore (define_global "const_fpext" (const_fpext ffoldbomb fp128_type) m);
344   ignore (define_global "const_uitofp" (const_uitofp foldbomb double_type) m);
345   ignore (define_global "const_sitofp" (const_sitofp foldbomb double_type) m);
346   ignore (define_global "const_fptoui" (const_fptoui ffoldbomb i32_type) m);
347   ignore (define_global "const_fptosi" (const_fptosi ffoldbomb i32_type) m);
348   ignore (define_global "const_ptrtoint" (const_ptrtoint
349     (const_gep (const_null (pointer_type i8_type))
350                [| const_int i32_type 1 |])
351     i32_type) m);
352   ignore (define_global "const_inttoptr" (const_inttoptr (const_add foldbomb five)
353                                                   void_ptr) m);
354   ignore (define_global "const_bitcast" (const_bitcast ffoldbomb i64_type) m);
355   ignore (define_global "const_intcast"
356           (const_intcast foldbomb i128_type ~is_signed:false) m);
357
358   group "misc constants";
359   (* CHECK: const_size_of{{.*}}getelementptr{{.*}}null
360    * CHECK: const_gep{{.*}}getelementptr
361    * CHECK: const_select{{.*}}select
362    * CHECK: const_extractelement{{.*}}extractelement
363    * CHECK: const_insertelement{{.*}}insertelement
364    * CHECK: const_shufflevector = global <4 x i32> <i32 0, i32 1, i32 1, i32 0>
365    *)
366   ignore (define_global "const_size_of" (size_of (pointer_type i8_type)) m);
367   ignore (define_global "const_gep" (const_gep foldbomb_gv [| five |]) m);
368   ignore (define_global "const_select" (const_select
369     (const_icmp Icmp.Sle foldbomb five)
370     (const_int i8_type (-1))
371     (const_int i8_type 0)) m);
372   let zero = const_int i32_type 0 in
373   let one  = const_int i32_type 1 in
374   ignore (define_global "const_extractelement" (const_extractelement
375     (const_vector [| zero; one; zero; one |])
376     (const_trunc foldbomb i32_type)) m);
377   ignore (define_global "const_insertelement" (const_insertelement
378     (const_vector [| zero; one; zero; one |])
379     zero (const_trunc foldbomb i32_type)) m);
380   ignore (define_global "const_shufflevector" (const_shufflevector
381     (const_vector [| zero; one |])
382     (const_vector [| one; zero |])
383     (const_vector [| const_int i32_type 0; const_int i32_type 1;
384                      const_int i32_type 2; const_int i32_type 3 |])) m);
385
386   group "asm"; begin
387     let ft = function_type void_type [| i32_type; i32_type; i32_type |] in
388     ignore (const_inline_asm
389       ft
390       ""
391       "{cx},{ax},{di},~{dirflag},~{fpsr},~{flags},~{edi},~{ecx}"
392       true
393       false)
394   end;
395
396   group "recursive struct"; begin
397       let nsty = named_struct_type context "rec" in
398       let pty = pointer_type nsty in
399       struct_set_body nsty [| i32_type; pty |] false;
400       let elts = [| const_int i32_type 4; const_pointer_null pty |] in
401       let grec_init = const_named_struct nsty elts in
402       ignore (define_global "grec" grec_init m);
403       ignore (string_of_lltype nsty);
404   end
405
406
407 (*===-- Global Values -----------------------------------------------------===*)
408
409 let test_global_values () =
410   let (++) x f = f x; x in
411   let zero32 = const_null i32_type in
412
413   (* CHECK: GVal01
414    *)
415   group "naming";
416   let g = define_global "TEMPORARY" zero32 m in
417   insist ("TEMPORARY" = value_name g);
418   set_value_name "GVal01" g;
419   insist ("GVal01" = value_name g);
420
421   (* CHECK: GVal02{{.*}}linkonce
422    *)
423   group "linkage";
424   let g = define_global "GVal02" zero32 m ++
425           set_linkage Linkage.Link_once in
426   insist (Linkage.Link_once = linkage g);
427
428   (* CHECK: GVal03{{.*}}Hanalei
429    *)
430   group "section";
431   let g = define_global "GVal03" zero32 m ++
432           set_section "Hanalei" in
433   insist ("Hanalei" = section g);
434
435   (* CHECK: GVal04{{.*}}hidden
436    *)
437   group "visibility";
438   let g = define_global "GVal04" zero32 m ++
439           set_visibility Visibility.Hidden in
440   insist (Visibility.Hidden = visibility g);
441
442   (* CHECK: GVal05{{.*}}align 128
443    *)
444   group "alignment";
445   let g = define_global "GVal05" zero32 m ++
446           set_alignment 128 in
447   insist (128 = alignment g)
448
449
450 (*===-- Global Variables --------------------------------------------------===*)
451
452 let test_global_variables () =
453   let (++) x f = f x; x in
454   let forty_two32 = const_int i32_type 42 in
455
456   group "declarations"; begin
457     (* CHECK: @GVar01 = external global i32
458      * CHECK: @QGVar01 = external addrspace(3) global i32
459      *)
460     insist (None == lookup_global "GVar01" m);
461     let g = declare_global i32_type "GVar01" m in
462     insist (is_declaration g);
463     insist (pointer_type float_type ==
464               type_of (declare_global float_type "GVar01" m));
465     insist (g == declare_global i32_type "GVar01" m);
466     insist (match lookup_global "GVar01" m with Some x -> x = g
467                                               | None -> false);
468
469     insist (None == lookup_global "QGVar01" m);
470     let g = declare_qualified_global i32_type "QGVar01" 3 m in
471     insist (is_declaration g);
472     insist (qualified_pointer_type float_type 3 ==
473               type_of (declare_qualified_global float_type "QGVar01" 3 m));
474     insist (g == declare_qualified_global i32_type "QGVar01" 3 m);
475     insist (match lookup_global "QGVar01" m with Some x -> x = g
476                                               | None -> false);
477   end;
478
479   group "definitions"; begin
480     (* CHECK: @GVar02 = global i32 42
481      * CHECK: @GVar03 = global i32 42
482      * CHECK: @QGVar02 = addrspace(3) global i32 42
483      * CHECK: @QGVar03 = addrspace(3) global i32 42
484      *)
485     let g = define_global "GVar02" forty_two32 m in
486     let g2 = declare_global i32_type "GVar03" m ++
487            set_initializer forty_two32 in
488     insist (not (is_declaration g));
489     insist (not (is_declaration g2));
490     insist ((global_initializer g) == (global_initializer g2));
491
492     let g = define_qualified_global "QGVar02" forty_two32 3 m in
493     let g2 = declare_qualified_global i32_type "QGVar03" 3 m ++
494            set_initializer forty_two32 in
495     insist (not (is_declaration g));
496     insist (not (is_declaration g2));
497     insist ((global_initializer g) == (global_initializer g2));
498   end;
499
500   (* CHECK: GVar04{{.*}}thread_local
501    *)
502   group "threadlocal";
503   let g = define_global "GVar04" forty_two32 m ++
504           set_thread_local true in
505   insist (is_thread_local g);
506
507   (* CHECK: GVar05{{.*}}thread_local(initialexec)
508    *)
509   group "threadlocal_mode";
510   let g = define_global "GVar05" forty_two32 m ++
511           set_thread_local_mode ThreadLocalMode.InitialExec in
512   insist ((thread_local_mode g) = ThreadLocalMode.InitialExec);
513
514   (* CHECK: GVar06{{.*}}externally_initialized
515    *)
516   group "externally_initialized";
517   let g = define_global "GVar06" forty_two32 m ++
518           set_externally_initialized true in
519   insist (is_externally_initialized g);
520
521   (* CHECK-NOWHERE-NOT: GVar07
522    *)
523   group "delete";
524   let g = define_global "GVar07" forty_two32 m in
525   delete_global g;
526
527   (* CHECK: ConstGlobalVar{{.*}}constant
528    *)
529   group "constant";
530   let g = define_global "ConstGlobalVar" forty_two32 m in
531   insist (not (is_global_constant g));
532   set_global_constant true g;
533   insist (is_global_constant g);
534
535   begin group "iteration";
536     let m = create_module context "temp" in
537
538     insist (At_end m = global_begin m);
539     insist (At_start m = global_end m);
540
541     let g1 = declare_global i32_type "One" m in
542     let g2 = declare_global i32_type "Two" m in
543
544     insist (Before g1 = global_begin m);
545     insist (Before g2 = global_succ g1);
546     insist (At_end m = global_succ g2);
547
548     insist (After g2 = global_end m);
549     insist (After g1 = global_pred g2);
550     insist (At_start m = global_pred g1);
551
552     let lf s x = s ^ "->" ^ value_name x in
553     insist ("->One->Two" = fold_left_globals lf "" m);
554
555     let rf x s = value_name x ^ "<-" ^ s in
556     insist ("One<-Two<-" = fold_right_globals rf m "");
557
558     dispose_module m
559   end
560
561 (* String globals built below are emitted here.
562  * CHECK: build_global_string{{.*}}stringval
563  *)
564
565
566 (*===-- Uses --------------------------------------------------------------===*)
567
568 let test_uses () =
569   let ty = function_type i32_type [| i32_type; i32_type |] in
570   let fn = define_function "use_function" ty m in
571   let b = builder_at_end context (entry_block fn) in
572
573   let p1 = param fn 0 in
574   let p2 = param fn 1 in
575   let v1 = build_add p1 p2 "v1" b in
576   let v2 = build_add p1 v1 "v2" b in
577   let _ = build_add v1 v2 "v3" b in
578
579   let lf s u = value_name (user u) ^ "->" ^ s in
580   insist ("v2->v3->" = fold_left_uses lf "" v1);
581   let rf u s = value_name (user u) ^ "<-" ^ s in
582   insist ("v3<-v2<-" = fold_right_uses rf v1 "");
583
584   let lf s u = value_name (used_value u) ^ "->" ^ s in
585   insist ("v1->v1->" = fold_left_uses lf "" v1);
586
587   let rf u s = value_name (used_value u) ^ "<-" ^ s in
588   insist ("v1<-v1<-" = fold_right_uses rf v1 "");
589
590   ignore (build_unreachable b)
591
592
593 (*===-- Users -------------------------------------------------------------===*)
594
595 let test_users () =
596   let ty = function_type i32_type [| i32_type; i32_type |] in
597   let fn = define_function "user_function" ty m in
598   let b = builder_at_end context (entry_block fn) in
599
600   let p1 = param fn 0 in
601   let p2 = param fn 1 in
602   let a3 = build_alloca i32_type "user_alloca" b in
603   let p3 = build_load a3 "user_load" b in
604   let i = build_add p1 p2 "sum" b in
605
606   insist ((num_operands i) = 2);
607   insist ((operand i 0) = p1);
608   insist ((operand i 1) = p2);
609
610   set_operand i 1 p3;
611   insist ((operand i 1) != p2);
612   insist ((operand i 1) = p3);
613
614   ignore (build_unreachable b)
615
616
617 (*===-- Aliases -----------------------------------------------------------===*)
618
619 let test_aliases () =
620   (* CHECK: @alias = alias i32* @aliasee
621    *)
622   let forty_two32 = const_int i32_type 42 in
623   let v = define_global "aliasee" forty_two32 m in
624   ignore (add_alias m (pointer_type i32_type) v "alias")
625
626
627 (*===-- Functions ---------------------------------------------------------===*)
628
629 let test_functions () =
630   let ty = function_type i32_type [| i32_type; i64_type |] in
631   let ty2 = function_type i8_type [| i8_type; i64_type |] in
632
633   (* CHECK: declare i32 @Fn1(i32, i64)
634    *)
635   begin group "declare";
636     insist (None = lookup_function "Fn1" m);
637     let fn = declare_function "Fn1" ty m in
638     insist (pointer_type ty = type_of fn);
639     insist (is_declaration fn);
640     insist (0 = Array.length (basic_blocks fn));
641     insist (pointer_type ty2 == type_of (declare_function "Fn1" ty2 m));
642     insist (fn == declare_function "Fn1" ty m);
643     insist (None <> lookup_function "Fn1" m);
644     insist (match lookup_function "Fn1" m with Some x -> x = fn
645                                              | None -> false);
646     insist (m == global_parent fn)
647   end;
648
649   (* CHECK-NOWHERE-NOT: Fn2
650    *)
651   group "delete";
652   let fn = declare_function "Fn2" ty m in
653   delete_function fn;
654
655   (* CHECK: define{{.*}}Fn3
656    *)
657   group "define";
658   let fn = define_function "Fn3" ty m in
659   insist (not (is_declaration fn));
660   insist (1 = Array.length (basic_blocks fn));
661   ignore (build_unreachable (builder_at_end context (entry_block fn)));
662
663   (* CHECK: define{{.*}}Fn4{{.*}}Param1{{.*}}Param2
664    *)
665   group "params";
666   let fn = define_function "Fn4" ty m in
667   let params = params fn in
668   insist (2 = Array.length params);
669   insist (params.(0) = param fn 0);
670   insist (params.(1) = param fn 1);
671   insist (i32_type = type_of params.(0));
672   insist (i64_type = type_of params.(1));
673   set_value_name "Param1" params.(0);
674   set_value_name "Param2" params.(1);
675   ignore (build_unreachable (builder_at_end context (entry_block fn)));
676
677   (* CHECK: fastcc{{.*}}Fn5
678    *)
679   group "callconv";
680   let fn = define_function "Fn5" ty m in
681   insist (CallConv.c = function_call_conv fn);
682   set_function_call_conv CallConv.fast fn;
683   insist (CallConv.fast = function_call_conv fn);
684   ignore (build_unreachable (builder_at_end context (entry_block fn)));
685
686   begin group "gc";
687     (* CHECK: Fn6{{.*}}gc{{.*}}shadowstack
688      *)
689     let fn = define_function "Fn6" ty m in
690     insist (None = gc fn);
691     set_gc (Some "ocaml") fn;
692     insist (Some "ocaml" = gc fn);
693     set_gc None fn;
694     insist (None = gc fn);
695     set_gc (Some "shadowstack") fn;
696     ignore (build_unreachable (builder_at_end context (entry_block fn)));
697   end;
698
699   begin group "iteration";
700     let m = create_module context "temp" in
701
702     insist (At_end m = function_begin m);
703     insist (At_start m = function_end m);
704
705     let f1 = define_function "One" ty m in
706     let f2 = define_function "Two" ty m in
707
708     insist (Before f1 = function_begin m);
709     insist (Before f2 = function_succ f1);
710     insist (At_end m = function_succ f2);
711
712     insist (After f2 = function_end m);
713     insist (After f1 = function_pred f2);
714     insist (At_start m = function_pred f1);
715
716     let lf s x = s ^ "->" ^ value_name x in
717     insist ("->One->Two" = fold_left_functions lf "" m);
718
719     let rf x s = value_name x ^ "<-" ^ s in
720     insist ("One<-Two<-" = fold_right_functions rf m "");
721
722     dispose_module m
723   end
724
725
726 (*===-- Params ------------------------------------------------------------===*)
727
728 let test_params () =
729   begin group "iteration";
730     let m = create_module context "temp" in
731
732     let vf = define_function "void" (function_type void_type [| |]) m in
733
734     insist (At_end vf = param_begin vf);
735     insist (At_start vf = param_end vf);
736
737     let ty = function_type void_type [| i32_type; i32_type |] in
738     let f = define_function "f" ty m in
739     let p1 = param f 0 in
740     let p2 = param f 1 in
741     set_value_name "One" p1;
742     set_value_name "Two" p2;
743     add_param_attr p1 Attribute.Sext;
744     add_param_attr p2 Attribute.Noalias;
745     remove_param_attr p2 Attribute.Noalias;
746     add_function_attr f Attribute.Nounwind;
747     add_function_attr f Attribute.Noreturn;
748     remove_function_attr f Attribute.Noreturn;
749
750     insist (Before p1 = param_begin f);
751     insist (Before p2 = param_succ p1);
752     insist (At_end f = param_succ p2);
753
754     insist (After p2 = param_end f);
755     insist (After p1 = param_pred p2);
756     insist (At_start f = param_pred p1);
757
758     let lf s x = s ^ "->" ^ value_name x in
759     insist ("->One->Two" = fold_left_params lf "" f);
760
761     let rf x s = value_name x ^ "<-" ^ s in
762     insist ("One<-Two<-" = fold_right_params rf f "");
763
764     dispose_module m
765   end
766
767
768 (*===-- Basic Blocks ------------------------------------------------------===*)
769
770 let test_basic_blocks () =
771   let ty = function_type void_type [| |] in
772
773   (* CHECK: Bb1
774    *)
775   group "entry";
776   let fn = declare_function "X" ty m in
777   let bb = append_block context "Bb1" fn in
778   insist (bb = entry_block fn);
779   ignore (build_unreachable (builder_at_end context bb));
780
781   (* CHECK-NOWHERE-NOT: Bb2
782    *)
783   group "delete";
784   let fn = declare_function "X2" ty m in
785   let bb = append_block context "Bb2" fn in
786   delete_block bb;
787
788   group "insert";
789   let fn = declare_function "X3" ty m in
790   let bbb = append_block context "b" fn in
791   let bba = insert_block context "a" bbb in
792   insist ([| bba; bbb |] = basic_blocks fn);
793   ignore (build_unreachable (builder_at_end context bba));
794   ignore (build_unreachable (builder_at_end context bbb));
795
796   (* CHECK: Bb3
797    *)
798   group "name/value";
799   let fn = define_function "X4" ty m in
800   let bb = entry_block fn in
801   ignore (build_unreachable (builder_at_end context bb));
802   let bbv = value_of_block bb in
803   set_value_name "Bb3" bbv;
804   insist ("Bb3" = value_name bbv);
805
806   group "casts";
807   let fn = define_function "X5" ty m in
808   let bb = entry_block fn in
809   ignore (build_unreachable (builder_at_end context bb));
810   insist (bb = block_of_value (value_of_block bb));
811   insist (value_is_block (value_of_block bb));
812   insist (not (value_is_block (const_null i32_type)));
813
814   begin group "iteration";
815     let m = create_module context "temp" in
816     let f = declare_function "Temp" (function_type i32_type [| |]) m in
817
818     insist (At_end f = block_begin f);
819     insist (At_start f = block_end f);
820
821     let b1 = append_block context "One" f in
822     let b2 = append_block context "Two" f in
823
824     insist (Before b1 = block_begin f);
825     insist (Before b2 = block_succ b1);
826     insist (At_end f = block_succ b2);
827
828     insist (After b2 = block_end f);
829     insist (After b1 = block_pred b2);
830     insist (At_start f = block_pred b1);
831
832     let lf s x = s ^ "->" ^ value_name (value_of_block x) in
833     insist ("->One->Two" = fold_left_blocks lf "" f);
834
835     let rf x s = value_name (value_of_block x) ^ "<-" ^ s in
836     insist ("One<-Two<-" = fold_right_blocks rf f "");
837
838     dispose_module m
839   end
840
841
842 (*===-- Instructions ------------------------------------------------------===*)
843
844 let test_instructions () =
845   begin group "iteration";
846     let m = create_module context "temp" in
847     let fty = function_type void_type [| i32_type; i32_type |] in
848     let f = define_function "f" fty m in
849     let bb = entry_block f in
850     let b = builder_at context (At_end bb) in
851
852     insist (At_end bb = instr_begin bb);
853     insist (At_start bb = instr_end bb);
854
855     let i1 = build_add (param f 0) (param f 1) "One" b in
856     let i2 = build_sub (param f 0) (param f 1) "Two" b in
857
858     insist (Before i1 = instr_begin bb);
859     insist (Before i2 = instr_succ i1);
860     insist (At_end bb = instr_succ i2);
861
862     insist (After i2 = instr_end bb);
863     insist (After i1 = instr_pred i2);
864     insist (At_start bb = instr_pred i1);
865
866     let lf s x = s ^ "->" ^ value_name x in
867     insist ("->One->Two" = fold_left_instrs lf "" bb);
868
869     let rf x s = value_name x ^ "<-" ^ s in
870     insist ("One<-Two<-" = fold_right_instrs rf bb "");
871
872     dispose_module m
873   end;
874
875   group "clone instr";
876   begin
877     (* CHECK: %clone = add i32 %0, 2
878      *)
879     let fty = function_type void_type [| i32_type |] in
880     let fn = define_function "BuilderParent" fty m in
881     let bb = entry_block fn in
882     let b = builder_at_end context bb in
883     let p = param fn 0 in
884     let sum = build_add p p "sum" b in
885     let y = const_int i32_type 2 in
886     let clone = instr_clone sum in
887     set_operand clone 0 p;
888     set_operand clone 1 y;
889     insert_into_builder clone "clone" b;
890     ignore (build_ret_void b)
891   end
892
893
894 (*===-- Builder -----------------------------------------------------------===*)
895
896 let test_builder () =
897   let (++) x f = f x; x in
898
899   begin group "parent";
900     insist (try
901               ignore (insertion_block (builder context));
902               false
903             with Not_found ->
904               true);
905
906     let fty = function_type void_type [| i32_type |] in
907     let fn = define_function "BuilderParent" fty m in
908     let bb = entry_block fn in
909     let b = builder_at_end context bb in
910     let p = param fn 0 in
911     let sum = build_add p p "sum" b in
912     ignore (build_ret_void b);
913
914     insist (fn = block_parent bb);
915     insist (fn = param_parent p);
916     insist (bb = instr_parent sum);
917     insist (bb = insertion_block b)
918   end;
919
920   group "ret void";
921   begin
922     (* CHECK: ret void
923      *)
924     let fty = function_type void_type [| |] in
925     let fn = declare_function "X6" fty m in
926     let b = builder_at_end context (append_block context "Bb01" fn) in
927     ignore (build_ret_void b)
928   end;
929
930   group "ret aggregate";
931   begin
932       (* CHECK: ret { i8, i64 } { i8 4, i64 5 }
933        *)
934       let sty = struct_type context [| i8_type; i64_type |] in
935       let fty = function_type sty [| |] in
936       let fn = declare_function "XA6" fty m in
937       let b = builder_at_end context (append_block context "Bb01" fn) in
938       let agg = [| const_int i8_type 4; const_int i64_type 5 |] in
939       ignore (build_aggregate_ret agg b)
940   end;
941
942   (* The rest of the tests will use one big function. *)
943   let fty = function_type i32_type [| i32_type; i32_type |] in
944   let fn = define_function "X7" fty m in
945   let atentry = builder_at_end context (entry_block fn) in
946   let p1 = param fn 0 ++ set_value_name "P1" in
947   let p2 = param fn 1 ++ set_value_name "P2" in
948   let f1 = build_uitofp p1 float_type "F1" atentry in
949   let f2 = build_uitofp p2 float_type "F2" atentry in
950
951   let bb00 = append_block context "Bb00" fn in
952   ignore (build_unreachable (builder_at_end context bb00));
953
954   group "function attribute";
955   begin
956       ignore (add_function_attr fn Attribute.UWTable);
957       (* CHECK: X7{{.*}}#0
958        * #0 is uwtable, defined at EOF.
959        *)
960       insist ([Attribute.UWTable] = function_attr fn);
961   end;
962
963   group "casts"; begin
964     let void_ptr = pointer_type i8_type in
965
966     (* CHECK-DAG: %build_trunc = trunc i32 %P1 to i8
967      * CHECK-DAG: %build_trunc2 = trunc i32 %P1 to i8
968      * CHECK-DAG: %build_trunc3 = trunc i32 %P1 to i8
969      * CHECK-DAG: %build_zext = zext i8 %build_trunc to i32
970      * CHECK-DAG: %build_zext2 = zext i8 %build_trunc to i32
971      * CHECK-DAG: %build_sext = sext i32 %build_zext to i64
972      * CHECK-DAG: %build_sext2 = sext i32 %build_zext to i64
973      * CHECK-DAG: %build_sext3 = sext i32 %build_zext to i64
974      * CHECK-DAG: %build_uitofp = uitofp i64 %build_sext to float
975      * CHECK-DAG: %build_sitofp = sitofp i32 %build_zext to double
976      * CHECK-DAG: %build_fptoui = fptoui float %build_uitofp to i32
977      * CHECK-DAG: %build_fptosi = fptosi double %build_sitofp to i64
978      * CHECK-DAG: %build_fptrunc = fptrunc double %build_sitofp to float
979      * CHECK-DAG: %build_fptrunc2 = fptrunc double %build_sitofp to float
980      * CHECK-DAG: %build_fpext = fpext float %build_fptrunc to double
981      * CHECK-DAG: %build_fpext2 = fpext float %build_fptrunc to double
982      * CHECK-DAG: %build_inttoptr = inttoptr i32 %P1 to i8*
983      * CHECK-DAG: %build_ptrtoint = ptrtoint i8* %build_inttoptr to i64
984      * CHECK-DAG: %build_ptrtoint2 = ptrtoint i8* %build_inttoptr to i64
985      * CHECK-DAG: %build_bitcast = bitcast i64 %build_ptrtoint to double
986      * CHECK-DAG: %build_bitcast2 = bitcast i64 %build_ptrtoint to double
987      * CHECK-DAG: %build_bitcast3 = bitcast i64 %build_ptrtoint to double
988      * CHECK-DAG: %build_bitcast4 = bitcast i64 %build_ptrtoint to double
989      * CHECK-DAG: %build_pointercast = bitcast i8* %build_inttoptr to i16*
990      *)
991     let inst28 = build_trunc p1 i8_type "build_trunc" atentry in
992     let inst29 = build_zext inst28 i32_type "build_zext" atentry in
993     let inst30 = build_sext inst29 i64_type "build_sext" atentry in
994     let inst31 = build_uitofp inst30 float_type "build_uitofp" atentry in
995     let inst32 = build_sitofp inst29 double_type "build_sitofp" atentry in
996     ignore(build_fptoui inst31 i32_type "build_fptoui" atentry);
997     ignore(build_fptosi inst32 i64_type "build_fptosi" atentry);
998     let inst35 = build_fptrunc inst32 float_type "build_fptrunc" atentry in
999     ignore(build_fpext inst35 double_type "build_fpext" atentry);
1000     let inst37 = build_inttoptr p1 void_ptr "build_inttoptr" atentry in
1001     let inst38 = build_ptrtoint inst37 i64_type "build_ptrtoint" atentry in
1002     ignore(build_bitcast inst38 double_type "build_bitcast" atentry);
1003     ignore(build_zext_or_bitcast inst38 double_type "build_bitcast2" atentry);
1004     ignore(build_sext_or_bitcast inst38 double_type "build_bitcast3" atentry);
1005     ignore(build_trunc_or_bitcast inst38 double_type "build_bitcast4" atentry);
1006     ignore(build_pointercast inst37 (pointer_type i16_type) "build_pointercast" atentry);
1007
1008     ignore(build_zext_or_bitcast inst28 i32_type "build_zext2" atentry);
1009     ignore(build_sext_or_bitcast inst29 i64_type "build_sext2" atentry);
1010     ignore(build_trunc_or_bitcast p1 i8_type "build_trunc2" atentry);
1011     ignore(build_pointercast inst37 i64_type "build_ptrtoint2" atentry);
1012     ignore(build_intcast inst29 i64_type "build_sext3" atentry);
1013     ignore(build_intcast p1 i8_type "build_trunc3" atentry);
1014     ignore(build_fpcast inst35 double_type "build_fpext2" atentry);
1015     ignore(build_fpcast inst32 float_type "build_fptrunc2" atentry);
1016   end;
1017
1018   group "comparisons"; begin
1019     (* CHECK: %build_icmp_ne = icmp ne i32 %P1, %P2
1020      * CHECK: %build_icmp_sle = icmp sle i32 %P2, %P1
1021      * CHECK: %build_fcmp_false = fcmp false float %F1, %F2
1022      * CHECK: %build_fcmp_true = fcmp true float %F2, %F1
1023      * CHECK: %build_is_null{{.*}}= icmp eq{{.*}}%X0,{{.*}}null
1024      * CHECK: %build_is_not_null = icmp ne i8* %X1, null
1025      * CHECK: %build_ptrdiff
1026      *)
1027     let c = build_icmp Icmp.Ne    p1 p2 "build_icmp_ne" atentry in
1028     insist (Some Icmp.Ne = icmp_predicate c);
1029     insist (None = fcmp_predicate c);
1030
1031     let c = build_icmp Icmp.Sle   p2 p1 "build_icmp_sle" atentry in
1032     insist (Some Icmp.Sle = icmp_predicate c);
1033     insist (None = fcmp_predicate c);
1034
1035     let c = build_fcmp Fcmp.False f1 f2 "build_fcmp_false" atentry in
1036     (* insist (Some Fcmp.False = fcmp_predicate c); *)
1037     insist (None = icmp_predicate c);
1038
1039     let c = build_fcmp Fcmp.True  f2 f1 "build_fcmp_true" atentry in
1040     (* insist (Some Fcmp.True = fcmp_predicate c); *)
1041     insist (None = icmp_predicate c);
1042
1043     let g0 = declare_global (pointer_type i8_type) "g0" m in
1044     let g1 = declare_global (pointer_type i8_type) "g1" m in
1045     let p0 = build_load g0 "X0" atentry in
1046     let p1 = build_load g1 "X1" atentry in
1047     ignore (build_is_null p0 "build_is_null" atentry);
1048     ignore (build_is_not_null p1 "build_is_not_null" atentry);
1049     ignore (build_ptrdiff p1 p0 "build_ptrdiff" atentry);
1050   end;
1051
1052   group "miscellaneous"; begin
1053     (* CHECK: %build_call = tail call cc63 i32 @{{.*}}(i32 signext %P2, i32 %P1)
1054      * CHECK: %build_select = select i1 %build_icmp, i32 %P1, i32 %P2
1055      * CHECK: %build_va_arg = va_arg i8** null, i32
1056      * CHECK: %build_extractelement = extractelement <4 x i32> %Vec1, i32 %P2
1057      * CHECK: %build_insertelement = insertelement <4 x i32> %Vec1, i32 %P1, i32 %P2
1058      * CHECK: %build_shufflevector = shufflevector <4 x i32> %Vec1, <4 x i32> %Vec2, <4 x i32> <i32 1, i32 1, i32 0, i32 0>
1059      * CHECK: %build_insertvalue0 = insertvalue{{.*}}%bl, i32 1, 0
1060      * CHECK: %build_extractvalue = extractvalue{{.*}}%build_insertvalue1, 1
1061      *)
1062     let ci = build_call fn [| p2; p1 |] "build_call" atentry in
1063     insist (CallConv.c = instruction_call_conv ci);
1064     set_instruction_call_conv 63 ci;
1065     insist (63 = instruction_call_conv ci);
1066     insist (not (is_tail_call ci));
1067     set_tail_call true ci;
1068     insist (is_tail_call ci);
1069     add_instruction_param_attr ci 1 Attribute.Sext;
1070     add_instruction_param_attr ci 2 Attribute.Noalias;
1071     remove_instruction_param_attr ci 2 Attribute.Noalias;
1072
1073     let inst46 = build_icmp Icmp.Eq p1 p2 "build_icmp" atentry in
1074     ignore (build_select inst46 p1 p2 "build_select" atentry);
1075     ignore (build_va_arg
1076       (const_null (pointer_type (pointer_type i8_type)))
1077       i32_type "build_va_arg" atentry);
1078
1079     (* Set up some vector vregs. *)
1080     let one  = const_int i32_type 1 in
1081     let zero = const_int i32_type 0 in
1082     let t1 = const_vector [| one; zero; one; zero |] in
1083     let t2 = const_vector [| zero; one; zero; one |] in
1084     let t3 = const_vector [| one; one; zero; zero |] in
1085     let vec1 = build_insertelement t1 p1 p2 "Vec1" atentry in
1086     let vec2 = build_insertelement t2 p1 p2 "Vec2" atentry in
1087     let sty = struct_type context [| i32_type; i8_type |] in
1088
1089     ignore (build_extractelement vec1 p2 "build_extractelement" atentry);
1090     ignore (build_insertelement vec1 p1 p2 "build_insertelement" atentry);
1091     ignore (build_shufflevector vec1 vec2 t3 "build_shufflevector" atentry);
1092
1093     let p = build_alloca sty "ba" atentry in
1094     let agg = build_load p "bl" atentry in
1095     let agg0 = build_insertvalue agg (const_int i32_type 1) 0
1096                  "build_insertvalue0" atentry in
1097     let agg1 = build_insertvalue agg0 (const_int i8_type 2) 1
1098                  "build_insertvalue1" atentry in
1099     ignore (build_extractvalue agg1 1 "build_extractvalue" atentry)
1100   end;
1101
1102   group "metadata"; begin
1103     (* CHECK: %metadata = add i32 %P1, %P2, !test !1
1104      * !1 is metadata emitted at EOF.
1105      *)
1106     let i = build_add p1 p2 "metadata" atentry in
1107     insist ((has_metadata i) = false);
1108
1109     let m1 = const_int i32_type 1 in
1110     let m2 = mdstring context "metadata test" in
1111     let md = mdnode context [| m1; m2 |] in
1112
1113     let kind = mdkind_id context "test" in
1114     set_metadata i kind md;
1115
1116     insist ((has_metadata i) = true);
1117     insist ((metadata i kind) = Some md);
1118
1119     clear_metadata i kind;
1120
1121     insist ((has_metadata i) = false);
1122     insist ((metadata i kind) = None);
1123
1124     set_metadata i kind md
1125   end;
1126
1127   group "named metadata"; begin
1128     (* !llvm.module.flags is emitted at EOF. *)
1129     let n1 = const_int i32_type 1 in
1130     let n2 = mdstring context "Debug Info Version" in
1131     let n3 = const_int i32_type 2 in
1132     let md = mdnode context [| n1; n2; n3 |] in
1133     add_named_metadata_operand m "llvm.module.flags" md;
1134
1135     insist ((get_named_metadata m "llvm.module.flags") = [| md |])
1136   end;
1137
1138   group "dbg"; begin
1139     (* CHECK: %dbg = add i32 %P1, %P2, !dbg !2
1140      * !2 is metadata emitted at EOF.
1141      *)
1142     insist ((current_debug_location atentry) = None);
1143
1144     let m_line = const_int i32_type 2 in
1145     let m_col = const_int i32_type 3 in
1146     let m_scope = mdnode context [| |] in
1147     let m_inlined = mdnode context [| |] in
1148     let md = mdnode context [| m_line; m_col; m_scope; m_inlined |] in
1149     set_current_debug_location atentry md;
1150
1151     insist ((current_debug_location atentry) = Some md);
1152
1153     let i = build_add p1 p2 "dbg" atentry in
1154     insist ((has_metadata i) = true);
1155
1156     clear_current_debug_location atentry
1157   end;
1158
1159   group "ret"; begin
1160     (* CHECK: ret{{.*}}P1
1161      *)
1162     let ret = build_ret p1 atentry in
1163     position_before ret atentry
1164   end;
1165
1166   (* see test/Feature/exception.ll *)
1167   let bblpad = append_block context "Bblpad" fn in
1168   let rt = struct_type context [| pointer_type i8_type; i32_type |] in
1169   let ft = var_arg_function_type i32_type  [||] in
1170   let personality = declare_function "__gxx_personality_v0" ft m in
1171   let ztic = declare_global (pointer_type i8_type) "_ZTIc" m in
1172   let ztid = declare_global (pointer_type i8_type) "_ZTId" m in
1173   let ztipkc = declare_global (pointer_type i8_type) "_ZTIPKc" m in
1174   begin
1175       set_global_constant true ztic;
1176       set_global_constant true ztid;
1177       set_global_constant true ztipkc;
1178       let lp = build_landingpad rt personality 0 "lpad"
1179        (builder_at_end context bblpad) in begin
1180            set_cleanup lp true;
1181            add_clause lp ztic;
1182            insist((pointer_type (pointer_type i8_type)) = type_of ztid);
1183            let ety = pointer_type (pointer_type i8_type) in
1184            add_clause lp (const_array ety [| ztipkc; ztid |]);
1185            ignore (build_resume lp (builder_at_end context bblpad));
1186       end;
1187       (* CHECK: landingpad{{.*}}personality{{.*}}__gxx_personality_v0
1188        * CHECK: cleanup
1189        * CHECK: catch{{.*}}i8**{{.*}}@_ZTIc
1190        * CHECK: filter{{.*}}@_ZTIPKc{{.*}}@_ZTId
1191        * CHECK: resume
1192        * *)
1193   end;
1194
1195   group "br"; begin
1196     (* CHECK: br{{.*}}Bb02
1197      *)
1198     let bb02 = append_block context "Bb02" fn in
1199     let b = builder_at_end context bb02 in
1200     let br = build_br bb02 b in
1201     insist (successors br = [| bb02 |]) ;
1202     insist (is_conditional br = false) ;
1203     insist (get_branch br = Some (`Unconditional bb02)) ;
1204   end;
1205
1206   group "cond_br"; begin
1207     (* CHECK: br{{.*}}build_br{{.*}}Bb03{{.*}}Bb00
1208      *)
1209     let bb03 = append_block context "Bb03" fn in
1210     let b = builder_at_end context bb03 in
1211     let cond = build_trunc p1 i1_type "build_br" b in
1212     let br = build_cond_br cond bb03 bb00 b in
1213     insist (num_successors br = 2) ;
1214     insist (successor br 0 = bb03) ;
1215     insist (successor br 1 = bb00) ;
1216     insist (is_conditional br = true) ;
1217     insist (get_branch br = Some (`Conditional (cond, bb03, bb00))) ;
1218   end;
1219
1220   group "switch"; begin
1221     (* CHECK: switch{{.*}}P1{{.*}}SwiBlock3
1222      * CHECK: 2,{{.*}}SwiBlock2
1223      *)
1224     let bb1 = append_block context "SwiBlock1" fn in
1225     let bb2 = append_block context "SwiBlock2" fn in
1226     ignore (build_unreachable (builder_at_end context bb2));
1227     let bb3 = append_block context "SwiBlock3" fn in
1228     ignore (build_unreachable (builder_at_end context bb3));
1229     let si = build_switch p1 bb3 1 (builder_at_end context bb1) in begin
1230         ignore (add_case si (const_int i32_type 2) bb2);
1231         insist (switch_default_dest si = bb3);
1232     end;
1233     insist (num_successors si = 2) ;
1234     insist (get_branch si = None) ;
1235   end;
1236
1237   group "malloc/free"; begin
1238       (* CHECK: call{{.*}}@malloc(i32 ptrtoint
1239        * CHECK: call{{.*}}@free(i8*
1240        * CHECK: call{{.*}}@malloc(i32 %
1241        *)
1242       let bb1 = append_block context "MallocBlock1" fn in
1243       let m1 = (build_malloc (pointer_type i32_type) "m1"
1244       (builder_at_end context bb1)) in
1245       ignore (build_free m1 (builder_at_end context bb1));
1246       ignore (build_array_malloc i32_type p1 "m2" (builder_at_end context bb1));
1247       ignore (build_unreachable (builder_at_end context bb1));
1248   end;
1249
1250   group "indirectbr"; begin
1251     (* CHECK: indirectbr i8* blockaddress(@X7, %IBRBlock2), [label %IBRBlock2, label %IBRBlock3]
1252      *)
1253     let bb1 = append_block context "IBRBlock1" fn in
1254
1255     let bb2 = append_block context "IBRBlock2" fn in
1256     ignore (build_unreachable (builder_at_end context bb2));
1257
1258     let bb3 = append_block context "IBRBlock3" fn in
1259     ignore (build_unreachable (builder_at_end context bb3));
1260
1261     let addr = block_address fn bb2 in
1262     let ibr = build_indirect_br addr 2 (builder_at_end context bb1) in
1263     ignore (add_destination ibr bb2);
1264     ignore (add_destination ibr bb3)
1265   end;
1266
1267   group "invoke"; begin
1268     (* CHECK: build_invoke{{.*}}invoke{{.*}}P1{{.*}}P2
1269      * CHECK: to{{.*}}Bb04{{.*}}unwind{{.*}}Bblpad
1270      *)
1271     let bb04 = append_block context "Bb04" fn in
1272     let b = builder_at_end context bb04 in
1273     ignore (build_invoke fn [| p1; p2 |] bb04 bblpad "build_invoke" b)
1274   end;
1275
1276   group "unreachable"; begin
1277     (* CHECK: unreachable
1278      *)
1279     let bb06 = append_block context "Bb06" fn in
1280     let b = builder_at_end context bb06 in
1281     ignore (build_unreachable b)
1282   end;
1283
1284   group "arithmetic"; begin
1285     let bb07 = append_block context "Bb07" fn in
1286     let b = builder_at_end context bb07 in
1287
1288     (* CHECK: %build_add = add i32 %P1, %P2
1289      * CHECK: %build_nsw_add = add nsw i32 %P1, %P2
1290      * CHECK: %build_nuw_add = add nuw i32 %P1, %P2
1291      * CHECK: %build_fadd = fadd float %F1, %F2
1292      * CHECK: %build_sub = sub i32 %P1, %P2
1293      * CHECK: %build_nsw_sub = sub nsw i32 %P1, %P2
1294      * CHECK: %build_nuw_sub = sub nuw i32 %P1, %P2
1295      * CHECK: %build_fsub = fsub float %F1, %F2
1296      * CHECK: %build_mul = mul i32 %P1, %P2
1297      * CHECK: %build_nsw_mul = mul nsw i32 %P1, %P2
1298      * CHECK: %build_nuw_mul = mul nuw i32 %P1, %P2
1299      * CHECK: %build_fmul = fmul float %F1, %F2
1300      * CHECK: %build_udiv = udiv i32 %P1, %P2
1301      * CHECK: %build_sdiv = sdiv i32 %P1, %P2
1302      * CHECK: %build_exact_sdiv = sdiv exact i32 %P1, %P2
1303      * CHECK: %build_fdiv = fdiv float %F1, %F2
1304      * CHECK: %build_urem = urem i32 %P1, %P2
1305      * CHECK: %build_srem = srem i32 %P1, %P2
1306      * CHECK: %build_frem = frem float %F1, %F2
1307      * CHECK: %build_shl = shl i32 %P1, %P2
1308      * CHECK: %build_lshl = lshr i32 %P1, %P2
1309      * CHECK: %build_ashl = ashr i32 %P1, %P2
1310      * CHECK: %build_and = and i32 %P1, %P2
1311      * CHECK: %build_or = or i32 %P1, %P2
1312      * CHECK: %build_xor = xor i32 %P1, %P2
1313      * CHECK: %build_neg = sub i32 0, %P1
1314      * CHECK: %build_nsw_neg = sub nsw i32 0, %P1
1315      * CHECK: %build_nuw_neg = sub nuw i32 0, %P1
1316      * CHECK: %build_fneg = fsub float {{.*}}0{{.*}}, %F1
1317      * CHECK: %build_not = xor i32 %P1, -1
1318      *)
1319     ignore (build_add p1 p2 "build_add" b);
1320     ignore (build_nsw_add p1 p2 "build_nsw_add" b);
1321     ignore (build_nuw_add p1 p2 "build_nuw_add" b);
1322     ignore (build_fadd f1 f2 "build_fadd" b);
1323     ignore (build_sub p1 p2 "build_sub" b);
1324     ignore (build_nsw_sub p1 p2 "build_nsw_sub" b);
1325     ignore (build_nuw_sub p1 p2 "build_nuw_sub" b);
1326     ignore (build_fsub f1 f2 "build_fsub" b);
1327     ignore (build_mul p1 p2 "build_mul" b);
1328     ignore (build_nsw_mul p1 p2 "build_nsw_mul" b);
1329     ignore (build_nuw_mul p1 p2 "build_nuw_mul" b);
1330     ignore (build_fmul f1 f2 "build_fmul" b);
1331     ignore (build_udiv p1 p2 "build_udiv" b);
1332     ignore (build_sdiv p1 p2 "build_sdiv" b);
1333     ignore (build_exact_sdiv p1 p2 "build_exact_sdiv" b);
1334     ignore (build_fdiv f1 f2 "build_fdiv" b);
1335     ignore (build_urem p1 p2 "build_urem" b);
1336     ignore (build_srem p1 p2 "build_srem" b);
1337     ignore (build_frem f1 f2 "build_frem" b);
1338     ignore (build_shl p1 p2 "build_shl" b);
1339     ignore (build_lshr p1 p2 "build_lshl" b);
1340     ignore (build_ashr p1 p2 "build_ashl" b);
1341     ignore (build_and p1 p2 "build_and" b);
1342     ignore (build_or p1 p2 "build_or" b);
1343     ignore (build_xor p1 p2 "build_xor" b);
1344     ignore (build_neg p1 "build_neg" b);
1345     ignore (build_nsw_neg p1 "build_nsw_neg" b);
1346     ignore (build_nuw_neg p1 "build_nuw_neg" b);
1347     ignore (build_fneg f1 "build_fneg" b);
1348     ignore (build_not p1 "build_not" b);
1349     ignore (build_unreachable b)
1350   end;
1351
1352   group "memory"; begin
1353     let bb08 = append_block context "Bb08" fn in
1354     let b = builder_at_end context bb08 in
1355
1356     (* CHECK: %build_alloca = alloca i32
1357      * CHECK: %build_array_alloca = alloca i32, i32 %P2
1358      * CHECK: %build_load = load volatile i32* %build_array_alloca, align 4
1359      * CHECK: store volatile i32 %P2, i32* %build_alloca, align 4
1360      * CHECK: %build_gep = getelementptr i32* %build_array_alloca, i32 %P2
1361      * CHECK: %build_in_bounds_gep = getelementptr inbounds i32* %build_array_alloca, i32 %P2
1362      * CHECK: %build_struct_gep = getelementptr inbounds{{.*}}%build_alloca2, i32 0, i32 1
1363      * CHECK: %build_atomicrmw = atomicrmw xchg i8* %p, i8 42 seq_cst
1364      *)
1365     let alloca = build_alloca i32_type "build_alloca" b in
1366     let array_alloca = build_array_alloca i32_type p2 "build_array_alloca" b in
1367
1368     let load = build_load array_alloca "build_load" b in
1369     ignore(set_alignment 4 load);
1370     ignore(set_volatile true load);
1371     insist(true = is_volatile load);
1372     insist(4 = alignment load);
1373
1374     let store = build_store p2 alloca b in
1375     ignore(set_volatile true store);
1376     ignore(set_alignment 4 store);
1377     insist(true = is_volatile store);
1378     insist(4 = alignment store);
1379     ignore(build_gep array_alloca [| p2 |] "build_gep" b);
1380     ignore(build_in_bounds_gep array_alloca [| p2 |] "build_in_bounds_gep" b);
1381
1382     let sty = struct_type context [| i32_type; i8_type |] in
1383     let alloca2 = build_alloca sty "build_alloca2" b in
1384     ignore(build_struct_gep alloca2 1 "build_struct_gep" b);
1385
1386     let p = build_alloca i8_type "p" b in
1387     ignore(build_atomicrmw AtomicRMWBinOp.Xchg p (const_int i8_type 42)
1388               AtomicOrdering.SequentiallyConsistent false "build_atomicrmw"
1389               b);
1390
1391     ignore(build_unreachable b)
1392   end;
1393
1394   group "string"; begin
1395     let bb09 = append_block context "Bb09" fn in
1396     let b = builder_at_end context bb09 in
1397     let p = build_alloca (pointer_type i8_type) "p" b in
1398     (* build_global_string is emitted above.
1399      * CHECK: store{{.*}}build_global_string1{{.*}}p
1400      * *)
1401     ignore (build_global_string "stringval" "build_global_string" b);
1402     let g = build_global_stringptr "stringval" "build_global_string1" b in
1403     ignore (build_store g p b);
1404     ignore(build_unreachable b);
1405   end;
1406
1407   group "phi"; begin
1408     (* CHECK: PhiNode{{.*}}P1{{.*}}PhiBlock1{{.*}}P2{{.*}}PhiBlock2
1409      *)
1410     let b1 = append_block context "PhiBlock1" fn in
1411     let b2 = append_block context "PhiBlock2" fn in
1412
1413     let jb = append_block context "PhiJoinBlock" fn in
1414     ignore (build_br jb (builder_at_end context b1));
1415     ignore (build_br jb (builder_at_end context b2));
1416     let at_jb = builder_at_end context jb in
1417
1418     let phi = build_phi [(p1, b1)] "PhiNode" at_jb in
1419     insist ([(p1, b1)] = incoming phi);
1420
1421     add_incoming (p2, b2) phi;
1422     insist ([(p1, b1); (p2, b2)] = incoming phi);
1423
1424     ignore (build_unreachable at_jb);
1425   end
1426
1427 (* End-of-file checks for things like metdata and attributes.
1428  * CHECK: attributes #0 = {{.*}}uwtable{{.*}}
1429  * CHECK: !llvm.module.flags = !{!0}
1430  * CHECK: !0 = metadata !{i32 1, metadata !"Debug Info Version", i32 2}
1431  * CHECK: !1 = metadata !{i32 1, metadata !"metadata test"}
1432  * CHECK: !2 = metadata !{i32 2, i32 3, metadata !3, metadata !3}
1433  *)
1434
1435 (*===-- Pass Managers -----------------------------------------------------===*)
1436
1437 let test_pass_manager () =
1438   let (++) x f = ignore (f x); x in
1439
1440   begin group "module pass manager";
1441     ignore (PassManager.create ()
1442              ++ PassManager.run_module m
1443              ++ PassManager.dispose)
1444   end;
1445
1446   begin group "function pass manager";
1447     let fty = function_type void_type [| |] in
1448     let fn = define_function "FunctionPassManager" fty m in
1449     ignore (build_ret_void (builder_at_end context (entry_block fn)));
1450
1451     ignore (PassManager.create_function m
1452              ++ PassManager.initialize
1453              ++ PassManager.run_function fn
1454              ++ PassManager.finalize
1455              ++ PassManager.dispose)
1456   end
1457
1458
1459 (*===-- Memory Buffer -----------------------------------------------------===*)
1460
1461 let test_memory_buffer () =
1462   group "memory buffer";
1463   let buf = MemoryBuffer.of_string "foobar" in
1464   insist ((MemoryBuffer.as_string buf) = "foobar")
1465
1466
1467 (*===-- Writer ------------------------------------------------------------===*)
1468
1469 let test_writer () =
1470   group "valid";
1471   insist (match Llvm_analysis.verify_module m with
1472           | None -> true
1473           | Some msg -> prerr_string msg; false);
1474
1475   group "writer";
1476   insist (write_bitcode_file m filename);
1477
1478   dispose_module m
1479
1480
1481 (*===-- Driver ------------------------------------------------------------===*)
1482
1483 let _ =
1484   suite "conversion"       test_conversion;
1485   suite "target"           test_target;
1486   suite "constants"        test_constants;
1487   suite "global values"    test_global_values;
1488   suite "global variables" test_global_variables;
1489   suite "uses"             test_uses;
1490   suite "users"            test_users;
1491   suite "aliases"          test_aliases;
1492   suite "functions"        test_functions;
1493   suite "params"           test_params;
1494   suite "basic blocks"     test_basic_blocks;
1495   suite "instructions"     test_instructions;
1496   suite "builder"          test_builder;
1497   suite "pass manager"     test_pass_manager;
1498   suite "memory buffer"    test_memory_buffer;
1499   suite "writer"           test_writer; (* Keep this last; it disposes m. *)
1500   exit !exit_status