[codeview] Put !heapallocsite on calls to operator new
[lldb.git] / clang / lib / CodeGen / CGDebugInfo.cpp
1 //===--- CGDebugInfo.cpp - Emit Debug Information for a Module ------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This coordinates the debug information generation while generating code.
10 //
11 //===----------------------------------------------------------------------===//
12
13 #include "CGDebugInfo.h"
14 #include "CGBlocks.h"
15 #include "CGCXXABI.h"
16 #include "CGObjCRuntime.h"
17 #include "CGRecordLayout.h"
18 #include "CodeGenFunction.h"
19 #include "CodeGenModule.h"
20 #include "ConstantEmitter.h"
21 #include "clang/AST/ASTContext.h"
22 #include "clang/AST/Attr.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/CodeGenOptions.h"
29 #include "clang/Basic/FileManager.h"
30 #include "clang/Basic/SourceManager.h"
31 #include "clang/Basic/Version.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 #include "llvm/Support/TimeProfiler.h"
50 using namespace clang;
51 using namespace clang::CodeGen;
52
53 static uint32_t getTypeAlignIfRequired(const Type *Ty, const ASTContext &Ctx) {
54   auto TI = Ctx.getTypeInfo(Ty);
55   return TI.AlignIsRequired ? TI.Align : 0;
56 }
57
58 static uint32_t getTypeAlignIfRequired(QualType Ty, const ASTContext &Ctx) {
59   return getTypeAlignIfRequired(Ty.getTypePtr(), Ctx);
60 }
61
62 static uint32_t getDeclAlignIfRequired(const Decl *D, const ASTContext &Ctx) {
63   return D->hasAttr<AlignedAttr>() ? D->getMaxAlignment() : 0;
64 }
65
66 CGDebugInfo::CGDebugInfo(CodeGenModule &CGM)
67     : CGM(CGM), DebugKind(CGM.getCodeGenOpts().getDebugInfo()),
68       DebugTypeExtRefs(CGM.getCodeGenOpts().DebugTypeExtRefs),
69       DBuilder(CGM.getModule()) {
70   for (const auto &KV : CGM.getCodeGenOpts().DebugPrefixMap)
71     DebugPrefixMap[KV.first] = KV.second;
72   CreateCompileUnit();
73 }
74
75 CGDebugInfo::~CGDebugInfo() {
76   assert(LexicalBlockStack.empty() &&
77          "Region stack mismatch, stack not empty!");
78 }
79
80 ApplyDebugLocation::ApplyDebugLocation(CodeGenFunction &CGF,
81                                        SourceLocation TemporaryLocation)
82     : CGF(&CGF) {
83   init(TemporaryLocation);
84 }
85
86 ApplyDebugLocation::ApplyDebugLocation(CodeGenFunction &CGF,
87                                        bool DefaultToEmpty,
88                                        SourceLocation TemporaryLocation)
89     : CGF(&CGF) {
90   init(TemporaryLocation, DefaultToEmpty);
91 }
92
93 void ApplyDebugLocation::init(SourceLocation TemporaryLocation,
94                               bool DefaultToEmpty) {
95   auto *DI = CGF->getDebugInfo();
96   if (!DI) {
97     CGF = nullptr;
98     return;
99   }
100
101   OriginalLocation = CGF->Builder.getCurrentDebugLocation();
102
103   if (OriginalLocation && !DI->CGM.getExpressionLocationsEnabled())
104     return;
105
106   if (TemporaryLocation.isValid()) {
107     DI->EmitLocation(CGF->Builder, TemporaryLocation);
108     return;
109   }
110
111   if (DefaultToEmpty) {
112     CGF->Builder.SetCurrentDebugLocation(llvm::DebugLoc());
113     return;
114   }
115
116   // Construct a location that has a valid scope, but no line info.
117   assert(!DI->LexicalBlockStack.empty());
118   CGF->Builder.SetCurrentDebugLocation(llvm::DebugLoc::get(
119       0, 0, DI->LexicalBlockStack.back(), DI->getInlinedAt()));
120 }
121
122 ApplyDebugLocation::ApplyDebugLocation(CodeGenFunction &CGF, const Expr *E)
123     : CGF(&CGF) {
124   init(E->getExprLoc());
125 }
126
127 ApplyDebugLocation::ApplyDebugLocation(CodeGenFunction &CGF, llvm::DebugLoc Loc)
128     : CGF(&CGF) {
129   if (!CGF.getDebugInfo()) {
130     this->CGF = nullptr;
131     return;
132   }
133   OriginalLocation = CGF.Builder.getCurrentDebugLocation();
134   if (Loc)
135     CGF.Builder.SetCurrentDebugLocation(std::move(Loc));
136 }
137
138 ApplyDebugLocation::~ApplyDebugLocation() {
139   // Query CGF so the location isn't overwritten when location updates are
140   // temporarily disabled (for C++ default function arguments)
141   if (CGF)
142     CGF->Builder.SetCurrentDebugLocation(std::move(OriginalLocation));
143 }
144
145 ApplyInlineDebugLocation::ApplyInlineDebugLocation(CodeGenFunction &CGF,
146                                                    GlobalDecl InlinedFn)
147     : CGF(&CGF) {
148   if (!CGF.getDebugInfo()) {
149     this->CGF = nullptr;
150     return;
151   }
152   auto &DI = *CGF.getDebugInfo();
153   SavedLocation = DI.getLocation();
154   assert((DI.getInlinedAt() ==
155           CGF.Builder.getCurrentDebugLocation()->getInlinedAt()) &&
156          "CGDebugInfo and IRBuilder are out of sync");
157
158   DI.EmitInlineFunctionStart(CGF.Builder, InlinedFn);
159 }
160
161 ApplyInlineDebugLocation::~ApplyInlineDebugLocation() {
162   if (!CGF)
163     return;
164   auto &DI = *CGF->getDebugInfo();
165   DI.EmitInlineFunctionEnd(CGF->Builder);
166   DI.EmitLocation(CGF->Builder, SavedLocation);
167 }
168
169 void CGDebugInfo::setLocation(SourceLocation Loc) {
170   // If the new location isn't valid return.
171   if (Loc.isInvalid())
172     return;
173
174   CurLoc = CGM.getContext().getSourceManager().getExpansionLoc(Loc);
175
176   // If we've changed files in the middle of a lexical scope go ahead
177   // and create a new lexical scope with file node if it's different
178   // from the one in the scope.
179   if (LexicalBlockStack.empty())
180     return;
181
182   SourceManager &SM = CGM.getContext().getSourceManager();
183   auto *Scope = cast<llvm::DIScope>(LexicalBlockStack.back());
184   PresumedLoc PCLoc = SM.getPresumedLoc(CurLoc);
185   if (PCLoc.isInvalid() || Scope->getFile() == getOrCreateFile(CurLoc))
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                              TheCU->getFile());
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, but we must have spaces between consecutive
235   // angle brackets that close nested template argument lists.
236   if (CGM.getCodeGenOpts().EmitCodeView) {
237     PP.MSVCFormatting = true;
238     PP.SplitTemplateClosers = true;
239   } else {
240     // For DWARF, printing rules are underspecified.
241     // SplitTemplateClosers yields better interop with GCC and GDB (PR46052).
242     PP.SplitTemplateClosers = true;
243   }
244
245   // Apply -fdebug-prefix-map.
246   PP.Callbacks = &PrintCB;
247   return PP;
248 }
249
250 StringRef CGDebugInfo::getFunctionName(const FunctionDecl *FD) {
251   assert(FD && "Invalid FunctionDecl!");
252   IdentifierInfo *FII = FD->getIdentifier();
253   FunctionTemplateSpecializationInfo *Info =
254       FD->getTemplateSpecializationInfo();
255
256   // Emit the unqualified name in normal operation. LLVM and the debugger can
257   // compute the fully qualified name from the scope chain. If we're only
258   // emitting line table info, there won't be any scope chains, so emit the
259   // fully qualified name here so that stack traces are more accurate.
260   // FIXME: Do this when emitting DWARF as well as when emitting CodeView after
261   // evaluating the size impact.
262   bool UseQualifiedName = DebugKind == codegenoptions::DebugLineTablesOnly &&
263                           CGM.getCodeGenOpts().EmitCodeView;
264
265   if (!Info && FII && !UseQualifiedName)
266     return FII->getName();
267
268   SmallString<128> NS;
269   llvm::raw_svector_ostream OS(NS);
270   if (!UseQualifiedName)
271     FD->printName(OS);
272   else
273     FD->printQualifiedName(OS, getPrintingPolicy());
274
275   // Add any template specialization args.
276   if (Info) {
277     const TemplateArgumentList *TArgs = Info->TemplateArguments;
278     printTemplateArgumentList(OS, TArgs->asArray(), getPrintingPolicy());
279   }
280
281   // Copy this name on the side and use its reference.
282   return internString(OS.str());
283 }
284
285 StringRef CGDebugInfo::getObjCMethodName(const ObjCMethodDecl *OMD) {
286   SmallString<256> MethodName;
287   llvm::raw_svector_ostream OS(MethodName);
288   OS << (OMD->isInstanceMethod() ? '-' : '+') << '[';
289   const DeclContext *DC = OMD->getDeclContext();
290   if (const auto *OID = dyn_cast<ObjCImplementationDecl>(DC)) {
291     OS << OID->getName();
292   } else if (const auto *OID = dyn_cast<ObjCInterfaceDecl>(DC)) {
293     OS << OID->getName();
294   } else if (const auto *OC = dyn_cast<ObjCCategoryDecl>(DC)) {
295     if (OC->IsClassExtension()) {
296       OS << OC->getClassInterface()->getName();
297     } else {
298       OS << OC->getIdentifier()->getNameStart() << '('
299          << OC->getIdentifier()->getNameStart() << ')';
300     }
301   } else if (const auto *OCD = dyn_cast<ObjCCategoryImplDecl>(DC)) {
302     OS << OCD->getClassInterface()->getName() << '(' << OCD->getName() << ')';
303   }
304   OS << ' ' << OMD->getSelector().getAsString() << ']';
305
306   return internString(OS.str());
307 }
308
309 StringRef CGDebugInfo::getSelectorName(Selector S) {
310   return internString(S.getAsString());
311 }
312
313 StringRef CGDebugInfo::getClassName(const RecordDecl *RD) {
314   if (isa<ClassTemplateSpecializationDecl>(RD)) {
315     SmallString<128> Name;
316     llvm::raw_svector_ostream OS(Name);
317     PrintingPolicy PP = getPrintingPolicy();
318     PP.PrintCanonicalTypes = true;
319     RD->getNameForDiagnostic(OS, PP,
320                              /*Qualified*/ false);
321
322     // Copy this name on the side and use its reference.
323     return internString(Name);
324   }
325
326   // quick optimization to avoid having to intern strings that are already
327   // stored reliably elsewhere
328   if (const IdentifierInfo *II = RD->getIdentifier())
329     return II->getName();
330
331   // The CodeView printer in LLVM wants to see the names of unnamed types: it is
332   // used to reconstruct the fully qualified type names.
333   if (CGM.getCodeGenOpts().EmitCodeView) {
334     if (const TypedefNameDecl *D = RD->getTypedefNameForAnonDecl()) {
335       assert(RD->getDeclContext() == D->getDeclContext() &&
336              "Typedef should not be in another decl context!");
337       assert(D->getDeclName().getAsIdentifierInfo() &&
338              "Typedef was not named!");
339       return D->getDeclName().getAsIdentifierInfo()->getName();
340     }
341
342     if (CGM.getLangOpts().CPlusPlus) {
343       StringRef Name;
344
345       ASTContext &Context = CGM.getContext();
346       if (const DeclaratorDecl *DD = Context.getDeclaratorForUnnamedTagDecl(RD))
347         // Anonymous types without a name for linkage purposes have their
348         // declarator mangled in if they have one.
349         Name = DD->getName();
350       else if (const TypedefNameDecl *TND =
351                    Context.getTypedefNameForUnnamedTagDecl(RD))
352         // Anonymous types without a name for linkage purposes have their
353         // associate typedef mangled in if they have one.
354         Name = TND->getName();
355
356       if (!Name.empty()) {
357         SmallString<256> UnnamedType("<unnamed-type-");
358         UnnamedType += Name;
359         UnnamedType += '>';
360         return internString(UnnamedType);
361       }
362     }
363   }
364
365   return StringRef();
366 }
367
368 Optional<llvm::DIFile::ChecksumKind>
369 CGDebugInfo::computeChecksum(FileID FID, SmallString<32> &Checksum) const {
370   Checksum.clear();
371
372   if (!CGM.getCodeGenOpts().EmitCodeView &&
373       CGM.getCodeGenOpts().DwarfVersion < 5)
374     return None;
375
376   SourceManager &SM = CGM.getContext().getSourceManager();
377   bool Invalid;
378   const llvm::MemoryBuffer *MemBuffer = SM.getBuffer(FID, &Invalid);
379   if (Invalid)
380     return None;
381
382   llvm::MD5 Hash;
383   llvm::MD5::MD5Result Result;
384
385   Hash.update(MemBuffer->getBuffer());
386   Hash.final(Result);
387
388   Hash.stringifyResult(Result, Checksum);
389   return llvm::DIFile::CSK_MD5;
390 }
391
392 Optional<StringRef> CGDebugInfo::getSource(const SourceManager &SM,
393                                            FileID FID) {
394   if (!CGM.getCodeGenOpts().EmbedSource)
395     return None;
396
397   bool SourceInvalid = false;
398   StringRef Source = SM.getBufferData(FID, &SourceInvalid);
399
400   if (SourceInvalid)
401     return None;
402
403   return Source;
404 }
405
406 llvm::DIFile *CGDebugInfo::getOrCreateFile(SourceLocation Loc) {
407   if (!Loc.isValid())
408     // If Location is not valid then use main input file.
409     return TheCU->getFile();
410
411   SourceManager &SM = CGM.getContext().getSourceManager();
412   PresumedLoc PLoc = SM.getPresumedLoc(Loc);
413
414   StringRef FileName = PLoc.getFilename();
415   if (PLoc.isInvalid() || FileName.empty())
416     // If the location is not valid then use main input file.
417     return TheCU->getFile();
418
419   // Cache the results.
420   auto It = DIFileCache.find(FileName.data());
421   if (It != DIFileCache.end()) {
422     // Verify that the information still exists.
423     if (llvm::Metadata *V = It->second)
424       return cast<llvm::DIFile>(V);
425   }
426
427   SmallString<32> Checksum;
428
429   // Compute the checksum if possible. If the location is affected by a #line
430   // directive that refers to a file, PLoc will have an invalid FileID, and we
431   // will correctly get no checksum.
432   Optional<llvm::DIFile::ChecksumKind> CSKind =
433       computeChecksum(PLoc.getFileID(), Checksum);
434   Optional<llvm::DIFile::ChecksumInfo<StringRef>> CSInfo;
435   if (CSKind)
436     CSInfo.emplace(*CSKind, Checksum);
437   return createFile(FileName, CSInfo, getSource(SM, SM.getFileID(Loc)));
438 }
439
440 llvm::DIFile *
441 CGDebugInfo::createFile(StringRef FileName,
442                         Optional<llvm::DIFile::ChecksumInfo<StringRef>> CSInfo,
443                         Optional<StringRef> Source) {
444   StringRef Dir;
445   StringRef File;
446   std::string RemappedFile = remapDIPath(FileName);
447   std::string CurDir = remapDIPath(getCurrentDirname());
448   SmallString<128> DirBuf;
449   SmallString<128> FileBuf;
450   if (llvm::sys::path::is_absolute(RemappedFile)) {
451     // Strip the common prefix (if it is more than just "/") from current
452     // directory and FileName for a more space-efficient encoding.
453     auto FileIt = llvm::sys::path::begin(RemappedFile);
454     auto FileE = llvm::sys::path::end(RemappedFile);
455     auto CurDirIt = llvm::sys::path::begin(CurDir);
456     auto CurDirE = llvm::sys::path::end(CurDir);
457     for (; CurDirIt != CurDirE && *CurDirIt == *FileIt; ++CurDirIt, ++FileIt)
458       llvm::sys::path::append(DirBuf, *CurDirIt);
459     if (std::distance(llvm::sys::path::begin(CurDir), CurDirIt) == 1) {
460       // Don't strip the common prefix if it is only the root "/"
461       // since that would make LLVM diagnostic locations confusing.
462       Dir = {};
463       File = RemappedFile;
464     } else {
465       for (; FileIt != FileE; ++FileIt)
466         llvm::sys::path::append(FileBuf, *FileIt);
467       Dir = DirBuf;
468       File = FileBuf;
469     }
470   } else {
471     Dir = CurDir;
472     File = RemappedFile;
473   }
474   llvm::DIFile *F = DBuilder.createFile(File, Dir, CSInfo, Source);
475   DIFileCache[FileName.data()].reset(F);
476   return F;
477 }
478
479 std::string CGDebugInfo::remapDIPath(StringRef Path) const {
480   if (DebugPrefixMap.empty())
481     return Path.str();
482
483   SmallString<256> P = Path;
484   for (const auto &Entry : DebugPrefixMap)
485     if (llvm::sys::path::replace_path_prefix(P, Entry.first, Entry.second))
486       break;
487   return P.str().str();
488 }
489
490 unsigned CGDebugInfo::getLineNumber(SourceLocation Loc) {
491   if (Loc.isInvalid() && CurLoc.isInvalid())
492     return 0;
493   SourceManager &SM = CGM.getContext().getSourceManager();
494   PresumedLoc PLoc = SM.getPresumedLoc(Loc.isValid() ? Loc : CurLoc);
495   return PLoc.isValid() ? PLoc.getLine() : 0;
496 }
497
498 unsigned CGDebugInfo::getColumnNumber(SourceLocation Loc, bool Force) {
499   // We may not want column information at all.
500   if (!Force && !CGM.getCodeGenOpts().DebugColumnInfo)
501     return 0;
502
503   // If the location is invalid then use the current column.
504   if (Loc.isInvalid() && CurLoc.isInvalid())
505     return 0;
506   SourceManager &SM = CGM.getContext().getSourceManager();
507   PresumedLoc PLoc = SM.getPresumedLoc(Loc.isValid() ? Loc : CurLoc);
508   return PLoc.isValid() ? PLoc.getColumn() : 0;
509 }
510
511 StringRef CGDebugInfo::getCurrentDirname() {
512   if (!CGM.getCodeGenOpts().DebugCompilationDir.empty())
513     return CGM.getCodeGenOpts().DebugCompilationDir;
514
515   if (!CWDName.empty())
516     return CWDName;
517   SmallString<256> CWD;
518   llvm::sys::fs::current_path(CWD);
519   return CWDName = internString(CWD);
520 }
521
522 void CGDebugInfo::CreateCompileUnit() {
523   SmallString<32> Checksum;
524   Optional<llvm::DIFile::ChecksumKind> CSKind;
525   Optional<llvm::DIFile::ChecksumInfo<StringRef>> CSInfo;
526
527   // Should we be asking the SourceManager for the main file name, instead of
528   // accepting it as an argument? This just causes the main file name to
529   // mismatch with source locations and create extra lexical scopes or
530   // mismatched debug info (a CU with a DW_AT_file of "-", because that's what
531   // the driver passed, but functions/other things have DW_AT_file of "<stdin>"
532   // because that's what the SourceManager says)
533
534   // Get absolute path name.
535   SourceManager &SM = CGM.getContext().getSourceManager();
536   std::string MainFileName = CGM.getCodeGenOpts().MainFileName;
537   if (MainFileName.empty())
538     MainFileName = "<stdin>";
539
540   // The main file name provided via the "-main-file-name" option contains just
541   // the file name itself with no path information. This file name may have had
542   // a relative path, so we look into the actual file entry for the main
543   // file to determine the real absolute path for the file.
544   std::string MainFileDir;
545   if (const FileEntry *MainFile = SM.getFileEntryForID(SM.getMainFileID())) {
546     MainFileDir = std::string(MainFile->getDir()->getName());
547     if (!llvm::sys::path::is_absolute(MainFileName)) {
548       llvm::SmallString<1024> MainFileDirSS(MainFileDir);
549       llvm::sys::path::append(MainFileDirSS, MainFileName);
550       MainFileName =
551           std::string(llvm::sys::path::remove_leading_dotslash(MainFileDirSS));
552     }
553     // If the main file name provided is identical to the input file name, and
554     // if the input file is a preprocessed source, use the module name for
555     // debug info. The module name comes from the name specified in the first
556     // linemarker if the input is a preprocessed source.
557     if (MainFile->getName() == MainFileName &&
558         FrontendOptions::getInputKindForExtension(
559             MainFile->getName().rsplit('.').second)
560             .isPreprocessed())
561       MainFileName = CGM.getModule().getName().str();
562
563     CSKind = computeChecksum(SM.getMainFileID(), Checksum);
564   }
565
566   llvm::dwarf::SourceLanguage LangTag;
567   const LangOptions &LO = CGM.getLangOpts();
568   if (LO.CPlusPlus) {
569     if (LO.ObjC)
570       LangTag = llvm::dwarf::DW_LANG_ObjC_plus_plus;
571     else if (LO.CPlusPlus14)
572       LangTag = llvm::dwarf::DW_LANG_C_plus_plus_14;
573     else if (LO.CPlusPlus11)
574       LangTag = llvm::dwarf::DW_LANG_C_plus_plus_11;
575     else
576       LangTag = llvm::dwarf::DW_LANG_C_plus_plus;
577   } else if (LO.ObjC) {
578     LangTag = llvm::dwarf::DW_LANG_ObjC;
579   } else if (LO.RenderScript) {
580     LangTag = llvm::dwarf::DW_LANG_GOOGLE_RenderScript;
581   } else if (LO.C99) {
582     LangTag = llvm::dwarf::DW_LANG_C99;
583   } else {
584     LangTag = llvm::dwarf::DW_LANG_C89;
585   }
586
587   std::string Producer = getClangFullVersion();
588
589   // Figure out which version of the ObjC runtime we have.
590   unsigned RuntimeVers = 0;
591   if (LO.ObjC)
592     RuntimeVers = LO.ObjCRuntime.isNonFragile() ? 2 : 1;
593
594   llvm::DICompileUnit::DebugEmissionKind EmissionKind;
595   switch (DebugKind) {
596   case codegenoptions::NoDebugInfo:
597   case codegenoptions::LocTrackingOnly:
598     EmissionKind = llvm::DICompileUnit::NoDebug;
599     break;
600   case codegenoptions::DebugLineTablesOnly:
601     EmissionKind = llvm::DICompileUnit::LineTablesOnly;
602     break;
603   case codegenoptions::DebugDirectivesOnly:
604     EmissionKind = llvm::DICompileUnit::DebugDirectivesOnly;
605     break;
606   case codegenoptions::DebugInfoConstructor:
607   case codegenoptions::LimitedDebugInfo:
608   case codegenoptions::FullDebugInfo:
609     EmissionKind = llvm::DICompileUnit::FullDebug;
610     break;
611   }
612
613   uint64_t DwoId = 0;
614   auto &CGOpts = CGM.getCodeGenOpts();
615   // The DIFile used by the CU is distinct from the main source
616   // file. Its directory part specifies what becomes the
617   // DW_AT_comp_dir (the compilation directory), even if the source
618   // file was specified with an absolute path.
619   if (CSKind)
620     CSInfo.emplace(*CSKind, Checksum);
621   llvm::DIFile *CUFile = DBuilder.createFile(
622       remapDIPath(MainFileName), remapDIPath(getCurrentDirname()), CSInfo,
623       getSource(SM, SM.getMainFileID()));
624
625   StringRef Sysroot, SDK;
626   if (CGM.getCodeGenOpts().getDebuggerTuning() == llvm::DebuggerKind::LLDB) {
627     Sysroot = CGM.getHeaderSearchOpts().Sysroot;
628     auto B = llvm::sys::path::rbegin(Sysroot);
629     auto E = llvm::sys::path::rend(Sysroot);
630     auto It = std::find_if(B, E, [](auto SDK) { return SDK.endswith(".sdk"); });
631     if (It != E)
632       SDK = *It;
633   }
634
635   // Create new compile unit.
636   TheCU = DBuilder.createCompileUnit(
637       LangTag, CUFile, CGOpts.EmitVersionIdentMetadata ? Producer : "",
638       LO.Optimize || CGOpts.PrepareForLTO || CGOpts.PrepareForThinLTO,
639       CGOpts.DwarfDebugFlags, RuntimeVers, CGOpts.SplitDwarfFile, EmissionKind,
640       DwoId, CGOpts.SplitDwarfInlining, CGOpts.DebugInfoForProfiling,
641       CGM.getTarget().getTriple().isNVPTX()
642           ? llvm::DICompileUnit::DebugNameTableKind::None
643           : static_cast<llvm::DICompileUnit::DebugNameTableKind>(
644                 CGOpts.DebugNameTable),
645       CGOpts.DebugRangesBaseAddress, remapDIPath(Sysroot), SDK);
646 }
647
648 llvm::DIType *CGDebugInfo::CreateType(const BuiltinType *BT) {
649   llvm::dwarf::TypeKind Encoding;
650   StringRef BTName;
651   switch (BT->getKind()) {
652 #define BUILTIN_TYPE(Id, SingletonId)
653 #define PLACEHOLDER_TYPE(Id, SingletonId) case BuiltinType::Id:
654 #include "clang/AST/BuiltinTypes.def"
655   case BuiltinType::Dependent:
656     llvm_unreachable("Unexpected builtin type");
657   case BuiltinType::NullPtr:
658     return DBuilder.createNullPtrType();
659   case BuiltinType::Void:
660     return nullptr;
661   case BuiltinType::ObjCClass:
662     if (!ClassTy)
663       ClassTy =
664           DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
665                                      "objc_class", TheCU, TheCU->getFile(), 0);
666     return ClassTy;
667   case BuiltinType::ObjCId: {
668     // typedef struct objc_class *Class;
669     // typedef struct objc_object {
670     //  Class isa;
671     // } *id;
672
673     if (ObjTy)
674       return ObjTy;
675
676     if (!ClassTy)
677       ClassTy =
678           DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
679                                      "objc_class", TheCU, TheCU->getFile(), 0);
680
681     unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
682
683     auto *ISATy = DBuilder.createPointerType(ClassTy, Size);
684
685     ObjTy = DBuilder.createStructType(TheCU, "objc_object", TheCU->getFile(), 0,
686                                       0, 0, llvm::DINode::FlagZero, nullptr,
687                                       llvm::DINodeArray());
688
689     DBuilder.replaceArrays(
690         ObjTy, DBuilder.getOrCreateArray(&*DBuilder.createMemberType(
691                    ObjTy, "isa", TheCU->getFile(), 0, Size, 0, 0,
692                    llvm::DINode::FlagZero, ISATy)));
693     return ObjTy;
694   }
695   case BuiltinType::ObjCSel: {
696     if (!SelTy)
697       SelTy = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
698                                          "objc_selector", TheCU,
699                                          TheCU->getFile(), 0);
700     return SelTy;
701   }
702
703 #define IMAGE_TYPE(ImgType, Id, SingletonId, Access, Suffix)                   \
704   case BuiltinType::Id:                                                        \
705     return getOrCreateStructPtrType("opencl_" #ImgType "_" #Suffix "_t",       \
706                                     SingletonId);
707 #include "clang/Basic/OpenCLImageTypes.def"
708   case BuiltinType::OCLSampler:
709     return getOrCreateStructPtrType("opencl_sampler_t", OCLSamplerDITy);
710   case BuiltinType::OCLEvent:
711     return getOrCreateStructPtrType("opencl_event_t", OCLEventDITy);
712   case BuiltinType::OCLClkEvent:
713     return getOrCreateStructPtrType("opencl_clk_event_t", OCLClkEventDITy);
714   case BuiltinType::OCLQueue:
715     return getOrCreateStructPtrType("opencl_queue_t", OCLQueueDITy);
716   case BuiltinType::OCLReserveID:
717     return getOrCreateStructPtrType("opencl_reserve_id_t", OCLReserveIDDITy);
718 #define EXT_OPAQUE_TYPE(ExtType, Id, Ext) \
719   case BuiltinType::Id: \
720     return getOrCreateStructPtrType("opencl_" #ExtType, Id##Ty);
721 #include "clang/Basic/OpenCLExtensionTypes.def"
722   // TODO: real support for SVE types requires more infrastructure
723   // to be added first.  The types have a variable length and are
724   // represented in debug info as types whose length depends on a
725   // target-specific pseudo register.
726 #define SVE_TYPE(Name, Id, SingletonId) \
727   case BuiltinType::Id:
728 #include "clang/Basic/AArch64SVEACLETypes.def"
729   {
730     unsigned DiagID = CGM.getDiags().getCustomDiagID(
731         DiagnosticsEngine::Error,
732         "cannot yet generate debug info for SVE type '%0'");
733     auto Name = BT->getName(CGM.getContext().getPrintingPolicy());
734     CGM.getDiags().Report(DiagID) << Name;
735     // Return something safe.
736     return CreateType(cast<const BuiltinType>(CGM.getContext().IntTy));
737   }
738
739   case BuiltinType::UChar:
740   case BuiltinType::Char_U:
741     Encoding = llvm::dwarf::DW_ATE_unsigned_char;
742     break;
743   case BuiltinType::Char_S:
744   case BuiltinType::SChar:
745     Encoding = llvm::dwarf::DW_ATE_signed_char;
746     break;
747   case BuiltinType::Char8:
748   case BuiltinType::Char16:
749   case BuiltinType::Char32:
750     Encoding = llvm::dwarf::DW_ATE_UTF;
751     break;
752   case BuiltinType::UShort:
753   case BuiltinType::UInt:
754   case BuiltinType::UInt128:
755   case BuiltinType::ULong:
756   case BuiltinType::WChar_U:
757   case BuiltinType::ULongLong:
758     Encoding = llvm::dwarf::DW_ATE_unsigned;
759     break;
760   case BuiltinType::Short:
761   case BuiltinType::Int:
762   case BuiltinType::Int128:
763   case BuiltinType::Long:
764   case BuiltinType::WChar_S:
765   case BuiltinType::LongLong:
766     Encoding = llvm::dwarf::DW_ATE_signed;
767     break;
768   case BuiltinType::Bool:
769     Encoding = llvm::dwarf::DW_ATE_boolean;
770     break;
771   case BuiltinType::Half:
772   case BuiltinType::Float:
773   case BuiltinType::LongDouble:
774   case BuiltinType::Float16:
775   case BuiltinType::BFloat16:
776   case BuiltinType::Float128:
777   case BuiltinType::Double:
778     // FIXME: For targets where long double and __float128 have the same size,
779     // they are currently indistinguishable in the debugger without some
780     // special treatment. However, there is currently no consensus on encoding
781     // and this should be updated once a DWARF encoding exists for distinct
782     // floating point types of the same size.
783     Encoding = llvm::dwarf::DW_ATE_float;
784     break;
785   case BuiltinType::ShortAccum:
786   case BuiltinType::Accum:
787   case BuiltinType::LongAccum:
788   case BuiltinType::ShortFract:
789   case BuiltinType::Fract:
790   case BuiltinType::LongFract:
791   case BuiltinType::SatShortFract:
792   case BuiltinType::SatFract:
793   case BuiltinType::SatLongFract:
794   case BuiltinType::SatShortAccum:
795   case BuiltinType::SatAccum:
796   case BuiltinType::SatLongAccum:
797     Encoding = llvm::dwarf::DW_ATE_signed_fixed;
798     break;
799   case BuiltinType::UShortAccum:
800   case BuiltinType::UAccum:
801   case BuiltinType::ULongAccum:
802   case BuiltinType::UShortFract:
803   case BuiltinType::UFract:
804   case BuiltinType::ULongFract:
805   case BuiltinType::SatUShortAccum:
806   case BuiltinType::SatUAccum:
807   case BuiltinType::SatULongAccum:
808   case BuiltinType::SatUShortFract:
809   case BuiltinType::SatUFract:
810   case BuiltinType::SatULongFract:
811     Encoding = llvm::dwarf::DW_ATE_unsigned_fixed;
812     break;
813   }
814
815   switch (BT->getKind()) {
816   case BuiltinType::Long:
817     BTName = "long int";
818     break;
819   case BuiltinType::LongLong:
820     BTName = "long long int";
821     break;
822   case BuiltinType::ULong:
823     BTName = "long unsigned int";
824     break;
825   case BuiltinType::ULongLong:
826     BTName = "long long unsigned int";
827     break;
828   default:
829     BTName = BT->getName(CGM.getLangOpts());
830     break;
831   }
832   // Bit size and offset of the type.
833   uint64_t Size = CGM.getContext().getTypeSize(BT);
834   return DBuilder.createBasicType(BTName, Size, Encoding);
835 }
836
837 llvm::DIType *CGDebugInfo::CreateType(const AutoType *Ty) {
838   return DBuilder.createUnspecifiedType("auto");
839 }
840
841 llvm::DIType *CGDebugInfo::CreateType(const ExtIntType *Ty) {
842
843   StringRef Name = Ty->isUnsigned() ? "unsigned _ExtInt" : "_ExtInt";
844   llvm::dwarf::TypeKind Encoding = Ty->isUnsigned()
845                                        ? llvm::dwarf::DW_ATE_unsigned
846                                        : llvm::dwarf::DW_ATE_signed;
847
848   return DBuilder.createBasicType(Name, CGM.getContext().getTypeSize(Ty),
849                                   Encoding);
850 }
851
852 llvm::DIType *CGDebugInfo::CreateType(const ComplexType *Ty) {
853   // Bit size and offset of the type.
854   llvm::dwarf::TypeKind Encoding = llvm::dwarf::DW_ATE_complex_float;
855   if (Ty->isComplexIntegerType())
856     Encoding = llvm::dwarf::DW_ATE_lo_user;
857
858   uint64_t Size = CGM.getContext().getTypeSize(Ty);
859   return DBuilder.createBasicType("complex", Size, Encoding);
860 }
861
862 llvm::DIType *CGDebugInfo::CreateQualifiedType(QualType Ty,
863                                                llvm::DIFile *Unit) {
864   QualifierCollector Qc;
865   const Type *T = Qc.strip(Ty);
866
867   // Ignore these qualifiers for now.
868   Qc.removeObjCGCAttr();
869   Qc.removeAddressSpace();
870   Qc.removeObjCLifetime();
871
872   // We will create one Derived type for one qualifier and recurse to handle any
873   // additional ones.
874   llvm::dwarf::Tag Tag;
875   if (Qc.hasConst()) {
876     Tag = llvm::dwarf::DW_TAG_const_type;
877     Qc.removeConst();
878   } else if (Qc.hasVolatile()) {
879     Tag = llvm::dwarf::DW_TAG_volatile_type;
880     Qc.removeVolatile();
881   } else if (Qc.hasRestrict()) {
882     Tag = llvm::dwarf::DW_TAG_restrict_type;
883     Qc.removeRestrict();
884   } else {
885     assert(Qc.empty() && "Unknown type qualifier for debug info");
886     return getOrCreateType(QualType(T, 0), Unit);
887   }
888
889   auto *FromTy = getOrCreateType(Qc.apply(CGM.getContext(), T), Unit);
890
891   // No need to fill in the Name, Line, Size, Alignment, Offset in case of
892   // CVR derived types.
893   return DBuilder.createQualifiedType(Tag, FromTy);
894 }
895
896 llvm::DIType *CGDebugInfo::CreateType(const ObjCObjectPointerType *Ty,
897                                       llvm::DIFile *Unit) {
898
899   // The frontend treats 'id' as a typedef to an ObjCObjectType,
900   // whereas 'id<protocol>' is treated as an ObjCPointerType. For the
901   // debug info, we want to emit 'id' in both cases.
902   if (Ty->isObjCQualifiedIdType())
903     return getOrCreateType(CGM.getContext().getObjCIdType(), Unit);
904
905   return CreatePointerLikeType(llvm::dwarf::DW_TAG_pointer_type, Ty,
906                                Ty->getPointeeType(), Unit);
907 }
908
909 llvm::DIType *CGDebugInfo::CreateType(const PointerType *Ty,
910                                       llvm::DIFile *Unit) {
911   return CreatePointerLikeType(llvm::dwarf::DW_TAG_pointer_type, Ty,
912                                Ty->getPointeeType(), Unit);
913 }
914
915 /// \return whether a C++ mangling exists for the type defined by TD.
916 static bool hasCXXMangling(const TagDecl *TD, llvm::DICompileUnit *TheCU) {
917   switch (TheCU->getSourceLanguage()) {
918   case llvm::dwarf::DW_LANG_C_plus_plus:
919   case llvm::dwarf::DW_LANG_C_plus_plus_11:
920   case llvm::dwarf::DW_LANG_C_plus_plus_14:
921     return true;
922   case llvm::dwarf::DW_LANG_ObjC_plus_plus:
923     return isa<CXXRecordDecl>(TD) || isa<EnumDecl>(TD);
924   default:
925     return false;
926   }
927 }
928
929 // Determines if the debug info for this tag declaration needs a type
930 // identifier. The purpose of the unique identifier is to deduplicate type
931 // information for identical types across TUs. Because of the C++ one definition
932 // rule (ODR), it is valid to assume that the type is defined the same way in
933 // every TU and its debug info is equivalent.
934 //
935 // C does not have the ODR, and it is common for codebases to contain multiple
936 // different definitions of a struct with the same name in different TUs.
937 // Therefore, if the type doesn't have a C++ mangling, don't give it an
938 // identifer. Type information in C is smaller and simpler than C++ type
939 // information, so the increase in debug info size is negligible.
940 //
941 // If the type is not externally visible, it should be unique to the current TU,
942 // and should not need an identifier to participate in type deduplication.
943 // However, when emitting CodeView, the format internally uses these
944 // unique type name identifers for references between debug info. For example,
945 // the method of a class in an anonymous namespace uses the identifer to refer
946 // to its parent class. The Microsoft C++ ABI attempts to provide unique names
947 // for such types, so when emitting CodeView, always use identifiers for C++
948 // types. This may create problems when attempting to emit CodeView when the MS
949 // C++ ABI is not in use.
950 static bool needsTypeIdentifier(const TagDecl *TD, CodeGenModule &CGM,
951                                 llvm::DICompileUnit *TheCU) {
952   // We only add a type identifier for types with C++ name mangling.
953   if (!hasCXXMangling(TD, TheCU))
954     return false;
955
956   // Externally visible types with C++ mangling need a type identifier.
957   if (TD->isExternallyVisible())
958     return true;
959
960   // CodeView types with C++ mangling need a type identifier.
961   if (CGM.getCodeGenOpts().EmitCodeView)
962     return true;
963
964   return false;
965 }
966
967 // Returns a unique type identifier string if one exists, or an empty string.
968 static SmallString<256> getTypeIdentifier(const TagType *Ty, CodeGenModule &CGM,
969                                           llvm::DICompileUnit *TheCU) {
970   SmallString<256> Identifier;
971   const TagDecl *TD = Ty->getDecl();
972
973   if (!needsTypeIdentifier(TD, CGM, TheCU))
974     return Identifier;
975   if (const auto *RD = dyn_cast<CXXRecordDecl>(TD))
976     if (RD->getDefinition())
977       if (RD->isDynamicClass() &&
978           CGM.getVTableLinkage(RD) == llvm::GlobalValue::ExternalLinkage)
979         return Identifier;
980
981   // TODO: This is using the RTTI name. Is there a better way to get
982   // a unique string for a type?
983   llvm::raw_svector_ostream Out(Identifier);
984   CGM.getCXXABI().getMangleContext().mangleCXXRTTIName(QualType(Ty, 0), Out);
985   return Identifier;
986 }
987
988 /// \return the appropriate DWARF tag for a composite type.
989 static llvm::dwarf::Tag getTagForRecord(const RecordDecl *RD) {
990   llvm::dwarf::Tag Tag;
991   if (RD->isStruct() || RD->isInterface())
992     Tag = llvm::dwarf::DW_TAG_structure_type;
993   else if (RD->isUnion())
994     Tag = llvm::dwarf::DW_TAG_union_type;
995   else {
996     // FIXME: This could be a struct type giving a default visibility different
997     // than C++ class type, but needs llvm metadata changes first.
998     assert(RD->isClass());
999     Tag = llvm::dwarf::DW_TAG_class_type;
1000   }
1001   return Tag;
1002 }
1003
1004 llvm::DICompositeType *
1005 CGDebugInfo::getOrCreateRecordFwdDecl(const RecordType *Ty,
1006                                       llvm::DIScope *Ctx) {
1007   const RecordDecl *RD = Ty->getDecl();
1008   if (llvm::DIType *T = getTypeOrNull(CGM.getContext().getRecordType(RD)))
1009     return cast<llvm::DICompositeType>(T);
1010   llvm::DIFile *DefUnit = getOrCreateFile(RD->getLocation());
1011   unsigned Line = getLineNumber(RD->getLocation());
1012   StringRef RDName = getClassName(RD);
1013
1014   uint64_t Size = 0;
1015   uint32_t Align = 0;
1016
1017   llvm::DINode::DIFlags Flags = llvm::DINode::FlagFwdDecl;
1018
1019   // Add flag to nontrivial forward declarations. To be consistent with MSVC,
1020   // add the flag if a record has no definition because we don't know whether
1021   // it will be trivial or not.
1022   if (const CXXRecordDecl *CXXRD = dyn_cast<CXXRecordDecl>(RD))
1023     if (!CXXRD->hasDefinition() ||
1024         (CXXRD->hasDefinition() && !CXXRD->isTrivial()))
1025       Flags |= llvm::DINode::FlagNonTrivial;
1026
1027   // Create the type.
1028   SmallString<256> Identifier = getTypeIdentifier(Ty, CGM, TheCU);
1029   llvm::DICompositeType *RetTy = DBuilder.createReplaceableCompositeType(
1030       getTagForRecord(RD), RDName, Ctx, DefUnit, Line, 0, Size, Align, Flags,
1031       Identifier);
1032   if (CGM.getCodeGenOpts().DebugFwdTemplateParams)
1033     if (auto *TSpecial = dyn_cast<ClassTemplateSpecializationDecl>(RD))
1034       DBuilder.replaceArrays(RetTy, llvm::DINodeArray(),
1035                              CollectCXXTemplateParams(TSpecial, DefUnit));
1036   ReplaceMap.emplace_back(
1037       std::piecewise_construct, std::make_tuple(Ty),
1038       std::make_tuple(static_cast<llvm::Metadata *>(RetTy)));
1039   return RetTy;
1040 }
1041
1042 llvm::DIType *CGDebugInfo::CreatePointerLikeType(llvm::dwarf::Tag Tag,
1043                                                  const Type *Ty,
1044                                                  QualType PointeeTy,
1045                                                  llvm::DIFile *Unit) {
1046   // Bit size, align and offset of the type.
1047   // Size is always the size of a pointer. We can't use getTypeSize here
1048   // because that does not return the correct value for references.
1049   unsigned AddressSpace = CGM.getContext().getTargetAddressSpace(PointeeTy);
1050   uint64_t Size = CGM.getTarget().getPointerWidth(AddressSpace);
1051   auto Align = getTypeAlignIfRequired(Ty, CGM.getContext());
1052   Optional<unsigned> DWARFAddressSpace =
1053       CGM.getTarget().getDWARFAddressSpace(AddressSpace);
1054
1055   if (Tag == llvm::dwarf::DW_TAG_reference_type ||
1056       Tag == llvm::dwarf::DW_TAG_rvalue_reference_type)
1057     return DBuilder.createReferenceType(Tag, getOrCreateType(PointeeTy, Unit),
1058                                         Size, Align, DWARFAddressSpace);
1059   else
1060     return DBuilder.createPointerType(getOrCreateType(PointeeTy, Unit), Size,
1061                                       Align, DWARFAddressSpace);
1062 }
1063
1064 llvm::DIType *CGDebugInfo::getOrCreateStructPtrType(StringRef Name,
1065                                                     llvm::DIType *&Cache) {
1066   if (Cache)
1067     return Cache;
1068   Cache = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type, Name,
1069                                      TheCU, TheCU->getFile(), 0);
1070   unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
1071   Cache = DBuilder.createPointerType(Cache, Size);
1072   return Cache;
1073 }
1074
1075 uint64_t CGDebugInfo::collectDefaultElementTypesForBlockPointer(
1076     const BlockPointerType *Ty, llvm::DIFile *Unit, llvm::DIDerivedType *DescTy,
1077     unsigned LineNo, SmallVectorImpl<llvm::Metadata *> &EltTys) {
1078   QualType FType;
1079
1080   // Advanced by calls to CreateMemberType in increments of FType, then
1081   // returned as the overall size of the default elements.
1082   uint64_t FieldOffset = 0;
1083
1084   // Blocks in OpenCL have unique constraints which make the standard fields
1085   // redundant while requiring size and align fields for enqueue_kernel. See
1086   // initializeForBlockHeader in CGBlocks.cpp
1087   if (CGM.getLangOpts().OpenCL) {
1088     FType = CGM.getContext().IntTy;
1089     EltTys.push_back(CreateMemberType(Unit, FType, "__size", &FieldOffset));
1090     EltTys.push_back(CreateMemberType(Unit, FType, "__align", &FieldOffset));
1091   } else {
1092     FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
1093     EltTys.push_back(CreateMemberType(Unit, FType, "__isa", &FieldOffset));
1094     FType = CGM.getContext().IntTy;
1095     EltTys.push_back(CreateMemberType(Unit, FType, "__flags", &FieldOffset));
1096     EltTys.push_back(CreateMemberType(Unit, FType, "__reserved", &FieldOffset));
1097     FType = CGM.getContext().getPointerType(Ty->getPointeeType());
1098     EltTys.push_back(CreateMemberType(Unit, FType, "__FuncPtr", &FieldOffset));
1099     FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
1100     uint64_t FieldSize = CGM.getContext().getTypeSize(Ty);
1101     uint32_t FieldAlign = CGM.getContext().getTypeAlign(Ty);
1102     EltTys.push_back(DBuilder.createMemberType(
1103         Unit, "__descriptor", nullptr, LineNo, FieldSize, FieldAlign,
1104         FieldOffset, llvm::DINode::FlagZero, DescTy));
1105     FieldOffset += FieldSize;
1106   }
1107
1108   return FieldOffset;
1109 }
1110
1111 llvm::DIType *CGDebugInfo::CreateType(const BlockPointerType *Ty,
1112                                       llvm::DIFile *Unit) {
1113   SmallVector<llvm::Metadata *, 8> EltTys;
1114   QualType FType;
1115   uint64_t FieldOffset;
1116   llvm::DINodeArray Elements;
1117
1118   FieldOffset = 0;
1119   FType = CGM.getContext().UnsignedLongTy;
1120   EltTys.push_back(CreateMemberType(Unit, FType, "reserved", &FieldOffset));
1121   EltTys.push_back(CreateMemberType(Unit, FType, "Size", &FieldOffset));
1122
1123   Elements = DBuilder.getOrCreateArray(EltTys);
1124   EltTys.clear();
1125
1126   llvm::DINode::DIFlags Flags = llvm::DINode::FlagAppleBlock;
1127
1128   auto *EltTy =
1129       DBuilder.createStructType(Unit, "__block_descriptor", nullptr, 0,
1130                                 FieldOffset, 0, Flags, nullptr, Elements);
1131
1132   // Bit size, align and offset of the type.
1133   uint64_t Size = CGM.getContext().getTypeSize(Ty);
1134
1135   auto *DescTy = DBuilder.createPointerType(EltTy, Size);
1136
1137   FieldOffset = collectDefaultElementTypesForBlockPointer(Ty, Unit, DescTy,
1138                                                           0, EltTys);
1139
1140   Elements = DBuilder.getOrCreateArray(EltTys);
1141
1142   // The __block_literal_generic structs are marked with a special
1143   // DW_AT_APPLE_BLOCK attribute and are an implementation detail only
1144   // the debugger needs to know about. To allow type uniquing, emit
1145   // them without a name or a location.
1146   EltTy = DBuilder.createStructType(Unit, "", nullptr, 0, FieldOffset, 0,
1147                                     Flags, nullptr, Elements);
1148
1149   return DBuilder.createPointerType(EltTy, Size);
1150 }
1151
1152 llvm::DIType *CGDebugInfo::CreateType(const TemplateSpecializationType *Ty,
1153                                       llvm::DIFile *Unit) {
1154   assert(Ty->isTypeAlias());
1155   llvm::DIType *Src = getOrCreateType(Ty->getAliasedType(), Unit);
1156
1157   auto *AliasDecl =
1158       cast<TypeAliasTemplateDecl>(Ty->getTemplateName().getAsTemplateDecl())
1159           ->getTemplatedDecl();
1160
1161   if (AliasDecl->hasAttr<NoDebugAttr>())
1162     return Src;
1163
1164   SmallString<128> NS;
1165   llvm::raw_svector_ostream OS(NS);
1166   Ty->getTemplateName().print(OS, getPrintingPolicy(), /*qualified*/ false);
1167   printTemplateArgumentList(OS, Ty->template_arguments(), getPrintingPolicy());
1168
1169   SourceLocation Loc = AliasDecl->getLocation();
1170   return DBuilder.createTypedef(Src, OS.str(), getOrCreateFile(Loc),
1171                                 getLineNumber(Loc),
1172                                 getDeclContextDescriptor(AliasDecl));
1173 }
1174
1175 llvm::DIType *CGDebugInfo::CreateType(const TypedefType *Ty,
1176                                       llvm::DIFile *Unit) {
1177   llvm::DIType *Underlying =
1178       getOrCreateType(Ty->getDecl()->getUnderlyingType(), Unit);
1179
1180   if (Ty->getDecl()->hasAttr<NoDebugAttr>())
1181     return Underlying;
1182
1183   // We don't set size information, but do specify where the typedef was
1184   // declared.
1185   SourceLocation Loc = Ty->getDecl()->getLocation();
1186
1187   uint32_t Align = getDeclAlignIfRequired(Ty->getDecl(), CGM.getContext());
1188   // Typedefs are derived from some other type.
1189   return DBuilder.createTypedef(Underlying, Ty->getDecl()->getName(),
1190                                 getOrCreateFile(Loc), getLineNumber(Loc),
1191                                 getDeclContextDescriptor(Ty->getDecl()), Align);
1192 }
1193
1194 static unsigned getDwarfCC(CallingConv CC) {
1195   switch (CC) {
1196   case CC_C:
1197     // Avoid emitting DW_AT_calling_convention if the C convention was used.
1198     return 0;
1199
1200   case CC_X86StdCall:
1201     return llvm::dwarf::DW_CC_BORLAND_stdcall;
1202   case CC_X86FastCall:
1203     return llvm::dwarf::DW_CC_BORLAND_msfastcall;
1204   case CC_X86ThisCall:
1205     return llvm::dwarf::DW_CC_BORLAND_thiscall;
1206   case CC_X86VectorCall:
1207     return llvm::dwarf::DW_CC_LLVM_vectorcall;
1208   case CC_X86Pascal:
1209     return llvm::dwarf::DW_CC_BORLAND_pascal;
1210   case CC_Win64:
1211     return llvm::dwarf::DW_CC_LLVM_Win64;
1212   case CC_X86_64SysV:
1213     return llvm::dwarf::DW_CC_LLVM_X86_64SysV;
1214   case CC_AAPCS:
1215   case CC_AArch64VectorCall:
1216     return llvm::dwarf::DW_CC_LLVM_AAPCS;
1217   case CC_AAPCS_VFP:
1218     return llvm::dwarf::DW_CC_LLVM_AAPCS_VFP;
1219   case CC_IntelOclBicc:
1220     return llvm::dwarf::DW_CC_LLVM_IntelOclBicc;
1221   case CC_SpirFunction:
1222     return llvm::dwarf::DW_CC_LLVM_SpirFunction;
1223   case CC_OpenCLKernel:
1224     return llvm::dwarf::DW_CC_LLVM_OpenCLKernel;
1225   case CC_Swift:
1226     return llvm::dwarf::DW_CC_LLVM_Swift;
1227   case CC_PreserveMost:
1228     return llvm::dwarf::DW_CC_LLVM_PreserveMost;
1229   case CC_PreserveAll:
1230     return llvm::dwarf::DW_CC_LLVM_PreserveAll;
1231   case CC_X86RegCall:
1232     return llvm::dwarf::DW_CC_LLVM_X86RegCall;
1233   }
1234   return 0;
1235 }
1236
1237 llvm::DIType *CGDebugInfo::CreateType(const FunctionType *Ty,
1238                                       llvm::DIFile *Unit) {
1239   SmallVector<llvm::Metadata *, 16> EltTys;
1240
1241   // Add the result type at least.
1242   EltTys.push_back(getOrCreateType(Ty->getReturnType(), Unit));
1243
1244   // Set up remainder of arguments if there is a prototype.
1245   // otherwise emit it as a variadic function.
1246   if (isa<FunctionNoProtoType>(Ty))
1247     EltTys.push_back(DBuilder.createUnspecifiedParameter());
1248   else if (const auto *FPT = dyn_cast<FunctionProtoType>(Ty)) {
1249     for (const QualType &ParamType : FPT->param_types())
1250       EltTys.push_back(getOrCreateType(ParamType, Unit));
1251     if (FPT->isVariadic())
1252       EltTys.push_back(DBuilder.createUnspecifiedParameter());
1253   }
1254
1255   llvm::DITypeRefArray EltTypeArray = DBuilder.getOrCreateTypeArray(EltTys);
1256   return DBuilder.createSubroutineType(EltTypeArray, llvm::DINode::FlagZero,
1257                                        getDwarfCC(Ty->getCallConv()));
1258 }
1259
1260 /// Convert an AccessSpecifier into the corresponding DINode flag.
1261 /// As an optimization, return 0 if the access specifier equals the
1262 /// default for the containing type.
1263 static llvm::DINode::DIFlags getAccessFlag(AccessSpecifier Access,
1264                                            const RecordDecl *RD) {
1265   AccessSpecifier Default = clang::AS_none;
1266   if (RD && RD->isClass())
1267     Default = clang::AS_private;
1268   else if (RD && (RD->isStruct() || RD->isUnion()))
1269     Default = clang::AS_public;
1270
1271   if (Access == Default)
1272     return llvm::DINode::FlagZero;
1273
1274   switch (Access) {
1275   case clang::AS_private:
1276     return llvm::DINode::FlagPrivate;
1277   case clang::AS_protected:
1278     return llvm::DINode::FlagProtected;
1279   case clang::AS_public:
1280     return llvm::DINode::FlagPublic;
1281   case clang::AS_none:
1282     return llvm::DINode::FlagZero;
1283   }
1284   llvm_unreachable("unexpected access enumerator");
1285 }
1286
1287 llvm::DIType *CGDebugInfo::createBitFieldType(const FieldDecl *BitFieldDecl,
1288                                               llvm::DIScope *RecordTy,
1289                                               const RecordDecl *RD) {
1290   StringRef Name = BitFieldDecl->getName();
1291   QualType Ty = BitFieldDecl->getType();
1292   SourceLocation Loc = BitFieldDecl->getLocation();
1293   llvm::DIFile *VUnit = getOrCreateFile(Loc);
1294   llvm::DIType *DebugType = getOrCreateType(Ty, VUnit);
1295
1296   // Get the location for the field.
1297   llvm::DIFile *File = getOrCreateFile(Loc);
1298   unsigned Line = getLineNumber(Loc);
1299
1300   const CGBitFieldInfo &BitFieldInfo =
1301       CGM.getTypes().getCGRecordLayout(RD).getBitFieldInfo(BitFieldDecl);
1302   uint64_t SizeInBits = BitFieldInfo.Size;
1303   assert(SizeInBits > 0 && "found named 0-width bitfield");
1304   uint64_t StorageOffsetInBits =
1305       CGM.getContext().toBits(BitFieldInfo.StorageOffset);
1306   uint64_t Offset = BitFieldInfo.Offset;
1307   // The bit offsets for big endian machines are reversed for big
1308   // endian target, compensate for that as the DIDerivedType requires
1309   // un-reversed offsets.
1310   if (CGM.getDataLayout().isBigEndian())
1311     Offset = BitFieldInfo.StorageSize - BitFieldInfo.Size - Offset;
1312   uint64_t OffsetInBits = StorageOffsetInBits + Offset;
1313   llvm::DINode::DIFlags Flags = getAccessFlag(BitFieldDecl->getAccess(), RD);
1314   return DBuilder.createBitFieldMemberType(
1315       RecordTy, Name, File, Line, SizeInBits, OffsetInBits, StorageOffsetInBits,
1316       Flags, DebugType);
1317 }
1318
1319 llvm::DIType *
1320 CGDebugInfo::createFieldType(StringRef name, QualType type, SourceLocation loc,
1321                              AccessSpecifier AS, uint64_t offsetInBits,
1322                              uint32_t AlignInBits, llvm::DIFile *tunit,
1323                              llvm::DIScope *scope, const RecordDecl *RD) {
1324   llvm::DIType *debugType = getOrCreateType(type, tunit);
1325
1326   // Get the location for the field.
1327   llvm::DIFile *file = getOrCreateFile(loc);
1328   unsigned line = getLineNumber(loc);
1329
1330   uint64_t SizeInBits = 0;
1331   auto Align = AlignInBits;
1332   if (!type->isIncompleteArrayType()) {
1333     TypeInfo TI = CGM.getContext().getTypeInfo(type);
1334     SizeInBits = TI.Width;
1335     if (!Align)
1336       Align = getTypeAlignIfRequired(type, CGM.getContext());
1337   }
1338
1339   llvm::DINode::DIFlags flags = getAccessFlag(AS, RD);
1340   return DBuilder.createMemberType(scope, name, file, line, SizeInBits, Align,
1341                                    offsetInBits, flags, debugType);
1342 }
1343
1344 void CGDebugInfo::CollectRecordLambdaFields(
1345     const CXXRecordDecl *CXXDecl, SmallVectorImpl<llvm::Metadata *> &elements,
1346     llvm::DIType *RecordTy) {
1347   // For C++11 Lambdas a Field will be the same as a Capture, but the Capture
1348   // has the name and the location of the variable so we should iterate over
1349   // both concurrently.
1350   const ASTRecordLayout &layout = CGM.getContext().getASTRecordLayout(CXXDecl);
1351   RecordDecl::field_iterator Field = CXXDecl->field_begin();
1352   unsigned fieldno = 0;
1353   for (CXXRecordDecl::capture_const_iterator I = CXXDecl->captures_begin(),
1354                                              E = CXXDecl->captures_end();
1355        I != E; ++I, ++Field, ++fieldno) {
1356     const LambdaCapture &C = *I;
1357     if (C.capturesVariable()) {
1358       SourceLocation Loc = C.getLocation();
1359       assert(!Field->isBitField() && "lambdas don't have bitfield members!");
1360       VarDecl *V = C.getCapturedVar();
1361       StringRef VName = V->getName();
1362       llvm::DIFile *VUnit = getOrCreateFile(Loc);
1363       auto Align = getDeclAlignIfRequired(V, CGM.getContext());
1364       llvm::DIType *FieldType = createFieldType(
1365           VName, Field->getType(), Loc, Field->getAccess(),
1366           layout.getFieldOffset(fieldno), Align, VUnit, RecordTy, CXXDecl);
1367       elements.push_back(FieldType);
1368     } else if (C.capturesThis()) {
1369       // TODO: Need to handle 'this' in some way by probably renaming the
1370       // this of the lambda class and having a field member of 'this' or
1371       // by using AT_object_pointer for the function and having that be
1372       // used as 'this' for semantic references.
1373       FieldDecl *f = *Field;
1374       llvm::DIFile *VUnit = getOrCreateFile(f->getLocation());
1375       QualType type = f->getType();
1376       llvm::DIType *fieldType = createFieldType(
1377           "this", type, f->getLocation(), f->getAccess(),
1378           layout.getFieldOffset(fieldno), VUnit, RecordTy, CXXDecl);
1379
1380       elements.push_back(fieldType);
1381     }
1382   }
1383 }
1384
1385 llvm::DIDerivedType *
1386 CGDebugInfo::CreateRecordStaticField(const VarDecl *Var, llvm::DIType *RecordTy,
1387                                      const RecordDecl *RD) {
1388   // Create the descriptor for the static variable, with or without
1389   // constant initializers.
1390   Var = Var->getCanonicalDecl();
1391   llvm::DIFile *VUnit = getOrCreateFile(Var->getLocation());
1392   llvm::DIType *VTy = getOrCreateType(Var->getType(), VUnit);
1393
1394   unsigned LineNumber = getLineNumber(Var->getLocation());
1395   StringRef VName = Var->getName();
1396   llvm::Constant *C = nullptr;
1397   if (Var->getInit()) {
1398     const APValue *Value = Var->evaluateValue();
1399     if (Value) {
1400       if (Value->isInt())
1401         C = llvm::ConstantInt::get(CGM.getLLVMContext(), Value->getInt());
1402       if (Value->isFloat())
1403         C = llvm::ConstantFP::get(CGM.getLLVMContext(), Value->getFloat());
1404     }
1405   }
1406
1407   llvm::DINode::DIFlags Flags = getAccessFlag(Var->getAccess(), RD);
1408   auto Align = getDeclAlignIfRequired(Var, CGM.getContext());
1409   llvm::DIDerivedType *GV = DBuilder.createStaticMemberType(
1410       RecordTy, VName, VUnit, LineNumber, VTy, Flags, C, Align);
1411   StaticDataMemberCache[Var->getCanonicalDecl()].reset(GV);
1412   return GV;
1413 }
1414
1415 void CGDebugInfo::CollectRecordNormalField(
1416     const FieldDecl *field, uint64_t OffsetInBits, llvm::DIFile *tunit,
1417     SmallVectorImpl<llvm::Metadata *> &elements, llvm::DIType *RecordTy,
1418     const RecordDecl *RD) {
1419   StringRef name = field->getName();
1420   QualType type = field->getType();
1421
1422   // Ignore unnamed fields unless they're anonymous structs/unions.
1423   if (name.empty() && !type->isRecordType())
1424     return;
1425
1426   llvm::DIType *FieldType;
1427   if (field->isBitField()) {
1428     FieldType = createBitFieldType(field, RecordTy, RD);
1429   } else {
1430     auto Align = getDeclAlignIfRequired(field, CGM.getContext());
1431     FieldType =
1432         createFieldType(name, type, field->getLocation(), field->getAccess(),
1433                         OffsetInBits, Align, tunit, RecordTy, RD);
1434   }
1435
1436   elements.push_back(FieldType);
1437 }
1438
1439 void CGDebugInfo::CollectRecordNestedType(
1440     const TypeDecl *TD, SmallVectorImpl<llvm::Metadata *> &elements) {
1441   QualType Ty = CGM.getContext().getTypeDeclType(TD);
1442   // Injected class names are not considered nested records.
1443   if (isa<InjectedClassNameType>(Ty))
1444     return;
1445   SourceLocation Loc = TD->getLocation();
1446   llvm::DIType *nestedType = getOrCreateType(Ty, getOrCreateFile(Loc));
1447   elements.push_back(nestedType);
1448 }
1449
1450 void CGDebugInfo::CollectRecordFields(
1451     const RecordDecl *record, llvm::DIFile *tunit,
1452     SmallVectorImpl<llvm::Metadata *> &elements,
1453     llvm::DICompositeType *RecordTy) {
1454   const auto *CXXDecl = dyn_cast<CXXRecordDecl>(record);
1455
1456   if (CXXDecl && CXXDecl->isLambda())
1457     CollectRecordLambdaFields(CXXDecl, elements, RecordTy);
1458   else {
1459     const ASTRecordLayout &layout = CGM.getContext().getASTRecordLayout(record);
1460
1461     // Field number for non-static fields.
1462     unsigned fieldNo = 0;
1463
1464     // Static and non-static members should appear in the same order as
1465     // the corresponding declarations in the source program.
1466     for (const auto *I : record->decls())
1467       if (const auto *V = dyn_cast<VarDecl>(I)) {
1468         if (V->hasAttr<NoDebugAttr>())
1469           continue;
1470
1471         // Skip variable template specializations when emitting CodeView. MSVC
1472         // doesn't emit them.
1473         if (CGM.getCodeGenOpts().EmitCodeView &&
1474             isa<VarTemplateSpecializationDecl>(V))
1475           continue;
1476
1477         if (isa<VarTemplatePartialSpecializationDecl>(V))
1478           continue;
1479
1480         // Reuse the existing static member declaration if one exists
1481         auto MI = StaticDataMemberCache.find(V->getCanonicalDecl());
1482         if (MI != StaticDataMemberCache.end()) {
1483           assert(MI->second &&
1484                  "Static data member declaration should still exist");
1485           elements.push_back(MI->second);
1486         } else {
1487           auto Field = CreateRecordStaticField(V, RecordTy, record);
1488           elements.push_back(Field);
1489         }
1490       } else if (const auto *field = dyn_cast<FieldDecl>(I)) {
1491         CollectRecordNormalField(field, layout.getFieldOffset(fieldNo), tunit,
1492                                  elements, RecordTy, record);
1493
1494         // Bump field number for next field.
1495         ++fieldNo;
1496       } else if (CGM.getCodeGenOpts().EmitCodeView) {
1497         // Debug info for nested types is included in the member list only for
1498         // CodeView.
1499         if (const auto *nestedType = dyn_cast<TypeDecl>(I))
1500           if (!nestedType->isImplicit() &&
1501               nestedType->getDeclContext() == record)
1502             CollectRecordNestedType(nestedType, elements);
1503       }
1504   }
1505 }
1506
1507 llvm::DISubroutineType *
1508 CGDebugInfo::getOrCreateMethodType(const CXXMethodDecl *Method,
1509                                    llvm::DIFile *Unit, bool decl) {
1510   const FunctionProtoType *Func = Method->getType()->getAs<FunctionProtoType>();
1511   if (Method->isStatic())
1512     return cast_or_null<llvm::DISubroutineType>(
1513         getOrCreateType(QualType(Func, 0), Unit));
1514   return getOrCreateInstanceMethodType(Method->getThisType(), Func, Unit, decl);
1515 }
1516
1517 llvm::DISubroutineType *
1518 CGDebugInfo::getOrCreateInstanceMethodType(QualType ThisPtr,
1519                                            const FunctionProtoType *Func,
1520                                            llvm::DIFile *Unit, bool decl) {
1521   // Add "this" pointer.
1522   llvm::DITypeRefArray Args(
1523       cast<llvm::DISubroutineType>(getOrCreateType(QualType(Func, 0), Unit))
1524           ->getTypeArray());
1525   assert(Args.size() && "Invalid number of arguments!");
1526
1527   SmallVector<llvm::Metadata *, 16> Elts;
1528   // First element is always return type. For 'void' functions it is NULL.
1529   QualType temp = Func->getReturnType();
1530   if (temp->getTypeClass() == Type::Auto && decl)
1531     Elts.push_back(CreateType(cast<AutoType>(temp)));
1532   else
1533     Elts.push_back(Args[0]);
1534
1535   // "this" pointer is always first argument.
1536   const CXXRecordDecl *RD = ThisPtr->getPointeeCXXRecordDecl();
1537   if (isa<ClassTemplateSpecializationDecl>(RD)) {
1538     // Create pointer type directly in this case.
1539     const PointerType *ThisPtrTy = cast<PointerType>(ThisPtr);
1540     QualType PointeeTy = ThisPtrTy->getPointeeType();
1541     unsigned AS = CGM.getContext().getTargetAddressSpace(PointeeTy);
1542     uint64_t Size = CGM.getTarget().getPointerWidth(AS);
1543     auto Align = getTypeAlignIfRequired(ThisPtrTy, CGM.getContext());
1544     llvm::DIType *PointeeType = getOrCreateType(PointeeTy, Unit);
1545     llvm::DIType *ThisPtrType =
1546         DBuilder.createPointerType(PointeeType, Size, Align);
1547     TypeCache[ThisPtr.getAsOpaquePtr()].reset(ThisPtrType);
1548     // TODO: This and the artificial type below are misleading, the
1549     // types aren't artificial the argument is, but the current
1550     // metadata doesn't represent that.
1551     ThisPtrType = DBuilder.createObjectPointerType(ThisPtrType);
1552     Elts.push_back(ThisPtrType);
1553   } else {
1554     llvm::DIType *ThisPtrType = getOrCreateType(ThisPtr, Unit);
1555     TypeCache[ThisPtr.getAsOpaquePtr()].reset(ThisPtrType);
1556     ThisPtrType = DBuilder.createObjectPointerType(ThisPtrType);
1557     Elts.push_back(ThisPtrType);
1558   }
1559
1560   // Copy rest of the arguments.
1561   for (unsigned i = 1, e = Args.size(); i != e; ++i)
1562     Elts.push_back(Args[i]);
1563
1564   llvm::DITypeRefArray EltTypeArray = DBuilder.getOrCreateTypeArray(Elts);
1565
1566   llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
1567   if (Func->getExtProtoInfo().RefQualifier == RQ_LValue)
1568     Flags |= llvm::DINode::FlagLValueReference;
1569   if (Func->getExtProtoInfo().RefQualifier == RQ_RValue)
1570     Flags |= llvm::DINode::FlagRValueReference;
1571
1572   return DBuilder.createSubroutineType(EltTypeArray, Flags,
1573                                        getDwarfCC(Func->getCallConv()));
1574 }
1575
1576 /// isFunctionLocalClass - Return true if CXXRecordDecl is defined
1577 /// inside a function.
1578 static bool isFunctionLocalClass(const CXXRecordDecl *RD) {
1579   if (const auto *NRD = dyn_cast<CXXRecordDecl>(RD->getDeclContext()))
1580     return isFunctionLocalClass(NRD);
1581   if (isa<FunctionDecl>(RD->getDeclContext()))
1582     return true;
1583   return false;
1584 }
1585
1586 llvm::DISubprogram *CGDebugInfo::CreateCXXMemberFunction(
1587     const CXXMethodDecl *Method, llvm::DIFile *Unit, llvm::DIType *RecordTy) {
1588   bool IsCtorOrDtor =
1589       isa<CXXConstructorDecl>(Method) || isa<CXXDestructorDecl>(Method);
1590
1591   StringRef MethodName = getFunctionName(Method);
1592   llvm::DISubroutineType *MethodTy = getOrCreateMethodType(Method, Unit, true);
1593
1594   // Since a single ctor/dtor corresponds to multiple functions, it doesn't
1595   // make sense to give a single ctor/dtor a linkage name.
1596   StringRef MethodLinkageName;
1597   // FIXME: 'isFunctionLocalClass' seems like an arbitrary/unintentional
1598   // property to use here. It may've been intended to model "is non-external
1599   // type" but misses cases of non-function-local but non-external classes such
1600   // as those in anonymous namespaces as well as the reverse - external types
1601   // that are function local, such as those in (non-local) inline functions.
1602   if (!IsCtorOrDtor && !isFunctionLocalClass(Method->getParent()))
1603     MethodLinkageName = CGM.getMangledName(Method);
1604
1605   // Get the location for the method.
1606   llvm::DIFile *MethodDefUnit = nullptr;
1607   unsigned MethodLine = 0;
1608   if (!Method->isImplicit()) {
1609     MethodDefUnit = getOrCreateFile(Method->getLocation());
1610     MethodLine = getLineNumber(Method->getLocation());
1611   }
1612
1613   // Collect virtual method info.
1614   llvm::DIType *ContainingType = nullptr;
1615   unsigned VIndex = 0;
1616   llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
1617   llvm::DISubprogram::DISPFlags SPFlags = llvm::DISubprogram::SPFlagZero;
1618   int ThisAdjustment = 0;
1619
1620   if (Method->isVirtual()) {
1621     if (Method->isPure())
1622       SPFlags |= llvm::DISubprogram::SPFlagPureVirtual;
1623     else
1624       SPFlags |= llvm::DISubprogram::SPFlagVirtual;
1625
1626     if (CGM.getTarget().getCXXABI().isItaniumFamily()) {
1627       // It doesn't make sense to give a virtual destructor a vtable index,
1628       // since a single destructor has two entries in the vtable.
1629       if (!isa<CXXDestructorDecl>(Method))
1630         VIndex = CGM.getItaniumVTableContext().getMethodVTableIndex(Method);
1631     } else {
1632       // Emit MS ABI vftable information.  There is only one entry for the
1633       // deleting dtor.
1634       const auto *DD = dyn_cast<CXXDestructorDecl>(Method);
1635       GlobalDecl GD = DD ? GlobalDecl(DD, Dtor_Deleting) : GlobalDecl(Method);
1636       MethodVFTableLocation ML =
1637           CGM.getMicrosoftVTableContext().getMethodVFTableLocation(GD);
1638       VIndex = ML.Index;
1639
1640       // CodeView only records the vftable offset in the class that introduces
1641       // the virtual method. This is possible because, unlike Itanium, the MS
1642       // C++ ABI does not include all virtual methods from non-primary bases in
1643       // the vtable for the most derived class. For example, if C inherits from
1644       // A and B, C's primary vftable will not include B's virtual methods.
1645       if (Method->size_overridden_methods() == 0)
1646         Flags |= llvm::DINode::FlagIntroducedVirtual;
1647
1648       // The 'this' adjustment accounts for both the virtual and non-virtual
1649       // portions of the adjustment. Presumably the debugger only uses it when
1650       // it knows the dynamic type of an object.
1651       ThisAdjustment = CGM.getCXXABI()
1652                            .getVirtualFunctionPrologueThisAdjustment(GD)
1653                            .getQuantity();
1654     }
1655     ContainingType = RecordTy;
1656   }
1657
1658   // We're checking for deleted C++ special member functions
1659   // [Ctors,Dtors, Copy/Move]
1660   auto checkAttrDeleted = [&](const auto *Method) {
1661     if (Method->getCanonicalDecl()->isDeleted())
1662       SPFlags |= llvm::DISubprogram::SPFlagDeleted;
1663   };
1664
1665   switch (Method->getKind()) {
1666
1667   case Decl::CXXConstructor:
1668   case Decl::CXXDestructor:
1669     checkAttrDeleted(Method);
1670     break;
1671   case Decl::CXXMethod:
1672     if (Method->isCopyAssignmentOperator() ||
1673         Method->isMoveAssignmentOperator())
1674       checkAttrDeleted(Method);
1675     break;
1676   default:
1677     break;
1678   }
1679
1680   if (Method->isNoReturn())
1681     Flags |= llvm::DINode::FlagNoReturn;
1682
1683   if (Method->isStatic())
1684     Flags |= llvm::DINode::FlagStaticMember;
1685   if (Method->isImplicit())
1686     Flags |= llvm::DINode::FlagArtificial;
1687   Flags |= getAccessFlag(Method->getAccess(), Method->getParent());
1688   if (const auto *CXXC = dyn_cast<CXXConstructorDecl>(Method)) {
1689     if (CXXC->isExplicit())
1690       Flags |= llvm::DINode::FlagExplicit;
1691   } else if (const auto *CXXC = dyn_cast<CXXConversionDecl>(Method)) {
1692     if (CXXC->isExplicit())
1693       Flags |= llvm::DINode::FlagExplicit;
1694   }
1695   if (Method->hasPrototype())
1696     Flags |= llvm::DINode::FlagPrototyped;
1697   if (Method->getRefQualifier() == RQ_LValue)
1698     Flags |= llvm::DINode::FlagLValueReference;
1699   if (Method->getRefQualifier() == RQ_RValue)
1700     Flags |= llvm::DINode::FlagRValueReference;
1701   if (CGM.getLangOpts().Optimize)
1702     SPFlags |= llvm::DISubprogram::SPFlagOptimized;
1703
1704   // In this debug mode, emit type info for a class when its constructor type
1705   // info is emitted.
1706   if (DebugKind == codegenoptions::DebugInfoConstructor)
1707     if (const CXXConstructorDecl *CD = dyn_cast<CXXConstructorDecl>(Method))
1708       completeClass(CD->getParent());
1709
1710   llvm::DINodeArray TParamsArray = CollectFunctionTemplateParams(Method, Unit);
1711   llvm::DISubprogram *SP = DBuilder.createMethod(
1712       RecordTy, MethodName, MethodLinkageName, MethodDefUnit, MethodLine,
1713       MethodTy, VIndex, ThisAdjustment, ContainingType, Flags, SPFlags,
1714       TParamsArray.get());
1715
1716   SPCache[Method->getCanonicalDecl()].reset(SP);
1717
1718   return SP;
1719 }
1720
1721 void CGDebugInfo::CollectCXXMemberFunctions(
1722     const CXXRecordDecl *RD, llvm::DIFile *Unit,
1723     SmallVectorImpl<llvm::Metadata *> &EltTys, llvm::DIType *RecordTy) {
1724
1725   // Since we want more than just the individual member decls if we
1726   // have templated functions iterate over every declaration to gather
1727   // the functions.
1728   for (const auto *I : RD->decls()) {
1729     const auto *Method = dyn_cast<CXXMethodDecl>(I);
1730     // If the member is implicit, don't add it to the member list. This avoids
1731     // the member being added to type units by LLVM, while still allowing it
1732     // to be emitted into the type declaration/reference inside the compile
1733     // unit.
1734     // Ditto 'nodebug' methods, for consistency with CodeGenFunction.cpp.
1735     // FIXME: Handle Using(Shadow?)Decls here to create
1736     // DW_TAG_imported_declarations inside the class for base decls brought into
1737     // derived classes. GDB doesn't seem to notice/leverage these when I tried
1738     // it, so I'm not rushing to fix this. (GCC seems to produce them, if
1739     // referenced)
1740     if (!Method || Method->isImplicit() || Method->hasAttr<NoDebugAttr>())
1741       continue;
1742
1743     if (Method->getType()->castAs<FunctionProtoType>()->getContainedAutoType())
1744       continue;
1745
1746     // Reuse the existing member function declaration if it exists.
1747     // It may be associated with the declaration of the type & should be
1748     // reused as we're building the definition.
1749     //
1750     // This situation can arise in the vtable-based debug info reduction where
1751     // implicit members are emitted in a non-vtable TU.
1752     auto MI = SPCache.find(Method->getCanonicalDecl());
1753     EltTys.push_back(MI == SPCache.end()
1754                          ? CreateCXXMemberFunction(Method, Unit, RecordTy)
1755                          : static_cast<llvm::Metadata *>(MI->second));
1756   }
1757 }
1758
1759 void CGDebugInfo::CollectCXXBases(const CXXRecordDecl *RD, llvm::DIFile *Unit,
1760                                   SmallVectorImpl<llvm::Metadata *> &EltTys,
1761                                   llvm::DIType *RecordTy) {
1762   llvm::DenseSet<CanonicalDeclPtr<const CXXRecordDecl>> SeenTypes;
1763   CollectCXXBasesAux(RD, Unit, EltTys, RecordTy, RD->bases(), SeenTypes,
1764                      llvm::DINode::FlagZero);
1765
1766   // If we are generating CodeView debug info, we also need to emit records for
1767   // indirect virtual base classes.
1768   if (CGM.getCodeGenOpts().EmitCodeView) {
1769     CollectCXXBasesAux(RD, Unit, EltTys, RecordTy, RD->vbases(), SeenTypes,
1770                        llvm::DINode::FlagIndirectVirtualBase);
1771   }
1772 }
1773
1774 void CGDebugInfo::CollectCXXBasesAux(
1775     const CXXRecordDecl *RD, llvm::DIFile *Unit,
1776     SmallVectorImpl<llvm::Metadata *> &EltTys, llvm::DIType *RecordTy,
1777     const CXXRecordDecl::base_class_const_range &Bases,
1778     llvm::DenseSet<CanonicalDeclPtr<const CXXRecordDecl>> &SeenTypes,
1779     llvm::DINode::DIFlags StartingFlags) {
1780   const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
1781   for (const auto &BI : Bases) {
1782     const auto *Base =
1783         cast<CXXRecordDecl>(BI.getType()->castAs<RecordType>()->getDecl());
1784     if (!SeenTypes.insert(Base).second)
1785       continue;
1786     auto *BaseTy = getOrCreateType(BI.getType(), Unit);
1787     llvm::DINode::DIFlags BFlags = StartingFlags;
1788     uint64_t BaseOffset;
1789     uint32_t VBPtrOffset = 0;
1790
1791     if (BI.isVirtual()) {
1792       if (CGM.getTarget().getCXXABI().isItaniumFamily()) {
1793         // virtual base offset offset is -ve. The code generator emits dwarf
1794         // expression where it expects +ve number.
1795         BaseOffset = 0 - CGM.getItaniumVTableContext()
1796                              .getVirtualBaseOffsetOffset(RD, Base)
1797                              .getQuantity();
1798       } else {
1799         // In the MS ABI, store the vbtable offset, which is analogous to the
1800         // vbase offset offset in Itanium.
1801         BaseOffset =
1802             4 * CGM.getMicrosoftVTableContext().getVBTableIndex(RD, Base);
1803         VBPtrOffset = CGM.getContext()
1804                           .getASTRecordLayout(RD)
1805                           .getVBPtrOffset()
1806                           .getQuantity();
1807       }
1808       BFlags |= llvm::DINode::FlagVirtual;
1809     } else
1810       BaseOffset = CGM.getContext().toBits(RL.getBaseClassOffset(Base));
1811     // FIXME: Inconsistent units for BaseOffset. It is in bytes when
1812     // BI->isVirtual() and bits when not.
1813
1814     BFlags |= getAccessFlag(BI.getAccessSpecifier(), RD);
1815     llvm::DIType *DTy = DBuilder.createInheritance(RecordTy, BaseTy, BaseOffset,
1816                                                    VBPtrOffset, BFlags);
1817     EltTys.push_back(DTy);
1818   }
1819 }
1820
1821 llvm::DINodeArray
1822 CGDebugInfo::CollectTemplateParams(const TemplateParameterList *TPList,
1823                                    ArrayRef<TemplateArgument> TAList,
1824                                    llvm::DIFile *Unit) {
1825   SmallVector<llvm::Metadata *, 16> TemplateParams;
1826   for (unsigned i = 0, e = TAList.size(); i != e; ++i) {
1827     const TemplateArgument &TA = TAList[i];
1828     StringRef Name;
1829     bool defaultParameter = false;
1830     if (TPList)
1831       Name = TPList->getParam(i)->getName();
1832     switch (TA.getKind()) {
1833     case TemplateArgument::Type: {
1834       llvm::DIType *TTy = getOrCreateType(TA.getAsType(), Unit);
1835
1836       if (TPList)
1837         if (auto *templateType =
1838                 dyn_cast_or_null<TemplateTypeParmDecl>(TPList->getParam(i)))
1839           if (templateType->hasDefaultArgument())
1840             defaultParameter =
1841                 templateType->getDefaultArgument() == TA.getAsType();
1842
1843       TemplateParams.push_back(DBuilder.createTemplateTypeParameter(
1844           TheCU, Name, TTy, defaultParameter));
1845
1846     } break;
1847     case TemplateArgument::Integral: {
1848       llvm::DIType *TTy = getOrCreateType(TA.getIntegralType(), Unit);
1849       if (TPList && CGM.getCodeGenOpts().DwarfVersion >= 5)
1850         if (auto *templateType =
1851                 dyn_cast_or_null<NonTypeTemplateParmDecl>(TPList->getParam(i)))
1852           if (templateType->hasDefaultArgument() &&
1853               !templateType->getDefaultArgument()->isValueDependent())
1854             defaultParameter = llvm::APSInt::isSameValue(
1855                 templateType->getDefaultArgument()->EvaluateKnownConstInt(
1856                     CGM.getContext()),
1857                 TA.getAsIntegral());
1858
1859       TemplateParams.push_back(DBuilder.createTemplateValueParameter(
1860           TheCU, Name, TTy, defaultParameter,
1861           llvm::ConstantInt::get(CGM.getLLVMContext(), TA.getAsIntegral())));
1862     } break;
1863     case TemplateArgument::Declaration: {
1864       const ValueDecl *D = TA.getAsDecl();
1865       QualType T = TA.getParamTypeForDecl().getDesugaredType(CGM.getContext());
1866       llvm::DIType *TTy = getOrCreateType(T, Unit);
1867       llvm::Constant *V = nullptr;
1868       // Skip retrieve the value if that template parameter has cuda device
1869       // attribute, i.e. that value is not available at the host side.
1870       if (!CGM.getLangOpts().CUDA || CGM.getLangOpts().CUDAIsDevice ||
1871           !D->hasAttr<CUDADeviceAttr>()) {
1872         const CXXMethodDecl *MD;
1873         // Variable pointer template parameters have a value that is the address
1874         // of the variable.
1875         if (const auto *VD = dyn_cast<VarDecl>(D))
1876           V = CGM.GetAddrOfGlobalVar(VD);
1877         // Member function pointers have special support for building them,
1878         // though this is currently unsupported in LLVM CodeGen.
1879         else if ((MD = dyn_cast<CXXMethodDecl>(D)) && MD->isInstance())
1880           V = CGM.getCXXABI().EmitMemberFunctionPointer(MD);
1881         else if (const auto *FD = dyn_cast<FunctionDecl>(D))
1882           V = CGM.GetAddrOfFunction(FD);
1883         // Member data pointers have special handling too to compute the fixed
1884         // offset within the object.
1885         else if (const auto *MPT =
1886                      dyn_cast<MemberPointerType>(T.getTypePtr())) {
1887           // These five lines (& possibly the above member function pointer
1888           // handling) might be able to be refactored to use similar code in
1889           // CodeGenModule::getMemberPointerConstant
1890           uint64_t fieldOffset = CGM.getContext().getFieldOffset(D);
1891           CharUnits chars =
1892               CGM.getContext().toCharUnitsFromBits((int64_t)fieldOffset);
1893           V = CGM.getCXXABI().EmitMemberDataPointer(MPT, chars);
1894         } else if (const auto *GD = dyn_cast<MSGuidDecl>(D)) {
1895           V = CGM.GetAddrOfMSGuidDecl(GD).getPointer();
1896         }
1897         assert(V && "Failed to find template parameter pointer");
1898         V = V->stripPointerCasts();
1899       }
1900       TemplateParams.push_back(DBuilder.createTemplateValueParameter(
1901           TheCU, Name, TTy, defaultParameter, cast_or_null<llvm::Constant>(V)));
1902     } break;
1903     case TemplateArgument::NullPtr: {
1904       QualType T = TA.getNullPtrType();
1905       llvm::DIType *TTy = getOrCreateType(T, Unit);
1906       llvm::Constant *V = nullptr;
1907       // Special case member data pointer null values since they're actually -1
1908       // instead of zero.
1909       if (const auto *MPT = dyn_cast<MemberPointerType>(T.getTypePtr()))
1910         // But treat member function pointers as simple zero integers because
1911         // it's easier than having a special case in LLVM's CodeGen. If LLVM
1912         // CodeGen grows handling for values of non-null member function
1913         // pointers then perhaps we could remove this special case and rely on
1914         // EmitNullMemberPointer for member function pointers.
1915         if (MPT->isMemberDataPointer())
1916           V = CGM.getCXXABI().EmitNullMemberPointer(MPT);
1917       if (!V)
1918         V = llvm::ConstantInt::get(CGM.Int8Ty, 0);
1919       TemplateParams.push_back(DBuilder.createTemplateValueParameter(
1920           TheCU, Name, TTy, defaultParameter, V));
1921     } break;
1922     case TemplateArgument::Template:
1923       TemplateParams.push_back(DBuilder.createTemplateTemplateParameter(
1924           TheCU, Name, nullptr,
1925           TA.getAsTemplate().getAsTemplateDecl()->getQualifiedNameAsString()));
1926       break;
1927     case TemplateArgument::Pack:
1928       TemplateParams.push_back(DBuilder.createTemplateParameterPack(
1929           TheCU, Name, nullptr,
1930           CollectTemplateParams(nullptr, TA.getPackAsArray(), Unit)));
1931       break;
1932     case TemplateArgument::Expression: {
1933       const Expr *E = TA.getAsExpr();
1934       QualType T = E->getType();
1935       if (E->isGLValue())
1936         T = CGM.getContext().getLValueReferenceType(T);
1937       llvm::Constant *V = ConstantEmitter(CGM).emitAbstract(E, T);
1938       assert(V && "Expression in template argument isn't constant");
1939       llvm::DIType *TTy = getOrCreateType(T, Unit);
1940       TemplateParams.push_back(DBuilder.createTemplateValueParameter(
1941           TheCU, Name, TTy, defaultParameter, V->stripPointerCasts()));
1942     } break;
1943     // And the following should never occur:
1944     case TemplateArgument::TemplateExpansion:
1945     case TemplateArgument::Null:
1946       llvm_unreachable(
1947           "These argument types shouldn't exist in concrete types");
1948     }
1949   }
1950   return DBuilder.getOrCreateArray(TemplateParams);
1951 }
1952
1953 llvm::DINodeArray
1954 CGDebugInfo::CollectFunctionTemplateParams(const FunctionDecl *FD,
1955                                            llvm::DIFile *Unit) {
1956   if (FD->getTemplatedKind() ==
1957       FunctionDecl::TK_FunctionTemplateSpecialization) {
1958     const TemplateParameterList *TList = FD->getTemplateSpecializationInfo()
1959                                              ->getTemplate()
1960                                              ->getTemplateParameters();
1961     return CollectTemplateParams(
1962         TList, FD->getTemplateSpecializationArgs()->asArray(), Unit);
1963   }
1964   return llvm::DINodeArray();
1965 }
1966
1967 llvm::DINodeArray CGDebugInfo::CollectVarTemplateParams(const VarDecl *VL,
1968                                                         llvm::DIFile *Unit) {
1969   // Always get the full list of parameters, not just the ones from the
1970   // specialization. A partial specialization may have fewer parameters than
1971   // there are arguments.
1972   auto *TS = dyn_cast<VarTemplateSpecializationDecl>(VL);
1973   if (!TS)
1974     return llvm::DINodeArray();
1975   VarTemplateDecl *T = TS->getSpecializedTemplate();
1976   const TemplateParameterList *TList = T->getTemplateParameters();
1977   auto TA = TS->getTemplateArgs().asArray();
1978   return CollectTemplateParams(TList, TA, Unit);
1979 }
1980
1981 llvm::DINodeArray CGDebugInfo::CollectCXXTemplateParams(
1982     const ClassTemplateSpecializationDecl *TSpecial, llvm::DIFile *Unit) {
1983   // Always get the full list of parameters, not just the ones from the
1984   // specialization. A partial specialization may have fewer parameters than
1985   // there are arguments.
1986   TemplateParameterList *TPList =
1987       TSpecial->getSpecializedTemplate()->getTemplateParameters();
1988   const TemplateArgumentList &TAList = TSpecial->getTemplateArgs();
1989   return CollectTemplateParams(TPList, TAList.asArray(), Unit);
1990 }
1991
1992 llvm::DIType *CGDebugInfo::getOrCreateVTablePtrType(llvm::DIFile *Unit) {
1993   if (VTablePtrType)
1994     return VTablePtrType;
1995
1996   ASTContext &Context = CGM.getContext();
1997
1998   /* Function type */
1999   llvm::Metadata *STy = getOrCreateType(Context.IntTy, Unit);
2000   llvm::DITypeRefArray SElements = DBuilder.getOrCreateTypeArray(STy);
2001   llvm::DIType *SubTy = DBuilder.createSubroutineType(SElements);
2002   unsigned Size = Context.getTypeSize(Context.VoidPtrTy);
2003   unsigned VtblPtrAddressSpace = CGM.getTarget().getVtblPtrAddressSpace();
2004   Optional<unsigned> DWARFAddressSpace =
2005       CGM.getTarget().getDWARFAddressSpace(VtblPtrAddressSpace);
2006
2007   llvm::DIType *vtbl_ptr_type = DBuilder.createPointerType(
2008       SubTy, Size, 0, DWARFAddressSpace, "__vtbl_ptr_type");
2009   VTablePtrType = DBuilder.createPointerType(vtbl_ptr_type, Size);
2010   return VTablePtrType;
2011 }
2012
2013 StringRef CGDebugInfo::getVTableName(const CXXRecordDecl *RD) {
2014   // Copy the gdb compatible name on the side and use its reference.
2015   return internString("_vptr$", RD->getNameAsString());
2016 }
2017
2018 StringRef CGDebugInfo::getDynamicInitializerName(const VarDecl *VD,
2019                                                  DynamicInitKind StubKind,
2020                                                  llvm::Function *InitFn) {
2021   // If we're not emitting codeview, use the mangled name. For Itanium, this is
2022   // arbitrary.
2023   if (!CGM.getCodeGenOpts().EmitCodeView)
2024     return InitFn->getName();
2025
2026   // Print the normal qualified name for the variable, then break off the last
2027   // NNS, and add the appropriate other text. Clang always prints the global
2028   // variable name without template arguments, so we can use rsplit("::") and
2029   // then recombine the pieces.
2030   SmallString<128> QualifiedGV;
2031   StringRef Quals;
2032   StringRef GVName;
2033   {
2034     llvm::raw_svector_ostream OS(QualifiedGV);
2035     VD->printQualifiedName(OS, getPrintingPolicy());
2036     std::tie(Quals, GVName) = OS.str().rsplit("::");
2037     if (GVName.empty())
2038       std::swap(Quals, GVName);
2039   }
2040
2041   SmallString<128> InitName;
2042   llvm::raw_svector_ostream OS(InitName);
2043   if (!Quals.empty())
2044     OS << Quals << "::";
2045
2046   switch (StubKind) {
2047   case DynamicInitKind::NoStub:
2048     llvm_unreachable("not an initializer");
2049   case DynamicInitKind::Initializer:
2050     OS << "`dynamic initializer for '";
2051     break;
2052   case DynamicInitKind::AtExit:
2053     OS << "`dynamic atexit destructor for '";
2054     break;
2055   }
2056
2057   OS << GVName;
2058
2059   // Add any template specialization args.
2060   if (const auto *VTpl = dyn_cast<VarTemplateSpecializationDecl>(VD)) {
2061     printTemplateArgumentList(OS, VTpl->getTemplateArgs().asArray(),
2062                               getPrintingPolicy());
2063   }
2064
2065   OS << '\'';
2066
2067   return internString(OS.str());
2068 }
2069
2070 void CGDebugInfo::CollectVTableInfo(const CXXRecordDecl *RD, llvm::DIFile *Unit,
2071                                     SmallVectorImpl<llvm::Metadata *> &EltTys,
2072                                     llvm::DICompositeType *RecordTy) {
2073   // If this class is not dynamic then there is not any vtable info to collect.
2074   if (!RD->isDynamicClass())
2075     return;
2076
2077   // Don't emit any vtable shape or vptr info if this class doesn't have an
2078   // extendable vfptr. This can happen if the class doesn't have virtual
2079   // methods, or in the MS ABI if those virtual methods only come from virtually
2080   // inherited bases.
2081   const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
2082   if (!RL.hasExtendableVFPtr())
2083     return;
2084
2085   // CodeView needs to know how large the vtable of every dynamic class is, so
2086   // emit a special named pointer type into the element list. The vptr type
2087   // points to this type as well.
2088   llvm::DIType *VPtrTy = nullptr;
2089   bool NeedVTableShape = CGM.getCodeGenOpts().EmitCodeView &&
2090                          CGM.getTarget().getCXXABI().isMicrosoft();
2091   if (NeedVTableShape) {
2092     uint64_t PtrWidth =
2093         CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
2094     const VTableLayout &VFTLayout =
2095         CGM.getMicrosoftVTableContext().getVFTableLayout(RD, CharUnits::Zero());
2096     unsigned VSlotCount =
2097         VFTLayout.vtable_components().size() - CGM.getLangOpts().RTTIData;
2098     unsigned VTableWidth = PtrWidth * VSlotCount;
2099     unsigned VtblPtrAddressSpace = CGM.getTarget().getVtblPtrAddressSpace();
2100     Optional<unsigned> DWARFAddressSpace =
2101         CGM.getTarget().getDWARFAddressSpace(VtblPtrAddressSpace);
2102
2103     // Create a very wide void* type and insert it directly in the element list.
2104     llvm::DIType *VTableType = DBuilder.createPointerType(
2105         nullptr, VTableWidth, 0, DWARFAddressSpace, "__vtbl_ptr_type");
2106     EltTys.push_back(VTableType);
2107
2108     // The vptr is a pointer to this special vtable type.
2109     VPtrTy = DBuilder.createPointerType(VTableType, PtrWidth);
2110   }
2111
2112   // If there is a primary base then the artificial vptr member lives there.
2113   if (RL.getPrimaryBase())
2114     return;
2115
2116   if (!VPtrTy)
2117     VPtrTy = getOrCreateVTablePtrType(Unit);
2118
2119   unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
2120   llvm::DIType *VPtrMember =
2121       DBuilder.createMemberType(Unit, getVTableName(RD), Unit, 0, Size, 0, 0,
2122                                 llvm::DINode::FlagArtificial, VPtrTy);
2123   EltTys.push_back(VPtrMember);
2124 }
2125
2126 llvm::DIType *CGDebugInfo::getOrCreateRecordType(QualType RTy,
2127                                                  SourceLocation Loc) {
2128   assert(CGM.getCodeGenOpts().hasReducedDebugInfo());
2129   llvm::DIType *T = getOrCreateType(RTy, getOrCreateFile(Loc));
2130   return T;
2131 }
2132
2133 llvm::DIType *CGDebugInfo::getOrCreateInterfaceType(QualType D,
2134                                                     SourceLocation Loc) {
2135   return getOrCreateStandaloneType(D, Loc);
2136 }
2137
2138 llvm::DIType *CGDebugInfo::getOrCreateStandaloneType(QualType D,
2139                                                      SourceLocation Loc) {
2140   assert(CGM.getCodeGenOpts().hasReducedDebugInfo());
2141   assert(!D.isNull() && "null type");
2142   llvm::DIType *T = getOrCreateType(D, getOrCreateFile(Loc));
2143   assert(T && "could not create debug info for type");
2144
2145   RetainedTypes.push_back(D.getAsOpaquePtr());
2146   return T;
2147 }
2148
2149 void CGDebugInfo::addHeapAllocSiteMetadata(llvm::CallBase *CI,
2150                                            QualType AllocatedTy,
2151                                            SourceLocation Loc) {
2152   llvm::MDNode *node;
2153   if (AllocatedTy->isVoidType())
2154     node = llvm::MDNode::get(CGM.getLLVMContext(), None);
2155   else
2156     node = getOrCreateType(AllocatedTy, getOrCreateFile(Loc));
2157
2158   CI->setMetadata("heapallocsite", node);
2159 }
2160
2161 void CGDebugInfo::completeType(const EnumDecl *ED) {
2162   if (DebugKind <= codegenoptions::DebugLineTablesOnly)
2163     return;
2164   QualType Ty = CGM.getContext().getEnumType(ED);
2165   void *TyPtr = Ty.getAsOpaquePtr();
2166   auto I = TypeCache.find(TyPtr);
2167   if (I == TypeCache.end() || !cast<llvm::DIType>(I->second)->isForwardDecl())
2168     return;
2169   llvm::DIType *Res = CreateTypeDefinition(Ty->castAs<EnumType>());
2170   assert(!Res->isForwardDecl());
2171   TypeCache[TyPtr].reset(Res);
2172 }
2173
2174 void CGDebugInfo::completeType(const RecordDecl *RD) {
2175   if (DebugKind > codegenoptions::LimitedDebugInfo ||
2176       !CGM.getLangOpts().CPlusPlus)
2177     completeRequiredType(RD);
2178 }
2179
2180 /// Return true if the class or any of its methods are marked dllimport.
2181 static bool isClassOrMethodDLLImport(const CXXRecordDecl *RD) {
2182   if (RD->hasAttr<DLLImportAttr>())
2183     return true;
2184   for (const CXXMethodDecl *MD : RD->methods())
2185     if (MD->hasAttr<DLLImportAttr>())
2186       return true;
2187   return false;
2188 }
2189
2190 /// Does a type definition exist in an imported clang module?
2191 static bool isDefinedInClangModule(const RecordDecl *RD) {
2192   // Only definitions that where imported from an AST file come from a module.
2193   if (!RD || !RD->isFromASTFile())
2194     return false;
2195   // Anonymous entities cannot be addressed. Treat them as not from module.
2196   if (!RD->isExternallyVisible() && RD->getName().empty())
2197     return false;
2198   if (auto *CXXDecl = dyn_cast<CXXRecordDecl>(RD)) {
2199     if (!CXXDecl->isCompleteDefinition())
2200       return false;
2201     // Check wether RD is a template.
2202     auto TemplateKind = CXXDecl->getTemplateSpecializationKind();
2203     if (TemplateKind != TSK_Undeclared) {
2204       // Unfortunately getOwningModule() isn't accurate enough to find the
2205       // owning module of a ClassTemplateSpecializationDecl that is inside a
2206       // namespace spanning multiple modules.
2207       bool Explicit = false;
2208       if (auto *TD = dyn_cast<ClassTemplateSpecializationDecl>(CXXDecl))
2209         Explicit = TD->isExplicitInstantiationOrSpecialization();
2210       if (!Explicit && CXXDecl->getEnclosingNamespaceContext())
2211         return false;
2212       // This is a template, check the origin of the first member.
2213       if (CXXDecl->field_begin() == CXXDecl->field_end())
2214         return TemplateKind == TSK_ExplicitInstantiationDeclaration;
2215       if (!CXXDecl->field_begin()->isFromASTFile())
2216         return false;
2217     }
2218   }
2219   return true;
2220 }
2221
2222 void CGDebugInfo::completeClassData(const RecordDecl *RD) {
2223   if (auto *CXXRD = dyn_cast<CXXRecordDecl>(RD))
2224     if (CXXRD->isDynamicClass() &&
2225         CGM.getVTableLinkage(CXXRD) ==
2226             llvm::GlobalValue::AvailableExternallyLinkage &&
2227         !isClassOrMethodDLLImport(CXXRD))
2228       return;
2229
2230   if (DebugTypeExtRefs && isDefinedInClangModule(RD->getDefinition()))
2231     return;
2232
2233   completeClass(RD);
2234 }
2235
2236 void CGDebugInfo::completeClass(const RecordDecl *RD) {
2237   if (DebugKind <= codegenoptions::DebugLineTablesOnly)
2238     return;
2239   QualType Ty = CGM.getContext().getRecordType(RD);
2240   void *TyPtr = Ty.getAsOpaquePtr();
2241   auto I = TypeCache.find(TyPtr);
2242   if (I != TypeCache.end() && !cast<llvm::DIType>(I->second)->isForwardDecl())
2243     return;
2244   llvm::DIType *Res = CreateTypeDefinition(Ty->castAs<RecordType>());
2245   assert(!Res->isForwardDecl());
2246   TypeCache[TyPtr].reset(Res);
2247 }
2248
2249 static bool hasExplicitMemberDefinition(CXXRecordDecl::method_iterator I,
2250                                         CXXRecordDecl::method_iterator End) {
2251   for (CXXMethodDecl *MD : llvm::make_range(I, End))
2252     if (FunctionDecl *Tmpl = MD->getInstantiatedFromMemberFunction())
2253       if (!Tmpl->isImplicit() && Tmpl->isThisDeclarationADefinition() &&
2254           !MD->getMemberSpecializationInfo()->isExplicitSpecialization())
2255         return true;
2256   return false;
2257 }
2258
2259 static bool shouldOmitDefinition(codegenoptions::DebugInfoKind DebugKind,
2260                                  bool DebugTypeExtRefs, const RecordDecl *RD,
2261                                  const LangOptions &LangOpts) {
2262   if (DebugTypeExtRefs && isDefinedInClangModule(RD->getDefinition()))
2263     return true;
2264
2265   if (auto *ES = RD->getASTContext().getExternalSource())
2266     if (ES->hasExternalDefinitions(RD) == ExternalASTSource::EK_Always)
2267       return true;
2268
2269   if (DebugKind > codegenoptions::LimitedDebugInfo)
2270     return false;
2271
2272   if (!LangOpts.CPlusPlus)
2273     return false;
2274
2275   if (!RD->isCompleteDefinitionRequired())
2276     return true;
2277
2278   const auto *CXXDecl = dyn_cast<CXXRecordDecl>(RD);
2279
2280   if (!CXXDecl)
2281     return false;
2282
2283   // Only emit complete debug info for a dynamic class when its vtable is
2284   // emitted.  However, Microsoft debuggers don't resolve type information
2285   // across DLL boundaries, so skip this optimization if the class or any of its
2286   // methods are marked dllimport. This isn't a complete solution, since objects
2287   // without any dllimport methods can be used in one DLL and constructed in
2288   // another, but it is the current behavior of LimitedDebugInfo.
2289   if (CXXDecl->hasDefinition() && CXXDecl->isDynamicClass() &&
2290       !isClassOrMethodDLLImport(CXXDecl))
2291     return true;
2292
2293   // In constructor debug mode, only emit debug info for a class when its
2294   // constructor is emitted. Skip this optimization if the class or any of
2295   // its methods are marked dllimport.
2296   if (DebugKind == codegenoptions::DebugInfoConstructor &&
2297       !CXXDecl->isLambda() && !CXXDecl->hasConstexprNonCopyMoveConstructor() &&
2298       !isClassOrMethodDLLImport(CXXDecl))
2299     for (const auto *Ctor : CXXDecl->ctors())
2300       if (Ctor->isUserProvided())
2301         return true;
2302
2303   TemplateSpecializationKind Spec = TSK_Undeclared;
2304   if (const auto *SD = dyn_cast<ClassTemplateSpecializationDecl>(RD))
2305     Spec = SD->getSpecializationKind();
2306
2307   if (Spec == TSK_ExplicitInstantiationDeclaration &&
2308       hasExplicitMemberDefinition(CXXDecl->method_begin(),
2309                                   CXXDecl->method_end()))
2310     return true;
2311
2312   return false;
2313 }
2314
2315 void CGDebugInfo::completeRequiredType(const RecordDecl *RD) {
2316   if (shouldOmitDefinition(DebugKind, DebugTypeExtRefs, RD, CGM.getLangOpts()))
2317     return;
2318
2319   QualType Ty = CGM.getContext().getRecordType(RD);
2320   llvm::DIType *T = getTypeOrNull(Ty);
2321   if (T && T->isForwardDecl())
2322     completeClassData(RD);
2323 }
2324
2325 llvm::DIType *CGDebugInfo::CreateType(const RecordType *Ty) {
2326   RecordDecl *RD = Ty->getDecl();
2327   llvm::DIType *T = cast_or_null<llvm::DIType>(getTypeOrNull(QualType(Ty, 0)));
2328   if (T || shouldOmitDefinition(DebugKind, DebugTypeExtRefs, RD,
2329                                 CGM.getLangOpts())) {
2330     if (!T)
2331       T = getOrCreateRecordFwdDecl(Ty, getDeclContextDescriptor(RD));
2332     return T;
2333   }
2334
2335   return CreateTypeDefinition(Ty);
2336 }
2337
2338 llvm::DIType *CGDebugInfo::CreateTypeDefinition(const RecordType *Ty) {
2339   RecordDecl *RD = Ty->getDecl();
2340
2341   // Get overall information about the record type for the debug info.
2342   llvm::DIFile *DefUnit = getOrCreateFile(RD->getLocation());
2343
2344   // Records and classes and unions can all be recursive.  To handle them, we
2345   // first generate a debug descriptor for the struct as a forward declaration.
2346   // Then (if it is a definition) we go through and get debug info for all of
2347   // its members.  Finally, we create a descriptor for the complete type (which
2348   // may refer to the forward decl if the struct is recursive) and replace all
2349   // uses of the forward declaration with the final definition.
2350   llvm::DICompositeType *FwdDecl = getOrCreateLimitedType(Ty, DefUnit);
2351
2352   const RecordDecl *D = RD->getDefinition();
2353   if (!D || !D->isCompleteDefinition())
2354     return FwdDecl;
2355
2356   if (const auto *CXXDecl = dyn_cast<CXXRecordDecl>(RD))
2357     CollectContainingType(CXXDecl, FwdDecl);
2358
2359   // Push the struct on region stack.
2360   LexicalBlockStack.emplace_back(&*FwdDecl);
2361   RegionMap[Ty->getDecl()].reset(FwdDecl);
2362
2363   // Convert all the elements.
2364   SmallVector<llvm::Metadata *, 16> EltTys;
2365   // what about nested types?
2366
2367   // Note: The split of CXXDecl information here is intentional, the
2368   // gdb tests will depend on a certain ordering at printout. The debug
2369   // information offsets are still correct if we merge them all together
2370   // though.
2371   const auto *CXXDecl = dyn_cast<CXXRecordDecl>(RD);
2372   if (CXXDecl) {
2373     CollectCXXBases(CXXDecl, DefUnit, EltTys, FwdDecl);
2374     CollectVTableInfo(CXXDecl, DefUnit, EltTys, FwdDecl);
2375   }
2376
2377   // Collect data fields (including static variables and any initializers).
2378   CollectRecordFields(RD, DefUnit, EltTys, FwdDecl);
2379   if (CXXDecl)
2380     CollectCXXMemberFunctions(CXXDecl, DefUnit, EltTys, FwdDecl);
2381
2382   LexicalBlockStack.pop_back();
2383   RegionMap.erase(Ty->getDecl());
2384
2385   llvm::DINodeArray Elements = DBuilder.getOrCreateArray(EltTys);
2386   DBuilder.replaceArrays(FwdDecl, Elements);
2387
2388   if (FwdDecl->isTemporary())
2389     FwdDecl =
2390         llvm::MDNode::replaceWithPermanent(llvm::TempDICompositeType(FwdDecl));
2391
2392   RegionMap[Ty->getDecl()].reset(FwdDecl);
2393   return FwdDecl;
2394 }
2395
2396 llvm::DIType *CGDebugInfo::CreateType(const ObjCObjectType *Ty,
2397                                       llvm::DIFile *Unit) {
2398   // Ignore protocols.
2399   return getOrCreateType(Ty->getBaseType(), Unit);
2400 }
2401
2402 llvm::DIType *CGDebugInfo::CreateType(const ObjCTypeParamType *Ty,
2403                                       llvm::DIFile *Unit) {
2404   // Ignore protocols.
2405   SourceLocation Loc = Ty->getDecl()->getLocation();
2406
2407   // Use Typedefs to represent ObjCTypeParamType.
2408   return DBuilder.createTypedef(
2409       getOrCreateType(Ty->getDecl()->getUnderlyingType(), Unit),
2410       Ty->getDecl()->getName(), getOrCreateFile(Loc), getLineNumber(Loc),
2411       getDeclContextDescriptor(Ty->getDecl()));
2412 }
2413
2414 /// \return true if Getter has the default name for the property PD.
2415 static bool hasDefaultGetterName(const ObjCPropertyDecl *PD,
2416                                  const ObjCMethodDecl *Getter) {
2417   assert(PD);
2418   if (!Getter)
2419     return true;
2420
2421   assert(Getter->getDeclName().isObjCZeroArgSelector());
2422   return PD->getName() ==
2423          Getter->getDeclName().getObjCSelector().getNameForSlot(0);
2424 }
2425
2426 /// \return true if Setter has the default name for the property PD.
2427 static bool hasDefaultSetterName(const ObjCPropertyDecl *PD,
2428                                  const ObjCMethodDecl *Setter) {
2429   assert(PD);
2430   if (!Setter)
2431     return true;
2432
2433   assert(Setter->getDeclName().isObjCOneArgSelector());
2434   return SelectorTable::constructSetterName(PD->getName()) ==
2435          Setter->getDeclName().getObjCSelector().getNameForSlot(0);
2436 }
2437
2438 llvm::DIType *CGDebugInfo::CreateType(const ObjCInterfaceType *Ty,
2439                                       llvm::DIFile *Unit) {
2440   ObjCInterfaceDecl *ID = Ty->getDecl();
2441   if (!ID)
2442     return nullptr;
2443
2444   // Return a forward declaration if this type was imported from a clang module,
2445   // and this is not the compile unit with the implementation of the type (which
2446   // may contain hidden ivars).
2447   if (DebugTypeExtRefs && ID->isFromASTFile() && ID->getDefinition() &&
2448       !ID->getImplementation())
2449     return DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
2450                                       ID->getName(),
2451                                       getDeclContextDescriptor(ID), Unit, 0);
2452
2453   // Get overall information about the record type for the debug info.
2454   llvm::DIFile *DefUnit = getOrCreateFile(ID->getLocation());
2455   unsigned Line = getLineNumber(ID->getLocation());
2456   auto RuntimeLang =
2457       static_cast<llvm::dwarf::SourceLanguage>(TheCU->getSourceLanguage());
2458
2459   // If this is just a forward declaration return a special forward-declaration
2460   // debug type since we won't be able to lay out the entire type.
2461   ObjCInterfaceDecl *Def = ID->getDefinition();
2462   if (!Def || !Def->getImplementation()) {
2463     llvm::DIScope *Mod = getParentModuleOrNull(ID);
2464     llvm::DIType *FwdDecl = DBuilder.createReplaceableCompositeType(
2465         llvm::dwarf::DW_TAG_structure_type, ID->getName(), Mod ? Mod : TheCU,
2466         DefUnit, Line, RuntimeLang);
2467     ObjCInterfaceCache.push_back(ObjCInterfaceCacheEntry(Ty, FwdDecl, Unit));
2468     return FwdDecl;
2469   }
2470
2471   return CreateTypeDefinition(Ty, Unit);
2472 }
2473
2474 llvm::DIModule *CGDebugInfo::getOrCreateModuleRef(ASTSourceDescriptor Mod,
2475                                                   bool CreateSkeletonCU) {
2476   // Use the Module pointer as the key into the cache. This is a
2477   // nullptr if the "Module" is a PCH, which is safe because we don't
2478   // support chained PCH debug info, so there can only be a single PCH.
2479   const Module *M = Mod.getModuleOrNull();
2480   auto ModRef = ModuleCache.find(M);
2481   if (ModRef != ModuleCache.end())
2482     return cast<llvm::DIModule>(ModRef->second);
2483
2484   // Macro definitions that were defined with "-D" on the command line.
2485   SmallString<128> ConfigMacros;
2486   {
2487     llvm::raw_svector_ostream OS(ConfigMacros);
2488     const auto &PPOpts = CGM.getPreprocessorOpts();
2489     unsigned I = 0;
2490     // Translate the macro definitions back into a command line.
2491     for (auto &M : PPOpts.Macros) {
2492       if (++I > 1)
2493         OS << " ";
2494       const std::string &Macro = M.first;
2495       bool Undef = M.second;
2496       OS << "\"-" << (Undef ? 'U' : 'D');
2497       for (char c : Macro)
2498         switch (c) {
2499         case '\\':
2500           OS << "\\\\";
2501           break;
2502         case '"':
2503           OS << "\\\"";
2504           break;
2505         default:
2506           OS << c;
2507         }
2508       OS << '\"';
2509     }
2510   }
2511
2512   bool IsRootModule = M ? !M->Parent : true;
2513   // When a module name is specified as -fmodule-name, that module gets a
2514   // clang::Module object, but it won't actually be built or imported; it will
2515   // be textual.
2516   if (CreateSkeletonCU && IsRootModule && Mod.getASTFile().empty() && M)
2517     assert(StringRef(M->Name).startswith(CGM.getLangOpts().ModuleName) &&
2518            "clang module without ASTFile must be specified by -fmodule-name");
2519
2520   // Return a StringRef to the remapped Path.
2521   auto RemapPath = [this](StringRef Path) -> std::string {
2522     std::string Remapped = remapDIPath(Path);
2523     StringRef Relative(Remapped);
2524     StringRef CompDir = TheCU->getDirectory();
2525     if (Relative.consume_front(CompDir))
2526       Relative.consume_front(llvm::sys::path::get_separator());
2527
2528     return Relative.str();
2529   };
2530
2531   if (CreateSkeletonCU && IsRootModule && !Mod.getASTFile().empty()) {
2532     // PCH files don't have a signature field in the control block,
2533     // but LLVM detects skeleton CUs by looking for a non-zero DWO id.
2534     // We use the lower 64 bits for debug info.
2535     uint64_t Signature =
2536         Mod.getSignature()
2537             ? (uint64_t)Mod.getSignature()[1] << 32 | Mod.getSignature()[0]
2538             : ~1ULL;
2539     llvm::DIBuilder DIB(CGM.getModule());
2540     SmallString<0> PCM;
2541     if (!llvm::sys::path::is_absolute(Mod.getASTFile()))
2542       PCM = Mod.getPath();
2543     llvm::sys::path::append(PCM, Mod.getASTFile());
2544     DIB.createCompileUnit(
2545         TheCU->getSourceLanguage(),
2546         // TODO: Support "Source" from external AST providers?
2547         DIB.createFile(Mod.getModuleName(), TheCU->getDirectory()),
2548         TheCU->getProducer(), false, StringRef(), 0, RemapPath(PCM),
2549         llvm::DICompileUnit::FullDebug, Signature);
2550     DIB.finalize();
2551   }
2552
2553   llvm::DIModule *Parent =
2554       IsRootModule ? nullptr
2555                    : getOrCreateModuleRef(ASTSourceDescriptor(*M->Parent),
2556                                           CreateSkeletonCU);
2557   std::string IncludePath = Mod.getPath().str();
2558   llvm::DIModule *DIMod =
2559       DBuilder.createModule(Parent, Mod.getModuleName(), ConfigMacros,
2560                             RemapPath(IncludePath));
2561   ModuleCache[M].reset(DIMod);
2562   return DIMod;
2563 }
2564
2565 llvm::DIType *CGDebugInfo::CreateTypeDefinition(const ObjCInterfaceType *Ty,
2566                                                 llvm::DIFile *Unit) {
2567   ObjCInterfaceDecl *ID = Ty->getDecl();
2568   llvm::DIFile *DefUnit = getOrCreateFile(ID->getLocation());
2569   unsigned Line = getLineNumber(ID->getLocation());
2570   unsigned RuntimeLang = TheCU->getSourceLanguage();
2571
2572   // Bit size, align and offset of the type.
2573   uint64_t Size = CGM.getContext().getTypeSize(Ty);
2574   auto Align = getTypeAlignIfRequired(Ty, CGM.getContext());
2575
2576   llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
2577   if (ID->getImplementation())
2578     Flags |= llvm::DINode::FlagObjcClassComplete;
2579
2580   llvm::DIScope *Mod = getParentModuleOrNull(ID);
2581   llvm::DICompositeType *RealDecl = DBuilder.createStructType(
2582       Mod ? Mod : Unit, ID->getName(), DefUnit, Line, Size, Align, Flags,
2583       nullptr, llvm::DINodeArray(), RuntimeLang);
2584
2585   QualType QTy(Ty, 0);
2586   TypeCache[QTy.getAsOpaquePtr()].reset(RealDecl);
2587
2588   // Push the struct on region stack.
2589   LexicalBlockStack.emplace_back(RealDecl);
2590   RegionMap[Ty->getDecl()].reset(RealDecl);
2591
2592   // Convert all the elements.
2593   SmallVector<llvm::Metadata *, 16> EltTys;
2594
2595   ObjCInterfaceDecl *SClass = ID->getSuperClass();
2596   if (SClass) {
2597     llvm::DIType *SClassTy =
2598         getOrCreateType(CGM.getContext().getObjCInterfaceType(SClass), Unit);
2599     if (!SClassTy)
2600       return nullptr;
2601
2602     llvm::DIType *InhTag = DBuilder.createInheritance(RealDecl, SClassTy, 0, 0,
2603                                                       llvm::DINode::FlagZero);
2604     EltTys.push_back(InhTag);
2605   }
2606
2607   // Create entries for all of the properties.
2608   auto AddProperty = [&](const ObjCPropertyDecl *PD) {
2609     SourceLocation Loc = PD->getLocation();
2610     llvm::DIFile *PUnit = getOrCreateFile(Loc);
2611     unsigned PLine = getLineNumber(Loc);
2612     ObjCMethodDecl *Getter = PD->getGetterMethodDecl();
2613     ObjCMethodDecl *Setter = PD->getSetterMethodDecl();
2614     llvm::MDNode *PropertyNode = DBuilder.createObjCProperty(
2615         PD->getName(), PUnit, PLine,
2616         hasDefaultGetterName(PD, Getter) ? ""
2617                                          : getSelectorName(PD->getGetterName()),
2618         hasDefaultSetterName(PD, Setter) ? ""
2619                                          : getSelectorName(PD->getSetterName()),
2620         PD->getPropertyAttributes(), getOrCreateType(PD->getType(), PUnit));
2621     EltTys.push_back(PropertyNode);
2622   };
2623   {
2624     llvm::SmallPtrSet<const IdentifierInfo *, 16> PropertySet;
2625     for (const ObjCCategoryDecl *ClassExt : ID->known_extensions())
2626       for (auto *PD : ClassExt->properties()) {
2627         PropertySet.insert(PD->getIdentifier());
2628         AddProperty(PD);
2629       }
2630     for (const auto *PD : ID->properties()) {
2631       // Don't emit duplicate metadata for properties that were already in a
2632       // class extension.
2633       if (!PropertySet.insert(PD->getIdentifier()).second)
2634         continue;
2635       AddProperty(PD);
2636     }
2637   }
2638
2639   const ASTRecordLayout &RL = CGM.getContext().getASTObjCInterfaceLayout(ID);
2640   unsigned FieldNo = 0;
2641   for (ObjCIvarDecl *Field = ID->all_declared_ivar_begin(); Field;
2642        Field = Field->getNextIvar(), ++FieldNo) {
2643     llvm::DIType *FieldTy = getOrCreateType(Field->getType(), Unit);
2644     if (!FieldTy)
2645       return nullptr;
2646
2647     StringRef FieldName = Field->getName();
2648
2649     // Ignore unnamed fields.
2650     if (FieldName.empty())
2651       continue;
2652
2653     // Get the location for the field.
2654     llvm::DIFile *FieldDefUnit = getOrCreateFile(Field->getLocation());
2655     unsigned FieldLine = getLineNumber(Field->getLocation());
2656     QualType FType = Field->getType();
2657     uint64_t FieldSize = 0;
2658     uint32_t FieldAlign = 0;
2659
2660     if (!FType->isIncompleteArrayType()) {
2661
2662       // Bit size, align and offset of the type.
2663       FieldSize = Field->isBitField()
2664                       ? Field->getBitWidthValue(CGM.getContext())
2665                       : CGM.getContext().getTypeSize(FType);
2666       FieldAlign = getTypeAlignIfRequired(FType, CGM.getContext());
2667     }
2668
2669     uint64_t FieldOffset;
2670     if (CGM.getLangOpts().ObjCRuntime.isNonFragile()) {
2671       // We don't know the runtime offset of an ivar if we're using the
2672       // non-fragile ABI.  For bitfields, use the bit offset into the first
2673       // byte of storage of the bitfield.  For other fields, use zero.
2674       if (Field->isBitField()) {
2675         FieldOffset =
2676             CGM.getObjCRuntime().ComputeBitfieldBitOffset(CGM, ID, Field);
2677         FieldOffset %= CGM.getContext().getCharWidth();
2678       } else {
2679         FieldOffset = 0;
2680       }
2681     } else {
2682       FieldOffset = RL.getFieldOffset(FieldNo);
2683     }
2684
2685     llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
2686     if (Field->getAccessControl() == ObjCIvarDecl::Protected)
2687       Flags = llvm::DINode::FlagProtected;
2688     else if (Field->getAccessControl() == ObjCIvarDecl::Private)
2689       Flags = llvm::DINode::FlagPrivate;
2690     else if (Field->getAccessControl() == ObjCIvarDecl::Public)
2691       Flags = llvm::DINode::FlagPublic;
2692
2693     llvm::MDNode *PropertyNode = nullptr;
2694     if (ObjCImplementationDecl *ImpD = ID->getImplementation()) {
2695       if (ObjCPropertyImplDecl *PImpD =
2696               ImpD->FindPropertyImplIvarDecl(Field->getIdentifier())) {
2697         if (ObjCPropertyDecl *PD = PImpD->getPropertyDecl()) {
2698           SourceLocation Loc = PD->getLocation();
2699           llvm::DIFile *PUnit = getOrCreateFile(Loc);
2700           unsigned PLine = getLineNumber(Loc);
2701           ObjCMethodDecl *Getter = PImpD->getGetterMethodDecl();
2702           ObjCMethodDecl *Setter = PImpD->getSetterMethodDecl();
2703           PropertyNode = DBuilder.createObjCProperty(
2704               PD->getName(), PUnit, PLine,
2705               hasDefaultGetterName(PD, Getter)
2706                   ? ""
2707                   : getSelectorName(PD->getGetterName()),
2708               hasDefaultSetterName(PD, Setter)
2709                   ? ""
2710                   : getSelectorName(PD->getSetterName()),
2711               PD->getPropertyAttributes(),
2712               getOrCreateType(PD->getType(), PUnit));
2713         }
2714       }
2715     }
2716     FieldTy = DBuilder.createObjCIVar(FieldName, FieldDefUnit, FieldLine,
2717                                       FieldSize, FieldAlign, FieldOffset, Flags,
2718                                       FieldTy, PropertyNode);
2719     EltTys.push_back(FieldTy);
2720   }
2721
2722   llvm::DINodeArray Elements = DBuilder.getOrCreateArray(EltTys);
2723   DBuilder.replaceArrays(RealDecl, Elements);
2724
2725   LexicalBlockStack.pop_back();
2726   return RealDecl;
2727 }
2728
2729 llvm::DIType *CGDebugInfo::CreateType(const VectorType *Ty,
2730                                       llvm::DIFile *Unit) {
2731   llvm::DIType *ElementTy = getOrCreateType(Ty->getElementType(), Unit);
2732   int64_t Count = Ty->getNumElements();
2733
2734   llvm::Metadata *Subscript;
2735   QualType QTy(Ty, 0);
2736   auto SizeExpr = SizeExprCache.find(QTy);
2737   if (SizeExpr != SizeExprCache.end())
2738     Subscript = DBuilder.getOrCreateSubrange(
2739         SizeExpr->getSecond() /*count*/, nullptr /*lowerBound*/,
2740         nullptr /*upperBound*/, nullptr /*stride*/);
2741   else {
2742     auto *CountNode =
2743         llvm::ConstantAsMetadata::get(llvm::ConstantInt::getSigned(
2744             llvm::Type::getInt64Ty(CGM.getLLVMContext()), Count ? Count : -1));
2745     Subscript = DBuilder.getOrCreateSubrange(
2746         CountNode /*count*/, nullptr /*lowerBound*/, nullptr /*upperBound*/,
2747         nullptr /*stride*/);
2748   }
2749   llvm::DINodeArray SubscriptArray = DBuilder.getOrCreateArray(Subscript);
2750
2751   uint64_t Size = CGM.getContext().getTypeSize(Ty);
2752   auto Align = getTypeAlignIfRequired(Ty, CGM.getContext());
2753
2754   return DBuilder.createVectorType(Size, Align, ElementTy, SubscriptArray);
2755 }
2756
2757 llvm::DIType *CGDebugInfo::CreateType(const ConstantMatrixType *Ty,
2758                                       llvm::DIFile *Unit) {
2759   // FIXME: Create another debug type for matrices
2760   // For the time being, it treats it like a nested ArrayType.
2761
2762   llvm::DIType *ElementTy = getOrCreateType(Ty->getElementType(), Unit);
2763   uint64_t Size = CGM.getContext().getTypeSize(Ty);
2764   uint32_t Align = getTypeAlignIfRequired(Ty, CGM.getContext());
2765
2766   // Create ranges for both dimensions.
2767   llvm::SmallVector<llvm::Metadata *, 2> Subscripts;
2768   auto *ColumnCountNode =
2769       llvm::ConstantAsMetadata::get(llvm::ConstantInt::getSigned(
2770           llvm::Type::getInt64Ty(CGM.getLLVMContext()), Ty->getNumColumns()));
2771   auto *RowCountNode =
2772       llvm::ConstantAsMetadata::get(llvm::ConstantInt::getSigned(
2773           llvm::Type::getInt64Ty(CGM.getLLVMContext()), Ty->getNumRows()));
2774   Subscripts.push_back(DBuilder.getOrCreateSubrange(
2775       ColumnCountNode /*count*/, nullptr /*lowerBound*/, nullptr /*upperBound*/,
2776       nullptr /*stride*/));
2777   Subscripts.push_back(DBuilder.getOrCreateSubrange(
2778       RowCountNode /*count*/, nullptr /*lowerBound*/, nullptr /*upperBound*/,
2779       nullptr /*stride*/));
2780   llvm::DINodeArray SubscriptArray = DBuilder.getOrCreateArray(Subscripts);
2781   return DBuilder.createArrayType(Size, Align, ElementTy, SubscriptArray);
2782 }
2783
2784 llvm::DIType *CGDebugInfo::CreateType(const ArrayType *Ty, llvm::DIFile *Unit) {
2785   uint64_t Size;
2786   uint32_t Align;
2787
2788   // FIXME: make getTypeAlign() aware of VLAs and incomplete array types
2789   if (const auto *VAT = dyn_cast<VariableArrayType>(Ty)) {
2790     Size = 0;
2791     Align = getTypeAlignIfRequired(CGM.getContext().getBaseElementType(VAT),
2792                                    CGM.getContext());
2793   } else if (Ty->isIncompleteArrayType()) {
2794     Size = 0;
2795     if (Ty->getElementType()->isIncompleteType())
2796       Align = 0;
2797     else
2798       Align = getTypeAlignIfRequired(Ty->getElementType(), CGM.getContext());
2799   } else if (Ty->isIncompleteType()) {
2800     Size = 0;
2801     Align = 0;
2802   } else {
2803     // Size and align of the whole array, not the element type.
2804     Size = CGM.getContext().getTypeSize(Ty);
2805     Align = getTypeAlignIfRequired(Ty, CGM.getContext());
2806   }
2807
2808   // Add the dimensions of the array.  FIXME: This loses CV qualifiers from
2809   // interior arrays, do we care?  Why aren't nested arrays represented the
2810   // obvious/recursive way?
2811   SmallVector<llvm::Metadata *, 8> Subscripts;
2812   QualType EltTy(Ty, 0);
2813   while ((Ty = dyn_cast<ArrayType>(EltTy))) {
2814     // If the number of elements is known, then count is that number. Otherwise,
2815     // it's -1. This allows us to represent a subrange with an array of 0
2816     // elements, like this:
2817     //
2818     //   struct foo {
2819     //     int x[0];
2820     //   };
2821     int64_t Count = -1; // Count == -1 is an unbounded array.
2822     if (const auto *CAT = dyn_cast<ConstantArrayType>(Ty))
2823       Count = CAT->getSize().getZExtValue();
2824     else if (const auto *VAT = dyn_cast<VariableArrayType>(Ty)) {
2825       if (Expr *Size = VAT->getSizeExpr()) {
2826         Expr::EvalResult Result;
2827         if (Size->EvaluateAsInt(Result, CGM.getContext()))
2828           Count = Result.Val.getInt().getExtValue();
2829       }
2830     }
2831
2832     auto SizeNode = SizeExprCache.find(EltTy);
2833     if (SizeNode != SizeExprCache.end())
2834       Subscripts.push_back(DBuilder.getOrCreateSubrange(
2835           SizeNode->getSecond() /*count*/, nullptr /*lowerBound*/,
2836           nullptr /*upperBound*/, nullptr /*stride*/));
2837     else {
2838       auto *CountNode =
2839           llvm::ConstantAsMetadata::get(llvm::ConstantInt::getSigned(
2840               llvm::Type::getInt64Ty(CGM.getLLVMContext()), Count));
2841       Subscripts.push_back(DBuilder.getOrCreateSubrange(
2842           CountNode /*count*/, nullptr /*lowerBound*/, nullptr /*upperBound*/,
2843           nullptr /*stride*/));
2844     }
2845     EltTy = Ty->getElementType();
2846   }
2847
2848   llvm::DINodeArray SubscriptArray = DBuilder.getOrCreateArray(Subscripts);
2849
2850   return DBuilder.createArrayType(Size, Align, getOrCreateType(EltTy, Unit),
2851                                   SubscriptArray);
2852 }
2853
2854 llvm::DIType *CGDebugInfo::CreateType(const LValueReferenceType *Ty,
2855                                       llvm::DIFile *Unit) {
2856   return CreatePointerLikeType(llvm::dwarf::DW_TAG_reference_type, Ty,
2857                                Ty->getPointeeType(), Unit);
2858 }
2859
2860 llvm::DIType *CGDebugInfo::CreateType(const RValueReferenceType *Ty,
2861                                       llvm::DIFile *Unit) {
2862   return CreatePointerLikeType(llvm::dwarf::DW_TAG_rvalue_reference_type, Ty,
2863                                Ty->getPointeeType(), Unit);
2864 }
2865
2866 llvm::DIType *CGDebugInfo::CreateType(const MemberPointerType *Ty,
2867                                       llvm::DIFile *U) {
2868   llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
2869   uint64_t Size = 0;
2870
2871   if (!Ty->isIncompleteType()) {
2872     Size = CGM.getContext().getTypeSize(Ty);
2873
2874     // Set the MS inheritance model. There is no flag for the unspecified model.
2875     if (CGM.getTarget().getCXXABI().isMicrosoft()) {
2876       switch (Ty->getMostRecentCXXRecordDecl()->getMSInheritanceModel()) {
2877       case MSInheritanceModel::Single:
2878         Flags |= llvm::DINode::FlagSingleInheritance;
2879         break;
2880       case MSInheritanceModel::Multiple:
2881         Flags |= llvm::DINode::FlagMultipleInheritance;
2882         break;
2883       case MSInheritanceModel::Virtual:
2884         Flags |= llvm::DINode::FlagVirtualInheritance;
2885         break;
2886       case MSInheritanceModel::Unspecified:
2887         break;
2888       }
2889     }
2890   }
2891
2892   llvm::DIType *ClassType = getOrCreateType(QualType(Ty->getClass(), 0), U);
2893   if (Ty->isMemberDataPointerType())
2894     return DBuilder.createMemberPointerType(
2895         getOrCreateType(Ty->getPointeeType(), U), ClassType, Size, /*Align=*/0,
2896         Flags);
2897
2898   const FunctionProtoType *FPT =
2899       Ty->getPointeeType()->getAs<FunctionProtoType>();
2900   return DBuilder.createMemberPointerType(
2901       getOrCreateInstanceMethodType(
2902           CXXMethodDecl::getThisType(FPT, Ty->getMostRecentCXXRecordDecl()),
2903           FPT, U, false),
2904       ClassType, Size, /*Align=*/0, Flags);
2905 }
2906
2907 llvm::DIType *CGDebugInfo::CreateType(const AtomicType *Ty, llvm::DIFile *U) {
2908   auto *FromTy = getOrCreateType(Ty->getValueType(), U);
2909   return DBuilder.createQualifiedType(llvm::dwarf::DW_TAG_atomic_type, FromTy);
2910 }
2911
2912 llvm::DIType *CGDebugInfo::CreateType(const PipeType *Ty, llvm::DIFile *U) {
2913   return getOrCreateType(Ty->getElementType(), U);
2914 }
2915
2916 llvm::DIType *CGDebugInfo::CreateEnumType(const EnumType *Ty) {
2917   const EnumDecl *ED = Ty->getDecl();
2918
2919   uint64_t Size = 0;
2920   uint32_t Align = 0;
2921   if (!ED->getTypeForDecl()->isIncompleteType()) {
2922     Size = CGM.getContext().getTypeSize(ED->getTypeForDecl());
2923     Align = getDeclAlignIfRequired(ED, CGM.getContext());
2924   }
2925
2926   SmallString<256> Identifier = getTypeIdentifier(Ty, CGM, TheCU);
2927
2928   bool isImportedFromModule =
2929       DebugTypeExtRefs && ED->isFromASTFile() && ED->getDefinition();
2930
2931   // If this is just a forward declaration, construct an appropriately
2932   // marked node and just return it.
2933   if (isImportedFromModule || !ED->getDefinition()) {
2934     // Note that it is possible for enums to be created as part of
2935     // their own declcontext. In this case a FwdDecl will be created
2936     // twice. This doesn't cause a problem because both FwdDecls are
2937     // entered into the ReplaceMap: finalize() will replace the first
2938     // FwdDecl with the second and then replace the second with
2939     // complete type.
2940     llvm::DIScope *EDContext = getDeclContextDescriptor(ED);
2941     llvm::DIFile *DefUnit = getOrCreateFile(ED->getLocation());
2942     llvm::TempDIScope TmpContext(DBuilder.createReplaceableCompositeType(
2943         llvm::dwarf::DW_TAG_enumeration_type, "", TheCU, DefUnit, 0));
2944
2945     unsigned Line = getLineNumber(ED->getLocation());
2946     StringRef EDName = ED->getName();
2947     llvm::DIType *RetTy = DBuilder.createReplaceableCompositeType(
2948         llvm::dwarf::DW_TAG_enumeration_type, EDName, EDContext, DefUnit, Line,
2949         0, Size, Align, llvm::DINode::FlagFwdDecl, Identifier);
2950
2951     ReplaceMap.emplace_back(
2952         std::piecewise_construct, std::make_tuple(Ty),
2953         std::make_tuple(static_cast<llvm::Metadata *>(RetTy)));
2954     return RetTy;
2955   }
2956
2957   return CreateTypeDefinition(Ty);
2958 }
2959
2960 llvm::DIType *CGDebugInfo::CreateTypeDefinition(const EnumType *Ty) {
2961   const EnumDecl *ED = Ty->getDecl();
2962   uint64_t Size = 0;
2963   uint32_t Align = 0;
2964   if (!ED->getTypeForDecl()->isIncompleteType()) {
2965     Size = CGM.getContext().getTypeSize(ED->getTypeForDecl());
2966     Align = getDeclAlignIfRequired(ED, CGM.getContext());
2967   }
2968
2969   SmallString<256> Identifier = getTypeIdentifier(Ty, CGM, TheCU);
2970
2971   // Create elements for each enumerator.
2972   SmallVector<llvm::Metadata *, 16> Enumerators;
2973   ED = ED->getDefinition();
2974   bool IsSigned = ED->getIntegerType()->isSignedIntegerType();
2975   for (const auto *Enum : ED->enumerators()) {
2976     const auto &InitVal = Enum->getInitVal();
2977     auto Value = IsSigned ? InitVal.getSExtValue() : InitVal.getZExtValue();
2978     Enumerators.push_back(
2979         DBuilder.createEnumerator(Enum->getName(), Value, !IsSigned));
2980   }
2981
2982   // Return a CompositeType for the enum itself.
2983   llvm::DINodeArray EltArray = DBuilder.getOrCreateArray(Enumerators);
2984
2985   llvm::DIFile *DefUnit = getOrCreateFile(ED->getLocation());
2986   unsigned Line = getLineNumber(ED->getLocation());
2987   llvm::DIScope *EnumContext = getDeclContextDescriptor(ED);
2988   llvm::DIType *ClassTy = getOrCreateType(ED->getIntegerType(), DefUnit);
2989   return DBuilder.createEnumerationType(EnumContext, ED->getName(), DefUnit,
2990                                         Line, Size, Align, EltArray, ClassTy,
2991                                         Identifier, ED->isScoped());
2992 }
2993
2994 llvm::DIMacro *CGDebugInfo::CreateMacro(llvm::DIMacroFile *Parent,
2995                                         unsigned MType, SourceLocation LineLoc,
2996                                         StringRef Name, StringRef Value) {
2997   unsigned Line = LineLoc.isInvalid() ? 0 : getLineNumber(LineLoc);
2998   return DBuilder.createMacro(Parent, Line, MType, Name, Value);
2999 }
3000
3001 llvm::DIMacroFile *CGDebugInfo::CreateTempMacroFile(llvm::DIMacroFile *Parent,
3002                                                     SourceLocation LineLoc,
3003                                                     SourceLocation FileLoc) {
3004   llvm::DIFile *FName = getOrCreateFile(FileLoc);
3005   unsigned Line = LineLoc.isInvalid() ? 0 : getLineNumber(LineLoc);
3006   return DBuilder.createTempMacroFile(Parent, Line, FName);
3007 }
3008
3009 static QualType UnwrapTypeForDebugInfo(QualType T, const ASTContext &C) {
3010   Qualifiers Quals;
3011   do {
3012     Qualifiers InnerQuals = T.getLocalQualifiers();
3013     // Qualifiers::operator+() doesn't like it if you add a Qualifier
3014     // that is already there.
3015     Quals += Qualifiers::removeCommonQualifiers(Quals, InnerQuals);
3016     Quals += InnerQuals;
3017     QualType LastT = T;
3018     switch (T->getTypeClass()) {
3019     default:
3020       return C.getQualifiedType(T.getTypePtr(), Quals);
3021     case Type::TemplateSpecialization: {
3022       const auto *Spec = cast<TemplateSpecializationType>(T);
3023       if (Spec->isTypeAlias())
3024         return C.getQualifiedType(T.getTypePtr(), Quals);
3025       T = Spec->desugar();
3026       break;
3027     }
3028     case Type::TypeOfExpr:
3029       T = cast<TypeOfExprType>(T)->getUnderlyingExpr()->getType();
3030       break;
3031     case Type::TypeOf:
3032       T = cast<TypeOfType>(T)->getUnderlyingType();
3033       break;
3034     case Type::Decltype:
3035       T = cast<DecltypeType>(T)->getUnderlyingType();
3036       break;
3037     case Type::UnaryTransform:
3038       T = cast<UnaryTransformType>(T)->getUnderlyingType();
3039       break;
3040     case Type::Attributed:
3041       T = cast<AttributedType>(T)->getEquivalentType();
3042       break;
3043     case Type::Elaborated:
3044       T = cast<ElaboratedType>(T)->getNamedType();
3045       break;
3046     case Type::Paren:
3047       T = cast<ParenType>(T)->getInnerType();
3048       break;
3049     case Type::MacroQualified:
3050       T = cast<MacroQualifiedType>(T)->getUnderlyingType();
3051       break;
3052     case Type::SubstTemplateTypeParm:
3053       T = cast<SubstTemplateTypeParmType>(T)->getReplacementType();
3054       break;
3055     case Type::Auto:
3056     case Type::DeducedTemplateSpecialization: {
3057       QualType DT = cast<DeducedType>(T)->getDeducedType();
3058       assert(!DT.isNull() && "Undeduced types shouldn't reach here.");
3059       T = DT;
3060       break;
3061     }
3062     case Type::Adjusted:
3063     case Type::Decayed:
3064       // Decayed and adjusted types use the adjusted type in LLVM and DWARF.
3065       T = cast<AdjustedType>(T)->getAdjustedType();
3066       break;
3067     }
3068
3069     assert(T != LastT && "Type unwrapping failed to unwrap!");
3070     (void)LastT;
3071   } while (true);
3072 }
3073
3074 llvm::DIType *CGDebugInfo::getTypeOrNull(QualType Ty) {
3075
3076   // Unwrap the type as needed for debug information.
3077   Ty = UnwrapTypeForDebugInfo(Ty, CGM.getContext());
3078
3079   auto It = TypeCache.find(Ty.getAsOpaquePtr());
3080   if (It != TypeCache.end()) {
3081     // Verify that the debug info still exists.
3082     if (llvm::Metadata *V = It->second)
3083       return cast<llvm::DIType>(V);
3084   }
3085
3086   return nullptr;
3087 }
3088
3089 void CGDebugInfo::completeTemplateDefinition(
3090     const ClassTemplateSpecializationDecl &SD) {
3091   if (DebugKind <= codegenoptions::DebugLineTablesOnly)
3092     return;
3093   completeUnusedClass(SD);
3094 }
3095
3096 void CGDebugInfo::completeUnusedClass(const CXXRecordDecl &D) {
3097   if (DebugKind <= codegenoptions::DebugLineTablesOnly)
3098     return;
3099
3100   completeClassData(&D);
3101   // In case this type has no member function definitions being emitted, ensure
3102   // it is retained
3103   RetainedTypes.push_back(CGM.getContext().getRecordType(&D).getAsOpaquePtr());
3104 }
3105
3106 llvm::DIType *CGDebugInfo::getOrCreateType(QualType Ty, llvm::DIFile *Unit) {
3107   if (Ty.isNull())
3108     return nullptr;
3109
3110   llvm::TimeTraceScope TimeScope("DebugType", [&]() {
3111     std::string Name;
3112     llvm::raw_string_ostream OS(Name);
3113     Ty.print(OS, getPrintingPolicy());
3114     return Name;
3115   });
3116
3117   // Unwrap the type as needed for debug information.
3118   Ty = UnwrapTypeForDebugInfo(Ty, CGM.getContext());
3119
3120   if (auto *T = getTypeOrNull(Ty))
3121     return T;
3122
3123   llvm::DIType *Res = CreateTypeNode(Ty, Unit);
3124   void *TyPtr = Ty.getAsOpaquePtr();
3125
3126   // And update the type cache.
3127   TypeCache[TyPtr].reset(Res);
3128
3129   return Res;
3130 }
3131
3132 llvm::DIModule *CGDebugInfo::getParentModuleOrNull(const Decl *D) {
3133   // A forward declaration inside a module header does not belong to the module.
3134   if (isa<RecordDecl>(D) && !cast<RecordDecl>(D)->getDefinition())
3135     return nullptr;
3136   if (DebugTypeExtRefs && D->isFromASTFile()) {
3137     // Record a reference to an imported clang module or precompiled header.
3138     auto *Reader = CGM.getContext().getExternalSource();
3139     auto Idx = D->getOwningModuleID();
3140     auto Info = Reader->getSourceDescriptor(Idx);
3141     if (Info)
3142       return getOrCreateModuleRef(*Info, /*SkeletonCU=*/true);
3143   } else if (ClangModuleMap) {
3144     // We are building a clang module or a precompiled header.
3145     //
3146     // TODO: When D is a CXXRecordDecl or a C++ Enum, the ODR applies
3147     // and it wouldn't be necessary to specify the parent scope
3148     // because the type is already unique by definition (it would look
3149     // like the output of -fno-standalone-debug). On the other hand,
3150     // the parent scope helps a consumer to quickly locate the object
3151     // file where the type's definition is located, so it might be
3152     // best to make this behavior a command line or debugger tuning
3153     // option.
3154     if (Module *M = D->getOwningModule()) {
3155       // This is a (sub-)module.
3156       auto Info = ASTSourceDescriptor(*M);
3157       return getOrCreateModuleRef(Info, /*SkeletonCU=*/false);
3158     } else {
3159       // This the precompiled header being built.
3160       return getOrCreateModuleRef(PCHDescriptor, /*SkeletonCU=*/false);
3161     }
3162   }
3163
3164   return nullptr;
3165 }
3166
3167 llvm::DIType *CGDebugInfo::CreateTypeNode(QualType Ty, llvm::DIFile *Unit) {
3168   // Handle qualifiers, which recursively handles what they refer to.
3169   if (Ty.hasLocalQualifiers())
3170     return CreateQualifiedType(Ty, Unit);
3171
3172   // Work out details of type.
3173   switch (Ty->getTypeClass()) {
3174 #define TYPE(Class, Base)
3175 #define ABSTRACT_TYPE(Class, Base)
3176 #define NON_CANONICAL_TYPE(Class, Base)
3177 #define DEPENDENT_TYPE(Class, Base) case Type::Class:
3178 #include "clang/AST/TypeNodes.inc"
3179     llvm_unreachable("Dependent types cannot show up in debug information");
3180
3181   case Type::ExtVector:
3182   case Type::Vector:
3183     return CreateType(cast<VectorType>(Ty), Unit);
3184   case Type::ConstantMatrix:
3185     return CreateType(cast<ConstantMatrixType>(Ty), Unit);
3186   case Type::ObjCObjectPointer:
3187     return CreateType(cast<ObjCObjectPointerType>(Ty), Unit);
3188   case Type::ObjCObject:
3189     return CreateType(cast<ObjCObjectType>(Ty), Unit);
3190   case Type::ObjCTypeParam:
3191     return CreateType(cast<ObjCTypeParamType>(Ty), Unit);
3192   case Type::ObjCInterface:
3193     return CreateType(cast<ObjCInterfaceType>(Ty), Unit);
3194   case Type::Builtin:
3195     return CreateType(cast<BuiltinType>(Ty));
3196   case Type::Complex:
3197     return CreateType(cast<ComplexType>(Ty));
3198   case Type::Pointer:
3199     return CreateType(cast<PointerType>(Ty), Unit);
3200   case Type::BlockPointer:
3201     return CreateType(cast<BlockPointerType>(Ty), Unit);
3202   case Type::Typedef:
3203     return CreateType(cast<TypedefType>(Ty), Unit);
3204   case Type::Record:
3205     return CreateType(cast<RecordType>(Ty));
3206   case Type::Enum:
3207     return CreateEnumType(cast<EnumType>(Ty));
3208   case Type::FunctionProto:
3209   case Type::FunctionNoProto:
3210     return CreateType(cast<FunctionType>(Ty), Unit);
3211   case Type::ConstantArray:
3212   case Type::VariableArray:
3213   case Type::IncompleteArray:
3214     return CreateType(cast<ArrayType>(Ty), Unit);
3215
3216   case Type::LValueReference:
3217     return CreateType(cast<LValueReferenceType>(Ty), Unit);
3218   case Type::RValueReference:
3219     return CreateType(cast<RValueReferenceType>(Ty), Unit);
3220
3221   case Type::MemberPointer:
3222     return CreateType(cast<MemberPointerType>(Ty), Unit);
3223
3224   case Type::Atomic:
3225     return CreateType(cast<AtomicType>(Ty), Unit);
3226
3227   case Type::ExtInt:
3228     return CreateType(cast<ExtIntType>(Ty));
3229   case Type::Pipe:
3230     return CreateType(cast<PipeType>(Ty), Unit);
3231
3232   case Type::TemplateSpecialization:
3233     return CreateType(cast<TemplateSpecializationType>(Ty), Unit);
3234
3235   case Type::Auto:
3236   case Type::Attributed:
3237   case Type::Adjusted:
3238   case Type::Decayed:
3239   case Type::DeducedTemplateSpecialization:
3240   case Type::Elaborated:
3241   case Type::Paren:
3242   case Type::MacroQualified:
3243   case Type::SubstTemplateTypeParm:
3244   case Type::TypeOfExpr:
3245   case Type::TypeOf:
3246   case Type::Decltype:
3247   case Type::UnaryTransform:
3248   case Type::PackExpansion:
3249     break;
3250   }
3251
3252   llvm_unreachable("type should have been unwrapped!");
3253 }
3254
3255 llvm::DICompositeType *CGDebugInfo::getOrCreateLimitedType(const RecordType *Ty,
3256                                                            llvm::DIFile *Unit) {
3257   QualType QTy(Ty, 0);
3258
3259   auto *T = cast_or_null<llvm::DICompositeType>(getTypeOrNull(QTy));
3260
3261   // We may have cached a forward decl when we could have created
3262   // a non-forward decl. Go ahead and create a non-forward decl
3263   // now.
3264   if (T && !T->isForwardDecl())
3265     return T;
3266
3267   // Otherwise create the type.
3268   llvm::DICompositeType *Res = CreateLimitedType(Ty);
3269
3270   // Propagate members from the declaration to the definition
3271   // CreateType(const RecordType*) will overwrite this with the members in the
3272   // correct order if the full type is needed.
3273   DBuilder.replaceArrays(Res, T ? T->getElements() : llvm::DINodeArray());
3274
3275   // And update the type cache.
3276   TypeCache[QTy.getAsOpaquePtr()].reset(Res);
3277   return Res;
3278 }
3279
3280 // TODO: Currently used for context chains when limiting debug info.
3281 llvm::DICompositeType *CGDebugInfo::CreateLimitedType(const RecordType *Ty) {
3282   RecordDecl *RD = Ty->getDecl();
3283
3284   // Get overall information about the record type for the debug info.
3285   llvm::DIFile *DefUnit = getOrCreateFile(RD->getLocation());
3286   unsigned Line = getLineNumber(RD->getLocation());
3287   StringRef RDName = getClassName(RD);
3288
3289   llvm::DIScope *RDContext = getDeclContextDescriptor(RD);
3290
3291   // If we ended up creating the type during the context chain construction,
3292   // just return that.
3293   auto *T = cast_or_null<llvm::DICompositeType>(
3294       getTypeOrNull(CGM.getContext().getRecordType(RD)));
3295   if (T && (!T->isForwardDecl() || !RD->getDefinition()))
3296     return T;
3297
3298   // If this is just a forward or incomplete declaration, construct an
3299   // appropriately marked node and just return it.
3300   const RecordDecl *D = RD->getDefinition();
3301   if (!D || !D->isCompleteDefinition())
3302     return getOrCreateRecordFwdDecl(Ty, RDContext);
3303
3304   uint64_t Size = CGM.getContext().getTypeSize(Ty);
3305   auto Align = getDeclAlignIfRequired(D, CGM.getContext());
3306
3307   SmallString<256> Identifier = getTypeIdentifier(Ty, CGM, TheCU);
3308
3309   // Explicitly record the calling convention and export symbols for C++
3310   // records.
3311   auto Flags = llvm::DINode::FlagZero;
3312   if (auto CXXRD = dyn_cast<CXXRecordDecl>(RD)) {
3313     if (CGM.getCXXABI().getRecordArgABI(CXXRD) == CGCXXABI::RAA_Indirect)
3314       Flags |= llvm::DINode::FlagTypePassByReference;
3315     else
3316       Flags |= llvm::DINode::FlagTypePassByValue;
3317
3318     // Record if a C++ record is non-trivial type.
3319     if (!CXXRD->isTrivial())
3320       Flags |= llvm::DINode::FlagNonTrivial;
3321
3322     // Record exports it symbols to the containing structure.
3323     if (CXXRD->isAnonymousStructOrUnion())
3324         Flags |= llvm::DINode::FlagExportSymbols;
3325   }
3326
3327   llvm::DICompositeType *RealDecl = DBuilder.createReplaceableCompositeType(
3328       getTagForRecord(RD), RDName, RDContext, DefUnit, Line, 0, Size, Align,
3329       Flags, Identifier);
3330
3331   // Elements of composite types usually have back to the type, creating
3332   // uniquing cycles.  Distinct nodes are more efficient.
3333   switch (RealDecl->getTag()) {
3334   default:
3335     llvm_unreachable("invalid composite type tag");
3336
3337   case llvm::dwarf::DW_TAG_array_type:
3338   case llvm::dwarf::DW_TAG_enumeration_type:
3339     // Array elements and most enumeration elements don't have back references,
3340     // so they don't tend to be involved in uniquing cycles and there is some
3341     // chance of merging them when linking together two modules.  Only make
3342     // them distinct if they are ODR-uniqued.
3343     if (Identifier.empty())
3344       break;
3345     LLVM_FALLTHROUGH;
3346
3347   case llvm::dwarf::DW_TAG_structure_type:
3348   case llvm::dwarf::DW_TAG_union_type:
3349   case llvm::dwarf::DW_TAG_class_type:
3350     // Immediately resolve to a distinct node.
3351     RealDecl =
3352         llvm::MDNode::replaceWithDistinct(llvm::TempDICompositeType(RealDecl));
3353     break;
3354   }
3355
3356   RegionMap[Ty->getDecl()].reset(RealDecl);
3357   TypeCache[QualType(Ty, 0).getAsOpaquePtr()].reset(RealDecl);
3358
3359   if (const auto *TSpecial = dyn_cast<ClassTemplateSpecializationDecl>(RD))
3360     DBuilder.replaceArrays(RealDecl, llvm::DINodeArray(),
3361                            CollectCXXTemplateParams(TSpecial, DefUnit));
3362   return RealDecl;
3363 }
3364
3365 void CGDebugInfo::CollectContainingType(const CXXRecordDecl *RD,
3366                                         llvm::DICompositeType *RealDecl) {
3367   // A class's primary base or the class itself contains the vtable.
3368   llvm::DICompositeType *ContainingType = nullptr;
3369   const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
3370   if (const CXXRecordDecl *PBase = RL.getPrimaryBase()) {
3371     // Seek non-virtual primary base root.
3372     while (1) {
3373       const ASTRecordLayout &BRL = CGM.getContext().getASTRecordLayout(PBase);
3374       const CXXRecordDecl *PBT = BRL.getPrimaryBase();
3375       if (PBT && !BRL.isPrimaryBaseVirtual())
3376         PBase = PBT;
3377       else
3378         break;
3379     }
3380     ContainingType = cast<llvm::DICompositeType>(
3381         getOrCreateType(QualType(PBase->getTypeForDecl(), 0),
3382                         getOrCreateFile(RD->getLocation())));
3383   } else if (RD->isDynamicClass())
3384     ContainingType = RealDecl;
3385
3386   DBuilder.replaceVTableHolder(RealDecl, ContainingType);
3387 }
3388
3389 llvm::DIType *CGDebugInfo::CreateMemberType(llvm::DIFile *Unit, QualType FType,
3390                                             StringRef Name, uint64_t *Offset) {
3391   llvm::DIType *FieldTy = CGDebugInfo::getOrCreateType(FType, Unit);
3392   uint64_t FieldSize = CGM.getContext().getTypeSize(FType);
3393   auto FieldAlign = getTypeAlignIfRequired(FType, CGM.getContext());
3394   llvm::DIType *Ty =
3395       DBuilder.createMemberType(Unit, Name, Unit, 0, FieldSize, FieldAlign,
3396                                 *Offset, llvm::DINode::FlagZero, FieldTy);
3397   *Offset += FieldSize;
3398   return Ty;
3399 }
3400
3401 void CGDebugInfo::collectFunctionDeclProps(GlobalDecl GD, llvm::DIFile *Unit,
3402                                            StringRef &Name,
3403                                            StringRef &LinkageName,
3404                                            llvm::DIScope *&FDContext,
3405                                            llvm::DINodeArray &TParamsArray,
3406                                            llvm::DINode::DIFlags &Flags) {
3407   const auto *FD = cast<FunctionDecl>(GD.getDecl());
3408   Name = getFunctionName(FD);
3409   // Use mangled name as linkage name for C/C++ functions.
3410   if (FD->hasPrototype()) {
3411     LinkageName = CGM.getMangledName(GD);
3412     Flags |= llvm::DINode::FlagPrototyped;
3413   }
3414   // No need to replicate the linkage name if it isn't different from the
3415   // subprogram name, no need to have it at all unless coverage is enabled or
3416   // debug is set to more than just line tables or extra debug info is needed.
3417   if (LinkageName == Name || (!CGM.getCodeGenOpts().EmitGcovArcs &&
3418                               !CGM.getCodeGenOpts().EmitGcovNotes &&
3419                               !CGM.getCodeGenOpts().DebugInfoForProfiling &&
3420                               DebugKind <= codegenoptions::DebugLineTablesOnly))
3421     LinkageName = StringRef();
3422
3423   if (CGM.getCodeGenOpts().hasReducedDebugInfo()) {
3424     if (const NamespaceDecl *NSDecl =
3425             dyn_cast_or_null<NamespaceDecl>(FD->getDeclContext()))
3426       FDContext = getOrCreateNamespace(NSDecl);
3427     else if (const RecordDecl *RDecl =
3428                  dyn_cast_or_null<RecordDecl>(FD->getDeclContext())) {
3429       llvm::DIScope *Mod = getParentModuleOrNull(RDecl);
3430       FDContext = getContextDescriptor(RDecl, Mod ? Mod : TheCU);
3431     }
3432     // Check if it is a noreturn-marked function
3433     if (FD->isNoReturn())
3434       Flags |= llvm::DINode::FlagNoReturn;
3435     // Collect template parameters.
3436     TParamsArray = CollectFunctionTemplateParams(FD, Unit);
3437   }
3438 }
3439
3440 void CGDebugInfo::collectVarDeclProps(const VarDecl *VD, llvm::DIFile *&Unit,
3441                                       unsigned &LineNo, QualType &T,
3442                                       StringRef &Name, StringRef &LinkageName,
3443                                       llvm::MDTuple *&TemplateParameters,
3444                                       llvm::DIScope *&VDContext) {
3445   Unit = getOrCreateFile(VD->getLocation());
3446   LineNo = getLineNumber(VD->getLocation());
3447
3448   setLocation(VD->getLocation());
3449
3450   T = VD->getType();
3451   if (T->isIncompleteArrayType()) {
3452     // CodeGen turns int[] into int[1] so we'll do the same here.
3453     llvm::APInt ConstVal(32, 1);
3454     QualType ET = CGM.getContext().getAsArrayType(T)->getElementType();
3455
3456     T = CGM.getContext().getConstantArrayType(ET, ConstVal, nullptr,
3457                                               ArrayType::Normal, 0);
3458   }
3459
3460   Name = VD->getName();
3461   if (VD->getDeclContext() && !isa<FunctionDecl>(VD->getDeclContext()) &&
3462       !isa<ObjCMethodDecl>(VD->getDeclContext()))
3463     LinkageName = CGM.getMangledName(VD);
3464   if (LinkageName == Name)
3465     LinkageName = StringRef();
3466
3467   if (isa<VarTemplateSpecializationDecl>(VD)) {
3468     llvm::DINodeArray parameterNodes = CollectVarTemplateParams(VD, &*Unit);
3469     TemplateParameters = parameterNodes.get();
3470   } else {
3471     TemplateParameters = nullptr;
3472   }
3473
3474   // Since we emit declarations (DW_AT_members) for static members, place the
3475   // definition of those static members in the namespace they were declared in
3476   // in the source code (the lexical decl context).
3477   // FIXME: Generalize this for even non-member global variables where the
3478   // declaration and definition may have different lexical decl contexts, once
3479   // we have support for emitting declarations of (non-member) global variables.
3480   const DeclContext *DC = VD->isStaticDataMember() ? VD->getLexicalDeclContext()
3481                                                    : VD->getDeclContext();
3482   // When a record type contains an in-line initialization of a static data
3483   // member, and the record type is marked as __declspec(dllexport), an implicit
3484   // definition of the member will be created in the record context.  DWARF
3485   // doesn't seem to have a nice way to describe this in a form that consumers
3486   // are likely to understand, so fake the "normal" situation of a definition
3487   // outside the class by putting it in the global scope.
3488   if (DC->isRecord())
3489     DC = CGM.getContext().getTranslationUnitDecl();
3490
3491   llvm::DIScope *Mod = getParentModuleOrNull(VD);
3492   VDContext = getContextDescriptor(cast<Decl>(DC), Mod ? Mod : TheCU);
3493 }
3494
3495 llvm::DISubprogram *CGDebugInfo::getFunctionFwdDeclOrStub(GlobalDecl GD,
3496                                                           bool Stub) {
3497   llvm::DINodeArray TParamsArray;
3498   StringRef Name, LinkageName;
3499   llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
3500   llvm::DISubprogram::DISPFlags SPFlags = llvm::DISubprogram::SPFlagZero;
3501   SourceLocation Loc = GD.getDecl()->getLocation();
3502   llvm::DIFile *Unit = getOrCreateFile(Loc);
3503   llvm::DIScope *DContext = Unit;
3504   unsigned Line = getLineNumber(Loc);
3505   collectFunctionDeclProps(GD, Unit, Name, LinkageName, DContext, TParamsArray,
3506                            Flags);
3507   auto *FD = cast<FunctionDecl>(GD.getDecl());
3508
3509   // Build function type.
3510   SmallVector<QualType, 16> ArgTypes;
3511   for (const ParmVarDecl *Parm : FD->parameters())
3512     ArgTypes.push_back(Parm->getType());
3513
3514   CallingConv CC = FD->getType()->castAs<FunctionType>()->getCallConv();
3515   QualType FnType = CGM.getContext().getFunctionType(
3516       FD->getReturnType(), ArgTypes, FunctionProtoType::ExtProtoInfo(CC));
3517   if (!FD->isExternallyVisible())
3518     SPFlags |= llvm::DISubprogram::SPFlagLocalToUnit;
3519   if (CGM.getLangOpts().Optimize)
3520     SPFlags |= llvm::DISubprogram::SPFlagOptimized;
3521
3522   if (Stub) {
3523     Flags |= getCallSiteRelatedAttrs();
3524     SPFlags |= llvm::DISubprogram::SPFlagDefinition;
3525     return DBuilder.createFunction(
3526         DContext, Name, LinkageName, Unit, Line,
3527         getOrCreateFunctionType(GD.getDecl(), FnType, Unit), 0, Flags, SPFlags,
3528         TParamsArray.get(), getFunctionDeclaration(FD));
3529   }
3530
3531   llvm::DISubprogram *SP = DBuilder.createTempFunctionFwdDecl(
3532       DContext, Name, LinkageName, Unit, Line,
3533       getOrCreateFunctionType(GD.getDecl(), FnType, Unit), 0, Flags, SPFlags,
3534       TParamsArray.get(), getFunctionDeclaration(FD));
3535   const FunctionDecl *CanonDecl = FD->getCanonicalDecl();
3536   FwdDeclReplaceMap.emplace_back(std::piecewise_construct,
3537                                  std::make_tuple(CanonDecl),
3538                                  std::make_tuple(SP));
3539   return SP;
3540 }
3541
3542 llvm::DISubprogram *CGDebugInfo::getFunctionForwardDeclaration(GlobalDecl GD) {
3543   return getFunctionFwdDeclOrStub(GD, /* Stub = */ false);
3544 }
3545
3546 llvm::DISubprogram *CGDebugInfo::getFunctionStub(GlobalDecl GD) {
3547   return getFunctionFwdDeclOrStub(GD, /* Stub = */ true);
3548 }
3549
3550 llvm::DIGlobalVariable *
3551 CGDebugInfo::getGlobalVariableForwardDeclaration(const VarDecl *VD) {
3552   QualType T;
3553   StringRef Name, LinkageName;
3554   SourceLocation Loc = VD->getLocation();
3555   llvm::DIFile *Unit = getOrCreateFile(Loc);
3556   llvm::DIScope *DContext = Unit;
3557   unsigned Line = getLineNumber(Loc);
3558   llvm::MDTuple *TemplateParameters = nullptr;
3559
3560   collectVarDeclProps(VD, Unit, Line, T, Name, LinkageName, TemplateParameters,
3561                       DContext);
3562   auto Align = getDeclAlignIfRequired(VD, CGM.getContext());
3563   auto *GV = DBuilder.createTempGlobalVariableFwdDecl(
3564       DContext, Name, LinkageName, Unit, Line, getOrCreateType(T, Unit),
3565       !VD->isExternallyVisible(), nullptr, TemplateParameters, Align);
3566   FwdDeclReplaceMap.emplace_back(
3567       std::piecewise_construct,
3568       std::make_tuple(cast<VarDecl>(VD->getCanonicalDecl())),
3569       std::make_tuple(static_cast<llvm::Metadata *>(GV)));