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