LLVM 24.0.0git
ThinLTOBitcodeWriter.cpp
Go to the documentation of this file.
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
15#include "llvm/IR/Constants.h"
16#include "llvm/IR/DebugInfo.h"
18#include "llvm/IR/Intrinsics.h"
19#include "llvm/IR/Module.h"
20#include "llvm/IR/PassManager.h"
23#include "llvm/Transforms/IPO.h"
29using namespace llvm;
30
31namespace {
32
33// Determine if a promotion alias should be created for a symbol name.
34static 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 for (const char &C : Name) {
38 if (isAlnum(C) || C == '_' || C == '.')
39 continue;
40 return false;
41 }
42 return true;
43}
44
45// Promote each local-linkage entity defined by ExportM and used by ImportM by
46// changing visibility and appending the given ModuleId.
47void promoteInternals(Module &ExportM, Module &ImportM, StringRef ModuleId,
48 const SetVector<GlobalValue *> &PromoteExtra) {
50 for (auto &ExportGV : ExportM.global_values()) {
51 if (!ExportGV.hasLocalLinkage())
52 continue;
53
54 auto Name = ExportGV.getName();
55 GlobalValue *ImportGV = nullptr;
56 if (!PromoteExtra.count(&ExportGV)) {
57 ImportGV = ImportM.getNamedValue(Name);
58 if (!ImportGV)
59 continue;
60 ImportGV->removeDeadConstantUsers();
61 if (ImportGV->use_empty()) {
62 ImportGV->eraseFromParent();
63 continue;
64 }
65 }
66
67 std::string OldName = Name.str();
68 std::string NewName = (Name + ModuleId).str();
69
70 if (const auto *C = ExportGV.getComdat())
71 if (C->getName() == Name)
72 RenamedComdats.try_emplace(C, ExportM.getOrInsertComdat(NewName));
73
74 ExportGV.setName(NewName);
75 ExportGV.setLinkage(GlobalValue::ExternalLinkage);
76 ExportGV.setVisibility(GlobalValue::HiddenVisibility);
77 // TODO: remove this reassign and instead create an alias.
78 ExportGV.reassignGUID();
79 if (ImportGV) {
80 ImportGV->setName(NewName);
82 ImportGV->reassignGUID();
83 }
84
85 if (isa<Function>(&ExportGV) && allowPromotionAlias(OldName)) {
86 // Create a local alias with the original name to avoid breaking
87 // references from inline assembly.
88 std::string Alias =
89 ".lto_set_conditional " + OldName + "," + NewName + "\n";
90 ExportM.appendModuleInlineAsm(Alias);
91 }
92 }
93
94 if (!RenamedComdats.empty())
95 for (auto &GO : ExportM.global_objects())
96 if (auto *C = GO.getComdat()) {
97 auto Replacement = RenamedComdats.find(C);
98 if (Replacement != RenamedComdats.end())
99 GO.setComdat(Replacement->second);
100 }
101}
102
103// Promote all internal (i.e. distinct) type ids used by the module by replacing
104// them with external type ids formed using the module id.
105//
106// Note that this needs to be done before we clone the module because each clone
107// will receive its own set of distinct metadata nodes.
108void promoteTypeIds(Module &M, StringRef ModuleId) {
110 auto ExternalizeTypeId = [&](CallInst *CI, unsigned ArgNo) {
111 Metadata *MD =
112 cast<MetadataAsValue>(CI->getArgOperand(ArgNo))->getMetadata();
113
114 if (isa<MDNode>(MD) && cast<MDNode>(MD)->isDistinct()) {
115 Metadata *&GlobalMD = LocalToGlobal[MD];
116 if (!GlobalMD) {
117 std::string NewName = (Twine(LocalToGlobal.size()) + ModuleId).str();
118 GlobalMD = MDString::get(M.getContext(), NewName);
119 }
120
121 CI->setArgOperand(ArgNo,
122 MetadataAsValue::get(M.getContext(), GlobalMD));
123 }
124 };
125
126 if (Function *TypeTestFunc =
127 Intrinsic::getDeclarationIfExists(&M, Intrinsic::type_test)) {
128 for (const Use &U : TypeTestFunc->uses()) {
129 auto CI = cast<CallInst>(U.getUser());
130 ExternalizeTypeId(CI, 1);
131 }
132 }
133
134 if (Function *PublicTypeTestFunc =
135 Intrinsic::getDeclarationIfExists(&M, Intrinsic::public_type_test)) {
136 for (const Use &U : PublicTypeTestFunc->uses()) {
137 auto CI = cast<CallInst>(U.getUser());
138 ExternalizeTypeId(CI, 1);
139 }
140 }
141
142 if (Function *TypeCheckedLoadFunc =
143 Intrinsic::getDeclarationIfExists(&M, Intrinsic::type_checked_load)) {
144 for (const Use &U : TypeCheckedLoadFunc->uses()) {
145 auto CI = cast<CallInst>(U.getUser());
146 ExternalizeTypeId(CI, 2);
147 }
148 }
149
150 if (Function *TypeCheckedLoadRelativeFunc = Intrinsic::getDeclarationIfExists(
151 &M, Intrinsic::type_checked_load_relative)) {
152 for (const Use &U : TypeCheckedLoadRelativeFunc->uses()) {
153 auto CI = cast<CallInst>(U.getUser());
154 ExternalizeTypeId(CI, 2);
155 }
156 }
157
158 for (GlobalObject &GO : M.global_objects()) {
160 GO.getMetadata(LLVMContext::MD_type, MDs);
161
162 GO.eraseMetadata(LLVMContext::MD_type);
163 for (auto *MD : MDs) {
164 auto I = LocalToGlobal.find(MD->getOperand(1));
165 if (I == LocalToGlobal.end()) {
166 GO.addMetadata(LLVMContext::MD_type, *MD);
167 continue;
168 }
169 GO.addMetadata(
170 LLVMContext::MD_type,
171 *MDNode::get(M.getContext(), {MD->getOperand(0), I->second}));
172 }
173
175 GO.getMetadata(LLVMContext::MD_callgraph, CGMDs);
176
177 GO.eraseMetadata(LLVMContext::MD_callgraph);
178 for (auto *MD : CGMDs) {
179 if (MD->getNumOperands() == 1) {
180 auto I = LocalToGlobal.find(MD->getOperand(0));
181 if (I == LocalToGlobal.end()) {
182 GO.addMetadata(LLVMContext::MD_callgraph, *MD);
183 continue;
184 }
185 GO.addMetadata(LLVMContext::MD_callgraph,
186 *MDNode::get(M.getContext(), {I->second}));
187 }
188 }
189 }
190}
191
192// Drop unused globals, and drop type information from function declarations.
193// FIXME: If we made functions typeless then there would be no need to do this.
194void simplifyExternals(Module &M) {
195 FunctionType *EmptyFT =
196 FunctionType::get(Type::getVoidTy(M.getContext()), false);
197
199 if (F.isDeclaration() && F.use_empty()) {
200 F.eraseFromParent();
201 continue;
202 }
203
204 if (!F.isDeclaration() || F.getFunctionType() == EmptyFT ||
205 // Changing the type of an intrinsic may invalidate the IR.
206 F.getName().starts_with("llvm."))
207 continue;
208
210 F.getAddressSpace(), "", &M);
211 NewF->copyAttributesFrom(&F);
212 // Only copy function attribtues.
213 NewF->setAttributes(AttributeList::get(M.getContext(),
214 AttributeList::FunctionIndex,
215 F.getAttributes().getFnAttrs()));
216 NewF->takeName(&F);
217 NewF->setMetadata(LLVMContext::MD_guid,
218 F.getMetadata(LLVMContext::MD_guid));
219 F.replaceAllUsesWith(NewF);
220 F.eraseFromParent();
221 }
222
223 for (GlobalIFunc &I : llvm::make_early_inc_range(M.ifuncs())) {
224 if (I.use_empty())
225 I.eraseFromParent();
226 else
227 assert(I.getResolverFunction() && "ifunc misses its resolver function");
228 }
229
230 for (GlobalVariable &GV : llvm::make_early_inc_range(M.globals())) {
231 if (GV.isDeclaration() && GV.use_empty()) {
232 GV.eraseFromParent();
233 continue;
234 }
235 }
236}
237
238static void
239filterModule(Module *M,
240 function_ref<bool(const GlobalValue *)> ShouldKeepDefinition) {
241 std::vector<GlobalValue *> V;
242 for (GlobalValue &GV : M->global_values())
243 if (!ShouldKeepDefinition(&GV))
244 V.push_back(&GV);
245
246 for (GlobalValue *GV : V)
247 if (!convertToDeclaration(*GV))
248 GV->eraseFromParent();
249}
250
251void forEachVirtualFunction(Constant *C, function_ref<void(Function *)> Fn) {
252 if (auto *F = dyn_cast<Function>(C))
253 return Fn(F);
254 if (isa<GlobalValue>(C))
255 return;
256 for (Value *Op : C->operands())
257 forEachVirtualFunction(cast<Constant>(Op), Fn);
258}
259
260// Clone any @llvm[.compiler].used over to the new module and append
261// values whose defs were cloned into that module.
262static void cloneUsedGlobalVariables(const Module &SrcM, Module &DestM,
263 bool CompilerUsed) {
265 // First collect those in the llvm[.compiler].used set.
266 collectUsedGlobalVariables(SrcM, Used, CompilerUsed);
267 // Next build a set of the equivalent values defined in DestM.
268 for (auto *V : Used) {
269 auto *GV = DestM.getNamedValue(V->getName());
270 if (GV && !GV->isDeclaration())
271 NewUsed.push_back(GV);
272 }
273 // Finally, add them to a llvm[.compiler].used variable in DestM.
274 if (CompilerUsed)
275 appendToCompilerUsed(DestM, NewUsed);
276 else
277 appendToUsed(DestM, NewUsed);
278}
279
280#ifndef NDEBUG
281static bool enableUnifiedLTO(Module &M) {
282 bool UnifiedLTO = false;
283 if (auto *MD =
284 mdconst::extract_or_null<ConstantInt>(M.getModuleFlag("UnifiedLTO")))
285 UnifiedLTO = MD->getZExtValue();
286 return UnifiedLTO;
287}
288#endif
289
290bool mustEmitToMergedModule(const GlobalValue *GV) {
291 // The __cfi_check definition is filled in by the CrossDSOCFI pass which
292 // runs only in the merged module.
293 return GV->getName() == "__cfi_check";
294}
295
296// If it's possible to split M into regular and thin LTO parts, do so and write
297// a multi-module bitcode file with the two parts to OS. Otherwise, write only a
298// regular LTO bitcode file to OS.
299void splitAndWriteThinLTOBitcode(
300 raw_ostream &OS, raw_ostream *ThinLinkOS,
301 function_ref<AAResults &(Function &)> AARGetter, Module &M,
302 const bool ShouldPreserveUseListOrder) {
303 std::string ModuleId = getUniqueModuleId(&M);
304 if (ModuleId.empty()) {
305 assert(!enableUnifiedLTO(M));
306 // We couldn't generate a module ID for this module, write it out as a
307 // regular LTO module with an index for summary-based dead stripping.
308 ProfileSummaryInfo PSI(M);
309 M.addModuleFlag(Module::Error, "ThinLTO", uint32_t(0));
310 ModuleSummaryIndex Index = buildModuleSummaryIndex(M, nullptr, &PSI);
311 WriteBitcodeToFile(M, OS, ShouldPreserveUseListOrder, &Index,
312 /*UnifiedLTO=*/false);
313
314 if (ThinLinkOS)
315 // We don't have a ThinLTO part, but still write the module to the
316 // ThinLinkOS if requested so that the expected output file is produced.
317 WriteBitcodeToFile(M, *ThinLinkOS, ShouldPreserveUseListOrder, &Index,
318 /*UnifiedLTO=*/false);
319
320 return;
321 }
322
323 promoteTypeIds(M, ModuleId);
324
325 // Returns whether a global or its associated global has attached type
326 // metadata. The former may participate in CFI or whole-program
327 // devirtualization, so they need to appear in the merged module instead of
328 // the thin LTO module. Similarly, globals that are associated with globals
329 // with type metadata need to appear in the merged module because they will
330 // reference the global's section directly.
331 auto HasTypeMetadata = [](const GlobalObject *GO) {
332 if (MDNode *MD = GO->getMetadata(LLVMContext::MD_associated))
333 if (auto *AssocVM = dyn_cast_or_null<ValueAsMetadata>(MD->getOperand(0)))
334 if (auto *AssocGO = dyn_cast<GlobalObject>(AssocVM->getValue()))
335 if (AssocGO->hasMetadata(LLVMContext::MD_type))
336 return true;
337 return GO->hasMetadata(LLVMContext::MD_type);
338 };
339
340 // Collect the set of virtual functions that are eligible for virtual constant
341 // propagation. Each eligible function must not access memory, must return
342 // an integer of width <=64 bits, must take at least one argument, must not
343 // use its first argument (assumed to be "this") and all arguments other than
344 // the first one must be of <=64 bit integer type.
345 //
346 // Note that we test whether this copy of the function is readnone, rather
347 // than testing function attributes, which must hold for any copy of the
348 // function, even a less optimized version substituted at link time. This is
349 // sound because the virtual constant propagation optimizations effectively
350 // inline all implementations of the virtual function into each call site,
351 // rather than using function attributes to perform local optimization.
352 DenseSet<const Function *> EligibleVirtualFns;
353 // If any member of a comdat lives in MergedM, put all members of that
354 // comdat in MergedM to keep the comdat together.
355 DenseSet<const Comdat *> MergedMComdats;
356 for (GlobalVariable &GV : M.globals())
357 if (!GV.isDeclaration() && HasTypeMetadata(&GV)) {
358 if (const auto *C = GV.getComdat())
359 MergedMComdats.insert(C);
360 forEachVirtualFunction(GV.getInitializer(), [&](Function *F) {
361 auto *RT = dyn_cast<IntegerType>(F->getReturnType());
362 if (!RT || RT->getBitWidth() > 64 || F->arg_empty() ||
363 !F->arg_begin()->use_empty())
364 return;
365 for (auto &Arg : drop_begin(F->args())) {
366 auto *ArgT = dyn_cast<IntegerType>(Arg.getType());
367 if (!ArgT || ArgT->getBitWidth() > 64)
368 return;
369 }
370 if (!F->isDeclaration() &&
371 computeFunctionBodyMemoryAccess(*F, AARGetter(*F))
372 .doesNotAccessMemory())
373 EligibleVirtualFns.insert(F);
374 });
375 }
376
378 std::unique_ptr<Module> MergedM(
379 CloneModule(M, VMap, [&](const GlobalValue *GV) -> bool {
380 if (const auto *C = GV->getComdat())
381 if (MergedMComdats.count(C))
382 return true;
383 if (mustEmitToMergedModule(GV))
384 return true;
385 if (auto *F = dyn_cast<Function>(GV))
386 return EligibleVirtualFns.count(F);
387 if (auto *GVar =
389 return HasTypeMetadata(GVar);
390 return false;
391 }));
392 StripDebugInfo(*MergedM);
393 MergedM->removeModuleInlineAsm();
394
395 // Clone any llvm.*used globals to ensure the included values are
396 // not deleted.
397 cloneUsedGlobalVariables(M, *MergedM, /*CompilerUsed*/ false);
398 cloneUsedGlobalVariables(M, *MergedM, /*CompilerUsed*/ true);
399
400 for (Function &F : *MergedM)
401 if (!F.isDeclaration() && !mustEmitToMergedModule(&F)) {
402 // Reset the linkage of all functions eligible for virtual constant
403 // propagation. The canonical definitions live in the thin LTO module so
404 // that they can be imported.
406 F.setComdat(nullptr);
407 }
408
409 SetVector<GlobalValue *> CfiFunctions;
410 for (auto &F : M)
411 if ((!F.hasLocalLinkage() || F.hasAddressTaken()) && HasTypeMetadata(&F))
412 CfiFunctions.insert(&F);
413 for (auto &A : M.aliases())
414 if (auto *F = dyn_cast<Function>(A.getAliasee()))
415 if (HasTypeMetadata(F))
416 CfiFunctions.insert(&A);
417
418 // Remove all globals with type metadata, globals with comdats that live in
419 // MergedM, and aliases pointing to such globals from the thin LTO module.
420 filterModule(&M, [&](const GlobalValue *GV) {
422 if (HasTypeMetadata(GVar))
423 return false;
424 if (const auto *C = GV->getComdat())
425 if (MergedMComdats.count(C))
426 return false;
427 if (mustEmitToMergedModule(GV))
428 return false;
429 return true;
430 });
431
432 // CfiFunctions contains only symbols from M. promoteInternals tries to find
433 // match values from its first argument (the "exporting module") in
434 // CfiFunctions. So we only need CfiFunctions for the second promotion (M ->
435 // MergedM)
436 promoteInternals(*MergedM, M, ModuleId, {});
437 promoteInternals(M, *MergedM, ModuleId, CfiFunctions);
438
439 auto &Ctx = MergedM->getContext();
440 SmallVector<MDNode *, 8> CfiFunctionMDs;
441 for (auto *V : CfiFunctions) {
442 Function &F = *cast<Function>(V->getAliaseeObject());
444 F.getMetadata(LLVMContext::MD_type, Types);
445
447 Elts.push_back(MDString::get(Ctx, V->getName()));
451 else if (F.hasExternalWeakLinkage())
453 else
456 llvm::ConstantInt::get(Type::getInt8Ty(Ctx), Linkage)));
457 GlobalValue::GUID GUID = V->getGUID();
459 llvm::ConstantInt::get(Type::getInt64Ty(Ctx), GUID)));
460 append_range(Elts, Types);
461 CfiFunctionMDs.push_back(MDTuple::get(Ctx, Elts));
462 }
463
464 if(!CfiFunctionMDs.empty()) {
465 NamedMDNode *NMD = MergedM->getOrInsertNamedMetadata("cfi.functions");
466 for (auto *MD : CfiFunctionMDs)
467 NMD->addOperand(MD);
468 }
469
471 for (auto &A : M.aliases()) {
472 if (!isa<Function>(A.getAliasee()))
473 continue;
474
475 auto *F = cast<Function>(A.getAliasee());
476 FunctionAliases[F].push_back(&A);
477 }
478
479 if (!FunctionAliases.empty()) {
480 NamedMDNode *NMD = MergedM->getOrInsertNamedMetadata("aliases");
481 for (auto &Alias : FunctionAliases) {
483 Elts.push_back(MDString::get(Ctx, Alias.first->getName()));
484 for (auto *A : Alias.second)
485 Elts.push_back(MDString::get(Ctx, A->getName()));
486 NMD->addOperand(MDTuple::get(Ctx, Elts));
487 }
488 }
489
492 Function *F = M.getFunction(Name);
493 if (!F || F->use_empty())
494 return;
495
496 Symvers.push_back(MDTuple::get(
497 Ctx, {MDString::get(Ctx, Name), MDString::get(Ctx, Alias)}));
498 });
499
500 if (!Symvers.empty()) {
501 NamedMDNode *NMD = MergedM->getOrInsertNamedMetadata("symvers");
502 for (auto *MD : Symvers)
503 NMD->addOperand(MD);
504 }
505
506 simplifyExternals(*MergedM);
507
508 // FIXME: Try to re-use BSI and PFI from the original module here.
509 ProfileSummaryInfo PSI(M);
510 ModuleSummaryIndex Index = buildModuleSummaryIndex(M, nullptr, &PSI);
511
512 // Mark the merged module as requiring full LTO. We still want an index for
513 // it though, so that it can participate in summary-based dead stripping.
514 MergedM->addModuleFlag(Module::Error, "ThinLTO", uint32_t(0));
515 ModuleSummaryIndex MergedMIndex =
516 buildModuleSummaryIndex(*MergedM, nullptr, &PSI);
517
519
520 BitcodeWriter W(Buffer);
521 // Save the module hash produced for the full bitcode, which will
522 // be used in the backends, and use that in the minimized bitcode
523 // produced for the full link.
524 ModuleHash ModHash = {{0}};
525 W.writeModule(M, ShouldPreserveUseListOrder, &Index,
526 /*GenerateHash=*/true, &ModHash);
527 W.writeModule(*MergedM, ShouldPreserveUseListOrder, &MergedMIndex);
528 W.writeSymtab();
529 W.writeStrtab();
530 OS << Buffer;
531
532 // If a minimized bitcode module was requested for the thin link, only
533 // the information that is needed by thin link will be written in the
534 // given OS (the merged module will be written as usual).
535 if (ThinLinkOS) {
536 Buffer.clear();
537 BitcodeWriter W2(Buffer);
539 W2.writeThinLinkBitcode(M, Index, ModHash);
540 W2.writeModule(*MergedM, /*ShouldPreserveUseListOrder=*/false,
541 &MergedMIndex);
542 W2.writeSymtab();
543 W2.writeStrtab();
544 *ThinLinkOS << Buffer;
545 }
546}
547
548// Check if the LTO Unit splitting has been enabled.
549bool enableSplitLTOUnit(Module &M) {
550 bool EnableSplitLTOUnit = false;
552 M.getModuleFlag("EnableSplitLTOUnit")))
553 EnableSplitLTOUnit = MD->getZExtValue();
554 return EnableSplitLTOUnit;
555}
556
557// Returns whether this module needs to be split (if splitting is enabled).
558bool requiresSplit(Module &M) {
559 for (auto &GO : M.global_objects()) {
560 if (GO.hasMetadata(LLVMContext::MD_type))
561 return true;
562 if (mustEmitToMergedModule(&GO))
563 return true;
564 }
565 return false;
566}
567
568bool writeThinLTOBitcode(raw_ostream &OS, raw_ostream *ThinLinkOS,
569 function_ref<AAResults &(Function &)> AARGetter,
570 Module &M, const ModuleSummaryIndex *Index,
571 const bool ShouldPreserveUseListOrder) {
572 std::unique_ptr<ModuleSummaryIndex> NewIndex = nullptr;
573 // See if this module needs to be split. If so, we try to split it
574 // or at least promote type ids to enable WPD.
575 if (requiresSplit(M)) {
576 if (enableSplitLTOUnit(M)) {
577 splitAndWriteThinLTOBitcode(OS, ThinLinkOS, AARGetter, M,
578 ShouldPreserveUseListOrder);
579 return true;
580 }
581 // Promote type ids as needed for index-based WPD.
582 std::string ModuleId = getUniqueModuleId(&M);
583 if (!ModuleId.empty()) {
584 promoteTypeIds(M, ModuleId);
585 // Need to rebuild the index so that it contains type metadata
586 // for the newly promoted type ids.
587 // FIXME: Probably should not bother building the index at all
588 // in the caller of writeThinLTOBitcode (which does so via the
589 // ModuleSummaryIndexAnalysis pass), since we have to rebuild it
590 // anyway whenever there is type metadata (here or in
591 // splitAndWriteThinLTOBitcode). Just always build it once via the
592 // buildModuleSummaryIndex when Module(s) are ready.
593 ProfileSummaryInfo PSI(M);
594 NewIndex = std::make_unique<ModuleSummaryIndex>(
595 buildModuleSummaryIndex(M, nullptr, &PSI));
596 Index = NewIndex.get();
597 }
598 }
599
600 // Write it out as an unsplit ThinLTO module.
601
602 // Save the module hash produced for the full bitcode, which will
603 // be used in the backends, and use that in the minimized bitcode
604 // produced for the full link.
605 ModuleHash ModHash = {{0}};
606 WriteBitcodeToFile(M, OS, ShouldPreserveUseListOrder, Index,
607 /*GenerateHash=*/true, &ModHash);
608 // If a minimized bitcode module was requested for the thin link, only
609 // the information that is needed by thin link will be written in the
610 // given OS.
611 if (ThinLinkOS && Index)
612 writeThinLinkBitcodeToFile(M, *ThinLinkOS, *Index, ModHash);
613 return false;
614}
615
616} // anonymous namespace
617
622
623 bool Changed = writeThinLTOBitcode(
624 OS, ThinLinkOS,
625 [&FAM](Function &F) -> AAResults & {
626 return FAM.getResult<AAManager>(F);
627 },
629 ShouldPreserveUseListOrder);
630
632}
assert(UImm &&(UImm !=~static_cast< T >(0)) &&"Invalid immediate!")
This is the interface for LLVM's primary stateless and local alias analysis.
static GCRegistry::Add< ShadowStackGC > C("shadow-stack", "Very portable GC for uncooperative code generators")
static GCRegistry::Add< ErlangGC > A("erlang", "erlang-compatible garbage collector")
This file contains the declarations for the subclasses of Constant, which represent the different fla...
DXIL Finalize Linkage
Provides passes for computing function attributes based on interprocedural analyses.
Module.h This file contains the declarations for the Module class.
This header defines various interfaces for pass management in LLVM.
#define F(x, y, z)
Definition MD5.cpp:54
#define I(x, y, z)
Definition MD5.cpp:57
This is the interface to build a ModuleSummaryIndex for a module.
FunctionAnalysisManager FAM
if(PassOpts->AAPipeline)
A manager for alias analyses.
PassT::Result & getResult(IRUnitT &IR, ExtraArgTs... ExtraArgs)
Get the result of an analysis pass for a given IR unit.
Value * getArgOperand(unsigned i) const
void setArgOperand(unsigned i, Value *v)
This class represents a function call, abstracting a target machine's calling convention.
static ConstantAsMetadata * get(Constant *C)
Definition Metadata.h:537
This is an important base class in LLVM.
Definition Constant.h:43
LLVM_ABI void removeDeadConstantUsers() const
If there are any dead constant users dangling off of this constant, remove them.
iterator find(const_arg_type_t< KeyT > Val)
Definition DenseMap.h:223
std::pair< iterator, bool > try_emplace(KeyT &&Key, Ts &&...Args)
Definition DenseMap.h:299
unsigned size() const
Definition DenseMap.h:172
bool empty() const
Definition DenseMap.h:171
iterator end()
Definition DenseMap.h:141
Implements a dense probed hash-table based set.
Definition DenseSet.h:281
static LLVM_ABI FunctionType * get(Type *Result, ArrayRef< Type * > Params, bool isVarArg)
This static method is the primary way of constructing a FunctionType.
static Function * Create(FunctionType *Ty, LinkageTypes Linkage, unsigned AddrSpace, const Twine &N="", Module *M=nullptr)
Definition Function.h:169
void setAttributes(AttributeList Attrs)
Set the attribute list for this Function.
Definition Function.h:332
void copyAttributesFrom(const Function *Src)
copyAttributesFrom - copy all additional attributes (those not needed to create a Function) from the ...
Definition Function.cpp:845
LLVM_ABI void setMetadata(unsigned KindID, MDNode *Node)
Set a particular kind of metadata attachment.
LLVM_ABI bool isDeclaration() const
Return true if the primary definition of this global value is outside of the current translation unit...
Definition Globals.cpp:408
uint64_t GUID
Declare a type to represent a global unique identifier for a global value.
LLVM_ABI const Comdat * getComdat() const
Definition Globals.cpp:274
LLVM_ABI const GlobalObject * getAliaseeObject() const
Definition Globals.cpp:521
LLVM_ABI void eraseFromParent()
This method unlinks 'this' from the containing module and deletes it.
Definition Globals.cpp:158
@ HiddenVisibility
The GV is hidden.
Definition GlobalValue.h:69
void setVisibility(VisibilityTypes V)
LLVM_ABI void reassignGUID()
Recompute and assign a GUID to this value, replacing the existing GUID.
Definition Globals.cpp:96
@ ExternalLinkage
Externally visible function.
Definition GlobalValue.h:53
@ AvailableExternallyLinkage
Available for inspection, not emission.
Definition GlobalValue.h:54
Metadata node.
Definition Metadata.h:1069
static MDTuple * get(LLVMContext &Context, ArrayRef< Metadata * > MDs)
Definition Metadata.h:1567
static LLVM_ABI MDString * get(LLVMContext &Context, StringRef Str)
Definition Metadata.cpp:615
static MDTuple * get(LLVMContext &Context, ArrayRef< Metadata * > MDs)
Definition Metadata.h:1513
This class implements a map that also provides access to all stored values in a deterministic order.
Definition MapVector.h:38
bool empty() const
Definition MapVector.h:79
static LLVM_ABI MetadataAsValue * get(LLVMContext &Context, Metadata *MD)
Definition Metadata.cpp:111
Root of the metadata hierarchy.
Definition Metadata.h:64
Analysis pass to provide the ModuleSummaryIndex object.
Class to hold module path string table and global value map, and encapsulate methods for operating on...
static LLVM_ABI void CollectAsmSymvers(const Module &M, function_ref< void(StringRef, StringRef)> AsmSymver)
Parse inline ASM and collect the symvers directives that are defined in the current module.
A Module instance is used to store all the information related to an LLVM module.
Definition Module.h:68
@ Error
Emits an error if two values disagree, otherwise the resulting value is that of the operands.
Definition Module.h:121
void appendModuleInlineAsm(GlobalAsmFragment Fragment)
Append to the module-scope inline assembly blocks.
Definition Module.h:398
iterator_range< global_object_iterator > global_objects()
Definition Module.cpp:461
GlobalValue * getNamedValue(StringRef Name) const
Return the global value in the module with the specified name, of arbitrary type.
Definition Module.cpp:177
Comdat * getOrInsertComdat(StringRef Name)
Return the Comdat in the module with the specified name.
Definition Module.cpp:631
iterator_range< global_value_iterator > global_values()
Definition Module.cpp:469
A tuple of MDNodes.
Definition Metadata.h:1755
LLVM_ABI void addOperand(MDNode *M)
A set of analyses that are preserved following a run of a transformation pass.
Definition Analysis.h:112
static PreservedAnalyses none()
Convenience factory function for the empty preserved set.
Definition Analysis.h:115
static PreservedAnalyses all()
Construct a special preserved set that preserves all passes.
Definition Analysis.h:118
Analysis providing profile information.
A vector that has set insertion semantics.
Definition SetVector.h:57
size_type count(const_arg_type key) const
Count the number of elements of a given key in the SetVector.
Definition SetVector.h:268
bool insert(const value_type &X)
Insert a new element into the SetVector.
Definition SetVector.h:157
void push_back(const T &Elt)
This is a 'vector' (really, a variable-sized array), optimized for the case when the array is small.
Represent a constant reference to a string, i.e.
Definition StringRef.h:56
LLVM_ABI PreservedAnalyses run(Module &M, ModuleAnalysisManager &AM)
Twine - A lightweight data structure for efficiently representing the concatenation of temporary valu...
Definition Twine.h:82
static LLVM_ABI IntegerType * getInt64Ty(LLVMContext &C)
Definition Type.cpp:310
static LLVM_ABI Type * getVoidTy(LLVMContext &C)
Definition Type.cpp:282
static LLVM_ABI IntegerType * getInt8Ty(LLVMContext &C)
Definition Type.cpp:307
A Use represents the edge between a Value definition and its users.
Definition Use.h:35
LLVM Value Representation.
Definition Value.h:75
LLVM_ABI void setName(const Twine &Name)
Change the name of the value.
Definition Value.cpp:394
bool use_empty() const
Definition Value.h:346
iterator_range< use_iterator > uses()
Definition Value.h:380
LLVM_ABI StringRef getName() const
Return a constant reference to the value's name.
Definition Value.cpp:319
LLVM_ABI void takeName(Value *V)
Transfer the name from V to this value.
Definition Value.cpp:400
std::pair< iterator, bool > insert(const ValueT &V)
Definition DenseSet.h:209
size_type count(const_arg_type_t< ValueT > V) const
Return 1 if the specified key is in the set, 0 otherwise.
Definition DenseSet.h:187
An efficient, type-erasing, non-owning reference to a callable.
This class implements an extremely fast bulk output stream that can only output to a stream.
Definition raw_ostream.h:53
Changed
LLVM_ABI Function * getDeclarationIfExists(const Module *M, ID id)
Look up the Function declaration of the intrinsic id in the Module M and return it if it exists.
LLVM_ABI bool isJumpTableCanonical(Function *F)
std::enable_if_t< detail::IsValidPointer< X, Y >::value, X * > extract_or_null(Y &&MD)
Extract a Value from Metadata, allowing null.
Definition Metadata.h:683
This is an optimization pass for GlobalISel generic memory operations.
LLVM_ABI MemoryEffects computeFunctionBodyMemoryAccess(Function &F, AAResults &AAR)
Returns the memory access properties of this copy of the function.
LLVM_ABI void WriteBitcodeToFile(const Module &M, raw_ostream &Out, bool ShouldPreserveUseListOrder=false, const ModuleSummaryIndex *Index=nullptr, bool GenerateHash=false, ModuleHash *ModHash=nullptr)
Write the specified module to the specified raw output stream.
decltype(auto) dyn_cast(const From &Val)
dyn_cast<X> - Return the argument parameter cast to the specified type.
Definition Casting.h:643
std::array< uint32_t, 5 > ModuleHash
160 bits SHA1
LLVM_ABI void writeThinLinkBitcodeToFile(const Module &M, raw_ostream &Out, const ModuleSummaryIndex &Index, const ModuleHash &ModHash)
Write the specified thin link bitcode file (i.e., the minimized bitcode file) to the given raw output...
void append_range(Container &C, Range &&R)
Wrapper function to append range R to container C.
Definition STLExtras.h:2208
iterator_range< early_inc_iterator_impl< detail::IterOfRange< RangeT > > > make_early_inc_range(RangeT &&Range)
Make a range that does early increment to allow mutation of the underlying range without disrupting i...
Definition STLExtras.h:633
LLVM_ABI bool convertToDeclaration(GlobalValue &GV)
Converts value GV to declaration, or replaces with a declaration if it is an alias.
InnerAnalysisManagerProxy< FunctionAnalysisManager, Module > FunctionAnalysisManagerModuleProxy
Provide the FunctionAnalysisManager to Module proxy.
LLVM_ABI ModuleSummaryIndex buildModuleSummaryIndex(const Module &M, std::function< BlockFrequencyInfo *(const Function &F)> GetBFICallback, ProfileSummaryInfo *PSI, std::function< const StackSafetyInfo *(const Function &F)> GetSSICallback=[](const Function &F) -> const StackSafetyInfo *{ return nullptr;})
Direct function to compute a ModuleSummaryIndex from a given module.
auto dyn_cast_or_null(const Y &Val)
Definition Casting.h:753
LLVM_ABI std::string getUniqueModuleId(Module *M)
Produce a unique identifier for this module by taking the MD5 sum of the names of the module's strong...
bool isAlnum(char C)
Checks whether character C is either a decimal digit or an uppercase or lowercase letter as classifie...
bool isa(const From &Val)
isa<X> - Return true if the parameter to the template is an instance of one of the template type argu...
Definition Casting.h:547
LLVM_ABI bool StripDebugInfo(Module &M)
Strip debug info in the module if it exists.
LLVM_ABI void appendToCompilerUsed(Module &M, ArrayRef< GlobalValue * > Values)
Adds global values to the llvm.compiler.used list.
DWARFExpression::Operation Op
ValueMap< const Value *, WeakTrackingVH > ValueToValueMapTy
decltype(auto) cast(const From &Val)
cast<X> - Return the argument parameter cast to the specified type.
Definition Casting.h:559
AnalysisManager< Function > FunctionAnalysisManager
Convenience typedef for the Function analysis manager.
LLVM_ABI std::unique_ptr< Module > CloneModule(const Module &M)
Return an exact copy of the specified module.
LLVM_ABI void appendToUsed(Module &M, ArrayRef< GlobalValue * > Values)
Adds global values to the llvm.used list.
CfiFunctionLinkage
The type of CFI jumptable needed for a function.
@ CFL_WeakDeclaration
AnalysisManager< Module > ModuleAnalysisManager
Convenience typedef for the Module analysis manager.
Definition MIRParser.h:39
LLVM_ABI GlobalVariable * collectUsedGlobalVariables(const Module &M, SmallVectorImpl< GlobalValue * > &Vec, bool CompilerUsed)
Given "llvm.used" or "llvm.compiler.used" as a global name, collect the initializer elements of that ...
Definition Module.cpp:932