1 //===--- CGDebugInfo.cpp - Emit Debug Information 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 debug information generation while generating code.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #include "CGDebugInfo.h"
15 #include "CGBlocks.h"
16 #include "CGCXXABI.h"
17 #include "CGObjCRuntime.h"
18 #include "CGRecordLayout.h"
19 #include "CodeGenFunction.h"
20 #include "CodeGenModule.h"
21 #include "ConstantEmitter.h"
22 #include "clang/AST/ASTContext.h"
23 #include "clang/AST/DeclFriend.h"
24 #include "clang/AST/DeclObjC.h"
25 #include "clang/AST/DeclTemplate.h"
26 #include "clang/AST/Expr.h"
27 #include "clang/AST/RecordLayout.h"
28 #include "clang/Basic/FileManager.h"
29 #include "clang/Basic/SourceManager.h"
30 #include "clang/Basic/Version.h"
31 #include "clang/Frontend/CodeGenOptions.h"
32 #include "clang/Frontend/FrontendOptions.h"
33 #include "clang/Lex/HeaderSearchOptions.h"
34 #include "clang/Lex/ModuleMap.h"
35 #include "clang/Lex/PreprocessorOptions.h"
36 #include "llvm/ADT/DenseSet.h"
37 #include "llvm/ADT/SmallVector.h"
38 #include "llvm/ADT/StringExtras.h"
39 #include "llvm/IR/Constants.h"
40 #include "llvm/IR/DataLayout.h"
41 #include "llvm/IR/DerivedTypes.h"
42 #include "llvm/IR/Instructions.h"
43 #include "llvm/IR/Intrinsics.h"
44 #include "llvm/IR/Metadata.h"
45 #include "llvm/IR/Module.h"
46 #include "llvm/Support/FileSystem.h"
47 #include "llvm/Support/MD5.h"
48 #include "llvm/Support/Path.h"
49 using namespace clang;
50 using namespace clang::CodeGen;
51 
52 static uint32_t getTypeAlignIfRequired(const Type *Ty, const ASTContext &Ctx) {
53   auto TI = Ctx.getTypeInfo(Ty);
54   return TI.AlignIsRequired ? TI.Align : 0;
55 }
56 
57 static uint32_t getTypeAlignIfRequired(QualType Ty, const ASTContext &Ctx) {
58   return getTypeAlignIfRequired(Ty.getTypePtr(), Ctx);
59 }
60 
61 static uint32_t getDeclAlignIfRequired(const Decl *D, const ASTContext &Ctx) {
62   return D->hasAttr<AlignedAttr>() ? D->getMaxAlignment() : 0;
63 }
64 
65 CGDebugInfo::CGDebugInfo(CodeGenModule &CGM)
66     : CGM(CGM), DebugKind(CGM.getCodeGenOpts().getDebugInfo()),
67       DebugTypeExtRefs(CGM.getCodeGenOpts().DebugTypeExtRefs),
68       DBuilder(CGM.getModule()) {
69   for (const auto &KV : CGM.getCodeGenOpts().DebugPrefixMap)
70     DebugPrefixMap[KV.first] = KV.second;
71   CreateCompileUnit();
72 }
73 
74 CGDebugInfo::~CGDebugInfo() {
75   assert(LexicalBlockStack.empty() &&
76          "Region stack mismatch, stack not empty!");
77 }
78 
79 ApplyDebugLocation::ApplyDebugLocation(CodeGenFunction &CGF,
80                                        SourceLocation TemporaryLocation)
81     : CGF(&CGF) {
82   init(TemporaryLocation);
83 }
84 
85 ApplyDebugLocation::ApplyDebugLocation(CodeGenFunction &CGF,
86                                        bool DefaultToEmpty,
87                                        SourceLocation TemporaryLocation)
88     : CGF(&CGF) {
89   init(TemporaryLocation, DefaultToEmpty);
90 }
91 
92 void ApplyDebugLocation::init(SourceLocation TemporaryLocation,
93                               bool DefaultToEmpty) {
94   auto *DI = CGF->getDebugInfo();
95   if (!DI) {
96     CGF = nullptr;
97     return;
98   }
99 
100   OriginalLocation = CGF->Builder.getCurrentDebugLocation();
101 
102   if (OriginalLocation && !DI->CGM.getExpressionLocationsEnabled())
103     return;
104 
105   if (TemporaryLocation.isValid()) {
106     DI->EmitLocation(CGF->Builder, TemporaryLocation);
107     return;
108   }
109 
110   if (DefaultToEmpty) {
111     CGF->Builder.SetCurrentDebugLocation(llvm::DebugLoc());
112     return;
113   }
114 
115   // Construct a location that has a valid scope, but no line info.
116   assert(!DI->LexicalBlockStack.empty());
117   CGF->Builder.SetCurrentDebugLocation(llvm::DebugLoc::get(
118       0, 0, DI->LexicalBlockStack.back(), DI->getInlinedAt()));
119 }
120 
121 ApplyDebugLocation::ApplyDebugLocation(CodeGenFunction &CGF, const Expr *E)
122     : CGF(&CGF) {
123   init(E->getExprLoc());
124 }
125 
126 ApplyDebugLocation::ApplyDebugLocation(CodeGenFunction &CGF, llvm::DebugLoc Loc)
127     : CGF(&CGF) {
128   if (!CGF.getDebugInfo()) {
129     this->CGF = nullptr;
130     return;
131   }
132   OriginalLocation = CGF.Builder.getCurrentDebugLocation();
133   if (Loc)
134     CGF.Builder.SetCurrentDebugLocation(std::move(Loc));
135 }
136 
137 ApplyDebugLocation::~ApplyDebugLocation() {
138   // Query CGF so the location isn't overwritten when location updates are
139   // temporarily disabled (for C++ default function arguments)
140   if (CGF)
141     CGF->Builder.SetCurrentDebugLocation(std::move(OriginalLocation));
142 }
143 
144 ApplyInlineDebugLocation::ApplyInlineDebugLocation(CodeGenFunction &CGF,
145                                                    GlobalDecl InlinedFn)
146     : CGF(&CGF) {
147   if (!CGF.getDebugInfo()) {
148     this->CGF = nullptr;
149     return;
150   }
151   auto &DI = *CGF.getDebugInfo();
152   SavedLocation = DI.getLocation();
153   assert((DI.getInlinedAt() ==
154           CGF.Builder.getCurrentDebugLocation()->getInlinedAt()) &&
155          "CGDebugInfo and IRBuilder are out of sync");
156 
157   DI.EmitInlineFunctionStart(CGF.Builder, InlinedFn);
158 }
159 
160 ApplyInlineDebugLocation::~ApplyInlineDebugLocation() {
161   if (!CGF)
162     return;
163   auto &DI = *CGF->getDebugInfo();
164   DI.EmitInlineFunctionEnd(CGF->Builder);
165   DI.EmitLocation(CGF->Builder, SavedLocation);
166 }
167 
168 void CGDebugInfo::setLocation(SourceLocation Loc) {
169   // If the new location isn't valid return.
170   if (Loc.isInvalid())
171     return;
172 
173   CurLoc = CGM.getContext().getSourceManager().getExpansionLoc(Loc);
174 
175   // If we've changed files in the middle of a lexical scope go ahead
176   // and create a new lexical scope with file node if it's different
177   // from the one in the scope.
178   if (LexicalBlockStack.empty())
179     return;
180 
181   SourceManager &SM = CGM.getContext().getSourceManager();
182   auto *Scope = cast<llvm::DIScope>(LexicalBlockStack.back());
183   PresumedLoc PCLoc = SM.getPresumedLoc(CurLoc);
184 
185   if (PCLoc.isInvalid() || Scope->getFilename() == PCLoc.getFilename())
186     return;
187 
188   if (auto *LBF = dyn_cast<llvm::DILexicalBlockFile>(Scope)) {
189     LexicalBlockStack.pop_back();
190     LexicalBlockStack.emplace_back(DBuilder.createLexicalBlockFile(
191         LBF->getScope(), getOrCreateFile(CurLoc)));
192   } else if (isa<llvm::DILexicalBlock>(Scope) ||
193              isa<llvm::DISubprogram>(Scope)) {
194     LexicalBlockStack.pop_back();
195     LexicalBlockStack.emplace_back(
196         DBuilder.createLexicalBlockFile(Scope, getOrCreateFile(CurLoc)));
197   }
198 }
199 
200 llvm::DIScope *CGDebugInfo::getDeclContextDescriptor(const Decl *D) {
201   llvm::DIScope *Mod = getParentModuleOrNull(D);
202   return getContextDescriptor(cast<Decl>(D->getDeclContext()),
203                               Mod ? Mod : TheCU);
204 }
205 
206 llvm::DIScope *CGDebugInfo::getContextDescriptor(const Decl *Context,
207                                                  llvm::DIScope *Default) {
208   if (!Context)
209     return Default;
210 
211   auto I = RegionMap.find(Context);
212   if (I != RegionMap.end()) {
213     llvm::Metadata *V = I->second;
214     return dyn_cast_or_null<llvm::DIScope>(V);
215   }
216 
217   // Check namespace.
218   if (const auto *NSDecl = dyn_cast<NamespaceDecl>(Context))
219     return getOrCreateNamespace(NSDecl);
220 
221   if (const auto *RDecl = dyn_cast<RecordDecl>(Context))
222     if (!RDecl->isDependentType())
223       return getOrCreateType(CGM.getContext().getTypeDeclType(RDecl),
224                              getOrCreateMainFile());
225   return Default;
226 }
227 
228 PrintingPolicy CGDebugInfo::getPrintingPolicy() const {
229   PrintingPolicy PP = CGM.getContext().getPrintingPolicy();
230 
231   // If we're emitting codeview, it's important to try to match MSVC's naming so
232   // that visualizers written for MSVC will trigger for our class names. In
233   // particular, we can't have spaces between arguments of standard templates
234   // like basic_string and vector.
235   if (CGM.getCodeGenOpts().EmitCodeView)
236     PP.MSVCFormatting = true;
237 
238   return PP;
239 }
240 
241 StringRef CGDebugInfo::getFunctionName(const FunctionDecl *FD) {
242   assert(FD && "Invalid FunctionDecl!");
243   IdentifierInfo *FII = FD->getIdentifier();
244   FunctionTemplateSpecializationInfo *Info =
245       FD->getTemplateSpecializationInfo();
246 
247   // Emit the unqualified name in normal operation. LLVM and the debugger can
248   // compute the fully qualified name from the scope chain. If we're only
249   // emitting line table info, there won't be any scope chains, so emit the
250   // fully qualified name here so that stack traces are more accurate.
251   // FIXME: Do this when emitting DWARF as well as when emitting CodeView after
252   // evaluating the size impact.
253   bool UseQualifiedName = DebugKind == codegenoptions::DebugLineTablesOnly &&
254                           CGM.getCodeGenOpts().EmitCodeView;
255 
256   if (!Info && FII && !UseQualifiedName)
257     return FII->getName();
258 
259   SmallString<128> NS;
260   llvm::raw_svector_ostream OS(NS);
261   if (!UseQualifiedName)
262     FD->printName(OS);
263   else
264     FD->printQualifiedName(OS, getPrintingPolicy());
265 
266   // Add any template specialization args.
267   if (Info) {
268     const TemplateArgumentList *TArgs = Info->TemplateArguments;
269     printTemplateArgumentList(OS, TArgs->asArray(), getPrintingPolicy());
270   }
271 
272   // Copy this name on the side and use its reference.
273   return internString(OS.str());
274 }
275 
276 StringRef CGDebugInfo::getObjCMethodName(const ObjCMethodDecl *OMD) {
277   SmallString<256> MethodName;
278   llvm::raw_svector_ostream OS(MethodName);
279   OS << (OMD->isInstanceMethod() ? '-' : '+') << '[';
280   const DeclContext *DC = OMD->getDeclContext();
281   if (const auto *OID = dyn_cast<ObjCImplementationDecl>(DC)) {
282     OS << OID->getName();
283   } else if (const auto *OID = dyn_cast<ObjCInterfaceDecl>(DC)) {
284     OS << OID->getName();
285   } else if (const auto *OC = dyn_cast<ObjCCategoryDecl>(DC)) {
286     if (OC->IsClassExtension()) {
287       OS << OC->getClassInterface()->getName();
288     } else {
289       OS << OC->getIdentifier()->getNameStart() << '('
290          << OC->getIdentifier()->getNameStart() << ')';
291     }
292   } else if (const auto *OCD = dyn_cast<ObjCCategoryImplDecl>(DC)) {
293     OS << OCD->getClassInterface()->getName() << '(' << OCD->getName() << ')';
294   } else if (isa<ObjCProtocolDecl>(DC)) {
295     // We can extract the type of the class from the self pointer.
296     if (ImplicitParamDecl *SelfDecl = OMD->getSelfDecl()) {
297       QualType ClassTy =
298           cast<ObjCObjectPointerType>(SelfDecl->getType())->getPointeeType();
299       ClassTy.print(OS, PrintingPolicy(LangOptions()));
300     }
301   }
302   OS << ' ' << OMD->getSelector().getAsString() << ']';
303 
304   return internString(OS.str());
305 }
306 
307 StringRef CGDebugInfo::getSelectorName(Selector S) {
308   return internString(S.getAsString());
309 }
310 
311 StringRef CGDebugInfo::getClassName(const RecordDecl *RD) {
312   if (isa<ClassTemplateSpecializationDecl>(RD)) {
313     SmallString<128> Name;
314     llvm::raw_svector_ostream OS(Name);
315     RD->getNameForDiagnostic(OS, getPrintingPolicy(),
316                              /*Qualified*/ false);
317 
318     // Copy this name on the side and use its reference.
319     return internString(Name);
320   }
321 
322   // quick optimization to avoid having to intern strings that are already
323   // stored reliably elsewhere
324   if (const IdentifierInfo *II = RD->getIdentifier())
325     return II->getName();
326 
327   // The CodeView printer in LLVM wants to see the names of unnamed types: it is
328   // used to reconstruct the fully qualified type names.
329   if (CGM.getCodeGenOpts().EmitCodeView) {
330     if (const TypedefNameDecl *D = RD->getTypedefNameForAnonDecl()) {
331       assert(RD->getDeclContext() == D->getDeclContext() &&
332              "Typedef should not be in another decl context!");
333       assert(D->getDeclName().getAsIdentifierInfo() &&
334              "Typedef was not named!");
335       return D->getDeclName().getAsIdentifierInfo()->getName();
336     }
337 
338     if (CGM.getLangOpts().CPlusPlus) {
339       StringRef Name;
340 
341       ASTContext &Context = CGM.getContext();
342       if (const DeclaratorDecl *DD = Context.getDeclaratorForUnnamedTagDecl(RD))
343         // Anonymous types without a name for linkage purposes have their
344         // declarator mangled in if they have one.
345         Name = DD->getName();
346       else if (const TypedefNameDecl *TND =
347                    Context.getTypedefNameForUnnamedTagDecl(RD))
348         // Anonymous types without a name for linkage purposes have their
349         // associate typedef mangled in if they have one.
350         Name = TND->getName();
351 
352       if (!Name.empty()) {
353         SmallString<256> UnnamedType("<unnamed-type-");
354         UnnamedType += Name;
355         UnnamedType += '>';
356         return internString(UnnamedType);
357       }
358     }
359   }
360 
361   return StringRef();
362 }
363 
364 Optional<llvm::DIFile::ChecksumKind>
365 CGDebugInfo::computeChecksum(FileID FID, SmallString<32> &Checksum) const {
366   Checksum.clear();
367 
368   if (!CGM.getCodeGenOpts().EmitCodeView &&
369       CGM.getCodeGenOpts().DwarfVersion < 5)
370     return None;
371 
372   SourceManager &SM = CGM.getContext().getSourceManager();
373   bool Invalid;
374   llvm::MemoryBuffer *MemBuffer = SM.getBuffer(FID, &Invalid);
375   if (Invalid)
376     return None;
377 
378   llvm::MD5 Hash;
379   llvm::MD5::MD5Result Result;
380 
381   Hash.update(MemBuffer->getBuffer());
382   Hash.final(Result);
383 
384   Hash.stringifyResult(Result, Checksum);
385   return llvm::DIFile::CSK_MD5;
386 }
387 
388 Optional<StringRef> CGDebugInfo::getSource(const SourceManager &SM,
389                                            FileID FID) {
390   if (!CGM.getCodeGenOpts().EmbedSource)
391     return None;
392 
393   bool SourceInvalid = false;
394   StringRef Source = SM.getBufferData(FID, &SourceInvalid);
395 
396   if (SourceInvalid)
397     return None;
398 
399   return Source;
400 }
401 
402 llvm::DIFile *CGDebugInfo::getOrCreateFile(SourceLocation Loc) {
403   if (!Loc.isValid())
404     // If Location is not valid then use main input file.
405     return getOrCreateMainFile();
406 
407   SourceManager &SM = CGM.getContext().getSourceManager();
408   PresumedLoc PLoc = SM.getPresumedLoc(Loc);
409 
410   if (PLoc.isInvalid() || StringRef(PLoc.getFilename()).empty())
411     // If the location is not valid then use main input file.
412     return getOrCreateMainFile();
413 
414   // Cache the results.
415   const char *fname = PLoc.getFilename();
416   auto It = DIFileCache.find(fname);
417 
418   if (It != DIFileCache.end()) {
419     // Verify that the information still exists.
420     if (llvm::Metadata *V = It->second)
421       return cast<llvm::DIFile>(V);
422   }
423 
424   SmallString<32> Checksum;
425   Optional<llvm::DIFile::ChecksumKind> CSKind =
426       computeChecksum(SM.getFileID(Loc), Checksum);
427   Optional<llvm::DIFile::ChecksumInfo<StringRef>> CSInfo;
428   if (CSKind)
429     CSInfo.emplace(*CSKind, Checksum);
430 
431   llvm::DIFile *F = DBuilder.createFile(
432       remapDIPath(PLoc.getFilename()), remapDIPath(getCurrentDirname()), CSInfo,
433       getSource(SM, SM.getFileID(Loc)));
434 
435   DIFileCache[fname].reset(F);
436   return F;
437 }
438 
439 llvm::DIFile *CGDebugInfo::getOrCreateMainFile() {
440   return DBuilder.createFile(
441       remapDIPath(TheCU->getFilename()), remapDIPath(TheCU->getDirectory()),
442       TheCU->getFile()->getChecksum(),
443       CGM.getCodeGenOpts().EmbedSource ? TheCU->getSource() : None);
444 }
445 
446 std::string CGDebugInfo::remapDIPath(StringRef Path) const {
447   for (const auto &Entry : DebugPrefixMap)
448     if (Path.startswith(Entry.first))
449       return (Twine(Entry.second) + Path.substr(Entry.first.size())).str();
450   return Path.str();
451 }
452 
453 unsigned CGDebugInfo::getLineNumber(SourceLocation Loc) {
454   if (Loc.isInvalid() && CurLoc.isInvalid())
455     return 0;
456   SourceManager &SM = CGM.getContext().getSourceManager();
457   PresumedLoc PLoc = SM.getPresumedLoc(Loc.isValid() ? Loc : CurLoc);
458   return PLoc.isValid() ? PLoc.getLine() : 0;
459 }
460 
461 unsigned CGDebugInfo::getColumnNumber(SourceLocation Loc, bool Force) {
462   // We may not want column information at all.
463   if (!Force && !CGM.getCodeGenOpts().DebugColumnInfo)
464     return 0;
465 
466   // If the location is invalid then use the current column.
467   if (Loc.isInvalid() && CurLoc.isInvalid())
468     return 0;
469   SourceManager &SM = CGM.getContext().getSourceManager();
470   PresumedLoc PLoc = SM.getPresumedLoc(Loc.isValid() ? Loc : CurLoc);
471   return PLoc.isValid() ? PLoc.getColumn() : 0;
472 }
473 
474 StringRef CGDebugInfo::getCurrentDirname() {
475   if (!CGM.getCodeGenOpts().DebugCompilationDir.empty())
476     return CGM.getCodeGenOpts().DebugCompilationDir;
477 
478   if (!CWDName.empty())
479     return CWDName;
480   SmallString<256> CWD;
481   llvm::sys::fs::current_path(CWD);
482   return CWDName = internString(CWD);
483 }
484 
485 void CGDebugInfo::CreateCompileUnit() {
486   SmallString<32> Checksum;
487   Optional<llvm::DIFile::ChecksumKind> CSKind;
488   Optional<llvm::DIFile::ChecksumInfo<StringRef>> CSInfo;
489 
490   // Should we be asking the SourceManager for the main file name, instead of
491   // accepting it as an argument? This just causes the main file name to
492   // mismatch with source locations and create extra lexical scopes or
493   // mismatched debug info (a CU with a DW_AT_file of "-", because that's what
494   // the driver passed, but functions/other things have DW_AT_file of "<stdin>"
495   // because that's what the SourceManager says)
496 
497   // Get absolute path name.
498   SourceManager &SM = CGM.getContext().getSourceManager();
499   std::string MainFileName = CGM.getCodeGenOpts().MainFileName;
500   if (MainFileName.empty())
501     MainFileName = "<stdin>";
502 
503   // The main file name provided via the "-main-file-name" option contains just
504   // the file name itself with no path information. This file name may have had
505   // a relative path, so we look into the actual file entry for the main
506   // file to determine the real absolute path for the file.
507   std::string MainFileDir;
508   if (const FileEntry *MainFile = SM.getFileEntryForID(SM.getMainFileID())) {
509     MainFileDir = remapDIPath(MainFile->getDir()->getName());
510     if (MainFileDir != ".") {
511       llvm::SmallString<1024> MainFileDirSS(MainFileDir);
512       llvm::sys::path::append(MainFileDirSS, MainFileName);
513       MainFileName = MainFileDirSS.str();
514     }
515     // If the main file name provided is identical to the input file name, and
516     // if the input file is a preprocessed source, use the module name for
517     // debug info. The module name comes from the name specified in the first
518     // linemarker if the input is a preprocessed source.
519     if (MainFile->getName() == MainFileName &&
520         FrontendOptions::getInputKindForExtension(
521             MainFile->getName().rsplit('.').second)
522             .isPreprocessed())
523       MainFileName = CGM.getModule().getName().str();
524 
525     CSKind = computeChecksum(SM.getMainFileID(), Checksum);
526   }
527 
528   llvm::dwarf::SourceLanguage LangTag;
529   const LangOptions &LO = CGM.getLangOpts();
530   if (LO.CPlusPlus) {
531     if (LO.ObjC1)
532       LangTag = llvm::dwarf::DW_LANG_ObjC_plus_plus;
533     else
534       LangTag = llvm::dwarf::DW_LANG_C_plus_plus;
535   } else if (LO.ObjC1) {
536     LangTag = llvm::dwarf::DW_LANG_ObjC;
537   } else if (LO.RenderScript) {
538     LangTag = llvm::dwarf::DW_LANG_GOOGLE_RenderScript;
539   } else if (LO.C99) {
540     LangTag = llvm::dwarf::DW_LANG_C99;
541   } else {
542     LangTag = llvm::dwarf::DW_LANG_C89;
543   }
544 
545   std::string Producer = getClangFullVersion();
546 
547   // Figure out which version of the ObjC runtime we have.
548   unsigned RuntimeVers = 0;
549   if (LO.ObjC1)
550     RuntimeVers = LO.ObjCRuntime.isNonFragile() ? 2 : 1;
551 
552   llvm::DICompileUnit::DebugEmissionKind EmissionKind;
553   switch (DebugKind) {
554   case codegenoptions::NoDebugInfo:
555   case codegenoptions::LocTrackingOnly:
556     EmissionKind = llvm::DICompileUnit::NoDebug;
557     break;
558   case codegenoptions::DebugLineTablesOnly:
559     EmissionKind = llvm::DICompileUnit::LineTablesOnly;
560     break;
561   case codegenoptions::DebugDirectivesOnly:
562     EmissionKind = llvm::DICompileUnit::DebugDirectivesOnly;
563     break;
564   case codegenoptions::LimitedDebugInfo:
565   case codegenoptions::FullDebugInfo:
566     EmissionKind = llvm::DICompileUnit::FullDebug;
567     break;
568   }
569 
570   if (CSKind)
571     CSInfo.emplace(*CSKind, Checksum);
572 
573   // Create new compile unit.
574   // FIXME - Eliminate TheCU.
575   auto &CGOpts = CGM.getCodeGenOpts();
576   TheCU = DBuilder.createCompileUnit(
577       LangTag,
578       DBuilder.createFile(remapDIPath(MainFileName),
579                           remapDIPath(getCurrentDirname()), CSInfo,
580                           getSource(SM, SM.getMainFileID())),
581       CGOpts.EmitVersionIdentMetadata ? Producer : "",
582       LO.Optimize || CGOpts.PrepareForLTO || CGOpts.PrepareForThinLTO,
583       CGOpts.DwarfDebugFlags, RuntimeVers,
584       CGOpts.EnableSplitDwarf ? "" : CGOpts.SplitDwarfFile, EmissionKind,
585       0 /* DWOid */, CGOpts.SplitDwarfInlining, CGOpts.DebugInfoForProfiling,
586       CGM.getTarget().getTriple().isNVPTX()
587           ? llvm::DICompileUnit::DebugNameTableKind::None
588           : static_cast<llvm::DICompileUnit::DebugNameTableKind>(
589                 CGOpts.DebugNameTable));
590 }
591 
592 llvm::DIType *CGDebugInfo::CreateType(const BuiltinType *BT) {
593   llvm::dwarf::TypeKind Encoding;
594   StringRef BTName;
595   switch (BT->getKind()) {
596 #define BUILTIN_TYPE(Id, SingletonId)
597 #define PLACEHOLDER_TYPE(Id, SingletonId) case BuiltinType::Id:
598 #include "clang/AST/BuiltinTypes.def"
599   case BuiltinType::Dependent:
600     llvm_unreachable("Unexpected builtin type");
601   case BuiltinType::NullPtr:
602     return DBuilder.createNullPtrType();
603   case BuiltinType::Void:
604     return nullptr;
605   case BuiltinType::ObjCClass:
606     if (!ClassTy)
607       ClassTy = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
608                                            "objc_class", TheCU,
609                                            getOrCreateMainFile(), 0);
610     return ClassTy;
611   case BuiltinType::ObjCId: {
612     // typedef struct objc_class *Class;
613     // typedef struct objc_object {
614     //  Class isa;
615     // } *id;
616 
617     if (ObjTy)
618       return ObjTy;
619 
620     if (!ClassTy)
621       ClassTy = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
622                                            "objc_class", TheCU,
623                                            getOrCreateMainFile(), 0);
624 
625     unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
626 
627     auto *ISATy = DBuilder.createPointerType(ClassTy, Size);
628 
629     ObjTy = DBuilder.createStructType(
630         TheCU, "objc_object", getOrCreateMainFile(), 0, 0, 0,
631         llvm::DINode::FlagZero, nullptr, llvm::DINodeArray());
632 
633     DBuilder.replaceArrays(
634         ObjTy, DBuilder.getOrCreateArray(&*DBuilder.createMemberType(
635                    ObjTy, "isa", getOrCreateMainFile(), 0, Size, 0, 0,
636                    llvm::DINode::FlagZero, ISATy)));
637     return ObjTy;
638   }
639   case BuiltinType::ObjCSel: {
640     if (!SelTy)
641       SelTy = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
642                                          "objc_selector", TheCU,
643                                          getOrCreateMainFile(), 0);
644     return SelTy;
645   }
646 
647 #define IMAGE_TYPE(ImgType, Id, SingletonId, Access, Suffix)                   \
648   case BuiltinType::Id:                                                        \
649     return getOrCreateStructPtrType("opencl_" #ImgType "_" #Suffix "_t",       \
650                                     SingletonId);
651 #include "clang/Basic/OpenCLImageTypes.def"
652   case BuiltinType::OCLSampler:
653     return getOrCreateStructPtrType("opencl_sampler_t", OCLSamplerDITy);
654   case BuiltinType::OCLEvent:
655     return getOrCreateStructPtrType("opencl_event_t", OCLEventDITy);
656   case BuiltinType::OCLClkEvent:
657     return getOrCreateStructPtrType("opencl_clk_event_t", OCLClkEventDITy);
658   case BuiltinType::OCLQueue:
659     return getOrCreateStructPtrType("opencl_queue_t", OCLQueueDITy);
660   case BuiltinType::OCLReserveID:
661     return getOrCreateStructPtrType("opencl_reserve_id_t", OCLReserveIDDITy);
662 
663   case BuiltinType::UChar:
664   case BuiltinType::Char_U:
665     Encoding = llvm::dwarf::DW_ATE_unsigned_char;
666     break;
667   case BuiltinType::Char_S:
668   case BuiltinType::SChar:
669     Encoding = llvm::dwarf::DW_ATE_signed_char;
670     break;
671   case BuiltinType::Char8:
672   case BuiltinType::Char16:
673   case BuiltinType::Char32:
674     Encoding = llvm::dwarf::DW_ATE_UTF;
675     break;
676   case BuiltinType::UShort:
677   case BuiltinType::UInt:
678   case BuiltinType::UInt128:
679   case BuiltinType::ULong:
680   case BuiltinType::WChar_U:
681   case BuiltinType::ULongLong:
682     Encoding = llvm::dwarf::DW_ATE_unsigned;
683     break;
684   case BuiltinType::Short:
685   case BuiltinType::Int:
686   case BuiltinType::Int128:
687   case BuiltinType::Long:
688   case BuiltinType::WChar_S:
689   case BuiltinType::LongLong:
690     Encoding = llvm::dwarf::DW_ATE_signed;
691     break;
692   case BuiltinType::Bool:
693     Encoding = llvm::dwarf::DW_ATE_boolean;
694     break;
695   case BuiltinType::Half:
696   case BuiltinType::Float:
697   case BuiltinType::LongDouble:
698   case BuiltinType::Float16:
699   case BuiltinType::Float128:
700   case BuiltinType::Double:
701     // FIXME: For targets where long double and __float128 have the same size,
702     // they are currently indistinguishable in the debugger without some
703     // special treatment. However, there is currently no consensus on encoding
704     // and this should be updated once a DWARF encoding exists for distinct
705     // floating point types of the same size.
706     Encoding = llvm::dwarf::DW_ATE_float;
707     break;
708   case BuiltinType::ShortAccum:
709   case BuiltinType::Accum:
710   case BuiltinType::LongAccum:
711   case BuiltinType::ShortFract:
712   case BuiltinType::Fract:
713   case BuiltinType::LongFract:
714   case BuiltinType::SatShortFract:
715   case BuiltinType::SatFract:
716   case BuiltinType::SatLongFract:
717   case BuiltinType::SatShortAccum:
718   case BuiltinType::SatAccum:
719   case BuiltinType::SatLongAccum:
720     Encoding = llvm::dwarf::DW_ATE_signed_fixed;
721     break;
722   case BuiltinType::UShortAccum:
723   case BuiltinType::UAccum:
724   case BuiltinType::ULongAccum:
725   case BuiltinType::UShortFract:
726   case BuiltinType::UFract:
727   case BuiltinType::ULongFract:
728   case BuiltinType::SatUShortAccum:
729   case BuiltinType::SatUAccum:
730   case BuiltinType::SatULongAccum:
731   case BuiltinType::SatUShortFract:
732   case BuiltinType::SatUFract:
733   case BuiltinType::SatULongFract:
734     Encoding = llvm::dwarf::DW_ATE_unsigned_fixed;
735     break;
736   }
737 
738   switch (BT->getKind()) {
739   case BuiltinType::Long:
740     BTName = "long int";
741     break;
742   case BuiltinType::LongLong:
743     BTName = "long long int";
744     break;
745   case BuiltinType::ULong:
746     BTName = "long unsigned int";
747     break;
748   case BuiltinType::ULongLong:
749     BTName = "long long unsigned int";
750     break;
751   default:
752     BTName = BT->getName(CGM.getLangOpts());
753     break;
754   }
755   // Bit size and offset of the type.
756   uint64_t Size = CGM.getContext().getTypeSize(BT);
757   return DBuilder.createBasicType(BTName, Size, Encoding);
758 }
759 
760 llvm::DIType *CGDebugInfo::CreateType(const ComplexType *Ty) {
761   // Bit size and offset of the type.
762   llvm::dwarf::TypeKind Encoding = llvm::dwarf::DW_ATE_complex_float;
763   if (Ty->isComplexIntegerType())
764     Encoding = llvm::dwarf::DW_ATE_lo_user;
765 
766   uint64_t Size = CGM.getContext().getTypeSize(Ty);
767   return DBuilder.createBasicType("complex", Size, Encoding);
768 }
769 
770 llvm::DIType *CGDebugInfo::CreateQualifiedType(QualType Ty,
771                                                llvm::DIFile *Unit) {
772   QualifierCollector Qc;
773   const Type *T = Qc.strip(Ty);
774 
775   // Ignore these qualifiers for now.
776   Qc.removeObjCGCAttr();
777   Qc.removeAddressSpace();
778   Qc.removeObjCLifetime();
779 
780   // We will create one Derived type for one qualifier and recurse to handle any
781   // additional ones.
782   llvm::dwarf::Tag Tag;
783   if (Qc.hasConst()) {
784     Tag = llvm::dwarf::DW_TAG_const_type;
785     Qc.removeConst();
786   } else if (Qc.hasVolatile()) {
787     Tag = llvm::dwarf::DW_TAG_volatile_type;
788     Qc.removeVolatile();
789   } else if (Qc.hasRestrict()) {
790     Tag = llvm::dwarf::DW_TAG_restrict_type;
791     Qc.removeRestrict();
792   } else {
793     assert(Qc.empty() && "Unknown type qualifier for debug info");
794     return getOrCreateType(QualType(T, 0), Unit);
795   }
796 
797   auto *FromTy = getOrCreateType(Qc.apply(CGM.getContext(), T), Unit);
798 
799   // No need to fill in the Name, Line, Size, Alignment, Offset in case of
800   // CVR derived types.
801   return DBuilder.createQualifiedType(Tag, FromTy);
802 }
803 
804 llvm::DIType *CGDebugInfo::CreateType(const ObjCObjectPointerType *Ty,
805                                       llvm::DIFile *Unit) {
806 
807   // The frontend treats 'id' as a typedef to an ObjCObjectType,
808   // whereas 'id<protocol>' is treated as an ObjCPointerType. For the
809   // debug info, we want to emit 'id' in both cases.
810   if (Ty->isObjCQualifiedIdType())
811     return getOrCreateType(CGM.getContext().getObjCIdType(), Unit);
812 
813   return CreatePointerLikeType(llvm::dwarf::DW_TAG_pointer_type, Ty,
814                                Ty->getPointeeType(), Unit);
815 }
816 
817 llvm::DIType *CGDebugInfo::CreateType(const PointerType *Ty,
818                                       llvm::DIFile *Unit) {
819   return CreatePointerLikeType(llvm::dwarf::DW_TAG_pointer_type, Ty,
820                                Ty->getPointeeType(), Unit);
821 }
822 
823 /// \return whether a C++ mangling exists for the type defined by TD.
824 static bool hasCXXMangling(const TagDecl *TD, llvm::DICompileUnit *TheCU) {
825   switch (TheCU->getSourceLanguage()) {
826   case llvm::dwarf::DW_LANG_C_plus_plus:
827     return true;
828   case llvm::dwarf::DW_LANG_ObjC_plus_plus:
829     return isa<CXXRecordDecl>(TD) || isa<EnumDecl>(TD);
830   default:
831     return false;
832   }
833 }
834 
835 // Determines if the debug info for this tag declaration needs a type
836 // identifier. The purpose of the unique identifier is to deduplicate type
837 // information for identical types across TUs. Because of the C++ one definition
838 // rule (ODR), it is valid to assume that the type is defined the same way in
839 // every TU and its debug info is equivalent.
840 //
841 // C does not have the ODR, and it is common for codebases to contain multiple
842 // different definitions of a struct with the same name in different TUs.
843 // Therefore, if the type doesn't have a C++ mangling, don't give it an
844 // identifer. Type information in C is smaller and simpler than C++ type
845 // information, so the increase in debug info size is negligible.
846 //
847 // If the type is not externally visible, it should be unique to the current TU,
848 // and should not need an identifier to participate in type deduplication.
849 // However, when emitting CodeView, the format internally uses these
850 // unique type name identifers for references between debug info. For example,
851 // the method of a class in an anonymous namespace uses the identifer to refer
852 // to its parent class. The Microsoft C++ ABI attempts to provide unique names
853 // for such types, so when emitting CodeView, always use identifiers for C++
854 // types. This may create problems when attempting to emit CodeView when the MS
855 // C++ ABI is not in use.
856 static bool needsTypeIdentifier(const TagDecl *TD, CodeGenModule &CGM,
857                                 llvm::DICompileUnit *TheCU) {
858   // We only add a type identifier for types with C++ name mangling.
859   if (!hasCXXMangling(TD, TheCU))
860     return false;
861 
862   // Externally visible types with C++ mangling need a type identifier.
863   if (TD->isExternallyVisible())
864     return true;
865 
866   // CodeView types with C++ mangling need a type identifier.
867   if (CGM.getCodeGenOpts().EmitCodeView)
868     return true;
869 
870   return false;
871 }
872 
873 // Returns a unique type identifier string if one exists, or an empty string.
874 static SmallString<256> getTypeIdentifier(const TagType *Ty, CodeGenModule &CGM,
875                                           llvm::DICompileUnit *TheCU) {
876   SmallString<256> Identifier;
877   const TagDecl *TD = Ty->getDecl();
878 
879   if (!needsTypeIdentifier(TD, CGM, TheCU))
880     return Identifier;
881 
882   // TODO: This is using the RTTI name. Is there a better way to get
883   // a unique string for a type?
884   llvm::raw_svector_ostream Out(Identifier);
885   CGM.getCXXABI().getMangleContext().mangleCXXRTTIName(QualType(Ty, 0), Out);
886   return Identifier;
887 }
888 
889 /// \return the appropriate DWARF tag for a composite type.
890 static llvm::dwarf::Tag getTagForRecord(const RecordDecl *RD) {
891   llvm::dwarf::Tag Tag;
892   if (RD->isStruct() || RD->isInterface())
893     Tag = llvm::dwarf::DW_TAG_structure_type;
894   else if (RD->isUnion())
895     Tag = llvm::dwarf::DW_TAG_union_type;
896   else {
897     // FIXME: This could be a struct type giving a default visibility different
898     // than C++ class type, but needs llvm metadata changes first.
899     assert(RD->isClass());
900     Tag = llvm::dwarf::DW_TAG_class_type;
901   }
902   return Tag;
903 }
904 
905 llvm::DICompositeType *
906 CGDebugInfo::getOrCreateRecordFwdDecl(const RecordType *Ty,
907                                       llvm::DIScope *Ctx) {
908   const RecordDecl *RD = Ty->getDecl();
909   if (llvm::DIType *T = getTypeOrNull(CGM.getContext().getRecordType(RD)))
910     return cast<llvm::DICompositeType>(T);
911   llvm::DIFile *DefUnit = getOrCreateFile(RD->getLocation());
912   unsigned Line = getLineNumber(RD->getLocation());
913   StringRef RDName = getClassName(RD);
914 
915   uint64_t Size = 0;
916   uint32_t Align = 0;
917 
918   // Create the type.
919   SmallString<256> Identifier = getTypeIdentifier(Ty, CGM, TheCU);
920   llvm::DICompositeType *RetTy = DBuilder.createReplaceableCompositeType(
921       getTagForRecord(RD), RDName, Ctx, DefUnit, Line, 0, Size, Align,
922       llvm::DINode::FlagFwdDecl, Identifier);
923   if (CGM.getCodeGenOpts().DebugFwdTemplateParams)
924     if (auto *TSpecial = dyn_cast<ClassTemplateSpecializationDecl>(RD))
925       DBuilder.replaceArrays(RetTy, llvm::DINodeArray(),
926                              CollectCXXTemplateParams(TSpecial, DefUnit));
927   ReplaceMap.emplace_back(
928       std::piecewise_construct, std::make_tuple(Ty),
929       std::make_tuple(static_cast<llvm::Metadata *>(RetTy)));
930   return RetTy;
931 }
932 
933 llvm::DIType *CGDebugInfo::CreatePointerLikeType(llvm::dwarf::Tag Tag,
934                                                  const Type *Ty,
935                                                  QualType PointeeTy,
936                                                  llvm::DIFile *Unit) {
937   // Bit size, align and offset of the type.
938   // Size is always the size of a pointer. We can't use getTypeSize here
939   // because that does not return the correct value for references.
940   unsigned AddressSpace = CGM.getContext().getTargetAddressSpace(PointeeTy);
941   uint64_t Size = CGM.getTarget().getPointerWidth(AddressSpace);
942   auto Align = getTypeAlignIfRequired(Ty, CGM.getContext());
943   Optional<unsigned> DWARFAddressSpace =
944       CGM.getTarget().getDWARFAddressSpace(AddressSpace);
945 
946   if (Tag == llvm::dwarf::DW_TAG_reference_type ||
947       Tag == llvm::dwarf::DW_TAG_rvalue_reference_type)
948     return DBuilder.createReferenceType(Tag, getOrCreateType(PointeeTy, Unit),
949                                         Size, Align, DWARFAddressSpace);
950   else
951     return DBuilder.createPointerType(getOrCreateType(PointeeTy, Unit), Size,
952                                       Align, DWARFAddressSpace);
953 }
954 
955 llvm::DIType *CGDebugInfo::getOrCreateStructPtrType(StringRef Name,
956                                                     llvm::DIType *&Cache) {
957   if (Cache)
958     return Cache;
959   Cache = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type, Name,
960                                      TheCU, getOrCreateMainFile(), 0);
961   unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
962   Cache = DBuilder.createPointerType(Cache, Size);
963   return Cache;
964 }
965 
966 uint64_t CGDebugInfo::collectDefaultElementTypesForBlockPointer(
967     const BlockPointerType *Ty, llvm::DIFile *Unit, llvm::DIDerivedType *DescTy,
968     unsigned LineNo, SmallVectorImpl<llvm::Metadata *> &EltTys) {
969   QualType FType;
970 
971   // Advanced by calls to CreateMemberType in increments of FType, then
972   // returned as the overall size of the default elements.
973   uint64_t FieldOffset = 0;
974 
975   // Blocks in OpenCL have unique constraints which make the standard fields
976   // redundant while requiring size and align fields for enqueue_kernel. See
977   // initializeForBlockHeader in CGBlocks.cpp
978   if (CGM.getLangOpts().OpenCL) {
979     FType = CGM.getContext().IntTy;
980     EltTys.push_back(CreateMemberType(Unit, FType, "__size", &FieldOffset));
981     EltTys.push_back(CreateMemberType(Unit, FType, "__align", &FieldOffset));
982   } else {
983     FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
984     EltTys.push_back(CreateMemberType(Unit, FType, "__isa", &FieldOffset));
985     FType = CGM.getContext().IntTy;
986     EltTys.push_back(CreateMemberType(Unit, FType, "__flags", &FieldOffset));
987     EltTys.push_back(CreateMemberType(Unit, FType, "__reserved", &FieldOffset));
988     FType = CGM.getContext().getPointerType(Ty->getPointeeType());
989     EltTys.push_back(CreateMemberType(Unit, FType, "__FuncPtr", &FieldOffset));
990     FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
991     uint64_t FieldSize = CGM.getContext().getTypeSize(Ty);
992     uint32_t FieldAlign = CGM.getContext().getTypeAlign(Ty);
993     EltTys.push_back(DBuilder.createMemberType(
994         Unit, "__descriptor", nullptr, LineNo, FieldSize, FieldAlign,
995         FieldOffset, llvm::DINode::FlagZero, DescTy));
996     FieldOffset += FieldSize;
997   }
998 
999   return FieldOffset;
1000 }
1001 
1002 llvm::DIType *CGDebugInfo::CreateType(const BlockPointerType *Ty,
1003                                       llvm::DIFile *Unit) {
1004   SmallVector<llvm::Metadata *, 8> EltTys;
1005   QualType FType;
1006   uint64_t FieldOffset;
1007   llvm::DINodeArray Elements;
1008 
1009   FieldOffset = 0;
1010   FType = CGM.getContext().UnsignedLongTy;
1011   EltTys.push_back(CreateMemberType(Unit, FType, "reserved", &FieldOffset));
1012   EltTys.push_back(CreateMemberType(Unit, FType, "Size", &FieldOffset));
1013 
1014   Elements = DBuilder.getOrCreateArray(EltTys);
1015   EltTys.clear();
1016 
1017   llvm::DINode::DIFlags Flags = llvm::DINode::FlagAppleBlock;
1018 
1019   auto *EltTy =
1020       DBuilder.createStructType(Unit, "__block_descriptor", nullptr, 0,
1021                                 FieldOffset, 0, Flags, nullptr, Elements);
1022 
1023   // Bit size, align and offset of the type.
1024   uint64_t Size = CGM.getContext().getTypeSize(Ty);
1025 
1026   auto *DescTy = DBuilder.createPointerType(EltTy, Size);
1027 
1028   FieldOffset = collectDefaultElementTypesForBlockPointer(Ty, Unit, DescTy,
1029                                                           0, EltTys);
1030 
1031   Elements = DBuilder.getOrCreateArray(EltTys);
1032 
1033   // The __block_literal_generic structs are marked with a special
1034   // DW_AT_APPLE_BLOCK attribute and are an implementation detail only
1035   // the debugger needs to know about. To allow type uniquing, emit
1036   // them without a name or a location.
1037   EltTy = DBuilder.createStructType(Unit, "", nullptr, 0, FieldOffset, 0,
1038                                     Flags, nullptr, Elements);
1039 
1040   return DBuilder.createPointerType(EltTy, Size);
1041 }
1042 
1043 llvm::DIType *CGDebugInfo::CreateType(const TemplateSpecializationType *Ty,
1044                                       llvm::DIFile *Unit) {
1045   assert(Ty->isTypeAlias());
1046   llvm::DIType *Src = getOrCreateType(Ty->getAliasedType(), Unit);
1047 
1048   SmallString<128> NS;
1049   llvm::raw_svector_ostream OS(NS);
1050   Ty->getTemplateName().print(OS, getPrintingPolicy(), /*qualified*/ false);
1051   printTemplateArgumentList(OS, Ty->template_arguments(), getPrintingPolicy());
1052 
1053   auto *AliasDecl =
1054       cast<TypeAliasTemplateDecl>(Ty->getTemplateName().getAsTemplateDecl())
1055           ->getTemplatedDecl();
1056 
1057   SourceLocation Loc = AliasDecl->getLocation();
1058   return DBuilder.createTypedef(Src, OS.str(), getOrCreateFile(Loc),
1059                                 getLineNumber(Loc),
1060                                 getDeclContextDescriptor(AliasDecl));
1061 }
1062 
1063 llvm::DIType *CGDebugInfo::CreateType(const TypedefType *Ty,
1064                                       llvm::DIFile *Unit) {
1065   // We don't set size information, but do specify where the typedef was
1066   // declared.
1067   SourceLocation Loc = Ty->getDecl()->getLocation();
1068 
1069   // Typedefs are derived from some other type.
1070   return DBuilder.createTypedef(
1071       getOrCreateType(Ty->getDecl()->getUnderlyingType(), Unit),
1072       Ty->getDecl()->getName(), getOrCreateFile(Loc), getLineNumber(Loc),
1073       getDeclContextDescriptor(Ty->getDecl()));
1074 }
1075 
1076 static unsigned getDwarfCC(CallingConv CC) {
1077   switch (CC) {
1078   case CC_C:
1079     // Avoid emitting DW_AT_calling_convention if the C convention was used.
1080     return 0;
1081 
1082   case CC_X86StdCall:
1083     return llvm::dwarf::DW_CC_BORLAND_stdcall;
1084   case CC_X86FastCall:
1085     return llvm::dwarf::DW_CC_BORLAND_msfastcall;
1086   case CC_X86ThisCall:
1087     return llvm::dwarf::DW_CC_BORLAND_thiscall;
1088   case CC_X86VectorCall:
1089     return llvm::dwarf::DW_CC_LLVM_vectorcall;
1090   case CC_X86Pascal:
1091     return llvm::dwarf::DW_CC_BORLAND_pascal;
1092   case CC_Win64:
1093     return llvm::dwarf::DW_CC_LLVM_Win64;
1094   case CC_X86_64SysV:
1095     return llvm::dwarf::DW_CC_LLVM_X86_64SysV;
1096   case CC_AAPCS:
1097     return llvm::dwarf::DW_CC_LLVM_AAPCS;
1098   case CC_AAPCS_VFP:
1099     return llvm::dwarf::DW_CC_LLVM_AAPCS_VFP;
1100   case CC_IntelOclBicc:
1101     return llvm::dwarf::DW_CC_LLVM_IntelOclBicc;
1102   case CC_SpirFunction:
1103     return llvm::dwarf::DW_CC_LLVM_SpirFunction;
1104   case CC_OpenCLKernel:
1105     return llvm::dwarf::DW_CC_LLVM_OpenCLKernel;
1106   case CC_Swift:
1107     return llvm::dwarf::DW_CC_LLVM_Swift;
1108   case CC_PreserveMost:
1109     return llvm::dwarf::DW_CC_LLVM_PreserveMost;
1110   case CC_PreserveAll:
1111     return llvm::dwarf::DW_CC_LLVM_PreserveAll;
1112   case CC_X86RegCall:
1113     return llvm::dwarf::DW_CC_LLVM_X86RegCall;
1114   }
1115   return 0;
1116 }
1117 
1118 llvm::DIType *CGDebugInfo::CreateType(const FunctionType *Ty,
1119                                       llvm::DIFile *Unit) {
1120   SmallVector<llvm::Metadata *, 16> EltTys;
1121 
1122   // Add the result type at least.
1123   EltTys.push_back(getOrCreateType(Ty->getReturnType(), Unit));
1124 
1125   // Set up remainder of arguments if there is a prototype.
1126   // otherwise emit it as a variadic function.
1127   if (isa<FunctionNoProtoType>(Ty))
1128     EltTys.push_back(DBuilder.createUnspecifiedParameter());
1129   else if (const auto *FPT = dyn_cast<FunctionProtoType>(Ty)) {
1130     for (const QualType &ParamType : FPT->param_types())
1131       EltTys.push_back(getOrCreateType(ParamType, Unit));
1132     if (FPT->isVariadic())
1133       EltTys.push_back(DBuilder.createUnspecifiedParameter());
1134   }
1135 
1136   llvm::DITypeRefArray EltTypeArray = DBuilder.getOrCreateTypeArray(EltTys);
1137   return DBuilder.createSubroutineType(EltTypeArray, llvm::DINode::FlagZero,
1138                                        getDwarfCC(Ty->getCallConv()));
1139 }
1140 
1141 /// Convert an AccessSpecifier into the corresponding DINode flag.
1142 /// As an optimization, return 0 if the access specifier equals the
1143 /// default for the containing type.
1144 static llvm::DINode::DIFlags getAccessFlag(AccessSpecifier Access,
1145                                            const RecordDecl *RD) {
1146   AccessSpecifier Default = clang::AS_none;
1147   if (RD && RD->isClass())
1148     Default = clang::AS_private;
1149   else if (RD && (RD->isStruct() || RD->isUnion()))
1150     Default = clang::AS_public;
1151 
1152   if (Access == Default)
1153     return llvm::DINode::FlagZero;
1154 
1155   switch (Access) {
1156   case clang::AS_private:
1157     return llvm::DINode::FlagPrivate;
1158   case clang::AS_protected:
1159     return llvm::DINode::FlagProtected;
1160   case clang::AS_public:
1161     return llvm::DINode::FlagPublic;
1162   case clang::AS_none:
1163     return llvm::DINode::FlagZero;
1164   }
1165   llvm_unreachable("unexpected access enumerator");
1166 }
1167 
1168 llvm::DIType *CGDebugInfo::createBitFieldType(const FieldDecl *BitFieldDecl,
1169                                               llvm::DIScope *RecordTy,
1170                                               const RecordDecl *RD) {
1171   StringRef Name = BitFieldDecl->getName();
1172   QualType Ty = BitFieldDecl->getType();
1173   SourceLocation Loc = BitFieldDecl->getLocation();
1174   llvm::DIFile *VUnit = getOrCreateFile(Loc);
1175   llvm::DIType *DebugType = getOrCreateType(Ty, VUnit);
1176 
1177   // Get the location for the field.
1178   llvm::DIFile *File = getOrCreateFile(Loc);
1179   unsigned Line = getLineNumber(Loc);
1180 
1181   const CGBitFieldInfo &BitFieldInfo =
1182       CGM.getTypes().getCGRecordLayout(RD).getBitFieldInfo(BitFieldDecl);
1183   uint64_t SizeInBits = BitFieldInfo.Size;
1184   assert(SizeInBits > 0 && "found named 0-width bitfield");
1185   uint64_t StorageOffsetInBits =
1186       CGM.getContext().toBits(BitFieldInfo.StorageOffset);
1187   uint64_t Offset = BitFieldInfo.Offset;
1188   // The bit offsets for big endian machines are reversed for big
1189   // endian target, compensate for that as the DIDerivedType requires
1190   // un-reversed offsets.
1191   if (CGM.getDataLayout().isBigEndian())
1192     Offset = BitFieldInfo.StorageSize - BitFieldInfo.Size - Offset;
1193   uint64_t OffsetInBits = StorageOffsetInBits + Offset;
1194   llvm::DINode::DIFlags Flags = getAccessFlag(BitFieldDecl->getAccess(), RD);
1195   return DBuilder.createBitFieldMemberType(
1196       RecordTy, Name, File, Line, SizeInBits, OffsetInBits, StorageOffsetInBits,
1197       Flags, DebugType);
1198 }
1199 
1200 llvm::DIType *
1201 CGDebugInfo::createFieldType(StringRef name, QualType type, SourceLocation loc,
1202                              AccessSpecifier AS, uint64_t offsetInBits,
1203                              uint32_t AlignInBits, llvm::DIFile *tunit,
1204                              llvm::DIScope *scope, const RecordDecl *RD) {
1205   llvm::DIType *debugType = getOrCreateType(type, tunit);
1206 
1207   // Get the location for the field.
1208   llvm::DIFile *file = getOrCreateFile(loc);
1209   unsigned line = getLineNumber(loc);
1210 
1211   uint64_t SizeInBits = 0;
1212   auto Align = AlignInBits;
1213   if (!type->isIncompleteArrayType()) {
1214     TypeInfo TI = CGM.getContext().getTypeInfo(type);
1215     SizeInBits = TI.Width;
1216     if (!Align)
1217       Align = getTypeAlignIfRequired(type, CGM.getContext());
1218   }
1219 
1220   llvm::DINode::DIFlags flags = getAccessFlag(AS, RD);
1221   return DBuilder.createMemberType(scope, name, file, line, SizeInBits, Align,
1222                                    offsetInBits, flags, debugType);
1223 }
1224 
1225 void CGDebugInfo::CollectRecordLambdaFields(
1226     const CXXRecordDecl *CXXDecl, SmallVectorImpl<llvm::Metadata *> &elements,
1227     llvm::DIType *RecordTy) {
1228   // For C++11 Lambdas a Field will be the same as a Capture, but the Capture
1229   // has the name and the location of the variable so we should iterate over
1230   // both concurrently.
1231   const ASTRecordLayout &layout = CGM.getContext().getASTRecordLayout(CXXDecl);
1232   RecordDecl::field_iterator Field = CXXDecl->field_begin();
1233   unsigned fieldno = 0;
1234   for (CXXRecordDecl::capture_const_iterator I = CXXDecl->captures_begin(),
1235                                              E = CXXDecl->captures_end();
1236        I != E; ++I, ++Field, ++fieldno) {
1237     const LambdaCapture &C = *I;
1238     if (C.capturesVariable()) {
1239       SourceLocation Loc = C.getLocation();
1240       assert(!Field->isBitField() && "lambdas don't have bitfield members!");
1241       VarDecl *V = C.getCapturedVar();
1242       StringRef VName = V->getName();
1243       llvm::DIFile *VUnit = getOrCreateFile(Loc);
1244       auto Align = getDeclAlignIfRequired(V, CGM.getContext());
1245       llvm::DIType *FieldType = createFieldType(
1246           VName, Field->getType(), Loc, Field->getAccess(),
1247           layout.getFieldOffset(fieldno), Align, VUnit, RecordTy, CXXDecl);
1248       elements.push_back(FieldType);
1249     } else if (C.capturesThis()) {
1250       // TODO: Need to handle 'this' in some way by probably renaming the
1251       // this of the lambda class and having a field member of 'this' or
1252       // by using AT_object_pointer for the function and having that be
1253       // used as 'this' for semantic references.
1254       FieldDecl *f = *Field;
1255       llvm::DIFile *VUnit = getOrCreateFile(f->getLocation());
1256       QualType type = f->getType();
1257       llvm::DIType *fieldType = createFieldType(
1258           "this", type, f->getLocation(), f->getAccess(),
1259           layout.getFieldOffset(fieldno), VUnit, RecordTy, CXXDecl);
1260 
1261       elements.push_back(fieldType);
1262     }
1263   }
1264 }
1265 
1266 llvm::DIDerivedType *
1267 CGDebugInfo::CreateRecordStaticField(const VarDecl *Var, llvm::DIType *RecordTy,
1268                                      const RecordDecl *RD) {
1269   // Create the descriptor for the static variable, with or without
1270   // constant initializers.
1271   Var = Var->getCanonicalDecl();
1272   llvm::DIFile *VUnit = getOrCreateFile(Var->getLocation());
1273   llvm::DIType *VTy = getOrCreateType(Var->getType(), VUnit);
1274 
1275   unsigned LineNumber = getLineNumber(Var->getLocation());
1276   StringRef VName = Var->getName();
1277   llvm::Constant *C = nullptr;
1278   if (Var->getInit()) {
1279     const APValue *Value = Var->evaluateValue();
1280     if (Value) {
1281       if (Value->isInt())
1282         C = llvm::ConstantInt::get(CGM.getLLVMContext(), Value->getInt());
1283       if (Value->isFloat())
1284         C = llvm::ConstantFP::get(CGM.getLLVMContext(), Value->getFloat());
1285     }
1286   }
1287 
1288   llvm::DINode::DIFlags Flags = getAccessFlag(Var->getAccess(), RD);
1289   auto Align = getDeclAlignIfRequired(Var, CGM.getContext());
1290   llvm::DIDerivedType *GV = DBuilder.createStaticMemberType(
1291       RecordTy, VName, VUnit, LineNumber, VTy, Flags, C, Align);
1292   StaticDataMemberCache[Var->getCanonicalDecl()].reset(GV);
1293   return GV;
1294 }
1295 
1296 void CGDebugInfo::CollectRecordNormalField(
1297     const FieldDecl *field, uint64_t OffsetInBits, llvm::DIFile *tunit,
1298     SmallVectorImpl<llvm::Metadata *> &elements, llvm::DIType *RecordTy,
1299     const RecordDecl *RD) {
1300   StringRef name = field->getName();
1301   QualType type = field->getType();
1302 
1303   // Ignore unnamed fields unless they're anonymous structs/unions.
1304   if (name.empty() && !type->isRecordType())
1305     return;
1306 
1307   llvm::DIType *FieldType;
1308   if (field->isBitField()) {
1309     FieldType = createBitFieldType(field, RecordTy, RD);
1310   } else {
1311     auto Align = getDeclAlignIfRequired(field, CGM.getContext());
1312     FieldType =
1313         createFieldType(name, type, field->getLocation(), field->getAccess(),
1314                         OffsetInBits, Align, tunit, RecordTy, RD);
1315   }
1316 
1317   elements.push_back(FieldType);
1318 }
1319 
1320 void CGDebugInfo::CollectRecordNestedType(
1321     const TypeDecl *TD, SmallVectorImpl<llvm::Metadata *> &elements) {
1322   QualType Ty = CGM.getContext().getTypeDeclType(TD);
1323   // Injected class names are not considered nested records.
1324   if (isa<InjectedClassNameType>(Ty))
1325     return;
1326   SourceLocation Loc = TD->getLocation();
1327   llvm::DIType *nestedType = getOrCreateType(Ty, getOrCreateFile(Loc));
1328   elements.push_back(nestedType);
1329 }
1330 
1331 void CGDebugInfo::CollectRecordFields(
1332     const RecordDecl *record, llvm::DIFile *tunit,
1333     SmallVectorImpl<llvm::Metadata *> &elements,
1334     llvm::DICompositeType *RecordTy) {
1335   const auto *CXXDecl = dyn_cast<CXXRecordDecl>(record);
1336 
1337   if (CXXDecl && CXXDecl->isLambda())
1338     CollectRecordLambdaFields(CXXDecl, elements, RecordTy);
1339   else {
1340     const ASTRecordLayout &layout = CGM.getContext().getASTRecordLayout(record);
1341 
1342     // Field number for non-static fields.
1343     unsigned fieldNo = 0;
1344 
1345     // Static and non-static members should appear in the same order as
1346     // the corresponding declarations in the source program.
1347     for (const auto *I : record->decls())
1348       if (const auto *V = dyn_cast<VarDecl>(I)) {
1349         if (V->hasAttr<NoDebugAttr>())
1350           continue;
1351 
1352         // Skip variable template specializations when emitting CodeView. MSVC
1353         // doesn't emit them.
1354         if (CGM.getCodeGenOpts().EmitCodeView &&
1355             isa<VarTemplateSpecializationDecl>(V))
1356           continue;
1357 
1358         // Reuse the existing static member declaration if one exists
1359         auto MI = StaticDataMemberCache.find(V->getCanonicalDecl());
1360         if (MI != StaticDataMemberCache.end()) {
1361           assert(MI->second &&
1362                  "Static data member declaration should still exist");
1363           elements.push_back(MI->second);
1364         } else {
1365           auto Field = CreateRecordStaticField(V, RecordTy, record);
1366           elements.push_back(Field);
1367         }
1368       } else if (const auto *field = dyn_cast<FieldDecl>(I)) {
1369         CollectRecordNormalField(field, layout.getFieldOffset(fieldNo), tunit,
1370                                  elements, RecordTy, record);
1371 
1372         // Bump field number for next field.
1373         ++fieldNo;
1374       } else if (CGM.getCodeGenOpts().EmitCodeView) {
1375         // Debug info for nested types is included in the member list only for
1376         // CodeView.
1377         if (const auto *nestedType = dyn_cast<TypeDecl>(I))
1378           if (!nestedType->isImplicit() &&
1379               nestedType->getDeclContext() == record)
1380             CollectRecordNestedType(nestedType, elements);
1381       }
1382   }
1383 }
1384 
1385 llvm::DISubroutineType *
1386 CGDebugInfo::getOrCreateMethodType(const CXXMethodDecl *Method,
1387                                    llvm::DIFile *Unit) {
1388   const FunctionProtoType *Func = Method->getType()->getAs<FunctionProtoType>();
1389   if (Method->isStatic())
1390     return cast_or_null<llvm::DISubroutineType>(
1391         getOrCreateType(QualType(Func, 0), Unit));
1392   return getOrCreateInstanceMethodType(Method->getThisType(CGM.getContext()),
1393                                        Func, Unit);
1394 }
1395 
1396 llvm::DISubroutineType *CGDebugInfo::getOrCreateInstanceMethodType(
1397     QualType ThisPtr, const FunctionProtoType *Func, llvm::DIFile *Unit) {
1398   // Add "this" pointer.
1399   llvm::DITypeRefArray Args(
1400       cast<llvm::DISubroutineType>(getOrCreateType(QualType(Func, 0), Unit))
1401           ->getTypeArray());
1402   assert(Args.size() && "Invalid number of arguments!");
1403 
1404   SmallVector<llvm::Metadata *, 16> Elts;
1405 
1406   // First element is always return type. For 'void' functions it is NULL.
1407   Elts.push_back(Args[0]);
1408 
1409   // "this" pointer is always first argument.
1410   const CXXRecordDecl *RD = ThisPtr->getPointeeCXXRecordDecl();
1411   if (isa<ClassTemplateSpecializationDecl>(RD)) {
1412     // Create pointer type directly in this case.
1413     const PointerType *ThisPtrTy = cast<PointerType>(ThisPtr);
1414     QualType PointeeTy = ThisPtrTy->getPointeeType();
1415     unsigned AS = CGM.getContext().getTargetAddressSpace(PointeeTy);
1416     uint64_t Size = CGM.getTarget().getPointerWidth(AS);
1417     auto Align = getTypeAlignIfRequired(ThisPtrTy, CGM.getContext());
1418     llvm::DIType *PointeeType = getOrCreateType(PointeeTy, Unit);
1419     llvm::DIType *ThisPtrType =
1420         DBuilder.createPointerType(PointeeType, Size, Align);
1421     TypeCache[ThisPtr.getAsOpaquePtr()].reset(ThisPtrType);
1422     // TODO: This and the artificial type below are misleading, the
1423     // types aren't artificial the argument is, but the current
1424     // metadata doesn't represent that.
1425     ThisPtrType = DBuilder.createObjectPointerType(ThisPtrType);
1426     Elts.push_back(ThisPtrType);
1427   } else {
1428     llvm::DIType *ThisPtrType = getOrCreateType(ThisPtr, Unit);
1429     TypeCache[ThisPtr.getAsOpaquePtr()].reset(ThisPtrType);
1430     ThisPtrType = DBuilder.createObjectPointerType(ThisPtrType);
1431     Elts.push_back(ThisPtrType);
1432   }
1433 
1434   // Copy rest of the arguments.
1435   for (unsigned i = 1, e = Args.size(); i != e; ++i)
1436     Elts.push_back(Args[i]);
1437 
1438   llvm::DITypeRefArray EltTypeArray = DBuilder.getOrCreateTypeArray(Elts);
1439 
1440   llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
1441   if (Func->getExtProtoInfo().RefQualifier == RQ_LValue)
1442     Flags |= llvm::DINode::FlagLValueReference;
1443   if (Func->getExtProtoInfo().RefQualifier == RQ_RValue)
1444     Flags |= llvm::DINode::FlagRValueReference;
1445 
1446   return DBuilder.createSubroutineType(EltTypeArray, Flags,
1447                                        getDwarfCC(Func->getCallConv()));
1448 }
1449 
1450 /// isFunctionLocalClass - Return true if CXXRecordDecl is defined
1451 /// inside a function.
1452 static bool isFunctionLocalClass(const CXXRecordDecl *RD) {
1453   if (const auto *NRD = dyn_cast<CXXRecordDecl>(RD->getDeclContext()))
1454     return isFunctionLocalClass(NRD);
1455   if (isa<FunctionDecl>(RD->getDeclContext()))
1456     return true;
1457   return false;
1458 }
1459 
1460 llvm::DISubprogram *CGDebugInfo::CreateCXXMemberFunction(
1461     const CXXMethodDecl *Method, llvm::DIFile *Unit, llvm::DIType *RecordTy) {
1462   bool IsCtorOrDtor =
1463       isa<CXXConstructorDecl>(Method) || isa<CXXDestructorDecl>(Method);
1464 
1465   StringRef MethodName = getFunctionName(Method);
1466   llvm::DISubroutineType *MethodTy = getOrCreateMethodType(Method, Unit);
1467 
1468   // Since a single ctor/dtor corresponds to multiple functions, it doesn't
1469   // make sense to give a single ctor/dtor a linkage name.
1470   StringRef MethodLinkageName;
1471   // FIXME: 'isFunctionLocalClass' seems like an arbitrary/unintentional
1472   // property to use here. It may've been intended to model "is non-external
1473   // type" but misses cases of non-function-local but non-external classes such
1474   // as those in anonymous namespaces as well as the reverse - external types
1475   // that are function local, such as those in (non-local) inline functions.
1476   if (!IsCtorOrDtor && !isFunctionLocalClass(Method->getParent()))
1477     MethodLinkageName = CGM.getMangledName(Method);
1478 
1479   // Get the location for the method.
1480   llvm::DIFile *MethodDefUnit = nullptr;
1481   unsigned MethodLine = 0;
1482   if (!Method->isImplicit()) {
1483     MethodDefUnit = getOrCreateFile(Method->getLocation());
1484     MethodLine = getLineNumber(Method->getLocation());
1485   }
1486 
1487   // Collect virtual method info.
1488   llvm::DIType *ContainingType = nullptr;
1489   unsigned Virtuality = 0;
1490   unsigned VIndex = 0;
1491   llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
1492   int ThisAdjustment = 0;
1493 
1494   if (Method->isVirtual()) {
1495     if (Method->isPure())
1496       Virtuality = llvm::dwarf::DW_VIRTUALITY_pure_virtual;
1497     else
1498       Virtuality = llvm::dwarf::DW_VIRTUALITY_virtual;
1499 
1500     if (CGM.getTarget().getCXXABI().isItaniumFamily()) {
1501       // It doesn't make sense to give a virtual destructor a vtable index,
1502       // since a single destructor has two entries in the vtable.
1503       if (!isa<CXXDestructorDecl>(Method))
1504         VIndex = CGM.getItaniumVTableContext().getMethodVTableIndex(Method);
1505     } else {
1506       // Emit MS ABI vftable information.  There is only one entry for the
1507       // deleting dtor.
1508       const auto *DD = dyn_cast<CXXDestructorDecl>(Method);
1509       GlobalDecl GD = DD ? GlobalDecl(DD, Dtor_Deleting) : GlobalDecl(Method);
1510       MethodVFTableLocation ML =
1511           CGM.getMicrosoftVTableContext().getMethodVFTableLocation(GD);
1512       VIndex = ML.Index;
1513 
1514       // CodeView only records the vftable offset in the class that introduces
1515       // the virtual method. This is possible because, unlike Itanium, the MS
1516       // C++ ABI does not include all virtual methods from non-primary bases in
1517       // the vtable for the most derived class. For example, if C inherits from
1518       // A and B, C's primary vftable will not include B's virtual methods.
1519       if (Method->size_overridden_methods() == 0)
1520         Flags |= llvm::DINode::FlagIntroducedVirtual;
1521 
1522       // The 'this' adjustment accounts for both the virtual and non-virtual
1523       // portions of the adjustment. Presumably the debugger only uses it when
1524       // it knows the dynamic type of an object.
1525       ThisAdjustment = CGM.getCXXABI()
1526                            .getVirtualFunctionPrologueThisAdjustment(GD)
1527                            .getQuantity();
1528     }
1529     ContainingType = RecordTy;
1530   }
1531 
1532   if (Method->isStatic())
1533     Flags |= llvm::DINode::FlagStaticMember;
1534   if (Method->isImplicit())
1535     Flags |= llvm::DINode::FlagArtificial;
1536   Flags |= getAccessFlag(Method->getAccess(), Method->getParent());
1537   if (const auto *CXXC = dyn_cast<CXXConstructorDecl>(Method)) {
1538     if (CXXC->isExplicit())
1539       Flags |= llvm::DINode::FlagExplicit;
1540   } else if (const auto *CXXC = dyn_cast<CXXConversionDecl>(Method)) {
1541     if (CXXC->isExplicit())
1542       Flags |= llvm::DINode::FlagExplicit;
1543   }
1544   if (Method->hasPrototype())
1545     Flags |= llvm::DINode::FlagPrototyped;
1546   if (Method->getRefQualifier() == RQ_LValue)
1547     Flags |= llvm::DINode::FlagLValueReference;
1548   if (Method->getRefQualifier() == RQ_RValue)
1549     Flags |= llvm::DINode::FlagRValueReference;
1550 
1551   llvm::DINodeArray TParamsArray = CollectFunctionTemplateParams(Method, Unit);
1552   llvm::DISubprogram *SP = DBuilder.createMethod(
1553       RecordTy, MethodName, MethodLinkageName, MethodDefUnit, MethodLine,
1554       MethodTy, /*isLocalToUnit=*/false, /*isDefinition=*/false, Virtuality,
1555       VIndex, ThisAdjustment, ContainingType, Flags, CGM.getLangOpts().Optimize,
1556       TParamsArray.get());
1557 
1558   SPCache[Method->getCanonicalDecl()].reset(SP);
1559 
1560   return SP;
1561 }
1562 
1563 void CGDebugInfo::CollectCXXMemberFunctions(
1564     const CXXRecordDecl *RD, llvm::DIFile *Unit,
1565     SmallVectorImpl<llvm::Metadata *> &EltTys, llvm::DIType *RecordTy) {
1566 
1567   // Since we want more than just the individual member decls if we
1568   // have templated functions iterate over every declaration to gather
1569   // the functions.
1570   for (const auto *I : RD->decls()) {
1571     const auto *Method = dyn_cast<CXXMethodDecl>(I);
1572     // If the member is implicit, don't add it to the member list. This avoids
1573     // the member being added to type units by LLVM, while still allowing it
1574     // to be emitted into the type declaration/reference inside the compile
1575     // unit.
1576     // Ditto 'nodebug' methods, for consistency with CodeGenFunction.cpp.
1577     // FIXME: Handle Using(Shadow?)Decls here to create
1578     // DW_TAG_imported_declarations inside the class for base decls brought into
1579     // derived classes. GDB doesn't seem to notice/leverage these when I tried
1580     // it, so I'm not rushing to fix this. (GCC seems to produce them, if
1581     // referenced)
1582     if (!Method || Method->isImplicit() || Method->hasAttr<NoDebugAttr>())
1583       continue;
1584 
1585     if (Method->getType()->getAs<FunctionProtoType>()->getContainedAutoType())
1586       continue;
1587 
1588     // Reuse the existing member function declaration if it exists.
1589     // It may be associated with the declaration of the type & should be
1590     // reused as we're building the definition.
1591     //
1592     // This situation can arise in the vtable-based debug info reduction where
1593     // implicit members are emitted in a non-vtable TU.
1594     auto MI = SPCache.find(Method->getCanonicalDecl());
1595     EltTys.push_back(MI == SPCache.end()
1596                          ? CreateCXXMemberFunction(Method, Unit, RecordTy)
1597                          : static_cast<llvm::Metadata *>(MI->second));
1598   }
1599 }
1600 
1601 void CGDebugInfo::CollectCXXBases(const CXXRecordDecl *RD, llvm::DIFile *Unit,
1602                                   SmallVectorImpl<llvm::Metadata *> &EltTys,
1603                                   llvm::DIType *RecordTy) {
1604   llvm::DenseSet<CanonicalDeclPtr<const CXXRecordDecl>> SeenTypes;
1605   CollectCXXBasesAux(RD, Unit, EltTys, RecordTy, RD->bases(), SeenTypes,
1606                      llvm::DINode::FlagZero);
1607 
1608   // If we are generating CodeView debug info, we also need to emit records for
1609   // indirect virtual base classes.
1610   if (CGM.getCodeGenOpts().EmitCodeView) {
1611     CollectCXXBasesAux(RD, Unit, EltTys, RecordTy, RD->vbases(), SeenTypes,
1612                        llvm::DINode::FlagIndirectVirtualBase);
1613   }
1614 }
1615 
1616 void CGDebugInfo::CollectCXXBasesAux(
1617     const CXXRecordDecl *RD, llvm::DIFile *Unit,
1618     SmallVectorImpl<llvm::Metadata *> &EltTys, llvm::DIType *RecordTy,
1619     const CXXRecordDecl::base_class_const_range &Bases,
1620     llvm::DenseSet<CanonicalDeclPtr<const CXXRecordDecl>> &SeenTypes,
1621     llvm::DINode::DIFlags StartingFlags) {
1622   const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
1623   for (const auto &BI : Bases) {
1624     const auto *Base =
1625         cast<CXXRecordDecl>(BI.getType()->getAs<RecordType>()->getDecl());
1626     if (!SeenTypes.insert(Base).second)
1627       continue;
1628     auto *BaseTy = getOrCreateType(BI.getType(), Unit);
1629     llvm::DINode::DIFlags BFlags = StartingFlags;
1630     uint64_t BaseOffset;
1631     uint32_t VBPtrOffset = 0;
1632 
1633     if (BI.isVirtual()) {
1634       if (CGM.getTarget().getCXXABI().isItaniumFamily()) {
1635         // virtual base offset offset is -ve. The code generator emits dwarf
1636         // expression where it expects +ve number.
1637         BaseOffset = 0 - CGM.getItaniumVTableContext()
1638                              .getVirtualBaseOffsetOffset(RD, Base)
1639                              .getQuantity();
1640       } else {
1641         // In the MS ABI, store the vbtable offset, which is analogous to the
1642         // vbase offset offset in Itanium.
1643         BaseOffset =
1644             4 * CGM.getMicrosoftVTableContext().getVBTableIndex(RD, Base);
1645         VBPtrOffset = CGM.getContext()
1646                           .getASTRecordLayout(RD)
1647                           .getVBPtrOffset()
1648                           .getQuantity();
1649       }
1650       BFlags |= llvm::DINode::FlagVirtual;
1651     } else
1652       BaseOffset = CGM.getContext().toBits(RL.getBaseClassOffset(Base));
1653     // FIXME: Inconsistent units for BaseOffset. It is in bytes when
1654     // BI->isVirtual() and bits when not.
1655 
1656     BFlags |= getAccessFlag(BI.getAccessSpecifier(), RD);
1657     llvm::DIType *DTy = DBuilder.createInheritance(RecordTy, BaseTy, BaseOffset,
1658                                                    VBPtrOffset, BFlags);
1659     EltTys.push_back(DTy);
1660   }
1661 }
1662 
1663 llvm::DINodeArray
1664 CGDebugInfo::CollectTemplateParams(const TemplateParameterList *TPList,
1665                                    ArrayRef<TemplateArgument> TAList,
1666                                    llvm::DIFile *Unit) {
1667   SmallVector<llvm::Metadata *, 16> TemplateParams;
1668   for (unsigned i = 0, e = TAList.size(); i != e; ++i) {
1669     const TemplateArgument &TA = TAList[i];
1670     StringRef Name;
1671     if (TPList)
1672       Name = TPList->getParam(i)->getName();
1673     switch (TA.getKind()) {
1674     case TemplateArgument::Type: {
1675       llvm::DIType *TTy = getOrCreateType(TA.getAsType(), Unit);
1676       TemplateParams.push_back(
1677           DBuilder.createTemplateTypeParameter(TheCU, Name, TTy));
1678     } break;
1679     case TemplateArgument::Integral: {
1680       llvm::DIType *TTy = getOrCreateType(TA.getIntegralType(), Unit);
1681       TemplateParams.push_back(DBuilder.createTemplateValueParameter(
1682           TheCU, Name, TTy,
1683           llvm::ConstantInt::get(CGM.getLLVMContext(), TA.getAsIntegral())));
1684     } break;
1685     case TemplateArgument::Declaration: {
1686       const ValueDecl *D = TA.getAsDecl();
1687       QualType T = TA.getParamTypeForDecl().getDesugaredType(CGM.getContext());
1688       llvm::DIType *TTy = getOrCreateType(T, Unit);
1689       llvm::Constant *V = nullptr;
1690       const CXXMethodDecl *MD;
1691       // Variable pointer template parameters have a value that is the address
1692       // of the variable.
1693       if (const auto *VD = dyn_cast<VarDecl>(D))
1694         V = CGM.GetAddrOfGlobalVar(VD);
1695       // Member function pointers have special support for building them, though
1696       // this is currently unsupported in LLVM CodeGen.
1697       else if ((MD = dyn_cast<CXXMethodDecl>(D)) && MD->isInstance())
1698         V = CGM.getCXXABI().EmitMemberFunctionPointer(MD);
1699       else if (const auto *FD = dyn_cast<FunctionDecl>(D))
1700         V = CGM.GetAddrOfFunction(FD);
1701       // Member data pointers have special handling too to compute the fixed
1702       // offset within the object.
1703       else if (const auto *MPT = dyn_cast<MemberPointerType>(T.getTypePtr())) {
1704         // These five lines (& possibly the above member function pointer
1705         // handling) might be able to be refactored to use similar code in
1706         // CodeGenModule::getMemberPointerConstant
1707         uint64_t fieldOffset = CGM.getContext().getFieldOffset(D);
1708         CharUnits chars =
1709             CGM.getContext().toCharUnitsFromBits((int64_t)fieldOffset);
1710         V = CGM.getCXXABI().EmitMemberDataPointer(MPT, chars);
1711       }
1712       TemplateParams.push_back(DBuilder.createTemplateValueParameter(
1713           TheCU, Name, TTy,
1714           cast_or_null<llvm::Constant>(V->stripPointerCasts())));
1715     } break;
1716     case TemplateArgument::NullPtr: {
1717       QualType T = TA.getNullPtrType();
1718       llvm::DIType *TTy = getOrCreateType(T, Unit);
1719       llvm::Constant *V = nullptr;
1720       // Special case member data pointer null values since they're actually -1
1721       // instead of zero.
1722       if (const auto *MPT = dyn_cast<MemberPointerType>(T.getTypePtr()))
1723         // But treat member function pointers as simple zero integers because
1724         // it's easier than having a special case in LLVM's CodeGen. If LLVM
1725         // CodeGen grows handling for values of non-null member function
1726         // pointers then perhaps we could remove this special case and rely on
1727         // EmitNullMemberPointer for member function pointers.
1728         if (MPT->isMemberDataPointer())
1729           V = CGM.getCXXABI().EmitNullMemberPointer(MPT);
1730       if (!V)
1731         V = llvm::ConstantInt::get(CGM.Int8Ty, 0);
1732       TemplateParams.push_back(
1733           DBuilder.createTemplateValueParameter(TheCU, Name, TTy, V));
1734     } break;
1735     case TemplateArgument::Template:
1736       TemplateParams.push_back(DBuilder.createTemplateTemplateParameter(
1737           TheCU, Name, nullptr,
1738           TA.getAsTemplate().getAsTemplateDecl()->getQualifiedNameAsString()));
1739       break;
1740     case TemplateArgument::Pack:
1741       TemplateParams.push_back(DBuilder.createTemplateParameterPack(
1742           TheCU, Name, nullptr,
1743           CollectTemplateParams(nullptr, TA.getPackAsArray(), Unit)));
1744       break;
1745     case TemplateArgument::Expression: {
1746       const Expr *E = TA.getAsExpr();
1747       QualType T = E->getType();
1748       if (E->isGLValue())
1749         T = CGM.getContext().getLValueReferenceType(T);
1750       llvm::Constant *V = ConstantEmitter(CGM).emitAbstract(E, T);
1751       assert(V && "Expression in template argument isn't constant");
1752       llvm::DIType *TTy = getOrCreateType(T, Unit);
1753       TemplateParams.push_back(DBuilder.createTemplateValueParameter(
1754           TheCU, Name, TTy, V->stripPointerCasts()));
1755     } break;
1756     // And the following should never occur:
1757     case TemplateArgument::TemplateExpansion:
1758     case TemplateArgument::Null:
1759       llvm_unreachable(
1760           "These argument types shouldn't exist in concrete types");
1761     }
1762   }
1763   return DBuilder.getOrCreateArray(TemplateParams);
1764 }
1765 
1766 llvm::DINodeArray
1767 CGDebugInfo::CollectFunctionTemplateParams(const FunctionDecl *FD,
1768                                            llvm::DIFile *Unit) {
1769   if (FD->getTemplatedKind() ==
1770       FunctionDecl::TK_FunctionTemplateSpecialization) {
1771     const TemplateParameterList *TList = FD->getTemplateSpecializationInfo()
1772                                              ->getTemplate()
1773                                              ->getTemplateParameters();
1774     return CollectTemplateParams(
1775         TList, FD->getTemplateSpecializationArgs()->asArray(), Unit);
1776   }
1777   return llvm::DINodeArray();
1778 }
1779 
1780 llvm::DINodeArray CGDebugInfo::CollectVarTemplateParams(const VarDecl *VL,
1781     llvm::DIFile *Unit) {
1782   if (auto *TS = dyn_cast<VarTemplateSpecializationDecl>(VL)) {
1783     auto T = TS->getSpecializedTemplateOrPartial();
1784     auto TA = TS->getTemplateArgs().asArray();
1785     // Collect parameters for a partial specialization
1786     if (T.is<VarTemplatePartialSpecializationDecl *>()) {
1787       const TemplateParameterList *TList =
1788         T.get<VarTemplatePartialSpecializationDecl *>()
1789         ->getTemplateParameters();
1790       return CollectTemplateParams(TList, TA, Unit);
1791     }
1792 
1793     // Collect parameters for an explicit specialization
1794     if (T.is<VarTemplateDecl *>()) {
1795       const TemplateParameterList *TList = T.get<VarTemplateDecl *>()
1796         ->getTemplateParameters();
1797       return CollectTemplateParams(TList, TA, Unit);
1798     }
1799   }
1800   return llvm::DINodeArray();
1801 }
1802 
1803 llvm::DINodeArray CGDebugInfo::CollectCXXTemplateParams(
1804     const ClassTemplateSpecializationDecl *TSpecial, llvm::DIFile *Unit) {
1805   // Always get the full list of parameters, not just the ones from
1806   // the specialization.
1807   TemplateParameterList *TPList =
1808       TSpecial->getSpecializedTemplate()->getTemplateParameters();
1809   const TemplateArgumentList &TAList = TSpecial->getTemplateArgs();
1810   return CollectTemplateParams(TPList, TAList.asArray(), Unit);
1811 }
1812 
1813 llvm::DIType *CGDebugInfo::getOrCreateVTablePtrType(llvm::DIFile *Unit) {
1814   if (VTablePtrType)
1815     return VTablePtrType;
1816 
1817   ASTContext &Context = CGM.getContext();
1818 
1819   /* Function type */
1820   llvm::Metadata *STy = getOrCreateType(Context.IntTy, Unit);
1821   llvm::DITypeRefArray SElements = DBuilder.getOrCreateTypeArray(STy);
1822   llvm::DIType *SubTy = DBuilder.createSubroutineType(SElements);
1823   unsigned Size = Context.getTypeSize(Context.VoidPtrTy);
1824   unsigned VtblPtrAddressSpace = CGM.getTarget().getVtblPtrAddressSpace();
1825   Optional<unsigned> DWARFAddressSpace =
1826       CGM.getTarget().getDWARFAddressSpace(VtblPtrAddressSpace);
1827 
1828   llvm::DIType *vtbl_ptr_type = DBuilder.createPointerType(
1829       SubTy, Size, 0, DWARFAddressSpace, "__vtbl_ptr_type");
1830   VTablePtrType = DBuilder.createPointerType(vtbl_ptr_type, Size);
1831   return VTablePtrType;
1832 }
1833 
1834 StringRef CGDebugInfo::getVTableName(const CXXRecordDecl *RD) {
1835   // Copy the gdb compatible name on the side and use its reference.
1836   return internString("_vptr$", RD->getNameAsString());
1837 }
1838 
1839 void CGDebugInfo::CollectVTableInfo(const CXXRecordDecl *RD, llvm::DIFile *Unit,
1840                                     SmallVectorImpl<llvm::Metadata *> &EltTys,
1841                                     llvm::DICompositeType *RecordTy) {
1842   // If this class is not dynamic then there is not any vtable info to collect.
1843   if (!RD->isDynamicClass())
1844     return;
1845 
1846   // Don't emit any vtable shape or vptr info if this class doesn't have an
1847   // extendable vfptr. This can happen if the class doesn't have virtual
1848   // methods, or in the MS ABI if those virtual methods only come from virtually
1849   // inherited bases.
1850   const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
1851   if (!RL.hasExtendableVFPtr())
1852     return;
1853 
1854   // CodeView needs to know how large the vtable of every dynamic class is, so
1855   // emit a special named pointer type into the element list. The vptr type
1856   // points to this type as well.
1857   llvm::DIType *VPtrTy = nullptr;
1858   bool NeedVTableShape = CGM.getCodeGenOpts().EmitCodeView &&
1859                          CGM.getTarget().getCXXABI().isMicrosoft();
1860   if (NeedVTableShape) {
1861     uint64_t PtrWidth =
1862         CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
1863     const VTableLayout &VFTLayout =
1864         CGM.getMicrosoftVTableContext().getVFTableLayout(RD, CharUnits::Zero());
1865     unsigned VSlotCount =
1866         VFTLayout.vtable_components().size() - CGM.getLangOpts().RTTIData;
1867     unsigned VTableWidth = PtrWidth * VSlotCount;
1868     unsigned VtblPtrAddressSpace = CGM.getTarget().getVtblPtrAddressSpace();
1869     Optional<unsigned> DWARFAddressSpace =
1870         CGM.getTarget().getDWARFAddressSpace(VtblPtrAddressSpace);
1871 
1872     // Create a very wide void* type and insert it directly in the element list.
1873     llvm::DIType *VTableType = DBuilder.createPointerType(
1874         nullptr, VTableWidth, 0, DWARFAddressSpace, "__vtbl_ptr_type");
1875     EltTys.push_back(VTableType);
1876 
1877     // The vptr is a pointer to this special vtable type.
1878     VPtrTy = DBuilder.createPointerType(VTableType, PtrWidth);
1879   }
1880 
1881   // If there is a primary base then the artificial vptr member lives there.
1882   if (RL.getPrimaryBase())
1883     return;
1884 
1885   if (!VPtrTy)
1886     VPtrTy = getOrCreateVTablePtrType(Unit);
1887 
1888   unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
1889   llvm::DIType *VPtrMember =
1890       DBuilder.createMemberType(Unit, getVTableName(RD), Unit, 0, Size, 0, 0,
1891                                 llvm::DINode::FlagArtificial, VPtrTy);
1892   EltTys.push_back(VPtrMember);
1893 }
1894 
1895 llvm::DIType *CGDebugInfo::getOrCreateRecordType(QualType RTy,
1896                                                  SourceLocation Loc) {
1897   assert(DebugKind >= codegenoptions::LimitedDebugInfo);
1898   llvm::DIType *T = getOrCreateType(RTy, getOrCreateFile(Loc));
1899   return T;
1900 }
1901 
1902 llvm::DIType *CGDebugInfo::getOrCreateInterfaceType(QualType D,
1903                                                     SourceLocation Loc) {
1904   return getOrCreateStandaloneType(D, Loc);
1905 }
1906 
1907 llvm::DIType *CGDebugInfo::getOrCreateStandaloneType(QualType D,
1908                                                      SourceLocation Loc) {
1909   assert(DebugKind >= codegenoptions::LimitedDebugInfo);
1910   assert(!D.isNull() && "null type");
1911   llvm::DIType *T = getOrCreateType(D, getOrCreateFile(Loc));
1912   assert(T && "could not create debug info for type");
1913 
1914   RetainedTypes.push_back(D.getAsOpaquePtr());
1915   return T;
1916 }
1917 
1918 void CGDebugInfo::completeType(const EnumDecl *ED) {
1919   if (DebugKind <= codegenoptions::DebugLineTablesOnly)
1920     return;
1921   QualType Ty = CGM.getContext().getEnumType(ED);
1922   void *TyPtr = Ty.getAsOpaquePtr();
1923   auto I = TypeCache.find(TyPtr);
1924   if (I == TypeCache.end() || !cast<llvm::DIType>(I->second)->isForwardDecl())
1925     return;
1926   llvm::DIType *Res = CreateTypeDefinition(Ty->castAs<EnumType>());
1927   assert(!Res->isForwardDecl());
1928   TypeCache[TyPtr].reset(Res);
1929 }
1930 
1931 void CGDebugInfo::completeType(const RecordDecl *RD) {
1932   if (DebugKind > codegenoptions::LimitedDebugInfo ||
1933       !CGM.getLangOpts().CPlusPlus)
1934     completeRequiredType(RD);
1935 }
1936 
1937 /// Return true if the class or any of its methods are marked dllimport.
1938 static bool isClassOrMethodDLLImport(const CXXRecordDecl *RD) {
1939   if (RD->hasAttr<DLLImportAttr>())
1940     return true;
1941   for (const CXXMethodDecl *MD : RD->methods())
1942     if (MD->hasAttr<DLLImportAttr>())
1943       return true;
1944   return false;
1945 }
1946 
1947 /// Does a type definition exist in an imported clang module?
1948 static bool isDefinedInClangModule(const RecordDecl *RD) {
1949   // Only definitions that where imported from an AST file come from a module.
1950   if (!RD || !RD->isFromASTFile())
1951     return false;
1952   // Anonymous entities cannot be addressed. Treat them as not from module.
1953   if (!RD->isExternallyVisible() && RD->getName().empty())
1954     return false;
1955   if (auto *CXXDecl = dyn_cast<CXXRecordDecl>(RD)) {
1956     if (!CXXDecl->isCompleteDefinition())
1957       return false;
1958     auto TemplateKind = CXXDecl->getTemplateSpecializationKind();
1959     if (TemplateKind != TSK_Undeclared) {
1960       // This is a template, check the origin of the first member.
1961       if (CXXDecl->field_begin() == CXXDecl->field_end())
1962         return TemplateKind == TSK_ExplicitInstantiationDeclaration;
1963       if (!CXXDecl->field_begin()->isFromASTFile())
1964         return false;
1965     }
1966   }
1967   return true;
1968 }
1969 
1970 void CGDebugInfo::completeClassData(const RecordDecl *RD) {
1971   if (auto *CXXRD = dyn_cast<CXXRecordDecl>(RD))
1972     if (CXXRD->isDynamicClass() &&
1973         CGM.getVTableLinkage(CXXRD) ==
1974             llvm::GlobalValue::AvailableExternallyLinkage &&
1975         !isClassOrMethodDLLImport(CXXRD))
1976       return;
1977 
1978   if (DebugTypeExtRefs && isDefinedInClangModule(RD->getDefinition()))
1979     return;
1980 
1981   completeClass(RD);
1982 }
1983 
1984 void CGDebugInfo::completeClass(const RecordDecl *RD) {
1985   if (DebugKind <= codegenoptions::DebugLineTablesOnly)
1986     return;
1987   QualType Ty = CGM.getContext().getRecordType(RD);
1988   void *TyPtr = Ty.getAsOpaquePtr();
1989   auto I = TypeCache.find(TyPtr);
1990   if (I != TypeCache.end() && !cast<llvm::DIType>(I->second)->isForwardDecl())
1991     return;
1992   llvm::DIType *Res = CreateTypeDefinition(Ty->castAs<RecordType>());
1993   assert(!Res->isForwardDecl());
1994   TypeCache[TyPtr].reset(Res);
1995 }
1996 
1997 static bool hasExplicitMemberDefinition(CXXRecordDecl::method_iterator I,
1998                                         CXXRecordDecl::method_iterator End) {
1999   for (CXXMethodDecl *MD : llvm::make_range(I, End))
2000     if (FunctionDecl *Tmpl = MD->getInstantiatedFromMemberFunction())
2001       if (!Tmpl->isImplicit() && Tmpl->isThisDeclarationADefinition() &&
2002           !MD->getMemberSpecializationInfo()->isExplicitSpecialization())
2003         return true;
2004   return false;
2005 }
2006 
2007 static bool shouldOmitDefinition(codegenoptions::DebugInfoKind DebugKind,
2008                                  bool DebugTypeExtRefs, const RecordDecl *RD,
2009                                  const LangOptions &LangOpts) {
2010   if (DebugTypeExtRefs && isDefinedInClangModule(RD->getDefinition()))
2011     return true;
2012 
2013   if (auto *ES = RD->getASTContext().getExternalSource())
2014     if (ES->hasExternalDefinitions(RD) == ExternalASTSource::EK_Always)
2015       return true;
2016 
2017   if (DebugKind > codegenoptions::LimitedDebugInfo)
2018     return false;
2019 
2020   if (!LangOpts.CPlusPlus)
2021     return false;
2022 
2023   if (!RD->isCompleteDefinitionRequired())
2024     return true;
2025 
2026   const auto *CXXDecl = dyn_cast<CXXRecordDecl>(RD);
2027 
2028   if (!CXXDecl)
2029     return false;
2030 
2031   // Only emit complete debug info for a dynamic class when its vtable is
2032   // emitted.  However, Microsoft debuggers don't resolve type information
2033   // across DLL boundaries, so skip this optimization if the class or any of its
2034   // methods are marked dllimport. This isn't a complete solution, since objects
2035   // without any dllimport methods can be used in one DLL and constructed in
2036   // another, but it is the current behavior of LimitedDebugInfo.
2037   if (CXXDecl->hasDefinition() && CXXDecl->isDynamicClass() &&
2038       !isClassOrMethodDLLImport(CXXDecl))
2039     return true;
2040 
2041   TemplateSpecializationKind Spec = TSK_Undeclared;
2042   if (const auto *SD = dyn_cast<ClassTemplateSpecializationDecl>(RD))
2043     Spec = SD->getSpecializationKind();
2044 
2045   if (Spec == TSK_ExplicitInstantiationDeclaration &&
2046       hasExplicitMemberDefinition(CXXDecl->method_begin(),
2047                                   CXXDecl->method_end()))
2048     return true;
2049 
2050   return false;
2051 }
2052 
2053 void CGDebugInfo::completeRequiredType(const RecordDecl *RD) {
2054   if (shouldOmitDefinition(DebugKind, DebugTypeExtRefs, RD, CGM.getLangOpts()))
2055     return;
2056 
2057   QualType Ty = CGM.getContext().getRecordType(RD);
2058   llvm::DIType *T = getTypeOrNull(Ty);
2059   if (T && T->isForwardDecl())
2060     completeClassData(RD);
2061 }
2062 
2063 llvm::DIType *CGDebugInfo::CreateType(const RecordType *Ty) {
2064   RecordDecl *RD = Ty->getDecl();
2065   llvm::DIType *T = cast_or_null<llvm::DIType>(getTypeOrNull(QualType(Ty, 0)));
2066   if (T || shouldOmitDefinition(DebugKind, DebugTypeExtRefs, RD,
2067                                 CGM.getLangOpts())) {
2068     if (!T)
2069       T = getOrCreateRecordFwdDecl(Ty, getDeclContextDescriptor(RD));
2070     return T;
2071   }
2072 
2073   return CreateTypeDefinition(Ty);
2074 }
2075 
2076 llvm::DIType *CGDebugInfo::CreateTypeDefinition(const RecordType *Ty) {
2077   RecordDecl *RD = Ty->getDecl();
2078 
2079   // Get overall information about the record type for the debug info.
2080   llvm::DIFile *DefUnit = getOrCreateFile(RD->getLocation());
2081 
2082   // Records and classes and unions can all be recursive.  To handle them, we
2083   // first generate a debug descriptor for the struct as a forward declaration.
2084   // Then (if it is a definition) we go through and get debug info for all of
2085   // its members.  Finally, we create a descriptor for the complete type (which
2086   // may refer to the forward decl if the struct is recursive) and replace all
2087   // uses of the forward declaration with the final definition.
2088   llvm::DICompositeType *FwdDecl = getOrCreateLimitedType(Ty, DefUnit);
2089 
2090   const RecordDecl *D = RD->getDefinition();
2091   if (!D || !D->isCompleteDefinition())
2092     return FwdDecl;
2093 
2094   if (const auto *CXXDecl = dyn_cast<CXXRecordDecl>(RD))
2095     CollectContainingType(CXXDecl, FwdDecl);
2096 
2097   // Push the struct on region stack.
2098   LexicalBlockStack.emplace_back(&*FwdDecl);
2099   RegionMap[Ty->getDecl()].reset(FwdDecl);
2100 
2101   // Convert all the elements.
2102   SmallVector<llvm::Metadata *, 16> EltTys;
2103   // what about nested types?
2104 
2105   // Note: The split of CXXDecl information here is intentional, the
2106   // gdb tests will depend on a certain ordering at printout. The debug
2107   // information offsets are still correct if we merge them all together
2108   // though.
2109   const auto *CXXDecl = dyn_cast<CXXRecordDecl>(RD);
2110   if (CXXDecl) {
2111     CollectCXXBases(CXXDecl, DefUnit, EltTys, FwdDecl);
2112     CollectVTableInfo(CXXDecl, DefUnit, EltTys, FwdDecl);
2113   }
2114 
2115   // Collect data fields (including static variables and any initializers).
2116   CollectRecordFields(RD, DefUnit, EltTys, FwdDecl);
2117   if (CXXDecl)
2118     CollectCXXMemberFunctions(CXXDecl, DefUnit, EltTys, FwdDecl);
2119 
2120   LexicalBlockStack.pop_back();
2121   RegionMap.erase(Ty->getDecl());
2122 
2123   llvm::DINodeArray Elements = DBuilder.getOrCreateArray(EltTys);
2124   DBuilder.replaceArrays(FwdDecl, Elements);
2125 
2126   if (FwdDecl->isTemporary())
2127     FwdDecl =
2128         llvm::MDNode::replaceWithPermanent(llvm::TempDICompositeType(FwdDecl));
2129 
2130   RegionMap[Ty->getDecl()].reset(FwdDecl);
2131   return FwdDecl;
2132 }
2133 
2134 llvm::DIType *CGDebugInfo::CreateType(const ObjCObjectType *Ty,
2135                                       llvm::DIFile *Unit) {
2136   // Ignore protocols.
2137   return getOrCreateType(Ty->getBaseType(), Unit);
2138 }
2139 
2140 llvm::DIType *CGDebugInfo::CreateType(const ObjCTypeParamType *Ty,
2141                                       llvm::DIFile *Unit) {
2142   // Ignore protocols.
2143   SourceLocation Loc = Ty->getDecl()->getLocation();
2144 
2145   // Use Typedefs to represent ObjCTypeParamType.
2146   return DBuilder.createTypedef(
2147       getOrCreateType(Ty->getDecl()->getUnderlyingType(), Unit),
2148       Ty->getDecl()->getName(), getOrCreateFile(Loc), getLineNumber(Loc),
2149       getDeclContextDescriptor(Ty->getDecl()));
2150 }
2151 
2152 /// \return true if Getter has the default name for the property PD.
2153 static bool hasDefaultGetterName(const ObjCPropertyDecl *PD,
2154                                  const ObjCMethodDecl *Getter) {
2155   assert(PD);
2156   if (!Getter)
2157     return true;
2158 
2159   assert(Getter->getDeclName().isObjCZeroArgSelector());
2160   return PD->getName() ==
2161          Getter->getDeclName().getObjCSelector().getNameForSlot(0);
2162 }
2163 
2164 /// \return true if Setter has the default name for the property PD.
2165 static bool hasDefaultSetterName(const ObjCPropertyDecl *PD,
2166                                  const ObjCMethodDecl *Setter) {
2167   assert(PD);
2168   if (!Setter)
2169     return true;
2170 
2171   assert(Setter->getDeclName().isObjCOneArgSelector());
2172   return SelectorTable::constructSetterName(PD->getName()) ==
2173          Setter->getDeclName().getObjCSelector().getNameForSlot(0);
2174 }
2175 
2176 llvm::DIType *CGDebugInfo::CreateType(const ObjCInterfaceType *Ty,
2177                                       llvm::DIFile *Unit) {
2178   ObjCInterfaceDecl *ID = Ty->getDecl();
2179   if (!ID)
2180     return nullptr;
2181 
2182   // Return a forward declaration if this type was imported from a clang module,
2183   // and this is not the compile unit with the implementation of the type (which
2184   // may contain hidden ivars).
2185   if (DebugTypeExtRefs && ID->isFromASTFile() && ID->getDefinition() &&
2186       !ID->getImplementation())
2187     return DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
2188                                       ID->getName(),
2189                                       getDeclContextDescriptor(ID), Unit, 0);
2190 
2191   // Get overall information about the record type for the debug info.
2192   llvm::DIFile *DefUnit = getOrCreateFile(ID->getLocation());
2193   unsigned Line = getLineNumber(ID->getLocation());
2194   auto RuntimeLang =
2195       static_cast<llvm::dwarf::SourceLanguage>(TheCU->getSourceLanguage());
2196 
2197   // If this is just a forward declaration return a special forward-declaration
2198   // debug type since we won't be able to lay out the entire type.
2199   ObjCInterfaceDecl *Def = ID->getDefinition();
2200   if (!Def || !Def->getImplementation()) {
2201     llvm::DIScope *Mod = getParentModuleOrNull(ID);
2202     llvm::DIType *FwdDecl = DBuilder.createReplaceableCompositeType(
2203         llvm::dwarf::DW_TAG_structure_type, ID->getName(), Mod ? Mod : TheCU,
2204         DefUnit, Line, RuntimeLang);
2205     ObjCInterfaceCache.push_back(ObjCInterfaceCacheEntry(Ty, FwdDecl, Unit));
2206     return FwdDecl;
2207   }
2208 
2209   return CreateTypeDefinition(Ty, Unit);
2210 }
2211 
2212 llvm::DIModule *
2213 CGDebugInfo::getOrCreateModuleRef(ExternalASTSource::ASTSourceDescriptor Mod,
2214                                   bool CreateSkeletonCU) {
2215   // Use the Module pointer as the key into the cache. This is a
2216   // nullptr if the "Module" is a PCH, which is safe because we don't
2217   // support chained PCH debug info, so there can only be a single PCH.
2218   const Module *M = Mod.getModuleOrNull();
2219   auto ModRef = ModuleCache.find(M);
2220   if (ModRef != ModuleCache.end())
2221     return cast<llvm::DIModule>(ModRef->second);
2222 
2223   // Macro definitions that were defined with "-D" on the command line.
2224   SmallString<128> ConfigMacros;
2225   {
2226     llvm::raw_svector_ostream OS(ConfigMacros);
2227     const auto &PPOpts = CGM.getPreprocessorOpts();
2228     unsigned I = 0;
2229     // Translate the macro definitions back into a command line.
2230     for (auto &M : PPOpts.Macros) {
2231       if (++I > 1)
2232         OS << " ";
2233       const std::string &Macro = M.first;
2234       bool Undef = M.second;
2235       OS << "\"-" << (Undef ? 'U' : 'D');
2236       for (char c : Macro)
2237         switch (c) {
2238         case '\\':
2239           OS << "\\\\";
2240           break;
2241         case '"':
2242           OS << "\\\"";
2243           break;
2244         default:
2245           OS << c;
2246         }
2247       OS << '\"';
2248     }
2249   }
2250 
2251   bool IsRootModule = M ? !M->Parent : true;
2252   if (CreateSkeletonCU && IsRootModule) {
2253     // PCH files don't have a signature field in the control block,
2254     // but LLVM detects skeleton CUs by looking for a non-zero DWO id.
2255     // We use the lower 64 bits for debug info.
2256     uint64_t Signature =
2257         Mod.getSignature()
2258             ? (uint64_t)Mod.getSignature()[1] << 32 | Mod.getSignature()[0]
2259             : ~1ULL;
2260     llvm::DIBuilder DIB(CGM.getModule());
2261     DIB.createCompileUnit(TheCU->getSourceLanguage(),
2262                           // TODO: Support "Source" from external AST providers?
2263                           DIB.createFile(Mod.getModuleName(), Mod.getPath()),
2264                           TheCU->getProducer(), true, StringRef(), 0,
2265                           Mod.getASTFile(), llvm::DICompileUnit::FullDebug,
2266                           Signature);
2267     DIB.finalize();
2268   }
2269   llvm::DIModule *Parent =
2270       IsRootModule ? nullptr
2271                    : getOrCreateModuleRef(
2272                          ExternalASTSource::ASTSourceDescriptor(*M->Parent),
2273                          CreateSkeletonCU);
2274   llvm::DIModule *DIMod =
2275       DBuilder.createModule(Parent, Mod.getModuleName(), ConfigMacros,
2276                             Mod.getPath(), CGM.getHeaderSearchOpts().Sysroot);
2277   ModuleCache[M].reset(DIMod);
2278   return DIMod;
2279 }
2280 
2281 llvm::DIType *CGDebugInfo::CreateTypeDefinition(const ObjCInterfaceType *Ty,
2282                                                 llvm::DIFile *Unit) {
2283   ObjCInterfaceDecl *ID = Ty->getDecl();
2284   llvm::DIFile *DefUnit = getOrCreateFile(ID->getLocation());
2285   unsigned Line = getLineNumber(ID->getLocation());
2286   unsigned RuntimeLang = TheCU->getSourceLanguage();
2287 
2288   // Bit size, align and offset of the type.
2289   uint64_t Size = CGM.getContext().getTypeSize(Ty);
2290   auto Align = getTypeAlignIfRequired(Ty, CGM.getContext());
2291 
2292   llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
2293   if (ID->getImplementation())
2294     Flags |= llvm::DINode::FlagObjcClassComplete;
2295 
2296   llvm::DIScope *Mod = getParentModuleOrNull(ID);
2297   llvm::DICompositeType *RealDecl = DBuilder.createStructType(
2298       Mod ? Mod : Unit, ID->getName(), DefUnit, Line, Size, Align, Flags,
2299       nullptr, llvm::DINodeArray(), RuntimeLang);
2300 
2301   QualType QTy(Ty, 0);
2302   TypeCache[QTy.getAsOpaquePtr()].reset(RealDecl);
2303 
2304   // Push the struct on region stack.
2305   LexicalBlockStack.emplace_back(RealDecl);
2306   RegionMap[Ty->getDecl()].reset(RealDecl);
2307 
2308   // Convert all the elements.
2309   SmallVector<llvm::Metadata *, 16> EltTys;
2310 
2311   ObjCInterfaceDecl *SClass = ID->getSuperClass();
2312   if (SClass) {
2313     llvm::DIType *SClassTy =
2314         getOrCreateType(CGM.getContext().getObjCInterfaceType(SClass), Unit);
2315     if (!SClassTy)
2316       return nullptr;
2317 
2318     llvm::DIType *InhTag = DBuilder.createInheritance(RealDecl, SClassTy, 0, 0,
2319                                                       llvm::DINode::FlagZero);
2320     EltTys.push_back(InhTag);
2321   }
2322 
2323   // Create entries for all of the properties.
2324   auto AddProperty = [&](const ObjCPropertyDecl *PD) {
2325     SourceLocation Loc = PD->getLocation();
2326     llvm::DIFile *PUnit = getOrCreateFile(Loc);
2327     unsigned PLine = getLineNumber(Loc);
2328     ObjCMethodDecl *Getter = PD->getGetterMethodDecl();
2329     ObjCMethodDecl *Setter = PD->getSetterMethodDecl();
2330     llvm::MDNode *PropertyNode = DBuilder.createObjCProperty(
2331         PD->getName(), PUnit, PLine,
2332         hasDefaultGetterName(PD, Getter) ? ""
2333                                          : getSelectorName(PD->getGetterName()),
2334         hasDefaultSetterName(PD, Setter) ? ""
2335                                          : getSelectorName(PD->getSetterName()),
2336         PD->getPropertyAttributes(), getOrCreateType(PD->getType(), PUnit));
2337     EltTys.push_back(PropertyNode);
2338   };
2339   {
2340     llvm::SmallPtrSet<const IdentifierInfo *, 16> PropertySet;
2341     for (const ObjCCategoryDecl *ClassExt : ID->known_extensions())
2342       for (auto *PD : ClassExt->properties()) {
2343         PropertySet.insert(PD->getIdentifier());
2344         AddProperty(PD);
2345       }
2346     for (const auto *PD : ID->properties()) {
2347       // Don't emit duplicate metadata for properties that were already in a
2348       // class extension.
2349       if (!PropertySet.insert(PD->getIdentifier()).second)
2350         continue;
2351       AddProperty(PD);
2352     }
2353   }
2354 
2355   const ASTRecordLayout &RL = CGM.getContext().getASTObjCInterfaceLayout(ID);
2356   unsigned FieldNo = 0;
2357   for (ObjCIvarDecl *Field = ID->all_declared_ivar_begin(); Field;
2358        Field = Field->getNextIvar(), ++FieldNo) {
2359     llvm::DIType *FieldTy = getOrCreateType(Field->getType(), Unit);
2360     if (!FieldTy)
2361       return nullptr;
2362 
2363     StringRef FieldName = Field->getName();
2364 
2365     // Ignore unnamed fields.
2366     if (FieldName.empty())
2367       continue;
2368 
2369     // Get the location for the field.
2370     llvm::DIFile *FieldDefUnit = getOrCreateFile(Field->getLocation());
2371     unsigned FieldLine = getLineNumber(Field->getLocation());
2372     QualType FType = Field->getType();
2373     uint64_t FieldSize = 0;
2374     uint32_t FieldAlign = 0;
2375 
2376     if (!FType->isIncompleteArrayType()) {
2377 
2378       // Bit size, align and offset of the type.
2379       FieldSize = Field->isBitField()
2380                       ? Field->getBitWidthValue(CGM.getContext())
2381                       : CGM.getContext().getTypeSize(FType);
2382       FieldAlign = getTypeAlignIfRequired(FType, CGM.getContext());
2383     }
2384 
2385     uint64_t FieldOffset;
2386     if (CGM.getLangOpts().ObjCRuntime.isNonFragile()) {
2387       // We don't know the runtime offset of an ivar if we're using the
2388       // non-fragile ABI.  For bitfields, use the bit offset into the first
2389       // byte of storage of the bitfield.  For other fields, use zero.
2390       if (Field->isBitField()) {
2391         FieldOffset =
2392             CGM.getObjCRuntime().ComputeBitfieldBitOffset(CGM, ID, Field);
2393         FieldOffset %= CGM.getContext().getCharWidth();
2394       } else {
2395         FieldOffset = 0;
2396       }
2397     } else {
2398       FieldOffset = RL.getFieldOffset(FieldNo);
2399     }
2400 
2401     llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
2402     if (Field->getAccessControl() == ObjCIvarDecl::Protected)
2403       Flags = llvm::DINode::FlagProtected;
2404     else if (Field->getAccessControl() == ObjCIvarDecl::Private)
2405       Flags = llvm::DINode::FlagPrivate;
2406     else if (Field->getAccessControl() == ObjCIvarDecl::Public)
2407       Flags = llvm::DINode::FlagPublic;
2408 
2409     llvm::MDNode *PropertyNode = nullptr;
2410     if (ObjCImplementationDecl *ImpD = ID->getImplementation()) {
2411       if (ObjCPropertyImplDecl *PImpD =
2412               ImpD->FindPropertyImplIvarDecl(Field->getIdentifier())) {
2413         if (ObjCPropertyDecl *PD = PImpD->getPropertyDecl()) {
2414           SourceLocation Loc = PD->getLocation();
2415           llvm::DIFile *PUnit = getOrCreateFile(Loc);
2416           unsigned PLine = getLineNumber(Loc);
2417           ObjCMethodDecl *Getter = PD->getGetterMethodDecl();
2418           ObjCMethodDecl *Setter = PD->getSetterMethodDecl();
2419           PropertyNode = DBuilder.createObjCProperty(
2420               PD->getName(), PUnit, PLine,
2421               hasDefaultGetterName(PD, Getter)
2422                   ? ""
2423                   : getSelectorName(PD->getGetterName()),
2424               hasDefaultSetterName(PD, Setter)
2425                   ? ""
2426                   : getSelectorName(PD->getSetterName()),
2427               PD->getPropertyAttributes(),
2428               getOrCreateType(PD->getType(), PUnit));
2429         }
2430       }
2431     }
2432     FieldTy = DBuilder.createObjCIVar(FieldName, FieldDefUnit, FieldLine,
2433                                       FieldSize, FieldAlign, FieldOffset, Flags,
2434                                       FieldTy, PropertyNode);
2435     EltTys.push_back(FieldTy);
2436   }
2437 
2438   llvm::DINodeArray Elements = DBuilder.getOrCreateArray(EltTys);
2439   DBuilder.replaceArrays(RealDecl, Elements);
2440 
2441   LexicalBlockStack.pop_back();
2442   return RealDecl;
2443 }
2444 
2445 llvm::DIType *CGDebugInfo::CreateType(const VectorType *Ty,
2446                                       llvm::DIFile *Unit) {
2447   llvm::DIType *ElementTy = getOrCreateType(Ty->getElementType(), Unit);
2448   int64_t Count = Ty->getNumElements();
2449 
2450   llvm::Metadata *Subscript;
2451   QualType QTy(Ty, 0);
2452   auto SizeExpr = SizeExprCache.find(QTy);
2453   if (SizeExpr != SizeExprCache.end())
2454     Subscript = DBuilder.getOrCreateSubrange(0, SizeExpr->getSecond());
2455   else
2456     Subscript = DBuilder.getOrCreateSubrange(0, Count ? Count : -1);
2457   llvm::DINodeArray SubscriptArray = DBuilder.getOrCreateArray(Subscript);
2458 
2459   uint64_t Size = CGM.getContext().getTypeSize(Ty);
2460   auto Align = getTypeAlignIfRequired(Ty, CGM.getContext());
2461 
2462   return DBuilder.createVectorType(Size, Align, ElementTy, SubscriptArray);
2463 }
2464 
2465 llvm::DIType *CGDebugInfo::CreateType(const ArrayType *Ty, llvm::DIFile *Unit) {
2466   uint64_t Size;
2467   uint32_t Align;
2468 
2469   // FIXME: make getTypeAlign() aware of VLAs and incomplete array types
2470   if (const auto *VAT = dyn_cast<VariableArrayType>(Ty)) {
2471     Size = 0;
2472     Align = getTypeAlignIfRequired(CGM.getContext().getBaseElementType(VAT),
2473                                    CGM.getContext());
2474   } else if (Ty->isIncompleteArrayType()) {
2475     Size = 0;
2476     if (Ty->getElementType()->isIncompleteType())
2477       Align = 0;
2478     else
2479       Align = getTypeAlignIfRequired(Ty->getElementType(), CGM.getContext());
2480   } else if (Ty->isIncompleteType()) {
2481     Size = 0;
2482     Align = 0;
2483   } else {
2484     // Size and align of the whole array, not the element type.
2485     Size = CGM.getContext().getTypeSize(Ty);
2486     Align = getTypeAlignIfRequired(Ty, CGM.getContext());
2487   }
2488 
2489   // Add the dimensions of the array.  FIXME: This loses CV qualifiers from
2490   // interior arrays, do we care?  Why aren't nested arrays represented the
2491   // obvious/recursive way?
2492   SmallVector<llvm::Metadata *, 8> Subscripts;
2493   QualType EltTy(Ty, 0);
2494   while ((Ty = dyn_cast<ArrayType>(EltTy))) {
2495     // If the number of elements is known, then count is that number. Otherwise,
2496     // it's -1. This allows us to represent a subrange with an array of 0
2497     // elements, like this:
2498     //
2499     //   struct foo {
2500     //     int x[0];
2501     //   };
2502     int64_t Count = -1; // Count == -1 is an unbounded array.
2503     if (const auto *CAT = dyn_cast<ConstantArrayType>(Ty))
2504       Count = CAT->getSize().getZExtValue();
2505     else if (const auto *VAT = dyn_cast<VariableArrayType>(Ty)) {
2506       if (Expr *Size = VAT->getSizeExpr()) {
2507         llvm::APSInt V;
2508         if (Size->EvaluateAsInt(V, CGM.getContext()))
2509           Count = V.getExtValue();
2510       }
2511     }
2512 
2513     auto SizeNode = SizeExprCache.find(EltTy);
2514     if (SizeNode != SizeExprCache.end())
2515       Subscripts.push_back(
2516           DBuilder.getOrCreateSubrange(0, SizeNode->getSecond()));
2517     else
2518       Subscripts.push_back(DBuilder.getOrCreateSubrange(0, Count));
2519     EltTy = Ty->getElementType();
2520   }
2521 
2522   llvm::DINodeArray SubscriptArray = DBuilder.getOrCreateArray(Subscripts);
2523 
2524   return DBuilder.createArrayType(Size, Align, getOrCreateType(EltTy, Unit),
2525                                   SubscriptArray);
2526 }
2527 
2528 llvm::DIType *CGDebugInfo::CreateType(const LValueReferenceType *Ty,
2529                                       llvm::DIFile *Unit) {
2530   return CreatePointerLikeType(llvm::dwarf::DW_TAG_reference_type, Ty,
2531                                Ty->getPointeeType(), Unit);
2532 }
2533 
2534 llvm::DIType *CGDebugInfo::CreateType(const RValueReferenceType *Ty,
2535                                       llvm::DIFile *Unit) {
2536   return CreatePointerLikeType(llvm::dwarf::DW_TAG_rvalue_reference_type, Ty,
2537                                Ty->getPointeeType(), Unit);
2538 }
2539 
2540 llvm::DIType *CGDebugInfo::CreateType(const MemberPointerType *Ty,
2541                                       llvm::DIFile *U) {
2542   llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
2543   uint64_t Size = 0;
2544 
2545   if (!Ty->isIncompleteType()) {
2546     Size = CGM.getContext().getTypeSize(Ty);
2547 
2548     // Set the MS inheritance model. There is no flag for the unspecified model.
2549     if (CGM.getTarget().getCXXABI().isMicrosoft()) {
2550       switch (Ty->getMostRecentCXXRecordDecl()->getMSInheritanceModel()) {
2551       case MSInheritanceAttr::Keyword_single_inheritance:
2552         Flags |= llvm::DINode::FlagSingleInheritance;
2553         break;
2554       case MSInheritanceAttr::Keyword_multiple_inheritance:
2555         Flags |= llvm::DINode::FlagMultipleInheritance;
2556         break;
2557       case MSInheritanceAttr::Keyword_virtual_inheritance:
2558         Flags |= llvm::DINode::FlagVirtualInheritance;
2559         break;
2560       case MSInheritanceAttr::Keyword_unspecified_inheritance:
2561         break;
2562       }
2563     }
2564   }
2565 
2566   llvm::DIType *ClassType = getOrCreateType(QualType(Ty->getClass(), 0), U);
2567   if (Ty->isMemberDataPointerType())
2568     return DBuilder.createMemberPointerType(
2569         getOrCreateType(Ty->getPointeeType(), U), ClassType, Size, /*Align=*/0,
2570         Flags);
2571 
2572   const FunctionProtoType *FPT =
2573       Ty->getPointeeType()->getAs<FunctionProtoType>();
2574   return DBuilder.createMemberPointerType(
2575       getOrCreateInstanceMethodType(CGM.getContext().getPointerType(QualType(
2576                                         Ty->getClass(), FPT->getTypeQuals())),
2577                                     FPT, U),
2578       ClassType, Size, /*Align=*/0, Flags);
2579 }
2580 
2581 llvm::DIType *CGDebugInfo::CreateType(const AtomicType *Ty, llvm::DIFile *U) {
2582   auto *FromTy = getOrCreateType(Ty->getValueType(), U);
2583   return DBuilder.createQualifiedType(llvm::dwarf::DW_TAG_atomic_type, FromTy);
2584 }
2585 
2586 llvm::DIType *CGDebugInfo::CreateType(const PipeType *Ty, llvm::DIFile *U) {
2587   return getOrCreateType(Ty->getElementType(), U);
2588 }
2589 
2590 llvm::DIType *CGDebugInfo::CreateEnumType(const EnumType *Ty) {
2591   const EnumDecl *ED = Ty->getDecl();
2592 
2593   uint64_t Size = 0;
2594   uint32_t Align = 0;
2595   if (!ED->getTypeForDecl()->isIncompleteType()) {
2596     Size = CGM.getContext().getTypeSize(ED->getTypeForDecl());
2597     Align = getDeclAlignIfRequired(ED, CGM.getContext());
2598   }
2599 
2600   SmallString<256> Identifier = getTypeIdentifier(Ty, CGM, TheCU);
2601 
2602   bool isImportedFromModule =
2603       DebugTypeExtRefs && ED->isFromASTFile() && ED->getDefinition();
2604 
2605   // If this is just a forward declaration, construct an appropriately
2606   // marked node and just return it.
2607   if (isImportedFromModule || !ED->getDefinition()) {
2608     // Note that it is possible for enums to be created as part of
2609     // their own declcontext. In this case a FwdDecl will be created
2610     // twice. This doesn't cause a problem because both FwdDecls are
2611     // entered into the ReplaceMap: finalize() will replace the first
2612     // FwdDecl with the second and then replace the second with
2613     // complete type.
2614     llvm::DIScope *EDContext = getDeclContextDescriptor(ED);
2615     llvm::DIFile *DefUnit = getOrCreateFile(ED->getLocation());
2616     llvm::TempDIScope TmpContext(DBuilder.createReplaceableCompositeType(
2617         llvm::dwarf::DW_TAG_enumeration_type, "", TheCU, DefUnit, 0));
2618 
2619     unsigned Line = getLineNumber(ED->getLocation());
2620     StringRef EDName = ED->getName();
2621     llvm::DIType *RetTy = DBuilder.createReplaceableCompositeType(
2622         llvm::dwarf::DW_TAG_enumeration_type, EDName, EDContext, DefUnit, Line,
2623         0, Size, Align, llvm::DINode::FlagFwdDecl, Identifier);
2624 
2625     ReplaceMap.emplace_back(
2626         std::piecewise_construct, std::make_tuple(Ty),
2627         std::make_tuple(static_cast<llvm::Metadata *>(RetTy)));
2628     return RetTy;
2629   }
2630 
2631   return CreateTypeDefinition(Ty);
2632 }
2633 
2634 llvm::DIType *CGDebugInfo::CreateTypeDefinition(const EnumType *Ty) {
2635   const EnumDecl *ED = Ty->getDecl();
2636   uint64_t Size = 0;
2637   uint32_t Align = 0;
2638   if (!ED->getTypeForDecl()->isIncompleteType()) {
2639     Size = CGM.getContext().getTypeSize(ED->getTypeForDecl());
2640     Align = getDeclAlignIfRequired(ED, CGM.getContext());
2641   }
2642 
2643   SmallString<256> Identifier = getTypeIdentifier(Ty, CGM, TheCU);
2644 
2645   // Create elements for each enumerator.
2646   SmallVector<llvm::Metadata *, 16> Enumerators;
2647   ED = ED->getDefinition();
2648   bool IsSigned = ED->getIntegerType()->isSignedIntegerType();
2649   for (const auto *Enum : ED->enumerators()) {
2650     const auto &InitVal = Enum->getInitVal();
2651     auto Value = IsSigned ? InitVal.getSExtValue() : InitVal.getZExtValue();
2652     Enumerators.push_back(
2653         DBuilder.createEnumerator(Enum->getName(), Value, !IsSigned));
2654   }
2655 
2656   // Return a CompositeType for the enum itself.
2657   llvm::DINodeArray EltArray = DBuilder.getOrCreateArray(Enumerators);
2658 
2659   llvm::DIFile *DefUnit = getOrCreateFile(ED->getLocation());
2660   unsigned Line = getLineNumber(ED->getLocation());
2661   llvm::DIScope *EnumContext = getDeclContextDescriptor(ED);
2662   llvm::DIType *ClassTy = getOrCreateType(ED->getIntegerType(), DefUnit);
2663   return DBuilder.createEnumerationType(EnumContext, ED->getName(), DefUnit,
2664                                         Line, Size, Align, EltArray, ClassTy,
2665                                         Identifier, ED->isFixed());
2666 }
2667 
2668 llvm::DIMacro *CGDebugInfo::CreateMacro(llvm::DIMacroFile *Parent,
2669                                         unsigned MType, SourceLocation LineLoc,
2670                                         StringRef Name, StringRef Value) {
2671   unsigned Line = LineLoc.isInvalid() ? 0 : getLineNumber(LineLoc);
2672   return DBuilder.createMacro(Parent, Line, MType, Name, Value);
2673 }
2674 
2675 llvm::DIMacroFile *CGDebugInfo::CreateTempMacroFile(llvm::DIMacroFile *Parent,
2676                                                     SourceLocation LineLoc,
2677                                                     SourceLocation FileLoc) {
2678   llvm::DIFile *FName = getOrCreateFile(FileLoc);
2679   unsigned Line = LineLoc.isInvalid() ? 0 : getLineNumber(LineLoc);
2680   return DBuilder.createTempMacroFile(Parent, Line, FName);
2681 }
2682 
2683 static QualType UnwrapTypeForDebugInfo(QualType T, const ASTContext &C) {
2684   Qualifiers Quals;
2685   do {
2686     Qualifiers InnerQuals = T.getLocalQualifiers();
2687     // Qualifiers::operator+() doesn't like it if you add a Qualifier
2688     // that is already there.
2689     Quals += Qualifiers::removeCommonQualifiers(Quals, InnerQuals);
2690     Quals += InnerQuals;
2691     QualType LastT = T;
2692     switch (T->getTypeClass()) {
2693     default:
2694       return C.getQualifiedType(T.getTypePtr(), Quals);
2695     case Type::TemplateSpecialization: {
2696       const auto *Spec = cast<TemplateSpecializationType>(T);
2697       if (Spec->isTypeAlias())
2698         return C.getQualifiedType(T.getTypePtr(), Quals);
2699       T = Spec->desugar();
2700       break;
2701     }
2702     case Type::TypeOfExpr:
2703       T = cast<TypeOfExprType>(T)->getUnderlyingExpr()->getType();
2704       break;
2705     case Type::TypeOf:
2706       T = cast<TypeOfType>(T)->getUnderlyingType();
2707       break;
2708     case Type::Decltype:
2709       T = cast<DecltypeType>(T)->getUnderlyingType();
2710       break;
2711     case Type::UnaryTransform:
2712       T = cast<UnaryTransformType>(T)->getUnderlyingType();
2713       break;
2714     case Type::Attributed:
2715       T = cast<AttributedType>(T)->getEquivalentType();
2716       break;
2717     case Type::Elaborated:
2718       T = cast<ElaboratedType>(T)->getNamedType();
2719       break;
2720     case Type::Paren:
2721       T = cast<ParenType>(T)->getInnerType();
2722       break;
2723     case Type::SubstTemplateTypeParm:
2724       T = cast<SubstTemplateTypeParmType>(T)->getReplacementType();
2725       break;
2726     case Type::Auto:
2727     case Type::DeducedTemplateSpecialization: {
2728       QualType DT = cast<DeducedType>(T)->getDeducedType();
2729       assert(!DT.isNull() && "Undeduced types shouldn't reach here.");
2730       T = DT;
2731       break;
2732     }
2733     case Type::Adjusted:
2734     case Type::Decayed:
2735       // Decayed and adjusted types use the adjusted type in LLVM and DWARF.
2736       T = cast<AdjustedType>(T)->getAdjustedType();
2737       break;
2738     }
2739 
2740     assert(T != LastT && "Type unwrapping failed to unwrap!");
2741     (void)LastT;
2742   } while (true);
2743 }
2744 
2745 llvm::DIType *CGDebugInfo::getTypeOrNull(QualType Ty) {
2746 
2747   // Unwrap the type as needed for debug information.
2748   Ty = UnwrapTypeForDebugInfo(Ty, CGM.getContext());
2749 
2750   auto It = TypeCache.find(Ty.getAsOpaquePtr());
2751   if (It != TypeCache.end()) {
2752     // Verify that the debug info still exists.
2753     if (llvm::Metadata *V = It->second)
2754       return cast<llvm::DIType>(V);
2755   }
2756 
2757   return nullptr;
2758 }
2759 
2760 void CGDebugInfo::completeTemplateDefinition(
2761     const ClassTemplateSpecializationDecl &SD) {
2762   if (DebugKind <= codegenoptions::DebugLineTablesOnly)
2763     return;
2764   completeUnusedClass(SD);
2765 }
2766 
2767 void CGDebugInfo::completeUnusedClass(const CXXRecordDecl &D) {
2768   if (DebugKind <= codegenoptions::DebugLineTablesOnly)
2769     return;
2770 
2771   completeClassData(&D);
2772   // In case this type has no member function definitions being emitted, ensure
2773   // it is retained
2774   RetainedTypes.push_back(CGM.getContext().getRecordType(&D).getAsOpaquePtr());
2775 }
2776 
2777 llvm::DIType *CGDebugInfo::getOrCreateType(QualType Ty, llvm::DIFile *Unit) {
2778   if (Ty.isNull())
2779     return nullptr;
2780 
2781   // Unwrap the type as needed for debug information.
2782   Ty = UnwrapTypeForDebugInfo(Ty, CGM.getContext());
2783 
2784   if (auto *T = getTypeOrNull(Ty))
2785     return T;
2786 
2787   llvm::DIType *Res = CreateTypeNode(Ty, Unit);
2788   void *TyPtr = Ty.getAsOpaquePtr();
2789 
2790   // And update the type cache.
2791   TypeCache[TyPtr].reset(Res);
2792 
2793   return Res;
2794 }
2795 
2796 llvm::DIModule *CGDebugInfo::getParentModuleOrNull(const Decl *D) {
2797   // A forward declaration inside a module header does not belong to the module.
2798   if (isa<RecordDecl>(D) && !cast<RecordDecl>(D)->getDefinition())
2799     return nullptr;
2800   if (DebugTypeExtRefs && D->isFromASTFile()) {
2801     // Record a reference to an imported clang module or precompiled header.
2802     auto *Reader = CGM.getContext().getExternalSource();
2803     auto Idx = D->getOwningModuleID();
2804     auto Info = Reader->getSourceDescriptor(Idx);
2805     if (Info)
2806       return getOrCreateModuleRef(*Info, /*SkeletonCU=*/true);
2807   } else if (ClangModuleMap) {
2808     // We are building a clang module or a precompiled header.
2809     //
2810     // TODO: When D is a CXXRecordDecl or a C++ Enum, the ODR applies
2811     // and it wouldn't be necessary to specify the parent scope
2812     // because the type is already unique by definition (it would look
2813     // like the output of -fno-standalone-debug). On the other hand,
2814     // the parent scope helps a consumer to quickly locate the object
2815     // file where the type's definition is located, so it might be
2816     // best to make this behavior a command line or debugger tuning
2817     // option.
2818     if (Module *M = D->getOwningModule()) {
2819       // This is a (sub-)module.
2820       auto Info = ExternalASTSource::ASTSourceDescriptor(*M);
2821       return getOrCreateModuleRef(Info, /*SkeletonCU=*/false);
2822     } else {
2823       // This the precompiled header being built.
2824       return getOrCreateModuleRef(PCHDescriptor, /*SkeletonCU=*/false);
2825     }
2826   }
2827 
2828   return nullptr;
2829 }
2830 
2831 llvm::DIType *CGDebugInfo::CreateTypeNode(QualType Ty, llvm::DIFile *Unit) {
2832   // Handle qualifiers, which recursively handles what they refer to.
2833   if (Ty.hasLocalQualifiers())
2834     return CreateQualifiedType(Ty, Unit);
2835 
2836   // Work out details of type.
2837   switch (Ty->getTypeClass()) {
2838 #define TYPE(Class, Base)
2839 #define ABSTRACT_TYPE(Class, Base)
2840 #define NON_CANONICAL_TYPE(Class, Base)
2841 #define DEPENDENT_TYPE(Class, Base) case Type::Class:
2842 #include "clang/AST/TypeNodes.def"
2843     llvm_unreachable("Dependent types cannot show up in debug information");
2844 
2845   case Type::ExtVector:
2846   case Type::Vector:
2847     return CreateType(cast<VectorType>(Ty), Unit);
2848   case Type::ObjCObjectPointer:
2849     return CreateType(cast<ObjCObjectPointerType>(Ty), Unit);
2850   case Type::ObjCObject:
2851     return CreateType(cast<ObjCObjectType>(Ty), Unit);
2852   case Type::ObjCTypeParam:
2853     return CreateType(cast<ObjCTypeParamType>(Ty), Unit);
2854   case Type::ObjCInterface:
2855     return CreateType(cast<ObjCInterfaceType>(Ty), Unit);
2856   case Type::Builtin:
2857     return CreateType(cast<BuiltinType>(Ty));
2858   case Type::Complex:
2859     return CreateType(cast<ComplexType>(Ty));
2860   case Type::Pointer:
2861     return CreateType(cast<PointerType>(Ty), Unit);
2862   case Type::BlockPointer:
2863     return CreateType(cast<BlockPointerType>(Ty), Unit);
2864   case Type::Typedef:
2865     return CreateType(cast<TypedefType>(Ty), Unit);
2866   case Type::Record:
2867     return CreateType(cast<RecordType>(Ty));
2868   case Type::Enum:
2869     return CreateEnumType(cast<EnumType>(Ty));
2870   case Type::FunctionProto:
2871   case Type::FunctionNoProto:
2872     return CreateType(cast<FunctionType>(Ty), Unit);
2873   case Type::ConstantArray:
2874   case Type::VariableArray:
2875   case Type::IncompleteArray:
2876     return CreateType(cast<ArrayType>(Ty), Unit);
2877 
2878   case Type::LValueReference:
2879     return CreateType(cast<LValueReferenceType>(Ty), Unit);
2880   case Type::RValueReference:
2881     return CreateType(cast<RValueReferenceType>(Ty), Unit);
2882 
2883   case Type::MemberPointer:
2884     return CreateType(cast<MemberPointerType>(Ty), Unit);
2885 
2886   case Type::Atomic:
2887     return CreateType(cast<AtomicType>(Ty), Unit);
2888 
2889   case Type::Pipe:
2890     return CreateType(cast<PipeType>(Ty), Unit);
2891 
2892   case Type::TemplateSpecialization:
2893     return CreateType(cast<TemplateSpecializationType>(Ty), Unit);
2894 
2895   case Type::Auto:
2896   case Type::Attributed:
2897   case Type::Adjusted:
2898   case Type::Decayed:
2899   case Type::DeducedTemplateSpecialization:
2900   case Type::Elaborated:
2901   case Type::Paren:
2902   case Type::SubstTemplateTypeParm:
2903   case Type::TypeOfExpr:
2904   case Type::TypeOf:
2905   case Type::Decltype:
2906   case Type::UnaryTransform:
2907   case Type::PackExpansion:
2908     break;
2909   }
2910 
2911   llvm_unreachable("type should have been unwrapped!");
2912 }
2913 
2914 llvm::DICompositeType *CGDebugInfo::getOrCreateLimitedType(const RecordType *Ty,
2915                                                            llvm::DIFile *Unit) {
2916   QualType QTy(Ty, 0);
2917 
2918   auto *T = cast_or_null<llvm::DICompositeType>(getTypeOrNull(QTy));
2919 
2920   // We may have cached a forward decl when we could have created
2921   // a non-forward decl. Go ahead and create a non-forward decl
2922   // now.
2923   if (T && !T->isForwardDecl())
2924     return T;
2925 
2926   // Otherwise create the type.
2927   llvm::DICompositeType *Res = CreateLimitedType(Ty);
2928 
2929   // Propagate members from the declaration to the definition
2930   // CreateType(const RecordType*) will overwrite this with the members in the
2931   // correct order if the full type is needed.
2932   DBuilder.replaceArrays(Res, T ? T->getElements() : llvm::DINodeArray());
2933 
2934   // And update the type cache.
2935   TypeCache[QTy.getAsOpaquePtr()].reset(Res);
2936   return Res;
2937 }
2938 
2939 // TODO: Currently used for context chains when limiting debug info.
2940 llvm::DICompositeType *CGDebugInfo::CreateLimitedType(const RecordType *Ty) {
2941   RecordDecl *RD = Ty->getDecl();
2942 
2943   // Get overall information about the record type for the debug info.
2944   llvm::DIFile *DefUnit = getOrCreateFile(RD->getLocation());
2945   unsigned Line = getLineNumber(RD->getLocation());
2946   StringRef RDName = getClassName(RD);
2947 
2948   llvm::DIScope *RDContext = getDeclContextDescriptor(RD);
2949 
2950   // If we ended up creating the type during the context chain construction,
2951   // just return that.
2952   auto *T = cast_or_null<llvm::DICompositeType>(
2953       getTypeOrNull(CGM.getContext().getRecordType(RD)));
2954   if (T && (!T->isForwardDecl() || !RD->getDefinition()))
2955     return T;
2956 
2957   // If this is just a forward or incomplete declaration, construct an
2958   // appropriately marked node and just return it.
2959   const RecordDecl *D = RD->getDefinition();
2960   if (!D || !D->isCompleteDefinition())
2961     return getOrCreateRecordFwdDecl(Ty, RDContext);
2962 
2963   uint64_t Size = CGM.getContext().getTypeSize(Ty);
2964   auto Align = getDeclAlignIfRequired(D, CGM.getContext());
2965 
2966   SmallString<256> Identifier = getTypeIdentifier(Ty, CGM, TheCU);
2967 
2968   // Explicitly record the calling convention for C++ records.
2969   auto Flags = llvm::DINode::FlagZero;
2970   if (auto CXXRD = dyn_cast<CXXRecordDecl>(RD)) {
2971     if (CGM.getCXXABI().getRecordArgABI(CXXRD) == CGCXXABI::RAA_Indirect)
2972       Flags |= llvm::DINode::FlagTypePassByReference;
2973     else
2974       Flags |= llvm::DINode::FlagTypePassByValue;
2975 
2976     // Record if a C++ record is trivial type.
2977     if (CXXRD->isTrivial())
2978       Flags |= llvm::DINode::FlagTrivial;
2979   }
2980 
2981   llvm::DICompositeType *RealDecl = DBuilder.createReplaceableCompositeType(
2982       getTagForRecord(RD), RDName, RDContext, DefUnit, Line, 0, Size, Align,
2983       Flags, Identifier);
2984 
2985   // Elements of composite types usually have back to the type, creating
2986   // uniquing cycles.  Distinct nodes are more efficient.
2987   switch (RealDecl->getTag()) {
2988   default:
2989     llvm_unreachable("invalid composite type tag");
2990 
2991   case llvm::dwarf::DW_TAG_array_type:
2992   case llvm::dwarf::DW_TAG_enumeration_type:
2993     // Array elements and most enumeration elements don't have back references,
2994     // so they don't tend to be involved in uniquing cycles and there is some
2995     // chance of merging them when linking together two modules.  Only make
2996     // them distinct if they are ODR-uniqued.
2997     if (Identifier.empty())
2998       break;
2999     LLVM_FALLTHROUGH;
3000 
3001   case llvm::dwarf::DW_TAG_structure_type:
3002   case llvm::dwarf::DW_TAG_union_type:
3003   case llvm::dwarf::DW_TAG_class_type:
3004     // Immediately resolve to a distinct node.
3005     RealDecl =
3006         llvm::MDNode::replaceWithDistinct(llvm::TempDICompositeType(RealDecl));
3007     break;
3008   }
3009 
3010   RegionMap[Ty->getDecl()].reset(RealDecl);
3011   TypeCache[QualType(Ty, 0).getAsOpaquePtr()].reset(RealDecl);
3012 
3013   if (const auto *TSpecial = dyn_cast<ClassTemplateSpecializationDecl>(RD))
3014     DBuilder.replaceArrays(RealDecl, llvm::DINodeArray(),
3015                            CollectCXXTemplateParams(TSpecial, DefUnit));
3016   return RealDecl;
3017 }
3018 
3019 void CGDebugInfo::CollectContainingType(const CXXRecordDecl *RD,
3020                                         llvm::DICompositeType *RealDecl) {
3021   // A class's primary base or the class itself contains the vtable.
3022   llvm::DICompositeType *ContainingType = nullptr;
3023   const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
3024   if (const CXXRecordDecl *PBase = RL.getPrimaryBase()) {
3025     // Seek non-virtual primary base root.
3026     while (1) {
3027       const ASTRecordLayout &BRL = CGM.getContext().getASTRecordLayout(PBase);
3028       const CXXRecordDecl *PBT = BRL.getPrimaryBase();
3029       if (PBT && !BRL.isPrimaryBaseVirtual())
3030         PBase = PBT;
3031       else
3032         break;
3033     }
3034     ContainingType = cast<llvm::DICompositeType>(
3035         getOrCreateType(QualType(PBase->getTypeForDecl(), 0),
3036                         getOrCreateFile(RD->getLocation())));
3037   } else if (RD->isDynamicClass())
3038     ContainingType = RealDecl;
3039 
3040   DBuilder.replaceVTableHolder(RealDecl, ContainingType);
3041 }
3042 
3043 llvm::DIType *CGDebugInfo::CreateMemberType(llvm::DIFile *Unit, QualType FType,
3044                                             StringRef Name, uint64_t *Offset) {
3045   llvm::DIType *FieldTy = CGDebugInfo::getOrCreateType(FType, Unit);
3046   uint64_t FieldSize = CGM.getContext().getTypeSize(FType);
3047   auto FieldAlign = getTypeAlignIfRequired(FType, CGM.getContext());
3048   llvm::DIType *Ty =
3049       DBuilder.createMemberType(Unit, Name, Unit, 0, FieldSize, FieldAlign,
3050                                 *Offset, llvm::DINode::FlagZero, FieldTy);
3051   *Offset += FieldSize;
3052   return Ty;
3053 }
3054 
3055 void CGDebugInfo::collectFunctionDeclProps(GlobalDecl GD, llvm::DIFile *Unit,
3056                                            StringRef &Name,
3057                                            StringRef &LinkageName,
3058                                            llvm::DIScope *&FDContext,
3059                                            llvm::DINodeArray &TParamsArray,
3060                                            llvm::DINode::DIFlags &Flags) {
3061   const auto *FD = cast<FunctionDecl>(GD.getDecl());
3062   Name = getFunctionName(FD);
3063   // Use mangled name as linkage name for C/C++ functions.
3064   if (FD->hasPrototype()) {
3065     LinkageName = CGM.getMangledName(GD);
3066     Flags |= llvm::DINode::FlagPrototyped;
3067   }
3068   // No need to replicate the linkage name if it isn't different from the
3069   // subprogram name, no need to have it at all unless coverage is enabled or
3070   // debug is set to more than just line tables or extra debug info is needed.
3071   if (LinkageName == Name || (!CGM.getCodeGenOpts().EmitGcovArcs &&
3072                               !CGM.getCodeGenOpts().EmitGcovNotes &&
3073                               !CGM.getCodeGenOpts().DebugInfoForProfiling &&
3074                               DebugKind <= codegenoptions::DebugLineTablesOnly))
3075     LinkageName = StringRef();
3076 
3077   if (DebugKind >= codegenoptions::LimitedDebugInfo) {
3078     if (const NamespaceDecl *NSDecl =
3079             dyn_cast_or_null<NamespaceDecl>(FD->getDeclContext()))
3080       FDContext = getOrCreateNamespace(NSDecl);
3081     else if (const RecordDecl *RDecl =
3082                  dyn_cast_or_null<RecordDecl>(FD->getDeclContext())) {
3083       llvm::DIScope *Mod = getParentModuleOrNull(RDecl);
3084       FDContext = getContextDescriptor(RDecl, Mod ? Mod : TheCU);
3085     }
3086     // Check if it is a noreturn-marked function
3087     if (FD->isNoReturn())
3088       Flags |= llvm::DINode::FlagNoReturn;
3089     // Collect template parameters.
3090     TParamsArray = CollectFunctionTemplateParams(FD, Unit);
3091   }
3092 }
3093 
3094 void CGDebugInfo::collectVarDeclProps(const VarDecl *VD, llvm::DIFile *&Unit,
3095                                       unsigned &LineNo, QualType &T,
3096                                       StringRef &Name, StringRef &LinkageName,
3097                                       llvm::MDTuple *&TemplateParameters,
3098                                       llvm::DIScope *&VDContext) {
3099   Unit = getOrCreateFile(VD->getLocation());
3100   LineNo = getLineNumber(VD->getLocation());
3101 
3102   setLocation(VD->getLocation());
3103 
3104   T = VD->getType();
3105   if (T->isIncompleteArrayType()) {
3106     // CodeGen turns int[] into int[1] so we'll do the same here.
3107     llvm::APInt ConstVal(32, 1);
3108     QualType ET = CGM.getContext().getAsArrayType(T)->getElementType();
3109 
3110     T = CGM.getContext().getConstantArrayType(ET, ConstVal, ArrayType::Normal,
3111                                               0);
3112   }
3113 
3114   Name = VD->getName();
3115   if (VD->getDeclContext() && !isa<FunctionDecl>(VD->getDeclContext()) &&
3116       !isa<ObjCMethodDecl>(VD->getDeclContext()))
3117     LinkageName = CGM.getMangledName(VD);
3118   if (LinkageName == Name)
3119     LinkageName = StringRef();
3120 
3121   if (isa<VarTemplateSpecializationDecl>(VD)) {
3122     llvm::DINodeArray parameterNodes = CollectVarTemplateParams(VD, &*Unit);
3123     TemplateParameters = parameterNodes.get();
3124   } else {
3125     TemplateParameters = nullptr;
3126   }
3127 
3128   // Since we emit declarations (DW_AT_members) for static members, place the
3129   // definition of those static members in the namespace they were declared in
3130   // in the source code (the lexical decl context).
3131   // FIXME: Generalize this for even non-member global variables where the
3132   // declaration and definition may have different lexical decl contexts, once
3133   // we have support for emitting declarations of (non-member) global variables.
3134   const DeclContext *DC = VD->isStaticDataMember() ? VD->getLexicalDeclContext()
3135                                                    : VD->getDeclContext();
3136   // When a record type contains an in-line initialization of a static data
3137   // member, and the record type is marked as __declspec(dllexport), an implicit
3138   // definition of the member will be created in the record context.  DWARF
3139   // doesn't seem to have a nice way to describe this in a form that consumers
3140   // are likely to understand, so fake the "normal" situation of a definition
3141   // outside the class by putting it in the global scope.
3142   if (DC->isRecord())
3143     DC = CGM.getContext().getTranslationUnitDecl();
3144 
3145   llvm::DIScope *Mod = getParentModuleOrNull(VD);
3146   VDContext = getContextDescriptor(cast<Decl>(DC), Mod ? Mod : TheCU);
3147 }
3148 
3149 llvm::DISubprogram *CGDebugInfo::getFunctionFwdDeclOrStub(GlobalDecl GD,
3150                                                           bool Stub) {
3151   llvm::DINodeArray TParamsArray;
3152   StringRef Name, LinkageName;
3153   llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
3154   SourceLocation Loc = GD.getDecl()->getLocation();
3155   llvm::DIFile *Unit = getOrCreateFile(Loc);
3156   llvm::DIScope *DContext = Unit;
3157   unsigned Line = getLineNumber(Loc);
3158   collectFunctionDeclProps(GD, Unit, Name, LinkageName, DContext, TParamsArray,
3159                            Flags);
3160   auto *FD = dyn_cast<FunctionDecl>(GD.getDecl());
3161 
3162   // Build function type.
3163   SmallVector<QualType, 16> ArgTypes;
3164   if (FD)
3165     for (const ParmVarDecl *Parm : FD->parameters())
3166       ArgTypes.push_back(Parm->getType());
3167   CallingConv CC = FD->getType()->castAs<FunctionType>()->getCallConv();
3168   QualType FnType = CGM.getContext().getFunctionType(
3169       FD->getReturnType(), ArgTypes, FunctionProtoType::ExtProtoInfo(CC));
3170   if (Stub) {
3171     Flags |= getCallSiteRelatedAttrs();
3172     return DBuilder.createFunction(
3173         DContext, Name, LinkageName, Unit, Line,
3174         getOrCreateFunctionType(GD.getDecl(), FnType, Unit),
3175         !FD->isExternallyVisible(),
3176         /* isDefinition = */ true, 0, Flags, CGM.getLangOpts().Optimize,
3177         TParamsArray.get(), getFunctionDeclaration(FD));
3178   }
3179 
3180   llvm::DISubprogram *SP = DBuilder.createTempFunctionFwdDecl(
3181       DContext, Name, LinkageName, Unit, Line,
3182       getOrCreateFunctionType(GD.getDecl(), FnType, Unit),
3183       !FD->isExternallyVisible(),
3184       /* isDefinition = */ false, 0, Flags, CGM.getLangOpts().Optimize,
3185       TParamsArray.get(), getFunctionDeclaration(FD));
3186   const FunctionDecl *CanonDecl = FD->getCanonicalDecl();
3187   FwdDeclReplaceMap.emplace_back(std::piecewise_construct,
3188                                  std::make_tuple(CanonDecl),
3189                                  std::make_tuple(SP));
3190   return SP;
3191 }
3192 
3193 llvm::DISubprogram *CGDebugInfo::getFunctionForwardDeclaration(GlobalDecl GD) {
3194   return getFunctionFwdDeclOrStub(GD, /* Stub = */ false);
3195 }
3196 
3197 llvm::DISubprogram *CGDebugInfo::getFunctionStub(GlobalDecl GD) {
3198   return getFunctionFwdDeclOrStub(GD, /* Stub = */ true);
3199 }
3200 
3201 llvm::DIGlobalVariable *
3202 CGDebugInfo::getGlobalVariableForwardDeclaration(const VarDecl *VD) {
3203   QualType T;
3204   StringRef Name, LinkageName;
3205   SourceLocation Loc = VD->getLocation();
3206   llvm::DIFile *Unit = getOrCreateFile(Loc);
3207   llvm::DIScope *DContext = Unit;
3208   unsigned Line = getLineNumber(Loc);
3209   llvm::MDTuple *TemplateParameters = nullptr;
3210 
3211   collectVarDeclProps(VD, Unit, Line, T, Name, LinkageName, TemplateParameters,
3212                       DContext);
3213   auto Align = getDeclAlignIfRequired(VD, CGM.getContext());
3214   auto *GV = DBuilder.createTempGlobalVariableFwdDecl(
3215       DContext, Name, LinkageName, Unit, Line, getOrCreateType(T, Unit),
3216       !VD->isExternallyVisible(), nullptr, TemplateParameters, Align);
3217   FwdDeclReplaceMap.emplace_back(
3218       std::piecewise_construct,
3219       std::make_tuple(cast<VarDecl>(VD->getCanonicalDecl())),
3220       std::make_tuple(static_cast<llvm::Metadata *>(GV)));
3221   return GV;
3222 }
3223 
3224 llvm::DINode *CGDebugInfo::getDeclarationOrDefinition(const Decl *D) {
3225   // We only need a declaration (not a definition) of the type - so use whatever
3226   // we would otherwise do to get a type for a pointee. (forward declarations in
3227   // limited debug info, full definitions (if the type definition is available)
3228   // in unlimited debug info)
3229   if (const auto *TD = dyn_cast<TypeDecl>(D))
3230     return getOrCreateType(CGM.getContext().getTypeDeclType(TD),
3231                            getOrCreateFile(TD->getLocation()));
3232   auto I = DeclCache.find(D->getCanonicalDecl());
3233 
3234   if (I != DeclCache.end()) {
3235     auto N = I->second;
3236     if (auto *GVE = dyn_cast_or_null<llvm::DIGlobalVariableExpression>(N))
3237       return GVE->getVariable();
3238     return dyn_cast_or_null<llvm::DINode>(N);
3239   }
3240 
3241   // No definition for now. Emit a forward definition that might be
3242   // merged with a potential upcoming definition.
3243   if (const auto *FD = dyn_cast<FunctionDecl>(D))
3244     return getFunctionForwardDeclaration(FD);
3245   else if (const auto *VD = dyn_cast<VarDecl>(D))
3246     return getGlobalVariableForwardDeclaration(VD);
3247 
3248   return nullptr;
3249 }
3250 
3251 llvm::DISubprogram *CGDebugInfo::getFunctionDeclaration(const Decl *D) {
3252   if (!D || DebugKind <= codegenoptions::DebugLineTablesOnly)
3253     return nullptr;
3254 
3255   const auto *FD = dyn_cast<FunctionDecl>(D);
3256   if (!FD)
3257     return nullptr;
3258 
3259   // Setup context.
3260   auto *S = getDeclContextDescriptor(D);
3261 
3262   auto MI = SPCache.find(FD->getCanonicalDecl());
3263   if (MI == SPCache.end()) {
3264     if (const auto *MD = dyn_cast<CXXMethodDecl>(FD->getCanonicalDecl())) {
3265       return CreateCXXMemberFunction(MD, getOrCreateFile(MD->getLocation()),
3266                                      cast<llvm::DICompositeType>(S));
3267     }
3268   }
3269   if (MI != SPCache.end()) {
3270     auto *SP = dyn_cast_or_null<llvm::DISubprogram>(MI->second);
3271     if (SP && !SP->isDefinition())
3272       return SP;
3273   }
3274 
3275   for (auto NextFD : FD->redecls()) {
3276     auto MI = SPCache.find(NextFD->getCanonicalDecl());
3277     if (MI != SPCache.end()) {
3278       auto *SP = dyn_cast_or_null<llvm::DISubprogram>(MI->second);
3279       if (SP && !SP->isDefinition())
3280         return SP;
3281     }
3282   }
3283   return nullptr;
3284 }
3285 
3286 // getOrCreateFunctionType - Construct type. If it is a c++ method, include
3287 // implicit parameter "this".
3288 llvm::DISubroutineType *CGDebugInfo::getOrCreateFunctionType(const Decl *D,
3289                                                              QualType FnType,
3290                                                              llvm::DIFile *F) {
3291   if (!D || DebugKind <= codegenoptions::DebugLineTablesOnly)
3292     // Create fake but valid subroutine type. Otherwise -verify would fail, and
3293     // subprogram DIE will miss DW_AT_decl_file and DW_AT_decl_line fields.
3294     return DBuilder.createSubroutineType(DBuilder.getOrCreateTypeArray(None));
3295 
3296   if (const auto *Method = dyn_cast<CXXMethodDecl>(D))
3297     return getOrCreateMethodType(Method, F);
3298 
3299   const auto *FTy = FnType->getAs<FunctionType>();
3300   CallingConv CC = FTy ? FTy->getCallConv() : CallingConv::CC_C;
3301 
3302   if (const auto *OMethod = dyn_cast<ObjCMethodDecl>(D)) {
3303     // Add "self" and "_cmd"
3304     SmallVector<llvm::Metadata *, 16> Elts;
3305 
3306     // First element is always return type. For 'void' functions it is NULL.
3307     QualType ResultTy = OMethod->getReturnType();
3308 
3309     // Replace the instancetype keyword with the actual type.
3310     if (ResultTy == CGM.getContext().getObjCInstanceType())
3311       ResultTy = CGM.getContext().getPointerType(
3312           QualType(OMethod->getClassInterface()->getTypeForDecl(), 0));
3313 
3314     Elts.push_back(getOrCreateType(ResultTy, F));
3315     // "self" pointer is always first argument.
3316     QualType SelfDeclTy;
3317     if (auto *SelfDecl = OMethod->getSelfDecl())
3318       SelfDeclTy = SelfDecl->getType();
3319     else if (auto *FPT = dyn_cast<FunctionProtoType>(FnType))
3320       if (FPT->getNumParams() > 1)
3321         SelfDeclTy = FPT->getParamType(0);
3322     if (!SelfDeclTy.isNull())
3323       Elts.push_back(
3324           CreateSelfType(SelfDeclTy, getOrCreateType(SelfDeclTy, F)));
3325     // "_cmd" pointer is always second argument.
3326     Elts.push_back(DBuilder.createArtificialType(
3327         getOrCreateType(CGM.getContext().getObjCSelType(), F)));
3328     // Get rest of the arguments.
3329     for (const auto *PI : OMethod->parameters())
3330       Elts.push_back(getOrCreateType(PI->getType(), F));
3331     // Variadic methods need a special marker at the end of the type list.
3332     if (OMethod->isVariadic())
3333       Elts.push_back(DBuilder.createUnspecifiedParameter());
3334 
3335     llvm::DITypeRefArray EltTypeArray = DBuilder.getOrCreateTypeArray(Elts);
3336     return DBuilder.createSubroutineType(EltTypeArray, llvm::DINode::FlagZero,
3337                                          getDwarfCC(CC));
3338   }
3339 
3340   // Handle variadic function types; they need an additional
3341   // unspecified parameter.
3342   if (const auto *FD = dyn_cast<FunctionDecl>(D))
3343     if (FD->isVariadic()) {
3344       SmallVector<llvm::Metadata *, 16> EltTys;
3345       EltTys.push_back(getOrCreateType(FD->getReturnType(), F));
3346       if (const auto *FPT = dyn_cast<FunctionProtoType>(FnType))
3347         for (QualType ParamType : FPT->param_types())
3348           EltTys.push_back(getOrCreateType(ParamType, F));
3349       EltTys.push_back(DBuilder.createUnspecifiedParameter());
3350       llvm::DITypeRefArray EltTypeArray = DBuilder.getOrCreateTypeArray(EltTys);
3351       return DBuilder.createSubroutineType(EltTypeArray, llvm::DINode::FlagZero,
3352                                            getDwarfCC(CC));
3353     }
3354 
3355   return cast<llvm::DISubroutineType>(getOrCreateType(FnType, F));
3356 }
3357 
3358 void CGDebugInfo::EmitFunctionStart(GlobalDecl GD, SourceLocation Loc,
3359                                     SourceLocation ScopeLoc, QualType FnType,
3360                                     llvm::Function *Fn, bool CurFuncIsThunk,
3361                                     CGBuilderTy &Builder) {
3362 
3363   StringRef Name;
3364   StringRef LinkageName;
3365 
3366   FnBeginRegionCount.push_back(LexicalBlockStack.size());
3367 
3368   const Decl *D = GD.getDecl();
3369   bool HasDecl = (D != nullptr);
3370 
3371   llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
3372   llvm::DIFile *Unit = getOrCreateFile(Loc);
3373   llvm::DIScope *FDContext = Unit;
3374   llvm::DINodeArray TParamsArray;
3375   if (!HasDecl) {
3376     // Use llvm function name.
3377     LinkageName = Fn->getName();
3378   } else if (const auto *FD = dyn_cast<FunctionDecl>(D)) {
3379     // If there is a subprogram for this function available then use it.
3380     auto FI = SPCache.find(FD->getCanonicalDecl());
3381     if (FI != SPCache.end()) {
3382       auto *SP = dyn_cast_or_null<llvm::DISubprogram>(FI->second);
3383       if (SP && SP->isDefinition()) {
3384         LexicalBlockStack.emplace_back(SP);
3385         RegionMap[D].reset(SP);
3386         return;
3387       }
3388     }
3389     collectFunctionDeclProps(GD, Unit, Name, LinkageName, FDContext,
3390                              TParamsArray, Flags);
3391   } else if (const auto *OMD = dyn_cast<ObjCMethodDecl>(D)) {
3392     Name = getObjCMethodName(OMD);
3393     Flags |= llvm::DINode::FlagPrototyped;
3394   } else {
3395     // Use llvm function name.
3396     Name = Fn->getName();
3397     Flags |= llvm::DINode::FlagPrototyped;
3398   }
3399   if (Name.startswith("\01"))
3400     Name = Name.substr(1);
3401 
3402   if (!HasDecl || D->isImplicit() || D->hasAttr<ArtificialAttr>()) {
3403     Flags |= llvm::DINode::FlagArtificial;
3404     // Artificial functions should not silently reuse CurLoc.
3405     CurLoc = SourceLocation();
3406   }
3407 
3408   if (CurFuncIsThunk)
3409     Flags |= llvm::DINode::FlagThunk;
3410 
3411   llvm::DINode::DIFlags FlagsForDef = Flags | getCallSiteRelatedAttrs();
3412 
3413   unsigned LineNo = getLineNumber(Loc);
3414   unsigned ScopeLine = getLineNumber(ScopeLoc);
3415 
3416   // FIXME: The function declaration we're constructing here is mostly reusing
3417   // declarations from CXXMethodDecl and not constructing new ones for arbitrary
3418   // FunctionDecls. When/if we fix this we can have FDContext be TheCU/null for
3419   // all subprograms instead of the actual context since subprogram definitions
3420   // are emitted as CU level entities by the backend.
3421   llvm::DISubprogram *SP = DBuilder.createFunction(
3422       FDContext, Name, LinkageName, Unit, LineNo,
3423       getOrCreateFunctionType(D, FnType, Unit), Fn->hasLocalLinkage(),
3424       true /*definition*/, ScopeLine, FlagsForDef, CGM.getLangOpts().Optimize,
3425       TParamsArray.get(), getFunctionDeclaration(D));
3426   Fn->setSubprogram(SP);
3427   // We might get here with a VarDecl in the case we're generating
3428   // code for the initialization of globals. Do not record these decls
3429   // as they will overwrite the actual VarDecl Decl in the cache.
3430   if (HasDecl && isa<FunctionDecl>(D))
3431     DeclCache[D->getCanonicalDecl()].reset(SP);
3432 
3433   if (CGM.getCodeGenOpts().DwarfVersion >= 5) {
3434     // Starting with DWARF V5 method declarations are emitted as children of
3435     // the interface type.
3436     if (const auto *OMD = dyn_cast_or_null<ObjCMethodDecl>(D)) {
3437       const ObjCInterfaceDecl *ID = OMD->getClassInterface();
3438       QualType QTy(ID->getTypeForDecl(), 0);
3439       auto It = TypeCache.find(QTy.getAsOpaquePtr());
3440       if (It != TypeCache.end()) {
3441         llvm::DICompositeType *InterfaceDecl =
3442             cast<llvm::DICompositeType>(It->second);
3443         llvm::DISubprogram *FD = DBuilder.createFunction(
3444             InterfaceDecl, Name, LinkageName, Unit, LineNo,
3445             getOrCreateFunctionType(D, FnType, Unit), Fn->hasLocalLinkage(),
3446             false /*definition*/, ScopeLine, Flags, CGM.getLangOpts().Optimize,
3447             TParamsArray.get());
3448         DBuilder.finalizeSubprogram(FD);
3449         ObjCMethodCache[ID].push_back(FD);
3450       }
3451     }
3452   }
3453 
3454   // Push the function onto the lexical block stack.
3455   LexicalBlockStack.emplace_back(SP);
3456 
3457   if (HasDecl)
3458     RegionMap[D].reset(SP);
3459 }
3460 
3461 void CGDebugInfo::EmitFunctionDecl(GlobalDecl GD, SourceLocation Loc,
3462                                    QualType FnType) {
3463   StringRef Name;
3464   StringRef LinkageName;
3465 
3466   const Decl *D = GD.getDecl();
3467   if (!D)
3468     return;
3469 
3470   llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
3471   llvm::DIFile *Unit = getOrCreateFile(Loc);
3472   llvm::DIScope *FDContext = getDeclContextDescriptor(D);
3473   llvm::DINodeArray TParamsArray;
3474   if (isa<FunctionDecl>(D)) {
3475     // If there is a DISubprogram for this function available then use it.
3476     collectFunctionDeclProps(GD, Unit, Name, LinkageName, FDContext,
3477                              TParamsArray, Flags);
3478   } else if (const auto *OMD = dyn_cast<ObjCMethodDecl>(D)) {
3479     Name = getObjCMethodName(OMD);
3480     Flags |= llvm::DINode::FlagPrototyped;
3481   } else {
3482     llvm_unreachable("not a function or ObjC method");
3483   }
3484   if (!Name.empty() && Name[0] == '\01')
3485     Name = Name.substr(1);
3486 
3487   if (D->isImplicit()) {
3488     Flags |= llvm::DINode::FlagArtificial;
3489     // Artificial functions without a location should not silently reuse CurLoc.
3490     if (Loc.isInvalid())
3491       CurLoc = SourceLocation();
3492   }
3493   unsigned LineNo = getLineNumber(Loc);
3494   unsigned ScopeLine = 0;
3495 
3496   DBuilder.retainType(DBuilder.createFunction(
3497       FDContext, Name, LinkageName, Unit, LineNo,
3498       getOrCreateFunctionType(D, FnType, Unit), false /*internalLinkage*/,
3499       false /*definition*/, ScopeLine, Flags, CGM.getLangOpts().Optimize,
3500       TParamsArray.get(), getFunctionDeclaration(D)));
3501 }
3502 
3503 void CGDebugInfo::EmitInlineFunctionStart(CGBuilderTy &Builder, GlobalDecl GD) {
3504   const auto *FD = cast<FunctionDecl>(GD.getDecl());
3505   // If there is a subprogram for this function available then use it.
3506   auto FI = SPCache.find(FD->getCanonicalDecl());
3507   llvm::DISubprogram *SP = nullptr;
3508   if (FI != SPCache.end())
3509     SP = dyn_cast_or_null<llvm::DISubprogram>(FI->second);
3510   if (!SP || !SP->isDefinition())
3511     SP = getFunctionStub(GD);
3512   FnBeginRegionCount.push_back(LexicalBlockStack.size());
3513   LexicalBlockStack.emplace_back(SP);
3514   setInlinedAt(Builder.getCurrentDebugLocation());
3515   EmitLocation(Builder, FD->getLocation());
3516 }
3517 
3518 void CGDebugInfo::EmitInlineFunctionEnd(CGBuilderTy &Builder) {
3519   assert(CurInlinedAt && "unbalanced inline scope stack");
3520   EmitFunctionEnd(Builder, nullptr);
3521   setInlinedAt(llvm::DebugLoc(CurInlinedAt).getInlinedAt());
3522 }
3523 
3524 void CGDebugInfo::EmitLocation(CGBuilderTy &Builder, SourceLocation Loc) {
3525   // Update our current location
3526   setLocation(Loc);
3527 
3528   if (CurLoc.isInvalid() || CurLoc.isMacroID())
3529     return;
3530 
3531   llvm::MDNode *Scope = LexicalBlockStack.back();
3532   Builder.SetCurrentDebugLocation(llvm::DebugLoc::get(
3533       getLineNumber(CurLoc), getColumnNumber(CurLoc), Scope, CurInlinedAt));
3534 }
3535 
3536 void CGDebugInfo::CreateLexicalBlock(SourceLocation Loc) {
3537   llvm::MDNode *Back = nullptr;
3538   if (!LexicalBlockStack.empty())
3539     Back = LexicalBlockStack.back().get();
3540   LexicalBlockStack.emplace_back(DBuilder.createLexicalBlock(
3541       cast<llvm::DIScope>(Back), getOrCreateFile(CurLoc), getLineNumber(CurLoc),
3542       getColumnNumber(CurLoc)));
3543 }
3544 
3545 void CGDebugInfo::AppendAddressSpaceXDeref(
3546     unsigned AddressSpace, SmallVectorImpl<int64_t> &Expr) const {
3547   Optional<unsigned> DWARFAddressSpace =
3548       CGM.getTarget().getDWARFAddressSpace(AddressSpace);
3549   if (!DWARFAddressSpace)
3550     return;
3551 
3552   Expr.push_back(llvm::dwarf::DW_OP_constu);
3553   Expr.push_back(DWARFAddressSpace.getValue());
3554   Expr.push_back(llvm::dwarf::DW_OP_swap);
3555   Expr.push_back(llvm::dwarf::DW_OP_xderef);
3556 }
3557 
3558 void CGDebugInfo::EmitLexicalBlockStart(CGBuilderTy &Builder,
3559                                         SourceLocation Loc) {
3560   // Set our current location.
3561   setLocation(Loc);
3562 
3563   // Emit a line table change for the current location inside the new scope.
3564   Builder.SetCurrentDebugLocation(
3565       llvm::DebugLoc::get(getLineNumber(Loc), getColumnNumber(Loc),
3566                           LexicalBlockStack.back(), CurInlinedAt));
3567 
3568   if (DebugKind <= codegenoptions::DebugLineTablesOnly)
3569     return;
3570 
3571   // Create a new lexical block and push it on the stack.
3572   CreateLexicalBlock(Loc);
3573 }
3574 
3575 void CGDebugInfo::EmitLexicalBlockEnd(CGBuilderTy &Builder,
3576                                       SourceLocation Loc) {
3577   assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
3578 
3579   // Provide an entry in the line table for the end of the block.
3580   EmitLocation(Builder, Loc);
3581 
3582   if (DebugKind <= codegenoptions::DebugLineTablesOnly)
3583     return;
3584 
3585   LexicalBlockStack.pop_back();
3586 }
3587 
3588 void CGDebugInfo::EmitFunctionEnd(CGBuilderTy &Builder, llvm::Function *Fn) {
3589   assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
3590   unsigned RCount = FnBeginRegionCount.back();
3591   assert(RCount <= LexicalBlockStack.size() && "Region stack mismatch");
3592 
3593   // Pop all regions for this function.
3594   while (LexicalBlockStack.size() != RCount) {
3595     // Provide an entry in the line table for the end of the block.
3596     EmitLocation(Builder, CurLoc);
3597     LexicalBlockStack.pop_back();
3598   }
3599   FnBeginRegionCount.pop_back();
3600 
3601   if (Fn && Fn->getSubprogram())
3602     DBuilder.finalizeSubprogram(Fn->getSubprogram());
3603 }
3604 
3605 CGDebugInfo::BlockByRefType
3606 CGDebugInfo::EmitTypeForVarWithBlocksAttr(const VarDecl *VD,
3607                                           uint64_t *XOffset) {
3608   SmallVector<llvm::Metadata *, 5> EltTys;
3609   QualType FType;
3610   uint64_t FieldSize, FieldOffset;
3611   uint32_t FieldAlign;
3612 
3613   llvm::DIFile *Unit = getOrCreateFile(VD->getLocation());
3614   QualType Type = VD->getType();
3615 
3616   FieldOffset = 0;
3617   FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
3618   EltTys.push_back(CreateMemberType(Unit, FType, "__isa", &FieldOffset));
3619   EltTys.push_back(CreateMemberType(Unit, FType, "__forwarding", &FieldOffset));
3620   FType = CGM.getContext().IntTy;
3621   EltTys.push_back(CreateMemberType(Unit, FType, "__flags", &FieldOffset));
3622   EltTys.push_back(CreateMemberType(Unit, FType, "__size", &FieldOffset));
3623 
3624   bool HasCopyAndDispose = CGM.getContext().BlockRequiresCopying(Type, VD);
3625   if (HasCopyAndDispose) {
3626     FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
3627     EltTys.push_back(
3628         CreateMemberType(Unit, FType, "__copy_helper", &FieldOffset));
3629     EltTys.push_back(
3630         CreateMemberType(Unit, FType, "__destroy_helper", &FieldOffset));
3631   }
3632   bool HasByrefExtendedLayout;
3633   Qualifiers::ObjCLifetime Lifetime;
3634   if (CGM.getContext().getByrefLifetime(Type, Lifetime,
3635                                         HasByrefExtendedLayout) &&
3636       HasByrefExtendedLayout) {
3637     FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
3638     EltTys.push_back(
3639         CreateMemberType(Unit, FType, "__byref_variable_layout", &FieldOffset));
3640   }
3641 
3642   CharUnits Align = CGM.getContext().getDeclAlign(VD);
3643   if (Align > CGM.getContext().toCharUnitsFromBits(
3644                   CGM.getTarget().getPointerAlign(0))) {
3645     CharUnits FieldOffsetInBytes =
3646         CGM.getContext().toCharUnitsFromBits(FieldOffset);
3647     CharUnits AlignedOffsetInBytes = FieldOffsetInBytes.alignTo(Align);
3648     CharUnits NumPaddingBytes = AlignedOffsetInBytes - FieldOffsetInBytes;
3649 
3650     if (NumPaddingBytes.isPositive()) {
3651       llvm::APInt pad(32, NumPaddingBytes.getQuantity());
3652       FType = CGM.getContext().getConstantArrayType(CGM.getContext().CharTy,
3653                                                     pad, ArrayType::Normal, 0);
3654       EltTys.push_back(CreateMemberType(Unit, FType, "", &FieldOffset));
3655     }
3656   }
3657 
3658   FType = Type;
3659   llvm::DIType *WrappedTy = getOrCreateType(FType, Unit);
3660   FieldSize = CGM.getContext().getTypeSize(FType);
3661   FieldAlign = CGM.getContext().toBits(Align);
3662 
3663   *XOffset = FieldOffset;
3664   llvm::DIType *FieldTy = DBuilder.createMemberType(
3665       Unit, VD->getName(), Unit, 0, FieldSize, FieldAlign, FieldOffset,
3666       llvm::DINode::FlagZero, WrappedTy);
3667   EltTys.push_back(FieldTy);
3668   FieldOffset += FieldSize;
3669 
3670   llvm::DINodeArray Elements = DBuilder.getOrCreateArray(EltTys);
3671   return {DBuilder.createStructType(Unit, "", Unit, 0, FieldOffset, 0,
3672                                     llvm::DINode::FlagZero, nullptr, Elements),
3673           WrappedTy};
3674 }
3675 
3676 llvm::DILocalVariable *CGDebugInfo::EmitDeclare(const VarDecl *VD,
3677                                                 llvm::Value *Storage,
3678                                                 llvm::Optional<unsigned> ArgNo,
3679                                                 CGBuilderTy &Builder) {
3680   assert(DebugKind >= codegenoptions::LimitedDebugInfo);
3681   assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
3682   if (VD->hasAttr<NoDebugAttr>())
3683     return nullptr;
3684 
3685   bool Unwritten =
3686       VD->isImplicit() || (isa<Decl>(VD->getDeclContext()) &&
3687                            cast<Decl>(VD->getDeclContext())->isImplicit());
3688   llvm::DIFile *Unit = nullptr;
3689   if (!Unwritten)
3690     Unit = getOrCreateFile(VD->getLocation());
3691   llvm::DIType *Ty;
3692   uint64_t XOffset = 0;
3693   if (VD->hasAttr<BlocksAttr>())
3694     Ty = EmitTypeForVarWithBlocksAttr(VD, &XOffset).WrappedType;
3695   else
3696     Ty = getOrCreateType(VD->getType(), Unit);
3697 
3698   // If there is no debug info for this type then do not emit debug info
3699   // for this variable.
3700   if (!Ty)
3701     return nullptr;
3702 
3703   // Get location information.
3704   unsigned Line = 0;
3705   unsigned Column = 0;
3706   if (!Unwritten) {
3707     Line = getLineNumber(VD->getLocation());
3708     Column = getColumnNumber(VD->getLocation());
3709   }
3710   SmallVector<int64_t, 13> Expr;
3711   llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
3712   if (VD->isImplicit())
3713     Flags |= llvm::DINode::FlagArtificial;
3714 
3715   auto Align = getDeclAlignIfRequired(VD, CGM.getContext());
3716 
3717   unsigned AddressSpace = CGM.getContext().getTargetAddressSpace(VD->getType());
3718   AppendAddressSpaceXDeref(AddressSpace, Expr);
3719 
3720   // If this is implicit parameter of CXXThis or ObjCSelf kind, then give it an
3721   // object pointer flag.
3722   if (const auto *IPD = dyn_cast<ImplicitParamDecl>(VD)) {
3723     if (IPD->getParameterKind() == ImplicitParamDecl::CXXThis ||
3724         IPD->getParameterKind() == ImplicitParamDecl::ObjCSelf)
3725       Flags |= llvm::DINode::FlagObjectPointer;
3726   }
3727 
3728   // Note: Older versions of clang used to emit byval references with an extra
3729   // DW_OP_deref, because they referenced the IR arg directly instead of
3730   // referencing an alloca. Newer versions of LLVM don't treat allocas
3731   // differently from other function arguments when used in a dbg.declare.
3732   auto *Scope = cast<llvm::DIScope>(LexicalBlockStack.back());
3733   StringRef Name = VD->getName();
3734   if (!Name.empty()) {
3735     if (VD->hasAttr<BlocksAttr>()) {
3736       // Here, we need an offset *into* the alloca.
3737       CharUnits offset = CharUnits::fromQuantity(32);
3738       Expr.push_back(llvm::dwarf::DW_OP_plus_uconst);
3739       // offset of __forwarding field
3740       offset = CGM.getContext().toCharUnitsFromBits(
3741           CGM.getTarget().getPointerWidth(0));
3742       Expr.push_back(offset.getQuantity());
3743       Expr.push_back(llvm::dwarf::DW_OP_deref);
3744       Expr.push_back(llvm::dwarf::DW_OP_plus_uconst);
3745       // offset of x field
3746       offset = CGM.getContext().toCharUnitsFromBits(XOffset);
3747       Expr.push_back(offset.getQuantity());
3748     }
3749   } else if (const auto *RT = dyn_cast<RecordType>(VD->getType())) {
3750     // If VD is an anonymous union then Storage represents value for
3751     // all union fields.
3752     const RecordDecl *RD = RT->getDecl();
3753     if (RD->isUnion() && RD->isAnonymousStructOrUnion()) {
3754       // GDB has trouble finding local variables in anonymous unions, so we emit
3755       // artificial local variables for each of the members.
3756       //
3757       // FIXME: Remove this code as soon as GDB supports this.
3758       // The debug info verifier in LLVM operates based on the assumption that a
3759       // variable has the same size as its storage and we had to disable the
3760       // check for artificial variables.
3761       for (const auto *Field : RD->fields()) {
3762         llvm::DIType *FieldTy = getOrCreateType(Field->getType(), Unit);
3763         StringRef FieldName = Field->getName();
3764 
3765         // Ignore unnamed fields. Do not ignore unnamed records.
3766         if (FieldName.empty() && !isa<RecordType>(Field->getType()))
3767           continue;
3768 
3769         // Use VarDecl's Tag, Scope and Line number.
3770         auto FieldAlign = getDeclAlignIfRequired(Field, CGM.getContext());
3771         auto *D = DBuilder.createAutoVariable(
3772             Scope, FieldName, Unit, Line, FieldTy, CGM.getLangOpts().Optimize,
3773             Flags | llvm::DINode::FlagArtificial, FieldAlign);
3774 
3775         // Insert an llvm.dbg.declare into the current block.
3776         DBuilder.insertDeclare(
3777             Storage, D, DBuilder.createExpression(Expr),
3778             llvm::DebugLoc::get(Line, Column, Scope, CurInlinedAt),
3779             Builder.GetInsertBlock());
3780       }
3781     }
3782   }
3783 
3784   // Create the descriptor for the variable.
3785   auto *D = ArgNo ? DBuilder.createParameterVariable(
3786                         Scope, Name, *ArgNo, Unit, Line, Ty,
3787                         CGM.getLangOpts().Optimize, Flags)
3788                   : DBuilder.createAutoVariable(Scope, Name, Unit, Line, Ty,
3789                                                 CGM.getLangOpts().Optimize,
3790                                                 Flags, Align);
3791 
3792   // Insert an llvm.dbg.declare into the current block.
3793   DBuilder.insertDeclare(Storage, D, DBuilder.createExpression(Expr),
3794                          llvm::DebugLoc::get(Line, Column, Scope, CurInlinedAt),
3795                          Builder.GetInsertBlock());
3796 
3797   return D;
3798 }
3799 
3800 llvm::DILocalVariable *
3801 CGDebugInfo::EmitDeclareOfAutoVariable(const VarDecl *VD, llvm::Value *Storage,
3802                                        CGBuilderTy &Builder) {
3803   assert(DebugKind >= codegenoptions::LimitedDebugInfo);
3804   return EmitDeclare(VD, Storage, llvm::None, Builder);
3805 }
3806 
3807 llvm::DIType *CGDebugInfo::CreateSelfType(const QualType &QualTy,
3808                                           llvm::DIType *Ty) {
3809   llvm::DIType *CachedTy = getTypeOrNull(QualTy);
3810   if (CachedTy)
3811     Ty = CachedTy;
3812   return DBuilder.createObjectPointerType(Ty);
3813 }
3814 
3815 void CGDebugInfo::EmitDeclareOfBlockDeclRefVariable(
3816     const VarDecl *VD, llvm::Value *Storage, CGBuilderTy &Builder,
3817     const CGBlockInfo &blockInfo, llvm::Instruction *InsertPoint) {
3818   assert(DebugKind >= codegenoptions::LimitedDebugInfo);
3819   assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
3820 
3821   if (Builder.GetInsertBlock() == nullptr)
3822     return;
3823   if (VD->hasAttr<NoDebugAttr>())
3824     return;
3825 
3826   bool isByRef = VD->hasAttr<BlocksAttr>();
3827 
3828   uint64_t XOffset = 0;
3829   llvm::DIFile *Unit = getOrCreateFile(VD->getLocation());
3830   llvm::DIType *Ty;
3831   if (isByRef)
3832     Ty = EmitTypeForVarWithBlocksAttr(VD, &XOffset).WrappedType;
3833   else
3834     Ty = getOrCreateType(VD->getType(), Unit);
3835 
3836   // Self is passed along as an implicit non-arg variable in a
3837   // block. Mark it as the object pointer.
3838   if (const auto *IPD = dyn_cast<ImplicitParamDecl>(VD))
3839     if (IPD->getParameterKind() == ImplicitParamDecl::ObjCSelf)
3840       Ty = CreateSelfType(VD->getType(), Ty);
3841 
3842   // Get location information.
3843   unsigned Line = getLineNumber(VD->getLocation());
3844   unsigned Column = getColumnNumber(VD->getLocation());
3845 
3846   const llvm::DataLayout &target = CGM.getDataLayout();
3847 
3848   CharUnits offset = CharUnits::fromQuantity(
3849       target.getStructLayout(blockInfo.StructureType)
3850           ->getElementOffset(blockInfo.getCapture(VD).getIndex()));
3851 
3852   SmallVector<int64_t, 9> addr;
3853   addr.push_back(llvm::dwarf::DW_OP_deref);
3854   addr.push_back(llvm::dwarf::DW_OP_plus_uconst);
3855   addr.push_back(offset.getQuantity());
3856   if (isByRef) {
3857     addr.push_back(llvm::dwarf::DW_OP_deref);
3858     addr.push_back(llvm::dwarf::DW_OP_plus_uconst);
3859     // offset of __forwarding field
3860     offset =
3861         CGM.getContext().toCharUnitsFromBits(target.getPointerSizeInBits(0));
3862     addr.push_back(offset.getQuantity());
3863     addr.push_back(llvm::dwarf::DW_OP_deref);
3864     addr.push_back(llvm::dwarf::DW_OP_plus_uconst);
3865     // offset of x field
3866     offset = CGM.getContext().toCharUnitsFromBits(XOffset);
3867     addr.push_back(offset.getQuantity());
3868   }
3869 
3870   // Create the descriptor for the variable.
3871   auto Align = getDeclAlignIfRequired(VD, CGM.getContext());
3872   auto *D = DBuilder.createAutoVariable(
3873       cast<llvm::DILocalScope>(LexicalBlockStack.back()), VD->getName(), Unit,
3874       Line, Ty, false, llvm::DINode::FlagZero, Align);
3875 
3876   // Insert an llvm.dbg.declare into the current block.
3877   auto DL =
3878       llvm::DebugLoc::get(Line, Column, LexicalBlockStack.back(), CurInlinedAt);
3879   auto *Expr = DBuilder.createExpression(addr);
3880   if (InsertPoint)
3881     DBuilder.insertDeclare(Storage, D, Expr, DL, InsertPoint);
3882   else
3883     DBuilder.insertDeclare(Storage, D, Expr, DL, Builder.GetInsertBlock());
3884 }
3885 
3886 void CGDebugInfo::EmitDeclareOfArgVariable(const VarDecl *VD, llvm::Value *AI,
3887                                            unsigned ArgNo,
3888                                            CGBuilderTy &Builder) {
3889   assert(DebugKind >= codegenoptions::LimitedDebugInfo);
3890   EmitDeclare(VD, AI, ArgNo, Builder);
3891 }
3892 
3893 namespace {
3894 struct BlockLayoutChunk {
3895   uint64_t OffsetInBits;
3896   const BlockDecl::Capture *Capture;
3897 };
3898 bool operator<(const BlockLayoutChunk &l, const BlockLayoutChunk &r) {
3899   return l.OffsetInBits < r.OffsetInBits;
3900 }
3901 } // namespace
3902 
3903 void CGDebugInfo::collectDefaultFieldsForBlockLiteralDeclare(
3904     const CGBlockInfo &Block, const ASTContext &Context, SourceLocation Loc,
3905     const llvm::StructLayout &BlockLayout, llvm::DIFile *Unit,
3906     SmallVectorImpl<llvm::Metadata *> &Fields) {
3907   // Blocks in OpenCL have unique constraints which make the standard fields
3908   // redundant while requiring size and align fields for enqueue_kernel. See
3909   // initializeForBlockHeader in CGBlocks.cpp
3910   if (CGM.getLangOpts().OpenCL) {
3911     Fields.push_back(createFieldType("__size", Context.IntTy, Loc, AS_public,
3912                                      BlockLayout.getElementOffsetInBits(0),
3913                                      Unit, Unit));
3914     Fields.push_back(createFieldType("__align", Context.IntTy, Loc, AS_public,
3915                                      BlockLayout.getElementOffsetInBits(1),
3916                                      Unit, Unit));
3917   } else {
3918     Fields.push_back(createFieldType("__isa", Context.VoidPtrTy, Loc, AS_public,
3919                                      BlockLayout.getElementOffsetInBits(0),
3920                                      Unit, Unit));
3921     Fields.push_back(createFieldType("__flags", Context.IntTy, Loc, AS_public,
3922                                      BlockLayout.getElementOffsetInBits(1),
3923                                      Unit, Unit));
3924     Fields.push_back(
3925         createFieldType("__reserved", Context.IntTy, Loc, AS_public,
3926                         BlockLayout.getElementOffsetInBits(2), Unit, Unit));
3927     auto *FnTy = Block.getBlockExpr()->getFunctionType();
3928     auto FnPtrType = CGM.getContext().getPointerType(FnTy->desugar());
3929     Fields.push_back(createFieldType("__FuncPtr", FnPtrType, Loc, AS_public,
3930                                      BlockLayout.getElementOffsetInBits(3),
3931                                      Unit, Unit));
3932     Fields.push_back(createFieldType(
3933         "__descriptor",
3934         Context.getPointerType(Block.NeedsCopyDispose
3935                                    ? Context.getBlockDescriptorExtendedType()
3936                                    : Context.getBlockDescriptorType()),
3937         Loc, AS_public, BlockLayout.getElementOffsetInBits(4), Unit, Unit));
3938   }
3939 }
3940 
3941 void CGDebugInfo::EmitDeclareOfBlockLiteralArgVariable(const CGBlockInfo &block,
3942                                                        StringRef Name,
3943                                                        unsigned ArgNo,
3944                                                        llvm::AllocaInst *Alloca,
3945                                                        CGBuilderTy &Builder) {
3946   assert(DebugKind >= codegenoptions::LimitedDebugInfo);
3947   ASTContext &C = CGM.getContext();
3948   const BlockDecl *blockDecl = block.getBlockDecl();
3949 
3950   // Collect some general information about the block's location.
3951   SourceLocation loc = blockDecl->getCaretLocation();
3952   llvm::DIFile *tunit = getOrCreateFile(loc);
3953   unsigned line = getLineNumber(loc);
3954   unsigned column = getColumnNumber(loc);
3955 
3956   // Build the debug-info type for the block literal.
3957   getDeclContextDescriptor(blockDecl);
3958 
3959   const llvm::StructLayout *blockLayout =
3960       CGM.getDataLayout().getStructLayout(block.StructureType);
3961 
3962   SmallVector<llvm::Metadata *, 16> fields;
3963   collectDefaultFieldsForBlockLiteralDeclare(block, C, loc, *blockLayout, tunit,
3964                                              fields);
3965 
3966   // We want to sort the captures by offset, not because DWARF
3967   // requires this, but because we're paranoid about debuggers.
3968   SmallVector<BlockLayoutChunk, 8> chunks;
3969 
3970   // 'this' capture.
3971   if (blockDecl->capturesCXXThis()) {
3972     BlockLayoutChunk chunk;
3973     chunk.OffsetInBits =
3974         blockLayout->getElementOffsetInBits(block.CXXThisIndex);
3975     chunk.Capture = nullptr;
3976     chunks.push_back(chunk);
3977   }
3978 
3979   // Variable captures.
3980   for (const auto &capture : blockDecl->captures()) {
3981     const VarDecl *variable = capture.getVariable();
3982     const CGBlockInfo::Capture &captureInfo = block.getCapture(variable);
3983 
3984     // Ignore constant captures.
3985     if (captureInfo.isConstant())
3986       continue;
3987 
3988     BlockLayoutChunk chunk;
3989     chunk.OffsetInBits =
3990         blockLayout->getElementOffsetInBits(captureInfo.getIndex());
3991     chunk.Capture = &capture;
3992     chunks.push_back(chunk);
3993   }
3994 
3995   // Sort by offset.
3996   llvm::array_pod_sort(chunks.begin(), chunks.end());
3997 
3998   for (const BlockLayoutChunk &Chunk : chunks) {
3999     uint64_t offsetInBits = Chunk.OffsetInBits;
4000     const BlockDecl::Capture *capture = Chunk.Capture;
4001 
4002     // If we have a null capture, this must be the C++ 'this' capture.
4003     if (!capture) {
4004       QualType type;
4005       if (auto *Method =
4006               cast_or_null<CXXMethodDecl>(blockDecl->getNonClosureContext()))
4007         type = Method->getThisType(C);
4008       else if (auto *RDecl = dyn_cast<CXXRecordDecl>(blockDecl->getParent()))
4009         type = QualType(RDecl->getTypeForDecl(), 0);
4010       else
4011         llvm_unreachable("unexpected block declcontext");
4012 
4013       fields.push_back(createFieldType("this", type, loc, AS_public,
4014                                        offsetInBits, tunit, tunit));
4015       continue;
4016     }
4017 
4018     const VarDecl *variable = capture->getVariable();
4019     StringRef name = variable->getName();
4020 
4021     llvm::DIType *fieldType;
4022     if (capture->isByRef()) {
4023       TypeInfo PtrInfo = C.getTypeInfo(C.VoidPtrTy);
4024       auto Align = PtrInfo.AlignIsRequired ? PtrInfo.Align : 0;
4025       // FIXME: This recomputes the layout of the BlockByRefWrapper.
4026       uint64_t xoffset;
4027       fieldType =
4028           EmitTypeForVarWithBlocksAttr(variable, &xoffset).BlockByRefWrapper;
4029       fieldType = DBuilder.createPointerType(fieldType, PtrInfo.Width);
4030       fieldType = DBuilder.createMemberType(tunit, name, tunit, line,
4031                                             PtrInfo.Width, Align, offsetInBits,
4032                                             llvm::DINode::FlagZero, fieldType);
4033     } else {
4034       auto Align = getDeclAlignIfRequired(variable, CGM.getContext());
4035       fieldType = createFieldType(name, variable->getType(), loc, AS_public,
4036                                   offsetInBits, Align, tunit, tunit);
4037     }
4038     fields.push_back(fieldType);
4039   }
4040 
4041   SmallString<36> typeName;
4042   llvm::raw_svector_ostream(typeName)
4043       << "__block_literal_" << CGM.getUniqueBlockCount();
4044 
4045   llvm::DINodeArray fieldsArray = DBuilder.getOrCreateArray(fields);
4046 
4047   llvm::DIType *type =
4048       DBuilder.createStructType(tunit, typeName.str(), tunit, line,
4049                                 CGM.getContext().toBits(block.BlockSize), 0,
4050                                 llvm::DINode::FlagZero, nullptr, fieldsArray);
4051   type = DBuilder.createPointerType(type, CGM.PointerWidthInBits);
4052 
4053   // Get overall information about the block.
4054   llvm::DINode::DIFlags flags = llvm::DINode::FlagArtificial;
4055   auto *scope = cast<llvm::DILocalScope>(LexicalBlockStack.back());
4056 
4057   // Create the descriptor for the parameter.
4058   auto *debugVar = DBuilder.createParameterVariable(
4059       scope, Name, ArgNo, tunit, line, type, CGM.getLangOpts().Optimize, flags);
4060 
4061   // Insert an llvm.dbg.declare into the current block.
4062   DBuilder.insertDeclare(Alloca, debugVar, DBuilder.createExpression(),
4063                          llvm::DebugLoc::get(line, column, scope, CurInlinedAt),
4064                          Builder.GetInsertBlock());
4065 }
4066 
4067 llvm::DIDerivedType *
4068 CGDebugInfo::getOrCreateStaticDataMemberDeclarationOrNull(const VarDecl *D) {
4069   if (!D->isStaticDataMember())
4070     return nullptr;
4071 
4072   auto MI = StaticDataMemberCache.find(D->getCanonicalDecl());
4073   if (MI != StaticDataMemberCache.end()) {
4074     assert(MI->second && "Static data member declaration should still exist");
4075     return MI->second;
4076   }
4077 
4078   // If the member wasn't found in the cache, lazily construct and add it to the
4079   // type (used when a limited form of the type is emitted).
4080   auto DC = D->getDeclContext();
4081   auto *Ctxt = cast<llvm::DICompositeType>(getDeclContextDescriptor(D));
4082   return CreateRecordStaticField(D, Ctxt, cast<RecordDecl>(DC));
4083 }
4084 
4085 llvm::DIGlobalVariableExpression *CGDebugInfo::CollectAnonRecordDecls(
4086     const RecordDecl *RD, llvm::DIFile *Unit, unsigned LineNo,
4087     StringRef LinkageName, llvm::GlobalVariable *Var, llvm::DIScope *DContext) {
4088   llvm::DIGlobalVariableExpression *GVE = nullptr;
4089 
4090   for (const auto *Field : RD->fields()) {
4091     llvm::DIType *FieldTy = getOrCreateType(Field->getType(), Unit);
4092     StringRef FieldName = Field->getName();
4093 
4094     // Ignore unnamed fields, but recurse into anonymous records.
4095     if (FieldName.empty()) {
4096       if (const auto *RT = dyn_cast<RecordType>(Field->getType()))
4097         GVE = CollectAnonRecordDecls(RT->getDecl(), Unit, LineNo, LinkageName,
4098                                      Var, DContext);
4099       continue;
4100     }
4101     // Use VarDecl's Tag, Scope and Line number.
4102     GVE = DBuilder.createGlobalVariableExpression(
4103         DContext, FieldName, LinkageName, Unit, LineNo, FieldTy,
4104         Var->hasLocalLinkage());
4105     Var->addDebugInfo(GVE);
4106   }
4107   return GVE;
4108 }
4109 
4110 void CGDebugInfo::EmitGlobalVariable(llvm::GlobalVariable *Var,
4111                                      const VarDecl *D) {
4112   assert(DebugKind >= codegenoptions::LimitedDebugInfo);
4113   if (D->hasAttr<NoDebugAttr>())
4114     return;
4115 
4116   // If we already created a DIGlobalVariable for this declaration, just attach
4117   // it to the llvm::GlobalVariable.
4118   auto Cached = DeclCache.find(D->getCanonicalDecl());
4119   if (Cached != DeclCache.end())
4120     return Var->addDebugInfo(
4121         cast<llvm::DIGlobalVariableExpression>(Cached->second));
4122 
4123   // Create global variable debug descriptor.
4124   llvm::DIFile *Unit = nullptr;
4125   llvm::DIScope *DContext = nullptr;
4126   unsigned LineNo;
4127   StringRef DeclName, LinkageName;
4128   QualType T;
4129   llvm::MDTuple *TemplateParameters = nullptr;
4130   collectVarDeclProps(D, Unit, LineNo, T, DeclName, LinkageName,
4131                       TemplateParameters, DContext);
4132 
4133   // Attempt to store one global variable for the declaration - even if we
4134   // emit a lot of fields.
4135   llvm::DIGlobalVariableExpression *GVE = nullptr;
4136 
4137   // If this is an anonymous union then we'll want to emit a global
4138   // variable for each member of the anonymous union so that it's possible
4139   // to find the name of any field in the union.
4140   if (T->isUnionType() && DeclName.empty()) {
4141     const RecordDecl *RD = T->castAs<RecordType>()->getDecl();
4142     assert(RD->isAnonymousStructOrUnion() &&
4143            "unnamed non-anonymous struct or union?");
4144     GVE = CollectAnonRecordDecls(RD, Unit, LineNo, LinkageName, Var, DContext);
4145   } else {
4146     auto Align = getDeclAlignIfRequired(D, CGM.getContext());
4147 
4148     SmallVector<int64_t, 4> Expr;
4149     unsigned AddressSpace =
4150         CGM.getContext().getTargetAddressSpace(D->getType());
4151     AppendAddressSpaceXDeref(AddressSpace, Expr);
4152 
4153     GVE = DBuilder.createGlobalVariableExpression(
4154         DContext, DeclName, LinkageName, Unit, LineNo, getOrCreateType(T, Unit),
4155         Var->hasLocalLinkage(),
4156         Expr.empty() ? nullptr : DBuilder.createExpression(Expr),
4157         getOrCreateStaticDataMemberDeclarationOrNull(D), TemplateParameters,
4158         Align);
4159     Var->addDebugInfo(GVE);
4160   }
4161   DeclCache[D->getCanonicalDecl()].reset(GVE);
4162 }
4163 
4164 void CGDebugInfo::EmitGlobalVariable(const ValueDecl *VD, const APValue &Init) {
4165   assert(DebugKind >= codegenoptions::LimitedDebugInfo);
4166   if (VD->hasAttr<NoDebugAttr>())
4167     return;
4168   auto Align = getDeclAlignIfRequired(VD, CGM.getContext());
4169   // Create the descriptor for the variable.
4170   llvm::DIFile *Unit = getOrCreateFile(VD->getLocation());
4171   StringRef Name = VD->getName();
4172   llvm::DIType *Ty = getOrCreateType(VD->getType(), Unit);
4173   if (const auto *ECD = dyn_cast<EnumConstantDecl>(VD)) {
4174     const auto *ED = cast<EnumDecl>(ECD->getDeclContext());
4175     assert(isa<EnumType>(ED->getTypeForDecl()) && "Enum without EnumType?");
4176     Ty = getOrCreateType(QualType(ED->getTypeForDecl(), 0), Unit);
4177   }
4178   // Do not use global variables for enums.
4179   //
4180   // FIXME: why not?
4181   if (Ty->getTag() == llvm::dwarf::DW_TAG_enumeration_type)
4182     return;
4183   // Do not emit separate definitions for function local const/statics.
4184   if (isa<FunctionDecl>(VD->getDeclContext()))
4185     return;
4186   VD = cast<ValueDecl>(VD->getCanonicalDecl());
4187   auto *VarD = cast<VarDecl>(VD);
4188   if (VarD->isStaticDataMember()) {
4189     auto *RD = cast<RecordDecl>(VarD->getDeclContext());
4190     getDeclContextDescriptor(VarD);
4191     // Ensure that the type is retained even though it's otherwise unreferenced.
4192     //
4193     // FIXME: This is probably unnecessary, since Ty should reference RD
4194     // through its scope.
4195     RetainedTypes.push_back(
4196         CGM.getContext().getRecordType(RD).getAsOpaquePtr());
4197     return;
4198   }
4199 
4200   llvm::DIScope *DContext = getDeclContextDescriptor(VD);
4201 
4202   auto &GV = DeclCache[VD];
4203   if (GV)
4204     return;
4205   llvm::DIExpression *InitExpr = nullptr;
4206   if (CGM.getContext().getTypeSize(VD->getType()) <= 64) {
4207     // FIXME: Add a representation for integer constants wider than 64 bits.
4208     if (Init.isInt())
4209       InitExpr =
4210           DBuilder.createConstantValueExpression(Init.getInt().getExtValue());
4211     else if (Init.isFloat())
4212       InitExpr = DBuilder.createConstantValueExpression(
4213           Init.getFloat().bitcastToAPInt().getZExtValue());
4214   }
4215 
4216   llvm::MDTuple *TemplateParameters = nullptr;
4217 
4218   if (isa<VarTemplateSpecializationDecl>(VD))
4219     if (VarD) {
4220       llvm::DINodeArray parameterNodes = CollectVarTemplateParams(VarD, &*Unit);
4221       TemplateParameters = parameterNodes.get();
4222     }
4223 
4224   GV.reset(DBuilder.createGlobalVariableExpression(
4225       DContext, Name, StringRef(), Unit, getLineNumber(VD->getLocation()), Ty,
4226       true, InitExpr, getOrCreateStaticDataMemberDeclarationOrNull(VarD),
4227       TemplateParameters, Align));
4228 }
4229 
4230 llvm::DIScope *CGDebugInfo::getCurrentContextDescriptor(const Decl *D) {
4231   if (!LexicalBlockStack.empty())
4232     return LexicalBlockStack.back();
4233   llvm::DIScope *Mod = getParentModuleOrNull(D);
4234   return getContextDescriptor(D, Mod ? Mod : TheCU);
4235 }
4236 
4237 void CGDebugInfo::EmitUsingDirective(const UsingDirectiveDecl &UD) {
4238   if (CGM.getCodeGenOpts().getDebugInfo() < codegenoptions::LimitedDebugInfo)
4239     return;
4240   const NamespaceDecl *NSDecl = UD.getNominatedNamespace();
4241   if (!NSDecl->isAnonymousNamespace() ||
4242       CGM.getCodeGenOpts().DebugExplicitImport) {
4243     auto Loc = UD.getLocation();
4244     DBuilder.createImportedModule(
4245         getCurrentContextDescriptor(cast<Decl>(UD.getDeclContext())),
4246         getOrCreateNamespace(NSDecl), getOrCreateFile(Loc), getLineNumber(Loc));
4247   }
4248 }
4249 
4250 void CGDebugInfo::EmitUsingDecl(const UsingDecl &UD) {
4251   if (CGM.getCodeGenOpts().getDebugInfo() < codegenoptions::LimitedDebugInfo)
4252     return;
4253   assert(UD.shadow_size() &&
4254          "We shouldn't be codegening an invalid UsingDecl containing no decls");
4255   // Emitting one decl is sufficient - debuggers can detect that this is an
4256   // overloaded name & provide lookup for all the overloads.
4257   const UsingShadowDecl &USD = **UD.shadow_begin();
4258 
4259   // FIXME: Skip functions with undeduced auto return type for now since we
4260   // don't currently have the plumbing for separate declarations & definitions
4261   // of free functions and mismatched types (auto in the declaration, concrete
4262   // return type in the definition)
4263   if (const auto *FD = dyn_cast<FunctionDecl>(USD.getUnderlyingDecl()))
4264     if (const auto *AT =
4265             FD->getType()->getAs<FunctionProtoType>()->getContainedAutoType())
4266       if (AT->getDeducedType().isNull())
4267         return;
4268   if (llvm::DINode *Target =
4269           getDeclarationOrDefinition(USD.getUnderlyingDecl())) {
4270     auto Loc = USD.getLocation();
4271     DBuilder.createImportedDeclaration(
4272         getCurrentContextDescriptor(cast<Decl>(USD.getDeclContext())), Target,
4273         getOrCreateFile(Loc), getLineNumber(Loc));
4274   }
4275 }
4276 
4277 void CGDebugInfo::EmitImportDecl(const ImportDecl &ID) {
4278   if (CGM.getCodeGenOpts().getDebuggerTuning() != llvm::DebuggerKind::LLDB)
4279     return;
4280   if (Module *M = ID.getImportedModule()) {
4281     auto Info = ExternalASTSource::ASTSourceDescriptor(*M);
4282     auto Loc = ID.getLocation();
4283     DBuilder.createImportedDeclaration(
4284         getCurrentContextDescriptor(cast<Decl>(ID.getDeclContext())),
4285         getOrCreateModuleRef(Info, DebugTypeExtRefs), getOrCreateFile(Loc),
4286         getLineNumber(Loc));
4287   }
4288 }
4289 
4290 llvm::DIImportedEntity *
4291 CGDebugInfo::EmitNamespaceAlias(const NamespaceAliasDecl &NA) {
4292   if (CGM.getCodeGenOpts().getDebugInfo() < codegenoptions::LimitedDebugInfo)
4293     return nullptr;
4294   auto &VH = NamespaceAliasCache[&NA];
4295   if (VH)
4296     return cast<llvm::DIImportedEntity>(VH);
4297   llvm::DIImportedEntity *R;
4298   auto Loc = NA.getLocation();
4299   if (const auto *Underlying =
4300           dyn_cast<NamespaceAliasDecl>(NA.getAliasedNamespace()))
4301     // This could cache & dedup here rather than relying on metadata deduping.
4302     R = DBuilder.createImportedDeclaration(
4303         getCurrentContextDescriptor(cast<Decl>(NA.getDeclContext())),
4304         EmitNamespaceAlias(*Underlying), getOrCreateFile(Loc),
4305         getLineNumber(Loc), NA.getName());
4306   else
4307     R = DBuilder.createImportedDeclaration(
4308         getCurrentContextDescriptor(cast<Decl>(NA.getDeclContext())),
4309         getOrCreateNamespace(cast<NamespaceDecl>(NA.getAliasedNamespace())),
4310         getOrCreateFile(Loc), getLineNumber(Loc), NA.getName());
4311   VH.reset(R);
4312   return R;
4313 }
4314 
4315 llvm::DINamespace *
4316 CGDebugInfo::getOrCreateNamespace(const NamespaceDecl *NSDecl) {
4317   // Don't canonicalize the NamespaceDecl here: The DINamespace will be uniqued
4318   // if necessary, and this way multiple declarations of the same namespace in
4319   // different parent modules stay distinct.
4320   auto I = NamespaceCache.find(NSDecl);
4321   if (I != NamespaceCache.end())
4322     return cast<llvm::DINamespace>(I->second);
4323 
4324   llvm::DIScope *Context = getDeclContextDescriptor(NSDecl);
4325   // Don't trust the context if it is a DIModule (see comment above).
4326   llvm::DINamespace *NS =
4327       DBuilder.createNameSpace(Context, NSDecl->getName(), NSDecl->isInline());
4328   NamespaceCache[NSDecl].reset(NS);
4329   return NS;
4330 }
4331 
4332 void CGDebugInfo::setDwoId(uint64_t Signature) {
4333   assert(TheCU && "no main compile unit");
4334   TheCU->setDWOId(Signature);
4335 }
4336 
4337 void CGDebugInfo::finalize() {
4338   // Creating types might create further types - invalidating the current
4339   // element and the size(), so don't cache/reference them.
4340   for (size_t i = 0; i != ObjCInterfaceCache.size(); ++i) {
4341     ObjCInterfaceCacheEntry E = ObjCInterfaceCache[i];
4342     llvm::DIType *Ty = E.Type->getDecl()->getDefinition()
4343                            ? CreateTypeDefinition(E.Type, E.Unit)
4344                            : E.Decl;
4345     DBuilder.replaceTemporary(llvm::TempDIType(E.Decl), Ty);
4346   }
4347 
4348   if (CGM.getCodeGenOpts().DwarfVersion >= 5) {
4349     // Add methods to interface.
4350     for (const auto &P : ObjCMethodCache) {
4351       if (P.second.empty())
4352         continue;
4353 
4354       QualType QTy(P.first->getTypeForDecl(), 0);
4355       auto It = TypeCache.find(QTy.getAsOpaquePtr());
4356       assert(It != TypeCache.end());
4357 
4358       llvm::DICompositeType *InterfaceDecl =
4359           cast<llvm::DICompositeType>(It->second);
4360 
4361       SmallVector<llvm::Metadata *, 16> EltTys;
4362       auto CurrenetElts = InterfaceDecl->getElements();
4363       EltTys.append(CurrenetElts.begin(), CurrenetElts.end());
4364       for (auto &MD : P.second)
4365         EltTys.push_back(MD);
4366       llvm::DINodeArray Elements = DBuilder.getOrCreateArray(EltTys);
4367       DBuilder.replaceArrays(InterfaceDecl, Elements);
4368     }
4369   }
4370 
4371   for (const auto &P : ReplaceMap) {
4372     assert(P.second);
4373     auto *Ty = cast<llvm::DIType>(P.second);
4374     assert(Ty->isForwardDecl());
4375 
4376     auto It = TypeCache.find(P.first);
4377     assert(It != TypeCache.end());
4378     assert(It->second);
4379 
4380     DBuilder.replaceTemporary(llvm::TempDIType(Ty),
4381                               cast<llvm::DIType>(It->second));
4382   }
4383 
4384   for (const auto &P : FwdDeclReplaceMap) {
4385     assert(P.second);
4386     llvm::TempMDNode FwdDecl(cast<llvm::MDNode>(P.second));
4387     llvm::Metadata *Repl;
4388 
4389     auto It = DeclCache.find(P.first);
4390     // If there has been no definition for the declaration, call RAUW
4391     // with ourselves, that will destroy the temporary MDNode and
4392     // replace it with a standard one, avoiding leaking memory.
4393     if (It == DeclCache.end())
4394       Repl = P.second;
4395     else
4396       Repl = It->second;
4397 
4398     if (auto *GVE = dyn_cast_or_null<llvm::DIGlobalVariableExpression>(Repl))
4399       Repl = GVE->getVariable();
4400     DBuilder.replaceTemporary(std::move(FwdDecl), cast<llvm::MDNode>(Repl));
4401   }
4402 
4403   // We keep our own list of retained types, because we need to look
4404   // up the final type in the type cache.
4405   for (auto &RT : RetainedTypes)
4406     if (auto MD = TypeCache[RT])
4407       DBuilder.retainType(cast<llvm::DIType>(MD));
4408 
4409   DBuilder.finalize();
4410 }
4411 
4412 void CGDebugInfo::EmitExplicitCastType(QualType Ty) {
4413   if (CGM.getCodeGenOpts().getDebugInfo() < codegenoptions::LimitedDebugInfo)
4414     return;
4415 
4416   if (auto *DieTy = getOrCreateType(Ty, getOrCreateMainFile()))
4417     // Don't ignore in case of explicit cast where it is referenced indirectly.
4418     DBuilder.retainType(DieTy);
4419 }
4420 
4421 llvm::DebugLoc CGDebugInfo::SourceLocToDebugLoc(SourceLocation Loc) {
4422   if (LexicalBlockStack.empty())
4423     return llvm::DebugLoc();
4424 
4425   llvm::MDNode *Scope = LexicalBlockStack.back();
4426   return llvm::DebugLoc::get(getLineNumber(Loc), getColumnNumber(Loc), Scope);
4427 }
4428 
4429 llvm::DINode::DIFlags CGDebugInfo::getCallSiteRelatedAttrs() const {
4430   // Call site-related attributes are only useful in optimized programs, and
4431   // when there's a possibility of debugging backtraces.
4432   if (!CGM.getLangOpts().Optimize || DebugKind == codegenoptions::NoDebugInfo ||
4433       DebugKind == codegenoptions::LocTrackingOnly)
4434     return llvm::DINode::FlagZero;
4435 
4436   // Call site-related attributes are available in DWARF v5. Some debuggers,
4437   // while not fully DWARF v5-compliant, may accept these attributes as if they
4438   // were part of DWARF v4.
4439   bool SupportsDWARFv4Ext =
4440       CGM.getCodeGenOpts().DwarfVersion == 4 &&
4441       CGM.getCodeGenOpts().getDebuggerTuning() == llvm::DebuggerKind::LLDB;
4442   if (!SupportsDWARFv4Ext && CGM.getCodeGenOpts().DwarfVersion < 5)
4443     return llvm::DINode::FlagZero;
4444 
4445   return llvm::DINode::FlagAllCallsDescribed;
4446 }
4447