blob: 49b2e6b2c546ac1b3b3b4bd47a6e700c96b9c431 [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"
Devang Patel9e529c32009-07-02 01:15:24 +000027#include "llvm/Support/DebugLoc.h"
Chris Lattnera81d29b2009-08-23 07:33:14 +000028#include "llvm/Support/raw_ostream.h"
Chris Lattnera45664f2008-11-10 02:56:27 +000029using namespace llvm;
Argyrios Kyrtzidis77eaa682009-05-03 08:50:41 +000030using namespace llvm::dwarf;
Chris Lattnera45664f2008-11-10 02:56:27 +000031
32//===----------------------------------------------------------------------===//
33// DIDescriptor
34//===----------------------------------------------------------------------===//
35
Argyrios Kyrtzidis77eaa682009-05-03 08:50:41 +000036/// ValidDebugInfo - Return true if V represents valid debug info value.
Devang Patele4b27562009-08-28 23:24:31 +000037/// FIXME : Add DIDescriptor.isValid()
Chris Lattner784b8502009-12-29 09:15:46 +000038bool DIDescriptor::ValidDebugInfo(MDNode *N, unsigned OptLevel) {
Devang Patele4b27562009-08-28 23:24:31 +000039 if (!N)
Argyrios Kyrtzidis77eaa682009-05-03 08:50:41 +000040 return false;
41
Devang Patele4b27562009-08-28 23:24:31 +000042 DIDescriptor DI(N);
Argyrios Kyrtzidis77eaa682009-05-03 08:50:41 +000043
44 // Check current version. Allow Version6 for now.
45 unsigned Version = DI.getVersion();
46 if (Version != LLVMDebugVersion && Version != LLVMDebugVersion6)
47 return false;
48
Chris Lattner099b7792009-12-29 09:22:47 +000049 switch (DI.getTag()) {
Argyrios Kyrtzidis77eaa682009-05-03 08:50:41 +000050 case DW_TAG_variable:
Devang Patele4b27562009-08-28 23:24:31 +000051 assert(DIVariable(N).Verify() && "Invalid DebugInfo value");
Argyrios Kyrtzidis77eaa682009-05-03 08:50:41 +000052 break;
53 case DW_TAG_compile_unit:
Devang Patele4b27562009-08-28 23:24:31 +000054 assert(DICompileUnit(N).Verify() && "Invalid DebugInfo value");
Argyrios Kyrtzidis77eaa682009-05-03 08:50:41 +000055 break;
56 case DW_TAG_subprogram:
Devang Patele4b27562009-08-28 23:24:31 +000057 assert(DISubprogram(N).Verify() && "Invalid DebugInfo value");
Argyrios Kyrtzidis77eaa682009-05-03 08:50:41 +000058 break;
59 case DW_TAG_lexical_block:
Bill Wendlingdc817b62009-05-14 18:26:15 +000060 // FIXME: This interfers with the quality of generated code during
61 // optimization.
Argyrios Kyrtzidis77eaa682009-05-03 08:50:41 +000062 if (OptLevel != CodeGenOpt::None)
63 return false;
Bill Wendlingdc817b62009-05-14 18:26:15 +000064 // FALLTHROUGH
Argyrios Kyrtzidis77eaa682009-05-03 08:50:41 +000065 default:
66 break;
67 }
68
69 return true;
70}
71
Devang Patel65dbc902009-11-25 17:36:49 +000072StringRef
Devang Patel5ccdd102009-09-29 18:40:58 +000073DIDescriptor::getStringField(unsigned Elt) const {
Devang Patele4b27562009-08-28 23:24:31 +000074 if (DbgNode == 0)
Devang Patel65dbc902009-11-25 17:36:49 +000075 return StringRef();
Chris Lattnera45664f2008-11-10 02:56:27 +000076
Chris Lattner5d0cacd2009-12-31 01:22:29 +000077 if (Elt < DbgNode->getNumOperands())
78 if (MDString *MDS = dyn_cast_or_null<MDString>(DbgNode->getOperand(Elt)))
Devang Patel65dbc902009-11-25 17:36:49 +000079 return MDS->getString();
Daniel Dunbarf612ff62009-09-19 20:40:05 +000080
Devang Patel65dbc902009-11-25 17:36:49 +000081 return StringRef();
Chris Lattnera45664f2008-11-10 02:56:27 +000082}
83
84uint64_t DIDescriptor::getUInt64Field(unsigned Elt) const {
Daniel Dunbarf612ff62009-09-19 20:40:05 +000085 if (DbgNode == 0)
Chris Lattnera45664f2008-11-10 02:56:27 +000086 return 0;
Bill Wendlingdc817b62009-05-14 18:26:15 +000087
Chris Lattner5d0cacd2009-12-31 01:22:29 +000088 if (Elt < DbgNode->getNumOperands())
89 if (ConstantInt *CI = dyn_cast<ConstantInt>(DbgNode->getOperand(Elt)))
Devang Patele4b27562009-08-28 23:24:31 +000090 return CI->getZExtValue();
Daniel Dunbarf612ff62009-09-19 20:40:05 +000091
Chris Lattnera45664f2008-11-10 02:56:27 +000092 return 0;
93}
94
Chris Lattnera45664f2008-11-10 02:56:27 +000095DIDescriptor DIDescriptor::getDescriptorField(unsigned Elt) const {
Daniel Dunbarf612ff62009-09-19 20:40:05 +000096 if (DbgNode == 0)
Chris Lattnera45664f2008-11-10 02:56:27 +000097 return DIDescriptor();
Bill Wendlingdc817b62009-05-14 18:26:15 +000098
Chris Lattner5d0cacd2009-12-31 01:22:29 +000099 if (Elt < DbgNode->getNumOperands() && DbgNode->getOperand(Elt))
100 return DIDescriptor(dyn_cast<MDNode>(DbgNode->getOperand(Elt)));
Devang Patele4b27562009-08-28 23:24:31 +0000101
102 return DIDescriptor();
Chris Lattnera45664f2008-11-10 02:56:27 +0000103}
104
105GlobalVariable *DIDescriptor::getGlobalVariableField(unsigned Elt) const {
Daniel Dunbarf612ff62009-09-19 20:40:05 +0000106 if (DbgNode == 0)
Chris Lattnera45664f2008-11-10 02:56:27 +0000107 return 0;
Bill Wendlingdc817b62009-05-14 18:26:15 +0000108
Chris Lattner5d0cacd2009-12-31 01:22:29 +0000109 if (Elt < DbgNode->getNumOperands())
110 return dyn_cast_or_null<GlobalVariable>(DbgNode->getOperand(Elt));
Devang Patele4b27562009-08-28 23:24:31 +0000111 return 0;
Chris Lattnera45664f2008-11-10 02:56:27 +0000112}
113
Chris Lattnerf0908a32009-12-31 03:02:08 +0000114unsigned DIVariable::getNumAddrElements() const {
115 return DbgNode->getNumOperands()-6;
116}
117
118
Chris Lattnera45664f2008-11-10 02:56:27 +0000119//===----------------------------------------------------------------------===//
Devang Patel6ceea332009-08-31 18:49:10 +0000120// Predicates
Chris Lattnera45664f2008-11-10 02:56:27 +0000121//===----------------------------------------------------------------------===//
122
Devang Patel6ceea332009-08-31 18:49:10 +0000123/// isBasicType - Return true if the specified tag is legal for
124/// DIBasicType.
125bool DIDescriptor::isBasicType() const {
Devang Patel3c91b052010-03-08 20:52:55 +0000126 return DbgNode && getTag() == dwarf::DW_TAG_base_type;
Torok Edwinb07fbd92008-12-13 08:25:29 +0000127}
Chris Lattnera45664f2008-11-10 02:56:27 +0000128
Devang Patel6ceea332009-08-31 18:49:10 +0000129/// isDerivedType - Return true if the specified tag is legal for DIDerivedType.
130bool DIDescriptor::isDerivedType() const {
Devang Patel3c91b052010-03-08 20:52:55 +0000131 if (!DbgNode) return false;
Chris Lattner099b7792009-12-29 09:22:47 +0000132 switch (getTag()) {
Chris Lattnera45664f2008-11-10 02:56:27 +0000133 case dwarf::DW_TAG_typedef:
134 case dwarf::DW_TAG_pointer_type:
135 case dwarf::DW_TAG_reference_type:
136 case dwarf::DW_TAG_const_type:
137 case dwarf::DW_TAG_volatile_type:
138 case dwarf::DW_TAG_restrict_type:
139 case dwarf::DW_TAG_member:
140 case dwarf::DW_TAG_inheritance:
141 return true;
142 default:
Devang Patele4b27562009-08-28 23:24:31 +0000143 // CompositeTypes are currently modelled as DerivedTypes.
Devang Patel6ceea332009-08-31 18:49:10 +0000144 return isCompositeType();
Chris Lattnera45664f2008-11-10 02:56:27 +0000145 }
146}
147
Chris Lattnera45664f2008-11-10 02:56:27 +0000148/// isCompositeType - Return true if the specified tag is legal for
149/// DICompositeType.
Devang Patel6ceea332009-08-31 18:49:10 +0000150bool DIDescriptor::isCompositeType() const {
Devang Patel3c91b052010-03-08 20:52:55 +0000151 if (!DbgNode) return false;
Chris Lattner099b7792009-12-29 09:22:47 +0000152 switch (getTag()) {
Chris Lattnera45664f2008-11-10 02:56:27 +0000153 case dwarf::DW_TAG_array_type:
154 case dwarf::DW_TAG_structure_type:
155 case dwarf::DW_TAG_union_type:
156 case dwarf::DW_TAG_enumeration_type:
157 case dwarf::DW_TAG_vector_type:
158 case dwarf::DW_TAG_subroutine_type:
Devang Patel25cb0d72009-03-25 03:52:06 +0000159 case dwarf::DW_TAG_class_type:
Chris Lattnera45664f2008-11-10 02:56:27 +0000160 return true;
161 default:
162 return false;
163 }
164}
165
Chris Lattnera45664f2008-11-10 02:56:27 +0000166/// isVariable - Return true if the specified tag is legal for DIVariable.
Devang Patel6ceea332009-08-31 18:49:10 +0000167bool DIDescriptor::isVariable() const {
Devang Patel3c91b052010-03-08 20:52:55 +0000168 if (!DbgNode) return false;
Chris Lattner099b7792009-12-29 09:22:47 +0000169 switch (getTag()) {
Chris Lattnera45664f2008-11-10 02:56:27 +0000170 case dwarf::DW_TAG_auto_variable:
171 case dwarf::DW_TAG_arg_variable:
172 case dwarf::DW_TAG_return_variable:
173 return true;
174 default:
175 return false;
176 }
177}
178
Devang Patelecbeb1a2009-09-30 22:34:41 +0000179/// isType - Return true if the specified tag is legal for DIType.
180bool DIDescriptor::isType() const {
181 return isBasicType() || isCompositeType() || isDerivedType();
182}
183
Devang Patel6ceea332009-08-31 18:49:10 +0000184/// isSubprogram - Return true if the specified tag is legal for
185/// DISubprogram.
186bool DIDescriptor::isSubprogram() const {
Devang Patel3c91b052010-03-08 20:52:55 +0000187 return DbgNode && getTag() == dwarf::DW_TAG_subprogram;
Devang Patel6ceea332009-08-31 18:49:10 +0000188}
189
190/// isGlobalVariable - Return true if the specified tag is legal for
191/// DIGlobalVariable.
192bool DIDescriptor::isGlobalVariable() const {
Devang Patel3c91b052010-03-08 20:52:55 +0000193 return DbgNode && getTag() == dwarf::DW_TAG_variable;
Devang Patel6ceea332009-08-31 18:49:10 +0000194}
195
Devang Patelecbeb1a2009-09-30 22:34:41 +0000196/// isGlobal - Return true if the specified tag is legal for DIGlobal.
197bool DIDescriptor::isGlobal() const {
198 return isGlobalVariable();
199}
200
Daniel Dunbarf612ff62009-09-19 20:40:05 +0000201/// isScope - Return true if the specified tag is one of the scope
Devang Patel43d98b32009-08-31 20:44:45 +0000202/// related tag.
203bool DIDescriptor::isScope() const {
Devang Patel3c91b052010-03-08 20:52:55 +0000204 if (!DbgNode) return false;
Chris Lattner099b7792009-12-29 09:22:47 +0000205 switch (getTag()) {
206 case dwarf::DW_TAG_compile_unit:
207 case dwarf::DW_TAG_lexical_block:
208 case dwarf::DW_TAG_subprogram:
209 case dwarf::DW_TAG_namespace:
210 return true;
211 default:
212 break;
Devang Patel43d98b32009-08-31 20:44:45 +0000213 }
214 return false;
215}
Devang Patel6ceea332009-08-31 18:49:10 +0000216
Devang Patelc9f322d2009-08-31 21:34:44 +0000217/// isCompileUnit - Return true if the specified tag is DW_TAG_compile_unit.
218bool DIDescriptor::isCompileUnit() const {
Devang Patel3c91b052010-03-08 20:52:55 +0000219 return DbgNode && getTag() == dwarf::DW_TAG_compile_unit;
Devang Patelc9f322d2009-08-31 21:34:44 +0000220}
221
Devang Patel7aa81892010-03-08 22:27:22 +0000222/// isFile - Return true if the specified tag is DW_TAG_file_type.
223bool DIDescriptor::isFile() const {
224 return DbgNode && getTag() == dwarf::DW_TAG_file_type;
225}
226
Devang Patel6404e4e2009-12-15 19:16:48 +0000227/// isNameSpace - Return true if the specified tag is DW_TAG_namespace.
228bool DIDescriptor::isNameSpace() const {
Devang Patel3c91b052010-03-08 20:52:55 +0000229 return DbgNode && getTag() == dwarf::DW_TAG_namespace;
Devang Patel6404e4e2009-12-15 19:16:48 +0000230}
231
Devang Patel5e005d82009-08-31 22:00:15 +0000232/// isLexicalBlock - Return true if the specified tag is DW_TAG_lexical_block.
233bool DIDescriptor::isLexicalBlock() const {
Devang Patel3c91b052010-03-08 20:52:55 +0000234 return DbgNode && getTag() == dwarf::DW_TAG_lexical_block;
Devang Patel5e005d82009-08-31 22:00:15 +0000235}
236
Devang Patelecbeb1a2009-09-30 22:34:41 +0000237/// isSubrange - Return true if the specified tag is DW_TAG_subrange_type.
238bool DIDescriptor::isSubrange() const {
Devang Patel3c91b052010-03-08 20:52:55 +0000239 return DbgNode && getTag() == dwarf::DW_TAG_subrange_type;
Devang Patelecbeb1a2009-09-30 22:34:41 +0000240}
241
242/// isEnumerator - Return true if the specified tag is DW_TAG_enumerator.
243bool DIDescriptor::isEnumerator() const {
Devang Patel3c91b052010-03-08 20:52:55 +0000244 return DbgNode && getTag() == dwarf::DW_TAG_enumerator;
Devang Patelecbeb1a2009-09-30 22:34:41 +0000245}
246
Devang Patel6ceea332009-08-31 18:49:10 +0000247//===----------------------------------------------------------------------===//
248// Simple Descriptor Constructors and other Methods
249//===----------------------------------------------------------------------===//
250
Devang Patel77bf2952010-03-08 22:02:50 +0000251DIType::DIType(MDNode *N) : DIScope(N) {
Devang Patel6ceea332009-08-31 18:49:10 +0000252 if (!N) return;
253 if (!isBasicType() && !isDerivedType() && !isCompositeType()) {
254 DbgNode = 0;
255 }
256}
257
Devang Patel68afdc32009-01-05 18:33:01 +0000258unsigned DIArray::getNumElements() const {
Devang Patel3c91b052010-03-08 20:52:55 +0000259 if (!DbgNode)
260 return 0;
Chris Lattner5d0cacd2009-12-31 01:22:29 +0000261 return DbgNode->getNumOperands();
Devang Patel68afdc32009-01-05 18:33:01 +0000262}
Chris Lattnera45664f2008-11-10 02:56:27 +0000263
Devang Patelc4999d72009-07-22 18:23:44 +0000264/// replaceAllUsesWith - Replace all uses of debug info referenced by
265/// this descriptor. After this completes, the current debug info value
266/// is erased.
267void DIDerivedType::replaceAllUsesWith(DIDescriptor &D) {
Devang Patel3c91b052010-03-08 20:52:55 +0000268 if (!DbgNode)
Devang Patelc4999d72009-07-22 18:23:44 +0000269 return;
270
Daniel Dunbar48a097b2009-09-22 02:03:18 +0000271 // Since we use a TrackingVH for the node, its easy for clients to manufacture
272 // legitimate situations where they want to replaceAllUsesWith() on something
273 // which, due to uniquing, has merged with the source. We shield clients from
274 // this detail by allowing a value to be replaced with replaceAllUsesWith()
275 // itself.
276 if (getNode() != D.getNode()) {
277 MDNode *Node = DbgNode;
278 Node->replaceAllUsesWith(D.getNode());
Chris Lattnerb76359e2009-12-31 01:05:46 +0000279 Node->destroy();
Daniel Dunbar48a097b2009-09-22 02:03:18 +0000280 }
Devang Patelc4999d72009-07-22 18:23:44 +0000281}
282
Devang Patelb79b5352009-01-19 23:21:49 +0000283/// Verify - Verify that a compile unit is well formed.
284bool DICompileUnit::Verify() const {
Devang Patel3c91b052010-03-08 20:52:55 +0000285 if (!DbgNode)
Devang Patelb79b5352009-01-19 23:21:49 +0000286 return false;
Devang Patel65dbc902009-11-25 17:36:49 +0000287 StringRef N = getFilename();
288 if (N.empty())
Bill Wendling0582ae92009-03-13 04:39:26 +0000289 return false;
Devang Patelb79b5352009-01-19 23:21:49 +0000290 // It is possible that directory and produce string is empty.
Bill Wendling0582ae92009-03-13 04:39:26 +0000291 return true;
Devang Patelb79b5352009-01-19 23:21:49 +0000292}
293
294/// Verify - Verify that a type descriptor is well formed.
295bool DIType::Verify() const {
Devang Patel3c91b052010-03-08 20:52:55 +0000296 if (!DbgNode)
Devang Patelb79b5352009-01-19 23:21:49 +0000297 return false;
Devang Patel3c91b052010-03-08 20:52:55 +0000298 if (!getContext().Verify())
Devang Patelb79b5352009-01-19 23:21:49 +0000299 return false;
300
301 DICompileUnit CU = getCompileUnit();
Devang Patel3c91b052010-03-08 20:52:55 +0000302 if (!CU.Verify())
Devang Patelb79b5352009-01-19 23:21:49 +0000303 return false;
304 return true;
305}
306
307/// Verify - Verify that a composite type descriptor is well formed.
308bool DICompositeType::Verify() const {
Devang Patel3c91b052010-03-08 20:52:55 +0000309 if (!DbgNode)
Devang Patelb79b5352009-01-19 23:21:49 +0000310 return false;
Devang Patel3c91b052010-03-08 20:52:55 +0000311 if (!getContext().Verify())
Devang Patelb79b5352009-01-19 23:21:49 +0000312 return false;
313
314 DICompileUnit CU = getCompileUnit();
Devang Patel3c91b052010-03-08 20:52:55 +0000315 if (!CU.Verify())
Devang Patelb79b5352009-01-19 23:21:49 +0000316 return false;
317 return true;
318}
319
320/// Verify - Verify that a subprogram descriptor is well formed.
321bool DISubprogram::Verify() const {
Devang Patel3c91b052010-03-08 20:52:55 +0000322 if (!DbgNode)
Devang Patelb79b5352009-01-19 23:21:49 +0000323 return false;
Daniel Dunbarf612ff62009-09-19 20:40:05 +0000324
Devang Patel3c91b052010-03-08 20:52:55 +0000325 if (!getContext().Verify())
Devang Patelb79b5352009-01-19 23:21:49 +0000326 return false;
327
328 DICompileUnit CU = getCompileUnit();
Daniel Dunbarf612ff62009-09-19 20:40:05 +0000329 if (!CU.Verify())
Devang Patelb79b5352009-01-19 23:21:49 +0000330 return false;
331
332 DICompositeType Ty = getType();
Devang Patel3c91b052010-03-08 20:52:55 +0000333 if (!Ty.Verify())
Devang Patelb79b5352009-01-19 23:21:49 +0000334 return false;
335 return true;
336}
337
338/// Verify - Verify that a global variable descriptor is well formed.
339bool DIGlobalVariable::Verify() const {
Devang Patel3c91b052010-03-08 20:52:55 +0000340 if (!DbgNode)
Devang Patelb79b5352009-01-19 23:21:49 +0000341 return false;
Daniel Dunbarf612ff62009-09-19 20:40:05 +0000342
Devang Patel65dbc902009-11-25 17:36:49 +0000343 if (getDisplayName().empty())
Devang Patel84c73e92009-11-06 17:58:12 +0000344 return false;
345
Devang Patel3c91b052010-03-08 20:52:55 +0000346 if (!getContext().Verify())
Devang Patelb79b5352009-01-19 23:21:49 +0000347 return false;
348
349 DICompileUnit CU = getCompileUnit();
Devang Patel3c91b052010-03-08 20:52:55 +0000350 if (!CU.Verify())
Devang Patelb79b5352009-01-19 23:21:49 +0000351 return false;
352
353 DIType Ty = getType();
354 if (!Ty.Verify())
355 return false;
356
357 if (!getGlobal())
358 return false;
359
360 return true;
361}
362
363/// Verify - Verify that a variable descriptor is well formed.
364bool DIVariable::Verify() const {
Devang Patel3c91b052010-03-08 20:52:55 +0000365 if (!DbgNode)
Devang Patelb79b5352009-01-19 23:21:49 +0000366 return false;
Daniel Dunbarf612ff62009-09-19 20:40:05 +0000367
Devang Patel3c91b052010-03-08 20:52:55 +0000368 if (!getContext().Verify())
Devang Patelb79b5352009-01-19 23:21:49 +0000369 return false;
370
371 DIType Ty = getType();
372 if (!Ty.Verify())
373 return false;
374
Devang Patelb79b5352009-01-19 23:21:49 +0000375 return true;
376}
377
Devang Patel3c91b052010-03-08 20:52:55 +0000378/// Verify - Verify that a location descriptor is well formed.
379bool DILocation::Verify() const {
380 if (!DbgNode)
381 return false;
382
383 return DbgNode->getNumOperands() == 4;
384}
385
Devang Patel36375ee2009-02-17 21:23:59 +0000386/// getOriginalTypeSize - If this type is derived from a base type then
387/// return base type size.
388uint64_t DIDerivedType::getOriginalTypeSize() const {
Devang Patel61ecbd12009-11-04 23:48:00 +0000389 unsigned Tag = getTag();
390 if (Tag == dwarf::DW_TAG_member || Tag == dwarf::DW_TAG_typedef ||
391 Tag == dwarf::DW_TAG_const_type || Tag == dwarf::DW_TAG_volatile_type ||
392 Tag == dwarf::DW_TAG_restrict_type) {
393 DIType BaseType = getTypeDerivedFrom();
Devang Patel5ebfa2d2009-11-06 18:24:05 +0000394 // If this type is not derived from any type then take conservative
395 // approach.
Devang Patel3c91b052010-03-08 20:52:55 +0000396 if (!BaseType.isValid())
Devang Patel5ebfa2d2009-11-06 18:24:05 +0000397 return getSizeInBits();
Devang Patel61ecbd12009-11-04 23:48:00 +0000398 if (BaseType.isDerivedType())
399 return DIDerivedType(BaseType.getNode()).getOriginalTypeSize();
400 else
401 return BaseType.getSizeInBits();
402 }
403
404 return getSizeInBits();
Devang Patel36375ee2009-02-17 21:23:59 +0000405}
Devang Patelb79b5352009-01-19 23:21:49 +0000406
Devang Patelaf5b6bb2009-04-15 00:06:07 +0000407/// describes - Return true if this subprogram provides debugging
408/// information for the function F.
409bool DISubprogram::describes(const Function *F) {
Chris Lattner099b7792009-12-29 09:22:47 +0000410 assert(F && "Invalid function");
Devang Patel65dbc902009-11-25 17:36:49 +0000411 StringRef Name = getLinkageName();
412 if (Name.empty())
Devang Patel5ccdd102009-09-29 18:40:58 +0000413 Name = getName();
Devang Patel65dbc902009-11-25 17:36:49 +0000414 if (F->getName() == Name)
Devang Patelaf5b6bb2009-04-15 00:06:07 +0000415 return true;
416 return false;
417}
418
Devang Patel65dbc902009-11-25 17:36:49 +0000419StringRef DIScope::getFilename() const {
Devang Patel77bf2952010-03-08 22:02:50 +0000420 if (!DbgNode)
421 return StringRef();
Devang Patelecbeb1a2009-09-30 22:34:41 +0000422 if (isLexicalBlock())
423 return DILexicalBlock(DbgNode).getFilename();
Chris Lattner099b7792009-12-29 09:22:47 +0000424 if (isSubprogram())
Devang Patelecbeb1a2009-09-30 22:34:41 +0000425 return DISubprogram(DbgNode).getFilename();
Chris Lattner099b7792009-12-29 09:22:47 +0000426 if (isCompileUnit())
Devang Patelecbeb1a2009-09-30 22:34:41 +0000427 return DICompileUnit(DbgNode).getFilename();
Chris Lattner099b7792009-12-29 09:22:47 +0000428 if (isNameSpace())
Devang Patel6404e4e2009-12-15 19:16:48 +0000429 return DINameSpace(DbgNode).getFilename();
Devang Patel77bf2952010-03-08 22:02:50 +0000430 if (isType())
431 return DIType(DbgNode).getFilename();
Devang Patel7aa81892010-03-08 22:27:22 +0000432 if (isFile())
433 return DIFile(DbgNode).getFilename();
Chris Lattner099b7792009-12-29 09:22:47 +0000434 assert(0 && "Invalid DIScope!");
Devang Patel65dbc902009-11-25 17:36:49 +0000435 return StringRef();
Devang Patelecbeb1a2009-09-30 22:34:41 +0000436}
437
Devang Patel65dbc902009-11-25 17:36:49 +0000438StringRef DIScope::getDirectory() const {
Devang Patel77bf2952010-03-08 22:02:50 +0000439 if (!DbgNode)
440 return StringRef();
Devang Patelecbeb1a2009-09-30 22:34:41 +0000441 if (isLexicalBlock())
442 return DILexicalBlock(DbgNode).getDirectory();
Chris Lattner099b7792009-12-29 09:22:47 +0000443 if (isSubprogram())
Devang Patelecbeb1a2009-09-30 22:34:41 +0000444 return DISubprogram(DbgNode).getDirectory();
Chris Lattner099b7792009-12-29 09:22:47 +0000445 if (isCompileUnit())
Devang Patelecbeb1a2009-09-30 22:34:41 +0000446 return DICompileUnit(DbgNode).getDirectory();
Chris Lattner099b7792009-12-29 09:22:47 +0000447 if (isNameSpace())
Devang Patel6404e4e2009-12-15 19:16:48 +0000448 return DINameSpace(DbgNode).getDirectory();
Devang Patel77bf2952010-03-08 22:02:50 +0000449 if (isType())
450 return DIType(DbgNode).getDirectory();
Devang Patel7aa81892010-03-08 22:27:22 +0000451 if (isFile())
452 return DIFile(DbgNode).getDirectory();
Chris Lattner099b7792009-12-29 09:22:47 +0000453 assert(0 && "Invalid DIScope!");
Devang Patel65dbc902009-11-25 17:36:49 +0000454 return StringRef();
Devang Patelecbeb1a2009-09-30 22:34:41 +0000455}
456
Chris Lattnera45664f2008-11-10 02:56:27 +0000457//===----------------------------------------------------------------------===//
Devang Patel7136a652009-07-01 22:10:23 +0000458// DIDescriptor: dump routines for all descriptors.
459//===----------------------------------------------------------------------===//
460
461
462/// dump - Print descriptor.
463void DIDescriptor::dump() const {
David Greene0eb5b662009-12-23 19:45:49 +0000464 dbgs() << "[" << dwarf::TagString(getTag()) << "] ";
465 dbgs().write_hex((intptr_t) &*DbgNode) << ']';
Devang Patel7136a652009-07-01 22:10:23 +0000466}
467
468/// dump - Print compile unit.
469void DICompileUnit::dump() const {
470 if (getLanguage())
David Greene0eb5b662009-12-23 19:45:49 +0000471 dbgs() << " [" << dwarf::LanguageString(getLanguage()) << "] ";
Devang Patel7136a652009-07-01 22:10:23 +0000472
David Greene0eb5b662009-12-23 19:45:49 +0000473 dbgs() << " [" << getDirectory() << "/" << getFilename() << " ]";
Devang Patel7136a652009-07-01 22:10:23 +0000474}
475
476/// dump - Print type.
477void DIType::dump() const {
Devang Patel3c91b052010-03-08 20:52:55 +0000478 if (!DbgNode) return;
Devang Patel7136a652009-07-01 22:10:23 +0000479
Devang Patel65dbc902009-11-25 17:36:49 +0000480 StringRef Res = getName();
481 if (!Res.empty())
David Greene0eb5b662009-12-23 19:45:49 +0000482 dbgs() << " [" << Res << "] ";
Devang Patel7136a652009-07-01 22:10:23 +0000483
484 unsigned Tag = getTag();
David Greene0eb5b662009-12-23 19:45:49 +0000485 dbgs() << " [" << dwarf::TagString(Tag) << "] ";
Devang Patel7136a652009-07-01 22:10:23 +0000486
487 // TODO : Print context
488 getCompileUnit().dump();
David Greene0eb5b662009-12-23 19:45:49 +0000489 dbgs() << " ["
Daniel Dunbarf612ff62009-09-19 20:40:05 +0000490 << getLineNumber() << ", "
Chris Lattnera81d29b2009-08-23 07:33:14 +0000491 << getSizeInBits() << ", "
492 << getAlignInBits() << ", "
Daniel Dunbarf612ff62009-09-19 20:40:05 +0000493 << getOffsetInBits()
Chris Lattnera81d29b2009-08-23 07:33:14 +0000494 << "] ";
Devang Patel7136a652009-07-01 22:10:23 +0000495
Daniel Dunbarf612ff62009-09-19 20:40:05 +0000496 if (isPrivate())
David Greene0eb5b662009-12-23 19:45:49 +0000497 dbgs() << " [private] ";
Devang Patel7136a652009-07-01 22:10:23 +0000498 else if (isProtected())
David Greene0eb5b662009-12-23 19:45:49 +0000499 dbgs() << " [protected] ";
Devang Patel7136a652009-07-01 22:10:23 +0000500
501 if (isForwardDecl())
David Greene0eb5b662009-12-23 19:45:49 +0000502 dbgs() << " [fwd] ";
Devang Patel7136a652009-07-01 22:10:23 +0000503
Devang Patel6ceea332009-08-31 18:49:10 +0000504 if (isBasicType())
Devang Patele4b27562009-08-28 23:24:31 +0000505 DIBasicType(DbgNode).dump();
Devang Patel6ceea332009-08-31 18:49:10 +0000506 else if (isDerivedType())
Devang Patele4b27562009-08-28 23:24:31 +0000507 DIDerivedType(DbgNode).dump();
Devang Patel6ceea332009-08-31 18:49:10 +0000508 else if (isCompositeType())
Devang Patele4b27562009-08-28 23:24:31 +0000509 DICompositeType(DbgNode).dump();
Devang Patel7136a652009-07-01 22:10:23 +0000510 else {
David Greene0eb5b662009-12-23 19:45:49 +0000511 dbgs() << "Invalid DIType\n";
Devang Patel7136a652009-07-01 22:10:23 +0000512 return;
513 }
514
David Greene0eb5b662009-12-23 19:45:49 +0000515 dbgs() << "\n";
Devang Patel7136a652009-07-01 22:10:23 +0000516}
517
518/// dump - Print basic type.
519void DIBasicType::dump() const {
David Greene0eb5b662009-12-23 19:45:49 +0000520 dbgs() << " [" << dwarf::AttributeEncodingString(getEncoding()) << "] ";
Devang Patel7136a652009-07-01 22:10:23 +0000521}
522
523/// dump - Print derived type.
524void DIDerivedType::dump() const {
David Greene0eb5b662009-12-23 19:45:49 +0000525 dbgs() << "\n\t Derived From: "; getTypeDerivedFrom().dump();
Devang Patel7136a652009-07-01 22:10:23 +0000526}
527
528/// dump - Print composite type.
529void DICompositeType::dump() const {
530 DIArray A = getTypeArray();
David Greene0eb5b662009-12-23 19:45:49 +0000531 dbgs() << " [" << A.getNumElements() << " elements]";
Devang Patel7136a652009-07-01 22:10:23 +0000532}
533
534/// dump - Print global.
535void DIGlobal::dump() const {
Devang Patel65dbc902009-11-25 17:36:49 +0000536 StringRef Res = getName();
537 if (!Res.empty())
David Greene0eb5b662009-12-23 19:45:49 +0000538 dbgs() << " [" << Res << "] ";
Devang Patel7136a652009-07-01 22:10:23 +0000539
540 unsigned Tag = getTag();
David Greene0eb5b662009-12-23 19:45:49 +0000541 dbgs() << " [" << dwarf::TagString(Tag) << "] ";
Devang Patel7136a652009-07-01 22:10:23 +0000542
543 // TODO : Print context
544 getCompileUnit().dump();
David Greene0eb5b662009-12-23 19:45:49 +0000545 dbgs() << " [" << getLineNumber() << "] ";
Devang Patel7136a652009-07-01 22:10:23 +0000546
547 if (isLocalToUnit())
David Greene0eb5b662009-12-23 19:45:49 +0000548 dbgs() << " [local] ";
Devang Patel7136a652009-07-01 22:10:23 +0000549
550 if (isDefinition())
David Greene0eb5b662009-12-23 19:45:49 +0000551 dbgs() << " [def] ";
Devang Patel7136a652009-07-01 22:10:23 +0000552
Devang Patel6ceea332009-08-31 18:49:10 +0000553 if (isGlobalVariable())
Devang Patele4b27562009-08-28 23:24:31 +0000554 DIGlobalVariable(DbgNode).dump();
Devang Patel7136a652009-07-01 22:10:23 +0000555
David Greene0eb5b662009-12-23 19:45:49 +0000556 dbgs() << "\n";
Devang Patel7136a652009-07-01 22:10:23 +0000557}
558
559/// dump - Print subprogram.
560void DISubprogram::dump() const {
Devang Patel65dbc902009-11-25 17:36:49 +0000561 StringRef Res = getName();
562 if (!Res.empty())
David Greene0eb5b662009-12-23 19:45:49 +0000563 dbgs() << " [" << Res << "] ";
Devang Patel82dfc0c2009-08-31 22:47:13 +0000564
565 unsigned Tag = getTag();
David Greene0eb5b662009-12-23 19:45:49 +0000566 dbgs() << " [" << dwarf::TagString(Tag) << "] ";
Devang Patel82dfc0c2009-08-31 22:47:13 +0000567
568 // TODO : Print context
569 getCompileUnit().dump();
David Greene0eb5b662009-12-23 19:45:49 +0000570 dbgs() << " [" << getLineNumber() << "] ";
Devang Patel82dfc0c2009-08-31 22:47:13 +0000571
572 if (isLocalToUnit())
David Greene0eb5b662009-12-23 19:45:49 +0000573 dbgs() << " [local] ";
Devang Patel82dfc0c2009-08-31 22:47:13 +0000574
575 if (isDefinition())
David Greene0eb5b662009-12-23 19:45:49 +0000576 dbgs() << " [def] ";
Devang Patel82dfc0c2009-08-31 22:47:13 +0000577
David Greene0eb5b662009-12-23 19:45:49 +0000578 dbgs() << "\n";
Devang Patel7136a652009-07-01 22:10:23 +0000579}
580
581/// dump - Print global variable.
582void DIGlobalVariable::dump() const {
David Greene0eb5b662009-12-23 19:45:49 +0000583 dbgs() << " [";
Chris Lattnera81d29b2009-08-23 07:33:14 +0000584 getGlobal()->dump();
David Greene0eb5b662009-12-23 19:45:49 +0000585 dbgs() << "] ";
Devang Patel7136a652009-07-01 22:10:23 +0000586}
587
588/// dump - Print variable.
589void DIVariable::dump() const {
Devang Patel65dbc902009-11-25 17:36:49 +0000590 StringRef Res = getName();
591 if (!Res.empty())
David Greene0eb5b662009-12-23 19:45:49 +0000592 dbgs() << " [" << Res << "] ";
Devang Patel7136a652009-07-01 22:10:23 +0000593
594 getCompileUnit().dump();
David Greene0eb5b662009-12-23 19:45:49 +0000595 dbgs() << " [" << getLineNumber() << "] ";
Devang Patel7136a652009-07-01 22:10:23 +0000596 getType().dump();
David Greene0eb5b662009-12-23 19:45:49 +0000597 dbgs() << "\n";
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000598
599 // FIXME: Dump complex addresses
Devang Patel7136a652009-07-01 22:10:23 +0000600}
601
602//===----------------------------------------------------------------------===//
Chris Lattnera45664f2008-11-10 02:56:27 +0000603// DIFactory: Basic Helpers
604//===----------------------------------------------------------------------===//
605
Bill Wendlingdc817b62009-05-14 18:26:15 +0000606DIFactory::DIFactory(Module &m)
Victor Hernandez06203122010-01-23 00:03:28 +0000607 : M(m), VMContext(M.getContext()), DeclareFn(0), ValueFn(0) {}
Chris Lattner497a7a82008-11-10 04:10:34 +0000608
Chris Lattnera45664f2008-11-10 02:56:27 +0000609Constant *DIFactory::GetTagConstant(unsigned TAG) {
Devang Patel6906ba52009-01-20 19:22:03 +0000610 assert((TAG & LLVMDebugVersionMask) == 0 &&
Chris Lattnera45664f2008-11-10 02:56:27 +0000611 "Tag too large for debug encoding!");
Owen Anderson1d0be152009-08-13 21:58:54 +0000612 return ConstantInt::get(Type::getInt32Ty(VMContext), TAG | LLVMDebugVersion);
Chris Lattnera45664f2008-11-10 02:56:27 +0000613}
614
Chris Lattnera45664f2008-11-10 02:56:27 +0000615//===----------------------------------------------------------------------===//
616// DIFactory: Primary Constructors
617//===----------------------------------------------------------------------===//
618
Daniel Dunbarf612ff62009-09-19 20:40:05 +0000619/// GetOrCreateArray - Create an descriptor for an array of descriptors.
Chris Lattnera45664f2008-11-10 02:56:27 +0000620/// This implicitly uniques the arrays created.
621DIArray DIFactory::GetOrCreateArray(DIDescriptor *Tys, unsigned NumTys) {
Devang Patele4b27562009-08-28 23:24:31 +0000622 SmallVector<Value*, 16> Elts;
Daniel Dunbarf612ff62009-09-19 20:40:05 +0000623
Devang Patele4b27562009-08-28 23:24:31 +0000624 if (NumTys == 0)
625 Elts.push_back(llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)));
626 else
627 for (unsigned i = 0; i != NumTys; ++i)
628 Elts.push_back(Tys[i].getNode());
Devang Patel82459882009-08-26 05:01:18 +0000629
Devang Patele4b27562009-08-28 23:24:31 +0000630 return DIArray(MDNode::get(VMContext,Elts.data(), Elts.size()));
Chris Lattnera45664f2008-11-10 02:56:27 +0000631}
632
633/// GetOrCreateSubrange - Create a descriptor for a value range. This
634/// implicitly uniques the values returned.
635DISubrange DIFactory::GetOrCreateSubrange(int64_t Lo, int64_t Hi) {
Devang Patele4b27562009-08-28 23:24:31 +0000636 Value *Elts[] = {
Chris Lattnera45664f2008-11-10 02:56:27 +0000637 GetTagConstant(dwarf::DW_TAG_subrange_type),
Owen Anderson1d0be152009-08-13 21:58:54 +0000638 ConstantInt::get(Type::getInt64Ty(VMContext), Lo),
639 ConstantInt::get(Type::getInt64Ty(VMContext), Hi)
Chris Lattnera45664f2008-11-10 02:56:27 +0000640 };
Daniel Dunbarf612ff62009-09-19 20:40:05 +0000641
Devang Patele4b27562009-08-28 23:24:31 +0000642 return DISubrange(MDNode::get(VMContext, &Elts[0], 3));
Chris Lattnera45664f2008-11-10 02:56:27 +0000643}
644
645
646
647/// CreateCompileUnit - Create a new descriptor for the specified compile
648/// unit. Note that this does not unique compile units within the module.
649DICompileUnit DIFactory::CreateCompileUnit(unsigned LangID,
Devang Patel65dbc902009-11-25 17:36:49 +0000650 StringRef Filename,
651 StringRef Directory,
652 StringRef Producer,
Devang Pateldd9db662009-01-30 18:20:31 +0000653 bool isMain,
Devang Patel3b64c6b2009-01-23 22:33:47 +0000654 bool isOptimized,
Devang Patel65dbc902009-11-25 17:36:49 +0000655 StringRef Flags,
Devang Patel13319ce2009-02-17 22:43:44 +0000656 unsigned RunTimeVer) {
Devang Patele4b27562009-08-28 23:24:31 +0000657 Value *Elts[] = {
Chris Lattnera45664f2008-11-10 02:56:27 +0000658 GetTagConstant(dwarf::DW_TAG_compile_unit),
Devang Patele4b27562009-08-28 23:24:31 +0000659 llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
Owen Anderson1d0be152009-08-13 21:58:54 +0000660 ConstantInt::get(Type::getInt32Ty(VMContext), LangID),
Devang Patele4b27562009-08-28 23:24:31 +0000661 MDString::get(VMContext, Filename),
662 MDString::get(VMContext, Directory),
663 MDString::get(VMContext, Producer),
Owen Anderson1d0be152009-08-13 21:58:54 +0000664 ConstantInt::get(Type::getInt1Ty(VMContext), isMain),
665 ConstantInt::get(Type::getInt1Ty(VMContext), isOptimized),
Devang Patele4b27562009-08-28 23:24:31 +0000666 MDString::get(VMContext, Flags),
Owen Anderson1d0be152009-08-13 21:58:54 +0000667 ConstantInt::get(Type::getInt32Ty(VMContext), RunTimeVer)
Chris Lattnera45664f2008-11-10 02:56:27 +0000668 };
Devang Patele4b27562009-08-28 23:24:31 +0000669
670 return DICompileUnit(MDNode::get(VMContext, &Elts[0], 10));
Chris Lattnera45664f2008-11-10 02:56:27 +0000671}
672
Devang Patel7aa81892010-03-08 22:27:22 +0000673/// CreateFile - Create a new descriptor for the specified file.
674DIFile DIFactory::CreateFile(StringRef Filename,
675 StringRef Directory,
676 DICompileUnit CU) {
677 Value *Elts[] = {
678 GetTagConstant(dwarf::DW_TAG_file_type),
679 MDString::get(VMContext, Filename),
680 MDString::get(VMContext, Directory),
681 CU.getNode()
682 };
683
684 return DIFile(MDNode::get(VMContext, &Elts[0], 4));
685}
686
Chris Lattnera45664f2008-11-10 02:56:27 +0000687/// CreateEnumerator - Create a single enumerator value.
Devang Patel65dbc902009-11-25 17:36:49 +0000688DIEnumerator DIFactory::CreateEnumerator(StringRef Name, uint64_t Val){
Devang Patele4b27562009-08-28 23:24:31 +0000689 Value *Elts[] = {
Chris Lattnera45664f2008-11-10 02:56:27 +0000690 GetTagConstant(dwarf::DW_TAG_enumerator),
Devang Patele4b27562009-08-28 23:24:31 +0000691 MDString::get(VMContext, Name),
Owen Anderson1d0be152009-08-13 21:58:54 +0000692 ConstantInt::get(Type::getInt64Ty(VMContext), Val)
Chris Lattnera45664f2008-11-10 02:56:27 +0000693 };
Devang Patele4b27562009-08-28 23:24:31 +0000694 return DIEnumerator(MDNode::get(VMContext, &Elts[0], 3));
Chris Lattnera45664f2008-11-10 02:56:27 +0000695}
696
697
698/// CreateBasicType - Create a basic type like int, float, etc.
699DIBasicType DIFactory::CreateBasicType(DIDescriptor Context,
Devang Patel65dbc902009-11-25 17:36:49 +0000700 StringRef Name,
Chris Lattnera45664f2008-11-10 02:56:27 +0000701 DICompileUnit CompileUnit,
702 unsigned LineNumber,
703 uint64_t SizeInBits,
704 uint64_t AlignInBits,
705 uint64_t OffsetInBits, unsigned Flags,
Devang Pateldd9db662009-01-30 18:20:31 +0000706 unsigned Encoding) {
Devang Patele4b27562009-08-28 23:24:31 +0000707 Value *Elts[] = {
Chris Lattnera45664f2008-11-10 02:56:27 +0000708 GetTagConstant(dwarf::DW_TAG_base_type),
Devang Patele4b27562009-08-28 23:24:31 +0000709 Context.getNode(),
710 MDString::get(VMContext, Name),
711 CompileUnit.getNode(),
Owen Anderson1d0be152009-08-13 21:58:54 +0000712 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
713 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
714 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
715 ConstantInt::get(Type::getInt64Ty(VMContext), OffsetInBits),
716 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
717 ConstantInt::get(Type::getInt32Ty(VMContext), Encoding)
Chris Lattnera45664f2008-11-10 02:56:27 +0000718 };
Devang Patele4b27562009-08-28 23:24:31 +0000719 return DIBasicType(MDNode::get(VMContext, &Elts[0], 10));
Chris Lattnera45664f2008-11-10 02:56:27 +0000720}
721
Devang Patelac16d442009-10-26 16:54:35 +0000722
723/// CreateBasicType - Create a basic type like int, float, etc.
724DIBasicType DIFactory::CreateBasicTypeEx(DIDescriptor Context,
Devang Patel65dbc902009-11-25 17:36:49 +0000725 StringRef Name,
Devang Patelac16d442009-10-26 16:54:35 +0000726 DICompileUnit CompileUnit,
727 unsigned LineNumber,
728 Constant *SizeInBits,
729 Constant *AlignInBits,
730 Constant *OffsetInBits, unsigned Flags,
731 unsigned Encoding) {
732 Value *Elts[] = {
733 GetTagConstant(dwarf::DW_TAG_base_type),
734 Context.getNode(),
735 MDString::get(VMContext, Name),
736 CompileUnit.getNode(),
737 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
738 SizeInBits,
739 AlignInBits,
740 OffsetInBits,
741 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
742 ConstantInt::get(Type::getInt32Ty(VMContext), Encoding)
743 };
744 return DIBasicType(MDNode::get(VMContext, &Elts[0], 10));
745}
746
Devang Patelb4645642010-02-06 01:02:37 +0000747/// CreateArtificialType - Create a new DIType with "artificial" flag set.
748DIType DIFactory::CreateArtificialType(DIType Ty) {
749 if (Ty.isArtificial())
750 return Ty;
751
752 SmallVector<Value *, 9> Elts;
753 MDNode *N = Ty.getNode();
754 assert (N && "Unexpected input DIType!");
755 for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i) {
756 if (Value *V = N->getOperand(i))
757 Elts.push_back(V);
758 else
759 Elts.push_back(Constant::getNullValue(Type::getInt32Ty(VMContext)));
760 }
761
762 unsigned CurFlags = Ty.getFlags();
763 CurFlags = CurFlags | DIType::FlagArtificial;
764
765 // Flags are stored at this slot.
766 Elts[8] = ConstantInt::get(Type::getInt32Ty(VMContext), CurFlags);
767
768 return DIType(MDNode::get(VMContext, Elts.data(), Elts.size()));
769}
Devang Patelac16d442009-10-26 16:54:35 +0000770
Chris Lattnera45664f2008-11-10 02:56:27 +0000771/// CreateDerivedType - Create a derived type like const qualified type,
772/// pointer, typedef, etc.
773DIDerivedType DIFactory::CreateDerivedType(unsigned Tag,
774 DIDescriptor Context,
Devang Patel65dbc902009-11-25 17:36:49 +0000775 StringRef Name,
Chris Lattnera45664f2008-11-10 02:56:27 +0000776 DICompileUnit CompileUnit,
777 unsigned LineNumber,
778 uint64_t SizeInBits,
779 uint64_t AlignInBits,
780 uint64_t OffsetInBits,
781 unsigned Flags,
Devang Pateldd9db662009-01-30 18:20:31 +0000782 DIType DerivedFrom) {
Devang Patele4b27562009-08-28 23:24:31 +0000783 Value *Elts[] = {
Chris Lattnera45664f2008-11-10 02:56:27 +0000784 GetTagConstant(Tag),
Devang Patele4b27562009-08-28 23:24:31 +0000785 Context.getNode(),
786 MDString::get(VMContext, Name),
787 CompileUnit.getNode(),
Owen Anderson1d0be152009-08-13 21:58:54 +0000788 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
789 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
790 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
791 ConstantInt::get(Type::getInt64Ty(VMContext), OffsetInBits),
792 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
Devang Patele4b27562009-08-28 23:24:31 +0000793 DerivedFrom.getNode(),
Chris Lattnera45664f2008-11-10 02:56:27 +0000794 };
Devang Patele4b27562009-08-28 23:24:31 +0000795 return DIDerivedType(MDNode::get(VMContext, &Elts[0], 10));
Chris Lattnera45664f2008-11-10 02:56:27 +0000796}
797
Devang Patelac16d442009-10-26 16:54:35 +0000798
799/// CreateDerivedType - Create a derived type like const qualified type,
800/// pointer, typedef, etc.
801DIDerivedType DIFactory::CreateDerivedTypeEx(unsigned Tag,
802 DIDescriptor Context,
Devang Patel65dbc902009-11-25 17:36:49 +0000803 StringRef Name,
Devang Patelac16d442009-10-26 16:54:35 +0000804 DICompileUnit CompileUnit,
805 unsigned LineNumber,
806 Constant *SizeInBits,
807 Constant *AlignInBits,
808 Constant *OffsetInBits,
809 unsigned Flags,
810 DIType DerivedFrom) {
811 Value *Elts[] = {
812 GetTagConstant(Tag),
813 Context.getNode(),
814 MDString::get(VMContext, Name),
815 CompileUnit.getNode(),
816 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
817 SizeInBits,
818 AlignInBits,
819 OffsetInBits,
820 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
821 DerivedFrom.getNode(),
822 };
823 return DIDerivedType(MDNode::get(VMContext, &Elts[0], 10));
824}
825
826
Chris Lattnera45664f2008-11-10 02:56:27 +0000827/// CreateCompositeType - Create a composite type like array, struct, etc.
828DICompositeType DIFactory::CreateCompositeType(unsigned Tag,
829 DIDescriptor Context,
Devang Patel65dbc902009-11-25 17:36:49 +0000830 StringRef Name,
Chris Lattnera45664f2008-11-10 02:56:27 +0000831 DICompileUnit CompileUnit,
832 unsigned LineNumber,
833 uint64_t SizeInBits,
834 uint64_t AlignInBits,
835 uint64_t OffsetInBits,
836 unsigned Flags,
837 DIType DerivedFrom,
Devang Patel13319ce2009-02-17 22:43:44 +0000838 DIArray Elements,
Devang Patel0fd7f9d2010-01-26 21:14:59 +0000839 unsigned RuntimeLang,
840 MDNode *ContainingType) {
Owen Andersone277fed2009-07-07 16:31:25 +0000841
Devang Patele4b27562009-08-28 23:24:31 +0000842 Value *Elts[] = {
Chris Lattnera45664f2008-11-10 02:56:27 +0000843 GetTagConstant(Tag),
Devang Patele4b27562009-08-28 23:24:31 +0000844 Context.getNode(),
845 MDString::get(VMContext, Name),
846 CompileUnit.getNode(),
Owen Anderson1d0be152009-08-13 21:58:54 +0000847 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
848 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
849 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
850 ConstantInt::get(Type::getInt64Ty(VMContext), OffsetInBits),
851 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
Devang Patele4b27562009-08-28 23:24:31 +0000852 DerivedFrom.getNode(),
853 Elements.getNode(),
Devang Patel0fd7f9d2010-01-26 21:14:59 +0000854 ConstantInt::get(Type::getInt32Ty(VMContext), RuntimeLang),
855 ContainingType
Chris Lattnera45664f2008-11-10 02:56:27 +0000856 };
Devang Patel0fd7f9d2010-01-26 21:14:59 +0000857 return DICompositeType(MDNode::get(VMContext, &Elts[0], 13));
Chris Lattnera45664f2008-11-10 02:56:27 +0000858}
859
860
Devang Patelac16d442009-10-26 16:54:35 +0000861/// CreateCompositeType - Create a composite type like array, struct, etc.
862DICompositeType DIFactory::CreateCompositeTypeEx(unsigned Tag,
863 DIDescriptor Context,
Devang Patel65dbc902009-11-25 17:36:49 +0000864 StringRef Name,
Devang Patelac16d442009-10-26 16:54:35 +0000865 DICompileUnit CompileUnit,
866 unsigned LineNumber,
867 Constant *SizeInBits,
868 Constant *AlignInBits,
869 Constant *OffsetInBits,
870 unsigned Flags,
871 DIType DerivedFrom,
872 DIArray Elements,
873 unsigned RuntimeLang) {
874
875 Value *Elts[] = {
876 GetTagConstant(Tag),
877 Context.getNode(),
878 MDString::get(VMContext, Name),
879 CompileUnit.getNode(),
880 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
881 SizeInBits,
882 AlignInBits,
883 OffsetInBits,
884 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
885 DerivedFrom.getNode(),
886 Elements.getNode(),
887 ConstantInt::get(Type::getInt32Ty(VMContext), RuntimeLang)
888 };
889 return DICompositeType(MDNode::get(VMContext, &Elts[0], 12));
890}
891
892
Chris Lattnera45664f2008-11-10 02:56:27 +0000893/// CreateSubprogram - Create a new descriptor for the specified subprogram.
894/// See comments in DISubprogram for descriptions of these fields. This
895/// method does not unique the generated descriptors.
Daniel Dunbarf612ff62009-09-19 20:40:05 +0000896DISubprogram DIFactory::CreateSubprogram(DIDescriptor Context,
Devang Patel65dbc902009-11-25 17:36:49 +0000897 StringRef Name,
898 StringRef DisplayName,
899 StringRef LinkageName,
Chris Lattnera45664f2008-11-10 02:56:27 +0000900 DICompileUnit CompileUnit,
Devang Patel2e369932010-01-23 00:26:28 +0000901 unsigned LineNo, DIType Ty,
Chris Lattnera45664f2008-11-10 02:56:27 +0000902 bool isLocalToUnit,
Devang Patel5d11eb02009-12-03 19:11:07 +0000903 bool isDefinition,
904 unsigned VK, unsigned VIndex,
Devang Patel4e0d19d2010-02-03 19:57:19 +0000905 DIType ContainingType,
906 bool isArtificial) {
Devang Patel854967e2008-12-17 22:39:29 +0000907
Devang Patele4b27562009-08-28 23:24:31 +0000908 Value *Elts[] = {
Chris Lattnera45664f2008-11-10 02:56:27 +0000909 GetTagConstant(dwarf::DW_TAG_subprogram),
Devang Patele4b27562009-08-28 23:24:31 +0000910 llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
911 Context.getNode(),
912 MDString::get(VMContext, Name),
913 MDString::get(VMContext, DisplayName),
914 MDString::get(VMContext, LinkageName),
915 CompileUnit.getNode(),
Owen Anderson1d0be152009-08-13 21:58:54 +0000916 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
Devang Patel2e369932010-01-23 00:26:28 +0000917 Ty.getNode(),
Owen Anderson1d0be152009-08-13 21:58:54 +0000918 ConstantInt::get(Type::getInt1Ty(VMContext), isLocalToUnit),
Devang Patel5d11eb02009-12-03 19:11:07 +0000919 ConstantInt::get(Type::getInt1Ty(VMContext), isDefinition),
920 ConstantInt::get(Type::getInt32Ty(VMContext), (unsigned)VK),
921 ConstantInt::get(Type::getInt32Ty(VMContext), VIndex),
Devang Patel4e0d19d2010-02-03 19:57:19 +0000922 ContainingType.getNode(),
923 ConstantInt::get(Type::getInt1Ty(VMContext), isArtificial)
Chris Lattnera45664f2008-11-10 02:56:27 +0000924 };
Devang Patel4e0d19d2010-02-03 19:57:19 +0000925 return DISubprogram(MDNode::get(VMContext, &Elts[0], 15));
Chris Lattnera45664f2008-11-10 02:56:27 +0000926}
927
Devang Patele3a18de2009-12-01 23:09:02 +0000928/// CreateSubprogramDefinition - Create new subprogram descriptor for the
929/// given declaration.
930DISubprogram DIFactory::CreateSubprogramDefinition(DISubprogram &SPDeclaration) {
931 if (SPDeclaration.isDefinition())
932 return DISubprogram(SPDeclaration.getNode());
933
934 MDNode *DeclNode = SPDeclaration.getNode();
935 Value *Elts[] = {
936 GetTagConstant(dwarf::DW_TAG_subprogram),
937 llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
Chris Lattner5d0cacd2009-12-31 01:22:29 +0000938 DeclNode->getOperand(2), // Context
939 DeclNode->getOperand(3), // Name
940 DeclNode->getOperand(4), // DisplayName
941 DeclNode->getOperand(5), // LinkageName
942 DeclNode->getOperand(6), // CompileUnit
943 DeclNode->getOperand(7), // LineNo
944 DeclNode->getOperand(8), // Type
945 DeclNode->getOperand(9), // isLocalToUnit
Devang Patel5d11eb02009-12-03 19:11:07 +0000946 ConstantInt::get(Type::getInt1Ty(VMContext), true),
Chris Lattner5d0cacd2009-12-31 01:22:29 +0000947 DeclNode->getOperand(11), // Virtuality
948 DeclNode->getOperand(12), // VIndex
Devang Patel4e0d19d2010-02-03 19:57:19 +0000949 DeclNode->getOperand(13), // Containting Type
950 DeclNode->getOperand(14) // isArtificial
Devang Patele3a18de2009-12-01 23:09:02 +0000951 };
Devang Patel4e0d19d2010-02-03 19:57:19 +0000952 return DISubprogram(MDNode::get(VMContext, &Elts[0], 15));
Devang Patele3a18de2009-12-01 23:09:02 +0000953}
954
Chris Lattnera45664f2008-11-10 02:56:27 +0000955/// CreateGlobalVariable - Create a new descriptor for the specified global.
956DIGlobalVariable
Devang Patel65dbc902009-11-25 17:36:49 +0000957DIFactory::CreateGlobalVariable(DIDescriptor Context, StringRef Name,
958 StringRef DisplayName,
959 StringRef LinkageName,
Chris Lattnera45664f2008-11-10 02:56:27 +0000960 DICompileUnit CompileUnit,
Devang Patel2e369932010-01-23 00:26:28 +0000961 unsigned LineNo, DIType Ty,bool isLocalToUnit,
Devang Pateldd9db662009-01-30 18:20:31 +0000962 bool isDefinition, llvm::GlobalVariable *Val) {
Daniel Dunbarf612ff62009-09-19 20:40:05 +0000963 Value *Elts[] = {
Chris Lattnera45664f2008-11-10 02:56:27 +0000964 GetTagConstant(dwarf::DW_TAG_variable),
Devang Patele4b27562009-08-28 23:24:31 +0000965 llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
966 Context.getNode(),
967 MDString::get(VMContext, Name),
968 MDString::get(VMContext, DisplayName),
969 MDString::get(VMContext, LinkageName),
970 CompileUnit.getNode(),
Owen Anderson1d0be152009-08-13 21:58:54 +0000971 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
Devang Patel2e369932010-01-23 00:26:28 +0000972 Ty.getNode(),
Owen Anderson1d0be152009-08-13 21:58:54 +0000973 ConstantInt::get(Type::getInt1Ty(VMContext), isLocalToUnit),
974 ConstantInt::get(Type::getInt1Ty(VMContext), isDefinition),
Devang Patele4b27562009-08-28 23:24:31 +0000975 Val
Chris Lattnera45664f2008-11-10 02:56:27 +0000976 };
Devang Patele4b27562009-08-28 23:24:31 +0000977
978 Value *const *Vs = &Elts[0];
979 MDNode *Node = MDNode::get(VMContext,Vs, 12);
980
981 // Create a named metadata so that we do not lose this mdnode.
982 NamedMDNode *NMD = M.getOrInsertNamedMetadata("llvm.dbg.gv");
Chris Lattner5d0cacd2009-12-31 01:22:29 +0000983 NMD->addOperand(Node);
Devang Patele4b27562009-08-28 23:24:31 +0000984
985 return DIGlobalVariable(Node);
Chris Lattnera45664f2008-11-10 02:56:27 +0000986}
987
988
989/// CreateVariable - Create a new descriptor for the specified variable.
990DIVariable DIFactory::CreateVariable(unsigned Tag, DIDescriptor Context,
Devang Patel65dbc902009-11-25 17:36:49 +0000991 StringRef Name,
Chris Lattnera45664f2008-11-10 02:56:27 +0000992 DICompileUnit CompileUnit, unsigned LineNo,
Devang Patel2e369932010-01-23 00:26:28 +0000993 DIType Ty) {
Devang Patele4b27562009-08-28 23:24:31 +0000994 Value *Elts[] = {
Chris Lattnera45664f2008-11-10 02:56:27 +0000995 GetTagConstant(Tag),
Devang Patele4b27562009-08-28 23:24:31 +0000996 Context.getNode(),
997 MDString::get(VMContext, Name),
998 CompileUnit.getNode(),
Owen Anderson1d0be152009-08-13 21:58:54 +0000999 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
Devang Patel2e369932010-01-23 00:26:28 +00001000 Ty.getNode(),
Chris Lattnera45664f2008-11-10 02:56:27 +00001001 };
Devang Patele4b27562009-08-28 23:24:31 +00001002 return DIVariable(MDNode::get(VMContext, &Elts[0], 6));
Chris Lattnera45664f2008-11-10 02:56:27 +00001003}
1004
1005
Mike Stump3e4c9bd2009-09-30 00:08:22 +00001006/// CreateComplexVariable - Create a new descriptor for the specified variable
1007/// which has a complex address expression for its address.
1008DIVariable DIFactory::CreateComplexVariable(unsigned Tag, DIDescriptor Context,
1009 const std::string &Name,
1010 DICompileUnit CompileUnit,
1011 unsigned LineNo,
Devang Patel2e369932010-01-23 00:26:28 +00001012 DIType Ty,
1013 SmallVector<Value *, 9> &addr) {
Mike Stump3e4c9bd2009-09-30 00:08:22 +00001014 SmallVector<Value *, 9> Elts;
1015 Elts.push_back(GetTagConstant(Tag));
1016 Elts.push_back(Context.getNode());
1017 Elts.push_back(MDString::get(VMContext, Name));
1018 Elts.push_back(CompileUnit.getNode());
1019 Elts.push_back(ConstantInt::get(Type::getInt32Ty(VMContext), LineNo));
Devang Patel2e369932010-01-23 00:26:28 +00001020 Elts.push_back(Ty.getNode());
Mike Stump3e4c9bd2009-09-30 00:08:22 +00001021 Elts.insert(Elts.end(), addr.begin(), addr.end());
1022
1023 return DIVariable(MDNode::get(VMContext, &Elts[0], 6+addr.size()));
1024}
1025
1026
Chris Lattnera45664f2008-11-10 02:56:27 +00001027/// CreateBlock - This creates a descriptor for a lexical block with the
Owen Anderson99035272009-07-07 17:12:53 +00001028/// specified parent VMContext.
Devang Patel3d821aa2010-02-16 21:39:34 +00001029DILexicalBlock DIFactory::CreateLexicalBlock(DIDescriptor Context,
1030 unsigned LineNo, unsigned Col) {
Devang Patele4b27562009-08-28 23:24:31 +00001031 Value *Elts[] = {
Chris Lattnera45664f2008-11-10 02:56:27 +00001032 GetTagConstant(dwarf::DW_TAG_lexical_block),
Devang Patel3d821aa2010-02-16 21:39:34 +00001033 Context.getNode(),
1034 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
1035 ConstantInt::get(Type::getInt32Ty(VMContext), Col)
Chris Lattnera45664f2008-11-10 02:56:27 +00001036 };
Devang Patel3d821aa2010-02-16 21:39:34 +00001037 return DILexicalBlock(MDNode::get(VMContext, &Elts[0], 4));
Chris Lattnera45664f2008-11-10 02:56:27 +00001038}
1039
Devang Patel6404e4e2009-12-15 19:16:48 +00001040/// CreateNameSpace - This creates new descriptor for a namespace
1041/// with the specified parent context.
1042DINameSpace DIFactory::CreateNameSpace(DIDescriptor Context, StringRef Name,
1043 DICompileUnit CompileUnit,
1044 unsigned LineNo) {
1045 Value *Elts[] = {
1046 GetTagConstant(dwarf::DW_TAG_namespace),
1047 Context.getNode(),
1048 MDString::get(VMContext, Name),
1049 CompileUnit.getNode(),
1050 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo)
1051 };
1052 return DINameSpace(MDNode::get(VMContext, &Elts[0], 5));
1053}
1054
Devang Patelf98d8fe2009-09-01 01:14:15 +00001055/// CreateLocation - Creates a debug info location.
Daniel Dunbarf612ff62009-09-19 20:40:05 +00001056DILocation DIFactory::CreateLocation(unsigned LineNo, unsigned ColumnNo,
Daniel Dunbara279bc32009-09-20 02:20:51 +00001057 DIScope S, DILocation OrigLoc) {
Devang Patelf98d8fe2009-09-01 01:14:15 +00001058 Value *Elts[] = {
1059 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
1060 ConstantInt::get(Type::getInt32Ty(VMContext), ColumnNo),
1061 S.getNode(),
1062 OrigLoc.getNode(),
1063 };
1064 return DILocation(MDNode::get(VMContext, &Elts[0], 4));
1065}
1066
Devang Patele54a5e82009-11-23 19:11:20 +00001067/// CreateLocation - Creates a debug info location.
1068DILocation DIFactory::CreateLocation(unsigned LineNo, unsigned ColumnNo,
1069 DIScope S, MDNode *OrigLoc) {
1070 Value *Elts[] = {
1071 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
1072 ConstantInt::get(Type::getInt32Ty(VMContext), ColumnNo),
1073 S.getNode(),
1074 OrigLoc
1075 };
1076 return DILocation(MDNode::get(VMContext, &Elts[0], 4));
1077}
Chris Lattnera45664f2008-11-10 02:56:27 +00001078
1079//===----------------------------------------------------------------------===//
1080// DIFactory: Routines for inserting code into a function
1081//===----------------------------------------------------------------------===//
1082
Chris Lattnera45664f2008-11-10 02:56:27 +00001083/// InsertDeclare - Insert a new llvm.dbg.declare intrinsic call.
Devang Patel6daf99b2009-11-10 22:05:35 +00001084Instruction *DIFactory::InsertDeclare(Value *Storage, DIVariable D,
Victor Hernandez5b7e48b2010-01-11 07:45:19 +00001085 Instruction *InsertBefore) {
Victor Hernandez4cf292a2010-01-26 02:07:38 +00001086 assert(Storage && "no storage passed to dbg.declare");
1087 assert(D.getNode() && "empty DIVariable passed to dbg.declare");
Chris Lattnera45664f2008-11-10 02:56:27 +00001088 if (!DeclareFn)
Bill Wendlingdc817b62009-05-14 18:26:15 +00001089 DeclareFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_declare);
1090
Victor Hernandez756462b2010-01-18 20:42:09 +00001091 Value *Args[] = { MDNode::get(Storage->getContext(), &Storage, 1),
1092 D.getNode() };
Devang Patel6daf99b2009-11-10 22:05:35 +00001093 return CallInst::Create(DeclareFn, Args, Args+2, "", InsertBefore);
Mike Stumpe4250392009-10-01 22:08:58 +00001094}
1095
1096/// InsertDeclare - Insert a new llvm.dbg.declare intrinsic call.
Devang Patel6daf99b2009-11-10 22:05:35 +00001097Instruction *DIFactory::InsertDeclare(Value *Storage, DIVariable D,
Victor Hernandez5b7e48b2010-01-11 07:45:19 +00001098 BasicBlock *InsertAtEnd) {
Victor Hernandez4cf292a2010-01-26 02:07:38 +00001099 assert(Storage && "no storage passed to dbg.declare");
1100 assert(D.getNode() && "empty DIVariable passed to dbg.declare");
Mike Stumpe4250392009-10-01 22:08:58 +00001101 if (!DeclareFn)
1102 DeclareFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_declare);
1103
Victor Hernandez756462b2010-01-18 20:42:09 +00001104 Value *Args[] = { MDNode::get(Storage->getContext(), &Storage, 1),
1105 D.getNode() };
Devang Patel27a53de2010-01-29 18:30:57 +00001106
1107 // If this block already has a terminator then insert this intrinsic
1108 // before the terminator.
1109 if (TerminatorInst *T = InsertAtEnd->getTerminator())
1110 return CallInst::Create(DeclareFn, Args, Args+2, "", T);
1111 else
1112 return CallInst::Create(DeclareFn, Args, Args+2, "", InsertAtEnd);}
Torok Edwin620f2802008-12-16 09:07:36 +00001113
Victor Hernandezc59b3352009-12-07 21:54:43 +00001114/// InsertDbgValueIntrinsic - Insert a new llvm.dbg.value intrinsic call.
Victor Hernandez5b7e48b2010-01-11 07:45:19 +00001115Instruction *DIFactory::InsertDbgValueIntrinsic(Value *V, uint64_t Offset,
Victor Hernandezc59b3352009-12-07 21:54:43 +00001116 DIVariable D,
1117 Instruction *InsertBefore) {
Victor Hernandez2f9dac72009-12-07 19:36:34 +00001118 assert(V && "no value passed to dbg.value");
Victor Hernandez4cf292a2010-01-26 02:07:38 +00001119 assert(D.getNode() && "empty DIVariable passed to dbg.value");
Victor Hernandez2f9dac72009-12-07 19:36:34 +00001120 if (!ValueFn)
1121 ValueFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_value);
1122
Victor Hernandezc8b7cd02010-01-20 05:44:11 +00001123 Value *Args[] = { MDNode::get(V->getContext(), &V, 1),
Victor Hernandez5b7e48b2010-01-11 07:45:19 +00001124 ConstantInt::get(Type::getInt64Ty(V->getContext()), Offset),
Victor Hernandez2f9dac72009-12-07 19:36:34 +00001125 D.getNode() };
1126 return CallInst::Create(ValueFn, Args, Args+3, "", InsertBefore);
1127}
1128
Victor Hernandezc59b3352009-12-07 21:54:43 +00001129/// InsertDbgValueIntrinsic - Insert a new llvm.dbg.value intrinsic call.
Victor Hernandez5b7e48b2010-01-11 07:45:19 +00001130Instruction *DIFactory::InsertDbgValueIntrinsic(Value *V, uint64_t Offset,
Victor Hernandezc59b3352009-12-07 21:54:43 +00001131 DIVariable D,
1132 BasicBlock *InsertAtEnd) {
Victor Hernandez2f9dac72009-12-07 19:36:34 +00001133 assert(V && "no value passed to dbg.value");
Victor Hernandez4cf292a2010-01-26 02:07:38 +00001134 assert(D.getNode() && "empty DIVariable passed to dbg.value");
Victor Hernandez2f9dac72009-12-07 19:36:34 +00001135 if (!ValueFn)
1136 ValueFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_value);
1137
Victor Hernandezc8b7cd02010-01-20 05:44:11 +00001138 Value *Args[] = { MDNode::get(V->getContext(), &V, 1),
Victor Hernandez5b7e48b2010-01-11 07:45:19 +00001139 ConstantInt::get(Type::getInt64Ty(V->getContext()), Offset),
Victor Hernandez2f9dac72009-12-07 19:36:34 +00001140 D.getNode() };
1141 return CallInst::Create(ValueFn, Args, Args+3, "", InsertAtEnd);
1142}
Devang Patele4b27562009-08-28 23:24:31 +00001143
Devang Pateld2f79a12009-07-28 19:55:13 +00001144//===----------------------------------------------------------------------===//
Devang Patel98c65172009-07-30 18:25:15 +00001145// DebugInfoFinder implementations.
Devang Pateld2f79a12009-07-28 19:55:13 +00001146//===----------------------------------------------------------------------===//
1147
Devang Patel98c65172009-07-30 18:25:15 +00001148/// processModule - Process entire module and collect debug info.
1149void DebugInfoFinder::processModule(Module &M) {
Chris Lattner08113472009-12-29 09:01:33 +00001150 unsigned MDDbgKind = M.getMDKindID("dbg");
Devang Patel70d75ca2009-11-12 19:02:56 +00001151
Devang Pateld2f79a12009-07-28 19:55:13 +00001152 for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
1153 for (Function::iterator FI = (*I).begin(), FE = (*I).end(); FI != FE; ++FI)
1154 for (BasicBlock::iterator BI = (*FI).begin(), BE = (*FI).end(); BI != BE;
1155 ++BI) {
Devang Patel70d75ca2009-11-12 19:02:56 +00001156 if (DbgDeclareInst *DDI = dyn_cast<DbgDeclareInst>(BI))
Devang Patelb4d31302009-07-31 18:18:52 +00001157 processDeclare(DDI);
Chris Lattner3990b122009-12-28 23:41:32 +00001158 else if (MDNode *L = BI->getMetadata(MDDbgKind))
Chris Lattner0eb41982009-12-28 20:45:51 +00001159 processLocation(DILocation(L));
Devang Pateld2f79a12009-07-28 19:55:13 +00001160 }
Devang Patele4b27562009-08-28 23:24:31 +00001161
1162 NamedMDNode *NMD = M.getNamedMetadata("llvm.dbg.gv");
1163 if (!NMD)
1164 return;
1165
Chris Lattner5d0cacd2009-12-31 01:22:29 +00001166 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
1167 DIGlobalVariable DIG(cast<MDNode>(NMD->getOperand(i)));
Devang Pateld2f79a12009-07-28 19:55:13 +00001168 if (addGlobalVariable(DIG)) {
1169 addCompileUnit(DIG.getCompileUnit());
Devang Patel98c65172009-07-30 18:25:15 +00001170 processType(DIG.getType());
Devang Pateld2f79a12009-07-28 19:55:13 +00001171 }
1172 }
1173}
Daniel Dunbarf612ff62009-09-19 20:40:05 +00001174
Devang Patel6daf99b2009-11-10 22:05:35 +00001175/// processLocation - Process DILocation.
1176void DebugInfoFinder::processLocation(DILocation Loc) {
Devang Patel3c91b052010-03-08 20:52:55 +00001177 if (!Loc.Verify()) return;
1178 DIDescriptor S(Loc.getScope().getNode());
Devang Patel6daf99b2009-11-10 22:05:35 +00001179 if (S.isCompileUnit())
1180 addCompileUnit(DICompileUnit(S.getNode()));
1181 else if (S.isSubprogram())
1182 processSubprogram(DISubprogram(S.getNode()));
1183 else if (S.isLexicalBlock())
1184 processLexicalBlock(DILexicalBlock(S.getNode()));
1185 processLocation(Loc.getOrigLocation());
1186}
1187
Devang Patel98c65172009-07-30 18:25:15 +00001188/// processType - Process DIType.
1189void DebugInfoFinder::processType(DIType DT) {
Devang Patel72bcdb62009-08-10 22:09:58 +00001190 if (!addType(DT))
Devang Pateld2f79a12009-07-28 19:55:13 +00001191 return;
1192
1193 addCompileUnit(DT.getCompileUnit());
Devang Patel6ceea332009-08-31 18:49:10 +00001194 if (DT.isCompositeType()) {
Devang Patele4b27562009-08-28 23:24:31 +00001195 DICompositeType DCT(DT.getNode());
Devang Patel98c65172009-07-30 18:25:15 +00001196 processType(DCT.getTypeDerivedFrom());
Devang Pateld2f79a12009-07-28 19:55:13 +00001197 DIArray DA = DCT.getTypeArray();
Devang Patel3c91b052010-03-08 20:52:55 +00001198 for (unsigned i = 0, e = DA.getNumElements(); i != e; ++i) {
1199 DIDescriptor D = DA.getElement(i);
1200 if (D.isType())
1201 processType(DIType(D.getNode()));
1202 else if (D.isSubprogram())
1203 processSubprogram(DISubprogram(D.getNode()));
1204 }
Devang Patel6ceea332009-08-31 18:49:10 +00001205 } else if (DT.isDerivedType()) {
Devang Patele4b27562009-08-28 23:24:31 +00001206 DIDerivedType DDT(DT.getNode());
Devang Patel3c91b052010-03-08 20:52:55 +00001207 processType(DDT.getTypeDerivedFrom());
Devang Pateld2f79a12009-07-28 19:55:13 +00001208 }
1209}
1210
Devang Patelbeab41b2009-10-07 22:04:08 +00001211/// processLexicalBlock
1212void DebugInfoFinder::processLexicalBlock(DILexicalBlock LB) {
Devang Patelbeab41b2009-10-07 22:04:08 +00001213 DIScope Context = LB.getContext();
1214 if (Context.isLexicalBlock())
1215 return processLexicalBlock(DILexicalBlock(Context.getNode()));
1216 else
1217 return processSubprogram(DISubprogram(Context.getNode()));
1218}
1219
Devang Patel98c65172009-07-30 18:25:15 +00001220/// processSubprogram - Process DISubprogram.
1221void DebugInfoFinder::processSubprogram(DISubprogram SP) {
Devang Pateld2f79a12009-07-28 19:55:13 +00001222 if (!addSubprogram(SP))
1223 return;
1224 addCompileUnit(SP.getCompileUnit());
Devang Patel98c65172009-07-30 18:25:15 +00001225 processType(SP.getType());
Devang Pateld2f79a12009-07-28 19:55:13 +00001226}
1227
Devang Patelb4d31302009-07-31 18:18:52 +00001228/// processDeclare - Process DbgDeclareInst.
1229void DebugInfoFinder::processDeclare(DbgDeclareInst *DDI) {
Devang Patel3c91b052010-03-08 20:52:55 +00001230 MDNode *N = dyn_cast<MDNode>(DDI->getVariable());
1231 if (!N) return;
1232
1233 DIDescriptor DV(N);
1234 if (!DV.isVariable())
Devang Patelb4d31302009-07-31 18:18:52 +00001235 return;
1236
Devang Patele4b27562009-08-28 23:24:31 +00001237 if (!NodesSeen.insert(DV.getNode()))
Devang Patelb4d31302009-07-31 18:18:52 +00001238 return;
1239
Devang Patel3c91b052010-03-08 20:52:55 +00001240 addCompileUnit(DIVariable(N).getCompileUnit());
1241 processType(DIVariable(N).getType());
Devang Patelb4d31302009-07-31 18:18:52 +00001242}
1243
Devang Patel72bcdb62009-08-10 22:09:58 +00001244/// addType - Add type into Tys.
1245bool DebugInfoFinder::addType(DIType DT) {
Devang Patel3c91b052010-03-08 20:52:55 +00001246 if (!DT.isValid())
Devang Patel72bcdb62009-08-10 22:09:58 +00001247 return false;
1248
Devang Patele4b27562009-08-28 23:24:31 +00001249 if (!NodesSeen.insert(DT.getNode()))
Devang Patel72bcdb62009-08-10 22:09:58 +00001250 return false;
1251
Devang Patele4b27562009-08-28 23:24:31 +00001252 TYs.push_back(DT.getNode());
Devang Patel72bcdb62009-08-10 22:09:58 +00001253 return true;
1254}
1255
Devang Pateld2f79a12009-07-28 19:55:13 +00001256/// addCompileUnit - Add compile unit into CUs.
Devang Patel98c65172009-07-30 18:25:15 +00001257bool DebugInfoFinder::addCompileUnit(DICompileUnit CU) {
Devang Patel3c91b052010-03-08 20:52:55 +00001258 if (!CU.Verify())
Devang Pateld2f79a12009-07-28 19:55:13 +00001259 return false;
1260
Devang Patele4b27562009-08-28 23:24:31 +00001261 if (!NodesSeen.insert(CU.getNode()))
Devang Pateld2f79a12009-07-28 19:55:13 +00001262 return false;
1263
Devang Patele4b27562009-08-28 23:24:31 +00001264 CUs.push_back(CU.getNode());
Devang Pateld2f79a12009-07-28 19:55:13 +00001265 return true;
1266}
Daniel Dunbarf612ff62009-09-19 20:40:05 +00001267
Devang Pateld2f79a12009-07-28 19:55:13 +00001268/// addGlobalVariable - Add global variable into GVs.
Devang Patel98c65172009-07-30 18:25:15 +00001269bool DebugInfoFinder::addGlobalVariable(DIGlobalVariable DIG) {
Devang Patel3c91b052010-03-08 20:52:55 +00001270 if (!DIDescriptor(DIG.getNode()).isGlobalVariable())
Devang Pateld2f79a12009-07-28 19:55:13 +00001271 return false;
1272
Devang Patele4b27562009-08-28 23:24:31 +00001273 if (!NodesSeen.insert(DIG.getNode()))
Devang Pateld2f79a12009-07-28 19:55:13 +00001274 return false;
1275
Devang Patele4b27562009-08-28 23:24:31 +00001276 GVs.push_back(DIG.getNode());
Devang Pateld2f79a12009-07-28 19:55:13 +00001277 return true;
1278}
1279
1280// addSubprogram - Add subprgoram into SPs.
Devang Patel98c65172009-07-30 18:25:15 +00001281bool DebugInfoFinder::addSubprogram(DISubprogram SP) {
Devang Patel3c91b052010-03-08 20:52:55 +00001282 if (!DIDescriptor(SP.getNode()).isSubprogram())
Devang Pateld2f79a12009-07-28 19:55:13 +00001283 return false;
Daniel Dunbarf612ff62009-09-19 20:40:05 +00001284
Devang Patele4b27562009-08-28 23:24:31 +00001285 if (!NodesSeen.insert(SP.getNode()))
Devang Pateld2f79a12009-07-28 19:55:13 +00001286 return false;
1287
Devang Patele4b27562009-08-28 23:24:31 +00001288 SPs.push_back(SP.getNode());
Devang Pateld2f79a12009-07-28 19:55:13 +00001289 return true;
1290}
1291
Victor Hernandez756462b2010-01-18 20:42:09 +00001292/// Find the debug info descriptor corresponding to this global variable.
1293static Value *findDbgGlobalDeclare(GlobalVariable *V) {
Chris Lattner099b7792009-12-29 09:22:47 +00001294 const Module *M = V->getParent();
1295 NamedMDNode *NMD = M->getNamedMetadata("llvm.dbg.gv");
1296 if (!NMD)
Torok Edwinff7d0e92009-03-10 13:41:26 +00001297 return 0;
Chris Lattner099b7792009-12-29 09:22:47 +00001298
Chris Lattner5d0cacd2009-12-31 01:22:29 +00001299 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
Devang Patel3c91b052010-03-08 20:52:55 +00001300 DIDescriptor DIG(cast_or_null<MDNode>(NMD->getOperand(i)));
1301 if (!DIG.isGlobalVariable())
Chris Lattner099b7792009-12-29 09:22:47 +00001302 continue;
Devang Patel3c91b052010-03-08 20:52:55 +00001303 if (DIGlobalVariable(DIG.getNode()).getGlobal() == V)
Chris Lattner099b7792009-12-29 09:22:47 +00001304 return DIG.getNode();
Torok Edwinff7d0e92009-03-10 13:41:26 +00001305 }
Chris Lattner099b7792009-12-29 09:22:47 +00001306 return 0;
1307}
Torok Edwinff7d0e92009-03-10 13:41:26 +00001308
Chris Lattner099b7792009-12-29 09:22:47 +00001309/// Finds the llvm.dbg.declare intrinsic corresponding to this value if any.
1310/// It looks through pointer casts too.
Victor Hernandez756462b2010-01-18 20:42:09 +00001311static const DbgDeclareInst *findDbgDeclare(const Value *V) {
Victor Hernandez3a328652010-01-15 19:04:09 +00001312 V = V->stripPointerCasts();
1313
1314 if (!isa<Instruction>(V) && !isa<Argument>(V))
Torok Edwin620f2802008-12-16 09:07:36 +00001315 return 0;
Victor Hernandez3a328652010-01-15 19:04:09 +00001316
1317 const Function *F = NULL;
1318 if (const Instruction *I = dyn_cast<Instruction>(V))
1319 F = I->getParent()->getParent();
1320 else if (const Argument *A = dyn_cast<Argument>(V))
1321 F = A->getParent();
1322
1323 for (Function::const_iterator FI = F->begin(), FE = F->end(); FI != FE; ++FI)
1324 for (BasicBlock::const_iterator BI = (*FI).begin(), BE = (*FI).end();
1325 BI != BE; ++BI)
1326 if (const DbgDeclareInst *DDI = dyn_cast<DbgDeclareInst>(BI))
1327 if (DDI->getAddress() == V)
1328 return DDI;
Bill Wendlingdc817b62009-05-14 18:26:15 +00001329
Chris Lattner099b7792009-12-29 09:22:47 +00001330 return 0;
1331}
Bill Wendlingdc817b62009-05-14 18:26:15 +00001332
Chris Lattner099b7792009-12-29 09:22:47 +00001333bool llvm::getLocationInfo(const Value *V, std::string &DisplayName,
1334 std::string &Type, unsigned &LineNo,
1335 std::string &File, std::string &Dir) {
1336 DICompileUnit Unit;
1337 DIType TypeD;
Bill Wendlingdc817b62009-05-14 18:26:15 +00001338
Chris Lattner099b7792009-12-29 09:22:47 +00001339 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(const_cast<Value*>(V))) {
1340 Value *DIGV = findDbgGlobalDeclare(GV);
1341 if (!DIGV) return false;
1342 DIGlobalVariable Var(cast<MDNode>(DIGV));
Bill Wendlingdc817b62009-05-14 18:26:15 +00001343
Chris Lattner099b7792009-12-29 09:22:47 +00001344 StringRef D = Var.getDisplayName();
Devang Patel65dbc902009-11-25 17:36:49 +00001345 if (!D.empty())
Chris Lattner099b7792009-12-29 09:22:47 +00001346 DisplayName = D;
1347 LineNo = Var.getLineNumber();
1348 Unit = Var.getCompileUnit();
1349 TypeD = Var.getType();
1350 } else {
1351 const DbgDeclareInst *DDI = findDbgDeclare(V);
1352 if (!DDI) return false;
1353 DIVariable Var(cast<MDNode>(DDI->getVariable()));
1354
1355 StringRef D = Var.getName();
1356 if (!D.empty())
1357 DisplayName = D;
1358 LineNo = Var.getLineNumber();
1359 Unit = Var.getCompileUnit();
1360 TypeD = Var.getType();
Torok Edwinff7d0e92009-03-10 13:41:26 +00001361 }
Devang Patel13e16b62009-06-26 01:49:18 +00001362
Chris Lattner099b7792009-12-29 09:22:47 +00001363 StringRef T = TypeD.getName();
1364 if (!T.empty())
1365 Type = T;
1366 StringRef F = Unit.getFilename();
1367 if (!F.empty())
1368 File = F;
1369 StringRef D = Unit.getDirectory();
1370 if (!D.empty())
1371 Dir = D;
1372 return true;
1373}
Devang Patel9e529c32009-07-02 01:15:24 +00001374
Chris Lattner099b7792009-12-29 09:22:47 +00001375/// ExtractDebugLocation - Extract debug location information
Chris Lattner099b7792009-12-29 09:22:47 +00001376/// from DILocation.
1377DebugLoc llvm::ExtractDebugLocation(DILocation &Loc,
1378 DebugLocTracker &DebugLocInfo) {
Devang Patel6b61f582010-01-16 06:09:35 +00001379 DenseMap<MDNode *, unsigned>::iterator II
1380 = DebugLocInfo.DebugIdMap.find(Loc.getNode());
Chris Lattner099b7792009-12-29 09:22:47 +00001381 if (II != DebugLocInfo.DebugIdMap.end())
1382 return DebugLoc::get(II->second);
Devang Patel1b75f442009-09-16 18:20:05 +00001383
Chris Lattner099b7792009-12-29 09:22:47 +00001384 // Add a new location entry.
1385 unsigned Id = DebugLocInfo.DebugLocations.size();
Devang Patel6b61f582010-01-16 06:09:35 +00001386 DebugLocInfo.DebugLocations.push_back(Loc.getNode());
1387 DebugLocInfo.DebugIdMap[Loc.getNode()] = Id;
Daniel Dunbarf612ff62009-09-19 20:40:05 +00001388
Chris Lattner099b7792009-12-29 09:22:47 +00001389 return DebugLoc::get(Id);
1390}
Devang Patel1b75f442009-09-16 18:20:05 +00001391
Chris Lattner099b7792009-12-29 09:22:47 +00001392/// getDISubprogram - Find subprogram that is enclosing this scope.
1393DISubprogram llvm::getDISubprogram(MDNode *Scope) {
1394 DIDescriptor D(Scope);
Chris Lattner099b7792009-12-29 09:22:47 +00001395 if (D.isSubprogram())
1396 return DISubprogram(Scope);
1397
1398 if (D.isLexicalBlock())
1399 return getDISubprogram(DILexicalBlock(Scope).getContext().getNode());
1400
1401 return DISubprogram();
1402}
Devang Patel193f7202009-11-24 01:14:22 +00001403
Chris Lattner099b7792009-12-29 09:22:47 +00001404/// getDICompositeType - Find underlying composite type.
1405DICompositeType llvm::getDICompositeType(DIType T) {
Chris Lattner099b7792009-12-29 09:22:47 +00001406 if (T.isCompositeType())
1407 return DICompositeType(T.getNode());
1408
1409 if (T.isDerivedType())
1410 return getDICompositeType(DIDerivedType(T.getNode()).getTypeDerivedFrom());
1411
1412 return DICompositeType();
Torok Edwin620f2802008-12-16 09:07:36 +00001413}