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 LTO_H
  17 #define LTO_H  1
  18
  19 #include "llvm-c/Core.h"
  20 #include <stdbool.h>
  21 #include <stddef.h>
  22
  23 #define LTO_API_VERSION 3
  24
  25 typedef enum {
  26     LTO_SYMBOL_ALIGNMENT_MASK         = 0x0000001F,    /* log2 of alignment */
  27     LTO_SYMBOL_PERMISSIONS_MASK       = 0x000000E0,
  28     LTO_SYMBOL_PERMISSIONS_CODE       = 0x000000A0,
  29     LTO_SYMBOL_PERMISSIONS_DATA       = 0x000000C0,
  30     LTO_SYMBOL_PERMISSIONS_RODATA     = 0x00000080,
  31     LTO_SYMBOL_DEFINITION_MASK        = 0x00000700,
  32     LTO_SYMBOL_DEFINITION_REGULAR     = 0x00000100,
  33     LTO_SYMBOL_DEFINITION_TENTATIVE   = 0x00000200,
  34     LTO_SYMBOL_DEFINITION_WEAK        = 0x00000300,
  35     LTO_SYMBOL_DEFINITION_UNDEFINED   = 0x00000400,
  36     LTO_SYMBOL_DEFINITION_WEAKUNDEF   = 0x00000500,
  37     LTO_SYMBOL_SCOPE_MASK             = 0x00003800,
  38     LTO_SYMBOL_SCOPE_INTERNAL         = 0x00000800,
  39     LTO_SYMBOL_SCOPE_HIDDEN           = 0x00001000,
  40     LTO_SYMBOL_SCOPE_PROTECTED        = 0x00002000,
  41     LTO_SYMBOL_SCOPE_DEFAULT          = 0x00001800
  42 } lto_symbol_attributes;
  43
  44 typedef enum {
  45     LTO_DEBUG_MODEL_NONE         = 0,
  46     LTO_DEBUG_MODEL_DWARF        = 1
  47 } lto_debug_model;
  48
  49 typedef enum {
  50     LTO_CODEGEN_PIC_MODEL_STATIC         = 0,
  51     LTO_CODEGEN_PIC_MODEL_DYNAMIC        = 1,
  52     LTO_CODEGEN_PIC_MODEL_DYNAMIC_NO_PIC = 2
  53 } lto_codegen_model;
  54
  55
  56 /** opaque reference to a loaded object module */
  57 typedef struct LTOModule*         lto_module_t;
  58
  59 /** opaque reference to a code generator */
  60 typedef struct LTOCodeGenerator*  lto_code_gen_t;
  61
  62 typedef struct LTOContext*        lto_context_t;
  63
  64 #ifdef __cplusplus
  65 extern "C" {
  66 #endif
  67
  68 /**
  69  * Returns a printable string.
  70  */
  71 extern const char*
  72 lto_get_version(void);
  73
  74
  75 /**
  76  * Returns the last error string or NULL if last operation was sucessful.
  77  */
  78 extern const char*
  79 lto_get_error_message(void);
  80
  81 /**
  82  * Checks if a file is a loadable object file.
  83  */
  84 extern bool
  85 lto_module_is_object_file(const char* path);
  86
  87
  88 /**
  89  * Checks if a file is a loadable object compiled for requested target.
  90  */
  91 extern bool
  92 lto_module_is_object_file_for_target(const char* path,
  93                                      const char* target_triple_prefix);
  94
  95
  96 /**
  97  * Checks if a buffer is a loadable object file.
  98  */
  99 extern bool
 100 lto_module_is_object_file_in_memory(const void* mem, size_t length);
 101
 102
 103 /**
 104  * Checks if a buffer is a loadable object compiled for requested target.
 105  */
 106 extern bool
 107 lto_module_is_object_file_in_memory_for_target(const void* mem, size_t length,
 108                                                const char* target_triple_prefix);
 109
 110
 111 /**
 112  * Loads an object file from disk.
 113  * Returns NULL on error (check lto_get_error_message() for details).
 114  */
 115 extern lto_module_t
 116 lto_module_create(const char* path, LLVMContextRef Ctxt);
 117
 118
 119 /**
 120  * Loads an object file from memory.
 121  * Returns NULL on error (check lto_get_error_message() for details).
 122  */
 123 extern lto_module_t
 124 lto_module_create_from_memory(const void* mem, size_t length,
 125                               LLVMContextRef Ctxt);
 126
 127
 128 /**
 129  * Frees all memory internally allocated by the module.
 130  * Upon return the lto_module_t is no longer valid.
 131  */
 132 extern void
 133 lto_module_dispose(lto_module_t mod);
 134
 135
 136 /**
 137  * Returns triple string which the object module was compiled under.
 138  */
 139 extern const char*
 140 lto_module_get_target_triple(lto_module_t mod);
 141
 142
 143 /**
 144  * Returns the number of symbols in the object module.
 145  */
 146 extern unsigned int
 147 lto_module_get_num_symbols(lto_module_t mod);
 148
 149
 150 /**
 151  * Returns the name of the ith symbol in the object module.
 152  */
 153 extern const char*
 154 lto_module_get_symbol_name(lto_module_t mod, unsigned int index);
 155
 156
 157 /**
 158  * Returns the attributes of the ith symbol in the object module.
 159  */
 160 extern lto_symbol_attributes
 161 lto_module_get_symbol_attribute(lto_module_t mod, unsigned int index);
 162
 163
 164 /**
 165  * Instantiates a code generator.
 166  * Returns NULL on error (check lto_get_error_message() for details).
 167  */
 168 extern lto_code_gen_t
 169 lto_codegen_create(LLVMContextRef Ctxt);
 170
 171
 172 /**
 173  * Frees all code generator and all memory it internally allocated.
 174  * Upon return the lto_code_gen_t is no longer valid.
 175  */
 176 extern void
 177 lto_codegen_dispose(lto_code_gen_t);
 178
 179
 180
 181 /**
 182  * Add an object module to the set of modules for which code will be generated.
 183  * Returns true on error (check lto_get_error_message() for details).
 184  */
 185 extern bool
 186 lto_codegen_add_module(lto_code_gen_t cg, lto_module_t mod);
 187
 188
 189
 190 /**
 191  * Sets if debug info should be generated.
 192  * Returns true on error (check lto_get_error_message() for details).
 193  */
 194 extern bool
 195 lto_codegen_set_debug_model(lto_code_gen_t cg, lto_debug_model);
 196
 197
 198 /**
 199  * Sets which PIC code model to generated.
 200  * Returns true on error (check lto_get_error_message() for details).
 201  */
 202 extern bool
 203 lto_codegen_set_pic_model(lto_code_gen_t cg, lto_codegen_model);
 204
 205
 206 /**
 207  * Sets the location of the "gcc" to run. If not set, libLTO will search for
 208  * "gcc" on the path.
 209  */
 210 extern void
 211 lto_codegen_set_gcc_path(lto_code_gen_t cg, const char* path);
 212
 213
 214 /**
 215  * Sets the location of the assembler tool to run. If not set, libLTO
 216  * will use gcc to invoke the assembler.
 217  */
 218 extern void
 219 lto_codegen_set_assembler_path(lto_code_gen_t cg, const char* path);
 220
 221
 222 /**
 223  * Adds to a list of all global symbols that must exist in the final
 224  * generated code.  If a function is not listed, it might be
 225  * inlined into every usage and optimized away.
 226  */
 227 extern void
 228 lto_codegen_add_must_preserve_symbol(lto_code_gen_t cg, const char* symbol);
 229
 230
 231 /**
 232  * Writes a new object file at the specified path that contains the
 233  * merged contents of all modules added so far.
 234  * Returns true on error (check lto_get_error_message() for details).
 235  */
 236 extern bool
 237 lto_codegen_write_merged_modules(lto_code_gen_t cg, const char* path);
 238
 239
 240 /**
 241  * Generates code for all added modules into one native object file.
 242  * On sucess returns a pointer to a generated mach-o/ELF buffer and
 243  * length set to the buffer size.  The buffer is owned by the
 244  * lto_code_gen_t and will be freed when lto_codegen_dispose()
 245  * is called, or lto_codegen_compile() is called again.
 246  * On failure, returns NULL (check lto_get_error_message() for details).
 247  */
 248 extern const void*
 249 lto_codegen_compile(lto_code_gen_t cg, size_t* length);
 250
 251
 252 /**
 253  * Sets options to help debug codegen bugs.
 254  */
 255 extern void
 256 lto_codegen_debug_options(lto_code_gen_t cg, const char *);
 257 #ifdef __cplusplus
 258 }
 259 #endif
 260
 261
 262 #endif