tools/lto/lto.cpp

   1 //===-lto.cpp - LLVM Link Time Optimizer ----------------------------------===//
   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 file implements the Link Time Optimization library. This library is
  11 // intended to be used by linker to optimize code at link time.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #include "llvm-c/lto.h"
  16 #include "LTOCodeGenerator.h"
  17 #include "LTOModule.h"
  18 #include "llvm-c/Core.h"
  19
  20
  21 // Holds most recent error string.
  22 // *** Not thread safe ***
  23 static std::string sLastErrorString;
  24
  25 /// lto_get_version - Returns a printable string.
  26 extern const char* lto_get_version() {
  27   return LTOCodeGenerator::getVersionString();
  28 }
  29
  30 /// lto_get_error_message - Returns the last error string or NULL if last
  31 /// operation was successful.
  32 const char* lto_get_error_message() {
  33   return sLastErrorString.c_str();
  34 }
  35
  36 /// lto_module_is_object_file - Validates if a file is a loadable object file.
  37 bool lto_module_is_object_file(const char* path) {
  38   return LTOModule::isBitcodeFile(path);
  39 }
  40
  41 /// lto_module_is_object_file_for_target - Validates if a file is a loadable
  42 /// object file compilable for requested target.
  43 bool lto_module_is_object_file_for_target(const char* path,
  44                                           const char* target_triplet_prefix) {
  45   return LTOModule::isBitcodeFileForTarget(path, target_triplet_prefix);
  46 }
  47
  48 /// lto_module_is_object_file_in_memory - Validates if a buffer is a loadable
  49 /// object file.
  50 bool lto_module_is_object_file_in_memory(const void* mem, size_t length) {
  51   return LTOModule::isBitcodeFile(mem, length);
  52 }
  53
  54 /// lto_module_is_object_file_in_memory_for_target - Validates if a buffer is a
  55 /// loadable object file compilable for the target.
  56 bool
  57 lto_module_is_object_file_in_memory_for_target(const void* mem,
  58                                             size_t length,
  59                                             const char* target_triplet_prefix) {
  60   return LTOModule::isBitcodeFileForTarget(mem, length, target_triplet_prefix);
  61 }
  62
  63 /// lto_module_create - Loads an object file from disk. Returns NULL on error
  64 /// (check lto_get_error_message() for details).
  65 lto_module_t lto_module_create(const char* path) {
  66   return LTOModule::makeLTOModule(path, sLastErrorString);
  67 }
  68
  69 /// lto_module_create_from_fd - Loads an object file from disk. Returns NULL on
  70 /// error (check lto_get_error_message() for details).
  71 lto_module_t lto_module_create_from_fd(int fd, const char *path, size_t size) {
  72   return LTOModule::makeLTOModule(fd, path, size, sLastErrorString);
  73 }
  74
  75 /// lto_module_create_from_fd_at_offset - Loads an object file from disk.
  76 /// Returns NULL on error (check lto_get_error_message() for details).
  77 lto_module_t lto_module_create_from_fd_at_offset(int fd, const char *path,
  78                                                  size_t file_size,
  79                                                  size_t map_size,
  80                                                  off_t offset) {
  81   return LTOModule::makeLTOModule(fd, path, file_size, map_size,
  82                                   offset, sLastErrorString);
  83 }
  84
  85 /// lto_module_create_from_memory - Loads an object file from memory. Returns
  86 /// NULL on error (check lto_get_error_message() for details).
  87 lto_module_t lto_module_create_from_memory(const void* mem, size_t length) {
  88   return LTOModule::makeLTOModule(mem, length, sLastErrorString);
  89 }
  90
  91 /// lto_module_dispose - Frees all memory for a module. Upon return the
  92 /// lto_module_t is no longer valid.
  93 void lto_module_dispose(lto_module_t mod) {
  94   delete mod;
  95 }
  96
  97 /// lto_module_get_target_triple - Returns triplet string which the object
  98 /// module was compiled under.
  99 const char* lto_module_get_target_triple(lto_module_t mod) {
 100   return mod->getTargetTriple();
 101 }
 102
 103 /// lto_module_set_target_triple - Sets triple string with which the object will
 104 /// be codegened.
 105 void lto_module_set_target_triple(lto_module_t mod, const char *triple) {
 106   return mod->setTargetTriple(triple);
 107 }
 108
 109 /// lto_module_get_num_symbols - Returns the number of symbols in the object
 110 /// module.
 111 unsigned int lto_module_get_num_symbols(lto_module_t mod) {
 112   return mod->getSymbolCount();
 113 }
 114
 115 /// lto_module_get_symbol_name - Returns the name of the ith symbol in the
 116 /// object module.
 117 const char* lto_module_get_symbol_name(lto_module_t mod, unsigned int index) {
 118   return mod->getSymbolName(index);
 119 }
 120
 121 /// lto_module_get_symbol_attribute - Returns the attributes of the ith symbol
 122 /// in the object module.
 123 lto_symbol_attributes lto_module_get_symbol_attribute(lto_module_t mod,
 124                                                       unsigned int index) {
 125   return mod->getSymbolAttributes(index);
 126 }
 127
 128 /// lto_codegen_create - Instantiates a code generator. Returns NULL if there
 129 /// is an error.
 130 lto_code_gen_t lto_codegen_create(void) {
 131   return new LTOCodeGenerator();
 132 }
 133
 134 /// lto_codegen_dispose - Frees all memory for a code generator. Upon return the
 135 /// lto_code_gen_t is no longer valid.
 136 void lto_codegen_dispose(lto_code_gen_t cg) {
 137   delete cg;
 138 }
 139
 140 /// lto_codegen_add_module - Add an object module to the set of modules for
 141 /// which code will be generated. Returns true on error (check
 142 /// lto_get_error_message() for details).
 143 bool lto_codegen_add_module(lto_code_gen_t cg, lto_module_t mod) {
 144   return cg->addModule(mod, sLastErrorString);
 145 }
 146
 147 /// lto_codegen_set_debug_model - Sets what if any format of debug info should
 148 /// be generated. Returns true on error (check lto_get_error_message() for
 149 /// details).
 150 bool lto_codegen_set_debug_model(lto_code_gen_t cg, lto_debug_model debug) {
 151   return cg->setDebugInfo(debug, sLastErrorString);
 152 }
 153
 154 /// lto_codegen_set_pic_model - Sets what code model to generated. Returns true
 155 /// on error (check lto_get_error_message() for details).
 156 bool lto_codegen_set_pic_model(lto_code_gen_t cg, lto_codegen_model model) {
 157   return cg->setCodePICModel(model, sLastErrorString);
 158 }
 159
 160 /// lto_codegen_set_cpu - Sets the cpu to generate code for.
 161 void lto_codegen_set_cpu(lto_code_gen_t cg, const char *cpu) {
 162   return cg->setCpu(cpu);
 163 }
 164
 165 /// lto_codegen_set_assembler_path - Sets the path to the assembler tool.
 166 void lto_codegen_set_assembler_path(lto_code_gen_t cg, const char *path) {
 167   // In here only for backwards compatibility. We use MC now.
 168 }
 169
 170 /// lto_codegen_set_assembler_args - Sets extra arguments that libLTO should
 171 /// pass to the assembler.
 172 void lto_codegen_set_assembler_args(lto_code_gen_t cg, const char **args,
 173                                     int nargs) {
 174   // In here only for backwards compatibility. We use MC now.
 175 }
 176
 177 /// lto_codegen_add_must_preserve_symbol - Adds to a list of all global symbols
 178 /// that must exist in the final generated code. If a function is not listed
 179 /// there, it might be inlined into every usage and optimized away.
 180 void lto_codegen_add_must_preserve_symbol(lto_code_gen_t cg,
 181                                           const char *symbol) {
 182   cg->addMustPreserveSymbol(symbol);
 183 }
 184
 185 /// lto_codegen_write_merged_modules - Writes a new file at the specified path
 186 /// that contains the merged contents of all modules added so far. Returns true
 187 /// on error (check lto_get_error_message() for details).
 188 bool lto_codegen_write_merged_modules(lto_code_gen_t cg, const char *path) {
 189   return cg->writeMergedModules(path, sLastErrorString);
 190 }
 191
 192 /// lto_codegen_compile - Generates code for all added modules into one native
 193 /// object file. On success returns a pointer to a generated mach-o/ELF buffer
 194 /// and length set to the buffer size. The buffer is owned by the lto_code_gen_t
 195 /// object and will be freed when lto_codegen_dispose() is called, or
 196 /// lto_codegen_compile() is called again. On failure, returns NULL (check
 197 /// lto_get_error_message() for details).
 198 const void *lto_codegen_compile(lto_code_gen_t cg, size_t *length) {
 199   return cg->compile(length, sLastErrorString);
 200 }
 201
 202 /// lto_codegen_compile_to_file - Generates code for all added modules into one
 203 /// native object file. The name of the file is written to name. Returns true on
 204 /// error.
 205 bool lto_codegen_compile_to_file(lto_code_gen_t cg, const char **name) {
 206   return cg->compile_to_file(name, sLastErrorString);
 207 }
 208
 209 /// lto_codegen_debug_options - Used to pass extra options to the code
 210 /// generator.
 211 void lto_codegen_debug_options(lto_code_gen_t cg, const char *opt) {
 212   cg->setCodeGenDebugOptions(opt);
 213 }