1 /*===-- llvm-c/lto.h - LTO Public C Interface ---------------------*- 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 header provides public interface to an abstract link time optimization*|
11 |* library. LLVM provides an implementation of this interface for use with *|
12 |* llvm bitcode files. *|
14 \*===----------------------------------------------------------------------===*/
21 #include "llvm/System/DataTypes.h"
23 #define LTO_API_VERSION 3
26 LTO_SYMBOL_ALIGNMENT_MASK = 0x0000001F, /* log2 of alignment */
27 LTO_SYMBOL_PERMISSIONS_MASK = 0x000000E0,
28 LTO_SYMBOL_PERMISSIONS_CODE = 0x000000A0,
29 LTO_SYMBOL_PERMISSIONS_DATA = 0x000000C0,
30 LTO_SYMBOL_PERMISSIONS_RODATA = 0x00000080,
31 LTO_SYMBOL_DEFINITION_MASK = 0x00000700,
32 LTO_SYMBOL_DEFINITION_REGULAR = 0x00000100,
33 LTO_SYMBOL_DEFINITION_TENTATIVE = 0x00000200,
34 LTO_SYMBOL_DEFINITION_WEAK = 0x00000300,
35 LTO_SYMBOL_DEFINITION_UNDEFINED = 0x00000400,
36 LTO_SYMBOL_DEFINITION_WEAKUNDEF = 0x00000500,
37 LTO_SYMBOL_SCOPE_MASK = 0x00003800,
38 LTO_SYMBOL_SCOPE_INTERNAL = 0x00000800,
39 LTO_SYMBOL_SCOPE_HIDDEN = 0x00001000,
40 LTO_SYMBOL_SCOPE_PROTECTED = 0x00002000,
41 LTO_SYMBOL_SCOPE_DEFAULT = 0x00001800
42 } lto_symbol_attributes;
45 LTO_DEBUG_MODEL_NONE = 0,
46 LTO_DEBUG_MODEL_DWARF = 1
50 LTO_CODEGEN_PIC_MODEL_STATIC = 0,
51 LTO_CODEGEN_PIC_MODEL_DYNAMIC = 1,
52 LTO_CODEGEN_PIC_MODEL_DYNAMIC_NO_PIC = 2
56 /** opaque reference to a loaded object module */
57 typedef struct LTOModule* lto_module_t;
59 /** opaque reference to a code generator */
60 typedef struct LTOCodeGenerator* lto_code_gen_t;
67 * Returns a printable string.
70 lto_get_version(void);
74 * Returns the last error string or NULL if last operation was sucessful.
77 lto_get_error_message(void);
80 * Checks if a file is a loadable object file.
83 lto_module_is_object_file(const char* path);
87 * Checks if a file is a loadable object compiled for requested target.
90 lto_module_is_object_file_for_target(const char* path,
91 const char* target_triple_prefix);
95 * Checks if a buffer is a loadable object file.
98 lto_module_is_object_file_in_memory(const void* mem, size_t length);
102 * Checks if a buffer is a loadable object compiled for requested target.
105 lto_module_is_object_file_in_memory_for_target(const void* mem, size_t length,
106 const char* target_triple_prefix);
110 * Loads an object file from disk.
111 * Returns NULL on error (check lto_get_error_message() for details).
114 lto_module_create(const char* path);
118 * Loads an object file from memory.
119 * Returns NULL on error (check lto_get_error_message() for details).
122 lto_module_create_from_memory(const void* mem, size_t length);
126 * Frees all memory internally allocated by the module.
127 * Upon return the lto_module_t is no longer valid.
130 lto_module_dispose(lto_module_t mod);
134 * Returns triple string which the object module was compiled under.
137 lto_module_get_target_triple(lto_module_t mod);
140 * Sets triple string with which the object will be codegened.
143 lto_module_set_target_triple(lto_module_t mod, const char *triple);
147 * Returns the number of symbols in the object module.
150 lto_module_get_num_symbols(lto_module_t mod);
154 * Returns the name of the ith symbol in the object module.
157 lto_module_get_symbol_name(lto_module_t mod, uint32_t index);
161 * Returns the attributes of the ith symbol in the object module.
163 extern lto_symbol_attributes
164 lto_module_get_symbol_attribute(lto_module_t mod, uint32_t index);
168 * Instantiates a code generator.
169 * Returns NULL on error (check lto_get_error_message() for details).
171 extern lto_code_gen_t
172 lto_codegen_create(void);
176 * Frees all code generator and all memory it internally allocated.
177 * Upon return the lto_code_gen_t is no longer valid.
180 lto_codegen_dispose(lto_code_gen_t);
185 * Add an object module to the set of modules for which code will be generated.
186 * Returns true on error (check lto_get_error_message() for details).
189 lto_codegen_add_module(lto_code_gen_t cg, lto_module_t mod);
194 * Sets if debug info should be generated.
195 * Returns true on error (check lto_get_error_message() for details).
198 lto_codegen_set_debug_model(lto_code_gen_t cg, lto_debug_model);
202 * Sets which PIC code model to generated.
203 * Returns true on error (check lto_get_error_message() for details).
206 lto_codegen_set_pic_model(lto_code_gen_t cg, lto_codegen_model);
210 * Sets the cpu to generate code for.
213 lto_codegen_set_cpu(lto_code_gen_t cg, const char *cpu);
217 * Sets the location of the assembler tool to run. If not set, libLTO
218 * will use gcc to invoke the assembler.
221 lto_codegen_set_assembler_path(lto_code_gen_t cg, const char* path);
224 * Sets extra arguments that libLTO should pass to the assembler.
227 lto_codegen_set_assembler_args(lto_code_gen_t cg, const char **args,
231 * Adds to a list of all global symbols that must exist in the final
232 * generated code. If a function is not listed, it might be
233 * inlined into every usage and optimized away.
236 lto_codegen_add_must_preserve_symbol(lto_code_gen_t cg, const char* symbol);
240 * Writes a new object file at the specified path that contains the
241 * merged contents of all modules added so far.
242 * Returns true on error (check lto_get_error_message() for details).
245 lto_codegen_write_merged_modules(lto_code_gen_t cg, const char* path);
249 * Generates code for all added modules into one native object file.
250 * On sucess returns a pointer to a generated mach-o/ELF buffer and
251 * length set to the buffer size. The buffer is owned by the
252 * lto_code_gen_t and will be freed when lto_codegen_dispose()
253 * is called, or lto_codegen_compile() is called again.
254 * On failure, returns NULL (check lto_get_error_message() for details).
257 lto_codegen_compile(lto_code_gen_t cg, size_t* length);
261 * Sets options to help debug codegen bugs.
264 lto_codegen_debug_options(lto_code_gen_t cg, const char *);