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
41 module Linkage = struct
44 | Available_externally
60 module Visibility = struct
67 module CallConv = struct
75 module Attribute = struct
134 exception IoError of string
136 external register_exns : exn -> unit = "llvm_register_core_exns"
137 let _ = register_exns (IoError "")
139 type ('a, 'b) llpos =
143 type ('a, 'b) llrev_pos =
147 (*===-- Contexts ----------------------------------------------------------===*)
148 external create_context : unit -> llcontext = "llvm_create_context"
149 external dispose_context : llcontext -> unit = "llvm_dispose_context"
150 external global_context : unit -> llcontext = "llvm_global_context"
151 external mdkind_id : llcontext -> string -> int = "llvm_mdkind_id"
153 (*===-- Modules -----------------------------------------------------------===*)
154 external create_module : llcontext -> string -> llmodule = "llvm_create_module"
155 external dispose_module : llmodule -> unit = "llvm_dispose_module"
156 external target_triple: llmodule -> string
157 = "llvm_target_triple"
158 external set_target_triple: string -> llmodule -> unit
159 = "llvm_set_target_triple"
160 external data_layout: llmodule -> string
162 external set_data_layout: string -> llmodule -> unit
163 = "llvm_set_data_layout"
164 external define_type_name : string -> lltype -> llmodule -> bool
165 = "llvm_add_type_name"
166 external delete_type_name : string -> llmodule -> unit
167 = "llvm_delete_type_name"
168 external type_by_name : llmodule -> string -> lltype option
169 = "llvm_type_by_name"
170 external dump_module : llmodule -> unit = "llvm_dump_module"
172 (*===-- Types -------------------------------------------------------------===*)
173 external classify_type : lltype -> TypeKind.t = "llvm_classify_type"
174 external type_context : lltype -> llcontext = "llvm_type_context"
176 (*--... Operations on integer types ........................................--*)
177 external i1_type : llcontext -> lltype = "llvm_i1_type"
178 external i8_type : llcontext -> lltype = "llvm_i8_type"
179 external i16_type : llcontext -> lltype = "llvm_i16_type"
180 external i32_type : llcontext -> lltype = "llvm_i32_type"
181 external i64_type : llcontext -> lltype = "llvm_i64_type"
183 external integer_type : llcontext -> int -> lltype = "llvm_integer_type"
184 external integer_bitwidth : lltype -> int = "llvm_integer_bitwidth"
186 (*--... Operations on real types ...........................................--*)
187 external float_type : llcontext -> lltype = "llvm_float_type"
188 external double_type : llcontext -> lltype = "llvm_double_type"
189 external x86fp80_type : llcontext -> lltype = "llvm_x86fp80_type"
190 external fp128_type : llcontext -> lltype = "llvm_fp128_type"
191 external ppc_fp128_type : llcontext -> lltype = "llvm_ppc_fp128_type"
193 (*--... Operations on function types .......................................--*)
194 external function_type : lltype -> lltype array -> lltype = "llvm_function_type"
195 external var_arg_function_type : lltype -> lltype array -> lltype
196 = "llvm_var_arg_function_type"
197 external is_var_arg : lltype -> bool = "llvm_is_var_arg"
198 external return_type : lltype -> lltype = "LLVMGetReturnType"
199 external param_types : lltype -> lltype array = "llvm_param_types"
201 (*--... Operations on struct types .........................................--*)
202 external struct_type : llcontext -> lltype array -> lltype = "llvm_struct_type"
203 external packed_struct_type : llcontext -> lltype array -> lltype
204 = "llvm_packed_struct_type"
205 external struct_element_types : lltype -> lltype array
206 = "llvm_struct_element_types"
207 external is_packed : lltype -> bool = "llvm_is_packed"
209 (*--... Operations on union types ..........................................--*)
210 external union_type : llcontext -> lltype array -> lltype = "llvm_union_type"
211 external union_element_types : lltype -> lltype array
212 = "llvm_union_element_types"
214 (*--... Operations on pointer, vector, and array types .....................--*)
215 external array_type : lltype -> int -> lltype = "llvm_array_type"
216 external pointer_type : lltype -> lltype = "llvm_pointer_type"
217 external qualified_pointer_type : lltype -> int -> lltype
218 = "llvm_qualified_pointer_type"
219 external vector_type : lltype -> int -> lltype = "llvm_vector_type"
221 external element_type : lltype -> lltype = "LLVMGetElementType"
222 external array_length : lltype -> int = "llvm_array_length"
223 external address_space : lltype -> int = "llvm_address_space"
224 external vector_size : lltype -> int = "llvm_vector_size"
226 (*--... Operations on other types ..........................................--*)
227 external opaque_type : llcontext -> lltype = "llvm_opaque_type"
228 external void_type : llcontext -> lltype = "llvm_void_type"
229 external label_type : llcontext -> lltype = "llvm_label_type"
231 (*--... Operations on type handles .........................................--*)
232 external handle_to_type : lltype -> lltypehandle = "llvm_handle_to_type"
233 external type_of_handle : lltypehandle -> lltype = "llvm_type_of_handle"
234 external refine_type : lltype -> lltype -> unit = "llvm_refine_type"
237 (*===-- Values ------------------------------------------------------------===*)
238 external type_of : llvalue -> lltype = "llvm_type_of"
239 external value_name : llvalue -> string = "llvm_value_name"
240 external set_value_name : string -> llvalue -> unit = "llvm_set_value_name"
241 external dump_value : llvalue -> unit = "llvm_dump_value"
242 external replace_all_uses_with : llvalue -> llvalue -> unit
243 = "LLVMReplaceAllUsesWith"
245 (*--... Operations on constants of (mostly) any type .......................--*)
246 external is_constant : llvalue -> bool = "llvm_is_constant"
247 external const_null : lltype -> llvalue = "LLVMConstNull"
248 external const_all_ones : (*int|vec*)lltype -> llvalue = "LLVMConstAllOnes"
249 external const_pointer_null : lltype -> llvalue = "LLVMConstPointerNull"
250 external undef : lltype -> llvalue = "LLVMGetUndef"
251 external is_null : llvalue -> bool = "llvm_is_null"
252 external is_undef : llvalue -> bool = "llvm_is_undef"
254 (*--... Operations on instructions .........................................--*)
255 external has_metadata : llvalue -> bool = "llvm_has_metadata"
256 external metadata : llvalue -> int -> llvalue option = "llvm_metadata"
257 external set_metadata : llvalue -> int -> llvalue -> unit = "llvm_set_metadata"
258 external clear_metadata : llvalue -> int -> unit = "llvm_clear_metadata"
260 (*--... Operations on metadata .......,.....................................--*)
261 external mdstring : llcontext -> string -> llvalue = "llvm_mdstring"
262 external mdnode : llcontext -> llvalue array -> llvalue = "llvm_mdnode"
264 (*--... Operations on scalar constants .....................................--*)
265 external const_int : lltype -> int -> llvalue = "llvm_const_int"
266 external const_of_int64 : lltype -> Int64.t -> bool -> llvalue
267 = "llvm_const_of_int64"
268 external const_int_of_string : lltype -> string -> int -> llvalue
269 = "llvm_const_int_of_string"
270 external const_float : lltype -> float -> llvalue = "llvm_const_float"
271 external const_float_of_string : lltype -> string -> llvalue
272 = "llvm_const_float_of_string"
274 (*--... Operations on composite constants ..................................--*)
275 external const_string : llcontext -> string -> llvalue = "llvm_const_string"
276 external const_stringz : llcontext -> string -> llvalue = "llvm_const_stringz"
277 external const_array : lltype -> llvalue array -> llvalue = "llvm_const_array"
278 external const_struct : llcontext -> llvalue array -> llvalue
279 = "llvm_const_struct"
280 external const_packed_struct : llcontext -> llvalue array -> llvalue
281 = "llvm_const_packed_struct"
282 external const_vector : llvalue array -> llvalue = "llvm_const_vector"
283 external const_union : lltype -> llvalue -> llvalue = "LLVMConstUnion"
285 (*--... Constant expressions ...............................................--*)
286 external align_of : lltype -> llvalue = "LLVMAlignOf"
287 external size_of : lltype -> llvalue = "LLVMSizeOf"
288 external const_neg : llvalue -> llvalue = "LLVMConstNeg"
289 external const_nsw_neg : llvalue -> llvalue = "LLVMConstNSWNeg"
290 external const_nuw_neg : llvalue -> llvalue = "LLVMConstNUWNeg"
291 external const_fneg : llvalue -> llvalue = "LLVMConstFNeg"
292 external const_not : llvalue -> llvalue = "LLVMConstNot"
293 external const_add : llvalue -> llvalue -> llvalue = "LLVMConstAdd"
294 external const_nsw_add : llvalue -> llvalue -> llvalue = "LLVMConstNSWAdd"
295 external const_nuw_add : llvalue -> llvalue -> llvalue = "LLVMConstNUWAdd"
296 external const_fadd : llvalue -> llvalue -> llvalue = "LLVMConstFAdd"
297 external const_sub : llvalue -> llvalue -> llvalue = "LLVMConstSub"
298 external const_nsw_sub : llvalue -> llvalue -> llvalue = "LLVMConstNSWSub"
299 external const_nuw_sub : llvalue -> llvalue -> llvalue = "LLVMConstNUWSub"
300 external const_fsub : llvalue -> llvalue -> llvalue = "LLVMConstFSub"
301 external const_mul : llvalue -> llvalue -> llvalue = "LLVMConstMul"
302 external const_nsw_mul : llvalue -> llvalue -> llvalue = "LLVMConstNSWMul"
303 external const_nuw_mul : llvalue -> llvalue -> llvalue = "LLVMConstNUWMul"
304 external const_fmul : llvalue -> llvalue -> llvalue = "LLVMConstFMul"
305 external const_udiv : llvalue -> llvalue -> llvalue = "LLVMConstUDiv"
306 external const_sdiv : llvalue -> llvalue -> llvalue = "LLVMConstSDiv"
307 external const_exact_sdiv : llvalue -> llvalue -> llvalue = "LLVMConstExactSDiv"
308 external const_fdiv : llvalue -> llvalue -> llvalue = "LLVMConstFDiv"
309 external const_urem : llvalue -> llvalue -> llvalue = "LLVMConstURem"
310 external const_srem : llvalue -> llvalue -> llvalue = "LLVMConstSRem"
311 external const_frem : llvalue -> llvalue -> llvalue = "LLVMConstFRem"
312 external const_and : llvalue -> llvalue -> llvalue = "LLVMConstAnd"
313 external const_or : llvalue -> llvalue -> llvalue = "LLVMConstOr"
314 external const_xor : llvalue -> llvalue -> llvalue = "LLVMConstXor"
315 external const_icmp : Icmp.t -> llvalue -> llvalue -> llvalue
317 external const_fcmp : Fcmp.t -> llvalue -> llvalue -> llvalue
319 external const_shl : llvalue -> llvalue -> llvalue = "LLVMConstShl"
320 external const_lshr : llvalue -> llvalue -> llvalue = "LLVMConstLShr"
321 external const_ashr : llvalue -> llvalue -> llvalue = "LLVMConstAShr"
322 external const_gep : llvalue -> llvalue array -> llvalue = "llvm_const_gep"
323 external const_in_bounds_gep : llvalue -> llvalue array -> llvalue
324 = "llvm_const_in_bounds_gep"
325 external const_trunc : llvalue -> lltype -> llvalue = "LLVMConstTrunc"
326 external const_sext : llvalue -> lltype -> llvalue = "LLVMConstSExt"
327 external const_zext : llvalue -> lltype -> llvalue = "LLVMConstZExt"
328 external const_fptrunc : llvalue -> lltype -> llvalue = "LLVMConstFPTrunc"
329 external const_fpext : llvalue -> lltype -> llvalue = "LLVMConstFPExt"
330 external const_uitofp : llvalue -> lltype -> llvalue = "LLVMConstUIToFP"
331 external const_sitofp : llvalue -> lltype -> llvalue = "LLVMConstSIToFP"
332 external const_fptoui : llvalue -> lltype -> llvalue = "LLVMConstFPToUI"
333 external const_fptosi : llvalue -> lltype -> llvalue = "LLVMConstFPToSI"
334 external const_ptrtoint : llvalue -> lltype -> llvalue = "LLVMConstPtrToInt"
335 external const_inttoptr : llvalue -> lltype -> llvalue = "LLVMConstIntToPtr"
336 external const_bitcast : llvalue -> lltype -> llvalue = "LLVMConstBitCast"
337 external const_zext_or_bitcast : llvalue -> lltype -> llvalue
338 = "LLVMConstZExtOrBitCast"
339 external const_sext_or_bitcast : llvalue -> lltype -> llvalue
340 = "LLVMConstSExtOrBitCast"
341 external const_trunc_or_bitcast : llvalue -> lltype -> llvalue
342 = "LLVMConstTruncOrBitCast"
343 external const_pointercast : llvalue -> lltype -> llvalue
344 = "LLVMConstPointerCast"
345 external const_intcast : llvalue -> lltype -> llvalue = "LLVMConstIntCast"
346 external const_fpcast : llvalue -> lltype -> llvalue = "LLVMConstFPCast"
347 external const_select : llvalue -> llvalue -> llvalue -> llvalue
349 external const_extractelement : llvalue -> llvalue -> llvalue
350 = "LLVMConstExtractElement"
351 external const_insertelement : llvalue -> llvalue -> llvalue -> llvalue
352 = "LLVMConstInsertElement"
353 external const_shufflevector : llvalue -> llvalue -> llvalue -> llvalue
354 = "LLVMConstShuffleVector"
355 external const_extractvalue : llvalue -> int array -> llvalue
356 = "llvm_const_extractvalue"
357 external const_insertvalue : llvalue -> llvalue -> int array -> llvalue
358 = "llvm_const_insertvalue"
359 external const_inline_asm : lltype -> string -> string -> bool -> bool ->
361 = "llvm_const_inline_asm"
362 external block_address : llvalue -> llbasicblock -> llvalue = "LLVMBlockAddress"
364 (*--... Operations on global variables, functions, and aliases (globals) ...--*)
365 external global_parent : llvalue -> llmodule = "LLVMGetGlobalParent"
366 external is_declaration : llvalue -> bool = "llvm_is_declaration"
367 external linkage : llvalue -> Linkage.t = "llvm_linkage"
368 external set_linkage : Linkage.t -> llvalue -> unit = "llvm_set_linkage"
369 external section : llvalue -> string = "llvm_section"
370 external set_section : string -> llvalue -> unit = "llvm_set_section"
371 external visibility : llvalue -> Visibility.t = "llvm_visibility"
372 external set_visibility : Visibility.t -> llvalue -> unit = "llvm_set_visibility"
373 external alignment : llvalue -> int = "llvm_alignment"
374 external set_alignment : int -> llvalue -> unit = "llvm_set_alignment"
375 external is_global_constant : llvalue -> bool = "llvm_is_global_constant"
376 external set_global_constant : bool -> llvalue -> unit
377 = "llvm_set_global_constant"
379 (*--... Operations on global variables .....................................--*)
380 external declare_global : lltype -> string -> llmodule -> llvalue
381 = "llvm_declare_global"
382 external declare_qualified_global : lltype -> string -> int -> llmodule ->
384 = "llvm_declare_qualified_global"
385 external define_global : string -> llvalue -> llmodule -> llvalue
386 = "llvm_define_global"
387 external define_qualified_global : string -> llvalue -> int -> llmodule ->
389 = "llvm_define_qualified_global"
390 external lookup_global : string -> llmodule -> llvalue option
391 = "llvm_lookup_global"
392 external delete_global : llvalue -> unit = "llvm_delete_global"
393 external global_initializer : llvalue -> llvalue = "LLVMGetInitializer"
394 external set_initializer : llvalue -> llvalue -> unit = "llvm_set_initializer"
395 external remove_initializer : llvalue -> unit = "llvm_remove_initializer"
396 external is_thread_local : llvalue -> bool = "llvm_is_thread_local"
397 external set_thread_local : bool -> llvalue -> unit = "llvm_set_thread_local"
398 external global_begin : llmodule -> (llmodule, llvalue) llpos
399 = "llvm_global_begin"
400 external global_succ : llvalue -> (llmodule, llvalue) llpos
402 external global_end : llmodule -> (llmodule, llvalue) llrev_pos
404 external global_pred : llvalue -> (llmodule, llvalue) llrev_pos
407 let rec iter_global_range f i e =
408 if i = e then () else
410 | At_end _ -> raise (Invalid_argument "Invalid global variable range.")
413 iter_global_range f (global_succ bb) e
415 let iter_globals f m =
416 iter_global_range f (global_begin m) (At_end m)
418 let rec fold_left_global_range f init i e =
419 if i = e then init else
421 | At_end _ -> raise (Invalid_argument "Invalid global variable range.")
422 | Before bb -> fold_left_global_range f (f init bb) (global_succ bb) e
424 let fold_left_globals f init m =
425 fold_left_global_range f init (global_begin m) (At_end m)
427 let rec rev_iter_global_range f i e =
428 if i = e then () else
430 | At_start _ -> raise (Invalid_argument "Invalid global variable range.")
433 rev_iter_global_range f (global_pred bb) e
435 let rev_iter_globals f m =
436 rev_iter_global_range f (global_end m) (At_start m)
438 let rec fold_right_global_range f i e init =
439 if i = e then init else
441 | At_start _ -> raise (Invalid_argument "Invalid global variable range.")
442 | After bb -> fold_right_global_range f (global_pred bb) e (f bb init)
444 let fold_right_globals f m init =
445 fold_right_global_range f (global_end m) (At_start m) init
447 (*--... Operations on aliases ..............................................--*)
448 external add_alias : llmodule -> lltype -> llvalue -> string -> llvalue
451 (*--... Operations on functions ............................................--*)
452 external declare_function : string -> lltype -> llmodule -> llvalue
453 = "llvm_declare_function"
454 external define_function : string -> lltype -> llmodule -> llvalue
455 = "llvm_define_function"
456 external lookup_function : string -> llmodule -> llvalue option
457 = "llvm_lookup_function"
458 external delete_function : llvalue -> unit = "llvm_delete_function"
459 external is_intrinsic : llvalue -> bool = "llvm_is_intrinsic"
460 external function_call_conv : llvalue -> int = "llvm_function_call_conv"
461 external set_function_call_conv : int -> llvalue -> unit
462 = "llvm_set_function_call_conv"
463 external gc : llvalue -> string option = "llvm_gc"
464 external set_gc : string option -> llvalue -> unit = "llvm_set_gc"
465 external function_begin : llmodule -> (llmodule, llvalue) llpos
466 = "llvm_function_begin"
467 external function_succ : llvalue -> (llmodule, llvalue) llpos
468 = "llvm_function_succ"
469 external function_end : llmodule -> (llmodule, llvalue) llrev_pos
470 = "llvm_function_end"
471 external function_pred : llvalue -> (llmodule, llvalue) llrev_pos
472 = "llvm_function_pred"
474 let rec iter_function_range f i e =
475 if i = e then () else
477 | At_end _ -> raise (Invalid_argument "Invalid function range.")
480 iter_function_range f (function_succ fn) e
482 let iter_functions f m =
483 iter_function_range f (function_begin m) (At_end m)
485 let rec fold_left_function_range f init i e =
486 if i = e then init else
488 | At_end _ -> raise (Invalid_argument "Invalid function range.")
489 | Before fn -> fold_left_function_range f (f init fn) (function_succ fn) e
491 let fold_left_functions f init m =
492 fold_left_function_range f init (function_begin m) (At_end m)
494 let rec rev_iter_function_range f i e =
495 if i = e then () else
497 | At_start _ -> raise (Invalid_argument "Invalid function range.")
500 rev_iter_function_range f (function_pred fn) e
502 let rev_iter_functions f m =
503 rev_iter_function_range f (function_end m) (At_start m)
505 let rec fold_right_function_range f i e init =
506 if i = e then init else
508 | At_start _ -> raise (Invalid_argument "Invalid function range.")
509 | After fn -> fold_right_function_range f (function_pred fn) e (f fn init)
511 let fold_right_functions f m init =
512 fold_right_function_range f (function_end m) (At_start m) init
514 external add_function_attr : llvalue -> Attribute.t -> unit
515 = "llvm_add_function_attr"
516 external remove_function_attr : llvalue -> Attribute.t -> unit
517 = "llvm_remove_function_attr"
519 (*--... Operations on params ...............................................--*)
520 external params : llvalue -> llvalue array = "llvm_params"
521 external param : llvalue -> int -> llvalue = "llvm_param"
522 external param_parent : llvalue -> llvalue = "LLVMGetParamParent"
523 external param_begin : llvalue -> (llvalue, llvalue) llpos = "llvm_param_begin"
524 external param_succ : llvalue -> (llvalue, llvalue) llpos = "llvm_param_succ"
525 external param_end : llvalue -> (llvalue, llvalue) llrev_pos = "llvm_param_end"
526 external param_pred : llvalue -> (llvalue, llvalue) llrev_pos ="llvm_param_pred"
528 let rec iter_param_range f i e =
529 if i = e then () else
531 | At_end _ -> raise (Invalid_argument "Invalid parameter range.")
534 iter_param_range f (param_succ p) e
536 let iter_params f fn =
537 iter_param_range f (param_begin fn) (At_end fn)
539 let rec fold_left_param_range f init i e =
540 if i = e then init else
542 | At_end _ -> raise (Invalid_argument "Invalid parameter range.")
543 | Before p -> fold_left_param_range f (f init p) (param_succ p) e
545 let fold_left_params f init fn =
546 fold_left_param_range f init (param_begin fn) (At_end fn)
548 let rec rev_iter_param_range f i e =
549 if i = e then () else
551 | At_start _ -> raise (Invalid_argument "Invalid parameter range.")
554 rev_iter_param_range f (param_pred p) e
556 let rev_iter_params f fn =
557 rev_iter_param_range f (param_end fn) (At_start fn)
559 let rec fold_right_param_range f init i e =
560 if i = e then init else
562 | At_start _ -> raise (Invalid_argument "Invalid parameter range.")
563 | After p -> fold_right_param_range f (f p init) (param_pred p) e
565 let fold_right_params f fn init =
566 fold_right_param_range f init (param_end fn) (At_start fn)
568 external add_param_attr : llvalue -> Attribute.t -> unit
569 = "llvm_add_param_attr"
570 external remove_param_attr : llvalue -> Attribute.t -> unit
571 = "llvm_remove_param_attr"
572 external set_param_alignment : llvalue -> int -> unit
573 = "llvm_set_param_alignment"
575 (*--... Operations on basic blocks .........................................--*)
576 external value_of_block : llbasicblock -> llvalue = "LLVMBasicBlockAsValue"
577 external value_is_block : llvalue -> bool = "llvm_value_is_block"
578 external block_of_value : llvalue -> llbasicblock = "LLVMValueAsBasicBlock"
579 external block_parent : llbasicblock -> llvalue = "LLVMGetBasicBlockParent"
580 external basic_blocks : llvalue -> llbasicblock array = "llvm_basic_blocks"
581 external entry_block : llvalue -> llbasicblock = "LLVMGetEntryBasicBlock"
582 external delete_block : llbasicblock -> unit = "llvm_delete_block"
583 external append_block : llcontext -> string -> llvalue -> llbasicblock
584 = "llvm_append_block"
585 external insert_block : llcontext -> string -> llbasicblock -> llbasicblock
586 = "llvm_insert_block"
587 external block_begin : llvalue -> (llvalue, llbasicblock) llpos
589 external block_succ : llbasicblock -> (llvalue, llbasicblock) llpos
591 external block_end : llvalue -> (llvalue, llbasicblock) llrev_pos
593 external block_pred : llbasicblock -> (llvalue, llbasicblock) llrev_pos
596 let rec iter_block_range f i e =
597 if i = e then () else
599 | At_end _ -> raise (Invalid_argument "Invalid block range.")
602 iter_block_range f (block_succ bb) e
604 let iter_blocks f fn =
605 iter_block_range f (block_begin fn) (At_end fn)
607 let rec fold_left_block_range f init i e =
608 if i = e then init else
610 | At_end _ -> raise (Invalid_argument "Invalid block range.")
611 | Before bb -> fold_left_block_range f (f init bb) (block_succ bb) e
613 let fold_left_blocks f init fn =
614 fold_left_block_range f init (block_begin fn) (At_end fn)
616 let rec rev_iter_block_range f i e =
617 if i = e then () else
619 | At_start _ -> raise (Invalid_argument "Invalid block range.")
622 rev_iter_block_range f (block_pred bb) e
624 let rev_iter_blocks f fn =
625 rev_iter_block_range f (block_end fn) (At_start fn)
627 let rec fold_right_block_range f init i e =
628 if i = e then init else
630 | At_start _ -> raise (Invalid_argument "Invalid block range.")
631 | After bb -> fold_right_block_range f (f bb init) (block_pred bb) e
633 let fold_right_blocks f fn init =
634 fold_right_block_range f init (block_end fn) (At_start fn)
636 (*--... Operations on instructions .........................................--*)
637 external instr_parent : llvalue -> llbasicblock = "LLVMGetInstructionParent"
638 external instr_begin : llbasicblock -> (llbasicblock, llvalue) llpos
640 external instr_succ : llvalue -> (llbasicblock, llvalue) llpos
642 external instr_end : llbasicblock -> (llbasicblock, llvalue) llrev_pos
644 external instr_pred : llvalue -> (llbasicblock, llvalue) llrev_pos
647 let rec iter_instrs_range f i e =
648 if i = e then () else
650 | At_end _ -> raise (Invalid_argument "Invalid instruction range.")
653 iter_instrs_range f (instr_succ i) e
655 let iter_instrs f bb =
656 iter_instrs_range f (instr_begin bb) (At_end bb)
658 let rec fold_left_instrs_range f init i e =
659 if i = e then init else
661 | At_end _ -> raise (Invalid_argument "Invalid instruction range.")
662 | Before i -> fold_left_instrs_range f (f init i) (instr_succ i) e
664 let fold_left_instrs f init bb =
665 fold_left_instrs_range f init (instr_begin bb) (At_end bb)
667 let rec rev_iter_instrs_range f i e =
668 if i = e then () else
670 | At_start _ -> raise (Invalid_argument "Invalid instruction range.")
673 rev_iter_instrs_range f (instr_pred i) e
675 let rev_iter_instrs f bb =
676 rev_iter_instrs_range f (instr_end bb) (At_start bb)
678 let rec fold_right_instr_range f i e init =
679 if i = e then init else
681 | At_start _ -> raise (Invalid_argument "Invalid instruction range.")
682 | After i -> fold_right_instr_range f (instr_pred i) e (f i init)
684 let fold_right_instrs f bb init =
685 fold_right_instr_range f (instr_end bb) (At_start bb) init
688 (*--... Operations on call sites ...........................................--*)
689 external instruction_call_conv: llvalue -> int
690 = "llvm_instruction_call_conv"
691 external set_instruction_call_conv: int -> llvalue -> unit
692 = "llvm_set_instruction_call_conv"
693 external add_instruction_param_attr : llvalue -> int -> Attribute.t -> unit
694 = "llvm_add_instruction_param_attr"
695 external remove_instruction_param_attr : llvalue -> int -> Attribute.t -> unit
696 = "llvm_remove_instruction_param_attr"
698 (*--... Operations on call instructions (only) .............................--*)
699 external is_tail_call : llvalue -> bool = "llvm_is_tail_call"
700 external set_tail_call : bool -> llvalue -> unit = "llvm_set_tail_call"
702 (*--... Operations on phi nodes ............................................--*)
703 external add_incoming : (llvalue * llbasicblock) -> llvalue -> unit
704 = "llvm_add_incoming"
705 external incoming : llvalue -> (llvalue * llbasicblock) list = "llvm_incoming"
708 (*===-- Instruction builders ----------------------------------------------===*)
709 external builder : llcontext -> llbuilder = "llvm_builder"
710 external position_builder : (llbasicblock, llvalue) llpos -> llbuilder -> unit
711 = "llvm_position_builder"
712 external insertion_block : llbuilder -> llbasicblock = "llvm_insertion_block"
713 external insert_into_builder : llvalue -> string -> llbuilder -> unit
714 = "llvm_insert_into_builder"
716 let builder_at context ip =
717 let b = builder context in
718 position_builder ip b;
721 let builder_before context i = builder_at context (Before i)
722 let builder_at_end context bb = builder_at context (At_end bb)
724 let position_before i = position_builder (Before i)
725 let position_at_end bb = position_builder (At_end bb)
728 (*--... Metadata ...........................................................--*)
729 external set_current_debug_location : llbuilder -> llvalue -> unit
730 = "llvm_set_current_debug_location"
731 external clear_current_debug_location : llbuilder -> unit
732 = "llvm_clear_current_debug_location"
733 external current_debug_location : llbuilder -> llvalue option
734 = "llvm_current_debug_location"
735 external set_inst_debug_location : llbuilder -> llvalue -> unit
736 = "llvm_set_inst_debug_location"
739 (*--... Terminators ........................................................--*)
740 external build_ret_void : llbuilder -> llvalue = "llvm_build_ret_void"
741 external build_ret : llvalue -> llbuilder -> llvalue = "llvm_build_ret"
742 external build_aggregate_ret : llvalue array -> llbuilder -> llvalue
743 = "llvm_build_aggregate_ret"
744 external build_br : llbasicblock -> llbuilder -> llvalue = "llvm_build_br"
745 external build_cond_br : llvalue -> llbasicblock -> llbasicblock -> llbuilder ->
746 llvalue = "llvm_build_cond_br"
747 external build_switch : llvalue -> llbasicblock -> int -> llbuilder -> llvalue
748 = "llvm_build_switch"
749 external add_case : llvalue -> llvalue -> llbasicblock -> unit
751 external build_indirect_br : llvalue -> int -> llbuilder -> llvalue
752 = "llvm_build_indirect_br"
753 external add_destination : llvalue -> llbasicblock -> unit
754 = "llvm_add_destination"
755 external build_invoke : llvalue -> llvalue array -> llbasicblock ->
756 llbasicblock -> string -> llbuilder -> llvalue
757 = "llvm_build_invoke_bc" "llvm_build_invoke_nat"
758 external build_unwind : llbuilder -> llvalue = "llvm_build_unwind"
759 external build_unreachable : llbuilder -> llvalue = "llvm_build_unreachable"
761 (*--... Arithmetic .........................................................--*)
762 external build_add : llvalue -> llvalue -> string -> llbuilder -> llvalue
764 external build_nsw_add : llvalue -> llvalue -> string -> llbuilder -> llvalue
765 = "llvm_build_nsw_add"
766 external build_nuw_add : llvalue -> llvalue -> string -> llbuilder -> llvalue
767 = "llvm_build_nuw_add"
768 external build_fadd : llvalue -> llvalue -> string -> llbuilder -> llvalue
770 external build_sub : llvalue -> llvalue -> string -> llbuilder -> llvalue
772 external build_nsw_sub : llvalue -> llvalue -> string -> llbuilder -> llvalue
773 = "llvm_build_nsw_sub"
774 external build_nuw_sub : llvalue -> llvalue -> string -> llbuilder -> llvalue
775 = "llvm_build_nuw_sub"
776 external build_fsub : llvalue -> llvalue -> string -> llbuilder -> llvalue
778 external build_mul : llvalue -> llvalue -> string -> llbuilder -> llvalue
780 external build_nsw_mul : llvalue -> llvalue -> string -> llbuilder -> llvalue
781 = "llvm_build_nsw_mul"
782 external build_nuw_mul : llvalue -> llvalue -> string -> llbuilder -> llvalue
783 = "llvm_build_nuw_mul"
784 external build_fmul : llvalue -> llvalue -> string -> llbuilder -> llvalue
786 external build_udiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
788 external build_sdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
790 external build_exact_sdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
791 = "llvm_build_exact_sdiv"
792 external build_fdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
794 external build_urem : llvalue -> llvalue -> string -> llbuilder -> llvalue
796 external build_srem : llvalue -> llvalue -> string -> llbuilder -> llvalue
798 external build_frem : llvalue -> llvalue -> string -> llbuilder -> llvalue
800 external build_shl : llvalue -> llvalue -> string -> llbuilder -> llvalue
802 external build_lshr : llvalue -> llvalue -> string -> llbuilder -> llvalue
804 external build_ashr : llvalue -> llvalue -> string -> llbuilder -> llvalue
806 external build_and : llvalue -> llvalue -> string -> llbuilder -> llvalue
808 external build_or : llvalue -> llvalue -> string -> llbuilder -> llvalue
810 external build_xor : llvalue -> llvalue -> string -> llbuilder -> llvalue
812 external build_neg : llvalue -> string -> llbuilder -> llvalue
814 external build_nsw_neg : llvalue -> string -> llbuilder -> llvalue
815 = "llvm_build_nsw_neg"
816 external build_nuw_neg : llvalue -> string -> llbuilder -> llvalue
817 = "llvm_build_nuw_neg"
818 external build_fneg : llvalue -> string -> llbuilder -> llvalue
820 external build_not : llvalue -> string -> llbuilder -> llvalue
823 (*--... Memory .............................................................--*)
824 external build_alloca : lltype -> string -> llbuilder -> llvalue
825 = "llvm_build_alloca"
826 external build_array_alloca : lltype -> llvalue -> string -> llbuilder ->
827 llvalue = "llvm_build_array_alloca"
828 external build_load : llvalue -> string -> llbuilder -> llvalue
830 external build_store : llvalue -> llvalue -> llbuilder -> llvalue
832 external build_gep : llvalue -> llvalue array -> string -> llbuilder -> llvalue
834 external build_in_bounds_gep : llvalue -> llvalue array -> string ->
835 llbuilder -> llvalue = "llvm_build_in_bounds_gep"
836 external build_struct_gep : llvalue -> int -> string -> llbuilder -> llvalue
837 = "llvm_build_struct_gep"
839 external build_global_string : string -> string -> llbuilder -> llvalue
840 = "llvm_build_global_string"
841 external build_global_stringptr : string -> string -> llbuilder -> llvalue
842 = "llvm_build_global_stringptr"
844 (*--... Casts ..............................................................--*)
845 external build_trunc : llvalue -> lltype -> string -> llbuilder -> llvalue
847 external build_zext : llvalue -> lltype -> string -> llbuilder -> llvalue
849 external build_sext : llvalue -> lltype -> string -> llbuilder -> llvalue
851 external build_fptoui : llvalue -> lltype -> string -> llbuilder -> llvalue
852 = "llvm_build_fptoui"
853 external build_fptosi : llvalue -> lltype -> string -> llbuilder -> llvalue
854 = "llvm_build_fptosi"
855 external build_uitofp : llvalue -> lltype -> string -> llbuilder -> llvalue
856 = "llvm_build_uitofp"
857 external build_sitofp : llvalue -> lltype -> string -> llbuilder -> llvalue
858 = "llvm_build_sitofp"
859 external build_fptrunc : llvalue -> lltype -> string -> llbuilder -> llvalue
860 = "llvm_build_fptrunc"
861 external build_fpext : llvalue -> lltype -> string -> llbuilder -> llvalue
863 external build_ptrtoint : llvalue -> lltype -> string -> llbuilder -> llvalue
864 = "llvm_build_prttoint"
865 external build_inttoptr : llvalue -> lltype -> string -> llbuilder -> llvalue
866 = "llvm_build_inttoptr"
867 external build_bitcast : llvalue -> lltype -> string -> llbuilder -> llvalue
868 = "llvm_build_bitcast"
869 external build_zext_or_bitcast : llvalue -> lltype -> string -> llbuilder ->
870 llvalue = "llvm_build_zext_or_bitcast"
871 external build_sext_or_bitcast : llvalue -> lltype -> string -> llbuilder ->
872 llvalue = "llvm_build_sext_or_bitcast"
873 external build_trunc_or_bitcast : llvalue -> lltype -> string -> llbuilder ->
874 llvalue = "llvm_build_trunc_or_bitcast"
875 external build_pointercast : llvalue -> lltype -> string -> llbuilder -> llvalue
876 = "llvm_build_pointercast"
877 external build_intcast : llvalue -> lltype -> string -> llbuilder -> llvalue
878 = "llvm_build_intcast"
879 external build_fpcast : llvalue -> lltype -> string -> llbuilder -> llvalue
880 = "llvm_build_fpcast"
882 (*--... Comparisons ........................................................--*)
883 external build_icmp : Icmp.t -> llvalue -> llvalue -> string ->
884 llbuilder -> llvalue = "llvm_build_icmp"
885 external build_fcmp : Fcmp.t -> llvalue -> llvalue -> string ->
886 llbuilder -> llvalue = "llvm_build_fcmp"
888 (*--... Miscellaneous instructions .........................................--*)
889 external build_phi : (llvalue * llbasicblock) list -> string -> llbuilder ->
890 llvalue = "llvm_build_phi"
891 external build_call : llvalue -> llvalue array -> string -> llbuilder -> llvalue
893 external build_select : llvalue -> llvalue -> llvalue -> string -> llbuilder ->
894 llvalue = "llvm_build_select"
895 external build_va_arg : llvalue -> lltype -> string -> llbuilder -> llvalue
896 = "llvm_build_va_arg"
897 external build_extractelement : llvalue -> llvalue -> string -> llbuilder ->
898 llvalue = "llvm_build_extractelement"
899 external build_insertelement : llvalue -> llvalue -> llvalue -> string ->
900 llbuilder -> llvalue = "llvm_build_insertelement"
901 external build_shufflevector : llvalue -> llvalue -> llvalue -> string ->
902 llbuilder -> llvalue = "llvm_build_shufflevector"
903 external build_extractvalue : llvalue -> int -> string -> llbuilder -> llvalue
904 = "llvm_build_extractvalue"
905 external build_insertvalue : llvalue -> llvalue -> int -> string -> llbuilder ->
906 llvalue = "llvm_build_insertvalue"
908 external build_is_null : llvalue -> string -> llbuilder -> llvalue
909 = "llvm_build_is_null"
910 external build_is_not_null : llvalue -> string -> llbuilder -> llvalue
911 = "llvm_build_is_not_null"
912 external build_ptrdiff : llvalue -> llvalue -> string -> llbuilder -> llvalue
913 = "llvm_build_ptrdiff"
915 (*===-- Module providers --------------------------------------------------===*)
917 module ModuleProvider = struct
918 external create : llmodule -> llmoduleprovider
919 = "LLVMCreateModuleProviderForExistingModule"
920 external dispose : llmoduleprovider -> unit = "llvm_dispose_module_provider"
924 (*===-- Memory buffers ----------------------------------------------------===*)
926 module MemoryBuffer = struct
927 external of_file : string -> llmemorybuffer = "llvm_memorybuffer_of_file"
928 external of_stdin : unit -> llmemorybuffer = "llvm_memorybuffer_of_stdin"
929 external dispose : llmemorybuffer -> unit = "llvm_memorybuffer_dispose"
933 (*===-- Pass Manager ------------------------------------------------------===*)
935 module PassManager = struct
937 type any = [ `Module | `Function ]
938 external create : unit -> [ `Module ] t = "llvm_passmanager_create"
939 external create_function : llmoduleprovider -> [ `Function ] t
940 = "LLVMCreateFunctionPassManager"
941 external run_module : llmodule -> [ `Module ] t -> bool
942 = "llvm_passmanager_run_module"
943 external initialize : [ `Function ] t -> bool = "llvm_passmanager_initialize"
944 external run_function : llvalue -> [ `Function ] t -> bool
945 = "llvm_passmanager_run_function"
946 external finalize : [ `Function ] t -> bool = "llvm_passmanager_finalize"
947 external dispose : [< any ] t -> unit = "llvm_passmanager_dispose"
951 (*===-- Non-Externs -------------------------------------------------------===*)
952 (* These functions are built using the externals, so must be declared late. *)
954 let concat2 sep arr =
956 if 0 < Array.length arr then begin
958 for i = 1 to (Array.length arr) - 1 do
959 s := !s ^ sep ^ arr.(i)
964 let rec string_of_lltype ty =
965 (* FIXME: stop infinite recursion! :) *)
966 match classify_type ty with
967 TypeKind.Integer -> "i" ^ string_of_int (integer_bitwidth ty)
968 | TypeKind.Pointer -> (string_of_lltype (element_type ty)) ^ "*"
970 let s = "{ " ^ (concat2 ", " (
971 Array.map string_of_lltype (struct_element_types ty)
976 | TypeKind.Union -> "union { " ^ (concat2 ", " (
977 Array.map string_of_lltype (union_element_types ty)
979 | TypeKind.Array -> "[" ^ (string_of_int (array_length ty)) ^
980 " x " ^ (string_of_lltype (element_type ty)) ^ "]"
981 | TypeKind.Vector -> "<" ^ (string_of_int (vector_size ty)) ^
982 " x " ^ (string_of_lltype (element_type ty)) ^ ">"
983 | TypeKind.Opaque -> "opaque"
984 | TypeKind.Function -> string_of_lltype (return_type ty) ^
985 " (" ^ (concat2 ", " (
986 Array.map string_of_lltype (param_types ty)
988 | TypeKind.Label -> "label"
989 | TypeKind.Ppc_fp128 -> "ppc_fp128"
990 | TypeKind.Fp128 -> "fp128"
991 | TypeKind.X86fp80 -> "x86_fp80"
992 | TypeKind.Double -> "double"
993 | TypeKind.Float -> "float"
994 | TypeKind.Void -> "void"
995 | TypeKind.Metadata -> "metadata"