tools/lto/LTOCodeGenerator.cpp

   1 //===-LTOCodeGenerator.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 "LTOModule.h"
  16 #include "LTOCodeGenerator.h"
  17 #include "llvm/Constants.h"
  18 #include "llvm/DerivedTypes.h"
  19 #include "llvm/Linker.h"
  20 #include "llvm/LLVMContext.h"
  21 #include "llvm/Module.h"
  22 #include "llvm/PassManager.h"
  23 #include "llvm/ADT/StringExtras.h"
  24 #include "llvm/ADT/Triple.h"
  25 #include "llvm/Analysis/Passes.h"
  26 #include "llvm/Analysis/Verifier.h"
  27 #include "llvm/Bitcode/ReaderWriter.h"
  28 #include "llvm/MC/MCAsmInfo.h"
  29 #include "llvm/MC/MCContext.h"
  30 #include "llvm/MC/SubtargetFeature.h"
  31 #include "llvm/Target/Mangler.h"
  32 #include "llvm/Target/TargetOptions.h"
  33 #include "llvm/Target/TargetData.h"
  34 #include "llvm/Target/TargetMachine.h"
  35 #include "llvm/Target/TargetRegisterInfo.h"
  36 #include "llvm/Support/CommandLine.h"
  37 #include "llvm/Support/ErrorHandling.h"
  38 #include "llvm/Support/FormattedStream.h"
  39 #include "llvm/Support/MemoryBuffer.h"
  40 #include "llvm/Support/SystemUtils.h"
  41 #include "llvm/Support/ToolOutputFile.h"
  42 #include "llvm/Support/Host.h"
  43 #include "llvm/Support/Program.h"
  44 #include "llvm/Support/Signals.h"
  45 #include "llvm/Support/TargetRegistry.h"
  46 #include "llvm/Support/TargetSelect.h"
  47 #include "llvm/Support/system_error.h"
  48 #include "llvm/Config/config.h"
  49 #include "llvm/Transforms/IPO.h"
  50 #include "llvm/Transforms/IPO/PassManagerBuilder.h"
  51 #include <cstdlib>
  52 #include <unistd.h>
  53 #include <fcntl.h>
  54
  55
  56 using namespace llvm;
  57
  58 static cl::opt<bool> DisableInline("disable-inlining",
  59   cl::desc("Do not run the inliner pass"));
  60
  61
  62 const char* LTOCodeGenerator::getVersionString()
  63 {
  64 #ifdef LLVM_VERSION_INFO
  65     return PACKAGE_NAME " version " PACKAGE_VERSION ", " LLVM_VERSION_INFO;
  66 #else
  67     return PACKAGE_NAME " version " PACKAGE_VERSION;
  68 #endif
  69 }
  70
  71
  72 LTOCodeGenerator::LTOCodeGenerator()
  73     : _context(getGlobalContext()),
  74       _linker("LinkTimeOptimizer", "ld-temp.o", _context), _target(NULL),
  75       _emitDwarfDebugInfo(false), _scopeRestrictionsDone(false),
  76       _codeModel(LTO_CODEGEN_PIC_MODEL_DYNAMIC),
  77       _nativeObjectFile(NULL)
  78 {
  79     InitializeAllTargets();
  80     InitializeAllTargetMCs();
  81     InitializeAllAsmPrinters();
  82 }
  83
  84 LTOCodeGenerator::~LTOCodeGenerator()
  85 {
  86     delete _target;
  87     delete _nativeObjectFile;
  88 }
  89
  90
  91
  92 bool LTOCodeGenerator::addModule(LTOModule* mod, std::string& errMsg)
  93 {
  94   bool ret = _linker.LinkInModule(mod->getLLVVMModule(), &errMsg);
  95
  96   const std::vector<const char*> &undefs = mod->getAsmUndefinedRefs();
  97   for (int i = 0, e = undefs.size(); i != e; ++i)
  98     _asmUndefinedRefs[undefs[i]] = 1;
  99
 100   return ret;
 101 }
 102
 103
 104 bool LTOCodeGenerator::setDebugInfo(lto_debug_model debug, std::string& errMsg)
 105 {
 106     switch (debug) {
 107         case LTO_DEBUG_MODEL_NONE:
 108             _emitDwarfDebugInfo = false;
 109             return false;
 110
 111         case LTO_DEBUG_MODEL_DWARF:
 112             _emitDwarfDebugInfo = true;
 113             return false;
 114     }
 115     llvm_unreachable("Unknown debug format!");
 116 }
 117
 118
 119 bool LTOCodeGenerator::setCodePICModel(lto_codegen_model model,
 120                                        std::string& errMsg)
 121 {
 122     switch (model) {
 123         case LTO_CODEGEN_PIC_MODEL_STATIC:
 124         case LTO_CODEGEN_PIC_MODEL_DYNAMIC:
 125         case LTO_CODEGEN_PIC_MODEL_DYNAMIC_NO_PIC:
 126             _codeModel = model;
 127             return false;
 128     }
 129     llvm_unreachable("Unknown PIC model!");
 130 }
 131
 132 void LTOCodeGenerator::setCpu(const char* mCpu)
 133 {
 134   _mCpu = mCpu;
 135 }
 136
 137 void LTOCodeGenerator::addMustPreserveSymbol(const char* sym)
 138 {
 139     _mustPreserveSymbols[sym] = 1;
 140 }
 141
 142
 143 bool LTOCodeGenerator::writeMergedModules(const char *path,
 144                                           std::string &errMsg) {
 145   if (determineTarget(errMsg))
 146     return true;
 147
 148   // mark which symbols can not be internalized
 149   applyScopeRestrictions();
 150
 151   // create output file
 152   std::string ErrInfo;
 153   tool_output_file Out(path, ErrInfo,
 154                        raw_fd_ostream::F_Binary);
 155   if (!ErrInfo.empty()) {
 156     errMsg = "could not open bitcode file for writing: ";
 157     errMsg += path;
 158     return true;
 159   }
 160
 161   // write bitcode to it
 162   WriteBitcodeToFile(_linker.getModule(), Out.os());
 163   Out.os().close();
 164
 165   if (Out.os().has_error()) {
 166     errMsg = "could not write bitcode file: ";
 167     errMsg += path;
 168     Out.os().clear_error();
 169     return true;
 170   }
 171
 172   Out.keep();
 173   return false;
 174 }
 175
 176
 177 bool LTOCodeGenerator::compile_to_file(const char** name, std::string& errMsg)
 178 {
 179   // make unique temp .o file to put generated object file
 180   sys::PathWithStatus uniqueObjPath("lto-llvm.o");
 181   if ( uniqueObjPath.createTemporaryFileOnDisk(false, &errMsg) ) {
 182     uniqueObjPath.eraseFromDisk();
 183     return true;
 184   }
 185   sys::RemoveFileOnSignal(uniqueObjPath);
 186
 187   // generate object file
 188   bool genResult = false;
 189   tool_output_file objFile(uniqueObjPath.c_str(), errMsg);
 190   if (!errMsg.empty())
 191     return true;
 192   genResult = this->generateObjectFile(objFile.os(), errMsg);
 193   objFile.os().close();
 194   if (objFile.os().has_error()) {
 195     objFile.os().clear_error();
 196     return true;
 197   }
 198   objFile.keep();
 199   if ( genResult ) {
 200     uniqueObjPath.eraseFromDisk();
 201     return true;
 202   }
 203
 204   _nativeObjectPath = uniqueObjPath.str();
 205   *name = _nativeObjectPath.c_str();
 206   return false;
 207 }
 208
 209 const void* LTOCodeGenerator::compile(size_t* length, std::string& errMsg)
 210 {
 211   const char *name;
 212   if (compile_to_file(&name, errMsg))
 213     return NULL;
 214
 215   // remove old buffer if compile() called twice
 216   delete _nativeObjectFile;
 217
 218   // read .o file into memory buffer
 219   OwningPtr<MemoryBuffer> BuffPtr;
 220   if (error_code ec = MemoryBuffer::getFile(name, BuffPtr, -1, false)) {
 221     errMsg = ec.message();
 222     return NULL;
 223   }
 224   _nativeObjectFile = BuffPtr.take();
 225
 226   // remove temp files
 227   sys::Path(_nativeObjectPath).eraseFromDisk();
 228
 229   // return buffer, unless error
 230   if ( _nativeObjectFile == NULL )
 231     return NULL;
 232   *length = _nativeObjectFile->getBufferSize();
 233   return _nativeObjectFile->getBufferStart();
 234 }
 235
 236 bool LTOCodeGenerator::determineTarget(std::string& errMsg)
 237 {
 238     if ( _target == NULL ) {
 239         std::string Triple = _linker.getModule()->getTargetTriple();
 240         if (Triple.empty())
 241           Triple = sys::getDefaultTargetTriple();
 242
 243         // create target machine from info for merged modules
 244         const Target *march = TargetRegistry::lookupTarget(Triple, errMsg);
 245         if ( march == NULL )
 246             return true;
 247
 248         // The relocation model is actually a static member of TargetMachine
 249         // and needs to be set before the TargetMachine is instantiated.
 250         Reloc::Model RelocModel = Reloc::Default;
 251         switch( _codeModel ) {
 252         case LTO_CODEGEN_PIC_MODEL_STATIC:
 253             RelocModel = Reloc::Static;
 254             break;
 255         case LTO_CODEGEN_PIC_MODEL_DYNAMIC:
 256             RelocModel = Reloc::PIC_;
 257             break;
 258         case LTO_CODEGEN_PIC_MODEL_DYNAMIC_NO_PIC:
 259             RelocModel = Reloc::DynamicNoPIC;
 260             break;
 261         }
 262
 263         // construct LTOModule, hand over ownership of module and target
 264         SubtargetFeatures Features;
 265         Features.getDefaultSubtargetFeatures(llvm::Triple(Triple));
 266         std::string FeatureStr = Features.getString();
 267         TargetOptions Options;
 268         _target = march->createTargetMachine(Triple, _mCpu, FeatureStr, Options,
 269                                              RelocModel);
 270     }
 271     return false;
 272 }
 273
 274 void LTOCodeGenerator::applyRestriction(GlobalValue &GV,
 275                                      std::vector<const char*> &mustPreserveList,
 276                                         SmallPtrSet<GlobalValue*, 8> &asmUsed,
 277                                         Mangler &mangler) {
 278   SmallString<64> Buffer;
 279   mangler.getNameWithPrefix(Buffer, &GV, false);
 280
 281   if (GV.isDeclaration())
 282     return;
 283   if (_mustPreserveSymbols.count(Buffer))
 284     mustPreserveList.push_back(GV.getName().data());
 285   if (_asmUndefinedRefs.count(Buffer))
 286     asmUsed.insert(&GV);
 287 }
 288
 289 static void findUsedValues(GlobalVariable *LLVMUsed,
 290                            SmallPtrSet<GlobalValue*, 8> &UsedValues) {
 291   if (LLVMUsed == 0) return;
 292
 293   ConstantArray *Inits = dyn_cast<ConstantArray>(LLVMUsed->getInitializer());
 294   if (Inits == 0) return;
 295
 296   for (unsigned i = 0, e = Inits->getNumOperands(); i != e; ++i)
 297     if (GlobalValue *GV =
 298           dyn_cast<GlobalValue>(Inits->getOperand(i)->stripPointerCasts()))
 299       UsedValues.insert(GV);
 300 }
 301
 302 void LTOCodeGenerator::applyScopeRestrictions() {
 303   if (_scopeRestrictionsDone) return;
 304   Module *mergedModule = _linker.getModule();
 305
 306   // Start off with a verification pass.
 307   PassManager passes;
 308   passes.add(createVerifierPass());
 309
 310   // mark which symbols can not be internalized
 311   MCContext Context(*_target->getMCAsmInfo(), *_target->getRegisterInfo(), NULL);
 312   Mangler mangler(Context, *_target->getTargetData());
 313   std::vector<const char*> mustPreserveList;
 314   SmallPtrSet<GlobalValue*, 8> asmUsed;
 315
 316   for (Module::iterator f = mergedModule->begin(),
 317          e = mergedModule->end(); f != e; ++f)
 318     applyRestriction(*f, mustPreserveList, asmUsed, mangler);
 319   for (Module::global_iterator v = mergedModule->global_begin(),
 320          e = mergedModule->global_end(); v !=  e; ++v)
 321     applyRestriction(*v, mustPreserveList, asmUsed, mangler);
 322   for (Module::alias_iterator a = mergedModule->alias_begin(),
 323          e = mergedModule->alias_end(); a != e; ++a)
 324     applyRestriction(*a, mustPreserveList, asmUsed, mangler);
 325
 326   GlobalVariable *LLVMCompilerUsed =
 327     mergedModule->getGlobalVariable("llvm.compiler.used");
 328   findUsedValues(LLVMCompilerUsed, asmUsed);
 329   if (LLVMCompilerUsed)
 330     LLVMCompilerUsed->eraseFromParent();
 331
 332   llvm::Type *i8PTy = llvm::Type::getInt8PtrTy(_context);
 333   std::vector<Constant*> asmUsed2;
 334   for (SmallPtrSet<GlobalValue*, 16>::const_iterator i = asmUsed.begin(),
 335          e = asmUsed.end(); i !=e; ++i) {
 336     GlobalValue *GV = *i;
 337     Constant *c = ConstantExpr::getBitCast(GV, i8PTy);
 338     asmUsed2.push_back(c);
 339   }
 340
 341   llvm::ArrayType *ATy = llvm::ArrayType::get(i8PTy, asmUsed2.size());
 342   LLVMCompilerUsed =
 343     new llvm::GlobalVariable(*mergedModule, ATy, false,
 344                              llvm::GlobalValue::AppendingLinkage,
 345                              llvm::ConstantArray::get(ATy, asmUsed2),
 346                              "llvm.compiler.used");
 347
 348   LLVMCompilerUsed->setSection("llvm.metadata");
 349
 350   passes.add(createInternalizePass(mustPreserveList));
 351
 352   // apply scope restrictions
 353   passes.run(*mergedModule);
 354
 355   _scopeRestrictionsDone = true;
 356 }
 357
 358 /// Optimize merged modules using various IPO passes
 359 bool LTOCodeGenerator::generateObjectFile(raw_ostream &out,
 360                                           std::string &errMsg) {
 361     if ( this->determineTarget(errMsg) )
 362         return true;
 363
 364     // mark which symbols can not be internalized
 365     this->applyScopeRestrictions();
 366
 367     Module* mergedModule = _linker.getModule();
 368
 369     // if options were requested, set them
 370     if ( !_codegenOptions.empty() )
 371         cl::ParseCommandLineOptions(_codegenOptions.size(),
 372                                     const_cast<char **>(&_codegenOptions[0]));
 373
 374     // Instantiate the pass manager to organize the passes.
 375     PassManager passes;
 376
 377     // Start off with a verification pass.
 378     passes.add(createVerifierPass());
 379
 380     // Add an appropriate TargetData instance for this module...
 381     passes.add(new TargetData(*_target->getTargetData()));
 382
 383     PassManagerBuilder().populateLTOPassManager(passes, /*Internalize=*/ false,
 384                                                 !DisableInline);
 385
 386     // Make sure everything is still good.
 387     passes.add(createVerifierPass());
 388
 389     FunctionPassManager *codeGenPasses = new FunctionPassManager(mergedModule);
 390
 391     codeGenPasses->add(new TargetData(*_target->getTargetData()));
 392
 393     formatted_raw_ostream Out(out);
 394
 395     if (_target->addPassesToEmitFile(*codeGenPasses, Out,
 396                                      TargetMachine::CGFT_ObjectFile,
 397                                      CodeGenOpt::Aggressive)) {
 398       errMsg = "target file type not supported";
 399       return true;
 400     }
 401
 402     // Run our queue of passes all at once now, efficiently.
 403     passes.run(*mergedModule);
 404
 405     // Run the code generator, and write assembly file
 406     codeGenPasses->doInitialization();
 407
 408     for (Module::iterator
 409            it = mergedModule->begin(), e = mergedModule->end(); it != e; ++it)
 410       if (!it->isDeclaration())
 411         codeGenPasses->run(*it);
 412
 413     codeGenPasses->doFinalization();
 414     delete codeGenPasses;
 415
 416     return false; // success
 417 }
 418
 419
 420 /// Optimize merged modules using various IPO passes
 421 void LTOCodeGenerator::setCodeGenDebugOptions(const char* options)
 422 {
 423     for (std::pair<StringRef, StringRef> o = getToken(options);
 424          !o.first.empty(); o = getToken(o.second)) {
 425         // ParseCommandLineOptions() expects argv[0] to be program name.
 426         // Lazily add that.
 427         if ( _codegenOptions.empty() )
 428             _codegenOptions.push_back("libLTO");
 429         _codegenOptions.push_back(strdup(o.first.str().c_str()));
 430     }
 431 }