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/ValueHandle.h"
29 #include "llvm/Support/raw_ostream.h"
30 using namespace llvm;
31 using namespace llvm::dwarf;
33 //===----------------------------------------------------------------------===//
34 // DIDescriptor
35 //===----------------------------------------------------------------------===//
37 bool DIDescriptor::Verify() const {
38 return DbgNode &&
39 (DIDerivedType(DbgNode).Verify() ||
40 DICompositeType(DbgNode).Verify() || DIBasicType(DbgNode).Verify() ||
41 DIVariable(DbgNode).Verify() || DISubprogram(DbgNode).Verify() ||
42 DIGlobalVariable(DbgNode).Verify() || DIFile(DbgNode).Verify() ||
43 DICompileUnit(DbgNode).Verify() || DINameSpace(DbgNode).Verify() ||
44 DILexicalBlock(DbgNode).Verify() ||
45 DILexicalBlockFile(DbgNode).Verify() ||
46 DISubrange(DbgNode).Verify() || DIEnumerator(DbgNode).Verify() ||
47 DIObjCProperty(DbgNode).Verify() ||
48 DITemplateTypeParameter(DbgNode).Verify() ||
49 DITemplateValueParameter(DbgNode).Verify() ||
50 DIImportedEntity(DbgNode).Verify());
51 }
53 static Value *getField(const MDNode *DbgNode, unsigned Elt) {
54 if (DbgNode == 0 || Elt >= DbgNode->getNumOperands())
55 return 0;
56 return DbgNode->getOperand(Elt);
57 }
59 static MDNode *getNodeField(const MDNode *DbgNode, unsigned Elt) {
60 return dyn_cast_or_null<MDNode>(getField(DbgNode, Elt));
61 }
63 static StringRef getStringField(const MDNode *DbgNode, unsigned Elt) {
64 if (MDString *MDS = dyn_cast_or_null<MDString>(getField(DbgNode, Elt)))
65 return MDS->getString();
66 return StringRef();
67 }
69 StringRef DIDescriptor::getStringField(unsigned Elt) const {
70 return ::getStringField(DbgNode, Elt);
71 }
73 uint64_t DIDescriptor::getUInt64Field(unsigned Elt) const {
74 if (DbgNode == 0)
75 return 0;
77 if (Elt < DbgNode->getNumOperands())
78 if (ConstantInt *CI
79 = dyn_cast_or_null<ConstantInt>(DbgNode->getOperand(Elt)))
80 return CI->getZExtValue();
82 return 0;
83 }
85 int64_t DIDescriptor::getInt64Field(unsigned Elt) const {
86 if (DbgNode == 0)
87 return 0;
89 if (Elt < DbgNode->getNumOperands())
90 if (ConstantInt *CI
91 = dyn_cast_or_null<ConstantInt>(DbgNode->getOperand(Elt)))
92 return CI->getSExtValue();
94 return 0;
95 }
97 DIDescriptor DIDescriptor::getDescriptorField(unsigned Elt) const {
98 MDNode *Field = getNodeField(DbgNode, Elt);
99 return DIDescriptor(Field);
100 }
102 GlobalVariable *DIDescriptor::getGlobalVariableField(unsigned Elt) const {
103 if (DbgNode == 0)
104 return 0;
106 if (Elt < DbgNode->getNumOperands())
107 return dyn_cast_or_null<GlobalVariable>(DbgNode->getOperand(Elt));
108 return 0;
109 }
111 Constant *DIDescriptor::getConstantField(unsigned Elt) const {
112 if (DbgNode == 0)
113 return 0;
115 if (Elt < DbgNode->getNumOperands())
116 return dyn_cast_or_null<Constant>(DbgNode->getOperand(Elt));
117 return 0;
118 }
120 Function *DIDescriptor::getFunctionField(unsigned Elt) const {
121 if (DbgNode == 0)
122 return 0;
124 if (Elt < DbgNode->getNumOperands())
125 return dyn_cast_or_null<Function>(DbgNode->getOperand(Elt));
126 return 0;
127 }
129 void DIDescriptor::replaceFunctionField(unsigned Elt, Function *F) {
130 if (DbgNode == 0)
131 return;
133 if (Elt < DbgNode->getNumOperands()) {
134 MDNode *Node = const_cast<MDNode*>(DbgNode);
135 Node->replaceOperandWith(Elt, F);
136 }
137 }
139 unsigned DIVariable::getNumAddrElements() const {
140 return DbgNode->getNumOperands()-8;
141 }
143 /// getInlinedAt - If this variable is inlined then return inline location.
144 MDNode *DIVariable::getInlinedAt() const {
145 return getNodeField(DbgNode, 7);
146 }
148 //===----------------------------------------------------------------------===//
149 // Predicates
150 //===----------------------------------------------------------------------===//
152 /// isBasicType - Return true if the specified tag is legal for
153 /// DIBasicType.
154 bool DIDescriptor::isBasicType() const {
155 if (!DbgNode) return false;
156 switch (getTag()) {
157 case dwarf::DW_TAG_base_type:
158 case dwarf::DW_TAG_unspecified_type:
159 return true;
160 default:
161 return false;
162 }
163 }
165 /// isDerivedType - Return true if the specified tag is legal for DIDerivedType.
166 bool DIDescriptor::isDerivedType() const {
167 if (!DbgNode) return false;
168 switch (getTag()) {
169 case dwarf::DW_TAG_typedef:
170 case dwarf::DW_TAG_pointer_type:
171 case dwarf::DW_TAG_ptr_to_member_type:
172 case dwarf::DW_TAG_reference_type:
173 case dwarf::DW_TAG_rvalue_reference_type:
174 case dwarf::DW_TAG_const_type:
175 case dwarf::DW_TAG_volatile_type:
176 case dwarf::DW_TAG_restrict_type:
177 case dwarf::DW_TAG_member:
178 case dwarf::DW_TAG_inheritance:
179 case dwarf::DW_TAG_friend:
180 return true;
181 default:
182 // CompositeTypes are currently modelled as DerivedTypes.
183 return isCompositeType();
184 }
185 }
187 /// isCompositeType - Return true if the specified tag is legal for
188 /// DICompositeType.
189 bool DIDescriptor::isCompositeType() const {
190 if (!DbgNode) return false;
191 switch (getTag()) {
192 case dwarf::DW_TAG_array_type:
193 case dwarf::DW_TAG_structure_type:
194 case dwarf::DW_TAG_union_type:
195 case dwarf::DW_TAG_enumeration_type:
196 case dwarf::DW_TAG_subroutine_type:
197 case dwarf::DW_TAG_class_type:
198 return true;
199 default:
200 return false;
201 }
202 }
204 /// isVariable - Return true if the specified tag is legal for DIVariable.
205 bool DIDescriptor::isVariable() const {
206 if (!DbgNode) return false;
207 switch (getTag()) {
208 case dwarf::DW_TAG_auto_variable:
209 case dwarf::DW_TAG_arg_variable:
210 return true;
211 default:
212 return false;
213 }
214 }
216 /// isType - Return true if the specified tag is legal for DIType.
217 bool DIDescriptor::isType() const {
218 return isBasicType() || isCompositeType() || isDerivedType();
219 }
221 /// isSubprogram - Return true if the specified tag is legal for
222 /// DISubprogram.
223 bool DIDescriptor::isSubprogram() const {
224 return DbgNode && getTag() == dwarf::DW_TAG_subprogram;
225 }
227 /// isGlobalVariable - Return true if the specified tag is legal for
228 /// DIGlobalVariable.
229 bool DIDescriptor::isGlobalVariable() const {
230 return DbgNode && (getTag() == dwarf::DW_TAG_variable ||
231 getTag() == dwarf::DW_TAG_constant);
232 }
234 /// isUnspecifiedParmeter - Return true if the specified tag is
235 /// DW_TAG_unspecified_parameters.
236 bool DIDescriptor::isUnspecifiedParameter() const {
237 return DbgNode && getTag() == dwarf::DW_TAG_unspecified_parameters;
238 }
240 /// isScope - Return true if the specified tag is one of the scope
241 /// related tag.
242 bool DIDescriptor::isScope() const {
243 if (!DbgNode) return false;
244 switch (getTag()) {
245 case dwarf::DW_TAG_compile_unit:
246 case dwarf::DW_TAG_lexical_block:
247 case dwarf::DW_TAG_subprogram:
248 case dwarf::DW_TAG_namespace:
249 return true;
250 default:
251 break;
252 }
253 return false;
254 }
256 /// isTemplateTypeParameter - Return true if the specified tag is
257 /// DW_TAG_template_type_parameter.
258 bool DIDescriptor::isTemplateTypeParameter() const {
259 return DbgNode && getTag() == dwarf::DW_TAG_template_type_parameter;
260 }
262 /// isTemplateValueParameter - Return true if the specified tag is
263 /// DW_TAG_template_value_parameter.
264 bool DIDescriptor::isTemplateValueParameter() const {
265 return DbgNode && (getTag() == dwarf::DW_TAG_template_value_parameter ||
266 getTag() == dwarf::DW_TAG_GNU_template_template_param ||
267 getTag() == dwarf::DW_TAG_GNU_template_parameter_pack);
268 }
270 /// isCompileUnit - Return true if the specified tag is DW_TAG_compile_unit.
271 bool DIDescriptor::isCompileUnit() const {
272 return DbgNode && getTag() == dwarf::DW_TAG_compile_unit;
273 }
275 /// isFile - Return true if the specified tag is DW_TAG_file_type.
276 bool DIDescriptor::isFile() const {
277 return DbgNode && getTag() == dwarf::DW_TAG_file_type;
278 }
280 /// isNameSpace - Return true if the specified tag is DW_TAG_namespace.
281 bool DIDescriptor::isNameSpace() const {
282 return DbgNode && getTag() == dwarf::DW_TAG_namespace;
283 }
285 /// isLexicalBlockFile - Return true if the specified descriptor is a
286 /// lexical block with an extra file.
287 bool DIDescriptor::isLexicalBlockFile() const {
288 return DbgNode && getTag() == dwarf::DW_TAG_lexical_block &&
289 (DbgNode->getNumOperands() == 3);
290 }
292 /// isLexicalBlock - Return true if the specified tag is DW_TAG_lexical_block.
293 bool DIDescriptor::isLexicalBlock() const {
294 return DbgNode && getTag() == dwarf::DW_TAG_lexical_block &&
295 (DbgNode->getNumOperands() > 3);
296 }
298 /// isSubrange - Return true if the specified tag is DW_TAG_subrange_type.
299 bool DIDescriptor::isSubrange() const {
300 return DbgNode && getTag() == dwarf::DW_TAG_subrange_type;
301 }
303 /// isEnumerator - Return true if the specified tag is DW_TAG_enumerator.
304 bool DIDescriptor::isEnumerator() const {
305 return DbgNode && getTag() == dwarf::DW_TAG_enumerator;
306 }
308 /// isObjCProperty - Return true if the specified tag is DW_TAG_APPLE_property.
309 bool DIDescriptor::isObjCProperty() const {
310 return DbgNode && getTag() == dwarf::DW_TAG_APPLE_property;
311 }
313 /// \brief Return true if the specified tag is DW_TAG_imported_module or
314 /// DW_TAG_imported_declaration.
315 bool DIDescriptor::isImportedEntity() const {
316 return DbgNode && (getTag() == dwarf::DW_TAG_imported_module ||
317 getTag() == dwarf::DW_TAG_imported_declaration);
318 }
320 //===----------------------------------------------------------------------===//
321 // Simple Descriptor Constructors and other Methods
322 //===----------------------------------------------------------------------===//
324 unsigned DIArray::getNumElements() const {
325 if (!DbgNode)
326 return 0;
327 return DbgNode->getNumOperands();
328 }
330 /// replaceAllUsesWith - Replace all uses of the MDNode used by this
331 /// type with the one in the passed descriptor.
332 void DIType::replaceAllUsesWith(DIDescriptor &D) {
334 assert(DbgNode && "Trying to replace an unverified type!");
336 // Since we use a TrackingVH for the node, its easy for clients to manufacture
337 // legitimate situations where they want to replaceAllUsesWith() on something
338 // which, due to uniquing, has merged with the source. We shield clients from
339 // this detail by allowing a value to be replaced with replaceAllUsesWith()
340 // itself.
341 if (DbgNode != D) {
342 MDNode *Node = const_cast<MDNode*>(DbgNode);
343 const MDNode *DN = D;
344 const Value *V = cast_or_null<Value>(DN);
345 Node->replaceAllUsesWith(const_cast<Value*>(V));
346 MDNode::deleteTemporary(Node);
347 }
348 }
350 /// replaceAllUsesWith - Replace all uses of the MDNode used by this
351 /// type with the one in D.
352 void DIType::replaceAllUsesWith(MDNode *D) {
354 assert(DbgNode && "Trying to replace an unverified type!");
356 // Since we use a TrackingVH for the node, its easy for clients to manufacture
357 // legitimate situations where they want to replaceAllUsesWith() on something
358 // which, due to uniquing, has merged with the source. We shield clients from
359 // this detail by allowing a value to be replaced with replaceAllUsesWith()
360 // itself.
361 if (DbgNode != D) {
362 MDNode *Node = const_cast<MDNode*>(DbgNode);
363 const MDNode *DN = D;
364 const Value *V = cast_or_null<Value>(DN);
365 Node->replaceAllUsesWith(const_cast<Value*>(V));
366 MDNode::deleteTemporary(Node);
367 }
368 }
370 /// isUnsignedDIType - Return true if type encoding is unsigned.
371 bool DIType::isUnsignedDIType() {
372 DIDerivedType DTy(DbgNode);
373 if (DTy.Verify())
374 return DTy.getTypeDerivedFrom().isUnsignedDIType();
376 DIBasicType BTy(DbgNode);
377 if (BTy.Verify()) {
378 unsigned Encoding = BTy.getEncoding();
379 if (Encoding == dwarf::DW_ATE_unsigned ||
380 Encoding == dwarf::DW_ATE_unsigned_char ||
381 Encoding == dwarf::DW_ATE_boolean)
382 return true;
383 }
384 return false;
385 }
387 /// Verify - Verify that a compile unit is well formed.
388 bool DICompileUnit::Verify() const {
389 if (!isCompileUnit())
390 return false;
392 // Don't bother verifying the compilation directory or producer string
393 // as those could be empty.
394 if (getFilename().empty())
395 return false;
397 return DbgNode->getNumOperands() == 13;
398 }
400 /// Verify - Verify that an ObjC property is well formed.
401 bool DIObjCProperty::Verify() const {
402 if (!isObjCProperty())
403 return false;
405 // Don't worry about the rest of the strings for now.
406 return DbgNode->getNumOperands() == 8;
407 }
409 /// Check if a field at position Elt of a MDNode is a MDNode.
410 /// We currently allow an empty string and an integer.
411 /// But we don't allow a non-empty string in a MDNode field.
412 static bool fieldIsMDNode(const MDNode *DbgNode, unsigned Elt) {
413 // FIXME: This function should return true, if the field is null or the field
414 // is indeed a MDNode: return !Fld || isa<MDNode>(Fld).
415 Value *Fld = getField(DbgNode, Elt);
416 if (Fld && isa<MDString>(Fld) &&
417 !cast<MDString>(Fld)->getString().empty())
418 return false;
419 return true;
420 }
422 /// Check if a field at position Elt of a MDNode is a MDString.
423 static bool fieldIsMDString(const MDNode *DbgNode, unsigned Elt) {
424 Value *Fld = getField(DbgNode, Elt);
425 return !Fld || isa<MDString>(Fld);
426 }
428 /// Check if a value can be a TypeRef.
429 static bool isTypeRef(const Value *Val) {
430 return !Val || isa<MDString>(Val) || isa<MDNode>(Val);
431 }
433 /// Check if a field at position Elt of a MDNode can be a TypeRef.
434 static bool fieldIsTypeRef(const MDNode *DbgNode, unsigned Elt) {
435 Value *Fld = getField(DbgNode, Elt);
436 return isTypeRef(Fld);
437 }
439 /// Verify - Verify that a type descriptor is well formed.
440 bool DIType::Verify() const {
441 if (!isType())
442 return false;
443 // Make sure Context @ field 2 is MDNode.
444 if (!fieldIsMDNode(DbgNode, 2))
445 return false;
447 // FIXME: Sink this into the various subclass verifies.
448 uint16_t Tag = getTag();
449 if (!isBasicType() && Tag != dwarf::DW_TAG_const_type &&
450 Tag != dwarf::DW_TAG_volatile_type && Tag != dwarf::DW_TAG_pointer_type &&
451 Tag != dwarf::DW_TAG_ptr_to_member_type &&
452 Tag != dwarf::DW_TAG_reference_type &&
453 Tag != dwarf::DW_TAG_rvalue_reference_type &&
454 Tag != dwarf::DW_TAG_restrict_type && Tag != dwarf::DW_TAG_array_type &&
455 Tag != dwarf::DW_TAG_enumeration_type &&
456 Tag != dwarf::DW_TAG_subroutine_type &&
457 Tag != dwarf::DW_TAG_inheritance && Tag != dwarf::DW_TAG_friend &&
458 getFilename().empty())
459 return false;
460 // DIType is abstract, it should be a BasicType, a DerivedType or
461 // a CompositeType.
462 if (isBasicType())
463 DIBasicType(DbgNode).Verify();
464 else if (isCompositeType())
465 DICompositeType(DbgNode).Verify();
466 else if (isDerivedType())
467 DIDerivedType(DbgNode).Verify();
468 else
469 return false;
470 return true;
471 }
473 /// Verify - Verify that a basic type descriptor is well formed.
474 bool DIBasicType::Verify() const {
475 return isBasicType() && DbgNode->getNumOperands() == 10;
476 }
478 /// Verify - Verify that a derived type descriptor is well formed.
479 bool DIDerivedType::Verify() const {
480 // Make sure DerivedFrom @ field 9 is MDNode.
481 if (!fieldIsMDNode(DbgNode, 9))
482 return false;
483 if (getTag() == dwarf::DW_TAG_ptr_to_member_type)
484 // Make sure ClassType @ field 10 is a TypeRef.
485 if (!fieldIsTypeRef(DbgNode, 10))
486 return false;
488 return isDerivedType() && DbgNode->getNumOperands() >= 10 &&
489 DbgNode->getNumOperands() <= 14;
490 }
492 /// Verify - Verify that a composite type descriptor is well formed.
493 bool DICompositeType::Verify() const {
494 if (!isCompositeType())
495 return false;
497 // Make sure DerivedFrom @ field 9 and ContainingType @ field 12 are MDNodes.
498 if (!fieldIsMDNode(DbgNode, 9))
499 return false;
500 if (!fieldIsMDNode(DbgNode, 12))
501 return false;
503 // Make sure the type identifier at field 14 is MDString, it can be null.
504 if (!fieldIsMDString(DbgNode, 14))
505 return false;
507 // If this is an array type verify that we have a DIType in the derived type
508 // field as that's the type of our element.
509 if (getTag() == dwarf::DW_TAG_array_type)
510 if (!DIType(getTypeDerivedFrom()))
511 return false;
513 return DbgNode->getNumOperands() == 15;
514 }
516 /// Verify - Verify that a subprogram descriptor is well formed.
517 bool DISubprogram::Verify() const {
518 if (!isSubprogram())
519 return false;
521 // Make sure context @ field 2 and type @ field 7 are MDNodes.
522 if (!fieldIsMDNode(DbgNode, 2))
523 return false;
524 if (!fieldIsMDNode(DbgNode, 7))
525 return false;
526 // Containing type @ field 12.
527 if (!fieldIsMDNode(DbgNode, 12))
528 return false;
529 return DbgNode->getNumOperands() == 20;
530 }
532 /// Verify - Verify that a global variable descriptor is well formed.
533 bool DIGlobalVariable::Verify() const {
534 if (!isGlobalVariable())
535 return false;
537 if (getDisplayName().empty())
538 return false;
539 // Make sure context @ field 2 and type @ field 8 are MDNodes.
540 if (!fieldIsMDNode(DbgNode, 2))
541 return false;
542 if (!fieldIsMDNode(DbgNode, 8))
543 return false;
544 // Make sure StaticDataMemberDeclaration @ field 12 is MDNode.
545 if (!fieldIsMDNode(DbgNode, 12))
546 return false;
548 return DbgNode->getNumOperands() == 13;
549 }
551 /// Verify - Verify that a variable descriptor is well formed.
552 bool DIVariable::Verify() const {
553 if (!isVariable())
554 return false;
556 // Make sure context @ field 1 and type @ field 5 are MDNodes.
557 if (!fieldIsMDNode(DbgNode, 1))
558 return false;
559 if (!fieldIsMDNode(DbgNode, 5))
560 return false;
561 return DbgNode->getNumOperands() >= 8;
562 }
564 /// Verify - Verify that a location descriptor is well formed.
565 bool DILocation::Verify() const {
566 if (!DbgNode)
567 return false;
569 return DbgNode->getNumOperands() == 4;
570 }
572 /// Verify - Verify that a namespace descriptor is well formed.
573 bool DINameSpace::Verify() const {
574 if (!isNameSpace())
575 return false;
576 return DbgNode->getNumOperands() == 5;
577 }
579 /// \brief Retrieve the MDNode for the directory/file pair.
580 MDNode *DIFile::getFileNode() const {
581 return getNodeField(DbgNode, 1);
582 }
584 /// \brief Verify that the file descriptor is well formed.
585 bool DIFile::Verify() const {
586 return isFile() && DbgNode->getNumOperands() == 2;
587 }
589 /// \brief Verify that the enumerator descriptor is well formed.
590 bool DIEnumerator::Verify() const {
591 return isEnumerator() && DbgNode->getNumOperands() == 3;
592 }
594 /// \brief Verify that the subrange descriptor is well formed.
595 bool DISubrange::Verify() const {
596 return isSubrange() && DbgNode->getNumOperands() == 3;
597 }
599 /// \brief Verify that the lexical block descriptor is well formed.
600 bool DILexicalBlock::Verify() const {
601 return isLexicalBlock() && DbgNode->getNumOperands() == 6;
602 }
604 /// \brief Verify that the file-scoped lexical block descriptor is well formed.
605 bool DILexicalBlockFile::Verify() const {
606 return isLexicalBlockFile() && DbgNode->getNumOperands() == 3;
607 }
609 /// \brief Verify that the template type parameter descriptor is well formed.
610 bool DITemplateTypeParameter::Verify() const {
611 return isTemplateTypeParameter() && DbgNode->getNumOperands() == 7;
612 }
614 /// \brief Verify that the template value parameter descriptor is well formed.
615 bool DITemplateValueParameter::Verify() const {
616 return isTemplateValueParameter() && DbgNode->getNumOperands() == 8;
617 }
619 /// \brief Verify that the imported module descriptor is well formed.
620 bool DIImportedEntity::Verify() const {
621 return isImportedEntity() &&
622 (DbgNode->getNumOperands() == 4 || DbgNode->getNumOperands() == 5);
623 }
625 /// getOriginalTypeSize - If this type is derived from a base type then
626 /// return base type size.
627 uint64_t DIDerivedType::getOriginalTypeSize() const {
628 uint16_t Tag = getTag();
630 if (Tag != dwarf::DW_TAG_member && Tag != dwarf::DW_TAG_typedef &&
631 Tag != dwarf::DW_TAG_const_type && Tag != dwarf::DW_TAG_volatile_type &&
632 Tag != dwarf::DW_TAG_restrict_type)
633 return getSizeInBits();
635 DIType BaseType = getTypeDerivedFrom();
637 // If this type is not derived from any type then take conservative approach.
638 if (!BaseType.isValid())
639 return getSizeInBits();
641 // If this is a derived type, go ahead and get the base type, unless it's a
642 // reference then it's just the size of the field. Pointer types have no need
643 // of this since they're a different type of qualification on the type.
644 if (BaseType.getTag() == dwarf::DW_TAG_reference_type ||
645 BaseType.getTag() == dwarf::DW_TAG_rvalue_reference_type)
646 return getSizeInBits();
648 if (BaseType.isDerivedType())
649 return DIDerivedType(BaseType).getOriginalTypeSize();
651 return BaseType.getSizeInBits();
652 }
654 /// getObjCProperty - Return property node, if this ivar is associated with one.
655 MDNode *DIDerivedType::getObjCProperty() const {
656 return getNodeField(DbgNode, 10);
657 }
659 MDString *DICompositeType::getIdentifier() const {
660 return cast_or_null<MDString>(getField(DbgNode, 14));
661 }
663 #ifndef NDEBUG
664 static void VerifySubsetOf(const MDNode *LHS, const MDNode *RHS) {
665 for (unsigned i = 0; i != LHS->getNumOperands(); ++i) {
666 // Skip the 'empty' list (that's a single i32 0, rather than truly empty).
667 if (i == 0 && isa<ConstantInt>(LHS->getOperand(i)))
668 continue;
669 const MDNode *E = cast<MDNode>(LHS->getOperand(i));
670 bool found = false;
671 for (unsigned j = 0; !found && j != RHS->getNumOperands(); ++j)
672 found = E == RHS->getOperand(j);
673 assert(found && "Losing a member during member list replacement");
674 }
675 }
676 #endif
678 /// \brief Set the array of member DITypes.
679 void DICompositeType::setTypeArray(DIArray Elements, DIArray TParams) {
680 assert((!TParams || DbgNode->getNumOperands() == 15) &&
681 "If you're setting the template parameters this should include a slot "
682 "for that!");
683 TrackingVH<MDNode> N(*this);
684 if (Elements) {
685 #ifndef NDEBUG
686 // Check that the new list of members contains all the old members as well.
687 if (const MDNode *El = cast_or_null<MDNode>(N->getOperand(10)))
688 VerifySubsetOf(El, Elements);
689 #endif
690 N->replaceOperandWith(10, Elements);
691 }
692 if (TParams)
693 N->replaceOperandWith(13, TParams);
694 DbgNode = N;
695 }
697 void DICompositeType::addMember(DIDescriptor D) {
698 SmallVector<llvm::Value *, 16> M;
699 DIArray OrigM = getTypeArray();
700 unsigned Elements = OrigM.getNumElements();
701 if (Elements == 1 && !OrigM.getElement(0))
702 Elements = 0;
703 M.reserve(Elements + 1);
704 for (unsigned i = 0; i != Elements; ++i)
705 M.push_back(OrigM.getElement(i));
706 M.push_back(D);
707 setTypeArray(DIArray(MDNode::get(DbgNode->getContext(), M)));
708 }
710 /// \brief Set the containing type.
711 void DICompositeType::setContainingType(DICompositeType ContainingType) {
712 TrackingVH<MDNode> N(*this);
713 N->replaceOperandWith(12, ContainingType);
714 DbgNode = N;
715 }
717 /// isInlinedFnArgument - Return true if this variable provides debugging
718 /// information for an inlined function arguments.
719 bool DIVariable::isInlinedFnArgument(const Function *CurFn) {
720 assert(CurFn && "Invalid function");
721 if (!getContext().isSubprogram())
722 return false;
723 // This variable is not inlined function argument if its scope
724 // does not describe current function.
725 return !DISubprogram(getContext()).describes(CurFn);
726 }
728 /// describes - Return true if this subprogram provides debugging
729 /// information for the function F.
730 bool DISubprogram::describes(const Function *F) {
731 assert(F && "Invalid function");
732 if (F == getFunction())
733 return true;
734 StringRef Name = getLinkageName();
735 if (Name.empty())
736 Name = getName();
737 if (F->getName() == Name)
738 return true;
739 return false;
740 }
742 unsigned DISubprogram::isOptimized() const {
743 assert (DbgNode && "Invalid subprogram descriptor!");
744 if (DbgNode->getNumOperands() == 15)
745 return getUnsignedField(14);
746 return 0;
747 }
749 MDNode *DISubprogram::getVariablesNodes() const {
750 return getNodeField(DbgNode, 18);
751 }
753 DIArray DISubprogram::getVariables() const {
754 return DIArray(getNodeField(DbgNode, 18));
755 }
757 Value *DITemplateValueParameter::getValue() const {
758 return getField(DbgNode, 4);
759 }
761 // If the current node has a parent scope then return that,
762 // else return an empty scope.
763 DIScope DIScope::getContext() const {
765 if (isType())
766 return DIType(DbgNode).getContext();
768 if (isSubprogram())
769 return DISubprogram(DbgNode).getContext();
771 if (isLexicalBlock())
772 return DILexicalBlock(DbgNode).getContext();
774 if (isLexicalBlockFile())
775 return DILexicalBlockFile(DbgNode).getContext();
777 if (isNameSpace())
778 return DINameSpace(DbgNode).getContext();
780 assert((isFile() || isCompileUnit()) && "Unhandled type of scope.");
781 return DIScope();
782 }
784 StringRef DIScope::getFilename() const {
785 if (!DbgNode)
786 return StringRef();
787 return ::getStringField(getNodeField(DbgNode, 1), 0);
788 }
790 StringRef DIScope::getDirectory() const {
791 if (!DbgNode)
792 return StringRef();
793 return ::getStringField(getNodeField(DbgNode, 1), 1);
794 }
796 DIArray DICompileUnit::getEnumTypes() const {
797 if (!DbgNode || DbgNode->getNumOperands() < 13)
798 return DIArray();
800 return DIArray(getNodeField(DbgNode, 7));
801 }
803 DIArray DICompileUnit::getRetainedTypes() const {
804 if (!DbgNode || DbgNode->getNumOperands() < 13)
805 return DIArray();
807 return DIArray(getNodeField(DbgNode, 8));
808 }
810 DIArray DICompileUnit::getSubprograms() const {
811 if (!DbgNode || DbgNode->getNumOperands() < 13)
812 return DIArray();
814 return DIArray(getNodeField(DbgNode, 9));
815 }
818 DIArray DICompileUnit::getGlobalVariables() const {
819 if (!DbgNode || DbgNode->getNumOperands() < 13)
820 return DIArray();
822 return DIArray(getNodeField(DbgNode, 10));
823 }
825 DIArray DICompileUnit::getImportedEntities() const {
826 if (!DbgNode || DbgNode->getNumOperands() < 13)
827 return DIArray();
829 return DIArray(getNodeField(DbgNode, 11));
830 }
832 /// fixupSubprogramName - Replace contains special characters used
833 /// in a typical Objective-C names with '.' in a given string.
834 static void fixupSubprogramName(DISubprogram Fn, SmallVectorImpl<char> &Out) {
835 StringRef FName =
836 Fn.getFunction() ? Fn.getFunction()->getName() : Fn.getName();
837 FName = Function::getRealLinkageName(FName);
839 StringRef Prefix("llvm.dbg.lv.");
840 Out.reserve(FName.size() + Prefix.size());
841 Out.append(Prefix.begin(), Prefix.end());
843 bool isObjCLike = false;
844 for (size_t i = 0, e = FName.size(); i < e; ++i) {
845 char C = FName[i];
846 if (C == '[')
847 isObjCLike = true;
849 if (isObjCLike && (C == '[' || C == ']' || C == ' ' || C == ':' ||
850 C == '+' || C == '(' || C == ')'))
851 Out.push_back('.');
852 else
853 Out.push_back(C);
854 }
855 }
857 /// getFnSpecificMDNode - Return a NameMDNode, if available, that is
858 /// suitable to hold function specific information.
859 NamedMDNode *llvm::getFnSpecificMDNode(const Module &M, DISubprogram Fn) {
860 SmallString<32> Name;
861 fixupSubprogramName(Fn, Name);
862 return M.getNamedMetadata(Name.str());
863 }
865 /// getOrInsertFnSpecificMDNode - Return a NameMDNode that is suitable
866 /// to hold function specific information.
867 NamedMDNode *llvm::getOrInsertFnSpecificMDNode(Module &M, DISubprogram Fn) {
868 SmallString<32> Name;
869 fixupSubprogramName(Fn, Name);
870 return M.getOrInsertNamedMetadata(Name.str());
871 }
873 /// createInlinedVariable - Create a new inlined variable based on current
874 /// variable.
875 /// @param DV Current Variable.
876 /// @param InlinedScope Location at current variable is inlined.
877 DIVariable llvm::createInlinedVariable(MDNode *DV, MDNode *InlinedScope,
878 LLVMContext &VMContext) {
879 SmallVector<Value *, 16> Elts;
880 // Insert inlined scope as 7th element.
881 for (unsigned i = 0, e = DV->getNumOperands(); i != e; ++i)
882 i == 7 ? Elts.push_back(InlinedScope) :
883 Elts.push_back(DV->getOperand(i));
884 return DIVariable(MDNode::get(VMContext, Elts));
885 }
887 /// cleanseInlinedVariable - Remove inlined scope from the variable.
888 DIVariable llvm::cleanseInlinedVariable(MDNode *DV, LLVMContext &VMContext) {
889 SmallVector<Value *, 16> Elts;
890 // Insert inlined scope as 7th element.
891 for (unsigned i = 0, e = DV->getNumOperands(); i != e; ++i)
892 i == 7 ?
893 Elts.push_back(Constant::getNullValue(Type::getInt32Ty(VMContext))):
894 Elts.push_back(DV->getOperand(i));
895 return DIVariable(MDNode::get(VMContext, Elts));
896 }
898 /// getDISubprogram - Find subprogram that is enclosing this scope.
899 DISubprogram llvm::getDISubprogram(const MDNode *Scope) {
900 DIDescriptor D(Scope);
901 if (D.isSubprogram())
902 return DISubprogram(Scope);
904 if (D.isLexicalBlockFile())
905 return getDISubprogram(DILexicalBlockFile(Scope).getContext());
907 if (D.isLexicalBlock())
908 return getDISubprogram(DILexicalBlock(Scope).getContext());
910 return DISubprogram();
911 }
913 /// getDICompositeType - Find underlying composite type.
914 DICompositeType llvm::getDICompositeType(DIType T) {
915 if (T.isCompositeType())
916 return DICompositeType(T);
918 if (T.isDerivedType())
919 return getDICompositeType(DIDerivedType(T).getTypeDerivedFrom());
921 return DICompositeType();
922 }
924 /// isSubprogramContext - Return true if Context is either a subprogram
925 /// or another context nested inside a subprogram.
926 bool llvm::isSubprogramContext(const MDNode *Context) {
927 if (!Context)
928 return false;
929 DIDescriptor D(Context);
930 if (D.isSubprogram())
931 return true;
932 if (D.isType())
933 return isSubprogramContext(DIType(Context).getContext());
934 return false;
935 }
937 /// Update DITypeIdentifierMap by going through retained types of each CU.
938 DITypeIdentifierMap llvm::generateDITypeIdentifierMap(
939 const NamedMDNode *CU_Nodes) {
940 DITypeIdentifierMap Map;
941 for (unsigned CUi = 0, CUe = CU_Nodes->getNumOperands(); CUi != CUe; ++CUi) {
942 DICompileUnit CU(CU_Nodes->getOperand(CUi));
943 DIArray Retain = CU.getRetainedTypes();
944 for (unsigned Ti = 0, Te = Retain.getNumElements(); Ti != Te; ++Ti) {
945 if (!Retain.getElement(Ti).isCompositeType())
946 continue;
947 DICompositeType Ty(Retain.getElement(Ti));
948 if (MDString *TypeId = Ty.getIdentifier()) {
949 // Definition has priority over declaration.
950 // Try to insert (TypeId, Ty) to Map.
951 std::pair<DITypeIdentifierMap::iterator, bool> P =
952 Map.insert(std::make_pair(TypeId, Ty));
953 // If TypeId already exists in Map and this is a definition, replace
954 // whatever we had (declaration or definition) with the definition.
955 if (!P.second && !Ty.isForwardDecl())
956 P.first->second = Ty;
957 }
958 }
959 }
960 return Map;
961 }
963 //===----------------------------------------------------------------------===//
964 // DebugInfoFinder implementations.
965 //===----------------------------------------------------------------------===//
967 void DebugInfoFinder::reset() {
968 CUs.clear();
969 SPs.clear();
970 GVs.clear();
971 TYs.clear();
972 Scopes.clear();
973 NodesSeen.clear();
974 }
976 /// processModule - Process entire module and collect debug info.
977 void DebugInfoFinder::processModule(const Module &M) {
978 if (NamedMDNode *CU_Nodes = M.getNamedMetadata("llvm.dbg.cu")) {
979 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
980 DICompileUnit CU(CU_Nodes->getOperand(i));
981 addCompileUnit(CU);
982 DIArray GVs = CU.getGlobalVariables();
983 for (unsigned i = 0, e = GVs.getNumElements(); i != e; ++i) {
984 DIGlobalVariable DIG(GVs.getElement(i));
985 if (addGlobalVariable(DIG)) {
986 processScope(DIG.getContext());
987 processType(DIG.getType());
988 }
989 }
990 DIArray SPs = CU.getSubprograms();
991 for (unsigned i = 0, e = SPs.getNumElements(); i != e; ++i)
992 processSubprogram(DISubprogram(SPs.getElement(i)));
993 DIArray EnumTypes = CU.getEnumTypes();
994 for (unsigned i = 0, e = EnumTypes.getNumElements(); i != e; ++i)
995 processType(DIType(EnumTypes.getElement(i)));
996 DIArray RetainedTypes = CU.getRetainedTypes();
997 for (unsigned i = 0, e = RetainedTypes.getNumElements(); i != e; ++i)
998 processType(DIType(RetainedTypes.getElement(i)));
999 DIArray Imports = CU.getImportedEntities();
1000 for (unsigned i = 0, e = Imports.getNumElements(); i != e; ++i) {
1001 DIImportedEntity Import = DIImportedEntity(
1002 Imports.getElement(i));
1003 DIDescriptor Entity = Import.getEntity();
1004 if (Entity.isType())
1005 processType(DIType(Entity));
1006 else if (Entity.isSubprogram())
1007 processSubprogram(DISubprogram(Entity));
1008 else if (Entity.isNameSpace())
1009 processScope(DINameSpace(Entity).getContext());
1010 }
1011 // FIXME: We really shouldn't be bailing out after visiting just one CU
1012 return;
1013 }
1014 }
1015 }
1017 /// processLocation - Process DILocation.
1018 void DebugInfoFinder::processLocation(DILocation Loc) {
1019 if (!Loc) return;
1020 processScope(Loc.getScope());
1021 processLocation(Loc.getOrigLocation());
1022 }
1024 /// processType - Process DIType.
1025 void DebugInfoFinder::processType(DIType DT) {
1026 if (!addType(DT))
1027 return;
1028 processScope(DT.getContext());
1029 if (DT.isCompositeType()) {
1030 DICompositeType DCT(DT);
1031 processType(DCT.getTypeDerivedFrom());
1032 DIArray DA = DCT.getTypeArray();
1033 for (unsigned i = 0, e = DA.getNumElements(); i != e; ++i) {
1034 DIDescriptor D = DA.getElement(i);
1035 if (D.isType())
1036 processType(DIType(D));
1037 else if (D.isSubprogram())
1038 processSubprogram(DISubprogram(D));
1039 }
1040 } else if (DT.isDerivedType()) {
1041 DIDerivedType DDT(DT);
1042 processType(DDT.getTypeDerivedFrom());
1043 }
1044 }
1046 void DebugInfoFinder::processScope(DIScope Scope) {
1047 if (Scope.isType()) {
1048 DIType Ty(Scope);
1049 processType(Ty);
1050 return;
1051 }
1052 if (Scope.isCompileUnit()) {
1053 addCompileUnit(DICompileUnit(Scope));
1054 return;
1055 }
1056 if (Scope.isSubprogram()) {
1057 processSubprogram(DISubprogram(Scope));
1058 return;
1059 }
1060 if (!addScope(Scope))
1061 return;
1062 if (Scope.isLexicalBlock()) {
1063 DILexicalBlock LB(Scope);
1064 processScope(LB.getContext());
1065 } else if (Scope.isLexicalBlockFile()) {
1066 DILexicalBlockFile LBF = DILexicalBlockFile(Scope);
1067 processScope(LBF.getScope());
1068 } else if (Scope.isNameSpace()) {
1069 DINameSpace NS(Scope);
1070 processScope(NS.getContext());
1071 }
1072 }
1074 /// processLexicalBlock
1075 void DebugInfoFinder::processLexicalBlock(DILexicalBlock LB) {
1076 DIScope Context = LB.getContext();
1077 if (Context.isLexicalBlock())
1078 return processLexicalBlock(DILexicalBlock(Context));
1079 else if (Context.isLexicalBlockFile()) {
1080 DILexicalBlockFile DBF = DILexicalBlockFile(Context);
1081 return processLexicalBlock(DILexicalBlock(DBF.getScope()));
1082 }
1083 else
1084 return processSubprogram(DISubprogram(Context));
1085 }
1087 /// processSubprogram - Process DISubprogram.
1088 void DebugInfoFinder::processSubprogram(DISubprogram SP) {
1089 if (!addSubprogram(SP))
1090 return;
1091 processScope(SP.getContext());
1092 processType(SP.getType());
1093 DIArray TParams = SP.getTemplateParams();
1094 for (unsigned I = 0, E = TParams.getNumElements(); I != E; ++I) {
1095 DIDescriptor Element = TParams.getElement(I);
1096 if (Element.isTemplateTypeParameter()) {
1097 DITemplateTypeParameter TType(Element);
1098 processScope(TType.getContext());
1099 processType(TType.getType());
1100 } else if (Element.isTemplateValueParameter()) {
1101 DITemplateValueParameter TVal(Element);
1102 processScope(TVal.getContext());
1103 processType(TVal.getType());
1104 }
1105 }
1106 }
1108 /// processDeclare - Process DbgDeclareInst.
1109 void DebugInfoFinder::processDeclare(const DbgDeclareInst *DDI) {
1110 MDNode *N = dyn_cast<MDNode>(DDI->getVariable());
1111 if (!N) return;
1113 DIDescriptor DV(N);
1114 if (!DV.isVariable())
1115 return;
1117 if (!NodesSeen.insert(DV))
1118 return;
1119 processScope(DIVariable(N).getContext());
1120 processType(DIVariable(N).getType());
1121 }
1123 void DebugInfoFinder::processValue(const DbgValueInst *DVI) {
1124 MDNode *N = dyn_cast<MDNode>(DVI->getVariable());
1125 if (!N) return;
1127 DIDescriptor DV(N);
1128 if (!DV.isVariable())
1129 return;
1131 if (!NodesSeen.insert(DV))
1132 return;
1133 processScope(DIVariable(N).getContext());
1134 processType(DIVariable(N).getType());
1135 }
1137 /// addType - Add type into Tys.
1138 bool DebugInfoFinder::addType(DIType DT) {
1139 if (!DT)
1140 return false;
1142 if (!NodesSeen.insert(DT))
1143 return false;
1145 TYs.push_back(DT);
1146 return true;
1147 }
1149 /// addCompileUnit - Add compile unit into CUs.
1150 bool DebugInfoFinder::addCompileUnit(DICompileUnit CU) {
1151 if (!CU)
1152 return false;
1153 if (!NodesSeen.insert(CU))
1154 return false;
1156 CUs.push_back(CU);
1157 return true;
1158 }
1160 /// addGlobalVariable - Add global variable into GVs.
1161 bool DebugInfoFinder::addGlobalVariable(DIGlobalVariable DIG) {
1162 if (!DIG)
1163 return false;
1165 if (!NodesSeen.insert(DIG))
1166 return false;
1168 GVs.push_back(DIG);
1169 return true;
1170 }
1172 // addSubprogram - Add subprgoram into SPs.
1173 bool DebugInfoFinder::addSubprogram(DISubprogram SP) {
1174 if (!SP)
1175 return false;
1177 if (!NodesSeen.insert(SP))
1178 return false;
1180 SPs.push_back(SP);
1181 return true;
1182 }
1184 bool DebugInfoFinder::addScope(DIScope Scope) {
1185 if (!Scope)
1186 return false;
1187 // FIXME: Ocaml binding generates a scope with no content, we treat it
1188 // as null for now.
1189 if (Scope->getNumOperands() == 0)
1190 return false;
1191 if (!NodesSeen.insert(Scope))
1192 return false;
1193 Scopes.push_back(Scope);
1194 return true;
1195 }
1197 //===----------------------------------------------------------------------===//
1198 // DIDescriptor: dump routines for all descriptors.
1199 //===----------------------------------------------------------------------===//
1201 /// dump - Print descriptor to dbgs() with a newline.
1202 void DIDescriptor::dump() const {
1203 print(dbgs()); dbgs() << '\n';
1204 }
1206 /// print - Print descriptor.
1207 void DIDescriptor::print(raw_ostream &OS) const {
1208 if (!DbgNode) return;
1210 if (const char *Tag = dwarf::TagString(getTag()))
1211 OS << "[ " << Tag << " ]";
1213 if (this->isSubrange()) {
1214 DISubrange(DbgNode).printInternal(OS);
1215 } else if (this->isCompileUnit()) {
1216 DICompileUnit(DbgNode).printInternal(OS);
1217 } else if (this->isFile()) {
1218 DIFile(DbgNode).printInternal(OS);
1219 } else if (this->isEnumerator()) {
1220 DIEnumerator(DbgNode).printInternal(OS);
1221 } else if (this->isBasicType()) {
1222 DIType(DbgNode).printInternal(OS);
1223 } else if (this->isDerivedType()) {
1224 DIDerivedType(DbgNode).printInternal(OS);
1225 } else if (this->isCompositeType()) {
1226 DICompositeType(DbgNode).printInternal(OS);
1227 } else if (this->isSubprogram()) {
1228 DISubprogram(DbgNode).printInternal(OS);
1229 } else if (this->isGlobalVariable()) {
1230 DIGlobalVariable(DbgNode).printInternal(OS);
1231 } else if (this->isVariable()) {
1232 DIVariable(DbgNode).printInternal(OS);
1233 } else if (this->isObjCProperty()) {
1234 DIObjCProperty(DbgNode).printInternal(OS);
1235 } else if (this->isNameSpace()) {
1236 DINameSpace(DbgNode).printInternal(OS);
1237 } else if (this->isScope()) {
1238 DIScope(DbgNode).printInternal(OS);
1239 }
1240 }
1242 void DISubrange::printInternal(raw_ostream &OS) const {
1243 int64_t Count = getCount();
1244 if (Count != -1)
1245 OS << " [" << getLo() << ", " << Count - 1 << ']';
1246 else
1247 OS << " [unbounded]";
1248 }
1250 void DIScope::printInternal(raw_ostream &OS) const {
1251 OS << " [" << getDirectory() << "/" << getFilename() << ']';
1252 }
1254 void DICompileUnit::printInternal(raw_ostream &OS) const {
1255 DIScope::printInternal(OS);
1256 OS << " [";
1257 unsigned Lang = getLanguage();
1258 if (const char *LangStr = dwarf::LanguageString(Lang))
1259 OS << LangStr;
1260 else
1261 (OS << "lang 0x").write_hex(Lang);
1262 OS << ']';
1263 }
1265 void DIEnumerator::printInternal(raw_ostream &OS) const {
1266 OS << " [" << getName() << " :: " << getEnumValue() << ']';
1267 }
1269 void DIType::printInternal(raw_ostream &OS) const {
1270 if (!DbgNode) return;
1272 StringRef Res = getName();
1273 if (!Res.empty())
1274 OS << " [" << Res << "]";
1276 // TODO: Print context?
1278 OS << " [line " << getLineNumber()
1279 << ", size " << getSizeInBits()
1280 << ", align " << getAlignInBits()
1281 << ", offset " << getOffsetInBits();
1282 if (isBasicType())
1283 if (const char *Enc =
1284 dwarf::AttributeEncodingString(DIBasicType(DbgNode).getEncoding()))
1285 OS << ", enc " << Enc;
1286 OS << "]";
1288 if (isPrivate())
1289 OS << " [private]";
1290 else if (isProtected())
1291 OS << " [protected]";
1293 if (isArtificial())
1294 OS << " [artificial]";
1296 if (isForwardDecl())
1297 OS << " [decl]";
1298 else if (getTag() == dwarf::DW_TAG_structure_type ||
1299 getTag() == dwarf::DW_TAG_union_type ||
1300 getTag() == dwarf::DW_TAG_enumeration_type ||
1301 getTag() == dwarf::DW_TAG_class_type)
1302 OS << " [def]";
1303 if (isVector())
1304 OS << " [vector]";
1305 if (isStaticMember())
1306 OS << " [static]";
1307 }
1309 void DIDerivedType::printInternal(raw_ostream &OS) const {
1310 DIType::printInternal(OS);
1311 OS << " [from " << getTypeDerivedFrom().getName() << ']';
1312 }
1314 void DICompositeType::printInternal(raw_ostream &OS) const {
1315 DIType::printInternal(OS);
1316 DIArray A = getTypeArray();
1317 OS << " [" << A.getNumElements() << " elements]";
1318 }
1320 void DINameSpace::printInternal(raw_ostream &OS) const {
1321 StringRef Name = getName();
1322 if (!Name.empty())
1323 OS << " [" << Name << ']';
1325 OS << " [line " << getLineNumber() << ']';
1326 }
1328 void DISubprogram::printInternal(raw_ostream &OS) const {
1329 // TODO : Print context
1330 OS << " [line " << getLineNumber() << ']';
1332 if (isLocalToUnit())
1333 OS << " [local]";
1335 if (isDefinition())
1336 OS << " [def]";
1338 if (getScopeLineNumber() != getLineNumber())
1339 OS << " [scope " << getScopeLineNumber() << "]";
1341 if (isPrivate())
1342 OS << " [private]";
1343 else if (isProtected())
1344 OS << " [protected]";
1346 StringRef Res = getName();
1347 if (!Res.empty())
1348 OS << " [" << Res << ']';
1349 }
1351 void DIGlobalVariable::printInternal(raw_ostream &OS) const {
1352 StringRef Res = getName();
1353 if (!Res.empty())
1354 OS << " [" << Res << ']';
1356 OS << " [line " << getLineNumber() << ']';
1358 // TODO : Print context
1360 if (isLocalToUnit())
1361 OS << " [local]";
1363 if (isDefinition())
1364 OS << " [def]";
1365 }
1367 void DIVariable::printInternal(raw_ostream &OS) const {
1368 StringRef Res = getName();
1369 if (!Res.empty())
1370 OS << " [" << Res << ']';
1372 OS << " [line " << getLineNumber() << ']';
1373 }
1375 void DIObjCProperty::printInternal(raw_ostream &OS) const {
1376 StringRef Name = getObjCPropertyName();
1377 if (!Name.empty())
1378 OS << " [" << Name << ']';
1380 OS << " [line " << getLineNumber()
1381 << ", properties " << getUnsignedField(6) << ']';
1382 }
1384 static void printDebugLoc(DebugLoc DL, raw_ostream &CommentOS,
1385 const LLVMContext &Ctx) {
1386 if (!DL.isUnknown()) { // Print source line info.
1387 DIScope Scope(DL.getScope(Ctx));
1388 assert(Scope.isScope() &&
1389 "Scope of a DebugLoc should be a DIScope.");
1390 // Omit the directory, because it's likely to be long and uninteresting.
1391 CommentOS << Scope.getFilename();
1392 CommentOS << ':' << DL.getLine();
1393 if (DL.getCol() != 0)
1394 CommentOS << ':' << DL.getCol();
1395 DebugLoc InlinedAtDL = DebugLoc::getFromDILocation(DL.getInlinedAt(Ctx));
1396 if (!InlinedAtDL.isUnknown()) {
1397 CommentOS << " @[ ";
1398 printDebugLoc(InlinedAtDL, CommentOS, Ctx);
1399 CommentOS << " ]";
1400 }
1401 }
1402 }
1404 void DIVariable::printExtendedName(raw_ostream &OS) const {
1405 const LLVMContext &Ctx = DbgNode->getContext();
1406 StringRef Res = getName();
1407 if (!Res.empty())
1408 OS << Res << "," << getLineNumber();
1409 if (MDNode *InlinedAt = getInlinedAt()) {
1410 DebugLoc InlinedAtDL = DebugLoc::getFromDILocation(InlinedAt);
1411 if (!InlinedAtDL.isUnknown()) {
1412 OS << " @[";
1413 printDebugLoc(InlinedAtDL, OS, Ctx);
1414 OS << "]";
1415 }
1416 }
1417 }
1419 DITypeRef::DITypeRef(const Value *V) : TypeVal(V) {
1420 assert(isTypeRef(V) && "DITypeRef should be a MDString or MDNode");
1421 }
1423 /// Given a DITypeIdentifierMap, tries to find the corresponding
1424 /// DIType for a DITypeRef.
1425 DIType DITypeRef::resolve(const DITypeIdentifierMap &Map) const {
1426 if (!TypeVal)
1427 return NULL;
1429 if (const MDNode *MD = dyn_cast<MDNode>(TypeVal)) {
1430 assert(DIType(MD).isType() &&
1431 "MDNode in DITypeRef should be a DIType.");
1432 return MD;
1433 }
1435 const MDString *MS = cast<MDString>(TypeVal);
1436 // Find the corresponding MDNode.
1437 DITypeIdentifierMap::const_iterator Iter = Map.find(MS);
1438 assert(Iter != Map.end() && "Identifier not in the type map?");
1439 assert(DIType(Iter->second).isType() &&
1440 "MDNode in DITypeIdentifierMap should be a DIType.");
1441 return Iter->second;
1442 }
1444 /// Specialize getFieldAs to handle fields that are references to DITypes.
1445 template <>
1446 DITypeRef DIDescriptor::getFieldAs<DITypeRef>(unsigned Elt) const {
1447 return DITypeRef(getField(DbgNode, Elt));
1448 }