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