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