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 \*===----------------------------------------------------------------------===*/
20 #include <sys/types.h>
23 #if !defined(_MSC_VER)
25 typedef bool lto_bool_t;
27 /* MSVC in particular does not have anything like _Bool or bool in C, but we can
28 at least make sure the type is the same size. The implementation side will
30 typedef unsigned char lto_bool_t;
33 typedef bool lto_bool_t;
37 * @defgroup LLVMCLTO LTO
43 #define LTO_API_VERSION 5
46 LTO_SYMBOL_ALIGNMENT_MASK = 0x0000001F, /* log2 of alignment */
47 LTO_SYMBOL_PERMISSIONS_MASK = 0x000000E0,
48 LTO_SYMBOL_PERMISSIONS_CODE = 0x000000A0,
49 LTO_SYMBOL_PERMISSIONS_DATA = 0x000000C0,
50 LTO_SYMBOL_PERMISSIONS_RODATA = 0x00000080,
51 LTO_SYMBOL_DEFINITION_MASK = 0x00000700,
52 LTO_SYMBOL_DEFINITION_REGULAR = 0x00000100,
53 LTO_SYMBOL_DEFINITION_TENTATIVE = 0x00000200,
54 LTO_SYMBOL_DEFINITION_WEAK = 0x00000300,
55 LTO_SYMBOL_DEFINITION_UNDEFINED = 0x00000400,
56 LTO_SYMBOL_DEFINITION_WEAKUNDEF = 0x00000500,
57 LTO_SYMBOL_SCOPE_MASK = 0x00003800,
58 LTO_SYMBOL_SCOPE_INTERNAL = 0x00000800,
59 LTO_SYMBOL_SCOPE_HIDDEN = 0x00001000,
60 LTO_SYMBOL_SCOPE_PROTECTED = 0x00002000,
61 LTO_SYMBOL_SCOPE_DEFAULT = 0x00001800,
62 LTO_SYMBOL_SCOPE_DEFAULT_CAN_BE_HIDDEN = 0x00002800
63 } lto_symbol_attributes;
66 LTO_DEBUG_MODEL_NONE = 0,
67 LTO_DEBUG_MODEL_DWARF = 1
71 LTO_CODEGEN_PIC_MODEL_STATIC = 0,
72 LTO_CODEGEN_PIC_MODEL_DYNAMIC = 1,
73 LTO_CODEGEN_PIC_MODEL_DYNAMIC_NO_PIC = 2
77 /** opaque reference to a loaded object module */
78 typedef struct LTOModule* lto_module_t;
80 /** opaque reference to a code generator */
81 typedef struct LTOCodeGenerator* lto_code_gen_t;
88 * Returns a printable string.
91 lto_get_version(void);
95 * Returns the last error string or NULL if last operation was successful.
98 lto_get_error_message(void);
101 * Checks if a file is a loadable object file.
104 lto_module_is_object_file(const char* path);
108 * Checks if a file is a loadable object compiled for requested target.
111 lto_module_is_object_file_for_target(const char* path,
112 const char* target_triple_prefix);
116 * Checks if a buffer is a loadable object file.
119 lto_module_is_object_file_in_memory(const void* mem, size_t length);
123 * Checks if a buffer is a loadable object compiled for requested target.
126 lto_module_is_object_file_in_memory_for_target(const void* mem, size_t length,
127 const char* target_triple_prefix);
131 * Loads an object file from disk.
132 * Returns NULL on error (check lto_get_error_message() for details).
135 lto_module_create(const char* path);
139 * Loads an object file from memory.
140 * Returns NULL on error (check lto_get_error_message() for details).
143 lto_module_create_from_memory(const void* mem, size_t length);
146 * Loads an object file from disk. The seek point of fd is not preserved.
147 * Returns NULL on error (check lto_get_error_message() for details).
150 lto_module_create_from_fd(int fd, const char *path, size_t file_size);
153 * Loads an object file from disk. The seek point of fd is not preserved.
154 * Returns NULL on error (check lto_get_error_message() for details).
157 lto_module_create_from_fd_at_offset(int fd, const char *path, size_t file_size,
158 size_t map_size, off_t offset);
162 * Frees all memory internally allocated by the module.
163 * Upon return the lto_module_t is no longer valid.
166 lto_module_dispose(lto_module_t mod);
170 * Returns triple string which the object module was compiled under.
173 lto_module_get_target_triple(lto_module_t mod);
176 * Sets triple string with which the object will be codegened.
179 lto_module_set_target_triple(lto_module_t mod, const char *triple);
183 * Returns the number of symbols in the object module.
186 lto_module_get_num_symbols(lto_module_t mod);
190 * Returns the name of the ith symbol in the object module.
193 lto_module_get_symbol_name(lto_module_t mod, unsigned int index);
197 * Returns the attributes of the ith symbol in the object module.
199 extern lto_symbol_attributes
200 lto_module_get_symbol_attribute(lto_module_t mod, unsigned int index);
204 * Instantiates a code generator.
205 * Returns NULL on error (check lto_get_error_message() for details).
207 extern lto_code_gen_t
208 lto_codegen_create(void);
212 * Frees all code generator and all memory it internally allocated.
213 * Upon return the lto_code_gen_t is no longer valid.
216 lto_codegen_dispose(lto_code_gen_t);
221 * Add an object module to the set of modules for which code will be generated.
222 * Returns true on error (check lto_get_error_message() for details).
225 lto_codegen_add_module(lto_code_gen_t cg, lto_module_t mod);
230 * Sets if debug info should be generated.
231 * Returns true on error (check lto_get_error_message() for details).
234 lto_codegen_set_debug_model(lto_code_gen_t cg, lto_debug_model);
238 * Sets which PIC code model to generated.
239 * Returns true on error (check lto_get_error_message() for details).
242 lto_codegen_set_pic_model(lto_code_gen_t cg, lto_codegen_model);
246 * Sets the cpu to generate code for.
249 lto_codegen_set_cpu(lto_code_gen_t cg, const char *cpu);
253 * Sets the location of the assembler tool to run. If not set, libLTO
254 * will use gcc to invoke the assembler.
257 lto_codegen_set_assembler_path(lto_code_gen_t cg, const char* path);
260 * Sets extra arguments that libLTO should pass to the assembler.
263 lto_codegen_set_assembler_args(lto_code_gen_t cg, const char **args,
267 * Tells LTO optimization passes that this symbol must be preserved
268 * because it is referenced by native code or a command line option.
271 lto_codegen_add_must_preserve_symbol(lto_code_gen_t cg, const char* symbol);
275 * Tells LTO optimization passes that a dynamic shared library is being
276 * built and this symbol may be exported. Unless IR semantics allow the symbol
277 * to be made local to the library, it should remain so it can be exported by
278 * the shared library.
280 extern void lto_codegen_add_dso_symbol(lto_code_gen_t cg, const char *symbol);
283 * Writes a new object file at the specified path that contains the
284 * merged contents of all modules added so far.
285 * Returns true on error (check lto_get_error_message() for details).
288 lto_codegen_write_merged_modules(lto_code_gen_t cg, const char* path);
291 * Generates code for all added modules into one native object file.
292 * On success returns a pointer to a generated mach-o/ELF buffer and
293 * length set to the buffer size. The buffer is owned by the
294 * lto_code_gen_t and will be freed when lto_codegen_dispose()
295 * is called, or lto_codegen_compile() is called again.
296 * On failure, returns NULL (check lto_get_error_message() for details).
299 lto_codegen_compile(lto_code_gen_t cg, size_t* length);
302 * Generates code for all added modules into one native object file.
303 * The name of the file is written to name. Returns true on error.
306 lto_codegen_compile_to_file(lto_code_gen_t cg, const char** name);
310 * Sets options to help debug codegen bugs.
313 lto_codegen_debug_options(lto_code_gen_t cg, const char *);
316 * Initializes LLVM disassemblers.
317 * FIXME: This doesn't really belong here.
320 lto_initialize_disassembler(void);