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
38 module Linkage = struct
41 | Available_externally
57 module Visibility = struct
64 module CallConv = struct
72 module Attribute = struct
96 | Stackalignment of int
133 exception IoError of string
135 external register_exns : exn -> unit = "llvm_register_core_exns"
136 let _ = register_exns (IoError "")
138 type ('a, 'b) llpos =
142 type ('a, 'b) llrev_pos =
146 (*===-- Contexts ----------------------------------------------------------===*)
147 external create_context : unit -> llcontext = "llvm_create_context"
148 external dispose_context : llcontext -> unit = "llvm_dispose_context"
149 external global_context : unit -> llcontext = "llvm_global_context"
150 external mdkind_id : llcontext -> string -> int = "llvm_mdkind_id"
152 (*===-- Modules -----------------------------------------------------------===*)
153 external create_module : llcontext -> string -> llmodule = "llvm_create_module"
154 external dispose_module : llmodule -> unit = "llvm_dispose_module"
155 external target_triple: llmodule -> string
156 = "llvm_target_triple"
157 external set_target_triple: string -> llmodule -> unit
158 = "llvm_set_target_triple"
159 external data_layout: llmodule -> string
161 external set_data_layout: string -> llmodule -> unit
162 = "llvm_set_data_layout"
163 external dump_module : llmodule -> unit = "llvm_dump_module"
164 external set_module_inline_asm : llmodule -> string -> unit
165 = "llvm_set_module_inline_asm"
167 (*===-- Types -------------------------------------------------------------===*)
168 external classify_type : lltype -> TypeKind.t = "llvm_classify_type"
169 external type_context : lltype -> llcontext = "llvm_type_context"
171 (*--... Operations on integer types ........................................--*)
172 external i1_type : llcontext -> lltype = "llvm_i1_type"
173 external i8_type : llcontext -> lltype = "llvm_i8_type"
174 external i16_type : llcontext -> lltype = "llvm_i16_type"
175 external i32_type : llcontext -> lltype = "llvm_i32_type"
176 external i64_type : llcontext -> lltype = "llvm_i64_type"
178 external integer_type : llcontext -> int -> lltype = "llvm_integer_type"
179 external integer_bitwidth : lltype -> int = "llvm_integer_bitwidth"
181 (*--... Operations on real types ...........................................--*)
182 external float_type : llcontext -> lltype = "llvm_float_type"
183 external double_type : llcontext -> lltype = "llvm_double_type"
184 external x86fp80_type : llcontext -> lltype = "llvm_x86fp80_type"
185 external fp128_type : llcontext -> lltype = "llvm_fp128_type"
186 external ppc_fp128_type : llcontext -> lltype = "llvm_ppc_fp128_type"
188 (*--... Operations on function types .......................................--*)
189 external function_type : lltype -> lltype array -> lltype = "llvm_function_type"
190 external var_arg_function_type : lltype -> lltype array -> lltype
191 = "llvm_var_arg_function_type"
192 external is_var_arg : lltype -> bool = "llvm_is_var_arg"
193 external return_type : lltype -> lltype = "LLVMGetReturnType"
194 external param_types : lltype -> lltype array = "llvm_param_types"
196 (*--... Operations on struct types .........................................--*)
197 external struct_type : llcontext -> lltype array -> lltype = "llvm_struct_type"
198 external packed_struct_type : llcontext -> lltype array -> lltype
199 = "llvm_packed_struct_type"
200 external struct_element_types : lltype -> lltype array
201 = "llvm_struct_element_types"
202 external is_packed : lltype -> bool = "llvm_is_packed"
204 (*--... Operations on pointer, vector, and array types .....................--*)
205 external array_type : lltype -> int -> lltype = "llvm_array_type"
206 external pointer_type : lltype -> lltype = "llvm_pointer_type"
207 external qualified_pointer_type : lltype -> int -> lltype
208 = "llvm_qualified_pointer_type"
209 external vector_type : lltype -> int -> lltype = "llvm_vector_type"
211 external element_type : lltype -> lltype = "LLVMGetElementType"
212 external array_length : lltype -> int = "llvm_array_length"
213 external address_space : lltype -> int = "llvm_address_space"
214 external vector_size : lltype -> int = "llvm_vector_size"
216 (*--... Operations on other types ..........................................--*)
217 external void_type : llcontext -> lltype = "llvm_void_type"
218 external label_type : llcontext -> lltype = "llvm_label_type"
220 (*===-- Values ------------------------------------------------------------===*)
221 external type_of : llvalue -> lltype = "llvm_type_of"
222 external value_name : llvalue -> string = "llvm_value_name"
223 external set_value_name : string -> llvalue -> unit = "llvm_set_value_name"
224 external dump_value : llvalue -> unit = "llvm_dump_value"
225 external replace_all_uses_with : llvalue -> llvalue -> unit
226 = "LLVMReplaceAllUsesWith"
228 (*--... Operations on uses .................................................--*)
229 external use_begin : llvalue -> lluse option = "llvm_use_begin"
230 external use_succ : lluse -> lluse option = "llvm_use_succ"
231 external user : lluse -> llvalue = "llvm_user"
232 external used_value : lluse -> llvalue = "llvm_used_value"
235 let rec aux = function
243 let fold_left_uses f init v =
247 | Some u -> aux (f init u) (use_succ u)
249 aux init (use_begin v)
251 let fold_right_uses f v init =
255 | Some u -> f u (aux (use_succ u) init)
257 aux (use_begin v) init
260 (*--... Operations on users ................................................--*)
261 external operand : llvalue -> int -> llvalue = "llvm_operand"
262 external set_operand : llvalue -> int -> llvalue -> unit = "llvm_set_operand"
263 external num_operands : llvalue -> int = "llvm_num_operands"
265 (*--... Operations on constants of (mostly) any type .......................--*)
266 external is_constant : llvalue -> bool = "llvm_is_constant"
267 external const_null : lltype -> llvalue = "LLVMConstNull"
268 external const_all_ones : (*int|vec*)lltype -> llvalue = "LLVMConstAllOnes"
269 external const_pointer_null : lltype -> llvalue = "LLVMConstPointerNull"
270 external undef : lltype -> llvalue = "LLVMGetUndef"
271 external is_null : llvalue -> bool = "llvm_is_null"
272 external is_undef : llvalue -> bool = "llvm_is_undef"
274 (*--... Operations on instructions .........................................--*)
275 external has_metadata : llvalue -> bool = "llvm_has_metadata"
276 external metadata : llvalue -> int -> llvalue option = "llvm_metadata"
277 external set_metadata : llvalue -> int -> llvalue -> unit = "llvm_set_metadata"
278 external clear_metadata : llvalue -> int -> unit = "llvm_clear_metadata"
280 (*--... Operations on metadata .......,.....................................--*)
281 external mdstring : llcontext -> string -> llvalue = "llvm_mdstring"
282 external mdnode : llcontext -> llvalue array -> llvalue = "llvm_mdnode"
284 (*--... Operations on scalar constants .....................................--*)
285 external const_int : lltype -> int -> llvalue = "llvm_const_int"
286 external const_of_int64 : lltype -> Int64.t -> bool -> llvalue
287 = "llvm_const_of_int64"
288 external const_int_of_string : lltype -> string -> int -> llvalue
289 = "llvm_const_int_of_string"
290 external const_float : lltype -> float -> llvalue = "llvm_const_float"
291 external const_float_of_string : lltype -> string -> llvalue
292 = "llvm_const_float_of_string"
294 (*--... Operations on composite constants ..................................--*)
295 external const_string : llcontext -> string -> llvalue = "llvm_const_string"
296 external const_stringz : llcontext -> string -> llvalue = "llvm_const_stringz"
297 external const_array : lltype -> llvalue array -> llvalue = "llvm_const_array"
298 external const_struct : llcontext -> llvalue array -> llvalue
299 = "llvm_const_struct"
300 external const_packed_struct : llcontext -> llvalue array -> llvalue
301 = "llvm_const_packed_struct"
302 external const_vector : llvalue array -> llvalue = "llvm_const_vector"
304 (*--... Constant expressions ...............................................--*)
305 external align_of : lltype -> llvalue = "LLVMAlignOf"
306 external size_of : lltype -> llvalue = "LLVMSizeOf"
307 external const_neg : llvalue -> llvalue = "LLVMConstNeg"
308 external const_nsw_neg : llvalue -> llvalue = "LLVMConstNSWNeg"
309 external const_nuw_neg : llvalue -> llvalue = "LLVMConstNUWNeg"
310 external const_fneg : llvalue -> llvalue = "LLVMConstFNeg"
311 external const_not : llvalue -> llvalue = "LLVMConstNot"
312 external const_add : llvalue -> llvalue -> llvalue = "LLVMConstAdd"
313 external const_nsw_add : llvalue -> llvalue -> llvalue = "LLVMConstNSWAdd"
314 external const_nuw_add : llvalue -> llvalue -> llvalue = "LLVMConstNUWAdd"
315 external const_fadd : llvalue -> llvalue -> llvalue = "LLVMConstFAdd"
316 external const_sub : llvalue -> llvalue -> llvalue = "LLVMConstSub"
317 external const_nsw_sub : llvalue -> llvalue -> llvalue = "LLVMConstNSWSub"
318 external const_nuw_sub : llvalue -> llvalue -> llvalue = "LLVMConstNUWSub"
319 external const_fsub : llvalue -> llvalue -> llvalue = "LLVMConstFSub"
320 external const_mul : llvalue -> llvalue -> llvalue = "LLVMConstMul"
321 external const_nsw_mul : llvalue -> llvalue -> llvalue = "LLVMConstNSWMul"
322 external const_nuw_mul : llvalue -> llvalue -> llvalue = "LLVMConstNUWMul"
323 external const_fmul : llvalue -> llvalue -> llvalue = "LLVMConstFMul"
324 external const_udiv : llvalue -> llvalue -> llvalue = "LLVMConstUDiv"
325 external const_sdiv : llvalue -> llvalue -> llvalue = "LLVMConstSDiv"
326 external const_exact_sdiv : llvalue -> llvalue -> llvalue = "LLVMConstExactSDiv"
327 external const_fdiv : llvalue -> llvalue -> llvalue = "LLVMConstFDiv"
328 external const_urem : llvalue -> llvalue -> llvalue = "LLVMConstURem"
329 external const_srem : llvalue -> llvalue -> llvalue = "LLVMConstSRem"
330 external const_frem : llvalue -> llvalue -> llvalue = "LLVMConstFRem"
331 external const_and : llvalue -> llvalue -> llvalue = "LLVMConstAnd"
332 external const_or : llvalue -> llvalue -> llvalue = "LLVMConstOr"
333 external const_xor : llvalue -> llvalue -> llvalue = "LLVMConstXor"
334 external const_icmp : Icmp.t -> llvalue -> llvalue -> llvalue
336 external const_fcmp : Fcmp.t -> llvalue -> llvalue -> llvalue
338 external const_shl : llvalue -> llvalue -> llvalue = "LLVMConstShl"
339 external const_lshr : llvalue -> llvalue -> llvalue = "LLVMConstLShr"
340 external const_ashr : llvalue -> llvalue -> llvalue = "LLVMConstAShr"
341 external const_gep : llvalue -> llvalue array -> llvalue = "llvm_const_gep"
342 external const_in_bounds_gep : llvalue -> llvalue array -> llvalue
343 = "llvm_const_in_bounds_gep"
344 external const_trunc : llvalue -> lltype -> llvalue = "LLVMConstTrunc"
345 external const_sext : llvalue -> lltype -> llvalue = "LLVMConstSExt"
346 external const_zext : llvalue -> lltype -> llvalue = "LLVMConstZExt"
347 external const_fptrunc : llvalue -> lltype -> llvalue = "LLVMConstFPTrunc"
348 external const_fpext : llvalue -> lltype -> llvalue = "LLVMConstFPExt"
349 external const_uitofp : llvalue -> lltype -> llvalue = "LLVMConstUIToFP"
350 external const_sitofp : llvalue -> lltype -> llvalue = "LLVMConstSIToFP"
351 external const_fptoui : llvalue -> lltype -> llvalue = "LLVMConstFPToUI"
352 external const_fptosi : llvalue -> lltype -> llvalue = "LLVMConstFPToSI"
353 external const_ptrtoint : llvalue -> lltype -> llvalue = "LLVMConstPtrToInt"
354 external const_inttoptr : llvalue -> lltype -> llvalue = "LLVMConstIntToPtr"
355 external const_bitcast : llvalue -> lltype -> llvalue = "LLVMConstBitCast"
356 external const_zext_or_bitcast : llvalue -> lltype -> llvalue
357 = "LLVMConstZExtOrBitCast"
358 external const_sext_or_bitcast : llvalue -> lltype -> llvalue
359 = "LLVMConstSExtOrBitCast"
360 external const_trunc_or_bitcast : llvalue -> lltype -> llvalue
361 = "LLVMConstTruncOrBitCast"
362 external const_pointercast : llvalue -> lltype -> llvalue
363 = "LLVMConstPointerCast"
364 external const_intcast : llvalue -> lltype -> llvalue = "LLVMConstIntCast"
365 external const_fpcast : llvalue -> lltype -> llvalue = "LLVMConstFPCast"
366 external const_select : llvalue -> llvalue -> llvalue -> llvalue
368 external const_extractelement : llvalue -> llvalue -> llvalue
369 = "LLVMConstExtractElement"
370 external const_insertelement : llvalue -> llvalue -> llvalue -> llvalue
371 = "LLVMConstInsertElement"
372 external const_shufflevector : llvalue -> llvalue -> llvalue -> llvalue
373 = "LLVMConstShuffleVector"
374 external const_extractvalue : llvalue -> int array -> llvalue
375 = "llvm_const_extractvalue"
376 external const_insertvalue : llvalue -> llvalue -> int array -> llvalue
377 = "llvm_const_insertvalue"
378 external const_inline_asm : lltype -> string -> string -> bool -> bool ->
380 = "llvm_const_inline_asm"
381 external block_address : llvalue -> llbasicblock -> llvalue = "LLVMBlockAddress"
383 (*--... Operations on global variables, functions, and aliases (globals) ...--*)
384 external global_parent : llvalue -> llmodule = "LLVMGetGlobalParent"
385 external is_declaration : llvalue -> bool = "llvm_is_declaration"
386 external linkage : llvalue -> Linkage.t = "llvm_linkage"
387 external set_linkage : Linkage.t -> llvalue -> unit = "llvm_set_linkage"
388 external section : llvalue -> string = "llvm_section"
389 external set_section : string -> llvalue -> unit = "llvm_set_section"
390 external visibility : llvalue -> Visibility.t = "llvm_visibility"
391 external set_visibility : Visibility.t -> llvalue -> unit = "llvm_set_visibility"
392 external alignment : llvalue -> int = "llvm_alignment"
393 external set_alignment : int -> llvalue -> unit = "llvm_set_alignment"
394 external is_global_constant : llvalue -> bool = "llvm_is_global_constant"
395 external set_global_constant : bool -> llvalue -> unit
396 = "llvm_set_global_constant"
398 (*--... Operations on global variables .....................................--*)
399 external declare_global : lltype -> string -> llmodule -> llvalue
400 = "llvm_declare_global"
401 external declare_qualified_global : lltype -> string -> int -> llmodule ->
403 = "llvm_declare_qualified_global"
404 external define_global : string -> llvalue -> llmodule -> llvalue
405 = "llvm_define_global"
406 external define_qualified_global : string -> llvalue -> int -> llmodule ->
408 = "llvm_define_qualified_global"
409 external lookup_global : string -> llmodule -> llvalue option
410 = "llvm_lookup_global"
411 external delete_global : llvalue -> unit = "llvm_delete_global"
412 external global_initializer : llvalue -> llvalue = "LLVMGetInitializer"
413 external set_initializer : llvalue -> llvalue -> unit = "llvm_set_initializer"
414 external remove_initializer : llvalue -> unit = "llvm_remove_initializer"
415 external is_thread_local : llvalue -> bool = "llvm_is_thread_local"
416 external set_thread_local : bool -> llvalue -> unit = "llvm_set_thread_local"
417 external global_begin : llmodule -> (llmodule, llvalue) llpos
418 = "llvm_global_begin"
419 external global_succ : llvalue -> (llmodule, llvalue) llpos
421 external global_end : llmodule -> (llmodule, llvalue) llrev_pos
423 external global_pred : llvalue -> (llmodule, llvalue) llrev_pos
426 let rec iter_global_range f i e =
427 if i = e then () else
429 | At_end _ -> raise (Invalid_argument "Invalid global variable range.")
432 iter_global_range f (global_succ bb) e
434 let iter_globals f m =
435 iter_global_range f (global_begin m) (At_end m)
437 let rec fold_left_global_range f init i e =
438 if i = e then init else
440 | At_end _ -> raise (Invalid_argument "Invalid global variable range.")
441 | Before bb -> fold_left_global_range f (f init bb) (global_succ bb) e
443 let fold_left_globals f init m =
444 fold_left_global_range f init (global_begin m) (At_end m)
446 let rec rev_iter_global_range f i e =
447 if i = e then () else
449 | At_start _ -> raise (Invalid_argument "Invalid global variable range.")
452 rev_iter_global_range f (global_pred bb) e
454 let rev_iter_globals f m =
455 rev_iter_global_range f (global_end m) (At_start m)
457 let rec fold_right_global_range f i e init =
458 if i = e then init else
460 | At_start _ -> raise (Invalid_argument "Invalid global variable range.")
461 | After bb -> fold_right_global_range f (global_pred bb) e (f bb init)
463 let fold_right_globals f m init =
464 fold_right_global_range f (global_end m) (At_start m) init
466 (*--... Operations on aliases ..............................................--*)
467 external add_alias : llmodule -> lltype -> llvalue -> string -> llvalue
470 (*--... Operations on functions ............................................--*)
471 external declare_function : string -> lltype -> llmodule -> llvalue
472 = "llvm_declare_function"
473 external define_function : string -> lltype -> llmodule -> llvalue
474 = "llvm_define_function"
475 external lookup_function : string -> llmodule -> llvalue option
476 = "llvm_lookup_function"
477 external delete_function : llvalue -> unit = "llvm_delete_function"
478 external is_intrinsic : llvalue -> bool = "llvm_is_intrinsic"
479 external function_call_conv : llvalue -> int = "llvm_function_call_conv"
480 external set_function_call_conv : int -> llvalue -> unit
481 = "llvm_set_function_call_conv"
482 external gc : llvalue -> string option = "llvm_gc"
483 external set_gc : string option -> llvalue -> unit = "llvm_set_gc"
484 external function_begin : llmodule -> (llmodule, llvalue) llpos
485 = "llvm_function_begin"
486 external function_succ : llvalue -> (llmodule, llvalue) llpos
487 = "llvm_function_succ"
488 external function_end : llmodule -> (llmodule, llvalue) llrev_pos
489 = "llvm_function_end"
490 external function_pred : llvalue -> (llmodule, llvalue) llrev_pos
491 = "llvm_function_pred"
493 let rec iter_function_range f i e =
494 if i = e then () else
496 | At_end _ -> raise (Invalid_argument "Invalid function range.")
499 iter_function_range f (function_succ fn) e
501 let iter_functions f m =
502 iter_function_range f (function_begin m) (At_end m)
504 let rec fold_left_function_range f init i e =
505 if i = e then init else
507 | At_end _ -> raise (Invalid_argument "Invalid function range.")
508 | Before fn -> fold_left_function_range f (f init fn) (function_succ fn) e
510 let fold_left_functions f init m =
511 fold_left_function_range f init (function_begin m) (At_end m)
513 let rec rev_iter_function_range f i e =
514 if i = e then () else
516 | At_start _ -> raise (Invalid_argument "Invalid function range.")
519 rev_iter_function_range f (function_pred fn) e
521 let rev_iter_functions f m =
522 rev_iter_function_range f (function_end m) (At_start m)
524 let rec fold_right_function_range f i e init =
525 if i = e then init else
527 | At_start _ -> raise (Invalid_argument "Invalid function range.")
528 | After fn -> fold_right_function_range f (function_pred fn) e (f fn init)
530 let fold_right_functions f m init =
531 fold_right_function_range f (function_end m) (At_start m) init
533 external llvm_add_function_attr : llvalue -> int -> unit
534 = "llvm_add_function_attr"
535 external llvm_remove_function_attr : llvalue -> int -> unit
536 = "llvm_remove_function_attr"
538 let pack_attr (attr:Attribute.t) : int =
540 Attribute.Zext -> 1 lsl 0
541 | Attribute.Sext -> 1 lsl 1
542 | Attribute.Noreturn -> 1 lsl 2
543 | Attribute.Inreg -> 1 lsl 3
544 | Attribute.Structret -> 1 lsl 4
545 | Attribute.Nounwind -> 1 lsl 5
546 | Attribute.Noalias -> 1 lsl 6
547 | Attribute.Byval -> 1 lsl 7
548 | Attribute.Nest -> 1 lsl 8
549 | Attribute.Readnone -> 1 lsl 9
550 | Attribute.Readonly -> 1 lsl 10
551 | Attribute.Noinline -> 1 lsl 11
552 | Attribute.Alwaysinline -> 1 lsl 12
553 | Attribute.Optsize -> 1 lsl 13
554 | Attribute.Ssp -> 1 lsl 14
555 | Attribute.Sspreq -> 1 lsl 15
556 | Attribute.Alignment n -> n lsl 16
557 | Attribute.Nocapture -> 1 lsl 21
558 | Attribute.Noredzone -> 1 lsl 22
559 | Attribute.Noimplicitfloat -> 1 lsl 23
560 | Attribute.Naked -> 1 lsl 24
561 | Attribute.Inlinehint -> 1 lsl 25
562 | Attribute.Stackalignment n -> n lsl 26
564 let add_function_attr llval attr =
565 llvm_add_function_attr llval (pack_attr attr)
567 let remove_function_attr llval attr =
568 llvm_remove_function_attr llval (pack_attr attr)
570 (*--... Operations on params ...............................................--*)
571 external params : llvalue -> llvalue array = "llvm_params"
572 external param : llvalue -> int -> llvalue = "llvm_param"
573 external param_parent : llvalue -> llvalue = "LLVMGetParamParent"
574 external param_begin : llvalue -> (llvalue, llvalue) llpos = "llvm_param_begin"
575 external param_succ : llvalue -> (llvalue, llvalue) llpos = "llvm_param_succ"
576 external param_end : llvalue -> (llvalue, llvalue) llrev_pos = "llvm_param_end"
577 external param_pred : llvalue -> (llvalue, llvalue) llrev_pos ="llvm_param_pred"
579 let rec iter_param_range f i e =
580 if i = e then () else
582 | At_end _ -> raise (Invalid_argument "Invalid parameter range.")
585 iter_param_range f (param_succ p) e
587 let iter_params f fn =
588 iter_param_range f (param_begin fn) (At_end fn)
590 let rec fold_left_param_range f init i e =
591 if i = e then init else
593 | At_end _ -> raise (Invalid_argument "Invalid parameter range.")
594 | Before p -> fold_left_param_range f (f init p) (param_succ p) e
596 let fold_left_params f init fn =
597 fold_left_param_range f init (param_begin fn) (At_end fn)
599 let rec rev_iter_param_range f i e =
600 if i = e then () else
602 | At_start _ -> raise (Invalid_argument "Invalid parameter range.")
605 rev_iter_param_range f (param_pred p) e
607 let rev_iter_params f fn =
608 rev_iter_param_range f (param_end fn) (At_start fn)
610 let rec fold_right_param_range f init i e =
611 if i = e then init else
613 | At_start _ -> raise (Invalid_argument "Invalid parameter range.")
614 | After p -> fold_right_param_range f (f p init) (param_pred p) e
616 let fold_right_params f fn init =
617 fold_right_param_range f init (param_end fn) (At_start fn)
619 external llvm_add_param_attr : llvalue -> int -> unit
620 = "llvm_add_param_attr"
621 external llvm_remove_param_attr : llvalue -> int -> unit
622 = "llvm_remove_param_attr"
624 let add_param_attr llval attr =
625 llvm_add_param_attr llval (pack_attr attr)
627 let remove_param_attr llval attr =
628 llvm_remove_param_attr llval (pack_attr attr)
630 external set_param_alignment : llvalue -> int -> unit
631 = "llvm_set_param_alignment"
633 (*--... Operations on basic blocks .........................................--*)
634 external value_of_block : llbasicblock -> llvalue = "LLVMBasicBlockAsValue"
635 external value_is_block : llvalue -> bool = "llvm_value_is_block"
636 external block_of_value : llvalue -> llbasicblock = "LLVMValueAsBasicBlock"
637 external block_parent : llbasicblock -> llvalue = "LLVMGetBasicBlockParent"
638 external basic_blocks : llvalue -> llbasicblock array = "llvm_basic_blocks"
639 external entry_block : llvalue -> llbasicblock = "LLVMGetEntryBasicBlock"
640 external delete_block : llbasicblock -> unit = "llvm_delete_block"
641 external append_block : llcontext -> string -> llvalue -> llbasicblock
642 = "llvm_append_block"
643 external insert_block : llcontext -> string -> llbasicblock -> llbasicblock
644 = "llvm_insert_block"
645 external block_begin : llvalue -> (llvalue, llbasicblock) llpos
647 external block_succ : llbasicblock -> (llvalue, llbasicblock) llpos
649 external block_end : llvalue -> (llvalue, llbasicblock) llrev_pos
651 external block_pred : llbasicblock -> (llvalue, llbasicblock) llrev_pos
654 let rec iter_block_range f i e =
655 if i = e then () else
657 | At_end _ -> raise (Invalid_argument "Invalid block range.")
660 iter_block_range f (block_succ bb) e
662 let iter_blocks f fn =
663 iter_block_range f (block_begin fn) (At_end fn)
665 let rec fold_left_block_range f init i e =
666 if i = e then init else
668 | At_end _ -> raise (Invalid_argument "Invalid block range.")
669 | Before bb -> fold_left_block_range f (f init bb) (block_succ bb) e
671 let fold_left_blocks f init fn =
672 fold_left_block_range f init (block_begin fn) (At_end fn)
674 let rec rev_iter_block_range f i e =
675 if i = e then () else
677 | At_start _ -> raise (Invalid_argument "Invalid block range.")
680 rev_iter_block_range f (block_pred bb) e
682 let rev_iter_blocks f fn =
683 rev_iter_block_range f (block_end fn) (At_start fn)
685 let rec fold_right_block_range f init i e =
686 if i = e then init else
688 | At_start _ -> raise (Invalid_argument "Invalid block range.")
689 | After bb -> fold_right_block_range f (f bb init) (block_pred bb) e
691 let fold_right_blocks f fn init =
692 fold_right_block_range f init (block_end fn) (At_start fn)
694 (*--... Operations on instructions .........................................--*)
695 external instr_parent : llvalue -> llbasicblock = "LLVMGetInstructionParent"
696 external instr_begin : llbasicblock -> (llbasicblock, llvalue) llpos
698 external instr_succ : llvalue -> (llbasicblock, llvalue) llpos
700 external instr_end : llbasicblock -> (llbasicblock, llvalue) llrev_pos
702 external instr_pred : llvalue -> (llbasicblock, llvalue) llrev_pos
705 let rec iter_instrs_range f i e =
706 if i = e then () else
708 | At_end _ -> raise (Invalid_argument "Invalid instruction range.")
711 iter_instrs_range f (instr_succ i) e
713 let iter_instrs f bb =
714 iter_instrs_range f (instr_begin bb) (At_end bb)
716 let rec fold_left_instrs_range f init i e =
717 if i = e then init else
719 | At_end _ -> raise (Invalid_argument "Invalid instruction range.")
720 | Before i -> fold_left_instrs_range f (f init i) (instr_succ i) e
722 let fold_left_instrs f init bb =
723 fold_left_instrs_range f init (instr_begin bb) (At_end bb)
725 let rec rev_iter_instrs_range f i e =
726 if i = e then () else
728 | At_start _ -> raise (Invalid_argument "Invalid instruction range.")
731 rev_iter_instrs_range f (instr_pred i) e
733 let rev_iter_instrs f bb =
734 rev_iter_instrs_range f (instr_end bb) (At_start bb)
736 let rec fold_right_instr_range f i e init =
737 if i = e then init else
739 | At_start _ -> raise (Invalid_argument "Invalid instruction range.")
740 | After i -> fold_right_instr_range f (instr_pred i) e (f i init)
742 let fold_right_instrs f bb init =
743 fold_right_instr_range f (instr_end bb) (At_start bb) init
746 (*--... Operations on call sites ...........................................--*)
747 external instruction_call_conv: llvalue -> int
748 = "llvm_instruction_call_conv"
749 external set_instruction_call_conv: int -> llvalue -> unit
750 = "llvm_set_instruction_call_conv"
752 external llvm_add_instruction_param_attr : llvalue -> int -> int -> unit
753 = "llvm_add_instruction_param_attr"
754 external llvm_remove_instruction_param_attr : llvalue -> int -> int -> unit
755 = "llvm_remove_instruction_param_attr"
757 let add_instruction_param_attr llval i attr =
758 llvm_add_instruction_param_attr llval i (pack_attr attr)
760 let remove_instruction_param_attr llval i attr =
761 llvm_remove_instruction_param_attr llval i (pack_attr attr)
763 (*--... Operations on call instructions (only) .............................--*)
764 external is_tail_call : llvalue -> bool = "llvm_is_tail_call"
765 external set_tail_call : bool -> llvalue -> unit = "llvm_set_tail_call"
767 (*--... Operations on phi nodes ............................................--*)
768 external add_incoming : (llvalue * llbasicblock) -> llvalue -> unit
769 = "llvm_add_incoming"
770 external incoming : llvalue -> (llvalue * llbasicblock) list = "llvm_incoming"
773 (*===-- Instruction builders ----------------------------------------------===*)
774 external builder : llcontext -> llbuilder = "llvm_builder"
775 external position_builder : (llbasicblock, llvalue) llpos -> llbuilder -> unit
776 = "llvm_position_builder"
777 external insertion_block : llbuilder -> llbasicblock = "llvm_insertion_block"
778 external insert_into_builder : llvalue -> string -> llbuilder -> unit
779 = "llvm_insert_into_builder"
781 let builder_at context ip =
782 let b = builder context in
783 position_builder ip b;
786 let builder_before context i = builder_at context (Before i)
787 let builder_at_end context bb = builder_at context (At_end bb)
789 let position_before i = position_builder (Before i)
790 let position_at_end bb = position_builder (At_end bb)
793 (*--... Metadata ...........................................................--*)
794 external set_current_debug_location : llbuilder -> llvalue -> unit
795 = "llvm_set_current_debug_location"
796 external clear_current_debug_location : llbuilder -> unit
797 = "llvm_clear_current_debug_location"
798 external current_debug_location : llbuilder -> llvalue option
799 = "llvm_current_debug_location"
800 external set_inst_debug_location : llbuilder -> llvalue -> unit
801 = "llvm_set_inst_debug_location"
804 (*--... Terminators ........................................................--*)
805 external build_ret_void : llbuilder -> llvalue = "llvm_build_ret_void"
806 external build_ret : llvalue -> llbuilder -> llvalue = "llvm_build_ret"
807 external build_aggregate_ret : llvalue array -> llbuilder -> llvalue
808 = "llvm_build_aggregate_ret"
809 external build_br : llbasicblock -> llbuilder -> llvalue = "llvm_build_br"
810 external build_cond_br : llvalue -> llbasicblock -> llbasicblock -> llbuilder ->
811 llvalue = "llvm_build_cond_br"
812 external build_switch : llvalue -> llbasicblock -> int -> llbuilder -> llvalue
813 = "llvm_build_switch"
814 external add_case : llvalue -> llvalue -> llbasicblock -> unit
816 external build_indirect_br : llvalue -> int -> llbuilder -> llvalue
817 = "llvm_build_indirect_br"
818 external add_destination : llvalue -> llbasicblock -> unit
819 = "llvm_add_destination"
820 external build_invoke : llvalue -> llvalue array -> llbasicblock ->
821 llbasicblock -> string -> llbuilder -> llvalue
822 = "llvm_build_invoke_bc" "llvm_build_invoke_nat"
823 external build_landingpad : lltype -> llvalue -> int -> string -> llbuilder ->
824 llvalue = "llvm_build_landingpad"
825 external set_cleanup : llvalue -> bool -> unit = "llvm_set_cleanup"
826 external build_unreachable : llbuilder -> llvalue = "llvm_build_unreachable"
828 (*--... Arithmetic .........................................................--*)
829 external build_add : llvalue -> llvalue -> string -> llbuilder -> llvalue
831 external build_nsw_add : llvalue -> llvalue -> string -> llbuilder -> llvalue
832 = "llvm_build_nsw_add"
833 external build_nuw_add : llvalue -> llvalue -> string -> llbuilder -> llvalue
834 = "llvm_build_nuw_add"
835 external build_fadd : llvalue -> llvalue -> string -> llbuilder -> llvalue
837 external build_sub : llvalue -> llvalue -> string -> llbuilder -> llvalue
839 external build_nsw_sub : llvalue -> llvalue -> string -> llbuilder -> llvalue
840 = "llvm_build_nsw_sub"
841 external build_nuw_sub : llvalue -> llvalue -> string -> llbuilder -> llvalue
842 = "llvm_build_nuw_sub"
843 external build_fsub : llvalue -> llvalue -> string -> llbuilder -> llvalue
845 external build_mul : llvalue -> llvalue -> string -> llbuilder -> llvalue
847 external build_nsw_mul : llvalue -> llvalue -> string -> llbuilder -> llvalue
848 = "llvm_build_nsw_mul"
849 external build_nuw_mul : llvalue -> llvalue -> string -> llbuilder -> llvalue
850 = "llvm_build_nuw_mul"
851 external build_fmul : llvalue -> llvalue -> string -> llbuilder -> llvalue
853 external build_udiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
855 external build_sdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
857 external build_exact_sdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
858 = "llvm_build_exact_sdiv"
859 external build_fdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
861 external build_urem : llvalue -> llvalue -> string -> llbuilder -> llvalue
863 external build_srem : llvalue -> llvalue -> string -> llbuilder -> llvalue
865 external build_frem : llvalue -> llvalue -> string -> llbuilder -> llvalue
867 external build_shl : llvalue -> llvalue -> string -> llbuilder -> llvalue
869 external build_lshr : llvalue -> llvalue -> string -> llbuilder -> llvalue
871 external build_ashr : llvalue -> llvalue -> string -> llbuilder -> llvalue
873 external build_and : llvalue -> llvalue -> string -> llbuilder -> llvalue
875 external build_or : llvalue -> llvalue -> string -> llbuilder -> llvalue
877 external build_xor : llvalue -> llvalue -> string -> llbuilder -> llvalue
879 external build_neg : llvalue -> string -> llbuilder -> llvalue
881 external build_nsw_neg : llvalue -> string -> llbuilder -> llvalue
882 = "llvm_build_nsw_neg"
883 external build_nuw_neg : llvalue -> string -> llbuilder -> llvalue
884 = "llvm_build_nuw_neg"
885 external build_fneg : llvalue -> string -> llbuilder -> llvalue
887 external build_not : llvalue -> string -> llbuilder -> llvalue
890 (*--... Memory .............................................................--*)
891 external build_alloca : lltype -> string -> llbuilder -> llvalue
892 = "llvm_build_alloca"
893 external build_array_alloca : lltype -> llvalue -> string -> llbuilder ->
894 llvalue = "llvm_build_array_alloca"
895 external build_load : llvalue -> string -> llbuilder -> llvalue
897 external build_store : llvalue -> llvalue -> llbuilder -> llvalue
899 external build_gep : llvalue -> llvalue array -> string -> llbuilder -> llvalue
901 external build_in_bounds_gep : llvalue -> llvalue array -> string ->
902 llbuilder -> llvalue = "llvm_build_in_bounds_gep"
903 external build_struct_gep : llvalue -> int -> string -> llbuilder -> llvalue
904 = "llvm_build_struct_gep"
906 external build_global_string : string -> string -> llbuilder -> llvalue
907 = "llvm_build_global_string"
908 external build_global_stringptr : string -> string -> llbuilder -> llvalue
909 = "llvm_build_global_stringptr"
911 (*--... Casts ..............................................................--*)
912 external build_trunc : llvalue -> lltype -> string -> llbuilder -> llvalue
914 external build_zext : llvalue -> lltype -> string -> llbuilder -> llvalue
916 external build_sext : llvalue -> lltype -> string -> llbuilder -> llvalue
918 external build_fptoui : llvalue -> lltype -> string -> llbuilder -> llvalue
919 = "llvm_build_fptoui"
920 external build_fptosi : llvalue -> lltype -> string -> llbuilder -> llvalue
921 = "llvm_build_fptosi"
922 external build_uitofp : llvalue -> lltype -> string -> llbuilder -> llvalue
923 = "llvm_build_uitofp"
924 external build_sitofp : llvalue -> lltype -> string -> llbuilder -> llvalue
925 = "llvm_build_sitofp"
926 external build_fptrunc : llvalue -> lltype -> string -> llbuilder -> llvalue
927 = "llvm_build_fptrunc"
928 external build_fpext : llvalue -> lltype -> string -> llbuilder -> llvalue
930 external build_ptrtoint : llvalue -> lltype -> string -> llbuilder -> llvalue
931 = "llvm_build_prttoint"
932 external build_inttoptr : llvalue -> lltype -> string -> llbuilder -> llvalue
933 = "llvm_build_inttoptr"
934 external build_bitcast : llvalue -> lltype -> string -> llbuilder -> llvalue
935 = "llvm_build_bitcast"
936 external build_zext_or_bitcast : llvalue -> lltype -> string -> llbuilder ->
937 llvalue = "llvm_build_zext_or_bitcast"
938 external build_sext_or_bitcast : llvalue -> lltype -> string -> llbuilder ->
939 llvalue = "llvm_build_sext_or_bitcast"
940 external build_trunc_or_bitcast : llvalue -> lltype -> string -> llbuilder ->
941 llvalue = "llvm_build_trunc_or_bitcast"
942 external build_pointercast : llvalue -> lltype -> string -> llbuilder -> llvalue
943 = "llvm_build_pointercast"
944 external build_intcast : llvalue -> lltype -> string -> llbuilder -> llvalue
945 = "llvm_build_intcast"
946 external build_fpcast : llvalue -> lltype -> string -> llbuilder -> llvalue
947 = "llvm_build_fpcast"
949 (*--... Comparisons ........................................................--*)
950 external build_icmp : Icmp.t -> llvalue -> llvalue -> string ->
951 llbuilder -> llvalue = "llvm_build_icmp"
952 external build_fcmp : Fcmp.t -> llvalue -> llvalue -> string ->
953 llbuilder -> llvalue = "llvm_build_fcmp"
955 (*--... Miscellaneous instructions .........................................--*)
956 external build_phi : (llvalue * llbasicblock) list -> string -> llbuilder ->
957 llvalue = "llvm_build_phi"
958 external build_call : llvalue -> llvalue array -> string -> llbuilder -> llvalue
960 external build_select : llvalue -> llvalue -> llvalue -> string -> llbuilder ->
961 llvalue = "llvm_build_select"
962 external build_va_arg : llvalue -> lltype -> string -> llbuilder -> llvalue
963 = "llvm_build_va_arg"
964 external build_extractelement : llvalue -> llvalue -> string -> llbuilder ->
965 llvalue = "llvm_build_extractelement"
966 external build_insertelement : llvalue -> llvalue -> llvalue -> string ->
967 llbuilder -> llvalue = "llvm_build_insertelement"
968 external build_shufflevector : llvalue -> llvalue -> llvalue -> string ->
969 llbuilder -> llvalue = "llvm_build_shufflevector"
970 external build_extractvalue : llvalue -> int -> string -> llbuilder -> llvalue
971 = "llvm_build_extractvalue"
972 external build_insertvalue : llvalue -> llvalue -> int -> string -> llbuilder ->
973 llvalue = "llvm_build_insertvalue"
975 external build_is_null : llvalue -> string -> llbuilder -> llvalue
976 = "llvm_build_is_null"
977 external build_is_not_null : llvalue -> string -> llbuilder -> llvalue
978 = "llvm_build_is_not_null"
979 external build_ptrdiff : llvalue -> llvalue -> string -> llbuilder -> llvalue
980 = "llvm_build_ptrdiff"
983 (*===-- Memory buffers ----------------------------------------------------===*)
985 module MemoryBuffer = struct
986 external of_file : string -> llmemorybuffer = "llvm_memorybuffer_of_file"
987 external of_stdin : unit -> llmemorybuffer = "llvm_memorybuffer_of_stdin"
988 external dispose : llmemorybuffer -> unit = "llvm_memorybuffer_dispose"
992 (*===-- Pass Manager ------------------------------------------------------===*)
994 module PassManager = struct
996 type any = [ `Module | `Function ]
997 external create : unit -> [ `Module ] t = "llvm_passmanager_create"
998 external create_function : llmodule -> [ `Function ] t
999 = "LLVMCreateFunctionPassManager"
1000 external run_module : llmodule -> [ `Module ] t -> bool
1001 = "llvm_passmanager_run_module"
1002 external initialize : [ `Function ] t -> bool = "llvm_passmanager_initialize"
1003 external run_function : llvalue -> [ `Function ] t -> bool
1004 = "llvm_passmanager_run_function"
1005 external finalize : [ `Function ] t -> bool = "llvm_passmanager_finalize"
1006 external dispose : [< any ] t -> unit = "llvm_passmanager_dispose"
1010 (*===-- Non-Externs -------------------------------------------------------===*)
1011 (* These functions are built using the externals, so must be declared late. *)
1013 let concat2 sep arr =
1015 if 0 < Array.length arr then begin
1017 for i = 1 to (Array.length arr) - 1 do
1018 s := !s ^ sep ^ arr.(i)
1023 let rec string_of_lltype ty =
1024 (* FIXME: stop infinite recursion! :) *)
1025 match classify_type ty with
1026 TypeKind.Integer -> "i" ^ string_of_int (integer_bitwidth ty)
1027 | TypeKind.Pointer -> (string_of_lltype (element_type ty)) ^ "*"
1028 | TypeKind.Struct ->
1029 let s = "{ " ^ (concat2 ", " (
1030 Array.map string_of_lltype (struct_element_types ty)
1035 | TypeKind.Array -> "[" ^ (string_of_int (array_length ty)) ^
1036 " x " ^ (string_of_lltype (element_type ty)) ^ "]"
1037 | TypeKind.Vector -> "<" ^ (string_of_int (vector_size ty)) ^
1038 " x " ^ (string_of_lltype (element_type ty)) ^ ">"
1039 | TypeKind.Function -> string_of_lltype (return_type ty) ^
1040 " (" ^ (concat2 ", " (
1041 Array.map string_of_lltype (param_types ty)
1043 | TypeKind.Label -> "label"
1044 | TypeKind.Ppc_fp128 -> "ppc_fp128"
1045 | TypeKind.Fp128 -> "fp128"
1046 | TypeKind.X86fp80 -> "x86_fp80"
1047 | TypeKind.Double -> "double"
1048 | TypeKind.Float -> "float"
1049 | TypeKind.Void -> "void"
1050 | TypeKind.Metadata -> "metadata"