1 //===--- CGDebugInfo.cpp - Emit Debug Information for a Module ------------===//
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
7 //===----------------------------------------------------------------------===//
9 // This coordinates the debug information generation while generating code.
11 //===----------------------------------------------------------------------===//
13 #include "CGDebugInfo.h"
16 #include "CGObjCRuntime.h"
17 #include "CGRecordLayout.h"
18 #include "CodeGenFunction.h"
19 #include "CodeGenModule.h"
20 #include "ConstantEmitter.h"
21 #include "clang/Analysis/Analyses/ExprMutationAnalyzer.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/CodeGenOptions.h"
29 #include "clang/Basic/FileManager.h"
30 #include "clang/Basic/SourceManager.h"
31 #include "clang/Basic/Version.h"
32 #include "clang/Frontend/FrontendOptions.h"
33 #include "clang/Lex/HeaderSearchOptions.h"
34 #include "clang/Lex/ModuleMap.h"
35 #include "clang/Lex/PreprocessorOptions.h"
36 #include "llvm/ADT/DenseSet.h"
37 #include "llvm/ADT/SmallVector.h"
38 #include "llvm/ADT/StringExtras.h"
39 #include "llvm/IR/Constants.h"
40 #include "llvm/IR/DataLayout.h"
41 #include "llvm/IR/DerivedTypes.h"
42 #include "llvm/IR/Instructions.h"
43 #include "llvm/IR/Intrinsics.h"
44 #include "llvm/IR/Metadata.h"
45 #include "llvm/IR/Module.h"
46 #include "llvm/Support/FileSystem.h"
47 #include "llvm/Support/MD5.h"
48 #include "llvm/Support/Path.h"
49 using namespace clang;
50 using namespace clang::CodeGen;
52 static uint32_t getTypeAlignIfRequired(const Type *Ty, const ASTContext &Ctx) {
53 auto TI = Ctx.getTypeInfo(Ty);
54 return TI.AlignIsRequired ? TI.Align : 0;
57 static uint32_t getTypeAlignIfRequired(QualType Ty, const ASTContext &Ctx) {
58 return getTypeAlignIfRequired(Ty.getTypePtr(), Ctx);
61 static uint32_t getDeclAlignIfRequired(const Decl *D, const ASTContext &Ctx) {
62 return D->hasAttr<AlignedAttr>() ? D->getMaxAlignment() : 0;
65 CGDebugInfo::CGDebugInfo(CodeGenModule &CGM)
66 : CGM(CGM), DebugKind(CGM.getCodeGenOpts().getDebugInfo()),
67 DebugTypeExtRefs(CGM.getCodeGenOpts().DebugTypeExtRefs),
68 DBuilder(CGM.getModule()) {
69 for (const auto &KV : CGM.getCodeGenOpts().DebugPrefixMap)
70 DebugPrefixMap[KV.first] = KV.second;
74 CGDebugInfo::~CGDebugInfo() {
75 assert(LexicalBlockStack.empty() &&
76 "Region stack mismatch, stack not empty!");
79 ApplyDebugLocation::ApplyDebugLocation(CodeGenFunction &CGF,
80 SourceLocation TemporaryLocation)
82 init(TemporaryLocation);
85 ApplyDebugLocation::ApplyDebugLocation(CodeGenFunction &CGF,
87 SourceLocation TemporaryLocation)
89 init(TemporaryLocation, DefaultToEmpty);
92 void ApplyDebugLocation::init(SourceLocation TemporaryLocation,
93 bool DefaultToEmpty) {
94 auto *DI = CGF->getDebugInfo();
100 OriginalLocation = CGF->Builder.getCurrentDebugLocation();
102 if (OriginalLocation && !DI->CGM.getExpressionLocationsEnabled())
105 if (TemporaryLocation.isValid()) {
106 DI->EmitLocation(CGF->Builder, TemporaryLocation);
110 if (DefaultToEmpty) {
111 CGF->Builder.SetCurrentDebugLocation(llvm::DebugLoc());
115 // Construct a location that has a valid scope, but no line info.
116 assert(!DI->LexicalBlockStack.empty());
117 CGF->Builder.SetCurrentDebugLocation(llvm::DebugLoc::get(
118 0, 0, DI->LexicalBlockStack.back(), DI->getInlinedAt()));
121 ApplyDebugLocation::ApplyDebugLocation(CodeGenFunction &CGF, const Expr *E)
123 init(E->getExprLoc());
126 ApplyDebugLocation::ApplyDebugLocation(CodeGenFunction &CGF, llvm::DebugLoc Loc)
128 if (!CGF.getDebugInfo()) {
132 OriginalLocation = CGF.Builder.getCurrentDebugLocation();
134 CGF.Builder.SetCurrentDebugLocation(std::move(Loc));
137 ApplyDebugLocation::~ApplyDebugLocation() {
138 // Query CGF so the location isn't overwritten when location updates are
139 // temporarily disabled (for C++ default function arguments)
141 CGF->Builder.SetCurrentDebugLocation(std::move(OriginalLocation));
144 ApplyInlineDebugLocation::ApplyInlineDebugLocation(CodeGenFunction &CGF,
145 GlobalDecl InlinedFn)
147 if (!CGF.getDebugInfo()) {
151 auto &DI = *CGF.getDebugInfo();
152 SavedLocation = DI.getLocation();
153 assert((DI.getInlinedAt() ==
154 CGF.Builder.getCurrentDebugLocation()->getInlinedAt()) &&
155 "CGDebugInfo and IRBuilder are out of sync");
157 DI.EmitInlineFunctionStart(CGF.Builder, InlinedFn);
160 ApplyInlineDebugLocation::~ApplyInlineDebugLocation() {
163 auto &DI = *CGF->getDebugInfo();
164 DI.EmitInlineFunctionEnd(CGF->Builder);
165 DI.EmitLocation(CGF->Builder, SavedLocation);
168 void CGDebugInfo::setLocation(SourceLocation Loc) {
169 // If the new location isn't valid return.
173 CurLoc = CGM.getContext().getSourceManager().getExpansionLoc(Loc);
175 // If we've changed files in the middle of a lexical scope go ahead
176 // and create a new lexical scope with file node if it's different
177 // from the one in the scope.
178 if (LexicalBlockStack.empty())
181 SourceManager &SM = CGM.getContext().getSourceManager();
182 auto *Scope = cast<llvm::DIScope>(LexicalBlockStack.back());
183 PresumedLoc PCLoc = SM.getPresumedLoc(CurLoc);
184 if (PCLoc.isInvalid() || Scope->getFile() == getOrCreateFile(CurLoc))
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),
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;
237 // Apply -fdebug-prefix-map.
238 PP.RemapFilePaths = true;
239 PP.remapPath = [this](StringRef Path) { return remapDIPath(Path); };
243 StringRef CGDebugInfo::getFunctionName(const FunctionDecl *FD) {
244 assert(FD && "Invalid FunctionDecl!");
245 IdentifierInfo *FII = FD->getIdentifier();
246 FunctionTemplateSpecializationInfo *Info =
247 FD->getTemplateSpecializationInfo();
249 // Emit the unqualified name in normal operation. LLVM and the debugger can
250 // compute the fully qualified name from the scope chain. If we're only
251 // emitting line table info, there won't be any scope chains, so emit the
252 // fully qualified name here so that stack traces are more accurate.
253 // FIXME: Do this when emitting DWARF as well as when emitting CodeView after
254 // evaluating the size impact.
255 bool UseQualifiedName = DebugKind == codegenoptions::DebugLineTablesOnly &&
256 CGM.getCodeGenOpts().EmitCodeView;
258 if (!Info && FII && !UseQualifiedName)
259 return FII->getName();
262 llvm::raw_svector_ostream OS(NS);
263 if (!UseQualifiedName)
266 FD->printQualifiedName(OS, getPrintingPolicy());
268 // Add any template specialization args.
270 const TemplateArgumentList *TArgs = Info->TemplateArguments;
271 printTemplateArgumentList(OS, TArgs->asArray(), getPrintingPolicy());
274 // Copy this name on the side and use its reference.
275 return internString(OS.str());
278 StringRef CGDebugInfo::getObjCMethodName(const ObjCMethodDecl *OMD) {
279 SmallString<256> MethodName;
280 llvm::raw_svector_ostream OS(MethodName);
281 OS << (OMD->isInstanceMethod() ? '-' : '+') << '[';
282 const DeclContext *DC = OMD->getDeclContext();
283 if (const auto *OID = dyn_cast<ObjCImplementationDecl>(DC)) {
284 OS << OID->getName();
285 } else if (const auto *OID = dyn_cast<ObjCInterfaceDecl>(DC)) {
286 OS << OID->getName();
287 } else if (const auto *OC = dyn_cast<ObjCCategoryDecl>(DC)) {
288 if (OC->IsClassExtension()) {
289 OS << OC->getClassInterface()->getName();
291 OS << OC->getIdentifier()->getNameStart() << '('
292 << OC->getIdentifier()->getNameStart() << ')';
294 } else if (const auto *OCD = dyn_cast<ObjCCategoryImplDecl>(DC)) {
295 OS << OCD->getClassInterface()->getName() << '(' << OCD->getName() << ')';
296 } else if (isa<ObjCProtocolDecl>(DC)) {
297 // We can extract the type of the class from the self pointer.
298 if (ImplicitParamDecl *SelfDecl = OMD->getSelfDecl()) {
300 cast<ObjCObjectPointerType>(SelfDecl->getType())->getPointeeType();
301 ClassTy.print(OS, PrintingPolicy(LangOptions()));
304 OS << ' ' << OMD->getSelector().getAsString() << ']';
306 return internString(OS.str());
309 StringRef CGDebugInfo::getSelectorName(Selector S) {
310 return internString(S.getAsString());
313 StringRef CGDebugInfo::getClassName(const RecordDecl *RD) {
314 if (isa<ClassTemplateSpecializationDecl>(RD)) {
315 SmallString<128> Name;
316 llvm::raw_svector_ostream OS(Name);
317 RD->getNameForDiagnostic(OS, getPrintingPolicy(),
318 /*Qualified*/ false);
320 // Copy this name on the side and use its reference.
321 return internString(Name);
324 // quick optimization to avoid having to intern strings that are already
325 // stored reliably elsewhere
326 if (const IdentifierInfo *II = RD->getIdentifier())
327 return II->getName();
329 // The CodeView printer in LLVM wants to see the names of unnamed types: it is
330 // used to reconstruct the fully qualified type names.
331 if (CGM.getCodeGenOpts().EmitCodeView) {
332 if (const TypedefNameDecl *D = RD->getTypedefNameForAnonDecl()) {
333 assert(RD->getDeclContext() == D->getDeclContext() &&
334 "Typedef should not be in another decl context!");
335 assert(D->getDeclName().getAsIdentifierInfo() &&
336 "Typedef was not named!");
337 return D->getDeclName().getAsIdentifierInfo()->getName();
340 if (CGM.getLangOpts().CPlusPlus) {
343 ASTContext &Context = CGM.getContext();
344 if (const DeclaratorDecl *DD = Context.getDeclaratorForUnnamedTagDecl(RD))
345 // Anonymous types without a name for linkage purposes have their
346 // declarator mangled in if they have one.
347 Name = DD->getName();
348 else if (const TypedefNameDecl *TND =
349 Context.getTypedefNameForUnnamedTagDecl(RD))
350 // Anonymous types without a name for linkage purposes have their
351 // associate typedef mangled in if they have one.
352 Name = TND->getName();
355 SmallString<256> UnnamedType("<unnamed-type-");
358 return internString(UnnamedType);
366 Optional<llvm::DIFile::ChecksumKind>
367 CGDebugInfo::computeChecksum(FileID FID, SmallString<32> &Checksum) const {
370 if (!CGM.getCodeGenOpts().EmitCodeView &&
371 CGM.getCodeGenOpts().DwarfVersion < 5)
374 SourceManager &SM = CGM.getContext().getSourceManager();
376 const llvm::MemoryBuffer *MemBuffer = SM.getBuffer(FID, &Invalid);
381 llvm::MD5::MD5Result Result;
383 Hash.update(MemBuffer->getBuffer());
386 Hash.stringifyResult(Result, Checksum);
387 return llvm::DIFile::CSK_MD5;
390 Optional<StringRef> CGDebugInfo::getSource(const SourceManager &SM,
392 if (!CGM.getCodeGenOpts().EmbedSource)
395 bool SourceInvalid = false;
396 StringRef Source = SM.getBufferData(FID, &SourceInvalid);
404 llvm::DIFile *CGDebugInfo::getOrCreateFile(SourceLocation Loc) {
406 // If Location is not valid then use main input file.
407 return TheCU->getFile();
409 SourceManager &SM = CGM.getContext().getSourceManager();
410 PresumedLoc PLoc = SM.getPresumedLoc(Loc);
412 StringRef FileName = PLoc.getFilename();
413 if (PLoc.isInvalid() || FileName.empty())
414 // If the location is not valid then use main input file.
415 return TheCU->getFile();
417 // Cache the results.
418 auto It = DIFileCache.find(FileName.data());
419 if (It != DIFileCache.end()) {
420 // Verify that the information still exists.
421 if (llvm::Metadata *V = It->second)
422 return cast<llvm::DIFile>(V);
425 SmallString<32> Checksum;
427 // Compute the checksum if possible. If the location is affected by a #line
428 // directive that refers to a file, PLoc will have an invalid FileID, and we
429 // will correctly get no checksum.
430 Optional<llvm::DIFile::ChecksumKind> CSKind =
431 computeChecksum(PLoc.getFileID(), Checksum);
432 Optional<llvm::DIFile::ChecksumInfo<StringRef>> CSInfo;
434 CSInfo.emplace(*CSKind, Checksum);
435 return createFile(FileName, CSInfo, getSource(SM, SM.getFileID(Loc)));
439 CGDebugInfo::createFile(StringRef FileName,
440 Optional<llvm::DIFile::ChecksumInfo<StringRef>> CSInfo,
441 Optional<StringRef> Source) {
444 std::string RemappedFile = remapDIPath(FileName);
445 std::string CurDir = remapDIPath(getCurrentDirname());
446 SmallString<128> DirBuf;
447 SmallString<128> FileBuf;
448 if (llvm::sys::path::is_absolute(RemappedFile)) {
449 // Strip the common prefix (if it is more than just "/") from current
450 // directory and FileName for a more space-efficient encoding.
451 auto FileIt = llvm::sys::path::begin(RemappedFile);
452 auto FileE = llvm::sys::path::end(RemappedFile);
453 auto CurDirIt = llvm::sys::path::begin(CurDir);
454 auto CurDirE = llvm::sys::path::end(CurDir);
455 for (; CurDirIt != CurDirE && *CurDirIt == *FileIt; ++CurDirIt, ++FileIt)
456 llvm::sys::path::append(DirBuf, *CurDirIt);
457 if (std::distance(llvm::sys::path::begin(CurDir), CurDirIt) == 1) {
458 // Don't strip the common prefix if it is only the root "/"
459 // since that would make LLVM diagnostic locations confusing.
463 for (; FileIt != FileE; ++FileIt)
464 llvm::sys::path::append(FileBuf, *FileIt);
472 llvm::DIFile *F = DBuilder.createFile(File, Dir, CSInfo, Source);
473 DIFileCache[FileName.data()].reset(F);
477 std::string CGDebugInfo::remapDIPath(StringRef Path) const {
478 for (const auto &Entry : DebugPrefixMap)
479 if (Path.startswith(Entry.first))
480 return (Twine(Entry.second) + Path.substr(Entry.first.size())).str();
484 unsigned CGDebugInfo::getLineNumber(SourceLocation Loc) {
485 if (Loc.isInvalid() && CurLoc.isInvalid())
487 SourceManager &SM = CGM.getContext().getSourceManager();
488 PresumedLoc PLoc = SM.getPresumedLoc(Loc.isValid() ? Loc : CurLoc);
489 return PLoc.isValid() ? PLoc.getLine() : 0;
492 unsigned CGDebugInfo::getColumnNumber(SourceLocation Loc, bool Force) {
493 // We may not want column information at all.
494 if (!Force && !CGM.getCodeGenOpts().DebugColumnInfo)
497 // If the location is invalid then use the current column.
498 if (Loc.isInvalid() && CurLoc.isInvalid())
500 SourceManager &SM = CGM.getContext().getSourceManager();
501 PresumedLoc PLoc = SM.getPresumedLoc(Loc.isValid() ? Loc : CurLoc);
502 return PLoc.isValid() ? PLoc.getColumn() : 0;
505 StringRef CGDebugInfo::getCurrentDirname() {
506 if (!CGM.getCodeGenOpts().DebugCompilationDir.empty())
507 return CGM.getCodeGenOpts().DebugCompilationDir;
509 if (!CWDName.empty())
511 SmallString<256> CWD;
512 llvm::sys::fs::current_path(CWD);
513 return CWDName = internString(CWD);
516 void CGDebugInfo::CreateCompileUnit() {
517 SmallString<32> Checksum;
518 Optional<llvm::DIFile::ChecksumKind> CSKind;
519 Optional<llvm::DIFile::ChecksumInfo<StringRef>> CSInfo;
521 // Should we be asking the SourceManager for the main file name, instead of
522 // accepting it as an argument? This just causes the main file name to
523 // mismatch with source locations and create extra lexical scopes or
524 // mismatched debug info (a CU with a DW_AT_file of "-", because that's what
525 // the driver passed, but functions/other things have DW_AT_file of "<stdin>"
526 // because that's what the SourceManager says)
528 // Get absolute path name.
529 SourceManager &SM = CGM.getContext().getSourceManager();
530 std::string MainFileName = CGM.getCodeGenOpts().MainFileName;
531 if (MainFileName.empty())
532 MainFileName = "<stdin>";
534 // The main file name provided via the "-main-file-name" option contains just
535 // the file name itself with no path information. This file name may have had
536 // a relative path, so we look into the actual file entry for the main
537 // file to determine the real absolute path for the file.
538 std::string MainFileDir;
539 if (const FileEntry *MainFile = SM.getFileEntryForID(SM.getMainFileID())) {
540 MainFileDir = remapDIPath(MainFile->getDir()->getName());
541 if (MainFileDir != ".") {
542 llvm::SmallString<1024> MainFileDirSS(MainFileDir);
543 llvm::sys::path::append(MainFileDirSS, MainFileName);
544 MainFileName = MainFileDirSS.str();
546 // If the main file name provided is identical to the input file name, and
547 // if the input file is a preprocessed source, use the module name for
548 // debug info. The module name comes from the name specified in the first
549 // linemarker if the input is a preprocessed source.
550 if (MainFile->getName() == MainFileName &&
551 FrontendOptions::getInputKindForExtension(
552 MainFile->getName().rsplit('.').second)
554 MainFileName = CGM.getModule().getName().str();
556 CSKind = computeChecksum(SM.getMainFileID(), Checksum);
559 llvm::dwarf::SourceLanguage LangTag;
560 const LangOptions &LO = CGM.getLangOpts();
563 LangTag = llvm::dwarf::DW_LANG_ObjC_plus_plus;
565 LangTag = llvm::dwarf::DW_LANG_C_plus_plus;
566 } else if (LO.ObjC) {
567 LangTag = llvm::dwarf::DW_LANG_ObjC;
568 } else if (LO.RenderScript) {
569 LangTag = llvm::dwarf::DW_LANG_GOOGLE_RenderScript;
571 LangTag = llvm::dwarf::DW_LANG_C99;
573 LangTag = llvm::dwarf::DW_LANG_C89;
576 std::string Producer = getClangFullVersion();
578 // Figure out which version of the ObjC runtime we have.
579 unsigned RuntimeVers = 0;
581 RuntimeVers = LO.ObjCRuntime.isNonFragile() ? 2 : 1;
583 llvm::DICompileUnit::DebugEmissionKind EmissionKind;
585 case codegenoptions::NoDebugInfo:
586 case codegenoptions::LocTrackingOnly:
587 EmissionKind = llvm::DICompileUnit::NoDebug;
589 case codegenoptions::DebugLineTablesOnly:
590 EmissionKind = llvm::DICompileUnit::LineTablesOnly;
592 case codegenoptions::DebugDirectivesOnly:
593 EmissionKind = llvm::DICompileUnit::DebugDirectivesOnly;
595 case codegenoptions::LimitedDebugInfo:
596 case codegenoptions::FullDebugInfo:
597 EmissionKind = llvm::DICompileUnit::FullDebug;
602 auto &CGOpts = CGM.getCodeGenOpts();
603 // The DIFile used by the CU is distinct from the main source
604 // file. Its directory part specifies what becomes the
605 // DW_AT_comp_dir (the compilation directory), even if the source
606 // file was specified with an absolute path.
608 CSInfo.emplace(*CSKind, Checksum);
609 llvm::DIFile *CUFile = DBuilder.createFile(
610 remapDIPath(MainFileName), remapDIPath(getCurrentDirname()), CSInfo,
611 getSource(SM, SM.getMainFileID()));
613 // Create new compile unit.
614 TheCU = DBuilder.createCompileUnit(
615 LangTag, CUFile, CGOpts.EmitVersionIdentMetadata ? Producer : "",
616 LO.Optimize || CGOpts.PrepareForLTO || CGOpts.PrepareForThinLTO,
617 CGOpts.DwarfDebugFlags, RuntimeVers, CGOpts.SplitDwarfFile, EmissionKind,
618 DwoId, CGOpts.SplitDwarfInlining, CGOpts.DebugInfoForProfiling,
619 CGM.getTarget().getTriple().isNVPTX()
620 ? llvm::DICompileUnit::DebugNameTableKind::None
621 : static_cast<llvm::DICompileUnit::DebugNameTableKind>(
622 CGOpts.DebugNameTable),
623 CGOpts.DebugRangesBaseAddress);
626 llvm::DIType *CGDebugInfo::CreateType(const BuiltinType *BT) {
627 llvm::dwarf::TypeKind Encoding;
629 switch (BT->getKind()) {
630 #define BUILTIN_TYPE(Id, SingletonId)
631 #define PLACEHOLDER_TYPE(Id, SingletonId) case BuiltinType::Id:
632 #include "clang/AST/BuiltinTypes.def"
633 case BuiltinType::Dependent:
634 llvm_unreachable("Unexpected builtin type");
635 case BuiltinType::NullPtr:
636 return DBuilder.createNullPtrType();
637 case BuiltinType::Void:
639 case BuiltinType::ObjCClass:
642 DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
643 "objc_class", TheCU, TheCU->getFile(), 0);
645 case BuiltinType::ObjCId: {
646 // typedef struct objc_class *Class;
647 // typedef struct objc_object {
656 DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
657 "objc_class", TheCU, TheCU->getFile(), 0);
659 unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
661 auto *ISATy = DBuilder.createPointerType(ClassTy, Size);
663 ObjTy = DBuilder.createStructType(TheCU, "objc_object", TheCU->getFile(), 0,
664 0, 0, llvm::DINode::FlagZero, nullptr,
665 llvm::DINodeArray());
667 DBuilder.replaceArrays(
668 ObjTy, DBuilder.getOrCreateArray(&*DBuilder.createMemberType(
669 ObjTy, "isa", TheCU->getFile(), 0, Size, 0, 0,
670 llvm::DINode::FlagZero, ISATy)));
673 case BuiltinType::ObjCSel: {
675 SelTy = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
676 "objc_selector", TheCU,
677 TheCU->getFile(), 0);
681 #define IMAGE_TYPE(ImgType, Id, SingletonId, Access, Suffix) \
682 case BuiltinType::Id: \
683 return getOrCreateStructPtrType("opencl_" #ImgType "_" #Suffix "_t", \
685 #include "clang/Basic/OpenCLImageTypes.def"
686 case BuiltinType::OCLSampler:
687 return getOrCreateStructPtrType("opencl_sampler_t", OCLSamplerDITy);
688 case BuiltinType::OCLEvent:
689 return getOrCreateStructPtrType("opencl_event_t", OCLEventDITy);
690 case BuiltinType::OCLClkEvent:
691 return getOrCreateStructPtrType("opencl_clk_event_t", OCLClkEventDITy);
692 case BuiltinType::OCLQueue:
693 return getOrCreateStructPtrType("opencl_queue_t", OCLQueueDITy);
694 case BuiltinType::OCLReserveID:
695 return getOrCreateStructPtrType("opencl_reserve_id_t", OCLReserveIDDITy);
696 #define EXT_OPAQUE_TYPE(ExtType, Id, Ext) \
697 case BuiltinType::Id: \
698 return getOrCreateStructPtrType("opencl_" #ExtType, Id##Ty);
699 #include "clang/Basic/OpenCLExtensionTypes.def"
701 case BuiltinType::UChar:
702 case BuiltinType::Char_U:
703 Encoding = llvm::dwarf::DW_ATE_unsigned_char;
705 case BuiltinType::Char_S:
706 case BuiltinType::SChar:
707 Encoding = llvm::dwarf::DW_ATE_signed_char;
709 case BuiltinType::Char8:
710 case BuiltinType::Char16:
711 case BuiltinType::Char32:
712 Encoding = llvm::dwarf::DW_ATE_UTF;
714 case BuiltinType::UShort:
715 case BuiltinType::UInt:
716 case BuiltinType::UInt128:
717 case BuiltinType::ULong:
718 case BuiltinType::WChar_U:
719 case BuiltinType::ULongLong:
720 Encoding = llvm::dwarf::DW_ATE_unsigned;
722 case BuiltinType::Short:
723 case BuiltinType::Int:
724 case BuiltinType::Int128:
725 case BuiltinType::Long:
726 case BuiltinType::WChar_S:
727 case BuiltinType::LongLong:
728 Encoding = llvm::dwarf::DW_ATE_signed;
730 case BuiltinType::Bool:
731 Encoding = llvm::dwarf::DW_ATE_boolean;
733 case BuiltinType::Half:
734 case BuiltinType::Float:
735 case BuiltinType::LongDouble:
736 case BuiltinType::Float16:
737 case BuiltinType::Float128:
738 case BuiltinType::Double:
739 // FIXME: For targets where long double and __float128 have the same size,
740 // they are currently indistinguishable in the debugger without some
741 // special treatment. However, there is currently no consensus on encoding
742 // and this should be updated once a DWARF encoding exists for distinct
743 // floating point types of the same size.
744 Encoding = llvm::dwarf::DW_ATE_float;
746 case BuiltinType::ShortAccum:
747 case BuiltinType::Accum:
748 case BuiltinType::LongAccum:
749 case BuiltinType::ShortFract:
750 case BuiltinType::Fract:
751 case BuiltinType::LongFract:
752 case BuiltinType::SatShortFract:
753 case BuiltinType::SatFract:
754 case BuiltinType::SatLongFract:
755 case BuiltinType::SatShortAccum:
756 case BuiltinType::SatAccum:
757 case BuiltinType::SatLongAccum:
758 Encoding = llvm::dwarf::DW_ATE_signed_fixed;
760 case BuiltinType::UShortAccum:
761 case BuiltinType::UAccum:
762 case BuiltinType::ULongAccum:
763 case BuiltinType::UShortFract:
764 case BuiltinType::UFract:
765 case BuiltinType::ULongFract:
766 case BuiltinType::SatUShortAccum:
767 case BuiltinType::SatUAccum:
768 case BuiltinType::SatULongAccum:
769 case BuiltinType::SatUShortFract:
770 case BuiltinType::SatUFract:
771 case BuiltinType::SatULongFract:
772 Encoding = llvm::dwarf::DW_ATE_unsigned_fixed;
776 switch (BT->getKind()) {
777 case BuiltinType::Long:
780 case BuiltinType::LongLong:
781 BTName = "long long int";
783 case BuiltinType::ULong:
784 BTName = "long unsigned int";
786 case BuiltinType::ULongLong:
787 BTName = "long long unsigned int";
790 BTName = BT->getName(CGM.getLangOpts());
793 // Bit size and offset of the type.
794 uint64_t Size = CGM.getContext().getTypeSize(BT);
795 return DBuilder.createBasicType(BTName, Size, Encoding);
798 llvm::DIType *CGDebugInfo::CreateType(const ComplexType *Ty) {
799 // Bit size and offset of the type.
800 llvm::dwarf::TypeKind Encoding = llvm::dwarf::DW_ATE_complex_float;
801 if (Ty->isComplexIntegerType())
802 Encoding = llvm::dwarf::DW_ATE_lo_user;
804 uint64_t Size = CGM.getContext().getTypeSize(Ty);
805 return DBuilder.createBasicType("complex", Size, Encoding);
808 llvm::DIType *CGDebugInfo::CreateQualifiedType(QualType Ty,
809 llvm::DIFile *Unit) {
810 QualifierCollector Qc;
811 const Type *T = Qc.strip(Ty);
813 // Ignore these qualifiers for now.
814 Qc.removeObjCGCAttr();
815 Qc.removeAddressSpace();
816 Qc.removeObjCLifetime();
818 // We will create one Derived type for one qualifier and recurse to handle any
820 llvm::dwarf::Tag Tag;
822 Tag = llvm::dwarf::DW_TAG_const_type;
824 } else if (Qc.hasVolatile()) {
825 Tag = llvm::dwarf::DW_TAG_volatile_type;
827 } else if (Qc.hasRestrict()) {
828 Tag = llvm::dwarf::DW_TAG_restrict_type;
831 assert(Qc.empty() && "Unknown type qualifier for debug info");
832 return getOrCreateType(QualType(T, 0), Unit);
835 auto *FromTy = getOrCreateType(Qc.apply(CGM.getContext(), T), Unit);
837 // No need to fill in the Name, Line, Size, Alignment, Offset in case of
838 // CVR derived types.
839 return DBuilder.createQualifiedType(Tag, FromTy);
842 llvm::DIType *CGDebugInfo::CreateType(const ObjCObjectPointerType *Ty,
843 llvm::DIFile *Unit) {
845 // The frontend treats 'id' as a typedef to an ObjCObjectType,
846 // whereas 'id<protocol>' is treated as an ObjCPointerType. For the
847 // debug info, we want to emit 'id' in both cases.
848 if (Ty->isObjCQualifiedIdType())
849 return getOrCreateType(CGM.getContext().getObjCIdType(), Unit);
851 return CreatePointerLikeType(llvm::dwarf::DW_TAG_pointer_type, Ty,
852 Ty->getPointeeType(), Unit);
855 llvm::DIType *CGDebugInfo::CreateType(const PointerType *Ty,
856 llvm::DIFile *Unit) {
857 return CreatePointerLikeType(llvm::dwarf::DW_TAG_pointer_type, Ty,
858 Ty->getPointeeType(), Unit);
861 /// \return whether a C++ mangling exists for the type defined by TD.
862 static bool hasCXXMangling(const TagDecl *TD, llvm::DICompileUnit *TheCU) {
863 switch (TheCU->getSourceLanguage()) {
864 case llvm::dwarf::DW_LANG_C_plus_plus:
866 case llvm::dwarf::DW_LANG_ObjC_plus_plus:
867 return isa<CXXRecordDecl>(TD) || isa<EnumDecl>(TD);
873 // Determines if the debug info for this tag declaration needs a type
874 // identifier. The purpose of the unique identifier is to deduplicate type
875 // information for identical types across TUs. Because of the C++ one definition
876 // rule (ODR), it is valid to assume that the type is defined the same way in
877 // every TU and its debug info is equivalent.
879 // C does not have the ODR, and it is common for codebases to contain multiple
880 // different definitions of a struct with the same name in different TUs.
881 // Therefore, if the type doesn't have a C++ mangling, don't give it an
882 // identifer. Type information in C is smaller and simpler than C++ type
883 // information, so the increase in debug info size is negligible.
885 // If the type is not externally visible, it should be unique to the current TU,
886 // and should not need an identifier to participate in type deduplication.
887 // However, when emitting CodeView, the format internally uses these
888 // unique type name identifers for references between debug info. For example,
889 // the method of a class in an anonymous namespace uses the identifer to refer
890 // to its parent class. The Microsoft C++ ABI attempts to provide unique names
891 // for such types, so when emitting CodeView, always use identifiers for C++
892 // types. This may create problems when attempting to emit CodeView when the MS
893 // C++ ABI is not in use.
894 static bool needsTypeIdentifier(const TagDecl *TD, CodeGenModule &CGM,
895 llvm::DICompileUnit *TheCU) {
896 // We only add a type identifier for types with C++ name mangling.
897 if (!hasCXXMangling(TD, TheCU))
900 // Externally visible types with C++ mangling need a type identifier.
901 if (TD->isExternallyVisible())
904 // CodeView types with C++ mangling need a type identifier.
905 if (CGM.getCodeGenOpts().EmitCodeView)
911 // Returns a unique type identifier string if one exists, or an empty string.
912 static SmallString<256> getTypeIdentifier(const TagType *Ty, CodeGenModule &CGM,
913 llvm::DICompileUnit *TheCU) {
914 SmallString<256> Identifier;
915 const TagDecl *TD = Ty->getDecl();
917 if (!needsTypeIdentifier(TD, CGM, TheCU))
919 if (const auto *RD = dyn_cast<CXXRecordDecl>(TD))
920 if (RD->getDefinition())
921 if (RD->isDynamicClass() &&
922 CGM.getVTableLinkage(RD) == llvm::GlobalValue::ExternalLinkage)
925 // TODO: This is using the RTTI name. Is there a better way to get
926 // a unique string for a type?
927 llvm::raw_svector_ostream Out(Identifier);
928 CGM.getCXXABI().getMangleContext().mangleCXXRTTIName(QualType(Ty, 0), Out);
932 /// \return the appropriate DWARF tag for a composite type.
933 static llvm::dwarf::Tag getTagForRecord(const RecordDecl *RD) {
934 llvm::dwarf::Tag Tag;
935 if (RD->isStruct() || RD->isInterface())
936 Tag = llvm::dwarf::DW_TAG_structure_type;
937 else if (RD->isUnion())
938 Tag = llvm::dwarf::DW_TAG_union_type;
940 // FIXME: This could be a struct type giving a default visibility different
941 // than C++ class type, but needs llvm metadata changes first.
942 assert(RD->isClass());
943 Tag = llvm::dwarf::DW_TAG_class_type;
948 llvm::DICompositeType *
949 CGDebugInfo::getOrCreateRecordFwdDecl(const RecordType *Ty,
950 llvm::DIScope *Ctx) {
951 const RecordDecl *RD = Ty->getDecl();
952 if (llvm::DIType *T = getTypeOrNull(CGM.getContext().getRecordType(RD)))
953 return cast<llvm::DICompositeType>(T);
954 llvm::DIFile *DefUnit = getOrCreateFile(RD->getLocation());
955 unsigned Line = getLineNumber(RD->getLocation());
956 StringRef RDName = getClassName(RD);
962 SmallString<256> Identifier = getTypeIdentifier(Ty, CGM, TheCU);
963 llvm::DICompositeType *RetTy = DBuilder.createReplaceableCompositeType(
964 getTagForRecord(RD), RDName, Ctx, DefUnit, Line, 0, Size, Align,
965 llvm::DINode::FlagFwdDecl, Identifier);
966 if (CGM.getCodeGenOpts().DebugFwdTemplateParams)
967 if (auto *TSpecial = dyn_cast<ClassTemplateSpecializationDecl>(RD))
968 DBuilder.replaceArrays(RetTy, llvm::DINodeArray(),
969 CollectCXXTemplateParams(TSpecial, DefUnit));
970 ReplaceMap.emplace_back(
971 std::piecewise_construct, std::make_tuple(Ty),
972 std::make_tuple(static_cast<llvm::Metadata *>(RetTy)));
976 llvm::DIType *CGDebugInfo::CreatePointerLikeType(llvm::dwarf::Tag Tag,
979 llvm::DIFile *Unit) {
980 // Bit size, align and offset of the type.
981 // Size is always the size of a pointer. We can't use getTypeSize here
982 // because that does not return the correct value for references.
983 unsigned AddressSpace = CGM.getContext().getTargetAddressSpace(PointeeTy);
984 uint64_t Size = CGM.getTarget().getPointerWidth(AddressSpace);
985 auto Align = getTypeAlignIfRequired(Ty, CGM.getContext());
986 Optional<unsigned> DWARFAddressSpace =
987 CGM.getTarget().getDWARFAddressSpace(AddressSpace);
989 if (Tag == llvm::dwarf::DW_TAG_reference_type ||
990 Tag == llvm::dwarf::DW_TAG_rvalue_reference_type)
991 return DBuilder.createReferenceType(Tag, getOrCreateType(PointeeTy, Unit),
992 Size, Align, DWARFAddressSpace);
994 return DBuilder.createPointerType(getOrCreateType(PointeeTy, Unit), Size,
995 Align, DWARFAddressSpace);
998 llvm::DIType *CGDebugInfo::getOrCreateStructPtrType(StringRef Name,
999 llvm::DIType *&Cache) {
1002 Cache = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type, Name,
1003 TheCU, TheCU->getFile(), 0);
1004 unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
1005 Cache = DBuilder.createPointerType(Cache, Size);
1009 uint64_t CGDebugInfo::collectDefaultElementTypesForBlockPointer(
1010 const BlockPointerType *Ty, llvm::DIFile *Unit, llvm::DIDerivedType *DescTy,
1011 unsigned LineNo, SmallVectorImpl<llvm::Metadata *> &EltTys) {
1014 // Advanced by calls to CreateMemberType in increments of FType, then
1015 // returned as the overall size of the default elements.
1016 uint64_t FieldOffset = 0;
1018 // Blocks in OpenCL have unique constraints which make the standard fields
1019 // redundant while requiring size and align fields for enqueue_kernel. See
1020 // initializeForBlockHeader in CGBlocks.cpp
1021 if (CGM.getLangOpts().OpenCL) {
1022 FType = CGM.getContext().IntTy;
1023 EltTys.push_back(CreateMemberType(Unit, FType, "__size", &FieldOffset));
1024 EltTys.push_back(CreateMemberType(Unit, FType, "__align", &FieldOffset));
1026 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
1027 EltTys.push_back(CreateMemberType(Unit, FType, "__isa", &FieldOffset));
1028 FType = CGM.getContext().IntTy;
1029 EltTys.push_back(CreateMemberType(Unit, FType, "__flags", &FieldOffset));
1030 EltTys.push_back(CreateMemberType(Unit, FType, "__reserved", &FieldOffset));
1031 FType = CGM.getContext().getPointerType(Ty->getPointeeType());
1032 EltTys.push_back(CreateMemberType(Unit, FType, "__FuncPtr", &FieldOffset));
1033 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
1034 uint64_t FieldSize = CGM.getContext().getTypeSize(Ty);
1035 uint32_t FieldAlign = CGM.getContext().getTypeAlign(Ty);
1036 EltTys.push_back(DBuilder.createMemberType(
1037 Unit, "__descriptor", nullptr, LineNo, FieldSize, FieldAlign,
1038 FieldOffset, llvm::DINode::FlagZero, DescTy));
1039 FieldOffset += FieldSize;
1045 llvm::DIType *CGDebugInfo::CreateType(const BlockPointerType *Ty,
1046 llvm::DIFile *Unit) {
1047 SmallVector<llvm::Metadata *, 8> EltTys;
1049 uint64_t FieldOffset;
1050 llvm::DINodeArray Elements;
1053 FType = CGM.getContext().UnsignedLongTy;
1054 EltTys.push_back(CreateMemberType(Unit, FType, "reserved", &FieldOffset));
1055 EltTys.push_back(CreateMemberType(Unit, FType, "Size", &FieldOffset));
1057 Elements = DBuilder.getOrCreateArray(EltTys);
1060 llvm::DINode::DIFlags Flags = llvm::DINode::FlagAppleBlock;
1063 DBuilder.createStructType(Unit, "__block_descriptor", nullptr, 0,
1064 FieldOffset, 0, Flags, nullptr, Elements);
1066 // Bit size, align and offset of the type.
1067 uint64_t Size = CGM.getContext().getTypeSize(Ty);
1069 auto *DescTy = DBuilder.createPointerType(EltTy, Size);
1071 FieldOffset = collectDefaultElementTypesForBlockPointer(Ty, Unit, DescTy,
1074 Elements = DBuilder.getOrCreateArray(EltTys);
1076 // The __block_literal_generic structs are marked with a special
1077 // DW_AT_APPLE_BLOCK attribute and are an implementation detail only
1078 // the debugger needs to know about. To allow type uniquing, emit
1079 // them without a name or a location.
1080 EltTy = DBuilder.createStructType(Unit, "", nullptr, 0, FieldOffset, 0,
1081 Flags, nullptr, Elements);
1083 return DBuilder.createPointerType(EltTy, Size);
1086 llvm::DIType *CGDebugInfo::CreateType(const TemplateSpecializationType *Ty,
1087 llvm::DIFile *Unit) {
1088 assert(Ty->isTypeAlias());
1089 llvm::DIType *Src = getOrCreateType(Ty->getAliasedType(), Unit);
1092 cast<TypeAliasTemplateDecl>(Ty->getTemplateName().getAsTemplateDecl())
1093 ->getTemplatedDecl();
1095 if (AliasDecl->hasAttr<NoDebugAttr>())
1098 SmallString<128> NS;
1099 llvm::raw_svector_ostream OS(NS);
1100 Ty->getTemplateName().print(OS, getPrintingPolicy(), /*qualified*/ false);
1101 printTemplateArgumentList(OS, Ty->template_arguments(), getPrintingPolicy());
1103 SourceLocation Loc = AliasDecl->getLocation();
1104 return DBuilder.createTypedef(Src, OS.str(), getOrCreateFile(Loc),
1106 getDeclContextDescriptor(AliasDecl));
1109 llvm::DIType *CGDebugInfo::CreateType(const TypedefType *Ty,
1110 llvm::DIFile *Unit) {
1111 llvm::DIType *Underlying =
1112 getOrCreateType(Ty->getDecl()->getUnderlyingType(), Unit);
1114 if (Ty->getDecl()->hasAttr<NoDebugAttr>())
1117 // We don't set size information, but do specify where the typedef was
1119 SourceLocation Loc = Ty->getDecl()->getLocation();
1121 // Typedefs are derived from some other type.
1122 return DBuilder.createTypedef(Underlying, Ty->getDecl()->getName(),
1123 getOrCreateFile(Loc), getLineNumber(Loc),
1124 getDeclContextDescriptor(Ty->getDecl()));
1127 static unsigned getDwarfCC(CallingConv CC) {
1130 // Avoid emitting DW_AT_calling_convention if the C convention was used.
1134 return llvm::dwarf::DW_CC_BORLAND_stdcall;
1135 case CC_X86FastCall:
1136 return llvm::dwarf::DW_CC_BORLAND_msfastcall;
1137 case CC_X86ThisCall:
1138 return llvm::dwarf::DW_CC_BORLAND_thiscall;
1139 case CC_X86VectorCall:
1140 return llvm::dwarf::DW_CC_LLVM_vectorcall;
1142 return llvm::dwarf::DW_CC_BORLAND_pascal;
1144 return llvm::dwarf::DW_CC_LLVM_Win64;
1146 return llvm::dwarf::DW_CC_LLVM_X86_64SysV;
1148 case CC_AArch64VectorCall:
1149 return llvm::dwarf::DW_CC_LLVM_AAPCS;
1151 return llvm::dwarf::DW_CC_LLVM_AAPCS_VFP;
1152 case CC_IntelOclBicc:
1153 return llvm::dwarf::DW_CC_LLVM_IntelOclBicc;
1154 case CC_SpirFunction:
1155 return llvm::dwarf::DW_CC_LLVM_SpirFunction;
1156 case CC_OpenCLKernel:
1157 return llvm::dwarf::DW_CC_LLVM_OpenCLKernel;
1159 return llvm::dwarf::DW_CC_LLVM_Swift;
1160 case CC_PreserveMost:
1161 return llvm::dwarf::DW_CC_LLVM_PreserveMost;
1162 case CC_PreserveAll:
1163 return llvm::dwarf::DW_CC_LLVM_PreserveAll;
1165 return llvm::dwarf::DW_CC_LLVM_X86RegCall;
1170 llvm::DIType *CGDebugInfo::CreateType(const FunctionType *Ty,
1171 llvm::DIFile *Unit) {
1172 SmallVector<llvm::Metadata *, 16> EltTys;
1174 // Add the result type at least.
1175 EltTys.push_back(getOrCreateType(Ty->getReturnType(), Unit));
1177 // Set up remainder of arguments if there is a prototype.
1178 // otherwise emit it as a variadic function.
1179 if (isa<FunctionNoProtoType>(Ty))
1180 EltTys.push_back(DBuilder.createUnspecifiedParameter());
1181 else if (const auto *FPT = dyn_cast<FunctionProtoType>(Ty)) {
1182 for (const QualType &ParamType : FPT->param_types())
1183 EltTys.push_back(getOrCreateType(ParamType, Unit));
1184 if (FPT->isVariadic())
1185 EltTys.push_back(DBuilder.createUnspecifiedParameter());
1188 llvm::DITypeRefArray EltTypeArray = DBuilder.getOrCreateTypeArray(EltTys);
1189 return DBuilder.createSubroutineType(EltTypeArray, llvm::DINode::FlagZero,
1190 getDwarfCC(Ty->getCallConv()));
1193 /// Convert an AccessSpecifier into the corresponding DINode flag.
1194 /// As an optimization, return 0 if the access specifier equals the
1195 /// default for the containing type.
1196 static llvm::DINode::DIFlags getAccessFlag(AccessSpecifier Access,
1197 const RecordDecl *RD) {
1198 AccessSpecifier Default = clang::AS_none;
1199 if (RD && RD->isClass())
1200 Default = clang::AS_private;
1201 else if (RD && (RD->isStruct() || RD->isUnion()))
1202 Default = clang::AS_public;
1204 if (Access == Default)
1205 return llvm::DINode::FlagZero;
1208 case clang::AS_private:
1209 return llvm::DINode::FlagPrivate;
1210 case clang::AS_protected:
1211 return llvm::DINode::FlagProtected;
1212 case clang::AS_public:
1213 return llvm::DINode::FlagPublic;
1214 case clang::AS_none:
1215 return llvm::DINode::FlagZero;
1217 llvm_unreachable("unexpected access enumerator");
1220 llvm::DIType *CGDebugInfo::createBitFieldType(const FieldDecl *BitFieldDecl,
1221 llvm::DIScope *RecordTy,
1222 const RecordDecl *RD) {
1223 StringRef Name = BitFieldDecl->getName();
1224 QualType Ty = BitFieldDecl->getType();
1225 SourceLocation Loc = BitFieldDecl->getLocation();
1226 llvm::DIFile *VUnit = getOrCreateFile(Loc);
1227 llvm::DIType *DebugType = getOrCreateType(Ty, VUnit);
1229 // Get the location for the field.
1230 llvm::DIFile *File = getOrCreateFile(Loc);
1231 unsigned Line = getLineNumber(Loc);
1233 const CGBitFieldInfo &BitFieldInfo =
1234 CGM.getTypes().getCGRecordLayout(RD).getBitFieldInfo(BitFieldDecl);
1235 uint64_t SizeInBits = BitFieldInfo.Size;
1236 assert(SizeInBits > 0 && "found named 0-width bitfield");
1237 uint64_t StorageOffsetInBits =
1238 CGM.getContext().toBits(BitFieldInfo.StorageOffset);
1239 uint64_t Offset = BitFieldInfo.Offset;
1240 // The bit offsets for big endian machines are reversed for big
1241 // endian target, compensate for that as the DIDerivedType requires
1242 // un-reversed offsets.
1243 if (CGM.getDataLayout().isBigEndian())
1244 Offset = BitFieldInfo.StorageSize - BitFieldInfo.Size - Offset;
1245 uint64_t OffsetInBits = StorageOffsetInBits + Offset;
1246 llvm::DINode::DIFlags Flags = getAccessFlag(BitFieldDecl->getAccess(), RD);
1247 return DBuilder.createBitFieldMemberType(
1248 RecordTy, Name, File, Line, SizeInBits, OffsetInBits, StorageOffsetInBits,
1253 CGDebugInfo::createFieldType(StringRef name, QualType type, SourceLocation loc,
1254 AccessSpecifier AS, uint64_t offsetInBits,
1255 uint32_t AlignInBits, llvm::DIFile *tunit,
1256 llvm::DIScope *scope, const RecordDecl *RD) {
1257 llvm::DIType *debugType = getOrCreateType(type, tunit);
1259 // Get the location for the field.
1260 llvm::DIFile *file = getOrCreateFile(loc);
1261 unsigned line = getLineNumber(loc);
1263 uint64_t SizeInBits = 0;
1264 auto Align = AlignInBits;
1265 if (!type->isIncompleteArrayType()) {
1266 TypeInfo TI = CGM.getContext().getTypeInfo(type);
1267 SizeInBits = TI.Width;
1269 Align = getTypeAlignIfRequired(type, CGM.getContext());
1272 llvm::DINode::DIFlags flags = getAccessFlag(AS, RD);
1273 return DBuilder.createMemberType(scope, name, file, line, SizeInBits, Align,
1274 offsetInBits, flags, debugType);
1277 void CGDebugInfo::CollectRecordLambdaFields(
1278 const CXXRecordDecl *CXXDecl, SmallVectorImpl<llvm::Metadata *> &elements,
1279 llvm::DIType *RecordTy) {
1280 // For C++11 Lambdas a Field will be the same as a Capture, but the Capture
1281 // has the name and the location of the variable so we should iterate over
1282 // both concurrently.
1283 const ASTRecordLayout &layout = CGM.getContext().getASTRecordLayout(CXXDecl);
1284 RecordDecl::field_iterator Field = CXXDecl->field_begin();
1285 unsigned fieldno = 0;
1286 for (CXXRecordDecl::capture_const_iterator I = CXXDecl->captures_begin(),
1287 E = CXXDecl->captures_end();
1288 I != E; ++I, ++Field, ++fieldno) {
1289 const LambdaCapture &C = *I;
1290 if (C.capturesVariable()) {
1291 SourceLocation Loc = C.getLocation();
1292 assert(!Field->isBitField() && "lambdas don't have bitfield members!");
1293 VarDecl *V = C.getCapturedVar();
1294 StringRef VName = V->getName();
1295 llvm::DIFile *VUnit = getOrCreateFile(Loc);
1296 auto Align = getDeclAlignIfRequired(V, CGM.getContext());
1297 llvm::DIType *FieldType = createFieldType(
1298 VName, Field->getType(), Loc, Field->getAccess(),
1299 layout.getFieldOffset(fieldno), Align, VUnit, RecordTy, CXXDecl);
1300 elements.push_back(FieldType);
1301 } else if (C.capturesThis()) {
1302 // TODO: Need to handle 'this' in some way by probably renaming the
1303 // this of the lambda class and having a field member of 'this' or
1304 // by using AT_object_pointer for the function and having that be
1305 // used as 'this' for semantic references.
1306 FieldDecl *f = *Field;
1307 llvm::DIFile *VUnit = getOrCreateFile(f->getLocation());
1308 QualType type = f->getType();
1309 llvm::DIType *fieldType = createFieldType(
1310 "this", type, f->getLocation(), f->getAccess(),
1311 layout.getFieldOffset(fieldno), VUnit, RecordTy, CXXDecl);
1313 elements.push_back(fieldType);
1318 llvm::DIDerivedType *
1319 CGDebugInfo::CreateRecordStaticField(const VarDecl *Var, llvm::DIType *RecordTy,
1320 const RecordDecl *RD) {
1321 // Create the descriptor for the static variable, with or without
1322 // constant initializers.
1323 Var = Var->getCanonicalDecl();
1324 llvm::DIFile *VUnit = getOrCreateFile(Var->getLocation());
1325 llvm::DIType *VTy = getOrCreateType(Var->getType(), VUnit);
1327 unsigned LineNumber = getLineNumber(Var->getLocation());
1328 StringRef VName = Var->getName();
1329 llvm::Constant *C = nullptr;
1330 if (Var->getInit()) {
1331 const APValue *Value = Var->evaluateValue();
1334 C = llvm::ConstantInt::get(CGM.getLLVMContext(), Value->getInt());
1335 if (Value->isFloat())
1336 C = llvm::ConstantFP::get(CGM.getLLVMContext(), Value->getFloat());
1340 llvm::DINode::DIFlags Flags = getAccessFlag(Var->getAccess(), RD);
1341 auto Align = getDeclAlignIfRequired(Var, CGM.getContext());
1342 llvm::DIDerivedType *GV = DBuilder.createStaticMemberType(
1343 RecordTy, VName, VUnit, LineNumber, VTy, Flags, C, Align);
1344 StaticDataMemberCache[Var->getCanonicalDecl()].reset(GV);
1348 void CGDebugInfo::CollectRecordNormalField(
1349 const FieldDecl *field, uint64_t OffsetInBits, llvm::DIFile *tunit,
1350 SmallVectorImpl<llvm::Metadata *> &elements, llvm::DIType *RecordTy,
1351 const RecordDecl *RD) {
1352 StringRef name = field->getName();
1353 QualType type = field->getType();
1355 // Ignore unnamed fields unless they're anonymous structs/unions.
1356 if (name.empty() && !type->isRecordType())
1359 llvm::DIType *FieldType;
1360 if (field->isBitField()) {
1361 FieldType = createBitFieldType(field, RecordTy, RD);
1363 auto Align = getDeclAlignIfRequired(field, CGM.getContext());
1365 createFieldType(name, type, field->getLocation(), field->getAccess(),
1366 OffsetInBits, Align, tunit, RecordTy, RD);
1369 elements.push_back(FieldType);
1372 void CGDebugInfo::CollectRecordNestedType(
1373 const TypeDecl *TD, SmallVectorImpl<llvm::Metadata *> &elements) {
1374 QualType Ty = CGM.getContext().getTypeDeclType(TD);
1375 // Injected class names are not considered nested records.
1376 if (isa<InjectedClassNameType>(Ty))
1378 SourceLocation Loc = TD->getLocation();
1379 llvm::DIType *nestedType = getOrCreateType(Ty, getOrCreateFile(Loc));
1380 elements.push_back(nestedType);
1383 void CGDebugInfo::CollectRecordFields(
1384 const RecordDecl *record, llvm::DIFile *tunit,
1385 SmallVectorImpl<llvm::Metadata *> &elements,
1386 llvm::DICompositeType *RecordTy) {
1387 const auto *CXXDecl = dyn_cast<CXXRecordDecl>(record);
1389 if (CXXDecl && CXXDecl->isLambda())
1390 CollectRecordLambdaFields(CXXDecl, elements, RecordTy);
1392 const ASTRecordLayout &layout = CGM.getContext().getASTRecordLayout(record);
1394 // Field number for non-static fields.
1395 unsigned fieldNo = 0;
1397 // Static and non-static members should appear in the same order as
1398 // the corresponding declarations in the source program.
1399 for (const auto *I : record->decls())
1400 if (const auto *V = dyn_cast<VarDecl>(I)) {
1401 if (V->hasAttr<NoDebugAttr>())
1404 // Skip variable template specializations when emitting CodeView. MSVC
1405 // doesn't emit them.
1406 if (CGM.getCodeGenOpts().EmitCodeView &&
1407 isa<VarTemplateSpecializationDecl>(V))
1410 if (isa<VarTemplatePartialSpecializationDecl>(V))
1413 // Reuse the existing static member declaration if one exists
1414 auto MI = StaticDataMemberCache.find(V->getCanonicalDecl());
1415 if (MI != StaticDataMemberCache.end()) {
1416 assert(MI->second &&
1417 "Static data member declaration should still exist");
1418 elements.push_back(MI->second);
1420 auto Field = CreateRecordStaticField(V, RecordTy, record);
1421 elements.push_back(Field);
1423 } else if (const auto *field = dyn_cast<FieldDecl>(I)) {
1424 CollectRecordNormalField(field, layout.getFieldOffset(fieldNo), tunit,
1425 elements, RecordTy, record);
1427 // Bump field number for next field.
1429 } else if (CGM.getCodeGenOpts().EmitCodeView) {
1430 // Debug info for nested types is included in the member list only for
1432 if (const auto *nestedType = dyn_cast<TypeDecl>(I))
1433 if (!nestedType->isImplicit() &&
1434 nestedType->getDeclContext() == record)
1435 CollectRecordNestedType(nestedType, elements);
1440 llvm::DISubroutineType *
1441 CGDebugInfo::getOrCreateMethodType(const CXXMethodDecl *Method,
1442 llvm::DIFile *Unit) {
1443 const FunctionProtoType *Func = Method->getType()->getAs<FunctionProtoType>();
1444 if (Method->isStatic())
1445 return cast_or_null<llvm::DISubroutineType>(
1446 getOrCreateType(QualType(Func, 0), Unit));
1447 return getOrCreateInstanceMethodType(Method->getThisType(), Func, Unit);
1450 llvm::DISubroutineType *CGDebugInfo::getOrCreateInstanceMethodType(
1451 QualType ThisPtr, const FunctionProtoType *Func, llvm::DIFile *Unit) {
1452 // Add "this" pointer.
1453 llvm::DITypeRefArray Args(
1454 cast<llvm::DISubroutineType>(getOrCreateType(QualType(Func, 0), Unit))
1456 assert(Args.size() && "Invalid number of arguments!");
1458 SmallVector<llvm::Metadata *, 16> Elts;
1460 // First element is always return type. For 'void' functions it is NULL.
1461 Elts.push_back(Args[0]);
1463 // "this" pointer is always first argument.
1464 const CXXRecordDecl *RD = ThisPtr->getPointeeCXXRecordDecl();
1465 if (isa<ClassTemplateSpecializationDecl>(RD)) {
1466 // Create pointer type directly in this case.
1467 const PointerType *ThisPtrTy = cast<PointerType>(ThisPtr);
1468 QualType PointeeTy = ThisPtrTy->getPointeeType();
1469 unsigned AS = CGM.getContext().getTargetAddressSpace(PointeeTy);
1470 uint64_t Size = CGM.getTarget().getPointerWidth(AS);
1471 auto Align = getTypeAlignIfRequired(ThisPtrTy, CGM.getContext());
1472 llvm::DIType *PointeeType = getOrCreateType(PointeeTy, Unit);
1473 llvm::DIType *ThisPtrType =
1474 DBuilder.createPointerType(PointeeType, Size, Align);
1475 TypeCache[ThisPtr.getAsOpaquePtr()].reset(ThisPtrType);
1476 // TODO: This and the artificial type below are misleading, the
1477 // types aren't artificial the argument is, but the current
1478 // metadata doesn't represent that.
1479 ThisPtrType = DBuilder.createObjectPointerType(ThisPtrType);
1480 Elts.push_back(ThisPtrType);
1482 llvm::DIType *ThisPtrType = getOrCreateType(ThisPtr, Unit);
1483 TypeCache[ThisPtr.getAsOpaquePtr()].reset(ThisPtrType);
1484 ThisPtrType = DBuilder.createObjectPointerType(ThisPtrType);
1485 Elts.push_back(ThisPtrType);
1488 // Copy rest of the arguments.
1489 for (unsigned i = 1, e = Args.size(); i != e; ++i)
1490 Elts.push_back(Args[i]);
1492 llvm::DITypeRefArray EltTypeArray = DBuilder.getOrCreateTypeArray(Elts);
1494 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
1495 if (Func->getExtProtoInfo().RefQualifier == RQ_LValue)
1496 Flags |= llvm::DINode::FlagLValueReference;
1497 if (Func->getExtProtoInfo().RefQualifier == RQ_RValue)
1498 Flags |= llvm::DINode::FlagRValueReference;
1500 return DBuilder.createSubroutineType(EltTypeArray, Flags,
1501 getDwarfCC(Func->getCallConv()));
1504 /// isFunctionLocalClass - Return true if CXXRecordDecl is defined
1505 /// inside a function.
1506 static bool isFunctionLocalClass(const CXXRecordDecl *RD) {
1507 if (const auto *NRD = dyn_cast<CXXRecordDecl>(RD->getDeclContext()))
1508 return isFunctionLocalClass(NRD);
1509 if (isa<FunctionDecl>(RD->getDeclContext()))
1514 llvm::DISubprogram *CGDebugInfo::CreateCXXMemberFunction(
1515 const CXXMethodDecl *Method, llvm::DIFile *Unit, llvm::DIType *RecordTy) {
1517 isa<CXXConstructorDecl>(Method) || isa<CXXDestructorDecl>(Method);
1519 StringRef MethodName = getFunctionName(Method);
1520 llvm::DISubroutineType *MethodTy = getOrCreateMethodType(Method, Unit);
1522 // Since a single ctor/dtor corresponds to multiple functions, it doesn't
1523 // make sense to give a single ctor/dtor a linkage name.
1524 StringRef MethodLinkageName;
1525 // FIXME: 'isFunctionLocalClass' seems like an arbitrary/unintentional
1526 // property to use here. It may've been intended to model "is non-external
1527 // type" but misses cases of non-function-local but non-external classes such
1528 // as those in anonymous namespaces as well as the reverse - external types
1529 // that are function local, such as those in (non-local) inline functions.
1530 if (!IsCtorOrDtor && !isFunctionLocalClass(Method->getParent()))
1531 MethodLinkageName = CGM.getMangledName(Method);
1533 // Get the location for the method.
1534 llvm::DIFile *MethodDefUnit = nullptr;
1535 unsigned MethodLine = 0;
1536 if (!Method->isImplicit()) {
1537 MethodDefUnit = getOrCreateFile(Method->getLocation());
1538 MethodLine = getLineNumber(Method->getLocation());
1541 // Collect virtual method info.
1542 llvm::DIType *ContainingType = nullptr;
1543 unsigned VIndex = 0;
1544 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
1545 llvm::DISubprogram::DISPFlags SPFlags = llvm::DISubprogram::SPFlagZero;
1546 int ThisAdjustment = 0;
1548 if (Method->isVirtual()) {
1549 if (Method->isPure())
1550 SPFlags |= llvm::DISubprogram::SPFlagPureVirtual;
1552 SPFlags |= llvm::DISubprogram::SPFlagVirtual;
1554 if (CGM.getTarget().getCXXABI().isItaniumFamily()) {
1555 // It doesn't make sense to give a virtual destructor a vtable index,
1556 // since a single destructor has two entries in the vtable.
1557 if (!isa<CXXDestructorDecl>(Method))
1558 VIndex = CGM.getItaniumVTableContext().getMethodVTableIndex(Method);
1560 // Emit MS ABI vftable information. There is only one entry for the
1562 const auto *DD = dyn_cast<CXXDestructorDecl>(Method);
1563 GlobalDecl GD = DD ? GlobalDecl(DD, Dtor_Deleting) : GlobalDecl(Method);
1564 MethodVFTableLocation ML =
1565 CGM.getMicrosoftVTableContext().getMethodVFTableLocation(GD);
1568 // CodeView only records the vftable offset in the class that introduces
1569 // the virtual method. This is possible because, unlike Itanium, the MS
1570 // C++ ABI does not include all virtual methods from non-primary bases in
1571 // the vtable for the most derived class. For example, if C inherits from
1572 // A and B, C's primary vftable will not include B's virtual methods.
1573 if (Method->size_overridden_methods() == 0)
1574 Flags |= llvm::DINode::FlagIntroducedVirtual;
1576 // The 'this' adjustment accounts for both the virtual and non-virtual
1577 // portions of the adjustment. Presumably the debugger only uses it when
1578 // it knows the dynamic type of an object.
1579 ThisAdjustment = CGM.getCXXABI()
1580 .getVirtualFunctionPrologueThisAdjustment(GD)
1583 ContainingType = RecordTy;
1586 if (Method->isStatic())
1587 Flags |= llvm::DINode::FlagStaticMember;
1588 if (Method->isImplicit())
1589 Flags |= llvm::DINode::FlagArtificial;
1590 Flags |= getAccessFlag(Method->getAccess(), Method->getParent());
1591 if (const auto *CXXC = dyn_cast<CXXConstructorDecl>(Method)) {
1592 if (CXXC->isExplicit())
1593 Flags |= llvm::DINode::FlagExplicit;
1594 } else if (const auto *CXXC = dyn_cast<CXXConversionDecl>(Method)) {
1595 if (CXXC->isExplicit())
1596 Flags |= llvm::DINode::FlagExplicit;
1598 if (Method->hasPrototype())
1599 Flags |= llvm::DINode::FlagPrototyped;
1600 if (Method->getRefQualifier() == RQ_LValue)
1601 Flags |= llvm::DINode::FlagLValueReference;
1602 if (Method->getRefQualifier() == RQ_RValue)
1603 Flags |= llvm::DINode::FlagRValueReference;
1604 if (CGM.getLangOpts().Optimize)
1605 SPFlags |= llvm::DISubprogram::SPFlagOptimized;
1607 llvm::DINodeArray TParamsArray = CollectFunctionTemplateParams(Method, Unit);
1608 llvm::DISubprogram *SP = DBuilder.createMethod(
1609 RecordTy, MethodName, MethodLinkageName, MethodDefUnit, MethodLine,
1610 MethodTy, VIndex, ThisAdjustment, ContainingType, Flags, SPFlags,
1611 TParamsArray.get());
1613 SPCache[Method->getCanonicalDecl()].reset(SP);
1618 void CGDebugInfo::CollectCXXMemberFunctions(
1619 const CXXRecordDecl *RD, llvm::DIFile *Unit,
1620 SmallVectorImpl<llvm::Metadata *> &EltTys, llvm::DIType *RecordTy) {
1622 // Since we want more than just the individual member decls if we
1623 // have templated functions iterate over every declaration to gather
1625 for (const auto *I : RD->decls()) {
1626 const auto *Method = dyn_cast<CXXMethodDecl>(I);
1627 // If the member is implicit, don't add it to the member list. This avoids
1628 // the member being added to type units by LLVM, while still allowing it
1629 // to be emitted into the type declaration/reference inside the compile
1631 // Ditto 'nodebug' methods, for consistency with CodeGenFunction.cpp.
1632 // FIXME: Handle Using(Shadow?)Decls here to create
1633 // DW_TAG_imported_declarations inside the class for base decls brought into
1634 // derived classes. GDB doesn't seem to notice/leverage these when I tried
1635 // it, so I'm not rushing to fix this. (GCC seems to produce them, if
1637 if (!Method || Method->isImplicit() || Method->hasAttr<NoDebugAttr>())
1640 if (Method->getType()->getAs<FunctionProtoType>()->getContainedAutoType())
1643 // Reuse the existing member function declaration if it exists.
1644 // It may be associated with the declaration of the type & should be
1645 // reused as we're building the definition.
1647 // This situation can arise in the vtable-based debug info reduction where
1648 // implicit members are emitted in a non-vtable TU.
1649 auto MI = SPCache.find(Method->getCanonicalDecl());
1650 EltTys.push_back(MI == SPCache.end()
1651 ? CreateCXXMemberFunction(Method, Unit, RecordTy)
1652 : static_cast<llvm::Metadata *>(MI->second));
1656 void CGDebugInfo::CollectCXXBases(const CXXRecordDecl *RD, llvm::DIFile *Unit,
1657 SmallVectorImpl<llvm::Metadata *> &EltTys,
1658 llvm::DIType *RecordTy) {
1659 llvm::DenseSet<CanonicalDeclPtr<const CXXRecordDecl>> SeenTypes;
1660 CollectCXXBasesAux(RD, Unit, EltTys, RecordTy, RD->bases(), SeenTypes,
1661 llvm::DINode::FlagZero);
1663 // If we are generating CodeView debug info, we also need to emit records for
1664 // indirect virtual base classes.
1665 if (CGM.getCodeGenOpts().EmitCodeView) {
1666 CollectCXXBasesAux(RD, Unit, EltTys, RecordTy, RD->vbases(), SeenTypes,
1667 llvm::DINode::FlagIndirectVirtualBase);
1671 void CGDebugInfo::CollectCXXBasesAux(
1672 const CXXRecordDecl *RD, llvm::DIFile *Unit,
1673 SmallVectorImpl<llvm::Metadata *> &EltTys, llvm::DIType *RecordTy,
1674 const CXXRecordDecl::base_class_const_range &Bases,
1675 llvm::DenseSet<CanonicalDeclPtr<const CXXRecordDecl>> &SeenTypes,
1676 llvm::DINode::DIFlags StartingFlags) {
1677 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
1678 for (const auto &BI : Bases) {
1680 cast<CXXRecordDecl>(BI.getType()->getAs<RecordType>()->getDecl());
1681 if (!SeenTypes.insert(Base).second)
1683 auto *BaseTy = getOrCreateType(BI.getType(), Unit);
1684 llvm::DINode::DIFlags BFlags = StartingFlags;
1685 uint64_t BaseOffset;
1686 uint32_t VBPtrOffset = 0;
1688 if (BI.isVirtual()) {
1689 if (CGM.getTarget().getCXXABI().isItaniumFamily()) {
1690 // virtual base offset offset is -ve. The code generator emits dwarf
1691 // expression where it expects +ve number.
1692 BaseOffset = 0 - CGM.getItaniumVTableContext()
1693 .getVirtualBaseOffsetOffset(RD, Base)
1696 // In the MS ABI, store the vbtable offset, which is analogous to the
1697 // vbase offset offset in Itanium.
1699 4 * CGM.getMicrosoftVTableContext().getVBTableIndex(RD, Base);
1700 VBPtrOffset = CGM.getContext()
1701 .getASTRecordLayout(RD)
1705 BFlags |= llvm::DINode::FlagVirtual;
1707 BaseOffset = CGM.getContext().toBits(RL.getBaseClassOffset(Base));
1708 // FIXME: Inconsistent units for BaseOffset. It is in bytes when
1709 // BI->isVirtual() and bits when not.
1711 BFlags |= getAccessFlag(BI.getAccessSpecifier(), RD);
1712 llvm::DIType *DTy = DBuilder.createInheritance(RecordTy, BaseTy, BaseOffset,
1713 VBPtrOffset, BFlags);
1714 EltTys.push_back(DTy);
1719 CGDebugInfo::CollectTemplateParams(const TemplateParameterList *TPList,
1720 ArrayRef<TemplateArgument> TAList,
1721 llvm::DIFile *Unit) {
1722 SmallVector<llvm::Metadata *, 16> TemplateParams;
1723 for (unsigned i = 0, e = TAList.size(); i != e; ++i) {
1724 const TemplateArgument &TA = TAList[i];
1727 Name = TPList->getParam(i)->getName();
1728 switch (TA.getKind()) {
1729 case TemplateArgument::Type: {
1730 llvm::DIType *TTy = getOrCreateType(TA.getAsType(), Unit);
1731 TemplateParams.push_back(
1732 DBuilder.createTemplateTypeParameter(TheCU, Name, TTy));
1734 case TemplateArgument::Integral: {
1735 llvm::DIType *TTy = getOrCreateType(TA.getIntegralType(), Unit);
1736 TemplateParams.push_back(DBuilder.createTemplateValueParameter(
1738 llvm::ConstantInt::get(CGM.getLLVMContext(), TA.getAsIntegral())));
1740 case TemplateArgument::Declaration: {
1741 const ValueDecl *D = TA.getAsDecl();
1742 QualType T = TA.getParamTypeForDecl().getDesugaredType(CGM.getContext());
1743 llvm::DIType *TTy = getOrCreateType(T, Unit);
1744 llvm::Constant *V = nullptr;
1745 // Skip retrieve the value if that template parameter has cuda device
1746 // attribute, i.e. that value is not available at the host side.
1747 if (!CGM.getLangOpts().CUDA || CGM.getLangOpts().CUDAIsDevice ||
1748 !D->hasAttr<CUDADeviceAttr>()) {
1749 const CXXMethodDecl *MD;
1750 // Variable pointer template parameters have a value that is the address
1752 if (const auto *VD = dyn_cast<VarDecl>(D))
1753 V = CGM.GetAddrOfGlobalVar(VD);
1754 // Member function pointers have special support for building them,
1755 // though this is currently unsupported in LLVM CodeGen.
1756 else if ((MD = dyn_cast<CXXMethodDecl>(D)) && MD->isInstance())
1757 V = CGM.getCXXABI().EmitMemberFunctionPointer(MD);
1758 else if (const auto *FD = dyn_cast<FunctionDecl>(D))
1759 V = CGM.GetAddrOfFunction(FD);
1760 // Member data pointers have special handling too to compute the fixed
1761 // offset within the object.
1762 else if (const auto *MPT =
1763 dyn_cast<MemberPointerType>(T.getTypePtr())) {
1764 // These five lines (& possibly the above member function pointer
1765 // handling) might be able to be refactored to use similar code in
1766 // CodeGenModule::getMemberPointerConstant
1767 uint64_t fieldOffset = CGM.getContext().getFieldOffset(D);
1769 CGM.getContext().toCharUnitsFromBits((int64_t)fieldOffset);
1770 V = CGM.getCXXABI().EmitMemberDataPointer(MPT, chars);
1772 V = V->stripPointerCasts();
1774 TemplateParams.push_back(DBuilder.createTemplateValueParameter(
1775 TheCU, Name, TTy, cast_or_null<llvm::Constant>(V)));
1777 case TemplateArgument::NullPtr: {
1778 QualType T = TA.getNullPtrType();
1779 llvm::DIType *TTy = getOrCreateType(T, Unit);
1780 llvm::Constant *V = nullptr;
1781 // Special case member data pointer null values since they're actually -1
1783 if (const auto *MPT = dyn_cast<MemberPointerType>(T.getTypePtr()))
1784 // But treat member function pointers as simple zero integers because
1785 // it's easier than having a special case in LLVM's CodeGen. If LLVM
1786 // CodeGen grows handling for values of non-null member function
1787 // pointers then perhaps we could remove this special case and rely on
1788 // EmitNullMemberPointer for member function pointers.
1789 if (MPT->isMemberDataPointer())
1790 V = CGM.getCXXABI().EmitNullMemberPointer(MPT);
1792 V = llvm::ConstantInt::get(CGM.Int8Ty, 0);
1793 TemplateParams.push_back(
1794 DBuilder.createTemplateValueParameter(TheCU, Name, TTy, V));
1796 case TemplateArgument::Template:
1797 TemplateParams.push_back(DBuilder.createTemplateTemplateParameter(
1798 TheCU, Name, nullptr,
1799 TA.getAsTemplate().getAsTemplateDecl()->getQualifiedNameAsString()));
1801 case TemplateArgument::Pack:
1802 TemplateParams.push_back(DBuilder.createTemplateParameterPack(
1803 TheCU, Name, nullptr,
1804 CollectTemplateParams(nullptr, TA.getPackAsArray(), Unit)));
1806 case TemplateArgument::Expression: {
1807 const Expr *E = TA.getAsExpr();
1808 QualType T = E->getType();
1810 T = CGM.getContext().getLValueReferenceType(T);
1811 llvm::Constant *V = ConstantEmitter(CGM).emitAbstract(E, T);
1812 assert(V && "Expression in template argument isn't constant");
1813 llvm::DIType *TTy = getOrCreateType(T, Unit);
1814 TemplateParams.push_back(DBuilder.createTemplateValueParameter(
1815 TheCU, Name, TTy, V->stripPointerCasts()));
1817 // And the following should never occur:
1818 case TemplateArgument::TemplateExpansion:
1819 case TemplateArgument::Null:
1821 "These argument types shouldn't exist in concrete types");
1824 return DBuilder.getOrCreateArray(TemplateParams);
1828 CGDebugInfo::CollectFunctionTemplateParams(const FunctionDecl *FD,
1829 llvm::DIFile *Unit) {
1830 if (FD->getTemplatedKind() ==
1831 FunctionDecl::TK_FunctionTemplateSpecialization) {
1832 const TemplateParameterList *TList = FD->getTemplateSpecializationInfo()
1834 ->getTemplateParameters();
1835 return CollectTemplateParams(
1836 TList, FD->getTemplateSpecializationArgs()->asArray(), Unit);
1838 return llvm::DINodeArray();
1841 llvm::DINodeArray CGDebugInfo::CollectVarTemplateParams(const VarDecl *VL,
1842 llvm::DIFile *Unit) {
1843 // Always get the full list of parameters, not just the ones from the
1844 // specialization. A partial specialization may have fewer parameters than
1845 // there are arguments.
1846 auto *TS = dyn_cast<VarTemplateSpecializationDecl>(VL);
1848 return llvm::DINodeArray();
1849 VarTemplateDecl *T = TS->getSpecializedTemplate();
1850 const TemplateParameterList *TList = T->getTemplateParameters();
1851 auto TA = TS->getTemplateArgs().asArray();
1852 return CollectTemplateParams(TList, TA, Unit);
1855 llvm::DINodeArray CGDebugInfo::CollectCXXTemplateParams(
1856 const ClassTemplateSpecializationDecl *TSpecial, llvm::DIFile *Unit) {
1857 // Always get the full list of parameters, not just the ones from the
1858 // specialization. A partial specialization may have fewer parameters than
1859 // there are arguments.
1860 TemplateParameterList *TPList =
1861 TSpecial->getSpecializedTemplate()->getTemplateParameters();
1862 const TemplateArgumentList &TAList = TSpecial->getTemplateArgs();
1863 return CollectTemplateParams(TPList, TAList.asArray(), Unit);
1866 llvm::DIType *CGDebugInfo::getOrCreateVTablePtrType(llvm::DIFile *Unit) {
1868 return VTablePtrType;
1870 ASTContext &Context = CGM.getContext();
1873 llvm::Metadata *STy = getOrCreateType(Context.IntTy, Unit);
1874 llvm::DITypeRefArray SElements = DBuilder.getOrCreateTypeArray(STy);
1875 llvm::DIType *SubTy = DBuilder.createSubroutineType(SElements);
1876 unsigned Size = Context.getTypeSize(Context.VoidPtrTy);
1877 unsigned VtblPtrAddressSpace = CGM.getTarget().getVtblPtrAddressSpace();
1878 Optional<unsigned> DWARFAddressSpace =
1879 CGM.getTarget().getDWARFAddressSpace(VtblPtrAddressSpace);
1881 llvm::DIType *vtbl_ptr_type = DBuilder.createPointerType(
1882 SubTy, Size, 0, DWARFAddressSpace, "__vtbl_ptr_type");
1883 VTablePtrType = DBuilder.createPointerType(vtbl_ptr_type, Size);
1884 return VTablePtrType;
1887 StringRef CGDebugInfo::getVTableName(const CXXRecordDecl *RD) {
1888 // Copy the gdb compatible name on the side and use its reference.
1889 return internString("_vptr$", RD->getNameAsString());
1892 StringRef CGDebugInfo::getDynamicInitializerName(const VarDecl *VD,
1893 DynamicInitKind StubKind,
1894 llvm::Function *InitFn) {
1895 // If we're not emitting codeview, use the mangled name. For Itanium, this is
1897 if (!CGM.getCodeGenOpts().EmitCodeView)
1898 return InitFn->getName();
1900 // Print the normal qualified name for the variable, then break off the last
1901 // NNS, and add the appropriate other text. Clang always prints the global
1902 // variable name without template arguments, so we can use rsplit("::") and
1903 // then recombine the pieces.
1904 SmallString<128> QualifiedGV;
1908 llvm::raw_svector_ostream OS(QualifiedGV);
1909 VD->printQualifiedName(OS, getPrintingPolicy());
1910 std::tie(Quals, GVName) = OS.str().rsplit("::");
1912 std::swap(Quals, GVName);
1915 SmallString<128> InitName;
1916 llvm::raw_svector_ostream OS(InitName);
1918 OS << Quals << "::";
1921 case DynamicInitKind::NoStub:
1922 llvm_unreachable("not an initializer");
1923 case DynamicInitKind::Initializer:
1924 OS << "`dynamic initializer for '";
1926 case DynamicInitKind::AtExit:
1927 OS << "`dynamic atexit destructor for '";
1933 // Add any template specialization args.
1934 if (const auto *VTpl = dyn_cast<VarTemplateSpecializationDecl>(VD)) {
1935 printTemplateArgumentList(OS, VTpl->getTemplateArgs().asArray(),
1936 getPrintingPolicy());
1941 return internString(OS.str());
1944 void CGDebugInfo::CollectVTableInfo(const CXXRecordDecl *RD, llvm::DIFile *Unit,
1945 SmallVectorImpl<llvm::Metadata *> &EltTys,
1946 llvm::DICompositeType *RecordTy) {
1947 // If this class is not dynamic then there is not any vtable info to collect.
1948 if (!RD->isDynamicClass())
1951 // Don't emit any vtable shape or vptr info if this class doesn't have an
1952 // extendable vfptr. This can happen if the class doesn't have virtual
1953 // methods, or in the MS ABI if those virtual methods only come from virtually
1955 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
1956 if (!RL.hasExtendableVFPtr())
1959 // CodeView needs to know how large the vtable of every dynamic class is, so
1960 // emit a special named pointer type into the element list. The vptr type
1961 // points to this type as well.
1962 llvm::DIType *VPtrTy = nullptr;
1963 bool NeedVTableShape = CGM.getCodeGenOpts().EmitCodeView &&
1964 CGM.getTarget().getCXXABI().isMicrosoft();
1965 if (NeedVTableShape) {
1967 CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
1968 const VTableLayout &VFTLayout =
1969 CGM.getMicrosoftVTableContext().getVFTableLayout(RD, CharUnits::Zero());
1970 unsigned VSlotCount =
1971 VFTLayout.vtable_components().size() - CGM.getLangOpts().RTTIData;
1972 unsigned VTableWidth = PtrWidth * VSlotCount;
1973 unsigned VtblPtrAddressSpace = CGM.getTarget().getVtblPtrAddressSpace();
1974 Optional<unsigned> DWARFAddressSpace =
1975 CGM.getTarget().getDWARFAddressSpace(VtblPtrAddressSpace);
1977 // Create a very wide void* type and insert it directly in the element list.
1978 llvm::DIType *VTableType = DBuilder.createPointerType(
1979 nullptr, VTableWidth, 0, DWARFAddressSpace, "__vtbl_ptr_type");
1980 EltTys.push_back(VTableType);
1982 // The vptr is a pointer to this special vtable type.
1983 VPtrTy = DBuilder.createPointerType(VTableType, PtrWidth);
1986 // If there is a primary base then the artificial vptr member lives there.
1987 if (RL.getPrimaryBase())
1991 VPtrTy = getOrCreateVTablePtrType(Unit);
1993 unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
1994 llvm::DIType *VPtrMember =
1995 DBuilder.createMemberType(Unit, getVTableName(RD), Unit, 0, Size, 0, 0,
1996 llvm::DINode::FlagArtificial, VPtrTy);
1997 EltTys.push_back(VPtrMember);
2000 llvm::DIType *CGDebugInfo::getOrCreateRecordType(QualType RTy,
2001 SourceLocation Loc) {
2002 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
2003 llvm::DIType *T = getOrCreateType(RTy, getOrCreateFile(Loc));
2007 llvm::DIType *CGDebugInfo::getOrCreateInterfaceType(QualType D,
2008 SourceLocation Loc) {
2009 return getOrCreateStandaloneType(D, Loc);
2012 llvm::DIType *CGDebugInfo::getOrCreateStandaloneType(QualType D,
2013 SourceLocation Loc) {
2014 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
2015 assert(!D.isNull() && "null type");
2016 llvm::DIType *T = getOrCreateType(D, getOrCreateFile(Loc));
2017 assert(T && "could not create debug info for type");
2019 RetainedTypes.push_back(D.getAsOpaquePtr());
2023 void CGDebugInfo::addHeapAllocSiteMetadata(llvm::Instruction *CI,
2025 SourceLocation Loc) {
2027 if (D.getTypePtr()->isVoidPointerType()) {
2028 node = llvm::MDNode::get(CGM.getLLVMContext(), None);
2030 QualType PointeeTy = D.getTypePtr()->getPointeeType();
2031 node = getOrCreateType(PointeeTy, getOrCreateFile(Loc));
2034 CI->setMetadata("heapallocsite", node);
2037 void CGDebugInfo::completeType(const EnumDecl *ED) {
2038 if (DebugKind <= codegenoptions::DebugLineTablesOnly)
2040 QualType Ty = CGM.getContext().getEnumType(ED);
2041 void *TyPtr = Ty.getAsOpaquePtr();
2042 auto I = TypeCache.find(TyPtr);
2043 if (I == TypeCache.end() || !cast<llvm::DIType>(I->second)->isForwardDecl())
2045 llvm::DIType *Res = CreateTypeDefinition(Ty->castAs<EnumType>());
2046 assert(!Res->isForwardDecl());
2047 TypeCache[TyPtr].reset(Res);
2050 void CGDebugInfo::completeType(const RecordDecl *RD) {
2051 if (DebugKind > codegenoptions::LimitedDebugInfo ||
2052 !CGM.getLangOpts().CPlusPlus)
2053 completeRequiredType(RD);
2056 /// Return true if the class or any of its methods are marked dllimport.
2057 static bool isClassOrMethodDLLImport(const CXXRecordDecl *RD) {
2058 if (RD->hasAttr<DLLImportAttr>())
2060 for (const CXXMethodDecl *MD : RD->methods())
2061 if (MD->hasAttr<DLLImportAttr>())
2066 /// Does a type definition exist in an imported clang module?
2067 static bool isDefinedInClangModule(const RecordDecl *RD) {
2068 // Only definitions that where imported from an AST file come from a module.
2069 if (!RD || !RD->isFromASTFile())
2071 // Anonymous entities cannot be addressed. Treat them as not from module.
2072 if (!RD->isExternallyVisible() && RD->getName().empty())
2074 if (auto *CXXDecl = dyn_cast<CXXRecordDecl>(RD)) {
2075 if (!CXXDecl->isCompleteDefinition())
2077 // Check wether RD is a template.
2078 auto TemplateKind = CXXDecl->getTemplateSpecializationKind();
2079 if (TemplateKind != TSK_Undeclared) {
2080 // Unfortunately getOwningModule() isn't accurate enough to find the
2081 // owning module of a ClassTemplateSpecializationDecl that is inside a
2082 // namespace spanning multiple modules.
2083 bool Explicit = false;
2084 if (auto *TD = dyn_cast<ClassTemplateSpecializationDecl>(CXXDecl))
2085 Explicit = TD->isExplicitInstantiationOrSpecialization();
2086 if (!Explicit && CXXDecl->getEnclosingNamespaceContext())
2088 // This is a template, check the origin of the first member.
2089 if (CXXDecl->field_begin() == CXXDecl->field_end())
2090 return TemplateKind == TSK_ExplicitInstantiationDeclaration;
2091 if (!CXXDecl->field_begin()->isFromASTFile())
2098 void CGDebugInfo::completeClassData(const RecordDecl *RD) {
2099 if (auto *CXXRD = dyn_cast<CXXRecordDecl>(RD))
2100 if (CXXRD->isDynamicClass() &&
2101 CGM.getVTableLinkage(CXXRD) ==
2102 llvm::GlobalValue::AvailableExternallyLinkage &&
2103 !isClassOrMethodDLLImport(CXXRD))
2106 if (DebugTypeExtRefs && isDefinedInClangModule(RD->getDefinition()))
2112 void CGDebugInfo::completeClass(const RecordDecl *RD) {
2113 if (DebugKind <= codegenoptions::DebugLineTablesOnly)
2115 QualType Ty = CGM.getContext().getRecordType(RD);
2116 void *TyPtr = Ty.getAsOpaquePtr();
2117 auto I = TypeCache.find(TyPtr);
2118 if (I != TypeCache.end() && !cast<llvm::DIType>(I->second)->isForwardDecl())
2120 llvm::DIType *Res = CreateTypeDefinition(Ty->castAs<RecordType>());
2121 assert(!Res->isForwardDecl());
2122 TypeCache[TyPtr].reset(Res);
2125 static bool hasExplicitMemberDefinition(CXXRecordDecl::method_iterator I,
2126 CXXRecordDecl::method_iterator End) {
2127 for (CXXMethodDecl *MD : llvm::make_range(I, End))
2128 if (FunctionDecl *Tmpl = MD->getInstantiatedFromMemberFunction())
2129 if (!Tmpl->isImplicit() && Tmpl->isThisDeclarationADefinition() &&
2130 !MD->getMemberSpecializationInfo()->isExplicitSpecialization())
2135 static bool shouldOmitDefinition(codegenoptions::DebugInfoKind DebugKind,
2136 bool DebugTypeExtRefs, const RecordDecl *RD,
2137 const LangOptions &LangOpts) {
2138 if (DebugTypeExtRefs && isDefinedInClangModule(RD->getDefinition()))
2141 if (auto *ES = RD->getASTContext().getExternalSource())
2142 if (ES->hasExternalDefinitions(RD) == ExternalASTSource::EK_Always)
2145 if (DebugKind > codegenoptions::LimitedDebugInfo)
2148 if (!LangOpts.CPlusPlus)
2151 if (!RD->isCompleteDefinitionRequired())
2154 const auto *CXXDecl = dyn_cast<CXXRecordDecl>(RD);
2159 // Only emit complete debug info for a dynamic class when its vtable is
2160 // emitted. However, Microsoft debuggers don't resolve type information
2161 // across DLL boundaries, so skip this optimization if the class or any of its
2162 // methods are marked dllimport. This isn't a complete solution, since objects
2163 // without any dllimport methods can be used in one DLL and constructed in
2164 // another, but it is the current behavior of LimitedDebugInfo.
2165 if (CXXDecl->hasDefinition() && CXXDecl->isDynamicClass() &&
2166 !isClassOrMethodDLLImport(CXXDecl))
2169 TemplateSpecializationKind Spec = TSK_Undeclared;
2170 if (const auto *SD = dyn_cast<ClassTemplateSpecializationDecl>(RD))
2171 Spec = SD->getSpecializationKind();
2173 if (Spec == TSK_ExplicitInstantiationDeclaration &&
2174 hasExplicitMemberDefinition(CXXDecl->method_begin(),
2175 CXXDecl->method_end()))
2181 void CGDebugInfo::completeRequiredType(const RecordDecl *RD) {
2182 if (shouldOmitDefinition(DebugKind, DebugTypeExtRefs, RD, CGM.getLangOpts()))
2185 QualType Ty = CGM.getContext().getRecordType(RD);
2186 llvm::DIType *T = getTypeOrNull(Ty);
2187 if (T && T->isForwardDecl())
2188 completeClassData(RD);
2191 llvm::DIType *CGDebugInfo::CreateType(const RecordType *Ty) {
2192 RecordDecl *RD = Ty->getDecl();
2193 llvm::DIType *T = cast_or_null<llvm::DIType>(getTypeOrNull(QualType(Ty, 0)));
2194 if (T || shouldOmitDefinition(DebugKind, DebugTypeExtRefs, RD,
2195 CGM.getLangOpts())) {
2197 T = getOrCreateRecordFwdDecl(Ty, getDeclContextDescriptor(RD));
2201 return CreateTypeDefinition(Ty);
2204 llvm::DIType *CGDebugInfo::CreateTypeDefinition(const RecordType *Ty) {
2205 RecordDecl *RD = Ty->getDecl();
2207 // Get overall information about the record type for the debug info.
2208 llvm::DIFile *DefUnit = getOrCreateFile(RD->getLocation());
2210 // Records and classes and unions can all be recursive. To handle them, we
2211 // first generate a debug descriptor for the struct as a forward declaration.
2212 // Then (if it is a definition) we go through and get debug info for all of
2213 // its members. Finally, we create a descriptor for the complete type (which
2214 // may refer to the forward decl if the struct is recursive) and replace all
2215 // uses of the forward declaration with the final definition.
2216 llvm::DICompositeType *FwdDecl = getOrCreateLimitedType(Ty, DefUnit);
2218 const RecordDecl *D = RD->getDefinition();
2219 if (!D || !D->isCompleteDefinition())
2222 if (const auto *CXXDecl = dyn_cast<CXXRecordDecl>(RD))
2223 CollectContainingType(CXXDecl, FwdDecl);
2225 // Push the struct on region stack.
2226 LexicalBlockStack.emplace_back(&*FwdDecl);
2227 RegionMap[Ty->getDecl()].reset(FwdDecl);
2229 // Convert all the elements.
2230 SmallVector<llvm::Metadata *, 16> EltTys;
2231 // what about nested types?
2233 // Note: The split of CXXDecl information here is intentional, the
2234 // gdb tests will depend on a certain ordering at printout. The debug
2235 // information offsets are still correct if we merge them all together
2237 const auto *CXXDecl = dyn_cast<CXXRecordDecl>(RD);
2239 CollectCXXBases(CXXDecl, DefUnit, EltTys, FwdDecl);
2240 CollectVTableInfo(CXXDecl, DefUnit, EltTys, FwdDecl);
2243 // Collect data fields (including static variables and any initializers).
2244 CollectRecordFields(RD, DefUnit, EltTys, FwdDecl);
2246 CollectCXXMemberFunctions(CXXDecl, DefUnit, EltTys, FwdDecl);
2248 LexicalBlockStack.pop_back();
2249 RegionMap.erase(Ty->getDecl());
2251 llvm::DINodeArray Elements = DBuilder.getOrCreateArray(EltTys);
2252 DBuilder.replaceArrays(FwdDecl, Elements);
2254 if (FwdDecl->isTemporary())
2256 llvm::MDNode::replaceWithPermanent(llvm::TempDICompositeType(FwdDecl));
2258 RegionMap[Ty->getDecl()].reset(FwdDecl);
2262 llvm::DIType *CGDebugInfo::CreateType(const ObjCObjectType *Ty,
2263 llvm::DIFile *Unit) {
2264 // Ignore protocols.
2265 return getOrCreateType(Ty->getBaseType(), Unit);
2268 llvm::DIType *CGDebugInfo::CreateType(const ObjCTypeParamType *Ty,
2269 llvm::DIFile *Unit) {
2270 // Ignore protocols.
2271 SourceLocation Loc = Ty->getDecl()->getLocation();
2273 // Use Typedefs to represent ObjCTypeParamType.
2274 return DBuilder.createTypedef(
2275 getOrCreateType(Ty->getDecl()->getUnderlyingType(), Unit),
2276 Ty->getDecl()->getName(), getOrCreateFile(Loc), getLineNumber(Loc),
2277 getDeclContextDescriptor(Ty->getDecl()));
2280 /// \return true if Getter has the default name for the property PD.
2281 static bool hasDefaultGetterName(const ObjCPropertyDecl *PD,
2282 const ObjCMethodDecl *Getter) {
2287 assert(Getter->getDeclName().isObjCZeroArgSelector());
2288 return PD->getName() ==
2289 Getter->getDeclName().getObjCSelector().getNameForSlot(0);
2292 /// \return true if Setter has the default name for the property PD.
2293 static bool hasDefaultSetterName(const ObjCPropertyDecl *PD,
2294 const ObjCMethodDecl *Setter) {
2299 assert(Setter->getDeclName().isObjCOneArgSelector());
2300 return SelectorTable::constructSetterName(PD->getName()) ==
2301 Setter->getDeclName().getObjCSelector().getNameForSlot(0);
2304 llvm::DIType *CGDebugInfo::CreateType(const ObjCInterfaceType *Ty,
2305 llvm::DIFile *Unit) {
2306 ObjCInterfaceDecl *ID = Ty->getDecl();
2310 // Return a forward declaration if this type was imported from a clang module,
2311 // and this is not the compile unit with the implementation of the type (which
2312 // may contain hidden ivars).
2313 if (DebugTypeExtRefs && ID->isFromASTFile() && ID->getDefinition() &&
2314 !ID->getImplementation())
2315 return DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
2317 getDeclContextDescriptor(ID), Unit, 0);
2319 // Get overall information about the record type for the debug info.
2320 llvm::DIFile *DefUnit = getOrCreateFile(ID->getLocation());
2321 unsigned Line = getLineNumber(ID->getLocation());
2323 static_cast<llvm::dwarf::SourceLanguage>(TheCU->getSourceLanguage());
2325 // If this is just a forward declaration return a special forward-declaration
2326 // debug type since we won't be able to lay out the entire type.
2327 ObjCInterfaceDecl *Def = ID->getDefinition();
2328 if (!Def || !Def->getImplementation()) {
2329 llvm::DIScope *Mod = getParentModuleOrNull(ID);
2330 llvm::DIType *FwdDecl = DBuilder.createReplaceableCompositeType(
2331 llvm::dwarf::DW_TAG_structure_type, ID->getName(), Mod ? Mod : TheCU,
2332 DefUnit, Line, RuntimeLang);
2333 ObjCInterfaceCache.push_back(ObjCInterfaceCacheEntry(Ty, FwdDecl, Unit));
2337 return CreateTypeDefinition(Ty, Unit);
2341 CGDebugInfo::getOrCreateModuleRef(ExternalASTSource::ASTSourceDescriptor Mod,
2342 bool CreateSkeletonCU) {
2343 // Use the Module pointer as the key into the cache. This is a
2344 // nullptr if the "Module" is a PCH, which is safe because we don't
2345 // support chained PCH debug info, so there can only be a single PCH.
2346 const Module *M = Mod.getModuleOrNull();
2347 auto ModRef = ModuleCache.find(M);
2348 if (ModRef != ModuleCache.end())
2349 return cast<llvm::DIModule>(ModRef->second);
2351 // Macro definitions that were defined with "-D" on the command line.
2352 SmallString<128> ConfigMacros;
2354 llvm::raw_svector_ostream OS(ConfigMacros);
2355 const auto &PPOpts = CGM.getPreprocessorOpts();
2357 // Translate the macro definitions back into a command line.
2358 for (auto &M : PPOpts.Macros) {
2361 const std::string &Macro = M.first;
2362 bool Undef = M.second;
2363 OS << "\"-" << (Undef ? 'U' : 'D');
2364 for (char c : Macro)
2379 bool IsRootModule = M ? !M->Parent : true;
2380 // When a module name is specified as -fmodule-name, that module gets a
2381 // clang::Module object, but it won't actually be built or imported; it will
2383 if (CreateSkeletonCU && IsRootModule && Mod.getASTFile().empty() && M)
2384 assert(StringRef(M->Name).startswith(CGM.getLangOpts().ModuleName) &&
2385 "clang module without ASTFile must be specified by -fmodule-name");
2387 if (CreateSkeletonCU && IsRootModule && !Mod.getASTFile().empty()) {
2388 // PCH files don't have a signature field in the control block,
2389 // but LLVM detects skeleton CUs by looking for a non-zero DWO id.
2390 // We use the lower 64 bits for debug info.
2391 uint64_t Signature =
2393 ? (uint64_t)Mod.getSignature()[1] << 32 | Mod.getSignature()[0]
2395 llvm::DIBuilder DIB(CGM.getModule());
2396 DIB.createCompileUnit(TheCU->getSourceLanguage(),
2397 // TODO: Support "Source" from external AST providers?
2398 DIB.createFile(Mod.getModuleName(), Mod.getPath()),
2399 TheCU->getProducer(), true, StringRef(), 0,
2400 Mod.getASTFile(), llvm::DICompileUnit::FullDebug,
2405 llvm::DIModule *Parent =
2406 IsRootModule ? nullptr
2407 : getOrCreateModuleRef(
2408 ExternalASTSource::ASTSourceDescriptor(*M->Parent),
2410 llvm::DIModule *DIMod =
2411 DBuilder.createModule(Parent, Mod.getModuleName(), ConfigMacros,
2412 Mod.getPath(), CGM.getHeaderSearchOpts().Sysroot);
2413 ModuleCache[M].reset(DIMod);
2417 llvm::DIType *CGDebugInfo::CreateTypeDefinition(const ObjCInterfaceType *Ty,
2418 llvm::DIFile *Unit) {
2419 ObjCInterfaceDecl *ID = Ty->getDecl();
2420 llvm::DIFile *DefUnit = getOrCreateFile(ID->getLocation());
2421 unsigned Line = getLineNumber(ID->getLocation());
2422 unsigned RuntimeLang = TheCU->getSourceLanguage();
2424 // Bit size, align and offset of the type.
2425 uint64_t Size = CGM.getContext().getTypeSize(Ty);
2426 auto Align = getTypeAlignIfRequired(Ty, CGM.getContext());
2428 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
2429 if (ID->getImplementation())
2430 Flags |= llvm::DINode::FlagObjcClassComplete;
2432 llvm::DIScope *Mod = getParentModuleOrNull(ID);
2433 llvm::DICompositeType *RealDecl = DBuilder.createStructType(
2434 Mod ? Mod : Unit, ID->getName(), DefUnit, Line, Size, Align, Flags,
2435 nullptr, llvm::DINodeArray(), RuntimeLang);
2437 QualType QTy(Ty, 0);
2438 TypeCache[QTy.getAsOpaquePtr()].reset(RealDecl);
2440 // Push the struct on region stack.
2441 LexicalBlockStack.emplace_back(RealDecl);
2442 RegionMap[Ty->getDecl()].reset(RealDecl);
2444 // Convert all the elements.
2445 SmallVector<llvm::Metadata *, 16> EltTys;
2447 ObjCInterfaceDecl *SClass = ID->getSuperClass();
2449 llvm::DIType *SClassTy =
2450 getOrCreateType(CGM.getContext().getObjCInterfaceType(SClass), Unit);
2454 llvm::DIType *InhTag = DBuilder.createInheritance(RealDecl, SClassTy, 0, 0,
2455 llvm::DINode::FlagZero);
2456 EltTys.push_back(InhTag);
2459 // Create entries for all of the properties.
2460 auto AddProperty = [&](const ObjCPropertyDecl *PD) {
2461 SourceLocation Loc = PD->getLocation();
2462 llvm::DIFile *PUnit = getOrCreateFile(Loc);
2463 unsigned PLine = getLineNumber(Loc);
2464 ObjCMethodDecl *Getter = PD->getGetterMethodDecl();
2465 ObjCMethodDecl *Setter = PD->getSetterMethodDecl();
2466 llvm::MDNode *PropertyNode = DBuilder.createObjCProperty(
2467 PD->getName(), PUnit, PLine,
2468 hasDefaultGetterName(PD, Getter) ? ""
2469 : getSelectorName(PD->getGetterName()),
2470 hasDefaultSetterName(PD, Setter) ? ""
2471 : getSelectorName(PD->getSetterName()),
2472 PD->getPropertyAttributes(), getOrCreateType(PD->getType(), PUnit));
2473 EltTys.push_back(PropertyNode);
2476 llvm::SmallPtrSet<const IdentifierInfo *, 16> PropertySet;
2477 for (const ObjCCategoryDecl *ClassExt : ID->known_extensions())
2478 for (auto *PD : ClassExt->properties()) {
2479 PropertySet.insert(PD->getIdentifier());
2482 for (const auto *PD : ID->properties()) {
2483 // Don't emit duplicate metadata for properties that were already in a
2485 if (!PropertySet.insert(PD->getIdentifier()).second)
2491 const ASTRecordLayout &RL = CGM.getContext().getASTObjCInterfaceLayout(ID);
2492 unsigned FieldNo = 0;
2493 for (ObjCIvarDecl *Field = ID->all_declared_ivar_begin(); Field;
2494 Field = Field->getNextIvar(), ++FieldNo) {
2495 llvm::DIType *FieldTy = getOrCreateType(Field->getType(), Unit);
2499 StringRef FieldName = Field->getName();
2501 // Ignore unnamed fields.
2502 if (FieldName.empty())
2505 // Get the location for the field.
2506 llvm::DIFile *FieldDefUnit = getOrCreateFile(Field->getLocation());
2507 unsigned FieldLine = getLineNumber(Field->getLocation());
2508 QualType FType = Field->getType();
2509 uint64_t FieldSize = 0;
2510 uint32_t FieldAlign = 0;
2512 if (!FType->isIncompleteArrayType()) {
2514 // Bit size, align and offset of the type.
2515 FieldSize = Field->isBitField()
2516 ? Field->getBitWidthValue(CGM.getContext())
2517 : CGM.getContext().getTypeSize(FType);
2518 FieldAlign = getTypeAlignIfRequired(FType, CGM.getContext());
2521 uint64_t FieldOffset;
2522 if (CGM.getLangOpts().ObjCRuntime.isNonFragile()) {
2523 // We don't know the runtime offset of an ivar if we're using the
2524 // non-fragile ABI. For bitfields, use the bit offset into the first
2525 // byte of storage of the bitfield. For other fields, use zero.
2526 if (Field->isBitField()) {
2528 CGM.getObjCRuntime().ComputeBitfieldBitOffset(CGM, ID, Field);
2529 FieldOffset %= CGM.getContext().getCharWidth();
2534 FieldOffset = RL.getFieldOffset(FieldNo);
2537 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
2538 if (Field->getAccessControl() == ObjCIvarDecl::Protected)
2539 Flags = llvm::DINode::FlagProtected;
2540 else if (Field->getAccessControl() == ObjCIvarDecl::Private)
2541 Flags = llvm::DINode::FlagPrivate;
2542 else if (Field->getAccessControl() == ObjCIvarDecl::Public)
2543 Flags = llvm::DINode::FlagPublic;
2545 llvm::MDNode *PropertyNode = nullptr;
2546 if (ObjCImplementationDecl *ImpD = ID->getImplementation()) {
2547 if (ObjCPropertyImplDecl *PImpD =
2548 ImpD->FindPropertyImplIvarDecl(Field->getIdentifier())) {
2549 if (ObjCPropertyDecl *PD = PImpD->getPropertyDecl()) {
2550 SourceLocation Loc = PD->getLocation();
2551 llvm::DIFile *PUnit = getOrCreateFile(Loc);
2552 unsigned PLine = getLineNumber(Loc);
2553 ObjCMethodDecl *Getter = PD->getGetterMethodDecl();
2554 ObjCMethodDecl *Setter = PD->getSetterMethodDecl();
2555 PropertyNode = DBuilder.createObjCProperty(
2556 PD->getName(), PUnit, PLine,
2557 hasDefaultGetterName(PD, Getter)
2559 : getSelectorName(PD->getGetterName()),
2560 hasDefaultSetterName(PD, Setter)
2562 : getSelectorName(PD->getSetterName()),
2563 PD->getPropertyAttributes(),
2564 getOrCreateType(PD->getType(), PUnit));
2568 FieldTy = DBuilder.createObjCIVar(FieldName, FieldDefUnit, FieldLine,
2569 FieldSize, FieldAlign, FieldOffset, Flags,
2570 FieldTy, PropertyNode);
2571 EltTys.push_back(FieldTy);
2574 llvm::DINodeArray Elements = DBuilder.getOrCreateArray(EltTys);
2575 DBuilder.replaceArrays(RealDecl, Elements);
2577 LexicalBlockStack.pop_back();
2581 llvm::DIType *CGDebugInfo::CreateType(const VectorType *Ty,
2582 llvm::DIFile *Unit) {
2583 llvm::DIType *ElementTy = getOrCreateType(Ty->getElementType(), Unit);
2584 int64_t Count = Ty->getNumElements();
2586 llvm::Metadata *Subscript;
2587 QualType QTy(Ty, 0);
2588 auto SizeExpr = SizeExprCache.find(QTy);
2589 if (SizeExpr != SizeExprCache.end())
2590 Subscript = DBuilder.getOrCreateSubrange(0, SizeExpr->getSecond());
2592 Subscript = DBuilder.getOrCreateSubrange(0, Count ? Count : -1);
2593 llvm::DINodeArray SubscriptArray = DBuilder.getOrCreateArray(Subscript);
2595 uint64_t Size = CGM.getContext().getTypeSize(Ty);
2596 auto Align = getTypeAlignIfRequired(Ty, CGM.getContext());
2598 return DBuilder.createVectorType(Size, Align, ElementTy, SubscriptArray);
2601 llvm::DIType *CGDebugInfo::CreateType(const ArrayType *Ty, llvm::DIFile *Unit) {
2605 // FIXME: make getTypeAlign() aware of VLAs and incomplete array types
2606 if (const auto *VAT = dyn_cast<VariableArrayType>(Ty)) {
2608 Align = getTypeAlignIfRequired(CGM.getContext().getBaseElementType(VAT),
2610 } else if (Ty->isIncompleteArrayType()) {
2612 if (Ty->getElementType()->isIncompleteType())
2615 Align = getTypeAlignIfRequired(Ty->getElementType(), CGM.getContext());
2616 } else if (Ty->isIncompleteType()) {
2620 // Size and align of the whole array, not the element type.
2621 Size = CGM.getContext().getTypeSize(Ty);
2622 Align = getTypeAlignIfRequired(Ty, CGM.getContext());
2625 // Add the dimensions of the array. FIXME: This loses CV qualifiers from
2626 // interior arrays, do we care? Why aren't nested arrays represented the
2627 // obvious/recursive way?
2628 SmallVector<llvm::Metadata *, 8> Subscripts;
2629 QualType EltTy(Ty, 0);
2630 while ((Ty = dyn_cast<ArrayType>(EltTy))) {
2631 // If the number of elements is known, then count is that number. Otherwise,
2632 // it's -1. This allows us to represent a subrange with an array of 0
2633 // elements, like this:
2638 int64_t Count = -1; // Count == -1 is an unbounded array.
2639 if (const auto *CAT = dyn_cast<ConstantArrayType>(Ty))
2640 Count = CAT->getSize().getZExtValue();
2641 else if (const auto *VAT = dyn_cast<VariableArrayType>(Ty)) {
2642 if (Expr *Size = VAT->getSizeExpr()) {
2643 Expr::EvalResult Result;
2644 if (Size->EvaluateAsInt(Result, CGM.getContext()))
2645 Count = Result.Val.getInt().getExtValue();
2649 auto SizeNode = SizeExprCache.find(EltTy);
2650 if (SizeNode != SizeExprCache.end())
2651 Subscripts.push_back(
2652 DBuilder.getOrCreateSubrange(0, SizeNode->getSecond()));
2654 Subscripts.push_back(DBuilder.getOrCreateSubrange(0, Count));
2655 EltTy = Ty->getElementType();
2658 llvm::DINodeArray SubscriptArray = DBuilder.getOrCreateArray(Subscripts);
2660 return DBuilder.createArrayType(Size, Align, getOrCreateType(EltTy, Unit),
2664 llvm::DIType *CGDebugInfo::CreateType(const LValueReferenceType *Ty,
2665 llvm::DIFile *Unit) {
2666 return CreatePointerLikeType(llvm::dwarf::DW_TAG_reference_type, Ty,
2667 Ty->getPointeeType(), Unit);
2670 llvm::DIType *CGDebugInfo::CreateType(const RValueReferenceType *Ty,
2671 llvm::DIFile *Unit) {
2672 return CreatePointerLikeType(llvm::dwarf::DW_TAG_rvalue_reference_type, Ty,
2673 Ty->getPointeeType(), Unit);
2676 llvm::DIType *CGDebugInfo::CreateType(const MemberPointerType *Ty,
2678 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
2681 if (!Ty->isIncompleteType()) {
2682 Size = CGM.getContext().getTypeSize(Ty);
2684 // Set the MS inheritance model. There is no flag for the unspecified model.
2685 if (CGM.getTarget().getCXXABI().isMicrosoft()) {
2686 switch (Ty->getMostRecentCXXRecordDecl()->getMSInheritanceModel()) {
2687 case MSInheritanceAttr::Keyword_single_inheritance:
2688 Flags |= llvm::DINode::FlagSingleInheritance;
2690 case MSInheritanceAttr::Keyword_multiple_inheritance:
2691 Flags |= llvm::DINode::FlagMultipleInheritance;
2693 case MSInheritanceAttr::Keyword_virtual_inheritance:
2694 Flags |= llvm::DINode::FlagVirtualInheritance;
2696 case MSInheritanceAttr::Keyword_unspecified_inheritance:
2702 llvm::DIType *ClassType = getOrCreateType(QualType(Ty->getClass(), 0), U);
2703 if (Ty->isMemberDataPointerType())
2704 return DBuilder.createMemberPointerType(
2705 getOrCreateType(Ty->getPointeeType(), U), ClassType, Size, /*Align=*/0,
2708 const FunctionProtoType *FPT =
2709 Ty->getPointeeType()->getAs<FunctionProtoType>();
2710 return DBuilder.createMemberPointerType(
2711 getOrCreateInstanceMethodType(
2712 CXXMethodDecl::getThisType(FPT, Ty->getMostRecentCXXRecordDecl()),
2714 ClassType, Size, /*Align=*/0, Flags);
2717 llvm::DIType *CGDebugInfo::CreateType(const AtomicType *Ty, llvm::DIFile *U) {
2718 auto *FromTy = getOrCreateType(Ty->getValueType(), U);
2719 return DBuilder.createQualifiedType(llvm::dwarf::DW_TAG_atomic_type, FromTy);
2722 llvm::DIType *CGDebugInfo::CreateType(const PipeType *Ty, llvm::DIFile *U) {
2723 return getOrCreateType(Ty->getElementType(), U);
2726 llvm::DIType *CGDebugInfo::CreateEnumType(const EnumType *Ty) {
2727 const EnumDecl *ED = Ty->getDecl();
2731 if (!ED->getTypeForDecl()->isIncompleteType()) {
2732 Size = CGM.getContext().getTypeSize(ED->getTypeForDecl());
2733 Align = getDeclAlignIfRequired(ED, CGM.getContext());
2736 SmallString<256> Identifier = getTypeIdentifier(Ty, CGM, TheCU);
2738 bool isImportedFromModule =
2739 DebugTypeExtRefs && ED->isFromASTFile() && ED->getDefinition();
2741 // If this is just a forward declaration, construct an appropriately
2742 // marked node and just return it.
2743 if (isImportedFromModule || !ED->getDefinition()) {
2744 // Note that it is possible for enums to be created as part of
2745 // their own declcontext. In this case a FwdDecl will be created
2746 // twice. This doesn't cause a problem because both FwdDecls are
2747 // entered into the ReplaceMap: finalize() will replace the first
2748 // FwdDecl with the second and then replace the second with
2750 llvm::DIScope *EDContext = getDeclContextDescriptor(ED);
2751 llvm::DIFile *DefUnit = getOrCreateFile(ED->getLocation());
2752 llvm::TempDIScope TmpContext(DBuilder.createReplaceableCompositeType(
2753 llvm::dwarf::DW_TAG_enumeration_type, "", TheCU, DefUnit, 0));
2755 unsigned Line = getLineNumber(ED->getLocation());
2756 StringRef EDName = ED->getName();
2757 llvm::DIType *RetTy = DBuilder.createReplaceableCompositeType(
2758 llvm::dwarf::DW_TAG_enumeration_type, EDName, EDContext, DefUnit, Line,
2759 0, Size, Align, llvm::DINode::FlagFwdDecl, Identifier);
2761 ReplaceMap.emplace_back(
2762 std::piecewise_construct, std::make_tuple(Ty),
2763 std::make_tuple(static_cast<llvm::Metadata *>(RetTy)));
2767 return CreateTypeDefinition(Ty);
2770 llvm::DIType *CGDebugInfo::CreateTypeDefinition(const EnumType *Ty) {
2771 const EnumDecl *ED = Ty->getDecl();
2774 if (!ED->getTypeForDecl()->isIncompleteType()) {
2775 Size = CGM.getContext().getTypeSize(ED->getTypeForDecl());
2776 Align = getDeclAlignIfRequired(ED, CGM.getContext());
2779 SmallString<256> Identifier = getTypeIdentifier(Ty, CGM, TheCU);
2781 // Create elements for each enumerator.
2782 SmallVector<llvm::Metadata *, 16> Enumerators;
2783 ED = ED->getDefinition();
2784 bool IsSigned = ED->getIntegerType()->isSignedIntegerType();
2785 for (const auto *Enum : ED->enumerators()) {
2786 const auto &InitVal = Enum->getInitVal();
2787 auto Value = IsSigned ? InitVal.getSExtValue() : InitVal.getZExtValue();
2788 Enumerators.push_back(
2789 DBuilder.createEnumerator(Enum->getName(), Value, !IsSigned));
2792 // Return a CompositeType for the enum itself.
2793 llvm::DINodeArray EltArray = DBuilder.getOrCreateArray(Enumerators);
2795 llvm::DIFile *DefUnit = getOrCreateFile(ED->getLocation());
2796 unsigned Line = getLineNumber(ED->getLocation());
2797 llvm::DIScope *EnumContext = getDeclContextDescriptor(ED);
2798 llvm::DIType *ClassTy = getOrCreateType(ED->getIntegerType(), DefUnit);
2799 return DBuilder.createEnumerationType(EnumContext, ED->getName(), DefUnit,
2800 Line, Size, Align, EltArray, ClassTy,
2801 Identifier, ED->isScoped());
2804 llvm::DIMacro *CGDebugInfo::CreateMacro(llvm::DIMacroFile *Parent,
2805 unsigned MType, SourceLocation LineLoc,
2806 StringRef Name, StringRef Value) {
2807 unsigned Line = LineLoc.isInvalid() ? 0 : getLineNumber(LineLoc);
2808 return DBuilder.createMacro(Parent, Line, MType, Name, Value);
2811 llvm::DIMacroFile *CGDebugInfo::CreateTempMacroFile(llvm::DIMacroFile *Parent,
2812 SourceLocation LineLoc,
2813 SourceLocation FileLoc) {
2814 llvm::DIFile *FName = getOrCreateFile(FileLoc);
2815 unsigned Line = LineLoc.isInvalid() ? 0 : getLineNumber(LineLoc);
2816 return DBuilder.createTempMacroFile(Parent, Line, FName);
2819 static QualType UnwrapTypeForDebugInfo(QualType T, const ASTContext &C) {
2822 Qualifiers InnerQuals = T.getLocalQualifiers();
2823 // Qualifiers::operator+() doesn't like it if you add a Qualifier
2824 // that is already there.
2825 Quals += Qualifiers::removeCommonQualifiers(Quals, InnerQuals);
2826 Quals += InnerQuals;
2828 switch (T->getTypeClass()) {
2830 return C.getQualifiedType(T.getTypePtr(), Quals);
2831 case Type::TemplateSpecialization: {
2832 const auto *Spec = cast<TemplateSpecializationType>(T);
2833 if (Spec->isTypeAlias())
2834 return C.getQualifiedType(T.getTypePtr(), Quals);
2835 T = Spec->desugar();
2838 case Type::TypeOfExpr:
2839 T = cast<TypeOfExprType>(T)->getUnderlyingExpr()->getType();
2842 T = cast<TypeOfType>(T)->getUnderlyingType();
2844 case Type::Decltype:
2845 T = cast<DecltypeType>(T)->getUnderlyingType();
2847 case Type::UnaryTransform:
2848 T = cast<UnaryTransformType>(T)->getUnderlyingType();
2850 case Type::Attributed:
2851 T = cast<AttributedType>(T)->getEquivalentType();
2853 case Type::Elaborated:
2854 T = cast<ElaboratedType>(T)->getNamedType();
2857 T = cast<ParenType>(T)->getInnerType();
2859 case Type::MacroQualified:
2860 T = cast<MacroQualifiedType>(T)->getUnderlyingType();
2862 case Type::SubstTemplateTypeParm:
2863 T = cast<SubstTemplateTypeParmType>(T)->getReplacementType();
2866 case Type::DeducedTemplateSpecialization: {
2867 QualType DT = cast<DeducedType>(T)->getDeducedType();
2868 assert(!DT.isNull() && "Undeduced types shouldn't reach here.");
2872 case Type::Adjusted:
2874 // Decayed and adjusted types use the adjusted type in LLVM and DWARF.
2875 T = cast<AdjustedType>(T)->getAdjustedType();
2879 assert(T != LastT && "Type unwrapping failed to unwrap!");
2884 llvm::DIType *CGDebugInfo::getTypeOrNull(QualType Ty) {
2886 // Unwrap the type as needed for debug information.
2887 Ty = UnwrapTypeForDebugInfo(Ty, CGM.getContext());
2889 auto It = TypeCache.find(Ty.getAsOpaquePtr());
2890 if (It != TypeCache.end()) {
2891 // Verify that the debug info still exists.
2892 if (llvm::Metadata *V = It->second)
2893 return cast<llvm::DIType>(V);
2899 void CGDebugInfo::completeTemplateDefinition(
2900 const ClassTemplateSpecializationDecl &SD) {
2901 if (DebugKind <= codegenoptions::DebugLineTablesOnly)
2903 completeUnusedClass(SD);
2906 void CGDebugInfo::completeUnusedClass(const CXXRecordDecl &D) {
2907 if (DebugKind <= codegenoptions::DebugLineTablesOnly)
2910 completeClassData(&D);
2911 // In case this type has no member function definitions being emitted, ensure
2913 RetainedTypes.push_back(CGM.getContext().getRecordType(&D).getAsOpaquePtr());
2916 llvm::DIType *CGDebugInfo::getOrCreateType(QualType Ty, llvm::DIFile *Unit) {
2920 // Unwrap the type as needed for debug information.
2921 Ty = UnwrapTypeForDebugInfo(Ty, CGM.getContext());
2923 if (auto *T = getTypeOrNull(Ty))
2926 llvm::DIType *Res = CreateTypeNode(Ty, Unit);
2927 void *TyPtr = Ty.getAsOpaquePtr();
2929 // And update the type cache.
2930 TypeCache[TyPtr].reset(Res);
2935 llvm::DIModule *CGDebugInfo::getParentModuleOrNull(const Decl *D) {
2936 // A forward declaration inside a module header does not belong to the module.
2937 if (isa<RecordDecl>(D) && !cast<RecordDecl>(D)->getDefinition())
2939 if (DebugTypeExtRefs && D->isFromASTFile()) {
2940 // Record a reference to an imported clang module or precompiled header.
2941 auto *Reader = CGM.getContext().getExternalSource();
2942 auto Idx = D->getOwningModuleID();
2943 auto Info = Reader->getSourceDescriptor(Idx);
2945 return getOrCreateModuleRef(*Info, /*SkeletonCU=*/true);
2946 } else if (ClangModuleMap) {
2947 // We are building a clang module or a precompiled header.
2949 // TODO: When D is a CXXRecordDecl or a C++ Enum, the ODR applies
2950 // and it wouldn't be necessary to specify the parent scope
2951 // because the type is already unique by definition (it would look
2952 // like the output of -fno-standalone-debug). On the other hand,
2953 // the parent scope helps a consumer to quickly locate the object
2954 // file where the type's definition is located, so it might be
2955 // best to make this behavior a command line or debugger tuning
2957 if (Module *M = D->getOwningModule()) {
2958 // This is a (sub-)module.
2959 auto Info = ExternalASTSource::ASTSourceDescriptor(*M);
2960 return getOrCreateModuleRef(Info, /*SkeletonCU=*/false);
2962 // This the precompiled header being built.
2963 return getOrCreateModuleRef(PCHDescriptor, /*SkeletonCU=*/false);
2970 llvm::DIType *CGDebugInfo::CreateTypeNode(QualType Ty, llvm::DIFile *Unit) {
2971 // Handle qualifiers, which recursively handles what they refer to.
2972 if (Ty.hasLocalQualifiers())
2973 return CreateQualifiedType(Ty, Unit);
2975 // Work out details of type.
2976 switch (Ty->getTypeClass()) {
2977 #define TYPE(Class, Base)
2978 #define ABSTRACT_TYPE(Class, Base)
2979 #define NON_CANONICAL_TYPE(Class, Base)
2980 #define DEPENDENT_TYPE(Class, Base) case Type::Class:
2981 #include "clang/AST/TypeNodes.def"
2982 llvm_unreachable("Dependent types cannot show up in debug information");
2984 case Type::ExtVector:
2986 return CreateType(cast<VectorType>(Ty), Unit);
2987 case Type::ObjCObjectPointer:
2988 return CreateType(cast<ObjCObjectPointerType>(Ty), Unit);
2989 case Type::ObjCObject:
2990 return CreateType(cast<ObjCObjectType>(Ty), Unit);
2991 case Type::ObjCTypeParam:
2992 return CreateType(cast<ObjCTypeParamType>(Ty), Unit);
2993 case Type::ObjCInterface:
2994 return CreateType(cast<ObjCInterfaceType>(Ty), Unit);
2996 return CreateType(cast<BuiltinType>(Ty));
2998 return CreateType(cast<ComplexType>(Ty));
3000 return CreateType(cast<PointerType>(Ty), Unit);
3001 case Type::BlockPointer:
3002 return CreateType(cast<BlockPointerType>(Ty), Unit);
3004 return CreateType(cast<TypedefType>(Ty), Unit);
3006 return CreateType(cast<RecordType>(Ty));
3008 return CreateEnumType(cast<EnumType>(Ty));
3009 case Type::FunctionProto:
3010 case Type::FunctionNoProto:
3011 return CreateType(cast<FunctionType>(Ty), Unit);
3012 case Type::ConstantArray:
3013 case Type::VariableArray:
3014 case Type::IncompleteArray:
3015 return CreateType(cast<ArrayType>(Ty), Unit);
3017 case Type::LValueReference:
3018 return CreateType(cast<LValueReferenceType>(Ty), Unit);
3019 case Type::RValueReference:
3020 return CreateType(cast<RValueReferenceType>(Ty), Unit);
3022 case Type::MemberPointer:
3023 return CreateType(cast<MemberPointerType>(Ty), Unit);
3026 return CreateType(cast<AtomicType>(Ty), Unit);
3029 return CreateType(cast<PipeType>(Ty), Unit);
3031 case Type::TemplateSpecialization:
3032 return CreateType(cast<TemplateSpecializationType>(Ty), Unit);
3035 case Type::Attributed:
3036 case Type::Adjusted:
3038 case Type::DeducedTemplateSpecialization:
3039 case Type::Elaborated:
3041 case Type::MacroQualified:
3042 case Type::SubstTemplateTypeParm:
3043 case Type::TypeOfExpr:
3045 case Type::Decltype:
3046 case Type::UnaryTransform:
3047 case Type::PackExpansion:
3051 llvm_unreachable("type should have been unwrapped!");
3054 llvm::DICompositeType *CGDebugInfo::getOrCreateLimitedType(const RecordType *Ty,
3055 llvm::DIFile *Unit) {
3056 QualType QTy(Ty, 0);
3058 auto *T = cast_or_null<llvm::DICompositeType>(getTypeOrNull(QTy));
3060 // We may have cached a forward decl when we could have created
3061 // a non-forward decl. Go ahead and create a non-forward decl
3063 if (T && !T->isForwardDecl())
3066 // Otherwise create the type.
3067 llvm::DICompositeType *Res = CreateLimitedType(Ty);
3069 // Propagate members from the declaration to the definition
3070 // CreateType(const RecordType*) will overwrite this with the members in the
3071 // correct order if the full type is needed.
3072 DBuilder.replaceArrays(Res, T ? T->getElements() : llvm::DINodeArray());
3074 // And update the type cache.
3075 TypeCache[QTy.getAsOpaquePtr()].reset(Res);
3079 // TODO: Currently used for context chains when limiting debug info.
3080 llvm::DICompositeType *CGDebugInfo::CreateLimitedType(const RecordType *Ty) {
3081 RecordDecl *RD = Ty->getDecl();
3083 // Get overall information about the record type for the debug info.
3084 llvm::DIFile *DefUnit = getOrCreateFile(RD->getLocation());
3085 unsigned Line = getLineNumber(RD->getLocation());
3086 StringRef RDName = getClassName(RD);
3088 llvm::DIScope *RDContext = getDeclContextDescriptor(RD);
3090 // If we ended up creating the type during the context chain construction,
3091 // just return that.
3092 auto *T = cast_or_null<llvm::DICompositeType>(
3093 getTypeOrNull(CGM.getContext().getRecordType(RD)));
3094 if (T && (!T->isForwardDecl() || !RD->getDefinition()))
3097 // If this is just a forward or incomplete declaration, construct an
3098 // appropriately marked node and just return it.
3099 const RecordDecl *D = RD->getDefinition();
3100 if (!D || !D->isCompleteDefinition())
3101 return getOrCreateRecordFwdDecl(Ty, RDContext);
3103 uint64_t Size = CGM.getContext().getTypeSize(Ty);
3104 auto Align = getDeclAlignIfRequired(D, CGM.getContext());
3106 SmallString<256> Identifier = getTypeIdentifier(Ty, CGM, TheCU);
3108 // Explicitly record the calling convention for C++ records.
3109 auto Flags = llvm::DINode::FlagZero;
3110 if (auto CXXRD = dyn_cast<CXXRecordDecl>(RD)) {
3111 if (CGM.getCXXABI().getRecordArgABI(CXXRD) == CGCXXABI::RAA_Indirect)
3112 Flags |= llvm::DINode::FlagTypePassByReference;
3114 Flags |= llvm::DINode::FlagTypePassByValue;
3116 // Record if a C++ record is non-trivial type.
3117 if (!CXXRD->isTrivial())
3118 Flags |= llvm::DINode::FlagNonTrivial;
3121 llvm::DICompositeType *RealDecl = DBuilder.createReplaceableCompositeType(
3122 getTagForRecord(RD), RDName, RDContext, DefUnit, Line, 0, Size, Align,
3125 // Elements of composite types usually have back to the type, creating
3126 // uniquing cycles. Distinct nodes are more efficient.
3127 switch (RealDecl->getTag()) {
3129 llvm_unreachable("invalid composite type tag");
3131 case llvm::dwarf::DW_TAG_array_type:
3132 case llvm::dwarf::DW_TAG_enumeration_type:
3133 // Array elements and most enumeration elements don't have back references,
3134 // so they don't tend to be involved in uniquing cycles and there is some
3135 // chance of merging them when linking together two modules. Only make
3136 // them distinct if they are ODR-uniqued.
3137 if (Identifier.empty())
3141 case llvm::dwarf::DW_TAG_structure_type:
3142 case llvm::dwarf::DW_TAG_union_type:
3143 case llvm::dwarf::DW_TAG_class_type:
3144 // Immediately resolve to a distinct node.
3146 llvm::MDNode::replaceWithDistinct(llvm::TempDICompositeType(RealDecl));
3150 RegionMap[Ty->getDecl()].reset(RealDecl);
3151 TypeCache[QualType(Ty, 0).getAsOpaquePtr()].reset(RealDecl);
3153 if (const auto *TSpecial = dyn_cast<ClassTemplateSpecializationDecl>(RD))
3154 DBuilder.replaceArrays(RealDecl, llvm::DINodeArray(),
3155 CollectCXXTemplateParams(TSpecial, DefUnit));
3159 void CGDebugInfo::CollectContainingType(const CXXRecordDecl *RD,
3160 llvm::DICompositeType *RealDecl) {
3161 // A class's primary base or the class itself contains the vtable.
3162 llvm::DICompositeType *ContainingType = nullptr;
3163 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
3164 if (const CXXRecordDecl *PBase = RL.getPrimaryBase()) {
3165 // Seek non-virtual primary base root.
3167 const ASTRecordLayout &BRL = CGM.getContext().getASTRecordLayout(PBase);
3168 const CXXRecordDecl *PBT = BRL.getPrimaryBase();
3169 if (PBT && !BRL.isPrimaryBaseVirtual())
3174 ContainingType = cast<llvm::DICompositeType>(
3175 getOrCreateType(QualType(PBase->getTypeForDecl(), 0),
3176 getOrCreateFile(RD->getLocation())));
3177 } else if (RD->isDynamicClass())
3178 ContainingType = RealDecl;
3180 DBuilder.replaceVTableHolder(RealDecl, ContainingType);
3183 llvm::DIType *CGDebugInfo::CreateMemberType(llvm::DIFile *Unit, QualType FType,
3184 StringRef Name, uint64_t *Offset) {
3185 llvm::DIType *FieldTy = CGDebugInfo::getOrCreateType(FType, Unit);
3186 uint64_t FieldSize = CGM.getContext().getTypeSize(FType);
3187 auto FieldAlign = getTypeAlignIfRequired(FType, CGM.getContext());
3189 DBuilder.createMemberType(Unit, Name, Unit, 0, FieldSize, FieldAlign,
3190 *Offset, llvm::DINode::FlagZero, FieldTy);
3191 *Offset += FieldSize;
3195 void CGDebugInfo::collectFunctionDeclProps(GlobalDecl GD, llvm::DIFile *Unit,
3197 StringRef &LinkageName,
3198 llvm::DIScope *&FDContext,
3199 llvm::DINodeArray &TParamsArray,
3200 llvm::DINode::DIFlags &Flags) {
3201 const auto *FD = cast<FunctionDecl>(GD.getDecl());
3202 Name = getFunctionName(FD);
3203 // Use mangled name as linkage name for C/C++ functions.
3204 if (FD->hasPrototype()) {
3205 LinkageName = CGM.getMangledName(GD);
3206 Flags |= llvm::DINode::FlagPrototyped;
3208 // No need to replicate the linkage name if it isn't different from the
3209 // subprogram name, no need to have it at all unless coverage is enabled or
3210 // debug is set to more than just line tables or extra debug info is needed.
3211 if (LinkageName == Name || (!CGM.getCodeGenOpts().EmitGcovArcs &&
3212 !CGM.getCodeGenOpts().EmitGcovNotes &&
3213 !CGM.getCodeGenOpts().DebugInfoForProfiling &&
3214 DebugKind <= codegenoptions::DebugLineTablesOnly))
3215 LinkageName = StringRef();
3217 if (DebugKind >= codegenoptions::LimitedDebugInfo) {
3218 if (const NamespaceDecl *NSDecl =
3219 dyn_cast_or_null<NamespaceDecl>(FD->getDeclContext()))
3220 FDContext = getOrCreateNamespace(NSDecl);
3221 else if (const RecordDecl *RDecl =
3222 dyn_cast_or_null<RecordDecl>(FD->getDeclContext())) {
3223 llvm::DIScope *Mod = getParentModuleOrNull(RDecl);
3224 FDContext = getContextDescriptor(RDecl, Mod ? Mod : TheCU);
3226 // Check if it is a noreturn-marked function
3227 if (FD->isNoReturn())
3228 Flags |= llvm::DINode::FlagNoReturn;
3229 // Collect template parameters.
3230 TParamsArray = CollectFunctionTemplateParams(FD, Unit);
3234 void CGDebugInfo::collectVarDeclProps(const VarDecl *VD, llvm::DIFile *&Unit,
3235 unsigned &LineNo, QualType &T,
3236 StringRef &Name, StringRef &LinkageName,
3237 llvm::MDTuple *&TemplateParameters,
3238 llvm::DIScope *&VDContext) {
3239 Unit = getOrCreateFile(VD->getLocation());
3240 LineNo = getLineNumber(VD->getLocation());
3242 setLocation(VD->getLocation());
3245 if (T->isIncompleteArrayType()) {
3246 // CodeGen turns int[] into int[1] so we'll do the same here.
3247 llvm::APInt ConstVal(32, 1);
3248 QualType ET = CGM.getContext().getAsArrayType(T)->getElementType();
3250 T = CGM.getContext().getConstantArrayType(ET, ConstVal, ArrayType::Normal,
3254 Name = VD->getName();
3255 if (VD->getDeclContext() && !isa<FunctionDecl>(VD->getDeclContext()) &&
3256 !isa<ObjCMethodDecl>(VD->getDeclContext()))
3257 LinkageName = CGM.getMangledName(VD);
3258 if (LinkageName == Name)
3259 LinkageName = StringRef();
3261 if (isa<VarTemplateSpecializationDecl>(VD)) {
3262 llvm::DINodeArray parameterNodes = CollectVarTemplateParams(VD, &*Unit);
3263 TemplateParameters = parameterNodes.get();
3265 TemplateParameters = nullptr;
3268 // Since we emit declarations (DW_AT_members) for static members, place the
3269 // definition of those static members in the namespace they were declared in
3270 // in the source code (the lexical decl context).
3271 // FIXME: Generalize this for even non-member global variables where the
3272 // declaration and definition may have different lexical decl contexts, once
3273 // we have support for emitting declarations of (non-member) global variables.
3274 const DeclContext *DC = VD->isStaticDataMember() ? VD->getLexicalDeclContext()
3275 : VD->getDeclContext();
3276 // When a record type contains an in-line initialization of a static data
3277 // member, and the record type is marked as __declspec(dllexport), an implicit
3278 // definition of the member will be created in the record context. DWARF
3279 // doesn't seem to have a nice way to describe this in a form that consumers
3280 // are likely to understand, so fake the "normal" situation of a definition
3281 // outside the class by putting it in the global scope.
3283 DC = CGM.getContext().getTranslationUnitDecl();
3285 llvm::DIScope *Mod = getParentModuleOrNull(VD);
3286 VDContext = getContextDescriptor(cast<Decl>(DC), Mod ? Mod : TheCU);
3289 llvm::DISubprogram *CGDebugInfo::getFunctionFwdDeclOrStub(GlobalDecl GD,
3291 llvm::DINodeArray TParamsArray;
3292 StringRef Name, LinkageName;
3293 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
3294 llvm::DISubprogram::DISPFlags SPFlags = llvm::DISubprogram::SPFlagZero;
3295 SourceLocation Loc = GD.getDecl()->getLocation();
3296 llvm::DIFile *Unit = getOrCreateFile(Loc);
3297 llvm::DIScope *DContext = Unit;
3298 unsigned Line = getLineNumber(Loc);
3299 collectFunctionDeclProps(GD, Unit, Name, LinkageName, DContext, TParamsArray,
3301 auto *FD = dyn_cast<FunctionDecl>(GD.getDecl());
3303 // Build function type.
3304 SmallVector<QualType, 16> ArgTypes;
3306 for (const ParmVarDecl *Parm : FD->parameters())
3307 ArgTypes.push_back(Parm->getType());
3308 CallingConv CC = FD->getType()->castAs<FunctionType>()->getCallConv();
3309 QualType FnType = CGM.getContext().getFunctionType(
3310 FD->getReturnType(), ArgTypes, FunctionProtoType::ExtProtoInfo(CC));
3311 if (!FD->isExternallyVisible())
3312 SPFlags |= llvm::DISubprogram::SPFlagLocalToUnit;
3313 if (CGM.getLangOpts().Optimize)
3314 SPFlags |= llvm::DISubprogram::SPFlagOptimized;
3317 Flags |= getCallSiteRelatedAttrs();
3318 SPFlags |= llvm::DISubprogram::SPFlagDefinition;
3319 return DBuilder.createFunction(
3320 DContext, Name, LinkageName, Unit, Line,
3321 getOrCreateFunctionType(GD.getDecl(), FnType, Unit), 0, Flags, SPFlags,
3322 TParamsArray.get(), getFunctionDeclaration(FD));
3325 llvm::DISubprogram *SP = DBuilder.createTempFunctionFwdDecl(
3326 DContext, Name, LinkageName, Unit, Line,
3327 getOrCreateFunctionType(GD.getDecl(), FnType, Unit), 0, Flags, SPFlags,
3328 TParamsArray.get(), getFunctionDeclaration(FD));
3329 const FunctionDecl *CanonDecl = FD->getCanonicalDecl();
3330 FwdDeclReplaceMap.emplace_back(std::piecewise_construct,
3331 std::make_tuple(CanonDecl),
3332 std::make_tuple(SP));
3336 llvm::DISubprogram *CGDebugInfo::getFunctionForwardDeclaration(GlobalDecl GD) {
3337 return getFunctionFwdDeclOrStub(GD, /* Stub = */ false);
3340 llvm::DISubprogram *CGDebugInfo::getFunctionStub(GlobalDecl GD) {
3341 return getFunctionFwdDeclOrStub(GD, /* Stub = */ true);
3344 llvm::DIGlobalVariable *
3345 CGDebugInfo::getGlobalVariableForwardDeclaration(const VarDecl *VD) {
3347 StringRef Name, LinkageName;
3348 SourceLocation Loc = VD->getLocation();
3349 llvm::DIFile *Unit = getOrCreateFile(Loc);
3350 llvm::DIScope *DContext = Unit;
3351 unsigned Line = getLineNumber(Loc);
3352 llvm::MDTuple *TemplateParameters = nullptr;
3354 collectVarDeclProps(VD, Unit, Line, T, Name, LinkageName, TemplateParameters,
3356 auto Align = getDeclAlignIfRequired(VD, CGM.getContext());
3357 auto *GV = DBuilder.createTempGlobalVariableFwdDecl(
3358 DContext, Name, LinkageName, Unit, Line, getOrCreateType(T, Unit),
3359 !VD->isExternallyVisible(), nullptr, TemplateParameters, Align);
3360 FwdDeclReplaceMap.emplace_back(
3361 std::piecewise_construct,
3362 std::make_tuple(cast<VarDecl>(VD->getCanonicalDecl())),
3363 std::make_tuple(static_cast<llvm::Metadata *>(GV)));
3367 llvm::DINode *CGDebugInfo::getDeclarationOrDefinition(const Decl *D) {
3368 // We only need a declaration (not a definition) of the type - so use whatever
3369 // we would otherwise do to get a type for a pointee. (forward declarations in
3370 // limited debug info, full definitions (if the type definition is available)
3371 // in unlimited debug info)
3372 if (const auto *TD = dyn_cast<TypeDecl>(D))
3373 return getOrCreateType(CGM.getContext().getTypeDeclType(TD),
3374 getOrCreateFile(TD->getLocation()));
3375 auto I = DeclCache.find(D->getCanonicalDecl());
3377 if (I != DeclCache.end()) {
3379 if (auto *GVE = dyn_cast_or_null<llvm::DIGlobalVariableExpression>(N))
3380 return GVE->getVariable();
3381 return dyn_cast_or_null<llvm::DINode>(N);
3384 // No definition for now. Emit a forward definition that might be
3385 // merged with a potential upcoming definition.
3386 if (const auto *FD = dyn_cast<FunctionDecl>(D))
3387 return getFunctionForwardDeclaration(FD);
3388 else if (const auto *VD = dyn_cast<VarDecl>(D))
3389 return getGlobalVariableForwardDeclaration(VD);
3394 llvm::DISubprogram *CGDebugInfo::getFunctionDeclaration(const Decl *D) {
3395 if (!D || DebugKind <= codegenoptions::DebugLineTablesOnly)
3398 const auto *FD = dyn_cast<FunctionDecl>(D);
3403 auto *S = getDeclContextDescriptor(D);
3405 auto MI = SPCache.find(FD->getCanonicalDecl());
3406 if (MI == SPCache.end()) {
3407 if (const auto *MD = dyn_cast<CXXMethodDecl>(FD->getCanonicalDecl())) {
3408 return CreateCXXMemberFunction(MD, getOrCreateFile(MD->getLocation()),
3409 cast<llvm::DICompositeType>(S));
3412 if (MI != SPCache.end()) {
3413 auto *SP = dyn_cast_or_null<llvm::DISubprogram>(MI->second);
3414 if (SP && !SP->isDefinition())
3418 for (auto NextFD : FD->redecls()) {
3419 auto MI = SPCache.find(NextFD->getCanonicalDecl());
3420 if (MI != SPCache.end()) {
3421 auto *SP = dyn_cast_or_null<llvm::DISubprogram>(MI->second);
3422 if (SP && !SP->isDefinition())
3429 // getOrCreateFunctionType - Construct type. If it is a c++ method, include
3430 // implicit parameter "this".
3431 llvm::DISubroutineType *CGDebugInfo::getOrCreateFunctionType(const Decl *D,
3434 if (!D || DebugKind <= codegenoptions::DebugLineTablesOnly)
3435 // Create fake but valid subroutine type. Otherwise -verify would fail, and
3436 // subprogram DIE will miss DW_AT_decl_file and DW_AT_decl_line fields.
3437 return DBuilder.createSubroutineType(DBuilder.getOrCreateTypeArray(None));
3439 if (const auto *Method = dyn_cast<CXXMethodDecl>(D))
3440 return getOrCreateMethodType(Method, F);
3442 const auto *FTy = FnType->getAs<FunctionType>();
3443 CallingConv CC = FTy ? FTy->getCallConv() : CallingConv::CC_C;
3445 if (const auto *OMethod = dyn_cast<ObjCMethodDecl>(D)) {
3446 // Add "self" and "_cmd"
3447 SmallVector<llvm::Metadata *, 16> Elts;
3449 // First element is always return type. For 'void' functions it is NULL.
3450 QualType ResultTy = OMethod->getReturnType();
3452 // Replace the instancetype keyword with the actual type.
3453 if (ResultTy == CGM.getContext().getObjCInstanceType())
3454 ResultTy = CGM.getContext().getPointerType(
3455 QualType(OMethod->getClassInterface()->getTypeForDecl(), 0));
3457 Elts.push_back(getOrCreateType(ResultTy, F));
3458 // "self" pointer is always first argument.
3459 QualType SelfDeclTy;
3460 if (auto *SelfDecl = OMethod->getSelfDecl())
3461 SelfDeclTy = SelfDecl->getType();
3462 else if (auto *FPT = dyn_cast<FunctionProtoType>(FnType))
3463 if (FPT->getNumParams() > 1)
3464 SelfDeclTy = FPT->getParamType(0);
3465 if (!SelfDeclTy.isNull())
3467 CreateSelfType(SelfDeclTy, getOrCreateType(SelfDeclTy, F)));
3468 // "_cmd" pointer is always second argument.
3469 Elts.push_back(DBuilder.createArtificialType(
3470 getOrCreateType(CGM.getContext().getObjCSelType(), F)));
3471 // Get rest of the arguments.
3472 for (const auto *PI : OMethod->parameters())
3473 Elts.push_back(getOrCreateType(PI->getType(), F));
3474 // Variadic methods need a special marker at the end of the type list.
3475 if (OMethod->isVariadic())
3476 Elts.push_back(DBuilder.createUnspecifiedParameter());
3478 llvm::DITypeRefArray EltTypeArray = DBuilder.getOrCreateTypeArray(Elts);
3479 return DBuilder.createSubroutineType(EltTypeArray, llvm::DINode::FlagZero,
3483 // Handle variadic function types; they need an additional
3484 // unspecified parameter.
3485 if (const auto *FD = dyn_cast<FunctionDecl>(D))
3486 if (FD->isVariadic()) {
3487 SmallVector<llvm::Metadata *, 16> EltTys;
3488 EltTys.push_back(getOrCreateType(FD->getReturnType(), F));
3489 if (const auto *FPT = dyn_cast<FunctionProtoType>(FnType))
3490 for (QualType ParamType : FPT->param_types())
3491 EltTys.push_back(getOrCreateType(ParamType, F));
3492 EltTys.push_back(DBuilder.createUnspecifiedParameter());
3493 llvm::DITypeRefArray EltTypeArray = DBuilder.getOrCreateTypeArray(EltTys);
3494 return DBuilder.createSubroutineType(EltTypeArray, llvm::DINode::FlagZero,
3498 return cast<llvm::DISubroutineType>(getOrCreateType(FnType, F));
3501 void CGDebugInfo::EmitFunctionStart(GlobalDecl GD, SourceLocation Loc,
3502 SourceLocation ScopeLoc, QualType FnType,
3503 llvm::Function *Fn, bool CurFuncIsThunk,
3504 CGBuilderTy &Builder) {
3507 StringRef LinkageName;
3509 FnBeginRegionCount.push_back(LexicalBlockStack.size());
3511 const Decl *D = GD.getDecl();
3512 bool HasDecl = (D != nullptr);
3514 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
3515 llvm::DISubprogram::DISPFlags SPFlags = llvm::DISubprogram::SPFlagZero;
3516 llvm::DIFile *Unit = getOrCreateFile(Loc);
3517 llvm::DIScope *FDContext = Unit;
3518 llvm::DINodeArray TParamsArray;
3520 // Use llvm function name.
3521 LinkageName = Fn->getName();
3522 } else if (const auto *FD = dyn_cast<FunctionDecl>(D)) {
3523 // If there is a subprogram for this function available then use it.
3524 auto FI = SPCache.find(FD->getCanonicalDecl());
3525 if (FI != SPCache.end()) {
3526 auto *SP = dyn_cast_or_null<llvm::DISubprogram>(FI->second);
3527 if (SP && SP->isDefinition()) {
3528 LexicalBlockStack.emplace_back(SP);
3529 RegionMap[D].reset(SP);
3533 collectFunctionDeclProps(GD, Unit, Name, LinkageName, FDContext,
3534 TParamsArray, Flags);
3535 } else if (const auto *OMD = dyn_cast<ObjCMethodDecl>(D)) {
3536 Name = getObjCMethodName(OMD);
3537 Flags |= llvm::DINode::FlagPrototyped;
3538 } else if (isa<VarDecl>(D) &&
3539 GD.getDynamicInitKind() != DynamicInitKind::NoStub) {
3540 // This is a global initializer or atexit destructor for a global variable.
3541 Name = getDynamicInitializerName(cast<VarDecl>(D), GD.getDynamicInitKind(),
3544 // Use llvm function name.
3545 Name = Fn->getName();
3546 Flags |= llvm::DINode::FlagPrototyped;
3548 if (Name.startswith("\01"))
3549 Name = Name.substr(1);
3551 if (!HasDecl || D->isImplicit() || D->hasAttr<ArtificialAttr>()) {
3552 Flags |= llvm::DINode::FlagArtificial;
3553 // Artificial functions should not silently reuse CurLoc.
3554 CurLoc = SourceLocation();
3558 Flags |= llvm::DINode::FlagThunk;
3560 if (Fn->hasLocalLinkage())
3561 SPFlags |= llvm::DISubprogram::SPFlagLocalToUnit;
3562 if (CGM.getLangOpts().Optimize)
3563 SPFlags |= llvm::DISubprogram::SPFlagOptimized;
3565 llvm::DINode::DIFlags FlagsForDef = Flags | getCallSiteRelatedAttrs();
3566 llvm::DISubprogram::DISPFlags SPFlagsForDef =
3567 SPFlags | llvm::DISubprogram::SPFlagDefinition;
3569 unsigned LineNo = getLineNumber(Loc);
3570 unsigned ScopeLine = getLineNumber(ScopeLoc);
3572 // FIXME: The function declaration we're constructing here is mostly reusing
3573 // declarations from CXXMethodDecl and not constructing new ones for arbitrary
3574 // FunctionDecls. When/if we fix this we can have FDContext be TheCU/null for
3575 // all subprograms instead of the actual context since subprogram definitions
3576 // are emitted as CU level entities by the backend.
3577 llvm::DISubprogram *SP = DBuilder.createFunction(
3578 FDContext, Name, LinkageName, Unit, LineNo,
3579 getOrCreateFunctionType(D, FnType, Unit), ScopeLine, FlagsForDef,
3580 SPFlagsForDef, TParamsArray.get(), getFunctionDeclaration(D));
3581 Fn->setSubprogram(SP);
3582 // We might get here with a VarDecl in the case we're generating
3583 // code for the initialization of globals. Do not record these decls
3584 // as they will overwrite the actual VarDecl Decl in the cache.
3585 if (HasDecl && isa<FunctionDecl>(D))
3586 DeclCache[D->getCanonicalDecl()].reset(SP);
3588 // We use the SPDefCache only in the case when the debug entry values option
3589 // is set, in order to speed up parameters modification analysis.
3591 // FIXME: Use AbstractCallee here to support ObjCMethodDecl.
3592 if (CGM.getCodeGenOpts().EnableDebugEntryValues && HasDecl)
3593 if (auto *FD = dyn_cast<FunctionDecl>(D))
3594 if (FD->hasBody() && !FD->param_empty())
3595 SPDefCache[FD].reset(SP);
3597 if (CGM.getCodeGenOpts().DwarfVersion >= 5) {
3598 // Starting with DWARF V5 method declarations are emitted as children of
3599 // the interface type.
3600 if (const auto *OMD = dyn_cast_or_null<ObjCMethodDecl>(D)) {
3601 const ObjCInterfaceDecl *ID = OMD->getClassInterface();
3602 QualType QTy(ID->getTypeForDecl(), 0);
3603 auto It = TypeCache.find(QTy.getAsOpaquePtr());
3604 if (It != TypeCache.end()) {
3605 llvm::DICompositeType *InterfaceDecl =
3606 cast<llvm::DICompositeType>(It->second);
3607 llvm::DISubprogram *FD = DBuilder.createFunction(
3608 InterfaceDecl, Name, LinkageName, Unit, LineNo,
3609 getOrCreateFunctionType(D, FnType, Unit), ScopeLine, Flags, SPFlags,
3610 TParamsArray.get());
3611 DBuilder.finalizeSubprogram(FD);
3612 ObjCMethodCache[ID].push_back(FD);
3617 // Push the function onto the lexical block stack.
3618 LexicalBlockStack.emplace_back(SP);
3621 RegionMap[D].reset(SP);
3624 void CGDebugInfo::EmitFunctionDecl(GlobalDecl GD, SourceLocation Loc,
3625 QualType FnType, llvm::Function *Fn) {
3627 StringRef LinkageName;
3629 const Decl *D = GD.getDecl();
3633 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
3634 llvm::DIFile *Unit = getOrCreateFile(Loc);
3635 bool IsDeclForCallSite = Fn ? true : false;
3636 llvm::DIScope *FDContext =
3637 IsDeclForCallSite ? Unit : getDeclContextDescriptor(D);
3638 llvm::DINodeArray TParamsArray;
3639 if (isa<FunctionDecl>(D)) {
3640 // If there is a DISubprogram for this function available then use it.
3641 collectFunctionDeclProps(GD, Unit, Name, LinkageName, FDContext,
3642 TParamsArray, Flags);
3643 } else if (const auto *OMD = dyn_cast<ObjCMethodDecl>(D)) {
3644 Name = getObjCMethodName(OMD);
3645 Flags |= llvm::DINode::FlagPrototyped;
3647 llvm_unreachable("not a function or ObjC method");
3649 if (!Name.empty() && Name[0] == '\01')
3650 Name = Name.substr(1);
3652 if (D->isImplicit()) {
3653 Flags |= llvm::DINode::FlagArtificial;
3654 // Artificial functions without a location should not silently reuse CurLoc.
3655 if (Loc.isInvalid())
3656 CurLoc = SourceLocation();
3658 unsigned LineNo = getLineNumber(Loc);
3659 unsigned ScopeLine = 0;
3660 llvm::DISubprogram::DISPFlags SPFlags = llvm::DISubprogram::SPFlagZero;
3661 if (CGM.getLangOpts().Optimize)
3662 SPFlags |= llvm::DISubprogram::SPFlagOptimized;
3664 llvm::DISubprogram *SP = DBuilder.createFunction(
3665 FDContext, Name, LinkageName, Unit, LineNo,
3666 getOrCreateFunctionType(D, FnType, Unit), ScopeLine, Flags, SPFlags,
3667 TParamsArray.get(), getFunctionDeclaration(D));
3669 if (IsDeclForCallSite)
3670 Fn->setSubprogram(SP);
3672 DBuilder.retainType(SP);
3675 void CGDebugInfo::EmitFuncDeclForCallSite(llvm::CallBase *CallOrInvoke,
3676 QualType CalleeType,
3677 const FunctionDecl *CalleeDecl) {
3678 auto &CGOpts = CGM.getCodeGenOpts();
3679 if (!CGOpts.EnableDebugEntryValues || !CGM.getLangOpts().Optimize ||
3681 CGM.getCodeGenOpts().getDebugInfo() < codegenoptions::LimitedDebugInfo)
3684 auto *Func = CallOrInvoke->getCalledFunction();
3688 // If there is no DISubprogram attached to the function being called,
3689 // create the one describing the function in order to have complete
3690 // call site debug info.
3691 if (Func->getSubprogram())
3694 if (!CalleeDecl->isStatic() && !CalleeDecl->isInlined())
3695 EmitFunctionDecl(CalleeDecl, CalleeDecl->getLocation(), CalleeType, Func);
3698 void CGDebugInfo::EmitInlineFunctionStart(CGBuilderTy &Builder, GlobalDecl GD) {
3699 const auto *FD = cast<FunctionDecl>(GD.getDecl());
3700 // If there is a subprogram for this function available then use it.
3701 auto FI = SPCache.find(FD->getCanonicalDecl());
3702 llvm::DISubprogram *SP = nullptr;
3703 if (FI != SPCache.end())
3704 SP = dyn_cast_or_null<llvm::DISubprogram>(FI->second);
3705 if (!SP || !SP->isDefinition())
3706 SP = getFunctionStub(GD);
3707 FnBeginRegionCount.push_back(LexicalBlockStack.size());
3708 LexicalBlockStack.emplace_back(SP);
3709 setInlinedAt(Builder.getCurrentDebugLocation());
3710 EmitLocation(Builder, FD->getLocation());
3713 void CGDebugInfo::EmitInlineFunctionEnd(CGBuilderTy &Builder) {
3714 assert(CurInlinedAt && "unbalanced inline scope stack");
3715 EmitFunctionEnd(Builder, nullptr);
3716 setInlinedAt(llvm::DebugLoc(CurInlinedAt).getInlinedAt());
3719 void CGDebugInfo::EmitLocation(CGBuilderTy &Builder, SourceLocation Loc) {
3720 // Update our current location
3723 if (CurLoc.isInvalid() || CurLoc.isMacroID() || LexicalBlockStack.empty())
3726 llvm::MDNode *Scope = LexicalBlockStack.back();
3727 Builder.SetCurrentDebugLocation(llvm::DebugLoc::get(
3728 getLineNumber(CurLoc), getColumnNumber(CurLoc), Scope, CurInlinedAt));
3731 void CGDebugInfo::CreateLexicalBlock(SourceLocation Loc) {
3732 llvm::MDNode *Back = nullptr;
3733 if (!LexicalBlockStack.empty())
3734 Back = LexicalBlockStack.back().get();
3735 LexicalBlockStack.emplace_back(DBuilder.createLexicalBlock(
3736 cast<llvm::DIScope>(Back), getOrCreateFile(CurLoc), getLineNumber(CurLoc),
3737 getColumnNumber(CurLoc)));
3740 void CGDebugInfo::AppendAddressSpaceXDeref(
3741 unsigned AddressSpace, SmallVectorImpl<int64_t> &Expr) const {
3742 Optional<unsigned> DWARFAddressSpace =
3743 CGM.getTarget().getDWARFAddressSpace(AddressSpace);
3744 if (!DWARFAddressSpace)
3747 Expr.push_back(llvm::dwarf::DW_OP_constu);
3748 Expr.push_back(DWARFAddressSpace.getValue());
3749 Expr.push_back(llvm::dwarf::DW_OP_swap);
3750 Expr.push_back(llvm::dwarf::DW_OP_xderef);
3753 void CGDebugInfo::EmitLexicalBlockStart(CGBuilderTy &Builder,
3754 SourceLocation Loc) {
3755 // Set our current location.
3758 // Emit a line table change for the current location inside the new scope.
3759 Builder.SetCurrentDebugLocation(
3760 llvm::DebugLoc::get(getLineNumber(Loc), getColumnNumber(Loc),
3761 LexicalBlockStack.back(), CurInlinedAt));
3763 if (DebugKind <= codegenoptions::DebugLineTablesOnly)
3766 // Create a new lexical block and push it on the stack.
3767 CreateLexicalBlock(Loc);
3770 void CGDebugInfo::EmitLexicalBlockEnd(CGBuilderTy &Builder,
3771 SourceLocation Loc) {
3772 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
3774 // Provide an entry in the line table for the end of the block.
3775 EmitLocation(Builder, Loc);
3777 if (DebugKind <= codegenoptions::DebugLineTablesOnly)
3780 LexicalBlockStack.pop_back();
3783 void CGDebugInfo::EmitFunctionEnd(CGBuilderTy &Builder, llvm::Function *Fn) {
3784 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
3785 unsigned RCount = FnBeginRegionCount.back();
3786 assert(RCount <= LexicalBlockStack.size() && "Region stack mismatch");
3788 // Pop all regions for this function.
3789 while (LexicalBlockStack.size() != RCount) {
3790 // Provide an entry in the line table for the end of the block.
3791 EmitLocation(Builder, CurLoc);
3792 LexicalBlockStack.pop_back();
3794 FnBeginRegionCount.pop_back();
3796 if (Fn && Fn->getSubprogram())
3797 DBuilder.finalizeSubprogram(Fn->getSubprogram());
3800 CGDebugInfo::BlockByRefType
3801 CGDebugInfo::EmitTypeForVarWithBlocksAttr(const VarDecl *VD,
3802 uint64_t *XOffset) {
3803 SmallVector<llvm::Metadata *, 5> EltTys;
3805 uint64_t FieldSize, FieldOffset;
3806 uint32_t FieldAlign;
3808 llvm::DIFile *Unit = getOrCreateFile(VD->getLocation());
3809 QualType Type = VD->getType();
3812 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
3813 EltTys.push_back(CreateMemberType(Unit, FType, "__isa", &FieldOffset));
3814 EltTys.push_back(CreateMemberType(Unit, FType, "__forwarding", &FieldOffset));
3815 FType = CGM.getContext().IntTy;
3816 EltTys.push_back(CreateMemberType(Unit, FType, "__flags", &FieldOffset));
3817 EltTys.push_back(CreateMemberType(Unit, FType, "__size", &FieldOffset));
3819 bool HasCopyAndDispose = CGM.getContext().BlockRequiresCopying(Type, VD);
3820 if (HasCopyAndDispose) {
3821 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
3823 CreateMemberType(Unit, FType, "__copy_helper", &FieldOffset));
3825 CreateMemberType(Unit, FType, "__destroy_helper", &FieldOffset));
3827 bool HasByrefExtendedLayout;
3828 Qualifiers::ObjCLifetime Lifetime;
3829 if (CGM.getContext().getByrefLifetime(Type, Lifetime,
3830 HasByrefExtendedLayout) &&
3831 HasByrefExtendedLayout) {
3832 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
3834 CreateMemberType(Unit, FType, "__byref_variable_layout", &FieldOffset));
3837 CharUnits Align = CGM.getContext().getDeclAlign(VD);
3838 if (Align > CGM.getContext().toCharUnitsFromBits(
3839 CGM.getTarget().getPointerAlign(0))) {
3840 CharUnits FieldOffsetInBytes =
3841 CGM.getContext().toCharUnitsFromBits(FieldOffset);
3842 CharUnits AlignedOffsetInBytes = FieldOffsetInBytes.alignTo(Align);
3843 CharUnits NumPaddingBytes = AlignedOffsetInBytes - FieldOffsetInBytes;
3845 if (NumPaddingBytes.isPositive()) {
3846 llvm::APInt pad(32, NumPaddingBytes.getQuantity());
3847 FType = CGM.getContext().getConstantArrayType(CGM.getContext().CharTy,
3848 pad, ArrayType::Normal, 0);
3849 EltTys.push_back(CreateMemberType(Unit, FType, "", &FieldOffset));
3854 llvm::DIType *WrappedTy = getOrCreateType(FType, Unit);
3855 FieldSize = CGM.getContext().getTypeSize(FType);
3856 FieldAlign = CGM.getContext().toBits(Align);
3858 *XOffset = FieldOffset;
3859 llvm::DIType *FieldTy = DBuilder.createMemberType(
3860 Unit, VD->getName(), Unit, 0, FieldSize, FieldAlign, FieldOffset,
3861 llvm::DINode::FlagZero, WrappedTy);
3862 EltTys.push_back(FieldTy);
3863 FieldOffset += FieldSize;
3865 llvm::DINodeArray Elements = DBuilder.getOrCreateArray(EltTys);
3866 return {DBuilder.createStructType(Unit, "", Unit, 0, FieldOffset, 0,
3867 llvm::DINode::FlagZero, nullptr, Elements),
3871 llvm::DILocalVariable *CGDebugInfo::EmitDeclare(const VarDecl *VD,
3872 llvm::Value *Storage,
3873 llvm::Optional<unsigned> ArgNo,
3874 CGBuilderTy &Builder,
3875 const bool UsePointerValue) {
3876 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
3877 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
3878 if (VD->hasAttr<NoDebugAttr>())
3882 VD->isImplicit() || (isa<Decl>(VD->getDeclContext()) &&
3883 cast<Decl>(VD->getDeclContext())->isImplicit());
3884 llvm::DIFile *Unit = nullptr;
3886 Unit = getOrCreateFile(VD->getLocation());
3888 uint64_t XOffset = 0;
3889 if (VD->hasAttr<BlocksAttr>())
3890 Ty = EmitTypeForVarWithBlocksAttr(VD, &XOffset).WrappedType;
3892 Ty = getOrCreateType(VD->getType(), Unit);
3894 // If there is no debug info for this type then do not emit debug info
3895 // for this variable.
3899 // Get location information.
3901 unsigned Column = 0;
3903 Line = getLineNumber(VD->getLocation());
3904 Column = getColumnNumber(VD->getLocation());
3906 SmallVector<int64_t, 13> Expr;
3907 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
3908 if (VD->isImplicit())
3909 Flags |= llvm::DINode::FlagArtificial;
3911 auto Align = getDeclAlignIfRequired(VD, CGM.getContext());
3913 unsigned AddressSpace = CGM.getContext().getTargetAddressSpace(VD->getType());
3914 AppendAddressSpaceXDeref(AddressSpace, Expr);
3916 // If this is implicit parameter of CXXThis or ObjCSelf kind, then give it an
3917 // object pointer flag.
3918 if (const auto *IPD = dyn_cast<ImplicitParamDecl>(VD)) {
3919 if (IPD->getParameterKind() == ImplicitParamDecl::CXXThis ||
3920 IPD->getParameterKind() == ImplicitParamDecl::ObjCSelf)
3921 Flags |= llvm::DINode::FlagObjectPointer;
3924 // Note: Older versions of clang used to emit byval references with an extra
3925 // DW_OP_deref, because they referenced the IR arg directly instead of
3926 // referencing an alloca. Newer versions of LLVM don't treat allocas
3927 // differently from other function arguments when used in a dbg.declare.
3928 auto *Scope = cast<llvm::DIScope>(LexicalBlockStack.back());
3929 StringRef Name = VD->getName();
3930 if (!Name.empty()) {
3931 if (VD->hasAttr<BlocksAttr>()) {
3932 // Here, we need an offset *into* the alloca.
3933 CharUnits offset = CharUnits::fromQuantity(32);
3934 Expr.push_back(llvm::dwarf::DW_OP_plus_uconst);
3935 // offset of __forwarding field
3936 offset = CGM.getContext().toCharUnitsFromBits(
3937 CGM.getTarget().getPointerWidth(0));
3938 Expr.push_back(offset.getQuantity());
3939 Expr.push_back(llvm::dwarf::DW_OP_deref);
3940 Expr.push_back(llvm::dwarf::DW_OP_plus_uconst);
3941 // offset of x field
3942 offset = CGM.getContext().toCharUnitsFromBits(XOffset);
3943 Expr.push_back(offset.getQuantity());
3945 } else if (const auto *RT = dyn_cast<RecordType>(VD->getType())) {
3946 // If VD is an anonymous union then Storage represents value for
3947 // all union fields.
3948 const RecordDecl *RD = RT->getDecl();
3949 if (RD->isUnion() && RD->isAnonymousStructOrUnion()) {
3950 // GDB has trouble finding local variables in anonymous unions, so we emit
3951 // artificial local variables for each of the members.
3953 // FIXME: Remove this code as soon as GDB supports this.
3954 // The debug info verifier in LLVM operates based on the assumption that a
3955 // variable has the same size as its storage and we had to disable the
3956 // check for artificial variables.
3957 for (const auto *Field : RD->fields()) {
3958 llvm::DIType *FieldTy = getOrCreateType(Field->getType(), Unit);
3959 StringRef FieldName = Field->getName();
3961 // Ignore unnamed fields. Do not ignore unnamed records.
3962 if (FieldName.empty() && !isa<RecordType>(Field->getType()))
3965 // Use VarDecl's Tag, Scope and Line number.
3966 auto FieldAlign = getDeclAlignIfRequired(Field, CGM.getContext());
3967 auto *D = DBuilder.createAutoVariable(
3968 Scope, FieldName, Unit, Line, FieldTy, CGM.getLangOpts().Optimize,
3969 Flags | llvm::DINode::FlagArtificial, FieldAlign);
3971 // Insert an llvm.dbg.declare into the current block.
3972 DBuilder.insertDeclare(
3973 Storage, D, DBuilder.createExpression(Expr),
3974 llvm::DebugLoc::get(Line, Column, Scope, CurInlinedAt),
3975 Builder.GetInsertBlock());
3980 // Clang stores the sret pointer provided by the caller in a static alloca.
3981 // Use DW_OP_deref to tell the debugger to load the pointer and treat it as
3982 // the address of the variable.
3983 if (UsePointerValue) {
3984 assert(std::find(Expr.begin(), Expr.end(), llvm::dwarf::DW_OP_deref) ==
3986 "Debug info already contains DW_OP_deref.");
3987 Expr.push_back(llvm::dwarf::DW_OP_deref);
3990 // Create the descriptor for the variable.
3991 auto *D = ArgNo ? DBuilder.createParameterVariable(
3992 Scope, Name, *ArgNo, Unit, Line, Ty,
3993 CGM.getLangOpts().Optimize, Flags)
3994 : DBuilder.createAutoVariable(Scope, Name, Unit, Line, Ty,
3995 CGM.getLangOpts().Optimize,
3998 // Insert an llvm.dbg.declare into the current block.
3999 DBuilder.insertDeclare(Storage, D, DBuilder.createExpression(Expr),
4000 llvm::DebugLoc::get(Line, Column, Scope, CurInlinedAt),
4001 Builder.GetInsertBlock());
4003 if (CGM.getCodeGenOpts().EnableDebugEntryValues && ArgNo) {
4004 if (auto *PD = dyn_cast<ParmVarDecl>(VD))
4005 ParamCache[PD].reset(D);
4011 llvm::DILocalVariable *
4012 CGDebugInfo::EmitDeclareOfAutoVariable(const VarDecl *VD, llvm::Value *Storage,
4013 CGBuilderTy &Builder,
4014 const bool UsePointerValue) {
4015 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
4016 return EmitDeclare(VD, Storage, llvm::None, Builder, UsePointerValue);
4019 void CGDebugInfo::EmitLabel(const LabelDecl *D, CGBuilderTy &Builder) {
4020 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
4021 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
4023 if (D->hasAttr<NoDebugAttr>())
4026 auto *Scope = cast<llvm::DIScope>(LexicalBlockStack.back());
4027 llvm::DIFile *Unit = getOrCreateFile(D->getLocation());
4029 // Get location information.
4030 unsigned Line = getLineNumber(D->getLocation());
4031 unsigned Column = getColumnNumber(D->getLocation());
4033 StringRef Name = D->getName();
4035 // Create the descriptor for the label.
4037 DBuilder.createLabel(Scope, Name, Unit, Line, CGM.getLangOpts().Optimize);
4039 // Insert an llvm.dbg.label into the current block.
4040 DBuilder.insertLabel(L,
4041 llvm::DebugLoc::get(Line, Column, Scope, CurInlinedAt),
4042 Builder.GetInsertBlock());
4045 llvm::DIType *CGDebugInfo::CreateSelfType(const QualType &QualTy,
4047 llvm::DIType *CachedTy = getTypeOrNull(QualTy);
4050 return DBuilder.createObjectPointerType(Ty);
4053 void CGDebugInfo::EmitDeclareOfBlockDeclRefVariable(
4054 const VarDecl *VD, llvm::Value *Storage, CGBuilderTy &Builder,
4055 const CGBlockInfo &blockInfo, llvm::Instruction *InsertPoint) {
4056 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
4057 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
4059 if (Builder.GetInsertBlock() == nullptr)
4061 if (VD->hasAttr<NoDebugAttr>())
4064 bool isByRef = VD->hasAttr<BlocksAttr>();
4066 uint64_t XOffset = 0;
4067 llvm::DIFile *Unit = getOrCreateFile(VD->getLocation());
4070 Ty = EmitTypeForVarWithBlocksAttr(VD, &XOffset).WrappedType;
4072 Ty = getOrCreateType(VD->getType(), Unit);
4074 // Self is passed along as an implicit non-arg variable in a
4075 // block. Mark it as the object pointer.
4076 if (const auto *IPD = dyn_cast<ImplicitParamDecl>(VD))
4077 if (IPD->getParameterKind() == ImplicitParamDecl::ObjCSelf)
4078 Ty = CreateSelfType(VD->getType(), Ty);
4080 // Get location information.
4081 unsigned Line = getLineNumber(VD->getLocation());
4082 unsigned Column = getColumnNumber(VD->getLocation());
4084 const llvm::DataLayout &target = CGM.getDataLayout();
4086 CharUnits offset = CharUnits::fromQuantity(
4087 target.getStructLayout(blockInfo.StructureType)
4088 ->getElementOffset(blockInfo.getCapture(VD).getIndex()));
4090 SmallVector<int64_t, 9> addr;
4091 addr.push_back(llvm::dwarf::DW_OP_deref);
4092 addr.push_back(llvm::dwarf::DW_OP_plus_uconst);
4093 addr.push_back(offset.getQuantity());
4095 addr.push_back(llvm::dwarf::DW_OP_deref);
4096 addr.push_back(llvm::dwarf::DW_OP_plus_uconst);
4097 // offset of __forwarding field
4099 CGM.getContext().toCharUnitsFromBits(target.getPointerSizeInBits(0));
4100 addr.push_back(offset.getQuantity());
4101 addr.push_back(llvm::dwarf::DW_OP_deref);
4102 addr.push_back(llvm::dwarf::DW_OP_plus_uconst);
4103 // offset of x field
4104 offset = CGM.getContext().toCharUnitsFromBits(XOffset);
4105 addr.push_back(offset.getQuantity());
4108 // Create the descriptor for the variable.
4109 auto Align = getDeclAlignIfRequired(VD, CGM.getContext());
4110 auto *D = DBuilder.createAutoVariable(
4111 cast<llvm::DILocalScope>(LexicalBlockStack.back()), VD->getName(), Unit,
4112 Line, Ty, false, llvm::DINode::FlagZero, Align);
4114 // Insert an llvm.dbg.declare into the current block.
4116 llvm::DebugLoc::get(Line, Column, LexicalBlockStack.back(), CurInlinedAt);
4117 auto *Expr = DBuilder.createExpression(addr);
4119 DBuilder.insertDeclare(Storage, D, Expr, DL, InsertPoint);
4121 DBuilder.insertDeclare(Storage, D, Expr, DL, Builder.GetInsertBlock());
4124 void CGDebugInfo::EmitDeclareOfArgVariable(const VarDecl *VD, llvm::Value *AI,
4126 CGBuilderTy &Builder) {
4127 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
4128 EmitDeclare(VD, AI, ArgNo, Builder);
4132 struct BlockLayoutChunk {
4133 uint64_t OffsetInBits;
4134 const BlockDecl::Capture *Capture;
4136 bool operator<(const BlockLayoutChunk &l, const BlockLayoutChunk &r) {
4137 return l.OffsetInBits < r.OffsetInBits;
4141 void CGDebugInfo::collectDefaultFieldsForBlockLiteralDeclare(
4142 const CGBlockInfo &Block, const ASTContext &Context, SourceLocation Loc,
4143 const llvm::StructLayout &BlockLayout, llvm::DIFile *Unit,
4144 SmallVectorImpl<llvm::Metadata *> &Fields) {
4145 // Blocks in OpenCL have unique constraints which make the standard fields
4146 // redundant while requiring size and align fields for enqueue_kernel. See
4147 // initializeForBlockHeader in CGBlocks.cpp
4148 if (CGM.getLangOpts().OpenCL) {
4149 Fields.push_back(createFieldType("__size", Context.IntTy, Loc, AS_public,
4150 BlockLayout.getElementOffsetInBits(0),
4152 Fields.push_back(createFieldType("__align", Context.IntTy, Loc, AS_public,
4153 BlockLayout.getElementOffsetInBits(1),
4156 Fields.push_back(createFieldType("__isa", Context.VoidPtrTy, Loc, AS_public,
4157 BlockLayout.getElementOffsetInBits(0),
4159 Fields.push_back(createFieldType("__flags", Context.IntTy, Loc, AS_public,
4160 BlockLayout.getElementOffsetInBits(1),
4163 createFieldType("__reserved", Context.IntTy, Loc, AS_public,
4164 BlockLayout.getElementOffsetInBits(2), Unit, Unit));
4165 auto *FnTy = Block.getBlockExpr()->getFunctionType();
4166 auto FnPtrType = CGM.getContext().getPointerType(FnTy->desugar());
4167 Fields.push_back(createFieldType("__FuncPtr", FnPtrType, Loc, AS_public,
4168 BlockLayout.getElementOffsetInBits(3),
4170 Fields.push_back(createFieldType(
4172 Context.getPointerType(Block.NeedsCopyDispose
4173 ? Context.getBlockDescriptorExtendedType()
4174 : Context.getBlockDescriptorType()),
4175 Loc, AS_public, BlockLayout.getElementOffsetInBits(4), Unit, Unit));
4179 void CGDebugInfo::EmitDeclareOfBlockLiteralArgVariable(const CGBlockInfo &block,
4182 llvm::AllocaInst *Alloca,
4183 CGBuilderTy &Builder) {
4184 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
4185 ASTContext &C = CGM.getContext();
4186 const BlockDecl *blockDecl = block.getBlockDecl();
4188 // Collect some general information about the block's location.
4189 SourceLocation loc = blockDecl->getCaretLocation();
4190 llvm::DIFile *tunit = getOrCreateFile(loc);
4191 unsigned line = getLineNumber(loc);
4192 unsigned column = getColumnNumber(loc);
4194 // Build the debug-info type for the block literal.
4195 getDeclContextDescriptor(blockDecl);
4197 const llvm::StructLayout *blockLayout =
4198 CGM.getDataLayout().getStructLayout(block.StructureType);
4200 SmallVector<llvm::Metadata *, 16> fields;
4201 collectDefaultFieldsForBlockLiteralDeclare(block, C, loc, *blockLayout, tunit,
4204 // We want to sort the captures by offset, not because DWARF
4205 // requires this, but because we're paranoid about debuggers.
4206 SmallVector<BlockLayoutChunk, 8> chunks;
4209 if (blockDecl->capturesCXXThis()) {
4210 BlockLayoutChunk chunk;
4211 chunk.OffsetInBits =
4212 blockLayout->getElementOffsetInBits(block.CXXThisIndex);
4213 chunk.Capture = nullptr;
4214 chunks.push_back(chunk);
4217 // Variable captures.
4218 for (const auto &capture : blockDecl->captures()) {
4219 const VarDecl *variable = capture.getVariable();
4220 const CGBlockInfo::Capture &captureInfo = block.getCapture(variable);
4222 // Ignore constant captures.
4223 if (captureInfo.isConstant())
4226 BlockLayoutChunk chunk;
4227 chunk.OffsetInBits =
4228 blockLayout->getElementOffsetInBits(captureInfo.getIndex());
4229 chunk.Capture = &capture;
4230 chunks.push_back(chunk);
4234 llvm::array_pod_sort(chunks.begin(), chunks.end());
4236 for (const BlockLayoutChunk &Chunk : chunks) {
4237 uint64_t offsetInBits = Chunk.OffsetInBits;
4238 const BlockDecl::Capture *capture = Chunk.Capture;
4240 // If we have a null capture, this must be the C++ 'this' capture.
4244 cast_or_null<CXXMethodDecl>(blockDecl->getNonClosureContext()))
4245 type = Method->getThisType();
4246 else if (auto *RDecl = dyn_cast<CXXRecordDecl>(blockDecl->getParent()))
4247 type = QualType(RDecl->getTypeForDecl(), 0);
4249 llvm_unreachable("unexpected block declcontext");
4251 fields.push_back(createFieldType("this", type, loc, AS_public,
4252 offsetInBits, tunit, tunit));
4256 const VarDecl *variable = capture->getVariable();
4257 StringRef name = variable->getName();
4259 llvm::DIType *fieldType;
4260 if (capture->isByRef()) {
4261 TypeInfo PtrInfo = C.getTypeInfo(C.VoidPtrTy);
4262 auto Align = PtrInfo.AlignIsRequired ? PtrInfo.Align : 0;
4263 // FIXME: This recomputes the layout of the BlockByRefWrapper.
4266 EmitTypeForVarWithBlocksAttr(variable, &xoffset).BlockByRefWrapper;
4267 fieldType = DBuilder.createPointerType(fieldType, PtrInfo.Width);
4268 fieldType = DBuilder.createMemberType(tunit, name, tunit, line,
4269 PtrInfo.Width, Align, offsetInBits,
4270 llvm::DINode::FlagZero, fieldType);
4272 auto Align = getDeclAlignIfRequired(variable, CGM.getContext());
4273 fieldType = createFieldType(name, variable->getType(), loc, AS_public,
4274 offsetInBits, Align, tunit, tunit);
4276 fields.push_back(fieldType);
4279 SmallString<36> typeName;
4280 llvm::raw_svector_ostream(typeName)
4281 << "__block_literal_" << CGM.getUniqueBlockCount();
4283 llvm::DINodeArray fieldsArray = DBuilder.getOrCreateArray(fields);
4285 llvm::DIType *type =
4286 DBuilder.createStructType(tunit, typeName.str(), tunit, line,
4287 CGM.getContext().toBits(block.BlockSize), 0,
4288 llvm::DINode::FlagZero, nullptr, fieldsArray);
4289 type = DBuilder.createPointerType(type, CGM.PointerWidthInBits);
4291 // Get overall information about the block.
4292 llvm::DINode::DIFlags flags = llvm::DINode::FlagArtificial;
4293 auto *scope = cast<llvm::DILocalScope>(LexicalBlockStack.back());
4295 // Create the descriptor for the parameter.
4296 auto *debugVar = DBuilder.createParameterVariable(
4297 scope, Name, ArgNo, tunit, line, type, CGM.getLangOpts().Optimize, flags);
4299 // Insert an llvm.dbg.declare into the current block.
4300 DBuilder.insertDeclare(Alloca, debugVar, DBuilder.createExpression(),
4301 llvm::DebugLoc::get(line, column, scope, CurInlinedAt),
4302 Builder.GetInsertBlock());
4305 llvm::DIDerivedType *
4306 CGDebugInfo::getOrCreateStaticDataMemberDeclarationOrNull(const VarDecl *D) {
4307 if (!D || !D->isStaticDataMember())
4310 auto MI = StaticDataMemberCache.find(D->getCanonicalDecl());
4311 if (MI != StaticDataMemberCache.end()) {
4312 assert(MI->second && "Static data member declaration should still exist");
4316 // If the member wasn't found in the cache, lazily construct and add it to the
4317 // type (used when a limited form of the type is emitted).
4318 auto DC = D->getDeclContext();
4319 auto *Ctxt = cast<llvm::DICompositeType>(getDeclContextDescriptor(D));
4320 return CreateRecordStaticField(D, Ctxt, cast<RecordDecl>(DC));
4323 llvm::DIGlobalVariableExpression *CGDebugInfo::CollectAnonRecordDecls(
4324 const RecordDecl *RD, llvm::DIFile *Unit, unsigned LineNo,
4325 StringRef LinkageName, llvm::GlobalVariable *Var, llvm::DIScope *DContext) {
4326 llvm::DIGlobalVariableExpression *GVE = nullptr;
4328 for (const auto *Field : RD->fields()) {
4329 llvm::DIType *FieldTy = getOrCreateType(Field->getType(), Unit);
4330 StringRef FieldName = Field->getName();
4332 // Ignore unnamed fields, but recurse into anonymous records.
4333 if (FieldName.empty()) {
4334 if (const auto *RT = dyn_cast<RecordType>(Field->getType()))
4335 GVE = CollectAnonRecordDecls(RT->getDecl(), Unit, LineNo, LinkageName,
4339 // Use VarDecl's Tag, Scope and Line number.
4340 GVE = DBuilder.createGlobalVariableExpression(
4341 DContext, FieldName, LinkageName, Unit, LineNo, FieldTy,
4342 Var->hasLocalLinkage());
4343 Var->addDebugInfo(GVE);
4348 void CGDebugInfo::EmitGlobalVariable(llvm::GlobalVariable *Var,
4350 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
4351 if (D->hasAttr<NoDebugAttr>())
4354 // If we already created a DIGlobalVariable for this declaration, just attach
4355 // it to the llvm::GlobalVariable.
4356 auto Cached = DeclCache.find(D->getCanonicalDecl());
4357 if (Cached != DeclCache.end())
4358 return Var->addDebugInfo(
4359 cast<llvm::DIGlobalVariableExpression>(Cached->second));
4361 // Create global variable debug descriptor.
4362 llvm::DIFile *Unit = nullptr;
4363 llvm::DIScope *DContext = nullptr;
4365 StringRef DeclName, LinkageName;
4367 llvm::MDTuple *TemplateParameters = nullptr;
4368 collectVarDeclProps(D, Unit, LineNo, T, DeclName, LinkageName,
4369 TemplateParameters, DContext);
4371 // Attempt to store one global variable for the declaration - even if we
4372 // emit a lot of fields.
4373 llvm::DIGlobalVariableExpression *GVE = nullptr;
4375 // If this is an anonymous union then we'll want to emit a global
4376 // variable for each member of the anonymous union so that it's possible
4377 // to find the name of any field in the union.
4378 if (T->isUnionType() && DeclName.empty()) {
4379 const RecordDecl *RD = T->castAs<RecordType>()->getDecl();
4380 assert(RD->isAnonymousStructOrUnion() &&
4381 "unnamed non-anonymous struct or union?");
4382 GVE = CollectAnonRecordDecls(RD, Unit, LineNo, LinkageName, Var, DContext);
4384 auto Align = getDeclAlignIfRequired(D, CGM.getContext());
4386 SmallVector<int64_t, 4> Expr;
4387 unsigned AddressSpace =
4388 CGM.getContext().getTargetAddressSpace(D->getType());
4389 if (CGM.getLangOpts().CUDA && CGM.getLangOpts().CUDAIsDevice) {
4390 if (D->hasAttr<CUDASharedAttr>())
4392 CGM.getContext().getTargetAddressSpace(LangAS::cuda_shared);
4393 else if (D->hasAttr<CUDAConstantAttr>())
4395 CGM.getContext().getTargetAddressSpace(LangAS::cuda_constant);
4397 AppendAddressSpaceXDeref(AddressSpace, Expr);
4399 GVE = DBuilder.createGlobalVariableExpression(
4400 DContext, DeclName, LinkageName, Unit, LineNo, getOrCreateType(T, Unit),
4401 Var->hasLocalLinkage(),
4402 Expr.empty() ? nullptr : DBuilder.createExpression(Expr),
4403 getOrCreateStaticDataMemberDeclarationOrNull(D), TemplateParameters,
4405 Var->addDebugInfo(GVE);
4407 DeclCache[D->getCanonicalDecl()].reset(GVE);
4410 void CGDebugInfo::EmitGlobalVariable(const ValueDecl *VD, const APValue &Init) {
4411 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
4412 if (VD->hasAttr<NoDebugAttr>())
4414 auto Align = getDeclAlignIfRequired(VD, CGM.getContext());
4415 // Create the descriptor for the variable.
4416 llvm::DIFile *Unit = getOrCreateFile(VD->getLocation());
4417 StringRef Name = VD->getName();
4418 llvm::DIType *Ty = getOrCreateType(VD->getType(), Unit);
4420 // Do not use global variables for enums, unless in CodeView.
4421 if (const auto *ECD = dyn_cast<EnumConstantDecl>(VD)) {
4422 const auto *ED = cast<EnumDecl>(ECD->getDeclContext());
4423 assert(isa<EnumType>(ED->getTypeForDecl()) && "Enum without EnumType?");
4426 // If CodeView, emit enums as global variables, unless they are defined
4427 // inside a class. We do this because MSVC doesn't emit S_CONSTANTs for
4428 // enums in classes, and because it is difficult to attach this scope
4429 // information to the global variable.
4430 if (!CGM.getCodeGenOpts().EmitCodeView ||
4431 isa<RecordDecl>(ED->getDeclContext()))
4435 llvm::DIScope *DContext = nullptr;
4437 // Do not emit separate definitions for function local consts.
4438 if (isa<FunctionDecl>(VD->getDeclContext()))
4441 // Emit definition for static members in CodeView.
4442 VD = cast<ValueDecl>(VD->getCanonicalDecl());
4443 auto *VarD = dyn_cast<VarDecl>(VD);
4444 if (VarD && VarD->isStaticDataMember()) {
4445 auto *RD = cast<RecordDecl>(VarD->getDeclContext());
4446 getDeclContextDescriptor(VarD);
4447 // Ensure that the type is retained even though it's otherwise unreferenced.
4449 // FIXME: This is probably unnecessary, since Ty should reference RD
4450 // through its scope.
4451 RetainedTypes.push_back(
4452 CGM.getContext().getRecordType(RD).getAsOpaquePtr());
4454 if (!CGM.getCodeGenOpts().EmitCodeView)
4457 // Use the global scope for static members.
4458 DContext = getContextDescriptor(
4459 cast<Decl>(CGM.getContext().getTranslationUnitDecl()), TheCU);
4461 DContext = getDeclContextDescriptor(VD);
4464 auto &GV = DeclCache[VD];
4467 llvm::DIExpression *InitExpr = nullptr;
4468 if (CGM.getContext().getTypeSize(VD->getType()) <= 64) {
4469 // FIXME: Add a representation for integer constants wider than 64 bits.
4472 DBuilder.createConstantValueExpression(Init.getInt().getExtValue());
4473 else if (Init.isFloat())
4474 InitExpr = DBuilder.createConstantValueExpression(
4475 Init.getFloat().bitcastToAPInt().getZExtValue());
4478 llvm::MDTuple *TemplateParameters = nullptr;
4480 if (isa<VarTemplateSpecializationDecl>(VD))
4482 llvm::DINodeArray parameterNodes = CollectVarTemplateParams(VarD, &*Unit);
4483 TemplateParameters = parameterNodes.get();
4486 GV.reset(DBuilder.createGlobalVariableExpression(
4487 DContext, Name, StringRef(), Unit, getLineNumber(VD->getLocation()), Ty,
4488 true, InitExpr, getOrCreateStaticDataMemberDeclarationOrNull(VarD),
4489 TemplateParameters, Align));
4492 llvm::DIScope *CGDebugInfo::getCurrentContextDescriptor(const Decl *D) {
4493 if (!LexicalBlockStack.empty())
4494 return LexicalBlockStack.back();
4495 llvm::DIScope *Mod = getParentModuleOrNull(D);
4496 return getContextDescriptor(D, Mod ? Mod : TheCU);
4499 void CGDebugInfo::EmitUsingDirective(const UsingDirectiveDecl &UD) {
4500 if (CGM.getCodeGenOpts().getDebugInfo() < codegenoptions::LimitedDebugInfo)
4502 const NamespaceDecl *NSDecl = UD.getNominatedNamespace();
4503 if (!NSDecl->isAnonymousNamespace() ||
4504 CGM.getCodeGenOpts().DebugExplicitImport) {
4505 auto Loc = UD.getLocation();
4506 DBuilder.createImportedModule(
4507 getCurrentContextDescriptor(cast<Decl>(UD.getDeclContext())),
4508 getOrCreateNamespace(NSDecl), getOrCreateFile(Loc), getLineNumber(Loc));
4512 void CGDebugInfo::EmitUsingDecl(const UsingDecl &UD) {
4513 if (CGM.getCodeGenOpts().getDebugInfo() < codegenoptions::LimitedDebugInfo)
4515 assert(UD.shadow_size() &&
4516 "We shouldn't be codegening an invalid UsingDecl containing no decls");
4517 // Emitting one decl is sufficient - debuggers can detect that this is an
4518 // overloaded name & provide lookup for all the overloads.
4519 const UsingShadowDecl &USD = **UD.shadow_begin();
4521 // FIXME: Skip functions with undeduced auto return type for now since we
4522 // don't currently have the plumbing for separate declarations & definitions
4523 // of free functions and mismatched types (auto in the declaration, concrete
4524 // return type in the definition)
4525 if (const auto *FD = dyn_cast<FunctionDecl>(USD.getUnderlyingDecl()))
4526 if (const auto *AT =
4527 FD->getType()->getAs<FunctionProtoType>()->getContainedAutoType())
4528 if (AT->getDeducedType().isNull())
4530 if (llvm::DINode *Target =
4531 getDeclarationOrDefinition(USD.getUnderlyingDecl())) {
4532 auto Loc = USD.getLocation();
4533 DBuilder.createImportedDeclaration(
4534 getCurrentContextDescriptor(cast<Decl>(USD.getDeclContext())), Target,
4535 getOrCreateFile(Loc), getLineNumber(Loc));
4539 void CGDebugInfo::EmitImportDecl(const ImportDecl &ID) {
4540 if (CGM.getCodeGenOpts().getDebuggerTuning() != llvm::DebuggerKind::LLDB)
4542 if (Module *M = ID.getImportedModule()) {
4543 auto Info = ExternalASTSource::ASTSourceDescriptor(*M);
4544 auto Loc = ID.getLocation();
4545 DBuilder.createImportedDeclaration(
4546 getCurrentContextDescriptor(cast<Decl>(ID.getDeclContext())),
4547 getOrCreateModuleRef(Info, DebugTypeExtRefs), getOrCreateFile(Loc),
4548 getLineNumber(Loc));
4552 llvm::DIImportedEntity *
4553 CGDebugInfo::EmitNamespaceAlias(const NamespaceAliasDecl &NA) {
4554 if (CGM.getCodeGenOpts().getDebugInfo() < codegenoptions::LimitedDebugInfo)
4556 auto &VH = NamespaceAliasCache[&NA];
4558 return cast<llvm::DIImportedEntity>(VH);
4559 llvm::DIImportedEntity *R;
4560 auto Loc = NA.getLocation();
4561 if (const auto *Underlying =
4562 dyn_cast<NamespaceAliasDecl>(NA.getAliasedNamespace()))
4563 // This could cache & dedup here rather than relying on metadata deduping.
4564 R = DBuilder.createImportedDeclaration(
4565 getCurrentContextDescriptor(cast<Decl>(NA.getDeclContext())),
4566 EmitNamespaceAlias(*Underlying), getOrCreateFile(Loc),
4567 getLineNumber(Loc), NA.getName());
4569 R = DBuilder.createImportedDeclaration(
4570 getCurrentContextDescriptor(cast<Decl>(NA.getDeclContext())),
4571 getOrCreateNamespace(cast<NamespaceDecl>(NA.getAliasedNamespace())),
4572 getOrCreateFile(Loc), getLineNumber(Loc), NA.getName());
4578 CGDebugInfo::getOrCreateNamespace(const NamespaceDecl *NSDecl) {
4579 // Don't canonicalize the NamespaceDecl here: The DINamespace will be uniqued
4580 // if necessary, and this way multiple declarations of the same namespace in
4581 // different parent modules stay distinct.
4582 auto I = NamespaceCache.find(NSDecl);
4583 if (I != NamespaceCache.end())
4584 return cast<llvm::DINamespace>(I->second);
4586 llvm::DIScope *Context = getDeclContextDescriptor(NSDecl);
4587 // Don't trust the context if it is a DIModule (see comment above).
4588 llvm::DINamespace *NS =
4589 DBuilder.createNameSpace(Context, NSDecl->getName(), NSDecl->isInline());
4590 NamespaceCache[NSDecl].reset(NS);
4594 void CGDebugInfo::setDwoId(uint64_t Signature) {
4595 assert(TheCU && "no main compile unit");
4596 TheCU->setDWOId(Signature);
4599 /// Analyzes each function parameter to determine whether it is constant
4600 /// throughout the function body.
4601 static void analyzeParametersModification(
4603 llvm::DenseMap<const FunctionDecl *, llvm::TrackingMDRef> &SPDefCache,
4604 llvm::DenseMap<const ParmVarDecl *, llvm::TrackingMDRef> &ParamCache) {
4605 for (auto &SP : SPDefCache) {
4606 auto *FD = SP.first;
4607 assert(FD->hasBody() && "Functions must have body here");
4608 const Stmt *FuncBody = (*FD).getBody();
4609 for (auto Parm : FD->parameters()) {
4610 ExprMutationAnalyzer FuncAnalyzer(*FuncBody, Ctx);
4611 if (FuncAnalyzer.isMutated(Parm))
4614 auto I = ParamCache.find(Parm);
4615 assert(I != ParamCache.end() && "Parameters should be already cached");
4616 auto *DIParm = cast<llvm::DILocalVariable>(I->second);
4617 DIParm->setIsNotModified();
4622 void CGDebugInfo::finalize() {
4623 // Creating types might create further types - invalidating the current
4624 // element and the size(), so don't cache/reference them.
4625 for (size_t i = 0; i != ObjCInterfaceCache.size(); ++i) {
4626 ObjCInterfaceCacheEntry E = ObjCInterfaceCache[i];
4627 llvm::DIType *Ty = E.Type->getDecl()->getDefinition()
4628 ? CreateTypeDefinition(E.Type, E.Unit)
4630 DBuilder.replaceTemporary(llvm::TempDIType(E.Decl), Ty);
4633 if (CGM.getCodeGenOpts().DwarfVersion >= 5) {
4634 // Add methods to interface.
4635 for (const auto &P : ObjCMethodCache) {
4636 if (P.second.empty())
4639 QualType QTy(P.first->getTypeForDecl(), 0);
4640 auto It = TypeCache.find(QTy.getAsOpaquePtr());
4641 assert(It != TypeCache.end());
4643 llvm::DICompositeType *InterfaceDecl =
4644 cast<llvm::DICompositeType>(It->second);
4646 SmallVector<llvm::Metadata *, 16> EltTys;
4647 auto CurrenetElts = InterfaceDecl->getElements();
4648 EltTys.append(CurrenetElts.begin(), CurrenetElts.end());
4649 for (auto &MD : P.second)
4650 EltTys.push_back(MD);
4651 llvm::DINodeArray Elements = DBuilder.getOrCreateArray(EltTys);
4652 DBuilder.replaceArrays(InterfaceDecl, Elements);
4656 for (const auto &P : ReplaceMap) {
4658 auto *Ty = cast<llvm::DIType>(P.second);
4659 assert(Ty->isForwardDecl());
4661 auto It = TypeCache.find(P.first);
4662 assert(It != TypeCache.end());
4665 DBuilder.replaceTemporary(llvm::TempDIType(Ty),
4666 cast<llvm::DIType>(It->second));
4669 for (const auto &P : FwdDeclReplaceMap) {
4671 llvm::TempMDNode FwdDecl(cast<llvm::MDNode>(P.second));
4672 llvm::Metadata *Repl;
4674 auto It = DeclCache.find(P.first);
4675 // If there has been no definition for the declaration, call RAUW
4676 // with ourselves, that will destroy the temporary MDNode and
4677 // replace it with a standard one, avoiding leaking memory.
4678 if (It == DeclCache.end())
4683 if (auto *GVE = dyn_cast_or_null<llvm::DIGlobalVariableExpression>(Repl))
4684 Repl = GVE->getVariable();
4685 DBuilder.replaceTemporary(std::move(FwdDecl), cast<llvm::MDNode>(Repl));
4688 // We keep our own list of retained types, because we need to look
4689 // up the final type in the type cache.
4690 for (auto &RT : RetainedTypes)
4691 if (auto MD = TypeCache[RT])
4692 DBuilder.retainType(cast<llvm::DIType>(MD));
4694 if (CGM.getCodeGenOpts().EnableDebugEntryValues)
4695 // This will be used to emit debug entry values.
4696 analyzeParametersModification(CGM.getContext(), SPDefCache, ParamCache);
4698 DBuilder.finalize();
4701 void CGDebugInfo::EmitExplicitCastType(QualType Ty) {
4702 if (CGM.getCodeGenOpts().getDebugInfo() < codegenoptions::LimitedDebugInfo)
4705 if (auto *DieTy = getOrCreateType(Ty, TheCU->getFile()))
4706 // Don't ignore in case of explicit cast where it is referenced indirectly.
4707 DBuilder.retainType(DieTy);
4710 llvm::DebugLoc CGDebugInfo::SourceLocToDebugLoc(SourceLocation Loc) {
4711 if (LexicalBlockStack.empty())
4712 return llvm::DebugLoc();
4714 llvm::MDNode *Scope = LexicalBlockStack.back();
4715 return llvm::DebugLoc::get(getLineNumber(Loc), getColumnNumber(Loc), Scope);
4718 llvm::DINode::DIFlags CGDebugInfo::getCallSiteRelatedAttrs() const {
4719 // Call site-related attributes are only useful in optimized programs, and
4720 // when there's a possibility of debugging backtraces.
4721 if (!CGM.getLangOpts().Optimize || DebugKind == codegenoptions::NoDebugInfo ||
4722 DebugKind == codegenoptions::LocTrackingOnly)
4723 return llvm::DINode::FlagZero;
4725 // Call site-related attributes are available in DWARF v5. Some debuggers,
4726 // while not fully DWARF v5-compliant, may accept these attributes as if they
4727 // were part of DWARF v4.
4728 bool SupportsDWARFv4Ext =
4729 CGM.getCodeGenOpts().DwarfVersion == 4 &&
4730 (CGM.getCodeGenOpts().getDebuggerTuning() == llvm::DebuggerKind::LLDB ||
4731 (CGM.getCodeGenOpts().EnableDebugEntryValues &&
4732 CGM.getCodeGenOpts().getDebuggerTuning() == llvm::DebuggerKind::GDB));
4734 if (!SupportsDWARFv4Ext && CGM.getCodeGenOpts().DwarfVersion < 5)
4735 return llvm::DINode::FlagZero;
4737 return llvm::DINode::FlagAllCallsDescribed;