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 getFilename() const {
193 return getFieldAs<DIFile>(3).getFilename();
195 StringRef getDirectory() const {
196 return getFieldAs<DIFile>(3).getDirectory();
198 StringRef getProducer() const { return getStringField(4); }
200 bool isOptimized() const { return getUnsignedField(5) != 0; }
201 StringRef getFlags() const { return getStringField(6); }
202 unsigned getRunTimeVersion() const { return getUnsignedField(7); }
204 DIArray getEnumTypes() const;
205 DIArray getRetainedTypes() const;
206 DIArray getSubprograms() const;
207 DIArray getGlobalVariables() const;
209 StringRef getSplitDebugFilename() const { return getStringField(12); }
211 /// Verify - Verify that a compile unit is well formed.
215 /// DIEnumerator - A wrapper for an enumerator (e.g. X and Y in 'enum {X,Y}').
216 /// FIXME: it seems strange that this doesn't have either a reference to the
217 /// type/precision or a file/line pair for location info.
218 class DIEnumerator : public DIDescriptor {
219 friend class DIDescriptor;
220 void printInternal(raw_ostream &OS) const;
222 explicit DIEnumerator(const MDNode *N = 0) : DIDescriptor(N) {}
224 StringRef getName() const { return getStringField(1); }
225 uint64_t getEnumValue() const { return getUInt64Field(2); }
229 /// DIType - This is a wrapper for a type.
230 /// FIXME: Types should be factored much better so that CV qualifiers and
231 /// others do not require a huge and empty descriptor full of zeros.
232 class DIType : public DIScope {
234 friend class DIDescriptor;
235 void printInternal(raw_ostream &OS) const;
236 // This ctor is used when the Tag has already been validated by a derived
238 DIType(const MDNode *N, bool, bool) : DIScope(N) {}
240 /// Verify - Verify that a type descriptor is well formed.
242 explicit DIType(const MDNode *N);
245 DIScope getContext() const { return getFieldAs<DIScope>(2); }
246 StringRef getName() const { return getStringField(3); }
247 unsigned getLineNumber() const { return getUnsignedField(4); }
248 uint64_t getSizeInBits() const { return getUInt64Field(5); }
249 uint64_t getAlignInBits() const { return getUInt64Field(6); }
250 // FIXME: Offset is only used for DW_TAG_member nodes. Making every type
251 // carry this is just plain insane.
252 uint64_t getOffsetInBits() const { return getUInt64Field(7); }
253 unsigned getFlags() const { return getUnsignedField(8); }
254 bool isPrivate() const {
255 return (getFlags() & FlagPrivate) != 0;
257 bool isProtected() const {
258 return (getFlags() & FlagProtected) != 0;
260 bool isForwardDecl() const {
261 return (getFlags() & FlagFwdDecl) != 0;
263 // isAppleBlock - Return true if this is the Apple Blocks extension.
264 bool isAppleBlockExtension() const {
265 return (getFlags() & FlagAppleBlock) != 0;
267 bool isBlockByrefStruct() const {
268 return (getFlags() & FlagBlockByrefStruct) != 0;
270 bool isVirtual() const {
271 return (getFlags() & FlagVirtual) != 0;
273 bool isArtificial() const {
274 return (getFlags() & FlagArtificial) != 0;
276 bool isObjectPointer() const {
277 return (getFlags() & FlagObjectPointer) != 0;
279 bool isObjcClassComplete() const {
280 return (getFlags() & FlagObjcClassComplete) != 0;
282 bool isVector() const {
283 return (getFlags() & FlagVector) != 0;
285 bool isStaticMember() const {
286 return (getFlags() & FlagStaticMember) != 0;
288 bool isValid() const {
289 return DbgNode && (isBasicType() || isDerivedType() || isCompositeType());
292 /// isUnsignedDIType - Return true if type encoding is unsigned.
293 bool isUnsignedDIType();
295 /// replaceAllUsesWith - Replace all uses of debug info referenced by
297 void replaceAllUsesWith(DIDescriptor &D);
298 void replaceAllUsesWith(MDNode *D);
301 /// DIBasicType - A basic type, like 'int' or 'float'.
302 class DIBasicType : public DIType {
304 explicit DIBasicType(const MDNode *N = 0) : DIType(N) {}
306 unsigned getEncoding() const { return getUnsignedField(9); }
308 /// Verify - Verify that a basic type descriptor is well formed.
312 /// DIDerivedType - A simple derived type, like a const qualified type,
313 /// a typedef, a pointer or reference, et cetera. Or, a data member of
314 /// a class/struct/union.
315 class DIDerivedType : public DIType {
316 friend class DIDescriptor;
317 void printInternal(raw_ostream &OS) const;
319 explicit DIDerivedType(const MDNode *N, bool, bool)
320 : DIType(N, true, true) {}
322 explicit DIDerivedType(const MDNode *N = 0)
323 : DIType(N, true, true) {}
325 DIType getTypeDerivedFrom() const { return getFieldAs<DIType>(9); }
327 /// getOriginalTypeSize - If this type is derived from a base type then
328 /// return base type size.
329 uint64_t getOriginalTypeSize() const;
331 /// getObjCProperty - Return property node, if this ivar is
332 /// associated with one.
333 MDNode *getObjCProperty() const;
335 DIType getClassType() const {
336 assert(getTag() == dwarf::DW_TAG_ptr_to_member_type);
337 return getFieldAs<DIType>(10);
340 Constant *getConstant() const {
341 assert((getTag() == dwarf::DW_TAG_member) && isStaticMember());
342 return getConstantField(10);
345 /// Verify - Verify that a derived type descriptor is well formed.
349 /// DICompositeType - This descriptor holds a type that can refer to multiple
350 /// other types, like a function or struct.
351 /// FIXME: Why is this a DIDerivedType??
352 class DICompositeType : public DIDerivedType {
353 friend class DIDescriptor;
354 void printInternal(raw_ostream &OS) const;
356 explicit DICompositeType(const MDNode *N = 0)
357 : DIDerivedType(N, true, true) {
358 if (N && !isCompositeType())
362 DIArray getTypeArray() const { return getFieldAs<DIArray>(10); }
363 unsigned getRunTimeLang() const { return getUnsignedField(11); }
364 DICompositeType getContainingType() const {
365 return getFieldAs<DICompositeType>(12);
367 DIArray getTemplateParams() const { return getFieldAs<DIArray>(13); }
369 /// Verify - Verify that a composite type descriptor is well formed.
373 /// DITemplateTypeParameter - This is a wrapper for template type parameter.
374 class DITemplateTypeParameter : public DIDescriptor {
376 explicit DITemplateTypeParameter(const MDNode *N = 0) : DIDescriptor(N) {}
378 DIScope getContext() const { return getFieldAs<DIScope>(1); }
379 StringRef getName() const { return getStringField(2); }
380 DIType getType() const { return getFieldAs<DIType>(3); }
381 StringRef getFilename() const {
382 return getFieldAs<DIFile>(4).getFilename();
384 StringRef getDirectory() const {
385 return getFieldAs<DIFile>(4).getDirectory();
387 unsigned getLineNumber() const { return getUnsignedField(5); }
388 unsigned getColumnNumber() const { return getUnsignedField(6); }
392 /// DITemplateValueParameter - This is a wrapper for template value parameter.
393 class DITemplateValueParameter : public DIDescriptor {
395 explicit DITemplateValueParameter(const MDNode *N = 0) : DIDescriptor(N) {}
397 DIScope getContext() const { return getFieldAs<DIScope>(1); }
398 StringRef getName() const { return getStringField(2); }
399 DIType getType() const { return getFieldAs<DIType>(3); }
400 uint64_t getValue() const { return getUInt64Field(4); }
401 StringRef getFilename() const {
402 return getFieldAs<DIFile>(5).getFilename();
404 StringRef getDirectory() const {
405 return getFieldAs<DIFile>(5).getDirectory();
407 unsigned getLineNumber() const { return getUnsignedField(6); }
408 unsigned getColumnNumber() const { return getUnsignedField(7); }
412 /// DISubprogram - This is a wrapper for a subprogram (e.g. a function).
413 class DISubprogram : public DIScope {
414 friend class DIDescriptor;
415 void printInternal(raw_ostream &OS) const;
417 explicit DISubprogram(const MDNode *N = 0) : DIScope(N) {}
419 DIScope getContext() const { return getFieldAs<DIScope>(2); }
420 StringRef getName() const { return getStringField(3); }
421 StringRef getDisplayName() const { return getStringField(4); }
422 StringRef getLinkageName() const { return getStringField(5); }
423 unsigned getLineNumber() const { return getUnsignedField(7); }
424 DICompositeType getType() const { return getFieldAs<DICompositeType>(8); }
426 /// getReturnTypeName - Subprogram return types are encoded either as
427 /// DIType or as DICompositeType.
428 StringRef getReturnTypeName() const {
429 DICompositeType DCT(getFieldAs<DICompositeType>(8));
431 DIArray A = DCT.getTypeArray();
432 DIType T(A.getElement(0));
435 DIType T(getFieldAs<DIType>(8));
439 /// isLocalToUnit - Return true if this subprogram is local to the current
440 /// compile unit, like 'static' in C.
441 unsigned isLocalToUnit() const { return getUnsignedField(9); }
442 unsigned isDefinition() const { return getUnsignedField(10); }
444 unsigned getVirtuality() const { return getUnsignedField(11); }
445 unsigned getVirtualIndex() const { return getUnsignedField(12); }
447 DICompositeType getContainingType() const {
448 return getFieldAs<DICompositeType>(13);
451 unsigned getFlags() const {
452 return getUnsignedField(14);
455 unsigned isArtificial() const {
456 return (getUnsignedField(14) & FlagArtificial) != 0;
458 /// isPrivate - Return true if this subprogram has "private"
459 /// access specifier.
460 bool isPrivate() const {
461 return (getUnsignedField(14) & FlagPrivate) != 0;
463 /// isProtected - Return true if this subprogram has "protected"
464 /// access specifier.
465 bool isProtected() const {
466 return (getUnsignedField(14) & FlagProtected) != 0;
468 /// isExplicit - Return true if this subprogram is marked as explicit.
469 bool isExplicit() const {
470 return (getUnsignedField(14) & FlagExplicit) != 0;
472 /// isPrototyped - Return true if this subprogram is prototyped.
473 bool isPrototyped() const {
474 return (getUnsignedField(14) & FlagPrototyped) != 0;
477 unsigned isOptimized() const;
479 StringRef getFilename() const {
480 return getFieldAs<DIFile>(6).getFilename();
483 StringRef getDirectory() const {
484 return getFieldAs<DIFile>(6).getDirectory();
487 DIFile getFile() const {
488 return getFieldAs<DIFile>(6);
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(20); }
496 /// Verify - Verify that a subprogram descriptor is well formed.
499 /// describes - Return true if this subprogram provides debugging
500 /// information for the function F.
501 bool describes(const Function *F);
503 Function *getFunction() const { return getFunctionField(16); }
504 void replaceFunction(Function *F) { replaceFunctionField(16, F); }
505 DIArray getTemplateParams() const { return getFieldAs<DIArray>(17); }
506 DISubprogram getFunctionDeclaration() const {
507 return getFieldAs<DISubprogram>(18);
509 MDNode *getVariablesNodes() const;
510 DIArray getVariables() const;
513 /// DIGlobalVariable - This is a wrapper for a global variable.
514 class DIGlobalVariable : public DIDescriptor {
515 friend class DIDescriptor;
516 void printInternal(raw_ostream &OS) const;
518 explicit DIGlobalVariable(const MDNode *N = 0) : DIDescriptor(N) {}
520 DIScope getContext() const { return getFieldAs<DIScope>(2); }
521 StringRef getName() const { return getStringField(3); }
522 StringRef getDisplayName() const { return getStringField(4); }
523 StringRef getLinkageName() const { return getStringField(5); }
524 StringRef getFilename() const {
525 return getFieldAs<DIFile>(6).getFilename();
527 StringRef getDirectory() const {
528 return getFieldAs<DIFile>(6).getDirectory();
532 unsigned getLineNumber() const { return getUnsignedField(7); }
533 DIType getType() const { return getFieldAs<DIType>(8); }
534 unsigned isLocalToUnit() const { return getUnsignedField(9); }
535 unsigned isDefinition() const { return getUnsignedField(10); }
537 GlobalVariable *getGlobal() const { return getGlobalVariableField(11); }
538 Constant *getConstant() const { return getConstantField(11); }
539 DIDerivedType getStaticDataMemberDeclaration() const {
540 return getFieldAs<DIDerivedType>(12);
543 /// Verify - Verify that a global variable descriptor is well formed.
547 /// DIVariable - This is a wrapper for a variable (e.g. parameter, local,
549 class DIVariable : public DIDescriptor {
550 friend class DIDescriptor;
551 void printInternal(raw_ostream &OS) const;
553 explicit DIVariable(const MDNode *N = 0)
556 DIScope getContext() const { return getFieldAs<DIScope>(1); }
557 StringRef getName() const { return getStringField(2); }
558 DIFile getFile() const { return getFieldAs<DIFile>(3); }
559 unsigned getLineNumber() const {
560 return (getUnsignedField(4) << 8) >> 8;
562 unsigned getArgNumber() const {
563 unsigned L = getUnsignedField(4);
566 DIType getType() const { return getFieldAs<DIType>(5); }
568 /// isArtificial - Return true if this variable is marked as "artificial".
569 bool isArtificial() const {
570 return (getUnsignedField(6) & FlagArtificial) != 0;
573 bool isObjectPointer() const {
574 return (getUnsignedField(6) & FlagObjectPointer) != 0;
577 /// getInlinedAt - If this variable is inlined then return inline location.
578 MDNode *getInlinedAt() const;
580 /// Verify - Verify that a variable descriptor is well formed.
583 /// HasComplexAddr - Return true if the variable has a complex address.
584 bool hasComplexAddress() const {
585 return getNumAddrElements() > 0;
588 unsigned getNumAddrElements() const;
590 uint64_t getAddrElement(unsigned Idx) const {
591 return getUInt64Field(Idx+8);
594 /// isBlockByrefVariable - Return true if the variable was declared as
595 /// a "__block" variable (Apple Blocks).
596 bool isBlockByrefVariable() const {
597 return getType().isBlockByrefStruct();
600 /// isInlinedFnArgument - Return true if this variable provides debugging
601 /// information for an inlined function arguments.
602 bool isInlinedFnArgument(const Function *CurFn);
604 void printExtendedName(raw_ostream &OS) const;
607 /// DILexicalBlock - This is a wrapper for a lexical block.
608 class DILexicalBlock : public DIScope {
610 explicit DILexicalBlock(const MDNode *N = 0) : DIScope(N) {}
611 DIScope getContext() const { return getFieldAs<DIScope>(1); }
612 unsigned getLineNumber() const { return getUnsignedField(2); }
613 unsigned getColumnNumber() const { return getUnsignedField(3); }
614 StringRef getDirectory() const {
615 return getFieldAs<DIFile>(4).getDirectory();
617 StringRef getFilename() const {
618 return getFieldAs<DIFile>(4).getFilename();
623 /// DILexicalBlockFile - This is a wrapper for a lexical block with
624 /// a filename change.
625 class DILexicalBlockFile : public DIScope {
627 explicit DILexicalBlockFile(const MDNode *N = 0) : DIScope(N) {}
628 DIScope getContext() const { if (getScope().isSubprogram()) return getScope(); return getScope().getContext(); }
629 unsigned getLineNumber() const { return getScope().getLineNumber(); }
630 unsigned getColumnNumber() const { return getScope().getColumnNumber(); }
631 StringRef getDirectory() const {
632 return getFieldAs<DIFile>(2).getDirectory();
634 StringRef getFilename() const {
635 return getFieldAs<DIFile>(2).getFilename();
637 DILexicalBlock getScope() const { return getFieldAs<DILexicalBlock>(1); }
641 /// DINameSpace - A wrapper for a C++ style name space.
642 class DINameSpace : public DIScope {
643 friend class DIDescriptor;
644 void printInternal(raw_ostream &OS) const;
646 explicit DINameSpace(const MDNode *N = 0) : DIScope(N) {}
647 DIScope getContext() const { return getFieldAs<DIScope>(2); }
648 StringRef getName() const { return getStringField(3); }
649 unsigned getLineNumber() const { return getUnsignedField(4); }
653 /// DILocation - This object holds location information. This object
654 /// is not associated with any DWARF tag.
655 class DILocation : public DIDescriptor {
657 explicit DILocation(const MDNode *N) : DIDescriptor(N) { }
659 unsigned getLineNumber() const { return getUnsignedField(0); }
660 unsigned getColumnNumber() const { return getUnsignedField(1); }
661 DIScope getScope() const { return getFieldAs<DIScope>(2); }
662 DILocation getOrigLocation() const { return getFieldAs<DILocation>(3); }
663 StringRef getFilename() const { return getScope().getFilename(); }
664 StringRef getDirectory() const { return getScope().getDirectory(); }
668 class DIObjCProperty : public DIDescriptor {
669 friend class DIDescriptor;
670 void printInternal(raw_ostream &OS) const;
672 explicit DIObjCProperty(const MDNode *N) : DIDescriptor(N) { }
674 StringRef getObjCPropertyName() const { return getStringField(1); }
675 DIFile getFile() const { return getFieldAs<DIFile>(2); }
676 unsigned getLineNumber() const { return getUnsignedField(3); }
678 StringRef getObjCPropertyGetterName() const {
679 return getStringField(4);
681 StringRef getObjCPropertySetterName() const {
682 return getStringField(5);
684 bool isReadOnlyObjCProperty() {
685 return (getUnsignedField(6) & dwarf::DW_APPLE_PROPERTY_readonly) != 0;
687 bool isReadWriteObjCProperty() {
688 return (getUnsignedField(6) & dwarf::DW_APPLE_PROPERTY_readwrite) != 0;
690 bool isAssignObjCProperty() {
691 return (getUnsignedField(6) & dwarf::DW_APPLE_PROPERTY_assign) != 0;
693 bool isRetainObjCProperty() {
694 return (getUnsignedField(6) & dwarf::DW_APPLE_PROPERTY_retain) != 0;
696 bool isCopyObjCProperty() {
697 return (getUnsignedField(6) & dwarf::DW_APPLE_PROPERTY_copy) != 0;
699 bool isNonAtomicObjCProperty() {
700 return (getUnsignedField(6) & dwarf::DW_APPLE_PROPERTY_nonatomic) != 0;
703 DIType getType() const { return getFieldAs<DIType>(7); }
705 /// Verify - Verify that a derived type descriptor is well formed.
709 /// getDISubprogram - Find subprogram that is enclosing this scope.
710 DISubprogram getDISubprogram(const MDNode *Scope);
712 /// getDICompositeType - Find underlying composite type.
713 DICompositeType getDICompositeType(DIType T);
715 /// isSubprogramContext - Return true if Context is either a subprogram
716 /// or another context nested inside a subprogram.
717 bool isSubprogramContext(const MDNode *Context);
719 /// getOrInsertFnSpecificMDNode - Return a NameMDNode that is suitable
720 /// to hold function specific information.
721 NamedMDNode *getOrInsertFnSpecificMDNode(Module &M, DISubprogram SP);
723 /// getFnSpecificMDNode - Return a NameMDNode, if available, that is
724 /// suitable to hold function specific information.
725 NamedMDNode *getFnSpecificMDNode(const Module &M, DISubprogram SP);
727 /// createInlinedVariable - Create a new inlined variable based on current
729 /// @param DV Current Variable.
730 /// @param InlinedScope Location at current variable is inlined.
731 DIVariable createInlinedVariable(MDNode *DV, MDNode *InlinedScope,
732 LLVMContext &VMContext);
734 /// cleanseInlinedVariable - Remove inlined scope from the variable.
735 DIVariable cleanseInlinedVariable(MDNode *DV, LLVMContext &VMContext);
737 class DebugInfoFinder {
739 /// processModule - Process entire module and collect debug info
741 void processModule(const Module &M);
744 /// processType - Process DIType.
745 void processType(DIType DT);
747 /// processLexicalBlock - Process DILexicalBlock.
748 void processLexicalBlock(DILexicalBlock LB);
750 /// processSubprogram - Process DISubprogram.
751 void processSubprogram(DISubprogram SP);
753 /// processDeclare - Process DbgDeclareInst.
754 void processDeclare(const DbgDeclareInst *DDI);
756 /// processLocation - Process DILocation.
757 void processLocation(DILocation Loc);
759 /// addCompileUnit - Add compile unit into CUs.
760 bool addCompileUnit(DICompileUnit CU);
762 /// addGlobalVariable - Add global variable into GVs.
763 bool addGlobalVariable(DIGlobalVariable DIG);
765 // addSubprogram - Add subprogram into SPs.
766 bool addSubprogram(DISubprogram SP);
768 /// addType - Add type into Tys.
769 bool addType(DIType DT);
772 typedef SmallVector<MDNode *, 8>::const_iterator iterator;
773 iterator compile_unit_begin() const { return CUs.begin(); }
774 iterator compile_unit_end() const { return CUs.end(); }
775 iterator subprogram_begin() const { return SPs.begin(); }
776 iterator subprogram_end() const { return SPs.end(); }
777 iterator global_variable_begin() const { return GVs.begin(); }
778 iterator global_variable_end() const { return GVs.end(); }
779 iterator type_begin() const { return TYs.begin(); }
780 iterator type_end() const { return TYs.end(); }
782 unsigned compile_unit_count() const { return CUs.size(); }
783 unsigned global_variable_count() const { return GVs.size(); }
784 unsigned subprogram_count() const { return SPs.size(); }
785 unsigned type_count() const { return TYs.size(); }
788 SmallVector<MDNode *, 8> CUs; // Compile Units
789 SmallVector<MDNode *, 8> SPs; // Subprograms
790 SmallVector<MDNode *, 8> GVs; // Global Variables;
791 SmallVector<MDNode *, 8> TYs; // Types
792 SmallPtrSet<MDNode *, 64> NodesSeen;
794 } // end namespace llvm