contrib/llvm/lib/LTO/LTOBackend.cpp

   1 //===-LTOBackend.cpp - LLVM Link Time Optimizer Backend -------------------===//
   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 "backend" phase of LTO, i.e. it performs
  11 // optimization and code generation on a loaded module. It is generally used
  12 // internally by the LTO class but can also be used independently, for example
  13 // to implement a standalone ThinLTO backend.
  14 //
  15 //===----------------------------------------------------------------------===//
  16
  17 #include "llvm/LTO/LTOBackend.h"
  18 #include "llvm/Analysis/AliasAnalysis.h"
  19 #include "llvm/Analysis/CGSCCPassManager.h"
  20 #include "llvm/Analysis/TargetLibraryInfo.h"
  21 #include "llvm/Analysis/TargetTransformInfo.h"
  22 #include "llvm/Bitcode/BitcodeReader.h"
  23 #include "llvm/Bitcode/BitcodeWriter.h"
  24 #include "llvm/IR/LegacyPassManager.h"
  25 #include "llvm/IR/PassManager.h"
  26 #include "llvm/IR/Verifier.h"
  27 #include "llvm/LTO/LTO.h"
  28 #include "llvm/MC/SubtargetFeature.h"
  29 #include "llvm/Object/ModuleSymbolTable.h"
  30 #include "llvm/Passes/PassBuilder.h"
  31 #include "llvm/Support/Error.h"
  32 #include "llvm/Support/FileSystem.h"
  33 #include "llvm/Support/TargetRegistry.h"
  34 #include "llvm/Support/ThreadPool.h"
  35 #include "llvm/Target/TargetMachine.h"
  36 #include "llvm/Transforms/IPO.h"
  37 #include "llvm/Transforms/IPO/PassManagerBuilder.h"
  38 #include "llvm/Transforms/Scalar/LoopPassManager.h"
  39 #include "llvm/Transforms/Utils/FunctionImportUtils.h"
  40 #include "llvm/Transforms/Utils/SplitModule.h"
  41
  42 using namespace llvm;
  43 using namespace lto;
  44
  45 LLVM_ATTRIBUTE_NORETURN static void reportOpenError(StringRef Path, Twine Msg) {
  46   errs() << "failed to open " << Path << ": " << Msg << '\n';
  47   errs().flush();
  48   exit(1);
  49 }
  50
  51 Error Config::addSaveTemps(std::string OutputFileName,
  52                            bool UseInputModulePath) {
  53   ShouldDiscardValueNames = false;
  54
  55   std::error_code EC;
  56   ResolutionFile = llvm::make_unique<raw_fd_ostream>(
  57       OutputFileName + "resolution.txt", EC, sys::fs::OpenFlags::F_Text);
  58   if (EC)
  59     return errorCodeToError(EC);
  60
  61   auto setHook = [&](std::string PathSuffix, ModuleHookFn &Hook) {
  62     // Keep track of the hook provided by the linker, which also needs to run.
  63     ModuleHookFn LinkerHook = Hook;
  64     Hook = [=](unsigned Task, const Module &M) {
  65       // If the linker's hook returned false, we need to pass that result
  66       // through.
  67       if (LinkerHook && !LinkerHook(Task, M))
  68         return false;
  69
  70       std::string PathPrefix;
  71       // If this is the combined module (not a ThinLTO backend compile) or the
  72       // user hasn't requested using the input module's path, emit to a file
  73       // named from the provided OutputFileName with the Task ID appended.
  74       if (M.getModuleIdentifier() == "ld-temp.o" || !UseInputModulePath) {
  75         PathPrefix = OutputFileName + utostr(Task);
  76       } else
  77         PathPrefix = M.getModuleIdentifier();
  78       std::string Path = PathPrefix + "." + PathSuffix + ".bc";
  79       std::error_code EC;
  80       raw_fd_ostream OS(Path, EC, sys::fs::OpenFlags::F_None);
  81       // Because -save-temps is a debugging feature, we report the error
  82       // directly and exit.
  83       if (EC)
  84         reportOpenError(Path, EC.message());
  85       WriteBitcodeToFile(&M, OS, /*ShouldPreserveUseListOrder=*/false);
  86       return true;
  87     };
  88   };
  89
  90   setHook("0.preopt", PreOptModuleHook);
  91   setHook("1.promote", PostPromoteModuleHook);
  92   setHook("2.internalize", PostInternalizeModuleHook);
  93   setHook("3.import", PostImportModuleHook);
  94   setHook("4.opt", PostOptModuleHook);
  95   setHook("5.precodegen", PreCodeGenModuleHook);
  96
  97   CombinedIndexHook = [=](const ModuleSummaryIndex &Index) {
  98     std::string Path = OutputFileName + "index.bc";
  99     std::error_code EC;
 100     raw_fd_ostream OS(Path, EC, sys::fs::OpenFlags::F_None);
 101     // Because -save-temps is a debugging feature, we report the error
 102     // directly and exit.
 103     if (EC)
 104       reportOpenError(Path, EC.message());
 105     WriteIndexToFile(Index, OS);
 106     return true;
 107   };
 108
 109   return Error::success();
 110 }
 111
 112 namespace {
 113
 114 std::unique_ptr<TargetMachine>
 115 createTargetMachine(Config &Conf, const Target *TheTarget, Module &M) {
 116   StringRef TheTriple = M.getTargetTriple();
 117   SubtargetFeatures Features;
 118   Features.getDefaultSubtargetFeatures(Triple(TheTriple));
 119   for (const std::string &A : Conf.MAttrs)
 120     Features.AddFeature(A);
 121
 122   Reloc::Model RelocModel;
 123   if (Conf.RelocModel)
 124     RelocModel = *Conf.RelocModel;
 125   else
 126     RelocModel =
 127         M.getPICLevel() == PICLevel::NotPIC ? Reloc::Static : Reloc::PIC_;
 128
 129   return std::unique_ptr<TargetMachine>(TheTarget->createTargetMachine(
 130       TheTriple, Conf.CPU, Features.getString(), Conf.Options, RelocModel,
 131       Conf.CodeModel, Conf.CGOptLevel));
 132 }
 133
 134 static void runNewPMPasses(Config &Conf, Module &Mod, TargetMachine *TM,
 135                            unsigned OptLevel, bool IsThinLTO) {
 136   Optional<PGOOptions> PGOOpt;
 137   if (!Conf.SampleProfile.empty())
 138     PGOOpt = PGOOptions("", "", Conf.SampleProfile, false, true);
 139
 140   PassBuilder PB(TM, PGOOpt);
 141   AAManager AA;
 142
 143   // Parse a custom AA pipeline if asked to.
 144   if (!PB.parseAAPipeline(AA, "default"))
 145     report_fatal_error("Error parsing default AA pipeline");
 146
 147   LoopAnalysisManager LAM(Conf.DebugPassManager);
 148   FunctionAnalysisManager FAM(Conf.DebugPassManager);
 149   CGSCCAnalysisManager CGAM(Conf.DebugPassManager);
 150   ModuleAnalysisManager MAM(Conf.DebugPassManager);
 151
 152   // Register the AA manager first so that our version is the one used.
 153   FAM.registerPass([&] { return std::move(AA); });
 154
 155   // Register all the basic analyses with the managers.
 156   PB.registerModuleAnalyses(MAM);
 157   PB.registerCGSCCAnalyses(CGAM);
 158   PB.registerFunctionAnalyses(FAM);
 159   PB.registerLoopAnalyses(LAM);
 160   PB.crossRegisterProxies(LAM, FAM, CGAM, MAM);
 161
 162   ModulePassManager MPM(Conf.DebugPassManager);
 163   // FIXME (davide): verify the input.
 164
 165   PassBuilder::OptimizationLevel OL;
 166
 167   switch (OptLevel) {
 168   default:
 169     llvm_unreachable("Invalid optimization level");
 170   case 0:
 171     OL = PassBuilder::O0;
 172     break;
 173   case 1:
 174     OL = PassBuilder::O1;
 175     break;
 176   case 2:
 177     OL = PassBuilder::O2;
 178     break;
 179   case 3:
 180     OL = PassBuilder::O3;
 181     break;
 182   }
 183
 184   if (IsThinLTO)
 185     MPM = PB.buildThinLTODefaultPipeline(OL, Conf.DebugPassManager);
 186   else
 187     MPM = PB.buildLTODefaultPipeline(OL, Conf.DebugPassManager);
 188   MPM.run(Mod, MAM);
 189
 190   // FIXME (davide): verify the output.
 191 }
 192
 193 static void runNewPMCustomPasses(Module &Mod, TargetMachine *TM,
 194                                  std::string PipelineDesc,
 195                                  std::string AAPipelineDesc,
 196                                  bool DisableVerify) {
 197   PassBuilder PB(TM);
 198   AAManager AA;
 199
 200   // Parse a custom AA pipeline if asked to.
 201   if (!AAPipelineDesc.empty())
 202     if (!PB.parseAAPipeline(AA, AAPipelineDesc))
 203       report_fatal_error("unable to parse AA pipeline description: " +
 204                          AAPipelineDesc);
 205
 206   LoopAnalysisManager LAM;
 207   FunctionAnalysisManager FAM;
 208   CGSCCAnalysisManager CGAM;
 209   ModuleAnalysisManager MAM;
 210
 211   // Register the AA manager first so that our version is the one used.
 212   FAM.registerPass([&] { return std::move(AA); });
 213
 214   // Register all the basic analyses with the managers.
 215   PB.registerModuleAnalyses(MAM);
 216   PB.registerCGSCCAnalyses(CGAM);
 217   PB.registerFunctionAnalyses(FAM);
 218   PB.registerLoopAnalyses(LAM);
 219   PB.crossRegisterProxies(LAM, FAM, CGAM, MAM);
 220
 221   ModulePassManager MPM;
 222
 223   // Always verify the input.
 224   MPM.addPass(VerifierPass());
 225
 226   // Now, add all the passes we've been requested to.
 227   if (!PB.parsePassPipeline(MPM, PipelineDesc))
 228     report_fatal_error("unable to parse pass pipeline description: " +
 229                        PipelineDesc);
 230
 231   if (!DisableVerify)
 232     MPM.addPass(VerifierPass());
 233   MPM.run(Mod, MAM);
 234 }
 235
 236 static void runOldPMPasses(Config &Conf, Module &Mod, TargetMachine *TM,
 237                            bool IsThinLTO, ModuleSummaryIndex *ExportSummary,
 238                            const ModuleSummaryIndex *ImportSummary) {
 239   legacy::PassManager passes;
 240   passes.add(createTargetTransformInfoWrapperPass(TM->getTargetIRAnalysis()));
 241
 242   PassManagerBuilder PMB;
 243   PMB.LibraryInfo = new TargetLibraryInfoImpl(Triple(TM->getTargetTriple()));
 244   PMB.Inliner = createFunctionInliningPass();
 245   PMB.ExportSummary = ExportSummary;
 246   PMB.ImportSummary = ImportSummary;
 247   // Unconditionally verify input since it is not verified before this
 248   // point and has unknown origin.
 249   PMB.VerifyInput = true;
 250   PMB.VerifyOutput = !Conf.DisableVerify;
 251   PMB.LoopVectorize = true;
 252   PMB.SLPVectorize = true;
 253   PMB.OptLevel = Conf.OptLevel;
 254   PMB.PGOSampleUse = Conf.SampleProfile;
 255   if (IsThinLTO)
 256     PMB.populateThinLTOPassManager(passes);
 257   else
 258     PMB.populateLTOPassManager(passes);
 259   passes.run(Mod);
 260 }
 261
 262 bool opt(Config &Conf, TargetMachine *TM, unsigned Task, Module &Mod,
 263          bool IsThinLTO, ModuleSummaryIndex *ExportSummary,
 264          const ModuleSummaryIndex *ImportSummary) {
 265   // FIXME: Plumb the combined index into the new pass manager.
 266   if (!Conf.OptPipeline.empty())
 267     runNewPMCustomPasses(Mod, TM, Conf.OptPipeline, Conf.AAPipeline,
 268                          Conf.DisableVerify);
 269   else if (Conf.UseNewPM)
 270     runNewPMPasses(Conf, Mod, TM, Conf.OptLevel, IsThinLTO);
 271   else
 272     runOldPMPasses(Conf, Mod, TM, IsThinLTO, ExportSummary, ImportSummary);
 273   return !Conf.PostOptModuleHook || Conf.PostOptModuleHook(Task, Mod);
 274 }
 275
 276 void codegen(Config &Conf, TargetMachine *TM, AddStreamFn AddStream,
 277              unsigned Task, Module &Mod) {
 278   if (Conf.PreCodeGenModuleHook && !Conf.PreCodeGenModuleHook(Task, Mod))
 279     return;
 280
 281   auto Stream = AddStream(Task);
 282   legacy::PassManager CodeGenPasses;
 283   if (TM->addPassesToEmitFile(CodeGenPasses, *Stream->OS, Conf.CGFileType))
 284     report_fatal_error("Failed to setup codegen");
 285   CodeGenPasses.run(Mod);
 286 }
 287
 288 void splitCodeGen(Config &C, TargetMachine *TM, AddStreamFn AddStream,
 289                   unsigned ParallelCodeGenParallelismLevel,
 290                   std::unique_ptr<Module> Mod) {
 291   ThreadPool CodegenThreadPool(ParallelCodeGenParallelismLevel);
 292   unsigned ThreadCount = 0;
 293   const Target *T = &TM->getTarget();
 294
 295   SplitModule(
 296       std::move(Mod), ParallelCodeGenParallelismLevel,
 297       [&](std::unique_ptr<Module> MPart) {
 298         // We want to clone the module in a new context to multi-thread the
 299         // codegen. We do it by serializing partition modules to bitcode
 300         // (while still on the main thread, in order to avoid data races) and
 301         // spinning up new threads which deserialize the partitions into
 302         // separate contexts.
 303         // FIXME: Provide a more direct way to do this in LLVM.
 304         SmallString<0> BC;
 305         raw_svector_ostream BCOS(BC);
 306         WriteBitcodeToFile(MPart.get(), BCOS);
 307
 308         // Enqueue the task
 309         CodegenThreadPool.async(
 310             [&](const SmallString<0> &BC, unsigned ThreadId) {
 311               LTOLLVMContext Ctx(C);
 312               Expected<std::unique_ptr<Module>> MOrErr = parseBitcodeFile(
 313                   MemoryBufferRef(StringRef(BC.data(), BC.size()), "ld-temp.o"),
 314                   Ctx);
 315               if (!MOrErr)
 316                 report_fatal_error("Failed to read bitcode");
 317               std::unique_ptr<Module> MPartInCtx = std::move(MOrErr.get());
 318
 319               std::unique_ptr<TargetMachine> TM =
 320                   createTargetMachine(C, T, *MPartInCtx);
 321
 322               codegen(C, TM.get(), AddStream, ThreadId, *MPartInCtx);
 323             },
 324             // Pass BC using std::move to ensure that it get moved rather than
 325             // copied into the thread's context.
 326             std::move(BC), ThreadCount++);
 327       },
 328       false);
 329
 330   // Because the inner lambda (which runs in a worker thread) captures our local
 331   // variables, we need to wait for the worker threads to terminate before we
 332   // can leave the function scope.
 333   CodegenThreadPool.wait();
 334 }
 335
 336 Expected<const Target *> initAndLookupTarget(Config &C, Module &Mod) {
 337   if (!C.OverrideTriple.empty())
 338     Mod.setTargetTriple(C.OverrideTriple);
 339   else if (Mod.getTargetTriple().empty())
 340     Mod.setTargetTriple(C.DefaultTriple);
 341
 342   std::string Msg;
 343   const Target *T = TargetRegistry::lookupTarget(Mod.getTargetTriple(), Msg);
 344   if (!T)
 345     return make_error<StringError>(Msg, inconvertibleErrorCode());
 346   return T;
 347 }
 348
 349 }
 350
 351 static void
 352 finalizeOptimizationRemarks(std::unique_ptr<ToolOutputFile> DiagOutputFile) {
 353   // Make sure we flush the diagnostic remarks file in case the linker doesn't
 354   // call the global destructors before exiting.
 355   if (!DiagOutputFile)
 356     return;
 357   DiagOutputFile->keep();
 358   DiagOutputFile->os().flush();
 359 }
 360
 361 Error lto::backend(Config &C, AddStreamFn AddStream,
 362                    unsigned ParallelCodeGenParallelismLevel,
 363                    std::unique_ptr<Module> Mod,
 364                    ModuleSummaryIndex &CombinedIndex) {
 365   Expected<const Target *> TOrErr = initAndLookupTarget(C, *Mod);
 366   if (!TOrErr)
 367     return TOrErr.takeError();
 368
 369   std::unique_ptr<TargetMachine> TM = createTargetMachine(C, *TOrErr, *Mod);
 370
 371   // Setup optimization remarks.
 372   auto DiagFileOrErr = lto::setupOptimizationRemarks(
 373       Mod->getContext(), C.RemarksFilename, C.RemarksWithHotness);
 374   if (!DiagFileOrErr)
 375     return DiagFileOrErr.takeError();
 376   auto DiagnosticOutputFile = std::move(*DiagFileOrErr);
 377
 378   if (!C.CodeGenOnly) {
 379     if (!opt(C, TM.get(), 0, *Mod, /*IsThinLTO=*/false,
 380              /*ExportSummary=*/&CombinedIndex, /*ImportSummary=*/nullptr)) {
 381       finalizeOptimizationRemarks(std::move(DiagnosticOutputFile));
 382       return Error::success();
 383     }
 384   }
 385
 386   if (ParallelCodeGenParallelismLevel == 1) {
 387     codegen(C, TM.get(), AddStream, 0, *Mod);
 388   } else {
 389     splitCodeGen(C, TM.get(), AddStream, ParallelCodeGenParallelismLevel,
 390                  std::move(Mod));
 391   }
 392   finalizeOptimizationRemarks(std::move(DiagnosticOutputFile));
 393   return Error::success();
 394 }
 395
 396 Error lto::thinBackend(Config &Conf, unsigned Task, AddStreamFn AddStream,
 397                        Module &Mod, const ModuleSummaryIndex &CombinedIndex,
 398                        const FunctionImporter::ImportMapTy &ImportList,
 399                        const GVSummaryMapTy &DefinedGlobals,
 400                        MapVector<StringRef, BitcodeModule> &ModuleMap) {
 401   Expected<const Target *> TOrErr = initAndLookupTarget(Conf, Mod);
 402   if (!TOrErr)
 403     return TOrErr.takeError();
 404
 405   std::unique_ptr<TargetMachine> TM = createTargetMachine(Conf, *TOrErr, Mod);
 406
 407   if (Conf.CodeGenOnly) {
 408     codegen(Conf, TM.get(), AddStream, Task, Mod);
 409     return Error::success();
 410   }
 411
 412   if (Conf.PreOptModuleHook && !Conf.PreOptModuleHook(Task, Mod))
 413     return Error::success();
 414
 415   renameModuleForThinLTO(Mod, CombinedIndex);
 416
 417   thinLTOResolveWeakForLinkerModule(Mod, DefinedGlobals);
 418
 419   if (Conf.PostPromoteModuleHook && !Conf.PostPromoteModuleHook(Task, Mod))
 420     return Error::success();
 421
 422   if (!DefinedGlobals.empty())
 423     thinLTOInternalizeModule(Mod, DefinedGlobals);
 424
 425   if (Conf.PostInternalizeModuleHook &&
 426       !Conf.PostInternalizeModuleHook(Task, Mod))
 427     return Error::success();
 428
 429   auto ModuleLoader = [&](StringRef Identifier) {
 430     assert(Mod.getContext().isODRUniquingDebugTypes() &&
 431            "ODR Type uniquing should be enabled on the context");
 432     auto I = ModuleMap.find(Identifier);
 433     assert(I != ModuleMap.end());
 434     return I->second.getLazyModule(Mod.getContext(),
 435                                    /*ShouldLazyLoadMetadata=*/true,
 436                                    /*IsImporting*/ true);
 437   };
 438
 439   FunctionImporter Importer(CombinedIndex, ModuleLoader);
 440   if (Error Err = Importer.importFunctions(Mod, ImportList).takeError())
 441     return Err;
 442
 443   if (Conf.PostImportModuleHook && !Conf.PostImportModuleHook(Task, Mod))
 444     return Error::success();
 445
 446   if (!opt(Conf, TM.get(), Task, Mod, /*IsThinLTO=*/true,
 447            /*ExportSummary=*/nullptr, /*ImportSummary=*/&CombinedIndex))
 448     return Error::success();
 449
 450   codegen(Conf, TM.get(), AddStream, Task, Mod);
 451   return Error::success();
 452 }