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