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
  18 #include "llvm/Constants.h"
  19 #include "llvm/DerivedTypes.h"
  20 #include "llvm/Linker.h"
  21 #include "llvm/LLVMContext.h"
  22 #include "llvm/Module.h"
  23 #include "llvm/PassManager.h"
  24 #include "llvm/ADT/StringExtras.h"
  25 #include "llvm/ADT/Triple.h"
  26 #include "llvm/Analysis/Passes.h"
  27 #include "llvm/Analysis/LoopPass.h"
  28 #include "llvm/Analysis/Verifier.h"
  29 #include "llvm/Bitcode/ReaderWriter.h"
  30 #include "llvm/MC/MCAsmInfo.h"
  31 #include "llvm/MC/MCContext.h"
  32 #include "llvm/Target/Mangler.h"
  33 #include "llvm/Target/SubtargetFeature.h"
  34 #include "llvm/Target/TargetOptions.h"
  35 #include "llvm/Target/TargetData.h"
  36 #include "llvm/Target/TargetMachine.h"
  37 #include "llvm/Target/TargetRegistry.h"
  38 #include "llvm/Target/TargetSelect.h"
  39 #include "llvm/Transforms/IPO.h"
  40 #include "llvm/Transforms/Scalar.h"
  41 #include "llvm/Support/CommandLine.h"
  42 #include "llvm/Support/FormattedStream.h"
  43 #include "llvm/Support/MemoryBuffer.h"
  44 #include "llvm/Support/StandardPasses.h"
  45 #include "llvm/Support/SystemUtils.h"
  46 #include "llvm/System/Host.h"
  47 #include "llvm/System/Program.h"
  48 #include "llvm/System/Signals.h"
  49 #include "llvm/Config/config.h"
  50 #include <cstdlib>
  51 #include <unistd.h>
  52 #include <fcntl.h>
  53
  54
  55 using namespace llvm;
  56
  57 static cl::opt<bool> DisableInline("disable-inlining",
  58   cl::desc("Do not run the inliner pass"));
  59
  60
  61 const char* LTOCodeGenerator::getVersionString()
  62 {
  63 #ifdef LLVM_VERSION_INFO
  64     return PACKAGE_NAME " version " PACKAGE_VERSION ", " LLVM_VERSION_INFO;
  65 #else
  66     return PACKAGE_NAME " version " PACKAGE_VERSION;
  67 #endif
  68 }
  69
  70
  71 LTOCodeGenerator::LTOCodeGenerator()
  72     : _context(getGlobalContext()),
  73       _linker("LinkTimeOptimizer", "ld-temp.o", _context), _target(NULL),
  74       _emitDwarfDebugInfo(false), _scopeRestrictionsDone(false),
  75       _codeModel(LTO_CODEGEN_PIC_MODEL_DYNAMIC),
  76       _nativeObjectFile(NULL), _assemblerPath(NULL)
  77 {
  78     InitializeAllTargets();
  79     InitializeAllAsmPrinters();
  80 }
  81
  82 LTOCodeGenerator::~LTOCodeGenerator()
  83 {
  84     delete _target;
  85     delete _nativeObjectFile;
  86 }
  87
  88
  89
  90 bool LTOCodeGenerator::addModule(LTOModule* mod, std::string& errMsg)
  91 {
  92     return _linker.LinkInModule(mod->getLLVVMModule(), &errMsg);
  93 }
  94
  95
  96 bool LTOCodeGenerator::setDebugInfo(lto_debug_model debug, std::string& errMsg)
  97 {
  98     switch (debug) {
  99         case LTO_DEBUG_MODEL_NONE:
 100             _emitDwarfDebugInfo = false;
 101             return false;
 102
 103         case LTO_DEBUG_MODEL_DWARF:
 104             _emitDwarfDebugInfo = true;
 105             return false;
 106     }
 107     errMsg = "unknown debug format";
 108     return true;
 109 }
 110
 111
 112 bool LTOCodeGenerator::setCodePICModel(lto_codegen_model model,
 113                                        std::string& errMsg)
 114 {
 115     switch (model) {
 116         case LTO_CODEGEN_PIC_MODEL_STATIC:
 117         case LTO_CODEGEN_PIC_MODEL_DYNAMIC:
 118         case LTO_CODEGEN_PIC_MODEL_DYNAMIC_NO_PIC:
 119             _codeModel = model;
 120             return false;
 121     }
 122     errMsg = "unknown pic model";
 123     return true;
 124 }
 125
 126 void LTOCodeGenerator::setAssemblerPath(const char* path)
 127 {
 128     if ( _assemblerPath )
 129         delete _assemblerPath;
 130     _assemblerPath = new sys::Path(path);
 131 }
 132
 133 void LTOCodeGenerator::addMustPreserveSymbol(const char* sym)
 134 {
 135     _mustPreserveSymbols[sym] = 1;
 136 }
 137
 138
 139 bool LTOCodeGenerator::writeMergedModules(const char *path,
 140                                           std::string &errMsg) {
 141   if (determineTarget(errMsg))
 142     return true;
 143
 144   // mark which symbols can not be internalized
 145   applyScopeRestrictions();
 146
 147   // create output file
 148   std::string ErrInfo;
 149   raw_fd_ostream Out(path, ErrInfo,
 150                      raw_fd_ostream::F_Binary);
 151   if (!ErrInfo.empty()) {
 152     errMsg = "could not open bitcode file for writing: ";
 153     errMsg += path;
 154     return true;
 155   }
 156
 157   // write bitcode to it
 158   WriteBitcodeToFile(_linker.getModule(), Out);
 159
 160   if (Out.has_error()) {
 161     errMsg = "could not write bitcode file: ";
 162     errMsg += path;
 163     return true;
 164   }
 165
 166   return false;
 167 }
 168
 169
 170 const void* LTOCodeGenerator::compile(size_t* length, std::string& errMsg)
 171 {
 172     // make unique temp .s file to put generated assembly code
 173     sys::Path uniqueAsmPath("lto-llvm.s");
 174     if ( uniqueAsmPath.createTemporaryFileOnDisk(true, &errMsg) )
 175         return NULL;
 176     sys::RemoveFileOnSignal(uniqueAsmPath);
 177
 178     // generate assembly code
 179     bool genResult = false;
 180     {
 181       raw_fd_ostream asmFD(uniqueAsmPath.c_str(), errMsg);
 182       formatted_raw_ostream asmFile(asmFD);
 183       if (!errMsg.empty())
 184         return NULL;
 185       genResult = this->generateAssemblyCode(asmFile, errMsg);
 186     }
 187     if ( genResult ) {
 188         if ( uniqueAsmPath.exists() )
 189             uniqueAsmPath.eraseFromDisk();
 190         return NULL;
 191     }
 192
 193     // make unique temp .o file to put generated object file
 194     sys::PathWithStatus uniqueObjPath("lto-llvm.o");
 195     if ( uniqueObjPath.createTemporaryFileOnDisk(true, &errMsg) ) {
 196         if ( uniqueAsmPath.exists() )
 197             uniqueAsmPath.eraseFromDisk();
 198         return NULL;
 199     }
 200     sys::RemoveFileOnSignal(uniqueObjPath);
 201
 202     // assemble the assembly code
 203     const std::string& uniqueObjStr = uniqueObjPath.str();
 204     bool asmResult = this->assemble(uniqueAsmPath.str(), uniqueObjStr, errMsg);
 205     if ( !asmResult ) {
 206         // remove old buffer if compile() called twice
 207         delete _nativeObjectFile;
 208
 209         // read .o file into memory buffer
 210         _nativeObjectFile = MemoryBuffer::getFile(uniqueObjStr.c_str(),&errMsg);
 211     }
 212
 213     // remove temp files
 214     uniqueAsmPath.eraseFromDisk();
 215     uniqueObjPath.eraseFromDisk();
 216
 217     // return buffer, unless error
 218     if ( _nativeObjectFile == NULL )
 219         return NULL;
 220     *length = _nativeObjectFile->getBufferSize();
 221     return _nativeObjectFile->getBufferStart();
 222 }
 223
 224
 225 bool LTOCodeGenerator::assemble(const std::string& asmPath,
 226                                 const std::string& objPath, std::string& errMsg)
 227 {
 228     sys::Path tool;
 229     bool needsCompilerOptions = true;
 230     if ( _assemblerPath ) {
 231         tool = *_assemblerPath;
 232         needsCompilerOptions = false;
 233     } else {
 234         // find compiler driver
 235         tool = sys::Program::FindProgramByName("gcc");
 236         if ( tool.isEmpty() ) {
 237             errMsg = "can't locate gcc";
 238             return true;
 239         }
 240     }
 241
 242     // build argument list
 243     std::vector<const char*> args;
 244     llvm::Triple targetTriple(_linker.getModule()->getTargetTriple());
 245     const char *arch = targetTriple.getArchNameForAssembler();
 246
 247     args.push_back(tool.c_str());
 248
 249     if (targetTriple.getOS() == Triple::Darwin) {
 250         // darwin specific command line options
 251         if (arch != NULL) {
 252             args.push_back("-arch");
 253             args.push_back(arch);
 254         }
 255         // add -static to assembler command line when code model requires
 256         if ( (_assemblerPath != NULL) &&
 257             (_codeModel == LTO_CODEGEN_PIC_MODEL_STATIC) )
 258             args.push_back("-static");
 259     }
 260     if ( needsCompilerOptions ) {
 261         args.push_back("-c");
 262         args.push_back("-x");
 263         args.push_back("assembler");
 264     }
 265     args.push_back("-o");
 266     args.push_back(objPath.c_str());
 267     args.push_back(asmPath.c_str());
 268     args.push_back(0);
 269
 270     // invoke assembler
 271     if ( sys::Program::ExecuteAndWait(tool, &args[0], 0, 0, 0, 0, &errMsg) ) {
 272         errMsg = "error in assembly";
 273         return true;
 274     }
 275     return false; // success
 276 }
 277
 278
 279
 280 bool LTOCodeGenerator::determineTarget(std::string& errMsg)
 281 {
 282     if ( _target == NULL ) {
 283         std::string Triple = _linker.getModule()->getTargetTriple();
 284         if (Triple.empty())
 285           Triple = sys::getHostTriple();
 286
 287         // create target machine from info for merged modules
 288         const Target *march = TargetRegistry::lookupTarget(Triple, errMsg);
 289         if ( march == NULL )
 290             return true;
 291
 292         // The relocation model is actually a static member of TargetMachine
 293         // and needs to be set before the TargetMachine is instantiated.
 294         switch( _codeModel ) {
 295         case LTO_CODEGEN_PIC_MODEL_STATIC:
 296             TargetMachine::setRelocationModel(Reloc::Static);
 297             break;
 298         case LTO_CODEGEN_PIC_MODEL_DYNAMIC:
 299             TargetMachine::setRelocationModel(Reloc::PIC_);
 300             break;
 301         case LTO_CODEGEN_PIC_MODEL_DYNAMIC_NO_PIC:
 302             TargetMachine::setRelocationModel(Reloc::DynamicNoPIC);
 303             break;
 304         }
 305
 306         // construct LTModule, hand over ownership of module and target
 307         const std::string FeatureStr =
 308            SubtargetFeatures::getDefaultSubtargetFeatures(llvm::Triple(Triple));
 309         _target = march->createTargetMachine(Triple, FeatureStr);
 310     }
 311     return false;
 312 }
 313
 314 void LTOCodeGenerator::applyScopeRestrictions() {
 315   if (_scopeRestrictionsDone) return;
 316   Module *mergedModule = _linker.getModule();
 317
 318   // Start off with a verification pass.
 319   PassManager passes;
 320   passes.add(createVerifierPass());
 321
 322   // mark which symbols can not be internalized
 323   if (!_mustPreserveSymbols.empty()) {
 324     MCContext Context(*_target->getMCAsmInfo());
 325     Mangler mangler(Context, *_target->getTargetData());
 326     std::vector<const char*> mustPreserveList;
 327     for (Module::iterator f = mergedModule->begin(),
 328          e = mergedModule->end(); f != e; ++f) {
 329       if (!f->isDeclaration() &&
 330           _mustPreserveSymbols.count(mangler.getNameWithPrefix(f)))
 331         mustPreserveList.push_back(::strdup(f->getNameStr().c_str()));
 332     }
 333     for (Module::global_iterator v = mergedModule->global_begin(),
 334          e = mergedModule->global_end(); v !=  e; ++v) {
 335       if (v->isDeclaration() &&
 336           _mustPreserveSymbols.count(mangler.getNameWithPrefix(v)))
 337         mustPreserveList.push_back(::strdup(v->getNameStr().c_str()));
 338     }
 339     passes.add(createInternalizePass(mustPreserveList));
 340   }
 341
 342   // apply scope restrictions
 343   passes.run(*mergedModule);
 344
 345   _scopeRestrictionsDone = true;
 346 }
 347
 348 /// Optimize merged modules using various IPO passes
 349 bool LTOCodeGenerator::generateAssemblyCode(formatted_raw_ostream& out,
 350                                             std::string& errMsg)
 351 {
 352     if ( this->determineTarget(errMsg) )
 353         return true;
 354
 355     // mark which symbols can not be internalized
 356     this->applyScopeRestrictions();
 357
 358     Module* mergedModule = _linker.getModule();
 359
 360     // If target supports exception handling then enable it now.
 361     switch (_target->getMCAsmInfo()->getExceptionHandlingType()) {
 362     case ExceptionHandling::Dwarf:
 363       llvm::DwarfExceptionHandling = true;
 364       break;
 365     case ExceptionHandling::SjLj:
 366       llvm::SjLjExceptionHandling = true;
 367       break;
 368     case ExceptionHandling::None:
 369       break;
 370     default:
 371       assert (0 && "Unknown exception handling model!");
 372     }
 373
 374     // if options were requested, set them
 375     if ( !_codegenOptions.empty() )
 376         cl::ParseCommandLineOptions(_codegenOptions.size(),
 377                                                 (char**)&_codegenOptions[0]);
 378
 379     // Instantiate the pass manager to organize the passes.
 380     PassManager passes;
 381
 382     // Start off with a verification pass.
 383     passes.add(createVerifierPass());
 384
 385     // Add an appropriate TargetData instance for this module...
 386     passes.add(new TargetData(*_target->getTargetData()));
 387
 388     createStandardLTOPasses(&passes, /*Internalize=*/ false, !DisableInline,
 389                             /*VerifyEach=*/ false);
 390
 391     // Make sure everything is still good.
 392     passes.add(createVerifierPass());
 393
 394     FunctionPassManager* codeGenPasses = new FunctionPassManager(mergedModule);
 395
 396     codeGenPasses->add(new TargetData(*_target->getTargetData()));
 397
 398     if (_target->addPassesToEmitFile(*codeGenPasses, out,
 399                                      TargetMachine::CGFT_AssemblyFile,
 400                                      CodeGenOpt::Aggressive)) {
 401       errMsg = "target file type not supported";
 402       return true;
 403     }
 404
 405     // Run our queue of passes all at once now, efficiently.
 406     passes.run(*mergedModule);
 407
 408     // Run the code generator, and write assembly file
 409     codeGenPasses->doInitialization();
 410
 411     for (Module::iterator
 412            it = mergedModule->begin(), e = mergedModule->end(); it != e; ++it)
 413       if (!it->isDeclaration())
 414         codeGenPasses->run(*it);
 415
 416     codeGenPasses->doFinalization();
 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 }