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