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 16
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_COMDAT = 0x00004000
67 } lto_symbol_attributes;
70 * \since prior to LTO_API_VERSION=3
73 LTO_DEBUG_MODEL_NONE = 0,
74 LTO_DEBUG_MODEL_DWARF = 1
78 * \since prior to LTO_API_VERSION=3
81 LTO_CODEGEN_PIC_MODEL_STATIC = 0,
82 LTO_CODEGEN_PIC_MODEL_DYNAMIC = 1,
83 LTO_CODEGEN_PIC_MODEL_DYNAMIC_NO_PIC = 2,
84 LTO_CODEGEN_PIC_MODEL_DEFAULT = 3
87 /** opaque reference to a loaded object module */
88 typedef struct LLVMOpaqueLTOModule *lto_module_t;
90 /** opaque reference to a code generator */
91 typedef struct LLVMOpaqueLTOCodeGenerator *lto_code_gen_t;
98 * Returns a printable string.
100 * \since prior to LTO_API_VERSION=3
103 lto_get_version(void);
107 * Returns the last error string or NULL if last operation was successful.
109 * \since prior to LTO_API_VERSION=3
112 lto_get_error_message(void);
115 * Checks if a file is a loadable object file.
117 * \since prior to LTO_API_VERSION=3
120 lto_module_is_object_file(const char* path);
124 * Checks if a file is a loadable object compiled for requested target.
126 * \since prior to LTO_API_VERSION=3
129 lto_module_is_object_file_for_target(const char* path,
130 const char* target_triple_prefix);
134 * Checks if a buffer is a loadable object file.
136 * \since prior to LTO_API_VERSION=3
139 lto_module_is_object_file_in_memory(const void* mem, size_t length);
143 * Checks if a buffer is a loadable object compiled for requested target.
145 * \since prior to LTO_API_VERSION=3
148 lto_module_is_object_file_in_memory_for_target(const void* mem, size_t length,
149 const char* target_triple_prefix);
153 * Loads an object file from disk.
154 * Returns NULL on error (check lto_get_error_message() for details).
156 * \since prior to LTO_API_VERSION=3
159 lto_module_create(const char* path);
163 * Loads an object file from memory.
164 * Returns NULL on error (check lto_get_error_message() for details).
166 * \since prior to LTO_API_VERSION=3
169 lto_module_create_from_memory(const void* mem, size_t length);
172 * Loads an object file from memory with an extra path argument.
173 * Returns NULL on error (check lto_get_error_message() for details).
175 * \since LTO_API_VERSION=9
178 lto_module_create_from_memory_with_path(const void* mem, size_t length,
182 * \brief Loads an object file in its own context.
184 * Loads an object file in its own LLVMContext. This function call is
185 * thread-safe. However, modules created this way should not be merged into an
186 * lto_code_gen_t using \a lto_codegen_add_module().
188 * Returns NULL on error (check lto_get_error_message() for details).
190 * \since LTO_API_VERSION=11
193 lto_module_create_in_local_context(const void *mem, size_t length,
197 * \brief Loads an object file in the codegen context.
199 * Loads an object file into the same context as \c cg. The module is safe to
200 * add using \a lto_codegen_add_module().
202 * Returns NULL on error (check lto_get_error_message() for details).
204 * \since LTO_API_VERSION=11
207 lto_module_create_in_codegen_context(const void *mem, size_t length,
208 const char *path, lto_code_gen_t cg);
211 * Loads an object file from disk. The seek point of fd is not preserved.
212 * Returns NULL on error (check lto_get_error_message() for details).
214 * \since LTO_API_VERSION=5
217 lto_module_create_from_fd(int fd, const char *path, size_t file_size);
220 * Loads an object file from disk. The seek point of fd is not preserved.
221 * Returns NULL on error (check lto_get_error_message() for details).
223 * \since LTO_API_VERSION=5
226 lto_module_create_from_fd_at_offset(int fd, const char *path, size_t file_size,
227 size_t map_size, off_t offset);
230 * Frees all memory internally allocated by the module.
231 * Upon return the lto_module_t is no longer valid.
233 * \since prior to LTO_API_VERSION=3
236 lto_module_dispose(lto_module_t mod);
239 * Returns triple string which the object module was compiled under.
241 * \since prior to LTO_API_VERSION=3
244 lto_module_get_target_triple(lto_module_t mod);
247 * Sets triple string with which the object will be codegened.
249 * \since LTO_API_VERSION=4
252 lto_module_set_target_triple(lto_module_t mod, const char *triple);
256 * Returns the number of symbols in the object module.
258 * \since prior to LTO_API_VERSION=3
261 lto_module_get_num_symbols(lto_module_t mod);
265 * Returns the name of the ith symbol in the object module.
267 * \since prior to LTO_API_VERSION=3
270 lto_module_get_symbol_name(lto_module_t mod, unsigned int index);
274 * Returns the attributes of the ith symbol in the object module.
276 * \since prior to LTO_API_VERSION=3
278 extern lto_symbol_attributes
279 lto_module_get_symbol_attribute(lto_module_t mod, unsigned int index);
283 * Returns the module's linker options.
285 * The linker options may consist of multiple flags. It is the linker's
286 * responsibility to split the flags using a platform-specific mechanism.
288 * \since LTO_API_VERSION=16
291 lto_module_get_linkeropts(lto_module_t mod);
295 * Diagnostic severity.
297 * \since LTO_API_VERSION=7
302 LTO_DS_REMARK = 3, // Added in LTO_API_VERSION=10.
304 } lto_codegen_diagnostic_severity_t;
307 * Diagnostic handler type.
308 * \p severity defines the severity.
309 * \p diag is the actual diagnostic.
310 * The diagnostic is not prefixed by any of severity keyword, e.g., 'error: '.
311 * \p ctxt is used to pass the context set with the diagnostic handler.
313 * \since LTO_API_VERSION=7
315 typedef void (*lto_diagnostic_handler_t)(
316 lto_codegen_diagnostic_severity_t severity, const char *diag, void *ctxt);
319 * Set a diagnostic handler and the related context (void *).
320 * This is more general than lto_get_error_message, as the diagnostic handler
321 * can be called at anytime within lto.
323 * \since LTO_API_VERSION=7
325 extern void lto_codegen_set_diagnostic_handler(lto_code_gen_t,
326 lto_diagnostic_handler_t,
330 * Instantiates a code generator.
331 * Returns NULL on error (check lto_get_error_message() for details).
333 * All modules added using \a lto_codegen_add_module() must have been created
334 * in the same context as the codegen.
336 * \since prior to LTO_API_VERSION=3
338 extern lto_code_gen_t
339 lto_codegen_create(void);
342 * \brief Instantiate a code generator in its own context.
344 * Instantiates a code generator in its own context. Modules added via \a
345 * lto_codegen_add_module() must have all been created in the same context,
346 * using \a lto_module_create_in_codegen_context().
348 * \since LTO_API_VERSION=11
350 extern lto_code_gen_t
351 lto_codegen_create_in_local_context(void);
354 * Frees all code generator and all memory it internally allocated.
355 * Upon return the lto_code_gen_t is no longer valid.
357 * \since prior to LTO_API_VERSION=3
360 lto_codegen_dispose(lto_code_gen_t);
363 * Add an object module to the set of modules for which code will be generated.
364 * Returns true on error (check lto_get_error_message() for details).
366 * \c cg and \c mod must both be in the same context. See \a
367 * lto_codegen_create_in_local_context() and \a
368 * lto_module_create_in_codegen_context().
370 * \since prior to LTO_API_VERSION=3
373 lto_codegen_add_module(lto_code_gen_t cg, lto_module_t mod);
376 * Sets the object module for code generation. This will transfer the ownship of
377 * the module to code generator.
379 * \c cg and \c mod must both be in the same context.
381 * \since LTO_API_VERSION=13
384 lto_codegen_set_module(lto_code_gen_t cg, lto_module_t mod);
387 * Sets if debug info should be generated.
388 * Returns true on error (check lto_get_error_message() for details).
390 * \since prior to LTO_API_VERSION=3
393 lto_codegen_set_debug_model(lto_code_gen_t cg, lto_debug_model);
397 * Sets which PIC code model to generated.
398 * Returns true on error (check lto_get_error_message() for details).
400 * \since prior to LTO_API_VERSION=3
403 lto_codegen_set_pic_model(lto_code_gen_t cg, lto_codegen_model);
407 * Sets the cpu to generate code for.
409 * \since LTO_API_VERSION=4
412 lto_codegen_set_cpu(lto_code_gen_t cg, const char *cpu);
416 * Sets the location of the assembler tool to run. If not set, libLTO
417 * will use gcc to invoke the assembler.
419 * \since LTO_API_VERSION=3
422 lto_codegen_set_assembler_path(lto_code_gen_t cg, const char* path);
425 * Sets extra arguments that libLTO should pass to the assembler.
427 * \since LTO_API_VERSION=4
430 lto_codegen_set_assembler_args(lto_code_gen_t cg, const char **args,
434 * Adds to a list of all global symbols that must exist in the final generated
435 * code. If a function is not listed there, it might be inlined into every usage
436 * and optimized away.
438 * \since prior to LTO_API_VERSION=3
441 lto_codegen_add_must_preserve_symbol(lto_code_gen_t cg, const char* symbol);
444 * Writes a new object file at the specified path that contains the
445 * merged contents of all modules added so far.
446 * Returns true on error (check lto_get_error_message() for details).
448 * \since LTO_API_VERSION=5
451 lto_codegen_write_merged_modules(lto_code_gen_t cg, const char* path);
454 * Generates code for all added modules into one native object file.
455 * This calls lto_codegen_optimize then lto_codegen_compile_optimized.
457 * On success returns a pointer to a generated mach-o/ELF buffer and
458 * length set to the buffer size. The buffer is owned by the
459 * lto_code_gen_t and will be freed when lto_codegen_dispose()
460 * is called, or lto_codegen_compile() is called again.
461 * On failure, returns NULL (check lto_get_error_message() for details).
463 * \since prior to LTO_API_VERSION=3
466 lto_codegen_compile(lto_code_gen_t cg, size_t* length);
469 * Generates code for all added modules into one native object file.
470 * This calls lto_codegen_optimize then lto_codegen_compile_optimized (instead
471 * of returning a generated mach-o/ELF buffer, it writes to a file).
473 * The name of the file is written to name. Returns true on error.
475 * \since LTO_API_VERSION=5
478 lto_codegen_compile_to_file(lto_code_gen_t cg, const char** name);
481 * Runs optimization for the merged module. Returns true on error.
483 * \since LTO_API_VERSION=12
486 lto_codegen_optimize(lto_code_gen_t cg);
489 * Generates code for the optimized merged module into one native object file.
490 * It will not run any IR optimizations on the merged module.
492 * On success returns a pointer to a generated mach-o/ELF buffer and length set
493 * to the buffer size. The buffer is owned by the lto_code_gen_t and will be
494 * freed when lto_codegen_dispose() is called, or
495 * lto_codegen_compile_optimized() is called again. On failure, returns NULL
496 * (check lto_get_error_message() for details).
498 * \since LTO_API_VERSION=12
501 lto_codegen_compile_optimized(lto_code_gen_t cg, size_t* length);
504 * Returns the runtime API version.
506 * \since LTO_API_VERSION=12
509 lto_api_version(void);
512 * Sets options to help debug codegen bugs.
514 * \since prior to LTO_API_VERSION=3
517 lto_codegen_debug_options(lto_code_gen_t cg, const char *);
520 * Initializes LLVM disassemblers.
521 * FIXME: This doesn't really belong here.
523 * \since LTO_API_VERSION=5
526 lto_initialize_disassembler(void);
529 * Sets if we should run internalize pass during optimization and code
532 * \since LTO_API_VERSION=14
535 lto_codegen_set_should_internalize(lto_code_gen_t cg,
536 lto_bool_t ShouldInternalize);
539 * \brief Set whether to embed uselists in bitcode.
541 * Sets whether \a lto_codegen_write_merged_modules() should embed uselists in
542 * output bitcode. This should be turned on for all -save-temps output.
544 * \since LTO_API_VERSION=15
547 lto_codegen_set_should_embed_uselists(lto_code_gen_t cg,
548 lto_bool_t ShouldEmbedUselists);