xref: /llvm-project-15.0.7/lld/COFF/LTO.cpp (revision ad38fbff)
1 //===- LTO.cpp ------------------------------------------------------------===//
2 //
3 //                             The LLVM Linker
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 
10 #include "LTO.h"
11 #include "Config.h"
12 #include "Error.h"
13 #include "InputFiles.h"
14 #include "Symbols.h"
15 #include "lld/Common/TargetOptionsCommandFlags.h"
16 #include "llvm/ADT/STLExtras.h"
17 #include "llvm/ADT/SmallString.h"
18 #include "llvm/ADT/StringRef.h"
19 #include "llvm/ADT/Twine.h"
20 #include "llvm/IR/DiagnosticPrinter.h"
21 #include "llvm/LTO/Caching.h"
22 #include "llvm/LTO/Config.h"
23 #include "llvm/LTO/LTO.h"
24 #include "llvm/Object/SymbolicFile.h"
25 #include "llvm/Support/CodeGen.h"
26 #include "llvm/Support/Error.h"
27 #include "llvm/Support/FileSystem.h"
28 #include "llvm/Support/MemoryBuffer.h"
29 #include "llvm/Support/raw_ostream.h"
30 #include <algorithm>
31 #include <cstddef>
32 #include <memory>
33 #include <string>
34 #include <system_error>
35 #include <vector>
36 
37 using namespace llvm;
38 using namespace llvm::object;
39 
40 using namespace lld;
41 using namespace lld::coff;
42 
43 static void diagnosticHandler(const DiagnosticInfo &DI) {
44   SmallString<128> ErrStorage;
45   raw_svector_ostream OS(ErrStorage);
46   DiagnosticPrinterRawOStream DP(OS);
47   DI.print(DP);
48   warn(ErrStorage);
49 }
50 
51 static void checkError(Error E) {
52   handleAllErrors(std::move(E),
53                   [&](ErrorInfoBase &EIB) { error(EIB.message()); });
54 }
55 
56 static void saveBuffer(StringRef Buffer, const Twine &Path) {
57   std::error_code EC;
58   raw_fd_ostream OS(Path.str(), EC, sys::fs::OpenFlags::F_None);
59   if (EC)
60     error("cannot create " + Path + ": " + EC.message());
61   OS << Buffer;
62 }
63 
64 static std::unique_ptr<lto::LTO> createLTO() {
65   lto::Config Conf;
66   Conf.Options = InitTargetOptionsFromCodeGenFlags();
67   // Use static reloc model on 32-bit x86 because it usually results in more
68   // compact code, and because there are also known code generation bugs when
69   // using the PIC model (see PR34306).
70   if (Config->Machine == COFF::IMAGE_FILE_MACHINE_I386)
71     Conf.RelocModel = Reloc::Static;
72   else
73     Conf.RelocModel = Reloc::PIC_;
74   Conf.DisableVerify = true;
75   Conf.DiagHandler = diagnosticHandler;
76   Conf.OptLevel = Config->LTOOptLevel;
77   if (Config->SaveTemps)
78     checkError(Conf.addSaveTemps(std::string(Config->OutputFile) + ".",
79                                  /*UseInputModulePath*/ true));
80   lto::ThinBackend Backend;
81   if (Config->LTOJobs != 0)
82     Backend = lto::createInProcessThinBackend(Config->LTOJobs);
83   return llvm::make_unique<lto::LTO>(std::move(Conf), Backend,
84                                      Config->LTOPartitions);
85 }
86 
87 BitcodeCompiler::BitcodeCompiler() : LTOObj(createLTO()) {}
88 
89 BitcodeCompiler::~BitcodeCompiler() = default;
90 
91 static void undefine(Symbol *S) {
92   replaceBody<Undefined>(S, S->body()->getName());
93 }
94 
95 void BitcodeCompiler::add(BitcodeFile &F) {
96   lto::InputFile &Obj = *F.Obj;
97   unsigned SymNum = 0;
98   std::vector<SymbolBody *> SymBodies = F.getSymbols();
99   std::vector<lto::SymbolResolution> Resols(SymBodies.size());
100 
101   // Provide a resolution to the LTO API for each symbol.
102   for (const lto::InputFile::Symbol &ObjSym : Obj.symbols()) {
103     SymbolBody *B = SymBodies[SymNum];
104     Symbol *Sym = B->symbol();
105     lto::SymbolResolution &R = Resols[SymNum];
106     ++SymNum;
107 
108     // Ideally we shouldn't check for SF_Undefined but currently IRObjectFile
109     // reports two symbols for module ASM defined. Without this check, lld
110     // flags an undefined in IR with a definition in ASM as prevailing.
111     // Once IRObjectFile is fixed to report only one symbol this hack can
112     // be removed.
113     R.Prevailing = !ObjSym.isUndefined() && B->getFile() == &F;
114     R.VisibleToRegularObj = Sym->IsUsedInRegularObj;
115     if (R.Prevailing)
116       undefine(Sym);
117   }
118   checkError(LTOObj->add(std::move(F.Obj), Resols));
119 }
120 
121 // Merge all the bitcode files we have seen, codegen the result
122 // and return the resulting objects.
123 std::vector<StringRef> BitcodeCompiler::compile() {
124   unsigned MaxTasks = LTOObj->getMaxTasks();
125   Buff.resize(MaxTasks);
126   Files.resize(MaxTasks);
127 
128   // The /lldltocache option specifies the path to a directory in which to cache
129   // native object files for ThinLTO incremental builds. If a path was
130   // specified, configure LTO to use it as the cache directory.
131   lto::NativeObjectCache Cache;
132   if (!Config->LTOCache.empty())
133     Cache = check(
134         lto::localCache(Config->LTOCache,
135                         [&](size_t Task, std::unique_ptr<MemoryBuffer> MB,
136                             StringRef Path) { Files[Task] = std::move(MB); }));
137 
138   checkError(LTOObj->run(
139       [&](size_t Task) {
140         return llvm::make_unique<lto::NativeObjectStream>(
141             llvm::make_unique<raw_svector_ostream>(Buff[Task]));
142       },
143       Cache));
144 
145   if (!Config->LTOCache.empty())
146     pruneCache(Config->LTOCache, Config->LTOCachePolicy);
147 
148   std::vector<StringRef> Ret;
149   for (unsigned I = 0; I != MaxTasks; ++I) {
150     if (Buff[I].empty())
151       continue;
152     if (Config->SaveTemps) {
153       if (I == 0)
154         saveBuffer(Buff[I], Config->OutputFile + ".lto.obj");
155       else
156         saveBuffer(Buff[I], Config->OutputFile + Twine(I) + ".lto.obj");
157     }
158     Ret.emplace_back(Buff[I].data(), Buff[I].size());
159   }
160 
161   for (std::unique_ptr<MemoryBuffer> &File : Files)
162     if (File)
163       Ret.push_back(File->getBuffer());
164 
165   return Ret;
166 }
167