xref: /freebsd/contrib/llvm-project/llvm/lib/Transforms/IPO/ThinLTOBitcodeWriter.cpp (revision e64bea71c21eb42e97aa615188ba91f6cce0d36d)
1 //===- ThinLTOBitcodeWriter.cpp - Bitcode writing pass for ThinLTO --------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 
9 #include "llvm/Transforms/IPO/ThinLTOBitcodeWriter.h"
10 #include "llvm/Analysis/BasicAliasAnalysis.h"
11 #include "llvm/Analysis/ModuleSummaryAnalysis.h"
12 #include "llvm/Analysis/ProfileSummaryInfo.h"
13 #include "llvm/Analysis/TypeMetadataUtils.h"
14 #include "llvm/Bitcode/BitcodeWriter.h"
15 #include "llvm/IR/Constants.h"
16 #include "llvm/IR/DebugInfo.h"
17 #include "llvm/IR/Instructions.h"
18 #include "llvm/IR/Intrinsics.h"
19 #include "llvm/IR/Module.h"
20 #include "llvm/IR/PassManager.h"
21 #include "llvm/Object/ModuleSymbolTable.h"
22 #include "llvm/Support/raw_ostream.h"
23 #include "llvm/Transforms/IPO.h"
24 #include "llvm/Transforms/IPO/FunctionAttrs.h"
25 #include "llvm/Transforms/IPO/FunctionImport.h"
26 #include "llvm/Transforms/IPO/LowerTypeTests.h"
27 #include "llvm/Transforms/Utils/Cloning.h"
28 #include "llvm/Transforms/Utils/ModuleUtils.h"
29 using namespace llvm;
30 
31 namespace {
32 
33 // Determine if a promotion alias should be created for a symbol name.
allowPromotionAlias(const std::string & Name)34 static bool allowPromotionAlias(const std::string &Name) {
35   // Promotion aliases are used only in inline assembly. It's safe to
36   // simply skip unusual names. Subset of MCAsmInfo::isAcceptableChar()
37   // and MCAsmInfoXCOFF::isAcceptableChar().
38   for (const char &C : Name) {
39     if (isAlnum(C) || C == '_' || C == '.')
40       continue;
41     return false;
42   }
43   return true;
44 }
45 
46 // Promote each local-linkage entity defined by ExportM and used by ImportM by
47 // changing visibility and appending the given ModuleId.
promoteInternals(Module & ExportM,Module & ImportM,StringRef ModuleId,SetVector<GlobalValue * > & PromoteExtra)48 void promoteInternals(Module &ExportM, Module &ImportM, StringRef ModuleId,
49                       SetVector<GlobalValue *> &PromoteExtra) {
50   DenseMap<const Comdat *, Comdat *> RenamedComdats;
51   for (auto &ExportGV : ExportM.global_values()) {
52     if (!ExportGV.hasLocalLinkage())
53       continue;
54 
55     auto Name = ExportGV.getName();
56     GlobalValue *ImportGV = nullptr;
57     if (!PromoteExtra.count(&ExportGV)) {
58       ImportGV = ImportM.getNamedValue(Name);
59       if (!ImportGV)
60         continue;
61       ImportGV->removeDeadConstantUsers();
62       if (ImportGV->use_empty()) {
63         ImportGV->eraseFromParent();
64         continue;
65       }
66     }
67 
68     std::string OldName = Name.str();
69     std::string NewName = (Name + ModuleId).str();
70 
71     if (const auto *C = ExportGV.getComdat())
72       if (C->getName() == Name)
73         RenamedComdats.try_emplace(C, ExportM.getOrInsertComdat(NewName));
74 
75     ExportGV.setName(NewName);
76     ExportGV.setLinkage(GlobalValue::ExternalLinkage);
77     ExportGV.setVisibility(GlobalValue::HiddenVisibility);
78 
79     if (ImportGV) {
80       ImportGV->setName(NewName);
81       ImportGV->setVisibility(GlobalValue::HiddenVisibility);
82     }
83 
84     if (isa<Function>(&ExportGV) && allowPromotionAlias(OldName)) {
85       // Create a local alias with the original name to avoid breaking
86       // references from inline assembly.
87       std::string Alias =
88           ".lto_set_conditional " + OldName + "," + NewName + "\n";
89       ExportM.appendModuleInlineAsm(Alias);
90     }
91   }
92 
93   if (!RenamedComdats.empty())
94     for (auto &GO : ExportM.global_objects())
95       if (auto *C = GO.getComdat()) {
96         auto Replacement = RenamedComdats.find(C);
97         if (Replacement != RenamedComdats.end())
98           GO.setComdat(Replacement->second);
99       }
100 }
101 
102 // Promote all internal (i.e. distinct) type ids used by the module by replacing
103 // them with external type ids formed using the module id.
104 //
105 // Note that this needs to be done before we clone the module because each clone
106 // will receive its own set of distinct metadata nodes.
promoteTypeIds(Module & M,StringRef ModuleId)107 void promoteTypeIds(Module &M, StringRef ModuleId) {
108   DenseMap<Metadata *, Metadata *> LocalToGlobal;
109   auto ExternalizeTypeId = [&](CallInst *CI, unsigned ArgNo) {
110     Metadata *MD =
111         cast<MetadataAsValue>(CI->getArgOperand(ArgNo))->getMetadata();
112 
113     if (isa<MDNode>(MD) && cast<MDNode>(MD)->isDistinct()) {
114       Metadata *&GlobalMD = LocalToGlobal[MD];
115       if (!GlobalMD) {
116         std::string NewName = (Twine(LocalToGlobal.size()) + ModuleId).str();
117         GlobalMD = MDString::get(M.getContext(), NewName);
118       }
119 
120       CI->setArgOperand(ArgNo,
121                         MetadataAsValue::get(M.getContext(), GlobalMD));
122     }
123   };
124 
125   if (Function *TypeTestFunc =
126           Intrinsic::getDeclarationIfExists(&M, Intrinsic::type_test)) {
127     for (const Use &U : TypeTestFunc->uses()) {
128       auto CI = cast<CallInst>(U.getUser());
129       ExternalizeTypeId(CI, 1);
130     }
131   }
132 
133   if (Function *PublicTypeTestFunc =
134           Intrinsic::getDeclarationIfExists(&M, Intrinsic::public_type_test)) {
135     for (const Use &U : PublicTypeTestFunc->uses()) {
136       auto CI = cast<CallInst>(U.getUser());
137       ExternalizeTypeId(CI, 1);
138     }
139   }
140 
141   if (Function *TypeCheckedLoadFunc =
142           Intrinsic::getDeclarationIfExists(&M, Intrinsic::type_checked_load)) {
143     for (const Use &U : TypeCheckedLoadFunc->uses()) {
144       auto CI = cast<CallInst>(U.getUser());
145       ExternalizeTypeId(CI, 2);
146     }
147   }
148 
149   if (Function *TypeCheckedLoadRelativeFunc = Intrinsic::getDeclarationIfExists(
150           &M, Intrinsic::type_checked_load_relative)) {
151     for (const Use &U : TypeCheckedLoadRelativeFunc->uses()) {
152       auto CI = cast<CallInst>(U.getUser());
153       ExternalizeTypeId(CI, 2);
154     }
155   }
156 
157   for (GlobalObject &GO : M.global_objects()) {
158     SmallVector<MDNode *, 1> MDs;
159     GO.getMetadata(LLVMContext::MD_type, MDs);
160 
161     GO.eraseMetadata(LLVMContext::MD_type);
162     for (auto *MD : MDs) {
163       auto I = LocalToGlobal.find(MD->getOperand(1));
164       if (I == LocalToGlobal.end()) {
165         GO.addMetadata(LLVMContext::MD_type, *MD);
166         continue;
167       }
168       GO.addMetadata(
169           LLVMContext::MD_type,
170           *MDNode::get(M.getContext(), {MD->getOperand(0), I->second}));
171     }
172   }
173 }
174 
175 // Drop unused globals, and drop type information from function declarations.
176 // FIXME: If we made functions typeless then there would be no need to do this.
simplifyExternals(Module & M)177 void simplifyExternals(Module &M) {
178   FunctionType *EmptyFT =
179       FunctionType::get(Type::getVoidTy(M.getContext()), false);
180 
181   for (Function &F : llvm::make_early_inc_range(M)) {
182     if (F.isDeclaration() && F.use_empty()) {
183       F.eraseFromParent();
184       continue;
185     }
186 
187     if (!F.isDeclaration() || F.getFunctionType() == EmptyFT ||
188         // Changing the type of an intrinsic may invalidate the IR.
189         F.getName().starts_with("llvm."))
190       continue;
191 
192     Function *NewF =
193         Function::Create(EmptyFT, GlobalValue::ExternalLinkage,
194                          F.getAddressSpace(), "", &M);
195     NewF->copyAttributesFrom(&F);
196     // Only copy function attribtues.
197     NewF->setAttributes(AttributeList::get(M.getContext(),
198                                            AttributeList::FunctionIndex,
199                                            F.getAttributes().getFnAttrs()));
200     NewF->takeName(&F);
201     F.replaceAllUsesWith(NewF);
202     F.eraseFromParent();
203   }
204 
205   for (GlobalIFunc &I : llvm::make_early_inc_range(M.ifuncs())) {
206     if (I.use_empty())
207       I.eraseFromParent();
208     else
209       assert(I.getResolverFunction() && "ifunc misses its resolver function");
210   }
211 
212   for (GlobalVariable &GV : llvm::make_early_inc_range(M.globals())) {
213     if (GV.isDeclaration() && GV.use_empty()) {
214       GV.eraseFromParent();
215       continue;
216     }
217   }
218 }
219 
220 static void
filterModule(Module * M,function_ref<bool (const GlobalValue *)> ShouldKeepDefinition)221 filterModule(Module *M,
222              function_ref<bool(const GlobalValue *)> ShouldKeepDefinition) {
223   std::vector<GlobalValue *> V;
224   for (GlobalValue &GV : M->global_values())
225     if (!ShouldKeepDefinition(&GV))
226       V.push_back(&GV);
227 
228   for (GlobalValue *GV : V)
229     if (!convertToDeclaration(*GV))
230       GV->eraseFromParent();
231 }
232 
forEachVirtualFunction(Constant * C,function_ref<void (Function *)> Fn)233 void forEachVirtualFunction(Constant *C, function_ref<void(Function *)> Fn) {
234   if (auto *F = dyn_cast<Function>(C))
235     return Fn(F);
236   if (isa<GlobalValue>(C))
237     return;
238   for (Value *Op : C->operands())
239     forEachVirtualFunction(cast<Constant>(Op), Fn);
240 }
241 
242 // Clone any @llvm[.compiler].used over to the new module and append
243 // values whose defs were cloned into that module.
cloneUsedGlobalVariables(const Module & SrcM,Module & DestM,bool CompilerUsed)244 static void cloneUsedGlobalVariables(const Module &SrcM, Module &DestM,
245                                      bool CompilerUsed) {
246   SmallVector<GlobalValue *, 4> Used, NewUsed;
247   // First collect those in the llvm[.compiler].used set.
248   collectUsedGlobalVariables(SrcM, Used, CompilerUsed);
249   // Next build a set of the equivalent values defined in DestM.
250   for (auto *V : Used) {
251     auto *GV = DestM.getNamedValue(V->getName());
252     if (GV && !GV->isDeclaration())
253       NewUsed.push_back(GV);
254   }
255   // Finally, add them to a llvm[.compiler].used variable in DestM.
256   if (CompilerUsed)
257     appendToCompilerUsed(DestM, NewUsed);
258   else
259     appendToUsed(DestM, NewUsed);
260 }
261 
262 #ifndef NDEBUG
enableUnifiedLTO(Module & M)263 static bool enableUnifiedLTO(Module &M) {
264   bool UnifiedLTO = false;
265   if (auto *MD =
266           mdconst::extract_or_null<ConstantInt>(M.getModuleFlag("UnifiedLTO")))
267     UnifiedLTO = MD->getZExtValue();
268   return UnifiedLTO;
269 }
270 #endif
271 
272 // If it's possible to split M into regular and thin LTO parts, do so and write
273 // a multi-module bitcode file with the two parts to OS. Otherwise, write only a
274 // regular LTO bitcode file to OS.
splitAndWriteThinLTOBitcode(raw_ostream & OS,raw_ostream * ThinLinkOS,function_ref<AAResults & (Function &)> AARGetter,Module & M,const bool ShouldPreserveUseListOrder)275 void splitAndWriteThinLTOBitcode(
276     raw_ostream &OS, raw_ostream *ThinLinkOS,
277     function_ref<AAResults &(Function &)> AARGetter, Module &M,
278     const bool ShouldPreserveUseListOrder) {
279   std::string ModuleId = getUniqueModuleId(&M);
280   if (ModuleId.empty()) {
281     assert(!enableUnifiedLTO(M));
282     // We couldn't generate a module ID for this module, write it out as a
283     // regular LTO module with an index for summary-based dead stripping.
284     ProfileSummaryInfo PSI(M);
285     M.addModuleFlag(Module::Error, "ThinLTO", uint32_t(0));
286     ModuleSummaryIndex Index = buildModuleSummaryIndex(M, nullptr, &PSI);
287     WriteBitcodeToFile(M, OS, ShouldPreserveUseListOrder, &Index,
288                        /*UnifiedLTO=*/false);
289 
290     if (ThinLinkOS)
291       // We don't have a ThinLTO part, but still write the module to the
292       // ThinLinkOS if requested so that the expected output file is produced.
293       WriteBitcodeToFile(M, *ThinLinkOS, ShouldPreserveUseListOrder, &Index,
294                          /*UnifiedLTO=*/false);
295 
296     return;
297   }
298 
299   promoteTypeIds(M, ModuleId);
300 
301   // Returns whether a global or its associated global has attached type
302   // metadata. The former may participate in CFI or whole-program
303   // devirtualization, so they need to appear in the merged module instead of
304   // the thin LTO module. Similarly, globals that are associated with globals
305   // with type metadata need to appear in the merged module because they will
306   // reference the global's section directly.
307   auto HasTypeMetadata = [](const GlobalObject *GO) {
308     if (MDNode *MD = GO->getMetadata(LLVMContext::MD_associated))
309       if (auto *AssocVM = dyn_cast_or_null<ValueAsMetadata>(MD->getOperand(0)))
310         if (auto *AssocGO = dyn_cast<GlobalObject>(AssocVM->getValue()))
311           if (AssocGO->hasMetadata(LLVMContext::MD_type))
312             return true;
313     return GO->hasMetadata(LLVMContext::MD_type);
314   };
315 
316   // Collect the set of virtual functions that are eligible for virtual constant
317   // propagation. Each eligible function must not access memory, must return
318   // an integer of width <=64 bits, must take at least one argument, must not
319   // use its first argument (assumed to be "this") and all arguments other than
320   // the first one must be of <=64 bit integer type.
321   //
322   // Note that we test whether this copy of the function is readnone, rather
323   // than testing function attributes, which must hold for any copy of the
324   // function, even a less optimized version substituted at link time. This is
325   // sound because the virtual constant propagation optimizations effectively
326   // inline all implementations of the virtual function into each call site,
327   // rather than using function attributes to perform local optimization.
328   DenseSet<const Function *> EligibleVirtualFns;
329   // If any member of a comdat lives in MergedM, put all members of that
330   // comdat in MergedM to keep the comdat together.
331   DenseSet<const Comdat *> MergedMComdats;
332   for (GlobalVariable &GV : M.globals())
333     if (!GV.isDeclaration() && HasTypeMetadata(&GV)) {
334       if (const auto *C = GV.getComdat())
335         MergedMComdats.insert(C);
336       forEachVirtualFunction(GV.getInitializer(), [&](Function *F) {
337         auto *RT = dyn_cast<IntegerType>(F->getReturnType());
338         if (!RT || RT->getBitWidth() > 64 || F->arg_empty() ||
339             !F->arg_begin()->use_empty())
340           return;
341         for (auto &Arg : drop_begin(F->args())) {
342           auto *ArgT = dyn_cast<IntegerType>(Arg.getType());
343           if (!ArgT || ArgT->getBitWidth() > 64)
344             return;
345         }
346         if (!F->isDeclaration() &&
347             computeFunctionBodyMemoryAccess(*F, AARGetter(*F))
348                 .doesNotAccessMemory())
349           EligibleVirtualFns.insert(F);
350       });
351     }
352 
353   auto MustEmitToMergedModule = [](const GlobalValue *GV) {
354     // The __cfi_check definition is filled in by the CrossDSOCFI pass which
355     // runs only in the merged module.
356     return GV->getName() == "__cfi_check";
357   };
358 
359   ValueToValueMapTy VMap;
360   std::unique_ptr<Module> MergedM(
361       CloneModule(M, VMap, [&](const GlobalValue *GV) -> bool {
362         if (const auto *C = GV->getComdat())
363           if (MergedMComdats.count(C))
364             return true;
365         if (MustEmitToMergedModule(GV))
366           return true;
367         if (auto *F = dyn_cast<Function>(GV))
368           return EligibleVirtualFns.count(F);
369         if (auto *GVar =
370                 dyn_cast_or_null<GlobalVariable>(GV->getAliaseeObject()))
371           return HasTypeMetadata(GVar);
372         return false;
373       }));
374   StripDebugInfo(*MergedM);
375   MergedM->setModuleInlineAsm("");
376 
377   // Clone any llvm.*used globals to ensure the included values are
378   // not deleted.
379   cloneUsedGlobalVariables(M, *MergedM, /*CompilerUsed*/ false);
380   cloneUsedGlobalVariables(M, *MergedM, /*CompilerUsed*/ true);
381 
382   for (Function &F : *MergedM)
383     if (!F.isDeclaration() && !MustEmitToMergedModule(&F)) {
384       // Reset the linkage of all functions eligible for virtual constant
385       // propagation. The canonical definitions live in the thin LTO module so
386       // that they can be imported.
387       F.setLinkage(GlobalValue::AvailableExternallyLinkage);
388       F.setComdat(nullptr);
389     }
390 
391   SetVector<GlobalValue *> CfiFunctions;
392   for (auto &F : M)
393     if ((!F.hasLocalLinkage() || F.hasAddressTaken()) && HasTypeMetadata(&F))
394       CfiFunctions.insert(&F);
395 
396   // Remove all globals with type metadata, globals with comdats that live in
397   // MergedM, and aliases pointing to such globals from the thin LTO module.
398   filterModule(&M, [&](const GlobalValue *GV) {
399     if (auto *GVar = dyn_cast_or_null<GlobalVariable>(GV->getAliaseeObject()))
400       if (HasTypeMetadata(GVar))
401         return false;
402     if (const auto *C = GV->getComdat())
403       if (MergedMComdats.count(C))
404         return false;
405     if (MustEmitToMergedModule(GV))
406       return false;
407     return true;
408   });
409 
410   promoteInternals(*MergedM, M, ModuleId, CfiFunctions);
411   promoteInternals(M, *MergedM, ModuleId, CfiFunctions);
412 
413   auto &Ctx = MergedM->getContext();
414   SmallVector<MDNode *, 8> CfiFunctionMDs;
415   for (auto *V : CfiFunctions) {
416     Function &F = *cast<Function>(V);
417     SmallVector<MDNode *, 2> Types;
418     F.getMetadata(LLVMContext::MD_type, Types);
419 
420     SmallVector<Metadata *, 4> Elts;
421     Elts.push_back(MDString::get(Ctx, F.getName()));
422     CfiFunctionLinkage Linkage;
423     if (lowertypetests::isJumpTableCanonical(&F))
424       Linkage = CFL_Definition;
425     else if (F.hasExternalWeakLinkage())
426       Linkage = CFL_WeakDeclaration;
427     else
428       Linkage = CFL_Declaration;
429     Elts.push_back(ConstantAsMetadata::get(
430         llvm::ConstantInt::get(Type::getInt8Ty(Ctx), Linkage)));
431     append_range(Elts, Types);
432     CfiFunctionMDs.push_back(MDTuple::get(Ctx, Elts));
433   }
434 
435   if(!CfiFunctionMDs.empty()) {
436     NamedMDNode *NMD = MergedM->getOrInsertNamedMetadata("cfi.functions");
437     for (auto *MD : CfiFunctionMDs)
438       NMD->addOperand(MD);
439   }
440 
441   SmallVector<MDNode *, 8> FunctionAliases;
442   for (auto &A : M.aliases()) {
443     if (!isa<Function>(A.getAliasee()))
444       continue;
445 
446     auto *F = cast<Function>(A.getAliasee());
447 
448     Metadata *Elts[] = {
449         MDString::get(Ctx, A.getName()),
450         MDString::get(Ctx, F->getName()),
451         ConstantAsMetadata::get(
452             ConstantInt::get(Type::getInt8Ty(Ctx), A.getVisibility())),
453         ConstantAsMetadata::get(
454             ConstantInt::get(Type::getInt8Ty(Ctx), A.isWeakForLinker())),
455     };
456 
457     FunctionAliases.push_back(MDTuple::get(Ctx, Elts));
458   }
459 
460   if (!FunctionAliases.empty()) {
461     NamedMDNode *NMD = MergedM->getOrInsertNamedMetadata("aliases");
462     for (auto *MD : FunctionAliases)
463       NMD->addOperand(MD);
464   }
465 
466   SmallVector<MDNode *, 8> Symvers;
467   ModuleSymbolTable::CollectAsmSymvers(M, [&](StringRef Name, StringRef Alias) {
468     Function *F = M.getFunction(Name);
469     if (!F || F->use_empty())
470       return;
471 
472     Symvers.push_back(MDTuple::get(
473         Ctx, {MDString::get(Ctx, Name), MDString::get(Ctx, Alias)}));
474   });
475 
476   if (!Symvers.empty()) {
477     NamedMDNode *NMD = MergedM->getOrInsertNamedMetadata("symvers");
478     for (auto *MD : Symvers)
479       NMD->addOperand(MD);
480   }
481 
482   simplifyExternals(*MergedM);
483 
484   // FIXME: Try to re-use BSI and PFI from the original module here.
485   ProfileSummaryInfo PSI(M);
486   ModuleSummaryIndex Index = buildModuleSummaryIndex(M, nullptr, &PSI);
487 
488   // Mark the merged module as requiring full LTO. We still want an index for
489   // it though, so that it can participate in summary-based dead stripping.
490   MergedM->addModuleFlag(Module::Error, "ThinLTO", uint32_t(0));
491   ModuleSummaryIndex MergedMIndex =
492       buildModuleSummaryIndex(*MergedM, nullptr, &PSI);
493 
494   SmallVector<char, 0> Buffer;
495 
496   BitcodeWriter W(Buffer);
497   // Save the module hash produced for the full bitcode, which will
498   // be used in the backends, and use that in the minimized bitcode
499   // produced for the full link.
500   ModuleHash ModHash = {{0}};
501   W.writeModule(M, ShouldPreserveUseListOrder, &Index,
502                 /*GenerateHash=*/true, &ModHash);
503   W.writeModule(*MergedM, ShouldPreserveUseListOrder, &MergedMIndex);
504   W.writeSymtab();
505   W.writeStrtab();
506   OS << Buffer;
507 
508   // If a minimized bitcode module was requested for the thin link, only
509   // the information that is needed by thin link will be written in the
510   // given OS (the merged module will be written as usual).
511   if (ThinLinkOS) {
512     Buffer.clear();
513     BitcodeWriter W2(Buffer);
514     StripDebugInfo(M);
515     W2.writeThinLinkBitcode(M, Index, ModHash);
516     W2.writeModule(*MergedM, /*ShouldPreserveUseListOrder=*/false,
517                    &MergedMIndex);
518     W2.writeSymtab();
519     W2.writeStrtab();
520     *ThinLinkOS << Buffer;
521   }
522 }
523 
524 // Check if the LTO Unit splitting has been enabled.
enableSplitLTOUnit(Module & M)525 bool enableSplitLTOUnit(Module &M) {
526   bool EnableSplitLTOUnit = false;
527   if (auto *MD = mdconst::extract_or_null<ConstantInt>(
528           M.getModuleFlag("EnableSplitLTOUnit")))
529     EnableSplitLTOUnit = MD->getZExtValue();
530   return EnableSplitLTOUnit;
531 }
532 
533 // Returns whether this module needs to be split because it uses type metadata.
hasTypeMetadata(Module & M)534 bool hasTypeMetadata(Module &M) {
535   for (auto &GO : M.global_objects()) {
536     if (GO.hasMetadata(LLVMContext::MD_type))
537       return true;
538   }
539   return false;
540 }
541 
writeThinLTOBitcode(raw_ostream & OS,raw_ostream * ThinLinkOS,function_ref<AAResults & (Function &)> AARGetter,Module & M,const ModuleSummaryIndex * Index,const bool ShouldPreserveUseListOrder)542 bool writeThinLTOBitcode(raw_ostream &OS, raw_ostream *ThinLinkOS,
543                          function_ref<AAResults &(Function &)> AARGetter,
544                          Module &M, const ModuleSummaryIndex *Index,
545                          const bool ShouldPreserveUseListOrder) {
546   std::unique_ptr<ModuleSummaryIndex> NewIndex = nullptr;
547   // See if this module has any type metadata. If so, we try to split it
548   // or at least promote type ids to enable WPD.
549   if (hasTypeMetadata(M)) {
550     if (enableSplitLTOUnit(M)) {
551       splitAndWriteThinLTOBitcode(OS, ThinLinkOS, AARGetter, M,
552                                   ShouldPreserveUseListOrder);
553       return true;
554     }
555     // Promote type ids as needed for index-based WPD.
556     std::string ModuleId = getUniqueModuleId(&M);
557     if (!ModuleId.empty()) {
558       promoteTypeIds(M, ModuleId);
559       // Need to rebuild the index so that it contains type metadata
560       // for the newly promoted type ids.
561       // FIXME: Probably should not bother building the index at all
562       // in the caller of writeThinLTOBitcode (which does so via the
563       // ModuleSummaryIndexAnalysis pass), since we have to rebuild it
564       // anyway whenever there is type metadata (here or in
565       // splitAndWriteThinLTOBitcode). Just always build it once via the
566       // buildModuleSummaryIndex when Module(s) are ready.
567       ProfileSummaryInfo PSI(M);
568       NewIndex = std::make_unique<ModuleSummaryIndex>(
569           buildModuleSummaryIndex(M, nullptr, &PSI));
570       Index = NewIndex.get();
571     }
572   }
573 
574   // Write it out as an unsplit ThinLTO module.
575 
576   // Save the module hash produced for the full bitcode, which will
577   // be used in the backends, and use that in the minimized bitcode
578   // produced for the full link.
579   ModuleHash ModHash = {{0}};
580   WriteBitcodeToFile(M, OS, ShouldPreserveUseListOrder, Index,
581                      /*GenerateHash=*/true, &ModHash);
582   // If a minimized bitcode module was requested for the thin link, only
583   // the information that is needed by thin link will be written in the
584   // given OS.
585   if (ThinLinkOS && Index)
586     writeThinLinkBitcodeToFile(M, *ThinLinkOS, *Index, ModHash);
587   return false;
588 }
589 
590 } // anonymous namespace
591 
592 PreservedAnalyses
run(Module & M,ModuleAnalysisManager & AM)593 llvm::ThinLTOBitcodeWriterPass::run(Module &M, ModuleAnalysisManager &AM) {
594   FunctionAnalysisManager &FAM =
595       AM.getResult<FunctionAnalysisManagerModuleProxy>(M).getManager();
596 
597   M.removeDebugIntrinsicDeclarations();
598 
599   bool Changed = writeThinLTOBitcode(
600       OS, ThinLinkOS,
601       [&FAM](Function &F) -> AAResults & {
602         return FAM.getResult<AAManager>(F);
603       },
604       M, &AM.getResult<ModuleSummaryIndexAnalysis>(M),
605       ShouldPreserveUseListOrder);
606 
607   return Changed ? PreservedAnalyses::none() : PreservedAnalyses::all();
608 }
609