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