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 LTO_SYMBOL_ALIGNMENT_MASK = 0x0000001F, /* log2 of alignment */
24 LTO_SYMBOL_PERMISSIONS_MASK = 0x000000E0,
25 LTO_SYMBOL_PERMISSIONS_CODE = 0x000000A0,
26 LTO_SYMBOL_PERMISSIONS_DATA = 0x000000C0,
27 LTO_SYMBOL_PERMISSIONS_RODATA = 0x00000080,
28 LTO_SYMBOL_DEFINITION_MASK = 0x00000700,
29 LTO_SYMBOL_DEFINITION_REGULAR = 0x00000100,
30 LTO_SYMBOL_DEFINITION_TENTATIVE = 0x00000200,
31 LTO_SYMBOL_DEFINITION_WEAK = 0x00000300,
32 LTO_SYMBOL_DEFINITION_UNDEFINED = 0x00000400,
33 LTO_SYMBOL_SCOPE_MASK = 0x00003800,
34 LTO_SYMBOL_SCOPE_INTERNAL = 0x00000800,
35 LTO_SYMBOL_SCOPE_HIDDEN = 0x00001000,
36 LTO_SYMBOL_SCOPE_PROTECTED = 0x00002000,
37 LTO_SYMBOL_SCOPE_DEFAULT = 0x00001800
38 } lto_symbol_attributes;
41 LTO_DEBUG_MODEL_NONE = 0,
42 LTO_DEBUG_MODEL_DWARF = 1
46 LTO_CODEGEN_PIC_MODEL_STATIC = 0,
47 LTO_CODEGEN_PIC_MODEL_DYNAMIC = 1,
48 LTO_CODEGEN_PIC_MODEL_DYNAMIC_NO_PIC = 2
52 /** opaque reference to a loaded object module */
53 typedef struct LTOModule* lto_module_t;
55 /** opaque reference to a code generator */
56 typedef struct LTOCodeGenerator* lto_code_gen_t;
64 * Returns a printable string.
67 lto_get_version(void);
71 * Returns the last error string or NULL if last operation was sucessful.
74 lto_get_error_message(void);
78 * Checks if a file is a loadable object file.
81 lto_module_is_object_file(const char* path);
85 * Checks if a file is a loadable object compiled for requested target.
88 lto_module_is_object_file_for_target(const char* path,
89 const char* target_triple_prefix);
93 * Checks if a buffer is a loadable object file.
96 lto_module_is_object_file_in_memory(const void* mem, size_t length);
100 * Checks if a buffer is a loadable object compiled for requested target.
103 lto_module_is_object_file_in_memory_for_target(const void* mem, size_t length,
104 const char* target_triple_prefix);
108 * Loads an object file from disk.
109 * Returns NULL on error (check lto_get_error_message() for details).
112 lto_module_create(const char* path);
116 * Loads an object file from memory.
117 * Returns NULL on error (check lto_get_error_message() for details).
120 lto_module_create_from_memory(const void* mem, size_t length);
124 * Frees all memory internally allocated by the module.
125 * Upon return the lto_module_t is no longer valid.
128 lto_module_dispose(lto_module_t mod);
132 * Returns triple string which the object module was compiled under.
135 lto_module_get_target_triple(lto_module_t mod);
139 * Returns the number of symbols in the object module.
142 lto_module_get_num_symbols(lto_module_t mod);
146 * Returns the name of the ith symbol in the object module.
149 lto_module_get_symbol_name(lto_module_t mod, unsigned int index);
153 * Returns the attributes of the ith symbol in the object module.
155 extern lto_symbol_attributes
156 lto_module_get_symbol_attribute(lto_module_t mod, unsigned int index);
160 * Instantiates a code generator.
161 * Returns NULL on error (check lto_get_error_message() for details).
163 extern lto_code_gen_t
164 lto_codegen_create(void);
168 * Frees all code generator and all memory it internally allocated.
169 * Upon return the lto_code_gen_t is no longer valid.
172 lto_codegen_dispose(lto_code_gen_t);
177 * Add an object module to the set of modules for which code will be generated.
178 * Returns true on error (check lto_get_error_message() for details).
181 lto_codegen_add_module(lto_code_gen_t cg, lto_module_t mod);
186 * Sets if debug info should be generated.
187 * Returns true on error (check lto_get_error_message() for details).
190 lto_codegen_set_debug_model(lto_code_gen_t cg, lto_debug_model);
194 * Sets which PIC code model to generated.
195 * Returns true on error (check lto_get_error_message() for details).
198 lto_codegen_set_pic_model(lto_code_gen_t cg, lto_codegen_model);
202 * Adds to a list of all global symbols that must exist in the final
203 * generated code. If a function is not listed, it might be
204 * inlined into every usage and optimized away.
207 lto_codegen_add_must_preserve_symbol(lto_code_gen_t cg, const char* symbol);
211 * Writes a new object file at the specified path that contains the
212 * merged contents of all modules added so far.
213 * Returns true on error (check lto_get_error_message() for details).
216 lto_codegen_write_merged_modules(lto_code_gen_t cg, const char* path);
220 * Generates code for all added modules into one native object file.
221 * On sucess returns a pointer to a generated mach-o/ELF buffer and
222 * length set to the buffer size. The buffer is owned by the
223 * lto_code_gen_t and will be freed when lto_codegen_dispose()
224 * is called, or lto_codegen_compile() is called again.
225 * On failure, returns NULL (check lto_get_error_message() for details).
228 lto_codegen_compile(lto_code_gen_t cg, size_t* length);
232 * Sets options to help debug codegen bugs.
235 lto_codegen_debug_options(lto_code_gen_t cg, const char *);