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 6
  44
  45 typedef enum {
  46     LTO_SYMBOL_ALIGNMENT_MASK              = 0x0000001F, /* log2 of alignment */
  47     LTO_SYMBOL_PERMISSIONS_MASK            = 0x000000E0,
  48     LTO_SYMBOL_PERMISSIONS_CODE            = 0x000000A0,
  49     LTO_SYMBOL_PERMISSIONS_DATA            = 0x000000C0,
  50     LTO_SYMBOL_PERMISSIONS_RODATA          = 0x00000080,
  51     LTO_SYMBOL_DEFINITION_MASK             = 0x00000700,
  52     LTO_SYMBOL_DEFINITION_REGULAR          = 0x00000100,
  53     LTO_SYMBOL_DEFINITION_TENTATIVE        = 0x00000200,
  54     LTO_SYMBOL_DEFINITION_WEAK             = 0x00000300,
  55     LTO_SYMBOL_DEFINITION_UNDEFINED        = 0x00000400,
  56     LTO_SYMBOL_DEFINITION_WEAKUNDEF        = 0x00000500,
  57     LTO_SYMBOL_SCOPE_MASK                  = 0x00003800,
  58     LTO_SYMBOL_SCOPE_INTERNAL              = 0x00000800,
  59     LTO_SYMBOL_SCOPE_HIDDEN                = 0x00001000,
  60     LTO_SYMBOL_SCOPE_PROTECTED             = 0x00002000,
  61     LTO_SYMBOL_SCOPE_DEFAULT               = 0x00001800,
  62     LTO_SYMBOL_SCOPE_DEFAULT_CAN_BE_HIDDEN = 0x00002800
  63 } lto_symbol_attributes;
  64
  65 typedef enum {
  66     LTO_DEBUG_MODEL_NONE         = 0,
  67     LTO_DEBUG_MODEL_DWARF        = 1
  68 } lto_debug_model;
  69
  70 typedef enum {
  71     LTO_CODEGEN_PIC_MODEL_STATIC         = 0,
  72     LTO_CODEGEN_PIC_MODEL_DYNAMIC        = 1,
  73     LTO_CODEGEN_PIC_MODEL_DYNAMIC_NO_PIC = 2
  74 } lto_codegen_model;
  75
  76 typedef enum {
  77     LTO_INTERNALIZE_FULL   = 0,
  78     LTO_INTERNALIZE_NONE   = 1,
  79     LTO_INTERNALIZE_HIDDEN = 2
  80 } lto_internalize_strategy;
  81
  82 /** opaque reference to a loaded object module */
  83 typedef struct LTOModule*         lto_module_t;
  84
  85 /** opaque reference to a code generator */
  86 typedef struct LTOCodeGenerator*  lto_code_gen_t;
  87
  88 #ifdef __cplusplus
  89 extern "C" {
  90 #endif
  91
  92 /**
  93  * Returns a printable string.
  94  */
  95 extern const char*
  96 lto_get_version(void);
  97
  98
  99 /**
 100  * Returns the last error string or NULL if last operation was successful.
 101  */
 102 extern const char*
 103 lto_get_error_message(void);
 104
 105 /**
 106  * Checks if a file is a loadable object file.
 107  */
 108 extern lto_bool_t
 109 lto_module_is_object_file(const char* path);
 110
 111
 112 /**
 113  * Checks if a file is a loadable object compiled for requested target.
 114  */
 115 extern lto_bool_t
 116 lto_module_is_object_file_for_target(const char* path,
 117                                      const char* target_triple_prefix);
 118
 119
 120 /**
 121  * Checks if a buffer is a loadable object file.
 122  */
 123 extern lto_bool_t
 124 lto_module_is_object_file_in_memory(const void* mem, size_t length);
 125
 126
 127 /**
 128  * Checks if a buffer is a loadable object compiled for requested target.
 129  */
 130 extern lto_bool_t
 131 lto_module_is_object_file_in_memory_for_target(const void* mem, size_t length,
 132                                               const char* target_triple_prefix);
 133
 134
 135 /**
 136  * Loads an object file from disk.
 137  * Returns NULL on error (check lto_get_error_message() for details).
 138  */
 139 extern lto_module_t
 140 lto_module_create(const char* path);
 141
 142
 143 /**
 144  * Loads an object file from memory.
 145  * Returns NULL on error (check lto_get_error_message() for details).
 146  */
 147 extern lto_module_t
 148 lto_module_create_from_memory(const void* mem, size_t length);
 149
 150 /**
 151  * Loads an object file from disk. The seek point of fd is not preserved.
 152  * Returns NULL on error (check lto_get_error_message() for details).
 153  */
 154 extern lto_module_t
 155 lto_module_create_from_fd(int fd, const char *path, size_t file_size);
 156
 157 /**
 158  * Loads an object file from disk. The seek point of fd is not preserved.
 159  * Returns NULL on error (check lto_get_error_message() for details).
 160  */
 161 extern lto_module_t
 162 lto_module_create_from_fd_at_offset(int fd, const char *path, size_t file_size,
 163                                     size_t map_size, off_t offset);
 164
 165
 166 /**
 167  * Frees all memory internally allocated by the module.
 168  * Upon return the lto_module_t is no longer valid.
 169  */
 170 extern void
 171 lto_module_dispose(lto_module_t mod);
 172
 173
 174 /**
 175  * Returns triple string which the object module was compiled under.
 176  */
 177 extern const char*
 178 lto_module_get_target_triple(lto_module_t mod);
 179
 180 /**
 181  * Sets triple string with which the object will be codegened.
 182  */
 183 extern void
 184 lto_module_set_target_triple(lto_module_t mod, const char *triple);
 185
 186
 187 /**
 188  * Returns the number of symbols in the object module.
 189  */
 190 extern unsigned int
 191 lto_module_get_num_symbols(lto_module_t mod);
 192
 193
 194 /**
 195  * Returns the name of the ith symbol in the object module.
 196  */
 197 extern const char*
 198 lto_module_get_symbol_name(lto_module_t mod, unsigned int index);
 199
 200
 201 /**
 202  * Returns the attributes of the ith symbol in the object module.
 203  */
 204 extern lto_symbol_attributes
 205 lto_module_get_symbol_attribute(lto_module_t mod, unsigned int index);
 206
 207
 208 /**
 209  * Instantiates a code generator.
 210  * Returns NULL on error (check lto_get_error_message() for details).
 211  */
 212 extern lto_code_gen_t
 213 lto_codegen_create(void);
 214
 215
 216 /**
 217  * Frees all code generator and all memory it internally allocated.
 218  * Upon return the lto_code_gen_t is no longer valid.
 219  */
 220 extern void
 221 lto_codegen_dispose(lto_code_gen_t);
 222
 223
 224
 225 /**
 226  * Add an object module to the set of modules for which code will be generated.
 227  * Returns true on error (check lto_get_error_message() for details).
 228  */
 229 extern lto_bool_t
 230 lto_codegen_add_module(lto_code_gen_t cg, lto_module_t mod);
 231
 232
 233
 234 /**
 235  * Sets if debug info should be generated.
 236  * Returns true on error (check lto_get_error_message() for details).
 237  */
 238 extern lto_bool_t
 239 lto_codegen_set_debug_model(lto_code_gen_t cg, lto_debug_model);
 240
 241
 242 /**
 243  * Sets which PIC code model to generated.
 244  * Returns true on error (check lto_get_error_message() for details).
 245  */
 246 extern lto_bool_t
 247 lto_codegen_set_pic_model(lto_code_gen_t cg, lto_codegen_model);
 248
 249
 250 /**
 251  * Sets the cpu to generate code for.
 252  */
 253 extern void
 254 lto_codegen_set_cpu(lto_code_gen_t cg, const char *cpu);
 255
 256
 257 /**
 258  * Sets the location of the assembler tool to run. If not set, libLTO
 259  * will use gcc to invoke the assembler.
 260  */
 261 extern void
 262 lto_codegen_set_assembler_path(lto_code_gen_t cg, const char* path);
 263
 264 /**
 265  * Sets extra arguments that libLTO should pass to the assembler.
 266  */
 267 extern void
 268 lto_codegen_set_assembler_args(lto_code_gen_t cg, const char **args,
 269                                int nargs);
 270
 271 /**
 272  * Sets the strategy to use during internalize.  Default strategy is
 273  * LTO_INTERNALIZE_FULL.
 274  */
 275 extern void
 276 lto_codegen_set_internalize_strategy(lto_code_gen_t cg,
 277                                      lto_internalize_strategy);
 278
 279 /**
 280  * Tells LTO optimization passes that this symbol must be preserved
 281  * because it is referenced by native code or a command line option.
 282  */
 283 extern void
 284 lto_codegen_add_must_preserve_symbol(lto_code_gen_t cg, const char* symbol);
 285
 286 /**
 287  * Writes a new object file at the specified path that contains the
 288  * merged contents of all modules added so far.
 289  * Returns true on error (check lto_get_error_message() for details).
 290  */
 291 extern lto_bool_t
 292 lto_codegen_write_merged_modules(lto_code_gen_t cg, const char* path);
 293
 294 /**
 295  * Generates code for all added modules into one native object file.
 296  * On success returns a pointer to a generated mach-o/ELF buffer and
 297  * length set to the buffer size.  The buffer is owned by the
 298  * lto_code_gen_t and will be freed when lto_codegen_dispose()
 299  * is called, or lto_codegen_compile() is called again.
 300  * On failure, returns NULL (check lto_get_error_message() for details).
 301  */
 302 extern const void*
 303 lto_codegen_compile(lto_code_gen_t cg, size_t* length);
 304
 305 /**
 306  * Generates code for all added modules into one native object file.
 307  * The name of the file is written to name. Returns true on error.
 308  */
 309 extern lto_bool_t
 310 lto_codegen_compile_to_file(lto_code_gen_t cg, const char** name);
 311
 312
 313 /**
 314  * Sets options to help debug codegen bugs.
 315  */
 316 extern void
 317 lto_codegen_debug_options(lto_code_gen_t cg, const char *);
 318
 319 /**
 320  * Initializes LLVM disassemblers.
 321  * FIXME: This doesn't really belong here.
 322  */
 323 extern void
 324 lto_initialize_disassembler(void);
 325
 326 #ifdef __cplusplus
 327 }
 328 #endif
 329
 330 /**
 331  * @}
 332  */
 333
 334 #endif