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 "llvm/LTO/LTOCodeGenerator.h"
16 #include "llvm/ADT/StringExtras.h"
17 #include "llvm/Analysis/Passes.h"
18 #include "llvm/Analysis/TargetLibraryInfo.h"
19 #include "llvm/Analysis/TargetTransformInfo.h"
20 #include "llvm/Bitcode/ReaderWriter.h"
21 #include "llvm/CodeGen/ParallelCG.h"
22 #include "llvm/CodeGen/RuntimeLibcalls.h"
23 #include "llvm/Config/config.h"
24 #include "llvm/IR/Constants.h"
25 #include "llvm/IR/DataLayout.h"
26 #include "llvm/IR/DerivedTypes.h"
27 #include "llvm/IR/DiagnosticInfo.h"
28 #include "llvm/IR/DiagnosticPrinter.h"
29 #include "llvm/IR/LLVMContext.h"
30 #include "llvm/IR/LegacyPassManager.h"
31 #include "llvm/IR/Mangler.h"
32 #include "llvm/IR/Module.h"
33 #include "llvm/IR/Verifier.h"
34 #include "llvm/InitializePasses.h"
35 #include "llvm/LTO/LTOModule.h"
36 #include "llvm/Linker/Linker.h"
37 #include "llvm/MC/MCAsmInfo.h"
38 #include "llvm/MC/MCContext.h"
39 #include "llvm/MC/SubtargetFeature.h"
40 #include "llvm/Support/CommandLine.h"
41 #include "llvm/Support/FileSystem.h"
42 #include "llvm/Support/Host.h"
43 #include "llvm/Support/MemoryBuffer.h"
44 #include "llvm/Support/Signals.h"
45 #include "llvm/Support/TargetRegistry.h"
46 #include "llvm/Support/TargetSelect.h"
47 #include "llvm/Support/ToolOutputFile.h"
48 #include "llvm/Support/raw_ostream.h"
49 #include "llvm/Target/TargetLowering.h"
50 #include "llvm/Target/TargetOptions.h"
51 #include "llvm/Target/TargetRegisterInfo.h"
52 #include "llvm/Target/TargetSubtargetInfo.h"
53 #include "llvm/Transforms/IPO.h"
54 #include "llvm/Transforms/IPO/PassManagerBuilder.h"
55 #include "llvm/Transforms/ObjCARC.h"
56 #include <system_error>
57 using namespace llvm;
58 
59 const char* LTOCodeGenerator::getVersionString() {
60 #ifdef LLVM_VERSION_INFO
61   return PACKAGE_NAME " version " PACKAGE_VERSION ", " LLVM_VERSION_INFO;
62 #else
63   return PACKAGE_NAME " version " PACKAGE_VERSION;
64 #endif
65 }
66 
67 LTOCodeGenerator::LTOCodeGenerator()
68     : Context(getGlobalContext()),
69       MergedModule(new Module("ld-temp.o", Context)),
70       IRLinker(MergedModule.get()) {
71   initializeLTOPasses();
72 }
73 
74 LTOCodeGenerator::LTOCodeGenerator(std::unique_ptr<LLVMContext> Context)
75     : OwnedContext(std::move(Context)), Context(*OwnedContext),
76       MergedModule(new Module("ld-temp.o", *OwnedContext)),
77       IRLinker(MergedModule.get()) {
78   initializeLTOPasses();
79 }
80 
81 LTOCodeGenerator::~LTOCodeGenerator() {}
82 
83 // Initialize LTO passes. Please keep this function in sync with
84 // PassManagerBuilder::populateLTOPassManager(), and make sure all LTO
85 // passes are initialized.
86 void LTOCodeGenerator::initializeLTOPasses() {
87   PassRegistry &R = *PassRegistry::getPassRegistry();
88 
89   initializeInternalizePassPass(R);
90   initializeIPSCCPPass(R);
91   initializeGlobalOptPass(R);
92   initializeConstantMergePass(R);
93   initializeDAHPass(R);
94   initializeInstructionCombiningPassPass(R);
95   initializeSimpleInlinerPass(R);
96   initializePruneEHPass(R);
97   initializeGlobalDCEPass(R);
98   initializeArgPromotionPass(R);
99   initializeJumpThreadingPass(R);
100   initializeSROALegacyPassPass(R);
101   initializeSROA_DTPass(R);
102   initializeSROA_SSAUpPass(R);
103   initializeFunctionAttrsPass(R);
104   initializeGlobalsAAWrapperPassPass(R);
105   initializeLICMPass(R);
106   initializeMergedLoadStoreMotionPass(R);
107   initializeGVNPass(R);
108   initializeMemCpyOptPass(R);
109   initializeDCEPass(R);
110   initializeCFGSimplifyPassPass(R);
111 }
112 
113 bool LTOCodeGenerator::addModule(LTOModule *Mod) {
114   assert(&Mod->getModule().getContext() == &Context &&
115          "Expected module in same context");
116 
117   bool ret = IRLinker.linkInModule(&Mod->getModule());
118 
119   const std::vector<const char *> &undefs = Mod->getAsmUndefinedRefs();
120   for (int i = 0, e = undefs.size(); i != e; ++i)
121     AsmUndefinedRefs[undefs[i]] = 1;
122 
123   return !ret;
124 }
125 
126 void LTOCodeGenerator::setModule(std::unique_ptr<LTOModule> Mod) {
127   assert(&Mod->getModule().getContext() == &Context &&
128          "Expected module in same context");
129 
130   AsmUndefinedRefs.clear();
131 
132   MergedModule = Mod->takeModule();
133   IRLinker.setModule(MergedModule.get());
134 
135   const std::vector<const char*> &Undefs = Mod->getAsmUndefinedRefs();
136   for (int I = 0, E = Undefs.size(); I != E; ++I)
137     AsmUndefinedRefs[Undefs[I]] = 1;
138 }
139 
140 void LTOCodeGenerator::setTargetOptions(TargetOptions Options) {
141   this->Options = Options;
142 }
143 
144 void LTOCodeGenerator::setDebugInfo(lto_debug_model Debug) {
145   switch (Debug) {
146   case LTO_DEBUG_MODEL_NONE:
147     EmitDwarfDebugInfo = false;
148     return;
149 
150   case LTO_DEBUG_MODEL_DWARF:
151     EmitDwarfDebugInfo = true;
152     return;
153   }
154   llvm_unreachable("Unknown debug format!");
155 }
156 
157 void LTOCodeGenerator::setOptLevel(unsigned Level) {
158   OptLevel = Level;
159   switch (OptLevel) {
160   case 0:
161     CGOptLevel = CodeGenOpt::None;
162     break;
163   case 1:
164     CGOptLevel = CodeGenOpt::Less;
165     break;
166   case 2:
167     CGOptLevel = CodeGenOpt::Default;
168     break;
169   case 3:
170     CGOptLevel = CodeGenOpt::Aggressive;
171     break;
172   }
173 }
174 
175 bool LTOCodeGenerator::writeMergedModules(const char *Path,
176                                           std::string &ErrMsg) {
177   if (!determineTarget(ErrMsg))
178     return false;
179 
180   // mark which symbols can not be internalized
181   applyScopeRestrictions();
182 
183   // create output file
184   std::error_code EC;
185   tool_output_file Out(Path, EC, sys::fs::F_None);
186   if (EC) {
187     ErrMsg = "could not open bitcode file for writing: ";
188     ErrMsg += Path;
189     return false;
190   }
191 
192   // write bitcode to it
193   WriteBitcodeToFile(MergedModule.get(), Out.os(), ShouldEmbedUselists);
194   Out.os().close();
195 
196   if (Out.os().has_error()) {
197     ErrMsg = "could not write bitcode file: ";
198     ErrMsg += Path;
199     Out.os().clear_error();
200     return false;
201   }
202 
203   Out.keep();
204   return true;
205 }
206 
207 bool LTOCodeGenerator::compileOptimizedToFile(const char **Name,
208                                               std::string &ErrMsg) {
209   // make unique temp .o file to put generated object file
210   SmallString<128> Filename;
211   int FD;
212   std::error_code EC =
213       sys::fs::createTemporaryFile("lto-llvm", "o", FD, Filename);
214   if (EC) {
215     ErrMsg = EC.message();
216     return false;
217   }
218 
219   // generate object file
220   tool_output_file objFile(Filename.c_str(), FD);
221 
222   bool genResult = compileOptimized(&objFile.os(), ErrMsg);
223   objFile.os().close();
224   if (objFile.os().has_error()) {
225     objFile.os().clear_error();
226     sys::fs::remove(Twine(Filename));
227     return false;
228   }
229 
230   objFile.keep();
231   if (!genResult) {
232     sys::fs::remove(Twine(Filename));
233     return false;
234   }
235 
236   NativeObjectPath = Filename.c_str();
237   *Name = NativeObjectPath.c_str();
238   return true;
239 }
240 
241 std::unique_ptr<MemoryBuffer>
242 LTOCodeGenerator::compileOptimized(std::string &ErrMsg) {
243   const char *name;
244   if (!compileOptimizedToFile(&name, ErrMsg))
245     return nullptr;
246 
247   // read .o file into memory buffer
248   ErrorOr<std::unique_ptr<MemoryBuffer>> BufferOrErr =
249       MemoryBuffer::getFile(name, -1, false);
250   if (std::error_code EC = BufferOrErr.getError()) {
251     ErrMsg = EC.message();
252     sys::fs::remove(NativeObjectPath);
253     return nullptr;
254   }
255 
256   // remove temp files
257   sys::fs::remove(NativeObjectPath);
258 
259   return std::move(*BufferOrErr);
260 }
261 
262 bool LTOCodeGenerator::compile_to_file(const char **Name, bool DisableVerify,
263                                        bool DisableInline,
264                                        bool DisableGVNLoadPRE,
265                                        bool DisableVectorization,
266                                        std::string &ErrMsg) {
267   if (!optimize(DisableVerify, DisableInline, DisableGVNLoadPRE,
268                 DisableVectorization, ErrMsg))
269     return false;
270 
271   return compileOptimizedToFile(Name, ErrMsg);
272 }
273 
274 std::unique_ptr<MemoryBuffer>
275 LTOCodeGenerator::compile(bool DisableVerify, bool DisableInline,
276                           bool DisableGVNLoadPRE, bool DisableVectorization,
277                           std::string &ErrMsg) {
278   if (!optimize(DisableVerify, DisableInline, DisableGVNLoadPRE,
279                 DisableVectorization, ErrMsg))
280     return nullptr;
281 
282   return compileOptimized(ErrMsg);
283 }
284 
285 bool LTOCodeGenerator::determineTarget(std::string &ErrMsg) {
286   if (TargetMach)
287     return true;
288 
289   std::string TripleStr = MergedModule->getTargetTriple();
290   if (TripleStr.empty()) {
291     TripleStr = sys::getDefaultTargetTriple();
292     MergedModule->setTargetTriple(TripleStr);
293   }
294   llvm::Triple Triple(TripleStr);
295 
296   // create target machine from info for merged modules
297   const Target *march = TargetRegistry::lookupTarget(TripleStr, ErrMsg);
298   if (!march)
299     return false;
300 
301   // Construct LTOModule, hand over ownership of module and target. Use MAttr as
302   // the default set of features.
303   SubtargetFeatures Features(MAttr);
304   Features.getDefaultSubtargetFeatures(Triple);
305   FeatureStr = Features.getString();
306   // Set a default CPU for Darwin triples.
307   if (MCpu.empty() && Triple.isOSDarwin()) {
308     if (Triple.getArch() == llvm::Triple::x86_64)
309       MCpu = "core2";
310     else if (Triple.getArch() == llvm::Triple::x86)
311       MCpu = "yonah";
312     else if (Triple.getArch() == llvm::Triple::aarch64)
313       MCpu = "cyclone";
314   }
315 
316   TargetMach.reset(march->createTargetMachine(TripleStr, MCpu, FeatureStr,
317                                               Options, RelocModel,
318                                               CodeModel::Default, CGOptLevel));
319   return true;
320 }
321 
322 void LTOCodeGenerator::
323 applyRestriction(GlobalValue &GV,
324                  ArrayRef<StringRef> Libcalls,
325                  std::vector<const char*> &MustPreserveList,
326                  SmallPtrSetImpl<GlobalValue*> &AsmUsed,
327                  Mangler &Mangler) {
328   // There are no restrictions to apply to declarations.
329   if (GV.isDeclaration())
330     return;
331 
332   // There is nothing more restrictive than private linkage.
333   if (GV.hasPrivateLinkage())
334     return;
335 
336   SmallString<64> Buffer;
337   TargetMach->getNameWithPrefix(Buffer, &GV, Mangler);
338 
339   if (MustPreserveSymbols.count(Buffer))
340     MustPreserveList.push_back(GV.getName().data());
341   if (AsmUndefinedRefs.count(Buffer))
342     AsmUsed.insert(&GV);
343 
344   // Conservatively append user-supplied runtime library functions to
345   // llvm.compiler.used.  These could be internalized and deleted by
346   // optimizations like -globalopt, causing problems when later optimizations
347   // add new library calls (e.g., llvm.memset => memset and printf => puts).
348   // Leave it to the linker to remove any dead code (e.g. with -dead_strip).
349   if (isa<Function>(GV) &&
350       std::binary_search(Libcalls.begin(), Libcalls.end(), GV.getName()))
351     AsmUsed.insert(&GV);
352 }
353 
354 static void findUsedValues(GlobalVariable *LLVMUsed,
355                            SmallPtrSetImpl<GlobalValue*> &UsedValues) {
356   if (!LLVMUsed) return;
357 
358   ConstantArray *Inits = cast<ConstantArray>(LLVMUsed->getInitializer());
359   for (unsigned i = 0, e = Inits->getNumOperands(); i != e; ++i)
360     if (GlobalValue *GV =
361         dyn_cast<GlobalValue>(Inits->getOperand(i)->stripPointerCasts()))
362       UsedValues.insert(GV);
363 }
364 
365 // Collect names of runtime library functions. User-defined functions with the
366 // same names are added to llvm.compiler.used to prevent them from being
367 // deleted by optimizations.
368 static void accumulateAndSortLibcalls(std::vector<StringRef> &Libcalls,
369                                       const TargetLibraryInfo& TLI,
370                                       const Module &Mod,
371                                       const TargetMachine &TM) {
372   // TargetLibraryInfo has info on C runtime library calls on the current
373   // target.
374   for (unsigned I = 0, E = static_cast<unsigned>(LibFunc::NumLibFuncs);
375        I != E; ++I) {
376     LibFunc::Func F = static_cast<LibFunc::Func>(I);
377     if (TLI.has(F))
378       Libcalls.push_back(TLI.getName(F));
379   }
380 
381   SmallPtrSet<const TargetLowering *, 1> TLSet;
382 
383   for (const Function &F : Mod) {
384     const TargetLowering *Lowering =
385         TM.getSubtargetImpl(F)->getTargetLowering();
386 
387     if (Lowering && TLSet.insert(Lowering).second)
388       // TargetLowering has info on library calls that CodeGen expects to be
389       // available, both from the C runtime and compiler-rt.
390       for (unsigned I = 0, E = static_cast<unsigned>(RTLIB::UNKNOWN_LIBCALL);
391            I != E; ++I)
392         if (const char *Name =
393                 Lowering->getLibcallName(static_cast<RTLIB::Libcall>(I)))
394           Libcalls.push_back(Name);
395   }
396 
397   array_pod_sort(Libcalls.begin(), Libcalls.end());
398   Libcalls.erase(std::unique(Libcalls.begin(), Libcalls.end()),
399                  Libcalls.end());
400 }
401 
402 void LTOCodeGenerator::applyScopeRestrictions() {
403   if (ScopeRestrictionsDone || !ShouldInternalize)
404     return;
405 
406   // Start off with a verification pass.
407   legacy::PassManager passes;
408   passes.add(createVerifierPass());
409 
410   // mark which symbols can not be internalized
411   Mangler Mangler;
412   std::vector<const char*> MustPreserveList;
413   SmallPtrSet<GlobalValue*, 8> AsmUsed;
414   std::vector<StringRef> Libcalls;
415   TargetLibraryInfoImpl TLII(Triple(TargetMach->getTargetTriple()));
416   TargetLibraryInfo TLI(TLII);
417 
418   accumulateAndSortLibcalls(Libcalls, TLI, *MergedModule, *TargetMach);
419 
420   for (Function &f : *MergedModule)
421     applyRestriction(f, Libcalls, MustPreserveList, AsmUsed, Mangler);
422   for (GlobalVariable &v : MergedModule->globals())
423     applyRestriction(v, Libcalls, MustPreserveList, AsmUsed, Mangler);
424   for (GlobalAlias &a : MergedModule->aliases())
425     applyRestriction(a, Libcalls, MustPreserveList, AsmUsed, Mangler);
426 
427   GlobalVariable *LLVMCompilerUsed =
428     MergedModule->getGlobalVariable("llvm.compiler.used");
429   findUsedValues(LLVMCompilerUsed, AsmUsed);
430   if (LLVMCompilerUsed)
431     LLVMCompilerUsed->eraseFromParent();
432 
433   if (!AsmUsed.empty()) {
434     llvm::Type *i8PTy = llvm::Type::getInt8PtrTy(Context);
435     std::vector<Constant*> asmUsed2;
436     for (auto *GV : AsmUsed) {
437       Constant *c = ConstantExpr::getBitCast(GV, i8PTy);
438       asmUsed2.push_back(c);
439     }
440 
441     llvm::ArrayType *ATy = llvm::ArrayType::get(i8PTy, asmUsed2.size());
442     LLVMCompilerUsed =
443       new llvm::GlobalVariable(*MergedModule, ATy, false,
444                                llvm::GlobalValue::AppendingLinkage,
445                                llvm::ConstantArray::get(ATy, asmUsed2),
446                                "llvm.compiler.used");
447 
448     LLVMCompilerUsed->setSection("llvm.metadata");
449   }
450 
451   passes.add(createInternalizePass(MustPreserveList));
452 
453   // apply scope restrictions
454   passes.run(*MergedModule);
455 
456   ScopeRestrictionsDone = true;
457 }
458 
459 /// Optimize merged modules using various IPO passes
460 bool LTOCodeGenerator::optimize(bool DisableVerify, bool DisableInline,
461                                 bool DisableGVNLoadPRE,
462                                 bool DisableVectorization,
463                                 std::string &ErrMsg) {
464   if (!this->determineTarget(ErrMsg))
465     return false;
466 
467   // Mark which symbols can not be internalized
468   this->applyScopeRestrictions();
469 
470   // Instantiate the pass manager to organize the passes.
471   legacy::PassManager passes;
472 
473   // Add an appropriate DataLayout instance for this module...
474   MergedModule->setDataLayout(TargetMach->createDataLayout());
475 
476   passes.add(
477       createTargetTransformInfoWrapperPass(TargetMach->getTargetIRAnalysis()));
478 
479   Triple TargetTriple(TargetMach->getTargetTriple());
480   PassManagerBuilder PMB;
481   PMB.DisableGVNLoadPRE = DisableGVNLoadPRE;
482   PMB.LoopVectorize = !DisableVectorization;
483   PMB.SLPVectorize = !DisableVectorization;
484   if (!DisableInline)
485     PMB.Inliner = createFunctionInliningPass();
486   PMB.LibraryInfo = new TargetLibraryInfoImpl(TargetTriple);
487   PMB.OptLevel = OptLevel;
488   PMB.VerifyInput = !DisableVerify;
489   PMB.VerifyOutput = !DisableVerify;
490 
491   PMB.populateLTOPassManager(passes);
492 
493   // Run our queue of passes all at once now, efficiently.
494   passes.run(*MergedModule);
495 
496   return true;
497 }
498 
499 bool LTOCodeGenerator::compileOptimized(ArrayRef<raw_pwrite_stream *> Out,
500                                         std::string &ErrMsg) {
501   if (!this->determineTarget(ErrMsg))
502     return false;
503 
504   legacy::PassManager preCodeGenPasses;
505 
506   // If the bitcode files contain ARC code and were compiled with optimization,
507   // the ObjCARCContractPass must be run, so do it unconditionally here.
508   preCodeGenPasses.add(createObjCARCContractPass());
509   preCodeGenPasses.run(*MergedModule);
510 
511   // Do code generation. We need to preserve the module in case the client calls
512   // writeMergedModules() after compilation, but we only need to allow this at
513   // parallelism level 1. This is achieved by having splitCodeGen return the
514   // original module at parallelism level 1 which we then assign back to
515   // MergedModule.
516   MergedModule =
517       splitCodeGen(std::move(MergedModule), Out, MCpu, FeatureStr, Options,
518                    RelocModel, CodeModel::Default, CGOptLevel);
519 
520   return true;
521 }
522 
523 /// setCodeGenDebugOptions - Set codegen debugging options to aid in debugging
524 /// LTO problems.
525 void LTOCodeGenerator::setCodeGenDebugOptions(const char *Options) {
526   for (std::pair<StringRef, StringRef> o = getToken(Options); !o.first.empty();
527        o = getToken(o.second))
528     CodegenOptions.push_back(o.first);
529 }
530 
531 void LTOCodeGenerator::parseCodeGenDebugOptions() {
532   // if options were requested, set them
533   if (!CodegenOptions.empty()) {
534     // ParseCommandLineOptions() expects argv[0] to be program name.
535     std::vector<const char *> CodegenArgv(1, "libLLVMLTO");
536     for (std::string &Arg : CodegenOptions)
537       CodegenArgv.push_back(Arg.c_str());
538     cl::ParseCommandLineOptions(CodegenArgv.size(), CodegenArgv.data());
539   }
540 }
541 
542 void LTOCodeGenerator::DiagnosticHandler(const DiagnosticInfo &DI,
543                                          void *Context) {
544   ((LTOCodeGenerator *)Context)->DiagnosticHandler2(DI);
545 }
546 
547 void LTOCodeGenerator::DiagnosticHandler2(const DiagnosticInfo &DI) {
548   // Map the LLVM internal diagnostic severity to the LTO diagnostic severity.
549   lto_codegen_diagnostic_severity_t Severity;
550   switch (DI.getSeverity()) {
551   case DS_Error:
552     Severity = LTO_DS_ERROR;
553     break;
554   case DS_Warning:
555     Severity = LTO_DS_WARNING;
556     break;
557   case DS_Remark:
558     Severity = LTO_DS_REMARK;
559     break;
560   case DS_Note:
561     Severity = LTO_DS_NOTE;
562     break;
563   }
564   // Create the string that will be reported to the external diagnostic handler.
565   std::string MsgStorage;
566   raw_string_ostream Stream(MsgStorage);
567   DiagnosticPrinterRawOStream DP(Stream);
568   DI.print(DP);
569   Stream.flush();
570 
571   // If this method has been called it means someone has set up an external
572   // diagnostic handler. Assert on that.
573   assert(DiagHandler && "Invalid diagnostic handler");
574   (*DiagHandler)(Severity, MsgStorage.c_str(), DiagContext);
575 }
576 
577 void
578 LTOCodeGenerator::setDiagnosticHandler(lto_diagnostic_handler_t DiagHandler,
579                                        void *Ctxt) {
580   this->DiagHandler = DiagHandler;
581   this->DiagContext = Ctxt;
582   if (!DiagHandler)
583     return Context.setDiagnosticHandler(nullptr, nullptr);
584   // Register the LTOCodeGenerator stub in the LLVMContext to forward the
585   // diagnostic to the external DiagHandler.
586   Context.setDiagnosticHandler(LTOCodeGenerator::DiagnosticHandler, this,
587                                /* RespectFilters */ true);
588 }
589