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