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