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 9
  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_attributes;
  67
  68 /**
  69  * \since prior to LTO_API_VERSION=3
  70  */
  71 typedef enum {
  72     LTO_DEBUG_MODEL_NONE         = 0,
  73     LTO_DEBUG_MODEL_DWARF        = 1
  74 } lto_debug_model;
  75
  76 /**
  77  * \since prior to LTO_API_VERSION=3
  78  */
  79 typedef enum {
  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_model;
  84
  85 /**
  86  * \since LTO_API_VERSION=6
  87  */
  88 typedef enum {
  89     LTO_INTERNALIZE_FULL   = 0,
  90     LTO_INTERNALIZE_NONE   = 1,
  91     LTO_INTERNALIZE_HIDDEN = 2
  92 } lto_internalize_strategy;
  93
  94 /** opaque reference to a loaded object module */
  95 typedef struct LTOModule*         lto_module_t;
  96
  97 /** opaque reference to a code generator */
  98 typedef struct LTOCodeGenerator*  lto_code_gen_t;
  99
 100 #ifdef __cplusplus
 101 extern "C" {
 102 #endif
 103
 104 /**
 105  * Returns a printable string.
 106  *
 107  * \since prior to LTO_API_VERSION=3
 108  */
 109 extern const char*
 110 lto_get_version(void);
 111
 112
 113 /**
 114  * Returns the last error string or NULL if last operation was successful.
 115  *
 116  * \since prior to LTO_API_VERSION=3
 117  */
 118 extern const char*
 119 lto_get_error_message(void);
 120
 121 /**
 122  * Checks if a file is a loadable object file.
 123  *
 124  * \since prior to LTO_API_VERSION=3
 125  */
 126 extern lto_bool_t
 127 lto_module_is_object_file(const char* path);
 128
 129
 130 /**
 131  * Checks if a file is a loadable object compiled for requested target.
 132  *
 133  * \since prior to LTO_API_VERSION=3
 134  */
 135 extern lto_bool_t
 136 lto_module_is_object_file_for_target(const char* path,
 137                                      const char* target_triple_prefix);
 138
 139
 140 /**
 141  * Checks if a buffer is a loadable object file.
 142  *
 143  * \since prior to LTO_API_VERSION=3
 144  */
 145 extern lto_bool_t
 146 lto_module_is_object_file_in_memory(const void* mem, size_t length);
 147
 148
 149 /**
 150  * Checks if a buffer is a loadable object compiled for requested target.
 151  *
 152  * \since prior to LTO_API_VERSION=3
 153  */
 154 extern lto_bool_t
 155 lto_module_is_object_file_in_memory_for_target(const void* mem, size_t length,
 156                                               const char* target_triple_prefix);
 157
 158
 159 /**
 160  * Loads an object file from disk.
 161  * Returns NULL on error (check lto_get_error_message() for details).
 162  *
 163  * \since prior to LTO_API_VERSION=3
 164  */
 165 extern lto_module_t
 166 lto_module_create(const char* path);
 167
 168
 169 /**
 170  * Loads an object file from memory.
 171  * Returns NULL on error (check lto_get_error_message() for details).
 172  *
 173  * \since prior to LTO_API_VERSION=3
 174  */
 175 extern lto_module_t
 176 lto_module_create_from_memory(const void* mem, size_t length);
 177
 178 /**
 179  * Loads an object file from memory with an extra path argument.
 180  * Returns NULL on error (check lto_get_error_message() for details).
 181  *
 182  * \since prior to LTO_API_VERSION=9
 183  */
 184 extern lto_module_t
 185 lto_module_create_from_memory_with_path(const void* mem, size_t length,
 186                                         const char *path);
 187
 188 /**
 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).
 191  *
 192  * \since LTO_API_VERSION=5
 193  */
 194 extern lto_module_t
 195 lto_module_create_from_fd(int fd, const char *path, size_t file_size);
 196
 197 /**
 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).
 200  *
 201  * \since LTO_API_VERSION=5
 202  */
 203 extern lto_module_t
 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);
 206
 207 /**
 208  * Frees all memory internally allocated by the module.
 209  * Upon return the lto_module_t is no longer valid.
 210  *
 211  * \since prior to LTO_API_VERSION=3
 212  */
 213 extern void
 214 lto_module_dispose(lto_module_t mod);
 215
 216 /**
 217  * Returns triple string which the object module was compiled under.
 218  *
 219  * \since prior to LTO_API_VERSION=3
 220  */
 221 extern const char*
 222 lto_module_get_target_triple(lto_module_t mod);
 223
 224 /**
 225  * Sets triple string with which the object will be codegened.
 226  *
 227  * \since LTO_API_VERSION=4
 228  */
 229 extern void
 230 lto_module_set_target_triple(lto_module_t mod, const char *triple);
 231
 232
 233 /**
 234  * Returns the number of symbols in the object module.
 235  *
 236  * \since prior to LTO_API_VERSION=3
 237  */
 238 extern unsigned int
 239 lto_module_get_num_symbols(lto_module_t mod);
 240
 241
 242 /**
 243  * Returns the name of the ith symbol in the object module.
 244  *
 245  * \since prior to LTO_API_VERSION=3
 246  */
 247 extern const char*
 248 lto_module_get_symbol_name(lto_module_t mod, unsigned int index);
 249
 250
 251 /**
 252  * Returns the attributes of the ith symbol in the object module.
 253  *
 254  * \since prior to LTO_API_VERSION=3
 255  */
 256 extern lto_symbol_attributes
 257 lto_module_get_symbol_attribute(lto_module_t mod, unsigned int index);
 258
 259
 260 /**
 261  * Returns the number of dependent libraries in the object module.
 262  *
 263  * \since LTO_API_VERSION=8
 264  */
 265 extern unsigned int
 266 lto_module_get_num_deplibs(lto_module_t mod);
 267
 268
 269 /**
 270  * Returns the ith dependent library in the module.
 271  *
 272  * \since LTO_API_VERSION=8
 273  */
 274 extern const char*
 275 lto_module_get_deplib(lto_module_t mod, unsigned int index);
 276
 277
 278 /**
 279  * Returns the number of linker options in the object module.
 280  *
 281  * \since LTO_API_VERSION=8
 282  */
 283 extern unsigned int
 284 lto_module_get_num_linkeropts(lto_module_t mod);
 285
 286
 287 /**
 288  * Returns the ith linker option in the module.
 289  *
 290  * \since LTO_API_VERSION=8
 291  */
 292 extern const char*
 293 lto_module_get_linkeropt(lto_module_t mod, unsigned int index);
 294
 295
 296 /**
 297  * Diagnostic severity.
 298  *
 299  * \since LTO_API_VERSION=7
 300  */
 301 typedef enum {
 302   LTO_DS_ERROR,
 303   LTO_DS_WARNING,
 304   LTO_DS_NOTE
 305 } lto_codegen_diagnostic_severity_t;
 306
 307 /**
 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.
 313  *
 314  * \since LTO_API_VERSION=7
 315  */
 316 typedef void (*lto_diagnostic_handler_t)(
 317     lto_codegen_diagnostic_severity_t severity, const char *diag, void *ctxt);
 318
 319 /**
 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.
 323  *
 324  * \since LTO_API_VERSION=7
 325  */
 326 extern void lto_codegen_set_diagnostic_handler(lto_code_gen_t,
 327                                                lto_diagnostic_handler_t,
 328                                                void *);
 329
 330 /**
 331  * Instantiates a code generator.
 332  * Returns NULL on error (check lto_get_error_message() for details).
 333  *
 334  * \since prior to LTO_API_VERSION=3
 335  */
 336 extern lto_code_gen_t
 337 lto_codegen_create(void);
 338
 339 /**
 340  * Frees all code generator and all memory it internally allocated.
 341  * Upon return the lto_code_gen_t is no longer valid.
 342  *
 343  * \since prior to LTO_API_VERSION=3
 344  */
 345 extern void
 346 lto_codegen_dispose(lto_code_gen_t);
 347
 348 /**
 349  * Add an object module to the set of modules for which code will be generated.
 350  * Returns true on error (check lto_get_error_message() for details).
 351  *
 352  * \since prior to LTO_API_VERSION=3
 353  */
 354 extern lto_bool_t
 355 lto_codegen_add_module(lto_code_gen_t cg, lto_module_t mod);
 356
 357 /**
 358  * Sets if debug info should be generated.
 359  * Returns true on error (check lto_get_error_message() for details).
 360  *
 361  * \since prior to LTO_API_VERSION=3
 362  */
 363 extern lto_bool_t
 364 lto_codegen_set_debug_model(lto_code_gen_t cg, lto_debug_model);
 365
 366
 367 /**
 368  * Sets which PIC code model to generated.
 369  * Returns true on error (check lto_get_error_message() for details).
 370  *
 371  * \since prior to LTO_API_VERSION=3
 372  */
 373 extern lto_bool_t
 374 lto_codegen_set_pic_model(lto_code_gen_t cg, lto_codegen_model);
 375
 376
 377 /**
 378  * Sets the cpu to generate code for.
 379  *
 380  * \since LTO_API_VERSION=4
 381  */
 382 extern void
 383 lto_codegen_set_cpu(lto_code_gen_t cg, const char *cpu);
 384
 385
 386 /**
 387  * Sets the location of the assembler tool to run. If not set, libLTO
 388  * will use gcc to invoke the assembler.
 389  *
 390  * \since LTO_API_VERSION=3
 391  */
 392 extern void
 393 lto_codegen_set_assembler_path(lto_code_gen_t cg, const char* path);
 394
 395 /**
 396  * Sets extra arguments that libLTO should pass to the assembler.
 397  *
 398  * \since LTO_API_VERSION=4
 399  */
 400 extern void
 401 lto_codegen_set_assembler_args(lto_code_gen_t cg, const char **args,
 402                                int nargs);
 403
 404 /**
 405  * Sets the strategy to use during internalize.  Default strategy is
 406  * LTO_INTERNALIZE_FULL.
 407  *
 408  * \since LTO_API_VERSION=6
 409  */
 410 extern void
 411 lto_codegen_set_internalize_strategy(lto_code_gen_t cg,
 412                                      lto_internalize_strategy);
 413
 414 /**
 415  * Tells LTO optimization passes that this symbol must be preserved
 416  * because it is referenced by native code or a command line option.
 417  *
 418  * \since prior to LTO_API_VERSION=3
 419  */
 420 extern void
 421 lto_codegen_add_must_preserve_symbol(lto_code_gen_t cg, const char* symbol);
 422
 423 /**
 424  * Writes a new object file at the specified path that contains the
 425  * merged contents of all modules added so far.
 426  * Returns true on error (check lto_get_error_message() for details).
 427  *
 428  * \since LTO_API_VERSION=5
 429  */
 430 extern lto_bool_t
 431 lto_codegen_write_merged_modules(lto_code_gen_t cg, const char* path);
 432
 433 /**
 434  * Generates code for all added modules into one native object file.
 435  * On success returns a pointer to a generated mach-o/ELF buffer and
 436  * length set to the buffer size.  The buffer is owned by the
 437  * lto_code_gen_t and will be freed when lto_codegen_dispose()
 438  * is called, or lto_codegen_compile() is called again.
 439  * On failure, returns NULL (check lto_get_error_message() for details).
 440  *
 441  * \since prior to LTO_API_VERSION=3
 442  */
 443 extern const void*
 444 lto_codegen_compile(lto_code_gen_t cg, size_t* length);
 445
 446 /**
 447  * Generates code for all added modules into one native object file.
 448  * The name of the file is written to name. Returns true on error.
 449  *
 450  * \since LTO_API_VERSION=5
 451  */
 452 extern lto_bool_t
 453 lto_codegen_compile_to_file(lto_code_gen_t cg, const char** name);
 454
 455
 456 /**
 457  * Sets options to help debug codegen bugs.
 458  *
 459  * \since prior to LTO_API_VERSION=3
 460  */
 461 extern void
 462 lto_codegen_debug_options(lto_code_gen_t cg, const char *);
 463
 464 /**
 465  * Initializes LLVM disassemblers.
 466  * FIXME: This doesn't really belong here.
 467  *
 468  * \since LTO_API_VERSION=5
 469  */
 470 extern void
 471 lto_initialize_disassembler(void);
 472
 473 #ifdef __cplusplus
 474 }
 475 #endif
 476
 477 /**
 478  * @}
 479  */
 480
 481 #endif