blob: dc22db3b01bcd875db4b1484987731073f075046 [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:
Manman Ren626a4b72013-09-09 19:00:55 +0000249 case dwarf::DW_TAG_file_type:
Chris Lattner099b7792009-12-29 09:22:47 +0000250 return true;
251 default:
252 break;
Devang Patel43d98b32009-08-31 20:44:45 +0000253 }
Manman Ren626a4b72013-09-09 19:00:55 +0000254 return isType();
Devang Patel43d98b32009-08-31 20:44:45 +0000255}
Devang Patel6ceea332009-08-31 18:49:10 +0000256
Devang Patel7e2cb112011-02-02 21:38:25 +0000257/// isTemplateTypeParameter - Return true if the specified tag is
258/// DW_TAG_template_type_parameter.
259bool DIDescriptor::isTemplateTypeParameter() const {
260 return DbgNode && getTag() == dwarf::DW_TAG_template_type_parameter;
261}
262
Devang Patele7d93872011-02-02 22:35:53 +0000263/// isTemplateValueParameter - Return true if the specified tag is
264/// DW_TAG_template_value_parameter.
265bool DIDescriptor::isTemplateValueParameter() const {
David Blaikiee88939c2013-06-22 18:59:11 +0000266 return DbgNode && (getTag() == dwarf::DW_TAG_template_value_parameter ||
267 getTag() == dwarf::DW_TAG_GNU_template_template_param ||
268 getTag() == dwarf::DW_TAG_GNU_template_parameter_pack);
Devang Patele7d93872011-02-02 22:35:53 +0000269}
270
Devang Patelc9f322d2009-08-31 21:34:44 +0000271/// isCompileUnit - Return true if the specified tag is DW_TAG_compile_unit.
272bool DIDescriptor::isCompileUnit() const {
Devang Patel3c91b052010-03-08 20:52:55 +0000273 return DbgNode && getTag() == dwarf::DW_TAG_compile_unit;
Devang Patelc9f322d2009-08-31 21:34:44 +0000274}
275
Devang Patel7aa81892010-03-08 22:27:22 +0000276/// isFile - Return true if the specified tag is DW_TAG_file_type.
277bool DIDescriptor::isFile() const {
278 return DbgNode && getTag() == dwarf::DW_TAG_file_type;
279}
280
Devang Patel6404e4e2009-12-15 19:16:48 +0000281/// isNameSpace - Return true if the specified tag is DW_TAG_namespace.
282bool DIDescriptor::isNameSpace() const {
Devang Patel3c91b052010-03-08 20:52:55 +0000283 return DbgNode && getTag() == dwarf::DW_TAG_namespace;
Devang Patel6404e4e2009-12-15 19:16:48 +0000284}
285
Eric Christopher6618a242011-10-11 22:59:11 +0000286/// isLexicalBlockFile - Return true if the specified descriptor is a
287/// lexical block with an extra file.
288bool DIDescriptor::isLexicalBlockFile() const {
289 return DbgNode && getTag() == dwarf::DW_TAG_lexical_block &&
David Blaikie72dfb052013-03-28 02:44:59 +0000290 (DbgNode->getNumOperands() == 3);
Eric Christopher6618a242011-10-11 22:59:11 +0000291}
292
Devang Patel5e005d82009-08-31 22:00:15 +0000293/// isLexicalBlock - Return true if the specified tag is DW_TAG_lexical_block.
294bool DIDescriptor::isLexicalBlock() const {
Eric Christopher6618a242011-10-11 22:59:11 +0000295 return DbgNode && getTag() == dwarf::DW_TAG_lexical_block &&
David Blaikie72dfb052013-03-28 02:44:59 +0000296 (DbgNode->getNumOperands() > 3);
Devang Patel5e005d82009-08-31 22:00:15 +0000297}
298
Devang Patelecbeb1a2009-09-30 22:34:41 +0000299/// isSubrange - Return true if the specified tag is DW_TAG_subrange_type.
300bool DIDescriptor::isSubrange() const {
Devang Patel3c91b052010-03-08 20:52:55 +0000301 return DbgNode && getTag() == dwarf::DW_TAG_subrange_type;
Devang Patelecbeb1a2009-09-30 22:34:41 +0000302}
303
304/// isEnumerator - Return true if the specified tag is DW_TAG_enumerator.
305bool DIDescriptor::isEnumerator() const {
Devang Patel3c91b052010-03-08 20:52:55 +0000306 return DbgNode && getTag() == dwarf::DW_TAG_enumerator;
Devang Patelecbeb1a2009-09-30 22:34:41 +0000307}
308
David Blaikie35450432013-03-27 17:50:12 +0000309/// isObjCProperty - Return true if the specified tag is DW_TAG_APPLE_property.
Devang Patel1ea02d42012-02-04 00:59:25 +0000310bool DIDescriptor::isObjCProperty() const {
Eric Christopher6c31ee22012-03-29 21:35:05 +0000311 return DbgNode && getTag() == dwarf::DW_TAG_APPLE_property;
Devang Patel1ea02d42012-02-04 00:59:25 +0000312}
David Blaikiec462db62013-04-22 06:12:31 +0000313
David Blaikie20d9e412013-05-07 21:35:53 +0000314/// \brief Return true if the specified tag is DW_TAG_imported_module or
315/// DW_TAG_imported_declaration.
316bool DIDescriptor::isImportedEntity() const {
317 return DbgNode && (getTag() == dwarf::DW_TAG_imported_module ||
318 getTag() == dwarf::DW_TAG_imported_declaration);
David Blaikiec462db62013-04-22 06:12:31 +0000319}
320
Devang Patel6ceea332009-08-31 18:49:10 +0000321//===----------------------------------------------------------------------===//
322// Simple Descriptor Constructors and other Methods
323//===----------------------------------------------------------------------===//
324
Devang Patel68afdc32009-01-05 18:33:01 +0000325unsigned DIArray::getNumElements() const {
Devang Patel3c91b052010-03-08 20:52:55 +0000326 if (!DbgNode)
327 return 0;
Chris Lattner5d0cacd2009-12-31 01:22:29 +0000328 return DbgNode->getNumOperands();
Devang Patel68afdc32009-01-05 18:33:01 +0000329}
Chris Lattnera45664f2008-11-10 02:56:27 +0000330
Eric Christophere6f774e2013-07-24 01:51:12 +0000331/// replaceAllUsesWith - Replace all uses of the MDNode used by this
332/// type with the one in the passed descriptor.
Dan Gohman489b29b2010-08-20 22:02:26 +0000333void DIType::replaceAllUsesWith(DIDescriptor &D) {
Eric Christophere6f774e2013-07-24 01:51:12 +0000334
335 assert(DbgNode && "Trying to replace an unverified type!");
Devang Patelc4999d72009-07-22 18:23:44 +0000336
Daniel Dunbar48a097b2009-09-22 02:03:18 +0000337 // Since we use a TrackingVH for the node, its easy for clients to manufacture
338 // legitimate situations where they want to replaceAllUsesWith() on something
339 // which, due to uniquing, has merged with the source. We shield clients from
340 // this detail by allowing a value to be replaced with replaceAllUsesWith()
341 // itself.
Devang Pateled66bf52010-05-07 18:19:32 +0000342 if (DbgNode != D) {
Devang Patele9f8f5e2010-05-07 20:54:48 +0000343 MDNode *Node = const_cast<MDNode*>(DbgNode);
344 const MDNode *DN = D;
345 const Value *V = cast_or_null<Value>(DN);
346 Node->replaceAllUsesWith(const_cast<Value*>(V));
Dan Gohman489b29b2010-08-20 22:02:26 +0000347 MDNode::deleteTemporary(Node);
Daniel Dunbar48a097b2009-09-22 02:03:18 +0000348 }
Devang Patelc4999d72009-07-22 18:23:44 +0000349}
350
Eric Christophere6f774e2013-07-24 01:51:12 +0000351/// replaceAllUsesWith - Replace all uses of the MDNode used by this
352/// type with the one in D.
Devang Patel0a2551d2010-12-08 20:18:20 +0000353void DIType::replaceAllUsesWith(MDNode *D) {
Eric Christophere6f774e2013-07-24 01:51:12 +0000354
355 assert(DbgNode && "Trying to replace an unverified type!");
Devang Patel0a2551d2010-12-08 20:18:20 +0000356
357 // Since we use a TrackingVH for the node, its easy for clients to manufacture
358 // legitimate situations where they want to replaceAllUsesWith() on something
359 // which, due to uniquing, has merged with the source. We shield clients from
360 // this detail by allowing a value to be replaced with replaceAllUsesWith()
361 // itself.
362 if (DbgNode != D) {
363 MDNode *Node = const_cast<MDNode*>(DbgNode);
364 const MDNode *DN = D;
365 const Value *V = cast_or_null<Value>(DN);
366 Node->replaceAllUsesWith(const_cast<Value*>(V));
367 MDNode::deleteTemporary(Node);
368 }
369}
370
Devang Patel6f9d8ff2011-08-15 17:57:41 +0000371/// isUnsignedDIType - Return true if type encoding is unsigned.
372bool DIType::isUnsignedDIType() {
373 DIDerivedType DTy(DbgNode);
374 if (DTy.Verify())
375 return DTy.getTypeDerivedFrom().isUnsignedDIType();
376
377 DIBasicType BTy(DbgNode);
378 if (BTy.Verify()) {
379 unsigned Encoding = BTy.getEncoding();
380 if (Encoding == dwarf::DW_ATE_unsigned ||
David Blaikiefe07db32013-01-19 23:00:25 +0000381 Encoding == dwarf::DW_ATE_unsigned_char ||
382 Encoding == dwarf::DW_ATE_boolean)
Devang Patel6f9d8ff2011-08-15 17:57:41 +0000383 return true;
384 }
385 return false;
386}
387
Devang Patelb79b5352009-01-19 23:21:49 +0000388/// Verify - Verify that a compile unit is well formed.
389bool DICompileUnit::Verify() const {
David Blaikiec0ec8a42013-03-11 23:39:23 +0000390 if (!isCompileUnit())
Devang Patelb79b5352009-01-19 23:21:49 +0000391 return false;
Eric Christopher78ac65f2013-07-24 00:54:39 +0000392
393 // Don't bother verifying the compilation directory or producer string
394 // as those could be empty.
395 if (getFilename().empty())
Bill Wendling0582ae92009-03-13 04:39:26 +0000396 return false;
Eric Christopher78ac65f2013-07-24 00:54:39 +0000397
David Blaikiec462db62013-04-22 06:12:31 +0000398 return DbgNode->getNumOperands() == 13;
Devang Patelb79b5352009-01-19 23:21:49 +0000399}
400
Eric Christopherb8ca9882012-03-29 08:42:56 +0000401/// Verify - Verify that an ObjC property is well formed.
402bool DIObjCProperty::Verify() const {
David Blaikiec0ec8a42013-03-11 23:39:23 +0000403 if (!isObjCProperty())
Eric Christopherb8ca9882012-03-29 08:42:56 +0000404 return false;
David Blaikiec0ec8a42013-03-11 23:39:23 +0000405
Eric Christopherb8ca9882012-03-29 08:42:56 +0000406 // Don't worry about the rest of the strings for now.
David Blaikiec0ec8a42013-03-11 23:39:23 +0000407 return DbgNode->getNumOperands() == 8;
Eric Christopherb8ca9882012-03-29 08:42:56 +0000408}
409
Manman Ren3367ed32013-07-25 21:19:31 +0000410/// Check if a field at position Elt of a MDNode is a MDNode.
411/// We currently allow an empty string and an integer.
412/// But we don't allow a non-empty string in a MDNode field.
Manman Ren27ce44d2013-07-25 06:43:01 +0000413static bool fieldIsMDNode(const MDNode *DbgNode, unsigned Elt) {
Manman Ren3367ed32013-07-25 21:19:31 +0000414 // FIXME: This function should return true, if the field is null or the field
415 // is indeed a MDNode: return !Fld || isa<MDNode>(Fld).
Manman Ren27ce44d2013-07-25 06:43:01 +0000416 Value *Fld = getField(DbgNode, Elt);
417 if (Fld && isa<MDString>(Fld) &&
418 !cast<MDString>(Fld)->getString().empty())
419 return false;
420 return true;
421}
422
Manman Ren6e3cd0e2013-08-26 22:39:55 +0000423/// Check if a field at position Elt of a MDNode is a MDString.
424static bool fieldIsMDString(const MDNode *DbgNode, unsigned Elt) {
425 Value *Fld = getField(DbgNode, Elt);
426 return !Fld || isa<MDString>(Fld);
427}
428
Manman Renc5733052013-09-09 19:03:51 +0000429/// Check if a value can be a reference to a type.
Manman Renbc660712013-09-05 18:48:31 +0000430static bool isTypeRef(const Value *Val) {
Manman Renc5733052013-09-09 19:03:51 +0000431 return !Val ||
432 (isa<MDString>(Val) && !cast<MDString>(Val)->getString().empty()) ||
433 (isa<MDNode>(Val) && DIType(cast<MDNode>(Val)).isType());
Manman Renbc660712013-09-05 18:48:31 +0000434}
435
Manman Renc5733052013-09-09 19:03:51 +0000436/// Check if a field at position Elt of a MDNode can be a reference to a type.
Manman Renbc660712013-09-05 18:48:31 +0000437static bool fieldIsTypeRef(const MDNode *DbgNode, unsigned Elt) {
438 Value *Fld = getField(DbgNode, Elt);
439 return isTypeRef(Fld);
440}
441
Manman Renc5733052013-09-09 19:03:51 +0000442/// Check if a value can be a ScopeRef.
443static bool isScopeRef(const Value *Val) {
444 return !Val ||
445 (isa<MDString>(Val) && !cast<MDString>(Val)->getString().empty()) ||
446 (isa<MDNode>(Val) && DIScope(cast<MDNode>(Val)).isScope());
447}
448
Devang Patelb79b5352009-01-19 23:21:49 +0000449/// Verify - Verify that a type descriptor is well formed.
450bool DIType::Verify() const {
David Blaikiec0ec8a42013-03-11 23:39:23 +0000451 if (!isType())
Devang Patelb79b5352009-01-19 23:21:49 +0000452 return false;
Manman Rencb420a42013-07-25 19:33:30 +0000453 // Make sure Context @ field 2 is MDNode.
454 if (!fieldIsMDNode(DbgNode, 2))
455 return false;
456
Eric Christopherbf7644a2013-07-24 00:54:36 +0000457 // FIXME: Sink this into the various subclass verifies.
Eric Christopher31667622013-08-08 01:41:00 +0000458 uint16_t Tag = getTag();
Devang Patelb71bbf92010-11-02 20:41:13 +0000459 if (!isBasicType() && Tag != dwarf::DW_TAG_const_type &&
460 Tag != dwarf::DW_TAG_volatile_type && Tag != dwarf::DW_TAG_pointer_type &&
David Blaikie62fdfb52013-01-07 05:51:15 +0000461 Tag != dwarf::DW_TAG_ptr_to_member_type &&
Eric Christopher791e6292012-05-19 01:36:37 +0000462 Tag != dwarf::DW_TAG_reference_type &&
463 Tag != dwarf::DW_TAG_rvalue_reference_type &&
Eric Christopherbf7644a2013-07-24 00:54:36 +0000464 Tag != dwarf::DW_TAG_restrict_type && Tag != dwarf::DW_TAG_array_type &&
Eric Christopher791e6292012-05-19 01:36:37 +0000465 Tag != dwarf::DW_TAG_enumeration_type &&
466 Tag != dwarf::DW_TAG_subroutine_type &&
Eric Christopherbf7644a2013-07-24 00:54:36 +0000467 Tag != dwarf::DW_TAG_inheritance && Tag != dwarf::DW_TAG_friend &&
Eric Christopher791e6292012-05-19 01:36:37 +0000468 getFilename().empty())
Devang Patelb79b5352009-01-19 23:21:49 +0000469 return false;
Manman Ren9fd61782013-07-23 18:14:25 +0000470 // DIType is abstract, it should be a BasicType, a DerivedType or
471 // a CompositeType.
472 if (isBasicType())
473 DIBasicType(DbgNode).Verify();
474 else if (isCompositeType())
475 DICompositeType(DbgNode).Verify();
476 else if (isDerivedType())
477 DIDerivedType(DbgNode).Verify();
478 else
479 return false;
Devang Patelb79b5352009-01-19 23:21:49 +0000480 return true;
481}
482
Devang Patel0c4720c2010-08-23 18:25:56 +0000483/// Verify - Verify that a basic type descriptor is well formed.
484bool DIBasicType::Verify() const {
David Blaikie72dfb052013-03-28 02:44:59 +0000485 return isBasicType() && DbgNode->getNumOperands() == 10;
Devang Patel0c4720c2010-08-23 18:25:56 +0000486}
487
488/// Verify - Verify that a derived type descriptor is well formed.
489bool DIDerivedType::Verify() const {
Manman Ren27ce44d2013-07-25 06:43:01 +0000490 // Make sure DerivedFrom @ field 9 is MDNode.
491 if (!fieldIsMDNode(DbgNode, 9))
492 return false;
493 if (getTag() == dwarf::DW_TAG_ptr_to_member_type)
Manman Renbc660712013-09-05 18:48:31 +0000494 // Make sure ClassType @ field 10 is a TypeRef.
495 if (!fieldIsTypeRef(DbgNode, 10))
Manman Ren27ce44d2013-07-25 06:43:01 +0000496 return false;
497
David Blaikie72dfb052013-03-28 02:44:59 +0000498 return isDerivedType() && DbgNode->getNumOperands() >= 10 &&
499 DbgNode->getNumOperands() <= 14;
Devang Patel0c4720c2010-08-23 18:25:56 +0000500}
501
Devang Patelb79b5352009-01-19 23:21:49 +0000502/// Verify - Verify that a composite type descriptor is well formed.
503bool DICompositeType::Verify() const {
David Blaikiec0ec8a42013-03-11 23:39:23 +0000504 if (!isCompositeType())
Devang Patelb79b5352009-01-19 23:21:49 +0000505 return false;
Devang Patelb79b5352009-01-19 23:21:49 +0000506
Manman Ren27ce44d2013-07-25 06:43:01 +0000507 // Make sure DerivedFrom @ field 9 and ContainingType @ field 12 are MDNodes.
508 if (!fieldIsMDNode(DbgNode, 9))
509 return false;
Manman Rene42279c2013-09-06 18:46:00 +0000510 if (!fieldIsTypeRef(DbgNode, 12))
Manman Ren27ce44d2013-07-25 06:43:01 +0000511 return false;
512
Manman Ren6e3cd0e2013-08-26 22:39:55 +0000513 // Make sure the type identifier at field 14 is MDString, it can be null.
514 if (!fieldIsMDString(DbgNode, 14))
515 return false;
516
Eric Christopherdc1363f2013-08-08 07:40:37 +0000517 // If this is an array type verify that we have a DIType in the derived type
518 // field as that's the type of our element.
519 if (getTag() == dwarf::DW_TAG_array_type)
520 if (!DIType(getTypeDerivedFrom()))
521 return false;
522
Manman Ren6e3cd0e2013-08-26 22:39:55 +0000523 return DbgNode->getNumOperands() == 15;
Devang Patelb79b5352009-01-19 23:21:49 +0000524}
525
526/// Verify - Verify that a subprogram descriptor is well formed.
527bool DISubprogram::Verify() const {
David Blaikiec0ec8a42013-03-11 23:39:23 +0000528 if (!isSubprogram())
Devang Patelb79b5352009-01-19 23:21:49 +0000529 return false;
Daniel Dunbarf612ff62009-09-19 20:40:05 +0000530
Manman Ren27ce44d2013-07-25 06:43:01 +0000531 // Make sure context @ field 2 and type @ field 7 are MDNodes.
532 if (!fieldIsMDNode(DbgNode, 2))
533 return false;
534 if (!fieldIsMDNode(DbgNode, 7))
535 return false;
536 // Containing type @ field 12.
Manman Ren0e85f6e2013-09-07 00:04:05 +0000537 if (!fieldIsTypeRef(DbgNode, 12))
Manman Ren27ce44d2013-07-25 06:43:01 +0000538 return false;
David Blaikie72dfb052013-03-28 02:44:59 +0000539 return DbgNode->getNumOperands() == 20;
Devang Patelb79b5352009-01-19 23:21:49 +0000540}
541
542/// Verify - Verify that a global variable descriptor is well formed.
543bool DIGlobalVariable::Verify() const {
David Blaikiec0ec8a42013-03-11 23:39:23 +0000544 if (!isGlobalVariable())
Devang Patelb79b5352009-01-19 23:21:49 +0000545 return false;
Daniel Dunbarf612ff62009-09-19 20:40:05 +0000546
Devang Patel65dbc902009-11-25 17:36:49 +0000547 if (getDisplayName().empty())
Devang Patel84c73e92009-11-06 17:58:12 +0000548 return false;
Manman Ren27ce44d2013-07-25 06:43:01 +0000549 // Make sure context @ field 2 and type @ field 8 are MDNodes.
550 if (!fieldIsMDNode(DbgNode, 2))
551 return false;
552 if (!fieldIsMDNode(DbgNode, 8))
553 return false;
554 // Make sure StaticDataMemberDeclaration @ field 12 is MDNode.
555 if (!fieldIsMDNode(DbgNode, 12))
556 return false;
Devang Patel84c73e92009-11-06 17:58:12 +0000557
David Blaikiec0ec8a42013-03-11 23:39:23 +0000558 return DbgNode->getNumOperands() == 13;
Devang Patelb79b5352009-01-19 23:21:49 +0000559}
560
561/// Verify - Verify that a variable descriptor is well formed.
562bool DIVariable::Verify() const {
David Blaikiec0ec8a42013-03-11 23:39:23 +0000563 if (!isVariable())
Devang Patelb79b5352009-01-19 23:21:49 +0000564 return false;
Daniel Dunbarf612ff62009-09-19 20:40:05 +0000565
Manman Ren27ce44d2013-07-25 06:43:01 +0000566 // Make sure context @ field 1 and type @ field 5 are MDNodes.
567 if (!fieldIsMDNode(DbgNode, 1))
568 return false;
569 if (!fieldIsMDNode(DbgNode, 5))
570 return false;
David Blaikiec0ec8a42013-03-11 23:39:23 +0000571 return DbgNode->getNumOperands() >= 8;
Devang Patelb79b5352009-01-19 23:21:49 +0000572}
573
Devang Patel3c91b052010-03-08 20:52:55 +0000574/// Verify - Verify that a location descriptor is well formed.
575bool DILocation::Verify() const {
576 if (!DbgNode)
577 return false;
Jim Grosbache62b6902010-07-21 21:36:25 +0000578
Devang Patel3c91b052010-03-08 20:52:55 +0000579 return DbgNode->getNumOperands() == 4;
580}
581
Devang Patel47e22652010-05-07 23:04:32 +0000582/// Verify - Verify that a namespace descriptor is well formed.
583bool DINameSpace::Verify() const {
David Blaikiec0ec8a42013-03-11 23:39:23 +0000584 if (!isNameSpace())
Devang Patel47e22652010-05-07 23:04:32 +0000585 return false;
David Blaikie72dfb052013-03-28 02:44:59 +0000586 return DbgNode->getNumOperands() == 5;
David Blaikiec0ec8a42013-03-11 23:39:23 +0000587}
588
David Blaikie4776bce2013-03-20 00:26:26 +0000589/// \brief Retrieve the MDNode for the directory/file pair.
590MDNode *DIFile::getFileNode() const {
Manman Rend2ed53c2013-07-23 20:39:32 +0000591 return getNodeField(DbgNode, 1);
David Blaikie4776bce2013-03-20 00:26:26 +0000592}
593
David Blaikiec0ec8a42013-03-11 23:39:23 +0000594/// \brief Verify that the file descriptor is well formed.
595bool DIFile::Verify() const {
David Blaikie72dfb052013-03-28 02:44:59 +0000596 return isFile() && DbgNode->getNumOperands() == 2;
David Blaikiec0ec8a42013-03-11 23:39:23 +0000597}
598
599/// \brief Verify that the enumerator descriptor is well formed.
600bool DIEnumerator::Verify() const {
601 return isEnumerator() && DbgNode->getNumOperands() == 3;
602}
603
604/// \brief Verify that the subrange descriptor is well formed.
605bool DISubrange::Verify() const {
606 return isSubrange() && DbgNode->getNumOperands() == 3;
607}
608
609/// \brief Verify that the lexical block descriptor is well formed.
610bool DILexicalBlock::Verify() const {
David Blaikie72dfb052013-03-28 02:44:59 +0000611 return isLexicalBlock() && DbgNode->getNumOperands() == 6;
David Blaikiec0ec8a42013-03-11 23:39:23 +0000612}
613
614/// \brief Verify that the file-scoped lexical block descriptor is well formed.
615bool DILexicalBlockFile::Verify() const {
David Blaikie72dfb052013-03-28 02:44:59 +0000616 return isLexicalBlockFile() && DbgNode->getNumOperands() == 3;
David Blaikiec0ec8a42013-03-11 23:39:23 +0000617}
618
619/// \brief Verify that the template type parameter descriptor is well formed.
620bool DITemplateTypeParameter::Verify() const {
621 return isTemplateTypeParameter() && DbgNode->getNumOperands() == 7;
622}
623
624/// \brief Verify that the template value parameter descriptor is well formed.
625bool DITemplateValueParameter::Verify() const {
626 return isTemplateValueParameter() && DbgNode->getNumOperands() == 8;
Devang Patel47e22652010-05-07 23:04:32 +0000627}
628
David Blaikiec462db62013-04-22 06:12:31 +0000629/// \brief Verify that the imported module descriptor is well formed.
David Blaikie20d9e412013-05-07 21:35:53 +0000630bool DIImportedEntity::Verify() const {
David Blaikie7b72cc72013-05-20 22:50:35 +0000631 return isImportedEntity() &&
632 (DbgNode->getNumOperands() == 4 || DbgNode->getNumOperands() == 5);
David Blaikiec462db62013-04-22 06:12:31 +0000633}
634
Devang Patel36375ee2009-02-17 21:23:59 +0000635/// getOriginalTypeSize - If this type is derived from a base type then
636/// return base type size.
637uint64_t DIDerivedType::getOriginalTypeSize() const {
Eric Christopher31667622013-08-08 01:41:00 +0000638 uint16_t Tag = getTag();
Eric Christopher2e1b0c02011-12-16 23:42:45 +0000639
Bill Wendlinge8778242012-06-26 23:22:18 +0000640 if (Tag != dwarf::DW_TAG_member && Tag != dwarf::DW_TAG_typedef &&
641 Tag != dwarf::DW_TAG_const_type && Tag != dwarf::DW_TAG_volatile_type &&
642 Tag != dwarf::DW_TAG_restrict_type)
643 return getSizeInBits();
Jim Grosbache62b6902010-07-21 21:36:25 +0000644
Bill Wendlinge8778242012-06-26 23:22:18 +0000645 DIType BaseType = getTypeDerivedFrom();
646
647 // If this type is not derived from any type then take conservative approach.
648 if (!BaseType.isValid())
649 return getSizeInBits();
650
651 // If this is a derived type, go ahead and get the base type, unless it's a
652 // reference then it's just the size of the field. Pointer types have no need
653 // of this since they're a different type of qualification on the type.
654 if (BaseType.getTag() == dwarf::DW_TAG_reference_type ||
655 BaseType.getTag() == dwarf::DW_TAG_rvalue_reference_type)
656 return getSizeInBits();
657
658 if (BaseType.isDerivedType())
659 return DIDerivedType(BaseType).getOriginalTypeSize();
660
661 return BaseType.getSizeInBits();
Devang Patel36375ee2009-02-17 21:23:59 +0000662}
Devang Patelb79b5352009-01-19 23:21:49 +0000663
Devang Patel6588abf2012-02-06 17:49:43 +0000664/// getObjCProperty - Return property node, if this ivar is associated with one.
665MDNode *DIDerivedType::getObjCProperty() const {
Manman Rend2ed53c2013-07-23 20:39:32 +0000666 return getNodeField(DbgNode, 10);
Devang Patel6588abf2012-02-06 17:49:43 +0000667}
668
Manman Ren6e3cd0e2013-08-26 22:39:55 +0000669MDString *DICompositeType::getIdentifier() const {
670 return cast_or_null<MDString>(getField(DbgNode, 14));
671}
672
David Blaikie02ae44f2013-08-28 20:42:43 +0000673#ifndef NDEBUG
674static void VerifySubsetOf(const MDNode *LHS, const MDNode *RHS) {
675 for (unsigned i = 0; i != LHS->getNumOperands(); ++i) {
David Blaikieb5011bd2013-08-28 20:45:45 +0000676 // Skip the 'empty' list (that's a single i32 0, rather than truly empty).
David Blaikie02ae44f2013-08-28 20:42:43 +0000677 if (i == 0 && isa<ConstantInt>(LHS->getOperand(i)))
678 continue;
679 const MDNode *E = cast<MDNode>(LHS->getOperand(i));
680 bool found = false;
681 for (unsigned j = 0; !found && j != RHS->getNumOperands(); ++j)
682 found = E == RHS->getOperand(j);
683 assert(found && "Losing a member during member list replacement");
684 }
685}
686#endif
687
David Blaikief34ea642013-03-26 23:46:36 +0000688/// \brief Set the array of member DITypes.
David Blaikied072a162013-03-26 21:59:17 +0000689void DICompositeType::setTypeArray(DIArray Elements, DIArray TParams) {
Manman Ren6e3cd0e2013-08-26 22:39:55 +0000690 assert((!TParams || DbgNode->getNumOperands() == 15) &&
Benjamin Kramer2b393fb2013-03-27 15:03:14 +0000691 "If you're setting the template parameters this should include a slot "
692 "for that!");
David Blaikied072a162013-03-26 21:59:17 +0000693 TrackingVH<MDNode> N(*this);
David Blaikie980879e2013-08-28 17:28:16 +0000694 if (Elements) {
695#ifndef NDEBUG
David Blaikieb5011bd2013-08-28 20:45:45 +0000696 // Check that the new list of members contains all the old members as well.
David Blaikie02ae44f2013-08-28 20:42:43 +0000697 if (const MDNode *El = cast_or_null<MDNode>(N->getOperand(10)))
698 VerifySubsetOf(El, Elements);
David Blaikie980879e2013-08-28 17:28:16 +0000699#endif
700 N->replaceOperandWith(10, Elements);
701 }
David Blaikied072a162013-03-26 21:59:17 +0000702 if (TParams)
David Blaikie72dfb052013-03-28 02:44:59 +0000703 N->replaceOperandWith(13, TParams);
David Blaikied072a162013-03-26 21:59:17 +0000704 DbgNode = N;
705}
706
David Blaikie692062f2013-08-16 20:42:14 +0000707void DICompositeType::addMember(DIDescriptor D) {
David Blaikie8328b692013-08-09 17:17:12 +0000708 SmallVector<llvm::Value *, 16> M;
709 DIArray OrigM = getTypeArray();
710 unsigned Elements = OrigM.getNumElements();
711 if (Elements == 1 && !OrigM.getElement(0))
712 Elements = 0;
713 M.reserve(Elements + 1);
714 for (unsigned i = 0; i != Elements; ++i)
715 M.push_back(OrigM.getElement(i));
David Blaikie692062f2013-08-16 20:42:14 +0000716 M.push_back(D);
David Blaikie8328b692013-08-09 17:17:12 +0000717 setTypeArray(DIArray(MDNode::get(DbgNode->getContext(), M)));
718}
719
Manman Ren5930eab2013-09-06 18:27:00 +0000720/// Generate a reference to this DIType. Uses the type identifier instead
721/// of the actual MDNode if possible, to help type uniquing.
Manman Renc5733052013-09-09 19:03:51 +0000722Value *DIScope::generateRef() {
Manman Ren5930eab2013-09-06 18:27:00 +0000723 if (!isCompositeType())
Manman Renc5733052013-09-09 19:03:51 +0000724 return *this;
Manman Ren5930eab2013-09-06 18:27:00 +0000725 DICompositeType DTy(DbgNode);
726 if (!DTy.getIdentifier())
Manman Renc5733052013-09-09 19:03:51 +0000727 return *this;
728 return DTy.getIdentifier();
Manman Ren5930eab2013-09-06 18:27:00 +0000729}
730
David Blaikief34ea642013-03-26 23:46:36 +0000731/// \brief Set the containing type.
732void DICompositeType::setContainingType(DICompositeType ContainingType) {
733 TrackingVH<MDNode> N(*this);
Manman Rene42279c2013-09-06 18:46:00 +0000734 N->replaceOperandWith(12, ContainingType.generateRef());
David Blaikief34ea642013-03-26 23:46:36 +0000735 DbgNode = N;
736}
737
Jim Grosbache62b6902010-07-21 21:36:25 +0000738/// isInlinedFnArgument - Return true if this variable provides debugging
Devang Patel719f6a92010-04-29 20:40:36 +0000739/// information for an inlined function arguments.
740bool DIVariable::isInlinedFnArgument(const Function *CurFn) {
741 assert(CurFn && "Invalid function");
742 if (!getContext().isSubprogram())
743 return false;
Jim Grosbache62b6902010-07-21 21:36:25 +0000744 // This variable is not inlined function argument if its scope
Devang Patel719f6a92010-04-29 20:40:36 +0000745 // does not describe current function.
Bill Wendlinge8778242012-06-26 23:22:18 +0000746 return !DISubprogram(getContext()).describes(CurFn);
Devang Patel719f6a92010-04-29 20:40:36 +0000747}
748
Devang Patelaf5b6bb2009-04-15 00:06:07 +0000749/// describes - Return true if this subprogram provides debugging
750/// information for the function F.
751bool DISubprogram::describes(const Function *F) {
Chris Lattner099b7792009-12-29 09:22:47 +0000752 assert(F && "Invalid function");
Devang Patelffd33cd2010-06-16 06:42:02 +0000753 if (F == getFunction())
754 return true;
Devang Patel65dbc902009-11-25 17:36:49 +0000755 StringRef Name = getLinkageName();
756 if (Name.empty())
Devang Patel5ccdd102009-09-29 18:40:58 +0000757 Name = getName();
Devang Patel65dbc902009-11-25 17:36:49 +0000758 if (F->getName() == Name)
Devang Patelaf5b6bb2009-04-15 00:06:07 +0000759 return true;
760 return false;
761}
762
Jim Grosbache62b6902010-07-21 21:36:25 +0000763unsigned DISubprogram::isOptimized() const {
Devang Patelccff8122010-04-30 19:38:23 +0000764 assert (DbgNode && "Invalid subprogram descriptor!");
David Blaikie72dfb052013-03-28 02:44:59 +0000765 if (DbgNode->getNumOperands() == 15)
766 return getUnsignedField(14);
Devang Patelccff8122010-04-30 19:38:23 +0000767 return 0;
768}
769
Devang Patel93d39be2011-08-19 23:28:12 +0000770MDNode *DISubprogram::getVariablesNodes() const {
Manman Rend2ed53c2013-07-23 20:39:32 +0000771 return getNodeField(DbgNode, 18);
Devang Patel93d39be2011-08-19 23:28:12 +0000772}
773
774DIArray DISubprogram::getVariables() const {
Manman Ren4f2c2972013-07-23 23:07:38 +0000775 return DIArray(getNodeField(DbgNode, 18));
Devang Patel93d39be2011-08-19 23:28:12 +0000776}
777
David Blaikie4de9d722013-05-10 21:52:07 +0000778Value *DITemplateValueParameter::getValue() const {
779 return getField(DbgNode, 4);
780}
781
Devang Patel65dbc902009-11-25 17:36:49 +0000782StringRef DIScope::getFilename() const {
Devang Patel77bf2952010-03-08 22:02:50 +0000783 if (!DbgNode)
784 return StringRef();
David Blaikieb4cf0ab2013-03-17 21:13:55 +0000785 return ::getStringField(getNodeField(DbgNode, 1), 0);
Devang Patelecbeb1a2009-09-30 22:34:41 +0000786}
787
Devang Patel65dbc902009-11-25 17:36:49 +0000788StringRef DIScope::getDirectory() const {
Devang Patel77bf2952010-03-08 22:02:50 +0000789 if (!DbgNode)
790 return StringRef();
David Blaikieb4cf0ab2013-03-17 21:13:55 +0000791 return ::getStringField(getNodeField(DbgNode, 1), 1);
Devang Patelecbeb1a2009-09-30 22:34:41 +0000792}
793
Devang Patel94c7ddb2011-08-16 22:09:43 +0000794DIArray DICompileUnit::getEnumTypes() const {
David Blaikiec462db62013-04-22 06:12:31 +0000795 if (!DbgNode || DbgNode->getNumOperands() < 13)
David Blaikie72dfb052013-03-28 02:44:59 +0000796 return DIArray();
797
Manman Ren4f2c2972013-07-23 23:07:38 +0000798 return DIArray(getNodeField(DbgNode, 7));
David Blaikie72dfb052013-03-28 02:44:59 +0000799}
800
801DIArray DICompileUnit::getRetainedTypes() const {
David Blaikiec462db62013-04-22 06:12:31 +0000802 if (!DbgNode || DbgNode->getNumOperands() < 13)
David Blaikiede3077a2013-03-13 00:01:35 +0000803 return DIArray();
804
Manman Ren4f2c2972013-07-23 23:07:38 +0000805 return DIArray(getNodeField(DbgNode, 8));
David Blaikiede3077a2013-03-13 00:01:35 +0000806}
807
David Blaikie72dfb052013-03-28 02:44:59 +0000808DIArray DICompileUnit::getSubprograms() const {
David Blaikiec462db62013-04-22 06:12:31 +0000809 if (!DbgNode || DbgNode->getNumOperands() < 13)
David Blaikie46561ce2013-03-12 22:43:04 +0000810 return DIArray();
811
Manman Ren4f2c2972013-07-23 23:07:38 +0000812 return DIArray(getNodeField(DbgNode, 9));
David Blaikie46561ce2013-03-12 22:43:04 +0000813}
814
David Blaikie72dfb052013-03-28 02:44:59 +0000815
816DIArray DICompileUnit::getGlobalVariables() const {
David Blaikiec462db62013-04-22 06:12:31 +0000817 if (!DbgNode || DbgNode->getNumOperands() < 13)
Devang Patel94c7ddb2011-08-16 22:09:43 +0000818 return DIArray();
819
Manman Ren4f2c2972013-07-23 23:07:38 +0000820 return DIArray(getNodeField(DbgNode, 10));
Devang Patel94c7ddb2011-08-16 22:09:43 +0000821}
822
David Blaikie20d9e412013-05-07 21:35:53 +0000823DIArray DICompileUnit::getImportedEntities() const {
David Blaikiec462db62013-04-22 06:12:31 +0000824 if (!DbgNode || DbgNode->getNumOperands() < 13)
825 return DIArray();
826
Manman Ren4f2c2972013-07-23 23:07:38 +0000827 return DIArray(getNodeField(DbgNode, 11));
David Blaikiec462db62013-04-22 06:12:31 +0000828}
829
Benjamin Kramer7c2b4be2013-06-01 17:51:14 +0000830/// fixupSubprogramName - Replace contains special characters used
Devang Patel62367042010-11-10 22:19:21 +0000831/// in a typical Objective-C names with '.' in a given string.
Benjamin Kramer7c2b4be2013-06-01 17:51:14 +0000832static void fixupSubprogramName(DISubprogram Fn, SmallVectorImpl<char> &Out) {
833 StringRef FName =
834 Fn.getFunction() ? Fn.getFunction()->getName() : Fn.getName();
835 FName = Function::getRealLinkageName(FName);
836
837 StringRef Prefix("llvm.dbg.lv.");
838 Out.reserve(FName.size() + Prefix.size());
839 Out.append(Prefix.begin(), Prefix.end());
840
Benjamin Kramer1a81d482011-06-18 14:42:42 +0000841 bool isObjCLike = false;
Benjamin Kramer7c2b4be2013-06-01 17:51:14 +0000842 for (size_t i = 0, e = FName.size(); i < e; ++i) {
843 char C = FName[i];
Benjamin Kramer1a81d482011-06-18 14:42:42 +0000844 if (C == '[')
845 isObjCLike = true;
846
847 if (isObjCLike && (C == '[' || C == ']' || C == ' ' || C == ':' ||
848 C == '+' || C == '(' || C == ')'))
849 Out.push_back('.');
850 else
851 Out.push_back(C);
Devang Patel62367042010-11-10 22:19:21 +0000852 }
853}
854
Eric Christopher5f214ae2012-11-20 00:15:36 +0000855/// getFnSpecificMDNode - Return a NameMDNode, if available, that is
Devang Patel62367042010-11-10 22:19:21 +0000856/// suitable to hold function specific information.
Devang Patel93d39be2011-08-19 23:28:12 +0000857NamedMDNode *llvm::getFnSpecificMDNode(const Module &M, DISubprogram Fn) {
Benjamin Kramer7c2b4be2013-06-01 17:51:14 +0000858 SmallString<32> Name;
859 fixupSubprogramName(Fn, Name);
Benjamin Kramer1a81d482011-06-18 14:42:42 +0000860 return M.getNamedMetadata(Name.str());
Devang Patel62367042010-11-10 22:19:21 +0000861}
862
Duncan Sands291bb702011-03-02 20:30:37 +0000863/// getOrInsertFnSpecificMDNode - Return a NameMDNode that is suitable
864/// to hold function specific information.
Devang Patel93d39be2011-08-19 23:28:12 +0000865NamedMDNode *llvm::getOrInsertFnSpecificMDNode(Module &M, DISubprogram Fn) {
Benjamin Kramer7c2b4be2013-06-01 17:51:14 +0000866 SmallString<32> Name;
867 fixupSubprogramName(Fn, Name);
Benjamin Kramer1a81d482011-06-18 14:42:42 +0000868 return M.getOrInsertNamedMetadata(Name.str());
Devang Patel1a7ca032010-09-28 18:08:20 +0000869}
870
Devang Patel23336b42011-07-19 19:41:54 +0000871/// createInlinedVariable - Create a new inlined variable based on current
872/// variable.
873/// @param DV Current Variable.
874/// @param InlinedScope Location at current variable is inlined.
875DIVariable llvm::createInlinedVariable(MDNode *DV, MDNode *InlinedScope,
876 LLVMContext &VMContext) {
877 SmallVector<Value *, 16> Elts;
878 // Insert inlined scope as 7th element.
879 for (unsigned i = 0, e = DV->getNumOperands(); i != e; ++i)
880 i == 7 ? Elts.push_back(InlinedScope) :
881 Elts.push_back(DV->getOperand(i));
882 return DIVariable(MDNode::get(VMContext, Elts));
883}
Devang Patel1a7ca032010-09-28 18:08:20 +0000884
Devang Patelb549bcf2011-08-10 21:50:54 +0000885/// cleanseInlinedVariable - Remove inlined scope from the variable.
886DIVariable llvm::cleanseInlinedVariable(MDNode *DV, LLVMContext &VMContext) {
887 SmallVector<Value *, 16> Elts;
888 // Insert inlined scope as 7th element.
889 for (unsigned i = 0, e = DV->getNumOperands(); i != e; ++i)
Eric Christopher5f214ae2012-11-20 00:15:36 +0000890 i == 7 ?
Bill Wendling0735e812012-07-06 17:46:28 +0000891 Elts.push_back(Constant::getNullValue(Type::getInt32Ty(VMContext))):
Devang Patelb549bcf2011-08-10 21:50:54 +0000892 Elts.push_back(DV->getOperand(i));
893 return DIVariable(MDNode::get(VMContext, Elts));
894}
895
Bill Wendling0bcbd1d2012-06-28 00:05:13 +0000896/// getDISubprogram - Find subprogram that is enclosing this scope.
897DISubprogram llvm::getDISubprogram(const MDNode *Scope) {
898 DIDescriptor D(Scope);
899 if (D.isSubprogram())
900 return DISubprogram(Scope);
901
902 if (D.isLexicalBlockFile())
903 return getDISubprogram(DILexicalBlockFile(Scope).getContext());
Eric Christopher5f214ae2012-11-20 00:15:36 +0000904
Bill Wendling0bcbd1d2012-06-28 00:05:13 +0000905 if (D.isLexicalBlock())
906 return getDISubprogram(DILexicalBlock(Scope).getContext());
907
908 return DISubprogram();
909}
910
Eric Christopher7bb386a2013-07-09 00:16:56 +0000911/// getDICompositeType - Find underlying composite type.
912DICompositeType llvm::getDICompositeType(DIType T) {
913 if (T.isCompositeType())
914 return DICompositeType(T);
915
916 if (T.isDerivedType())
917 return getDICompositeType(DIDerivedType(T).getTypeDerivedFrom());
918
919 return DICompositeType();
920}
921
Manman Renbc660712013-09-05 18:48:31 +0000922/// Update DITypeIdentifierMap by going through retained types of each CU.
923DITypeIdentifierMap llvm::generateDITypeIdentifierMap(
924 const NamedMDNode *CU_Nodes) {
925 DITypeIdentifierMap Map;
926 for (unsigned CUi = 0, CUe = CU_Nodes->getNumOperands(); CUi != CUe; ++CUi) {
927 DICompileUnit CU(CU_Nodes->getOperand(CUi));
928 DIArray Retain = CU.getRetainedTypes();
929 for (unsigned Ti = 0, Te = Retain.getNumElements(); Ti != Te; ++Ti) {
930 if (!Retain.getElement(Ti).isCompositeType())
931 continue;
932 DICompositeType Ty(Retain.getElement(Ti));
933 if (MDString *TypeId = Ty.getIdentifier()) {
934 // Definition has priority over declaration.
935 // Try to insert (TypeId, Ty) to Map.
936 std::pair<DITypeIdentifierMap::iterator, bool> P =
937 Map.insert(std::make_pair(TypeId, Ty));
938 // If TypeId already exists in Map and this is a definition, replace
939 // whatever we had (declaration or definition) with the definition.
940 if (!P.second && !Ty.isForwardDecl())
941 P.first->second = Ty;
942 }
943 }
944 }
945 return Map;
946}
947
Devang Pateld2f79a12009-07-28 19:55:13 +0000948//===----------------------------------------------------------------------===//
Devang Patel98c65172009-07-30 18:25:15 +0000949// DebugInfoFinder implementations.
Devang Pateld2f79a12009-07-28 19:55:13 +0000950//===----------------------------------------------------------------------===//
951
Manman Ren0e29eee2013-07-23 00:22:51 +0000952void DebugInfoFinder::reset() {
953 CUs.clear();
954 SPs.clear();
955 GVs.clear();
956 TYs.clear();
957 Scopes.clear();
958 NodesSeen.clear();
959}
960
Devang Patel98c65172009-07-30 18:25:15 +0000961/// processModule - Process entire module and collect debug info.
Eric Christopherc4639d62012-11-19 22:42:15 +0000962void DebugInfoFinder::processModule(const Module &M) {
Devang Patelcd2db162011-10-17 22:30:34 +0000963 if (NamedMDNode *CU_Nodes = M.getNamedMetadata("llvm.dbg.cu")) {
964 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
965 DICompileUnit CU(CU_Nodes->getOperand(i));
966 addCompileUnit(CU);
David Blaikiec0ec8a42013-03-11 23:39:23 +0000967 DIArray GVs = CU.getGlobalVariables();
968 for (unsigned i = 0, e = GVs.getNumElements(); i != e; ++i) {
969 DIGlobalVariable DIG(GVs.getElement(i));
Manman Ren96ea0382013-07-20 00:38:46 +0000970 if (addGlobalVariable(DIG)) {
Manman Renfdd16bb2013-07-22 20:28:53 +0000971 processScope(DIG.getContext());
David Blaikiec0ec8a42013-03-11 23:39:23 +0000972 processType(DIG.getType());
Manman Ren96ea0382013-07-20 00:38:46 +0000973 }
Devang Patelcd2db162011-10-17 22:30:34 +0000974 }
David Blaikiec0ec8a42013-03-11 23:39:23 +0000975 DIArray SPs = CU.getSubprograms();
976 for (unsigned i = 0, e = SPs.getNumElements(); i != e; ++i)
977 processSubprogram(DISubprogram(SPs.getElement(i)));
978 DIArray EnumTypes = CU.getEnumTypes();
979 for (unsigned i = 0, e = EnumTypes.getNumElements(); i != e; ++i)
980 processType(DIType(EnumTypes.getElement(i)));
981 DIArray RetainedTypes = CU.getRetainedTypes();
982 for (unsigned i = 0, e = RetainedTypes.getNumElements(); i != e; ++i)
983 processType(DIType(RetainedTypes.getElement(i)));
Manman Ren6b6a2ac2013-08-24 00:32:12 +0000984 DIArray Imports = CU.getImportedEntities();
985 for (unsigned i = 0, e = Imports.getNumElements(); i != e; ++i) {
986 DIImportedEntity Import = DIImportedEntity(
987 Imports.getElement(i));
988 DIDescriptor Entity = Import.getEntity();
989 if (Entity.isType())
990 processType(DIType(Entity));
991 else if (Entity.isSubprogram())
992 processSubprogram(DISubprogram(Entity));
993 else if (Entity.isNameSpace())
994 processScope(DINameSpace(Entity).getContext());
995 }
David Blaikiec0ec8a42013-03-11 23:39:23 +0000996 // FIXME: We really shouldn't be bailing out after visiting just one CU
997 return;
Devang Patelcd2db162011-10-17 22:30:34 +0000998 }
999 }
Devang Pateld2f79a12009-07-28 19:55:13 +00001000}
Daniel Dunbarf612ff62009-09-19 20:40:05 +00001001
Devang Patel6daf99b2009-11-10 22:05:35 +00001002/// processLocation - Process DILocation.
1003void DebugInfoFinder::processLocation(DILocation Loc) {
Manman Renf40d5782013-08-06 19:38:43 +00001004 if (!Loc) return;
1005 processScope(Loc.getScope());
Devang Patel6daf99b2009-11-10 22:05:35 +00001006 processLocation(Loc.getOrigLocation());
1007}
1008
Devang Patel98c65172009-07-30 18:25:15 +00001009/// processType - Process DIType.
1010void DebugInfoFinder::processType(DIType DT) {
Devang Patel72bcdb62009-08-10 22:09:58 +00001011 if (!addType(DT))
Devang Pateld2f79a12009-07-28 19:55:13 +00001012 return;
Manman Renfdd16bb2013-07-22 20:28:53 +00001013 processScope(DT.getContext());
Devang Patel6ceea332009-08-31 18:49:10 +00001014 if (DT.isCompositeType()) {
Devang Patel2db49d72010-05-07 18:11:54 +00001015 DICompositeType DCT(DT);
Devang Patel98c65172009-07-30 18:25:15 +00001016 processType(DCT.getTypeDerivedFrom());
Devang Pateld2f79a12009-07-28 19:55:13 +00001017 DIArray DA = DCT.getTypeArray();
Devang Patel3c91b052010-03-08 20:52:55 +00001018 for (unsigned i = 0, e = DA.getNumElements(); i != e; ++i) {
1019 DIDescriptor D = DA.getElement(i);
1020 if (D.isType())
Devang Patel2db49d72010-05-07 18:11:54 +00001021 processType(DIType(D));
Devang Patel3c91b052010-03-08 20:52:55 +00001022 else if (D.isSubprogram())
Devang Patel2db49d72010-05-07 18:11:54 +00001023 processSubprogram(DISubprogram(D));
Devang Patel3c91b052010-03-08 20:52:55 +00001024 }
Devang Patel6ceea332009-08-31 18:49:10 +00001025 } else if (DT.isDerivedType()) {
Devang Patel2db49d72010-05-07 18:11:54 +00001026 DIDerivedType DDT(DT);
Devang Patel3c91b052010-03-08 20:52:55 +00001027 processType(DDT.getTypeDerivedFrom());
Devang Pateld2f79a12009-07-28 19:55:13 +00001028 }
1029}
1030
Manman Renfdd16bb2013-07-22 20:28:53 +00001031void DebugInfoFinder::processScope(DIScope Scope) {
1032 if (Scope.isType()) {
1033 DIType Ty(Scope);
1034 processType(Ty);
1035 return;
1036 }
Manman Ren7894ffd2013-07-23 23:10:00 +00001037 if (Scope.isCompileUnit()) {
1038 addCompileUnit(DICompileUnit(Scope));
1039 return;
1040 }
1041 if (Scope.isSubprogram()) {
1042 processSubprogram(DISubprogram(Scope));
1043 return;
1044 }
Manman Renfdd16bb2013-07-22 20:28:53 +00001045 if (!addScope(Scope))
1046 return;
1047 if (Scope.isLexicalBlock()) {
1048 DILexicalBlock LB(Scope);
1049 processScope(LB.getContext());
1050 } else if (Scope.isLexicalBlockFile()) {
1051 DILexicalBlockFile LBF = DILexicalBlockFile(Scope);
1052 processScope(LBF.getScope());
1053 } else if (Scope.isNameSpace()) {
1054 DINameSpace NS(Scope);
1055 processScope(NS.getContext());
1056 }
1057}
1058
Devang Patelbeab41b2009-10-07 22:04:08 +00001059/// processLexicalBlock
1060void DebugInfoFinder::processLexicalBlock(DILexicalBlock LB) {
Devang Patelbeab41b2009-10-07 22:04:08 +00001061 DIScope Context = LB.getContext();
1062 if (Context.isLexicalBlock())
Devang Patel2db49d72010-05-07 18:11:54 +00001063 return processLexicalBlock(DILexicalBlock(Context));
Eric Christopher6618a242011-10-11 22:59:11 +00001064 else if (Context.isLexicalBlockFile()) {
1065 DILexicalBlockFile DBF = DILexicalBlockFile(Context);
1066 return processLexicalBlock(DILexicalBlock(DBF.getScope()));
1067 }
Devang Patelbeab41b2009-10-07 22:04:08 +00001068 else
Devang Patel2db49d72010-05-07 18:11:54 +00001069 return processSubprogram(DISubprogram(Context));
Devang Patelbeab41b2009-10-07 22:04:08 +00001070}
1071
Devang Patel98c65172009-07-30 18:25:15 +00001072/// processSubprogram - Process DISubprogram.
1073void DebugInfoFinder::processSubprogram(DISubprogram SP) {
Devang Pateld2f79a12009-07-28 19:55:13 +00001074 if (!addSubprogram(SP))
1075 return;
Manman Renfdd16bb2013-07-22 20:28:53 +00001076 processScope(SP.getContext());
Devang Patel98c65172009-07-30 18:25:15 +00001077 processType(SP.getType());
Manman Ren003f5512013-08-23 18:36:18 +00001078 DIArray TParams = SP.getTemplateParams();
1079 for (unsigned I = 0, E = TParams.getNumElements(); I != E; ++I) {
1080 DIDescriptor Element = TParams.getElement(I);
1081 if (Element.isTemplateTypeParameter()) {
1082 DITemplateTypeParameter TType(Element);
1083 processScope(TType.getContext());
1084 processType(TType.getType());
1085 } else if (Element.isTemplateValueParameter()) {
1086 DITemplateValueParameter TVal(Element);
1087 processScope(TVal.getContext());
1088 processType(TVal.getType());
1089 }
1090 }
Devang Pateld2f79a12009-07-28 19:55:13 +00001091}
1092
Devang Patelb4d31302009-07-31 18:18:52 +00001093/// processDeclare - Process DbgDeclareInst.
Eric Christopherc4639d62012-11-19 22:42:15 +00001094void DebugInfoFinder::processDeclare(const DbgDeclareInst *DDI) {
Devang Patel3c91b052010-03-08 20:52:55 +00001095 MDNode *N = dyn_cast<MDNode>(DDI->getVariable());
1096 if (!N) return;
1097
1098 DIDescriptor DV(N);
1099 if (!DV.isVariable())
Devang Patelb4d31302009-07-31 18:18:52 +00001100 return;
1101
Devang Patel2db49d72010-05-07 18:11:54 +00001102 if (!NodesSeen.insert(DV))
Devang Patelb4d31302009-07-31 18:18:52 +00001103 return;
Manman Ren7894ffd2013-07-23 23:10:00 +00001104 processScope(DIVariable(N).getContext());
Devang Patel3c91b052010-03-08 20:52:55 +00001105 processType(DIVariable(N).getType());
Devang Patelb4d31302009-07-31 18:18:52 +00001106}
1107
Manman Ren0e29eee2013-07-23 00:22:51 +00001108void DebugInfoFinder::processValue(const DbgValueInst *DVI) {
1109 MDNode *N = dyn_cast<MDNode>(DVI->getVariable());
1110 if (!N) return;
1111
1112 DIDescriptor DV(N);
1113 if (!DV.isVariable())
1114 return;
1115
1116 if (!NodesSeen.insert(DV))
1117 return;
Manman Ren504a7fb2013-07-24 17:10:09 +00001118 processScope(DIVariable(N).getContext());
Manman Ren0e29eee2013-07-23 00:22:51 +00001119 processType(DIVariable(N).getType());
1120}
1121
Devang Patel72bcdb62009-08-10 22:09:58 +00001122/// addType - Add type into Tys.
1123bool DebugInfoFinder::addType(DIType DT) {
Manman Ren2d69cc42013-07-27 01:26:08 +00001124 if (!DT)
Devang Patel72bcdb62009-08-10 22:09:58 +00001125 return false;
1126
Devang Patel2db49d72010-05-07 18:11:54 +00001127 if (!NodesSeen.insert(DT))
Devang Patel72bcdb62009-08-10 22:09:58 +00001128 return false;
1129
Devang Patel2db49d72010-05-07 18:11:54 +00001130 TYs.push_back(DT);
Devang Patel72bcdb62009-08-10 22:09:58 +00001131 return true;
1132}
1133
Devang Pateld2f79a12009-07-28 19:55:13 +00001134/// addCompileUnit - Add compile unit into CUs.
Devang Patel98c65172009-07-30 18:25:15 +00001135bool DebugInfoFinder::addCompileUnit(DICompileUnit CU) {
Manman Ren2d69cc42013-07-27 01:26:08 +00001136 if (!CU)
1137 return false;
Devang Patel2db49d72010-05-07 18:11:54 +00001138 if (!NodesSeen.insert(CU))
Devang Pateld2f79a12009-07-28 19:55:13 +00001139 return false;
1140
Devang Patel2db49d72010-05-07 18:11:54 +00001141 CUs.push_back(CU);
Devang Pateld2f79a12009-07-28 19:55:13 +00001142 return true;
1143}
Daniel Dunbarf612ff62009-09-19 20:40:05 +00001144
Devang Pateld2f79a12009-07-28 19:55:13 +00001145/// addGlobalVariable - Add global variable into GVs.
Devang Patel98c65172009-07-30 18:25:15 +00001146bool DebugInfoFinder::addGlobalVariable(DIGlobalVariable DIG) {
Manman Ren2d69cc42013-07-27 01:26:08 +00001147 if (!DIG)
Devang Pateld2f79a12009-07-28 19:55:13 +00001148 return false;
1149
Devang Patel2db49d72010-05-07 18:11:54 +00001150 if (!NodesSeen.insert(DIG))
Devang Pateld2f79a12009-07-28 19:55:13 +00001151 return false;
1152
Devang Patel2db49d72010-05-07 18:11:54 +00001153 GVs.push_back(DIG);
Devang Pateld2f79a12009-07-28 19:55:13 +00001154 return true;
1155}
1156
1157// addSubprogram - Add subprgoram into SPs.
Devang Patel98c65172009-07-30 18:25:15 +00001158bool DebugInfoFinder::addSubprogram(DISubprogram SP) {
Manman Ren2d69cc42013-07-27 01:26:08 +00001159 if (!SP)
Devang Pateld2f79a12009-07-28 19:55:13 +00001160 return false;
Daniel Dunbarf612ff62009-09-19 20:40:05 +00001161
Devang Patel2db49d72010-05-07 18:11:54 +00001162 if (!NodesSeen.insert(SP))
Devang Pateld2f79a12009-07-28 19:55:13 +00001163 return false;
1164
Devang Patel2db49d72010-05-07 18:11:54 +00001165 SPs.push_back(SP);
Devang Pateld2f79a12009-07-28 19:55:13 +00001166 return true;
1167}
1168
Manman Ren96ea0382013-07-20 00:38:46 +00001169bool DebugInfoFinder::addScope(DIScope Scope) {
1170 if (!Scope)
1171 return false;
Manman Renf40d5782013-08-06 19:38:43 +00001172 // FIXME: Ocaml binding generates a scope with no content, we treat it
1173 // as null for now.
1174 if (Scope->getNumOperands() == 0)
1175 return false;
Manman Ren96ea0382013-07-20 00:38:46 +00001176 if (!NodesSeen.insert(Scope))
1177 return false;
1178 Scopes.push_back(Scope);
1179 return true;
1180}
1181
Bill Wendlinge8778242012-06-26 23:22:18 +00001182//===----------------------------------------------------------------------===//
1183// DIDescriptor: dump routines for all descriptors.
1184//===----------------------------------------------------------------------===//
1185
1186/// dump - Print descriptor to dbgs() with a newline.
1187void DIDescriptor::dump() const {
1188 print(dbgs()); dbgs() << '\n';
1189}
1190
1191/// print - Print descriptor.
1192void DIDescriptor::print(raw_ostream &OS) const {
1193 if (!DbgNode) return;
1194
Bill Wendling97a75922012-06-28 02:17:58 +00001195 if (const char *Tag = dwarf::TagString(getTag()))
1196 OS << "[ " << Tag << " ]";
Bill Wendlinge8778242012-06-26 23:22:18 +00001197
1198 if (this->isSubrange()) {
1199 DISubrange(DbgNode).printInternal(OS);
Bill Wendlinge8778242012-06-26 23:22:18 +00001200 } else if (this->isCompileUnit()) {
1201 DICompileUnit(DbgNode).printInternal(OS);
1202 } else if (this->isFile()) {
1203 DIFile(DbgNode).printInternal(OS);
1204 } else if (this->isEnumerator()) {
1205 DIEnumerator(DbgNode).printInternal(OS);
1206 } else if (this->isBasicType()) {
1207 DIType(DbgNode).printInternal(OS);
1208 } else if (this->isDerivedType()) {
1209 DIDerivedType(DbgNode).printInternal(OS);
1210 } else if (this->isCompositeType()) {
1211 DICompositeType(DbgNode).printInternal(OS);
1212 } else if (this->isSubprogram()) {
1213 DISubprogram(DbgNode).printInternal(OS);
1214 } else if (this->isGlobalVariable()) {
1215 DIGlobalVariable(DbgNode).printInternal(OS);
1216 } else if (this->isVariable()) {
1217 DIVariable(DbgNode).printInternal(OS);
Bill Wendling2da1a162012-07-06 19:12:31 +00001218 } else if (this->isObjCProperty()) {
1219 DIObjCProperty(DbgNode).printInternal(OS);
David Blaikie1cd30fd2013-03-20 05:14:14 +00001220 } else if (this->isNameSpace()) {
1221 DINameSpace(DbgNode).printInternal(OS);
Bill Wendling625252f2012-07-06 23:06:16 +00001222 } else if (this->isScope()) {
1223 DIScope(DbgNode).printInternal(OS);
Bill Wendlinge8778242012-06-26 23:22:18 +00001224 }
1225}
1226
1227void DISubrange::printInternal(raw_ostream &OS) const {
Bill Wendling9493dae2012-12-04 21:34:03 +00001228 int64_t Count = getCount();
1229 if (Count != -1)
1230 OS << " [" << getLo() << ", " << Count - 1 << ']';
1231 else
Bill Wendling46defa52012-12-05 21:43:30 +00001232 OS << " [unbounded]";
Bill Wendlinge8778242012-06-26 23:22:18 +00001233}
1234
1235void DIScope::printInternal(raw_ostream &OS) const {
1236 OS << " [" << getDirectory() << "/" << getFilename() << ']';
1237}
1238
1239void DICompileUnit::printInternal(raw_ostream &OS) const {
1240 DIScope::printInternal(OS);
David Blaikie2ca02c62013-04-17 03:41:36 +00001241 OS << " [";
1242 unsigned Lang = getLanguage();
1243 if (const char *LangStr = dwarf::LanguageString(Lang))
1244 OS << LangStr;
1245 else
1246 (OS << "lang 0x").write_hex(Lang);
1247 OS << ']';
Bill Wendlinge8778242012-06-26 23:22:18 +00001248}
1249
1250void DIEnumerator::printInternal(raw_ostream &OS) const {
1251 OS << " [" << getName() << " :: " << getEnumValue() << ']';
1252}
1253
1254void DIType::printInternal(raw_ostream &OS) const {
1255 if (!DbgNode) return;
1256
1257 StringRef Res = getName();
1258 if (!Res.empty())
1259 OS << " [" << Res << "]";
1260
1261 // TODO: Print context?
1262
1263 OS << " [line " << getLineNumber()
1264 << ", size " << getSizeInBits()
1265 << ", align " << getAlignInBits()
1266 << ", offset " << getOffsetInBits();
1267 if (isBasicType())
Eric Christopher5f214ae2012-11-20 00:15:36 +00001268 if (const char *Enc =
Bill Wendlingfc1c70a2012-06-28 02:12:20 +00001269 dwarf::AttributeEncodingString(DIBasicType(DbgNode).getEncoding()))
1270 OS << ", enc " << Enc;
Bill Wendlinge8778242012-06-26 23:22:18 +00001271 OS << "]";
1272
1273 if (isPrivate())
1274 OS << " [private]";
1275 else if (isProtected())
1276 OS << " [protected]";
1277
David Blaikie0fecdfb2013-01-08 00:31:02 +00001278 if (isArtificial())
1279 OS << " [artificial]";
1280
Bill Wendlinge8778242012-06-26 23:22:18 +00001281 if (isForwardDecl())
David Blaikiee954d982013-06-21 03:41:54 +00001282 OS << " [decl]";
1283 else if (getTag() == dwarf::DW_TAG_structure_type ||
1284 getTag() == dwarf::DW_TAG_union_type ||
1285 getTag() == dwarf::DW_TAG_enumeration_type ||
1286 getTag() == dwarf::DW_TAG_class_type)
1287 OS << " [def]";
Eric Christopher9a1e0e22013-01-08 01:53:52 +00001288 if (isVector())
1289 OS << " [vector]";
Eric Christopher6b6061f2013-01-16 01:22:23 +00001290 if (isStaticMember())
1291 OS << " [static]";
Bill Wendlinge8778242012-06-26 23:22:18 +00001292}
1293
1294void DIDerivedType::printInternal(raw_ostream &OS) const {
1295 DIType::printInternal(OS);
1296 OS << " [from " << getTypeDerivedFrom().getName() << ']';
1297}
1298
1299void DICompositeType::printInternal(raw_ostream &OS) const {
1300 DIType::printInternal(OS);
1301 DIArray A = getTypeArray();
1302 OS << " [" << A.getNumElements() << " elements]";
1303}
1304
David Blaikie1cd30fd2013-03-20 05:14:14 +00001305void DINameSpace::printInternal(raw_ostream &OS) const {
1306 StringRef Name = getName();
1307 if (!Name.empty())
1308 OS << " [" << Name << ']';
1309
1310 OS << " [line " << getLineNumber() << ']';
1311}
1312
Bill Wendlinge8778242012-06-26 23:22:18 +00001313void DISubprogram::printInternal(raw_ostream &OS) const {
Bill Wendlinge8778242012-06-26 23:22:18 +00001314 // TODO : Print context
Bill Wendlinge8778242012-06-26 23:22:18 +00001315 OS << " [line " << getLineNumber() << ']';
1316
1317 if (isLocalToUnit())
1318 OS << " [local]";
1319
1320 if (isDefinition())
1321 OS << " [def]";
1322
1323 if (getScopeLineNumber() != getLineNumber())
1324 OS << " [scope " << getScopeLineNumber() << "]";
Bill Wendlingee17cee2012-07-06 23:43:12 +00001325
David Blaikiee302b6c2013-01-05 21:39:33 +00001326 if (isPrivate())
1327 OS << " [private]";
1328 else if (isProtected())
1329 OS << " [protected]";
1330
Bill Wendlingee17cee2012-07-06 23:43:12 +00001331 StringRef Res = getName();
1332 if (!Res.empty())
1333 OS << " [" << Res << ']';
Bill Wendlinge8778242012-06-26 23:22:18 +00001334}
1335
1336void DIGlobalVariable::printInternal(raw_ostream &OS) const {
1337 StringRef Res = getName();
1338 if (!Res.empty())
1339 OS << " [" << Res << ']';
1340
1341 OS << " [line " << getLineNumber() << ']';
1342
1343 // TODO : Print context
1344
1345 if (isLocalToUnit())
1346 OS << " [local]";
1347
1348 if (isDefinition())
1349 OS << " [def]";
1350}
1351
1352void DIVariable::printInternal(raw_ostream &OS) const {
1353 StringRef Res = getName();
1354 if (!Res.empty())
1355 OS << " [" << Res << ']';
1356
1357 OS << " [line " << getLineNumber() << ']';
1358}
1359
Bill Wendling2da1a162012-07-06 19:12:31 +00001360void DIObjCProperty::printInternal(raw_ostream &OS) const {
1361 StringRef Name = getObjCPropertyName();
1362 if (!Name.empty())
1363 OS << " [" << Name << ']';
1364
1365 OS << " [line " << getLineNumber()
1366 << ", properties " << getUnsignedField(6) << ']';
1367}
1368
Bill Wendlinge8778242012-06-26 23:22:18 +00001369static void printDebugLoc(DebugLoc DL, raw_ostream &CommentOS,
1370 const LLVMContext &Ctx) {
1371 if (!DL.isUnknown()) { // Print source line info.
1372 DIScope Scope(DL.getScope(Ctx));
Manman Renc7b61c62013-07-01 18:20:30 +00001373 assert(Scope.isScope() &&
1374 "Scope of a DebugLoc should be a DIScope.");
Bill Wendlinge8778242012-06-26 23:22:18 +00001375 // Omit the directory, because it's likely to be long and uninteresting.
Manman Renc7b61c62013-07-01 18:20:30 +00001376 CommentOS << Scope.getFilename();
Bill Wendlinge8778242012-06-26 23:22:18 +00001377 CommentOS << ':' << DL.getLine();
1378 if (DL.getCol() != 0)
1379 CommentOS << ':' << DL.getCol();
1380 DebugLoc InlinedAtDL = DebugLoc::getFromDILocation(DL.getInlinedAt(Ctx));
1381 if (!InlinedAtDL.isUnknown()) {
1382 CommentOS << " @[ ";
1383 printDebugLoc(InlinedAtDL, CommentOS, Ctx);
1384 CommentOS << " ]";
1385 }
1386 }
1387}
1388
1389void DIVariable::printExtendedName(raw_ostream &OS) const {
1390 const LLVMContext &Ctx = DbgNode->getContext();
1391 StringRef Res = getName();
1392 if (!Res.empty())
1393 OS << Res << "," << getLineNumber();
1394 if (MDNode *InlinedAt = getInlinedAt()) {
1395 DebugLoc InlinedAtDL = DebugLoc::getFromDILocation(InlinedAt);
1396 if (!InlinedAtDL.isUnknown()) {
1397 OS << " @[";
1398 printDebugLoc(InlinedAtDL, OS, Ctx);
1399 OS << "]";
1400 }
1401 }
1402}
Manman Renbc660712013-09-05 18:48:31 +00001403
Manman Renc5733052013-09-09 19:03:51 +00001404DIScopeRef::DIScopeRef(const Value *V) : Val(V) {
1405 assert(isScopeRef(V) && "DIScopeRef should be a MDString or MDNode");
Manman Renbc660712013-09-05 18:48:31 +00001406}
1407
1408/// Given a DITypeIdentifierMap, tries to find the corresponding
Manman Renc5733052013-09-09 19:03:51 +00001409/// DIScope for a DIScopeRef.
1410DIScope DIScopeRef::resolve(const DITypeIdentifierMap &Map) const {
1411 if (!Val)
1412 return DIScope();
Manman Renbc660712013-09-05 18:48:31 +00001413
Manman Renc5733052013-09-09 19:03:51 +00001414 if (const MDNode *MD = dyn_cast<MDNode>(Val))
1415 return DIScope(MD);
Manman Renbc660712013-09-05 18:48:31 +00001416
Manman Renc5733052013-09-09 19:03:51 +00001417 const MDString *MS = cast<MDString>(Val);
Manman Renbc660712013-09-05 18:48:31 +00001418 // Find the corresponding MDNode.
1419 DITypeIdentifierMap::const_iterator Iter = Map.find(MS);
1420 assert(Iter != Map.end() && "Identifier not in the type map?");
1421 assert(DIType(Iter->second).isType() &&
1422 "MDNode in DITypeIdentifierMap should be a DIType.");
Manman Renc5733052013-09-09 19:03:51 +00001423 return DIScope(Iter->second);
Manman Renbc660712013-09-05 18:48:31 +00001424}
1425
Manman Renc5733052013-09-09 19:03:51 +00001426/// Specialize getFieldAs to handle fields that are references to DIScopes.
Manman Renbc660712013-09-05 18:48:31 +00001427template <>
Manman Renc5733052013-09-09 19:03:51 +00001428DIScopeRef DIDescriptor::getFieldAs<DIScopeRef>(unsigned Elt) const {
1429 return DIScopeRef(getField(DbgNode, Elt));
Manman Renbc660712013-09-05 18:48:31 +00001430}