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
\*===----------------------------------------------------------------------===*/
22
#define LTO_API_VERSION 3
25
LTO_SYMBOL_ALIGNMENT_MASK = 0x0000001F, /* log2 of alignment */
26
LTO_SYMBOL_PERMISSIONS_MASK = 0x000000E0,
27
LTO_SYMBOL_PERMISSIONS_CODE = 0x000000A0,
28
LTO_SYMBOL_PERMISSIONS_DATA = 0x000000C0,
29
LTO_SYMBOL_PERMISSIONS_RODATA = 0x00000080,
30
LTO_SYMBOL_DEFINITION_MASK = 0x00000700,
31
LTO_SYMBOL_DEFINITION_REGULAR = 0x00000100,
32
LTO_SYMBOL_DEFINITION_TENTATIVE = 0x00000200,
33
LTO_SYMBOL_DEFINITION_WEAK = 0x00000300,
34
LTO_SYMBOL_DEFINITION_UNDEFINED = 0x00000400,
35
LTO_SYMBOL_DEFINITION_WEAKUNDEF = 0x00000500,
36
LTO_SYMBOL_SCOPE_MASK = 0x00003800,
37
LTO_SYMBOL_SCOPE_INTERNAL = 0x00000800,
38
LTO_SYMBOL_SCOPE_HIDDEN = 0x00001000,
39
LTO_SYMBOL_SCOPE_PROTECTED = 0x00002000,
40
LTO_SYMBOL_SCOPE_DEFAULT = 0x00001800
41
} lto_symbol_attributes;
44
LTO_DEBUG_MODEL_NONE = 0,
45
LTO_DEBUG_MODEL_DWARF = 1
49
LTO_CODEGEN_PIC_MODEL_STATIC = 0,
50
LTO_CODEGEN_PIC_MODEL_DYNAMIC = 1,
51
LTO_CODEGEN_PIC_MODEL_DYNAMIC_NO_PIC = 2
55
/** opaque reference to a loaded object module */
56
typedef struct LTOModule* lto_module_t;
58
/** opaque reference to a code generator */
59
typedef struct LTOCodeGenerator* lto_code_gen_t;
66
* Returns a printable string.
69
lto_get_version(void);
73
* Returns the last error string or NULL if last operation was sucessful.
76
lto_get_error_message(void);
79
* Checks if a file is a loadable object file.
82
lto_module_is_object_file(const char* path);
86
* Checks if a file is a loadable object compiled for requested target.
89
lto_module_is_object_file_for_target(const char* path,
90
const char* target_triple_prefix);
94
* Checks if a buffer is a loadable object file.
97
lto_module_is_object_file_in_memory(const void* mem, size_t length);
101
* Checks if a buffer is a loadable object compiled for requested target.
104
lto_module_is_object_file_in_memory_for_target(const void* mem, size_t length,
105
const char* target_triple_prefix);
109
* Loads an object file from disk.
110
* Returns NULL on error (check lto_get_error_message() for details).
113
lto_module_create(const char* path);
117
* Loads an object file from memory.
118
* Returns NULL on error (check lto_get_error_message() for details).
121
lto_module_create_from_memory(const void* mem, size_t length);
125
* Frees all memory internally allocated by the module.
126
* Upon return the lto_module_t is no longer valid.
129
lto_module_dispose(lto_module_t mod);
133
* Returns triple string which the object module was compiled under.
136
lto_module_get_target_triple(lto_module_t mod);
140
* Returns the number of symbols in the object module.
143
lto_module_get_num_symbols(lto_module_t mod);
147
* Returns the name of the ith symbol in the object module.
150
lto_module_get_symbol_name(lto_module_t mod, unsigned int index);
154
* Returns the attributes of the ith symbol in the object module.
156
extern lto_symbol_attributes
157
lto_module_get_symbol_attribute(lto_module_t mod, unsigned int index);
161
* Instantiates a code generator.
162
* Returns NULL on error (check lto_get_error_message() for details).
164
extern lto_code_gen_t
165
lto_codegen_create(void);
169
* Frees all code generator and all memory it internally allocated.
170
* Upon return the lto_code_gen_t is no longer valid.
173
lto_codegen_dispose(lto_code_gen_t);
178
* Add an object module to the set of modules for which code will be generated.
179
* Returns true on error (check lto_get_error_message() for details).
182
lto_codegen_add_module(lto_code_gen_t cg, lto_module_t mod);
187
* Sets if debug info should be generated.
188
* Returns true on error (check lto_get_error_message() for details).
191
lto_codegen_set_debug_model(lto_code_gen_t cg, lto_debug_model);
195
* Sets which PIC code model to generated.
196
* Returns true on error (check lto_get_error_message() for details).
199
lto_codegen_set_pic_model(lto_code_gen_t cg, lto_codegen_model);
203
* Sets the location of the "gcc" to run. If not set, libLTO will search for
207
lto_codegen_set_gcc_path(lto_code_gen_t cg, const char* path);
211
* Sets the location of the assembler tool to run. If not set, libLTO
212
* will use gcc to invoke the assembler.
215
lto_codegen_set_assembler_path(lto_code_gen_t cg, const char* path);
219
* Adds to a list of all global symbols that must exist in the final
220
* generated code. If a function is not listed, it might be
221
* inlined into every usage and optimized away.
224
lto_codegen_add_must_preserve_symbol(lto_code_gen_t cg, const char* symbol);
228
* Writes a new object file at the specified path that contains the
229
* merged contents of all modules added so far.
230
* Returns true on error (check lto_get_error_message() for details).
233
lto_codegen_write_merged_modules(lto_code_gen_t cg, const char* path);
237
* Generates code for all added modules into one native object file.
238
* On sucess returns a pointer to a generated mach-o/ELF buffer and
239
* length set to the buffer size. The buffer is owned by the
240
* lto_code_gen_t and will be freed when lto_codegen_dispose()
241
* is called, or lto_codegen_compile() is called again.
242
* On failure, returns NULL (check lto_get_error_message() for details).
245
lto_codegen_compile(lto_code_gen_t cg, size_t* length);
249
* Sets options to help debug codegen bugs.
252
lto_codegen_debug_options(lto_code_gen_t cg, const char *);