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())
183 /// DICompileUnit - A wrapper for a compile unit.
184 class DICompileUnit : public DIScope {
185 friend class DIDescriptor;
186 void printInternal(raw_ostream &OS) const;
188 explicit DICompileUnit(const MDNode *N = 0) : DIScope(N) {}
190 unsigned getLanguage() const { return getUnsignedField(2); }
191 StringRef getFilename() const {
192 return getFieldAs<DIFile>(3).getFilename();
194 StringRef getDirectory() const {
195 return getFieldAs<DIFile>(3).getDirectory();
197 StringRef getProducer() const { return getStringField(4); }
199 bool isOptimized() const { return getUnsignedField(5) != 0; }
200 StringRef getFlags() const { return getStringField(6); }
201 unsigned getRunTimeVersion() const { return getUnsignedField(7); }
203 DIArray getEnumTypes() const;
204 DIArray getRetainedTypes() const;
205 DIArray getSubprograms() const;
206 DIArray getGlobalVariables() const;
208 StringRef getSplitDebugFilename() const { return getStringField(12); }
210 /// Verify - Verify that a compile unit is well formed.
214 /// DIEnumerator - A wrapper for an enumerator (e.g. X and Y in 'enum {X,Y}').
215 /// FIXME: it seems strange that this doesn't have either a reference to the
216 /// type/precision or a file/line pair for location info.
217 class DIEnumerator : public DIDescriptor {
218 friend class DIDescriptor;
219 void printInternal(raw_ostream &OS) const;
221 explicit DIEnumerator(const MDNode *N = 0) : DIDescriptor(N) {}
223 StringRef getName() const { return getStringField(1); }
224 uint64_t getEnumValue() const { return getUInt64Field(2); }
228 /// DIType - This is a wrapper for a type.
229 /// FIXME: Types should be factored much better so that CV qualifiers and
230 /// others do not require a huge and empty descriptor full of zeros.
231 class DIType : public DIScope {
233 friend class DIDescriptor;
234 void printInternal(raw_ostream &OS) const;
235 // This ctor is used when the Tag has already been validated by a derived
237 DIType(const MDNode *N, bool, bool) : DIScope(N) {}
239 /// Verify - Verify that a type descriptor is well formed.
241 explicit DIType(const MDNode *N);
244 DIScope getContext() const { return getFieldAs<DIScope>(2); }
245 StringRef getName() const { return getStringField(3); }
246 unsigned getLineNumber() const { return getUnsignedField(4); }
247 uint64_t getSizeInBits() const { return getUInt64Field(5); }
248 uint64_t getAlignInBits() const { return getUInt64Field(6); }
249 // FIXME: Offset is only used for DW_TAG_member nodes. Making every type
250 // carry this is just plain insane.
251 uint64_t getOffsetInBits() const { return getUInt64Field(7); }
252 unsigned getFlags() const { return getUnsignedField(8); }
253 bool isPrivate() const {
254 return (getFlags() & FlagPrivate) != 0;
256 bool isProtected() const {
257 return (getFlags() & FlagProtected) != 0;
259 bool isForwardDecl() const {
260 return (getFlags() & FlagFwdDecl) != 0;
262 // isAppleBlock - Return true if this is the Apple Blocks extension.
263 bool isAppleBlockExtension() const {
264 return (getFlags() & FlagAppleBlock) != 0;
266 bool isBlockByrefStruct() const {
267 return (getFlags() & FlagBlockByrefStruct) != 0;
269 bool isVirtual() const {
270 return (getFlags() & FlagVirtual) != 0;
272 bool isArtificial() const {
273 return (getFlags() & FlagArtificial) != 0;
275 bool isObjectPointer() const {
276 return (getFlags() & FlagObjectPointer) != 0;
278 bool isObjcClassComplete() const {
279 return (getFlags() & FlagObjcClassComplete) != 0;
281 bool isVector() const {
282 return (getFlags() & FlagVector) != 0;
284 bool isStaticMember() const {
285 return (getFlags() & FlagStaticMember) != 0;
287 bool isValid() const {
288 return DbgNode && (isBasicType() || isDerivedType() || isCompositeType());
290 StringRef getDirectory() const {
291 return getFieldAs<DIFile>(1).getDirectory();
293 StringRef getFilename() const {
294 return getFieldAs<DIFile>(1).getFilename();
297 /// isUnsignedDIType - Return true if type encoding is unsigned.
298 bool isUnsignedDIType();
300 /// replaceAllUsesWith - Replace all uses of debug info referenced by
302 void replaceAllUsesWith(DIDescriptor &D);
303 void replaceAllUsesWith(MDNode *D);
306 /// DIBasicType - A basic type, like 'int' or 'float'.
307 class DIBasicType : public DIType {
309 explicit DIBasicType(const MDNode *N = 0) : DIType(N) {}
311 unsigned getEncoding() const { return getUnsignedField(9); }
313 /// Verify - Verify that a basic type descriptor is well formed.
317 /// DIDerivedType - A simple derived type, like a const qualified type,
318 /// a typedef, a pointer or reference, et cetera. Or, a data member of
319 /// a class/struct/union.
320 class DIDerivedType : public DIType {
321 friend class DIDescriptor;
322 void printInternal(raw_ostream &OS) const;
324 explicit DIDerivedType(const MDNode *N, bool, bool)
325 : DIType(N, true, true) {}
327 explicit DIDerivedType(const MDNode *N = 0)
328 : DIType(N, true, true) {}
330 DIType getTypeDerivedFrom() const { return getFieldAs<DIType>(9); }
332 /// getOriginalTypeSize - If this type is derived from a base type then
333 /// return base type size.
334 uint64_t getOriginalTypeSize() const;
336 /// getObjCProperty - Return property node, if this ivar is
337 /// associated with one.
338 MDNode *getObjCProperty() const;
340 DIType getClassType() const {
341 assert(getTag() == dwarf::DW_TAG_ptr_to_member_type);
342 return getFieldAs<DIType>(10);
345 Constant *getConstant() const {
346 assert((getTag() == dwarf::DW_TAG_member) && isStaticMember());
347 return getConstantField(10);
350 /// Verify - Verify that a derived type descriptor is well formed.
354 /// DICompositeType - This descriptor holds a type that can refer to multiple
355 /// other types, like a function or struct.
356 /// FIXME: Why is this a DIDerivedType??
357 class DICompositeType : public DIDerivedType {
358 friend class DIDescriptor;
359 void printInternal(raw_ostream &OS) const;
361 explicit DICompositeType(const MDNode *N = 0)
362 : DIDerivedType(N, true, true) {
363 if (N && !isCompositeType())
367 DIArray getTypeArray() const { return getFieldAs<DIArray>(10); }
368 unsigned getRunTimeLang() const { return getUnsignedField(11); }
369 DICompositeType getContainingType() const {
370 return getFieldAs<DICompositeType>(12);
372 DIArray getTemplateParams() const { return getFieldAs<DIArray>(13); }
374 /// Verify - Verify that a composite type descriptor is well formed.
378 /// DITemplateTypeParameter - This is a wrapper for template type parameter.
379 class DITemplateTypeParameter : public DIDescriptor {
381 explicit DITemplateTypeParameter(const MDNode *N = 0) : DIDescriptor(N) {}
383 DIScope getContext() const { return getFieldAs<DIScope>(1); }
384 StringRef getName() const { return getStringField(2); }
385 DIType getType() const { return getFieldAs<DIType>(3); }
386 StringRef getFilename() const {
387 return getFieldAs<DIFile>(4).getFilename();
389 StringRef getDirectory() const {
390 return getFieldAs<DIFile>(4).getDirectory();
392 unsigned getLineNumber() const { return getUnsignedField(5); }
393 unsigned getColumnNumber() const { return getUnsignedField(6); }
397 /// DITemplateValueParameter - This is a wrapper for template value parameter.
398 class DITemplateValueParameter : public DIDescriptor {
400 explicit DITemplateValueParameter(const MDNode *N = 0) : DIDescriptor(N) {}
402 DIScope getContext() const { return getFieldAs<DIScope>(1); }
403 StringRef getName() const { return getStringField(2); }
404 DIType getType() const { return getFieldAs<DIType>(3); }
405 uint64_t getValue() const { return getUInt64Field(4); }
406 StringRef getFilename() const {
407 return getFieldAs<DIFile>(5).getFilename();
409 StringRef getDirectory() const {
410 return getFieldAs<DIFile>(5).getDirectory();
412 unsigned getLineNumber() const { return getUnsignedField(6); }
413 unsigned getColumnNumber() const { return getUnsignedField(7); }
417 /// DISubprogram - This is a wrapper for a subprogram (e.g. a function).
418 class DISubprogram : public DIScope {
419 friend class DIDescriptor;
420 void printInternal(raw_ostream &OS) const;
422 explicit DISubprogram(const MDNode *N = 0) : DIScope(N) {}
424 DIScope getContext() const { return getFieldAs<DIScope>(2); }
425 StringRef getName() const { return getStringField(3); }
426 StringRef getDisplayName() const { return getStringField(4); }
427 StringRef getLinkageName() const { return getStringField(5); }
428 unsigned getLineNumber() const { return getUnsignedField(7); }
429 DICompositeType getType() const { return getFieldAs<DICompositeType>(8); }
431 /// getReturnTypeName - Subprogram return types are encoded either as
432 /// DIType or as DICompositeType.
433 StringRef getReturnTypeName() const {
434 DICompositeType DCT(getFieldAs<DICompositeType>(8));
436 DIArray A = DCT.getTypeArray();
437 DIType T(A.getElement(0));
440 DIType T(getFieldAs<DIType>(8));
444 /// isLocalToUnit - Return true if this subprogram is local to the current
445 /// compile unit, like 'static' in C.
446 unsigned isLocalToUnit() const { return getUnsignedField(9); }
447 unsigned isDefinition() const { return getUnsignedField(10); }
449 unsigned getVirtuality() const { return getUnsignedField(11); }
450 unsigned getVirtualIndex() const { return getUnsignedField(12); }
452 DICompositeType getContainingType() const {
453 return getFieldAs<DICompositeType>(13);
456 unsigned getFlags() const {
457 return getUnsignedField(14);
460 unsigned isArtificial() const {
461 return (getUnsignedField(14) & FlagArtificial) != 0;
463 /// isPrivate - Return true if this subprogram has "private"
464 /// access specifier.
465 bool isPrivate() const {
466 return (getUnsignedField(14) & FlagPrivate) != 0;
468 /// isProtected - Return true if this subprogram has "protected"
469 /// access specifier.
470 bool isProtected() const {
471 return (getUnsignedField(14) & FlagProtected) != 0;
473 /// isExplicit - Return true if this subprogram is marked as explicit.
474 bool isExplicit() const {
475 return (getUnsignedField(14) & FlagExplicit) != 0;
477 /// isPrototyped - Return true if this subprogram is prototyped.
478 bool isPrototyped() const {
479 return (getUnsignedField(14) & FlagPrototyped) != 0;
482 unsigned isOptimized() const;
484 StringRef getFilename() const {
485 return getFieldAs<DIFile>(6).getFilename();
488 StringRef getDirectory() const {
489 return getFieldAs<DIFile>(6).getDirectory();
492 DIFile getFile() const {
493 return getFieldAs<DIFile>(6);
496 /// getScopeLineNumber - Get the beginning of the scope of the
497 /// function, not necessarily where the name of the program
499 unsigned getScopeLineNumber() const { return getUnsignedField(20); }
501 /// Verify - Verify that a subprogram descriptor is well formed.
504 /// describes - Return true if this subprogram provides debugging
505 /// information for the function F.
506 bool describes(const Function *F);
508 Function *getFunction() const { return getFunctionField(16); }
509 void replaceFunction(Function *F) { replaceFunctionField(16, F); }
510 DIArray getTemplateParams() const { return getFieldAs<DIArray>(17); }
511 DISubprogram getFunctionDeclaration() const {
512 return getFieldAs<DISubprogram>(18);
514 MDNode *getVariablesNodes() const;
515 DIArray getVariables() const;
518 /// DIGlobalVariable - This is a wrapper for a global variable.
519 class DIGlobalVariable : public DIDescriptor {
520 friend class DIDescriptor;
521 void printInternal(raw_ostream &OS) const;
523 explicit DIGlobalVariable(const MDNode *N = 0) : DIDescriptor(N) {}
525 DIScope getContext() const { return getFieldAs<DIScope>(2); }
526 StringRef getName() const { return getStringField(3); }
527 StringRef getDisplayName() const { return getStringField(4); }
528 StringRef getLinkageName() const { return getStringField(5); }
529 StringRef getFilename() const {
530 return getFieldAs<DIFile>(6).getFilename();
532 StringRef getDirectory() const {
533 return getFieldAs<DIFile>(6).getDirectory();
537 unsigned getLineNumber() const { return getUnsignedField(7); }
538 DIType getType() const { return getFieldAs<DIType>(8); }
539 unsigned isLocalToUnit() const { return getUnsignedField(9); }
540 unsigned isDefinition() const { return getUnsignedField(10); }
542 GlobalVariable *getGlobal() const { return getGlobalVariableField(11); }
543 Constant *getConstant() const { return getConstantField(11); }
544 DIDerivedType getStaticDataMemberDeclaration() const {
545 return getFieldAs<DIDerivedType>(12);
548 /// Verify - Verify that a global variable descriptor is well formed.
552 /// DIVariable - This is a wrapper for a variable (e.g. parameter, local,
554 class DIVariable : public DIDescriptor {
555 friend class DIDescriptor;
556 void printInternal(raw_ostream &OS) const;
558 explicit DIVariable(const MDNode *N = 0)
561 DIScope getContext() const { return getFieldAs<DIScope>(1); }
562 StringRef getName() const { return getStringField(2); }
563 DIFile getFile() const { return getFieldAs<DIFile>(3); }
564 unsigned getLineNumber() const {
565 return (getUnsignedField(4) << 8) >> 8;
567 unsigned getArgNumber() const {
568 unsigned L = getUnsignedField(4);
571 DIType getType() const { return getFieldAs<DIType>(5); }
573 /// isArtificial - Return true if this variable is marked as "artificial".
574 bool isArtificial() const {
575 return (getUnsignedField(6) & FlagArtificial) != 0;
578 bool isObjectPointer() const {
579 return (getUnsignedField(6) & FlagObjectPointer) != 0;
582 /// getInlinedAt - If this variable is inlined then return inline location.
583 MDNode *getInlinedAt() const;
585 /// Verify - Verify that a variable descriptor is well formed.
588 /// HasComplexAddr - Return true if the variable has a complex address.
589 bool hasComplexAddress() const {
590 return getNumAddrElements() > 0;
593 unsigned getNumAddrElements() const;
595 uint64_t getAddrElement(unsigned Idx) const {
596 return getUInt64Field(Idx+8);
599 /// isBlockByrefVariable - Return true if the variable was declared as
600 /// a "__block" variable (Apple Blocks).
601 bool isBlockByrefVariable() const {
602 return getType().isBlockByrefStruct();
605 /// isInlinedFnArgument - Return true if this variable provides debugging
606 /// information for an inlined function arguments.
607 bool isInlinedFnArgument(const Function *CurFn);
609 void printExtendedName(raw_ostream &OS) const;
612 /// DILexicalBlock - This is a wrapper for a lexical block.
613 class DILexicalBlock : public DIScope {
615 explicit DILexicalBlock(const MDNode *N = 0) : DIScope(N) {}
616 DIScope getContext() const { return getFieldAs<DIScope>(1); }
617 unsigned getLineNumber() const { return getUnsignedField(2); }
618 unsigned getColumnNumber() const { return getUnsignedField(3); }
619 StringRef getDirectory() const {
620 return getFieldAs<DIFile>(4).getDirectory();
622 StringRef getFilename() const {
623 return getFieldAs<DIFile>(4).getFilename();
628 /// DILexicalBlockFile - This is a wrapper for a lexical block with
629 /// a filename change.
630 class DILexicalBlockFile : public DIScope {
632 explicit DILexicalBlockFile(const MDNode *N = 0) : DIScope(N) {}
633 DIScope getContext() const { if (getScope().isSubprogram()) return getScope(); return getScope().getContext(); }
634 unsigned getLineNumber() const { return getScope().getLineNumber(); }
635 unsigned getColumnNumber() const { return getScope().getColumnNumber(); }
636 StringRef getDirectory() const {
637 return getFieldAs<DIFile>(2).getDirectory();
639 StringRef getFilename() const {
640 return getFieldAs<DIFile>(2).getFilename();
642 DILexicalBlock getScope() const { return getFieldAs<DILexicalBlock>(1); }
646 /// DINameSpace - A wrapper for a C++ style name space.
647 class DINameSpace : public DIScope {
649 explicit DINameSpace(const MDNode *N = 0) : DIScope(N) {}
650 DIScope getContext() const { return getFieldAs<DIScope>(1); }
651 StringRef getName() const { return getStringField(2); }
652 StringRef getDirectory() const {
653 return getFieldAs<DIFile>(3).getDirectory();
655 StringRef getFilename() const {
656 return getFieldAs<DIFile>(3).getFilename();
658 unsigned getLineNumber() const { return getUnsignedField(4); }
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;
681 explicit DIObjCProperty(const MDNode *N) : DIDescriptor(N) { }
683 StringRef getObjCPropertyName() const { return getStringField(1); }
684 DIFile getFile() const { return getFieldAs<DIFile>(2); }
685 unsigned getLineNumber() const { return getUnsignedField(3); }
687 StringRef getObjCPropertyGetterName() const {
688 return getStringField(4);
690 StringRef getObjCPropertySetterName() const {
691 return getStringField(5);
693 bool isReadOnlyObjCProperty() {
694 return (getUnsignedField(6) & dwarf::DW_APPLE_PROPERTY_readonly) != 0;
696 bool isReadWriteObjCProperty() {
697 return (getUnsignedField(6) & dwarf::DW_APPLE_PROPERTY_readwrite) != 0;
699 bool isAssignObjCProperty() {
700 return (getUnsignedField(6) & dwarf::DW_APPLE_PROPERTY_assign) != 0;
702 bool isRetainObjCProperty() {
703 return (getUnsignedField(6) & dwarf::DW_APPLE_PROPERTY_retain) != 0;
705 bool isCopyObjCProperty() {
706 return (getUnsignedField(6) & dwarf::DW_APPLE_PROPERTY_copy) != 0;
708 bool isNonAtomicObjCProperty() {
709 return (getUnsignedField(6) & dwarf::DW_APPLE_PROPERTY_nonatomic) != 0;
712 DIType getType() const { return getFieldAs<DIType>(7); }
714 /// Verify - Verify that a derived type descriptor is well formed.
718 /// getDISubprogram - Find subprogram that is enclosing this scope.
719 DISubprogram getDISubprogram(const MDNode *Scope);
721 /// getDICompositeType - Find underlying composite type.
722 DICompositeType getDICompositeType(DIType T);
724 /// isSubprogramContext - Return true if Context is either a subprogram
725 /// or another context nested inside a subprogram.
726 bool isSubprogramContext(const MDNode *Context);
728 /// getOrInsertFnSpecificMDNode - Return a NameMDNode that is suitable
729 /// to hold function specific information.
730 NamedMDNode *getOrInsertFnSpecificMDNode(Module &M, DISubprogram SP);
732 /// getFnSpecificMDNode - Return a NameMDNode, if available, that is
733 /// suitable to hold function specific information.
734 NamedMDNode *getFnSpecificMDNode(const Module &M, DISubprogram SP);
736 /// createInlinedVariable - Create a new inlined variable based on current
738 /// @param DV Current Variable.
739 /// @param InlinedScope Location at current variable is inlined.
740 DIVariable createInlinedVariable(MDNode *DV, MDNode *InlinedScope,
741 LLVMContext &VMContext);
743 /// cleanseInlinedVariable - Remove inlined scope from the variable.
744 DIVariable cleanseInlinedVariable(MDNode *DV, LLVMContext &VMContext);
746 class DebugInfoFinder {
748 /// processModule - Process entire module and collect debug info
750 void processModule(const Module &M);
753 /// processType - Process DIType.
754 void processType(DIType DT);
756 /// processLexicalBlock - Process DILexicalBlock.
757 void processLexicalBlock(DILexicalBlock LB);
759 /// processSubprogram - Process DISubprogram.
760 void processSubprogram(DISubprogram SP);
762 /// processDeclare - Process DbgDeclareInst.
763 void processDeclare(const DbgDeclareInst *DDI);
765 /// processLocation - Process DILocation.
766 void processLocation(DILocation Loc);
768 /// addCompileUnit - Add compile unit into CUs.
769 bool addCompileUnit(DICompileUnit CU);
771 /// addGlobalVariable - Add global variable into GVs.
772 bool addGlobalVariable(DIGlobalVariable DIG);
774 // addSubprogram - Add subprogram into SPs.
775 bool addSubprogram(DISubprogram SP);
777 /// addType - Add type into Tys.
778 bool addType(DIType DT);
781 typedef SmallVector<MDNode *, 8>::const_iterator iterator;
782 iterator compile_unit_begin() const { return CUs.begin(); }
783 iterator compile_unit_end() const { return CUs.end(); }
784 iterator subprogram_begin() const { return SPs.begin(); }
785 iterator subprogram_end() const { return SPs.end(); }
786 iterator global_variable_begin() const { return GVs.begin(); }
787 iterator global_variable_end() const { return GVs.end(); }
788 iterator type_begin() const { return TYs.begin(); }
789 iterator type_end() const { return TYs.end(); }
791 unsigned compile_unit_count() const { return CUs.size(); }
792 unsigned global_variable_count() const { return GVs.size(); }
793 unsigned subprogram_count() const { return SPs.size(); }
794 unsigned type_count() const { return TYs.size(); }
797 SmallVector<MDNode *, 8> CUs; // Compile Units
798 SmallVector<MDNode *, 8> SPs; // Subprograms
799 SmallVector<MDNode *, 8> GVs; // Global Variables;
800 SmallVector<MDNode *, 8> TYs; // Types
801 SmallPtrSet<MDNode *, 64> NodesSeen;
803 } // end namespace llvm