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 *===----------------------------------------------------------------------===*)
21 module TypeKind = struct
40 module Linkage = struct
43 | Available_externally
54 module Visibility = struct
61 module CallConv = struct
69 module Attribute = struct
118 exception IoError of string
120 external register_exns : exn -> unit = "llvm_register_core_exns"
121 let _ = register_exns (IoError "")
123 type ('a, 'b) llpos =
127 type ('a, 'b) llrev_pos =
131 (*===-- Contexts ----------------------------------------------------------===*)
132 external create_context : unit -> llcontext = "llvm_create_context"
133 external dispose_context : unit -> llcontext = "llvm_dispose_context"
134 external global_context : unit -> llcontext = "llvm_global_context"
136 (*===-- Modules -----------------------------------------------------------===*)
137 external create_module : llcontext -> string -> llmodule = "llvm_create_module"
138 external dispose_module : llmodule -> unit = "llvm_dispose_module"
139 external target_triple: llmodule -> string
140 = "llvm_target_triple"
141 external set_target_triple: string -> llmodule -> unit
142 = "llvm_set_target_triple"
143 external data_layout: llmodule -> string
145 external set_data_layout: string -> llmodule -> unit
146 = "llvm_set_data_layout"
147 external define_type_name : string -> lltype -> llmodule -> bool
148 = "llvm_add_type_name"
149 external delete_type_name : string -> llmodule -> unit
150 = "llvm_delete_type_name"
151 external dump_module : llmodule -> unit = "llvm_dump_module"
153 (*===-- Types -------------------------------------------------------------===*)
154 external classify_type : lltype -> TypeKind.t = "llvm_classify_type"
155 external type_context : lltype -> llcontext = "llvm_type_context"
157 (*--... Operations on integer types ........................................--*)
158 external i1_type : llcontext -> lltype = "llvm_i1_type"
159 external i8_type : llcontext -> lltype = "llvm_i8_type"
160 external i16_type : llcontext -> lltype = "llvm_i16_type"
161 external i32_type : llcontext -> lltype = "llvm_i32_type"
162 external i64_type : llcontext -> lltype = "llvm_i64_type"
164 external integer_type : llcontext -> int -> lltype = "llvm_integer_type"
165 external integer_bitwidth : lltype -> int = "llvm_integer_bitwidth"
167 (*--... Operations on real types ...........................................--*)
168 external float_type : llcontext -> lltype = "llvm_float_type"
169 external double_type : llcontext -> lltype = "llvm_double_type"
170 external x86fp80_type : llcontext -> lltype = "llvm_x86fp80_type"
171 external fp128_type : llcontext -> lltype = "llvm_fp128_type"
172 external ppc_fp128_type : llcontext -> lltype = "llvm_ppc_fp128_type"
174 (*--... Operations on function types .......................................--*)
175 external function_type : lltype -> lltype array -> lltype = "llvm_function_type"
176 external var_arg_function_type : lltype -> lltype array -> lltype
177 = "llvm_var_arg_function_type"
178 external is_var_arg : lltype -> bool = "llvm_is_var_arg"
179 external return_type : lltype -> lltype = "LLVMGetReturnType"
180 external param_types : lltype -> lltype array = "llvm_param_types"
182 (*--... Operations on struct types .........................................--*)
183 external struct_type : llcontext -> lltype array -> lltype = "llvm_struct_type"
184 external packed_struct_type : llcontext -> lltype array -> lltype
185 = "llvm_packed_struct_type"
186 external element_types : lltype -> lltype array = "llvm_element_types"
187 external is_packed : lltype -> bool = "llvm_is_packed"
189 (*--... Operations on pointer, vector, and array types .....................--*)
190 external array_type : lltype -> int -> lltype = "llvm_array_type"
191 external pointer_type : lltype -> lltype = "llvm_pointer_type"
192 external qualified_pointer_type : lltype -> int -> lltype
193 = "llvm_qualified_pointer_type"
194 external vector_type : lltype -> int -> lltype = "llvm_vector_type"
196 external element_type : lltype -> lltype = "LLVMGetElementType"
197 external array_length : lltype -> int = "llvm_array_length"
198 external address_space : lltype -> int = "llvm_address_space"
199 external vector_size : lltype -> int = "llvm_vector_size"
201 (*--... Operations on other types ..........................................--*)
202 external opaque_type : llcontext -> lltype = "llvm_opaque_type"
203 external void_type : llcontext -> lltype = "llvm_void_type"
204 external label_type : llcontext -> lltype = "llvm_label_type"
206 (*--... Operations on type handles .........................................--*)
207 external handle_to_type : lltype -> lltypehandle = "llvm_handle_to_type"
208 external type_of_handle : lltypehandle -> lltype = "llvm_type_of_handle"
209 external refine_type : lltype -> lltype -> unit = "llvm_refine_type"
212 (*===-- Values ------------------------------------------------------------===*)
213 external type_of : llvalue -> lltype = "llvm_type_of"
214 external value_name : llvalue -> string = "llvm_value_name"
215 external set_value_name : string -> llvalue -> unit = "llvm_set_value_name"
216 external dump_value : llvalue -> unit = "llvm_dump_value"
218 (*--... Operations on constants of (mostly) any type .......................--*)
219 external is_constant : llvalue -> bool = "llvm_is_constant"
220 external const_null : lltype -> llvalue = "LLVMConstNull"
221 external const_all_ones : (*int|vec*)lltype -> llvalue = "LLVMConstAllOnes"
222 external undef : lltype -> llvalue = "LLVMGetUndef"
223 external is_null : llvalue -> bool = "llvm_is_null"
224 external is_undef : llvalue -> bool = "llvm_is_undef"
226 (*--... Operations on scalar constants .....................................--*)
227 external const_int : lltype -> int -> llvalue = "llvm_const_int"
228 external const_of_int64 : lltype -> Int64.t -> bool -> llvalue
229 = "llvm_const_of_int64"
230 external const_int_of_string : lltype -> string -> int -> llvalue
231 = "llvm_const_int_of_string"
232 external const_float : lltype -> float -> llvalue = "llvm_const_float"
233 external const_float_of_string : lltype -> string -> llvalue
234 = "llvm_const_float_of_string"
236 (*--... Operations on composite constants ..................................--*)
237 external const_string : llcontext -> string -> llvalue = "llvm_const_string"
238 external const_stringz : llcontext -> string -> llvalue = "llvm_const_stringz"
239 external const_array : lltype -> llvalue array -> llvalue = "llvm_const_array"
240 external const_struct : llcontext -> llvalue array -> llvalue
241 = "llvm_const_struct"
242 external const_packed_struct : llcontext -> llvalue array -> llvalue
243 = "llvm_const_packed_struct"
244 external const_vector : llvalue array -> llvalue = "llvm_const_vector"
246 (*--... Constant expressions ...............................................--*)
247 external align_of : lltype -> llvalue = "LLVMAlignOf"
248 external size_of : lltype -> llvalue = "LLVMSizeOf"
249 external const_neg : llvalue -> llvalue = "LLVMConstNeg"
250 external const_fneg : llvalue -> llvalue = "LLVMConstFNeg"
251 external const_not : llvalue -> llvalue = "LLVMConstNot"
252 external const_add : llvalue -> llvalue -> llvalue = "LLVMConstAdd"
253 external const_nsw_add : llvalue -> llvalue -> llvalue = "LLVMConstNSWAdd"
254 external const_fadd : llvalue -> llvalue -> llvalue = "LLVMConstFAdd"
255 external const_sub : llvalue -> llvalue -> llvalue = "LLVMConstSub"
256 external const_fsub : llvalue -> llvalue -> llvalue = "LLVMConstFSub"
257 external const_mul : llvalue -> llvalue -> llvalue = "LLVMConstMul"
258 external const_fmul : llvalue -> llvalue -> llvalue = "LLVMConstFMul"
259 external const_udiv : llvalue -> llvalue -> llvalue = "LLVMConstUDiv"
260 external const_sdiv : llvalue -> llvalue -> llvalue = "LLVMConstSDiv"
261 external const_exact_sdiv : llvalue -> llvalue -> llvalue = "LLVMConstExactSDiv"
262 external const_fdiv : llvalue -> llvalue -> llvalue = "LLVMConstFDiv"
263 external const_urem : llvalue -> llvalue -> llvalue = "LLVMConstURem"
264 external const_srem : llvalue -> llvalue -> llvalue = "LLVMConstSRem"
265 external const_frem : llvalue -> llvalue -> llvalue = "LLVMConstFRem"
266 external const_and : llvalue -> llvalue -> llvalue = "LLVMConstAnd"
267 external const_or : llvalue -> llvalue -> llvalue = "LLVMConstOr"
268 external const_xor : llvalue -> llvalue -> llvalue = "LLVMConstXor"
269 external const_icmp : Icmp.t -> llvalue -> llvalue -> llvalue
271 external const_fcmp : Fcmp.t -> llvalue -> llvalue -> llvalue
273 external const_shl : llvalue -> llvalue -> llvalue = "LLVMConstShl"
274 external const_lshr : llvalue -> llvalue -> llvalue = "LLVMConstLShr"
275 external const_ashr : llvalue -> llvalue -> llvalue = "LLVMConstAShr"
276 external const_gep : llvalue -> llvalue array -> llvalue = "llvm_const_gep"
277 external const_in_bounds_gep : llvalue -> llvalue array -> llvalue
278 = "llvm_const_in_bounds_gep"
279 external const_trunc : llvalue -> lltype -> llvalue = "LLVMConstTrunc"
280 external const_sext : llvalue -> lltype -> llvalue = "LLVMConstSExt"
281 external const_zext : llvalue -> lltype -> llvalue = "LLVMConstZExt"
282 external const_fptrunc : llvalue -> lltype -> llvalue = "LLVMConstFPTrunc"
283 external const_fpext : llvalue -> lltype -> llvalue = "LLVMConstFPExt"
284 external const_uitofp : llvalue -> lltype -> llvalue = "LLVMConstUIToFP"
285 external const_sitofp : llvalue -> lltype -> llvalue = "LLVMConstSIToFP"
286 external const_fptoui : llvalue -> lltype -> llvalue = "LLVMConstFPToUI"
287 external const_fptosi : llvalue -> lltype -> llvalue = "LLVMConstFPToSI"
288 external const_ptrtoint : llvalue -> lltype -> llvalue = "LLVMConstPtrToInt"
289 external const_inttoptr : llvalue -> lltype -> llvalue = "LLVMConstIntToPtr"
290 external const_bitcast : llvalue -> lltype -> llvalue = "LLVMConstBitCast"
291 external const_zext_or_bitcast : llvalue -> lltype -> llvalue
292 = "LLVMConstZExtOrBitCast"
293 external const_sext_or_bitcast : llvalue -> lltype -> llvalue
294 = "LLVMConstSExtOrBitCast"
295 external const_trunc_or_bitcast : llvalue -> lltype -> llvalue
296 = "LLVMConstTruncOrBitCast"
297 external const_pointercast : llvalue -> lltype -> llvalue
298 = "LLVMConstPointerCast"
299 external const_intcast : llvalue -> lltype -> llvalue = "LLVMConstIntCast"
300 external const_fpcast : llvalue -> lltype -> llvalue = "LLVMConstFPCast"
301 external const_select : llvalue -> llvalue -> llvalue -> llvalue
303 external const_extractelement : llvalue -> llvalue -> llvalue
304 = "LLVMConstExtractElement"
305 external const_insertelement : llvalue -> llvalue -> llvalue -> llvalue
306 = "LLVMConstInsertElement"
307 external const_shufflevector : llvalue -> llvalue -> llvalue -> llvalue
308 = "LLVMConstShuffleVector"
309 external const_extractvalue : llvalue -> int array -> llvalue
310 = "llvm_const_extractvalue"
311 external const_insertvalue : llvalue -> llvalue -> int array -> llvalue
312 = "llvm_const_insertvalue"
314 (*--... Operations on global variables, functions, and aliases (globals) ...--*)
315 external global_parent : llvalue -> llmodule = "LLVMGetGlobalParent"
316 external is_declaration : llvalue -> bool = "llvm_is_declaration"
317 external linkage : llvalue -> Linkage.t = "llvm_linkage"
318 external set_linkage : Linkage.t -> llvalue -> unit = "llvm_set_linkage"
319 external section : llvalue -> string = "llvm_section"
320 external set_section : string -> llvalue -> unit = "llvm_set_section"
321 external visibility : llvalue -> Visibility.t = "llvm_visibility"
322 external set_visibility : Visibility.t -> llvalue -> unit = "llvm_set_visibility"
323 external alignment : llvalue -> int = "llvm_alignment"
324 external set_alignment : int -> llvalue -> unit = "llvm_set_alignment"
325 external is_global_constant : llvalue -> bool = "llvm_is_global_constant"
326 external set_global_constant : bool -> llvalue -> unit
327 = "llvm_set_global_constant"
329 (*--... Operations on global variables .....................................--*)
330 external declare_global : lltype -> string -> llmodule -> llvalue
331 = "llvm_declare_global"
332 external define_global : string -> llvalue -> llmodule -> llvalue
333 = "llvm_define_global"
334 external lookup_global : string -> llmodule -> llvalue option
335 = "llvm_lookup_global"
336 external delete_global : llvalue -> unit = "llvm_delete_global"
337 external global_initializer : llvalue -> llvalue = "LLVMGetInitializer"
338 external set_initializer : llvalue -> llvalue -> unit = "llvm_set_initializer"
339 external remove_initializer : llvalue -> unit = "llvm_remove_initializer"
340 external is_thread_local : llvalue -> bool = "llvm_is_thread_local"
341 external set_thread_local : bool -> llvalue -> unit = "llvm_set_thread_local"
342 external global_begin : llmodule -> (llmodule, llvalue) llpos
343 = "llvm_global_begin"
344 external global_succ : llvalue -> (llmodule, llvalue) llpos
346 external global_end : llmodule -> (llmodule, llvalue) llrev_pos
348 external global_pred : llvalue -> (llmodule, llvalue) llrev_pos
351 let rec iter_global_range f i e =
352 if i = e then () else
354 | At_end _ -> raise (Invalid_argument "Invalid global variable range.")
357 iter_global_range f (global_succ bb) e
359 let iter_globals f m =
360 iter_global_range f (global_begin m) (At_end m)
362 let rec fold_left_global_range f init i e =
363 if i = e then init else
365 | At_end _ -> raise (Invalid_argument "Invalid global variable range.")
366 | Before bb -> fold_left_global_range f (f init bb) (global_succ bb) e
368 let fold_left_globals f init m =
369 fold_left_global_range f init (global_begin m) (At_end m)
371 let rec rev_iter_global_range f i e =
372 if i = e then () else
374 | At_start _ -> raise (Invalid_argument "Invalid global variable range.")
377 rev_iter_global_range f (global_pred bb) e
379 let rev_iter_globals f m =
380 rev_iter_global_range f (global_end m) (At_start m)
382 let rec fold_right_global_range f i e init =
383 if i = e then init else
385 | At_start _ -> raise (Invalid_argument "Invalid global variable range.")
386 | After bb -> fold_right_global_range f (global_pred bb) e (f bb init)
388 let fold_right_globals f m init =
389 fold_right_global_range f (global_end m) (At_start m) init
391 (*--... Operations on functions ............................................--*)
392 external declare_function : string -> lltype -> llmodule -> llvalue
393 = "llvm_declare_function"
394 external define_function : string -> lltype -> llmodule -> llvalue
395 = "llvm_define_function"
396 external lookup_function : string -> llmodule -> llvalue option
397 = "llvm_lookup_function"
398 external delete_function : llvalue -> unit = "llvm_delete_function"
399 external is_intrinsic : llvalue -> bool = "llvm_is_intrinsic"
400 external function_call_conv : llvalue -> int = "llvm_function_call_conv"
401 external set_function_call_conv : int -> llvalue -> unit
402 = "llvm_set_function_call_conv"
403 external gc : llvalue -> string option = "llvm_gc"
404 external set_gc : string option -> llvalue -> unit = "llvm_set_gc"
405 external function_begin : llmodule -> (llmodule, llvalue) llpos
406 = "llvm_function_begin"
407 external function_succ : llvalue -> (llmodule, llvalue) llpos
408 = "llvm_function_succ"
409 external function_end : llmodule -> (llmodule, llvalue) llrev_pos
410 = "llvm_function_end"
411 external function_pred : llvalue -> (llmodule, llvalue) llrev_pos
412 = "llvm_function_pred"
414 let rec iter_function_range f i e =
415 if i = e then () else
417 | At_end _ -> raise (Invalid_argument "Invalid function range.")
420 iter_function_range f (function_succ fn) e
422 let iter_functions f m =
423 iter_function_range f (function_begin m) (At_end m)
425 let rec fold_left_function_range f init i e =
426 if i = e then init else
428 | At_end _ -> raise (Invalid_argument "Invalid function range.")
429 | Before fn -> fold_left_function_range f (f init fn) (function_succ fn) e
431 let fold_left_functions f init m =
432 fold_left_function_range f init (function_begin m) (At_end m)
434 let rec rev_iter_function_range f i e =
435 if i = e then () else
437 | At_start _ -> raise (Invalid_argument "Invalid function range.")
440 rev_iter_function_range f (function_pred fn) e
442 let rev_iter_functions f m =
443 rev_iter_function_range f (function_end m) (At_start m)
445 let rec fold_right_function_range f i e init =
446 if i = e then init else
448 | At_start _ -> raise (Invalid_argument "Invalid function range.")
449 | After fn -> fold_right_function_range f (function_pred fn) e (f fn init)
451 let fold_right_functions f m init =
452 fold_right_function_range f (function_end m) (At_start m) init
454 external add_function_attr : llvalue -> Attribute.t -> unit
455 = "llvm_add_function_attr"
456 external remove_function_attr : llvalue -> Attribute.t -> unit
457 = "llvm_remove_function_attr"
459 (*--... Operations on params ...............................................--*)
460 external params : llvalue -> llvalue array = "llvm_params"
461 external param : llvalue -> int -> llvalue = "llvm_param"
462 external param_parent : llvalue -> llvalue = "LLVMGetParamParent"
463 external param_begin : llvalue -> (llvalue, llvalue) llpos = "llvm_param_begin"
464 external param_succ : llvalue -> (llvalue, llvalue) llpos = "llvm_param_succ"
465 external param_end : llvalue -> (llvalue, llvalue) llrev_pos = "llvm_param_end"
466 external param_pred : llvalue -> (llvalue, llvalue) llrev_pos ="llvm_param_pred"
468 let rec iter_param_range f i e =
469 if i = e then () else
471 | At_end _ -> raise (Invalid_argument "Invalid parameter range.")
474 iter_param_range f (param_succ p) e
476 let iter_params f fn =
477 iter_param_range f (param_begin fn) (At_end fn)
479 let rec fold_left_param_range f init i e =
480 if i = e then init else
482 | At_end _ -> raise (Invalid_argument "Invalid parameter range.")
483 | Before p -> fold_left_param_range f (f init p) (param_succ p) e
485 let fold_left_params f init fn =
486 fold_left_param_range f init (param_begin fn) (At_end fn)
488 let rec rev_iter_param_range f i e =
489 if i = e then () else
491 | At_start _ -> raise (Invalid_argument "Invalid parameter range.")
494 rev_iter_param_range f (param_pred p) e
496 let rev_iter_params f fn =
497 rev_iter_param_range f (param_end fn) (At_start fn)
499 let rec fold_right_param_range f init i e =
500 if i = e then init else
502 | At_start _ -> raise (Invalid_argument "Invalid parameter range.")
503 | After p -> fold_right_param_range f (f p init) (param_pred p) e
505 let fold_right_params f fn init =
506 fold_right_param_range f init (param_end fn) (At_start fn)
508 external add_param_attr : llvalue -> Attribute.t -> unit
509 = "llvm_add_param_attr"
510 external remove_param_attr : llvalue -> Attribute.t -> unit
511 = "llvm_remove_param_attr"
512 external set_param_alignment : llvalue -> int -> unit
513 = "llvm_set_param_alignment"
515 (*--... Operations on basic blocks .........................................--*)
516 external value_of_block : llbasicblock -> llvalue = "LLVMBasicBlockAsValue"
517 external value_is_block : llvalue -> bool = "llvm_value_is_block"
518 external block_of_value : llvalue -> llbasicblock = "LLVMValueAsBasicBlock"
519 external block_parent : llbasicblock -> llvalue = "LLVMGetBasicBlockParent"
520 external basic_blocks : llvalue -> llbasicblock array = "llvm_basic_blocks"
521 external entry_block : llvalue -> llbasicblock = "LLVMGetEntryBasicBlock"
522 external delete_block : llbasicblock -> unit = "llvm_delete_block"
523 external append_block : llcontext -> string -> llvalue -> llbasicblock
524 = "llvm_append_block"
525 external insert_block : llcontext -> string -> llbasicblock -> llbasicblock
526 = "llvm_insert_block"
527 external block_begin : llvalue -> (llvalue, llbasicblock) llpos
529 external block_succ : llbasicblock -> (llvalue, llbasicblock) llpos
531 external block_end : llvalue -> (llvalue, llbasicblock) llrev_pos
533 external block_pred : llbasicblock -> (llvalue, llbasicblock) llrev_pos
536 let rec iter_block_range f i e =
537 if i = e then () else
539 | At_end _ -> raise (Invalid_argument "Invalid block range.")
542 iter_block_range f (block_succ bb) e
544 let iter_blocks f fn =
545 iter_block_range f (block_begin fn) (At_end fn)
547 let rec fold_left_block_range f init i e =
548 if i = e then init else
550 | At_end _ -> raise (Invalid_argument "Invalid block range.")
551 | Before bb -> fold_left_block_range f (f init bb) (block_succ bb) e
553 let fold_left_blocks f init fn =
554 fold_left_block_range f init (block_begin fn) (At_end fn)
556 let rec rev_iter_block_range f i e =
557 if i = e then () else
559 | At_start _ -> raise (Invalid_argument "Invalid block range.")
562 rev_iter_block_range f (block_pred bb) e
564 let rev_iter_blocks f fn =
565 rev_iter_block_range f (block_end fn) (At_start fn)
567 let rec fold_right_block_range f init i e =
568 if i = e then init else
570 | At_start _ -> raise (Invalid_argument "Invalid block range.")
571 | After bb -> fold_right_block_range f (f bb init) (block_pred bb) e
573 let fold_right_blocks f fn init =
574 fold_right_block_range f init (block_end fn) (At_start fn)
576 (*--... Operations on instructions .........................................--*)
577 external instr_parent : llvalue -> llbasicblock = "LLVMGetInstructionParent"
578 external instr_begin : llbasicblock -> (llbasicblock, llvalue) llpos
580 external instr_succ : llvalue -> (llbasicblock, llvalue) llpos
582 external instr_end : llbasicblock -> (llbasicblock, llvalue) llrev_pos
584 external instr_pred : llvalue -> (llbasicblock, llvalue) llrev_pos
587 let rec iter_instrs_range f i e =
588 if i = e then () else
590 | At_end _ -> raise (Invalid_argument "Invalid instruction range.")
593 iter_instrs_range f (instr_succ i) e
595 let iter_instrs f bb =
596 iter_instrs_range f (instr_begin bb) (At_end bb)
598 let rec fold_left_instrs_range f init i e =
599 if i = e then init else
601 | At_end _ -> raise (Invalid_argument "Invalid instruction range.")
602 | Before i -> fold_left_instrs_range f (f init i) (instr_succ i) e
604 let fold_left_instrs f init bb =
605 fold_left_instrs_range f init (instr_begin bb) (At_end bb)
607 let rec rev_iter_instrs_range f i e =
608 if i = e then () else
610 | At_start _ -> raise (Invalid_argument "Invalid instruction range.")
613 rev_iter_instrs_range f (instr_pred i) e
615 let rev_iter_instrs f bb =
616 rev_iter_instrs_range f (instr_end bb) (At_start bb)
618 let rec fold_right_instr_range f i e init =
619 if i = e then init else
621 | At_start _ -> raise (Invalid_argument "Invalid instruction range.")
622 | After i -> fold_right_instr_range f (instr_pred i) e (f i init)
624 let fold_right_instrs f bb init =
625 fold_right_instr_range f (instr_end bb) (At_start bb) init
628 (*--... Operations on call sites ...........................................--*)
629 external instruction_call_conv: llvalue -> int
630 = "llvm_instruction_call_conv"
631 external set_instruction_call_conv: int -> llvalue -> unit
632 = "llvm_set_instruction_call_conv"
633 external add_instruction_param_attr : llvalue -> int -> Attribute.t -> unit
634 = "llvm_add_instruction_param_attr"
635 external remove_instruction_param_attr : llvalue -> int -> Attribute.t -> unit
636 = "llvm_remove_instruction_param_attr"
638 (*--... Operations on call instructions (only) .............................--*)
639 external is_tail_call : llvalue -> bool = "llvm_is_tail_call"
640 external set_tail_call : bool -> llvalue -> unit = "llvm_set_tail_call"
642 (*--... Operations on phi nodes ............................................--*)
643 external add_incoming : (llvalue * llbasicblock) -> llvalue -> unit
644 = "llvm_add_incoming"
645 external incoming : llvalue -> (llvalue * llbasicblock) list = "llvm_incoming"
648 (*===-- Instruction builders ----------------------------------------------===*)
649 external builder : llcontext -> llbuilder = "llvm_builder"
650 external position_builder : (llbasicblock, llvalue) llpos -> llbuilder -> unit
651 = "llvm_position_builder"
652 external insertion_block : llbuilder -> llbasicblock = "llvm_insertion_block"
653 external insert_into_builder : llvalue -> string -> llbuilder -> unit
654 = "llvm_insert_into_builder"
656 let builder_at context ip =
657 let b = builder context in
658 position_builder ip b;
661 let builder_before context i = builder_at context (Before i)
662 let builder_at_end context bb = builder_at context (At_end bb)
664 let position_before i = position_builder (Before i)
665 let position_at_end bb = position_builder (At_end bb)
668 (*--... Terminators ........................................................--*)
669 external build_ret_void : llbuilder -> llvalue = "llvm_build_ret_void"
670 external build_ret : llvalue -> llbuilder -> llvalue = "llvm_build_ret"
671 external build_aggregate_ret : llvalue array -> llbuilder -> llvalue
672 = "llvm_build_aggregate_ret"
673 external build_br : llbasicblock -> llbuilder -> llvalue = "llvm_build_br"
674 external build_cond_br : llvalue -> llbasicblock -> llbasicblock -> llbuilder ->
675 llvalue = "llvm_build_cond_br"
676 external build_switch : llvalue -> llbasicblock -> int -> llbuilder -> llvalue
677 = "llvm_build_switch"
678 external add_case : llvalue -> llvalue -> llbasicblock -> unit
680 external build_invoke : llvalue -> llvalue array -> llbasicblock ->
681 llbasicblock -> string -> llbuilder -> llvalue
682 = "llvm_build_invoke_bc" "llvm_build_invoke_nat"
683 external build_unwind : llbuilder -> llvalue = "llvm_build_unwind"
684 external build_unreachable : llbuilder -> llvalue = "llvm_build_unreachable"
686 (*--... Arithmetic .........................................................--*)
687 external build_add : llvalue -> llvalue -> string -> llbuilder -> llvalue
689 external build_nsw_add : llvalue -> llvalue -> string -> llbuilder -> llvalue
690 = "llvm_build_nsw_add"
691 external build_fadd : llvalue -> llvalue -> string -> llbuilder -> llvalue
693 external build_sub : llvalue -> llvalue -> string -> llbuilder -> llvalue
695 external build_fsub : llvalue -> llvalue -> string -> llbuilder -> llvalue
697 external build_mul : llvalue -> llvalue -> string -> llbuilder -> llvalue
699 external build_fmul : llvalue -> llvalue -> string -> llbuilder -> llvalue
701 external build_udiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
703 external build_sdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
705 external build_exact_sdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
706 = "llvm_build_exact_sdiv"
707 external build_fdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
709 external build_urem : llvalue -> llvalue -> string -> llbuilder -> llvalue
711 external build_srem : llvalue -> llvalue -> string -> llbuilder -> llvalue
713 external build_frem : llvalue -> llvalue -> string -> llbuilder -> llvalue
715 external build_shl : llvalue -> llvalue -> string -> llbuilder -> llvalue
717 external build_lshr : llvalue -> llvalue -> string -> llbuilder -> llvalue
719 external build_ashr : llvalue -> llvalue -> string -> llbuilder -> llvalue
721 external build_and : llvalue -> llvalue -> string -> llbuilder -> llvalue
723 external build_or : llvalue -> llvalue -> string -> llbuilder -> llvalue
725 external build_xor : llvalue -> llvalue -> string -> llbuilder -> llvalue
727 external build_neg : llvalue -> string -> llbuilder -> llvalue
729 external build_not : llvalue -> string -> llbuilder -> llvalue
732 (*--... Memory .............................................................--*)
733 external build_malloc : lltype -> string -> llbuilder -> llvalue
734 = "llvm_build_malloc"
735 external build_array_malloc : lltype -> llvalue -> string -> llbuilder ->
736 llvalue = "llvm_build_array_malloc"
737 external build_alloca : lltype -> string -> llbuilder -> llvalue
738 = "llvm_build_alloca"
739 external build_array_alloca : lltype -> llvalue -> string -> llbuilder ->
740 llvalue = "llvm_build_array_alloca"
741 external build_free : llvalue -> llbuilder -> llvalue = "llvm_build_free"
742 external build_load : llvalue -> string -> llbuilder -> llvalue
744 external build_store : llvalue -> llvalue -> llbuilder -> llvalue
746 external build_gep : llvalue -> llvalue array -> string -> llbuilder -> llvalue
748 external build_in_bounds_gep : llvalue -> llvalue array -> string ->
749 llbuilder -> llvalue = "llvm_build_in_bounds_gep"
750 external build_struct_gep : llvalue -> int -> string -> llbuilder -> llvalue
751 = "llvm_build_struct_gep"
753 external build_global_string : string -> string -> llbuilder -> llvalue
754 = "llvm_build_global_string"
755 external build_global_stringptr : string -> string -> llbuilder -> llvalue
756 = "llvm_build_global_stringptr"
758 (*--... Casts ..............................................................--*)
759 external build_trunc : llvalue -> lltype -> string -> llbuilder -> llvalue
761 external build_zext : llvalue -> lltype -> string -> llbuilder -> llvalue
763 external build_sext : llvalue -> lltype -> string -> llbuilder -> llvalue
765 external build_fptoui : llvalue -> lltype -> string -> llbuilder -> llvalue
766 = "llvm_build_fptoui"
767 external build_fptosi : llvalue -> lltype -> string -> llbuilder -> llvalue
768 = "llvm_build_fptosi"
769 external build_uitofp : llvalue -> lltype -> string -> llbuilder -> llvalue
770 = "llvm_build_uitofp"
771 external build_sitofp : llvalue -> lltype -> string -> llbuilder -> llvalue
772 = "llvm_build_sitofp"
773 external build_fptrunc : llvalue -> lltype -> string -> llbuilder -> llvalue
774 = "llvm_build_fptrunc"
775 external build_fpext : llvalue -> lltype -> string -> llbuilder -> llvalue
777 external build_ptrtoint : llvalue -> lltype -> string -> llbuilder -> llvalue
778 = "llvm_build_prttoint"
779 external build_inttoptr : llvalue -> lltype -> string -> llbuilder -> llvalue
780 = "llvm_build_inttoptr"
781 external build_bitcast : llvalue -> lltype -> string -> llbuilder -> llvalue
782 = "llvm_build_bitcast"
783 external build_zext_or_bitcast : llvalue -> lltype -> string -> llbuilder ->
784 llvalue = "llvm_build_zext_or_bitcast"
785 external build_sext_or_bitcast : llvalue -> lltype -> string -> llbuilder ->
786 llvalue = "llvm_build_sext_or_bitcast"
787 external build_trunc_or_bitcast : llvalue -> lltype -> string -> llbuilder ->
788 llvalue = "llvm_build_trunc_or_bitcast"
789 external build_pointercast : llvalue -> lltype -> string -> llbuilder -> llvalue
790 = "llvm_build_pointercast"
791 external build_intcast : llvalue -> lltype -> string -> llbuilder -> llvalue
792 = "llvm_build_intcast"
793 external build_fpcast : llvalue -> lltype -> string -> llbuilder -> llvalue
794 = "llvm_build_fpcast"
796 (*--... Comparisons ........................................................--*)
797 external build_icmp : Icmp.t -> llvalue -> llvalue -> string ->
798 llbuilder -> llvalue = "llvm_build_icmp"
799 external build_fcmp : Fcmp.t -> llvalue -> llvalue -> string ->
800 llbuilder -> llvalue = "llvm_build_fcmp"
802 (*--... Miscellaneous instructions .........................................--*)
803 external build_phi : (llvalue * llbasicblock) list -> string -> llbuilder ->
804 llvalue = "llvm_build_phi"
805 external build_call : llvalue -> llvalue array -> string -> llbuilder -> llvalue
807 external build_select : llvalue -> llvalue -> llvalue -> string -> llbuilder ->
808 llvalue = "llvm_build_select"
809 external build_va_arg : llvalue -> lltype -> string -> llbuilder -> llvalue
810 = "llvm_build_va_arg"
811 external build_extractelement : llvalue -> llvalue -> string -> llbuilder ->
812 llvalue = "llvm_build_extractelement"
813 external build_insertelement : llvalue -> llvalue -> llvalue -> string ->
814 llbuilder -> llvalue = "llvm_build_insertelement"
815 external build_shufflevector : llvalue -> llvalue -> llvalue -> string ->
816 llbuilder -> llvalue = "llvm_build_shufflevector"
817 external build_extractvalue : llvalue -> int -> string -> llbuilder -> llvalue
818 = "llvm_build_extractvalue"
819 external build_insertvalue : llvalue -> llvalue -> int -> string -> llbuilder ->
820 llvalue = "llvm_build_insertvalue"
822 external build_is_null : llvalue -> string -> llbuilder -> llvalue
823 = "llvm_build_is_null"
824 external build_is_not_null : llvalue -> string -> llbuilder -> llvalue
825 = "llvm_build_is_not_null"
826 external build_ptrdiff : llvalue -> llvalue -> string -> llbuilder -> llvalue
827 = "llvm_build_ptrdiff"
829 (*===-- Module providers --------------------------------------------------===*)
831 module ModuleProvider = struct
832 external create : llmodule -> llmoduleprovider
833 = "LLVMCreateModuleProviderForExistingModule"
834 external dispose : llmoduleprovider -> unit = "llvm_dispose_module_provider"
838 (*===-- Memory buffers ----------------------------------------------------===*)
840 module MemoryBuffer = struct
841 external of_file : string -> llmemorybuffer = "llvm_memorybuffer_of_file"
842 external of_stdin : unit -> llmemorybuffer = "llvm_memorybuffer_of_stdin"
843 external dispose : llmemorybuffer -> unit = "llvm_memorybuffer_dispose"
847 (*===-- Pass Manager ------------------------------------------------------===*)
849 module PassManager = struct
851 type any = [ `Module | `Function ]
852 external create : unit -> [ `Module ] t = "llvm_passmanager_create"
853 external create_function : llmoduleprovider -> [ `Function ] t
854 = "LLVMCreateFunctionPassManager"
855 external run_module : llmodule -> [ `Module ] t -> bool
856 = "llvm_passmanager_run_module"
857 external initialize : [ `Function ] t -> bool = "llvm_passmanager_initialize"
858 external run_function : llvalue -> [ `Function ] t -> bool
859 = "llvm_passmanager_run_function"
860 external finalize : [ `Function ] t -> bool = "llvm_passmanager_finalize"
861 external dispose : [< any ] t -> unit = "llvm_passmanager_dispose"
865 (*===-- Non-Externs -------------------------------------------------------===*)
866 (* These functions are built using the externals, so must be declared late. *)
868 let concat2 sep arr =
870 if 0 < Array.length arr then begin
872 for i = 1 to (Array.length arr) - 1 do
873 s := !s ^ sep ^ arr.(i)
878 let rec string_of_lltype ty =
879 (* FIXME: stop infinite recursion! :) *)
880 match classify_type ty with
881 TypeKind.Integer -> "i" ^ string_of_int (integer_bitwidth ty)
882 | TypeKind.Pointer -> (string_of_lltype (element_type ty)) ^ "*"
884 let s = "{ " ^ (concat2 ", " (
885 Array.map string_of_lltype (element_types ty)
890 | TypeKind.Array -> "[" ^ (string_of_int (array_length ty)) ^
891 " x " ^ (string_of_lltype (element_type ty)) ^ "]"
892 | TypeKind.Vector -> "<" ^ (string_of_int (vector_size ty)) ^
893 " x " ^ (string_of_lltype (element_type ty)) ^ ">"
894 | TypeKind.Opaque -> "opaque"
895 | TypeKind.Function -> string_of_lltype (return_type ty) ^
896 " (" ^ (concat2 ", " (
897 Array.map string_of_lltype (param_types ty)
899 | TypeKind.Label -> "label"
900 | TypeKind.Ppc_fp128 -> "ppc_fp128"
901 | TypeKind.Fp128 -> "fp128"
902 | TypeKind.X86fp80 -> "x86_fp80"
903 | TypeKind.Double -> "double"
904 | TypeKind.Float -> "float"
905 | TypeKind.Void -> "void"
906 | TypeKind.Metadata -> "metadata"