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