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