1 //===--- DebugInfo.cpp - Debug Information Helper Classes -----------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements the helper classes used to build and interpret debug
11 // information in LLVM IR form.
13 //===----------------------------------------------------------------------===//
15 #include "llvm/IR/DebugInfo.h"
16 #include "LLVMContextImpl.h"
17 #include "llvm/ADT/STLExtras.h"
18 #include "llvm/ADT/SmallPtrSet.h"
19 #include "llvm/ADT/SmallString.h"
20 #include "llvm/Analysis/ValueTracking.h"
21 #include "llvm/IR/Constants.h"
22 #include "llvm/IR/DIBuilder.h"
23 #include "llvm/IR/DerivedTypes.h"
24 #include "llvm/IR/Instructions.h"
25 #include "llvm/IR/IntrinsicInst.h"
26 #include "llvm/IR/Intrinsics.h"
27 #include "llvm/IR/Module.h"
28 #include "llvm/IR/ValueHandle.h"
29 #include "llvm/Support/Debug.h"
30 #include "llvm/Support/Dwarf.h"
31 #include "llvm/Support/raw_ostream.h"
33 using namespace llvm::dwarf;
35 //===----------------------------------------------------------------------===//
37 //===----------------------------------------------------------------------===//
39 bool DIDescriptor::Verify() const {
41 (DIDerivedType(DbgNode).Verify() ||
42 DICompositeType(DbgNode).Verify() || DIBasicType(DbgNode).Verify() ||
43 DIVariable(DbgNode).Verify() || DISubprogram(DbgNode).Verify() ||
44 DIGlobalVariable(DbgNode).Verify() || DIFile(DbgNode).Verify() ||
45 DICompileUnit(DbgNode).Verify() || DINameSpace(DbgNode).Verify() ||
46 DILexicalBlock(DbgNode).Verify() ||
47 DILexicalBlockFile(DbgNode).Verify() ||
48 DISubrange(DbgNode).Verify() || DIEnumerator(DbgNode).Verify() ||
49 DIObjCProperty(DbgNode).Verify() ||
50 DITemplateTypeParameter(DbgNode).Verify() ||
51 DITemplateValueParameter(DbgNode).Verify() ||
52 DIImportedEntity(DbgNode).Verify());
55 static Value *getField(const MDNode *DbgNode, unsigned Elt) {
56 if (!DbgNode || Elt >= DbgNode->getNumOperands())
58 return DbgNode->getOperand(Elt);
61 static MDNode *getNodeField(const MDNode *DbgNode, unsigned Elt) {
62 return dyn_cast_or_null<MDNode>(getField(DbgNode, Elt));
65 static StringRef getStringField(const MDNode *DbgNode, unsigned Elt) {
66 if (MDString *MDS = dyn_cast_or_null<MDString>(getField(DbgNode, Elt)))
67 return MDS->getString();
71 StringRef DIDescriptor::getStringField(unsigned Elt) const {
72 return ::getStringField(DbgNode, Elt);
75 uint64_t DIDescriptor::getUInt64Field(unsigned Elt) const {
79 if (Elt < DbgNode->getNumOperands())
81 dyn_cast_or_null<ConstantInt>(DbgNode->getOperand(Elt)))
82 return CI->getZExtValue();
87 int64_t DIDescriptor::getInt64Field(unsigned Elt) const {
91 if (Elt < DbgNode->getNumOperands())
93 dyn_cast_or_null<ConstantInt>(DbgNode->getOperand(Elt)))
94 return CI->getSExtValue();
99 DIDescriptor DIDescriptor::getDescriptorField(unsigned Elt) const {
100 MDNode *Field = getNodeField(DbgNode, Elt);
101 return DIDescriptor(Field);
104 GlobalVariable *DIDescriptor::getGlobalVariableField(unsigned Elt) const {
108 if (Elt < DbgNode->getNumOperands())
109 return dyn_cast_or_null<GlobalVariable>(DbgNode->getOperand(Elt));
113 Constant *DIDescriptor::getConstantField(unsigned Elt) const {
117 if (Elt < DbgNode->getNumOperands())
118 return dyn_cast_or_null<Constant>(DbgNode->getOperand(Elt));
122 Function *DIDescriptor::getFunctionField(unsigned Elt) const {
126 if (Elt < DbgNode->getNumOperands())
127 return dyn_cast_or_null<Function>(DbgNode->getOperand(Elt));
131 void DIDescriptor::replaceFunctionField(unsigned Elt, Function *F) {
135 if (Elt < DbgNode->getNumOperands()) {
136 MDNode *Node = const_cast<MDNode *>(DbgNode);
137 Node->replaceOperandWith(Elt, F);
141 uint64_t DIVariable::getAddrElement(unsigned Idx) const {
142 DIDescriptor ComplexExpr = getDescriptorField(8);
143 if (Idx < ComplexExpr->getNumOperands())
144 if (auto *CI = dyn_cast_or_null<ConstantInt>(ComplexExpr->getOperand(Idx)))
145 return CI->getZExtValue();
147 assert(false && "non-existing complex address element requested");
151 /// getInlinedAt - If this variable is inlined then return inline location.
152 MDNode *DIVariable::getInlinedAt() const { return getNodeField(DbgNode, 7); }
154 bool DIVariable::isVariablePiece() const {
155 return hasComplexAddress() && getAddrElement(0) == DIBuilder::OpPiece;
158 uint64_t DIVariable::getPieceOffset() const {
159 assert(isVariablePiece());
160 return getAddrElement(1);
163 uint64_t DIVariable::getPieceSize() const {
164 assert(isVariablePiece());
165 return getAddrElement(2);
168 /// Return the size reported by the variable's type.
169 unsigned DIVariable::getSizeInBits(const DITypeIdentifierMap &Map) {
170 DIType Ty = getType().resolve(Map);
171 // Follow derived types until we reach a type that
172 // reports back a size.
173 while (Ty.isDerivedType() && !Ty.getSizeInBits()) {
174 DIDerivedType DT(&*Ty);
175 Ty = DT.getTypeDerivedFrom().resolve(Map);
177 assert(Ty.getSizeInBits() && "type with size 0");
178 return Ty.getSizeInBits();
184 //===----------------------------------------------------------------------===//
186 //===----------------------------------------------------------------------===//
188 bool DIDescriptor::isSubroutineType() const {
189 return isCompositeType() && getTag() == dwarf::DW_TAG_subroutine_type;
192 /// isBasicType - Return true if the specified tag is legal for
194 bool DIDescriptor::isBasicType() const {
198 case dwarf::DW_TAG_base_type:
199 case dwarf::DW_TAG_unspecified_type:
206 /// isDerivedType - Return true if the specified tag is legal for DIDerivedType.
207 bool DIDescriptor::isDerivedType() const {
211 case dwarf::DW_TAG_typedef:
212 case dwarf::DW_TAG_pointer_type:
213 case dwarf::DW_TAG_ptr_to_member_type:
214 case dwarf::DW_TAG_reference_type:
215 case dwarf::DW_TAG_rvalue_reference_type:
216 case dwarf::DW_TAG_const_type:
217 case dwarf::DW_TAG_volatile_type:
218 case dwarf::DW_TAG_restrict_type:
219 case dwarf::DW_TAG_member:
220 case dwarf::DW_TAG_inheritance:
221 case dwarf::DW_TAG_friend:
224 // CompositeTypes are currently modelled as DerivedTypes.
225 return isCompositeType();
229 /// isCompositeType - Return true if the specified tag is legal for
231 bool DIDescriptor::isCompositeType() const {
235 case dwarf::DW_TAG_array_type:
236 case dwarf::DW_TAG_structure_type:
237 case dwarf::DW_TAG_union_type:
238 case dwarf::DW_TAG_enumeration_type:
239 case dwarf::DW_TAG_subroutine_type:
240 case dwarf::DW_TAG_class_type:
247 /// isVariable - Return true if the specified tag is legal for DIVariable.
248 bool DIDescriptor::isVariable() const {
252 case dwarf::DW_TAG_auto_variable:
253 case dwarf::DW_TAG_arg_variable:
260 /// isType - Return true if the specified tag is legal for DIType.
261 bool DIDescriptor::isType() const {
262 return isBasicType() || isCompositeType() || isDerivedType();
265 /// isSubprogram - Return true if the specified tag is legal for
267 bool DIDescriptor::isSubprogram() const {
268 return DbgNode && getTag() == dwarf::DW_TAG_subprogram;
271 /// isGlobalVariable - Return true if the specified tag is legal for
272 /// DIGlobalVariable.
273 bool DIDescriptor::isGlobalVariable() const {
274 return DbgNode && (getTag() == dwarf::DW_TAG_variable ||
275 getTag() == dwarf::DW_TAG_constant);
278 /// isScope - Return true if the specified tag is one of the scope
280 bool DIDescriptor::isScope() const {
284 case dwarf::DW_TAG_compile_unit:
285 case dwarf::DW_TAG_lexical_block:
286 case dwarf::DW_TAG_subprogram:
287 case dwarf::DW_TAG_namespace:
288 case dwarf::DW_TAG_file_type:
296 /// isTemplateTypeParameter - Return true if the specified tag is
297 /// DW_TAG_template_type_parameter.
298 bool DIDescriptor::isTemplateTypeParameter() const {
299 return DbgNode && getTag() == dwarf::DW_TAG_template_type_parameter;
302 /// isTemplateValueParameter - Return true if the specified tag is
303 /// DW_TAG_template_value_parameter.
304 bool DIDescriptor::isTemplateValueParameter() const {
305 return DbgNode && (getTag() == dwarf::DW_TAG_template_value_parameter ||
306 getTag() == dwarf::DW_TAG_GNU_template_template_param ||
307 getTag() == dwarf::DW_TAG_GNU_template_parameter_pack);
310 /// isCompileUnit - Return true if the specified tag is DW_TAG_compile_unit.
311 bool DIDescriptor::isCompileUnit() const {
312 return DbgNode && getTag() == dwarf::DW_TAG_compile_unit;
315 /// isFile - Return true if the specified tag is DW_TAG_file_type.
316 bool DIDescriptor::isFile() const {
317 return DbgNode && getTag() == dwarf::DW_TAG_file_type;
320 /// isNameSpace - Return true if the specified tag is DW_TAG_namespace.
321 bool DIDescriptor::isNameSpace() const {
322 return DbgNode && getTag() == dwarf::DW_TAG_namespace;
325 /// isLexicalBlockFile - Return true if the specified descriptor is a
326 /// lexical block with an extra file.
327 bool DIDescriptor::isLexicalBlockFile() const {
328 return DbgNode && getTag() == dwarf::DW_TAG_lexical_block &&
329 (DbgNode->getNumOperands() == 4);
332 /// isLexicalBlock - Return true if the specified tag is DW_TAG_lexical_block.
333 bool DIDescriptor::isLexicalBlock() const {
334 return DbgNode && getTag() == dwarf::DW_TAG_lexical_block &&
335 (DbgNode->getNumOperands() > 3);
338 /// isSubrange - Return true if the specified tag is DW_TAG_subrange_type.
339 bool DIDescriptor::isSubrange() const {
340 return DbgNode && getTag() == dwarf::DW_TAG_subrange_type;
343 /// isEnumerator - Return true if the specified tag is DW_TAG_enumerator.
344 bool DIDescriptor::isEnumerator() const {
345 return DbgNode && getTag() == dwarf::DW_TAG_enumerator;
348 /// isObjCProperty - Return true if the specified tag is DW_TAG_APPLE_property.
349 bool DIDescriptor::isObjCProperty() const {
350 return DbgNode && getTag() == dwarf::DW_TAG_APPLE_property;
353 /// \brief Return true if the specified tag is DW_TAG_imported_module or
354 /// DW_TAG_imported_declaration.
355 bool DIDescriptor::isImportedEntity() const {
356 return DbgNode && (getTag() == dwarf::DW_TAG_imported_module ||
357 getTag() == dwarf::DW_TAG_imported_declaration);
360 //===----------------------------------------------------------------------===//
361 // Simple Descriptor Constructors and other Methods
362 //===----------------------------------------------------------------------===//
364 /// replaceAllUsesWith - Replace all uses of the MDNode used by this
365 /// type with the one in the passed descriptor.
366 void DIType::replaceAllUsesWith(LLVMContext &VMContext, DIDescriptor D) {
368 assert(DbgNode && "Trying to replace an unverified type!");
370 // Since we use a TrackingVH for the node, its easy for clients to manufacture
371 // legitimate situations where they want to replaceAllUsesWith() on something
372 // which, due to uniquing, has merged with the source. We shield clients from
373 // this detail by allowing a value to be replaced with replaceAllUsesWith()
375 const MDNode *DN = D;
377 SmallVector<Value*, 10> Ops(DbgNode->getNumOperands());
378 for (size_t i = 0; i != Ops.size(); ++i)
379 Ops[i] = DbgNode->getOperand(i);
380 DN = MDNode::get(VMContext, Ops);
383 MDNode *Node = const_cast<MDNode *>(DbgNode);
384 const Value *V = cast_or_null<Value>(DN);
385 Node->replaceAllUsesWith(const_cast<Value *>(V));
386 MDNode::deleteTemporary(Node);
390 /// replaceAllUsesWith - Replace all uses of the MDNode used by this
391 /// type with the one in D.
392 void DIType::replaceAllUsesWith(MDNode *D) {
394 assert(DbgNode && "Trying to replace an unverified type!");
395 assert(DbgNode != D && "This replacement should always happen");
396 MDNode *Node = const_cast<MDNode *>(DbgNode);
397 const MDNode *DN = D;
398 const Value *V = cast_or_null<Value>(DN);
399 Node->replaceAllUsesWith(const_cast<Value *>(V));
400 MDNode::deleteTemporary(Node);
403 /// Verify - Verify that a compile unit is well formed.
404 bool DICompileUnit::Verify() const {
405 if (!isCompileUnit())
408 // Don't bother verifying the compilation directory or producer string
409 // as those could be empty.
410 if (getFilename().empty())
413 return DbgNode->getNumOperands() == 14;
416 /// Verify - Verify that an ObjC property is well formed.
417 bool DIObjCProperty::Verify() const {
418 if (!isObjCProperty())
421 // Don't worry about the rest of the strings for now.
422 return DbgNode->getNumOperands() == 8;
425 /// Check if a field at position Elt of a MDNode is a MDNode.
426 /// We currently allow an empty string and an integer.
427 /// But we don't allow a non-empty string in a MDNode field.
428 static bool fieldIsMDNode(const MDNode *DbgNode, unsigned Elt) {
429 // FIXME: This function should return true, if the field is null or the field
430 // is indeed a MDNode: return !Fld || isa<MDNode>(Fld).
431 Value *Fld = getField(DbgNode, Elt);
432 if (Fld && isa<MDString>(Fld) && !cast<MDString>(Fld)->getString().empty())
437 /// Check if a field at position Elt of a MDNode is a MDString.
438 static bool fieldIsMDString(const MDNode *DbgNode, unsigned Elt) {
439 Value *Fld = getField(DbgNode, Elt);
440 return !Fld || isa<MDString>(Fld);
443 /// Check if a value can be a reference to a type.
444 static bool isTypeRef(const Value *Val) {
446 (isa<MDString>(Val) && !cast<MDString>(Val)->getString().empty()) ||
447 (isa<MDNode>(Val) && DIType(cast<MDNode>(Val)).isType());
450 /// Check if a field at position Elt of a MDNode can be a reference to a type.
451 static bool fieldIsTypeRef(const MDNode *DbgNode, unsigned Elt) {
452 Value *Fld = getField(DbgNode, Elt);
453 return isTypeRef(Fld);
456 /// Check if a value can be a ScopeRef.
457 static bool isScopeRef(const Value *Val) {
459 (isa<MDString>(Val) && !cast<MDString>(Val)->getString().empty()) ||
460 // Not checking for Val->isScope() here, because it would work
461 // only for lexical scopes and not all subclasses of DIScope.
465 /// Check if a field at position Elt of a MDNode can be a ScopeRef.
466 static bool fieldIsScopeRef(const MDNode *DbgNode, unsigned Elt) {
467 Value *Fld = getField(DbgNode, Elt);
468 return isScopeRef(Fld);
471 /// Verify - Verify that a type descriptor is well formed.
472 bool DIType::Verify() const {
475 // Make sure Context @ field 2 is MDNode.
476 if (!fieldIsScopeRef(DbgNode, 2))
479 // FIXME: Sink this into the various subclass verifies.
480 uint16_t Tag = getTag();
481 if (!isBasicType() && Tag != dwarf::DW_TAG_const_type &&
482 Tag != dwarf::DW_TAG_volatile_type && Tag != dwarf::DW_TAG_pointer_type &&
483 Tag != dwarf::DW_TAG_ptr_to_member_type &&
484 Tag != dwarf::DW_TAG_reference_type &&
485 Tag != dwarf::DW_TAG_rvalue_reference_type &&
486 Tag != dwarf::DW_TAG_restrict_type && Tag != dwarf::DW_TAG_array_type &&
487 Tag != dwarf::DW_TAG_enumeration_type &&
488 Tag != dwarf::DW_TAG_subroutine_type &&
489 Tag != dwarf::DW_TAG_inheritance && Tag != dwarf::DW_TAG_friend &&
490 getFilename().empty())
493 // DIType is abstract, it should be a BasicType, a DerivedType or
496 return DIBasicType(DbgNode).Verify();
497 else if (isCompositeType())
498 return DICompositeType(DbgNode).Verify();
499 else if (isDerivedType())
500 return DIDerivedType(DbgNode).Verify();
505 /// Verify - Verify that a basic type descriptor is well formed.
506 bool DIBasicType::Verify() const {
507 return isBasicType() && DbgNode->getNumOperands() == 10;
510 /// Verify - Verify that a derived type descriptor is well formed.
511 bool DIDerivedType::Verify() const {
512 // Make sure DerivedFrom @ field 9 is TypeRef.
513 if (!fieldIsTypeRef(DbgNode, 9))
515 if (getTag() == dwarf::DW_TAG_ptr_to_member_type)
516 // Make sure ClassType @ field 10 is a TypeRef.
517 if (!fieldIsTypeRef(DbgNode, 10))
520 return isDerivedType() && DbgNode->getNumOperands() >= 10 &&
521 DbgNode->getNumOperands() <= 14;
524 /// Verify - Verify that a composite type descriptor is well formed.
525 bool DICompositeType::Verify() const {
526 if (!isCompositeType())
529 // Make sure DerivedFrom @ field 9 and ContainingType @ field 12 are TypeRef.
530 if (!fieldIsTypeRef(DbgNode, 9))
532 if (!fieldIsTypeRef(DbgNode, 12))
535 // Make sure the type identifier at field 14 is MDString, it can be null.
536 if (!fieldIsMDString(DbgNode, 14))
539 // A subroutine type can't be both & and &&.
540 if (isLValueReference() && isRValueReference())
543 return DbgNode->getNumOperands() == 15;
546 /// Verify - Verify that a subprogram descriptor is well formed.
547 bool DISubprogram::Verify() const {
551 // Make sure context @ field 2 is a ScopeRef and type @ field 7 is a MDNode.
552 if (!fieldIsScopeRef(DbgNode, 2))
554 if (!fieldIsMDNode(DbgNode, 7))
556 // Containing type @ field 12.
557 if (!fieldIsTypeRef(DbgNode, 12))
560 // A subprogram can't be both & and &&.
561 if (isLValueReference() && isRValueReference())
564 return DbgNode->getNumOperands() == 20;
567 /// Verify - Verify that a global variable descriptor is well formed.
568 bool DIGlobalVariable::Verify() const {
569 if (!isGlobalVariable())
572 if (getDisplayName().empty())
574 // Make sure context @ field 2 is an MDNode.
575 if (!fieldIsMDNode(DbgNode, 2))
577 // Make sure that type @ field 8 is a DITypeRef.
578 if (!fieldIsTypeRef(DbgNode, 8))
580 // Make sure StaticDataMemberDeclaration @ field 12 is MDNode.
581 if (!fieldIsMDNode(DbgNode, 12))
584 return DbgNode->getNumOperands() == 13;
587 /// Verify - Verify that a variable descriptor is well formed.
588 bool DIVariable::Verify() const {
592 // Make sure context @ field 1 is an MDNode.
593 if (!fieldIsMDNode(DbgNode, 1))
595 // Make sure that type @ field 5 is a DITypeRef.
596 if (!fieldIsTypeRef(DbgNode, 5))
599 // Variable without a complex expression.
600 if (DbgNode->getNumOperands() == 8)
603 // Make sure the complex expression is an MDNode.
604 return (DbgNode->getNumOperands() == 9 && fieldIsMDNode(DbgNode, 8));
607 /// Verify - Verify that a location descriptor is well formed.
608 bool DILocation::Verify() const {
612 return DbgNode->getNumOperands() == 4;
615 /// Verify - Verify that a namespace descriptor is well formed.
616 bool DINameSpace::Verify() const {
619 return DbgNode->getNumOperands() == 5;
622 /// \brief Retrieve the MDNode for the directory/file pair.
623 MDNode *DIFile::getFileNode() const { return getNodeField(DbgNode, 1); }
625 /// \brief Verify that the file descriptor is well formed.
626 bool DIFile::Verify() const {
627 return isFile() && DbgNode->getNumOperands() == 2;
630 /// \brief Verify that the enumerator descriptor is well formed.
631 bool DIEnumerator::Verify() const {
632 return isEnumerator() && DbgNode->getNumOperands() == 3;
635 /// \brief Verify that the subrange descriptor is well formed.
636 bool DISubrange::Verify() const {
637 return isSubrange() && DbgNode->getNumOperands() == 3;
640 /// \brief Verify that the lexical block descriptor is well formed.
641 bool DILexicalBlock::Verify() const {
642 return isLexicalBlock() && DbgNode->getNumOperands() == 6;
645 /// \brief Verify that the file-scoped lexical block descriptor is well formed.
646 bool DILexicalBlockFile::Verify() const {
647 return isLexicalBlockFile() && DbgNode->getNumOperands() == 4;
650 /// \brief Verify that the template type parameter descriptor is well formed.
651 bool DITemplateTypeParameter::Verify() const {
652 return isTemplateTypeParameter() && DbgNode->getNumOperands() == 7;
655 /// \brief Verify that the template value parameter descriptor is well formed.
656 bool DITemplateValueParameter::Verify() const {
657 return isTemplateValueParameter() && DbgNode->getNumOperands() == 8;
660 /// \brief Verify that the imported module descriptor is well formed.
661 bool DIImportedEntity::Verify() const {
662 return isImportedEntity() &&
663 (DbgNode->getNumOperands() == 4 || DbgNode->getNumOperands() == 5);
666 /// getObjCProperty - Return property node, if this ivar is associated with one.
667 MDNode *DIDerivedType::getObjCProperty() const {
668 return getNodeField(DbgNode, 10);
671 MDString *DICompositeType::getIdentifier() const {
672 return cast_or_null<MDString>(getField(DbgNode, 14));
676 static void VerifySubsetOf(const MDNode *LHS, const MDNode *RHS) {
677 for (unsigned i = 0; i != LHS->getNumOperands(); ++i) {
678 // Skip the 'empty' list (that's a single i32 0, rather than truly empty).
679 if (i == 0 && isa<ConstantInt>(LHS->getOperand(i)))
681 const MDNode *E = cast<MDNode>(LHS->getOperand(i));
683 for (unsigned j = 0; !found && j != RHS->getNumOperands(); ++j)
684 found = E == RHS->getOperand(j);
685 assert(found && "Losing a member during member list replacement");
690 /// \brief Set the array of member DITypes.
691 void DICompositeType::setArraysHelper(MDNode *Elements, MDNode *TParams) {
692 TrackingVH<MDNode> N(*this);
695 // Check that the new list of members contains all the old members as well.
696 if (const MDNode *El = cast_or_null<MDNode>(N->getOperand(10)))
697 VerifySubsetOf(El, Elements);
699 N->replaceOperandWith(10, Elements);
702 N->replaceOperandWith(13, TParams);
706 /// Generate a reference to this DIType. Uses the type identifier instead
707 /// of the actual MDNode if possible, to help type uniquing.
708 DIScopeRef DIScope::getRef() const {
709 if (!isCompositeType())
710 return DIScopeRef(*this);
711 DICompositeType DTy(DbgNode);
712 if (!DTy.getIdentifier())
713 return DIScopeRef(*this);
714 return DIScopeRef(DTy.getIdentifier());
717 /// \brief Set the containing type.
718 void DICompositeType::setContainingType(DICompositeType ContainingType) {
719 TrackingVH<MDNode> N(*this);
720 N->replaceOperandWith(12, ContainingType.getRef());
724 /// isInlinedFnArgument - Return true if this variable provides debugging
725 /// information for an inlined function arguments.
726 bool DIVariable::isInlinedFnArgument(const Function *CurFn) {
727 assert(CurFn && "Invalid function");
728 if (!getContext().isSubprogram())
730 // This variable is not inlined function argument if its scope
731 // does not describe current function.
732 return !DISubprogram(getContext()).describes(CurFn);
735 /// describes - Return true if this subprogram provides debugging
736 /// information for the function F.
737 bool DISubprogram::describes(const Function *F) {
738 assert(F && "Invalid function");
739 if (F == getFunction())
741 StringRef Name = getLinkageName();
744 if (F->getName() == Name)
749 unsigned DISubprogram::isOptimized() const {
750 assert(DbgNode && "Invalid subprogram descriptor!");
751 if (DbgNode->getNumOperands() == 15)
752 return getUnsignedField(14);
756 MDNode *DISubprogram::getVariablesNodes() const {
757 return getNodeField(DbgNode, 18);
760 DIArray DISubprogram::getVariables() const {
761 return DIArray(getNodeField(DbgNode, 18));
764 Value *DITemplateValueParameter::getValue() const {
765 return getField(DbgNode, 4);
768 // If the current node has a parent scope then return that,
769 // else return an empty scope.
770 DIScopeRef DIScope::getContext() const {
773 return DIType(DbgNode).getContext();
776 return DIScopeRef(DISubprogram(DbgNode).getContext());
778 if (isLexicalBlock())
779 return DIScopeRef(DILexicalBlock(DbgNode).getContext());
781 if (isLexicalBlockFile())
782 return DIScopeRef(DILexicalBlockFile(DbgNode).getContext());
785 return DIScopeRef(DINameSpace(DbgNode).getContext());
787 assert((isFile() || isCompileUnit()) && "Unhandled type of scope.");
788 return DIScopeRef(nullptr);
791 // If the scope node has a name, return that, else return an empty string.
792 StringRef DIScope::getName() const {
794 return DIType(DbgNode).getName();
796 return DISubprogram(DbgNode).getName();
798 return DINameSpace(DbgNode).getName();
799 assert((isLexicalBlock() || isLexicalBlockFile() || isFile() ||
801 "Unhandled type of scope.");
805 StringRef DIScope::getFilename() const {
808 return ::getStringField(getNodeField(DbgNode, 1), 0);
811 StringRef DIScope::getDirectory() const {
814 return ::getStringField(getNodeField(DbgNode, 1), 1);
817 DIArray DICompileUnit::getEnumTypes() const {
818 if (!DbgNode || DbgNode->getNumOperands() < 13)
821 return DIArray(getNodeField(DbgNode, 7));
824 DIArray DICompileUnit::getRetainedTypes() const {
825 if (!DbgNode || DbgNode->getNumOperands() < 13)
828 return DIArray(getNodeField(DbgNode, 8));
831 DIArray DICompileUnit::getSubprograms() const {
832 if (!DbgNode || DbgNode->getNumOperands() < 13)
835 return DIArray(getNodeField(DbgNode, 9));
838 DIArray DICompileUnit::getGlobalVariables() const {
839 if (!DbgNode || DbgNode->getNumOperands() < 13)
842 return DIArray(getNodeField(DbgNode, 10));
845 DIArray DICompileUnit::getImportedEntities() const {
846 if (!DbgNode || DbgNode->getNumOperands() < 13)
849 return DIArray(getNodeField(DbgNode, 11));
852 /// copyWithNewScope - Return a copy of this location, replacing the
853 /// current scope with the given one.
854 DILocation DILocation::copyWithNewScope(LLVMContext &Ctx,
855 DILexicalBlockFile NewScope) {
856 SmallVector<Value *, 10> Elts;
858 for (unsigned I = 0; I < DbgNode->getNumOperands(); ++I) {
860 Elts.push_back(DbgNode->getOperand(I));
862 Elts.push_back(NewScope);
864 MDNode *NewDIL = MDNode::get(Ctx, Elts);
865 return DILocation(NewDIL);
868 /// computeNewDiscriminator - Generate a new discriminator value for this
869 /// file and line location.
870 unsigned DILocation::computeNewDiscriminator(LLVMContext &Ctx) {
871 std::pair<const char *, unsigned> Key(getFilename().data(), getLineNumber());
872 return ++Ctx.pImpl->DiscriminatorTable[Key];
875 /// fixupSubprogramName - Replace contains special characters used
876 /// in a typical Objective-C names with '.' in a given string.
877 static void fixupSubprogramName(DISubprogram Fn, SmallVectorImpl<char> &Out) {
879 Fn.getFunction() ? Fn.getFunction()->getName() : Fn.getName();
880 FName = Function::getRealLinkageName(FName);
882 StringRef Prefix("llvm.dbg.lv.");
883 Out.reserve(FName.size() + Prefix.size());
884 Out.append(Prefix.begin(), Prefix.end());
886 bool isObjCLike = false;
887 for (size_t i = 0, e = FName.size(); i < e; ++i) {
892 if (isObjCLike && (C == '[' || C == ']' || C == ' ' || C == ':' ||
893 C == '+' || C == '(' || C == ')'))
900 /// getFnSpecificMDNode - Return a NameMDNode, if available, that is
901 /// suitable to hold function specific information.
902 NamedMDNode *llvm::getFnSpecificMDNode(const Module &M, DISubprogram Fn) {
903 SmallString<32> Name;
904 fixupSubprogramName(Fn, Name);
905 return M.getNamedMetadata(Name.str());
908 /// getOrInsertFnSpecificMDNode - Return a NameMDNode that is suitable
909 /// to hold function specific information.
910 NamedMDNode *llvm::getOrInsertFnSpecificMDNode(Module &M, DISubprogram Fn) {
911 SmallString<32> Name;
912 fixupSubprogramName(Fn, Name);
913 return M.getOrInsertNamedMetadata(Name.str());
916 /// createInlinedVariable - Create a new inlined variable based on current
918 /// @param DV Current Variable.
919 /// @param InlinedScope Location at current variable is inlined.
920 DIVariable llvm::createInlinedVariable(MDNode *DV, MDNode *InlinedScope,
921 LLVMContext &VMContext) {
922 SmallVector<Value *, 16> Elts;
923 // Insert inlined scope as 7th element.
924 for (unsigned i = 0, e = DV->getNumOperands(); i != e; ++i)
925 i == 7 ? Elts.push_back(InlinedScope) : Elts.push_back(DV->getOperand(i));
926 return DIVariable(MDNode::get(VMContext, Elts));
929 /// cleanseInlinedVariable - Remove inlined scope from the variable.
930 DIVariable llvm::cleanseInlinedVariable(MDNode *DV, LLVMContext &VMContext) {
931 SmallVector<Value *, 16> Elts;
932 // Insert inlined scope as 7th element.
933 for (unsigned i = 0, e = DV->getNumOperands(); i != e; ++i)
934 i == 7 ? Elts.push_back(Constant::getNullValue(Type::getInt32Ty(VMContext)))
935 : Elts.push_back(DV->getOperand(i));
936 return DIVariable(MDNode::get(VMContext, Elts));
940 /// getEntireVariable - Remove OpPiece exprs from the variable.
941 DIVariable llvm::getEntireVariable(DIVariable DV) {
942 if (!DV.isVariablePiece())
945 SmallVector<Value *, 8> Elts;
946 for (unsigned i = 0; i < 8; ++i)
947 Elts.push_back(DV->getOperand(i));
949 return DIVariable(MDNode::get(DV->getContext(), Elts));
952 /// getDISubprogram - Find subprogram that is enclosing this scope.
953 DISubprogram llvm::getDISubprogram(const MDNode *Scope) {
954 DIDescriptor D(Scope);
955 if (D.isSubprogram())
956 return DISubprogram(Scope);
958 if (D.isLexicalBlockFile())
959 return getDISubprogram(DILexicalBlockFile(Scope).getContext());
961 if (D.isLexicalBlock())
962 return getDISubprogram(DILexicalBlock(Scope).getContext());
964 return DISubprogram();
967 /// getDICompositeType - Find underlying composite type.
968 DICompositeType llvm::getDICompositeType(DIType T) {
969 if (T.isCompositeType())
970 return DICompositeType(T);
972 if (T.isDerivedType()) {
973 // This function is currently used by dragonegg and dragonegg does
974 // not generate identifier for types, so using an empty map to resolve
975 // DerivedFrom should be fine.
976 DITypeIdentifierMap EmptyMap;
977 return getDICompositeType(
978 DIDerivedType(T).getTypeDerivedFrom().resolve(EmptyMap));
981 return DICompositeType();
984 /// Update DITypeIdentifierMap by going through retained types of each CU.
986 llvm::generateDITypeIdentifierMap(const NamedMDNode *CU_Nodes) {
987 DITypeIdentifierMap Map;
988 for (unsigned CUi = 0, CUe = CU_Nodes->getNumOperands(); CUi != CUe; ++CUi) {
989 DICompileUnit CU(CU_Nodes->getOperand(CUi));
990 DIArray Retain = CU.getRetainedTypes();
991 for (unsigned Ti = 0, Te = Retain.getNumElements(); Ti != Te; ++Ti) {
992 if (!Retain.getElement(Ti).isCompositeType())
994 DICompositeType Ty(Retain.getElement(Ti));
995 if (MDString *TypeId = Ty.getIdentifier()) {
996 // Definition has priority over declaration.
997 // Try to insert (TypeId, Ty) to Map.
998 std::pair<DITypeIdentifierMap::iterator, bool> P =
999 Map.insert(std::make_pair(TypeId, Ty));
1000 // If TypeId already exists in Map and this is a definition, replace
1001 // whatever we had (declaration or definition) with the definition.
1002 if (!P.second && !Ty.isForwardDecl())
1003 P.first->second = Ty;
1010 //===----------------------------------------------------------------------===//
1011 // DebugInfoFinder implementations.
1012 //===----------------------------------------------------------------------===//
1014 void DebugInfoFinder::reset() {
1021 TypeIdentifierMap.clear();
1022 TypeMapInitialized = false;
1025 void DebugInfoFinder::InitializeTypeMap(const Module &M) {
1026 if (!TypeMapInitialized)
1027 if (NamedMDNode *CU_Nodes = M.getNamedMetadata("llvm.dbg.cu")) {
1028 TypeIdentifierMap = generateDITypeIdentifierMap(CU_Nodes);
1029 TypeMapInitialized = true;
1033 /// processModule - Process entire module and collect debug info.
1034 void DebugInfoFinder::processModule(const Module &M) {
1035 InitializeTypeMap(M);
1036 if (NamedMDNode *CU_Nodes = M.getNamedMetadata("llvm.dbg.cu")) {
1037 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
1038 DICompileUnit CU(CU_Nodes->getOperand(i));
1040 DIArray GVs = CU.getGlobalVariables();
1041 for (unsigned i = 0, e = GVs.getNumElements(); i != e; ++i) {
1042 DIGlobalVariable DIG(GVs.getElement(i));
1043 if (addGlobalVariable(DIG)) {
1044 processScope(DIG.getContext());
1045 processType(DIG.getType().resolve(TypeIdentifierMap));
1048 DIArray SPs = CU.getSubprograms();
1049 for (unsigned i = 0, e = SPs.getNumElements(); i != e; ++i)
1050 processSubprogram(DISubprogram(SPs.getElement(i)));
1051 DIArray EnumTypes = CU.getEnumTypes();
1052 for (unsigned i = 0, e = EnumTypes.getNumElements(); i != e; ++i)
1053 processType(DIType(EnumTypes.getElement(i)));
1054 DIArray RetainedTypes = CU.getRetainedTypes();
1055 for (unsigned i = 0, e = RetainedTypes.getNumElements(); i != e; ++i)
1056 processType(DIType(RetainedTypes.getElement(i)));
1057 DIArray Imports = CU.getImportedEntities();
1058 for (unsigned i = 0, e = Imports.getNumElements(); i != e; ++i) {
1059 DIImportedEntity Import = DIImportedEntity(Imports.getElement(i));
1060 DIDescriptor Entity = Import.getEntity().resolve(TypeIdentifierMap);
1061 if (Entity.isType())
1062 processType(DIType(Entity));
1063 else if (Entity.isSubprogram())
1064 processSubprogram(DISubprogram(Entity));
1065 else if (Entity.isNameSpace())
1066 processScope(DINameSpace(Entity).getContext());
1072 /// processLocation - Process DILocation.
1073 void DebugInfoFinder::processLocation(const Module &M, DILocation Loc) {
1076 InitializeTypeMap(M);
1077 processScope(Loc.getScope());
1078 processLocation(M, Loc.getOrigLocation());
1081 /// processType - Process DIType.
1082 void DebugInfoFinder::processType(DIType DT) {
1085 processScope(DT.getContext().resolve(TypeIdentifierMap));
1086 if (DT.isCompositeType()) {
1087 DICompositeType DCT(DT);
1088 processType(DCT.getTypeDerivedFrom().resolve(TypeIdentifierMap));
1089 if (DT.isSubroutineType()) {
1090 DITypeArray DTA = DISubroutineType(DT).getTypeArray();
1091 for (unsigned i = 0, e = DTA.getNumElements(); i != e; ++i)
1092 processType(DTA.getElement(i).resolve(TypeIdentifierMap));
1095 DIArray DA = DCT.getElements();
1096 for (unsigned i = 0, e = DA.getNumElements(); i != e; ++i) {
1097 DIDescriptor D = DA.getElement(i);
1099 processType(DIType(D));
1100 else if (D.isSubprogram())
1101 processSubprogram(DISubprogram(D));
1103 } else if (DT.isDerivedType()) {
1104 DIDerivedType DDT(DT);
1105 processType(DDT.getTypeDerivedFrom().resolve(TypeIdentifierMap));
1109 void DebugInfoFinder::processScope(DIScope Scope) {
1110 if (Scope.isType()) {
1115 if (Scope.isCompileUnit()) {
1116 addCompileUnit(DICompileUnit(Scope));
1119 if (Scope.isSubprogram()) {
1120 processSubprogram(DISubprogram(Scope));
1123 if (!addScope(Scope))
1125 if (Scope.isLexicalBlock()) {
1126 DILexicalBlock LB(Scope);
1127 processScope(LB.getContext());
1128 } else if (Scope.isLexicalBlockFile()) {
1129 DILexicalBlockFile LBF = DILexicalBlockFile(Scope);
1130 processScope(LBF.getScope());
1131 } else if (Scope.isNameSpace()) {
1132 DINameSpace NS(Scope);
1133 processScope(NS.getContext());
1137 /// processSubprogram - Process DISubprogram.
1138 void DebugInfoFinder::processSubprogram(DISubprogram SP) {
1139 if (!addSubprogram(SP))
1141 processScope(SP.getContext().resolve(TypeIdentifierMap));
1142 processType(SP.getType());
1143 DIArray TParams = SP.getTemplateParams();
1144 for (unsigned I = 0, E = TParams.getNumElements(); I != E; ++I) {
1145 DIDescriptor Element = TParams.getElement(I);
1146 if (Element.isTemplateTypeParameter()) {
1147 DITemplateTypeParameter TType(Element);
1148 processScope(TType.getContext().resolve(TypeIdentifierMap));
1149 processType(TType.getType().resolve(TypeIdentifierMap));
1150 } else if (Element.isTemplateValueParameter()) {
1151 DITemplateValueParameter TVal(Element);
1152 processScope(TVal.getContext().resolve(TypeIdentifierMap));
1153 processType(TVal.getType().resolve(TypeIdentifierMap));
1158 /// processDeclare - Process DbgDeclareInst.
1159 void DebugInfoFinder::processDeclare(const Module &M,
1160 const DbgDeclareInst *DDI) {
1161 MDNode *N = dyn_cast<MDNode>(DDI->getVariable());
1164 InitializeTypeMap(M);
1167 if (!DV.isVariable())
1170 if (!NodesSeen.insert(DV))
1172 processScope(DIVariable(N).getContext());
1173 processType(DIVariable(N).getType().resolve(TypeIdentifierMap));
1176 void DebugInfoFinder::processValue(const Module &M, const DbgValueInst *DVI) {
1177 MDNode *N = dyn_cast<MDNode>(DVI->getVariable());
1180 InitializeTypeMap(M);
1183 if (!DV.isVariable())
1186 if (!NodesSeen.insert(DV))
1188 processScope(DIVariable(N).getContext());
1189 processType(DIVariable(N).getType().resolve(TypeIdentifierMap));
1192 /// addType - Add type into Tys.
1193 bool DebugInfoFinder::addType(DIType DT) {
1197 if (!NodesSeen.insert(DT))
1204 /// addCompileUnit - Add compile unit into CUs.
1205 bool DebugInfoFinder::addCompileUnit(DICompileUnit CU) {
1208 if (!NodesSeen.insert(CU))
1215 /// addGlobalVariable - Add global variable into GVs.
1216 bool DebugInfoFinder::addGlobalVariable(DIGlobalVariable DIG) {
1220 if (!NodesSeen.insert(DIG))
1227 // addSubprogram - Add subprgoram into SPs.
1228 bool DebugInfoFinder::addSubprogram(DISubprogram SP) {
1232 if (!NodesSeen.insert(SP))
1239 bool DebugInfoFinder::addScope(DIScope Scope) {
1242 // FIXME: Ocaml binding generates a scope with no content, we treat it
1244 if (Scope->getNumOperands() == 0)
1246 if (!NodesSeen.insert(Scope))
1248 Scopes.push_back(Scope);
1252 //===----------------------------------------------------------------------===//
1253 // DIDescriptor: dump routines for all descriptors.
1254 //===----------------------------------------------------------------------===//
1256 /// dump - Print descriptor to dbgs() with a newline.
1257 void DIDescriptor::dump() const {
1262 /// print - Print descriptor.
1263 void DIDescriptor::print(raw_ostream &OS) const {
1267 if (const char *Tag = dwarf::TagString(getTag()))
1268 OS << "[ " << Tag << " ]";
1270 if (this->isSubrange()) {
1271 DISubrange(DbgNode).printInternal(OS);
1272 } else if (this->isCompileUnit()) {
1273 DICompileUnit(DbgNode).printInternal(OS);
1274 } else if (this->isFile()) {
1275 DIFile(DbgNode).printInternal(OS);
1276 } else if (this->isEnumerator()) {
1277 DIEnumerator(DbgNode).printInternal(OS);
1278 } else if (this->isBasicType()) {
1279 DIType(DbgNode).printInternal(OS);
1280 } else if (this->isDerivedType()) {
1281 DIDerivedType(DbgNode).printInternal(OS);
1282 } else if (this->isCompositeType()) {
1283 DICompositeType(DbgNode).printInternal(OS);
1284 } else if (this->isSubprogram()) {
1285 DISubprogram(DbgNode).printInternal(OS);
1286 } else if (this->isGlobalVariable()) {
1287 DIGlobalVariable(DbgNode).printInternal(OS);
1288 } else if (this->isVariable()) {
1289 DIVariable(DbgNode).printInternal(OS);
1290 } else if (this->isObjCProperty()) {
1291 DIObjCProperty(DbgNode).printInternal(OS);
1292 } else if (this->isNameSpace()) {
1293 DINameSpace(DbgNode).printInternal(OS);
1294 } else if (this->isScope()) {
1295 DIScope(DbgNode).printInternal(OS);
1299 void DISubrange::printInternal(raw_ostream &OS) const {
1300 int64_t Count = getCount();
1302 OS << " [" << getLo() << ", " << Count - 1 << ']';
1304 OS << " [unbounded]";
1307 void DIScope::printInternal(raw_ostream &OS) const {
1308 OS << " [" << getDirectory() << "/" << getFilename() << ']';
1311 void DICompileUnit::printInternal(raw_ostream &OS) const {
1312 DIScope::printInternal(OS);
1314 unsigned Lang = getLanguage();
1315 if (const char *LangStr = dwarf::LanguageString(Lang))
1318 (OS << "lang 0x").write_hex(Lang);
1322 void DIEnumerator::printInternal(raw_ostream &OS) const {
1323 OS << " [" << getName() << " :: " << getEnumValue() << ']';
1326 void DIType::printInternal(raw_ostream &OS) const {
1330 StringRef Res = getName();
1332 OS << " [" << Res << "]";
1334 // TODO: Print context?
1336 OS << " [line " << getLineNumber() << ", size " << getSizeInBits()
1337 << ", align " << getAlignInBits() << ", offset " << getOffsetInBits();
1339 if (const char *Enc =
1340 dwarf::AttributeEncodingString(DIBasicType(DbgNode).getEncoding()))
1341 OS << ", enc " << Enc;
1346 else if (isProtected())
1347 OS << " [protected]";
1348 else if (isPublic())
1352 OS << " [artificial]";
1354 if (isForwardDecl())
1356 else if (getTag() == dwarf::DW_TAG_structure_type ||
1357 getTag() == dwarf::DW_TAG_union_type ||
1358 getTag() == dwarf::DW_TAG_enumeration_type ||
1359 getTag() == dwarf::DW_TAG_class_type)
1363 if (isStaticMember())
1366 if (isLValueReference())
1367 OS << " [reference]";
1369 if (isRValueReference())
1370 OS << " [rvalue reference]";
1373 void DIDerivedType::printInternal(raw_ostream &OS) const {
1374 DIType::printInternal(OS);
1375 OS << " [from " << getTypeDerivedFrom().getName() << ']';
1378 void DICompositeType::printInternal(raw_ostream &OS) const {
1379 DIType::printInternal(OS);
1380 DIArray A = getElements();
1381 OS << " [" << A.getNumElements() << " elements]";
1384 void DINameSpace::printInternal(raw_ostream &OS) const {
1385 StringRef Name = getName();
1387 OS << " [" << Name << ']';
1389 OS << " [line " << getLineNumber() << ']';
1392 void DISubprogram::printInternal(raw_ostream &OS) const {
1393 // TODO : Print context
1394 OS << " [line " << getLineNumber() << ']';
1396 if (isLocalToUnit())
1402 if (getScopeLineNumber() != getLineNumber())
1403 OS << " [scope " << getScopeLineNumber() << "]";
1407 else if (isProtected())
1408 OS << " [protected]";
1409 else if (isPublic())
1412 if (isLValueReference())
1413 OS << " [reference]";
1415 if (isRValueReference())
1416 OS << " [rvalue reference]";
1418 StringRef Res = getName();
1420 OS << " [" << Res << ']';
1423 void DIGlobalVariable::printInternal(raw_ostream &OS) const {
1424 StringRef Res = getName();
1426 OS << " [" << Res << ']';
1428 OS << " [line " << getLineNumber() << ']';
1430 // TODO : Print context
1432 if (isLocalToUnit())
1439 void DIVariable::printInternal(raw_ostream &OS) const {
1440 StringRef Res = getName();
1442 OS << " [" << Res << ']';
1444 OS << " [line " << getLineNumber() << ']';
1446 if (isVariablePiece())
1447 OS << " [piece, size " << getPieceSize()
1448 << ", offset " << getPieceOffset() << ']';
1451 void DIObjCProperty::printInternal(raw_ostream &OS) const {
1452 StringRef Name = getObjCPropertyName();
1454 OS << " [" << Name << ']';
1456 OS << " [line " << getLineNumber() << ", properties " << getUnsignedField(6)
1460 static void printDebugLoc(DebugLoc DL, raw_ostream &CommentOS,
1461 const LLVMContext &Ctx) {
1462 if (!DL.isUnknown()) { // Print source line info.
1463 DIScope Scope(DL.getScope(Ctx));
1464 assert(Scope.isScope() && "Scope of a DebugLoc should be a DIScope.");
1465 // Omit the directory, because it's likely to be long and uninteresting.
1466 CommentOS << Scope.getFilename();
1467 CommentOS << ':' << DL.getLine();
1468 if (DL.getCol() != 0)
1469 CommentOS << ':' << DL.getCol();
1470 DebugLoc InlinedAtDL = DebugLoc::getFromDILocation(DL.getInlinedAt(Ctx));
1471 if (!InlinedAtDL.isUnknown()) {
1472 CommentOS << " @[ ";
1473 printDebugLoc(InlinedAtDL, CommentOS, Ctx);
1479 void DIVariable::printExtendedName(raw_ostream &OS) const {
1480 const LLVMContext &Ctx = DbgNode->getContext();
1481 StringRef Res = getName();
1483 OS << Res << "," << getLineNumber();
1484 if (MDNode *InlinedAt = getInlinedAt()) {
1485 DebugLoc InlinedAtDL = DebugLoc::getFromDILocation(InlinedAt);
1486 if (!InlinedAtDL.isUnknown()) {
1488 printDebugLoc(InlinedAtDL, OS, Ctx);
1494 /// Specialize constructor to make sure it has the correct type.
1495 template <> DIRef<DIScope>::DIRef(const Value *V) : Val(V) {
1496 assert(isScopeRef(V) && "DIScopeRef should be a MDString or MDNode");
1498 template <> DIRef<DIType>::DIRef(const Value *V) : Val(V) {
1499 assert(isTypeRef(V) && "DITypeRef should be a MDString or MDNode");
1502 /// Specialize getFieldAs to handle fields that are references to DIScopes.
1504 DIScopeRef DIDescriptor::getFieldAs<DIScopeRef>(unsigned Elt) const {
1505 return DIScopeRef(getField(DbgNode, Elt));
1507 /// Specialize getFieldAs to handle fields that are references to DITypes.
1508 template <> DITypeRef DIDescriptor::getFieldAs<DITypeRef>(unsigned Elt) const {
1509 return DITypeRef(getField(DbgNode, Elt));
1512 /// Strip debug info in the module if it exists.
1513 /// To do this, we remove all calls to the debugger intrinsics and any named
1514 /// metadata for debugging. We also remove debug locations for instructions.
1515 /// Return true if module is modified.
1516 bool llvm::StripDebugInfo(Module &M) {
1518 bool Changed = false;
1520 // Remove all of the calls to the debugger intrinsics, and remove them from
1522 if (Function *Declare = M.getFunction("llvm.dbg.declare")) {
1523 while (!Declare->use_empty()) {
1524 CallInst *CI = cast<CallInst>(Declare->user_back());
1525 CI->eraseFromParent();
1527 Declare->eraseFromParent();
1531 if (Function *DbgVal = M.getFunction("llvm.dbg.value")) {
1532 while (!DbgVal->use_empty()) {
1533 CallInst *CI = cast<CallInst>(DbgVal->user_back());
1534 CI->eraseFromParent();
1536 DbgVal->eraseFromParent();
1540 for (Module::named_metadata_iterator NMI = M.named_metadata_begin(),
1541 NME = M.named_metadata_end(); NMI != NME;) {
1542 NamedMDNode *NMD = NMI;
1544 if (NMD->getName().startswith("llvm.dbg.")) {
1545 NMD->eraseFromParent();
1550 for (Module::iterator MI = M.begin(), ME = M.end(); MI != ME; ++MI)
1551 for (Function::iterator FI = MI->begin(), FE = MI->end(); FI != FE;
1553 for (BasicBlock::iterator BI = FI->begin(), BE = FI->end(); BI != BE;
1555 if (!BI->getDebugLoc().isUnknown()) {
1557 BI->setDebugLoc(DebugLoc());
1564 /// Return Debug Info Metadata Version by checking module flags.
1565 unsigned llvm::getDebugMetadataVersionFromModule(const Module &M) {
1566 Value *Val = M.getModuleFlag("Debug Info Version");
1569 return cast<ConstantInt>(Val)->getZExtValue();
1572 llvm::DenseMap<const llvm::Function *, llvm::DISubprogram>
1573 llvm::makeSubprogramMap(const Module &M) {
1574 DenseMap<const Function *, DISubprogram> R;
1576 NamedMDNode *CU_Nodes = M.getNamedMetadata("llvm.dbg.cu");
1580 for (MDNode *N : CU_Nodes->operands()) {
1581 DICompileUnit CUNode(N);
1582 DIArray SPs = CUNode.getSubprograms();
1583 for (unsigned i = 0, e = SPs.getNumElements(); i != e; ++i) {
1584 DISubprogram SP(SPs.getElement(i));
1585 if (Function *F = SP.getFunction())
1586 R.insert(std::make_pair(F, SP));