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