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/ADT/SmallPtrSet.h"
21 #include "llvm/ADT/SmallVector.h"
22 #include "llvm/ADT/StringRef.h"
23 #include "llvm/Support/Dwarf.h"
43 class DILexicalBlockFile;
48 /// DIDescriptor - A thin wraper around MDNode to access encoded debug info.
49 /// This should not be stored in a container, because the underlying MDNode
50 /// may change in certain situations.
55 FlagProtected = 1 << 1,
57 FlagAppleBlock = 1 << 3,
58 FlagBlockByrefStruct = 1 << 4,
60 FlagArtificial = 1 << 6,
61 FlagExplicit = 1 << 7,
62 FlagPrototyped = 1 << 8,
63 FlagObjcClassComplete = 1 << 9,
64 FlagObjectPointer = 1 << 10,
66 FlagStaticMember = 1 << 12
69 const MDNode *DbgNode;
71 StringRef getStringField(unsigned Elt) const;
72 unsigned getUnsignedField(unsigned Elt) const {
73 return (unsigned)getUInt64Field(Elt);
75 uint64_t getUInt64Field(unsigned Elt) const;
76 int64_t getInt64Field(unsigned Elt) const;
77 DIDescriptor getDescriptorField(unsigned Elt) const;
79 template <typename DescTy>
80 DescTy getFieldAs(unsigned Elt) const {
81 return DescTy(getDescriptorField(Elt));
84 GlobalVariable *getGlobalVariableField(unsigned Elt) const;
85 Constant *getConstantField(unsigned Elt) const;
86 Function *getFunctionField(unsigned Elt) const;
87 void replaceFunctionField(unsigned Elt, Function *F);
90 explicit DIDescriptor() : DbgNode(0) {}
91 explicit DIDescriptor(const MDNode *N) : DbgNode(N) {}
92 explicit DIDescriptor(const DIFile F);
93 explicit DIDescriptor(const DISubprogram F);
94 explicit DIDescriptor(const DILexicalBlockFile F);
95 explicit DIDescriptor(const DILexicalBlock F);
96 explicit DIDescriptor(const DIVariable F);
97 explicit DIDescriptor(const DIType F);
101 operator MDNode *() const { return const_cast<MDNode*>(DbgNode); }
102 MDNode *operator ->() const { return const_cast<MDNode*>(DbgNode); }
104 unsigned getTag() const {
105 return getUnsignedField(0) & ~LLVMDebugVersionMask;
108 bool isDerivedType() const;
109 bool isCompositeType() const;
110 bool isBasicType() const;
111 bool isVariable() const;
112 bool isSubprogram() const;
113 bool isGlobalVariable() const;
114 bool isScope() const;
116 bool isCompileUnit() const;
117 bool isNameSpace() const;
118 bool isLexicalBlockFile() const;
119 bool isLexicalBlock() const;
120 bool isSubrange() const;
121 bool isEnumerator() const;
123 bool isGlobal() const;
124 bool isUnspecifiedParameter() const;
125 bool isTemplateTypeParameter() const;
126 bool isTemplateValueParameter() const;
127 bool isObjCProperty() const;
129 /// print - print descriptor.
130 void print(raw_ostream &OS) const;
132 /// dump - print descriptor to dbgs() with a newline.
136 /// DISubrange - This is used to represent ranges, for array bounds.
137 class DISubrange : public DIDescriptor {
138 friend class DIDescriptor;
139 void printInternal(raw_ostream &OS) const;
141 explicit DISubrange(const MDNode *N = 0) : DIDescriptor(N) {}
143 int64_t getLo() const { return getInt64Field(1); }
144 int64_t getCount() const { return getInt64Field(2); }
148 /// DIArray - This descriptor holds an array of descriptors.
149 class DIArray : public DIDescriptor {
151 explicit DIArray(const MDNode *N = 0)
154 unsigned getNumElements() const;
155 DIDescriptor getElement(unsigned Idx) const {
156 return getDescriptorField(Idx);
160 /// DIScope - A base class for various scopes.
161 class DIScope : public DIDescriptor {
163 friend class DIDescriptor;
164 void printInternal(raw_ostream &OS) const;
166 explicit DIScope(const MDNode *N = 0) : DIDescriptor (N) {}
168 StringRef getFilename() const;
169 StringRef getDirectory() const;
172 /// DIFile - This is a wrapper for a file.
173 class DIFile : public DIScope {
174 friend class DIDescriptor;
176 explicit DIFile(const MDNode *N = 0) : DIScope(N) {
177 if (DbgNode && !isFile())
180 MDNode *getFileNode() const;
184 /// DICompileUnit - A wrapper for a compile unit.
185 class DICompileUnit : public DIScope {
186 friend class DIDescriptor;
187 void printInternal(raw_ostream &OS) const;
189 explicit DICompileUnit(const MDNode *N = 0) : DIScope(N) {}
191 unsigned getLanguage() const { return getUnsignedField(2); }
192 StringRef getProducer() const { return getStringField(3); }
194 bool isOptimized() const { return getUnsignedField(4) != 0; }
195 StringRef getFlags() const { return getStringField(5); }
196 unsigned getRunTimeVersion() const { return getUnsignedField(6); }
198 DIArray getEnumTypes() const;
199 DIArray getRetainedTypes() const;
200 DIArray getSubprograms() const;
201 DIArray getGlobalVariables() const;
203 StringRef getSplitDebugFilename() const { return getStringField(11); }
205 /// Verify - Verify that a compile unit is well formed.
209 /// DIEnumerator - A wrapper for an enumerator (e.g. X and Y in 'enum {X,Y}').
210 /// FIXME: it seems strange that this doesn't have either a reference to the
211 /// type/precision or a file/line pair for location info.
212 class DIEnumerator : public DIDescriptor {
213 friend class DIDescriptor;
214 void printInternal(raw_ostream &OS) const;
216 explicit DIEnumerator(const MDNode *N = 0) : DIDescriptor(N) {}
218 StringRef getName() const { return getStringField(1); }
219 uint64_t getEnumValue() const { return getUInt64Field(2); }
223 /// DIType - This is a wrapper for a type.
224 /// FIXME: Types should be factored much better so that CV qualifiers and
225 /// others do not require a huge and empty descriptor full of zeros.
226 class DIType : public DIScope {
228 friend class DIDescriptor;
229 void printInternal(raw_ostream &OS) const;
230 // This ctor is used when the Tag has already been validated by a derived
232 DIType(const MDNode *N, bool, bool) : DIScope(N) {}
234 /// Verify - Verify that a type descriptor is well formed.
236 explicit DIType(const MDNode *N);
239 DIScope getContext() const { return getFieldAs<DIScope>(2); }
240 StringRef getName() const { return getStringField(3); }
241 unsigned getLineNumber() const { return getUnsignedField(4); }
242 uint64_t getSizeInBits() const { return getUInt64Field(5); }
243 uint64_t getAlignInBits() const { return getUInt64Field(6); }
244 // FIXME: Offset is only used for DW_TAG_member nodes. Making every type
245 // carry this is just plain insane.
246 uint64_t getOffsetInBits() const { return getUInt64Field(7); }
247 unsigned getFlags() const { return getUnsignedField(8); }
248 bool isPrivate() const {
249 return (getFlags() & FlagPrivate) != 0;
251 bool isProtected() const {
252 return (getFlags() & FlagProtected) != 0;
254 bool isForwardDecl() const {
255 return (getFlags() & FlagFwdDecl) != 0;
257 // isAppleBlock - Return true if this is the Apple Blocks extension.
258 bool isAppleBlockExtension() const {
259 return (getFlags() & FlagAppleBlock) != 0;
261 bool isBlockByrefStruct() const {
262 return (getFlags() & FlagBlockByrefStruct) != 0;
264 bool isVirtual() const {
265 return (getFlags() & FlagVirtual) != 0;
267 bool isArtificial() const {
268 return (getFlags() & FlagArtificial) != 0;
270 bool isObjectPointer() const {
271 return (getFlags() & FlagObjectPointer) != 0;
273 bool isObjcClassComplete() const {
274 return (getFlags() & FlagObjcClassComplete) != 0;
276 bool isVector() const {
277 return (getFlags() & FlagVector) != 0;
279 bool isStaticMember() const {
280 return (getFlags() & FlagStaticMember) != 0;
282 bool isValid() const {
283 return DbgNode && (isBasicType() || isDerivedType() || isCompositeType());
286 /// isUnsignedDIType - Return true if type encoding is unsigned.
287 bool isUnsignedDIType();
289 /// replaceAllUsesWith - Replace all uses of debug info referenced by
291 void replaceAllUsesWith(DIDescriptor &D);
292 void replaceAllUsesWith(MDNode *D);
295 /// DIBasicType - A basic type, like 'int' or 'float'.
296 class DIBasicType : public DIType {
298 explicit DIBasicType(const MDNode *N = 0) : DIType(N) {}
300 unsigned getEncoding() const { return getUnsignedField(9); }
302 /// Verify - Verify that a basic type descriptor is well formed.
306 /// DIDerivedType - A simple derived type, like a const qualified type,
307 /// a typedef, a pointer or reference, et cetera. Or, a data member of
308 /// a class/struct/union.
309 class DIDerivedType : public DIType {
310 friend class DIDescriptor;
311 void printInternal(raw_ostream &OS) const;
313 explicit DIDerivedType(const MDNode *N, bool, bool)
314 : DIType(N, true, true) {}
316 explicit DIDerivedType(const MDNode *N = 0)
317 : DIType(N, true, true) {}
319 DIType getTypeDerivedFrom() const { return getFieldAs<DIType>(9); }
321 /// getOriginalTypeSize - If this type is derived from a base type then
322 /// return base type size.
323 uint64_t getOriginalTypeSize() const;
325 /// getObjCProperty - Return property node, if this ivar is
326 /// associated with one.
327 MDNode *getObjCProperty() const;
329 DIType getClassType() const {
330 assert(getTag() == dwarf::DW_TAG_ptr_to_member_type);
331 return getFieldAs<DIType>(10);
334 Constant *getConstant() const {
335 assert((getTag() == dwarf::DW_TAG_member) && isStaticMember());
336 return getConstantField(10);
339 /// Verify - Verify that a derived type descriptor is well formed.
343 /// DICompositeType - This descriptor holds a type that can refer to multiple
344 /// other types, like a function or struct.
345 /// FIXME: Why is this a DIDerivedType??
346 class DICompositeType : public DIDerivedType {
347 friend class DIDescriptor;
348 void printInternal(raw_ostream &OS) const;
350 explicit DICompositeType(const MDNode *N = 0)
351 : DIDerivedType(N, true, true) {
352 if (N && !isCompositeType())
356 DIArray getTypeArray() const { return getFieldAs<DIArray>(10); }
357 unsigned getRunTimeLang() const { return getUnsignedField(11); }
358 DICompositeType getContainingType() const {
359 return getFieldAs<DICompositeType>(12);
361 DIArray getTemplateParams() const { return getFieldAs<DIArray>(13); }
363 /// Verify - Verify that a composite type descriptor is well formed.
367 /// DITemplateTypeParameter - This is a wrapper for template type parameter.
368 class DITemplateTypeParameter : public DIDescriptor {
370 explicit DITemplateTypeParameter(const MDNode *N = 0) : DIDescriptor(N) {}
372 DIScope getContext() const { return getFieldAs<DIScope>(1); }
373 StringRef getName() const { return getStringField(2); }
374 DIType getType() const { return getFieldAs<DIType>(3); }
375 StringRef getFilename() const {
376 return getFieldAs<DIFile>(4).getFilename();
378 StringRef getDirectory() const {
379 return getFieldAs<DIFile>(4).getDirectory();
381 unsigned getLineNumber() const { return getUnsignedField(5); }
382 unsigned getColumnNumber() const { return getUnsignedField(6); }
386 /// DITemplateValueParameter - This is a wrapper for template value parameter.
387 class DITemplateValueParameter : public DIDescriptor {
389 explicit DITemplateValueParameter(const MDNode *N = 0) : DIDescriptor(N) {}
391 DIScope getContext() const { return getFieldAs<DIScope>(1); }
392 StringRef getName() const { return getStringField(2); }
393 DIType getType() const { return getFieldAs<DIType>(3); }
394 uint64_t getValue() const { return getUInt64Field(4); }
395 StringRef getFilename() const {
396 return getFieldAs<DIFile>(5).getFilename();
398 StringRef getDirectory() const {
399 return getFieldAs<DIFile>(5).getDirectory();
401 unsigned getLineNumber() const { return getUnsignedField(6); }
402 unsigned getColumnNumber() const { return getUnsignedField(7); }
406 /// DISubprogram - This is a wrapper for a subprogram (e.g. a function).
407 class DISubprogram : public DIScope {
408 friend class DIDescriptor;
409 void printInternal(raw_ostream &OS) const;
411 explicit DISubprogram(const MDNode *N = 0) : DIScope(N) {}
413 DIScope getContext() const { return getFieldAs<DIScope>(1); }
414 StringRef getName() const { return getStringField(2); }
415 StringRef getDisplayName() const { return getStringField(3); }
416 StringRef getLinkageName() const { return getStringField(4); }
417 unsigned getLineNumber() const { return getUnsignedField(6); }
418 DICompositeType getType() const { return getFieldAs<DICompositeType>(7); }
420 /// getReturnTypeName - Subprogram return types are encoded either as
421 /// DIType or as DICompositeType.
422 StringRef getReturnTypeName() const {
423 DICompositeType DCT(getFieldAs<DICompositeType>(7));
425 DIArray A = DCT.getTypeArray();
426 DIType T(A.getElement(0));
429 DIType T(getFieldAs<DIType>(7));
433 /// isLocalToUnit - Return true if this subprogram is local to the current
434 /// compile unit, like 'static' in C.
435 unsigned isLocalToUnit() const { return getUnsignedField(8); }
436 unsigned isDefinition() const { return getUnsignedField(9); }
438 unsigned getVirtuality() const { return getUnsignedField(10); }
439 unsigned getVirtualIndex() const { return getUnsignedField(11); }
441 DICompositeType getContainingType() const {
442 return getFieldAs<DICompositeType>(12);
445 unsigned getFlags() const {
446 return getUnsignedField(13);
449 unsigned isArtificial() const {
450 return (getUnsignedField(13) & FlagArtificial) != 0;
452 /// isPrivate - Return true if this subprogram has "private"
453 /// access specifier.
454 bool isPrivate() const {
455 return (getUnsignedField(13) & FlagPrivate) != 0;
457 /// isProtected - Return true if this subprogram has "protected"
458 /// access specifier.
459 bool isProtected() const {
460 return (getUnsignedField(13) & FlagProtected) != 0;
462 /// isExplicit - Return true if this subprogram is marked as explicit.
463 bool isExplicit() const {
464 return (getUnsignedField(13) & FlagExplicit) != 0;
466 /// isPrototyped - Return true if this subprogram is prototyped.
467 bool isPrototyped() const {
468 return (getUnsignedField(13) & FlagPrototyped) != 0;
471 unsigned isOptimized() const;
473 StringRef getFilename() const {
474 return getFieldAs<DIFile>(5).getFilename();
477 StringRef getDirectory() const {
478 return getFieldAs<DIFile>(5).getDirectory();
481 /// getScopeLineNumber - Get the beginning of the scope of the
482 /// function, not necessarily where the name of the program
484 unsigned getScopeLineNumber() const { return getUnsignedField(19); }
486 /// Verify - Verify that a subprogram descriptor is well formed.
489 /// describes - Return true if this subprogram provides debugging
490 /// information for the function F.
491 bool describes(const Function *F);
493 Function *getFunction() const { return getFunctionField(15); }
494 void replaceFunction(Function *F) { replaceFunctionField(15, F); }
495 DIArray getTemplateParams() const { return getFieldAs<DIArray>(16); }
496 DISubprogram getFunctionDeclaration() const {
497 return getFieldAs<DISubprogram>(17);
499 MDNode *getVariablesNodes() const;
500 DIArray getVariables() const;
503 /// DIGlobalVariable - This is a wrapper for a global variable.
504 class DIGlobalVariable : public DIDescriptor {
505 friend class DIDescriptor;
506 void printInternal(raw_ostream &OS) const;
508 explicit DIGlobalVariable(const MDNode *N = 0) : DIDescriptor(N) {}
510 DIScope getContext() const { return getFieldAs<DIScope>(2); }
511 StringRef getName() const { return getStringField(3); }
512 StringRef getDisplayName() const { return getStringField(4); }
513 StringRef getLinkageName() const { return getStringField(5); }
514 StringRef getFilename() const {
515 return getFieldAs<DIFile>(6).getFilename();
517 StringRef getDirectory() const {
518 return getFieldAs<DIFile>(6).getDirectory();
522 unsigned getLineNumber() const { return getUnsignedField(7); }
523 DIType getType() const { return getFieldAs<DIType>(8); }
524 unsigned isLocalToUnit() const { return getUnsignedField(9); }
525 unsigned isDefinition() const { return getUnsignedField(10); }
527 GlobalVariable *getGlobal() const { return getGlobalVariableField(11); }
528 Constant *getConstant() const { return getConstantField(11); }
529 DIDerivedType getStaticDataMemberDeclaration() const {
530 return getFieldAs<DIDerivedType>(12);
533 /// Verify - Verify that a global variable descriptor is well formed.
537 /// DIVariable - This is a wrapper for a variable (e.g. parameter, local,
539 class DIVariable : public DIDescriptor {
540 friend class DIDescriptor;
541 void printInternal(raw_ostream &OS) const;
543 explicit DIVariable(const MDNode *N = 0)
546 DIScope getContext() const { return getFieldAs<DIScope>(1); }
547 StringRef getName() const { return getStringField(2); }
548 DIFile getFile() const { return getFieldAs<DIFile>(3); }
549 unsigned getLineNumber() const {
550 return (getUnsignedField(4) << 8) >> 8;
552 unsigned getArgNumber() const {
553 unsigned L = getUnsignedField(4);
556 DIType getType() const { return getFieldAs<DIType>(5); }
558 /// isArtificial - Return true if this variable is marked as "artificial".
559 bool isArtificial() const {
560 return (getUnsignedField(6) & FlagArtificial) != 0;
563 bool isObjectPointer() const {
564 return (getUnsignedField(6) & FlagObjectPointer) != 0;
567 /// getInlinedAt - If this variable is inlined then return inline location.
568 MDNode *getInlinedAt() const;
570 /// Verify - Verify that a variable descriptor is well formed.
573 /// HasComplexAddr - Return true if the variable has a complex address.
574 bool hasComplexAddress() const {
575 return getNumAddrElements() > 0;
578 unsigned getNumAddrElements() const;
580 uint64_t getAddrElement(unsigned Idx) const {
581 return getUInt64Field(Idx+8);
584 /// isBlockByrefVariable - Return true if the variable was declared as
585 /// a "__block" variable (Apple Blocks).
586 bool isBlockByrefVariable() const {
587 return getType().isBlockByrefStruct();
590 /// isInlinedFnArgument - Return true if this variable provides debugging
591 /// information for an inlined function arguments.
592 bool isInlinedFnArgument(const Function *CurFn);
594 void printExtendedName(raw_ostream &OS) const;
597 /// DILexicalBlock - This is a wrapper for a lexical block.
598 class DILexicalBlock : public DIScope {
600 explicit DILexicalBlock(const MDNode *N = 0) : DIScope(N) {}
601 DIScope getContext() const { return getFieldAs<DIScope>(1); }
602 unsigned getLineNumber() const { return getUnsignedField(2); }
603 unsigned getColumnNumber() const { return getUnsignedField(3); }
604 StringRef getDirectory() const {
605 return getFieldAs<DIFile>(4).getDirectory();
607 StringRef getFilename() const {
608 return getFieldAs<DIFile>(4).getFilename();
613 /// DILexicalBlockFile - This is a wrapper for a lexical block with
614 /// a filename change.
615 class DILexicalBlockFile : public DIScope {
617 explicit DILexicalBlockFile(const MDNode *N = 0) : DIScope(N) {}
618 DIScope getContext() const { if (getScope().isSubprogram()) return getScope(); return getScope().getContext(); }
619 unsigned getLineNumber() const { return getScope().getLineNumber(); }
620 unsigned getColumnNumber() const { return getScope().getColumnNumber(); }
621 StringRef getDirectory() const {
622 return getFieldAs<DIFile>(2).getDirectory();
624 StringRef getFilename() const {
625 return getFieldAs<DIFile>(2).getFilename();
627 DILexicalBlock getScope() const { return getFieldAs<DILexicalBlock>(1); }
631 /// DINameSpace - A wrapper for a C++ style name space.
632 class DINameSpace : public DIScope {
633 friend class DIDescriptor;
634 void printInternal(raw_ostream &OS) const;
636 explicit DINameSpace(const MDNode *N = 0) : DIScope(N) {}
637 DIScope getContext() const { return getFieldAs<DIScope>(2); }
638 StringRef getName() const { return getStringField(3); }
639 unsigned getLineNumber() const { return getUnsignedField(4); }
643 /// DILocation - This object holds location information. This object
644 /// is not associated with any DWARF tag.
645 class DILocation : public DIDescriptor {
647 explicit DILocation(const MDNode *N) : DIDescriptor(N) { }
649 unsigned getLineNumber() const { return getUnsignedField(0); }
650 unsigned getColumnNumber() const { return getUnsignedField(1); }
651 DIScope getScope() const { return getFieldAs<DIScope>(2); }
652 DILocation getOrigLocation() const { return getFieldAs<DILocation>(3); }
653 StringRef getFilename() const { return getScope().getFilename(); }
654 StringRef getDirectory() const { return getScope().getDirectory(); }
658 class DIObjCProperty : public DIDescriptor {
659 friend class DIDescriptor;
660 void printInternal(raw_ostream &OS) const;
662 explicit DIObjCProperty(const MDNode *N) : DIDescriptor(N) { }
664 StringRef getObjCPropertyName() const { return getStringField(1); }
665 DIFile getFile() const { return getFieldAs<DIFile>(2); }
666 unsigned getLineNumber() const { return getUnsignedField(3); }
668 StringRef getObjCPropertyGetterName() const {
669 return getStringField(4);
671 StringRef getObjCPropertySetterName() const {
672 return getStringField(5);
674 bool isReadOnlyObjCProperty() {
675 return (getUnsignedField(6) & dwarf::DW_APPLE_PROPERTY_readonly) != 0;
677 bool isReadWriteObjCProperty() {
678 return (getUnsignedField(6) & dwarf::DW_APPLE_PROPERTY_readwrite) != 0;
680 bool isAssignObjCProperty() {
681 return (getUnsignedField(6) & dwarf::DW_APPLE_PROPERTY_assign) != 0;
683 bool isRetainObjCProperty() {
684 return (getUnsignedField(6) & dwarf::DW_APPLE_PROPERTY_retain) != 0;
686 bool isCopyObjCProperty() {
687 return (getUnsignedField(6) & dwarf::DW_APPLE_PROPERTY_copy) != 0;
689 bool isNonAtomicObjCProperty() {
690 return (getUnsignedField(6) & dwarf::DW_APPLE_PROPERTY_nonatomic) != 0;
693 DIType getType() const { return getFieldAs<DIType>(7); }
695 /// Verify - Verify that a derived type descriptor is well formed.
699 /// getDISubprogram - Find subprogram that is enclosing this scope.
700 DISubprogram getDISubprogram(const MDNode *Scope);
702 /// getDICompositeType - Find underlying composite type.
703 DICompositeType getDICompositeType(DIType T);
705 /// isSubprogramContext - Return true if Context is either a subprogram
706 /// or another context nested inside a subprogram.
707 bool isSubprogramContext(const MDNode *Context);
709 /// getOrInsertFnSpecificMDNode - Return a NameMDNode that is suitable
710 /// to hold function specific information.
711 NamedMDNode *getOrInsertFnSpecificMDNode(Module &M, DISubprogram SP);
713 /// getFnSpecificMDNode - Return a NameMDNode, if available, that is
714 /// suitable to hold function specific information.
715 NamedMDNode *getFnSpecificMDNode(const Module &M, DISubprogram SP);
717 /// createInlinedVariable - Create a new inlined variable based on current
719 /// @param DV Current Variable.
720 /// @param InlinedScope Location at current variable is inlined.
721 DIVariable createInlinedVariable(MDNode *DV, MDNode *InlinedScope,
722 LLVMContext &VMContext);
724 /// cleanseInlinedVariable - Remove inlined scope from the variable.
725 DIVariable cleanseInlinedVariable(MDNode *DV, LLVMContext &VMContext);
727 class DebugInfoFinder {
729 /// processModule - Process entire module and collect debug info
731 void processModule(const Module &M);
734 /// processType - Process DIType.
735 void processType(DIType DT);
737 /// processLexicalBlock - Process DILexicalBlock.
738 void processLexicalBlock(DILexicalBlock LB);
740 /// processSubprogram - Process DISubprogram.
741 void processSubprogram(DISubprogram SP);
743 /// processDeclare - Process DbgDeclareInst.
744 void processDeclare(const DbgDeclareInst *DDI);
746 /// processLocation - Process DILocation.
747 void processLocation(DILocation Loc);
749 /// addCompileUnit - Add compile unit into CUs.
750 bool addCompileUnit(DICompileUnit CU);
752 /// addGlobalVariable - Add global variable into GVs.
753 bool addGlobalVariable(DIGlobalVariable DIG);
755 // addSubprogram - Add subprogram into SPs.
756 bool addSubprogram(DISubprogram SP);
758 /// addType - Add type into Tys.
759 bool addType(DIType DT);
762 typedef SmallVector<MDNode *, 8>::const_iterator iterator;
763 iterator compile_unit_begin() const { return CUs.begin(); }
764 iterator compile_unit_end() const { return CUs.end(); }
765 iterator subprogram_begin() const { return SPs.begin(); }
766 iterator subprogram_end() const { return SPs.end(); }
767 iterator global_variable_begin() const { return GVs.begin(); }
768 iterator global_variable_end() const { return GVs.end(); }
769 iterator type_begin() const { return TYs.begin(); }
770 iterator type_end() const { return TYs.end(); }
772 unsigned compile_unit_count() const { return CUs.size(); }
773 unsigned global_variable_count() const { return GVs.size(); }
774 unsigned subprogram_count() const { return SPs.size(); }
775 unsigned type_count() const { return TYs.size(); }
778 SmallVector<MDNode *, 8> CUs; // Compile Units
779 SmallVector<MDNode *, 8> SPs; // Subprograms
780 SmallVector<MDNode *, 8> GVs; // Global Variables;
781 SmallVector<MDNode *, 8> TYs; // Types
782 SmallPtrSet<MDNode *, 64> NodesSeen;
784 } // end namespace llvm