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