1 (*===-- llvm/llvm.ml - LLVM Ocaml Interface --------------------------------===*
3 * The LLVM Compiler Infrastructure
5 * This file is distributed under the University of Illinois Open Source
6 * License. See LICENSE.TXT for details.
8 *===----------------------------------------------------------------------===*)
21 module TypeKind = struct
40 module Linkage = struct
43 | Available_externally
59 module Visibility = struct
66 module CallConv = struct
74 module Attribute = struct
98 | Stackalignment of int
135 exception IoError of string
137 external register_exns : exn -> unit = "llvm_register_core_exns"
138 let _ = register_exns (IoError "")
140 type ('a, 'b) llpos =
144 type ('a, 'b) llrev_pos =
148 (*===-- Contexts ----------------------------------------------------------===*)
149 external create_context : unit -> llcontext = "llvm_create_context"
150 external dispose_context : llcontext -> unit = "llvm_dispose_context"
151 external global_context : unit -> llcontext = "llvm_global_context"
152 external mdkind_id : llcontext -> string -> int = "llvm_mdkind_id"
154 (*===-- Modules -----------------------------------------------------------===*)
155 external create_module : llcontext -> string -> llmodule = "llvm_create_module"
156 external dispose_module : llmodule -> unit = "llvm_dispose_module"
157 external target_triple: llmodule -> string
158 = "llvm_target_triple"
159 external set_target_triple: string -> llmodule -> unit
160 = "llvm_set_target_triple"
161 external data_layout: llmodule -> string
163 external set_data_layout: string -> llmodule -> unit
164 = "llvm_set_data_layout"
165 external define_type_name : string -> lltype -> llmodule -> bool
166 = "llvm_add_type_name"
167 external delete_type_name : string -> llmodule -> unit
168 = "llvm_delete_type_name"
169 external type_by_name : llmodule -> string -> lltype option
170 = "llvm_type_by_name"
171 external dump_module : llmodule -> unit = "llvm_dump_module"
172 external set_module_inline_asm : llmodule -> string -> unit
173 = "llvm_set_module_inline_asm"
175 (*===-- Types -------------------------------------------------------------===*)
176 external classify_type : lltype -> TypeKind.t = "llvm_classify_type"
177 external type_context : lltype -> llcontext = "llvm_type_context"
179 (*--... Operations on integer types ........................................--*)
180 external i1_type : llcontext -> lltype = "llvm_i1_type"
181 external i8_type : llcontext -> lltype = "llvm_i8_type"
182 external i16_type : llcontext -> lltype = "llvm_i16_type"
183 external i32_type : llcontext -> lltype = "llvm_i32_type"
184 external i64_type : llcontext -> lltype = "llvm_i64_type"
186 external integer_type : llcontext -> int -> lltype = "llvm_integer_type"
187 external integer_bitwidth : lltype -> int = "llvm_integer_bitwidth"
189 (*--... Operations on real types ...........................................--*)
190 external float_type : llcontext -> lltype = "llvm_float_type"
191 external double_type : llcontext -> lltype = "llvm_double_type"
192 external x86fp80_type : llcontext -> lltype = "llvm_x86fp80_type"
193 external fp128_type : llcontext -> lltype = "llvm_fp128_type"
194 external ppc_fp128_type : llcontext -> lltype = "llvm_ppc_fp128_type"
196 (*--... Operations on function types .......................................--*)
197 external function_type : lltype -> lltype array -> lltype = "llvm_function_type"
198 external var_arg_function_type : lltype -> lltype array -> lltype
199 = "llvm_var_arg_function_type"
200 external is_var_arg : lltype -> bool = "llvm_is_var_arg"
201 external return_type : lltype -> lltype = "LLVMGetReturnType"
202 external param_types : lltype -> lltype array = "llvm_param_types"
204 (*--... Operations on struct types .........................................--*)
205 external struct_type : llcontext -> lltype array -> lltype = "llvm_struct_type"
206 external packed_struct_type : llcontext -> lltype array -> lltype
207 = "llvm_packed_struct_type"
208 external struct_element_types : lltype -> lltype array
209 = "llvm_struct_element_types"
210 external is_packed : lltype -> bool = "llvm_is_packed"
212 (*--... Operations on pointer, vector, and array types .....................--*)
213 external array_type : lltype -> int -> lltype = "llvm_array_type"
214 external pointer_type : lltype -> lltype = "llvm_pointer_type"
215 external qualified_pointer_type : lltype -> int -> lltype
216 = "llvm_qualified_pointer_type"
217 external vector_type : lltype -> int -> lltype = "llvm_vector_type"
219 external element_type : lltype -> lltype = "LLVMGetElementType"
220 external array_length : lltype -> int = "llvm_array_length"
221 external address_space : lltype -> int = "llvm_address_space"
222 external vector_size : lltype -> int = "llvm_vector_size"
224 (*--... Operations on other types ..........................................--*)
225 external opaque_type : llcontext -> lltype = "llvm_opaque_type"
226 external void_type : llcontext -> lltype = "llvm_void_type"
227 external label_type : llcontext -> lltype = "llvm_label_type"
229 (*--... Operations on type handles .........................................--*)
230 external handle_to_type : lltype -> lltypehandle = "llvm_handle_to_type"
231 external type_of_handle : lltypehandle -> lltype = "llvm_type_of_handle"
232 external refine_type : lltype -> lltype -> unit = "llvm_refine_type"
235 (*===-- Values ------------------------------------------------------------===*)
236 external type_of : llvalue -> lltype = "llvm_type_of"
237 external value_name : llvalue -> string = "llvm_value_name"
238 external set_value_name : string -> llvalue -> unit = "llvm_set_value_name"
239 external dump_value : llvalue -> unit = "llvm_dump_value"
240 external replace_all_uses_with : llvalue -> llvalue -> unit
241 = "LLVMReplaceAllUsesWith"
243 (*--... Operations on uses .................................................--*)
244 external use_begin : llvalue -> lluse option = "llvm_use_begin"
245 external use_succ : lluse -> lluse option = "llvm_use_succ"
246 external user : lluse -> llvalue = "llvm_user"
247 external used_value : lluse -> llvalue = "llvm_used_value"
250 let rec aux = function
258 let fold_left_uses f init v =
262 | Some u -> aux (f init u) (use_succ u)
264 aux init (use_begin v)
266 let fold_right_uses f v init =
270 | Some u -> f u (aux (use_succ u) init)
272 aux (use_begin v) init
275 (*--... Operations on users ................................................--*)
276 external operand : llvalue -> int -> llvalue = "llvm_operand"
277 external set_operand : llvalue -> int -> llvalue -> unit = "llvm_set_operand"
278 external num_operands : llvalue -> int = "llvm_num_operands"
280 (*--... Operations on constants of (mostly) any type .......................--*)
281 external is_constant : llvalue -> bool = "llvm_is_constant"
282 external const_null : lltype -> llvalue = "LLVMConstNull"
283 external const_all_ones : (*int|vec*)lltype -> llvalue = "LLVMConstAllOnes"
284 external const_pointer_null : lltype -> llvalue = "LLVMConstPointerNull"
285 external undef : lltype -> llvalue = "LLVMGetUndef"
286 external is_null : llvalue -> bool = "llvm_is_null"
287 external is_undef : llvalue -> bool = "llvm_is_undef"
289 (*--... Operations on instructions .........................................--*)
290 external has_metadata : llvalue -> bool = "llvm_has_metadata"
291 external metadata : llvalue -> int -> llvalue option = "llvm_metadata"
292 external set_metadata : llvalue -> int -> llvalue -> unit = "llvm_set_metadata"
293 external clear_metadata : llvalue -> int -> unit = "llvm_clear_metadata"
295 (*--... Operations on metadata .......,.....................................--*)
296 external mdstring : llcontext -> string -> llvalue = "llvm_mdstring"
297 external mdnode : llcontext -> llvalue array -> llvalue = "llvm_mdnode"
299 (*--... Operations on scalar constants .....................................--*)
300 external const_int : lltype -> int -> llvalue = "llvm_const_int"
301 external const_of_int64 : lltype -> Int64.t -> bool -> llvalue
302 = "llvm_const_of_int64"
303 external const_int_of_string : lltype -> string -> int -> llvalue
304 = "llvm_const_int_of_string"
305 external const_float : lltype -> float -> llvalue = "llvm_const_float"
306 external const_float_of_string : lltype -> string -> llvalue
307 = "llvm_const_float_of_string"
309 (*--... Operations on composite constants ..................................--*)
310 external const_string : llcontext -> string -> llvalue = "llvm_const_string"
311 external const_stringz : llcontext -> string -> llvalue = "llvm_const_stringz"
312 external const_array : lltype -> llvalue array -> llvalue = "llvm_const_array"
313 external const_struct : llcontext -> llvalue array -> llvalue
314 = "llvm_const_struct"
315 external const_packed_struct : llcontext -> llvalue array -> llvalue
316 = "llvm_const_packed_struct"
317 external const_vector : llvalue array -> llvalue = "llvm_const_vector"
319 (*--... Constant expressions ...............................................--*)
320 external align_of : lltype -> llvalue = "LLVMAlignOf"
321 external size_of : lltype -> llvalue = "LLVMSizeOf"
322 external const_neg : llvalue -> llvalue = "LLVMConstNeg"
323 external const_nsw_neg : llvalue -> llvalue = "LLVMConstNSWNeg"
324 external const_nuw_neg : llvalue -> llvalue = "LLVMConstNUWNeg"
325 external const_fneg : llvalue -> llvalue = "LLVMConstFNeg"
326 external const_not : llvalue -> llvalue = "LLVMConstNot"
327 external const_add : llvalue -> llvalue -> llvalue = "LLVMConstAdd"
328 external const_nsw_add : llvalue -> llvalue -> llvalue = "LLVMConstNSWAdd"
329 external const_nuw_add : llvalue -> llvalue -> llvalue = "LLVMConstNUWAdd"
330 external const_fadd : llvalue -> llvalue -> llvalue = "LLVMConstFAdd"
331 external const_sub : llvalue -> llvalue -> llvalue = "LLVMConstSub"
332 external const_nsw_sub : llvalue -> llvalue -> llvalue = "LLVMConstNSWSub"
333 external const_nuw_sub : llvalue -> llvalue -> llvalue = "LLVMConstNUWSub"
334 external const_fsub : llvalue -> llvalue -> llvalue = "LLVMConstFSub"
335 external const_mul : llvalue -> llvalue -> llvalue = "LLVMConstMul"
336 external const_nsw_mul : llvalue -> llvalue -> llvalue = "LLVMConstNSWMul"
337 external const_nuw_mul : llvalue -> llvalue -> llvalue = "LLVMConstNUWMul"
338 external const_fmul : llvalue -> llvalue -> llvalue = "LLVMConstFMul"
339 external const_udiv : llvalue -> llvalue -> llvalue = "LLVMConstUDiv"
340 external const_sdiv : llvalue -> llvalue -> llvalue = "LLVMConstSDiv"
341 external const_exact_sdiv : llvalue -> llvalue -> llvalue = "LLVMConstExactSDiv"
342 external const_fdiv : llvalue -> llvalue -> llvalue = "LLVMConstFDiv"
343 external const_urem : llvalue -> llvalue -> llvalue = "LLVMConstURem"
344 external const_srem : llvalue -> llvalue -> llvalue = "LLVMConstSRem"
345 external const_frem : llvalue -> llvalue -> llvalue = "LLVMConstFRem"
346 external const_and : llvalue -> llvalue -> llvalue = "LLVMConstAnd"
347 external const_or : llvalue -> llvalue -> llvalue = "LLVMConstOr"
348 external const_xor : llvalue -> llvalue -> llvalue = "LLVMConstXor"
349 external const_icmp : Icmp.t -> llvalue -> llvalue -> llvalue
351 external const_fcmp : Fcmp.t -> llvalue -> llvalue -> llvalue
353 external const_shl : llvalue -> llvalue -> llvalue = "LLVMConstShl"
354 external const_lshr : llvalue -> llvalue -> llvalue = "LLVMConstLShr"
355 external const_ashr : llvalue -> llvalue -> llvalue = "LLVMConstAShr"
356 external const_gep : llvalue -> llvalue array -> llvalue = "llvm_const_gep"
357 external const_in_bounds_gep : llvalue -> llvalue array -> llvalue
358 = "llvm_const_in_bounds_gep"
359 external const_trunc : llvalue -> lltype -> llvalue = "LLVMConstTrunc"
360 external const_sext : llvalue -> lltype -> llvalue = "LLVMConstSExt"
361 external const_zext : llvalue -> lltype -> llvalue = "LLVMConstZExt"
362 external const_fptrunc : llvalue -> lltype -> llvalue = "LLVMConstFPTrunc"
363 external const_fpext : llvalue -> lltype -> llvalue = "LLVMConstFPExt"
364 external const_uitofp : llvalue -> lltype -> llvalue = "LLVMConstUIToFP"
365 external const_sitofp : llvalue -> lltype -> llvalue = "LLVMConstSIToFP"
366 external const_fptoui : llvalue -> lltype -> llvalue = "LLVMConstFPToUI"
367 external const_fptosi : llvalue -> lltype -> llvalue = "LLVMConstFPToSI"
368 external const_ptrtoint : llvalue -> lltype -> llvalue = "LLVMConstPtrToInt"
369 external const_inttoptr : llvalue -> lltype -> llvalue = "LLVMConstIntToPtr"
370 external const_bitcast : llvalue -> lltype -> llvalue = "LLVMConstBitCast"
371 external const_zext_or_bitcast : llvalue -> lltype -> llvalue
372 = "LLVMConstZExtOrBitCast"
373 external const_sext_or_bitcast : llvalue -> lltype -> llvalue
374 = "LLVMConstSExtOrBitCast"
375 external const_trunc_or_bitcast : llvalue -> lltype -> llvalue
376 = "LLVMConstTruncOrBitCast"
377 external const_pointercast : llvalue -> lltype -> llvalue
378 = "LLVMConstPointerCast"
379 external const_intcast : llvalue -> lltype -> llvalue = "LLVMConstIntCast"
380 external const_fpcast : llvalue -> lltype -> llvalue = "LLVMConstFPCast"
381 external const_select : llvalue -> llvalue -> llvalue -> llvalue
383 external const_extractelement : llvalue -> llvalue -> llvalue
384 = "LLVMConstExtractElement"
385 external const_insertelement : llvalue -> llvalue -> llvalue -> llvalue
386 = "LLVMConstInsertElement"
387 external const_shufflevector : llvalue -> llvalue -> llvalue -> llvalue
388 = "LLVMConstShuffleVector"
389 external const_extractvalue : llvalue -> int array -> llvalue
390 = "llvm_const_extractvalue"
391 external const_insertvalue : llvalue -> llvalue -> int array -> llvalue
392 = "llvm_const_insertvalue"
393 external const_inline_asm : lltype -> string -> string -> bool -> bool ->
395 = "llvm_const_inline_asm"
396 external block_address : llvalue -> llbasicblock -> llvalue = "LLVMBlockAddress"
398 (*--... Operations on global variables, functions, and aliases (globals) ...--*)
399 external global_parent : llvalue -> llmodule = "LLVMGetGlobalParent"
400 external is_declaration : llvalue -> bool = "llvm_is_declaration"
401 external linkage : llvalue -> Linkage.t = "llvm_linkage"
402 external set_linkage : Linkage.t -> llvalue -> unit = "llvm_set_linkage"
403 external section : llvalue -> string = "llvm_section"
404 external set_section : string -> llvalue -> unit = "llvm_set_section"
405 external visibility : llvalue -> Visibility.t = "llvm_visibility"
406 external set_visibility : Visibility.t -> llvalue -> unit = "llvm_set_visibility"
407 external alignment : llvalue -> int = "llvm_alignment"
408 external set_alignment : int -> llvalue -> unit = "llvm_set_alignment"
409 external is_global_constant : llvalue -> bool = "llvm_is_global_constant"
410 external set_global_constant : bool -> llvalue -> unit
411 = "llvm_set_global_constant"
413 (*--... Operations on global variables .....................................--*)
414 external declare_global : lltype -> string -> llmodule -> llvalue
415 = "llvm_declare_global"
416 external declare_qualified_global : lltype -> string -> int -> llmodule ->
418 = "llvm_declare_qualified_global"
419 external define_global : string -> llvalue -> llmodule -> llvalue
420 = "llvm_define_global"
421 external define_qualified_global : string -> llvalue -> int -> llmodule ->
423 = "llvm_define_qualified_global"
424 external lookup_global : string -> llmodule -> llvalue option
425 = "llvm_lookup_global"
426 external delete_global : llvalue -> unit = "llvm_delete_global"
427 external global_initializer : llvalue -> llvalue = "LLVMGetInitializer"
428 external set_initializer : llvalue -> llvalue -> unit = "llvm_set_initializer"
429 external remove_initializer : llvalue -> unit = "llvm_remove_initializer"
430 external is_thread_local : llvalue -> bool = "llvm_is_thread_local"
431 external set_thread_local : bool -> llvalue -> unit = "llvm_set_thread_local"
432 external global_begin : llmodule -> (llmodule, llvalue) llpos
433 = "llvm_global_begin"
434 external global_succ : llvalue -> (llmodule, llvalue) llpos
436 external global_end : llmodule -> (llmodule, llvalue) llrev_pos
438 external global_pred : llvalue -> (llmodule, llvalue) llrev_pos
441 let rec iter_global_range f i e =
442 if i = e then () else
444 | At_end _ -> raise (Invalid_argument "Invalid global variable range.")
447 iter_global_range f (global_succ bb) e
449 let iter_globals f m =
450 iter_global_range f (global_begin m) (At_end m)
452 let rec fold_left_global_range f init i e =
453 if i = e then init else
455 | At_end _ -> raise (Invalid_argument "Invalid global variable range.")
456 | Before bb -> fold_left_global_range f (f init bb) (global_succ bb) e
458 let fold_left_globals f init m =
459 fold_left_global_range f init (global_begin m) (At_end m)
461 let rec rev_iter_global_range f i e =
462 if i = e then () else
464 | At_start _ -> raise (Invalid_argument "Invalid global variable range.")
467 rev_iter_global_range f (global_pred bb) e
469 let rev_iter_globals f m =
470 rev_iter_global_range f (global_end m) (At_start m)
472 let rec fold_right_global_range f i e init =
473 if i = e then init else
475 | At_start _ -> raise (Invalid_argument "Invalid global variable range.")
476 | After bb -> fold_right_global_range f (global_pred bb) e (f bb init)
478 let fold_right_globals f m init =
479 fold_right_global_range f (global_end m) (At_start m) init
481 (*--... Operations on aliases ..............................................--*)
482 external add_alias : llmodule -> lltype -> llvalue -> string -> llvalue
485 (*--... Operations on functions ............................................--*)
486 external declare_function : string -> lltype -> llmodule -> llvalue
487 = "llvm_declare_function"
488 external define_function : string -> lltype -> llmodule -> llvalue
489 = "llvm_define_function"
490 external lookup_function : string -> llmodule -> llvalue option
491 = "llvm_lookup_function"
492 external delete_function : llvalue -> unit = "llvm_delete_function"
493 external is_intrinsic : llvalue -> bool = "llvm_is_intrinsic"
494 external function_call_conv : llvalue -> int = "llvm_function_call_conv"
495 external set_function_call_conv : int -> llvalue -> unit
496 = "llvm_set_function_call_conv"
497 external gc : llvalue -> string option = "llvm_gc"
498 external set_gc : string option -> llvalue -> unit = "llvm_set_gc"
499 external function_begin : llmodule -> (llmodule, llvalue) llpos
500 = "llvm_function_begin"
501 external function_succ : llvalue -> (llmodule, llvalue) llpos
502 = "llvm_function_succ"
503 external function_end : llmodule -> (llmodule, llvalue) llrev_pos
504 = "llvm_function_end"
505 external function_pred : llvalue -> (llmodule, llvalue) llrev_pos
506 = "llvm_function_pred"
508 let rec iter_function_range f i e =
509 if i = e then () else
511 | At_end _ -> raise (Invalid_argument "Invalid function range.")
514 iter_function_range f (function_succ fn) e
516 let iter_functions f m =
517 iter_function_range f (function_begin m) (At_end m)
519 let rec fold_left_function_range f init i e =
520 if i = e then init else
522 | At_end _ -> raise (Invalid_argument "Invalid function range.")
523 | Before fn -> fold_left_function_range f (f init fn) (function_succ fn) e
525 let fold_left_functions f init m =
526 fold_left_function_range f init (function_begin m) (At_end m)
528 let rec rev_iter_function_range f i e =
529 if i = e then () else
531 | At_start _ -> raise (Invalid_argument "Invalid function range.")
534 rev_iter_function_range f (function_pred fn) e
536 let rev_iter_functions f m =
537 rev_iter_function_range f (function_end m) (At_start m)
539 let rec fold_right_function_range f i e init =
540 if i = e then init else
542 | At_start _ -> raise (Invalid_argument "Invalid function range.")
543 | After fn -> fold_right_function_range f (function_pred fn) e (f fn init)
545 let fold_right_functions f m init =
546 fold_right_function_range f (function_end m) (At_start m) init
548 external llvm_add_function_attr : llvalue -> int -> unit
549 = "llvm_add_function_attr"
550 external llvm_remove_function_attr : llvalue -> int -> unit
551 = "llvm_remove_function_attr"
553 let pack_attr (attr:Attribute.t) : int =
555 Attribute.Zext -> 1 lsl 0
556 | Attribute.Sext -> 1 lsl 1
557 | Attribute.Noreturn -> 1 lsl 2
558 | Attribute.Inreg -> 1 lsl 3
559 | Attribute.Structret -> 1 lsl 4
560 | Attribute.Nounwind -> 1 lsl 5
561 | Attribute.Noalias -> 1 lsl 6
562 | Attribute.Byval -> 1 lsl 7
563 | Attribute.Nest -> 1 lsl 8
564 | Attribute.Readnone -> 1 lsl 9
565 | Attribute.Readonly -> 1 lsl 10
566 | Attribute.Noinline -> 1 lsl 11
567 | Attribute.Alwaysinline -> 1 lsl 12
568 | Attribute.Optsize -> 1 lsl 13
569 | Attribute.Ssp -> 1 lsl 14
570 | Attribute.Sspreq -> 1 lsl 15
571 | Attribute.Alignment n -> n lsl 16
572 | Attribute.Nocapture -> 1 lsl 21
573 | Attribute.Noredzone -> 1 lsl 22
574 | Attribute.Noimplicitfloat -> 1 lsl 23
575 | Attribute.Naked -> 1 lsl 24
576 | Attribute.Inlinehint -> 1 lsl 25
577 | Attribute.Stackalignment n -> n lsl 26
579 let add_function_attr llval attr =
580 llvm_add_function_attr llval (pack_attr attr)
582 let remove_function_attr llval attr =
583 llvm_remove_function_attr llval (pack_attr attr)
585 (*--... Operations on params ...............................................--*)
586 external params : llvalue -> llvalue array = "llvm_params"
587 external param : llvalue -> int -> llvalue = "llvm_param"
588 external param_parent : llvalue -> llvalue = "LLVMGetParamParent"
589 external param_begin : llvalue -> (llvalue, llvalue) llpos = "llvm_param_begin"
590 external param_succ : llvalue -> (llvalue, llvalue) llpos = "llvm_param_succ"
591 external param_end : llvalue -> (llvalue, llvalue) llrev_pos = "llvm_param_end"
592 external param_pred : llvalue -> (llvalue, llvalue) llrev_pos ="llvm_param_pred"
594 let rec iter_param_range f i e =
595 if i = e then () else
597 | At_end _ -> raise (Invalid_argument "Invalid parameter range.")
600 iter_param_range f (param_succ p) e
602 let iter_params f fn =
603 iter_param_range f (param_begin fn) (At_end fn)
605 let rec fold_left_param_range f init i e =
606 if i = e then init else
608 | At_end _ -> raise (Invalid_argument "Invalid parameter range.")
609 | Before p -> fold_left_param_range f (f init p) (param_succ p) e
611 let fold_left_params f init fn =
612 fold_left_param_range f init (param_begin fn) (At_end fn)
614 let rec rev_iter_param_range f i e =
615 if i = e then () else
617 | At_start _ -> raise (Invalid_argument "Invalid parameter range.")
620 rev_iter_param_range f (param_pred p) e
622 let rev_iter_params f fn =
623 rev_iter_param_range f (param_end fn) (At_start fn)
625 let rec fold_right_param_range f init i e =
626 if i = e then init else
628 | At_start _ -> raise (Invalid_argument "Invalid parameter range.")
629 | After p -> fold_right_param_range f (f p init) (param_pred p) e
631 let fold_right_params f fn init =
632 fold_right_param_range f init (param_end fn) (At_start fn)
634 external llvm_add_param_attr : llvalue -> int -> unit
635 = "llvm_add_param_attr"
636 external llvm_remove_param_attr : llvalue -> int -> unit
637 = "llvm_remove_param_attr"
639 let add_param_attr llval attr =
640 llvm_add_param_attr llval (pack_attr attr)
642 let remove_param_attr llval attr =
643 llvm_remove_param_attr llval (pack_attr attr)
645 external set_param_alignment : llvalue -> int -> unit
646 = "llvm_set_param_alignment"
648 (*--... Operations on basic blocks .........................................--*)
649 external value_of_block : llbasicblock -> llvalue = "LLVMBasicBlockAsValue"
650 external value_is_block : llvalue -> bool = "llvm_value_is_block"
651 external block_of_value : llvalue -> llbasicblock = "LLVMValueAsBasicBlock"
652 external block_parent : llbasicblock -> llvalue = "LLVMGetBasicBlockParent"
653 external basic_blocks : llvalue -> llbasicblock array = "llvm_basic_blocks"
654 external entry_block : llvalue -> llbasicblock = "LLVMGetEntryBasicBlock"
655 external delete_block : llbasicblock -> unit = "llvm_delete_block"
656 external append_block : llcontext -> string -> llvalue -> llbasicblock
657 = "llvm_append_block"
658 external insert_block : llcontext -> string -> llbasicblock -> llbasicblock
659 = "llvm_insert_block"
660 external block_begin : llvalue -> (llvalue, llbasicblock) llpos
662 external block_succ : llbasicblock -> (llvalue, llbasicblock) llpos
664 external block_end : llvalue -> (llvalue, llbasicblock) llrev_pos
666 external block_pred : llbasicblock -> (llvalue, llbasicblock) llrev_pos
669 let rec iter_block_range f i e =
670 if i = e then () else
672 | At_end _ -> raise (Invalid_argument "Invalid block range.")
675 iter_block_range f (block_succ bb) e
677 let iter_blocks f fn =
678 iter_block_range f (block_begin fn) (At_end fn)
680 let rec fold_left_block_range f init i e =
681 if i = e then init else
683 | At_end _ -> raise (Invalid_argument "Invalid block range.")
684 | Before bb -> fold_left_block_range f (f init bb) (block_succ bb) e
686 let fold_left_blocks f init fn =
687 fold_left_block_range f init (block_begin fn) (At_end fn)
689 let rec rev_iter_block_range f i e =
690 if i = e then () else
692 | At_start _ -> raise (Invalid_argument "Invalid block range.")
695 rev_iter_block_range f (block_pred bb) e
697 let rev_iter_blocks f fn =
698 rev_iter_block_range f (block_end fn) (At_start fn)
700 let rec fold_right_block_range f init i e =
701 if i = e then init else
703 | At_start _ -> raise (Invalid_argument "Invalid block range.")
704 | After bb -> fold_right_block_range f (f bb init) (block_pred bb) e
706 let fold_right_blocks f fn init =
707 fold_right_block_range f init (block_end fn) (At_start fn)
709 (*--... Operations on instructions .........................................--*)
710 external instr_parent : llvalue -> llbasicblock = "LLVMGetInstructionParent"
711 external instr_begin : llbasicblock -> (llbasicblock, llvalue) llpos
713 external instr_succ : llvalue -> (llbasicblock, llvalue) llpos
715 external instr_end : llbasicblock -> (llbasicblock, llvalue) llrev_pos
717 external instr_pred : llvalue -> (llbasicblock, llvalue) llrev_pos
720 let rec iter_instrs_range f i e =
721 if i = e then () else
723 | At_end _ -> raise (Invalid_argument "Invalid instruction range.")
726 iter_instrs_range f (instr_succ i) e
728 let iter_instrs f bb =
729 iter_instrs_range f (instr_begin bb) (At_end bb)
731 let rec fold_left_instrs_range f init i e =
732 if i = e then init else
734 | At_end _ -> raise (Invalid_argument "Invalid instruction range.")
735 | Before i -> fold_left_instrs_range f (f init i) (instr_succ i) e
737 let fold_left_instrs f init bb =
738 fold_left_instrs_range f init (instr_begin bb) (At_end bb)
740 let rec rev_iter_instrs_range f i e =
741 if i = e then () else
743 | At_start _ -> raise (Invalid_argument "Invalid instruction range.")
746 rev_iter_instrs_range f (instr_pred i) e
748 let rev_iter_instrs f bb =
749 rev_iter_instrs_range f (instr_end bb) (At_start bb)
751 let rec fold_right_instr_range f i e init =
752 if i = e then init else
754 | At_start _ -> raise (Invalid_argument "Invalid instruction range.")
755 | After i -> fold_right_instr_range f (instr_pred i) e (f i init)
757 let fold_right_instrs f bb init =
758 fold_right_instr_range f (instr_end bb) (At_start bb) init
761 (*--... Operations on call sites ...........................................--*)
762 external instruction_call_conv: llvalue -> int
763 = "llvm_instruction_call_conv"
764 external set_instruction_call_conv: int -> llvalue -> unit
765 = "llvm_set_instruction_call_conv"
767 external llvm_add_instruction_param_attr : llvalue -> int -> int -> unit
768 = "llvm_add_instruction_param_attr"
769 external llvm_remove_instruction_param_attr : llvalue -> int -> int -> unit
770 = "llvm_remove_instruction_param_attr"
772 let add_instruction_param_attr llval i attr =
773 llvm_add_instruction_param_attr llval i (pack_attr attr)
775 let remove_instruction_param_attr llval i attr =
776 llvm_remove_instruction_param_attr llval i (pack_attr attr)
778 (*--... Operations on call instructions (only) .............................--*)
779 external is_tail_call : llvalue -> bool = "llvm_is_tail_call"
780 external set_tail_call : bool -> llvalue -> unit = "llvm_set_tail_call"
782 (*--... Operations on phi nodes ............................................--*)
783 external add_incoming : (llvalue * llbasicblock) -> llvalue -> unit
784 = "llvm_add_incoming"
785 external incoming : llvalue -> (llvalue * llbasicblock) list = "llvm_incoming"
788 (*===-- Instruction builders ----------------------------------------------===*)
789 external builder : llcontext -> llbuilder = "llvm_builder"
790 external position_builder : (llbasicblock, llvalue) llpos -> llbuilder -> unit
791 = "llvm_position_builder"
792 external insertion_block : llbuilder -> llbasicblock = "llvm_insertion_block"
793 external insert_into_builder : llvalue -> string -> llbuilder -> unit
794 = "llvm_insert_into_builder"
796 let builder_at context ip =
797 let b = builder context in
798 position_builder ip b;
801 let builder_before context i = builder_at context (Before i)
802 let builder_at_end context bb = builder_at context (At_end bb)
804 let position_before i = position_builder (Before i)
805 let position_at_end bb = position_builder (At_end bb)
808 (*--... Metadata ...........................................................--*)
809 external set_current_debug_location : llbuilder -> llvalue -> unit
810 = "llvm_set_current_debug_location"
811 external clear_current_debug_location : llbuilder -> unit
812 = "llvm_clear_current_debug_location"
813 external current_debug_location : llbuilder -> llvalue option
814 = "llvm_current_debug_location"
815 external set_inst_debug_location : llbuilder -> llvalue -> unit
816 = "llvm_set_inst_debug_location"
819 (*--... Terminators ........................................................--*)
820 external build_ret_void : llbuilder -> llvalue = "llvm_build_ret_void"
821 external build_ret : llvalue -> llbuilder -> llvalue = "llvm_build_ret"
822 external build_aggregate_ret : llvalue array -> llbuilder -> llvalue
823 = "llvm_build_aggregate_ret"
824 external build_br : llbasicblock -> llbuilder -> llvalue = "llvm_build_br"
825 external build_cond_br : llvalue -> llbasicblock -> llbasicblock -> llbuilder ->
826 llvalue = "llvm_build_cond_br"
827 external build_switch : llvalue -> llbasicblock -> int -> llbuilder -> llvalue
828 = "llvm_build_switch"
829 external add_case : llvalue -> llvalue -> llbasicblock -> unit
831 external build_indirect_br : llvalue -> int -> llbuilder -> llvalue
832 = "llvm_build_indirect_br"
833 external add_destination : llvalue -> llbasicblock -> unit
834 = "llvm_add_destination"
835 external build_invoke : llvalue -> llvalue array -> llbasicblock ->
836 llbasicblock -> string -> llbuilder -> llvalue
837 = "llvm_build_invoke_bc" "llvm_build_invoke_nat"
838 external build_unwind : llbuilder -> llvalue = "llvm_build_unwind"
839 external build_unreachable : llbuilder -> llvalue = "llvm_build_unreachable"
841 (*--... Arithmetic .........................................................--*)
842 external build_add : llvalue -> llvalue -> string -> llbuilder -> llvalue
844 external build_nsw_add : llvalue -> llvalue -> string -> llbuilder -> llvalue
845 = "llvm_build_nsw_add"
846 external build_nuw_add : llvalue -> llvalue -> string -> llbuilder -> llvalue
847 = "llvm_build_nuw_add"
848 external build_fadd : llvalue -> llvalue -> string -> llbuilder -> llvalue
850 external build_sub : llvalue -> llvalue -> string -> llbuilder -> llvalue
852 external build_nsw_sub : llvalue -> llvalue -> string -> llbuilder -> llvalue
853 = "llvm_build_nsw_sub"
854 external build_nuw_sub : llvalue -> llvalue -> string -> llbuilder -> llvalue
855 = "llvm_build_nuw_sub"
856 external build_fsub : llvalue -> llvalue -> string -> llbuilder -> llvalue
858 external build_mul : llvalue -> llvalue -> string -> llbuilder -> llvalue
860 external build_nsw_mul : llvalue -> llvalue -> string -> llbuilder -> llvalue
861 = "llvm_build_nsw_mul"
862 external build_nuw_mul : llvalue -> llvalue -> string -> llbuilder -> llvalue
863 = "llvm_build_nuw_mul"
864 external build_fmul : llvalue -> llvalue -> string -> llbuilder -> llvalue
866 external build_udiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
868 external build_sdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
870 external build_exact_sdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
871 = "llvm_build_exact_sdiv"
872 external build_fdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
874 external build_urem : llvalue -> llvalue -> string -> llbuilder -> llvalue
876 external build_srem : llvalue -> llvalue -> string -> llbuilder -> llvalue
878 external build_frem : llvalue -> llvalue -> string -> llbuilder -> llvalue
880 external build_shl : llvalue -> llvalue -> string -> llbuilder -> llvalue
882 external build_lshr : llvalue -> llvalue -> string -> llbuilder -> llvalue
884 external build_ashr : llvalue -> llvalue -> string -> llbuilder -> llvalue
886 external build_and : llvalue -> llvalue -> string -> llbuilder -> llvalue
888 external build_or : llvalue -> llvalue -> string -> llbuilder -> llvalue
890 external build_xor : llvalue -> llvalue -> string -> llbuilder -> llvalue
892 external build_neg : llvalue -> string -> llbuilder -> llvalue
894 external build_nsw_neg : llvalue -> string -> llbuilder -> llvalue
895 = "llvm_build_nsw_neg"
896 external build_nuw_neg : llvalue -> string -> llbuilder -> llvalue
897 = "llvm_build_nuw_neg"
898 external build_fneg : llvalue -> string -> llbuilder -> llvalue
900 external build_not : llvalue -> string -> llbuilder -> llvalue
903 (*--... Memory .............................................................--*)
904 external build_alloca : lltype -> string -> llbuilder -> llvalue
905 = "llvm_build_alloca"
906 external build_array_alloca : lltype -> llvalue -> string -> llbuilder ->
907 llvalue = "llvm_build_array_alloca"
908 external build_load : llvalue -> string -> llbuilder -> llvalue
910 external build_store : llvalue -> llvalue -> llbuilder -> llvalue
912 external build_gep : llvalue -> llvalue array -> string -> llbuilder -> llvalue
914 external build_in_bounds_gep : llvalue -> llvalue array -> string ->
915 llbuilder -> llvalue = "llvm_build_in_bounds_gep"
916 external build_struct_gep : llvalue -> int -> string -> llbuilder -> llvalue
917 = "llvm_build_struct_gep"
919 external build_global_string : string -> string -> llbuilder -> llvalue
920 = "llvm_build_global_string"
921 external build_global_stringptr : string -> string -> llbuilder -> llvalue
922 = "llvm_build_global_stringptr"
924 (*--... Casts ..............................................................--*)
925 external build_trunc : llvalue -> lltype -> string -> llbuilder -> llvalue
927 external build_zext : llvalue -> lltype -> string -> llbuilder -> llvalue
929 external build_sext : llvalue -> lltype -> string -> llbuilder -> llvalue
931 external build_fptoui : llvalue -> lltype -> string -> llbuilder -> llvalue
932 = "llvm_build_fptoui"
933 external build_fptosi : llvalue -> lltype -> string -> llbuilder -> llvalue
934 = "llvm_build_fptosi"
935 external build_uitofp : llvalue -> lltype -> string -> llbuilder -> llvalue
936 = "llvm_build_uitofp"
937 external build_sitofp : llvalue -> lltype -> string -> llbuilder -> llvalue
938 = "llvm_build_sitofp"
939 external build_fptrunc : llvalue -> lltype -> string -> llbuilder -> llvalue
940 = "llvm_build_fptrunc"
941 external build_fpext : llvalue -> lltype -> string -> llbuilder -> llvalue
943 external build_ptrtoint : llvalue -> lltype -> string -> llbuilder -> llvalue
944 = "llvm_build_prttoint"
945 external build_inttoptr : llvalue -> lltype -> string -> llbuilder -> llvalue
946 = "llvm_build_inttoptr"
947 external build_bitcast : llvalue -> lltype -> string -> llbuilder -> llvalue
948 = "llvm_build_bitcast"
949 external build_zext_or_bitcast : llvalue -> lltype -> string -> llbuilder ->
950 llvalue = "llvm_build_zext_or_bitcast"
951 external build_sext_or_bitcast : llvalue -> lltype -> string -> llbuilder ->
952 llvalue = "llvm_build_sext_or_bitcast"
953 external build_trunc_or_bitcast : llvalue -> lltype -> string -> llbuilder ->
954 llvalue = "llvm_build_trunc_or_bitcast"
955 external build_pointercast : llvalue -> lltype -> string -> llbuilder -> llvalue
956 = "llvm_build_pointercast"
957 external build_intcast : llvalue -> lltype -> string -> llbuilder -> llvalue
958 = "llvm_build_intcast"
959 external build_fpcast : llvalue -> lltype -> string -> llbuilder -> llvalue
960 = "llvm_build_fpcast"
962 (*--... Comparisons ........................................................--*)
963 external build_icmp : Icmp.t -> llvalue -> llvalue -> string ->
964 llbuilder -> llvalue = "llvm_build_icmp"
965 external build_fcmp : Fcmp.t -> llvalue -> llvalue -> string ->
966 llbuilder -> llvalue = "llvm_build_fcmp"
968 (*--... Miscellaneous instructions .........................................--*)
969 external build_phi : (llvalue * llbasicblock) list -> string -> llbuilder ->
970 llvalue = "llvm_build_phi"
971 external build_call : llvalue -> llvalue array -> string -> llbuilder -> llvalue
973 external build_select : llvalue -> llvalue -> llvalue -> string -> llbuilder ->
974 llvalue = "llvm_build_select"
975 external build_va_arg : llvalue -> lltype -> string -> llbuilder -> llvalue
976 = "llvm_build_va_arg"
977 external build_extractelement : llvalue -> llvalue -> string -> llbuilder ->
978 llvalue = "llvm_build_extractelement"
979 external build_insertelement : llvalue -> llvalue -> llvalue -> string ->
980 llbuilder -> llvalue = "llvm_build_insertelement"
981 external build_shufflevector : llvalue -> llvalue -> llvalue -> string ->
982 llbuilder -> llvalue = "llvm_build_shufflevector"
983 external build_extractvalue : llvalue -> int -> string -> llbuilder -> llvalue
984 = "llvm_build_extractvalue"
985 external build_insertvalue : llvalue -> llvalue -> int -> string -> llbuilder ->
986 llvalue = "llvm_build_insertvalue"
988 external build_is_null : llvalue -> string -> llbuilder -> llvalue
989 = "llvm_build_is_null"
990 external build_is_not_null : llvalue -> string -> llbuilder -> llvalue
991 = "llvm_build_is_not_null"
992 external build_ptrdiff : llvalue -> llvalue -> string -> llbuilder -> llvalue
993 = "llvm_build_ptrdiff"
996 (*===-- Memory buffers ----------------------------------------------------===*)
998 module MemoryBuffer = struct
999 external of_file : string -> llmemorybuffer = "llvm_memorybuffer_of_file"
1000 external of_stdin : unit -> llmemorybuffer = "llvm_memorybuffer_of_stdin"
1001 external dispose : llmemorybuffer -> unit = "llvm_memorybuffer_dispose"
1005 (*===-- Pass Manager ------------------------------------------------------===*)
1007 module PassManager = struct
1009 type any = [ `Module | `Function ]
1010 external create : unit -> [ `Module ] t = "llvm_passmanager_create"
1011 external create_function : llmodule -> [ `Function ] t
1012 = "LLVMCreateFunctionPassManager"
1013 external run_module : llmodule -> [ `Module ] t -> bool
1014 = "llvm_passmanager_run_module"
1015 external initialize : [ `Function ] t -> bool = "llvm_passmanager_initialize"
1016 external run_function : llvalue -> [ `Function ] t -> bool
1017 = "llvm_passmanager_run_function"
1018 external finalize : [ `Function ] t -> bool = "llvm_passmanager_finalize"
1019 external dispose : [< any ] t -> unit = "llvm_passmanager_dispose"
1023 (*===-- Non-Externs -------------------------------------------------------===*)
1024 (* These functions are built using the externals, so must be declared late. *)
1026 let concat2 sep arr =
1028 if 0 < Array.length arr then begin
1030 for i = 1 to (Array.length arr) - 1 do
1031 s := !s ^ sep ^ arr.(i)
1036 let rec string_of_lltype ty =
1037 (* FIXME: stop infinite recursion! :) *)
1038 match classify_type ty with
1039 TypeKind.Integer -> "i" ^ string_of_int (integer_bitwidth ty)
1040 | TypeKind.Pointer -> (string_of_lltype (element_type ty)) ^ "*"
1041 | TypeKind.Struct ->
1042 let s = "{ " ^ (concat2 ", " (
1043 Array.map string_of_lltype (struct_element_types ty)
1048 | TypeKind.Array -> "[" ^ (string_of_int (array_length ty)) ^
1049 " x " ^ (string_of_lltype (element_type ty)) ^ "]"
1050 | TypeKind.Vector -> "<" ^ (string_of_int (vector_size ty)) ^
1051 " x " ^ (string_of_lltype (element_type ty)) ^ ">"
1052 | TypeKind.Opaque -> "opaque"
1053 | TypeKind.Function -> string_of_lltype (return_type ty) ^
1054 " (" ^ (concat2 ", " (
1055 Array.map string_of_lltype (param_types ty)
1057 | TypeKind.Label -> "label"
1058 | TypeKind.Ppc_fp128 -> "ppc_fp128"
1059 | TypeKind.Fp128 -> "fp128"
1060 | TypeKind.X86fp80 -> "x86_fp80"
1061 | TypeKind.Double -> "double"
1062 | TypeKind.Float -> "float"
1063 | TypeKind.Void -> "void"
1064 | TypeKind.Metadata -> "metadata"