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