blob: 2e981a5d6800f4dbce5948201fd6a30191dade84 [file] [log] [blame]
Devang Patel57c5a202010-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 Wendlingf799efd2012-06-29 08:32:07 +000014#include "llvm/DIBuilder.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000015#include "llvm/ADT/STLExtras.h"
Bill Wendlinge38859d2012-06-28 00:05:13 +000016#include "llvm/DebugInfo.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000017#include "llvm/IR/Constants.h"
18#include "llvm/IR/IntrinsicInst.h"
19#include "llvm/IR/Module.h"
Eric Christopher34164192012-04-03 00:43:49 +000020#include "llvm/Support/Debug.h"
Devang Patel57c5a202010-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 Patel63f83cd2010-12-07 23:58:00 +000031
Devang Patel57c5a202010-11-04 15:01:38 +000032DIBuilder::DIBuilder(Module &m)
Eric Christopher3cc90fe2011-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 Pateleb1bb4e2011-08-16 22:09:43 +000036{}
Devang Patel57c5a202010-11-04 15:01:38 +000037
Devang Patel2b8acaf2011-08-15 23:00:00 +000038/// finalize - Construct any deferred debug info descriptors.
39void DIBuilder::finalize() {
Devang Pateleb1bb4e2011-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 Patel59e27c52011-08-19 23:28:12 +000048 for (unsigned i = 0, e = SPs.getNumElements(); i != e; ++i) {
49 DISubprogram SP(SPs.getElement(i));
Eric Christopher27deb262012-04-23 19:00:11 +000050 SmallVector<Value *, 4> Variables;
Devang Patel59e27c52011-08-19 23:28:12 +000051 if (NamedMDNode *NMD = getFnSpecificMDNode(M, SP)) {
Devang Patel59e27c52011-08-19 23:28:12 +000052 for (unsigned ii = 0, ee = NMD->getNumOperands(); ii != ee; ++ii)
53 Variables.push_back(NMD->getOperand(ii));
Devang Patel59e27c52011-08-19 23:28:12 +000054 NMD->eraseFromParent();
55 }
Eric Christopher27deb262012-04-23 19:00:11 +000056 if (MDNode *Temp = SP.getVariablesNodes()) {
57 DIArray AV = getOrCreateArray(Variables);
58 DIType(Temp).replaceAllUsesWith(AV);
59 }
Devang Patel59e27c52011-08-19 23:28:12 +000060 }
Devang Pateleb1bb4e2011-08-16 22:09:43 +000061
62 DIArray GVs = getOrCreateArray(AllGVs);
63 DIType(TempGVs).replaceAllUsesWith(GVs);
David Blaikie88564f3c2013-04-19 06:57:04 +000064
65 DIArray IMs = getOrCreateArray(AllImportedModules);
66 DIType(TempImportedModules).replaceAllUsesWith(IMs);
Devang Pateleb1bb4e2011-08-16 22:09:43 +000067}
68
Eric Christopher3cc90fe2011-08-26 21:02:40 +000069/// getNonCompileUnitScope - If N is compile unit return NULL otherwise return
70/// N.
Devang Pateleb1bb4e2011-08-16 22:09:43 +000071static MDNode *getNonCompileUnitScope(MDNode *N) {
72 if (DIDescriptor(N).isCompileUnit())
73 return NULL;
74 return N;
Devang Patel2b8acaf2011-08-15 23:00:00 +000075}
76
David Blaikieefb0d652013-03-20 23:58:12 +000077static MDNode *createFilePathPair(LLVMContext &VMContext, StringRef Filename,
78 StringRef Directory) {
79 assert(!Filename.empty() && "Unable to create file without name");
80 Value *Pair[] = {
81 MDString::get(VMContext, Filename),
82 MDString::get(VMContext, Directory),
83 };
84 return MDNode::get(VMContext, Pair);
85}
86
Devang Patel9b412732011-02-22 18:56:12 +000087/// createCompileUnit - A CompileUnit provides an anchor for all debugging
Devang Patel57c5a202010-11-04 15:01:38 +000088/// information generated during this instance of compilation.
Eric Christopher3cc90fe2011-08-26 21:02:40 +000089void DIBuilder::createCompileUnit(unsigned Lang, StringRef Filename,
90 StringRef Directory, StringRef Producer,
91 bool isOptimized, StringRef Flags,
Eric Christopher0dab3642013-02-22 23:50:04 +000092 unsigned RunTimeVer, StringRef SplitName) {
Chandler Carruth4c0ee742012-01-10 18:18:52 +000093 assert(((Lang <= dwarf::DW_LANG_Python && Lang >= dwarf::DW_LANG_C89) ||
94 (Lang <= dwarf::DW_LANG_hi_user && Lang >= dwarf::DW_LANG_lo_user)) &&
95 "Invalid Language tag");
96 assert(!Filename.empty() &&
97 "Unable to create compile unit without filename");
Devang Pateleb1bb4e2011-08-16 22:09:43 +000098 Value *TElts[] = { GetTagConstant(VMContext, DW_TAG_base_type) };
99 TempEnumTypes = MDNode::getTemporary(VMContext, TElts);
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000100
101 TempRetainTypes = MDNode::getTemporary(VMContext, TElts);
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000102
103 TempSubprograms = MDNode::getTemporary(VMContext, TElts);
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000104
105 TempGVs = MDNode::getTemporary(VMContext, TElts);
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000106
David Blaikie88564f3c2013-04-19 06:57:04 +0000107 TempImportedModules = MDNode::getTemporary(VMContext, TElts);
108
Benjamin Kramered8b7bf2010-11-04 18:45:27 +0000109 Value *Elts[] = {
110 GetTagConstant(VMContext, dwarf::DW_TAG_compile_unit),
David Blaikieefb0d652013-03-20 23:58:12 +0000111 createFilePathPair(VMContext, Filename, Directory),
David Blaikie3b888522013-03-20 22:52:54 +0000112 ConstantInt::get(Type::getInt32Ty(VMContext), Lang),
Benjamin Kramered8b7bf2010-11-04 18:45:27 +0000113 MDString::get(VMContext, Producer),
Benjamin Kramered8b7bf2010-11-04 18:45:27 +0000114 ConstantInt::get(Type::getInt1Ty(VMContext), isOptimized),
115 MDString::get(VMContext, Flags),
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000116 ConstantInt::get(Type::getInt32Ty(VMContext), RunTimeVer),
David Blaikie33111df2013-02-02 05:56:24 +0000117 TempEnumTypes,
118 TempRetainTypes,
119 TempSubprograms,
Eric Christopher0dab3642013-02-22 23:50:04 +0000120 TempGVs,
David Blaikie88564f3c2013-04-19 06:57:04 +0000121 TempImportedModules,
Eric Christopher0dab3642013-02-22 23:50:04 +0000122 MDString::get(VMContext, SplitName)
Benjamin Kramered8b7bf2010-11-04 18:45:27 +0000123 };
David Blaikie5692e722013-03-28 02:44:59 +0000124 TheCU = DICompileUnit(MDNode::get(VMContext, Elts));
Devang Patel09fa69e2011-05-03 16:18:28 +0000125
126 // Create a named metadata so that it is easier to find cu in a module.
127 NamedMDNode *NMD = M.getOrInsertNamedMetadata("llvm.dbg.cu");
128 NMD->addOperand(TheCU);
Devang Patel57c5a202010-11-04 15:01:38 +0000129}
130
David Blaikie88564f3c2013-04-19 06:57:04 +0000131DIImportedModule DIBuilder::createImportedModule(DIScope Context,
132 DINameSpace NS,
133 unsigned Line) {
134 Value *Elts[] = {
135 GetTagConstant(VMContext, dwarf::DW_TAG_imported_module),
136 Context,
137 NS,
138 ConstantInt::get(Type::getInt32Ty(VMContext), Line),
139 };
140 DIImportedModule M(MDNode::get(VMContext, Elts));
141 assert(M.Verify() && "Imported module should be valid");
142 AllImportedModules.push_back(M);
143 return M;
144}
145
Devang Patel9b412732011-02-22 18:56:12 +0000146/// createFile - Create a file descriptor to hold debugging information
Devang Patel57c5a202010-11-04 15:01:38 +0000147/// for a file.
Devang Patel9b412732011-02-22 18:56:12 +0000148DIFile DIBuilder::createFile(StringRef Filename, StringRef Directory) {
David Blaikie8fb82242013-03-17 21:13:55 +0000149 Value *Elts[] = {
150 GetTagConstant(VMContext, dwarf::DW_TAG_file_type),
David Blaikie5692e722013-03-28 02:44:59 +0000151 createFilePathPair(VMContext, Filename, Directory)
David Blaikie8fb82242013-03-17 21:13:55 +0000152 };
David Blaikie5692e722013-03-28 02:44:59 +0000153 return DIFile(MDNode::get(VMContext, Elts));
Devang Patel57c5a202010-11-04 15:01:38 +0000154}
155
Devang Patel9b412732011-02-22 18:56:12 +0000156/// createEnumerator - Create a single enumerator value.
157DIEnumerator DIBuilder::createEnumerator(StringRef Name, uint64_t Val) {
Devang Patel1ad1abe2011-09-12 18:26:08 +0000158 assert(!Name.empty() && "Unable to create enumerator without name");
Benjamin Kramered8b7bf2010-11-04 18:45:27 +0000159 Value *Elts[] = {
160 GetTagConstant(VMContext, dwarf::DW_TAG_enumerator),
161 MDString::get(VMContext, Name),
162 ConstantInt::get(Type::getInt64Ty(VMContext), Val)
163 };
David Blaikie5692e722013-03-28 02:44:59 +0000164 return DIEnumerator(MDNode::get(VMContext, Elts));
Devang Patel57c5a202010-11-04 15:01:38 +0000165}
166
Devang Patel04d6d472011-09-14 23:13:28 +0000167/// createNullPtrType - Create C++0x nullptr type.
168DIType DIBuilder::createNullPtrType(StringRef Name) {
169 assert(!Name.empty() && "Unable to create type without name");
170 // nullptr is encoded in DIBasicType format. Line number, filename,
171 // ,size, alignment, offset and flags are always empty here.
172 Value *Elts[] = {
173 GetTagConstant(VMContext, dwarf::DW_TAG_unspecified_type),
David Blaikieabec74b2013-03-19 23:25:22 +0000174 NULL, // Filename
Devang Patel04d6d472011-09-14 23:13:28 +0000175 NULL, //TheCU,
176 MDString::get(VMContext, Name),
Devang Patel04d6d472011-09-14 23:13:28 +0000177 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
178 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Size
179 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Align
180 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
181 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags;
Bill Wendling5ef31592012-07-06 17:49:19 +0000182 ConstantInt::get(Type::getInt32Ty(VMContext), 0) // Encoding
Devang Patel04d6d472011-09-14 23:13:28 +0000183 };
David Blaikie5692e722013-03-28 02:44:59 +0000184 return DIType(MDNode::get(VMContext, Elts));
Devang Patel04d6d472011-09-14 23:13:28 +0000185}
186
Eric Christopher3cc90fe2011-08-26 21:02:40 +0000187/// createBasicType - Create debugging information entry for a basic
Devang Patel57c5a202010-11-04 15:01:38 +0000188/// type, e.g 'char'.
David Blaikie209d63a2013-02-12 00:40:41 +0000189DIBasicType
190DIBuilder::createBasicType(StringRef Name, uint64_t SizeInBits,
191 uint64_t AlignInBits, unsigned Encoding) {
Devang Patel1ad1abe2011-09-12 18:26:08 +0000192 assert(!Name.empty() && "Unable to create type without name");
Devang Patel57c5a202010-11-04 15:01:38 +0000193 // Basic types are encoded in DIBasicType format. Line number, filename,
194 // offset and flags are always empty here.
Benjamin Kramered8b7bf2010-11-04 18:45:27 +0000195 Value *Elts[] = {
196 GetTagConstant(VMContext, dwarf::DW_TAG_base_type),
David Blaikieabec74b2013-03-19 23:25:22 +0000197 NULL, // File/directory name
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000198 NULL, //TheCU,
Benjamin Kramered8b7bf2010-11-04 18:45:27 +0000199 MDString::get(VMContext, Name),
Benjamin Kramered8b7bf2010-11-04 18:45:27 +0000200 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
201 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
202 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
203 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
204 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags;
205 ConstantInt::get(Type::getInt32Ty(VMContext), Encoding)
206 };
David Blaikie5692e722013-03-28 02:44:59 +0000207 return DIBasicType(MDNode::get(VMContext, Elts));
Devang Patel57c5a202010-11-04 15:01:38 +0000208}
209
Nick Lewycky47eebcf2011-11-09 22:45:04 +0000210/// createQualifiedType - Create debugging information entry for a qualified
Devang Patel57c5a202010-11-04 15:01:38 +0000211/// type, e.g. 'const int'.
David Blaikief11de2f2013-02-18 06:41:57 +0000212DIDerivedType DIBuilder::createQualifiedType(unsigned Tag, DIType FromTy) {
Benjamin Kramered8b7bf2010-11-04 18:45:27 +0000213 // Qualified types are encoded in DIDerivedType format.
214 Value *Elts[] = {
215 GetTagConstant(VMContext, Tag),
David Blaikieabec74b2013-03-19 23:25:22 +0000216 NULL, // Filename
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000217 NULL, //TheCU,
Benjamin Kramered8b7bf2010-11-04 18:45:27 +0000218 MDString::get(VMContext, StringRef()), // Empty name.
Benjamin Kramered8b7bf2010-11-04 18:45:27 +0000219 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
220 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Size
221 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Align
222 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
223 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags
224 FromTy
225 };
David Blaikie5692e722013-03-28 02:44:59 +0000226 return DIDerivedType(MDNode::get(VMContext, Elts));
Devang Patel57c5a202010-11-04 15:01:38 +0000227}
228
Devang Patel9b412732011-02-22 18:56:12 +0000229/// createPointerType - Create debugging information entry for a pointer.
David Blaikief11de2f2013-02-18 06:41:57 +0000230DIDerivedType
231DIBuilder::createPointerType(DIType PointeeTy, uint64_t SizeInBits,
232 uint64_t AlignInBits, StringRef Name) {
Benjamin Kramered8b7bf2010-11-04 18:45:27 +0000233 // Pointer types are encoded in DIDerivedType format.
234 Value *Elts[] = {
235 GetTagConstant(VMContext, dwarf::DW_TAG_pointer_type),
David Blaikieabec74b2013-03-19 23:25:22 +0000236 NULL, // Filename
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000237 NULL, //TheCU,
Benjamin Kramered8b7bf2010-11-04 18:45:27 +0000238 MDString::get(VMContext, Name),
Benjamin Kramered8b7bf2010-11-04 18:45:27 +0000239 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
240 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
241 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
242 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
243 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags
244 PointeeTy
245 };
David Blaikie5692e722013-03-28 02:44:59 +0000246 return DIDerivedType(MDNode::get(VMContext, Elts));
Devang Patel57c5a202010-11-04 15:01:38 +0000247}
248
David Blaikief11de2f2013-02-18 06:41:57 +0000249DIDerivedType DIBuilder::createMemberPointerType(DIType PointeeTy, DIType Base) {
David Blaikie5d3249b2013-01-07 05:51:15 +0000250 // Pointer types are encoded in DIDerivedType format.
251 Value *Elts[] = {
252 GetTagConstant(VMContext, dwarf::DW_TAG_ptr_to_member_type),
David Blaikieabec74b2013-03-19 23:25:22 +0000253 NULL, // Filename
David Blaikie5d3249b2013-01-07 05:51:15 +0000254 NULL, //TheCU,
255 NULL,
David Blaikie5d3249b2013-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 Blaikie5692e722013-03-28 02:44:59 +0000264 return DIDerivedType(MDNode::get(VMContext, Elts));
David Blaikie5d3249b2013-01-07 05:51:15 +0000265}
266
Eric Christopherb5cf66c2012-05-19 01:36:37 +0000267/// createReferenceType - Create debugging information entry for a reference
268/// type.
David Blaikief11de2f2013-02-18 06:41:57 +0000269DIDerivedType DIBuilder::createReferenceType(unsigned Tag, DIType RTy) {
Devang Patel1ad1abe2011-09-12 18:26:08 +0000270 assert(RTy.Verify() && "Unable to create reference type");
Benjamin Kramered8b7bf2010-11-04 18:45:27 +0000271 // References are encoded in DIDerivedType format.
272 Value *Elts[] = {
Eric Christopherb5cf66c2012-05-19 01:36:37 +0000273 GetTagConstant(VMContext, Tag),
David Blaikieabec74b2013-03-19 23:25:22 +0000274 NULL, // Filename
Eric Christopher3cc90fe2011-08-26 21:02:40 +0000275 NULL, // TheCU,
Benjamin Kramered8b7bf2010-11-04 18:45:27 +0000276 NULL, // Name
Benjamin Kramered8b7bf2010-11-04 18:45:27 +0000277 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
278 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Size
279 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Align
280 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
281 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags
282 RTy
283 };
David Blaikie5692e722013-03-28 02:44:59 +0000284 return DIDerivedType(MDNode::get(VMContext, Elts));
Devang Patel57c5a202010-11-04 15:01:38 +0000285}
286
Devang Patel9b412732011-02-22 18:56:12 +0000287/// createTypedef - Create debugging information entry for a typedef.
David Blaikief11de2f2013-02-18 06:41:57 +0000288DIDerivedType DIBuilder::createTypedef(DIType Ty, StringRef Name, DIFile File,
289 unsigned LineNo, DIDescriptor Context) {
Benjamin Kramered8b7bf2010-11-04 18:45:27 +0000290 // typedefs are encoded in DIDerivedType format.
291 assert(Ty.Verify() && "Invalid typedef type!");
292 Value *Elts[] = {
293 GetTagConstant(VMContext, dwarf::DW_TAG_typedef),
David Blaikie200b6ed2013-03-20 00:26:26 +0000294 File.getFileNode(),
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000295 getNonCompileUnitScope(Context),
Benjamin Kramered8b7bf2010-11-04 18:45:27 +0000296 MDString::get(VMContext, Name),
Benjamin Kramered8b7bf2010-11-04 18:45:27 +0000297 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
298 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Size
299 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Align
300 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
301 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags
302 Ty
303 };
David Blaikie5692e722013-03-28 02:44:59 +0000304 return DIDerivedType(MDNode::get(VMContext, Elts));
Devang Patel57c5a202010-11-04 15:01:38 +0000305}
306
Devang Patel9b412732011-02-22 18:56:12 +0000307/// createFriend - Create debugging information entry for a 'friend'.
308DIType DIBuilder::createFriend(DIType Ty, DIType FriendTy) {
Benjamin Kramered8b7bf2010-11-04 18:45:27 +0000309 // typedefs are encoded in DIDerivedType format.
310 assert(Ty.Verify() && "Invalid type!");
311 assert(FriendTy.Verify() && "Invalid friend type!");
312 Value *Elts[] = {
313 GetTagConstant(VMContext, dwarf::DW_TAG_friend),
David Blaikieabec74b2013-03-19 23:25:22 +0000314 NULL,
Benjamin Kramered8b7bf2010-11-04 18:45:27 +0000315 Ty,
316 NULL, // Name
Benjamin Kramered8b7bf2010-11-04 18:45:27 +0000317 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
318 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Size
319 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Align
320 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
321 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags
322 FriendTy
323 };
David Blaikie5692e722013-03-28 02:44:59 +0000324 return DIType(MDNode::get(VMContext, Elts));
Devang Patel57c5a202010-11-04 15:01:38 +0000325}
326
Devang Patel9b412732011-02-22 18:56:12 +0000327/// createInheritance - Create debugging information entry to establish
Eric Christopher777c9282011-09-12 19:58:22 +0000328/// inheritance relationship between two types.
David Blaikief11de2f2013-02-18 06:41:57 +0000329DIDerivedType DIBuilder::createInheritance(
330 DIType Ty, DIType BaseTy, uint64_t BaseOffset, unsigned Flags) {
Devang Patel1ad1abe2011-09-12 18:26:08 +0000331 assert(Ty.Verify() && "Unable to create inheritance");
Benjamin Kramered8b7bf2010-11-04 18:45:27 +0000332 // TAG_inheritance is encoded in DIDerivedType format.
333 Value *Elts[] = {
334 GetTagConstant(VMContext, dwarf::DW_TAG_inheritance),
David Blaikieabec74b2013-03-19 23:25:22 +0000335 NULL,
Benjamin Kramered8b7bf2010-11-04 18:45:27 +0000336 Ty,
337 NULL, // Name
Benjamin Kramered8b7bf2010-11-04 18:45:27 +0000338 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
339 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Size
340 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Align
341 ConstantInt::get(Type::getInt64Ty(VMContext), BaseOffset),
342 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
343 BaseTy
344 };
David Blaikie5692e722013-03-28 02:44:59 +0000345 return DIDerivedType(MDNode::get(VMContext, Elts));
Devang Patel57c5a202010-11-04 15:01:38 +0000346}
347
Devang Patel9b412732011-02-22 18:56:12 +0000348/// createMemberType - Create debugging information entry for a member.
David Blaikief11de2f2013-02-18 06:41:57 +0000349DIDerivedType DIBuilder::createMemberType(
350 DIDescriptor Scope, StringRef Name, DIFile File, unsigned LineNumber,
351 uint64_t SizeInBits, uint64_t AlignInBits, uint64_t OffsetInBits,
352 unsigned Flags, DIType Ty) {
Benjamin Kramered8b7bf2010-11-04 18:45:27 +0000353 // TAG_member is encoded in DIDerivedType format.
354 Value *Elts[] = {
355 GetTagConstant(VMContext, dwarf::DW_TAG_member),
David Blaikie200b6ed2013-03-20 00:26:26 +0000356 File.getFileNode(),
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000357 getNonCompileUnitScope(Scope),
Benjamin Kramered8b7bf2010-11-04 18:45:27 +0000358 MDString::get(VMContext, Name),
Benjamin Kramered8b7bf2010-11-04 18:45:27 +0000359 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
360 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
361 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
362 ConstantInt::get(Type::getInt64Ty(VMContext), OffsetInBits),
363 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
364 Ty
365 };
David Blaikie5692e722013-03-28 02:44:59 +0000366 return DIDerivedType(MDNode::get(VMContext, Elts));
Devang Patel57c5a202010-11-04 15:01:38 +0000367}
368
Eric Christopher4d23a4a2013-01-16 01:22:23 +0000369/// createStaticMemberType - Create debugging information entry for a
370/// C++ static data member.
371DIType DIBuilder::createStaticMemberType(DIDescriptor Scope, StringRef Name,
372 DIFile File, unsigned LineNumber,
373 DIType Ty, unsigned Flags,
374 llvm::Value *Val) {
375 // TAG_member is encoded in DIDerivedType format.
376 Flags |= DIDescriptor::FlagStaticMember;
377 Value *Elts[] = {
378 GetTagConstant(VMContext, dwarf::DW_TAG_member),
David Blaikie200b6ed2013-03-20 00:26:26 +0000379 File.getFileNode(),
Eric Christopher4d23a4a2013-01-16 01:22:23 +0000380 getNonCompileUnitScope(Scope),
381 MDString::get(VMContext, Name),
Eric Christopher4d23a4a2013-01-16 01:22:23 +0000382 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
383 ConstantInt::get(Type::getInt64Ty(VMContext), 0/*SizeInBits*/),
384 ConstantInt::get(Type::getInt64Ty(VMContext), 0/*AlignInBits*/),
385 ConstantInt::get(Type::getInt64Ty(VMContext), 0/*OffsetInBits*/),
386 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
387 Ty,
388 Val
389 };
David Blaikie5692e722013-03-28 02:44:59 +0000390 return DIType(MDNode::get(VMContext, Elts));
Eric Christopher4d23a4a2013-01-16 01:22:23 +0000391}
392
Devang Patel514b4002011-04-16 00:11:51 +0000393/// createObjCIVar - Create debugging information entry for Objective-C
394/// instance variable.
Eric Christopher3cc90fe2011-08-26 21:02:40 +0000395DIType DIBuilder::createObjCIVar(StringRef Name,
396 DIFile File, unsigned LineNumber,
Devang Patel514b4002011-04-16 00:11:51 +0000397 uint64_t SizeInBits, uint64_t AlignInBits,
Eric Christopher3cc90fe2011-08-26 21:02:40 +0000398 uint64_t OffsetInBits, unsigned Flags,
Devang Patel514b4002011-04-16 00:11:51 +0000399 DIType Ty, StringRef PropertyName,
400 StringRef GetterName, StringRef SetterName,
401 unsigned PropertyAttributes) {
402 // TAG_member is encoded in DIDerivedType format.
403 Value *Elts[] = {
404 GetTagConstant(VMContext, dwarf::DW_TAG_member),
David Blaikie200b6ed2013-03-20 00:26:26 +0000405 File.getFileNode(),
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000406 getNonCompileUnitScope(File),
Devang Patel514b4002011-04-16 00:11:51 +0000407 MDString::get(VMContext, Name),
Devang Patel514b4002011-04-16 00:11:51 +0000408 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
409 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
410 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
411 ConstantInt::get(Type::getInt64Ty(VMContext), OffsetInBits),
412 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
413 Ty,
414 MDString::get(VMContext, PropertyName),
415 MDString::get(VMContext, GetterName),
416 MDString::get(VMContext, SetterName),
417 ConstantInt::get(Type::getInt32Ty(VMContext), PropertyAttributes)
418 };
David Blaikie5692e722013-03-28 02:44:59 +0000419 return DIType(MDNode::get(VMContext, Elts));
Devang Patel514b4002011-04-16 00:11:51 +0000420}
421
Devang Patel44882172012-02-06 17:49:43 +0000422/// createObjCIVar - Create debugging information entry for Objective-C
423/// instance variable.
424DIType DIBuilder::createObjCIVar(StringRef Name,
425 DIFile File, unsigned LineNumber,
426 uint64_t SizeInBits, uint64_t AlignInBits,
427 uint64_t OffsetInBits, unsigned Flags,
428 DIType Ty, MDNode *PropertyNode) {
429 // TAG_member is encoded in DIDerivedType format.
430 Value *Elts[] = {
431 GetTagConstant(VMContext, dwarf::DW_TAG_member),
David Blaikie200b6ed2013-03-20 00:26:26 +0000432 File.getFileNode(),
Devang Patel44882172012-02-06 17:49:43 +0000433 getNonCompileUnitScope(File),
434 MDString::get(VMContext, Name),
Devang Patel44882172012-02-06 17:49:43 +0000435 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
436 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
437 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
438 ConstantInt::get(Type::getInt64Ty(VMContext), OffsetInBits),
439 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
440 Ty,
441 PropertyNode
442 };
David Blaikie5692e722013-03-28 02:44:59 +0000443 return DIType(MDNode::get(VMContext, Elts));
Devang Patel44882172012-02-06 17:49:43 +0000444}
445
Devang Patelcc481592012-02-04 00:59:25 +0000446/// createObjCProperty - Create debugging information entry for Objective-C
447/// property.
Eric Christopher70e1bd82012-03-29 08:42:56 +0000448DIObjCProperty DIBuilder::createObjCProperty(StringRef Name,
Eric Christopher17426692012-07-06 02:35:57 +0000449 DIFile File, unsigned LineNumber,
Devang Patelcc481592012-02-04 00:59:25 +0000450 StringRef GetterName,
451 StringRef SetterName,
Eric Christopher70e1bd82012-03-29 08:42:56 +0000452 unsigned PropertyAttributes,
Eric Christopher17426692012-07-06 02:35:57 +0000453 DIType Ty) {
Devang Patelcc481592012-02-04 00:59:25 +0000454 Value *Elts[] = {
Eric Christopherc13fd6d2012-03-29 21:35:05 +0000455 GetTagConstant(VMContext, dwarf::DW_TAG_APPLE_property),
Devang Patelcc481592012-02-04 00:59:25 +0000456 MDString::get(VMContext, Name),
Eric Christopher70e1bd82012-03-29 08:42:56 +0000457 File,
458 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
Devang Patelcc481592012-02-04 00:59:25 +0000459 MDString::get(VMContext, GetterName),
460 MDString::get(VMContext, SetterName),
Eric Christopher70e1bd82012-03-29 08:42:56 +0000461 ConstantInt::get(Type::getInt32Ty(VMContext), PropertyAttributes),
462 Ty
Devang Patelcc481592012-02-04 00:59:25 +0000463 };
David Blaikie5692e722013-03-28 02:44:59 +0000464 return DIObjCProperty(MDNode::get(VMContext, Elts));
Devang Patelcc481592012-02-04 00:59:25 +0000465}
466
Devang Patel9b412732011-02-22 18:56:12 +0000467/// createTemplateTypeParameter - Create debugging information for template
Devang Patel3a9e65e2011-02-02 21:38:25 +0000468/// type parameter.
Eric Christopher3cc90fe2011-08-26 21:02:40 +0000469DITemplateTypeParameter
Devang Patel9b412732011-02-22 18:56:12 +0000470DIBuilder::createTemplateTypeParameter(DIDescriptor Context, StringRef Name,
Devang Patel3a9e65e2011-02-02 21:38:25 +0000471 DIType Ty, MDNode *File, unsigned LineNo,
472 unsigned ColumnNo) {
473 Value *Elts[] = {
474 GetTagConstant(VMContext, dwarf::DW_TAG_template_type_parameter),
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000475 getNonCompileUnitScope(Context),
Devang Patel3a9e65e2011-02-02 21:38:25 +0000476 MDString::get(VMContext, Name),
477 Ty,
478 File,
479 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
480 ConstantInt::get(Type::getInt32Ty(VMContext), ColumnNo)
481 };
David Blaikie5692e722013-03-28 02:44:59 +0000482 return DITemplateTypeParameter(MDNode::get(VMContext, Elts));
Devang Patel3a9e65e2011-02-02 21:38:25 +0000483}
484
Devang Patel9b412732011-02-22 18:56:12 +0000485/// createTemplateValueParameter - Create debugging information for template
Devang Patelbe933b42011-02-02 22:35:53 +0000486/// value parameter.
Eric Christopher3cc90fe2011-08-26 21:02:40 +0000487DITemplateValueParameter
Devang Patel9b412732011-02-22 18:56:12 +0000488DIBuilder::createTemplateValueParameter(DIDescriptor Context, StringRef Name,
Devang Patelbe933b42011-02-02 22:35:53 +0000489 DIType Ty, uint64_t Val,
490 MDNode *File, unsigned LineNo,
491 unsigned ColumnNo) {
492 Value *Elts[] = {
493 GetTagConstant(VMContext, dwarf::DW_TAG_template_value_parameter),
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000494 getNonCompileUnitScope(Context),
Devang Patelbe933b42011-02-02 22:35:53 +0000495 MDString::get(VMContext, Name),
496 Ty,
497 ConstantInt::get(Type::getInt64Ty(VMContext), Val),
498 File,
499 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
500 ConstantInt::get(Type::getInt32Ty(VMContext), ColumnNo)
501 };
David Blaikie5692e722013-03-28 02:44:59 +0000502 return DITemplateValueParameter(MDNode::get(VMContext, Elts));
Devang Patelbe933b42011-02-02 22:35:53 +0000503}
504
Eric Christopher17426692012-07-06 02:35:57 +0000505/// createClassType - Create debugging information entry for a class.
David Blaikiea7310a32013-03-26 23:46:39 +0000506DICompositeType DIBuilder::createClassType(DIDescriptor Context, StringRef Name,
507 DIFile File, unsigned LineNumber,
508 uint64_t SizeInBits,
509 uint64_t AlignInBits,
510 uint64_t OffsetInBits,
511 unsigned Flags, DIType DerivedFrom,
512 DIArray Elements,
513 MDNode *VTableHolder,
514 MDNode *TemplateParams) {
David Blaikie085abe32013-03-11 23:21:19 +0000515 assert((!Context || Context.Verify()) &&
516 "createClassType should be called with a valid Context");
517 // TAG_class_type is encoded in DICompositeType format.
Eric Christopher17426692012-07-06 02:35:57 +0000518 Value *Elts[] = {
519 GetTagConstant(VMContext, dwarf::DW_TAG_class_type),
David Blaikie200b6ed2013-03-20 00:26:26 +0000520 File.getFileNode(),
Eric Christopher17426692012-07-06 02:35:57 +0000521 getNonCompileUnitScope(Context),
522 MDString::get(VMContext, Name),
Eric Christopher17426692012-07-06 02:35:57 +0000523 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
524 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
525 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
526 ConstantInt::get(Type::getInt32Ty(VMContext), OffsetInBits),
527 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
528 DerivedFrom,
529 Elements,
530 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
531 VTableHolder,
532 TemplateParams
533 };
David Blaikiea7310a32013-03-26 23:46:39 +0000534 DICompositeType R(MDNode::get(VMContext, Elts));
David Blaikie085abe32013-03-11 23:21:19 +0000535 assert(R.Verify() && "createClassType should return a verifiable DIType");
536 return R;
Eric Christopher17426692012-07-06 02:35:57 +0000537}
538
Devang Patel9b412732011-02-22 18:56:12 +0000539/// createStructType - Create debugging information entry for a struct.
David Blaikiebbe0e1a2013-02-25 01:07:18 +0000540DICompositeType DIBuilder::createStructType(DIDescriptor Context,
541 StringRef Name, DIFile File,
542 unsigned LineNumber,
543 uint64_t SizeInBits,
544 uint64_t AlignInBits,
545 unsigned Flags, DIType DerivedFrom,
546 DIArray Elements,
547 unsigned RunTimeLang,
548 MDNode *VTableHolder) {
Devang Patel746660f2010-12-07 23:25:47 +0000549 // TAG_structure_type is encoded in DICompositeType format.
550 Value *Elts[] = {
551 GetTagConstant(VMContext, dwarf::DW_TAG_structure_type),
David Blaikie200b6ed2013-03-20 00:26:26 +0000552 File.getFileNode(),
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000553 getNonCompileUnitScope(Context),
Devang Patel746660f2010-12-07 23:25:47 +0000554 MDString::get(VMContext, Name),
Devang Patel746660f2010-12-07 23:25:47 +0000555 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
556 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
557 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
Devang Patel89ea4f22010-12-08 01:50:15 +0000558 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
Devang Patel746660f2010-12-07 23:25:47 +0000559 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
David Blaikiebbe0e1a2013-02-25 01:07:18 +0000560 DerivedFrom,
Devang Patel746660f2010-12-07 23:25:47 +0000561 Elements,
562 ConstantInt::get(Type::getInt32Ty(VMContext), RunTimeLang),
David Blaikiebbe0e1a2013-02-25 01:07:18 +0000563 VTableHolder,
David Blaikie12bbf712013-02-18 07:27:30 +0000564 NULL,
Devang Patel746660f2010-12-07 23:25:47 +0000565 };
David Blaikie085abe32013-03-11 23:21:19 +0000566 DICompositeType R(MDNode::get(VMContext, Elts));
567 assert(R.Verify() && "createStructType should return a verifiable DIType");
568 return R;
Devang Patel746660f2010-12-07 23:25:47 +0000569}
570
Devang Patel9b412732011-02-22 18:56:12 +0000571/// createUnionType - Create debugging information entry for an union.
Eric Christopher17dd8f02013-04-02 22:55:52 +0000572DICompositeType DIBuilder::createUnionType(DIDescriptor Scope, StringRef Name,
573 DIFile File, unsigned LineNumber,
574 uint64_t SizeInBits,
575 uint64_t AlignInBits, unsigned Flags,
576 DIArray Elements,
577 unsigned RunTimeLang) {
Devang Patel89ea4f22010-12-08 01:50:15 +0000578 // TAG_union_type is encoded in DICompositeType format.
579 Value *Elts[] = {
580 GetTagConstant(VMContext, dwarf::DW_TAG_union_type),
David Blaikie200b6ed2013-03-20 00:26:26 +0000581 File.getFileNode(),
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000582 getNonCompileUnitScope(Scope),
Devang Patel89ea4f22010-12-08 01:50:15 +0000583 MDString::get(VMContext, Name),
Devang Patel89ea4f22010-12-08 01:50:15 +0000584 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
585 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
586 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
587 ConstantInt::get(Type::getInt64Ty(VMContext), 0),
588 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
Devang Patel78847f02011-12-16 17:51:31 +0000589 NULL,
Devang Patel89ea4f22010-12-08 01:50:15 +0000590 Elements,
591 ConstantInt::get(Type::getInt32Ty(VMContext), RunTimeLang),
Eric Christopher6476f902013-04-02 22:55:56 +0000592 Constant::getNullValue(Type::getInt32Ty(VMContext)),
593 NULL
Devang Patel89ea4f22010-12-08 01:50:15 +0000594 };
David Blaikie5692e722013-03-28 02:44:59 +0000595 return DICompositeType(MDNode::get(VMContext, Elts));
Devang Patel89ea4f22010-12-08 01:50:15 +0000596}
597
Devang Patel9b412732011-02-22 18:56:12 +0000598/// createSubroutineType - Create subroutine type.
David Blaikief11de2f2013-02-18 06:41:57 +0000599DICompositeType
600DIBuilder::createSubroutineType(DIFile File, DIArray ParameterTypes) {
Devang Patel89ea4f22010-12-08 01:50:15 +0000601 // TAG_subroutine_type is encoded in DICompositeType format.
602 Value *Elts[] = {
603 GetTagConstant(VMContext, dwarf::DW_TAG_subroutine_type),
Bill Wendling7154c432012-07-06 17:47:36 +0000604 Constant::getNullValue(Type::getInt32Ty(VMContext)),
Bill Wendling7154c432012-07-06 17:47:36 +0000605 Constant::getNullValue(Type::getInt32Ty(VMContext)),
David Blaikieabec74b2013-03-19 23:25:22 +0000606 MDString::get(VMContext, ""),
Devang Patel89ea4f22010-12-08 01:50:15 +0000607 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
608 ConstantInt::get(Type::getInt64Ty(VMContext), 0),
609 ConstantInt::get(Type::getInt64Ty(VMContext), 0),
Devang Patel78847f02011-12-16 17:51:31 +0000610 ConstantInt::get(Type::getInt64Ty(VMContext), 0),
Devang Patel89ea4f22010-12-08 01:50:15 +0000611 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
Devang Patel78847f02011-12-16 17:51:31 +0000612 NULL,
Devang Patel89ea4f22010-12-08 01:50:15 +0000613 ParameterTypes,
614 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
Bill Wendling5ef31592012-07-06 17:49:19 +0000615 Constant::getNullValue(Type::getInt32Ty(VMContext))
Devang Patel89ea4f22010-12-08 01:50:15 +0000616 };
David Blaikie5692e722013-03-28 02:44:59 +0000617 return DICompositeType(MDNode::get(VMContext, Elts));
Devang Patel89ea4f22010-12-08 01:50:15 +0000618}
619
Eric Christopher3cc90fe2011-08-26 21:02:40 +0000620/// createEnumerationType - Create debugging information entry for an
Devang Patel89ea4f22010-12-08 01:50:15 +0000621/// enumeration.
David Blaikief11de2f2013-02-18 06:41:57 +0000622DICompositeType DIBuilder::createEnumerationType(
623 DIDescriptor Scope, StringRef Name, DIFile File, unsigned LineNumber,
624 uint64_t SizeInBits, uint64_t AlignInBits, DIArray Elements,
625 DIType ClassType) {
Devang Patel89ea4f22010-12-08 01:50:15 +0000626 // TAG_enumeration_type is encoded in DICompositeType format.
627 Value *Elts[] = {
628 GetTagConstant(VMContext, dwarf::DW_TAG_enumeration_type),
David Blaikie200b6ed2013-03-20 00:26:26 +0000629 File.getFileNode(),
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000630 getNonCompileUnitScope(Scope),
Devang Patel89ea4f22010-12-08 01:50:15 +0000631 MDString::get(VMContext, Name),
Devang Patel89ea4f22010-12-08 01:50:15 +0000632 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
633 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
634 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
635 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
Eli Friedmanc6c86c42012-10-05 01:49:14 +0000636 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
Eric Christopherc4964352012-05-23 00:09:20 +0000637 ClassType,
Devang Patel89ea4f22010-12-08 01:50:15 +0000638 Elements,
639 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
Bill Wendling5ef31592012-07-06 17:49:19 +0000640 Constant::getNullValue(Type::getInt32Ty(VMContext))
Devang Patel89ea4f22010-12-08 01:50:15 +0000641 };
Devang Patel0c773242011-04-18 23:51:03 +0000642 MDNode *Node = MDNode::get(VMContext, Elts);
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000643 AllEnumTypes.push_back(Node);
David Blaikie5692e722013-03-28 02:44:59 +0000644 return DICompositeType(Node);
Devang Patel89ea4f22010-12-08 01:50:15 +0000645}
646
Devang Patel9b412732011-02-22 18:56:12 +0000647/// createArrayType - Create debugging information entry for an array.
David Blaikief11de2f2013-02-18 06:41:57 +0000648DICompositeType DIBuilder::createArrayType(uint64_t Size, uint64_t AlignInBits,
649 DIType Ty, DIArray Subscripts) {
Devang Patel89ea4f22010-12-08 01:50:15 +0000650 // TAG_array_type is encoded in DICompositeType format.
651 Value *Elts[] = {
652 GetTagConstant(VMContext, dwarf::DW_TAG_array_type),
David Blaikieabec74b2013-03-19 23:25:22 +0000653 NULL, // Filename/Directory,
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000654 NULL, //TheCU,
Devang Patel89ea4f22010-12-08 01:50:15 +0000655 MDString::get(VMContext, ""),
Devang Patel89ea4f22010-12-08 01:50:15 +0000656 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
657 ConstantInt::get(Type::getInt64Ty(VMContext), Size),
658 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
659 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
660 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
661 Ty,
662 Subscripts,
663 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
Bill Wendling5ef31592012-07-06 17:49:19 +0000664 Constant::getNullValue(Type::getInt32Ty(VMContext))
Devang Patel89ea4f22010-12-08 01:50:15 +0000665 };
David Blaikie5692e722013-03-28 02:44:59 +0000666 return DICompositeType(MDNode::get(VMContext, Elts));
Devang Patel89ea4f22010-12-08 01:50:15 +0000667}
668
Devang Patel9b412732011-02-22 18:56:12 +0000669/// createVectorType - Create debugging information entry for a vector.
Eric Christopher3cc90fe2011-08-26 21:02:40 +0000670DIType DIBuilder::createVectorType(uint64_t Size, uint64_t AlignInBits,
Devang Patel89ea4f22010-12-08 01:50:15 +0000671 DIType Ty, DIArray Subscripts) {
Eric Christopher72a52952013-01-08 01:53:52 +0000672
673 // A vector is an array type with the FlagVector flag applied.
Devang Patel89ea4f22010-12-08 01:50:15 +0000674 Value *Elts[] = {
Eric Christopher72a52952013-01-08 01:53:52 +0000675 GetTagConstant(VMContext, dwarf::DW_TAG_array_type),
David Blaikieabec74b2013-03-19 23:25:22 +0000676 NULL, // Filename/Directory,
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000677 NULL, //TheCU,
Devang Patel89ea4f22010-12-08 01:50:15 +0000678 MDString::get(VMContext, ""),
Devang Patel89ea4f22010-12-08 01:50:15 +0000679 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
680 ConstantInt::get(Type::getInt64Ty(VMContext), Size),
681 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
682 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
Eric Christopher72a52952013-01-08 01:53:52 +0000683 ConstantInt::get(Type::getInt32Ty(VMContext), DIType::FlagVector),
Devang Patel89ea4f22010-12-08 01:50:15 +0000684 Ty,
685 Subscripts,
686 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
Bill Wendling5ef31592012-07-06 17:49:19 +0000687 Constant::getNullValue(Type::getInt32Ty(VMContext))
Devang Patel89ea4f22010-12-08 01:50:15 +0000688 };
David Blaikie5692e722013-03-28 02:44:59 +0000689 return DIType(MDNode::get(VMContext, Elts));
Devang Patel89ea4f22010-12-08 01:50:15 +0000690}
Devang Patel746660f2010-12-07 23:25:47 +0000691
Devang Patel9b412732011-02-22 18:56:12 +0000692/// createArtificialType - Create a new DIType with "artificial" flag set.
693DIType DIBuilder::createArtificialType(DIType Ty) {
Devang Patel57c5a202010-11-04 15:01:38 +0000694 if (Ty.isArtificial())
695 return Ty;
696
697 SmallVector<Value *, 9> Elts;
698 MDNode *N = Ty;
699 assert (N && "Unexpected input DIType!");
700 for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i) {
701 if (Value *V = N->getOperand(i))
702 Elts.push_back(V);
703 else
704 Elts.push_back(Constant::getNullValue(Type::getInt32Ty(VMContext)));
705 }
706
707 unsigned CurFlags = Ty.getFlags();
708 CurFlags = CurFlags | DIType::FlagArtificial;
709
710 // Flags are stored at this slot.
David Blaikie5692e722013-03-28 02:44:59 +0000711 Elts[8] = ConstantInt::get(Type::getInt32Ty(VMContext), CurFlags);
Devang Patel57c5a202010-11-04 15:01:38 +0000712
David Blaikie5692e722013-03-28 02:44:59 +0000713 return DIType(MDNode::get(VMContext, Elts));
Devang Patel57c5a202010-11-04 15:01:38 +0000714}
Devang Patel746660f2010-12-07 23:25:47 +0000715
Eric Christopher9bd36092013-01-08 01:53:42 +0000716/// createObjectPointerType - Create a new type with both the object pointer
717/// and artificial flags set.
Eric Christophere3417762012-09-12 23:36:19 +0000718DIType DIBuilder::createObjectPointerType(DIType Ty) {
719 if (Ty.isObjectPointer())
720 return Ty;
721
722 SmallVector<Value *, 9> Elts;
723 MDNode *N = Ty;
724 assert (N && "Unexpected input DIType!");
725 for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i) {
726 if (Value *V = N->getOperand(i))
727 Elts.push_back(V);
728 else
729 Elts.push_back(Constant::getNullValue(Type::getInt32Ty(VMContext)));
730 }
731
732 unsigned CurFlags = Ty.getFlags();
733 CurFlags = CurFlags | (DIType::FlagObjectPointer | DIType::FlagArtificial);
734
735 // Flags are stored at this slot.
David Blaikie5692e722013-03-28 02:44:59 +0000736 Elts[8] = ConstantInt::get(Type::getInt32Ty(VMContext), CurFlags);
Eric Christophere3417762012-09-12 23:36:19 +0000737
David Blaikie5692e722013-03-28 02:44:59 +0000738 return DIType(MDNode::get(VMContext, Elts));
Eric Christophere3417762012-09-12 23:36:19 +0000739}
740
Eric Christopher3cc90fe2011-08-26 21:02:40 +0000741/// retainType - Retain DIType in a module even if it is not referenced
Devang Patel89ea4f22010-12-08 01:50:15 +0000742/// through debug info anchors.
Devang Patel9b412732011-02-22 18:56:12 +0000743void DIBuilder::retainType(DIType T) {
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000744 AllRetainTypes.push_back(T);
Devang Patel89ea4f22010-12-08 01:50:15 +0000745}
746
Devang Patel9b412732011-02-22 18:56:12 +0000747/// createUnspecifiedParameter - Create unspeicified type descriptor
Devang Patel89ea4f22010-12-08 01:50:15 +0000748/// for the subroutine type.
Devang Patel9b412732011-02-22 18:56:12 +0000749DIDescriptor DIBuilder::createUnspecifiedParameter() {
Eric Christopher3cc90fe2011-08-26 21:02:40 +0000750 Value *Elts[] = {
751 GetTagConstant(VMContext, dwarf::DW_TAG_unspecified_parameters)
Devang Patel89ea4f22010-12-08 01:50:15 +0000752 };
Devang Patel0c773242011-04-18 23:51:03 +0000753 return DIDescriptor(MDNode::get(VMContext, Elts));
Devang Patel89ea4f22010-12-08 01:50:15 +0000754}
755
Eric Christopherae56eec2012-02-08 00:22:26 +0000756/// createForwardDecl - Create a temporary forward-declared type that
757/// can be RAUW'd if the full type is seen.
Eric Christopher27deb262012-04-23 19:00:11 +0000758DIType DIBuilder::createForwardDecl(unsigned Tag, StringRef Name,
759 DIDescriptor Scope, DIFile F,
Eli Friedmanc6c86c42012-10-05 01:49:14 +0000760 unsigned Line, unsigned RuntimeLang,
761 uint64_t SizeInBits,
762 uint64_t AlignInBits) {
Eric Christopherae56eec2012-02-08 00:22:26 +0000763 // Create a temporary MDNode.
764 Value *Elts[] = {
765 GetTagConstant(VMContext, Tag),
David Blaikie200b6ed2013-03-20 00:26:26 +0000766 F.getFileNode(),
Eric Christopher27deb262012-04-23 19:00:11 +0000767 getNonCompileUnitScope(Scope),
Eric Christopherae56eec2012-02-08 00:22:26 +0000768 MDString::get(VMContext, Name),
Eric Christopherae56eec2012-02-08 00:22:26 +0000769 ConstantInt::get(Type::getInt32Ty(VMContext), Line),
Eli Friedmanc6c86c42012-10-05 01:49:14 +0000770 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
771 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
Eric Christopherae56eec2012-02-08 00:22:26 +0000772 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
773 ConstantInt::get(Type::getInt32Ty(VMContext),
Eric Christopher89797122012-02-20 18:04:14 +0000774 DIDescriptor::FlagFwdDecl),
775 NULL,
776 DIArray(),
777 ConstantInt::get(Type::getInt32Ty(VMContext), RuntimeLang)
Eric Christopherae56eec2012-02-08 00:22:26 +0000778 };
779 MDNode *Node = MDNode::getTemporary(VMContext, Elts);
David Blaikie085abe32013-03-11 23:21:19 +0000780 assert(DIType(Node).Verify() &&
781 "createForwardDecl result should be verifiable");
Eric Christopherae56eec2012-02-08 00:22:26 +0000782 return DIType(Node);
783}
784
Devang Patel9b412732011-02-22 18:56:12 +0000785/// getOrCreateArray - Get a DIArray, create one if required.
Jay Foaddbf81d82011-04-24 10:11:03 +0000786DIArray DIBuilder::getOrCreateArray(ArrayRef<Value *> Elements) {
787 if (Elements.empty()) {
Bill Wendling7154c432012-07-06 17:47:36 +0000788 Value *Null = Constant::getNullValue(Type::getInt32Ty(VMContext));
Jay Foad5514afe2011-04-21 19:59:31 +0000789 return DIArray(MDNode::get(VMContext, Null));
Devang Patel746660f2010-12-07 23:25:47 +0000790 }
Jay Foaddbf81d82011-04-24 10:11:03 +0000791 return DIArray(MDNode::get(VMContext, Elements));
Devang Patel746660f2010-12-07 23:25:47 +0000792}
793
Devang Patel9b412732011-02-22 18:56:12 +0000794/// getOrCreateSubrange - Create a descriptor for a value range. This
Devang Patel89ea4f22010-12-08 01:50:15 +0000795/// implicitly uniques the values returned.
Bill Wendlingd7767122012-12-04 21:34:03 +0000796DISubrange DIBuilder::getOrCreateSubrange(int64_t Lo, int64_t Count) {
Devang Patel89ea4f22010-12-08 01:50:15 +0000797 Value *Elts[] = {
798 GetTagConstant(VMContext, dwarf::DW_TAG_subrange_type),
799 ConstantInt::get(Type::getInt64Ty(VMContext), Lo),
Bill Wendlingbfc0e572012-12-04 06:20:49 +0000800 ConstantInt::get(Type::getInt64Ty(VMContext), Count)
Devang Patel89ea4f22010-12-08 01:50:15 +0000801 };
802
Devang Patel0c773242011-04-18 23:51:03 +0000803 return DISubrange(MDNode::get(VMContext, Elts));
Devang Patel89ea4f22010-12-08 01:50:15 +0000804}
805
David Blaikie62f1fea2013-03-20 17:49:48 +0000806/// \brief Create a new descriptor for the specified global.
Devang Patel746660f2010-12-07 23:25:47 +0000807DIGlobalVariable DIBuilder::
David Blaikie62f1fea2013-03-20 17:49:48 +0000808createGlobalVariable(StringRef Name, StringRef LinkageName, DIFile F,
809 unsigned LineNumber, DIType Ty, bool isLocalToUnit,
810 Value *Val) {
Devang Patel746660f2010-12-07 23:25:47 +0000811 Value *Elts[] = {
812 GetTagConstant(VMContext, dwarf::DW_TAG_variable),
Bill Wendling7154c432012-07-06 17:47:36 +0000813 Constant::getNullValue(Type::getInt32Ty(VMContext)),
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000814 NULL, // TheCU,
Devang Patel746660f2010-12-07 23:25:47 +0000815 MDString::get(VMContext, Name),
816 MDString::get(VMContext, Name),
David Blaikie62f1fea2013-03-20 17:49:48 +0000817 MDString::get(VMContext, LinkageName),
Devang Patel746660f2010-12-07 23:25:47 +0000818 F,
819 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
820 Ty,
821 ConstantInt::get(Type::getInt32Ty(VMContext), isLocalToUnit),
822 ConstantInt::get(Type::getInt32Ty(VMContext), 1), /* isDefinition*/
Eric Christopher4d23a4a2013-01-16 01:22:23 +0000823 Val,
824 DIDescriptor()
Devang Patel746660f2010-12-07 23:25:47 +0000825 };
Devang Patel0c773242011-04-18 23:51:03 +0000826 MDNode *Node = MDNode::get(VMContext, Elts);
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000827 AllGVs.push_back(Node);
Devang Patel746660f2010-12-07 23:25:47 +0000828 return DIGlobalVariable(Node);
829}
830
David Blaikie62f1fea2013-03-20 17:49:48 +0000831/// \brief Create a new descriptor for the specified global.
832DIGlobalVariable DIBuilder::
833createGlobalVariable(StringRef Name, DIFile F, unsigned LineNumber,
834 DIType Ty, bool isLocalToUnit, Value *Val) {
835 return createGlobalVariable(Name, Name, F, LineNumber, Ty, isLocalToUnit,
836 Val);
837}
838
Devang Patel9b412732011-02-22 18:56:12 +0000839/// createStaticVariable - Create a new descriptor for the specified static
Devang Patel746660f2010-12-07 23:25:47 +0000840/// variable.
841DIGlobalVariable DIBuilder::
Eric Christopher3cc90fe2011-08-26 21:02:40 +0000842createStaticVariable(DIDescriptor Context, StringRef Name,
843 StringRef LinkageName, DIFile F, unsigned LineNumber,
Eric Christopher4d23a4a2013-01-16 01:22:23 +0000844 DIType Ty, bool isLocalToUnit, Value *Val, MDNode *Decl) {
Devang Patel746660f2010-12-07 23:25:47 +0000845 Value *Elts[] = {
846 GetTagConstant(VMContext, dwarf::DW_TAG_variable),
Bill Wendling7154c432012-07-06 17:47:36 +0000847 Constant::getNullValue(Type::getInt32Ty(VMContext)),
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000848 getNonCompileUnitScope(Context),
Devang Patel746660f2010-12-07 23:25:47 +0000849 MDString::get(VMContext, Name),
850 MDString::get(VMContext, Name),
851 MDString::get(VMContext, LinkageName),
852 F,
853 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
854 Ty,
855 ConstantInt::get(Type::getInt32Ty(VMContext), isLocalToUnit),
856 ConstantInt::get(Type::getInt32Ty(VMContext), 1), /* isDefinition*/
Eric Christopher4d23a4a2013-01-16 01:22:23 +0000857 Val,
858 DIDescriptor(Decl)
Devang Patel746660f2010-12-07 23:25:47 +0000859 };
Devang Patel0c773242011-04-18 23:51:03 +0000860 MDNode *Node = MDNode::get(VMContext, Elts);
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000861 AllGVs.push_back(Node);
Devang Patel746660f2010-12-07 23:25:47 +0000862 return DIGlobalVariable(Node);
863}
864
Devang Patel9b412732011-02-22 18:56:12 +0000865/// createVariable - Create a new descriptor for the specified variable.
866DIVariable DIBuilder::createLocalVariable(unsigned Tag, DIDescriptor Scope,
Devang Patel63f83cd2010-12-07 23:58:00 +0000867 StringRef Name, DIFile File,
Eric Christopher3cc90fe2011-08-26 21:02:40 +0000868 unsigned LineNo, DIType Ty,
Devang Patel40eee1e2011-03-01 22:58:13 +0000869 bool AlwaysPreserve, unsigned Flags,
870 unsigned ArgNo) {
David Blaikie085abe32013-03-11 23:21:19 +0000871 DIDescriptor Context(getNonCompileUnitScope(Scope));
872 assert((!Context || Context.Verify()) &&
873 "createLocalVariable should be called with a valid Context");
874 assert(Ty.Verify() &&
875 "createLocalVariable should be called with a valid type");
Devang Patel63f83cd2010-12-07 23:58:00 +0000876 Value *Elts[] = {
877 GetTagConstant(VMContext, Tag),
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000878 getNonCompileUnitScope(Scope),
Devang Patel63f83cd2010-12-07 23:58:00 +0000879 MDString::get(VMContext, Name),
880 File,
Devang Patel40eee1e2011-03-01 22:58:13 +0000881 ConstantInt::get(Type::getInt32Ty(VMContext), (LineNo | (ArgNo << 24))),
Devang Patel63f83cd2010-12-07 23:58:00 +0000882 Ty,
Devang Patelcfa82a32011-07-19 19:41:54 +0000883 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
Bill Wendling5ef31592012-07-06 17:49:19 +0000884 Constant::getNullValue(Type::getInt32Ty(VMContext))
Devang Patel63f83cd2010-12-07 23:58:00 +0000885 };
Devang Patel0c773242011-04-18 23:51:03 +0000886 MDNode *Node = MDNode::get(VMContext, Elts);
Devang Patel63f83cd2010-12-07 23:58:00 +0000887 if (AlwaysPreserve) {
888 // The optimizer may remove local variable. If there is an interest
889 // to preserve variable info in such situation then stash it in a
890 // named mdnode.
891 DISubprogram Fn(getDISubprogram(Scope));
Devang Patel59e27c52011-08-19 23:28:12 +0000892 NamedMDNode *FnLocals = getOrInsertFnSpecificMDNode(M, Fn);
Devang Patel63f83cd2010-12-07 23:58:00 +0000893 FnLocals->addOperand(Node);
894 }
David Blaikie085abe32013-03-11 23:21:19 +0000895 assert(DIVariable(Node).Verify() &&
896 "createLocalVariable should return a verifiable DIVariable");
Devang Patel63f83cd2010-12-07 23:58:00 +0000897 return DIVariable(Node);
898}
899
Devang Patel9b412732011-02-22 18:56:12 +0000900/// createComplexVariable - Create a new descriptor for the specified variable
Devang Patel746660f2010-12-07 23:25:47 +0000901/// which has a complex address expression for its address.
Devang Patel9b412732011-02-22 18:56:12 +0000902DIVariable DIBuilder::createComplexVariable(unsigned Tag, DIDescriptor Scope,
Devang Patel746660f2010-12-07 23:25:47 +0000903 StringRef Name, DIFile F,
904 unsigned LineNo,
Jay Foaddbf81d82011-04-24 10:11:03 +0000905 DIType Ty, ArrayRef<Value *> Addr,
906 unsigned ArgNo) {
Devang Patel746660f2010-12-07 23:25:47 +0000907 SmallVector<Value *, 15> Elts;
908 Elts.push_back(GetTagConstant(VMContext, Tag));
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000909 Elts.push_back(getNonCompileUnitScope(Scope)),
Devang Patel746660f2010-12-07 23:25:47 +0000910 Elts.push_back(MDString::get(VMContext, Name));
911 Elts.push_back(F);
Eric Christopher3cc90fe2011-08-26 21:02:40 +0000912 Elts.push_back(ConstantInt::get(Type::getInt32Ty(VMContext),
Devang Patela93cc252012-02-08 00:17:07 +0000913 (LineNo | (ArgNo << 24))));
Devang Patel746660f2010-12-07 23:25:47 +0000914 Elts.push_back(Ty);
Bill Wendling7154c432012-07-06 17:47:36 +0000915 Elts.push_back(Constant::getNullValue(Type::getInt32Ty(VMContext)));
916 Elts.push_back(Constant::getNullValue(Type::getInt32Ty(VMContext)));
Jay Foaddbf81d82011-04-24 10:11:03 +0000917 Elts.append(Addr.begin(), Addr.end());
Devang Patel746660f2010-12-07 23:25:47 +0000918
Devang Patel0c773242011-04-18 23:51:03 +0000919 return DIVariable(MDNode::get(VMContext, Elts));
Devang Patel746660f2010-12-07 23:25:47 +0000920}
921
Devang Patel9b412732011-02-22 18:56:12 +0000922/// createFunction - Create a new descriptor for the specified function.
923DISubprogram DIBuilder::createFunction(DIDescriptor Context,
Devang Patelb68c6232010-12-08 20:42:44 +0000924 StringRef Name,
925 StringRef LinkageName,
926 DIFile File, unsigned LineNo,
927 DIType Ty,
928 bool isLocalToUnit, bool isDefinition,
Eric Christopher34164192012-04-03 00:43:49 +0000929 unsigned ScopeLine,
Devang Patelb68c6232010-12-08 20:42:44 +0000930 unsigned Flags, bool isOptimized,
Devang Patel9f738842011-04-05 22:52:06 +0000931 Function *Fn,
Devang Patel1d6bbd42011-04-22 23:10:17 +0000932 MDNode *TParams,
933 MDNode *Decl) {
Devang Patel59e27c52011-08-19 23:28:12 +0000934 Value *TElts[] = { GetTagConstant(VMContext, DW_TAG_base_type) };
Devang Patelb68c6232010-12-08 20:42:44 +0000935 Value *Elts[] = {
936 GetTagConstant(VMContext, dwarf::DW_TAG_subprogram),
David Blaikie5ef3fcb2013-03-21 23:08:34 +0000937 File.getFileNode(),
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000938 getNonCompileUnitScope(Context),
Devang Patelb68c6232010-12-08 20:42:44 +0000939 MDString::get(VMContext, Name),
940 MDString::get(VMContext, Name),
941 MDString::get(VMContext, LinkageName),
Devang Patelb68c6232010-12-08 20:42:44 +0000942 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
943 Ty,
944 ConstantInt::get(Type::getInt1Ty(VMContext), isLocalToUnit),
945 ConstantInt::get(Type::getInt1Ty(VMContext), isDefinition),
946 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
947 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
Devang Patelcdd833e2011-12-15 17:55:56 +0000948 NULL,
Devang Patelb68c6232010-12-08 20:42:44 +0000949 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
950 ConstantInt::get(Type::getInt1Ty(VMContext), isOptimized),
Devang Patel9f738842011-04-05 22:52:06 +0000951 Fn,
Devang Patel1d6bbd42011-04-22 23:10:17 +0000952 TParams,
Devang Patel59e27c52011-08-19 23:28:12 +0000953 Decl,
David Blaikie2811f8a2013-02-04 05:56:36 +0000954 MDNode::getTemporary(VMContext, TElts),
Eric Christopher34164192012-04-03 00:43:49 +0000955 ConstantInt::get(Type::getInt32Ty(VMContext), ScopeLine)
Devang Patelb68c6232010-12-08 20:42:44 +0000956 };
Devang Patel0c773242011-04-18 23:51:03 +0000957 MDNode *Node = MDNode::get(VMContext, Elts);
Devang Patelb68c6232010-12-08 20:42:44 +0000958
959 // Create a named metadata so that we do not lose this mdnode.
David Blaikie595eb442013-02-18 07:10:22 +0000960 if (isDefinition)
961 AllSubprograms.push_back(Node);
David Blaikiecc8d0902013-03-21 20:28:52 +0000962 DISubprogram S(Node);
963 assert(S.Verify() && "createFunction should return a valid DISubprogram");
964 return S;
Devang Patelb68c6232010-12-08 20:42:44 +0000965}
966
Devang Patel9b412732011-02-22 18:56:12 +0000967/// createMethod - Create a new descriptor for the specified C++ method.
968DISubprogram DIBuilder::createMethod(DIDescriptor Context,
Devang Patelb68c6232010-12-08 20:42:44 +0000969 StringRef Name,
970 StringRef LinkageName,
971 DIFile F,
972 unsigned LineNo, DIType Ty,
973 bool isLocalToUnit,
974 bool isDefinition,
975 unsigned VK, unsigned VIndex,
976 MDNode *VTableHolder,
977 unsigned Flags,
978 bool isOptimized,
Devang Patel9f738842011-04-05 22:52:06 +0000979 Function *Fn,
980 MDNode *TParam) {
Devang Patel59e27c52011-08-19 23:28:12 +0000981 Value *TElts[] = { GetTagConstant(VMContext, DW_TAG_base_type) };
Devang Patelb68c6232010-12-08 20:42:44 +0000982 Value *Elts[] = {
983 GetTagConstant(VMContext, dwarf::DW_TAG_subprogram),
David Blaikie5ef3fcb2013-03-21 23:08:34 +0000984 F.getFileNode(),
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000985 getNonCompileUnitScope(Context),
Devang Patelb68c6232010-12-08 20:42:44 +0000986 MDString::get(VMContext, Name),
987 MDString::get(VMContext, Name),
988 MDString::get(VMContext, LinkageName),
Devang Patelb68c6232010-12-08 20:42:44 +0000989 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
990 Ty,
991 ConstantInt::get(Type::getInt1Ty(VMContext), isLocalToUnit),
992 ConstantInt::get(Type::getInt1Ty(VMContext), isDefinition),
993 ConstantInt::get(Type::getInt32Ty(VMContext), (unsigned)VK),
994 ConstantInt::get(Type::getInt32Ty(VMContext), VIndex),
995 VTableHolder,
996 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
997 ConstantInt::get(Type::getInt1Ty(VMContext), isOptimized),
Devang Patel9f738842011-04-05 22:52:06 +0000998 Fn,
999 TParam,
Bill Wendling7154c432012-07-06 17:47:36 +00001000 Constant::getNullValue(Type::getInt32Ty(VMContext)),
David Blaikie2811f8a2013-02-04 05:56:36 +00001001 MDNode::getTemporary(VMContext, TElts),
Eric Christopher5d5338f2012-05-18 00:16:22 +00001002 // FIXME: Do we want to use different scope/lines?
Eric Christopher34164192012-04-03 00:43:49 +00001003 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo)
Devang Patelb68c6232010-12-08 20:42:44 +00001004 };
Devang Patel0c773242011-04-18 23:51:03 +00001005 MDNode *Node = MDNode::get(VMContext, Elts);
David Blaikie595eb442013-02-18 07:10:22 +00001006 if (isDefinition)
1007 AllSubprograms.push_back(Node);
David Blaikiecc8d0902013-03-21 20:28:52 +00001008 DISubprogram S(Node);
1009 assert(S.Verify() && "createMethod should return a valid DISubprogram");
1010 return S;
Devang Patelb68c6232010-12-08 20:42:44 +00001011}
1012
Devang Patel9b412732011-02-22 18:56:12 +00001013/// createNameSpace - This creates new descriptor for a namespace
Devang Patel746660f2010-12-07 23:25:47 +00001014/// with the specified parent scope.
Devang Patel9b412732011-02-22 18:56:12 +00001015DINameSpace DIBuilder::createNameSpace(DIDescriptor Scope, StringRef Name,
Devang Patel746660f2010-12-07 23:25:47 +00001016 DIFile File, unsigned LineNo) {
1017 Value *Elts[] = {
1018 GetTagConstant(VMContext, dwarf::DW_TAG_namespace),
David Blaikie2881da72013-03-20 19:39:15 +00001019 File.getFileNode(),
Devang Pateleb1bb4e2011-08-16 22:09:43 +00001020 getNonCompileUnitScope(Scope),
Devang Patel746660f2010-12-07 23:25:47 +00001021 MDString::get(VMContext, Name),
Devang Patel746660f2010-12-07 23:25:47 +00001022 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo)
1023 };
David Blaikie085abe32013-03-11 23:21:19 +00001024 DINameSpace R(MDNode::get(VMContext, Elts));
1025 assert(R.Verify() &&
1026 "createNameSpace should return a verifiable DINameSpace");
1027 return R;
Devang Patel746660f2010-12-07 23:25:47 +00001028}
1029
Eric Christopher6647b832011-10-11 22:59:11 +00001030/// createLexicalBlockFile - This creates a new MDNode that encapsulates
1031/// an existing scope with a new filename.
1032DILexicalBlockFile DIBuilder::createLexicalBlockFile(DIDescriptor Scope,
Devang Patela93cc252012-02-08 00:17:07 +00001033 DIFile File) {
Eric Christopher6647b832011-10-11 22:59:11 +00001034 Value *Elts[] = {
1035 GetTagConstant(VMContext, dwarf::DW_TAG_lexical_block),
David Blaikie61ef2be2013-03-22 20:18:46 +00001036 File.getFileNode(),
David Blaikie7c8dbc12013-03-22 19:13:22 +00001037 Scope
Eric Christopher6647b832011-10-11 22:59:11 +00001038 };
David Blaikie085abe32013-03-11 23:21:19 +00001039 DILexicalBlockFile R(MDNode::get(VMContext, Elts));
1040 assert(
1041 R.Verify() &&
1042 "createLexicalBlockFile should return a verifiable DILexicalBlockFile");
1043 return R;
Eric Christopher6647b832011-10-11 22:59:11 +00001044}
1045
Devang Patel9b412732011-02-22 18:56:12 +00001046DILexicalBlock DIBuilder::createLexicalBlock(DIDescriptor Scope, DIFile File,
Devang Patel89ea4f22010-12-08 01:50:15 +00001047 unsigned Line, unsigned Col) {
1048 // Defeat MDNode uniqing for lexical blocks by using unique id.
1049 static unsigned int unique_id = 0;
1050 Value *Elts[] = {
1051 GetTagConstant(VMContext, dwarf::DW_TAG_lexical_block),
David Blaikie30ce0782013-03-22 17:33:20 +00001052 File.getFileNode(),
Devang Pateleb1bb4e2011-08-16 22:09:43 +00001053 getNonCompileUnitScope(Scope),
Devang Patel89ea4f22010-12-08 01:50:15 +00001054 ConstantInt::get(Type::getInt32Ty(VMContext), Line),
1055 ConstantInt::get(Type::getInt32Ty(VMContext), Col),
Devang Patel89ea4f22010-12-08 01:50:15 +00001056 ConstantInt::get(Type::getInt32Ty(VMContext), unique_id++)
1057 };
David Blaikie085abe32013-03-11 23:21:19 +00001058 DILexicalBlock R(MDNode::get(VMContext, Elts));
1059 assert(R.Verify() &&
1060 "createLexicalBlock should return a verifiable DILexicalBlock");
1061 return R;
Devang Patel89ea4f22010-12-08 01:50:15 +00001062}
1063
Devang Patel9b412732011-02-22 18:56:12 +00001064/// insertDeclare - Insert a new llvm.dbg.declare intrinsic call.
1065Instruction *DIBuilder::insertDeclare(Value *Storage, DIVariable VarInfo,
Devang Patel746660f2010-12-07 23:25:47 +00001066 Instruction *InsertBefore) {
1067 assert(Storage && "no storage passed to dbg.declare");
1068 assert(VarInfo.Verify() && "empty DIVariable passed to dbg.declare");
1069 if (!DeclareFn)
1070 DeclareFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_declare);
1071
Jay Foad5514afe2011-04-21 19:59:31 +00001072 Value *Args[] = { MDNode::get(Storage->getContext(), Storage), VarInfo };
Jay Foad5bd375a2011-07-15 08:37:34 +00001073 return CallInst::Create(DeclareFn, Args, "", InsertBefore);
Devang Patel746660f2010-12-07 23:25:47 +00001074}
1075
Devang Patel9b412732011-02-22 18:56:12 +00001076/// insertDeclare - Insert a new llvm.dbg.declare intrinsic call.
1077Instruction *DIBuilder::insertDeclare(Value *Storage, DIVariable VarInfo,
Devang Patel746660f2010-12-07 23:25:47 +00001078 BasicBlock *InsertAtEnd) {
1079 assert(Storage && "no storage passed to dbg.declare");
1080 assert(VarInfo.Verify() && "invalid DIVariable passed to dbg.declare");
1081 if (!DeclareFn)
1082 DeclareFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_declare);
1083
Jay Foad5514afe2011-04-21 19:59:31 +00001084 Value *Args[] = { MDNode::get(Storage->getContext(), Storage), VarInfo };
Devang Patel746660f2010-12-07 23:25:47 +00001085
1086 // If this block already has a terminator then insert this intrinsic
1087 // before the terminator.
1088 if (TerminatorInst *T = InsertAtEnd->getTerminator())
Jay Foad5bd375a2011-07-15 08:37:34 +00001089 return CallInst::Create(DeclareFn, Args, "", T);
Devang Patel746660f2010-12-07 23:25:47 +00001090 else
Jay Foad5bd375a2011-07-15 08:37:34 +00001091 return CallInst::Create(DeclareFn, Args, "", InsertAtEnd);
Devang Patel746660f2010-12-07 23:25:47 +00001092}
1093
Devang Patel9b412732011-02-22 18:56:12 +00001094/// insertDbgValueIntrinsic - Insert a new llvm.dbg.value intrinsic call.
1095Instruction *DIBuilder::insertDbgValueIntrinsic(Value *V, uint64_t Offset,
Devang Patel746660f2010-12-07 23:25:47 +00001096 DIVariable VarInfo,
1097 Instruction *InsertBefore) {
1098 assert(V && "no value passed to dbg.value");
1099 assert(VarInfo.Verify() && "invalid DIVariable passed to dbg.value");
1100 if (!ValueFn)
1101 ValueFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_value);
1102
Jay Foad5514afe2011-04-21 19:59:31 +00001103 Value *Args[] = { MDNode::get(V->getContext(), V),
Devang Patel746660f2010-12-07 23:25:47 +00001104 ConstantInt::get(Type::getInt64Ty(V->getContext()), Offset),
1105 VarInfo };
Jay Foad5bd375a2011-07-15 08:37:34 +00001106 return CallInst::Create(ValueFn, Args, "", InsertBefore);
Devang Patel746660f2010-12-07 23:25:47 +00001107}
1108
Devang Patel9b412732011-02-22 18:56:12 +00001109/// insertDbgValueIntrinsic - Insert a new llvm.dbg.value intrinsic call.
1110Instruction *DIBuilder::insertDbgValueIntrinsic(Value *V, uint64_t Offset,
Devang Patel746660f2010-12-07 23:25:47 +00001111 DIVariable VarInfo,
1112 BasicBlock *InsertAtEnd) {
1113 assert(V && "no value passed to dbg.value");
1114 assert(VarInfo.Verify() && "invalid DIVariable passed to dbg.value");
1115 if (!ValueFn)
1116 ValueFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_value);
1117
Jay Foad5514afe2011-04-21 19:59:31 +00001118 Value *Args[] = { MDNode::get(V->getContext(), V),
Devang Patel746660f2010-12-07 23:25:47 +00001119 ConstantInt::get(Type::getInt64Ty(V->getContext()), Offset),
1120 VarInfo };
Jay Foad5bd375a2011-07-15 08:37:34 +00001121 return CallInst::Create(ValueFn, Args, "", InsertAtEnd);
Devang Patel746660f2010-12-07 23:25:47 +00001122}