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