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