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 6
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 LTO_INTERNALIZE_FULL = 0,
78 LTO_INTERNALIZE_NONE = 1,
79 LTO_INTERNALIZE_HIDDEN = 2
80 } lto_internalize_strategy;
82 /** opaque reference to a loaded object module */
83 typedef struct LTOModule* lto_module_t;
85 /** opaque reference to a code generator */
86 typedef struct LTOCodeGenerator* lto_code_gen_t;
93 * Returns a printable string.
96 lto_get_version(void);
100 * Returns the last error string or NULL if last operation was successful.
103 lto_get_error_message(void);
106 * Checks if a file is a loadable object file.
109 lto_module_is_object_file(const char* path);
113 * Checks if a file is a loadable object compiled for requested target.
116 lto_module_is_object_file_for_target(const char* path,
117 const char* target_triple_prefix);
121 * Checks if a buffer is a loadable object file.
124 lto_module_is_object_file_in_memory(const void* mem, size_t length);
128 * Checks if a buffer is a loadable object compiled for requested target.
131 lto_module_is_object_file_in_memory_for_target(const void* mem, size_t length,
132 const char* target_triple_prefix);
136 * Loads an object file from disk.
137 * Returns NULL on error (check lto_get_error_message() for details).
140 lto_module_create(const char* path);
144 * Loads an object file from memory.
145 * Returns NULL on error (check lto_get_error_message() for details).
148 lto_module_create_from_memory(const void* mem, size_t length);
151 * Loads an object file from disk. The seek point of fd is not preserved.
152 * Returns NULL on error (check lto_get_error_message() for details).
155 lto_module_create_from_fd(int fd, const char *path, size_t file_size);
158 * Loads an object file from disk. The seek point of fd is not preserved.
159 * Returns NULL on error (check lto_get_error_message() for details).
162 lto_module_create_from_fd_at_offset(int fd, const char *path, size_t file_size,
163 size_t map_size, off_t offset);
167 * Frees all memory internally allocated by the module.
168 * Upon return the lto_module_t is no longer valid.
171 lto_module_dispose(lto_module_t mod);
175 * Returns triple string which the object module was compiled under.
178 lto_module_get_target_triple(lto_module_t mod);
181 * Sets triple string with which the object will be codegened.
184 lto_module_set_target_triple(lto_module_t mod, const char *triple);
188 * Returns the number of symbols in the object module.
191 lto_module_get_num_symbols(lto_module_t mod);
195 * Returns the name of the ith symbol in the object module.
198 lto_module_get_symbol_name(lto_module_t mod, unsigned int index);
202 * Returns the attributes of the ith symbol in the object module.
204 extern lto_symbol_attributes
205 lto_module_get_symbol_attribute(lto_module_t mod, unsigned int index);
209 * Instantiates a code generator.
210 * Returns NULL on error (check lto_get_error_message() for details).
212 extern lto_code_gen_t
213 lto_codegen_create(void);
217 * Frees all code generator and all memory it internally allocated.
218 * Upon return the lto_code_gen_t is no longer valid.
221 lto_codegen_dispose(lto_code_gen_t);
226 * Add an object module to the set of modules for which code will be generated.
227 * Returns true on error (check lto_get_error_message() for details).
230 lto_codegen_add_module(lto_code_gen_t cg, lto_module_t mod);
235 * Sets if debug info should be generated.
236 * Returns true on error (check lto_get_error_message() for details).
239 lto_codegen_set_debug_model(lto_code_gen_t cg, lto_debug_model);
243 * Sets which PIC code model to generated.
244 * Returns true on error (check lto_get_error_message() for details).
247 lto_codegen_set_pic_model(lto_code_gen_t cg, lto_codegen_model);
251 * Sets the cpu to generate code for.
254 lto_codegen_set_cpu(lto_code_gen_t cg, const char *cpu);
258 * Sets the location of the assembler tool to run. If not set, libLTO
259 * will use gcc to invoke the assembler.
262 lto_codegen_set_assembler_path(lto_code_gen_t cg, const char* path);
265 * Sets extra arguments that libLTO should pass to the assembler.
268 lto_codegen_set_assembler_args(lto_code_gen_t cg, const char **args,
272 * Sets the strategy to use during internalize. Default strategy is
273 * LTO_INTERNALIZE_FULL.
276 lto_codegen_set_internalize_strategy(lto_code_gen_t cg,
277 lto_internalize_strategy);
280 * Tells LTO optimization passes that this symbol must be preserved
281 * because it is referenced by native code or a command line option.
284 lto_codegen_add_must_preserve_symbol(lto_code_gen_t cg, const char* symbol);
287 * Writes a new object file at the specified path that contains the
288 * merged contents of all modules added so far.
289 * Returns true on error (check lto_get_error_message() for details).
292 lto_codegen_write_merged_modules(lto_code_gen_t cg, const char* path);
295 * Generates code for all added modules into one native object file.
296 * On success returns a pointer to a generated mach-o/ELF buffer and
297 * length set to the buffer size. The buffer is owned by the
298 * lto_code_gen_t and will be freed when lto_codegen_dispose()
299 * is called, or lto_codegen_compile() is called again.
300 * On failure, returns NULL (check lto_get_error_message() for details).
303 lto_codegen_compile(lto_code_gen_t cg, size_t* length);
306 * Generates code for all added modules into one native object file.
307 * The name of the file is written to name. Returns true on error.
310 lto_codegen_compile_to_file(lto_code_gen_t cg, const char** name);
314 * Sets options to help debug codegen bugs.
317 lto_codegen_debug_options(lto_code_gen_t cg, const char *);
320 * Initializes LLVM disassemblers.
321 * FIXME: This doesn't really belong here.
324 lto_initialize_disassembler(void);