blob: 6c274dabe0080324c331da55bc48d59637c8e339 [file] [log] [blame]
Devang Patel35fcd652010-11-04 15:01:38 +00001//===--- DIBuilder.cpp - Debug Information Builder ------------------------===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This file implements the DIBuilder.
11//
12//===----------------------------------------------------------------------===//
13
Bill Wendling16eeb6f2012-06-29 08:32:07 +000014#include "llvm/DIBuilder.h"
Chandler Carruthd04a8d42012-12-03 16:50:05 +000015#include "llvm/ADT/STLExtras.h"
Bill Wendling0bcbd1d2012-06-28 00:05:13 +000016#include "llvm/DebugInfo.h"
Chandler Carruth0b8c9a82013-01-02 11:36:10 +000017#include "llvm/IR/Constants.h"
18#include "llvm/IR/IntrinsicInst.h"
19#include "llvm/IR/Module.h"
Eric Christopher6126a1e2012-04-03 00:43:49 +000020#include "llvm/Support/Debug.h"
Devang Patel35fcd652010-11-04 15:01:38 +000021#include "llvm/Support/Dwarf.h"
22
23using namespace llvm;
24using namespace llvm::dwarf;
25
26static Constant *GetTagConstant(LLVMContext &VMContext, unsigned Tag) {
27 assert((Tag & LLVMDebugVersionMask) == 0 &&
28 "Tag too large for debug encoding!");
29 return ConstantInt::get(Type::getInt32Ty(VMContext), Tag | LLVMDebugVersion);
30}
Devang Patel48f17ba2010-12-07 23:58:00 +000031
Devang Patel35fcd652010-11-04 15:01:38 +000032DIBuilder::DIBuilder(Module &m)
Eric Christopher6c0046f2011-08-26 21:02:40 +000033 : M(m), VMContext(M.getContext()), TheCU(0), TempEnumTypes(0),
34 TempRetainTypes(0), TempSubprograms(0), TempGVs(0), DeclareFn(0),
35 ValueFn(0)
Devang Patel94c7ddb2011-08-16 22:09:43 +000036{}
Devang Patel35fcd652010-11-04 15:01:38 +000037
Devang Patel6326a422011-08-15 23:00:00 +000038/// finalize - Construct any deferred debug info descriptors.
39void DIBuilder::finalize() {
Devang Patel94c7ddb2011-08-16 22:09:43 +000040 DIArray Enums = getOrCreateArray(AllEnumTypes);
41 DIType(TempEnumTypes).replaceAllUsesWith(Enums);
42
43 DIArray RetainTypes = getOrCreateArray(AllRetainTypes);
44 DIType(TempRetainTypes).replaceAllUsesWith(RetainTypes);
45
46 DIArray SPs = getOrCreateArray(AllSubprograms);
47 DIType(TempSubprograms).replaceAllUsesWith(SPs);
Devang Patel93d39be2011-08-19 23:28:12 +000048 for (unsigned i = 0, e = SPs.getNumElements(); i != e; ++i) {
49 DISubprogram SP(SPs.getElement(i));
Eric Christopher216432d2012-04-23 19:00:11 +000050 SmallVector<Value *, 4> Variables;
Devang Patel93d39be2011-08-19 23:28:12 +000051 if (NamedMDNode *NMD = getFnSpecificMDNode(M, SP)) {
Devang Patel93d39be2011-08-19 23:28:12 +000052 for (unsigned ii = 0, ee = NMD->getNumOperands(); ii != ee; ++ii)
53 Variables.push_back(NMD->getOperand(ii));
Devang Patel93d39be2011-08-19 23:28:12 +000054 NMD->eraseFromParent();
55 }
Eric Christopher216432d2012-04-23 19:00:11 +000056 if (MDNode *Temp = SP.getVariablesNodes()) {
57 DIArray AV = getOrCreateArray(Variables);
58 DIType(Temp).replaceAllUsesWith(AV);
59 }
Devang Patel93d39be2011-08-19 23:28:12 +000060 }
Devang Patel94c7ddb2011-08-16 22:09:43 +000061
62 DIArray GVs = getOrCreateArray(AllGVs);
63 DIType(TempGVs).replaceAllUsesWith(GVs);
David Blaikiec462db62013-04-22 06:12:31 +000064
65 DIArray IMs = getOrCreateArray(AllImportedModules);
66 DIType(TempImportedModules).replaceAllUsesWith(IMs);
Devang Patel94c7ddb2011-08-16 22:09:43 +000067}
68
Eric Christopher6c0046f2011-08-26 21:02:40 +000069/// getNonCompileUnitScope - If N is compile unit return NULL otherwise return
70/// N.
Devang Patel94c7ddb2011-08-16 22:09:43 +000071static MDNode *getNonCompileUnitScope(MDNode *N) {
72 if (DIDescriptor(N).isCompileUnit())
73 return NULL;
74 return N;
Devang Patel6326a422011-08-15 23:00:00 +000075}
76
David Blaikie00c5c5d2013-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 Patel50d280c2011-02-22 18:56:12 +000087/// createCompileUnit - A CompileUnit provides an anchor for all debugging
Devang Patel35fcd652010-11-04 15:01:38 +000088/// information generated during this instance of compilation.
Eric Christopher6c0046f2011-08-26 21:02:40 +000089void DIBuilder::createCompileUnit(unsigned Lang, StringRef Filename,
90 StringRef Directory, StringRef Producer,
91 bool isOptimized, StringRef Flags,
Eric Christophere4b67902013-02-22 23:50:04 +000092 unsigned RunTimeVer, StringRef SplitName) {
Chandler Carruthb0dc4d92012-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 Patel94c7ddb2011-08-16 22:09:43 +000098 Value *TElts[] = { GetTagConstant(VMContext, DW_TAG_base_type) };
99 TempEnumTypes = MDNode::getTemporary(VMContext, TElts);
Devang Patel94c7ddb2011-08-16 22:09:43 +0000100
101 TempRetainTypes = MDNode::getTemporary(VMContext, TElts);
Devang Patel94c7ddb2011-08-16 22:09:43 +0000102
103 TempSubprograms = MDNode::getTemporary(VMContext, TElts);
Devang Patel94c7ddb2011-08-16 22:09:43 +0000104
105 TempGVs = MDNode::getTemporary(VMContext, TElts);
Devang Patel94c7ddb2011-08-16 22:09:43 +0000106
David Blaikiec462db62013-04-22 06:12:31 +0000107 TempImportedModules = MDNode::getTemporary(VMContext, TElts);
108
Benjamin Kramer42c9b252010-11-04 18:45:27 +0000109 Value *Elts[] = {
110 GetTagConstant(VMContext, dwarf::DW_TAG_compile_unit),
David Blaikie00c5c5d2013-03-20 23:58:12 +0000111 createFilePathPair(VMContext, Filename, Directory),
David Blaikie162c8002013-03-20 22:52:54 +0000112 ConstantInt::get(Type::getInt32Ty(VMContext), Lang),
Benjamin Kramer42c9b252010-11-04 18:45:27 +0000113 MDString::get(VMContext, Producer),
Benjamin Kramer42c9b252010-11-04 18:45:27 +0000114 ConstantInt::get(Type::getInt1Ty(VMContext), isOptimized),
115 MDString::get(VMContext, Flags),
Devang Patel94c7ddb2011-08-16 22:09:43 +0000116 ConstantInt::get(Type::getInt32Ty(VMContext), RunTimeVer),
David Blaikiea8eefc72013-02-02 05:56:24 +0000117 TempEnumTypes,
118 TempRetainTypes,
119 TempSubprograms,
Eric Christophere4b67902013-02-22 23:50:04 +0000120 TempGVs,
David Blaikiec462db62013-04-22 06:12:31 +0000121 TempImportedModules,
Eric Christophere4b67902013-02-22 23:50:04 +0000122 MDString::get(VMContext, SplitName)
Benjamin Kramer42c9b252010-11-04 18:45:27 +0000123 };
David Blaikie72dfb052013-03-28 02:44:59 +0000124 TheCU = DICompileUnit(MDNode::get(VMContext, Elts));
Devang Patel464f4ef2011-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 Patel35fcd652010-11-04 15:01:38 +0000129}
130
David Blaikie7b72cc72013-05-20 22:50:35 +0000131static DIImportedEntity
132createImportedModule(LLVMContext &C, DIScope Context, DIDescriptor NS,
133 unsigned Line, StringRef Name,
134 SmallVectorImpl<Value *> &AllImportedModules) {
135 const MDNode *R;
136 if (Name.empty()) {
137 Value *Elts[] = {
138 GetTagConstant(C, dwarf::DW_TAG_imported_module),
139 Context,
140 NS,
141 ConstantInt::get(Type::getInt32Ty(C), Line),
142 };
143 R = MDNode::get(C, Elts);
144 } else {
145 Value *Elts[] = {
146 GetTagConstant(C, dwarf::DW_TAG_imported_module),
147 Context,
148 NS,
149 ConstantInt::get(Type::getInt32Ty(C), Line),
150 MDString::get(C, Name)
151 };
152 R = MDNode::get(C, Elts);
153 }
154 DIImportedEntity M(R);
David Blaikie20d9e412013-05-07 21:35:53 +0000155 assert(M.Verify() && "Imported module should be valid");
156 AllImportedModules.push_back(M);
157 return M;
158}
159
David Blaikie7b72cc72013-05-20 22:50:35 +0000160DIImportedEntity DIBuilder::createImportedModule(DIScope Context,
161 DINameSpace NS, unsigned Line,
162 StringRef Name) {
163 return ::createImportedModule(VMContext, Context, NS, Line, Name,
164 AllImportedModules);
165}
166
167DIImportedEntity DIBuilder::createImportedModule(DIScope Context,
168 DIImportedEntity NS,
169 unsigned Line,
170 StringRef Name) {
171 return ::createImportedModule(VMContext, Context, NS, Line, Name,
172 AllImportedModules);
173}
174
David Blaikie20d9e412013-05-07 21:35:53 +0000175DIImportedEntity DIBuilder::createImportedDeclaration(DIScope Context,
176 DIDescriptor Decl,
177 unsigned Line) {
178 Value *Elts[] = {
179 GetTagConstant(VMContext, dwarf::DW_TAG_imported_declaration),
180 Context,
181 Decl,
182 ConstantInt::get(Type::getInt32Ty(VMContext), Line),
183 };
184 DIImportedEntity M(MDNode::get(VMContext, Elts));
David Blaikiec462db62013-04-22 06:12:31 +0000185 assert(M.Verify() && "Imported module should be valid");
186 AllImportedModules.push_back(M);
187 return M;
188}
189
Devang Patel50d280c2011-02-22 18:56:12 +0000190/// createFile - Create a file descriptor to hold debugging information
Devang Patel35fcd652010-11-04 15:01:38 +0000191/// for a file.
Devang Patel50d280c2011-02-22 18:56:12 +0000192DIFile DIBuilder::createFile(StringRef Filename, StringRef Directory) {
David Blaikieb4cf0ab2013-03-17 21:13:55 +0000193 Value *Elts[] = {
194 GetTagConstant(VMContext, dwarf::DW_TAG_file_type),
David Blaikie72dfb052013-03-28 02:44:59 +0000195 createFilePathPair(VMContext, Filename, Directory)
David Blaikieb4cf0ab2013-03-17 21:13:55 +0000196 };
David Blaikie72dfb052013-03-28 02:44:59 +0000197 return DIFile(MDNode::get(VMContext, Elts));
Devang Patel35fcd652010-11-04 15:01:38 +0000198}
199
Devang Patel50d280c2011-02-22 18:56:12 +0000200/// createEnumerator - Create a single enumerator value.
201DIEnumerator DIBuilder::createEnumerator(StringRef Name, uint64_t Val) {
Devang Patel811ae5b2011-09-12 18:26:08 +0000202 assert(!Name.empty() && "Unable to create enumerator without name");
Benjamin Kramer42c9b252010-11-04 18:45:27 +0000203 Value *Elts[] = {
204 GetTagConstant(VMContext, dwarf::DW_TAG_enumerator),
205 MDString::get(VMContext, Name),
206 ConstantInt::get(Type::getInt64Ty(VMContext), Val)
207 };
David Blaikie72dfb052013-03-28 02:44:59 +0000208 return DIEnumerator(MDNode::get(VMContext, Elts));
Devang Patel35fcd652010-11-04 15:01:38 +0000209}
210
Devang Patel734a67c2011-09-14 23:13:28 +0000211/// createNullPtrType - Create C++0x nullptr type.
Manman Ren576d49a2013-06-07 18:35:53 +0000212DIBasicType DIBuilder::createNullPtrType(StringRef Name) {
Devang Patel734a67c2011-09-14 23:13:28 +0000213 assert(!Name.empty() && "Unable to create type without name");
214 // nullptr is encoded in DIBasicType format. Line number, filename,
215 // ,size, alignment, offset and flags are always empty here.
216 Value *Elts[] = {
217 GetTagConstant(VMContext, dwarf::DW_TAG_unspecified_type),
David Blaikiea13f3cd2013-03-19 23:25:22 +0000218 NULL, // Filename
Devang Patel734a67c2011-09-14 23:13:28 +0000219 NULL, //TheCU,
220 MDString::get(VMContext, Name),
Devang Patel734a67c2011-09-14 23:13:28 +0000221 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
222 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Size
223 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Align
224 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
225 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags;
Bill Wendling9fdb7c02012-07-06 17:49:19 +0000226 ConstantInt::get(Type::getInt32Ty(VMContext), 0) // Encoding
Devang Patel734a67c2011-09-14 23:13:28 +0000227 };
Manman Ren576d49a2013-06-07 18:35:53 +0000228 return DIBasicType(MDNode::get(VMContext, Elts));
Devang Patel734a67c2011-09-14 23:13:28 +0000229}
230
Eric Christopher6c0046f2011-08-26 21:02:40 +0000231/// createBasicType - Create debugging information entry for a basic
Devang Patel35fcd652010-11-04 15:01:38 +0000232/// type, e.g 'char'.
David Blaikie2ce067a2013-02-12 00:40:41 +0000233DIBasicType
234DIBuilder::createBasicType(StringRef Name, uint64_t SizeInBits,
235 uint64_t AlignInBits, unsigned Encoding) {
Devang Patel811ae5b2011-09-12 18:26:08 +0000236 assert(!Name.empty() && "Unable to create type without name");
Devang Patel35fcd652010-11-04 15:01:38 +0000237 // Basic types are encoded in DIBasicType format. Line number, filename,
238 // offset and flags are always empty here.
Benjamin Kramer42c9b252010-11-04 18:45:27 +0000239 Value *Elts[] = {
240 GetTagConstant(VMContext, dwarf::DW_TAG_base_type),
David Blaikiea13f3cd2013-03-19 23:25:22 +0000241 NULL, // File/directory name
Devang Patel94c7ddb2011-08-16 22:09:43 +0000242 NULL, //TheCU,
Benjamin Kramer42c9b252010-11-04 18:45:27 +0000243 MDString::get(VMContext, Name),
Benjamin Kramer42c9b252010-11-04 18:45:27 +0000244 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
245 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
246 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
247 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
248 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags;
249 ConstantInt::get(Type::getInt32Ty(VMContext), Encoding)
250 };
David Blaikie72dfb052013-03-28 02:44:59 +0000251 return DIBasicType(MDNode::get(VMContext, Elts));
Devang Patel35fcd652010-11-04 15:01:38 +0000252}
253
Nick Lewyckyffab7d02011-11-09 22:45:04 +0000254/// createQualifiedType - Create debugging information entry for a qualified
Devang Patel35fcd652010-11-04 15:01:38 +0000255/// type, e.g. 'const int'.
David Blaikied67c5ca2013-02-18 06:41:57 +0000256DIDerivedType DIBuilder::createQualifiedType(unsigned Tag, DIType FromTy) {
Benjamin Kramer42c9b252010-11-04 18:45:27 +0000257 // Qualified types are encoded in DIDerivedType format.
258 Value *Elts[] = {
259 GetTagConstant(VMContext, Tag),
David Blaikiea13f3cd2013-03-19 23:25:22 +0000260 NULL, // Filename
Devang Patel94c7ddb2011-08-16 22:09:43 +0000261 NULL, //TheCU,
Benjamin Kramer42c9b252010-11-04 18:45:27 +0000262 MDString::get(VMContext, StringRef()), // Empty name.
Benjamin Kramer42c9b252010-11-04 18:45:27 +0000263 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
264 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Size
265 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Align
266 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
267 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags
268 FromTy
269 };
David Blaikie72dfb052013-03-28 02:44:59 +0000270 return DIDerivedType(MDNode::get(VMContext, Elts));
Devang Patel35fcd652010-11-04 15:01:38 +0000271}
272
Devang Patel50d280c2011-02-22 18:56:12 +0000273/// createPointerType - Create debugging information entry for a pointer.
David Blaikied67c5ca2013-02-18 06:41:57 +0000274DIDerivedType
275DIBuilder::createPointerType(DIType PointeeTy, uint64_t SizeInBits,
276 uint64_t AlignInBits, StringRef Name) {
Benjamin Kramer42c9b252010-11-04 18:45:27 +0000277 // Pointer types are encoded in DIDerivedType format.
278 Value *Elts[] = {
279 GetTagConstant(VMContext, dwarf::DW_TAG_pointer_type),
David Blaikiea13f3cd2013-03-19 23:25:22 +0000280 NULL, // Filename
Devang Patel94c7ddb2011-08-16 22:09:43 +0000281 NULL, //TheCU,
Benjamin Kramer42c9b252010-11-04 18:45:27 +0000282 MDString::get(VMContext, Name),
Benjamin Kramer42c9b252010-11-04 18:45:27 +0000283 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
284 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
285 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
286 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
287 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags
288 PointeeTy
289 };
David Blaikie72dfb052013-03-28 02:44:59 +0000290 return DIDerivedType(MDNode::get(VMContext, Elts));
Devang Patel35fcd652010-11-04 15:01:38 +0000291}
292
Eric Christopher09b79812013-04-19 20:37:12 +0000293DIDerivedType DIBuilder::createMemberPointerType(DIType PointeeTy,
294 DIType Base) {
David Blaikie62fdfb52013-01-07 05:51:15 +0000295 // Pointer types are encoded in DIDerivedType format.
296 Value *Elts[] = {
297 GetTagConstant(VMContext, dwarf::DW_TAG_ptr_to_member_type),
David Blaikiea13f3cd2013-03-19 23:25:22 +0000298 NULL, // Filename
David Blaikie62fdfb52013-01-07 05:51:15 +0000299 NULL, //TheCU,
300 NULL,
David Blaikie62fdfb52013-01-07 05:51:15 +0000301 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
302 ConstantInt::get(Type::getInt64Ty(VMContext), 0),
303 ConstantInt::get(Type::getInt64Ty(VMContext), 0),
304 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
305 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags
306 PointeeTy,
307 Base
308 };
David Blaikie72dfb052013-03-28 02:44:59 +0000309 return DIDerivedType(MDNode::get(VMContext, Elts));
David Blaikie62fdfb52013-01-07 05:51:15 +0000310}
311
Eric Christopher791e6292012-05-19 01:36:37 +0000312/// createReferenceType - Create debugging information entry for a reference
313/// type.
David Blaikied67c5ca2013-02-18 06:41:57 +0000314DIDerivedType DIBuilder::createReferenceType(unsigned Tag, DIType RTy) {
Devang Patel811ae5b2011-09-12 18:26:08 +0000315 assert(RTy.Verify() && "Unable to create reference type");
Benjamin Kramer42c9b252010-11-04 18:45:27 +0000316 // References are encoded in DIDerivedType format.
317 Value *Elts[] = {
Eric Christopher791e6292012-05-19 01:36:37 +0000318 GetTagConstant(VMContext, Tag),
David Blaikiea13f3cd2013-03-19 23:25:22 +0000319 NULL, // Filename
Eric Christopher6c0046f2011-08-26 21:02:40 +0000320 NULL, // TheCU,
Benjamin Kramer42c9b252010-11-04 18:45:27 +0000321 NULL, // Name
Benjamin Kramer42c9b252010-11-04 18:45:27 +0000322 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
323 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Size
324 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Align
325 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
326 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags
327 RTy
328 };
David Blaikie72dfb052013-03-28 02:44:59 +0000329 return DIDerivedType(MDNode::get(VMContext, Elts));
Devang Patel35fcd652010-11-04 15:01:38 +0000330}
331
Devang Patel50d280c2011-02-22 18:56:12 +0000332/// createTypedef - Create debugging information entry for a typedef.
David Blaikied67c5ca2013-02-18 06:41:57 +0000333DIDerivedType DIBuilder::createTypedef(DIType Ty, StringRef Name, DIFile File,
334 unsigned LineNo, DIDescriptor Context) {
Benjamin Kramer42c9b252010-11-04 18:45:27 +0000335 // typedefs are encoded in DIDerivedType format.
336 assert(Ty.Verify() && "Invalid typedef type!");
337 Value *Elts[] = {
338 GetTagConstant(VMContext, dwarf::DW_TAG_typedef),
David Blaikie4776bce2013-03-20 00:26:26 +0000339 File.getFileNode(),
Devang Patel94c7ddb2011-08-16 22:09:43 +0000340 getNonCompileUnitScope(Context),
Benjamin Kramer42c9b252010-11-04 18:45:27 +0000341 MDString::get(VMContext, Name),
Benjamin Kramer42c9b252010-11-04 18:45:27 +0000342 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
343 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Size
344 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Align
345 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
346 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags
347 Ty
348 };
David Blaikie72dfb052013-03-28 02:44:59 +0000349 return DIDerivedType(MDNode::get(VMContext, Elts));
Devang Patel35fcd652010-11-04 15:01:38 +0000350}
351
Devang Patel50d280c2011-02-22 18:56:12 +0000352/// createFriend - Create debugging information entry for a 'friend'.
Manman Ren576d49a2013-06-07 18:35:53 +0000353DIDerivedType DIBuilder::createFriend(DIType Ty, DIType FriendTy) {
Benjamin Kramer42c9b252010-11-04 18:45:27 +0000354 // typedefs are encoded in DIDerivedType format.
355 assert(Ty.Verify() && "Invalid type!");
356 assert(FriendTy.Verify() && "Invalid friend type!");
357 Value *Elts[] = {
358 GetTagConstant(VMContext, dwarf::DW_TAG_friend),
David Blaikiea13f3cd2013-03-19 23:25:22 +0000359 NULL,
Benjamin Kramer42c9b252010-11-04 18:45:27 +0000360 Ty,
361 NULL, // Name
Benjamin Kramer42c9b252010-11-04 18:45:27 +0000362 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
363 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Size
364 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Align
365 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
366 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags
367 FriendTy
368 };
Manman Ren576d49a2013-06-07 18:35:53 +0000369 return DIDerivedType(MDNode::get(VMContext, Elts));
Devang Patel35fcd652010-11-04 15:01:38 +0000370}
371
Devang Patel50d280c2011-02-22 18:56:12 +0000372/// createInheritance - Create debugging information entry to establish
Eric Christopherc27c7342011-09-12 19:58:22 +0000373/// inheritance relationship between two types.
David Blaikied67c5ca2013-02-18 06:41:57 +0000374DIDerivedType DIBuilder::createInheritance(
375 DIType Ty, DIType BaseTy, uint64_t BaseOffset, unsigned Flags) {
Devang Patel811ae5b2011-09-12 18:26:08 +0000376 assert(Ty.Verify() && "Unable to create inheritance");
Benjamin Kramer42c9b252010-11-04 18:45:27 +0000377 // TAG_inheritance is encoded in DIDerivedType format.
378 Value *Elts[] = {
379 GetTagConstant(VMContext, dwarf::DW_TAG_inheritance),
David Blaikiea13f3cd2013-03-19 23:25:22 +0000380 NULL,
Benjamin Kramer42c9b252010-11-04 18:45:27 +0000381 Ty,
382 NULL, // Name
Benjamin Kramer42c9b252010-11-04 18:45:27 +0000383 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
384 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Size
385 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Align
386 ConstantInt::get(Type::getInt64Ty(VMContext), BaseOffset),
387 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
388 BaseTy
389 };
David Blaikie72dfb052013-03-28 02:44:59 +0000390 return DIDerivedType(MDNode::get(VMContext, Elts));
Devang Patel35fcd652010-11-04 15:01:38 +0000391}
392
Devang Patel50d280c2011-02-22 18:56:12 +0000393/// createMemberType - Create debugging information entry for a member.
David Blaikied67c5ca2013-02-18 06:41:57 +0000394DIDerivedType DIBuilder::createMemberType(
395 DIDescriptor Scope, StringRef Name, DIFile File, unsigned LineNumber,
396 uint64_t SizeInBits, uint64_t AlignInBits, uint64_t OffsetInBits,
397 unsigned Flags, DIType Ty) {
Benjamin Kramer42c9b252010-11-04 18:45:27 +0000398 // TAG_member is encoded in DIDerivedType format.
399 Value *Elts[] = {
400 GetTagConstant(VMContext, dwarf::DW_TAG_member),
David Blaikie4776bce2013-03-20 00:26:26 +0000401 File.getFileNode(),
Devang Patel94c7ddb2011-08-16 22:09:43 +0000402 getNonCompileUnitScope(Scope),
Benjamin Kramer42c9b252010-11-04 18:45:27 +0000403 MDString::get(VMContext, Name),
Benjamin Kramer42c9b252010-11-04 18:45:27 +0000404 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
405 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
406 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
407 ConstantInt::get(Type::getInt64Ty(VMContext), OffsetInBits),
408 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
409 Ty
410 };
David Blaikie72dfb052013-03-28 02:44:59 +0000411 return DIDerivedType(MDNode::get(VMContext, Elts));
Devang Patel35fcd652010-11-04 15:01:38 +0000412}
413
Eric Christopher6b6061f2013-01-16 01:22:23 +0000414/// createStaticMemberType - Create debugging information entry for a
415/// C++ static data member.
Manman Ren576d49a2013-06-07 18:35:53 +0000416DIDerivedType
417DIBuilder::createStaticMemberType(DIDescriptor Scope, StringRef Name,
418 DIFile File, unsigned LineNumber,
419 DIType Ty, unsigned Flags,
420 llvm::Value *Val) {
Eric Christopher6b6061f2013-01-16 01:22:23 +0000421 // TAG_member is encoded in DIDerivedType format.
422 Flags |= DIDescriptor::FlagStaticMember;
423 Value *Elts[] = {
424 GetTagConstant(VMContext, dwarf::DW_TAG_member),
David Blaikie4776bce2013-03-20 00:26:26 +0000425 File.getFileNode(),
Eric Christopher6b6061f2013-01-16 01:22:23 +0000426 getNonCompileUnitScope(Scope),
427 MDString::get(VMContext, Name),
Eric Christopher6b6061f2013-01-16 01:22:23 +0000428 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
429 ConstantInt::get(Type::getInt64Ty(VMContext), 0/*SizeInBits*/),
430 ConstantInt::get(Type::getInt64Ty(VMContext), 0/*AlignInBits*/),
431 ConstantInt::get(Type::getInt64Ty(VMContext), 0/*OffsetInBits*/),
432 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
433 Ty,
434 Val
435 };
Manman Ren576d49a2013-06-07 18:35:53 +0000436 return DIDerivedType(MDNode::get(VMContext, Elts));
Eric Christopher6b6061f2013-01-16 01:22:23 +0000437}
438
Devang Patele9db5e22011-04-16 00:11:51 +0000439/// createObjCIVar - Create debugging information entry for Objective-C
440/// instance variable.
Manman Ren576d49a2013-06-07 18:35:53 +0000441DIDerivedType
442DIBuilder::createObjCIVar(StringRef Name,
443 DIFile File, unsigned LineNumber,
444 uint64_t SizeInBits, uint64_t AlignInBits,
445 uint64_t OffsetInBits, unsigned Flags,
446 DIType Ty, StringRef PropertyName,
447 StringRef GetterName, StringRef SetterName,
448 unsigned PropertyAttributes) {
Devang Patele9db5e22011-04-16 00:11:51 +0000449 // TAG_member is encoded in DIDerivedType format.
450 Value *Elts[] = {
451 GetTagConstant(VMContext, dwarf::DW_TAG_member),
David Blaikie4776bce2013-03-20 00:26:26 +0000452 File.getFileNode(),
Devang Patel94c7ddb2011-08-16 22:09:43 +0000453 getNonCompileUnitScope(File),
Devang Patele9db5e22011-04-16 00:11:51 +0000454 MDString::get(VMContext, Name),
Devang Patele9db5e22011-04-16 00:11:51 +0000455 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
456 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
457 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
458 ConstantInt::get(Type::getInt64Ty(VMContext), OffsetInBits),
459 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
460 Ty,
461 MDString::get(VMContext, PropertyName),
462 MDString::get(VMContext, GetterName),
463 MDString::get(VMContext, SetterName),
464 ConstantInt::get(Type::getInt32Ty(VMContext), PropertyAttributes)
465 };
Manman Ren576d49a2013-06-07 18:35:53 +0000466 return DIDerivedType(MDNode::get(VMContext, Elts));
Devang Patele9db5e22011-04-16 00:11:51 +0000467}
468
Devang Patel6588abf2012-02-06 17:49:43 +0000469/// createObjCIVar - Create debugging information entry for Objective-C
470/// instance variable.
Manman Ren576d49a2013-06-07 18:35:53 +0000471DIDerivedType
472DIBuilder::createObjCIVar(StringRef Name,
473 DIFile File, unsigned LineNumber,
474 uint64_t SizeInBits, uint64_t AlignInBits,
475 uint64_t OffsetInBits, unsigned Flags,
476 DIType Ty, MDNode *PropertyNode) {
Devang Patel6588abf2012-02-06 17:49:43 +0000477 // TAG_member is encoded in DIDerivedType format.
478 Value *Elts[] = {
479 GetTagConstant(VMContext, dwarf::DW_TAG_member),
David Blaikie4776bce2013-03-20 00:26:26 +0000480 File.getFileNode(),
Devang Patel6588abf2012-02-06 17:49:43 +0000481 getNonCompileUnitScope(File),
482 MDString::get(VMContext, Name),
Devang Patel6588abf2012-02-06 17:49:43 +0000483 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
484 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
485 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
486 ConstantInt::get(Type::getInt64Ty(VMContext), OffsetInBits),
487 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
488 Ty,
489 PropertyNode
490 };
Manman Ren576d49a2013-06-07 18:35:53 +0000491 return DIDerivedType(MDNode::get(VMContext, Elts));
Devang Patel6588abf2012-02-06 17:49:43 +0000492}
493
Devang Patel1ea02d42012-02-04 00:59:25 +0000494/// createObjCProperty - Create debugging information entry for Objective-C
495/// property.
Eric Christopherb8ca9882012-03-29 08:42:56 +0000496DIObjCProperty DIBuilder::createObjCProperty(StringRef Name,
Eric Christopher87c06a82012-07-06 02:35:57 +0000497 DIFile File, unsigned LineNumber,
Devang Patel1ea02d42012-02-04 00:59:25 +0000498 StringRef GetterName,
Adrian Prantl2f445be2013-04-19 19:56:02 +0000499 StringRef SetterName,
Eric Christopherb8ca9882012-03-29 08:42:56 +0000500 unsigned PropertyAttributes,
Eric Christopher87c06a82012-07-06 02:35:57 +0000501 DIType Ty) {
Devang Patel1ea02d42012-02-04 00:59:25 +0000502 Value *Elts[] = {
Eric Christopher6c31ee22012-03-29 21:35:05 +0000503 GetTagConstant(VMContext, dwarf::DW_TAG_APPLE_property),
Devang Patel1ea02d42012-02-04 00:59:25 +0000504 MDString::get(VMContext, Name),
Eric Christopherb8ca9882012-03-29 08:42:56 +0000505 File,
506 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
Devang Patel1ea02d42012-02-04 00:59:25 +0000507 MDString::get(VMContext, GetterName),
508 MDString::get(VMContext, SetterName),
Eric Christopherb8ca9882012-03-29 08:42:56 +0000509 ConstantInt::get(Type::getInt32Ty(VMContext), PropertyAttributes),
510 Ty
Devang Patel1ea02d42012-02-04 00:59:25 +0000511 };
David Blaikie72dfb052013-03-28 02:44:59 +0000512 return DIObjCProperty(MDNode::get(VMContext, Elts));
Devang Patel1ea02d42012-02-04 00:59:25 +0000513}
514
Devang Patel50d280c2011-02-22 18:56:12 +0000515/// createTemplateTypeParameter - Create debugging information for template
Devang Patel7e2cb112011-02-02 21:38:25 +0000516/// type parameter.
Eric Christopher6c0046f2011-08-26 21:02:40 +0000517DITemplateTypeParameter
Devang Patel50d280c2011-02-22 18:56:12 +0000518DIBuilder::createTemplateTypeParameter(DIDescriptor Context, StringRef Name,
Devang Patel7e2cb112011-02-02 21:38:25 +0000519 DIType Ty, MDNode *File, unsigned LineNo,
520 unsigned ColumnNo) {
521 Value *Elts[] = {
522 GetTagConstant(VMContext, dwarf::DW_TAG_template_type_parameter),
Devang Patel94c7ddb2011-08-16 22:09:43 +0000523 getNonCompileUnitScope(Context),
Devang Patel7e2cb112011-02-02 21:38:25 +0000524 MDString::get(VMContext, Name),
525 Ty,
526 File,
527 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
528 ConstantInt::get(Type::getInt32Ty(VMContext), ColumnNo)
529 };
David Blaikie72dfb052013-03-28 02:44:59 +0000530 return DITemplateTypeParameter(MDNode::get(VMContext, Elts));
Devang Patel7e2cb112011-02-02 21:38:25 +0000531}
532
Devang Patel50d280c2011-02-22 18:56:12 +0000533/// createTemplateValueParameter - Create debugging information for template
Devang Patele7d93872011-02-02 22:35:53 +0000534/// value parameter.
Eric Christopher6c0046f2011-08-26 21:02:40 +0000535DITemplateValueParameter
Devang Patel50d280c2011-02-22 18:56:12 +0000536DIBuilder::createTemplateValueParameter(DIDescriptor Context, StringRef Name,
David Blaikie4de9d722013-05-10 21:52:07 +0000537 DIType Ty, Value *Val,
Devang Patele7d93872011-02-02 22:35:53 +0000538 MDNode *File, unsigned LineNo,
539 unsigned ColumnNo) {
540 Value *Elts[] = {
541 GetTagConstant(VMContext, dwarf::DW_TAG_template_value_parameter),
Devang Patel94c7ddb2011-08-16 22:09:43 +0000542 getNonCompileUnitScope(Context),
Devang Patele7d93872011-02-02 22:35:53 +0000543 MDString::get(VMContext, Name),
544 Ty,
David Blaikie4de9d722013-05-10 21:52:07 +0000545 Val,
Devang Patele7d93872011-02-02 22:35:53 +0000546 File,
547 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
548 ConstantInt::get(Type::getInt32Ty(VMContext), ColumnNo)
549 };
David Blaikie72dfb052013-03-28 02:44:59 +0000550 return DITemplateValueParameter(MDNode::get(VMContext, Elts));
Devang Patele7d93872011-02-02 22:35:53 +0000551}
552
Eric Christopher87c06a82012-07-06 02:35:57 +0000553/// createClassType - Create debugging information entry for a class.
David Blaikieca442a42013-03-26 23:46:39 +0000554DICompositeType DIBuilder::createClassType(DIDescriptor Context, StringRef Name,
555 DIFile File, unsigned LineNumber,
556 uint64_t SizeInBits,
557 uint64_t AlignInBits,
558 uint64_t OffsetInBits,
559 unsigned Flags, DIType DerivedFrom,
560 DIArray Elements,
561 MDNode *VTableHolder,
562 MDNode *TemplateParams) {
David Blaikie66438682013-03-11 23:21:19 +0000563 assert((!Context || Context.Verify()) &&
564 "createClassType should be called with a valid Context");
565 // TAG_class_type is encoded in DICompositeType format.
Eric Christopher87c06a82012-07-06 02:35:57 +0000566 Value *Elts[] = {
567 GetTagConstant(VMContext, dwarf::DW_TAG_class_type),
David Blaikie4776bce2013-03-20 00:26:26 +0000568 File.getFileNode(),
Eric Christopher87c06a82012-07-06 02:35:57 +0000569 getNonCompileUnitScope(Context),
570 MDString::get(VMContext, Name),
Eric Christopher87c06a82012-07-06 02:35:57 +0000571 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
572 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
573 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
574 ConstantInt::get(Type::getInt32Ty(VMContext), OffsetInBits),
575 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
576 DerivedFrom,
577 Elements,
578 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
579 VTableHolder,
580 TemplateParams
581 };
David Blaikieca442a42013-03-26 23:46:39 +0000582 DICompositeType R(MDNode::get(VMContext, Elts));
David Blaikie66438682013-03-11 23:21:19 +0000583 assert(R.Verify() && "createClassType should return a verifiable DIType");
584 return R;
Eric Christopher87c06a82012-07-06 02:35:57 +0000585}
586
Devang Patel50d280c2011-02-22 18:56:12 +0000587/// createStructType - Create debugging information entry for a struct.
David Blaikie6172f022013-02-25 01:07:18 +0000588DICompositeType DIBuilder::createStructType(DIDescriptor Context,
589 StringRef Name, DIFile File,
590 unsigned LineNumber,
591 uint64_t SizeInBits,
592 uint64_t AlignInBits,
593 unsigned Flags, DIType DerivedFrom,
594 DIArray Elements,
595 unsigned RunTimeLang,
596 MDNode *VTableHolder) {
Devang Patelfe58f952010-12-07 23:25:47 +0000597 // TAG_structure_type is encoded in DICompositeType format.
598 Value *Elts[] = {
599 GetTagConstant(VMContext, dwarf::DW_TAG_structure_type),
David Blaikie4776bce2013-03-20 00:26:26 +0000600 File.getFileNode(),
Devang Patel94c7ddb2011-08-16 22:09:43 +0000601 getNonCompileUnitScope(Context),
Devang Patelfe58f952010-12-07 23:25:47 +0000602 MDString::get(VMContext, Name),
Devang Patelfe58f952010-12-07 23:25:47 +0000603 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
604 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
605 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
Devang Patel43c249c2010-12-08 01:50:15 +0000606 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
Devang Patelfe58f952010-12-07 23:25:47 +0000607 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
David Blaikie6172f022013-02-25 01:07:18 +0000608 DerivedFrom,
Devang Patelfe58f952010-12-07 23:25:47 +0000609 Elements,
610 ConstantInt::get(Type::getInt32Ty(VMContext), RunTimeLang),
David Blaikie6172f022013-02-25 01:07:18 +0000611 VTableHolder,
David Blaikied4f92fd2013-02-18 07:27:30 +0000612 NULL,
Devang Patelfe58f952010-12-07 23:25:47 +0000613 };
David Blaikie66438682013-03-11 23:21:19 +0000614 DICompositeType R(MDNode::get(VMContext, Elts));
615 assert(R.Verify() && "createStructType should return a verifiable DIType");
616 return R;
Devang Patelfe58f952010-12-07 23:25:47 +0000617}
618
Devang Patel50d280c2011-02-22 18:56:12 +0000619/// createUnionType - Create debugging information entry for an union.
Eric Christophercf0623b2013-04-02 22:55:52 +0000620DICompositeType DIBuilder::createUnionType(DIDescriptor Scope, StringRef Name,
621 DIFile File, unsigned LineNumber,
622 uint64_t SizeInBits,
623 uint64_t AlignInBits, unsigned Flags,
624 DIArray Elements,
625 unsigned RunTimeLang) {
Devang Patel43c249c2010-12-08 01:50:15 +0000626 // TAG_union_type is encoded in DICompositeType format.
627 Value *Elts[] = {
628 GetTagConstant(VMContext, dwarf::DW_TAG_union_type),
David Blaikie4776bce2013-03-20 00:26:26 +0000629 File.getFileNode(),
Devang Patel94c7ddb2011-08-16 22:09:43 +0000630 getNonCompileUnitScope(Scope),
Devang Patel43c249c2010-12-08 01:50:15 +0000631 MDString::get(VMContext, Name),
Devang Patel43c249c2010-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::getInt64Ty(VMContext), 0),
636 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
Devang Patelc104cf22011-12-16 17:51:31 +0000637 NULL,
Devang Patel43c249c2010-12-08 01:50:15 +0000638 Elements,
639 ConstantInt::get(Type::getInt32Ty(VMContext), RunTimeLang),
Eric Christopherc656fda2013-04-02 22:55:56 +0000640 Constant::getNullValue(Type::getInt32Ty(VMContext)),
641 NULL
Devang Patel43c249c2010-12-08 01:50:15 +0000642 };
David Blaikie72dfb052013-03-28 02:44:59 +0000643 return DICompositeType(MDNode::get(VMContext, Elts));
Devang Patel43c249c2010-12-08 01:50:15 +0000644}
645
Devang Patel50d280c2011-02-22 18:56:12 +0000646/// createSubroutineType - Create subroutine type.
David Blaikied67c5ca2013-02-18 06:41:57 +0000647DICompositeType
648DIBuilder::createSubroutineType(DIFile File, DIArray ParameterTypes) {
Devang Patel43c249c2010-12-08 01:50:15 +0000649 // TAG_subroutine_type is encoded in DICompositeType format.
650 Value *Elts[] = {
651 GetTagConstant(VMContext, dwarf::DW_TAG_subroutine_type),
Bill Wendlingf46b4972012-07-06 17:47:36 +0000652 Constant::getNullValue(Type::getInt32Ty(VMContext)),
Bill Wendlingf46b4972012-07-06 17:47:36 +0000653 Constant::getNullValue(Type::getInt32Ty(VMContext)),
David Blaikiea13f3cd2013-03-19 23:25:22 +0000654 MDString::get(VMContext, ""),
Devang Patel43c249c2010-12-08 01:50:15 +0000655 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
656 ConstantInt::get(Type::getInt64Ty(VMContext), 0),
657 ConstantInt::get(Type::getInt64Ty(VMContext), 0),
Devang Patelc104cf22011-12-16 17:51:31 +0000658 ConstantInt::get(Type::getInt64Ty(VMContext), 0),
Devang Patel43c249c2010-12-08 01:50:15 +0000659 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
Devang Patelc104cf22011-12-16 17:51:31 +0000660 NULL,
Devang Patel43c249c2010-12-08 01:50:15 +0000661 ParameterTypes,
662 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
Bill Wendling9fdb7c02012-07-06 17:49:19 +0000663 Constant::getNullValue(Type::getInt32Ty(VMContext))
Devang Patel43c249c2010-12-08 01:50:15 +0000664 };
David Blaikie72dfb052013-03-28 02:44:59 +0000665 return DICompositeType(MDNode::get(VMContext, Elts));
Devang Patel43c249c2010-12-08 01:50:15 +0000666}
667
Eric Christopher6c0046f2011-08-26 21:02:40 +0000668/// createEnumerationType - Create debugging information entry for an
Devang Patel43c249c2010-12-08 01:50:15 +0000669/// enumeration.
David Blaikied67c5ca2013-02-18 06:41:57 +0000670DICompositeType DIBuilder::createEnumerationType(
671 DIDescriptor Scope, StringRef Name, DIFile File, unsigned LineNumber,
672 uint64_t SizeInBits, uint64_t AlignInBits, DIArray Elements,
Adrian Prantl2f445be2013-04-19 19:56:02 +0000673 DIType UnderlyingType) {
Devang Patel43c249c2010-12-08 01:50:15 +0000674 // TAG_enumeration_type is encoded in DICompositeType format.
675 Value *Elts[] = {
676 GetTagConstant(VMContext, dwarf::DW_TAG_enumeration_type),
David Blaikie4776bce2013-03-20 00:26:26 +0000677 File.getFileNode(),
Devang Patel94c7ddb2011-08-16 22:09:43 +0000678 getNonCompileUnitScope(Scope),
Devang Patel43c249c2010-12-08 01:50:15 +0000679 MDString::get(VMContext, Name),
Devang Patel43c249c2010-12-08 01:50:15 +0000680 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
681 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
682 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
683 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
Eli Friedmance3da6f2012-10-05 01:49:14 +0000684 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
Adrian Prantl2f445be2013-04-19 19:56:02 +0000685 UnderlyingType,
Devang Patel43c249c2010-12-08 01:50:15 +0000686 Elements,
687 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
Bill Wendling9fdb7c02012-07-06 17:49:19 +0000688 Constant::getNullValue(Type::getInt32Ty(VMContext))
Devang Patel43c249c2010-12-08 01:50:15 +0000689 };
Devang Patel1f48a952011-04-18 23:51:03 +0000690 MDNode *Node = MDNode::get(VMContext, Elts);
Devang Patel94c7ddb2011-08-16 22:09:43 +0000691 AllEnumTypes.push_back(Node);
David Blaikie72dfb052013-03-28 02:44:59 +0000692 return DICompositeType(Node);
Devang Patel43c249c2010-12-08 01:50:15 +0000693}
694
Devang Patel50d280c2011-02-22 18:56:12 +0000695/// createArrayType - Create debugging information entry for an array.
David Blaikied67c5ca2013-02-18 06:41:57 +0000696DICompositeType DIBuilder::createArrayType(uint64_t Size, uint64_t AlignInBits,
697 DIType Ty, DIArray Subscripts) {
Devang Patel43c249c2010-12-08 01:50:15 +0000698 // TAG_array_type is encoded in DICompositeType format.
699 Value *Elts[] = {
700 GetTagConstant(VMContext, dwarf::DW_TAG_array_type),
David Blaikiea13f3cd2013-03-19 23:25:22 +0000701 NULL, // Filename/Directory,
Devang Patel94c7ddb2011-08-16 22:09:43 +0000702 NULL, //TheCU,
Devang Patel43c249c2010-12-08 01:50:15 +0000703 MDString::get(VMContext, ""),
Devang Patel43c249c2010-12-08 01:50:15 +0000704 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
705 ConstantInt::get(Type::getInt64Ty(VMContext), Size),
706 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
707 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
708 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
709 Ty,
710 Subscripts,
711 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
Bill Wendling9fdb7c02012-07-06 17:49:19 +0000712 Constant::getNullValue(Type::getInt32Ty(VMContext))
Devang Patel43c249c2010-12-08 01:50:15 +0000713 };
David Blaikie72dfb052013-03-28 02:44:59 +0000714 return DICompositeType(MDNode::get(VMContext, Elts));
Devang Patel43c249c2010-12-08 01:50:15 +0000715}
716
Devang Patel50d280c2011-02-22 18:56:12 +0000717/// createVectorType - Create debugging information entry for a vector.
Manman Ren37bfb182013-06-07 03:13:46 +0000718DICompositeType DIBuilder::createVectorType(uint64_t Size, uint64_t AlignInBits,
719 DIType Ty, DIArray Subscripts) {
Eric Christopher9a1e0e22013-01-08 01:53:52 +0000720
721 // A vector is an array type with the FlagVector flag applied.
Devang Patel43c249c2010-12-08 01:50:15 +0000722 Value *Elts[] = {
Eric Christopher9a1e0e22013-01-08 01:53:52 +0000723 GetTagConstant(VMContext, dwarf::DW_TAG_array_type),
David Blaikiea13f3cd2013-03-19 23:25:22 +0000724 NULL, // Filename/Directory,
Devang Patel94c7ddb2011-08-16 22:09:43 +0000725 NULL, //TheCU,
Devang Patel43c249c2010-12-08 01:50:15 +0000726 MDString::get(VMContext, ""),
Devang Patel43c249c2010-12-08 01:50:15 +0000727 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
728 ConstantInt::get(Type::getInt64Ty(VMContext), Size),
729 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
730 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
Eric Christopher9a1e0e22013-01-08 01:53:52 +0000731 ConstantInt::get(Type::getInt32Ty(VMContext), DIType::FlagVector),
Devang Patel43c249c2010-12-08 01:50:15 +0000732 Ty,
733 Subscripts,
734 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
Bill Wendling9fdb7c02012-07-06 17:49:19 +0000735 Constant::getNullValue(Type::getInt32Ty(VMContext))
Devang Patel43c249c2010-12-08 01:50:15 +0000736 };
Manman Ren37bfb182013-06-07 03:13:46 +0000737 return DICompositeType(MDNode::get(VMContext, Elts));
Devang Patel43c249c2010-12-08 01:50:15 +0000738}
Devang Patelfe58f952010-12-07 23:25:47 +0000739
Devang Patel50d280c2011-02-22 18:56:12 +0000740/// createArtificialType - Create a new DIType with "artificial" flag set.
741DIType DIBuilder::createArtificialType(DIType Ty) {
Devang Patel35fcd652010-11-04 15:01:38 +0000742 if (Ty.isArtificial())
743 return Ty;
744
745 SmallVector<Value *, 9> Elts;
746 MDNode *N = Ty;
747 assert (N && "Unexpected input DIType!");
748 for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i) {
749 if (Value *V = N->getOperand(i))
750 Elts.push_back(V);
751 else
752 Elts.push_back(Constant::getNullValue(Type::getInt32Ty(VMContext)));
753 }
754
755 unsigned CurFlags = Ty.getFlags();
756 CurFlags = CurFlags | DIType::FlagArtificial;
757
758 // Flags are stored at this slot.
David Blaikie72dfb052013-03-28 02:44:59 +0000759 Elts[8] = ConstantInt::get(Type::getInt32Ty(VMContext), CurFlags);
Devang Patel35fcd652010-11-04 15:01:38 +0000760
David Blaikie72dfb052013-03-28 02:44:59 +0000761 return DIType(MDNode::get(VMContext, Elts));
Devang Patel35fcd652010-11-04 15:01:38 +0000762}
Devang Patelfe58f952010-12-07 23:25:47 +0000763
Eric Christopher1f55eb42013-01-08 01:53:42 +0000764/// createObjectPointerType - Create a new type with both the object pointer
765/// and artificial flags set.
Eric Christophere5212782012-09-12 23:36:19 +0000766DIType DIBuilder::createObjectPointerType(DIType Ty) {
767 if (Ty.isObjectPointer())
768 return Ty;
769
770 SmallVector<Value *, 9> Elts;
771 MDNode *N = Ty;
772 assert (N && "Unexpected input DIType!");
773 for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i) {
774 if (Value *V = N->getOperand(i))
775 Elts.push_back(V);
776 else
777 Elts.push_back(Constant::getNullValue(Type::getInt32Ty(VMContext)));
778 }
779
780 unsigned CurFlags = Ty.getFlags();
781 CurFlags = CurFlags | (DIType::FlagObjectPointer | DIType::FlagArtificial);
782
783 // Flags are stored at this slot.
David Blaikie72dfb052013-03-28 02:44:59 +0000784 Elts[8] = ConstantInt::get(Type::getInt32Ty(VMContext), CurFlags);
Eric Christophere5212782012-09-12 23:36:19 +0000785
David Blaikie72dfb052013-03-28 02:44:59 +0000786 return DIType(MDNode::get(VMContext, Elts));
Eric Christophere5212782012-09-12 23:36:19 +0000787}
788
Eric Christopher6c0046f2011-08-26 21:02:40 +0000789/// retainType - Retain DIType in a module even if it is not referenced
Devang Patel43c249c2010-12-08 01:50:15 +0000790/// through debug info anchors.
Devang Patel50d280c2011-02-22 18:56:12 +0000791void DIBuilder::retainType(DIType T) {
Devang Patel94c7ddb2011-08-16 22:09:43 +0000792 AllRetainTypes.push_back(T);
Devang Patel43c249c2010-12-08 01:50:15 +0000793}
794
Devang Patel50d280c2011-02-22 18:56:12 +0000795/// createUnspecifiedParameter - Create unspeicified type descriptor
Devang Patel43c249c2010-12-08 01:50:15 +0000796/// for the subroutine type.
Devang Patel50d280c2011-02-22 18:56:12 +0000797DIDescriptor DIBuilder::createUnspecifiedParameter() {
Eric Christopher6c0046f2011-08-26 21:02:40 +0000798 Value *Elts[] = {
799 GetTagConstant(VMContext, dwarf::DW_TAG_unspecified_parameters)
Devang Patel43c249c2010-12-08 01:50:15 +0000800 };
Devang Patel1f48a952011-04-18 23:51:03 +0000801 return DIDescriptor(MDNode::get(VMContext, Elts));
Devang Patel43c249c2010-12-08 01:50:15 +0000802}
803
Eric Christopher4fe34572012-02-08 00:22:26 +0000804/// createForwardDecl - Create a temporary forward-declared type that
805/// can be RAUW'd if the full type is seen.
Eric Christopher216432d2012-04-23 19:00:11 +0000806DIType DIBuilder::createForwardDecl(unsigned Tag, StringRef Name,
807 DIDescriptor Scope, DIFile F,
Eli Friedmance3da6f2012-10-05 01:49:14 +0000808 unsigned Line, unsigned RuntimeLang,
809 uint64_t SizeInBits,
810 uint64_t AlignInBits) {
Eric Christopher4fe34572012-02-08 00:22:26 +0000811 // Create a temporary MDNode.
812 Value *Elts[] = {
813 GetTagConstant(VMContext, Tag),
David Blaikie4776bce2013-03-20 00:26:26 +0000814 F.getFileNode(),
Eric Christopher216432d2012-04-23 19:00:11 +0000815 getNonCompileUnitScope(Scope),
Eric Christopher4fe34572012-02-08 00:22:26 +0000816 MDString::get(VMContext, Name),
Eric Christopher4fe34572012-02-08 00:22:26 +0000817 ConstantInt::get(Type::getInt32Ty(VMContext), Line),
Eli Friedmance3da6f2012-10-05 01:49:14 +0000818 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
819 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
Eric Christopher4fe34572012-02-08 00:22:26 +0000820 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
821 ConstantInt::get(Type::getInt32Ty(VMContext),
Eric Christopher9f90e872012-02-20 18:04:14 +0000822 DIDescriptor::FlagFwdDecl),
823 NULL,
824 DIArray(),
825 ConstantInt::get(Type::getInt32Ty(VMContext), RuntimeLang)
Eric Christopher4fe34572012-02-08 00:22:26 +0000826 };
827 MDNode *Node = MDNode::getTemporary(VMContext, Elts);
David Blaikie66438682013-03-11 23:21:19 +0000828 assert(DIType(Node).Verify() &&
829 "createForwardDecl result should be verifiable");
Eric Christopher4fe34572012-02-08 00:22:26 +0000830 return DIType(Node);
831}
832
Devang Patel50d280c2011-02-22 18:56:12 +0000833/// getOrCreateArray - Get a DIArray, create one if required.
Jay Foad68550182011-04-24 10:11:03 +0000834DIArray DIBuilder::getOrCreateArray(ArrayRef<Value *> Elements) {
835 if (Elements.empty()) {
Bill Wendlingf46b4972012-07-06 17:47:36 +0000836 Value *Null = Constant::getNullValue(Type::getInt32Ty(VMContext));
Jay Foadec9186b2011-04-21 19:59:31 +0000837 return DIArray(MDNode::get(VMContext, Null));
Devang Patelfe58f952010-12-07 23:25:47 +0000838 }
Jay Foad68550182011-04-24 10:11:03 +0000839 return DIArray(MDNode::get(VMContext, Elements));
Devang Patelfe58f952010-12-07 23:25:47 +0000840}
841
Devang Patel50d280c2011-02-22 18:56:12 +0000842/// getOrCreateSubrange - Create a descriptor for a value range. This
Devang Patel43c249c2010-12-08 01:50:15 +0000843/// implicitly uniques the values returned.
Bill Wendling9493dae2012-12-04 21:34:03 +0000844DISubrange DIBuilder::getOrCreateSubrange(int64_t Lo, int64_t Count) {
Devang Patel43c249c2010-12-08 01:50:15 +0000845 Value *Elts[] = {
846 GetTagConstant(VMContext, dwarf::DW_TAG_subrange_type),
847 ConstantInt::get(Type::getInt64Ty(VMContext), Lo),
Bill Wendlinga7645a32012-12-04 06:20:49 +0000848 ConstantInt::get(Type::getInt64Ty(VMContext), Count)
Devang Patel43c249c2010-12-08 01:50:15 +0000849 };
850
Devang Patel1f48a952011-04-18 23:51:03 +0000851 return DISubrange(MDNode::get(VMContext, Elts));
Devang Patel43c249c2010-12-08 01:50:15 +0000852}
853
David Blaikie3fac43d2013-03-20 17:49:48 +0000854/// \brief Create a new descriptor for the specified global.
Devang Patelfe58f952010-12-07 23:25:47 +0000855DIGlobalVariable DIBuilder::
David Blaikie3fac43d2013-03-20 17:49:48 +0000856createGlobalVariable(StringRef Name, StringRef LinkageName, DIFile F,
857 unsigned LineNumber, DIType Ty, bool isLocalToUnit,
858 Value *Val) {
Devang Patelfe58f952010-12-07 23:25:47 +0000859 Value *Elts[] = {
860 GetTagConstant(VMContext, dwarf::DW_TAG_variable),
Bill Wendlingf46b4972012-07-06 17:47:36 +0000861 Constant::getNullValue(Type::getInt32Ty(VMContext)),
Devang Patel94c7ddb2011-08-16 22:09:43 +0000862 NULL, // TheCU,
Devang Patelfe58f952010-12-07 23:25:47 +0000863 MDString::get(VMContext, Name),
864 MDString::get(VMContext, Name),
David Blaikie3fac43d2013-03-20 17:49:48 +0000865 MDString::get(VMContext, LinkageName),
Devang Patelfe58f952010-12-07 23:25:47 +0000866 F,
867 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
868 Ty,
869 ConstantInt::get(Type::getInt32Ty(VMContext), isLocalToUnit),
870 ConstantInt::get(Type::getInt32Ty(VMContext), 1), /* isDefinition*/
Eric Christopher6b6061f2013-01-16 01:22:23 +0000871 Val,
872 DIDescriptor()
Devang Patelfe58f952010-12-07 23:25:47 +0000873 };
Devang Patel1f48a952011-04-18 23:51:03 +0000874 MDNode *Node = MDNode::get(VMContext, Elts);
Devang Patel94c7ddb2011-08-16 22:09:43 +0000875 AllGVs.push_back(Node);
Devang Patelfe58f952010-12-07 23:25:47 +0000876 return DIGlobalVariable(Node);
877}
878
David Blaikie3fac43d2013-03-20 17:49:48 +0000879/// \brief Create a new descriptor for the specified global.
880DIGlobalVariable DIBuilder::
881createGlobalVariable(StringRef Name, DIFile F, unsigned LineNumber,
882 DIType Ty, bool isLocalToUnit, Value *Val) {
883 return createGlobalVariable(Name, Name, F, LineNumber, Ty, isLocalToUnit,
884 Val);
885}
886
Devang Patel50d280c2011-02-22 18:56:12 +0000887/// createStaticVariable - Create a new descriptor for the specified static
Devang Patelfe58f952010-12-07 23:25:47 +0000888/// variable.
889DIGlobalVariable DIBuilder::
Eric Christopher6c0046f2011-08-26 21:02:40 +0000890createStaticVariable(DIDescriptor Context, StringRef Name,
891 StringRef LinkageName, DIFile F, unsigned LineNumber,
Eric Christopher6b6061f2013-01-16 01:22:23 +0000892 DIType Ty, bool isLocalToUnit, Value *Val, MDNode *Decl) {
Devang Patelfe58f952010-12-07 23:25:47 +0000893 Value *Elts[] = {
894 GetTagConstant(VMContext, dwarf::DW_TAG_variable),
Bill Wendlingf46b4972012-07-06 17:47:36 +0000895 Constant::getNullValue(Type::getInt32Ty(VMContext)),
Devang Patel94c7ddb2011-08-16 22:09:43 +0000896 getNonCompileUnitScope(Context),
Devang Patelfe58f952010-12-07 23:25:47 +0000897 MDString::get(VMContext, Name),
898 MDString::get(VMContext, Name),
899 MDString::get(VMContext, LinkageName),
900 F,
901 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
902 Ty,
903 ConstantInt::get(Type::getInt32Ty(VMContext), isLocalToUnit),
904 ConstantInt::get(Type::getInt32Ty(VMContext), 1), /* isDefinition*/
Eric Christopher6b6061f2013-01-16 01:22:23 +0000905 Val,
906 DIDescriptor(Decl)
Devang Patelfe58f952010-12-07 23:25:47 +0000907 };
Devang Patel1f48a952011-04-18 23:51:03 +0000908 MDNode *Node = MDNode::get(VMContext, Elts);
Devang Patel94c7ddb2011-08-16 22:09:43 +0000909 AllGVs.push_back(Node);
Devang Patelfe58f952010-12-07 23:25:47 +0000910 return DIGlobalVariable(Node);
911}
912
Devang Patel50d280c2011-02-22 18:56:12 +0000913/// createVariable - Create a new descriptor for the specified variable.
914DIVariable DIBuilder::createLocalVariable(unsigned Tag, DIDescriptor Scope,
Devang Patel48f17ba2010-12-07 23:58:00 +0000915 StringRef Name, DIFile File,
Eric Christopher6c0046f2011-08-26 21:02:40 +0000916 unsigned LineNo, DIType Ty,
Devang Patele9e16c52011-03-01 22:58:13 +0000917 bool AlwaysPreserve, unsigned Flags,
918 unsigned ArgNo) {
David Blaikie66438682013-03-11 23:21:19 +0000919 DIDescriptor Context(getNonCompileUnitScope(Scope));
920 assert((!Context || Context.Verify()) &&
921 "createLocalVariable should be called with a valid Context");
922 assert(Ty.Verify() &&
923 "createLocalVariable should be called with a valid type");
Devang Patel48f17ba2010-12-07 23:58:00 +0000924 Value *Elts[] = {
925 GetTagConstant(VMContext, Tag),
Devang Patel94c7ddb2011-08-16 22:09:43 +0000926 getNonCompileUnitScope(Scope),
Devang Patel48f17ba2010-12-07 23:58:00 +0000927 MDString::get(VMContext, Name),
928 File,
Devang Patele9e16c52011-03-01 22:58:13 +0000929 ConstantInt::get(Type::getInt32Ty(VMContext), (LineNo | (ArgNo << 24))),
Devang Patel48f17ba2010-12-07 23:58:00 +0000930 Ty,
Devang Patel23336b42011-07-19 19:41:54 +0000931 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
Bill Wendling9fdb7c02012-07-06 17:49:19 +0000932 Constant::getNullValue(Type::getInt32Ty(VMContext))
Devang Patel48f17ba2010-12-07 23:58:00 +0000933 };
Devang Patel1f48a952011-04-18 23:51:03 +0000934 MDNode *Node = MDNode::get(VMContext, Elts);
Devang Patel48f17ba2010-12-07 23:58:00 +0000935 if (AlwaysPreserve) {
936 // The optimizer may remove local variable. If there is an interest
937 // to preserve variable info in such situation then stash it in a
938 // named mdnode.
939 DISubprogram Fn(getDISubprogram(Scope));
Devang Patel93d39be2011-08-19 23:28:12 +0000940 NamedMDNode *FnLocals = getOrInsertFnSpecificMDNode(M, Fn);
Devang Patel48f17ba2010-12-07 23:58:00 +0000941 FnLocals->addOperand(Node);
942 }
David Blaikie66438682013-03-11 23:21:19 +0000943 assert(DIVariable(Node).Verify() &&
944 "createLocalVariable should return a verifiable DIVariable");
Devang Patel48f17ba2010-12-07 23:58:00 +0000945 return DIVariable(Node);
946}
947
Devang Patel50d280c2011-02-22 18:56:12 +0000948/// createComplexVariable - Create a new descriptor for the specified variable
Devang Patelfe58f952010-12-07 23:25:47 +0000949/// which has a complex address expression for its address.
Devang Patel50d280c2011-02-22 18:56:12 +0000950DIVariable DIBuilder::createComplexVariable(unsigned Tag, DIDescriptor Scope,
Devang Patelfe58f952010-12-07 23:25:47 +0000951 StringRef Name, DIFile F,
952 unsigned LineNo,
Jay Foad68550182011-04-24 10:11:03 +0000953 DIType Ty, ArrayRef<Value *> Addr,
954 unsigned ArgNo) {
Devang Patelfe58f952010-12-07 23:25:47 +0000955 SmallVector<Value *, 15> Elts;
956 Elts.push_back(GetTagConstant(VMContext, Tag));
Devang Patel94c7ddb2011-08-16 22:09:43 +0000957 Elts.push_back(getNonCompileUnitScope(Scope)),
Devang Patelfe58f952010-12-07 23:25:47 +0000958 Elts.push_back(MDString::get(VMContext, Name));
959 Elts.push_back(F);
Eric Christopher6c0046f2011-08-26 21:02:40 +0000960 Elts.push_back(ConstantInt::get(Type::getInt32Ty(VMContext),
Devang Patel9f997212012-02-08 00:17:07 +0000961 (LineNo | (ArgNo << 24))));
Devang Patelfe58f952010-12-07 23:25:47 +0000962 Elts.push_back(Ty);
Bill Wendlingf46b4972012-07-06 17:47:36 +0000963 Elts.push_back(Constant::getNullValue(Type::getInt32Ty(VMContext)));
964 Elts.push_back(Constant::getNullValue(Type::getInt32Ty(VMContext)));
Jay Foad68550182011-04-24 10:11:03 +0000965 Elts.append(Addr.begin(), Addr.end());
Devang Patelfe58f952010-12-07 23:25:47 +0000966
Devang Patel1f48a952011-04-18 23:51:03 +0000967 return DIVariable(MDNode::get(VMContext, Elts));
Devang Patelfe58f952010-12-07 23:25:47 +0000968}
969
Devang Patel50d280c2011-02-22 18:56:12 +0000970/// createFunction - Create a new descriptor for the specified function.
971DISubprogram DIBuilder::createFunction(DIDescriptor Context,
Devang Patel44498a62010-12-08 20:42:44 +0000972 StringRef Name,
973 StringRef LinkageName,
974 DIFile File, unsigned LineNo,
David Blaikie3d331842013-05-22 23:22:18 +0000975 DICompositeType Ty,
Devang Patel44498a62010-12-08 20:42:44 +0000976 bool isLocalToUnit, bool isDefinition,
Eric Christopher6126a1e2012-04-03 00:43:49 +0000977 unsigned ScopeLine,
Devang Patel44498a62010-12-08 20:42:44 +0000978 unsigned Flags, bool isOptimized,
Devang Patelda194752011-04-05 22:52:06 +0000979 Function *Fn,
Devang Patel5e06bb82011-04-22 23:10:17 +0000980 MDNode *TParams,
981 MDNode *Decl) {
David Blaikie3d331842013-05-22 23:22:18 +0000982 assert(Ty.getTag() == dwarf::DW_TAG_subroutine_type &&
983 "function types should be subroutines");
Devang Patel93d39be2011-08-19 23:28:12 +0000984 Value *TElts[] = { GetTagConstant(VMContext, DW_TAG_base_type) };
Devang Patel44498a62010-12-08 20:42:44 +0000985 Value *Elts[] = {
986 GetTagConstant(VMContext, dwarf::DW_TAG_subprogram),
David Blaikiebb4e6192013-03-21 23:08:34 +0000987 File.getFileNode(),
Devang Patel94c7ddb2011-08-16 22:09:43 +0000988 getNonCompileUnitScope(Context),
Devang Patel44498a62010-12-08 20:42:44 +0000989 MDString::get(VMContext, Name),
990 MDString::get(VMContext, Name),
991 MDString::get(VMContext, LinkageName),
Devang Patel44498a62010-12-08 20:42:44 +0000992 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
993 Ty,
994 ConstantInt::get(Type::getInt1Ty(VMContext), isLocalToUnit),
995 ConstantInt::get(Type::getInt1Ty(VMContext), isDefinition),
996 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
997 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
Devang Patel9642c572011-12-15 17:55:56 +0000998 NULL,
Devang Patel44498a62010-12-08 20:42:44 +0000999 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
1000 ConstantInt::get(Type::getInt1Ty(VMContext), isOptimized),
Devang Patelda194752011-04-05 22:52:06 +00001001 Fn,
Devang Patel5e06bb82011-04-22 23:10:17 +00001002 TParams,
Devang Patel93d39be2011-08-19 23:28:12 +00001003 Decl,
David Blaikief839eed2013-02-04 05:56:36 +00001004 MDNode::getTemporary(VMContext, TElts),
Eric Christopher6126a1e2012-04-03 00:43:49 +00001005 ConstantInt::get(Type::getInt32Ty(VMContext), ScopeLine)
Devang Patel44498a62010-12-08 20:42:44 +00001006 };
Devang Patel1f48a952011-04-18 23:51:03 +00001007 MDNode *Node = MDNode::get(VMContext, Elts);
Devang Patel44498a62010-12-08 20:42:44 +00001008
1009 // Create a named metadata so that we do not lose this mdnode.
David Blaikie139f7e52013-02-18 07:10:22 +00001010 if (isDefinition)
1011 AllSubprograms.push_back(Node);
David Blaikieebb51832013-03-21 20:28:52 +00001012 DISubprogram S(Node);
1013 assert(S.Verify() && "createFunction should return a valid DISubprogram");
1014 return S;
Devang Patel44498a62010-12-08 20:42:44 +00001015}
1016
Devang Patel50d280c2011-02-22 18:56:12 +00001017/// createMethod - Create a new descriptor for the specified C++ method.
1018DISubprogram DIBuilder::createMethod(DIDescriptor Context,
Devang Patel44498a62010-12-08 20:42:44 +00001019 StringRef Name,
1020 StringRef LinkageName,
1021 DIFile F,
David Blaikie3d331842013-05-22 23:22:18 +00001022 unsigned LineNo, DICompositeType Ty,
Devang Patel44498a62010-12-08 20:42:44 +00001023 bool isLocalToUnit,
1024 bool isDefinition,
1025 unsigned VK, unsigned VIndex,
1026 MDNode *VTableHolder,
1027 unsigned Flags,
1028 bool isOptimized,
Devang Patelda194752011-04-05 22:52:06 +00001029 Function *Fn,
1030 MDNode *TParam) {
David Blaikie3d331842013-05-22 23:22:18 +00001031 assert(Ty.getTag() == dwarf::DW_TAG_subroutine_type &&
1032 "function types should be subroutines");
Devang Patel93d39be2011-08-19 23:28:12 +00001033 Value *TElts[] = { GetTagConstant(VMContext, DW_TAG_base_type) };
Devang Patel44498a62010-12-08 20:42:44 +00001034 Value *Elts[] = {
1035 GetTagConstant(VMContext, dwarf::DW_TAG_subprogram),
David Blaikiebb4e6192013-03-21 23:08:34 +00001036 F.getFileNode(),
Devang Patel94c7ddb2011-08-16 22:09:43 +00001037 getNonCompileUnitScope(Context),
Devang Patel44498a62010-12-08 20:42:44 +00001038 MDString::get(VMContext, Name),
1039 MDString::get(VMContext, Name),
1040 MDString::get(VMContext, LinkageName),
Devang Patel44498a62010-12-08 20:42:44 +00001041 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
1042 Ty,
1043 ConstantInt::get(Type::getInt1Ty(VMContext), isLocalToUnit),
1044 ConstantInt::get(Type::getInt1Ty(VMContext), isDefinition),
1045 ConstantInt::get(Type::getInt32Ty(VMContext), (unsigned)VK),
1046 ConstantInt::get(Type::getInt32Ty(VMContext), VIndex),
1047 VTableHolder,
1048 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
1049 ConstantInt::get(Type::getInt1Ty(VMContext), isOptimized),
Devang Patelda194752011-04-05 22:52:06 +00001050 Fn,
1051 TParam,
Bill Wendlingf46b4972012-07-06 17:47:36 +00001052 Constant::getNullValue(Type::getInt32Ty(VMContext)),
David Blaikief839eed2013-02-04 05:56:36 +00001053 MDNode::getTemporary(VMContext, TElts),
Eric Christopher25016522012-05-18 00:16:22 +00001054 // FIXME: Do we want to use different scope/lines?
Eric Christopher6126a1e2012-04-03 00:43:49 +00001055 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo)
Devang Patel44498a62010-12-08 20:42:44 +00001056 };
Devang Patel1f48a952011-04-18 23:51:03 +00001057 MDNode *Node = MDNode::get(VMContext, Elts);
David Blaikie139f7e52013-02-18 07:10:22 +00001058 if (isDefinition)
1059 AllSubprograms.push_back(Node);
David Blaikieebb51832013-03-21 20:28:52 +00001060 DISubprogram S(Node);
1061 assert(S.Verify() && "createMethod should return a valid DISubprogram");
1062 return S;
Devang Patel44498a62010-12-08 20:42:44 +00001063}
1064
Devang Patel50d280c2011-02-22 18:56:12 +00001065/// createNameSpace - This creates new descriptor for a namespace
Devang Patelfe58f952010-12-07 23:25:47 +00001066/// with the specified parent scope.
Devang Patel50d280c2011-02-22 18:56:12 +00001067DINameSpace DIBuilder::createNameSpace(DIDescriptor Scope, StringRef Name,
Devang Patelfe58f952010-12-07 23:25:47 +00001068 DIFile File, unsigned LineNo) {
1069 Value *Elts[] = {
1070 GetTagConstant(VMContext, dwarf::DW_TAG_namespace),
David Blaikie6115ed02013-03-20 19:39:15 +00001071 File.getFileNode(),
Devang Patel94c7ddb2011-08-16 22:09:43 +00001072 getNonCompileUnitScope(Scope),
Devang Patelfe58f952010-12-07 23:25:47 +00001073 MDString::get(VMContext, Name),
Devang Patelfe58f952010-12-07 23:25:47 +00001074 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo)
1075 };
David Blaikie66438682013-03-11 23:21:19 +00001076 DINameSpace R(MDNode::get(VMContext, Elts));
1077 assert(R.Verify() &&
1078 "createNameSpace should return a verifiable DINameSpace");
1079 return R;
Devang Patelfe58f952010-12-07 23:25:47 +00001080}
1081
Eric Christopher6618a242011-10-11 22:59:11 +00001082/// createLexicalBlockFile - This creates a new MDNode that encapsulates
1083/// an existing scope with a new filename.
1084DILexicalBlockFile DIBuilder::createLexicalBlockFile(DIDescriptor Scope,
Devang Patel9f997212012-02-08 00:17:07 +00001085 DIFile File) {
Eric Christopher6618a242011-10-11 22:59:11 +00001086 Value *Elts[] = {
1087 GetTagConstant(VMContext, dwarf::DW_TAG_lexical_block),
David Blaikie8faed272013-03-22 20:18:46 +00001088 File.getFileNode(),
David Blaikie7b246862013-03-22 19:13:22 +00001089 Scope
Eric Christopher6618a242011-10-11 22:59:11 +00001090 };
David Blaikie66438682013-03-11 23:21:19 +00001091 DILexicalBlockFile R(MDNode::get(VMContext, Elts));
1092 assert(
1093 R.Verify() &&
1094 "createLexicalBlockFile should return a verifiable DILexicalBlockFile");
1095 return R;
Eric Christopher6618a242011-10-11 22:59:11 +00001096}
1097
Devang Patel50d280c2011-02-22 18:56:12 +00001098DILexicalBlock DIBuilder::createLexicalBlock(DIDescriptor Scope, DIFile File,
Devang Patel43c249c2010-12-08 01:50:15 +00001099 unsigned Line, unsigned Col) {
1100 // Defeat MDNode uniqing for lexical blocks by using unique id.
1101 static unsigned int unique_id = 0;
1102 Value *Elts[] = {
1103 GetTagConstant(VMContext, dwarf::DW_TAG_lexical_block),
David Blaikie4b52a882013-03-22 17:33:20 +00001104 File.getFileNode(),
Devang Patel94c7ddb2011-08-16 22:09:43 +00001105 getNonCompileUnitScope(Scope),
Devang Patel43c249c2010-12-08 01:50:15 +00001106 ConstantInt::get(Type::getInt32Ty(VMContext), Line),
1107 ConstantInt::get(Type::getInt32Ty(VMContext), Col),
Devang Patel43c249c2010-12-08 01:50:15 +00001108 ConstantInt::get(Type::getInt32Ty(VMContext), unique_id++)
1109 };
David Blaikie66438682013-03-11 23:21:19 +00001110 DILexicalBlock R(MDNode::get(VMContext, Elts));
1111 assert(R.Verify() &&
1112 "createLexicalBlock should return a verifiable DILexicalBlock");
1113 return R;
Devang Patel43c249c2010-12-08 01:50:15 +00001114}
1115
Devang Patel50d280c2011-02-22 18:56:12 +00001116/// insertDeclare - Insert a new llvm.dbg.declare intrinsic call.
1117Instruction *DIBuilder::insertDeclare(Value *Storage, DIVariable VarInfo,
Devang Patelfe58f952010-12-07 23:25:47 +00001118 Instruction *InsertBefore) {
1119 assert(Storage && "no storage passed to dbg.declare");
1120 assert(VarInfo.Verify() && "empty DIVariable passed to dbg.declare");
1121 if (!DeclareFn)
1122 DeclareFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_declare);
1123
Jay Foadec9186b2011-04-21 19:59:31 +00001124 Value *Args[] = { MDNode::get(Storage->getContext(), Storage), VarInfo };
Jay Foada3efbb12011-07-15 08:37:34 +00001125 return CallInst::Create(DeclareFn, Args, "", InsertBefore);
Devang Patelfe58f952010-12-07 23:25:47 +00001126}
1127
Devang Patel50d280c2011-02-22 18:56:12 +00001128/// insertDeclare - Insert a new llvm.dbg.declare intrinsic call.
1129Instruction *DIBuilder::insertDeclare(Value *Storage, DIVariable VarInfo,
Devang Patelfe58f952010-12-07 23:25:47 +00001130 BasicBlock *InsertAtEnd) {
1131 assert(Storage && "no storage passed to dbg.declare");
1132 assert(VarInfo.Verify() && "invalid DIVariable passed to dbg.declare");
1133 if (!DeclareFn)
1134 DeclareFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_declare);
1135
Jay Foadec9186b2011-04-21 19:59:31 +00001136 Value *Args[] = { MDNode::get(Storage->getContext(), Storage), VarInfo };
Devang Patelfe58f952010-12-07 23:25:47 +00001137
1138 // If this block already has a terminator then insert this intrinsic
1139 // before the terminator.
1140 if (TerminatorInst *T = InsertAtEnd->getTerminator())
Jay Foada3efbb12011-07-15 08:37:34 +00001141 return CallInst::Create(DeclareFn, Args, "", T);
Devang Patelfe58f952010-12-07 23:25:47 +00001142 else
Jay Foada3efbb12011-07-15 08:37:34 +00001143 return CallInst::Create(DeclareFn, Args, "", InsertAtEnd);
Devang Patelfe58f952010-12-07 23:25:47 +00001144}
1145
Devang Patel50d280c2011-02-22 18:56:12 +00001146/// insertDbgValueIntrinsic - Insert a new llvm.dbg.value intrinsic call.
1147Instruction *DIBuilder::insertDbgValueIntrinsic(Value *V, uint64_t Offset,
Devang Patelfe58f952010-12-07 23:25:47 +00001148 DIVariable VarInfo,
1149 Instruction *InsertBefore) {
1150 assert(V && "no value passed to dbg.value");
1151 assert(VarInfo.Verify() && "invalid DIVariable passed to dbg.value");
1152 if (!ValueFn)
1153 ValueFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_value);
1154
Jay Foadec9186b2011-04-21 19:59:31 +00001155 Value *Args[] = { MDNode::get(V->getContext(), V),
Devang Patelfe58f952010-12-07 23:25:47 +00001156 ConstantInt::get(Type::getInt64Ty(V->getContext()), Offset),
1157 VarInfo };
Jay Foada3efbb12011-07-15 08:37:34 +00001158 return CallInst::Create(ValueFn, Args, "", InsertBefore);
Devang Patelfe58f952010-12-07 23:25:47 +00001159}
1160
Devang Patel50d280c2011-02-22 18:56:12 +00001161/// insertDbgValueIntrinsic - Insert a new llvm.dbg.value intrinsic call.
1162Instruction *DIBuilder::insertDbgValueIntrinsic(Value *V, uint64_t Offset,
Devang Patelfe58f952010-12-07 23:25:47 +00001163 DIVariable VarInfo,
1164 BasicBlock *InsertAtEnd) {
1165 assert(V && "no value passed to dbg.value");
1166 assert(VarInfo.Verify() && "invalid DIVariable passed to dbg.value");
1167 if (!ValueFn)
1168 ValueFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_value);
1169
Jay Foadec9186b2011-04-21 19:59:31 +00001170 Value *Args[] = { MDNode::get(V->getContext(), V),
Devang Patelfe58f952010-12-07 23:25:47 +00001171 ConstantInt::get(Type::getInt64Ty(V->getContext()), Offset),
1172 VarInfo };
Jay Foada3efbb12011-07-15 08:37:34 +00001173 return CallInst::Create(ValueFn, Args, "", InsertAtEnd);
Devang Patelfe58f952010-12-07 23:25:47 +00001174}