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,
230 // Pointer types are encoded in DIDerivedType format.
232 GetTagConstant(VMContext, dwarf::DW_TAG_ptr_to_member_type),
236 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
237 ConstantInt::get(Type::getInt64Ty(VMContext), 0),
238 ConstantInt::get(Type::getInt64Ty(VMContext), 0),
239 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
240 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags
244 return DIDerivedType(MDNode::get(VMContext, Elts));
247 /// createReferenceType - Create debugging information entry for a reference
249 DIDerivedType DIBuilder::createReferenceType(unsigned Tag, DIType RTy) {
250 assert(RTy.Verify() && "Unable to create reference type");
251 // References are encoded in DIDerivedType format.
253 GetTagConstant(VMContext, Tag),
257 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
258 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Size
259 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Align
260 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
261 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags
264 return DIDerivedType(MDNode::get(VMContext, Elts));
267 /// createTypedef - Create debugging information entry for a typedef.
268 DIDerivedType DIBuilder::createTypedef(DIType Ty, StringRef Name, DIFile File,
269 unsigned LineNo, DIDescriptor Context) {
270 // typedefs are encoded in DIDerivedType format.
271 assert(Ty.Verify() && "Invalid typedef type!");
273 GetTagConstant(VMContext, dwarf::DW_TAG_typedef),
275 getNonCompileUnitScope(Context),
276 MDString::get(VMContext, Name),
277 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
278 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Size
279 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Align
280 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
281 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags
284 return DIDerivedType(MDNode::get(VMContext, Elts));
287 /// createFriend - Create debugging information entry for a 'friend'.
288 DIType DIBuilder::createFriend(DIType Ty, DIType FriendTy) {
289 // typedefs are encoded in DIDerivedType format.
290 assert(Ty.Verify() && "Invalid type!");
291 assert(FriendTy.Verify() && "Invalid friend type!");
293 GetTagConstant(VMContext, dwarf::DW_TAG_friend),
297 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
298 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Size
299 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Align
300 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
301 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags
304 return DIType(MDNode::get(VMContext, Elts));
307 /// createInheritance - Create debugging information entry to establish
308 /// inheritance relationship between two types.
309 DIDerivedType DIBuilder::createInheritance(
310 DIType Ty, DIType BaseTy, uint64_t BaseOffset, unsigned Flags) {
311 assert(Ty.Verify() && "Unable to create inheritance");
312 // TAG_inheritance is encoded in DIDerivedType format.
314 GetTagConstant(VMContext, dwarf::DW_TAG_inheritance),
318 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
319 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Size
320 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Align
321 ConstantInt::get(Type::getInt64Ty(VMContext), BaseOffset),
322 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
325 return DIDerivedType(MDNode::get(VMContext, Elts));
328 /// createMemberType - Create debugging information entry for a member.
329 DIDerivedType DIBuilder::createMemberType(
330 DIDescriptor Scope, StringRef Name, DIFile File, unsigned LineNumber,
331 uint64_t SizeInBits, uint64_t AlignInBits, uint64_t OffsetInBits,
332 unsigned Flags, DIType Ty) {
333 // TAG_member is encoded in DIDerivedType format.
335 GetTagConstant(VMContext, dwarf::DW_TAG_member),
337 getNonCompileUnitScope(Scope),
338 MDString::get(VMContext, Name),
339 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
340 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
341 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
342 ConstantInt::get(Type::getInt64Ty(VMContext), OffsetInBits),
343 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
346 return DIDerivedType(MDNode::get(VMContext, Elts));
349 /// createStaticMemberType - Create debugging information entry for a
350 /// C++ static data member.
351 DIType DIBuilder::createStaticMemberType(DIDescriptor Scope, StringRef Name,
352 DIFile File, unsigned LineNumber,
353 DIType Ty, unsigned Flags,
355 // TAG_member is encoded in DIDerivedType format.
356 Flags |= DIDescriptor::FlagStaticMember;
358 GetTagConstant(VMContext, dwarf::DW_TAG_member),
360 getNonCompileUnitScope(Scope),
361 MDString::get(VMContext, Name),
362 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
363 ConstantInt::get(Type::getInt64Ty(VMContext), 0/*SizeInBits*/),
364 ConstantInt::get(Type::getInt64Ty(VMContext), 0/*AlignInBits*/),
365 ConstantInt::get(Type::getInt64Ty(VMContext), 0/*OffsetInBits*/),
366 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
370 return DIType(MDNode::get(VMContext, Elts));
373 /// createObjCIVar - Create debugging information entry for Objective-C
374 /// instance variable.
375 DIType DIBuilder::createObjCIVar(StringRef Name,
376 DIFile File, unsigned LineNumber,
377 uint64_t SizeInBits, uint64_t AlignInBits,
378 uint64_t OffsetInBits, unsigned Flags,
379 DIType Ty, StringRef PropertyName,
380 StringRef GetterName, StringRef SetterName,
381 unsigned PropertyAttributes) {
382 // TAG_member is encoded in DIDerivedType format.
384 GetTagConstant(VMContext, dwarf::DW_TAG_member),
386 getNonCompileUnitScope(File),
387 MDString::get(VMContext, Name),
388 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
389 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
390 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
391 ConstantInt::get(Type::getInt64Ty(VMContext), OffsetInBits),
392 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
394 MDString::get(VMContext, PropertyName),
395 MDString::get(VMContext, GetterName),
396 MDString::get(VMContext, SetterName),
397 ConstantInt::get(Type::getInt32Ty(VMContext), PropertyAttributes)
399 return DIType(MDNode::get(VMContext, Elts));
402 /// createObjCIVar - Create debugging information entry for Objective-C
403 /// instance variable.
404 DIType DIBuilder::createObjCIVar(StringRef Name,
405 DIFile File, unsigned LineNumber,
406 uint64_t SizeInBits, uint64_t AlignInBits,
407 uint64_t OffsetInBits, unsigned Flags,
408 DIType Ty, MDNode *PropertyNode) {
409 // TAG_member is encoded in DIDerivedType format.
411 GetTagConstant(VMContext, dwarf::DW_TAG_member),
413 getNonCompileUnitScope(File),
414 MDString::get(VMContext, Name),
415 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
416 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
417 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
418 ConstantInt::get(Type::getInt64Ty(VMContext), OffsetInBits),
419 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
423 return DIType(MDNode::get(VMContext, Elts));
426 /// createObjCProperty - Create debugging information entry for Objective-C
428 DIObjCProperty DIBuilder::createObjCProperty(StringRef Name,
429 DIFile File, unsigned LineNumber,
430 StringRef GetterName,
431 StringRef SetterName,
432 unsigned PropertyAttributes,
435 GetTagConstant(VMContext, dwarf::DW_TAG_APPLE_property),
436 MDString::get(VMContext, Name),
438 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
439 MDString::get(VMContext, GetterName),
440 MDString::get(VMContext, SetterName),
441 ConstantInt::get(Type::getInt32Ty(VMContext), PropertyAttributes),
444 return DIObjCProperty(MDNode::get(VMContext, Elts));
447 /// createTemplateTypeParameter - Create debugging information for template
449 DITemplateTypeParameter
450 DIBuilder::createTemplateTypeParameter(DIDescriptor Context, StringRef Name,
451 DIType Ty, MDNode *File, unsigned LineNo,
454 GetTagConstant(VMContext, dwarf::DW_TAG_template_type_parameter),
455 getNonCompileUnitScope(Context),
456 MDString::get(VMContext, Name),
459 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
460 ConstantInt::get(Type::getInt32Ty(VMContext), ColumnNo)
462 return DITemplateTypeParameter(MDNode::get(VMContext, Elts));
465 /// createTemplateValueParameter - Create debugging information for template
467 DITemplateValueParameter
468 DIBuilder::createTemplateValueParameter(DIDescriptor Context, StringRef Name,
469 DIType Ty, uint64_t Val,
470 MDNode *File, unsigned LineNo,
473 GetTagConstant(VMContext, dwarf::DW_TAG_template_value_parameter),
474 getNonCompileUnitScope(Context),
475 MDString::get(VMContext, Name),
477 ConstantInt::get(Type::getInt64Ty(VMContext), Val),
479 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
480 ConstantInt::get(Type::getInt32Ty(VMContext), ColumnNo)
482 return DITemplateValueParameter(MDNode::get(VMContext, Elts));
485 /// createClassType - Create debugging information entry for a class.
486 DICompositeType DIBuilder::createClassType(DIDescriptor Context, StringRef Name,
487 DIFile File, unsigned LineNumber,
489 uint64_t AlignInBits,
490 uint64_t OffsetInBits,
491 unsigned Flags, DIType DerivedFrom,
493 MDNode *VTableHolder,
494 MDNode *TemplateParams) {
495 assert((!Context || Context.Verify()) &&
496 "createClassType should be called with a valid Context");
497 // TAG_class_type is encoded in DICompositeType format.
499 GetTagConstant(VMContext, dwarf::DW_TAG_class_type),
501 getNonCompileUnitScope(Context),
502 MDString::get(VMContext, Name),
503 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
504 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
505 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
506 ConstantInt::get(Type::getInt32Ty(VMContext), OffsetInBits),
507 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
510 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
514 DICompositeType R(MDNode::get(VMContext, Elts));
515 assert(R.Verify() && "createClassType should return a verifiable DIType");
519 /// createStructType - Create debugging information entry for a struct.
520 DICompositeType DIBuilder::createStructType(DIDescriptor Context,
521 StringRef Name, DIFile File,
524 uint64_t AlignInBits,
525 unsigned Flags, DIType DerivedFrom,
527 unsigned RunTimeLang,
528 MDNode *VTableHolder) {
529 // TAG_structure_type is encoded in DICompositeType format.
531 GetTagConstant(VMContext, dwarf::DW_TAG_structure_type),
533 getNonCompileUnitScope(Context),
534 MDString::get(VMContext, Name),
535 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
536 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
537 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
538 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
539 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
542 ConstantInt::get(Type::getInt32Ty(VMContext), RunTimeLang),
546 DICompositeType R(MDNode::get(VMContext, Elts));
547 assert(R.Verify() && "createStructType should return a verifiable DIType");
551 /// createUnionType - Create debugging information entry for an union.
552 DICompositeType DIBuilder::createUnionType(DIDescriptor Scope, StringRef Name,
553 DIFile File, unsigned LineNumber,
555 uint64_t AlignInBits, unsigned Flags,
557 unsigned RunTimeLang) {
558 // TAG_union_type is encoded in DICompositeType format.
560 GetTagConstant(VMContext, dwarf::DW_TAG_union_type),
562 getNonCompileUnitScope(Scope),
563 MDString::get(VMContext, Name),
564 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
565 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
566 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
567 ConstantInt::get(Type::getInt64Ty(VMContext), 0),
568 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
571 ConstantInt::get(Type::getInt32Ty(VMContext), RunTimeLang),
572 Constant::getNullValue(Type::getInt32Ty(VMContext)),
575 return DICompositeType(MDNode::get(VMContext, Elts));
578 /// createSubroutineType - Create subroutine type.
580 DIBuilder::createSubroutineType(DIFile File, DIArray ParameterTypes) {
581 // TAG_subroutine_type is encoded in DICompositeType format.
583 GetTagConstant(VMContext, dwarf::DW_TAG_subroutine_type),
584 Constant::getNullValue(Type::getInt32Ty(VMContext)),
585 Constant::getNullValue(Type::getInt32Ty(VMContext)),
586 MDString::get(VMContext, ""),
587 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
588 ConstantInt::get(Type::getInt64Ty(VMContext), 0),
589 ConstantInt::get(Type::getInt64Ty(VMContext), 0),
590 ConstantInt::get(Type::getInt64Ty(VMContext), 0),
591 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
594 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
595 Constant::getNullValue(Type::getInt32Ty(VMContext))
597 return DICompositeType(MDNode::get(VMContext, Elts));
600 /// createEnumerationType - Create debugging information entry for an
602 DICompositeType DIBuilder::createEnumerationType(
603 DIDescriptor Scope, StringRef Name, DIFile File, unsigned LineNumber,
604 uint64_t SizeInBits, uint64_t AlignInBits, DIArray Elements,
605 DIType UnderlyingType) {
606 // TAG_enumeration_type is encoded in DICompositeType format.
608 GetTagConstant(VMContext, dwarf::DW_TAG_enumeration_type),
610 getNonCompileUnitScope(Scope),
611 MDString::get(VMContext, Name),
612 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
613 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
614 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
615 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
616 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
619 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
620 Constant::getNullValue(Type::getInt32Ty(VMContext))
622 MDNode *Node = MDNode::get(VMContext, Elts);
623 AllEnumTypes.push_back(Node);
624 return DICompositeType(Node);
627 /// createArrayType - Create debugging information entry for an array.
628 DICompositeType DIBuilder::createArrayType(uint64_t Size, uint64_t AlignInBits,
629 DIType Ty, DIArray Subscripts) {
630 // TAG_array_type is encoded in DICompositeType format.
632 GetTagConstant(VMContext, dwarf::DW_TAG_array_type),
633 NULL, // Filename/Directory,
635 MDString::get(VMContext, ""),
636 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
637 ConstantInt::get(Type::getInt64Ty(VMContext), Size),
638 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
639 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
640 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
643 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
644 Constant::getNullValue(Type::getInt32Ty(VMContext))
646 return DICompositeType(MDNode::get(VMContext, Elts));
649 /// createVectorType - Create debugging information entry for a vector.
650 DIType DIBuilder::createVectorType(uint64_t Size, uint64_t AlignInBits,
651 DIType Ty, DIArray Subscripts) {
653 // A vector is an array type with the FlagVector flag applied.
655 GetTagConstant(VMContext, dwarf::DW_TAG_array_type),
656 NULL, // Filename/Directory,
658 MDString::get(VMContext, ""),
659 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
660 ConstantInt::get(Type::getInt64Ty(VMContext), Size),
661 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
662 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
663 ConstantInt::get(Type::getInt32Ty(VMContext), DIType::FlagVector),
666 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
667 Constant::getNullValue(Type::getInt32Ty(VMContext))
669 return DIType(MDNode::get(VMContext, Elts));
672 /// createArtificialType - Create a new DIType with "artificial" flag set.
673 DIType DIBuilder::createArtificialType(DIType Ty) {
674 if (Ty.isArtificial())
677 SmallVector<Value *, 9> Elts;
679 assert (N && "Unexpected input DIType!");
680 for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i) {
681 if (Value *V = N->getOperand(i))
684 Elts.push_back(Constant::getNullValue(Type::getInt32Ty(VMContext)));
687 unsigned CurFlags = Ty.getFlags();
688 CurFlags = CurFlags | DIType::FlagArtificial;
690 // Flags are stored at this slot.
691 Elts[8] = ConstantInt::get(Type::getInt32Ty(VMContext), CurFlags);
693 return DIType(MDNode::get(VMContext, Elts));
696 /// createObjectPointerType - Create a new type with both the object pointer
697 /// and artificial flags set.
698 DIType DIBuilder::createObjectPointerType(DIType Ty) {
699 if (Ty.isObjectPointer())
702 SmallVector<Value *, 9> Elts;
704 assert (N && "Unexpected input DIType!");
705 for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i) {
706 if (Value *V = N->getOperand(i))
709 Elts.push_back(Constant::getNullValue(Type::getInt32Ty(VMContext)));
712 unsigned CurFlags = Ty.getFlags();
713 CurFlags = CurFlags | (DIType::FlagObjectPointer | DIType::FlagArtificial);
715 // Flags are stored at this slot.
716 Elts[8] = ConstantInt::get(Type::getInt32Ty(VMContext), CurFlags);
718 return DIType(MDNode::get(VMContext, Elts));
721 /// retainType - Retain DIType in a module even if it is not referenced
722 /// through debug info anchors.
723 void DIBuilder::retainType(DIType T) {
724 AllRetainTypes.push_back(T);
727 /// createUnspecifiedParameter - Create unspeicified type descriptor
728 /// for the subroutine type.
729 DIDescriptor DIBuilder::createUnspecifiedParameter() {
731 GetTagConstant(VMContext, dwarf::DW_TAG_unspecified_parameters)
733 return DIDescriptor(MDNode::get(VMContext, Elts));
736 /// createForwardDecl - Create a temporary forward-declared type that
737 /// can be RAUW'd if the full type is seen.
738 DIType DIBuilder::createForwardDecl(unsigned Tag, StringRef Name,
739 DIDescriptor Scope, DIFile F,
740 unsigned Line, unsigned RuntimeLang,
742 uint64_t AlignInBits) {
743 // Create a temporary MDNode.
745 GetTagConstant(VMContext, Tag),
747 getNonCompileUnitScope(Scope),
748 MDString::get(VMContext, Name),
749 ConstantInt::get(Type::getInt32Ty(VMContext), Line),
750 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
751 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
752 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
753 ConstantInt::get(Type::getInt32Ty(VMContext),
754 DIDescriptor::FlagFwdDecl),
757 ConstantInt::get(Type::getInt32Ty(VMContext), RuntimeLang)
759 MDNode *Node = MDNode::getTemporary(VMContext, Elts);
760 assert(DIType(Node).Verify() &&
761 "createForwardDecl result should be verifiable");
765 /// getOrCreateArray - Get a DIArray, create one if required.
766 DIArray DIBuilder::getOrCreateArray(ArrayRef<Value *> Elements) {
767 if (Elements.empty()) {
768 Value *Null = Constant::getNullValue(Type::getInt32Ty(VMContext));
769 return DIArray(MDNode::get(VMContext, Null));
771 return DIArray(MDNode::get(VMContext, Elements));
774 /// getOrCreateSubrange - Create a descriptor for a value range. This
775 /// implicitly uniques the values returned.
776 DISubrange DIBuilder::getOrCreateSubrange(int64_t Lo, int64_t Count) {
778 GetTagConstant(VMContext, dwarf::DW_TAG_subrange_type),
779 ConstantInt::get(Type::getInt64Ty(VMContext), Lo),
780 ConstantInt::get(Type::getInt64Ty(VMContext), Count)
783 return DISubrange(MDNode::get(VMContext, Elts));
786 /// \brief Create a new descriptor for the specified global.
787 DIGlobalVariable DIBuilder::
788 createGlobalVariable(StringRef Name, StringRef LinkageName, DIFile F,
789 unsigned LineNumber, DIType Ty, bool isLocalToUnit,
792 GetTagConstant(VMContext, dwarf::DW_TAG_variable),
793 Constant::getNullValue(Type::getInt32Ty(VMContext)),
795 MDString::get(VMContext, Name),
796 MDString::get(VMContext, Name),
797 MDString::get(VMContext, LinkageName),
799 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
801 ConstantInt::get(Type::getInt32Ty(VMContext), isLocalToUnit),
802 ConstantInt::get(Type::getInt32Ty(VMContext), 1), /* isDefinition*/
806 MDNode *Node = MDNode::get(VMContext, Elts);
807 AllGVs.push_back(Node);
808 return DIGlobalVariable(Node);
811 /// \brief Create a new descriptor for the specified global.
812 DIGlobalVariable DIBuilder::
813 createGlobalVariable(StringRef Name, DIFile F, unsigned LineNumber,
814 DIType Ty, bool isLocalToUnit, Value *Val) {
815 return createGlobalVariable(Name, Name, F, LineNumber, Ty, isLocalToUnit,
819 /// createStaticVariable - Create a new descriptor for the specified static
821 DIGlobalVariable DIBuilder::
822 createStaticVariable(DIDescriptor Context, StringRef Name,
823 StringRef LinkageName, DIFile F, unsigned LineNumber,
824 DIType Ty, bool isLocalToUnit, Value *Val, MDNode *Decl) {
826 GetTagConstant(VMContext, dwarf::DW_TAG_variable),
827 Constant::getNullValue(Type::getInt32Ty(VMContext)),
828 getNonCompileUnitScope(Context),
829 MDString::get(VMContext, Name),
830 MDString::get(VMContext, Name),
831 MDString::get(VMContext, LinkageName),
833 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
835 ConstantInt::get(Type::getInt32Ty(VMContext), isLocalToUnit),
836 ConstantInt::get(Type::getInt32Ty(VMContext), 1), /* isDefinition*/
840 MDNode *Node = MDNode::get(VMContext, Elts);
841 AllGVs.push_back(Node);
842 return DIGlobalVariable(Node);
845 /// createVariable - Create a new descriptor for the specified variable.
846 DIVariable DIBuilder::createLocalVariable(unsigned Tag, DIDescriptor Scope,
847 StringRef Name, DIFile File,
848 unsigned LineNo, DIType Ty,
849 bool AlwaysPreserve, unsigned Flags,
851 DIDescriptor Context(getNonCompileUnitScope(Scope));
852 assert((!Context || Context.Verify()) &&
853 "createLocalVariable should be called with a valid Context");
854 assert(Ty.Verify() &&
855 "createLocalVariable should be called with a valid type");
857 GetTagConstant(VMContext, Tag),
858 getNonCompileUnitScope(Scope),
859 MDString::get(VMContext, Name),
861 ConstantInt::get(Type::getInt32Ty(VMContext), (LineNo | (ArgNo << 24))),
863 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
864 Constant::getNullValue(Type::getInt32Ty(VMContext))
866 MDNode *Node = MDNode::get(VMContext, Elts);
867 if (AlwaysPreserve) {
868 // The optimizer may remove local variable. If there is an interest
869 // to preserve variable info in such situation then stash it in a
871 DISubprogram Fn(getDISubprogram(Scope));
872 NamedMDNode *FnLocals = getOrInsertFnSpecificMDNode(M, Fn);
873 FnLocals->addOperand(Node);
875 assert(DIVariable(Node).Verify() &&
876 "createLocalVariable should return a verifiable DIVariable");
877 return DIVariable(Node);
880 /// createComplexVariable - Create a new descriptor for the specified variable
881 /// which has a complex address expression for its address.
882 DIVariable DIBuilder::createComplexVariable(unsigned Tag, DIDescriptor Scope,
883 StringRef Name, DIFile F,
885 DIType Ty, ArrayRef<Value *> Addr,
887 SmallVector<Value *, 15> Elts;
888 Elts.push_back(GetTagConstant(VMContext, Tag));
889 Elts.push_back(getNonCompileUnitScope(Scope)),
890 Elts.push_back(MDString::get(VMContext, Name));
892 Elts.push_back(ConstantInt::get(Type::getInt32Ty(VMContext),
893 (LineNo | (ArgNo << 24))));
895 Elts.push_back(Constant::getNullValue(Type::getInt32Ty(VMContext)));
896 Elts.push_back(Constant::getNullValue(Type::getInt32Ty(VMContext)));
897 Elts.append(Addr.begin(), Addr.end());
899 return DIVariable(MDNode::get(VMContext, Elts));
902 /// createFunction - Create a new descriptor for the specified function.
903 DISubprogram DIBuilder::createFunction(DIDescriptor Context,
905 StringRef LinkageName,
906 DIFile File, unsigned LineNo,
908 bool isLocalToUnit, bool isDefinition,
910 unsigned Flags, bool isOptimized,
914 Value *TElts[] = { GetTagConstant(VMContext, DW_TAG_base_type) };
916 GetTagConstant(VMContext, dwarf::DW_TAG_subprogram),
918 getNonCompileUnitScope(Context),
919 MDString::get(VMContext, Name),
920 MDString::get(VMContext, Name),
921 MDString::get(VMContext, LinkageName),
922 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
924 ConstantInt::get(Type::getInt1Ty(VMContext), isLocalToUnit),
925 ConstantInt::get(Type::getInt1Ty(VMContext), isDefinition),
926 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
927 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
929 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
930 ConstantInt::get(Type::getInt1Ty(VMContext), isOptimized),
934 MDNode::getTemporary(VMContext, TElts),
935 ConstantInt::get(Type::getInt32Ty(VMContext), ScopeLine)
937 MDNode *Node = MDNode::get(VMContext, Elts);
939 // Create a named metadata so that we do not lose this mdnode.
941 AllSubprograms.push_back(Node);
942 DISubprogram S(Node);
943 assert(S.Verify() && "createFunction should return a valid DISubprogram");
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),
965 getNonCompileUnitScope(Context),
966 MDString::get(VMContext, Name),
967 MDString::get(VMContext, Name),
968 MDString::get(VMContext, LinkageName),
969 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
971 ConstantInt::get(Type::getInt1Ty(VMContext), isLocalToUnit),
972 ConstantInt::get(Type::getInt1Ty(VMContext), isDefinition),
973 ConstantInt::get(Type::getInt32Ty(VMContext), (unsigned)VK),
974 ConstantInt::get(Type::getInt32Ty(VMContext), VIndex),
976 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
977 ConstantInt::get(Type::getInt1Ty(VMContext), isOptimized),
980 Constant::getNullValue(Type::getInt32Ty(VMContext)),
981 MDNode::getTemporary(VMContext, TElts),
982 // FIXME: Do we want to use different scope/lines?
983 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo)
985 MDNode *Node = MDNode::get(VMContext, Elts);
987 AllSubprograms.push_back(Node);
988 DISubprogram S(Node);
989 assert(S.Verify() && "createMethod should return a valid DISubprogram");
993 /// createNameSpace - This creates new descriptor for a namespace
994 /// with the specified parent scope.
995 DINameSpace DIBuilder::createNameSpace(DIDescriptor Scope, StringRef Name,
996 DIFile File, unsigned LineNo) {
998 GetTagConstant(VMContext, dwarf::DW_TAG_namespace),
1000 getNonCompileUnitScope(Scope),
1001 MDString::get(VMContext, Name),
1002 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo)
1004 DINameSpace R(MDNode::get(VMContext, Elts));
1005 assert(R.Verify() &&
1006 "createNameSpace should return a verifiable DINameSpace");
1010 /// createLexicalBlockFile - This creates a new MDNode that encapsulates
1011 /// an existing scope with a new filename.
1012 DILexicalBlockFile DIBuilder::createLexicalBlockFile(DIDescriptor Scope,
1015 GetTagConstant(VMContext, dwarf::DW_TAG_lexical_block),
1019 DILexicalBlockFile R(MDNode::get(VMContext, Elts));
1022 "createLexicalBlockFile should return a verifiable DILexicalBlockFile");
1026 DILexicalBlock DIBuilder::createLexicalBlock(DIDescriptor Scope, DIFile File,
1027 unsigned Line, unsigned Col) {
1028 // Defeat MDNode uniqing for lexical blocks by using unique id.
1029 static unsigned int unique_id = 0;
1031 GetTagConstant(VMContext, dwarf::DW_TAG_lexical_block),
1033 getNonCompileUnitScope(Scope),
1034 ConstantInt::get(Type::getInt32Ty(VMContext), Line),
1035 ConstantInt::get(Type::getInt32Ty(VMContext), Col),
1036 ConstantInt::get(Type::getInt32Ty(VMContext), unique_id++)
1038 DILexicalBlock R(MDNode::get(VMContext, Elts));
1039 assert(R.Verify() &&
1040 "createLexicalBlock should return a verifiable DILexicalBlock");
1044 /// insertDeclare - Insert a new llvm.dbg.declare intrinsic call.
1045 Instruction *DIBuilder::insertDeclare(Value *Storage, DIVariable VarInfo,
1046 Instruction *InsertBefore) {
1047 assert(Storage && "no storage passed to dbg.declare");
1048 assert(VarInfo.Verify() && "empty DIVariable passed to dbg.declare");
1050 DeclareFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_declare);
1052 Value *Args[] = { MDNode::get(Storage->getContext(), Storage), VarInfo };
1053 return CallInst::Create(DeclareFn, Args, "", InsertBefore);
1056 /// insertDeclare - Insert a new llvm.dbg.declare intrinsic call.
1057 Instruction *DIBuilder::insertDeclare(Value *Storage, DIVariable VarInfo,
1058 BasicBlock *InsertAtEnd) {
1059 assert(Storage && "no storage passed to dbg.declare");
1060 assert(VarInfo.Verify() && "invalid DIVariable passed to dbg.declare");
1062 DeclareFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_declare);
1064 Value *Args[] = { MDNode::get(Storage->getContext(), Storage), VarInfo };
1066 // If this block already has a terminator then insert this intrinsic
1067 // before the terminator.
1068 if (TerminatorInst *T = InsertAtEnd->getTerminator())
1069 return CallInst::Create(DeclareFn, Args, "", T);
1071 return CallInst::Create(DeclareFn, Args, "", InsertAtEnd);
1074 /// insertDbgValueIntrinsic - Insert a new llvm.dbg.value intrinsic call.
1075 Instruction *DIBuilder::insertDbgValueIntrinsic(Value *V, uint64_t Offset,
1077 Instruction *InsertBefore) {
1078 assert(V && "no value passed to dbg.value");
1079 assert(VarInfo.Verify() && "invalid DIVariable passed to dbg.value");
1081 ValueFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_value);
1083 Value *Args[] = { MDNode::get(V->getContext(), V),
1084 ConstantInt::get(Type::getInt64Ty(V->getContext()), Offset),
1086 return CallInst::Create(ValueFn, Args, "", InsertBefore);
1089 /// insertDbgValueIntrinsic - Insert a new llvm.dbg.value intrinsic call.
1090 Instruction *DIBuilder::insertDbgValueIntrinsic(Value *V, uint64_t Offset,
1092 BasicBlock *InsertAtEnd) {
1093 assert(V && "no value passed to dbg.value");
1094 assert(VarInfo.Verify() && "invalid DIVariable passed to dbg.value");
1096 ValueFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_value);
1098 Value *Args[] = { MDNode::get(V->getContext(), V),
1099 ConstantInt::get(Type::getInt64Ty(V->getContext()), Offset),
1101 return CallInst::Create(ValueFn, Args, "", InsertAtEnd);