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 DIFile *DIFile::getImpl(LLVMContext &Context, MDString *Filename, 351 MDString *Directory, StorageType Storage, 352 bool ShouldCreate) { 353 assert(isCanonical(Filename) && "Expected canonical MDString"); 354 assert(isCanonical(Directory) && "Expected canonical MDString"); 355 DEFINE_GETIMPL_LOOKUP(DIFile, (Filename, Directory)); 356 Metadata *Ops[] = {Filename, Directory}; 357 DEFINE_GETIMPL_STORE_NO_CONSTRUCTOR_ARGS(DIFile, Ops); 358 } 359 360 DICompileUnit *DICompileUnit::getImpl( 361 LLVMContext &Context, unsigned SourceLanguage, Metadata *File, 362 MDString *Producer, bool IsOptimized, MDString *Flags, 363 unsigned RuntimeVersion, MDString *SplitDebugFilename, 364 unsigned EmissionKind, Metadata *EnumTypes, Metadata *RetainedTypes, 365 Metadata *GlobalVariables, Metadata *ImportedEntities, Metadata *Macros, 366 uint64_t DWOId, bool SplitDebugInlining, StorageType Storage, 367 bool ShouldCreate) { 368 assert(Storage != Uniqued && "Cannot unique DICompileUnit"); 369 assert(isCanonical(Producer) && "Expected canonical MDString"); 370 assert(isCanonical(Flags) && "Expected canonical MDString"); 371 assert(isCanonical(SplitDebugFilename) && "Expected canonical MDString"); 372 373 Metadata *Ops[] = { 374 File, Producer, Flags, SplitDebugFilename, 375 EnumTypes, RetainedTypes, GlobalVariables, ImportedEntities, 376 Macros}; 377 return storeImpl(new (array_lengthof(Ops)) 378 DICompileUnit(Context, Storage, SourceLanguage, 379 IsOptimized, RuntimeVersion, EmissionKind, 380 DWOId, SplitDebugInlining, Ops), 381 Storage); 382 } 383 384 Optional<DICompileUnit::DebugEmissionKind> 385 DICompileUnit::getEmissionKind(StringRef Str) { 386 return StringSwitch<Optional<DebugEmissionKind>>(Str) 387 .Case("NoDebug", NoDebug) 388 .Case("FullDebug", FullDebug) 389 .Case("LineTablesOnly", LineTablesOnly) 390 .Default(None); 391 } 392 393 const char *DICompileUnit::EmissionKindString(DebugEmissionKind EK) { 394 switch (EK) { 395 case NoDebug: return "NoDebug"; 396 case FullDebug: return "FullDebug"; 397 case LineTablesOnly: return "LineTablesOnly"; 398 } 399 return nullptr; 400 } 401 402 DISubprogram *DILocalScope::getSubprogram() const { 403 if (auto *Block = dyn_cast<DILexicalBlockBase>(this)) 404 return Block->getScope()->getSubprogram(); 405 return const_cast<DISubprogram *>(cast<DISubprogram>(this)); 406 } 407 408 DILocalScope *DILocalScope::getNonLexicalBlockFileScope() const { 409 if (auto *File = dyn_cast<DILexicalBlockFile>(this)) 410 return File->getScope()->getNonLexicalBlockFileScope(); 411 return const_cast<DILocalScope *>(this); 412 } 413 414 DISubprogram *DISubprogram::getImpl( 415 LLVMContext &Context, Metadata *Scope, MDString *Name, 416 MDString *LinkageName, Metadata *File, unsigned Line, Metadata *Type, 417 bool IsLocalToUnit, bool IsDefinition, unsigned ScopeLine, 418 Metadata *ContainingType, unsigned Virtuality, unsigned VirtualIndex, 419 int ThisAdjustment, DIFlags Flags, bool IsOptimized, Metadata *Unit, 420 Metadata *TemplateParams, Metadata *Declaration, Metadata *Variables, 421 StorageType Storage, bool ShouldCreate) { 422 assert(isCanonical(Name) && "Expected canonical MDString"); 423 assert(isCanonical(LinkageName) && "Expected canonical MDString"); 424 DEFINE_GETIMPL_LOOKUP( 425 DISubprogram, 426 (Scope, Name, LinkageName, File, Line, Type, IsLocalToUnit, IsDefinition, 427 ScopeLine, ContainingType, Virtuality, VirtualIndex, ThisAdjustment, 428 Flags, IsOptimized, Unit, TemplateParams, Declaration, Variables)); 429 Metadata *Ops[] = {File, Scope, Name, Name, 430 LinkageName, Type, ContainingType, Unit, 431 TemplateParams, Declaration, Variables}; 432 DEFINE_GETIMPL_STORE(DISubprogram, (Line, ScopeLine, Virtuality, VirtualIndex, 433 ThisAdjustment, Flags, IsLocalToUnit, 434 IsDefinition, IsOptimized), 435 Ops); 436 } 437 438 bool DISubprogram::describes(const Function *F) const { 439 assert(F && "Invalid function"); 440 if (F->getSubprogram() == this) 441 return true; 442 StringRef Name = getLinkageName(); 443 if (Name.empty()) 444 Name = getName(); 445 return F->getName() == Name; 446 } 447 448 DILexicalBlock *DILexicalBlock::getImpl(LLVMContext &Context, Metadata *Scope, 449 Metadata *File, unsigned Line, 450 unsigned Column, StorageType Storage, 451 bool ShouldCreate) { 452 // Fixup column. 453 adjustColumn(Column); 454 455 assert(Scope && "Expected scope"); 456 DEFINE_GETIMPL_LOOKUP(DILexicalBlock, (Scope, File, Line, Column)); 457 Metadata *Ops[] = {File, Scope}; 458 DEFINE_GETIMPL_STORE(DILexicalBlock, (Line, Column), Ops); 459 } 460 461 DILexicalBlockFile *DILexicalBlockFile::getImpl(LLVMContext &Context, 462 Metadata *Scope, Metadata *File, 463 unsigned Discriminator, 464 StorageType Storage, 465 bool ShouldCreate) { 466 assert(Scope && "Expected scope"); 467 DEFINE_GETIMPL_LOOKUP(DILexicalBlockFile, (Scope, File, Discriminator)); 468 Metadata *Ops[] = {File, Scope}; 469 DEFINE_GETIMPL_STORE(DILexicalBlockFile, (Discriminator), Ops); 470 } 471 472 DINamespace *DINamespace::getImpl(LLVMContext &Context, Metadata *Scope, 473 Metadata *File, MDString *Name, unsigned Line, 474 bool ExportSymbols, StorageType Storage, 475 bool ShouldCreate) { 476 assert(isCanonical(Name) && "Expected canonical MDString"); 477 DEFINE_GETIMPL_LOOKUP(DINamespace, (Scope, File, Name, Line, ExportSymbols)); 478 Metadata *Ops[] = {File, Scope, Name}; 479 DEFINE_GETIMPL_STORE(DINamespace, (Line, ExportSymbols), Ops); 480 } 481 482 DIModule *DIModule::getImpl(LLVMContext &Context, Metadata *Scope, 483 MDString *Name, MDString *ConfigurationMacros, 484 MDString *IncludePath, MDString *ISysRoot, 485 StorageType Storage, bool ShouldCreate) { 486 assert(isCanonical(Name) && "Expected canonical MDString"); 487 DEFINE_GETIMPL_LOOKUP( 488 DIModule, (Scope, Name, ConfigurationMacros, IncludePath, ISysRoot)); 489 Metadata *Ops[] = {Scope, Name, ConfigurationMacros, IncludePath, ISysRoot}; 490 DEFINE_GETIMPL_STORE_NO_CONSTRUCTOR_ARGS(DIModule, Ops); 491 } 492 493 DITemplateTypeParameter *DITemplateTypeParameter::getImpl(LLVMContext &Context, 494 MDString *Name, 495 Metadata *Type, 496 StorageType Storage, 497 bool ShouldCreate) { 498 assert(isCanonical(Name) && "Expected canonical MDString"); 499 DEFINE_GETIMPL_LOOKUP(DITemplateTypeParameter, (Name, Type)); 500 Metadata *Ops[] = {Name, Type}; 501 DEFINE_GETIMPL_STORE_NO_CONSTRUCTOR_ARGS(DITemplateTypeParameter, Ops); 502 } 503 504 DITemplateValueParameter *DITemplateValueParameter::getImpl( 505 LLVMContext &Context, unsigned Tag, MDString *Name, Metadata *Type, 506 Metadata *Value, StorageType Storage, bool ShouldCreate) { 507 assert(isCanonical(Name) && "Expected canonical MDString"); 508 DEFINE_GETIMPL_LOOKUP(DITemplateValueParameter, (Tag, Name, Type, Value)); 509 Metadata *Ops[] = {Name, Type, Value}; 510 DEFINE_GETIMPL_STORE(DITemplateValueParameter, (Tag), Ops); 511 } 512 513 DIGlobalVariable * 514 DIGlobalVariable::getImpl(LLVMContext &Context, Metadata *Scope, MDString *Name, 515 MDString *LinkageName, Metadata *File, unsigned Line, 516 Metadata *Type, bool IsLocalToUnit, bool IsDefinition, 517 Metadata *Variable, 518 Metadata *StaticDataMemberDeclaration, 519 uint32_t AlignInBits, 520 StorageType Storage, bool ShouldCreate) { 521 assert(isCanonical(Name) && "Expected canonical MDString"); 522 assert(isCanonical(LinkageName) && "Expected canonical MDString"); 523 DEFINE_GETIMPL_LOOKUP(DIGlobalVariable, 524 (Scope, Name, LinkageName, File, Line, Type, 525 IsLocalToUnit, IsDefinition, Variable, 526 StaticDataMemberDeclaration, AlignInBits)); 527 Metadata *Ops[] = {Scope, Name, File, Type, 528 Name, LinkageName, Variable, StaticDataMemberDeclaration}; 529 DEFINE_GETIMPL_STORE(DIGlobalVariable, 530 (Line, IsLocalToUnit, IsDefinition, AlignInBits), 531 Ops); 532 } 533 534 DILocalVariable *DILocalVariable::getImpl(LLVMContext &Context, Metadata *Scope, 535 MDString *Name, Metadata *File, 536 unsigned Line, Metadata *Type, 537 unsigned Arg, DIFlags Flags, 538 uint32_t AlignInBits, 539 StorageType Storage, 540 bool ShouldCreate) { 541 // 64K ought to be enough for any frontend. 542 assert(Arg <= UINT16_MAX && "Expected argument number to fit in 16-bits"); 543 544 assert(Scope && "Expected scope"); 545 assert(isCanonical(Name) && "Expected canonical MDString"); 546 DEFINE_GETIMPL_LOOKUP(DILocalVariable, 547 (Scope, Name, File, Line, Type, Arg, Flags, 548 AlignInBits)); 549 Metadata *Ops[] = {Scope, Name, File, Type}; 550 DEFINE_GETIMPL_STORE(DILocalVariable, (Line, Arg, Flags, AlignInBits), Ops); 551 } 552 553 DIExpression *DIExpression::getImpl(LLVMContext &Context, 554 ArrayRef<uint64_t> Elements, 555 StorageType Storage, bool ShouldCreate) { 556 DEFINE_GETIMPL_LOOKUP(DIExpression, (Elements)); 557 DEFINE_GETIMPL_STORE_NO_OPS(DIExpression, (Elements)); 558 } 559 560 unsigned DIExpression::ExprOperand::getSize() const { 561 switch (getOp()) { 562 case dwarf::DW_OP_bit_piece: 563 return 3; 564 case dwarf::DW_OP_constu: 565 case dwarf::DW_OP_plus: 566 case dwarf::DW_OP_minus: 567 return 2; 568 default: 569 return 1; 570 } 571 } 572 573 bool DIExpression::isValid() const { 574 for (auto I = expr_op_begin(), E = expr_op_end(); I != E; ++I) { 575 // Check that there's space for the operand. 576 if (I->get() + I->getSize() > E->get()) 577 return false; 578 579 // Check that the operand is valid. 580 switch (I->getOp()) { 581 default: 582 return false; 583 case dwarf::DW_OP_bit_piece: 584 case dwarf::DW_OP_stack_value: 585 // We only support bit piece and stack value expressions which appear at 586 // the end. 587 return I->get() + I->getSize() == E->get(); 588 case dwarf::DW_OP_constu: 589 case dwarf::DW_OP_plus: 590 case dwarf::DW_OP_minus: 591 case dwarf::DW_OP_deref: 592 break; 593 } 594 } 595 return true; 596 } 597 598 bool DIExpression::isBitPiece() const { 599 assert(isValid() && "Expected valid expression"); 600 if (unsigned N = getNumElements()) 601 if (N >= 3) 602 return getElement(N - 3) == dwarf::DW_OP_bit_piece; 603 return false; 604 } 605 606 uint64_t DIExpression::getBitPieceOffset() const { 607 assert(isBitPiece() && "Expected bit piece"); 608 return getElement(getNumElements() - 2); 609 } 610 611 uint64_t DIExpression::getBitPieceSize() const { 612 assert(isBitPiece() && "Expected bit piece"); 613 return getElement(getNumElements() - 1); 614 } 615 616 DIObjCProperty *DIObjCProperty::getImpl( 617 LLVMContext &Context, MDString *Name, Metadata *File, unsigned Line, 618 MDString *GetterName, MDString *SetterName, unsigned Attributes, 619 Metadata *Type, StorageType Storage, bool ShouldCreate) { 620 assert(isCanonical(Name) && "Expected canonical MDString"); 621 assert(isCanonical(GetterName) && "Expected canonical MDString"); 622 assert(isCanonical(SetterName) && "Expected canonical MDString"); 623 DEFINE_GETIMPL_LOOKUP(DIObjCProperty, (Name, File, Line, GetterName, 624 SetterName, Attributes, Type)); 625 Metadata *Ops[] = {Name, File, GetterName, SetterName, Type}; 626 DEFINE_GETIMPL_STORE(DIObjCProperty, (Line, Attributes), Ops); 627 } 628 629 DIImportedEntity *DIImportedEntity::getImpl(LLVMContext &Context, unsigned Tag, 630 Metadata *Scope, Metadata *Entity, 631 unsigned Line, MDString *Name, 632 StorageType Storage, 633 bool ShouldCreate) { 634 assert(isCanonical(Name) && "Expected canonical MDString"); 635 DEFINE_GETIMPL_LOOKUP(DIImportedEntity, (Tag, Scope, Entity, Line, Name)); 636 Metadata *Ops[] = {Scope, Entity, Name}; 637 DEFINE_GETIMPL_STORE(DIImportedEntity, (Tag, Line), Ops); 638 } 639 640 DIMacro *DIMacro::getImpl(LLVMContext &Context, unsigned MIType, 641 unsigned Line, MDString *Name, MDString *Value, 642 StorageType Storage, bool ShouldCreate) { 643 assert(isCanonical(Name) && "Expected canonical MDString"); 644 DEFINE_GETIMPL_LOOKUP(DIMacro, (MIType, Line, Name, Value)); 645 Metadata *Ops[] = { Name, Value }; 646 DEFINE_GETIMPL_STORE(DIMacro, (MIType, Line), Ops); 647 } 648 649 DIMacroFile *DIMacroFile::getImpl(LLVMContext &Context, unsigned MIType, 650 unsigned Line, Metadata *File, 651 Metadata *Elements, StorageType Storage, 652 bool ShouldCreate) { 653 DEFINE_GETIMPL_LOOKUP(DIMacroFile, 654 (MIType, Line, File, Elements)); 655 Metadata *Ops[] = { File, Elements }; 656 DEFINE_GETIMPL_STORE(DIMacroFile, (MIType, Line), Ops); 657 } 658 659