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