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 10
46 * \since prior to LTO_API_VERSION=3
49 LTO_SYMBOL_ALIGNMENT_MASK = 0x0000001F, /* log2 of alignment */
50 LTO_SYMBOL_PERMISSIONS_MASK = 0x000000E0,
51 LTO_SYMBOL_PERMISSIONS_CODE = 0x000000A0,
52 LTO_SYMBOL_PERMISSIONS_DATA = 0x000000C0,
53 LTO_SYMBOL_PERMISSIONS_RODATA = 0x00000080,
54 LTO_SYMBOL_DEFINITION_MASK = 0x00000700,
55 LTO_SYMBOL_DEFINITION_REGULAR = 0x00000100,
56 LTO_SYMBOL_DEFINITION_TENTATIVE = 0x00000200,
57 LTO_SYMBOL_DEFINITION_WEAK = 0x00000300,
58 LTO_SYMBOL_DEFINITION_UNDEFINED = 0x00000400,
59 LTO_SYMBOL_DEFINITION_WEAKUNDEF = 0x00000500,
60 LTO_SYMBOL_SCOPE_MASK = 0x00003800,
61 LTO_SYMBOL_SCOPE_INTERNAL = 0x00000800,
62 LTO_SYMBOL_SCOPE_HIDDEN = 0x00001000,
63 LTO_SYMBOL_SCOPE_PROTECTED = 0x00002000,
64 LTO_SYMBOL_SCOPE_DEFAULT = 0x00001800,
65 LTO_SYMBOL_SCOPE_DEFAULT_CAN_BE_HIDDEN = 0x00002800
66 } lto_symbol_attributes;
69 * \since prior to LTO_API_VERSION=3
72 LTO_DEBUG_MODEL_NONE = 0,
73 LTO_DEBUG_MODEL_DWARF = 1
77 * \since prior to LTO_API_VERSION=3
80 LTO_CODEGEN_PIC_MODEL_STATIC = 0,
81 LTO_CODEGEN_PIC_MODEL_DYNAMIC = 1,
82 LTO_CODEGEN_PIC_MODEL_DYNAMIC_NO_PIC = 2
86 * \since LTO_API_VERSION=6
89 LTO_INTERNALIZE_FULL = 0,
90 LTO_INTERNALIZE_NONE = 1,
91 LTO_INTERNALIZE_HIDDEN = 2
92 } lto_internalize_strategy;
94 /** opaque reference to a loaded object module */
95 typedef struct LTOModule* lto_module_t;
97 /** opaque reference to a code generator */
98 typedef struct LTOCodeGenerator* lto_code_gen_t;
105 * Returns a printable string.
107 * \since prior to LTO_API_VERSION=3
110 lto_get_version(void);
114 * Returns the last error string or NULL if last operation was successful.
116 * \since prior to LTO_API_VERSION=3
119 lto_get_error_message(void);
122 * Checks if a file is a loadable object file.
124 * \since prior to LTO_API_VERSION=3
127 lto_module_is_object_file(const char* path);
131 * Checks if a file is a loadable object compiled for requested target.
133 * \since prior to LTO_API_VERSION=3
136 lto_module_is_object_file_for_target(const char* path,
137 const char* target_triple_prefix);
141 * Checks if a buffer is a loadable object file.
143 * \since prior to LTO_API_VERSION=3
146 lto_module_is_object_file_in_memory(const void* mem, size_t length);
150 * Checks if a buffer is a loadable object compiled for requested target.
152 * \since prior to LTO_API_VERSION=3
155 lto_module_is_object_file_in_memory_for_target(const void* mem, size_t length,
156 const char* target_triple_prefix);
160 * Loads an object file from disk.
161 * Returns NULL on error (check lto_get_error_message() for details).
163 * \since prior to LTO_API_VERSION=3
166 lto_module_create(const char* path);
170 * Loads an object file from memory.
171 * Returns NULL on error (check lto_get_error_message() for details).
173 * \since prior to LTO_API_VERSION=3
176 lto_module_create_from_memory(const void* mem, size_t length);
179 * Loads an object file from memory with an extra path argument.
180 * Returns NULL on error (check lto_get_error_message() for details).
182 * \since prior to LTO_API_VERSION=9
185 lto_module_create_from_memory_with_path(const void* mem, size_t length,
189 * Loads an object file from disk. The seek point of fd is not preserved.
190 * Returns NULL on error (check lto_get_error_message() for details).
192 * \since LTO_API_VERSION=5
195 lto_module_create_from_fd(int fd, const char *path, size_t file_size);
198 * Loads an object file from disk. The seek point of fd is not preserved.
199 * Returns NULL on error (check lto_get_error_message() for details).
201 * \since LTO_API_VERSION=5
204 lto_module_create_from_fd_at_offset(int fd, const char *path, size_t file_size,
205 size_t map_size, off_t offset);
208 * Frees all memory internally allocated by the module.
209 * Upon return the lto_module_t is no longer valid.
211 * \since prior to LTO_API_VERSION=3
214 lto_module_dispose(lto_module_t mod);
217 * Returns triple string which the object module was compiled under.
219 * \since prior to LTO_API_VERSION=3
222 lto_module_get_target_triple(lto_module_t mod);
225 * Sets triple string with which the object will be codegened.
227 * \since LTO_API_VERSION=4
230 lto_module_set_target_triple(lto_module_t mod, const char *triple);
234 * Returns the number of symbols in the object module.
236 * \since prior to LTO_API_VERSION=3
239 lto_module_get_num_symbols(lto_module_t mod);
243 * Returns the name of the ith symbol in the object module.
245 * \since prior to LTO_API_VERSION=3
248 lto_module_get_symbol_name(lto_module_t mod, unsigned int index);
252 * Returns the attributes of the ith symbol in the object module.
254 * \since prior to LTO_API_VERSION=3
256 extern lto_symbol_attributes
257 lto_module_get_symbol_attribute(lto_module_t mod, unsigned int index);
261 * Returns the number of dependent libraries in the object module.
263 * \since LTO_API_VERSION=8
266 lto_module_get_num_deplibs(lto_module_t mod);
270 * Returns the ith dependent library in the module.
272 * \since LTO_API_VERSION=8
275 lto_module_get_deplib(lto_module_t mod, unsigned int index);
279 * Returns the number of linker options in the object module.
281 * \since LTO_API_VERSION=8
284 lto_module_get_num_linkeropts(lto_module_t mod);
288 * Returns the ith linker option in the module.
290 * \since LTO_API_VERSION=8
293 lto_module_get_linkeropt(lto_module_t mod, unsigned int index);
297 * Diagnostic severity.
299 * \since LTO_API_VERSION=7
304 LTO_DS_REMARK = 3, // Added in LTO_API_VERSION=10.
306 } lto_codegen_diagnostic_severity_t;
309 * Diagnostic handler type.
310 * \p severity defines the severity.
311 * \p diag is the actual diagnostic.
312 * The diagnostic is not prefixed by any of severity keyword, e.g., 'error: '.
313 * \p ctxt is used to pass the context set with the diagnostic handler.
315 * \since LTO_API_VERSION=7
317 typedef void (*lto_diagnostic_handler_t)(
318 lto_codegen_diagnostic_severity_t severity, const char *diag, void *ctxt);
321 * Set a diagnostic handler and the related context (void *).
322 * This is more general than lto_get_error_message, as the diagnostic handler
323 * can be called at anytime within lto.
325 * \since LTO_API_VERSION=7
327 extern void lto_codegen_set_diagnostic_handler(lto_code_gen_t,
328 lto_diagnostic_handler_t,
332 * Instantiates a code generator.
333 * Returns NULL on error (check lto_get_error_message() for details).
335 * \since prior to LTO_API_VERSION=3
337 extern lto_code_gen_t
338 lto_codegen_create(void);
341 * Frees all code generator and all memory it internally allocated.
342 * Upon return the lto_code_gen_t is no longer valid.
344 * \since prior to LTO_API_VERSION=3
347 lto_codegen_dispose(lto_code_gen_t);
350 * Add an object module to the set of modules for which code will be generated.
351 * Returns true on error (check lto_get_error_message() for details).
353 * \since prior to LTO_API_VERSION=3
356 lto_codegen_add_module(lto_code_gen_t cg, lto_module_t mod);
359 * Sets if debug info should be generated.
360 * Returns true on error (check lto_get_error_message() for details).
362 * \since prior to LTO_API_VERSION=3
365 lto_codegen_set_debug_model(lto_code_gen_t cg, lto_debug_model);
369 * Sets which PIC code model to generated.
370 * Returns true on error (check lto_get_error_message() for details).
372 * \since prior to LTO_API_VERSION=3
375 lto_codegen_set_pic_model(lto_code_gen_t cg, lto_codegen_model);
379 * Sets the cpu to generate code for.
381 * \since LTO_API_VERSION=4
384 lto_codegen_set_cpu(lto_code_gen_t cg, const char *cpu);
388 * Sets the location of the assembler tool to run. If not set, libLTO
389 * will use gcc to invoke the assembler.
391 * \since LTO_API_VERSION=3
394 lto_codegen_set_assembler_path(lto_code_gen_t cg, const char* path);
397 * Sets extra arguments that libLTO should pass to the assembler.
399 * \since LTO_API_VERSION=4
402 lto_codegen_set_assembler_args(lto_code_gen_t cg, const char **args,
406 * Sets the strategy to use during internalize. Default strategy is
407 * LTO_INTERNALIZE_FULL.
409 * \since LTO_API_VERSION=6
412 lto_codegen_set_internalize_strategy(lto_code_gen_t cg,
413 lto_internalize_strategy);
416 * Tells LTO optimization passes that this symbol must be preserved
417 * because it is referenced by native code or a command line option.
419 * \since prior to LTO_API_VERSION=3
422 lto_codegen_add_must_preserve_symbol(lto_code_gen_t cg, const char* symbol);
425 * Writes a new object file at the specified path that contains the
426 * merged contents of all modules added so far.
427 * Returns true on error (check lto_get_error_message() for details).
429 * \since LTO_API_VERSION=5
432 lto_codegen_write_merged_modules(lto_code_gen_t cg, const char* path);
435 * Generates code for all added modules into one native object file.
436 * On success returns a pointer to a generated mach-o/ELF buffer and
437 * length set to the buffer size. The buffer is owned by the
438 * lto_code_gen_t and will be freed when lto_codegen_dispose()
439 * is called, or lto_codegen_compile() is called again.
440 * On failure, returns NULL (check lto_get_error_message() for details).
442 * \since prior to LTO_API_VERSION=3
445 lto_codegen_compile(lto_code_gen_t cg, size_t* length);
448 * Generates code for all added modules into one native object file.
449 * The name of the file is written to name. Returns true on error.
451 * \since LTO_API_VERSION=5
454 lto_codegen_compile_to_file(lto_code_gen_t cg, const char** name);
458 * Sets options to help debug codegen bugs.
460 * \since prior to LTO_API_VERSION=3
463 lto_codegen_debug_options(lto_code_gen_t cg, const char *);
466 * Initializes LLVM disassemblers.
467 * FIXME: This doesn't really belong here.
469 * \since LTO_API_VERSION=5
472 lto_initialize_disassembler(void);