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 \*===----------------------------------------------------------------------===*/
24 * @defgroup LLVMCLTO LTO
30 #define LTO_API_VERSION 4
33 LTO_SYMBOL_ALIGNMENT_MASK = 0x0000001F, /* log2 of alignment */
34 LTO_SYMBOL_PERMISSIONS_MASK = 0x000000E0,
35 LTO_SYMBOL_PERMISSIONS_CODE = 0x000000A0,
36 LTO_SYMBOL_PERMISSIONS_DATA = 0x000000C0,
37 LTO_SYMBOL_PERMISSIONS_RODATA = 0x00000080,
38 LTO_SYMBOL_DEFINITION_MASK = 0x00000700,
39 LTO_SYMBOL_DEFINITION_REGULAR = 0x00000100,
40 LTO_SYMBOL_DEFINITION_TENTATIVE = 0x00000200,
41 LTO_SYMBOL_DEFINITION_WEAK = 0x00000300,
42 LTO_SYMBOL_DEFINITION_UNDEFINED = 0x00000400,
43 LTO_SYMBOL_DEFINITION_WEAKUNDEF = 0x00000500,
44 LTO_SYMBOL_SCOPE_MASK = 0x00003800,
45 LTO_SYMBOL_SCOPE_INTERNAL = 0x00000800,
46 LTO_SYMBOL_SCOPE_HIDDEN = 0x00001000,
47 LTO_SYMBOL_SCOPE_PROTECTED = 0x00002000,
48 LTO_SYMBOL_SCOPE_DEFAULT = 0x00001800,
49 LTO_SYMBOL_SCOPE_DEFAULT_CAN_BE_HIDDEN = 0x00002800
50 } lto_symbol_attributes;
53 LTO_DEBUG_MODEL_NONE = 0,
54 LTO_DEBUG_MODEL_DWARF = 1
58 LTO_CODEGEN_PIC_MODEL_STATIC = 0,
59 LTO_CODEGEN_PIC_MODEL_DYNAMIC = 1,
60 LTO_CODEGEN_PIC_MODEL_DYNAMIC_NO_PIC = 2
64 /** opaque reference to a loaded object module */
65 typedef struct LTOModule* lto_module_t;
67 /** opaque reference to a code generator */
68 typedef struct LTOCodeGenerator* lto_code_gen_t;
75 * Returns a printable string.
78 lto_get_version(void);
82 * Returns the last error string or NULL if last operation was successful.
85 lto_get_error_message(void);
88 * Checks if a file is a loadable object file.
91 lto_module_is_object_file(const char* path);
95 * Checks if a file is a loadable object compiled for requested target.
98 lto_module_is_object_file_for_target(const char* path,
99 const char* target_triple_prefix);
103 * Checks if a buffer is a loadable object file.
106 lto_module_is_object_file_in_memory(const void* mem, size_t length);
110 * Checks if a buffer is a loadable object compiled for requested target.
113 lto_module_is_object_file_in_memory_for_target(const void* mem, size_t length,
114 const char* target_triple_prefix);
118 * Loads an object file from disk.
119 * Returns NULL on error (check lto_get_error_message() for details).
122 lto_module_create(const char* path);
126 * Loads an object file from memory.
127 * Returns NULL on error (check lto_get_error_message() for details).
130 lto_module_create_from_memory(const void* mem, size_t length);
133 * Loads an object file from disk. The seek point of fd is not preserved.
134 * Returns NULL on error (check lto_get_error_message() for details).
137 lto_module_create_from_fd(int fd, const char *path, size_t file_size);
140 * Loads an object file from disk. The seek point of fd is not preserved.
141 * Returns NULL on error (check lto_get_error_message() for details).
144 lto_module_create_from_fd_at_offset(int fd, const char *path, size_t file_size,
145 size_t map_size, off_t offset);
149 * Frees all memory internally allocated by the module.
150 * Upon return the lto_module_t is no longer valid.
153 lto_module_dispose(lto_module_t mod);
157 * Returns triple string which the object module was compiled under.
160 lto_module_get_target_triple(lto_module_t mod);
163 * Sets triple string with which the object will be codegened.
166 lto_module_set_target_triple(lto_module_t mod, const char *triple);
170 * Returns the number of symbols in the object module.
173 lto_module_get_num_symbols(lto_module_t mod);
177 * Returns the name of the ith symbol in the object module.
180 lto_module_get_symbol_name(lto_module_t mod, unsigned int index);
184 * Returns the attributes of the ith symbol in the object module.
186 extern lto_symbol_attributes
187 lto_module_get_symbol_attribute(lto_module_t mod, unsigned int index);
191 * Instantiates a code generator.
192 * Returns NULL on error (check lto_get_error_message() for details).
194 extern lto_code_gen_t
195 lto_codegen_create(void);
199 * Frees all code generator and all memory it internally allocated.
200 * Upon return the lto_code_gen_t is no longer valid.
203 lto_codegen_dispose(lto_code_gen_t);
208 * Add an object module to the set of modules for which code will be generated.
209 * Returns true on error (check lto_get_error_message() for details).
212 lto_codegen_add_module(lto_code_gen_t cg, lto_module_t mod);
217 * Sets if debug info should be generated.
218 * Returns true on error (check lto_get_error_message() for details).
221 lto_codegen_set_debug_model(lto_code_gen_t cg, lto_debug_model);
225 * Sets which PIC code model to generated.
226 * Returns true on error (check lto_get_error_message() for details).
229 lto_codegen_set_pic_model(lto_code_gen_t cg, lto_codegen_model);
233 * Sets the cpu to generate code for.
236 lto_codegen_set_cpu(lto_code_gen_t cg, const char *cpu);
240 * Sets the location of the assembler tool to run. If not set, libLTO
241 * will use gcc to invoke the assembler.
244 lto_codegen_set_assembler_path(lto_code_gen_t cg, const char* path);
247 * Sets extra arguments that libLTO should pass to the assembler.
250 lto_codegen_set_assembler_args(lto_code_gen_t cg, const char **args,
254 * Enables the internalize pass during LTO optimizations.
257 lto_codegen_set_whole_program_optimization(lto_code_gen_t cg);
260 * Adds to a list of all global symbols that must exist in the final
261 * generated code. If a function is not listed, it might be
262 * inlined into every usage and optimized away.
265 lto_codegen_add_must_preserve_symbol(lto_code_gen_t cg, const char* symbol);
268 * Writes a new object file at the specified path that contains the
269 * merged contents of all modules added so far.
270 * Returns true on error (check lto_get_error_message() for details).
273 lto_codegen_write_merged_modules(lto_code_gen_t cg, const char* path);
276 * Generates code for all added modules into one native object file.
277 * On success returns a pointer to a generated mach-o/ELF buffer and
278 * length set to the buffer size. The buffer is owned by the
279 * lto_code_gen_t and will be freed when lto_codegen_dispose()
280 * is called, or lto_codegen_compile() is called again.
281 * On failure, returns NULL (check lto_get_error_message() for details).
284 lto_codegen_compile(lto_code_gen_t cg, size_t* length);
287 * Generates code for all added modules into one native object file.
288 * The name of the file is written to name. Returns true on error.
291 lto_codegen_compile_to_file(lto_code_gen_t cg, const char** name);
295 * Sets options to help debug codegen bugs.
298 lto_codegen_debug_options(lto_code_gen_t cg, const char *);