Debug info: Implement (rvalue) reference qualifiers for C++11 non-static
[opencl/llvm.git] / lib / IR / DebugInfo.cpp
1 //===--- DebugInfo.cpp - Debug Information Helper Classes -----------------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This file implements the helper classes used to build and interpret debug
11 // information in LLVM IR form.
12 //
13 //===----------------------------------------------------------------------===//
15 #include "llvm/DebugInfo.h"
16 #include "llvm/ADT/STLExtras.h"
17 #include "llvm/ADT/SmallPtrSet.h"
18 #include "llvm/ADT/SmallString.h"
19 #include "llvm/Analysis/ValueTracking.h"
20 #include "llvm/IR/Constants.h"
21 #include "llvm/IR/DerivedTypes.h"
22 #include "llvm/IR/Instructions.h"
23 #include "llvm/IR/IntrinsicInst.h"
24 #include "llvm/IR/Intrinsics.h"
25 #include "llvm/IR/Module.h"
26 #include "llvm/Support/Debug.h"
27 #include "llvm/Support/Dwarf.h"
28 #include "llvm/Support/ValueHandle.h"
29 #include "llvm/Support/raw_ostream.h"
30 using namespace llvm;
31 using namespace llvm::dwarf;
33 //===----------------------------------------------------------------------===//
34 // DIDescriptor
35 //===----------------------------------------------------------------------===//
37 bool DIDescriptor::Verify() const {
38   return DbgNode &&
39          (DIDerivedType(DbgNode).Verify() ||
40           DICompositeType(DbgNode).Verify() || DIBasicType(DbgNode).Verify() ||
41           DIVariable(DbgNode).Verify() || DISubprogram(DbgNode).Verify() ||
42           DIGlobalVariable(DbgNode).Verify() || DIFile(DbgNode).Verify() ||
43           DICompileUnit(DbgNode).Verify() || DINameSpace(DbgNode).Verify() ||
44           DILexicalBlock(DbgNode).Verify() ||
45           DILexicalBlockFile(DbgNode).Verify() ||
46           DISubrange(DbgNode).Verify() || DIEnumerator(DbgNode).Verify() ||
47           DIObjCProperty(DbgNode).Verify() ||
48           DITemplateTypeParameter(DbgNode).Verify() ||
49           DITemplateValueParameter(DbgNode).Verify() ||
50           DIImportedEntity(DbgNode).Verify());
51 }
53 static Value *getField(const MDNode *DbgNode, unsigned Elt) {
54   if (DbgNode == 0 || Elt >= DbgNode->getNumOperands())
55     return 0;
56   return DbgNode->getOperand(Elt);
57 }
59 static MDNode *getNodeField(const MDNode *DbgNode, unsigned Elt) {
60   return dyn_cast_or_null<MDNode>(getField(DbgNode, Elt));
61 }
63 static StringRef getStringField(const MDNode *DbgNode, unsigned Elt) {
64   if (MDString *MDS = dyn_cast_or_null<MDString>(getField(DbgNode, Elt)))
65     return MDS->getString();
66   return StringRef();
67 }
69 StringRef DIDescriptor::getStringField(unsigned Elt) const {
70   return ::getStringField(DbgNode, Elt);
71 }
73 uint64_t DIDescriptor::getUInt64Field(unsigned Elt) const {
74   if (DbgNode == 0)
75     return 0;
77   if (Elt < DbgNode->getNumOperands())
78     if (ConstantInt *CI =
79             dyn_cast_or_null<ConstantInt>(DbgNode->getOperand(Elt)))
80       return CI->getZExtValue();
82   return 0;
83 }
85 int64_t DIDescriptor::getInt64Field(unsigned Elt) const {
86   if (DbgNode == 0)
87     return 0;
89   if (Elt < DbgNode->getNumOperands())
90     if (ConstantInt *CI =
91             dyn_cast_or_null<ConstantInt>(DbgNode->getOperand(Elt)))
92       return CI->getSExtValue();
94   return 0;
95 }
97 DIDescriptor DIDescriptor::getDescriptorField(unsigned Elt) const {
98   MDNode *Field = getNodeField(DbgNode, Elt);
99   return DIDescriptor(Field);
102 GlobalVariable *DIDescriptor::getGlobalVariableField(unsigned Elt) const {
103   if (DbgNode == 0)
104     return 0;
106   if (Elt < DbgNode->getNumOperands())
107     return dyn_cast_or_null<GlobalVariable>(DbgNode->getOperand(Elt));
108   return 0;
111 Constant *DIDescriptor::getConstantField(unsigned Elt) const {
112   if (DbgNode == 0)
113     return 0;
115   if (Elt < DbgNode->getNumOperands())
116     return dyn_cast_or_null<Constant>(DbgNode->getOperand(Elt));
117   return 0;
120 Function *DIDescriptor::getFunctionField(unsigned Elt) const {
121   if (DbgNode == 0)
122     return 0;
124   if (Elt < DbgNode->getNumOperands())
125     return dyn_cast_or_null<Function>(DbgNode->getOperand(Elt));
126   return 0;
129 void DIDescriptor::replaceFunctionField(unsigned Elt, Function *F) {
130   if (DbgNode == 0)
131     return;
133   if (Elt < DbgNode->getNumOperands()) {
134     MDNode *Node = const_cast<MDNode *>(DbgNode);
135     Node->replaceOperandWith(Elt, F);
136   }
139 unsigned DIVariable::getNumAddrElements() const {
140   return DbgNode->getNumOperands() - 8;
143 /// getInlinedAt - If this variable is inlined then return inline location.
144 MDNode *DIVariable::getInlinedAt() const { return getNodeField(DbgNode, 7); }
146 //===----------------------------------------------------------------------===//
147 // Predicates
148 //===----------------------------------------------------------------------===//
150 /// isBasicType - Return true if the specified tag is legal for
151 /// DIBasicType.
152 bool DIDescriptor::isBasicType() const {
153   if (!DbgNode)
154     return false;
155   switch (getTag()) {
156   case dwarf::DW_TAG_base_type:
157   case dwarf::DW_TAG_unspecified_type:
158     return true;
159   default:
160     return false;
161   }
164 /// isDerivedType - Return true if the specified tag is legal for DIDerivedType.
165 bool DIDescriptor::isDerivedType() const {
166   if (!DbgNode)
167     return false;
168   switch (getTag()) {
169   case dwarf::DW_TAG_typedef:
170   case dwarf::DW_TAG_pointer_type:
171   case dwarf::DW_TAG_ptr_to_member_type:
172   case dwarf::DW_TAG_reference_type:
173   case dwarf::DW_TAG_rvalue_reference_type:
174   case dwarf::DW_TAG_const_type:
175   case dwarf::DW_TAG_volatile_type:
176   case dwarf::DW_TAG_restrict_type:
177   case dwarf::DW_TAG_member:
178   case dwarf::DW_TAG_inheritance:
179   case dwarf::DW_TAG_friend:
180     return true;
181   default:
182     // CompositeTypes are currently modelled as DerivedTypes.
183     return isCompositeType();
184   }
187 /// isCompositeType - Return true if the specified tag is legal for
188 /// DICompositeType.
189 bool DIDescriptor::isCompositeType() const {
190   if (!DbgNode)
191     return false;
192   switch (getTag()) {
193   case dwarf::DW_TAG_array_type:
194   case dwarf::DW_TAG_structure_type:
195   case dwarf::DW_TAG_union_type:
196   case dwarf::DW_TAG_enumeration_type:
197   case dwarf::DW_TAG_subroutine_type:
198   case dwarf::DW_TAG_class_type:
199     return true;
200   default:
201     return false;
202   }
205 /// isVariable - Return true if the specified tag is legal for DIVariable.
206 bool DIDescriptor::isVariable() const {
207   if (!DbgNode)
208     return false;
209   switch (getTag()) {
210   case dwarf::DW_TAG_auto_variable:
211   case dwarf::DW_TAG_arg_variable:
212     return true;
213   default:
214     return false;
215   }
218 /// isType - Return true if the specified tag is legal for DIType.
219 bool DIDescriptor::isType() const {
220   return isBasicType() || isCompositeType() || isDerivedType();
223 /// isSubprogram - Return true if the specified tag is legal for
224 /// DISubprogram.
225 bool DIDescriptor::isSubprogram() const {
226   return DbgNode && getTag() == dwarf::DW_TAG_subprogram;
229 /// isGlobalVariable - Return true if the specified tag is legal for
230 /// DIGlobalVariable.
231 bool DIDescriptor::isGlobalVariable() const {
232   return DbgNode && (getTag() == dwarf::DW_TAG_variable ||
233                      getTag() == dwarf::DW_TAG_constant);
236 /// isUnspecifiedParmeter - Return true if the specified tag is
237 /// DW_TAG_unspecified_parameters.
238 bool DIDescriptor::isUnspecifiedParameter() const {
239   return DbgNode && getTag() == dwarf::DW_TAG_unspecified_parameters;
242 /// isScope - Return true if the specified tag is one of the scope
243 /// related tag.
244 bool DIDescriptor::isScope() const {
245   if (!DbgNode)
246     return false;
247   switch (getTag()) {
248   case dwarf::DW_TAG_compile_unit:
249   case dwarf::DW_TAG_lexical_block:
250   case dwarf::DW_TAG_subprogram:
251   case dwarf::DW_TAG_namespace:
252   case dwarf::DW_TAG_file_type:
253     return true;
254   default:
255     break;
256   }
257   return isType();
260 /// isTemplateTypeParameter - Return true if the specified tag is
261 /// DW_TAG_template_type_parameter.
262 bool DIDescriptor::isTemplateTypeParameter() const {
263   return DbgNode && getTag() == dwarf::DW_TAG_template_type_parameter;
266 /// isTemplateValueParameter - Return true if the specified tag is
267 /// DW_TAG_template_value_parameter.
268 bool DIDescriptor::isTemplateValueParameter() const {
269   return DbgNode && (getTag() == dwarf::DW_TAG_template_value_parameter ||
270                      getTag() == dwarf::DW_TAG_GNU_template_template_param ||
271                      getTag() == dwarf::DW_TAG_GNU_template_parameter_pack);
274 /// isCompileUnit - Return true if the specified tag is DW_TAG_compile_unit.
275 bool DIDescriptor::isCompileUnit() const {
276   return DbgNode && getTag() == dwarf::DW_TAG_compile_unit;
279 /// isFile - Return true if the specified tag is DW_TAG_file_type.
280 bool DIDescriptor::isFile() const {
281   return DbgNode && getTag() == dwarf::DW_TAG_file_type;
284 /// isNameSpace - Return true if the specified tag is DW_TAG_namespace.
285 bool DIDescriptor::isNameSpace() const {
286   return DbgNode && getTag() == dwarf::DW_TAG_namespace;
289 /// isLexicalBlockFile - Return true if the specified descriptor is a
290 /// lexical block with an extra file.
291 bool DIDescriptor::isLexicalBlockFile() const {
292   return DbgNode && getTag() == dwarf::DW_TAG_lexical_block &&
293          (DbgNode->getNumOperands() == 3);
296 /// isLexicalBlock - Return true if the specified tag is DW_TAG_lexical_block.
297 bool DIDescriptor::isLexicalBlock() const {
298   return DbgNode && getTag() == dwarf::DW_TAG_lexical_block &&
299          (DbgNode->getNumOperands() > 3);
302 /// isSubrange - Return true if the specified tag is DW_TAG_subrange_type.
303 bool DIDescriptor::isSubrange() const {
304   return DbgNode && getTag() == dwarf::DW_TAG_subrange_type;
307 /// isEnumerator - Return true if the specified tag is DW_TAG_enumerator.
308 bool DIDescriptor::isEnumerator() const {
309   return DbgNode && getTag() == dwarf::DW_TAG_enumerator;
312 /// isObjCProperty - Return true if the specified tag is DW_TAG_APPLE_property.
313 bool DIDescriptor::isObjCProperty() const {
314   return DbgNode && getTag() == dwarf::DW_TAG_APPLE_property;
317 /// \brief Return true if the specified tag is DW_TAG_imported_module or
318 /// DW_TAG_imported_declaration.
319 bool DIDescriptor::isImportedEntity() const {
320   return DbgNode && (getTag() == dwarf::DW_TAG_imported_module ||
321                      getTag() == dwarf::DW_TAG_imported_declaration);
324 //===----------------------------------------------------------------------===//
325 // Simple Descriptor Constructors and other Methods
326 //===----------------------------------------------------------------------===//
328 unsigned DIArray::getNumElements() const {
329   if (!DbgNode)
330     return 0;
331   return DbgNode->getNumOperands();
334 /// replaceAllUsesWith - Replace all uses of the MDNode used by this
335 /// type with the one in the passed descriptor.
336 void DIType::replaceAllUsesWith(DIDescriptor &D) {
338   assert(DbgNode && "Trying to replace an unverified type!");
340   // Since we use a TrackingVH for the node, its easy for clients to manufacture
341   // legitimate situations where they want to replaceAllUsesWith() on something
342   // which, due to uniquing, has merged with the source. We shield clients from
343   // this detail by allowing a value to be replaced with replaceAllUsesWith()
344   // itself.
345   if (DbgNode != D) {
346     MDNode *Node = const_cast<MDNode *>(DbgNode);
347     const MDNode *DN = D;
348     const Value *V = cast_or_null<Value>(DN);
349     Node->replaceAllUsesWith(const_cast<Value *>(V));
350     MDNode::deleteTemporary(Node);
351   }
354 /// replaceAllUsesWith - Replace all uses of the MDNode used by this
355 /// type with the one in D.
356 void DIType::replaceAllUsesWith(MDNode *D) {
358   assert(DbgNode && "Trying to replace an unverified type!");
360   // Since we use a TrackingVH for the node, its easy for clients to manufacture
361   // legitimate situations where they want to replaceAllUsesWith() on something
362   // which, due to uniquing, has merged with the source. We shield clients from
363   // this detail by allowing a value to be replaced with replaceAllUsesWith()
364   // itself.
365   if (DbgNode != D) {
366     MDNode *Node = const_cast<MDNode *>(DbgNode);
367     const MDNode *DN = D;
368     const Value *V = cast_or_null<Value>(DN);
369     Node->replaceAllUsesWith(const_cast<Value *>(V));
370     MDNode::deleteTemporary(Node);
371   }
374 /// Verify - Verify that a compile unit is well formed.
375 bool DICompileUnit::Verify() const {
376   if (!isCompileUnit())
377     return false;
379   // Don't bother verifying the compilation directory or producer string
380   // as those could be empty.
381   if (getFilename().empty())
382     return false;
384   return DbgNode->getNumOperands() == 13;
387 /// Verify - Verify that an ObjC property is well formed.
388 bool DIObjCProperty::Verify() const {
389   if (!isObjCProperty())
390     return false;
392   // Don't worry about the rest of the strings for now.
393   return DbgNode->getNumOperands() == 8;
396 /// Check if a field at position Elt of a MDNode is a MDNode.
397 /// We currently allow an empty string and an integer.
398 /// But we don't allow a non-empty string in a MDNode field.
399 static bool fieldIsMDNode(const MDNode *DbgNode, unsigned Elt) {
400   // FIXME: This function should return true, if the field is null or the field
401   // is indeed a MDNode: return !Fld || isa<MDNode>(Fld).
402   Value *Fld = getField(DbgNode, Elt);
403   if (Fld && isa<MDString>(Fld) && !cast<MDString>(Fld)->getString().empty())
404     return false;
405   return true;
408 /// Check if a field at position Elt of a MDNode is a MDString.
409 static bool fieldIsMDString(const MDNode *DbgNode, unsigned Elt) {
410   Value *Fld = getField(DbgNode, Elt);
411   return !Fld || isa<MDString>(Fld);
414 /// Check if a value can be a reference to a type.
415 static bool isTypeRef(const Value *Val) {
416   return !Val ||
417          (isa<MDString>(Val) && !cast<MDString>(Val)->getString().empty()) ||
418          (isa<MDNode>(Val) && DIType(cast<MDNode>(Val)).isType());
421 /// Check if a field at position Elt of a MDNode can be a reference to a type.
422 static bool fieldIsTypeRef(const MDNode *DbgNode, unsigned Elt) {
423   Value *Fld = getField(DbgNode, Elt);
424   return isTypeRef(Fld);
427 /// Check if a value can be a ScopeRef.
428 static bool isScopeRef(const Value *Val) {
429   return !Val ||
430          (isa<MDString>(Val) && !cast<MDString>(Val)->getString().empty()) ||
431          (isa<MDNode>(Val) && DIScope(cast<MDNode>(Val)).isScope());
434 /// Check if a field at position Elt of a MDNode can be a ScopeRef.
435 static bool fieldIsScopeRef(const MDNode *DbgNode, unsigned Elt) {
436   Value *Fld = getField(DbgNode, Elt);
437   return isScopeRef(Fld);
440 /// Verify - Verify that a type descriptor is well formed.
441 bool DIType::Verify() const {
442   if (!isType())
443     return false;
444   // Make sure Context @ field 2 is MDNode.
445   if (!fieldIsScopeRef(DbgNode, 2))
446     return false;
448   // FIXME: Sink this into the various subclass verifies.
449   uint16_t Tag = getTag();
450   if (!isBasicType() && Tag != dwarf::DW_TAG_const_type &&
451       Tag != dwarf::DW_TAG_volatile_type && Tag != dwarf::DW_TAG_pointer_type &&
452       Tag != dwarf::DW_TAG_ptr_to_member_type &&
453       Tag != dwarf::DW_TAG_reference_type &&
454       Tag != dwarf::DW_TAG_rvalue_reference_type &&
455       Tag != dwarf::DW_TAG_restrict_type && Tag != dwarf::DW_TAG_array_type &&
456       Tag != dwarf::DW_TAG_enumeration_type &&
457       Tag != dwarf::DW_TAG_subroutine_type &&
458       Tag != dwarf::DW_TAG_inheritance && Tag != dwarf::DW_TAG_friend &&
459       getFilename().empty())
460     return false;
461   // DIType is abstract, it should be a BasicType, a DerivedType or
462   // a CompositeType.
463   if (isBasicType())
464     return DIBasicType(DbgNode).Verify();
465   else if (isCompositeType())
466     return DICompositeType(DbgNode).Verify();
467   else if (isDerivedType())
468     return DIDerivedType(DbgNode).Verify();
469   else
470     return false;
473 /// Verify - Verify that a basic type descriptor is well formed.
474 bool DIBasicType::Verify() const {
475   return isBasicType() && DbgNode->getNumOperands() == 10;
478 /// Verify - Verify that a derived type descriptor is well formed.
479 bool DIDerivedType::Verify() const {
480   // Make sure DerivedFrom @ field 9 is TypeRef.
481   if (!fieldIsTypeRef(DbgNode, 9))
482     return false;
483   if (getTag() == dwarf::DW_TAG_ptr_to_member_type)
484     // Make sure ClassType @ field 10 is a TypeRef.
485     if (!fieldIsTypeRef(DbgNode, 10))
486       return false;
488   return isDerivedType() && DbgNode->getNumOperands() >= 10 &&
489          DbgNode->getNumOperands() <= 14;
492 /// Verify - Verify that a composite type descriptor is well formed.
493 bool DICompositeType::Verify() const {
494   if (!isCompositeType())
495     return false;
497   // Make sure DerivedFrom @ field 9 and ContainingType @ field 12 are TypeRef.
498   if (!fieldIsTypeRef(DbgNode, 9))
499     return false;
500   if (!fieldIsTypeRef(DbgNode, 12))
501     return false;
503   // Make sure the type identifier at field 14 is MDString, it can be null.
504   if (!fieldIsMDString(DbgNode, 14))
505     return false;
507   // A subroutine type can't be both & and &&.
508   if (isLValueReference() && isRValueReference())
509     return false;
511   return DbgNode->getNumOperands() == 15;
514 /// Verify - Verify that a subprogram descriptor is well formed.
515 bool DISubprogram::Verify() const {
516   if (!isSubprogram())
517     return false;
519   // Make sure context @ field 2 is a ScopeRef and type @ field 7 is a MDNode.
520   if (!fieldIsScopeRef(DbgNode, 2))
521     return false;
522   if (!fieldIsMDNode(DbgNode, 7))
523     return false;
524   // Containing type @ field 12.
525   if (!fieldIsTypeRef(DbgNode, 12))
526     return false;
528   // A subprogram can't be both & and &&.
529   if (isLValueReference() && isRValueReference())
530     return false;
532   return DbgNode->getNumOperands() == 20;
535 /// Verify - Verify that a global variable descriptor is well formed.
536 bool DIGlobalVariable::Verify() const {
537   if (!isGlobalVariable())
538     return false;
540   if (getDisplayName().empty())
541     return false;
542   // Make sure context @ field 2 and type @ field 8 are MDNodes.
543   if (!fieldIsMDNode(DbgNode, 2))
544     return false;
545   if (!fieldIsMDNode(DbgNode, 8))
546     return false;
547   // Make sure StaticDataMemberDeclaration @ field 12 is MDNode.
548   if (!fieldIsMDNode(DbgNode, 12))
549     return false;
551   return DbgNode->getNumOperands() == 13;
554 /// Verify - Verify that a variable descriptor is well formed.
555 bool DIVariable::Verify() const {
556   if (!isVariable())
557     return false;
559   // Make sure context @ field 1 and type @ field 5 are MDNodes.
560   if (!fieldIsMDNode(DbgNode, 1))
561     return false;
562   if (!fieldIsMDNode(DbgNode, 5))
563     return false;
564   return DbgNode->getNumOperands() >= 8;
567 /// Verify - Verify that a location descriptor is well formed.
568 bool DILocation::Verify() const {
569   if (!DbgNode)
570     return false;
572   return DbgNode->getNumOperands() == 4;
575 /// Verify - Verify that a namespace descriptor is well formed.
576 bool DINameSpace::Verify() const {
577   if (!isNameSpace())
578     return false;
579   return DbgNode->getNumOperands() == 5;
582 /// \brief Retrieve the MDNode for the directory/file pair.
583 MDNode *DIFile::getFileNode() const { return getNodeField(DbgNode, 1); }
585 /// \brief Verify that the file descriptor is well formed.
586 bool DIFile::Verify() const {
587   return isFile() && DbgNode->getNumOperands() == 2;
590 /// \brief Verify that the enumerator descriptor is well formed.
591 bool DIEnumerator::Verify() const {
592   return isEnumerator() && DbgNode->getNumOperands() == 3;
595 /// \brief Verify that the subrange descriptor is well formed.
596 bool DISubrange::Verify() const {
597   return isSubrange() && DbgNode->getNumOperands() == 3;
600 /// \brief Verify that the lexical block descriptor is well formed.
601 bool DILexicalBlock::Verify() const {
602   return isLexicalBlock() && DbgNode->getNumOperands() == 6;
605 /// \brief Verify that the file-scoped lexical block descriptor is well formed.
606 bool DILexicalBlockFile::Verify() const {
607   return isLexicalBlockFile() && DbgNode->getNumOperands() == 3;
610 /// \brief Verify that the template type parameter descriptor is well formed.
611 bool DITemplateTypeParameter::Verify() const {
612   return isTemplateTypeParameter() && DbgNode->getNumOperands() == 7;
615 /// \brief Verify that the template value parameter descriptor is well formed.
616 bool DITemplateValueParameter::Verify() const {
617   return isTemplateValueParameter() && DbgNode->getNumOperands() == 8;
620 /// \brief Verify that the imported module descriptor is well formed.
621 bool DIImportedEntity::Verify() const {
622   return isImportedEntity() &&
623          (DbgNode->getNumOperands() == 4 || DbgNode->getNumOperands() == 5);
626 /// getObjCProperty - Return property node, if this ivar is associated with one.
627 MDNode *DIDerivedType::getObjCProperty() const {
628   return getNodeField(DbgNode, 10);
631 MDString *DICompositeType::getIdentifier() const {
632   return cast_or_null<MDString>(getField(DbgNode, 14));
635 #ifndef NDEBUG
636 static void VerifySubsetOf(const MDNode *LHS, const MDNode *RHS) {
637   for (unsigned i = 0; i != LHS->getNumOperands(); ++i) {
638     // Skip the 'empty' list (that's a single i32 0, rather than truly empty).
639     if (i == 0 && isa<ConstantInt>(LHS->getOperand(i)))
640       continue;
641     const MDNode *E = cast<MDNode>(LHS->getOperand(i));
642     bool found = false;
643     for (unsigned j = 0; !found && j != RHS->getNumOperands(); ++j)
644       found = E == RHS->getOperand(j);
645     assert(found && "Losing a member during member list replacement");
646   }
648 #endif
650 /// \brief Set the array of member DITypes.
651 void DICompositeType::setTypeArray(DIArray Elements, DIArray TParams) {
652   assert((!TParams || DbgNode->getNumOperands() == 15) &&
653          "If you're setting the template parameters this should include a slot "
654          "for that!");
655   TrackingVH<MDNode> N(*this);
656   if (Elements) {
657 #ifndef NDEBUG
658     // Check that the new list of members contains all the old members as well.
659     if (const MDNode *El = cast_or_null<MDNode>(N->getOperand(10)))
660       VerifySubsetOf(El, Elements);
661 #endif
662     N->replaceOperandWith(10, Elements);
663   }
664   if (TParams)
665     N->replaceOperandWith(13, TParams);
666   DbgNode = N;
669 void DICompositeType::addMember(DIDescriptor D) {
670   SmallVector<llvm::Value *, 16> M;
671   DIArray OrigM = getTypeArray();
672   unsigned Elements = OrigM.getNumElements();
673   if (Elements == 1 && !OrigM.getElement(0))
674     Elements = 0;
675   M.reserve(Elements + 1);
676   for (unsigned i = 0; i != Elements; ++i)
677     M.push_back(OrigM.getElement(i));
678   M.push_back(D);
679   setTypeArray(DIArray(MDNode::get(DbgNode->getContext(), M)));
682 /// Generate a reference to this DIType. Uses the type identifier instead
683 /// of the actual MDNode if possible, to help type uniquing.
684 DIScopeRef DIScope::getRef() const {
685   if (!isCompositeType())
686     return DIScopeRef(*this);
687   DICompositeType DTy(DbgNode);
688   if (!DTy.getIdentifier())
689     return DIScopeRef(*this);
690   return DIScopeRef(DTy.getIdentifier());
693 /// \brief Set the containing type.
694 void DICompositeType::setContainingType(DICompositeType ContainingType) {
695   TrackingVH<MDNode> N(*this);
696   N->replaceOperandWith(12, ContainingType.getRef());
697   DbgNode = N;
700 /// isInlinedFnArgument - Return true if this variable provides debugging
701 /// information for an inlined function arguments.
702 bool DIVariable::isInlinedFnArgument(const Function *CurFn) {
703   assert(CurFn && "Invalid function");
704   if (!getContext().isSubprogram())
705     return false;
706   // This variable is not inlined function argument if its scope
707   // does not describe current function.
708   return !DISubprogram(getContext()).describes(CurFn);
711 /// describes - Return true if this subprogram provides debugging
712 /// information for the function F.
713 bool DISubprogram::describes(const Function *F) {
714   assert(F && "Invalid function");
715   if (F == getFunction())
716     return true;
717   StringRef Name = getLinkageName();
718   if (Name.empty())
719     Name = getName();
720   if (F->getName() == Name)
721     return true;
722   return false;
725 unsigned DISubprogram::isOptimized() const {
726   assert(DbgNode && "Invalid subprogram descriptor!");
727   if (DbgNode->getNumOperands() == 15)
728     return getUnsignedField(14);
729   return 0;
732 MDNode *DISubprogram::getVariablesNodes() const {
733   return getNodeField(DbgNode, 18);
736 DIArray DISubprogram::getVariables() const {
737   return DIArray(getNodeField(DbgNode, 18));
740 Value *DITemplateValueParameter::getValue() const {
741   return getField(DbgNode, 4);
744 // If the current node has a parent scope then return that,
745 // else return an empty scope.
746 DIScopeRef DIScope::getContext() const {
748   if (isType())
749     return DIType(DbgNode).getContext();
751   if (isSubprogram())
752     return DIScopeRef(DISubprogram(DbgNode).getContext());
754   if (isLexicalBlock())
755     return DIScopeRef(DILexicalBlock(DbgNode).getContext());
757   if (isLexicalBlockFile())
758     return DIScopeRef(DILexicalBlockFile(DbgNode).getContext());
760   if (isNameSpace())
761     return DIScopeRef(DINameSpace(DbgNode).getContext());
763   assert((isFile() || isCompileUnit()) && "Unhandled type of scope.");
764   return DIScopeRef(NULL);
767 // If the scope node has a name, return that, else return an empty string.
768 StringRef DIScope::getName() const {
769   if (isType())
770     return DIType(DbgNode).getName();
771   if (isSubprogram())
772     return DISubprogram(DbgNode).getName();
773   if (isNameSpace())
774     return DINameSpace(DbgNode).getName();
775   assert((isLexicalBlock() || isLexicalBlockFile() || isFile() ||
776           isCompileUnit()) &&
777          "Unhandled type of scope.");
778   return StringRef();
781 StringRef DIScope::getFilename() const {
782   if (!DbgNode)
783     return StringRef();
784   return ::getStringField(getNodeField(DbgNode, 1), 0);
787 StringRef DIScope::getDirectory() const {
788   if (!DbgNode)
789     return StringRef();
790   return ::getStringField(getNodeField(DbgNode, 1), 1);
793 DIArray DICompileUnit::getEnumTypes() const {
794   if (!DbgNode || DbgNode->getNumOperands() < 13)
795     return DIArray();
797   return DIArray(getNodeField(DbgNode, 7));
800 DIArray DICompileUnit::getRetainedTypes() const {
801   if (!DbgNode || DbgNode->getNumOperands() < 13)
802     return DIArray();
804   return DIArray(getNodeField(DbgNode, 8));
807 DIArray DICompileUnit::getSubprograms() const {
808   if (!DbgNode || DbgNode->getNumOperands() < 13)
809     return DIArray();
811   return DIArray(getNodeField(DbgNode, 9));
814 DIArray DICompileUnit::getGlobalVariables() const {
815   if (!DbgNode || DbgNode->getNumOperands() < 13)
816     return DIArray();
818   return DIArray(getNodeField(DbgNode, 10));
821 DIArray DICompileUnit::getImportedEntities() const {
822   if (!DbgNode || DbgNode->getNumOperands() < 13)
823     return DIArray();
825   return DIArray(getNodeField(DbgNode, 11));
828 /// fixupSubprogramName - Replace contains special characters used
829 /// in a typical Objective-C names with '.' in a given string.
830 static void fixupSubprogramName(DISubprogram Fn, SmallVectorImpl<char> &Out) {
831   StringRef FName =
832       Fn.getFunction() ? Fn.getFunction()->getName() : Fn.getName();
833   FName = Function::getRealLinkageName(FName);
835   StringRef Prefix("llvm.dbg.lv.");
836   Out.reserve(FName.size() + Prefix.size());
837   Out.append(Prefix.begin(), Prefix.end());
839   bool isObjCLike = false;
840   for (size_t i = 0, e = FName.size(); i < e; ++i) {
841     char C = FName[i];
842     if (C == '[')
843       isObjCLike = true;
845     if (isObjCLike && (C == '[' || C == ']' || C == ' ' || C == ':' ||
846                        C == '+' || C == '(' || C == ')'))
847       Out.push_back('.');
848     else
849       Out.push_back(C);
850   }
853 /// getFnSpecificMDNode - Return a NameMDNode, if available, that is
854 /// suitable to hold function specific information.
855 NamedMDNode *llvm::getFnSpecificMDNode(const Module &M, DISubprogram Fn) {
856   SmallString<32> Name;
857   fixupSubprogramName(Fn, Name);
858   return M.getNamedMetadata(Name.str());
861 /// getOrInsertFnSpecificMDNode - Return a NameMDNode that is suitable
862 /// to hold function specific information.
863 NamedMDNode *llvm::getOrInsertFnSpecificMDNode(Module &M, DISubprogram Fn) {
864   SmallString<32> Name;
865   fixupSubprogramName(Fn, Name);
866   return M.getOrInsertNamedMetadata(Name.str());
869 /// createInlinedVariable - Create a new inlined variable based on current
870 /// variable.
871 /// @param DV            Current Variable.
872 /// @param InlinedScope  Location at current variable is inlined.
873 DIVariable llvm::createInlinedVariable(MDNode *DV, MDNode *InlinedScope,
874                                        LLVMContext &VMContext) {
875   SmallVector<Value *, 16> Elts;
876   // Insert inlined scope as 7th element.
877   for (unsigned i = 0, e = DV->getNumOperands(); i != e; ++i)
878     i == 7 ? Elts.push_back(InlinedScope) : Elts.push_back(DV->getOperand(i));
879   return DIVariable(MDNode::get(VMContext, Elts));
882 /// cleanseInlinedVariable - Remove inlined scope from the variable.
883 DIVariable llvm::cleanseInlinedVariable(MDNode *DV, LLVMContext &VMContext) {
884   SmallVector<Value *, 16> Elts;
885   // Insert inlined scope as 7th element.
886   for (unsigned i = 0, e = DV->getNumOperands(); i != e; ++i)
887     i == 7 ? Elts.push_back(Constant::getNullValue(Type::getInt32Ty(VMContext)))
888            : Elts.push_back(DV->getOperand(i));
889   return DIVariable(MDNode::get(VMContext, Elts));
892 /// getDISubprogram - Find subprogram that is enclosing this scope.
893 DISubprogram llvm::getDISubprogram(const MDNode *Scope) {
894   DIDescriptor D(Scope);
895   if (D.isSubprogram())
896     return DISubprogram(Scope);
898   if (D.isLexicalBlockFile())
899     return getDISubprogram(DILexicalBlockFile(Scope).getContext());
901   if (D.isLexicalBlock())
902     return getDISubprogram(DILexicalBlock(Scope).getContext());
904   return DISubprogram();
907 /// getDICompositeType - Find underlying composite type.
908 DICompositeType llvm::getDICompositeType(DIType T) {
909   if (T.isCompositeType())
910     return DICompositeType(T);
912   if (T.isDerivedType()) {
913     // This function is currently used by dragonegg and dragonegg does
914     // not generate identifier for types, so using an empty map to resolve
915     // DerivedFrom should be fine.
916     DITypeIdentifierMap EmptyMap;
917     return getDICompositeType(
918         DIDerivedType(T).getTypeDerivedFrom().resolve(EmptyMap));
919   }
921   return DICompositeType();
924 /// Update DITypeIdentifierMap by going through retained types of each CU.
925 DITypeIdentifierMap
926 llvm::generateDITypeIdentifierMap(const NamedMDNode *CU_Nodes) {
927   DITypeIdentifierMap Map;
928   for (unsigned CUi = 0, CUe = CU_Nodes->getNumOperands(); CUi != CUe; ++CUi) {
929     DICompileUnit CU(CU_Nodes->getOperand(CUi));
930     DIArray Retain = CU.getRetainedTypes();
931     for (unsigned Ti = 0, Te = Retain.getNumElements(); Ti != Te; ++Ti) {
932       if (!Retain.getElement(Ti).isCompositeType())
933         continue;
934       DICompositeType Ty(Retain.getElement(Ti));
935       if (MDString *TypeId = Ty.getIdentifier()) {
936         // Definition has priority over declaration.
937         // Try to insert (TypeId, Ty) to Map.
938         std::pair<DITypeIdentifierMap::iterator, bool> P =
939             Map.insert(std::make_pair(TypeId, Ty));
940         // If TypeId already exists in Map and this is a definition, replace
941         // whatever we had (declaration or definition) with the definition.
942         if (!P.second && !Ty.isForwardDecl())
943           P.first->second = Ty;
944       }
945     }
946   }
947   return Map;
950 //===----------------------------------------------------------------------===//
951 // DebugInfoFinder implementations.
952 //===----------------------------------------------------------------------===//
954 void DebugInfoFinder::reset() {
955   CUs.clear();
956   SPs.clear();
957   GVs.clear();
958   TYs.clear();
959   Scopes.clear();
960   NodesSeen.clear();
961   TypeIdentifierMap.clear();
962   TypeMapInitialized = false;
965 void DebugInfoFinder::InitializeTypeMap(const Module &M) {
966   if (!TypeMapInitialized)
967     if (NamedMDNode *CU_Nodes = M.getNamedMetadata("llvm.dbg.cu")) {
968       TypeIdentifierMap = generateDITypeIdentifierMap(CU_Nodes);
969       TypeMapInitialized = true;
970     }
973 /// processModule - Process entire module and collect debug info.
974 void DebugInfoFinder::processModule(const Module &M) {
975   InitializeTypeMap(M);
976   if (NamedMDNode *CU_Nodes = M.getNamedMetadata("llvm.dbg.cu")) {
977     for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
978       DICompileUnit CU(CU_Nodes->getOperand(i));
979       addCompileUnit(CU);
980       DIArray GVs = CU.getGlobalVariables();
981       for (unsigned i = 0, e = GVs.getNumElements(); i != e; ++i) {
982         DIGlobalVariable DIG(GVs.getElement(i));
983         if (addGlobalVariable(DIG)) {
984           processScope(DIG.getContext());
985           processType(DIG.getType());
986         }
987       }
988       DIArray SPs = CU.getSubprograms();
989       for (unsigned i = 0, e = SPs.getNumElements(); i != e; ++i)
990         processSubprogram(DISubprogram(SPs.getElement(i)));
991       DIArray EnumTypes = CU.getEnumTypes();
992       for (unsigned i = 0, e = EnumTypes.getNumElements(); i != e; ++i)
993         processType(DIType(EnumTypes.getElement(i)));
994       DIArray RetainedTypes = CU.getRetainedTypes();
995       for (unsigned i = 0, e = RetainedTypes.getNumElements(); i != e; ++i)
996         processType(DIType(RetainedTypes.getElement(i)));
997       DIArray Imports = CU.getImportedEntities();
998       for (unsigned i = 0, e = Imports.getNumElements(); i != e; ++i) {
999         DIImportedEntity Import = DIImportedEntity(Imports.getElement(i));
1000         DIDescriptor Entity = Import.getEntity();
1001         if (Entity.isType())
1002           processType(DIType(Entity));
1003         else if (Entity.isSubprogram())
1004           processSubprogram(DISubprogram(Entity));
1005         else if (Entity.isNameSpace())
1006           processScope(DINameSpace(Entity).getContext());
1007       }
1008     }
1009   }
1012 /// processLocation - Process DILocation.
1013 void DebugInfoFinder::processLocation(const Module &M, DILocation Loc) {
1014   if (!Loc)
1015     return;
1016   InitializeTypeMap(M);
1017   processScope(Loc.getScope());
1018   processLocation(M, Loc.getOrigLocation());
1021 /// processType - Process DIType.
1022 void DebugInfoFinder::processType(DIType DT) {
1023   if (!addType(DT))
1024     return;
1025   processScope(DT.getContext().resolve(TypeIdentifierMap));
1026   if (DT.isCompositeType()) {
1027     DICompositeType DCT(DT);
1028     processType(DCT.getTypeDerivedFrom().resolve(TypeIdentifierMap));
1029     DIArray DA = DCT.getTypeArray();
1030     for (unsigned i = 0, e = DA.getNumElements(); i != e; ++i) {
1031       DIDescriptor D = DA.getElement(i);
1032       if (D.isType())
1033         processType(DIType(D));
1034       else if (D.isSubprogram())
1035         processSubprogram(DISubprogram(D));
1036     }
1037   } else if (DT.isDerivedType()) {
1038     DIDerivedType DDT(DT);
1039     processType(DDT.getTypeDerivedFrom().resolve(TypeIdentifierMap));
1040   }
1043 void DebugInfoFinder::processScope(DIScope Scope) {
1044   if (Scope.isType()) {
1045     DIType Ty(Scope);
1046     processType(Ty);
1047     return;
1048   }
1049   if (Scope.isCompileUnit()) {
1050     addCompileUnit(DICompileUnit(Scope));
1051     return;
1052   }
1053   if (Scope.isSubprogram()) {
1054     processSubprogram(DISubprogram(Scope));
1055     return;
1056   }
1057   if (!addScope(Scope))
1058     return;
1059   if (Scope.isLexicalBlock()) {
1060     DILexicalBlock LB(Scope);
1061     processScope(LB.getContext());
1062   } else if (Scope.isLexicalBlockFile()) {
1063     DILexicalBlockFile LBF = DILexicalBlockFile(Scope);
1064     processScope(LBF.getScope());
1065   } else if (Scope.isNameSpace()) {
1066     DINameSpace NS(Scope);
1067     processScope(NS.getContext());
1068   }
1071 /// processLexicalBlock
1072 void DebugInfoFinder::processLexicalBlock(DILexicalBlock LB) {
1073   DIScope Context = LB.getContext();
1074   if (Context.isLexicalBlock())
1075     return processLexicalBlock(DILexicalBlock(Context));
1076   else if (Context.isLexicalBlockFile()) {
1077     DILexicalBlockFile DBF = DILexicalBlockFile(Context);
1078     return processLexicalBlock(DILexicalBlock(DBF.getScope()));
1079   } else
1080     return processSubprogram(DISubprogram(Context));
1083 /// processSubprogram - Process DISubprogram.
1084 void DebugInfoFinder::processSubprogram(DISubprogram SP) {
1085   if (!addSubprogram(SP))
1086     return;
1087   processScope(SP.getContext().resolve(TypeIdentifierMap));
1088   processType(SP.getType());
1089   DIArray TParams = SP.getTemplateParams();
1090   for (unsigned I = 0, E = TParams.getNumElements(); I != E; ++I) {
1091     DIDescriptor Element = TParams.getElement(I);
1092     if (Element.isTemplateTypeParameter()) {
1093       DITemplateTypeParameter TType(Element);
1094       processScope(TType.getContext().resolve(TypeIdentifierMap));
1095       processType(TType.getType().resolve(TypeIdentifierMap));
1096     } else if (Element.isTemplateValueParameter()) {
1097       DITemplateValueParameter TVal(Element);
1098       processScope(TVal.getContext().resolve(TypeIdentifierMap));
1099       processType(TVal.getType().resolve(TypeIdentifierMap));
1100     }
1101   }
1104 /// processDeclare - Process DbgDeclareInst.
1105 void DebugInfoFinder::processDeclare(const Module &M,
1106                                      const DbgDeclareInst *DDI) {
1107   MDNode *N = dyn_cast<MDNode>(DDI->getVariable());
1108   if (!N)
1109     return;
1110   InitializeTypeMap(M);
1112   DIDescriptor DV(N);
1113   if (!DV.isVariable())
1114     return;
1116   if (!NodesSeen.insert(DV))
1117     return;
1118   processScope(DIVariable(N).getContext());
1119   processType(DIVariable(N).getType());
1122 void DebugInfoFinder::processValue(const Module &M, const DbgValueInst *DVI) {
1123   MDNode *N = dyn_cast<MDNode>(DVI->getVariable());
1124   if (!N)
1125     return;
1126   InitializeTypeMap(M);
1128   DIDescriptor DV(N);
1129   if (!DV.isVariable())
1130     return;
1132   if (!NodesSeen.insert(DV))
1133     return;
1134   processScope(DIVariable(N).getContext());
1135   processType(DIVariable(N).getType());
1138 /// addType - Add type into Tys.
1139 bool DebugInfoFinder::addType(DIType DT) {
1140   if (!DT)
1141     return false;
1143   if (!NodesSeen.insert(DT))
1144     return false;
1146   TYs.push_back(DT);
1147   return true;
1150 /// addCompileUnit - Add compile unit into CUs.
1151 bool DebugInfoFinder::addCompileUnit(DICompileUnit CU) {
1152   if (!CU)
1153     return false;
1154   if (!NodesSeen.insert(CU))
1155     return false;
1157   CUs.push_back(CU);
1158   return true;
1161 /// addGlobalVariable - Add global variable into GVs.
1162 bool DebugInfoFinder::addGlobalVariable(DIGlobalVariable DIG) {
1163   if (!DIG)
1164     return false;
1166   if (!NodesSeen.insert(DIG))
1167     return false;
1169   GVs.push_back(DIG);
1170   return true;
1173 // addSubprogram - Add subprgoram into SPs.
1174 bool DebugInfoFinder::addSubprogram(DISubprogram SP) {
1175   if (!SP)
1176     return false;
1178   if (!NodesSeen.insert(SP))
1179     return false;
1181   SPs.push_back(SP);
1182   return true;
1185 bool DebugInfoFinder::addScope(DIScope Scope) {
1186   if (!Scope)
1187     return false;
1188   // FIXME: Ocaml binding generates a scope with no content, we treat it
1189   // as null for now.
1190   if (Scope->getNumOperands() == 0)
1191     return false;
1192   if (!NodesSeen.insert(Scope))
1193     return false;
1194   Scopes.push_back(Scope);
1195   return true;
1198 //===----------------------------------------------------------------------===//
1199 // DIDescriptor: dump routines for all descriptors.
1200 //===----------------------------------------------------------------------===//
1202 /// dump - Print descriptor to dbgs() with a newline.
1203 void DIDescriptor::dump() const {
1204   print(dbgs());
1205   dbgs() << '\n';
1208 /// print - Print descriptor.
1209 void DIDescriptor::print(raw_ostream &OS) const {
1210   if (!DbgNode)
1211     return;
1213   if (const char *Tag = dwarf::TagString(getTag()))
1214     OS << "[ " << Tag << " ]";
1216   if (this->isSubrange()) {
1217     DISubrange(DbgNode).printInternal(OS);
1218   } else if (this->isCompileUnit()) {
1219     DICompileUnit(DbgNode).printInternal(OS);
1220   } else if (this->isFile()) {
1221     DIFile(DbgNode).printInternal(OS);
1222   } else if (this->isEnumerator()) {
1223     DIEnumerator(DbgNode).printInternal(OS);
1224   } else if (this->isBasicType()) {
1225     DIType(DbgNode).printInternal(OS);
1226   } else if (this->isDerivedType()) {
1227     DIDerivedType(DbgNode).printInternal(OS);
1228   } else if (this->isCompositeType()) {
1229     DICompositeType(DbgNode).printInternal(OS);
1230   } else if (this->isSubprogram()) {
1231     DISubprogram(DbgNode).printInternal(OS);
1232   } else if (this->isGlobalVariable()) {
1233     DIGlobalVariable(DbgNode).printInternal(OS);
1234   } else if (this->isVariable()) {
1235     DIVariable(DbgNode).printInternal(OS);
1236   } else if (this->isObjCProperty()) {
1237     DIObjCProperty(DbgNode).printInternal(OS);
1238   } else if (this->isNameSpace()) {
1239     DINameSpace(DbgNode).printInternal(OS);
1240   } else if (this->isScope()) {
1241     DIScope(DbgNode).printInternal(OS);
1242   }
1245 void DISubrange::printInternal(raw_ostream &OS) const {
1246   int64_t Count = getCount();
1247   if (Count != -1)
1248     OS << " [" << getLo() << ", " << Count - 1 << ']';
1249   else
1250     OS << " [unbounded]";
1253 void DIScope::printInternal(raw_ostream &OS) const {
1254   OS << " [" << getDirectory() << "/" << getFilename() << ']';
1257 void DICompileUnit::printInternal(raw_ostream &OS) const {
1258   DIScope::printInternal(OS);
1259   OS << " [";
1260   unsigned Lang = getLanguage();
1261   if (const char *LangStr = dwarf::LanguageString(Lang))
1262     OS << LangStr;
1263   else
1264     (OS << "lang 0x").write_hex(Lang);
1265   OS << ']';
1268 void DIEnumerator::printInternal(raw_ostream &OS) const {
1269   OS << " [" << getName() << " :: " << getEnumValue() << ']';
1272 void DIType::printInternal(raw_ostream &OS) const {
1273   if (!DbgNode)
1274     return;
1276   StringRef Res = getName();
1277   if (!Res.empty())
1278     OS << " [" << Res << "]";
1280   // TODO: Print context?
1282   OS << " [line " << getLineNumber() << ", size " << getSizeInBits()
1283      << ", align " << getAlignInBits() << ", offset " << getOffsetInBits();
1284   if (isBasicType())
1285     if (const char *Enc =
1286             dwarf::AttributeEncodingString(DIBasicType(DbgNode).getEncoding()))
1287       OS << ", enc " << Enc;
1288   OS << "]";
1290   if (isPrivate())
1291     OS << " [private]";
1292   else if (isProtected())
1293     OS << " [protected]";
1295   if (isArtificial())
1296     OS << " [artificial]";
1298   if (isForwardDecl())
1299     OS << " [decl]";
1300   else if (getTag() == dwarf::DW_TAG_structure_type ||
1301            getTag() == dwarf::DW_TAG_union_type ||
1302            getTag() == dwarf::DW_TAG_enumeration_type ||
1303            getTag() == dwarf::DW_TAG_class_type)
1304     OS << " [def]";
1305   if (isVector())
1306     OS << " [vector]";
1307   if (isStaticMember())
1308     OS << " [static]";
1310   if (isLValueReference())
1311     OS << " [reference]";
1313   if (isRValueReference())
1314     OS << " [rvalue reference]";
1317 void DIDerivedType::printInternal(raw_ostream &OS) const {
1318   DIType::printInternal(OS);
1319   OS << " [from " << getTypeDerivedFrom().getName() << ']';
1322 void DICompositeType::printInternal(raw_ostream &OS) const {
1323   DIType::printInternal(OS);
1324   DIArray A = getTypeArray();
1325   OS << " [" << A.getNumElements() << " elements]";
1328 void DINameSpace::printInternal(raw_ostream &OS) const {
1329   StringRef Name = getName();
1330   if (!Name.empty())
1331     OS << " [" << Name << ']';
1333   OS << " [line " << getLineNumber() << ']';
1336 void DISubprogram::printInternal(raw_ostream &OS) const {
1337   // TODO : Print context
1338   OS << " [line " << getLineNumber() << ']';
1340   if (isLocalToUnit())
1341     OS << " [local]";
1343   if (isDefinition())
1344     OS << " [def]";
1346   if (getScopeLineNumber() != getLineNumber())
1347     OS << " [scope " << getScopeLineNumber() << "]";
1349   if (isPrivate())
1350     OS << " [private]";
1351   else if (isProtected())
1352     OS << " [protected]";
1354   if (isLValueReference())
1355     OS << " [reference]";
1357   if (isRValueReference())
1358     OS << " [rvalue reference]";
1360   StringRef Res = getName();
1361   if (!Res.empty())
1362     OS << " [" << Res << ']';
1365 void DIGlobalVariable::printInternal(raw_ostream &OS) const {
1366   StringRef Res = getName();
1367   if (!Res.empty())
1368     OS << " [" << Res << ']';
1370   OS << " [line " << getLineNumber() << ']';
1372   // TODO : Print context
1374   if (isLocalToUnit())
1375     OS << " [local]";
1377   if (isDefinition())
1378     OS << " [def]";
1381 void DIVariable::printInternal(raw_ostream &OS) const {
1382   StringRef Res = getName();
1383   if (!Res.empty())
1384     OS << " [" << Res << ']';
1386   OS << " [line " << getLineNumber() << ']';
1389 void DIObjCProperty::printInternal(raw_ostream &OS) const {
1390   StringRef Name = getObjCPropertyName();
1391   if (!Name.empty())
1392     OS << " [" << Name << ']';
1394   OS << " [line " << getLineNumber() << ", properties " << getUnsignedField(6)
1395      << ']';
1398 static void printDebugLoc(DebugLoc DL, raw_ostream &CommentOS,
1399                           const LLVMContext &Ctx) {
1400   if (!DL.isUnknown()) { // Print source line info.
1401     DIScope Scope(DL.getScope(Ctx));
1402     assert(Scope.isScope() && "Scope of a DebugLoc should be a DIScope.");
1403     // Omit the directory, because it's likely to be long and uninteresting.
1404     CommentOS << Scope.getFilename();
1405     CommentOS << ':' << DL.getLine();
1406     if (DL.getCol() != 0)
1407       CommentOS << ':' << DL.getCol();
1408     DebugLoc InlinedAtDL = DebugLoc::getFromDILocation(DL.getInlinedAt(Ctx));
1409     if (!InlinedAtDL.isUnknown()) {
1410       CommentOS << " @[ ";
1411       printDebugLoc(InlinedAtDL, CommentOS, Ctx);
1412       CommentOS << " ]";
1413     }
1414   }
1417 void DIVariable::printExtendedName(raw_ostream &OS) const {
1418   const LLVMContext &Ctx = DbgNode->getContext();
1419   StringRef Res = getName();
1420   if (!Res.empty())
1421     OS << Res << "," << getLineNumber();
1422   if (MDNode *InlinedAt = getInlinedAt()) {
1423     DebugLoc InlinedAtDL = DebugLoc::getFromDILocation(InlinedAt);
1424     if (!InlinedAtDL.isUnknown()) {
1425       OS << " @[";
1426       printDebugLoc(InlinedAtDL, OS, Ctx);
1427       OS << "]";
1428     }
1429   }
1432 /// Specialize constructor to make sure it has the correct type.
1433 template <> DIRef<DIScope>::DIRef(const Value *V) : Val(V) {
1434   assert(isScopeRef(V) && "DIScopeRef should be a MDString or MDNode");
1436 template <> DIRef<DIType>::DIRef(const Value *V) : Val(V) {
1437   assert(isTypeRef(V) && "DITypeRef should be a MDString or MDNode");
1440 /// Specialize getFieldAs to handle fields that are references to DIScopes.
1441 template <>
1442 DIScopeRef DIDescriptor::getFieldAs<DIScopeRef>(unsigned Elt) const {
1443   return DIScopeRef(getField(DbgNode, Elt));
1445 /// Specialize getFieldAs to handle fields that are references to DITypes.
1446 template <> DITypeRef DIDescriptor::getFieldAs<DITypeRef>(unsigned Elt) const {
1447   return DITypeRef(getField(DbgNode, Elt));
1450 /// Strip debug info in the module if it exists.
1451 /// To do this, we remove all calls to the debugger intrinsics and any named
1452 /// metadata for debugging. We also remove debug locations for instructions.
1453 /// Return true if module is modified.
1454 bool llvm::StripDebugInfo(Module &M) {
1456   bool Changed = false;
1458   // Remove all of the calls to the debugger intrinsics, and remove them from
1459   // the module.
1460   if (Function *Declare = M.getFunction("llvm.dbg.declare")) {
1461     while (!Declare->use_empty()) {
1462       CallInst *CI = cast<CallInst>(Declare->use_back());
1463       CI->eraseFromParent();
1464     }
1465     Declare->eraseFromParent();
1466     Changed = true;
1467   }
1469   if (Function *DbgVal = M.getFunction("llvm.dbg.value")) {
1470     while (!DbgVal->use_empty()) {
1471       CallInst *CI = cast<CallInst>(DbgVal->use_back());
1472       CI->eraseFromParent();
1473     }
1474     DbgVal->eraseFromParent();
1475     Changed = true;
1476   }
1478   for (Module::named_metadata_iterator NMI = M.named_metadata_begin(),
1479          NME = M.named_metadata_end(); NMI != NME;) {
1480     NamedMDNode *NMD = NMI;
1481     ++NMI;
1482     if (NMD->getName().startswith("llvm.dbg.")) {
1483       NMD->eraseFromParent();
1484       Changed = true;
1485     }
1486   }
1488   for (Module::iterator MI = M.begin(), ME = M.end(); MI != ME; ++MI)
1489     for (Function::iterator FI = MI->begin(), FE = MI->end(); FI != FE;
1490          ++FI)
1491       for (BasicBlock::iterator BI = FI->begin(), BE = FI->end(); BI != BE;
1492            ++BI) {
1493         if (!BI->getDebugLoc().isUnknown()) {
1494           Changed = true;
1495           BI->setDebugLoc(DebugLoc());
1496         }
1497       }
1499   return Changed;
1502 /// Return Debug Info Metadata Version by checking module flags.
1503 unsigned llvm::getDebugMetadataVersionFromModule(const Module &M) {
1504   Value *Val = M.getModuleFlag("Debug Info Version");
1505   if (!Val)
1506     return 0;
1507   return cast<ConstantInt>(Val)->getZExtValue();