1 //===--- DIBuilder.cpp - Debug Information Builder ------------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements the DIBuilder.
12 //===----------------------------------------------------------------------===//
14 #include "llvm/DIBuilder.h"
15 #include "llvm/ADT/STLExtras.h"
16 #include "llvm/DebugInfo.h"
17 #include "llvm/IR/Constants.h"
18 #include "llvm/IR/IntrinsicInst.h"
19 #include "llvm/IR/Module.h"
20 #include "llvm/Support/Debug.h"
21 #include "llvm/Support/Dwarf.h"
24 using namespace llvm::dwarf;
26 static 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);
32 DIBuilder::DIBuilder(Module &m)
33 : M(m), VMContext(M.getContext()), TheCU(0), TempEnumTypes(0),
34 TempRetainTypes(0), TempSubprograms(0), TempGVs(0), DeclareFn(0),
38 /// finalize - Construct any deferred debug info descriptors.
39 void DIBuilder::finalize() {
40 DIArray Enums = getOrCreateArray(AllEnumTypes);
41 DIType(TempEnumTypes).replaceAllUsesWith(Enums);
43 DIArray RetainTypes = getOrCreateArray(AllRetainTypes);
44 DIType(TempRetainTypes).replaceAllUsesWith(RetainTypes);
46 DIArray SPs = getOrCreateArray(AllSubprograms);
47 DIType(TempSubprograms).replaceAllUsesWith(SPs);
48 for (unsigned i = 0, e = SPs.getNumElements(); i != e; ++i) {
49 DISubprogram SP(SPs.getElement(i));
50 SmallVector<Value *, 4> Variables;
51 if (NamedMDNode *NMD = getFnSpecificMDNode(M, SP)) {
52 for (unsigned ii = 0, ee = NMD->getNumOperands(); ii != ee; ++ii)
53 Variables.push_back(NMD->getOperand(ii));
54 NMD->eraseFromParent();
56 if (MDNode *Temp = SP.getVariablesNodes()) {
57 DIArray AV = getOrCreateArray(Variables);
58 DIType(Temp).replaceAllUsesWith(AV);
62 DIArray GVs = getOrCreateArray(AllGVs);
63 DIType(TempGVs).replaceAllUsesWith(GVs);
66 /// getNonCompileUnitScope - If N is compile unit return NULL otherwise return
68 static MDNode *getNonCompileUnitScope(MDNode *N) {
69 if (DIDescriptor(N).isCompileUnit())
74 static MDNode *createFilePathPair(LLVMContext &VMContext, StringRef Filename,
75 StringRef Directory) {
76 assert(!Filename.empty() && "Unable to create file without name");
78 MDString::get(VMContext, Filename),
79 MDString::get(VMContext, Directory),
81 return MDNode::get(VMContext, Pair);
84 /// createCompileUnit - A CompileUnit provides an anchor for all debugging
85 /// information generated during this instance of compilation.
86 void DIBuilder::createCompileUnit(unsigned Lang, StringRef Filename,
87 StringRef Directory, StringRef Producer,
88 bool isOptimized, StringRef Flags,
89 unsigned RunTimeVer, StringRef SplitName) {
90 assert(((Lang <= dwarf::DW_LANG_Python && Lang >= dwarf::DW_LANG_C89) ||
91 (Lang <= dwarf::DW_LANG_hi_user && Lang >= dwarf::DW_LANG_lo_user)) &&
92 "Invalid Language tag");
93 assert(!Filename.empty() &&
94 "Unable to create compile unit without filename");
95 Value *TElts[] = { GetTagConstant(VMContext, DW_TAG_base_type) };
96 TempEnumTypes = MDNode::getTemporary(VMContext, TElts);
98 TempRetainTypes = MDNode::getTemporary(VMContext, TElts);
100 TempSubprograms = MDNode::getTemporary(VMContext, TElts);
102 TempGVs = MDNode::getTemporary(VMContext, TElts);
105 GetTagConstant(VMContext, dwarf::DW_TAG_compile_unit),
106 createFilePathPair(VMContext, Filename, Directory),
107 ConstantInt::get(Type::getInt32Ty(VMContext), Lang),
108 MDString::get(VMContext, Producer),
109 ConstantInt::get(Type::getInt1Ty(VMContext), isOptimized),
110 MDString::get(VMContext, Flags),
111 ConstantInt::get(Type::getInt32Ty(VMContext), RunTimeVer),
116 MDString::get(VMContext, SplitName)
118 TheCU = DICompileUnit(MDNode::get(VMContext, Elts));
120 // Create a named metadata so that it is easier to find cu in a module.
121 NamedMDNode *NMD = M.getOrInsertNamedMetadata("llvm.dbg.cu");
122 NMD->addOperand(TheCU);
125 /// createFile - Create a file descriptor to hold debugging information
127 DIFile DIBuilder::createFile(StringRef Filename, StringRef Directory) {
129 GetTagConstant(VMContext, dwarf::DW_TAG_file_type),
130 createFilePathPair(VMContext, Filename, Directory)
132 return DIFile(MDNode::get(VMContext, Elts));
135 /// createEnumerator - Create a single enumerator value.
136 DIEnumerator DIBuilder::createEnumerator(StringRef Name, uint64_t Val) {
137 assert(!Name.empty() && "Unable to create enumerator without name");
139 GetTagConstant(VMContext, dwarf::DW_TAG_enumerator),
140 MDString::get(VMContext, Name),
141 ConstantInt::get(Type::getInt64Ty(VMContext), Val)
143 return DIEnumerator(MDNode::get(VMContext, Elts));
146 /// createNullPtrType - Create C++0x nullptr type.
147 DIType DIBuilder::createNullPtrType(StringRef Name) {
148 assert(!Name.empty() && "Unable to create type without name");
149 // nullptr is encoded in DIBasicType format. Line number, filename,
150 // ,size, alignment, offset and flags are always empty here.
152 GetTagConstant(VMContext, dwarf::DW_TAG_unspecified_type),
155 MDString::get(VMContext, Name),
156 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
157 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Size
158 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Align
159 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
160 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags;
161 ConstantInt::get(Type::getInt32Ty(VMContext), 0) // Encoding
163 return DIType(MDNode::get(VMContext, Elts));
166 /// createBasicType - Create debugging information entry for a basic
167 /// type, e.g 'char'.
169 DIBuilder::createBasicType(StringRef Name, uint64_t SizeInBits,
170 uint64_t AlignInBits, unsigned Encoding) {
171 assert(!Name.empty() && "Unable to create type without name");
172 // Basic types are encoded in DIBasicType format. Line number, filename,
173 // offset and flags are always empty here.
175 GetTagConstant(VMContext, dwarf::DW_TAG_base_type),
176 NULL, // File/directory name
178 MDString::get(VMContext, Name),
179 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
180 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
181 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
182 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
183 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags;
184 ConstantInt::get(Type::getInt32Ty(VMContext), Encoding)
186 return DIBasicType(MDNode::get(VMContext, Elts));
189 /// createQualifiedType - Create debugging information entry for a qualified
190 /// type, e.g. 'const int'.
191 DIDerivedType DIBuilder::createQualifiedType(unsigned Tag, DIType FromTy) {
192 // Qualified types are encoded in DIDerivedType format.
194 GetTagConstant(VMContext, Tag),
197 MDString::get(VMContext, StringRef()), // Empty name.
198 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
199 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Size
200 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Align
201 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
202 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags
205 return DIDerivedType(MDNode::get(VMContext, Elts));
208 /// createPointerType - Create debugging information entry for a pointer.
210 DIBuilder::createPointerType(DIType PointeeTy, uint64_t SizeInBits,
211 uint64_t AlignInBits, StringRef Name) {
212 // Pointer types are encoded in DIDerivedType format.
214 GetTagConstant(VMContext, dwarf::DW_TAG_pointer_type),
217 MDString::get(VMContext, Name),
218 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
219 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
220 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
221 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
222 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags
225 return DIDerivedType(MDNode::get(VMContext, Elts));
228 DIDerivedType DIBuilder::createMemberPointerType(DIType PointeeTy, DIType Base) {
229 // Pointer types are encoded in DIDerivedType format.
231 GetTagConstant(VMContext, dwarf::DW_TAG_ptr_to_member_type),
235 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
236 ConstantInt::get(Type::getInt64Ty(VMContext), 0),
237 ConstantInt::get(Type::getInt64Ty(VMContext), 0),
238 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
239 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags
243 return DIDerivedType(MDNode::get(VMContext, Elts));
246 /// createReferenceType - Create debugging information entry for a reference
248 DIDerivedType DIBuilder::createReferenceType(unsigned Tag, DIType RTy) {
249 assert(RTy.Verify() && "Unable to create reference type");
250 // References are encoded in DIDerivedType format.
252 GetTagConstant(VMContext, Tag),
256 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
257 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Size
258 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Align
259 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
260 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags
263 return DIDerivedType(MDNode::get(VMContext, Elts));
266 /// createTypedef - Create debugging information entry for a typedef.
267 DIDerivedType DIBuilder::createTypedef(DIType Ty, StringRef Name, DIFile File,
268 unsigned LineNo, DIDescriptor Context) {
269 // typedefs are encoded in DIDerivedType format.
270 assert(Ty.Verify() && "Invalid typedef type!");
272 GetTagConstant(VMContext, dwarf::DW_TAG_typedef),
274 getNonCompileUnitScope(Context),
275 MDString::get(VMContext, Name),
276 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
277 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Size
278 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Align
279 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
280 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags
283 return DIDerivedType(MDNode::get(VMContext, Elts));
286 /// createFriend - Create debugging information entry for a 'friend'.
287 DIType DIBuilder::createFriend(DIType Ty, DIType FriendTy) {
288 // typedefs are encoded in DIDerivedType format.
289 assert(Ty.Verify() && "Invalid type!");
290 assert(FriendTy.Verify() && "Invalid friend type!");
292 GetTagConstant(VMContext, dwarf::DW_TAG_friend),
296 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
297 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Size
298 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Align
299 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
300 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags
303 return DIType(MDNode::get(VMContext, Elts));
306 /// createInheritance - Create debugging information entry to establish
307 /// inheritance relationship between two types.
308 DIDerivedType DIBuilder::createInheritance(
309 DIType Ty, DIType BaseTy, uint64_t BaseOffset, unsigned Flags) {
310 assert(Ty.Verify() && "Unable to create inheritance");
311 // TAG_inheritance is encoded in DIDerivedType format.
313 GetTagConstant(VMContext, dwarf::DW_TAG_inheritance),
317 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
318 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Size
319 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Align
320 ConstantInt::get(Type::getInt64Ty(VMContext), BaseOffset),
321 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
324 return DIDerivedType(MDNode::get(VMContext, Elts));
327 /// createMemberType - Create debugging information entry for a member.
328 DIDerivedType DIBuilder::createMemberType(
329 DIDescriptor Scope, StringRef Name, DIFile File, unsigned LineNumber,
330 uint64_t SizeInBits, uint64_t AlignInBits, uint64_t OffsetInBits,
331 unsigned Flags, DIType Ty) {
332 // TAG_member is encoded in DIDerivedType format.
334 GetTagConstant(VMContext, dwarf::DW_TAG_member),
336 getNonCompileUnitScope(Scope),
337 MDString::get(VMContext, Name),
338 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
339 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
340 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
341 ConstantInt::get(Type::getInt64Ty(VMContext), OffsetInBits),
342 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
345 return DIDerivedType(MDNode::get(VMContext, Elts));
348 /// createStaticMemberType - Create debugging information entry for a
349 /// C++ static data member.
350 DIType DIBuilder::createStaticMemberType(DIDescriptor Scope, StringRef Name,
351 DIFile File, unsigned LineNumber,
352 DIType Ty, unsigned Flags,
354 // TAG_member is encoded in DIDerivedType format.
355 Flags |= DIDescriptor::FlagStaticMember;
357 GetTagConstant(VMContext, dwarf::DW_TAG_member),
359 getNonCompileUnitScope(Scope),
360 MDString::get(VMContext, Name),
361 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
362 ConstantInt::get(Type::getInt64Ty(VMContext), 0/*SizeInBits*/),
363 ConstantInt::get(Type::getInt64Ty(VMContext), 0/*AlignInBits*/),
364 ConstantInt::get(Type::getInt64Ty(VMContext), 0/*OffsetInBits*/),
365 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
369 return DIType(MDNode::get(VMContext, Elts));
372 /// createObjCIVar - Create debugging information entry for Objective-C
373 /// instance variable.
374 DIType DIBuilder::createObjCIVar(StringRef Name,
375 DIFile File, unsigned LineNumber,
376 uint64_t SizeInBits, uint64_t AlignInBits,
377 uint64_t OffsetInBits, unsigned Flags,
378 DIType Ty, StringRef PropertyName,
379 StringRef GetterName, StringRef SetterName,
380 unsigned PropertyAttributes) {
381 // TAG_member is encoded in DIDerivedType format.
383 GetTagConstant(VMContext, dwarf::DW_TAG_member),
385 getNonCompileUnitScope(File),
386 MDString::get(VMContext, Name),
387 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
388 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
389 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
390 ConstantInt::get(Type::getInt64Ty(VMContext), OffsetInBits),
391 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
393 MDString::get(VMContext, PropertyName),
394 MDString::get(VMContext, GetterName),
395 MDString::get(VMContext, SetterName),
396 ConstantInt::get(Type::getInt32Ty(VMContext), PropertyAttributes)
398 return DIType(MDNode::get(VMContext, Elts));
401 /// createObjCIVar - Create debugging information entry for Objective-C
402 /// instance variable.
403 DIType DIBuilder::createObjCIVar(StringRef Name,
404 DIFile File, unsigned LineNumber,
405 uint64_t SizeInBits, uint64_t AlignInBits,
406 uint64_t OffsetInBits, unsigned Flags,
407 DIType Ty, MDNode *PropertyNode) {
408 // TAG_member is encoded in DIDerivedType format.
410 GetTagConstant(VMContext, dwarf::DW_TAG_member),
412 getNonCompileUnitScope(File),
413 MDString::get(VMContext, Name),
414 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
415 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
416 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
417 ConstantInt::get(Type::getInt64Ty(VMContext), OffsetInBits),
418 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
422 return DIType(MDNode::get(VMContext, Elts));
425 /// createObjCProperty - Create debugging information entry for Objective-C
427 DIObjCProperty DIBuilder::createObjCProperty(StringRef Name,
428 DIFile File, unsigned LineNumber,
429 StringRef GetterName,
430 StringRef SetterName,
431 unsigned PropertyAttributes,
434 GetTagConstant(VMContext, dwarf::DW_TAG_APPLE_property),
435 MDString::get(VMContext, Name),
437 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
438 MDString::get(VMContext, GetterName),
439 MDString::get(VMContext, SetterName),
440 ConstantInt::get(Type::getInt32Ty(VMContext), PropertyAttributes),
443 return DIObjCProperty(MDNode::get(VMContext, Elts));
446 /// createTemplateTypeParameter - Create debugging information for template
448 DITemplateTypeParameter
449 DIBuilder::createTemplateTypeParameter(DIDescriptor Context, StringRef Name,
450 DIType Ty, MDNode *File, unsigned LineNo,
453 GetTagConstant(VMContext, dwarf::DW_TAG_template_type_parameter),
454 getNonCompileUnitScope(Context),
455 MDString::get(VMContext, Name),
458 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
459 ConstantInt::get(Type::getInt32Ty(VMContext), ColumnNo)
461 return DITemplateTypeParameter(MDNode::get(VMContext, Elts));
464 /// createTemplateValueParameter - Create debugging information for template
466 DITemplateValueParameter
467 DIBuilder::createTemplateValueParameter(DIDescriptor Context, StringRef Name,
468 DIType Ty, uint64_t Val,
469 MDNode *File, unsigned LineNo,
472 GetTagConstant(VMContext, dwarf::DW_TAG_template_value_parameter),
473 getNonCompileUnitScope(Context),
474 MDString::get(VMContext, Name),
476 ConstantInt::get(Type::getInt64Ty(VMContext), Val),
478 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
479 ConstantInt::get(Type::getInt32Ty(VMContext), ColumnNo)
481 return DITemplateValueParameter(MDNode::get(VMContext, Elts));
484 /// createClassType - Create debugging information entry for a class.
485 DIType DIBuilder::createClassType(DIDescriptor Context, StringRef Name,
486 DIFile File, unsigned LineNumber,
487 uint64_t SizeInBits, uint64_t AlignInBits,
488 uint64_t OffsetInBits, unsigned Flags,
489 DIType DerivedFrom, DIArray Elements,
490 MDNode *VTableHolder,
491 MDNode *TemplateParams) {
492 assert((!Context || Context.Verify()) &&
493 "createClassType should be called with a valid Context");
494 // TAG_class_type is encoded in DICompositeType format.
496 GetTagConstant(VMContext, dwarf::DW_TAG_class_type),
498 getNonCompileUnitScope(Context),
499 MDString::get(VMContext, Name),
500 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
501 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
502 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
503 ConstantInt::get(Type::getInt32Ty(VMContext), OffsetInBits),
504 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
507 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
511 DIType R(MDNode::get(VMContext, Elts));
512 assert(R.Verify() && "createClassType should return a verifiable DIType");
516 /// createStructType - Create debugging information entry for a struct.
517 DICompositeType DIBuilder::createStructType(DIDescriptor Context,
518 StringRef Name, DIFile File,
521 uint64_t AlignInBits,
522 unsigned Flags, DIType DerivedFrom,
524 unsigned RunTimeLang,
525 MDNode *VTableHolder) {
526 // TAG_structure_type is encoded in DICompositeType format.
528 GetTagConstant(VMContext, dwarf::DW_TAG_structure_type),
530 getNonCompileUnitScope(Context),
531 MDString::get(VMContext, Name),
532 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
533 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
534 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
535 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
536 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
539 ConstantInt::get(Type::getInt32Ty(VMContext), RunTimeLang),
543 DICompositeType R(MDNode::get(VMContext, Elts));
544 assert(R.Verify() && "createStructType should return a verifiable DIType");
548 /// createUnionType - Create debugging information entry for an union.
549 DICompositeType DIBuilder::createUnionType(
550 DIDescriptor Scope, StringRef Name, DIFile File, unsigned LineNumber,
551 uint64_t SizeInBits, uint64_t AlignInBits, unsigned Flags, DIArray Elements,
552 unsigned RunTimeLang) {
553 // TAG_union_type is encoded in DICompositeType format.
555 GetTagConstant(VMContext, dwarf::DW_TAG_union_type),
557 getNonCompileUnitScope(Scope),
558 MDString::get(VMContext, Name),
559 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
560 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
561 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
562 ConstantInt::get(Type::getInt64Ty(VMContext), 0),
563 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
566 ConstantInt::get(Type::getInt32Ty(VMContext), RunTimeLang),
567 Constant::getNullValue(Type::getInt32Ty(VMContext))
569 return DICompositeType(MDNode::get(VMContext, Elts));
572 /// createSubroutineType - Create subroutine type.
574 DIBuilder::createSubroutineType(DIFile File, DIArray ParameterTypes) {
575 // TAG_subroutine_type is encoded in DICompositeType format.
577 GetTagConstant(VMContext, dwarf::DW_TAG_subroutine_type),
578 Constant::getNullValue(Type::getInt32Ty(VMContext)),
579 Constant::getNullValue(Type::getInt32Ty(VMContext)),
580 MDString::get(VMContext, ""),
581 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
582 ConstantInt::get(Type::getInt64Ty(VMContext), 0),
583 ConstantInt::get(Type::getInt64Ty(VMContext), 0),
584 ConstantInt::get(Type::getInt64Ty(VMContext), 0),
585 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
588 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
589 Constant::getNullValue(Type::getInt32Ty(VMContext))
591 return DICompositeType(MDNode::get(VMContext, Elts));
594 /// createEnumerationType - Create debugging information entry for an
596 DICompositeType DIBuilder::createEnumerationType(
597 DIDescriptor Scope, StringRef Name, DIFile File, unsigned LineNumber,
598 uint64_t SizeInBits, uint64_t AlignInBits, DIArray Elements,
600 // TAG_enumeration_type is encoded in DICompositeType format.
602 GetTagConstant(VMContext, dwarf::DW_TAG_enumeration_type),
604 getNonCompileUnitScope(Scope),
605 MDString::get(VMContext, Name),
606 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
607 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
608 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
609 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
610 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
613 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
614 Constant::getNullValue(Type::getInt32Ty(VMContext))
616 MDNode *Node = MDNode::get(VMContext, Elts);
617 AllEnumTypes.push_back(Node);
618 return DICompositeType(Node);
621 /// createArrayType - Create debugging information entry for an array.
622 DICompositeType DIBuilder::createArrayType(uint64_t Size, uint64_t AlignInBits,
623 DIType Ty, DIArray Subscripts) {
624 // TAG_array_type is encoded in DICompositeType format.
626 GetTagConstant(VMContext, dwarf::DW_TAG_array_type),
627 NULL, // Filename/Directory,
629 MDString::get(VMContext, ""),
630 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
631 ConstantInt::get(Type::getInt64Ty(VMContext), Size),
632 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
633 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
634 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
637 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
638 Constant::getNullValue(Type::getInt32Ty(VMContext))
640 return DICompositeType(MDNode::get(VMContext, Elts));
643 /// createVectorType - Create debugging information entry for a vector.
644 DIType DIBuilder::createVectorType(uint64_t Size, uint64_t AlignInBits,
645 DIType Ty, DIArray Subscripts) {
647 // A vector is an array type with the FlagVector flag applied.
649 GetTagConstant(VMContext, dwarf::DW_TAG_array_type),
650 NULL, // Filename/Directory,
652 MDString::get(VMContext, ""),
653 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
654 ConstantInt::get(Type::getInt64Ty(VMContext), Size),
655 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
656 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
657 ConstantInt::get(Type::getInt32Ty(VMContext), DIType::FlagVector),
660 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
661 Constant::getNullValue(Type::getInt32Ty(VMContext))
663 return DIType(MDNode::get(VMContext, Elts));
666 /// createArtificialType - Create a new DIType with "artificial" flag set.
667 DIType DIBuilder::createArtificialType(DIType Ty) {
668 if (Ty.isArtificial())
671 SmallVector<Value *, 9> Elts;
673 assert (N && "Unexpected input DIType!");
674 for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i) {
675 if (Value *V = N->getOperand(i))
678 Elts.push_back(Constant::getNullValue(Type::getInt32Ty(VMContext)));
681 unsigned CurFlags = Ty.getFlags();
682 CurFlags = CurFlags | DIType::FlagArtificial;
684 // Flags are stored at this slot.
685 Elts[8] = ConstantInt::get(Type::getInt32Ty(VMContext), CurFlags);
687 return DIType(MDNode::get(VMContext, Elts));
690 /// createObjectPointerType - Create a new type with both the object pointer
691 /// and artificial flags set.
692 DIType DIBuilder::createObjectPointerType(DIType Ty) {
693 if (Ty.isObjectPointer())
696 SmallVector<Value *, 9> Elts;
698 assert (N && "Unexpected input DIType!");
699 for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i) {
700 if (Value *V = N->getOperand(i))
703 Elts.push_back(Constant::getNullValue(Type::getInt32Ty(VMContext)));
706 unsigned CurFlags = Ty.getFlags();
707 CurFlags = CurFlags | (DIType::FlagObjectPointer | DIType::FlagArtificial);
709 // Flags are stored at this slot.
710 Elts[8] = ConstantInt::get(Type::getInt32Ty(VMContext), CurFlags);
712 return DIType(MDNode::get(VMContext, Elts));
715 /// retainType - Retain DIType in a module even if it is not referenced
716 /// through debug info anchors.
717 void DIBuilder::retainType(DIType T) {
718 AllRetainTypes.push_back(T);
721 /// createUnspecifiedParameter - Create unspeicified type descriptor
722 /// for the subroutine type.
723 DIDescriptor DIBuilder::createUnspecifiedParameter() {
725 GetTagConstant(VMContext, dwarf::DW_TAG_unspecified_parameters)
727 return DIDescriptor(MDNode::get(VMContext, Elts));
730 /// createForwardDecl - Create a temporary forward-declared type that
731 /// can be RAUW'd if the full type is seen.
732 DIType DIBuilder::createForwardDecl(unsigned Tag, StringRef Name,
733 DIDescriptor Scope, DIFile F,
734 unsigned Line, unsigned RuntimeLang,
736 uint64_t AlignInBits) {
737 // Create a temporary MDNode.
739 GetTagConstant(VMContext, Tag),
741 getNonCompileUnitScope(Scope),
742 MDString::get(VMContext, Name),
743 ConstantInt::get(Type::getInt32Ty(VMContext), Line),
744 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
745 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
746 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
747 ConstantInt::get(Type::getInt32Ty(VMContext),
748 DIDescriptor::FlagFwdDecl),
751 ConstantInt::get(Type::getInt32Ty(VMContext), RuntimeLang)
753 MDNode *Node = MDNode::getTemporary(VMContext, Elts);
754 assert(DIType(Node).Verify() &&
755 "createForwardDecl result should be verifiable");
759 /// getOrCreateArray - Get a DIArray, create one if required.
760 DIArray DIBuilder::getOrCreateArray(ArrayRef<Value *> Elements) {
761 if (Elements.empty()) {
762 Value *Null = Constant::getNullValue(Type::getInt32Ty(VMContext));
763 return DIArray(MDNode::get(VMContext, Null));
765 return DIArray(MDNode::get(VMContext, Elements));
768 /// getOrCreateSubrange - Create a descriptor for a value range. This
769 /// implicitly uniques the values returned.
770 DISubrange DIBuilder::getOrCreateSubrange(int64_t Lo, int64_t Count) {
772 GetTagConstant(VMContext, dwarf::DW_TAG_subrange_type),
773 ConstantInt::get(Type::getInt64Ty(VMContext), Lo),
774 ConstantInt::get(Type::getInt64Ty(VMContext), Count)
777 return DISubrange(MDNode::get(VMContext, Elts));
780 /// \brief Create a new descriptor for the specified global.
781 DIGlobalVariable DIBuilder::
782 createGlobalVariable(StringRef Name, StringRef LinkageName, DIFile F,
783 unsigned LineNumber, DIType Ty, bool isLocalToUnit,
786 GetTagConstant(VMContext, dwarf::DW_TAG_variable),
787 Constant::getNullValue(Type::getInt32Ty(VMContext)),
789 MDString::get(VMContext, Name),
790 MDString::get(VMContext, Name),
791 MDString::get(VMContext, LinkageName),
793 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
795 ConstantInt::get(Type::getInt32Ty(VMContext), isLocalToUnit),
796 ConstantInt::get(Type::getInt32Ty(VMContext), 1), /* isDefinition*/
800 MDNode *Node = MDNode::get(VMContext, Elts);
801 AllGVs.push_back(Node);
802 return DIGlobalVariable(Node);
805 /// \brief Create a new descriptor for the specified global.
806 DIGlobalVariable DIBuilder::
807 createGlobalVariable(StringRef Name, DIFile F, unsigned LineNumber,
808 DIType Ty, bool isLocalToUnit, Value *Val) {
809 return createGlobalVariable(Name, Name, F, LineNumber, Ty, isLocalToUnit,
813 /// createStaticVariable - Create a new descriptor for the specified static
815 DIGlobalVariable DIBuilder::
816 createStaticVariable(DIDescriptor Context, StringRef Name,
817 StringRef LinkageName, DIFile F, unsigned LineNumber,
818 DIType Ty, bool isLocalToUnit, Value *Val, MDNode *Decl) {
820 GetTagConstant(VMContext, dwarf::DW_TAG_variable),
821 Constant::getNullValue(Type::getInt32Ty(VMContext)),
822 getNonCompileUnitScope(Context),
823 MDString::get(VMContext, Name),
824 MDString::get(VMContext, Name),
825 MDString::get(VMContext, LinkageName),
827 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
829 ConstantInt::get(Type::getInt32Ty(VMContext), isLocalToUnit),
830 ConstantInt::get(Type::getInt32Ty(VMContext), 1), /* isDefinition*/
834 MDNode *Node = MDNode::get(VMContext, Elts);
835 AllGVs.push_back(Node);
836 return DIGlobalVariable(Node);
839 /// createVariable - Create a new descriptor for the specified variable.
840 DIVariable DIBuilder::createLocalVariable(unsigned Tag, DIDescriptor Scope,
841 StringRef Name, DIFile File,
842 unsigned LineNo, DIType Ty,
843 bool AlwaysPreserve, unsigned Flags,
845 DIDescriptor Context(getNonCompileUnitScope(Scope));
846 assert((!Context || Context.Verify()) &&
847 "createLocalVariable should be called with a valid Context");
848 assert(Ty.Verify() &&
849 "createLocalVariable should be called with a valid type");
851 GetTagConstant(VMContext, Tag),
852 getNonCompileUnitScope(Scope),
853 MDString::get(VMContext, Name),
855 ConstantInt::get(Type::getInt32Ty(VMContext), (LineNo | (ArgNo << 24))),
857 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
858 Constant::getNullValue(Type::getInt32Ty(VMContext))
860 MDNode *Node = MDNode::get(VMContext, Elts);
861 if (AlwaysPreserve) {
862 // The optimizer may remove local variable. If there is an interest
863 // to preserve variable info in such situation then stash it in a
865 DISubprogram Fn(getDISubprogram(Scope));
866 NamedMDNode *FnLocals = getOrInsertFnSpecificMDNode(M, Fn);
867 FnLocals->addOperand(Node);
869 assert(DIVariable(Node).Verify() &&
870 "createLocalVariable should return a verifiable DIVariable");
871 return DIVariable(Node);
874 /// createComplexVariable - Create a new descriptor for the specified variable
875 /// which has a complex address expression for its address.
876 DIVariable DIBuilder::createComplexVariable(unsigned Tag, DIDescriptor Scope,
877 StringRef Name, DIFile F,
879 DIType Ty, ArrayRef<Value *> Addr,
881 SmallVector<Value *, 15> Elts;
882 Elts.push_back(GetTagConstant(VMContext, Tag));
883 Elts.push_back(getNonCompileUnitScope(Scope)),
884 Elts.push_back(MDString::get(VMContext, Name));
886 Elts.push_back(ConstantInt::get(Type::getInt32Ty(VMContext),
887 (LineNo | (ArgNo << 24))));
889 Elts.push_back(Constant::getNullValue(Type::getInt32Ty(VMContext)));
890 Elts.push_back(Constant::getNullValue(Type::getInt32Ty(VMContext)));
891 Elts.append(Addr.begin(), Addr.end());
893 return DIVariable(MDNode::get(VMContext, Elts));
896 /// createFunction - Create a new descriptor for the specified function.
897 DISubprogram DIBuilder::createFunction(DIDescriptor Context,
899 StringRef LinkageName,
900 DIFile File, unsigned LineNo,
902 bool isLocalToUnit, bool isDefinition,
904 unsigned Flags, bool isOptimized,
908 Value *TElts[] = { GetTagConstant(VMContext, DW_TAG_base_type) };
910 GetTagConstant(VMContext, dwarf::DW_TAG_subprogram),
912 getNonCompileUnitScope(Context),
913 MDString::get(VMContext, Name),
914 MDString::get(VMContext, Name),
915 MDString::get(VMContext, LinkageName),
916 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
918 ConstantInt::get(Type::getInt1Ty(VMContext), isLocalToUnit),
919 ConstantInt::get(Type::getInt1Ty(VMContext), isDefinition),
920 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
921 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
923 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
924 ConstantInt::get(Type::getInt1Ty(VMContext), isOptimized),
928 MDNode::getTemporary(VMContext, TElts),
929 ConstantInt::get(Type::getInt32Ty(VMContext), ScopeLine)
931 MDNode *Node = MDNode::get(VMContext, Elts);
933 // Create a named metadata so that we do not lose this mdnode.
935 AllSubprograms.push_back(Node);
936 DISubprogram S(Node);
937 assert(S.Verify() && "createFunction should return a valid DISubprogram");
941 /// createMethod - Create a new descriptor for the specified C++ method.
942 DISubprogram DIBuilder::createMethod(DIDescriptor Context,
944 StringRef LinkageName,
946 unsigned LineNo, DIType Ty,
949 unsigned VK, unsigned VIndex,
950 MDNode *VTableHolder,
955 Value *TElts[] = { GetTagConstant(VMContext, DW_TAG_base_type) };
957 GetTagConstant(VMContext, dwarf::DW_TAG_subprogram),
959 getNonCompileUnitScope(Context),
960 MDString::get(VMContext, Name),
961 MDString::get(VMContext, Name),
962 MDString::get(VMContext, LinkageName),
963 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
965 ConstantInt::get(Type::getInt1Ty(VMContext), isLocalToUnit),
966 ConstantInt::get(Type::getInt1Ty(VMContext), isDefinition),
967 ConstantInt::get(Type::getInt32Ty(VMContext), (unsigned)VK),
968 ConstantInt::get(Type::getInt32Ty(VMContext), VIndex),
970 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
971 ConstantInt::get(Type::getInt1Ty(VMContext), isOptimized),
974 Constant::getNullValue(Type::getInt32Ty(VMContext)),
975 MDNode::getTemporary(VMContext, TElts),
976 // FIXME: Do we want to use different scope/lines?
977 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo)
979 MDNode *Node = MDNode::get(VMContext, Elts);
981 AllSubprograms.push_back(Node);
982 DISubprogram S(Node);
983 assert(S.Verify() && "createMethod should return a valid DISubprogram");
987 /// createNameSpace - This creates new descriptor for a namespace
988 /// with the specified parent scope.
989 DINameSpace DIBuilder::createNameSpace(DIDescriptor Scope, StringRef Name,
990 DIFile File, unsigned LineNo) {
992 GetTagConstant(VMContext, dwarf::DW_TAG_namespace),
994 getNonCompileUnitScope(Scope),
995 MDString::get(VMContext, Name),
996 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo)
998 DINameSpace R(MDNode::get(VMContext, Elts));
1000 "createNameSpace should return a verifiable DINameSpace");
1004 /// createLexicalBlockFile - This creates a new MDNode that encapsulates
1005 /// an existing scope with a new filename.
1006 DILexicalBlockFile DIBuilder::createLexicalBlockFile(DIDescriptor Scope,
1009 GetTagConstant(VMContext, dwarf::DW_TAG_lexical_block),
1013 DILexicalBlockFile R(MDNode::get(VMContext, Elts));
1016 "createLexicalBlockFile should return a verifiable DILexicalBlockFile");
1020 DILexicalBlock DIBuilder::createLexicalBlock(DIDescriptor Scope, DIFile File,
1021 unsigned Line, unsigned Col) {
1022 // Defeat MDNode uniqing for lexical blocks by using unique id.
1023 static unsigned int unique_id = 0;
1025 GetTagConstant(VMContext, dwarf::DW_TAG_lexical_block),
1026 getNonCompileUnitScope(Scope),
1027 ConstantInt::get(Type::getInt32Ty(VMContext), Line),
1028 ConstantInt::get(Type::getInt32Ty(VMContext), Col),
1030 ConstantInt::get(Type::getInt32Ty(VMContext), unique_id++)
1032 DILexicalBlock R(MDNode::get(VMContext, Elts));
1033 assert(R.Verify() &&
1034 "createLexicalBlock should return a verifiable DILexicalBlock");
1038 /// insertDeclare - Insert a new llvm.dbg.declare intrinsic call.
1039 Instruction *DIBuilder::insertDeclare(Value *Storage, DIVariable VarInfo,
1040 Instruction *InsertBefore) {
1041 assert(Storage && "no storage passed to dbg.declare");
1042 assert(VarInfo.Verify() && "empty DIVariable passed to dbg.declare");
1044 DeclareFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_declare);
1046 Value *Args[] = { MDNode::get(Storage->getContext(), Storage), VarInfo };
1047 return CallInst::Create(DeclareFn, Args, "", InsertBefore);
1050 /// insertDeclare - Insert a new llvm.dbg.declare intrinsic call.
1051 Instruction *DIBuilder::insertDeclare(Value *Storage, DIVariable VarInfo,
1052 BasicBlock *InsertAtEnd) {
1053 assert(Storage && "no storage passed to dbg.declare");
1054 assert(VarInfo.Verify() && "invalid DIVariable passed to dbg.declare");
1056 DeclareFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_declare);
1058 Value *Args[] = { MDNode::get(Storage->getContext(), Storage), VarInfo };
1060 // If this block already has a terminator then insert this intrinsic
1061 // before the terminator.
1062 if (TerminatorInst *T = InsertAtEnd->getTerminator())
1063 return CallInst::Create(DeclareFn, Args, "", T);
1065 return CallInst::Create(DeclareFn, Args, "", InsertAtEnd);
1068 /// insertDbgValueIntrinsic - Insert a new llvm.dbg.value intrinsic call.
1069 Instruction *DIBuilder::insertDbgValueIntrinsic(Value *V, uint64_t Offset,
1071 Instruction *InsertBefore) {
1072 assert(V && "no value passed to dbg.value");
1073 assert(VarInfo.Verify() && "invalid DIVariable passed to dbg.value");
1075 ValueFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_value);
1077 Value *Args[] = { MDNode::get(V->getContext(), V),
1078 ConstantInt::get(Type::getInt64Ty(V->getContext()), Offset),
1080 return CallInst::Create(ValueFn, Args, "", InsertBefore);
1083 /// insertDbgValueIntrinsic - Insert a new llvm.dbg.value intrinsic call.
1084 Instruction *DIBuilder::insertDbgValueIntrinsic(Value *V, uint64_t Offset,
1086 BasicBlock *InsertAtEnd) {
1087 assert(V && "no value passed to dbg.value");
1088 assert(VarInfo.Verify() && "invalid DIVariable passed to dbg.value");
1090 ValueFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_value);
1092 Value *Args[] = { MDNode::get(V->getContext(), V),
1093 ConstantInt::get(Type::getInt64Ty(V->getContext()), Offset),
1095 return CallInst::Create(ValueFn, Args, "", InsertAtEnd);