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 17
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_ALIAS = 0x00008000
68 } lto_symbol_attributes;
71 * \since prior to LTO_API_VERSION=3
74 LTO_DEBUG_MODEL_NONE = 0,
75 LTO_DEBUG_MODEL_DWARF = 1
79 * \since prior to LTO_API_VERSION=3
82 LTO_CODEGEN_PIC_MODEL_STATIC = 0,
83 LTO_CODEGEN_PIC_MODEL_DYNAMIC = 1,
84 LTO_CODEGEN_PIC_MODEL_DYNAMIC_NO_PIC = 2,
85 LTO_CODEGEN_PIC_MODEL_DEFAULT = 3
88 /** opaque reference to a loaded object module */
89 typedef struct LLVMOpaqueLTOModule *lto_module_t;
91 /** opaque reference to a code generator */
92 typedef struct LLVMOpaqueLTOCodeGenerator *lto_code_gen_t;
99 * Returns a printable string.
101 * \since prior to LTO_API_VERSION=3
104 lto_get_version(void);
108 * Returns the last error string or NULL if last operation was successful.
110 * \since prior to LTO_API_VERSION=3
113 lto_get_error_message(void);
116 * Checks if a file is a loadable object file.
118 * \since prior to LTO_API_VERSION=3
121 lto_module_is_object_file(const char* path);
125 * Checks if a file is a loadable object compiled for requested target.
127 * \since prior to LTO_API_VERSION=3
130 lto_module_is_object_file_for_target(const char* path,
131 const char* target_triple_prefix);
135 * Checks if a buffer is a loadable object file.
137 * \since prior to LTO_API_VERSION=3
140 lto_module_is_object_file_in_memory(const void* mem, size_t length);
144 * Checks if a buffer is a loadable object compiled for requested target.
146 * \since prior to LTO_API_VERSION=3
149 lto_module_is_object_file_in_memory_for_target(const void* mem, size_t length,
150 const char* target_triple_prefix);
154 * Loads an object file from disk.
155 * Returns NULL on error (check lto_get_error_message() for details).
157 * \since prior to LTO_API_VERSION=3
160 lto_module_create(const char* path);
164 * Loads an object file from memory.
165 * Returns NULL on error (check lto_get_error_message() for details).
167 * \since prior to LTO_API_VERSION=3
170 lto_module_create_from_memory(const void* mem, size_t length);
173 * Loads an object file from memory with an extra path argument.
174 * Returns NULL on error (check lto_get_error_message() for details).
176 * \since LTO_API_VERSION=9
179 lto_module_create_from_memory_with_path(const void* mem, size_t length,
183 * \brief Loads an object file in its own context.
185 * Loads an object file in its own LLVMContext. This function call is
186 * thread-safe. However, modules created this way should not be merged into an
187 * lto_code_gen_t using \a lto_codegen_add_module().
189 * Returns NULL on error (check lto_get_error_message() for details).
191 * \since LTO_API_VERSION=11
194 lto_module_create_in_local_context(const void *mem, size_t length,
198 * \brief Loads an object file in the codegen context.
200 * Loads an object file into the same context as \c cg. The module is safe to
201 * add using \a lto_codegen_add_module().
203 * Returns NULL on error (check lto_get_error_message() for details).
205 * \since LTO_API_VERSION=11
208 lto_module_create_in_codegen_context(const void *mem, size_t length,
209 const char *path, lto_code_gen_t cg);
212 * Loads an object file from disk. The seek point of fd is not preserved.
213 * Returns NULL on error (check lto_get_error_message() for details).
215 * \since LTO_API_VERSION=5
218 lto_module_create_from_fd(int fd, const char *path, size_t file_size);
221 * Loads an object file from disk. The seek point of fd is not preserved.
222 * Returns NULL on error (check lto_get_error_message() for details).
224 * \since LTO_API_VERSION=5
227 lto_module_create_from_fd_at_offset(int fd, const char *path, size_t file_size,
228 size_t map_size, off_t offset);
231 * Frees all memory internally allocated by the module.
232 * Upon return the lto_module_t is no longer valid.
234 * \since prior to LTO_API_VERSION=3
237 lto_module_dispose(lto_module_t mod);
240 * Returns triple string which the object module was compiled under.
242 * \since prior to LTO_API_VERSION=3
245 lto_module_get_target_triple(lto_module_t mod);
248 * Sets triple string with which the object will be codegened.
250 * \since LTO_API_VERSION=4
253 lto_module_set_target_triple(lto_module_t mod, const char *triple);
257 * Returns the number of symbols in the object module.
259 * \since prior to LTO_API_VERSION=3
262 lto_module_get_num_symbols(lto_module_t mod);
266 * Returns the name of the ith symbol in the object module.
268 * \since prior to LTO_API_VERSION=3
271 lto_module_get_symbol_name(lto_module_t mod, unsigned int index);
275 * Returns the attributes of the ith symbol in the object module.
277 * \since prior to LTO_API_VERSION=3
279 extern lto_symbol_attributes
280 lto_module_get_symbol_attribute(lto_module_t mod, unsigned int index);
284 * Returns the module's linker options.
286 * The linker options may consist of multiple flags. It is the linker's
287 * responsibility to split the flags using a platform-specific mechanism.
289 * \since LTO_API_VERSION=16
292 lto_module_get_linkeropts(lto_module_t mod);
296 * Diagnostic severity.
298 * \since LTO_API_VERSION=7
303 LTO_DS_REMARK = 3, // Added in LTO_API_VERSION=10.
305 } lto_codegen_diagnostic_severity_t;
308 * Diagnostic handler type.
309 * \p severity defines the severity.
310 * \p diag is the actual diagnostic.
311 * The diagnostic is not prefixed by any of severity keyword, e.g., 'error: '.
312 * \p ctxt is used to pass the context set with the diagnostic handler.
314 * \since LTO_API_VERSION=7
316 typedef void (*lto_diagnostic_handler_t)(
317 lto_codegen_diagnostic_severity_t severity, const char *diag, void *ctxt);
320 * Set a diagnostic handler and the related context (void *).
321 * This is more general than lto_get_error_message, as the diagnostic handler
322 * can be called at anytime within lto.
324 * \since LTO_API_VERSION=7
326 extern void lto_codegen_set_diagnostic_handler(lto_code_gen_t,
327 lto_diagnostic_handler_t,
331 * Instantiates a code generator.
332 * Returns NULL on error (check lto_get_error_message() for details).
334 * All modules added using \a lto_codegen_add_module() must have been created
335 * in the same context as the codegen.
337 * \since prior to LTO_API_VERSION=3
339 extern lto_code_gen_t
340 lto_codegen_create(void);
343 * \brief Instantiate a code generator in its own context.
345 * Instantiates a code generator in its own context. Modules added via \a
346 * lto_codegen_add_module() must have all been created in the same context,
347 * using \a lto_module_create_in_codegen_context().
349 * \since LTO_API_VERSION=11
351 extern lto_code_gen_t
352 lto_codegen_create_in_local_context(void);
355 * Frees all code generator and all memory it internally allocated.
356 * Upon return the lto_code_gen_t is no longer valid.
358 * \since prior to LTO_API_VERSION=3
361 lto_codegen_dispose(lto_code_gen_t);
364 * Add an object module to the set of modules for which code will be generated.
365 * Returns true on error (check lto_get_error_message() for details).
367 * \c cg and \c mod must both be in the same context. See \a
368 * lto_codegen_create_in_local_context() and \a
369 * lto_module_create_in_codegen_context().
371 * \since prior to LTO_API_VERSION=3
374 lto_codegen_add_module(lto_code_gen_t cg, lto_module_t mod);
377 * Sets the object module for code generation. This will transfer the ownership
378 * of the module to the code generator.
380 * \c cg and \c mod must both be in the same context.
382 * \since LTO_API_VERSION=13
385 lto_codegen_set_module(lto_code_gen_t cg, lto_module_t mod);
388 * Sets if debug info should be generated.
389 * Returns true on error (check lto_get_error_message() for details).
391 * \since prior to LTO_API_VERSION=3
394 lto_codegen_set_debug_model(lto_code_gen_t cg, lto_debug_model);
398 * Sets which PIC code model to generated.
399 * Returns true on error (check lto_get_error_message() for details).
401 * \since prior to LTO_API_VERSION=3
404 lto_codegen_set_pic_model(lto_code_gen_t cg, lto_codegen_model);
408 * Sets the cpu to generate code for.
410 * \since LTO_API_VERSION=4
413 lto_codegen_set_cpu(lto_code_gen_t cg, const char *cpu);
417 * Sets the location of the assembler tool to run. If not set, libLTO
418 * will use gcc to invoke the assembler.
420 * \since LTO_API_VERSION=3
423 lto_codegen_set_assembler_path(lto_code_gen_t cg, const char* path);
426 * Sets extra arguments that libLTO should pass to the assembler.
428 * \since LTO_API_VERSION=4
431 lto_codegen_set_assembler_args(lto_code_gen_t cg, const char **args,
435 * Adds to a list of all global symbols that must exist in the final generated
436 * code. If a function is not listed there, it might be inlined into every usage
437 * and optimized away.
439 * \since prior to LTO_API_VERSION=3
442 lto_codegen_add_must_preserve_symbol(lto_code_gen_t cg, const char* symbol);
445 * Writes a new object file at the specified path that contains the
446 * merged contents of all modules added so far.
447 * Returns true on error (check lto_get_error_message() for details).
449 * \since LTO_API_VERSION=5
452 lto_codegen_write_merged_modules(lto_code_gen_t cg, const char* path);
455 * Generates code for all added modules into one native object file.
456 * This calls lto_codegen_optimize then lto_codegen_compile_optimized.
458 * On success returns a pointer to a generated mach-o/ELF buffer and
459 * length set to the buffer size. The buffer is owned by the
460 * lto_code_gen_t and will be freed when lto_codegen_dispose()
461 * is called, or lto_codegen_compile() is called again.
462 * On failure, returns NULL (check lto_get_error_message() for details).
464 * \since prior to LTO_API_VERSION=3
467 lto_codegen_compile(lto_code_gen_t cg, size_t* length);
470 * Generates code for all added modules into one native object file.
471 * This calls lto_codegen_optimize then lto_codegen_compile_optimized (instead
472 * of returning a generated mach-o/ELF buffer, it writes to a file).
474 * The name of the file is written to name. Returns true on error.
476 * \since LTO_API_VERSION=5
479 lto_codegen_compile_to_file(lto_code_gen_t cg, const char** name);
482 * Runs optimization for the merged module. Returns true on error.
484 * \since LTO_API_VERSION=12
487 lto_codegen_optimize(lto_code_gen_t cg);
490 * Generates code for the optimized merged module into one native object file.
491 * It will not run any IR optimizations on the merged module.
493 * On success returns a pointer to a generated mach-o/ELF buffer and length set
494 * to the buffer size. The buffer is owned by the lto_code_gen_t and will be
495 * freed when lto_codegen_dispose() is called, or
496 * lto_codegen_compile_optimized() is called again. On failure, returns NULL
497 * (check lto_get_error_message() for details).
499 * \since LTO_API_VERSION=12
502 lto_codegen_compile_optimized(lto_code_gen_t cg, size_t* length);
505 * Returns the runtime API version.
507 * \since LTO_API_VERSION=12
510 lto_api_version(void);
513 * Sets options to help debug codegen bugs.
515 * \since prior to LTO_API_VERSION=3
518 lto_codegen_debug_options(lto_code_gen_t cg, const char *);
521 * Initializes LLVM disassemblers.
522 * FIXME: This doesn't really belong here.
524 * \since LTO_API_VERSION=5
527 lto_initialize_disassembler(void);
530 * Sets if we should run internalize pass during optimization and code
533 * \since LTO_API_VERSION=14
536 lto_codegen_set_should_internalize(lto_code_gen_t cg,
537 lto_bool_t ShouldInternalize);
540 * \brief Set whether to embed uselists in bitcode.
542 * Sets whether \a lto_codegen_write_merged_modules() should embed uselists in
543 * output bitcode. This should be turned on for all -save-temps output.
545 * \since LTO_API_VERSION=15
548 lto_codegen_set_should_embed_uselists(lto_code_gen_t cg,
549 lto_bool_t ShouldEmbedUselists);