More constructor cleanup.
[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 unsigned DIArray::getNumElements() const {
348   if (!DbgNode)
349     return 0;
350   return DbgNode->getNumOperands();
351 }
352
353 /// replaceAllUsesWith - Replace all uses of debug info referenced by
354 /// this descriptor.
355 void DIType::replaceAllUsesWith(DIDescriptor &D) {
356   if (!DbgNode)
357     return;
358
359   // Since we use a TrackingVH for the node, its easy for clients to manufacture
360   // legitimate situations where they want to replaceAllUsesWith() on something
361   // which, due to uniquing, has merged with the source. We shield clients from
362   // this detail by allowing a value to be replaced with replaceAllUsesWith()
363   // itself.
364   if (DbgNode != D) {
365     MDNode *Node = const_cast<MDNode*>(DbgNode);
366     const MDNode *DN = D;
367     const Value *V = cast_or_null<Value>(DN);
368     Node->replaceAllUsesWith(const_cast<Value*>(V));
369     MDNode::deleteTemporary(Node);
370   }
371 }
372
373 /// replaceAllUsesWith - Replace all uses of debug info referenced by
374 /// this descriptor.
375 void DIType::replaceAllUsesWith(MDNode *D) {
376   if (!DbgNode)
377     return;
378
379   // Since we use a TrackingVH for the node, its easy for clients to manufacture
380   // legitimate situations where they want to replaceAllUsesWith() on something
381   // which, due to uniquing, has merged with the source. We shield clients from
382   // this detail by allowing a value to be replaced with replaceAllUsesWith()
383   // itself.
384   if (DbgNode != D) {
385     MDNode *Node = const_cast<MDNode*>(DbgNode);
386     const MDNode *DN = D;
387     const Value *V = cast_or_null<Value>(DN);
388     Node->replaceAllUsesWith(const_cast<Value*>(V));
389     MDNode::deleteTemporary(Node);
390   }
391 }
392
393 /// isUnsignedDIType - Return true if type encoding is unsigned.
394 bool DIType::isUnsignedDIType() {
395   DIDerivedType DTy(DbgNode);
396   if (DTy.Verify())
397     return DTy.getTypeDerivedFrom().isUnsignedDIType();
398
399   DIBasicType BTy(DbgNode);
400   if (BTy.Verify()) {
401     unsigned Encoding = BTy.getEncoding();
402     if (Encoding == dwarf::DW_ATE_unsigned ||
403         Encoding == dwarf::DW_ATE_unsigned_char ||
404         Encoding == dwarf::DW_ATE_boolean)
405       return true;
406   }
407   return false;
408 }
409
410 /// Verify - Verify that a compile unit is well formed.
411 bool DICompileUnit::Verify() const {
412   if (!isCompileUnit())
413     return false;
414
415   // Don't bother verifying the compilation directory or producer string
416   // as those could be empty.
417   if (getFilename().empty())
418     return false;
419
420   return DbgNode->getNumOperands() == 13;
421 }
422
423 /// Verify - Verify that an ObjC property is well formed.
424 bool DIObjCProperty::Verify() const {
425   if (!isObjCProperty())
426     return false;
427
428   // Don't worry about the rest of the strings for now.
429   return DbgNode->getNumOperands() == 8;
430 }
431
432 /// Verify - Verify that a type descriptor is well formed.
433 bool DIType::Verify() const {
434   if (!isType())
435     return false;
436   // FIXME: Sink this into the various subclass verifies.
437   unsigned Tag = getTag();
438   if (!isBasicType() && Tag != dwarf::DW_TAG_const_type &&
439       Tag != dwarf::DW_TAG_volatile_type && Tag != dwarf::DW_TAG_pointer_type &&
440       Tag != dwarf::DW_TAG_ptr_to_member_type &&
441       Tag != dwarf::DW_TAG_reference_type &&
442       Tag != dwarf::DW_TAG_rvalue_reference_type &&
443       Tag != dwarf::DW_TAG_restrict_type && Tag != dwarf::DW_TAG_array_type &&
444       Tag != dwarf::DW_TAG_enumeration_type &&
445       Tag != dwarf::DW_TAG_subroutine_type &&
446       Tag != dwarf::DW_TAG_inheritance && Tag != dwarf::DW_TAG_friend &&
447       getFilename().empty())
448     return false;
449   // DIType is abstract, it should be a BasicType, a DerivedType or
450   // a CompositeType.
451   if (isBasicType())
452     DIBasicType(DbgNode).Verify();
453   else if (isCompositeType())
454     DICompositeType(DbgNode).Verify();
455   else if (isDerivedType())
456     DIDerivedType(DbgNode).Verify();
457   else
458     return false;
459   return true;
460 }
461
462 /// Verify - Verify that a basic type descriptor is well formed.
463 bool DIBasicType::Verify() const {
464   return isBasicType() && DbgNode->getNumOperands() == 10;
465 }
466
467 /// Verify - Verify that a derived type descriptor is well formed.
468 bool DIDerivedType::Verify() const {
469   return isDerivedType() && DbgNode->getNumOperands() >= 10 &&
470          DbgNode->getNumOperands() <= 14;
471 }
472
473 /// Verify - Verify that a composite type descriptor is well formed.
474 bool DICompositeType::Verify() const {
475   if (!isCompositeType())
476     return false;
477
478   return DbgNode->getNumOperands() >= 10 && DbgNode->getNumOperands() <= 14;
479 }
480
481 /// Verify - Verify that a subprogram descriptor is well formed.
482 bool DISubprogram::Verify() const {
483   if (!isSubprogram())
484     return false;
485
486   return DbgNode->getNumOperands() == 20;
487 }
488
489 /// Verify - Verify that a global variable descriptor is well formed.
490 bool DIGlobalVariable::Verify() const {
491   if (!isGlobalVariable())
492     return false;
493
494   if (getDisplayName().empty())
495     return false;
496
497   return DbgNode->getNumOperands() == 13;
498 }
499
500 /// Verify - Verify that a variable descriptor is well formed.
501 bool DIVariable::Verify() const {
502   if (!isVariable())
503     return false;
504
505   return DbgNode->getNumOperands() >= 8;
506 }
507
508 /// Verify - Verify that a location descriptor is well formed.
509 bool DILocation::Verify() const {
510   if (!DbgNode)
511     return false;
512
513   return DbgNode->getNumOperands() == 4;
514 }
515
516 /// Verify - Verify that a namespace descriptor is well formed.
517 bool DINameSpace::Verify() const {
518   if (!isNameSpace())
519     return false;
520   return DbgNode->getNumOperands() == 5;
521 }
522
523 /// \brief Retrieve the MDNode for the directory/file pair.
524 MDNode *DIFile::getFileNode() const {
525   return getNodeField(DbgNode, 1);
526 }
527
528 /// \brief Verify that the file descriptor is well formed.
529 bool DIFile::Verify() const {
530   return isFile() && DbgNode->getNumOperands() == 2;
531 }
532
533 /// \brief Verify that the enumerator descriptor is well formed.
534 bool DIEnumerator::Verify() const {
535   return isEnumerator() && DbgNode->getNumOperands() == 3;
536 }
537
538 /// \brief Verify that the subrange descriptor is well formed.
539 bool DISubrange::Verify() const {
540   return isSubrange() && DbgNode->getNumOperands() == 3;
541 }
542
543 /// \brief Verify that the lexical block descriptor is well formed.
544 bool DILexicalBlock::Verify() const {
545   return isLexicalBlock() && DbgNode->getNumOperands() == 6;
546 }
547
548 /// \brief Verify that the file-scoped lexical block descriptor is well formed.
549 bool DILexicalBlockFile::Verify() const {
550   return isLexicalBlockFile() && DbgNode->getNumOperands() == 3;
551 }
552
553 /// \brief Verify that the template type parameter descriptor is well formed.
554 bool DITemplateTypeParameter::Verify() const {
555   return isTemplateTypeParameter() && DbgNode->getNumOperands() == 7;
556 }
557
558 /// \brief Verify that the template value parameter descriptor is well formed.
559 bool DITemplateValueParameter::Verify() const {
560   return isTemplateValueParameter() && DbgNode->getNumOperands() == 8;
561 }
562
563 /// \brief Verify that the imported module descriptor is well formed.
564 bool DIImportedEntity::Verify() const {
565   return isImportedEntity() &&
566          (DbgNode->getNumOperands() == 4 || DbgNode->getNumOperands() == 5);
567 }
568
569 /// getOriginalTypeSize - If this type is derived from a base type then
570 /// return base type size.
571 uint64_t DIDerivedType::getOriginalTypeSize() const {
572   unsigned Tag = getTag();
573
574   if (Tag != dwarf::DW_TAG_member && Tag != dwarf::DW_TAG_typedef &&
575       Tag != dwarf::DW_TAG_const_type && Tag != dwarf::DW_TAG_volatile_type &&
576       Tag != dwarf::DW_TAG_restrict_type)
577     return getSizeInBits();
578
579   DIType BaseType = getTypeDerivedFrom();
580
581   // If this type is not derived from any type then take conservative approach.
582   if (!BaseType.isValid())
583     return getSizeInBits();
584
585   // If this is a derived type, go ahead and get the base type, unless it's a
586   // reference then it's just the size of the field. Pointer types have no need
587   // of this since they're a different type of qualification on the type.
588   if (BaseType.getTag() == dwarf::DW_TAG_reference_type ||
589       BaseType.getTag() == dwarf::DW_TAG_rvalue_reference_type)
590     return getSizeInBits();
591
592   if (BaseType.isDerivedType())
593     return DIDerivedType(BaseType).getOriginalTypeSize();
594
595   return BaseType.getSizeInBits();
596 }
597
598 /// getObjCProperty - Return property node, if this ivar is associated with one.
599 MDNode *DIDerivedType::getObjCProperty() const {
600   return getNodeField(DbgNode, 10);
601 }
602
603 /// \brief Set the array of member DITypes.
604 void DICompositeType::setTypeArray(DIArray Elements, DIArray TParams) {
605   assert((!TParams || DbgNode->getNumOperands() == 14) &&
606          "If you're setting the template parameters this should include a slot "
607          "for that!");
608   TrackingVH<MDNode> N(*this);
609   N->replaceOperandWith(10, Elements);
610   if (TParams)
611     N->replaceOperandWith(13, TParams);
612   DbgNode = N;
613 }
614
615 /// \brief Set the containing type.
616 void DICompositeType::setContainingType(DICompositeType ContainingType) {
617   TrackingVH<MDNode> N(*this);
618   N->replaceOperandWith(12, ContainingType);
619   DbgNode = N;
620 }
621
622 /// isInlinedFnArgument - Return true if this variable provides debugging
623 /// information for an inlined function arguments.
624 bool DIVariable::isInlinedFnArgument(const Function *CurFn) {
625   assert(CurFn && "Invalid function");
626   if (!getContext().isSubprogram())
627     return false;
628   // This variable is not inlined function argument if its scope
629   // does not describe current function.
630   return !DISubprogram(getContext()).describes(CurFn);
631 }
632
633 /// describes - Return true if this subprogram provides debugging
634 /// information for the function F.
635 bool DISubprogram::describes(const Function *F) {
636   assert(F && "Invalid function");
637   if (F == getFunction())
638     return true;
639   StringRef Name = getLinkageName();
640   if (Name.empty())
641     Name = getName();
642   if (F->getName() == Name)
643     return true;
644   return false;
645 }
646
647 unsigned DISubprogram::isOptimized() const {
648   assert (DbgNode && "Invalid subprogram descriptor!");
649   if (DbgNode->getNumOperands() == 15)
650     return getUnsignedField(14);
651   return 0;
652 }
653
654 MDNode *DISubprogram::getVariablesNodes() const {
655   return getNodeField(DbgNode, 18);
656 }
657
658 DIArray DISubprogram::getVariables() const {
659   return DIArray(getNodeField(DbgNode, 18));
660 }
661
662 Value *DITemplateValueParameter::getValue() const {
663   return getField(DbgNode, 4);
664 }
665
666 StringRef DIScope::getFilename() const {
667   if (!DbgNode)
668     return StringRef();
669   return ::getStringField(getNodeField(DbgNode, 1), 0);
670 }
671
672 StringRef DIScope::getDirectory() const {
673   if (!DbgNode)
674     return StringRef();
675   return ::getStringField(getNodeField(DbgNode, 1), 1);
676 }
677
678 DIArray DICompileUnit::getEnumTypes() const {
679   if (!DbgNode || DbgNode->getNumOperands() < 13)
680     return DIArray();
681
682   return DIArray(getNodeField(DbgNode, 7));
683 }
684
685 DIArray DICompileUnit::getRetainedTypes() const {
686   if (!DbgNode || DbgNode->getNumOperands() < 13)
687     return DIArray();
688
689   return DIArray(getNodeField(DbgNode, 8));
690 }
691
692 DIArray DICompileUnit::getSubprograms() const {
693   if (!DbgNode || DbgNode->getNumOperands() < 13)
694     return DIArray();
695
696   return DIArray(getNodeField(DbgNode, 9));
697 }
698
699
700 DIArray DICompileUnit::getGlobalVariables() const {
701   if (!DbgNode || DbgNode->getNumOperands() < 13)
702     return DIArray();
703
704   return DIArray(getNodeField(DbgNode, 10));
705 }
706
707 DIArray DICompileUnit::getImportedEntities() const {
708   if (!DbgNode || DbgNode->getNumOperands() < 13)
709     return DIArray();
710
711   return DIArray(getNodeField(DbgNode, 11));
712 }
713
714 /// fixupSubprogramName - Replace contains special characters used
715 /// in a typical Objective-C names with '.' in a given string.
716 static void fixupSubprogramName(DISubprogram Fn, SmallVectorImpl<char> &Out) {
717   StringRef FName =
718       Fn.getFunction() ? Fn.getFunction()->getName() : Fn.getName();
719   FName = Function::getRealLinkageName(FName);
720
721   StringRef Prefix("llvm.dbg.lv.");
722   Out.reserve(FName.size() + Prefix.size());
723   Out.append(Prefix.begin(), Prefix.end());
724
725   bool isObjCLike = false;
726   for (size_t i = 0, e = FName.size(); i < e; ++i) {
727     char C = FName[i];
728     if (C == '[')
729       isObjCLike = true;
730
731     if (isObjCLike && (C == '[' || C == ']' || C == ' ' || C == ':' ||
732                        C == '+' || C == '(' || C == ')'))
733       Out.push_back('.');
734     else
735       Out.push_back(C);
736   }
737 }
738
739 /// getFnSpecificMDNode - Return a NameMDNode, if available, that is
740 /// suitable to hold function specific information.
741 NamedMDNode *llvm::getFnSpecificMDNode(const Module &M, DISubprogram Fn) {
742   SmallString<32> Name;
743   fixupSubprogramName(Fn, Name);
744   return M.getNamedMetadata(Name.str());
745 }
746
747 /// getOrInsertFnSpecificMDNode - Return a NameMDNode that is suitable
748 /// to hold function specific information.
749 NamedMDNode *llvm::getOrInsertFnSpecificMDNode(Module &M, DISubprogram Fn) {
750   SmallString<32> Name;
751   fixupSubprogramName(Fn, Name);
752   return M.getOrInsertNamedMetadata(Name.str());
753 }
754
755 /// createInlinedVariable - Create a new inlined variable based on current
756 /// variable.
757 /// @param DV            Current Variable.
758 /// @param InlinedScope  Location at current variable is inlined.
759 DIVariable llvm::createInlinedVariable(MDNode *DV, MDNode *InlinedScope,
760                                        LLVMContext &VMContext) {
761   SmallVector<Value *, 16> Elts;
762   // Insert inlined scope as 7th element.
763   for (unsigned i = 0, e = DV->getNumOperands(); i != e; ++i)
764     i == 7 ? Elts.push_back(InlinedScope) :
765              Elts.push_back(DV->getOperand(i));
766   return DIVariable(MDNode::get(VMContext, Elts));
767 }
768
769 /// cleanseInlinedVariable - Remove inlined scope from the variable.
770 DIVariable llvm::cleanseInlinedVariable(MDNode *DV, LLVMContext &VMContext) {
771   SmallVector<Value *, 16> Elts;
772   // Insert inlined scope as 7th element.
773   for (unsigned i = 0, e = DV->getNumOperands(); i != e; ++i)
774     i == 7 ?
775       Elts.push_back(Constant::getNullValue(Type::getInt32Ty(VMContext))):
776       Elts.push_back(DV->getOperand(i));
777   return DIVariable(MDNode::get(VMContext, Elts));
778 }
779
780 /// getDISubprogram - Find subprogram that is enclosing this scope.
781 DISubprogram llvm::getDISubprogram(const MDNode *Scope) {
782   DIDescriptor D(Scope);
783   if (D.isSubprogram())
784     return DISubprogram(Scope);
785
786   if (D.isLexicalBlockFile())
787     return getDISubprogram(DILexicalBlockFile(Scope).getContext());
788
789   if (D.isLexicalBlock())
790     return getDISubprogram(DILexicalBlock(Scope).getContext());
791
792   return DISubprogram();
793 }
794
795 /// getDICompositeType - Find underlying composite type.
796 DICompositeType llvm::getDICompositeType(DIType T) {
797   if (T.isCompositeType())
798     return DICompositeType(T);
799
800   if (T.isDerivedType())
801     return getDICompositeType(DIDerivedType(T).getTypeDerivedFrom());
802
803   return DICompositeType();
804 }
805
806 /// isSubprogramContext - Return true if Context is either a subprogram
807 /// or another context nested inside a subprogram.
808 bool llvm::isSubprogramContext(const MDNode *Context) {
809   if (!Context)
810     return false;
811   DIDescriptor D(Context);
812   if (D.isSubprogram())
813     return true;
814   if (D.isType())
815     return isSubprogramContext(DIType(Context).getContext());
816   return false;
817 }
818
819 //===----------------------------------------------------------------------===//
820 // DebugInfoFinder implementations.
821 //===----------------------------------------------------------------------===//
822
823 void DebugInfoFinder::reset() {
824   CUs.clear();
825   SPs.clear();
826   GVs.clear();
827   TYs.clear();
828   Scopes.clear();
829   NodesSeen.clear();
830 }
831
832 /// processModule - Process entire module and collect debug info.
833 void DebugInfoFinder::processModule(const Module &M) {
834   if (NamedMDNode *CU_Nodes = M.getNamedMetadata("llvm.dbg.cu")) {
835     for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
836       DICompileUnit CU(CU_Nodes->getOperand(i));
837       addCompileUnit(CU);
838       DIArray GVs = CU.getGlobalVariables();
839       for (unsigned i = 0, e = GVs.getNumElements(); i != e; ++i) {
840         DIGlobalVariable DIG(GVs.getElement(i));
841         if (addGlobalVariable(DIG)) {
842           processScope(DIG.getContext());
843           processType(DIG.getType());
844         }
845       }
846       DIArray SPs = CU.getSubprograms();
847       for (unsigned i = 0, e = SPs.getNumElements(); i != e; ++i)
848         processSubprogram(DISubprogram(SPs.getElement(i)));
849       DIArray EnumTypes = CU.getEnumTypes();
850       for (unsigned i = 0, e = EnumTypes.getNumElements(); i != e; ++i)
851         processType(DIType(EnumTypes.getElement(i)));
852       DIArray RetainedTypes = CU.getRetainedTypes();
853       for (unsigned i = 0, e = RetainedTypes.getNumElements(); i != e; ++i)
854         processType(DIType(RetainedTypes.getElement(i)));
855       // FIXME: We really shouldn't be bailing out after visiting just one CU
856       return;
857     }
858   }
859 }
860
861 /// processLocation - Process DILocation.
862 void DebugInfoFinder::processLocation(DILocation Loc) {
863   if (!Loc.Verify()) return;
864   DIDescriptor S(Loc.getScope());
865   if (S.isCompileUnit())
866     addCompileUnit(DICompileUnit(S));
867   else if (S.isSubprogram())
868     processSubprogram(DISubprogram(S));
869   else if (S.isLexicalBlock())
870     processLexicalBlock(DILexicalBlock(S));
871   else if (S.isLexicalBlockFile()) {
872     DILexicalBlockFile DBF = DILexicalBlockFile(S);
873     processLexicalBlock(DILexicalBlock(DBF.getScope()));
874   }
875   processLocation(Loc.getOrigLocation());
876 }
877
878 /// processType - Process DIType.
879 void DebugInfoFinder::processType(DIType DT) {
880   if (!addType(DT))
881     return;
882   processScope(DT.getContext());
883   if (DT.isCompositeType()) {
884     DICompositeType DCT(DT);
885     processType(DCT.getTypeDerivedFrom());
886     DIArray DA = DCT.getTypeArray();
887     for (unsigned i = 0, e = DA.getNumElements(); i != e; ++i) {
888       DIDescriptor D = DA.getElement(i);
889       if (D.isType())
890         processType(DIType(D));
891       else if (D.isSubprogram())
892         processSubprogram(DISubprogram(D));
893     }
894   } else if (DT.isDerivedType()) {
895     DIDerivedType DDT(DT);
896     processType(DDT.getTypeDerivedFrom());
897   }
898 }
899
900 void DebugInfoFinder::processScope(DIScope Scope) {
901   if (Scope.isType()) {
902     DIType Ty(Scope);
903     processType(Ty);
904     return;
905   }
906   if (Scope.isCompileUnit()) {
907     addCompileUnit(DICompileUnit(Scope));
908     return;
909   }
910   if (Scope.isSubprogram()) {
911     processSubprogram(DISubprogram(Scope));
912     return;
913   }
914   if (!addScope(Scope))
915     return;
916   if (Scope.isLexicalBlock()) {
917     DILexicalBlock LB(Scope);
918     processScope(LB.getContext());
919   } else if (Scope.isLexicalBlockFile()) {
920     DILexicalBlockFile LBF = DILexicalBlockFile(Scope);
921     processScope(LBF.getScope());
922   } else if (Scope.isNameSpace()) {
923     DINameSpace NS(Scope);
924     processScope(NS.getContext());
925   }
926 }
927
928 /// processLexicalBlock
929 void DebugInfoFinder::processLexicalBlock(DILexicalBlock LB) {
930   DIScope Context = LB.getContext();
931   if (Context.isLexicalBlock())
932     return processLexicalBlock(DILexicalBlock(Context));
933   else if (Context.isLexicalBlockFile()) {
934     DILexicalBlockFile DBF = DILexicalBlockFile(Context);
935     return processLexicalBlock(DILexicalBlock(DBF.getScope()));
936   }
937   else
938     return processSubprogram(DISubprogram(Context));
939 }
940
941 /// processSubprogram - Process DISubprogram.
942 void DebugInfoFinder::processSubprogram(DISubprogram SP) {
943   if (!addSubprogram(SP))
944     return;
945   processScope(SP.getContext());
946   processType(SP.getType());
947 }
948
949 /// processDeclare - Process DbgDeclareInst.
950 void DebugInfoFinder::processDeclare(const DbgDeclareInst *DDI) {
951   MDNode *N = dyn_cast<MDNode>(DDI->getVariable());
952   if (!N) return;
953
954   DIDescriptor DV(N);
955   if (!DV.isVariable())
956     return;
957
958   if (!NodesSeen.insert(DV))
959     return;
960   processScope(DIVariable(N).getContext());
961   processType(DIVariable(N).getType());
962 }
963
964 void DebugInfoFinder::processValue(const DbgValueInst *DVI) {
965   MDNode *N = dyn_cast<MDNode>(DVI->getVariable());
966   if (!N) return;
967
968   DIDescriptor DV(N);
969   if (!DV.isVariable())
970     return;
971
972   if (!NodesSeen.insert(DV))
973     return;
974   processType(DIVariable(N).getType());
975 }
976
977 /// addType - Add type into Tys.
978 bool DebugInfoFinder::addType(DIType DT) {
979   if (!DT.isValid())
980     return false;
981
982   if (!NodesSeen.insert(DT))
983     return false;
984
985   TYs.push_back(DT);
986   return true;
987 }
988
989 /// addCompileUnit - Add compile unit into CUs.
990 bool DebugInfoFinder::addCompileUnit(DICompileUnit CU) {
991   if (!CU.Verify())
992     return false;
993
994   if (!NodesSeen.insert(CU))
995     return false;
996
997   CUs.push_back(CU);
998   return true;
999 }
1000
1001 /// addGlobalVariable - Add global variable into GVs.
1002 bool DebugInfoFinder::addGlobalVariable(DIGlobalVariable DIG) {
1003   if (!DIDescriptor(DIG).isGlobalVariable())
1004     return false;
1005
1006   if (!NodesSeen.insert(DIG))
1007     return false;
1008
1009   GVs.push_back(DIG);
1010   return true;
1011 }
1012
1013 // addSubprogram - Add subprgoram into SPs.
1014 bool DebugInfoFinder::addSubprogram(DISubprogram SP) {
1015   if (!DIDescriptor(SP).isSubprogram())
1016     return false;
1017
1018   if (!NodesSeen.insert(SP))
1019     return false;
1020
1021   SPs.push_back(SP);
1022   return true;
1023 }
1024
1025 bool DebugInfoFinder::addScope(DIScope Scope) {
1026   if (!Scope)
1027     return false;
1028   if (!NodesSeen.insert(Scope))
1029     return false;
1030   Scopes.push_back(Scope);
1031   return true;
1032 }
1033
1034 //===----------------------------------------------------------------------===//
1035 // DIDescriptor: dump routines for all descriptors.
1036 //===----------------------------------------------------------------------===//
1037
1038 /// dump - Print descriptor to dbgs() with a newline.
1039 void DIDescriptor::dump() const {
1040   print(dbgs()); dbgs() << '\n';
1041 }
1042
1043 /// print - Print descriptor.
1044 void DIDescriptor::print(raw_ostream &OS) const {
1045   if (!DbgNode) return;
1046
1047   if (const char *Tag = dwarf::TagString(getTag()))
1048     OS << "[ " << Tag << " ]";
1049
1050   if (this->isSubrange()) {
1051     DISubrange(DbgNode).printInternal(OS);
1052   } else if (this->isCompileUnit()) {
1053     DICompileUnit(DbgNode).printInternal(OS);
1054   } else if (this->isFile()) {
1055     DIFile(DbgNode).printInternal(OS);
1056   } else if (this->isEnumerator()) {
1057     DIEnumerator(DbgNode).printInternal(OS);
1058   } else if (this->isBasicType()) {
1059     DIType(DbgNode).printInternal(OS);
1060   } else if (this->isDerivedType()) {
1061     DIDerivedType(DbgNode).printInternal(OS);
1062   } else if (this->isCompositeType()) {
1063     DICompositeType(DbgNode).printInternal(OS);
1064   } else if (this->isSubprogram()) {
1065     DISubprogram(DbgNode).printInternal(OS);
1066   } else if (this->isGlobalVariable()) {
1067     DIGlobalVariable(DbgNode).printInternal(OS);
1068   } else if (this->isVariable()) {
1069     DIVariable(DbgNode).printInternal(OS);
1070   } else if (this->isObjCProperty()) {
1071     DIObjCProperty(DbgNode).printInternal(OS);
1072   } else if (this->isNameSpace()) {
1073     DINameSpace(DbgNode).printInternal(OS);
1074   } else if (this->isScope()) {
1075     DIScope(DbgNode).printInternal(OS);
1076   }
1077 }
1078
1079 void DISubrange::printInternal(raw_ostream &OS) const {
1080   int64_t Count = getCount();
1081   if (Count != -1)
1082     OS << " [" << getLo() << ", " << Count - 1 << ']';
1083   else
1084     OS << " [unbounded]";
1085 }
1086
1087 void DIScope::printInternal(raw_ostream &OS) const {
1088   OS << " [" << getDirectory() << "/" << getFilename() << ']';
1089 }
1090
1091 void DICompileUnit::printInternal(raw_ostream &OS) const {
1092   DIScope::printInternal(OS);
1093   OS << " [";
1094   unsigned Lang = getLanguage();
1095   if (const char *LangStr = dwarf::LanguageString(Lang))
1096     OS << LangStr;
1097   else
1098     (OS << "lang 0x").write_hex(Lang);
1099   OS << ']';
1100 }
1101
1102 void DIEnumerator::printInternal(raw_ostream &OS) const {
1103   OS << " [" << getName() << " :: " << getEnumValue() << ']';
1104 }
1105
1106 void DIType::printInternal(raw_ostream &OS) const {
1107   if (!DbgNode) return;
1108
1109   StringRef Res = getName();
1110   if (!Res.empty())
1111     OS << " [" << Res << "]";
1112
1113   // TODO: Print context?
1114
1115   OS << " [line " << getLineNumber()
1116      << ", size " << getSizeInBits()
1117      << ", align " << getAlignInBits()
1118      << ", offset " << getOffsetInBits();
1119   if (isBasicType())
1120     if (const char *Enc =
1121         dwarf::AttributeEncodingString(DIBasicType(DbgNode).getEncoding()))
1122       OS << ", enc " << Enc;
1123   OS << "]";
1124
1125   if (isPrivate())
1126     OS << " [private]";
1127   else if (isProtected())
1128     OS << " [protected]";
1129
1130   if (isArtificial())
1131     OS << " [artificial]";
1132
1133   if (isForwardDecl())
1134     OS << " [decl]";
1135   else if (getTag() == dwarf::DW_TAG_structure_type ||
1136            getTag() == dwarf::DW_TAG_union_type ||
1137            getTag() == dwarf::DW_TAG_enumeration_type ||
1138            getTag() == dwarf::DW_TAG_class_type)
1139     OS << " [def]";
1140   if (isVector())
1141     OS << " [vector]";
1142   if (isStaticMember())
1143     OS << " [static]";
1144 }
1145
1146 void DIDerivedType::printInternal(raw_ostream &OS) const {
1147   DIType::printInternal(OS);
1148   OS << " [from " << getTypeDerivedFrom().getName() << ']';
1149 }
1150
1151 void DICompositeType::printInternal(raw_ostream &OS) const {
1152   DIType::printInternal(OS);
1153   DIArray A = getTypeArray();
1154   OS << " [" << A.getNumElements() << " elements]";
1155 }
1156
1157 void DINameSpace::printInternal(raw_ostream &OS) const {
1158   StringRef Name = getName();
1159   if (!Name.empty())
1160     OS << " [" << Name << ']';
1161
1162   OS << " [line " << getLineNumber() << ']';
1163 }
1164
1165 void DISubprogram::printInternal(raw_ostream &OS) const {
1166   // TODO : Print context
1167   OS << " [line " << getLineNumber() << ']';
1168
1169   if (isLocalToUnit())
1170     OS << " [local]";
1171
1172   if (isDefinition())
1173     OS << " [def]";
1174
1175   if (getScopeLineNumber() != getLineNumber())
1176     OS << " [scope " << getScopeLineNumber() << "]";
1177
1178   if (isPrivate())
1179     OS << " [private]";
1180   else if (isProtected())
1181     OS << " [protected]";
1182
1183   StringRef Res = getName();
1184   if (!Res.empty())
1185     OS << " [" << Res << ']';
1186 }
1187
1188 void DIGlobalVariable::printInternal(raw_ostream &OS) const {
1189   StringRef Res = getName();
1190   if (!Res.empty())
1191     OS << " [" << Res << ']';
1192
1193   OS << " [line " << getLineNumber() << ']';
1194
1195   // TODO : Print context
1196
1197   if (isLocalToUnit())
1198     OS << " [local]";
1199
1200   if (isDefinition())
1201     OS << " [def]";
1202 }
1203
1204 void DIVariable::printInternal(raw_ostream &OS) const {
1205   StringRef Res = getName();
1206   if (!Res.empty())
1207     OS << " [" << Res << ']';
1208
1209   OS << " [line " << getLineNumber() << ']';
1210 }
1211
1212 void DIObjCProperty::printInternal(raw_ostream &OS) const {
1213   StringRef Name = getObjCPropertyName();
1214   if (!Name.empty())
1215     OS << " [" << Name << ']';
1216
1217   OS << " [line " << getLineNumber()
1218      << ", properties " << getUnsignedField(6) << ']';
1219 }
1220
1221 static void printDebugLoc(DebugLoc DL, raw_ostream &CommentOS,
1222                           const LLVMContext &Ctx) {
1223   if (!DL.isUnknown()) {          // Print source line info.
1224     DIScope Scope(DL.getScope(Ctx));
1225     assert(Scope.isScope() &&
1226       "Scope of a DebugLoc should be a DIScope.");
1227     // Omit the directory, because it's likely to be long and uninteresting.
1228     CommentOS << Scope.getFilename();
1229     CommentOS << ':' << DL.getLine();
1230     if (DL.getCol() != 0)
1231       CommentOS << ':' << DL.getCol();
1232     DebugLoc InlinedAtDL = DebugLoc::getFromDILocation(DL.getInlinedAt(Ctx));
1233     if (!InlinedAtDL.isUnknown()) {
1234       CommentOS << " @[ ";
1235       printDebugLoc(InlinedAtDL, CommentOS, Ctx);
1236       CommentOS << " ]";
1237     }
1238   }
1239 }
1240
1241 void DIVariable::printExtendedName(raw_ostream &OS) const {
1242   const LLVMContext &Ctx = DbgNode->getContext();
1243   StringRef Res = getName();
1244   if (!Res.empty())
1245     OS << Res << "," << getLineNumber();
1246   if (MDNode *InlinedAt = getInlinedAt()) {
1247     DebugLoc InlinedAtDL = DebugLoc::getFromDILocation(InlinedAt);
1248     if (!InlinedAtDL.isUnknown()) {
1249       OS << " @[";
1250       printDebugLoc(InlinedAtDL, OS, Ctx);
1251       OS << "]";
1252     }
1253   }
1254 }