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