blob: ee53dffed0ee22503b322f9c16e876fdb0080d3e [file] [log] [blame]
Devang Patel35fcd652010-11-04 15:01:38 +00001//===--- DIBuilder.cpp - Debug Information Builder ------------------------===//
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 DIBuilder.
11//
12//===----------------------------------------------------------------------===//
13
Bill Wendling16eeb6f2012-06-29 08:32:07 +000014#include "llvm/DIBuilder.h"
Chandler Carruthd04a8d42012-12-03 16:50:05 +000015#include "llvm/ADT/STLExtras.h"
Bill Wendling0bcbd1d2012-06-28 00:05:13 +000016#include "llvm/DebugInfo.h"
Chandler Carruth0b8c9a82013-01-02 11:36:10 +000017#include "llvm/IR/Constants.h"
18#include "llvm/IR/IntrinsicInst.h"
19#include "llvm/IR/Module.h"
Eric Christopher6126a1e2012-04-03 00:43:49 +000020#include "llvm/Support/Debug.h"
Devang Patel35fcd652010-11-04 15:01:38 +000021#include "llvm/Support/Dwarf.h"
22
23using namespace llvm;
24using namespace llvm::dwarf;
25
26static Constant *GetTagConstant(LLVMContext &VMContext, unsigned Tag) {
27 assert((Tag & LLVMDebugVersionMask) == 0 &&
28 "Tag too large for debug encoding!");
29 return ConstantInt::get(Type::getInt32Ty(VMContext), Tag | LLVMDebugVersion);
30}
Devang Patel48f17ba2010-12-07 23:58:00 +000031
Devang Patel35fcd652010-11-04 15:01:38 +000032DIBuilder::DIBuilder(Module &m)
Eric Christopher6c0046f2011-08-26 21:02:40 +000033 : M(m), VMContext(M.getContext()), TheCU(0), TempEnumTypes(0),
34 TempRetainTypes(0), TempSubprograms(0), TempGVs(0), DeclareFn(0),
35 ValueFn(0)
Devang Patel94c7ddb2011-08-16 22:09:43 +000036{}
Devang Patel35fcd652010-11-04 15:01:38 +000037
Devang Patel6326a422011-08-15 23:00:00 +000038/// finalize - Construct any deferred debug info descriptors.
39void DIBuilder::finalize() {
Devang Patel94c7ddb2011-08-16 22:09:43 +000040 DIArray Enums = getOrCreateArray(AllEnumTypes);
41 DIType(TempEnumTypes).replaceAllUsesWith(Enums);
42
43 DIArray RetainTypes = getOrCreateArray(AllRetainTypes);
44 DIType(TempRetainTypes).replaceAllUsesWith(RetainTypes);
45
46 DIArray SPs = getOrCreateArray(AllSubprograms);
47 DIType(TempSubprograms).replaceAllUsesWith(SPs);
Devang Patel93d39be2011-08-19 23:28:12 +000048 for (unsigned i = 0, e = SPs.getNumElements(); i != e; ++i) {
49 DISubprogram SP(SPs.getElement(i));
Eric Christopher216432d2012-04-23 19:00:11 +000050 SmallVector<Value *, 4> Variables;
Devang Patel93d39be2011-08-19 23:28:12 +000051 if (NamedMDNode *NMD = getFnSpecificMDNode(M, SP)) {
Devang Patel93d39be2011-08-19 23:28:12 +000052 for (unsigned ii = 0, ee = NMD->getNumOperands(); ii != ee; ++ii)
53 Variables.push_back(NMD->getOperand(ii));
Devang Patel93d39be2011-08-19 23:28:12 +000054 NMD->eraseFromParent();
55 }
Eric Christopher216432d2012-04-23 19:00:11 +000056 if (MDNode *Temp = SP.getVariablesNodes()) {
57 DIArray AV = getOrCreateArray(Variables);
58 DIType(Temp).replaceAllUsesWith(AV);
59 }
Devang Patel93d39be2011-08-19 23:28:12 +000060 }
Devang Patel94c7ddb2011-08-16 22:09:43 +000061
62 DIArray GVs = getOrCreateArray(AllGVs);
63 DIType(TempGVs).replaceAllUsesWith(GVs);
64}
65
Eric Christopher6c0046f2011-08-26 21:02:40 +000066/// getNonCompileUnitScope - If N is compile unit return NULL otherwise return
67/// N.
Devang Patel94c7ddb2011-08-16 22:09:43 +000068static MDNode *getNonCompileUnitScope(MDNode *N) {
69 if (DIDescriptor(N).isCompileUnit())
70 return NULL;
71 return N;
Devang Patel6326a422011-08-15 23:00:00 +000072}
73
David Blaikie00c5c5d2013-03-20 23:58:12 +000074static MDNode *createFilePathPair(LLVMContext &VMContext, StringRef Filename,
75 StringRef Directory) {
76 assert(!Filename.empty() && "Unable to create file without name");
77 Value *Pair[] = {
78 MDString::get(VMContext, Filename),
79 MDString::get(VMContext, Directory),
80 };
81 return MDNode::get(VMContext, Pair);
82}
83
Devang Patel50d280c2011-02-22 18:56:12 +000084/// createCompileUnit - A CompileUnit provides an anchor for all debugging
Devang Patel35fcd652010-11-04 15:01:38 +000085/// information generated during this instance of compilation.
Eric Christopher6c0046f2011-08-26 21:02:40 +000086void DIBuilder::createCompileUnit(unsigned Lang, StringRef Filename,
87 StringRef Directory, StringRef Producer,
88 bool isOptimized, StringRef Flags,
Eric Christophere4b67902013-02-22 23:50:04 +000089 unsigned RunTimeVer, StringRef SplitName) {
Chandler Carruthb0dc4d92012-01-10 18:18:52 +000090 assert(((Lang <= dwarf::DW_LANG_Python && Lang >= dwarf::DW_LANG_C89) ||
91 (Lang <= dwarf::DW_LANG_hi_user && Lang >= dwarf::DW_LANG_lo_user)) &&
92 "Invalid Language tag");
93 assert(!Filename.empty() &&
94 "Unable to create compile unit without filename");
Devang Patel94c7ddb2011-08-16 22:09:43 +000095 Value *TElts[] = { GetTagConstant(VMContext, DW_TAG_base_type) };
96 TempEnumTypes = MDNode::getTemporary(VMContext, TElts);
Devang Patel94c7ddb2011-08-16 22:09:43 +000097
98 TempRetainTypes = MDNode::getTemporary(VMContext, TElts);
Devang Patel94c7ddb2011-08-16 22:09:43 +000099
100 TempSubprograms = MDNode::getTemporary(VMContext, TElts);
Devang Patel94c7ddb2011-08-16 22:09:43 +0000101
102 TempGVs = MDNode::getTemporary(VMContext, TElts);
Devang Patel94c7ddb2011-08-16 22:09:43 +0000103
Benjamin Kramer42c9b252010-11-04 18:45:27 +0000104 Value *Elts[] = {
105 GetTagConstant(VMContext, dwarf::DW_TAG_compile_unit),
David Blaikie00c5c5d2013-03-20 23:58:12 +0000106 createFilePathPair(VMContext, Filename, Directory),
David Blaikie342d92c2013-03-27 00:07:26 +0000107 NULL, // Imported modules
David Blaikie162c8002013-03-20 22:52:54 +0000108 ConstantInt::get(Type::getInt32Ty(VMContext), Lang),
Benjamin Kramer42c9b252010-11-04 18:45:27 +0000109 MDString::get(VMContext, Producer),
Benjamin Kramer42c9b252010-11-04 18:45:27 +0000110 ConstantInt::get(Type::getInt1Ty(VMContext), isOptimized),
111 MDString::get(VMContext, Flags),
Devang Patel94c7ddb2011-08-16 22:09:43 +0000112 ConstantInt::get(Type::getInt32Ty(VMContext), RunTimeVer),
David Blaikiea8eefc72013-02-02 05:56:24 +0000113 TempEnumTypes,
114 TempRetainTypes,
115 TempSubprograms,
Eric Christophere4b67902013-02-22 23:50:04 +0000116 TempGVs,
117 MDString::get(VMContext, SplitName)
Benjamin Kramer42c9b252010-11-04 18:45:27 +0000118 };
David Blaikie342d92c2013-03-27 00:07:26 +0000119 DICompileUnit CU(MDNode::get(VMContext, Elts));
120 assert(CU.Verify() && "The compile unit should be valid");
121 TheCU = CU;
Devang Patel464f4ef2011-05-03 16:18:28 +0000122
123 // Create a named metadata so that it is easier to find cu in a module.
124 NamedMDNode *NMD = M.getOrInsertNamedMetadata("llvm.dbg.cu");
125 NMD->addOperand(TheCU);
Devang Patel35fcd652010-11-04 15:01:38 +0000126}
127
Devang Patel50d280c2011-02-22 18:56:12 +0000128/// createFile - Create a file descriptor to hold debugging information
Devang Patel35fcd652010-11-04 15:01:38 +0000129/// for a file.
Devang Patel50d280c2011-02-22 18:56:12 +0000130DIFile DIBuilder::createFile(StringRef Filename, StringRef Directory) {
David Blaikieb4cf0ab2013-03-17 21:13:55 +0000131 Value *Elts[] = {
132 GetTagConstant(VMContext, dwarf::DW_TAG_file_type),
David Blaikie342d92c2013-03-27 00:07:26 +0000133 createFilePathPair(VMContext, Filename, Directory),
134 NULL // Imported modules
David Blaikieb4cf0ab2013-03-17 21:13:55 +0000135 };
David Blaikie342d92c2013-03-27 00:07:26 +0000136 DIFile F(MDNode::get(VMContext, Elts));
137 assert(F.Verify() && "The DIFile should be valid");
138 return F;
Devang Patel35fcd652010-11-04 15:01:38 +0000139}
140
Devang Patel50d280c2011-02-22 18:56:12 +0000141/// createEnumerator - Create a single enumerator value.
142DIEnumerator DIBuilder::createEnumerator(StringRef Name, uint64_t Val) {
Devang Patel811ae5b2011-09-12 18:26:08 +0000143 assert(!Name.empty() && "Unable to create enumerator without name");
Benjamin Kramer42c9b252010-11-04 18:45:27 +0000144 Value *Elts[] = {
145 GetTagConstant(VMContext, dwarf::DW_TAG_enumerator),
146 MDString::get(VMContext, Name),
147 ConstantInt::get(Type::getInt64Ty(VMContext), Val)
148 };
David Blaikie342d92c2013-03-27 00:07:26 +0000149 DIEnumerator E(MDNode::get(VMContext, Elts));
150 assert(E.Verify() && "The enumerator should be valid");
151 return E;
Devang Patel35fcd652010-11-04 15:01:38 +0000152}
153
Devang Patel734a67c2011-09-14 23:13:28 +0000154/// createNullPtrType - Create C++0x nullptr type.
155DIType DIBuilder::createNullPtrType(StringRef Name) {
156 assert(!Name.empty() && "Unable to create type without name");
157 // nullptr is encoded in DIBasicType format. Line number, filename,
158 // ,size, alignment, offset and flags are always empty here.
159 Value *Elts[] = {
160 GetTagConstant(VMContext, dwarf::DW_TAG_unspecified_type),
David Blaikiea13f3cd2013-03-19 23:25:22 +0000161 NULL, // Filename
David Blaikie342d92c2013-03-27 00:07:26 +0000162 Constant::getNullValue(Type::getInt32Ty(VMContext)), // Imported modules
Devang Patel734a67c2011-09-14 23:13:28 +0000163 NULL, //TheCU,
164 MDString::get(VMContext, Name),
Devang Patel734a67c2011-09-14 23:13:28 +0000165 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
166 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Size
167 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Align
168 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
169 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags;
Bill Wendling9fdb7c02012-07-06 17:49:19 +0000170 ConstantInt::get(Type::getInt32Ty(VMContext), 0) // Encoding
Devang Patel734a67c2011-09-14 23:13:28 +0000171 };
David Blaikie342d92c2013-03-27 00:07:26 +0000172 DIType T(MDNode::get(VMContext, Elts));
173 assert(T.Verify() && "The nullptr type should be valid");
174 return T;
Devang Patel734a67c2011-09-14 23:13:28 +0000175}
176
Eric Christopher6c0046f2011-08-26 21:02:40 +0000177/// createBasicType - Create debugging information entry for a basic
Devang Patel35fcd652010-11-04 15:01:38 +0000178/// type, e.g 'char'.
David Blaikie2ce067a2013-02-12 00:40:41 +0000179DIBasicType
180DIBuilder::createBasicType(StringRef Name, uint64_t SizeInBits,
181 uint64_t AlignInBits, unsigned Encoding) {
Devang Patel811ae5b2011-09-12 18:26:08 +0000182 assert(!Name.empty() && "Unable to create type without name");
Devang Patel35fcd652010-11-04 15:01:38 +0000183 // Basic types are encoded in DIBasicType format. Line number, filename,
184 // offset and flags are always empty here.
Benjamin Kramer42c9b252010-11-04 18:45:27 +0000185 Value *Elts[] = {
186 GetTagConstant(VMContext, dwarf::DW_TAG_base_type),
David Blaikiea13f3cd2013-03-19 23:25:22 +0000187 NULL, // File/directory name
David Blaikie342d92c2013-03-27 00:07:26 +0000188 NULL, // Imported modules
Devang Patel94c7ddb2011-08-16 22:09:43 +0000189 NULL, //TheCU,
Benjamin Kramer42c9b252010-11-04 18:45:27 +0000190 MDString::get(VMContext, Name),
Benjamin Kramer42c9b252010-11-04 18:45:27 +0000191 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
192 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
193 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
194 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
195 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags;
196 ConstantInt::get(Type::getInt32Ty(VMContext), Encoding)
197 };
David Blaikie342d92c2013-03-27 00:07:26 +0000198 DIBasicType T(MDNode::get(VMContext, Elts));
199 assert(T.Verify() && "The basic type should be valid");
200 return T;
Devang Patel35fcd652010-11-04 15:01:38 +0000201}
202
Nick Lewyckyffab7d02011-11-09 22:45:04 +0000203/// createQualifiedType - Create debugging information entry for a qualified
Devang Patel35fcd652010-11-04 15:01:38 +0000204/// type, e.g. 'const int'.
David Blaikied67c5ca2013-02-18 06:41:57 +0000205DIDerivedType DIBuilder::createQualifiedType(unsigned Tag, DIType FromTy) {
Benjamin Kramer42c9b252010-11-04 18:45:27 +0000206 // Qualified types are encoded in DIDerivedType format.
207 Value *Elts[] = {
208 GetTagConstant(VMContext, Tag),
David Blaikiea13f3cd2013-03-19 23:25:22 +0000209 NULL, // Filename
David Blaikie342d92c2013-03-27 00:07:26 +0000210 NULL, // Imported modules
Devang Patel94c7ddb2011-08-16 22:09:43 +0000211 NULL, //TheCU,
Benjamin Kramer42c9b252010-11-04 18:45:27 +0000212 MDString::get(VMContext, StringRef()), // Empty name.
Benjamin Kramer42c9b252010-11-04 18:45:27 +0000213 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
214 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Size
215 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Align
216 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
217 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags
218 FromTy
219 };
David Blaikie342d92c2013-03-27 00:07:26 +0000220 DIDerivedType T(MDNode::get(VMContext, Elts));
221 assert(T.Verify() && "The derived type should be valid");
222 return T;
Devang Patel35fcd652010-11-04 15:01:38 +0000223}
224
Devang Patel50d280c2011-02-22 18:56:12 +0000225/// createPointerType - Create debugging information entry for a pointer.
David Blaikied67c5ca2013-02-18 06:41:57 +0000226DIDerivedType
227DIBuilder::createPointerType(DIType PointeeTy, uint64_t SizeInBits,
228 uint64_t AlignInBits, StringRef Name) {
Benjamin Kramer42c9b252010-11-04 18:45:27 +0000229 // Pointer types are encoded in DIDerivedType format.
230 Value *Elts[] = {
231 GetTagConstant(VMContext, dwarf::DW_TAG_pointer_type),
David Blaikiea13f3cd2013-03-19 23:25:22 +0000232 NULL, // Filename
David Blaikie342d92c2013-03-27 00:07:26 +0000233 NULL, // Imported modules
Devang Patel94c7ddb2011-08-16 22:09:43 +0000234 NULL, //TheCU,
Benjamin Kramer42c9b252010-11-04 18:45:27 +0000235 MDString::get(VMContext, Name),
Benjamin Kramer42c9b252010-11-04 18:45:27 +0000236 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
237 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
238 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
239 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
240 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags
241 PointeeTy
242 };
David Blaikie342d92c2013-03-27 00:07:26 +0000243 DIDerivedType T(MDNode::get(VMContext, Elts));
244 assert(T.Verify() && "The pointer type should be valid");
245 return T;
Devang Patel35fcd652010-11-04 15:01:38 +0000246}
247
David Blaikied67c5ca2013-02-18 06:41:57 +0000248DIDerivedType DIBuilder::createMemberPointerType(DIType PointeeTy, DIType Base) {
David Blaikie62fdfb52013-01-07 05:51:15 +0000249 // Pointer types are encoded in DIDerivedType format.
250 Value *Elts[] = {
251 GetTagConstant(VMContext, dwarf::DW_TAG_ptr_to_member_type),
David Blaikiea13f3cd2013-03-19 23:25:22 +0000252 NULL, // Filename
David Blaikie342d92c2013-03-27 00:07:26 +0000253 NULL, // Imported modules
David Blaikie62fdfb52013-01-07 05:51:15 +0000254 NULL, //TheCU,
255 NULL,
David Blaikie62fdfb52013-01-07 05:51:15 +0000256 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
257 ConstantInt::get(Type::getInt64Ty(VMContext), 0),
258 ConstantInt::get(Type::getInt64Ty(VMContext), 0),
259 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
260 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags
261 PointeeTy,
262 Base
263 };
David Blaikie342d92c2013-03-27 00:07:26 +0000264 DIDerivedType T(MDNode::get(VMContext, Elts));
265 assert(T.Verify() && "The member pointer type should be valid");
266 return T;
David Blaikie62fdfb52013-01-07 05:51:15 +0000267}
268
Eric Christopher791e6292012-05-19 01:36:37 +0000269/// createReferenceType - Create debugging information entry for a reference
270/// type.
David Blaikied67c5ca2013-02-18 06:41:57 +0000271DIDerivedType DIBuilder::createReferenceType(unsigned Tag, DIType RTy) {
Devang Patel811ae5b2011-09-12 18:26:08 +0000272 assert(RTy.Verify() && "Unable to create reference type");
Benjamin Kramer42c9b252010-11-04 18:45:27 +0000273 // References are encoded in DIDerivedType format.
274 Value *Elts[] = {
Eric Christopher791e6292012-05-19 01:36:37 +0000275 GetTagConstant(VMContext, Tag),
David Blaikiea13f3cd2013-03-19 23:25:22 +0000276 NULL, // Filename
David Blaikie342d92c2013-03-27 00:07:26 +0000277 NULL, // Imported modules
Eric Christopher6c0046f2011-08-26 21:02:40 +0000278 NULL, // TheCU,
Benjamin Kramer42c9b252010-11-04 18:45:27 +0000279 NULL, // Name
Benjamin Kramer42c9b252010-11-04 18:45:27 +0000280 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
281 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Size
282 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Align
283 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
284 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags
285 RTy
286 };
David Blaikie342d92c2013-03-27 00:07:26 +0000287 DIDerivedType T(MDNode::get(VMContext, Elts));
288 assert(T.Verify() && "The reference type should be valid");
289 return T;
Devang Patel35fcd652010-11-04 15:01:38 +0000290}
291
Devang Patel50d280c2011-02-22 18:56:12 +0000292/// createTypedef - Create debugging information entry for a typedef.
David Blaikied67c5ca2013-02-18 06:41:57 +0000293DIDerivedType DIBuilder::createTypedef(DIType Ty, StringRef Name, DIFile File,
294 unsigned LineNo, DIDescriptor Context) {
Benjamin Kramer42c9b252010-11-04 18:45:27 +0000295 // typedefs are encoded in DIDerivedType format.
296 assert(Ty.Verify() && "Invalid typedef type!");
297 Value *Elts[] = {
298 GetTagConstant(VMContext, dwarf::DW_TAG_typedef),
David Blaikie4776bce2013-03-20 00:26:26 +0000299 File.getFileNode(),
David Blaikie342d92c2013-03-27 00:07:26 +0000300 NULL, // Imported modules
Devang Patel94c7ddb2011-08-16 22:09:43 +0000301 getNonCompileUnitScope(Context),
Benjamin Kramer42c9b252010-11-04 18:45:27 +0000302 MDString::get(VMContext, Name),
Benjamin Kramer42c9b252010-11-04 18:45:27 +0000303 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
304 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Size
305 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Align
306 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
307 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags
308 Ty
309 };
David Blaikie342d92c2013-03-27 00:07:26 +0000310 DIDerivedType T(MDNode::get(VMContext, Elts));
311 assert(T.Verify() && "The typedef Type should be valid");
312 return T;
Devang Patel35fcd652010-11-04 15:01:38 +0000313}
314
Devang Patel50d280c2011-02-22 18:56:12 +0000315/// createFriend - Create debugging information entry for a 'friend'.
316DIType DIBuilder::createFriend(DIType Ty, DIType FriendTy) {
Benjamin Kramer42c9b252010-11-04 18:45:27 +0000317 // typedefs are encoded in DIDerivedType format.
318 assert(Ty.Verify() && "Invalid type!");
319 assert(FriendTy.Verify() && "Invalid friend type!");
320 Value *Elts[] = {
321 GetTagConstant(VMContext, dwarf::DW_TAG_friend),
David Blaikiea13f3cd2013-03-19 23:25:22 +0000322 NULL,
David Blaikie342d92c2013-03-27 00:07:26 +0000323 NULL, // Imported modules
Benjamin Kramer42c9b252010-11-04 18:45:27 +0000324 Ty,
325 NULL, // Name
Benjamin Kramer42c9b252010-11-04 18:45:27 +0000326 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
327 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Size
328 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Align
329 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
330 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags
331 FriendTy
332 };
David Blaikie342d92c2013-03-27 00:07:26 +0000333 DIType T(MDNode::get(VMContext, Elts));
334 assert(T.Verify() && "The friend type should be valid");
335 return T;
Devang Patel35fcd652010-11-04 15:01:38 +0000336}
337
Devang Patel50d280c2011-02-22 18:56:12 +0000338/// createInheritance - Create debugging information entry to establish
Eric Christopherc27c7342011-09-12 19:58:22 +0000339/// inheritance relationship between two types.
David Blaikied67c5ca2013-02-18 06:41:57 +0000340DIDerivedType DIBuilder::createInheritance(
341 DIType Ty, DIType BaseTy, uint64_t BaseOffset, unsigned Flags) {
Devang Patel811ae5b2011-09-12 18:26:08 +0000342 assert(Ty.Verify() && "Unable to create inheritance");
Benjamin Kramer42c9b252010-11-04 18:45:27 +0000343 // TAG_inheritance is encoded in DIDerivedType format.
344 Value *Elts[] = {
345 GetTagConstant(VMContext, dwarf::DW_TAG_inheritance),
David Blaikiea13f3cd2013-03-19 23:25:22 +0000346 NULL,
David Blaikie342d92c2013-03-27 00:07:26 +0000347 NULL, // Imported modules
Benjamin Kramer42c9b252010-11-04 18:45:27 +0000348 Ty,
349 NULL, // Name
Benjamin Kramer42c9b252010-11-04 18:45:27 +0000350 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
351 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Size
352 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Align
353 ConstantInt::get(Type::getInt64Ty(VMContext), BaseOffset),
354 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
355 BaseTy
356 };
David Blaikie342d92c2013-03-27 00:07:26 +0000357 DIDerivedType T(MDNode::get(VMContext, Elts));
358 assert(T.Verify() && "The inheritance type should be valid");
359 return T;
Devang Patel35fcd652010-11-04 15:01:38 +0000360}
361
Devang Patel50d280c2011-02-22 18:56:12 +0000362/// createMemberType - Create debugging information entry for a member.
David Blaikied67c5ca2013-02-18 06:41:57 +0000363DIDerivedType DIBuilder::createMemberType(
364 DIDescriptor Scope, StringRef Name, DIFile File, unsigned LineNumber,
365 uint64_t SizeInBits, uint64_t AlignInBits, uint64_t OffsetInBits,
366 unsigned Flags, DIType Ty) {
Benjamin Kramer42c9b252010-11-04 18:45:27 +0000367 // TAG_member is encoded in DIDerivedType format.
368 Value *Elts[] = {
369 GetTagConstant(VMContext, dwarf::DW_TAG_member),
David Blaikie4776bce2013-03-20 00:26:26 +0000370 File.getFileNode(),
David Blaikie342d92c2013-03-27 00:07:26 +0000371 NULL, // Imported modules
Devang Patel94c7ddb2011-08-16 22:09:43 +0000372 getNonCompileUnitScope(Scope),
Benjamin Kramer42c9b252010-11-04 18:45:27 +0000373 MDString::get(VMContext, Name),
Benjamin Kramer42c9b252010-11-04 18:45:27 +0000374 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
375 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
376 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
377 ConstantInt::get(Type::getInt64Ty(VMContext), OffsetInBits),
378 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
379 Ty
380 };
David Blaikie342d92c2013-03-27 00:07:26 +0000381 DIDerivedType T(MDNode::get(VMContext, Elts));
382 assert(T.Verify() && "The member type should be valid");
383 return T;
Devang Patel35fcd652010-11-04 15:01:38 +0000384}
385
Eric Christopher6b6061f2013-01-16 01:22:23 +0000386/// createStaticMemberType - Create debugging information entry for a
387/// C++ static data member.
388DIType DIBuilder::createStaticMemberType(DIDescriptor Scope, StringRef Name,
389 DIFile File, unsigned LineNumber,
390 DIType Ty, unsigned Flags,
391 llvm::Value *Val) {
392 // TAG_member is encoded in DIDerivedType format.
393 Flags |= DIDescriptor::FlagStaticMember;
394 Value *Elts[] = {
395 GetTagConstant(VMContext, dwarf::DW_TAG_member),
David Blaikie4776bce2013-03-20 00:26:26 +0000396 File.getFileNode(),
David Blaikie342d92c2013-03-27 00:07:26 +0000397 NULL, // Imported modules
Eric Christopher6b6061f2013-01-16 01:22:23 +0000398 getNonCompileUnitScope(Scope),
399 MDString::get(VMContext, Name),
Eric Christopher6b6061f2013-01-16 01:22:23 +0000400 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
401 ConstantInt::get(Type::getInt64Ty(VMContext), 0/*SizeInBits*/),
402 ConstantInt::get(Type::getInt64Ty(VMContext), 0/*AlignInBits*/),
403 ConstantInt::get(Type::getInt64Ty(VMContext), 0/*OffsetInBits*/),
404 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
405 Ty,
406 Val
407 };
David Blaikie342d92c2013-03-27 00:07:26 +0000408 DIType T(MDNode::get(VMContext, Elts));
409 assert(T.Verify() && "The static member type should be valid");
410 return T;
Eric Christopher6b6061f2013-01-16 01:22:23 +0000411}
412
Devang Patele9db5e22011-04-16 00:11:51 +0000413/// createObjCIVar - Create debugging information entry for Objective-C
414/// instance variable.
Eric Christopher6c0046f2011-08-26 21:02:40 +0000415DIType DIBuilder::createObjCIVar(StringRef Name,
416 DIFile File, unsigned LineNumber,
Devang Patele9db5e22011-04-16 00:11:51 +0000417 uint64_t SizeInBits, uint64_t AlignInBits,
Eric Christopher6c0046f2011-08-26 21:02:40 +0000418 uint64_t OffsetInBits, unsigned Flags,
Devang Patele9db5e22011-04-16 00:11:51 +0000419 DIType Ty, StringRef PropertyName,
420 StringRef GetterName, StringRef SetterName,
421 unsigned PropertyAttributes) {
422 // TAG_member is encoded in DIDerivedType format.
423 Value *Elts[] = {
424 GetTagConstant(VMContext, dwarf::DW_TAG_member),
David Blaikie4776bce2013-03-20 00:26:26 +0000425 File.getFileNode(),
David Blaikie342d92c2013-03-27 00:07:26 +0000426 NULL, // Imported modules
Devang Patel94c7ddb2011-08-16 22:09:43 +0000427 getNonCompileUnitScope(File),
Devang Patele9db5e22011-04-16 00:11:51 +0000428 MDString::get(VMContext, Name),
Devang Patele9db5e22011-04-16 00:11:51 +0000429 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
430 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
431 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
432 ConstantInt::get(Type::getInt64Ty(VMContext), OffsetInBits),
433 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
434 Ty,
435 MDString::get(VMContext, PropertyName),
436 MDString::get(VMContext, GetterName),
437 MDString::get(VMContext, SetterName),
438 ConstantInt::get(Type::getInt32Ty(VMContext), PropertyAttributes)
439 };
David Blaikie342d92c2013-03-27 00:07:26 +0000440 DIType T(MDNode::get(VMContext, Elts));
441 assert(T.Verify() && "The Objective-C IVar type should be valid");
442 return T;
Devang Patele9db5e22011-04-16 00:11:51 +0000443}
444
Devang Patel6588abf2012-02-06 17:49:43 +0000445/// createObjCIVar - Create debugging information entry for Objective-C
446/// instance variable.
447DIType DIBuilder::createObjCIVar(StringRef Name,
448 DIFile File, unsigned LineNumber,
449 uint64_t SizeInBits, uint64_t AlignInBits,
450 uint64_t OffsetInBits, unsigned Flags,
451 DIType Ty, MDNode *PropertyNode) {
452 // TAG_member is encoded in DIDerivedType format.
453 Value *Elts[] = {
454 GetTagConstant(VMContext, dwarf::DW_TAG_member),
David Blaikie4776bce2013-03-20 00:26:26 +0000455 File.getFileNode(),
David Blaikie342d92c2013-03-27 00:07:26 +0000456 NULL, // Imported modules
Devang Patel6588abf2012-02-06 17:49:43 +0000457 getNonCompileUnitScope(File),
458 MDString::get(VMContext, Name),
Devang Patel6588abf2012-02-06 17:49:43 +0000459 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
460 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
461 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
462 ConstantInt::get(Type::getInt64Ty(VMContext), OffsetInBits),
463 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
464 Ty,
465 PropertyNode
466 };
David Blaikie342d92c2013-03-27 00:07:26 +0000467 DIType T(MDNode::get(VMContext, Elts));
468 assert(T.Verify() && "The Objective-C IVar type should be valid");
469 return T;
Devang Patel6588abf2012-02-06 17:49:43 +0000470}
471
Devang Patel1ea02d42012-02-04 00:59:25 +0000472/// createObjCProperty - Create debugging information entry for Objective-C
473/// property.
Eric Christopherb8ca9882012-03-29 08:42:56 +0000474DIObjCProperty DIBuilder::createObjCProperty(StringRef Name,
Eric Christopher87c06a82012-07-06 02:35:57 +0000475 DIFile File, unsigned LineNumber,
Devang Patel1ea02d42012-02-04 00:59:25 +0000476 StringRef GetterName,
477 StringRef SetterName,
Eric Christopherb8ca9882012-03-29 08:42:56 +0000478 unsigned PropertyAttributes,
Eric Christopher87c06a82012-07-06 02:35:57 +0000479 DIType Ty) {
Devang Patel1ea02d42012-02-04 00:59:25 +0000480 Value *Elts[] = {
Eric Christopher6c31ee22012-03-29 21:35:05 +0000481 GetTagConstant(VMContext, dwarf::DW_TAG_APPLE_property),
Devang Patel1ea02d42012-02-04 00:59:25 +0000482 MDString::get(VMContext, Name),
Eric Christopherb8ca9882012-03-29 08:42:56 +0000483 File,
484 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
Devang Patel1ea02d42012-02-04 00:59:25 +0000485 MDString::get(VMContext, GetterName),
486 MDString::get(VMContext, SetterName),
Eric Christopherb8ca9882012-03-29 08:42:56 +0000487 ConstantInt::get(Type::getInt32Ty(VMContext), PropertyAttributes),
488 Ty
Devang Patel1ea02d42012-02-04 00:59:25 +0000489 };
David Blaikie342d92c2013-03-27 00:07:26 +0000490 DIObjCProperty P(MDNode::get(VMContext, Elts));
491 assert(P.Verify() && "The Objective-C property should be valid");
492 return P;
Devang Patel1ea02d42012-02-04 00:59:25 +0000493}
494
Devang Patel50d280c2011-02-22 18:56:12 +0000495/// createTemplateTypeParameter - Create debugging information for template
Devang Patel7e2cb112011-02-02 21:38:25 +0000496/// type parameter.
Eric Christopher6c0046f2011-08-26 21:02:40 +0000497DITemplateTypeParameter
Devang Patel50d280c2011-02-22 18:56:12 +0000498DIBuilder::createTemplateTypeParameter(DIDescriptor Context, StringRef Name,
Devang Patel7e2cb112011-02-02 21:38:25 +0000499 DIType Ty, MDNode *File, unsigned LineNo,
500 unsigned ColumnNo) {
501 Value *Elts[] = {
502 GetTagConstant(VMContext, dwarf::DW_TAG_template_type_parameter),
Devang Patel94c7ddb2011-08-16 22:09:43 +0000503 getNonCompileUnitScope(Context),
Devang Patel7e2cb112011-02-02 21:38:25 +0000504 MDString::get(VMContext, Name),
505 Ty,
506 File,
507 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
508 ConstantInt::get(Type::getInt32Ty(VMContext), ColumnNo)
509 };
David Blaikie342d92c2013-03-27 00:07:26 +0000510 DITemplateTypeParameter P(MDNode::get(VMContext, Elts));
511 assert(P.Verify() && "The template type parameter should be valid");
512 return P;
Devang Patel7e2cb112011-02-02 21:38:25 +0000513}
514
Devang Patel50d280c2011-02-22 18:56:12 +0000515/// createTemplateValueParameter - Create debugging information for template
Devang Patele7d93872011-02-02 22:35:53 +0000516/// value parameter.
Eric Christopher6c0046f2011-08-26 21:02:40 +0000517DITemplateValueParameter
Devang Patel50d280c2011-02-22 18:56:12 +0000518DIBuilder::createTemplateValueParameter(DIDescriptor Context, StringRef Name,
Devang Patele7d93872011-02-02 22:35:53 +0000519 DIType Ty, uint64_t Val,
520 MDNode *File, unsigned LineNo,
521 unsigned ColumnNo) {
522 Value *Elts[] = {
523 GetTagConstant(VMContext, dwarf::DW_TAG_template_value_parameter),
Devang Patel94c7ddb2011-08-16 22:09:43 +0000524 getNonCompileUnitScope(Context),
Devang Patele7d93872011-02-02 22:35:53 +0000525 MDString::get(VMContext, Name),
526 Ty,
527 ConstantInt::get(Type::getInt64Ty(VMContext), Val),
528 File,
529 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
530 ConstantInt::get(Type::getInt32Ty(VMContext), ColumnNo)
531 };
David Blaikie342d92c2013-03-27 00:07:26 +0000532 DITemplateValueParameter P(MDNode::get(VMContext, Elts));
533 assert(P.Verify() && "The template value parameter should be valid");
534 return P;
Devang Patele7d93872011-02-02 22:35:53 +0000535}
536
Eric Christopher87c06a82012-07-06 02:35:57 +0000537/// createClassType - Create debugging information entry for a class.
David Blaikieca442a42013-03-26 23:46:39 +0000538DICompositeType DIBuilder::createClassType(DIDescriptor Context, StringRef Name,
539 DIFile File, unsigned LineNumber,
540 uint64_t SizeInBits,
541 uint64_t AlignInBits,
542 uint64_t OffsetInBits,
543 unsigned Flags, DIType DerivedFrom,
544 DIArray Elements,
545 MDNode *VTableHolder,
546 MDNode *TemplateParams) {
David Blaikie66438682013-03-11 23:21:19 +0000547 assert((!Context || Context.Verify()) &&
548 "createClassType should be called with a valid Context");
549 // TAG_class_type is encoded in DICompositeType format.
Eric Christopher87c06a82012-07-06 02:35:57 +0000550 Value *Elts[] = {
551 GetTagConstant(VMContext, dwarf::DW_TAG_class_type),
David Blaikie4776bce2013-03-20 00:26:26 +0000552 File.getFileNode(),
David Blaikie342d92c2013-03-27 00:07:26 +0000553 NULL, // Imported modules
Eric Christopher87c06a82012-07-06 02:35:57 +0000554 getNonCompileUnitScope(Context),
555 MDString::get(VMContext, Name),
Eric Christopher87c06a82012-07-06 02:35:57 +0000556 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
557 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
558 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
559 ConstantInt::get(Type::getInt32Ty(VMContext), OffsetInBits),
560 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
561 DerivedFrom,
562 Elements,
563 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
564 VTableHolder,
565 TemplateParams
566 };
David Blaikieca442a42013-03-26 23:46:39 +0000567 DICompositeType R(MDNode::get(VMContext, Elts));
David Blaikie66438682013-03-11 23:21:19 +0000568 assert(R.Verify() && "createClassType should return a verifiable DIType");
569 return R;
Eric Christopher87c06a82012-07-06 02:35:57 +0000570}
571
Devang Patel50d280c2011-02-22 18:56:12 +0000572/// createStructType - Create debugging information entry for a struct.
David Blaikie6172f022013-02-25 01:07:18 +0000573DICompositeType DIBuilder::createStructType(DIDescriptor Context,
574 StringRef Name, DIFile File,
575 unsigned LineNumber,
576 uint64_t SizeInBits,
577 uint64_t AlignInBits,
578 unsigned Flags, DIType DerivedFrom,
579 DIArray Elements,
580 unsigned RunTimeLang,
581 MDNode *VTableHolder) {
Devang Patelfe58f952010-12-07 23:25:47 +0000582 // TAG_structure_type is encoded in DICompositeType format.
583 Value *Elts[] = {
584 GetTagConstant(VMContext, dwarf::DW_TAG_structure_type),
David Blaikie4776bce2013-03-20 00:26:26 +0000585 File.getFileNode(),
David Blaikie342d92c2013-03-27 00:07:26 +0000586 NULL, // Imported modules
Devang Patel94c7ddb2011-08-16 22:09:43 +0000587 getNonCompileUnitScope(Context),
Devang Patelfe58f952010-12-07 23:25:47 +0000588 MDString::get(VMContext, Name),
Devang Patelfe58f952010-12-07 23:25:47 +0000589 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
590 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
591 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
Devang Patel43c249c2010-12-08 01:50:15 +0000592 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
Devang Patelfe58f952010-12-07 23:25:47 +0000593 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
David Blaikie6172f022013-02-25 01:07:18 +0000594 DerivedFrom,
Devang Patelfe58f952010-12-07 23:25:47 +0000595 Elements,
596 ConstantInt::get(Type::getInt32Ty(VMContext), RunTimeLang),
David Blaikie6172f022013-02-25 01:07:18 +0000597 VTableHolder,
David Blaikied4f92fd2013-02-18 07:27:30 +0000598 NULL,
Devang Patelfe58f952010-12-07 23:25:47 +0000599 };
David Blaikie66438682013-03-11 23:21:19 +0000600 DICompositeType R(MDNode::get(VMContext, Elts));
601 assert(R.Verify() && "createStructType should return a verifiable DIType");
602 return R;
Devang Patelfe58f952010-12-07 23:25:47 +0000603}
604
Devang Patel50d280c2011-02-22 18:56:12 +0000605/// createUnionType - Create debugging information entry for an union.
David Blaikied67c5ca2013-02-18 06:41:57 +0000606DICompositeType DIBuilder::createUnionType(
607 DIDescriptor Scope, StringRef Name, DIFile File, unsigned LineNumber,
608 uint64_t SizeInBits, uint64_t AlignInBits, unsigned Flags, DIArray Elements,
609 unsigned RunTimeLang) {
Devang Patel43c249c2010-12-08 01:50:15 +0000610 // TAG_union_type is encoded in DICompositeType format.
611 Value *Elts[] = {
612 GetTagConstant(VMContext, dwarf::DW_TAG_union_type),
David Blaikie4776bce2013-03-20 00:26:26 +0000613 File.getFileNode(),
David Blaikie342d92c2013-03-27 00:07:26 +0000614 NULL, // Imported modules
Devang Patel94c7ddb2011-08-16 22:09:43 +0000615 getNonCompileUnitScope(Scope),
Devang Patel43c249c2010-12-08 01:50:15 +0000616 MDString::get(VMContext, Name),
Devang Patel43c249c2010-12-08 01:50:15 +0000617 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
618 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
619 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
620 ConstantInt::get(Type::getInt64Ty(VMContext), 0),
621 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
Devang Patelc104cf22011-12-16 17:51:31 +0000622 NULL,
Devang Patel43c249c2010-12-08 01:50:15 +0000623 Elements,
624 ConstantInt::get(Type::getInt32Ty(VMContext), RunTimeLang),
Bill Wendling9fdb7c02012-07-06 17:49:19 +0000625 Constant::getNullValue(Type::getInt32Ty(VMContext))
Devang Patel43c249c2010-12-08 01:50:15 +0000626 };
David Blaikie342d92c2013-03-27 00:07:26 +0000627 DICompositeType T(MDNode::get(VMContext, Elts));
628 assert(T.Verify() && "The union type should be valid");
629 return T;
Devang Patel43c249c2010-12-08 01:50:15 +0000630}
631
Devang Patel50d280c2011-02-22 18:56:12 +0000632/// createSubroutineType - Create subroutine type.
David Blaikied67c5ca2013-02-18 06:41:57 +0000633DICompositeType
634DIBuilder::createSubroutineType(DIFile File, DIArray ParameterTypes) {
Devang Patel43c249c2010-12-08 01:50:15 +0000635 // TAG_subroutine_type is encoded in DICompositeType format.
636 Value *Elts[] = {
637 GetTagConstant(VMContext, dwarf::DW_TAG_subroutine_type),
Bill Wendlingf46b4972012-07-06 17:47:36 +0000638 Constant::getNullValue(Type::getInt32Ty(VMContext)),
David Blaikie342d92c2013-03-27 00:07:26 +0000639 Constant::getNullValue(Type::getInt32Ty(VMContext)), // Imported modules
Bill Wendlingf46b4972012-07-06 17:47:36 +0000640 Constant::getNullValue(Type::getInt32Ty(VMContext)),
David Blaikiea13f3cd2013-03-19 23:25:22 +0000641 MDString::get(VMContext, ""),
Devang Patel43c249c2010-12-08 01:50:15 +0000642 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
643 ConstantInt::get(Type::getInt64Ty(VMContext), 0),
644 ConstantInt::get(Type::getInt64Ty(VMContext), 0),
Devang Patelc104cf22011-12-16 17:51:31 +0000645 ConstantInt::get(Type::getInt64Ty(VMContext), 0),
Devang Patel43c249c2010-12-08 01:50:15 +0000646 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
Devang Patelc104cf22011-12-16 17:51:31 +0000647 NULL,
Devang Patel43c249c2010-12-08 01:50:15 +0000648 ParameterTypes,
649 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
Bill Wendling9fdb7c02012-07-06 17:49:19 +0000650 Constant::getNullValue(Type::getInt32Ty(VMContext))
Devang Patel43c249c2010-12-08 01:50:15 +0000651 };
David Blaikie342d92c2013-03-27 00:07:26 +0000652 DICompositeType T(MDNode::get(VMContext, Elts));
653 assert(T.Verify() && "The subroutine type should be valid");
654 return T;
Devang Patel43c249c2010-12-08 01:50:15 +0000655}
656
Eric Christopher6c0046f2011-08-26 21:02:40 +0000657/// createEnumerationType - Create debugging information entry for an
Devang Patel43c249c2010-12-08 01:50:15 +0000658/// enumeration.
David Blaikied67c5ca2013-02-18 06:41:57 +0000659DICompositeType DIBuilder::createEnumerationType(
660 DIDescriptor Scope, StringRef Name, DIFile File, unsigned LineNumber,
661 uint64_t SizeInBits, uint64_t AlignInBits, DIArray Elements,
662 DIType ClassType) {
Devang Patel43c249c2010-12-08 01:50:15 +0000663 // TAG_enumeration_type is encoded in DICompositeType format.
664 Value *Elts[] = {
665 GetTagConstant(VMContext, dwarf::DW_TAG_enumeration_type),
David Blaikie4776bce2013-03-20 00:26:26 +0000666 File.getFileNode(),
David Blaikie342d92c2013-03-27 00:07:26 +0000667 NULL, // Imported modules
Devang Patel94c7ddb2011-08-16 22:09:43 +0000668 getNonCompileUnitScope(Scope),
Devang Patel43c249c2010-12-08 01:50:15 +0000669 MDString::get(VMContext, Name),
Devang Patel43c249c2010-12-08 01:50:15 +0000670 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
671 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
672 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
673 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
Eli Friedmance3da6f2012-10-05 01:49:14 +0000674 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
Eric Christopherbb0f6ea2012-05-23 00:09:20 +0000675 ClassType,
Devang Patel43c249c2010-12-08 01:50:15 +0000676 Elements,
677 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
Bill Wendling9fdb7c02012-07-06 17:49:19 +0000678 Constant::getNullValue(Type::getInt32Ty(VMContext))
Devang Patel43c249c2010-12-08 01:50:15 +0000679 };
Devang Patel1f48a952011-04-18 23:51:03 +0000680 MDNode *Node = MDNode::get(VMContext, Elts);
Devang Patel94c7ddb2011-08-16 22:09:43 +0000681 AllEnumTypes.push_back(Node);
David Blaikie342d92c2013-03-27 00:07:26 +0000682 DICompositeType T(Node);
683 assert(T.Verify() && "The enumeration type should be valid");
684 return T;
Devang Patel43c249c2010-12-08 01:50:15 +0000685}
686
Devang Patel50d280c2011-02-22 18:56:12 +0000687/// createArrayType - Create debugging information entry for an array.
David Blaikied67c5ca2013-02-18 06:41:57 +0000688DICompositeType DIBuilder::createArrayType(uint64_t Size, uint64_t AlignInBits,
689 DIType Ty, DIArray Subscripts) {
Devang Patel43c249c2010-12-08 01:50:15 +0000690 // TAG_array_type is encoded in DICompositeType format.
691 Value *Elts[] = {
692 GetTagConstant(VMContext, dwarf::DW_TAG_array_type),
David Blaikiea13f3cd2013-03-19 23:25:22 +0000693 NULL, // Filename/Directory,
David Blaikie342d92c2013-03-27 00:07:26 +0000694 Constant::getNullValue(Type::getInt32Ty(VMContext)), // Imported modules
Devang Patel94c7ddb2011-08-16 22:09:43 +0000695 NULL, //TheCU,
Devang Patel43c249c2010-12-08 01:50:15 +0000696 MDString::get(VMContext, ""),
Devang Patel43c249c2010-12-08 01:50:15 +0000697 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
698 ConstantInt::get(Type::getInt64Ty(VMContext), Size),
699 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
700 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
701 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
702 Ty,
703 Subscripts,
704 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
Bill Wendling9fdb7c02012-07-06 17:49:19 +0000705 Constant::getNullValue(Type::getInt32Ty(VMContext))
Devang Patel43c249c2010-12-08 01:50:15 +0000706 };
David Blaikie342d92c2013-03-27 00:07:26 +0000707 DICompositeType T(MDNode::get(VMContext, Elts));
708 assert(T.Verify() && "The array type should be valid");
709 return T;
Devang Patel43c249c2010-12-08 01:50:15 +0000710}
711
Devang Patel50d280c2011-02-22 18:56:12 +0000712/// createVectorType - Create debugging information entry for a vector.
Eric Christopher6c0046f2011-08-26 21:02:40 +0000713DIType DIBuilder::createVectorType(uint64_t Size, uint64_t AlignInBits,
Devang Patel43c249c2010-12-08 01:50:15 +0000714 DIType Ty, DIArray Subscripts) {
Eric Christopher9a1e0e22013-01-08 01:53:52 +0000715
716 // A vector is an array type with the FlagVector flag applied.
Devang Patel43c249c2010-12-08 01:50:15 +0000717 Value *Elts[] = {
Eric Christopher9a1e0e22013-01-08 01:53:52 +0000718 GetTagConstant(VMContext, dwarf::DW_TAG_array_type),
David Blaikiea13f3cd2013-03-19 23:25:22 +0000719 NULL, // Filename/Directory,
David Blaikie342d92c2013-03-27 00:07:26 +0000720 Constant::getNullValue(Type::getInt32Ty(VMContext)), // Imported modules
Devang Patel94c7ddb2011-08-16 22:09:43 +0000721 NULL, //TheCU,
Devang Patel43c249c2010-12-08 01:50:15 +0000722 MDString::get(VMContext, ""),
Devang Patel43c249c2010-12-08 01:50:15 +0000723 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
724 ConstantInt::get(Type::getInt64Ty(VMContext), Size),
725 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
726 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
Eric Christopher9a1e0e22013-01-08 01:53:52 +0000727 ConstantInt::get(Type::getInt32Ty(VMContext), DIType::FlagVector),
Devang Patel43c249c2010-12-08 01:50:15 +0000728 Ty,
729 Subscripts,
730 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
Bill Wendling9fdb7c02012-07-06 17:49:19 +0000731 Constant::getNullValue(Type::getInt32Ty(VMContext))
Devang Patel43c249c2010-12-08 01:50:15 +0000732 };
David Blaikie342d92c2013-03-27 00:07:26 +0000733 DIType T(MDNode::get(VMContext, Elts));
734 assert(T.Verify() && "The vector type should be valid");
735 return T;
Devang Patel43c249c2010-12-08 01:50:15 +0000736}
Devang Patelfe58f952010-12-07 23:25:47 +0000737
Devang Patel50d280c2011-02-22 18:56:12 +0000738/// createArtificialType - Create a new DIType with "artificial" flag set.
739DIType DIBuilder::createArtificialType(DIType Ty) {
Devang Patel35fcd652010-11-04 15:01:38 +0000740 if (Ty.isArtificial())
741 return Ty;
742
743 SmallVector<Value *, 9> Elts;
744 MDNode *N = Ty;
745 assert (N && "Unexpected input DIType!");
746 for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i) {
747 if (Value *V = N->getOperand(i))
748 Elts.push_back(V);
749 else
750 Elts.push_back(Constant::getNullValue(Type::getInt32Ty(VMContext)));
751 }
752
753 unsigned CurFlags = Ty.getFlags();
754 CurFlags = CurFlags | DIType::FlagArtificial;
755
756 // Flags are stored at this slot.
David Blaikie342d92c2013-03-27 00:07:26 +0000757 Elts[9] = ConstantInt::get(Type::getInt32Ty(VMContext), CurFlags);
Devang Patel35fcd652010-11-04 15:01:38 +0000758
David Blaikie342d92c2013-03-27 00:07:26 +0000759 DIType T(MDNode::get(VMContext, Elts));
760 assert(T.Verify() && "The artificial type should be valid");
761 return T;
Devang Patel35fcd652010-11-04 15:01:38 +0000762}
Devang Patelfe58f952010-12-07 23:25:47 +0000763
Eric Christopher1f55eb42013-01-08 01:53:42 +0000764/// createObjectPointerType - Create a new type with both the object pointer
765/// and artificial flags set.
Eric Christophere5212782012-09-12 23:36:19 +0000766DIType DIBuilder::createObjectPointerType(DIType Ty) {
767 if (Ty.isObjectPointer())
768 return Ty;
769
770 SmallVector<Value *, 9> Elts;
771 MDNode *N = Ty;
772 assert (N && "Unexpected input DIType!");
773 for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i) {
774 if (Value *V = N->getOperand(i))
775 Elts.push_back(V);
776 else
777 Elts.push_back(Constant::getNullValue(Type::getInt32Ty(VMContext)));
778 }
779
780 unsigned CurFlags = Ty.getFlags();
781 CurFlags = CurFlags | (DIType::FlagObjectPointer | DIType::FlagArtificial);
782
783 // Flags are stored at this slot.
David Blaikie342d92c2013-03-27 00:07:26 +0000784 Elts[9] = ConstantInt::get(Type::getInt32Ty(VMContext), CurFlags);
Eric Christophere5212782012-09-12 23:36:19 +0000785
David Blaikie342d92c2013-03-27 00:07:26 +0000786 DIType T(MDNode::get(VMContext, Elts));
787 assert(T.Verify() && "The object pointer type should be valid");
788 return T;
Eric Christophere5212782012-09-12 23:36:19 +0000789}
790
Eric Christopher6c0046f2011-08-26 21:02:40 +0000791/// retainType - Retain DIType in a module even if it is not referenced
Devang Patel43c249c2010-12-08 01:50:15 +0000792/// through debug info anchors.
Devang Patel50d280c2011-02-22 18:56:12 +0000793void DIBuilder::retainType(DIType T) {
Devang Patel94c7ddb2011-08-16 22:09:43 +0000794 AllRetainTypes.push_back(T);
Devang Patel43c249c2010-12-08 01:50:15 +0000795}
796
Devang Patel50d280c2011-02-22 18:56:12 +0000797/// createUnspecifiedParameter - Create unspeicified type descriptor
Devang Patel43c249c2010-12-08 01:50:15 +0000798/// for the subroutine type.
Devang Patel50d280c2011-02-22 18:56:12 +0000799DIDescriptor DIBuilder::createUnspecifiedParameter() {
Eric Christopher6c0046f2011-08-26 21:02:40 +0000800 Value *Elts[] = {
801 GetTagConstant(VMContext, dwarf::DW_TAG_unspecified_parameters)
Devang Patel43c249c2010-12-08 01:50:15 +0000802 };
Devang Patel1f48a952011-04-18 23:51:03 +0000803 return DIDescriptor(MDNode::get(VMContext, Elts));
Devang Patel43c249c2010-12-08 01:50:15 +0000804}
805
Eric Christopher4fe34572012-02-08 00:22:26 +0000806/// createForwardDecl - Create a temporary forward-declared type that
807/// can be RAUW'd if the full type is seen.
Eric Christopher216432d2012-04-23 19:00:11 +0000808DIType DIBuilder::createForwardDecl(unsigned Tag, StringRef Name,
809 DIDescriptor Scope, DIFile F,
Eli Friedmance3da6f2012-10-05 01:49:14 +0000810 unsigned Line, unsigned RuntimeLang,
811 uint64_t SizeInBits,
812 uint64_t AlignInBits) {
Eric Christopher4fe34572012-02-08 00:22:26 +0000813 // Create a temporary MDNode.
814 Value *Elts[] = {
815 GetTagConstant(VMContext, Tag),
David Blaikie4776bce2013-03-20 00:26:26 +0000816 F.getFileNode(),
David Blaikie342d92c2013-03-27 00:07:26 +0000817 NULL, // Imported modules
Eric Christopher216432d2012-04-23 19:00:11 +0000818 getNonCompileUnitScope(Scope),
Eric Christopher4fe34572012-02-08 00:22:26 +0000819 MDString::get(VMContext, Name),
Eric Christopher4fe34572012-02-08 00:22:26 +0000820 ConstantInt::get(Type::getInt32Ty(VMContext), Line),
Eli Friedmance3da6f2012-10-05 01:49:14 +0000821 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
822 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
Eric Christopher4fe34572012-02-08 00:22:26 +0000823 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
824 ConstantInt::get(Type::getInt32Ty(VMContext),
Eric Christopher9f90e872012-02-20 18:04:14 +0000825 DIDescriptor::FlagFwdDecl),
826 NULL,
827 DIArray(),
828 ConstantInt::get(Type::getInt32Ty(VMContext), RuntimeLang)
Eric Christopher4fe34572012-02-08 00:22:26 +0000829 };
830 MDNode *Node = MDNode::getTemporary(VMContext, Elts);
David Blaikie66438682013-03-11 23:21:19 +0000831 assert(DIType(Node).Verify() &&
832 "createForwardDecl result should be verifiable");
Eric Christopher4fe34572012-02-08 00:22:26 +0000833 return DIType(Node);
834}
835
Devang Patel50d280c2011-02-22 18:56:12 +0000836/// getOrCreateArray - Get a DIArray, create one if required.
Jay Foad68550182011-04-24 10:11:03 +0000837DIArray DIBuilder::getOrCreateArray(ArrayRef<Value *> Elements) {
838 if (Elements.empty()) {
Bill Wendlingf46b4972012-07-06 17:47:36 +0000839 Value *Null = Constant::getNullValue(Type::getInt32Ty(VMContext));
Jay Foadec9186b2011-04-21 19:59:31 +0000840 return DIArray(MDNode::get(VMContext, Null));
Devang Patelfe58f952010-12-07 23:25:47 +0000841 }
Jay Foad68550182011-04-24 10:11:03 +0000842 return DIArray(MDNode::get(VMContext, Elements));
Devang Patelfe58f952010-12-07 23:25:47 +0000843}
844
Devang Patel50d280c2011-02-22 18:56:12 +0000845/// getOrCreateSubrange - Create a descriptor for a value range. This
Devang Patel43c249c2010-12-08 01:50:15 +0000846/// implicitly uniques the values returned.
Bill Wendling9493dae2012-12-04 21:34:03 +0000847DISubrange DIBuilder::getOrCreateSubrange(int64_t Lo, int64_t Count) {
Devang Patel43c249c2010-12-08 01:50:15 +0000848 Value *Elts[] = {
849 GetTagConstant(VMContext, dwarf::DW_TAG_subrange_type),
850 ConstantInt::get(Type::getInt64Ty(VMContext), Lo),
Bill Wendlinga7645a32012-12-04 06:20:49 +0000851 ConstantInt::get(Type::getInt64Ty(VMContext), Count)
Devang Patel43c249c2010-12-08 01:50:15 +0000852 };
853
Devang Patel1f48a952011-04-18 23:51:03 +0000854 return DISubrange(MDNode::get(VMContext, Elts));
Devang Patel43c249c2010-12-08 01:50:15 +0000855}
856
David Blaikie3fac43d2013-03-20 17:49:48 +0000857/// \brief Create a new descriptor for the specified global.
Devang Patelfe58f952010-12-07 23:25:47 +0000858DIGlobalVariable DIBuilder::
David Blaikie3fac43d2013-03-20 17:49:48 +0000859createGlobalVariable(StringRef Name, StringRef LinkageName, DIFile F,
860 unsigned LineNumber, DIType Ty, bool isLocalToUnit,
861 Value *Val) {
Devang Patelfe58f952010-12-07 23:25:47 +0000862 Value *Elts[] = {
863 GetTagConstant(VMContext, dwarf::DW_TAG_variable),
Bill Wendlingf46b4972012-07-06 17:47:36 +0000864 Constant::getNullValue(Type::getInt32Ty(VMContext)),
Devang Patel94c7ddb2011-08-16 22:09:43 +0000865 NULL, // TheCU,
Devang Patelfe58f952010-12-07 23:25:47 +0000866 MDString::get(VMContext, Name),
867 MDString::get(VMContext, Name),
David Blaikie3fac43d2013-03-20 17:49:48 +0000868 MDString::get(VMContext, LinkageName),
Devang Patelfe58f952010-12-07 23:25:47 +0000869 F,
870 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
871 Ty,
872 ConstantInt::get(Type::getInt32Ty(VMContext), isLocalToUnit),
873 ConstantInt::get(Type::getInt32Ty(VMContext), 1), /* isDefinition*/
Eric Christopher6b6061f2013-01-16 01:22:23 +0000874 Val,
875 DIDescriptor()
Devang Patelfe58f952010-12-07 23:25:47 +0000876 };
Devang Patel1f48a952011-04-18 23:51:03 +0000877 MDNode *Node = MDNode::get(VMContext, Elts);
Devang Patel94c7ddb2011-08-16 22:09:43 +0000878 AllGVs.push_back(Node);
Devang Patelfe58f952010-12-07 23:25:47 +0000879 return DIGlobalVariable(Node);
880}
881
David Blaikie3fac43d2013-03-20 17:49:48 +0000882/// \brief Create a new descriptor for the specified global.
883DIGlobalVariable DIBuilder::
884createGlobalVariable(StringRef Name, DIFile F, unsigned LineNumber,
885 DIType Ty, bool isLocalToUnit, Value *Val) {
886 return createGlobalVariable(Name, Name, F, LineNumber, Ty, isLocalToUnit,
887 Val);
888}
889
Devang Patel50d280c2011-02-22 18:56:12 +0000890/// createStaticVariable - Create a new descriptor for the specified static
Devang Patelfe58f952010-12-07 23:25:47 +0000891/// variable.
892DIGlobalVariable DIBuilder::
Eric Christopher6c0046f2011-08-26 21:02:40 +0000893createStaticVariable(DIDescriptor Context, StringRef Name,
894 StringRef LinkageName, DIFile F, unsigned LineNumber,
Eric Christopher6b6061f2013-01-16 01:22:23 +0000895 DIType Ty, bool isLocalToUnit, Value *Val, MDNode *Decl) {
Devang Patelfe58f952010-12-07 23:25:47 +0000896 Value *Elts[] = {
897 GetTagConstant(VMContext, dwarf::DW_TAG_variable),
Bill Wendlingf46b4972012-07-06 17:47:36 +0000898 Constant::getNullValue(Type::getInt32Ty(VMContext)),
Devang Patel94c7ddb2011-08-16 22:09:43 +0000899 getNonCompileUnitScope(Context),
Devang Patelfe58f952010-12-07 23:25:47 +0000900 MDString::get(VMContext, Name),
901 MDString::get(VMContext, Name),
902 MDString::get(VMContext, LinkageName),
903 F,
904 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
905 Ty,
906 ConstantInt::get(Type::getInt32Ty(VMContext), isLocalToUnit),
907 ConstantInt::get(Type::getInt32Ty(VMContext), 1), /* isDefinition*/
Eric Christopher6b6061f2013-01-16 01:22:23 +0000908 Val,
909 DIDescriptor(Decl)
Devang Patelfe58f952010-12-07 23:25:47 +0000910 };
Devang Patel1f48a952011-04-18 23:51:03 +0000911 MDNode *Node = MDNode::get(VMContext, Elts);
Devang Patel94c7ddb2011-08-16 22:09:43 +0000912 AllGVs.push_back(Node);
Devang Patelfe58f952010-12-07 23:25:47 +0000913 return DIGlobalVariable(Node);
914}
915
Devang Patel50d280c2011-02-22 18:56:12 +0000916/// createVariable - Create a new descriptor for the specified variable.
917DIVariable DIBuilder::createLocalVariable(unsigned Tag, DIDescriptor Scope,
Devang Patel48f17ba2010-12-07 23:58:00 +0000918 StringRef Name, DIFile File,
Eric Christopher6c0046f2011-08-26 21:02:40 +0000919 unsigned LineNo, DIType Ty,
Devang Patele9e16c52011-03-01 22:58:13 +0000920 bool AlwaysPreserve, unsigned Flags,
921 unsigned ArgNo) {
David Blaikie66438682013-03-11 23:21:19 +0000922 DIDescriptor Context(getNonCompileUnitScope(Scope));
923 assert((!Context || Context.Verify()) &&
924 "createLocalVariable should be called with a valid Context");
925 assert(Ty.Verify() &&
926 "createLocalVariable should be called with a valid type");
Devang Patel48f17ba2010-12-07 23:58:00 +0000927 Value *Elts[] = {
928 GetTagConstant(VMContext, Tag),
Devang Patel94c7ddb2011-08-16 22:09:43 +0000929 getNonCompileUnitScope(Scope),
Devang Patel48f17ba2010-12-07 23:58:00 +0000930 MDString::get(VMContext, Name),
931 File,
Devang Patele9e16c52011-03-01 22:58:13 +0000932 ConstantInt::get(Type::getInt32Ty(VMContext), (LineNo | (ArgNo << 24))),
Devang Patel48f17ba2010-12-07 23:58:00 +0000933 Ty,
Devang Patel23336b42011-07-19 19:41:54 +0000934 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
Bill Wendling9fdb7c02012-07-06 17:49:19 +0000935 Constant::getNullValue(Type::getInt32Ty(VMContext))
Devang Patel48f17ba2010-12-07 23:58:00 +0000936 };
Devang Patel1f48a952011-04-18 23:51:03 +0000937 MDNode *Node = MDNode::get(VMContext, Elts);
Devang Patel48f17ba2010-12-07 23:58:00 +0000938 if (AlwaysPreserve) {
939 // The optimizer may remove local variable. If there is an interest
940 // to preserve variable info in such situation then stash it in a
941 // named mdnode.
942 DISubprogram Fn(getDISubprogram(Scope));
Devang Patel93d39be2011-08-19 23:28:12 +0000943 NamedMDNode *FnLocals = getOrInsertFnSpecificMDNode(M, Fn);
Devang Patel48f17ba2010-12-07 23:58:00 +0000944 FnLocals->addOperand(Node);
945 }
David Blaikie66438682013-03-11 23:21:19 +0000946 assert(DIVariable(Node).Verify() &&
947 "createLocalVariable should return a verifiable DIVariable");
Devang Patel48f17ba2010-12-07 23:58:00 +0000948 return DIVariable(Node);
949}
950
Devang Patel50d280c2011-02-22 18:56:12 +0000951/// createComplexVariable - Create a new descriptor for the specified variable
Devang Patelfe58f952010-12-07 23:25:47 +0000952/// which has a complex address expression for its address.
Devang Patel50d280c2011-02-22 18:56:12 +0000953DIVariable DIBuilder::createComplexVariable(unsigned Tag, DIDescriptor Scope,
Devang Patelfe58f952010-12-07 23:25:47 +0000954 StringRef Name, DIFile F,
955 unsigned LineNo,
Jay Foad68550182011-04-24 10:11:03 +0000956 DIType Ty, ArrayRef<Value *> Addr,
957 unsigned ArgNo) {
Devang Patelfe58f952010-12-07 23:25:47 +0000958 SmallVector<Value *, 15> Elts;
959 Elts.push_back(GetTagConstant(VMContext, Tag));
Devang Patel94c7ddb2011-08-16 22:09:43 +0000960 Elts.push_back(getNonCompileUnitScope(Scope)),
Devang Patelfe58f952010-12-07 23:25:47 +0000961 Elts.push_back(MDString::get(VMContext, Name));
962 Elts.push_back(F);
Eric Christopher6c0046f2011-08-26 21:02:40 +0000963 Elts.push_back(ConstantInt::get(Type::getInt32Ty(VMContext),
Devang Patel9f997212012-02-08 00:17:07 +0000964 (LineNo | (ArgNo << 24))));
Devang Patelfe58f952010-12-07 23:25:47 +0000965 Elts.push_back(Ty);
Bill Wendlingf46b4972012-07-06 17:47:36 +0000966 Elts.push_back(Constant::getNullValue(Type::getInt32Ty(VMContext)));
967 Elts.push_back(Constant::getNullValue(Type::getInt32Ty(VMContext)));
Jay Foad68550182011-04-24 10:11:03 +0000968 Elts.append(Addr.begin(), Addr.end());
Devang Patelfe58f952010-12-07 23:25:47 +0000969
Devang Patel1f48a952011-04-18 23:51:03 +0000970 return DIVariable(MDNode::get(VMContext, Elts));
Devang Patelfe58f952010-12-07 23:25:47 +0000971}
972
Devang Patel50d280c2011-02-22 18:56:12 +0000973/// createFunction - Create a new descriptor for the specified function.
974DISubprogram DIBuilder::createFunction(DIDescriptor Context,
Devang Patel44498a62010-12-08 20:42:44 +0000975 StringRef Name,
976 StringRef LinkageName,
977 DIFile File, unsigned LineNo,
978 DIType Ty,
979 bool isLocalToUnit, bool isDefinition,
Eric Christopher6126a1e2012-04-03 00:43:49 +0000980 unsigned ScopeLine,
Devang Patel44498a62010-12-08 20:42:44 +0000981 unsigned Flags, bool isOptimized,
Devang Patelda194752011-04-05 22:52:06 +0000982 Function *Fn,
Devang Patel5e06bb82011-04-22 23:10:17 +0000983 MDNode *TParams,
984 MDNode *Decl) {
Devang Patel93d39be2011-08-19 23:28:12 +0000985 Value *TElts[] = { GetTagConstant(VMContext, DW_TAG_base_type) };
Devang Patel44498a62010-12-08 20:42:44 +0000986 Value *Elts[] = {
987 GetTagConstant(VMContext, dwarf::DW_TAG_subprogram),
David Blaikiebb4e6192013-03-21 23:08:34 +0000988 File.getFileNode(),
David Blaikie342d92c2013-03-27 00:07:26 +0000989 NULL, // Imported modules
Devang Patel94c7ddb2011-08-16 22:09:43 +0000990 getNonCompileUnitScope(Context),
Devang Patel44498a62010-12-08 20:42:44 +0000991 MDString::get(VMContext, Name),
992 MDString::get(VMContext, Name),
993 MDString::get(VMContext, LinkageName),
Devang Patel44498a62010-12-08 20:42:44 +0000994 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
995 Ty,
996 ConstantInt::get(Type::getInt1Ty(VMContext), isLocalToUnit),
997 ConstantInt::get(Type::getInt1Ty(VMContext), isDefinition),
998 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
999 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
Devang Patel9642c572011-12-15 17:55:56 +00001000 NULL,
Devang Patel44498a62010-12-08 20:42:44 +00001001 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
1002 ConstantInt::get(Type::getInt1Ty(VMContext), isOptimized),
Devang Patelda194752011-04-05 22:52:06 +00001003 Fn,
Devang Patel5e06bb82011-04-22 23:10:17 +00001004 TParams,
Devang Patel93d39be2011-08-19 23:28:12 +00001005 Decl,
David Blaikief839eed2013-02-04 05:56:36 +00001006 MDNode::getTemporary(VMContext, TElts),
Eric Christopher6126a1e2012-04-03 00:43:49 +00001007 ConstantInt::get(Type::getInt32Ty(VMContext), ScopeLine)
Devang Patel44498a62010-12-08 20:42:44 +00001008 };
Devang Patel1f48a952011-04-18 23:51:03 +00001009 MDNode *Node = MDNode::get(VMContext, Elts);
Devang Patel44498a62010-12-08 20:42:44 +00001010
1011 // Create a named metadata so that we do not lose this mdnode.
David Blaikie139f7e52013-02-18 07:10:22 +00001012 if (isDefinition)
1013 AllSubprograms.push_back(Node);
David Blaikieebb51832013-03-21 20:28:52 +00001014 DISubprogram S(Node);
1015 assert(S.Verify() && "createFunction should return a valid DISubprogram");
1016 return S;
Devang Patel44498a62010-12-08 20:42:44 +00001017}
1018
Devang Patel50d280c2011-02-22 18:56:12 +00001019/// createMethod - Create a new descriptor for the specified C++ method.
1020DISubprogram DIBuilder::createMethod(DIDescriptor Context,
Devang Patel44498a62010-12-08 20:42:44 +00001021 StringRef Name,
1022 StringRef LinkageName,
1023 DIFile F,
1024 unsigned LineNo, DIType Ty,
1025 bool isLocalToUnit,
1026 bool isDefinition,
1027 unsigned VK, unsigned VIndex,
1028 MDNode *VTableHolder,
1029 unsigned Flags,
1030 bool isOptimized,
Devang Patelda194752011-04-05 22:52:06 +00001031 Function *Fn,
1032 MDNode *TParam) {
Devang Patel93d39be2011-08-19 23:28:12 +00001033 Value *TElts[] = { GetTagConstant(VMContext, DW_TAG_base_type) };
Devang Patel44498a62010-12-08 20:42:44 +00001034 Value *Elts[] = {
1035 GetTagConstant(VMContext, dwarf::DW_TAG_subprogram),
David Blaikiebb4e6192013-03-21 23:08:34 +00001036 F.getFileNode(),
David Blaikie342d92c2013-03-27 00:07:26 +00001037 NULL, // Imported modules
Devang Patel94c7ddb2011-08-16 22:09:43 +00001038 getNonCompileUnitScope(Context),
Devang Patel44498a62010-12-08 20:42:44 +00001039 MDString::get(VMContext, Name),
1040 MDString::get(VMContext, Name),
1041 MDString::get(VMContext, LinkageName),
Devang Patel44498a62010-12-08 20:42:44 +00001042 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
1043 Ty,
1044 ConstantInt::get(Type::getInt1Ty(VMContext), isLocalToUnit),
1045 ConstantInt::get(Type::getInt1Ty(VMContext), isDefinition),
1046 ConstantInt::get(Type::getInt32Ty(VMContext), (unsigned)VK),
1047 ConstantInt::get(Type::getInt32Ty(VMContext), VIndex),
1048 VTableHolder,
1049 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
1050 ConstantInt::get(Type::getInt1Ty(VMContext), isOptimized),
Devang Patelda194752011-04-05 22:52:06 +00001051 Fn,
1052 TParam,
Bill Wendlingf46b4972012-07-06 17:47:36 +00001053 Constant::getNullValue(Type::getInt32Ty(VMContext)),
David Blaikief839eed2013-02-04 05:56:36 +00001054 MDNode::getTemporary(VMContext, TElts),
Eric Christopher25016522012-05-18 00:16:22 +00001055 // FIXME: Do we want to use different scope/lines?
Eric Christopher6126a1e2012-04-03 00:43:49 +00001056 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo)
Devang Patel44498a62010-12-08 20:42:44 +00001057 };
Devang Patel1f48a952011-04-18 23:51:03 +00001058 MDNode *Node = MDNode::get(VMContext, Elts);
David Blaikie139f7e52013-02-18 07:10:22 +00001059 if (isDefinition)
1060 AllSubprograms.push_back(Node);
David Blaikieebb51832013-03-21 20:28:52 +00001061 DISubprogram S(Node);
1062 assert(S.Verify() && "createMethod should return a valid DISubprogram");
1063 return S;
Devang Patel44498a62010-12-08 20:42:44 +00001064}
1065
Devang Patel50d280c2011-02-22 18:56:12 +00001066/// createNameSpace - This creates new descriptor for a namespace
Devang Patelfe58f952010-12-07 23:25:47 +00001067/// with the specified parent scope.
Devang Patel50d280c2011-02-22 18:56:12 +00001068DINameSpace DIBuilder::createNameSpace(DIDescriptor Scope, StringRef Name,
Devang Patelfe58f952010-12-07 23:25:47 +00001069 DIFile File, unsigned LineNo) {
1070 Value *Elts[] = {
1071 GetTagConstant(VMContext, dwarf::DW_TAG_namespace),
David Blaikie6115ed02013-03-20 19:39:15 +00001072 File.getFileNode(),
David Blaikie342d92c2013-03-27 00:07:26 +00001073 NULL, // Imported modules
Devang Patel94c7ddb2011-08-16 22:09:43 +00001074 getNonCompileUnitScope(Scope),
Devang Patelfe58f952010-12-07 23:25:47 +00001075 MDString::get(VMContext, Name),
Devang Patelfe58f952010-12-07 23:25:47 +00001076 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo)
1077 };
David Blaikie66438682013-03-11 23:21:19 +00001078 DINameSpace R(MDNode::get(VMContext, Elts));
1079 assert(R.Verify() &&
1080 "createNameSpace should return a verifiable DINameSpace");
1081 return R;
Devang Patelfe58f952010-12-07 23:25:47 +00001082}
1083
Eric Christopher6618a242011-10-11 22:59:11 +00001084/// createLexicalBlockFile - This creates a new MDNode that encapsulates
1085/// an existing scope with a new filename.
1086DILexicalBlockFile DIBuilder::createLexicalBlockFile(DIDescriptor Scope,
Devang Patel9f997212012-02-08 00:17:07 +00001087 DIFile File) {
Eric Christopher6618a242011-10-11 22:59:11 +00001088 Value *Elts[] = {
1089 GetTagConstant(VMContext, dwarf::DW_TAG_lexical_block),
David Blaikie8faed272013-03-22 20:18:46 +00001090 File.getFileNode(),
David Blaikie342d92c2013-03-27 00:07:26 +00001091 NULL, // Imported modules
David Blaikie7b246862013-03-22 19:13:22 +00001092 Scope
Eric Christopher6618a242011-10-11 22:59:11 +00001093 };
David Blaikie66438682013-03-11 23:21:19 +00001094 DILexicalBlockFile R(MDNode::get(VMContext, Elts));
1095 assert(
1096 R.Verify() &&
1097 "createLexicalBlockFile should return a verifiable DILexicalBlockFile");
1098 return R;
Eric Christopher6618a242011-10-11 22:59:11 +00001099}
1100
Devang Patel50d280c2011-02-22 18:56:12 +00001101DILexicalBlock DIBuilder::createLexicalBlock(DIDescriptor Scope, DIFile File,
Devang Patel43c249c2010-12-08 01:50:15 +00001102 unsigned Line, unsigned Col) {
1103 // Defeat MDNode uniqing for lexical blocks by using unique id.
1104 static unsigned int unique_id = 0;
1105 Value *Elts[] = {
1106 GetTagConstant(VMContext, dwarf::DW_TAG_lexical_block),
David Blaikie4b52a882013-03-22 17:33:20 +00001107 File.getFileNode(),
David Blaikie342d92c2013-03-27 00:07:26 +00001108 NULL, // Imported modules
Devang Patel94c7ddb2011-08-16 22:09:43 +00001109 getNonCompileUnitScope(Scope),
Devang Patel43c249c2010-12-08 01:50:15 +00001110 ConstantInt::get(Type::getInt32Ty(VMContext), Line),
1111 ConstantInt::get(Type::getInt32Ty(VMContext), Col),
Devang Patel43c249c2010-12-08 01:50:15 +00001112 ConstantInt::get(Type::getInt32Ty(VMContext), unique_id++)
1113 };
David Blaikie66438682013-03-11 23:21:19 +00001114 DILexicalBlock R(MDNode::get(VMContext, Elts));
1115 assert(R.Verify() &&
1116 "createLexicalBlock should return a verifiable DILexicalBlock");
1117 return R;
Devang Patel43c249c2010-12-08 01:50:15 +00001118}
1119
Devang Patel50d280c2011-02-22 18:56:12 +00001120/// insertDeclare - Insert a new llvm.dbg.declare intrinsic call.
1121Instruction *DIBuilder::insertDeclare(Value *Storage, DIVariable VarInfo,
Devang Patelfe58f952010-12-07 23:25:47 +00001122 Instruction *InsertBefore) {
1123 assert(Storage && "no storage passed to dbg.declare");
1124 assert(VarInfo.Verify() && "empty DIVariable passed to dbg.declare");
1125 if (!DeclareFn)
1126 DeclareFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_declare);
1127
Jay Foadec9186b2011-04-21 19:59:31 +00001128 Value *Args[] = { MDNode::get(Storage->getContext(), Storage), VarInfo };
Jay Foada3efbb12011-07-15 08:37:34 +00001129 return CallInst::Create(DeclareFn, Args, "", InsertBefore);
Devang Patelfe58f952010-12-07 23:25:47 +00001130}
1131
Devang Patel50d280c2011-02-22 18:56:12 +00001132/// insertDeclare - Insert a new llvm.dbg.declare intrinsic call.
1133Instruction *DIBuilder::insertDeclare(Value *Storage, DIVariable VarInfo,
Devang Patelfe58f952010-12-07 23:25:47 +00001134 BasicBlock *InsertAtEnd) {
1135 assert(Storage && "no storage passed to dbg.declare");
1136 assert(VarInfo.Verify() && "invalid DIVariable passed to dbg.declare");
1137 if (!DeclareFn)
1138 DeclareFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_declare);
1139
Jay Foadec9186b2011-04-21 19:59:31 +00001140 Value *Args[] = { MDNode::get(Storage->getContext(), Storage), VarInfo };
Devang Patelfe58f952010-12-07 23:25:47 +00001141
1142 // If this block already has a terminator then insert this intrinsic
1143 // before the terminator.
1144 if (TerminatorInst *T = InsertAtEnd->getTerminator())
Jay Foada3efbb12011-07-15 08:37:34 +00001145 return CallInst::Create(DeclareFn, Args, "", T);
Devang Patelfe58f952010-12-07 23:25:47 +00001146 else
Jay Foada3efbb12011-07-15 08:37:34 +00001147 return CallInst::Create(DeclareFn, Args, "", InsertAtEnd);
Devang Patelfe58f952010-12-07 23:25:47 +00001148}
1149
Devang Patel50d280c2011-02-22 18:56:12 +00001150/// insertDbgValueIntrinsic - Insert a new llvm.dbg.value intrinsic call.
1151Instruction *DIBuilder::insertDbgValueIntrinsic(Value *V, uint64_t Offset,
Devang Patelfe58f952010-12-07 23:25:47 +00001152 DIVariable VarInfo,
1153 Instruction *InsertBefore) {
1154 assert(V && "no value passed to dbg.value");
1155 assert(VarInfo.Verify() && "invalid DIVariable passed to dbg.value");
1156 if (!ValueFn)
1157 ValueFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_value);
1158
Jay Foadec9186b2011-04-21 19:59:31 +00001159 Value *Args[] = { MDNode::get(V->getContext(), V),
Devang Patelfe58f952010-12-07 23:25:47 +00001160 ConstantInt::get(Type::getInt64Ty(V->getContext()), Offset),
1161 VarInfo };
Jay Foada3efbb12011-07-15 08:37:34 +00001162 return CallInst::Create(ValueFn, Args, "", InsertBefore);
Devang Patelfe58f952010-12-07 23:25:47 +00001163}
1164
Devang Patel50d280c2011-02-22 18:56:12 +00001165/// insertDbgValueIntrinsic - Insert a new llvm.dbg.value intrinsic call.
1166Instruction *DIBuilder::insertDbgValueIntrinsic(Value *V, uint64_t Offset,
Devang Patelfe58f952010-12-07 23:25:47 +00001167 DIVariable VarInfo,
1168 BasicBlock *InsertAtEnd) {
1169 assert(V && "no value passed to dbg.value");
1170 assert(VarInfo.Verify() && "invalid DIVariable passed to dbg.value");
1171 if (!ValueFn)
1172 ValueFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_value);
1173
Jay Foadec9186b2011-04-21 19:59:31 +00001174 Value *Args[] = { MDNode::get(V->getContext(), V),
Devang Patelfe58f952010-12-07 23:25:47 +00001175 ConstantInt::get(Type::getInt64Ty(V->getContext()), Offset),
1176 VarInfo };
Jay Foada3efbb12011-07-15 08:37:34 +00001177 return CallInst::Create(ValueFn, Args, "", InsertAtEnd);
Devang Patelfe58f952010-12-07 23:25:47 +00001178}