blob: 0980e80aa4cb74046fd73c71ce7ec52a313b3915 [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 Blaikief55abea2013-04-22 06:12:31 +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 Blaikief55abea2013-04-22 06:12:31 +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 Blaikief55abea2013-04-22 06:12:31 +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 Blaikief55abea2013-04-22 06:12:31 +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
Eric Christopher89e594d2013-04-19 20:37:12 +0000249DIDerivedType DIBuilder::createMemberPointerType(DIType PointeeTy,
250 DIType Base) {
David Blaikie5d3249b2013-01-07 05:51:15 +0000251 // Pointer types are encoded in DIDerivedType format.
252 Value *Elts[] = {
253 GetTagConstant(VMContext, dwarf::DW_TAG_ptr_to_member_type),
David Blaikieabec74b2013-03-19 23:25:22 +0000254 NULL, // Filename
David Blaikie5d3249b2013-01-07 05:51:15 +0000255 NULL, //TheCU,
256 NULL,
David Blaikie5d3249b2013-01-07 05:51:15 +0000257 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
258 ConstantInt::get(Type::getInt64Ty(VMContext), 0),
259 ConstantInt::get(Type::getInt64Ty(VMContext), 0),
260 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
261 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags
262 PointeeTy,
263 Base
264 };
David Blaikie5692e722013-03-28 02:44:59 +0000265 return DIDerivedType(MDNode::get(VMContext, Elts));
David Blaikie5d3249b2013-01-07 05:51:15 +0000266}
267
Eric Christopherb5cf66c2012-05-19 01:36:37 +0000268/// createReferenceType - Create debugging information entry for a reference
269/// type.
David Blaikief11de2f2013-02-18 06:41:57 +0000270DIDerivedType DIBuilder::createReferenceType(unsigned Tag, DIType RTy) {
Devang Patel1ad1abe2011-09-12 18:26:08 +0000271 assert(RTy.Verify() && "Unable to create reference type");
Benjamin Kramered8b7bf2010-11-04 18:45:27 +0000272 // References are encoded in DIDerivedType format.
273 Value *Elts[] = {
Eric Christopherb5cf66c2012-05-19 01:36:37 +0000274 GetTagConstant(VMContext, Tag),
David Blaikieabec74b2013-03-19 23:25:22 +0000275 NULL, // Filename
Eric Christopher3cc90fe2011-08-26 21:02:40 +0000276 NULL, // TheCU,
Benjamin Kramered8b7bf2010-11-04 18:45:27 +0000277 NULL, // Name
Benjamin Kramered8b7bf2010-11-04 18:45:27 +0000278 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
279 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Size
280 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Align
281 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
282 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags
283 RTy
284 };
David Blaikie5692e722013-03-28 02:44:59 +0000285 return DIDerivedType(MDNode::get(VMContext, Elts));
Devang Patel57c5a202010-11-04 15:01:38 +0000286}
287
Devang Patel9b412732011-02-22 18:56:12 +0000288/// createTypedef - Create debugging information entry for a typedef.
David Blaikief11de2f2013-02-18 06:41:57 +0000289DIDerivedType DIBuilder::createTypedef(DIType Ty, StringRef Name, DIFile File,
290 unsigned LineNo, DIDescriptor Context) {
Benjamin Kramered8b7bf2010-11-04 18:45:27 +0000291 // typedefs are encoded in DIDerivedType format.
292 assert(Ty.Verify() && "Invalid typedef type!");
293 Value *Elts[] = {
294 GetTagConstant(VMContext, dwarf::DW_TAG_typedef),
David Blaikie200b6ed2013-03-20 00:26:26 +0000295 File.getFileNode(),
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000296 getNonCompileUnitScope(Context),
Benjamin Kramered8b7bf2010-11-04 18:45:27 +0000297 MDString::get(VMContext, Name),
Benjamin Kramered8b7bf2010-11-04 18:45:27 +0000298 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
299 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Size
300 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Align
301 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
302 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags
303 Ty
304 };
David Blaikie5692e722013-03-28 02:44:59 +0000305 return DIDerivedType(MDNode::get(VMContext, Elts));
Devang Patel57c5a202010-11-04 15:01:38 +0000306}
307
Devang Patel9b412732011-02-22 18:56:12 +0000308/// createFriend - Create debugging information entry for a 'friend'.
309DIType DIBuilder::createFriend(DIType Ty, DIType FriendTy) {
Benjamin Kramered8b7bf2010-11-04 18:45:27 +0000310 // typedefs are encoded in DIDerivedType format.
311 assert(Ty.Verify() && "Invalid type!");
312 assert(FriendTy.Verify() && "Invalid friend type!");
313 Value *Elts[] = {
314 GetTagConstant(VMContext, dwarf::DW_TAG_friend),
David Blaikieabec74b2013-03-19 23:25:22 +0000315 NULL,
Benjamin Kramered8b7bf2010-11-04 18:45:27 +0000316 Ty,
317 NULL, // Name
Benjamin Kramered8b7bf2010-11-04 18:45:27 +0000318 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
319 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Size
320 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Align
321 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
322 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags
323 FriendTy
324 };
David Blaikie5692e722013-03-28 02:44:59 +0000325 return DIType(MDNode::get(VMContext, Elts));
Devang Patel57c5a202010-11-04 15:01:38 +0000326}
327
Devang Patel9b412732011-02-22 18:56:12 +0000328/// createInheritance - Create debugging information entry to establish
Eric Christopher777c9282011-09-12 19:58:22 +0000329/// inheritance relationship between two types.
David Blaikief11de2f2013-02-18 06:41:57 +0000330DIDerivedType DIBuilder::createInheritance(
331 DIType Ty, DIType BaseTy, uint64_t BaseOffset, unsigned Flags) {
Devang Patel1ad1abe2011-09-12 18:26:08 +0000332 assert(Ty.Verify() && "Unable to create inheritance");
Benjamin Kramered8b7bf2010-11-04 18:45:27 +0000333 // TAG_inheritance is encoded in DIDerivedType format.
334 Value *Elts[] = {
335 GetTagConstant(VMContext, dwarf::DW_TAG_inheritance),
David Blaikieabec74b2013-03-19 23:25:22 +0000336 NULL,
Benjamin Kramered8b7bf2010-11-04 18:45:27 +0000337 Ty,
338 NULL, // Name
Benjamin Kramered8b7bf2010-11-04 18:45:27 +0000339 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
340 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Size
341 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Align
342 ConstantInt::get(Type::getInt64Ty(VMContext), BaseOffset),
343 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
344 BaseTy
345 };
David Blaikie5692e722013-03-28 02:44:59 +0000346 return DIDerivedType(MDNode::get(VMContext, Elts));
Devang Patel57c5a202010-11-04 15:01:38 +0000347}
348
Devang Patel9b412732011-02-22 18:56:12 +0000349/// createMemberType - Create debugging information entry for a member.
David Blaikief11de2f2013-02-18 06:41:57 +0000350DIDerivedType DIBuilder::createMemberType(
351 DIDescriptor Scope, StringRef Name, DIFile File, unsigned LineNumber,
352 uint64_t SizeInBits, uint64_t AlignInBits, uint64_t OffsetInBits,
353 unsigned Flags, DIType Ty) {
Benjamin Kramered8b7bf2010-11-04 18:45:27 +0000354 // TAG_member is encoded in DIDerivedType format.
355 Value *Elts[] = {
356 GetTagConstant(VMContext, dwarf::DW_TAG_member),
David Blaikie200b6ed2013-03-20 00:26:26 +0000357 File.getFileNode(),
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000358 getNonCompileUnitScope(Scope),
Benjamin Kramered8b7bf2010-11-04 18:45:27 +0000359 MDString::get(VMContext, Name),
Benjamin Kramered8b7bf2010-11-04 18:45:27 +0000360 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
361 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
362 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
363 ConstantInt::get(Type::getInt64Ty(VMContext), OffsetInBits),
364 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
365 Ty
366 };
David Blaikie5692e722013-03-28 02:44:59 +0000367 return DIDerivedType(MDNode::get(VMContext, Elts));
Devang Patel57c5a202010-11-04 15:01:38 +0000368}
369
Eric Christopher4d23a4a2013-01-16 01:22:23 +0000370/// createStaticMemberType - Create debugging information entry for a
371/// C++ static data member.
372DIType DIBuilder::createStaticMemberType(DIDescriptor Scope, StringRef Name,
373 DIFile File, unsigned LineNumber,
374 DIType Ty, unsigned Flags,
375 llvm::Value *Val) {
376 // TAG_member is encoded in DIDerivedType format.
377 Flags |= DIDescriptor::FlagStaticMember;
378 Value *Elts[] = {
379 GetTagConstant(VMContext, dwarf::DW_TAG_member),
David Blaikie200b6ed2013-03-20 00:26:26 +0000380 File.getFileNode(),
Eric Christopher4d23a4a2013-01-16 01:22:23 +0000381 getNonCompileUnitScope(Scope),
382 MDString::get(VMContext, Name),
Eric Christopher4d23a4a2013-01-16 01:22:23 +0000383 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
384 ConstantInt::get(Type::getInt64Ty(VMContext), 0/*SizeInBits*/),
385 ConstantInt::get(Type::getInt64Ty(VMContext), 0/*AlignInBits*/),
386 ConstantInt::get(Type::getInt64Ty(VMContext), 0/*OffsetInBits*/),
387 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
388 Ty,
389 Val
390 };
David Blaikie5692e722013-03-28 02:44:59 +0000391 return DIType(MDNode::get(VMContext, Elts));
Eric Christopher4d23a4a2013-01-16 01:22:23 +0000392}
393
Devang Patel514b4002011-04-16 00:11:51 +0000394/// createObjCIVar - Create debugging information entry for Objective-C
395/// instance variable.
Eric Christopher3cc90fe2011-08-26 21:02:40 +0000396DIType DIBuilder::createObjCIVar(StringRef Name,
397 DIFile File, unsigned LineNumber,
Devang Patel514b4002011-04-16 00:11:51 +0000398 uint64_t SizeInBits, uint64_t AlignInBits,
Eric Christopher3cc90fe2011-08-26 21:02:40 +0000399 uint64_t OffsetInBits, unsigned Flags,
Devang Patel514b4002011-04-16 00:11:51 +0000400 DIType Ty, StringRef PropertyName,
401 StringRef GetterName, StringRef SetterName,
402 unsigned PropertyAttributes) {
403 // TAG_member is encoded in DIDerivedType format.
404 Value *Elts[] = {
405 GetTagConstant(VMContext, dwarf::DW_TAG_member),
David Blaikie200b6ed2013-03-20 00:26:26 +0000406 File.getFileNode(),
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000407 getNonCompileUnitScope(File),
Devang Patel514b4002011-04-16 00:11:51 +0000408 MDString::get(VMContext, Name),
Devang Patel514b4002011-04-16 00:11:51 +0000409 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
410 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
411 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
412 ConstantInt::get(Type::getInt64Ty(VMContext), OffsetInBits),
413 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
414 Ty,
415 MDString::get(VMContext, PropertyName),
416 MDString::get(VMContext, GetterName),
417 MDString::get(VMContext, SetterName),
418 ConstantInt::get(Type::getInt32Ty(VMContext), PropertyAttributes)
419 };
David Blaikie5692e722013-03-28 02:44:59 +0000420 return DIType(MDNode::get(VMContext, Elts));
Devang Patel514b4002011-04-16 00:11:51 +0000421}
422
Devang Patel44882172012-02-06 17:49:43 +0000423/// createObjCIVar - Create debugging information entry for Objective-C
424/// instance variable.
425DIType DIBuilder::createObjCIVar(StringRef Name,
426 DIFile File, unsigned LineNumber,
427 uint64_t SizeInBits, uint64_t AlignInBits,
428 uint64_t OffsetInBits, unsigned Flags,
429 DIType Ty, MDNode *PropertyNode) {
430 // TAG_member is encoded in DIDerivedType format.
431 Value *Elts[] = {
432 GetTagConstant(VMContext, dwarf::DW_TAG_member),
David Blaikie200b6ed2013-03-20 00:26:26 +0000433 File.getFileNode(),
Devang Patel44882172012-02-06 17:49:43 +0000434 getNonCompileUnitScope(File),
435 MDString::get(VMContext, Name),
Devang Patel44882172012-02-06 17:49:43 +0000436 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
437 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
438 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
439 ConstantInt::get(Type::getInt64Ty(VMContext), OffsetInBits),
440 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
441 Ty,
442 PropertyNode
443 };
David Blaikie5692e722013-03-28 02:44:59 +0000444 return DIType(MDNode::get(VMContext, Elts));
Devang Patel44882172012-02-06 17:49:43 +0000445}
446
Devang Patelcc481592012-02-04 00:59:25 +0000447/// createObjCProperty - Create debugging information entry for Objective-C
448/// property.
Eric Christopher70e1bd82012-03-29 08:42:56 +0000449DIObjCProperty DIBuilder::createObjCProperty(StringRef Name,
Eric Christopher17426692012-07-06 02:35:57 +0000450 DIFile File, unsigned LineNumber,
Devang Patelcc481592012-02-04 00:59:25 +0000451 StringRef GetterName,
Adrian Prantl425ca792013-04-19 19:56:02 +0000452 StringRef SetterName,
Eric Christopher70e1bd82012-03-29 08:42:56 +0000453 unsigned PropertyAttributes,
Eric Christopher17426692012-07-06 02:35:57 +0000454 DIType Ty) {
Devang Patelcc481592012-02-04 00:59:25 +0000455 Value *Elts[] = {
Eric Christopherc13fd6d2012-03-29 21:35:05 +0000456 GetTagConstant(VMContext, dwarf::DW_TAG_APPLE_property),
Devang Patelcc481592012-02-04 00:59:25 +0000457 MDString::get(VMContext, Name),
Eric Christopher70e1bd82012-03-29 08:42:56 +0000458 File,
459 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
Devang Patelcc481592012-02-04 00:59:25 +0000460 MDString::get(VMContext, GetterName),
461 MDString::get(VMContext, SetterName),
Eric Christopher70e1bd82012-03-29 08:42:56 +0000462 ConstantInt::get(Type::getInt32Ty(VMContext), PropertyAttributes),
463 Ty
Devang Patelcc481592012-02-04 00:59:25 +0000464 };
David Blaikie5692e722013-03-28 02:44:59 +0000465 return DIObjCProperty(MDNode::get(VMContext, Elts));
Devang Patelcc481592012-02-04 00:59:25 +0000466}
467
Devang Patel9b412732011-02-22 18:56:12 +0000468/// createTemplateTypeParameter - Create debugging information for template
Devang Patel3a9e65e2011-02-02 21:38:25 +0000469/// type parameter.
Eric Christopher3cc90fe2011-08-26 21:02:40 +0000470DITemplateTypeParameter
Devang Patel9b412732011-02-22 18:56:12 +0000471DIBuilder::createTemplateTypeParameter(DIDescriptor Context, StringRef Name,
Devang Patel3a9e65e2011-02-02 21:38:25 +0000472 DIType Ty, MDNode *File, unsigned LineNo,
473 unsigned ColumnNo) {
474 Value *Elts[] = {
475 GetTagConstant(VMContext, dwarf::DW_TAG_template_type_parameter),
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000476 getNonCompileUnitScope(Context),
Devang Patel3a9e65e2011-02-02 21:38:25 +0000477 MDString::get(VMContext, Name),
478 Ty,
479 File,
480 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
481 ConstantInt::get(Type::getInt32Ty(VMContext), ColumnNo)
482 };
David Blaikie5692e722013-03-28 02:44:59 +0000483 return DITemplateTypeParameter(MDNode::get(VMContext, Elts));
Devang Patel3a9e65e2011-02-02 21:38:25 +0000484}
485
Devang Patel9b412732011-02-22 18:56:12 +0000486/// createTemplateValueParameter - Create debugging information for template
Devang Patelbe933b42011-02-02 22:35:53 +0000487/// value parameter.
Eric Christopher3cc90fe2011-08-26 21:02:40 +0000488DITemplateValueParameter
Devang Patel9b412732011-02-22 18:56:12 +0000489DIBuilder::createTemplateValueParameter(DIDescriptor Context, StringRef Name,
Devang Patelbe933b42011-02-02 22:35:53 +0000490 DIType Ty, uint64_t Val,
491 MDNode *File, unsigned LineNo,
492 unsigned ColumnNo) {
493 Value *Elts[] = {
494 GetTagConstant(VMContext, dwarf::DW_TAG_template_value_parameter),
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000495 getNonCompileUnitScope(Context),
Devang Patelbe933b42011-02-02 22:35:53 +0000496 MDString::get(VMContext, Name),
497 Ty,
498 ConstantInt::get(Type::getInt64Ty(VMContext), Val),
499 File,
500 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
501 ConstantInt::get(Type::getInt32Ty(VMContext), ColumnNo)
502 };
David Blaikie5692e722013-03-28 02:44:59 +0000503 return DITemplateValueParameter(MDNode::get(VMContext, Elts));
Devang Patelbe933b42011-02-02 22:35:53 +0000504}
505
Eric Christopher17426692012-07-06 02:35:57 +0000506/// createClassType - Create debugging information entry for a class.
David Blaikiea7310a32013-03-26 23:46:39 +0000507DICompositeType DIBuilder::createClassType(DIDescriptor Context, StringRef Name,
508 DIFile File, unsigned LineNumber,
509 uint64_t SizeInBits,
510 uint64_t AlignInBits,
511 uint64_t OffsetInBits,
512 unsigned Flags, DIType DerivedFrom,
513 DIArray Elements,
514 MDNode *VTableHolder,
515 MDNode *TemplateParams) {
David Blaikie085abe32013-03-11 23:21:19 +0000516 assert((!Context || Context.Verify()) &&
517 "createClassType should be called with a valid Context");
518 // TAG_class_type is encoded in DICompositeType format.
Eric Christopher17426692012-07-06 02:35:57 +0000519 Value *Elts[] = {
520 GetTagConstant(VMContext, dwarf::DW_TAG_class_type),
David Blaikie200b6ed2013-03-20 00:26:26 +0000521 File.getFileNode(),
Eric Christopher17426692012-07-06 02:35:57 +0000522 getNonCompileUnitScope(Context),
523 MDString::get(VMContext, Name),
Eric Christopher17426692012-07-06 02:35:57 +0000524 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
525 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
526 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
527 ConstantInt::get(Type::getInt32Ty(VMContext), OffsetInBits),
528 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
529 DerivedFrom,
530 Elements,
531 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
532 VTableHolder,
533 TemplateParams
534 };
David Blaikiea7310a32013-03-26 23:46:39 +0000535 DICompositeType R(MDNode::get(VMContext, Elts));
David Blaikie085abe32013-03-11 23:21:19 +0000536 assert(R.Verify() && "createClassType should return a verifiable DIType");
537 return R;
Eric Christopher17426692012-07-06 02:35:57 +0000538}
539
Devang Patel9b412732011-02-22 18:56:12 +0000540/// createStructType - Create debugging information entry for a struct.
David Blaikiebbe0e1a2013-02-25 01:07:18 +0000541DICompositeType DIBuilder::createStructType(DIDescriptor Context,
542 StringRef Name, DIFile File,
543 unsigned LineNumber,
544 uint64_t SizeInBits,
545 uint64_t AlignInBits,
546 unsigned Flags, DIType DerivedFrom,
547 DIArray Elements,
548 unsigned RunTimeLang,
549 MDNode *VTableHolder) {
Devang Patel746660f2010-12-07 23:25:47 +0000550 // TAG_structure_type is encoded in DICompositeType format.
551 Value *Elts[] = {
552 GetTagConstant(VMContext, dwarf::DW_TAG_structure_type),
David Blaikie200b6ed2013-03-20 00:26:26 +0000553 File.getFileNode(),
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000554 getNonCompileUnitScope(Context),
Devang Patel746660f2010-12-07 23:25:47 +0000555 MDString::get(VMContext, Name),
Devang Patel746660f2010-12-07 23:25:47 +0000556 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
557 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
558 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
Devang Patel89ea4f22010-12-08 01:50:15 +0000559 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
Devang Patel746660f2010-12-07 23:25:47 +0000560 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
David Blaikiebbe0e1a2013-02-25 01:07:18 +0000561 DerivedFrom,
Devang Patel746660f2010-12-07 23:25:47 +0000562 Elements,
563 ConstantInt::get(Type::getInt32Ty(VMContext), RunTimeLang),
David Blaikiebbe0e1a2013-02-25 01:07:18 +0000564 VTableHolder,
David Blaikie12bbf712013-02-18 07:27:30 +0000565 NULL,
Devang Patel746660f2010-12-07 23:25:47 +0000566 };
David Blaikie085abe32013-03-11 23:21:19 +0000567 DICompositeType R(MDNode::get(VMContext, Elts));
568 assert(R.Verify() && "createStructType should return a verifiable DIType");
569 return R;
Devang Patel746660f2010-12-07 23:25:47 +0000570}
571
Devang Patel9b412732011-02-22 18:56:12 +0000572/// createUnionType - Create debugging information entry for an union.
Eric Christopher17dd8f02013-04-02 22:55:52 +0000573DICompositeType DIBuilder::createUnionType(DIDescriptor Scope, StringRef Name,
574 DIFile File, unsigned LineNumber,
575 uint64_t SizeInBits,
576 uint64_t AlignInBits, unsigned Flags,
577 DIArray Elements,
578 unsigned RunTimeLang) {
Devang Patel89ea4f22010-12-08 01:50:15 +0000579 // TAG_union_type is encoded in DICompositeType format.
580 Value *Elts[] = {
581 GetTagConstant(VMContext, dwarf::DW_TAG_union_type),
David Blaikie200b6ed2013-03-20 00:26:26 +0000582 File.getFileNode(),
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000583 getNonCompileUnitScope(Scope),
Devang Patel89ea4f22010-12-08 01:50:15 +0000584 MDString::get(VMContext, Name),
Devang Patel89ea4f22010-12-08 01:50:15 +0000585 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
586 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
587 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
588 ConstantInt::get(Type::getInt64Ty(VMContext), 0),
589 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
Devang Patel78847f02011-12-16 17:51:31 +0000590 NULL,
Devang Patel89ea4f22010-12-08 01:50:15 +0000591 Elements,
592 ConstantInt::get(Type::getInt32Ty(VMContext), RunTimeLang),
Eric Christopher6476f902013-04-02 22:55:56 +0000593 Constant::getNullValue(Type::getInt32Ty(VMContext)),
594 NULL
Devang Patel89ea4f22010-12-08 01:50:15 +0000595 };
David Blaikie5692e722013-03-28 02:44:59 +0000596 return DICompositeType(MDNode::get(VMContext, Elts));
Devang Patel89ea4f22010-12-08 01:50:15 +0000597}
598
Devang Patel9b412732011-02-22 18:56:12 +0000599/// createSubroutineType - Create subroutine type.
David Blaikief11de2f2013-02-18 06:41:57 +0000600DICompositeType
601DIBuilder::createSubroutineType(DIFile File, DIArray ParameterTypes) {
Devang Patel89ea4f22010-12-08 01:50:15 +0000602 // TAG_subroutine_type is encoded in DICompositeType format.
603 Value *Elts[] = {
604 GetTagConstant(VMContext, dwarf::DW_TAG_subroutine_type),
Bill Wendling7154c432012-07-06 17:47:36 +0000605 Constant::getNullValue(Type::getInt32Ty(VMContext)),
Bill Wendling7154c432012-07-06 17:47:36 +0000606 Constant::getNullValue(Type::getInt32Ty(VMContext)),
David Blaikieabec74b2013-03-19 23:25:22 +0000607 MDString::get(VMContext, ""),
Devang Patel89ea4f22010-12-08 01:50:15 +0000608 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
609 ConstantInt::get(Type::getInt64Ty(VMContext), 0),
610 ConstantInt::get(Type::getInt64Ty(VMContext), 0),
Devang Patel78847f02011-12-16 17:51:31 +0000611 ConstantInt::get(Type::getInt64Ty(VMContext), 0),
Devang Patel89ea4f22010-12-08 01:50:15 +0000612 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
Devang Patel78847f02011-12-16 17:51:31 +0000613 NULL,
Devang Patel89ea4f22010-12-08 01:50:15 +0000614 ParameterTypes,
615 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
Bill Wendling5ef31592012-07-06 17:49:19 +0000616 Constant::getNullValue(Type::getInt32Ty(VMContext))
Devang Patel89ea4f22010-12-08 01:50:15 +0000617 };
David Blaikie5692e722013-03-28 02:44:59 +0000618 return DICompositeType(MDNode::get(VMContext, Elts));
Devang Patel89ea4f22010-12-08 01:50:15 +0000619}
620
Eric Christopher3cc90fe2011-08-26 21:02:40 +0000621/// createEnumerationType - Create debugging information entry for an
Devang Patel89ea4f22010-12-08 01:50:15 +0000622/// enumeration.
David Blaikief11de2f2013-02-18 06:41:57 +0000623DICompositeType DIBuilder::createEnumerationType(
624 DIDescriptor Scope, StringRef Name, DIFile File, unsigned LineNumber,
625 uint64_t SizeInBits, uint64_t AlignInBits, DIArray Elements,
Adrian Prantl425ca792013-04-19 19:56:02 +0000626 DIType UnderlyingType) {
Devang Patel89ea4f22010-12-08 01:50:15 +0000627 // TAG_enumeration_type is encoded in DICompositeType format.
628 Value *Elts[] = {
629 GetTagConstant(VMContext, dwarf::DW_TAG_enumeration_type),
David Blaikie200b6ed2013-03-20 00:26:26 +0000630 File.getFileNode(),
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000631 getNonCompileUnitScope(Scope),
Devang Patel89ea4f22010-12-08 01:50:15 +0000632 MDString::get(VMContext, Name),
Devang Patel89ea4f22010-12-08 01:50:15 +0000633 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
634 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
635 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
636 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
Eli Friedmanc6c86c42012-10-05 01:49:14 +0000637 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
Adrian Prantl425ca792013-04-19 19:56:02 +0000638 UnderlyingType,
Devang Patel89ea4f22010-12-08 01:50:15 +0000639 Elements,
640 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
Bill Wendling5ef31592012-07-06 17:49:19 +0000641 Constant::getNullValue(Type::getInt32Ty(VMContext))
Devang Patel89ea4f22010-12-08 01:50:15 +0000642 };
Devang Patel0c773242011-04-18 23:51:03 +0000643 MDNode *Node = MDNode::get(VMContext, Elts);
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000644 AllEnumTypes.push_back(Node);
David Blaikie5692e722013-03-28 02:44:59 +0000645 return DICompositeType(Node);
Devang Patel89ea4f22010-12-08 01:50:15 +0000646}
647
Devang Patel9b412732011-02-22 18:56:12 +0000648/// createArrayType - Create debugging information entry for an array.
David Blaikief11de2f2013-02-18 06:41:57 +0000649DICompositeType DIBuilder::createArrayType(uint64_t Size, uint64_t AlignInBits,
650 DIType Ty, DIArray Subscripts) {
Devang Patel89ea4f22010-12-08 01:50:15 +0000651 // TAG_array_type is encoded in DICompositeType format.
652 Value *Elts[] = {
653 GetTagConstant(VMContext, dwarf::DW_TAG_array_type),
David Blaikieabec74b2013-03-19 23:25:22 +0000654 NULL, // Filename/Directory,
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000655 NULL, //TheCU,
Devang Patel89ea4f22010-12-08 01:50:15 +0000656 MDString::get(VMContext, ""),
Devang Patel89ea4f22010-12-08 01:50:15 +0000657 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
658 ConstantInt::get(Type::getInt64Ty(VMContext), Size),
659 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
660 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
661 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
662 Ty,
663 Subscripts,
664 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
Bill Wendling5ef31592012-07-06 17:49:19 +0000665 Constant::getNullValue(Type::getInt32Ty(VMContext))
Devang Patel89ea4f22010-12-08 01:50:15 +0000666 };
David Blaikie5692e722013-03-28 02:44:59 +0000667 return DICompositeType(MDNode::get(VMContext, Elts));
Devang Patel89ea4f22010-12-08 01:50:15 +0000668}
669
Devang Patel9b412732011-02-22 18:56:12 +0000670/// createVectorType - Create debugging information entry for a vector.
Eric Christopher3cc90fe2011-08-26 21:02:40 +0000671DIType DIBuilder::createVectorType(uint64_t Size, uint64_t AlignInBits,
Devang Patel89ea4f22010-12-08 01:50:15 +0000672 DIType Ty, DIArray Subscripts) {
Eric Christopher72a52952013-01-08 01:53:52 +0000673
674 // A vector is an array type with the FlagVector flag applied.
Devang Patel89ea4f22010-12-08 01:50:15 +0000675 Value *Elts[] = {
Eric Christopher72a52952013-01-08 01:53:52 +0000676 GetTagConstant(VMContext, dwarf::DW_TAG_array_type),
David Blaikieabec74b2013-03-19 23:25:22 +0000677 NULL, // Filename/Directory,
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000678 NULL, //TheCU,
Devang Patel89ea4f22010-12-08 01:50:15 +0000679 MDString::get(VMContext, ""),
Devang Patel89ea4f22010-12-08 01:50:15 +0000680 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
681 ConstantInt::get(Type::getInt64Ty(VMContext), Size),
682 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
683 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
Eric Christopher72a52952013-01-08 01:53:52 +0000684 ConstantInt::get(Type::getInt32Ty(VMContext), DIType::FlagVector),
Devang Patel89ea4f22010-12-08 01:50:15 +0000685 Ty,
686 Subscripts,
687 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
Bill Wendling5ef31592012-07-06 17:49:19 +0000688 Constant::getNullValue(Type::getInt32Ty(VMContext))
Devang Patel89ea4f22010-12-08 01:50:15 +0000689 };
David Blaikie5692e722013-03-28 02:44:59 +0000690 return DIType(MDNode::get(VMContext, Elts));
Devang Patel89ea4f22010-12-08 01:50:15 +0000691}
Devang Patel746660f2010-12-07 23:25:47 +0000692
Devang Patel9b412732011-02-22 18:56:12 +0000693/// createArtificialType - Create a new DIType with "artificial" flag set.
694DIType DIBuilder::createArtificialType(DIType Ty) {
Devang Patel57c5a202010-11-04 15:01:38 +0000695 if (Ty.isArtificial())
696 return Ty;
697
698 SmallVector<Value *, 9> Elts;
699 MDNode *N = Ty;
700 assert (N && "Unexpected input DIType!");
701 for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i) {
702 if (Value *V = N->getOperand(i))
703 Elts.push_back(V);
704 else
705 Elts.push_back(Constant::getNullValue(Type::getInt32Ty(VMContext)));
706 }
707
708 unsigned CurFlags = Ty.getFlags();
709 CurFlags = CurFlags | DIType::FlagArtificial;
710
711 // Flags are stored at this slot.
David Blaikie5692e722013-03-28 02:44:59 +0000712 Elts[8] = ConstantInt::get(Type::getInt32Ty(VMContext), CurFlags);
Devang Patel57c5a202010-11-04 15:01:38 +0000713
David Blaikie5692e722013-03-28 02:44:59 +0000714 return DIType(MDNode::get(VMContext, Elts));
Devang Patel57c5a202010-11-04 15:01:38 +0000715}
Devang Patel746660f2010-12-07 23:25:47 +0000716
Eric Christopher9bd36092013-01-08 01:53:42 +0000717/// createObjectPointerType - Create a new type with both the object pointer
718/// and artificial flags set.
Eric Christophere3417762012-09-12 23:36:19 +0000719DIType DIBuilder::createObjectPointerType(DIType Ty) {
720 if (Ty.isObjectPointer())
721 return Ty;
722
723 SmallVector<Value *, 9> Elts;
724 MDNode *N = Ty;
725 assert (N && "Unexpected input DIType!");
726 for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i) {
727 if (Value *V = N->getOperand(i))
728 Elts.push_back(V);
729 else
730 Elts.push_back(Constant::getNullValue(Type::getInt32Ty(VMContext)));
731 }
732
733 unsigned CurFlags = Ty.getFlags();
734 CurFlags = CurFlags | (DIType::FlagObjectPointer | DIType::FlagArtificial);
735
736 // Flags are stored at this slot.
David Blaikie5692e722013-03-28 02:44:59 +0000737 Elts[8] = ConstantInt::get(Type::getInt32Ty(VMContext), CurFlags);
Eric Christophere3417762012-09-12 23:36:19 +0000738
David Blaikie5692e722013-03-28 02:44:59 +0000739 return DIType(MDNode::get(VMContext, Elts));
Eric Christophere3417762012-09-12 23:36:19 +0000740}
741
Eric Christopher3cc90fe2011-08-26 21:02:40 +0000742/// retainType - Retain DIType in a module even if it is not referenced
Devang Patel89ea4f22010-12-08 01:50:15 +0000743/// through debug info anchors.
Devang Patel9b412732011-02-22 18:56:12 +0000744void DIBuilder::retainType(DIType T) {
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000745 AllRetainTypes.push_back(T);
Devang Patel89ea4f22010-12-08 01:50:15 +0000746}
747
Devang Patel9b412732011-02-22 18:56:12 +0000748/// createUnspecifiedParameter - Create unspeicified type descriptor
Devang Patel89ea4f22010-12-08 01:50:15 +0000749/// for the subroutine type.
Devang Patel9b412732011-02-22 18:56:12 +0000750DIDescriptor DIBuilder::createUnspecifiedParameter() {
Eric Christopher3cc90fe2011-08-26 21:02:40 +0000751 Value *Elts[] = {
752 GetTagConstant(VMContext, dwarf::DW_TAG_unspecified_parameters)
Devang Patel89ea4f22010-12-08 01:50:15 +0000753 };
Devang Patel0c773242011-04-18 23:51:03 +0000754 return DIDescriptor(MDNode::get(VMContext, Elts));
Devang Patel89ea4f22010-12-08 01:50:15 +0000755}
756
Eric Christopherae56eec2012-02-08 00:22:26 +0000757/// createForwardDecl - Create a temporary forward-declared type that
758/// can be RAUW'd if the full type is seen.
Eric Christopher27deb262012-04-23 19:00:11 +0000759DIType DIBuilder::createForwardDecl(unsigned Tag, StringRef Name,
760 DIDescriptor Scope, DIFile F,
Eli Friedmanc6c86c42012-10-05 01:49:14 +0000761 unsigned Line, unsigned RuntimeLang,
762 uint64_t SizeInBits,
763 uint64_t AlignInBits) {
Eric Christopherae56eec2012-02-08 00:22:26 +0000764 // Create a temporary MDNode.
765 Value *Elts[] = {
766 GetTagConstant(VMContext, Tag),
David Blaikie200b6ed2013-03-20 00:26:26 +0000767 F.getFileNode(),
Eric Christopher27deb262012-04-23 19:00:11 +0000768 getNonCompileUnitScope(Scope),
Eric Christopherae56eec2012-02-08 00:22:26 +0000769 MDString::get(VMContext, Name),
Eric Christopherae56eec2012-02-08 00:22:26 +0000770 ConstantInt::get(Type::getInt32Ty(VMContext), Line),
Eli Friedmanc6c86c42012-10-05 01:49:14 +0000771 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
772 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
Eric Christopherae56eec2012-02-08 00:22:26 +0000773 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
774 ConstantInt::get(Type::getInt32Ty(VMContext),
Eric Christopher89797122012-02-20 18:04:14 +0000775 DIDescriptor::FlagFwdDecl),
776 NULL,
777 DIArray(),
778 ConstantInt::get(Type::getInt32Ty(VMContext), RuntimeLang)
Eric Christopherae56eec2012-02-08 00:22:26 +0000779 };
780 MDNode *Node = MDNode::getTemporary(VMContext, Elts);
David Blaikie085abe32013-03-11 23:21:19 +0000781 assert(DIType(Node).Verify() &&
782 "createForwardDecl result should be verifiable");
Eric Christopherae56eec2012-02-08 00:22:26 +0000783 return DIType(Node);
784}
785
Devang Patel9b412732011-02-22 18:56:12 +0000786/// getOrCreateArray - Get a DIArray, create one if required.
Jay Foaddbf81d82011-04-24 10:11:03 +0000787DIArray DIBuilder::getOrCreateArray(ArrayRef<Value *> Elements) {
788 if (Elements.empty()) {
Bill Wendling7154c432012-07-06 17:47:36 +0000789 Value *Null = Constant::getNullValue(Type::getInt32Ty(VMContext));
Jay Foad5514afe2011-04-21 19:59:31 +0000790 return DIArray(MDNode::get(VMContext, Null));
Devang Patel746660f2010-12-07 23:25:47 +0000791 }
Jay Foaddbf81d82011-04-24 10:11:03 +0000792 return DIArray(MDNode::get(VMContext, Elements));
Devang Patel746660f2010-12-07 23:25:47 +0000793}
794
Devang Patel9b412732011-02-22 18:56:12 +0000795/// getOrCreateSubrange - Create a descriptor for a value range. This
Devang Patel89ea4f22010-12-08 01:50:15 +0000796/// implicitly uniques the values returned.
Bill Wendlingd7767122012-12-04 21:34:03 +0000797DISubrange DIBuilder::getOrCreateSubrange(int64_t Lo, int64_t Count) {
Devang Patel89ea4f22010-12-08 01:50:15 +0000798 Value *Elts[] = {
799 GetTagConstant(VMContext, dwarf::DW_TAG_subrange_type),
800 ConstantInt::get(Type::getInt64Ty(VMContext), Lo),
Bill Wendlingbfc0e572012-12-04 06:20:49 +0000801 ConstantInt::get(Type::getInt64Ty(VMContext), Count)
Devang Patel89ea4f22010-12-08 01:50:15 +0000802 };
803
Devang Patel0c773242011-04-18 23:51:03 +0000804 return DISubrange(MDNode::get(VMContext, Elts));
Devang Patel89ea4f22010-12-08 01:50:15 +0000805}
806
David Blaikie62f1fea2013-03-20 17:49:48 +0000807/// \brief Create a new descriptor for the specified global.
Devang Patel746660f2010-12-07 23:25:47 +0000808DIGlobalVariable DIBuilder::
David Blaikie62f1fea2013-03-20 17:49:48 +0000809createGlobalVariable(StringRef Name, StringRef LinkageName, DIFile F,
810 unsigned LineNumber, DIType Ty, bool isLocalToUnit,
811 Value *Val) {
Devang Patel746660f2010-12-07 23:25:47 +0000812 Value *Elts[] = {
813 GetTagConstant(VMContext, dwarf::DW_TAG_variable),
Bill Wendling7154c432012-07-06 17:47:36 +0000814 Constant::getNullValue(Type::getInt32Ty(VMContext)),
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000815 NULL, // TheCU,
Devang Patel746660f2010-12-07 23:25:47 +0000816 MDString::get(VMContext, Name),
817 MDString::get(VMContext, Name),
David Blaikie62f1fea2013-03-20 17:49:48 +0000818 MDString::get(VMContext, LinkageName),
Devang Patel746660f2010-12-07 23:25:47 +0000819 F,
820 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
821 Ty,
822 ConstantInt::get(Type::getInt32Ty(VMContext), isLocalToUnit),
823 ConstantInt::get(Type::getInt32Ty(VMContext), 1), /* isDefinition*/
Eric Christopher4d23a4a2013-01-16 01:22:23 +0000824 Val,
825 DIDescriptor()
Devang Patel746660f2010-12-07 23:25:47 +0000826 };
Devang Patel0c773242011-04-18 23:51:03 +0000827 MDNode *Node = MDNode::get(VMContext, Elts);
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000828 AllGVs.push_back(Node);
Devang Patel746660f2010-12-07 23:25:47 +0000829 return DIGlobalVariable(Node);
830}
831
David Blaikie62f1fea2013-03-20 17:49:48 +0000832/// \brief Create a new descriptor for the specified global.
833DIGlobalVariable DIBuilder::
834createGlobalVariable(StringRef Name, DIFile F, unsigned LineNumber,
835 DIType Ty, bool isLocalToUnit, Value *Val) {
836 return createGlobalVariable(Name, Name, F, LineNumber, Ty, isLocalToUnit,
837 Val);
838}
839
Devang Patel9b412732011-02-22 18:56:12 +0000840/// createStaticVariable - Create a new descriptor for the specified static
Devang Patel746660f2010-12-07 23:25:47 +0000841/// variable.
842DIGlobalVariable DIBuilder::
Eric Christopher3cc90fe2011-08-26 21:02:40 +0000843createStaticVariable(DIDescriptor Context, StringRef Name,
844 StringRef LinkageName, DIFile F, unsigned LineNumber,
Eric Christopher4d23a4a2013-01-16 01:22:23 +0000845 DIType Ty, bool isLocalToUnit, Value *Val, MDNode *Decl) {
Devang Patel746660f2010-12-07 23:25:47 +0000846 Value *Elts[] = {
847 GetTagConstant(VMContext, dwarf::DW_TAG_variable),
Bill Wendling7154c432012-07-06 17:47:36 +0000848 Constant::getNullValue(Type::getInt32Ty(VMContext)),
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000849 getNonCompileUnitScope(Context),
Devang Patel746660f2010-12-07 23:25:47 +0000850 MDString::get(VMContext, Name),
851 MDString::get(VMContext, Name),
852 MDString::get(VMContext, LinkageName),
853 F,
854 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
855 Ty,
856 ConstantInt::get(Type::getInt32Ty(VMContext), isLocalToUnit),
857 ConstantInt::get(Type::getInt32Ty(VMContext), 1), /* isDefinition*/
Eric Christopher4d23a4a2013-01-16 01:22:23 +0000858 Val,
859 DIDescriptor(Decl)
Devang Patel746660f2010-12-07 23:25:47 +0000860 };
Devang Patel0c773242011-04-18 23:51:03 +0000861 MDNode *Node = MDNode::get(VMContext, Elts);
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000862 AllGVs.push_back(Node);
Devang Patel746660f2010-12-07 23:25:47 +0000863 return DIGlobalVariable(Node);
864}
865
Devang Patel9b412732011-02-22 18:56:12 +0000866/// createVariable - Create a new descriptor for the specified variable.
867DIVariable DIBuilder::createLocalVariable(unsigned Tag, DIDescriptor Scope,
Devang Patel63f83cd2010-12-07 23:58:00 +0000868 StringRef Name, DIFile File,
Eric Christopher3cc90fe2011-08-26 21:02:40 +0000869 unsigned LineNo, DIType Ty,
Devang Patel40eee1e2011-03-01 22:58:13 +0000870 bool AlwaysPreserve, unsigned Flags,
871 unsigned ArgNo) {
David Blaikie085abe32013-03-11 23:21:19 +0000872 DIDescriptor Context(getNonCompileUnitScope(Scope));
873 assert((!Context || Context.Verify()) &&
874 "createLocalVariable should be called with a valid Context");
875 assert(Ty.Verify() &&
876 "createLocalVariable should be called with a valid type");
Devang Patel63f83cd2010-12-07 23:58:00 +0000877 Value *Elts[] = {
878 GetTagConstant(VMContext, Tag),
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000879 getNonCompileUnitScope(Scope),
Devang Patel63f83cd2010-12-07 23:58:00 +0000880 MDString::get(VMContext, Name),
881 File,
Devang Patel40eee1e2011-03-01 22:58:13 +0000882 ConstantInt::get(Type::getInt32Ty(VMContext), (LineNo | (ArgNo << 24))),
Devang Patel63f83cd2010-12-07 23:58:00 +0000883 Ty,
Devang Patelcfa82a32011-07-19 19:41:54 +0000884 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
Bill Wendling5ef31592012-07-06 17:49:19 +0000885 Constant::getNullValue(Type::getInt32Ty(VMContext))
Devang Patel63f83cd2010-12-07 23:58:00 +0000886 };
Devang Patel0c773242011-04-18 23:51:03 +0000887 MDNode *Node = MDNode::get(VMContext, Elts);
Devang Patel63f83cd2010-12-07 23:58:00 +0000888 if (AlwaysPreserve) {
889 // The optimizer may remove local variable. If there is an interest
890 // to preserve variable info in such situation then stash it in a
891 // named mdnode.
892 DISubprogram Fn(getDISubprogram(Scope));
Devang Patel59e27c52011-08-19 23:28:12 +0000893 NamedMDNode *FnLocals = getOrInsertFnSpecificMDNode(M, Fn);
Devang Patel63f83cd2010-12-07 23:58:00 +0000894 FnLocals->addOperand(Node);
895 }
David Blaikie085abe32013-03-11 23:21:19 +0000896 assert(DIVariable(Node).Verify() &&
897 "createLocalVariable should return a verifiable DIVariable");
Devang Patel63f83cd2010-12-07 23:58:00 +0000898 return DIVariable(Node);
899}
900
Devang Patel9b412732011-02-22 18:56:12 +0000901/// createComplexVariable - Create a new descriptor for the specified variable
Devang Patel746660f2010-12-07 23:25:47 +0000902/// which has a complex address expression for its address.
Devang Patel9b412732011-02-22 18:56:12 +0000903DIVariable DIBuilder::createComplexVariable(unsigned Tag, DIDescriptor Scope,
Devang Patel746660f2010-12-07 23:25:47 +0000904 StringRef Name, DIFile F,
905 unsigned LineNo,
Jay Foaddbf81d82011-04-24 10:11:03 +0000906 DIType Ty, ArrayRef<Value *> Addr,
907 unsigned ArgNo) {
Devang Patel746660f2010-12-07 23:25:47 +0000908 SmallVector<Value *, 15> Elts;
909 Elts.push_back(GetTagConstant(VMContext, Tag));
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000910 Elts.push_back(getNonCompileUnitScope(Scope)),
Devang Patel746660f2010-12-07 23:25:47 +0000911 Elts.push_back(MDString::get(VMContext, Name));
912 Elts.push_back(F);
Eric Christopher3cc90fe2011-08-26 21:02:40 +0000913 Elts.push_back(ConstantInt::get(Type::getInt32Ty(VMContext),
Devang Patela93cc252012-02-08 00:17:07 +0000914 (LineNo | (ArgNo << 24))));
Devang Patel746660f2010-12-07 23:25:47 +0000915 Elts.push_back(Ty);
Bill Wendling7154c432012-07-06 17:47:36 +0000916 Elts.push_back(Constant::getNullValue(Type::getInt32Ty(VMContext)));
917 Elts.push_back(Constant::getNullValue(Type::getInt32Ty(VMContext)));
Jay Foaddbf81d82011-04-24 10:11:03 +0000918 Elts.append(Addr.begin(), Addr.end());
Devang Patel746660f2010-12-07 23:25:47 +0000919
Devang Patel0c773242011-04-18 23:51:03 +0000920 return DIVariable(MDNode::get(VMContext, Elts));
Devang Patel746660f2010-12-07 23:25:47 +0000921}
922
Devang Patel9b412732011-02-22 18:56:12 +0000923/// createFunction - Create a new descriptor for the specified function.
924DISubprogram DIBuilder::createFunction(DIDescriptor Context,
Devang Patelb68c6232010-12-08 20:42:44 +0000925 StringRef Name,
926 StringRef LinkageName,
927 DIFile File, unsigned LineNo,
928 DIType Ty,
929 bool isLocalToUnit, bool isDefinition,
Eric Christopher34164192012-04-03 00:43:49 +0000930 unsigned ScopeLine,
Devang Patelb68c6232010-12-08 20:42:44 +0000931 unsigned Flags, bool isOptimized,
Devang Patel9f738842011-04-05 22:52:06 +0000932 Function *Fn,
Devang Patel1d6bbd42011-04-22 23:10:17 +0000933 MDNode *TParams,
934 MDNode *Decl) {
Devang Patel59e27c52011-08-19 23:28:12 +0000935 Value *TElts[] = { GetTagConstant(VMContext, DW_TAG_base_type) };
Devang Patelb68c6232010-12-08 20:42:44 +0000936 Value *Elts[] = {
937 GetTagConstant(VMContext, dwarf::DW_TAG_subprogram),
David Blaikie5ef3fcb2013-03-21 23:08:34 +0000938 File.getFileNode(),
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000939 getNonCompileUnitScope(Context),
Devang Patelb68c6232010-12-08 20:42:44 +0000940 MDString::get(VMContext, Name),
941 MDString::get(VMContext, Name),
942 MDString::get(VMContext, LinkageName),
Devang Patelb68c6232010-12-08 20:42:44 +0000943 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
944 Ty,
945 ConstantInt::get(Type::getInt1Ty(VMContext), isLocalToUnit),
946 ConstantInt::get(Type::getInt1Ty(VMContext), isDefinition),
947 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
948 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
Devang Patelcdd833e2011-12-15 17:55:56 +0000949 NULL,
Devang Patelb68c6232010-12-08 20:42:44 +0000950 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
951 ConstantInt::get(Type::getInt1Ty(VMContext), isOptimized),
Devang Patel9f738842011-04-05 22:52:06 +0000952 Fn,
Devang Patel1d6bbd42011-04-22 23:10:17 +0000953 TParams,
Devang Patel59e27c52011-08-19 23:28:12 +0000954 Decl,
David Blaikie2811f8a2013-02-04 05:56:36 +0000955 MDNode::getTemporary(VMContext, TElts),
Eric Christopher34164192012-04-03 00:43:49 +0000956 ConstantInt::get(Type::getInt32Ty(VMContext), ScopeLine)
Devang Patelb68c6232010-12-08 20:42:44 +0000957 };
Devang Patel0c773242011-04-18 23:51:03 +0000958 MDNode *Node = MDNode::get(VMContext, Elts);
Devang Patelb68c6232010-12-08 20:42:44 +0000959
960 // Create a named metadata so that we do not lose this mdnode.
David Blaikie595eb442013-02-18 07:10:22 +0000961 if (isDefinition)
962 AllSubprograms.push_back(Node);
David Blaikiecc8d0902013-03-21 20:28:52 +0000963 DISubprogram S(Node);
964 assert(S.Verify() && "createFunction should return a valid DISubprogram");
965 return S;
Devang Patelb68c6232010-12-08 20:42:44 +0000966}
967
Devang Patel9b412732011-02-22 18:56:12 +0000968/// createMethod - Create a new descriptor for the specified C++ method.
969DISubprogram DIBuilder::createMethod(DIDescriptor Context,
Devang Patelb68c6232010-12-08 20:42:44 +0000970 StringRef Name,
971 StringRef LinkageName,
972 DIFile F,
973 unsigned LineNo, DIType Ty,
974 bool isLocalToUnit,
975 bool isDefinition,
976 unsigned VK, unsigned VIndex,
977 MDNode *VTableHolder,
978 unsigned Flags,
979 bool isOptimized,
Devang Patel9f738842011-04-05 22:52:06 +0000980 Function *Fn,
981 MDNode *TParam) {
Devang Patel59e27c52011-08-19 23:28:12 +0000982 Value *TElts[] = { GetTagConstant(VMContext, DW_TAG_base_type) };
Devang Patelb68c6232010-12-08 20:42:44 +0000983 Value *Elts[] = {
984 GetTagConstant(VMContext, dwarf::DW_TAG_subprogram),
David Blaikie5ef3fcb2013-03-21 23:08:34 +0000985 F.getFileNode(),
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000986 getNonCompileUnitScope(Context),
Devang Patelb68c6232010-12-08 20:42:44 +0000987 MDString::get(VMContext, Name),
988 MDString::get(VMContext, Name),
989 MDString::get(VMContext, LinkageName),
Devang Patelb68c6232010-12-08 20:42:44 +0000990 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
991 Ty,
992 ConstantInt::get(Type::getInt1Ty(VMContext), isLocalToUnit),
993 ConstantInt::get(Type::getInt1Ty(VMContext), isDefinition),
994 ConstantInt::get(Type::getInt32Ty(VMContext), (unsigned)VK),
995 ConstantInt::get(Type::getInt32Ty(VMContext), VIndex),
996 VTableHolder,
997 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
998 ConstantInt::get(Type::getInt1Ty(VMContext), isOptimized),
Devang Patel9f738842011-04-05 22:52:06 +0000999 Fn,
1000 TParam,
Bill Wendling7154c432012-07-06 17:47:36 +00001001 Constant::getNullValue(Type::getInt32Ty(VMContext)),
David Blaikie2811f8a2013-02-04 05:56:36 +00001002 MDNode::getTemporary(VMContext, TElts),
Eric Christopher5d5338f2012-05-18 00:16:22 +00001003 // FIXME: Do we want to use different scope/lines?
Eric Christopher34164192012-04-03 00:43:49 +00001004 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo)
Devang Patelb68c6232010-12-08 20:42:44 +00001005 };
Devang Patel0c773242011-04-18 23:51:03 +00001006 MDNode *Node = MDNode::get(VMContext, Elts);
David Blaikie595eb442013-02-18 07:10:22 +00001007 if (isDefinition)
1008 AllSubprograms.push_back(Node);
David Blaikiecc8d0902013-03-21 20:28:52 +00001009 DISubprogram S(Node);
1010 assert(S.Verify() && "createMethod should return a valid DISubprogram");
1011 return S;
Devang Patelb68c6232010-12-08 20:42:44 +00001012}
1013
Devang Patel9b412732011-02-22 18:56:12 +00001014/// createNameSpace - This creates new descriptor for a namespace
Devang Patel746660f2010-12-07 23:25:47 +00001015/// with the specified parent scope.
Devang Patel9b412732011-02-22 18:56:12 +00001016DINameSpace DIBuilder::createNameSpace(DIDescriptor Scope, StringRef Name,
Devang Patel746660f2010-12-07 23:25:47 +00001017 DIFile File, unsigned LineNo) {
1018 Value *Elts[] = {
1019 GetTagConstant(VMContext, dwarf::DW_TAG_namespace),
David Blaikie2881da72013-03-20 19:39:15 +00001020 File.getFileNode(),
Devang Pateleb1bb4e2011-08-16 22:09:43 +00001021 getNonCompileUnitScope(Scope),
Devang Patel746660f2010-12-07 23:25:47 +00001022 MDString::get(VMContext, Name),
Devang Patel746660f2010-12-07 23:25:47 +00001023 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo)
1024 };
David Blaikie085abe32013-03-11 23:21:19 +00001025 DINameSpace R(MDNode::get(VMContext, Elts));
1026 assert(R.Verify() &&
1027 "createNameSpace should return a verifiable DINameSpace");
1028 return R;
Devang Patel746660f2010-12-07 23:25:47 +00001029}
1030
Eric Christopher6647b832011-10-11 22:59:11 +00001031/// createLexicalBlockFile - This creates a new MDNode that encapsulates
1032/// an existing scope with a new filename.
1033DILexicalBlockFile DIBuilder::createLexicalBlockFile(DIDescriptor Scope,
Devang Patela93cc252012-02-08 00:17:07 +00001034 DIFile File) {
Eric Christopher6647b832011-10-11 22:59:11 +00001035 Value *Elts[] = {
1036 GetTagConstant(VMContext, dwarf::DW_TAG_lexical_block),
David Blaikie61ef2be2013-03-22 20:18:46 +00001037 File.getFileNode(),
David Blaikie7c8dbc12013-03-22 19:13:22 +00001038 Scope
Eric Christopher6647b832011-10-11 22:59:11 +00001039 };
David Blaikie085abe32013-03-11 23:21:19 +00001040 DILexicalBlockFile R(MDNode::get(VMContext, Elts));
1041 assert(
1042 R.Verify() &&
1043 "createLexicalBlockFile should return a verifiable DILexicalBlockFile");
1044 return R;
Eric Christopher6647b832011-10-11 22:59:11 +00001045}
1046
Devang Patel9b412732011-02-22 18:56:12 +00001047DILexicalBlock DIBuilder::createLexicalBlock(DIDescriptor Scope, DIFile File,
Devang Patel89ea4f22010-12-08 01:50:15 +00001048 unsigned Line, unsigned Col) {
1049 // Defeat MDNode uniqing for lexical blocks by using unique id.
1050 static unsigned int unique_id = 0;
1051 Value *Elts[] = {
1052 GetTagConstant(VMContext, dwarf::DW_TAG_lexical_block),
David Blaikie30ce0782013-03-22 17:33:20 +00001053 File.getFileNode(),
Devang Pateleb1bb4e2011-08-16 22:09:43 +00001054 getNonCompileUnitScope(Scope),
Devang Patel89ea4f22010-12-08 01:50:15 +00001055 ConstantInt::get(Type::getInt32Ty(VMContext), Line),
1056 ConstantInt::get(Type::getInt32Ty(VMContext), Col),
Devang Patel89ea4f22010-12-08 01:50:15 +00001057 ConstantInt::get(Type::getInt32Ty(VMContext), unique_id++)
1058 };
David Blaikie085abe32013-03-11 23:21:19 +00001059 DILexicalBlock R(MDNode::get(VMContext, Elts));
1060 assert(R.Verify() &&
1061 "createLexicalBlock should return a verifiable DILexicalBlock");
1062 return R;
Devang Patel89ea4f22010-12-08 01:50:15 +00001063}
1064
Devang Patel9b412732011-02-22 18:56:12 +00001065/// insertDeclare - Insert a new llvm.dbg.declare intrinsic call.
1066Instruction *DIBuilder::insertDeclare(Value *Storage, DIVariable VarInfo,
Devang Patel746660f2010-12-07 23:25:47 +00001067 Instruction *InsertBefore) {
1068 assert(Storage && "no storage passed to dbg.declare");
1069 assert(VarInfo.Verify() && "empty DIVariable passed to dbg.declare");
1070 if (!DeclareFn)
1071 DeclareFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_declare);
1072
Jay Foad5514afe2011-04-21 19:59:31 +00001073 Value *Args[] = { MDNode::get(Storage->getContext(), Storage), VarInfo };
Jay Foad5bd375a2011-07-15 08:37:34 +00001074 return CallInst::Create(DeclareFn, Args, "", InsertBefore);
Devang Patel746660f2010-12-07 23:25:47 +00001075}
1076
Devang Patel9b412732011-02-22 18:56:12 +00001077/// insertDeclare - Insert a new llvm.dbg.declare intrinsic call.
1078Instruction *DIBuilder::insertDeclare(Value *Storage, DIVariable VarInfo,
Devang Patel746660f2010-12-07 23:25:47 +00001079 BasicBlock *InsertAtEnd) {
1080 assert(Storage && "no storage passed to dbg.declare");
1081 assert(VarInfo.Verify() && "invalid DIVariable passed to dbg.declare");
1082 if (!DeclareFn)
1083 DeclareFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_declare);
1084
Jay Foad5514afe2011-04-21 19:59:31 +00001085 Value *Args[] = { MDNode::get(Storage->getContext(), Storage), VarInfo };
Devang Patel746660f2010-12-07 23:25:47 +00001086
1087 // If this block already has a terminator then insert this intrinsic
1088 // before the terminator.
1089 if (TerminatorInst *T = InsertAtEnd->getTerminator())
Jay Foad5bd375a2011-07-15 08:37:34 +00001090 return CallInst::Create(DeclareFn, Args, "", T);
Devang Patel746660f2010-12-07 23:25:47 +00001091 else
Jay Foad5bd375a2011-07-15 08:37:34 +00001092 return CallInst::Create(DeclareFn, Args, "", InsertAtEnd);
Devang Patel746660f2010-12-07 23:25:47 +00001093}
1094
Devang Patel9b412732011-02-22 18:56:12 +00001095/// insertDbgValueIntrinsic - Insert a new llvm.dbg.value intrinsic call.
1096Instruction *DIBuilder::insertDbgValueIntrinsic(Value *V, uint64_t Offset,
Devang Patel746660f2010-12-07 23:25:47 +00001097 DIVariable VarInfo,
1098 Instruction *InsertBefore) {
1099 assert(V && "no value passed to dbg.value");
1100 assert(VarInfo.Verify() && "invalid DIVariable passed to dbg.value");
1101 if (!ValueFn)
1102 ValueFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_value);
1103
Jay Foad5514afe2011-04-21 19:59:31 +00001104 Value *Args[] = { MDNode::get(V->getContext(), V),
Devang Patel746660f2010-12-07 23:25:47 +00001105 ConstantInt::get(Type::getInt64Ty(V->getContext()), Offset),
1106 VarInfo };
Jay Foad5bd375a2011-07-15 08:37:34 +00001107 return CallInst::Create(ValueFn, Args, "", InsertBefore);
Devang Patel746660f2010-12-07 23:25:47 +00001108}
1109
Devang Patel9b412732011-02-22 18:56:12 +00001110/// insertDbgValueIntrinsic - Insert a new llvm.dbg.value intrinsic call.
1111Instruction *DIBuilder::insertDbgValueIntrinsic(Value *V, uint64_t Offset,
Devang Patel746660f2010-12-07 23:25:47 +00001112 DIVariable VarInfo,
1113 BasicBlock *InsertAtEnd) {
1114 assert(V && "no value passed to dbg.value");
1115 assert(VarInfo.Verify() && "invalid DIVariable passed to dbg.value");
1116 if (!ValueFn)
1117 ValueFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_value);
1118
Jay Foad5514afe2011-04-21 19:59:31 +00001119 Value *Args[] = { MDNode::get(V->getContext(), V),
Devang Patel746660f2010-12-07 23:25:47 +00001120 ConstantInt::get(Type::getInt64Ty(V->getContext()), Offset),
1121 VarInfo };
Jay Foad5bd375a2011-07-15 08:37:34 +00001122 return CallInst::Create(ValueFn, Args, "", InsertAtEnd);
Devang Patel746660f2010-12-07 23:25:47 +00001123}