blob: 1c799452754e97caf4743cc724efc0f367a5f1e3 [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.
212DIType DIBuilder::createNullPtrType(StringRef Name) {
213 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 };
David Blaikie72dfb052013-03-28 02:44:59 +0000228 return DIType(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'.
353DIType 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 };
David Blaikie72dfb052013-03-28 02:44:59 +0000369 return DIType(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.
416DIType DIBuilder::createStaticMemberType(DIDescriptor Scope, StringRef Name,
417 DIFile File, unsigned LineNumber,
418 DIType Ty, unsigned Flags,
419 llvm::Value *Val) {
420 // TAG_member is encoded in DIDerivedType format.
421 Flags |= DIDescriptor::FlagStaticMember;
422 Value *Elts[] = {
423 GetTagConstant(VMContext, dwarf::DW_TAG_member),
David Blaikie4776bce2013-03-20 00:26:26 +0000424 File.getFileNode(),
Eric Christopher6b6061f2013-01-16 01:22:23 +0000425 getNonCompileUnitScope(Scope),
426 MDString::get(VMContext, Name),
Eric Christopher6b6061f2013-01-16 01:22:23 +0000427 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
428 ConstantInt::get(Type::getInt64Ty(VMContext), 0/*SizeInBits*/),
429 ConstantInt::get(Type::getInt64Ty(VMContext), 0/*AlignInBits*/),
430 ConstantInt::get(Type::getInt64Ty(VMContext), 0/*OffsetInBits*/),
431 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
432 Ty,
433 Val
434 };
David Blaikie72dfb052013-03-28 02:44:59 +0000435 return DIType(MDNode::get(VMContext, Elts));
Eric Christopher6b6061f2013-01-16 01:22:23 +0000436}
437
Devang Patele9db5e22011-04-16 00:11:51 +0000438/// createObjCIVar - Create debugging information entry for Objective-C
439/// instance variable.
Eric Christopher6c0046f2011-08-26 21:02:40 +0000440DIType DIBuilder::createObjCIVar(StringRef Name,
441 DIFile File, unsigned LineNumber,
Devang Patele9db5e22011-04-16 00:11:51 +0000442 uint64_t SizeInBits, uint64_t AlignInBits,
Eric Christopher6c0046f2011-08-26 21:02:40 +0000443 uint64_t OffsetInBits, unsigned Flags,
Devang Patele9db5e22011-04-16 00:11:51 +0000444 DIType Ty, StringRef PropertyName,
445 StringRef GetterName, StringRef SetterName,
446 unsigned PropertyAttributes) {
447 // TAG_member is encoded in DIDerivedType format.
448 Value *Elts[] = {
449 GetTagConstant(VMContext, dwarf::DW_TAG_member),
David Blaikie4776bce2013-03-20 00:26:26 +0000450 File.getFileNode(),
Devang Patel94c7ddb2011-08-16 22:09:43 +0000451 getNonCompileUnitScope(File),
Devang Patele9db5e22011-04-16 00:11:51 +0000452 MDString::get(VMContext, Name),
Devang Patele9db5e22011-04-16 00:11:51 +0000453 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
454 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
455 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
456 ConstantInt::get(Type::getInt64Ty(VMContext), OffsetInBits),
457 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
458 Ty,
459 MDString::get(VMContext, PropertyName),
460 MDString::get(VMContext, GetterName),
461 MDString::get(VMContext, SetterName),
462 ConstantInt::get(Type::getInt32Ty(VMContext), PropertyAttributes)
463 };
David Blaikie72dfb052013-03-28 02:44:59 +0000464 return DIType(MDNode::get(VMContext, Elts));
Devang Patele9db5e22011-04-16 00:11:51 +0000465}
466
Devang Patel6588abf2012-02-06 17:49:43 +0000467/// createObjCIVar - Create debugging information entry for Objective-C
468/// instance variable.
469DIType DIBuilder::createObjCIVar(StringRef Name,
470 DIFile File, unsigned LineNumber,
471 uint64_t SizeInBits, uint64_t AlignInBits,
472 uint64_t OffsetInBits, unsigned Flags,
473 DIType Ty, MDNode *PropertyNode) {
474 // TAG_member is encoded in DIDerivedType format.
475 Value *Elts[] = {
476 GetTagConstant(VMContext, dwarf::DW_TAG_member),
David Blaikie4776bce2013-03-20 00:26:26 +0000477 File.getFileNode(),
Devang Patel6588abf2012-02-06 17:49:43 +0000478 getNonCompileUnitScope(File),
479 MDString::get(VMContext, Name),
Devang Patel6588abf2012-02-06 17:49:43 +0000480 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
481 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
482 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
483 ConstantInt::get(Type::getInt64Ty(VMContext), OffsetInBits),
484 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
485 Ty,
486 PropertyNode
487 };
David Blaikie72dfb052013-03-28 02:44:59 +0000488 return DIType(MDNode::get(VMContext, Elts));
Devang Patel6588abf2012-02-06 17:49:43 +0000489}
490
Devang Patel1ea02d42012-02-04 00:59:25 +0000491/// createObjCProperty - Create debugging information entry for Objective-C
492/// property.
Eric Christopherb8ca9882012-03-29 08:42:56 +0000493DIObjCProperty DIBuilder::createObjCProperty(StringRef Name,
Eric Christopher87c06a82012-07-06 02:35:57 +0000494 DIFile File, unsigned LineNumber,
Devang Patel1ea02d42012-02-04 00:59:25 +0000495 StringRef GetterName,
Adrian Prantl2f445be2013-04-19 19:56:02 +0000496 StringRef SetterName,
Eric Christopherb8ca9882012-03-29 08:42:56 +0000497 unsigned PropertyAttributes,
Eric Christopher87c06a82012-07-06 02:35:57 +0000498 DIType Ty) {
Devang Patel1ea02d42012-02-04 00:59:25 +0000499 Value *Elts[] = {
Eric Christopher6c31ee22012-03-29 21:35:05 +0000500 GetTagConstant(VMContext, dwarf::DW_TAG_APPLE_property),
Devang Patel1ea02d42012-02-04 00:59:25 +0000501 MDString::get(VMContext, Name),
Eric Christopherb8ca9882012-03-29 08:42:56 +0000502 File,
503 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
Devang Patel1ea02d42012-02-04 00:59:25 +0000504 MDString::get(VMContext, GetterName),
505 MDString::get(VMContext, SetterName),
Eric Christopherb8ca9882012-03-29 08:42:56 +0000506 ConstantInt::get(Type::getInt32Ty(VMContext), PropertyAttributes),
507 Ty
Devang Patel1ea02d42012-02-04 00:59:25 +0000508 };
David Blaikie72dfb052013-03-28 02:44:59 +0000509 return DIObjCProperty(MDNode::get(VMContext, Elts));
Devang Patel1ea02d42012-02-04 00:59:25 +0000510}
511
Devang Patel50d280c2011-02-22 18:56:12 +0000512/// createTemplateTypeParameter - Create debugging information for template
Devang Patel7e2cb112011-02-02 21:38:25 +0000513/// type parameter.
Eric Christopher6c0046f2011-08-26 21:02:40 +0000514DITemplateTypeParameter
Devang Patel50d280c2011-02-22 18:56:12 +0000515DIBuilder::createTemplateTypeParameter(DIDescriptor Context, StringRef Name,
Devang Patel7e2cb112011-02-02 21:38:25 +0000516 DIType Ty, MDNode *File, unsigned LineNo,
517 unsigned ColumnNo) {
518 Value *Elts[] = {
519 GetTagConstant(VMContext, dwarf::DW_TAG_template_type_parameter),
Devang Patel94c7ddb2011-08-16 22:09:43 +0000520 getNonCompileUnitScope(Context),
Devang Patel7e2cb112011-02-02 21:38:25 +0000521 MDString::get(VMContext, Name),
522 Ty,
523 File,
524 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
525 ConstantInt::get(Type::getInt32Ty(VMContext), ColumnNo)
526 };
David Blaikie72dfb052013-03-28 02:44:59 +0000527 return DITemplateTypeParameter(MDNode::get(VMContext, Elts));
Devang Patel7e2cb112011-02-02 21:38:25 +0000528}
529
Devang Patel50d280c2011-02-22 18:56:12 +0000530/// createTemplateValueParameter - Create debugging information for template
Devang Patele7d93872011-02-02 22:35:53 +0000531/// value parameter.
Eric Christopher6c0046f2011-08-26 21:02:40 +0000532DITemplateValueParameter
Devang Patel50d280c2011-02-22 18:56:12 +0000533DIBuilder::createTemplateValueParameter(DIDescriptor Context, StringRef Name,
David Blaikie4de9d722013-05-10 21:52:07 +0000534 DIType Ty, Value *Val,
Devang Patele7d93872011-02-02 22:35:53 +0000535 MDNode *File, unsigned LineNo,
536 unsigned ColumnNo) {
537 Value *Elts[] = {
538 GetTagConstant(VMContext, dwarf::DW_TAG_template_value_parameter),
Devang Patel94c7ddb2011-08-16 22:09:43 +0000539 getNonCompileUnitScope(Context),
Devang Patele7d93872011-02-02 22:35:53 +0000540 MDString::get(VMContext, Name),
541 Ty,
David Blaikie4de9d722013-05-10 21:52:07 +0000542 Val,
Devang Patele7d93872011-02-02 22:35:53 +0000543 File,
544 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
545 ConstantInt::get(Type::getInt32Ty(VMContext), ColumnNo)
546 };
David Blaikie72dfb052013-03-28 02:44:59 +0000547 return DITemplateValueParameter(MDNode::get(VMContext, Elts));
Devang Patele7d93872011-02-02 22:35:53 +0000548}
549
Eric Christopher87c06a82012-07-06 02:35:57 +0000550/// createClassType - Create debugging information entry for a class.
David Blaikieca442a42013-03-26 23:46:39 +0000551DICompositeType DIBuilder::createClassType(DIDescriptor Context, StringRef Name,
552 DIFile File, unsigned LineNumber,
553 uint64_t SizeInBits,
554 uint64_t AlignInBits,
555 uint64_t OffsetInBits,
556 unsigned Flags, DIType DerivedFrom,
557 DIArray Elements,
558 MDNode *VTableHolder,
559 MDNode *TemplateParams) {
David Blaikie66438682013-03-11 23:21:19 +0000560 assert((!Context || Context.Verify()) &&
561 "createClassType should be called with a valid Context");
562 // TAG_class_type is encoded in DICompositeType format.
Eric Christopher87c06a82012-07-06 02:35:57 +0000563 Value *Elts[] = {
564 GetTagConstant(VMContext, dwarf::DW_TAG_class_type),
David Blaikie4776bce2013-03-20 00:26:26 +0000565 File.getFileNode(),
Eric Christopher87c06a82012-07-06 02:35:57 +0000566 getNonCompileUnitScope(Context),
567 MDString::get(VMContext, Name),
Eric Christopher87c06a82012-07-06 02:35:57 +0000568 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
569 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
570 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
571 ConstantInt::get(Type::getInt32Ty(VMContext), OffsetInBits),
572 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
573 DerivedFrom,
574 Elements,
575 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
576 VTableHolder,
577 TemplateParams
578 };
David Blaikieca442a42013-03-26 23:46:39 +0000579 DICompositeType R(MDNode::get(VMContext, Elts));
David Blaikie66438682013-03-11 23:21:19 +0000580 assert(R.Verify() && "createClassType should return a verifiable DIType");
581 return R;
Eric Christopher87c06a82012-07-06 02:35:57 +0000582}
583
Devang Patel50d280c2011-02-22 18:56:12 +0000584/// createStructType - Create debugging information entry for a struct.
David Blaikie6172f022013-02-25 01:07:18 +0000585DICompositeType DIBuilder::createStructType(DIDescriptor Context,
586 StringRef Name, DIFile File,
587 unsigned LineNumber,
588 uint64_t SizeInBits,
589 uint64_t AlignInBits,
590 unsigned Flags, DIType DerivedFrom,
591 DIArray Elements,
592 unsigned RunTimeLang,
593 MDNode *VTableHolder) {
Devang Patelfe58f952010-12-07 23:25:47 +0000594 // TAG_structure_type is encoded in DICompositeType format.
595 Value *Elts[] = {
596 GetTagConstant(VMContext, dwarf::DW_TAG_structure_type),
David Blaikie4776bce2013-03-20 00:26:26 +0000597 File.getFileNode(),
Devang Patel94c7ddb2011-08-16 22:09:43 +0000598 getNonCompileUnitScope(Context),
Devang Patelfe58f952010-12-07 23:25:47 +0000599 MDString::get(VMContext, Name),
Devang Patelfe58f952010-12-07 23:25:47 +0000600 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
601 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
602 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
Devang Patel43c249c2010-12-08 01:50:15 +0000603 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
Devang Patelfe58f952010-12-07 23:25:47 +0000604 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
David Blaikie6172f022013-02-25 01:07:18 +0000605 DerivedFrom,
Devang Patelfe58f952010-12-07 23:25:47 +0000606 Elements,
607 ConstantInt::get(Type::getInt32Ty(VMContext), RunTimeLang),
David Blaikie6172f022013-02-25 01:07:18 +0000608 VTableHolder,
David Blaikied4f92fd2013-02-18 07:27:30 +0000609 NULL,
Devang Patelfe58f952010-12-07 23:25:47 +0000610 };
David Blaikie66438682013-03-11 23:21:19 +0000611 DICompositeType R(MDNode::get(VMContext, Elts));
612 assert(R.Verify() && "createStructType should return a verifiable DIType");
613 return R;
Devang Patelfe58f952010-12-07 23:25:47 +0000614}
615
Devang Patel50d280c2011-02-22 18:56:12 +0000616/// createUnionType - Create debugging information entry for an union.
Eric Christophercf0623b2013-04-02 22:55:52 +0000617DICompositeType DIBuilder::createUnionType(DIDescriptor Scope, StringRef Name,
618 DIFile File, unsigned LineNumber,
619 uint64_t SizeInBits,
620 uint64_t AlignInBits, unsigned Flags,
621 DIArray Elements,
622 unsigned RunTimeLang) {
Devang Patel43c249c2010-12-08 01:50:15 +0000623 // TAG_union_type is encoded in DICompositeType format.
624 Value *Elts[] = {
625 GetTagConstant(VMContext, dwarf::DW_TAG_union_type),
David Blaikie4776bce2013-03-20 00:26:26 +0000626 File.getFileNode(),
Devang Patel94c7ddb2011-08-16 22:09:43 +0000627 getNonCompileUnitScope(Scope),
Devang Patel43c249c2010-12-08 01:50:15 +0000628 MDString::get(VMContext, Name),
Devang Patel43c249c2010-12-08 01:50:15 +0000629 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
630 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
631 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
632 ConstantInt::get(Type::getInt64Ty(VMContext), 0),
633 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
Devang Patelc104cf22011-12-16 17:51:31 +0000634 NULL,
Devang Patel43c249c2010-12-08 01:50:15 +0000635 Elements,
636 ConstantInt::get(Type::getInt32Ty(VMContext), RunTimeLang),
Eric Christopherc656fda2013-04-02 22:55:56 +0000637 Constant::getNullValue(Type::getInt32Ty(VMContext)),
638 NULL
Devang Patel43c249c2010-12-08 01:50:15 +0000639 };
David Blaikie72dfb052013-03-28 02:44:59 +0000640 return DICompositeType(MDNode::get(VMContext, Elts));
Devang Patel43c249c2010-12-08 01:50:15 +0000641}
642
Devang Patel50d280c2011-02-22 18:56:12 +0000643/// createSubroutineType - Create subroutine type.
David Blaikied67c5ca2013-02-18 06:41:57 +0000644DICompositeType
645DIBuilder::createSubroutineType(DIFile File, DIArray ParameterTypes) {
Devang Patel43c249c2010-12-08 01:50:15 +0000646 // TAG_subroutine_type is encoded in DICompositeType format.
647 Value *Elts[] = {
648 GetTagConstant(VMContext, dwarf::DW_TAG_subroutine_type),
Bill Wendlingf46b4972012-07-06 17:47:36 +0000649 Constant::getNullValue(Type::getInt32Ty(VMContext)),
Bill Wendlingf46b4972012-07-06 17:47:36 +0000650 Constant::getNullValue(Type::getInt32Ty(VMContext)),
David Blaikiea13f3cd2013-03-19 23:25:22 +0000651 MDString::get(VMContext, ""),
Devang Patel43c249c2010-12-08 01:50:15 +0000652 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
653 ConstantInt::get(Type::getInt64Ty(VMContext), 0),
654 ConstantInt::get(Type::getInt64Ty(VMContext), 0),
Devang Patelc104cf22011-12-16 17:51:31 +0000655 ConstantInt::get(Type::getInt64Ty(VMContext), 0),
Devang Patel43c249c2010-12-08 01:50:15 +0000656 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
Devang Patelc104cf22011-12-16 17:51:31 +0000657 NULL,
Devang Patel43c249c2010-12-08 01:50:15 +0000658 ParameterTypes,
659 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
Bill Wendling9fdb7c02012-07-06 17:49:19 +0000660 Constant::getNullValue(Type::getInt32Ty(VMContext))
Devang Patel43c249c2010-12-08 01:50:15 +0000661 };
David Blaikie72dfb052013-03-28 02:44:59 +0000662 return DICompositeType(MDNode::get(VMContext, Elts));
Devang Patel43c249c2010-12-08 01:50:15 +0000663}
664
Eric Christopher6c0046f2011-08-26 21:02:40 +0000665/// createEnumerationType - Create debugging information entry for an
Devang Patel43c249c2010-12-08 01:50:15 +0000666/// enumeration.
David Blaikied67c5ca2013-02-18 06:41:57 +0000667DICompositeType DIBuilder::createEnumerationType(
668 DIDescriptor Scope, StringRef Name, DIFile File, unsigned LineNumber,
669 uint64_t SizeInBits, uint64_t AlignInBits, DIArray Elements,
Adrian Prantl2f445be2013-04-19 19:56:02 +0000670 DIType UnderlyingType) {
Devang Patel43c249c2010-12-08 01:50:15 +0000671 // TAG_enumeration_type is encoded in DICompositeType format.
672 Value *Elts[] = {
673 GetTagConstant(VMContext, dwarf::DW_TAG_enumeration_type),
David Blaikie4776bce2013-03-20 00:26:26 +0000674 File.getFileNode(),
Devang Patel94c7ddb2011-08-16 22:09:43 +0000675 getNonCompileUnitScope(Scope),
Devang Patel43c249c2010-12-08 01:50:15 +0000676 MDString::get(VMContext, Name),
Devang Patel43c249c2010-12-08 01:50:15 +0000677 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
678 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
679 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
680 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
Eli Friedmance3da6f2012-10-05 01:49:14 +0000681 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
Adrian Prantl2f445be2013-04-19 19:56:02 +0000682 UnderlyingType,
Devang Patel43c249c2010-12-08 01:50:15 +0000683 Elements,
684 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
Bill Wendling9fdb7c02012-07-06 17:49:19 +0000685 Constant::getNullValue(Type::getInt32Ty(VMContext))
Devang Patel43c249c2010-12-08 01:50:15 +0000686 };
Devang Patel1f48a952011-04-18 23:51:03 +0000687 MDNode *Node = MDNode::get(VMContext, Elts);
Devang Patel94c7ddb2011-08-16 22:09:43 +0000688 AllEnumTypes.push_back(Node);
David Blaikie72dfb052013-03-28 02:44:59 +0000689 return DICompositeType(Node);
Devang Patel43c249c2010-12-08 01:50:15 +0000690}
691
Devang Patel50d280c2011-02-22 18:56:12 +0000692/// createArrayType - Create debugging information entry for an array.
David Blaikied67c5ca2013-02-18 06:41:57 +0000693DICompositeType DIBuilder::createArrayType(uint64_t Size, uint64_t AlignInBits,
694 DIType Ty, DIArray Subscripts) {
Devang Patel43c249c2010-12-08 01:50:15 +0000695 // TAG_array_type is encoded in DICompositeType format.
696 Value *Elts[] = {
697 GetTagConstant(VMContext, dwarf::DW_TAG_array_type),
David Blaikiea13f3cd2013-03-19 23:25:22 +0000698 NULL, // Filename/Directory,
Devang Patel94c7ddb2011-08-16 22:09:43 +0000699 NULL, //TheCU,
Devang Patel43c249c2010-12-08 01:50:15 +0000700 MDString::get(VMContext, ""),
Devang Patel43c249c2010-12-08 01:50:15 +0000701 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
702 ConstantInt::get(Type::getInt64Ty(VMContext), Size),
703 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
704 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
705 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
706 Ty,
707 Subscripts,
708 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
Bill Wendling9fdb7c02012-07-06 17:49:19 +0000709 Constant::getNullValue(Type::getInt32Ty(VMContext))
Devang Patel43c249c2010-12-08 01:50:15 +0000710 };
David Blaikie72dfb052013-03-28 02:44:59 +0000711 return DICompositeType(MDNode::get(VMContext, Elts));
Devang Patel43c249c2010-12-08 01:50:15 +0000712}
713
Devang Patel50d280c2011-02-22 18:56:12 +0000714/// createVectorType - Create debugging information entry for a vector.
Eric Christopher6c0046f2011-08-26 21:02:40 +0000715DIType DIBuilder::createVectorType(uint64_t Size, uint64_t AlignInBits,
Devang Patel43c249c2010-12-08 01:50:15 +0000716 DIType Ty, DIArray Subscripts) {
Eric Christopher9a1e0e22013-01-08 01:53:52 +0000717
718 // A vector is an array type with the FlagVector flag applied.
Devang Patel43c249c2010-12-08 01:50:15 +0000719 Value *Elts[] = {
Eric Christopher9a1e0e22013-01-08 01:53:52 +0000720 GetTagConstant(VMContext, dwarf::DW_TAG_array_type),
David Blaikiea13f3cd2013-03-19 23:25:22 +0000721 NULL, // Filename/Directory,
Devang Patel94c7ddb2011-08-16 22:09:43 +0000722 NULL, //TheCU,
Devang Patel43c249c2010-12-08 01:50:15 +0000723 MDString::get(VMContext, ""),
Devang Patel43c249c2010-12-08 01:50:15 +0000724 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
725 ConstantInt::get(Type::getInt64Ty(VMContext), Size),
726 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
727 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
Eric Christopher9a1e0e22013-01-08 01:53:52 +0000728 ConstantInt::get(Type::getInt32Ty(VMContext), DIType::FlagVector),
Devang Patel43c249c2010-12-08 01:50:15 +0000729 Ty,
730 Subscripts,
731 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
Bill Wendling9fdb7c02012-07-06 17:49:19 +0000732 Constant::getNullValue(Type::getInt32Ty(VMContext))
Devang Patel43c249c2010-12-08 01:50:15 +0000733 };
David Blaikie72dfb052013-03-28 02:44:59 +0000734 return DIType(MDNode::get(VMContext, Elts));
Devang Patel43c249c2010-12-08 01:50:15 +0000735}
Devang Patelfe58f952010-12-07 23:25:47 +0000736
Devang Patel50d280c2011-02-22 18:56:12 +0000737/// createArtificialType - Create a new DIType with "artificial" flag set.
738DIType DIBuilder::createArtificialType(DIType Ty) {
Devang Patel35fcd652010-11-04 15:01:38 +0000739 if (Ty.isArtificial())
740 return Ty;
741
742 SmallVector<Value *, 9> Elts;
743 MDNode *N = Ty;
744 assert (N && "Unexpected input DIType!");
745 for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i) {
746 if (Value *V = N->getOperand(i))
747 Elts.push_back(V);
748 else
749 Elts.push_back(Constant::getNullValue(Type::getInt32Ty(VMContext)));
750 }
751
752 unsigned CurFlags = Ty.getFlags();
753 CurFlags = CurFlags | DIType::FlagArtificial;
754
755 // Flags are stored at this slot.
David Blaikie72dfb052013-03-28 02:44:59 +0000756 Elts[8] = ConstantInt::get(Type::getInt32Ty(VMContext), CurFlags);
Devang Patel35fcd652010-11-04 15:01:38 +0000757
David Blaikie72dfb052013-03-28 02:44:59 +0000758 return DIType(MDNode::get(VMContext, Elts));
Devang Patel35fcd652010-11-04 15:01:38 +0000759}
Devang Patelfe58f952010-12-07 23:25:47 +0000760
Eric Christopher1f55eb42013-01-08 01:53:42 +0000761/// createObjectPointerType - Create a new type with both the object pointer
762/// and artificial flags set.
Eric Christophere5212782012-09-12 23:36:19 +0000763DIType DIBuilder::createObjectPointerType(DIType Ty) {
764 if (Ty.isObjectPointer())
765 return Ty;
766
767 SmallVector<Value *, 9> Elts;
768 MDNode *N = Ty;
769 assert (N && "Unexpected input DIType!");
770 for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i) {
771 if (Value *V = N->getOperand(i))
772 Elts.push_back(V);
773 else
774 Elts.push_back(Constant::getNullValue(Type::getInt32Ty(VMContext)));
775 }
776
777 unsigned CurFlags = Ty.getFlags();
778 CurFlags = CurFlags | (DIType::FlagObjectPointer | DIType::FlagArtificial);
779
780 // Flags are stored at this slot.
David Blaikie72dfb052013-03-28 02:44:59 +0000781 Elts[8] = ConstantInt::get(Type::getInt32Ty(VMContext), CurFlags);
Eric Christophere5212782012-09-12 23:36:19 +0000782
David Blaikie72dfb052013-03-28 02:44:59 +0000783 return DIType(MDNode::get(VMContext, Elts));
Eric Christophere5212782012-09-12 23:36:19 +0000784}
785
Eric Christopher6c0046f2011-08-26 21:02:40 +0000786/// retainType - Retain DIType in a module even if it is not referenced
Devang Patel43c249c2010-12-08 01:50:15 +0000787/// through debug info anchors.
Devang Patel50d280c2011-02-22 18:56:12 +0000788void DIBuilder::retainType(DIType T) {
Devang Patel94c7ddb2011-08-16 22:09:43 +0000789 AllRetainTypes.push_back(T);
Devang Patel43c249c2010-12-08 01:50:15 +0000790}
791
Devang Patel50d280c2011-02-22 18:56:12 +0000792/// createUnspecifiedParameter - Create unspeicified type descriptor
Devang Patel43c249c2010-12-08 01:50:15 +0000793/// for the subroutine type.
Devang Patel50d280c2011-02-22 18:56:12 +0000794DIDescriptor DIBuilder::createUnspecifiedParameter() {
Eric Christopher6c0046f2011-08-26 21:02:40 +0000795 Value *Elts[] = {
796 GetTagConstant(VMContext, dwarf::DW_TAG_unspecified_parameters)
Devang Patel43c249c2010-12-08 01:50:15 +0000797 };
Devang Patel1f48a952011-04-18 23:51:03 +0000798 return DIDescriptor(MDNode::get(VMContext, Elts));
Devang Patel43c249c2010-12-08 01:50:15 +0000799}
800
Eric Christopher4fe34572012-02-08 00:22:26 +0000801/// createForwardDecl - Create a temporary forward-declared type that
802/// can be RAUW'd if the full type is seen.
Eric Christopher216432d2012-04-23 19:00:11 +0000803DIType DIBuilder::createForwardDecl(unsigned Tag, StringRef Name,
804 DIDescriptor Scope, DIFile F,
Eli Friedmance3da6f2012-10-05 01:49:14 +0000805 unsigned Line, unsigned RuntimeLang,
806 uint64_t SizeInBits,
807 uint64_t AlignInBits) {
Eric Christopher4fe34572012-02-08 00:22:26 +0000808 // Create a temporary MDNode.
809 Value *Elts[] = {
810 GetTagConstant(VMContext, Tag),
David Blaikie4776bce2013-03-20 00:26:26 +0000811 F.getFileNode(),
Eric Christopher216432d2012-04-23 19:00:11 +0000812 getNonCompileUnitScope(Scope),
Eric Christopher4fe34572012-02-08 00:22:26 +0000813 MDString::get(VMContext, Name),
Eric Christopher4fe34572012-02-08 00:22:26 +0000814 ConstantInt::get(Type::getInt32Ty(VMContext), Line),
Eli Friedmance3da6f2012-10-05 01:49:14 +0000815 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
816 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
Eric Christopher4fe34572012-02-08 00:22:26 +0000817 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
818 ConstantInt::get(Type::getInt32Ty(VMContext),
Eric Christopher9f90e872012-02-20 18:04:14 +0000819 DIDescriptor::FlagFwdDecl),
820 NULL,
821 DIArray(),
822 ConstantInt::get(Type::getInt32Ty(VMContext), RuntimeLang)
Eric Christopher4fe34572012-02-08 00:22:26 +0000823 };
824 MDNode *Node = MDNode::getTemporary(VMContext, Elts);
David Blaikie66438682013-03-11 23:21:19 +0000825 assert(DIType(Node).Verify() &&
826 "createForwardDecl result should be verifiable");
Eric Christopher4fe34572012-02-08 00:22:26 +0000827 return DIType(Node);
828}
829
Devang Patel50d280c2011-02-22 18:56:12 +0000830/// getOrCreateArray - Get a DIArray, create one if required.
Jay Foad68550182011-04-24 10:11:03 +0000831DIArray DIBuilder::getOrCreateArray(ArrayRef<Value *> Elements) {
832 if (Elements.empty()) {
Bill Wendlingf46b4972012-07-06 17:47:36 +0000833 Value *Null = Constant::getNullValue(Type::getInt32Ty(VMContext));
Jay Foadec9186b2011-04-21 19:59:31 +0000834 return DIArray(MDNode::get(VMContext, Null));
Devang Patelfe58f952010-12-07 23:25:47 +0000835 }
Jay Foad68550182011-04-24 10:11:03 +0000836 return DIArray(MDNode::get(VMContext, Elements));
Devang Patelfe58f952010-12-07 23:25:47 +0000837}
838
Devang Patel50d280c2011-02-22 18:56:12 +0000839/// getOrCreateSubrange - Create a descriptor for a value range. This
Devang Patel43c249c2010-12-08 01:50:15 +0000840/// implicitly uniques the values returned.
Bill Wendling9493dae2012-12-04 21:34:03 +0000841DISubrange DIBuilder::getOrCreateSubrange(int64_t Lo, int64_t Count) {
Devang Patel43c249c2010-12-08 01:50:15 +0000842 Value *Elts[] = {
843 GetTagConstant(VMContext, dwarf::DW_TAG_subrange_type),
844 ConstantInt::get(Type::getInt64Ty(VMContext), Lo),
Bill Wendlinga7645a32012-12-04 06:20:49 +0000845 ConstantInt::get(Type::getInt64Ty(VMContext), Count)
Devang Patel43c249c2010-12-08 01:50:15 +0000846 };
847
Devang Patel1f48a952011-04-18 23:51:03 +0000848 return DISubrange(MDNode::get(VMContext, Elts));
Devang Patel43c249c2010-12-08 01:50:15 +0000849}
850
David Blaikie3fac43d2013-03-20 17:49:48 +0000851/// \brief Create a new descriptor for the specified global.
Devang Patelfe58f952010-12-07 23:25:47 +0000852DIGlobalVariable DIBuilder::
David Blaikie3fac43d2013-03-20 17:49:48 +0000853createGlobalVariable(StringRef Name, StringRef LinkageName, DIFile F,
854 unsigned LineNumber, DIType Ty, bool isLocalToUnit,
855 Value *Val) {
Devang Patelfe58f952010-12-07 23:25:47 +0000856 Value *Elts[] = {
857 GetTagConstant(VMContext, dwarf::DW_TAG_variable),
Bill Wendlingf46b4972012-07-06 17:47:36 +0000858 Constant::getNullValue(Type::getInt32Ty(VMContext)),
Devang Patel94c7ddb2011-08-16 22:09:43 +0000859 NULL, // TheCU,
Devang Patelfe58f952010-12-07 23:25:47 +0000860 MDString::get(VMContext, Name),
861 MDString::get(VMContext, Name),
David Blaikie3fac43d2013-03-20 17:49:48 +0000862 MDString::get(VMContext, LinkageName),
Devang Patelfe58f952010-12-07 23:25:47 +0000863 F,
864 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
865 Ty,
866 ConstantInt::get(Type::getInt32Ty(VMContext), isLocalToUnit),
867 ConstantInt::get(Type::getInt32Ty(VMContext), 1), /* isDefinition*/
Eric Christopher6b6061f2013-01-16 01:22:23 +0000868 Val,
869 DIDescriptor()
Devang Patelfe58f952010-12-07 23:25:47 +0000870 };
Devang Patel1f48a952011-04-18 23:51:03 +0000871 MDNode *Node = MDNode::get(VMContext, Elts);
Devang Patel94c7ddb2011-08-16 22:09:43 +0000872 AllGVs.push_back(Node);
Devang Patelfe58f952010-12-07 23:25:47 +0000873 return DIGlobalVariable(Node);
874}
875
David Blaikie3fac43d2013-03-20 17:49:48 +0000876/// \brief Create a new descriptor for the specified global.
877DIGlobalVariable DIBuilder::
878createGlobalVariable(StringRef Name, DIFile F, unsigned LineNumber,
879 DIType Ty, bool isLocalToUnit, Value *Val) {
880 return createGlobalVariable(Name, Name, F, LineNumber, Ty, isLocalToUnit,
881 Val);
882}
883
Devang Patel50d280c2011-02-22 18:56:12 +0000884/// createStaticVariable - Create a new descriptor for the specified static
Devang Patelfe58f952010-12-07 23:25:47 +0000885/// variable.
886DIGlobalVariable DIBuilder::
Eric Christopher6c0046f2011-08-26 21:02:40 +0000887createStaticVariable(DIDescriptor Context, StringRef Name,
888 StringRef LinkageName, DIFile F, unsigned LineNumber,
Eric Christopher6b6061f2013-01-16 01:22:23 +0000889 DIType Ty, bool isLocalToUnit, Value *Val, MDNode *Decl) {
Devang Patelfe58f952010-12-07 23:25:47 +0000890 Value *Elts[] = {
891 GetTagConstant(VMContext, dwarf::DW_TAG_variable),
Bill Wendlingf46b4972012-07-06 17:47:36 +0000892 Constant::getNullValue(Type::getInt32Ty(VMContext)),
Devang Patel94c7ddb2011-08-16 22:09:43 +0000893 getNonCompileUnitScope(Context),
Devang Patelfe58f952010-12-07 23:25:47 +0000894 MDString::get(VMContext, Name),
895 MDString::get(VMContext, Name),
896 MDString::get(VMContext, LinkageName),
897 F,
898 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
899 Ty,
900 ConstantInt::get(Type::getInt32Ty(VMContext), isLocalToUnit),
901 ConstantInt::get(Type::getInt32Ty(VMContext), 1), /* isDefinition*/
Eric Christopher6b6061f2013-01-16 01:22:23 +0000902 Val,
903 DIDescriptor(Decl)
Devang Patelfe58f952010-12-07 23:25:47 +0000904 };
Devang Patel1f48a952011-04-18 23:51:03 +0000905 MDNode *Node = MDNode::get(VMContext, Elts);
Devang Patel94c7ddb2011-08-16 22:09:43 +0000906 AllGVs.push_back(Node);
Devang Patelfe58f952010-12-07 23:25:47 +0000907 return DIGlobalVariable(Node);
908}
909
Devang Patel50d280c2011-02-22 18:56:12 +0000910/// createVariable - Create a new descriptor for the specified variable.
911DIVariable DIBuilder::createLocalVariable(unsigned Tag, DIDescriptor Scope,
Devang Patel48f17ba2010-12-07 23:58:00 +0000912 StringRef Name, DIFile File,
Eric Christopher6c0046f2011-08-26 21:02:40 +0000913 unsigned LineNo, DIType Ty,
Devang Patele9e16c52011-03-01 22:58:13 +0000914 bool AlwaysPreserve, unsigned Flags,
915 unsigned ArgNo) {
David Blaikie66438682013-03-11 23:21:19 +0000916 DIDescriptor Context(getNonCompileUnitScope(Scope));
917 assert((!Context || Context.Verify()) &&
918 "createLocalVariable should be called with a valid Context");
919 assert(Ty.Verify() &&
920 "createLocalVariable should be called with a valid type");
Devang Patel48f17ba2010-12-07 23:58:00 +0000921 Value *Elts[] = {
922 GetTagConstant(VMContext, Tag),
Devang Patel94c7ddb2011-08-16 22:09:43 +0000923 getNonCompileUnitScope(Scope),
Devang Patel48f17ba2010-12-07 23:58:00 +0000924 MDString::get(VMContext, Name),
925 File,
Devang Patele9e16c52011-03-01 22:58:13 +0000926 ConstantInt::get(Type::getInt32Ty(VMContext), (LineNo | (ArgNo << 24))),
Devang Patel48f17ba2010-12-07 23:58:00 +0000927 Ty,
Devang Patel23336b42011-07-19 19:41:54 +0000928 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
Bill Wendling9fdb7c02012-07-06 17:49:19 +0000929 Constant::getNullValue(Type::getInt32Ty(VMContext))
Devang Patel48f17ba2010-12-07 23:58:00 +0000930 };
Devang Patel1f48a952011-04-18 23:51:03 +0000931 MDNode *Node = MDNode::get(VMContext, Elts);
Devang Patel48f17ba2010-12-07 23:58:00 +0000932 if (AlwaysPreserve) {
933 // The optimizer may remove local variable. If there is an interest
934 // to preserve variable info in such situation then stash it in a
935 // named mdnode.
936 DISubprogram Fn(getDISubprogram(Scope));
Devang Patel93d39be2011-08-19 23:28:12 +0000937 NamedMDNode *FnLocals = getOrInsertFnSpecificMDNode(M, Fn);
Devang Patel48f17ba2010-12-07 23:58:00 +0000938 FnLocals->addOperand(Node);
939 }
David Blaikie66438682013-03-11 23:21:19 +0000940 assert(DIVariable(Node).Verify() &&
941 "createLocalVariable should return a verifiable DIVariable");
Devang Patel48f17ba2010-12-07 23:58:00 +0000942 return DIVariable(Node);
943}
944
Devang Patel50d280c2011-02-22 18:56:12 +0000945/// createComplexVariable - Create a new descriptor for the specified variable
Devang Patelfe58f952010-12-07 23:25:47 +0000946/// which has a complex address expression for its address.
Devang Patel50d280c2011-02-22 18:56:12 +0000947DIVariable DIBuilder::createComplexVariable(unsigned Tag, DIDescriptor Scope,
Devang Patelfe58f952010-12-07 23:25:47 +0000948 StringRef Name, DIFile F,
949 unsigned LineNo,
Jay Foad68550182011-04-24 10:11:03 +0000950 DIType Ty, ArrayRef<Value *> Addr,
951 unsigned ArgNo) {
Devang Patelfe58f952010-12-07 23:25:47 +0000952 SmallVector<Value *, 15> Elts;
953 Elts.push_back(GetTagConstant(VMContext, Tag));
Devang Patel94c7ddb2011-08-16 22:09:43 +0000954 Elts.push_back(getNonCompileUnitScope(Scope)),
Devang Patelfe58f952010-12-07 23:25:47 +0000955 Elts.push_back(MDString::get(VMContext, Name));
956 Elts.push_back(F);
Eric Christopher6c0046f2011-08-26 21:02:40 +0000957 Elts.push_back(ConstantInt::get(Type::getInt32Ty(VMContext),
Devang Patel9f997212012-02-08 00:17:07 +0000958 (LineNo | (ArgNo << 24))));
Devang Patelfe58f952010-12-07 23:25:47 +0000959 Elts.push_back(Ty);
Bill Wendlingf46b4972012-07-06 17:47:36 +0000960 Elts.push_back(Constant::getNullValue(Type::getInt32Ty(VMContext)));
961 Elts.push_back(Constant::getNullValue(Type::getInt32Ty(VMContext)));
Jay Foad68550182011-04-24 10:11:03 +0000962 Elts.append(Addr.begin(), Addr.end());
Devang Patelfe58f952010-12-07 23:25:47 +0000963
Devang Patel1f48a952011-04-18 23:51:03 +0000964 return DIVariable(MDNode::get(VMContext, Elts));
Devang Patelfe58f952010-12-07 23:25:47 +0000965}
966
Devang Patel50d280c2011-02-22 18:56:12 +0000967/// createFunction - Create a new descriptor for the specified function.
968DISubprogram DIBuilder::createFunction(DIDescriptor Context,
Devang Patel44498a62010-12-08 20:42:44 +0000969 StringRef Name,
970 StringRef LinkageName,
971 DIFile File, unsigned LineNo,
972 DIType Ty,
973 bool isLocalToUnit, bool isDefinition,
Eric Christopher6126a1e2012-04-03 00:43:49 +0000974 unsigned ScopeLine,
Devang Patel44498a62010-12-08 20:42:44 +0000975 unsigned Flags, bool isOptimized,
Devang Patelda194752011-04-05 22:52:06 +0000976 Function *Fn,
Devang Patel5e06bb82011-04-22 23:10:17 +0000977 MDNode *TParams,
978 MDNode *Decl) {
Devang Patel93d39be2011-08-19 23:28:12 +0000979 Value *TElts[] = { GetTagConstant(VMContext, DW_TAG_base_type) };
Devang Patel44498a62010-12-08 20:42:44 +0000980 Value *Elts[] = {
981 GetTagConstant(VMContext, dwarf::DW_TAG_subprogram),
David Blaikiebb4e6192013-03-21 23:08:34 +0000982 File.getFileNode(),
Devang Patel94c7ddb2011-08-16 22:09:43 +0000983 getNonCompileUnitScope(Context),
Devang Patel44498a62010-12-08 20:42:44 +0000984 MDString::get(VMContext, Name),
985 MDString::get(VMContext, Name),
986 MDString::get(VMContext, LinkageName),
Devang Patel44498a62010-12-08 20:42:44 +0000987 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
988 Ty,
989 ConstantInt::get(Type::getInt1Ty(VMContext), isLocalToUnit),
990 ConstantInt::get(Type::getInt1Ty(VMContext), isDefinition),
991 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
992 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
Devang Patel9642c572011-12-15 17:55:56 +0000993 NULL,
Devang Patel44498a62010-12-08 20:42:44 +0000994 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
995 ConstantInt::get(Type::getInt1Ty(VMContext), isOptimized),
Devang Patelda194752011-04-05 22:52:06 +0000996 Fn,
Devang Patel5e06bb82011-04-22 23:10:17 +0000997 TParams,
Devang Patel93d39be2011-08-19 23:28:12 +0000998 Decl,
David Blaikief839eed2013-02-04 05:56:36 +0000999 MDNode::getTemporary(VMContext, TElts),
Eric Christopher6126a1e2012-04-03 00:43:49 +00001000 ConstantInt::get(Type::getInt32Ty(VMContext), ScopeLine)
Devang Patel44498a62010-12-08 20:42:44 +00001001 };
Devang Patel1f48a952011-04-18 23:51:03 +00001002 MDNode *Node = MDNode::get(VMContext, Elts);
Devang Patel44498a62010-12-08 20:42:44 +00001003
1004 // Create a named metadata so that we do not lose this mdnode.
David Blaikie139f7e52013-02-18 07:10:22 +00001005 if (isDefinition)
1006 AllSubprograms.push_back(Node);
David Blaikieebb51832013-03-21 20:28:52 +00001007 DISubprogram S(Node);
1008 assert(S.Verify() && "createFunction should return a valid DISubprogram");
1009 return S;
Devang Patel44498a62010-12-08 20:42:44 +00001010}
1011
Devang Patel50d280c2011-02-22 18:56:12 +00001012/// createMethod - Create a new descriptor for the specified C++ method.
1013DISubprogram DIBuilder::createMethod(DIDescriptor Context,
Devang Patel44498a62010-12-08 20:42:44 +00001014 StringRef Name,
1015 StringRef LinkageName,
1016 DIFile F,
1017 unsigned LineNo, DIType Ty,
1018 bool isLocalToUnit,
1019 bool isDefinition,
1020 unsigned VK, unsigned VIndex,
1021 MDNode *VTableHolder,
1022 unsigned Flags,
1023 bool isOptimized,
Devang Patelda194752011-04-05 22:52:06 +00001024 Function *Fn,
1025 MDNode *TParam) {
Devang Patel93d39be2011-08-19 23:28:12 +00001026 Value *TElts[] = { GetTagConstant(VMContext, DW_TAG_base_type) };
Devang Patel44498a62010-12-08 20:42:44 +00001027 Value *Elts[] = {
1028 GetTagConstant(VMContext, dwarf::DW_TAG_subprogram),
David Blaikiebb4e6192013-03-21 23:08:34 +00001029 F.getFileNode(),
Devang Patel94c7ddb2011-08-16 22:09:43 +00001030 getNonCompileUnitScope(Context),
Devang Patel44498a62010-12-08 20:42:44 +00001031 MDString::get(VMContext, Name),
1032 MDString::get(VMContext, Name),
1033 MDString::get(VMContext, LinkageName),
Devang Patel44498a62010-12-08 20:42:44 +00001034 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
1035 Ty,
1036 ConstantInt::get(Type::getInt1Ty(VMContext), isLocalToUnit),
1037 ConstantInt::get(Type::getInt1Ty(VMContext), isDefinition),
1038 ConstantInt::get(Type::getInt32Ty(VMContext), (unsigned)VK),
1039 ConstantInt::get(Type::getInt32Ty(VMContext), VIndex),
1040 VTableHolder,
1041 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
1042 ConstantInt::get(Type::getInt1Ty(VMContext), isOptimized),
Devang Patelda194752011-04-05 22:52:06 +00001043 Fn,
1044 TParam,
Bill Wendlingf46b4972012-07-06 17:47:36 +00001045 Constant::getNullValue(Type::getInt32Ty(VMContext)),
David Blaikief839eed2013-02-04 05:56:36 +00001046 MDNode::getTemporary(VMContext, TElts),
Eric Christopher25016522012-05-18 00:16:22 +00001047 // FIXME: Do we want to use different scope/lines?
Eric Christopher6126a1e2012-04-03 00:43:49 +00001048 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo)
Devang Patel44498a62010-12-08 20:42:44 +00001049 };
Devang Patel1f48a952011-04-18 23:51:03 +00001050 MDNode *Node = MDNode::get(VMContext, Elts);
David Blaikie139f7e52013-02-18 07:10:22 +00001051 if (isDefinition)
1052 AllSubprograms.push_back(Node);
David Blaikieebb51832013-03-21 20:28:52 +00001053 DISubprogram S(Node);
1054 assert(S.Verify() && "createMethod should return a valid DISubprogram");
1055 return S;
Devang Patel44498a62010-12-08 20:42:44 +00001056}
1057
Devang Patel50d280c2011-02-22 18:56:12 +00001058/// createNameSpace - This creates new descriptor for a namespace
Devang Patelfe58f952010-12-07 23:25:47 +00001059/// with the specified parent scope.
Devang Patel50d280c2011-02-22 18:56:12 +00001060DINameSpace DIBuilder::createNameSpace(DIDescriptor Scope, StringRef Name,
Devang Patelfe58f952010-12-07 23:25:47 +00001061 DIFile File, unsigned LineNo) {
1062 Value *Elts[] = {
1063 GetTagConstant(VMContext, dwarf::DW_TAG_namespace),
David Blaikie6115ed02013-03-20 19:39:15 +00001064 File.getFileNode(),
Devang Patel94c7ddb2011-08-16 22:09:43 +00001065 getNonCompileUnitScope(Scope),
Devang Patelfe58f952010-12-07 23:25:47 +00001066 MDString::get(VMContext, Name),
Devang Patelfe58f952010-12-07 23:25:47 +00001067 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo)
1068 };
David Blaikie66438682013-03-11 23:21:19 +00001069 DINameSpace R(MDNode::get(VMContext, Elts));
1070 assert(R.Verify() &&
1071 "createNameSpace should return a verifiable DINameSpace");
1072 return R;
Devang Patelfe58f952010-12-07 23:25:47 +00001073}
1074
Eric Christopher6618a242011-10-11 22:59:11 +00001075/// createLexicalBlockFile - This creates a new MDNode that encapsulates
1076/// an existing scope with a new filename.
1077DILexicalBlockFile DIBuilder::createLexicalBlockFile(DIDescriptor Scope,
Devang Patel9f997212012-02-08 00:17:07 +00001078 DIFile File) {
Eric Christopher6618a242011-10-11 22:59:11 +00001079 Value *Elts[] = {
1080 GetTagConstant(VMContext, dwarf::DW_TAG_lexical_block),
David Blaikie8faed272013-03-22 20:18:46 +00001081 File.getFileNode(),
David Blaikie7b246862013-03-22 19:13:22 +00001082 Scope
Eric Christopher6618a242011-10-11 22:59:11 +00001083 };
David Blaikie66438682013-03-11 23:21:19 +00001084 DILexicalBlockFile R(MDNode::get(VMContext, Elts));
1085 assert(
1086 R.Verify() &&
1087 "createLexicalBlockFile should return a verifiable DILexicalBlockFile");
1088 return R;
Eric Christopher6618a242011-10-11 22:59:11 +00001089}
1090
Devang Patel50d280c2011-02-22 18:56:12 +00001091DILexicalBlock DIBuilder::createLexicalBlock(DIDescriptor Scope, DIFile File,
Devang Patel43c249c2010-12-08 01:50:15 +00001092 unsigned Line, unsigned Col) {
1093 // Defeat MDNode uniqing for lexical blocks by using unique id.
1094 static unsigned int unique_id = 0;
1095 Value *Elts[] = {
1096 GetTagConstant(VMContext, dwarf::DW_TAG_lexical_block),
David Blaikie4b52a882013-03-22 17:33:20 +00001097 File.getFileNode(),
Devang Patel94c7ddb2011-08-16 22:09:43 +00001098 getNonCompileUnitScope(Scope),
Devang Patel43c249c2010-12-08 01:50:15 +00001099 ConstantInt::get(Type::getInt32Ty(VMContext), Line),
1100 ConstantInt::get(Type::getInt32Ty(VMContext), Col),
Devang Patel43c249c2010-12-08 01:50:15 +00001101 ConstantInt::get(Type::getInt32Ty(VMContext), unique_id++)
1102 };
David Blaikie66438682013-03-11 23:21:19 +00001103 DILexicalBlock R(MDNode::get(VMContext, Elts));
1104 assert(R.Verify() &&
1105 "createLexicalBlock should return a verifiable DILexicalBlock");
1106 return R;
Devang Patel43c249c2010-12-08 01:50:15 +00001107}
1108
Devang Patel50d280c2011-02-22 18:56:12 +00001109/// insertDeclare - Insert a new llvm.dbg.declare intrinsic call.
1110Instruction *DIBuilder::insertDeclare(Value *Storage, DIVariable VarInfo,
Devang Patelfe58f952010-12-07 23:25:47 +00001111 Instruction *InsertBefore) {
1112 assert(Storage && "no storage passed to dbg.declare");
1113 assert(VarInfo.Verify() && "empty DIVariable passed to dbg.declare");
1114 if (!DeclareFn)
1115 DeclareFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_declare);
1116
Jay Foadec9186b2011-04-21 19:59:31 +00001117 Value *Args[] = { MDNode::get(Storage->getContext(), Storage), VarInfo };
Jay Foada3efbb12011-07-15 08:37:34 +00001118 return CallInst::Create(DeclareFn, Args, "", InsertBefore);
Devang Patelfe58f952010-12-07 23:25:47 +00001119}
1120
Devang Patel50d280c2011-02-22 18:56:12 +00001121/// insertDeclare - Insert a new llvm.dbg.declare intrinsic call.
1122Instruction *DIBuilder::insertDeclare(Value *Storage, DIVariable VarInfo,
Devang Patelfe58f952010-12-07 23:25:47 +00001123 BasicBlock *InsertAtEnd) {
1124 assert(Storage && "no storage passed to dbg.declare");
1125 assert(VarInfo.Verify() && "invalid DIVariable passed to dbg.declare");
1126 if (!DeclareFn)
1127 DeclareFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_declare);
1128
Jay Foadec9186b2011-04-21 19:59:31 +00001129 Value *Args[] = { MDNode::get(Storage->getContext(), Storage), VarInfo };
Devang Patelfe58f952010-12-07 23:25:47 +00001130
1131 // If this block already has a terminator then insert this intrinsic
1132 // before the terminator.
1133 if (TerminatorInst *T = InsertAtEnd->getTerminator())
Jay Foada3efbb12011-07-15 08:37:34 +00001134 return CallInst::Create(DeclareFn, Args, "", T);
Devang Patelfe58f952010-12-07 23:25:47 +00001135 else
Jay Foada3efbb12011-07-15 08:37:34 +00001136 return CallInst::Create(DeclareFn, Args, "", InsertAtEnd);
Devang Patelfe58f952010-12-07 23:25:47 +00001137}
1138
Devang Patel50d280c2011-02-22 18:56:12 +00001139/// insertDbgValueIntrinsic - Insert a new llvm.dbg.value intrinsic call.
1140Instruction *DIBuilder::insertDbgValueIntrinsic(Value *V, uint64_t Offset,
Devang Patelfe58f952010-12-07 23:25:47 +00001141 DIVariable VarInfo,
1142 Instruction *InsertBefore) {
1143 assert(V && "no value passed to dbg.value");
1144 assert(VarInfo.Verify() && "invalid DIVariable passed to dbg.value");
1145 if (!ValueFn)
1146 ValueFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_value);
1147
Jay Foadec9186b2011-04-21 19:59:31 +00001148 Value *Args[] = { MDNode::get(V->getContext(), V),
Devang Patelfe58f952010-12-07 23:25:47 +00001149 ConstantInt::get(Type::getInt64Ty(V->getContext()), Offset),
1150 VarInfo };
Jay Foada3efbb12011-07-15 08:37:34 +00001151 return CallInst::Create(ValueFn, Args, "", InsertBefore);
Devang Patelfe58f952010-12-07 23:25:47 +00001152}
1153
Devang Patel50d280c2011-02-22 18:56:12 +00001154/// insertDbgValueIntrinsic - Insert a new llvm.dbg.value intrinsic call.
1155Instruction *DIBuilder::insertDbgValueIntrinsic(Value *V, uint64_t Offset,
Devang Patelfe58f952010-12-07 23:25:47 +00001156 DIVariable VarInfo,
1157 BasicBlock *InsertAtEnd) {
1158 assert(V && "no value passed to dbg.value");
1159 assert(VarInfo.Verify() && "invalid DIVariable passed to dbg.value");
1160 if (!ValueFn)
1161 ValueFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_value);
1162
Jay Foadec9186b2011-04-21 19:59:31 +00001163 Value *Args[] = { MDNode::get(V->getContext(), V),
Devang Patelfe58f952010-12-07 23:25:47 +00001164 ConstantInt::get(Type::getInt64Ty(V->getContext()), Offset),
1165 VarInfo };
Jay Foada3efbb12011-07-15 08:37:34 +00001166 return CallInst::Create(ValueFn, Args, "", InsertAtEnd);
Devang Patelfe58f952010-12-07 23:25:47 +00001167}