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