1 //===--- CGDebugInfo.cpp - Emit Debug Information for a Module ------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This coordinates the debug information generation while generating code.
12 //===----------------------------------------------------------------------===//
14 #include "CGDebugInfo.h"
17 #include "CGObjCRuntime.h"
18 #include "CGRecordLayout.h"
19 #include "CodeGenFunction.h"
20 #include "CodeGenModule.h"
21 #include "ConstantEmitter.h"
22 #include "clang/AST/ASTContext.h"
23 #include "clang/AST/DeclFriend.h"
24 #include "clang/AST/DeclObjC.h"
25 #include "clang/AST/DeclTemplate.h"
26 #include "clang/AST/Expr.h"
27 #include "clang/AST/RecordLayout.h"
28 #include "clang/Basic/FileManager.h"
29 #include "clang/Basic/SourceManager.h"
30 #include "clang/Basic/Version.h"
31 #include "clang/Frontend/CodeGenOptions.h"
32 #include "clang/Frontend/FrontendOptions.h"
33 #include "clang/Lex/HeaderSearchOptions.h"
34 #include "clang/Lex/ModuleMap.h"
35 #include "clang/Lex/PreprocessorOptions.h"
36 #include "llvm/ADT/DenseSet.h"
37 #include "llvm/ADT/SmallVector.h"
38 #include "llvm/ADT/StringExtras.h"
39 #include "llvm/IR/Constants.h"
40 #include "llvm/IR/DataLayout.h"
41 #include "llvm/IR/DerivedTypes.h"
42 #include "llvm/IR/Instructions.h"
43 #include "llvm/IR/Intrinsics.h"
44 #include "llvm/IR/Module.h"
45 #include "llvm/Support/FileSystem.h"
46 #include "llvm/Support/MD5.h"
47 #include "llvm/Support/Path.h"
48 using namespace clang;
49 using namespace clang::CodeGen;
51 static uint32_t getTypeAlignIfRequired(const Type *Ty, const ASTContext &Ctx) {
52 auto TI = Ctx.getTypeInfo(Ty);
53 return TI.AlignIsRequired ? TI.Align : 0;
56 static uint32_t getTypeAlignIfRequired(QualType Ty, const ASTContext &Ctx) {
57 return getTypeAlignIfRequired(Ty.getTypePtr(), Ctx);
60 static uint32_t getDeclAlignIfRequired(const Decl *D, const ASTContext &Ctx) {
61 return D->hasAttr<AlignedAttr>() ? D->getMaxAlignment() : 0;
64 CGDebugInfo::CGDebugInfo(CodeGenModule &CGM)
65 : CGM(CGM), DebugKind(CGM.getCodeGenOpts().getDebugInfo()),
66 DebugTypeExtRefs(CGM.getCodeGenOpts().DebugTypeExtRefs),
67 DBuilder(CGM.getModule()) {
68 for (const auto &KV : CGM.getCodeGenOpts().DebugPrefixMap)
69 DebugPrefixMap[KV.first] = KV.second;
73 CGDebugInfo::~CGDebugInfo() {
74 assert(LexicalBlockStack.empty() &&
75 "Region stack mismatch, stack not empty!");
78 ApplyDebugLocation::ApplyDebugLocation(CodeGenFunction &CGF,
79 SourceLocation TemporaryLocation)
81 init(TemporaryLocation);
84 ApplyDebugLocation::ApplyDebugLocation(CodeGenFunction &CGF,
86 SourceLocation TemporaryLocation)
88 init(TemporaryLocation, DefaultToEmpty);
91 void ApplyDebugLocation::init(SourceLocation TemporaryLocation,
92 bool DefaultToEmpty) {
93 auto *DI = CGF->getDebugInfo();
99 OriginalLocation = CGF->Builder.getCurrentDebugLocation();
101 if (OriginalLocation && !DI->CGM.getExpressionLocationsEnabled())
104 if (TemporaryLocation.isValid()) {
105 DI->EmitLocation(CGF->Builder, TemporaryLocation);
109 if (DefaultToEmpty) {
110 CGF->Builder.SetCurrentDebugLocation(llvm::DebugLoc());
114 // Construct a location that has a valid scope, but no line info.
115 assert(!DI->LexicalBlockStack.empty());
116 CGF->Builder.SetCurrentDebugLocation(llvm::DebugLoc::get(
117 0, 0, DI->LexicalBlockStack.back(), DI->getInlinedAt()));
120 ApplyDebugLocation::ApplyDebugLocation(CodeGenFunction &CGF, const Expr *E)
122 init(E->getExprLoc());
125 ApplyDebugLocation::ApplyDebugLocation(CodeGenFunction &CGF, llvm::DebugLoc Loc)
127 if (!CGF.getDebugInfo()) {
131 OriginalLocation = CGF.Builder.getCurrentDebugLocation();
133 CGF.Builder.SetCurrentDebugLocation(std::move(Loc));
136 ApplyDebugLocation::~ApplyDebugLocation() {
137 // Query CGF so the location isn't overwritten when location updates are
138 // temporarily disabled (for C++ default function arguments)
140 CGF->Builder.SetCurrentDebugLocation(std::move(OriginalLocation));
143 ApplyInlineDebugLocation::ApplyInlineDebugLocation(CodeGenFunction &CGF,
144 GlobalDecl InlinedFn)
146 if (!CGF.getDebugInfo()) {
150 auto &DI = *CGF.getDebugInfo();
151 SavedLocation = DI.getLocation();
152 assert((DI.getInlinedAt() ==
153 CGF.Builder.getCurrentDebugLocation()->getInlinedAt()) &&
154 "CGDebugInfo and IRBuilder are out of sync");
156 DI.EmitInlineFunctionStart(CGF.Builder, InlinedFn);
159 ApplyInlineDebugLocation::~ApplyInlineDebugLocation() {
162 auto &DI = *CGF->getDebugInfo();
163 DI.EmitInlineFunctionEnd(CGF->Builder);
164 DI.EmitLocation(CGF->Builder, SavedLocation);
167 void CGDebugInfo::setLocation(SourceLocation Loc) {
168 // If the new location isn't valid return.
172 CurLoc = CGM.getContext().getSourceManager().getExpansionLoc(Loc);
174 // If we've changed files in the middle of a lexical scope go ahead
175 // and create a new lexical scope with file node if it's different
176 // from the one in the scope.
177 if (LexicalBlockStack.empty())
180 SourceManager &SM = CGM.getContext().getSourceManager();
181 auto *Scope = cast<llvm::DIScope>(LexicalBlockStack.back());
182 PresumedLoc PCLoc = SM.getPresumedLoc(CurLoc);
184 if (PCLoc.isInvalid() || Scope->getFilename() == PCLoc.getFilename())
187 if (auto *LBF = dyn_cast<llvm::DILexicalBlockFile>(Scope)) {
188 LexicalBlockStack.pop_back();
189 LexicalBlockStack.emplace_back(DBuilder.createLexicalBlockFile(
190 LBF->getScope(), getOrCreateFile(CurLoc)));
191 } else if (isa<llvm::DILexicalBlock>(Scope) ||
192 isa<llvm::DISubprogram>(Scope)) {
193 LexicalBlockStack.pop_back();
194 LexicalBlockStack.emplace_back(
195 DBuilder.createLexicalBlockFile(Scope, getOrCreateFile(CurLoc)));
199 llvm::DIScope *CGDebugInfo::getDeclContextDescriptor(const Decl *D) {
200 llvm::DIScope *Mod = getParentModuleOrNull(D);
201 return getContextDescriptor(cast<Decl>(D->getDeclContext()),
205 llvm::DIScope *CGDebugInfo::getContextDescriptor(const Decl *Context,
206 llvm::DIScope *Default) {
210 auto I = RegionMap.find(Context);
211 if (I != RegionMap.end()) {
212 llvm::Metadata *V = I->second;
213 return dyn_cast_or_null<llvm::DIScope>(V);
217 if (const auto *NSDecl = dyn_cast<NamespaceDecl>(Context))
218 return getOrCreateNamespace(NSDecl);
220 if (const auto *RDecl = dyn_cast<RecordDecl>(Context))
221 if (!RDecl->isDependentType())
222 return getOrCreateType(CGM.getContext().getTypeDeclType(RDecl),
223 getOrCreateMainFile());
227 PrintingPolicy CGDebugInfo::getPrintingPolicy() const {
228 PrintingPolicy PP = CGM.getContext().getPrintingPolicy();
230 // If we're emitting codeview, it's important to try to match MSVC's naming so
231 // that visualizers written for MSVC will trigger for our class names. In
232 // particular, we can't have spaces between arguments of standard templates
233 // like basic_string and vector.
234 if (CGM.getCodeGenOpts().EmitCodeView)
235 PP.MSVCFormatting = true;
240 StringRef CGDebugInfo::getFunctionName(const FunctionDecl *FD) {
241 assert(FD && "Invalid FunctionDecl!");
242 IdentifierInfo *FII = FD->getIdentifier();
243 FunctionTemplateSpecializationInfo *Info =
244 FD->getTemplateSpecializationInfo();
246 // Emit the unqualified name in normal operation. LLVM and the debugger can
247 // compute the fully qualified name from the scope chain. If we're only
248 // emitting line table info, there won't be any scope chains, so emit the
249 // fully qualified name here so that stack traces are more accurate.
250 // FIXME: Do this when emitting DWARF as well as when emitting CodeView after
251 // evaluating the size impact.
252 bool UseQualifiedName = DebugKind == codegenoptions::DebugLineTablesOnly &&
253 CGM.getCodeGenOpts().EmitCodeView;
255 if (!Info && FII && !UseQualifiedName)
256 return FII->getName();
259 llvm::raw_svector_ostream OS(NS);
260 if (!UseQualifiedName)
263 FD->printQualifiedName(OS, getPrintingPolicy());
265 // Add any template specialization args.
267 const TemplateArgumentList *TArgs = Info->TemplateArguments;
268 printTemplateArgumentList(OS, TArgs->asArray(), getPrintingPolicy());
271 // Copy this name on the side and use its reference.
272 return internString(OS.str());
275 StringRef CGDebugInfo::getObjCMethodName(const ObjCMethodDecl *OMD) {
276 SmallString<256> MethodName;
277 llvm::raw_svector_ostream OS(MethodName);
278 OS << (OMD->isInstanceMethod() ? '-' : '+') << '[';
279 const DeclContext *DC = OMD->getDeclContext();
280 if (const auto *OID = dyn_cast<ObjCImplementationDecl>(DC)) {
281 OS << OID->getName();
282 } else if (const auto *OID = dyn_cast<ObjCInterfaceDecl>(DC)) {
283 OS << OID->getName();
284 } else if (const auto *OC = dyn_cast<ObjCCategoryDecl>(DC)) {
285 if (OC->IsClassExtension()) {
286 OS << OC->getClassInterface()->getName();
288 OS << OC->getIdentifier()->getNameStart() << '('
289 << OC->getIdentifier()->getNameStart() << ')';
291 } else if (const auto *OCD = dyn_cast<ObjCCategoryImplDecl>(DC)) {
292 OS << OCD->getClassInterface()->getName() << '('
293 << OCD->getName() << ')';
294 } else if (isa<ObjCProtocolDecl>(DC)) {
295 // We can extract the type of the class from the self pointer.
296 if (ImplicitParamDecl *SelfDecl = OMD->getSelfDecl()) {
298 cast<ObjCObjectPointerType>(SelfDecl->getType())->getPointeeType();
299 ClassTy.print(OS, PrintingPolicy(LangOptions()));
302 OS << ' ' << OMD->getSelector().getAsString() << ']';
304 return internString(OS.str());
307 StringRef CGDebugInfo::getSelectorName(Selector S) {
308 return internString(S.getAsString());
311 StringRef CGDebugInfo::getClassName(const RecordDecl *RD) {
312 if (isa<ClassTemplateSpecializationDecl>(RD)) {
313 SmallString<128> Name;
314 llvm::raw_svector_ostream OS(Name);
315 RD->getNameForDiagnostic(OS, getPrintingPolicy(),
316 /*Qualified*/ false);
318 // Copy this name on the side and use its reference.
319 return internString(Name);
322 // quick optimization to avoid having to intern strings that are already
323 // stored reliably elsewhere
324 if (const IdentifierInfo *II = RD->getIdentifier())
325 return II->getName();
327 // The CodeView printer in LLVM wants to see the names of unnamed types: it is
328 // used to reconstruct the fully qualified type names.
329 if (CGM.getCodeGenOpts().EmitCodeView) {
330 if (const TypedefNameDecl *D = RD->getTypedefNameForAnonDecl()) {
331 assert(RD->getDeclContext() == D->getDeclContext() &&
332 "Typedef should not be in another decl context!");
333 assert(D->getDeclName().getAsIdentifierInfo() &&
334 "Typedef was not named!");
335 return D->getDeclName().getAsIdentifierInfo()->getName();
338 if (CGM.getLangOpts().CPlusPlus) {
341 ASTContext &Context = CGM.getContext();
342 if (const DeclaratorDecl *DD = Context.getDeclaratorForUnnamedTagDecl(RD))
343 // Anonymous types without a name for linkage purposes have their
344 // declarator mangled in if they have one.
345 Name = DD->getName();
346 else if (const TypedefNameDecl *TND =
347 Context.getTypedefNameForUnnamedTagDecl(RD))
348 // Anonymous types without a name for linkage purposes have their
349 // associate typedef mangled in if they have one.
350 Name = TND->getName();
353 SmallString<256> UnnamedType("<unnamed-type-");
356 return internString(UnnamedType);
364 llvm::DIFile::ChecksumKind
365 CGDebugInfo::computeChecksum(FileID FID, SmallString<32> &Checksum) const {
368 if (!CGM.getCodeGenOpts().EmitCodeView)
369 return llvm::DIFile::CSK_None;
371 SourceManager &SM = CGM.getContext().getSourceManager();
373 llvm::MemoryBuffer *MemBuffer = SM.getBuffer(FID, &Invalid);
375 return llvm::DIFile::CSK_None;
378 llvm::MD5::MD5Result Result;
380 Hash.update(MemBuffer->getBuffer());
383 Hash.stringifyResult(Result, Checksum);
384 return llvm::DIFile::CSK_MD5;
387 llvm::DIFile *CGDebugInfo::getOrCreateFile(SourceLocation Loc) {
389 // If Location is not valid then use main input file.
390 return DBuilder.createFile(remapDIPath(TheCU->getFilename()),
391 remapDIPath(TheCU->getDirectory()),
392 TheCU->getFile()->getChecksumKind(),
393 TheCU->getFile()->getChecksum());
395 SourceManager &SM = CGM.getContext().getSourceManager();
396 PresumedLoc PLoc = SM.getPresumedLoc(Loc);
398 if (PLoc.isInvalid() || StringRef(PLoc.getFilename()).empty())
399 // If the location is not valid then use main input file.
400 return DBuilder.createFile(remapDIPath(TheCU->getFilename()),
401 remapDIPath(TheCU->getDirectory()),
402 TheCU->getFile()->getChecksumKind(),
403 TheCU->getFile()->getChecksum());
405 // Cache the results.
406 const char *fname = PLoc.getFilename();
407 auto it = DIFileCache.find(fname);
409 if (it != DIFileCache.end()) {
410 // Verify that the information still exists.
411 if (llvm::Metadata *V = it->second)
412 return cast<llvm::DIFile>(V);
415 SmallString<32> Checksum;
416 llvm::DIFile::ChecksumKind CSKind =
417 computeChecksum(SM.getFileID(Loc), Checksum);
419 llvm::DIFile *F = DBuilder.createFile(remapDIPath(PLoc.getFilename()),
420 remapDIPath(getCurrentDirname()),
423 DIFileCache[fname].reset(F);
427 llvm::DIFile *CGDebugInfo::getOrCreateMainFile() {
428 return DBuilder.createFile(remapDIPath(TheCU->getFilename()),
429 remapDIPath(TheCU->getDirectory()),
430 TheCU->getFile()->getChecksumKind(),
431 TheCU->getFile()->getChecksum());
434 std::string CGDebugInfo::remapDIPath(StringRef Path) const {
435 for (const auto &Entry : DebugPrefixMap)
436 if (Path.startswith(Entry.first))
437 return (Twine(Entry.second) + Path.substr(Entry.first.size())).str();
441 unsigned CGDebugInfo::getLineNumber(SourceLocation Loc) {
442 if (Loc.isInvalid() && CurLoc.isInvalid())
444 SourceManager &SM = CGM.getContext().getSourceManager();
445 PresumedLoc PLoc = SM.getPresumedLoc(Loc.isValid() ? Loc : CurLoc);
446 return PLoc.isValid() ? PLoc.getLine() : 0;
449 unsigned CGDebugInfo::getColumnNumber(SourceLocation Loc, bool Force) {
450 // We may not want column information at all.
451 if (!Force && !CGM.getCodeGenOpts().DebugColumnInfo)
454 // If the location is invalid then use the current column.
455 if (Loc.isInvalid() && CurLoc.isInvalid())
457 SourceManager &SM = CGM.getContext().getSourceManager();
458 PresumedLoc PLoc = SM.getPresumedLoc(Loc.isValid() ? Loc : CurLoc);
459 return PLoc.isValid() ? PLoc.getColumn() : 0;
462 StringRef CGDebugInfo::getCurrentDirname() {
463 if (!CGM.getCodeGenOpts().DebugCompilationDir.empty())
464 return CGM.getCodeGenOpts().DebugCompilationDir;
466 if (!CWDName.empty())
468 SmallString<256> CWD;
469 llvm::sys::fs::current_path(CWD);
470 return CWDName = internString(CWD);
473 void CGDebugInfo::CreateCompileUnit() {
474 SmallString<32> Checksum;
475 llvm::DIFile::ChecksumKind CSKind = llvm::DIFile::CSK_None;
477 // Should we be asking the SourceManager for the main file name, instead of
478 // accepting it as an argument? This just causes the main file name to
479 // mismatch with source locations and create extra lexical scopes or
480 // mismatched debug info (a CU with a DW_AT_file of "-", because that's what
481 // the driver passed, but functions/other things have DW_AT_file of "<stdin>"
482 // because that's what the SourceManager says)
484 // Get absolute path name.
485 SourceManager &SM = CGM.getContext().getSourceManager();
486 std::string MainFileName = CGM.getCodeGenOpts().MainFileName;
487 if (MainFileName.empty())
488 MainFileName = "<stdin>";
490 // The main file name provided via the "-main-file-name" option contains just
491 // the file name itself with no path information. This file name may have had
492 // a relative path, so we look into the actual file entry for the main
493 // file to determine the real absolute path for the file.
494 std::string MainFileDir;
495 if (const FileEntry *MainFile = SM.getFileEntryForID(SM.getMainFileID())) {
496 MainFileDir = remapDIPath(MainFile->getDir()->getName());
497 if (MainFileDir != ".") {
498 llvm::SmallString<1024> MainFileDirSS(MainFileDir);
499 llvm::sys::path::append(MainFileDirSS, MainFileName);
500 MainFileName = MainFileDirSS.str();
502 // If the main file name provided is identical to the input file name, and
503 // if the input file is a preprocessed source, use the module name for
504 // debug info. The module name comes from the name specified in the first
505 // linemarker if the input is a preprocessed source.
506 if (MainFile->getName() == MainFileName &&
507 FrontendOptions::getInputKindForExtension(
508 MainFile->getName().rsplit('.').second)
510 MainFileName = CGM.getModule().getName().str();
512 CSKind = computeChecksum(SM.getMainFileID(), Checksum);
515 llvm::dwarf::SourceLanguage LangTag;
516 const LangOptions &LO = CGM.getLangOpts();
519 LangTag = llvm::dwarf::DW_LANG_ObjC_plus_plus;
521 LangTag = llvm::dwarf::DW_LANG_C_plus_plus;
522 } else if (LO.ObjC1) {
523 LangTag = llvm::dwarf::DW_LANG_ObjC;
524 } else if (LO.RenderScript) {
525 LangTag = llvm::dwarf::DW_LANG_GOOGLE_RenderScript;
527 LangTag = llvm::dwarf::DW_LANG_C99;
529 LangTag = llvm::dwarf::DW_LANG_C89;
532 std::string Producer = getClangFullVersion();
534 // Figure out which version of the ObjC runtime we have.
535 unsigned RuntimeVers = 0;
537 RuntimeVers = LO.ObjCRuntime.isNonFragile() ? 2 : 1;
539 llvm::DICompileUnit::DebugEmissionKind EmissionKind;
541 case codegenoptions::NoDebugInfo:
542 case codegenoptions::LocTrackingOnly:
543 EmissionKind = llvm::DICompileUnit::NoDebug;
545 case codegenoptions::DebugLineTablesOnly:
546 EmissionKind = llvm::DICompileUnit::LineTablesOnly;
548 case codegenoptions::LimitedDebugInfo:
549 case codegenoptions::FullDebugInfo:
550 EmissionKind = llvm::DICompileUnit::FullDebug;
554 // Create new compile unit.
555 // FIXME - Eliminate TheCU.
556 auto &CGOpts = CGM.getCodeGenOpts();
557 TheCU = DBuilder.createCompileUnit(
559 DBuilder.createFile(remapDIPath(MainFileName),
560 remapDIPath(getCurrentDirname()), CSKind, Checksum),
561 Producer, LO.Optimize || CGOpts.PrepareForLTO || CGOpts.EmitSummaryIndex,
562 CGOpts.DwarfDebugFlags, RuntimeVers,
563 CGOpts.EnableSplitDwarf ? "" : CGOpts.SplitDwarfFile, EmissionKind,
564 0 /* DWOid */, CGOpts.SplitDwarfInlining, CGOpts.DebugInfoForProfiling,
568 llvm::DIType *CGDebugInfo::CreateType(const BuiltinType *BT) {
569 llvm::dwarf::TypeKind Encoding;
571 switch (BT->getKind()) {
572 #define BUILTIN_TYPE(Id, SingletonId)
573 #define PLACEHOLDER_TYPE(Id, SingletonId) case BuiltinType::Id:
574 #include "clang/AST/BuiltinTypes.def"
575 case BuiltinType::Dependent:
576 llvm_unreachable("Unexpected builtin type");
577 case BuiltinType::NullPtr:
578 return DBuilder.createNullPtrType();
579 case BuiltinType::Void:
581 case BuiltinType::ObjCClass:
583 ClassTy = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
585 getOrCreateMainFile(), 0);
587 case BuiltinType::ObjCId: {
588 // typedef struct objc_class *Class;
589 // typedef struct objc_object {
597 ClassTy = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
599 getOrCreateMainFile(), 0);
601 unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
603 auto *ISATy = DBuilder.createPointerType(ClassTy, Size);
605 ObjTy = DBuilder.createStructType(
606 TheCU, "objc_object", getOrCreateMainFile(), 0, 0, 0,
607 llvm::DINode::FlagZero, nullptr, llvm::DINodeArray());
609 DBuilder.replaceArrays(
610 ObjTy, DBuilder.getOrCreateArray(&*DBuilder.createMemberType(
611 ObjTy, "isa", getOrCreateMainFile(), 0, Size, 0, 0,
612 llvm::DINode::FlagZero, ISATy)));
615 case BuiltinType::ObjCSel: {
617 SelTy = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
618 "objc_selector", TheCU,
619 getOrCreateMainFile(), 0);
623 #define IMAGE_TYPE(ImgType, Id, SingletonId, Access, Suffix) \
624 case BuiltinType::Id: \
625 return getOrCreateStructPtrType("opencl_" #ImgType "_" #Suffix "_t", \
627 #include "clang/Basic/OpenCLImageTypes.def"
628 case BuiltinType::OCLSampler:
629 return getOrCreateStructPtrType("opencl_sampler_t",
631 case BuiltinType::OCLEvent:
632 return getOrCreateStructPtrType("opencl_event_t", OCLEventDITy);
633 case BuiltinType::OCLClkEvent:
634 return getOrCreateStructPtrType("opencl_clk_event_t", OCLClkEventDITy);
635 case BuiltinType::OCLQueue:
636 return getOrCreateStructPtrType("opencl_queue_t", OCLQueueDITy);
637 case BuiltinType::OCLReserveID:
638 return getOrCreateStructPtrType("opencl_reserve_id_t", OCLReserveIDDITy);
640 case BuiltinType::UChar:
641 case BuiltinType::Char_U:
642 Encoding = llvm::dwarf::DW_ATE_unsigned_char;
644 case BuiltinType::Char_S:
645 case BuiltinType::SChar:
646 Encoding = llvm::dwarf::DW_ATE_signed_char;
648 case BuiltinType::Char16:
649 case BuiltinType::Char32:
650 Encoding = llvm::dwarf::DW_ATE_UTF;
652 case BuiltinType::UShort:
653 case BuiltinType::UInt:
654 case BuiltinType::UInt128:
655 case BuiltinType::ULong:
656 case BuiltinType::WChar_U:
657 case BuiltinType::ULongLong:
658 Encoding = llvm::dwarf::DW_ATE_unsigned;
660 case BuiltinType::Short:
661 case BuiltinType::Int:
662 case BuiltinType::Int128:
663 case BuiltinType::Long:
664 case BuiltinType::WChar_S:
665 case BuiltinType::LongLong:
666 Encoding = llvm::dwarf::DW_ATE_signed;
668 case BuiltinType::Bool:
669 Encoding = llvm::dwarf::DW_ATE_boolean;
671 case BuiltinType::Half:
672 case BuiltinType::Float:
673 case BuiltinType::LongDouble:
674 case BuiltinType::Float16:
675 case BuiltinType::Float128:
676 case BuiltinType::Double:
677 // FIXME: For targets where long double and __float128 have the same size,
678 // they are currently indistinguishable in the debugger without some
679 // special treatment. However, there is currently no consensus on encoding
680 // and this should be updated once a DWARF encoding exists for distinct
681 // floating point types of the same size.
682 Encoding = llvm::dwarf::DW_ATE_float;
686 switch (BT->getKind()) {
687 case BuiltinType::Long:
690 case BuiltinType::LongLong:
691 BTName = "long long int";
693 case BuiltinType::ULong:
694 BTName = "long unsigned int";
696 case BuiltinType::ULongLong:
697 BTName = "long long unsigned int";
700 BTName = BT->getName(CGM.getLangOpts());
703 // Bit size and offset of the type.
704 uint64_t Size = CGM.getContext().getTypeSize(BT);
705 return DBuilder.createBasicType(BTName, Size, Encoding);
708 llvm::DIType *CGDebugInfo::CreateType(const ComplexType *Ty) {
709 // Bit size and offset of the type.
710 llvm::dwarf::TypeKind Encoding = llvm::dwarf::DW_ATE_complex_float;
711 if (Ty->isComplexIntegerType())
712 Encoding = llvm::dwarf::DW_ATE_lo_user;
714 uint64_t Size = CGM.getContext().getTypeSize(Ty);
715 return DBuilder.createBasicType("complex", Size, Encoding);
718 llvm::DIType *CGDebugInfo::CreateQualifiedType(QualType Ty,
719 llvm::DIFile *Unit) {
720 QualifierCollector Qc;
721 const Type *T = Qc.strip(Ty);
723 // Ignore these qualifiers for now.
724 Qc.removeObjCGCAttr();
725 Qc.removeAddressSpace();
726 Qc.removeObjCLifetime();
728 // We will create one Derived type for one qualifier and recurse to handle any
730 llvm::dwarf::Tag Tag;
732 Tag = llvm::dwarf::DW_TAG_const_type;
734 } else if (Qc.hasVolatile()) {
735 Tag = llvm::dwarf::DW_TAG_volatile_type;
737 } else if (Qc.hasRestrict()) {
738 Tag = llvm::dwarf::DW_TAG_restrict_type;
741 assert(Qc.empty() && "Unknown type qualifier for debug info");
742 return getOrCreateType(QualType(T, 0), Unit);
745 auto *FromTy = getOrCreateType(Qc.apply(CGM.getContext(), T), Unit);
747 // No need to fill in the Name, Line, Size, Alignment, Offset in case of
748 // CVR derived types.
749 return DBuilder.createQualifiedType(Tag, FromTy);
752 llvm::DIType *CGDebugInfo::CreateType(const ObjCObjectPointerType *Ty,
753 llvm::DIFile *Unit) {
755 // The frontend treats 'id' as a typedef to an ObjCObjectType,
756 // whereas 'id<protocol>' is treated as an ObjCPointerType. For the
757 // debug info, we want to emit 'id' in both cases.
758 if (Ty->isObjCQualifiedIdType())
759 return getOrCreateType(CGM.getContext().getObjCIdType(), Unit);
761 return CreatePointerLikeType(llvm::dwarf::DW_TAG_pointer_type, Ty,
762 Ty->getPointeeType(), Unit);
765 llvm::DIType *CGDebugInfo::CreateType(const PointerType *Ty,
766 llvm::DIFile *Unit) {
767 return CreatePointerLikeType(llvm::dwarf::DW_TAG_pointer_type, Ty,
768 Ty->getPointeeType(), Unit);
771 /// \return whether a C++ mangling exists for the type defined by TD.
772 static bool hasCXXMangling(const TagDecl *TD, llvm::DICompileUnit *TheCU) {
773 switch (TheCU->getSourceLanguage()) {
774 case llvm::dwarf::DW_LANG_C_plus_plus:
776 case llvm::dwarf::DW_LANG_ObjC_plus_plus:
777 return isa<CXXRecordDecl>(TD) || isa<EnumDecl>(TD);
783 /// In C++ mode, types have linkage, so we can rely on the ODR and
784 /// on their mangled names, if they're external.
785 static SmallString<256> getUniqueTagTypeName(const TagType *Ty,
787 llvm::DICompileUnit *TheCU) {
788 SmallString<256> FullName;
789 const TagDecl *TD = Ty->getDecl();
791 if (!hasCXXMangling(TD, TheCU) || !TD->isExternallyVisible())
794 // TODO: This is using the RTTI name. Is there a better way to get
795 // a unique string for a type?
796 llvm::raw_svector_ostream Out(FullName);
797 CGM.getCXXABI().getMangleContext().mangleCXXRTTIName(QualType(Ty, 0), Out);
801 /// \return the approproate DWARF tag for a composite type.
802 static llvm::dwarf::Tag getTagForRecord(const RecordDecl *RD) {
803 llvm::dwarf::Tag Tag;
804 if (RD->isStruct() || RD->isInterface())
805 Tag = llvm::dwarf::DW_TAG_structure_type;
806 else if (RD->isUnion())
807 Tag = llvm::dwarf::DW_TAG_union_type;
809 // FIXME: This could be a struct type giving a default visibility different
810 // than C++ class type, but needs llvm metadata changes first.
811 assert(RD->isClass());
812 Tag = llvm::dwarf::DW_TAG_class_type;
817 llvm::DICompositeType *
818 CGDebugInfo::getOrCreateRecordFwdDecl(const RecordType *Ty,
819 llvm::DIScope *Ctx) {
820 const RecordDecl *RD = Ty->getDecl();
821 if (llvm::DIType *T = getTypeOrNull(CGM.getContext().getRecordType(RD)))
822 return cast<llvm::DICompositeType>(T);
823 llvm::DIFile *DefUnit = getOrCreateFile(RD->getLocation());
824 unsigned Line = getLineNumber(RD->getLocation());
825 StringRef RDName = getClassName(RD);
831 SmallString<256> FullName = getUniqueTagTypeName(Ty, CGM, TheCU);
832 llvm::DICompositeType *RetTy = DBuilder.createReplaceableCompositeType(
833 getTagForRecord(RD), RDName, Ctx, DefUnit, Line, 0, Size, Align,
834 llvm::DINode::FlagFwdDecl, FullName);
835 if (CGM.getCodeGenOpts().DebugFwdTemplateParams)
836 if (auto *TSpecial = dyn_cast<ClassTemplateSpecializationDecl>(RD))
837 DBuilder.replaceArrays(RetTy, llvm::DINodeArray(),
838 CollectCXXTemplateParams(TSpecial, DefUnit));
839 ReplaceMap.emplace_back(
840 std::piecewise_construct, std::make_tuple(Ty),
841 std::make_tuple(static_cast<llvm::Metadata *>(RetTy)));
845 llvm::DIType *CGDebugInfo::CreatePointerLikeType(llvm::dwarf::Tag Tag,
848 llvm::DIFile *Unit) {
849 // Bit size, align and offset of the type.
850 // Size is always the size of a pointer. We can't use getTypeSize here
851 // because that does not return the correct value for references.
852 unsigned AddressSpace = CGM.getContext().getTargetAddressSpace(PointeeTy);
853 uint64_t Size = CGM.getTarget().getPointerWidth(AddressSpace);
854 auto Align = getTypeAlignIfRequired(Ty, CGM.getContext());
855 Optional<unsigned> DWARFAddressSpace =
856 CGM.getTarget().getDWARFAddressSpace(AddressSpace);
858 if (Tag == llvm::dwarf::DW_TAG_reference_type ||
859 Tag == llvm::dwarf::DW_TAG_rvalue_reference_type)
860 return DBuilder.createReferenceType(Tag, getOrCreateType(PointeeTy, Unit),
861 Size, Align, DWARFAddressSpace);
863 return DBuilder.createPointerType(getOrCreateType(PointeeTy, Unit), Size,
864 Align, DWARFAddressSpace);
867 llvm::DIType *CGDebugInfo::getOrCreateStructPtrType(StringRef Name,
868 llvm::DIType *&Cache) {
871 Cache = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type, Name,
872 TheCU, getOrCreateMainFile(), 0);
873 unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
874 Cache = DBuilder.createPointerType(Cache, Size);
878 llvm::DIType *CGDebugInfo::CreateType(const BlockPointerType *Ty,
879 llvm::DIFile *Unit) {
880 SmallVector<llvm::Metadata *, 8> EltTys;
882 uint64_t FieldSize, FieldOffset;
884 llvm::DINodeArray Elements;
887 FType = CGM.getContext().UnsignedLongTy;
888 EltTys.push_back(CreateMemberType(Unit, FType, "reserved", &FieldOffset));
889 EltTys.push_back(CreateMemberType(Unit, FType, "Size", &FieldOffset));
891 Elements = DBuilder.getOrCreateArray(EltTys);
894 llvm::DINode::DIFlags Flags = llvm::DINode::FlagAppleBlock;
898 DBuilder.createStructType(Unit, "__block_descriptor", nullptr, LineNo,
899 FieldOffset, 0, Flags, nullptr, Elements);
901 // Bit size, align and offset of the type.
902 uint64_t Size = CGM.getContext().getTypeSize(Ty);
904 auto *DescTy = DBuilder.createPointerType(EltTy, Size);
907 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
908 EltTys.push_back(CreateMemberType(Unit, FType, "__isa", &FieldOffset));
909 FType = CGM.getContext().IntTy;
910 EltTys.push_back(CreateMemberType(Unit, FType, "__flags", &FieldOffset));
911 EltTys.push_back(CreateMemberType(Unit, FType, "__reserved", &FieldOffset));
912 FType = CGM.getContext().getPointerType(Ty->getPointeeType());
913 EltTys.push_back(CreateMemberType(Unit, FType, "__FuncPtr", &FieldOffset));
915 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
916 FieldSize = CGM.getContext().getTypeSize(Ty);
917 FieldAlign = CGM.getContext().getTypeAlign(Ty);
918 EltTys.push_back(DBuilder.createMemberType(
919 Unit, "__descriptor", nullptr, LineNo, FieldSize, FieldAlign, FieldOffset,
920 llvm::DINode::FlagZero, DescTy));
922 FieldOffset += FieldSize;
923 Elements = DBuilder.getOrCreateArray(EltTys);
925 // The __block_literal_generic structs are marked with a special
926 // DW_AT_APPLE_BLOCK attribute and are an implementation detail only
927 // the debugger needs to know about. To allow type uniquing, emit
928 // them without a name or a location.
930 DBuilder.createStructType(Unit, "", nullptr, LineNo,
931 FieldOffset, 0, Flags, nullptr, Elements);
933 return DBuilder.createPointerType(EltTy, Size);
936 llvm::DIType *CGDebugInfo::CreateType(const TemplateSpecializationType *Ty,
937 llvm::DIFile *Unit) {
938 assert(Ty->isTypeAlias());
939 llvm::DIType *Src = getOrCreateType(Ty->getAliasedType(), Unit);
942 llvm::raw_svector_ostream OS(NS);
943 Ty->getTemplateName().print(OS, getPrintingPolicy(), /*qualified*/ false);
944 printTemplateArgumentList(OS, Ty->template_arguments(), getPrintingPolicy());
946 auto *AliasDecl = cast<TypeAliasTemplateDecl>(
947 Ty->getTemplateName().getAsTemplateDecl())->getTemplatedDecl();
949 SourceLocation Loc = AliasDecl->getLocation();
950 return DBuilder.createTypedef(Src, OS.str(), getOrCreateFile(Loc),
952 getDeclContextDescriptor(AliasDecl));
955 llvm::DIType *CGDebugInfo::CreateType(const TypedefType *Ty,
956 llvm::DIFile *Unit) {
957 // We don't set size information, but do specify where the typedef was
959 SourceLocation Loc = Ty->getDecl()->getLocation();
961 // Typedefs are derived from some other type.
962 return DBuilder.createTypedef(
963 getOrCreateType(Ty->getDecl()->getUnderlyingType(), Unit),
964 Ty->getDecl()->getName(), getOrCreateFile(Loc), getLineNumber(Loc),
965 getDeclContextDescriptor(Ty->getDecl()));
968 static unsigned getDwarfCC(CallingConv CC) {
971 // Avoid emitting DW_AT_calling_convention if the C convention was used.
975 return llvm::dwarf::DW_CC_BORLAND_stdcall;
977 return llvm::dwarf::DW_CC_BORLAND_msfastcall;
979 return llvm::dwarf::DW_CC_BORLAND_thiscall;
980 case CC_X86VectorCall:
981 return llvm::dwarf::DW_CC_LLVM_vectorcall;
983 return llvm::dwarf::DW_CC_BORLAND_pascal;
985 // FIXME: Create new DW_CC_ codes for these calling conventions.
990 case CC_IntelOclBicc:
991 case CC_SpirFunction:
992 case CC_OpenCLKernel:
994 case CC_PreserveMost:
1002 llvm::DIType *CGDebugInfo::CreateType(const FunctionType *Ty,
1003 llvm::DIFile *Unit) {
1004 SmallVector<llvm::Metadata *, 16> EltTys;
1006 // Add the result type at least.
1007 EltTys.push_back(getOrCreateType(Ty->getReturnType(), Unit));
1009 // Set up remainder of arguments if there is a prototype.
1010 // otherwise emit it as a variadic function.
1011 if (isa<FunctionNoProtoType>(Ty))
1012 EltTys.push_back(DBuilder.createUnspecifiedParameter());
1013 else if (const auto *FPT = dyn_cast<FunctionProtoType>(Ty)) {
1014 for (const QualType &ParamType : FPT->param_types())
1015 EltTys.push_back(getOrCreateType(ParamType, Unit));
1016 if (FPT->isVariadic())
1017 EltTys.push_back(DBuilder.createUnspecifiedParameter());
1020 llvm::DITypeRefArray EltTypeArray = DBuilder.getOrCreateTypeArray(EltTys);
1021 return DBuilder.createSubroutineType(EltTypeArray, llvm::DINode::FlagZero,
1022 getDwarfCC(Ty->getCallConv()));
1025 /// Convert an AccessSpecifier into the corresponding DINode flag.
1026 /// As an optimization, return 0 if the access specifier equals the
1027 /// default for the containing type.
1028 static llvm::DINode::DIFlags getAccessFlag(AccessSpecifier Access,
1029 const RecordDecl *RD) {
1030 AccessSpecifier Default = clang::AS_none;
1031 if (RD && RD->isClass())
1032 Default = clang::AS_private;
1033 else if (RD && (RD->isStruct() || RD->isUnion()))
1034 Default = clang::AS_public;
1036 if (Access == Default)
1037 return llvm::DINode::FlagZero;
1040 case clang::AS_private:
1041 return llvm::DINode::FlagPrivate;
1042 case clang::AS_protected:
1043 return llvm::DINode::FlagProtected;
1044 case clang::AS_public:
1045 return llvm::DINode::FlagPublic;
1046 case clang::AS_none:
1047 return llvm::DINode::FlagZero;
1049 llvm_unreachable("unexpected access enumerator");
1052 llvm::DIType *CGDebugInfo::createBitFieldType(const FieldDecl *BitFieldDecl,
1053 llvm::DIScope *RecordTy,
1054 const RecordDecl *RD) {
1055 StringRef Name = BitFieldDecl->getName();
1056 QualType Ty = BitFieldDecl->getType();
1057 SourceLocation Loc = BitFieldDecl->getLocation();
1058 llvm::DIFile *VUnit = getOrCreateFile(Loc);
1059 llvm::DIType *DebugType = getOrCreateType(Ty, VUnit);
1061 // Get the location for the field.
1062 llvm::DIFile *File = getOrCreateFile(Loc);
1063 unsigned Line = getLineNumber(Loc);
1065 const CGBitFieldInfo &BitFieldInfo =
1066 CGM.getTypes().getCGRecordLayout(RD).getBitFieldInfo(BitFieldDecl);
1067 uint64_t SizeInBits = BitFieldInfo.Size;
1068 assert(SizeInBits > 0 && "found named 0-width bitfield");
1069 uint64_t StorageOffsetInBits =
1070 CGM.getContext().toBits(BitFieldInfo.StorageOffset);
1071 uint64_t Offset = BitFieldInfo.Offset;
1072 // The bit offsets for big endian machines are reversed for big
1073 // endian target, compensate for that as the DIDerivedType requires
1074 // un-reversed offsets.
1075 if (CGM.getDataLayout().isBigEndian())
1076 Offset = BitFieldInfo.StorageSize - BitFieldInfo.Size - Offset;
1077 uint64_t OffsetInBits = StorageOffsetInBits + Offset;
1078 llvm::DINode::DIFlags Flags = getAccessFlag(BitFieldDecl->getAccess(), RD);
1079 return DBuilder.createBitFieldMemberType(
1080 RecordTy, Name, File, Line, SizeInBits, OffsetInBits, StorageOffsetInBits,
1085 CGDebugInfo::createFieldType(StringRef name, QualType type, SourceLocation loc,
1086 AccessSpecifier AS, uint64_t offsetInBits,
1087 uint32_t AlignInBits, llvm::DIFile *tunit,
1088 llvm::DIScope *scope, const RecordDecl *RD) {
1089 llvm::DIType *debugType = getOrCreateType(type, tunit);
1091 // Get the location for the field.
1092 llvm::DIFile *file = getOrCreateFile(loc);
1093 unsigned line = getLineNumber(loc);
1095 uint64_t SizeInBits = 0;
1096 auto Align = AlignInBits;
1097 if (!type->isIncompleteArrayType()) {
1098 TypeInfo TI = CGM.getContext().getTypeInfo(type);
1099 SizeInBits = TI.Width;
1101 Align = getTypeAlignIfRequired(type, CGM.getContext());
1104 llvm::DINode::DIFlags flags = getAccessFlag(AS, RD);
1105 return DBuilder.createMemberType(scope, name, file, line, SizeInBits,
1106 Align, offsetInBits, flags, debugType);
1109 void CGDebugInfo::CollectRecordLambdaFields(
1110 const CXXRecordDecl *CXXDecl, SmallVectorImpl<llvm::Metadata *> &elements,
1111 llvm::DIType *RecordTy) {
1112 // For C++11 Lambdas a Field will be the same as a Capture, but the Capture
1113 // has the name and the location of the variable so we should iterate over
1114 // both concurrently.
1115 const ASTRecordLayout &layout = CGM.getContext().getASTRecordLayout(CXXDecl);
1116 RecordDecl::field_iterator Field = CXXDecl->field_begin();
1117 unsigned fieldno = 0;
1118 for (CXXRecordDecl::capture_const_iterator I = CXXDecl->captures_begin(),
1119 E = CXXDecl->captures_end();
1120 I != E; ++I, ++Field, ++fieldno) {
1121 const LambdaCapture &C = *I;
1122 if (C.capturesVariable()) {
1123 SourceLocation Loc = C.getLocation();
1124 assert(!Field->isBitField() && "lambdas don't have bitfield members!");
1125 VarDecl *V = C.getCapturedVar();
1126 StringRef VName = V->getName();
1127 llvm::DIFile *VUnit = getOrCreateFile(Loc);
1128 auto Align = getDeclAlignIfRequired(V, CGM.getContext());
1129 llvm::DIType *FieldType = createFieldType(
1130 VName, Field->getType(), Loc, Field->getAccess(),
1131 layout.getFieldOffset(fieldno), Align, VUnit, RecordTy, CXXDecl);
1132 elements.push_back(FieldType);
1133 } else if (C.capturesThis()) {
1134 // TODO: Need to handle 'this' in some way by probably renaming the
1135 // this of the lambda class and having a field member of 'this' or
1136 // by using AT_object_pointer for the function and having that be
1137 // used as 'this' for semantic references.
1138 FieldDecl *f = *Field;
1139 llvm::DIFile *VUnit = getOrCreateFile(f->getLocation());
1140 QualType type = f->getType();
1141 llvm::DIType *fieldType = createFieldType(
1142 "this", type, f->getLocation(), f->getAccess(),
1143 layout.getFieldOffset(fieldno), VUnit, RecordTy, CXXDecl);
1145 elements.push_back(fieldType);
1150 llvm::DIDerivedType *
1151 CGDebugInfo::CreateRecordStaticField(const VarDecl *Var, llvm::DIType *RecordTy,
1152 const RecordDecl *RD) {
1153 // Create the descriptor for the static variable, with or without
1154 // constant initializers.
1155 Var = Var->getCanonicalDecl();
1156 llvm::DIFile *VUnit = getOrCreateFile(Var->getLocation());
1157 llvm::DIType *VTy = getOrCreateType(Var->getType(), VUnit);
1159 unsigned LineNumber = getLineNumber(Var->getLocation());
1160 StringRef VName = Var->getName();
1161 llvm::Constant *C = nullptr;
1162 if (Var->getInit()) {
1163 const APValue *Value = Var->evaluateValue();
1166 C = llvm::ConstantInt::get(CGM.getLLVMContext(), Value->getInt());
1167 if (Value->isFloat())
1168 C = llvm::ConstantFP::get(CGM.getLLVMContext(), Value->getFloat());
1172 llvm::DINode::DIFlags Flags = getAccessFlag(Var->getAccess(), RD);
1173 auto Align = getDeclAlignIfRequired(Var, CGM.getContext());
1174 llvm::DIDerivedType *GV = DBuilder.createStaticMemberType(
1175 RecordTy, VName, VUnit, LineNumber, VTy, Flags, C, Align);
1176 StaticDataMemberCache[Var->getCanonicalDecl()].reset(GV);
1180 void CGDebugInfo::CollectRecordNormalField(
1181 const FieldDecl *field, uint64_t OffsetInBits, llvm::DIFile *tunit,
1182 SmallVectorImpl<llvm::Metadata *> &elements, llvm::DIType *RecordTy,
1183 const RecordDecl *RD) {
1184 StringRef name = field->getName();
1185 QualType type = field->getType();
1187 // Ignore unnamed fields unless they're anonymous structs/unions.
1188 if (name.empty() && !type->isRecordType())
1191 llvm::DIType *FieldType;
1192 if (field->isBitField()) {
1193 FieldType = createBitFieldType(field, RecordTy, RD);
1195 auto Align = getDeclAlignIfRequired(field, CGM.getContext());
1197 createFieldType(name, type, field->getLocation(), field->getAccess(),
1198 OffsetInBits, Align, tunit, RecordTy, RD);
1201 elements.push_back(FieldType);
1204 void CGDebugInfo::CollectRecordNestedType(
1205 const TypeDecl *TD, SmallVectorImpl<llvm::Metadata *> &elements) {
1206 QualType Ty = CGM.getContext().getTypeDeclType(TD);
1207 // Injected class names are not considered nested records.
1208 if (isa<InjectedClassNameType>(Ty))
1210 SourceLocation Loc = TD->getLocation();
1211 llvm::DIType *nestedType = getOrCreateType(Ty, getOrCreateFile(Loc));
1212 elements.push_back(nestedType);
1215 void CGDebugInfo::CollectRecordFields(
1216 const RecordDecl *record, llvm::DIFile *tunit,
1217 SmallVectorImpl<llvm::Metadata *> &elements,
1218 llvm::DICompositeType *RecordTy) {
1219 const auto *CXXDecl = dyn_cast<CXXRecordDecl>(record);
1221 if (CXXDecl && CXXDecl->isLambda())
1222 CollectRecordLambdaFields(CXXDecl, elements, RecordTy);
1224 const ASTRecordLayout &layout = CGM.getContext().getASTRecordLayout(record);
1226 // Debug info for nested types is included in the member list only for
1228 bool IncludeNestedTypes = CGM.getCodeGenOpts().EmitCodeView;
1230 // Field number for non-static fields.
1231 unsigned fieldNo = 0;
1233 // Static and non-static members should appear in the same order as
1234 // the corresponding declarations in the source program.
1235 for (const auto *I : record->decls())
1236 if (const auto *V = dyn_cast<VarDecl>(I)) {
1237 if (V->hasAttr<NoDebugAttr>())
1239 // Reuse the existing static member declaration if one exists
1240 auto MI = StaticDataMemberCache.find(V->getCanonicalDecl());
1241 if (MI != StaticDataMemberCache.end()) {
1242 assert(MI->second &&
1243 "Static data member declaration should still exist");
1244 elements.push_back(MI->second);
1246 auto Field = CreateRecordStaticField(V, RecordTy, record);
1247 elements.push_back(Field);
1249 } else if (const auto *field = dyn_cast<FieldDecl>(I)) {
1250 CollectRecordNormalField(field, layout.getFieldOffset(fieldNo), tunit,
1251 elements, RecordTy, record);
1253 // Bump field number for next field.
1255 } else if (IncludeNestedTypes) {
1256 if (const auto *nestedType = dyn_cast<TypeDecl>(I))
1257 if (!nestedType->isImplicit() &&
1258 nestedType->getDeclContext() == record)
1259 CollectRecordNestedType(nestedType, elements);
1264 llvm::DISubroutineType *
1265 CGDebugInfo::getOrCreateMethodType(const CXXMethodDecl *Method,
1266 llvm::DIFile *Unit) {
1267 const FunctionProtoType *Func = Method->getType()->getAs<FunctionProtoType>();
1268 if (Method->isStatic())
1269 return cast_or_null<llvm::DISubroutineType>(
1270 getOrCreateType(QualType(Func, 0), Unit));
1271 return getOrCreateInstanceMethodType(Method->getThisType(CGM.getContext()),
1275 llvm::DISubroutineType *CGDebugInfo::getOrCreateInstanceMethodType(
1276 QualType ThisPtr, const FunctionProtoType *Func, llvm::DIFile *Unit) {
1277 // Add "this" pointer.
1278 llvm::DITypeRefArray Args(
1279 cast<llvm::DISubroutineType>(getOrCreateType(QualType(Func, 0), Unit))
1281 assert(Args.size() && "Invalid number of arguments!");
1283 SmallVector<llvm::Metadata *, 16> Elts;
1285 // First element is always return type. For 'void' functions it is NULL.
1286 Elts.push_back(Args[0]);
1288 // "this" pointer is always first argument.
1289 const CXXRecordDecl *RD = ThisPtr->getPointeeCXXRecordDecl();
1290 if (isa<ClassTemplateSpecializationDecl>(RD)) {
1291 // Create pointer type directly in this case.
1292 const PointerType *ThisPtrTy = cast<PointerType>(ThisPtr);
1293 QualType PointeeTy = ThisPtrTy->getPointeeType();
1294 unsigned AS = CGM.getContext().getTargetAddressSpace(PointeeTy);
1295 uint64_t Size = CGM.getTarget().getPointerWidth(AS);
1296 auto Align = getTypeAlignIfRequired(ThisPtrTy, CGM.getContext());
1297 llvm::DIType *PointeeType = getOrCreateType(PointeeTy, Unit);
1298 llvm::DIType *ThisPtrType =
1299 DBuilder.createPointerType(PointeeType, Size, Align);
1300 TypeCache[ThisPtr.getAsOpaquePtr()].reset(ThisPtrType);
1301 // TODO: This and the artificial type below are misleading, the
1302 // types aren't artificial the argument is, but the current
1303 // metadata doesn't represent that.
1304 ThisPtrType = DBuilder.createObjectPointerType(ThisPtrType);
1305 Elts.push_back(ThisPtrType);
1307 llvm::DIType *ThisPtrType = getOrCreateType(ThisPtr, Unit);
1308 TypeCache[ThisPtr.getAsOpaquePtr()].reset(ThisPtrType);
1309 ThisPtrType = DBuilder.createObjectPointerType(ThisPtrType);
1310 Elts.push_back(ThisPtrType);
1313 // Copy rest of the arguments.
1314 for (unsigned i = 1, e = Args.size(); i != e; ++i)
1315 Elts.push_back(Args[i]);
1317 llvm::DITypeRefArray EltTypeArray = DBuilder.getOrCreateTypeArray(Elts);
1319 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
1320 if (Func->getExtProtoInfo().RefQualifier == RQ_LValue)
1321 Flags |= llvm::DINode::FlagLValueReference;
1322 if (Func->getExtProtoInfo().RefQualifier == RQ_RValue)
1323 Flags |= llvm::DINode::FlagRValueReference;
1325 return DBuilder.createSubroutineType(EltTypeArray, Flags,
1326 getDwarfCC(Func->getCallConv()));
1329 /// isFunctionLocalClass - Return true if CXXRecordDecl is defined
1330 /// inside a function.
1331 static bool isFunctionLocalClass(const CXXRecordDecl *RD) {
1332 if (const auto *NRD = dyn_cast<CXXRecordDecl>(RD->getDeclContext()))
1333 return isFunctionLocalClass(NRD);
1334 if (isa<FunctionDecl>(RD->getDeclContext()))
1339 llvm::DISubprogram *CGDebugInfo::CreateCXXMemberFunction(
1340 const CXXMethodDecl *Method, llvm::DIFile *Unit, llvm::DIType *RecordTy) {
1342 isa<CXXConstructorDecl>(Method) || isa<CXXDestructorDecl>(Method);
1344 StringRef MethodName = getFunctionName(Method);
1345 llvm::DISubroutineType *MethodTy = getOrCreateMethodType(Method, Unit);
1347 // Since a single ctor/dtor corresponds to multiple functions, it doesn't
1348 // make sense to give a single ctor/dtor a linkage name.
1349 StringRef MethodLinkageName;
1350 // FIXME: 'isFunctionLocalClass' seems like an arbitrary/unintentional
1351 // property to use here. It may've been intended to model "is non-external
1352 // type" but misses cases of non-function-local but non-external classes such
1353 // as those in anonymous namespaces as well as the reverse - external types
1354 // that are function local, such as those in (non-local) inline functions.
1355 if (!IsCtorOrDtor && !isFunctionLocalClass(Method->getParent()))
1356 MethodLinkageName = CGM.getMangledName(Method);
1358 // Get the location for the method.
1359 llvm::DIFile *MethodDefUnit = nullptr;
1360 unsigned MethodLine = 0;
1361 if (!Method->isImplicit()) {
1362 MethodDefUnit = getOrCreateFile(Method->getLocation());
1363 MethodLine = getLineNumber(Method->getLocation());
1366 // Collect virtual method info.
1367 llvm::DIType *ContainingType = nullptr;
1368 unsigned Virtuality = 0;
1369 unsigned VIndex = 0;
1370 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
1371 int ThisAdjustment = 0;
1373 if (Method->isVirtual()) {
1374 if (Method->isPure())
1375 Virtuality = llvm::dwarf::DW_VIRTUALITY_pure_virtual;
1377 Virtuality = llvm::dwarf::DW_VIRTUALITY_virtual;
1379 if (CGM.getTarget().getCXXABI().isItaniumFamily()) {
1380 // It doesn't make sense to give a virtual destructor a vtable index,
1381 // since a single destructor has two entries in the vtable.
1382 if (!isa<CXXDestructorDecl>(Method))
1383 VIndex = CGM.getItaniumVTableContext().getMethodVTableIndex(Method);
1385 // Emit MS ABI vftable information. There is only one entry for the
1387 const auto *DD = dyn_cast<CXXDestructorDecl>(Method);
1388 GlobalDecl GD = DD ? GlobalDecl(DD, Dtor_Deleting) : GlobalDecl(Method);
1389 MicrosoftVTableContext::MethodVFTableLocation ML =
1390 CGM.getMicrosoftVTableContext().getMethodVFTableLocation(GD);
1393 // CodeView only records the vftable offset in the class that introduces
1394 // the virtual method. This is possible because, unlike Itanium, the MS
1395 // C++ ABI does not include all virtual methods from non-primary bases in
1396 // the vtable for the most derived class. For example, if C inherits from
1397 // A and B, C's primary vftable will not include B's virtual methods.
1398 if (Method->size_overridden_methods() == 0)
1399 Flags |= llvm::DINode::FlagIntroducedVirtual;
1401 // The 'this' adjustment accounts for both the virtual and non-virtual
1402 // portions of the adjustment. Presumably the debugger only uses it when
1403 // it knows the dynamic type of an object.
1404 ThisAdjustment = CGM.getCXXABI()
1405 .getVirtualFunctionPrologueThisAdjustment(GD)
1408 ContainingType = RecordTy;
1411 if (Method->isStatic())
1412 Flags |= llvm::DINode::FlagStaticMember;
1413 if (Method->isImplicit())
1414 Flags |= llvm::DINode::FlagArtificial;
1415 Flags |= getAccessFlag(Method->getAccess(), Method->getParent());
1416 if (const auto *CXXC = dyn_cast<CXXConstructorDecl>(Method)) {
1417 if (CXXC->isExplicit())
1418 Flags |= llvm::DINode::FlagExplicit;
1419 } else if (const auto *CXXC = dyn_cast<CXXConversionDecl>(Method)) {
1420 if (CXXC->isExplicit())
1421 Flags |= llvm::DINode::FlagExplicit;
1423 if (Method->hasPrototype())
1424 Flags |= llvm::DINode::FlagPrototyped;
1425 if (Method->getRefQualifier() == RQ_LValue)
1426 Flags |= llvm::DINode::FlagLValueReference;
1427 if (Method->getRefQualifier() == RQ_RValue)
1428 Flags |= llvm::DINode::FlagRValueReference;
1430 llvm::DINodeArray TParamsArray = CollectFunctionTemplateParams(Method, Unit);
1431 llvm::DISubprogram *SP = DBuilder.createMethod(
1432 RecordTy, MethodName, MethodLinkageName, MethodDefUnit, MethodLine,
1433 MethodTy, /*isLocalToUnit=*/false, /*isDefinition=*/false, Virtuality,
1434 VIndex, ThisAdjustment, ContainingType, Flags, CGM.getLangOpts().Optimize,
1435 TParamsArray.get());
1437 SPCache[Method->getCanonicalDecl()].reset(SP);
1442 void CGDebugInfo::CollectCXXMemberFunctions(
1443 const CXXRecordDecl *RD, llvm::DIFile *Unit,
1444 SmallVectorImpl<llvm::Metadata *> &EltTys, llvm::DIType *RecordTy) {
1446 // Since we want more than just the individual member decls if we
1447 // have templated functions iterate over every declaration to gather
1449 for (const auto *I : RD->decls()) {
1450 const auto *Method = dyn_cast<CXXMethodDecl>(I);
1451 // If the member is implicit, don't add it to the member list. This avoids
1452 // the member being added to type units by LLVM, while still allowing it
1453 // to be emitted into the type declaration/reference inside the compile
1455 // Ditto 'nodebug' methods, for consistency with CodeGenFunction.cpp.
1456 // FIXME: Handle Using(Shadow?)Decls here to create
1457 // DW_TAG_imported_declarations inside the class for base decls brought into
1458 // derived classes. GDB doesn't seem to notice/leverage these when I tried
1459 // it, so I'm not rushing to fix this. (GCC seems to produce them, if
1461 if (!Method || Method->isImplicit() || Method->hasAttr<NoDebugAttr>())
1464 if (Method->getType()->getAs<FunctionProtoType>()->getContainedAutoType())
1467 // Reuse the existing member function declaration if it exists.
1468 // It may be associated with the declaration of the type & should be
1469 // reused as we're building the definition.
1471 // This situation can arise in the vtable-based debug info reduction where
1472 // implicit members are emitted in a non-vtable TU.
1473 auto MI = SPCache.find(Method->getCanonicalDecl());
1474 EltTys.push_back(MI == SPCache.end()
1475 ? CreateCXXMemberFunction(Method, Unit, RecordTy)
1476 : static_cast<llvm::Metadata *>(MI->second));
1480 void CGDebugInfo::CollectCXXBases(const CXXRecordDecl *RD, llvm::DIFile *Unit,
1481 SmallVectorImpl<llvm::Metadata *> &EltTys,
1482 llvm::DIType *RecordTy) {
1483 llvm::DenseSet<CanonicalDeclPtr<const CXXRecordDecl>> SeenTypes;
1484 CollectCXXBasesAux(RD, Unit, EltTys, RecordTy, RD->bases(), SeenTypes,
1485 llvm::DINode::FlagZero);
1487 // If we are generating CodeView debug info, we also need to emit records for
1488 // indirect virtual base classes.
1489 if (CGM.getCodeGenOpts().EmitCodeView) {
1490 CollectCXXBasesAux(RD, Unit, EltTys, RecordTy, RD->vbases(), SeenTypes,
1491 llvm::DINode::FlagIndirectVirtualBase);
1495 void CGDebugInfo::CollectCXXBasesAux(
1496 const CXXRecordDecl *RD, llvm::DIFile *Unit,
1497 SmallVectorImpl<llvm::Metadata *> &EltTys, llvm::DIType *RecordTy,
1498 const CXXRecordDecl::base_class_const_range &Bases,
1499 llvm::DenseSet<CanonicalDeclPtr<const CXXRecordDecl>> &SeenTypes,
1500 llvm::DINode::DIFlags StartingFlags) {
1501 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
1502 for (const auto &BI : Bases) {
1504 cast<CXXRecordDecl>(BI.getType()->getAs<RecordType>()->getDecl());
1505 if (!SeenTypes.insert(Base).second)
1507 auto *BaseTy = getOrCreateType(BI.getType(), Unit);
1508 llvm::DINode::DIFlags BFlags = StartingFlags;
1509 uint64_t BaseOffset;
1511 if (BI.isVirtual()) {
1512 if (CGM.getTarget().getCXXABI().isItaniumFamily()) {
1513 // virtual base offset offset is -ve. The code generator emits dwarf
1514 // expression where it expects +ve number.
1515 BaseOffset = 0 - CGM.getItaniumVTableContext()
1516 .getVirtualBaseOffsetOffset(RD, Base)
1519 // In the MS ABI, store the vbtable offset, which is analogous to the
1520 // vbase offset offset in Itanium.
1522 4 * CGM.getMicrosoftVTableContext().getVBTableIndex(RD, Base);
1524 BFlags |= llvm::DINode::FlagVirtual;
1526 BaseOffset = CGM.getContext().toBits(RL.getBaseClassOffset(Base));
1527 // FIXME: Inconsistent units for BaseOffset. It is in bytes when
1528 // BI->isVirtual() and bits when not.
1530 BFlags |= getAccessFlag(BI.getAccessSpecifier(), RD);
1532 DBuilder.createInheritance(RecordTy, BaseTy, BaseOffset, BFlags);
1533 EltTys.push_back(DTy);
1538 CGDebugInfo::CollectTemplateParams(const TemplateParameterList *TPList,
1539 ArrayRef<TemplateArgument> TAList,
1540 llvm::DIFile *Unit) {
1541 SmallVector<llvm::Metadata *, 16> TemplateParams;
1542 for (unsigned i = 0, e = TAList.size(); i != e; ++i) {
1543 const TemplateArgument &TA = TAList[i];
1546 Name = TPList->getParam(i)->getName();
1547 switch (TA.getKind()) {
1548 case TemplateArgument::Type: {
1549 llvm::DIType *TTy = getOrCreateType(TA.getAsType(), Unit);
1550 TemplateParams.push_back(
1551 DBuilder.createTemplateTypeParameter(TheCU, Name, TTy));
1553 case TemplateArgument::Integral: {
1554 llvm::DIType *TTy = getOrCreateType(TA.getIntegralType(), Unit);
1555 TemplateParams.push_back(DBuilder.createTemplateValueParameter(
1557 llvm::ConstantInt::get(CGM.getLLVMContext(), TA.getAsIntegral())));
1559 case TemplateArgument::Declaration: {
1560 const ValueDecl *D = TA.getAsDecl();
1561 QualType T = TA.getParamTypeForDecl().getDesugaredType(CGM.getContext());
1562 llvm::DIType *TTy = getOrCreateType(T, Unit);
1563 llvm::Constant *V = nullptr;
1564 const CXXMethodDecl *MD;
1565 // Variable pointer template parameters have a value that is the address
1567 if (const auto *VD = dyn_cast<VarDecl>(D))
1568 V = CGM.GetAddrOfGlobalVar(VD);
1569 // Member function pointers have special support for building them, though
1570 // this is currently unsupported in LLVM CodeGen.
1571 else if ((MD = dyn_cast<CXXMethodDecl>(D)) && MD->isInstance())
1572 V = CGM.getCXXABI().EmitMemberFunctionPointer(MD);
1573 else if (const auto *FD = dyn_cast<FunctionDecl>(D))
1574 V = CGM.GetAddrOfFunction(FD);
1575 // Member data pointers have special handling too to compute the fixed
1576 // offset within the object.
1577 else if (const auto *MPT = dyn_cast<MemberPointerType>(T.getTypePtr())) {
1578 // These five lines (& possibly the above member function pointer
1579 // handling) might be able to be refactored to use similar code in
1580 // CodeGenModule::getMemberPointerConstant
1581 uint64_t fieldOffset = CGM.getContext().getFieldOffset(D);
1583 CGM.getContext().toCharUnitsFromBits((int64_t)fieldOffset);
1584 V = CGM.getCXXABI().EmitMemberDataPointer(MPT, chars);
1586 TemplateParams.push_back(DBuilder.createTemplateValueParameter(
1588 cast_or_null<llvm::Constant>(V->stripPointerCasts())));
1590 case TemplateArgument::NullPtr: {
1591 QualType T = TA.getNullPtrType();
1592 llvm::DIType *TTy = getOrCreateType(T, Unit);
1593 llvm::Constant *V = nullptr;
1594 // Special case member data pointer null values since they're actually -1
1596 if (const auto *MPT = dyn_cast<MemberPointerType>(T.getTypePtr()))
1597 // But treat member function pointers as simple zero integers because
1598 // it's easier than having a special case in LLVM's CodeGen. If LLVM
1599 // CodeGen grows handling for values of non-null member function
1600 // pointers then perhaps we could remove this special case and rely on
1601 // EmitNullMemberPointer for member function pointers.
1602 if (MPT->isMemberDataPointer())
1603 V = CGM.getCXXABI().EmitNullMemberPointer(MPT);
1605 V = llvm::ConstantInt::get(CGM.Int8Ty, 0);
1606 TemplateParams.push_back(DBuilder.createTemplateValueParameter(
1607 TheCU, Name, TTy, V));
1609 case TemplateArgument::Template:
1610 TemplateParams.push_back(DBuilder.createTemplateTemplateParameter(
1611 TheCU, Name, nullptr,
1612 TA.getAsTemplate().getAsTemplateDecl()->getQualifiedNameAsString()));
1614 case TemplateArgument::Pack:
1615 TemplateParams.push_back(DBuilder.createTemplateParameterPack(
1616 TheCU, Name, nullptr,
1617 CollectTemplateParams(nullptr, TA.getPackAsArray(), Unit)));
1619 case TemplateArgument::Expression: {
1620 const Expr *E = TA.getAsExpr();
1621 QualType T = E->getType();
1623 T = CGM.getContext().getLValueReferenceType(T);
1624 llvm::Constant *V = ConstantEmitter(CGM).emitAbstract(E, T);
1625 assert(V && "Expression in template argument isn't constant");
1626 llvm::DIType *TTy = getOrCreateType(T, Unit);
1627 TemplateParams.push_back(DBuilder.createTemplateValueParameter(
1628 TheCU, Name, TTy, V->stripPointerCasts()));
1630 // And the following should never occur:
1631 case TemplateArgument::TemplateExpansion:
1632 case TemplateArgument::Null:
1634 "These argument types shouldn't exist in concrete types");
1637 return DBuilder.getOrCreateArray(TemplateParams);
1641 CGDebugInfo::CollectFunctionTemplateParams(const FunctionDecl *FD,
1642 llvm::DIFile *Unit) {
1643 if (FD->getTemplatedKind() ==
1644 FunctionDecl::TK_FunctionTemplateSpecialization) {
1645 const TemplateParameterList *TList = FD->getTemplateSpecializationInfo()
1647 ->getTemplateParameters();
1648 return CollectTemplateParams(
1649 TList, FD->getTemplateSpecializationArgs()->asArray(), Unit);
1651 return llvm::DINodeArray();
1654 llvm::DINodeArray CGDebugInfo::CollectCXXTemplateParams(
1655 const ClassTemplateSpecializationDecl *TSpecial, llvm::DIFile *Unit) {
1656 // Always get the full list of parameters, not just the ones from
1657 // the specialization.
1658 TemplateParameterList *TPList =
1659 TSpecial->getSpecializedTemplate()->getTemplateParameters();
1660 const TemplateArgumentList &TAList = TSpecial->getTemplateArgs();
1661 return CollectTemplateParams(TPList, TAList.asArray(), Unit);
1664 llvm::DIType *CGDebugInfo::getOrCreateVTablePtrType(llvm::DIFile *Unit) {
1666 return VTablePtrType;
1668 ASTContext &Context = CGM.getContext();
1671 llvm::Metadata *STy = getOrCreateType(Context.IntTy, Unit);
1672 llvm::DITypeRefArray SElements = DBuilder.getOrCreateTypeArray(STy);
1673 llvm::DIType *SubTy = DBuilder.createSubroutineType(SElements);
1674 unsigned Size = Context.getTypeSize(Context.VoidPtrTy);
1675 unsigned VtblPtrAddressSpace = CGM.getTarget().getVtblPtrAddressSpace();
1676 Optional<unsigned> DWARFAddressSpace =
1677 CGM.getTarget().getDWARFAddressSpace(VtblPtrAddressSpace);
1679 llvm::DIType *vtbl_ptr_type =
1680 DBuilder.createPointerType(SubTy, Size, 0, DWARFAddressSpace,
1682 VTablePtrType = DBuilder.createPointerType(vtbl_ptr_type, Size);
1683 return VTablePtrType;
1686 StringRef CGDebugInfo::getVTableName(const CXXRecordDecl *RD) {
1687 // Copy the gdb compatible name on the side and use its reference.
1688 return internString("_vptr$", RD->getNameAsString());
1691 void CGDebugInfo::CollectVTableInfo(const CXXRecordDecl *RD, llvm::DIFile *Unit,
1692 SmallVectorImpl<llvm::Metadata *> &EltTys,
1693 llvm::DICompositeType *RecordTy) {
1694 // If this class is not dynamic then there is not any vtable info to collect.
1695 if (!RD->isDynamicClass())
1698 // Don't emit any vtable shape or vptr info if this class doesn't have an
1699 // extendable vfptr. This can happen if the class doesn't have virtual
1700 // methods, or in the MS ABI if those virtual methods only come from virtually
1702 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
1703 if (!RL.hasExtendableVFPtr())
1706 // CodeView needs to know how large the vtable of every dynamic class is, so
1707 // emit a special named pointer type into the element list. The vptr type
1708 // points to this type as well.
1709 llvm::DIType *VPtrTy = nullptr;
1710 bool NeedVTableShape = CGM.getCodeGenOpts().EmitCodeView &&
1711 CGM.getTarget().getCXXABI().isMicrosoft();
1712 if (NeedVTableShape) {
1714 CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
1715 const VTableLayout &VFTLayout =
1716 CGM.getMicrosoftVTableContext().getVFTableLayout(RD, CharUnits::Zero());
1717 unsigned VSlotCount =
1718 VFTLayout.vtable_components().size() - CGM.getLangOpts().RTTIData;
1719 unsigned VTableWidth = PtrWidth * VSlotCount;
1720 unsigned VtblPtrAddressSpace = CGM.getTarget().getVtblPtrAddressSpace();
1721 Optional<unsigned> DWARFAddressSpace =
1722 CGM.getTarget().getDWARFAddressSpace(VtblPtrAddressSpace);
1724 // Create a very wide void* type and insert it directly in the element list.
1725 llvm::DIType *VTableType =
1726 DBuilder.createPointerType(nullptr, VTableWidth, 0, DWARFAddressSpace,
1728 EltTys.push_back(VTableType);
1730 // The vptr is a pointer to this special vtable type.
1731 VPtrTy = DBuilder.createPointerType(VTableType, PtrWidth);
1734 // If there is a primary base then the artificial vptr member lives there.
1735 if (RL.getPrimaryBase())
1739 VPtrTy = getOrCreateVTablePtrType(Unit);
1741 unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
1742 llvm::DIType *VPtrMember = DBuilder.createMemberType(
1743 Unit, getVTableName(RD), Unit, 0, Size, 0, 0,
1744 llvm::DINode::FlagArtificial, VPtrTy);
1745 EltTys.push_back(VPtrMember);
1748 llvm::DIType *CGDebugInfo::getOrCreateRecordType(QualType RTy,
1749 SourceLocation Loc) {
1750 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
1751 llvm::DIType *T = getOrCreateType(RTy, getOrCreateFile(Loc));
1755 llvm::DIType *CGDebugInfo::getOrCreateInterfaceType(QualType D,
1756 SourceLocation Loc) {
1757 return getOrCreateStandaloneType(D, Loc);
1760 llvm::DIType *CGDebugInfo::getOrCreateStandaloneType(QualType D,
1761 SourceLocation Loc) {
1762 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
1763 assert(!D.isNull() && "null type");
1764 llvm::DIType *T = getOrCreateType(D, getOrCreateFile(Loc));
1765 assert(T && "could not create debug info for type");
1767 RetainedTypes.push_back(D.getAsOpaquePtr());
1771 void CGDebugInfo::completeType(const EnumDecl *ED) {
1772 if (DebugKind <= codegenoptions::DebugLineTablesOnly)
1774 QualType Ty = CGM.getContext().getEnumType(ED);
1775 void *TyPtr = Ty.getAsOpaquePtr();
1776 auto I = TypeCache.find(TyPtr);
1777 if (I == TypeCache.end() || !cast<llvm::DIType>(I->second)->isForwardDecl())
1779 llvm::DIType *Res = CreateTypeDefinition(Ty->castAs<EnumType>());
1780 assert(!Res->isForwardDecl());
1781 TypeCache[TyPtr].reset(Res);
1784 void CGDebugInfo::completeType(const RecordDecl *RD) {
1785 if (DebugKind > codegenoptions::LimitedDebugInfo ||
1786 !CGM.getLangOpts().CPlusPlus)
1787 completeRequiredType(RD);
1790 /// Return true if the class or any of its methods are marked dllimport.
1791 static bool isClassOrMethodDLLImport(const CXXRecordDecl *RD) {
1792 if (RD->hasAttr<DLLImportAttr>())
1794 for (const CXXMethodDecl *MD : RD->methods())
1795 if (MD->hasAttr<DLLImportAttr>())
1800 /// Does a type definition exist in an imported clang module?
1801 static bool isDefinedInClangModule(const RecordDecl *RD) {
1802 // Only definitions that where imported from an AST file come from a module.
1803 if (!RD || !RD->isFromASTFile())
1805 // Anonymous entities cannot be addressed. Treat them as not from module.
1806 if (!RD->isExternallyVisible() && RD->getName().empty())
1808 if (auto *CXXDecl = dyn_cast<CXXRecordDecl>(RD)) {
1809 if (!CXXDecl->isCompleteDefinition())
1811 auto TemplateKind = CXXDecl->getTemplateSpecializationKind();
1812 if (TemplateKind != TSK_Undeclared) {
1813 // This is a template, check the origin of the first member.
1814 if (CXXDecl->field_begin() == CXXDecl->field_end())
1815 return TemplateKind == TSK_ExplicitInstantiationDeclaration;
1816 if (!CXXDecl->field_begin()->isFromASTFile())
1823 void CGDebugInfo::completeClassData(const RecordDecl *RD) {
1824 if (auto *CXXRD = dyn_cast<CXXRecordDecl>(RD))
1825 if (CXXRD->isDynamicClass() &&
1826 CGM.getVTableLinkage(CXXRD) ==
1827 llvm::GlobalValue::AvailableExternallyLinkage &&
1828 !isClassOrMethodDLLImport(CXXRD))
1831 if (DebugTypeExtRefs && isDefinedInClangModule(RD->getDefinition()))
1837 void CGDebugInfo::completeClass(const RecordDecl *RD) {
1838 if (DebugKind <= codegenoptions::DebugLineTablesOnly)
1840 QualType Ty = CGM.getContext().getRecordType(RD);
1841 void *TyPtr = Ty.getAsOpaquePtr();
1842 auto I = TypeCache.find(TyPtr);
1843 if (I != TypeCache.end() && !cast<llvm::DIType>(I->second)->isForwardDecl())
1845 llvm::DIType *Res = CreateTypeDefinition(Ty->castAs<RecordType>());
1846 assert(!Res->isForwardDecl());
1847 TypeCache[TyPtr].reset(Res);
1850 static bool hasExplicitMemberDefinition(CXXRecordDecl::method_iterator I,
1851 CXXRecordDecl::method_iterator End) {
1852 for (CXXMethodDecl *MD : llvm::make_range(I, End))
1853 if (FunctionDecl *Tmpl = MD->getInstantiatedFromMemberFunction())
1854 if (!Tmpl->isImplicit() && Tmpl->isThisDeclarationADefinition() &&
1855 !MD->getMemberSpecializationInfo()->isExplicitSpecialization())
1860 static bool shouldOmitDefinition(codegenoptions::DebugInfoKind DebugKind,
1861 bool DebugTypeExtRefs, const RecordDecl *RD,
1862 const LangOptions &LangOpts) {
1863 if (DebugTypeExtRefs && isDefinedInClangModule(RD->getDefinition()))
1866 if (auto *ES = RD->getASTContext().getExternalSource())
1867 if (ES->hasExternalDefinitions(RD) == ExternalASTSource::EK_Always)
1870 if (DebugKind > codegenoptions::LimitedDebugInfo)
1873 if (!LangOpts.CPlusPlus)
1876 if (!RD->isCompleteDefinitionRequired())
1879 const auto *CXXDecl = dyn_cast<CXXRecordDecl>(RD);
1884 // Only emit complete debug info for a dynamic class when its vtable is
1885 // emitted. However, Microsoft debuggers don't resolve type information
1886 // across DLL boundaries, so skip this optimization if the class or any of its
1887 // methods are marked dllimport. This isn't a complete solution, since objects
1888 // without any dllimport methods can be used in one DLL and constructed in
1889 // another, but it is the current behavior of LimitedDebugInfo.
1890 if (CXXDecl->hasDefinition() && CXXDecl->isDynamicClass() &&
1891 !isClassOrMethodDLLImport(CXXDecl))
1894 TemplateSpecializationKind Spec = TSK_Undeclared;
1895 if (const auto *SD = dyn_cast<ClassTemplateSpecializationDecl>(RD))
1896 Spec = SD->getSpecializationKind();
1898 if (Spec == TSK_ExplicitInstantiationDeclaration &&
1899 hasExplicitMemberDefinition(CXXDecl->method_begin(),
1900 CXXDecl->method_end()))
1906 void CGDebugInfo::completeRequiredType(const RecordDecl *RD) {
1907 if (shouldOmitDefinition(DebugKind, DebugTypeExtRefs, RD, CGM.getLangOpts()))
1910 QualType Ty = CGM.getContext().getRecordType(RD);
1911 llvm::DIType *T = getTypeOrNull(Ty);
1912 if (T && T->isForwardDecl())
1913 completeClassData(RD);
1916 llvm::DIType *CGDebugInfo::CreateType(const RecordType *Ty) {
1917 RecordDecl *RD = Ty->getDecl();
1918 llvm::DIType *T = cast_or_null<llvm::DIType>(getTypeOrNull(QualType(Ty, 0)));
1919 if (T || shouldOmitDefinition(DebugKind, DebugTypeExtRefs, RD,
1920 CGM.getLangOpts())) {
1922 T = getOrCreateRecordFwdDecl(Ty, getDeclContextDescriptor(RD));
1926 return CreateTypeDefinition(Ty);
1929 llvm::DIType *CGDebugInfo::CreateTypeDefinition(const RecordType *Ty) {
1930 RecordDecl *RD = Ty->getDecl();
1932 // Get overall information about the record type for the debug info.
1933 llvm::DIFile *DefUnit = getOrCreateFile(RD->getLocation());
1935 // Records and classes and unions can all be recursive. To handle them, we
1936 // first generate a debug descriptor for the struct as a forward declaration.
1937 // Then (if it is a definition) we go through and get debug info for all of
1938 // its members. Finally, we create a descriptor for the complete type (which
1939 // may refer to the forward decl if the struct is recursive) and replace all
1940 // uses of the forward declaration with the final definition.
1941 llvm::DICompositeType *FwdDecl = getOrCreateLimitedType(Ty, DefUnit);
1943 const RecordDecl *D = RD->getDefinition();
1944 if (!D || !D->isCompleteDefinition())
1947 if (const auto *CXXDecl = dyn_cast<CXXRecordDecl>(RD))
1948 CollectContainingType(CXXDecl, FwdDecl);
1950 // Push the struct on region stack.
1951 LexicalBlockStack.emplace_back(&*FwdDecl);
1952 RegionMap[Ty->getDecl()].reset(FwdDecl);
1954 // Convert all the elements.
1955 SmallVector<llvm::Metadata *, 16> EltTys;
1956 // what about nested types?
1958 // Note: The split of CXXDecl information here is intentional, the
1959 // gdb tests will depend on a certain ordering at printout. The debug
1960 // information offsets are still correct if we merge them all together
1962 const auto *CXXDecl = dyn_cast<CXXRecordDecl>(RD);
1964 CollectCXXBases(CXXDecl, DefUnit, EltTys, FwdDecl);
1965 CollectVTableInfo(CXXDecl, DefUnit, EltTys, FwdDecl);
1968 // Collect data fields (including static variables and any initializers).
1969 CollectRecordFields(RD, DefUnit, EltTys, FwdDecl);
1971 CollectCXXMemberFunctions(CXXDecl, DefUnit, EltTys, FwdDecl);
1973 LexicalBlockStack.pop_back();
1974 RegionMap.erase(Ty->getDecl());
1976 llvm::DINodeArray Elements = DBuilder.getOrCreateArray(EltTys);
1977 DBuilder.replaceArrays(FwdDecl, Elements);
1979 if (FwdDecl->isTemporary())
1981 llvm::MDNode::replaceWithPermanent(llvm::TempDICompositeType(FwdDecl));
1983 RegionMap[Ty->getDecl()].reset(FwdDecl);
1987 llvm::DIType *CGDebugInfo::CreateType(const ObjCObjectType *Ty,
1988 llvm::DIFile *Unit) {
1989 // Ignore protocols.
1990 return getOrCreateType(Ty->getBaseType(), Unit);
1993 llvm::DIType *CGDebugInfo::CreateType(const ObjCTypeParamType *Ty,
1994 llvm::DIFile *Unit) {
1995 // Ignore protocols.
1996 SourceLocation Loc = Ty->getDecl()->getLocation();
1998 // Use Typedefs to represent ObjCTypeParamType.
1999 return DBuilder.createTypedef(
2000 getOrCreateType(Ty->getDecl()->getUnderlyingType(), Unit),
2001 Ty->getDecl()->getName(), getOrCreateFile(Loc), getLineNumber(Loc),
2002 getDeclContextDescriptor(Ty->getDecl()));
2005 /// \return true if Getter has the default name for the property PD.
2006 static bool hasDefaultGetterName(const ObjCPropertyDecl *PD,
2007 const ObjCMethodDecl *Getter) {
2012 assert(Getter->getDeclName().isObjCZeroArgSelector());
2013 return PD->getName() ==
2014 Getter->getDeclName().getObjCSelector().getNameForSlot(0);
2017 /// \return true if Setter has the default name for the property PD.
2018 static bool hasDefaultSetterName(const ObjCPropertyDecl *PD,
2019 const ObjCMethodDecl *Setter) {
2024 assert(Setter->getDeclName().isObjCOneArgSelector());
2025 return SelectorTable::constructSetterName(PD->getName()) ==
2026 Setter->getDeclName().getObjCSelector().getNameForSlot(0);
2029 llvm::DIType *CGDebugInfo::CreateType(const ObjCInterfaceType *Ty,
2030 llvm::DIFile *Unit) {
2031 ObjCInterfaceDecl *ID = Ty->getDecl();
2035 // Return a forward declaration if this type was imported from a clang module,
2036 // and this is not the compile unit with the implementation of the type (which
2037 // may contain hidden ivars).
2038 if (DebugTypeExtRefs && ID->isFromASTFile() && ID->getDefinition() &&
2039 !ID->getImplementation())
2040 return DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
2042 getDeclContextDescriptor(ID), Unit, 0);
2044 // Get overall information about the record type for the debug info.
2045 llvm::DIFile *DefUnit = getOrCreateFile(ID->getLocation());
2046 unsigned Line = getLineNumber(ID->getLocation());
2048 static_cast<llvm::dwarf::SourceLanguage>(TheCU->getSourceLanguage());
2050 // If this is just a forward declaration return a special forward-declaration
2051 // debug type since we won't be able to lay out the entire type.
2052 ObjCInterfaceDecl *Def = ID->getDefinition();
2053 if (!Def || !Def->getImplementation()) {
2054 llvm::DIScope *Mod = getParentModuleOrNull(ID);
2055 llvm::DIType *FwdDecl = DBuilder.createReplaceableCompositeType(
2056 llvm::dwarf::DW_TAG_structure_type, ID->getName(), Mod ? Mod : TheCU,
2057 DefUnit, Line, RuntimeLang);
2058 ObjCInterfaceCache.push_back(ObjCInterfaceCacheEntry(Ty, FwdDecl, Unit));
2062 return CreateTypeDefinition(Ty, Unit);
2066 CGDebugInfo::getOrCreateModuleRef(ExternalASTSource::ASTSourceDescriptor Mod,
2067 bool CreateSkeletonCU) {
2068 // Use the Module pointer as the key into the cache. This is a
2069 // nullptr if the "Module" is a PCH, which is safe because we don't
2070 // support chained PCH debug info, so there can only be a single PCH.
2071 const Module *M = Mod.getModuleOrNull();
2072 auto ModRef = ModuleCache.find(M);
2073 if (ModRef != ModuleCache.end())
2074 return cast<llvm::DIModule>(ModRef->second);
2076 // Macro definitions that were defined with "-D" on the command line.
2077 SmallString<128> ConfigMacros;
2079 llvm::raw_svector_ostream OS(ConfigMacros);
2080 const auto &PPOpts = CGM.getPreprocessorOpts();
2082 // Translate the macro definitions back into a commmand line.
2083 for (auto &M : PPOpts.Macros) {
2086 const std::string &Macro = M.first;
2087 bool Undef = M.second;
2088 OS << "\"-" << (Undef ? 'U' : 'D');
2089 for (char c : Macro)
2091 case '\\' : OS << "\\\\"; break;
2092 case '"' : OS << "\\\""; break;
2099 bool IsRootModule = M ? !M->Parent : true;
2100 if (CreateSkeletonCU && IsRootModule) {
2101 // PCH files don't have a signature field in the control block,
2102 // but LLVM detects skeleton CUs by looking for a non-zero DWO id.
2103 // We use the lower 64 bits for debug info.
2104 uint64_t Signature =
2106 ? (uint64_t)Mod.getSignature()[1] << 32 | Mod.getSignature()[0]
2108 llvm::DIBuilder DIB(CGM.getModule());
2109 DIB.createCompileUnit(TheCU->getSourceLanguage(),
2110 DIB.createFile(Mod.getModuleName(), Mod.getPath()),
2111 TheCU->getProducer(), true, StringRef(), 0,
2112 Mod.getASTFile(), llvm::DICompileUnit::FullDebug,
2116 llvm::DIModule *Parent =
2117 IsRootModule ? nullptr
2118 : getOrCreateModuleRef(
2119 ExternalASTSource::ASTSourceDescriptor(*M->Parent),
2121 llvm::DIModule *DIMod =
2122 DBuilder.createModule(Parent, Mod.getModuleName(), ConfigMacros,
2123 Mod.getPath(), CGM.getHeaderSearchOpts().Sysroot);
2124 ModuleCache[M].reset(DIMod);
2128 llvm::DIType *CGDebugInfo::CreateTypeDefinition(const ObjCInterfaceType *Ty,
2129 llvm::DIFile *Unit) {
2130 ObjCInterfaceDecl *ID = Ty->getDecl();
2131 llvm::DIFile *DefUnit = getOrCreateFile(ID->getLocation());
2132 unsigned Line = getLineNumber(ID->getLocation());
2133 unsigned RuntimeLang = TheCU->getSourceLanguage();
2135 // Bit size, align and offset of the type.
2136 uint64_t Size = CGM.getContext().getTypeSize(Ty);
2137 auto Align = getTypeAlignIfRequired(Ty, CGM.getContext());
2139 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
2140 if (ID->getImplementation())
2141 Flags |= llvm::DINode::FlagObjcClassComplete;
2143 llvm::DIScope *Mod = getParentModuleOrNull(ID);
2144 llvm::DICompositeType *RealDecl = DBuilder.createStructType(
2145 Mod ? Mod : Unit, ID->getName(), DefUnit, Line, Size, Align, Flags,
2146 nullptr, llvm::DINodeArray(), RuntimeLang);
2148 QualType QTy(Ty, 0);
2149 TypeCache[QTy.getAsOpaquePtr()].reset(RealDecl);
2151 // Push the struct on region stack.
2152 LexicalBlockStack.emplace_back(RealDecl);
2153 RegionMap[Ty->getDecl()].reset(RealDecl);
2155 // Convert all the elements.
2156 SmallVector<llvm::Metadata *, 16> EltTys;
2158 ObjCInterfaceDecl *SClass = ID->getSuperClass();
2160 llvm::DIType *SClassTy =
2161 getOrCreateType(CGM.getContext().getObjCInterfaceType(SClass), Unit);
2165 llvm::DIType *InhTag = DBuilder.createInheritance(RealDecl, SClassTy, 0,
2166 llvm::DINode::FlagZero);
2167 EltTys.push_back(InhTag);
2170 // Create entries for all of the properties.
2171 auto AddProperty = [&](const ObjCPropertyDecl *PD) {
2172 SourceLocation Loc = PD->getLocation();
2173 llvm::DIFile *PUnit = getOrCreateFile(Loc);
2174 unsigned PLine = getLineNumber(Loc);
2175 ObjCMethodDecl *Getter = PD->getGetterMethodDecl();
2176 ObjCMethodDecl *Setter = PD->getSetterMethodDecl();
2177 llvm::MDNode *PropertyNode = DBuilder.createObjCProperty(
2178 PD->getName(), PUnit, PLine,
2179 hasDefaultGetterName(PD, Getter) ? ""
2180 : getSelectorName(PD->getGetterName()),
2181 hasDefaultSetterName(PD, Setter) ? ""
2182 : getSelectorName(PD->getSetterName()),
2183 PD->getPropertyAttributes(), getOrCreateType(PD->getType(), PUnit));
2184 EltTys.push_back(PropertyNode);
2187 llvm::SmallPtrSet<const IdentifierInfo*, 16> PropertySet;
2188 for (const ObjCCategoryDecl *ClassExt : ID->known_extensions())
2189 for (auto *PD : ClassExt->properties()) {
2190 PropertySet.insert(PD->getIdentifier());
2193 for (const auto *PD : ID->properties()) {
2194 // Don't emit duplicate metadata for properties that were already in a
2196 if (!PropertySet.insert(PD->getIdentifier()).second)
2202 const ASTRecordLayout &RL = CGM.getContext().getASTObjCInterfaceLayout(ID);
2203 unsigned FieldNo = 0;
2204 for (ObjCIvarDecl *Field = ID->all_declared_ivar_begin(); Field;
2205 Field = Field->getNextIvar(), ++FieldNo) {
2206 llvm::DIType *FieldTy = getOrCreateType(Field->getType(), Unit);
2210 StringRef FieldName = Field->getName();
2212 // Ignore unnamed fields.
2213 if (FieldName.empty())
2216 // Get the location for the field.
2217 llvm::DIFile *FieldDefUnit = getOrCreateFile(Field->getLocation());
2218 unsigned FieldLine = getLineNumber(Field->getLocation());
2219 QualType FType = Field->getType();
2220 uint64_t FieldSize = 0;
2221 uint32_t FieldAlign = 0;
2223 if (!FType->isIncompleteArrayType()) {
2225 // Bit size, align and offset of the type.
2226 FieldSize = Field->isBitField()
2227 ? Field->getBitWidthValue(CGM.getContext())
2228 : CGM.getContext().getTypeSize(FType);
2229 FieldAlign = getTypeAlignIfRequired(FType, CGM.getContext());
2232 uint64_t FieldOffset;
2233 if (CGM.getLangOpts().ObjCRuntime.isNonFragile()) {
2234 // We don't know the runtime offset of an ivar if we're using the
2235 // non-fragile ABI. For bitfields, use the bit offset into the first
2236 // byte of storage of the bitfield. For other fields, use zero.
2237 if (Field->isBitField()) {
2239 CGM.getObjCRuntime().ComputeBitfieldBitOffset(CGM, ID, Field);
2240 FieldOffset %= CGM.getContext().getCharWidth();
2245 FieldOffset = RL.getFieldOffset(FieldNo);
2248 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
2249 if (Field->getAccessControl() == ObjCIvarDecl::Protected)
2250 Flags = llvm::DINode::FlagProtected;
2251 else if (Field->getAccessControl() == ObjCIvarDecl::Private)
2252 Flags = llvm::DINode::FlagPrivate;
2253 else if (Field->getAccessControl() == ObjCIvarDecl::Public)
2254 Flags = llvm::DINode::FlagPublic;
2256 llvm::MDNode *PropertyNode = nullptr;
2257 if (ObjCImplementationDecl *ImpD = ID->getImplementation()) {
2258 if (ObjCPropertyImplDecl *PImpD =
2259 ImpD->FindPropertyImplIvarDecl(Field->getIdentifier())) {
2260 if (ObjCPropertyDecl *PD = PImpD->getPropertyDecl()) {
2261 SourceLocation Loc = PD->getLocation();
2262 llvm::DIFile *PUnit = getOrCreateFile(Loc);
2263 unsigned PLine = getLineNumber(Loc);
2264 ObjCMethodDecl *Getter = PD->getGetterMethodDecl();
2265 ObjCMethodDecl *Setter = PD->getSetterMethodDecl();
2266 PropertyNode = DBuilder.createObjCProperty(
2267 PD->getName(), PUnit, PLine,
2268 hasDefaultGetterName(PD, Getter) ? "" : getSelectorName(
2269 PD->getGetterName()),
2270 hasDefaultSetterName(PD, Setter) ? "" : getSelectorName(
2271 PD->getSetterName()),
2272 PD->getPropertyAttributes(),
2273 getOrCreateType(PD->getType(), PUnit));
2277 FieldTy = DBuilder.createObjCIVar(FieldName, FieldDefUnit, FieldLine,
2278 FieldSize, FieldAlign, FieldOffset, Flags,
2279 FieldTy, PropertyNode);
2280 EltTys.push_back(FieldTy);
2283 llvm::DINodeArray Elements = DBuilder.getOrCreateArray(EltTys);
2284 DBuilder.replaceArrays(RealDecl, Elements);
2286 LexicalBlockStack.pop_back();
2290 llvm::DIType *CGDebugInfo::CreateType(const VectorType *Ty,
2291 llvm::DIFile *Unit) {
2292 llvm::DIType *ElementTy = getOrCreateType(Ty->getElementType(), Unit);
2293 int64_t Count = Ty->getNumElements();
2295 // If number of elements are not known then this is an unbounded array.
2296 // Use Count == -1 to express such arrays.
2299 llvm::Metadata *Subscript = DBuilder.getOrCreateSubrange(0, Count);
2300 llvm::DINodeArray SubscriptArray = DBuilder.getOrCreateArray(Subscript);
2302 uint64_t Size = CGM.getContext().getTypeSize(Ty);
2303 auto Align = getTypeAlignIfRequired(Ty, CGM.getContext());
2305 return DBuilder.createVectorType(Size, Align, ElementTy, SubscriptArray);
2308 llvm::DIType *CGDebugInfo::CreateType(const ArrayType *Ty, llvm::DIFile *Unit) {
2312 // FIXME: make getTypeAlign() aware of VLAs and incomplete array types
2313 if (const auto *VAT = dyn_cast<VariableArrayType>(Ty)) {
2315 Align = getTypeAlignIfRequired(CGM.getContext().getBaseElementType(VAT),
2317 } else if (Ty->isIncompleteArrayType()) {
2319 if (Ty->getElementType()->isIncompleteType())
2322 Align = getTypeAlignIfRequired(Ty->getElementType(), CGM.getContext());
2323 } else if (Ty->isIncompleteType()) {
2327 // Size and align of the whole array, not the element type.
2328 Size = CGM.getContext().getTypeSize(Ty);
2329 Align = getTypeAlignIfRequired(Ty, CGM.getContext());
2332 // Add the dimensions of the array. FIXME: This loses CV qualifiers from
2333 // interior arrays, do we care? Why aren't nested arrays represented the
2334 // obvious/recursive way?
2335 SmallVector<llvm::Metadata *, 8> Subscripts;
2336 QualType EltTy(Ty, 0);
2337 while ((Ty = dyn_cast<ArrayType>(EltTy))) {
2338 // If the number of elements is known, then count is that number. Otherwise,
2339 // it's -1. This allows us to represent a subrange with an array of 0
2340 // elements, like this:
2345 int64_t Count = -1; // Count == -1 is an unbounded array.
2346 if (const auto *CAT = dyn_cast<ConstantArrayType>(Ty))
2347 Count = CAT->getSize().getZExtValue();
2348 else if (const auto *VAT = dyn_cast<VariableArrayType>(Ty)) {
2349 if (Expr *Size = VAT->getSizeExpr()) {
2351 if (Size->EvaluateAsInt(V, CGM.getContext()))
2352 Count = V.getExtValue();
2356 // FIXME: Verify this is right for VLAs.
2357 Subscripts.push_back(DBuilder.getOrCreateSubrange(0, Count));
2358 EltTy = Ty->getElementType();
2361 llvm::DINodeArray SubscriptArray = DBuilder.getOrCreateArray(Subscripts);
2363 return DBuilder.createArrayType(Size, Align, getOrCreateType(EltTy, Unit),
2367 llvm::DIType *CGDebugInfo::CreateType(const LValueReferenceType *Ty,
2368 llvm::DIFile *Unit) {
2369 return CreatePointerLikeType(llvm::dwarf::DW_TAG_reference_type, Ty,
2370 Ty->getPointeeType(), Unit);
2373 llvm::DIType *CGDebugInfo::CreateType(const RValueReferenceType *Ty,
2374 llvm::DIFile *Unit) {
2375 return CreatePointerLikeType(llvm::dwarf::DW_TAG_rvalue_reference_type, Ty,
2376 Ty->getPointeeType(), Unit);
2379 llvm::DIType *CGDebugInfo::CreateType(const MemberPointerType *Ty,
2381 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
2384 if (!Ty->isIncompleteType()) {
2385 Size = CGM.getContext().getTypeSize(Ty);
2387 // Set the MS inheritance model. There is no flag for the unspecified model.
2388 if (CGM.getTarget().getCXXABI().isMicrosoft()) {
2389 switch (Ty->getMostRecentCXXRecordDecl()->getMSInheritanceModel()) {
2390 case MSInheritanceAttr::Keyword_single_inheritance:
2391 Flags |= llvm::DINode::FlagSingleInheritance;
2393 case MSInheritanceAttr::Keyword_multiple_inheritance:
2394 Flags |= llvm::DINode::FlagMultipleInheritance;
2396 case MSInheritanceAttr::Keyword_virtual_inheritance:
2397 Flags |= llvm::DINode::FlagVirtualInheritance;
2399 case MSInheritanceAttr::Keyword_unspecified_inheritance:
2405 llvm::DIType *ClassType = getOrCreateType(QualType(Ty->getClass(), 0), U);
2406 if (Ty->isMemberDataPointerType())
2407 return DBuilder.createMemberPointerType(
2408 getOrCreateType(Ty->getPointeeType(), U), ClassType, Size, /*Align=*/0,
2411 const FunctionProtoType *FPT =
2412 Ty->getPointeeType()->getAs<FunctionProtoType>();
2413 return DBuilder.createMemberPointerType(
2414 getOrCreateInstanceMethodType(CGM.getContext().getPointerType(QualType(
2415 Ty->getClass(), FPT->getTypeQuals())),
2417 ClassType, Size, /*Align=*/0, Flags);
2420 llvm::DIType *CGDebugInfo::CreateType(const AtomicType *Ty, llvm::DIFile *U) {
2421 auto *FromTy = getOrCreateType(Ty->getValueType(), U);
2422 return DBuilder.createQualifiedType(llvm::dwarf::DW_TAG_atomic_type, FromTy);
2425 llvm::DIType* CGDebugInfo::CreateType(const PipeType *Ty,
2427 return getOrCreateType(Ty->getElementType(), U);
2430 llvm::DIType *CGDebugInfo::CreateEnumType(const EnumType *Ty) {
2431 const EnumDecl *ED = Ty->getDecl();
2435 if (!ED->getTypeForDecl()->isIncompleteType()) {
2436 Size = CGM.getContext().getTypeSize(ED->getTypeForDecl());
2437 Align = getDeclAlignIfRequired(ED, CGM.getContext());
2440 SmallString<256> FullName = getUniqueTagTypeName(Ty, CGM, TheCU);
2442 bool isImportedFromModule =
2443 DebugTypeExtRefs && ED->isFromASTFile() && ED->getDefinition();
2445 // If this is just a forward declaration, construct an appropriately
2446 // marked node and just return it.
2447 if (isImportedFromModule || !ED->getDefinition()) {
2448 // Note that it is possible for enums to be created as part of
2449 // their own declcontext. In this case a FwdDecl will be created
2450 // twice. This doesn't cause a problem because both FwdDecls are
2451 // entered into the ReplaceMap: finalize() will replace the first
2452 // FwdDecl with the second and then replace the second with
2454 llvm::DIScope *EDContext = getDeclContextDescriptor(ED);
2455 llvm::DIFile *DefUnit = getOrCreateFile(ED->getLocation());
2456 llvm::TempDIScope TmpContext(DBuilder.createReplaceableCompositeType(
2457 llvm::dwarf::DW_TAG_enumeration_type, "", TheCU, DefUnit, 0));
2459 unsigned Line = getLineNumber(ED->getLocation());
2460 StringRef EDName = ED->getName();
2461 llvm::DIType *RetTy = DBuilder.createReplaceableCompositeType(
2462 llvm::dwarf::DW_TAG_enumeration_type, EDName, EDContext, DefUnit, Line,
2463 0, Size, Align, llvm::DINode::FlagFwdDecl, FullName);
2465 ReplaceMap.emplace_back(
2466 std::piecewise_construct, std::make_tuple(Ty),
2467 std::make_tuple(static_cast<llvm::Metadata *>(RetTy)));
2471 return CreateTypeDefinition(Ty);
2474 llvm::DIType *CGDebugInfo::CreateTypeDefinition(const EnumType *Ty) {
2475 const EnumDecl *ED = Ty->getDecl();
2478 if (!ED->getTypeForDecl()->isIncompleteType()) {
2479 Size = CGM.getContext().getTypeSize(ED->getTypeForDecl());
2480 Align = getDeclAlignIfRequired(ED, CGM.getContext());
2483 SmallString<256> FullName = getUniqueTagTypeName(Ty, CGM, TheCU);
2485 // Create elements for each enumerator.
2486 SmallVector<llvm::Metadata *, 16> Enumerators;
2487 ED = ED->getDefinition();
2488 for (const auto *Enum : ED->enumerators()) {
2489 Enumerators.push_back(DBuilder.createEnumerator(
2490 Enum->getName(), Enum->getInitVal().getSExtValue()));
2493 // Return a CompositeType for the enum itself.
2494 llvm::DINodeArray EltArray = DBuilder.getOrCreateArray(Enumerators);
2496 llvm::DIFile *DefUnit = getOrCreateFile(ED->getLocation());
2497 unsigned Line = getLineNumber(ED->getLocation());
2498 llvm::DIScope *EnumContext = getDeclContextDescriptor(ED);
2499 llvm::DIType *ClassTy =
2500 ED->isFixed() ? getOrCreateType(ED->getIntegerType(), DefUnit) : nullptr;
2501 return DBuilder.createEnumerationType(EnumContext, ED->getName(), DefUnit,
2502 Line, Size, Align, EltArray, ClassTy,
2506 llvm::DIMacro *CGDebugInfo::CreateMacro(llvm::DIMacroFile *Parent,
2507 unsigned MType, SourceLocation LineLoc,
2508 StringRef Name, StringRef Value) {
2509 unsigned Line = LineLoc.isInvalid() ? 0 : getLineNumber(LineLoc);
2510 return DBuilder.createMacro(Parent, Line, MType, Name, Value);
2513 llvm::DIMacroFile *CGDebugInfo::CreateTempMacroFile(llvm::DIMacroFile *Parent,
2514 SourceLocation LineLoc,
2515 SourceLocation FileLoc) {
2516 llvm::DIFile *FName = getOrCreateFile(FileLoc);
2517 unsigned Line = LineLoc.isInvalid() ? 0 : getLineNumber(LineLoc);
2518 return DBuilder.createTempMacroFile(Parent, Line, FName);
2521 static QualType UnwrapTypeForDebugInfo(QualType T, const ASTContext &C) {
2524 Qualifiers InnerQuals = T.getLocalQualifiers();
2525 // Qualifiers::operator+() doesn't like it if you add a Qualifier
2526 // that is already there.
2527 Quals += Qualifiers::removeCommonQualifiers(Quals, InnerQuals);
2528 Quals += InnerQuals;
2530 switch (T->getTypeClass()) {
2532 return C.getQualifiedType(T.getTypePtr(), Quals);
2533 case Type::TemplateSpecialization: {
2534 const auto *Spec = cast<TemplateSpecializationType>(T);
2535 if (Spec->isTypeAlias())
2536 return C.getQualifiedType(T.getTypePtr(), Quals);
2537 T = Spec->desugar();
2540 case Type::TypeOfExpr:
2541 T = cast<TypeOfExprType>(T)->getUnderlyingExpr()->getType();
2544 T = cast<TypeOfType>(T)->getUnderlyingType();
2546 case Type::Decltype:
2547 T = cast<DecltypeType>(T)->getUnderlyingType();
2549 case Type::UnaryTransform:
2550 T = cast<UnaryTransformType>(T)->getUnderlyingType();
2552 case Type::Attributed:
2553 T = cast<AttributedType>(T)->getEquivalentType();
2555 case Type::Elaborated:
2556 T = cast<ElaboratedType>(T)->getNamedType();
2559 T = cast<ParenType>(T)->getInnerType();
2561 case Type::SubstTemplateTypeParm:
2562 T = cast<SubstTemplateTypeParmType>(T)->getReplacementType();
2565 case Type::DeducedTemplateSpecialization: {
2566 QualType DT = cast<DeducedType>(T)->getDeducedType();
2567 assert(!DT.isNull() && "Undeduced types shouldn't reach here.");
2571 case Type::Adjusted:
2573 // Decayed and adjusted types use the adjusted type in LLVM and DWARF.
2574 T = cast<AdjustedType>(T)->getAdjustedType();
2578 assert(T != LastT && "Type unwrapping failed to unwrap!");
2583 llvm::DIType *CGDebugInfo::getTypeOrNull(QualType Ty) {
2585 // Unwrap the type as needed for debug information.
2586 Ty = UnwrapTypeForDebugInfo(Ty, CGM.getContext());
2588 auto it = TypeCache.find(Ty.getAsOpaquePtr());
2589 if (it != TypeCache.end()) {
2590 // Verify that the debug info still exists.
2591 if (llvm::Metadata *V = it->second)
2592 return cast<llvm::DIType>(V);
2598 void CGDebugInfo::completeTemplateDefinition(
2599 const ClassTemplateSpecializationDecl &SD) {
2600 if (DebugKind <= codegenoptions::DebugLineTablesOnly)
2602 completeUnusedClass(SD);
2605 void CGDebugInfo::completeUnusedClass(const CXXRecordDecl &D) {
2606 if (DebugKind <= codegenoptions::DebugLineTablesOnly)
2609 completeClassData(&D);
2610 // In case this type has no member function definitions being emitted, ensure
2612 RetainedTypes.push_back(CGM.getContext().getRecordType(&D).getAsOpaquePtr());
2615 llvm::DIType *CGDebugInfo::getOrCreateType(QualType Ty, llvm::DIFile *Unit) {
2619 // Unwrap the type as needed for debug information.
2620 Ty = UnwrapTypeForDebugInfo(Ty, CGM.getContext());
2622 if (auto *T = getTypeOrNull(Ty))
2625 llvm::DIType *Res = CreateTypeNode(Ty, Unit);
2626 void* TyPtr = Ty.getAsOpaquePtr();
2628 // And update the type cache.
2629 TypeCache[TyPtr].reset(Res);
2634 llvm::DIModule *CGDebugInfo::getParentModuleOrNull(const Decl *D) {
2635 // A forward declaration inside a module header does not belong to the module.
2636 if (isa<RecordDecl>(D) && !cast<RecordDecl>(D)->getDefinition())
2638 if (DebugTypeExtRefs && D->isFromASTFile()) {
2639 // Record a reference to an imported clang module or precompiled header.
2640 auto *Reader = CGM.getContext().getExternalSource();
2641 auto Idx = D->getOwningModuleID();
2642 auto Info = Reader->getSourceDescriptor(Idx);
2644 return getOrCreateModuleRef(*Info, /*SkeletonCU=*/true);
2645 } else if (ClangModuleMap) {
2646 // We are building a clang module or a precompiled header.
2648 // TODO: When D is a CXXRecordDecl or a C++ Enum, the ODR applies
2649 // and it wouldn't be necessary to specify the parent scope
2650 // because the type is already unique by definition (it would look
2651 // like the output of -fno-standalone-debug). On the other hand,
2652 // the parent scope helps a consumer to quickly locate the object
2653 // file where the type's definition is located, so it might be
2654 // best to make this behavior a command line or debugger tuning
2656 if (Module *M = D->getOwningModule()) {
2657 // This is a (sub-)module.
2658 auto Info = ExternalASTSource::ASTSourceDescriptor(*M);
2659 return getOrCreateModuleRef(Info, /*SkeletonCU=*/false);
2661 // This the precompiled header being built.
2662 return getOrCreateModuleRef(PCHDescriptor, /*SkeletonCU=*/false);
2669 llvm::DIType *CGDebugInfo::CreateTypeNode(QualType Ty, llvm::DIFile *Unit) {
2670 // Handle qualifiers, which recursively handles what they refer to.
2671 if (Ty.hasLocalQualifiers())
2672 return CreateQualifiedType(Ty, Unit);
2674 // Work out details of type.
2675 switch (Ty->getTypeClass()) {
2676 #define TYPE(Class, Base)
2677 #define ABSTRACT_TYPE(Class, Base)
2678 #define NON_CANONICAL_TYPE(Class, Base)
2679 #define DEPENDENT_TYPE(Class, Base) case Type::Class:
2680 #include "clang/AST/TypeNodes.def"
2681 llvm_unreachable("Dependent types cannot show up in debug information");
2683 case Type::ExtVector:
2685 return CreateType(cast<VectorType>(Ty), Unit);
2686 case Type::ObjCObjectPointer:
2687 return CreateType(cast<ObjCObjectPointerType>(Ty), Unit);
2688 case Type::ObjCObject:
2689 return CreateType(cast<ObjCObjectType>(Ty), Unit);
2690 case Type::ObjCTypeParam:
2691 return CreateType(cast<ObjCTypeParamType>(Ty), Unit);
2692 case Type::ObjCInterface:
2693 return CreateType(cast<ObjCInterfaceType>(Ty), Unit);
2695 return CreateType(cast<BuiltinType>(Ty));
2697 return CreateType(cast<ComplexType>(Ty));
2699 return CreateType(cast<PointerType>(Ty), Unit);
2700 case Type::BlockPointer:
2701 return CreateType(cast<BlockPointerType>(Ty), Unit);
2703 return CreateType(cast<TypedefType>(Ty), Unit);
2705 return CreateType(cast<RecordType>(Ty));
2707 return CreateEnumType(cast<EnumType>(Ty));
2708 case Type::FunctionProto:
2709 case Type::FunctionNoProto:
2710 return CreateType(cast<FunctionType>(Ty), Unit);
2711 case Type::ConstantArray:
2712 case Type::VariableArray:
2713 case Type::IncompleteArray:
2714 return CreateType(cast<ArrayType>(Ty), Unit);
2716 case Type::LValueReference:
2717 return CreateType(cast<LValueReferenceType>(Ty), Unit);
2718 case Type::RValueReference:
2719 return CreateType(cast<RValueReferenceType>(Ty), Unit);
2721 case Type::MemberPointer:
2722 return CreateType(cast<MemberPointerType>(Ty), Unit);
2725 return CreateType(cast<AtomicType>(Ty), Unit);
2728 return CreateType(cast<PipeType>(Ty), Unit);
2730 case Type::TemplateSpecialization:
2731 return CreateType(cast<TemplateSpecializationType>(Ty), Unit);
2734 case Type::Attributed:
2735 case Type::Adjusted:
2737 case Type::DeducedTemplateSpecialization:
2738 case Type::Elaborated:
2740 case Type::SubstTemplateTypeParm:
2741 case Type::TypeOfExpr:
2743 case Type::Decltype:
2744 case Type::UnaryTransform:
2745 case Type::PackExpansion:
2749 llvm_unreachable("type should have been unwrapped!");
2752 llvm::DICompositeType *CGDebugInfo::getOrCreateLimitedType(const RecordType *Ty,
2753 llvm::DIFile *Unit) {
2754 QualType QTy(Ty, 0);
2756 auto *T = cast_or_null<llvm::DICompositeType>(getTypeOrNull(QTy));
2758 // We may have cached a forward decl when we could have created
2759 // a non-forward decl. Go ahead and create a non-forward decl
2761 if (T && !T->isForwardDecl())
2764 // Otherwise create the type.
2765 llvm::DICompositeType *Res = CreateLimitedType(Ty);
2767 // Propagate members from the declaration to the definition
2768 // CreateType(const RecordType*) will overwrite this with the members in the
2769 // correct order if the full type is needed.
2770 DBuilder.replaceArrays(Res, T ? T->getElements() : llvm::DINodeArray());
2772 // And update the type cache.
2773 TypeCache[QTy.getAsOpaquePtr()].reset(Res);
2777 // TODO: Currently used for context chains when limiting debug info.
2778 llvm::DICompositeType *CGDebugInfo::CreateLimitedType(const RecordType *Ty) {
2779 RecordDecl *RD = Ty->getDecl();
2781 // Get overall information about the record type for the debug info.
2782 llvm::DIFile *DefUnit = getOrCreateFile(RD->getLocation());
2783 unsigned Line = getLineNumber(RD->getLocation());
2784 StringRef RDName = getClassName(RD);
2786 llvm::DIScope *RDContext = getDeclContextDescriptor(RD);
2788 // If we ended up creating the type during the context chain construction,
2789 // just return that.
2790 auto *T = cast_or_null<llvm::DICompositeType>(
2791 getTypeOrNull(CGM.getContext().getRecordType(RD)));
2792 if (T && (!T->isForwardDecl() || !RD->getDefinition()))
2795 // If this is just a forward or incomplete declaration, construct an
2796 // appropriately marked node and just return it.
2797 const RecordDecl *D = RD->getDefinition();
2798 if (!D || !D->isCompleteDefinition())
2799 return getOrCreateRecordFwdDecl(Ty, RDContext);
2801 uint64_t Size = CGM.getContext().getTypeSize(Ty);
2802 auto Align = getDeclAlignIfRequired(D, CGM.getContext());
2804 SmallString<256> FullName = getUniqueTagTypeName(Ty, CGM, TheCU);
2806 llvm::DICompositeType *RealDecl = DBuilder.createReplaceableCompositeType(
2807 getTagForRecord(RD), RDName, RDContext, DefUnit, Line, 0, Size, Align,
2808 llvm::DINode::FlagZero, FullName);
2810 // Elements of composite types usually have back to the type, creating
2811 // uniquing cycles. Distinct nodes are more efficient.
2812 switch (RealDecl->getTag()) {
2814 llvm_unreachable("invalid composite type tag");
2816 case llvm::dwarf::DW_TAG_array_type:
2817 case llvm::dwarf::DW_TAG_enumeration_type:
2818 // Array elements and most enumeration elements don't have back references,
2819 // so they don't tend to be involved in uniquing cycles and there is some
2820 // chance of merging them when linking together two modules. Only make
2821 // them distinct if they are ODR-uniqued.
2822 if (FullName.empty())
2826 case llvm::dwarf::DW_TAG_structure_type:
2827 case llvm::dwarf::DW_TAG_union_type:
2828 case llvm::dwarf::DW_TAG_class_type:
2829 // Immediatley resolve to a distinct node.
2831 llvm::MDNode::replaceWithDistinct(llvm::TempDICompositeType(RealDecl));
2835 RegionMap[Ty->getDecl()].reset(RealDecl);
2836 TypeCache[QualType(Ty, 0).getAsOpaquePtr()].reset(RealDecl);
2838 if (const auto *TSpecial = dyn_cast<ClassTemplateSpecializationDecl>(RD))
2839 DBuilder.replaceArrays(RealDecl, llvm::DINodeArray(),
2840 CollectCXXTemplateParams(TSpecial, DefUnit));
2844 void CGDebugInfo::CollectContainingType(const CXXRecordDecl *RD,
2845 llvm::DICompositeType *RealDecl) {
2846 // A class's primary base or the class itself contains the vtable.
2847 llvm::DICompositeType *ContainingType = nullptr;
2848 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
2849 if (const CXXRecordDecl *PBase = RL.getPrimaryBase()) {
2850 // Seek non-virtual primary base root.
2852 const ASTRecordLayout &BRL = CGM.getContext().getASTRecordLayout(PBase);
2853 const CXXRecordDecl *PBT = BRL.getPrimaryBase();
2854 if (PBT && !BRL.isPrimaryBaseVirtual())
2859 ContainingType = cast<llvm::DICompositeType>(
2860 getOrCreateType(QualType(PBase->getTypeForDecl(), 0),
2861 getOrCreateFile(RD->getLocation())));
2862 } else if (RD->isDynamicClass())
2863 ContainingType = RealDecl;
2865 DBuilder.replaceVTableHolder(RealDecl, ContainingType);
2868 llvm::DIType *CGDebugInfo::CreateMemberType(llvm::DIFile *Unit, QualType FType,
2869 StringRef Name, uint64_t *Offset) {
2870 llvm::DIType *FieldTy = CGDebugInfo::getOrCreateType(FType, Unit);
2871 uint64_t FieldSize = CGM.getContext().getTypeSize(FType);
2872 auto FieldAlign = getTypeAlignIfRequired(FType, CGM.getContext());
2874 DBuilder.createMemberType(Unit, Name, Unit, 0, FieldSize, FieldAlign,
2875 *Offset, llvm::DINode::FlagZero, FieldTy);
2876 *Offset += FieldSize;
2880 void CGDebugInfo::collectFunctionDeclProps(GlobalDecl GD, llvm::DIFile *Unit,
2882 StringRef &LinkageName,
2883 llvm::DIScope *&FDContext,
2884 llvm::DINodeArray &TParamsArray,
2885 llvm::DINode::DIFlags &Flags) {
2886 const auto *FD = cast<FunctionDecl>(GD.getDecl());
2887 Name = getFunctionName(FD);
2888 // Use mangled name as linkage name for C/C++ functions.
2889 if (FD->hasPrototype()) {
2890 LinkageName = CGM.getMangledName(GD);
2891 Flags |= llvm::DINode::FlagPrototyped;
2893 // No need to replicate the linkage name if it isn't different from the
2894 // subprogram name, no need to have it at all unless coverage is enabled or
2895 // debug is set to more than just line tables or extra debug info is needed.
2896 if (LinkageName == Name || (!CGM.getCodeGenOpts().EmitGcovArcs &&
2897 !CGM.getCodeGenOpts().EmitGcovNotes &&
2898 !CGM.getCodeGenOpts().DebugInfoForProfiling &&
2899 DebugKind <= codegenoptions::DebugLineTablesOnly))
2900 LinkageName = StringRef();
2902 if (DebugKind >= codegenoptions::LimitedDebugInfo) {
2903 if (const NamespaceDecl *NSDecl =
2904 dyn_cast_or_null<NamespaceDecl>(FD->getDeclContext()))
2905 FDContext = getOrCreateNamespace(NSDecl);
2906 else if (const RecordDecl *RDecl =
2907 dyn_cast_or_null<RecordDecl>(FD->getDeclContext())) {
2908 llvm::DIScope *Mod = getParentModuleOrNull(RDecl);
2909 FDContext = getContextDescriptor(RDecl, Mod ? Mod : TheCU);
2911 // Check if it is a noreturn-marked function
2912 if (FD->isNoReturn())
2913 Flags |= llvm::DINode::FlagNoReturn;
2914 // Collect template parameters.
2915 TParamsArray = CollectFunctionTemplateParams(FD, Unit);
2919 void CGDebugInfo::collectVarDeclProps(const VarDecl *VD, llvm::DIFile *&Unit,
2920 unsigned &LineNo, QualType &T,
2921 StringRef &Name, StringRef &LinkageName,
2922 llvm::DIScope *&VDContext) {
2923 Unit = getOrCreateFile(VD->getLocation());
2924 LineNo = getLineNumber(VD->getLocation());
2926 setLocation(VD->getLocation());
2929 if (T->isIncompleteArrayType()) {
2930 // CodeGen turns int[] into int[1] so we'll do the same here.
2931 llvm::APInt ConstVal(32, 1);
2932 QualType ET = CGM.getContext().getAsArrayType(T)->getElementType();
2934 T = CGM.getContext().getConstantArrayType(ET, ConstVal,
2935 ArrayType::Normal, 0);
2938 Name = VD->getName();
2939 if (VD->getDeclContext() && !isa<FunctionDecl>(VD->getDeclContext()) &&
2940 !isa<ObjCMethodDecl>(VD->getDeclContext()))
2941 LinkageName = CGM.getMangledName(VD);
2942 if (LinkageName == Name)
2943 LinkageName = StringRef();
2945 // Since we emit declarations (DW_AT_members) for static members, place the
2946 // definition of those static members in the namespace they were declared in
2947 // in the source code (the lexical decl context).
2948 // FIXME: Generalize this for even non-member global variables where the
2949 // declaration and definition may have different lexical decl contexts, once
2950 // we have support for emitting declarations of (non-member) global variables.
2951 const DeclContext *DC = VD->isStaticDataMember() ? VD->getLexicalDeclContext()
2952 : VD->getDeclContext();
2953 // When a record type contains an in-line initialization of a static data
2954 // member, and the record type is marked as __declspec(dllexport), an implicit
2955 // definition of the member will be created in the record context. DWARF
2956 // doesn't seem to have a nice way to describe this in a form that consumers
2957 // are likely to understand, so fake the "normal" situation of a definition
2958 // outside the class by putting it in the global scope.
2960 DC = CGM.getContext().getTranslationUnitDecl();
2962 llvm::DIScope *Mod = getParentModuleOrNull(VD);
2963 VDContext = getContextDescriptor(cast<Decl>(DC), Mod ? Mod : TheCU);
2966 llvm::DISubprogram *CGDebugInfo::getFunctionFwdDeclOrStub(GlobalDecl GD,
2968 llvm::DINodeArray TParamsArray;
2969 StringRef Name, LinkageName;
2970 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
2971 SourceLocation Loc = GD.getDecl()->getLocation();
2972 llvm::DIFile *Unit = getOrCreateFile(Loc);
2973 llvm::DIScope *DContext = Unit;
2974 unsigned Line = getLineNumber(Loc);
2975 collectFunctionDeclProps(GD, Unit, Name, LinkageName, DContext,
2976 TParamsArray, Flags);
2977 auto *FD = dyn_cast<FunctionDecl>(GD.getDecl());
2979 // Build function type.
2980 SmallVector<QualType, 16> ArgTypes;
2982 for (const ParmVarDecl *Parm : FD->parameters())
2983 ArgTypes.push_back(Parm->getType());
2984 CallingConv CC = FD->getType()->castAs<FunctionType>()->getCallConv();
2985 QualType FnType = CGM.getContext().getFunctionType(
2986 FD->getReturnType(), ArgTypes, FunctionProtoType::ExtProtoInfo(CC));
2988 return DBuilder.createFunction(
2989 DContext, Name, LinkageName, Unit, Line,
2990 getOrCreateFunctionType(GD.getDecl(), FnType, Unit),
2991 !FD->isExternallyVisible(),
2992 /* isDefinition = */ true, 0, Flags, CGM.getLangOpts().Optimize,
2993 TParamsArray.get(), getFunctionDeclaration(FD));
2996 llvm::DISubprogram *SP = DBuilder.createTempFunctionFwdDecl(
2997 DContext, Name, LinkageName, Unit, Line,
2998 getOrCreateFunctionType(GD.getDecl(), FnType, Unit),
2999 !FD->isExternallyVisible(),
3000 /* isDefinition = */ false, 0, Flags, CGM.getLangOpts().Optimize,
3001 TParamsArray.get(), getFunctionDeclaration(FD));
3002 const auto *CanonDecl = cast<FunctionDecl>(FD->getCanonicalDecl());
3003 FwdDeclReplaceMap.emplace_back(std::piecewise_construct,
3004 std::make_tuple(CanonDecl),
3005 std::make_tuple(SP));
3009 llvm::DISubprogram *
3010 CGDebugInfo::getFunctionForwardDeclaration(GlobalDecl GD) {
3011 return getFunctionFwdDeclOrStub(GD, /* Stub = */ false);
3014 llvm::DISubprogram *
3015 CGDebugInfo::getFunctionStub(GlobalDecl GD) {
3016 return getFunctionFwdDeclOrStub(GD, /* Stub = */ true);
3019 llvm::DIGlobalVariable *
3020 CGDebugInfo::getGlobalVariableForwardDeclaration(const VarDecl *VD) {
3022 StringRef Name, LinkageName;
3023 SourceLocation Loc = VD->getLocation();
3024 llvm::DIFile *Unit = getOrCreateFile(Loc);
3025 llvm::DIScope *DContext = Unit;
3026 unsigned Line = getLineNumber(Loc);
3028 collectVarDeclProps(VD, Unit, Line, T, Name, LinkageName, DContext);
3029 auto Align = getDeclAlignIfRequired(VD, CGM.getContext());
3030 auto *GV = DBuilder.createTempGlobalVariableFwdDecl(
3031 DContext, Name, LinkageName, Unit, Line, getOrCreateType(T, Unit),
3032 !VD->isExternallyVisible(), nullptr, Align);
3033 FwdDeclReplaceMap.emplace_back(
3034 std::piecewise_construct,
3035 std::make_tuple(cast<VarDecl>(VD->getCanonicalDecl())),
3036 std::make_tuple(static_cast<llvm::Metadata *>(GV)));
3040 llvm::DINode *CGDebugInfo::getDeclarationOrDefinition(const Decl *D) {
3041 // We only need a declaration (not a definition) of the type - so use whatever
3042 // we would otherwise do to get a type for a pointee. (forward declarations in
3043 // limited debug info, full definitions (if the type definition is available)
3044 // in unlimited debug info)
3045 if (const auto *TD = dyn_cast<TypeDecl>(D))
3046 return getOrCreateType(CGM.getContext().getTypeDeclType(TD),
3047 getOrCreateFile(TD->getLocation()));
3048 auto I = DeclCache.find(D->getCanonicalDecl());
3050 if (I != DeclCache.end()) {
3052 if (auto *GVE = dyn_cast_or_null<llvm::DIGlobalVariableExpression>(N))
3053 return GVE->getVariable();
3054 return dyn_cast_or_null<llvm::DINode>(N);
3057 // No definition for now. Emit a forward definition that might be
3058 // merged with a potential upcoming definition.
3059 if (const auto *FD = dyn_cast<FunctionDecl>(D))
3060 return getFunctionForwardDeclaration(FD);
3061 else if (const auto *VD = dyn_cast<VarDecl>(D))
3062 return getGlobalVariableForwardDeclaration(VD);
3067 llvm::DISubprogram *CGDebugInfo::getFunctionDeclaration(const Decl *D) {
3068 if (!D || DebugKind <= codegenoptions::DebugLineTablesOnly)
3071 const auto *FD = dyn_cast<FunctionDecl>(D);
3076 auto *S = getDeclContextDescriptor(D);
3078 auto MI = SPCache.find(FD->getCanonicalDecl());
3079 if (MI == SPCache.end()) {
3080 if (const auto *MD = dyn_cast<CXXMethodDecl>(FD->getCanonicalDecl())) {
3081 return CreateCXXMemberFunction(MD, getOrCreateFile(MD->getLocation()),
3082 cast<llvm::DICompositeType>(S));
3085 if (MI != SPCache.end()) {
3086 auto *SP = dyn_cast_or_null<llvm::DISubprogram>(MI->second);
3087 if (SP && !SP->isDefinition())
3091 for (auto NextFD : FD->redecls()) {
3092 auto MI = SPCache.find(NextFD->getCanonicalDecl());
3093 if (MI != SPCache.end()) {
3094 auto *SP = dyn_cast_or_null<llvm::DISubprogram>(MI->second);
3095 if (SP && !SP->isDefinition())
3102 // getOrCreateFunctionType - Construct type. If it is a c++ method, include
3103 // implicit parameter "this".
3104 llvm::DISubroutineType *CGDebugInfo::getOrCreateFunctionType(const Decl *D,
3107 if (!D || DebugKind <= codegenoptions::DebugLineTablesOnly)
3108 // Create fake but valid subroutine type. Otherwise -verify would fail, and
3109 // subprogram DIE will miss DW_AT_decl_file and DW_AT_decl_line fields.
3110 return DBuilder.createSubroutineType(DBuilder.getOrCreateTypeArray(None));
3112 if (const auto *Method = dyn_cast<CXXMethodDecl>(D))
3113 return getOrCreateMethodType(Method, F);
3115 const auto *FTy = FnType->getAs<FunctionType>();
3116 CallingConv CC = FTy ? FTy->getCallConv() : CallingConv::CC_C;
3118 if (const auto *OMethod = dyn_cast<ObjCMethodDecl>(D)) {
3119 // Add "self" and "_cmd"
3120 SmallVector<llvm::Metadata *, 16> Elts;
3122 // First element is always return type. For 'void' functions it is NULL.
3123 QualType ResultTy = OMethod->getReturnType();
3125 // Replace the instancetype keyword with the actual type.
3126 if (ResultTy == CGM.getContext().getObjCInstanceType())
3127 ResultTy = CGM.getContext().getPointerType(
3128 QualType(OMethod->getClassInterface()->getTypeForDecl(), 0));
3130 Elts.push_back(getOrCreateType(ResultTy, F));
3131 // "self" pointer is always first argument.
3132 QualType SelfDeclTy;
3133 if (auto *SelfDecl = OMethod->getSelfDecl())
3134 SelfDeclTy = SelfDecl->getType();
3135 else if (auto *FPT = dyn_cast<FunctionProtoType>(FnType))
3136 if (FPT->getNumParams() > 1)
3137 SelfDeclTy = FPT->getParamType(0);
3138 if (!SelfDeclTy.isNull())
3139 Elts.push_back(CreateSelfType(SelfDeclTy, getOrCreateType(SelfDeclTy, F)));
3140 // "_cmd" pointer is always second argument.
3141 Elts.push_back(DBuilder.createArtificialType(
3142 getOrCreateType(CGM.getContext().getObjCSelType(), F)));
3143 // Get rest of the arguments.
3144 for (const auto *PI : OMethod->parameters())
3145 Elts.push_back(getOrCreateType(PI->getType(), F));
3146 // Variadic methods need a special marker at the end of the type list.
3147 if (OMethod->isVariadic())
3148 Elts.push_back(DBuilder.createUnspecifiedParameter());
3150 llvm::DITypeRefArray EltTypeArray = DBuilder.getOrCreateTypeArray(Elts);
3151 return DBuilder.createSubroutineType(EltTypeArray, llvm::DINode::FlagZero,
3155 // Handle variadic function types; they need an additional
3156 // unspecified parameter.
3157 if (const auto *FD = dyn_cast<FunctionDecl>(D))
3158 if (FD->isVariadic()) {
3159 SmallVector<llvm::Metadata *, 16> EltTys;
3160 EltTys.push_back(getOrCreateType(FD->getReturnType(), F));
3161 if (const auto *FPT = dyn_cast<FunctionProtoType>(FnType))
3162 for (QualType ParamType : FPT->param_types())
3163 EltTys.push_back(getOrCreateType(ParamType, F));
3164 EltTys.push_back(DBuilder.createUnspecifiedParameter());
3165 llvm::DITypeRefArray EltTypeArray = DBuilder.getOrCreateTypeArray(EltTys);
3166 return DBuilder.createSubroutineType(EltTypeArray, llvm::DINode::FlagZero,
3170 return cast<llvm::DISubroutineType>(getOrCreateType(FnType, F));
3173 void CGDebugInfo::EmitFunctionStart(GlobalDecl GD, SourceLocation Loc,
3174 SourceLocation ScopeLoc, QualType FnType,
3175 llvm::Function *Fn, CGBuilderTy &Builder) {
3178 StringRef LinkageName;
3180 FnBeginRegionCount.push_back(LexicalBlockStack.size());
3182 const Decl *D = GD.getDecl();
3183 bool HasDecl = (D != nullptr);
3185 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
3186 llvm::DIFile *Unit = getOrCreateFile(Loc);
3187 llvm::DIScope *FDContext = Unit;
3188 llvm::DINodeArray TParamsArray;
3190 // Use llvm function name.
3191 LinkageName = Fn->getName();
3192 } else if (const auto *FD = dyn_cast<FunctionDecl>(D)) {
3193 // If there is a subprogram for this function available then use it.
3194 auto FI = SPCache.find(FD->getCanonicalDecl());
3195 if (FI != SPCache.end()) {
3196 auto *SP = dyn_cast_or_null<llvm::DISubprogram>(FI->second);
3197 if (SP && SP->isDefinition()) {
3198 LexicalBlockStack.emplace_back(SP);
3199 RegionMap[D].reset(SP);
3203 collectFunctionDeclProps(GD, Unit, Name, LinkageName, FDContext,
3204 TParamsArray, Flags);
3205 } else if (const auto *OMD = dyn_cast<ObjCMethodDecl>(D)) {
3206 Name = getObjCMethodName(OMD);
3207 Flags |= llvm::DINode::FlagPrototyped;
3209 // Use llvm function name.
3210 Name = Fn->getName();
3211 Flags |= llvm::DINode::FlagPrototyped;
3213 if (Name.startswith("\01"))
3214 Name = Name.substr(1);
3216 if (!HasDecl || D->isImplicit()) {
3217 Flags |= llvm::DINode::FlagArtificial;
3218 // Artificial functions should not silently reuse CurLoc.
3219 CurLoc = SourceLocation();
3221 unsigned LineNo = getLineNumber(Loc);
3222 unsigned ScopeLine = getLineNumber(ScopeLoc);
3224 // FIXME: The function declaration we're constructing here is mostly reusing
3225 // declarations from CXXMethodDecl and not constructing new ones for arbitrary
3226 // FunctionDecls. When/if we fix this we can have FDContext be TheCU/null for
3227 // all subprograms instead of the actual context since subprogram definitions
3228 // are emitted as CU level entities by the backend.
3229 llvm::DISubprogram *SP = DBuilder.createFunction(
3230 FDContext, Name, LinkageName, Unit, LineNo,
3231 getOrCreateFunctionType(D, FnType, Unit), Fn->hasLocalLinkage(),
3232 true /*definition*/, ScopeLine, Flags, CGM.getLangOpts().Optimize,
3233 TParamsArray.get(), getFunctionDeclaration(D));
3234 Fn->setSubprogram(SP);
3235 // We might get here with a VarDecl in the case we're generating
3236 // code for the initialization of globals. Do not record these decls
3237 // as they will overwrite the actual VarDecl Decl in the cache.
3238 if (HasDecl && isa<FunctionDecl>(D))
3239 DeclCache[D->getCanonicalDecl()].reset(SP);
3241 // Push the function onto the lexical block stack.
3242 LexicalBlockStack.emplace_back(SP);
3245 RegionMap[D].reset(SP);
3248 void CGDebugInfo::EmitFunctionDecl(GlobalDecl GD, SourceLocation Loc,
3251 StringRef LinkageName;
3253 const Decl *D = GD.getDecl();
3257 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
3258 llvm::DIFile *Unit = getOrCreateFile(Loc);
3259 llvm::DIScope *FDContext = getDeclContextDescriptor(D);
3260 llvm::DINodeArray TParamsArray;
3261 if (isa<FunctionDecl>(D)) {
3262 // If there is a DISubprogram for this function available then use it.
3263 collectFunctionDeclProps(GD, Unit, Name, LinkageName, FDContext,
3264 TParamsArray, Flags);
3265 } else if (const auto *OMD = dyn_cast<ObjCMethodDecl>(D)) {
3266 Name = getObjCMethodName(OMD);
3267 Flags |= llvm::DINode::FlagPrototyped;
3269 llvm_unreachable("not a function or ObjC method");
3271 if (!Name.empty() && Name[0] == '\01')
3272 Name = Name.substr(1);
3274 if (D->isImplicit()) {
3275 Flags |= llvm::DINode::FlagArtificial;
3276 // Artificial functions without a location should not silently reuse CurLoc.
3277 if (Loc.isInvalid())
3278 CurLoc = SourceLocation();
3280 unsigned LineNo = getLineNumber(Loc);
3281 unsigned ScopeLine = 0;
3283 DBuilder.retainType(DBuilder.createFunction(
3284 FDContext, Name, LinkageName, Unit, LineNo,
3285 getOrCreateFunctionType(D, FnType, Unit), false /*internalLinkage*/,
3286 false /*definition*/, ScopeLine, Flags, CGM.getLangOpts().Optimize,
3287 TParamsArray.get(), getFunctionDeclaration(D)));
3290 void CGDebugInfo::EmitInlineFunctionStart(CGBuilderTy &Builder, GlobalDecl GD) {
3291 const auto *FD = cast<FunctionDecl>(GD.getDecl());
3292 // If there is a subprogram for this function available then use it.
3293 auto FI = SPCache.find(FD->getCanonicalDecl());
3294 llvm::DISubprogram *SP = nullptr;
3295 if (FI != SPCache.end())
3296 SP = dyn_cast_or_null<llvm::DISubprogram>(FI->second);
3297 if (!SP || !SP->isDefinition())
3298 SP = getFunctionStub(GD);
3299 FnBeginRegionCount.push_back(LexicalBlockStack.size());
3300 LexicalBlockStack.emplace_back(SP);
3301 setInlinedAt(Builder.getCurrentDebugLocation());
3302 EmitLocation(Builder, FD->getLocation());
3305 void CGDebugInfo::EmitInlineFunctionEnd(CGBuilderTy &Builder) {
3306 assert(CurInlinedAt && "unbalanced inline scope stack");
3307 EmitFunctionEnd(Builder, nullptr);
3308 setInlinedAt(llvm::DebugLoc(CurInlinedAt).getInlinedAt());
3311 void CGDebugInfo::EmitLocation(CGBuilderTy &Builder, SourceLocation Loc) {
3312 // Update our current location
3315 if (CurLoc.isInvalid() || CurLoc.isMacroID())
3318 llvm::MDNode *Scope = LexicalBlockStack.back();
3319 Builder.SetCurrentDebugLocation(llvm::DebugLoc::get(
3320 getLineNumber(CurLoc), getColumnNumber(CurLoc), Scope, CurInlinedAt));
3323 void CGDebugInfo::CreateLexicalBlock(SourceLocation Loc) {
3324 llvm::MDNode *Back = nullptr;
3325 if (!LexicalBlockStack.empty())
3326 Back = LexicalBlockStack.back().get();
3327 LexicalBlockStack.emplace_back(DBuilder.createLexicalBlock(
3328 cast<llvm::DIScope>(Back), getOrCreateFile(CurLoc), getLineNumber(CurLoc),
3329 getColumnNumber(CurLoc)));
3332 void CGDebugInfo::AppendAddressSpaceXDeref(
3333 unsigned AddressSpace,
3334 SmallVectorImpl<int64_t> &Expr) const {
3335 Optional<unsigned> DWARFAddressSpace =
3336 CGM.getTarget().getDWARFAddressSpace(AddressSpace);
3337 if (!DWARFAddressSpace)
3340 Expr.push_back(llvm::dwarf::DW_OP_constu);
3341 Expr.push_back(DWARFAddressSpace.getValue());
3342 Expr.push_back(llvm::dwarf::DW_OP_swap);
3343 Expr.push_back(llvm::dwarf::DW_OP_xderef);
3346 void CGDebugInfo::EmitLexicalBlockStart(CGBuilderTy &Builder,
3347 SourceLocation Loc) {
3348 // Set our current location.
3351 // Emit a line table change for the current location inside the new scope.
3352 Builder.SetCurrentDebugLocation(
3353 llvm::DebugLoc::get(getLineNumber(Loc), getColumnNumber(Loc),
3354 LexicalBlockStack.back(), CurInlinedAt));
3356 if (DebugKind <= codegenoptions::DebugLineTablesOnly)
3359 // Create a new lexical block and push it on the stack.
3360 CreateLexicalBlock(Loc);
3363 void CGDebugInfo::EmitLexicalBlockEnd(CGBuilderTy &Builder,
3364 SourceLocation Loc) {
3365 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
3367 // Provide an entry in the line table for the end of the block.
3368 EmitLocation(Builder, Loc);
3370 if (DebugKind <= codegenoptions::DebugLineTablesOnly)
3373 LexicalBlockStack.pop_back();
3376 void CGDebugInfo::EmitFunctionEnd(CGBuilderTy &Builder, llvm::Function *Fn) {
3377 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
3378 unsigned RCount = FnBeginRegionCount.back();
3379 assert(RCount <= LexicalBlockStack.size() && "Region stack mismatch");
3381 // Pop all regions for this function.
3382 while (LexicalBlockStack.size() != RCount) {
3383 // Provide an entry in the line table for the end of the block.
3384 EmitLocation(Builder, CurLoc);
3385 LexicalBlockStack.pop_back();
3387 FnBeginRegionCount.pop_back();
3389 if (Fn && Fn->getSubprogram())
3390 DBuilder.finalizeSubprogram(Fn->getSubprogram());
3393 llvm::DIType *CGDebugInfo::EmitTypeForVarWithBlocksAttr(const VarDecl *VD,
3394 uint64_t *XOffset) {
3396 SmallVector<llvm::Metadata *, 5> EltTys;
3398 uint64_t FieldSize, FieldOffset;
3399 uint32_t FieldAlign;
3401 llvm::DIFile *Unit = getOrCreateFile(VD->getLocation());
3402 QualType Type = VD->getType();
3405 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
3406 EltTys.push_back(CreateMemberType(Unit, FType, "__isa", &FieldOffset));
3407 EltTys.push_back(CreateMemberType(Unit, FType, "__forwarding", &FieldOffset));
3408 FType = CGM.getContext().IntTy;
3409 EltTys.push_back(CreateMemberType(Unit, FType, "__flags", &FieldOffset));
3410 EltTys.push_back(CreateMemberType(Unit, FType, "__size", &FieldOffset));
3412 bool HasCopyAndDispose = CGM.getContext().BlockRequiresCopying(Type, VD);
3413 if (HasCopyAndDispose) {
3414 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
3416 CreateMemberType(Unit, FType, "__copy_helper", &FieldOffset));
3418 CreateMemberType(Unit, FType, "__destroy_helper", &FieldOffset));
3420 bool HasByrefExtendedLayout;
3421 Qualifiers::ObjCLifetime Lifetime;
3422 if (CGM.getContext().getByrefLifetime(Type, Lifetime,
3423 HasByrefExtendedLayout) &&
3424 HasByrefExtendedLayout) {
3425 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
3427 CreateMemberType(Unit, FType, "__byref_variable_layout", &FieldOffset));
3430 CharUnits Align = CGM.getContext().getDeclAlign(VD);
3431 if (Align > CGM.getContext().toCharUnitsFromBits(
3432 CGM.getTarget().getPointerAlign(0))) {
3433 CharUnits FieldOffsetInBytes =
3434 CGM.getContext().toCharUnitsFromBits(FieldOffset);
3435 CharUnits AlignedOffsetInBytes = FieldOffsetInBytes.alignTo(Align);
3436 CharUnits NumPaddingBytes = AlignedOffsetInBytes - FieldOffsetInBytes;
3438 if (NumPaddingBytes.isPositive()) {
3439 llvm::APInt pad(32, NumPaddingBytes.getQuantity());
3440 FType = CGM.getContext().getConstantArrayType(CGM.getContext().CharTy,
3441 pad, ArrayType::Normal, 0);
3442 EltTys.push_back(CreateMemberType(Unit, FType, "", &FieldOffset));
3447 llvm::DIType *FieldTy = getOrCreateType(FType, Unit);
3448 FieldSize = CGM.getContext().getTypeSize(FType);
3449 FieldAlign = CGM.getContext().toBits(Align);
3451 *XOffset = FieldOffset;
3452 FieldTy = DBuilder.createMemberType(Unit, VD->getName(), Unit, 0, FieldSize,
3453 FieldAlign, FieldOffset,
3454 llvm::DINode::FlagZero, FieldTy);
3455 EltTys.push_back(FieldTy);
3456 FieldOffset += FieldSize;
3458 llvm::DINodeArray Elements = DBuilder.getOrCreateArray(EltTys);
3460 llvm::DINode::DIFlags Flags = llvm::DINode::FlagBlockByrefStruct;
3462 return DBuilder.createStructType(Unit, "", Unit, 0, FieldOffset, 0, Flags,
3466 void CGDebugInfo::EmitDeclare(const VarDecl *VD, llvm::Value *Storage,
3467 llvm::Optional<unsigned> ArgNo,
3468 CGBuilderTy &Builder) {
3469 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
3470 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
3471 if (VD->hasAttr<NoDebugAttr>())
3475 VD->isImplicit() || (isa<Decl>(VD->getDeclContext()) &&
3476 cast<Decl>(VD->getDeclContext())->isImplicit());
3477 llvm::DIFile *Unit = nullptr;
3479 Unit = getOrCreateFile(VD->getLocation());
3481 uint64_t XOffset = 0;
3482 if (VD->hasAttr<BlocksAttr>())
3483 Ty = EmitTypeForVarWithBlocksAttr(VD, &XOffset);
3485 Ty = getOrCreateType(VD->getType(), Unit);
3487 // If there is no debug info for this type then do not emit debug info
3488 // for this variable.
3492 // Get location information.
3494 unsigned Column = 0;
3496 Line = getLineNumber(VD->getLocation());
3497 Column = getColumnNumber(VD->getLocation());
3499 SmallVector<int64_t, 13> Expr;
3500 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
3501 if (VD->isImplicit())
3502 Flags |= llvm::DINode::FlagArtificial;
3504 auto Align = getDeclAlignIfRequired(VD, CGM.getContext());
3506 unsigned AddressSpace = CGM.getContext().getTargetAddressSpace(VD->getType());
3507 AppendAddressSpaceXDeref(AddressSpace, Expr);
3509 // If this is implicit parameter of CXXThis or ObjCSelf kind, then give it an
3510 // object pointer flag.
3511 if (const auto *IPD = dyn_cast<ImplicitParamDecl>(VD)) {
3512 if (IPD->getParameterKind() == ImplicitParamDecl::CXXThis ||
3513 IPD->getParameterKind() == ImplicitParamDecl::ObjCSelf)
3514 Flags |= llvm::DINode::FlagObjectPointer;
3517 // Note: Older versions of clang used to emit byval references with an extra
3518 // DW_OP_deref, because they referenced the IR arg directly instead of
3519 // referencing an alloca. Newer versions of LLVM don't treat allocas
3520 // differently from other function arguments when used in a dbg.declare.
3521 auto *Scope = cast<llvm::DIScope>(LexicalBlockStack.back());
3522 StringRef Name = VD->getName();
3523 if (!Name.empty()) {
3524 if (VD->hasAttr<BlocksAttr>()) {
3525 // Here, we need an offset *into* the alloca.
3526 CharUnits offset = CharUnits::fromQuantity(32);
3527 Expr.push_back(llvm::dwarf::DW_OP_plus_uconst);
3528 // offset of __forwarding field
3529 offset = CGM.getContext().toCharUnitsFromBits(
3530 CGM.getTarget().getPointerWidth(0));
3531 Expr.push_back(offset.getQuantity());
3532 Expr.push_back(llvm::dwarf::DW_OP_deref);
3533 Expr.push_back(llvm::dwarf::DW_OP_plus_uconst);
3534 // offset of x field
3535 offset = CGM.getContext().toCharUnitsFromBits(XOffset);
3536 Expr.push_back(offset.getQuantity());
3538 } else if (const auto *RT = dyn_cast<RecordType>(VD->getType())) {
3539 // If VD is an anonymous union then Storage represents value for
3540 // all union fields.
3541 const auto *RD = cast<RecordDecl>(RT->getDecl());
3542 if (RD->isUnion() && RD->isAnonymousStructOrUnion()) {
3543 // GDB has trouble finding local variables in anonymous unions, so we emit
3544 // artifical local variables for each of the members.
3546 // FIXME: Remove this code as soon as GDB supports this.
3547 // The debug info verifier in LLVM operates based on the assumption that a
3548 // variable has the same size as its storage and we had to disable the check
3549 // for artificial variables.
3550 for (const auto *Field : RD->fields()) {
3551 llvm::DIType *FieldTy = getOrCreateType(Field->getType(), Unit);
3552 StringRef FieldName = Field->getName();
3554 // Ignore unnamed fields. Do not ignore unnamed records.
3555 if (FieldName.empty() && !isa<RecordType>(Field->getType()))
3558 // Use VarDecl's Tag, Scope and Line number.
3559 auto FieldAlign = getDeclAlignIfRequired(Field, CGM.getContext());
3560 auto *D = DBuilder.createAutoVariable(
3561 Scope, FieldName, Unit, Line, FieldTy, CGM.getLangOpts().Optimize,
3562 Flags | llvm::DINode::FlagArtificial, FieldAlign);
3564 // Insert an llvm.dbg.declare into the current block.
3565 DBuilder.insertDeclare(
3566 Storage, D, DBuilder.createExpression(Expr),
3567 llvm::DebugLoc::get(Line, Column, Scope, CurInlinedAt),
3568 Builder.GetInsertBlock());
3573 // Create the descriptor for the variable.
3575 ? DBuilder.createParameterVariable(
3576 Scope, Name, *ArgNo, Unit, Line, Ty,
3577 CGM.getLangOpts().Optimize, Flags)
3578 : DBuilder.createAutoVariable(Scope, Name, Unit, Line, Ty,
3579 CGM.getLangOpts().Optimize, Flags,
3582 // Insert an llvm.dbg.declare into the current block.
3583 DBuilder.insertDeclare(Storage, D, DBuilder.createExpression(Expr),
3584 llvm::DebugLoc::get(Line, Column, Scope, CurInlinedAt),
3585 Builder.GetInsertBlock());
3588 void CGDebugInfo::EmitDeclareOfAutoVariable(const VarDecl *VD,
3589 llvm::Value *Storage,
3590 CGBuilderTy &Builder) {
3591 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
3592 EmitDeclare(VD, Storage, llvm::None, Builder);
3595 llvm::DIType *CGDebugInfo::CreateSelfType(const QualType &QualTy,
3597 llvm::DIType *CachedTy = getTypeOrNull(QualTy);
3600 return DBuilder.createObjectPointerType(Ty);
3603 void CGDebugInfo::EmitDeclareOfBlockDeclRefVariable(
3604 const VarDecl *VD, llvm::Value *Storage, CGBuilderTy &Builder,
3605 const CGBlockInfo &blockInfo, llvm::Instruction *InsertPoint) {
3606 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
3607 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
3609 if (Builder.GetInsertBlock() == nullptr)
3611 if (VD->hasAttr<NoDebugAttr>())
3614 bool isByRef = VD->hasAttr<BlocksAttr>();
3616 uint64_t XOffset = 0;
3617 llvm::DIFile *Unit = getOrCreateFile(VD->getLocation());
3620 Ty = EmitTypeForVarWithBlocksAttr(VD, &XOffset);
3622 Ty = getOrCreateType(VD->getType(), Unit);
3624 // Self is passed along as an implicit non-arg variable in a
3625 // block. Mark it as the object pointer.
3626 if (const auto *IPD = dyn_cast<ImplicitParamDecl>(VD))
3627 if (IPD->getParameterKind() == ImplicitParamDecl::ObjCSelf)
3628 Ty = CreateSelfType(VD->getType(), Ty);
3630 // Get location information.
3631 unsigned Line = getLineNumber(VD->getLocation());
3632 unsigned Column = getColumnNumber(VD->getLocation());
3634 const llvm::DataLayout &target = CGM.getDataLayout();
3636 CharUnits offset = CharUnits::fromQuantity(
3637 target.getStructLayout(blockInfo.StructureType)
3638 ->getElementOffset(blockInfo.getCapture(VD).getIndex()));
3640 SmallVector<int64_t, 9> addr;
3641 addr.push_back(llvm::dwarf::DW_OP_deref);
3642 addr.push_back(llvm::dwarf::DW_OP_plus_uconst);
3643 addr.push_back(offset.getQuantity());
3645 addr.push_back(llvm::dwarf::DW_OP_deref);
3646 addr.push_back(llvm::dwarf::DW_OP_plus_uconst);
3647 // offset of __forwarding field
3649 CGM.getContext().toCharUnitsFromBits(target.getPointerSizeInBits(0));
3650 addr.push_back(offset.getQuantity());
3651 addr.push_back(llvm::dwarf::DW_OP_deref);
3652 addr.push_back(llvm::dwarf::DW_OP_plus_uconst);
3653 // offset of x field
3654 offset = CGM.getContext().toCharUnitsFromBits(XOffset);
3655 addr.push_back(offset.getQuantity());
3658 // Create the descriptor for the variable.
3659 auto Align = getDeclAlignIfRequired(VD, CGM.getContext());
3660 auto *D = DBuilder.createAutoVariable(
3661 cast<llvm::DILocalScope>(LexicalBlockStack.back()), VD->getName(), Unit,
3662 Line, Ty, false, llvm::DINode::FlagZero, Align);
3664 // Insert an llvm.dbg.declare into the current block.
3666 llvm::DebugLoc::get(Line, Column, LexicalBlockStack.back(), CurInlinedAt);
3667 auto *Expr = DBuilder.createExpression(addr);
3669 DBuilder.insertDeclare(Storage, D, Expr, DL, InsertPoint);
3671 DBuilder.insertDeclare(Storage, D, Expr, DL, Builder.GetInsertBlock());
3674 void CGDebugInfo::EmitDeclareOfArgVariable(const VarDecl *VD, llvm::Value *AI,
3676 CGBuilderTy &Builder) {
3677 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
3678 EmitDeclare(VD, AI, ArgNo, Builder);
3682 struct BlockLayoutChunk {
3683 uint64_t OffsetInBits;
3684 const BlockDecl::Capture *Capture;
3686 bool operator<(const BlockLayoutChunk &l, const BlockLayoutChunk &r) {
3687 return l.OffsetInBits < r.OffsetInBits;
3691 void CGDebugInfo::EmitDeclareOfBlockLiteralArgVariable(const CGBlockInfo &block,
3694 llvm::AllocaInst *Alloca,
3695 CGBuilderTy &Builder) {
3696 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
3697 ASTContext &C = CGM.getContext();
3698 const BlockDecl *blockDecl = block.getBlockDecl();
3700 // Collect some general information about the block's location.
3701 SourceLocation loc = blockDecl->getCaretLocation();
3702 llvm::DIFile *tunit = getOrCreateFile(loc);
3703 unsigned line = getLineNumber(loc);
3704 unsigned column = getColumnNumber(loc);
3706 // Build the debug-info type for the block literal.
3707 getDeclContextDescriptor(blockDecl);
3709 const llvm::StructLayout *blockLayout =
3710 CGM.getDataLayout().getStructLayout(block.StructureType);
3712 SmallVector<llvm::Metadata *, 16> fields;
3713 fields.push_back(createFieldType("__isa", C.VoidPtrTy, loc, AS_public,
3714 blockLayout->getElementOffsetInBits(0),
3716 fields.push_back(createFieldType("__flags", C.IntTy, loc, AS_public,
3717 blockLayout->getElementOffsetInBits(1),
3719 fields.push_back(createFieldType("__reserved", C.IntTy, loc, AS_public,
3720 blockLayout->getElementOffsetInBits(2),
3722 auto *FnTy = block.getBlockExpr()->getFunctionType();
3723 auto FnPtrType = CGM.getContext().getPointerType(FnTy->desugar());
3724 fields.push_back(createFieldType("__FuncPtr", FnPtrType, loc, AS_public,
3725 blockLayout->getElementOffsetInBits(3),
3727 fields.push_back(createFieldType(
3728 "__descriptor", C.getPointerType(block.NeedsCopyDispose
3729 ? C.getBlockDescriptorExtendedType()
3730 : C.getBlockDescriptorType()),
3731 loc, AS_public, blockLayout->getElementOffsetInBits(4), tunit, tunit));
3733 // We want to sort the captures by offset, not because DWARF
3734 // requires this, but because we're paranoid about debuggers.
3735 SmallVector<BlockLayoutChunk, 8> chunks;
3738 if (blockDecl->capturesCXXThis()) {
3739 BlockLayoutChunk chunk;
3740 chunk.OffsetInBits =
3741 blockLayout->getElementOffsetInBits(block.CXXThisIndex);
3742 chunk.Capture = nullptr;
3743 chunks.push_back(chunk);
3746 // Variable captures.
3747 for (const auto &capture : blockDecl->captures()) {
3748 const VarDecl *variable = capture.getVariable();
3749 const CGBlockInfo::Capture &captureInfo = block.getCapture(variable);
3751 // Ignore constant captures.
3752 if (captureInfo.isConstant())
3755 BlockLayoutChunk chunk;
3756 chunk.OffsetInBits =
3757 blockLayout->getElementOffsetInBits(captureInfo.getIndex());
3758 chunk.Capture = &capture;
3759 chunks.push_back(chunk);
3763 llvm::array_pod_sort(chunks.begin(), chunks.end());
3765 for (const BlockLayoutChunk &Chunk : chunks) {
3766 uint64_t offsetInBits = Chunk.OffsetInBits;
3767 const BlockDecl::Capture *capture = Chunk.Capture;
3769 // If we have a null capture, this must be the C++ 'this' capture.
3773 cast_or_null<CXXMethodDecl>(blockDecl->getNonClosureContext()))
3774 type = Method->getThisType(C);
3775 else if (auto *RDecl = dyn_cast<CXXRecordDecl>(blockDecl->getParent()))
3776 type = QualType(RDecl->getTypeForDecl(), 0);
3778 llvm_unreachable("unexpected block declcontext");
3780 fields.push_back(createFieldType("this", type, loc, AS_public,
3781 offsetInBits, tunit, tunit));
3785 const VarDecl *variable = capture->getVariable();
3786 StringRef name = variable->getName();
3788 llvm::DIType *fieldType;
3789 if (capture->isByRef()) {
3790 TypeInfo PtrInfo = C.getTypeInfo(C.VoidPtrTy);
3791 auto Align = PtrInfo.AlignIsRequired ? PtrInfo.Align : 0;
3793 // FIXME: this creates a second copy of this type!
3795 fieldType = EmitTypeForVarWithBlocksAttr(variable, &xoffset);
3796 fieldType = DBuilder.createPointerType(fieldType, PtrInfo.Width);
3797 fieldType = DBuilder.createMemberType(tunit, name, tunit, line,
3798 PtrInfo.Width, Align, offsetInBits,
3799 llvm::DINode::FlagZero, fieldType);
3801 auto Align = getDeclAlignIfRequired(variable, CGM.getContext());
3802 fieldType = createFieldType(name, variable->getType(), loc, AS_public,
3803 offsetInBits, Align, tunit, tunit);
3805 fields.push_back(fieldType);
3808 SmallString<36> typeName;
3809 llvm::raw_svector_ostream(typeName) << "__block_literal_"
3810 << CGM.getUniqueBlockCount();
3812 llvm::DINodeArray fieldsArray = DBuilder.getOrCreateArray(fields);
3814 llvm::DIType *type =
3815 DBuilder.createStructType(tunit, typeName.str(), tunit, line,
3816 CGM.getContext().toBits(block.BlockSize), 0,
3817 llvm::DINode::FlagZero, nullptr, fieldsArray);
3818 type = DBuilder.createPointerType(type, CGM.PointerWidthInBits);
3820 // Get overall information about the block.
3821 llvm::DINode::DIFlags flags = llvm::DINode::FlagArtificial;
3822 auto *scope = cast<llvm::DILocalScope>(LexicalBlockStack.back());
3824 // Create the descriptor for the parameter.
3825 auto *debugVar = DBuilder.createParameterVariable(
3826 scope, Name, ArgNo, tunit, line, type,
3827 CGM.getLangOpts().Optimize, flags);
3829 // Insert an llvm.dbg.declare into the current block.
3830 DBuilder.insertDeclare(Alloca, debugVar, DBuilder.createExpression(),
3831 llvm::DebugLoc::get(line, column, scope, CurInlinedAt),
3832 Builder.GetInsertBlock());
3835 llvm::DIDerivedType *
3836 CGDebugInfo::getOrCreateStaticDataMemberDeclarationOrNull(const VarDecl *D) {
3837 if (!D->isStaticDataMember())
3840 auto MI = StaticDataMemberCache.find(D->getCanonicalDecl());
3841 if (MI != StaticDataMemberCache.end()) {
3842 assert(MI->second && "Static data member declaration should still exist");
3846 // If the member wasn't found in the cache, lazily construct and add it to the
3847 // type (used when a limited form of the type is emitted).
3848 auto DC = D->getDeclContext();
3849 auto *Ctxt = cast<llvm::DICompositeType>(getDeclContextDescriptor(D));
3850 return CreateRecordStaticField(D, Ctxt, cast<RecordDecl>(DC));
3853 llvm::DIGlobalVariableExpression *CGDebugInfo::CollectAnonRecordDecls(
3854 const RecordDecl *RD, llvm::DIFile *Unit, unsigned LineNo,
3855 StringRef LinkageName, llvm::GlobalVariable *Var, llvm::DIScope *DContext) {
3856 llvm::DIGlobalVariableExpression *GVE = nullptr;
3858 for (const auto *Field : RD->fields()) {
3859 llvm::DIType *FieldTy = getOrCreateType(Field->getType(), Unit);
3860 StringRef FieldName = Field->getName();
3862 // Ignore unnamed fields, but recurse into anonymous records.
3863 if (FieldName.empty()) {
3864 if (const auto *RT = dyn_cast<RecordType>(Field->getType()))
3865 GVE = CollectAnonRecordDecls(RT->getDecl(), Unit, LineNo, LinkageName,
3869 // Use VarDecl's Tag, Scope and Line number.
3870 GVE = DBuilder.createGlobalVariableExpression(
3871 DContext, FieldName, LinkageName, Unit, LineNo, FieldTy,
3872 Var->hasLocalLinkage());
3873 Var->addDebugInfo(GVE);
3878 void CGDebugInfo::EmitGlobalVariable(llvm::GlobalVariable *Var,
3880 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
3881 if (D->hasAttr<NoDebugAttr>())
3884 // If we already created a DIGlobalVariable for this declaration, just attach
3885 // it to the llvm::GlobalVariable.
3886 auto Cached = DeclCache.find(D->getCanonicalDecl());
3887 if (Cached != DeclCache.end())
3888 return Var->addDebugInfo(
3889 cast<llvm::DIGlobalVariableExpression>(Cached->second));
3891 // Create global variable debug descriptor.
3892 llvm::DIFile *Unit = nullptr;
3893 llvm::DIScope *DContext = nullptr;
3895 StringRef DeclName, LinkageName;
3897 collectVarDeclProps(D, Unit, LineNo, T, DeclName, LinkageName, DContext);
3899 // Attempt to store one global variable for the declaration - even if we
3900 // emit a lot of fields.
3901 llvm::DIGlobalVariableExpression *GVE = nullptr;
3903 // If this is an anonymous union then we'll want to emit a global
3904 // variable for each member of the anonymous union so that it's possible
3905 // to find the name of any field in the union.
3906 if (T->isUnionType() && DeclName.empty()) {
3907 const RecordDecl *RD = T->castAs<RecordType>()->getDecl();
3908 assert(RD->isAnonymousStructOrUnion() &&
3909 "unnamed non-anonymous struct or union?");
3910 GVE = CollectAnonRecordDecls(RD, Unit, LineNo, LinkageName, Var, DContext);
3912 auto Align = getDeclAlignIfRequired(D, CGM.getContext());
3914 SmallVector<int64_t, 4> Expr;
3915 unsigned AddressSpace =
3916 CGM.getContext().getTargetAddressSpace(D->getType());
3917 AppendAddressSpaceXDeref(AddressSpace, Expr);
3919 GVE = DBuilder.createGlobalVariableExpression(
3920 DContext, DeclName, LinkageName, Unit, LineNo, getOrCreateType(T, Unit),
3921 Var->hasLocalLinkage(),
3922 Expr.empty() ? nullptr : DBuilder.createExpression(Expr),
3923 getOrCreateStaticDataMemberDeclarationOrNull(D), Align);
3924 Var->addDebugInfo(GVE);
3926 DeclCache[D->getCanonicalDecl()].reset(GVE);
3929 void CGDebugInfo::EmitGlobalVariable(const ValueDecl *VD, const APValue &Init) {
3930 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
3931 if (VD->hasAttr<NoDebugAttr>())
3933 auto Align = getDeclAlignIfRequired(VD, CGM.getContext());
3934 // Create the descriptor for the variable.
3935 llvm::DIFile *Unit = getOrCreateFile(VD->getLocation());
3936 StringRef Name = VD->getName();
3937 llvm::DIType *Ty = getOrCreateType(VD->getType(), Unit);
3938 if (const auto *ECD = dyn_cast<EnumConstantDecl>(VD)) {
3939 const auto *ED = cast<EnumDecl>(ECD->getDeclContext());
3940 assert(isa<EnumType>(ED->getTypeForDecl()) && "Enum without EnumType?");
3941 Ty = getOrCreateType(QualType(ED->getTypeForDecl(), 0), Unit);
3943 // Do not use global variables for enums.
3946 if (Ty->getTag() == llvm::dwarf::DW_TAG_enumeration_type)
3948 // Do not emit separate definitions for function local const/statics.
3949 if (isa<FunctionDecl>(VD->getDeclContext()))
3951 VD = cast<ValueDecl>(VD->getCanonicalDecl());
3952 auto *VarD = cast<VarDecl>(VD);
3953 if (VarD->isStaticDataMember()) {
3954 auto *RD = cast<RecordDecl>(VarD->getDeclContext());
3955 getDeclContextDescriptor(VarD);
3956 // Ensure that the type is retained even though it's otherwise unreferenced.
3958 // FIXME: This is probably unnecessary, since Ty should reference RD
3959 // through its scope.
3960 RetainedTypes.push_back(
3961 CGM.getContext().getRecordType(RD).getAsOpaquePtr());
3965 llvm::DIScope *DContext = getDeclContextDescriptor(VD);
3967 auto &GV = DeclCache[VD];
3970 llvm::DIExpression *InitExpr = nullptr;
3971 if (CGM.getContext().getTypeSize(VD->getType()) <= 64) {
3972 // FIXME: Add a representation for integer constants wider than 64 bits.
3975 DBuilder.createConstantValueExpression(Init.getInt().getExtValue());
3976 else if (Init.isFloat())
3977 InitExpr = DBuilder.createConstantValueExpression(
3978 Init.getFloat().bitcastToAPInt().getZExtValue());
3980 GV.reset(DBuilder.createGlobalVariableExpression(
3981 DContext, Name, StringRef(), Unit, getLineNumber(VD->getLocation()), Ty,
3982 true, InitExpr, getOrCreateStaticDataMemberDeclarationOrNull(VarD),
3986 llvm::DIScope *CGDebugInfo::getCurrentContextDescriptor(const Decl *D) {
3987 if (!LexicalBlockStack.empty())
3988 return LexicalBlockStack.back();
3989 llvm::DIScope *Mod = getParentModuleOrNull(D);
3990 return getContextDescriptor(D, Mod ? Mod : TheCU);
3993 void CGDebugInfo::EmitUsingDirective(const UsingDirectiveDecl &UD) {
3994 if (CGM.getCodeGenOpts().getDebugInfo() < codegenoptions::LimitedDebugInfo)
3996 const NamespaceDecl *NSDecl = UD.getNominatedNamespace();
3997 if (!NSDecl->isAnonymousNamespace() ||
3998 CGM.getCodeGenOpts().DebugExplicitImport) {
3999 auto Loc = UD.getLocation();
4000 DBuilder.createImportedModule(
4001 getCurrentContextDescriptor(cast<Decl>(UD.getDeclContext())),
4002 getOrCreateNamespace(NSDecl), getOrCreateFile(Loc), getLineNumber(Loc));
4006 void CGDebugInfo::EmitUsingDecl(const UsingDecl &UD) {
4007 if (CGM.getCodeGenOpts().getDebugInfo() < codegenoptions::LimitedDebugInfo)
4009 assert(UD.shadow_size() &&
4010 "We shouldn't be codegening an invalid UsingDecl containing no decls");
4011 // Emitting one decl is sufficient - debuggers can detect that this is an
4012 // overloaded name & provide lookup for all the overloads.
4013 const UsingShadowDecl &USD = **UD.shadow_begin();
4015 // FIXME: Skip functions with undeduced auto return type for now since we
4016 // don't currently have the plumbing for separate declarations & definitions
4017 // of free functions and mismatched types (auto in the declaration, concrete
4018 // return type in the definition)
4019 if (const auto *FD = dyn_cast<FunctionDecl>(USD.getUnderlyingDecl()))
4020 if (const auto *AT =
4021 FD->getType()->getAs<FunctionProtoType>()->getContainedAutoType())
4022 if (AT->getDeducedType().isNull())
4024 if (llvm::DINode *Target =
4025 getDeclarationOrDefinition(USD.getUnderlyingDecl())) {
4026 auto Loc = USD.getLocation();
4027 DBuilder.createImportedDeclaration(
4028 getCurrentContextDescriptor(cast<Decl>(USD.getDeclContext())), Target,
4029 getOrCreateFile(Loc), getLineNumber(Loc));
4033 void CGDebugInfo::EmitImportDecl(const ImportDecl &ID) {
4034 if (CGM.getCodeGenOpts().getDebuggerTuning() != llvm::DebuggerKind::LLDB)
4036 if (Module *M = ID.getImportedModule()) {
4037 auto Info = ExternalASTSource::ASTSourceDescriptor(*M);
4038 auto Loc = ID.getLocation();
4039 DBuilder.createImportedDeclaration(
4040 getCurrentContextDescriptor(cast<Decl>(ID.getDeclContext())),
4041 getOrCreateModuleRef(Info, DebugTypeExtRefs), getOrCreateFile(Loc),
4042 getLineNumber(Loc));
4046 llvm::DIImportedEntity *
4047 CGDebugInfo::EmitNamespaceAlias(const NamespaceAliasDecl &NA) {
4048 if (CGM.getCodeGenOpts().getDebugInfo() < codegenoptions::LimitedDebugInfo)
4050 auto &VH = NamespaceAliasCache[&NA];
4052 return cast<llvm::DIImportedEntity>(VH);
4053 llvm::DIImportedEntity *R;
4054 auto Loc = NA.getLocation();
4055 if (const auto *Underlying =
4056 dyn_cast<NamespaceAliasDecl>(NA.getAliasedNamespace()))
4057 // This could cache & dedup here rather than relying on metadata deduping.
4058 R = DBuilder.createImportedDeclaration(
4059 getCurrentContextDescriptor(cast<Decl>(NA.getDeclContext())),
4060 EmitNamespaceAlias(*Underlying), getOrCreateFile(Loc),
4061 getLineNumber(Loc), NA.getName());
4063 R = DBuilder.createImportedDeclaration(
4064 getCurrentContextDescriptor(cast<Decl>(NA.getDeclContext())),
4065 getOrCreateNamespace(cast<NamespaceDecl>(NA.getAliasedNamespace())),
4066 getOrCreateFile(Loc), getLineNumber(Loc), NA.getName());
4072 CGDebugInfo::getOrCreateNamespace(const NamespaceDecl *NSDecl) {
4073 // Don't canonicalize the NamespaceDecl here: The DINamespace will be uniqued
4074 // if necessary, and this way multiple declarations of the same namespace in
4075 // different parent modules stay distinct.
4076 auto I = NamespaceCache.find(NSDecl);
4077 if (I != NamespaceCache.end())
4078 return cast<llvm::DINamespace>(I->second);
4080 llvm::DIScope *Context = getDeclContextDescriptor(NSDecl);
4081 // Don't trust the context if it is a DIModule (see comment above).
4082 llvm::DINamespace *NS =
4083 DBuilder.createNameSpace(Context, NSDecl->getName(), NSDecl->isInline());
4084 NamespaceCache[NSDecl].reset(NS);
4088 void CGDebugInfo::setDwoId(uint64_t Signature) {
4089 assert(TheCU && "no main compile unit");
4090 TheCU->setDWOId(Signature);
4094 void CGDebugInfo::finalize() {
4095 // Creating types might create further types - invalidating the current
4096 // element and the size(), so don't cache/reference them.
4097 for (size_t i = 0; i != ObjCInterfaceCache.size(); ++i) {
4098 ObjCInterfaceCacheEntry E = ObjCInterfaceCache[i];
4099 llvm::DIType *Ty = E.Type->getDecl()->getDefinition()
4100 ? CreateTypeDefinition(E.Type, E.Unit)
4102 DBuilder.replaceTemporary(llvm::TempDIType(E.Decl), Ty);
4105 for (auto p : ReplaceMap) {
4107 auto *Ty = cast<llvm::DIType>(p.second);
4108 assert(Ty->isForwardDecl());
4110 auto it = TypeCache.find(p.first);
4111 assert(it != TypeCache.end());
4114 DBuilder.replaceTemporary(llvm::TempDIType(Ty),
4115 cast<llvm::DIType>(it->second));
4118 for (const auto &p : FwdDeclReplaceMap) {
4120 llvm::TempMDNode FwdDecl(cast<llvm::MDNode>(p.second));
4121 llvm::Metadata *Repl;
4123 auto it = DeclCache.find(p.first);
4124 // If there has been no definition for the declaration, call RAUW
4125 // with ourselves, that will destroy the temporary MDNode and
4126 // replace it with a standard one, avoiding leaking memory.
4127 if (it == DeclCache.end())
4132 if (auto *GVE = dyn_cast_or_null<llvm::DIGlobalVariableExpression>(Repl))
4133 Repl = GVE->getVariable();
4134 DBuilder.replaceTemporary(std::move(FwdDecl), cast<llvm::MDNode>(Repl));
4137 // We keep our own list of retained types, because we need to look
4138 // up the final type in the type cache.
4139 for (auto &RT : RetainedTypes)
4140 if (auto MD = TypeCache[RT])
4141 DBuilder.retainType(cast<llvm::DIType>(MD));
4143 DBuilder.finalize();
4146 void CGDebugInfo::EmitExplicitCastType(QualType Ty) {
4147 if (CGM.getCodeGenOpts().getDebugInfo() < codegenoptions::LimitedDebugInfo)
4150 if (auto *DieTy = getOrCreateType(Ty, getOrCreateMainFile()))
4151 // Don't ignore in case of explicit cast where it is referenced indirectly.
4152 DBuilder.retainType(DieTy);
4155 llvm::DebugLoc CGDebugInfo::SourceLocToDebugLoc(SourceLocation Loc) {
4156 if (LexicalBlockStack.empty())
4157 return llvm::DebugLoc();
4159 llvm::MDNode *Scope = LexicalBlockStack.back();
4160 return llvm::DebugLoc::get(
4161 getLineNumber(Loc), getColumnNumber(Loc), Scope);