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