Debug Info: improve the verifier to check field types.
[oota-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 //===----------------------------------------------------------------------===//
14
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;
32
33 //===----------------------------------------------------------------------===//
34 // DIDescriptor
35 //===----------------------------------------------------------------------===//
36
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 }
52
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 }
58
59 static MDNode *getNodeField(const MDNode *DbgNode, unsigned Elt) {
60   return dyn_cast_or_null<MDNode>(getField(DbgNode, Elt));
61 }
62
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 }
68
69 StringRef DIDescriptor::getStringField(unsigned Elt) const {
70   return ::getStringField(DbgNode, Elt);
71 }
72
73 uint64_t DIDescriptor::getUInt64Field(unsigned Elt) const {
74   if (DbgNode == 0)
75     return 0;
76
77   if (Elt < DbgNode->getNumOperands())
78     if (ConstantInt *CI
79         = dyn_cast_or_null<ConstantInt>(DbgNode->getOperand(Elt)))
80       return CI->getZExtValue();
81
82   return 0;
83 }
84
85 int64_t DIDescriptor::getInt64Field(unsigned Elt) const {
86   if (DbgNode == 0)
87     return 0;
88
89   if (Elt < DbgNode->getNumOperands())
90     if (ConstantInt *CI
91         = dyn_cast_or_null<ConstantInt>(DbgNode->getOperand(Elt)))
92       return CI->getSExtValue();
93
94   return 0;
95 }
96
97 DIDescriptor DIDescriptor::getDescriptorField(unsigned Elt) const {
98   MDNode *Field = getNodeField(DbgNode, Elt);
99   return DIDescriptor(Field);
100 }
101
102 GlobalVariable *DIDescriptor::getGlobalVariableField(unsigned Elt) const {
103   if (DbgNode == 0)
104     return 0;
105
106   if (Elt < DbgNode->getNumOperands())
107       return dyn_cast_or_null<GlobalVariable>(DbgNode->getOperand(Elt));
108   return 0;
109 }
110
111 Constant *DIDescriptor::getConstantField(unsigned Elt) const {
112   if (DbgNode == 0)
113     return 0;
114
115   if (Elt < DbgNode->getNumOperands())
116       return dyn_cast_or_null<Constant>(DbgNode->getOperand(Elt));
117   return 0;
118 }
119
120 Function *DIDescriptor::getFunctionField(unsigned Elt) const {
121   if (DbgNode == 0)
122     return 0;
123
124   if (Elt < DbgNode->getNumOperands())
125       return dyn_cast_or_null<Function>(DbgNode->getOperand(Elt));
126   return 0;
127 }
128
129 void DIDescriptor::replaceFunctionField(unsigned Elt, Function *F) {
130   if (DbgNode == 0)
131     return;
132
133   if (Elt < DbgNode->getNumOperands()) {
134     MDNode *Node = const_cast<MDNode*>(DbgNode);
135     Node->replaceOperandWith(Elt, F);
136   }
137 }
138
139 unsigned DIVariable::getNumAddrElements() const {
140   return DbgNode->getNumOperands()-8;
141 }
142
143 /// getInlinedAt - If this variable is inlined then return inline location.
144 MDNode *DIVariable::getInlinedAt() const {
145   return getNodeField(DbgNode, 7);
146 }
147
148 //===----------------------------------------------------------------------===//
149 // Predicates
150 //===----------------------------------------------------------------------===//
151
152 /// isBasicType - Return true if the specified tag is legal for
153 /// DIBasicType.
154 bool DIDescriptor::isBasicType() const {
155   if (!DbgNode) return false;
156   switch (getTag()) {
157   case dwarf::DW_TAG_base_type:
158   case dwarf::DW_TAG_unspecified_type:
159     return true;
160   default:
161     return false;
162   }
163 }
164
165 /// isDerivedType - Return true if the specified tag is legal for DIDerivedType.
166 bool DIDescriptor::isDerivedType() const {
167   if (!DbgNode) 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   }
185 }
186
187 /// isCompositeType - Return true if the specified tag is legal for
188 /// DICompositeType.
189 bool DIDescriptor::isCompositeType() const {
190   if (!DbgNode) return false;
191   switch (getTag()) {
192   case dwarf::DW_TAG_array_type:
193   case dwarf::DW_TAG_structure_type:
194   case dwarf::DW_TAG_union_type:
195   case dwarf::DW_TAG_enumeration_type:
196   case dwarf::DW_TAG_subroutine_type:
197   case dwarf::DW_TAG_class_type:
198     return true;
199   default:
200     return false;
201   }
202 }
203
204 /// isVariable - Return true if the specified tag is legal for DIVariable.
205 bool DIDescriptor::isVariable() const {
206   if (!DbgNode) return false;
207   switch (getTag()) {
208   case dwarf::DW_TAG_auto_variable:
209   case dwarf::DW_TAG_arg_variable:
210     return true;
211   default:
212     return false;
213   }
214 }
215
216 /// isType - Return true if the specified tag is legal for DIType.
217 bool DIDescriptor::isType() const {
218   return isBasicType() || isCompositeType() || isDerivedType();
219 }
220
221 /// isSubprogram - Return true if the specified tag is legal for
222 /// DISubprogram.
223 bool DIDescriptor::isSubprogram() const {
224   return DbgNode && getTag() == dwarf::DW_TAG_subprogram;
225 }
226
227 /// isGlobalVariable - Return true if the specified tag is legal for
228 /// DIGlobalVariable.
229 bool DIDescriptor::isGlobalVariable() const {
230   return DbgNode && (getTag() == dwarf::DW_TAG_variable ||
231                      getTag() == dwarf::DW_TAG_constant);
232 }
233
234 /// isUnspecifiedParmeter - Return true if the specified tag is
235 /// DW_TAG_unspecified_parameters.
236 bool DIDescriptor::isUnspecifiedParameter() const {
237   return DbgNode && getTag() == dwarf::DW_TAG_unspecified_parameters;
238 }
239
240 /// isScope - Return true if the specified tag is one of the scope
241 /// related tag.
242 bool DIDescriptor::isScope() const {
243   if (!DbgNode) return false;
244   switch (getTag()) {
245   case dwarf::DW_TAG_compile_unit:
246   case dwarf::DW_TAG_lexical_block:
247   case dwarf::DW_TAG_subprogram:
248   case dwarf::DW_TAG_namespace:
249     return true;
250   default:
251     break;
252   }
253   return false;
254 }
255
256 /// isTemplateTypeParameter - Return true if the specified tag is
257 /// DW_TAG_template_type_parameter.
258 bool DIDescriptor::isTemplateTypeParameter() const {
259   return DbgNode && getTag() == dwarf::DW_TAG_template_type_parameter;
260 }
261
262 /// isTemplateValueParameter - Return true if the specified tag is
263 /// DW_TAG_template_value_parameter.
264 bool DIDescriptor::isTemplateValueParameter() const {
265   return DbgNode && (getTag() == dwarf::DW_TAG_template_value_parameter ||
266                      getTag() == dwarf::DW_TAG_GNU_template_template_param ||
267                      getTag() == dwarf::DW_TAG_GNU_template_parameter_pack);
268 }
269
270 /// isCompileUnit - Return true if the specified tag is DW_TAG_compile_unit.
271 bool DIDescriptor::isCompileUnit() const {
272   return DbgNode && getTag() == dwarf::DW_TAG_compile_unit;
273 }
274
275 /// isFile - Return true if the specified tag is DW_TAG_file_type.
276 bool DIDescriptor::isFile() const {
277   return DbgNode && getTag() == dwarf::DW_TAG_file_type;
278 }
279
280 /// isNameSpace - Return true if the specified tag is DW_TAG_namespace.
281 bool DIDescriptor::isNameSpace() const {
282   return DbgNode && getTag() == dwarf::DW_TAG_namespace;
283 }
284
285 /// isLexicalBlockFile - Return true if the specified descriptor is a
286 /// lexical block with an extra file.
287 bool DIDescriptor::isLexicalBlockFile() const {
288   return DbgNode && getTag() == dwarf::DW_TAG_lexical_block &&
289     (DbgNode->getNumOperands() == 3);
290 }
291
292 /// isLexicalBlock - Return true if the specified tag is DW_TAG_lexical_block.
293 bool DIDescriptor::isLexicalBlock() const {
294   return DbgNode && getTag() == dwarf::DW_TAG_lexical_block &&
295     (DbgNode->getNumOperands() > 3);
296 }
297
298 /// isSubrange - Return true if the specified tag is DW_TAG_subrange_type.
299 bool DIDescriptor::isSubrange() const {
300   return DbgNode && getTag() == dwarf::DW_TAG_subrange_type;
301 }
302
303 /// isEnumerator - Return true if the specified tag is DW_TAG_enumerator.
304 bool DIDescriptor::isEnumerator() const {
305   return DbgNode && getTag() == dwarf::DW_TAG_enumerator;
306 }
307
308 /// isObjCProperty - Return true if the specified tag is DW_TAG_APPLE_property.
309 bool DIDescriptor::isObjCProperty() const {
310   return DbgNode && getTag() == dwarf::DW_TAG_APPLE_property;
311 }
312
313 /// \brief Return true if the specified tag is DW_TAG_imported_module or
314 /// DW_TAG_imported_declaration.
315 bool DIDescriptor::isImportedEntity() const {
316   return DbgNode && (getTag() == dwarf::DW_TAG_imported_module ||
317                      getTag() == dwarf::DW_TAG_imported_declaration);
318 }
319
320 //===----------------------------------------------------------------------===//
321 // Simple Descriptor Constructors and other Methods
322 //===----------------------------------------------------------------------===//
323
324 unsigned DIArray::getNumElements() const {
325   if (!DbgNode)
326     return 0;
327   return DbgNode->getNumOperands();
328 }
329
330 /// replaceAllUsesWith - Replace all uses of the MDNode used by this
331 /// type with the one in the passed descriptor.
332 void DIType::replaceAllUsesWith(DIDescriptor &D) {
333
334   assert(DbgNode && "Trying to replace an unverified type!");
335
336   // Since we use a TrackingVH for the node, its easy for clients to manufacture
337   // legitimate situations where they want to replaceAllUsesWith() on something
338   // which, due to uniquing, has merged with the source. We shield clients from
339   // this detail by allowing a value to be replaced with replaceAllUsesWith()
340   // itself.
341   if (DbgNode != D) {
342     MDNode *Node = const_cast<MDNode*>(DbgNode);
343     const MDNode *DN = D;
344     const Value *V = cast_or_null<Value>(DN);
345     Node->replaceAllUsesWith(const_cast<Value*>(V));
346     MDNode::deleteTemporary(Node);
347   }
348 }
349
350 /// replaceAllUsesWith - Replace all uses of the MDNode used by this
351 /// type with the one in D.
352 void DIType::replaceAllUsesWith(MDNode *D) {
353
354   assert(DbgNode && "Trying to replace an unverified type!");
355
356   // Since we use a TrackingVH for the node, its easy for clients to manufacture
357   // legitimate situations where they want to replaceAllUsesWith() on something
358   // which, due to uniquing, has merged with the source. We shield clients from
359   // this detail by allowing a value to be replaced with replaceAllUsesWith()
360   // itself.
361   if (DbgNode != D) {
362     MDNode *Node = const_cast<MDNode*>(DbgNode);
363     const MDNode *DN = D;
364     const Value *V = cast_or_null<Value>(DN);
365     Node->replaceAllUsesWith(const_cast<Value*>(V));
366     MDNode::deleteTemporary(Node);
367   }
368 }
369
370 /// isUnsignedDIType - Return true if type encoding is unsigned.
371 bool DIType::isUnsignedDIType() {
372   DIDerivedType DTy(DbgNode);
373   if (DTy.Verify())
374     return DTy.getTypeDerivedFrom().isUnsignedDIType();
375
376   DIBasicType BTy(DbgNode);
377   if (BTy.Verify()) {
378     unsigned Encoding = BTy.getEncoding();
379     if (Encoding == dwarf::DW_ATE_unsigned ||
380         Encoding == dwarf::DW_ATE_unsigned_char ||
381         Encoding == dwarf::DW_ATE_boolean)
382       return true;
383   }
384   return false;
385 }
386
387 /// Verify - Verify that a compile unit is well formed.
388 bool DICompileUnit::Verify() const {
389   if (!isCompileUnit())
390     return false;
391
392   // Don't bother verifying the compilation directory or producer string
393   // as those could be empty.
394   if (getFilename().empty())
395     return false;
396
397   return DbgNode->getNumOperands() == 13;
398 }
399
400 /// Verify - Verify that an ObjC property is well formed.
401 bool DIObjCProperty::Verify() const {
402   if (!isObjCProperty())
403     return false;
404
405   // Don't worry about the rest of the strings for now.
406   return DbgNode->getNumOperands() == 8;
407 }
408
409 /// We allow an empty string to represent null. But we don't allow
410 /// a non-empty string in a MDNode field.
411 static bool fieldIsMDNode(const MDNode *DbgNode, unsigned Elt) {
412   Value *Fld = getField(DbgNode, Elt);
413   if (Fld && isa<MDString>(Fld) &&
414       !cast<MDString>(Fld)->getString().empty())
415     return false;
416   return true;
417 }
418
419 /// Verify - Verify that a type descriptor is well formed.
420 bool DIType::Verify() const {
421   if (!isType())
422     return false;
423   // FIXME: Sink this into the various subclass verifies.
424   unsigned Tag = getTag();
425   if (!isBasicType() && Tag != dwarf::DW_TAG_const_type &&
426       Tag != dwarf::DW_TAG_volatile_type && Tag != dwarf::DW_TAG_pointer_type &&
427       Tag != dwarf::DW_TAG_ptr_to_member_type &&
428       Tag != dwarf::DW_TAG_reference_type &&
429       Tag != dwarf::DW_TAG_rvalue_reference_type &&
430       Tag != dwarf::DW_TAG_restrict_type && Tag != dwarf::DW_TAG_array_type &&
431       Tag != dwarf::DW_TAG_enumeration_type &&
432       Tag != dwarf::DW_TAG_subroutine_type &&
433       Tag != dwarf::DW_TAG_inheritance && Tag != dwarf::DW_TAG_friend &&
434       getFilename().empty())
435     return false;
436   // DIType is abstract, it should be a BasicType, a DerivedType or
437   // a CompositeType.
438   if (isBasicType())
439     DIBasicType(DbgNode).Verify();
440   else if (isCompositeType())
441     DICompositeType(DbgNode).Verify();
442   else if (isDerivedType())
443     DIDerivedType(DbgNode).Verify();
444   else
445     return false;
446   return true;
447 }
448
449 /// Verify - Verify that a basic type descriptor is well formed.
450 bool DIBasicType::Verify() const {
451   return isBasicType() && DbgNode->getNumOperands() == 10;
452 }
453
454 /// Verify - Verify that a derived type descriptor is well formed.
455 bool DIDerivedType::Verify() const {
456   // Make sure DerivedFrom @ field 9 is MDNode.
457   if (!fieldIsMDNode(DbgNode, 9))
458     return false;
459   if (getTag() == dwarf::DW_TAG_ptr_to_member_type)
460     // Make sure ClassType @ field 10 is MDNode.
461     if (!fieldIsMDNode(DbgNode, 10))
462       return false;
463
464   return isDerivedType() && DbgNode->getNumOperands() >= 10 &&
465          DbgNode->getNumOperands() <= 14;
466 }
467
468 /// Verify - Verify that a composite type descriptor is well formed.
469 bool DICompositeType::Verify() const {
470   if (!isCompositeType())
471     return false;
472
473   // Make sure DerivedFrom @ field 9 and ContainingType @ field 12 are MDNodes.
474   if (!fieldIsMDNode(DbgNode, 9))
475     return false;
476   if (!fieldIsMDNode(DbgNode, 12))
477     return false;
478
479   return DbgNode->getNumOperands() >= 10 && DbgNode->getNumOperands() <= 14;
480 }
481
482 /// Verify - Verify that a subprogram descriptor is well formed.
483 bool DISubprogram::Verify() const {
484   if (!isSubprogram())
485     return false;
486
487   // Make sure context @ field 2 and type @ field 7 are MDNodes.
488   if (!fieldIsMDNode(DbgNode, 2))
489     return false;
490   if (!fieldIsMDNode(DbgNode, 7))
491     return false;
492   // Containing type @ field 12.
493   if (!fieldIsMDNode(DbgNode, 12))
494     return false;
495   return DbgNode->getNumOperands() == 20;
496 }
497
498 /// Verify - Verify that a global variable descriptor is well formed.
499 bool DIGlobalVariable::Verify() const {
500   if (!isGlobalVariable())
501     return false;
502
503   if (getDisplayName().empty())
504     return false;
505   // Make sure context @ field 2 and type @ field 8 are MDNodes.
506   if (!fieldIsMDNode(DbgNode, 2))
507     return false;
508   if (!fieldIsMDNode(DbgNode, 8))
509     return false;
510   // Make sure StaticDataMemberDeclaration @ field 12 is MDNode.
511   if (!fieldIsMDNode(DbgNode, 12))
512     return false;
513
514   return DbgNode->getNumOperands() == 13;
515 }
516
517 /// Verify - Verify that a variable descriptor is well formed.
518 bool DIVariable::Verify() const {
519   if (!isVariable())
520     return false;
521
522   // Make sure context @ field 1 and type @ field 5 are MDNodes.
523   if (!fieldIsMDNode(DbgNode, 1))
524     return false;
525   if (!fieldIsMDNode(DbgNode, 5))
526     return false;
527   return DbgNode->getNumOperands() >= 8;
528 }
529
530 /// Verify - Verify that a location descriptor is well formed.
531 bool DILocation::Verify() const {
532   if (!DbgNode)
533     return false;
534
535   return DbgNode->getNumOperands() == 4;
536 }
537
538 /// Verify - Verify that a namespace descriptor is well formed.
539 bool DINameSpace::Verify() const {
540   if (!isNameSpace())
541     return false;
542   return DbgNode->getNumOperands() == 5;
543 }
544
545 /// \brief Retrieve the MDNode for the directory/file pair.
546 MDNode *DIFile::getFileNode() const {
547   return getNodeField(DbgNode, 1);
548 }
549
550 /// \brief Verify that the file descriptor is well formed.
551 bool DIFile::Verify() const {
552   return isFile() && DbgNode->getNumOperands() == 2;
553 }
554
555 /// \brief Verify that the enumerator descriptor is well formed.
556 bool DIEnumerator::Verify() const {
557   return isEnumerator() && DbgNode->getNumOperands() == 3;
558 }
559
560 /// \brief Verify that the subrange descriptor is well formed.
561 bool DISubrange::Verify() const {
562   return isSubrange() && DbgNode->getNumOperands() == 3;
563 }
564
565 /// \brief Verify that the lexical block descriptor is well formed.
566 bool DILexicalBlock::Verify() const {
567   return isLexicalBlock() && DbgNode->getNumOperands() == 6;
568 }
569
570 /// \brief Verify that the file-scoped lexical block descriptor is well formed.
571 bool DILexicalBlockFile::Verify() const {
572   return isLexicalBlockFile() && DbgNode->getNumOperands() == 3;
573 }
574
575 /// \brief Verify that the template type parameter descriptor is well formed.
576 bool DITemplateTypeParameter::Verify() const {
577   return isTemplateTypeParameter() && DbgNode->getNumOperands() == 7;
578 }
579
580 /// \brief Verify that the template value parameter descriptor is well formed.
581 bool DITemplateValueParameter::Verify() const {
582   return isTemplateValueParameter() && DbgNode->getNumOperands() == 8;
583 }
584
585 /// \brief Verify that the imported module descriptor is well formed.
586 bool DIImportedEntity::Verify() const {
587   return isImportedEntity() &&
588          (DbgNode->getNumOperands() == 4 || DbgNode->getNumOperands() == 5);
589 }
590
591 /// getOriginalTypeSize - If this type is derived from a base type then
592 /// return base type size.
593 uint64_t DIDerivedType::getOriginalTypeSize() const {
594   unsigned Tag = getTag();
595
596   if (Tag != dwarf::DW_TAG_member && Tag != dwarf::DW_TAG_typedef &&
597       Tag != dwarf::DW_TAG_const_type && Tag != dwarf::DW_TAG_volatile_type &&
598       Tag != dwarf::DW_TAG_restrict_type)
599     return getSizeInBits();
600
601   DIType BaseType = getTypeDerivedFrom();
602
603   // If this type is not derived from any type then take conservative approach.
604   if (!BaseType.isValid())
605     return getSizeInBits();
606
607   // If this is a derived type, go ahead and get the base type, unless it's a
608   // reference then it's just the size of the field. Pointer types have no need
609   // of this since they're a different type of qualification on the type.
610   if (BaseType.getTag() == dwarf::DW_TAG_reference_type ||
611       BaseType.getTag() == dwarf::DW_TAG_rvalue_reference_type)
612     return getSizeInBits();
613
614   if (BaseType.isDerivedType())
615     return DIDerivedType(BaseType).getOriginalTypeSize();
616
617   return BaseType.getSizeInBits();
618 }
619
620 /// getObjCProperty - Return property node, if this ivar is associated with one.
621 MDNode *DIDerivedType::getObjCProperty() const {
622   return getNodeField(DbgNode, 10);
623 }
624
625 /// \brief Set the array of member DITypes.
626 void DICompositeType::setTypeArray(DIArray Elements, DIArray TParams) {
627   assert((!TParams || DbgNode->getNumOperands() == 14) &&
628          "If you're setting the template parameters this should include a slot "
629          "for that!");
630   TrackingVH<MDNode> N(*this);
631   N->replaceOperandWith(10, Elements);
632   if (TParams)
633     N->replaceOperandWith(13, TParams);
634   DbgNode = N;
635 }
636
637 /// \brief Set the containing type.
638 void DICompositeType::setContainingType(DICompositeType ContainingType) {
639   TrackingVH<MDNode> N(*this);
640   N->replaceOperandWith(12, ContainingType);
641   DbgNode = N;
642 }
643
644 /// isInlinedFnArgument - Return true if this variable provides debugging
645 /// information for an inlined function arguments.
646 bool DIVariable::isInlinedFnArgument(const Function *CurFn) {
647   assert(CurFn && "Invalid function");
648   if (!getContext().isSubprogram())
649     return false;
650   // This variable is not inlined function argument if its scope
651   // does not describe current function.
652   return !DISubprogram(getContext()).describes(CurFn);
653 }
654
655 /// describes - Return true if this subprogram provides debugging
656 /// information for the function F.
657 bool DISubprogram::describes(const Function *F) {
658   assert(F && "Invalid function");
659   if (F == getFunction())
660     return true;
661   StringRef Name = getLinkageName();
662   if (Name.empty())
663     Name = getName();
664   if (F->getName() == Name)
665     return true;
666   return false;
667 }
668
669 unsigned DISubprogram::isOptimized() const {
670   assert (DbgNode && "Invalid subprogram descriptor!");
671   if (DbgNode->getNumOperands() == 15)
672     return getUnsignedField(14);
673   return 0;
674 }
675
676 MDNode *DISubprogram::getVariablesNodes() const {
677   return getNodeField(DbgNode, 18);
678 }
679
680 DIArray DISubprogram::getVariables() const {
681   return DIArray(getNodeField(DbgNode, 18));
682 }
683
684 Value *DITemplateValueParameter::getValue() const {
685   return getField(DbgNode, 4);
686 }
687
688 StringRef DIScope::getFilename() const {
689   if (!DbgNode)
690     return StringRef();
691   return ::getStringField(getNodeField(DbgNode, 1), 0);
692 }
693
694 StringRef DIScope::getDirectory() const {
695   if (!DbgNode)
696     return StringRef();
697   return ::getStringField(getNodeField(DbgNode, 1), 1);
698 }
699
700 DIArray DICompileUnit::getEnumTypes() const {
701   if (!DbgNode || DbgNode->getNumOperands() < 13)
702     return DIArray();
703
704   return DIArray(getNodeField(DbgNode, 7));
705 }
706
707 DIArray DICompileUnit::getRetainedTypes() const {
708   if (!DbgNode || DbgNode->getNumOperands() < 13)
709     return DIArray();
710
711   return DIArray(getNodeField(DbgNode, 8));
712 }
713
714 DIArray DICompileUnit::getSubprograms() const {
715   if (!DbgNode || DbgNode->getNumOperands() < 13)
716     return DIArray();
717
718   return DIArray(getNodeField(DbgNode, 9));
719 }
720
721
722 DIArray DICompileUnit::getGlobalVariables() const {
723   if (!DbgNode || DbgNode->getNumOperands() < 13)
724     return DIArray();
725
726   return DIArray(getNodeField(DbgNode, 10));
727 }
728
729 DIArray DICompileUnit::getImportedEntities() const {
730   if (!DbgNode || DbgNode->getNumOperands() < 13)
731     return DIArray();
732
733   return DIArray(getNodeField(DbgNode, 11));
734 }
735
736 /// fixupSubprogramName - Replace contains special characters used
737 /// in a typical Objective-C names with '.' in a given string.
738 static void fixupSubprogramName(DISubprogram Fn, SmallVectorImpl<char> &Out) {
739   StringRef FName =
740       Fn.getFunction() ? Fn.getFunction()->getName() : Fn.getName();
741   FName = Function::getRealLinkageName(FName);
742
743   StringRef Prefix("llvm.dbg.lv.");
744   Out.reserve(FName.size() + Prefix.size());
745   Out.append(Prefix.begin(), Prefix.end());
746
747   bool isObjCLike = false;
748   for (size_t i = 0, e = FName.size(); i < e; ++i) {
749     char C = FName[i];
750     if (C == '[')
751       isObjCLike = true;
752
753     if (isObjCLike && (C == '[' || C == ']' || C == ' ' || C == ':' ||
754                        C == '+' || C == '(' || C == ')'))
755       Out.push_back('.');
756     else
757       Out.push_back(C);
758   }
759 }
760
761 /// getFnSpecificMDNode - Return a NameMDNode, if available, that is
762 /// suitable to hold function specific information.
763 NamedMDNode *llvm::getFnSpecificMDNode(const Module &M, DISubprogram Fn) {
764   SmallString<32> Name;
765   fixupSubprogramName(Fn, Name);
766   return M.getNamedMetadata(Name.str());
767 }
768
769 /// getOrInsertFnSpecificMDNode - Return a NameMDNode that is suitable
770 /// to hold function specific information.
771 NamedMDNode *llvm::getOrInsertFnSpecificMDNode(Module &M, DISubprogram Fn) {
772   SmallString<32> Name;
773   fixupSubprogramName(Fn, Name);
774   return M.getOrInsertNamedMetadata(Name.str());
775 }
776
777 /// createInlinedVariable - Create a new inlined variable based on current
778 /// variable.
779 /// @param DV            Current Variable.
780 /// @param InlinedScope  Location at current variable is inlined.
781 DIVariable llvm::createInlinedVariable(MDNode *DV, MDNode *InlinedScope,
782                                        LLVMContext &VMContext) {
783   SmallVector<Value *, 16> Elts;
784   // Insert inlined scope as 7th element.
785   for (unsigned i = 0, e = DV->getNumOperands(); i != e; ++i)
786     i == 7 ? Elts.push_back(InlinedScope) :
787              Elts.push_back(DV->getOperand(i));
788   return DIVariable(MDNode::get(VMContext, Elts));
789 }
790
791 /// cleanseInlinedVariable - Remove inlined scope from the variable.
792 DIVariable llvm::cleanseInlinedVariable(MDNode *DV, LLVMContext &VMContext) {
793   SmallVector<Value *, 16> Elts;
794   // Insert inlined scope as 7th element.
795   for (unsigned i = 0, e = DV->getNumOperands(); i != e; ++i)
796     i == 7 ?
797       Elts.push_back(Constant::getNullValue(Type::getInt32Ty(VMContext))):
798       Elts.push_back(DV->getOperand(i));
799   return DIVariable(MDNode::get(VMContext, Elts));
800 }
801
802 /// getDISubprogram - Find subprogram that is enclosing this scope.
803 DISubprogram llvm::getDISubprogram(const MDNode *Scope) {
804   DIDescriptor D(Scope);
805   if (D.isSubprogram())
806     return DISubprogram(Scope);
807
808   if (D.isLexicalBlockFile())
809     return getDISubprogram(DILexicalBlockFile(Scope).getContext());
810
811   if (D.isLexicalBlock())
812     return getDISubprogram(DILexicalBlock(Scope).getContext());
813
814   return DISubprogram();
815 }
816
817 /// getDICompositeType - Find underlying composite type.
818 DICompositeType llvm::getDICompositeType(DIType T) {
819   if (T.isCompositeType())
820     return DICompositeType(T);
821
822   if (T.isDerivedType())
823     return getDICompositeType(DIDerivedType(T).getTypeDerivedFrom());
824
825   return DICompositeType();
826 }
827
828 /// isSubprogramContext - Return true if Context is either a subprogram
829 /// or another context nested inside a subprogram.
830 bool llvm::isSubprogramContext(const MDNode *Context) {
831   if (!Context)
832     return false;
833   DIDescriptor D(Context);
834   if (D.isSubprogram())
835     return true;
836   if (D.isType())
837     return isSubprogramContext(DIType(Context).getContext());
838   return false;
839 }
840
841 //===----------------------------------------------------------------------===//
842 // DebugInfoFinder implementations.
843 //===----------------------------------------------------------------------===//
844
845 void DebugInfoFinder::reset() {
846   CUs.clear();
847   SPs.clear();
848   GVs.clear();
849   TYs.clear();
850   Scopes.clear();
851   NodesSeen.clear();
852 }
853
854 /// processModule - Process entire module and collect debug info.
855 void DebugInfoFinder::processModule(const Module &M) {
856   if (NamedMDNode *CU_Nodes = M.getNamedMetadata("llvm.dbg.cu")) {
857     for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
858       DICompileUnit CU(CU_Nodes->getOperand(i));
859       addCompileUnit(CU);
860       DIArray GVs = CU.getGlobalVariables();
861       for (unsigned i = 0, e = GVs.getNumElements(); i != e; ++i) {
862         DIGlobalVariable DIG(GVs.getElement(i));
863         if (addGlobalVariable(DIG)) {
864           processScope(DIG.getContext());
865           processType(DIG.getType());
866         }
867       }
868       DIArray SPs = CU.getSubprograms();
869       for (unsigned i = 0, e = SPs.getNumElements(); i != e; ++i)
870         processSubprogram(DISubprogram(SPs.getElement(i)));
871       DIArray EnumTypes = CU.getEnumTypes();
872       for (unsigned i = 0, e = EnumTypes.getNumElements(); i != e; ++i)
873         processType(DIType(EnumTypes.getElement(i)));
874       DIArray RetainedTypes = CU.getRetainedTypes();
875       for (unsigned i = 0, e = RetainedTypes.getNumElements(); i != e; ++i)
876         processType(DIType(RetainedTypes.getElement(i)));
877       // FIXME: We really shouldn't be bailing out after visiting just one CU
878       return;
879     }
880   }
881 }
882
883 /// processLocation - Process DILocation.
884 void DebugInfoFinder::processLocation(DILocation Loc) {
885   if (!Loc.Verify()) return;
886   DIDescriptor S(Loc.getScope());
887   if (S.isCompileUnit())
888     addCompileUnit(DICompileUnit(S));
889   else if (S.isSubprogram())
890     processSubprogram(DISubprogram(S));
891   else if (S.isLexicalBlock())
892     processLexicalBlock(DILexicalBlock(S));
893   else if (S.isLexicalBlockFile()) {
894     DILexicalBlockFile DBF = DILexicalBlockFile(S);
895     processLexicalBlock(DILexicalBlock(DBF.getScope()));
896   }
897   processLocation(Loc.getOrigLocation());
898 }
899
900 /// processType - Process DIType.
901 void DebugInfoFinder::processType(DIType DT) {
902   if (!addType(DT))
903     return;
904   processScope(DT.getContext());
905   if (DT.isCompositeType()) {
906     DICompositeType DCT(DT);
907     processType(DCT.getTypeDerivedFrom());
908     DIArray DA = DCT.getTypeArray();
909     for (unsigned i = 0, e = DA.getNumElements(); i != e; ++i) {
910       DIDescriptor D = DA.getElement(i);
911       if (D.isType())
912         processType(DIType(D));
913       else if (D.isSubprogram())
914         processSubprogram(DISubprogram(D));
915     }
916   } else if (DT.isDerivedType()) {
917     DIDerivedType DDT(DT);
918     processType(DDT.getTypeDerivedFrom());
919   }
920 }
921
922 void DebugInfoFinder::processScope(DIScope Scope) {
923   if (Scope.isType()) {
924     DIType Ty(Scope);
925     processType(Ty);
926     return;
927   }
928   if (Scope.isCompileUnit()) {
929     addCompileUnit(DICompileUnit(Scope));
930     return;
931   }
932   if (Scope.isSubprogram()) {
933     processSubprogram(DISubprogram(Scope));
934     return;
935   }
936   if (!addScope(Scope))
937     return;
938   if (Scope.isLexicalBlock()) {
939     DILexicalBlock LB(Scope);
940     processScope(LB.getContext());
941   } else if (Scope.isLexicalBlockFile()) {
942     DILexicalBlockFile LBF = DILexicalBlockFile(Scope);
943     processScope(LBF.getScope());
944   } else if (Scope.isNameSpace()) {
945     DINameSpace NS(Scope);
946     processScope(NS.getContext());
947   }
948 }
949
950 /// processLexicalBlock
951 void DebugInfoFinder::processLexicalBlock(DILexicalBlock LB) {
952   DIScope Context = LB.getContext();
953   if (Context.isLexicalBlock())
954     return processLexicalBlock(DILexicalBlock(Context));
955   else if (Context.isLexicalBlockFile()) {
956     DILexicalBlockFile DBF = DILexicalBlockFile(Context);
957     return processLexicalBlock(DILexicalBlock(DBF.getScope()));
958   }
959   else
960     return processSubprogram(DISubprogram(Context));
961 }
962
963 /// processSubprogram - Process DISubprogram.
964 void DebugInfoFinder::processSubprogram(DISubprogram SP) {
965   if (!addSubprogram(SP))
966     return;
967   processScope(SP.getContext());
968   processType(SP.getType());
969 }
970
971 /// processDeclare - Process DbgDeclareInst.
972 void DebugInfoFinder::processDeclare(const DbgDeclareInst *DDI) {
973   MDNode *N = dyn_cast<MDNode>(DDI->getVariable());
974   if (!N) return;
975
976   DIDescriptor DV(N);
977   if (!DV.isVariable())
978     return;
979
980   if (!NodesSeen.insert(DV))
981     return;
982   processScope(DIVariable(N).getContext());
983   processType(DIVariable(N).getType());
984 }
985
986 void DebugInfoFinder::processValue(const DbgValueInst *DVI) {
987   MDNode *N = dyn_cast<MDNode>(DVI->getVariable());
988   if (!N) return;
989
990   DIDescriptor DV(N);
991   if (!DV.isVariable())
992     return;
993
994   if (!NodesSeen.insert(DV))
995     return;
996   processScope(DIVariable(N).getContext());
997   processType(DIVariable(N).getType());
998 }
999
1000 /// addType - Add type into Tys.
1001 bool DebugInfoFinder::addType(DIType DT) {
1002   if (!DT.isValid())
1003     return false;
1004
1005   if (!NodesSeen.insert(DT))
1006     return false;
1007
1008   TYs.push_back(DT);
1009   return true;
1010 }
1011
1012 /// addCompileUnit - Add compile unit into CUs.
1013 bool DebugInfoFinder::addCompileUnit(DICompileUnit CU) {
1014   if (!CU.Verify())
1015     return false;
1016
1017   if (!NodesSeen.insert(CU))
1018     return false;
1019
1020   CUs.push_back(CU);
1021   return true;
1022 }
1023
1024 /// addGlobalVariable - Add global variable into GVs.
1025 bool DebugInfoFinder::addGlobalVariable(DIGlobalVariable DIG) {
1026   if (!DIDescriptor(DIG).isGlobalVariable())
1027     return false;
1028
1029   if (!NodesSeen.insert(DIG))
1030     return false;
1031
1032   GVs.push_back(DIG);
1033   return true;
1034 }
1035
1036 // addSubprogram - Add subprgoram into SPs.
1037 bool DebugInfoFinder::addSubprogram(DISubprogram SP) {
1038   if (!DIDescriptor(SP).isSubprogram())
1039     return false;
1040
1041   if (!NodesSeen.insert(SP))
1042     return false;
1043
1044   SPs.push_back(SP);
1045   return true;
1046 }
1047
1048 bool DebugInfoFinder::addScope(DIScope Scope) {
1049   if (!Scope)
1050     return false;
1051   if (!NodesSeen.insert(Scope))
1052     return false;
1053   Scopes.push_back(Scope);
1054   return true;
1055 }
1056
1057 //===----------------------------------------------------------------------===//
1058 // DIDescriptor: dump routines for all descriptors.
1059 //===----------------------------------------------------------------------===//
1060
1061 /// dump - Print descriptor to dbgs() with a newline.
1062 void DIDescriptor::dump() const {
1063   print(dbgs()); dbgs() << '\n';
1064 }
1065
1066 /// print - Print descriptor.
1067 void DIDescriptor::print(raw_ostream &OS) const {
1068   if (!DbgNode) return;
1069
1070   if (const char *Tag = dwarf::TagString(getTag()))
1071     OS << "[ " << Tag << " ]";
1072
1073   if (this->isSubrange()) {
1074     DISubrange(DbgNode).printInternal(OS);
1075   } else if (this->isCompileUnit()) {
1076     DICompileUnit(DbgNode).printInternal(OS);
1077   } else if (this->isFile()) {
1078     DIFile(DbgNode).printInternal(OS);
1079   } else if (this->isEnumerator()) {
1080     DIEnumerator(DbgNode).printInternal(OS);
1081   } else if (this->isBasicType()) {
1082     DIType(DbgNode).printInternal(OS);
1083   } else if (this->isDerivedType()) {
1084     DIDerivedType(DbgNode).printInternal(OS);
1085   } else if (this->isCompositeType()) {
1086     DICompositeType(DbgNode).printInternal(OS);
1087   } else if (this->isSubprogram()) {
1088     DISubprogram(DbgNode).printInternal(OS);
1089   } else if (this->isGlobalVariable()) {
1090     DIGlobalVariable(DbgNode).printInternal(OS);
1091   } else if (this->isVariable()) {
1092     DIVariable(DbgNode).printInternal(OS);
1093   } else if (this->isObjCProperty()) {
1094     DIObjCProperty(DbgNode).printInternal(OS);
1095   } else if (this->isNameSpace()) {
1096     DINameSpace(DbgNode).printInternal(OS);
1097   } else if (this->isScope()) {
1098     DIScope(DbgNode).printInternal(OS);
1099   }
1100 }
1101
1102 void DISubrange::printInternal(raw_ostream &OS) const {
1103   int64_t Count = getCount();
1104   if (Count != -1)
1105     OS << " [" << getLo() << ", " << Count - 1 << ']';
1106   else
1107     OS << " [unbounded]";
1108 }
1109
1110 void DIScope::printInternal(raw_ostream &OS) const {
1111   OS << " [" << getDirectory() << "/" << getFilename() << ']';
1112 }
1113
1114 void DICompileUnit::printInternal(raw_ostream &OS) const {
1115   DIScope::printInternal(OS);
1116   OS << " [";
1117   unsigned Lang = getLanguage();
1118   if (const char *LangStr = dwarf::LanguageString(Lang))
1119     OS << LangStr;
1120   else
1121     (OS << "lang 0x").write_hex(Lang);
1122   OS << ']';
1123 }
1124
1125 void DIEnumerator::printInternal(raw_ostream &OS) const {
1126   OS << " [" << getName() << " :: " << getEnumValue() << ']';
1127 }
1128
1129 void DIType::printInternal(raw_ostream &OS) const {
1130   if (!DbgNode) return;
1131
1132   StringRef Res = getName();
1133   if (!Res.empty())
1134     OS << " [" << Res << "]";
1135
1136   // TODO: Print context?
1137
1138   OS << " [line " << getLineNumber()
1139      << ", size " << getSizeInBits()
1140      << ", align " << getAlignInBits()
1141      << ", offset " << getOffsetInBits();
1142   if (isBasicType())
1143     if (const char *Enc =
1144         dwarf::AttributeEncodingString(DIBasicType(DbgNode).getEncoding()))
1145       OS << ", enc " << Enc;
1146   OS << "]";
1147
1148   if (isPrivate())
1149     OS << " [private]";
1150   else if (isProtected())
1151     OS << " [protected]";
1152
1153   if (isArtificial())
1154     OS << " [artificial]";
1155
1156   if (isForwardDecl())
1157     OS << " [decl]";
1158   else if (getTag() == dwarf::DW_TAG_structure_type ||
1159            getTag() == dwarf::DW_TAG_union_type ||
1160            getTag() == dwarf::DW_TAG_enumeration_type ||
1161            getTag() == dwarf::DW_TAG_class_type)
1162     OS << " [def]";
1163   if (isVector())
1164     OS << " [vector]";
1165   if (isStaticMember())
1166     OS << " [static]";
1167 }
1168
1169 void DIDerivedType::printInternal(raw_ostream &OS) const {
1170   DIType::printInternal(OS);
1171   OS << " [from " << getTypeDerivedFrom().getName() << ']';
1172 }
1173
1174 void DICompositeType::printInternal(raw_ostream &OS) const {
1175   DIType::printInternal(OS);
1176   DIArray A = getTypeArray();
1177   OS << " [" << A.getNumElements() << " elements]";
1178 }
1179
1180 void DINameSpace::printInternal(raw_ostream &OS) const {
1181   StringRef Name = getName();
1182   if (!Name.empty())
1183     OS << " [" << Name << ']';
1184
1185   OS << " [line " << getLineNumber() << ']';
1186 }
1187
1188 void DISubprogram::printInternal(raw_ostream &OS) const {
1189   // TODO : Print context
1190   OS << " [line " << getLineNumber() << ']';
1191
1192   if (isLocalToUnit())
1193     OS << " [local]";
1194
1195   if (isDefinition())
1196     OS << " [def]";
1197
1198   if (getScopeLineNumber() != getLineNumber())
1199     OS << " [scope " << getScopeLineNumber() << "]";
1200
1201   if (isPrivate())
1202     OS << " [private]";
1203   else if (isProtected())
1204     OS << " [protected]";
1205
1206   StringRef Res = getName();
1207   if (!Res.empty())
1208     OS << " [" << Res << ']';
1209 }
1210
1211 void DIGlobalVariable::printInternal(raw_ostream &OS) const {
1212   StringRef Res = getName();
1213   if (!Res.empty())
1214     OS << " [" << Res << ']';
1215
1216   OS << " [line " << getLineNumber() << ']';
1217
1218   // TODO : Print context
1219
1220   if (isLocalToUnit())
1221     OS << " [local]";
1222
1223   if (isDefinition())
1224     OS << " [def]";
1225 }
1226
1227 void DIVariable::printInternal(raw_ostream &OS) const {
1228   StringRef Res = getName();
1229   if (!Res.empty())
1230     OS << " [" << Res << ']';
1231
1232   OS << " [line " << getLineNumber() << ']';
1233 }
1234
1235 void DIObjCProperty::printInternal(raw_ostream &OS) const {
1236   StringRef Name = getObjCPropertyName();
1237   if (!Name.empty())
1238     OS << " [" << Name << ']';
1239
1240   OS << " [line " << getLineNumber()
1241      << ", properties " << getUnsignedField(6) << ']';
1242 }
1243
1244 static void printDebugLoc(DebugLoc DL, raw_ostream &CommentOS,
1245                           const LLVMContext &Ctx) {
1246   if (!DL.isUnknown()) {          // Print source line info.
1247     DIScope Scope(DL.getScope(Ctx));
1248     assert(Scope.isScope() &&
1249       "Scope of a DebugLoc should be a DIScope.");
1250     // Omit the directory, because it's likely to be long and uninteresting.
1251     CommentOS << Scope.getFilename();
1252     CommentOS << ':' << DL.getLine();
1253     if (DL.getCol() != 0)
1254       CommentOS << ':' << DL.getCol();
1255     DebugLoc InlinedAtDL = DebugLoc::getFromDILocation(DL.getInlinedAt(Ctx));
1256     if (!InlinedAtDL.isUnknown()) {
1257       CommentOS << " @[ ";
1258       printDebugLoc(InlinedAtDL, CommentOS, Ctx);
1259       CommentOS << " ]";
1260     }
1261   }
1262 }
1263
1264 void DIVariable::printExtendedName(raw_ostream &OS) const {
1265   const LLVMContext &Ctx = DbgNode->getContext();
1266   StringRef Res = getName();
1267   if (!Res.empty())
1268     OS << Res << "," << getLineNumber();
1269   if (MDNode *InlinedAt = getInlinedAt()) {
1270     DebugLoc InlinedAtDL = DebugLoc::getFromDILocation(InlinedAt);
1271     if (!InlinedAtDL.isUnknown()) {
1272       OS << " @[";
1273       printDebugLoc(InlinedAtDL, OS, Ctx);
1274       OS << "]";
1275     }
1276   }
1277 }