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 "llvm-c/Core.h"
  17
  18 #include "LTOModule.h"
  19 #include "LTOCodeGenerator.h"
  20
  21
  22 // holds most recent error string
  23 // *** not thread safe ***
  24 static std::string sLastErrorString;
  25
  26
  27
  28 //
  29 // returns a printable string
  30 //
  31 extern const char* lto_get_version()
  32 {
  33     return LTOCodeGenerator::getVersionString();
  34 }
  35
  36 //
  37 // returns the last error string or NULL if last operation was successful
  38 //
  39 const char* lto_get_error_message()
  40 {
  41     return sLastErrorString.c_str();
  42 }
  43
  44
  45
  46 //
  47 // validates if a file is a loadable object file
  48 //
  49 bool lto_module_is_object_file(const char* path)
  50 {
  51     return LTOModule::isBitcodeFile(path);
  52 }
  53
  54
  55 //
  56 // validates if a file is a loadable object file compilable for requested target
  57 //
  58 bool lto_module_is_object_file_for_target(const char* path,
  59                                             const char* target_triplet_prefix)
  60 {
  61     return LTOModule::isBitcodeFileForTarget(path, target_triplet_prefix);
  62 }
  63
  64
  65 //
  66 // validates if a buffer is a loadable object file
  67 //
  68 bool lto_module_is_object_file_in_memory(const void* mem, size_t length)
  69 {
  70     return LTOModule::isBitcodeFile(mem, length);
  71 }
  72
  73
  74 //
  75 // validates if a buffer is a loadable object file compilable for the target
  76 //
  77 bool lto_module_is_object_file_in_memory_for_target(const void* mem,
  78                             size_t length, const char* target_triplet_prefix)
  79 {
  80     return LTOModule::isBitcodeFileForTarget(mem, length, target_triplet_prefix);
  81 }
  82
  83
  84
  85 //
  86 // loads an object file from disk
  87 // returns NULL on error (check lto_get_error_message() for details)
  88 //
  89 lto_module_t lto_module_create(const char* path)
  90 {
  91      return LTOModule::makeLTOModule(path, sLastErrorString);
  92 }
  93
  94
  95 //
  96 // loads an object file from memory
  97 // returns NULL on error (check lto_get_error_message() for details)
  98 //
  99 lto_module_t lto_module_create_from_memory(const void* mem, size_t length)
 100 {
 101      return LTOModule::makeLTOModule(mem, length, sLastErrorString);
 102 }
 103
 104
 105 //
 106 // frees all memory for a module
 107 // upon return the lto_module_t is no longer valid
 108 //
 109 void lto_module_dispose(lto_module_t mod)
 110 {
 111     delete mod;
 112 }
 113
 114
 115 //
 116 // returns triplet string which the object module was compiled under
 117 //
 118 const char* lto_module_get_target_triple(lto_module_t mod)
 119 {
 120     return mod->getTargetTriple();
 121 }
 122
 123 //
 124 // sets triple string with which the object will be codegened.
 125 //
 126 void lto_module_set_target_triple(lto_module_t mod, const char *triple)
 127 {
 128     return mod->setTargetTriple(triple);
 129 }
 130
 131
 132 //
 133 // returns the number of symbols in the object module
 134 //
 135 uint32_t lto_module_get_num_symbols(lto_module_t mod)
 136 {
 137     return mod->getSymbolCount();
 138 }
 139
 140 //
 141 // returns the name of the ith symbol in the object module
 142 //
 143 const char* lto_module_get_symbol_name(lto_module_t mod, uint32_t index)
 144 {
 145     return mod->getSymbolName(index);
 146 }
 147
 148
 149 //
 150 // returns the attributes of the ith symbol in the object module
 151 //
 152 lto_symbol_attributes lto_module_get_symbol_attribute(lto_module_t mod,
 153                                                             uint32_t index)
 154 {
 155     return mod->getSymbolAttributes(index);
 156 }
 157
 158
 159
 160
 161
 162 //
 163 // instantiates a code generator
 164 // returns NULL if there is an error
 165 //
 166 lto_code_gen_t lto_codegen_create(void)
 167 {
 168      return new LTOCodeGenerator();
 169 }
 170
 171
 172
 173 //
 174 // frees all memory for a code generator
 175 // upon return the lto_code_gen_t is no longer valid
 176 //
 177 void lto_codegen_dispose(lto_code_gen_t cg)
 178 {
 179     delete cg;
 180 }
 181
 182
 183
 184 //
 185 // add an object module to the set of modules for which code will be generated
 186 // returns true on error (check lto_get_error_message() for details)
 187 //
 188 bool lto_codegen_add_module(lto_code_gen_t cg, lto_module_t mod)
 189 {
 190     return cg->addModule(mod, sLastErrorString);
 191 }
 192
 193
 194 //
 195 // sets what if any format of debug info should be generated
 196 // returns true on error (check lto_get_error_message() for details)
 197 //
 198 bool lto_codegen_set_debug_model(lto_code_gen_t cg, lto_debug_model debug)
 199 {
 200     return cg->setDebugInfo(debug, sLastErrorString);
 201 }
 202
 203
 204 //
 205 // sets what code model to generated
 206 // returns true on error (check lto_get_error_message() for details)
 207 //
 208 bool lto_codegen_set_pic_model(lto_code_gen_t cg, lto_codegen_model model)
 209 {
 210   return cg->setCodePICModel(model, sLastErrorString);
 211 }
 212
 213 //
 214 // sets the path to the assembler tool
 215 //
 216 void lto_codegen_set_assembler_path(lto_code_gen_t cg, const char* path)
 217 {
 218     cg->setAssemblerPath(path);
 219 }
 220
 221
 222 //
 223 // sets extra arguments that libLTO should pass to the assembler
 224 //
 225 void lto_codegen_set_assembler_args(lto_code_gen_t cg, const char** args,
 226                                     int nargs)
 227 {
 228   cg->setAssemblerArgs(args, nargs);
 229 }
 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 there, it might be
 234 // inlined into every usage and optimized away.
 235 //
 236 void lto_codegen_add_must_preserve_symbol(lto_code_gen_t cg, const char* symbol)
 237 {
 238   cg->addMustPreserveSymbol(symbol);
 239 }
 240
 241
 242 //
 243 // writes a new file at the specified path that contains the
 244 // merged contents of all modules added so far.
 245 // returns true on error (check lto_get_error_message() for details)
 246 //
 247 bool lto_codegen_write_merged_modules(lto_code_gen_t cg, const char* path)
 248 {
 249   return cg->writeMergedModules(path, sLastErrorString);
 250 }
 251
 252
 253 //
 254 // Generates code for all added modules into one native object file.
 255 // On sucess returns a pointer to a generated mach-o/ELF buffer and
 256 // length set to the buffer size.  The buffer is owned by the
 257 // lto_code_gen_t and will be freed when lto_codegen_dispose()
 258 // is called, or lto_codegen_compile() is called again.
 259 // On failure, returns NULL (check lto_get_error_message() for details).
 260 //
 261 extern const void*
 262 lto_codegen_compile(lto_code_gen_t cg, size_t* length)
 263 {
 264   return cg->compile(length, sLastErrorString);
 265 }
 266
 267
 268 //
 269 // Used to pass extra options to the code generator
 270 //
 271 extern void
 272 lto_codegen_debug_options(lto_code_gen_t cg, const char * opt)
 273 {
 274   cg->setCodeGenDebugOptions(opt);
 275 }