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