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 \*===----------------------------------------------------------------------===*/
23 #include <sys/types.h>
26 * @defgroup LLVMCLTO LTO
32 #define LTO_API_VERSION 5
35 LTO_SYMBOL_ALIGNMENT_MASK = 0x0000001F, /* log2 of alignment */
36 LTO_SYMBOL_PERMISSIONS_MASK = 0x000000E0,
37 LTO_SYMBOL_PERMISSIONS_CODE = 0x000000A0,
38 LTO_SYMBOL_PERMISSIONS_DATA = 0x000000C0,
39 LTO_SYMBOL_PERMISSIONS_RODATA = 0x00000080,
40 LTO_SYMBOL_DEFINITION_MASK = 0x00000700,
41 LTO_SYMBOL_DEFINITION_REGULAR = 0x00000100,
42 LTO_SYMBOL_DEFINITION_TENTATIVE = 0x00000200,
43 LTO_SYMBOL_DEFINITION_WEAK = 0x00000300,
44 LTO_SYMBOL_DEFINITION_UNDEFINED = 0x00000400,
45 LTO_SYMBOL_DEFINITION_WEAKUNDEF = 0x00000500,
46 LTO_SYMBOL_SCOPE_MASK = 0x00003800,
47 LTO_SYMBOL_SCOPE_INTERNAL = 0x00000800,
48 LTO_SYMBOL_SCOPE_HIDDEN = 0x00001000,
49 LTO_SYMBOL_SCOPE_PROTECTED = 0x00002000,
50 LTO_SYMBOL_SCOPE_DEFAULT = 0x00001800,
51 LTO_SYMBOL_SCOPE_DEFAULT_CAN_BE_HIDDEN = 0x00002800
52 } lto_symbol_attributes;
55 LTO_DEBUG_MODEL_NONE = 0,
56 LTO_DEBUG_MODEL_DWARF = 1
60 LTO_CODEGEN_PIC_MODEL_STATIC = 0,
61 LTO_CODEGEN_PIC_MODEL_DYNAMIC = 1,
62 LTO_CODEGEN_PIC_MODEL_DYNAMIC_NO_PIC = 2
66 /** opaque reference to a loaded object module */
67 typedef struct LTOModule* lto_module_t;
69 /** opaque reference to a code generator */
70 typedef struct LTOCodeGenerator* lto_code_gen_t;
77 * Returns a printable string.
80 lto_get_version(void);
84 * Returns the last error string or NULL if last operation was successful.
87 lto_get_error_message(void);
90 * Checks if a file is a loadable object file.
93 lto_module_is_object_file(const char* path);
97 * Checks if a file is a loadable object compiled for requested target.
100 lto_module_is_object_file_for_target(const char* path,
101 const char* target_triple_prefix);
105 * Checks if a buffer is a loadable object file.
108 lto_module_is_object_file_in_memory(const void* mem, size_t length);
112 * Checks if a buffer is a loadable object compiled for requested target.
115 lto_module_is_object_file_in_memory_for_target(const void* mem, size_t length,
116 const char* target_triple_prefix);
120 * Loads an object file from disk.
121 * Returns NULL on error (check lto_get_error_message() for details).
124 lto_module_create(const char* path);
128 * Loads an object file from memory.
129 * Returns NULL on error (check lto_get_error_message() for details).
132 lto_module_create_from_memory(const void* mem, size_t length);
135 * Loads an object file from disk. The seek point of fd is not preserved.
136 * Returns NULL on error (check lto_get_error_message() for details).
139 lto_module_create_from_fd(int fd, const char *path, size_t file_size);
142 * Loads an object file from disk. The seek point of fd is not preserved.
143 * Returns NULL on error (check lto_get_error_message() for details).
146 lto_module_create_from_fd_at_offset(int fd, const char *path, size_t file_size,
147 size_t map_size, off_t offset);
151 * Frees all memory internally allocated by the module.
152 * Upon return the lto_module_t is no longer valid.
155 lto_module_dispose(lto_module_t mod);
159 * Returns triple string which the object module was compiled under.
162 lto_module_get_target_triple(lto_module_t mod);
165 * Sets triple string with which the object will be codegened.
168 lto_module_set_target_triple(lto_module_t mod, const char *triple);
172 * Returns the number of symbols in the object module.
175 lto_module_get_num_symbols(lto_module_t mod);
179 * Returns the name of the ith symbol in the object module.
182 lto_module_get_symbol_name(lto_module_t mod, unsigned int index);
186 * Returns the attributes of the ith symbol in the object module.
188 extern lto_symbol_attributes
189 lto_module_get_symbol_attribute(lto_module_t mod, unsigned int index);
193 * Instantiates a code generator.
194 * Returns NULL on error (check lto_get_error_message() for details).
196 extern lto_code_gen_t
197 lto_codegen_create(void);
201 * Frees all code generator and all memory it internally allocated.
202 * Upon return the lto_code_gen_t is no longer valid.
205 lto_codegen_dispose(lto_code_gen_t);
210 * Add an object module to the set of modules for which code will be generated.
211 * Returns true on error (check lto_get_error_message() for details).
214 lto_codegen_add_module(lto_code_gen_t cg, lto_module_t mod);
219 * Sets if debug info should be generated.
220 * Returns true on error (check lto_get_error_message() for details).
223 lto_codegen_set_debug_model(lto_code_gen_t cg, lto_debug_model);
227 * Sets which PIC code model to generated.
228 * Returns true on error (check lto_get_error_message() for details).
231 lto_codegen_set_pic_model(lto_code_gen_t cg, lto_codegen_model);
235 * Sets the cpu to generate code for.
238 lto_codegen_set_cpu(lto_code_gen_t cg, const char *cpu);
242 * Sets the location of the assembler tool to run. If not set, libLTO
243 * will use gcc to invoke the assembler.
246 lto_codegen_set_assembler_path(lto_code_gen_t cg, const char* path);
249 * Sets extra arguments that libLTO should pass to the assembler.
252 lto_codegen_set_assembler_args(lto_code_gen_t cg, const char **args,
256 * Tells LTO optimization passes that this symbol must be preserved
257 * because it is referenced by native code or a command line option.
260 lto_codegen_add_must_preserve_symbol(lto_code_gen_t cg, const char* symbol);
264 * Tells LTO optimization passes that a dynamic shared library is being
265 * built and this symbol may be exported. Unless IR semantics allow the symbol
266 * to be made local to the library, it should remain so it can be exported by
267 * the shared library.
269 extern void lto_codegen_add_dso_symbol(lto_code_gen_t cg, const char *symbol);
272 * Writes a new object file at the specified path that contains the
273 * merged contents of all modules added so far.
274 * Returns true on error (check lto_get_error_message() for details).
277 lto_codegen_write_merged_modules(lto_code_gen_t cg, const char* path);
280 * Generates code for all added modules into one native object file.
281 * On success returns a pointer to a generated mach-o/ELF buffer and
282 * length set to the buffer size. The buffer is owned by the
283 * lto_code_gen_t and will be freed when lto_codegen_dispose()
284 * is called, or lto_codegen_compile() is called again.
285 * On failure, returns NULL (check lto_get_error_message() for details).
288 lto_codegen_compile(lto_code_gen_t cg, size_t* length);
291 * Generates code for all added modules into one native object file.
292 * The name of the file is written to name. Returns true on error.
295 lto_codegen_compile_to_file(lto_code_gen_t cg, const char** name);
299 * Sets options to help debug codegen bugs.
302 lto_codegen_debug_options(lto_code_gen_t cg, const char *);
305 * Initializes LLVM disassemblers.
306 * FIXME: This doesn't really belong here.
309 lto_initialize_disassembler(void);