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