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 /// createCompileUnit - A CompileUnit provides an anchor for all debugging
75 /// information generated during this instance of compilation.
76 void DIBuilder::createCompileUnit(unsigned Lang, StringRef Filename,
77 StringRef Directory, StringRef Producer,
78 bool isOptimized, StringRef Flags,
79 unsigned RunTimeVer, StringRef SplitName) {
80 assert(((Lang <= dwarf::DW_LANG_Python && Lang >= dwarf::DW_LANG_C89) ||
81 (Lang <= dwarf::DW_LANG_hi_user && Lang >= dwarf::DW_LANG_lo_user)) &&
82 "Invalid Language tag");
83 assert(!Filename.empty() &&
84 "Unable to create compile unit without filename");
85 Value *TElts[] = { GetTagConstant(VMContext, DW_TAG_base_type) };
86 TempEnumTypes = MDNode::getTemporary(VMContext, TElts);
88 TempRetainTypes = MDNode::getTemporary(VMContext, TElts);
90 TempSubprograms = MDNode::getTemporary(VMContext, TElts);
92 TempGVs = MDNode::getTemporary(VMContext, TElts);
95 GetTagConstant(VMContext, dwarf::DW_TAG_compile_unit),
96 Constant::getNullValue(Type::getInt32Ty(VMContext)),
97 ConstantInt::get(Type::getInt32Ty(VMContext), Lang),
98 createFile(Filename, Directory),
99 MDString::get(VMContext, Producer),
100 ConstantInt::get(Type::getInt1Ty(VMContext), isOptimized),
101 MDString::get(VMContext, Flags),
102 ConstantInt::get(Type::getInt32Ty(VMContext), RunTimeVer),
107 MDString::get(VMContext, SplitName)
109 TheCU = DICompileUnit(MDNode::get(VMContext, Elts));
111 // Create a named metadata so that it is easier to find cu in a module.
112 NamedMDNode *NMD = M.getOrInsertNamedMetadata("llvm.dbg.cu");
113 NMD->addOperand(TheCU);
116 /// createFile - Create a file descriptor to hold debugging information
118 DIFile DIBuilder::createFile(StringRef Filename, StringRef Directory) {
119 assert(!Filename.empty() && "Unable to create file without name");
121 GetTagConstant(VMContext, dwarf::DW_TAG_file_type),
122 MDString::get(VMContext, Filename),
123 MDString::get(VMContext, Directory),
125 return DIFile(MDNode::get(VMContext, Elts));
128 /// createEnumerator - Create a single enumerator value.
129 DIEnumerator DIBuilder::createEnumerator(StringRef Name, uint64_t Val) {
130 assert(!Name.empty() && "Unable to create enumerator without name");
132 GetTagConstant(VMContext, dwarf::DW_TAG_enumerator),
133 MDString::get(VMContext, Name),
134 ConstantInt::get(Type::getInt64Ty(VMContext), Val)
136 return DIEnumerator(MDNode::get(VMContext, Elts));
139 /// createNullPtrType - Create C++0x nullptr type.
140 DIType DIBuilder::createNullPtrType(StringRef Name) {
141 assert(!Name.empty() && "Unable to create type without name");
142 // nullptr is encoded in DIBasicType format. Line number, filename,
143 // ,size, alignment, offset and flags are always empty here.
145 GetTagConstant(VMContext, dwarf::DW_TAG_unspecified_type),
147 MDString::get(VMContext, Name),
149 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
150 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Size
151 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Align
152 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
153 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags;
154 ConstantInt::get(Type::getInt32Ty(VMContext), 0) // Encoding
156 return DIType(MDNode::get(VMContext, Elts));
159 /// createBasicType - Create debugging information entry for a basic
160 /// type, e.g 'char'.
162 DIBuilder::createBasicType(StringRef Name, uint64_t SizeInBits,
163 uint64_t AlignInBits, unsigned Encoding) {
164 assert(!Name.empty() && "Unable to create type without name");
165 // Basic types are encoded in DIBasicType format. Line number, filename,
166 // offset and flags are always empty here.
168 GetTagConstant(VMContext, dwarf::DW_TAG_base_type),
170 MDString::get(VMContext, Name),
172 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
173 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
174 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
175 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
176 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags;
177 ConstantInt::get(Type::getInt32Ty(VMContext), Encoding)
179 return DIBasicType(MDNode::get(VMContext, Elts));
182 /// createQualifiedType - Create debugging information entry for a qualified
183 /// type, e.g. 'const int'.
184 DIDerivedType DIBuilder::createQualifiedType(unsigned Tag, DIType FromTy) {
185 // Qualified types are encoded in DIDerivedType format.
187 GetTagConstant(VMContext, Tag),
189 MDString::get(VMContext, StringRef()), // Empty name.
191 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
192 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Size
193 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Align
194 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
195 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags
198 return DIDerivedType(MDNode::get(VMContext, Elts));
201 /// createPointerType - Create debugging information entry for a pointer.
203 DIBuilder::createPointerType(DIType PointeeTy, uint64_t SizeInBits,
204 uint64_t AlignInBits, StringRef Name) {
205 // Pointer types are encoded in DIDerivedType format.
207 GetTagConstant(VMContext, dwarf::DW_TAG_pointer_type),
209 MDString::get(VMContext, Name),
211 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
212 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
213 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
214 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
215 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags
218 return DIDerivedType(MDNode::get(VMContext, Elts));
221 DIDerivedType DIBuilder::createMemberPointerType(DIType PointeeTy, DIType Base) {
222 // Pointer types are encoded in DIDerivedType format.
224 GetTagConstant(VMContext, dwarf::DW_TAG_ptr_to_member_type),
228 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
229 ConstantInt::get(Type::getInt64Ty(VMContext), 0),
230 ConstantInt::get(Type::getInt64Ty(VMContext), 0),
231 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
232 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags
236 return DIDerivedType(MDNode::get(VMContext, Elts));
239 /// createReferenceType - Create debugging information entry for a reference
241 DIDerivedType DIBuilder::createReferenceType(unsigned Tag, DIType RTy) {
242 assert(RTy.Verify() && "Unable to create reference type");
243 // References are encoded in DIDerivedType format.
245 GetTagConstant(VMContext, Tag),
249 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
250 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Size
251 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Align
252 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
253 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags
256 return DIDerivedType(MDNode::get(VMContext, Elts));
259 /// createTypedef - Create debugging information entry for a typedef.
260 DIDerivedType DIBuilder::createTypedef(DIType Ty, StringRef Name, DIFile File,
261 unsigned LineNo, DIDescriptor Context) {
262 // typedefs are encoded in DIDerivedType format.
263 assert(Ty.Verify() && "Invalid typedef type!");
265 GetTagConstant(VMContext, dwarf::DW_TAG_typedef),
266 getNonCompileUnitScope(Context),
267 MDString::get(VMContext, Name),
269 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
270 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Size
271 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Align
272 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
273 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags
276 return DIDerivedType(MDNode::get(VMContext, Elts));
279 /// createFriend - Create debugging information entry for a 'friend'.
280 DIType DIBuilder::createFriend(DIType Ty, DIType FriendTy) {
281 // typedefs are encoded in DIDerivedType format.
282 assert(Ty.Verify() && "Invalid type!");
283 assert(FriendTy.Verify() && "Invalid friend type!");
285 GetTagConstant(VMContext, dwarf::DW_TAG_friend),
289 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
290 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Size
291 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Align
292 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
293 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags
296 return DIType(MDNode::get(VMContext, Elts));
299 /// createInheritance - Create debugging information entry to establish
300 /// inheritance relationship between two types.
301 DIDerivedType DIBuilder::createInheritance(
302 DIType Ty, DIType BaseTy, uint64_t BaseOffset, unsigned Flags) {
303 assert(Ty.Verify() && "Unable to create inheritance");
304 // TAG_inheritance is encoded in DIDerivedType format.
306 GetTagConstant(VMContext, dwarf::DW_TAG_inheritance),
310 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
311 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Size
312 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Align
313 ConstantInt::get(Type::getInt64Ty(VMContext), BaseOffset),
314 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
317 return DIDerivedType(MDNode::get(VMContext, Elts));
320 /// createMemberType - Create debugging information entry for a member.
321 DIDerivedType DIBuilder::createMemberType(
322 DIDescriptor Scope, StringRef Name, DIFile File, unsigned LineNumber,
323 uint64_t SizeInBits, uint64_t AlignInBits, uint64_t OffsetInBits,
324 unsigned Flags, DIType Ty) {
325 // TAG_member is encoded in DIDerivedType format.
327 GetTagConstant(VMContext, dwarf::DW_TAG_member),
328 getNonCompileUnitScope(Scope),
329 MDString::get(VMContext, Name),
331 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
332 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
333 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
334 ConstantInt::get(Type::getInt64Ty(VMContext), OffsetInBits),
335 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
338 return DIDerivedType(MDNode::get(VMContext, Elts));
341 /// createStaticMemberType - Create debugging information entry for a
342 /// C++ static data member.
343 DIType DIBuilder::createStaticMemberType(DIDescriptor Scope, StringRef Name,
344 DIFile File, unsigned LineNumber,
345 DIType Ty, unsigned Flags,
347 // TAG_member is encoded in DIDerivedType format.
348 Flags |= DIDescriptor::FlagStaticMember;
350 GetTagConstant(VMContext, dwarf::DW_TAG_member),
351 getNonCompileUnitScope(Scope),
352 MDString::get(VMContext, Name),
354 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
355 ConstantInt::get(Type::getInt64Ty(VMContext), 0/*SizeInBits*/),
356 ConstantInt::get(Type::getInt64Ty(VMContext), 0/*AlignInBits*/),
357 ConstantInt::get(Type::getInt64Ty(VMContext), 0/*OffsetInBits*/),
358 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
362 return DIType(MDNode::get(VMContext, Elts));
365 /// createObjCIVar - Create debugging information entry for Objective-C
366 /// instance variable.
367 DIType DIBuilder::createObjCIVar(StringRef Name,
368 DIFile File, unsigned LineNumber,
369 uint64_t SizeInBits, uint64_t AlignInBits,
370 uint64_t OffsetInBits, unsigned Flags,
371 DIType Ty, StringRef PropertyName,
372 StringRef GetterName, StringRef SetterName,
373 unsigned PropertyAttributes) {
374 // TAG_member is encoded in DIDerivedType format.
376 GetTagConstant(VMContext, dwarf::DW_TAG_member),
377 getNonCompileUnitScope(File),
378 MDString::get(VMContext, Name),
380 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
381 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
382 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
383 ConstantInt::get(Type::getInt64Ty(VMContext), OffsetInBits),
384 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
386 MDString::get(VMContext, PropertyName),
387 MDString::get(VMContext, GetterName),
388 MDString::get(VMContext, SetterName),
389 ConstantInt::get(Type::getInt32Ty(VMContext), PropertyAttributes)
391 return DIType(MDNode::get(VMContext, Elts));
394 /// createObjCIVar - Create debugging information entry for Objective-C
395 /// instance variable.
396 DIType DIBuilder::createObjCIVar(StringRef Name,
397 DIFile File, unsigned LineNumber,
398 uint64_t SizeInBits, uint64_t AlignInBits,
399 uint64_t OffsetInBits, unsigned Flags,
400 DIType Ty, MDNode *PropertyNode) {
401 // TAG_member is encoded in DIDerivedType format.
403 GetTagConstant(VMContext, dwarf::DW_TAG_member),
404 getNonCompileUnitScope(File),
405 MDString::get(VMContext, Name),
407 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
408 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
409 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
410 ConstantInt::get(Type::getInt64Ty(VMContext), OffsetInBits),
411 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
415 return DIType(MDNode::get(VMContext, Elts));
418 /// createObjCProperty - Create debugging information entry for Objective-C
420 DIObjCProperty DIBuilder::createObjCProperty(StringRef Name,
421 DIFile File, unsigned LineNumber,
422 StringRef GetterName,
423 StringRef SetterName,
424 unsigned PropertyAttributes,
427 GetTagConstant(VMContext, dwarf::DW_TAG_APPLE_property),
428 MDString::get(VMContext, Name),
430 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
431 MDString::get(VMContext, GetterName),
432 MDString::get(VMContext, SetterName),
433 ConstantInt::get(Type::getInt32Ty(VMContext), PropertyAttributes),
436 return DIObjCProperty(MDNode::get(VMContext, Elts));
439 /// createTemplateTypeParameter - Create debugging information for template
441 DITemplateTypeParameter
442 DIBuilder::createTemplateTypeParameter(DIDescriptor Context, StringRef Name,
443 DIType Ty, MDNode *File, unsigned LineNo,
446 GetTagConstant(VMContext, dwarf::DW_TAG_template_type_parameter),
447 getNonCompileUnitScope(Context),
448 MDString::get(VMContext, Name),
451 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
452 ConstantInt::get(Type::getInt32Ty(VMContext), ColumnNo)
454 return DITemplateTypeParameter(MDNode::get(VMContext, Elts));
457 /// createTemplateValueParameter - Create debugging information for template
459 DITemplateValueParameter
460 DIBuilder::createTemplateValueParameter(DIDescriptor Context, StringRef Name,
461 DIType Ty, uint64_t Val,
462 MDNode *File, unsigned LineNo,
465 GetTagConstant(VMContext, dwarf::DW_TAG_template_value_parameter),
466 getNonCompileUnitScope(Context),
467 MDString::get(VMContext, Name),
469 ConstantInt::get(Type::getInt64Ty(VMContext), Val),
471 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
472 ConstantInt::get(Type::getInt32Ty(VMContext), ColumnNo)
474 return DITemplateValueParameter(MDNode::get(VMContext, Elts));
477 /// createClassType - Create debugging information entry for a class.
478 DIType DIBuilder::createClassType(DIDescriptor Context, StringRef Name,
479 DIFile File, unsigned LineNumber,
480 uint64_t SizeInBits, uint64_t AlignInBits,
481 uint64_t OffsetInBits, unsigned Flags,
482 DIType DerivedFrom, DIArray Elements,
483 MDNode *VTableHolder,
484 MDNode *TemplateParams) {
485 assert((!Context || Context.Verify()) &&
486 "createClassType should be called with a valid Context");
487 // TAG_class_type is encoded in DICompositeType format.
489 GetTagConstant(VMContext, dwarf::DW_TAG_class_type),
490 getNonCompileUnitScope(Context),
491 MDString::get(VMContext, Name),
493 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
494 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
495 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
496 ConstantInt::get(Type::getInt32Ty(VMContext), OffsetInBits),
497 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
500 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
504 DIType R(MDNode::get(VMContext, Elts));
505 assert(R.Verify() && "createClassType should return a verifiable DIType");
509 /// createStructType - Create debugging information entry for a struct.
510 DICompositeType DIBuilder::createStructType(DIDescriptor Context,
511 StringRef Name, DIFile File,
514 uint64_t AlignInBits,
515 unsigned Flags, DIType DerivedFrom,
517 unsigned RunTimeLang,
518 MDNode *VTableHolder) {
519 // TAG_structure_type is encoded in DICompositeType format.
521 GetTagConstant(VMContext, dwarf::DW_TAG_structure_type),
522 getNonCompileUnitScope(Context),
523 MDString::get(VMContext, Name),
525 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
526 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
527 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
528 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
529 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
532 ConstantInt::get(Type::getInt32Ty(VMContext), RunTimeLang),
536 DICompositeType R(MDNode::get(VMContext, Elts));
537 assert(R.Verify() && "createStructType should return a verifiable DIType");
541 /// createUnionType - Create debugging information entry for an union.
542 DICompositeType DIBuilder::createUnionType(
543 DIDescriptor Scope, StringRef Name, DIFile File, unsigned LineNumber,
544 uint64_t SizeInBits, uint64_t AlignInBits, unsigned Flags, DIArray Elements,
545 unsigned RunTimeLang) {
546 // TAG_union_type is encoded in DICompositeType format.
548 GetTagConstant(VMContext, dwarf::DW_TAG_union_type),
549 getNonCompileUnitScope(Scope),
550 MDString::get(VMContext, Name),
552 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
553 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
554 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
555 ConstantInt::get(Type::getInt64Ty(VMContext), 0),
556 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
559 ConstantInt::get(Type::getInt32Ty(VMContext), RunTimeLang),
560 Constant::getNullValue(Type::getInt32Ty(VMContext))
562 return DICompositeType(MDNode::get(VMContext, Elts));
565 /// createSubroutineType - Create subroutine type.
567 DIBuilder::createSubroutineType(DIFile File, DIArray ParameterTypes) {
568 // TAG_subroutine_type is encoded in DICompositeType format.
570 GetTagConstant(VMContext, dwarf::DW_TAG_subroutine_type),
571 Constant::getNullValue(Type::getInt32Ty(VMContext)),
572 MDString::get(VMContext, ""),
573 Constant::getNullValue(Type::getInt32Ty(VMContext)),
574 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
575 ConstantInt::get(Type::getInt64Ty(VMContext), 0),
576 ConstantInt::get(Type::getInt64Ty(VMContext), 0),
577 ConstantInt::get(Type::getInt64Ty(VMContext), 0),
578 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
581 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
582 Constant::getNullValue(Type::getInt32Ty(VMContext))
584 return DICompositeType(MDNode::get(VMContext, Elts));
587 /// createEnumerationType - Create debugging information entry for an
589 DICompositeType DIBuilder::createEnumerationType(
590 DIDescriptor Scope, StringRef Name, DIFile File, unsigned LineNumber,
591 uint64_t SizeInBits, uint64_t AlignInBits, DIArray Elements,
593 // TAG_enumeration_type is encoded in DICompositeType format.
595 GetTagConstant(VMContext, dwarf::DW_TAG_enumeration_type),
596 getNonCompileUnitScope(Scope),
597 MDString::get(VMContext, Name),
599 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
600 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
601 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
602 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
603 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
606 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
607 Constant::getNullValue(Type::getInt32Ty(VMContext))
609 MDNode *Node = MDNode::get(VMContext, Elts);
610 AllEnumTypes.push_back(Node);
611 return DICompositeType(Node);
614 /// createArrayType - Create debugging information entry for an array.
615 DICompositeType DIBuilder::createArrayType(uint64_t Size, uint64_t AlignInBits,
616 DIType Ty, DIArray Subscripts) {
617 // TAG_array_type is encoded in DICompositeType format.
619 GetTagConstant(VMContext, dwarf::DW_TAG_array_type),
621 MDString::get(VMContext, ""),
623 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
624 ConstantInt::get(Type::getInt64Ty(VMContext), Size),
625 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
626 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
627 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
630 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
631 Constant::getNullValue(Type::getInt32Ty(VMContext))
633 return DICompositeType(MDNode::get(VMContext, Elts));
636 /// createVectorType - Create debugging information entry for a vector.
637 DIType DIBuilder::createVectorType(uint64_t Size, uint64_t AlignInBits,
638 DIType Ty, DIArray Subscripts) {
640 // A vector is an array type with the FlagVector flag applied.
642 GetTagConstant(VMContext, dwarf::DW_TAG_array_type),
644 MDString::get(VMContext, ""),
646 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
647 ConstantInt::get(Type::getInt64Ty(VMContext), Size),
648 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
649 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
650 ConstantInt::get(Type::getInt32Ty(VMContext), DIType::FlagVector),
653 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
654 Constant::getNullValue(Type::getInt32Ty(VMContext))
656 return DIType(MDNode::get(VMContext, Elts));
659 /// createArtificialType - Create a new DIType with "artificial" flag set.
660 DIType DIBuilder::createArtificialType(DIType Ty) {
661 if (Ty.isArtificial())
664 SmallVector<Value *, 9> Elts;
666 assert (N && "Unexpected input DIType!");
667 for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i) {
668 if (Value *V = N->getOperand(i))
671 Elts.push_back(Constant::getNullValue(Type::getInt32Ty(VMContext)));
674 unsigned CurFlags = Ty.getFlags();
675 CurFlags = CurFlags | DIType::FlagArtificial;
677 // Flags are stored at this slot.
678 Elts[8] = ConstantInt::get(Type::getInt32Ty(VMContext), CurFlags);
680 return DIType(MDNode::get(VMContext, Elts));
683 /// createObjectPointerType - Create a new type with both the object pointer
684 /// and artificial flags set.
685 DIType DIBuilder::createObjectPointerType(DIType Ty) {
686 if (Ty.isObjectPointer())
689 SmallVector<Value *, 9> Elts;
691 assert (N && "Unexpected input DIType!");
692 for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i) {
693 if (Value *V = N->getOperand(i))
696 Elts.push_back(Constant::getNullValue(Type::getInt32Ty(VMContext)));
699 unsigned CurFlags = Ty.getFlags();
700 CurFlags = CurFlags | (DIType::FlagObjectPointer | DIType::FlagArtificial);
702 // Flags are stored at this slot.
703 Elts[8] = ConstantInt::get(Type::getInt32Ty(VMContext), CurFlags);
705 return DIType(MDNode::get(VMContext, Elts));
708 /// retainType - Retain DIType in a module even if it is not referenced
709 /// through debug info anchors.
710 void DIBuilder::retainType(DIType T) {
711 AllRetainTypes.push_back(T);
714 /// createUnspecifiedParameter - Create unspeicified type descriptor
715 /// for the subroutine type.
716 DIDescriptor DIBuilder::createUnspecifiedParameter() {
718 GetTagConstant(VMContext, dwarf::DW_TAG_unspecified_parameters)
720 return DIDescriptor(MDNode::get(VMContext, Elts));
723 /// createTemporaryType - Create a temporary forward-declared type.
724 DIType DIBuilder::createTemporaryType() {
725 // Give the temporary MDNode a tag. It doesn't matter what tag we
726 // use here as long as DIType accepts it.
727 Value *Elts[] = { GetTagConstant(VMContext, DW_TAG_base_type) };
728 MDNode *Node = MDNode::getTemporary(VMContext, Elts);
732 /// createTemporaryType - Create a temporary forward-declared type.
733 DIType DIBuilder::createTemporaryType(DIFile F) {
734 // Give the temporary MDNode a tag. It doesn't matter what tag we
735 // use here as long as DIType accepts it.
737 GetTagConstant(VMContext, DW_TAG_base_type),
742 MDNode *Node = MDNode::getTemporary(VMContext, Elts);
746 /// createForwardDecl - Create a temporary forward-declared type that
747 /// can be RAUW'd if the full type is seen.
748 DIType DIBuilder::createForwardDecl(unsigned Tag, StringRef Name,
749 DIDescriptor Scope, DIFile F,
750 unsigned Line, unsigned RuntimeLang,
752 uint64_t AlignInBits) {
753 // Create a temporary MDNode.
755 GetTagConstant(VMContext, Tag),
756 getNonCompileUnitScope(Scope),
757 MDString::get(VMContext, Name),
759 ConstantInt::get(Type::getInt32Ty(VMContext), Line),
760 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
761 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
762 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
763 ConstantInt::get(Type::getInt32Ty(VMContext),
764 DIDescriptor::FlagFwdDecl),
767 ConstantInt::get(Type::getInt32Ty(VMContext), RuntimeLang)
769 MDNode *Node = MDNode::getTemporary(VMContext, Elts);
770 assert(DIType(Node).Verify() &&
771 "createForwardDecl result should be verifiable");
775 /// getOrCreateArray - Get a DIArray, create one if required.
776 DIArray DIBuilder::getOrCreateArray(ArrayRef<Value *> Elements) {
777 if (Elements.empty()) {
778 Value *Null = Constant::getNullValue(Type::getInt32Ty(VMContext));
779 return DIArray(MDNode::get(VMContext, Null));
781 return DIArray(MDNode::get(VMContext, Elements));
784 /// getOrCreateSubrange - Create a descriptor for a value range. This
785 /// implicitly uniques the values returned.
786 DISubrange DIBuilder::getOrCreateSubrange(int64_t Lo, int64_t Count) {
788 GetTagConstant(VMContext, dwarf::DW_TAG_subrange_type),
789 ConstantInt::get(Type::getInt64Ty(VMContext), Lo),
790 ConstantInt::get(Type::getInt64Ty(VMContext), Count)
793 return DISubrange(MDNode::get(VMContext, Elts));
796 /// createGlobalVariable - Create a new descriptor for the specified global.
797 DIGlobalVariable DIBuilder::
798 createGlobalVariable(StringRef Name, DIFile F, unsigned LineNumber,
799 DIType Ty, bool isLocalToUnit, Value *Val) {
801 GetTagConstant(VMContext, dwarf::DW_TAG_variable),
802 Constant::getNullValue(Type::getInt32Ty(VMContext)),
804 MDString::get(VMContext, Name),
805 MDString::get(VMContext, Name),
806 MDString::get(VMContext, Name),
808 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
810 ConstantInt::get(Type::getInt32Ty(VMContext), isLocalToUnit),
811 ConstantInt::get(Type::getInt32Ty(VMContext), 1), /* isDefinition*/
815 MDNode *Node = MDNode::get(VMContext, Elts);
816 AllGVs.push_back(Node);
817 return DIGlobalVariable(Node);
820 /// createStaticVariable - Create a new descriptor for the specified static
822 DIGlobalVariable DIBuilder::
823 createStaticVariable(DIDescriptor Context, StringRef Name,
824 StringRef LinkageName, DIFile F, unsigned LineNumber,
825 DIType Ty, bool isLocalToUnit, Value *Val, MDNode *Decl) {
827 GetTagConstant(VMContext, dwarf::DW_TAG_variable),
828 Constant::getNullValue(Type::getInt32Ty(VMContext)),
829 getNonCompileUnitScope(Context),
830 MDString::get(VMContext, Name),
831 MDString::get(VMContext, Name),
832 MDString::get(VMContext, LinkageName),
834 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
836 ConstantInt::get(Type::getInt32Ty(VMContext), isLocalToUnit),
837 ConstantInt::get(Type::getInt32Ty(VMContext), 1), /* isDefinition*/
841 MDNode *Node = MDNode::get(VMContext, Elts);
842 AllGVs.push_back(Node);
843 return DIGlobalVariable(Node);
846 /// createVariable - Create a new descriptor for the specified variable.
847 DIVariable DIBuilder::createLocalVariable(unsigned Tag, DIDescriptor Scope,
848 StringRef Name, DIFile File,
849 unsigned LineNo, DIType Ty,
850 bool AlwaysPreserve, unsigned Flags,
852 DIDescriptor Context(getNonCompileUnitScope(Scope));
853 assert((!Context || Context.Verify()) &&
854 "createLocalVariable should be called with a valid Context");
855 assert(Ty.Verify() &&
856 "createLocalVariable should be called with a valid type");
858 GetTagConstant(VMContext, Tag),
859 getNonCompileUnitScope(Scope),
860 MDString::get(VMContext, Name),
862 ConstantInt::get(Type::getInt32Ty(VMContext), (LineNo | (ArgNo << 24))),
864 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
865 Constant::getNullValue(Type::getInt32Ty(VMContext))
867 MDNode *Node = MDNode::get(VMContext, Elts);
868 if (AlwaysPreserve) {
869 // The optimizer may remove local variable. If there is an interest
870 // to preserve variable info in such situation then stash it in a
872 DISubprogram Fn(getDISubprogram(Scope));
873 NamedMDNode *FnLocals = getOrInsertFnSpecificMDNode(M, Fn);
874 FnLocals->addOperand(Node);
876 assert(DIVariable(Node).Verify() &&
877 "createLocalVariable should return a verifiable DIVariable");
878 return DIVariable(Node);
881 /// createComplexVariable - Create a new descriptor for the specified variable
882 /// which has a complex address expression for its address.
883 DIVariable DIBuilder::createComplexVariable(unsigned Tag, DIDescriptor Scope,
884 StringRef Name, DIFile F,
886 DIType Ty, ArrayRef<Value *> Addr,
888 SmallVector<Value *, 15> Elts;
889 Elts.push_back(GetTagConstant(VMContext, Tag));
890 Elts.push_back(getNonCompileUnitScope(Scope)),
891 Elts.push_back(MDString::get(VMContext, Name));
893 Elts.push_back(ConstantInt::get(Type::getInt32Ty(VMContext),
894 (LineNo | (ArgNo << 24))));
896 Elts.push_back(Constant::getNullValue(Type::getInt32Ty(VMContext)));
897 Elts.push_back(Constant::getNullValue(Type::getInt32Ty(VMContext)));
898 Elts.append(Addr.begin(), Addr.end());
900 return DIVariable(MDNode::get(VMContext, Elts));
903 /// createFunction - Create a new descriptor for the specified function.
904 DISubprogram DIBuilder::createFunction(DIDescriptor Context,
906 StringRef LinkageName,
907 DIFile File, unsigned LineNo,
909 bool isLocalToUnit, bool isDefinition,
911 unsigned Flags, bool isOptimized,
915 Value *TElts[] = { GetTagConstant(VMContext, DW_TAG_base_type) };
917 GetTagConstant(VMContext, dwarf::DW_TAG_subprogram),
918 Constant::getNullValue(Type::getInt32Ty(VMContext)),
919 getNonCompileUnitScope(Context),
920 MDString::get(VMContext, Name),
921 MDString::get(VMContext, Name),
922 MDString::get(VMContext, LinkageName),
924 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
926 ConstantInt::get(Type::getInt1Ty(VMContext), isLocalToUnit),
927 ConstantInt::get(Type::getInt1Ty(VMContext), isDefinition),
928 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
929 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
931 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
932 ConstantInt::get(Type::getInt1Ty(VMContext), isOptimized),
936 MDNode::getTemporary(VMContext, TElts),
937 ConstantInt::get(Type::getInt32Ty(VMContext), ScopeLine)
939 MDNode *Node = MDNode::get(VMContext, Elts);
941 // Create a named metadata so that we do not lose this mdnode.
943 AllSubprograms.push_back(Node);
944 return DISubprogram(Node);
947 /// createMethod - Create a new descriptor for the specified C++ method.
948 DISubprogram DIBuilder::createMethod(DIDescriptor Context,
950 StringRef LinkageName,
952 unsigned LineNo, DIType Ty,
955 unsigned VK, unsigned VIndex,
956 MDNode *VTableHolder,
961 Value *TElts[] = { GetTagConstant(VMContext, DW_TAG_base_type) };
963 GetTagConstant(VMContext, dwarf::DW_TAG_subprogram),
964 Constant::getNullValue(Type::getInt32Ty(VMContext)),
965 getNonCompileUnitScope(Context),
966 MDString::get(VMContext, Name),
967 MDString::get(VMContext, Name),
968 MDString::get(VMContext, LinkageName),
970 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
972 ConstantInt::get(Type::getInt1Ty(VMContext), isLocalToUnit),
973 ConstantInt::get(Type::getInt1Ty(VMContext), isDefinition),
974 ConstantInt::get(Type::getInt32Ty(VMContext), (unsigned)VK),
975 ConstantInt::get(Type::getInt32Ty(VMContext), VIndex),
977 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
978 ConstantInt::get(Type::getInt1Ty(VMContext), isOptimized),
981 Constant::getNullValue(Type::getInt32Ty(VMContext)),
982 MDNode::getTemporary(VMContext, TElts),
983 // FIXME: Do we want to use different scope/lines?
984 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo)
986 MDNode *Node = MDNode::get(VMContext, Elts);
988 AllSubprograms.push_back(Node);
989 return DISubprogram(Node);
992 /// createNameSpace - This creates new descriptor for a namespace
993 /// with the specified parent scope.
994 DINameSpace DIBuilder::createNameSpace(DIDescriptor Scope, StringRef Name,
995 DIFile File, unsigned LineNo) {
997 GetTagConstant(VMContext, dwarf::DW_TAG_namespace),
998 getNonCompileUnitScope(Scope),
999 MDString::get(VMContext, Name),
1001 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo)
1003 DINameSpace R(MDNode::get(VMContext, Elts));
1004 assert(R.Verify() &&
1005 "createNameSpace should return a verifiable DINameSpace");
1009 /// createLexicalBlockFile - This creates a new MDNode that encapsulates
1010 /// an existing scope with a new filename.
1011 DILexicalBlockFile DIBuilder::createLexicalBlockFile(DIDescriptor Scope,
1014 GetTagConstant(VMContext, dwarf::DW_TAG_lexical_block),
1018 DILexicalBlockFile R(MDNode::get(VMContext, Elts));
1021 "createLexicalBlockFile should return a verifiable DILexicalBlockFile");
1025 DILexicalBlock DIBuilder::createLexicalBlock(DIDescriptor Scope, DIFile File,
1026 unsigned Line, unsigned Col) {
1027 // Defeat MDNode uniqing for lexical blocks by using unique id.
1028 static unsigned int unique_id = 0;
1030 GetTagConstant(VMContext, dwarf::DW_TAG_lexical_block),
1031 getNonCompileUnitScope(Scope),
1032 ConstantInt::get(Type::getInt32Ty(VMContext), Line),
1033 ConstantInt::get(Type::getInt32Ty(VMContext), Col),
1035 ConstantInt::get(Type::getInt32Ty(VMContext), unique_id++)
1037 DILexicalBlock R(MDNode::get(VMContext, Elts));
1038 assert(R.Verify() &&
1039 "createLexicalBlock should return a verifiable DILexicalBlock");
1043 /// insertDeclare - Insert a new llvm.dbg.declare intrinsic call.
1044 Instruction *DIBuilder::insertDeclare(Value *Storage, DIVariable VarInfo,
1045 Instruction *InsertBefore) {
1046 assert(Storage && "no storage passed to dbg.declare");
1047 assert(VarInfo.Verify() && "empty DIVariable passed to dbg.declare");
1049 DeclareFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_declare);
1051 Value *Args[] = { MDNode::get(Storage->getContext(), Storage), VarInfo };
1052 return CallInst::Create(DeclareFn, Args, "", InsertBefore);
1055 /// insertDeclare - Insert a new llvm.dbg.declare intrinsic call.
1056 Instruction *DIBuilder::insertDeclare(Value *Storage, DIVariable VarInfo,
1057 BasicBlock *InsertAtEnd) {
1058 assert(Storage && "no storage passed to dbg.declare");
1059 assert(VarInfo.Verify() && "invalid DIVariable passed to dbg.declare");
1061 DeclareFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_declare);
1063 Value *Args[] = { MDNode::get(Storage->getContext(), Storage), VarInfo };
1065 // If this block already has a terminator then insert this intrinsic
1066 // before the terminator.
1067 if (TerminatorInst *T = InsertAtEnd->getTerminator())
1068 return CallInst::Create(DeclareFn, Args, "", T);
1070 return CallInst::Create(DeclareFn, Args, "", InsertAtEnd);
1073 /// insertDbgValueIntrinsic - Insert a new llvm.dbg.value intrinsic call.
1074 Instruction *DIBuilder::insertDbgValueIntrinsic(Value *V, uint64_t Offset,
1076 Instruction *InsertBefore) {
1077 assert(V && "no value passed to dbg.value");
1078 assert(VarInfo.Verify() && "invalid DIVariable passed to dbg.value");
1080 ValueFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_value);
1082 Value *Args[] = { MDNode::get(V->getContext(), V),
1083 ConstantInt::get(Type::getInt64Ty(V->getContext()), Offset),
1085 return CallInst::Create(ValueFn, Args, "", InsertBefore);
1088 /// insertDbgValueIntrinsic - Insert a new llvm.dbg.value intrinsic call.
1089 Instruction *DIBuilder::insertDbgValueIntrinsic(Value *V, uint64_t Offset,
1091 BasicBlock *InsertAtEnd) {
1092 assert(V && "no value passed to dbg.value");
1093 assert(VarInfo.Verify() && "invalid DIVariable passed to dbg.value");
1095 ValueFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_value);
1097 Value *Args[] = { MDNode::get(V->getContext(), V),
1098 ConstantInt::get(Type::getInt64Ty(V->getContext()), Offset),
1100 return CallInst::Create(ValueFn, Args, "", InsertAtEnd);