xref: /llvm-project/clang/lib/CodeGen/CodeGenModule.cpp (revision f9bc1b3bee557de5735c745f9558c47ca568bd96)
1 //===--- CodeGenModule.cpp - Emit LLVM Code from ASTs for a Module --------===//
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 // This coordinates the per-module state used while generating code.
10 //
11 //===----------------------------------------------------------------------===//
12 
13 #include "CodeGenModule.h"
14 #include "CGBlocks.h"
15 #include "CGCUDARuntime.h"
16 #include "CGCXXABI.h"
17 #include "CGCall.h"
18 #include "CGDebugInfo.h"
19 #include "CGObjCRuntime.h"
20 #include "CGOpenCLRuntime.h"
21 #include "CGOpenMPRuntime.h"
22 #include "CGOpenMPRuntimeAMDGCN.h"
23 #include "CGOpenMPRuntimeNVPTX.h"
24 #include "CodeGenFunction.h"
25 #include "CodeGenPGO.h"
26 #include "ConstantEmitter.h"
27 #include "CoverageMappingGen.h"
28 #include "TargetInfo.h"
29 #include "clang/AST/ASTContext.h"
30 #include "clang/AST/CharUnits.h"
31 #include "clang/AST/DeclCXX.h"
32 #include "clang/AST/DeclObjC.h"
33 #include "clang/AST/DeclTemplate.h"
34 #include "clang/AST/Mangle.h"
35 #include "clang/AST/RecordLayout.h"
36 #include "clang/AST/RecursiveASTVisitor.h"
37 #include "clang/AST/StmtVisitor.h"
38 #include "clang/Basic/Builtins.h"
39 #include "clang/Basic/CharInfo.h"
40 #include "clang/Basic/CodeGenOptions.h"
41 #include "clang/Basic/Diagnostic.h"
42 #include "clang/Basic/FileManager.h"
43 #include "clang/Basic/Module.h"
44 #include "clang/Basic/SourceManager.h"
45 #include "clang/Basic/TargetInfo.h"
46 #include "clang/Basic/Version.h"
47 #include "clang/CodeGen/ConstantInitBuilder.h"
48 #include "clang/Frontend/FrontendDiagnostic.h"
49 #include "llvm/ADT/StringSwitch.h"
50 #include "llvm/ADT/Triple.h"
51 #include "llvm/Analysis/TargetLibraryInfo.h"
52 #include "llvm/Frontend/OpenMP/OMPIRBuilder.h"
53 #include "llvm/IR/CallingConv.h"
54 #include "llvm/IR/DataLayout.h"
55 #include "llvm/IR/Intrinsics.h"
56 #include "llvm/IR/LLVMContext.h"
57 #include "llvm/IR/Module.h"
58 #include "llvm/IR/ProfileSummary.h"
59 #include "llvm/ProfileData/InstrProfReader.h"
60 #include "llvm/Support/CodeGen.h"
61 #include "llvm/Support/CommandLine.h"
62 #include "llvm/Support/ConvertUTF.h"
63 #include "llvm/Support/ErrorHandling.h"
64 #include "llvm/Support/MD5.h"
65 #include "llvm/Support/TimeProfiler.h"
66 #include "llvm/Support/X86TargetParser.h"
67 
68 using namespace clang;
69 using namespace CodeGen;
70 
71 static llvm::cl::opt<bool> LimitedCoverage(
72     "limited-coverage-experimental", llvm::cl::ZeroOrMore, llvm::cl::Hidden,
73     llvm::cl::desc("Emit limited coverage mapping information (experimental)"),
74     llvm::cl::init(false));
75 
76 static const char AnnotationSection[] = "llvm.metadata";
77 
78 static CGCXXABI *createCXXABI(CodeGenModule &CGM) {
79   switch (CGM.getContext().getCXXABIKind()) {
80   case TargetCXXABI::AppleARM64:
81   case TargetCXXABI::Fuchsia:
82   case TargetCXXABI::GenericAArch64:
83   case TargetCXXABI::GenericARM:
84   case TargetCXXABI::iOS:
85   case TargetCXXABI::WatchOS:
86   case TargetCXXABI::GenericMIPS:
87   case TargetCXXABI::GenericItanium:
88   case TargetCXXABI::WebAssembly:
89   case TargetCXXABI::XL:
90     return CreateItaniumCXXABI(CGM);
91   case TargetCXXABI::Microsoft:
92     return CreateMicrosoftCXXABI(CGM);
93   }
94 
95   llvm_unreachable("invalid C++ ABI kind");
96 }
97 
98 CodeGenModule::CodeGenModule(ASTContext &C, const HeaderSearchOptions &HSO,
99                              const PreprocessorOptions &PPO,
100                              const CodeGenOptions &CGO, llvm::Module &M,
101                              DiagnosticsEngine &diags,
102                              CoverageSourceInfo *CoverageInfo)
103     : Context(C), LangOpts(C.getLangOpts()), HeaderSearchOpts(HSO),
104       PreprocessorOpts(PPO), CodeGenOpts(CGO), TheModule(M), Diags(diags),
105       Target(C.getTargetInfo()), ABI(createCXXABI(*this)),
106       VMContext(M.getContext()), Types(*this), VTables(*this),
107       SanitizerMD(new SanitizerMetadata(*this)) {
108 
109   // Initialize the type cache.
110   llvm::LLVMContext &LLVMContext = M.getContext();
111   VoidTy = llvm::Type::getVoidTy(LLVMContext);
112   Int8Ty = llvm::Type::getInt8Ty(LLVMContext);
113   Int16Ty = llvm::Type::getInt16Ty(LLVMContext);
114   Int32Ty = llvm::Type::getInt32Ty(LLVMContext);
115   Int64Ty = llvm::Type::getInt64Ty(LLVMContext);
116   HalfTy = llvm::Type::getHalfTy(LLVMContext);
117   BFloatTy = llvm::Type::getBFloatTy(LLVMContext);
118   FloatTy = llvm::Type::getFloatTy(LLVMContext);
119   DoubleTy = llvm::Type::getDoubleTy(LLVMContext);
120   PointerWidthInBits = C.getTargetInfo().getPointerWidth(0);
121   PointerAlignInBytes =
122     C.toCharUnitsFromBits(C.getTargetInfo().getPointerAlign(0)).getQuantity();
123   SizeSizeInBytes =
124     C.toCharUnitsFromBits(C.getTargetInfo().getMaxPointerWidth()).getQuantity();
125   IntAlignInBytes =
126     C.toCharUnitsFromBits(C.getTargetInfo().getIntAlign()).getQuantity();
127   CharTy =
128     llvm::IntegerType::get(LLVMContext, C.getTargetInfo().getCharWidth());
129   IntTy = llvm::IntegerType::get(LLVMContext, C.getTargetInfo().getIntWidth());
130   IntPtrTy = llvm::IntegerType::get(LLVMContext,
131     C.getTargetInfo().getMaxPointerWidth());
132   Int8PtrTy = Int8Ty->getPointerTo(0);
133   Int8PtrPtrTy = Int8PtrTy->getPointerTo(0);
134   const llvm::DataLayout &DL = M.getDataLayout();
135   AllocaInt8PtrTy = Int8Ty->getPointerTo(DL.getAllocaAddrSpace());
136   GlobalsInt8PtrTy = Int8Ty->getPointerTo(DL.getDefaultGlobalsAddressSpace());
137   ASTAllocaAddressSpace = getTargetCodeGenInfo().getASTAllocaAddressSpace();
138 
139   RuntimeCC = getTargetCodeGenInfo().getABIInfo().getRuntimeCC();
140 
141   if (LangOpts.ObjC)
142     createObjCRuntime();
143   if (LangOpts.OpenCL)
144     createOpenCLRuntime();
145   if (LangOpts.OpenMP)
146     createOpenMPRuntime();
147   if (LangOpts.CUDA)
148     createCUDARuntime();
149 
150   // Enable TBAA unless it's suppressed. ThreadSanitizer needs TBAA even at O0.
151   if (LangOpts.Sanitize.has(SanitizerKind::Thread) ||
152       (!CodeGenOpts.RelaxedAliasing && CodeGenOpts.OptimizationLevel > 0))
153     TBAA.reset(new CodeGenTBAA(Context, TheModule, CodeGenOpts, getLangOpts(),
154                                getCXXABI().getMangleContext()));
155 
156   // If debug info or coverage generation is enabled, create the CGDebugInfo
157   // object.
158   if (CodeGenOpts.getDebugInfo() != codegenoptions::NoDebugInfo ||
159       CodeGenOpts.EmitGcovArcs || CodeGenOpts.EmitGcovNotes)
160     DebugInfo.reset(new CGDebugInfo(*this));
161 
162   Block.GlobalUniqueCount = 0;
163 
164   if (C.getLangOpts().ObjC)
165     ObjCData.reset(new ObjCEntrypoints());
166 
167   if (CodeGenOpts.hasProfileClangUse()) {
168     auto ReaderOrErr = llvm::IndexedInstrProfReader::create(
169         CodeGenOpts.ProfileInstrumentUsePath, CodeGenOpts.ProfileRemappingFile);
170     if (auto E = ReaderOrErr.takeError()) {
171       unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
172                                               "Could not read profile %0: %1");
173       llvm::handleAllErrors(std::move(E), [&](const llvm::ErrorInfoBase &EI) {
174         getDiags().Report(DiagID) << CodeGenOpts.ProfileInstrumentUsePath
175                                   << EI.message();
176       });
177     } else
178       PGOReader = std::move(ReaderOrErr.get());
179   }
180 
181   // If coverage mapping generation is enabled, create the
182   // CoverageMappingModuleGen object.
183   if (CodeGenOpts.CoverageMapping)
184     CoverageMapping.reset(new CoverageMappingModuleGen(*this, *CoverageInfo));
185 
186   // Generate the module name hash here if needed.
187   if (CodeGenOpts.UniqueInternalLinkageNames &&
188       !getModule().getSourceFileName().empty()) {
189     std::string Path = getModule().getSourceFileName();
190     // Check if a path substitution is needed from the MacroPrefixMap.
191     for (const auto &Entry : LangOpts.MacroPrefixMap)
192       if (Path.rfind(Entry.first, 0) != std::string::npos) {
193         Path = Entry.second + Path.substr(Entry.first.size());
194         break;
195       }
196     llvm::MD5 Md5;
197     Md5.update(Path);
198     llvm::MD5::MD5Result R;
199     Md5.final(R);
200     SmallString<32> Str;
201     llvm::MD5::stringifyResult(R, Str);
202     // Convert MD5hash to Decimal. Demangler suffixes can either contain
203     // numbers or characters but not both.
204     llvm::APInt IntHash(128, Str.str(), 16);
205     // Prepend "__uniq" before the hash for tools like profilers to understand
206     // that this symbol is of internal linkage type.  The "__uniq" is the
207     // pre-determined prefix that is used to tell tools that this symbol was
208     // created with -funique-internal-linakge-symbols and the tools can strip or
209     // keep the prefix as needed.
210     ModuleNameHash = (Twine(".__uniq.") +
211         Twine(toString(IntHash, /* Radix = */ 10, /* Signed = */false))).str();
212   }
213 }
214 
215 CodeGenModule::~CodeGenModule() {}
216 
217 void CodeGenModule::createObjCRuntime() {
218   // This is just isGNUFamily(), but we want to force implementors of
219   // new ABIs to decide how best to do this.
220   switch (LangOpts.ObjCRuntime.getKind()) {
221   case ObjCRuntime::GNUstep:
222   case ObjCRuntime::GCC:
223   case ObjCRuntime::ObjFW:
224     ObjCRuntime.reset(CreateGNUObjCRuntime(*this));
225     return;
226 
227   case ObjCRuntime::FragileMacOSX:
228   case ObjCRuntime::MacOSX:
229   case ObjCRuntime::iOS:
230   case ObjCRuntime::WatchOS:
231     ObjCRuntime.reset(CreateMacObjCRuntime(*this));
232     return;
233   }
234   llvm_unreachable("bad runtime kind");
235 }
236 
237 void CodeGenModule::createOpenCLRuntime() {
238   OpenCLRuntime.reset(new CGOpenCLRuntime(*this));
239 }
240 
241 void CodeGenModule::createOpenMPRuntime() {
242   // Select a specialized code generation class based on the target, if any.
243   // If it does not exist use the default implementation.
244   switch (getTriple().getArch()) {
245   case llvm::Triple::nvptx:
246   case llvm::Triple::nvptx64:
247     assert(getLangOpts().OpenMPIsDevice &&
248            "OpenMP NVPTX is only prepared to deal with device code.");
249     OpenMPRuntime.reset(new CGOpenMPRuntimeNVPTX(*this));
250     break;
251   case llvm::Triple::amdgcn:
252     assert(getLangOpts().OpenMPIsDevice &&
253            "OpenMP AMDGCN is only prepared to deal with device code.");
254     OpenMPRuntime.reset(new CGOpenMPRuntimeAMDGCN(*this));
255     break;
256   default:
257     if (LangOpts.OpenMPSimd)
258       OpenMPRuntime.reset(new CGOpenMPSIMDRuntime(*this));
259     else
260       OpenMPRuntime.reset(new CGOpenMPRuntime(*this));
261     break;
262   }
263 }
264 
265 void CodeGenModule::createCUDARuntime() {
266   CUDARuntime.reset(CreateNVCUDARuntime(*this));
267 }
268 
269 void CodeGenModule::addReplacement(StringRef Name, llvm::Constant *C) {
270   Replacements[Name] = C;
271 }
272 
273 void CodeGenModule::applyReplacements() {
274   for (auto &I : Replacements) {
275     StringRef MangledName = I.first();
276     llvm::Constant *Replacement = I.second;
277     llvm::GlobalValue *Entry = GetGlobalValue(MangledName);
278     if (!Entry)
279       continue;
280     auto *OldF = cast<llvm::Function>(Entry);
281     auto *NewF = dyn_cast<llvm::Function>(Replacement);
282     if (!NewF) {
283       if (auto *Alias = dyn_cast<llvm::GlobalAlias>(Replacement)) {
284         NewF = dyn_cast<llvm::Function>(Alias->getAliasee());
285       } else {
286         auto *CE = cast<llvm::ConstantExpr>(Replacement);
287         assert(CE->getOpcode() == llvm::Instruction::BitCast ||
288                CE->getOpcode() == llvm::Instruction::GetElementPtr);
289         NewF = dyn_cast<llvm::Function>(CE->getOperand(0));
290       }
291     }
292 
293     // Replace old with new, but keep the old order.
294     OldF->replaceAllUsesWith(Replacement);
295     if (NewF) {
296       NewF->removeFromParent();
297       OldF->getParent()->getFunctionList().insertAfter(OldF->getIterator(),
298                                                        NewF);
299     }
300     OldF->eraseFromParent();
301   }
302 }
303 
304 void CodeGenModule::addGlobalValReplacement(llvm::GlobalValue *GV, llvm::Constant *C) {
305   GlobalValReplacements.push_back(std::make_pair(GV, C));
306 }
307 
308 void CodeGenModule::applyGlobalValReplacements() {
309   for (auto &I : GlobalValReplacements) {
310     llvm::GlobalValue *GV = I.first;
311     llvm::Constant *C = I.second;
312 
313     GV->replaceAllUsesWith(C);
314     GV->eraseFromParent();
315   }
316 }
317 
318 // This is only used in aliases that we created and we know they have a
319 // linear structure.
320 static const llvm::GlobalObject *getAliasedGlobal(
321     const llvm::GlobalIndirectSymbol &GIS) {
322   llvm::SmallPtrSet<const llvm::GlobalIndirectSymbol*, 4> Visited;
323   const llvm::Constant *C = &GIS;
324   for (;;) {
325     C = C->stripPointerCasts();
326     if (auto *GO = dyn_cast<llvm::GlobalObject>(C))
327       return GO;
328     // stripPointerCasts will not walk over weak aliases.
329     auto *GIS2 = dyn_cast<llvm::GlobalIndirectSymbol>(C);
330     if (!GIS2)
331       return nullptr;
332     if (!Visited.insert(GIS2).second)
333       return nullptr;
334     C = GIS2->getIndirectSymbol();
335   }
336 }
337 
338 void CodeGenModule::checkAliases() {
339   // Check if the constructed aliases are well formed. It is really unfortunate
340   // that we have to do this in CodeGen, but we only construct mangled names
341   // and aliases during codegen.
342   bool Error = false;
343   DiagnosticsEngine &Diags = getDiags();
344   for (const GlobalDecl &GD : Aliases) {
345     const auto *D = cast<ValueDecl>(GD.getDecl());
346     SourceLocation Location;
347     bool IsIFunc = D->hasAttr<IFuncAttr>();
348     if (const Attr *A = D->getDefiningAttr())
349       Location = A->getLocation();
350     else
351       llvm_unreachable("Not an alias or ifunc?");
352     StringRef MangledName = getMangledName(GD);
353     llvm::GlobalValue *Entry = GetGlobalValue(MangledName);
354     auto *Alias  = cast<llvm::GlobalIndirectSymbol>(Entry);
355     const llvm::GlobalValue *GV = getAliasedGlobal(*Alias);
356     if (!GV) {
357       Error = true;
358       Diags.Report(Location, diag::err_cyclic_alias) << IsIFunc;
359     } else if (GV->isDeclaration()) {
360       Error = true;
361       Diags.Report(Location, diag::err_alias_to_undefined)
362           << IsIFunc << IsIFunc;
363     } else if (IsIFunc) {
364       // Check resolver function type.
365       llvm::FunctionType *FTy = dyn_cast<llvm::FunctionType>(
366           GV->getType()->getPointerElementType());
367       assert(FTy);
368       if (!FTy->getReturnType()->isPointerTy())
369         Diags.Report(Location, diag::err_ifunc_resolver_return);
370     }
371 
372     llvm::Constant *Aliasee = Alias->getIndirectSymbol();
373     llvm::GlobalValue *AliaseeGV;
374     if (auto CE = dyn_cast<llvm::ConstantExpr>(Aliasee))
375       AliaseeGV = cast<llvm::GlobalValue>(CE->getOperand(0));
376     else
377       AliaseeGV = cast<llvm::GlobalValue>(Aliasee);
378 
379     if (const SectionAttr *SA = D->getAttr<SectionAttr>()) {
380       StringRef AliasSection = SA->getName();
381       if (AliasSection != AliaseeGV->getSection())
382         Diags.Report(SA->getLocation(), diag::warn_alias_with_section)
383             << AliasSection << IsIFunc << IsIFunc;
384     }
385 
386     // We have to handle alias to weak aliases in here. LLVM itself disallows
387     // this since the object semantics would not match the IL one. For
388     // compatibility with gcc we implement it by just pointing the alias
389     // to its aliasee's aliasee. We also warn, since the user is probably
390     // expecting the link to be weak.
391     if (auto GA = dyn_cast<llvm::GlobalIndirectSymbol>(AliaseeGV)) {
392       if (GA->isInterposable()) {
393         Diags.Report(Location, diag::warn_alias_to_weak_alias)
394             << GV->getName() << GA->getName() << IsIFunc;
395         Aliasee = llvm::ConstantExpr::getPointerBitCastOrAddrSpaceCast(
396             GA->getIndirectSymbol(), Alias->getType());
397         Alias->setIndirectSymbol(Aliasee);
398       }
399     }
400   }
401   if (!Error)
402     return;
403 
404   for (const GlobalDecl &GD : Aliases) {
405     StringRef MangledName = getMangledName(GD);
406     llvm::GlobalValue *Entry = GetGlobalValue(MangledName);
407     auto *Alias = cast<llvm::GlobalIndirectSymbol>(Entry);
408     Alias->replaceAllUsesWith(llvm::UndefValue::get(Alias->getType()));
409     Alias->eraseFromParent();
410   }
411 }
412 
413 void CodeGenModule::clear() {
414   DeferredDeclsToEmit.clear();
415   if (OpenMPRuntime)
416     OpenMPRuntime->clear();
417 }
418 
419 void InstrProfStats::reportDiagnostics(DiagnosticsEngine &Diags,
420                                        StringRef MainFile) {
421   if (!hasDiagnostics())
422     return;
423   if (VisitedInMainFile > 0 && VisitedInMainFile == MissingInMainFile) {
424     if (MainFile.empty())
425       MainFile = "<stdin>";
426     Diags.Report(diag::warn_profile_data_unprofiled) << MainFile;
427   } else {
428     if (Mismatched > 0)
429       Diags.Report(diag::warn_profile_data_out_of_date) << Visited << Mismatched;
430 
431     if (Missing > 0)
432       Diags.Report(diag::warn_profile_data_missing) << Visited << Missing;
433   }
434 }
435 
436 static void setVisibilityFromDLLStorageClass(const clang::LangOptions &LO,
437                                              llvm::Module &M) {
438   if (!LO.VisibilityFromDLLStorageClass)
439     return;
440 
441   llvm::GlobalValue::VisibilityTypes DLLExportVisibility =
442       CodeGenModule::GetLLVMVisibility(LO.getDLLExportVisibility());
443   llvm::GlobalValue::VisibilityTypes NoDLLStorageClassVisibility =
444       CodeGenModule::GetLLVMVisibility(LO.getNoDLLStorageClassVisibility());
445   llvm::GlobalValue::VisibilityTypes ExternDeclDLLImportVisibility =
446       CodeGenModule::GetLLVMVisibility(LO.getExternDeclDLLImportVisibility());
447   llvm::GlobalValue::VisibilityTypes ExternDeclNoDLLStorageClassVisibility =
448       CodeGenModule::GetLLVMVisibility(
449           LO.getExternDeclNoDLLStorageClassVisibility());
450 
451   for (llvm::GlobalValue &GV : M.global_values()) {
452     if (GV.hasAppendingLinkage() || GV.hasLocalLinkage())
453       continue;
454 
455     // Reset DSO locality before setting the visibility. This removes
456     // any effects that visibility options and annotations may have
457     // had on the DSO locality. Setting the visibility will implicitly set
458     // appropriate globals to DSO Local; however, this will be pessimistic
459     // w.r.t. to the normal compiler IRGen.
460     GV.setDSOLocal(false);
461 
462     if (GV.isDeclarationForLinker()) {
463       GV.setVisibility(GV.getDLLStorageClass() ==
464                                llvm::GlobalValue::DLLImportStorageClass
465                            ? ExternDeclDLLImportVisibility
466                            : ExternDeclNoDLLStorageClassVisibility);
467     } else {
468       GV.setVisibility(GV.getDLLStorageClass() ==
469                                llvm::GlobalValue::DLLExportStorageClass
470                            ? DLLExportVisibility
471                            : NoDLLStorageClassVisibility);
472     }
473 
474     GV.setDLLStorageClass(llvm::GlobalValue::DefaultStorageClass);
475   }
476 }
477 
478 void CodeGenModule::Release() {
479   EmitDeferred();
480   EmitVTablesOpportunistically();
481   applyGlobalValReplacements();
482   applyReplacements();
483   checkAliases();
484   emitMultiVersionFunctions();
485   EmitCXXGlobalInitFunc();
486   EmitCXXGlobalCleanUpFunc();
487   registerGlobalDtorsWithAtExit();
488   EmitCXXThreadLocalInitFunc();
489   if (ObjCRuntime)
490     if (llvm::Function *ObjCInitFunction = ObjCRuntime->ModuleInitFunction())
491       AddGlobalCtor(ObjCInitFunction);
492   if (Context.getLangOpts().CUDA && CUDARuntime) {
493     if (llvm::Function *CudaCtorFunction = CUDARuntime->finalizeModule())
494       AddGlobalCtor(CudaCtorFunction);
495   }
496   if (OpenMPRuntime) {
497     if (llvm::Function *OpenMPRequiresDirectiveRegFun =
498             OpenMPRuntime->emitRequiresDirectiveRegFun()) {
499       AddGlobalCtor(OpenMPRequiresDirectiveRegFun, 0);
500     }
501     OpenMPRuntime->createOffloadEntriesAndInfoMetadata();
502     OpenMPRuntime->clear();
503   }
504   if (PGOReader) {
505     getModule().setProfileSummary(
506         PGOReader->getSummary(/* UseCS */ false).getMD(VMContext),
507         llvm::ProfileSummary::PSK_Instr);
508     if (PGOStats.hasDiagnostics())
509       PGOStats.reportDiagnostics(getDiags(), getCodeGenOpts().MainFileName);
510   }
511   EmitCtorList(GlobalCtors, "llvm.global_ctors");
512   EmitCtorList(GlobalDtors, "llvm.global_dtors");
513   EmitGlobalAnnotations();
514   EmitStaticExternCAliases();
515   EmitDeferredUnusedCoverageMappings();
516   CodeGenPGO(*this).setValueProfilingFlag(getModule());
517   if (CoverageMapping)
518     CoverageMapping->emit();
519   if (CodeGenOpts.SanitizeCfiCrossDso) {
520     CodeGenFunction(*this).EmitCfiCheckFail();
521     CodeGenFunction(*this).EmitCfiCheckStub();
522   }
523   emitAtAvailableLinkGuard();
524   if (Context.getTargetInfo().getTriple().isWasm() &&
525       !Context.getTargetInfo().getTriple().isOSEmscripten()) {
526     EmitMainVoidAlias();
527   }
528 
529   // Emit reference of __amdgpu_device_library_preserve_asan_functions to
530   // preserve ASAN functions in bitcode libraries.
531   if (LangOpts.Sanitize.has(SanitizerKind::Address) && getTriple().isAMDGPU()) {
532     auto *FT = llvm::FunctionType::get(VoidTy, {});
533     auto *F = llvm::Function::Create(
534         FT, llvm::GlobalValue::ExternalLinkage,
535         "__amdgpu_device_library_preserve_asan_functions", &getModule());
536     auto *Var = new llvm::GlobalVariable(
537         getModule(), FT->getPointerTo(),
538         /*isConstant=*/true, llvm::GlobalValue::WeakAnyLinkage, F,
539         "__amdgpu_device_library_preserve_asan_functions_ptr", nullptr,
540         llvm::GlobalVariable::NotThreadLocal);
541     addCompilerUsedGlobal(Var);
542   }
543 
544   emitLLVMUsed();
545   if (SanStats)
546     SanStats->finish();
547 
548   if (CodeGenOpts.Autolink &&
549       (Context.getLangOpts().Modules || !LinkerOptionsMetadata.empty())) {
550     EmitModuleLinkOptions();
551   }
552 
553   // On ELF we pass the dependent library specifiers directly to the linker
554   // without manipulating them. This is in contrast to other platforms where
555   // they are mapped to a specific linker option by the compiler. This
556   // difference is a result of the greater variety of ELF linkers and the fact
557   // that ELF linkers tend to handle libraries in a more complicated fashion
558   // than on other platforms. This forces us to defer handling the dependent
559   // libs to the linker.
560   //
561   // CUDA/HIP device and host libraries are different. Currently there is no
562   // way to differentiate dependent libraries for host or device. Existing
563   // usage of #pragma comment(lib, *) is intended for host libraries on
564   // Windows. Therefore emit llvm.dependent-libraries only for host.
565   if (!ELFDependentLibraries.empty() && !Context.getLangOpts().CUDAIsDevice) {
566     auto *NMD = getModule().getOrInsertNamedMetadata("llvm.dependent-libraries");
567     for (auto *MD : ELFDependentLibraries)
568       NMD->addOperand(MD);
569   }
570 
571   // Record mregparm value now so it is visible through rest of codegen.
572   if (Context.getTargetInfo().getTriple().getArch() == llvm::Triple::x86)
573     getModule().addModuleFlag(llvm::Module::Error, "NumRegisterParameters",
574                               CodeGenOpts.NumRegisterParameters);
575 
576   if (CodeGenOpts.DwarfVersion) {
577     getModule().addModuleFlag(llvm::Module::Max, "Dwarf Version",
578                               CodeGenOpts.DwarfVersion);
579   }
580 
581   if (CodeGenOpts.Dwarf64)
582     getModule().addModuleFlag(llvm::Module::Max, "DWARF64", 1);
583 
584   if (Context.getLangOpts().SemanticInterposition)
585     // Require various optimization to respect semantic interposition.
586     getModule().setSemanticInterposition(1);
587 
588   if (CodeGenOpts.EmitCodeView) {
589     // Indicate that we want CodeView in the metadata.
590     getModule().addModuleFlag(llvm::Module::Warning, "CodeView", 1);
591   }
592   if (CodeGenOpts.CodeViewGHash) {
593     getModule().addModuleFlag(llvm::Module::Warning, "CodeViewGHash", 1);
594   }
595   if (CodeGenOpts.ControlFlowGuard) {
596     // Function ID tables and checks for Control Flow Guard (cfguard=2).
597     getModule().addModuleFlag(llvm::Module::Warning, "cfguard", 2);
598   } else if (CodeGenOpts.ControlFlowGuardNoChecks) {
599     // Function ID tables for Control Flow Guard (cfguard=1).
600     getModule().addModuleFlag(llvm::Module::Warning, "cfguard", 1);
601   }
602   if (CodeGenOpts.EHContGuard) {
603     // Function ID tables for EH Continuation Guard.
604     getModule().addModuleFlag(llvm::Module::Warning, "ehcontguard", 1);
605   }
606   if (CodeGenOpts.OptimizationLevel > 0 && CodeGenOpts.StrictVTablePointers) {
607     // We don't support LTO with 2 with different StrictVTablePointers
608     // FIXME: we could support it by stripping all the information introduced
609     // by StrictVTablePointers.
610 
611     getModule().addModuleFlag(llvm::Module::Error, "StrictVTablePointers",1);
612 
613     llvm::Metadata *Ops[2] = {
614               llvm::MDString::get(VMContext, "StrictVTablePointers"),
615               llvm::ConstantAsMetadata::get(llvm::ConstantInt::get(
616                   llvm::Type::getInt32Ty(VMContext), 1))};
617 
618     getModule().addModuleFlag(llvm::Module::Require,
619                               "StrictVTablePointersRequirement",
620                               llvm::MDNode::get(VMContext, Ops));
621   }
622   if (getModuleDebugInfo())
623     // We support a single version in the linked module. The LLVM
624     // parser will drop debug info with a different version number
625     // (and warn about it, too).
626     getModule().addModuleFlag(llvm::Module::Warning, "Debug Info Version",
627                               llvm::DEBUG_METADATA_VERSION);
628 
629   // We need to record the widths of enums and wchar_t, so that we can generate
630   // the correct build attributes in the ARM backend. wchar_size is also used by
631   // TargetLibraryInfo.
632   uint64_t WCharWidth =
633       Context.getTypeSizeInChars(Context.getWideCharType()).getQuantity();
634   getModule().addModuleFlag(llvm::Module::Error, "wchar_size", WCharWidth);
635 
636   llvm::Triple::ArchType Arch = Context.getTargetInfo().getTriple().getArch();
637   if (   Arch == llvm::Triple::arm
638       || Arch == llvm::Triple::armeb
639       || Arch == llvm::Triple::thumb
640       || Arch == llvm::Triple::thumbeb) {
641     // The minimum width of an enum in bytes
642     uint64_t EnumWidth = Context.getLangOpts().ShortEnums ? 1 : 4;
643     getModule().addModuleFlag(llvm::Module::Error, "min_enum_size", EnumWidth);
644   }
645 
646   if (Arch == llvm::Triple::riscv32 || Arch == llvm::Triple::riscv64) {
647     StringRef ABIStr = Target.getABI();
648     llvm::LLVMContext &Ctx = TheModule.getContext();
649     getModule().addModuleFlag(llvm::Module::Error, "target-abi",
650                               llvm::MDString::get(Ctx, ABIStr));
651   }
652 
653   if (CodeGenOpts.SanitizeCfiCrossDso) {
654     // Indicate that we want cross-DSO control flow integrity checks.
655     getModule().addModuleFlag(llvm::Module::Override, "Cross-DSO CFI", 1);
656   }
657 
658   if (CodeGenOpts.WholeProgramVTables) {
659     // Indicate whether VFE was enabled for this module, so that the
660     // vcall_visibility metadata added under whole program vtables is handled
661     // appropriately in the optimizer.
662     getModule().addModuleFlag(llvm::Module::Error, "Virtual Function Elim",
663                               CodeGenOpts.VirtualFunctionElimination);
664   }
665 
666   if (LangOpts.Sanitize.has(SanitizerKind::CFIICall)) {
667     getModule().addModuleFlag(llvm::Module::Override,
668                               "CFI Canonical Jump Tables",
669                               CodeGenOpts.SanitizeCfiCanonicalJumpTables);
670   }
671 
672   if (CodeGenOpts.CFProtectionReturn &&
673       Target.checkCFProtectionReturnSupported(getDiags())) {
674     // Indicate that we want to instrument return control flow protection.
675     getModule().addModuleFlag(llvm::Module::Override, "cf-protection-return",
676                               1);
677   }
678 
679   if (CodeGenOpts.CFProtectionBranch &&
680       Target.checkCFProtectionBranchSupported(getDiags())) {
681     // Indicate that we want to instrument branch control flow protection.
682     getModule().addModuleFlag(llvm::Module::Override, "cf-protection-branch",
683                               1);
684   }
685 
686   if (Arch == llvm::Triple::aarch64 || Arch == llvm::Triple::aarch64_32 ||
687       Arch == llvm::Triple::aarch64_be) {
688     getModule().addModuleFlag(llvm::Module::Error,
689                               "branch-target-enforcement",
690                               LangOpts.BranchTargetEnforcement);
691 
692     getModule().addModuleFlag(llvm::Module::Error, "sign-return-address",
693                               LangOpts.hasSignReturnAddress());
694 
695     getModule().addModuleFlag(llvm::Module::Error, "sign-return-address-all",
696                               LangOpts.isSignReturnAddressScopeAll());
697 
698     getModule().addModuleFlag(llvm::Module::Error,
699                               "sign-return-address-with-bkey",
700                               !LangOpts.isSignReturnAddressWithAKey());
701   }
702 
703   if (!CodeGenOpts.MemoryProfileOutput.empty()) {
704     llvm::LLVMContext &Ctx = TheModule.getContext();
705     getModule().addModuleFlag(
706         llvm::Module::Error, "MemProfProfileFilename",
707         llvm::MDString::get(Ctx, CodeGenOpts.MemoryProfileOutput));
708   }
709 
710   if (LangOpts.CUDAIsDevice && getTriple().isNVPTX()) {
711     // Indicate whether __nvvm_reflect should be configured to flush denormal
712     // floating point values to 0.  (This corresponds to its "__CUDA_FTZ"
713     // property.)
714     getModule().addModuleFlag(llvm::Module::Override, "nvvm-reflect-ftz",
715                               CodeGenOpts.FP32DenormalMode.Output !=
716                                   llvm::DenormalMode::IEEE);
717   }
718 
719   if (LangOpts.EHAsynch)
720     getModule().addModuleFlag(llvm::Module::Warning, "eh-asynch", 1);
721 
722   // Indicate whether this Module was compiled with -fopenmp
723   if (getLangOpts().OpenMP && !getLangOpts().OpenMPSimd)
724     getModule().addModuleFlag(llvm::Module::Max, "openmp", LangOpts.OpenMP);
725   if (getLangOpts().OpenMPIsDevice)
726     getModule().addModuleFlag(llvm::Module::Max, "openmp-device",
727                               LangOpts.OpenMP);
728 
729   // Emit OpenCL specific module metadata: OpenCL/SPIR version.
730   if (LangOpts.OpenCL) {
731     EmitOpenCLMetadata();
732     // Emit SPIR version.
733     if (getTriple().isSPIR()) {
734       // SPIR v2.0 s2.12 - The SPIR version used by the module is stored in the
735       // opencl.spir.version named metadata.
736       // C++ for OpenCL has a distinct mapping for version compatibility with
737       // OpenCL.
738       auto Version = LangOpts.getOpenCLCompatibleVersion();
739       llvm::Metadata *SPIRVerElts[] = {
740           llvm::ConstantAsMetadata::get(llvm::ConstantInt::get(
741               Int32Ty, Version / 100)),
742           llvm::ConstantAsMetadata::get(llvm::ConstantInt::get(
743               Int32Ty, (Version / 100 > 1) ? 0 : 2))};
744       llvm::NamedMDNode *SPIRVerMD =
745           TheModule.getOrInsertNamedMetadata("opencl.spir.version");
746       llvm::LLVMContext &Ctx = TheModule.getContext();
747       SPIRVerMD->addOperand(llvm::MDNode::get(Ctx, SPIRVerElts));
748     }
749   }
750 
751   if (uint32_t PLevel = Context.getLangOpts().PICLevel) {
752     assert(PLevel < 3 && "Invalid PIC Level");
753     getModule().setPICLevel(static_cast<llvm::PICLevel::Level>(PLevel));
754     if (Context.getLangOpts().PIE)
755       getModule().setPIELevel(static_cast<llvm::PIELevel::Level>(PLevel));
756   }
757 
758   if (getCodeGenOpts().CodeModel.size() > 0) {
759     unsigned CM = llvm::StringSwitch<unsigned>(getCodeGenOpts().CodeModel)
760                   .Case("tiny", llvm::CodeModel::Tiny)
761                   .Case("small", llvm::CodeModel::Small)
762                   .Case("kernel", llvm::CodeModel::Kernel)
763                   .Case("medium", llvm::CodeModel::Medium)
764                   .Case("large", llvm::CodeModel::Large)
765                   .Default(~0u);
766     if (CM != ~0u) {
767       llvm::CodeModel::Model codeModel = static_cast<llvm::CodeModel::Model>(CM);
768       getModule().setCodeModel(codeModel);
769     }
770   }
771 
772   if (CodeGenOpts.NoPLT)
773     getModule().setRtLibUseGOT();
774   if (CodeGenOpts.UnwindTables)
775     getModule().setUwtable();
776 
777   switch (CodeGenOpts.getFramePointer()) {
778   case CodeGenOptions::FramePointerKind::None:
779     // 0 ("none") is the default.
780     break;
781   case CodeGenOptions::FramePointerKind::NonLeaf:
782     getModule().setFramePointer(llvm::FramePointerKind::NonLeaf);
783     break;
784   case CodeGenOptions::FramePointerKind::All:
785     getModule().setFramePointer(llvm::FramePointerKind::All);
786     break;
787   }
788 
789   SimplifyPersonality();
790 
791   if (getCodeGenOpts().EmitDeclMetadata)
792     EmitDeclMetadata();
793 
794   if (getCodeGenOpts().EmitGcovArcs || getCodeGenOpts().EmitGcovNotes)
795     EmitCoverageFile();
796 
797   if (CGDebugInfo *DI = getModuleDebugInfo())
798     DI->finalize();
799 
800   if (getCodeGenOpts().EmitVersionIdentMetadata)
801     EmitVersionIdentMetadata();
802 
803   if (!getCodeGenOpts().RecordCommandLine.empty())
804     EmitCommandLineMetadata();
805 
806   if (!getCodeGenOpts().StackProtectorGuard.empty())
807     getModule().setStackProtectorGuard(getCodeGenOpts().StackProtectorGuard);
808   if (!getCodeGenOpts().StackProtectorGuardReg.empty())
809     getModule().setStackProtectorGuardReg(
810         getCodeGenOpts().StackProtectorGuardReg);
811   if (getCodeGenOpts().StackProtectorGuardOffset != INT_MAX)
812     getModule().setStackProtectorGuardOffset(
813         getCodeGenOpts().StackProtectorGuardOffset);
814   if (getCodeGenOpts().StackAlignment)
815     getModule().setOverrideStackAlignment(getCodeGenOpts().StackAlignment);
816 
817   getTargetCodeGenInfo().emitTargetMetadata(*this, MangledDeclNames);
818 
819   EmitBackendOptionsMetadata(getCodeGenOpts());
820 
821   // Set visibility from DLL storage class
822   // We do this at the end of LLVM IR generation; after any operation
823   // that might affect the DLL storage class or the visibility, and
824   // before anything that might act on these.
825   setVisibilityFromDLLStorageClass(LangOpts, getModule());
826 }
827 
828 void CodeGenModule::EmitOpenCLMetadata() {
829   // SPIR v2.0 s2.13 - The OpenCL version used by the module is stored in the
830   // opencl.ocl.version named metadata node.
831   // C++ for OpenCL has a distinct mapping for versions compatibile with OpenCL.
832   auto Version = LangOpts.getOpenCLCompatibleVersion();
833   llvm::Metadata *OCLVerElts[] = {
834       llvm::ConstantAsMetadata::get(llvm::ConstantInt::get(
835           Int32Ty, Version / 100)),
836       llvm::ConstantAsMetadata::get(llvm::ConstantInt::get(
837           Int32Ty, (Version % 100) / 10))};
838   llvm::NamedMDNode *OCLVerMD =
839       TheModule.getOrInsertNamedMetadata("opencl.ocl.version");
840   llvm::LLVMContext &Ctx = TheModule.getContext();
841   OCLVerMD->addOperand(llvm::MDNode::get(Ctx, OCLVerElts));
842 }
843 
844 void CodeGenModule::EmitBackendOptionsMetadata(
845     const CodeGenOptions CodeGenOpts) {
846   switch (getTriple().getArch()) {
847   default:
848     break;
849   case llvm::Triple::riscv32:
850   case llvm::Triple::riscv64:
851     getModule().addModuleFlag(llvm::Module::Error, "SmallDataLimit",
852                               CodeGenOpts.SmallDataLimit);
853     break;
854   }
855 }
856 
857 void CodeGenModule::UpdateCompletedType(const TagDecl *TD) {
858   // Make sure that this type is translated.
859   Types.UpdateCompletedType(TD);
860 }
861 
862 void CodeGenModule::RefreshTypeCacheForClass(const CXXRecordDecl *RD) {
863   // Make sure that this type is translated.
864   Types.RefreshTypeCacheForClass(RD);
865 }
866 
867 llvm::MDNode *CodeGenModule::getTBAATypeInfo(QualType QTy) {
868   if (!TBAA)
869     return nullptr;
870   return TBAA->getTypeInfo(QTy);
871 }
872 
873 TBAAAccessInfo CodeGenModule::getTBAAAccessInfo(QualType AccessType) {
874   if (!TBAA)
875     return TBAAAccessInfo();
876   if (getLangOpts().CUDAIsDevice) {
877     // As CUDA builtin surface/texture types are replaced, skip generating TBAA
878     // access info.
879     if (AccessType->isCUDADeviceBuiltinSurfaceType()) {
880       if (getTargetCodeGenInfo().getCUDADeviceBuiltinSurfaceDeviceType() !=
881           nullptr)
882         return TBAAAccessInfo();
883     } else if (AccessType->isCUDADeviceBuiltinTextureType()) {
884       if (getTargetCodeGenInfo().getCUDADeviceBuiltinTextureDeviceType() !=
885           nullptr)
886         return TBAAAccessInfo();
887     }
888   }
889   return TBAA->getAccessInfo(AccessType);
890 }
891 
892 TBAAAccessInfo
893 CodeGenModule::getTBAAVTablePtrAccessInfo(llvm::Type *VTablePtrType) {
894   if (!TBAA)
895     return TBAAAccessInfo();
896   return TBAA->getVTablePtrAccessInfo(VTablePtrType);
897 }
898 
899 llvm::MDNode *CodeGenModule::getTBAAStructInfo(QualType QTy) {
900   if (!TBAA)
901     return nullptr;
902   return TBAA->getTBAAStructInfo(QTy);
903 }
904 
905 llvm::MDNode *CodeGenModule::getTBAABaseTypeInfo(QualType QTy) {
906   if (!TBAA)
907     return nullptr;
908   return TBAA->getBaseTypeInfo(QTy);
909 }
910 
911 llvm::MDNode *CodeGenModule::getTBAAAccessTagInfo(TBAAAccessInfo Info) {
912   if (!TBAA)
913     return nullptr;
914   return TBAA->getAccessTagInfo(Info);
915 }
916 
917 TBAAAccessInfo CodeGenModule::mergeTBAAInfoForCast(TBAAAccessInfo SourceInfo,
918                                                    TBAAAccessInfo TargetInfo) {
919   if (!TBAA)
920     return TBAAAccessInfo();
921   return TBAA->mergeTBAAInfoForCast(SourceInfo, TargetInfo);
922 }
923 
924 TBAAAccessInfo
925 CodeGenModule::mergeTBAAInfoForConditionalOperator(TBAAAccessInfo InfoA,
926                                                    TBAAAccessInfo InfoB) {
927   if (!TBAA)
928     return TBAAAccessInfo();
929   return TBAA->mergeTBAAInfoForConditionalOperator(InfoA, InfoB);
930 }
931 
932 TBAAAccessInfo
933 CodeGenModule::mergeTBAAInfoForMemoryTransfer(TBAAAccessInfo DestInfo,
934                                               TBAAAccessInfo SrcInfo) {
935   if (!TBAA)
936     return TBAAAccessInfo();
937   return TBAA->mergeTBAAInfoForConditionalOperator(DestInfo, SrcInfo);
938 }
939 
940 void CodeGenModule::DecorateInstructionWithTBAA(llvm::Instruction *Inst,
941                                                 TBAAAccessInfo TBAAInfo) {
942   if (llvm::MDNode *Tag = getTBAAAccessTagInfo(TBAAInfo))
943     Inst->setMetadata(llvm::LLVMContext::MD_tbaa, Tag);
944 }
945 
946 void CodeGenModule::DecorateInstructionWithInvariantGroup(
947     llvm::Instruction *I, const CXXRecordDecl *RD) {
948   I->setMetadata(llvm::LLVMContext::MD_invariant_group,
949                  llvm::MDNode::get(getLLVMContext(), {}));
950 }
951 
952 void CodeGenModule::Error(SourceLocation loc, StringRef message) {
953   unsigned diagID = getDiags().getCustomDiagID(DiagnosticsEngine::Error, "%0");
954   getDiags().Report(Context.getFullLoc(loc), diagID) << message;
955 }
956 
957 /// ErrorUnsupported - Print out an error that codegen doesn't support the
958 /// specified stmt yet.
959 void CodeGenModule::ErrorUnsupported(const Stmt *S, const char *Type) {
960   unsigned DiagID = getDiags().getCustomDiagID(DiagnosticsEngine::Error,
961                                                "cannot compile this %0 yet");
962   std::string Msg = Type;
963   getDiags().Report(Context.getFullLoc(S->getBeginLoc()), DiagID)
964       << Msg << S->getSourceRange();
965 }
966 
967 /// ErrorUnsupported - Print out an error that codegen doesn't support the
968 /// specified decl yet.
969 void CodeGenModule::ErrorUnsupported(const Decl *D, const char *Type) {
970   unsigned DiagID = getDiags().getCustomDiagID(DiagnosticsEngine::Error,
971                                                "cannot compile this %0 yet");
972   std::string Msg = Type;
973   getDiags().Report(Context.getFullLoc(D->getLocation()), DiagID) << Msg;
974 }
975 
976 llvm::ConstantInt *CodeGenModule::getSize(CharUnits size) {
977   return llvm::ConstantInt::get(SizeTy, size.getQuantity());
978 }
979 
980 void CodeGenModule::setGlobalVisibility(llvm::GlobalValue *GV,
981                                         const NamedDecl *D) const {
982   if (GV->hasDLLImportStorageClass())
983     return;
984   // Internal definitions always have default visibility.
985   if (GV->hasLocalLinkage()) {
986     GV->setVisibility(llvm::GlobalValue::DefaultVisibility);
987     return;
988   }
989   if (!D)
990     return;
991   // Set visibility for definitions, and for declarations if requested globally
992   // or set explicitly.
993   LinkageInfo LV = D->getLinkageAndVisibility();
994   if (LV.isVisibilityExplicit() || getLangOpts().SetVisibilityForExternDecls ||
995       !GV->isDeclarationForLinker())
996     GV->setVisibility(GetLLVMVisibility(LV.getVisibility()));
997 }
998 
999 static bool shouldAssumeDSOLocal(const CodeGenModule &CGM,
1000                                  llvm::GlobalValue *GV) {
1001   if (GV->hasLocalLinkage())
1002     return true;
1003 
1004   if (!GV->hasDefaultVisibility() && !GV->hasExternalWeakLinkage())
1005     return true;
1006 
1007   // DLLImport explicitly marks the GV as external.
1008   if (GV->hasDLLImportStorageClass())
1009     return false;
1010 
1011   const llvm::Triple &TT = CGM.getTriple();
1012   if (TT.isWindowsGNUEnvironment()) {
1013     // In MinGW, variables without DLLImport can still be automatically
1014     // imported from a DLL by the linker; don't mark variables that
1015     // potentially could come from another DLL as DSO local.
1016 
1017     // With EmulatedTLS, TLS variables can be autoimported from other DLLs
1018     // (and this actually happens in the public interface of libstdc++), so
1019     // such variables can't be marked as DSO local. (Native TLS variables
1020     // can't be dllimported at all, though.)
1021     if (GV->isDeclarationForLinker() && isa<llvm::GlobalVariable>(GV) &&
1022         (!GV->isThreadLocal() || CGM.getCodeGenOpts().EmulatedTLS))
1023       return false;
1024   }
1025 
1026   // On COFF, don't mark 'extern_weak' symbols as DSO local. If these symbols
1027   // remain unresolved in the link, they can be resolved to zero, which is
1028   // outside the current DSO.
1029   if (TT.isOSBinFormatCOFF() && GV->hasExternalWeakLinkage())
1030     return false;
1031 
1032   // Every other GV is local on COFF.
1033   // Make an exception for windows OS in the triple: Some firmware builds use
1034   // *-win32-macho triples. This (accidentally?) produced windows relocations
1035   // without GOT tables in older clang versions; Keep this behaviour.
1036   // FIXME: even thread local variables?
1037   if (TT.isOSBinFormatCOFF() || (TT.isOSWindows() && TT.isOSBinFormatMachO()))
1038     return true;
1039 
1040   // Only handle COFF and ELF for now.
1041   if (!TT.isOSBinFormatELF())
1042     return false;
1043 
1044   // If this is not an executable, don't assume anything is local.
1045   const auto &CGOpts = CGM.getCodeGenOpts();
1046   llvm::Reloc::Model RM = CGOpts.RelocationModel;
1047   const auto &LOpts = CGM.getLangOpts();
1048   if (RM != llvm::Reloc::Static && !LOpts.PIE) {
1049     // On ELF, if -fno-semantic-interposition is specified and the target
1050     // supports local aliases, there will be neither CC1
1051     // -fsemantic-interposition nor -fhalf-no-semantic-interposition. Set
1052     // dso_local on the function if using a local alias is preferable (can avoid
1053     // PLT indirection).
1054     if (!(isa<llvm::Function>(GV) && GV->canBenefitFromLocalAlias()))
1055       return false;
1056     return !(CGM.getLangOpts().SemanticInterposition ||
1057              CGM.getLangOpts().HalfNoSemanticInterposition);
1058   }
1059 
1060   // A definition cannot be preempted from an executable.
1061   if (!GV->isDeclarationForLinker())
1062     return true;
1063 
1064   // Most PIC code sequences that assume that a symbol is local cannot produce a
1065   // 0 if it turns out the symbol is undefined. While this is ABI and relocation
1066   // depended, it seems worth it to handle it here.
1067   if (RM == llvm::Reloc::PIC_ && GV->hasExternalWeakLinkage())
1068     return false;
1069 
1070   // PowerPC64 prefers TOC indirection to avoid copy relocations.
1071   if (TT.isPPC64())
1072     return false;
1073 
1074   if (CGOpts.DirectAccessExternalData) {
1075     // If -fdirect-access-external-data (default for -fno-pic), set dso_local
1076     // for non-thread-local variables. If the symbol is not defined in the
1077     // executable, a copy relocation will be needed at link time. dso_local is
1078     // excluded for thread-local variables because they generally don't support
1079     // copy relocations.
1080     if (auto *Var = dyn_cast<llvm::GlobalVariable>(GV))
1081       if (!Var->isThreadLocal())
1082         return true;
1083 
1084     // -fno-pic sets dso_local on a function declaration to allow direct
1085     // accesses when taking its address (similar to a data symbol). If the
1086     // function is not defined in the executable, a canonical PLT entry will be
1087     // needed at link time. -fno-direct-access-external-data can avoid the
1088     // canonical PLT entry. We don't generalize this condition to -fpie/-fpic as
1089     // it could just cause trouble without providing perceptible benefits.
1090     if (isa<llvm::Function>(GV) && !CGOpts.NoPLT && RM == llvm::Reloc::Static)
1091       return true;
1092   }
1093 
1094   // If we can use copy relocations we can assume it is local.
1095 
1096   // Otherwise don't assume it is local.
1097   return false;
1098 }
1099 
1100 void CodeGenModule::setDSOLocal(llvm::GlobalValue *GV) const {
1101   GV->setDSOLocal(shouldAssumeDSOLocal(*this, GV));
1102 }
1103 
1104 void CodeGenModule::setDLLImportDLLExport(llvm::GlobalValue *GV,
1105                                           GlobalDecl GD) const {
1106   const auto *D = dyn_cast<NamedDecl>(GD.getDecl());
1107   // C++ destructors have a few C++ ABI specific special cases.
1108   if (const auto *Dtor = dyn_cast_or_null<CXXDestructorDecl>(D)) {
1109     getCXXABI().setCXXDestructorDLLStorage(GV, Dtor, GD.getDtorType());
1110     return;
1111   }
1112   setDLLImportDLLExport(GV, D);
1113 }
1114 
1115 void CodeGenModule::setDLLImportDLLExport(llvm::GlobalValue *GV,
1116                                           const NamedDecl *D) const {
1117   if (D && D->isExternallyVisible()) {
1118     if (D->hasAttr<DLLImportAttr>())
1119       GV->setDLLStorageClass(llvm::GlobalVariable::DLLImportStorageClass);
1120     else if (D->hasAttr<DLLExportAttr>() && !GV->isDeclarationForLinker())
1121       GV->setDLLStorageClass(llvm::GlobalVariable::DLLExportStorageClass);
1122   }
1123 }
1124 
1125 void CodeGenModule::setGVProperties(llvm::GlobalValue *GV,
1126                                     GlobalDecl GD) const {
1127   setDLLImportDLLExport(GV, GD);
1128   setGVPropertiesAux(GV, dyn_cast<NamedDecl>(GD.getDecl()));
1129 }
1130 
1131 void CodeGenModule::setGVProperties(llvm::GlobalValue *GV,
1132                                     const NamedDecl *D) const {
1133   setDLLImportDLLExport(GV, D);
1134   setGVPropertiesAux(GV, D);
1135 }
1136 
1137 void CodeGenModule::setGVPropertiesAux(llvm::GlobalValue *GV,
1138                                        const NamedDecl *D) const {
1139   setGlobalVisibility(GV, D);
1140   setDSOLocal(GV);
1141   GV->setPartition(CodeGenOpts.SymbolPartition);
1142 }
1143 
1144 static llvm::GlobalVariable::ThreadLocalMode GetLLVMTLSModel(StringRef S) {
1145   return llvm::StringSwitch<llvm::GlobalVariable::ThreadLocalMode>(S)
1146       .Case("global-dynamic", llvm::GlobalVariable::GeneralDynamicTLSModel)
1147       .Case("local-dynamic", llvm::GlobalVariable::LocalDynamicTLSModel)
1148       .Case("initial-exec", llvm::GlobalVariable::InitialExecTLSModel)
1149       .Case("local-exec", llvm::GlobalVariable::LocalExecTLSModel);
1150 }
1151 
1152 llvm::GlobalVariable::ThreadLocalMode
1153 CodeGenModule::GetDefaultLLVMTLSModel() const {
1154   switch (CodeGenOpts.getDefaultTLSModel()) {
1155   case CodeGenOptions::GeneralDynamicTLSModel:
1156     return llvm::GlobalVariable::GeneralDynamicTLSModel;
1157   case CodeGenOptions::LocalDynamicTLSModel:
1158     return llvm::GlobalVariable::LocalDynamicTLSModel;
1159   case CodeGenOptions::InitialExecTLSModel:
1160     return llvm::GlobalVariable::InitialExecTLSModel;
1161   case CodeGenOptions::LocalExecTLSModel:
1162     return llvm::GlobalVariable::LocalExecTLSModel;
1163   }
1164   llvm_unreachable("Invalid TLS model!");
1165 }
1166 
1167 void CodeGenModule::setTLSMode(llvm::GlobalValue *GV, const VarDecl &D) const {
1168   assert(D.getTLSKind() && "setting TLS mode on non-TLS var!");
1169 
1170   llvm::GlobalValue::ThreadLocalMode TLM;
1171   TLM = GetDefaultLLVMTLSModel();
1172 
1173   // Override the TLS model if it is explicitly specified.
1174   if (const TLSModelAttr *Attr = D.getAttr<TLSModelAttr>()) {
1175     TLM = GetLLVMTLSModel(Attr->getModel());
1176   }
1177 
1178   GV->setThreadLocalMode(TLM);
1179 }
1180 
1181 static std::string getCPUSpecificMangling(const CodeGenModule &CGM,
1182                                           StringRef Name) {
1183   const TargetInfo &Target = CGM.getTarget();
1184   return (Twine('.') + Twine(Target.CPUSpecificManglingCharacter(Name))).str();
1185 }
1186 
1187 static void AppendCPUSpecificCPUDispatchMangling(const CodeGenModule &CGM,
1188                                                  const CPUSpecificAttr *Attr,
1189                                                  unsigned CPUIndex,
1190                                                  raw_ostream &Out) {
1191   // cpu_specific gets the current name, dispatch gets the resolver if IFunc is
1192   // supported.
1193   if (Attr)
1194     Out << getCPUSpecificMangling(CGM, Attr->getCPUName(CPUIndex)->getName());
1195   else if (CGM.getTarget().supportsIFunc())
1196     Out << ".resolver";
1197 }
1198 
1199 static void AppendTargetMangling(const CodeGenModule &CGM,
1200                                  const TargetAttr *Attr, raw_ostream &Out) {
1201   if (Attr->isDefaultVersion())
1202     return;
1203 
1204   Out << '.';
1205   const TargetInfo &Target = CGM.getTarget();
1206   ParsedTargetAttr Info =
1207       Attr->parse([&Target](StringRef LHS, StringRef RHS) {
1208         // Multiversioning doesn't allow "no-${feature}", so we can
1209         // only have "+" prefixes here.
1210         assert(LHS.startswith("+") && RHS.startswith("+") &&
1211                "Features should always have a prefix.");
1212         return Target.multiVersionSortPriority(LHS.substr(1)) >
1213                Target.multiVersionSortPriority(RHS.substr(1));
1214       });
1215 
1216   bool IsFirst = true;
1217 
1218   if (!Info.Architecture.empty()) {
1219     IsFirst = false;
1220     Out << "arch_" << Info.Architecture;
1221   }
1222 
1223   for (StringRef Feat : Info.Features) {
1224     if (!IsFirst)
1225       Out << '_';
1226     IsFirst = false;
1227     Out << Feat.substr(1);
1228   }
1229 }
1230 
1231 // Returns true if GD is a function decl with internal linkage and
1232 // needs a unique suffix after the mangled name.
1233 static bool isUniqueInternalLinkageDecl(GlobalDecl GD,
1234                                         CodeGenModule &CGM) {
1235   const Decl *D = GD.getDecl();
1236   return !CGM.getModuleNameHash().empty() && isa<FunctionDecl>(D) &&
1237          (CGM.getFunctionLinkage(GD) == llvm::GlobalValue::InternalLinkage);
1238 }
1239 
1240 static std::string getMangledNameImpl(CodeGenModule &CGM, GlobalDecl GD,
1241                                       const NamedDecl *ND,
1242                                       bool OmitMultiVersionMangling = false) {
1243   SmallString<256> Buffer;
1244   llvm::raw_svector_ostream Out(Buffer);
1245   MangleContext &MC = CGM.getCXXABI().getMangleContext();
1246   if (!CGM.getModuleNameHash().empty())
1247     MC.needsUniqueInternalLinkageNames();
1248   bool ShouldMangle = MC.shouldMangleDeclName(ND);
1249   if (ShouldMangle)
1250     MC.mangleName(GD.getWithDecl(ND), Out);
1251   else {
1252     IdentifierInfo *II = ND->getIdentifier();
1253     assert(II && "Attempt to mangle unnamed decl.");
1254     const auto *FD = dyn_cast<FunctionDecl>(ND);
1255 
1256     if (FD &&
1257         FD->getType()->castAs<FunctionType>()->getCallConv() == CC_X86RegCall) {
1258       Out << "__regcall3__" << II->getName();
1259     } else if (FD && FD->hasAttr<CUDAGlobalAttr>() &&
1260                GD.getKernelReferenceKind() == KernelReferenceKind::Stub) {
1261       Out << "__device_stub__" << II->getName();
1262     } else {
1263       Out << II->getName();
1264     }
1265   }
1266 
1267   // Check if the module name hash should be appended for internal linkage
1268   // symbols.   This should come before multi-version target suffixes are
1269   // appended. This is to keep the name and module hash suffix of the
1270   // internal linkage function together.  The unique suffix should only be
1271   // added when name mangling is done to make sure that the final name can
1272   // be properly demangled.  For example, for C functions without prototypes,
1273   // name mangling is not done and the unique suffix should not be appeneded
1274   // then.
1275   if (ShouldMangle && isUniqueInternalLinkageDecl(GD, CGM)) {
1276     assert(CGM.getCodeGenOpts().UniqueInternalLinkageNames &&
1277            "Hash computed when not explicitly requested");
1278     Out << CGM.getModuleNameHash();
1279   }
1280 
1281   if (const auto *FD = dyn_cast<FunctionDecl>(ND))
1282     if (FD->isMultiVersion() && !OmitMultiVersionMangling) {
1283       switch (FD->getMultiVersionKind()) {
1284       case MultiVersionKind::CPUDispatch:
1285       case MultiVersionKind::CPUSpecific:
1286         AppendCPUSpecificCPUDispatchMangling(CGM,
1287                                              FD->getAttr<CPUSpecificAttr>(),
1288                                              GD.getMultiVersionIndex(), Out);
1289         break;
1290       case MultiVersionKind::Target:
1291         AppendTargetMangling(CGM, FD->getAttr<TargetAttr>(), Out);
1292         break;
1293       case MultiVersionKind::None:
1294         llvm_unreachable("None multiversion type isn't valid here");
1295       }
1296     }
1297 
1298   // Make unique name for device side static file-scope variable for HIP.
1299   if (CGM.getContext().shouldExternalizeStaticVar(ND) &&
1300       CGM.getLangOpts().GPURelocatableDeviceCode &&
1301       CGM.getLangOpts().CUDAIsDevice && !CGM.getLangOpts().CUID.empty())
1302     CGM.printPostfixForExternalizedStaticVar(Out);
1303   return std::string(Out.str());
1304 }
1305 
1306 void CodeGenModule::UpdateMultiVersionNames(GlobalDecl GD,
1307                                             const FunctionDecl *FD) {
1308   if (!FD->isMultiVersion())
1309     return;
1310 
1311   // Get the name of what this would be without the 'target' attribute.  This
1312   // allows us to lookup the version that was emitted when this wasn't a
1313   // multiversion function.
1314   std::string NonTargetName =
1315       getMangledNameImpl(*this, GD, FD, /*OmitMultiVersionMangling=*/true);
1316   GlobalDecl OtherGD;
1317   if (lookupRepresentativeDecl(NonTargetName, OtherGD)) {
1318     assert(OtherGD.getCanonicalDecl()
1319                .getDecl()
1320                ->getAsFunction()
1321                ->isMultiVersion() &&
1322            "Other GD should now be a multiversioned function");
1323     // OtherFD is the version of this function that was mangled BEFORE
1324     // becoming a MultiVersion function.  It potentially needs to be updated.
1325     const FunctionDecl *OtherFD = OtherGD.getCanonicalDecl()
1326                                       .getDecl()
1327                                       ->getAsFunction()
1328                                       ->getMostRecentDecl();
1329     std::string OtherName = getMangledNameImpl(*this, OtherGD, OtherFD);
1330     // This is so that if the initial version was already the 'default'
1331     // version, we don't try to update it.
1332     if (OtherName != NonTargetName) {
1333       // Remove instead of erase, since others may have stored the StringRef
1334       // to this.
1335       const auto ExistingRecord = Manglings.find(NonTargetName);
1336       if (ExistingRecord != std::end(Manglings))
1337         Manglings.remove(&(*ExistingRecord));
1338       auto Result = Manglings.insert(std::make_pair(OtherName, OtherGD));
1339       MangledDeclNames[OtherGD.getCanonicalDecl()] = Result.first->first();
1340       if (llvm::GlobalValue *Entry = GetGlobalValue(NonTargetName))
1341         Entry->setName(OtherName);
1342     }
1343   }
1344 }
1345 
1346 StringRef CodeGenModule::getMangledName(GlobalDecl GD) {
1347   GlobalDecl CanonicalGD = GD.getCanonicalDecl();
1348 
1349   // Some ABIs don't have constructor variants.  Make sure that base and
1350   // complete constructors get mangled the same.
1351   if (const auto *CD = dyn_cast<CXXConstructorDecl>(CanonicalGD.getDecl())) {
1352     if (!getTarget().getCXXABI().hasConstructorVariants()) {
1353       CXXCtorType OrigCtorType = GD.getCtorType();
1354       assert(OrigCtorType == Ctor_Base || OrigCtorType == Ctor_Complete);
1355       if (OrigCtorType == Ctor_Base)
1356         CanonicalGD = GlobalDecl(CD, Ctor_Complete);
1357     }
1358   }
1359 
1360   // In CUDA/HIP device compilation with -fgpu-rdc, the mangled name of a
1361   // static device variable depends on whether the variable is referenced by
1362   // a host or device host function. Therefore the mangled name cannot be
1363   // cached.
1364   if (!LangOpts.CUDAIsDevice ||
1365       !getContext().mayExternalizeStaticVar(GD.getDecl())) {
1366     auto FoundName = MangledDeclNames.find(CanonicalGD);
1367     if (FoundName != MangledDeclNames.end())
1368       return FoundName->second;
1369   }
1370 
1371   // Keep the first result in the case of a mangling collision.
1372   const auto *ND = cast<NamedDecl>(GD.getDecl());
1373   std::string MangledName = getMangledNameImpl(*this, GD, ND);
1374 
1375   // Ensure either we have different ABIs between host and device compilations,
1376   // says host compilation following MSVC ABI but device compilation follows
1377   // Itanium C++ ABI or, if they follow the same ABI, kernel names after
1378   // mangling should be the same after name stubbing. The later checking is
1379   // very important as the device kernel name being mangled in host-compilation
1380   // is used to resolve the device binaries to be executed. Inconsistent naming
1381   // result in undefined behavior. Even though we cannot check that naming
1382   // directly between host- and device-compilations, the host- and
1383   // device-mangling in host compilation could help catching certain ones.
1384   assert(!isa<FunctionDecl>(ND) || !ND->hasAttr<CUDAGlobalAttr>() ||
1385          getLangOpts().CUDAIsDevice ||
1386          (getContext().getAuxTargetInfo() &&
1387           (getContext().getAuxTargetInfo()->getCXXABI() !=
1388            getContext().getTargetInfo().getCXXABI())) ||
1389          getCUDARuntime().getDeviceSideName(ND) ==
1390              getMangledNameImpl(
1391                  *this,
1392                  GD.getWithKernelReferenceKind(KernelReferenceKind::Kernel),
1393                  ND));
1394 
1395   auto Result = Manglings.insert(std::make_pair(MangledName, GD));
1396   return MangledDeclNames[CanonicalGD] = Result.first->first();
1397 }
1398 
1399 StringRef CodeGenModule::getBlockMangledName(GlobalDecl GD,
1400                                              const BlockDecl *BD) {
1401   MangleContext &MangleCtx = getCXXABI().getMangleContext();
1402   const Decl *D = GD.getDecl();
1403 
1404   SmallString<256> Buffer;
1405   llvm::raw_svector_ostream Out(Buffer);
1406   if (!D)
1407     MangleCtx.mangleGlobalBlock(BD,
1408       dyn_cast_or_null<VarDecl>(initializedGlobalDecl.getDecl()), Out);
1409   else if (const auto *CD = dyn_cast<CXXConstructorDecl>(D))
1410     MangleCtx.mangleCtorBlock(CD, GD.getCtorType(), BD, Out);
1411   else if (const auto *DD = dyn_cast<CXXDestructorDecl>(D))
1412     MangleCtx.mangleDtorBlock(DD, GD.getDtorType(), BD, Out);
1413   else
1414     MangleCtx.mangleBlock(cast<DeclContext>(D), BD, Out);
1415 
1416   auto Result = Manglings.insert(std::make_pair(Out.str(), BD));
1417   return Result.first->first();
1418 }
1419 
1420 llvm::GlobalValue *CodeGenModule::GetGlobalValue(StringRef Name) {
1421   return getModule().getNamedValue(Name);
1422 }
1423 
1424 /// AddGlobalCtor - Add a function to the list that will be called before
1425 /// main() runs.
1426 void CodeGenModule::AddGlobalCtor(llvm::Function *Ctor, int Priority,
1427                                   llvm::Constant *AssociatedData) {
1428   // FIXME: Type coercion of void()* types.
1429   GlobalCtors.push_back(Structor(Priority, Ctor, AssociatedData));
1430 }
1431 
1432 /// AddGlobalDtor - Add a function to the list that will be called
1433 /// when the module is unloaded.
1434 void CodeGenModule::AddGlobalDtor(llvm::Function *Dtor, int Priority,
1435                                   bool IsDtorAttrFunc) {
1436   if (CodeGenOpts.RegisterGlobalDtorsWithAtExit &&
1437       (!getContext().getTargetInfo().getTriple().isOSAIX() || IsDtorAttrFunc)) {
1438     DtorsUsingAtExit[Priority].push_back(Dtor);
1439     return;
1440   }
1441 
1442   // FIXME: Type coercion of void()* types.
1443   GlobalDtors.push_back(Structor(Priority, Dtor, nullptr));
1444 }
1445 
1446 void CodeGenModule::EmitCtorList(CtorList &Fns, const char *GlobalName) {
1447   if (Fns.empty()) return;
1448 
1449   // Ctor function type is void()*.
1450   llvm::FunctionType* CtorFTy = llvm::FunctionType::get(VoidTy, false);
1451   llvm::Type *CtorPFTy = llvm::PointerType::get(CtorFTy,
1452       TheModule.getDataLayout().getProgramAddressSpace());
1453 
1454   // Get the type of a ctor entry, { i32, void ()*, i8* }.
1455   llvm::StructType *CtorStructTy = llvm::StructType::get(
1456       Int32Ty, CtorPFTy, VoidPtrTy);
1457 
1458   // Construct the constructor and destructor arrays.
1459   ConstantInitBuilder builder(*this);
1460   auto ctors = builder.beginArray(CtorStructTy);
1461   for (const auto &I : Fns) {
1462     auto ctor = ctors.beginStruct(CtorStructTy);
1463     ctor.addInt(Int32Ty, I.Priority);
1464     ctor.add(llvm::ConstantExpr::getBitCast(I.Initializer, CtorPFTy));
1465     if (I.AssociatedData)
1466       ctor.add(llvm::ConstantExpr::getBitCast(I.AssociatedData, VoidPtrTy));
1467     else
1468       ctor.addNullPointer(VoidPtrTy);
1469     ctor.finishAndAddTo(ctors);
1470   }
1471 
1472   auto list =
1473     ctors.finishAndCreateGlobal(GlobalName, getPointerAlign(),
1474                                 /*constant*/ false,
1475                                 llvm::GlobalValue::AppendingLinkage);
1476 
1477   // The LTO linker doesn't seem to like it when we set an alignment
1478   // on appending variables.  Take it off as a workaround.
1479   list->setAlignment(llvm::None);
1480 
1481   Fns.clear();
1482 }
1483 
1484 llvm::GlobalValue::LinkageTypes
1485 CodeGenModule::getFunctionLinkage(GlobalDecl GD) {
1486   const auto *D = cast<FunctionDecl>(GD.getDecl());
1487 
1488   GVALinkage Linkage = getContext().GetGVALinkageForFunction(D);
1489 
1490   if (const auto *Dtor = dyn_cast<CXXDestructorDecl>(D))
1491     return getCXXABI().getCXXDestructorLinkage(Linkage, Dtor, GD.getDtorType());
1492 
1493   if (isa<CXXConstructorDecl>(D) &&
1494       cast<CXXConstructorDecl>(D)->isInheritingConstructor() &&
1495       Context.getTargetInfo().getCXXABI().isMicrosoft()) {
1496     // Our approach to inheriting constructors is fundamentally different from
1497     // that used by the MS ABI, so keep our inheriting constructor thunks
1498     // internal rather than trying to pick an unambiguous mangling for them.
1499     return llvm::GlobalValue::InternalLinkage;
1500   }
1501 
1502   return getLLVMLinkageForDeclarator(D, Linkage, /*IsConstantVariable=*/false);
1503 }
1504 
1505 llvm::ConstantInt *CodeGenModule::CreateCrossDsoCfiTypeId(llvm::Metadata *MD) {
1506   llvm::MDString *MDS = dyn_cast<llvm::MDString>(MD);
1507   if (!MDS) return nullptr;
1508 
1509   return llvm::ConstantInt::get(Int64Ty, llvm::MD5Hash(MDS->getString()));
1510 }
1511 
1512 void CodeGenModule::SetLLVMFunctionAttributes(GlobalDecl GD,
1513                                               const CGFunctionInfo &Info,
1514                                               llvm::Function *F, bool IsThunk) {
1515   unsigned CallingConv;
1516   llvm::AttributeList PAL;
1517   ConstructAttributeList(F->getName(), Info, GD, PAL, CallingConv,
1518                          /*AttrOnCallSite=*/false, IsThunk);
1519   F->setAttributes(PAL);
1520   F->setCallingConv(static_cast<llvm::CallingConv::ID>(CallingConv));
1521 }
1522 
1523 static void removeImageAccessQualifier(std::string& TyName) {
1524   std::string ReadOnlyQual("__read_only");
1525   std::string::size_type ReadOnlyPos = TyName.find(ReadOnlyQual);
1526   if (ReadOnlyPos != std::string::npos)
1527     // "+ 1" for the space after access qualifier.
1528     TyName.erase(ReadOnlyPos, ReadOnlyQual.size() + 1);
1529   else {
1530     std::string WriteOnlyQual("__write_only");
1531     std::string::size_type WriteOnlyPos = TyName.find(WriteOnlyQual);
1532     if (WriteOnlyPos != std::string::npos)
1533       TyName.erase(WriteOnlyPos, WriteOnlyQual.size() + 1);
1534     else {
1535       std::string ReadWriteQual("__read_write");
1536       std::string::size_type ReadWritePos = TyName.find(ReadWriteQual);
1537       if (ReadWritePos != std::string::npos)
1538         TyName.erase(ReadWritePos, ReadWriteQual.size() + 1);
1539     }
1540   }
1541 }
1542 
1543 // Returns the address space id that should be produced to the
1544 // kernel_arg_addr_space metadata. This is always fixed to the ids
1545 // as specified in the SPIR 2.0 specification in order to differentiate
1546 // for example in clGetKernelArgInfo() implementation between the address
1547 // spaces with targets without unique mapping to the OpenCL address spaces
1548 // (basically all single AS CPUs).
1549 static unsigned ArgInfoAddressSpace(LangAS AS) {
1550   switch (AS) {
1551   case LangAS::opencl_global:
1552     return 1;
1553   case LangAS::opencl_constant:
1554     return 2;
1555   case LangAS::opencl_local:
1556     return 3;
1557   case LangAS::opencl_generic:
1558     return 4; // Not in SPIR 2.0 specs.
1559   case LangAS::opencl_global_device:
1560     return 5;
1561   case LangAS::opencl_global_host:
1562     return 6;
1563   default:
1564     return 0; // Assume private.
1565   }
1566 }
1567 
1568 void CodeGenModule::GenOpenCLArgMetadata(llvm::Function *Fn,
1569                                          const FunctionDecl *FD,
1570                                          CodeGenFunction *CGF) {
1571   assert(((FD && CGF) || (!FD && !CGF)) &&
1572          "Incorrect use - FD and CGF should either be both null or not!");
1573   // Create MDNodes that represent the kernel arg metadata.
1574   // Each MDNode is a list in the form of "key", N number of values which is
1575   // the same number of values as their are kernel arguments.
1576 
1577   const PrintingPolicy &Policy = Context.getPrintingPolicy();
1578 
1579   // MDNode for the kernel argument address space qualifiers.
1580   SmallVector<llvm::Metadata *, 8> addressQuals;
1581 
1582   // MDNode for the kernel argument access qualifiers (images only).
1583   SmallVector<llvm::Metadata *, 8> accessQuals;
1584 
1585   // MDNode for the kernel argument type names.
1586   SmallVector<llvm::Metadata *, 8> argTypeNames;
1587 
1588   // MDNode for the kernel argument base type names.
1589   SmallVector<llvm::Metadata *, 8> argBaseTypeNames;
1590 
1591   // MDNode for the kernel argument type qualifiers.
1592   SmallVector<llvm::Metadata *, 8> argTypeQuals;
1593 
1594   // MDNode for the kernel argument names.
1595   SmallVector<llvm::Metadata *, 8> argNames;
1596 
1597   if (FD && CGF)
1598     for (unsigned i = 0, e = FD->getNumParams(); i != e; ++i) {
1599       const ParmVarDecl *parm = FD->getParamDecl(i);
1600       QualType ty = parm->getType();
1601       std::string typeQuals;
1602 
1603       // Get image and pipe access qualifier:
1604       if (ty->isImageType() || ty->isPipeType()) {
1605         const Decl *PDecl = parm;
1606         if (auto *TD = dyn_cast<TypedefType>(ty))
1607           PDecl = TD->getDecl();
1608         const OpenCLAccessAttr *A = PDecl->getAttr<OpenCLAccessAttr>();
1609         if (A && A->isWriteOnly())
1610           accessQuals.push_back(llvm::MDString::get(VMContext, "write_only"));
1611         else if (A && A->isReadWrite())
1612           accessQuals.push_back(llvm::MDString::get(VMContext, "read_write"));
1613         else
1614           accessQuals.push_back(llvm::MDString::get(VMContext, "read_only"));
1615       } else
1616         accessQuals.push_back(llvm::MDString::get(VMContext, "none"));
1617 
1618       // Get argument name.
1619       argNames.push_back(llvm::MDString::get(VMContext, parm->getName()));
1620 
1621       auto getTypeSpelling = [&](QualType Ty) {
1622         auto typeName = Ty.getUnqualifiedType().getAsString(Policy);
1623 
1624         if (Ty.isCanonical()) {
1625           StringRef typeNameRef = typeName;
1626           // Turn "unsigned type" to "utype"
1627           if (typeNameRef.consume_front("unsigned "))
1628             return std::string("u") + typeNameRef.str();
1629           if (typeNameRef.consume_front("signed "))
1630             return typeNameRef.str();
1631         }
1632 
1633         return typeName;
1634       };
1635 
1636       if (ty->isPointerType()) {
1637         QualType pointeeTy = ty->getPointeeType();
1638 
1639         // Get address qualifier.
1640         addressQuals.push_back(
1641             llvm::ConstantAsMetadata::get(CGF->Builder.getInt32(
1642                 ArgInfoAddressSpace(pointeeTy.getAddressSpace()))));
1643 
1644         // Get argument type name.
1645         std::string typeName = getTypeSpelling(pointeeTy) + "*";
1646         std::string baseTypeName =
1647             getTypeSpelling(pointeeTy.getCanonicalType()) + "*";
1648         argTypeNames.push_back(llvm::MDString::get(VMContext, typeName));
1649         argBaseTypeNames.push_back(
1650             llvm::MDString::get(VMContext, baseTypeName));
1651 
1652         // Get argument type qualifiers:
1653         if (ty.isRestrictQualified())
1654           typeQuals = "restrict";
1655         if (pointeeTy.isConstQualified() ||
1656             (pointeeTy.getAddressSpace() == LangAS::opencl_constant))
1657           typeQuals += typeQuals.empty() ? "const" : " const";
1658         if (pointeeTy.isVolatileQualified())
1659           typeQuals += typeQuals.empty() ? "volatile" : " volatile";
1660       } else {
1661         uint32_t AddrSpc = 0;
1662         bool isPipe = ty->isPipeType();
1663         if (ty->isImageType() || isPipe)
1664           AddrSpc = ArgInfoAddressSpace(LangAS::opencl_global);
1665 
1666         addressQuals.push_back(
1667             llvm::ConstantAsMetadata::get(CGF->Builder.getInt32(AddrSpc)));
1668 
1669         // Get argument type name.
1670         ty = isPipe ? ty->castAs<PipeType>()->getElementType() : ty;
1671         std::string typeName = getTypeSpelling(ty);
1672         std::string baseTypeName = getTypeSpelling(ty.getCanonicalType());
1673 
1674         // Remove access qualifiers on images
1675         // (as they are inseparable from type in clang implementation,
1676         // but OpenCL spec provides a special query to get access qualifier
1677         // via clGetKernelArgInfo with CL_KERNEL_ARG_ACCESS_QUALIFIER):
1678         if (ty->isImageType()) {
1679           removeImageAccessQualifier(typeName);
1680           removeImageAccessQualifier(baseTypeName);
1681         }
1682 
1683         argTypeNames.push_back(llvm::MDString::get(VMContext, typeName));
1684         argBaseTypeNames.push_back(
1685             llvm::MDString::get(VMContext, baseTypeName));
1686 
1687         if (isPipe)
1688           typeQuals = "pipe";
1689       }
1690       argTypeQuals.push_back(llvm::MDString::get(VMContext, typeQuals));
1691     }
1692 
1693   Fn->setMetadata("kernel_arg_addr_space",
1694                   llvm::MDNode::get(VMContext, addressQuals));
1695   Fn->setMetadata("kernel_arg_access_qual",
1696                   llvm::MDNode::get(VMContext, accessQuals));
1697   Fn->setMetadata("kernel_arg_type",
1698                   llvm::MDNode::get(VMContext, argTypeNames));
1699   Fn->setMetadata("kernel_arg_base_type",
1700                   llvm::MDNode::get(VMContext, argBaseTypeNames));
1701   Fn->setMetadata("kernel_arg_type_qual",
1702                   llvm::MDNode::get(VMContext, argTypeQuals));
1703   if (getCodeGenOpts().EmitOpenCLArgMetadata)
1704     Fn->setMetadata("kernel_arg_name",
1705                     llvm::MDNode::get(VMContext, argNames));
1706 }
1707 
1708 /// Determines whether the language options require us to model
1709 /// unwind exceptions.  We treat -fexceptions as mandating this
1710 /// except under the fragile ObjC ABI with only ObjC exceptions
1711 /// enabled.  This means, for example, that C with -fexceptions
1712 /// enables this.
1713 static bool hasUnwindExceptions(const LangOptions &LangOpts) {
1714   // If exceptions are completely disabled, obviously this is false.
1715   if (!LangOpts.Exceptions) return false;
1716 
1717   // If C++ exceptions are enabled, this is true.
1718   if (LangOpts.CXXExceptions) return true;
1719 
1720   // If ObjC exceptions are enabled, this depends on the ABI.
1721   if (LangOpts.ObjCExceptions) {
1722     return LangOpts.ObjCRuntime.hasUnwindExceptions();
1723   }
1724 
1725   return true;
1726 }
1727 
1728 static bool requiresMemberFunctionPointerTypeMetadata(CodeGenModule &CGM,
1729                                                       const CXXMethodDecl *MD) {
1730   // Check that the type metadata can ever actually be used by a call.
1731   if (!CGM.getCodeGenOpts().LTOUnit ||
1732       !CGM.HasHiddenLTOVisibility(MD->getParent()))
1733     return false;
1734 
1735   // Only functions whose address can be taken with a member function pointer
1736   // need this sort of type metadata.
1737   return !MD->isStatic() && !MD->isVirtual() && !isa<CXXConstructorDecl>(MD) &&
1738          !isa<CXXDestructorDecl>(MD);
1739 }
1740 
1741 std::vector<const CXXRecordDecl *>
1742 CodeGenModule::getMostBaseClasses(const CXXRecordDecl *RD) {
1743   llvm::SetVector<const CXXRecordDecl *> MostBases;
1744 
1745   std::function<void (const CXXRecordDecl *)> CollectMostBases;
1746   CollectMostBases = [&](const CXXRecordDecl *RD) {
1747     if (RD->getNumBases() == 0)
1748       MostBases.insert(RD);
1749     for (const CXXBaseSpecifier &B : RD->bases())
1750       CollectMostBases(B.getType()->getAsCXXRecordDecl());
1751   };
1752   CollectMostBases(RD);
1753   return MostBases.takeVector();
1754 }
1755 
1756 void CodeGenModule::SetLLVMFunctionAttributesForDefinition(const Decl *D,
1757                                                            llvm::Function *F) {
1758   llvm::AttrBuilder B;
1759 
1760   if (CodeGenOpts.UnwindTables)
1761     B.addAttribute(llvm::Attribute::UWTable);
1762 
1763   if (CodeGenOpts.StackClashProtector)
1764     B.addAttribute("probe-stack", "inline-asm");
1765 
1766   if (!hasUnwindExceptions(LangOpts))
1767     B.addAttribute(llvm::Attribute::NoUnwind);
1768 
1769   if (!D || !D->hasAttr<NoStackProtectorAttr>()) {
1770     if (LangOpts.getStackProtector() == LangOptions::SSPOn)
1771       B.addAttribute(llvm::Attribute::StackProtect);
1772     else if (LangOpts.getStackProtector() == LangOptions::SSPStrong)
1773       B.addAttribute(llvm::Attribute::StackProtectStrong);
1774     else if (LangOpts.getStackProtector() == LangOptions::SSPReq)
1775       B.addAttribute(llvm::Attribute::StackProtectReq);
1776   }
1777 
1778   if (!D) {
1779     // If we don't have a declaration to control inlining, the function isn't
1780     // explicitly marked as alwaysinline for semantic reasons, and inlining is
1781     // disabled, mark the function as noinline.
1782     if (!F->hasFnAttribute(llvm::Attribute::AlwaysInline) &&
1783         CodeGenOpts.getInlining() == CodeGenOptions::OnlyAlwaysInlining)
1784       B.addAttribute(llvm::Attribute::NoInline);
1785 
1786     F->addFnAttrs(B);
1787     return;
1788   }
1789 
1790   // Track whether we need to add the optnone LLVM attribute,
1791   // starting with the default for this optimization level.
1792   bool ShouldAddOptNone =
1793       !CodeGenOpts.DisableO0ImplyOptNone && CodeGenOpts.OptimizationLevel == 0;
1794   // We can't add optnone in the following cases, it won't pass the verifier.
1795   ShouldAddOptNone &= !D->hasAttr<MinSizeAttr>();
1796   ShouldAddOptNone &= !D->hasAttr<AlwaysInlineAttr>();
1797 
1798   // Add optnone, but do so only if the function isn't always_inline.
1799   if ((ShouldAddOptNone || D->hasAttr<OptimizeNoneAttr>()) &&
1800       !F->hasFnAttribute(llvm::Attribute::AlwaysInline)) {
1801     B.addAttribute(llvm::Attribute::OptimizeNone);
1802 
1803     // OptimizeNone implies noinline; we should not be inlining such functions.
1804     B.addAttribute(llvm::Attribute::NoInline);
1805 
1806     // We still need to handle naked functions even though optnone subsumes
1807     // much of their semantics.
1808     if (D->hasAttr<NakedAttr>())
1809       B.addAttribute(llvm::Attribute::Naked);
1810 
1811     // OptimizeNone wins over OptimizeForSize and MinSize.
1812     F->removeFnAttr(llvm::Attribute::OptimizeForSize);
1813     F->removeFnAttr(llvm::Attribute::MinSize);
1814   } else if (D->hasAttr<NakedAttr>()) {
1815     // Naked implies noinline: we should not be inlining such functions.
1816     B.addAttribute(llvm::Attribute::Naked);
1817     B.addAttribute(llvm::Attribute::NoInline);
1818   } else if (D->hasAttr<NoDuplicateAttr>()) {
1819     B.addAttribute(llvm::Attribute::NoDuplicate);
1820   } else if (D->hasAttr<NoInlineAttr>() && !F->hasFnAttribute(llvm::Attribute::AlwaysInline)) {
1821     // Add noinline if the function isn't always_inline.
1822     B.addAttribute(llvm::Attribute::NoInline);
1823   } else if (D->hasAttr<AlwaysInlineAttr>() &&
1824              !F->hasFnAttribute(llvm::Attribute::NoInline)) {
1825     // (noinline wins over always_inline, and we can't specify both in IR)
1826     B.addAttribute(llvm::Attribute::AlwaysInline);
1827   } else if (CodeGenOpts.getInlining() == CodeGenOptions::OnlyAlwaysInlining) {
1828     // If we're not inlining, then force everything that isn't always_inline to
1829     // carry an explicit noinline attribute.
1830     if (!F->hasFnAttribute(llvm::Attribute::AlwaysInline))
1831       B.addAttribute(llvm::Attribute::NoInline);
1832   } else {
1833     // Otherwise, propagate the inline hint attribute and potentially use its
1834     // absence to mark things as noinline.
1835     if (auto *FD = dyn_cast<FunctionDecl>(D)) {
1836       // Search function and template pattern redeclarations for inline.
1837       auto CheckForInline = [](const FunctionDecl *FD) {
1838         auto CheckRedeclForInline = [](const FunctionDecl *Redecl) {
1839           return Redecl->isInlineSpecified();
1840         };
1841         if (any_of(FD->redecls(), CheckRedeclForInline))
1842           return true;
1843         const FunctionDecl *Pattern = FD->getTemplateInstantiationPattern();
1844         if (!Pattern)
1845           return false;
1846         return any_of(Pattern->redecls(), CheckRedeclForInline);
1847       };
1848       if (CheckForInline(FD)) {
1849         B.addAttribute(llvm::Attribute::InlineHint);
1850       } else if (CodeGenOpts.getInlining() ==
1851                      CodeGenOptions::OnlyHintInlining &&
1852                  !FD->isInlined() &&
1853                  !F->hasFnAttribute(llvm::Attribute::AlwaysInline)) {
1854         B.addAttribute(llvm::Attribute::NoInline);
1855       }
1856     }
1857   }
1858 
1859   // Add other optimization related attributes if we are optimizing this
1860   // function.
1861   if (!D->hasAttr<OptimizeNoneAttr>()) {
1862     if (D->hasAttr<ColdAttr>()) {
1863       if (!ShouldAddOptNone)
1864         B.addAttribute(llvm::Attribute::OptimizeForSize);
1865       B.addAttribute(llvm::Attribute::Cold);
1866     }
1867     if (D->hasAttr<HotAttr>())
1868       B.addAttribute(llvm::Attribute::Hot);
1869     if (D->hasAttr<MinSizeAttr>())
1870       B.addAttribute(llvm::Attribute::MinSize);
1871   }
1872 
1873   F->addFnAttrs(B);
1874 
1875   unsigned alignment = D->getMaxAlignment() / Context.getCharWidth();
1876   if (alignment)
1877     F->setAlignment(llvm::Align(alignment));
1878 
1879   if (!D->hasAttr<AlignedAttr>())
1880     if (LangOpts.FunctionAlignment)
1881       F->setAlignment(llvm::Align(1ull << LangOpts.FunctionAlignment));
1882 
1883   // Some C++ ABIs require 2-byte alignment for member functions, in order to
1884   // reserve a bit for differentiating between virtual and non-virtual member
1885   // functions. If the current target's C++ ABI requires this and this is a
1886   // member function, set its alignment accordingly.
1887   if (getTarget().getCXXABI().areMemberFunctionsAligned()) {
1888     if (F->getAlignment() < 2 && isa<CXXMethodDecl>(D))
1889       F->setAlignment(llvm::Align(2));
1890   }
1891 
1892   // In the cross-dso CFI mode with canonical jump tables, we want !type
1893   // attributes on definitions only.
1894   if (CodeGenOpts.SanitizeCfiCrossDso &&
1895       CodeGenOpts.SanitizeCfiCanonicalJumpTables) {
1896     if (auto *FD = dyn_cast<FunctionDecl>(D)) {
1897       // Skip available_externally functions. They won't be codegen'ed in the
1898       // current module anyway.
1899       if (getContext().GetGVALinkageForFunction(FD) != GVA_AvailableExternally)
1900         CreateFunctionTypeMetadataForIcall(FD, F);
1901     }
1902   }
1903 
1904   // Emit type metadata on member functions for member function pointer checks.
1905   // These are only ever necessary on definitions; we're guaranteed that the
1906   // definition will be present in the LTO unit as a result of LTO visibility.
1907   auto *MD = dyn_cast<CXXMethodDecl>(D);
1908   if (MD && requiresMemberFunctionPointerTypeMetadata(*this, MD)) {
1909     for (const CXXRecordDecl *Base : getMostBaseClasses(MD->getParent())) {
1910       llvm::Metadata *Id =
1911           CreateMetadataIdentifierForType(Context.getMemberPointerType(
1912               MD->getType(), Context.getRecordType(Base).getTypePtr()));
1913       F->addTypeMetadata(0, Id);
1914     }
1915   }
1916 }
1917 
1918 void CodeGenModule::setLLVMFunctionFEnvAttributes(const FunctionDecl *D,
1919                                                   llvm::Function *F) {
1920   if (D->hasAttr<StrictFPAttr>()) {
1921     llvm::AttrBuilder FuncAttrs;
1922     FuncAttrs.addAttribute("strictfp");
1923     F->addFnAttrs(FuncAttrs);
1924   }
1925 }
1926 
1927 void CodeGenModule::SetCommonAttributes(GlobalDecl GD, llvm::GlobalValue *GV) {
1928   const Decl *D = GD.getDecl();
1929   if (dyn_cast_or_null<NamedDecl>(D))
1930     setGVProperties(GV, GD);
1931   else
1932     GV->setVisibility(llvm::GlobalValue::DefaultVisibility);
1933 
1934   if (D && D->hasAttr<UsedAttr>())
1935     addUsedOrCompilerUsedGlobal(GV);
1936 
1937   if (CodeGenOpts.KeepStaticConsts && D && isa<VarDecl>(D)) {
1938     const auto *VD = cast<VarDecl>(D);
1939     if (VD->getType().isConstQualified() &&
1940         VD->getStorageDuration() == SD_Static)
1941       addUsedOrCompilerUsedGlobal(GV);
1942   }
1943 }
1944 
1945 bool CodeGenModule::GetCPUAndFeaturesAttributes(GlobalDecl GD,
1946                                                 llvm::AttrBuilder &Attrs) {
1947   // Add target-cpu and target-features attributes to functions. If
1948   // we have a decl for the function and it has a target attribute then
1949   // parse that and add it to the feature set.
1950   StringRef TargetCPU = getTarget().getTargetOpts().CPU;
1951   StringRef TuneCPU = getTarget().getTargetOpts().TuneCPU;
1952   std::vector<std::string> Features;
1953   const auto *FD = dyn_cast_or_null<FunctionDecl>(GD.getDecl());
1954   FD = FD ? FD->getMostRecentDecl() : FD;
1955   const auto *TD = FD ? FD->getAttr<TargetAttr>() : nullptr;
1956   const auto *SD = FD ? FD->getAttr<CPUSpecificAttr>() : nullptr;
1957   bool AddedAttr = false;
1958   if (TD || SD) {
1959     llvm::StringMap<bool> FeatureMap;
1960     getContext().getFunctionFeatureMap(FeatureMap, GD);
1961 
1962     // Produce the canonical string for this set of features.
1963     for (const llvm::StringMap<bool>::value_type &Entry : FeatureMap)
1964       Features.push_back((Entry.getValue() ? "+" : "-") + Entry.getKey().str());
1965 
1966     // Now add the target-cpu and target-features to the function.
1967     // While we populated the feature map above, we still need to
1968     // get and parse the target attribute so we can get the cpu for
1969     // the function.
1970     if (TD) {
1971       ParsedTargetAttr ParsedAttr = TD->parse();
1972       if (!ParsedAttr.Architecture.empty() &&
1973           getTarget().isValidCPUName(ParsedAttr.Architecture)) {
1974         TargetCPU = ParsedAttr.Architecture;
1975         TuneCPU = ""; // Clear the tune CPU.
1976       }
1977       if (!ParsedAttr.Tune.empty() &&
1978           getTarget().isValidCPUName(ParsedAttr.Tune))
1979         TuneCPU = ParsedAttr.Tune;
1980     }
1981   } else {
1982     // Otherwise just add the existing target cpu and target features to the
1983     // function.
1984     Features = getTarget().getTargetOpts().Features;
1985   }
1986 
1987   if (!TargetCPU.empty()) {
1988     Attrs.addAttribute("target-cpu", TargetCPU);
1989     AddedAttr = true;
1990   }
1991   if (!TuneCPU.empty()) {
1992     Attrs.addAttribute("tune-cpu", TuneCPU);
1993     AddedAttr = true;
1994   }
1995   if (!Features.empty()) {
1996     llvm::sort(Features);
1997     Attrs.addAttribute("target-features", llvm::join(Features, ","));
1998     AddedAttr = true;
1999   }
2000 
2001   return AddedAttr;
2002 }
2003 
2004 void CodeGenModule::setNonAliasAttributes(GlobalDecl GD,
2005                                           llvm::GlobalObject *GO) {
2006   const Decl *D = GD.getDecl();
2007   SetCommonAttributes(GD, GO);
2008 
2009   if (D) {
2010     if (auto *GV = dyn_cast<llvm::GlobalVariable>(GO)) {
2011       if (D->hasAttr<RetainAttr>())
2012         addUsedGlobal(GV);
2013       if (auto *SA = D->getAttr<PragmaClangBSSSectionAttr>())
2014         GV->addAttribute("bss-section", SA->getName());
2015       if (auto *SA = D->getAttr<PragmaClangDataSectionAttr>())
2016         GV->addAttribute("data-section", SA->getName());
2017       if (auto *SA = D->getAttr<PragmaClangRodataSectionAttr>())
2018         GV->addAttribute("rodata-section", SA->getName());
2019       if (auto *SA = D->getAttr<PragmaClangRelroSectionAttr>())
2020         GV->addAttribute("relro-section", SA->getName());
2021     }
2022 
2023     if (auto *F = dyn_cast<llvm::Function>(GO)) {
2024       if (D->hasAttr<RetainAttr>())
2025         addUsedGlobal(F);
2026       if (auto *SA = D->getAttr<PragmaClangTextSectionAttr>())
2027         if (!D->getAttr<SectionAttr>())
2028           F->addFnAttr("implicit-section-name", SA->getName());
2029 
2030       llvm::AttrBuilder Attrs;
2031       if (GetCPUAndFeaturesAttributes(GD, Attrs)) {
2032         // We know that GetCPUAndFeaturesAttributes will always have the
2033         // newest set, since it has the newest possible FunctionDecl, so the
2034         // new ones should replace the old.
2035         llvm::AttrBuilder RemoveAttrs;
2036         RemoveAttrs.addAttribute("target-cpu");
2037         RemoveAttrs.addAttribute("target-features");
2038         RemoveAttrs.addAttribute("tune-cpu");
2039         F->removeFnAttrs(RemoveAttrs);
2040         F->addFnAttrs(Attrs);
2041       }
2042     }
2043 
2044     if (const auto *CSA = D->getAttr<CodeSegAttr>())
2045       GO->setSection(CSA->getName());
2046     else if (const auto *SA = D->getAttr<SectionAttr>())
2047       GO->setSection(SA->getName());
2048   }
2049 
2050   getTargetCodeGenInfo().setTargetAttributes(D, GO, *this);
2051 }
2052 
2053 void CodeGenModule::SetInternalFunctionAttributes(GlobalDecl GD,
2054                                                   llvm::Function *F,
2055                                                   const CGFunctionInfo &FI) {
2056   const Decl *D = GD.getDecl();
2057   SetLLVMFunctionAttributes(GD, FI, F, /*IsThunk=*/false);
2058   SetLLVMFunctionAttributesForDefinition(D, F);
2059 
2060   F->setLinkage(llvm::Function::InternalLinkage);
2061 
2062   setNonAliasAttributes(GD, F);
2063 }
2064 
2065 static void setLinkageForGV(llvm::GlobalValue *GV, const NamedDecl *ND) {
2066   // Set linkage and visibility in case we never see a definition.
2067   LinkageInfo LV = ND->getLinkageAndVisibility();
2068   // Don't set internal linkage on declarations.
2069   // "extern_weak" is overloaded in LLVM; we probably should have
2070   // separate linkage types for this.
2071   if (isExternallyVisible(LV.getLinkage()) &&
2072       (ND->hasAttr<WeakAttr>() || ND->isWeakImported()))
2073     GV->setLinkage(llvm::GlobalValue::ExternalWeakLinkage);
2074 }
2075 
2076 void CodeGenModule::CreateFunctionTypeMetadataForIcall(const FunctionDecl *FD,
2077                                                        llvm::Function *F) {
2078   // Only if we are checking indirect calls.
2079   if (!LangOpts.Sanitize.has(SanitizerKind::CFIICall))
2080     return;
2081 
2082   // Non-static class methods are handled via vtable or member function pointer
2083   // checks elsewhere.
2084   if (isa<CXXMethodDecl>(FD) && !cast<CXXMethodDecl>(FD)->isStatic())
2085     return;
2086 
2087   llvm::Metadata *MD = CreateMetadataIdentifierForType(FD->getType());
2088   F->addTypeMetadata(0, MD);
2089   F->addTypeMetadata(0, CreateMetadataIdentifierGeneralized(FD->getType()));
2090 
2091   // Emit a hash-based bit set entry for cross-DSO calls.
2092   if (CodeGenOpts.SanitizeCfiCrossDso)
2093     if (auto CrossDsoTypeId = CreateCrossDsoCfiTypeId(MD))
2094       F->addTypeMetadata(0, llvm::ConstantAsMetadata::get(CrossDsoTypeId));
2095 }
2096 
2097 void CodeGenModule::SetFunctionAttributes(GlobalDecl GD, llvm::Function *F,
2098                                           bool IsIncompleteFunction,
2099                                           bool IsThunk) {
2100 
2101   if (llvm::Intrinsic::ID IID = F->getIntrinsicID()) {
2102     // If this is an intrinsic function, set the function's attributes
2103     // to the intrinsic's attributes.
2104     F->setAttributes(llvm::Intrinsic::getAttributes(getLLVMContext(), IID));
2105     return;
2106   }
2107 
2108   const auto *FD = cast<FunctionDecl>(GD.getDecl());
2109 
2110   if (!IsIncompleteFunction)
2111     SetLLVMFunctionAttributes(GD, getTypes().arrangeGlobalDeclaration(GD), F,
2112                               IsThunk);
2113 
2114   // Add the Returned attribute for "this", except for iOS 5 and earlier
2115   // where substantial code, including the libstdc++ dylib, was compiled with
2116   // GCC and does not actually return "this".
2117   if (!IsThunk && getCXXABI().HasThisReturn(GD) &&
2118       !(getTriple().isiOS() && getTriple().isOSVersionLT(6))) {
2119     assert(!F->arg_empty() &&
2120            F->arg_begin()->getType()
2121              ->canLosslesslyBitCastTo(F->getReturnType()) &&
2122            "unexpected this return");
2123     F->addParamAttr(0, llvm::Attribute::Returned);
2124   }
2125 
2126   // Only a few attributes are set on declarations; these may later be
2127   // overridden by a definition.
2128 
2129   setLinkageForGV(F, FD);
2130   setGVProperties(F, FD);
2131 
2132   // Setup target-specific attributes.
2133   if (!IsIncompleteFunction && F->isDeclaration())
2134     getTargetCodeGenInfo().setTargetAttributes(FD, F, *this);
2135 
2136   if (const auto *CSA = FD->getAttr<CodeSegAttr>())
2137     F->setSection(CSA->getName());
2138   else if (const auto *SA = FD->getAttr<SectionAttr>())
2139      F->setSection(SA->getName());
2140 
2141   if (FD->hasAttr<ErrorAttr>())
2142     F->addFnAttr("dontcall");
2143 
2144   // If we plan on emitting this inline builtin, we can't treat it as a builtin.
2145   if (FD->isInlineBuiltinDeclaration()) {
2146     const FunctionDecl *FDBody;
2147     bool HasBody = FD->hasBody(FDBody);
2148     (void)HasBody;
2149     assert(HasBody && "Inline builtin declarations should always have an "
2150                       "available body!");
2151     if (shouldEmitFunction(FDBody))
2152       F->addFnAttr(llvm::Attribute::NoBuiltin);
2153   }
2154 
2155   if (FD->isReplaceableGlobalAllocationFunction()) {
2156     // A replaceable global allocation function does not act like a builtin by
2157     // default, only if it is invoked by a new-expression or delete-expression.
2158     F->addFnAttr(llvm::Attribute::NoBuiltin);
2159   }
2160 
2161   if (isa<CXXConstructorDecl>(FD) || isa<CXXDestructorDecl>(FD))
2162     F->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
2163   else if (const auto *MD = dyn_cast<CXXMethodDecl>(FD))
2164     if (MD->isVirtual())
2165       F->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
2166 
2167   // Don't emit entries for function declarations in the cross-DSO mode. This
2168   // is handled with better precision by the receiving DSO. But if jump tables
2169   // are non-canonical then we need type metadata in order to produce the local
2170   // jump table.
2171   if (!CodeGenOpts.SanitizeCfiCrossDso ||
2172       !CodeGenOpts.SanitizeCfiCanonicalJumpTables)
2173     CreateFunctionTypeMetadataForIcall(FD, F);
2174 
2175   if (getLangOpts().OpenMP && FD->hasAttr<OMPDeclareSimdDeclAttr>())
2176     getOpenMPRuntime().emitDeclareSimdFunction(FD, F);
2177 
2178   if (const auto *CB = FD->getAttr<CallbackAttr>()) {
2179     // Annotate the callback behavior as metadata:
2180     //  - The callback callee (as argument number).
2181     //  - The callback payloads (as argument numbers).
2182     llvm::LLVMContext &Ctx = F->getContext();
2183     llvm::MDBuilder MDB(Ctx);
2184 
2185     // The payload indices are all but the first one in the encoding. The first
2186     // identifies the callback callee.
2187     int CalleeIdx = *CB->encoding_begin();
2188     ArrayRef<int> PayloadIndices(CB->encoding_begin() + 1, CB->encoding_end());
2189     F->addMetadata(llvm::LLVMContext::MD_callback,
2190                    *llvm::MDNode::get(Ctx, {MDB.createCallbackEncoding(
2191                                                CalleeIdx, PayloadIndices,
2192                                                /* VarArgsArePassed */ false)}));
2193   }
2194 }
2195 
2196 void CodeGenModule::addUsedGlobal(llvm::GlobalValue *GV) {
2197   assert((isa<llvm::Function>(GV) || !GV->isDeclaration()) &&
2198          "Only globals with definition can force usage.");
2199   LLVMUsed.emplace_back(GV);
2200 }
2201 
2202 void CodeGenModule::addCompilerUsedGlobal(llvm::GlobalValue *GV) {
2203   assert(!GV->isDeclaration() &&
2204          "Only globals with definition can force usage.");
2205   LLVMCompilerUsed.emplace_back(GV);
2206 }
2207 
2208 void CodeGenModule::addUsedOrCompilerUsedGlobal(llvm::GlobalValue *GV) {
2209   assert((isa<llvm::Function>(GV) || !GV->isDeclaration()) &&
2210          "Only globals with definition can force usage.");
2211   if (getTriple().isOSBinFormatELF())
2212     LLVMCompilerUsed.emplace_back(GV);
2213   else
2214     LLVMUsed.emplace_back(GV);
2215 }
2216 
2217 static void emitUsed(CodeGenModule &CGM, StringRef Name,
2218                      std::vector<llvm::WeakTrackingVH> &List) {
2219   // Don't create llvm.used if there is no need.
2220   if (List.empty())
2221     return;
2222 
2223   // Convert List to what ConstantArray needs.
2224   SmallVector<llvm::Constant*, 8> UsedArray;
2225   UsedArray.resize(List.size());
2226   for (unsigned i = 0, e = List.size(); i != e; ++i) {
2227     UsedArray[i] =
2228         llvm::ConstantExpr::getPointerBitCastOrAddrSpaceCast(
2229             cast<llvm::Constant>(&*List[i]), CGM.Int8PtrTy);
2230   }
2231 
2232   if (UsedArray.empty())
2233     return;
2234   llvm::ArrayType *ATy = llvm::ArrayType::get(CGM.Int8PtrTy, UsedArray.size());
2235 
2236   auto *GV = new llvm::GlobalVariable(
2237       CGM.getModule(), ATy, false, llvm::GlobalValue::AppendingLinkage,
2238       llvm::ConstantArray::get(ATy, UsedArray), Name);
2239 
2240   GV->setSection("llvm.metadata");
2241 }
2242 
2243 void CodeGenModule::emitLLVMUsed() {
2244   emitUsed(*this, "llvm.used", LLVMUsed);
2245   emitUsed(*this, "llvm.compiler.used", LLVMCompilerUsed);
2246 }
2247 
2248 void CodeGenModule::AppendLinkerOptions(StringRef Opts) {
2249   auto *MDOpts = llvm::MDString::get(getLLVMContext(), Opts);
2250   LinkerOptionsMetadata.push_back(llvm::MDNode::get(getLLVMContext(), MDOpts));
2251 }
2252 
2253 void CodeGenModule::AddDetectMismatch(StringRef Name, StringRef Value) {
2254   llvm::SmallString<32> Opt;
2255   getTargetCodeGenInfo().getDetectMismatchOption(Name, Value, Opt);
2256   if (Opt.empty())
2257     return;
2258   auto *MDOpts = llvm::MDString::get(getLLVMContext(), Opt);
2259   LinkerOptionsMetadata.push_back(llvm::MDNode::get(getLLVMContext(), MDOpts));
2260 }
2261 
2262 void CodeGenModule::AddDependentLib(StringRef Lib) {
2263   auto &C = getLLVMContext();
2264   if (getTarget().getTriple().isOSBinFormatELF()) {
2265       ELFDependentLibraries.push_back(
2266         llvm::MDNode::get(C, llvm::MDString::get(C, Lib)));
2267     return;
2268   }
2269 
2270   llvm::SmallString<24> Opt;
2271   getTargetCodeGenInfo().getDependentLibraryOption(Lib, Opt);
2272   auto *MDOpts = llvm::MDString::get(getLLVMContext(), Opt);
2273   LinkerOptionsMetadata.push_back(llvm::MDNode::get(C, MDOpts));
2274 }
2275 
2276 /// Add link options implied by the given module, including modules
2277 /// it depends on, using a postorder walk.
2278 static void addLinkOptionsPostorder(CodeGenModule &CGM, Module *Mod,
2279                                     SmallVectorImpl<llvm::MDNode *> &Metadata,
2280                                     llvm::SmallPtrSet<Module *, 16> &Visited) {
2281   // Import this module's parent.
2282   if (Mod->Parent && Visited.insert(Mod->Parent).second) {
2283     addLinkOptionsPostorder(CGM, Mod->Parent, Metadata, Visited);
2284   }
2285 
2286   // Import this module's dependencies.
2287   for (unsigned I = Mod->Imports.size(); I > 0; --I) {
2288     if (Visited.insert(Mod->Imports[I - 1]).second)
2289       addLinkOptionsPostorder(CGM, Mod->Imports[I-1], Metadata, Visited);
2290   }
2291 
2292   // Add linker options to link against the libraries/frameworks
2293   // described by this module.
2294   llvm::LLVMContext &Context = CGM.getLLVMContext();
2295   bool IsELF = CGM.getTarget().getTriple().isOSBinFormatELF();
2296 
2297   // For modules that use export_as for linking, use that module
2298   // name instead.
2299   if (Mod->UseExportAsModuleLinkName)
2300     return;
2301 
2302   for (unsigned I = Mod->LinkLibraries.size(); I > 0; --I) {
2303     // Link against a framework.  Frameworks are currently Darwin only, so we
2304     // don't to ask TargetCodeGenInfo for the spelling of the linker option.
2305     if (Mod->LinkLibraries[I-1].IsFramework) {
2306       llvm::Metadata *Args[2] = {
2307           llvm::MDString::get(Context, "-framework"),
2308           llvm::MDString::get(Context, Mod->LinkLibraries[I - 1].Library)};
2309 
2310       Metadata.push_back(llvm::MDNode::get(Context, Args));
2311       continue;
2312     }
2313 
2314     // Link against a library.
2315     if (IsELF) {
2316       llvm::Metadata *Args[2] = {
2317           llvm::MDString::get(Context, "lib"),
2318           llvm::MDString::get(Context, Mod->LinkLibraries[I - 1].Library),
2319       };
2320       Metadata.push_back(llvm::MDNode::get(Context, Args));
2321     } else {
2322       llvm::SmallString<24> Opt;
2323       CGM.getTargetCodeGenInfo().getDependentLibraryOption(
2324           Mod->LinkLibraries[I - 1].Library, Opt);
2325       auto *OptString = llvm::MDString::get(Context, Opt);
2326       Metadata.push_back(llvm::MDNode::get(Context, OptString));
2327     }
2328   }
2329 }
2330 
2331 void CodeGenModule::EmitModuleLinkOptions() {
2332   // Collect the set of all of the modules we want to visit to emit link
2333   // options, which is essentially the imported modules and all of their
2334   // non-explicit child modules.
2335   llvm::SetVector<clang::Module *> LinkModules;
2336   llvm::SmallPtrSet<clang::Module *, 16> Visited;
2337   SmallVector<clang::Module *, 16> Stack;
2338 
2339   // Seed the stack with imported modules.
2340   for (Module *M : ImportedModules) {
2341     // Do not add any link flags when an implementation TU of a module imports
2342     // a header of that same module.
2343     if (M->getTopLevelModuleName() == getLangOpts().CurrentModule &&
2344         !getLangOpts().isCompilingModule())
2345       continue;
2346     if (Visited.insert(M).second)
2347       Stack.push_back(M);
2348   }
2349 
2350   // Find all of the modules to import, making a little effort to prune
2351   // non-leaf modules.
2352   while (!Stack.empty()) {
2353     clang::Module *Mod = Stack.pop_back_val();
2354 
2355     bool AnyChildren = false;
2356 
2357     // Visit the submodules of this module.
2358     for (const auto &SM : Mod->submodules()) {
2359       // Skip explicit children; they need to be explicitly imported to be
2360       // linked against.
2361       if (SM->IsExplicit)
2362         continue;
2363 
2364       if (Visited.insert(SM).second) {
2365         Stack.push_back(SM);
2366         AnyChildren = true;
2367       }
2368     }
2369 
2370     // We didn't find any children, so add this module to the list of
2371     // modules to link against.
2372     if (!AnyChildren) {
2373       LinkModules.insert(Mod);
2374     }
2375   }
2376 
2377   // Add link options for all of the imported modules in reverse topological
2378   // order.  We don't do anything to try to order import link flags with respect
2379   // to linker options inserted by things like #pragma comment().
2380   SmallVector<llvm::MDNode *, 16> MetadataArgs;
2381   Visited.clear();
2382   for (Module *M : LinkModules)
2383     if (Visited.insert(M).second)
2384       addLinkOptionsPostorder(*this, M, MetadataArgs, Visited);
2385   std::reverse(MetadataArgs.begin(), MetadataArgs.end());
2386   LinkerOptionsMetadata.append(MetadataArgs.begin(), MetadataArgs.end());
2387 
2388   // Add the linker options metadata flag.
2389   auto *NMD = getModule().getOrInsertNamedMetadata("llvm.linker.options");
2390   for (auto *MD : LinkerOptionsMetadata)
2391     NMD->addOperand(MD);
2392 }
2393 
2394 void CodeGenModule::EmitDeferred() {
2395   // Emit deferred declare target declarations.
2396   if (getLangOpts().OpenMP && !getLangOpts().OpenMPSimd)
2397     getOpenMPRuntime().emitDeferredTargetDecls();
2398 
2399   // Emit code for any potentially referenced deferred decls.  Since a
2400   // previously unused static decl may become used during the generation of code
2401   // for a static function, iterate until no changes are made.
2402 
2403   if (!DeferredVTables.empty()) {
2404     EmitDeferredVTables();
2405 
2406     // Emitting a vtable doesn't directly cause more vtables to
2407     // become deferred, although it can cause functions to be
2408     // emitted that then need those vtables.
2409     assert(DeferredVTables.empty());
2410   }
2411 
2412   // Emit CUDA/HIP static device variables referenced by host code only.
2413   // Note we should not clear CUDADeviceVarODRUsedByHost since it is still
2414   // needed for further handling.
2415   if (getLangOpts().CUDA && getLangOpts().CUDAIsDevice)
2416     for (const auto *V : getContext().CUDADeviceVarODRUsedByHost)
2417       DeferredDeclsToEmit.push_back(V);
2418 
2419   // Stop if we're out of both deferred vtables and deferred declarations.
2420   if (DeferredDeclsToEmit.empty())
2421     return;
2422 
2423   // Grab the list of decls to emit. If EmitGlobalDefinition schedules more
2424   // work, it will not interfere with this.
2425   std::vector<GlobalDecl> CurDeclsToEmit;
2426   CurDeclsToEmit.swap(DeferredDeclsToEmit);
2427 
2428   for (GlobalDecl &D : CurDeclsToEmit) {
2429     // We should call GetAddrOfGlobal with IsForDefinition set to true in order
2430     // to get GlobalValue with exactly the type we need, not something that
2431     // might had been created for another decl with the same mangled name but
2432     // different type.
2433     llvm::GlobalValue *GV = dyn_cast<llvm::GlobalValue>(
2434         GetAddrOfGlobal(D, ForDefinition));
2435 
2436     // In case of different address spaces, we may still get a cast, even with
2437     // IsForDefinition equal to true. Query mangled names table to get
2438     // GlobalValue.
2439     if (!GV)
2440       GV = GetGlobalValue(getMangledName(D));
2441 
2442     // Make sure GetGlobalValue returned non-null.
2443     assert(GV);
2444 
2445     // Check to see if we've already emitted this.  This is necessary
2446     // for a couple of reasons: first, decls can end up in the
2447     // deferred-decls queue multiple times, and second, decls can end
2448     // up with definitions in unusual ways (e.g. by an extern inline
2449     // function acquiring a strong function redefinition).  Just
2450     // ignore these cases.
2451     if (!GV->isDeclaration())
2452       continue;
2453 
2454     // If this is OpenMP, check if it is legal to emit this global normally.
2455     if (LangOpts.OpenMP && OpenMPRuntime && OpenMPRuntime->emitTargetGlobal(D))
2456       continue;
2457 
2458     // Otherwise, emit the definition and move on to the next one.
2459     EmitGlobalDefinition(D, GV);
2460 
2461     // If we found out that we need to emit more decls, do that recursively.
2462     // This has the advantage that the decls are emitted in a DFS and related
2463     // ones are close together, which is convenient for testing.
2464     if (!DeferredVTables.empty() || !DeferredDeclsToEmit.empty()) {
2465       EmitDeferred();
2466       assert(DeferredVTables.empty() && DeferredDeclsToEmit.empty());
2467     }
2468   }
2469 }
2470 
2471 void CodeGenModule::EmitVTablesOpportunistically() {
2472   // Try to emit external vtables as available_externally if they have emitted
2473   // all inlined virtual functions.  It runs after EmitDeferred() and therefore
2474   // is not allowed to create new references to things that need to be emitted
2475   // lazily. Note that it also uses fact that we eagerly emitting RTTI.
2476 
2477   assert((OpportunisticVTables.empty() || shouldOpportunisticallyEmitVTables())
2478          && "Only emit opportunistic vtables with optimizations");
2479 
2480   for (const CXXRecordDecl *RD : OpportunisticVTables) {
2481     assert(getVTables().isVTableExternal(RD) &&
2482            "This queue should only contain external vtables");
2483     if (getCXXABI().canSpeculativelyEmitVTable(RD))
2484       VTables.GenerateClassData(RD);
2485   }
2486   OpportunisticVTables.clear();
2487 }
2488 
2489 void CodeGenModule::EmitGlobalAnnotations() {
2490   if (Annotations.empty())
2491     return;
2492 
2493   // Create a new global variable for the ConstantStruct in the Module.
2494   llvm::Constant *Array = llvm::ConstantArray::get(llvm::ArrayType::get(
2495     Annotations[0]->getType(), Annotations.size()), Annotations);
2496   auto *gv = new llvm::GlobalVariable(getModule(), Array->getType(), false,
2497                                       llvm::GlobalValue::AppendingLinkage,
2498                                       Array, "llvm.global.annotations");
2499   gv->setSection(AnnotationSection);
2500 }
2501 
2502 llvm::Constant *CodeGenModule::EmitAnnotationString(StringRef Str) {
2503   llvm::Constant *&AStr = AnnotationStrings[Str];
2504   if (AStr)
2505     return AStr;
2506 
2507   // Not found yet, create a new global.
2508   llvm::Constant *s = llvm::ConstantDataArray::getString(getLLVMContext(), Str);
2509   auto *gv =
2510       new llvm::GlobalVariable(getModule(), s->getType(), true,
2511                                llvm::GlobalValue::PrivateLinkage, s, ".str");
2512   gv->setSection(AnnotationSection);
2513   gv->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
2514   AStr = gv;
2515   return gv;
2516 }
2517 
2518 llvm::Constant *CodeGenModule::EmitAnnotationUnit(SourceLocation Loc) {
2519   SourceManager &SM = getContext().getSourceManager();
2520   PresumedLoc PLoc = SM.getPresumedLoc(Loc);
2521   if (PLoc.isValid())
2522     return EmitAnnotationString(PLoc.getFilename());
2523   return EmitAnnotationString(SM.getBufferName(Loc));
2524 }
2525 
2526 llvm::Constant *CodeGenModule::EmitAnnotationLineNo(SourceLocation L) {
2527   SourceManager &SM = getContext().getSourceManager();
2528   PresumedLoc PLoc = SM.getPresumedLoc(L);
2529   unsigned LineNo = PLoc.isValid() ? PLoc.getLine() :
2530     SM.getExpansionLineNumber(L);
2531   return llvm::ConstantInt::get(Int32Ty, LineNo);
2532 }
2533 
2534 llvm::Constant *CodeGenModule::EmitAnnotationArgs(const AnnotateAttr *Attr) {
2535   ArrayRef<Expr *> Exprs = {Attr->args_begin(), Attr->args_size()};
2536   if (Exprs.empty())
2537     return llvm::ConstantPointerNull::get(GlobalsInt8PtrTy);
2538 
2539   llvm::FoldingSetNodeID ID;
2540   for (Expr *E : Exprs) {
2541     ID.Add(cast<clang::ConstantExpr>(E)->getAPValueResult());
2542   }
2543   llvm::Constant *&Lookup = AnnotationArgs[ID.ComputeHash()];
2544   if (Lookup)
2545     return Lookup;
2546 
2547   llvm::SmallVector<llvm::Constant *, 4> LLVMArgs;
2548   LLVMArgs.reserve(Exprs.size());
2549   ConstantEmitter ConstEmiter(*this);
2550   llvm::transform(Exprs, std::back_inserter(LLVMArgs), [&](const Expr *E) {
2551     const auto *CE = cast<clang::ConstantExpr>(E);
2552     return ConstEmiter.emitAbstract(CE->getBeginLoc(), CE->getAPValueResult(),
2553                                     CE->getType());
2554   });
2555   auto *Struct = llvm::ConstantStruct::getAnon(LLVMArgs);
2556   auto *GV = new llvm::GlobalVariable(getModule(), Struct->getType(), true,
2557                                       llvm::GlobalValue::PrivateLinkage, Struct,
2558                                       ".args");
2559   GV->setSection(AnnotationSection);
2560   GV->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
2561   auto *Bitcasted = llvm::ConstantExpr::getBitCast(GV, GlobalsInt8PtrTy);
2562 
2563   Lookup = Bitcasted;
2564   return Bitcasted;
2565 }
2566 
2567 llvm::Constant *CodeGenModule::EmitAnnotateAttr(llvm::GlobalValue *GV,
2568                                                 const AnnotateAttr *AA,
2569                                                 SourceLocation L) {
2570   // Get the globals for file name, annotation, and the line number.
2571   llvm::Constant *AnnoGV = EmitAnnotationString(AA->getAnnotation()),
2572                  *UnitGV = EmitAnnotationUnit(L),
2573                  *LineNoCst = EmitAnnotationLineNo(L),
2574                  *Args = EmitAnnotationArgs(AA);
2575 
2576   llvm::Constant *GVInGlobalsAS = GV;
2577   if (GV->getAddressSpace() !=
2578       getDataLayout().getDefaultGlobalsAddressSpace()) {
2579     GVInGlobalsAS = llvm::ConstantExpr::getAddrSpaceCast(
2580         GV, GV->getValueType()->getPointerTo(
2581                 getDataLayout().getDefaultGlobalsAddressSpace()));
2582   }
2583 
2584   // Create the ConstantStruct for the global annotation.
2585   llvm::Constant *Fields[] = {
2586       llvm::ConstantExpr::getBitCast(GVInGlobalsAS, GlobalsInt8PtrTy),
2587       llvm::ConstantExpr::getBitCast(AnnoGV, GlobalsInt8PtrTy),
2588       llvm::ConstantExpr::getBitCast(UnitGV, GlobalsInt8PtrTy),
2589       LineNoCst,
2590       Args,
2591   };
2592   return llvm::ConstantStruct::getAnon(Fields);
2593 }
2594 
2595 void CodeGenModule::AddGlobalAnnotations(const ValueDecl *D,
2596                                          llvm::GlobalValue *GV) {
2597   assert(D->hasAttr<AnnotateAttr>() && "no annotate attribute");
2598   // Get the struct elements for these annotations.
2599   for (const auto *I : D->specific_attrs<AnnotateAttr>())
2600     Annotations.push_back(EmitAnnotateAttr(GV, I, D->getLocation()));
2601 }
2602 
2603 bool CodeGenModule::isInNoSanitizeList(SanitizerMask Kind, llvm::Function *Fn,
2604                                        SourceLocation Loc) const {
2605   const auto &NoSanitizeL = getContext().getNoSanitizeList();
2606   // NoSanitize by function name.
2607   if (NoSanitizeL.containsFunction(Kind, Fn->getName()))
2608     return true;
2609   // NoSanitize by location.
2610   if (Loc.isValid())
2611     return NoSanitizeL.containsLocation(Kind, Loc);
2612   // If location is unknown, this may be a compiler-generated function. Assume
2613   // it's located in the main file.
2614   auto &SM = Context.getSourceManager();
2615   if (const auto *MainFile = SM.getFileEntryForID(SM.getMainFileID())) {
2616     return NoSanitizeL.containsFile(Kind, MainFile->getName());
2617   }
2618   return false;
2619 }
2620 
2621 bool CodeGenModule::isInNoSanitizeList(llvm::GlobalVariable *GV,
2622                                        SourceLocation Loc, QualType Ty,
2623                                        StringRef Category) const {
2624   // For now globals can be ignored only in ASan and KASan.
2625   const SanitizerMask EnabledAsanMask =
2626       LangOpts.Sanitize.Mask &
2627       (SanitizerKind::Address | SanitizerKind::KernelAddress |
2628        SanitizerKind::HWAddress | SanitizerKind::KernelHWAddress |
2629        SanitizerKind::MemTag);
2630   if (!EnabledAsanMask)
2631     return false;
2632   const auto &NoSanitizeL = getContext().getNoSanitizeList();
2633   if (NoSanitizeL.containsGlobal(EnabledAsanMask, GV->getName(), Category))
2634     return true;
2635   if (NoSanitizeL.containsLocation(EnabledAsanMask, Loc, Category))
2636     return true;
2637   // Check global type.
2638   if (!Ty.isNull()) {
2639     // Drill down the array types: if global variable of a fixed type is
2640     // not sanitized, we also don't instrument arrays of them.
2641     while (auto AT = dyn_cast<ArrayType>(Ty.getTypePtr()))
2642       Ty = AT->getElementType();
2643     Ty = Ty.getCanonicalType().getUnqualifiedType();
2644     // Only record types (classes, structs etc.) are ignored.
2645     if (Ty->isRecordType()) {
2646       std::string TypeStr = Ty.getAsString(getContext().getPrintingPolicy());
2647       if (NoSanitizeL.containsType(EnabledAsanMask, TypeStr, Category))
2648         return true;
2649     }
2650   }
2651   return false;
2652 }
2653 
2654 bool CodeGenModule::imbueXRayAttrs(llvm::Function *Fn, SourceLocation Loc,
2655                                    StringRef Category) const {
2656   const auto &XRayFilter = getContext().getXRayFilter();
2657   using ImbueAttr = XRayFunctionFilter::ImbueAttribute;
2658   auto Attr = ImbueAttr::NONE;
2659   if (Loc.isValid())
2660     Attr = XRayFilter.shouldImbueLocation(Loc, Category);
2661   if (Attr == ImbueAttr::NONE)
2662     Attr = XRayFilter.shouldImbueFunction(Fn->getName());
2663   switch (Attr) {
2664   case ImbueAttr::NONE:
2665     return false;
2666   case ImbueAttr::ALWAYS:
2667     Fn->addFnAttr("function-instrument", "xray-always");
2668     break;
2669   case ImbueAttr::ALWAYS_ARG1:
2670     Fn->addFnAttr("function-instrument", "xray-always");
2671     Fn->addFnAttr("xray-log-args", "1");
2672     break;
2673   case ImbueAttr::NEVER:
2674     Fn->addFnAttr("function-instrument", "xray-never");
2675     break;
2676   }
2677   return true;
2678 }
2679 
2680 bool CodeGenModule::isProfileInstrExcluded(llvm::Function *Fn,
2681                                            SourceLocation Loc) const {
2682   const auto &ProfileList = getContext().getProfileList();
2683   // If the profile list is empty, then instrument everything.
2684   if (ProfileList.isEmpty())
2685     return false;
2686   CodeGenOptions::ProfileInstrKind Kind = getCodeGenOpts().getProfileInstr();
2687   // First, check the function name.
2688   Optional<bool> V = ProfileList.isFunctionExcluded(Fn->getName(), Kind);
2689   if (V.hasValue())
2690     return *V;
2691   // Next, check the source location.
2692   if (Loc.isValid()) {
2693     Optional<bool> V = ProfileList.isLocationExcluded(Loc, Kind);
2694     if (V.hasValue())
2695       return *V;
2696   }
2697   // If location is unknown, this may be a compiler-generated function. Assume
2698   // it's located in the main file.
2699   auto &SM = Context.getSourceManager();
2700   if (const auto *MainFile = SM.getFileEntryForID(SM.getMainFileID())) {
2701     Optional<bool> V = ProfileList.isFileExcluded(MainFile->getName(), Kind);
2702     if (V.hasValue())
2703       return *V;
2704   }
2705   return ProfileList.getDefault();
2706 }
2707 
2708 bool CodeGenModule::MustBeEmitted(const ValueDecl *Global) {
2709   // Never defer when EmitAllDecls is specified.
2710   if (LangOpts.EmitAllDecls)
2711     return true;
2712 
2713   if (CodeGenOpts.KeepStaticConsts) {
2714     const auto *VD = dyn_cast<VarDecl>(Global);
2715     if (VD && VD->getType().isConstQualified() &&
2716         VD->getStorageDuration() == SD_Static)
2717       return true;
2718   }
2719 
2720   return getContext().DeclMustBeEmitted(Global);
2721 }
2722 
2723 bool CodeGenModule::MayBeEmittedEagerly(const ValueDecl *Global) {
2724   // In OpenMP 5.0 variables and function may be marked as
2725   // device_type(host/nohost) and we should not emit them eagerly unless we sure
2726   // that they must be emitted on the host/device. To be sure we need to have
2727   // seen a declare target with an explicit mentioning of the function, we know
2728   // we have if the level of the declare target attribute is -1. Note that we
2729   // check somewhere else if we should emit this at all.
2730   if (LangOpts.OpenMP >= 50 && !LangOpts.OpenMPSimd) {
2731     llvm::Optional<OMPDeclareTargetDeclAttr *> ActiveAttr =
2732         OMPDeclareTargetDeclAttr::getActiveAttr(Global);
2733     if (!ActiveAttr || (*ActiveAttr)->getLevel() != (unsigned)-1)
2734       return false;
2735   }
2736 
2737   if (const auto *FD = dyn_cast<FunctionDecl>(Global)) {
2738     if (FD->getTemplateSpecializationKind() == TSK_ImplicitInstantiation)
2739       // Implicit template instantiations may change linkage if they are later
2740       // explicitly instantiated, so they should not be emitted eagerly.
2741       return false;
2742   }
2743   if (const auto *VD = dyn_cast<VarDecl>(Global))
2744     if (Context.getInlineVariableDefinitionKind(VD) ==
2745         ASTContext::InlineVariableDefinitionKind::WeakUnknown)
2746       // A definition of an inline constexpr static data member may change
2747       // linkage later if it's redeclared outside the class.
2748       return false;
2749   // If OpenMP is enabled and threadprivates must be generated like TLS, delay
2750   // codegen for global variables, because they may be marked as threadprivate.
2751   if (LangOpts.OpenMP && LangOpts.OpenMPUseTLS &&
2752       getContext().getTargetInfo().isTLSSupported() && isa<VarDecl>(Global) &&
2753       !isTypeConstant(Global->getType(), false) &&
2754       !OMPDeclareTargetDeclAttr::isDeclareTargetDeclaration(Global))
2755     return false;
2756 
2757   return true;
2758 }
2759 
2760 ConstantAddress CodeGenModule::GetAddrOfMSGuidDecl(const MSGuidDecl *GD) {
2761   StringRef Name = getMangledName(GD);
2762 
2763   // The UUID descriptor should be pointer aligned.
2764   CharUnits Alignment = CharUnits::fromQuantity(PointerAlignInBytes);
2765 
2766   // Look for an existing global.
2767   if (llvm::GlobalVariable *GV = getModule().getNamedGlobal(Name))
2768     return ConstantAddress(GV, Alignment);
2769 
2770   ConstantEmitter Emitter(*this);
2771   llvm::Constant *Init;
2772 
2773   APValue &V = GD->getAsAPValue();
2774   if (!V.isAbsent()) {
2775     // If possible, emit the APValue version of the initializer. In particular,
2776     // this gets the type of the constant right.
2777     Init = Emitter.emitForInitializer(
2778         GD->getAsAPValue(), GD->getType().getAddressSpace(), GD->getType());
2779   } else {
2780     // As a fallback, directly construct the constant.
2781     // FIXME: This may get padding wrong under esoteric struct layout rules.
2782     // MSVC appears to create a complete type 'struct __s_GUID' that it
2783     // presumably uses to represent these constants.
2784     MSGuidDecl::Parts Parts = GD->getParts();
2785     llvm::Constant *Fields[4] = {
2786         llvm::ConstantInt::get(Int32Ty, Parts.Part1),
2787         llvm::ConstantInt::get(Int16Ty, Parts.Part2),
2788         llvm::ConstantInt::get(Int16Ty, Parts.Part3),
2789         llvm::ConstantDataArray::getRaw(
2790             StringRef(reinterpret_cast<char *>(Parts.Part4And5), 8), 8,
2791             Int8Ty)};
2792     Init = llvm::ConstantStruct::getAnon(Fields);
2793   }
2794 
2795   auto *GV = new llvm::GlobalVariable(
2796       getModule(), Init->getType(),
2797       /*isConstant=*/true, llvm::GlobalValue::LinkOnceODRLinkage, Init, Name);
2798   if (supportsCOMDAT())
2799     GV->setComdat(TheModule.getOrInsertComdat(GV->getName()));
2800   setDSOLocal(GV);
2801 
2802   llvm::Constant *Addr = GV;
2803   if (!V.isAbsent()) {
2804     Emitter.finalize(GV);
2805   } else {
2806     llvm::Type *Ty = getTypes().ConvertTypeForMem(GD->getType());
2807     Addr = llvm::ConstantExpr::getBitCast(
2808         GV, Ty->getPointerTo(GV->getAddressSpace()));
2809   }
2810   return ConstantAddress(Addr, Alignment);
2811 }
2812 
2813 ConstantAddress CodeGenModule::GetAddrOfTemplateParamObject(
2814     const TemplateParamObjectDecl *TPO) {
2815   StringRef Name = getMangledName(TPO);
2816   CharUnits Alignment = getNaturalTypeAlignment(TPO->getType());
2817 
2818   if (llvm::GlobalVariable *GV = getModule().getNamedGlobal(Name))
2819     return ConstantAddress(GV, Alignment);
2820 
2821   ConstantEmitter Emitter(*this);
2822   llvm::Constant *Init = Emitter.emitForInitializer(
2823         TPO->getValue(), TPO->getType().getAddressSpace(), TPO->getType());
2824 
2825   if (!Init) {
2826     ErrorUnsupported(TPO, "template parameter object");
2827     return ConstantAddress::invalid();
2828   }
2829 
2830   auto *GV = new llvm::GlobalVariable(
2831       getModule(), Init->getType(),
2832       /*isConstant=*/true, llvm::GlobalValue::LinkOnceODRLinkage, Init, Name);
2833   if (supportsCOMDAT())
2834     GV->setComdat(TheModule.getOrInsertComdat(GV->getName()));
2835   Emitter.finalize(GV);
2836 
2837   return ConstantAddress(GV, Alignment);
2838 }
2839 
2840 ConstantAddress CodeGenModule::GetWeakRefReference(const ValueDecl *VD) {
2841   const AliasAttr *AA = VD->getAttr<AliasAttr>();
2842   assert(AA && "No alias?");
2843 
2844   CharUnits Alignment = getContext().getDeclAlign(VD);
2845   llvm::Type *DeclTy = getTypes().ConvertTypeForMem(VD->getType());
2846 
2847   // See if there is already something with the target's name in the module.
2848   llvm::GlobalValue *Entry = GetGlobalValue(AA->getAliasee());
2849   if (Entry) {
2850     unsigned AS = getContext().getTargetAddressSpace(VD->getType());
2851     auto Ptr = llvm::ConstantExpr::getBitCast(Entry, DeclTy->getPointerTo(AS));
2852     return ConstantAddress(Ptr, Alignment);
2853   }
2854 
2855   llvm::Constant *Aliasee;
2856   if (isa<llvm::FunctionType>(DeclTy))
2857     Aliasee = GetOrCreateLLVMFunction(AA->getAliasee(), DeclTy,
2858                                       GlobalDecl(cast<FunctionDecl>(VD)),
2859                                       /*ForVTable=*/false);
2860   else
2861     Aliasee = GetOrCreateLLVMGlobal(AA->getAliasee(), DeclTy, LangAS::Default,
2862                                     nullptr);
2863 
2864   auto *F = cast<llvm::GlobalValue>(Aliasee);
2865   F->setLinkage(llvm::Function::ExternalWeakLinkage);
2866   WeakRefReferences.insert(F);
2867 
2868   return ConstantAddress(Aliasee, Alignment);
2869 }
2870 
2871 void CodeGenModule::EmitGlobal(GlobalDecl GD) {
2872   const auto *Global = cast<ValueDecl>(GD.getDecl());
2873 
2874   // Weak references don't produce any output by themselves.
2875   if (Global->hasAttr<WeakRefAttr>())
2876     return;
2877 
2878   // If this is an alias definition (which otherwise looks like a declaration)
2879   // emit it now.
2880   if (Global->hasAttr<AliasAttr>())
2881     return EmitAliasDefinition(GD);
2882 
2883   // IFunc like an alias whose value is resolved at runtime by calling resolver.
2884   if (Global->hasAttr<IFuncAttr>())
2885     return emitIFuncDefinition(GD);
2886 
2887   // If this is a cpu_dispatch multiversion function, emit the resolver.
2888   if (Global->hasAttr<CPUDispatchAttr>())
2889     return emitCPUDispatchDefinition(GD);
2890 
2891   // If this is CUDA, be selective about which declarations we emit.
2892   if (LangOpts.CUDA) {
2893     if (LangOpts.CUDAIsDevice) {
2894       if (!Global->hasAttr<CUDADeviceAttr>() &&
2895           !Global->hasAttr<CUDAGlobalAttr>() &&
2896           !Global->hasAttr<CUDAConstantAttr>() &&
2897           !Global->hasAttr<CUDASharedAttr>() &&
2898           !Global->getType()->isCUDADeviceBuiltinSurfaceType() &&
2899           !Global->getType()->isCUDADeviceBuiltinTextureType())
2900         return;
2901     } else {
2902       // We need to emit host-side 'shadows' for all global
2903       // device-side variables because the CUDA runtime needs their
2904       // size and host-side address in order to provide access to
2905       // their device-side incarnations.
2906 
2907       // So device-only functions are the only things we skip.
2908       if (isa<FunctionDecl>(Global) && !Global->hasAttr<CUDAHostAttr>() &&
2909           Global->hasAttr<CUDADeviceAttr>())
2910         return;
2911 
2912       assert((isa<FunctionDecl>(Global) || isa<VarDecl>(Global)) &&
2913              "Expected Variable or Function");
2914     }
2915   }
2916 
2917   if (LangOpts.OpenMP) {
2918     // If this is OpenMP, check if it is legal to emit this global normally.
2919     if (OpenMPRuntime && OpenMPRuntime->emitTargetGlobal(GD))
2920       return;
2921     if (auto *DRD = dyn_cast<OMPDeclareReductionDecl>(Global)) {
2922       if (MustBeEmitted(Global))
2923         EmitOMPDeclareReduction(DRD);
2924       return;
2925     } else if (auto *DMD = dyn_cast<OMPDeclareMapperDecl>(Global)) {
2926       if (MustBeEmitted(Global))
2927         EmitOMPDeclareMapper(DMD);
2928       return;
2929     }
2930   }
2931 
2932   // Ignore declarations, they will be emitted on their first use.
2933   if (const auto *FD = dyn_cast<FunctionDecl>(Global)) {
2934     // Forward declarations are emitted lazily on first use.
2935     if (!FD->doesThisDeclarationHaveABody()) {
2936       if (!FD->doesDeclarationForceExternallyVisibleDefinition())
2937         return;
2938 
2939       StringRef MangledName = getMangledName(GD);
2940 
2941       // Compute the function info and LLVM type.
2942       const CGFunctionInfo &FI = getTypes().arrangeGlobalDeclaration(GD);
2943       llvm::Type *Ty = getTypes().GetFunctionType(FI);
2944 
2945       GetOrCreateLLVMFunction(MangledName, Ty, GD, /*ForVTable=*/false,
2946                               /*DontDefer=*/false);
2947       return;
2948     }
2949   } else {
2950     const auto *VD = cast<VarDecl>(Global);
2951     assert(VD->isFileVarDecl() && "Cannot emit local var decl as global.");
2952     if (VD->isThisDeclarationADefinition() != VarDecl::Definition &&
2953         !Context.isMSStaticDataMemberInlineDefinition(VD)) {
2954       if (LangOpts.OpenMP) {
2955         // Emit declaration of the must-be-emitted declare target variable.
2956         if (llvm::Optional<OMPDeclareTargetDeclAttr::MapTypeTy> Res =
2957                 OMPDeclareTargetDeclAttr::isDeclareTargetDeclaration(VD)) {
2958           bool UnifiedMemoryEnabled =
2959               getOpenMPRuntime().hasRequiresUnifiedSharedMemory();
2960           if (*Res == OMPDeclareTargetDeclAttr::MT_To &&
2961               !UnifiedMemoryEnabled) {
2962             (void)GetAddrOfGlobalVar(VD);
2963           } else {
2964             assert(((*Res == OMPDeclareTargetDeclAttr::MT_Link) ||
2965                     (*Res == OMPDeclareTargetDeclAttr::MT_To &&
2966                      UnifiedMemoryEnabled)) &&
2967                    "Link clause or to clause with unified memory expected.");
2968             (void)getOpenMPRuntime().getAddrOfDeclareTargetVar(VD);
2969           }
2970 
2971           return;
2972         }
2973       }
2974       // If this declaration may have caused an inline variable definition to
2975       // change linkage, make sure that it's emitted.
2976       if (Context.getInlineVariableDefinitionKind(VD) ==
2977           ASTContext::InlineVariableDefinitionKind::Strong)
2978         GetAddrOfGlobalVar(VD);
2979       return;
2980     }
2981   }
2982 
2983   // Defer code generation to first use when possible, e.g. if this is an inline
2984   // function. If the global must always be emitted, do it eagerly if possible
2985   // to benefit from cache locality.
2986   if (MustBeEmitted(Global) && MayBeEmittedEagerly(Global)) {
2987     // Emit the definition if it can't be deferred.
2988     EmitGlobalDefinition(GD);
2989     return;
2990   }
2991 
2992   // If we're deferring emission of a C++ variable with an
2993   // initializer, remember the order in which it appeared in the file.
2994   if (getLangOpts().CPlusPlus && isa<VarDecl>(Global) &&
2995       cast<VarDecl>(Global)->hasInit()) {
2996     DelayedCXXInitPosition[Global] = CXXGlobalInits.size();
2997     CXXGlobalInits.push_back(nullptr);
2998   }
2999 
3000   StringRef MangledName = getMangledName(GD);
3001   if (GetGlobalValue(MangledName) != nullptr) {
3002     // The value has already been used and should therefore be emitted.
3003     addDeferredDeclToEmit(GD);
3004   } else if (MustBeEmitted(Global)) {
3005     // The value must be emitted, but cannot be emitted eagerly.
3006     assert(!MayBeEmittedEagerly(Global));
3007     addDeferredDeclToEmit(GD);
3008   } else {
3009     // Otherwise, remember that we saw a deferred decl with this name.  The
3010     // first use of the mangled name will cause it to move into
3011     // DeferredDeclsToEmit.
3012     DeferredDecls[MangledName] = GD;
3013   }
3014 }
3015 
3016 // Check if T is a class type with a destructor that's not dllimport.
3017 static bool HasNonDllImportDtor(QualType T) {
3018   if (const auto *RT = T->getBaseElementTypeUnsafe()->getAs<RecordType>())
3019     if (CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(RT->getDecl()))
3020       if (RD->getDestructor() && !RD->getDestructor()->hasAttr<DLLImportAttr>())
3021         return true;
3022 
3023   return false;
3024 }
3025 
3026 namespace {
3027   struct FunctionIsDirectlyRecursive
3028       : public ConstStmtVisitor<FunctionIsDirectlyRecursive, bool> {
3029     const StringRef Name;
3030     const Builtin::Context &BI;
3031     FunctionIsDirectlyRecursive(StringRef N, const Builtin::Context &C)
3032         : Name(N), BI(C) {}
3033 
3034     bool VisitCallExpr(const CallExpr *E) {
3035       const FunctionDecl *FD = E->getDirectCallee();
3036       if (!FD)
3037         return false;
3038       AsmLabelAttr *Attr = FD->getAttr<AsmLabelAttr>();
3039       if (Attr && Name == Attr->getLabel())
3040         return true;
3041       unsigned BuiltinID = FD->getBuiltinID();
3042       if (!BuiltinID || !BI.isLibFunction(BuiltinID))
3043         return false;
3044       StringRef BuiltinName = BI.getName(BuiltinID);
3045       if (BuiltinName.startswith("__builtin_") &&
3046           Name == BuiltinName.slice(strlen("__builtin_"), StringRef::npos)) {
3047         return true;
3048       }
3049       return false;
3050     }
3051 
3052     bool VisitStmt(const Stmt *S) {
3053       for (const Stmt *Child : S->children())
3054         if (Child && this->Visit(Child))
3055           return true;
3056       return false;
3057     }
3058   };
3059 
3060   // Make sure we're not referencing non-imported vars or functions.
3061   struct DLLImportFunctionVisitor
3062       : public RecursiveASTVisitor<DLLImportFunctionVisitor> {
3063     bool SafeToInline = true;
3064 
3065     bool shouldVisitImplicitCode() const { return true; }
3066 
3067     bool VisitVarDecl(VarDecl *VD) {
3068       if (VD->getTLSKind()) {
3069         // A thread-local variable cannot be imported.
3070         SafeToInline = false;
3071         return SafeToInline;
3072       }
3073 
3074       // A variable definition might imply a destructor call.
3075       if (VD->isThisDeclarationADefinition())
3076         SafeToInline = !HasNonDllImportDtor(VD->getType());
3077 
3078       return SafeToInline;
3079     }
3080 
3081     bool VisitCXXBindTemporaryExpr(CXXBindTemporaryExpr *E) {
3082       if (const auto *D = E->getTemporary()->getDestructor())
3083         SafeToInline = D->hasAttr<DLLImportAttr>();
3084       return SafeToInline;
3085     }
3086 
3087     bool VisitDeclRefExpr(DeclRefExpr *E) {
3088       ValueDecl *VD = E->getDecl();
3089       if (isa<FunctionDecl>(VD))
3090         SafeToInline = VD->hasAttr<DLLImportAttr>();
3091       else if (VarDecl *V = dyn_cast<VarDecl>(VD))
3092         SafeToInline = !V->hasGlobalStorage() || V->hasAttr<DLLImportAttr>();
3093       return SafeToInline;
3094     }
3095 
3096     bool VisitCXXConstructExpr(CXXConstructExpr *E) {
3097       SafeToInline = E->getConstructor()->hasAttr<DLLImportAttr>();
3098       return SafeToInline;
3099     }
3100 
3101     bool VisitCXXMemberCallExpr(CXXMemberCallExpr *E) {
3102       CXXMethodDecl *M = E->getMethodDecl();
3103       if (!M) {
3104         // Call through a pointer to member function. This is safe to inline.
3105         SafeToInline = true;
3106       } else {
3107         SafeToInline = M->hasAttr<DLLImportAttr>();
3108       }
3109       return SafeToInline;
3110     }
3111 
3112     bool VisitCXXDeleteExpr(CXXDeleteExpr *E) {
3113       SafeToInline = E->getOperatorDelete()->hasAttr<DLLImportAttr>();
3114       return SafeToInline;
3115     }
3116 
3117     bool VisitCXXNewExpr(CXXNewExpr *E) {
3118       SafeToInline = E->getOperatorNew()->hasAttr<DLLImportAttr>();
3119       return SafeToInline;
3120     }
3121   };
3122 }
3123 
3124 // isTriviallyRecursive - Check if this function calls another
3125 // decl that, because of the asm attribute or the other decl being a builtin,
3126 // ends up pointing to itself.
3127 bool
3128 CodeGenModule::isTriviallyRecursive(const FunctionDecl *FD) {
3129   StringRef Name;
3130   if (getCXXABI().getMangleContext().shouldMangleDeclName(FD)) {
3131     // asm labels are a special kind of mangling we have to support.
3132     AsmLabelAttr *Attr = FD->getAttr<AsmLabelAttr>();
3133     if (!Attr)
3134       return false;
3135     Name = Attr->getLabel();
3136   } else {
3137     Name = FD->getName();
3138   }
3139 
3140   FunctionIsDirectlyRecursive Walker(Name, Context.BuiltinInfo);
3141   const Stmt *Body = FD->getBody();
3142   return Body ? Walker.Visit(Body) : false;
3143 }
3144 
3145 bool CodeGenModule::shouldEmitFunction(GlobalDecl GD) {
3146   if (getFunctionLinkage(GD) != llvm::Function::AvailableExternallyLinkage)
3147     return true;
3148   const auto *F = cast<FunctionDecl>(GD.getDecl());
3149   if (CodeGenOpts.OptimizationLevel == 0 && !F->hasAttr<AlwaysInlineAttr>())
3150     return false;
3151 
3152   if (F->hasAttr<DLLImportAttr>() && !F->hasAttr<AlwaysInlineAttr>()) {
3153     // Check whether it would be safe to inline this dllimport function.
3154     DLLImportFunctionVisitor Visitor;
3155     Visitor.TraverseFunctionDecl(const_cast<FunctionDecl*>(F));
3156     if (!Visitor.SafeToInline)
3157       return false;
3158 
3159     if (const CXXDestructorDecl *Dtor = dyn_cast<CXXDestructorDecl>(F)) {
3160       // Implicit destructor invocations aren't captured in the AST, so the
3161       // check above can't see them. Check for them manually here.
3162       for (const Decl *Member : Dtor->getParent()->decls())
3163         if (isa<FieldDecl>(Member))
3164           if (HasNonDllImportDtor(cast<FieldDecl>(Member)->getType()))
3165             return false;
3166       for (const CXXBaseSpecifier &B : Dtor->getParent()->bases())
3167         if (HasNonDllImportDtor(B.getType()))
3168           return false;
3169     }
3170   }
3171 
3172   // PR9614. Avoid cases where the source code is lying to us. An available
3173   // externally function should have an equivalent function somewhere else,
3174   // but a function that calls itself through asm label/`__builtin_` trickery is
3175   // clearly not equivalent to the real implementation.
3176   // This happens in glibc's btowc and in some configure checks.
3177   return !isTriviallyRecursive(F);
3178 }
3179 
3180 bool CodeGenModule::shouldOpportunisticallyEmitVTables() {
3181   return CodeGenOpts.OptimizationLevel > 0;
3182 }
3183 
3184 void CodeGenModule::EmitMultiVersionFunctionDefinition(GlobalDecl GD,
3185                                                        llvm::GlobalValue *GV) {
3186   const auto *FD = cast<FunctionDecl>(GD.getDecl());
3187 
3188   if (FD->isCPUSpecificMultiVersion()) {
3189     auto *Spec = FD->getAttr<CPUSpecificAttr>();
3190     for (unsigned I = 0; I < Spec->cpus_size(); ++I)
3191       EmitGlobalFunctionDefinition(GD.getWithMultiVersionIndex(I), nullptr);
3192     // Requires multiple emits.
3193   } else
3194     EmitGlobalFunctionDefinition(GD, GV);
3195 }
3196 
3197 void CodeGenModule::EmitGlobalDefinition(GlobalDecl GD, llvm::GlobalValue *GV) {
3198   const auto *D = cast<ValueDecl>(GD.getDecl());
3199 
3200   PrettyStackTraceDecl CrashInfo(const_cast<ValueDecl *>(D), D->getLocation(),
3201                                  Context.getSourceManager(),
3202                                  "Generating code for declaration");
3203 
3204   if (const auto *FD = dyn_cast<FunctionDecl>(D)) {
3205     // At -O0, don't generate IR for functions with available_externally
3206     // linkage.
3207     if (!shouldEmitFunction(GD))
3208       return;
3209 
3210     llvm::TimeTraceScope TimeScope("CodeGen Function", [&]() {
3211       std::string Name;
3212       llvm::raw_string_ostream OS(Name);
3213       FD->getNameForDiagnostic(OS, getContext().getPrintingPolicy(),
3214                                /*Qualified=*/true);
3215       return Name;
3216     });
3217 
3218     if (const auto *Method = dyn_cast<CXXMethodDecl>(D)) {
3219       // Make sure to emit the definition(s) before we emit the thunks.
3220       // This is necessary for the generation of certain thunks.
3221       if (isa<CXXConstructorDecl>(Method) || isa<CXXDestructorDecl>(Method))
3222         ABI->emitCXXStructor(GD);
3223       else if (FD->isMultiVersion())
3224         EmitMultiVersionFunctionDefinition(GD, GV);
3225       else
3226         EmitGlobalFunctionDefinition(GD, GV);
3227 
3228       if (Method->isVirtual())
3229         getVTables().EmitThunks(GD);
3230 
3231       return;
3232     }
3233 
3234     if (FD->isMultiVersion())
3235       return EmitMultiVersionFunctionDefinition(GD, GV);
3236     return EmitGlobalFunctionDefinition(GD, GV);
3237   }
3238 
3239   if (const auto *VD = dyn_cast<VarDecl>(D))
3240     return EmitGlobalVarDefinition(VD, !VD->hasDefinition());
3241 
3242   llvm_unreachable("Invalid argument to EmitGlobalDefinition()");
3243 }
3244 
3245 static void ReplaceUsesOfNonProtoTypeWithRealFunction(llvm::GlobalValue *Old,
3246                                                       llvm::Function *NewFn);
3247 
3248 static unsigned
3249 TargetMVPriority(const TargetInfo &TI,
3250                  const CodeGenFunction::MultiVersionResolverOption &RO) {
3251   unsigned Priority = 0;
3252   for (StringRef Feat : RO.Conditions.Features)
3253     Priority = std::max(Priority, TI.multiVersionSortPriority(Feat));
3254 
3255   if (!RO.Conditions.Architecture.empty())
3256     Priority = std::max(
3257         Priority, TI.multiVersionSortPriority(RO.Conditions.Architecture));
3258   return Priority;
3259 }
3260 
3261 void CodeGenModule::emitMultiVersionFunctions() {
3262   std::vector<GlobalDecl> MVFuncsToEmit;
3263   MultiVersionFuncs.swap(MVFuncsToEmit);
3264   for (GlobalDecl GD : MVFuncsToEmit) {
3265     SmallVector<CodeGenFunction::MultiVersionResolverOption, 10> Options;
3266     const FunctionDecl *FD = cast<FunctionDecl>(GD.getDecl());
3267     getContext().forEachMultiversionedFunctionVersion(
3268         FD, [this, &GD, &Options](const FunctionDecl *CurFD) {
3269           GlobalDecl CurGD{
3270               (CurFD->isDefined() ? CurFD->getDefinition() : CurFD)};
3271           StringRef MangledName = getMangledName(CurGD);
3272           llvm::Constant *Func = GetGlobalValue(MangledName);
3273           if (!Func) {
3274             if (CurFD->isDefined()) {
3275               EmitGlobalFunctionDefinition(CurGD, nullptr);
3276               Func = GetGlobalValue(MangledName);
3277             } else {
3278               const CGFunctionInfo &FI =
3279                   getTypes().arrangeGlobalDeclaration(GD);
3280               llvm::FunctionType *Ty = getTypes().GetFunctionType(FI);
3281               Func = GetAddrOfFunction(CurGD, Ty, /*ForVTable=*/false,
3282                                        /*DontDefer=*/false, ForDefinition);
3283             }
3284             assert(Func && "This should have just been created");
3285           }
3286 
3287           const auto *TA = CurFD->getAttr<TargetAttr>();
3288           llvm::SmallVector<StringRef, 8> Feats;
3289           TA->getAddedFeatures(Feats);
3290 
3291           Options.emplace_back(cast<llvm::Function>(Func),
3292                                TA->getArchitecture(), Feats);
3293         });
3294 
3295     llvm::Function *ResolverFunc;
3296     const TargetInfo &TI = getTarget();
3297 
3298     if (TI.supportsIFunc() || FD->isTargetMultiVersion()) {
3299       ResolverFunc = cast<llvm::Function>(
3300           GetGlobalValue((getMangledName(GD) + ".resolver").str()));
3301       ResolverFunc->setLinkage(llvm::Function::WeakODRLinkage);
3302     } else {
3303       ResolverFunc = cast<llvm::Function>(GetGlobalValue(getMangledName(GD)));
3304     }
3305 
3306     if (supportsCOMDAT())
3307       ResolverFunc->setComdat(
3308           getModule().getOrInsertComdat(ResolverFunc->getName()));
3309 
3310     llvm::stable_sort(
3311         Options, [&TI](const CodeGenFunction::MultiVersionResolverOption &LHS,
3312                        const CodeGenFunction::MultiVersionResolverOption &RHS) {
3313           return TargetMVPriority(TI, LHS) > TargetMVPriority(TI, RHS);
3314         });
3315     CodeGenFunction CGF(*this);
3316     CGF.EmitMultiVersionResolver(ResolverFunc, Options);
3317   }
3318 
3319   // Ensure that any additions to the deferred decls list caused by emitting a
3320   // variant are emitted.  This can happen when the variant itself is inline and
3321   // calls a function without linkage.
3322   if (!MVFuncsToEmit.empty())
3323     EmitDeferred();
3324 
3325   // Ensure that any additions to the multiversion funcs list from either the
3326   // deferred decls or the multiversion functions themselves are emitted.
3327   if (!MultiVersionFuncs.empty())
3328     emitMultiVersionFunctions();
3329 }
3330 
3331 void CodeGenModule::emitCPUDispatchDefinition(GlobalDecl GD) {
3332   const auto *FD = cast<FunctionDecl>(GD.getDecl());
3333   assert(FD && "Not a FunctionDecl?");
3334   const auto *DD = FD->getAttr<CPUDispatchAttr>();
3335   assert(DD && "Not a cpu_dispatch Function?");
3336   llvm::Type *DeclTy = getTypes().ConvertType(FD->getType());
3337 
3338   if (const auto *CXXFD = dyn_cast<CXXMethodDecl>(FD)) {
3339     const CGFunctionInfo &FInfo = getTypes().arrangeCXXMethodDeclaration(CXXFD);
3340     DeclTy = getTypes().GetFunctionType(FInfo);
3341   }
3342 
3343   StringRef ResolverName = getMangledName(GD);
3344 
3345   llvm::Type *ResolverType;
3346   GlobalDecl ResolverGD;
3347   if (getTarget().supportsIFunc())
3348     ResolverType = llvm::FunctionType::get(
3349         llvm::PointerType::get(DeclTy,
3350                                Context.getTargetAddressSpace(FD->getType())),
3351         false);
3352   else {
3353     ResolverType = DeclTy;
3354     ResolverGD = GD;
3355   }
3356 
3357   auto *ResolverFunc = cast<llvm::Function>(GetOrCreateLLVMFunction(
3358       ResolverName, ResolverType, ResolverGD, /*ForVTable=*/false));
3359   ResolverFunc->setLinkage(llvm::Function::WeakODRLinkage);
3360   if (supportsCOMDAT())
3361     ResolverFunc->setComdat(
3362         getModule().getOrInsertComdat(ResolverFunc->getName()));
3363 
3364   SmallVector<CodeGenFunction::MultiVersionResolverOption, 10> Options;
3365   const TargetInfo &Target = getTarget();
3366   unsigned Index = 0;
3367   for (const IdentifierInfo *II : DD->cpus()) {
3368     // Get the name of the target function so we can look it up/create it.
3369     std::string MangledName = getMangledNameImpl(*this, GD, FD, true) +
3370                               getCPUSpecificMangling(*this, II->getName());
3371 
3372     llvm::Constant *Func = GetGlobalValue(MangledName);
3373 
3374     if (!Func) {
3375       GlobalDecl ExistingDecl = Manglings.lookup(MangledName);
3376       if (ExistingDecl.getDecl() &&
3377           ExistingDecl.getDecl()->getAsFunction()->isDefined()) {
3378         EmitGlobalFunctionDefinition(ExistingDecl, nullptr);
3379         Func = GetGlobalValue(MangledName);
3380       } else {
3381         if (!ExistingDecl.getDecl())
3382           ExistingDecl = GD.getWithMultiVersionIndex(Index);
3383 
3384       Func = GetOrCreateLLVMFunction(
3385           MangledName, DeclTy, ExistingDecl,
3386           /*ForVTable=*/false, /*DontDefer=*/true,
3387           /*IsThunk=*/false, llvm::AttributeList(), ForDefinition);
3388       }
3389     }
3390 
3391     llvm::SmallVector<StringRef, 32> Features;
3392     Target.getCPUSpecificCPUDispatchFeatures(II->getName(), Features);
3393     llvm::transform(Features, Features.begin(),
3394                     [](StringRef Str) { return Str.substr(1); });
3395     Features.erase(std::remove_if(
3396         Features.begin(), Features.end(), [&Target](StringRef Feat) {
3397           return !Target.validateCpuSupports(Feat);
3398         }), Features.end());
3399     Options.emplace_back(cast<llvm::Function>(Func), StringRef{}, Features);
3400     ++Index;
3401   }
3402 
3403   llvm::stable_sort(
3404       Options, [](const CodeGenFunction::MultiVersionResolverOption &LHS,
3405                   const CodeGenFunction::MultiVersionResolverOption &RHS) {
3406         return llvm::X86::getCpuSupportsMask(LHS.Conditions.Features) >
3407                llvm::X86::getCpuSupportsMask(RHS.Conditions.Features);
3408       });
3409 
3410   // If the list contains multiple 'default' versions, such as when it contains
3411   // 'pentium' and 'generic', don't emit the call to the generic one (since we
3412   // always run on at least a 'pentium'). We do this by deleting the 'least
3413   // advanced' (read, lowest mangling letter).
3414   while (Options.size() > 1 &&
3415          llvm::X86::getCpuSupportsMask(
3416              (Options.end() - 2)->Conditions.Features) == 0) {
3417     StringRef LHSName = (Options.end() - 2)->Function->getName();
3418     StringRef RHSName = (Options.end() - 1)->Function->getName();
3419     if (LHSName.compare(RHSName) < 0)
3420       Options.erase(Options.end() - 2);
3421     else
3422       Options.erase(Options.end() - 1);
3423   }
3424 
3425   CodeGenFunction CGF(*this);
3426   CGF.EmitMultiVersionResolver(ResolverFunc, Options);
3427 
3428   if (getTarget().supportsIFunc()) {
3429     std::string AliasName = getMangledNameImpl(
3430         *this, GD, FD, /*OmitMultiVersionMangling=*/true);
3431     llvm::Constant *AliasFunc = GetGlobalValue(AliasName);
3432     if (!AliasFunc) {
3433       auto *IFunc = cast<llvm::GlobalIFunc>(GetOrCreateLLVMFunction(
3434           AliasName, DeclTy, GD, /*ForVTable=*/false, /*DontDefer=*/true,
3435           /*IsThunk=*/false, llvm::AttributeList(), NotForDefinition));
3436       auto *GA = llvm::GlobalAlias::create(
3437          DeclTy, 0, getFunctionLinkage(GD), AliasName, IFunc, &getModule());
3438       GA->setLinkage(llvm::Function::WeakODRLinkage);
3439       SetCommonAttributes(GD, GA);
3440     }
3441   }
3442 }
3443 
3444 /// If a dispatcher for the specified mangled name is not in the module, create
3445 /// and return an llvm Function with the specified type.
3446 llvm::Constant *CodeGenModule::GetOrCreateMultiVersionResolver(
3447     GlobalDecl GD, llvm::Type *DeclTy, const FunctionDecl *FD) {
3448   std::string MangledName =
3449       getMangledNameImpl(*this, GD, FD, /*OmitMultiVersionMangling=*/true);
3450 
3451   // Holds the name of the resolver, in ifunc mode this is the ifunc (which has
3452   // a separate resolver).
3453   std::string ResolverName = MangledName;
3454   if (getTarget().supportsIFunc())
3455     ResolverName += ".ifunc";
3456   else if (FD->isTargetMultiVersion())
3457     ResolverName += ".resolver";
3458 
3459   // If this already exists, just return that one.
3460   if (llvm::GlobalValue *ResolverGV = GetGlobalValue(ResolverName))
3461     return ResolverGV;
3462 
3463   // Since this is the first time we've created this IFunc, make sure
3464   // that we put this multiversioned function into the list to be
3465   // replaced later if necessary (target multiversioning only).
3466   if (!FD->isCPUDispatchMultiVersion() && !FD->isCPUSpecificMultiVersion())
3467     MultiVersionFuncs.push_back(GD);
3468 
3469   if (getTarget().supportsIFunc()) {
3470     llvm::Type *ResolverType = llvm::FunctionType::get(
3471         llvm::PointerType::get(
3472             DeclTy, getContext().getTargetAddressSpace(FD->getType())),
3473         false);
3474     llvm::Constant *Resolver = GetOrCreateLLVMFunction(
3475         MangledName + ".resolver", ResolverType, GlobalDecl{},
3476         /*ForVTable=*/false);
3477     llvm::GlobalIFunc *GIF = llvm::GlobalIFunc::create(
3478         DeclTy, 0, llvm::Function::WeakODRLinkage, "", Resolver, &getModule());
3479     GIF->setName(ResolverName);
3480     SetCommonAttributes(FD, GIF);
3481 
3482     return GIF;
3483   }
3484 
3485   llvm::Constant *Resolver = GetOrCreateLLVMFunction(
3486       ResolverName, DeclTy, GlobalDecl{}, /*ForVTable=*/false);
3487   assert(isa<llvm::GlobalValue>(Resolver) &&
3488          "Resolver should be created for the first time");
3489   SetCommonAttributes(FD, cast<llvm::GlobalValue>(Resolver));
3490   return Resolver;
3491 }
3492 
3493 /// GetOrCreateLLVMFunction - If the specified mangled name is not in the
3494 /// module, create and return an llvm Function with the specified type. If there
3495 /// is something in the module with the specified name, return it potentially
3496 /// bitcasted to the right type.
3497 ///
3498 /// If D is non-null, it specifies a decl that correspond to this.  This is used
3499 /// to set the attributes on the function when it is first created.
3500 llvm::Constant *CodeGenModule::GetOrCreateLLVMFunction(
3501     StringRef MangledName, llvm::Type *Ty, GlobalDecl GD, bool ForVTable,
3502     bool DontDefer, bool IsThunk, llvm::AttributeList ExtraAttrs,
3503     ForDefinition_t IsForDefinition) {
3504   const Decl *D = GD.getDecl();
3505 
3506   // Any attempts to use a MultiVersion function should result in retrieving
3507   // the iFunc instead. Name Mangling will handle the rest of the changes.
3508   if (const FunctionDecl *FD = cast_or_null<FunctionDecl>(D)) {
3509     // For the device mark the function as one that should be emitted.
3510     if (getLangOpts().OpenMPIsDevice && OpenMPRuntime &&
3511         !OpenMPRuntime->markAsGlobalTarget(GD) && FD->isDefined() &&
3512         !DontDefer && !IsForDefinition) {
3513       if (const FunctionDecl *FDDef = FD->getDefinition()) {
3514         GlobalDecl GDDef;
3515         if (const auto *CD = dyn_cast<CXXConstructorDecl>(FDDef))
3516           GDDef = GlobalDecl(CD, GD.getCtorType());
3517         else if (const auto *DD = dyn_cast<CXXDestructorDecl>(FDDef))
3518           GDDef = GlobalDecl(DD, GD.getDtorType());
3519         else
3520           GDDef = GlobalDecl(FDDef);
3521         EmitGlobal(GDDef);
3522       }
3523     }
3524 
3525     if (FD->isMultiVersion()) {
3526       if (FD->hasAttr<TargetAttr>())
3527         UpdateMultiVersionNames(GD, FD);
3528       if (!IsForDefinition)
3529         return GetOrCreateMultiVersionResolver(GD, Ty, FD);
3530     }
3531   }
3532 
3533   // Lookup the entry, lazily creating it if necessary.
3534   llvm::GlobalValue *Entry = GetGlobalValue(MangledName);
3535   if (Entry) {
3536     if (WeakRefReferences.erase(Entry)) {
3537       const FunctionDecl *FD = cast_or_null<FunctionDecl>(D);
3538       if (FD && !FD->hasAttr<WeakAttr>())
3539         Entry->setLinkage(llvm::Function::ExternalLinkage);
3540     }
3541 
3542     // Handle dropped DLL attributes.
3543     if (D && !D->hasAttr<DLLImportAttr>() && !D->hasAttr<DLLExportAttr>()) {
3544       Entry->setDLLStorageClass(llvm::GlobalValue::DefaultStorageClass);
3545       setDSOLocal(Entry);
3546     }
3547 
3548     // If there are two attempts to define the same mangled name, issue an
3549     // error.
3550     if (IsForDefinition && !Entry->isDeclaration()) {
3551       GlobalDecl OtherGD;
3552       // Check that GD is not yet in DiagnosedConflictingDefinitions is required
3553       // to make sure that we issue an error only once.
3554       if (lookupRepresentativeDecl(MangledName, OtherGD) &&
3555           (GD.getCanonicalDecl().getDecl() !=
3556            OtherGD.getCanonicalDecl().getDecl()) &&
3557           DiagnosedConflictingDefinitions.insert(GD).second) {
3558         getDiags().Report(D->getLocation(), diag::err_duplicate_mangled_name)
3559             << MangledName;
3560         getDiags().Report(OtherGD.getDecl()->getLocation(),
3561                           diag::note_previous_definition);
3562       }
3563     }
3564 
3565     if ((isa<llvm::Function>(Entry) || isa<llvm::GlobalAlias>(Entry)) &&
3566         (Entry->getValueType() == Ty)) {
3567       return Entry;
3568     }
3569 
3570     // Make sure the result is of the correct type.
3571     // (If function is requested for a definition, we always need to create a new
3572     // function, not just return a bitcast.)
3573     if (!IsForDefinition)
3574       return llvm::ConstantExpr::getBitCast(Entry, Ty->getPointerTo());
3575   }
3576 
3577   // This function doesn't have a complete type (for example, the return
3578   // type is an incomplete struct). Use a fake type instead, and make
3579   // sure not to try to set attributes.
3580   bool IsIncompleteFunction = false;
3581 
3582   llvm::FunctionType *FTy;
3583   if (isa<llvm::FunctionType>(Ty)) {
3584     FTy = cast<llvm::FunctionType>(Ty);
3585   } else {
3586     FTy = llvm::FunctionType::get(VoidTy, false);
3587     IsIncompleteFunction = true;
3588   }
3589 
3590   llvm::Function *F =
3591       llvm::Function::Create(FTy, llvm::Function::ExternalLinkage,
3592                              Entry ? StringRef() : MangledName, &getModule());
3593 
3594   // If we already created a function with the same mangled name (but different
3595   // type) before, take its name and add it to the list of functions to be
3596   // replaced with F at the end of CodeGen.
3597   //
3598   // This happens if there is a prototype for a function (e.g. "int f()") and
3599   // then a definition of a different type (e.g. "int f(int x)").
3600   if (Entry) {
3601     F->takeName(Entry);
3602 
3603     // This might be an implementation of a function without a prototype, in
3604     // which case, try to do special replacement of calls which match the new
3605     // prototype.  The really key thing here is that we also potentially drop
3606     // arguments from the call site so as to make a direct call, which makes the
3607     // inliner happier and suppresses a number of optimizer warnings (!) about
3608     // dropping arguments.
3609     if (!Entry->use_empty()) {
3610       ReplaceUsesOfNonProtoTypeWithRealFunction(Entry, F);
3611       Entry->removeDeadConstantUsers();
3612     }
3613 
3614     llvm::Constant *BC = llvm::ConstantExpr::getBitCast(
3615         F, Entry->getValueType()->getPointerTo());
3616     addGlobalValReplacement(Entry, BC);
3617   }
3618 
3619   assert(F->getName() == MangledName && "name was uniqued!");
3620   if (D)
3621     SetFunctionAttributes(GD, F, IsIncompleteFunction, IsThunk);
3622   if (ExtraAttrs.hasFnAttrs()) {
3623     llvm::AttrBuilder B(ExtraAttrs, llvm::AttributeList::FunctionIndex);
3624     F->addFnAttrs(B);
3625   }
3626 
3627   if (!DontDefer) {
3628     // All MSVC dtors other than the base dtor are linkonce_odr and delegate to
3629     // each other bottoming out with the base dtor.  Therefore we emit non-base
3630     // dtors on usage, even if there is no dtor definition in the TU.
3631     if (D && isa<CXXDestructorDecl>(D) &&
3632         getCXXABI().useThunkForDtorVariant(cast<CXXDestructorDecl>(D),
3633                                            GD.getDtorType()))
3634       addDeferredDeclToEmit(GD);
3635 
3636     // This is the first use or definition of a mangled name.  If there is a
3637     // deferred decl with this name, remember that we need to emit it at the end
3638     // of the file.
3639     auto DDI = DeferredDecls.find(MangledName);
3640     if (DDI != DeferredDecls.end()) {
3641       // Move the potentially referenced deferred decl to the
3642       // DeferredDeclsToEmit list, and remove it from DeferredDecls (since we
3643       // don't need it anymore).
3644       addDeferredDeclToEmit(DDI->second);
3645       DeferredDecls.erase(DDI);
3646 
3647       // Otherwise, there are cases we have to worry about where we're
3648       // using a declaration for which we must emit a definition but where
3649       // we might not find a top-level definition:
3650       //   - member functions defined inline in their classes
3651       //   - friend functions defined inline in some class
3652       //   - special member functions with implicit definitions
3653       // If we ever change our AST traversal to walk into class methods,
3654       // this will be unnecessary.
3655       //
3656       // We also don't emit a definition for a function if it's going to be an
3657       // entry in a vtable, unless it's already marked as used.
3658     } else if (getLangOpts().CPlusPlus && D) {
3659       // Look for a declaration that's lexically in a record.
3660       for (const auto *FD = cast<FunctionDecl>(D)->getMostRecentDecl(); FD;
3661            FD = FD->getPreviousDecl()) {
3662         if (isa<CXXRecordDecl>(FD->getLexicalDeclContext())) {
3663           if (FD->doesThisDeclarationHaveABody()) {
3664             addDeferredDeclToEmit(GD.getWithDecl(FD));
3665             break;
3666           }
3667         }
3668       }
3669     }
3670   }
3671 
3672   // Make sure the result is of the requested type.
3673   if (!IsIncompleteFunction) {
3674     assert(F->getFunctionType() == Ty);
3675     return F;
3676   }
3677 
3678   llvm::Type *PTy = llvm::PointerType::getUnqual(Ty);
3679   return llvm::ConstantExpr::getBitCast(F, PTy);
3680 }
3681 
3682 /// GetAddrOfFunction - Return the address of the given function.  If Ty is
3683 /// non-null, then this function will use the specified type if it has to
3684 /// create it (this occurs when we see a definition of the function).
3685 llvm::Constant *CodeGenModule::GetAddrOfFunction(GlobalDecl GD,
3686                                                  llvm::Type *Ty,
3687                                                  bool ForVTable,
3688                                                  bool DontDefer,
3689                                               ForDefinition_t IsForDefinition) {
3690   assert(!cast<FunctionDecl>(GD.getDecl())->isConsteval() &&
3691          "consteval function should never be emitted");
3692   // If there was no specific requested type, just convert it now.
3693   if (!Ty) {
3694     const auto *FD = cast<FunctionDecl>(GD.getDecl());
3695     Ty = getTypes().ConvertType(FD->getType());
3696   }
3697 
3698   // Devirtualized destructor calls may come through here instead of via
3699   // getAddrOfCXXStructor. Make sure we use the MS ABI base destructor instead
3700   // of the complete destructor when necessary.
3701   if (const auto *DD = dyn_cast<CXXDestructorDecl>(GD.getDecl())) {
3702     if (getTarget().getCXXABI().isMicrosoft() &&
3703         GD.getDtorType() == Dtor_Complete &&
3704         DD->getParent()->getNumVBases() == 0)
3705       GD = GlobalDecl(DD, Dtor_Base);
3706   }
3707 
3708   StringRef MangledName = getMangledName(GD);
3709   auto *F = GetOrCreateLLVMFunction(MangledName, Ty, GD, ForVTable, DontDefer,
3710                                     /*IsThunk=*/false, llvm::AttributeList(),
3711                                     IsForDefinition);
3712   // Returns kernel handle for HIP kernel stub function.
3713   if (LangOpts.CUDA && !LangOpts.CUDAIsDevice &&
3714       cast<FunctionDecl>(GD.getDecl())->hasAttr<CUDAGlobalAttr>()) {
3715     auto *Handle = getCUDARuntime().getKernelHandle(
3716         cast<llvm::Function>(F->stripPointerCasts()), GD);
3717     if (IsForDefinition)
3718       return F;
3719     return llvm::ConstantExpr::getBitCast(Handle, Ty->getPointerTo());
3720   }
3721   return F;
3722 }
3723 
3724 static const FunctionDecl *
3725 GetRuntimeFunctionDecl(ASTContext &C, StringRef Name) {
3726   TranslationUnitDecl *TUDecl = C.getTranslationUnitDecl();
3727   DeclContext *DC = TranslationUnitDecl::castToDeclContext(TUDecl);
3728 
3729   IdentifierInfo &CII = C.Idents.get(Name);
3730   for (const auto *Result : DC->lookup(&CII))
3731     if (const auto *FD = dyn_cast<FunctionDecl>(Result))
3732       return FD;
3733 
3734   if (!C.getLangOpts().CPlusPlus)
3735     return nullptr;
3736 
3737   // Demangle the premangled name from getTerminateFn()
3738   IdentifierInfo &CXXII =
3739       (Name == "_ZSt9terminatev" || Name == "?terminate@@YAXXZ")
3740           ? C.Idents.get("terminate")
3741           : C.Idents.get(Name);
3742 
3743   for (const auto &N : {"__cxxabiv1", "std"}) {
3744     IdentifierInfo &NS = C.Idents.get(N);
3745     for (const auto *Result : DC->lookup(&NS)) {
3746       const NamespaceDecl *ND = dyn_cast<NamespaceDecl>(Result);
3747       if (auto *LSD = dyn_cast<LinkageSpecDecl>(Result))
3748         for (const auto *Result : LSD->lookup(&NS))
3749           if ((ND = dyn_cast<NamespaceDecl>(Result)))
3750             break;
3751 
3752       if (ND)
3753         for (const auto *Result : ND->lookup(&CXXII))
3754           if (const auto *FD = dyn_cast<FunctionDecl>(Result))
3755             return FD;
3756     }
3757   }
3758 
3759   return nullptr;
3760 }
3761 
3762 /// CreateRuntimeFunction - Create a new runtime function with the specified
3763 /// type and name.
3764 llvm::FunctionCallee
3765 CodeGenModule::CreateRuntimeFunction(llvm::FunctionType *FTy, StringRef Name,
3766                                      llvm::AttributeList ExtraAttrs, bool Local,
3767                                      bool AssumeConvergent) {
3768   if (AssumeConvergent) {
3769     ExtraAttrs =
3770         ExtraAttrs.addFnAttribute(VMContext, llvm::Attribute::Convergent);
3771   }
3772 
3773   llvm::Constant *C =
3774       GetOrCreateLLVMFunction(Name, FTy, GlobalDecl(), /*ForVTable=*/false,
3775                               /*DontDefer=*/false, /*IsThunk=*/false,
3776                               ExtraAttrs);
3777 
3778   if (auto *F = dyn_cast<llvm::Function>(C)) {
3779     if (F->empty()) {
3780       F->setCallingConv(getRuntimeCC());
3781 
3782       // In Windows Itanium environments, try to mark runtime functions
3783       // dllimport. For Mingw and MSVC, don't. We don't really know if the user
3784       // will link their standard library statically or dynamically. Marking
3785       // functions imported when they are not imported can cause linker errors
3786       // and warnings.
3787       if (!Local && getTriple().isWindowsItaniumEnvironment() &&
3788           !getCodeGenOpts().LTOVisibilityPublicStd) {
3789         const FunctionDecl *FD = GetRuntimeFunctionDecl(Context, Name);
3790         if (!FD || FD->hasAttr<DLLImportAttr>()) {
3791           F->setDLLStorageClass(llvm::GlobalValue::DLLImportStorageClass);
3792           F->setLinkage(llvm::GlobalValue::ExternalLinkage);
3793         }
3794       }
3795       setDSOLocal(F);
3796     }
3797   }
3798 
3799   return {FTy, C};
3800 }
3801 
3802 /// isTypeConstant - Determine whether an object of this type can be emitted
3803 /// as a constant.
3804 ///
3805 /// If ExcludeCtor is true, the duration when the object's constructor runs
3806 /// will not be considered. The caller will need to verify that the object is
3807 /// not written to during its construction.
3808 bool CodeGenModule::isTypeConstant(QualType Ty, bool ExcludeCtor) {
3809   if (!Ty.isConstant(Context) && !Ty->isReferenceType())
3810     return false;
3811 
3812   if (Context.getLangOpts().CPlusPlus) {
3813     if (const CXXRecordDecl *Record
3814           = Context.getBaseElementType(Ty)->getAsCXXRecordDecl())
3815       return ExcludeCtor && !Record->hasMutableFields() &&
3816              Record->hasTrivialDestructor();
3817   }
3818 
3819   return true;
3820 }
3821 
3822 /// GetOrCreateLLVMGlobal - If the specified mangled name is not in the module,
3823 /// create and return an llvm GlobalVariable with the specified type and address
3824 /// space. If there is something in the module with the specified name, return
3825 /// it potentially bitcasted to the right type.
3826 ///
3827 /// If D is non-null, it specifies a decl that correspond to this.  This is used
3828 /// to set the attributes on the global when it is first created.
3829 ///
3830 /// If IsForDefinition is true, it is guaranteed that an actual global with
3831 /// type Ty will be returned, not conversion of a variable with the same
3832 /// mangled name but some other type.
3833 llvm::Constant *
3834 CodeGenModule::GetOrCreateLLVMGlobal(StringRef MangledName, llvm::Type *Ty,
3835                                      LangAS AddrSpace, const VarDecl *D,
3836                                      ForDefinition_t IsForDefinition) {
3837   // Lookup the entry, lazily creating it if necessary.
3838   llvm::GlobalValue *Entry = GetGlobalValue(MangledName);
3839   unsigned TargetAS = getContext().getTargetAddressSpace(AddrSpace);
3840   if (Entry) {
3841     if (WeakRefReferences.erase(Entry)) {
3842       if (D && !D->hasAttr<WeakAttr>())
3843         Entry->setLinkage(llvm::Function::ExternalLinkage);
3844     }
3845 
3846     // Handle dropped DLL attributes.
3847     if (D && !D->hasAttr<DLLImportAttr>() && !D->hasAttr<DLLExportAttr>())
3848       Entry->setDLLStorageClass(llvm::GlobalValue::DefaultStorageClass);
3849 
3850     if (LangOpts.OpenMP && !LangOpts.OpenMPSimd && D)
3851       getOpenMPRuntime().registerTargetGlobalVariable(D, Entry);
3852 
3853     if (Entry->getValueType() == Ty && Entry->getAddressSpace() == TargetAS)
3854       return Entry;
3855 
3856     // If there are two attempts to define the same mangled name, issue an
3857     // error.
3858     if (IsForDefinition && !Entry->isDeclaration()) {
3859       GlobalDecl OtherGD;
3860       const VarDecl *OtherD;
3861 
3862       // Check that D is not yet in DiagnosedConflictingDefinitions is required
3863       // to make sure that we issue an error only once.
3864       if (D && lookupRepresentativeDecl(MangledName, OtherGD) &&
3865           (D->getCanonicalDecl() != OtherGD.getCanonicalDecl().getDecl()) &&
3866           (OtherD = dyn_cast<VarDecl>(OtherGD.getDecl())) &&
3867           OtherD->hasInit() &&
3868           DiagnosedConflictingDefinitions.insert(D).second) {
3869         getDiags().Report(D->getLocation(), diag::err_duplicate_mangled_name)
3870             << MangledName;
3871         getDiags().Report(OtherGD.getDecl()->getLocation(),
3872                           diag::note_previous_definition);
3873       }
3874     }
3875 
3876     // Make sure the result is of the correct type.
3877     if (Entry->getType()->getAddressSpace() != TargetAS) {
3878       return llvm::ConstantExpr::getAddrSpaceCast(Entry,
3879                                                   Ty->getPointerTo(TargetAS));
3880     }
3881 
3882     // (If global is requested for a definition, we always need to create a new
3883     // global, not just return a bitcast.)
3884     if (!IsForDefinition)
3885       return llvm::ConstantExpr::getBitCast(Entry, Ty->getPointerTo(TargetAS));
3886   }
3887 
3888   auto DAddrSpace = GetGlobalVarAddressSpace(D);
3889 
3890   auto *GV = new llvm::GlobalVariable(
3891       getModule(), Ty, false, llvm::GlobalValue::ExternalLinkage, nullptr,
3892       MangledName, nullptr, llvm::GlobalVariable::NotThreadLocal,
3893       getContext().getTargetAddressSpace(DAddrSpace));
3894 
3895   // If we already created a global with the same mangled name (but different
3896   // type) before, take its name and remove it from its parent.
3897   if (Entry) {
3898     GV->takeName(Entry);
3899 
3900     if (!Entry->use_empty()) {
3901       llvm::Constant *NewPtrForOldDecl =
3902           llvm::ConstantExpr::getBitCast(GV, Entry->getType());
3903       Entry->replaceAllUsesWith(NewPtrForOldDecl);
3904     }
3905 
3906     Entry->eraseFromParent();
3907   }
3908 
3909   // This is the first use or definition of a mangled name.  If there is a
3910   // deferred decl with this name, remember that we need to emit it at the end
3911   // of the file.
3912   auto DDI = DeferredDecls.find(MangledName);
3913   if (DDI != DeferredDecls.end()) {
3914     // Move the potentially referenced deferred decl to the DeferredDeclsToEmit
3915     // list, and remove it from DeferredDecls (since we don't need it anymore).
3916     addDeferredDeclToEmit(DDI->second);
3917     DeferredDecls.erase(DDI);
3918   }
3919 
3920   // Handle things which are present even on external declarations.
3921   if (D) {
3922     if (LangOpts.OpenMP && !LangOpts.OpenMPSimd)
3923       getOpenMPRuntime().registerTargetGlobalVariable(D, GV);
3924 
3925     // FIXME: This code is overly simple and should be merged with other global
3926     // handling.
3927     GV->setConstant(isTypeConstant(D->getType(), false));
3928 
3929     GV->setAlignment(getContext().getDeclAlign(D).getAsAlign());
3930 
3931     setLinkageForGV(GV, D);
3932 
3933     if (D->getTLSKind()) {
3934       if (D->getTLSKind() == VarDecl::TLS_Dynamic)
3935         CXXThreadLocals.push_back(D);
3936       setTLSMode(GV, *D);
3937     }
3938 
3939     setGVProperties(GV, D);
3940 
3941     // If required by the ABI, treat declarations of static data members with
3942     // inline initializers as definitions.
3943     if (getContext().isMSStaticDataMemberInlineDefinition(D)) {
3944       EmitGlobalVarDefinition(D);
3945     }
3946 
3947     // Emit section information for extern variables.
3948     if (D->hasExternalStorage()) {
3949       if (const SectionAttr *SA = D->getAttr<SectionAttr>())
3950         GV->setSection(SA->getName());
3951     }
3952 
3953     // Handle XCore specific ABI requirements.
3954     if (getTriple().getArch() == llvm::Triple::xcore &&
3955         D->getLanguageLinkage() == CLanguageLinkage &&
3956         D->getType().isConstant(Context) &&
3957         isExternallyVisible(D->getLinkageAndVisibility().getLinkage()))
3958       GV->setSection(".cp.rodata");
3959 
3960     // Check if we a have a const declaration with an initializer, we may be
3961     // able to emit it as available_externally to expose it's value to the
3962     // optimizer.
3963     if (Context.getLangOpts().CPlusPlus && GV->hasExternalLinkage() &&
3964         D->getType().isConstQualified() && !GV->hasInitializer() &&
3965         !D->hasDefinition() && D->hasInit() && !D->hasAttr<DLLImportAttr>()) {
3966       const auto *Record =
3967           Context.getBaseElementType(D->getType())->getAsCXXRecordDecl();
3968       bool HasMutableFields = Record && Record->hasMutableFields();
3969       if (!HasMutableFields) {
3970         const VarDecl *InitDecl;
3971         const Expr *InitExpr = D->getAnyInitializer(InitDecl);
3972         if (InitExpr) {
3973           ConstantEmitter emitter(*this);
3974           llvm::Constant *Init = emitter.tryEmitForInitializer(*InitDecl);
3975           if (Init) {
3976             auto *InitType = Init->getType();
3977             if (GV->getValueType() != InitType) {
3978               // The type of the initializer does not match the definition.
3979               // This happens when an initializer has a different type from
3980               // the type of the global (because of padding at the end of a
3981               // structure for instance).
3982               GV->setName(StringRef());
3983               // Make a new global with the correct type, this is now guaranteed
3984               // to work.
3985               auto *NewGV = cast<llvm::GlobalVariable>(
3986                   GetAddrOfGlobalVar(D, InitType, IsForDefinition)
3987                       ->stripPointerCasts());
3988 
3989               // Erase the old global, since it is no longer used.
3990               GV->eraseFromParent();
3991               GV = NewGV;
3992             } else {
3993               GV->setInitializer(Init);
3994               GV->setConstant(true);
3995               GV->setLinkage(llvm::GlobalValue::AvailableExternallyLinkage);
3996             }
3997             emitter.finalize(GV);
3998           }
3999         }
4000       }
4001     }
4002   }
4003 
4004   if (GV->isDeclaration()) {
4005     getTargetCodeGenInfo().setTargetAttributes(D, GV, *this);
4006     // External HIP managed variables needed to be recorded for transformation
4007     // in both device and host compilations.
4008     if (getLangOpts().CUDA && D && D->hasAttr<HIPManagedAttr>() &&
4009         D->hasExternalStorage())
4010       getCUDARuntime().handleVarRegistration(D, *GV);
4011   }
4012 
4013   LangAS ExpectedAS =
4014       D ? D->getType().getAddressSpace()
4015         : (LangOpts.OpenCL ? LangAS::opencl_global : LangAS::Default);
4016   assert(getContext().getTargetAddressSpace(ExpectedAS) == TargetAS);
4017   if (DAddrSpace != ExpectedAS) {
4018     return getTargetCodeGenInfo().performAddrSpaceCast(
4019         *this, GV, DAddrSpace, ExpectedAS, Ty->getPointerTo(TargetAS));
4020   }
4021 
4022   return GV;
4023 }
4024 
4025 llvm::Constant *
4026 CodeGenModule::GetAddrOfGlobal(GlobalDecl GD, ForDefinition_t IsForDefinition) {
4027   const Decl *D = GD.getDecl();
4028 
4029   if (isa<CXXConstructorDecl>(D) || isa<CXXDestructorDecl>(D))
4030     return getAddrOfCXXStructor(GD, /*FnInfo=*/nullptr, /*FnType=*/nullptr,
4031                                 /*DontDefer=*/false, IsForDefinition);
4032 
4033   if (isa<CXXMethodDecl>(D)) {
4034     auto FInfo =
4035         &getTypes().arrangeCXXMethodDeclaration(cast<CXXMethodDecl>(D));
4036     auto Ty = getTypes().GetFunctionType(*FInfo);
4037     return GetAddrOfFunction(GD, Ty, /*ForVTable=*/false, /*DontDefer=*/false,
4038                              IsForDefinition);
4039   }
4040 
4041   if (isa<FunctionDecl>(D)) {
4042     const CGFunctionInfo &FI = getTypes().arrangeGlobalDeclaration(GD);
4043     llvm::FunctionType *Ty = getTypes().GetFunctionType(FI);
4044     return GetAddrOfFunction(GD, Ty, /*ForVTable=*/false, /*DontDefer=*/false,
4045                              IsForDefinition);
4046   }
4047 
4048   return GetAddrOfGlobalVar(cast<VarDecl>(D), /*Ty=*/nullptr, IsForDefinition);
4049 }
4050 
4051 llvm::GlobalVariable *CodeGenModule::CreateOrReplaceCXXRuntimeVariable(
4052     StringRef Name, llvm::Type *Ty, llvm::GlobalValue::LinkageTypes Linkage,
4053     unsigned Alignment) {
4054   llvm::GlobalVariable *GV = getModule().getNamedGlobal(Name);
4055   llvm::GlobalVariable *OldGV = nullptr;
4056 
4057   if (GV) {
4058     // Check if the variable has the right type.
4059     if (GV->getValueType() == Ty)
4060       return GV;
4061 
4062     // Because C++ name mangling, the only way we can end up with an already
4063     // existing global with the same name is if it has been declared extern "C".
4064     assert(GV->isDeclaration() && "Declaration has wrong type!");
4065     OldGV = GV;
4066   }
4067 
4068   // Create a new variable.
4069   GV = new llvm::GlobalVariable(getModule(), Ty, /*isConstant=*/true,
4070                                 Linkage, nullptr, Name);
4071 
4072   if (OldGV) {
4073     // Replace occurrences of the old variable if needed.
4074     GV->takeName(OldGV);
4075 
4076     if (!OldGV->use_empty()) {
4077       llvm::Constant *NewPtrForOldDecl =
4078       llvm::ConstantExpr::getBitCast(GV, OldGV->getType());
4079       OldGV->replaceAllUsesWith(NewPtrForOldDecl);
4080     }
4081 
4082     OldGV->eraseFromParent();
4083   }
4084 
4085   if (supportsCOMDAT() && GV->isWeakForLinker() &&
4086       !GV->hasAvailableExternallyLinkage())
4087     GV->setComdat(TheModule.getOrInsertComdat(GV->getName()));
4088 
4089   GV->setAlignment(llvm::MaybeAlign(Alignment));
4090 
4091   return GV;
4092 }
4093 
4094 /// GetAddrOfGlobalVar - Return the llvm::Constant for the address of the
4095 /// given global variable.  If Ty is non-null and if the global doesn't exist,
4096 /// then it will be created with the specified type instead of whatever the
4097 /// normal requested type would be. If IsForDefinition is true, it is guaranteed
4098 /// that an actual global with type Ty will be returned, not conversion of a
4099 /// variable with the same mangled name but some other type.
4100 llvm::Constant *CodeGenModule::GetAddrOfGlobalVar(const VarDecl *D,
4101                                                   llvm::Type *Ty,
4102                                            ForDefinition_t IsForDefinition) {
4103   assert(D->hasGlobalStorage() && "Not a global variable");
4104   QualType ASTTy = D->getType();
4105   if (!Ty)
4106     Ty = getTypes().ConvertTypeForMem(ASTTy);
4107 
4108   StringRef MangledName = getMangledName(D);
4109   return GetOrCreateLLVMGlobal(MangledName, Ty, ASTTy.getAddressSpace(), D,
4110                                IsForDefinition);
4111 }
4112 
4113 /// CreateRuntimeVariable - Create a new runtime global variable with the
4114 /// specified type and name.
4115 llvm::Constant *
4116 CodeGenModule::CreateRuntimeVariable(llvm::Type *Ty,
4117                                      StringRef Name) {
4118   LangAS AddrSpace = getContext().getLangOpts().OpenCL ? LangAS::opencl_global
4119                                                        : LangAS::Default;
4120   auto *Ret = GetOrCreateLLVMGlobal(Name, Ty, AddrSpace, nullptr);
4121   setDSOLocal(cast<llvm::GlobalValue>(Ret->stripPointerCasts()));
4122   return Ret;
4123 }
4124 
4125 void CodeGenModule::EmitTentativeDefinition(const VarDecl *D) {
4126   assert(!D->getInit() && "Cannot emit definite definitions here!");
4127 
4128   StringRef MangledName = getMangledName(D);
4129   llvm::GlobalValue *GV = GetGlobalValue(MangledName);
4130 
4131   // We already have a definition, not declaration, with the same mangled name.
4132   // Emitting of declaration is not required (and actually overwrites emitted
4133   // definition).
4134   if (GV && !GV->isDeclaration())
4135     return;
4136 
4137   // If we have not seen a reference to this variable yet, place it into the
4138   // deferred declarations table to be emitted if needed later.
4139   if (!MustBeEmitted(D) && !GV) {
4140       DeferredDecls[MangledName] = D;
4141       return;
4142   }
4143 
4144   // The tentative definition is the only definition.
4145   EmitGlobalVarDefinition(D);
4146 }
4147 
4148 void CodeGenModule::EmitExternalDeclaration(const VarDecl *D) {
4149   EmitExternalVarDeclaration(D);
4150 }
4151 
4152 CharUnits CodeGenModule::GetTargetTypeStoreSize(llvm::Type *Ty) const {
4153   return Context.toCharUnitsFromBits(
4154       getDataLayout().getTypeStoreSizeInBits(Ty));
4155 }
4156 
4157 LangAS CodeGenModule::GetGlobalVarAddressSpace(const VarDecl *D) {
4158   if (LangOpts.OpenCL) {
4159     LangAS AS = D ? D->getType().getAddressSpace() : LangAS::opencl_global;
4160     assert(AS == LangAS::opencl_global ||
4161            AS == LangAS::opencl_global_device ||
4162            AS == LangAS::opencl_global_host ||
4163            AS == LangAS::opencl_constant ||
4164            AS == LangAS::opencl_local ||
4165            AS >= LangAS::FirstTargetAddressSpace);
4166     return AS;
4167   }
4168 
4169   if (LangOpts.SYCLIsDevice &&
4170       (!D || D->getType().getAddressSpace() == LangAS::Default))
4171     return LangAS::sycl_global;
4172 
4173   if (LangOpts.CUDA && LangOpts.CUDAIsDevice) {
4174     if (D && D->hasAttr<CUDAConstantAttr>())
4175       return LangAS::cuda_constant;
4176     else if (D && D->hasAttr<CUDASharedAttr>())
4177       return LangAS::cuda_shared;
4178     else if (D && D->hasAttr<CUDADeviceAttr>())
4179       return LangAS::cuda_device;
4180     else if (D && D->getType().isConstQualified())
4181       return LangAS::cuda_constant;
4182     else
4183       return LangAS::cuda_device;
4184   }
4185 
4186   if (LangOpts.OpenMP) {
4187     LangAS AS;
4188     if (OpenMPRuntime->hasAllocateAttributeForGlobalVar(D, AS))
4189       return AS;
4190   }
4191   return getTargetCodeGenInfo().getGlobalVarAddressSpace(*this, D);
4192 }
4193 
4194 LangAS CodeGenModule::GetGlobalConstantAddressSpace() const {
4195   // OpenCL v1.2 s6.5.3: a string literal is in the constant address space.
4196   if (LangOpts.OpenCL)
4197     return LangAS::opencl_constant;
4198   if (LangOpts.SYCLIsDevice)
4199     return LangAS::sycl_global;
4200   if (auto AS = getTarget().getConstantAddressSpace())
4201     return AS.getValue();
4202   return LangAS::Default;
4203 }
4204 
4205 // In address space agnostic languages, string literals are in default address
4206 // space in AST. However, certain targets (e.g. amdgcn) request them to be
4207 // emitted in constant address space in LLVM IR. To be consistent with other
4208 // parts of AST, string literal global variables in constant address space
4209 // need to be casted to default address space before being put into address
4210 // map and referenced by other part of CodeGen.
4211 // In OpenCL, string literals are in constant address space in AST, therefore
4212 // they should not be casted to default address space.
4213 static llvm::Constant *
4214 castStringLiteralToDefaultAddressSpace(CodeGenModule &CGM,
4215                                        llvm::GlobalVariable *GV) {
4216   llvm::Constant *Cast = GV;
4217   if (!CGM.getLangOpts().OpenCL) {
4218     auto AS = CGM.GetGlobalConstantAddressSpace();
4219     if (AS != LangAS::Default)
4220       Cast = CGM.getTargetCodeGenInfo().performAddrSpaceCast(
4221           CGM, GV, AS, LangAS::Default,
4222           GV->getValueType()->getPointerTo(
4223               CGM.getContext().getTargetAddressSpace(LangAS::Default)));
4224   }
4225   return Cast;
4226 }
4227 
4228 template<typename SomeDecl>
4229 void CodeGenModule::MaybeHandleStaticInExternC(const SomeDecl *D,
4230                                                llvm::GlobalValue *GV) {
4231   if (!getLangOpts().CPlusPlus)
4232     return;
4233 
4234   // Must have 'used' attribute, or else inline assembly can't rely on
4235   // the name existing.
4236   if (!D->template hasAttr<UsedAttr>())
4237     return;
4238 
4239   // Must have internal linkage and an ordinary name.
4240   if (!D->getIdentifier() || D->getFormalLinkage() != InternalLinkage)
4241     return;
4242 
4243   // Must be in an extern "C" context. Entities declared directly within
4244   // a record are not extern "C" even if the record is in such a context.
4245   const SomeDecl *First = D->getFirstDecl();
4246   if (First->getDeclContext()->isRecord() || !First->isInExternCContext())
4247     return;
4248 
4249   // OK, this is an internal linkage entity inside an extern "C" linkage
4250   // specification. Make a note of that so we can give it the "expected"
4251   // mangled name if nothing else is using that name.
4252   std::pair<StaticExternCMap::iterator, bool> R =
4253       StaticExternCValues.insert(std::make_pair(D->getIdentifier(), GV));
4254 
4255   // If we have multiple internal linkage entities with the same name
4256   // in extern "C" regions, none of them gets that name.
4257   if (!R.second)
4258     R.first->second = nullptr;
4259 }
4260 
4261 static bool shouldBeInCOMDAT(CodeGenModule &CGM, const Decl &D) {
4262   if (!CGM.supportsCOMDAT())
4263     return false;
4264 
4265   // Do not set COMDAT attribute for CUDA/HIP stub functions to prevent
4266   // them being "merged" by the COMDAT Folding linker optimization.
4267   if (D.hasAttr<CUDAGlobalAttr>())
4268     return false;
4269 
4270   if (D.hasAttr<SelectAnyAttr>())
4271     return true;
4272 
4273   GVALinkage Linkage;
4274   if (auto *VD = dyn_cast<VarDecl>(&D))
4275     Linkage = CGM.getContext().GetGVALinkageForVariable(VD);
4276   else
4277     Linkage = CGM.getContext().GetGVALinkageForFunction(cast<FunctionDecl>(&D));
4278 
4279   switch (Linkage) {
4280   case GVA_Internal:
4281   case GVA_AvailableExternally:
4282   case GVA_StrongExternal:
4283     return false;
4284   case GVA_DiscardableODR:
4285   case GVA_StrongODR:
4286     return true;
4287   }
4288   llvm_unreachable("No such linkage");
4289 }
4290 
4291 void CodeGenModule::maybeSetTrivialComdat(const Decl &D,
4292                                           llvm::GlobalObject &GO) {
4293   if (!shouldBeInCOMDAT(*this, D))
4294     return;
4295   GO.setComdat(TheModule.getOrInsertComdat(GO.getName()));
4296 }
4297 
4298 /// Pass IsTentative as true if you want to create a tentative definition.
4299 void CodeGenModule::EmitGlobalVarDefinition(const VarDecl *D,
4300                                             bool IsTentative) {
4301   // OpenCL global variables of sampler type are translated to function calls,
4302   // therefore no need to be translated.
4303   QualType ASTTy = D->getType();
4304   if (getLangOpts().OpenCL && ASTTy->isSamplerT())
4305     return;
4306 
4307   // If this is OpenMP device, check if it is legal to emit this global
4308   // normally.
4309   if (LangOpts.OpenMPIsDevice && OpenMPRuntime &&
4310       OpenMPRuntime->emitTargetGlobalVariable(D))
4311     return;
4312 
4313   llvm::TrackingVH<llvm::Constant> Init;
4314   bool NeedsGlobalCtor = false;
4315   bool NeedsGlobalDtor =
4316       D->needsDestruction(getContext()) == QualType::DK_cxx_destructor;
4317 
4318   const VarDecl *InitDecl;
4319   const Expr *InitExpr = D->getAnyInitializer(InitDecl);
4320 
4321   Optional<ConstantEmitter> emitter;
4322 
4323   // CUDA E.2.4.1 "__shared__ variables cannot have an initialization
4324   // as part of their declaration."  Sema has already checked for
4325   // error cases, so we just need to set Init to UndefValue.
4326   bool IsCUDASharedVar =
4327       getLangOpts().CUDAIsDevice && D->hasAttr<CUDASharedAttr>();
4328   // Shadows of initialized device-side global variables are also left
4329   // undefined.
4330   // Managed Variables should be initialized on both host side and device side.
4331   bool IsCUDAShadowVar =
4332       !getLangOpts().CUDAIsDevice && !D->hasAttr<HIPManagedAttr>() &&
4333       (D->hasAttr<CUDAConstantAttr>() || D->hasAttr<CUDADeviceAttr>() ||
4334        D->hasAttr<CUDASharedAttr>());
4335   bool IsCUDADeviceShadowVar =
4336       getLangOpts().CUDAIsDevice && !D->hasAttr<HIPManagedAttr>() &&
4337       (D->getType()->isCUDADeviceBuiltinSurfaceType() ||
4338        D->getType()->isCUDADeviceBuiltinTextureType());
4339   if (getLangOpts().CUDA &&
4340       (IsCUDASharedVar || IsCUDAShadowVar || IsCUDADeviceShadowVar))
4341     Init = llvm::UndefValue::get(getTypes().ConvertTypeForMem(ASTTy));
4342   else if (D->hasAttr<LoaderUninitializedAttr>())
4343     Init = llvm::UndefValue::get(getTypes().ConvertTypeForMem(ASTTy));
4344   else if (!InitExpr) {
4345     // This is a tentative definition; tentative definitions are
4346     // implicitly initialized with { 0 }.
4347     //
4348     // Note that tentative definitions are only emitted at the end of
4349     // a translation unit, so they should never have incomplete
4350     // type. In addition, EmitTentativeDefinition makes sure that we
4351     // never attempt to emit a tentative definition if a real one
4352     // exists. A use may still exists, however, so we still may need
4353     // to do a RAUW.
4354     assert(!ASTTy->isIncompleteType() && "Unexpected incomplete type");
4355     Init = EmitNullConstant(D->getType());
4356   } else {
4357     initializedGlobalDecl = GlobalDecl(D);
4358     emitter.emplace(*this);
4359     llvm::Constant *Initializer = emitter->tryEmitForInitializer(*InitDecl);
4360     if (!Initializer) {
4361       QualType T = InitExpr->getType();
4362       if (D->getType()->isReferenceType())
4363         T = D->getType();
4364 
4365       if (getLangOpts().CPlusPlus) {
4366         Init = EmitNullConstant(T);
4367         NeedsGlobalCtor = true;
4368       } else {
4369         ErrorUnsupported(D, "static initializer");
4370         Init = llvm::UndefValue::get(getTypes().ConvertType(T));
4371       }
4372     } else {
4373       Init = Initializer;
4374       // We don't need an initializer, so remove the entry for the delayed
4375       // initializer position (just in case this entry was delayed) if we
4376       // also don't need to register a destructor.
4377       if (getLangOpts().CPlusPlus && !NeedsGlobalDtor)
4378         DelayedCXXInitPosition.erase(D);
4379     }
4380   }
4381 
4382   llvm::Type* InitType = Init->getType();
4383   llvm::Constant *Entry =
4384       GetAddrOfGlobalVar(D, InitType, ForDefinition_t(!IsTentative));
4385 
4386   // Strip off pointer casts if we got them.
4387   Entry = Entry->stripPointerCasts();
4388 
4389   // Entry is now either a Function or GlobalVariable.
4390   auto *GV = dyn_cast<llvm::GlobalVariable>(Entry);
4391 
4392   // We have a definition after a declaration with the wrong type.
4393   // We must make a new GlobalVariable* and update everything that used OldGV
4394   // (a declaration or tentative definition) with the new GlobalVariable*
4395   // (which will be a definition).
4396   //
4397   // This happens if there is a prototype for a global (e.g.
4398   // "extern int x[];") and then a definition of a different type (e.g.
4399   // "int x[10];"). This also happens when an initializer has a different type
4400   // from the type of the global (this happens with unions).
4401   if (!GV || GV->getValueType() != InitType ||
4402       GV->getType()->getAddressSpace() !=
4403           getContext().getTargetAddressSpace(GetGlobalVarAddressSpace(D))) {
4404 
4405     // Move the old entry aside so that we'll create a new one.
4406     Entry->setName(StringRef());
4407 
4408     // Make a new global with the correct type, this is now guaranteed to work.
4409     GV = cast<llvm::GlobalVariable>(
4410         GetAddrOfGlobalVar(D, InitType, ForDefinition_t(!IsTentative))
4411             ->stripPointerCasts());
4412 
4413     // Replace all uses of the old global with the new global
4414     llvm::Constant *NewPtrForOldDecl =
4415         llvm::ConstantExpr::getPointerBitCastOrAddrSpaceCast(GV,
4416                                                              Entry->getType());
4417     Entry->replaceAllUsesWith(NewPtrForOldDecl);
4418 
4419     // Erase the old global, since it is no longer used.
4420     cast<llvm::GlobalValue>(Entry)->eraseFromParent();
4421   }
4422 
4423   MaybeHandleStaticInExternC(D, GV);
4424 
4425   if (D->hasAttr<AnnotateAttr>())
4426     AddGlobalAnnotations(D, GV);
4427 
4428   // Set the llvm linkage type as appropriate.
4429   llvm::GlobalValue::LinkageTypes Linkage =
4430       getLLVMLinkageVarDefinition(D, GV->isConstant());
4431 
4432   // CUDA B.2.1 "The __device__ qualifier declares a variable that resides on
4433   // the device. [...]"
4434   // CUDA B.2.2 "The __constant__ qualifier, optionally used together with
4435   // __device__, declares a variable that: [...]
4436   // Is accessible from all the threads within the grid and from the host
4437   // through the runtime library (cudaGetSymbolAddress() / cudaGetSymbolSize()
4438   // / cudaMemcpyToSymbol() / cudaMemcpyFromSymbol())."
4439   if (GV && LangOpts.CUDA) {
4440     if (LangOpts.CUDAIsDevice) {
4441       if (Linkage != llvm::GlobalValue::InternalLinkage &&
4442           (D->hasAttr<CUDADeviceAttr>() || D->hasAttr<CUDAConstantAttr>() ||
4443            D->getType()->isCUDADeviceBuiltinSurfaceType() ||
4444            D->getType()->isCUDADeviceBuiltinTextureType()))
4445         GV->setExternallyInitialized(true);
4446     } else {
4447       getCUDARuntime().internalizeDeviceSideVar(D, Linkage);
4448     }
4449     getCUDARuntime().handleVarRegistration(D, *GV);
4450   }
4451 
4452   GV->setInitializer(Init);
4453   if (emitter)
4454     emitter->finalize(GV);
4455 
4456   // If it is safe to mark the global 'constant', do so now.
4457   GV->setConstant(!NeedsGlobalCtor && !NeedsGlobalDtor &&
4458                   isTypeConstant(D->getType(), true));
4459 
4460   // If it is in a read-only section, mark it 'constant'.
4461   if (const SectionAttr *SA = D->getAttr<SectionAttr>()) {
4462     const ASTContext::SectionInfo &SI = Context.SectionInfos[SA->getName()];
4463     if ((SI.SectionFlags & ASTContext::PSF_Write) == 0)
4464       GV->setConstant(true);
4465   }
4466 
4467   GV->setAlignment(getContext().getDeclAlign(D).getAsAlign());
4468 
4469   // On Darwin, unlike other Itanium C++ ABI platforms, the thread-wrapper
4470   // function is only defined alongside the variable, not also alongside
4471   // callers. Normally, all accesses to a thread_local go through the
4472   // thread-wrapper in order to ensure initialization has occurred, underlying
4473   // variable will never be used other than the thread-wrapper, so it can be
4474   // converted to internal linkage.
4475   //
4476   // However, if the variable has the 'constinit' attribute, it _can_ be
4477   // referenced directly, without calling the thread-wrapper, so the linkage
4478   // must not be changed.
4479   //
4480   // Additionally, if the variable isn't plain external linkage, e.g. if it's
4481   // weak or linkonce, the de-duplication semantics are important to preserve,
4482   // so we don't change the linkage.
4483   if (D->getTLSKind() == VarDecl::TLS_Dynamic &&
4484       Linkage == llvm::GlobalValue::ExternalLinkage &&
4485       Context.getTargetInfo().getTriple().isOSDarwin() &&
4486       !D->hasAttr<ConstInitAttr>())
4487     Linkage = llvm::GlobalValue::InternalLinkage;
4488 
4489   GV->setLinkage(Linkage);
4490   if (D->hasAttr<DLLImportAttr>())
4491     GV->setDLLStorageClass(llvm::GlobalVariable::DLLImportStorageClass);
4492   else if (D->hasAttr<DLLExportAttr>())
4493     GV->setDLLStorageClass(llvm::GlobalVariable::DLLExportStorageClass);
4494   else
4495     GV->setDLLStorageClass(llvm::GlobalVariable::DefaultStorageClass);
4496 
4497   if (Linkage == llvm::GlobalVariable::CommonLinkage) {
4498     // common vars aren't constant even if declared const.
4499     GV->setConstant(false);
4500     // Tentative definition of global variables may be initialized with
4501     // non-zero null pointers. In this case they should have weak linkage
4502     // since common linkage must have zero initializer and must not have
4503     // explicit section therefore cannot have non-zero initial value.
4504     if (!GV->getInitializer()->isNullValue())
4505       GV->setLinkage(llvm::GlobalVariable::WeakAnyLinkage);
4506   }
4507 
4508   setNonAliasAttributes(D, GV);
4509 
4510   if (D->getTLSKind() && !GV->isThreadLocal()) {
4511     if (D->getTLSKind() == VarDecl::TLS_Dynamic)
4512       CXXThreadLocals.push_back(D);
4513     setTLSMode(GV, *D);
4514   }
4515 
4516   maybeSetTrivialComdat(*D, *GV);
4517 
4518   // Emit the initializer function if necessary.
4519   if (NeedsGlobalCtor || NeedsGlobalDtor)
4520     EmitCXXGlobalVarDeclInitFunc(D, GV, NeedsGlobalCtor);
4521 
4522   SanitizerMD->reportGlobalToASan(GV, *D, NeedsGlobalCtor);
4523 
4524   // Emit global variable debug information.
4525   if (CGDebugInfo *DI = getModuleDebugInfo())
4526     if (getCodeGenOpts().hasReducedDebugInfo())
4527       DI->EmitGlobalVariable(GV, D);
4528 }
4529 
4530 void CodeGenModule::EmitExternalVarDeclaration(const VarDecl *D) {
4531   if (CGDebugInfo *DI = getModuleDebugInfo())
4532     if (getCodeGenOpts().hasReducedDebugInfo()) {
4533       QualType ASTTy = D->getType();
4534       llvm::Type *Ty = getTypes().ConvertTypeForMem(D->getType());
4535       llvm::Constant *GV =
4536           GetOrCreateLLVMGlobal(D->getName(), Ty, ASTTy.getAddressSpace(), D);
4537       DI->EmitExternalVariable(
4538           cast<llvm::GlobalVariable>(GV->stripPointerCasts()), D);
4539     }
4540 }
4541 
4542 static bool isVarDeclStrongDefinition(const ASTContext &Context,
4543                                       CodeGenModule &CGM, const VarDecl *D,
4544                                       bool NoCommon) {
4545   // Don't give variables common linkage if -fno-common was specified unless it
4546   // was overridden by a NoCommon attribute.
4547   if ((NoCommon || D->hasAttr<NoCommonAttr>()) && !D->hasAttr<CommonAttr>())
4548     return true;
4549 
4550   // C11 6.9.2/2:
4551   //   A declaration of an identifier for an object that has file scope without
4552   //   an initializer, and without a storage-class specifier or with the
4553   //   storage-class specifier static, constitutes a tentative definition.
4554   if (D->getInit() || D->hasExternalStorage())
4555     return true;
4556 
4557   // A variable cannot be both common and exist in a section.
4558   if (D->hasAttr<SectionAttr>())
4559     return true;
4560 
4561   // A variable cannot be both common and exist in a section.
4562   // We don't try to determine which is the right section in the front-end.
4563   // If no specialized section name is applicable, it will resort to default.
4564   if (D->hasAttr<PragmaClangBSSSectionAttr>() ||
4565       D->hasAttr<PragmaClangDataSectionAttr>() ||
4566       D->hasAttr<PragmaClangRelroSectionAttr>() ||
4567       D->hasAttr<PragmaClangRodataSectionAttr>())
4568     return true;
4569 
4570   // Thread local vars aren't considered common linkage.
4571   if (D->getTLSKind())
4572     return true;
4573 
4574   // Tentative definitions marked with WeakImportAttr are true definitions.
4575   if (D->hasAttr<WeakImportAttr>())
4576     return true;
4577 
4578   // A variable cannot be both common and exist in a comdat.
4579   if (shouldBeInCOMDAT(CGM, *D))
4580     return true;
4581 
4582   // Declarations with a required alignment do not have common linkage in MSVC
4583   // mode.
4584   if (Context.getTargetInfo().getCXXABI().isMicrosoft()) {
4585     if (D->hasAttr<AlignedAttr>())
4586       return true;
4587     QualType VarType = D->getType();
4588     if (Context.isAlignmentRequired(VarType))
4589       return true;
4590 
4591     if (const auto *RT = VarType->getAs<RecordType>()) {
4592       const RecordDecl *RD = RT->getDecl();
4593       for (const FieldDecl *FD : RD->fields()) {
4594         if (FD->isBitField())
4595           continue;
4596         if (FD->hasAttr<AlignedAttr>())
4597           return true;
4598         if (Context.isAlignmentRequired(FD->getType()))
4599           return true;
4600       }
4601     }
4602   }
4603 
4604   // Microsoft's link.exe doesn't support alignments greater than 32 bytes for
4605   // common symbols, so symbols with greater alignment requirements cannot be
4606   // common.
4607   // Other COFF linkers (ld.bfd and LLD) support arbitrary power-of-two
4608   // alignments for common symbols via the aligncomm directive, so this
4609   // restriction only applies to MSVC environments.
4610   if (Context.getTargetInfo().getTriple().isKnownWindowsMSVCEnvironment() &&
4611       Context.getTypeAlignIfKnown(D->getType()) >
4612           Context.toBits(CharUnits::fromQuantity(32)))
4613     return true;
4614 
4615   return false;
4616 }
4617 
4618 llvm::GlobalValue::LinkageTypes CodeGenModule::getLLVMLinkageForDeclarator(
4619     const DeclaratorDecl *D, GVALinkage Linkage, bool IsConstantVariable) {
4620   if (Linkage == GVA_Internal)
4621     return llvm::Function::InternalLinkage;
4622 
4623   if (D->hasAttr<WeakAttr>()) {
4624     if (IsConstantVariable)
4625       return llvm::GlobalVariable::WeakODRLinkage;
4626     else
4627       return llvm::GlobalVariable::WeakAnyLinkage;
4628   }
4629 
4630   if (const auto *FD = D->getAsFunction())
4631     if (FD->isMultiVersion() && Linkage == GVA_AvailableExternally)
4632       return llvm::GlobalVariable::LinkOnceAnyLinkage;
4633 
4634   // We are guaranteed to have a strong definition somewhere else,
4635   // so we can use available_externally linkage.
4636   if (Linkage == GVA_AvailableExternally)
4637     return llvm::GlobalValue::AvailableExternallyLinkage;
4638 
4639   // Note that Apple's kernel linker doesn't support symbol
4640   // coalescing, so we need to avoid linkonce and weak linkages there.
4641   // Normally, this means we just map to internal, but for explicit
4642   // instantiations we'll map to external.
4643 
4644   // In C++, the compiler has to emit a definition in every translation unit
4645   // that references the function.  We should use linkonce_odr because
4646   // a) if all references in this translation unit are optimized away, we
4647   // don't need to codegen it.  b) if the function persists, it needs to be
4648   // merged with other definitions. c) C++ has the ODR, so we know the
4649   // definition is dependable.
4650   if (Linkage == GVA_DiscardableODR)
4651     return !Context.getLangOpts().AppleKext ? llvm::Function::LinkOnceODRLinkage
4652                                             : llvm::Function::InternalLinkage;
4653 
4654   // An explicit instantiation of a template has weak linkage, since
4655   // explicit instantiations can occur in multiple translation units
4656   // and must all be equivalent. However, we are not allowed to
4657   // throw away these explicit instantiations.
4658   //
4659   // CUDA/HIP: For -fno-gpu-rdc case, device code is limited to one TU,
4660   // so say that CUDA templates are either external (for kernels) or internal.
4661   // This lets llvm perform aggressive inter-procedural optimizations. For
4662   // -fgpu-rdc case, device function calls across multiple TU's are allowed,
4663   // therefore we need to follow the normal linkage paradigm.
4664   if (Linkage == GVA_StrongODR) {
4665     if (getLangOpts().AppleKext)
4666       return llvm::Function::ExternalLinkage;
4667     if (getLangOpts().CUDA && getLangOpts().CUDAIsDevice &&
4668         !getLangOpts().GPURelocatableDeviceCode)
4669       return D->hasAttr<CUDAGlobalAttr>() ? llvm::Function::ExternalLinkage
4670                                           : llvm::Function::InternalLinkage;
4671     return llvm::Function::WeakODRLinkage;
4672   }
4673 
4674   // C++ doesn't have tentative definitions and thus cannot have common
4675   // linkage.
4676   if (!getLangOpts().CPlusPlus && isa<VarDecl>(D) &&
4677       !isVarDeclStrongDefinition(Context, *this, cast<VarDecl>(D),
4678                                  CodeGenOpts.NoCommon))
4679     return llvm::GlobalVariable::CommonLinkage;
4680 
4681   // selectany symbols are externally visible, so use weak instead of
4682   // linkonce.  MSVC optimizes away references to const selectany globals, so
4683   // all definitions should be the same and ODR linkage should be used.
4684   // http://msdn.microsoft.com/en-us/library/5tkz6s71.aspx
4685   if (D->hasAttr<SelectAnyAttr>())
4686     return llvm::GlobalVariable::WeakODRLinkage;
4687 
4688   // Otherwise, we have strong external linkage.
4689   assert(Linkage == GVA_StrongExternal);
4690   return llvm::GlobalVariable::ExternalLinkage;
4691 }
4692 
4693 llvm::GlobalValue::LinkageTypes CodeGenModule::getLLVMLinkageVarDefinition(
4694     const VarDecl *VD, bool IsConstant) {
4695   GVALinkage Linkage = getContext().GetGVALinkageForVariable(VD);
4696   return getLLVMLinkageForDeclarator(VD, Linkage, IsConstant);
4697 }
4698 
4699 /// Replace the uses of a function that was declared with a non-proto type.
4700 /// We want to silently drop extra arguments from call sites
4701 static void replaceUsesOfNonProtoConstant(llvm::Constant *old,
4702                                           llvm::Function *newFn) {
4703   // Fast path.
4704   if (old->use_empty()) return;
4705 
4706   llvm::Type *newRetTy = newFn->getReturnType();
4707   SmallVector<llvm::Value*, 4> newArgs;
4708 
4709   for (llvm::Value::use_iterator ui = old->use_begin(), ue = old->use_end();
4710          ui != ue; ) {
4711     llvm::Value::use_iterator use = ui++; // Increment before the use is erased.
4712     llvm::User *user = use->getUser();
4713 
4714     // Recognize and replace uses of bitcasts.  Most calls to
4715     // unprototyped functions will use bitcasts.
4716     if (auto *bitcast = dyn_cast<llvm::ConstantExpr>(user)) {
4717       if (bitcast->getOpcode() == llvm::Instruction::BitCast)
4718         replaceUsesOfNonProtoConstant(bitcast, newFn);
4719       continue;
4720     }
4721 
4722     // Recognize calls to the function.
4723     llvm::CallBase *callSite = dyn_cast<llvm::CallBase>(user);
4724     if (!callSite) continue;
4725     if (!callSite->isCallee(&*use))
4726       continue;
4727 
4728     // If the return types don't match exactly, then we can't
4729     // transform this call unless it's dead.
4730     if (callSite->getType() != newRetTy && !callSite->use_empty())
4731       continue;
4732 
4733     // Get the call site's attribute list.
4734     SmallVector<llvm::AttributeSet, 8> newArgAttrs;
4735     llvm::AttributeList oldAttrs = callSite->getAttributes();
4736 
4737     // If the function was passed too few arguments, don't transform.
4738     unsigned newNumArgs = newFn->arg_size();
4739     if (callSite->arg_size() < newNumArgs)
4740       continue;
4741 
4742     // If extra arguments were passed, we silently drop them.
4743     // If any of the types mismatch, we don't transform.
4744     unsigned argNo = 0;
4745     bool dontTransform = false;
4746     for (llvm::Argument &A : newFn->args()) {
4747       if (callSite->getArgOperand(argNo)->getType() != A.getType()) {
4748         dontTransform = true;
4749         break;
4750       }
4751 
4752       // Add any parameter attributes.
4753       newArgAttrs.push_back(oldAttrs.getParamAttrs(argNo));
4754       argNo++;
4755     }
4756     if (dontTransform)
4757       continue;
4758 
4759     // Okay, we can transform this.  Create the new call instruction and copy
4760     // over the required information.
4761     newArgs.append(callSite->arg_begin(), callSite->arg_begin() + argNo);
4762 
4763     // Copy over any operand bundles.
4764     SmallVector<llvm::OperandBundleDef, 1> newBundles;
4765     callSite->getOperandBundlesAsDefs(newBundles);
4766 
4767     llvm::CallBase *newCall;
4768     if (dyn_cast<llvm::CallInst>(callSite)) {
4769       newCall =
4770           llvm::CallInst::Create(newFn, newArgs, newBundles, "", callSite);
4771     } else {
4772       auto *oldInvoke = cast<llvm::InvokeInst>(callSite);
4773       newCall = llvm::InvokeInst::Create(newFn, oldInvoke->getNormalDest(),
4774                                          oldInvoke->getUnwindDest(), newArgs,
4775                                          newBundles, "", callSite);
4776     }
4777     newArgs.clear(); // for the next iteration
4778 
4779     if (!newCall->getType()->isVoidTy())
4780       newCall->takeName(callSite);
4781     newCall->setAttributes(
4782         llvm::AttributeList::get(newFn->getContext(), oldAttrs.getFnAttrs(),
4783                                  oldAttrs.getRetAttrs(), newArgAttrs));
4784     newCall->setCallingConv(callSite->getCallingConv());
4785 
4786     // Finally, remove the old call, replacing any uses with the new one.
4787     if (!callSite->use_empty())
4788       callSite->replaceAllUsesWith(newCall);
4789 
4790     // Copy debug location attached to CI.
4791     if (callSite->getDebugLoc())
4792       newCall->setDebugLoc(callSite->getDebugLoc());
4793 
4794     callSite->eraseFromParent();
4795   }
4796 }
4797 
4798 /// ReplaceUsesOfNonProtoTypeWithRealFunction - This function is called when we
4799 /// implement a function with no prototype, e.g. "int foo() {}".  If there are
4800 /// existing call uses of the old function in the module, this adjusts them to
4801 /// call the new function directly.
4802 ///
4803 /// This is not just a cleanup: the always_inline pass requires direct calls to
4804 /// functions to be able to inline them.  If there is a bitcast in the way, it
4805 /// won't inline them.  Instcombine normally deletes these calls, but it isn't
4806 /// run at -O0.
4807 static void ReplaceUsesOfNonProtoTypeWithRealFunction(llvm::GlobalValue *Old,
4808                                                       llvm::Function *NewFn) {
4809   // If we're redefining a global as a function, don't transform it.
4810   if (!isa<llvm::Function>(Old)) return;
4811 
4812   replaceUsesOfNonProtoConstant(Old, NewFn);
4813 }
4814 
4815 void CodeGenModule::HandleCXXStaticMemberVarInstantiation(VarDecl *VD) {
4816   auto DK = VD->isThisDeclarationADefinition();
4817   if (DK == VarDecl::Definition && VD->hasAttr<DLLImportAttr>())
4818     return;
4819 
4820   TemplateSpecializationKind TSK = VD->getTemplateSpecializationKind();
4821   // If we have a definition, this might be a deferred decl. If the
4822   // instantiation is explicit, make sure we emit it at the end.
4823   if (VD->getDefinition() && TSK == TSK_ExplicitInstantiationDefinition)
4824     GetAddrOfGlobalVar(VD);
4825 
4826   EmitTopLevelDecl(VD);
4827 }
4828 
4829 void CodeGenModule::EmitGlobalFunctionDefinition(GlobalDecl GD,
4830                                                  llvm::GlobalValue *GV) {
4831   const auto *D = cast<FunctionDecl>(GD.getDecl());
4832 
4833   // Compute the function info and LLVM type.
4834   const CGFunctionInfo &FI = getTypes().arrangeGlobalDeclaration(GD);
4835   llvm::FunctionType *Ty = getTypes().GetFunctionType(FI);
4836 
4837   // Get or create the prototype for the function.
4838   if (!GV || (GV->getValueType() != Ty))
4839     GV = cast<llvm::GlobalValue>(GetAddrOfFunction(GD, Ty, /*ForVTable=*/false,
4840                                                    /*DontDefer=*/true,
4841                                                    ForDefinition));
4842 
4843   // Already emitted.
4844   if (!GV->isDeclaration())
4845     return;
4846 
4847   // We need to set linkage and visibility on the function before
4848   // generating code for it because various parts of IR generation
4849   // want to propagate this information down (e.g. to local static
4850   // declarations).
4851   auto *Fn = cast<llvm::Function>(GV);
4852   setFunctionLinkage(GD, Fn);
4853 
4854   // FIXME: this is redundant with part of setFunctionDefinitionAttributes
4855   setGVProperties(Fn, GD);
4856 
4857   MaybeHandleStaticInExternC(D, Fn);
4858 
4859   maybeSetTrivialComdat(*D, *Fn);
4860 
4861   // Set CodeGen attributes that represent floating point environment.
4862   setLLVMFunctionFEnvAttributes(D, Fn);
4863 
4864   CodeGenFunction(*this).GenerateCode(GD, Fn, FI);
4865 
4866   setNonAliasAttributes(GD, Fn);
4867   SetLLVMFunctionAttributesForDefinition(D, Fn);
4868 
4869   if (const ConstructorAttr *CA = D->getAttr<ConstructorAttr>())
4870     AddGlobalCtor(Fn, CA->getPriority());
4871   if (const DestructorAttr *DA = D->getAttr<DestructorAttr>())
4872     AddGlobalDtor(Fn, DA->getPriority(), true);
4873   if (D->hasAttr<AnnotateAttr>())
4874     AddGlobalAnnotations(D, Fn);
4875 }
4876 
4877 void CodeGenModule::EmitAliasDefinition(GlobalDecl GD) {
4878   const auto *D = cast<ValueDecl>(GD.getDecl());
4879   const AliasAttr *AA = D->getAttr<AliasAttr>();
4880   assert(AA && "Not an alias?");
4881 
4882   StringRef MangledName = getMangledName(GD);
4883 
4884   if (AA->getAliasee() == MangledName) {
4885     Diags.Report(AA->getLocation(), diag::err_cyclic_alias) << 0;
4886     return;
4887   }
4888 
4889   // If there is a definition in the module, then it wins over the alias.
4890   // This is dubious, but allow it to be safe.  Just ignore the alias.
4891   llvm::GlobalValue *Entry = GetGlobalValue(MangledName);
4892   if (Entry && !Entry->isDeclaration())
4893     return;
4894 
4895   Aliases.push_back(GD);
4896 
4897   llvm::Type *DeclTy = getTypes().ConvertTypeForMem(D->getType());
4898 
4899   // Create a reference to the named value.  This ensures that it is emitted
4900   // if a deferred decl.
4901   llvm::Constant *Aliasee;
4902   llvm::GlobalValue::LinkageTypes LT;
4903   if (isa<llvm::FunctionType>(DeclTy)) {
4904     Aliasee = GetOrCreateLLVMFunction(AA->getAliasee(), DeclTy, GD,
4905                                       /*ForVTable=*/false);
4906     LT = getFunctionLinkage(GD);
4907   } else {
4908     Aliasee = GetOrCreateLLVMGlobal(AA->getAliasee(), DeclTy, LangAS::Default,
4909                                     /*D=*/nullptr);
4910     if (const auto *VD = dyn_cast<VarDecl>(GD.getDecl()))
4911       LT = getLLVMLinkageVarDefinition(VD, D->getType().isConstQualified());
4912     else
4913       LT = getFunctionLinkage(GD);
4914   }
4915 
4916   // Create the new alias itself, but don't set a name yet.
4917   unsigned AS = Aliasee->getType()->getPointerAddressSpace();
4918   auto *GA =
4919       llvm::GlobalAlias::create(DeclTy, AS, LT, "", Aliasee, &getModule());
4920 
4921   if (Entry) {
4922     if (GA->getAliasee() == Entry) {
4923       Diags.Report(AA->getLocation(), diag::err_cyclic_alias) << 0;
4924       return;
4925     }
4926 
4927     assert(Entry->isDeclaration());
4928 
4929     // If there is a declaration in the module, then we had an extern followed
4930     // by the alias, as in:
4931     //   extern int test6();
4932     //   ...
4933     //   int test6() __attribute__((alias("test7")));
4934     //
4935     // Remove it and replace uses of it with the alias.
4936     GA->takeName(Entry);
4937 
4938     Entry->replaceAllUsesWith(llvm::ConstantExpr::getBitCast(GA,
4939                                                           Entry->getType()));
4940     Entry->eraseFromParent();
4941   } else {
4942     GA->setName(MangledName);
4943   }
4944 
4945   // Set attributes which are particular to an alias; this is a
4946   // specialization of the attributes which may be set on a global
4947   // variable/function.
4948   if (D->hasAttr<WeakAttr>() || D->hasAttr<WeakRefAttr>() ||
4949       D->isWeakImported()) {
4950     GA->setLinkage(llvm::Function::WeakAnyLinkage);
4951   }
4952 
4953   if (const auto *VD = dyn_cast<VarDecl>(D))
4954     if (VD->getTLSKind())
4955       setTLSMode(GA, *VD);
4956 
4957   SetCommonAttributes(GD, GA);
4958 }
4959 
4960 void CodeGenModule::emitIFuncDefinition(GlobalDecl GD) {
4961   const auto *D = cast<ValueDecl>(GD.getDecl());
4962   const IFuncAttr *IFA = D->getAttr<IFuncAttr>();
4963   assert(IFA && "Not an ifunc?");
4964 
4965   StringRef MangledName = getMangledName(GD);
4966 
4967   if (IFA->getResolver() == MangledName) {
4968     Diags.Report(IFA->getLocation(), diag::err_cyclic_alias) << 1;
4969     return;
4970   }
4971 
4972   // Report an error if some definition overrides ifunc.
4973   llvm::GlobalValue *Entry = GetGlobalValue(MangledName);
4974   if (Entry && !Entry->isDeclaration()) {
4975     GlobalDecl OtherGD;
4976     if (lookupRepresentativeDecl(MangledName, OtherGD) &&
4977         DiagnosedConflictingDefinitions.insert(GD).second) {
4978       Diags.Report(D->getLocation(), diag::err_duplicate_mangled_name)
4979           << MangledName;
4980       Diags.Report(OtherGD.getDecl()->getLocation(),
4981                    diag::note_previous_definition);
4982     }
4983     return;
4984   }
4985 
4986   Aliases.push_back(GD);
4987 
4988   llvm::Type *DeclTy = getTypes().ConvertTypeForMem(D->getType());
4989   llvm::Constant *Resolver =
4990       GetOrCreateLLVMFunction(IFA->getResolver(), DeclTy, GD,
4991                               /*ForVTable=*/false);
4992   llvm::GlobalIFunc *GIF =
4993       llvm::GlobalIFunc::create(DeclTy, 0, llvm::Function::ExternalLinkage,
4994                                 "", Resolver, &getModule());
4995   if (Entry) {
4996     if (GIF->getResolver() == Entry) {
4997       Diags.Report(IFA->getLocation(), diag::err_cyclic_alias) << 1;
4998       return;
4999     }
5000     assert(Entry->isDeclaration());
5001 
5002     // If there is a declaration in the module, then we had an extern followed
5003     // by the ifunc, as in:
5004     //   extern int test();
5005     //   ...
5006     //   int test() __attribute__((ifunc("resolver")));
5007     //
5008     // Remove it and replace uses of it with the ifunc.
5009     GIF->takeName(Entry);
5010 
5011     Entry->replaceAllUsesWith(llvm::ConstantExpr::getBitCast(GIF,
5012                                                           Entry->getType()));
5013     Entry->eraseFromParent();
5014   } else
5015     GIF->setName(MangledName);
5016 
5017   SetCommonAttributes(GD, GIF);
5018 }
5019 
5020 llvm::Function *CodeGenModule::getIntrinsic(unsigned IID,
5021                                             ArrayRef<llvm::Type*> Tys) {
5022   return llvm::Intrinsic::getDeclaration(&getModule(), (llvm::Intrinsic::ID)IID,
5023                                          Tys);
5024 }
5025 
5026 static llvm::StringMapEntry<llvm::GlobalVariable *> &
5027 GetConstantCFStringEntry(llvm::StringMap<llvm::GlobalVariable *> &Map,
5028                          const StringLiteral *Literal, bool TargetIsLSB,
5029                          bool &IsUTF16, unsigned &StringLength) {
5030   StringRef String = Literal->getString();
5031   unsigned NumBytes = String.size();
5032 
5033   // Check for simple case.
5034   if (!Literal->containsNonAsciiOrNull()) {
5035     StringLength = NumBytes;
5036     return *Map.insert(std::make_pair(String, nullptr)).first;
5037   }
5038 
5039   // Otherwise, convert the UTF8 literals into a string of shorts.
5040   IsUTF16 = true;
5041 
5042   SmallVector<llvm::UTF16, 128> ToBuf(NumBytes + 1); // +1 for ending nulls.
5043   const llvm::UTF8 *FromPtr = (const llvm::UTF8 *)String.data();
5044   llvm::UTF16 *ToPtr = &ToBuf[0];
5045 
5046   (void)llvm::ConvertUTF8toUTF16(&FromPtr, FromPtr + NumBytes, &ToPtr,
5047                                  ToPtr + NumBytes, llvm::strictConversion);
5048 
5049   // ConvertUTF8toUTF16 returns the length in ToPtr.
5050   StringLength = ToPtr - &ToBuf[0];
5051 
5052   // Add an explicit null.
5053   *ToPtr = 0;
5054   return *Map.insert(std::make_pair(
5055                          StringRef(reinterpret_cast<const char *>(ToBuf.data()),
5056                                    (StringLength + 1) * 2),
5057                          nullptr)).first;
5058 }
5059 
5060 ConstantAddress
5061 CodeGenModule::GetAddrOfConstantCFString(const StringLiteral *Literal) {
5062   unsigned StringLength = 0;
5063   bool isUTF16 = false;
5064   llvm::StringMapEntry<llvm::GlobalVariable *> &Entry =
5065       GetConstantCFStringEntry(CFConstantStringMap, Literal,
5066                                getDataLayout().isLittleEndian(), isUTF16,
5067                                StringLength);
5068 
5069   if (auto *C = Entry.second)
5070     return ConstantAddress(C, CharUnits::fromQuantity(C->getAlignment()));
5071 
5072   llvm::Constant *Zero = llvm::Constant::getNullValue(Int32Ty);
5073   llvm::Constant *Zeros[] = { Zero, Zero };
5074 
5075   const ASTContext &Context = getContext();
5076   const llvm::Triple &Triple = getTriple();
5077 
5078   const auto CFRuntime = getLangOpts().CFRuntime;
5079   const bool IsSwiftABI =
5080       static_cast<unsigned>(CFRuntime) >=
5081       static_cast<unsigned>(LangOptions::CoreFoundationABI::Swift);
5082   const bool IsSwift4_1 = CFRuntime == LangOptions::CoreFoundationABI::Swift4_1;
5083 
5084   // If we don't already have it, get __CFConstantStringClassReference.
5085   if (!CFConstantStringClassRef) {
5086     const char *CFConstantStringClassName = "__CFConstantStringClassReference";
5087     llvm::Type *Ty = getTypes().ConvertType(getContext().IntTy);
5088     Ty = llvm::ArrayType::get(Ty, 0);
5089 
5090     switch (CFRuntime) {
5091     default: break;
5092     case LangOptions::CoreFoundationABI::Swift: LLVM_FALLTHROUGH;
5093     case LangOptions::CoreFoundationABI::Swift5_0:
5094       CFConstantStringClassName =
5095           Triple.isOSDarwin() ? "$s15SwiftFoundation19_NSCFConstantStringCN"
5096                               : "$s10Foundation19_NSCFConstantStringCN";
5097       Ty = IntPtrTy;
5098       break;
5099     case LangOptions::CoreFoundationABI::Swift4_2:
5100       CFConstantStringClassName =
5101           Triple.isOSDarwin() ? "$S15SwiftFoundation19_NSCFConstantStringCN"
5102                               : "$S10Foundation19_NSCFConstantStringCN";
5103       Ty = IntPtrTy;
5104       break;
5105     case LangOptions::CoreFoundationABI::Swift4_1:
5106       CFConstantStringClassName =
5107           Triple.isOSDarwin() ? "__T015SwiftFoundation19_NSCFConstantStringCN"
5108                               : "__T010Foundation19_NSCFConstantStringCN";
5109       Ty = IntPtrTy;
5110       break;
5111     }
5112 
5113     llvm::Constant *C = CreateRuntimeVariable(Ty, CFConstantStringClassName);
5114 
5115     if (Triple.isOSBinFormatELF() || Triple.isOSBinFormatCOFF()) {
5116       llvm::GlobalValue *GV = nullptr;
5117 
5118       if ((GV = dyn_cast<llvm::GlobalValue>(C))) {
5119         IdentifierInfo &II = Context.Idents.get(GV->getName());
5120         TranslationUnitDecl *TUDecl = Context.getTranslationUnitDecl();
5121         DeclContext *DC = TranslationUnitDecl::castToDeclContext(TUDecl);
5122 
5123         const VarDecl *VD = nullptr;
5124         for (const auto *Result : DC->lookup(&II))
5125           if ((VD = dyn_cast<VarDecl>(Result)))
5126             break;
5127 
5128         if (Triple.isOSBinFormatELF()) {
5129           if (!VD)
5130             GV->setLinkage(llvm::GlobalValue::ExternalLinkage);
5131         } else {
5132           GV->setLinkage(llvm::GlobalValue::ExternalLinkage);
5133           if (!VD || !VD->hasAttr<DLLExportAttr>())
5134             GV->setDLLStorageClass(llvm::GlobalValue::DLLImportStorageClass);
5135           else
5136             GV->setDLLStorageClass(llvm::GlobalValue::DLLExportStorageClass);
5137         }
5138 
5139         setDSOLocal(GV);
5140       }
5141     }
5142 
5143     // Decay array -> ptr
5144     CFConstantStringClassRef =
5145         IsSwiftABI ? llvm::ConstantExpr::getPtrToInt(C, Ty)
5146                    : llvm::ConstantExpr::getGetElementPtr(Ty, C, Zeros);
5147   }
5148 
5149   QualType CFTy = Context.getCFConstantStringType();
5150 
5151   auto *STy = cast<llvm::StructType>(getTypes().ConvertType(CFTy));
5152 
5153   ConstantInitBuilder Builder(*this);
5154   auto Fields = Builder.beginStruct(STy);
5155 
5156   // Class pointer.
5157   Fields.add(cast<llvm::ConstantExpr>(CFConstantStringClassRef));
5158 
5159   // Flags.
5160   if (IsSwiftABI) {
5161     Fields.addInt(IntPtrTy, IsSwift4_1 ? 0x05 : 0x01);
5162     Fields.addInt(Int64Ty, isUTF16 ? 0x07d0 : 0x07c8);
5163   } else {
5164     Fields.addInt(IntTy, isUTF16 ? 0x07d0 : 0x07C8);
5165   }
5166 
5167   // String pointer.
5168   llvm::Constant *C = nullptr;
5169   if (isUTF16) {
5170     auto Arr = llvm::makeArrayRef(
5171         reinterpret_cast<uint16_t *>(const_cast<char *>(Entry.first().data())),
5172         Entry.first().size() / 2);
5173     C = llvm::ConstantDataArray::get(VMContext, Arr);
5174   } else {
5175     C = llvm::ConstantDataArray::getString(VMContext, Entry.first());
5176   }
5177 
5178   // Note: -fwritable-strings doesn't make the backing store strings of
5179   // CFStrings writable. (See <rdar://problem/10657500>)
5180   auto *GV =
5181       new llvm::GlobalVariable(getModule(), C->getType(), /*isConstant=*/true,
5182                                llvm::GlobalValue::PrivateLinkage, C, ".str");
5183   GV->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
5184   // Don't enforce the target's minimum global alignment, since the only use
5185   // of the string is via this class initializer.
5186   CharUnits Align = isUTF16 ? Context.getTypeAlignInChars(Context.ShortTy)
5187                             : Context.getTypeAlignInChars(Context.CharTy);
5188   GV->setAlignment(Align.getAsAlign());
5189 
5190   // FIXME: We set the section explicitly to avoid a bug in ld64 224.1.
5191   // Without it LLVM can merge the string with a non unnamed_addr one during
5192   // LTO.  Doing that changes the section it ends in, which surprises ld64.
5193   if (Triple.isOSBinFormatMachO())
5194     GV->setSection(isUTF16 ? "__TEXT,__ustring"
5195                            : "__TEXT,__cstring,cstring_literals");
5196   // Make sure the literal ends up in .rodata to allow for safe ICF and for
5197   // the static linker to adjust permissions to read-only later on.
5198   else if (Triple.isOSBinFormatELF())
5199     GV->setSection(".rodata");
5200 
5201   // String.
5202   llvm::Constant *Str =
5203       llvm::ConstantExpr::getGetElementPtr(GV->getValueType(), GV, Zeros);
5204 
5205   if (isUTF16)
5206     // Cast the UTF16 string to the correct type.
5207     Str = llvm::ConstantExpr::getBitCast(Str, Int8PtrTy);
5208   Fields.add(Str);
5209 
5210   // String length.
5211   llvm::IntegerType *LengthTy =
5212       llvm::IntegerType::get(getModule().getContext(),
5213                              Context.getTargetInfo().getLongWidth());
5214   if (IsSwiftABI) {
5215     if (CFRuntime == LangOptions::CoreFoundationABI::Swift4_1 ||
5216         CFRuntime == LangOptions::CoreFoundationABI::Swift4_2)
5217       LengthTy = Int32Ty;
5218     else
5219       LengthTy = IntPtrTy;
5220   }
5221   Fields.addInt(LengthTy, StringLength);
5222 
5223   // Swift ABI requires 8-byte alignment to ensure that the _Atomic(uint64_t) is
5224   // properly aligned on 32-bit platforms.
5225   CharUnits Alignment =
5226       IsSwiftABI ? Context.toCharUnitsFromBits(64) : getPointerAlign();
5227 
5228   // The struct.
5229   GV = Fields.finishAndCreateGlobal("_unnamed_cfstring_", Alignment,
5230                                     /*isConstant=*/false,
5231                                     llvm::GlobalVariable::PrivateLinkage);
5232   GV->addAttribute("objc_arc_inert");
5233   switch (Triple.getObjectFormat()) {
5234   case llvm::Triple::UnknownObjectFormat:
5235     llvm_unreachable("unknown file format");
5236   case llvm::Triple::GOFF:
5237     llvm_unreachable("GOFF is not yet implemented");
5238   case llvm::Triple::XCOFF:
5239     llvm_unreachable("XCOFF is not yet implemented");
5240   case llvm::Triple::COFF:
5241   case llvm::Triple::ELF:
5242   case llvm::Triple::Wasm:
5243     GV->setSection("cfstring");
5244     break;
5245   case llvm::Triple::MachO:
5246     GV->setSection("__DATA,__cfstring");
5247     break;
5248   }
5249   Entry.second = GV;
5250 
5251   return ConstantAddress(GV, Alignment);
5252 }
5253 
5254 bool CodeGenModule::getExpressionLocationsEnabled() const {
5255   return !CodeGenOpts.EmitCodeView || CodeGenOpts.DebugColumnInfo;
5256 }
5257 
5258 QualType CodeGenModule::getObjCFastEnumerationStateType() {
5259   if (ObjCFastEnumerationStateType.isNull()) {
5260     RecordDecl *D = Context.buildImplicitRecord("__objcFastEnumerationState");
5261     D->startDefinition();
5262 
5263     QualType FieldTypes[] = {
5264       Context.UnsignedLongTy,
5265       Context.getPointerType(Context.getObjCIdType()),
5266       Context.getPointerType(Context.UnsignedLongTy),
5267       Context.getConstantArrayType(Context.UnsignedLongTy,
5268                            llvm::APInt(32, 5), nullptr, ArrayType::Normal, 0)
5269     };
5270 
5271     for (size_t i = 0; i < 4; ++i) {
5272       FieldDecl *Field = FieldDecl::Create(Context,
5273                                            D,
5274                                            SourceLocation(),
5275                                            SourceLocation(), nullptr,
5276                                            FieldTypes[i], /*TInfo=*/nullptr,
5277                                            /*BitWidth=*/nullptr,
5278                                            /*Mutable=*/false,
5279                                            ICIS_NoInit);
5280       Field->setAccess(AS_public);
5281       D->addDecl(Field);
5282     }
5283 
5284     D->completeDefinition();
5285     ObjCFastEnumerationStateType = Context.getTagDeclType(D);
5286   }
5287 
5288   return ObjCFastEnumerationStateType;
5289 }
5290 
5291 llvm::Constant *
5292 CodeGenModule::GetConstantArrayFromStringLiteral(const StringLiteral *E) {
5293   assert(!E->getType()->isPointerType() && "Strings are always arrays");
5294 
5295   // Don't emit it as the address of the string, emit the string data itself
5296   // as an inline array.
5297   if (E->getCharByteWidth() == 1) {
5298     SmallString<64> Str(E->getString());
5299 
5300     // Resize the string to the right size, which is indicated by its type.
5301     const ConstantArrayType *CAT = Context.getAsConstantArrayType(E->getType());
5302     Str.resize(CAT->getSize().getZExtValue());
5303     return llvm::ConstantDataArray::getString(VMContext, Str, false);
5304   }
5305 
5306   auto *AType = cast<llvm::ArrayType>(getTypes().ConvertType(E->getType()));
5307   llvm::Type *ElemTy = AType->getElementType();
5308   unsigned NumElements = AType->getNumElements();
5309 
5310   // Wide strings have either 2-byte or 4-byte elements.
5311   if (ElemTy->getPrimitiveSizeInBits() == 16) {
5312     SmallVector<uint16_t, 32> Elements;
5313     Elements.reserve(NumElements);
5314 
5315     for(unsigned i = 0, e = E->getLength(); i != e; ++i)
5316       Elements.push_back(E->getCodeUnit(i));
5317     Elements.resize(NumElements);
5318     return llvm::ConstantDataArray::get(VMContext, Elements);
5319   }
5320 
5321   assert(ElemTy->getPrimitiveSizeInBits() == 32);
5322   SmallVector<uint32_t, 32> Elements;
5323   Elements.reserve(NumElements);
5324 
5325   for(unsigned i = 0, e = E->getLength(); i != e; ++i)
5326     Elements.push_back(E->getCodeUnit(i));
5327   Elements.resize(NumElements);
5328   return llvm::ConstantDataArray::get(VMContext, Elements);
5329 }
5330 
5331 static llvm::GlobalVariable *
5332 GenerateStringLiteral(llvm::Constant *C, llvm::GlobalValue::LinkageTypes LT,
5333                       CodeGenModule &CGM, StringRef GlobalName,
5334                       CharUnits Alignment) {
5335   unsigned AddrSpace = CGM.getContext().getTargetAddressSpace(
5336       CGM.GetGlobalConstantAddressSpace());
5337 
5338   llvm::Module &M = CGM.getModule();
5339   // Create a global variable for this string
5340   auto *GV = new llvm::GlobalVariable(
5341       M, C->getType(), !CGM.getLangOpts().WritableStrings, LT, C, GlobalName,
5342       nullptr, llvm::GlobalVariable::NotThreadLocal, AddrSpace);
5343   GV->setAlignment(Alignment.getAsAlign());
5344   GV->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
5345   if (GV->isWeakForLinker()) {
5346     assert(CGM.supportsCOMDAT() && "Only COFF uses weak string literals");
5347     GV->setComdat(M.getOrInsertComdat(GV->getName()));
5348   }
5349   CGM.setDSOLocal(GV);
5350 
5351   return GV;
5352 }
5353 
5354 /// GetAddrOfConstantStringFromLiteral - Return a pointer to a
5355 /// constant array for the given string literal.
5356 ConstantAddress
5357 CodeGenModule::GetAddrOfConstantStringFromLiteral(const StringLiteral *S,
5358                                                   StringRef Name) {
5359   CharUnits Alignment = getContext().getAlignOfGlobalVarInChars(S->getType());
5360 
5361   llvm::Constant *C = GetConstantArrayFromStringLiteral(S);
5362   llvm::GlobalVariable **Entry = nullptr;
5363   if (!LangOpts.WritableStrings) {
5364     Entry = &ConstantStringMap[C];
5365     if (auto GV = *Entry) {
5366       if (Alignment.getQuantity() > GV->getAlignment())
5367         GV->setAlignment(Alignment.getAsAlign());
5368       return ConstantAddress(castStringLiteralToDefaultAddressSpace(*this, GV),
5369                              Alignment);
5370     }
5371   }
5372 
5373   SmallString<256> MangledNameBuffer;
5374   StringRef GlobalVariableName;
5375   llvm::GlobalValue::LinkageTypes LT;
5376 
5377   // Mangle the string literal if that's how the ABI merges duplicate strings.
5378   // Don't do it if they are writable, since we don't want writes in one TU to
5379   // affect strings in another.
5380   if (getCXXABI().getMangleContext().shouldMangleStringLiteral(S) &&
5381       !LangOpts.WritableStrings) {
5382     llvm::raw_svector_ostream Out(MangledNameBuffer);
5383     getCXXABI().getMangleContext().mangleStringLiteral(S, Out);
5384     LT = llvm::GlobalValue::LinkOnceODRLinkage;
5385     GlobalVariableName = MangledNameBuffer;
5386   } else {
5387     LT = llvm::GlobalValue::PrivateLinkage;
5388     GlobalVariableName = Name;
5389   }
5390 
5391   auto GV = GenerateStringLiteral(C, LT, *this, GlobalVariableName, Alignment);
5392   if (Entry)
5393     *Entry = GV;
5394 
5395   SanitizerMD->reportGlobalToASan(GV, S->getStrTokenLoc(0), "<string literal>",
5396                                   QualType());
5397 
5398   return ConstantAddress(castStringLiteralToDefaultAddressSpace(*this, GV),
5399                          Alignment);
5400 }
5401 
5402 /// GetAddrOfConstantStringFromObjCEncode - Return a pointer to a constant
5403 /// array for the given ObjCEncodeExpr node.
5404 ConstantAddress
5405 CodeGenModule::GetAddrOfConstantStringFromObjCEncode(const ObjCEncodeExpr *E) {
5406   std::string Str;
5407   getContext().getObjCEncodingForType(E->getEncodedType(), Str);
5408 
5409   return GetAddrOfConstantCString(Str);
5410 }
5411 
5412 /// GetAddrOfConstantCString - Returns a pointer to a character array containing
5413 /// the literal and a terminating '\0' character.
5414 /// The result has pointer to array type.
5415 ConstantAddress CodeGenModule::GetAddrOfConstantCString(
5416     const std::string &Str, const char *GlobalName) {
5417   StringRef StrWithNull(Str.c_str(), Str.size() + 1);
5418   CharUnits Alignment =
5419     getContext().getAlignOfGlobalVarInChars(getContext().CharTy);
5420 
5421   llvm::Constant *C =
5422       llvm::ConstantDataArray::getString(getLLVMContext(), StrWithNull, false);
5423 
5424   // Don't share any string literals if strings aren't constant.
5425   llvm::GlobalVariable **Entry = nullptr;
5426   if (!LangOpts.WritableStrings) {
5427     Entry = &ConstantStringMap[C];
5428     if (auto GV = *Entry) {
5429       if (Alignment.getQuantity() > GV->getAlignment())
5430         GV->setAlignment(Alignment.getAsAlign());
5431       return ConstantAddress(castStringLiteralToDefaultAddressSpace(*this, GV),
5432                              Alignment);
5433     }
5434   }
5435 
5436   // Get the default prefix if a name wasn't specified.
5437   if (!GlobalName)
5438     GlobalName = ".str";
5439   // Create a global variable for this.
5440   auto GV = GenerateStringLiteral(C, llvm::GlobalValue::PrivateLinkage, *this,
5441                                   GlobalName, Alignment);
5442   if (Entry)
5443     *Entry = GV;
5444 
5445   return ConstantAddress(castStringLiteralToDefaultAddressSpace(*this, GV),
5446                          Alignment);
5447 }
5448 
5449 ConstantAddress CodeGenModule::GetAddrOfGlobalTemporary(
5450     const MaterializeTemporaryExpr *E, const Expr *Init) {
5451   assert((E->getStorageDuration() == SD_Static ||
5452           E->getStorageDuration() == SD_Thread) && "not a global temporary");
5453   const auto *VD = cast<VarDecl>(E->getExtendingDecl());
5454 
5455   // If we're not materializing a subobject of the temporary, keep the
5456   // cv-qualifiers from the type of the MaterializeTemporaryExpr.
5457   QualType MaterializedType = Init->getType();
5458   if (Init == E->getSubExpr())
5459     MaterializedType = E->getType();
5460 
5461   CharUnits Align = getContext().getTypeAlignInChars(MaterializedType);
5462 
5463   auto InsertResult = MaterializedGlobalTemporaryMap.insert({E, nullptr});
5464   if (!InsertResult.second) {
5465     // We've seen this before: either we already created it or we're in the
5466     // process of doing so.
5467     if (!InsertResult.first->second) {
5468       // We recursively re-entered this function, probably during emission of
5469       // the initializer. Create a placeholder. We'll clean this up in the
5470       // outer call, at the end of this function.
5471       llvm::Type *Type = getTypes().ConvertTypeForMem(MaterializedType);
5472       InsertResult.first->second = new llvm::GlobalVariable(
5473           getModule(), Type, false, llvm::GlobalVariable::InternalLinkage,
5474           nullptr);
5475     }
5476     return ConstantAddress(InsertResult.first->second, Align);
5477   }
5478 
5479   // FIXME: If an externally-visible declaration extends multiple temporaries,
5480   // we need to give each temporary the same name in every translation unit (and
5481   // we also need to make the temporaries externally-visible).
5482   SmallString<256> Name;
5483   llvm::raw_svector_ostream Out(Name);
5484   getCXXABI().getMangleContext().mangleReferenceTemporary(
5485       VD, E->getManglingNumber(), Out);
5486 
5487   APValue *Value = nullptr;
5488   if (E->getStorageDuration() == SD_Static && VD && VD->evaluateValue()) {
5489     // If the initializer of the extending declaration is a constant
5490     // initializer, we should have a cached constant initializer for this
5491     // temporary. Note that this might have a different value from the value
5492     // computed by evaluating the initializer if the surrounding constant
5493     // expression modifies the temporary.
5494     Value = E->getOrCreateValue(false);
5495   }
5496 
5497   // Try evaluating it now, it might have a constant initializer.
5498   Expr::EvalResult EvalResult;
5499   if (!Value && Init->EvaluateAsRValue(EvalResult, getContext()) &&
5500       !EvalResult.hasSideEffects())
5501     Value = &EvalResult.Val;
5502 
5503   LangAS AddrSpace =
5504       VD ? GetGlobalVarAddressSpace(VD) : MaterializedType.getAddressSpace();
5505 
5506   Optional<ConstantEmitter> emitter;
5507   llvm::Constant *InitialValue = nullptr;
5508   bool Constant = false;
5509   llvm::Type *Type;
5510   if (Value) {
5511     // The temporary has a constant initializer, use it.
5512     emitter.emplace(*this);
5513     InitialValue = emitter->emitForInitializer(*Value, AddrSpace,
5514                                                MaterializedType);
5515     Constant = isTypeConstant(MaterializedType, /*ExcludeCtor*/Value);
5516     Type = InitialValue->getType();
5517   } else {
5518     // No initializer, the initialization will be provided when we
5519     // initialize the declaration which performed lifetime extension.
5520     Type = getTypes().ConvertTypeForMem(MaterializedType);
5521   }
5522 
5523   // Create a global variable for this lifetime-extended temporary.
5524   llvm::GlobalValue::LinkageTypes Linkage =
5525       getLLVMLinkageVarDefinition(VD, Constant);
5526   if (Linkage == llvm::GlobalVariable::ExternalLinkage) {
5527     const VarDecl *InitVD;
5528     if (VD->isStaticDataMember() && VD->getAnyInitializer(InitVD) &&
5529         isa<CXXRecordDecl>(InitVD->getLexicalDeclContext())) {
5530       // Temporaries defined inside a class get linkonce_odr linkage because the
5531       // class can be defined in multiple translation units.
5532       Linkage = llvm::GlobalVariable::LinkOnceODRLinkage;
5533     } else {
5534       // There is no need for this temporary to have external linkage if the
5535       // VarDecl has external linkage.
5536       Linkage = llvm::GlobalVariable::InternalLinkage;
5537     }
5538   }
5539   auto TargetAS = getContext().getTargetAddressSpace(AddrSpace);
5540   auto *GV = new llvm::GlobalVariable(
5541       getModule(), Type, Constant, Linkage, InitialValue, Name.c_str(),
5542       /*InsertBefore=*/nullptr, llvm::GlobalVariable::NotThreadLocal, TargetAS);
5543   if (emitter) emitter->finalize(GV);
5544   setGVProperties(GV, VD);
5545   GV->setAlignment(Align.getAsAlign());
5546   if (supportsCOMDAT() && GV->isWeakForLinker())
5547     GV->setComdat(TheModule.getOrInsertComdat(GV->getName()));
5548   if (VD->getTLSKind())
5549     setTLSMode(GV, *VD);
5550   llvm::Constant *CV = GV;
5551   if (AddrSpace != LangAS::Default)
5552     CV = getTargetCodeGenInfo().performAddrSpaceCast(
5553         *this, GV, AddrSpace, LangAS::Default,
5554         Type->getPointerTo(
5555             getContext().getTargetAddressSpace(LangAS::Default)));
5556 
5557   // Update the map with the new temporary. If we created a placeholder above,
5558   // replace it with the new global now.
5559   llvm::Constant *&Entry = MaterializedGlobalTemporaryMap[E];
5560   if (Entry) {
5561     Entry->replaceAllUsesWith(
5562         llvm::ConstantExpr::getBitCast(CV, Entry->getType()));
5563     llvm::cast<llvm::GlobalVariable>(Entry)->eraseFromParent();
5564   }
5565   Entry = CV;
5566 
5567   return ConstantAddress(CV, Align);
5568 }
5569 
5570 /// EmitObjCPropertyImplementations - Emit information for synthesized
5571 /// properties for an implementation.
5572 void CodeGenModule::EmitObjCPropertyImplementations(const
5573                                                     ObjCImplementationDecl *D) {
5574   for (const auto *PID : D->property_impls()) {
5575     // Dynamic is just for type-checking.
5576     if (PID->getPropertyImplementation() == ObjCPropertyImplDecl::Synthesize) {
5577       ObjCPropertyDecl *PD = PID->getPropertyDecl();
5578 
5579       // Determine which methods need to be implemented, some may have
5580       // been overridden. Note that ::isPropertyAccessor is not the method
5581       // we want, that just indicates if the decl came from a
5582       // property. What we want to know is if the method is defined in
5583       // this implementation.
5584       auto *Getter = PID->getGetterMethodDecl();
5585       if (!Getter || Getter->isSynthesizedAccessorStub())
5586         CodeGenFunction(*this).GenerateObjCGetter(
5587             const_cast<ObjCImplementationDecl *>(D), PID);
5588       auto *Setter = PID->getSetterMethodDecl();
5589       if (!PD->isReadOnly() && (!Setter || Setter->isSynthesizedAccessorStub()))
5590         CodeGenFunction(*this).GenerateObjCSetter(
5591                                  const_cast<ObjCImplementationDecl *>(D), PID);
5592     }
5593   }
5594 }
5595 
5596 static bool needsDestructMethod(ObjCImplementationDecl *impl) {
5597   const ObjCInterfaceDecl *iface = impl->getClassInterface();
5598   for (const ObjCIvarDecl *ivar = iface->all_declared_ivar_begin();
5599        ivar; ivar = ivar->getNextIvar())
5600     if (ivar->getType().isDestructedType())
5601       return true;
5602 
5603   return false;
5604 }
5605 
5606 static bool AllTrivialInitializers(CodeGenModule &CGM,
5607                                    ObjCImplementationDecl *D) {
5608   CodeGenFunction CGF(CGM);
5609   for (ObjCImplementationDecl::init_iterator B = D->init_begin(),
5610        E = D->init_end(); B != E; ++B) {
5611     CXXCtorInitializer *CtorInitExp = *B;
5612     Expr *Init = CtorInitExp->getInit();
5613     if (!CGF.isTrivialInitializer(Init))
5614       return false;
5615   }
5616   return true;
5617 }
5618 
5619 /// EmitObjCIvarInitializations - Emit information for ivar initialization
5620 /// for an implementation.
5621 void CodeGenModule::EmitObjCIvarInitializations(ObjCImplementationDecl *D) {
5622   // We might need a .cxx_destruct even if we don't have any ivar initializers.
5623   if (needsDestructMethod(D)) {
5624     IdentifierInfo *II = &getContext().Idents.get(".cxx_destruct");
5625     Selector cxxSelector = getContext().Selectors.getSelector(0, &II);
5626     ObjCMethodDecl *DTORMethod = ObjCMethodDecl::Create(
5627         getContext(), D->getLocation(), D->getLocation(), cxxSelector,
5628         getContext().VoidTy, nullptr, D,
5629         /*isInstance=*/true, /*isVariadic=*/false,
5630         /*isPropertyAccessor=*/true, /*isSynthesizedAccessorStub=*/false,
5631         /*isImplicitlyDeclared=*/true,
5632         /*isDefined=*/false, ObjCMethodDecl::Required);
5633     D->addInstanceMethod(DTORMethod);
5634     CodeGenFunction(*this).GenerateObjCCtorDtorMethod(D, DTORMethod, false);
5635     D->setHasDestructors(true);
5636   }
5637 
5638   // If the implementation doesn't have any ivar initializers, we don't need
5639   // a .cxx_construct.
5640   if (D->getNumIvarInitializers() == 0 ||
5641       AllTrivialInitializers(*this, D))
5642     return;
5643 
5644   IdentifierInfo *II = &getContext().Idents.get(".cxx_construct");
5645   Selector cxxSelector = getContext().Selectors.getSelector(0, &II);
5646   // The constructor returns 'self'.
5647   ObjCMethodDecl *CTORMethod = ObjCMethodDecl::Create(
5648       getContext(), D->getLocation(), D->getLocation(), cxxSelector,
5649       getContext().getObjCIdType(), nullptr, D, /*isInstance=*/true,
5650       /*isVariadic=*/false,
5651       /*isPropertyAccessor=*/true, /*isSynthesizedAccessorStub=*/false,
5652       /*isImplicitlyDeclared=*/true,
5653       /*isDefined=*/false, ObjCMethodDecl::Required);
5654   D->addInstanceMethod(CTORMethod);
5655   CodeGenFunction(*this).GenerateObjCCtorDtorMethod(D, CTORMethod, true);
5656   D->setHasNonZeroConstructors(true);
5657 }
5658 
5659 // EmitLinkageSpec - Emit all declarations in a linkage spec.
5660 void CodeGenModule::EmitLinkageSpec(const LinkageSpecDecl *LSD) {
5661   if (LSD->getLanguage() != LinkageSpecDecl::lang_c &&
5662       LSD->getLanguage() != LinkageSpecDecl::lang_cxx) {
5663     ErrorUnsupported(LSD, "linkage spec");
5664     return;
5665   }
5666 
5667   EmitDeclContext(LSD);
5668 }
5669 
5670 void CodeGenModule::EmitDeclContext(const DeclContext *DC) {
5671   for (auto *I : DC->decls()) {
5672     // Unlike other DeclContexts, the contents of an ObjCImplDecl at TU scope
5673     // are themselves considered "top-level", so EmitTopLevelDecl on an
5674     // ObjCImplDecl does not recursively visit them. We need to do that in
5675     // case they're nested inside another construct (LinkageSpecDecl /
5676     // ExportDecl) that does stop them from being considered "top-level".
5677     if (auto *OID = dyn_cast<ObjCImplDecl>(I)) {
5678       for (auto *M : OID->methods())
5679         EmitTopLevelDecl(M);
5680     }
5681 
5682     EmitTopLevelDecl(I);
5683   }
5684 }
5685 
5686 /// EmitTopLevelDecl - Emit code for a single top level declaration.
5687 void CodeGenModule::EmitTopLevelDecl(Decl *D) {
5688   // Ignore dependent declarations.
5689   if (D->isTemplated())
5690     return;
5691 
5692   // Consteval function shouldn't be emitted.
5693   if (auto *FD = dyn_cast<FunctionDecl>(D))
5694     if (FD->isConsteval())
5695       return;
5696 
5697   switch (D->getKind()) {
5698   case Decl::CXXConversion:
5699   case Decl::CXXMethod:
5700   case Decl::Function:
5701     EmitGlobal(cast<FunctionDecl>(D));
5702     // Always provide some coverage mapping
5703     // even for the functions that aren't emitted.
5704     AddDeferredUnusedCoverageMapping(D);
5705     break;
5706 
5707   case Decl::CXXDeductionGuide:
5708     // Function-like, but does not result in code emission.
5709     break;
5710 
5711   case Decl::Var:
5712   case Decl::Decomposition:
5713   case Decl::VarTemplateSpecialization:
5714     EmitGlobal(cast<VarDecl>(D));
5715     if (auto *DD = dyn_cast<DecompositionDecl>(D))
5716       for (auto *B : DD->bindings())
5717         if (auto *HD = B->getHoldingVar())
5718           EmitGlobal(HD);
5719     break;
5720 
5721   // Indirect fields from global anonymous structs and unions can be
5722   // ignored; only the actual variable requires IR gen support.
5723   case Decl::IndirectField:
5724     break;
5725 
5726   // C++ Decls
5727   case Decl::Namespace:
5728     EmitDeclContext(cast<NamespaceDecl>(D));
5729     break;
5730   case Decl::ClassTemplateSpecialization: {
5731     const auto *Spec = cast<ClassTemplateSpecializationDecl>(D);
5732     if (CGDebugInfo *DI = getModuleDebugInfo())
5733       if (Spec->getSpecializationKind() ==
5734               TSK_ExplicitInstantiationDefinition &&
5735           Spec->hasDefinition())
5736         DI->completeTemplateDefinition(*Spec);
5737   } LLVM_FALLTHROUGH;
5738   case Decl::CXXRecord: {
5739     CXXRecordDecl *CRD = cast<CXXRecordDecl>(D);
5740     if (CGDebugInfo *DI = getModuleDebugInfo()) {
5741       if (CRD->hasDefinition())
5742         DI->EmitAndRetainType(getContext().getRecordType(cast<RecordDecl>(D)));
5743       if (auto *ES = D->getASTContext().getExternalSource())
5744         if (ES->hasExternalDefinitions(D) == ExternalASTSource::EK_Never)
5745           DI->completeUnusedClass(*CRD);
5746     }
5747     // Emit any static data members, they may be definitions.
5748     for (auto *I : CRD->decls())
5749       if (isa<VarDecl>(I) || isa<CXXRecordDecl>(I))
5750         EmitTopLevelDecl(I);
5751     break;
5752   }
5753     // No code generation needed.
5754   case Decl::UsingShadow:
5755   case Decl::ClassTemplate:
5756   case Decl::VarTemplate:
5757   case Decl::Concept:
5758   case Decl::VarTemplatePartialSpecialization:
5759   case Decl::FunctionTemplate:
5760   case Decl::TypeAliasTemplate:
5761   case Decl::Block:
5762   case Decl::Empty:
5763   case Decl::Binding:
5764     break;
5765   case Decl::Using:          // using X; [C++]
5766     if (CGDebugInfo *DI = getModuleDebugInfo())
5767         DI->EmitUsingDecl(cast<UsingDecl>(*D));
5768     break;
5769   case Decl::UsingEnum: // using enum X; [C++]
5770     if (CGDebugInfo *DI = getModuleDebugInfo())
5771       DI->EmitUsingEnumDecl(cast<UsingEnumDecl>(*D));
5772     break;
5773   case Decl::NamespaceAlias:
5774     if (CGDebugInfo *DI = getModuleDebugInfo())
5775         DI->EmitNamespaceAlias(cast<NamespaceAliasDecl>(*D));
5776     break;
5777   case Decl::UsingDirective: // using namespace X; [C++]
5778     if (CGDebugInfo *DI = getModuleDebugInfo())
5779       DI->EmitUsingDirective(cast<UsingDirectiveDecl>(*D));
5780     break;
5781   case Decl::CXXConstructor:
5782     getCXXABI().EmitCXXConstructors(cast<CXXConstructorDecl>(D));
5783     break;
5784   case Decl::CXXDestructor:
5785     getCXXABI().EmitCXXDestructors(cast<CXXDestructorDecl>(D));
5786     break;
5787 
5788   case Decl::StaticAssert:
5789     // Nothing to do.
5790     break;
5791 
5792   // Objective-C Decls
5793 
5794   // Forward declarations, no (immediate) code generation.
5795   case Decl::ObjCInterface:
5796   case Decl::ObjCCategory:
5797     break;
5798 
5799   case Decl::ObjCProtocol: {
5800     auto *Proto = cast<ObjCProtocolDecl>(D);
5801     if (Proto->isThisDeclarationADefinition())
5802       ObjCRuntime->GenerateProtocol(Proto);
5803     break;
5804   }
5805 
5806   case Decl::ObjCCategoryImpl:
5807     // Categories have properties but don't support synthesize so we
5808     // can ignore them here.
5809     ObjCRuntime->GenerateCategory(cast<ObjCCategoryImplDecl>(D));
5810     break;
5811 
5812   case Decl::ObjCImplementation: {
5813     auto *OMD = cast<ObjCImplementationDecl>(D);
5814     EmitObjCPropertyImplementations(OMD);
5815     EmitObjCIvarInitializations(OMD);
5816     ObjCRuntime->GenerateClass(OMD);
5817     // Emit global variable debug information.
5818     if (CGDebugInfo *DI = getModuleDebugInfo())
5819       if (getCodeGenOpts().hasReducedDebugInfo())
5820         DI->getOrCreateInterfaceType(getContext().getObjCInterfaceType(
5821             OMD->getClassInterface()), OMD->getLocation());
5822     break;
5823   }
5824   case Decl::ObjCMethod: {
5825     auto *OMD = cast<ObjCMethodDecl>(D);
5826     // If this is not a prototype, emit the body.
5827     if (OMD->getBody())
5828       CodeGenFunction(*this).GenerateObjCMethod(OMD);
5829     break;
5830   }
5831   case Decl::ObjCCompatibleAlias:
5832     ObjCRuntime->RegisterAlias(cast<ObjCCompatibleAliasDecl>(D));
5833     break;
5834 
5835   case Decl::PragmaComment: {
5836     const auto *PCD = cast<PragmaCommentDecl>(D);
5837     switch (PCD->getCommentKind()) {
5838     case PCK_Unknown:
5839       llvm_unreachable("unexpected pragma comment kind");
5840     case PCK_Linker:
5841       AppendLinkerOptions(PCD->getArg());
5842       break;
5843     case PCK_Lib:
5844         AddDependentLib(PCD->getArg());
5845       break;
5846     case PCK_Compiler:
5847     case PCK_ExeStr:
5848     case PCK_User:
5849       break; // We ignore all of these.
5850     }
5851     break;
5852   }
5853 
5854   case Decl::PragmaDetectMismatch: {
5855     const auto *PDMD = cast<PragmaDetectMismatchDecl>(D);
5856     AddDetectMismatch(PDMD->getName(), PDMD->getValue());
5857     break;
5858   }
5859 
5860   case Decl::LinkageSpec:
5861     EmitLinkageSpec(cast<LinkageSpecDecl>(D));
5862     break;
5863 
5864   case Decl::FileScopeAsm: {
5865     // File-scope asm is ignored during device-side CUDA compilation.
5866     if (LangOpts.CUDA && LangOpts.CUDAIsDevice)
5867       break;
5868     // File-scope asm is ignored during device-side OpenMP compilation.
5869     if (LangOpts.OpenMPIsDevice)
5870       break;
5871     // File-scope asm is ignored during device-side SYCL compilation.
5872     if (LangOpts.SYCLIsDevice)
5873       break;
5874     auto *AD = cast<FileScopeAsmDecl>(D);
5875     getModule().appendModuleInlineAsm(AD->getAsmString()->getString());
5876     break;
5877   }
5878 
5879   case Decl::Import: {
5880     auto *Import = cast<ImportDecl>(D);
5881 
5882     // If we've already imported this module, we're done.
5883     if (!ImportedModules.insert(Import->getImportedModule()))
5884       break;
5885 
5886     // Emit debug information for direct imports.
5887     if (!Import->getImportedOwningModule()) {
5888       if (CGDebugInfo *DI = getModuleDebugInfo())
5889         DI->EmitImportDecl(*Import);
5890     }
5891 
5892     // Find all of the submodules and emit the module initializers.
5893     llvm::SmallPtrSet<clang::Module *, 16> Visited;
5894     SmallVector<clang::Module *, 16> Stack;
5895     Visited.insert(Import->getImportedModule());
5896     Stack.push_back(Import->getImportedModule());
5897 
5898     while (!Stack.empty()) {
5899       clang::Module *Mod = Stack.pop_back_val();
5900       if (!EmittedModuleInitializers.insert(Mod).second)
5901         continue;
5902 
5903       for (auto *D : Context.getModuleInitializers(Mod))
5904         EmitTopLevelDecl(D);
5905 
5906       // Visit the submodules of this module.
5907       for (clang::Module::submodule_iterator Sub = Mod->submodule_begin(),
5908                                              SubEnd = Mod->submodule_end();
5909            Sub != SubEnd; ++Sub) {
5910         // Skip explicit children; they need to be explicitly imported to emit
5911         // the initializers.
5912         if ((*Sub)->IsExplicit)
5913           continue;
5914 
5915         if (Visited.insert(*Sub).second)
5916           Stack.push_back(*Sub);
5917       }
5918     }
5919     break;
5920   }
5921 
5922   case Decl::Export:
5923     EmitDeclContext(cast<ExportDecl>(D));
5924     break;
5925 
5926   case Decl::OMPThreadPrivate:
5927     EmitOMPThreadPrivateDecl(cast<OMPThreadPrivateDecl>(D));
5928     break;
5929 
5930   case Decl::OMPAllocate:
5931     EmitOMPAllocateDecl(cast<OMPAllocateDecl>(D));
5932     break;
5933 
5934   case Decl::OMPDeclareReduction:
5935     EmitOMPDeclareReduction(cast<OMPDeclareReductionDecl>(D));
5936     break;
5937 
5938   case Decl::OMPDeclareMapper:
5939     EmitOMPDeclareMapper(cast<OMPDeclareMapperDecl>(D));
5940     break;
5941 
5942   case Decl::OMPRequires:
5943     EmitOMPRequiresDecl(cast<OMPRequiresDecl>(D));
5944     break;
5945 
5946   case Decl::Typedef:
5947   case Decl::TypeAlias: // using foo = bar; [C++11]
5948     if (CGDebugInfo *DI = getModuleDebugInfo())
5949       DI->EmitAndRetainType(
5950           getContext().getTypedefType(cast<TypedefNameDecl>(D)));
5951     break;
5952 
5953   case Decl::Record:
5954     if (CGDebugInfo *DI = getModuleDebugInfo())
5955       if (cast<RecordDecl>(D)->getDefinition())
5956         DI->EmitAndRetainType(getContext().getRecordType(cast<RecordDecl>(D)));
5957     break;
5958 
5959   case Decl::Enum:
5960     if (CGDebugInfo *DI = getModuleDebugInfo())
5961       if (cast<EnumDecl>(D)->getDefinition())
5962         DI->EmitAndRetainType(getContext().getEnumType(cast<EnumDecl>(D)));
5963     break;
5964 
5965   default:
5966     // Make sure we handled everything we should, every other kind is a
5967     // non-top-level decl.  FIXME: Would be nice to have an isTopLevelDeclKind
5968     // function. Need to recode Decl::Kind to do that easily.
5969     assert(isa<TypeDecl>(D) && "Unsupported decl kind");
5970     break;
5971   }
5972 }
5973 
5974 void CodeGenModule::AddDeferredUnusedCoverageMapping(Decl *D) {
5975   // Do we need to generate coverage mapping?
5976   if (!CodeGenOpts.CoverageMapping)
5977     return;
5978   switch (D->getKind()) {
5979   case Decl::CXXConversion:
5980   case Decl::CXXMethod:
5981   case Decl::Function:
5982   case Decl::ObjCMethod:
5983   case Decl::CXXConstructor:
5984   case Decl::CXXDestructor: {
5985     if (!cast<FunctionDecl>(D)->doesThisDeclarationHaveABody())
5986       break;
5987     SourceManager &SM = getContext().getSourceManager();
5988     if (LimitedCoverage && SM.getMainFileID() != SM.getFileID(D->getBeginLoc()))
5989       break;
5990     auto I = DeferredEmptyCoverageMappingDecls.find(D);
5991     if (I == DeferredEmptyCoverageMappingDecls.end())
5992       DeferredEmptyCoverageMappingDecls[D] = true;
5993     break;
5994   }
5995   default:
5996     break;
5997   };
5998 }
5999 
6000 void CodeGenModule::ClearUnusedCoverageMapping(const Decl *D) {
6001   // Do we need to generate coverage mapping?
6002   if (!CodeGenOpts.CoverageMapping)
6003     return;
6004   if (const auto *Fn = dyn_cast<FunctionDecl>(D)) {
6005     if (Fn->isTemplateInstantiation())
6006       ClearUnusedCoverageMapping(Fn->getTemplateInstantiationPattern());
6007   }
6008   auto I = DeferredEmptyCoverageMappingDecls.find(D);
6009   if (I == DeferredEmptyCoverageMappingDecls.end())
6010     DeferredEmptyCoverageMappingDecls[D] = false;
6011   else
6012     I->second = false;
6013 }
6014 
6015 void CodeGenModule::EmitDeferredUnusedCoverageMappings() {
6016   // We call takeVector() here to avoid use-after-free.
6017   // FIXME: DeferredEmptyCoverageMappingDecls is getting mutated because
6018   // we deserialize function bodies to emit coverage info for them, and that
6019   // deserializes more declarations. How should we handle that case?
6020   for (const auto &Entry : DeferredEmptyCoverageMappingDecls.takeVector()) {
6021     if (!Entry.second)
6022       continue;
6023     const Decl *D = Entry.first;
6024     switch (D->getKind()) {
6025     case Decl::CXXConversion:
6026     case Decl::CXXMethod:
6027     case Decl::Function:
6028     case Decl::ObjCMethod: {
6029       CodeGenPGO PGO(*this);
6030       GlobalDecl GD(cast<FunctionDecl>(D));
6031       PGO.emitEmptyCounterMapping(D, getMangledName(GD),
6032                                   getFunctionLinkage(GD));
6033       break;
6034     }
6035     case Decl::CXXConstructor: {
6036       CodeGenPGO PGO(*this);
6037       GlobalDecl GD(cast<CXXConstructorDecl>(D), Ctor_Base);
6038       PGO.emitEmptyCounterMapping(D, getMangledName(GD),
6039                                   getFunctionLinkage(GD));
6040       break;
6041     }
6042     case Decl::CXXDestructor: {
6043       CodeGenPGO PGO(*this);
6044       GlobalDecl GD(cast<CXXDestructorDecl>(D), Dtor_Base);
6045       PGO.emitEmptyCounterMapping(D, getMangledName(GD),
6046                                   getFunctionLinkage(GD));
6047       break;
6048     }
6049     default:
6050       break;
6051     };
6052   }
6053 }
6054 
6055 void CodeGenModule::EmitMainVoidAlias() {
6056   // In order to transition away from "__original_main" gracefully, emit an
6057   // alias for "main" in the no-argument case so that libc can detect when
6058   // new-style no-argument main is in used.
6059   if (llvm::Function *F = getModule().getFunction("main")) {
6060     if (!F->isDeclaration() && F->arg_size() == 0 && !F->isVarArg() &&
6061         F->getReturnType()->isIntegerTy(Context.getTargetInfo().getIntWidth()))
6062       addUsedGlobal(llvm::GlobalAlias::create("__main_void", F));
6063   }
6064 }
6065 
6066 /// Turns the given pointer into a constant.
6067 static llvm::Constant *GetPointerConstant(llvm::LLVMContext &Context,
6068                                           const void *Ptr) {
6069   uintptr_t PtrInt = reinterpret_cast<uintptr_t>(Ptr);
6070   llvm::Type *i64 = llvm::Type::getInt64Ty(Context);
6071   return llvm::ConstantInt::get(i64, PtrInt);
6072 }
6073 
6074 static void EmitGlobalDeclMetadata(CodeGenModule &CGM,
6075                                    llvm::NamedMDNode *&GlobalMetadata,
6076                                    GlobalDecl D,
6077                                    llvm::GlobalValue *Addr) {
6078   if (!GlobalMetadata)
6079     GlobalMetadata =
6080       CGM.getModule().getOrInsertNamedMetadata("clang.global.decl.ptrs");
6081 
6082   // TODO: should we report variant information for ctors/dtors?
6083   llvm::Metadata *Ops[] = {llvm::ConstantAsMetadata::get(Addr),
6084                            llvm::ConstantAsMetadata::get(GetPointerConstant(
6085                                CGM.getLLVMContext(), D.getDecl()))};
6086   GlobalMetadata->addOperand(llvm::MDNode::get(CGM.getLLVMContext(), Ops));
6087 }
6088 
6089 /// For each function which is declared within an extern "C" region and marked
6090 /// as 'used', but has internal linkage, create an alias from the unmangled
6091 /// name to the mangled name if possible. People expect to be able to refer
6092 /// to such functions with an unmangled name from inline assembly within the
6093 /// same translation unit.
6094 void CodeGenModule::EmitStaticExternCAliases() {
6095   if (!getTargetCodeGenInfo().shouldEmitStaticExternCAliases())
6096     return;
6097   for (auto &I : StaticExternCValues) {
6098     IdentifierInfo *Name = I.first;
6099     llvm::GlobalValue *Val = I.second;
6100     if (Val && !getModule().getNamedValue(Name->getName()))
6101       addCompilerUsedGlobal(llvm::GlobalAlias::create(Name->getName(), Val));
6102   }
6103 }
6104 
6105 bool CodeGenModule::lookupRepresentativeDecl(StringRef MangledName,
6106                                              GlobalDecl &Result) const {
6107   auto Res = Manglings.find(MangledName);
6108   if (Res == Manglings.end())
6109     return false;
6110   Result = Res->getValue();
6111   return true;
6112 }
6113 
6114 /// Emits metadata nodes associating all the global values in the
6115 /// current module with the Decls they came from.  This is useful for
6116 /// projects using IR gen as a subroutine.
6117 ///
6118 /// Since there's currently no way to associate an MDNode directly
6119 /// with an llvm::GlobalValue, we create a global named metadata
6120 /// with the name 'clang.global.decl.ptrs'.
6121 void CodeGenModule::EmitDeclMetadata() {
6122   llvm::NamedMDNode *GlobalMetadata = nullptr;
6123 
6124   for (auto &I : MangledDeclNames) {
6125     llvm::GlobalValue *Addr = getModule().getNamedValue(I.second);
6126     // Some mangled names don't necessarily have an associated GlobalValue
6127     // in this module, e.g. if we mangled it for DebugInfo.
6128     if (Addr)
6129       EmitGlobalDeclMetadata(*this, GlobalMetadata, I.first, Addr);
6130   }
6131 }
6132 
6133 /// Emits metadata nodes for all the local variables in the current
6134 /// function.
6135 void CodeGenFunction::EmitDeclMetadata() {
6136   if (LocalDeclMap.empty()) return;
6137 
6138   llvm::LLVMContext &Context = getLLVMContext();
6139 
6140   // Find the unique metadata ID for this name.
6141   unsigned DeclPtrKind = Context.getMDKindID("clang.decl.ptr");
6142 
6143   llvm::NamedMDNode *GlobalMetadata = nullptr;
6144 
6145   for (auto &I : LocalDeclMap) {
6146     const Decl *D = I.first;
6147     llvm::Value *Addr = I.second.getPointer();
6148     if (auto *Alloca = dyn_cast<llvm::AllocaInst>(Addr)) {
6149       llvm::Value *DAddr = GetPointerConstant(getLLVMContext(), D);
6150       Alloca->setMetadata(
6151           DeclPtrKind, llvm::MDNode::get(
6152                            Context, llvm::ValueAsMetadata::getConstant(DAddr)));
6153     } else if (auto *GV = dyn_cast<llvm::GlobalValue>(Addr)) {
6154       GlobalDecl GD = GlobalDecl(cast<VarDecl>(D));
6155       EmitGlobalDeclMetadata(CGM, GlobalMetadata, GD, GV);
6156     }
6157   }
6158 }
6159 
6160 void CodeGenModule::EmitVersionIdentMetadata() {
6161   llvm::NamedMDNode *IdentMetadata =
6162     TheModule.getOrInsertNamedMetadata("llvm.ident");
6163   std::string Version = getClangFullVersion();
6164   llvm::LLVMContext &Ctx = TheModule.getContext();
6165 
6166   llvm::Metadata *IdentNode[] = {llvm::MDString::get(Ctx, Version)};
6167   IdentMetadata->addOperand(llvm::MDNode::get(Ctx, IdentNode));
6168 }
6169 
6170 void CodeGenModule::EmitCommandLineMetadata() {
6171   llvm::NamedMDNode *CommandLineMetadata =
6172     TheModule.getOrInsertNamedMetadata("llvm.commandline");
6173   std::string CommandLine = getCodeGenOpts().RecordCommandLine;
6174   llvm::LLVMContext &Ctx = TheModule.getContext();
6175 
6176   llvm::Metadata *CommandLineNode[] = {llvm::MDString::get(Ctx, CommandLine)};
6177   CommandLineMetadata->addOperand(llvm::MDNode::get(Ctx, CommandLineNode));
6178 }
6179 
6180 void CodeGenModule::EmitCoverageFile() {
6181   if (getCodeGenOpts().CoverageDataFile.empty() &&
6182       getCodeGenOpts().CoverageNotesFile.empty())
6183     return;
6184 
6185   llvm::NamedMDNode *CUNode = TheModule.getNamedMetadata("llvm.dbg.cu");
6186   if (!CUNode)
6187     return;
6188 
6189   llvm::NamedMDNode *GCov = TheModule.getOrInsertNamedMetadata("llvm.gcov");
6190   llvm::LLVMContext &Ctx = TheModule.getContext();
6191   auto *CoverageDataFile =
6192       llvm::MDString::get(Ctx, getCodeGenOpts().CoverageDataFile);
6193   auto *CoverageNotesFile =
6194       llvm::MDString::get(Ctx, getCodeGenOpts().CoverageNotesFile);
6195   for (int i = 0, e = CUNode->getNumOperands(); i != e; ++i) {
6196     llvm::MDNode *CU = CUNode->getOperand(i);
6197     llvm::Metadata *Elts[] = {CoverageNotesFile, CoverageDataFile, CU};
6198     GCov->addOperand(llvm::MDNode::get(Ctx, Elts));
6199   }
6200 }
6201 
6202 llvm::Constant *CodeGenModule::GetAddrOfRTTIDescriptor(QualType Ty,
6203                                                        bool ForEH) {
6204   // Return a bogus pointer if RTTI is disabled, unless it's for EH.
6205   // FIXME: should we even be calling this method if RTTI is disabled
6206   // and it's not for EH?
6207   if ((!ForEH && !getLangOpts().RTTI) || getLangOpts().CUDAIsDevice ||
6208       (getLangOpts().OpenMP && getLangOpts().OpenMPIsDevice &&
6209        getTriple().isNVPTX()))
6210     return llvm::Constant::getNullValue(Int8PtrTy);
6211 
6212   if (ForEH && Ty->isObjCObjectPointerType() &&
6213       LangOpts.ObjCRuntime.isGNUFamily())
6214     return ObjCRuntime->GetEHType(Ty);
6215 
6216   return getCXXABI().getAddrOfRTTIDescriptor(Ty);
6217 }
6218 
6219 void CodeGenModule::EmitOMPThreadPrivateDecl(const OMPThreadPrivateDecl *D) {
6220   // Do not emit threadprivates in simd-only mode.
6221   if (LangOpts.OpenMP && LangOpts.OpenMPSimd)
6222     return;
6223   for (auto RefExpr : D->varlists()) {
6224     auto *VD = cast<VarDecl>(cast<DeclRefExpr>(RefExpr)->getDecl());
6225     bool PerformInit =
6226         VD->getAnyInitializer() &&
6227         !VD->getAnyInitializer()->isConstantInitializer(getContext(),
6228                                                         /*ForRef=*/false);
6229 
6230     Address Addr(GetAddrOfGlobalVar(VD), getContext().getDeclAlign(VD));
6231     if (auto InitFunction = getOpenMPRuntime().emitThreadPrivateVarDefinition(
6232             VD, Addr, RefExpr->getBeginLoc(), PerformInit))
6233       CXXGlobalInits.push_back(InitFunction);
6234   }
6235 }
6236 
6237 llvm::Metadata *
6238 CodeGenModule::CreateMetadataIdentifierImpl(QualType T, MetadataTypeMap &Map,
6239                                             StringRef Suffix) {
6240   llvm::Metadata *&InternalId = Map[T.getCanonicalType()];
6241   if (InternalId)
6242     return InternalId;
6243 
6244   if (isExternallyVisible(T->getLinkage())) {
6245     std::string OutName;
6246     llvm::raw_string_ostream Out(OutName);
6247     getCXXABI().getMangleContext().mangleTypeName(T, Out);
6248     Out << Suffix;
6249 
6250     InternalId = llvm::MDString::get(getLLVMContext(), Out.str());
6251   } else {
6252     InternalId = llvm::MDNode::getDistinct(getLLVMContext(),
6253                                            llvm::ArrayRef<llvm::Metadata *>());
6254   }
6255 
6256   return InternalId;
6257 }
6258 
6259 llvm::Metadata *CodeGenModule::CreateMetadataIdentifierForType(QualType T) {
6260   return CreateMetadataIdentifierImpl(T, MetadataIdMap, "");
6261 }
6262 
6263 llvm::Metadata *
6264 CodeGenModule::CreateMetadataIdentifierForVirtualMemPtrType(QualType T) {
6265   return CreateMetadataIdentifierImpl(T, VirtualMetadataIdMap, ".virtual");
6266 }
6267 
6268 // Generalize pointer types to a void pointer with the qualifiers of the
6269 // originally pointed-to type, e.g. 'const char *' and 'char * const *'
6270 // generalize to 'const void *' while 'char *' and 'const char **' generalize to
6271 // 'void *'.
6272 static QualType GeneralizeType(ASTContext &Ctx, QualType Ty) {
6273   if (!Ty->isPointerType())
6274     return Ty;
6275 
6276   return Ctx.getPointerType(
6277       QualType(Ctx.VoidTy).withCVRQualifiers(
6278           Ty->getPointeeType().getCVRQualifiers()));
6279 }
6280 
6281 // Apply type generalization to a FunctionType's return and argument types
6282 static QualType GeneralizeFunctionType(ASTContext &Ctx, QualType Ty) {
6283   if (auto *FnType = Ty->getAs<FunctionProtoType>()) {
6284     SmallVector<QualType, 8> GeneralizedParams;
6285     for (auto &Param : FnType->param_types())
6286       GeneralizedParams.push_back(GeneralizeType(Ctx, Param));
6287 
6288     return Ctx.getFunctionType(
6289         GeneralizeType(Ctx, FnType->getReturnType()),
6290         GeneralizedParams, FnType->getExtProtoInfo());
6291   }
6292 
6293   if (auto *FnType = Ty->getAs<FunctionNoProtoType>())
6294     return Ctx.getFunctionNoProtoType(
6295         GeneralizeType(Ctx, FnType->getReturnType()));
6296 
6297   llvm_unreachable("Encountered unknown FunctionType");
6298 }
6299 
6300 llvm::Metadata *CodeGenModule::CreateMetadataIdentifierGeneralized(QualType T) {
6301   return CreateMetadataIdentifierImpl(GeneralizeFunctionType(getContext(), T),
6302                                       GeneralizedMetadataIdMap, ".generalized");
6303 }
6304 
6305 /// Returns whether this module needs the "all-vtables" type identifier.
6306 bool CodeGenModule::NeedAllVtablesTypeId() const {
6307   // Returns true if at least one of vtable-based CFI checkers is enabled and
6308   // is not in the trapping mode.
6309   return ((LangOpts.Sanitize.has(SanitizerKind::CFIVCall) &&
6310            !CodeGenOpts.SanitizeTrap.has(SanitizerKind::CFIVCall)) ||
6311           (LangOpts.Sanitize.has(SanitizerKind::CFINVCall) &&
6312            !CodeGenOpts.SanitizeTrap.has(SanitizerKind::CFINVCall)) ||
6313           (LangOpts.Sanitize.has(SanitizerKind::CFIDerivedCast) &&
6314            !CodeGenOpts.SanitizeTrap.has(SanitizerKind::CFIDerivedCast)) ||
6315           (LangOpts.Sanitize.has(SanitizerKind::CFIUnrelatedCast) &&
6316            !CodeGenOpts.SanitizeTrap.has(SanitizerKind::CFIUnrelatedCast)));
6317 }
6318 
6319 void CodeGenModule::AddVTableTypeMetadata(llvm::GlobalVariable *VTable,
6320                                           CharUnits Offset,
6321                                           const CXXRecordDecl *RD) {
6322   llvm::Metadata *MD =
6323       CreateMetadataIdentifierForType(QualType(RD->getTypeForDecl(), 0));
6324   VTable->addTypeMetadata(Offset.getQuantity(), MD);
6325 
6326   if (CodeGenOpts.SanitizeCfiCrossDso)
6327     if (auto CrossDsoTypeId = CreateCrossDsoCfiTypeId(MD))
6328       VTable->addTypeMetadata(Offset.getQuantity(),
6329                               llvm::ConstantAsMetadata::get(CrossDsoTypeId));
6330 
6331   if (NeedAllVtablesTypeId()) {
6332     llvm::Metadata *MD = llvm::MDString::get(getLLVMContext(), "all-vtables");
6333     VTable->addTypeMetadata(Offset.getQuantity(), MD);
6334   }
6335 }
6336 
6337 llvm::SanitizerStatReport &CodeGenModule::getSanStats() {
6338   if (!SanStats)
6339     SanStats = std::make_unique<llvm::SanitizerStatReport>(&getModule());
6340 
6341   return *SanStats;
6342 }
6343 
6344 llvm::Value *
6345 CodeGenModule::createOpenCLIntToSamplerConversion(const Expr *E,
6346                                                   CodeGenFunction &CGF) {
6347   llvm::Constant *C = ConstantEmitter(CGF).emitAbstract(E, E->getType());
6348   auto *SamplerT = getOpenCLRuntime().getSamplerType(E->getType().getTypePtr());
6349   auto *FTy = llvm::FunctionType::get(SamplerT, {C->getType()}, false);
6350   auto *Call = CGF.EmitRuntimeCall(
6351       CreateRuntimeFunction(FTy, "__translate_sampler_initializer"), {C});
6352   return Call;
6353 }
6354 
6355 CharUnits CodeGenModule::getNaturalPointeeTypeAlignment(
6356     QualType T, LValueBaseInfo *BaseInfo, TBAAAccessInfo *TBAAInfo) {
6357   return getNaturalTypeAlignment(T->getPointeeType(), BaseInfo, TBAAInfo,
6358                                  /* forPointeeType= */ true);
6359 }
6360 
6361 CharUnits CodeGenModule::getNaturalTypeAlignment(QualType T,
6362                                                  LValueBaseInfo *BaseInfo,
6363                                                  TBAAAccessInfo *TBAAInfo,
6364                                                  bool forPointeeType) {
6365   if (TBAAInfo)
6366     *TBAAInfo = getTBAAAccessInfo(T);
6367 
6368   // FIXME: This duplicates logic in ASTContext::getTypeAlignIfKnown. But
6369   // that doesn't return the information we need to compute BaseInfo.
6370 
6371   // Honor alignment typedef attributes even on incomplete types.
6372   // We also honor them straight for C++ class types, even as pointees;
6373   // there's an expressivity gap here.
6374   if (auto TT = T->getAs<TypedefType>()) {
6375     if (auto Align = TT->getDecl()->getMaxAlignment()) {
6376       if (BaseInfo)
6377         *BaseInfo = LValueBaseInfo(AlignmentSource::AttributedType);
6378       return getContext().toCharUnitsFromBits(Align);
6379     }
6380   }
6381 
6382   bool AlignForArray = T->isArrayType();
6383 
6384   // Analyze the base element type, so we don't get confused by incomplete
6385   // array types.
6386   T = getContext().getBaseElementType(T);
6387 
6388   if (T->isIncompleteType()) {
6389     // We could try to replicate the logic from
6390     // ASTContext::getTypeAlignIfKnown, but nothing uses the alignment if the
6391     // type is incomplete, so it's impossible to test. We could try to reuse
6392     // getTypeAlignIfKnown, but that doesn't return the information we need
6393     // to set BaseInfo.  So just ignore the possibility that the alignment is
6394     // greater than one.
6395     if (BaseInfo)
6396       *BaseInfo = LValueBaseInfo(AlignmentSource::Type);
6397     return CharUnits::One();
6398   }
6399 
6400   if (BaseInfo)
6401     *BaseInfo = LValueBaseInfo(AlignmentSource::Type);
6402 
6403   CharUnits Alignment;
6404   const CXXRecordDecl *RD;
6405   if (T.getQualifiers().hasUnaligned()) {
6406     Alignment = CharUnits::One();
6407   } else if (forPointeeType && !AlignForArray &&
6408              (RD = T->getAsCXXRecordDecl())) {
6409     // For C++ class pointees, we don't know whether we're pointing at a
6410     // base or a complete object, so we generally need to use the
6411     // non-virtual alignment.
6412     Alignment = getClassPointerAlignment(RD);
6413   } else {
6414     Alignment = getContext().getTypeAlignInChars(T);
6415   }
6416 
6417   // Cap to the global maximum type alignment unless the alignment
6418   // was somehow explicit on the type.
6419   if (unsigned MaxAlign = getLangOpts().MaxTypeAlign) {
6420     if (Alignment.getQuantity() > MaxAlign &&
6421         !getContext().isAlignmentRequired(T))
6422       Alignment = CharUnits::fromQuantity(MaxAlign);
6423   }
6424   return Alignment;
6425 }
6426 
6427 bool CodeGenModule::stopAutoInit() {
6428   unsigned StopAfter = getContext().getLangOpts().TrivialAutoVarInitStopAfter;
6429   if (StopAfter) {
6430     // This number is positive only when -ftrivial-auto-var-init-stop-after=* is
6431     // used
6432     if (NumAutoVarInit >= StopAfter) {
6433       return true;
6434     }
6435     if (!NumAutoVarInit) {
6436       unsigned DiagID = getDiags().getCustomDiagID(
6437           DiagnosticsEngine::Warning,
6438           "-ftrivial-auto-var-init-stop-after=%0 has been enabled to limit the "
6439           "number of times ftrivial-auto-var-init=%1 gets applied.");
6440       getDiags().Report(DiagID)
6441           << StopAfter
6442           << (getContext().getLangOpts().getTrivialAutoVarInit() ==
6443                       LangOptions::TrivialAutoVarInitKind::Zero
6444                   ? "zero"
6445                   : "pattern");
6446     }
6447     ++NumAutoVarInit;
6448   }
6449   return false;
6450 }
6451 
6452 void CodeGenModule::printPostfixForExternalizedStaticVar(
6453     llvm::raw_ostream &OS) const {
6454   OS << "__static__" << getContext().getCUIDHash();
6455 }
6456