1 (*===-- llvm/llvm.ml - LLVM Ocaml Interface --------------------------------===*
3 * The LLVM Compiler Infrastructure
5 * This file is distributed under the University of Illinois Open Source
6 * License. See LICENSE.TXT for details.
8 *===----------------------------------------------------------------------===*)
20 module TypeKind = struct
39 module Linkage = struct
42 | Available_externally
53 module Visibility = struct
60 module CallConv = struct
68 module Attribute = struct
117 exception IoError of string
119 external register_exns : exn -> unit = "llvm_register_core_exns"
120 let _ = register_exns (IoError "")
122 type ('a, 'b) llpos =
126 type ('a, 'b) llrev_pos =
131 (*===-- Modules -----------------------------------------------------------===*)
133 external create_module : string -> llmodule = "llvm_create_module"
134 external dispose_module : llmodule -> unit = "llvm_dispose_module"
135 external target_triple: llmodule -> string
136 = "llvm_target_triple"
137 external set_target_triple: string -> llmodule -> unit
138 = "llvm_set_target_triple"
139 external data_layout: llmodule -> string
141 external set_data_layout: string -> llmodule -> unit
142 = "llvm_set_data_layout"
143 external define_type_name : string -> lltype -> llmodule -> bool
144 = "llvm_add_type_name"
145 external delete_type_name : string -> llmodule -> unit
146 = "llvm_delete_type_name"
147 external dump_module : llmodule -> unit = "llvm_dump_module"
149 (*===-- Types -------------------------------------------------------------===*)
151 external classify_type : lltype -> TypeKind.t = "llvm_classify_type"
153 (*--... Operations on integer types ........................................--*)
154 external _i1_type : unit -> lltype = "llvm_i1_type"
155 external _i8_type : unit -> lltype = "llvm_i8_type"
156 external _i16_type : unit -> lltype = "llvm_i16_type"
157 external _i32_type : unit -> lltype = "llvm_i32_type"
158 external _i64_type : unit -> lltype = "llvm_i64_type"
160 let i1_type = _i1_type ()
161 let i8_type = _i8_type ()
162 let i16_type = _i16_type ()
163 let i32_type = _i32_type ()
164 let i64_type = _i64_type ()
166 external integer_type : int -> lltype = "llvm_integer_type"
167 external integer_bitwidth : lltype -> int = "llvm_integer_bitwidth"
169 (*--... Operations on real types ...........................................--*)
170 external _float_type : unit -> lltype = "llvm_float_type"
171 external _double_type : unit -> lltype = "llvm_double_type"
172 external _x86fp80_type : unit -> lltype = "llvm_x86fp80_type"
173 external _fp128_type : unit -> lltype = "llvm_fp128_type"
174 external _ppc_fp128_type : unit -> lltype = "llvm_ppc_fp128_type"
176 let float_type = _float_type ()
177 let double_type = _double_type ()
178 let x86fp80_type = _x86fp80_type ()
179 let fp128_type = _fp128_type ()
180 let ppc_fp128_type = _ppc_fp128_type ()
182 (*--... Operations on function types .......................................--*)
183 external function_type : lltype -> lltype array -> lltype = "llvm_function_type"
184 external var_arg_function_type : lltype -> lltype array -> lltype
185 = "llvm_var_arg_function_type"
186 external is_var_arg : lltype -> bool = "llvm_is_var_arg"
187 external return_type : lltype -> lltype = "LLVMGetReturnType"
188 external param_types : lltype -> lltype array = "llvm_param_types"
190 (*--... Operations on struct types .........................................--*)
191 external struct_type : lltype array -> lltype = "llvm_struct_type"
192 external packed_struct_type : lltype array -> lltype = "llvm_packed_struct_type"
193 external element_types : lltype -> lltype array = "llvm_element_types"
194 external is_packed : lltype -> bool = "llvm_is_packed"
196 (*--... Operations on pointer, vector, and array types .....................--*)
197 external array_type : lltype -> int -> lltype = "llvm_array_type"
198 external pointer_type : lltype -> lltype = "llvm_pointer_type"
199 external qualified_pointer_type : lltype -> int -> lltype
200 = "llvm_qualified_pointer_type"
201 external vector_type : lltype -> int -> lltype = "llvm_vector_type"
203 external element_type : lltype -> lltype = "LLVMGetElementType"
204 external array_length : lltype -> int = "llvm_array_length"
205 external address_space : lltype -> int = "llvm_address_space"
206 external vector_size : lltype -> int = "llvm_vector_size"
208 (*--... Operations on other types ..........................................--*)
209 external opaque_type : unit -> lltype = "llvm_opaque_type"
210 external _void_type : unit -> lltype = "llvm_void_type"
211 external _label_type : unit -> lltype = "llvm_label_type"
213 let void_type = _void_type ()
214 let label_type = _label_type ()
216 (*--... Operations on type handles .........................................--*)
217 external handle_to_type : lltype -> lltypehandle = "llvm_handle_to_type"
218 external type_of_handle : lltypehandle -> lltype = "llvm_type_of_handle"
219 external refine_type : lltype -> lltype -> unit = "llvm_refine_type"
222 (*===-- Values ------------------------------------------------------------===*)
223 external type_of : llvalue -> lltype = "llvm_type_of"
224 external value_name : llvalue -> string = "llvm_value_name"
225 external set_value_name : string -> llvalue -> unit = "llvm_set_value_name"
226 external dump_value : llvalue -> unit = "llvm_dump_value"
228 (*--... Operations on constants of (mostly) any type .......................--*)
229 external is_constant : llvalue -> bool = "llvm_is_constant"
230 external const_null : lltype -> llvalue = "LLVMConstNull"
231 external const_all_ones : (*int|vec*)lltype -> llvalue = "LLVMConstAllOnes"
232 external undef : lltype -> llvalue = "LLVMGetUndef"
233 external is_null : llvalue -> bool = "llvm_is_null"
234 external is_undef : llvalue -> bool = "llvm_is_undef"
236 (*--... Operations on scalar constants .....................................--*)
237 external const_int : lltype -> int -> llvalue = "llvm_const_int"
238 external const_of_int64 : lltype -> Int64.t -> bool -> llvalue
239 = "llvm_const_of_int64"
240 external const_float : lltype -> float -> llvalue = "llvm_const_float"
242 (*--... Operations on composite constants ..................................--*)
243 external const_string : string -> llvalue = "llvm_const_string"
244 external const_stringz : string -> llvalue = "llvm_const_stringz"
245 external const_array : lltype -> llvalue array -> llvalue = "llvm_const_array"
246 external const_struct : llvalue array -> llvalue = "llvm_const_struct"
247 external const_packed_struct : llvalue array -> llvalue
248 = "llvm_const_packed_struct"
249 external const_vector : llvalue array -> llvalue = "llvm_const_vector"
251 (*--... Constant expressions ...............................................--*)
252 external align_of : lltype -> llvalue = "LLVMAlignOf"
253 external size_of : lltype -> llvalue = "LLVMSizeOf"
254 external const_neg : llvalue -> llvalue = "LLVMConstNeg"
255 external const_fneg : llvalue -> llvalue = "LLVMConstFNeg"
256 external const_not : llvalue -> llvalue = "LLVMConstNot"
257 external const_add : llvalue -> llvalue -> llvalue = "LLVMConstAdd"
258 external const_nsw_add : llvalue -> llvalue -> llvalue = "LLVMConstNSWAdd"
259 external const_fadd : llvalue -> llvalue -> llvalue = "LLVMConstFAdd"
260 external const_sub : llvalue -> llvalue -> llvalue = "LLVMConstSub"
261 external const_fsub : llvalue -> llvalue -> llvalue = "LLVMConstFSub"
262 external const_mul : llvalue -> llvalue -> llvalue = "LLVMConstMul"
263 external const_fmul : llvalue -> llvalue -> llvalue = "LLVMConstFMul"
264 external const_udiv : llvalue -> llvalue -> llvalue = "LLVMConstUDiv"
265 external const_sdiv : llvalue -> llvalue -> llvalue = "LLVMConstSDiv"
266 external const_exact_sdiv : llvalue -> llvalue -> llvalue = "LLVMConstExactSDiv"
267 external const_fdiv : llvalue -> llvalue -> llvalue = "LLVMConstFDiv"
268 external const_urem : llvalue -> llvalue -> llvalue = "LLVMConstURem"
269 external const_srem : llvalue -> llvalue -> llvalue = "LLVMConstSRem"
270 external const_frem : llvalue -> llvalue -> llvalue = "LLVMConstFRem"
271 external const_and : llvalue -> llvalue -> llvalue = "LLVMConstAnd"
272 external const_or : llvalue -> llvalue -> llvalue = "LLVMConstOr"
273 external const_xor : llvalue -> llvalue -> llvalue = "LLVMConstXor"
274 external const_icmp : Icmp.t -> llvalue -> llvalue -> llvalue
276 external const_fcmp : Fcmp.t -> llvalue -> llvalue -> llvalue
278 external const_shl : llvalue -> llvalue -> llvalue = "LLVMConstShl"
279 external const_lshr : llvalue -> llvalue -> llvalue = "LLVMConstLShr"
280 external const_ashr : llvalue -> llvalue -> llvalue = "LLVMConstAShr"
281 external const_gep : llvalue -> llvalue array -> llvalue = "llvm_const_gep"
282 external const_in_bounds_gep : llvalue -> llvalue array -> llvalue
283 = "llvm_const_in_bounds_gep"
284 external const_trunc : llvalue -> lltype -> llvalue = "LLVMConstTrunc"
285 external const_sext : llvalue -> lltype -> llvalue = "LLVMConstSExt"
286 external const_zext : llvalue -> lltype -> llvalue = "LLVMConstZExt"
287 external const_fptrunc : llvalue -> lltype -> llvalue = "LLVMConstFPTrunc"
288 external const_fpext : llvalue -> lltype -> llvalue = "LLVMConstFPExt"
289 external const_uitofp : llvalue -> lltype -> llvalue = "LLVMConstUIToFP"
290 external const_sitofp : llvalue -> lltype -> llvalue = "LLVMConstSIToFP"
291 external const_fptoui : llvalue -> lltype -> llvalue = "LLVMConstFPToUI"
292 external const_fptosi : llvalue -> lltype -> llvalue = "LLVMConstFPToSI"
293 external const_ptrtoint : llvalue -> lltype -> llvalue = "LLVMConstPtrToInt"
294 external const_inttoptr : llvalue -> lltype -> llvalue = "LLVMConstIntToPtr"
295 external const_bitcast : llvalue -> lltype -> llvalue = "LLVMConstBitCast"
296 external const_zext_or_bitcast : llvalue -> lltype -> llvalue
297 = "LLVMConstZExtOrBitCast"
298 external const_sext_or_bitcast : llvalue -> lltype -> llvalue
299 = "LLVMConstSExtOrBitCast"
300 external const_trunc_or_bitcast : llvalue -> lltype -> llvalue
301 = "LLVMConstTruncOrBitCast"
302 external const_pointercast : llvalue -> lltype -> llvalue
303 = "LLVMConstPointerCast"
304 external const_intcast : llvalue -> lltype -> llvalue = "LLVMConstIntCast"
305 external const_fpcast : llvalue -> lltype -> llvalue = "LLVMConstFPCast"
306 external const_select : llvalue -> llvalue -> llvalue -> llvalue
308 external const_extractelement : llvalue -> llvalue -> llvalue
309 = "LLVMConstExtractElement"
310 external const_insertelement : llvalue -> llvalue -> llvalue -> llvalue
311 = "LLVMConstInsertElement"
312 external const_shufflevector : llvalue -> llvalue -> llvalue -> llvalue
313 = "LLVMConstShuffleVector"
314 external const_extractvalue : llvalue -> int array -> llvalue
315 = "llvm_const_extractvalue"
316 external const_insertvalue : llvalue -> llvalue -> int array -> llvalue
317 = "llvm_const_insertvalue"
319 (*--... Operations on global variables, functions, and aliases (globals) ...--*)
320 external global_parent : llvalue -> llmodule = "LLVMGetGlobalParent"
321 external is_declaration : llvalue -> bool = "llvm_is_declaration"
322 external linkage : llvalue -> Linkage.t = "llvm_linkage"
323 external set_linkage : Linkage.t -> llvalue -> unit = "llvm_set_linkage"
324 external section : llvalue -> string = "llvm_section"
325 external set_section : string -> llvalue -> unit = "llvm_set_section"
326 external visibility : llvalue -> Visibility.t = "llvm_visibility"
327 external set_visibility : Visibility.t -> llvalue -> unit = "llvm_set_visibility"
328 external alignment : llvalue -> int = "llvm_alignment"
329 external set_alignment : int -> llvalue -> unit = "llvm_set_alignment"
330 external is_global_constant : llvalue -> bool = "llvm_is_global_constant"
331 external set_global_constant : bool -> llvalue -> unit
332 = "llvm_set_global_constant"
334 (*--... Operations on global variables .....................................--*)
335 external declare_global : lltype -> string -> llmodule -> llvalue
336 = "llvm_declare_global"
337 external define_global : string -> llvalue -> llmodule -> llvalue
338 = "llvm_define_global"
339 external lookup_global : string -> llmodule -> llvalue option
340 = "llvm_lookup_global"
341 external delete_global : llvalue -> unit = "llvm_delete_global"
342 external global_initializer : llvalue -> llvalue = "LLVMGetInitializer"
343 external set_initializer : llvalue -> llvalue -> unit = "llvm_set_initializer"
344 external remove_initializer : llvalue -> unit = "llvm_remove_initializer"
345 external is_thread_local : llvalue -> bool = "llvm_is_thread_local"
346 external set_thread_local : bool -> llvalue -> unit = "llvm_set_thread_local"
347 external global_begin : llmodule -> (llmodule, llvalue) llpos
348 = "llvm_global_begin"
349 external global_succ : llvalue -> (llmodule, llvalue) llpos
351 external global_end : llmodule -> (llmodule, llvalue) llrev_pos
353 external global_pred : llvalue -> (llmodule, llvalue) llrev_pos
356 let rec iter_global_range f i e =
357 if i = e then () else
359 | At_end _ -> raise (Invalid_argument "Invalid global variable range.")
362 iter_global_range f (global_succ bb) e
364 let iter_globals f m =
365 iter_global_range f (global_begin m) (At_end m)
367 let rec fold_left_global_range f init i e =
368 if i = e then init else
370 | At_end _ -> raise (Invalid_argument "Invalid global variable range.")
371 | Before bb -> fold_left_global_range f (f init bb) (global_succ bb) e
373 let fold_left_globals f init m =
374 fold_left_global_range f init (global_begin m) (At_end m)
376 let rec rev_iter_global_range f i e =
377 if i = e then () else
379 | At_start _ -> raise (Invalid_argument "Invalid global variable range.")
382 rev_iter_global_range f (global_pred bb) e
384 let rev_iter_globals f m =
385 rev_iter_global_range f (global_end m) (At_start m)
387 let rec fold_right_global_range f i e init =
388 if i = e then init else
390 | At_start _ -> raise (Invalid_argument "Invalid global variable range.")
391 | After bb -> fold_right_global_range f (global_pred bb) e (f bb init)
393 let fold_right_globals f m init =
394 fold_right_global_range f (global_end m) (At_start m) init
396 (*--... Operations on functions ............................................--*)
397 external declare_function : string -> lltype -> llmodule -> llvalue
398 = "llvm_declare_function"
399 external define_function : string -> lltype -> llmodule -> llvalue
400 = "llvm_define_function"
401 external lookup_function : string -> llmodule -> llvalue option
402 = "llvm_lookup_function"
403 external delete_function : llvalue -> unit = "llvm_delete_function"
404 external is_intrinsic : llvalue -> bool = "llvm_is_intrinsic"
405 external function_call_conv : llvalue -> int = "llvm_function_call_conv"
406 external set_function_call_conv : int -> llvalue -> unit
407 = "llvm_set_function_call_conv"
408 external gc : llvalue -> string option = "llvm_gc"
409 external set_gc : string option -> llvalue -> unit = "llvm_set_gc"
410 external function_begin : llmodule -> (llmodule, llvalue) llpos
411 = "llvm_function_begin"
412 external function_succ : llvalue -> (llmodule, llvalue) llpos
413 = "llvm_function_succ"
414 external function_end : llmodule -> (llmodule, llvalue) llrev_pos
415 = "llvm_function_end"
416 external function_pred : llvalue -> (llmodule, llvalue) llrev_pos
417 = "llvm_function_pred"
419 let rec iter_function_range f i e =
420 if i = e then () else
422 | At_end _ -> raise (Invalid_argument "Invalid function range.")
425 iter_function_range f (function_succ fn) e
427 let iter_functions f m =
428 iter_function_range f (function_begin m) (At_end m)
430 let rec fold_left_function_range f init i e =
431 if i = e then init else
433 | At_end _ -> raise (Invalid_argument "Invalid function range.")
434 | Before fn -> fold_left_function_range f (f init fn) (function_succ fn) e
436 let fold_left_functions f init m =
437 fold_left_function_range f init (function_begin m) (At_end m)
439 let rec rev_iter_function_range f i e =
440 if i = e then () else
442 | At_start _ -> raise (Invalid_argument "Invalid function range.")
445 rev_iter_function_range f (function_pred fn) e
447 let rev_iter_functions f m =
448 rev_iter_function_range f (function_end m) (At_start m)
450 let rec fold_right_function_range f i e init =
451 if i = e then init else
453 | At_start _ -> raise (Invalid_argument "Invalid function range.")
454 | After fn -> fold_right_function_range f (function_pred fn) e (f fn init)
456 let fold_right_functions f m init =
457 fold_right_function_range f (function_end m) (At_start m) init
459 external add_function_attr : llvalue -> Attribute.t -> unit
460 = "llvm_add_function_attr"
461 external remove_function_attr : llvalue -> Attribute.t -> unit
462 = "llvm_remove_function_attr"
464 (*--... Operations on params ...............................................--*)
465 external params : llvalue -> llvalue array = "llvm_params"
466 external param : llvalue -> int -> llvalue = "llvm_param"
467 external param_parent : llvalue -> llvalue = "LLVMGetParamParent"
468 external param_begin : llvalue -> (llvalue, llvalue) llpos = "llvm_param_begin"
469 external param_succ : llvalue -> (llvalue, llvalue) llpos = "llvm_param_succ"
470 external param_end : llvalue -> (llvalue, llvalue) llrev_pos = "llvm_param_end"
471 external param_pred : llvalue -> (llvalue, llvalue) llrev_pos ="llvm_param_pred"
473 let rec iter_param_range f i e =
474 if i = e then () else
476 | At_end _ -> raise (Invalid_argument "Invalid parameter range.")
479 iter_param_range f (param_succ p) e
481 let iter_params f fn =
482 iter_param_range f (param_begin fn) (At_end fn)
484 let rec fold_left_param_range f init i e =
485 if i = e then init else
487 | At_end _ -> raise (Invalid_argument "Invalid parameter range.")
488 | Before p -> fold_left_param_range f (f init p) (param_succ p) e
490 let fold_left_params f init fn =
491 fold_left_param_range f init (param_begin fn) (At_end fn)
493 let rec rev_iter_param_range f i e =
494 if i = e then () else
496 | At_start _ -> raise (Invalid_argument "Invalid parameter range.")
499 rev_iter_param_range f (param_pred p) e
501 let rev_iter_params f fn =
502 rev_iter_param_range f (param_end fn) (At_start fn)
504 let rec fold_right_param_range f init i e =
505 if i = e then init else
507 | At_start _ -> raise (Invalid_argument "Invalid parameter range.")
508 | After p -> fold_right_param_range f (f p init) (param_pred p) e
510 let fold_right_params f fn init =
511 fold_right_param_range f init (param_end fn) (At_start fn)
513 external add_param_attr : llvalue -> Attribute.t -> unit
514 = "llvm_add_param_attr"
515 external remove_param_attr : llvalue -> Attribute.t -> unit
516 = "llvm_remove_param_attr"
517 external set_param_alignment : llvalue -> int -> unit
518 = "llvm_set_param_alignment"
520 (*--... Operations on basic blocks .........................................--*)
521 external value_of_block : llbasicblock -> llvalue = "LLVMBasicBlockAsValue"
522 external value_is_block : llvalue -> bool = "llvm_value_is_block"
523 external block_of_value : llvalue -> llbasicblock = "LLVMValueAsBasicBlock"
524 external block_parent : llbasicblock -> llvalue = "LLVMGetBasicBlockParent"
525 external basic_blocks : llvalue -> llbasicblock array = "llvm_basic_blocks"
526 external entry_block : llvalue -> llbasicblock = "LLVMGetEntryBasicBlock"
527 external delete_block : llbasicblock -> unit = "llvm_delete_block"
528 external append_block : string -> llvalue -> llbasicblock = "llvm_append_block"
529 external insert_block : string -> llbasicblock -> llbasicblock
530 = "llvm_insert_block"
531 external block_begin : llvalue -> (llvalue, llbasicblock) llpos
533 external block_succ : llbasicblock -> (llvalue, llbasicblock) llpos
535 external block_end : llvalue -> (llvalue, llbasicblock) llrev_pos
537 external block_pred : llbasicblock -> (llvalue, llbasicblock) llrev_pos
540 let rec iter_block_range f i e =
541 if i = e then () else
543 | At_end _ -> raise (Invalid_argument "Invalid block range.")
546 iter_block_range f (block_succ bb) e
548 let iter_blocks f fn =
549 iter_block_range f (block_begin fn) (At_end fn)
551 let rec fold_left_block_range f init i e =
552 if i = e then init else
554 | At_end _ -> raise (Invalid_argument "Invalid block range.")
555 | Before bb -> fold_left_block_range f (f init bb) (block_succ bb) e
557 let fold_left_blocks f init fn =
558 fold_left_block_range f init (block_begin fn) (At_end fn)
560 let rec rev_iter_block_range f i e =
561 if i = e then () else
563 | At_start _ -> raise (Invalid_argument "Invalid block range.")
566 rev_iter_block_range f (block_pred bb) e
568 let rev_iter_blocks f fn =
569 rev_iter_block_range f (block_end fn) (At_start fn)
571 let rec fold_right_block_range f init i e =
572 if i = e then init else
574 | At_start _ -> raise (Invalid_argument "Invalid block range.")
575 | After bb -> fold_right_block_range f (f bb init) (block_pred bb) e
577 let fold_right_blocks f fn init =
578 fold_right_block_range f init (block_end fn) (At_start fn)
580 (*--... Operations on instructions .........................................--*)
581 external instr_parent : llvalue -> llbasicblock = "LLVMGetInstructionParent"
582 external instr_begin : llbasicblock -> (llbasicblock, llvalue) llpos
584 external instr_succ : llvalue -> (llbasicblock, llvalue) llpos
586 external instr_end : llbasicblock -> (llbasicblock, llvalue) llrev_pos
588 external instr_pred : llvalue -> (llbasicblock, llvalue) llrev_pos
591 let rec iter_instrs_range f i e =
592 if i = e then () else
594 | At_end _ -> raise (Invalid_argument "Invalid instruction range.")
597 iter_instrs_range f (instr_succ i) e
599 let iter_instrs f bb =
600 iter_instrs_range f (instr_begin bb) (At_end bb)
602 let rec fold_left_instrs_range f init i e =
603 if i = e then init else
605 | At_end _ -> raise (Invalid_argument "Invalid instruction range.")
606 | Before i -> fold_left_instrs_range f (f init i) (instr_succ i) e
608 let fold_left_instrs f init bb =
609 fold_left_instrs_range f init (instr_begin bb) (At_end bb)
611 let rec rev_iter_instrs_range f i e =
612 if i = e then () else
614 | At_start _ -> raise (Invalid_argument "Invalid instruction range.")
617 rev_iter_instrs_range f (instr_pred i) e
619 let rev_iter_instrs f bb =
620 rev_iter_instrs_range f (instr_end bb) (At_start bb)
622 let rec fold_right_instr_range f i e init =
623 if i = e then init else
625 | At_start _ -> raise (Invalid_argument "Invalid instruction range.")
626 | After i -> fold_right_instr_range f (instr_pred i) e (f i init)
628 let fold_right_instrs f bb init =
629 fold_right_instr_range f (instr_end bb) (At_start bb) init
632 (*--... Operations on call sites ...........................................--*)
633 external instruction_call_conv: llvalue -> int
634 = "llvm_instruction_call_conv"
635 external set_instruction_call_conv: int -> llvalue -> unit
636 = "llvm_set_instruction_call_conv"
637 external add_instruction_param_attr : llvalue -> int -> Attribute.t -> unit
638 = "llvm_add_instruction_param_attr"
639 external remove_instruction_param_attr : llvalue -> int -> Attribute.t -> unit
640 = "llvm_remove_instruction_param_attr"
642 (*--... Operations on call instructions (only) .............................--*)
643 external is_tail_call : llvalue -> bool = "llvm_is_tail_call"
644 external set_tail_call : bool -> llvalue -> unit = "llvm_set_tail_call"
646 (*--... Operations on phi nodes ............................................--*)
647 external add_incoming : (llvalue * llbasicblock) -> llvalue -> unit
648 = "llvm_add_incoming"
649 external incoming : llvalue -> (llvalue * llbasicblock) list = "llvm_incoming"
652 (*===-- Instruction builders ----------------------------------------------===*)
653 external builder : unit -> llbuilder = "llvm_builder"
654 external position_builder : (llbasicblock, llvalue) llpos -> llbuilder -> unit
655 = "llvm_position_builder"
656 external insertion_block : llbuilder -> llbasicblock = "llvm_insertion_block"
657 external insert_into_builder : llvalue -> string -> llbuilder -> unit
658 = "llvm_insert_into_builder"
661 let b = builder () in
662 position_builder ip b;
665 let builder_before i = builder_at (Before i)
666 let builder_at_end bb = builder_at (At_end bb)
668 let position_before i = position_builder (Before i)
669 let position_at_end bb = position_builder (At_end bb)
672 (*--... Terminators ........................................................--*)
673 external build_ret_void : llbuilder -> llvalue = "llvm_build_ret_void"
674 external build_ret : llvalue -> llbuilder -> llvalue = "llvm_build_ret"
675 external build_aggregate_ret : llvalue array -> llbuilder -> llvalue
676 = "llvm_build_aggregate_ret"
677 external build_br : llbasicblock -> llbuilder -> llvalue = "llvm_build_br"
678 external build_cond_br : llvalue -> llbasicblock -> llbasicblock -> llbuilder ->
679 llvalue = "llvm_build_cond_br"
680 external build_switch : llvalue -> llbasicblock -> int -> llbuilder -> llvalue
681 = "llvm_build_switch"
682 external add_case : llvalue -> llvalue -> llbasicblock -> unit
684 external build_invoke : llvalue -> llvalue array -> llbasicblock ->
685 llbasicblock -> string -> llbuilder -> llvalue
686 = "llvm_build_invoke_bc" "llvm_build_invoke_nat"
687 external build_unwind : llbuilder -> llvalue = "llvm_build_unwind"
688 external build_unreachable : llbuilder -> llvalue = "llvm_build_unreachable"
690 (*--... Arithmetic .........................................................--*)
691 external build_add : llvalue -> llvalue -> string -> llbuilder -> llvalue
693 external build_nsw_add : llvalue -> llvalue -> string -> llbuilder -> llvalue
694 = "llvm_build_nsw_add"
695 external build_fadd : llvalue -> llvalue -> string -> llbuilder -> llvalue
697 external build_sub : llvalue -> llvalue -> string -> llbuilder -> llvalue
699 external build_fsub : llvalue -> llvalue -> string -> llbuilder -> llvalue
701 external build_mul : llvalue -> llvalue -> string -> llbuilder -> llvalue
703 external build_fmul : llvalue -> llvalue -> string -> llbuilder -> llvalue
705 external build_udiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
707 external build_sdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
709 external build_exact_sdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
710 = "llvm_build_exact_sdiv"
711 external build_fdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
713 external build_urem : llvalue -> llvalue -> string -> llbuilder -> llvalue
715 external build_srem : llvalue -> llvalue -> string -> llbuilder -> llvalue
717 external build_frem : llvalue -> llvalue -> string -> llbuilder -> llvalue
719 external build_shl : llvalue -> llvalue -> string -> llbuilder -> llvalue
721 external build_lshr : llvalue -> llvalue -> string -> llbuilder -> llvalue
723 external build_ashr : llvalue -> llvalue -> string -> llbuilder -> llvalue
725 external build_and : llvalue -> llvalue -> string -> llbuilder -> llvalue
727 external build_or : llvalue -> llvalue -> string -> llbuilder -> llvalue
729 external build_xor : llvalue -> llvalue -> string -> llbuilder -> llvalue
731 external build_neg : llvalue -> string -> llbuilder -> llvalue
733 external build_not : llvalue -> string -> llbuilder -> llvalue
736 (*--... Memory .............................................................--*)
737 external build_malloc : lltype -> string -> llbuilder -> llvalue
738 = "llvm_build_malloc"
739 external build_array_malloc : lltype -> llvalue -> string -> llbuilder ->
740 llvalue = "llvm_build_array_malloc"
741 external build_alloca : lltype -> string -> llbuilder -> llvalue
742 = "llvm_build_alloca"
743 external build_array_alloca : lltype -> llvalue -> string -> llbuilder ->
744 llvalue = "llvm_build_array_alloca"
745 external build_free : llvalue -> llbuilder -> llvalue = "llvm_build_free"
746 external build_load : llvalue -> string -> llbuilder -> llvalue
748 external build_store : llvalue -> llvalue -> llbuilder -> llvalue
750 external build_gep : llvalue -> llvalue array -> string -> llbuilder -> llvalue
752 external build_in_bounds_gep : llvalue -> llvalue array -> string ->
753 llbuilder -> llvalue = "llvm_build_in_bounds_gep"
754 external build_struct_gep : llvalue -> int -> string -> llbuilder -> llvalue
755 = "llvm_build_struct_gep"
757 external build_global_string : string -> string -> llbuilder -> llvalue
758 = "llvm_build_global_string"
759 external build_global_stringptr : string -> string -> llbuilder -> llvalue
760 = "llvm_build_global_stringptr"
762 (*--... Casts ..............................................................--*)
763 external build_trunc : llvalue -> lltype -> string -> llbuilder -> llvalue
765 external build_zext : llvalue -> lltype -> string -> llbuilder -> llvalue
767 external build_sext : llvalue -> lltype -> string -> llbuilder -> llvalue
769 external build_fptoui : llvalue -> lltype -> string -> llbuilder -> llvalue
770 = "llvm_build_fptoui"
771 external build_fptosi : llvalue -> lltype -> string -> llbuilder -> llvalue
772 = "llvm_build_fptosi"
773 external build_uitofp : llvalue -> lltype -> string -> llbuilder -> llvalue
774 = "llvm_build_uitofp"
775 external build_sitofp : llvalue -> lltype -> string -> llbuilder -> llvalue
776 = "llvm_build_sitofp"
777 external build_fptrunc : llvalue -> lltype -> string -> llbuilder -> llvalue
778 = "llvm_build_fptrunc"
779 external build_fpext : llvalue -> lltype -> string -> llbuilder -> llvalue
781 external build_ptrtoint : llvalue -> lltype -> string -> llbuilder -> llvalue
782 = "llvm_build_prttoint"
783 external build_inttoptr : llvalue -> lltype -> string -> llbuilder -> llvalue
784 = "llvm_build_inttoptr"
785 external build_bitcast : llvalue -> lltype -> string -> llbuilder -> llvalue
786 = "llvm_build_bitcast"
787 external build_zext_or_bitcast : llvalue -> lltype -> string -> llbuilder ->
788 llvalue = "llvm_build_zext_or_bitcast"
789 external build_sext_or_bitcast : llvalue -> lltype -> string -> llbuilder ->
790 llvalue = "llvm_build_sext_or_bitcast"
791 external build_trunc_or_bitcast : llvalue -> lltype -> string -> llbuilder ->
792 llvalue = "llvm_build_trunc_or_bitcast"
793 external build_pointercast : llvalue -> lltype -> string -> llbuilder -> llvalue
794 = "llvm_build_pointercast"
795 external build_intcast : llvalue -> lltype -> string -> llbuilder -> llvalue
796 = "llvm_build_intcast"
797 external build_fpcast : llvalue -> lltype -> string -> llbuilder -> llvalue
798 = "llvm_build_fpcast"
800 (*--... Comparisons ........................................................--*)
801 external build_icmp : Icmp.t -> llvalue -> llvalue -> string ->
802 llbuilder -> llvalue = "llvm_build_icmp"
803 external build_fcmp : Fcmp.t -> llvalue -> llvalue -> string ->
804 llbuilder -> llvalue = "llvm_build_fcmp"
806 (*--... Miscellaneous instructions .........................................--*)
807 external build_phi : (llvalue * llbasicblock) list -> string -> llbuilder ->
808 llvalue = "llvm_build_phi"
809 external build_call : llvalue -> llvalue array -> string -> llbuilder -> llvalue
811 external build_select : llvalue -> llvalue -> llvalue -> string -> llbuilder ->
812 llvalue = "llvm_build_select"
813 external build_va_arg : llvalue -> lltype -> string -> llbuilder -> llvalue
814 = "llvm_build_va_arg"
815 external build_extractelement : llvalue -> llvalue -> string -> llbuilder ->
816 llvalue = "llvm_build_extractelement"
817 external build_insertelement : llvalue -> llvalue -> llvalue -> string ->
818 llbuilder -> llvalue = "llvm_build_insertelement"
819 external build_shufflevector : llvalue -> llvalue -> llvalue -> string ->
820 llbuilder -> llvalue = "llvm_build_shufflevector"
821 external build_extractvalue : llvalue -> int -> string -> llbuilder -> llvalue
822 = "llvm_build_extractvalue"
823 external build_insertvalue : llvalue -> llvalue -> int -> string -> llbuilder ->
824 llvalue = "llvm_build_insertvalue"
826 external build_is_null : llvalue -> string -> llbuilder -> llvalue
827 = "llvm_build_is_null"
828 external build_is_not_null : llvalue -> string -> llbuilder -> llvalue
829 = "llvm_build_is_not_null"
830 external build_ptrdiff : llvalue -> llvalue -> string -> llbuilder -> llvalue
831 = "llvm_build_ptrdiff"
833 (*===-- Module providers --------------------------------------------------===*)
835 module ModuleProvider = struct
836 external create : llmodule -> llmoduleprovider
837 = "LLVMCreateModuleProviderForExistingModule"
838 external dispose : llmoduleprovider -> unit = "llvm_dispose_module_provider"
842 (*===-- Memory buffers ----------------------------------------------------===*)
844 module MemoryBuffer = struct
845 external of_file : string -> llmemorybuffer = "llvm_memorybuffer_of_file"
846 external of_stdin : unit -> llmemorybuffer = "llvm_memorybuffer_of_stdin"
847 external dispose : llmemorybuffer -> unit = "llvm_memorybuffer_dispose"
851 (*===-- Pass Manager ------------------------------------------------------===*)
853 module PassManager = struct
855 type any = [ `Module | `Function ]
856 external create : unit -> [ `Module ] t = "llvm_passmanager_create"
857 external create_function : llmoduleprovider -> [ `Function ] t
858 = "LLVMCreateFunctionPassManager"
859 external run_module : llmodule -> [ `Module ] t -> bool
860 = "llvm_passmanager_run_module"
861 external initialize : [ `Function ] t -> bool = "llvm_passmanager_initialize"
862 external run_function : llvalue -> [ `Function ] t -> bool
863 = "llvm_passmanager_run_function"
864 external finalize : [ `Function ] t -> bool = "llvm_passmanager_finalize"
865 external dispose : [< any ] t -> unit = "llvm_passmanager_dispose"
869 (*===-- Non-Externs -------------------------------------------------------===*)
870 (* These functions are built using the externals, so must be declared late. *)
872 let concat2 sep arr =
874 if 0 < Array.length arr then begin
876 for i = 1 to (Array.length arr) - 1 do
877 s := !s ^ sep ^ arr.(i)
882 let rec string_of_lltype ty =
883 (* FIXME: stop infinite recursion! :) *)
884 match classify_type ty with
885 TypeKind.Integer -> "i" ^ string_of_int (integer_bitwidth ty)
886 | TypeKind.Pointer -> (string_of_lltype (element_type ty)) ^ "*"
888 let s = "{ " ^ (concat2 ", " (
889 Array.map string_of_lltype (element_types ty)
894 | TypeKind.Array -> "[" ^ (string_of_int (array_length ty)) ^
895 " x " ^ (string_of_lltype (element_type ty)) ^ "]"
896 | TypeKind.Vector -> "<" ^ (string_of_int (vector_size ty)) ^
897 " x " ^ (string_of_lltype (element_type ty)) ^ ">"
898 | TypeKind.Opaque -> "opaque"
899 | TypeKind.Function -> string_of_lltype (return_type ty) ^
900 " (" ^ (concat2 ", " (
901 Array.map string_of_lltype (param_types ty)
903 | TypeKind.Label -> "label"
904 | TypeKind.Ppc_fp128 -> "ppc_fp128"
905 | TypeKind.Fp128 -> "fp128"
906 | TypeKind.X86fp80 -> "x86_fp80"
907 | TypeKind.Double -> "double"
908 | TypeKind.Float -> "float"
909 | TypeKind.Void -> "void"
910 | TypeKind.Metadata -> "metadata"