PR14606: Debug Info for namespace aliases/DW_TAG_imported_module
[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 }
297
298 /// isCompileUnit - Return true if the specified tag is DW_TAG_compile_unit.
299 bool DIDescriptor::isCompileUnit() const {
300   return DbgNode && getTag() == dwarf::DW_TAG_compile_unit;
301 }
302
303 /// isFile - Return true if the specified tag is DW_TAG_file_type.
304 bool DIDescriptor::isFile() const {
305   return DbgNode && getTag() == dwarf::DW_TAG_file_type;
306 }
307
308 /// isNameSpace - Return true if the specified tag is DW_TAG_namespace.
309 bool DIDescriptor::isNameSpace() const {
310   return DbgNode && getTag() == dwarf::DW_TAG_namespace;
311 }
312
313 /// isLexicalBlockFile - Return true if the specified descriptor is a
314 /// lexical block with an extra file.
315 bool DIDescriptor::isLexicalBlockFile() const {
316   return DbgNode && getTag() == dwarf::DW_TAG_lexical_block &&
317     (DbgNode->getNumOperands() == 3);
318 }
319
320 /// isLexicalBlock - Return true if the specified tag is DW_TAG_lexical_block.
321 bool DIDescriptor::isLexicalBlock() const {
322   return DbgNode && getTag() == dwarf::DW_TAG_lexical_block &&
323     (DbgNode->getNumOperands() > 3);
324 }
325
326 /// isSubrange - Return true if the specified tag is DW_TAG_subrange_type.
327 bool DIDescriptor::isSubrange() const {
328   return DbgNode && getTag() == dwarf::DW_TAG_subrange_type;
329 }
330
331 /// isEnumerator - Return true if the specified tag is DW_TAG_enumerator.
332 bool DIDescriptor::isEnumerator() const {
333   return DbgNode && getTag() == dwarf::DW_TAG_enumerator;
334 }
335
336 /// isObjCProperty - Return true if the specified tag is DW_TAG_APPLE_property.
337 bool DIDescriptor::isObjCProperty() const {
338   return DbgNode && getTag() == dwarf::DW_TAG_APPLE_property;
339 }
340
341 /// \brief Return true if the specified tag is DW_TAG_imported_module or
342 /// DW_TAG_imported_declaration.
343 bool DIDescriptor::isImportedEntity() const {
344   return DbgNode && (getTag() == dwarf::DW_TAG_imported_module ||
345                      getTag() == dwarf::DW_TAG_imported_declaration);
346 }
347
348 //===----------------------------------------------------------------------===//
349 // Simple Descriptor Constructors and other Methods
350 //===----------------------------------------------------------------------===//
351
352 DIType::DIType(const MDNode *N) : DIScope(N) {
353   if (!N) return;
354   if (!isBasicType() && !isDerivedType() && !isCompositeType()) {
355     DbgNode = 0;
356   }
357 }
358
359 unsigned DIArray::getNumElements() const {
360   if (!DbgNode)
361     return 0;
362   return DbgNode->getNumOperands();
363 }
364
365 /// replaceAllUsesWith - Replace all uses of debug info referenced by
366 /// this descriptor.
367 void DIType::replaceAllUsesWith(DIDescriptor &D) {
368   if (!DbgNode)
369     return;
370
371   // Since we use a TrackingVH for the node, its easy for clients to manufacture
372   // legitimate situations where they want to replaceAllUsesWith() on something
373   // which, due to uniquing, has merged with the source. We shield clients from
374   // this detail by allowing a value to be replaced with replaceAllUsesWith()
375   // itself.
376   if (DbgNode != D) {
377     MDNode *Node = const_cast<MDNode*>(DbgNode);
378     const MDNode *DN = D;
379     const Value *V = cast_or_null<Value>(DN);
380     Node->replaceAllUsesWith(const_cast<Value*>(V));
381     MDNode::deleteTemporary(Node);
382   }
383 }
384
385 /// replaceAllUsesWith - Replace all uses of debug info referenced by
386 /// this descriptor.
387 void DIType::replaceAllUsesWith(MDNode *D) {
388   if (!DbgNode)
389     return;
390
391   // Since we use a TrackingVH for the node, its easy for clients to manufacture
392   // legitimate situations where they want to replaceAllUsesWith() on something
393   // which, due to uniquing, has merged with the source. We shield clients from
394   // this detail by allowing a value to be replaced with replaceAllUsesWith()
395   // itself.
396   if (DbgNode != D) {
397     MDNode *Node = const_cast<MDNode*>(DbgNode);
398     const MDNode *DN = D;
399     const Value *V = cast_or_null<Value>(DN);
400     Node->replaceAllUsesWith(const_cast<Value*>(V));
401     MDNode::deleteTemporary(Node);
402   }
403 }
404
405 /// isUnsignedDIType - Return true if type encoding is unsigned.
406 bool DIType::isUnsignedDIType() {
407   DIDerivedType DTy(DbgNode);
408   if (DTy.Verify())
409     return DTy.getTypeDerivedFrom().isUnsignedDIType();
410
411   DIBasicType BTy(DbgNode);
412   if (BTy.Verify()) {
413     unsigned Encoding = BTy.getEncoding();
414     if (Encoding == dwarf::DW_ATE_unsigned ||
415         Encoding == dwarf::DW_ATE_unsigned_char ||
416         Encoding == dwarf::DW_ATE_boolean)
417       return true;
418   }
419   return false;
420 }
421
422 /// Verify - Verify that a compile unit is well formed.
423 bool DICompileUnit::Verify() const {
424   if (!isCompileUnit())
425     return false;
426   StringRef N = getFilename();
427   if (N.empty())
428     return false;
429   // It is possible that directory and produce string is empty.
430   return DbgNode->getNumOperands() == 13;
431 }
432
433 /// Verify - Verify that an ObjC property is well formed.
434 bool DIObjCProperty::Verify() const {
435   if (!isObjCProperty())
436     return false;
437
438   DIType Ty = getType();
439   if (!Ty.Verify()) return false;
440
441   // Don't worry about the rest of the strings for now.
442   return DbgNode->getNumOperands() == 8;
443 }
444
445 /// Verify - Verify that a type descriptor is well formed.
446 bool DIType::Verify() const {
447   if (!isType())
448     return false;
449   if (getContext() && !getContext().Verify())
450     return false;
451   unsigned Tag = getTag();
452   if (!isBasicType() && Tag != dwarf::DW_TAG_const_type &&
453       Tag != dwarf::DW_TAG_volatile_type && Tag != dwarf::DW_TAG_pointer_type &&
454       Tag != dwarf::DW_TAG_ptr_to_member_type &&
455       Tag != dwarf::DW_TAG_reference_type &&
456       Tag != dwarf::DW_TAG_rvalue_reference_type &&
457       Tag != dwarf::DW_TAG_restrict_type &&
458       Tag != dwarf::DW_TAG_array_type &&
459       Tag != dwarf::DW_TAG_enumeration_type &&
460       Tag != dwarf::DW_TAG_subroutine_type &&
461       getFilename().empty())
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   if (getContext() && !getContext().Verify())
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   if (getContext() && !getContext().Verify())
493     return false;
494
495   DICompositeType Ty = getType();
496   if (!Ty.Verify())
497     return false;
498   return DbgNode->getNumOperands() == 20;
499 }
500
501 /// Verify - Verify that a global variable descriptor is well formed.
502 bool DIGlobalVariable::Verify() const {
503   if (!isGlobalVariable())
504     return false;
505
506   if (getDisplayName().empty())
507     return false;
508
509   if (getContext() && !getContext().Verify())
510     return false;
511
512   DIType Ty = getType();
513   if (!Ty.Verify())
514     return false;
515
516   if (!getGlobal() && !getConstant())
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 /// fixupObjcLikeName - Replace contains special characters used
769 /// in a typical Objective-C names with '.' in a given string.
770 static void fixupObjcLikeName(StringRef Str, SmallVectorImpl<char> &Out) {
771   bool isObjCLike = false;
772   for (size_t i = 0, e = Str.size(); i < e; ++i) {
773     char C = Str[i];
774     if (C == '[')
775       isObjCLike = true;
776
777     if (isObjCLike && (C == '[' || C == ']' || C == ' ' || C == ':' ||
778                        C == '+' || C == '(' || C == ')'))
779       Out.push_back('.');
780     else
781       Out.push_back(C);
782   }
783 }
784
785 /// getFnSpecificMDNode - Return a NameMDNode, if available, that is
786 /// suitable to hold function specific information.
787 NamedMDNode *llvm::getFnSpecificMDNode(const Module &M, DISubprogram Fn) {
788   SmallString<32> Name = StringRef("llvm.dbg.lv.");
789   StringRef FName = "fn";
790   if (Fn.getFunction())
791     FName = Fn.getFunction()->getName();
792   else
793     FName = Fn.getName();
794   char One = '\1';
795   if (FName.startswith(StringRef(&One, 1)))
796     FName = FName.substr(1);
797   fixupObjcLikeName(FName, 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 = StringRef("llvm.dbg.lv.");
805   StringRef FName = "fn";
806   if (Fn.getFunction())
807     FName = Fn.getFunction()->getName();
808   else
809     FName = Fn.getName();
810   char One = '\1';
811   if (FName.startswith(StringRef(&One, 1)))
812     FName = FName.substr(1);
813   fixupObjcLikeName(FName, Name);
814
815   return M.getOrInsertNamedMetadata(Name.str());
816 }
817
818 /// createInlinedVariable - Create a new inlined variable based on current
819 /// variable.
820 /// @param DV            Current Variable.
821 /// @param InlinedScope  Location at current variable is inlined.
822 DIVariable llvm::createInlinedVariable(MDNode *DV, MDNode *InlinedScope,
823                                        LLVMContext &VMContext) {
824   SmallVector<Value *, 16> Elts;
825   // Insert inlined scope as 7th element.
826   for (unsigned i = 0, e = DV->getNumOperands(); i != e; ++i)
827     i == 7 ? Elts.push_back(InlinedScope) :
828              Elts.push_back(DV->getOperand(i));
829   return DIVariable(MDNode::get(VMContext, Elts));
830 }
831
832 /// cleanseInlinedVariable - Remove inlined scope from the variable.
833 DIVariable llvm::cleanseInlinedVariable(MDNode *DV, LLVMContext &VMContext) {
834   SmallVector<Value *, 16> Elts;
835   // Insert inlined scope as 7th element.
836   for (unsigned i = 0, e = DV->getNumOperands(); i != e; ++i)
837     i == 7 ?
838       Elts.push_back(Constant::getNullValue(Type::getInt32Ty(VMContext))):
839       Elts.push_back(DV->getOperand(i));
840   return DIVariable(MDNode::get(VMContext, Elts));
841 }
842
843 /// getDISubprogram - Find subprogram that is enclosing this scope.
844 DISubprogram llvm::getDISubprogram(const MDNode *Scope) {
845   DIDescriptor D(Scope);
846   if (D.isSubprogram())
847     return DISubprogram(Scope);
848
849   if (D.isLexicalBlockFile())
850     return getDISubprogram(DILexicalBlockFile(Scope).getContext());
851
852   if (D.isLexicalBlock())
853     return getDISubprogram(DILexicalBlock(Scope).getContext());
854
855   return DISubprogram();
856 }
857
858 /// getDICompositeType - Find underlying composite type.
859 DICompositeType llvm::getDICompositeType(DIType T) {
860   if (T.isCompositeType())
861     return DICompositeType(T);
862
863   if (T.isDerivedType())
864     return getDICompositeType(DIDerivedType(T).getTypeDerivedFrom());
865
866   return DICompositeType();
867 }
868
869 /// isSubprogramContext - Return true if Context is either a subprogram
870 /// or another context nested inside a subprogram.
871 bool llvm::isSubprogramContext(const MDNode *Context) {
872   if (!Context)
873     return false;
874   DIDescriptor D(Context);
875   if (D.isSubprogram())
876     return true;
877   if (D.isType())
878     return isSubprogramContext(DIType(Context).getContext());
879   return false;
880 }
881
882 //===----------------------------------------------------------------------===//
883 // DebugInfoFinder implementations.
884 //===----------------------------------------------------------------------===//
885
886 /// processModule - Process entire module and collect debug info.
887 void DebugInfoFinder::processModule(const Module &M) {
888   if (NamedMDNode *CU_Nodes = M.getNamedMetadata("llvm.dbg.cu")) {
889     for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
890       DICompileUnit CU(CU_Nodes->getOperand(i));
891       addCompileUnit(CU);
892       DIArray GVs = CU.getGlobalVariables();
893       for (unsigned i = 0, e = GVs.getNumElements(); i != e; ++i) {
894         DIGlobalVariable DIG(GVs.getElement(i));
895         if (addGlobalVariable(DIG))
896           processType(DIG.getType());
897       }
898       DIArray SPs = CU.getSubprograms();
899       for (unsigned i = 0, e = SPs.getNumElements(); i != e; ++i)
900         processSubprogram(DISubprogram(SPs.getElement(i)));
901       DIArray EnumTypes = CU.getEnumTypes();
902       for (unsigned i = 0, e = EnumTypes.getNumElements(); i != e; ++i)
903         processType(DIType(EnumTypes.getElement(i)));
904       DIArray RetainedTypes = CU.getRetainedTypes();
905       for (unsigned i = 0, e = RetainedTypes.getNumElements(); i != e; ++i)
906         processType(DIType(RetainedTypes.getElement(i)));
907       // FIXME: We really shouldn't be bailing out after visiting just one CU
908       return;
909     }
910   }
911 }
912
913 /// processLocation - Process DILocation.
914 void DebugInfoFinder::processLocation(DILocation Loc) {
915   if (!Loc.Verify()) return;
916   DIDescriptor S(Loc.getScope());
917   if (S.isCompileUnit())
918     addCompileUnit(DICompileUnit(S));
919   else if (S.isSubprogram())
920     processSubprogram(DISubprogram(S));
921   else if (S.isLexicalBlock())
922     processLexicalBlock(DILexicalBlock(S));
923   else if (S.isLexicalBlockFile()) {
924     DILexicalBlockFile DBF = DILexicalBlockFile(S);
925     processLexicalBlock(DILexicalBlock(DBF.getScope()));
926   }
927   processLocation(Loc.getOrigLocation());
928 }
929
930 /// processType - Process DIType.
931 void DebugInfoFinder::processType(DIType DT) {
932   if (!addType(DT))
933     return;
934   if (DT.isCompositeType()) {
935     DICompositeType DCT(DT);
936     processType(DCT.getTypeDerivedFrom());
937     DIArray DA = DCT.getTypeArray();
938     for (unsigned i = 0, e = DA.getNumElements(); i != e; ++i) {
939       DIDescriptor D = DA.getElement(i);
940       if (D.isType())
941         processType(DIType(D));
942       else if (D.isSubprogram())
943         processSubprogram(DISubprogram(D));
944     }
945   } else if (DT.isDerivedType()) {
946     DIDerivedType DDT(DT);
947     processType(DDT.getTypeDerivedFrom());
948   }
949 }
950
951 /// processLexicalBlock
952 void DebugInfoFinder::processLexicalBlock(DILexicalBlock LB) {
953   DIScope Context = LB.getContext();
954   if (Context.isLexicalBlock())
955     return processLexicalBlock(DILexicalBlock(Context));
956   else if (Context.isLexicalBlockFile()) {
957     DILexicalBlockFile DBF = DILexicalBlockFile(Context);
958     return processLexicalBlock(DILexicalBlock(DBF.getScope()));
959   }
960   else
961     return processSubprogram(DISubprogram(Context));
962 }
963
964 /// processSubprogram - Process DISubprogram.
965 void DebugInfoFinder::processSubprogram(DISubprogram SP) {
966   if (!addSubprogram(SP))
967     return;
968   processType(SP.getType());
969 }
970
971 /// processDeclare - Process DbgDeclareInst.
972 void DebugInfoFinder::processDeclare(const DbgDeclareInst *DDI) {
973   MDNode *N = dyn_cast<MDNode>(DDI->getVariable());
974   if (!N) return;
975
976   DIDescriptor DV(N);
977   if (!DV.isVariable())
978     return;
979
980   if (!NodesSeen.insert(DV))
981     return;
982   processType(DIVariable(N).getType());
983 }
984
985 /// addType - Add type into Tys.
986 bool DebugInfoFinder::addType(DIType DT) {
987   if (!DT.isValid())
988     return false;
989
990   if (!NodesSeen.insert(DT))
991     return false;
992
993   TYs.push_back(DT);
994   return true;
995 }
996
997 /// addCompileUnit - Add compile unit into CUs.
998 bool DebugInfoFinder::addCompileUnit(DICompileUnit CU) {
999   if (!CU.Verify())
1000     return false;
1001
1002   if (!NodesSeen.insert(CU))
1003     return false;
1004
1005   CUs.push_back(CU);
1006   return true;
1007 }
1008
1009 /// addGlobalVariable - Add global variable into GVs.
1010 bool DebugInfoFinder::addGlobalVariable(DIGlobalVariable DIG) {
1011   if (!DIDescriptor(DIG).isGlobalVariable())
1012     return false;
1013
1014   if (!NodesSeen.insert(DIG))
1015     return false;
1016
1017   GVs.push_back(DIG);
1018   return true;
1019 }
1020
1021 // addSubprogram - Add subprgoram into SPs.
1022 bool DebugInfoFinder::addSubprogram(DISubprogram SP) {
1023   if (!DIDescriptor(SP).isSubprogram())
1024     return false;
1025
1026   if (!NodesSeen.insert(SP))
1027     return false;
1028
1029   SPs.push_back(SP);
1030   return true;
1031 }
1032
1033 //===----------------------------------------------------------------------===//
1034 // DIDescriptor: dump routines for all descriptors.
1035 //===----------------------------------------------------------------------===//
1036
1037 /// dump - Print descriptor to dbgs() with a newline.
1038 void DIDescriptor::dump() const {
1039   print(dbgs()); dbgs() << '\n';
1040 }
1041
1042 /// print - Print descriptor.
1043 void DIDescriptor::print(raw_ostream &OS) const {
1044   if (!DbgNode) return;
1045
1046   if (const char *Tag = dwarf::TagString(getTag()))
1047     OS << "[ " << Tag << " ]";
1048
1049   if (this->isSubrange()) {
1050     DISubrange(DbgNode).printInternal(OS);
1051   } else if (this->isCompileUnit()) {
1052     DICompileUnit(DbgNode).printInternal(OS);
1053   } else if (this->isFile()) {
1054     DIFile(DbgNode).printInternal(OS);
1055   } else if (this->isEnumerator()) {
1056     DIEnumerator(DbgNode).printInternal(OS);
1057   } else if (this->isBasicType()) {
1058     DIType(DbgNode).printInternal(OS);
1059   } else if (this->isDerivedType()) {
1060     DIDerivedType(DbgNode).printInternal(OS);
1061   } else if (this->isCompositeType()) {
1062     DICompositeType(DbgNode).printInternal(OS);
1063   } else if (this->isSubprogram()) {
1064     DISubprogram(DbgNode).printInternal(OS);
1065   } else if (this->isGlobalVariable()) {
1066     DIGlobalVariable(DbgNode).printInternal(OS);
1067   } else if (this->isVariable()) {
1068     DIVariable(DbgNode).printInternal(OS);
1069   } else if (this->isObjCProperty()) {
1070     DIObjCProperty(DbgNode).printInternal(OS);
1071   } else if (this->isNameSpace()) {
1072     DINameSpace(DbgNode).printInternal(OS);
1073   } else if (this->isScope()) {
1074     DIScope(DbgNode).printInternal(OS);
1075   }
1076 }
1077
1078 void DISubrange::printInternal(raw_ostream &OS) const {
1079   int64_t Count = getCount();
1080   if (Count != -1)
1081     OS << " [" << getLo() << ", " << Count - 1 << ']';
1082   else
1083     OS << " [unbounded]";
1084 }
1085
1086 void DIScope::printInternal(raw_ostream &OS) const {
1087   OS << " [" << getDirectory() << "/" << getFilename() << ']';
1088 }
1089
1090 void DICompileUnit::printInternal(raw_ostream &OS) const {
1091   DIScope::printInternal(OS);
1092   OS << " [";
1093   unsigned Lang = getLanguage();
1094   if (const char *LangStr = dwarf::LanguageString(Lang))
1095     OS << LangStr;
1096   else
1097     (OS << "lang 0x").write_hex(Lang);
1098   OS << ']';
1099 }
1100
1101 void DIEnumerator::printInternal(raw_ostream &OS) const {
1102   OS << " [" << getName() << " :: " << getEnumValue() << ']';
1103 }
1104
1105 void DIType::printInternal(raw_ostream &OS) const {
1106   if (!DbgNode) return;
1107
1108   StringRef Res = getName();
1109   if (!Res.empty())
1110     OS << " [" << Res << "]";
1111
1112   // TODO: Print context?
1113
1114   OS << " [line " << getLineNumber()
1115      << ", size " << getSizeInBits()
1116      << ", align " << getAlignInBits()
1117      << ", offset " << getOffsetInBits();
1118   if (isBasicType())
1119     if (const char *Enc =
1120         dwarf::AttributeEncodingString(DIBasicType(DbgNode).getEncoding()))
1121       OS << ", enc " << Enc;
1122   OS << "]";
1123
1124   if (isPrivate())
1125     OS << " [private]";
1126   else if (isProtected())
1127     OS << " [protected]";
1128
1129   if (isArtificial())
1130     OS << " [artificial]";
1131
1132   if (isForwardDecl())
1133     OS << " [fwd]";
1134   if (isVector())
1135     OS << " [vector]";
1136   if (isStaticMember())
1137     OS << " [static]";
1138 }
1139
1140 void DIDerivedType::printInternal(raw_ostream &OS) const {
1141   DIType::printInternal(OS);
1142   OS << " [from " << getTypeDerivedFrom().getName() << ']';
1143 }
1144
1145 void DICompositeType::printInternal(raw_ostream &OS) const {
1146   DIType::printInternal(OS);
1147   DIArray A = getTypeArray();
1148   OS << " [" << A.getNumElements() << " elements]";
1149 }
1150
1151 void DINameSpace::printInternal(raw_ostream &OS) const {
1152   StringRef Name = getName();
1153   if (!Name.empty())
1154     OS << " [" << Name << ']';
1155
1156   OS << " [line " << getLineNumber() << ']';
1157 }
1158
1159 void DISubprogram::printInternal(raw_ostream &OS) const {
1160   // TODO : Print context
1161   OS << " [line " << getLineNumber() << ']';
1162
1163   if (isLocalToUnit())
1164     OS << " [local]";
1165
1166   if (isDefinition())
1167     OS << " [def]";
1168
1169   if (getScopeLineNumber() != getLineNumber())
1170     OS << " [scope " << getScopeLineNumber() << "]";
1171
1172   if (isPrivate())
1173     OS << " [private]";
1174   else if (isProtected())
1175     OS << " [protected]";
1176
1177   StringRef Res = getName();
1178   if (!Res.empty())
1179     OS << " [" << Res << ']';
1180 }
1181
1182 void DIGlobalVariable::printInternal(raw_ostream &OS) const {
1183   StringRef Res = getName();
1184   if (!Res.empty())
1185     OS << " [" << Res << ']';
1186
1187   OS << " [line " << getLineNumber() << ']';
1188
1189   // TODO : Print context
1190
1191   if (isLocalToUnit())
1192     OS << " [local]";
1193
1194   if (isDefinition())
1195     OS << " [def]";
1196 }
1197
1198 void DIVariable::printInternal(raw_ostream &OS) const {
1199   StringRef Res = getName();
1200   if (!Res.empty())
1201     OS << " [" << Res << ']';
1202
1203   OS << " [line " << getLineNumber() << ']';
1204 }
1205
1206 void DIObjCProperty::printInternal(raw_ostream &OS) const {
1207   StringRef Name = getObjCPropertyName();
1208   if (!Name.empty())
1209     OS << " [" << Name << ']';
1210
1211   OS << " [line " << getLineNumber()
1212      << ", properties " << getUnsignedField(6) << ']';
1213 }
1214
1215 static void printDebugLoc(DebugLoc DL, raw_ostream &CommentOS,
1216                           const LLVMContext &Ctx) {
1217   if (!DL.isUnknown()) {          // Print source line info.
1218     DIScope Scope(DL.getScope(Ctx));
1219     // Omit the directory, because it's likely to be long and uninteresting.
1220     if (Scope.Verify())
1221       CommentOS << Scope.getFilename();
1222     else
1223       CommentOS << "<unknown>";
1224     CommentOS << ':' << DL.getLine();
1225     if (DL.getCol() != 0)
1226       CommentOS << ':' << DL.getCol();
1227     DebugLoc InlinedAtDL = DebugLoc::getFromDILocation(DL.getInlinedAt(Ctx));
1228     if (!InlinedAtDL.isUnknown()) {
1229       CommentOS << " @[ ";
1230       printDebugLoc(InlinedAtDL, CommentOS, Ctx);
1231       CommentOS << " ]";
1232     }
1233   }
1234 }
1235
1236 void DIVariable::printExtendedName(raw_ostream &OS) const {
1237   const LLVMContext &Ctx = DbgNode->getContext();
1238   StringRef Res = getName();
1239   if (!Res.empty())
1240     OS << Res << "," << getLineNumber();
1241   if (MDNode *InlinedAt = getInlinedAt()) {
1242     DebugLoc InlinedAtDL = DebugLoc::getFromDILocation(InlinedAt);
1243     if (!InlinedAtDL.isUnknown()) {
1244       OS << " @[";
1245       printDebugLoc(InlinedAtDL, OS, Ctx);
1246       OS << "]";
1247     }
1248   }
1249 }