include/llvm-c/lto.h

   1 /*===-- llvm-c/lto.h - LTO Public C Interface ---------------------*- C -*-===*\
   2 |*                                                                            *|
   3 |*                     The LLVM Compiler Infrastructure                       *|
   4 |*                                                                            *|
   5 |* This file is distributed under the University of Illinois Open Source      *|
   6 |* License. See LICENSE.TXT for details.                                      *|
   7 |*                                                                            *|
   8 |*===----------------------------------------------------------------------===*|
   9 |*                                                                            *|
  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.                                                        *|
  13 |*                                                                            *|
  14 \*===----------------------------------------------------------------------===*/
  15
  16 #ifndef LLVM_C_LTO_H
  17 #define LLVM_C_LTO_H
  18
  19 #include <stddef.h>
  20 #include <sys/types.h>
  21
  22 #ifndef __cplusplus
  23 #if !defined(_MSC_VER)
  24 #include <stdbool.h>
  25 typedef bool lto_bool_t;
  26 #else
  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
  29    use C++ bool. */
  30 typedef unsigned char lto_bool_t;
  31 #endif
  32 #else
  33 typedef bool lto_bool_t;
  34 #endif
  35
  36 /**
  37  * @defgroup LLVMCLTO LTO
  38  * @ingroup LLVMC
  39  *
  40  * @{
  41  */
  42
  43 #define LTO_API_VERSION 15
  44
  45 /**
  46  * \since prior to LTO_API_VERSION=3
  47  */
  48 typedef enum {
  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;
  68
  69 /**
  70  * \since prior to LTO_API_VERSION=3
  71  */
  72 typedef enum {
  73     LTO_DEBUG_MODEL_NONE         = 0,
  74     LTO_DEBUG_MODEL_DWARF        = 1
  75 } lto_debug_model;
  76
  77 /**
  78  * \since prior to LTO_API_VERSION=3
  79  */
  80 typedef enum {
  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
  85 } lto_codegen_model;
  86
  87 /** opaque reference to a loaded object module */
  88 typedef struct LLVMOpaqueLTOModule *lto_module_t;
  89
  90 /** opaque reference to a code generator */
  91 typedef struct LLVMOpaqueLTOCodeGenerator *lto_code_gen_t;
  92
  93 #ifdef __cplusplus
  94 extern "C" {
  95 #endif
  96
  97 /**
  98  * Returns a printable string.
  99  *
 100  * \since prior to LTO_API_VERSION=3
 101  */
 102 extern const char*
 103 lto_get_version(void);
 104
 105
 106 /**
 107  * Returns the last error string or NULL if last operation was successful.
 108  *
 109  * \since prior to LTO_API_VERSION=3
 110  */
 111 extern const char*
 112 lto_get_error_message(void);
 113
 114 /**
 115  * Checks if a file is a loadable object file.
 116  *
 117  * \since prior to LTO_API_VERSION=3
 118  */
 119 extern lto_bool_t
 120 lto_module_is_object_file(const char* path);
 121
 122
 123 /**
 124  * Checks if a file is a loadable object compiled for requested target.
 125  *
 126  * \since prior to LTO_API_VERSION=3
 127  */
 128 extern lto_bool_t
 129 lto_module_is_object_file_for_target(const char* path,
 130                                      const char* target_triple_prefix);
 131
 132
 133 /**
 134  * Checks if a buffer is a loadable object file.
 135  *
 136  * \since prior to LTO_API_VERSION=3
 137  */
 138 extern lto_bool_t
 139 lto_module_is_object_file_in_memory(const void* mem, size_t length);
 140
 141
 142 /**
 143  * Checks if a buffer is a loadable object compiled for requested target.
 144  *
 145  * \since prior to LTO_API_VERSION=3
 146  */
 147 extern lto_bool_t
 148 lto_module_is_object_file_in_memory_for_target(const void* mem, size_t length,
 149                                               const char* target_triple_prefix);
 150
 151
 152 /**
 153  * Loads an object file from disk.
 154  * Returns NULL on error (check lto_get_error_message() for details).
 155  *
 156  * \since prior to LTO_API_VERSION=3
 157  */
 158 extern lto_module_t
 159 lto_module_create(const char* path);
 160
 161
 162 /**
 163  * Loads an object file from memory.
 164  * Returns NULL on error (check lto_get_error_message() for details).
 165  *
 166  * \since prior to LTO_API_VERSION=3
 167  */
 168 extern lto_module_t
 169 lto_module_create_from_memory(const void* mem, size_t length);
 170
 171 /**
 172  * Loads an object file from memory with an extra path argument.
 173  * Returns NULL on error (check lto_get_error_message() for details).
 174  *
 175  * \since LTO_API_VERSION=9
 176  */
 177 extern lto_module_t
 178 lto_module_create_from_memory_with_path(const void* mem, size_t length,
 179                                         const char *path);
 180
 181 /**
 182  * \brief Loads an object file in its own context.
 183  *
 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().
 187  *
 188  * Returns NULL on error (check lto_get_error_message() for details).
 189  *
 190  * \since LTO_API_VERSION=11
 191  */
 192 extern lto_module_t
 193 lto_module_create_in_local_context(const void *mem, size_t length,
 194                                    const char *path);
 195
 196 /**
 197  * \brief Loads an object file in the codegen context.
 198  *
 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().
 201  *
 202  * Returns NULL on error (check lto_get_error_message() for details).
 203  *
 204  * \since LTO_API_VERSION=11
 205  */
 206 extern lto_module_t
 207 lto_module_create_in_codegen_context(const void *mem, size_t length,
 208                                      const char *path, lto_code_gen_t cg);
 209
 210 /**
 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).
 213  *
 214  * \since LTO_API_VERSION=5
 215  */
 216 extern lto_module_t
 217 lto_module_create_from_fd(int fd, const char *path, size_t file_size);
 218
 219 /**
 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).
 222  *
 223  * \since LTO_API_VERSION=5
 224  */
 225 extern lto_module_t
 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);
 228
 229 /**
 230  * Frees all memory internally allocated by the module.
 231  * Upon return the lto_module_t is no longer valid.
 232  *
 233  * \since prior to LTO_API_VERSION=3
 234  */
 235 extern void
 236 lto_module_dispose(lto_module_t mod);
 237
 238 /**
 239  * Returns triple string which the object module was compiled under.
 240  *
 241  * \since prior to LTO_API_VERSION=3
 242  */
 243 extern const char*
 244 lto_module_get_target_triple(lto_module_t mod);
 245
 246 /**
 247  * Sets triple string with which the object will be codegened.
 248  *
 249  * \since LTO_API_VERSION=4
 250  */
 251 extern void
 252 lto_module_set_target_triple(lto_module_t mod, const char *triple);
 253
 254
 255 /**
 256  * Returns the number of symbols in the object module.
 257  *
 258  * \since prior to LTO_API_VERSION=3
 259  */
 260 extern unsigned int
 261 lto_module_get_num_symbols(lto_module_t mod);
 262
 263
 264 /**
 265  * Returns the name of the ith symbol in the object module.
 266  *
 267  * \since prior to LTO_API_VERSION=3
 268  */
 269 extern const char*
 270 lto_module_get_symbol_name(lto_module_t mod, unsigned int index);
 271
 272
 273 /**
 274  * Returns the attributes of the ith symbol in the object module.
 275  *
 276  * \since prior to LTO_API_VERSION=3
 277  */
 278 extern lto_symbol_attributes
 279 lto_module_get_symbol_attribute(lto_module_t mod, unsigned int index);
 280
 281
 282 /**
 283  * Returns the number of dependent libraries in the object module.
 284  *
 285  * \since LTO_API_VERSION=8
 286  */
 287 extern unsigned int
 288 lto_module_get_num_deplibs(lto_module_t mod);
 289
 290
 291 /**
 292  * Returns the ith dependent library in the module.
 293  *
 294  * \since LTO_API_VERSION=8
 295  */
 296 extern const char*
 297 lto_module_get_deplib(lto_module_t mod, unsigned int index);
 298
 299
 300 /**
 301  * Returns the number of linker options in the object module.
 302  *
 303  * \since LTO_API_VERSION=8
 304  */
 305 extern unsigned int
 306 lto_module_get_num_linkeropts(lto_module_t mod);
 307
 308
 309 /**
 310  * Returns the ith linker option in the module.
 311  *
 312  * \since LTO_API_VERSION=8
 313  */
 314 extern const char*
 315 lto_module_get_linkeropt(lto_module_t mod, unsigned int index);
 316
 317
 318 /**
 319  * Diagnostic severity.
 320  *
 321  * \since LTO_API_VERSION=7
 322  */
 323 typedef enum {
 324   LTO_DS_ERROR = 0,
 325   LTO_DS_WARNING = 1,
 326   LTO_DS_REMARK = 3, // Added in LTO_API_VERSION=10.
 327   LTO_DS_NOTE = 2
 328 } lto_codegen_diagnostic_severity_t;
 329
 330 /**
 331  * Diagnostic handler type.
 332  * \p severity defines the severity.
 333  * \p diag is the actual diagnostic.
 334  * The diagnostic is not prefixed by any of severity keyword, e.g., 'error: '.
 335  * \p ctxt is used to pass the context set with the diagnostic handler.
 336  *
 337  * \since LTO_API_VERSION=7
 338  */
 339 typedef void (*lto_diagnostic_handler_t)(
 340     lto_codegen_diagnostic_severity_t severity, const char *diag, void *ctxt);
 341
 342 /**
 343  * Set a diagnostic handler and the related context (void *).
 344  * This is more general than lto_get_error_message, as the diagnostic handler
 345  * can be called at anytime within lto.
 346  *
 347  * \since LTO_API_VERSION=7
 348  */
 349 extern void lto_codegen_set_diagnostic_handler(lto_code_gen_t,
 350                                                lto_diagnostic_handler_t,
 351                                                void *);
 352
 353 /**
 354  * Instantiates a code generator.
 355  * Returns NULL on error (check lto_get_error_message() for details).
 356  *
 357  * All modules added using \a lto_codegen_add_module() must have been created
 358  * in the same context as the codegen.
 359  *
 360  * \since prior to LTO_API_VERSION=3
 361  */
 362 extern lto_code_gen_t
 363 lto_codegen_create(void);
 364
 365 /**
 366  * \brief Instantiate a code generator in its own context.
 367  *
 368  * Instantiates a code generator in its own context.  Modules added via \a
 369  * lto_codegen_add_module() must have all been created in the same context,
 370  * using \a lto_module_create_in_codegen_context().
 371  *
 372  * \since LTO_API_VERSION=11
 373  */
 374 extern lto_code_gen_t
 375 lto_codegen_create_in_local_context(void);
 376
 377 /**
 378  * Frees all code generator and all memory it internally allocated.
 379  * Upon return the lto_code_gen_t is no longer valid.
 380  *
 381  * \since prior to LTO_API_VERSION=3
 382  */
 383 extern void
 384 lto_codegen_dispose(lto_code_gen_t);
 385
 386 /**
 387  * Add an object module to the set of modules for which code will be generated.
 388  * Returns true on error (check lto_get_error_message() for details).
 389  *
 390  * \c cg and \c mod must both be in the same context.  See \a
 391  * lto_codegen_create_in_local_context() and \a
 392  * lto_module_create_in_codegen_context().
 393  *
 394  * \since prior to LTO_API_VERSION=3
 395  */
 396 extern lto_bool_t
 397 lto_codegen_add_module(lto_code_gen_t cg, lto_module_t mod);
 398
 399 /**
 400  * Sets the object module for code generation. This will transfer the ownship of
 401  * the module to code generator.
 402  *
 403  * \c cg and \c mod must both be in the same context.
 404  *
 405  * \since LTO_API_VERSION=13
 406  */
 407 extern void
 408 lto_codegen_set_module(lto_code_gen_t cg, lto_module_t mod);
 409
 410 /**
 411  * Sets if debug info should be generated.
 412  * Returns true on error (check lto_get_error_message() for details).
 413  *
 414  * \since prior to LTO_API_VERSION=3
 415  */
 416 extern lto_bool_t
 417 lto_codegen_set_debug_model(lto_code_gen_t cg, lto_debug_model);
 418
 419
 420 /**
 421  * Sets which PIC code model to generated.
 422  * Returns true on error (check lto_get_error_message() for details).
 423  *
 424  * \since prior to LTO_API_VERSION=3
 425  */
 426 extern lto_bool_t
 427 lto_codegen_set_pic_model(lto_code_gen_t cg, lto_codegen_model);
 428
 429
 430 /**
 431  * Sets the cpu to generate code for.
 432  *
 433  * \since LTO_API_VERSION=4
 434  */
 435 extern void
 436 lto_codegen_set_cpu(lto_code_gen_t cg, const char *cpu);
 437
 438
 439 /**
 440  * Sets the location of the assembler tool to run. If not set, libLTO
 441  * will use gcc to invoke the assembler.
 442  *
 443  * \since LTO_API_VERSION=3
 444  */
 445 extern void
 446 lto_codegen_set_assembler_path(lto_code_gen_t cg, const char* path);
 447
 448 /**
 449  * Sets extra arguments that libLTO should pass to the assembler.
 450  *
 451  * \since LTO_API_VERSION=4
 452  */
 453 extern void
 454 lto_codegen_set_assembler_args(lto_code_gen_t cg, const char **args,
 455                                int nargs);
 456
 457 /**
 458  * Adds to a list of all global symbols that must exist in the final generated
 459  * code. If a function is not listed there, it might be inlined into every usage
 460  * and optimized away.
 461  *
 462  * \since prior to LTO_API_VERSION=3
 463  */
 464 extern void
 465 lto_codegen_add_must_preserve_symbol(lto_code_gen_t cg, const char* symbol);
 466
 467 /**
 468  * Writes a new object file at the specified path that contains the
 469  * merged contents of all modules added so far.
 470  * Returns true on error (check lto_get_error_message() for details).
 471  *
 472  * \since LTO_API_VERSION=5
 473  */
 474 extern lto_bool_t
 475 lto_codegen_write_merged_modules(lto_code_gen_t cg, const char* path);
 476
 477 /**
 478  * Generates code for all added modules into one native object file.
 479  * This calls lto_codegen_optimize then lto_codegen_compile_optimized.
 480  *
 481  * On success returns a pointer to a generated mach-o/ELF buffer and
 482  * length set to the buffer size.  The buffer is owned by the
 483  * lto_code_gen_t and will be freed when lto_codegen_dispose()
 484  * is called, or lto_codegen_compile() is called again.
 485  * On failure, returns NULL (check lto_get_error_message() for details).
 486  *
 487  * \since prior to LTO_API_VERSION=3
 488  */
 489 extern const void*
 490 lto_codegen_compile(lto_code_gen_t cg, size_t* length);
 491
 492 /**
 493  * Generates code for all added modules into one native object file.
 494  * This calls lto_codegen_optimize then lto_codegen_compile_optimized (instead
 495  * of returning a generated mach-o/ELF buffer, it writes to a file).
 496  *
 497  * The name of the file is written to name. Returns true on error.
 498  *
 499  * \since LTO_API_VERSION=5
 500  */
 501 extern lto_bool_t
 502 lto_codegen_compile_to_file(lto_code_gen_t cg, const char** name);
 503
 504 /**
 505  * Runs optimization for the merged module. Returns true on error.
 506  *
 507  * \since LTO_API_VERSION=12
 508  */
 509 extern lto_bool_t
 510 lto_codegen_optimize(lto_code_gen_t cg);
 511
 512 /**
 513  * Generates code for the optimized merged module into one native object file.
 514  * It will not run any IR optimizations on the merged module.
 515  *
 516  * On success returns a pointer to a generated mach-o/ELF buffer and length set
 517  * to the buffer size.  The buffer is owned by the lto_code_gen_t and will be
 518  * freed when lto_codegen_dispose() is called, or
 519  * lto_codegen_compile_optimized() is called again. On failure, returns NULL
 520  * (check lto_get_error_message() for details).
 521  *
 522  * \since LTO_API_VERSION=12
 523  */
 524 extern const void*
 525 lto_codegen_compile_optimized(lto_code_gen_t cg, size_t* length);
 526
 527 /**
 528  * Returns the runtime API version.
 529  *
 530  * \since LTO_API_VERSION=12
 531  */
 532 extern unsigned int
 533 lto_api_version(void);
 534
 535 /**
 536  * Sets options to help debug codegen bugs.
 537  *
 538  * \since prior to LTO_API_VERSION=3
 539  */
 540 extern void
 541 lto_codegen_debug_options(lto_code_gen_t cg, const char *);
 542
 543 /**
 544  * Initializes LLVM disassemblers.
 545  * FIXME: This doesn't really belong here.
 546  *
 547  * \since LTO_API_VERSION=5
 548  */
 549 extern void
 550 lto_initialize_disassembler(void);
 551
 552 /**
 553  * Sets if we should run internalize pass during optimization and code
 554  * generation.
 555  *
 556  * \since LTO_API_VERSION=14
 557  */
 558 extern void
 559 lto_codegen_set_should_internalize(lto_code_gen_t cg,
 560                                    lto_bool_t ShouldInternalize);
 561
 562 /**
 563  * \brief Set whether to embed uselists in bitcode.
 564  *
 565  * Sets whether \a lto_codegen_write_merged_modules() should embed uselists in
 566  * output bitcode.  This should be turned on for all -save-temps output.
 567  *
 568  * \since LTO_API_VERSION=15
 569  */
 570 extern void
 571 lto_codegen_set_should_embed_uselists(lto_code_gen_t cg,
 572                                       lto_bool_t ShouldEmbedUselists);
 573
 574 #ifdef __cplusplus
 575 }
 576 #endif
 577
 578 /**
 579  * @}
 580  */
 581
 582 #endif