1 /*===-- target_ocaml.c - LLVM OCaml Glue ------------------------*- C++ -*-===*\
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 |*===----------------------------------------------------------------------===*|
10 |* This file glues LLVM's OCaml interface to its C interface. These functions *|
11 |* are by and large transparent wrappers to the corresponding C functions. *|
13 |* Note that these functions intentionally take liberties with the CAMLparamX *|
14 |* macros, since most of the parameters are not GC heap objects. *|
16 \*===----------------------------------------------------------------------===*/
18 #include "llvm-c/Target.h"
19 #include "llvm-c/TargetMachine.h"
20 #include "caml/alloc.h"
21 #include "caml/fail.h"
22 #include "caml/memory.h"
23 #include "caml/custom.h"
25 /*===---- Exceptions ------------------------------------------------------===*/
27 static value llvm_target_error_exn;
29 CAMLprim value llvm_register_target_exns(value Error) {
30 llvm_target_error_exn = Field(Error, 0);
31 register_global_root(&llvm_target_error_exn);
35 static void llvm_raise(value Prototype, char *Message) {
36 CAMLparam1(Prototype);
37 CAMLlocal1(CamlMessage);
39 CamlMessage = copy_string(Message);
40 LLVMDisposeMessage(Message);
42 raise_with_arg(Prototype, CamlMessage);
43 abort(); /* NOTREACHED */
45 CAMLnoreturn; /* Silences warnings, but is missing in some versions. */
49 static value llvm_string_of_message(char* Message) {
50 value String = caml_copy_string(Message);
51 LLVMDisposeMessage(Message);
56 /*===---- Data Layout -----------------------------------------------------===*/
58 #define DataLayout_val(v) (*(LLVMTargetDataRef *)(Data_custom_val(v)))
60 static void llvm_finalize_data_layout(value DataLayout) {
61 LLVMDisposeTargetData(DataLayout_val(DataLayout));
64 static struct custom_operations llvm_data_layout_ops = {
65 (char *) "LLVMDataLayout",
66 llvm_finalize_data_layout,
67 custom_compare_default,
69 custom_serialize_default,
70 custom_deserialize_default
71 #ifdef custom_compare_ext_default
72 , custom_compare_ext_default
76 value llvm_alloc_data_layout(LLVMTargetDataRef DataLayout) {
77 value V = alloc_custom(&llvm_data_layout_ops, sizeof(LLVMTargetDataRef),
79 DataLayout_val(V) = DataLayout;
83 /* string -> DataLayout.t */
84 CAMLprim value llvm_datalayout_of_string(value StringRep) {
85 return llvm_alloc_data_layout(LLVMCreateTargetData(String_val(StringRep)));
88 /* DataLayout.t -> string */
89 CAMLprim value llvm_datalayout_as_string(value TD) {
90 char *StringRep = LLVMCopyStringRepOfTargetData(DataLayout_val(TD));
91 value Copy = copy_string(StringRep);
92 LLVMDisposeMessage(StringRep);
96 /* [<Llvm.PassManager.any] Llvm.PassManager.t -> DataLayout.t -> unit */
97 CAMLprim value llvm_datalayout_add_to_pass_manager(LLVMPassManagerRef PM,
99 LLVMAddTargetData(DataLayout_val(DL), PM);
103 /* DataLayout.t -> Endian.t */
104 CAMLprim value llvm_datalayout_byte_order(value DL) {
105 return Val_int(LLVMByteOrder(DataLayout_val(DL)));
108 /* DataLayout.t -> int */
109 CAMLprim value llvm_datalayout_pointer_size(value DL) {
110 return Val_int(LLVMPointerSize(DataLayout_val(DL)));
113 /* Llvm.llcontext -> DataLayout.t -> Llvm.lltype */
114 CAMLprim LLVMTypeRef llvm_datalayout_intptr_type(LLVMContextRef C, value DL) {
115 return LLVMIntPtrTypeInContext(C, DataLayout_val(DL));;
118 /* int -> DataLayout.t -> int */
119 CAMLprim value llvm_datalayout_qualified_pointer_size(value AS, value DL) {
120 return Val_int(LLVMPointerSizeForAS(DataLayout_val(DL), Int_val(AS)));
123 /* Llvm.llcontext -> int -> DataLayout.t -> Llvm.lltype */
124 CAMLprim LLVMTypeRef llvm_datalayout_qualified_intptr_type(LLVMContextRef C,
127 return LLVMIntPtrTypeForASInContext(C, DataLayout_val(DL), Int_val(AS));
130 /* Llvm.lltype -> DataLayout.t -> Int64.t */
131 CAMLprim value llvm_datalayout_size_in_bits(LLVMTypeRef Ty, value DL) {
132 return caml_copy_int64(LLVMSizeOfTypeInBits(DataLayout_val(DL), Ty));
135 /* Llvm.lltype -> DataLayout.t -> Int64.t */
136 CAMLprim value llvm_datalayout_store_size(LLVMTypeRef Ty, value DL) {
137 return caml_copy_int64(LLVMStoreSizeOfType(DataLayout_val(DL), Ty));
140 /* Llvm.lltype -> DataLayout.t -> Int64.t */
141 CAMLprim value llvm_datalayout_abi_size(LLVMTypeRef Ty, value DL) {
142 return caml_copy_int64(LLVMABISizeOfType(DataLayout_val(DL), Ty));
145 /* Llvm.lltype -> DataLayout.t -> int */
146 CAMLprim value llvm_datalayout_abi_align(LLVMTypeRef Ty, value DL) {
147 return Val_int(LLVMABIAlignmentOfType(DataLayout_val(DL), Ty));
150 /* Llvm.lltype -> DataLayout.t -> int */
151 CAMLprim value llvm_datalayout_stack_align(LLVMTypeRef Ty, value DL) {
152 return Val_int(LLVMCallFrameAlignmentOfType(DataLayout_val(DL), Ty));
155 /* Llvm.lltype -> DataLayout.t -> int */
156 CAMLprim value llvm_datalayout_preferred_align(LLVMTypeRef Ty, value DL) {
157 return Val_int(LLVMPreferredAlignmentOfType(DataLayout_val(DL), Ty));
160 /* Llvm.llvalue -> DataLayout.t -> int */
161 CAMLprim value llvm_datalayout_preferred_align_of_global(LLVMValueRef GlobalVar,
163 return Val_int(LLVMPreferredAlignmentOfGlobal(DataLayout_val(DL), GlobalVar));
166 /* Llvm.lltype -> Int64.t -> DataLayout.t -> int */
167 CAMLprim value llvm_datalayout_element_at_offset(LLVMTypeRef Ty, value Offset,
169 return Val_int(LLVMElementAtOffset(DataLayout_val(DL), Ty,
173 /* Llvm.lltype -> int -> DataLayout.t -> Int64.t */
174 CAMLprim value llvm_datalayout_offset_of_element(LLVMTypeRef Ty, value Index,
176 return caml_copy_int64(LLVMOffsetOfElement(DataLayout_val(DL), Ty,
180 /*===---- Target ----------------------------------------------------------===*/
182 static value llvm_target_option(LLVMTargetRef Target) {
184 value Result = caml_alloc_small(1, 0);
185 Store_field(Result, 0, (value) Target);
193 CAMLprim value llvm_target_default_triple(value Unit) {
194 char *TripleCStr = LLVMGetDefaultTargetTriple();
195 value TripleStr = caml_copy_string(TripleCStr);
196 LLVMDisposeMessage(TripleCStr);
201 /* unit -> Target.t option */
202 CAMLprim value llvm_target_first(value Unit) {
203 return llvm_target_option(LLVMGetFirstTarget());
206 /* Target.t -> Target.t option */
207 CAMLprim value llvm_target_succ(LLVMTargetRef Target) {
208 return llvm_target_option(LLVMGetNextTarget(Target));
211 /* string -> Target.t option */
212 CAMLprim value llvm_target_by_name(value Name) {
213 return llvm_target_option(LLVMGetTargetFromName(String_val(Name)));
216 /* string -> Target.t */
217 CAMLprim LLVMTargetRef llvm_target_by_triple(value Triple) {
221 if(LLVMGetTargetFromTriple(String_val(Triple), &T, &Error))
222 llvm_raise(llvm_target_error_exn, Error);
227 /* Target.t -> string */
228 CAMLprim value llvm_target_name(LLVMTargetRef Target) {
229 return caml_copy_string(LLVMGetTargetName(Target));
232 /* Target.t -> string */
233 CAMLprim value llvm_target_description(LLVMTargetRef Target) {
234 return caml_copy_string(LLVMGetTargetDescription(Target));
237 /* Target.t -> bool */
238 CAMLprim value llvm_target_has_jit(LLVMTargetRef Target) {
239 return Val_bool(LLVMTargetHasJIT(Target));
242 /* Target.t -> bool */
243 CAMLprim value llvm_target_has_target_machine(LLVMTargetRef Target) {
244 return Val_bool(LLVMTargetHasTargetMachine(Target));
247 /* Target.t -> bool */
248 CAMLprim value llvm_target_has_asm_backend(LLVMTargetRef Target) {
249 return Val_bool(LLVMTargetHasAsmBackend(Target));
252 /*===---- Target Machine --------------------------------------------------===*/
254 #define TargetMachine_val(v) (*(LLVMTargetMachineRef *)(Data_custom_val(v)))
256 static void llvm_finalize_target_machine(value Machine) {
257 LLVMDisposeTargetMachine(TargetMachine_val(Machine));
260 static struct custom_operations llvm_target_machine_ops = {
261 (char *) "LLVMTargetMachine",
262 llvm_finalize_target_machine,
263 custom_compare_default,
265 custom_serialize_default,
266 custom_deserialize_default
267 #ifdef custom_compare_ext_default
268 , custom_compare_ext_default
272 static value llvm_alloc_targetmachine(LLVMTargetMachineRef Machine) {
273 value V = alloc_custom(&llvm_target_machine_ops, sizeof(LLVMTargetMachineRef),
275 TargetMachine_val(V) = Machine;
279 /* triple:string -> ?cpu:string -> ?features:string
280 ?level:CodeGenOptLevel.t -> ?reloc_mode:RelocMode.t
281 ?code_model:CodeModel.t -> Target.t -> TargetMachine.t */
282 CAMLprim value llvm_create_targetmachine_native(value Triple, value CPU,
283 value Features, value OptLevel, value RelocMode,
284 value CodeModel, LLVMTargetRef Target) {
285 LLVMTargetMachineRef Machine;
286 const char *CPUStr = "", *FeaturesStr = "";
287 LLVMCodeGenOptLevel OptLevelEnum = LLVMCodeGenLevelDefault;
288 LLVMRelocMode RelocModeEnum = LLVMRelocDefault;
289 LLVMCodeModel CodeModelEnum = LLVMCodeModelDefault;
291 if(CPU != Val_int(0))
292 CPUStr = String_val(Field(CPU, 0));
293 if(Features != Val_int(0))
294 FeaturesStr = String_val(Field(Features, 0));
295 if(OptLevel != Val_int(0))
296 OptLevelEnum = Int_val(Field(OptLevel, 0));
297 if(RelocMode != Val_int(0))
298 RelocModeEnum = Int_val(Field(RelocMode, 0));
299 if(CodeModel != Val_int(0))
300 CodeModelEnum = Int_val(Field(CodeModel, 0));
302 Machine = LLVMCreateTargetMachine(Target, String_val(Triple), CPUStr,
303 FeaturesStr, OptLevelEnum, RelocModeEnum, CodeModelEnum);
305 return llvm_alloc_targetmachine(Machine);
308 CAMLprim value llvm_create_targetmachine_bytecode(value *argv, int argn) {
309 return llvm_create_targetmachine_native(argv[0], argv[1], argv[2], argv[3],
310 argv[4], argv[5], (LLVMTargetRef) argv[6]);
313 /* TargetMachine.t -> Target.t */
314 CAMLprim LLVMTargetRef llvm_targetmachine_target(value Machine) {
315 return LLVMGetTargetMachineTarget(TargetMachine_val(Machine));
318 /* TargetMachine.t -> string */
319 CAMLprim value llvm_targetmachine_triple(value Machine) {
320 return llvm_string_of_message(LLVMGetTargetMachineTriple(
321 TargetMachine_val(Machine)));
324 /* TargetMachine.t -> string */
325 CAMLprim value llvm_targetmachine_cpu(value Machine) {
326 return llvm_string_of_message(LLVMGetTargetMachineCPU(
327 TargetMachine_val(Machine)));
330 /* TargetMachine.t -> string */
331 CAMLprim value llvm_targetmachine_features(value Machine) {
332 return llvm_string_of_message(LLVMGetTargetMachineFeatureString(
333 TargetMachine_val(Machine)));
336 /* TargetMachine.t -> DataLayout.t */
337 CAMLprim value llvm_targetmachine_data_layout(value Machine) {
339 CAMLlocal1(DataLayout);
341 /* LLVMGetTargetMachineData returns a pointer owned by the TargetMachine,
342 so it is impossible to wrap it with llvm_alloc_target_data, which assumes
343 that OCaml owns the pointer. */
344 LLVMTargetDataRef OrigDataLayout;
345 OrigDataLayout = LLVMGetTargetMachineData(TargetMachine_val(Machine));
347 char* TargetDataCStr;
348 TargetDataCStr = LLVMCopyStringRepOfTargetData(OrigDataLayout);
349 DataLayout = llvm_alloc_data_layout(LLVMCreateTargetData(TargetDataCStr));
350 LLVMDisposeMessage(TargetDataCStr);
352 CAMLreturn(DataLayout);
355 /* TargetMachine.t -> bool -> unit */
356 CAMLprim value llvm_targetmachine_set_verbose_asm(value Machine, value Verb) {
357 LLVMSetTargetMachineAsmVerbosity(TargetMachine_val(Machine), Bool_val(Verb));
361 /* Llvm.llmodule -> CodeGenFileType.t -> string -> TargetMachine.t -> unit */
362 CAMLprim value llvm_targetmachine_emit_to_file(LLVMModuleRef Module,
363 value FileType, value FileName, value Machine) {
366 if(LLVMTargetMachineEmitToFile(TargetMachine_val(Machine), Module,
367 String_val(FileName), Int_val(FileType),
369 llvm_raise(llvm_target_error_exn, ErrorMessage);
375 /* Llvm.llmodule -> CodeGenFileType.t -> TargetMachine.t ->
376 Llvm.llmemorybuffer */
377 CAMLprim LLVMMemoryBufferRef llvm_targetmachine_emit_to_memory_buffer(
378 LLVMModuleRef Module, value FileType,
381 LLVMMemoryBufferRef Buffer;
383 if(LLVMTargetMachineEmitToMemoryBuffer(TargetMachine_val(Machine), Module,
384 Int_val(FileType), &ErrorMessage,
386 llvm_raise(llvm_target_error_exn, ErrorMessage);