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