xref: /llvm-project/clang/lib/CodeGen/CodeGenModule.cpp (revision 9f5260ab1350519b6569e67e0cf30a265f02dd20)
1 //===--- CodeGenModule.cpp - Emit LLVM Code from ASTs for a Module --------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This coordinates the per-module state used while generating code.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #include "CodeGenModule.h"
15 #include "CGBlocks.h"
16 #include "CGCUDARuntime.h"
17 #include "CGCXXABI.h"
18 #include "CGCall.h"
19 #include "CGDebugInfo.h"
20 #include "CGObjCRuntime.h"
21 #include "CGOpenCLRuntime.h"
22 #include "CGOpenMPRuntime.h"
23 #include "CodeGenFunction.h"
24 #include "CodeGenPGO.h"
25 #include "CodeGenTBAA.h"
26 #include "CoverageMappingGen.h"
27 #include "TargetInfo.h"
28 #include "clang/AST/ASTContext.h"
29 #include "clang/AST/CharUnits.h"
30 #include "clang/AST/DeclCXX.h"
31 #include "clang/AST/DeclObjC.h"
32 #include "clang/AST/DeclTemplate.h"
33 #include "clang/AST/Mangle.h"
34 #include "clang/AST/RecordLayout.h"
35 #include "clang/AST/RecursiveASTVisitor.h"
36 #include "clang/Basic/Builtins.h"
37 #include "clang/Basic/CharInfo.h"
38 #include "clang/Basic/Diagnostic.h"
39 #include "clang/Basic/Module.h"
40 #include "clang/Basic/SourceManager.h"
41 #include "clang/Basic/TargetInfo.h"
42 #include "clang/Basic/Version.h"
43 #include "clang/Frontend/CodeGenOptions.h"
44 #include "clang/Sema/SemaDiagnostic.h"
45 #include "llvm/ADT/APSInt.h"
46 #include "llvm/ADT/Triple.h"
47 #include "llvm/IR/CallSite.h"
48 #include "llvm/IR/CallingConv.h"
49 #include "llvm/IR/DataLayout.h"
50 #include "llvm/IR/Intrinsics.h"
51 #include "llvm/IR/LLVMContext.h"
52 #include "llvm/IR/Module.h"
53 #include "llvm/ProfileData/InstrProfReader.h"
54 #include "llvm/Support/ConvertUTF.h"
55 #include "llvm/Support/ErrorHandling.h"
56 
57 using namespace clang;
58 using namespace CodeGen;
59 
60 static const char AnnotationSection[] = "llvm.metadata";
61 
62 static CGCXXABI *createCXXABI(CodeGenModule &CGM) {
63   switch (CGM.getTarget().getCXXABI().getKind()) {
64   case TargetCXXABI::GenericAArch64:
65   case TargetCXXABI::GenericARM:
66   case TargetCXXABI::iOS:
67   case TargetCXXABI::iOS64:
68   case TargetCXXABI::WatchOS:
69   case TargetCXXABI::GenericMIPS:
70   case TargetCXXABI::GenericItanium:
71   case TargetCXXABI::WebAssembly:
72     return CreateItaniumCXXABI(CGM);
73   case TargetCXXABI::Microsoft:
74     return CreateMicrosoftCXXABI(CGM);
75   }
76 
77   llvm_unreachable("invalid C++ ABI kind");
78 }
79 
80 CodeGenModule::CodeGenModule(ASTContext &C, const HeaderSearchOptions &HSO,
81                              const PreprocessorOptions &PPO,
82                              const CodeGenOptions &CGO, llvm::Module &M,
83                              DiagnosticsEngine &diags,
84                              CoverageSourceInfo *CoverageInfo)
85     : Context(C), LangOpts(C.getLangOpts()), HeaderSearchOpts(HSO),
86       PreprocessorOpts(PPO), CodeGenOpts(CGO), TheModule(M), Diags(diags),
87       Target(C.getTargetInfo()), ABI(createCXXABI(*this)),
88       VMContext(M.getContext()), TBAA(nullptr), TheTargetCodeGenInfo(nullptr),
89       Types(*this), VTables(*this), ObjCRuntime(nullptr),
90       OpenCLRuntime(nullptr), OpenMPRuntime(nullptr), CUDARuntime(nullptr),
91       DebugInfo(nullptr), ObjCData(nullptr),
92       NoObjCARCExceptionsMetadata(nullptr), PGOReader(nullptr),
93       CFConstantStringClassRef(nullptr), ConstantStringClassRef(nullptr),
94       NSConstantStringType(nullptr), NSConcreteGlobalBlock(nullptr),
95       NSConcreteStackBlock(nullptr), BlockObjectAssign(nullptr),
96       BlockObjectDispose(nullptr), BlockDescriptorType(nullptr),
97       GenericBlockLiteralType(nullptr), LifetimeStartFn(nullptr),
98       LifetimeEndFn(nullptr), SanitizerMD(new SanitizerMetadata(*this)) {
99 
100   // Initialize the type cache.
101   llvm::LLVMContext &LLVMContext = M.getContext();
102   VoidTy = llvm::Type::getVoidTy(LLVMContext);
103   Int8Ty = llvm::Type::getInt8Ty(LLVMContext);
104   Int16Ty = llvm::Type::getInt16Ty(LLVMContext);
105   Int32Ty = llvm::Type::getInt32Ty(LLVMContext);
106   Int64Ty = llvm::Type::getInt64Ty(LLVMContext);
107   FloatTy = llvm::Type::getFloatTy(LLVMContext);
108   DoubleTy = llvm::Type::getDoubleTy(LLVMContext);
109   PointerWidthInBits = C.getTargetInfo().getPointerWidth(0);
110   PointerAlignInBytes =
111     C.toCharUnitsFromBits(C.getTargetInfo().getPointerAlign(0)).getQuantity();
112   IntAlignInBytes =
113     C.toCharUnitsFromBits(C.getTargetInfo().getIntAlign()).getQuantity();
114   IntTy = llvm::IntegerType::get(LLVMContext, C.getTargetInfo().getIntWidth());
115   IntPtrTy = llvm::IntegerType::get(LLVMContext, PointerWidthInBits);
116   Int8PtrTy = Int8Ty->getPointerTo(0);
117   Int8PtrPtrTy = Int8PtrTy->getPointerTo(0);
118 
119   RuntimeCC = getTargetCodeGenInfo().getABIInfo().getRuntimeCC();
120   BuiltinCC = getTargetCodeGenInfo().getABIInfo().getBuiltinCC();
121 
122   if (LangOpts.ObjC1)
123     createObjCRuntime();
124   if (LangOpts.OpenCL)
125     createOpenCLRuntime();
126   if (LangOpts.OpenMP)
127     createOpenMPRuntime();
128   if (LangOpts.CUDA)
129     createCUDARuntime();
130 
131   // Enable TBAA unless it's suppressed. ThreadSanitizer needs TBAA even at O0.
132   if (LangOpts.Sanitize.has(SanitizerKind::Thread) ||
133       (!CodeGenOpts.RelaxedAliasing && CodeGenOpts.OptimizationLevel > 0))
134     TBAA = new CodeGenTBAA(Context, VMContext, CodeGenOpts, getLangOpts(),
135                            getCXXABI().getMangleContext());
136 
137   // If debug info or coverage generation is enabled, create the CGDebugInfo
138   // object.
139   if (CodeGenOpts.getDebugInfo() != CodeGenOptions::NoDebugInfo ||
140       CodeGenOpts.EmitGcovArcs ||
141       CodeGenOpts.EmitGcovNotes)
142     DebugInfo = new CGDebugInfo(*this);
143 
144   Block.GlobalUniqueCount = 0;
145 
146   if (C.getLangOpts().ObjC1)
147     ObjCData = new ObjCEntrypoints();
148 
149   if (!CodeGenOpts.InstrProfileInput.empty()) {
150     auto ReaderOrErr =
151         llvm::IndexedInstrProfReader::create(CodeGenOpts.InstrProfileInput);
152     if (std::error_code EC = ReaderOrErr.getError()) {
153       unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
154                                               "Could not read profile %0: %1");
155       getDiags().Report(DiagID) << CodeGenOpts.InstrProfileInput
156                                 << EC.message();
157     } else
158       PGOReader = std::move(ReaderOrErr.get());
159   }
160 
161   // If coverage mapping generation is enabled, create the
162   // CoverageMappingModuleGen object.
163   if (CodeGenOpts.CoverageMapping)
164     CoverageMapping.reset(new CoverageMappingModuleGen(*this, *CoverageInfo));
165 }
166 
167 CodeGenModule::~CodeGenModule() {
168   delete ObjCRuntime;
169   delete OpenCLRuntime;
170   delete OpenMPRuntime;
171   delete CUDARuntime;
172   delete TheTargetCodeGenInfo;
173   delete TBAA;
174   delete DebugInfo;
175   delete ObjCData;
176 }
177 
178 void CodeGenModule::createObjCRuntime() {
179   // This is just isGNUFamily(), but we want to force implementors of
180   // new ABIs to decide how best to do this.
181   switch (LangOpts.ObjCRuntime.getKind()) {
182   case ObjCRuntime::GNUstep:
183   case ObjCRuntime::GCC:
184   case ObjCRuntime::ObjFW:
185     ObjCRuntime = CreateGNUObjCRuntime(*this);
186     return;
187 
188   case ObjCRuntime::FragileMacOSX:
189   case ObjCRuntime::MacOSX:
190   case ObjCRuntime::iOS:
191   case ObjCRuntime::WatchOS:
192     ObjCRuntime = CreateMacObjCRuntime(*this);
193     return;
194   }
195   llvm_unreachable("bad runtime kind");
196 }
197 
198 void CodeGenModule::createOpenCLRuntime() {
199   OpenCLRuntime = new CGOpenCLRuntime(*this);
200 }
201 
202 void CodeGenModule::createOpenMPRuntime() {
203   OpenMPRuntime = new CGOpenMPRuntime(*this);
204 }
205 
206 void CodeGenModule::createCUDARuntime() {
207   CUDARuntime = CreateNVCUDARuntime(*this);
208 }
209 
210 void CodeGenModule::addReplacement(StringRef Name, llvm::Constant *C) {
211   Replacements[Name] = C;
212 }
213 
214 void CodeGenModule::applyReplacements() {
215   for (auto &I : Replacements) {
216     StringRef MangledName = I.first();
217     llvm::Constant *Replacement = I.second;
218     llvm::GlobalValue *Entry = GetGlobalValue(MangledName);
219     if (!Entry)
220       continue;
221     auto *OldF = cast<llvm::Function>(Entry);
222     auto *NewF = dyn_cast<llvm::Function>(Replacement);
223     if (!NewF) {
224       if (auto *Alias = dyn_cast<llvm::GlobalAlias>(Replacement)) {
225         NewF = dyn_cast<llvm::Function>(Alias->getAliasee());
226       } else {
227         auto *CE = cast<llvm::ConstantExpr>(Replacement);
228         assert(CE->getOpcode() == llvm::Instruction::BitCast ||
229                CE->getOpcode() == llvm::Instruction::GetElementPtr);
230         NewF = dyn_cast<llvm::Function>(CE->getOperand(0));
231       }
232     }
233 
234     // Replace old with new, but keep the old order.
235     OldF->replaceAllUsesWith(Replacement);
236     if (NewF) {
237       NewF->removeFromParent();
238       OldF->getParent()->getFunctionList().insertAfter(OldF->getIterator(),
239                                                        NewF);
240     }
241     OldF->eraseFromParent();
242   }
243 }
244 
245 void CodeGenModule::addGlobalValReplacement(llvm::GlobalValue *GV, llvm::Constant *C) {
246   GlobalValReplacements.push_back(std::make_pair(GV, C));
247 }
248 
249 void CodeGenModule::applyGlobalValReplacements() {
250   for (auto &I : GlobalValReplacements) {
251     llvm::GlobalValue *GV = I.first;
252     llvm::Constant *C = I.second;
253 
254     GV->replaceAllUsesWith(C);
255     GV->eraseFromParent();
256   }
257 }
258 
259 // This is only used in aliases that we created and we know they have a
260 // linear structure.
261 static const llvm::GlobalObject *getAliasedGlobal(const llvm::GlobalAlias &GA) {
262   llvm::SmallPtrSet<const llvm::GlobalAlias*, 4> Visited;
263   const llvm::Constant *C = &GA;
264   for (;;) {
265     C = C->stripPointerCasts();
266     if (auto *GO = dyn_cast<llvm::GlobalObject>(C))
267       return GO;
268     // stripPointerCasts will not walk over weak aliases.
269     auto *GA2 = dyn_cast<llvm::GlobalAlias>(C);
270     if (!GA2)
271       return nullptr;
272     if (!Visited.insert(GA2).second)
273       return nullptr;
274     C = GA2->getAliasee();
275   }
276 }
277 
278 void CodeGenModule::checkAliases() {
279   // Check if the constructed aliases are well formed. It is really unfortunate
280   // that we have to do this in CodeGen, but we only construct mangled names
281   // and aliases during codegen.
282   bool Error = false;
283   DiagnosticsEngine &Diags = getDiags();
284   for (const GlobalDecl &GD : Aliases) {
285     const auto *D = cast<ValueDecl>(GD.getDecl());
286     const AliasAttr *AA = D->getAttr<AliasAttr>();
287     StringRef MangledName = getMangledName(GD);
288     llvm::GlobalValue *Entry = GetGlobalValue(MangledName);
289     auto *Alias = cast<llvm::GlobalAlias>(Entry);
290     const llvm::GlobalValue *GV = getAliasedGlobal(*Alias);
291     if (!GV) {
292       Error = true;
293       Diags.Report(AA->getLocation(), diag::err_cyclic_alias);
294     } else if (GV->isDeclaration()) {
295       Error = true;
296       Diags.Report(AA->getLocation(), diag::err_alias_to_undefined);
297     }
298 
299     llvm::Constant *Aliasee = Alias->getAliasee();
300     llvm::GlobalValue *AliaseeGV;
301     if (auto CE = dyn_cast<llvm::ConstantExpr>(Aliasee))
302       AliaseeGV = cast<llvm::GlobalValue>(CE->getOperand(0));
303     else
304       AliaseeGV = cast<llvm::GlobalValue>(Aliasee);
305 
306     if (const SectionAttr *SA = D->getAttr<SectionAttr>()) {
307       StringRef AliasSection = SA->getName();
308       if (AliasSection != AliaseeGV->getSection())
309         Diags.Report(SA->getLocation(), diag::warn_alias_with_section)
310             << AliasSection;
311     }
312 
313     // We have to handle alias to weak aliases in here. LLVM itself disallows
314     // this since the object semantics would not match the IL one. For
315     // compatibility with gcc we implement it by just pointing the alias
316     // to its aliasee's aliasee. We also warn, since the user is probably
317     // expecting the link to be weak.
318     if (auto GA = dyn_cast<llvm::GlobalAlias>(AliaseeGV)) {
319       if (GA->mayBeOverridden()) {
320         Diags.Report(AA->getLocation(), diag::warn_alias_to_weak_alias)
321             << GV->getName() << GA->getName();
322         Aliasee = llvm::ConstantExpr::getPointerBitCastOrAddrSpaceCast(
323             GA->getAliasee(), Alias->getType());
324         Alias->setAliasee(Aliasee);
325       }
326     }
327   }
328   if (!Error)
329     return;
330 
331   for (const GlobalDecl &GD : Aliases) {
332     StringRef MangledName = getMangledName(GD);
333     llvm::GlobalValue *Entry = GetGlobalValue(MangledName);
334     auto *Alias = cast<llvm::GlobalAlias>(Entry);
335     Alias->replaceAllUsesWith(llvm::UndefValue::get(Alias->getType()));
336     Alias->eraseFromParent();
337   }
338 }
339 
340 void CodeGenModule::clear() {
341   DeferredDeclsToEmit.clear();
342   if (OpenMPRuntime)
343     OpenMPRuntime->clear();
344 }
345 
346 void InstrProfStats::reportDiagnostics(DiagnosticsEngine &Diags,
347                                        StringRef MainFile) {
348   if (!hasDiagnostics())
349     return;
350   if (VisitedInMainFile > 0 && VisitedInMainFile == MissingInMainFile) {
351     if (MainFile.empty())
352       MainFile = "<stdin>";
353     Diags.Report(diag::warn_profile_data_unprofiled) << MainFile;
354   } else
355     Diags.Report(diag::warn_profile_data_out_of_date) << Visited << Missing
356                                                       << Mismatched;
357 }
358 
359 void CodeGenModule::Release() {
360   EmitDeferred();
361   applyGlobalValReplacements();
362   applyReplacements();
363   checkAliases();
364   EmitCXXGlobalInitFunc();
365   EmitCXXGlobalDtorFunc();
366   EmitCXXThreadLocalInitFunc();
367   if (ObjCRuntime)
368     if (llvm::Function *ObjCInitFunction = ObjCRuntime->ModuleInitFunction())
369       AddGlobalCtor(ObjCInitFunction);
370   if (Context.getLangOpts().CUDA && !Context.getLangOpts().CUDAIsDevice &&
371       CUDARuntime) {
372     if (llvm::Function *CudaCtorFunction = CUDARuntime->makeModuleCtorFunction())
373       AddGlobalCtor(CudaCtorFunction);
374     if (llvm::Function *CudaDtorFunction = CUDARuntime->makeModuleDtorFunction())
375       AddGlobalDtor(CudaDtorFunction);
376   }
377   if (PGOReader && PGOStats.hasDiagnostics())
378     PGOStats.reportDiagnostics(getDiags(), getCodeGenOpts().MainFileName);
379   EmitCtorList(GlobalCtors, "llvm.global_ctors");
380   EmitCtorList(GlobalDtors, "llvm.global_dtors");
381   EmitGlobalAnnotations();
382   EmitStaticExternCAliases();
383   EmitDeferredUnusedCoverageMappings();
384   if (CoverageMapping)
385     CoverageMapping->emit();
386   emitLLVMUsed();
387 
388   if (CodeGenOpts.Autolink &&
389       (Context.getLangOpts().Modules || !LinkerOptionsMetadata.empty())) {
390     EmitModuleLinkOptions();
391   }
392   if (CodeGenOpts.DwarfVersion) {
393     // We actually want the latest version when there are conflicts.
394     // We can change from Warning to Latest if such mode is supported.
395     getModule().addModuleFlag(llvm::Module::Warning, "Dwarf Version",
396                               CodeGenOpts.DwarfVersion);
397   }
398   if (CodeGenOpts.EmitCodeView) {
399     // Indicate that we want CodeView in the metadata.
400     getModule().addModuleFlag(llvm::Module::Warning, "CodeView", 1);
401   }
402   if (CodeGenOpts.OptimizationLevel > 0 && CodeGenOpts.StrictVTablePointers) {
403     // We don't support LTO with 2 with different StrictVTablePointers
404     // FIXME: we could support it by stripping all the information introduced
405     // by StrictVTablePointers.
406 
407     getModule().addModuleFlag(llvm::Module::Error, "StrictVTablePointers",1);
408 
409     llvm::Metadata *Ops[2] = {
410               llvm::MDString::get(VMContext, "StrictVTablePointers"),
411               llvm::ConstantAsMetadata::get(llvm::ConstantInt::get(
412                   llvm::Type::getInt32Ty(VMContext), 1))};
413 
414     getModule().addModuleFlag(llvm::Module::Require,
415                               "StrictVTablePointersRequirement",
416                               llvm::MDNode::get(VMContext, Ops));
417   }
418   if (DebugInfo)
419     // We support a single version in the linked module. The LLVM
420     // parser will drop debug info with a different version number
421     // (and warn about it, too).
422     getModule().addModuleFlag(llvm::Module::Warning, "Debug Info Version",
423                               llvm::DEBUG_METADATA_VERSION);
424 
425   // We need to record the widths of enums and wchar_t, so that we can generate
426   // the correct build attributes in the ARM backend.
427   llvm::Triple::ArchType Arch = Context.getTargetInfo().getTriple().getArch();
428   if (   Arch == llvm::Triple::arm
429       || Arch == llvm::Triple::armeb
430       || Arch == llvm::Triple::thumb
431       || Arch == llvm::Triple::thumbeb) {
432     // Width of wchar_t in bytes
433     uint64_t WCharWidth =
434         Context.getTypeSizeInChars(Context.getWideCharType()).getQuantity();
435     getModule().addModuleFlag(llvm::Module::Error, "wchar_size", WCharWidth);
436 
437     // The minimum width of an enum in bytes
438     uint64_t EnumWidth = Context.getLangOpts().ShortEnums ? 1 : 4;
439     getModule().addModuleFlag(llvm::Module::Error, "min_enum_size", EnumWidth);
440   }
441 
442   if (uint32_t PLevel = Context.getLangOpts().PICLevel) {
443     llvm::PICLevel::Level PL = llvm::PICLevel::Default;
444     switch (PLevel) {
445     case 0: break;
446     case 1: PL = llvm::PICLevel::Small; break;
447     case 2: PL = llvm::PICLevel::Large; break;
448     default: llvm_unreachable("Invalid PIC Level");
449     }
450 
451     getModule().setPICLevel(PL);
452   }
453 
454   SimplifyPersonality();
455 
456   if (getCodeGenOpts().EmitDeclMetadata)
457     EmitDeclMetadata();
458 
459   if (getCodeGenOpts().EmitGcovArcs || getCodeGenOpts().EmitGcovNotes)
460     EmitCoverageFile();
461 
462   if (DebugInfo)
463     DebugInfo->finalize();
464 
465   EmitVersionIdentMetadata();
466 
467   EmitTargetMetadata();
468 }
469 
470 void CodeGenModule::UpdateCompletedType(const TagDecl *TD) {
471   // Make sure that this type is translated.
472   Types.UpdateCompletedType(TD);
473 }
474 
475 llvm::MDNode *CodeGenModule::getTBAAInfo(QualType QTy) {
476   if (!TBAA)
477     return nullptr;
478   return TBAA->getTBAAInfo(QTy);
479 }
480 
481 llvm::MDNode *CodeGenModule::getTBAAInfoForVTablePtr() {
482   if (!TBAA)
483     return nullptr;
484   return TBAA->getTBAAInfoForVTablePtr();
485 }
486 
487 llvm::MDNode *CodeGenModule::getTBAAStructInfo(QualType QTy) {
488   if (!TBAA)
489     return nullptr;
490   return TBAA->getTBAAStructInfo(QTy);
491 }
492 
493 llvm::MDNode *CodeGenModule::getTBAAStructTagInfo(QualType BaseTy,
494                                                   llvm::MDNode *AccessN,
495                                                   uint64_t O) {
496   if (!TBAA)
497     return nullptr;
498   return TBAA->getTBAAStructTagInfo(BaseTy, AccessN, O);
499 }
500 
501 /// Decorate the instruction with a TBAA tag. For both scalar TBAA
502 /// and struct-path aware TBAA, the tag has the same format:
503 /// base type, access type and offset.
504 /// When ConvertTypeToTag is true, we create a tag based on the scalar type.
505 void CodeGenModule::DecorateInstructionWithTBAA(llvm::Instruction *Inst,
506                                                 llvm::MDNode *TBAAInfo,
507                                                 bool ConvertTypeToTag) {
508   if (ConvertTypeToTag && TBAA)
509     Inst->setMetadata(llvm::LLVMContext::MD_tbaa,
510                       TBAA->getTBAAScalarTagInfo(TBAAInfo));
511   else
512     Inst->setMetadata(llvm::LLVMContext::MD_tbaa, TBAAInfo);
513 }
514 
515 void CodeGenModule::DecorateInstructionWithInvariantGroup(
516     llvm::Instruction *I, const CXXRecordDecl *RD) {
517   llvm::Metadata *MD = CreateMetadataIdentifierForType(QualType(RD->getTypeForDecl(), 0));
518   auto *MetaDataNode = dyn_cast<llvm::MDNode>(MD);
519   // Check if we have to wrap MDString in MDNode.
520   if (!MetaDataNode)
521     MetaDataNode = llvm::MDNode::get(getLLVMContext(), MD);
522   I->setMetadata(llvm::LLVMContext::MD_invariant_group, MetaDataNode);
523 }
524 
525 void CodeGenModule::Error(SourceLocation loc, StringRef message) {
526   unsigned diagID = getDiags().getCustomDiagID(DiagnosticsEngine::Error, "%0");
527   getDiags().Report(Context.getFullLoc(loc), diagID) << message;
528 }
529 
530 /// ErrorUnsupported - Print out an error that codegen doesn't support the
531 /// specified stmt yet.
532 void CodeGenModule::ErrorUnsupported(const Stmt *S, const char *Type) {
533   unsigned DiagID = getDiags().getCustomDiagID(DiagnosticsEngine::Error,
534                                                "cannot compile this %0 yet");
535   std::string Msg = Type;
536   getDiags().Report(Context.getFullLoc(S->getLocStart()), DiagID)
537     << Msg << S->getSourceRange();
538 }
539 
540 /// ErrorUnsupported - Print out an error that codegen doesn't support the
541 /// specified decl yet.
542 void CodeGenModule::ErrorUnsupported(const Decl *D, const char *Type) {
543   unsigned DiagID = getDiags().getCustomDiagID(DiagnosticsEngine::Error,
544                                                "cannot compile this %0 yet");
545   std::string Msg = Type;
546   getDiags().Report(Context.getFullLoc(D->getLocation()), DiagID) << Msg;
547 }
548 
549 llvm::ConstantInt *CodeGenModule::getSize(CharUnits size) {
550   return llvm::ConstantInt::get(SizeTy, size.getQuantity());
551 }
552 
553 void CodeGenModule::setGlobalVisibility(llvm::GlobalValue *GV,
554                                         const NamedDecl *D) const {
555   // Internal definitions always have default visibility.
556   if (GV->hasLocalLinkage()) {
557     GV->setVisibility(llvm::GlobalValue::DefaultVisibility);
558     return;
559   }
560 
561   // Set visibility for definitions.
562   LinkageInfo LV = D->getLinkageAndVisibility();
563   if (LV.isVisibilityExplicit() || !GV->hasAvailableExternallyLinkage())
564     GV->setVisibility(GetLLVMVisibility(LV.getVisibility()));
565 }
566 
567 static llvm::GlobalVariable::ThreadLocalMode GetLLVMTLSModel(StringRef S) {
568   return llvm::StringSwitch<llvm::GlobalVariable::ThreadLocalMode>(S)
569       .Case("global-dynamic", llvm::GlobalVariable::GeneralDynamicTLSModel)
570       .Case("local-dynamic", llvm::GlobalVariable::LocalDynamicTLSModel)
571       .Case("initial-exec", llvm::GlobalVariable::InitialExecTLSModel)
572       .Case("local-exec", llvm::GlobalVariable::LocalExecTLSModel);
573 }
574 
575 static llvm::GlobalVariable::ThreadLocalMode GetLLVMTLSModel(
576     CodeGenOptions::TLSModel M) {
577   switch (M) {
578   case CodeGenOptions::GeneralDynamicTLSModel:
579     return llvm::GlobalVariable::GeneralDynamicTLSModel;
580   case CodeGenOptions::LocalDynamicTLSModel:
581     return llvm::GlobalVariable::LocalDynamicTLSModel;
582   case CodeGenOptions::InitialExecTLSModel:
583     return llvm::GlobalVariable::InitialExecTLSModel;
584   case CodeGenOptions::LocalExecTLSModel:
585     return llvm::GlobalVariable::LocalExecTLSModel;
586   }
587   llvm_unreachable("Invalid TLS model!");
588 }
589 
590 void CodeGenModule::setTLSMode(llvm::GlobalValue *GV, const VarDecl &D) const {
591   assert(D.getTLSKind() && "setting TLS mode on non-TLS var!");
592 
593   llvm::GlobalValue::ThreadLocalMode TLM;
594   TLM = GetLLVMTLSModel(CodeGenOpts.getDefaultTLSModel());
595 
596   // Override the TLS model if it is explicitly specified.
597   if (const TLSModelAttr *Attr = D.getAttr<TLSModelAttr>()) {
598     TLM = GetLLVMTLSModel(Attr->getModel());
599   }
600 
601   GV->setThreadLocalMode(TLM);
602 }
603 
604 StringRef CodeGenModule::getMangledName(GlobalDecl GD) {
605   StringRef &FoundStr = MangledDeclNames[GD.getCanonicalDecl()];
606   if (!FoundStr.empty())
607     return FoundStr;
608 
609   const auto *ND = cast<NamedDecl>(GD.getDecl());
610   SmallString<256> Buffer;
611   StringRef Str;
612   if (getCXXABI().getMangleContext().shouldMangleDeclName(ND)) {
613     llvm::raw_svector_ostream Out(Buffer);
614     if (const auto *D = dyn_cast<CXXConstructorDecl>(ND))
615       getCXXABI().getMangleContext().mangleCXXCtor(D, GD.getCtorType(), Out);
616     else if (const auto *D = dyn_cast<CXXDestructorDecl>(ND))
617       getCXXABI().getMangleContext().mangleCXXDtor(D, GD.getDtorType(), Out);
618     else
619       getCXXABI().getMangleContext().mangleName(ND, Out);
620     Str = Out.str();
621   } else {
622     IdentifierInfo *II = ND->getIdentifier();
623     assert(II && "Attempt to mangle unnamed decl.");
624     Str = II->getName();
625   }
626 
627   // Keep the first result in the case of a mangling collision.
628   auto Result = Manglings.insert(std::make_pair(Str, GD));
629   return FoundStr = Result.first->first();
630 }
631 
632 StringRef CodeGenModule::getBlockMangledName(GlobalDecl GD,
633                                              const BlockDecl *BD) {
634   MangleContext &MangleCtx = getCXXABI().getMangleContext();
635   const Decl *D = GD.getDecl();
636 
637   SmallString<256> Buffer;
638   llvm::raw_svector_ostream Out(Buffer);
639   if (!D)
640     MangleCtx.mangleGlobalBlock(BD,
641       dyn_cast_or_null<VarDecl>(initializedGlobalDecl.getDecl()), Out);
642   else if (const auto *CD = dyn_cast<CXXConstructorDecl>(D))
643     MangleCtx.mangleCtorBlock(CD, GD.getCtorType(), BD, Out);
644   else if (const auto *DD = dyn_cast<CXXDestructorDecl>(D))
645     MangleCtx.mangleDtorBlock(DD, GD.getDtorType(), BD, Out);
646   else
647     MangleCtx.mangleBlock(cast<DeclContext>(D), BD, Out);
648 
649   auto Result = Manglings.insert(std::make_pair(Out.str(), BD));
650   return Result.first->first();
651 }
652 
653 llvm::GlobalValue *CodeGenModule::GetGlobalValue(StringRef Name) {
654   return getModule().getNamedValue(Name);
655 }
656 
657 /// AddGlobalCtor - Add a function to the list that will be called before
658 /// main() runs.
659 void CodeGenModule::AddGlobalCtor(llvm::Function *Ctor, int Priority,
660                                   llvm::Constant *AssociatedData) {
661   // FIXME: Type coercion of void()* types.
662   GlobalCtors.push_back(Structor(Priority, Ctor, AssociatedData));
663 }
664 
665 /// AddGlobalDtor - Add a function to the list that will be called
666 /// when the module is unloaded.
667 void CodeGenModule::AddGlobalDtor(llvm::Function *Dtor, int Priority) {
668   // FIXME: Type coercion of void()* types.
669   GlobalDtors.push_back(Structor(Priority, Dtor, nullptr));
670 }
671 
672 void CodeGenModule::EmitCtorList(const CtorList &Fns, const char *GlobalName) {
673   // Ctor function type is void()*.
674   llvm::FunctionType* CtorFTy = llvm::FunctionType::get(VoidTy, false);
675   llvm::Type *CtorPFTy = llvm::PointerType::getUnqual(CtorFTy);
676 
677   // Get the type of a ctor entry, { i32, void ()*, i8* }.
678   llvm::StructType *CtorStructTy = llvm::StructType::get(
679       Int32Ty, llvm::PointerType::getUnqual(CtorFTy), VoidPtrTy, nullptr);
680 
681   // Construct the constructor and destructor arrays.
682   SmallVector<llvm::Constant *, 8> Ctors;
683   for (const auto &I : Fns) {
684     llvm::Constant *S[] = {
685         llvm::ConstantInt::get(Int32Ty, I.Priority, false),
686         llvm::ConstantExpr::getBitCast(I.Initializer, CtorPFTy),
687         (I.AssociatedData
688              ? llvm::ConstantExpr::getBitCast(I.AssociatedData, VoidPtrTy)
689              : llvm::Constant::getNullValue(VoidPtrTy))};
690     Ctors.push_back(llvm::ConstantStruct::get(CtorStructTy, S));
691   }
692 
693   if (!Ctors.empty()) {
694     llvm::ArrayType *AT = llvm::ArrayType::get(CtorStructTy, Ctors.size());
695     new llvm::GlobalVariable(TheModule, AT, false,
696                              llvm::GlobalValue::AppendingLinkage,
697                              llvm::ConstantArray::get(AT, Ctors),
698                              GlobalName);
699   }
700 }
701 
702 llvm::GlobalValue::LinkageTypes
703 CodeGenModule::getFunctionLinkage(GlobalDecl GD) {
704   const auto *D = cast<FunctionDecl>(GD.getDecl());
705 
706   GVALinkage Linkage = getContext().GetGVALinkageForFunction(D);
707 
708   if (isa<CXXDestructorDecl>(D) &&
709       getCXXABI().useThunkForDtorVariant(cast<CXXDestructorDecl>(D),
710                                          GD.getDtorType())) {
711     // Destructor variants in the Microsoft C++ ABI are always internal or
712     // linkonce_odr thunks emitted on an as-needed basis.
713     return Linkage == GVA_Internal ? llvm::GlobalValue::InternalLinkage
714                                    : llvm::GlobalValue::LinkOnceODRLinkage;
715   }
716 
717   return getLLVMLinkageForDeclarator(D, Linkage, /*isConstantVariable=*/false);
718 }
719 
720 void CodeGenModule::setFunctionDLLStorageClass(GlobalDecl GD, llvm::Function *F) {
721   const auto *FD = cast<FunctionDecl>(GD.getDecl());
722 
723   if (const auto *Dtor = dyn_cast_or_null<CXXDestructorDecl>(FD)) {
724     if (getCXXABI().useThunkForDtorVariant(Dtor, GD.getDtorType())) {
725       // Don't dllexport/import destructor thunks.
726       F->setDLLStorageClass(llvm::GlobalValue::DefaultStorageClass);
727       return;
728     }
729   }
730 
731   if (FD->hasAttr<DLLImportAttr>())
732     F->setDLLStorageClass(llvm::GlobalVariable::DLLImportStorageClass);
733   else if (FD->hasAttr<DLLExportAttr>())
734     F->setDLLStorageClass(llvm::GlobalVariable::DLLExportStorageClass);
735   else
736     F->setDLLStorageClass(llvm::GlobalVariable::DefaultStorageClass);
737 }
738 
739 void CodeGenModule::setFunctionDefinitionAttributes(const FunctionDecl *D,
740                                                     llvm::Function *F) {
741   setNonAliasAttributes(D, F);
742 }
743 
744 void CodeGenModule::SetLLVMFunctionAttributes(const Decl *D,
745                                               const CGFunctionInfo &Info,
746                                               llvm::Function *F) {
747   unsigned CallingConv;
748   AttributeListType AttributeList;
749   ConstructAttributeList(Info, D, AttributeList, CallingConv, false);
750   F->setAttributes(llvm::AttributeSet::get(getLLVMContext(), AttributeList));
751   F->setCallingConv(static_cast<llvm::CallingConv::ID>(CallingConv));
752 }
753 
754 /// Determines whether the language options require us to model
755 /// unwind exceptions.  We treat -fexceptions as mandating this
756 /// except under the fragile ObjC ABI with only ObjC exceptions
757 /// enabled.  This means, for example, that C with -fexceptions
758 /// enables this.
759 static bool hasUnwindExceptions(const LangOptions &LangOpts) {
760   // If exceptions are completely disabled, obviously this is false.
761   if (!LangOpts.Exceptions) return false;
762 
763   // If C++ exceptions are enabled, this is true.
764   if (LangOpts.CXXExceptions) return true;
765 
766   // If ObjC exceptions are enabled, this depends on the ABI.
767   if (LangOpts.ObjCExceptions) {
768     return LangOpts.ObjCRuntime.hasUnwindExceptions();
769   }
770 
771   return true;
772 }
773 
774 void CodeGenModule::SetLLVMFunctionAttributesForDefinition(const Decl *D,
775                                                            llvm::Function *F) {
776   llvm::AttrBuilder B;
777 
778   if (CodeGenOpts.UnwindTables)
779     B.addAttribute(llvm::Attribute::UWTable);
780 
781   if (!hasUnwindExceptions(LangOpts))
782     B.addAttribute(llvm::Attribute::NoUnwind);
783 
784   if (LangOpts.getStackProtector() == LangOptions::SSPOn)
785     B.addAttribute(llvm::Attribute::StackProtect);
786   else if (LangOpts.getStackProtector() == LangOptions::SSPStrong)
787     B.addAttribute(llvm::Attribute::StackProtectStrong);
788   else if (LangOpts.getStackProtector() == LangOptions::SSPReq)
789     B.addAttribute(llvm::Attribute::StackProtectReq);
790 
791   if (!D) {
792     F->addAttributes(llvm::AttributeSet::FunctionIndex,
793                      llvm::AttributeSet::get(
794                          F->getContext(),
795                          llvm::AttributeSet::FunctionIndex, B));
796     return;
797   }
798 
799   if (D->hasAttr<NakedAttr>()) {
800     // Naked implies noinline: we should not be inlining such functions.
801     B.addAttribute(llvm::Attribute::Naked);
802     B.addAttribute(llvm::Attribute::NoInline);
803   } else if (D->hasAttr<NoDuplicateAttr>()) {
804     B.addAttribute(llvm::Attribute::NoDuplicate);
805   } else if (D->hasAttr<NoInlineAttr>()) {
806     B.addAttribute(llvm::Attribute::NoInline);
807   } else if (D->hasAttr<AlwaysInlineAttr>() &&
808              !F->getAttributes().hasAttribute(llvm::AttributeSet::FunctionIndex,
809                                               llvm::Attribute::NoInline)) {
810     // (noinline wins over always_inline, and we can't specify both in IR)
811     B.addAttribute(llvm::Attribute::AlwaysInline);
812   }
813 
814   if (D->hasAttr<ColdAttr>()) {
815     if (!D->hasAttr<OptimizeNoneAttr>())
816       B.addAttribute(llvm::Attribute::OptimizeForSize);
817     B.addAttribute(llvm::Attribute::Cold);
818   }
819 
820   if (D->hasAttr<MinSizeAttr>())
821     B.addAttribute(llvm::Attribute::MinSize);
822 
823   F->addAttributes(llvm::AttributeSet::FunctionIndex,
824                    llvm::AttributeSet::get(
825                        F->getContext(), llvm::AttributeSet::FunctionIndex, B));
826 
827   if (D->hasAttr<OptimizeNoneAttr>()) {
828     // OptimizeNone implies noinline; we should not be inlining such functions.
829     F->addFnAttr(llvm::Attribute::OptimizeNone);
830     F->addFnAttr(llvm::Attribute::NoInline);
831 
832     // OptimizeNone wins over OptimizeForSize, MinSize, AlwaysInline.
833     F->removeFnAttr(llvm::Attribute::OptimizeForSize);
834     F->removeFnAttr(llvm::Attribute::MinSize);
835     assert(!F->hasFnAttribute(llvm::Attribute::AlwaysInline) &&
836            "OptimizeNone and AlwaysInline on same function!");
837 
838     // Attribute 'inlinehint' has no effect on 'optnone' functions.
839     // Explicitly remove it from the set of function attributes.
840     F->removeFnAttr(llvm::Attribute::InlineHint);
841   }
842 
843   if (isa<CXXConstructorDecl>(D) || isa<CXXDestructorDecl>(D))
844     F->setUnnamedAddr(true);
845   else if (const auto *MD = dyn_cast<CXXMethodDecl>(D))
846     if (MD->isVirtual())
847       F->setUnnamedAddr(true);
848 
849   unsigned alignment = D->getMaxAlignment() / Context.getCharWidth();
850   if (alignment)
851     F->setAlignment(alignment);
852 
853   // Some C++ ABIs require 2-byte alignment for member functions, in order to
854   // reserve a bit for differentiating between virtual and non-virtual member
855   // functions. If the current target's C++ ABI requires this and this is a
856   // member function, set its alignment accordingly.
857   if (getTarget().getCXXABI().areMemberFunctionsAligned()) {
858     if (F->getAlignment() < 2 && isa<CXXMethodDecl>(D))
859       F->setAlignment(2);
860   }
861 }
862 
863 void CodeGenModule::SetCommonAttributes(const Decl *D,
864                                         llvm::GlobalValue *GV) {
865   if (const auto *ND = dyn_cast_or_null<NamedDecl>(D))
866     setGlobalVisibility(GV, ND);
867   else
868     GV->setVisibility(llvm::GlobalValue::DefaultVisibility);
869 
870   if (D && D->hasAttr<UsedAttr>())
871     addUsedGlobal(GV);
872 }
873 
874 void CodeGenModule::setAliasAttributes(const Decl *D,
875                                        llvm::GlobalValue *GV) {
876   SetCommonAttributes(D, GV);
877 
878   // Process the dllexport attribute based on whether the original definition
879   // (not necessarily the aliasee) was exported.
880   if (D->hasAttr<DLLExportAttr>())
881     GV->setDLLStorageClass(llvm::GlobalValue::DLLExportStorageClass);
882 }
883 
884 void CodeGenModule::setNonAliasAttributes(const Decl *D,
885                                           llvm::GlobalObject *GO) {
886   SetCommonAttributes(D, GO);
887 
888   if (D)
889     if (const SectionAttr *SA = D->getAttr<SectionAttr>())
890       GO->setSection(SA->getName());
891 
892   getTargetCodeGenInfo().setTargetAttributes(D, GO, *this);
893 }
894 
895 void CodeGenModule::SetInternalFunctionAttributes(const Decl *D,
896                                                   llvm::Function *F,
897                                                   const CGFunctionInfo &FI) {
898   SetLLVMFunctionAttributes(D, FI, F);
899   SetLLVMFunctionAttributesForDefinition(D, F);
900 
901   F->setLinkage(llvm::Function::InternalLinkage);
902 
903   setNonAliasAttributes(D, F);
904 }
905 
906 static void setLinkageAndVisibilityForGV(llvm::GlobalValue *GV,
907                                          const NamedDecl *ND) {
908   // Set linkage and visibility in case we never see a definition.
909   LinkageInfo LV = ND->getLinkageAndVisibility();
910   if (LV.getLinkage() != ExternalLinkage) {
911     // Don't set internal linkage on declarations.
912   } else {
913     if (ND->hasAttr<DLLImportAttr>()) {
914       GV->setLinkage(llvm::GlobalValue::ExternalLinkage);
915       GV->setDLLStorageClass(llvm::GlobalValue::DLLImportStorageClass);
916     } else if (ND->hasAttr<DLLExportAttr>()) {
917       GV->setLinkage(llvm::GlobalValue::ExternalLinkage);
918       GV->setDLLStorageClass(llvm::GlobalValue::DLLExportStorageClass);
919     } else if (ND->hasAttr<WeakAttr>() || ND->isWeakImported()) {
920       // "extern_weak" is overloaded in LLVM; we probably should have
921       // separate linkage types for this.
922       GV->setLinkage(llvm::GlobalValue::ExternalWeakLinkage);
923     }
924 
925     // Set visibility on a declaration only if it's explicit.
926     if (LV.isVisibilityExplicit())
927       GV->setVisibility(CodeGenModule::GetLLVMVisibility(LV.getVisibility()));
928   }
929 }
930 
931 void CodeGenModule::SetFunctionAttributes(GlobalDecl GD, llvm::Function *F,
932                                           bool IsIncompleteFunction,
933                                           bool IsThunk) {
934   if (llvm::Intrinsic::ID IID = F->getIntrinsicID()) {
935     // If this is an intrinsic function, set the function's attributes
936     // to the intrinsic's attributes.
937     F->setAttributes(llvm::Intrinsic::getAttributes(getLLVMContext(), IID));
938     return;
939   }
940 
941   const auto *FD = cast<FunctionDecl>(GD.getDecl());
942 
943   if (!IsIncompleteFunction)
944     SetLLVMFunctionAttributes(FD, getTypes().arrangeGlobalDeclaration(GD), F);
945 
946   // Add the Returned attribute for "this", except for iOS 5 and earlier
947   // where substantial code, including the libstdc++ dylib, was compiled with
948   // GCC and does not actually return "this".
949   if (!IsThunk && getCXXABI().HasThisReturn(GD) &&
950       !(getTarget().getTriple().isiOS() &&
951         getTarget().getTriple().isOSVersionLT(6))) {
952     assert(!F->arg_empty() &&
953            F->arg_begin()->getType()
954              ->canLosslesslyBitCastTo(F->getReturnType()) &&
955            "unexpected this return");
956     F->addAttribute(1, llvm::Attribute::Returned);
957   }
958 
959   // Only a few attributes are set on declarations; these may later be
960   // overridden by a definition.
961 
962   setLinkageAndVisibilityForGV(F, FD);
963 
964   if (const SectionAttr *SA = FD->getAttr<SectionAttr>())
965     F->setSection(SA->getName());
966 
967   // A replaceable global allocation function does not act like a builtin by
968   // default, only if it is invoked by a new-expression or delete-expression.
969   if (FD->isReplaceableGlobalAllocationFunction())
970     F->addAttribute(llvm::AttributeSet::FunctionIndex,
971                     llvm::Attribute::NoBuiltin);
972 
973   // If we are checking indirect calls and this is not a non-static member
974   // function, emit a bit set entry for the function type.
975   if (LangOpts.Sanitize.has(SanitizerKind::CFIICall) &&
976       !(isa<CXXMethodDecl>(FD) && !cast<CXXMethodDecl>(FD)->isStatic())) {
977     llvm::NamedMDNode *BitsetsMD =
978         getModule().getOrInsertNamedMetadata("llvm.bitsets");
979 
980     llvm::Metadata *BitsetOps[] = {
981         CreateMetadataIdentifierForType(FD->getType()),
982         llvm::ConstantAsMetadata::get(F),
983         llvm::ConstantAsMetadata::get(llvm::ConstantInt::get(Int64Ty, 0))};
984     BitsetsMD->addOperand(llvm::MDTuple::get(getLLVMContext(), BitsetOps));
985   }
986 }
987 
988 void CodeGenModule::addUsedGlobal(llvm::GlobalValue *GV) {
989   assert(!GV->isDeclaration() &&
990          "Only globals with definition can force usage.");
991   LLVMUsed.emplace_back(GV);
992 }
993 
994 void CodeGenModule::addCompilerUsedGlobal(llvm::GlobalValue *GV) {
995   assert(!GV->isDeclaration() &&
996          "Only globals with definition can force usage.");
997   LLVMCompilerUsed.emplace_back(GV);
998 }
999 
1000 static void emitUsed(CodeGenModule &CGM, StringRef Name,
1001                      std::vector<llvm::WeakVH> &List) {
1002   // Don't create llvm.used if there is no need.
1003   if (List.empty())
1004     return;
1005 
1006   // Convert List to what ConstantArray needs.
1007   SmallVector<llvm::Constant*, 8> UsedArray;
1008   UsedArray.resize(List.size());
1009   for (unsigned i = 0, e = List.size(); i != e; ++i) {
1010     UsedArray[i] =
1011         llvm::ConstantExpr::getPointerBitCastOrAddrSpaceCast(
1012             cast<llvm::Constant>(&*List[i]), CGM.Int8PtrTy);
1013   }
1014 
1015   if (UsedArray.empty())
1016     return;
1017   llvm::ArrayType *ATy = llvm::ArrayType::get(CGM.Int8PtrTy, UsedArray.size());
1018 
1019   auto *GV = new llvm::GlobalVariable(
1020       CGM.getModule(), ATy, false, llvm::GlobalValue::AppendingLinkage,
1021       llvm::ConstantArray::get(ATy, UsedArray), Name);
1022 
1023   GV->setSection("llvm.metadata");
1024 }
1025 
1026 void CodeGenModule::emitLLVMUsed() {
1027   emitUsed(*this, "llvm.used", LLVMUsed);
1028   emitUsed(*this, "llvm.compiler.used", LLVMCompilerUsed);
1029 }
1030 
1031 void CodeGenModule::AppendLinkerOptions(StringRef Opts) {
1032   auto *MDOpts = llvm::MDString::get(getLLVMContext(), Opts);
1033   LinkerOptionsMetadata.push_back(llvm::MDNode::get(getLLVMContext(), MDOpts));
1034 }
1035 
1036 void CodeGenModule::AddDetectMismatch(StringRef Name, StringRef Value) {
1037   llvm::SmallString<32> Opt;
1038   getTargetCodeGenInfo().getDetectMismatchOption(Name, Value, Opt);
1039   auto *MDOpts = llvm::MDString::get(getLLVMContext(), Opt);
1040   LinkerOptionsMetadata.push_back(llvm::MDNode::get(getLLVMContext(), MDOpts));
1041 }
1042 
1043 void CodeGenModule::AddDependentLib(StringRef Lib) {
1044   llvm::SmallString<24> Opt;
1045   getTargetCodeGenInfo().getDependentLibraryOption(Lib, Opt);
1046   auto *MDOpts = llvm::MDString::get(getLLVMContext(), Opt);
1047   LinkerOptionsMetadata.push_back(llvm::MDNode::get(getLLVMContext(), MDOpts));
1048 }
1049 
1050 /// \brief Add link options implied by the given module, including modules
1051 /// it depends on, using a postorder walk.
1052 static void addLinkOptionsPostorder(CodeGenModule &CGM, Module *Mod,
1053                                     SmallVectorImpl<llvm::Metadata *> &Metadata,
1054                                     llvm::SmallPtrSet<Module *, 16> &Visited) {
1055   // Import this module's parent.
1056   if (Mod->Parent && Visited.insert(Mod->Parent).second) {
1057     addLinkOptionsPostorder(CGM, Mod->Parent, Metadata, Visited);
1058   }
1059 
1060   // Import this module's dependencies.
1061   for (unsigned I = Mod->Imports.size(); I > 0; --I) {
1062     if (Visited.insert(Mod->Imports[I - 1]).second)
1063       addLinkOptionsPostorder(CGM, Mod->Imports[I-1], Metadata, Visited);
1064   }
1065 
1066   // Add linker options to link against the libraries/frameworks
1067   // described by this module.
1068   llvm::LLVMContext &Context = CGM.getLLVMContext();
1069   for (unsigned I = Mod->LinkLibraries.size(); I > 0; --I) {
1070     // Link against a framework.  Frameworks are currently Darwin only, so we
1071     // don't to ask TargetCodeGenInfo for the spelling of the linker option.
1072     if (Mod->LinkLibraries[I-1].IsFramework) {
1073       llvm::Metadata *Args[2] = {
1074           llvm::MDString::get(Context, "-framework"),
1075           llvm::MDString::get(Context, Mod->LinkLibraries[I - 1].Library)};
1076 
1077       Metadata.push_back(llvm::MDNode::get(Context, Args));
1078       continue;
1079     }
1080 
1081     // Link against a library.
1082     llvm::SmallString<24> Opt;
1083     CGM.getTargetCodeGenInfo().getDependentLibraryOption(
1084       Mod->LinkLibraries[I-1].Library, Opt);
1085     auto *OptString = llvm::MDString::get(Context, Opt);
1086     Metadata.push_back(llvm::MDNode::get(Context, OptString));
1087   }
1088 }
1089 
1090 void CodeGenModule::EmitModuleLinkOptions() {
1091   // Collect the set of all of the modules we want to visit to emit link
1092   // options, which is essentially the imported modules and all of their
1093   // non-explicit child modules.
1094   llvm::SetVector<clang::Module *> LinkModules;
1095   llvm::SmallPtrSet<clang::Module *, 16> Visited;
1096   SmallVector<clang::Module *, 16> Stack;
1097 
1098   // Seed the stack with imported modules.
1099   for (Module *M : ImportedModules)
1100     if (Visited.insert(M).second)
1101       Stack.push_back(M);
1102 
1103   // Find all of the modules to import, making a little effort to prune
1104   // non-leaf modules.
1105   while (!Stack.empty()) {
1106     clang::Module *Mod = Stack.pop_back_val();
1107 
1108     bool AnyChildren = false;
1109 
1110     // Visit the submodules of this module.
1111     for (clang::Module::submodule_iterator Sub = Mod->submodule_begin(),
1112                                         SubEnd = Mod->submodule_end();
1113          Sub != SubEnd; ++Sub) {
1114       // Skip explicit children; they need to be explicitly imported to be
1115       // linked against.
1116       if ((*Sub)->IsExplicit)
1117         continue;
1118 
1119       if (Visited.insert(*Sub).second) {
1120         Stack.push_back(*Sub);
1121         AnyChildren = true;
1122       }
1123     }
1124 
1125     // We didn't find any children, so add this module to the list of
1126     // modules to link against.
1127     if (!AnyChildren) {
1128       LinkModules.insert(Mod);
1129     }
1130   }
1131 
1132   // Add link options for all of the imported modules in reverse topological
1133   // order.  We don't do anything to try to order import link flags with respect
1134   // to linker options inserted by things like #pragma comment().
1135   SmallVector<llvm::Metadata *, 16> MetadataArgs;
1136   Visited.clear();
1137   for (Module *M : LinkModules)
1138     if (Visited.insert(M).second)
1139       addLinkOptionsPostorder(*this, M, MetadataArgs, Visited);
1140   std::reverse(MetadataArgs.begin(), MetadataArgs.end());
1141   LinkerOptionsMetadata.append(MetadataArgs.begin(), MetadataArgs.end());
1142 
1143   // Add the linker options metadata flag.
1144   getModule().addModuleFlag(llvm::Module::AppendUnique, "Linker Options",
1145                             llvm::MDNode::get(getLLVMContext(),
1146                                               LinkerOptionsMetadata));
1147 }
1148 
1149 void CodeGenModule::EmitDeferred() {
1150   // Emit code for any potentially referenced deferred decls.  Since a
1151   // previously unused static decl may become used during the generation of code
1152   // for a static function, iterate until no changes are made.
1153 
1154   if (!DeferredVTables.empty()) {
1155     EmitDeferredVTables();
1156 
1157     // Emitting a v-table doesn't directly cause more v-tables to
1158     // become deferred, although it can cause functions to be
1159     // emitted that then need those v-tables.
1160     assert(DeferredVTables.empty());
1161   }
1162 
1163   // Stop if we're out of both deferred v-tables and deferred declarations.
1164   if (DeferredDeclsToEmit.empty())
1165     return;
1166 
1167   // Grab the list of decls to emit. If EmitGlobalDefinition schedules more
1168   // work, it will not interfere with this.
1169   std::vector<DeferredGlobal> CurDeclsToEmit;
1170   CurDeclsToEmit.swap(DeferredDeclsToEmit);
1171 
1172   for (DeferredGlobal &G : CurDeclsToEmit) {
1173     GlobalDecl D = G.GD;
1174     llvm::GlobalValue *GV = G.GV;
1175     G.GV = nullptr;
1176 
1177     // We should call GetAddrOfGlobal with IsForDefinition set to true in order
1178     // to get GlobalValue with exactly the type we need, not something that
1179     // might had been created for another decl with the same mangled name but
1180     // different type.
1181     // FIXME: Support for variables is not implemented yet.
1182     if (isa<FunctionDecl>(D.getDecl()))
1183       GV = cast<llvm::GlobalValue>(GetAddrOfGlobal(D, /*IsForDefinition=*/true));
1184     else
1185       if (!GV)
1186         GV = GetGlobalValue(getMangledName(D));
1187 
1188     // Check to see if we've already emitted this.  This is necessary
1189     // for a couple of reasons: first, decls can end up in the
1190     // deferred-decls queue multiple times, and second, decls can end
1191     // up with definitions in unusual ways (e.g. by an extern inline
1192     // function acquiring a strong function redefinition).  Just
1193     // ignore these cases.
1194     if (GV && !GV->isDeclaration())
1195       continue;
1196 
1197     // Otherwise, emit the definition and move on to the next one.
1198     EmitGlobalDefinition(D, GV);
1199 
1200     // If we found out that we need to emit more decls, do that recursively.
1201     // This has the advantage that the decls are emitted in a DFS and related
1202     // ones are close together, which is convenient for testing.
1203     if (!DeferredVTables.empty() || !DeferredDeclsToEmit.empty()) {
1204       EmitDeferred();
1205       assert(DeferredVTables.empty() && DeferredDeclsToEmit.empty());
1206     }
1207   }
1208 }
1209 
1210 void CodeGenModule::EmitGlobalAnnotations() {
1211   if (Annotations.empty())
1212     return;
1213 
1214   // Create a new global variable for the ConstantStruct in the Module.
1215   llvm::Constant *Array = llvm::ConstantArray::get(llvm::ArrayType::get(
1216     Annotations[0]->getType(), Annotations.size()), Annotations);
1217   auto *gv = new llvm::GlobalVariable(getModule(), Array->getType(), false,
1218                                       llvm::GlobalValue::AppendingLinkage,
1219                                       Array, "llvm.global.annotations");
1220   gv->setSection(AnnotationSection);
1221 }
1222 
1223 llvm::Constant *CodeGenModule::EmitAnnotationString(StringRef Str) {
1224   llvm::Constant *&AStr = AnnotationStrings[Str];
1225   if (AStr)
1226     return AStr;
1227 
1228   // Not found yet, create a new global.
1229   llvm::Constant *s = llvm::ConstantDataArray::getString(getLLVMContext(), Str);
1230   auto *gv =
1231       new llvm::GlobalVariable(getModule(), s->getType(), true,
1232                                llvm::GlobalValue::PrivateLinkage, s, ".str");
1233   gv->setSection(AnnotationSection);
1234   gv->setUnnamedAddr(true);
1235   AStr = gv;
1236   return gv;
1237 }
1238 
1239 llvm::Constant *CodeGenModule::EmitAnnotationUnit(SourceLocation Loc) {
1240   SourceManager &SM = getContext().getSourceManager();
1241   PresumedLoc PLoc = SM.getPresumedLoc(Loc);
1242   if (PLoc.isValid())
1243     return EmitAnnotationString(PLoc.getFilename());
1244   return EmitAnnotationString(SM.getBufferName(Loc));
1245 }
1246 
1247 llvm::Constant *CodeGenModule::EmitAnnotationLineNo(SourceLocation L) {
1248   SourceManager &SM = getContext().getSourceManager();
1249   PresumedLoc PLoc = SM.getPresumedLoc(L);
1250   unsigned LineNo = PLoc.isValid() ? PLoc.getLine() :
1251     SM.getExpansionLineNumber(L);
1252   return llvm::ConstantInt::get(Int32Ty, LineNo);
1253 }
1254 
1255 llvm::Constant *CodeGenModule::EmitAnnotateAttr(llvm::GlobalValue *GV,
1256                                                 const AnnotateAttr *AA,
1257                                                 SourceLocation L) {
1258   // Get the globals for file name, annotation, and the line number.
1259   llvm::Constant *AnnoGV = EmitAnnotationString(AA->getAnnotation()),
1260                  *UnitGV = EmitAnnotationUnit(L),
1261                  *LineNoCst = EmitAnnotationLineNo(L);
1262 
1263   // Create the ConstantStruct for the global annotation.
1264   llvm::Constant *Fields[4] = {
1265     llvm::ConstantExpr::getBitCast(GV, Int8PtrTy),
1266     llvm::ConstantExpr::getBitCast(AnnoGV, Int8PtrTy),
1267     llvm::ConstantExpr::getBitCast(UnitGV, Int8PtrTy),
1268     LineNoCst
1269   };
1270   return llvm::ConstantStruct::getAnon(Fields);
1271 }
1272 
1273 void CodeGenModule::AddGlobalAnnotations(const ValueDecl *D,
1274                                          llvm::GlobalValue *GV) {
1275   assert(D->hasAttr<AnnotateAttr>() && "no annotate attribute");
1276   // Get the struct elements for these annotations.
1277   for (const auto *I : D->specific_attrs<AnnotateAttr>())
1278     Annotations.push_back(EmitAnnotateAttr(GV, I, D->getLocation()));
1279 }
1280 
1281 bool CodeGenModule::isInSanitizerBlacklist(llvm::Function *Fn,
1282                                            SourceLocation Loc) const {
1283   const auto &SanitizerBL = getContext().getSanitizerBlacklist();
1284   // Blacklist by function name.
1285   if (SanitizerBL.isBlacklistedFunction(Fn->getName()))
1286     return true;
1287   // Blacklist by location.
1288   if (Loc.isValid())
1289     return SanitizerBL.isBlacklistedLocation(Loc);
1290   // If location is unknown, this may be a compiler-generated function. Assume
1291   // it's located in the main file.
1292   auto &SM = Context.getSourceManager();
1293   if (const auto *MainFile = SM.getFileEntryForID(SM.getMainFileID())) {
1294     return SanitizerBL.isBlacklistedFile(MainFile->getName());
1295   }
1296   return false;
1297 }
1298 
1299 bool CodeGenModule::isInSanitizerBlacklist(llvm::GlobalVariable *GV,
1300                                            SourceLocation Loc, QualType Ty,
1301                                            StringRef Category) const {
1302   // For now globals can be blacklisted only in ASan and KASan.
1303   if (!LangOpts.Sanitize.hasOneOf(
1304           SanitizerKind::Address | SanitizerKind::KernelAddress))
1305     return false;
1306   const auto &SanitizerBL = getContext().getSanitizerBlacklist();
1307   if (SanitizerBL.isBlacklistedGlobal(GV->getName(), Category))
1308     return true;
1309   if (SanitizerBL.isBlacklistedLocation(Loc, Category))
1310     return true;
1311   // Check global type.
1312   if (!Ty.isNull()) {
1313     // Drill down the array types: if global variable of a fixed type is
1314     // blacklisted, we also don't instrument arrays of them.
1315     while (auto AT = dyn_cast<ArrayType>(Ty.getTypePtr()))
1316       Ty = AT->getElementType();
1317     Ty = Ty.getCanonicalType().getUnqualifiedType();
1318     // We allow to blacklist only record types (classes, structs etc.)
1319     if (Ty->isRecordType()) {
1320       std::string TypeStr = Ty.getAsString(getContext().getPrintingPolicy());
1321       if (SanitizerBL.isBlacklistedType(TypeStr, Category))
1322         return true;
1323     }
1324   }
1325   return false;
1326 }
1327 
1328 bool CodeGenModule::MustBeEmitted(const ValueDecl *Global) {
1329   // Never defer when EmitAllDecls is specified.
1330   if (LangOpts.EmitAllDecls)
1331     return true;
1332 
1333   return getContext().DeclMustBeEmitted(Global);
1334 }
1335 
1336 bool CodeGenModule::MayBeEmittedEagerly(const ValueDecl *Global) {
1337   if (const auto *FD = dyn_cast<FunctionDecl>(Global))
1338     if (FD->getTemplateSpecializationKind() == TSK_ImplicitInstantiation)
1339       // Implicit template instantiations may change linkage if they are later
1340       // explicitly instantiated, so they should not be emitted eagerly.
1341       return false;
1342   // If OpenMP is enabled and threadprivates must be generated like TLS, delay
1343   // codegen for global variables, because they may be marked as threadprivate.
1344   if (LangOpts.OpenMP && LangOpts.OpenMPUseTLS &&
1345       getContext().getTargetInfo().isTLSSupported() && isa<VarDecl>(Global))
1346     return false;
1347 
1348   return true;
1349 }
1350 
1351 ConstantAddress CodeGenModule::GetAddrOfUuidDescriptor(
1352     const CXXUuidofExpr* E) {
1353   // Sema has verified that IIDSource has a __declspec(uuid()), and that its
1354   // well-formed.
1355   StringRef Uuid = E->getUuidAsStringRef(Context);
1356   std::string Name = "_GUID_" + Uuid.lower();
1357   std::replace(Name.begin(), Name.end(), '-', '_');
1358 
1359   // Contains a 32-bit field.
1360   CharUnits Alignment = CharUnits::fromQuantity(4);
1361 
1362   // Look for an existing global.
1363   if (llvm::GlobalVariable *GV = getModule().getNamedGlobal(Name))
1364     return ConstantAddress(GV, Alignment);
1365 
1366   llvm::Constant *Init = EmitUuidofInitializer(Uuid);
1367   assert(Init && "failed to initialize as constant");
1368 
1369   auto *GV = new llvm::GlobalVariable(
1370       getModule(), Init->getType(),
1371       /*isConstant=*/true, llvm::GlobalValue::LinkOnceODRLinkage, Init, Name);
1372   if (supportsCOMDAT())
1373     GV->setComdat(TheModule.getOrInsertComdat(GV->getName()));
1374   return ConstantAddress(GV, Alignment);
1375 }
1376 
1377 ConstantAddress CodeGenModule::GetWeakRefReference(const ValueDecl *VD) {
1378   const AliasAttr *AA = VD->getAttr<AliasAttr>();
1379   assert(AA && "No alias?");
1380 
1381   CharUnits Alignment = getContext().getDeclAlign(VD);
1382   llvm::Type *DeclTy = getTypes().ConvertTypeForMem(VD->getType());
1383 
1384   // See if there is already something with the target's name in the module.
1385   llvm::GlobalValue *Entry = GetGlobalValue(AA->getAliasee());
1386   if (Entry) {
1387     unsigned AS = getContext().getTargetAddressSpace(VD->getType());
1388     auto Ptr = llvm::ConstantExpr::getBitCast(Entry, DeclTy->getPointerTo(AS));
1389     return ConstantAddress(Ptr, Alignment);
1390   }
1391 
1392   llvm::Constant *Aliasee;
1393   if (isa<llvm::FunctionType>(DeclTy))
1394     Aliasee = GetOrCreateLLVMFunction(AA->getAliasee(), DeclTy,
1395                                       GlobalDecl(cast<FunctionDecl>(VD)),
1396                                       /*ForVTable=*/false);
1397   else
1398     Aliasee = GetOrCreateLLVMGlobal(AA->getAliasee(),
1399                                     llvm::PointerType::getUnqual(DeclTy),
1400                                     nullptr);
1401 
1402   auto *F = cast<llvm::GlobalValue>(Aliasee);
1403   F->setLinkage(llvm::Function::ExternalWeakLinkage);
1404   WeakRefReferences.insert(F);
1405 
1406   return ConstantAddress(Aliasee, Alignment);
1407 }
1408 
1409 void CodeGenModule::EmitGlobal(GlobalDecl GD) {
1410   const auto *Global = cast<ValueDecl>(GD.getDecl());
1411 
1412   // Weak references don't produce any output by themselves.
1413   if (Global->hasAttr<WeakRefAttr>())
1414     return;
1415 
1416   // If this is an alias definition (which otherwise looks like a declaration)
1417   // emit it now.
1418   if (Global->hasAttr<AliasAttr>())
1419     return EmitAliasDefinition(GD);
1420 
1421   // If this is CUDA, be selective about which declarations we emit.
1422   if (LangOpts.CUDA) {
1423     if (LangOpts.CUDAIsDevice) {
1424       if (!Global->hasAttr<CUDADeviceAttr>() &&
1425           !Global->hasAttr<CUDAGlobalAttr>() &&
1426           !Global->hasAttr<CUDAConstantAttr>() &&
1427           !Global->hasAttr<CUDASharedAttr>())
1428         return;
1429     } else {
1430       if (!Global->hasAttr<CUDAHostAttr>() && (
1431             Global->hasAttr<CUDADeviceAttr>() ||
1432             Global->hasAttr<CUDAConstantAttr>() ||
1433             Global->hasAttr<CUDASharedAttr>()))
1434         return;
1435     }
1436   }
1437 
1438   // Ignore declarations, they will be emitted on their first use.
1439   if (const auto *FD = dyn_cast<FunctionDecl>(Global)) {
1440     // Forward declarations are emitted lazily on first use.
1441     if (!FD->doesThisDeclarationHaveABody()) {
1442       if (!FD->doesDeclarationForceExternallyVisibleDefinition())
1443         return;
1444 
1445       StringRef MangledName = getMangledName(GD);
1446 
1447       // Compute the function info and LLVM type.
1448       const CGFunctionInfo &FI = getTypes().arrangeGlobalDeclaration(GD);
1449       llvm::Type *Ty = getTypes().GetFunctionType(FI);
1450 
1451       GetOrCreateLLVMFunction(MangledName, Ty, GD, /*ForVTable=*/false,
1452                               /*DontDefer=*/false);
1453       return;
1454     }
1455   } else {
1456     const auto *VD = cast<VarDecl>(Global);
1457     assert(VD->isFileVarDecl() && "Cannot emit local var decl as global.");
1458 
1459     if (VD->isThisDeclarationADefinition() != VarDecl::Definition &&
1460         !Context.isMSStaticDataMemberInlineDefinition(VD))
1461       return;
1462   }
1463 
1464   // Defer code generation to first use when possible, e.g. if this is an inline
1465   // function. If the global must always be emitted, do it eagerly if possible
1466   // to benefit from cache locality.
1467   if (MustBeEmitted(Global) && MayBeEmittedEagerly(Global)) {
1468     // Emit the definition if it can't be deferred.
1469     EmitGlobalDefinition(GD);
1470     return;
1471   }
1472 
1473   // If we're deferring emission of a C++ variable with an
1474   // initializer, remember the order in which it appeared in the file.
1475   if (getLangOpts().CPlusPlus && isa<VarDecl>(Global) &&
1476       cast<VarDecl>(Global)->hasInit()) {
1477     DelayedCXXInitPosition[Global] = CXXGlobalInits.size();
1478     CXXGlobalInits.push_back(nullptr);
1479   }
1480 
1481   StringRef MangledName = getMangledName(GD);
1482   if (llvm::GlobalValue *GV = GetGlobalValue(MangledName)) {
1483     // The value has already been used and should therefore be emitted.
1484     addDeferredDeclToEmit(GV, GD);
1485   } else if (MustBeEmitted(Global)) {
1486     // The value must be emitted, but cannot be emitted eagerly.
1487     assert(!MayBeEmittedEagerly(Global));
1488     addDeferredDeclToEmit(/*GV=*/nullptr, GD);
1489   } else {
1490     // Otherwise, remember that we saw a deferred decl with this name.  The
1491     // first use of the mangled name will cause it to move into
1492     // DeferredDeclsToEmit.
1493     DeferredDecls[MangledName] = GD;
1494   }
1495 }
1496 
1497 namespace {
1498   struct FunctionIsDirectlyRecursive :
1499     public RecursiveASTVisitor<FunctionIsDirectlyRecursive> {
1500     const StringRef Name;
1501     const Builtin::Context &BI;
1502     bool Result;
1503     FunctionIsDirectlyRecursive(StringRef N, const Builtin::Context &C) :
1504       Name(N), BI(C), Result(false) {
1505     }
1506     typedef RecursiveASTVisitor<FunctionIsDirectlyRecursive> Base;
1507 
1508     bool TraverseCallExpr(CallExpr *E) {
1509       const FunctionDecl *FD = E->getDirectCallee();
1510       if (!FD)
1511         return true;
1512       AsmLabelAttr *Attr = FD->getAttr<AsmLabelAttr>();
1513       if (Attr && Name == Attr->getLabel()) {
1514         Result = true;
1515         return false;
1516       }
1517       unsigned BuiltinID = FD->getBuiltinID();
1518       if (!BuiltinID || !BI.isLibFunction(BuiltinID))
1519         return true;
1520       StringRef BuiltinName = BI.getName(BuiltinID);
1521       if (BuiltinName.startswith("__builtin_") &&
1522           Name == BuiltinName.slice(strlen("__builtin_"), StringRef::npos)) {
1523         Result = true;
1524         return false;
1525       }
1526       return true;
1527     }
1528   };
1529 
1530   struct DLLImportFunctionVisitor
1531       : public RecursiveASTVisitor<DLLImportFunctionVisitor> {
1532     bool SafeToInline = true;
1533 
1534     bool VisitVarDecl(VarDecl *VD) {
1535       // A thread-local variable cannot be imported.
1536       SafeToInline = !VD->getTLSKind();
1537       return SafeToInline;
1538     }
1539 
1540     // Make sure we're not referencing non-imported vars or functions.
1541     bool VisitDeclRefExpr(DeclRefExpr *E) {
1542       ValueDecl *VD = E->getDecl();
1543       if (isa<FunctionDecl>(VD))
1544         SafeToInline = VD->hasAttr<DLLImportAttr>();
1545       else if (VarDecl *V = dyn_cast<VarDecl>(VD))
1546         SafeToInline = !V->hasGlobalStorage() || V->hasAttr<DLLImportAttr>();
1547       return SafeToInline;
1548     }
1549     bool VisitCXXDeleteExpr(CXXDeleteExpr *E) {
1550       SafeToInline = E->getOperatorDelete()->hasAttr<DLLImportAttr>();
1551       return SafeToInline;
1552     }
1553     bool VisitCXXNewExpr(CXXNewExpr *E) {
1554       SafeToInline = E->getOperatorNew()->hasAttr<DLLImportAttr>();
1555       return SafeToInline;
1556     }
1557   };
1558 }
1559 
1560 // isTriviallyRecursive - Check if this function calls another
1561 // decl that, because of the asm attribute or the other decl being a builtin,
1562 // ends up pointing to itself.
1563 bool
1564 CodeGenModule::isTriviallyRecursive(const FunctionDecl *FD) {
1565   StringRef Name;
1566   if (getCXXABI().getMangleContext().shouldMangleDeclName(FD)) {
1567     // asm labels are a special kind of mangling we have to support.
1568     AsmLabelAttr *Attr = FD->getAttr<AsmLabelAttr>();
1569     if (!Attr)
1570       return false;
1571     Name = Attr->getLabel();
1572   } else {
1573     Name = FD->getName();
1574   }
1575 
1576   FunctionIsDirectlyRecursive Walker(Name, Context.BuiltinInfo);
1577   Walker.TraverseFunctionDecl(const_cast<FunctionDecl*>(FD));
1578   return Walker.Result;
1579 }
1580 
1581 bool
1582 CodeGenModule::shouldEmitFunction(GlobalDecl GD) {
1583   if (getFunctionLinkage(GD) != llvm::Function::AvailableExternallyLinkage)
1584     return true;
1585   const auto *F = cast<FunctionDecl>(GD.getDecl());
1586   if (CodeGenOpts.OptimizationLevel == 0 && !F->hasAttr<AlwaysInlineAttr>())
1587     return false;
1588 
1589   if (F->hasAttr<DLLImportAttr>()) {
1590     // Check whether it would be safe to inline this dllimport function.
1591     DLLImportFunctionVisitor Visitor;
1592     Visitor.TraverseFunctionDecl(const_cast<FunctionDecl*>(F));
1593     if (!Visitor.SafeToInline)
1594       return false;
1595   }
1596 
1597   // PR9614. Avoid cases where the source code is lying to us. An available
1598   // externally function should have an equivalent function somewhere else,
1599   // but a function that calls itself is clearly not equivalent to the real
1600   // implementation.
1601   // This happens in glibc's btowc and in some configure checks.
1602   return !isTriviallyRecursive(F);
1603 }
1604 
1605 /// If the type for the method's class was generated by
1606 /// CGDebugInfo::createContextChain(), the cache contains only a
1607 /// limited DIType without any declarations. Since EmitFunctionStart()
1608 /// needs to find the canonical declaration for each method, we need
1609 /// to construct the complete type prior to emitting the method.
1610 void CodeGenModule::CompleteDIClassType(const CXXMethodDecl* D) {
1611   if (!D->isInstance())
1612     return;
1613 
1614   if (CGDebugInfo *DI = getModuleDebugInfo())
1615     if (getCodeGenOpts().getDebugInfo() >= CodeGenOptions::LimitedDebugInfo) {
1616       const auto *ThisPtr = cast<PointerType>(D->getThisType(getContext()));
1617       DI->getOrCreateRecordType(ThisPtr->getPointeeType(), D->getLocation());
1618     }
1619 }
1620 
1621 void CodeGenModule::EmitGlobalDefinition(GlobalDecl GD, llvm::GlobalValue *GV) {
1622   const auto *D = cast<ValueDecl>(GD.getDecl());
1623 
1624   PrettyStackTraceDecl CrashInfo(const_cast<ValueDecl *>(D), D->getLocation(),
1625                                  Context.getSourceManager(),
1626                                  "Generating code for declaration");
1627 
1628   if (isa<FunctionDecl>(D)) {
1629     // At -O0, don't generate IR for functions with available_externally
1630     // linkage.
1631     if (!shouldEmitFunction(GD))
1632       return;
1633 
1634     if (const auto *Method = dyn_cast<CXXMethodDecl>(D)) {
1635       CompleteDIClassType(Method);
1636       // Make sure to emit the definition(s) before we emit the thunks.
1637       // This is necessary for the generation of certain thunks.
1638       if (const auto *CD = dyn_cast<CXXConstructorDecl>(Method))
1639         ABI->emitCXXStructor(CD, getFromCtorType(GD.getCtorType()));
1640       else if (const auto *DD = dyn_cast<CXXDestructorDecl>(Method))
1641         ABI->emitCXXStructor(DD, getFromDtorType(GD.getDtorType()));
1642       else
1643         EmitGlobalFunctionDefinition(GD, GV);
1644 
1645       if (Method->isVirtual())
1646         getVTables().EmitThunks(GD);
1647 
1648       return;
1649     }
1650 
1651     return EmitGlobalFunctionDefinition(GD, GV);
1652   }
1653 
1654   if (const auto *VD = dyn_cast<VarDecl>(D))
1655     return EmitGlobalVarDefinition(VD);
1656 
1657   llvm_unreachable("Invalid argument to EmitGlobalDefinition()");
1658 }
1659 
1660 static void ReplaceUsesOfNonProtoTypeWithRealFunction(llvm::GlobalValue *Old,
1661                                                       llvm::Function *NewFn);
1662 
1663 /// GetOrCreateLLVMFunction - If the specified mangled name is not in the
1664 /// module, create and return an llvm Function with the specified type. If there
1665 /// is something in the module with the specified name, return it potentially
1666 /// bitcasted to the right type.
1667 ///
1668 /// If D is non-null, it specifies a decl that correspond to this.  This is used
1669 /// to set the attributes on the function when it is first created.
1670 llvm::Constant *
1671 CodeGenModule::GetOrCreateLLVMFunction(StringRef MangledName,
1672                                        llvm::Type *Ty,
1673                                        GlobalDecl GD, bool ForVTable,
1674                                        bool DontDefer, bool IsThunk,
1675                                        llvm::AttributeSet ExtraAttrs,
1676                                        bool IsForDefinition) {
1677   const Decl *D = GD.getDecl();
1678 
1679   // Lookup the entry, lazily creating it if necessary.
1680   llvm::GlobalValue *Entry = GetGlobalValue(MangledName);
1681   if (Entry) {
1682     if (WeakRefReferences.erase(Entry)) {
1683       const FunctionDecl *FD = cast_or_null<FunctionDecl>(D);
1684       if (FD && !FD->hasAttr<WeakAttr>())
1685         Entry->setLinkage(llvm::Function::ExternalLinkage);
1686     }
1687 
1688     // Handle dropped DLL attributes.
1689     if (D && !D->hasAttr<DLLImportAttr>() && !D->hasAttr<DLLExportAttr>())
1690       Entry->setDLLStorageClass(llvm::GlobalValue::DefaultStorageClass);
1691 
1692     // If there are two attempts to define the same mangled name, issue an
1693     // error.
1694     if (IsForDefinition && !Entry->isDeclaration()) {
1695       GlobalDecl OtherGD;
1696       // Check that GD is not yet in ExplicitDefinitions is required to make
1697       // sure that we issue an error only once.
1698       if (lookupRepresentativeDecl(MangledName, OtherGD) &&
1699           (GD.getCanonicalDecl().getDecl() !=
1700            OtherGD.getCanonicalDecl().getDecl()) &&
1701           DiagnosedConflictingDefinitions.insert(GD).second) {
1702         getDiags().Report(D->getLocation(),
1703                           diag::err_duplicate_mangled_name);
1704         getDiags().Report(OtherGD.getDecl()->getLocation(),
1705                           diag::note_previous_definition);
1706       }
1707     }
1708 
1709     if ((isa<llvm::Function>(Entry) || isa<llvm::GlobalAlias>(Entry)) &&
1710         (Entry->getType()->getElementType() == Ty)) {
1711       return Entry;
1712     }
1713 
1714     // Make sure the result is of the correct type.
1715     // (If function is requested for a definition, we always need to create a new
1716     // function, not just return a bitcast.)
1717     if (!IsForDefinition)
1718       return llvm::ConstantExpr::getBitCast(Entry, Ty->getPointerTo());
1719   }
1720 
1721   // This function doesn't have a complete type (for example, the return
1722   // type is an incomplete struct). Use a fake type instead, and make
1723   // sure not to try to set attributes.
1724   bool IsIncompleteFunction = false;
1725 
1726   llvm::FunctionType *FTy;
1727   if (isa<llvm::FunctionType>(Ty)) {
1728     FTy = cast<llvm::FunctionType>(Ty);
1729   } else {
1730     FTy = llvm::FunctionType::get(VoidTy, false);
1731     IsIncompleteFunction = true;
1732   }
1733 
1734   llvm::Function *F =
1735       llvm::Function::Create(FTy, llvm::Function::ExternalLinkage,
1736                              Entry ? StringRef() : MangledName, &getModule());
1737 
1738   // If we already created a function with the same mangled name (but different
1739   // type) before, take its name and add it to the list of functions to be
1740   // replaced with F at the end of CodeGen.
1741   //
1742   // This happens if there is a prototype for a function (e.g. "int f()") and
1743   // then a definition of a different type (e.g. "int f(int x)").
1744   if (Entry) {
1745     F->takeName(Entry);
1746 
1747     // This might be an implementation of a function without a prototype, in
1748     // which case, try to do special replacement of calls which match the new
1749     // prototype.  The really key thing here is that we also potentially drop
1750     // arguments from the call site so as to make a direct call, which makes the
1751     // inliner happier and suppresses a number of optimizer warnings (!) about
1752     // dropping arguments.
1753     if (!Entry->use_empty()) {
1754       ReplaceUsesOfNonProtoTypeWithRealFunction(Entry, F);
1755       Entry->removeDeadConstantUsers();
1756     }
1757 
1758     llvm::Constant *BC = llvm::ConstantExpr::getBitCast(
1759         F, Entry->getType()->getElementType()->getPointerTo());
1760     addGlobalValReplacement(Entry, BC);
1761   }
1762 
1763   assert(F->getName() == MangledName && "name was uniqued!");
1764   if (D)
1765     SetFunctionAttributes(GD, F, IsIncompleteFunction, IsThunk);
1766   if (ExtraAttrs.hasAttributes(llvm::AttributeSet::FunctionIndex)) {
1767     llvm::AttrBuilder B(ExtraAttrs, llvm::AttributeSet::FunctionIndex);
1768     F->addAttributes(llvm::AttributeSet::FunctionIndex,
1769                      llvm::AttributeSet::get(VMContext,
1770                                              llvm::AttributeSet::FunctionIndex,
1771                                              B));
1772   }
1773 
1774   if (!DontDefer) {
1775     // All MSVC dtors other than the base dtor are linkonce_odr and delegate to
1776     // each other bottoming out with the base dtor.  Therefore we emit non-base
1777     // dtors on usage, even if there is no dtor definition in the TU.
1778     if (D && isa<CXXDestructorDecl>(D) &&
1779         getCXXABI().useThunkForDtorVariant(cast<CXXDestructorDecl>(D),
1780                                            GD.getDtorType()))
1781       addDeferredDeclToEmit(F, GD);
1782 
1783     // This is the first use or definition of a mangled name.  If there is a
1784     // deferred decl with this name, remember that we need to emit it at the end
1785     // of the file.
1786     auto DDI = DeferredDecls.find(MangledName);
1787     if (DDI != DeferredDecls.end()) {
1788       // Move the potentially referenced deferred decl to the
1789       // DeferredDeclsToEmit list, and remove it from DeferredDecls (since we
1790       // don't need it anymore).
1791       addDeferredDeclToEmit(F, DDI->second);
1792       DeferredDecls.erase(DDI);
1793 
1794       // Otherwise, there are cases we have to worry about where we're
1795       // using a declaration for which we must emit a definition but where
1796       // we might not find a top-level definition:
1797       //   - member functions defined inline in their classes
1798       //   - friend functions defined inline in some class
1799       //   - special member functions with implicit definitions
1800       // If we ever change our AST traversal to walk into class methods,
1801       // this will be unnecessary.
1802       //
1803       // We also don't emit a definition for a function if it's going to be an
1804       // entry in a vtable, unless it's already marked as used.
1805     } else if (getLangOpts().CPlusPlus && D) {
1806       // Look for a declaration that's lexically in a record.
1807       for (const auto *FD = cast<FunctionDecl>(D)->getMostRecentDecl(); FD;
1808            FD = FD->getPreviousDecl()) {
1809         if (isa<CXXRecordDecl>(FD->getLexicalDeclContext())) {
1810           if (FD->doesThisDeclarationHaveABody()) {
1811             addDeferredDeclToEmit(F, GD.getWithDecl(FD));
1812             break;
1813           }
1814         }
1815       }
1816     }
1817   }
1818 
1819   // Make sure the result is of the requested type.
1820   if (!IsIncompleteFunction) {
1821     assert(F->getType()->getElementType() == Ty);
1822     return F;
1823   }
1824 
1825   llvm::Type *PTy = llvm::PointerType::getUnqual(Ty);
1826   return llvm::ConstantExpr::getBitCast(F, PTy);
1827 }
1828 
1829 /// GetAddrOfFunction - Return the address of the given function.  If Ty is
1830 /// non-null, then this function will use the specified type if it has to
1831 /// create it (this occurs when we see a definition of the function).
1832 llvm::Constant *CodeGenModule::GetAddrOfFunction(GlobalDecl GD,
1833                                                  llvm::Type *Ty,
1834                                                  bool ForVTable,
1835                                                  bool DontDefer,
1836                                                  bool IsForDefinition) {
1837   // If there was no specific requested type, just convert it now.
1838   if (!Ty)
1839     Ty = getTypes().ConvertType(cast<ValueDecl>(GD.getDecl())->getType());
1840 
1841   StringRef MangledName = getMangledName(GD);
1842   return GetOrCreateLLVMFunction(MangledName, Ty, GD, ForVTable, DontDefer,
1843                                  /*IsThunk=*/false, llvm::AttributeSet(),
1844                                  IsForDefinition);
1845 }
1846 
1847 /// CreateRuntimeFunction - Create a new runtime function with the specified
1848 /// type and name.
1849 llvm::Constant *
1850 CodeGenModule::CreateRuntimeFunction(llvm::FunctionType *FTy,
1851                                      StringRef Name,
1852                                      llvm::AttributeSet ExtraAttrs) {
1853   llvm::Constant *C =
1854       GetOrCreateLLVMFunction(Name, FTy, GlobalDecl(), /*ForVTable=*/false,
1855                               /*DontDefer=*/false, /*IsThunk=*/false, ExtraAttrs);
1856   if (auto *F = dyn_cast<llvm::Function>(C))
1857     if (F->empty())
1858       F->setCallingConv(getRuntimeCC());
1859   return C;
1860 }
1861 
1862 /// CreateBuiltinFunction - Create a new builtin function with the specified
1863 /// type and name.
1864 llvm::Constant *
1865 CodeGenModule::CreateBuiltinFunction(llvm::FunctionType *FTy,
1866                                      StringRef Name,
1867                                      llvm::AttributeSet ExtraAttrs) {
1868   llvm::Constant *C =
1869       GetOrCreateLLVMFunction(Name, FTy, GlobalDecl(), /*ForVTable=*/false,
1870                               /*DontDefer=*/false, /*IsThunk=*/false, ExtraAttrs);
1871   if (auto *F = dyn_cast<llvm::Function>(C))
1872     if (F->empty())
1873       F->setCallingConv(getBuiltinCC());
1874   return C;
1875 }
1876 
1877 /// isTypeConstant - Determine whether an object of this type can be emitted
1878 /// as a constant.
1879 ///
1880 /// If ExcludeCtor is true, the duration when the object's constructor runs
1881 /// will not be considered. The caller will need to verify that the object is
1882 /// not written to during its construction.
1883 bool CodeGenModule::isTypeConstant(QualType Ty, bool ExcludeCtor) {
1884   if (!Ty.isConstant(Context) && !Ty->isReferenceType())
1885     return false;
1886 
1887   if (Context.getLangOpts().CPlusPlus) {
1888     if (const CXXRecordDecl *Record
1889           = Context.getBaseElementType(Ty)->getAsCXXRecordDecl())
1890       return ExcludeCtor && !Record->hasMutableFields() &&
1891              Record->hasTrivialDestructor();
1892   }
1893 
1894   return true;
1895 }
1896 
1897 /// GetOrCreateLLVMGlobal - If the specified mangled name is not in the module,
1898 /// create and return an llvm GlobalVariable with the specified type.  If there
1899 /// is something in the module with the specified name, return it potentially
1900 /// bitcasted to the right type.
1901 ///
1902 /// If D is non-null, it specifies a decl that correspond to this.  This is used
1903 /// to set the attributes on the global when it is first created.
1904 llvm::Constant *
1905 CodeGenModule::GetOrCreateLLVMGlobal(StringRef MangledName,
1906                                      llvm::PointerType *Ty,
1907                                      const VarDecl *D) {
1908   // Lookup the entry, lazily creating it if necessary.
1909   llvm::GlobalValue *Entry = GetGlobalValue(MangledName);
1910   if (Entry) {
1911     if (WeakRefReferences.erase(Entry)) {
1912       if (D && !D->hasAttr<WeakAttr>())
1913         Entry->setLinkage(llvm::Function::ExternalLinkage);
1914     }
1915 
1916     // Handle dropped DLL attributes.
1917     if (D && !D->hasAttr<DLLImportAttr>() && !D->hasAttr<DLLExportAttr>())
1918       Entry->setDLLStorageClass(llvm::GlobalValue::DefaultStorageClass);
1919 
1920     if (Entry->getType() == Ty)
1921       return Entry;
1922 
1923     // Make sure the result is of the correct type.
1924     if (Entry->getType()->getAddressSpace() != Ty->getAddressSpace())
1925       return llvm::ConstantExpr::getAddrSpaceCast(Entry, Ty);
1926 
1927     return llvm::ConstantExpr::getBitCast(Entry, Ty);
1928   }
1929 
1930   unsigned AddrSpace = GetGlobalVarAddressSpace(D, Ty->getAddressSpace());
1931   auto *GV = new llvm::GlobalVariable(
1932       getModule(), Ty->getElementType(), false,
1933       llvm::GlobalValue::ExternalLinkage, nullptr, MangledName, nullptr,
1934       llvm::GlobalVariable::NotThreadLocal, AddrSpace);
1935 
1936   // This is the first use or definition of a mangled name.  If there is a
1937   // deferred decl with this name, remember that we need to emit it at the end
1938   // of the file.
1939   auto DDI = DeferredDecls.find(MangledName);
1940   if (DDI != DeferredDecls.end()) {
1941     // Move the potentially referenced deferred decl to the DeferredDeclsToEmit
1942     // list, and remove it from DeferredDecls (since we don't need it anymore).
1943     addDeferredDeclToEmit(GV, DDI->second);
1944     DeferredDecls.erase(DDI);
1945   }
1946 
1947   // Handle things which are present even on external declarations.
1948   if (D) {
1949     // FIXME: This code is overly simple and should be merged with other global
1950     // handling.
1951     GV->setConstant(isTypeConstant(D->getType(), false));
1952 
1953     GV->setAlignment(getContext().getDeclAlign(D).getQuantity());
1954 
1955     setLinkageAndVisibilityForGV(GV, D);
1956 
1957     if (D->getTLSKind()) {
1958       if (D->getTLSKind() == VarDecl::TLS_Dynamic)
1959         CXXThreadLocals.push_back(std::make_pair(D, GV));
1960       setTLSMode(GV, *D);
1961     }
1962 
1963     // If required by the ABI, treat declarations of static data members with
1964     // inline initializers as definitions.
1965     if (getContext().isMSStaticDataMemberInlineDefinition(D)) {
1966       EmitGlobalVarDefinition(D);
1967     }
1968 
1969     // Handle XCore specific ABI requirements.
1970     if (getTarget().getTriple().getArch() == llvm::Triple::xcore &&
1971         D->getLanguageLinkage() == CLanguageLinkage &&
1972         D->getType().isConstant(Context) &&
1973         isExternallyVisible(D->getLinkageAndVisibility().getLinkage()))
1974       GV->setSection(".cp.rodata");
1975   }
1976 
1977   if (AddrSpace != Ty->getAddressSpace())
1978     return llvm::ConstantExpr::getAddrSpaceCast(GV, Ty);
1979 
1980   return GV;
1981 }
1982 
1983 llvm::Constant *
1984 CodeGenModule::GetAddrOfGlobal(GlobalDecl GD,
1985                                bool IsForDefinition) {
1986   if (isa<CXXConstructorDecl>(GD.getDecl()))
1987     return getAddrOfCXXStructor(cast<CXXConstructorDecl>(GD.getDecl()),
1988                                 getFromCtorType(GD.getCtorType()),
1989                                 /*FnInfo=*/nullptr, /*FnType=*/nullptr,
1990                                 /*DontDefer=*/false, IsForDefinition);
1991   else if (isa<CXXDestructorDecl>(GD.getDecl()))
1992     return getAddrOfCXXStructor(cast<CXXDestructorDecl>(GD.getDecl()),
1993                                 getFromDtorType(GD.getDtorType()),
1994                                 /*FnInfo=*/nullptr, /*FnType=*/nullptr,
1995                                 /*DontDefer=*/false, IsForDefinition);
1996   else if (isa<CXXMethodDecl>(GD.getDecl())) {
1997     auto FInfo = &getTypes().arrangeCXXMethodDeclaration(
1998         cast<CXXMethodDecl>(GD.getDecl()));
1999     auto Ty = getTypes().GetFunctionType(*FInfo);
2000     return GetAddrOfFunction(GD, Ty, /*ForVTable=*/false, /*DontDefer=*/false,
2001                              IsForDefinition);
2002   } else if (isa<FunctionDecl>(GD.getDecl())) {
2003     const CGFunctionInfo &FI = getTypes().arrangeGlobalDeclaration(GD);
2004     llvm::FunctionType *Ty = getTypes().GetFunctionType(FI);
2005     return GetAddrOfFunction(GD, Ty, /*ForVTable=*/false, /*DontDefer=*/false,
2006                              IsForDefinition);
2007   } else
2008     return GetAddrOfGlobalVar(cast<VarDecl>(GD.getDecl()));
2009 }
2010 
2011 llvm::GlobalVariable *
2012 CodeGenModule::CreateOrReplaceCXXRuntimeVariable(StringRef Name,
2013                                       llvm::Type *Ty,
2014                                       llvm::GlobalValue::LinkageTypes Linkage) {
2015   llvm::GlobalVariable *GV = getModule().getNamedGlobal(Name);
2016   llvm::GlobalVariable *OldGV = nullptr;
2017 
2018   if (GV) {
2019     // Check if the variable has the right type.
2020     if (GV->getType()->getElementType() == Ty)
2021       return GV;
2022 
2023     // Because C++ name mangling, the only way we can end up with an already
2024     // existing global with the same name is if it has been declared extern "C".
2025     assert(GV->isDeclaration() && "Declaration has wrong type!");
2026     OldGV = GV;
2027   }
2028 
2029   // Create a new variable.
2030   GV = new llvm::GlobalVariable(getModule(), Ty, /*isConstant=*/true,
2031                                 Linkage, nullptr, Name);
2032 
2033   if (OldGV) {
2034     // Replace occurrences of the old variable if needed.
2035     GV->takeName(OldGV);
2036 
2037     if (!OldGV->use_empty()) {
2038       llvm::Constant *NewPtrForOldDecl =
2039       llvm::ConstantExpr::getBitCast(GV, OldGV->getType());
2040       OldGV->replaceAllUsesWith(NewPtrForOldDecl);
2041     }
2042 
2043     OldGV->eraseFromParent();
2044   }
2045 
2046   if (supportsCOMDAT() && GV->isWeakForLinker() &&
2047       !GV->hasAvailableExternallyLinkage())
2048     GV->setComdat(TheModule.getOrInsertComdat(GV->getName()));
2049 
2050   return GV;
2051 }
2052 
2053 /// GetAddrOfGlobalVar - Return the llvm::Constant for the address of the
2054 /// given global variable.  If Ty is non-null and if the global doesn't exist,
2055 /// then it will be created with the specified type instead of whatever the
2056 /// normal requested type would be.
2057 llvm::Constant *CodeGenModule::GetAddrOfGlobalVar(const VarDecl *D,
2058                                                   llvm::Type *Ty) {
2059   assert(D->hasGlobalStorage() && "Not a global variable");
2060   QualType ASTTy = D->getType();
2061   if (!Ty)
2062     Ty = getTypes().ConvertTypeForMem(ASTTy);
2063 
2064   llvm::PointerType *PTy =
2065     llvm::PointerType::get(Ty, getContext().getTargetAddressSpace(ASTTy));
2066 
2067   StringRef MangledName = getMangledName(D);
2068   return GetOrCreateLLVMGlobal(MangledName, PTy, D);
2069 }
2070 
2071 /// CreateRuntimeVariable - Create a new runtime global variable with the
2072 /// specified type and name.
2073 llvm::Constant *
2074 CodeGenModule::CreateRuntimeVariable(llvm::Type *Ty,
2075                                      StringRef Name) {
2076   return GetOrCreateLLVMGlobal(Name, llvm::PointerType::getUnqual(Ty), nullptr);
2077 }
2078 
2079 void CodeGenModule::EmitTentativeDefinition(const VarDecl *D) {
2080   assert(!D->getInit() && "Cannot emit definite definitions here!");
2081 
2082   if (!MustBeEmitted(D)) {
2083     // If we have not seen a reference to this variable yet, place it
2084     // into the deferred declarations table to be emitted if needed
2085     // later.
2086     StringRef MangledName = getMangledName(D);
2087     if (!GetGlobalValue(MangledName)) {
2088       DeferredDecls[MangledName] = D;
2089       return;
2090     }
2091   }
2092 
2093   // The tentative definition is the only definition.
2094   EmitGlobalVarDefinition(D);
2095 }
2096 
2097 CharUnits CodeGenModule::GetTargetTypeStoreSize(llvm::Type *Ty) const {
2098   return Context.toCharUnitsFromBits(
2099       getDataLayout().getTypeStoreSizeInBits(Ty));
2100 }
2101 
2102 unsigned CodeGenModule::GetGlobalVarAddressSpace(const VarDecl *D,
2103                                                  unsigned AddrSpace) {
2104   if (LangOpts.CUDA && LangOpts.CUDAIsDevice) {
2105     if (D->hasAttr<CUDAConstantAttr>())
2106       AddrSpace = getContext().getTargetAddressSpace(LangAS::cuda_constant);
2107     else if (D->hasAttr<CUDASharedAttr>())
2108       AddrSpace = getContext().getTargetAddressSpace(LangAS::cuda_shared);
2109     else
2110       AddrSpace = getContext().getTargetAddressSpace(LangAS::cuda_device);
2111   }
2112 
2113   return AddrSpace;
2114 }
2115 
2116 template<typename SomeDecl>
2117 void CodeGenModule::MaybeHandleStaticInExternC(const SomeDecl *D,
2118                                                llvm::GlobalValue *GV) {
2119   if (!getLangOpts().CPlusPlus)
2120     return;
2121 
2122   // Must have 'used' attribute, or else inline assembly can't rely on
2123   // the name existing.
2124   if (!D->template hasAttr<UsedAttr>())
2125     return;
2126 
2127   // Must have internal linkage and an ordinary name.
2128   if (!D->getIdentifier() || D->getFormalLinkage() != InternalLinkage)
2129     return;
2130 
2131   // Must be in an extern "C" context. Entities declared directly within
2132   // a record are not extern "C" even if the record is in such a context.
2133   const SomeDecl *First = D->getFirstDecl();
2134   if (First->getDeclContext()->isRecord() || !First->isInExternCContext())
2135     return;
2136 
2137   // OK, this is an internal linkage entity inside an extern "C" linkage
2138   // specification. Make a note of that so we can give it the "expected"
2139   // mangled name if nothing else is using that name.
2140   std::pair<StaticExternCMap::iterator, bool> R =
2141       StaticExternCValues.insert(std::make_pair(D->getIdentifier(), GV));
2142 
2143   // If we have multiple internal linkage entities with the same name
2144   // in extern "C" regions, none of them gets that name.
2145   if (!R.second)
2146     R.first->second = nullptr;
2147 }
2148 
2149 static bool shouldBeInCOMDAT(CodeGenModule &CGM, const Decl &D) {
2150   if (!CGM.supportsCOMDAT())
2151     return false;
2152 
2153   if (D.hasAttr<SelectAnyAttr>())
2154     return true;
2155 
2156   GVALinkage Linkage;
2157   if (auto *VD = dyn_cast<VarDecl>(&D))
2158     Linkage = CGM.getContext().GetGVALinkageForVariable(VD);
2159   else
2160     Linkage = CGM.getContext().GetGVALinkageForFunction(cast<FunctionDecl>(&D));
2161 
2162   switch (Linkage) {
2163   case GVA_Internal:
2164   case GVA_AvailableExternally:
2165   case GVA_StrongExternal:
2166     return false;
2167   case GVA_DiscardableODR:
2168   case GVA_StrongODR:
2169     return true;
2170   }
2171   llvm_unreachable("No such linkage");
2172 }
2173 
2174 void CodeGenModule::maybeSetTrivialComdat(const Decl &D,
2175                                           llvm::GlobalObject &GO) {
2176   if (!shouldBeInCOMDAT(*this, D))
2177     return;
2178   GO.setComdat(TheModule.getOrInsertComdat(GO.getName()));
2179 }
2180 
2181 void CodeGenModule::EmitGlobalVarDefinition(const VarDecl *D) {
2182   llvm::Constant *Init = nullptr;
2183   QualType ASTTy = D->getType();
2184   CXXRecordDecl *RD = ASTTy->getBaseElementTypeUnsafe()->getAsCXXRecordDecl();
2185   bool NeedsGlobalCtor = false;
2186   bool NeedsGlobalDtor = RD && !RD->hasTrivialDestructor();
2187 
2188   const VarDecl *InitDecl;
2189   const Expr *InitExpr = D->getAnyInitializer(InitDecl);
2190 
2191   // CUDA E.2.4.1 "__shared__ variables cannot have an initialization as part
2192   // of their declaration."
2193   if (getLangOpts().CPlusPlus && getLangOpts().CUDAIsDevice
2194       && D->hasAttr<CUDASharedAttr>()) {
2195     if (InitExpr) {
2196       const auto *C = dyn_cast<CXXConstructExpr>(InitExpr);
2197       if (C == nullptr || !C->getConstructor()->hasTrivialBody())
2198         Error(D->getLocation(),
2199               "__shared__ variable cannot have an initialization.");
2200     }
2201     Init = llvm::UndefValue::get(getTypes().ConvertType(ASTTy));
2202   } else if (!InitExpr) {
2203     // This is a tentative definition; tentative definitions are
2204     // implicitly initialized with { 0 }.
2205     //
2206     // Note that tentative definitions are only emitted at the end of
2207     // a translation unit, so they should never have incomplete
2208     // type. In addition, EmitTentativeDefinition makes sure that we
2209     // never attempt to emit a tentative definition if a real one
2210     // exists. A use may still exists, however, so we still may need
2211     // to do a RAUW.
2212     assert(!ASTTy->isIncompleteType() && "Unexpected incomplete type");
2213     Init = EmitNullConstant(D->getType());
2214   } else {
2215     initializedGlobalDecl = GlobalDecl(D);
2216     Init = EmitConstantInit(*InitDecl);
2217 
2218     if (!Init) {
2219       QualType T = InitExpr->getType();
2220       if (D->getType()->isReferenceType())
2221         T = D->getType();
2222 
2223       if (getLangOpts().CPlusPlus) {
2224         Init = EmitNullConstant(T);
2225         NeedsGlobalCtor = true;
2226       } else {
2227         ErrorUnsupported(D, "static initializer");
2228         Init = llvm::UndefValue::get(getTypes().ConvertType(T));
2229       }
2230     } else {
2231       // We don't need an initializer, so remove the entry for the delayed
2232       // initializer position (just in case this entry was delayed) if we
2233       // also don't need to register a destructor.
2234       if (getLangOpts().CPlusPlus && !NeedsGlobalDtor)
2235         DelayedCXXInitPosition.erase(D);
2236     }
2237   }
2238 
2239   llvm::Type* InitType = Init->getType();
2240   llvm::Constant *Entry = GetAddrOfGlobalVar(D, InitType);
2241 
2242   // Strip off a bitcast if we got one back.
2243   if (auto *CE = dyn_cast<llvm::ConstantExpr>(Entry)) {
2244     assert(CE->getOpcode() == llvm::Instruction::BitCast ||
2245            CE->getOpcode() == llvm::Instruction::AddrSpaceCast ||
2246            // All zero index gep.
2247            CE->getOpcode() == llvm::Instruction::GetElementPtr);
2248     Entry = CE->getOperand(0);
2249   }
2250 
2251   // Entry is now either a Function or GlobalVariable.
2252   auto *GV = dyn_cast<llvm::GlobalVariable>(Entry);
2253 
2254   // We have a definition after a declaration with the wrong type.
2255   // We must make a new GlobalVariable* and update everything that used OldGV
2256   // (a declaration or tentative definition) with the new GlobalVariable*
2257   // (which will be a definition).
2258   //
2259   // This happens if there is a prototype for a global (e.g.
2260   // "extern int x[];") and then a definition of a different type (e.g.
2261   // "int x[10];"). This also happens when an initializer has a different type
2262   // from the type of the global (this happens with unions).
2263   if (!GV ||
2264       GV->getType()->getElementType() != InitType ||
2265       GV->getType()->getAddressSpace() !=
2266        GetGlobalVarAddressSpace(D, getContext().getTargetAddressSpace(ASTTy))) {
2267 
2268     // Move the old entry aside so that we'll create a new one.
2269     Entry->setName(StringRef());
2270 
2271     // Make a new global with the correct type, this is now guaranteed to work.
2272     GV = cast<llvm::GlobalVariable>(GetAddrOfGlobalVar(D, InitType));
2273 
2274     // Replace all uses of the old global with the new global
2275     llvm::Constant *NewPtrForOldDecl =
2276         llvm::ConstantExpr::getBitCast(GV, Entry->getType());
2277     Entry->replaceAllUsesWith(NewPtrForOldDecl);
2278 
2279     // Erase the old global, since it is no longer used.
2280     cast<llvm::GlobalValue>(Entry)->eraseFromParent();
2281   }
2282 
2283   MaybeHandleStaticInExternC(D, GV);
2284 
2285   if (D->hasAttr<AnnotateAttr>())
2286     AddGlobalAnnotations(D, GV);
2287 
2288   // CUDA B.2.1 "The __device__ qualifier declares a variable that resides on
2289   // the device. [...]"
2290   // CUDA B.2.2 "The __constant__ qualifier, optionally used together with
2291   // __device__, declares a variable that: [...]
2292   // Is accessible from all the threads within the grid and from the host
2293   // through the runtime library (cudaGetSymbolAddress() / cudaGetSymbolSize()
2294   // / cudaMemcpyToSymbol() / cudaMemcpyFromSymbol())."
2295   if (GV && LangOpts.CUDA && LangOpts.CUDAIsDevice &&
2296       (D->hasAttr<CUDAConstantAttr>() || D->hasAttr<CUDADeviceAttr>())) {
2297     GV->setExternallyInitialized(true);
2298   }
2299   GV->setInitializer(Init);
2300 
2301   // If it is safe to mark the global 'constant', do so now.
2302   GV->setConstant(!NeedsGlobalCtor && !NeedsGlobalDtor &&
2303                   isTypeConstant(D->getType(), true));
2304 
2305   // If it is in a read-only section, mark it 'constant'.
2306   if (const SectionAttr *SA = D->getAttr<SectionAttr>()) {
2307     const ASTContext::SectionInfo &SI = Context.SectionInfos[SA->getName()];
2308     if ((SI.SectionFlags & ASTContext::PSF_Write) == 0)
2309       GV->setConstant(true);
2310   }
2311 
2312   GV->setAlignment(getContext().getDeclAlign(D).getQuantity());
2313 
2314   // Set the llvm linkage type as appropriate.
2315   llvm::GlobalValue::LinkageTypes Linkage =
2316       getLLVMLinkageVarDefinition(D, GV->isConstant());
2317 
2318   // On Darwin, the backing variable for a C++11 thread_local variable always
2319   // has internal linkage; all accesses should just be calls to the
2320   // Itanium-specified entry point, which has the normal linkage of the
2321   // variable.
2322   if (!D->isStaticLocal() && D->getTLSKind() == VarDecl::TLS_Dynamic &&
2323       Context.getTargetInfo().getTriple().isMacOSX())
2324     Linkage = llvm::GlobalValue::InternalLinkage;
2325 
2326   GV->setLinkage(Linkage);
2327   if (D->hasAttr<DLLImportAttr>())
2328     GV->setDLLStorageClass(llvm::GlobalVariable::DLLImportStorageClass);
2329   else if (D->hasAttr<DLLExportAttr>())
2330     GV->setDLLStorageClass(llvm::GlobalVariable::DLLExportStorageClass);
2331   else
2332     GV->setDLLStorageClass(llvm::GlobalVariable::DefaultStorageClass);
2333 
2334   if (Linkage == llvm::GlobalVariable::CommonLinkage)
2335     // common vars aren't constant even if declared const.
2336     GV->setConstant(false);
2337 
2338   setNonAliasAttributes(D, GV);
2339 
2340   if (D->getTLSKind() && !GV->isThreadLocal()) {
2341     if (D->getTLSKind() == VarDecl::TLS_Dynamic)
2342       CXXThreadLocals.push_back(std::make_pair(D, GV));
2343     setTLSMode(GV, *D);
2344   }
2345 
2346   maybeSetTrivialComdat(*D, *GV);
2347 
2348   // Emit the initializer function if necessary.
2349   if (NeedsGlobalCtor || NeedsGlobalDtor)
2350     EmitCXXGlobalVarDeclInitFunc(D, GV, NeedsGlobalCtor);
2351 
2352   SanitizerMD->reportGlobalToASan(GV, *D, NeedsGlobalCtor);
2353 
2354   // Emit global variable debug information.
2355   if (CGDebugInfo *DI = getModuleDebugInfo())
2356     if (getCodeGenOpts().getDebugInfo() >= CodeGenOptions::LimitedDebugInfo)
2357       DI->EmitGlobalVariable(GV, D);
2358 }
2359 
2360 static bool isVarDeclStrongDefinition(const ASTContext &Context,
2361                                       CodeGenModule &CGM, const VarDecl *D,
2362                                       bool NoCommon) {
2363   // Don't give variables common linkage if -fno-common was specified unless it
2364   // was overridden by a NoCommon attribute.
2365   if ((NoCommon || D->hasAttr<NoCommonAttr>()) && !D->hasAttr<CommonAttr>())
2366     return true;
2367 
2368   // C11 6.9.2/2:
2369   //   A declaration of an identifier for an object that has file scope without
2370   //   an initializer, and without a storage-class specifier or with the
2371   //   storage-class specifier static, constitutes a tentative definition.
2372   if (D->getInit() || D->hasExternalStorage())
2373     return true;
2374 
2375   // A variable cannot be both common and exist in a section.
2376   if (D->hasAttr<SectionAttr>())
2377     return true;
2378 
2379   // Thread local vars aren't considered common linkage.
2380   if (D->getTLSKind())
2381     return true;
2382 
2383   // Tentative definitions marked with WeakImportAttr are true definitions.
2384   if (D->hasAttr<WeakImportAttr>())
2385     return true;
2386 
2387   // A variable cannot be both common and exist in a comdat.
2388   if (shouldBeInCOMDAT(CGM, *D))
2389     return true;
2390 
2391   // Declarations with a required alignment do not have common linakge in MSVC
2392   // mode.
2393   if (Context.getTargetInfo().getCXXABI().isMicrosoft()) {
2394     if (D->hasAttr<AlignedAttr>())
2395       return true;
2396     QualType VarType = D->getType();
2397     if (Context.isAlignmentRequired(VarType))
2398       return true;
2399 
2400     if (const auto *RT = VarType->getAs<RecordType>()) {
2401       const RecordDecl *RD = RT->getDecl();
2402       for (const FieldDecl *FD : RD->fields()) {
2403         if (FD->isBitField())
2404           continue;
2405         if (FD->hasAttr<AlignedAttr>())
2406           return true;
2407         if (Context.isAlignmentRequired(FD->getType()))
2408           return true;
2409       }
2410     }
2411   }
2412 
2413   return false;
2414 }
2415 
2416 llvm::GlobalValue::LinkageTypes CodeGenModule::getLLVMLinkageForDeclarator(
2417     const DeclaratorDecl *D, GVALinkage Linkage, bool IsConstantVariable) {
2418   if (Linkage == GVA_Internal)
2419     return llvm::Function::InternalLinkage;
2420 
2421   if (D->hasAttr<WeakAttr>()) {
2422     if (IsConstantVariable)
2423       return llvm::GlobalVariable::WeakODRLinkage;
2424     else
2425       return llvm::GlobalVariable::WeakAnyLinkage;
2426   }
2427 
2428   // We are guaranteed to have a strong definition somewhere else,
2429   // so we can use available_externally linkage.
2430   if (Linkage == GVA_AvailableExternally)
2431     return llvm::Function::AvailableExternallyLinkage;
2432 
2433   // Note that Apple's kernel linker doesn't support symbol
2434   // coalescing, so we need to avoid linkonce and weak linkages there.
2435   // Normally, this means we just map to internal, but for explicit
2436   // instantiations we'll map to external.
2437 
2438   // In C++, the compiler has to emit a definition in every translation unit
2439   // that references the function.  We should use linkonce_odr because
2440   // a) if all references in this translation unit are optimized away, we
2441   // don't need to codegen it.  b) if the function persists, it needs to be
2442   // merged with other definitions. c) C++ has the ODR, so we know the
2443   // definition is dependable.
2444   if (Linkage == GVA_DiscardableODR)
2445     return !Context.getLangOpts().AppleKext ? llvm::Function::LinkOnceODRLinkage
2446                                             : llvm::Function::InternalLinkage;
2447 
2448   // An explicit instantiation of a template has weak linkage, since
2449   // explicit instantiations can occur in multiple translation units
2450   // and must all be equivalent. However, we are not allowed to
2451   // throw away these explicit instantiations.
2452   if (Linkage == GVA_StrongODR)
2453     return !Context.getLangOpts().AppleKext ? llvm::Function::WeakODRLinkage
2454                                             : llvm::Function::ExternalLinkage;
2455 
2456   // C++ doesn't have tentative definitions and thus cannot have common
2457   // linkage.
2458   if (!getLangOpts().CPlusPlus && isa<VarDecl>(D) &&
2459       !isVarDeclStrongDefinition(Context, *this, cast<VarDecl>(D),
2460                                  CodeGenOpts.NoCommon))
2461     return llvm::GlobalVariable::CommonLinkage;
2462 
2463   // selectany symbols are externally visible, so use weak instead of
2464   // linkonce.  MSVC optimizes away references to const selectany globals, so
2465   // all definitions should be the same and ODR linkage should be used.
2466   // http://msdn.microsoft.com/en-us/library/5tkz6s71.aspx
2467   if (D->hasAttr<SelectAnyAttr>())
2468     return llvm::GlobalVariable::WeakODRLinkage;
2469 
2470   // Otherwise, we have strong external linkage.
2471   assert(Linkage == GVA_StrongExternal);
2472   return llvm::GlobalVariable::ExternalLinkage;
2473 }
2474 
2475 llvm::GlobalValue::LinkageTypes CodeGenModule::getLLVMLinkageVarDefinition(
2476     const VarDecl *VD, bool IsConstant) {
2477   GVALinkage Linkage = getContext().GetGVALinkageForVariable(VD);
2478   return getLLVMLinkageForDeclarator(VD, Linkage, IsConstant);
2479 }
2480 
2481 /// Replace the uses of a function that was declared with a non-proto type.
2482 /// We want to silently drop extra arguments from call sites
2483 static void replaceUsesOfNonProtoConstant(llvm::Constant *old,
2484                                           llvm::Function *newFn) {
2485   // Fast path.
2486   if (old->use_empty()) return;
2487 
2488   llvm::Type *newRetTy = newFn->getReturnType();
2489   SmallVector<llvm::Value*, 4> newArgs;
2490 
2491   for (llvm::Value::use_iterator ui = old->use_begin(), ue = old->use_end();
2492          ui != ue; ) {
2493     llvm::Value::use_iterator use = ui++; // Increment before the use is erased.
2494     llvm::User *user = use->getUser();
2495 
2496     // Recognize and replace uses of bitcasts.  Most calls to
2497     // unprototyped functions will use bitcasts.
2498     if (auto *bitcast = dyn_cast<llvm::ConstantExpr>(user)) {
2499       if (bitcast->getOpcode() == llvm::Instruction::BitCast)
2500         replaceUsesOfNonProtoConstant(bitcast, newFn);
2501       continue;
2502     }
2503 
2504     // Recognize calls to the function.
2505     llvm::CallSite callSite(user);
2506     if (!callSite) continue;
2507     if (!callSite.isCallee(&*use)) continue;
2508 
2509     // If the return types don't match exactly, then we can't
2510     // transform this call unless it's dead.
2511     if (callSite->getType() != newRetTy && !callSite->use_empty())
2512       continue;
2513 
2514     // Get the call site's attribute list.
2515     SmallVector<llvm::AttributeSet, 8> newAttrs;
2516     llvm::AttributeSet oldAttrs = callSite.getAttributes();
2517 
2518     // Collect any return attributes from the call.
2519     if (oldAttrs.hasAttributes(llvm::AttributeSet::ReturnIndex))
2520       newAttrs.push_back(
2521         llvm::AttributeSet::get(newFn->getContext(),
2522                                 oldAttrs.getRetAttributes()));
2523 
2524     // If the function was passed too few arguments, don't transform.
2525     unsigned newNumArgs = newFn->arg_size();
2526     if (callSite.arg_size() < newNumArgs) continue;
2527 
2528     // If extra arguments were passed, we silently drop them.
2529     // If any of the types mismatch, we don't transform.
2530     unsigned argNo = 0;
2531     bool dontTransform = false;
2532     for (llvm::Function::arg_iterator ai = newFn->arg_begin(),
2533            ae = newFn->arg_end(); ai != ae; ++ai, ++argNo) {
2534       if (callSite.getArgument(argNo)->getType() != ai->getType()) {
2535         dontTransform = true;
2536         break;
2537       }
2538 
2539       // Add any parameter attributes.
2540       if (oldAttrs.hasAttributes(argNo + 1))
2541         newAttrs.
2542           push_back(llvm::
2543                     AttributeSet::get(newFn->getContext(),
2544                                       oldAttrs.getParamAttributes(argNo + 1)));
2545     }
2546     if (dontTransform)
2547       continue;
2548 
2549     if (oldAttrs.hasAttributes(llvm::AttributeSet::FunctionIndex))
2550       newAttrs.push_back(llvm::AttributeSet::get(newFn->getContext(),
2551                                                  oldAttrs.getFnAttributes()));
2552 
2553     // Okay, we can transform this.  Create the new call instruction and copy
2554     // over the required information.
2555     newArgs.append(callSite.arg_begin(), callSite.arg_begin() + argNo);
2556 
2557     llvm::CallSite newCall;
2558     if (callSite.isCall()) {
2559       newCall = llvm::CallInst::Create(newFn, newArgs, "",
2560                                        callSite.getInstruction());
2561     } else {
2562       auto *oldInvoke = cast<llvm::InvokeInst>(callSite.getInstruction());
2563       newCall = llvm::InvokeInst::Create(newFn,
2564                                          oldInvoke->getNormalDest(),
2565                                          oldInvoke->getUnwindDest(),
2566                                          newArgs, "",
2567                                          callSite.getInstruction());
2568     }
2569     newArgs.clear(); // for the next iteration
2570 
2571     if (!newCall->getType()->isVoidTy())
2572       newCall->takeName(callSite.getInstruction());
2573     newCall.setAttributes(
2574                      llvm::AttributeSet::get(newFn->getContext(), newAttrs));
2575     newCall.setCallingConv(callSite.getCallingConv());
2576 
2577     // Finally, remove the old call, replacing any uses with the new one.
2578     if (!callSite->use_empty())
2579       callSite->replaceAllUsesWith(newCall.getInstruction());
2580 
2581     // Copy debug location attached to CI.
2582     if (callSite->getDebugLoc())
2583       newCall->setDebugLoc(callSite->getDebugLoc());
2584     callSite->eraseFromParent();
2585   }
2586 }
2587 
2588 /// ReplaceUsesOfNonProtoTypeWithRealFunction - This function is called when we
2589 /// implement a function with no prototype, e.g. "int foo() {}".  If there are
2590 /// existing call uses of the old function in the module, this adjusts them to
2591 /// call the new function directly.
2592 ///
2593 /// This is not just a cleanup: the always_inline pass requires direct calls to
2594 /// functions to be able to inline them.  If there is a bitcast in the way, it
2595 /// won't inline them.  Instcombine normally deletes these calls, but it isn't
2596 /// run at -O0.
2597 static void ReplaceUsesOfNonProtoTypeWithRealFunction(llvm::GlobalValue *Old,
2598                                                       llvm::Function *NewFn) {
2599   // If we're redefining a global as a function, don't transform it.
2600   if (!isa<llvm::Function>(Old)) return;
2601 
2602   replaceUsesOfNonProtoConstant(Old, NewFn);
2603 }
2604 
2605 void CodeGenModule::HandleCXXStaticMemberVarInstantiation(VarDecl *VD) {
2606   TemplateSpecializationKind TSK = VD->getTemplateSpecializationKind();
2607   // If we have a definition, this might be a deferred decl. If the
2608   // instantiation is explicit, make sure we emit it at the end.
2609   if (VD->getDefinition() && TSK == TSK_ExplicitInstantiationDefinition)
2610     GetAddrOfGlobalVar(VD);
2611 
2612   EmitTopLevelDecl(VD);
2613 }
2614 
2615 void CodeGenModule::EmitGlobalFunctionDefinition(GlobalDecl GD,
2616                                                  llvm::GlobalValue *GV) {
2617   const auto *D = cast<FunctionDecl>(GD.getDecl());
2618 
2619   // Compute the function info and LLVM type.
2620   const CGFunctionInfo &FI = getTypes().arrangeGlobalDeclaration(GD);
2621   llvm::FunctionType *Ty = getTypes().GetFunctionType(FI);
2622 
2623   // Get or create the prototype for the function.
2624   if (!GV || (GV->getType()->getElementType() != Ty))
2625     GV = cast<llvm::GlobalValue>(GetAddrOfFunction(GD, Ty, /*ForVTable=*/false,
2626                                                    /*DontDefer=*/true,
2627                                                    /*IsForDefinition=*/true));
2628 
2629   // Already emitted.
2630   if (!GV->isDeclaration())
2631     return;
2632 
2633   // We need to set linkage and visibility on the function before
2634   // generating code for it because various parts of IR generation
2635   // want to propagate this information down (e.g. to local static
2636   // declarations).
2637   auto *Fn = cast<llvm::Function>(GV);
2638   setFunctionLinkage(GD, Fn);
2639   setFunctionDLLStorageClass(GD, Fn);
2640 
2641   // FIXME: this is redundant with part of setFunctionDefinitionAttributes
2642   setGlobalVisibility(Fn, D);
2643 
2644   MaybeHandleStaticInExternC(D, Fn);
2645 
2646   maybeSetTrivialComdat(*D, *Fn);
2647 
2648   CodeGenFunction(*this).GenerateCode(D, Fn, FI);
2649 
2650   setFunctionDefinitionAttributes(D, Fn);
2651   SetLLVMFunctionAttributesForDefinition(D, Fn);
2652 
2653   if (const ConstructorAttr *CA = D->getAttr<ConstructorAttr>())
2654     AddGlobalCtor(Fn, CA->getPriority());
2655   if (const DestructorAttr *DA = D->getAttr<DestructorAttr>())
2656     AddGlobalDtor(Fn, DA->getPriority());
2657   if (D->hasAttr<AnnotateAttr>())
2658     AddGlobalAnnotations(D, Fn);
2659 }
2660 
2661 void CodeGenModule::EmitAliasDefinition(GlobalDecl GD) {
2662   const auto *D = cast<ValueDecl>(GD.getDecl());
2663   const AliasAttr *AA = D->getAttr<AliasAttr>();
2664   assert(AA && "Not an alias?");
2665 
2666   StringRef MangledName = getMangledName(GD);
2667 
2668   if (AA->getAliasee() == MangledName) {
2669     Diags.Report(AA->getLocation(), diag::err_cyclic_alias);
2670     return;
2671   }
2672 
2673   // If there is a definition in the module, then it wins over the alias.
2674   // This is dubious, but allow it to be safe.  Just ignore the alias.
2675   llvm::GlobalValue *Entry = GetGlobalValue(MangledName);
2676   if (Entry && !Entry->isDeclaration())
2677     return;
2678 
2679   Aliases.push_back(GD);
2680 
2681   llvm::Type *DeclTy = getTypes().ConvertTypeForMem(D->getType());
2682 
2683   // Create a reference to the named value.  This ensures that it is emitted
2684   // if a deferred decl.
2685   llvm::Constant *Aliasee;
2686   if (isa<llvm::FunctionType>(DeclTy))
2687     Aliasee = GetOrCreateLLVMFunction(AA->getAliasee(), DeclTy, GD,
2688                                       /*ForVTable=*/false);
2689   else
2690     Aliasee = GetOrCreateLLVMGlobal(AA->getAliasee(),
2691                                     llvm::PointerType::getUnqual(DeclTy),
2692                                     /*D=*/nullptr);
2693 
2694   // Create the new alias itself, but don't set a name yet.
2695   auto *GA = llvm::GlobalAlias::create(
2696       DeclTy, 0, llvm::Function::ExternalLinkage, "", Aliasee, &getModule());
2697 
2698   if (Entry) {
2699     if (GA->getAliasee() == Entry) {
2700       Diags.Report(AA->getLocation(), diag::err_cyclic_alias);
2701       return;
2702     }
2703 
2704     assert(Entry->isDeclaration());
2705 
2706     // If there is a declaration in the module, then we had an extern followed
2707     // by the alias, as in:
2708     //   extern int test6();
2709     //   ...
2710     //   int test6() __attribute__((alias("test7")));
2711     //
2712     // Remove it and replace uses of it with the alias.
2713     GA->takeName(Entry);
2714 
2715     Entry->replaceAllUsesWith(llvm::ConstantExpr::getBitCast(GA,
2716                                                           Entry->getType()));
2717     Entry->eraseFromParent();
2718   } else {
2719     GA->setName(MangledName);
2720   }
2721 
2722   // Set attributes which are particular to an alias; this is a
2723   // specialization of the attributes which may be set on a global
2724   // variable/function.
2725   if (D->hasAttr<WeakAttr>() || D->hasAttr<WeakRefAttr>() ||
2726       D->isWeakImported()) {
2727     GA->setLinkage(llvm::Function::WeakAnyLinkage);
2728   }
2729 
2730   if (const auto *VD = dyn_cast<VarDecl>(D))
2731     if (VD->getTLSKind())
2732       setTLSMode(GA, *VD);
2733 
2734   setAliasAttributes(D, GA);
2735 }
2736 
2737 llvm::Function *CodeGenModule::getIntrinsic(unsigned IID,
2738                                             ArrayRef<llvm::Type*> Tys) {
2739   return llvm::Intrinsic::getDeclaration(&getModule(), (llvm::Intrinsic::ID)IID,
2740                                          Tys);
2741 }
2742 
2743 static llvm::StringMapEntry<llvm::GlobalVariable *> &
2744 GetConstantCFStringEntry(llvm::StringMap<llvm::GlobalVariable *> &Map,
2745                          const StringLiteral *Literal, bool TargetIsLSB,
2746                          bool &IsUTF16, unsigned &StringLength) {
2747   StringRef String = Literal->getString();
2748   unsigned NumBytes = String.size();
2749 
2750   // Check for simple case.
2751   if (!Literal->containsNonAsciiOrNull()) {
2752     StringLength = NumBytes;
2753     return *Map.insert(std::make_pair(String, nullptr)).first;
2754   }
2755 
2756   // Otherwise, convert the UTF8 literals into a string of shorts.
2757   IsUTF16 = true;
2758 
2759   SmallVector<UTF16, 128> ToBuf(NumBytes + 1); // +1 for ending nulls.
2760   const UTF8 *FromPtr = (const UTF8 *)String.data();
2761   UTF16 *ToPtr = &ToBuf[0];
2762 
2763   (void)ConvertUTF8toUTF16(&FromPtr, FromPtr + NumBytes,
2764                            &ToPtr, ToPtr + NumBytes,
2765                            strictConversion);
2766 
2767   // ConvertUTF8toUTF16 returns the length in ToPtr.
2768   StringLength = ToPtr - &ToBuf[0];
2769 
2770   // Add an explicit null.
2771   *ToPtr = 0;
2772   return *Map.insert(std::make_pair(
2773                          StringRef(reinterpret_cast<const char *>(ToBuf.data()),
2774                                    (StringLength + 1) * 2),
2775                          nullptr)).first;
2776 }
2777 
2778 static llvm::StringMapEntry<llvm::GlobalVariable *> &
2779 GetConstantStringEntry(llvm::StringMap<llvm::GlobalVariable *> &Map,
2780                        const StringLiteral *Literal, unsigned &StringLength) {
2781   StringRef String = Literal->getString();
2782   StringLength = String.size();
2783   return *Map.insert(std::make_pair(String, nullptr)).first;
2784 }
2785 
2786 ConstantAddress
2787 CodeGenModule::GetAddrOfConstantCFString(const StringLiteral *Literal) {
2788   unsigned StringLength = 0;
2789   bool isUTF16 = false;
2790   llvm::StringMapEntry<llvm::GlobalVariable *> &Entry =
2791       GetConstantCFStringEntry(CFConstantStringMap, Literal,
2792                                getDataLayout().isLittleEndian(), isUTF16,
2793                                StringLength);
2794 
2795   if (auto *C = Entry.second)
2796     return ConstantAddress(C, CharUnits::fromQuantity(C->getAlignment()));
2797 
2798   llvm::Constant *Zero = llvm::Constant::getNullValue(Int32Ty);
2799   llvm::Constant *Zeros[] = { Zero, Zero };
2800   llvm::Value *V;
2801 
2802   // If we don't already have it, get __CFConstantStringClassReference.
2803   if (!CFConstantStringClassRef) {
2804     llvm::Type *Ty = getTypes().ConvertType(getContext().IntTy);
2805     Ty = llvm::ArrayType::get(Ty, 0);
2806     llvm::Constant *GV = CreateRuntimeVariable(Ty,
2807                                            "__CFConstantStringClassReference");
2808     // Decay array -> ptr
2809     V = llvm::ConstantExpr::getGetElementPtr(Ty, GV, Zeros);
2810     CFConstantStringClassRef = V;
2811   }
2812   else
2813     V = CFConstantStringClassRef;
2814 
2815   QualType CFTy = getContext().getCFConstantStringType();
2816 
2817   auto *STy = cast<llvm::StructType>(getTypes().ConvertType(CFTy));
2818 
2819   llvm::Constant *Fields[4];
2820 
2821   // Class pointer.
2822   Fields[0] = cast<llvm::ConstantExpr>(V);
2823 
2824   // Flags.
2825   llvm::Type *Ty = getTypes().ConvertType(getContext().UnsignedIntTy);
2826   Fields[1] = isUTF16 ? llvm::ConstantInt::get(Ty, 0x07d0) :
2827     llvm::ConstantInt::get(Ty, 0x07C8);
2828 
2829   // String pointer.
2830   llvm::Constant *C = nullptr;
2831   if (isUTF16) {
2832     auto Arr = llvm::makeArrayRef(
2833         reinterpret_cast<uint16_t *>(const_cast<char *>(Entry.first().data())),
2834         Entry.first().size() / 2);
2835     C = llvm::ConstantDataArray::get(VMContext, Arr);
2836   } else {
2837     C = llvm::ConstantDataArray::getString(VMContext, Entry.first());
2838   }
2839 
2840   // Note: -fwritable-strings doesn't make the backing store strings of
2841   // CFStrings writable. (See <rdar://problem/10657500>)
2842   auto *GV =
2843       new llvm::GlobalVariable(getModule(), C->getType(), /*isConstant=*/true,
2844                                llvm::GlobalValue::PrivateLinkage, C, ".str");
2845   GV->setUnnamedAddr(true);
2846   // Don't enforce the target's minimum global alignment, since the only use
2847   // of the string is via this class initializer.
2848   // FIXME: We set the section explicitly to avoid a bug in ld64 224.1. Without
2849   // it LLVM can merge the string with a non unnamed_addr one during LTO. Doing
2850   // that changes the section it ends in, which surprises ld64.
2851   if (isUTF16) {
2852     CharUnits Align = getContext().getTypeAlignInChars(getContext().ShortTy);
2853     GV->setAlignment(Align.getQuantity());
2854     GV->setSection("__TEXT,__ustring");
2855   } else {
2856     CharUnits Align = getContext().getTypeAlignInChars(getContext().CharTy);
2857     GV->setAlignment(Align.getQuantity());
2858     GV->setSection("__TEXT,__cstring,cstring_literals");
2859   }
2860 
2861   // String.
2862   Fields[2] =
2863       llvm::ConstantExpr::getGetElementPtr(GV->getValueType(), GV, Zeros);
2864 
2865   if (isUTF16)
2866     // Cast the UTF16 string to the correct type.
2867     Fields[2] = llvm::ConstantExpr::getBitCast(Fields[2], Int8PtrTy);
2868 
2869   // String length.
2870   Ty = getTypes().ConvertType(getContext().LongTy);
2871   Fields[3] = llvm::ConstantInt::get(Ty, StringLength);
2872 
2873   CharUnits Alignment = getPointerAlign();
2874 
2875   // The struct.
2876   C = llvm::ConstantStruct::get(STy, Fields);
2877   GV = new llvm::GlobalVariable(getModule(), C->getType(), true,
2878                                 llvm::GlobalVariable::PrivateLinkage, C,
2879                                 "_unnamed_cfstring_");
2880   GV->setSection("__DATA,__cfstring");
2881   GV->setAlignment(Alignment.getQuantity());
2882   Entry.second = GV;
2883 
2884   return ConstantAddress(GV, Alignment);
2885 }
2886 
2887 ConstantAddress
2888 CodeGenModule::GetAddrOfConstantString(const StringLiteral *Literal) {
2889   unsigned StringLength = 0;
2890   llvm::StringMapEntry<llvm::GlobalVariable *> &Entry =
2891       GetConstantStringEntry(CFConstantStringMap, Literal, StringLength);
2892 
2893   if (auto *C = Entry.second)
2894     return ConstantAddress(C, CharUnits::fromQuantity(C->getAlignment()));
2895 
2896   llvm::Constant *Zero = llvm::Constant::getNullValue(Int32Ty);
2897   llvm::Constant *Zeros[] = { Zero, Zero };
2898   llvm::Value *V;
2899   // If we don't already have it, get _NSConstantStringClassReference.
2900   if (!ConstantStringClassRef) {
2901     std::string StringClass(getLangOpts().ObjCConstantStringClass);
2902     llvm::Type *Ty = getTypes().ConvertType(getContext().IntTy);
2903     llvm::Constant *GV;
2904     if (LangOpts.ObjCRuntime.isNonFragile()) {
2905       std::string str =
2906         StringClass.empty() ? "OBJC_CLASS_$_NSConstantString"
2907                             : "OBJC_CLASS_$_" + StringClass;
2908       GV = getObjCRuntime().GetClassGlobal(str);
2909       // Make sure the result is of the correct type.
2910       llvm::Type *PTy = llvm::PointerType::getUnqual(Ty);
2911       V = llvm::ConstantExpr::getBitCast(GV, PTy);
2912       ConstantStringClassRef = V;
2913     } else {
2914       std::string str =
2915         StringClass.empty() ? "_NSConstantStringClassReference"
2916                             : "_" + StringClass + "ClassReference";
2917       llvm::Type *PTy = llvm::ArrayType::get(Ty, 0);
2918       GV = CreateRuntimeVariable(PTy, str);
2919       // Decay array -> ptr
2920       V = llvm::ConstantExpr::getGetElementPtr(PTy, GV, Zeros);
2921       ConstantStringClassRef = V;
2922     }
2923   } else
2924     V = ConstantStringClassRef;
2925 
2926   if (!NSConstantStringType) {
2927     // Construct the type for a constant NSString.
2928     RecordDecl *D = Context.buildImplicitRecord("__builtin_NSString");
2929     D->startDefinition();
2930 
2931     QualType FieldTypes[3];
2932 
2933     // const int *isa;
2934     FieldTypes[0] = Context.getPointerType(Context.IntTy.withConst());
2935     // const char *str;
2936     FieldTypes[1] = Context.getPointerType(Context.CharTy.withConst());
2937     // unsigned int length;
2938     FieldTypes[2] = Context.UnsignedIntTy;
2939 
2940     // Create fields
2941     for (unsigned i = 0; i < 3; ++i) {
2942       FieldDecl *Field = FieldDecl::Create(Context, D,
2943                                            SourceLocation(),
2944                                            SourceLocation(), nullptr,
2945                                            FieldTypes[i], /*TInfo=*/nullptr,
2946                                            /*BitWidth=*/nullptr,
2947                                            /*Mutable=*/false,
2948                                            ICIS_NoInit);
2949       Field->setAccess(AS_public);
2950       D->addDecl(Field);
2951     }
2952 
2953     D->completeDefinition();
2954     QualType NSTy = Context.getTagDeclType(D);
2955     NSConstantStringType = cast<llvm::StructType>(getTypes().ConvertType(NSTy));
2956   }
2957 
2958   llvm::Constant *Fields[3];
2959 
2960   // Class pointer.
2961   Fields[0] = cast<llvm::ConstantExpr>(V);
2962 
2963   // String pointer.
2964   llvm::Constant *C =
2965       llvm::ConstantDataArray::getString(VMContext, Entry.first());
2966 
2967   llvm::GlobalValue::LinkageTypes Linkage;
2968   bool isConstant;
2969   Linkage = llvm::GlobalValue::PrivateLinkage;
2970   isConstant = !LangOpts.WritableStrings;
2971 
2972   auto *GV = new llvm::GlobalVariable(getModule(), C->getType(), isConstant,
2973                                       Linkage, C, ".str");
2974   GV->setUnnamedAddr(true);
2975   // Don't enforce the target's minimum global alignment, since the only use
2976   // of the string is via this class initializer.
2977   CharUnits Align = getContext().getTypeAlignInChars(getContext().CharTy);
2978   GV->setAlignment(Align.getQuantity());
2979   Fields[1] =
2980       llvm::ConstantExpr::getGetElementPtr(GV->getValueType(), GV, Zeros);
2981 
2982   // String length.
2983   llvm::Type *Ty = getTypes().ConvertType(getContext().UnsignedIntTy);
2984   Fields[2] = llvm::ConstantInt::get(Ty, StringLength);
2985 
2986   // The struct.
2987   CharUnits Alignment = getPointerAlign();
2988   C = llvm::ConstantStruct::get(NSConstantStringType, Fields);
2989   GV = new llvm::GlobalVariable(getModule(), C->getType(), true,
2990                                 llvm::GlobalVariable::PrivateLinkage, C,
2991                                 "_unnamed_nsstring_");
2992   GV->setAlignment(Alignment.getQuantity());
2993   const char *NSStringSection = "__OBJC,__cstring_object,regular,no_dead_strip";
2994   const char *NSStringNonFragileABISection =
2995       "__DATA,__objc_stringobj,regular,no_dead_strip";
2996   // FIXME. Fix section.
2997   GV->setSection(LangOpts.ObjCRuntime.isNonFragile()
2998                      ? NSStringNonFragileABISection
2999                      : NSStringSection);
3000   Entry.second = GV;
3001 
3002   return ConstantAddress(GV, Alignment);
3003 }
3004 
3005 QualType CodeGenModule::getObjCFastEnumerationStateType() {
3006   if (ObjCFastEnumerationStateType.isNull()) {
3007     RecordDecl *D = Context.buildImplicitRecord("__objcFastEnumerationState");
3008     D->startDefinition();
3009 
3010     QualType FieldTypes[] = {
3011       Context.UnsignedLongTy,
3012       Context.getPointerType(Context.getObjCIdType()),
3013       Context.getPointerType(Context.UnsignedLongTy),
3014       Context.getConstantArrayType(Context.UnsignedLongTy,
3015                            llvm::APInt(32, 5), ArrayType::Normal, 0)
3016     };
3017 
3018     for (size_t i = 0; i < 4; ++i) {
3019       FieldDecl *Field = FieldDecl::Create(Context,
3020                                            D,
3021                                            SourceLocation(),
3022                                            SourceLocation(), nullptr,
3023                                            FieldTypes[i], /*TInfo=*/nullptr,
3024                                            /*BitWidth=*/nullptr,
3025                                            /*Mutable=*/false,
3026                                            ICIS_NoInit);
3027       Field->setAccess(AS_public);
3028       D->addDecl(Field);
3029     }
3030 
3031     D->completeDefinition();
3032     ObjCFastEnumerationStateType = Context.getTagDeclType(D);
3033   }
3034 
3035   return ObjCFastEnumerationStateType;
3036 }
3037 
3038 llvm::Constant *
3039 CodeGenModule::GetConstantArrayFromStringLiteral(const StringLiteral *E) {
3040   assert(!E->getType()->isPointerType() && "Strings are always arrays");
3041 
3042   // Don't emit it as the address of the string, emit the string data itself
3043   // as an inline array.
3044   if (E->getCharByteWidth() == 1) {
3045     SmallString<64> Str(E->getString());
3046 
3047     // Resize the string to the right size, which is indicated by its type.
3048     const ConstantArrayType *CAT = Context.getAsConstantArrayType(E->getType());
3049     Str.resize(CAT->getSize().getZExtValue());
3050     return llvm::ConstantDataArray::getString(VMContext, Str, false);
3051   }
3052 
3053   auto *AType = cast<llvm::ArrayType>(getTypes().ConvertType(E->getType()));
3054   llvm::Type *ElemTy = AType->getElementType();
3055   unsigned NumElements = AType->getNumElements();
3056 
3057   // Wide strings have either 2-byte or 4-byte elements.
3058   if (ElemTy->getPrimitiveSizeInBits() == 16) {
3059     SmallVector<uint16_t, 32> Elements;
3060     Elements.reserve(NumElements);
3061 
3062     for(unsigned i = 0, e = E->getLength(); i != e; ++i)
3063       Elements.push_back(E->getCodeUnit(i));
3064     Elements.resize(NumElements);
3065     return llvm::ConstantDataArray::get(VMContext, Elements);
3066   }
3067 
3068   assert(ElemTy->getPrimitiveSizeInBits() == 32);
3069   SmallVector<uint32_t, 32> Elements;
3070   Elements.reserve(NumElements);
3071 
3072   for(unsigned i = 0, e = E->getLength(); i != e; ++i)
3073     Elements.push_back(E->getCodeUnit(i));
3074   Elements.resize(NumElements);
3075   return llvm::ConstantDataArray::get(VMContext, Elements);
3076 }
3077 
3078 static llvm::GlobalVariable *
3079 GenerateStringLiteral(llvm::Constant *C, llvm::GlobalValue::LinkageTypes LT,
3080                       CodeGenModule &CGM, StringRef GlobalName,
3081                       CharUnits Alignment) {
3082   // OpenCL v1.2 s6.5.3: a string literal is in the constant address space.
3083   unsigned AddrSpace = 0;
3084   if (CGM.getLangOpts().OpenCL)
3085     AddrSpace = CGM.getContext().getTargetAddressSpace(LangAS::opencl_constant);
3086 
3087   llvm::Module &M = CGM.getModule();
3088   // Create a global variable for this string
3089   auto *GV = new llvm::GlobalVariable(
3090       M, C->getType(), !CGM.getLangOpts().WritableStrings, LT, C, GlobalName,
3091       nullptr, llvm::GlobalVariable::NotThreadLocal, AddrSpace);
3092   GV->setAlignment(Alignment.getQuantity());
3093   GV->setUnnamedAddr(true);
3094   if (GV->isWeakForLinker()) {
3095     assert(CGM.supportsCOMDAT() && "Only COFF uses weak string literals");
3096     GV->setComdat(M.getOrInsertComdat(GV->getName()));
3097   }
3098 
3099   return GV;
3100 }
3101 
3102 /// GetAddrOfConstantStringFromLiteral - Return a pointer to a
3103 /// constant array for the given string literal.
3104 ConstantAddress
3105 CodeGenModule::GetAddrOfConstantStringFromLiteral(const StringLiteral *S,
3106                                                   StringRef Name) {
3107   CharUnits Alignment = getContext().getAlignOfGlobalVarInChars(S->getType());
3108 
3109   llvm::Constant *C = GetConstantArrayFromStringLiteral(S);
3110   llvm::GlobalVariable **Entry = nullptr;
3111   if (!LangOpts.WritableStrings) {
3112     Entry = &ConstantStringMap[C];
3113     if (auto GV = *Entry) {
3114       if (Alignment.getQuantity() > GV->getAlignment())
3115         GV->setAlignment(Alignment.getQuantity());
3116       return ConstantAddress(GV, Alignment);
3117     }
3118   }
3119 
3120   SmallString<256> MangledNameBuffer;
3121   StringRef GlobalVariableName;
3122   llvm::GlobalValue::LinkageTypes LT;
3123 
3124   // Mangle the string literal if the ABI allows for it.  However, we cannot
3125   // do this if  we are compiling with ASan or -fwritable-strings because they
3126   // rely on strings having normal linkage.
3127   if (!LangOpts.WritableStrings &&
3128       !LangOpts.Sanitize.has(SanitizerKind::Address) &&
3129       getCXXABI().getMangleContext().shouldMangleStringLiteral(S)) {
3130     llvm::raw_svector_ostream Out(MangledNameBuffer);
3131     getCXXABI().getMangleContext().mangleStringLiteral(S, Out);
3132 
3133     LT = llvm::GlobalValue::LinkOnceODRLinkage;
3134     GlobalVariableName = MangledNameBuffer;
3135   } else {
3136     LT = llvm::GlobalValue::PrivateLinkage;
3137     GlobalVariableName = Name;
3138   }
3139 
3140   auto GV = GenerateStringLiteral(C, LT, *this, GlobalVariableName, Alignment);
3141   if (Entry)
3142     *Entry = GV;
3143 
3144   SanitizerMD->reportGlobalToASan(GV, S->getStrTokenLoc(0), "<string literal>",
3145                                   QualType());
3146   return ConstantAddress(GV, Alignment);
3147 }
3148 
3149 /// GetAddrOfConstantStringFromObjCEncode - Return a pointer to a constant
3150 /// array for the given ObjCEncodeExpr node.
3151 ConstantAddress
3152 CodeGenModule::GetAddrOfConstantStringFromObjCEncode(const ObjCEncodeExpr *E) {
3153   std::string Str;
3154   getContext().getObjCEncodingForType(E->getEncodedType(), Str);
3155 
3156   return GetAddrOfConstantCString(Str);
3157 }
3158 
3159 /// GetAddrOfConstantCString - Returns a pointer to a character array containing
3160 /// the literal and a terminating '\0' character.
3161 /// The result has pointer to array type.
3162 ConstantAddress CodeGenModule::GetAddrOfConstantCString(
3163     const std::string &Str, const char *GlobalName) {
3164   StringRef StrWithNull(Str.c_str(), Str.size() + 1);
3165   CharUnits Alignment =
3166     getContext().getAlignOfGlobalVarInChars(getContext().CharTy);
3167 
3168   llvm::Constant *C =
3169       llvm::ConstantDataArray::getString(getLLVMContext(), StrWithNull, false);
3170 
3171   // Don't share any string literals if strings aren't constant.
3172   llvm::GlobalVariable **Entry = nullptr;
3173   if (!LangOpts.WritableStrings) {
3174     Entry = &ConstantStringMap[C];
3175     if (auto GV = *Entry) {
3176       if (Alignment.getQuantity() > GV->getAlignment())
3177         GV->setAlignment(Alignment.getQuantity());
3178       return ConstantAddress(GV, Alignment);
3179     }
3180   }
3181 
3182   // Get the default prefix if a name wasn't specified.
3183   if (!GlobalName)
3184     GlobalName = ".str";
3185   // Create a global variable for this.
3186   auto GV = GenerateStringLiteral(C, llvm::GlobalValue::PrivateLinkage, *this,
3187                                   GlobalName, Alignment);
3188   if (Entry)
3189     *Entry = GV;
3190   return ConstantAddress(GV, Alignment);
3191 }
3192 
3193 ConstantAddress CodeGenModule::GetAddrOfGlobalTemporary(
3194     const MaterializeTemporaryExpr *E, const Expr *Init) {
3195   assert((E->getStorageDuration() == SD_Static ||
3196           E->getStorageDuration() == SD_Thread) && "not a global temporary");
3197   const auto *VD = cast<VarDecl>(E->getExtendingDecl());
3198 
3199   // If we're not materializing a subobject of the temporary, keep the
3200   // cv-qualifiers from the type of the MaterializeTemporaryExpr.
3201   QualType MaterializedType = Init->getType();
3202   if (Init == E->GetTemporaryExpr())
3203     MaterializedType = E->getType();
3204 
3205   CharUnits Align = getContext().getTypeAlignInChars(MaterializedType);
3206 
3207   if (llvm::Constant *Slot = MaterializedGlobalTemporaryMap[E])
3208     return ConstantAddress(Slot, Align);
3209 
3210   // FIXME: If an externally-visible declaration extends multiple temporaries,
3211   // we need to give each temporary the same name in every translation unit (and
3212   // we also need to make the temporaries externally-visible).
3213   SmallString<256> Name;
3214   llvm::raw_svector_ostream Out(Name);
3215   getCXXABI().getMangleContext().mangleReferenceTemporary(
3216       VD, E->getManglingNumber(), Out);
3217 
3218   APValue *Value = nullptr;
3219   if (E->getStorageDuration() == SD_Static) {
3220     // We might have a cached constant initializer for this temporary. Note
3221     // that this might have a different value from the value computed by
3222     // evaluating the initializer if the surrounding constant expression
3223     // modifies the temporary.
3224     Value = getContext().getMaterializedTemporaryValue(E, false);
3225     if (Value && Value->isUninit())
3226       Value = nullptr;
3227   }
3228 
3229   // Try evaluating it now, it might have a constant initializer.
3230   Expr::EvalResult EvalResult;
3231   if (!Value && Init->EvaluateAsRValue(EvalResult, getContext()) &&
3232       !EvalResult.hasSideEffects())
3233     Value = &EvalResult.Val;
3234 
3235   llvm::Constant *InitialValue = nullptr;
3236   bool Constant = false;
3237   llvm::Type *Type;
3238   if (Value) {
3239     // The temporary has a constant initializer, use it.
3240     InitialValue = EmitConstantValue(*Value, MaterializedType, nullptr);
3241     Constant = isTypeConstant(MaterializedType, /*ExcludeCtor*/Value);
3242     Type = InitialValue->getType();
3243   } else {
3244     // No initializer, the initialization will be provided when we
3245     // initialize the declaration which performed lifetime extension.
3246     Type = getTypes().ConvertTypeForMem(MaterializedType);
3247   }
3248 
3249   // Create a global variable for this lifetime-extended temporary.
3250   llvm::GlobalValue::LinkageTypes Linkage =
3251       getLLVMLinkageVarDefinition(VD, Constant);
3252   if (Linkage == llvm::GlobalVariable::ExternalLinkage) {
3253     const VarDecl *InitVD;
3254     if (VD->isStaticDataMember() && VD->getAnyInitializer(InitVD) &&
3255         isa<CXXRecordDecl>(InitVD->getLexicalDeclContext())) {
3256       // Temporaries defined inside a class get linkonce_odr linkage because the
3257       // class can be defined in multipe translation units.
3258       Linkage = llvm::GlobalVariable::LinkOnceODRLinkage;
3259     } else {
3260       // There is no need for this temporary to have external linkage if the
3261       // VarDecl has external linkage.
3262       Linkage = llvm::GlobalVariable::InternalLinkage;
3263     }
3264   }
3265   unsigned AddrSpace = GetGlobalVarAddressSpace(
3266       VD, getContext().getTargetAddressSpace(MaterializedType));
3267   auto *GV = new llvm::GlobalVariable(
3268       getModule(), Type, Constant, Linkage, InitialValue, Name.c_str(),
3269       /*InsertBefore=*/nullptr, llvm::GlobalVariable::NotThreadLocal,
3270       AddrSpace);
3271   setGlobalVisibility(GV, VD);
3272   GV->setAlignment(Align.getQuantity());
3273   if (supportsCOMDAT() && GV->isWeakForLinker())
3274     GV->setComdat(TheModule.getOrInsertComdat(GV->getName()));
3275   if (VD->getTLSKind())
3276     setTLSMode(GV, *VD);
3277   MaterializedGlobalTemporaryMap[E] = GV;
3278   return ConstantAddress(GV, Align);
3279 }
3280 
3281 /// EmitObjCPropertyImplementations - Emit information for synthesized
3282 /// properties for an implementation.
3283 void CodeGenModule::EmitObjCPropertyImplementations(const
3284                                                     ObjCImplementationDecl *D) {
3285   for (const auto *PID : D->property_impls()) {
3286     // Dynamic is just for type-checking.
3287     if (PID->getPropertyImplementation() == ObjCPropertyImplDecl::Synthesize) {
3288       ObjCPropertyDecl *PD = PID->getPropertyDecl();
3289 
3290       // Determine which methods need to be implemented, some may have
3291       // been overridden. Note that ::isPropertyAccessor is not the method
3292       // we want, that just indicates if the decl came from a
3293       // property. What we want to know is if the method is defined in
3294       // this implementation.
3295       if (!D->getInstanceMethod(PD->getGetterName()))
3296         CodeGenFunction(*this).GenerateObjCGetter(
3297                                  const_cast<ObjCImplementationDecl *>(D), PID);
3298       if (!PD->isReadOnly() &&
3299           !D->getInstanceMethod(PD->getSetterName()))
3300         CodeGenFunction(*this).GenerateObjCSetter(
3301                                  const_cast<ObjCImplementationDecl *>(D), PID);
3302     }
3303   }
3304 }
3305 
3306 static bool needsDestructMethod(ObjCImplementationDecl *impl) {
3307   const ObjCInterfaceDecl *iface = impl->getClassInterface();
3308   for (const ObjCIvarDecl *ivar = iface->all_declared_ivar_begin();
3309        ivar; ivar = ivar->getNextIvar())
3310     if (ivar->getType().isDestructedType())
3311       return true;
3312 
3313   return false;
3314 }
3315 
3316 static bool AllTrivialInitializers(CodeGenModule &CGM,
3317                                    ObjCImplementationDecl *D) {
3318   CodeGenFunction CGF(CGM);
3319   for (ObjCImplementationDecl::init_iterator B = D->init_begin(),
3320        E = D->init_end(); B != E; ++B) {
3321     CXXCtorInitializer *CtorInitExp = *B;
3322     Expr *Init = CtorInitExp->getInit();
3323     if (!CGF.isTrivialInitializer(Init))
3324       return false;
3325   }
3326   return true;
3327 }
3328 
3329 /// EmitObjCIvarInitializations - Emit information for ivar initialization
3330 /// for an implementation.
3331 void CodeGenModule::EmitObjCIvarInitializations(ObjCImplementationDecl *D) {
3332   // We might need a .cxx_destruct even if we don't have any ivar initializers.
3333   if (needsDestructMethod(D)) {
3334     IdentifierInfo *II = &getContext().Idents.get(".cxx_destruct");
3335     Selector cxxSelector = getContext().Selectors.getSelector(0, &II);
3336     ObjCMethodDecl *DTORMethod =
3337       ObjCMethodDecl::Create(getContext(), D->getLocation(), D->getLocation(),
3338                              cxxSelector, getContext().VoidTy, nullptr, D,
3339                              /*isInstance=*/true, /*isVariadic=*/false,
3340                           /*isPropertyAccessor=*/true, /*isImplicitlyDeclared=*/true,
3341                              /*isDefined=*/false, ObjCMethodDecl::Required);
3342     D->addInstanceMethod(DTORMethod);
3343     CodeGenFunction(*this).GenerateObjCCtorDtorMethod(D, DTORMethod, false);
3344     D->setHasDestructors(true);
3345   }
3346 
3347   // If the implementation doesn't have any ivar initializers, we don't need
3348   // a .cxx_construct.
3349   if (D->getNumIvarInitializers() == 0 ||
3350       AllTrivialInitializers(*this, D))
3351     return;
3352 
3353   IdentifierInfo *II = &getContext().Idents.get(".cxx_construct");
3354   Selector cxxSelector = getContext().Selectors.getSelector(0, &II);
3355   // The constructor returns 'self'.
3356   ObjCMethodDecl *CTORMethod = ObjCMethodDecl::Create(getContext(),
3357                                                 D->getLocation(),
3358                                                 D->getLocation(),
3359                                                 cxxSelector,
3360                                                 getContext().getObjCIdType(),
3361                                                 nullptr, D, /*isInstance=*/true,
3362                                                 /*isVariadic=*/false,
3363                                                 /*isPropertyAccessor=*/true,
3364                                                 /*isImplicitlyDeclared=*/true,
3365                                                 /*isDefined=*/false,
3366                                                 ObjCMethodDecl::Required);
3367   D->addInstanceMethod(CTORMethod);
3368   CodeGenFunction(*this).GenerateObjCCtorDtorMethod(D, CTORMethod, true);
3369   D->setHasNonZeroConstructors(true);
3370 }
3371 
3372 /// EmitNamespace - Emit all declarations in a namespace.
3373 void CodeGenModule::EmitNamespace(const NamespaceDecl *ND) {
3374   for (auto *I : ND->decls()) {
3375     if (const auto *VD = dyn_cast<VarDecl>(I))
3376       if (VD->getTemplateSpecializationKind() != TSK_ExplicitSpecialization &&
3377           VD->getTemplateSpecializationKind() != TSK_Undeclared)
3378         continue;
3379     EmitTopLevelDecl(I);
3380   }
3381 }
3382 
3383 // EmitLinkageSpec - Emit all declarations in a linkage spec.
3384 void CodeGenModule::EmitLinkageSpec(const LinkageSpecDecl *LSD) {
3385   if (LSD->getLanguage() != LinkageSpecDecl::lang_c &&
3386       LSD->getLanguage() != LinkageSpecDecl::lang_cxx) {
3387     ErrorUnsupported(LSD, "linkage spec");
3388     return;
3389   }
3390 
3391   for (auto *I : LSD->decls()) {
3392     // Meta-data for ObjC class includes references to implemented methods.
3393     // Generate class's method definitions first.
3394     if (auto *OID = dyn_cast<ObjCImplDecl>(I)) {
3395       for (auto *M : OID->methods())
3396         EmitTopLevelDecl(M);
3397     }
3398     EmitTopLevelDecl(I);
3399   }
3400 }
3401 
3402 /// EmitTopLevelDecl - Emit code for a single top level declaration.
3403 void CodeGenModule::EmitTopLevelDecl(Decl *D) {
3404   // Ignore dependent declarations.
3405   if (D->getDeclContext() && D->getDeclContext()->isDependentContext())
3406     return;
3407 
3408   switch (D->getKind()) {
3409   case Decl::CXXConversion:
3410   case Decl::CXXMethod:
3411   case Decl::Function:
3412     // Skip function templates
3413     if (cast<FunctionDecl>(D)->getDescribedFunctionTemplate() ||
3414         cast<FunctionDecl>(D)->isLateTemplateParsed())
3415       return;
3416 
3417     EmitGlobal(cast<FunctionDecl>(D));
3418     // Always provide some coverage mapping
3419     // even for the functions that aren't emitted.
3420     AddDeferredUnusedCoverageMapping(D);
3421     break;
3422 
3423   case Decl::Var:
3424     // Skip variable templates
3425     if (cast<VarDecl>(D)->getDescribedVarTemplate())
3426       return;
3427   case Decl::VarTemplateSpecialization:
3428     EmitGlobal(cast<VarDecl>(D));
3429     break;
3430 
3431   // Indirect fields from global anonymous structs and unions can be
3432   // ignored; only the actual variable requires IR gen support.
3433   case Decl::IndirectField:
3434     break;
3435 
3436   // C++ Decls
3437   case Decl::Namespace:
3438     EmitNamespace(cast<NamespaceDecl>(D));
3439     break;
3440     // No code generation needed.
3441   case Decl::UsingShadow:
3442   case Decl::ClassTemplate:
3443   case Decl::VarTemplate:
3444   case Decl::VarTemplatePartialSpecialization:
3445   case Decl::FunctionTemplate:
3446   case Decl::TypeAliasTemplate:
3447   case Decl::Block:
3448   case Decl::Empty:
3449     break;
3450   case Decl::Using:          // using X; [C++]
3451     if (CGDebugInfo *DI = getModuleDebugInfo())
3452         DI->EmitUsingDecl(cast<UsingDecl>(*D));
3453     return;
3454   case Decl::NamespaceAlias:
3455     if (CGDebugInfo *DI = getModuleDebugInfo())
3456         DI->EmitNamespaceAlias(cast<NamespaceAliasDecl>(*D));
3457     return;
3458   case Decl::UsingDirective: // using namespace X; [C++]
3459     if (CGDebugInfo *DI = getModuleDebugInfo())
3460       DI->EmitUsingDirective(cast<UsingDirectiveDecl>(*D));
3461     return;
3462   case Decl::CXXConstructor:
3463     // Skip function templates
3464     if (cast<FunctionDecl>(D)->getDescribedFunctionTemplate() ||
3465         cast<FunctionDecl>(D)->isLateTemplateParsed())
3466       return;
3467 
3468     getCXXABI().EmitCXXConstructors(cast<CXXConstructorDecl>(D));
3469     break;
3470   case Decl::CXXDestructor:
3471     if (cast<FunctionDecl>(D)->isLateTemplateParsed())
3472       return;
3473     getCXXABI().EmitCXXDestructors(cast<CXXDestructorDecl>(D));
3474     break;
3475 
3476   case Decl::StaticAssert:
3477     // Nothing to do.
3478     break;
3479 
3480   // Objective-C Decls
3481 
3482   // Forward declarations, no (immediate) code generation.
3483   case Decl::ObjCInterface:
3484   case Decl::ObjCCategory:
3485     break;
3486 
3487   case Decl::ObjCProtocol: {
3488     auto *Proto = cast<ObjCProtocolDecl>(D);
3489     if (Proto->isThisDeclarationADefinition())
3490       ObjCRuntime->GenerateProtocol(Proto);
3491     break;
3492   }
3493 
3494   case Decl::ObjCCategoryImpl:
3495     // Categories have properties but don't support synthesize so we
3496     // can ignore them here.
3497     ObjCRuntime->GenerateCategory(cast<ObjCCategoryImplDecl>(D));
3498     break;
3499 
3500   case Decl::ObjCImplementation: {
3501     auto *OMD = cast<ObjCImplementationDecl>(D);
3502     EmitObjCPropertyImplementations(OMD);
3503     EmitObjCIvarInitializations(OMD);
3504     ObjCRuntime->GenerateClass(OMD);
3505     // Emit global variable debug information.
3506     if (CGDebugInfo *DI = getModuleDebugInfo())
3507       if (getCodeGenOpts().getDebugInfo() >= CodeGenOptions::LimitedDebugInfo)
3508         DI->getOrCreateInterfaceType(getContext().getObjCInterfaceType(
3509             OMD->getClassInterface()), OMD->getLocation());
3510     break;
3511   }
3512   case Decl::ObjCMethod: {
3513     auto *OMD = cast<ObjCMethodDecl>(D);
3514     // If this is not a prototype, emit the body.
3515     if (OMD->getBody())
3516       CodeGenFunction(*this).GenerateObjCMethod(OMD);
3517     break;
3518   }
3519   case Decl::ObjCCompatibleAlias:
3520     ObjCRuntime->RegisterAlias(cast<ObjCCompatibleAliasDecl>(D));
3521     break;
3522 
3523   case Decl::LinkageSpec:
3524     EmitLinkageSpec(cast<LinkageSpecDecl>(D));
3525     break;
3526 
3527   case Decl::FileScopeAsm: {
3528     // File-scope asm is ignored during device-side CUDA compilation.
3529     if (LangOpts.CUDA && LangOpts.CUDAIsDevice)
3530       break;
3531     auto *AD = cast<FileScopeAsmDecl>(D);
3532     getModule().appendModuleInlineAsm(AD->getAsmString()->getString());
3533     break;
3534   }
3535 
3536   case Decl::Import: {
3537     auto *Import = cast<ImportDecl>(D);
3538 
3539     // Ignore import declarations that come from imported modules.
3540     if (Import->getImportedOwningModule())
3541       break;
3542     if (CGDebugInfo *DI = getModuleDebugInfo())
3543       DI->EmitImportDecl(*Import);
3544 
3545     ImportedModules.insert(Import->getImportedModule());
3546     break;
3547   }
3548 
3549   case Decl::OMPThreadPrivate:
3550     EmitOMPThreadPrivateDecl(cast<OMPThreadPrivateDecl>(D));
3551     break;
3552 
3553   case Decl::ClassTemplateSpecialization: {
3554     const auto *Spec = cast<ClassTemplateSpecializationDecl>(D);
3555     if (DebugInfo &&
3556         Spec->getSpecializationKind() == TSK_ExplicitInstantiationDefinition &&
3557         Spec->hasDefinition())
3558       DebugInfo->completeTemplateDefinition(*Spec);
3559     break;
3560   }
3561 
3562   default:
3563     // Make sure we handled everything we should, every other kind is a
3564     // non-top-level decl.  FIXME: Would be nice to have an isTopLevelDeclKind
3565     // function. Need to recode Decl::Kind to do that easily.
3566     assert(isa<TypeDecl>(D) && "Unsupported decl kind");
3567     break;
3568   }
3569 }
3570 
3571 void CodeGenModule::AddDeferredUnusedCoverageMapping(Decl *D) {
3572   // Do we need to generate coverage mapping?
3573   if (!CodeGenOpts.CoverageMapping)
3574     return;
3575   switch (D->getKind()) {
3576   case Decl::CXXConversion:
3577   case Decl::CXXMethod:
3578   case Decl::Function:
3579   case Decl::ObjCMethod:
3580   case Decl::CXXConstructor:
3581   case Decl::CXXDestructor: {
3582     if (!cast<FunctionDecl>(D)->doesThisDeclarationHaveABody())
3583       return;
3584     auto I = DeferredEmptyCoverageMappingDecls.find(D);
3585     if (I == DeferredEmptyCoverageMappingDecls.end())
3586       DeferredEmptyCoverageMappingDecls[D] = true;
3587     break;
3588   }
3589   default:
3590     break;
3591   };
3592 }
3593 
3594 void CodeGenModule::ClearUnusedCoverageMapping(const Decl *D) {
3595   // Do we need to generate coverage mapping?
3596   if (!CodeGenOpts.CoverageMapping)
3597     return;
3598   if (const auto *Fn = dyn_cast<FunctionDecl>(D)) {
3599     if (Fn->isTemplateInstantiation())
3600       ClearUnusedCoverageMapping(Fn->getTemplateInstantiationPattern());
3601   }
3602   auto I = DeferredEmptyCoverageMappingDecls.find(D);
3603   if (I == DeferredEmptyCoverageMappingDecls.end())
3604     DeferredEmptyCoverageMappingDecls[D] = false;
3605   else
3606     I->second = false;
3607 }
3608 
3609 void CodeGenModule::EmitDeferredUnusedCoverageMappings() {
3610   std::vector<const Decl *> DeferredDecls;
3611   for (const auto &I : DeferredEmptyCoverageMappingDecls) {
3612     if (!I.second)
3613       continue;
3614     DeferredDecls.push_back(I.first);
3615   }
3616   // Sort the declarations by their location to make sure that the tests get a
3617   // predictable order for the coverage mapping for the unused declarations.
3618   if (CodeGenOpts.DumpCoverageMapping)
3619     std::sort(DeferredDecls.begin(), DeferredDecls.end(),
3620               [] (const Decl *LHS, const Decl *RHS) {
3621       return LHS->getLocStart() < RHS->getLocStart();
3622     });
3623   for (const auto *D : DeferredDecls) {
3624     switch (D->getKind()) {
3625     case Decl::CXXConversion:
3626     case Decl::CXXMethod:
3627     case Decl::Function:
3628     case Decl::ObjCMethod: {
3629       CodeGenPGO PGO(*this);
3630       GlobalDecl GD(cast<FunctionDecl>(D));
3631       PGO.emitEmptyCounterMapping(D, getMangledName(GD),
3632                                   getFunctionLinkage(GD));
3633       break;
3634     }
3635     case Decl::CXXConstructor: {
3636       CodeGenPGO PGO(*this);
3637       GlobalDecl GD(cast<CXXConstructorDecl>(D), Ctor_Base);
3638       PGO.emitEmptyCounterMapping(D, getMangledName(GD),
3639                                   getFunctionLinkage(GD));
3640       break;
3641     }
3642     case Decl::CXXDestructor: {
3643       CodeGenPGO PGO(*this);
3644       GlobalDecl GD(cast<CXXDestructorDecl>(D), Dtor_Base);
3645       PGO.emitEmptyCounterMapping(D, getMangledName(GD),
3646                                   getFunctionLinkage(GD));
3647       break;
3648     }
3649     default:
3650       break;
3651     };
3652   }
3653 }
3654 
3655 /// Turns the given pointer into a constant.
3656 static llvm::Constant *GetPointerConstant(llvm::LLVMContext &Context,
3657                                           const void *Ptr) {
3658   uintptr_t PtrInt = reinterpret_cast<uintptr_t>(Ptr);
3659   llvm::Type *i64 = llvm::Type::getInt64Ty(Context);
3660   return llvm::ConstantInt::get(i64, PtrInt);
3661 }
3662 
3663 static void EmitGlobalDeclMetadata(CodeGenModule &CGM,
3664                                    llvm::NamedMDNode *&GlobalMetadata,
3665                                    GlobalDecl D,
3666                                    llvm::GlobalValue *Addr) {
3667   if (!GlobalMetadata)
3668     GlobalMetadata =
3669       CGM.getModule().getOrInsertNamedMetadata("clang.global.decl.ptrs");
3670 
3671   // TODO: should we report variant information for ctors/dtors?
3672   llvm::Metadata *Ops[] = {llvm::ConstantAsMetadata::get(Addr),
3673                            llvm::ConstantAsMetadata::get(GetPointerConstant(
3674                                CGM.getLLVMContext(), D.getDecl()))};
3675   GlobalMetadata->addOperand(llvm::MDNode::get(CGM.getLLVMContext(), Ops));
3676 }
3677 
3678 /// For each function which is declared within an extern "C" region and marked
3679 /// as 'used', but has internal linkage, create an alias from the unmangled
3680 /// name to the mangled name if possible. People expect to be able to refer
3681 /// to such functions with an unmangled name from inline assembly within the
3682 /// same translation unit.
3683 void CodeGenModule::EmitStaticExternCAliases() {
3684   for (auto &I : StaticExternCValues) {
3685     IdentifierInfo *Name = I.first;
3686     llvm::GlobalValue *Val = I.second;
3687     if (Val && !getModule().getNamedValue(Name->getName()))
3688       addUsedGlobal(llvm::GlobalAlias::create(Name->getName(), Val));
3689   }
3690 }
3691 
3692 bool CodeGenModule::lookupRepresentativeDecl(StringRef MangledName,
3693                                              GlobalDecl &Result) const {
3694   auto Res = Manglings.find(MangledName);
3695   if (Res == Manglings.end())
3696     return false;
3697   Result = Res->getValue();
3698   return true;
3699 }
3700 
3701 /// Emits metadata nodes associating all the global values in the
3702 /// current module with the Decls they came from.  This is useful for
3703 /// projects using IR gen as a subroutine.
3704 ///
3705 /// Since there's currently no way to associate an MDNode directly
3706 /// with an llvm::GlobalValue, we create a global named metadata
3707 /// with the name 'clang.global.decl.ptrs'.
3708 void CodeGenModule::EmitDeclMetadata() {
3709   llvm::NamedMDNode *GlobalMetadata = nullptr;
3710 
3711   for (auto &I : MangledDeclNames) {
3712     llvm::GlobalValue *Addr = getModule().getNamedValue(I.second);
3713     // Some mangled names don't necessarily have an associated GlobalValue
3714     // in this module, e.g. if we mangled it for DebugInfo.
3715     if (Addr)
3716       EmitGlobalDeclMetadata(*this, GlobalMetadata, I.first, Addr);
3717   }
3718 }
3719 
3720 /// Emits metadata nodes for all the local variables in the current
3721 /// function.
3722 void CodeGenFunction::EmitDeclMetadata() {
3723   if (LocalDeclMap.empty()) return;
3724 
3725   llvm::LLVMContext &Context = getLLVMContext();
3726 
3727   // Find the unique metadata ID for this name.
3728   unsigned DeclPtrKind = Context.getMDKindID("clang.decl.ptr");
3729 
3730   llvm::NamedMDNode *GlobalMetadata = nullptr;
3731 
3732   for (auto &I : LocalDeclMap) {
3733     const Decl *D = I.first;
3734     llvm::Value *Addr = I.second.getPointer();
3735     if (auto *Alloca = dyn_cast<llvm::AllocaInst>(Addr)) {
3736       llvm::Value *DAddr = GetPointerConstant(getLLVMContext(), D);
3737       Alloca->setMetadata(
3738           DeclPtrKind, llvm::MDNode::get(
3739                            Context, llvm::ValueAsMetadata::getConstant(DAddr)));
3740     } else if (auto *GV = dyn_cast<llvm::GlobalValue>(Addr)) {
3741       GlobalDecl GD = GlobalDecl(cast<VarDecl>(D));
3742       EmitGlobalDeclMetadata(CGM, GlobalMetadata, GD, GV);
3743     }
3744   }
3745 }
3746 
3747 void CodeGenModule::EmitVersionIdentMetadata() {
3748   llvm::NamedMDNode *IdentMetadata =
3749     TheModule.getOrInsertNamedMetadata("llvm.ident");
3750   std::string Version = getClangFullVersion();
3751   llvm::LLVMContext &Ctx = TheModule.getContext();
3752 
3753   llvm::Metadata *IdentNode[] = {llvm::MDString::get(Ctx, Version)};
3754   IdentMetadata->addOperand(llvm::MDNode::get(Ctx, IdentNode));
3755 }
3756 
3757 void CodeGenModule::EmitTargetMetadata() {
3758   // Warning, new MangledDeclNames may be appended within this loop.
3759   // We rely on MapVector insertions adding new elements to the end
3760   // of the container.
3761   // FIXME: Move this loop into the one target that needs it, and only
3762   // loop over those declarations for which we couldn't emit the target
3763   // metadata when we emitted the declaration.
3764   for (unsigned I = 0; I != MangledDeclNames.size(); ++I) {
3765     auto Val = *(MangledDeclNames.begin() + I);
3766     const Decl *D = Val.first.getDecl()->getMostRecentDecl();
3767     llvm::GlobalValue *GV = GetGlobalValue(Val.second);
3768     getTargetCodeGenInfo().emitTargetMD(D, GV, *this);
3769   }
3770 }
3771 
3772 void CodeGenModule::EmitCoverageFile() {
3773   if (!getCodeGenOpts().CoverageFile.empty()) {
3774     if (llvm::NamedMDNode *CUNode = TheModule.getNamedMetadata("llvm.dbg.cu")) {
3775       llvm::NamedMDNode *GCov = TheModule.getOrInsertNamedMetadata("llvm.gcov");
3776       llvm::LLVMContext &Ctx = TheModule.getContext();
3777       llvm::MDString *CoverageFile =
3778           llvm::MDString::get(Ctx, getCodeGenOpts().CoverageFile);
3779       for (int i = 0, e = CUNode->getNumOperands(); i != e; ++i) {
3780         llvm::MDNode *CU = CUNode->getOperand(i);
3781         llvm::Metadata *Elts[] = {CoverageFile, CU};
3782         GCov->addOperand(llvm::MDNode::get(Ctx, Elts));
3783       }
3784     }
3785   }
3786 }
3787 
3788 llvm::Constant *CodeGenModule::EmitUuidofInitializer(StringRef Uuid) {
3789   // Sema has checked that all uuid strings are of the form
3790   // "12345678-1234-1234-1234-1234567890ab".
3791   assert(Uuid.size() == 36);
3792   for (unsigned i = 0; i < 36; ++i) {
3793     if (i == 8 || i == 13 || i == 18 || i == 23) assert(Uuid[i] == '-');
3794     else                                         assert(isHexDigit(Uuid[i]));
3795   }
3796 
3797   // The starts of all bytes of Field3 in Uuid. Field 3 is "1234-1234567890ab".
3798   const unsigned Field3ValueOffsets[8] = { 19, 21, 24, 26, 28, 30, 32, 34 };
3799 
3800   llvm::Constant *Field3[8];
3801   for (unsigned Idx = 0; Idx < 8; ++Idx)
3802     Field3[Idx] = llvm::ConstantInt::get(
3803         Int8Ty, Uuid.substr(Field3ValueOffsets[Idx], 2), 16);
3804 
3805   llvm::Constant *Fields[4] = {
3806     llvm::ConstantInt::get(Int32Ty, Uuid.substr(0,  8), 16),
3807     llvm::ConstantInt::get(Int16Ty, Uuid.substr(9,  4), 16),
3808     llvm::ConstantInt::get(Int16Ty, Uuid.substr(14, 4), 16),
3809     llvm::ConstantArray::get(llvm::ArrayType::get(Int8Ty, 8), Field3)
3810   };
3811 
3812   return llvm::ConstantStruct::getAnon(Fields);
3813 }
3814 
3815 llvm::Constant *CodeGenModule::GetAddrOfRTTIDescriptor(QualType Ty,
3816                                                        bool ForEH) {
3817   // Return a bogus pointer if RTTI is disabled, unless it's for EH.
3818   // FIXME: should we even be calling this method if RTTI is disabled
3819   // and it's not for EH?
3820   if (!ForEH && !getLangOpts().RTTI)
3821     return llvm::Constant::getNullValue(Int8PtrTy);
3822 
3823   if (ForEH && Ty->isObjCObjectPointerType() &&
3824       LangOpts.ObjCRuntime.isGNUFamily())
3825     return ObjCRuntime->GetEHType(Ty);
3826 
3827   return getCXXABI().getAddrOfRTTIDescriptor(Ty);
3828 }
3829 
3830 void CodeGenModule::EmitOMPThreadPrivateDecl(const OMPThreadPrivateDecl *D) {
3831   for (auto RefExpr : D->varlists()) {
3832     auto *VD = cast<VarDecl>(cast<DeclRefExpr>(RefExpr)->getDecl());
3833     bool PerformInit =
3834         VD->getAnyInitializer() &&
3835         !VD->getAnyInitializer()->isConstantInitializer(getContext(),
3836                                                         /*ForRef=*/false);
3837 
3838     Address Addr(GetAddrOfGlobalVar(VD), getContext().getDeclAlign(VD));
3839     if (auto InitFunction = getOpenMPRuntime().emitThreadPrivateVarDefinition(
3840             VD, Addr, RefExpr->getLocStart(), PerformInit))
3841       CXXGlobalInits.push_back(InitFunction);
3842   }
3843 }
3844 
3845 llvm::Metadata *CodeGenModule::CreateMetadataIdentifierForType(QualType T) {
3846   llvm::Metadata *&InternalId = MetadataIdMap[T.getCanonicalType()];
3847   if (InternalId)
3848     return InternalId;
3849 
3850   if (isExternallyVisible(T->getLinkage())) {
3851     std::string OutName;
3852     llvm::raw_string_ostream Out(OutName);
3853     getCXXABI().getMangleContext().mangleTypeName(T, Out);
3854 
3855     InternalId = llvm::MDString::get(getLLVMContext(), Out.str());
3856   } else {
3857     InternalId = llvm::MDNode::getDistinct(getLLVMContext(),
3858                                            llvm::ArrayRef<llvm::Metadata *>());
3859   }
3860 
3861   return InternalId;
3862 }
3863 
3864 llvm::MDTuple *CodeGenModule::CreateVTableBitSetEntry(
3865     llvm::GlobalVariable *VTable, CharUnits Offset, const CXXRecordDecl *RD) {
3866   llvm::Metadata *BitsetOps[] = {
3867       CreateMetadataIdentifierForType(QualType(RD->getTypeForDecl(), 0)),
3868       llvm::ConstantAsMetadata::get(VTable),
3869       llvm::ConstantAsMetadata::get(
3870           llvm::ConstantInt::get(Int64Ty, Offset.getQuantity()))};
3871   return llvm::MDTuple::get(getLLVMContext(), BitsetOps);
3872 }
3873