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_name : lltype -> string option = "llvm_struct_name"
201 external struct_element_types : lltype -> lltype array
202 = "llvm_struct_element_types"
203 external is_packed : lltype -> bool = "llvm_is_packed"
205 (*--... Operations on pointer, vector, and array types .....................--*)
206 external array_type : lltype -> int -> lltype = "llvm_array_type"
207 external pointer_type : lltype -> lltype = "llvm_pointer_type"
208 external qualified_pointer_type : lltype -> int -> lltype
209 = "llvm_qualified_pointer_type"
210 external vector_type : lltype -> int -> lltype = "llvm_vector_type"
212 external element_type : lltype -> lltype = "LLVMGetElementType"
213 external array_length : lltype -> int = "llvm_array_length"
214 external address_space : lltype -> int = "llvm_address_space"
215 external vector_size : lltype -> int = "llvm_vector_size"
217 (*--... Operations on other types ..........................................--*)
218 external void_type : llcontext -> lltype = "llvm_void_type"
219 external label_type : llcontext -> lltype = "llvm_label_type"
221 (*===-- Values ------------------------------------------------------------===*)
222 external type_of : llvalue -> lltype = "llvm_type_of"
223 external value_name : llvalue -> string = "llvm_value_name"
224 external set_value_name : string -> llvalue -> unit = "llvm_set_value_name"
225 external dump_value : llvalue -> unit = "llvm_dump_value"
226 external replace_all_uses_with : llvalue -> llvalue -> unit
227 = "LLVMReplaceAllUsesWith"
229 (*--... Operations on uses .................................................--*)
230 external use_begin : llvalue -> lluse option = "llvm_use_begin"
231 external use_succ : lluse -> lluse option = "llvm_use_succ"
232 external user : lluse -> llvalue = "llvm_user"
233 external used_value : lluse -> llvalue = "llvm_used_value"
236 let rec aux = function
244 let fold_left_uses f init v =
248 | Some u -> aux (f init u) (use_succ u)
250 aux init (use_begin v)
252 let fold_right_uses f v init =
256 | Some u -> f u (aux (use_succ u) init)
258 aux (use_begin v) init
261 (*--... Operations on users ................................................--*)
262 external operand : llvalue -> int -> llvalue = "llvm_operand"
263 external set_operand : llvalue -> int -> llvalue -> unit = "llvm_set_operand"
264 external num_operands : llvalue -> int = "llvm_num_operands"
266 (*--... Operations on constants of (mostly) any type .......................--*)
267 external is_constant : llvalue -> bool = "llvm_is_constant"
268 external const_null : lltype -> llvalue = "LLVMConstNull"
269 external const_all_ones : (*int|vec*)lltype -> llvalue = "LLVMConstAllOnes"
270 external const_pointer_null : lltype -> llvalue = "LLVMConstPointerNull"
271 external undef : lltype -> llvalue = "LLVMGetUndef"
272 external is_null : llvalue -> bool = "llvm_is_null"
273 external is_undef : llvalue -> bool = "llvm_is_undef"
275 (*--... Operations on instructions .........................................--*)
276 external has_metadata : llvalue -> bool = "llvm_has_metadata"
277 external metadata : llvalue -> int -> llvalue option = "llvm_metadata"
278 external set_metadata : llvalue -> int -> llvalue -> unit = "llvm_set_metadata"
279 external clear_metadata : llvalue -> int -> unit = "llvm_clear_metadata"
281 (*--... Operations on metadata .......,.....................................--*)
282 external mdstring : llcontext -> string -> llvalue = "llvm_mdstring"
283 external mdnode : llcontext -> llvalue array -> llvalue = "llvm_mdnode"
285 (*--... Operations on scalar constants .....................................--*)
286 external const_int : lltype -> int -> llvalue = "llvm_const_int"
287 external const_of_int64 : lltype -> Int64.t -> bool -> llvalue
288 = "llvm_const_of_int64"
289 external const_int_of_string : lltype -> string -> int -> llvalue
290 = "llvm_const_int_of_string"
291 external const_float : lltype -> float -> llvalue = "llvm_const_float"
292 external const_float_of_string : lltype -> string -> llvalue
293 = "llvm_const_float_of_string"
295 (*--... Operations on composite constants ..................................--*)
296 external const_string : llcontext -> string -> llvalue = "llvm_const_string"
297 external const_stringz : llcontext -> string -> llvalue = "llvm_const_stringz"
298 external const_array : lltype -> llvalue array -> llvalue = "llvm_const_array"
299 external const_struct : llcontext -> llvalue array -> llvalue
300 = "llvm_const_struct"
301 external const_packed_struct : llcontext -> llvalue array -> llvalue
302 = "llvm_const_packed_struct"
303 external const_vector : llvalue array -> llvalue = "llvm_const_vector"
305 (*--... Constant expressions ...............................................--*)
306 external align_of : lltype -> llvalue = "LLVMAlignOf"
307 external size_of : lltype -> llvalue = "LLVMSizeOf"
308 external const_neg : llvalue -> llvalue = "LLVMConstNeg"
309 external const_nsw_neg : llvalue -> llvalue = "LLVMConstNSWNeg"
310 external const_nuw_neg : llvalue -> llvalue = "LLVMConstNUWNeg"
311 external const_fneg : llvalue -> llvalue = "LLVMConstFNeg"
312 external const_not : llvalue -> llvalue = "LLVMConstNot"
313 external const_add : llvalue -> llvalue -> llvalue = "LLVMConstAdd"
314 external const_nsw_add : llvalue -> llvalue -> llvalue = "LLVMConstNSWAdd"
315 external const_nuw_add : llvalue -> llvalue -> llvalue = "LLVMConstNUWAdd"
316 external const_fadd : llvalue -> llvalue -> llvalue = "LLVMConstFAdd"
317 external const_sub : llvalue -> llvalue -> llvalue = "LLVMConstSub"
318 external const_nsw_sub : llvalue -> llvalue -> llvalue = "LLVMConstNSWSub"
319 external const_nuw_sub : llvalue -> llvalue -> llvalue = "LLVMConstNUWSub"
320 external const_fsub : llvalue -> llvalue -> llvalue = "LLVMConstFSub"
321 external const_mul : llvalue -> llvalue -> llvalue = "LLVMConstMul"
322 external const_nsw_mul : llvalue -> llvalue -> llvalue = "LLVMConstNSWMul"
323 external const_nuw_mul : llvalue -> llvalue -> llvalue = "LLVMConstNUWMul"
324 external const_fmul : llvalue -> llvalue -> llvalue = "LLVMConstFMul"
325 external const_udiv : llvalue -> llvalue -> llvalue = "LLVMConstUDiv"
326 external const_sdiv : llvalue -> llvalue -> llvalue = "LLVMConstSDiv"
327 external const_exact_sdiv : llvalue -> llvalue -> llvalue = "LLVMConstExactSDiv"
328 external const_fdiv : llvalue -> llvalue -> llvalue = "LLVMConstFDiv"
329 external const_urem : llvalue -> llvalue -> llvalue = "LLVMConstURem"
330 external const_srem : llvalue -> llvalue -> llvalue = "LLVMConstSRem"
331 external const_frem : llvalue -> llvalue -> llvalue = "LLVMConstFRem"
332 external const_and : llvalue -> llvalue -> llvalue = "LLVMConstAnd"
333 external const_or : llvalue -> llvalue -> llvalue = "LLVMConstOr"
334 external const_xor : llvalue -> llvalue -> llvalue = "LLVMConstXor"
335 external const_icmp : Icmp.t -> llvalue -> llvalue -> llvalue
337 external const_fcmp : Fcmp.t -> llvalue -> llvalue -> llvalue
339 external const_shl : llvalue -> llvalue -> llvalue = "LLVMConstShl"
340 external const_lshr : llvalue -> llvalue -> llvalue = "LLVMConstLShr"
341 external const_ashr : llvalue -> llvalue -> llvalue = "LLVMConstAShr"
342 external const_gep : llvalue -> llvalue array -> llvalue = "llvm_const_gep"
343 external const_in_bounds_gep : llvalue -> llvalue array -> llvalue
344 = "llvm_const_in_bounds_gep"
345 external const_trunc : llvalue -> lltype -> llvalue = "LLVMConstTrunc"
346 external const_sext : llvalue -> lltype -> llvalue = "LLVMConstSExt"
347 external const_zext : llvalue -> lltype -> llvalue = "LLVMConstZExt"
348 external const_fptrunc : llvalue -> lltype -> llvalue = "LLVMConstFPTrunc"
349 external const_fpext : llvalue -> lltype -> llvalue = "LLVMConstFPExt"
350 external const_uitofp : llvalue -> lltype -> llvalue = "LLVMConstUIToFP"
351 external const_sitofp : llvalue -> lltype -> llvalue = "LLVMConstSIToFP"
352 external const_fptoui : llvalue -> lltype -> llvalue = "LLVMConstFPToUI"
353 external const_fptosi : llvalue -> lltype -> llvalue = "LLVMConstFPToSI"
354 external const_ptrtoint : llvalue -> lltype -> llvalue = "LLVMConstPtrToInt"
355 external const_inttoptr : llvalue -> lltype -> llvalue = "LLVMConstIntToPtr"
356 external const_bitcast : llvalue -> lltype -> llvalue = "LLVMConstBitCast"
357 external const_zext_or_bitcast : llvalue -> lltype -> llvalue
358 = "LLVMConstZExtOrBitCast"
359 external const_sext_or_bitcast : llvalue -> lltype -> llvalue
360 = "LLVMConstSExtOrBitCast"
361 external const_trunc_or_bitcast : llvalue -> lltype -> llvalue
362 = "LLVMConstTruncOrBitCast"
363 external const_pointercast : llvalue -> lltype -> llvalue
364 = "LLVMConstPointerCast"
365 external const_intcast : llvalue -> lltype -> llvalue = "LLVMConstIntCast"
366 external const_fpcast : llvalue -> lltype -> llvalue = "LLVMConstFPCast"
367 external const_select : llvalue -> llvalue -> llvalue -> llvalue
369 external const_extractelement : llvalue -> llvalue -> llvalue
370 = "LLVMConstExtractElement"
371 external const_insertelement : llvalue -> llvalue -> llvalue -> llvalue
372 = "LLVMConstInsertElement"
373 external const_shufflevector : llvalue -> llvalue -> llvalue -> llvalue
374 = "LLVMConstShuffleVector"
375 external const_extractvalue : llvalue -> int array -> llvalue
376 = "llvm_const_extractvalue"
377 external const_insertvalue : llvalue -> llvalue -> int array -> llvalue
378 = "llvm_const_insertvalue"
379 external const_inline_asm : lltype -> string -> string -> bool -> bool ->
381 = "llvm_const_inline_asm"
382 external block_address : llvalue -> llbasicblock -> llvalue = "LLVMBlockAddress"
384 (*--... Operations on global variables, functions, and aliases (globals) ...--*)
385 external global_parent : llvalue -> llmodule = "LLVMGetGlobalParent"
386 external is_declaration : llvalue -> bool = "llvm_is_declaration"
387 external linkage : llvalue -> Linkage.t = "llvm_linkage"
388 external set_linkage : Linkage.t -> llvalue -> unit = "llvm_set_linkage"
389 external section : llvalue -> string = "llvm_section"
390 external set_section : string -> llvalue -> unit = "llvm_set_section"
391 external visibility : llvalue -> Visibility.t = "llvm_visibility"
392 external set_visibility : Visibility.t -> llvalue -> unit = "llvm_set_visibility"
393 external alignment : llvalue -> int = "llvm_alignment"
394 external set_alignment : int -> llvalue -> unit = "llvm_set_alignment"
395 external is_global_constant : llvalue -> bool = "llvm_is_global_constant"
396 external set_global_constant : bool -> llvalue -> unit
397 = "llvm_set_global_constant"
399 (*--... Operations on global variables .....................................--*)
400 external declare_global : lltype -> string -> llmodule -> llvalue
401 = "llvm_declare_global"
402 external declare_qualified_global : lltype -> string -> int -> llmodule ->
404 = "llvm_declare_qualified_global"
405 external define_global : string -> llvalue -> llmodule -> llvalue
406 = "llvm_define_global"
407 external define_qualified_global : string -> llvalue -> int -> llmodule ->
409 = "llvm_define_qualified_global"
410 external lookup_global : string -> llmodule -> llvalue option
411 = "llvm_lookup_global"
412 external delete_global : llvalue -> unit = "llvm_delete_global"
413 external global_initializer : llvalue -> llvalue = "LLVMGetInitializer"
414 external set_initializer : llvalue -> llvalue -> unit = "llvm_set_initializer"
415 external remove_initializer : llvalue -> unit = "llvm_remove_initializer"
416 external is_thread_local : llvalue -> bool = "llvm_is_thread_local"
417 external set_thread_local : bool -> llvalue -> unit = "llvm_set_thread_local"
418 external global_begin : llmodule -> (llmodule, llvalue) llpos
419 = "llvm_global_begin"
420 external global_succ : llvalue -> (llmodule, llvalue) llpos
422 external global_end : llmodule -> (llmodule, llvalue) llrev_pos
424 external global_pred : llvalue -> (llmodule, llvalue) llrev_pos
427 let rec iter_global_range f i e =
428 if i = e then () else
430 | At_end _ -> raise (Invalid_argument "Invalid global variable range.")
433 iter_global_range f (global_succ bb) e
435 let iter_globals f m =
436 iter_global_range f (global_begin m) (At_end m)
438 let rec fold_left_global_range f init i e =
439 if i = e then init else
441 | At_end _ -> raise (Invalid_argument "Invalid global variable range.")
442 | Before bb -> fold_left_global_range f (f init bb) (global_succ bb) e
444 let fold_left_globals f init m =
445 fold_left_global_range f init (global_begin m) (At_end m)
447 let rec rev_iter_global_range f i e =
448 if i = e then () else
450 | At_start _ -> raise (Invalid_argument "Invalid global variable range.")
453 rev_iter_global_range f (global_pred bb) e
455 let rev_iter_globals f m =
456 rev_iter_global_range f (global_end m) (At_start m)
458 let rec fold_right_global_range f i e init =
459 if i = e then init else
461 | At_start _ -> raise (Invalid_argument "Invalid global variable range.")
462 | After bb -> fold_right_global_range f (global_pred bb) e (f bb init)
464 let fold_right_globals f m init =
465 fold_right_global_range f (global_end m) (At_start m) init
467 (*--... Operations on aliases ..............................................--*)
468 external add_alias : llmodule -> lltype -> llvalue -> string -> llvalue
471 (*--... Operations on functions ............................................--*)
472 external declare_function : string -> lltype -> llmodule -> llvalue
473 = "llvm_declare_function"
474 external define_function : string -> lltype -> llmodule -> llvalue
475 = "llvm_define_function"
476 external lookup_function : string -> llmodule -> llvalue option
477 = "llvm_lookup_function"
478 external delete_function : llvalue -> unit = "llvm_delete_function"
479 external is_intrinsic : llvalue -> bool = "llvm_is_intrinsic"
480 external function_call_conv : llvalue -> int = "llvm_function_call_conv"
481 external set_function_call_conv : int -> llvalue -> unit
482 = "llvm_set_function_call_conv"
483 external gc : llvalue -> string option = "llvm_gc"
484 external set_gc : string option -> llvalue -> unit = "llvm_set_gc"
485 external function_begin : llmodule -> (llmodule, llvalue) llpos
486 = "llvm_function_begin"
487 external function_succ : llvalue -> (llmodule, llvalue) llpos
488 = "llvm_function_succ"
489 external function_end : llmodule -> (llmodule, llvalue) llrev_pos
490 = "llvm_function_end"
491 external function_pred : llvalue -> (llmodule, llvalue) llrev_pos
492 = "llvm_function_pred"
494 let rec iter_function_range f i e =
495 if i = e then () else
497 | At_end _ -> raise (Invalid_argument "Invalid function range.")
500 iter_function_range f (function_succ fn) e
502 let iter_functions f m =
503 iter_function_range f (function_begin m) (At_end m)
505 let rec fold_left_function_range f init i e =
506 if i = e then init else
508 | At_end _ -> raise (Invalid_argument "Invalid function range.")
509 | Before fn -> fold_left_function_range f (f init fn) (function_succ fn) e
511 let fold_left_functions f init m =
512 fold_left_function_range f init (function_begin m) (At_end m)
514 let rec rev_iter_function_range f i e =
515 if i = e then () else
517 | At_start _ -> raise (Invalid_argument "Invalid function range.")
520 rev_iter_function_range f (function_pred fn) e
522 let rev_iter_functions f m =
523 rev_iter_function_range f (function_end m) (At_start m)
525 let rec fold_right_function_range f i e init =
526 if i = e then init else
528 | At_start _ -> raise (Invalid_argument "Invalid function range.")
529 | After fn -> fold_right_function_range f (function_pred fn) e (f fn init)
531 let fold_right_functions f m init =
532 fold_right_function_range f (function_end m) (At_start m) init
534 external llvm_add_function_attr : llvalue -> int -> unit
535 = "llvm_add_function_attr"
536 external llvm_remove_function_attr : llvalue -> int -> unit
537 = "llvm_remove_function_attr"
539 let pack_attr (attr:Attribute.t) : int =
541 Attribute.Zext -> 1 lsl 0
542 | Attribute.Sext -> 1 lsl 1
543 | Attribute.Noreturn -> 1 lsl 2
544 | Attribute.Inreg -> 1 lsl 3
545 | Attribute.Structret -> 1 lsl 4
546 | Attribute.Nounwind -> 1 lsl 5
547 | Attribute.Noalias -> 1 lsl 6
548 | Attribute.Byval -> 1 lsl 7
549 | Attribute.Nest -> 1 lsl 8
550 | Attribute.Readnone -> 1 lsl 9
551 | Attribute.Readonly -> 1 lsl 10
552 | Attribute.Noinline -> 1 lsl 11
553 | Attribute.Alwaysinline -> 1 lsl 12
554 | Attribute.Optsize -> 1 lsl 13
555 | Attribute.Ssp -> 1 lsl 14
556 | Attribute.Sspreq -> 1 lsl 15
557 | Attribute.Alignment n -> n lsl 16
558 | Attribute.Nocapture -> 1 lsl 21
559 | Attribute.Noredzone -> 1 lsl 22
560 | Attribute.Noimplicitfloat -> 1 lsl 23
561 | Attribute.Naked -> 1 lsl 24
562 | Attribute.Inlinehint -> 1 lsl 25
563 | Attribute.Stackalignment n -> n lsl 26
565 let add_function_attr llval attr =
566 llvm_add_function_attr llval (pack_attr attr)
568 let remove_function_attr llval attr =
569 llvm_remove_function_attr llval (pack_attr attr)
571 (*--... Operations on params ...............................................--*)
572 external params : llvalue -> llvalue array = "llvm_params"
573 external param : llvalue -> int -> llvalue = "llvm_param"
574 external param_parent : llvalue -> llvalue = "LLVMGetParamParent"
575 external param_begin : llvalue -> (llvalue, llvalue) llpos = "llvm_param_begin"
576 external param_succ : llvalue -> (llvalue, llvalue) llpos = "llvm_param_succ"
577 external param_end : llvalue -> (llvalue, llvalue) llrev_pos = "llvm_param_end"
578 external param_pred : llvalue -> (llvalue, llvalue) llrev_pos ="llvm_param_pred"
580 let rec iter_param_range f i e =
581 if i = e then () else
583 | At_end _ -> raise (Invalid_argument "Invalid parameter range.")
586 iter_param_range f (param_succ p) e
588 let iter_params f fn =
589 iter_param_range f (param_begin fn) (At_end fn)
591 let rec fold_left_param_range f init i e =
592 if i = e then init else
594 | At_end _ -> raise (Invalid_argument "Invalid parameter range.")
595 | Before p -> fold_left_param_range f (f init p) (param_succ p) e
597 let fold_left_params f init fn =
598 fold_left_param_range f init (param_begin fn) (At_end fn)
600 let rec rev_iter_param_range f i e =
601 if i = e then () else
603 | At_start _ -> raise (Invalid_argument "Invalid parameter range.")
606 rev_iter_param_range f (param_pred p) e
608 let rev_iter_params f fn =
609 rev_iter_param_range f (param_end fn) (At_start fn)
611 let rec fold_right_param_range f init i e =
612 if i = e then init else
614 | At_start _ -> raise (Invalid_argument "Invalid parameter range.")
615 | After p -> fold_right_param_range f (f p init) (param_pred p) e
617 let fold_right_params f fn init =
618 fold_right_param_range f init (param_end fn) (At_start fn)
620 external llvm_add_param_attr : llvalue -> int -> unit
621 = "llvm_add_param_attr"
622 external llvm_remove_param_attr : llvalue -> int -> unit
623 = "llvm_remove_param_attr"
625 let add_param_attr llval attr =
626 llvm_add_param_attr llval (pack_attr attr)
628 let remove_param_attr llval attr =
629 llvm_remove_param_attr llval (pack_attr attr)
631 external set_param_alignment : llvalue -> int -> unit
632 = "llvm_set_param_alignment"
634 (*--... Operations on basic blocks .........................................--*)
635 external value_of_block : llbasicblock -> llvalue = "LLVMBasicBlockAsValue"
636 external value_is_block : llvalue -> bool = "llvm_value_is_block"
637 external block_of_value : llvalue -> llbasicblock = "LLVMValueAsBasicBlock"
638 external block_parent : llbasicblock -> llvalue = "LLVMGetBasicBlockParent"
639 external basic_blocks : llvalue -> llbasicblock array = "llvm_basic_blocks"
640 external entry_block : llvalue -> llbasicblock = "LLVMGetEntryBasicBlock"
641 external delete_block : llbasicblock -> unit = "llvm_delete_block"
642 external append_block : llcontext -> string -> llvalue -> llbasicblock
643 = "llvm_append_block"
644 external insert_block : llcontext -> string -> llbasicblock -> llbasicblock
645 = "llvm_insert_block"
646 external block_begin : llvalue -> (llvalue, llbasicblock) llpos
648 external block_succ : llbasicblock -> (llvalue, llbasicblock) llpos
650 external block_end : llvalue -> (llvalue, llbasicblock) llrev_pos
652 external block_pred : llbasicblock -> (llvalue, llbasicblock) llrev_pos
655 let rec iter_block_range f i e =
656 if i = e then () else
658 | At_end _ -> raise (Invalid_argument "Invalid block range.")
661 iter_block_range f (block_succ bb) e
663 let iter_blocks f fn =
664 iter_block_range f (block_begin fn) (At_end fn)
666 let rec fold_left_block_range f init i e =
667 if i = e then init else
669 | At_end _ -> raise (Invalid_argument "Invalid block range.")
670 | Before bb -> fold_left_block_range f (f init bb) (block_succ bb) e
672 let fold_left_blocks f init fn =
673 fold_left_block_range f init (block_begin fn) (At_end fn)
675 let rec rev_iter_block_range f i e =
676 if i = e then () else
678 | At_start _ -> raise (Invalid_argument "Invalid block range.")
681 rev_iter_block_range f (block_pred bb) e
683 let rev_iter_blocks f fn =
684 rev_iter_block_range f (block_end fn) (At_start fn)
686 let rec fold_right_block_range f init i e =
687 if i = e then init else
689 | At_start _ -> raise (Invalid_argument "Invalid block range.")
690 | After bb -> fold_right_block_range f (f bb init) (block_pred bb) e
692 let fold_right_blocks f fn init =
693 fold_right_block_range f init (block_end fn) (At_start fn)
695 (*--... Operations on instructions .........................................--*)
696 external instr_parent : llvalue -> llbasicblock = "LLVMGetInstructionParent"
697 external instr_begin : llbasicblock -> (llbasicblock, llvalue) llpos
699 external instr_succ : llvalue -> (llbasicblock, llvalue) llpos
701 external instr_end : llbasicblock -> (llbasicblock, llvalue) llrev_pos
703 external instr_pred : llvalue -> (llbasicblock, llvalue) llrev_pos
706 let rec iter_instrs_range f i e =
707 if i = e then () else
709 | At_end _ -> raise (Invalid_argument "Invalid instruction range.")
712 iter_instrs_range f (instr_succ i) e
714 let iter_instrs f bb =
715 iter_instrs_range f (instr_begin bb) (At_end bb)
717 let rec fold_left_instrs_range f init i e =
718 if i = e then init else
720 | At_end _ -> raise (Invalid_argument "Invalid instruction range.")
721 | Before i -> fold_left_instrs_range f (f init i) (instr_succ i) e
723 let fold_left_instrs f init bb =
724 fold_left_instrs_range f init (instr_begin bb) (At_end bb)
726 let rec rev_iter_instrs_range f i e =
727 if i = e then () else
729 | At_start _ -> raise (Invalid_argument "Invalid instruction range.")
732 rev_iter_instrs_range f (instr_pred i) e
734 let rev_iter_instrs f bb =
735 rev_iter_instrs_range f (instr_end bb) (At_start bb)
737 let rec fold_right_instr_range f i e init =
738 if i = e then init else
740 | At_start _ -> raise (Invalid_argument "Invalid instruction range.")
741 | After i -> fold_right_instr_range f (instr_pred i) e (f i init)
743 let fold_right_instrs f bb init =
744 fold_right_instr_range f (instr_end bb) (At_start bb) init
747 (*--... Operations on call sites ...........................................--*)
748 external instruction_call_conv: llvalue -> int
749 = "llvm_instruction_call_conv"
750 external set_instruction_call_conv: int -> llvalue -> unit
751 = "llvm_set_instruction_call_conv"
753 external llvm_add_instruction_param_attr : llvalue -> int -> int -> unit
754 = "llvm_add_instruction_param_attr"
755 external llvm_remove_instruction_param_attr : llvalue -> int -> int -> unit
756 = "llvm_remove_instruction_param_attr"
758 let add_instruction_param_attr llval i attr =
759 llvm_add_instruction_param_attr llval i (pack_attr attr)
761 let remove_instruction_param_attr llval i attr =
762 llvm_remove_instruction_param_attr llval i (pack_attr attr)
764 (*--... Operations on call instructions (only) .............................--*)
765 external is_tail_call : llvalue -> bool = "llvm_is_tail_call"
766 external set_tail_call : bool -> llvalue -> unit = "llvm_set_tail_call"
768 (*--... Operations on phi nodes ............................................--*)
769 external add_incoming : (llvalue * llbasicblock) -> llvalue -> unit
770 = "llvm_add_incoming"
771 external incoming : llvalue -> (llvalue * llbasicblock) list = "llvm_incoming"
774 (*===-- Instruction builders ----------------------------------------------===*)
775 external builder : llcontext -> llbuilder = "llvm_builder"
776 external position_builder : (llbasicblock, llvalue) llpos -> llbuilder -> unit
777 = "llvm_position_builder"
778 external insertion_block : llbuilder -> llbasicblock = "llvm_insertion_block"
779 external insert_into_builder : llvalue -> string -> llbuilder -> unit
780 = "llvm_insert_into_builder"
782 let builder_at context ip =
783 let b = builder context in
784 position_builder ip b;
787 let builder_before context i = builder_at context (Before i)
788 let builder_at_end context bb = builder_at context (At_end bb)
790 let position_before i = position_builder (Before i)
791 let position_at_end bb = position_builder (At_end bb)
794 (*--... Metadata ...........................................................--*)
795 external set_current_debug_location : llbuilder -> llvalue -> unit
796 = "llvm_set_current_debug_location"
797 external clear_current_debug_location : llbuilder -> unit
798 = "llvm_clear_current_debug_location"
799 external current_debug_location : llbuilder -> llvalue option
800 = "llvm_current_debug_location"
801 external set_inst_debug_location : llbuilder -> llvalue -> unit
802 = "llvm_set_inst_debug_location"
805 (*--... Terminators ........................................................--*)
806 external build_ret_void : llbuilder -> llvalue = "llvm_build_ret_void"
807 external build_ret : llvalue -> llbuilder -> llvalue = "llvm_build_ret"
808 external build_aggregate_ret : llvalue array -> llbuilder -> llvalue
809 = "llvm_build_aggregate_ret"
810 external build_br : llbasicblock -> llbuilder -> llvalue = "llvm_build_br"
811 external build_cond_br : llvalue -> llbasicblock -> llbasicblock -> llbuilder ->
812 llvalue = "llvm_build_cond_br"
813 external build_switch : llvalue -> llbasicblock -> int -> llbuilder -> llvalue
814 = "llvm_build_switch"
815 external add_case : llvalue -> llvalue -> llbasicblock -> unit
817 external build_indirect_br : llvalue -> int -> llbuilder -> llvalue
818 = "llvm_build_indirect_br"
819 external add_destination : llvalue -> llbasicblock -> unit
820 = "llvm_add_destination"
821 external build_invoke : llvalue -> llvalue array -> llbasicblock ->
822 llbasicblock -> string -> llbuilder -> llvalue
823 = "llvm_build_invoke_bc" "llvm_build_invoke_nat"
824 external build_landingpad : lltype -> llvalue -> int -> string -> llbuilder ->
825 llvalue = "llvm_build_landingpad"
826 external set_cleanup : llvalue -> bool -> unit = "llvm_set_cleanup"
827 external build_unreachable : llbuilder -> llvalue = "llvm_build_unreachable"
829 (*--... Arithmetic .........................................................--*)
830 external build_add : llvalue -> llvalue -> string -> llbuilder -> llvalue
832 external build_nsw_add : llvalue -> llvalue -> string -> llbuilder -> llvalue
833 = "llvm_build_nsw_add"
834 external build_nuw_add : llvalue -> llvalue -> string -> llbuilder -> llvalue
835 = "llvm_build_nuw_add"
836 external build_fadd : llvalue -> llvalue -> string -> llbuilder -> llvalue
838 external build_sub : llvalue -> llvalue -> string -> llbuilder -> llvalue
840 external build_nsw_sub : llvalue -> llvalue -> string -> llbuilder -> llvalue
841 = "llvm_build_nsw_sub"
842 external build_nuw_sub : llvalue -> llvalue -> string -> llbuilder -> llvalue
843 = "llvm_build_nuw_sub"
844 external build_fsub : llvalue -> llvalue -> string -> llbuilder -> llvalue
846 external build_mul : llvalue -> llvalue -> string -> llbuilder -> llvalue
848 external build_nsw_mul : llvalue -> llvalue -> string -> llbuilder -> llvalue
849 = "llvm_build_nsw_mul"
850 external build_nuw_mul : llvalue -> llvalue -> string -> llbuilder -> llvalue
851 = "llvm_build_nuw_mul"
852 external build_fmul : llvalue -> llvalue -> string -> llbuilder -> llvalue
854 external build_udiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
856 external build_sdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
858 external build_exact_sdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
859 = "llvm_build_exact_sdiv"
860 external build_fdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
862 external build_urem : llvalue -> llvalue -> string -> llbuilder -> llvalue
864 external build_srem : llvalue -> llvalue -> string -> llbuilder -> llvalue
866 external build_frem : llvalue -> llvalue -> string -> llbuilder -> llvalue
868 external build_shl : llvalue -> llvalue -> string -> llbuilder -> llvalue
870 external build_lshr : llvalue -> llvalue -> string -> llbuilder -> llvalue
872 external build_ashr : llvalue -> llvalue -> string -> llbuilder -> llvalue
874 external build_and : llvalue -> llvalue -> string -> llbuilder -> llvalue
876 external build_or : llvalue -> llvalue -> string -> llbuilder -> llvalue
878 external build_xor : llvalue -> llvalue -> string -> llbuilder -> llvalue
880 external build_neg : llvalue -> string -> llbuilder -> llvalue
882 external build_nsw_neg : llvalue -> string -> llbuilder -> llvalue
883 = "llvm_build_nsw_neg"
884 external build_nuw_neg : llvalue -> string -> llbuilder -> llvalue
885 = "llvm_build_nuw_neg"
886 external build_fneg : llvalue -> string -> llbuilder -> llvalue
888 external build_not : llvalue -> string -> llbuilder -> llvalue
891 (*--... Memory .............................................................--*)
892 external build_alloca : lltype -> string -> llbuilder -> llvalue
893 = "llvm_build_alloca"
894 external build_array_alloca : lltype -> llvalue -> string -> llbuilder ->
895 llvalue = "llvm_build_array_alloca"
896 external build_load : llvalue -> string -> llbuilder -> llvalue
898 external build_store : llvalue -> llvalue -> llbuilder -> llvalue
900 external build_gep : llvalue -> llvalue array -> string -> llbuilder -> llvalue
902 external build_in_bounds_gep : llvalue -> llvalue array -> string ->
903 llbuilder -> llvalue = "llvm_build_in_bounds_gep"
904 external build_struct_gep : llvalue -> int -> string -> llbuilder -> llvalue
905 = "llvm_build_struct_gep"
907 external build_global_string : string -> string -> llbuilder -> llvalue
908 = "llvm_build_global_string"
909 external build_global_stringptr : string -> string -> llbuilder -> llvalue
910 = "llvm_build_global_stringptr"
912 (*--... Casts ..............................................................--*)
913 external build_trunc : llvalue -> lltype -> string -> llbuilder -> llvalue
915 external build_zext : llvalue -> lltype -> string -> llbuilder -> llvalue
917 external build_sext : llvalue -> lltype -> string -> llbuilder -> llvalue
919 external build_fptoui : llvalue -> lltype -> string -> llbuilder -> llvalue
920 = "llvm_build_fptoui"
921 external build_fptosi : llvalue -> lltype -> string -> llbuilder -> llvalue
922 = "llvm_build_fptosi"
923 external build_uitofp : llvalue -> lltype -> string -> llbuilder -> llvalue
924 = "llvm_build_uitofp"
925 external build_sitofp : llvalue -> lltype -> string -> llbuilder -> llvalue
926 = "llvm_build_sitofp"
927 external build_fptrunc : llvalue -> lltype -> string -> llbuilder -> llvalue
928 = "llvm_build_fptrunc"
929 external build_fpext : llvalue -> lltype -> string -> llbuilder -> llvalue
931 external build_ptrtoint : llvalue -> lltype -> string -> llbuilder -> llvalue
932 = "llvm_build_prttoint"
933 external build_inttoptr : llvalue -> lltype -> string -> llbuilder -> llvalue
934 = "llvm_build_inttoptr"
935 external build_bitcast : llvalue -> lltype -> string -> llbuilder -> llvalue
936 = "llvm_build_bitcast"
937 external build_zext_or_bitcast : llvalue -> lltype -> string -> llbuilder ->
938 llvalue = "llvm_build_zext_or_bitcast"
939 external build_sext_or_bitcast : llvalue -> lltype -> string -> llbuilder ->
940 llvalue = "llvm_build_sext_or_bitcast"
941 external build_trunc_or_bitcast : llvalue -> lltype -> string -> llbuilder ->
942 llvalue = "llvm_build_trunc_or_bitcast"
943 external build_pointercast : llvalue -> lltype -> string -> llbuilder -> llvalue
944 = "llvm_build_pointercast"
945 external build_intcast : llvalue -> lltype -> string -> llbuilder -> llvalue
946 = "llvm_build_intcast"
947 external build_fpcast : llvalue -> lltype -> string -> llbuilder -> llvalue
948 = "llvm_build_fpcast"
950 (*--... Comparisons ........................................................--*)
951 external build_icmp : Icmp.t -> llvalue -> llvalue -> string ->
952 llbuilder -> llvalue = "llvm_build_icmp"
953 external build_fcmp : Fcmp.t -> llvalue -> llvalue -> string ->
954 llbuilder -> llvalue = "llvm_build_fcmp"
956 (*--... Miscellaneous instructions .........................................--*)
957 external build_phi : (llvalue * llbasicblock) list -> string -> llbuilder ->
958 llvalue = "llvm_build_phi"
959 external build_call : llvalue -> llvalue array -> string -> llbuilder -> llvalue
961 external build_select : llvalue -> llvalue -> llvalue -> string -> llbuilder ->
962 llvalue = "llvm_build_select"
963 external build_va_arg : llvalue -> lltype -> string -> llbuilder -> llvalue
964 = "llvm_build_va_arg"
965 external build_extractelement : llvalue -> llvalue -> string -> llbuilder ->
966 llvalue = "llvm_build_extractelement"
967 external build_insertelement : llvalue -> llvalue -> llvalue -> string ->
968 llbuilder -> llvalue = "llvm_build_insertelement"
969 external build_shufflevector : llvalue -> llvalue -> llvalue -> string ->
970 llbuilder -> llvalue = "llvm_build_shufflevector"
971 external build_extractvalue : llvalue -> int -> string -> llbuilder -> llvalue
972 = "llvm_build_extractvalue"
973 external build_insertvalue : llvalue -> llvalue -> int -> string -> llbuilder ->
974 llvalue = "llvm_build_insertvalue"
976 external build_is_null : llvalue -> string -> llbuilder -> llvalue
977 = "llvm_build_is_null"
978 external build_is_not_null : llvalue -> string -> llbuilder -> llvalue
979 = "llvm_build_is_not_null"
980 external build_ptrdiff : llvalue -> llvalue -> string -> llbuilder -> llvalue
981 = "llvm_build_ptrdiff"
984 (*===-- Memory buffers ----------------------------------------------------===*)
986 module MemoryBuffer = struct
987 external of_file : string -> llmemorybuffer = "llvm_memorybuffer_of_file"
988 external of_stdin : unit -> llmemorybuffer = "llvm_memorybuffer_of_stdin"
989 external dispose : llmemorybuffer -> unit = "llvm_memorybuffer_dispose"
993 (*===-- Pass Manager ------------------------------------------------------===*)
995 module PassManager = struct
997 type any = [ `Module | `Function ]
998 external create : unit -> [ `Module ] t = "llvm_passmanager_create"
999 external create_function : llmodule -> [ `Function ] t
1000 = "LLVMCreateFunctionPassManager"
1001 external run_module : llmodule -> [ `Module ] t -> bool
1002 = "llvm_passmanager_run_module"
1003 external initialize : [ `Function ] t -> bool = "llvm_passmanager_initialize"
1004 external run_function : llvalue -> [ `Function ] t -> bool
1005 = "llvm_passmanager_run_function"
1006 external finalize : [ `Function ] t -> bool = "llvm_passmanager_finalize"
1007 external dispose : [< any ] t -> unit = "llvm_passmanager_dispose"
1011 (*===-- Non-Externs -------------------------------------------------------===*)
1012 (* These functions are built using the externals, so must be declared late. *)
1014 let concat2 sep arr =
1016 if 0 < Array.length arr then begin
1018 for i = 1 to (Array.length arr) - 1 do
1019 s := !s ^ sep ^ arr.(i)
1024 let rec string_of_lltype ty =
1025 (* FIXME: stop infinite recursion! :) *)
1026 match classify_type ty with
1027 TypeKind.Integer -> "i" ^ string_of_int (integer_bitwidth ty)
1028 | TypeKind.Pointer -> (string_of_lltype (element_type ty)) ^ "*"
1029 | TypeKind.Struct ->
1030 let s = "{ " ^ (concat2 ", " (
1031 Array.map string_of_lltype (struct_element_types ty)
1036 | TypeKind.Array -> "[" ^ (string_of_int (array_length ty)) ^
1037 " x " ^ (string_of_lltype (element_type ty)) ^ "]"
1038 | TypeKind.Vector -> "<" ^ (string_of_int (vector_size ty)) ^
1039 " x " ^ (string_of_lltype (element_type ty)) ^ ">"
1040 | TypeKind.Function -> string_of_lltype (return_type ty) ^
1041 " (" ^ (concat2 ", " (
1042 Array.map string_of_lltype (param_types ty)
1044 | TypeKind.Label -> "label"
1045 | TypeKind.Ppc_fp128 -> "ppc_fp128"
1046 | TypeKind.Fp128 -> "fp128"
1047 | TypeKind.X86fp80 -> "x86_fp80"
1048 | TypeKind.Double -> "double"
1049 | TypeKind.Float -> "float"
1050 | TypeKind.Void -> "void"
1051 | TypeKind.Metadata -> "metadata"