blob: d3207cae350502fec442be1aa80e28eab67d213b [file] [log] [blame]
Chris Lattnera45664f2008-11-10 02:56:27 +00001//===--- DebugInfo.cpp - Debug Information Helper Classes -----------------===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This file implements the helper classes used to build and interpret debug
11// information in LLVM IR form.
12//
13//===----------------------------------------------------------------------===//
14
Bill Wendling0bcbd1d2012-06-28 00:05:13 +000015#include "llvm/DebugInfo.h"
Chandler Carruthd04a8d42012-12-03 16:50:05 +000016#include "llvm/ADT/STLExtras.h"
Devang Patele4b27562009-08-28 23:24:31 +000017#include "llvm/ADT/SmallPtrSet.h"
Dan Gohman17aa92c2010-07-21 23:38:33 +000018#include "llvm/ADT/SmallString.h"
Chandler Carruthd04a8d42012-12-03 16:50:05 +000019#include "llvm/Analysis/ValueTracking.h"
Chandler Carruth0b8c9a82013-01-02 11:36:10 +000020#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"
David Greene0eb5b662009-12-23 19:45:49 +000026#include "llvm/Support/Debug.h"
Argyrios Kyrtzidis77eaa682009-05-03 08:50:41 +000027#include "llvm/Support/Dwarf.h"
David Blaikied072a162013-03-26 21:59:17 +000028#include "llvm/Support/ValueHandle.h"
Chris Lattnera81d29b2009-08-23 07:33:14 +000029#include "llvm/Support/raw_ostream.h"
Chris Lattnera45664f2008-11-10 02:56:27 +000030using namespace llvm;
Argyrios Kyrtzidis77eaa682009-05-03 08:50:41 +000031using namespace llvm::dwarf;
Chris Lattnera45664f2008-11-10 02:56:27 +000032
33//===----------------------------------------------------------------------===//
34// DIDescriptor
35//===----------------------------------------------------------------------===//
36
David Blaikiec0ec8a42013-03-11 23:39:23 +000037bool 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() ||
David Blaikiec462db62013-04-22 06:12:31 +000049 DITemplateValueParameter(DbgNode).Verify() ||
David Blaikie20d9e412013-05-07 21:35:53 +000050 DIImportedEntity(DbgNode).Verify());
David Blaikiec0ec8a42013-03-11 23:39:23 +000051}
52
David Blaikieb4cf0ab2013-03-17 21:13:55 +000053static Value *getField(const MDNode *DbgNode, unsigned Elt) {
54 if (DbgNode == 0 || Elt >= DbgNode->getNumOperands())
55 return 0;
56 return DbgNode->getOperand(Elt);
57}
Chris Lattnera45664f2008-11-10 02:56:27 +000058
Manman Rend2ed53c2013-07-23 20:39:32 +000059static MDNode *getNodeField(const MDNode *DbgNode, unsigned Elt) {
60 return dyn_cast_or_null<MDNode>(getField(DbgNode, Elt));
David Blaikieb4cf0ab2013-03-17 21:13:55 +000061}
Daniel Dunbarf612ff62009-09-19 20:40:05 +000062
David Blaikieb4cf0ab2013-03-17 21:13:55 +000063static StringRef getStringField(const MDNode *DbgNode, unsigned Elt) {
64 if (MDString *MDS = dyn_cast_or_null<MDString>(getField(DbgNode, Elt)))
65 return MDS->getString();
Devang Patel65dbc902009-11-25 17:36:49 +000066 return StringRef();
Chris Lattnera45664f2008-11-10 02:56:27 +000067}
68
David Blaikieb4cf0ab2013-03-17 21:13:55 +000069StringRef DIDescriptor::getStringField(unsigned Elt) const {
70 return ::getStringField(DbgNode, Elt);
71}
72
Chris Lattnera45664f2008-11-10 02:56:27 +000073uint64_t DIDescriptor::getUInt64Field(unsigned Elt) const {
Daniel Dunbarf612ff62009-09-19 20:40:05 +000074 if (DbgNode == 0)
Chris Lattnera45664f2008-11-10 02:56:27 +000075 return 0;
Bill Wendlingdc817b62009-05-14 18:26:15 +000076
Chris Lattner5d0cacd2009-12-31 01:22:29 +000077 if (Elt < DbgNode->getNumOperands())
Eric Christopher5f214ae2012-11-20 00:15:36 +000078 if (ConstantInt *CI
79 = dyn_cast_or_null<ConstantInt>(DbgNode->getOperand(Elt)))
Devang Patele4b27562009-08-28 23:24:31 +000080 return CI->getZExtValue();
Daniel Dunbarf612ff62009-09-19 20:40:05 +000081
Chris Lattnera45664f2008-11-10 02:56:27 +000082 return 0;
83}
84
Bill Wendling9127be82012-12-03 19:44:25 +000085int64_t DIDescriptor::getInt64Field(unsigned Elt) const {
86 if (DbgNode == 0)
87 return 0;
88
89 if (Elt < DbgNode->getNumOperands())
90 if (ConstantInt *CI
91 = dyn_cast_or_null<ConstantInt>(DbgNode->getOperand(Elt)))
92 return CI->getSExtValue();
93
94 return 0;
95}
96
Chris Lattnera45664f2008-11-10 02:56:27 +000097DIDescriptor DIDescriptor::getDescriptorField(unsigned Elt) const {
Manman Rend2ed53c2013-07-23 20:39:32 +000098 MDNode *Field = getNodeField(DbgNode, Elt);
99 return DIDescriptor(Field);
Chris Lattnera45664f2008-11-10 02:56:27 +0000100}
101
102GlobalVariable *DIDescriptor::getGlobalVariableField(unsigned Elt) const {
Daniel Dunbarf612ff62009-09-19 20:40:05 +0000103 if (DbgNode == 0)
Chris Lattnera45664f2008-11-10 02:56:27 +0000104 return 0;
Bill Wendlingdc817b62009-05-14 18:26:15 +0000105
Chris Lattner5d0cacd2009-12-31 01:22:29 +0000106 if (Elt < DbgNode->getNumOperands())
107 return dyn_cast_or_null<GlobalVariable>(DbgNode->getOperand(Elt));
Devang Patele4b27562009-08-28 23:24:31 +0000108 return 0;
Chris Lattnera45664f2008-11-10 02:56:27 +0000109}
110
Devang Patel27398962010-08-09 21:39:24 +0000111Constant *DIDescriptor::getConstantField(unsigned Elt) const {
112 if (DbgNode == 0)
113 return 0;
114
115 if (Elt < DbgNode->getNumOperands())
116 return dyn_cast_or_null<Constant>(DbgNode->getOperand(Elt));
117 return 0;
118}
119
Stuart Hastings215aa152010-06-11 20:08:44 +0000120Function *DIDescriptor::getFunctionField(unsigned Elt) const {
121 if (DbgNode == 0)
122 return 0;
123
124 if (Elt < DbgNode->getNumOperands())
125 return dyn_cast_or_null<Function>(DbgNode->getOperand(Elt));
126 return 0;
127}
128
Alexey Samsonove97a3a42012-10-09 08:13:15 +0000129void DIDescriptor::replaceFunctionField(unsigned Elt, Function *F) {
130 if (DbgNode == 0)
131 return;
132
133 if (Elt < DbgNode->getNumOperands()) {
134 MDNode *Node = const_cast<MDNode*>(DbgNode);
135 Node->replaceOperandWith(Elt, F);
136 }
137}
138
Chris Lattnerf0908a32009-12-31 03:02:08 +0000139unsigned DIVariable::getNumAddrElements() const {
Devang Patel23336b42011-07-19 19:41:54 +0000140 return DbgNode->getNumOperands()-8;
Chris Lattnerf0908a32009-12-31 03:02:08 +0000141}
142
Devang Patel40c7e412011-07-20 22:18:50 +0000143/// getInlinedAt - If this variable is inlined then return inline location.
Devang Patel48d726f2011-08-09 01:03:14 +0000144MDNode *DIVariable::getInlinedAt() const {
Manman Rend2ed53c2013-07-23 20:39:32 +0000145 return getNodeField(DbgNode, 7);
Devang Patel40c7e412011-07-20 22:18:50 +0000146}
Chris Lattnerf0908a32009-12-31 03:02:08 +0000147
Chris Lattnera45664f2008-11-10 02:56:27 +0000148//===----------------------------------------------------------------------===//
Devang Patel6ceea332009-08-31 18:49:10 +0000149// Predicates
Chris Lattnera45664f2008-11-10 02:56:27 +0000150//===----------------------------------------------------------------------===//
151
Devang Patel6ceea332009-08-31 18:49:10 +0000152/// isBasicType - Return true if the specified tag is legal for
153/// DIBasicType.
154bool DIDescriptor::isBasicType() const {
Devang Patel734a67c2011-09-14 23:13:28 +0000155 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 }
Torok Edwinb07fbd92008-12-13 08:25:29 +0000163}
Chris Lattnera45664f2008-11-10 02:56:27 +0000164
Devang Patel6ceea332009-08-31 18:49:10 +0000165/// isDerivedType - Return true if the specified tag is legal for DIDerivedType.
166bool DIDescriptor::isDerivedType() const {
Devang Patel3c91b052010-03-08 20:52:55 +0000167 if (!DbgNode) return false;
Chris Lattner099b7792009-12-29 09:22:47 +0000168 switch (getTag()) {
Chris Lattnera45664f2008-11-10 02:56:27 +0000169 case dwarf::DW_TAG_typedef:
170 case dwarf::DW_TAG_pointer_type:
David Blaikie62fdfb52013-01-07 05:51:15 +0000171 case dwarf::DW_TAG_ptr_to_member_type:
Chris Lattnera45664f2008-11-10 02:56:27 +0000172 case dwarf::DW_TAG_reference_type:
Eric Christopher791e6292012-05-19 01:36:37 +0000173 case dwarf::DW_TAG_rvalue_reference_type:
Chris Lattnera45664f2008-11-10 02:56:27 +0000174 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:
Devang Patel49d96382010-08-23 23:16:25 +0000179 case dwarf::DW_TAG_friend:
Chris Lattnera45664f2008-11-10 02:56:27 +0000180 return true;
181 default:
Devang Patele4b27562009-08-28 23:24:31 +0000182 // CompositeTypes are currently modelled as DerivedTypes.
Devang Patel6ceea332009-08-31 18:49:10 +0000183 return isCompositeType();
Chris Lattnera45664f2008-11-10 02:56:27 +0000184 }
185}
186
Chris Lattnera45664f2008-11-10 02:56:27 +0000187/// isCompositeType - Return true if the specified tag is legal for
188/// DICompositeType.
Devang Patel6ceea332009-08-31 18:49:10 +0000189bool DIDescriptor::isCompositeType() const {
Devang Patel3c91b052010-03-08 20:52:55 +0000190 if (!DbgNode) return false;
Chris Lattner099b7792009-12-29 09:22:47 +0000191 switch (getTag()) {
Chris Lattnera45664f2008-11-10 02:56:27 +0000192 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:
Chris Lattnera45664f2008-11-10 02:56:27 +0000196 case dwarf::DW_TAG_subroutine_type:
Devang Patel25cb0d72009-03-25 03:52:06 +0000197 case dwarf::DW_TAG_class_type:
Chris Lattnera45664f2008-11-10 02:56:27 +0000198 return true;
199 default:
200 return false;
201 }
202}
203
Chris Lattnera45664f2008-11-10 02:56:27 +0000204/// isVariable - Return true if the specified tag is legal for DIVariable.
Devang Patel6ceea332009-08-31 18:49:10 +0000205bool DIDescriptor::isVariable() const {
Devang Patel3c91b052010-03-08 20:52:55 +0000206 if (!DbgNode) return false;
Chris Lattner099b7792009-12-29 09:22:47 +0000207 switch (getTag()) {
Chris Lattnera45664f2008-11-10 02:56:27 +0000208 case dwarf::DW_TAG_auto_variable:
209 case dwarf::DW_TAG_arg_variable:
Chris Lattnera45664f2008-11-10 02:56:27 +0000210 return true;
211 default:
212 return false;
213 }
214}
215
Devang Patelecbeb1a2009-09-30 22:34:41 +0000216/// isType - Return true if the specified tag is legal for DIType.
217bool DIDescriptor::isType() const {
218 return isBasicType() || isCompositeType() || isDerivedType();
219}
220
Devang Patel6ceea332009-08-31 18:49:10 +0000221/// isSubprogram - Return true if the specified tag is legal for
222/// DISubprogram.
223bool DIDescriptor::isSubprogram() const {
Devang Patel3c91b052010-03-08 20:52:55 +0000224 return DbgNode && getTag() == dwarf::DW_TAG_subprogram;
Devang Patel6ceea332009-08-31 18:49:10 +0000225}
226
227/// isGlobalVariable - Return true if the specified tag is legal for
228/// DIGlobalVariable.
229bool DIDescriptor::isGlobalVariable() const {
Devang Patel29368072010-08-10 07:11:13 +0000230 return DbgNode && (getTag() == dwarf::DW_TAG_variable ||
231 getTag() == dwarf::DW_TAG_constant);
Devang Patel6ceea332009-08-31 18:49:10 +0000232}
233
Devang Patel716a67f2011-02-03 00:13:47 +0000234/// isUnspecifiedParmeter - Return true if the specified tag is
Devang Pateld6747df2010-10-06 20:50:40 +0000235/// DW_TAG_unspecified_parameters.
236bool DIDescriptor::isUnspecifiedParameter() const {
237 return DbgNode && getTag() == dwarf::DW_TAG_unspecified_parameters;
238}
239
Daniel Dunbarf612ff62009-09-19 20:40:05 +0000240/// isScope - Return true if the specified tag is one of the scope
Devang Patel43d98b32009-08-31 20:44:45 +0000241/// related tag.
242bool DIDescriptor::isScope() const {
Devang Patel3c91b052010-03-08 20:52:55 +0000243 if (!DbgNode) return false;
Chris Lattner099b7792009-12-29 09:22:47 +0000244 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;
Devang Patel43d98b32009-08-31 20:44:45 +0000252 }
253 return false;
254}
Devang Patel6ceea332009-08-31 18:49:10 +0000255
Devang Patel7e2cb112011-02-02 21:38:25 +0000256/// isTemplateTypeParameter - Return true if the specified tag is
257/// DW_TAG_template_type_parameter.
258bool DIDescriptor::isTemplateTypeParameter() const {
259 return DbgNode && getTag() == dwarf::DW_TAG_template_type_parameter;
260}
261
Devang Patele7d93872011-02-02 22:35:53 +0000262/// isTemplateValueParameter - Return true if the specified tag is
263/// DW_TAG_template_value_parameter.
264bool DIDescriptor::isTemplateValueParameter() const {
David Blaikiee88939c2013-06-22 18:59:11 +0000265 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);
Devang Patele7d93872011-02-02 22:35:53 +0000268}
269
Devang Patelc9f322d2009-08-31 21:34:44 +0000270/// isCompileUnit - Return true if the specified tag is DW_TAG_compile_unit.
271bool DIDescriptor::isCompileUnit() const {
Devang Patel3c91b052010-03-08 20:52:55 +0000272 return DbgNode && getTag() == dwarf::DW_TAG_compile_unit;
Devang Patelc9f322d2009-08-31 21:34:44 +0000273}
274
Devang Patel7aa81892010-03-08 22:27:22 +0000275/// isFile - Return true if the specified tag is DW_TAG_file_type.
276bool DIDescriptor::isFile() const {
277 return DbgNode && getTag() == dwarf::DW_TAG_file_type;
278}
279
Devang Patel6404e4e2009-12-15 19:16:48 +0000280/// isNameSpace - Return true if the specified tag is DW_TAG_namespace.
281bool DIDescriptor::isNameSpace() const {
Devang Patel3c91b052010-03-08 20:52:55 +0000282 return DbgNode && getTag() == dwarf::DW_TAG_namespace;
Devang Patel6404e4e2009-12-15 19:16:48 +0000283}
284
Eric Christopher6618a242011-10-11 22:59:11 +0000285/// isLexicalBlockFile - Return true if the specified descriptor is a
286/// lexical block with an extra file.
287bool DIDescriptor::isLexicalBlockFile() const {
288 return DbgNode && getTag() == dwarf::DW_TAG_lexical_block &&
David Blaikie72dfb052013-03-28 02:44:59 +0000289 (DbgNode->getNumOperands() == 3);
Eric Christopher6618a242011-10-11 22:59:11 +0000290}
291
Devang Patel5e005d82009-08-31 22:00:15 +0000292/// isLexicalBlock - Return true if the specified tag is DW_TAG_lexical_block.
293bool DIDescriptor::isLexicalBlock() const {
Eric Christopher6618a242011-10-11 22:59:11 +0000294 return DbgNode && getTag() == dwarf::DW_TAG_lexical_block &&
David Blaikie72dfb052013-03-28 02:44:59 +0000295 (DbgNode->getNumOperands() > 3);
Devang Patel5e005d82009-08-31 22:00:15 +0000296}
297
Devang Patelecbeb1a2009-09-30 22:34:41 +0000298/// isSubrange - Return true if the specified tag is DW_TAG_subrange_type.
299bool DIDescriptor::isSubrange() const {
Devang Patel3c91b052010-03-08 20:52:55 +0000300 return DbgNode && getTag() == dwarf::DW_TAG_subrange_type;
Devang Patelecbeb1a2009-09-30 22:34:41 +0000301}
302
303/// isEnumerator - Return true if the specified tag is DW_TAG_enumerator.
304bool DIDescriptor::isEnumerator() const {
Devang Patel3c91b052010-03-08 20:52:55 +0000305 return DbgNode && getTag() == dwarf::DW_TAG_enumerator;
Devang Patelecbeb1a2009-09-30 22:34:41 +0000306}
307
David Blaikie35450432013-03-27 17:50:12 +0000308/// isObjCProperty - Return true if the specified tag is DW_TAG_APPLE_property.
Devang Patel1ea02d42012-02-04 00:59:25 +0000309bool DIDescriptor::isObjCProperty() const {
Eric Christopher6c31ee22012-03-29 21:35:05 +0000310 return DbgNode && getTag() == dwarf::DW_TAG_APPLE_property;
Devang Patel1ea02d42012-02-04 00:59:25 +0000311}
David Blaikiec462db62013-04-22 06:12:31 +0000312
David Blaikie20d9e412013-05-07 21:35:53 +0000313/// \brief Return true if the specified tag is DW_TAG_imported_module or
314/// DW_TAG_imported_declaration.
315bool DIDescriptor::isImportedEntity() const {
316 return DbgNode && (getTag() == dwarf::DW_TAG_imported_module ||
317 getTag() == dwarf::DW_TAG_imported_declaration);
David Blaikiec462db62013-04-22 06:12:31 +0000318}
319
Devang Patel6ceea332009-08-31 18:49:10 +0000320//===----------------------------------------------------------------------===//
321// Simple Descriptor Constructors and other Methods
322//===----------------------------------------------------------------------===//
323
Devang Patel68afdc32009-01-05 18:33:01 +0000324unsigned DIArray::getNumElements() const {
Devang Patel3c91b052010-03-08 20:52:55 +0000325 if (!DbgNode)
326 return 0;
Chris Lattner5d0cacd2009-12-31 01:22:29 +0000327 return DbgNode->getNumOperands();
Devang Patel68afdc32009-01-05 18:33:01 +0000328}
Chris Lattnera45664f2008-11-10 02:56:27 +0000329
Eric Christophere6f774e2013-07-24 01:51:12 +0000330/// replaceAllUsesWith - Replace all uses of the MDNode used by this
331/// type with the one in the passed descriptor.
Dan Gohman489b29b2010-08-20 22:02:26 +0000332void DIType::replaceAllUsesWith(DIDescriptor &D) {
Eric Christophere6f774e2013-07-24 01:51:12 +0000333
334 assert(DbgNode && "Trying to replace an unverified type!");
Devang Patelc4999d72009-07-22 18:23:44 +0000335
Daniel Dunbar48a097b2009-09-22 02:03:18 +0000336 // 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.
Devang Pateled66bf52010-05-07 18:19:32 +0000341 if (DbgNode != D) {
Devang Patele9f8f5e2010-05-07 20:54:48 +0000342 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));
Dan Gohman489b29b2010-08-20 22:02:26 +0000346 MDNode::deleteTemporary(Node);
Daniel Dunbar48a097b2009-09-22 02:03:18 +0000347 }
Devang Patelc4999d72009-07-22 18:23:44 +0000348}
349
Eric Christophere6f774e2013-07-24 01:51:12 +0000350/// replaceAllUsesWith - Replace all uses of the MDNode used by this
351/// type with the one in D.
Devang Patel0a2551d2010-12-08 20:18:20 +0000352void DIType::replaceAllUsesWith(MDNode *D) {
Eric Christophere6f774e2013-07-24 01:51:12 +0000353
354 assert(DbgNode && "Trying to replace an unverified type!");
Devang Patel0a2551d2010-12-08 20:18:20 +0000355
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}
369
Devang Patel6f9d8ff2011-08-15 17:57:41 +0000370/// isUnsignedDIType - Return true if type encoding is unsigned.
371bool DIType::isUnsignedDIType() {
372 DIDerivedType DTy(DbgNode);
373 if (DTy.Verify())
374 return DTy.getTypeDerivedFrom().isUnsignedDIType();
375
376 DIBasicType BTy(DbgNode);
377 if (BTy.Verify()) {
378 unsigned Encoding = BTy.getEncoding();
379 if (Encoding == dwarf::DW_ATE_unsigned ||
David Blaikiefe07db32013-01-19 23:00:25 +0000380 Encoding == dwarf::DW_ATE_unsigned_char ||
381 Encoding == dwarf::DW_ATE_boolean)
Devang Patel6f9d8ff2011-08-15 17:57:41 +0000382 return true;
383 }
384 return false;
385}
386
Devang Patelb79b5352009-01-19 23:21:49 +0000387/// Verify - Verify that a compile unit is well formed.
388bool DICompileUnit::Verify() const {
David Blaikiec0ec8a42013-03-11 23:39:23 +0000389 if (!isCompileUnit())
Devang Patelb79b5352009-01-19 23:21:49 +0000390 return false;
Eric Christopher78ac65f2013-07-24 00:54:39 +0000391
392 // Don't bother verifying the compilation directory or producer string
393 // as those could be empty.
394 if (getFilename().empty())
Bill Wendling0582ae92009-03-13 04:39:26 +0000395 return false;
Eric Christopher78ac65f2013-07-24 00:54:39 +0000396
David Blaikiec462db62013-04-22 06:12:31 +0000397 return DbgNode->getNumOperands() == 13;
Devang Patelb79b5352009-01-19 23:21:49 +0000398}
399
Eric Christopherb8ca9882012-03-29 08:42:56 +0000400/// Verify - Verify that an ObjC property is well formed.
401bool DIObjCProperty::Verify() const {
David Blaikiec0ec8a42013-03-11 23:39:23 +0000402 if (!isObjCProperty())
Eric Christopherb8ca9882012-03-29 08:42:56 +0000403 return false;
David Blaikiec0ec8a42013-03-11 23:39:23 +0000404
Eric Christopherb8ca9882012-03-29 08:42:56 +0000405 // Don't worry about the rest of the strings for now.
David Blaikiec0ec8a42013-03-11 23:39:23 +0000406 return DbgNode->getNumOperands() == 8;
Eric Christopherb8ca9882012-03-29 08:42:56 +0000407}
408
Manman Ren3367ed32013-07-25 21:19:31 +0000409/// 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.
Manman Ren27ce44d2013-07-25 06:43:01 +0000412static bool fieldIsMDNode(const MDNode *DbgNode, unsigned Elt) {
Manman Ren3367ed32013-07-25 21:19:31 +0000413 // FIXME: This function should return true, if the field is null or the field
414 // is indeed a MDNode: return !Fld || isa<MDNode>(Fld).
Manman Ren27ce44d2013-07-25 06:43:01 +0000415 Value *Fld = getField(DbgNode, Elt);
416 if (Fld && isa<MDString>(Fld) &&
417 !cast<MDString>(Fld)->getString().empty())
418 return false;
419 return true;
420}
421
Manman Ren6e3cd0e2013-08-26 22:39:55 +0000422/// Check if a field at position Elt of a MDNode is a MDString.
423static bool fieldIsMDString(const MDNode *DbgNode, unsigned Elt) {
424 Value *Fld = getField(DbgNode, Elt);
425 return !Fld || isa<MDString>(Fld);
426}
427
Manman Renbc660712013-09-05 18:48:31 +0000428/// Check if a value can be a TypeRef.
429static bool isTypeRef(const Value *Val) {
430 return !Val || isa<MDString>(Val) || isa<MDNode>(Val);
431}
432
433/// Check if a field at position Elt of a MDNode can be a TypeRef.
434static bool fieldIsTypeRef(const MDNode *DbgNode, unsigned Elt) {
435 Value *Fld = getField(DbgNode, Elt);
436 return isTypeRef(Fld);
437}
438
Devang Patelb79b5352009-01-19 23:21:49 +0000439/// Verify - Verify that a type descriptor is well formed.
440bool DIType::Verify() const {
David Blaikiec0ec8a42013-03-11 23:39:23 +0000441 if (!isType())
Devang Patelb79b5352009-01-19 23:21:49 +0000442 return false;
Manman Rencb420a42013-07-25 19:33:30 +0000443 // Make sure Context @ field 2 is MDNode.
444 if (!fieldIsMDNode(DbgNode, 2))
445 return false;
446
Eric Christopherbf7644a2013-07-24 00:54:36 +0000447 // FIXME: Sink this into the various subclass verifies.
Eric Christopher31667622013-08-08 01:41:00 +0000448 uint16_t Tag = getTag();
Devang Patelb71bbf92010-11-02 20:41:13 +0000449 if (!isBasicType() && Tag != dwarf::DW_TAG_const_type &&
450 Tag != dwarf::DW_TAG_volatile_type && Tag != dwarf::DW_TAG_pointer_type &&
David Blaikie62fdfb52013-01-07 05:51:15 +0000451 Tag != dwarf::DW_TAG_ptr_to_member_type &&
Eric Christopher791e6292012-05-19 01:36:37 +0000452 Tag != dwarf::DW_TAG_reference_type &&
453 Tag != dwarf::DW_TAG_rvalue_reference_type &&
Eric Christopherbf7644a2013-07-24 00:54:36 +0000454 Tag != dwarf::DW_TAG_restrict_type && Tag != dwarf::DW_TAG_array_type &&
Eric Christopher791e6292012-05-19 01:36:37 +0000455 Tag != dwarf::DW_TAG_enumeration_type &&
456 Tag != dwarf::DW_TAG_subroutine_type &&
Eric Christopherbf7644a2013-07-24 00:54:36 +0000457 Tag != dwarf::DW_TAG_inheritance && Tag != dwarf::DW_TAG_friend &&
Eric Christopher791e6292012-05-19 01:36:37 +0000458 getFilename().empty())
Devang Patelb79b5352009-01-19 23:21:49 +0000459 return false;
Manman Ren9fd61782013-07-23 18:14:25 +0000460 // 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;
Devang Patelb79b5352009-01-19 23:21:49 +0000470 return true;
471}
472
Devang Patel0c4720c2010-08-23 18:25:56 +0000473/// Verify - Verify that a basic type descriptor is well formed.
474bool DIBasicType::Verify() const {
David Blaikie72dfb052013-03-28 02:44:59 +0000475 return isBasicType() && DbgNode->getNumOperands() == 10;
Devang Patel0c4720c2010-08-23 18:25:56 +0000476}
477
478/// Verify - Verify that a derived type descriptor is well formed.
479bool DIDerivedType::Verify() const {
Manman Ren27ce44d2013-07-25 06:43:01 +0000480 // 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)
Manman Renbc660712013-09-05 18:48:31 +0000484 // Make sure ClassType @ field 10 is a TypeRef.
485 if (!fieldIsTypeRef(DbgNode, 10))
Manman Ren27ce44d2013-07-25 06:43:01 +0000486 return false;
487
David Blaikie72dfb052013-03-28 02:44:59 +0000488 return isDerivedType() && DbgNode->getNumOperands() >= 10 &&
489 DbgNode->getNumOperands() <= 14;
Devang Patel0c4720c2010-08-23 18:25:56 +0000490}
491
Devang Patelb79b5352009-01-19 23:21:49 +0000492/// Verify - Verify that a composite type descriptor is well formed.
493bool DICompositeType::Verify() const {
David Blaikiec0ec8a42013-03-11 23:39:23 +0000494 if (!isCompositeType())
Devang Patelb79b5352009-01-19 23:21:49 +0000495 return false;
Devang Patelb79b5352009-01-19 23:21:49 +0000496
Manman Ren27ce44d2013-07-25 06:43:01 +0000497 // 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;
502
Manman Ren6e3cd0e2013-08-26 22:39:55 +0000503 // Make sure the type identifier at field 14 is MDString, it can be null.
504 if (!fieldIsMDString(DbgNode, 14))
505 return false;
506
Eric Christopherdc1363f2013-08-08 07:40:37 +0000507 // 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;
512
Manman Ren6e3cd0e2013-08-26 22:39:55 +0000513 return DbgNode->getNumOperands() == 15;
Devang Patelb79b5352009-01-19 23:21:49 +0000514}
515
516/// Verify - Verify that a subprogram descriptor is well formed.
517bool DISubprogram::Verify() const {
David Blaikiec0ec8a42013-03-11 23:39:23 +0000518 if (!isSubprogram())
Devang Patelb79b5352009-01-19 23:21:49 +0000519 return false;
Daniel Dunbarf612ff62009-09-19 20:40:05 +0000520
Manman Ren27ce44d2013-07-25 06:43:01 +0000521 // 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;
David Blaikie72dfb052013-03-28 02:44:59 +0000529 return DbgNode->getNumOperands() == 20;
Devang Patelb79b5352009-01-19 23:21:49 +0000530}
531
532/// Verify - Verify that a global variable descriptor is well formed.
533bool DIGlobalVariable::Verify() const {
David Blaikiec0ec8a42013-03-11 23:39:23 +0000534 if (!isGlobalVariable())
Devang Patelb79b5352009-01-19 23:21:49 +0000535 return false;
Daniel Dunbarf612ff62009-09-19 20:40:05 +0000536
Devang Patel65dbc902009-11-25 17:36:49 +0000537 if (getDisplayName().empty())
Devang Patel84c73e92009-11-06 17:58:12 +0000538 return false;
Manman Ren27ce44d2013-07-25 06:43:01 +0000539 // 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;
Devang Patel84c73e92009-11-06 17:58:12 +0000547
David Blaikiec0ec8a42013-03-11 23:39:23 +0000548 return DbgNode->getNumOperands() == 13;
Devang Patelb79b5352009-01-19 23:21:49 +0000549}
550
551/// Verify - Verify that a variable descriptor is well formed.
552bool DIVariable::Verify() const {
David Blaikiec0ec8a42013-03-11 23:39:23 +0000553 if (!isVariable())
Devang Patelb79b5352009-01-19 23:21:49 +0000554 return false;
Daniel Dunbarf612ff62009-09-19 20:40:05 +0000555
Manman Ren27ce44d2013-07-25 06:43:01 +0000556 // 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;
David Blaikiec0ec8a42013-03-11 23:39:23 +0000561 return DbgNode->getNumOperands() >= 8;
Devang Patelb79b5352009-01-19 23:21:49 +0000562}
563
Devang Patel3c91b052010-03-08 20:52:55 +0000564/// Verify - Verify that a location descriptor is well formed.
565bool DILocation::Verify() const {
566 if (!DbgNode)
567 return false;
Jim Grosbache62b6902010-07-21 21:36:25 +0000568
Devang Patel3c91b052010-03-08 20:52:55 +0000569 return DbgNode->getNumOperands() == 4;
570}
571
Devang Patel47e22652010-05-07 23:04:32 +0000572/// Verify - Verify that a namespace descriptor is well formed.
573bool DINameSpace::Verify() const {
David Blaikiec0ec8a42013-03-11 23:39:23 +0000574 if (!isNameSpace())
Devang Patel47e22652010-05-07 23:04:32 +0000575 return false;
David Blaikie72dfb052013-03-28 02:44:59 +0000576 return DbgNode->getNumOperands() == 5;
David Blaikiec0ec8a42013-03-11 23:39:23 +0000577}
578
David Blaikie4776bce2013-03-20 00:26:26 +0000579/// \brief Retrieve the MDNode for the directory/file pair.
580MDNode *DIFile::getFileNode() const {
Manman Rend2ed53c2013-07-23 20:39:32 +0000581 return getNodeField(DbgNode, 1);
David Blaikie4776bce2013-03-20 00:26:26 +0000582}
583
David Blaikiec0ec8a42013-03-11 23:39:23 +0000584/// \brief Verify that the file descriptor is well formed.
585bool DIFile::Verify() const {
David Blaikie72dfb052013-03-28 02:44:59 +0000586 return isFile() && DbgNode->getNumOperands() == 2;
David Blaikiec0ec8a42013-03-11 23:39:23 +0000587}
588
589/// \brief Verify that the enumerator descriptor is well formed.
590bool DIEnumerator::Verify() const {
591 return isEnumerator() && DbgNode->getNumOperands() == 3;
592}
593
594/// \brief Verify that the subrange descriptor is well formed.
595bool DISubrange::Verify() const {
596 return isSubrange() && DbgNode->getNumOperands() == 3;
597}
598
599/// \brief Verify that the lexical block descriptor is well formed.
600bool DILexicalBlock::Verify() const {
David Blaikie72dfb052013-03-28 02:44:59 +0000601 return isLexicalBlock() && DbgNode->getNumOperands() == 6;
David Blaikiec0ec8a42013-03-11 23:39:23 +0000602}
603
604/// \brief Verify that the file-scoped lexical block descriptor is well formed.
605bool DILexicalBlockFile::Verify() const {
David Blaikie72dfb052013-03-28 02:44:59 +0000606 return isLexicalBlockFile() && DbgNode->getNumOperands() == 3;
David Blaikiec0ec8a42013-03-11 23:39:23 +0000607}
608
609/// \brief Verify that the template type parameter descriptor is well formed.
610bool DITemplateTypeParameter::Verify() const {
611 return isTemplateTypeParameter() && DbgNode->getNumOperands() == 7;
612}
613
614/// \brief Verify that the template value parameter descriptor is well formed.
615bool DITemplateValueParameter::Verify() const {
616 return isTemplateValueParameter() && DbgNode->getNumOperands() == 8;
Devang Patel47e22652010-05-07 23:04:32 +0000617}
618
David Blaikiec462db62013-04-22 06:12:31 +0000619/// \brief Verify that the imported module descriptor is well formed.
David Blaikie20d9e412013-05-07 21:35:53 +0000620bool DIImportedEntity::Verify() const {
David Blaikie7b72cc72013-05-20 22:50:35 +0000621 return isImportedEntity() &&
622 (DbgNode->getNumOperands() == 4 || DbgNode->getNumOperands() == 5);
David Blaikiec462db62013-04-22 06:12:31 +0000623}
624
Devang Patel36375ee2009-02-17 21:23:59 +0000625/// getOriginalTypeSize - If this type is derived from a base type then
626/// return base type size.
627uint64_t DIDerivedType::getOriginalTypeSize() const {
Eric Christopher31667622013-08-08 01:41:00 +0000628 uint16_t Tag = getTag();
Eric Christopher2e1b0c02011-12-16 23:42:45 +0000629
Bill Wendlinge8778242012-06-26 23:22:18 +0000630 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();
Jim Grosbache62b6902010-07-21 21:36:25 +0000634
Bill Wendlinge8778242012-06-26 23:22:18 +0000635 DIType BaseType = getTypeDerivedFrom();
636
637 // If this type is not derived from any type then take conservative approach.
638 if (!BaseType.isValid())
639 return getSizeInBits();
640
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();
647
648 if (BaseType.isDerivedType())
649 return DIDerivedType(BaseType).getOriginalTypeSize();
650
651 return BaseType.getSizeInBits();
Devang Patel36375ee2009-02-17 21:23:59 +0000652}
Devang Patelb79b5352009-01-19 23:21:49 +0000653
Devang Patel6588abf2012-02-06 17:49:43 +0000654/// getObjCProperty - Return property node, if this ivar is associated with one.
655MDNode *DIDerivedType::getObjCProperty() const {
Manman Rend2ed53c2013-07-23 20:39:32 +0000656 return getNodeField(DbgNode, 10);
Devang Patel6588abf2012-02-06 17:49:43 +0000657}
658
Manman Ren6e3cd0e2013-08-26 22:39:55 +0000659MDString *DICompositeType::getIdentifier() const {
660 return cast_or_null<MDString>(getField(DbgNode, 14));
661}
662
David Blaikie02ae44f2013-08-28 20:42:43 +0000663#ifndef NDEBUG
664static void VerifySubsetOf(const MDNode *LHS, const MDNode *RHS) {
665 for (unsigned i = 0; i != LHS->getNumOperands(); ++i) {
David Blaikieb5011bd2013-08-28 20:45:45 +0000666 // Skip the 'empty' list (that's a single i32 0, rather than truly empty).
David Blaikie02ae44f2013-08-28 20:42:43 +0000667 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
677
David Blaikief34ea642013-03-26 23:46:36 +0000678/// \brief Set the array of member DITypes.
David Blaikied072a162013-03-26 21:59:17 +0000679void DICompositeType::setTypeArray(DIArray Elements, DIArray TParams) {
Manman Ren6e3cd0e2013-08-26 22:39:55 +0000680 assert((!TParams || DbgNode->getNumOperands() == 15) &&
Benjamin Kramer2b393fb2013-03-27 15:03:14 +0000681 "If you're setting the template parameters this should include a slot "
682 "for that!");
David Blaikied072a162013-03-26 21:59:17 +0000683 TrackingVH<MDNode> N(*this);
David Blaikie980879e2013-08-28 17:28:16 +0000684 if (Elements) {
685#ifndef NDEBUG
David Blaikieb5011bd2013-08-28 20:45:45 +0000686 // Check that the new list of members contains all the old members as well.
David Blaikie02ae44f2013-08-28 20:42:43 +0000687 if (const MDNode *El = cast_or_null<MDNode>(N->getOperand(10)))
688 VerifySubsetOf(El, Elements);
David Blaikie980879e2013-08-28 17:28:16 +0000689#endif
690 N->replaceOperandWith(10, Elements);
691 }
David Blaikied072a162013-03-26 21:59:17 +0000692 if (TParams)
David Blaikie72dfb052013-03-28 02:44:59 +0000693 N->replaceOperandWith(13, TParams);
David Blaikied072a162013-03-26 21:59:17 +0000694 DbgNode = N;
695}
696
David Blaikie692062f2013-08-16 20:42:14 +0000697void DICompositeType::addMember(DIDescriptor D) {
David Blaikie8328b692013-08-09 17:17:12 +0000698 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));
David Blaikie692062f2013-08-16 20:42:14 +0000706 M.push_back(D);
David Blaikie8328b692013-08-09 17:17:12 +0000707 setTypeArray(DIArray(MDNode::get(DbgNode->getContext(), M)));
708}
709
David Blaikief34ea642013-03-26 23:46:36 +0000710/// \brief Set the containing type.
711void DICompositeType::setContainingType(DICompositeType ContainingType) {
712 TrackingVH<MDNode> N(*this);
David Blaikie72dfb052013-03-28 02:44:59 +0000713 N->replaceOperandWith(12, ContainingType);
David Blaikief34ea642013-03-26 23:46:36 +0000714 DbgNode = N;
715}
716
Jim Grosbache62b6902010-07-21 21:36:25 +0000717/// isInlinedFnArgument - Return true if this variable provides debugging
Devang Patel719f6a92010-04-29 20:40:36 +0000718/// information for an inlined function arguments.
719bool DIVariable::isInlinedFnArgument(const Function *CurFn) {
720 assert(CurFn && "Invalid function");
721 if (!getContext().isSubprogram())
722 return false;
Jim Grosbache62b6902010-07-21 21:36:25 +0000723 // This variable is not inlined function argument if its scope
Devang Patel719f6a92010-04-29 20:40:36 +0000724 // does not describe current function.
Bill Wendlinge8778242012-06-26 23:22:18 +0000725 return !DISubprogram(getContext()).describes(CurFn);
Devang Patel719f6a92010-04-29 20:40:36 +0000726}
727
Devang Patelaf5b6bb2009-04-15 00:06:07 +0000728/// describes - Return true if this subprogram provides debugging
729/// information for the function F.
730bool DISubprogram::describes(const Function *F) {
Chris Lattner099b7792009-12-29 09:22:47 +0000731 assert(F && "Invalid function");
Devang Patelffd33cd2010-06-16 06:42:02 +0000732 if (F == getFunction())
733 return true;
Devang Patel65dbc902009-11-25 17:36:49 +0000734 StringRef Name = getLinkageName();
735 if (Name.empty())
Devang Patel5ccdd102009-09-29 18:40:58 +0000736 Name = getName();
Devang Patel65dbc902009-11-25 17:36:49 +0000737 if (F->getName() == Name)
Devang Patelaf5b6bb2009-04-15 00:06:07 +0000738 return true;
739 return false;
740}
741
Jim Grosbache62b6902010-07-21 21:36:25 +0000742unsigned DISubprogram::isOptimized() const {
Devang Patelccff8122010-04-30 19:38:23 +0000743 assert (DbgNode && "Invalid subprogram descriptor!");
David Blaikie72dfb052013-03-28 02:44:59 +0000744 if (DbgNode->getNumOperands() == 15)
745 return getUnsignedField(14);
Devang Patelccff8122010-04-30 19:38:23 +0000746 return 0;
747}
748
Devang Patel93d39be2011-08-19 23:28:12 +0000749MDNode *DISubprogram::getVariablesNodes() const {
Manman Rend2ed53c2013-07-23 20:39:32 +0000750 return getNodeField(DbgNode, 18);
Devang Patel93d39be2011-08-19 23:28:12 +0000751}
752
753DIArray DISubprogram::getVariables() const {
Manman Ren4f2c2972013-07-23 23:07:38 +0000754 return DIArray(getNodeField(DbgNode, 18));
Devang Patel93d39be2011-08-19 23:28:12 +0000755}
756
David Blaikie4de9d722013-05-10 21:52:07 +0000757Value *DITemplateValueParameter::getValue() const {
758 return getField(DbgNode, 4);
759}
760
Eric Christopher956e5aa2013-07-26 17:02:36 +0000761// If the current node has a parent scope then return that,
762// else return an empty scope.
763DIScope DIScope::getContext() const {
764
765 if (isType())
766 return DIType(DbgNode).getContext();
767
768 if (isSubprogram())
769 return DISubprogram(DbgNode).getContext();
770
771 if (isLexicalBlock())
772 return DILexicalBlock(DbgNode).getContext();
773
774 if (isLexicalBlockFile())
775 return DILexicalBlockFile(DbgNode).getContext();
776
777 if (isNameSpace())
778 return DINameSpace(DbgNode).getContext();
779
Eric Christopher388d3222013-07-26 21:16:25 +0000780 assert((isFile() || isCompileUnit()) && "Unhandled type of scope.");
Eric Christopher956e5aa2013-07-26 17:02:36 +0000781 return DIScope();
782}
783
Devang Patel65dbc902009-11-25 17:36:49 +0000784StringRef DIScope::getFilename() const {
Devang Patel77bf2952010-03-08 22:02:50 +0000785 if (!DbgNode)
786 return StringRef();
David Blaikieb4cf0ab2013-03-17 21:13:55 +0000787 return ::getStringField(getNodeField(DbgNode, 1), 0);
Devang Patelecbeb1a2009-09-30 22:34:41 +0000788}
789
Devang Patel65dbc902009-11-25 17:36:49 +0000790StringRef DIScope::getDirectory() const {
Devang Patel77bf2952010-03-08 22:02:50 +0000791 if (!DbgNode)
792 return StringRef();
David Blaikieb4cf0ab2013-03-17 21:13:55 +0000793 return ::getStringField(getNodeField(DbgNode, 1), 1);
Devang Patelecbeb1a2009-09-30 22:34:41 +0000794}
795
Devang Patel94c7ddb2011-08-16 22:09:43 +0000796DIArray DICompileUnit::getEnumTypes() const {
David Blaikiec462db62013-04-22 06:12:31 +0000797 if (!DbgNode || DbgNode->getNumOperands() < 13)
David Blaikie72dfb052013-03-28 02:44:59 +0000798 return DIArray();
799
Manman Ren4f2c2972013-07-23 23:07:38 +0000800 return DIArray(getNodeField(DbgNode, 7));
David Blaikie72dfb052013-03-28 02:44:59 +0000801}
802
803DIArray DICompileUnit::getRetainedTypes() const {
David Blaikiec462db62013-04-22 06:12:31 +0000804 if (!DbgNode || DbgNode->getNumOperands() < 13)
David Blaikiede3077a2013-03-13 00:01:35 +0000805 return DIArray();
806
Manman Ren4f2c2972013-07-23 23:07:38 +0000807 return DIArray(getNodeField(DbgNode, 8));
David Blaikiede3077a2013-03-13 00:01:35 +0000808}
809
David Blaikie72dfb052013-03-28 02:44:59 +0000810DIArray DICompileUnit::getSubprograms() const {
David Blaikiec462db62013-04-22 06:12:31 +0000811 if (!DbgNode || DbgNode->getNumOperands() < 13)
David Blaikie46561ce2013-03-12 22:43:04 +0000812 return DIArray();
813
Manman Ren4f2c2972013-07-23 23:07:38 +0000814 return DIArray(getNodeField(DbgNode, 9));
David Blaikie46561ce2013-03-12 22:43:04 +0000815}
816
David Blaikie72dfb052013-03-28 02:44:59 +0000817
818DIArray DICompileUnit::getGlobalVariables() const {
David Blaikiec462db62013-04-22 06:12:31 +0000819 if (!DbgNode || DbgNode->getNumOperands() < 13)
Devang Patel94c7ddb2011-08-16 22:09:43 +0000820 return DIArray();
821
Manman Ren4f2c2972013-07-23 23:07:38 +0000822 return DIArray(getNodeField(DbgNode, 10));
Devang Patel94c7ddb2011-08-16 22:09:43 +0000823}
824
David Blaikie20d9e412013-05-07 21:35:53 +0000825DIArray DICompileUnit::getImportedEntities() const {
David Blaikiec462db62013-04-22 06:12:31 +0000826 if (!DbgNode || DbgNode->getNumOperands() < 13)
827 return DIArray();
828
Manman Ren4f2c2972013-07-23 23:07:38 +0000829 return DIArray(getNodeField(DbgNode, 11));
David Blaikiec462db62013-04-22 06:12:31 +0000830}
831
Benjamin Kramer7c2b4be2013-06-01 17:51:14 +0000832/// fixupSubprogramName - Replace contains special characters used
Devang Patel62367042010-11-10 22:19:21 +0000833/// in a typical Objective-C names with '.' in a given string.
Benjamin Kramer7c2b4be2013-06-01 17:51:14 +0000834static void fixupSubprogramName(DISubprogram Fn, SmallVectorImpl<char> &Out) {
835 StringRef FName =
836 Fn.getFunction() ? Fn.getFunction()->getName() : Fn.getName();
837 FName = Function::getRealLinkageName(FName);
838
839 StringRef Prefix("llvm.dbg.lv.");
840 Out.reserve(FName.size() + Prefix.size());
841 Out.append(Prefix.begin(), Prefix.end());
842
Benjamin Kramer1a81d482011-06-18 14:42:42 +0000843 bool isObjCLike = false;
Benjamin Kramer7c2b4be2013-06-01 17:51:14 +0000844 for (size_t i = 0, e = FName.size(); i < e; ++i) {
845 char C = FName[i];
Benjamin Kramer1a81d482011-06-18 14:42:42 +0000846 if (C == '[')
847 isObjCLike = true;
848
849 if (isObjCLike && (C == '[' || C == ']' || C == ' ' || C == ':' ||
850 C == '+' || C == '(' || C == ')'))
851 Out.push_back('.');
852 else
853 Out.push_back(C);
Devang Patel62367042010-11-10 22:19:21 +0000854 }
855}
856
Eric Christopher5f214ae2012-11-20 00:15:36 +0000857/// getFnSpecificMDNode - Return a NameMDNode, if available, that is
Devang Patel62367042010-11-10 22:19:21 +0000858/// suitable to hold function specific information.
Devang Patel93d39be2011-08-19 23:28:12 +0000859NamedMDNode *llvm::getFnSpecificMDNode(const Module &M, DISubprogram Fn) {
Benjamin Kramer7c2b4be2013-06-01 17:51:14 +0000860 SmallString<32> Name;
861 fixupSubprogramName(Fn, Name);
Benjamin Kramer1a81d482011-06-18 14:42:42 +0000862 return M.getNamedMetadata(Name.str());
Devang Patel62367042010-11-10 22:19:21 +0000863}
864
Duncan Sands291bb702011-03-02 20:30:37 +0000865/// getOrInsertFnSpecificMDNode - Return a NameMDNode that is suitable
866/// to hold function specific information.
Devang Patel93d39be2011-08-19 23:28:12 +0000867NamedMDNode *llvm::getOrInsertFnSpecificMDNode(Module &M, DISubprogram Fn) {
Benjamin Kramer7c2b4be2013-06-01 17:51:14 +0000868 SmallString<32> Name;
869 fixupSubprogramName(Fn, Name);
Benjamin Kramer1a81d482011-06-18 14:42:42 +0000870 return M.getOrInsertNamedMetadata(Name.str());
Devang Patel1a7ca032010-09-28 18:08:20 +0000871}
872
Devang Patel23336b42011-07-19 19:41:54 +0000873/// 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.
877DIVariable 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}
Devang Patel1a7ca032010-09-28 18:08:20 +0000886
Devang Patelb549bcf2011-08-10 21:50:54 +0000887/// cleanseInlinedVariable - Remove inlined scope from the variable.
888DIVariable 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)
Eric Christopher5f214ae2012-11-20 00:15:36 +0000892 i == 7 ?
Bill Wendling0735e812012-07-06 17:46:28 +0000893 Elts.push_back(Constant::getNullValue(Type::getInt32Ty(VMContext))):
Devang Patelb549bcf2011-08-10 21:50:54 +0000894 Elts.push_back(DV->getOperand(i));
895 return DIVariable(MDNode::get(VMContext, Elts));
896}
897
Bill Wendling0bcbd1d2012-06-28 00:05:13 +0000898/// getDISubprogram - Find subprogram that is enclosing this scope.
899DISubprogram llvm::getDISubprogram(const MDNode *Scope) {
900 DIDescriptor D(Scope);
901 if (D.isSubprogram())
902 return DISubprogram(Scope);
903
904 if (D.isLexicalBlockFile())
905 return getDISubprogram(DILexicalBlockFile(Scope).getContext());
Eric Christopher5f214ae2012-11-20 00:15:36 +0000906
Bill Wendling0bcbd1d2012-06-28 00:05:13 +0000907 if (D.isLexicalBlock())
908 return getDISubprogram(DILexicalBlock(Scope).getContext());
909
910 return DISubprogram();
911}
912
Eric Christopher7bb386a2013-07-09 00:16:56 +0000913/// getDICompositeType - Find underlying composite type.
914DICompositeType llvm::getDICompositeType(DIType T) {
915 if (T.isCompositeType())
916 return DICompositeType(T);
917
918 if (T.isDerivedType())
919 return getDICompositeType(DIDerivedType(T).getTypeDerivedFrom());
920
921 return DICompositeType();
922}
923
Bill Wendling0bcbd1d2012-06-28 00:05:13 +0000924/// isSubprogramContext - Return true if Context is either a subprogram
925/// or another context nested inside a subprogram.
926bool 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}
936
Manman Renbc660712013-09-05 18:48:31 +0000937/// Update DITypeIdentifierMap by going through retained types of each CU.
938DITypeIdentifierMap 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}
962
Devang Pateld2f79a12009-07-28 19:55:13 +0000963//===----------------------------------------------------------------------===//
Devang Patel98c65172009-07-30 18:25:15 +0000964// DebugInfoFinder implementations.
Devang Pateld2f79a12009-07-28 19:55:13 +0000965//===----------------------------------------------------------------------===//
966
Manman Ren0e29eee2013-07-23 00:22:51 +0000967void DebugInfoFinder::reset() {
968 CUs.clear();
969 SPs.clear();
970 GVs.clear();
971 TYs.clear();
972 Scopes.clear();
973 NodesSeen.clear();
974}
975
Devang Patel98c65172009-07-30 18:25:15 +0000976/// processModule - Process entire module and collect debug info.
Eric Christopherc4639d62012-11-19 22:42:15 +0000977void DebugInfoFinder::processModule(const Module &M) {
Devang Patelcd2db162011-10-17 22:30:34 +0000978 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);
David Blaikiec0ec8a42013-03-11 23:39:23 +0000982 DIArray GVs = CU.getGlobalVariables();
983 for (unsigned i = 0, e = GVs.getNumElements(); i != e; ++i) {
984 DIGlobalVariable DIG(GVs.getElement(i));
Manman Ren96ea0382013-07-20 00:38:46 +0000985 if (addGlobalVariable(DIG)) {
Manman Renfdd16bb2013-07-22 20:28:53 +0000986 processScope(DIG.getContext());
David Blaikiec0ec8a42013-03-11 23:39:23 +0000987 processType(DIG.getType());
Manman Ren96ea0382013-07-20 00:38:46 +0000988 }
Devang Patelcd2db162011-10-17 22:30:34 +0000989 }
David Blaikiec0ec8a42013-03-11 23:39:23 +0000990 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)));
Manman Ren6b6a2ac2013-08-24 00:32:12 +0000999 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 }
David Blaikiec0ec8a42013-03-11 23:39:23 +00001011 // FIXME: We really shouldn't be bailing out after visiting just one CU
1012 return;
Devang Patelcd2db162011-10-17 22:30:34 +00001013 }
1014 }
Devang Pateld2f79a12009-07-28 19:55:13 +00001015}
Daniel Dunbarf612ff62009-09-19 20:40:05 +00001016
Devang Patel6daf99b2009-11-10 22:05:35 +00001017/// processLocation - Process DILocation.
1018void DebugInfoFinder::processLocation(DILocation Loc) {
Manman Renf40d5782013-08-06 19:38:43 +00001019 if (!Loc) return;
1020 processScope(Loc.getScope());
Devang Patel6daf99b2009-11-10 22:05:35 +00001021 processLocation(Loc.getOrigLocation());
1022}
1023
Devang Patel98c65172009-07-30 18:25:15 +00001024/// processType - Process DIType.
1025void DebugInfoFinder::processType(DIType DT) {
Devang Patel72bcdb62009-08-10 22:09:58 +00001026 if (!addType(DT))
Devang Pateld2f79a12009-07-28 19:55:13 +00001027 return;
Manman Renfdd16bb2013-07-22 20:28:53 +00001028 processScope(DT.getContext());
Devang Patel6ceea332009-08-31 18:49:10 +00001029 if (DT.isCompositeType()) {
Devang Patel2db49d72010-05-07 18:11:54 +00001030 DICompositeType DCT(DT);
Devang Patel98c65172009-07-30 18:25:15 +00001031 processType(DCT.getTypeDerivedFrom());
Devang Pateld2f79a12009-07-28 19:55:13 +00001032 DIArray DA = DCT.getTypeArray();
Devang Patel3c91b052010-03-08 20:52:55 +00001033 for (unsigned i = 0, e = DA.getNumElements(); i != e; ++i) {
1034 DIDescriptor D = DA.getElement(i);
1035 if (D.isType())
Devang Patel2db49d72010-05-07 18:11:54 +00001036 processType(DIType(D));
Devang Patel3c91b052010-03-08 20:52:55 +00001037 else if (D.isSubprogram())
Devang Patel2db49d72010-05-07 18:11:54 +00001038 processSubprogram(DISubprogram(D));
Devang Patel3c91b052010-03-08 20:52:55 +00001039 }
Devang Patel6ceea332009-08-31 18:49:10 +00001040 } else if (DT.isDerivedType()) {
Devang Patel2db49d72010-05-07 18:11:54 +00001041 DIDerivedType DDT(DT);
Devang Patel3c91b052010-03-08 20:52:55 +00001042 processType(DDT.getTypeDerivedFrom());
Devang Pateld2f79a12009-07-28 19:55:13 +00001043 }
1044}
1045
Manman Renfdd16bb2013-07-22 20:28:53 +00001046void DebugInfoFinder::processScope(DIScope Scope) {
1047 if (Scope.isType()) {
1048 DIType Ty(Scope);
1049 processType(Ty);
1050 return;
1051 }
Manman Ren7894ffd2013-07-23 23:10:00 +00001052 if (Scope.isCompileUnit()) {
1053 addCompileUnit(DICompileUnit(Scope));
1054 return;
1055 }
1056 if (Scope.isSubprogram()) {
1057 processSubprogram(DISubprogram(Scope));
1058 return;
1059 }
Manman Renfdd16bb2013-07-22 20:28:53 +00001060 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}
1073
Devang Patelbeab41b2009-10-07 22:04:08 +00001074/// processLexicalBlock
1075void DebugInfoFinder::processLexicalBlock(DILexicalBlock LB) {
Devang Patelbeab41b2009-10-07 22:04:08 +00001076 DIScope Context = LB.getContext();
1077 if (Context.isLexicalBlock())
Devang Patel2db49d72010-05-07 18:11:54 +00001078 return processLexicalBlock(DILexicalBlock(Context));
Eric Christopher6618a242011-10-11 22:59:11 +00001079 else if (Context.isLexicalBlockFile()) {
1080 DILexicalBlockFile DBF = DILexicalBlockFile(Context);
1081 return processLexicalBlock(DILexicalBlock(DBF.getScope()));
1082 }
Devang Patelbeab41b2009-10-07 22:04:08 +00001083 else
Devang Patel2db49d72010-05-07 18:11:54 +00001084 return processSubprogram(DISubprogram(Context));
Devang Patelbeab41b2009-10-07 22:04:08 +00001085}
1086
Devang Patel98c65172009-07-30 18:25:15 +00001087/// processSubprogram - Process DISubprogram.
1088void DebugInfoFinder::processSubprogram(DISubprogram SP) {
Devang Pateld2f79a12009-07-28 19:55:13 +00001089 if (!addSubprogram(SP))
1090 return;
Manman Renfdd16bb2013-07-22 20:28:53 +00001091 processScope(SP.getContext());
Devang Patel98c65172009-07-30 18:25:15 +00001092 processType(SP.getType());
Manman Ren003f5512013-08-23 18:36:18 +00001093 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 }
Devang Pateld2f79a12009-07-28 19:55:13 +00001106}
1107
Devang Patelb4d31302009-07-31 18:18:52 +00001108/// processDeclare - Process DbgDeclareInst.
Eric Christopherc4639d62012-11-19 22:42:15 +00001109void DebugInfoFinder::processDeclare(const DbgDeclareInst *DDI) {
Devang Patel3c91b052010-03-08 20:52:55 +00001110 MDNode *N = dyn_cast<MDNode>(DDI->getVariable());
1111 if (!N) return;
1112
1113 DIDescriptor DV(N);
1114 if (!DV.isVariable())
Devang Patelb4d31302009-07-31 18:18:52 +00001115 return;
1116
Devang Patel2db49d72010-05-07 18:11:54 +00001117 if (!NodesSeen.insert(DV))
Devang Patelb4d31302009-07-31 18:18:52 +00001118 return;
Manman Ren7894ffd2013-07-23 23:10:00 +00001119 processScope(DIVariable(N).getContext());
Devang Patel3c91b052010-03-08 20:52:55 +00001120 processType(DIVariable(N).getType());
Devang Patelb4d31302009-07-31 18:18:52 +00001121}
1122
Manman Ren0e29eee2013-07-23 00:22:51 +00001123void DebugInfoFinder::processValue(const DbgValueInst *DVI) {
1124 MDNode *N = dyn_cast<MDNode>(DVI->getVariable());
1125 if (!N) return;
1126
1127 DIDescriptor DV(N);
1128 if (!DV.isVariable())
1129 return;
1130
1131 if (!NodesSeen.insert(DV))
1132 return;
Manman Ren504a7fb2013-07-24 17:10:09 +00001133 processScope(DIVariable(N).getContext());
Manman Ren0e29eee2013-07-23 00:22:51 +00001134 processType(DIVariable(N).getType());
1135}
1136
Devang Patel72bcdb62009-08-10 22:09:58 +00001137/// addType - Add type into Tys.
1138bool DebugInfoFinder::addType(DIType DT) {
Manman Ren2d69cc42013-07-27 01:26:08 +00001139 if (!DT)
Devang Patel72bcdb62009-08-10 22:09:58 +00001140 return false;
1141
Devang Patel2db49d72010-05-07 18:11:54 +00001142 if (!NodesSeen.insert(DT))
Devang Patel72bcdb62009-08-10 22:09:58 +00001143 return false;
1144
Devang Patel2db49d72010-05-07 18:11:54 +00001145 TYs.push_back(DT);
Devang Patel72bcdb62009-08-10 22:09:58 +00001146 return true;
1147}
1148
Devang Pateld2f79a12009-07-28 19:55:13 +00001149/// addCompileUnit - Add compile unit into CUs.
Devang Patel98c65172009-07-30 18:25:15 +00001150bool DebugInfoFinder::addCompileUnit(DICompileUnit CU) {
Manman Ren2d69cc42013-07-27 01:26:08 +00001151 if (!CU)
1152 return false;
Devang Patel2db49d72010-05-07 18:11:54 +00001153 if (!NodesSeen.insert(CU))
Devang Pateld2f79a12009-07-28 19:55:13 +00001154 return false;
1155
Devang Patel2db49d72010-05-07 18:11:54 +00001156 CUs.push_back(CU);
Devang Pateld2f79a12009-07-28 19:55:13 +00001157 return true;
1158}
Daniel Dunbarf612ff62009-09-19 20:40:05 +00001159
Devang Pateld2f79a12009-07-28 19:55:13 +00001160/// addGlobalVariable - Add global variable into GVs.
Devang Patel98c65172009-07-30 18:25:15 +00001161bool DebugInfoFinder::addGlobalVariable(DIGlobalVariable DIG) {
Manman Ren2d69cc42013-07-27 01:26:08 +00001162 if (!DIG)
Devang Pateld2f79a12009-07-28 19:55:13 +00001163 return false;
1164
Devang Patel2db49d72010-05-07 18:11:54 +00001165 if (!NodesSeen.insert(DIG))
Devang Pateld2f79a12009-07-28 19:55:13 +00001166 return false;
1167
Devang Patel2db49d72010-05-07 18:11:54 +00001168 GVs.push_back(DIG);
Devang Pateld2f79a12009-07-28 19:55:13 +00001169 return true;
1170}
1171
1172// addSubprogram - Add subprgoram into SPs.
Devang Patel98c65172009-07-30 18:25:15 +00001173bool DebugInfoFinder::addSubprogram(DISubprogram SP) {
Manman Ren2d69cc42013-07-27 01:26:08 +00001174 if (!SP)
Devang Pateld2f79a12009-07-28 19:55:13 +00001175 return false;
Daniel Dunbarf612ff62009-09-19 20:40:05 +00001176
Devang Patel2db49d72010-05-07 18:11:54 +00001177 if (!NodesSeen.insert(SP))
Devang Pateld2f79a12009-07-28 19:55:13 +00001178 return false;
1179
Devang Patel2db49d72010-05-07 18:11:54 +00001180 SPs.push_back(SP);
Devang Pateld2f79a12009-07-28 19:55:13 +00001181 return true;
1182}
1183
Manman Ren96ea0382013-07-20 00:38:46 +00001184bool DebugInfoFinder::addScope(DIScope Scope) {
1185 if (!Scope)
1186 return false;
Manman Renf40d5782013-08-06 19:38:43 +00001187 // 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;
Manman Ren96ea0382013-07-20 00:38:46 +00001191 if (!NodesSeen.insert(Scope))
1192 return false;
1193 Scopes.push_back(Scope);
1194 return true;
1195}
1196
Bill Wendlinge8778242012-06-26 23:22:18 +00001197//===----------------------------------------------------------------------===//
1198// DIDescriptor: dump routines for all descriptors.
1199//===----------------------------------------------------------------------===//
1200
1201/// dump - Print descriptor to dbgs() with a newline.
1202void DIDescriptor::dump() const {
1203 print(dbgs()); dbgs() << '\n';
1204}
1205
1206/// print - Print descriptor.
1207void DIDescriptor::print(raw_ostream &OS) const {
1208 if (!DbgNode) return;
1209
Bill Wendling97a75922012-06-28 02:17:58 +00001210 if (const char *Tag = dwarf::TagString(getTag()))
1211 OS << "[ " << Tag << " ]";
Bill Wendlinge8778242012-06-26 23:22:18 +00001212
1213 if (this->isSubrange()) {
1214 DISubrange(DbgNode).printInternal(OS);
Bill Wendlinge8778242012-06-26 23:22:18 +00001215 } 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);
Bill Wendling2da1a162012-07-06 19:12:31 +00001233 } else if (this->isObjCProperty()) {
1234 DIObjCProperty(DbgNode).printInternal(OS);
David Blaikie1cd30fd2013-03-20 05:14:14 +00001235 } else if (this->isNameSpace()) {
1236 DINameSpace(DbgNode).printInternal(OS);
Bill Wendling625252f2012-07-06 23:06:16 +00001237 } else if (this->isScope()) {
1238 DIScope(DbgNode).printInternal(OS);
Bill Wendlinge8778242012-06-26 23:22:18 +00001239 }
1240}
1241
1242void DISubrange::printInternal(raw_ostream &OS) const {
Bill Wendling9493dae2012-12-04 21:34:03 +00001243 int64_t Count = getCount();
1244 if (Count != -1)
1245 OS << " [" << getLo() << ", " << Count - 1 << ']';
1246 else
Bill Wendling46defa52012-12-05 21:43:30 +00001247 OS << " [unbounded]";
Bill Wendlinge8778242012-06-26 23:22:18 +00001248}
1249
1250void DIScope::printInternal(raw_ostream &OS) const {
1251 OS << " [" << getDirectory() << "/" << getFilename() << ']';
1252}
1253
1254void DICompileUnit::printInternal(raw_ostream &OS) const {
1255 DIScope::printInternal(OS);
David Blaikie2ca02c62013-04-17 03:41:36 +00001256 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 << ']';
Bill Wendlinge8778242012-06-26 23:22:18 +00001263}
1264
1265void DIEnumerator::printInternal(raw_ostream &OS) const {
1266 OS << " [" << getName() << " :: " << getEnumValue() << ']';
1267}
1268
1269void DIType::printInternal(raw_ostream &OS) const {
1270 if (!DbgNode) return;
1271
1272 StringRef Res = getName();
1273 if (!Res.empty())
1274 OS << " [" << Res << "]";
1275
1276 // TODO: Print context?
1277
1278 OS << " [line " << getLineNumber()
1279 << ", size " << getSizeInBits()
1280 << ", align " << getAlignInBits()
1281 << ", offset " << getOffsetInBits();
1282 if (isBasicType())
Eric Christopher5f214ae2012-11-20 00:15:36 +00001283 if (const char *Enc =
Bill Wendlingfc1c70a2012-06-28 02:12:20 +00001284 dwarf::AttributeEncodingString(DIBasicType(DbgNode).getEncoding()))
1285 OS << ", enc " << Enc;
Bill Wendlinge8778242012-06-26 23:22:18 +00001286 OS << "]";
1287
1288 if (isPrivate())
1289 OS << " [private]";
1290 else if (isProtected())
1291 OS << " [protected]";
1292
David Blaikie0fecdfb2013-01-08 00:31:02 +00001293 if (isArtificial())
1294 OS << " [artificial]";
1295
Bill Wendlinge8778242012-06-26 23:22:18 +00001296 if (isForwardDecl())
David Blaikiee954d982013-06-21 03:41:54 +00001297 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]";
Eric Christopher9a1e0e22013-01-08 01:53:52 +00001303 if (isVector())
1304 OS << " [vector]";
Eric Christopher6b6061f2013-01-16 01:22:23 +00001305 if (isStaticMember())
1306 OS << " [static]";
Bill Wendlinge8778242012-06-26 23:22:18 +00001307}
1308
1309void DIDerivedType::printInternal(raw_ostream &OS) const {
1310 DIType::printInternal(OS);
1311 OS << " [from " << getTypeDerivedFrom().getName() << ']';
1312}
1313
1314void DICompositeType::printInternal(raw_ostream &OS) const {
1315 DIType::printInternal(OS);
1316 DIArray A = getTypeArray();
1317 OS << " [" << A.getNumElements() << " elements]";
1318}
1319
David Blaikie1cd30fd2013-03-20 05:14:14 +00001320void DINameSpace::printInternal(raw_ostream &OS) const {
1321 StringRef Name = getName();
1322 if (!Name.empty())
1323 OS << " [" << Name << ']';
1324
1325 OS << " [line " << getLineNumber() << ']';
1326}
1327
Bill Wendlinge8778242012-06-26 23:22:18 +00001328void DISubprogram::printInternal(raw_ostream &OS) const {
Bill Wendlinge8778242012-06-26 23:22:18 +00001329 // TODO : Print context
Bill Wendlinge8778242012-06-26 23:22:18 +00001330 OS << " [line " << getLineNumber() << ']';
1331
1332 if (isLocalToUnit())
1333 OS << " [local]";
1334
1335 if (isDefinition())
1336 OS << " [def]";
1337
1338 if (getScopeLineNumber() != getLineNumber())
1339 OS << " [scope " << getScopeLineNumber() << "]";
Bill Wendlingee17cee2012-07-06 23:43:12 +00001340
David Blaikiee302b6c2013-01-05 21:39:33 +00001341 if (isPrivate())
1342 OS << " [private]";
1343 else if (isProtected())
1344 OS << " [protected]";
1345
Bill Wendlingee17cee2012-07-06 23:43:12 +00001346 StringRef Res = getName();
1347 if (!Res.empty())
1348 OS << " [" << Res << ']';
Bill Wendlinge8778242012-06-26 23:22:18 +00001349}
1350
1351void DIGlobalVariable::printInternal(raw_ostream &OS) const {
1352 StringRef Res = getName();
1353 if (!Res.empty())
1354 OS << " [" << Res << ']';
1355
1356 OS << " [line " << getLineNumber() << ']';
1357
1358 // TODO : Print context
1359
1360 if (isLocalToUnit())
1361 OS << " [local]";
1362
1363 if (isDefinition())
1364 OS << " [def]";
1365}
1366
1367void DIVariable::printInternal(raw_ostream &OS) const {
1368 StringRef Res = getName();
1369 if (!Res.empty())
1370 OS << " [" << Res << ']';
1371
1372 OS << " [line " << getLineNumber() << ']';
1373}
1374
Bill Wendling2da1a162012-07-06 19:12:31 +00001375void DIObjCProperty::printInternal(raw_ostream &OS) const {
1376 StringRef Name = getObjCPropertyName();
1377 if (!Name.empty())
1378 OS << " [" << Name << ']';
1379
1380 OS << " [line " << getLineNumber()
1381 << ", properties " << getUnsignedField(6) << ']';
1382}
1383
Bill Wendlinge8778242012-06-26 23:22:18 +00001384static 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));
Manman Renc7b61c62013-07-01 18:20:30 +00001388 assert(Scope.isScope() &&
1389 "Scope of a DebugLoc should be a DIScope.");
Bill Wendlinge8778242012-06-26 23:22:18 +00001390 // Omit the directory, because it's likely to be long and uninteresting.
Manman Renc7b61c62013-07-01 18:20:30 +00001391 CommentOS << Scope.getFilename();
Bill Wendlinge8778242012-06-26 23:22:18 +00001392 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}
1403
1404void 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}
Manman Renbc660712013-09-05 18:48:31 +00001418
1419DITypeRef::DITypeRef(const Value *V) : TypeVal(V) {
1420 assert(isTypeRef(V) && "DITypeRef should be a MDString or MDNode");
1421}
1422
1423/// Given a DITypeIdentifierMap, tries to find the corresponding
1424/// DIType for a DITypeRef.
1425DIType DITypeRef::resolve(const DITypeIdentifierMap &Map) const {
1426 if (!TypeVal)
1427 return NULL;
1428
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 }
1434
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}
1443
1444/// Specialize getFieldAs to handle fields that are references to DITypes.
1445template <>
1446DITypeRef DIDescriptor::getFieldAs<DITypeRef>(unsigned Elt) const {
1447 return DITypeRef(getField(DbgNode, Elt));
1448}