blob: 194811be903fe667b37b7fe48f78c425fa526263 [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
15#include "llvm/Analysis/DebugInfo.h"
Chris Lattner784b8502009-12-29 09:15:46 +000016#include "llvm/Target/TargetMachine.h" // FIXME: LAYERING VIOLATION!
Chris Lattnera45664f2008-11-10 02:56:27 +000017#include "llvm/Constants.h"
18#include "llvm/DerivedTypes.h"
19#include "llvm/Intrinsics.h"
Torok Edwin620f2802008-12-16 09:07:36 +000020#include "llvm/IntrinsicInst.h"
Chris Lattnera45664f2008-11-10 02:56:27 +000021#include "llvm/Instructions.h"
22#include "llvm/Module.h"
23#include "llvm/Analysis/ValueTracking.h"
Devang Patele4b27562009-08-28 23:24:31 +000024#include "llvm/ADT/SmallPtrSet.h"
David Greene0eb5b662009-12-23 19:45:49 +000025#include "llvm/Support/Debug.h"
Argyrios Kyrtzidis77eaa682009-05-03 08:50:41 +000026#include "llvm/Support/Dwarf.h"
Chris Lattnera81d29b2009-08-23 07:33:14 +000027#include "llvm/Support/raw_ostream.h"
Chris Lattnera45664f2008-11-10 02:56:27 +000028using namespace llvm;
Argyrios Kyrtzidis77eaa682009-05-03 08:50:41 +000029using namespace llvm::dwarf;
Chris Lattnera45664f2008-11-10 02:56:27 +000030
31//===----------------------------------------------------------------------===//
32// DIDescriptor
33//===----------------------------------------------------------------------===//
34
Devang Patel65dbc902009-11-25 17:36:49 +000035StringRef
Devang Patel5ccdd102009-09-29 18:40:58 +000036DIDescriptor::getStringField(unsigned Elt) const {
Devang Patele4b27562009-08-28 23:24:31 +000037 if (DbgNode == 0)
Devang Patel65dbc902009-11-25 17:36:49 +000038 return StringRef();
Chris Lattnera45664f2008-11-10 02:56:27 +000039
Chris Lattner5d0cacd2009-12-31 01:22:29 +000040 if (Elt < DbgNode->getNumOperands())
41 if (MDString *MDS = dyn_cast_or_null<MDString>(DbgNode->getOperand(Elt)))
Devang Patel65dbc902009-11-25 17:36:49 +000042 return MDS->getString();
Daniel Dunbarf612ff62009-09-19 20:40:05 +000043
Devang Patel65dbc902009-11-25 17:36:49 +000044 return StringRef();
Chris Lattnera45664f2008-11-10 02:56:27 +000045}
46
47uint64_t DIDescriptor::getUInt64Field(unsigned Elt) const {
Daniel Dunbarf612ff62009-09-19 20:40:05 +000048 if (DbgNode == 0)
Chris Lattnera45664f2008-11-10 02:56:27 +000049 return 0;
Bill Wendlingdc817b62009-05-14 18:26:15 +000050
Chris Lattner5d0cacd2009-12-31 01:22:29 +000051 if (Elt < DbgNode->getNumOperands())
52 if (ConstantInt *CI = dyn_cast<ConstantInt>(DbgNode->getOperand(Elt)))
Devang Patele4b27562009-08-28 23:24:31 +000053 return CI->getZExtValue();
Daniel Dunbarf612ff62009-09-19 20:40:05 +000054
Chris Lattnera45664f2008-11-10 02:56:27 +000055 return 0;
56}
57
Chris Lattnera45664f2008-11-10 02:56:27 +000058DIDescriptor DIDescriptor::getDescriptorField(unsigned Elt) const {
Daniel Dunbarf612ff62009-09-19 20:40:05 +000059 if (DbgNode == 0)
Chris Lattnera45664f2008-11-10 02:56:27 +000060 return DIDescriptor();
Bill Wendlingdc817b62009-05-14 18:26:15 +000061
Chris Lattner7a2f3e02010-03-31 05:53:47 +000062 if (Elt < DbgNode->getNumOperands())
Devang Patele9f8f5e2010-05-07 20:54:48 +000063 return DIDescriptor(dyn_cast_or_null<const MDNode>(DbgNode->getOperand(Elt)));
Devang Patele4b27562009-08-28 23:24:31 +000064 return DIDescriptor();
Chris Lattnera45664f2008-11-10 02:56:27 +000065}
66
67GlobalVariable *DIDescriptor::getGlobalVariableField(unsigned Elt) const {
Daniel Dunbarf612ff62009-09-19 20:40:05 +000068 if (DbgNode == 0)
Chris Lattnera45664f2008-11-10 02:56:27 +000069 return 0;
Bill Wendlingdc817b62009-05-14 18:26:15 +000070
Chris Lattner5d0cacd2009-12-31 01:22:29 +000071 if (Elt < DbgNode->getNumOperands())
72 return dyn_cast_or_null<GlobalVariable>(DbgNode->getOperand(Elt));
Devang Patele4b27562009-08-28 23:24:31 +000073 return 0;
Chris Lattnera45664f2008-11-10 02:56:27 +000074}
75
Chris Lattnerf0908a32009-12-31 03:02:08 +000076unsigned DIVariable::getNumAddrElements() const {
77 return DbgNode->getNumOperands()-6;
78}
79
80
Chris Lattnera45664f2008-11-10 02:56:27 +000081//===----------------------------------------------------------------------===//
Devang Patel6ceea332009-08-31 18:49:10 +000082// Predicates
Chris Lattnera45664f2008-11-10 02:56:27 +000083//===----------------------------------------------------------------------===//
84
Devang Patel6ceea332009-08-31 18:49:10 +000085/// isBasicType - Return true if the specified tag is legal for
86/// DIBasicType.
87bool DIDescriptor::isBasicType() const {
Devang Patel3c91b052010-03-08 20:52:55 +000088 return DbgNode && getTag() == dwarf::DW_TAG_base_type;
Torok Edwinb07fbd92008-12-13 08:25:29 +000089}
Chris Lattnera45664f2008-11-10 02:56:27 +000090
Devang Patel6ceea332009-08-31 18:49:10 +000091/// isDerivedType - Return true if the specified tag is legal for DIDerivedType.
92bool DIDescriptor::isDerivedType() const {
Devang Patel3c91b052010-03-08 20:52:55 +000093 if (!DbgNode) return false;
Chris Lattner099b7792009-12-29 09:22:47 +000094 switch (getTag()) {
Chris Lattnera45664f2008-11-10 02:56:27 +000095 case dwarf::DW_TAG_typedef:
96 case dwarf::DW_TAG_pointer_type:
97 case dwarf::DW_TAG_reference_type:
98 case dwarf::DW_TAG_const_type:
99 case dwarf::DW_TAG_volatile_type:
100 case dwarf::DW_TAG_restrict_type:
101 case dwarf::DW_TAG_member:
102 case dwarf::DW_TAG_inheritance:
103 return true;
104 default:
Devang Patele4b27562009-08-28 23:24:31 +0000105 // CompositeTypes are currently modelled as DerivedTypes.
Devang Patel6ceea332009-08-31 18:49:10 +0000106 return isCompositeType();
Chris Lattnera45664f2008-11-10 02:56:27 +0000107 }
108}
109
Chris Lattnera45664f2008-11-10 02:56:27 +0000110/// isCompositeType - Return true if the specified tag is legal for
111/// DICompositeType.
Devang Patel6ceea332009-08-31 18:49:10 +0000112bool DIDescriptor::isCompositeType() const {
Devang Patel3c91b052010-03-08 20:52:55 +0000113 if (!DbgNode) return false;
Chris Lattner099b7792009-12-29 09:22:47 +0000114 switch (getTag()) {
Chris Lattnera45664f2008-11-10 02:56:27 +0000115 case dwarf::DW_TAG_array_type:
116 case dwarf::DW_TAG_structure_type:
117 case dwarf::DW_TAG_union_type:
118 case dwarf::DW_TAG_enumeration_type:
119 case dwarf::DW_TAG_vector_type:
120 case dwarf::DW_TAG_subroutine_type:
Devang Patel25cb0d72009-03-25 03:52:06 +0000121 case dwarf::DW_TAG_class_type:
Chris Lattnera45664f2008-11-10 02:56:27 +0000122 return true;
123 default:
124 return false;
125 }
126}
127
Chris Lattnera45664f2008-11-10 02:56:27 +0000128/// isVariable - Return true if the specified tag is legal for DIVariable.
Devang Patel6ceea332009-08-31 18:49:10 +0000129bool DIDescriptor::isVariable() const {
Devang Patel3c91b052010-03-08 20:52:55 +0000130 if (!DbgNode) return false;
Chris Lattner099b7792009-12-29 09:22:47 +0000131 switch (getTag()) {
Chris Lattnera45664f2008-11-10 02:56:27 +0000132 case dwarf::DW_TAG_auto_variable:
133 case dwarf::DW_TAG_arg_variable:
134 case dwarf::DW_TAG_return_variable:
135 return true;
136 default:
137 return false;
138 }
139}
140
Devang Patelecbeb1a2009-09-30 22:34:41 +0000141/// isType - Return true if the specified tag is legal for DIType.
142bool DIDescriptor::isType() const {
143 return isBasicType() || isCompositeType() || isDerivedType();
144}
145
Devang Patel6ceea332009-08-31 18:49:10 +0000146/// isSubprogram - Return true if the specified tag is legal for
147/// DISubprogram.
148bool DIDescriptor::isSubprogram() const {
Devang Patel3c91b052010-03-08 20:52:55 +0000149 return DbgNode && getTag() == dwarf::DW_TAG_subprogram;
Devang Patel6ceea332009-08-31 18:49:10 +0000150}
151
152/// isGlobalVariable - Return true if the specified tag is legal for
153/// DIGlobalVariable.
154bool DIDescriptor::isGlobalVariable() const {
Devang Patel3c91b052010-03-08 20:52:55 +0000155 return DbgNode && getTag() == dwarf::DW_TAG_variable;
Devang Patel6ceea332009-08-31 18:49:10 +0000156}
157
Devang Patelecbeb1a2009-09-30 22:34:41 +0000158/// isGlobal - Return true if the specified tag is legal for DIGlobal.
159bool DIDescriptor::isGlobal() const {
160 return isGlobalVariable();
161}
162
Daniel Dunbarf612ff62009-09-19 20:40:05 +0000163/// isScope - Return true if the specified tag is one of the scope
Devang Patel43d98b32009-08-31 20:44:45 +0000164/// related tag.
165bool DIDescriptor::isScope() const {
Devang Patel3c91b052010-03-08 20:52:55 +0000166 if (!DbgNode) return false;
Chris Lattner099b7792009-12-29 09:22:47 +0000167 switch (getTag()) {
168 case dwarf::DW_TAG_compile_unit:
169 case dwarf::DW_TAG_lexical_block:
170 case dwarf::DW_TAG_subprogram:
171 case dwarf::DW_TAG_namespace:
172 return true;
173 default:
174 break;
Devang Patel43d98b32009-08-31 20:44:45 +0000175 }
176 return false;
177}
Devang Patel6ceea332009-08-31 18:49:10 +0000178
Devang Patelc9f322d2009-08-31 21:34:44 +0000179/// isCompileUnit - Return true if the specified tag is DW_TAG_compile_unit.
180bool DIDescriptor::isCompileUnit() const {
Devang Patel3c91b052010-03-08 20:52:55 +0000181 return DbgNode && getTag() == dwarf::DW_TAG_compile_unit;
Devang Patelc9f322d2009-08-31 21:34:44 +0000182}
183
Devang Patel7aa81892010-03-08 22:27:22 +0000184/// isFile - Return true if the specified tag is DW_TAG_file_type.
185bool DIDescriptor::isFile() const {
186 return DbgNode && getTag() == dwarf::DW_TAG_file_type;
187}
188
Devang Patel6404e4e2009-12-15 19:16:48 +0000189/// isNameSpace - Return true if the specified tag is DW_TAG_namespace.
190bool DIDescriptor::isNameSpace() const {
Devang Patel3c91b052010-03-08 20:52:55 +0000191 return DbgNode && getTag() == dwarf::DW_TAG_namespace;
Devang Patel6404e4e2009-12-15 19:16:48 +0000192}
193
Devang Patel5e005d82009-08-31 22:00:15 +0000194/// isLexicalBlock - Return true if the specified tag is DW_TAG_lexical_block.
195bool DIDescriptor::isLexicalBlock() const {
Devang Patel3c91b052010-03-08 20:52:55 +0000196 return DbgNode && getTag() == dwarf::DW_TAG_lexical_block;
Devang Patel5e005d82009-08-31 22:00:15 +0000197}
198
Devang Patelecbeb1a2009-09-30 22:34:41 +0000199/// isSubrange - Return true if the specified tag is DW_TAG_subrange_type.
200bool DIDescriptor::isSubrange() const {
Devang Patel3c91b052010-03-08 20:52:55 +0000201 return DbgNode && getTag() == dwarf::DW_TAG_subrange_type;
Devang Patelecbeb1a2009-09-30 22:34:41 +0000202}
203
204/// isEnumerator - Return true if the specified tag is DW_TAG_enumerator.
205bool DIDescriptor::isEnumerator() const {
Devang Patel3c91b052010-03-08 20:52:55 +0000206 return DbgNode && getTag() == dwarf::DW_TAG_enumerator;
Devang Patelecbeb1a2009-09-30 22:34:41 +0000207}
208
Devang Patel6ceea332009-08-31 18:49:10 +0000209//===----------------------------------------------------------------------===//
210// Simple Descriptor Constructors and other Methods
211//===----------------------------------------------------------------------===//
212
Devang Patele9f8f5e2010-05-07 20:54:48 +0000213DIType::DIType(const MDNode *N) : DIScope(N) {
Devang Patel6ceea332009-08-31 18:49:10 +0000214 if (!N) return;
215 if (!isBasicType() && !isDerivedType() && !isCompositeType()) {
216 DbgNode = 0;
217 }
218}
219
Devang Patel68afdc32009-01-05 18:33:01 +0000220unsigned DIArray::getNumElements() const {
Devang Patel3c91b052010-03-08 20:52:55 +0000221 if (!DbgNode)
222 return 0;
Chris Lattner5d0cacd2009-12-31 01:22:29 +0000223 return DbgNode->getNumOperands();
Devang Patel68afdc32009-01-05 18:33:01 +0000224}
Chris Lattnera45664f2008-11-10 02:56:27 +0000225
Devang Patelc4999d72009-07-22 18:23:44 +0000226/// replaceAllUsesWith - Replace all uses of debug info referenced by
227/// this descriptor. After this completes, the current debug info value
228/// is erased.
229void DIDerivedType::replaceAllUsesWith(DIDescriptor &D) {
Devang Patel3c91b052010-03-08 20:52:55 +0000230 if (!DbgNode)
Devang Patelc4999d72009-07-22 18:23:44 +0000231 return;
232
Daniel Dunbar48a097b2009-09-22 02:03:18 +0000233 // Since we use a TrackingVH for the node, its easy for clients to manufacture
234 // legitimate situations where they want to replaceAllUsesWith() on something
235 // which, due to uniquing, has merged with the source. We shield clients from
236 // this detail by allowing a value to be replaced with replaceAllUsesWith()
237 // itself.
Devang Pateled66bf52010-05-07 18:19:32 +0000238 if (DbgNode != D) {
Devang Patele9f8f5e2010-05-07 20:54:48 +0000239 MDNode *Node = const_cast<MDNode*>(DbgNode);
240 const MDNode *DN = D;
241 const Value *V = cast_or_null<Value>(DN);
242 Node->replaceAllUsesWith(const_cast<Value*>(V));
Chris Lattnerb76359e2009-12-31 01:05:46 +0000243 Node->destroy();
Daniel Dunbar48a097b2009-09-22 02:03:18 +0000244 }
Devang Patelc4999d72009-07-22 18:23:44 +0000245}
246
Devang Patelb79b5352009-01-19 23:21:49 +0000247/// Verify - Verify that a compile unit is well formed.
248bool DICompileUnit::Verify() const {
Devang Patel3c91b052010-03-08 20:52:55 +0000249 if (!DbgNode)
Devang Patelb79b5352009-01-19 23:21:49 +0000250 return false;
Devang Patel65dbc902009-11-25 17:36:49 +0000251 StringRef N = getFilename();
252 if (N.empty())
Bill Wendling0582ae92009-03-13 04:39:26 +0000253 return false;
Devang Patelb79b5352009-01-19 23:21:49 +0000254 // It is possible that directory and produce string is empty.
Bill Wendling0582ae92009-03-13 04:39:26 +0000255 return true;
Devang Patelb79b5352009-01-19 23:21:49 +0000256}
257
258/// Verify - Verify that a type descriptor is well formed.
259bool DIType::Verify() const {
Devang Patel3c91b052010-03-08 20:52:55 +0000260 if (!DbgNode)
Devang Patelb79b5352009-01-19 23:21:49 +0000261 return false;
Devang Patel3c91b052010-03-08 20:52:55 +0000262 if (!getContext().Verify())
Devang Patelb79b5352009-01-19 23:21:49 +0000263 return false;
264
265 DICompileUnit CU = getCompileUnit();
Devang Patel3c91b052010-03-08 20:52:55 +0000266 if (!CU.Verify())
Devang Patelb79b5352009-01-19 23:21:49 +0000267 return false;
268 return true;
269}
270
271/// Verify - Verify that a composite type descriptor is well formed.
272bool DICompositeType::Verify() const {
Devang Patel3c91b052010-03-08 20:52:55 +0000273 if (!DbgNode)
Devang Patelb79b5352009-01-19 23:21:49 +0000274 return false;
Devang Patel3c91b052010-03-08 20:52:55 +0000275 if (!getContext().Verify())
Devang Patelb79b5352009-01-19 23:21:49 +0000276 return false;
277
278 DICompileUnit CU = getCompileUnit();
Devang Patel3c91b052010-03-08 20:52:55 +0000279 if (!CU.Verify())
Devang Patelb79b5352009-01-19 23:21:49 +0000280 return false;
281 return true;
282}
283
284/// Verify - Verify that a subprogram descriptor is well formed.
285bool DISubprogram::Verify() const {
Devang Patel3c91b052010-03-08 20:52:55 +0000286 if (!DbgNode)
Devang Patelb79b5352009-01-19 23:21:49 +0000287 return false;
Daniel Dunbarf612ff62009-09-19 20:40:05 +0000288
Devang Patel3c91b052010-03-08 20:52:55 +0000289 if (!getContext().Verify())
Devang Patelb79b5352009-01-19 23:21:49 +0000290 return false;
291
292 DICompileUnit CU = getCompileUnit();
Daniel Dunbarf612ff62009-09-19 20:40:05 +0000293 if (!CU.Verify())
Devang Patelb79b5352009-01-19 23:21:49 +0000294 return false;
295
296 DICompositeType Ty = getType();
Devang Patel3c91b052010-03-08 20:52:55 +0000297 if (!Ty.Verify())
Devang Patelb79b5352009-01-19 23:21:49 +0000298 return false;
299 return true;
300}
301
302/// Verify - Verify that a global variable descriptor is well formed.
303bool DIGlobalVariable::Verify() const {
Devang Patel3c91b052010-03-08 20:52:55 +0000304 if (!DbgNode)
Devang Patelb79b5352009-01-19 23:21:49 +0000305 return false;
Daniel Dunbarf612ff62009-09-19 20:40:05 +0000306
Devang Patel65dbc902009-11-25 17:36:49 +0000307 if (getDisplayName().empty())
Devang Patel84c73e92009-11-06 17:58:12 +0000308 return false;
309
Devang Patel3c91b052010-03-08 20:52:55 +0000310 if (!getContext().Verify())
Devang Patelb79b5352009-01-19 23:21:49 +0000311 return false;
312
313 DICompileUnit CU = getCompileUnit();
Devang Patel3c91b052010-03-08 20:52:55 +0000314 if (!CU.Verify())
Devang Patelb79b5352009-01-19 23:21:49 +0000315 return false;
316
317 DIType Ty = getType();
318 if (!Ty.Verify())
319 return false;
320
321 if (!getGlobal())
322 return false;
323
324 return true;
325}
326
327/// Verify - Verify that a variable descriptor is well formed.
328bool DIVariable::Verify() const {
Devang Patel3c91b052010-03-08 20:52:55 +0000329 if (!DbgNode)
Devang Patelb79b5352009-01-19 23:21:49 +0000330 return false;
Daniel Dunbarf612ff62009-09-19 20:40:05 +0000331
Devang Patel3c91b052010-03-08 20:52:55 +0000332 if (!getContext().Verify())
Devang Patelb79b5352009-01-19 23:21:49 +0000333 return false;
334
Devang Patel62077af2010-05-07 21:42:24 +0000335 if (!getCompileUnit().Verify())
336 return false;
337
Devang Patelb79b5352009-01-19 23:21:49 +0000338 DIType Ty = getType();
339 if (!Ty.Verify())
340 return false;
341
Devang Patelb79b5352009-01-19 23:21:49 +0000342 return true;
343}
344
Devang Patel3c91b052010-03-08 20:52:55 +0000345/// Verify - Verify that a location descriptor is well formed.
346bool DILocation::Verify() const {
347 if (!DbgNode)
348 return false;
349
350 return DbgNode->getNumOperands() == 4;
351}
352
Devang Patel47e22652010-05-07 23:04:32 +0000353/// Verify - Verify that a namespace descriptor is well formed.
354bool DINameSpace::Verify() const {
355 if (!DbgNode)
356 return false;
357 if (getName().empty())
358 return false;
359 if (!getCompileUnit().Verify())
360 return false;
361 return true;
362}
363
Devang Patel36375ee2009-02-17 21:23:59 +0000364/// getOriginalTypeSize - If this type is derived from a base type then
365/// return base type size.
366uint64_t DIDerivedType::getOriginalTypeSize() const {
Devang Patel61ecbd12009-11-04 23:48:00 +0000367 unsigned Tag = getTag();
368 if (Tag == dwarf::DW_TAG_member || Tag == dwarf::DW_TAG_typedef ||
369 Tag == dwarf::DW_TAG_const_type || Tag == dwarf::DW_TAG_volatile_type ||
370 Tag == dwarf::DW_TAG_restrict_type) {
371 DIType BaseType = getTypeDerivedFrom();
Devang Patel5ebfa2d2009-11-06 18:24:05 +0000372 // If this type is not derived from any type then take conservative
373 // approach.
Devang Patel3c91b052010-03-08 20:52:55 +0000374 if (!BaseType.isValid())
Devang Patel5ebfa2d2009-11-06 18:24:05 +0000375 return getSizeInBits();
Devang Patel61ecbd12009-11-04 23:48:00 +0000376 if (BaseType.isDerivedType())
Devang Patel2db49d72010-05-07 18:11:54 +0000377 return DIDerivedType(BaseType).getOriginalTypeSize();
Devang Patel61ecbd12009-11-04 23:48:00 +0000378 else
379 return BaseType.getSizeInBits();
380 }
381
382 return getSizeInBits();
Devang Patel36375ee2009-02-17 21:23:59 +0000383}
Devang Patelb79b5352009-01-19 23:21:49 +0000384
Devang Patel719f6a92010-04-29 20:40:36 +0000385/// isInlinedFnArgument - Return trule if this variable provides debugging
386/// information for an inlined function arguments.
387bool DIVariable::isInlinedFnArgument(const Function *CurFn) {
388 assert(CurFn && "Invalid function");
389 if (!getContext().isSubprogram())
390 return false;
391 // This variable is not inlined function argument if its scope
392 // does not describe current function.
Devang Patel2db49d72010-05-07 18:11:54 +0000393 return !(DISubprogram(getContext()).describes(CurFn));
Devang Patel719f6a92010-04-29 20:40:36 +0000394}
395
Devang Patelaf5b6bb2009-04-15 00:06:07 +0000396/// describes - Return true if this subprogram provides debugging
397/// information for the function F.
398bool DISubprogram::describes(const Function *F) {
Chris Lattner099b7792009-12-29 09:22:47 +0000399 assert(F && "Invalid function");
Devang Patel65dbc902009-11-25 17:36:49 +0000400 StringRef Name = getLinkageName();
401 if (Name.empty())
Devang Patel5ccdd102009-09-29 18:40:58 +0000402 Name = getName();
Devang Patel65dbc902009-11-25 17:36:49 +0000403 if (F->getName() == Name)
Devang Patelaf5b6bb2009-04-15 00:06:07 +0000404 return true;
405 return false;
406}
407
Devang Patelccff8122010-04-30 19:38:23 +0000408unsigned DISubprogram::isOptimized() const {
409 assert (DbgNode && "Invalid subprogram descriptor!");
410 if (DbgNode->getNumOperands() == 16)
411 return getUnsignedField(15);
412 return 0;
413}
414
Devang Patel65dbc902009-11-25 17:36:49 +0000415StringRef DIScope::getFilename() const {
Devang Patel77bf2952010-03-08 22:02:50 +0000416 if (!DbgNode)
417 return StringRef();
Devang Patelecbeb1a2009-09-30 22:34:41 +0000418 if (isLexicalBlock())
419 return DILexicalBlock(DbgNode).getFilename();
Chris Lattner099b7792009-12-29 09:22:47 +0000420 if (isSubprogram())
Devang Patelecbeb1a2009-09-30 22:34:41 +0000421 return DISubprogram(DbgNode).getFilename();
Chris Lattner099b7792009-12-29 09:22:47 +0000422 if (isCompileUnit())
Devang Patelecbeb1a2009-09-30 22:34:41 +0000423 return DICompileUnit(DbgNode).getFilename();
Chris Lattner099b7792009-12-29 09:22:47 +0000424 if (isNameSpace())
Devang Patel6404e4e2009-12-15 19:16:48 +0000425 return DINameSpace(DbgNode).getFilename();
Devang Patel77bf2952010-03-08 22:02:50 +0000426 if (isType())
427 return DIType(DbgNode).getFilename();
Devang Patel7aa81892010-03-08 22:27:22 +0000428 if (isFile())
429 return DIFile(DbgNode).getFilename();
Chris Lattner099b7792009-12-29 09:22:47 +0000430 assert(0 && "Invalid DIScope!");
Devang Patel65dbc902009-11-25 17:36:49 +0000431 return StringRef();
Devang Patelecbeb1a2009-09-30 22:34:41 +0000432}
433
Devang Patel65dbc902009-11-25 17:36:49 +0000434StringRef DIScope::getDirectory() const {
Devang Patel77bf2952010-03-08 22:02:50 +0000435 if (!DbgNode)
436 return StringRef();
Devang Patelecbeb1a2009-09-30 22:34:41 +0000437 if (isLexicalBlock())
438 return DILexicalBlock(DbgNode).getDirectory();
Chris Lattner099b7792009-12-29 09:22:47 +0000439 if (isSubprogram())
Devang Patelecbeb1a2009-09-30 22:34:41 +0000440 return DISubprogram(DbgNode).getDirectory();
Chris Lattner099b7792009-12-29 09:22:47 +0000441 if (isCompileUnit())
Devang Patelecbeb1a2009-09-30 22:34:41 +0000442 return DICompileUnit(DbgNode).getDirectory();
Chris Lattner099b7792009-12-29 09:22:47 +0000443 if (isNameSpace())
Devang Patel6404e4e2009-12-15 19:16:48 +0000444 return DINameSpace(DbgNode).getDirectory();
Devang Patel77bf2952010-03-08 22:02:50 +0000445 if (isType())
446 return DIType(DbgNode).getDirectory();
Devang Patel7aa81892010-03-08 22:27:22 +0000447 if (isFile())
448 return DIFile(DbgNode).getDirectory();
Chris Lattner099b7792009-12-29 09:22:47 +0000449 assert(0 && "Invalid DIScope!");
Devang Patel65dbc902009-11-25 17:36:49 +0000450 return StringRef();
Devang Patelecbeb1a2009-09-30 22:34:41 +0000451}
452
Chris Lattnera45664f2008-11-10 02:56:27 +0000453//===----------------------------------------------------------------------===//
Devang Patel7136a652009-07-01 22:10:23 +0000454// DIDescriptor: dump routines for all descriptors.
455//===----------------------------------------------------------------------===//
456
457
Dan Gohman50404362010-05-07 15:30:29 +0000458/// print - Print descriptor.
459void DIDescriptor::print(raw_ostream &OS) const {
460 OS << "[" << dwarf::TagString(getTag()) << "] ";
461 OS.write_hex((intptr_t) &*DbgNode) << ']';
Devang Patel7136a652009-07-01 22:10:23 +0000462}
463
Dan Gohman50404362010-05-07 15:30:29 +0000464/// print - Print compile unit.
465void DICompileUnit::print(raw_ostream &OS) const {
Devang Patel7136a652009-07-01 22:10:23 +0000466 if (getLanguage())
Dan Gohman50404362010-05-07 15:30:29 +0000467 OS << " [" << dwarf::LanguageString(getLanguage()) << "] ";
Devang Patel7136a652009-07-01 22:10:23 +0000468
Dan Gohmanfaa19c32010-05-10 20:07:44 +0000469 OS << " [" << getDirectory() << "/" << getFilename() << "]";
Devang Patel7136a652009-07-01 22:10:23 +0000470}
471
Dan Gohman50404362010-05-07 15:30:29 +0000472/// print - Print type.
473void DIType::print(raw_ostream &OS) const {
Devang Patel3c91b052010-03-08 20:52:55 +0000474 if (!DbgNode) return;
Devang Patel7136a652009-07-01 22:10:23 +0000475
Devang Patel65dbc902009-11-25 17:36:49 +0000476 StringRef Res = getName();
477 if (!Res.empty())
Dan Gohman50404362010-05-07 15:30:29 +0000478 OS << " [" << Res << "] ";
Devang Patel7136a652009-07-01 22:10:23 +0000479
480 unsigned Tag = getTag();
Dan Gohman50404362010-05-07 15:30:29 +0000481 OS << " [" << dwarf::TagString(Tag) << "] ";
Devang Patel7136a652009-07-01 22:10:23 +0000482
483 // TODO : Print context
Dan Gohmanc014d092010-05-07 16:17:22 +0000484 getCompileUnit().print(OS);
Dan Gohman50404362010-05-07 15:30:29 +0000485 OS << " ["
Dan Gohman9a7063e2010-05-07 16:39:27 +0000486 << "line " << getLineNumber() << ", "
487 << getSizeInBits() << " bits, "
488 << getAlignInBits() << " bit alignment, "
489 << getOffsetInBits() << " bit offset"
Chris Lattnera81d29b2009-08-23 07:33:14 +0000490 << "] ";
Devang Patel7136a652009-07-01 22:10:23 +0000491
Daniel Dunbarf612ff62009-09-19 20:40:05 +0000492 if (isPrivate())
Dan Gohman50404362010-05-07 15:30:29 +0000493 OS << " [private] ";
Devang Patel7136a652009-07-01 22:10:23 +0000494 else if (isProtected())
Dan Gohman50404362010-05-07 15:30:29 +0000495 OS << " [protected] ";
Devang Patel7136a652009-07-01 22:10:23 +0000496
497 if (isForwardDecl())
Dan Gohman50404362010-05-07 15:30:29 +0000498 OS << " [fwd] ";
Devang Patel7136a652009-07-01 22:10:23 +0000499
Devang Patel6ceea332009-08-31 18:49:10 +0000500 if (isBasicType())
Dan Gohmanc014d092010-05-07 16:17:22 +0000501 DIBasicType(DbgNode).print(OS);
Devang Patel6ceea332009-08-31 18:49:10 +0000502 else if (isDerivedType())
Dan Gohmanc014d092010-05-07 16:17:22 +0000503 DIDerivedType(DbgNode).print(OS);
Devang Patel6ceea332009-08-31 18:49:10 +0000504 else if (isCompositeType())
Dan Gohmanc014d092010-05-07 16:17:22 +0000505 DICompositeType(DbgNode).print(OS);
Devang Patel7136a652009-07-01 22:10:23 +0000506 else {
Dan Gohman50404362010-05-07 15:30:29 +0000507 OS << "Invalid DIType\n";
Devang Patel7136a652009-07-01 22:10:23 +0000508 return;
509 }
510
Dan Gohman50404362010-05-07 15:30:29 +0000511 OS << "\n";
Devang Patel7136a652009-07-01 22:10:23 +0000512}
513
Dan Gohman50404362010-05-07 15:30:29 +0000514/// print - Print basic type.
515void DIBasicType::print(raw_ostream &OS) const {
516 OS << " [" << dwarf::AttributeEncodingString(getEncoding()) << "] ";
Devang Patel7136a652009-07-01 22:10:23 +0000517}
518
Dan Gohman50404362010-05-07 15:30:29 +0000519/// print - Print derived type.
520void DIDerivedType::print(raw_ostream &OS) const {
Dan Gohmanc014d092010-05-07 16:17:22 +0000521 OS << "\n\t Derived From: "; getTypeDerivedFrom().print(OS);
Devang Patel7136a652009-07-01 22:10:23 +0000522}
523
Dan Gohman50404362010-05-07 15:30:29 +0000524/// print - Print composite type.
525void DICompositeType::print(raw_ostream &OS) const {
Devang Patel7136a652009-07-01 22:10:23 +0000526 DIArray A = getTypeArray();
Dan Gohman50404362010-05-07 15:30:29 +0000527 OS << " [" << A.getNumElements() << " elements]";
Devang Patel7136a652009-07-01 22:10:23 +0000528}
529
Dan Gohman50404362010-05-07 15:30:29 +0000530/// print - Print subprogram.
531void DISubprogram::print(raw_ostream &OS) const {
Devang Patel65dbc902009-11-25 17:36:49 +0000532 StringRef Res = getName();
533 if (!Res.empty())
Dan Gohman50404362010-05-07 15:30:29 +0000534 OS << " [" << Res << "] ";
Devang Patel82dfc0c2009-08-31 22:47:13 +0000535
536 unsigned Tag = getTag();
Dan Gohman50404362010-05-07 15:30:29 +0000537 OS << " [" << dwarf::TagString(Tag) << "] ";
Devang Patel82dfc0c2009-08-31 22:47:13 +0000538
539 // TODO : Print context
Dan Gohmanc014d092010-05-07 16:17:22 +0000540 getCompileUnit().print(OS);
Dan Gohman50404362010-05-07 15:30:29 +0000541 OS << " [" << getLineNumber() << "] ";
Devang Patel82dfc0c2009-08-31 22:47:13 +0000542
543 if (isLocalToUnit())
Dan Gohman50404362010-05-07 15:30:29 +0000544 OS << " [local] ";
Devang Patel82dfc0c2009-08-31 22:47:13 +0000545
546 if (isDefinition())
Dan Gohman50404362010-05-07 15:30:29 +0000547 OS << " [def] ";
Devang Patel82dfc0c2009-08-31 22:47:13 +0000548
Dan Gohman50404362010-05-07 15:30:29 +0000549 OS << "\n";
550}
551
552/// print - Print global variable.
553void DIGlobalVariable::print(raw_ostream &OS) const {
554 OS << " [";
Devang Patela49d8772010-05-07 23:19:07 +0000555 StringRef Res = getName();
556 if (!Res.empty())
557 OS << " [" << Res << "] ";
558
559 unsigned Tag = getTag();
560 OS << " [" << dwarf::TagString(Tag) << "] ";
561
562 // TODO : Print context
563 getCompileUnit().print(OS);
564 OS << " [" << getLineNumber() << "] ";
565
566 if (isLocalToUnit())
567 OS << " [local] ";
568
569 if (isDefinition())
570 OS << " [def] ";
571
572 if (isGlobalVariable())
573 DIGlobalVariable(DbgNode).print(OS);
574 OS << "]\n";
Dan Gohman50404362010-05-07 15:30:29 +0000575}
576
577/// print - Print variable.
578void DIVariable::print(raw_ostream &OS) const {
579 StringRef Res = getName();
580 if (!Res.empty())
581 OS << " [" << Res << "] ";
582
Dan Gohmanc014d092010-05-07 16:17:22 +0000583 getCompileUnit().print(OS);
Dan Gohman50404362010-05-07 15:30:29 +0000584 OS << " [" << getLineNumber() << "] ";
Dan Gohmanc014d092010-05-07 16:17:22 +0000585 getType().print(OS);
Dan Gohman50404362010-05-07 15:30:29 +0000586 OS << "\n";
587
588 // FIXME: Dump complex addresses
589}
590
591/// dump - Print descriptor to dbgs() with a newline.
592void DIDescriptor::dump() const {
593 print(dbgs()); dbgs() << '\n';
594}
595
596/// dump - Print compile unit to dbgs() with a newline.
597void DICompileUnit::dump() const {
598 print(dbgs()); dbgs() << '\n';
599}
600
601/// dump - Print type to dbgs() with a newline.
602void DIType::dump() const {
603 print(dbgs()); dbgs() << '\n';
604}
605
606/// dump - Print basic type to dbgs() with a newline.
607void DIBasicType::dump() const {
608 print(dbgs()); dbgs() << '\n';
609}
610
611/// dump - Print derived type to dbgs() with a newline.
612void DIDerivedType::dump() const {
613 print(dbgs()); dbgs() << '\n';
614}
615
616/// dump - Print composite type to dbgs() with a newline.
617void DICompositeType::dump() const {
618 print(dbgs()); dbgs() << '\n';
619}
620
Dan Gohman50404362010-05-07 15:30:29 +0000621/// dump - Print subprogram to dbgs() with a newline.
622void DISubprogram::dump() const {
623 print(dbgs()); dbgs() << '\n';
Devang Patel7136a652009-07-01 22:10:23 +0000624}
625
626/// dump - Print global variable.
627void DIGlobalVariable::dump() const {
Dan Gohman50404362010-05-07 15:30:29 +0000628 print(dbgs()); dbgs() << '\n';
Devang Patel7136a652009-07-01 22:10:23 +0000629}
630
631/// dump - Print variable.
632void DIVariable::dump() const {
Dan Gohman50404362010-05-07 15:30:29 +0000633 print(dbgs()); dbgs() << '\n';
Devang Patel7136a652009-07-01 22:10:23 +0000634}
635
636//===----------------------------------------------------------------------===//
Chris Lattnera45664f2008-11-10 02:56:27 +0000637// DIFactory: Basic Helpers
638//===----------------------------------------------------------------------===//
639
Bill Wendlingdc817b62009-05-14 18:26:15 +0000640DIFactory::DIFactory(Module &m)
Victor Hernandez06203122010-01-23 00:03:28 +0000641 : M(m), VMContext(M.getContext()), DeclareFn(0), ValueFn(0) {}
Chris Lattner497a7a82008-11-10 04:10:34 +0000642
Chris Lattnera45664f2008-11-10 02:56:27 +0000643Constant *DIFactory::GetTagConstant(unsigned TAG) {
Devang Patel6906ba52009-01-20 19:22:03 +0000644 assert((TAG & LLVMDebugVersionMask) == 0 &&
Chris Lattnera45664f2008-11-10 02:56:27 +0000645 "Tag too large for debug encoding!");
Owen Anderson1d0be152009-08-13 21:58:54 +0000646 return ConstantInt::get(Type::getInt32Ty(VMContext), TAG | LLVMDebugVersion);
Chris Lattnera45664f2008-11-10 02:56:27 +0000647}
648
Chris Lattnera45664f2008-11-10 02:56:27 +0000649//===----------------------------------------------------------------------===//
650// DIFactory: Primary Constructors
651//===----------------------------------------------------------------------===//
652
Daniel Dunbarf612ff62009-09-19 20:40:05 +0000653/// GetOrCreateArray - Create an descriptor for an array of descriptors.
Chris Lattnera45664f2008-11-10 02:56:27 +0000654/// This implicitly uniques the arrays created.
655DIArray DIFactory::GetOrCreateArray(DIDescriptor *Tys, unsigned NumTys) {
Devang Patele4b27562009-08-28 23:24:31 +0000656 SmallVector<Value*, 16> Elts;
Daniel Dunbarf612ff62009-09-19 20:40:05 +0000657
Devang Patele4b27562009-08-28 23:24:31 +0000658 if (NumTys == 0)
659 Elts.push_back(llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)));
660 else
661 for (unsigned i = 0; i != NumTys; ++i)
Devang Patel2db49d72010-05-07 18:11:54 +0000662 Elts.push_back(Tys[i]);
Devang Patel82459882009-08-26 05:01:18 +0000663
Devang Patele4b27562009-08-28 23:24:31 +0000664 return DIArray(MDNode::get(VMContext,Elts.data(), Elts.size()));
Chris Lattnera45664f2008-11-10 02:56:27 +0000665}
666
667/// GetOrCreateSubrange - Create a descriptor for a value range. This
668/// implicitly uniques the values returned.
669DISubrange DIFactory::GetOrCreateSubrange(int64_t Lo, int64_t Hi) {
Devang Patele4b27562009-08-28 23:24:31 +0000670 Value *Elts[] = {
Chris Lattnera45664f2008-11-10 02:56:27 +0000671 GetTagConstant(dwarf::DW_TAG_subrange_type),
Owen Anderson1d0be152009-08-13 21:58:54 +0000672 ConstantInt::get(Type::getInt64Ty(VMContext), Lo),
673 ConstantInt::get(Type::getInt64Ty(VMContext), Hi)
Chris Lattnera45664f2008-11-10 02:56:27 +0000674 };
Daniel Dunbarf612ff62009-09-19 20:40:05 +0000675
Devang Patele4b27562009-08-28 23:24:31 +0000676 return DISubrange(MDNode::get(VMContext, &Elts[0], 3));
Chris Lattnera45664f2008-11-10 02:56:27 +0000677}
678
679
680
681/// CreateCompileUnit - Create a new descriptor for the specified compile
682/// unit. Note that this does not unique compile units within the module.
683DICompileUnit DIFactory::CreateCompileUnit(unsigned LangID,
Devang Patel65dbc902009-11-25 17:36:49 +0000684 StringRef Filename,
685 StringRef Directory,
686 StringRef Producer,
Devang Pateldd9db662009-01-30 18:20:31 +0000687 bool isMain,
Devang Patel3b64c6b2009-01-23 22:33:47 +0000688 bool isOptimized,
Devang Patel65dbc902009-11-25 17:36:49 +0000689 StringRef Flags,
Devang Patel13319ce2009-02-17 22:43:44 +0000690 unsigned RunTimeVer) {
Devang Patele4b27562009-08-28 23:24:31 +0000691 Value *Elts[] = {
Chris Lattnera45664f2008-11-10 02:56:27 +0000692 GetTagConstant(dwarf::DW_TAG_compile_unit),
Devang Patele4b27562009-08-28 23:24:31 +0000693 llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
Owen Anderson1d0be152009-08-13 21:58:54 +0000694 ConstantInt::get(Type::getInt32Ty(VMContext), LangID),
Devang Patele4b27562009-08-28 23:24:31 +0000695 MDString::get(VMContext, Filename),
696 MDString::get(VMContext, Directory),
697 MDString::get(VMContext, Producer),
Owen Anderson1d0be152009-08-13 21:58:54 +0000698 ConstantInt::get(Type::getInt1Ty(VMContext), isMain),
699 ConstantInt::get(Type::getInt1Ty(VMContext), isOptimized),
Devang Patele4b27562009-08-28 23:24:31 +0000700 MDString::get(VMContext, Flags),
Owen Anderson1d0be152009-08-13 21:58:54 +0000701 ConstantInt::get(Type::getInt32Ty(VMContext), RunTimeVer)
Chris Lattnera45664f2008-11-10 02:56:27 +0000702 };
Devang Patele4b27562009-08-28 23:24:31 +0000703
704 return DICompileUnit(MDNode::get(VMContext, &Elts[0], 10));
Chris Lattnera45664f2008-11-10 02:56:27 +0000705}
706
Devang Patel7aa81892010-03-08 22:27:22 +0000707/// CreateFile - Create a new descriptor for the specified file.
708DIFile DIFactory::CreateFile(StringRef Filename,
709 StringRef Directory,
710 DICompileUnit CU) {
711 Value *Elts[] = {
712 GetTagConstant(dwarf::DW_TAG_file_type),
713 MDString::get(VMContext, Filename),
714 MDString::get(VMContext, Directory),
Devang Patel2db49d72010-05-07 18:11:54 +0000715 CU
Devang Patel7aa81892010-03-08 22:27:22 +0000716 };
717
718 return DIFile(MDNode::get(VMContext, &Elts[0], 4));
719}
720
Chris Lattnera45664f2008-11-10 02:56:27 +0000721/// CreateEnumerator - Create a single enumerator value.
Devang Patel65dbc902009-11-25 17:36:49 +0000722DIEnumerator DIFactory::CreateEnumerator(StringRef Name, uint64_t Val){
Devang Patele4b27562009-08-28 23:24:31 +0000723 Value *Elts[] = {
Chris Lattnera45664f2008-11-10 02:56:27 +0000724 GetTagConstant(dwarf::DW_TAG_enumerator),
Devang Patele4b27562009-08-28 23:24:31 +0000725 MDString::get(VMContext, Name),
Owen Anderson1d0be152009-08-13 21:58:54 +0000726 ConstantInt::get(Type::getInt64Ty(VMContext), Val)
Chris Lattnera45664f2008-11-10 02:56:27 +0000727 };
Devang Patele4b27562009-08-28 23:24:31 +0000728 return DIEnumerator(MDNode::get(VMContext, &Elts[0], 3));
Chris Lattnera45664f2008-11-10 02:56:27 +0000729}
730
731
732/// CreateBasicType - Create a basic type like int, float, etc.
733DIBasicType DIFactory::CreateBasicType(DIDescriptor Context,
Devang Patel65dbc902009-11-25 17:36:49 +0000734 StringRef Name,
Devang Patel4b945502010-03-09 00:44:10 +0000735 DIFile F,
Chris Lattnera45664f2008-11-10 02:56:27 +0000736 unsigned LineNumber,
737 uint64_t SizeInBits,
738 uint64_t AlignInBits,
739 uint64_t OffsetInBits, unsigned Flags,
Devang Pateldd9db662009-01-30 18:20:31 +0000740 unsigned Encoding) {
Devang Patele4b27562009-08-28 23:24:31 +0000741 Value *Elts[] = {
Chris Lattnera45664f2008-11-10 02:56:27 +0000742 GetTagConstant(dwarf::DW_TAG_base_type),
Devang Patel2db49d72010-05-07 18:11:54 +0000743 Context,
Devang Patele4b27562009-08-28 23:24:31 +0000744 MDString::get(VMContext, Name),
Devang Patel2db49d72010-05-07 18:11:54 +0000745 F,
Owen Anderson1d0be152009-08-13 21:58:54 +0000746 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
747 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
748 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
749 ConstantInt::get(Type::getInt64Ty(VMContext), OffsetInBits),
750 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
751 ConstantInt::get(Type::getInt32Ty(VMContext), Encoding)
Chris Lattnera45664f2008-11-10 02:56:27 +0000752 };
Devang Patele4b27562009-08-28 23:24:31 +0000753 return DIBasicType(MDNode::get(VMContext, &Elts[0], 10));
Chris Lattnera45664f2008-11-10 02:56:27 +0000754}
755
Devang Patelac16d442009-10-26 16:54:35 +0000756
757/// CreateBasicType - Create a basic type like int, float, etc.
758DIBasicType DIFactory::CreateBasicTypeEx(DIDescriptor Context,
Devang Patel65dbc902009-11-25 17:36:49 +0000759 StringRef Name,
Devang Patel4b945502010-03-09 00:44:10 +0000760 DIFile F,
Devang Patelac16d442009-10-26 16:54:35 +0000761 unsigned LineNumber,
762 Constant *SizeInBits,
763 Constant *AlignInBits,
764 Constant *OffsetInBits, unsigned Flags,
765 unsigned Encoding) {
766 Value *Elts[] = {
767 GetTagConstant(dwarf::DW_TAG_base_type),
Devang Patel2db49d72010-05-07 18:11:54 +0000768 Context,
Devang Patelac16d442009-10-26 16:54:35 +0000769 MDString::get(VMContext, Name),
Devang Patel2db49d72010-05-07 18:11:54 +0000770 F,
Devang Patelac16d442009-10-26 16:54:35 +0000771 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
772 SizeInBits,
773 AlignInBits,
774 OffsetInBits,
775 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
776 ConstantInt::get(Type::getInt32Ty(VMContext), Encoding)
777 };
778 return DIBasicType(MDNode::get(VMContext, &Elts[0], 10));
779}
780
Devang Patelb4645642010-02-06 01:02:37 +0000781/// CreateArtificialType - Create a new DIType with "artificial" flag set.
782DIType DIFactory::CreateArtificialType(DIType Ty) {
783 if (Ty.isArtificial())
784 return Ty;
785
786 SmallVector<Value *, 9> Elts;
Devang Patel2db49d72010-05-07 18:11:54 +0000787 MDNode *N = Ty;
Devang Patelb4645642010-02-06 01:02:37 +0000788 assert (N && "Unexpected input DIType!");
789 for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i) {
790 if (Value *V = N->getOperand(i))
791 Elts.push_back(V);
792 else
793 Elts.push_back(Constant::getNullValue(Type::getInt32Ty(VMContext)));
794 }
795
796 unsigned CurFlags = Ty.getFlags();
797 CurFlags = CurFlags | DIType::FlagArtificial;
798
799 // Flags are stored at this slot.
800 Elts[8] = ConstantInt::get(Type::getInt32Ty(VMContext), CurFlags);
801
802 return DIType(MDNode::get(VMContext, Elts.data(), Elts.size()));
803}
Devang Patelac16d442009-10-26 16:54:35 +0000804
Chris Lattnera45664f2008-11-10 02:56:27 +0000805/// CreateDerivedType - Create a derived type like const qualified type,
806/// pointer, typedef, etc.
807DIDerivedType DIFactory::CreateDerivedType(unsigned Tag,
808 DIDescriptor Context,
Devang Patel65dbc902009-11-25 17:36:49 +0000809 StringRef Name,
Devang Patel4b945502010-03-09 00:44:10 +0000810 DIFile F,
Chris Lattnera45664f2008-11-10 02:56:27 +0000811 unsigned LineNumber,
812 uint64_t SizeInBits,
813 uint64_t AlignInBits,
814 uint64_t OffsetInBits,
815 unsigned Flags,
Devang Pateldd9db662009-01-30 18:20:31 +0000816 DIType DerivedFrom) {
Devang Patele4b27562009-08-28 23:24:31 +0000817 Value *Elts[] = {
Chris Lattnera45664f2008-11-10 02:56:27 +0000818 GetTagConstant(Tag),
Devang Patel2db49d72010-05-07 18:11:54 +0000819 Context,
Devang Patele4b27562009-08-28 23:24:31 +0000820 MDString::get(VMContext, Name),
Devang Patel2db49d72010-05-07 18:11:54 +0000821 F,
Owen Anderson1d0be152009-08-13 21:58:54 +0000822 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
823 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
824 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
825 ConstantInt::get(Type::getInt64Ty(VMContext), OffsetInBits),
826 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
Devang Patel2db49d72010-05-07 18:11:54 +0000827 DerivedFrom,
Chris Lattnera45664f2008-11-10 02:56:27 +0000828 };
Devang Patele4b27562009-08-28 23:24:31 +0000829 return DIDerivedType(MDNode::get(VMContext, &Elts[0], 10));
Chris Lattnera45664f2008-11-10 02:56:27 +0000830}
831
Devang Patelac16d442009-10-26 16:54:35 +0000832
833/// CreateDerivedType - Create a derived type like const qualified type,
834/// pointer, typedef, etc.
835DIDerivedType DIFactory::CreateDerivedTypeEx(unsigned Tag,
836 DIDescriptor Context,
Devang Patel65dbc902009-11-25 17:36:49 +0000837 StringRef Name,
Devang Patel4b945502010-03-09 00:44:10 +0000838 DIFile F,
Devang Patelac16d442009-10-26 16:54:35 +0000839 unsigned LineNumber,
840 Constant *SizeInBits,
841 Constant *AlignInBits,
842 Constant *OffsetInBits,
843 unsigned Flags,
844 DIType DerivedFrom) {
845 Value *Elts[] = {
846 GetTagConstant(Tag),
Devang Patel2db49d72010-05-07 18:11:54 +0000847 Context,
Devang Patelac16d442009-10-26 16:54:35 +0000848 MDString::get(VMContext, Name),
Devang Patel2db49d72010-05-07 18:11:54 +0000849 F,
Devang Patelac16d442009-10-26 16:54:35 +0000850 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
851 SizeInBits,
852 AlignInBits,
853 OffsetInBits,
854 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
Devang Patel2db49d72010-05-07 18:11:54 +0000855 DerivedFrom,
Devang Patelac16d442009-10-26 16:54:35 +0000856 };
857 return DIDerivedType(MDNode::get(VMContext, &Elts[0], 10));
858}
859
860
Chris Lattnera45664f2008-11-10 02:56:27 +0000861/// CreateCompositeType - Create a composite type like array, struct, etc.
862DICompositeType DIFactory::CreateCompositeType(unsigned Tag,
863 DIDescriptor Context,
Devang Patel65dbc902009-11-25 17:36:49 +0000864 StringRef Name,
Devang Patel4b945502010-03-09 00:44:10 +0000865 DIFile F,
Chris Lattnera45664f2008-11-10 02:56:27 +0000866 unsigned LineNumber,
867 uint64_t SizeInBits,
868 uint64_t AlignInBits,
869 uint64_t OffsetInBits,
870 unsigned Flags,
871 DIType DerivedFrom,
Devang Patel13319ce2009-02-17 22:43:44 +0000872 DIArray Elements,
Devang Patel0fd7f9d2010-01-26 21:14:59 +0000873 unsigned RuntimeLang,
874 MDNode *ContainingType) {
Owen Andersone277fed2009-07-07 16:31:25 +0000875
Devang Patele4b27562009-08-28 23:24:31 +0000876 Value *Elts[] = {
Chris Lattnera45664f2008-11-10 02:56:27 +0000877 GetTagConstant(Tag),
Devang Patel2db49d72010-05-07 18:11:54 +0000878 Context,
Devang Patele4b27562009-08-28 23:24:31 +0000879 MDString::get(VMContext, Name),
Devang Patel2db49d72010-05-07 18:11:54 +0000880 F,
Owen Anderson1d0be152009-08-13 21:58:54 +0000881 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
882 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
883 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
884 ConstantInt::get(Type::getInt64Ty(VMContext), OffsetInBits),
885 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
Devang Patel2db49d72010-05-07 18:11:54 +0000886 DerivedFrom,
887 Elements,
Devang Patel0fd7f9d2010-01-26 21:14:59 +0000888 ConstantInt::get(Type::getInt32Ty(VMContext), RuntimeLang),
889 ContainingType
Chris Lattnera45664f2008-11-10 02:56:27 +0000890 };
Devang Patel0fd7f9d2010-01-26 21:14:59 +0000891 return DICompositeType(MDNode::get(VMContext, &Elts[0], 13));
Chris Lattnera45664f2008-11-10 02:56:27 +0000892}
893
894
Devang Patelac16d442009-10-26 16:54:35 +0000895/// CreateCompositeType - Create a composite type like array, struct, etc.
896DICompositeType DIFactory::CreateCompositeTypeEx(unsigned Tag,
897 DIDescriptor Context,
Devang Patel65dbc902009-11-25 17:36:49 +0000898 StringRef Name,
Devang Patel4b945502010-03-09 00:44:10 +0000899 DIFile F,
Devang Patelac16d442009-10-26 16:54:35 +0000900 unsigned LineNumber,
901 Constant *SizeInBits,
902 Constant *AlignInBits,
903 Constant *OffsetInBits,
904 unsigned Flags,
905 DIType DerivedFrom,
906 DIArray Elements,
907 unsigned RuntimeLang) {
908
909 Value *Elts[] = {
910 GetTagConstant(Tag),
Devang Patel2db49d72010-05-07 18:11:54 +0000911 Context,
Devang Patelac16d442009-10-26 16:54:35 +0000912 MDString::get(VMContext, Name),
Devang Patel2db49d72010-05-07 18:11:54 +0000913 F,
Devang Patelac16d442009-10-26 16:54:35 +0000914 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
915 SizeInBits,
916 AlignInBits,
917 OffsetInBits,
918 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
Devang Patel2db49d72010-05-07 18:11:54 +0000919 DerivedFrom,
920 Elements,
Devang Patelac16d442009-10-26 16:54:35 +0000921 ConstantInt::get(Type::getInt32Ty(VMContext), RuntimeLang)
922 };
923 return DICompositeType(MDNode::get(VMContext, &Elts[0], 12));
924}
925
926
Chris Lattnera45664f2008-11-10 02:56:27 +0000927/// CreateSubprogram - Create a new descriptor for the specified subprogram.
928/// See comments in DISubprogram for descriptions of these fields. This
929/// method does not unique the generated descriptors.
Daniel Dunbarf612ff62009-09-19 20:40:05 +0000930DISubprogram DIFactory::CreateSubprogram(DIDescriptor Context,
Devang Patel65dbc902009-11-25 17:36:49 +0000931 StringRef Name,
932 StringRef DisplayName,
933 StringRef LinkageName,
Devang Patel4b945502010-03-09 00:44:10 +0000934 DIFile F,
Devang Patel2e369932010-01-23 00:26:28 +0000935 unsigned LineNo, DIType Ty,
Chris Lattnera45664f2008-11-10 02:56:27 +0000936 bool isLocalToUnit,
Devang Patel5d11eb02009-12-03 19:11:07 +0000937 bool isDefinition,
938 unsigned VK, unsigned VIndex,
Devang Patel4e0d19d2010-02-03 19:57:19 +0000939 DIType ContainingType,
Devang Patelccff8122010-04-30 19:38:23 +0000940 bool isArtificial,
941 bool isOptimized) {
Devang Patel854967e2008-12-17 22:39:29 +0000942
Devang Patele4b27562009-08-28 23:24:31 +0000943 Value *Elts[] = {
Chris Lattnera45664f2008-11-10 02:56:27 +0000944 GetTagConstant(dwarf::DW_TAG_subprogram),
Devang Patele4b27562009-08-28 23:24:31 +0000945 llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
Devang Patel2db49d72010-05-07 18:11:54 +0000946 Context,
Devang Patele4b27562009-08-28 23:24:31 +0000947 MDString::get(VMContext, Name),
948 MDString::get(VMContext, DisplayName),
949 MDString::get(VMContext, LinkageName),
Devang Patel2db49d72010-05-07 18:11:54 +0000950 F,
Owen Anderson1d0be152009-08-13 21:58:54 +0000951 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
Devang Patel2db49d72010-05-07 18:11:54 +0000952 Ty,
Owen Anderson1d0be152009-08-13 21:58:54 +0000953 ConstantInt::get(Type::getInt1Ty(VMContext), isLocalToUnit),
Devang Patel5d11eb02009-12-03 19:11:07 +0000954 ConstantInt::get(Type::getInt1Ty(VMContext), isDefinition),
955 ConstantInt::get(Type::getInt32Ty(VMContext), (unsigned)VK),
956 ConstantInt::get(Type::getInt32Ty(VMContext), VIndex),
Devang Patel2db49d72010-05-07 18:11:54 +0000957 ContainingType,
Devang Patelccff8122010-04-30 19:38:23 +0000958 ConstantInt::get(Type::getInt1Ty(VMContext), isArtificial),
959 ConstantInt::get(Type::getInt1Ty(VMContext), isOptimized)
Chris Lattnera45664f2008-11-10 02:56:27 +0000960 };
Devang Patelccff8122010-04-30 19:38:23 +0000961 return DISubprogram(MDNode::get(VMContext, &Elts[0], 16));
Chris Lattnera45664f2008-11-10 02:56:27 +0000962}
963
Devang Patele3a18de2009-12-01 23:09:02 +0000964/// CreateSubprogramDefinition - Create new subprogram descriptor for the
965/// given declaration.
966DISubprogram DIFactory::CreateSubprogramDefinition(DISubprogram &SPDeclaration) {
967 if (SPDeclaration.isDefinition())
Devang Patel2db49d72010-05-07 18:11:54 +0000968 return DISubprogram(SPDeclaration);
Devang Patele3a18de2009-12-01 23:09:02 +0000969
Devang Patel2db49d72010-05-07 18:11:54 +0000970 MDNode *DeclNode = SPDeclaration;
Devang Patele3a18de2009-12-01 23:09:02 +0000971 Value *Elts[] = {
972 GetTagConstant(dwarf::DW_TAG_subprogram),
973 llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
Chris Lattner5d0cacd2009-12-31 01:22:29 +0000974 DeclNode->getOperand(2), // Context
975 DeclNode->getOperand(3), // Name
976 DeclNode->getOperand(4), // DisplayName
977 DeclNode->getOperand(5), // LinkageName
978 DeclNode->getOperand(6), // CompileUnit
979 DeclNode->getOperand(7), // LineNo
980 DeclNode->getOperand(8), // Type
981 DeclNode->getOperand(9), // isLocalToUnit
Devang Patel5d11eb02009-12-03 19:11:07 +0000982 ConstantInt::get(Type::getInt1Ty(VMContext), true),
Chris Lattner5d0cacd2009-12-31 01:22:29 +0000983 DeclNode->getOperand(11), // Virtuality
984 DeclNode->getOperand(12), // VIndex
Devang Patel4e0d19d2010-02-03 19:57:19 +0000985 DeclNode->getOperand(13), // Containting Type
Devang Patelccff8122010-04-30 19:38:23 +0000986 DeclNode->getOperand(14), // isArtificial
987 DeclNode->getOperand(15) // isOptimized
Devang Patele3a18de2009-12-01 23:09:02 +0000988 };
Devang Patelccff8122010-04-30 19:38:23 +0000989 return DISubprogram(MDNode::get(VMContext, &Elts[0], 16));
Devang Patele3a18de2009-12-01 23:09:02 +0000990}
991
Chris Lattnera45664f2008-11-10 02:56:27 +0000992/// CreateGlobalVariable - Create a new descriptor for the specified global.
993DIGlobalVariable
Devang Patel65dbc902009-11-25 17:36:49 +0000994DIFactory::CreateGlobalVariable(DIDescriptor Context, StringRef Name,
995 StringRef DisplayName,
996 StringRef LinkageName,
Devang Patel4b945502010-03-09 00:44:10 +0000997 DIFile F,
Devang Patel2e369932010-01-23 00:26:28 +0000998 unsigned LineNo, DIType Ty,bool isLocalToUnit,
Devang Pateldd9db662009-01-30 18:20:31 +0000999 bool isDefinition, llvm::GlobalVariable *Val) {
Daniel Dunbarf612ff62009-09-19 20:40:05 +00001000 Value *Elts[] = {
Chris Lattnera45664f2008-11-10 02:56:27 +00001001 GetTagConstant(dwarf::DW_TAG_variable),
Devang Patele4b27562009-08-28 23:24:31 +00001002 llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
Devang Patel2db49d72010-05-07 18:11:54 +00001003 Context,
Devang Patele4b27562009-08-28 23:24:31 +00001004 MDString::get(VMContext, Name),
1005 MDString::get(VMContext, DisplayName),
1006 MDString::get(VMContext, LinkageName),
Devang Patel2db49d72010-05-07 18:11:54 +00001007 F,
Owen Anderson1d0be152009-08-13 21:58:54 +00001008 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
Devang Patel2db49d72010-05-07 18:11:54 +00001009 Ty,
Owen Anderson1d0be152009-08-13 21:58:54 +00001010 ConstantInt::get(Type::getInt1Ty(VMContext), isLocalToUnit),
1011 ConstantInt::get(Type::getInt1Ty(VMContext), isDefinition),
Devang Patele4b27562009-08-28 23:24:31 +00001012 Val
Chris Lattnera45664f2008-11-10 02:56:27 +00001013 };
Devang Patele4b27562009-08-28 23:24:31 +00001014
1015 Value *const *Vs = &Elts[0];
1016 MDNode *Node = MDNode::get(VMContext,Vs, 12);
1017
1018 // Create a named metadata so that we do not lose this mdnode.
1019 NamedMDNode *NMD = M.getOrInsertNamedMetadata("llvm.dbg.gv");
Chris Lattner5d0cacd2009-12-31 01:22:29 +00001020 NMD->addOperand(Node);
Devang Patele4b27562009-08-28 23:24:31 +00001021
1022 return DIGlobalVariable(Node);
Chris Lattnera45664f2008-11-10 02:56:27 +00001023}
1024
1025
1026/// CreateVariable - Create a new descriptor for the specified variable.
1027DIVariable DIFactory::CreateVariable(unsigned Tag, DIDescriptor Context,
Devang Patel65dbc902009-11-25 17:36:49 +00001028 StringRef Name,
Devang Patel4b945502010-03-09 00:44:10 +00001029 DIFile F,
1030 unsigned LineNo,
Devang Patel98e1cac2010-05-14 21:01:35 +00001031 DIType Ty, bool OptimizedBuild) {
Devang Patele4b27562009-08-28 23:24:31 +00001032 Value *Elts[] = {
Chris Lattnera45664f2008-11-10 02:56:27 +00001033 GetTagConstant(Tag),
Devang Patel2db49d72010-05-07 18:11:54 +00001034 Context,
Devang Patele4b27562009-08-28 23:24:31 +00001035 MDString::get(VMContext, Name),
Devang Patel2db49d72010-05-07 18:11:54 +00001036 F,
Owen Anderson1d0be152009-08-13 21:58:54 +00001037 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
Devang Patel2db49d72010-05-07 18:11:54 +00001038 Ty,
Chris Lattnera45664f2008-11-10 02:56:27 +00001039 };
Devang Patel98e1cac2010-05-14 21:01:35 +00001040 MDNode *Node = MDNode::get(VMContext, &Elts[0], 6);
1041 if (OptimizedBuild) {
1042 NamedMDNode *NMD = M.getOrInsertNamedMetadata("llvm.dbg.lv");
1043 NMD->addOperand(Node);
1044 }
1045 return DIVariable(Node);
Chris Lattnera45664f2008-11-10 02:56:27 +00001046}
1047
1048
Mike Stump3e4c9bd2009-09-30 00:08:22 +00001049/// CreateComplexVariable - Create a new descriptor for the specified variable
1050/// which has a complex address expression for its address.
1051DIVariable DIFactory::CreateComplexVariable(unsigned Tag, DIDescriptor Context,
1052 const std::string &Name,
Devang Patel4b945502010-03-09 00:44:10 +00001053 DIFile F,
Mike Stump3e4c9bd2009-09-30 00:08:22 +00001054 unsigned LineNo,
Devang Patel2e369932010-01-23 00:26:28 +00001055 DIType Ty,
1056 SmallVector<Value *, 9> &addr) {
Mike Stump3e4c9bd2009-09-30 00:08:22 +00001057 SmallVector<Value *, 9> Elts;
1058 Elts.push_back(GetTagConstant(Tag));
Devang Patel2db49d72010-05-07 18:11:54 +00001059 Elts.push_back(Context);
Mike Stump3e4c9bd2009-09-30 00:08:22 +00001060 Elts.push_back(MDString::get(VMContext, Name));
Devang Patel2db49d72010-05-07 18:11:54 +00001061 Elts.push_back(F);
Mike Stump3e4c9bd2009-09-30 00:08:22 +00001062 Elts.push_back(ConstantInt::get(Type::getInt32Ty(VMContext), LineNo));
Devang Patel2db49d72010-05-07 18:11:54 +00001063 Elts.push_back(Ty);
Mike Stump3e4c9bd2009-09-30 00:08:22 +00001064 Elts.insert(Elts.end(), addr.begin(), addr.end());
1065
1066 return DIVariable(MDNode::get(VMContext, &Elts[0], 6+addr.size()));
1067}
1068
1069
Chris Lattnera45664f2008-11-10 02:56:27 +00001070/// CreateBlock - This creates a descriptor for a lexical block with the
Owen Anderson99035272009-07-07 17:12:53 +00001071/// specified parent VMContext.
Devang Patel3d821aa2010-02-16 21:39:34 +00001072DILexicalBlock DIFactory::CreateLexicalBlock(DIDescriptor Context,
1073 unsigned LineNo, unsigned Col) {
Devang Patele4b27562009-08-28 23:24:31 +00001074 Value *Elts[] = {
Chris Lattnera45664f2008-11-10 02:56:27 +00001075 GetTagConstant(dwarf::DW_TAG_lexical_block),
Devang Patel2db49d72010-05-07 18:11:54 +00001076 Context,
Devang Patel3d821aa2010-02-16 21:39:34 +00001077 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
1078 ConstantInt::get(Type::getInt32Ty(VMContext), Col)
Chris Lattnera45664f2008-11-10 02:56:27 +00001079 };
Devang Patel3d821aa2010-02-16 21:39:34 +00001080 return DILexicalBlock(MDNode::get(VMContext, &Elts[0], 4));
Chris Lattnera45664f2008-11-10 02:56:27 +00001081}
1082
Devang Patel6404e4e2009-12-15 19:16:48 +00001083/// CreateNameSpace - This creates new descriptor for a namespace
1084/// with the specified parent context.
1085DINameSpace DIFactory::CreateNameSpace(DIDescriptor Context, StringRef Name,
Devang Patel4b945502010-03-09 00:44:10 +00001086 DIFile F,
Devang Patel6404e4e2009-12-15 19:16:48 +00001087 unsigned LineNo) {
1088 Value *Elts[] = {
1089 GetTagConstant(dwarf::DW_TAG_namespace),
Devang Patel2db49d72010-05-07 18:11:54 +00001090 Context,
Devang Patel6404e4e2009-12-15 19:16:48 +00001091 MDString::get(VMContext, Name),
Devang Patel2db49d72010-05-07 18:11:54 +00001092 F,
Devang Patel6404e4e2009-12-15 19:16:48 +00001093 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo)
1094 };
1095 return DINameSpace(MDNode::get(VMContext, &Elts[0], 5));
1096}
1097
Devang Patelf98d8fe2009-09-01 01:14:15 +00001098/// CreateLocation - Creates a debug info location.
Daniel Dunbarf612ff62009-09-19 20:40:05 +00001099DILocation DIFactory::CreateLocation(unsigned LineNo, unsigned ColumnNo,
Daniel Dunbara279bc32009-09-20 02:20:51 +00001100 DIScope S, DILocation OrigLoc) {
Devang Patelf98d8fe2009-09-01 01:14:15 +00001101 Value *Elts[] = {
1102 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
1103 ConstantInt::get(Type::getInt32Ty(VMContext), ColumnNo),
Devang Patel2db49d72010-05-07 18:11:54 +00001104 S,
1105 OrigLoc,
Devang Patelf98d8fe2009-09-01 01:14:15 +00001106 };
1107 return DILocation(MDNode::get(VMContext, &Elts[0], 4));
1108}
1109
Devang Patele54a5e82009-11-23 19:11:20 +00001110/// CreateLocation - Creates a debug info location.
1111DILocation DIFactory::CreateLocation(unsigned LineNo, unsigned ColumnNo,
1112 DIScope S, MDNode *OrigLoc) {
1113 Value *Elts[] = {
1114 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
1115 ConstantInt::get(Type::getInt32Ty(VMContext), ColumnNo),
Devang Patel2db49d72010-05-07 18:11:54 +00001116 S,
Devang Patele54a5e82009-11-23 19:11:20 +00001117 OrigLoc
1118 };
1119 return DILocation(MDNode::get(VMContext, &Elts[0], 4));
1120}
Chris Lattnera45664f2008-11-10 02:56:27 +00001121
1122//===----------------------------------------------------------------------===//
1123// DIFactory: Routines for inserting code into a function
1124//===----------------------------------------------------------------------===//
1125
Chris Lattnera45664f2008-11-10 02:56:27 +00001126/// InsertDeclare - Insert a new llvm.dbg.declare intrinsic call.
Devang Patel6daf99b2009-11-10 22:05:35 +00001127Instruction *DIFactory::InsertDeclare(Value *Storage, DIVariable D,
Victor Hernandez5b7e48b2010-01-11 07:45:19 +00001128 Instruction *InsertBefore) {
Victor Hernandez4cf292a2010-01-26 02:07:38 +00001129 assert(Storage && "no storage passed to dbg.declare");
Devang Patele9f8f5e2010-05-07 20:54:48 +00001130 assert(D.Verify() && "empty DIVariable passed to dbg.declare");
Chris Lattnera45664f2008-11-10 02:56:27 +00001131 if (!DeclareFn)
Bill Wendlingdc817b62009-05-14 18:26:15 +00001132 DeclareFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_declare);
1133
Victor Hernandez756462b2010-01-18 20:42:09 +00001134 Value *Args[] = { MDNode::get(Storage->getContext(), &Storage, 1),
Devang Patel2db49d72010-05-07 18:11:54 +00001135 D };
Devang Patel6daf99b2009-11-10 22:05:35 +00001136 return CallInst::Create(DeclareFn, Args, Args+2, "", InsertBefore);
Mike Stumpe4250392009-10-01 22:08:58 +00001137}
1138
1139/// InsertDeclare - Insert a new llvm.dbg.declare intrinsic call.
Devang Patel6daf99b2009-11-10 22:05:35 +00001140Instruction *DIFactory::InsertDeclare(Value *Storage, DIVariable D,
Victor Hernandez5b7e48b2010-01-11 07:45:19 +00001141 BasicBlock *InsertAtEnd) {
Victor Hernandez4cf292a2010-01-26 02:07:38 +00001142 assert(Storage && "no storage passed to dbg.declare");
Devang Patele9f8f5e2010-05-07 20:54:48 +00001143 assert(D.Verify() && "invalid DIVariable passed to dbg.declare");
Mike Stumpe4250392009-10-01 22:08:58 +00001144 if (!DeclareFn)
1145 DeclareFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_declare);
1146
Victor Hernandez756462b2010-01-18 20:42:09 +00001147 Value *Args[] = { MDNode::get(Storage->getContext(), &Storage, 1),
Devang Patel2db49d72010-05-07 18:11:54 +00001148 D };
Devang Patel27a53de2010-01-29 18:30:57 +00001149
1150 // If this block already has a terminator then insert this intrinsic
1151 // before the terminator.
1152 if (TerminatorInst *T = InsertAtEnd->getTerminator())
1153 return CallInst::Create(DeclareFn, Args, Args+2, "", T);
1154 else
1155 return CallInst::Create(DeclareFn, Args, Args+2, "", InsertAtEnd);}
Torok Edwin620f2802008-12-16 09:07:36 +00001156
Victor Hernandezc59b3352009-12-07 21:54:43 +00001157/// InsertDbgValueIntrinsic - Insert a new llvm.dbg.value intrinsic call.
Victor Hernandez5b7e48b2010-01-11 07:45:19 +00001158Instruction *DIFactory::InsertDbgValueIntrinsic(Value *V, uint64_t Offset,
Victor Hernandezc59b3352009-12-07 21:54:43 +00001159 DIVariable D,
1160 Instruction *InsertBefore) {
Victor Hernandez2f9dac72009-12-07 19:36:34 +00001161 assert(V && "no value passed to dbg.value");
Devang Patele9f8f5e2010-05-07 20:54:48 +00001162 assert(D.Verify() && "invalid DIVariable passed to dbg.value");
Victor Hernandez2f9dac72009-12-07 19:36:34 +00001163 if (!ValueFn)
1164 ValueFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_value);
1165
Victor Hernandezc8b7cd02010-01-20 05:44:11 +00001166 Value *Args[] = { MDNode::get(V->getContext(), &V, 1),
Victor Hernandez5b7e48b2010-01-11 07:45:19 +00001167 ConstantInt::get(Type::getInt64Ty(V->getContext()), Offset),
Devang Patel2db49d72010-05-07 18:11:54 +00001168 D };
Victor Hernandez2f9dac72009-12-07 19:36:34 +00001169 return CallInst::Create(ValueFn, Args, Args+3, "", InsertBefore);
1170}
1171
Victor Hernandezc59b3352009-12-07 21:54:43 +00001172/// InsertDbgValueIntrinsic - Insert a new llvm.dbg.value intrinsic call.
Victor Hernandez5b7e48b2010-01-11 07:45:19 +00001173Instruction *DIFactory::InsertDbgValueIntrinsic(Value *V, uint64_t Offset,
Victor Hernandezc59b3352009-12-07 21:54:43 +00001174 DIVariable D,
1175 BasicBlock *InsertAtEnd) {
Victor Hernandez2f9dac72009-12-07 19:36:34 +00001176 assert(V && "no value passed to dbg.value");
Devang Patele9f8f5e2010-05-07 20:54:48 +00001177 assert(D.Verify() && "invalid DIVariable passed to dbg.value");
Victor Hernandez2f9dac72009-12-07 19:36:34 +00001178 if (!ValueFn)
1179 ValueFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_value);
1180
Victor Hernandezc8b7cd02010-01-20 05:44:11 +00001181 Value *Args[] = { MDNode::get(V->getContext(), &V, 1),
Victor Hernandez5b7e48b2010-01-11 07:45:19 +00001182 ConstantInt::get(Type::getInt64Ty(V->getContext()), Offset),
Devang Patel2db49d72010-05-07 18:11:54 +00001183 D };
Victor Hernandez2f9dac72009-12-07 19:36:34 +00001184 return CallInst::Create(ValueFn, Args, Args+3, "", InsertAtEnd);
1185}
Devang Patele4b27562009-08-28 23:24:31 +00001186
Devang Pateld2f79a12009-07-28 19:55:13 +00001187//===----------------------------------------------------------------------===//
Devang Patel98c65172009-07-30 18:25:15 +00001188// DebugInfoFinder implementations.
Devang Pateld2f79a12009-07-28 19:55:13 +00001189//===----------------------------------------------------------------------===//
1190
Devang Patel98c65172009-07-30 18:25:15 +00001191/// processModule - Process entire module and collect debug info.
1192void DebugInfoFinder::processModule(Module &M) {
Devang Pateld2f79a12009-07-28 19:55:13 +00001193 for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
1194 for (Function::iterator FI = (*I).begin(), FE = (*I).end(); FI != FE; ++FI)
1195 for (BasicBlock::iterator BI = (*FI).begin(), BE = (*FI).end(); BI != BE;
1196 ++BI) {
Devang Patel01c5ff62010-05-04 01:05:02 +00001197 if (DbgDeclareInst *DDI = dyn_cast<DbgDeclareInst>(BI))
Devang Patelb4d31302009-07-31 18:18:52 +00001198 processDeclare(DDI);
Chris Lattner28a9bf62010-04-02 20:44:29 +00001199
1200 DebugLoc Loc = BI->getDebugLoc();
1201 if (Loc.isUnknown())
1202 continue;
1203
1204 LLVMContext &Ctx = BI->getContext();
1205 DIDescriptor Scope(Loc.getScope(Ctx));
1206
1207 if (Scope.isCompileUnit())
Devang Patel2db49d72010-05-07 18:11:54 +00001208 addCompileUnit(DICompileUnit(Scope));
Chris Lattner28a9bf62010-04-02 20:44:29 +00001209 else if (Scope.isSubprogram())
Devang Patel2db49d72010-05-07 18:11:54 +00001210 processSubprogram(DISubprogram(Scope));
Chris Lattner28a9bf62010-04-02 20:44:29 +00001211 else if (Scope.isLexicalBlock())
Devang Patel2db49d72010-05-07 18:11:54 +00001212 processLexicalBlock(DILexicalBlock(Scope));
Chris Lattner28a9bf62010-04-02 20:44:29 +00001213
1214 if (MDNode *IA = Loc.getInlinedAt(Ctx))
1215 processLocation(DILocation(IA));
Devang Pateld2f79a12009-07-28 19:55:13 +00001216 }
Devang Patele4b27562009-08-28 23:24:31 +00001217
1218 NamedMDNode *NMD = M.getNamedMetadata("llvm.dbg.gv");
1219 if (!NMD)
1220 return;
1221
Chris Lattner5d0cacd2009-12-31 01:22:29 +00001222 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
1223 DIGlobalVariable DIG(cast<MDNode>(NMD->getOperand(i)));
Devang Pateld2f79a12009-07-28 19:55:13 +00001224 if (addGlobalVariable(DIG)) {
1225 addCompileUnit(DIG.getCompileUnit());
Devang Patel98c65172009-07-30 18:25:15 +00001226 processType(DIG.getType());
Devang Pateld2f79a12009-07-28 19:55:13 +00001227 }
1228 }
1229}
Daniel Dunbarf612ff62009-09-19 20:40:05 +00001230
Devang Patel6daf99b2009-11-10 22:05:35 +00001231/// processLocation - Process DILocation.
1232void DebugInfoFinder::processLocation(DILocation Loc) {
Devang Patel3c91b052010-03-08 20:52:55 +00001233 if (!Loc.Verify()) return;
Devang Patel2db49d72010-05-07 18:11:54 +00001234 DIDescriptor S(Loc.getScope());
Devang Patel6daf99b2009-11-10 22:05:35 +00001235 if (S.isCompileUnit())
Devang Patel2db49d72010-05-07 18:11:54 +00001236 addCompileUnit(DICompileUnit(S));
Devang Patel6daf99b2009-11-10 22:05:35 +00001237 else if (S.isSubprogram())
Devang Patel2db49d72010-05-07 18:11:54 +00001238 processSubprogram(DISubprogram(S));
Devang Patel6daf99b2009-11-10 22:05:35 +00001239 else if (S.isLexicalBlock())
Devang Patel2db49d72010-05-07 18:11:54 +00001240 processLexicalBlock(DILexicalBlock(S));
Devang Patel6daf99b2009-11-10 22:05:35 +00001241 processLocation(Loc.getOrigLocation());
1242}
1243
Devang Patel98c65172009-07-30 18:25:15 +00001244/// processType - Process DIType.
1245void DebugInfoFinder::processType(DIType DT) {
Devang Patel72bcdb62009-08-10 22:09:58 +00001246 if (!addType(DT))
Devang Pateld2f79a12009-07-28 19:55:13 +00001247 return;
1248
1249 addCompileUnit(DT.getCompileUnit());
Devang Patel6ceea332009-08-31 18:49:10 +00001250 if (DT.isCompositeType()) {
Devang Patel2db49d72010-05-07 18:11:54 +00001251 DICompositeType DCT(DT);
Devang Patel98c65172009-07-30 18:25:15 +00001252 processType(DCT.getTypeDerivedFrom());
Devang Pateld2f79a12009-07-28 19:55:13 +00001253 DIArray DA = DCT.getTypeArray();
Devang Patel3c91b052010-03-08 20:52:55 +00001254 for (unsigned i = 0, e = DA.getNumElements(); i != e; ++i) {
1255 DIDescriptor D = DA.getElement(i);
1256 if (D.isType())
Devang Patel2db49d72010-05-07 18:11:54 +00001257 processType(DIType(D));
Devang Patel3c91b052010-03-08 20:52:55 +00001258 else if (D.isSubprogram())
Devang Patel2db49d72010-05-07 18:11:54 +00001259 processSubprogram(DISubprogram(D));
Devang Patel3c91b052010-03-08 20:52:55 +00001260 }
Devang Patel6ceea332009-08-31 18:49:10 +00001261 } else if (DT.isDerivedType()) {
Devang Patel2db49d72010-05-07 18:11:54 +00001262 DIDerivedType DDT(DT);
Devang Patel3c91b052010-03-08 20:52:55 +00001263 processType(DDT.getTypeDerivedFrom());
Devang Pateld2f79a12009-07-28 19:55:13 +00001264 }
1265}
1266
Devang Patelbeab41b2009-10-07 22:04:08 +00001267/// processLexicalBlock
1268void DebugInfoFinder::processLexicalBlock(DILexicalBlock LB) {
Devang Patelbeab41b2009-10-07 22:04:08 +00001269 DIScope Context = LB.getContext();
1270 if (Context.isLexicalBlock())
Devang Patel2db49d72010-05-07 18:11:54 +00001271 return processLexicalBlock(DILexicalBlock(Context));
Devang Patelbeab41b2009-10-07 22:04:08 +00001272 else
Devang Patel2db49d72010-05-07 18:11:54 +00001273 return processSubprogram(DISubprogram(Context));
Devang Patelbeab41b2009-10-07 22:04:08 +00001274}
1275
Devang Patel98c65172009-07-30 18:25:15 +00001276/// processSubprogram - Process DISubprogram.
1277void DebugInfoFinder::processSubprogram(DISubprogram SP) {
Devang Pateld2f79a12009-07-28 19:55:13 +00001278 if (!addSubprogram(SP))
1279 return;
1280 addCompileUnit(SP.getCompileUnit());
Devang Patel98c65172009-07-30 18:25:15 +00001281 processType(SP.getType());
Devang Pateld2f79a12009-07-28 19:55:13 +00001282}
1283
Devang Patelb4d31302009-07-31 18:18:52 +00001284/// processDeclare - Process DbgDeclareInst.
1285void DebugInfoFinder::processDeclare(DbgDeclareInst *DDI) {
Devang Patel3c91b052010-03-08 20:52:55 +00001286 MDNode *N = dyn_cast<MDNode>(DDI->getVariable());
1287 if (!N) return;
1288
1289 DIDescriptor DV(N);
1290 if (!DV.isVariable())
Devang Patelb4d31302009-07-31 18:18:52 +00001291 return;
1292
Devang Patel2db49d72010-05-07 18:11:54 +00001293 if (!NodesSeen.insert(DV))
Devang Patelb4d31302009-07-31 18:18:52 +00001294 return;
1295
Devang Patel3c91b052010-03-08 20:52:55 +00001296 addCompileUnit(DIVariable(N).getCompileUnit());
1297 processType(DIVariable(N).getType());
Devang Patelb4d31302009-07-31 18:18:52 +00001298}
1299
Devang Patel72bcdb62009-08-10 22:09:58 +00001300/// addType - Add type into Tys.
1301bool DebugInfoFinder::addType(DIType DT) {
Devang Patel3c91b052010-03-08 20:52:55 +00001302 if (!DT.isValid())
Devang Patel72bcdb62009-08-10 22:09:58 +00001303 return false;
1304
Devang Patel2db49d72010-05-07 18:11:54 +00001305 if (!NodesSeen.insert(DT))
Devang Patel72bcdb62009-08-10 22:09:58 +00001306 return false;
1307
Devang Patel2db49d72010-05-07 18:11:54 +00001308 TYs.push_back(DT);
Devang Patel72bcdb62009-08-10 22:09:58 +00001309 return true;
1310}
1311
Devang Pateld2f79a12009-07-28 19:55:13 +00001312/// addCompileUnit - Add compile unit into CUs.
Devang Patel98c65172009-07-30 18:25:15 +00001313bool DebugInfoFinder::addCompileUnit(DICompileUnit CU) {
Devang Patel3c91b052010-03-08 20:52:55 +00001314 if (!CU.Verify())
Devang Pateld2f79a12009-07-28 19:55:13 +00001315 return false;
1316
Devang Patel2db49d72010-05-07 18:11:54 +00001317 if (!NodesSeen.insert(CU))
Devang Pateld2f79a12009-07-28 19:55:13 +00001318 return false;
1319
Devang Patel2db49d72010-05-07 18:11:54 +00001320 CUs.push_back(CU);
Devang Pateld2f79a12009-07-28 19:55:13 +00001321 return true;
1322}
Daniel Dunbarf612ff62009-09-19 20:40:05 +00001323
Devang Pateld2f79a12009-07-28 19:55:13 +00001324/// addGlobalVariable - Add global variable into GVs.
Devang Patel98c65172009-07-30 18:25:15 +00001325bool DebugInfoFinder::addGlobalVariable(DIGlobalVariable DIG) {
Devang Patel2db49d72010-05-07 18:11:54 +00001326 if (!DIDescriptor(DIG).isGlobalVariable())
Devang Pateld2f79a12009-07-28 19:55:13 +00001327 return false;
1328
Devang Patel2db49d72010-05-07 18:11:54 +00001329 if (!NodesSeen.insert(DIG))
Devang Pateld2f79a12009-07-28 19:55:13 +00001330 return false;
1331
Devang Patel2db49d72010-05-07 18:11:54 +00001332 GVs.push_back(DIG);
Devang Pateld2f79a12009-07-28 19:55:13 +00001333 return true;
1334}
1335
1336// addSubprogram - Add subprgoram into SPs.
Devang Patel98c65172009-07-30 18:25:15 +00001337bool DebugInfoFinder::addSubprogram(DISubprogram SP) {
Devang Patel2db49d72010-05-07 18:11:54 +00001338 if (!DIDescriptor(SP).isSubprogram())
Devang Pateld2f79a12009-07-28 19:55:13 +00001339 return false;
Daniel Dunbarf612ff62009-09-19 20:40:05 +00001340
Devang Patel2db49d72010-05-07 18:11:54 +00001341 if (!NodesSeen.insert(SP))
Devang Pateld2f79a12009-07-28 19:55:13 +00001342 return false;
1343
Devang Patel2db49d72010-05-07 18:11:54 +00001344 SPs.push_back(SP);
Devang Pateld2f79a12009-07-28 19:55:13 +00001345 return true;
1346}
1347
Victor Hernandez756462b2010-01-18 20:42:09 +00001348/// Find the debug info descriptor corresponding to this global variable.
1349static Value *findDbgGlobalDeclare(GlobalVariable *V) {
Chris Lattner099b7792009-12-29 09:22:47 +00001350 const Module *M = V->getParent();
1351 NamedMDNode *NMD = M->getNamedMetadata("llvm.dbg.gv");
1352 if (!NMD)
Torok Edwinff7d0e92009-03-10 13:41:26 +00001353 return 0;
Chris Lattner099b7792009-12-29 09:22:47 +00001354
Chris Lattner5d0cacd2009-12-31 01:22:29 +00001355 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
Devang Patel3c91b052010-03-08 20:52:55 +00001356 DIDescriptor DIG(cast_or_null<MDNode>(NMD->getOperand(i)));
1357 if (!DIG.isGlobalVariable())
Chris Lattner099b7792009-12-29 09:22:47 +00001358 continue;
Devang Patel2db49d72010-05-07 18:11:54 +00001359 if (DIGlobalVariable(DIG).getGlobal() == V)
1360 return DIG;
Torok Edwinff7d0e92009-03-10 13:41:26 +00001361 }
Chris Lattner099b7792009-12-29 09:22:47 +00001362 return 0;
1363}
Torok Edwinff7d0e92009-03-10 13:41:26 +00001364
Chris Lattner099b7792009-12-29 09:22:47 +00001365/// Finds the llvm.dbg.declare intrinsic corresponding to this value if any.
1366/// It looks through pointer casts too.
Victor Hernandez756462b2010-01-18 20:42:09 +00001367static const DbgDeclareInst *findDbgDeclare(const Value *V) {
Victor Hernandez3a328652010-01-15 19:04:09 +00001368 V = V->stripPointerCasts();
1369
1370 if (!isa<Instruction>(V) && !isa<Argument>(V))
Torok Edwin620f2802008-12-16 09:07:36 +00001371 return 0;
Victor Hernandez3a328652010-01-15 19:04:09 +00001372
1373 const Function *F = NULL;
1374 if (const Instruction *I = dyn_cast<Instruction>(V))
1375 F = I->getParent()->getParent();
1376 else if (const Argument *A = dyn_cast<Argument>(V))
1377 F = A->getParent();
1378
1379 for (Function::const_iterator FI = F->begin(), FE = F->end(); FI != FE; ++FI)
1380 for (BasicBlock::const_iterator BI = (*FI).begin(), BE = (*FI).end();
1381 BI != BE; ++BI)
1382 if (const DbgDeclareInst *DDI = dyn_cast<DbgDeclareInst>(BI))
1383 if (DDI->getAddress() == V)
1384 return DDI;
Bill Wendlingdc817b62009-05-14 18:26:15 +00001385
Chris Lattner099b7792009-12-29 09:22:47 +00001386 return 0;
1387}
Bill Wendlingdc817b62009-05-14 18:26:15 +00001388
Chris Lattner099b7792009-12-29 09:22:47 +00001389bool llvm::getLocationInfo(const Value *V, std::string &DisplayName,
1390 std::string &Type, unsigned &LineNo,
1391 std::string &File, std::string &Dir) {
1392 DICompileUnit Unit;
1393 DIType TypeD;
Bill Wendlingdc817b62009-05-14 18:26:15 +00001394
Chris Lattner099b7792009-12-29 09:22:47 +00001395 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(const_cast<Value*>(V))) {
1396 Value *DIGV = findDbgGlobalDeclare(GV);
1397 if (!DIGV) return false;
1398 DIGlobalVariable Var(cast<MDNode>(DIGV));
Bill Wendlingdc817b62009-05-14 18:26:15 +00001399
Chris Lattner099b7792009-12-29 09:22:47 +00001400 StringRef D = Var.getDisplayName();
Devang Patel65dbc902009-11-25 17:36:49 +00001401 if (!D.empty())
Chris Lattner099b7792009-12-29 09:22:47 +00001402 DisplayName = D;
1403 LineNo = Var.getLineNumber();
1404 Unit = Var.getCompileUnit();
1405 TypeD = Var.getType();
1406 } else {
1407 const DbgDeclareInst *DDI = findDbgDeclare(V);
1408 if (!DDI) return false;
1409 DIVariable Var(cast<MDNode>(DDI->getVariable()));
1410
1411 StringRef D = Var.getName();
1412 if (!D.empty())
1413 DisplayName = D;
1414 LineNo = Var.getLineNumber();
1415 Unit = Var.getCompileUnit();
1416 TypeD = Var.getType();
Torok Edwinff7d0e92009-03-10 13:41:26 +00001417 }
Devang Patel13e16b62009-06-26 01:49:18 +00001418
Chris Lattner099b7792009-12-29 09:22:47 +00001419 StringRef T = TypeD.getName();
1420 if (!T.empty())
1421 Type = T;
1422 StringRef F = Unit.getFilename();
1423 if (!F.empty())
1424 File = F;
1425 StringRef D = Unit.getDirectory();
1426 if (!D.empty())
1427 Dir = D;
1428 return true;
1429}
Devang Patel9e529c32009-07-02 01:15:24 +00001430
Chris Lattner099b7792009-12-29 09:22:47 +00001431/// getDISubprogram - Find subprogram that is enclosing this scope.
Devang Patele9f8f5e2010-05-07 20:54:48 +00001432DISubprogram llvm::getDISubprogram(const MDNode *Scope) {
Chris Lattner099b7792009-12-29 09:22:47 +00001433 DIDescriptor D(Scope);
Chris Lattner099b7792009-12-29 09:22:47 +00001434 if (D.isSubprogram())
1435 return DISubprogram(Scope);
1436
1437 if (D.isLexicalBlock())
Devang Patel2db49d72010-05-07 18:11:54 +00001438 return getDISubprogram(DILexicalBlock(Scope).getContext());
Chris Lattner099b7792009-12-29 09:22:47 +00001439
1440 return DISubprogram();
1441}
Devang Patel193f7202009-11-24 01:14:22 +00001442
Chris Lattner099b7792009-12-29 09:22:47 +00001443/// getDICompositeType - Find underlying composite type.
1444DICompositeType llvm::getDICompositeType(DIType T) {
Chris Lattner099b7792009-12-29 09:22:47 +00001445 if (T.isCompositeType())
Devang Patel2db49d72010-05-07 18:11:54 +00001446 return DICompositeType(T);
Chris Lattner099b7792009-12-29 09:22:47 +00001447
1448 if (T.isDerivedType())
Devang Patel2db49d72010-05-07 18:11:54 +00001449 return getDICompositeType(DIDerivedType(T).getTypeDerivedFrom());
Chris Lattner099b7792009-12-29 09:22:47 +00001450
1451 return DICompositeType();
Torok Edwin620f2802008-12-16 09:07:36 +00001452}