1 //===- DebugInfoMetadata.cpp - Implement debug info metadata --------------===// 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 file implements the debug info Metadata classes. 11 // 12 //===----------------------------------------------------------------------===// 13 14 #include "llvm/IR/DebugInfoMetadata.h" 15 #include "LLVMContextImpl.h" 16 #include "MetadataImpl.h" 17 #include "llvm/ADT/StringSwitch.h" 18 #include "llvm/IR/Function.h" 19 20 using namespace llvm; 21 22 DILocation::DILocation(LLVMContext &C, StorageType Storage, unsigned Line, 23 unsigned Column, ArrayRef<Metadata *> MDs) 24 : MDNode(C, DILocationKind, Storage, MDs) { 25 assert((MDs.size() == 1 || MDs.size() == 2) && 26 "Expected a scope and optional inlined-at"); 27 28 // Set line and column. 29 assert(Column < (1u << 16) && "Expected 16-bit column"); 30 31 SubclassData32 = Line; 32 SubclassData16 = Column; 33 } 34 35 static void adjustColumn(unsigned &Column) { 36 // Set to unknown on overflow. We only have 16 bits to play with here. 37 if (Column >= (1u << 16)) 38 Column = 0; 39 } 40 41 DILocation *DILocation::getImpl(LLVMContext &Context, unsigned Line, 42 unsigned Column, Metadata *Scope, 43 Metadata *InlinedAt, StorageType Storage, 44 bool ShouldCreate) { 45 // Fixup column. 46 adjustColumn(Column); 47 48 if (Storage == Uniqued) { 49 if (auto *N = 50 getUniqued(Context.pImpl->DILocations, 51 DILocationInfo::KeyTy(Line, Column, Scope, InlinedAt))) 52 return N; 53 if (!ShouldCreate) 54 return nullptr; 55 } else { 56 assert(ShouldCreate && "Expected non-uniqued nodes to always be created"); 57 } 58 59 SmallVector<Metadata *, 2> Ops; 60 Ops.push_back(Scope); 61 if (InlinedAt) 62 Ops.push_back(InlinedAt); 63 return storeImpl(new (Ops.size()) 64 DILocation(Context, Storage, Line, Column, Ops), 65 Storage, Context.pImpl->DILocations); 66 } 67 68 DINode::DIFlags DINode::getFlag(StringRef Flag) { 69 return StringSwitch<DIFlags>(Flag) 70 #define HANDLE_DI_FLAG(ID, NAME) .Case("DIFlag" #NAME, Flag##NAME) 71 #include "llvm/IR/DebugInfoFlags.def" 72 .Default(DINode::FlagZero); 73 } 74 75 StringRef DINode::getFlagString(DIFlags Flag) { 76 switch (Flag) { 77 #define HANDLE_DI_FLAG(ID, NAME) \ 78 case Flag##NAME: \ 79 return "DIFlag" #NAME; 80 #include "llvm/IR/DebugInfoFlags.def" 81 } 82 return ""; 83 } 84 85 DINode::DIFlags DINode::splitFlags(DIFlags Flags, 86 SmallVectorImpl<DIFlags> &SplitFlags) { 87 // Flags that are packed together need to be specially handled, so 88 // that, for example, we emit "DIFlagPublic" and not 89 // "DIFlagPrivate | DIFlagProtected". 90 if (DIFlags A = Flags & FlagAccessibility) { 91 if (A == FlagPrivate) 92 SplitFlags.push_back(FlagPrivate); 93 else if (A == FlagProtected) 94 SplitFlags.push_back(FlagProtected); 95 else 96 SplitFlags.push_back(FlagPublic); 97 Flags &= ~A; 98 } 99 if (DIFlags R = Flags & FlagPtrToMemberRep) { 100 if (R == FlagSingleInheritance) 101 SplitFlags.push_back(FlagSingleInheritance); 102 else if (R == FlagMultipleInheritance) 103 SplitFlags.push_back(FlagMultipleInheritance); 104 else 105 SplitFlags.push_back(FlagVirtualInheritance); 106 Flags &= ~R; 107 } 108 if ((Flags & FlagIndirectVirtualBase) == FlagIndirectVirtualBase) { 109 Flags &= ~FlagIndirectVirtualBase; 110 SplitFlags.push_back(FlagIndirectVirtualBase); 111 } 112 113 #define HANDLE_DI_FLAG(ID, NAME) \ 114 if (DIFlags Bit = Flags & Flag##NAME) { \ 115 SplitFlags.push_back(Bit); \ 116 Flags &= ~Bit; \ 117 } 118 #include "llvm/IR/DebugInfoFlags.def" 119 return Flags; 120 } 121 122 DIScopeRef DIScope::getScope() const { 123 if (auto *T = dyn_cast<DIType>(this)) 124 return T->getScope(); 125 126 if (auto *SP = dyn_cast<DISubprogram>(this)) 127 return SP->getScope(); 128 129 if (auto *LB = dyn_cast<DILexicalBlockBase>(this)) 130 return LB->getScope(); 131 132 if (auto *NS = dyn_cast<DINamespace>(this)) 133 return NS->getScope(); 134 135 if (auto *M = dyn_cast<DIModule>(this)) 136 return M->getScope(); 137 138 assert((isa<DIFile>(this) || isa<DICompileUnit>(this)) && 139 "Unhandled type of scope."); 140 return nullptr; 141 } 142 143 StringRef DIScope::getName() const { 144 if (auto *T = dyn_cast<DIType>(this)) 145 return T->getName(); 146 if (auto *SP = dyn_cast<DISubprogram>(this)) 147 return SP->getName(); 148 if (auto *NS = dyn_cast<DINamespace>(this)) 149 return NS->getName(); 150 if (auto *M = dyn_cast<DIModule>(this)) 151 return M->getName(); 152 assert((isa<DILexicalBlockBase>(this) || isa<DIFile>(this) || 153 isa<DICompileUnit>(this)) && 154 "Unhandled type of scope."); 155 return ""; 156 } 157 158 #ifndef NDEBUG 159 static bool isCanonical(const MDString *S) { 160 return !S || !S->getString().empty(); 161 } 162 #endif 163 164 GenericDINode *GenericDINode::getImpl(LLVMContext &Context, unsigned Tag, 165 MDString *Header, 166 ArrayRef<Metadata *> DwarfOps, 167 StorageType Storage, bool ShouldCreate) { 168 unsigned Hash = 0; 169 if (Storage == Uniqued) { 170 GenericDINodeInfo::KeyTy Key(Tag, Header, DwarfOps); 171 if (auto *N = getUniqued(Context.pImpl->GenericDINodes, Key)) 172 return N; 173 if (!ShouldCreate) 174 return nullptr; 175 Hash = Key.getHash(); 176 } else { 177 assert(ShouldCreate && "Expected non-uniqued nodes to always be created"); 178 } 179 180 // Use a nullptr for empty headers. 181 assert(isCanonical(Header) && "Expected canonical MDString"); 182 Metadata *PreOps[] = {Header}; 183 return storeImpl(new (DwarfOps.size() + 1) GenericDINode( 184 Context, Storage, Hash, Tag, PreOps, DwarfOps), 185 Storage, Context.pImpl->GenericDINodes); 186 } 187 188 void GenericDINode::recalculateHash() { 189 setHash(GenericDINodeInfo::KeyTy::calculateHash(this)); 190 } 191 192 #define UNWRAP_ARGS_IMPL(...) __VA_ARGS__ 193 #define UNWRAP_ARGS(ARGS) UNWRAP_ARGS_IMPL ARGS 194 #define DEFINE_GETIMPL_LOOKUP(CLASS, ARGS) \ 195 do { \ 196 if (Storage == Uniqued) { \ 197 if (auto *N = getUniqued(Context.pImpl->CLASS##s, \ 198 CLASS##Info::KeyTy(UNWRAP_ARGS(ARGS)))) \ 199 return N; \ 200 if (!ShouldCreate) \ 201 return nullptr; \ 202 } else { \ 203 assert(ShouldCreate && \ 204 "Expected non-uniqued nodes to always be created"); \ 205 } \ 206 } while (false) 207 #define DEFINE_GETIMPL_STORE(CLASS, ARGS, OPS) \ 208 return storeImpl(new (array_lengthof(OPS)) \ 209 CLASS(Context, Storage, UNWRAP_ARGS(ARGS), OPS), \ 210 Storage, Context.pImpl->CLASS##s) 211 #define DEFINE_GETIMPL_STORE_NO_OPS(CLASS, ARGS) \ 212 return storeImpl(new (0u) CLASS(Context, Storage, UNWRAP_ARGS(ARGS)), \ 213 Storage, Context.pImpl->CLASS##s) 214 #define DEFINE_GETIMPL_STORE_NO_CONSTRUCTOR_ARGS(CLASS, OPS) \ 215 return storeImpl(new (array_lengthof(OPS)) CLASS(Context, Storage, OPS), \ 216 Storage, Context.pImpl->CLASS##s) 217 218 DISubrange *DISubrange::getImpl(LLVMContext &Context, int64_t Count, int64_t Lo, 219 StorageType Storage, bool ShouldCreate) { 220 DEFINE_GETIMPL_LOOKUP(DISubrange, (Count, Lo)); 221 DEFINE_GETIMPL_STORE_NO_OPS(DISubrange, (Count, Lo)); 222 } 223 224 DIEnumerator *DIEnumerator::getImpl(LLVMContext &Context, int64_t Value, 225 MDString *Name, StorageType Storage, 226 bool ShouldCreate) { 227 assert(isCanonical(Name) && "Expected canonical MDString"); 228 DEFINE_GETIMPL_LOOKUP(DIEnumerator, (Value, Name)); 229 Metadata *Ops[] = {Name}; 230 DEFINE_GETIMPL_STORE(DIEnumerator, (Value), Ops); 231 } 232 233 DIBasicType *DIBasicType::getImpl(LLVMContext &Context, unsigned Tag, 234 MDString *Name, uint64_t SizeInBits, 235 uint32_t AlignInBits, unsigned Encoding, 236 StorageType Storage, bool ShouldCreate) { 237 assert(isCanonical(Name) && "Expected canonical MDString"); 238 DEFINE_GETIMPL_LOOKUP(DIBasicType, 239 (Tag, Name, SizeInBits, AlignInBits, Encoding)); 240 Metadata *Ops[] = {nullptr, nullptr, Name}; 241 DEFINE_GETIMPL_STORE(DIBasicType, (Tag, SizeInBits, AlignInBits, Encoding), 242 Ops); 243 } 244 245 DIDerivedType *DIDerivedType::getImpl( 246 LLVMContext &Context, unsigned Tag, MDString *Name, Metadata *File, 247 unsigned Line, Metadata *Scope, Metadata *BaseType, uint64_t SizeInBits, 248 uint32_t AlignInBits, uint64_t OffsetInBits, DIFlags Flags, 249 Metadata *ExtraData, StorageType Storage, bool ShouldCreate) { 250 assert(isCanonical(Name) && "Expected canonical MDString"); 251 DEFINE_GETIMPL_LOOKUP(DIDerivedType, 252 (Tag, Name, File, Line, Scope, BaseType, SizeInBits, 253 AlignInBits, OffsetInBits, Flags, ExtraData)); 254 Metadata *Ops[] = {File, Scope, Name, BaseType, ExtraData}; 255 DEFINE_GETIMPL_STORE( 256 DIDerivedType, (Tag, Line, SizeInBits, AlignInBits, OffsetInBits, Flags), 257 Ops); 258 } 259 260 DICompositeType *DICompositeType::getImpl( 261 LLVMContext &Context, unsigned Tag, MDString *Name, Metadata *File, 262 unsigned Line, Metadata *Scope, Metadata *BaseType, uint64_t SizeInBits, 263 uint32_t AlignInBits, uint64_t OffsetInBits, DIFlags Flags, 264 Metadata *Elements, unsigned RuntimeLang, Metadata *VTableHolder, 265 Metadata *TemplateParams, MDString *Identifier, StorageType Storage, 266 bool ShouldCreate) { 267 assert(isCanonical(Name) && "Expected canonical MDString"); 268 269 // Keep this in sync with buildODRType. 270 DEFINE_GETIMPL_LOOKUP( 271 DICompositeType, (Tag, Name, File, Line, Scope, BaseType, SizeInBits, 272 AlignInBits, OffsetInBits, Flags, Elements, RuntimeLang, 273 VTableHolder, TemplateParams, Identifier)); 274 Metadata *Ops[] = {File, Scope, Name, BaseType, 275 Elements, VTableHolder, TemplateParams, Identifier}; 276 DEFINE_GETIMPL_STORE(DICompositeType, (Tag, Line, RuntimeLang, SizeInBits, 277 AlignInBits, OffsetInBits, Flags), 278 Ops); 279 } 280 281 DICompositeType *DICompositeType::buildODRType( 282 LLVMContext &Context, MDString &Identifier, unsigned Tag, MDString *Name, 283 Metadata *File, unsigned Line, Metadata *Scope, Metadata *BaseType, 284 uint64_t SizeInBits, uint32_t AlignInBits, uint64_t OffsetInBits, 285 DIFlags Flags, Metadata *Elements, unsigned RuntimeLang, 286 Metadata *VTableHolder, Metadata *TemplateParams) { 287 assert(!Identifier.getString().empty() && "Expected valid identifier"); 288 if (!Context.isODRUniquingDebugTypes()) 289 return nullptr; 290 auto *&CT = (*Context.pImpl->DITypeMap)[&Identifier]; 291 if (!CT) 292 return CT = DICompositeType::getDistinct( 293 Context, Tag, Name, File, Line, Scope, BaseType, SizeInBits, 294 AlignInBits, OffsetInBits, Flags, Elements, RuntimeLang, 295 VTableHolder, TemplateParams, &Identifier); 296 297 // Only mutate CT if it's a forward declaration and the new operands aren't. 298 assert(CT->getRawIdentifier() == &Identifier && "Wrong ODR identifier?"); 299 if (!CT->isForwardDecl() || (Flags & DINode::FlagFwdDecl)) 300 return CT; 301 302 // Mutate CT in place. Keep this in sync with getImpl. 303 CT->mutate(Tag, Line, RuntimeLang, SizeInBits, AlignInBits, OffsetInBits, 304 Flags); 305 Metadata *Ops[] = {File, Scope, Name, BaseType, 306 Elements, VTableHolder, TemplateParams, &Identifier}; 307 assert((std::end(Ops) - std::begin(Ops)) == (int)CT->getNumOperands() && 308 "Mismatched number of operands"); 309 for (unsigned I = 0, E = CT->getNumOperands(); I != E; ++I) 310 if (Ops[I] != CT->getOperand(I)) 311 CT->setOperand(I, Ops[I]); 312 return CT; 313 } 314 315 DICompositeType *DICompositeType::getODRType( 316 LLVMContext &Context, MDString &Identifier, unsigned Tag, MDString *Name, 317 Metadata *File, unsigned Line, Metadata *Scope, Metadata *BaseType, 318 uint64_t SizeInBits, uint32_t AlignInBits, uint64_t OffsetInBits, 319 DIFlags Flags, Metadata *Elements, unsigned RuntimeLang, 320 Metadata *VTableHolder, Metadata *TemplateParams) { 321 assert(!Identifier.getString().empty() && "Expected valid identifier"); 322 if (!Context.isODRUniquingDebugTypes()) 323 return nullptr; 324 auto *&CT = (*Context.pImpl->DITypeMap)[&Identifier]; 325 if (!CT) 326 CT = DICompositeType::getDistinct( 327 Context, Tag, Name, File, Line, Scope, BaseType, SizeInBits, 328 AlignInBits, OffsetInBits, Flags, Elements, RuntimeLang, VTableHolder, 329 TemplateParams, &Identifier); 330 return CT; 331 } 332 333 DICompositeType *DICompositeType::getODRTypeIfExists(LLVMContext &Context, 334 MDString &Identifier) { 335 assert(!Identifier.getString().empty() && "Expected valid identifier"); 336 if (!Context.isODRUniquingDebugTypes()) 337 return nullptr; 338 return Context.pImpl->DITypeMap->lookup(&Identifier); 339 } 340 341 DISubroutineType *DISubroutineType::getImpl(LLVMContext &Context, DIFlags Flags, 342 uint8_t CC, Metadata *TypeArray, 343 StorageType Storage, 344 bool ShouldCreate) { 345 DEFINE_GETIMPL_LOOKUP(DISubroutineType, (Flags, CC, TypeArray)); 346 Metadata *Ops[] = {nullptr, nullptr, nullptr, TypeArray}; 347 DEFINE_GETIMPL_STORE(DISubroutineType, (Flags, CC), Ops); 348 } 349 350 static const char *ChecksumKindName[DIFile::CSK_Last + 1] = { 351 "CSK_None", 352 "CSK_MD5", 353 "CSK_SHA1" 354 }; 355 356 DIFile::ChecksumKind DIFile::getChecksumKind(StringRef CSKindStr) { 357 return StringSwitch<DIFile::ChecksumKind>(CSKindStr) 358 .Case("CSK_MD5", DIFile::CSK_MD5) 359 .Case("CSK_SHA1", DIFile::CSK_SHA1) 360 .Default(DIFile::CSK_None); 361 } 362 363 StringRef DIFile::getChecksumKindAsString() const { 364 assert(CSKind <= DIFile::CSK_Last && "Invalid checksum kind"); 365 return ChecksumKindName[CSKind]; 366 } 367 368 DIFile *DIFile::getImpl(LLVMContext &Context, MDString *Filename, 369 MDString *Directory, DIFile::ChecksumKind CSKind, 370 MDString *Checksum, StorageType Storage, 371 bool ShouldCreate) { 372 assert(isCanonical(Filename) && "Expected canonical MDString"); 373 assert(isCanonical(Directory) && "Expected canonical MDString"); 374 assert(isCanonical(Checksum) && "Expected canonical MDString"); 375 DEFINE_GETIMPL_LOOKUP(DIFile, (Filename, Directory, CSKind, Checksum)); 376 Metadata *Ops[] = {Filename, Directory, Checksum}; 377 DEFINE_GETIMPL_STORE(DIFile, (CSKind), Ops); 378 } 379 380 DICompileUnit *DICompileUnit::getImpl( 381 LLVMContext &Context, unsigned SourceLanguage, Metadata *File, 382 MDString *Producer, bool IsOptimized, MDString *Flags, 383 unsigned RuntimeVersion, MDString *SplitDebugFilename, 384 unsigned EmissionKind, Metadata *EnumTypes, Metadata *RetainedTypes, 385 Metadata *GlobalVariables, Metadata *ImportedEntities, Metadata *Macros, 386 uint64_t DWOId, bool SplitDebugInlining, bool DebugInfoForProfiling, 387 StorageType Storage, bool ShouldCreate) { 388 assert(Storage != Uniqued && "Cannot unique DICompileUnit"); 389 assert(isCanonical(Producer) && "Expected canonical MDString"); 390 assert(isCanonical(Flags) && "Expected canonical MDString"); 391 assert(isCanonical(SplitDebugFilename) && "Expected canonical MDString"); 392 393 Metadata *Ops[] = { 394 File, Producer, Flags, SplitDebugFilename, 395 EnumTypes, RetainedTypes, GlobalVariables, ImportedEntities, 396 Macros}; 397 return storeImpl(new (array_lengthof(Ops)) 398 DICompileUnit(Context, Storage, SourceLanguage, 399 IsOptimized, RuntimeVersion, EmissionKind, 400 DWOId, SplitDebugInlining, 401 DebugInfoForProfiling, Ops), 402 Storage); 403 } 404 405 Optional<DICompileUnit::DebugEmissionKind> 406 DICompileUnit::getEmissionKind(StringRef Str) { 407 return StringSwitch<Optional<DebugEmissionKind>>(Str) 408 .Case("NoDebug", NoDebug) 409 .Case("FullDebug", FullDebug) 410 .Case("LineTablesOnly", LineTablesOnly) 411 .Default(None); 412 } 413 414 const char *DICompileUnit::EmissionKindString(DebugEmissionKind EK) { 415 switch (EK) { 416 case NoDebug: return "NoDebug"; 417 case FullDebug: return "FullDebug"; 418 case LineTablesOnly: return "LineTablesOnly"; 419 } 420 return nullptr; 421 } 422 423 DISubprogram *DILocalScope::getSubprogram() const { 424 if (auto *Block = dyn_cast<DILexicalBlockBase>(this)) 425 return Block->getScope()->getSubprogram(); 426 return const_cast<DISubprogram *>(cast<DISubprogram>(this)); 427 } 428 429 DILocalScope *DILocalScope::getNonLexicalBlockFileScope() const { 430 if (auto *File = dyn_cast<DILexicalBlockFile>(this)) 431 return File->getScope()->getNonLexicalBlockFileScope(); 432 return const_cast<DILocalScope *>(this); 433 } 434 435 DISubprogram *DISubprogram::getImpl( 436 LLVMContext &Context, Metadata *Scope, MDString *Name, 437 MDString *LinkageName, Metadata *File, unsigned Line, Metadata *Type, 438 bool IsLocalToUnit, bool IsDefinition, unsigned ScopeLine, 439 Metadata *ContainingType, unsigned Virtuality, unsigned VirtualIndex, 440 int ThisAdjustment, DIFlags Flags, bool IsOptimized, Metadata *Unit, 441 Metadata *TemplateParams, Metadata *Declaration, Metadata *Variables, 442 StorageType Storage, bool ShouldCreate) { 443 assert(isCanonical(Name) && "Expected canonical MDString"); 444 assert(isCanonical(LinkageName) && "Expected canonical MDString"); 445 DEFINE_GETIMPL_LOOKUP( 446 DISubprogram, 447 (Scope, Name, LinkageName, File, Line, Type, IsLocalToUnit, IsDefinition, 448 ScopeLine, ContainingType, Virtuality, VirtualIndex, ThisAdjustment, 449 Flags, IsOptimized, Unit, TemplateParams, Declaration, Variables)); 450 Metadata *Ops[] = {File, Scope, Name, Name, 451 LinkageName, Type, ContainingType, Unit, 452 TemplateParams, Declaration, Variables}; 453 DEFINE_GETIMPL_STORE(DISubprogram, (Line, ScopeLine, Virtuality, VirtualIndex, 454 ThisAdjustment, Flags, IsLocalToUnit, 455 IsDefinition, IsOptimized), 456 Ops); 457 } 458 459 bool DISubprogram::describes(const Function *F) const { 460 assert(F && "Invalid function"); 461 if (F->getSubprogram() == this) 462 return true; 463 StringRef Name = getLinkageName(); 464 if (Name.empty()) 465 Name = getName(); 466 return F->getName() == Name; 467 } 468 469 DILexicalBlock *DILexicalBlock::getImpl(LLVMContext &Context, Metadata *Scope, 470 Metadata *File, unsigned Line, 471 unsigned Column, StorageType Storage, 472 bool ShouldCreate) { 473 // Fixup column. 474 adjustColumn(Column); 475 476 assert(Scope && "Expected scope"); 477 DEFINE_GETIMPL_LOOKUP(DILexicalBlock, (Scope, File, Line, Column)); 478 Metadata *Ops[] = {File, Scope}; 479 DEFINE_GETIMPL_STORE(DILexicalBlock, (Line, Column), Ops); 480 } 481 482 DILexicalBlockFile *DILexicalBlockFile::getImpl(LLVMContext &Context, 483 Metadata *Scope, Metadata *File, 484 unsigned Discriminator, 485 StorageType Storage, 486 bool ShouldCreate) { 487 assert(Scope && "Expected scope"); 488 DEFINE_GETIMPL_LOOKUP(DILexicalBlockFile, (Scope, File, Discriminator)); 489 Metadata *Ops[] = {File, Scope}; 490 DEFINE_GETIMPL_STORE(DILexicalBlockFile, (Discriminator), Ops); 491 } 492 493 DINamespace *DINamespace::getImpl(LLVMContext &Context, Metadata *Scope, 494 Metadata *File, MDString *Name, unsigned Line, 495 bool ExportSymbols, StorageType Storage, 496 bool ShouldCreate) { 497 assert(isCanonical(Name) && "Expected canonical MDString"); 498 DEFINE_GETIMPL_LOOKUP(DINamespace, (Scope, File, Name, Line, ExportSymbols)); 499 Metadata *Ops[] = {File, Scope, Name}; 500 DEFINE_GETIMPL_STORE(DINamespace, (Line, ExportSymbols), Ops); 501 } 502 503 DIModule *DIModule::getImpl(LLVMContext &Context, Metadata *Scope, 504 MDString *Name, MDString *ConfigurationMacros, 505 MDString *IncludePath, MDString *ISysRoot, 506 StorageType Storage, bool ShouldCreate) { 507 assert(isCanonical(Name) && "Expected canonical MDString"); 508 DEFINE_GETIMPL_LOOKUP( 509 DIModule, (Scope, Name, ConfigurationMacros, IncludePath, ISysRoot)); 510 Metadata *Ops[] = {Scope, Name, ConfigurationMacros, IncludePath, ISysRoot}; 511 DEFINE_GETIMPL_STORE_NO_CONSTRUCTOR_ARGS(DIModule, Ops); 512 } 513 514 DITemplateTypeParameter *DITemplateTypeParameter::getImpl(LLVMContext &Context, 515 MDString *Name, 516 Metadata *Type, 517 StorageType Storage, 518 bool ShouldCreate) { 519 assert(isCanonical(Name) && "Expected canonical MDString"); 520 DEFINE_GETIMPL_LOOKUP(DITemplateTypeParameter, (Name, Type)); 521 Metadata *Ops[] = {Name, Type}; 522 DEFINE_GETIMPL_STORE_NO_CONSTRUCTOR_ARGS(DITemplateTypeParameter, Ops); 523 } 524 525 DITemplateValueParameter *DITemplateValueParameter::getImpl( 526 LLVMContext &Context, unsigned Tag, MDString *Name, Metadata *Type, 527 Metadata *Value, StorageType Storage, bool ShouldCreate) { 528 assert(isCanonical(Name) && "Expected canonical MDString"); 529 DEFINE_GETIMPL_LOOKUP(DITemplateValueParameter, (Tag, Name, Type, Value)); 530 Metadata *Ops[] = {Name, Type, Value}; 531 DEFINE_GETIMPL_STORE(DITemplateValueParameter, (Tag), Ops); 532 } 533 534 DIGlobalVariable * 535 DIGlobalVariable::getImpl(LLVMContext &Context, Metadata *Scope, MDString *Name, 536 MDString *LinkageName, Metadata *File, unsigned Line, 537 Metadata *Type, bool IsLocalToUnit, bool IsDefinition, 538 Metadata *StaticDataMemberDeclaration, 539 uint32_t AlignInBits, StorageType Storage, 540 bool ShouldCreate) { 541 assert(isCanonical(Name) && "Expected canonical MDString"); 542 assert(isCanonical(LinkageName) && "Expected canonical MDString"); 543 DEFINE_GETIMPL_LOOKUP(DIGlobalVariable, 544 (Scope, Name, LinkageName, File, Line, Type, 545 IsLocalToUnit, IsDefinition, 546 StaticDataMemberDeclaration, AlignInBits)); 547 Metadata *Ops[] = { 548 Scope, Name, File, Type, Name, LinkageName, StaticDataMemberDeclaration}; 549 DEFINE_GETIMPL_STORE(DIGlobalVariable, 550 (Line, IsLocalToUnit, IsDefinition, AlignInBits), 551 Ops); 552 } 553 554 DILocalVariable *DILocalVariable::getImpl(LLVMContext &Context, Metadata *Scope, 555 MDString *Name, Metadata *File, 556 unsigned Line, Metadata *Type, 557 unsigned Arg, DIFlags Flags, 558 uint32_t AlignInBits, 559 StorageType Storage, 560 bool ShouldCreate) { 561 // 64K ought to be enough for any frontend. 562 assert(Arg <= UINT16_MAX && "Expected argument number to fit in 16-bits"); 563 564 assert(Scope && "Expected scope"); 565 assert(isCanonical(Name) && "Expected canonical MDString"); 566 DEFINE_GETIMPL_LOOKUP(DILocalVariable, 567 (Scope, Name, File, Line, Type, Arg, Flags, 568 AlignInBits)); 569 Metadata *Ops[] = {Scope, Name, File, Type}; 570 DEFINE_GETIMPL_STORE(DILocalVariable, (Line, Arg, Flags, AlignInBits), Ops); 571 } 572 573 DIExpression *DIExpression::getImpl(LLVMContext &Context, 574 ArrayRef<uint64_t> Elements, 575 StorageType Storage, bool ShouldCreate) { 576 DEFINE_GETIMPL_LOOKUP(DIExpression, (Elements)); 577 DEFINE_GETIMPL_STORE_NO_OPS(DIExpression, (Elements)); 578 } 579 580 unsigned DIExpression::ExprOperand::getSize() const { 581 switch (getOp()) { 582 case dwarf::DW_OP_LLVM_fragment: 583 return 3; 584 case dwarf::DW_OP_constu: 585 case dwarf::DW_OP_plus: 586 case dwarf::DW_OP_minus: 587 return 2; 588 default: 589 return 1; 590 } 591 } 592 593 bool DIExpression::isValid() const { 594 for (auto I = expr_op_begin(), E = expr_op_end(); I != E; ++I) { 595 // Check that there's space for the operand. 596 if (I->get() + I->getSize() > E->get()) 597 return false; 598 599 // Check that the operand is valid. 600 switch (I->getOp()) { 601 default: 602 return false; 603 case dwarf::DW_OP_LLVM_fragment: 604 // A fragment operator must appear at the end. 605 return I->get() + I->getSize() == E->get(); 606 case dwarf::DW_OP_stack_value: { 607 // Must be the last one or followed by a DW_OP_LLVM_fragment. 608 if (I->get() + I->getSize() == E->get()) 609 break; 610 auto J = I; 611 if ((++J)->getOp() != dwarf::DW_OP_LLVM_fragment) 612 return false; 613 break; 614 } 615 case dwarf::DW_OP_constu: 616 case dwarf::DW_OP_plus: 617 case dwarf::DW_OP_minus: 618 case dwarf::DW_OP_deref: 619 break; 620 } 621 } 622 return true; 623 } 624 625 Optional<DIExpression::FragmentInfo> 626 DIExpression::getFragmentInfo(expr_op_iterator Start, expr_op_iterator End) { 627 for (auto I = Start; I != End; ++I) 628 if (I->getOp() == dwarf::DW_OP_LLVM_fragment) { 629 DIExpression::FragmentInfo Info = {I->getArg(1), I->getArg(0)}; 630 return Info; 631 } 632 return None; 633 } 634 635 bool DIExpression::isConstant() const { 636 // Recognize DW_OP_constu C DW_OP_stack_value (DW_OP_LLVM_fragment Len Ofs)?. 637 if (getNumElements() != 3 && getNumElements() != 6) 638 return false; 639 if (getElement(0) != dwarf::DW_OP_constu || 640 getElement(2) != dwarf::DW_OP_stack_value) 641 return false; 642 if (getNumElements() == 6 && getElement(3) != dwarf::DW_OP_LLVM_fragment) 643 return false; 644 return true; 645 } 646 647 DIGlobalVariableExpression * 648 DIGlobalVariableExpression::getImpl(LLVMContext &Context, Metadata *Variable, 649 Metadata *Expression, StorageType Storage, 650 bool ShouldCreate) { 651 DEFINE_GETIMPL_LOOKUP(DIGlobalVariableExpression, (Variable, Expression)); 652 Metadata *Ops[] = {Variable, Expression}; 653 DEFINE_GETIMPL_STORE_NO_CONSTRUCTOR_ARGS(DIGlobalVariableExpression, Ops); 654 } 655 656 DIObjCProperty *DIObjCProperty::getImpl( 657 LLVMContext &Context, MDString *Name, Metadata *File, unsigned Line, 658 MDString *GetterName, MDString *SetterName, unsigned Attributes, 659 Metadata *Type, StorageType Storage, bool ShouldCreate) { 660 assert(isCanonical(Name) && "Expected canonical MDString"); 661 assert(isCanonical(GetterName) && "Expected canonical MDString"); 662 assert(isCanonical(SetterName) && "Expected canonical MDString"); 663 DEFINE_GETIMPL_LOOKUP(DIObjCProperty, (Name, File, Line, GetterName, 664 SetterName, Attributes, Type)); 665 Metadata *Ops[] = {Name, File, GetterName, SetterName, Type}; 666 DEFINE_GETIMPL_STORE(DIObjCProperty, (Line, Attributes), Ops); 667 } 668 669 DIImportedEntity *DIImportedEntity::getImpl(LLVMContext &Context, unsigned Tag, 670 Metadata *Scope, Metadata *Entity, 671 unsigned Line, MDString *Name, 672 StorageType Storage, 673 bool ShouldCreate) { 674 assert(isCanonical(Name) && "Expected canonical MDString"); 675 DEFINE_GETIMPL_LOOKUP(DIImportedEntity, (Tag, Scope, Entity, Line, Name)); 676 Metadata *Ops[] = {Scope, Entity, Name}; 677 DEFINE_GETIMPL_STORE(DIImportedEntity, (Tag, Line), Ops); 678 } 679 680 DIMacro *DIMacro::getImpl(LLVMContext &Context, unsigned MIType, 681 unsigned Line, MDString *Name, MDString *Value, 682 StorageType Storage, bool ShouldCreate) { 683 assert(isCanonical(Name) && "Expected canonical MDString"); 684 DEFINE_GETIMPL_LOOKUP(DIMacro, (MIType, Line, Name, Value)); 685 Metadata *Ops[] = { Name, Value }; 686 DEFINE_GETIMPL_STORE(DIMacro, (MIType, Line), Ops); 687 } 688 689 DIMacroFile *DIMacroFile::getImpl(LLVMContext &Context, unsigned MIType, 690 unsigned Line, Metadata *File, 691 Metadata *Elements, StorageType Storage, 692 bool ShouldCreate) { 693 DEFINE_GETIMPL_LOOKUP(DIMacroFile, 694 (MIType, Line, File, Elements)); 695 Metadata *Ops[] = { File, Elements }; 696 DEFINE_GETIMPL_STORE(DIMacroFile, (MIType, Line), Ops); 697 } 698 699