1 (*===-- tools/ml/llvm.ml - LLVM Ocaml Interface ---------------------------===*
3 * The LLVM Compiler Infrastructure
5 * This file was developed by Gordon Henriksen and is distributed under the
6 * University of Illinois Open Source License. See LICENSE.TXT for details.
8 *===----------------------------------------------------------------------===
10 * This interface provides an ocaml API for the LLVM intermediate
11 * representation, the classes in the VMCore library.
13 *===----------------------------------------------------------------------===*)
16 (* These abstract types correlate directly to the LLVM VMCore classes. *)
20 type llbasicblock (* These are actually values, but
21 benefit from type checking. *)
48 | External_weak_linkage
54 | Protected_visibility
59 val x86_stdcallcc : int
60 val x86_fastcallcc : int
93 (*===-- Modules -----------------------------------------------------------===*)
95 (* Creates a module with the supplied module ID. Modules are not garbage
96 collected; it is mandatory to call dispose_module to free memory. *)
97 external create_module : string -> llmodule = "llvm_create_module"
99 (* Disposes a module. All references to subordinate objects are invalidated;
100 referencing them will invoke undefined behavior. *)
101 external dispose_module : llmodule -> unit = "llvm_dispose_module"
103 (* Adds a named type to the module's symbol table. Returns true if successful.
104 If such a name already exists, then no entry is added and returns false. *)
105 external define_type_name : string -> lltype -> llmodule -> bool
106 = "llvm_add_type_name"
108 external delete_type_name : string -> llmodule -> unit
109 = "llvm_delete_type_name"
112 (*===-- Types -------------------------------------------------------------===*)
113 external classify_type : lltype -> type_kind = "llvm_classify_type"
114 external refine_abstract_type : lltype -> lltype -> unit
115 = "llvm_refine_abstract_type"
116 val string_of_lltype : lltype -> string
118 (*--... Operations on integer types ........................................--*)
121 val i16_type : lltype
122 val i32_type : lltype
123 val i64_type : lltype
124 external make_integer_type : int -> lltype = "llvm_make_integer_type"
125 external integer_bitwidth : lltype -> int = "llvm_integer_bitwidth"
127 (*--... Operations on real types ...........................................--*)
128 val float_type : lltype
129 val double_type : lltype
130 val x86fp80_type : lltype
131 val fp128_type : lltype
132 val ppc_fp128_type : lltype
134 (*--... Operations on function types .......................................--*)
135 (* FIXME: handle parameter attributes *)
136 external make_function_type : lltype -> lltype array -> bool -> lltype
137 = "llvm_make_function_type"
138 external is_var_arg : lltype -> bool = "llvm_is_var_arg"
139 external return_type : lltype -> lltype = "llvm_return_type"
140 external param_types : lltype -> lltype array = "llvm_param_types"
142 (*--... Operations on struct types .........................................--*)
143 external make_struct_type : lltype array -> bool -> lltype
144 = "llvm_make_struct_type"
145 external element_types : lltype -> lltype array = "llvm_element_types"
146 external is_packed : lltype -> bool = "llvm_is_packed"
148 (*--... Operations on pointer, vector, and array types .....................--*)
149 external make_array_type : lltype -> int -> lltype = "llvm_make_array_type"
150 external make_pointer_type : lltype -> lltype = "llvm_make_pointer_type"
151 external make_vector_type : lltype -> int -> lltype = "llvm_make_vector_type"
153 external element_type : lltype -> lltype = "llvm_element_type"
154 external array_length : lltype -> int = "llvm_array_length"
155 external vector_size : lltype -> int = "llvm_vector_size"
157 (*--... Operations on other types ..........................................--*)
158 external make_opaque_type : unit -> lltype = "llvm_make_opaque_type"
159 val void_type : lltype
160 val label_type : lltype
163 (*===-- Values ------------------------------------------------------------===*)
164 external type_of : llvalue -> lltype = "llvm_type_of"
165 external value_name : llvalue -> string = "llvm_value_name"
166 external set_value_name : string -> llvalue -> unit = "llvm_set_value_name"
168 (*--... Operations on constants of (mostly) any type .......................--*)
169 external is_constant : llvalue -> bool = "llvm_is_constant"
170 external make_null : lltype -> llvalue = "LLVMGetNull"
171 external make_all_ones : (*int|vec*)lltype -> llvalue = "LLVMGetAllOnes"
172 external make_undef : lltype -> llvalue = "LLVMGetUndef"
173 external is_null : llvalue -> bool = "llvm_is_null"
174 external is_undef : llvalue -> bool = "llvm_is_undef"
176 (*--... Operations on scalar constants .....................................--*)
177 external make_int_constant : lltype -> int -> bool -> llvalue
178 = "llvm_make_int_constant"
179 external make_int64_constant : lltype -> Int64.t -> bool -> llvalue
180 = "llvm_make_int64_constant"
181 external make_real_constant : lltype -> float -> llvalue
182 = "llvm_make_real_constant"
184 (*--... Operations on composite constants ..................................--*)
185 external make_string_constant : string -> bool -> llvalue
186 = "llvm_make_string_constant"
187 external make_array_constant : lltype -> llvalue array -> llvalue
188 = "llvm_make_array_constant"
189 external make_struct_constant : llvalue array -> bool -> llvalue
190 = "llvm_make_struct_constant"
191 external make_vector_constant : llvalue array -> llvalue
192 = "llvm_make_vector_constant"
194 (*--... Operations on global variables, functions, and aliases (globals) ...--*)
195 external is_declaration : llvalue -> bool = "llvm_is_declaration"
196 external linkage : llvalue -> linkage = "llvm_linkage"
197 external set_linkage : linkage -> llvalue -> unit = "llvm_set_linkage"
198 external section : llvalue -> string = "llvm_section"
199 external set_section : string -> llvalue -> unit = "llvm_set_section"
200 external visibility : llvalue -> visibility = "llvm_visibility"
201 external set_visibility : visibility -> llvalue -> unit = "llvm_set_visibility"
202 external alignment : llvalue -> int = "llvm_alignment"
203 external set_alignment : int -> llvalue -> unit = "llvm_set_alignment"
205 (*--... Operations on global variables .....................................--*)
206 external declare_global : lltype -> string -> llmodule -> llvalue
207 = "llvm_declare_global"
208 external define_global : string -> llvalue -> llmodule -> llvalue
209 = "llvm_define_global"
210 external delete_global : llvalue -> unit = "llvm_delete_global"
211 external global_initializer : llvalue -> llvalue = "LLVMGetInitializer"
212 external set_initializer : llvalue -> llvalue -> unit = "llvm_set_initializer"
213 external remove_initializer : llvalue -> unit = "llvm_remove_initializer"
214 external is_thread_local : llvalue -> bool = "llvm_is_thread_local"
215 external set_thread_local : bool -> llvalue -> unit = "llvm_set_thread_local"
217 (*--... Operations on functions ............................................--*)
218 external declare_function : string -> lltype -> llmodule -> llvalue
219 = "llvm_declare_function"
220 external define_function : string -> lltype -> llmodule -> llvalue
221 = "llvm_define_function"
222 external delete_function : llvalue -> unit = "llvm_delete_function"
223 external params : llvalue -> llvalue array = "llvm_params"
224 external param : llvalue -> int -> llvalue = "llvm_param"
225 external is_intrinsic : llvalue -> bool = "llvm_is_intrinsic"
226 external function_call_conv : llvalue -> int = "llvm_function_call_conv"
227 external set_function_call_conv : int -> llvalue -> unit
228 = "llvm_set_function_call_conv"
230 (*--... Operations on basic blocks .........................................--*)
231 external basic_blocks : llvalue -> llbasicblock array = "llvm_basic_blocks"
232 external entry_block : llvalue -> llbasicblock = "LLVMGetEntryBasicBlock"
233 external delete_block : llbasicblock -> unit = "llvm_delete_block"
234 external append_block : string -> llvalue -> llbasicblock = "llvm_append_block"
235 external insert_block : string -> llbasicblock -> llbasicblock
236 = "llvm_insert_block"
237 external value_of_block : llbasicblock -> llvalue = "LLVMBasicBlockAsValue"
238 external value_is_block : llvalue -> bool = "llvm_value_is_block"
239 external block_of_value : llvalue -> llbasicblock = "LLVMValueAsBasicBlock"
242 (*===-- Instruction builders ----------------------------------------------===*)
243 external builder_before : llvalue -> llbuilder = "llvm_builder_before"
244 external builder_at_end : llbasicblock -> llbuilder = "llvm_builder_at_end"
245 external position_before : llvalue -> llbuilder -> unit = "llvm_position_before"
246 external position_at_end : llbasicblock -> llbuilder -> unit
247 = "llvm_position_at_end"
249 (*--... Terminators ........................................................--*)
250 external build_ret_void : llbuilder -> llvalue = "llvm_build_ret_void"
251 external build_ret : llvalue -> llbuilder -> llvalue = "llvm_build_ret"
252 external build_br : llbasicblock -> llbuilder -> llvalue = "llvm_build_br"
253 external build_cond_br : llvalue -> llbasicblock -> llbasicblock -> llbuilder ->
254 llvalue = "llvm_build_cond_br"
255 external build_switch : llvalue -> llbasicblock -> int -> llbuilder -> llvalue
256 = "llvm_build_switch"
257 external build_invoke : llvalue -> llvalue array -> llbasicblock ->
258 llbasicblock -> string -> llbuilder -> llvalue
259 = "llvm_build_invoke_bc" "llvm_build_invoke_nat"
260 external build_unwind : llbuilder -> llvalue = "llvm_build_unwind"
261 external build_unreachable : llbuilder -> llvalue = "llvm_build_unreachable"
263 (*--... Arithmetic .........................................................--*)
264 external build_add : llvalue -> llvalue -> string -> llbuilder -> llvalue
266 external build_sub : llvalue -> llvalue -> string -> llbuilder -> llvalue
268 external build_mul : llvalue -> llvalue -> string -> llbuilder -> llvalue
270 external build_udiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
272 external build_sdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
274 external build_fdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
276 external build_urem : llvalue -> llvalue -> string -> llbuilder -> llvalue
278 external build_srem : llvalue -> llvalue -> string -> llbuilder -> llvalue
280 external build_frem : llvalue -> llvalue -> string -> llbuilder -> llvalue
282 external build_shl : llvalue -> llvalue -> string -> llbuilder -> llvalue
284 external build_lshr : llvalue -> llvalue -> string -> llbuilder -> llvalue
286 external build_ashr : llvalue -> llvalue -> string -> llbuilder -> llvalue
288 external build_and : llvalue -> llvalue -> string -> llbuilder -> llvalue
290 external build_or : llvalue -> llvalue -> string -> llbuilder -> llvalue
292 external build_xor : llvalue -> llvalue -> string -> llbuilder -> llvalue
294 external build_neg : llvalue -> string -> llbuilder -> llvalue
296 external build_not : llvalue -> string -> llbuilder -> llvalue
299 (*--... Memory .............................................................--*)
300 external build_malloc : lltype -> string -> llbuilder -> llvalue
301 = "llvm_build_malloc"
302 external build_array_malloc : lltype -> llvalue -> string -> llbuilder ->
303 llvalue = "llvm_build_array_malloc"
304 external build_alloca : lltype -> string -> llbuilder -> llvalue
305 = "llvm_build_alloca"
306 external build_array_alloca : lltype -> llvalue -> string -> llbuilder ->
307 llvalue = "llvm_build_array_alloca"
308 external build_free : llvalue -> llbuilder -> llvalue = "llvm_build_free"
309 external build_load : llvalue -> string -> llbuilder -> llvalue
311 external build_store : llvalue -> llvalue -> llbuilder -> llvalue
313 external build_gep : llvalue -> llvalue array -> string -> llbuilder -> llvalue
316 (*--... Casts ..............................................................--*)
317 external build_trunc : llvalue -> lltype -> string -> llbuilder -> llvalue
319 external build_zext : llvalue -> lltype -> string -> llbuilder -> llvalue
321 external build_sext : llvalue -> lltype -> string -> llbuilder -> llvalue
323 external build_fptoui : llvalue -> lltype -> string -> llbuilder -> llvalue
324 = "llvm_build_fptoui"
325 external build_fptosi : llvalue -> lltype -> string -> llbuilder -> llvalue
326 = "llvm_build_fptosi"
327 external build_uitofp : llvalue -> lltype -> string -> llbuilder -> llvalue
328 = "llvm_build_uitofp"
329 external build_sitofp : llvalue -> lltype -> string -> llbuilder -> llvalue
330 = "llvm_build_sitofp"
331 external build_fptrunc : llvalue -> lltype -> string -> llbuilder -> llvalue
332 = "llvm_build_fptrunc"
333 external build_fpext : llvalue -> lltype -> string -> llbuilder -> llvalue
335 external build_ptrtoint : llvalue -> lltype -> string -> llbuilder -> llvalue
336 = "llvm_build_prttoint"
337 external build_inttoptr : llvalue -> lltype -> string -> llbuilder -> llvalue
338 = "llvm_build_inttoptr"
339 external build_bitcast : llvalue -> lltype -> string -> llbuilder -> llvalue
340 = "llvm_build_bitcast"
342 (*--... Comparisons ........................................................--*)
343 external build_icmp : int_predicate -> llvalue -> llvalue -> string ->
344 llbuilder -> llvalue = "llvm_build_icmp"
345 external build_fcmp : real_predicate -> llvalue -> llvalue -> string ->
346 llbuilder -> llvalue = "llvm_build_fcmp"
348 (*--... Miscellaneous instructions .........................................--*)
349 external build_phi : lltype -> string -> llbuilder -> llvalue = "llvm_build_phi"
350 external build_call : llvalue -> llvalue array -> string -> llbuilder -> llvalue
352 external build_select : llvalue -> llvalue -> llvalue -> string -> llbuilder ->
353 llvalue = "llvm_build_select"
354 external build_va_arg : llvalue -> lltype -> string -> llbuilder -> llvalue
355 = "llvm_build_va_arg"
356 external build_extractelement : llvalue -> llvalue -> string -> llbuilder ->
357 llvalue = "llvm_build_extractelement"
358 external build_insertelement : llvalue -> llvalue -> llvalue -> string ->
359 llbuilder -> llvalue = "llvm_build_insertelement"
360 external build_shufflevector : llvalue -> llvalue -> llvalue -> string ->
361 llbuilder -> llvalue = "llvm_build_shufflevector"