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