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 14
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,
83 LTO_CODEGEN_PIC_MODEL_DEFAULT = 3
86 /** opaque reference to a loaded object module */
87 typedef struct LLVMOpaqueLTOModule *lto_module_t;
89 /** opaque reference to a code generator */
90 typedef struct LLVMOpaqueLTOCodeGenerator *lto_code_gen_t;
97 * Returns a printable string.
99 * \since prior to LTO_API_VERSION=3
102 lto_get_version(void);
106 * Returns the last error string or NULL if last operation was successful.
108 * \since prior to LTO_API_VERSION=3
111 lto_get_error_message(void);
114 * Checks if a file is a loadable object file.
116 * \since prior to LTO_API_VERSION=3
119 lto_module_is_object_file(const char* path);
123 * Checks if a file is a loadable object compiled for requested target.
125 * \since prior to LTO_API_VERSION=3
128 lto_module_is_object_file_for_target(const char* path,
129 const char* target_triple_prefix);
133 * Checks if a buffer is a loadable object file.
135 * \since prior to LTO_API_VERSION=3
138 lto_module_is_object_file_in_memory(const void* mem, size_t length);
142 * Checks if a buffer is a loadable object compiled for requested target.
144 * \since prior to LTO_API_VERSION=3
147 lto_module_is_object_file_in_memory_for_target(const void* mem, size_t length,
148 const char* target_triple_prefix);
152 * Loads an object file from disk.
153 * Returns NULL on error (check lto_get_error_message() for details).
155 * \since prior to LTO_API_VERSION=3
158 lto_module_create(const char* path);
162 * Loads an object file from memory.
163 * Returns NULL on error (check lto_get_error_message() for details).
165 * \since prior to LTO_API_VERSION=3
168 lto_module_create_from_memory(const void* mem, size_t length);
171 * Loads an object file from memory with an extra path argument.
172 * Returns NULL on error (check lto_get_error_message() for details).
174 * \since prior to LTO_API_VERSION=9
177 lto_module_create_from_memory_with_path(const void* mem, size_t length,
181 * \brief Loads an object file in its own context.
183 * Loads an object file in its own LLVMContext. This function call is
184 * thread-safe. However, modules created this way should not be merged into an
185 * lto_code_gen_t using \a lto_codegen_add_module().
187 * Returns NULL on error (check lto_get_error_message() for details).
189 * \since LTO_API_VERSION=11
192 lto_module_create_in_local_context(const void *mem, size_t length,
196 * \brief Loads an object file in the codegen context.
198 * Loads an object file into the same context as \c cg. The module is safe to
199 * add using \a lto_codegen_add_module().
201 * Returns NULL on error (check lto_get_error_message() for details).
203 * \since LTO_API_VERSION=11
206 lto_module_create_in_codegen_context(const void *mem, size_t length,
207 const char *path, lto_code_gen_t cg);
210 * Loads an object file from disk. The seek point of fd is not preserved.
211 * Returns NULL on error (check lto_get_error_message() for details).
213 * \since LTO_API_VERSION=5
216 lto_module_create_from_fd(int fd, const char *path, size_t file_size);
219 * Loads an object file from disk. The seek point of fd is not preserved.
220 * Returns NULL on error (check lto_get_error_message() for details).
222 * \since LTO_API_VERSION=5
225 lto_module_create_from_fd_at_offset(int fd, const char *path, size_t file_size,
226 size_t map_size, off_t offset);
229 * Frees all memory internally allocated by the module.
230 * Upon return the lto_module_t is no longer valid.
232 * \since prior to LTO_API_VERSION=3
235 lto_module_dispose(lto_module_t mod);
238 * Returns triple string which the object module was compiled under.
240 * \since prior to LTO_API_VERSION=3
243 lto_module_get_target_triple(lto_module_t mod);
246 * Sets triple string with which the object will be codegened.
248 * \since LTO_API_VERSION=4
251 lto_module_set_target_triple(lto_module_t mod, const char *triple);
255 * Returns the number of symbols in the object module.
257 * \since prior to LTO_API_VERSION=3
260 lto_module_get_num_symbols(lto_module_t mod);
264 * Returns the name of the ith symbol in the object module.
266 * \since prior to LTO_API_VERSION=3
269 lto_module_get_symbol_name(lto_module_t mod, unsigned int index);
273 * Returns the attributes of the ith symbol in the object module.
275 * \since prior to LTO_API_VERSION=3
277 extern lto_symbol_attributes
278 lto_module_get_symbol_attribute(lto_module_t mod, unsigned int index);
282 * Returns the number of dependent libraries in the object module.
284 * \since LTO_API_VERSION=8
287 lto_module_get_num_deplibs(lto_module_t mod);
291 * Returns the ith dependent library in the module.
293 * \since LTO_API_VERSION=8
296 lto_module_get_deplib(lto_module_t mod, unsigned int index);
300 * Returns the number of linker options in the object module.
302 * \since LTO_API_VERSION=8
305 lto_module_get_num_linkeropts(lto_module_t mod);
309 * Returns the ith linker option in the module.
311 * \since LTO_API_VERSION=8
314 lto_module_get_linkeropt(lto_module_t mod, unsigned int index);
318 * Diagnostic severity.
320 * \since LTO_API_VERSION=7
325 LTO_DS_REMARK = 3, // Added in LTO_API_VERSION=10.
327 } lto_codegen_diagnostic_severity_t;
330 * Diagnostic handler type.
331 * \p severity defines the severity.
332 * \p diag is the actual diagnostic.
333 * The diagnostic is not prefixed by any of severity keyword, e.g., 'error: '.
334 * \p ctxt is used to pass the context set with the diagnostic handler.
336 * \since LTO_API_VERSION=7
338 typedef void (*lto_diagnostic_handler_t)(
339 lto_codegen_diagnostic_severity_t severity, const char *diag, void *ctxt);
342 * Set a diagnostic handler and the related context (void *).
343 * This is more general than lto_get_error_message, as the diagnostic handler
344 * can be called at anytime within lto.
346 * \since LTO_API_VERSION=7
348 extern void lto_codegen_set_diagnostic_handler(lto_code_gen_t,
349 lto_diagnostic_handler_t,
353 * Instantiates a code generator.
354 * Returns NULL on error (check lto_get_error_message() for details).
356 * All modules added using \a lto_codegen_add_module() must have been created
357 * in the same context as the codegen.
359 * \since prior to LTO_API_VERSION=3
361 extern lto_code_gen_t
362 lto_codegen_create(void);
365 * \brief Instantiate a code generator in its own context.
367 * Instantiates a code generator in its own context. Modules added via \a
368 * lto_codegen_add_module() must have all been created in the same context,
369 * using \a lto_module_create_in_codegen_context().
371 * \since LTO_API_VERSION=11
373 extern lto_code_gen_t
374 lto_codegen_create_in_local_context(void);
377 * Frees all code generator and all memory it internally allocated.
378 * Upon return the lto_code_gen_t is no longer valid.
380 * \since prior to LTO_API_VERSION=3
383 lto_codegen_dispose(lto_code_gen_t);
386 * Add an object module to the set of modules for which code will be generated.
387 * Returns true on error (check lto_get_error_message() for details).
389 * \c cg and \c mod must both be in the same context. See \a
390 * lto_codegen_create_in_local_context() and \a
391 * lto_module_create_in_codegen_context().
393 * \since prior to LTO_API_VERSION=3
396 lto_codegen_add_module(lto_code_gen_t cg, lto_module_t mod);
399 * Sets the object module for code generation. This will transfer the ownship of
400 * the module to code generator.
402 * \c cg and \c mod must both be in the same context.
404 * \since prior to LTO_API_VERSION=13
407 lto_codegen_set_module(lto_code_gen_t cg, lto_module_t mod);
410 * Sets if debug info should be generated.
411 * Returns true on error (check lto_get_error_message() for details).
413 * \since prior to LTO_API_VERSION=3
416 lto_codegen_set_debug_model(lto_code_gen_t cg, lto_debug_model);
420 * Sets which PIC code model to generated.
421 * Returns true on error (check lto_get_error_message() for details).
423 * \since prior to LTO_API_VERSION=3
426 lto_codegen_set_pic_model(lto_code_gen_t cg, lto_codegen_model);
430 * Sets the cpu to generate code for.
432 * \since LTO_API_VERSION=4
435 lto_codegen_set_cpu(lto_code_gen_t cg, const char *cpu);
439 * Sets the location of the assembler tool to run. If not set, libLTO
440 * will use gcc to invoke the assembler.
442 * \since LTO_API_VERSION=3
445 lto_codegen_set_assembler_path(lto_code_gen_t cg, const char* path);
448 * Sets extra arguments that libLTO should pass to the assembler.
450 * \since LTO_API_VERSION=4
453 lto_codegen_set_assembler_args(lto_code_gen_t cg, const char **args,
457 * Adds to a list of all global symbols that must exist in the final generated
458 * code. If a function is not listed there, it might be inlined into every usage
459 * and optimized away.
461 * \since prior to LTO_API_VERSION=3
464 lto_codegen_add_must_preserve_symbol(lto_code_gen_t cg, const char* symbol);
467 * Writes a new object file at the specified path that contains the
468 * merged contents of all modules added so far.
469 * Returns true on error (check lto_get_error_message() for details).
471 * \since LTO_API_VERSION=5
474 lto_codegen_write_merged_modules(lto_code_gen_t cg, const char* path);
477 * Generates code for all added modules into one native object file.
478 * This calls lto_codegen_optimize then lto_codegen_compile_optimized.
480 * On success returns a pointer to a generated mach-o/ELF buffer and
481 * length set to the buffer size. The buffer is owned by the
482 * lto_code_gen_t and will be freed when lto_codegen_dispose()
483 * is called, or lto_codegen_compile() is called again.
484 * On failure, returns NULL (check lto_get_error_message() for details).
486 * \since prior to LTO_API_VERSION=3
489 lto_codegen_compile(lto_code_gen_t cg, size_t* length);
492 * Generates code for all added modules into one native object file.
493 * This calls lto_codegen_optimize then lto_codegen_compile_optimized (instead
494 * of returning a generated mach-o/ELF buffer, it writes to a file).
496 * The name of the file is written to name. Returns true on error.
498 * \since LTO_API_VERSION=5
501 lto_codegen_compile_to_file(lto_code_gen_t cg, const char** name);
504 * Runs optimization for the merged module. Returns true on error.
506 * \since LTO_API_VERSION=12
509 lto_codegen_optimize(lto_code_gen_t cg);
512 * Generates code for the optimized merged module into one native object file.
513 * It will not run any IR optimizations on the merged module.
515 * On success returns a pointer to a generated mach-o/ELF buffer and length set
516 * to the buffer size. The buffer is owned by the lto_code_gen_t and will be
517 * freed when lto_codegen_dispose() is called, or
518 * lto_codegen_compile_optimized() is called again. On failure, returns NULL
519 * (check lto_get_error_message() for details).
521 * \since LTO_API_VERSION=12
524 lto_codegen_compile_optimized(lto_code_gen_t cg, size_t* length);
527 * Returns the runtime API version.
529 * \since LTO_API_VERSION=12
532 lto_api_version(void);
535 * Sets options to help debug codegen bugs.
537 * \since prior to LTO_API_VERSION=3
540 lto_codegen_debug_options(lto_code_gen_t cg, const char *);
543 * Initializes LLVM disassemblers.
544 * FIXME: This doesn't really belong here.
546 * \since LTO_API_VERSION=5
549 lto_initialize_disassembler(void);
552 * Sets if we should run internalize pass during optimization and code
555 * \since prior to LTO_API_VERSION=14
558 lto_codegen_set_should_internalize(lto_code_gen_t cg,
559 lto_bool_t ShouldInternalize);