1 //===--- llvm/Analysis/DebugInfo.h - Debug Information Helpers --*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file defines a bunch of datatypes that are useful for creating and
11 // walking debug info in LLVM IR form. They essentially provide wrappers around
12 // the information in the global variables that's needed when constructing the
15 //===----------------------------------------------------------------------===//
17 #ifndef LLVM_DEBUGINFO_H
18 #define LLVM_DEBUGINFO_H
20 #include "llvm/Support/Casting.h"
21 #include "llvm/ADT/DenseMap.h"
22 #include "llvm/ADT/SmallPtrSet.h"
23 #include "llvm/ADT/SmallVector.h"
24 #include "llvm/ADT/StringRef.h"
25 #include "llvm/IR/Metadata.h"
26 #include "llvm/Support/Dwarf.h"
48 class DILexicalBlockFile;
54 /// Maps from type identifier to the actual MDNode.
55 typedef DenseMap<const MDString *, MDNode *> DITypeIdentifierMap;
57 /// DIDescriptor - A thin wraper around MDNode to access encoded debug info.
58 /// This should not be stored in a container, because the underlying MDNode
59 /// may change in certain situations.
61 // Befriends DIRef so DIRef can befriend the protected member
62 // function: getFieldAs<DIRef>.
63 template <typename T> friend class DIRef;
68 FlagProtected = 1 << 1,
70 FlagAppleBlock = 1 << 3,
71 FlagBlockByrefStruct = 1 << 4,
73 FlagArtificial = 1 << 6,
74 FlagExplicit = 1 << 7,
75 FlagPrototyped = 1 << 8,
76 FlagObjcClassComplete = 1 << 9,
77 FlagObjectPointer = 1 << 10,
79 FlagStaticMember = 1 << 12,
80 FlagIndirectVariable = 1 << 13
84 const MDNode *DbgNode;
86 StringRef getStringField(unsigned Elt) const;
87 unsigned getUnsignedField(unsigned Elt) const {
88 return (unsigned)getUInt64Field(Elt);
90 uint64_t getUInt64Field(unsigned Elt) const;
91 int64_t getInt64Field(unsigned Elt) const;
92 DIDescriptor getDescriptorField(unsigned Elt) const;
94 template <typename DescTy> DescTy getFieldAs(unsigned Elt) const {
95 return DescTy(getDescriptorField(Elt));
98 GlobalVariable *getGlobalVariableField(unsigned Elt) const;
99 Constant *getConstantField(unsigned Elt) const;
100 Function *getFunctionField(unsigned Elt) const;
101 void replaceFunctionField(unsigned Elt, Function *F);
104 explicit DIDescriptor(const MDNode *N = 0) : DbgNode(N) {}
108 operator MDNode *() const { return const_cast<MDNode *>(DbgNode); }
109 MDNode *operator->() const { return const_cast<MDNode *>(DbgNode); }
111 // An explicit operator bool so that we can do testing of DI values
113 // FIXME: This operator bool isn't actually protecting anything at the
114 // moment due to the conversion operator above making DIDescriptor nodes
115 // implicitly convertable to bool.
116 LLVM_EXPLICIT operator bool() const { return DbgNode != 0; }
118 bool operator==(DIDescriptor Other) const { return DbgNode == Other.DbgNode; }
119 bool operator!=(DIDescriptor Other) const { return !operator==(Other); }
121 uint16_t getTag() const {
122 return getUnsignedField(0) & ~LLVMDebugVersionMask;
125 bool isDerivedType() const;
126 bool isCompositeType() const;
127 bool isBasicType() const;
128 bool isVariable() const;
129 bool isSubprogram() const;
130 bool isGlobalVariable() const;
131 bool isScope() const;
133 bool isCompileUnit() const;
134 bool isNameSpace() const;
135 bool isLexicalBlockFile() const;
136 bool isLexicalBlock() const;
137 bool isSubrange() const;
138 bool isEnumerator() const;
140 bool isUnspecifiedParameter() const;
141 bool isTemplateTypeParameter() const;
142 bool isTemplateValueParameter() const;
143 bool isObjCProperty() const;
144 bool isImportedEntity() const;
146 /// print - print descriptor.
147 void print(raw_ostream &OS) const;
149 /// dump - print descriptor to dbgs() with a newline.
153 /// DISubrange - This is used to represent ranges, for array bounds.
154 class DISubrange : public DIDescriptor {
155 friend class DIDescriptor;
156 void printInternal(raw_ostream &OS) const;
159 explicit DISubrange(const MDNode *N = 0) : DIDescriptor(N) {}
161 int64_t getLo() const { return getInt64Field(1); }
162 int64_t getCount() const { return getInt64Field(2); }
166 /// DIArray - This descriptor holds an array of descriptors.
167 class DIArray : public DIDescriptor {
169 explicit DIArray(const MDNode *N = 0) : DIDescriptor(N) {}
171 unsigned getNumElements() const;
172 DIDescriptor getElement(unsigned Idx) const {
173 return getDescriptorField(Idx);
177 /// DIEnumerator - A wrapper for an enumerator (e.g. X and Y in 'enum {X,Y}').
178 /// FIXME: it seems strange that this doesn't have either a reference to the
179 /// type/precision or a file/line pair for location info.
180 class DIEnumerator : public DIDescriptor {
181 friend class DIDescriptor;
182 void printInternal(raw_ostream &OS) const;
185 explicit DIEnumerator(const MDNode *N = 0) : DIDescriptor(N) {}
187 StringRef getName() const { return getStringField(1); }
188 int64_t getEnumValue() const { return getInt64Field(2); }
192 template <typename T> class DIRef;
193 typedef DIRef<DIScope> DIScopeRef;
194 typedef DIRef<DIType> DITypeRef;
196 /// DIScope - A base class for various scopes.
197 class DIScope : public DIDescriptor {
199 friend class DIDescriptor;
200 void printInternal(raw_ostream &OS) const;
203 explicit DIScope(const MDNode *N = 0) : DIDescriptor(N) {}
205 /// Gets the parent scope for this scope node or returns a
206 /// default constructed scope.
207 DIScopeRef getContext() const;
208 /// If the scope node has a name, return that, else return an empty string.
209 StringRef getName() const;
210 StringRef getFilename() const;
211 StringRef getDirectory() const;
213 /// Generate a reference to this DIScope. Uses the type identifier instead
214 /// of the actual MDNode if possible, to help type uniquing.
215 DIScopeRef getRef() const;
218 /// Represents reference to a DIDescriptor, abstracts over direct and
219 /// identifier-based metadata references.
220 template <typename T> class DIRef {
221 template <typename DescTy>
222 friend DescTy DIDescriptor::getFieldAs(unsigned Elt) const;
223 friend DIScopeRef DIScope::getContext() const;
224 friend DIScopeRef DIScope::getRef() const;
226 /// Val can be either a MDNode or a MDString, in the latter,
227 /// MDString specifies the type identifier.
229 explicit DIRef(const Value *V);
232 T resolve(const DITypeIdentifierMap &Map) const;
233 StringRef getName() const;
234 operator Value *() const { return const_cast<Value *>(Val); }
237 template <typename T>
238 T DIRef<T>::resolve(const DITypeIdentifierMap &Map) const {
242 if (const MDNode *MD = dyn_cast<MDNode>(Val))
245 const MDString *MS = cast<MDString>(Val);
246 // Find the corresponding MDNode.
247 DITypeIdentifierMap::const_iterator Iter = Map.find(MS);
248 assert(Iter != Map.end() && "Identifier not in the type map?");
249 assert(DIDescriptor(Iter->second).isType() &&
250 "MDNode in DITypeIdentifierMap should be a DIType.");
251 return T(Iter->second);
254 template <typename T> StringRef DIRef<T>::getName() const {
258 if (const MDNode *MD = dyn_cast<MDNode>(Val))
259 return T(MD).getName();
261 const MDString *MS = cast<MDString>(Val);
262 return MS->getString();
265 /// Specialize getFieldAs to handle fields that are references to DIScopes.
266 template <> DIScopeRef DIDescriptor::getFieldAs<DIScopeRef>(unsigned Elt) const;
267 /// Specialize DIRef constructor for DIScopeRef.
268 template <> DIRef<DIScope>::DIRef(const Value *V);
270 /// Specialize getFieldAs to handle fields that are references to DITypes.
271 template <> DITypeRef DIDescriptor::getFieldAs<DITypeRef>(unsigned Elt) const;
272 /// Specialize DIRef constructor for DITypeRef.
273 template <> DIRef<DIType>::DIRef(const Value *V);
275 /// DIType - This is a wrapper for a type.
276 /// FIXME: Types should be factored much better so that CV qualifiers and
277 /// others do not require a huge and empty descriptor full of zeros.
278 class DIType : public DIScope {
280 friend class DIDescriptor;
281 void printInternal(raw_ostream &OS) const;
284 explicit DIType(const MDNode *N = 0) : DIScope(N) {}
286 /// Verify - Verify that a type descriptor is well formed.
289 DIScopeRef getContext() const { return getFieldAs<DIScopeRef>(2); }
290 StringRef getName() const { return getStringField(3); }
291 unsigned getLineNumber() const { return getUnsignedField(4); }
292 uint64_t getSizeInBits() const { return getUInt64Field(5); }
293 uint64_t getAlignInBits() const { return getUInt64Field(6); }
294 // FIXME: Offset is only used for DW_TAG_member nodes. Making every type
295 // carry this is just plain insane.
296 uint64_t getOffsetInBits() const { return getUInt64Field(7); }
297 unsigned getFlags() const { return getUnsignedField(8); }
298 bool isPrivate() const { return (getFlags() & FlagPrivate) != 0; }
299 bool isProtected() const { return (getFlags() & FlagProtected) != 0; }
300 bool isForwardDecl() const { return (getFlags() & FlagFwdDecl) != 0; }
301 // isAppleBlock - Return true if this is the Apple Blocks extension.
302 bool isAppleBlockExtension() const {
303 return (getFlags() & FlagAppleBlock) != 0;
305 bool isBlockByrefStruct() const {
306 return (getFlags() & FlagBlockByrefStruct) != 0;
308 bool isVirtual() const { return (getFlags() & FlagVirtual) != 0; }
309 bool isArtificial() const { return (getFlags() & FlagArtificial) != 0; }
310 bool isObjectPointer() const { return (getFlags() & FlagObjectPointer) != 0; }
311 bool isObjcClassComplete() const {
312 return (getFlags() & FlagObjcClassComplete) != 0;
314 bool isVector() const { return (getFlags() & FlagVector) != 0; }
315 bool isStaticMember() const { return (getFlags() & FlagStaticMember) != 0; }
316 bool isValid() const { return DbgNode && isType(); }
318 /// replaceAllUsesWith - Replace all uses of debug info referenced by
320 void replaceAllUsesWith(DIDescriptor &D);
321 void replaceAllUsesWith(MDNode *D);
324 /// DIBasicType - A basic type, like 'int' or 'float'.
325 class DIBasicType : public DIType {
327 explicit DIBasicType(const MDNode *N = 0) : DIType(N) {}
329 unsigned getEncoding() const { return getUnsignedField(9); }
331 /// Verify - Verify that a basic type descriptor is well formed.
335 /// DIDerivedType - A simple derived type, like a const qualified type,
336 /// a typedef, a pointer or reference, et cetera. Or, a data member of
337 /// a class/struct/union.
338 class DIDerivedType : public DIType {
339 friend class DIDescriptor;
340 void printInternal(raw_ostream &OS) const;
343 explicit DIDerivedType(const MDNode *N = 0) : DIType(N) {}
345 DITypeRef getTypeDerivedFrom() const { return getFieldAs<DITypeRef>(9); }
347 /// getObjCProperty - Return property node, if this ivar is
348 /// associated with one.
349 MDNode *getObjCProperty() const;
351 DITypeRef getClassType() const {
352 assert(getTag() == dwarf::DW_TAG_ptr_to_member_type);
353 return getFieldAs<DITypeRef>(10);
356 Constant *getConstant() const {
357 assert((getTag() == dwarf::DW_TAG_member) && isStaticMember());
358 return getConstantField(10);
361 /// Verify - Verify that a derived type descriptor is well formed.
365 /// DICompositeType - This descriptor holds a type that can refer to multiple
366 /// other types, like a function or struct.
367 /// DICompositeType is derived from DIDerivedType because some
368 /// composite types (such as enums) can be derived from basic types
369 // FIXME: Make this derive from DIType directly & just store the
370 // base type in a single DIType field.
371 class DICompositeType : public DIDerivedType {
372 friend class DIDescriptor;
373 void printInternal(raw_ostream &OS) const;
376 explicit DICompositeType(const MDNode *N = 0) : DIDerivedType(N) {}
378 DIArray getTypeArray() const { return getFieldAs<DIArray>(10); }
379 void setTypeArray(DIArray Elements, DIArray TParams = DIArray());
380 void addMember(DIDescriptor D);
381 unsigned getRunTimeLang() const { return getUnsignedField(11); }
382 DITypeRef getContainingType() const { return getFieldAs<DITypeRef>(12); }
383 void setContainingType(DICompositeType ContainingType);
384 DIArray getTemplateParams() const { return getFieldAs<DIArray>(13); }
385 MDString *getIdentifier() const;
387 /// Verify - Verify that a composite type descriptor is well formed.
391 /// DIFile - This is a wrapper for a file.
392 class DIFile : public DIScope {
393 friend class DIDescriptor;
396 explicit DIFile(const MDNode *N = 0) : DIScope(N) {}
397 MDNode *getFileNode() const;
401 /// DICompileUnit - A wrapper for a compile unit.
402 class DICompileUnit : public DIScope {
403 friend class DIDescriptor;
404 void printInternal(raw_ostream &OS) const;
407 explicit DICompileUnit(const MDNode *N = 0) : DIScope(N) {}
409 unsigned getLanguage() const { return getUnsignedField(2); }
410 StringRef getProducer() const { return getStringField(3); }
412 bool isOptimized() const { return getUnsignedField(4) != 0; }
413 StringRef getFlags() const { return getStringField(5); }
414 unsigned getRunTimeVersion() const { return getUnsignedField(6); }
416 DIArray getEnumTypes() const;
417 DIArray getRetainedTypes() const;
418 DIArray getSubprograms() const;
419 DIArray getGlobalVariables() const;
420 DIArray getImportedEntities() const;
422 StringRef getSplitDebugFilename() const { return getStringField(12); }
424 /// Verify - Verify that a compile unit is well formed.
428 /// DISubprogram - This is a wrapper for a subprogram (e.g. a function).
429 class DISubprogram : public DIScope {
430 friend class DIDescriptor;
431 void printInternal(raw_ostream &OS) const;
434 explicit DISubprogram(const MDNode *N = 0) : DIScope(N) {}
436 DIScopeRef getContext() const { return getFieldAs<DIScopeRef>(2); }
437 StringRef getName() const { return getStringField(3); }
438 StringRef getDisplayName() const { return getStringField(4); }
439 StringRef getLinkageName() const { return getStringField(5); }
440 unsigned getLineNumber() const { return getUnsignedField(6); }
441 DICompositeType getType() const { return getFieldAs<DICompositeType>(7); }
443 /// isLocalToUnit - Return true if this subprogram is local to the current
444 /// compile unit, like 'static' in C.
445 unsigned isLocalToUnit() const { return getUnsignedField(8); }
446 unsigned isDefinition() const { return getUnsignedField(9); }
448 unsigned getVirtuality() const { return getUnsignedField(10); }
449 unsigned getVirtualIndex() const { return getUnsignedField(11); }
451 DITypeRef getContainingType() const { return getFieldAs<DITypeRef>(12); }
453 unsigned getFlags() const { return getUnsignedField(13); }
455 unsigned isArtificial() const {
456 return (getUnsignedField(13) & FlagArtificial) != 0;
458 /// isPrivate - Return true if this subprogram has "private"
459 /// access specifier.
460 bool isPrivate() const { return (getUnsignedField(13) & FlagPrivate) != 0; }
461 /// isProtected - Return true if this subprogram has "protected"
462 /// access specifier.
463 bool isProtected() const {
464 return (getUnsignedField(13) & FlagProtected) != 0;
466 /// isExplicit - Return true if this subprogram is marked as explicit.
467 bool isExplicit() const { return (getUnsignedField(13) & FlagExplicit) != 0; }
468 /// isPrototyped - Return true if this subprogram is prototyped.
469 bool isPrototyped() const {
470 return (getUnsignedField(13) & FlagPrototyped) != 0;
473 unsigned isOptimized() const;
475 /// Verify - Verify that a subprogram descriptor is well formed.
478 /// describes - Return true if this subprogram provides debugging
479 /// information for the function F.
480 bool describes(const Function *F);
482 Function *getFunction() const { return getFunctionField(15); }
483 void replaceFunction(Function *F) { replaceFunctionField(15, F); }
484 DIArray getTemplateParams() const { return getFieldAs<DIArray>(16); }
485 DISubprogram getFunctionDeclaration() const {
486 return getFieldAs<DISubprogram>(17);
488 MDNode *getVariablesNodes() const;
489 DIArray getVariables() const;
491 /// getScopeLineNumber - Get the beginning of the scope of the
492 /// function, not necessarily where the name of the program
494 unsigned getScopeLineNumber() const { return getUnsignedField(19); }
497 /// DILexicalBlock - This is a wrapper for a lexical block.
498 class DILexicalBlock : public DIScope {
500 explicit DILexicalBlock(const MDNode *N = 0) : DIScope(N) {}
501 DIScope getContext() const { return getFieldAs<DIScope>(2); }
502 unsigned getLineNumber() const { return getUnsignedField(3); }
503 unsigned getColumnNumber() const { return getUnsignedField(4); }
507 /// DILexicalBlockFile - This is a wrapper for a lexical block with
508 /// a filename change.
509 class DILexicalBlockFile : public DIScope {
511 explicit DILexicalBlockFile(const MDNode *N = 0) : DIScope(N) {}
512 DIScope getContext() const {
513 if (getScope().isSubprogram())
515 return getScope().getContext();
517 unsigned getLineNumber() const { return getScope().getLineNumber(); }
518 unsigned getColumnNumber() const { return getScope().getColumnNumber(); }
519 DILexicalBlock getScope() const { return getFieldAs<DILexicalBlock>(2); }
523 /// DINameSpace - A wrapper for a C++ style name space.
524 class DINameSpace : public DIScope {
525 friend class DIDescriptor;
526 void printInternal(raw_ostream &OS) const;
529 explicit DINameSpace(const MDNode *N = 0) : DIScope(N) {}
530 DIScope getContext() const { return getFieldAs<DIScope>(2); }
531 StringRef getName() const { return getStringField(3); }
532 unsigned getLineNumber() const { return getUnsignedField(4); }
536 /// DITemplateTypeParameter - This is a wrapper for template type parameter.
537 class DITemplateTypeParameter : public DIDescriptor {
539 explicit DITemplateTypeParameter(const MDNode *N = 0) : DIDescriptor(N) {}
541 DIScopeRef getContext() const { return getFieldAs<DIScopeRef>(1); }
542 StringRef getName() const { return getStringField(2); }
543 DITypeRef getType() const { return getFieldAs<DITypeRef>(3); }
544 StringRef getFilename() const { return getFieldAs<DIFile>(4).getFilename(); }
545 StringRef getDirectory() const {
546 return getFieldAs<DIFile>(4).getDirectory();
548 unsigned getLineNumber() const { return getUnsignedField(5); }
549 unsigned getColumnNumber() const { return getUnsignedField(6); }
553 /// DITemplateValueParameter - This is a wrapper for template value parameter.
554 class DITemplateValueParameter : public DIDescriptor {
556 explicit DITemplateValueParameter(const MDNode *N = 0) : DIDescriptor(N) {}
558 DIScopeRef getContext() const { return getFieldAs<DIScopeRef>(1); }
559 StringRef getName() const { return getStringField(2); }
560 DITypeRef getType() const { return getFieldAs<DITypeRef>(3); }
561 Value *getValue() const;
562 StringRef getFilename() const { return getFieldAs<DIFile>(5).getFilename(); }
563 StringRef getDirectory() const {
564 return getFieldAs<DIFile>(5).getDirectory();
566 unsigned getLineNumber() const { return getUnsignedField(6); }
567 unsigned getColumnNumber() const { return getUnsignedField(7); }
571 /// DIGlobalVariable - This is a wrapper for a global variable.
572 class DIGlobalVariable : public DIDescriptor {
573 friend class DIDescriptor;
574 void printInternal(raw_ostream &OS) const;
577 explicit DIGlobalVariable(const MDNode *N = 0) : DIDescriptor(N) {}
579 DIScope getContext() const { return getFieldAs<DIScope>(2); }
580 StringRef getName() const { return getStringField(3); }
581 StringRef getDisplayName() const { return getStringField(4); }
582 StringRef getLinkageName() const { return getStringField(5); }
583 StringRef getFilename() const { return getFieldAs<DIFile>(6).getFilename(); }
584 StringRef getDirectory() const {
585 return getFieldAs<DIFile>(6).getDirectory();
588 unsigned getLineNumber() const { return getUnsignedField(7); }
589 DIType getType() const { return getFieldAs<DIType>(8); }
590 unsigned isLocalToUnit() const { return getUnsignedField(9); }
591 unsigned isDefinition() const { return getUnsignedField(10); }
593 GlobalVariable *getGlobal() const { return getGlobalVariableField(11); }
594 Constant *getConstant() const { return getConstantField(11); }
595 DIDerivedType getStaticDataMemberDeclaration() const {
596 return getFieldAs<DIDerivedType>(12);
599 /// Verify - Verify that a global variable descriptor is well formed.
603 /// DIVariable - This is a wrapper for a variable (e.g. parameter, local,
605 class DIVariable : public DIDescriptor {
606 friend class DIDescriptor;
607 void printInternal(raw_ostream &OS) const;
610 explicit DIVariable(const MDNode *N = 0) : DIDescriptor(N) {}
612 DIScope getContext() const { return getFieldAs<DIScope>(1); }
613 StringRef getName() const { return getStringField(2); }
614 DIFile getFile() const { return getFieldAs<DIFile>(3); }
615 unsigned getLineNumber() const { return (getUnsignedField(4) << 8) >> 8; }
616 unsigned getArgNumber() const {
617 unsigned L = getUnsignedField(4);
620 DIType getType() const { return getFieldAs<DIType>(5); }
622 /// isArtificial - Return true if this variable is marked as "artificial".
623 bool isArtificial() const {
624 return (getUnsignedField(6) & FlagArtificial) != 0;
627 bool isObjectPointer() const {
628 return (getUnsignedField(6) & FlagObjectPointer) != 0;
631 /// \brief Return true if this variable is represented as a pointer.
632 bool isIndirect() const {
633 return (getUnsignedField(6) & FlagIndirectVariable) != 0;
636 /// getInlinedAt - If this variable is inlined then return inline location.
637 MDNode *getInlinedAt() const;
639 /// Verify - Verify that a variable descriptor is well formed.
642 /// HasComplexAddr - Return true if the variable has a complex address.
643 bool hasComplexAddress() const { return getNumAddrElements() > 0; }
645 unsigned getNumAddrElements() const;
647 uint64_t getAddrElement(unsigned Idx) const {
648 return getUInt64Field(Idx + 8);
651 /// isBlockByrefVariable - Return true if the variable was declared as
652 /// a "__block" variable (Apple Blocks).
653 bool isBlockByrefVariable() const { return getType().isBlockByrefStruct(); }
655 /// isInlinedFnArgument - Return true if this variable provides debugging
656 /// information for an inlined function arguments.
657 bool isInlinedFnArgument(const Function *CurFn);
659 void printExtendedName(raw_ostream &OS) const;
662 /// DILocation - This object holds location information. This object
663 /// is not associated with any DWARF tag.
664 class DILocation : public DIDescriptor {
666 explicit DILocation(const MDNode *N) : DIDescriptor(N) {}
668 unsigned getLineNumber() const { return getUnsignedField(0); }
669 unsigned getColumnNumber() const { return getUnsignedField(1); }
670 DIScope getScope() const { return getFieldAs<DIScope>(2); }
671 DILocation getOrigLocation() const { return getFieldAs<DILocation>(3); }
672 StringRef getFilename() const { return getScope().getFilename(); }
673 StringRef getDirectory() const { return getScope().getDirectory(); }
677 class DIObjCProperty : public DIDescriptor {
678 friend class DIDescriptor;
679 void printInternal(raw_ostream &OS) const;
682 explicit DIObjCProperty(const MDNode *N) : DIDescriptor(N) {}
684 StringRef getObjCPropertyName() const { return getStringField(1); }
685 DIFile getFile() const { return getFieldAs<DIFile>(2); }
686 unsigned getLineNumber() const { return getUnsignedField(3); }
688 StringRef getObjCPropertyGetterName() const { return getStringField(4); }
689 StringRef getObjCPropertySetterName() const { return getStringField(5); }
690 bool isReadOnlyObjCProperty() const {
691 return (getUnsignedField(6) & dwarf::DW_APPLE_PROPERTY_readonly) != 0;
693 bool isReadWriteObjCProperty() const {
694 return (getUnsignedField(6) & dwarf::DW_APPLE_PROPERTY_readwrite) != 0;
696 bool isAssignObjCProperty() const {
697 return (getUnsignedField(6) & dwarf::DW_APPLE_PROPERTY_assign) != 0;
699 bool isRetainObjCProperty() const {
700 return (getUnsignedField(6) & dwarf::DW_APPLE_PROPERTY_retain) != 0;
702 bool isCopyObjCProperty() const {
703 return (getUnsignedField(6) & dwarf::DW_APPLE_PROPERTY_copy) != 0;
705 bool isNonAtomicObjCProperty() const {
706 return (getUnsignedField(6) & dwarf::DW_APPLE_PROPERTY_nonatomic) != 0;
709 DIType getType() const { return getFieldAs<DIType>(7); }
711 /// Verify - Verify that a derived type descriptor is well formed.
715 /// \brief An imported module (C++ using directive or similar).
716 class DIImportedEntity : public DIDescriptor {
717 friend class DIDescriptor;
718 void printInternal(raw_ostream &OS) const;
721 explicit DIImportedEntity(const MDNode *N) : DIDescriptor(N) {}
722 DIScope getContext() const { return getFieldAs<DIScope>(1); }
723 DIDescriptor getEntity() const { return getFieldAs<DIDescriptor>(2); }
724 unsigned getLineNumber() const { return getUnsignedField(3); }
725 StringRef getName() const { return getStringField(4); }
729 /// getDISubprogram - Find subprogram that is enclosing this scope.
730 DISubprogram getDISubprogram(const MDNode *Scope);
732 /// getDICompositeType - Find underlying composite type.
733 DICompositeType getDICompositeType(DIType T);
735 /// getOrInsertFnSpecificMDNode - Return a NameMDNode that is suitable
736 /// to hold function specific information.
737 NamedMDNode *getOrInsertFnSpecificMDNode(Module &M, DISubprogram SP);
739 /// getFnSpecificMDNode - Return a NameMDNode, if available, that is
740 /// suitable to hold function specific information.
741 NamedMDNode *getFnSpecificMDNode(const Module &M, DISubprogram SP);
743 /// createInlinedVariable - Create a new inlined variable based on current
745 /// @param DV Current Variable.
746 /// @param InlinedScope Location at current variable is inlined.
747 DIVariable createInlinedVariable(MDNode *DV, MDNode *InlinedScope,
748 LLVMContext &VMContext);
750 /// cleanseInlinedVariable - Remove inlined scope from the variable.
751 DIVariable cleanseInlinedVariable(MDNode *DV, LLVMContext &VMContext);
753 /// Construct DITypeIdentifierMap by going through retained types of each CU.
754 DITypeIdentifierMap generateDITypeIdentifierMap(const NamedMDNode *CU_Nodes);
756 /// Strip debug info in the module if it exists.
757 /// To do this, we remove all calls to the debugger intrinsics and any named
758 /// metadata for debugging. We also remove debug locations for instructions.
759 /// Return true if module is modified.
760 bool StripDebugInfo(Module &M);
762 /// Return Debug Info Metadata Version by checking module flags.
763 unsigned getDebugMetadataVersionFromModule(const Module &M);
765 /// DebugInfoFinder tries to list all debug info MDNodes used in a module. To
766 /// list debug info MDNodes used by an instruction, DebugInfoFinder uses
767 /// processDeclare, processValue and processLocation to handle DbgDeclareInst,
768 /// DbgValueInst and DbgLoc attached to instructions. processModule will go
769 /// through all DICompileUnits in llvm.dbg.cu and list debug info MDNodes
771 class DebugInfoFinder {
773 DebugInfoFinder() : TypeMapInitialized(false) {}
775 /// processModule - Process entire module and collect debug info
777 void processModule(const Module &M);
779 /// processDeclare - Process DbgDeclareInst.
780 void processDeclare(const Module &M, const DbgDeclareInst *DDI);
781 /// Process DbgValueInst.
782 void processValue(const Module &M, const DbgValueInst *DVI);
783 /// processLocation - Process DILocation.
784 void processLocation(const Module &M, DILocation Loc);
790 /// Initialize TypeIdentifierMap.
791 void InitializeTypeMap(const Module &M);
793 /// processType - Process DIType.
794 void processType(DIType DT);
796 /// processLexicalBlock - Process DILexicalBlock.
797 void processLexicalBlock(DILexicalBlock LB);
799 /// processSubprogram - Process DISubprogram.
800 void processSubprogram(DISubprogram SP);
802 void processScope(DIScope Scope);
804 /// addCompileUnit - Add compile unit into CUs.
805 bool addCompileUnit(DICompileUnit CU);
807 /// addGlobalVariable - Add global variable into GVs.
808 bool addGlobalVariable(DIGlobalVariable DIG);
810 // addSubprogram - Add subprogram into SPs.
811 bool addSubprogram(DISubprogram SP);
813 /// addType - Add type into Tys.
814 bool addType(DIType DT);
816 bool addScope(DIScope Scope);
819 typedef SmallVectorImpl<MDNode *>::const_iterator iterator;
820 iterator compile_unit_begin() const { return CUs.begin(); }
821 iterator compile_unit_end() const { return CUs.end(); }
822 iterator subprogram_begin() const { return SPs.begin(); }
823 iterator subprogram_end() const { return SPs.end(); }
824 iterator global_variable_begin() const { return GVs.begin(); }
825 iterator global_variable_end() const { return GVs.end(); }
826 iterator type_begin() const { return TYs.begin(); }
827 iterator type_end() const { return TYs.end(); }
828 iterator scope_begin() const { return Scopes.begin(); }
829 iterator scope_end() const { return Scopes.end(); }
831 unsigned compile_unit_count() const { return CUs.size(); }
832 unsigned global_variable_count() const { return GVs.size(); }
833 unsigned subprogram_count() const { return SPs.size(); }
834 unsigned type_count() const { return TYs.size(); }
835 unsigned scope_count() const { return Scopes.size(); }
838 SmallVector<MDNode *, 8> CUs; // Compile Units
839 SmallVector<MDNode *, 8> SPs; // Subprograms
840 SmallVector<MDNode *, 8> GVs; // Global Variables;
841 SmallVector<MDNode *, 8> TYs; // Types
842 SmallVector<MDNode *, 8> Scopes; // Scopes
843 SmallPtrSet<MDNode *, 64> NodesSeen;
844 DITypeIdentifierMap TypeIdentifierMap;
845 /// Specify if TypeIdentifierMap is initialized.
846 bool TypeMapInitialized;
848 } // end namespace llvm