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 NULL, // Imported modules
108 ConstantInt::get(Type::getInt32Ty(VMContext), Lang),
109 MDString::get(VMContext, Producer),
110 ConstantInt::get(Type::getInt1Ty(VMContext), isOptimized),
111 MDString::get(VMContext, Flags),
112 ConstantInt::get(Type::getInt32Ty(VMContext), RunTimeVer),
117 MDString::get(VMContext, SplitName)
119 DICompileUnit CU(MDNode::get(VMContext, Elts));
120 assert(CU.Verify() && "The compile unit should be valid");
123 // Create a named metadata so that it is easier to find cu in a module.
124 NamedMDNode *NMD = M.getOrInsertNamedMetadata("llvm.dbg.cu");
125 NMD->addOperand(TheCU);
128 /// createFile - Create a file descriptor to hold debugging information
130 DIFile DIBuilder::createFile(StringRef Filename, StringRef Directory) {
132 GetTagConstant(VMContext, dwarf::DW_TAG_file_type),
133 createFilePathPair(VMContext, Filename, Directory),
134 NULL // Imported modules
136 DIFile F(MDNode::get(VMContext, Elts));
137 assert(F.Verify() && "The DIFile should be valid");
141 /// createEnumerator - Create a single enumerator value.
142 DIEnumerator DIBuilder::createEnumerator(StringRef Name, uint64_t Val) {
143 assert(!Name.empty() && "Unable to create enumerator without name");
145 GetTagConstant(VMContext, dwarf::DW_TAG_enumerator),
146 MDString::get(VMContext, Name),
147 ConstantInt::get(Type::getInt64Ty(VMContext), Val)
149 DIEnumerator E(MDNode::get(VMContext, Elts));
150 assert(E.Verify() && "The enumerator should be valid");
154 /// createNullPtrType - Create C++0x nullptr type.
155 DIType DIBuilder::createNullPtrType(StringRef Name) {
156 assert(!Name.empty() && "Unable to create type without name");
157 // nullptr is encoded in DIBasicType format. Line number, filename,
158 // ,size, alignment, offset and flags are always empty here.
160 GetTagConstant(VMContext, dwarf::DW_TAG_unspecified_type),
162 Constant::getNullValue(Type::getInt32Ty(VMContext)), // Imported modules
164 MDString::get(VMContext, Name),
165 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
166 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Size
167 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Align
168 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
169 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags;
170 ConstantInt::get(Type::getInt32Ty(VMContext), 0) // Encoding
172 DIType T(MDNode::get(VMContext, Elts));
173 assert(T.Verify() && "The nullptr type should be valid");
177 /// createBasicType - Create debugging information entry for a basic
178 /// type, e.g 'char'.
180 DIBuilder::createBasicType(StringRef Name, uint64_t SizeInBits,
181 uint64_t AlignInBits, unsigned Encoding) {
182 assert(!Name.empty() && "Unable to create type without name");
183 // Basic types are encoded in DIBasicType format. Line number, filename,
184 // offset and flags are always empty here.
186 GetTagConstant(VMContext, dwarf::DW_TAG_base_type),
187 NULL, // File/directory name
188 NULL, // Imported modules
190 MDString::get(VMContext, Name),
191 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
192 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
193 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
194 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
195 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags;
196 ConstantInt::get(Type::getInt32Ty(VMContext), Encoding)
198 DIBasicType T(MDNode::get(VMContext, Elts));
199 assert(T.Verify() && "The basic type should be valid");
203 /// createQualifiedType - Create debugging information entry for a qualified
204 /// type, e.g. 'const int'.
205 DIDerivedType DIBuilder::createQualifiedType(unsigned Tag, DIType FromTy) {
206 // Qualified types are encoded in DIDerivedType format.
208 GetTagConstant(VMContext, Tag),
210 NULL, // Imported modules
212 MDString::get(VMContext, StringRef()), // Empty name.
213 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
214 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Size
215 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Align
216 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
217 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags
220 DIDerivedType T(MDNode::get(VMContext, Elts));
221 assert(T.Verify() && "The derived type should be valid");
225 /// createPointerType - Create debugging information entry for a pointer.
227 DIBuilder::createPointerType(DIType PointeeTy, uint64_t SizeInBits,
228 uint64_t AlignInBits, StringRef Name) {
229 // Pointer types are encoded in DIDerivedType format.
231 GetTagConstant(VMContext, dwarf::DW_TAG_pointer_type),
233 NULL, // Imported modules
235 MDString::get(VMContext, Name),
236 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
237 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
238 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
239 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
240 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags
243 DIDerivedType T(MDNode::get(VMContext, Elts));
244 assert(T.Verify() && "The pointer type should be valid");
248 DIDerivedType DIBuilder::createMemberPointerType(DIType PointeeTy, DIType Base) {
249 // Pointer types are encoded in DIDerivedType format.
251 GetTagConstant(VMContext, dwarf::DW_TAG_ptr_to_member_type),
253 NULL, // Imported modules
256 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
257 ConstantInt::get(Type::getInt64Ty(VMContext), 0),
258 ConstantInt::get(Type::getInt64Ty(VMContext), 0),
259 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
260 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags
264 DIDerivedType T(MDNode::get(VMContext, Elts));
265 assert(T.Verify() && "The member pointer type should be valid");
269 /// createReferenceType - Create debugging information entry for a reference
271 DIDerivedType DIBuilder::createReferenceType(unsigned Tag, DIType RTy) {
272 assert(RTy.Verify() && "Unable to create reference type");
273 // References are encoded in DIDerivedType format.
275 GetTagConstant(VMContext, Tag),
277 NULL, // Imported modules
280 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
281 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Size
282 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Align
283 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
284 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags
287 DIDerivedType T(MDNode::get(VMContext, Elts));
288 assert(T.Verify() && "The reference type should be valid");
292 /// createTypedef - Create debugging information entry for a typedef.
293 DIDerivedType DIBuilder::createTypedef(DIType Ty, StringRef Name, DIFile File,
294 unsigned LineNo, DIDescriptor Context) {
295 // typedefs are encoded in DIDerivedType format.
296 assert(Ty.Verify() && "Invalid typedef type!");
298 GetTagConstant(VMContext, dwarf::DW_TAG_typedef),
300 NULL, // Imported modules
301 getNonCompileUnitScope(Context),
302 MDString::get(VMContext, Name),
303 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
304 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Size
305 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Align
306 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
307 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags
310 DIDerivedType T(MDNode::get(VMContext, Elts));
311 assert(T.Verify() && "The typedef Type should be valid");
315 /// createFriend - Create debugging information entry for a 'friend'.
316 DIType DIBuilder::createFriend(DIType Ty, DIType FriendTy) {
317 // typedefs are encoded in DIDerivedType format.
318 assert(Ty.Verify() && "Invalid type!");
319 assert(FriendTy.Verify() && "Invalid friend type!");
321 GetTagConstant(VMContext, dwarf::DW_TAG_friend),
323 NULL, // Imported modules
326 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
327 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Size
328 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Align
329 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
330 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags
333 DIType T(MDNode::get(VMContext, Elts));
334 assert(T.Verify() && "The friend type should be valid");
338 /// createInheritance - Create debugging information entry to establish
339 /// inheritance relationship between two types.
340 DIDerivedType DIBuilder::createInheritance(
341 DIType Ty, DIType BaseTy, uint64_t BaseOffset, unsigned Flags) {
342 assert(Ty.Verify() && "Unable to create inheritance");
343 // TAG_inheritance is encoded in DIDerivedType format.
345 GetTagConstant(VMContext, dwarf::DW_TAG_inheritance),
347 NULL, // Imported modules
350 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
351 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Size
352 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Align
353 ConstantInt::get(Type::getInt64Ty(VMContext), BaseOffset),
354 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
357 DIDerivedType T(MDNode::get(VMContext, Elts));
358 assert(T.Verify() && "The inheritance type should be valid");
362 /// createMemberType - Create debugging information entry for a member.
363 DIDerivedType DIBuilder::createMemberType(
364 DIDescriptor Scope, StringRef Name, DIFile File, unsigned LineNumber,
365 uint64_t SizeInBits, uint64_t AlignInBits, uint64_t OffsetInBits,
366 unsigned Flags, DIType Ty) {
367 // TAG_member is encoded in DIDerivedType format.
369 GetTagConstant(VMContext, dwarf::DW_TAG_member),
371 NULL, // Imported modules
372 getNonCompileUnitScope(Scope),
373 MDString::get(VMContext, Name),
374 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
375 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
376 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
377 ConstantInt::get(Type::getInt64Ty(VMContext), OffsetInBits),
378 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
381 DIDerivedType T(MDNode::get(VMContext, Elts));
382 assert(T.Verify() && "The member type should be valid");
386 /// createStaticMemberType - Create debugging information entry for a
387 /// C++ static data member.
388 DIType DIBuilder::createStaticMemberType(DIDescriptor Scope, StringRef Name,
389 DIFile File, unsigned LineNumber,
390 DIType Ty, unsigned Flags,
392 // TAG_member is encoded in DIDerivedType format.
393 Flags |= DIDescriptor::FlagStaticMember;
395 GetTagConstant(VMContext, dwarf::DW_TAG_member),
397 NULL, // Imported modules
398 getNonCompileUnitScope(Scope),
399 MDString::get(VMContext, Name),
400 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
401 ConstantInt::get(Type::getInt64Ty(VMContext), 0/*SizeInBits*/),
402 ConstantInt::get(Type::getInt64Ty(VMContext), 0/*AlignInBits*/),
403 ConstantInt::get(Type::getInt64Ty(VMContext), 0/*OffsetInBits*/),
404 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
408 DIType T(MDNode::get(VMContext, Elts));
409 assert(T.Verify() && "The static member type should be valid");
413 /// createObjCIVar - Create debugging information entry for Objective-C
414 /// instance variable.
415 DIType DIBuilder::createObjCIVar(StringRef Name,
416 DIFile File, unsigned LineNumber,
417 uint64_t SizeInBits, uint64_t AlignInBits,
418 uint64_t OffsetInBits, unsigned Flags,
419 DIType Ty, StringRef PropertyName,
420 StringRef GetterName, StringRef SetterName,
421 unsigned PropertyAttributes) {
422 // TAG_member is encoded in DIDerivedType format.
424 GetTagConstant(VMContext, dwarf::DW_TAG_member),
426 NULL, // Imported modules
427 getNonCompileUnitScope(File),
428 MDString::get(VMContext, Name),
429 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
430 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
431 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
432 ConstantInt::get(Type::getInt64Ty(VMContext), OffsetInBits),
433 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
435 MDString::get(VMContext, PropertyName),
436 MDString::get(VMContext, GetterName),
437 MDString::get(VMContext, SetterName),
438 ConstantInt::get(Type::getInt32Ty(VMContext), PropertyAttributes)
440 DIType T(MDNode::get(VMContext, Elts));
441 assert(T.Verify() && "The Objective-C IVar type should be valid");
445 /// createObjCIVar - Create debugging information entry for Objective-C
446 /// instance variable.
447 DIType DIBuilder::createObjCIVar(StringRef Name,
448 DIFile File, unsigned LineNumber,
449 uint64_t SizeInBits, uint64_t AlignInBits,
450 uint64_t OffsetInBits, unsigned Flags,
451 DIType Ty, MDNode *PropertyNode) {
452 // TAG_member is encoded in DIDerivedType format.
454 GetTagConstant(VMContext, dwarf::DW_TAG_member),
456 NULL, // Imported modules
457 getNonCompileUnitScope(File),
458 MDString::get(VMContext, Name),
459 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
460 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
461 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
462 ConstantInt::get(Type::getInt64Ty(VMContext), OffsetInBits),
463 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
467 DIType T(MDNode::get(VMContext, Elts));
468 assert(T.Verify() && "The Objective-C IVar type should be valid");
472 /// createObjCProperty - Create debugging information entry for Objective-C
474 DIObjCProperty DIBuilder::createObjCProperty(StringRef Name,
475 DIFile File, unsigned LineNumber,
476 StringRef GetterName,
477 StringRef SetterName,
478 unsigned PropertyAttributes,
481 GetTagConstant(VMContext, dwarf::DW_TAG_APPLE_property),
482 MDString::get(VMContext, Name),
484 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
485 MDString::get(VMContext, GetterName),
486 MDString::get(VMContext, SetterName),
487 ConstantInt::get(Type::getInt32Ty(VMContext), PropertyAttributes),
490 DIObjCProperty P(MDNode::get(VMContext, Elts));
491 assert(P.Verify() && "The Objective-C property should be valid");
495 /// createTemplateTypeParameter - Create debugging information for template
497 DITemplateTypeParameter
498 DIBuilder::createTemplateTypeParameter(DIDescriptor Context, StringRef Name,
499 DIType Ty, MDNode *File, unsigned LineNo,
502 GetTagConstant(VMContext, dwarf::DW_TAG_template_type_parameter),
503 getNonCompileUnitScope(Context),
504 MDString::get(VMContext, Name),
507 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
508 ConstantInt::get(Type::getInt32Ty(VMContext), ColumnNo)
510 DITemplateTypeParameter P(MDNode::get(VMContext, Elts));
511 assert(P.Verify() && "The template type parameter should be valid");
515 /// createTemplateValueParameter - Create debugging information for template
517 DITemplateValueParameter
518 DIBuilder::createTemplateValueParameter(DIDescriptor Context, StringRef Name,
519 DIType Ty, uint64_t Val,
520 MDNode *File, unsigned LineNo,
523 GetTagConstant(VMContext, dwarf::DW_TAG_template_value_parameter),
524 getNonCompileUnitScope(Context),
525 MDString::get(VMContext, Name),
527 ConstantInt::get(Type::getInt64Ty(VMContext), Val),
529 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
530 ConstantInt::get(Type::getInt32Ty(VMContext), ColumnNo)
532 DITemplateValueParameter P(MDNode::get(VMContext, Elts));
533 assert(P.Verify() && "The template value parameter should be valid");
537 /// createClassType - Create debugging information entry for a class.
538 DICompositeType DIBuilder::createClassType(DIDescriptor Context, StringRef Name,
539 DIFile File, unsigned LineNumber,
541 uint64_t AlignInBits,
542 uint64_t OffsetInBits,
543 unsigned Flags, DIType DerivedFrom,
545 MDNode *VTableHolder,
546 MDNode *TemplateParams) {
547 assert((!Context || Context.Verify()) &&
548 "createClassType should be called with a valid Context");
549 // TAG_class_type is encoded in DICompositeType format.
551 GetTagConstant(VMContext, dwarf::DW_TAG_class_type),
553 NULL, // Imported modules
554 getNonCompileUnitScope(Context),
555 MDString::get(VMContext, Name),
556 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
557 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
558 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
559 ConstantInt::get(Type::getInt32Ty(VMContext), OffsetInBits),
560 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
563 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
567 DICompositeType R(MDNode::get(VMContext, Elts));
568 assert(R.Verify() && "createClassType should return a verifiable DIType");
572 /// createStructType - Create debugging information entry for a struct.
573 DICompositeType DIBuilder::createStructType(DIDescriptor Context,
574 StringRef Name, DIFile File,
577 uint64_t AlignInBits,
578 unsigned Flags, DIType DerivedFrom,
580 unsigned RunTimeLang,
581 MDNode *VTableHolder) {
582 // TAG_structure_type is encoded in DICompositeType format.
584 GetTagConstant(VMContext, dwarf::DW_TAG_structure_type),
586 NULL, // Imported modules
587 getNonCompileUnitScope(Context),
588 MDString::get(VMContext, Name),
589 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
590 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
591 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
592 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
593 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
596 ConstantInt::get(Type::getInt32Ty(VMContext), RunTimeLang),
600 DICompositeType R(MDNode::get(VMContext, Elts));
601 assert(R.Verify() && "createStructType should return a verifiable DIType");
605 /// createUnionType - Create debugging information entry for an union.
606 DICompositeType DIBuilder::createUnionType(
607 DIDescriptor Scope, StringRef Name, DIFile File, unsigned LineNumber,
608 uint64_t SizeInBits, uint64_t AlignInBits, unsigned Flags, DIArray Elements,
609 unsigned RunTimeLang) {
610 // TAG_union_type is encoded in DICompositeType format.
612 GetTagConstant(VMContext, dwarf::DW_TAG_union_type),
614 NULL, // Imported modules
615 getNonCompileUnitScope(Scope),
616 MDString::get(VMContext, Name),
617 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
618 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
619 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
620 ConstantInt::get(Type::getInt64Ty(VMContext), 0),
621 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
624 ConstantInt::get(Type::getInt32Ty(VMContext), RunTimeLang),
625 Constant::getNullValue(Type::getInt32Ty(VMContext))
627 DICompositeType T(MDNode::get(VMContext, Elts));
628 assert(T.Verify() && "The union type should be valid");
632 /// createSubroutineType - Create subroutine type.
634 DIBuilder::createSubroutineType(DIFile File, DIArray ParameterTypes) {
635 // TAG_subroutine_type is encoded in DICompositeType format.
637 GetTagConstant(VMContext, dwarf::DW_TAG_subroutine_type),
638 Constant::getNullValue(Type::getInt32Ty(VMContext)),
639 Constant::getNullValue(Type::getInt32Ty(VMContext)), // Imported modules
640 Constant::getNullValue(Type::getInt32Ty(VMContext)),
641 MDString::get(VMContext, ""),
642 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
643 ConstantInt::get(Type::getInt64Ty(VMContext), 0),
644 ConstantInt::get(Type::getInt64Ty(VMContext), 0),
645 ConstantInt::get(Type::getInt64Ty(VMContext), 0),
646 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
649 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
650 Constant::getNullValue(Type::getInt32Ty(VMContext))
652 DICompositeType T(MDNode::get(VMContext, Elts));
653 assert(T.Verify() && "The subroutine type should be valid");
657 /// createEnumerationType - Create debugging information entry for an
659 DICompositeType DIBuilder::createEnumerationType(
660 DIDescriptor Scope, StringRef Name, DIFile File, unsigned LineNumber,
661 uint64_t SizeInBits, uint64_t AlignInBits, DIArray Elements,
663 // TAG_enumeration_type is encoded in DICompositeType format.
665 GetTagConstant(VMContext, dwarf::DW_TAG_enumeration_type),
667 NULL, // Imported modules
668 getNonCompileUnitScope(Scope),
669 MDString::get(VMContext, Name),
670 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
671 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
672 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
673 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
674 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
677 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
678 Constant::getNullValue(Type::getInt32Ty(VMContext))
680 MDNode *Node = MDNode::get(VMContext, Elts);
681 AllEnumTypes.push_back(Node);
682 DICompositeType T(Node);
683 assert(T.Verify() && "The enumeration type should be valid");
687 /// createArrayType - Create debugging information entry for an array.
688 DICompositeType DIBuilder::createArrayType(uint64_t Size, uint64_t AlignInBits,
689 DIType Ty, DIArray Subscripts) {
690 // TAG_array_type is encoded in DICompositeType format.
692 GetTagConstant(VMContext, dwarf::DW_TAG_array_type),
693 NULL, // Filename/Directory,
694 Constant::getNullValue(Type::getInt32Ty(VMContext)), // Imported modules
696 MDString::get(VMContext, ""),
697 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
698 ConstantInt::get(Type::getInt64Ty(VMContext), Size),
699 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
700 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
701 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
704 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
705 Constant::getNullValue(Type::getInt32Ty(VMContext))
707 DICompositeType T(MDNode::get(VMContext, Elts));
708 assert(T.Verify() && "The array type should be valid");
712 /// createVectorType - Create debugging information entry for a vector.
713 DIType DIBuilder::createVectorType(uint64_t Size, uint64_t AlignInBits,
714 DIType Ty, DIArray Subscripts) {
716 // A vector is an array type with the FlagVector flag applied.
718 GetTagConstant(VMContext, dwarf::DW_TAG_array_type),
719 NULL, // Filename/Directory,
720 Constant::getNullValue(Type::getInt32Ty(VMContext)), // Imported modules
722 MDString::get(VMContext, ""),
723 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
724 ConstantInt::get(Type::getInt64Ty(VMContext), Size),
725 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
726 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
727 ConstantInt::get(Type::getInt32Ty(VMContext), DIType::FlagVector),
730 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
731 Constant::getNullValue(Type::getInt32Ty(VMContext))
733 DIType T(MDNode::get(VMContext, Elts));
734 assert(T.Verify() && "The vector type should be valid");
738 /// createArtificialType - Create a new DIType with "artificial" flag set.
739 DIType DIBuilder::createArtificialType(DIType Ty) {
740 if (Ty.isArtificial())
743 SmallVector<Value *, 9> Elts;
745 assert (N && "Unexpected input DIType!");
746 for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i) {
747 if (Value *V = N->getOperand(i))
750 Elts.push_back(Constant::getNullValue(Type::getInt32Ty(VMContext)));
753 unsigned CurFlags = Ty.getFlags();
754 CurFlags = CurFlags | DIType::FlagArtificial;
756 // Flags are stored at this slot.
757 Elts[9] = ConstantInt::get(Type::getInt32Ty(VMContext), CurFlags);
759 DIType T(MDNode::get(VMContext, Elts));
760 assert(T.Verify() && "The artificial type should be valid");
764 /// createObjectPointerType - Create a new type with both the object pointer
765 /// and artificial flags set.
766 DIType DIBuilder::createObjectPointerType(DIType Ty) {
767 if (Ty.isObjectPointer())
770 SmallVector<Value *, 9> Elts;
772 assert (N && "Unexpected input DIType!");
773 for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i) {
774 if (Value *V = N->getOperand(i))
777 Elts.push_back(Constant::getNullValue(Type::getInt32Ty(VMContext)));
780 unsigned CurFlags = Ty.getFlags();
781 CurFlags = CurFlags | (DIType::FlagObjectPointer | DIType::FlagArtificial);
783 // Flags are stored at this slot.
784 Elts[9] = ConstantInt::get(Type::getInt32Ty(VMContext), CurFlags);
786 DIType T(MDNode::get(VMContext, Elts));
787 assert(T.Verify() && "The object pointer type should be valid");
791 /// retainType - Retain DIType in a module even if it is not referenced
792 /// through debug info anchors.
793 void DIBuilder::retainType(DIType T) {
794 AllRetainTypes.push_back(T);
797 /// createUnspecifiedParameter - Create unspeicified type descriptor
798 /// for the subroutine type.
799 DIDescriptor DIBuilder::createUnspecifiedParameter() {
801 GetTagConstant(VMContext, dwarf::DW_TAG_unspecified_parameters)
803 return DIDescriptor(MDNode::get(VMContext, Elts));
806 /// createForwardDecl - Create a temporary forward-declared type that
807 /// can be RAUW'd if the full type is seen.
808 DIType DIBuilder::createForwardDecl(unsigned Tag, StringRef Name,
809 DIDescriptor Scope, DIFile F,
810 unsigned Line, unsigned RuntimeLang,
812 uint64_t AlignInBits) {
813 // Create a temporary MDNode.
815 GetTagConstant(VMContext, Tag),
817 NULL, // Imported modules
818 getNonCompileUnitScope(Scope),
819 MDString::get(VMContext, Name),
820 ConstantInt::get(Type::getInt32Ty(VMContext), Line),
821 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
822 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
823 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
824 ConstantInt::get(Type::getInt32Ty(VMContext),
825 DIDescriptor::FlagFwdDecl),
828 ConstantInt::get(Type::getInt32Ty(VMContext), RuntimeLang)
830 MDNode *Node = MDNode::getTemporary(VMContext, Elts);
831 assert(DIType(Node).Verify() &&
832 "createForwardDecl result should be verifiable");
836 /// getOrCreateArray - Get a DIArray, create one if required.
837 DIArray DIBuilder::getOrCreateArray(ArrayRef<Value *> Elements) {
838 if (Elements.empty()) {
839 Value *Null = Constant::getNullValue(Type::getInt32Ty(VMContext));
840 return DIArray(MDNode::get(VMContext, Null));
842 return DIArray(MDNode::get(VMContext, Elements));
845 /// getOrCreateSubrange - Create a descriptor for a value range. This
846 /// implicitly uniques the values returned.
847 DISubrange DIBuilder::getOrCreateSubrange(int64_t Lo, int64_t Count) {
849 GetTagConstant(VMContext, dwarf::DW_TAG_subrange_type),
850 ConstantInt::get(Type::getInt64Ty(VMContext), Lo),
851 ConstantInt::get(Type::getInt64Ty(VMContext), Count)
854 return DISubrange(MDNode::get(VMContext, Elts));
857 /// \brief Create a new descriptor for the specified global.
858 DIGlobalVariable DIBuilder::
859 createGlobalVariable(StringRef Name, StringRef LinkageName, DIFile F,
860 unsigned LineNumber, DIType Ty, bool isLocalToUnit,
863 GetTagConstant(VMContext, dwarf::DW_TAG_variable),
864 Constant::getNullValue(Type::getInt32Ty(VMContext)),
866 MDString::get(VMContext, Name),
867 MDString::get(VMContext, Name),
868 MDString::get(VMContext, LinkageName),
870 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
872 ConstantInt::get(Type::getInt32Ty(VMContext), isLocalToUnit),
873 ConstantInt::get(Type::getInt32Ty(VMContext), 1), /* isDefinition*/
877 MDNode *Node = MDNode::get(VMContext, Elts);
878 AllGVs.push_back(Node);
879 return DIGlobalVariable(Node);
882 /// \brief Create a new descriptor for the specified global.
883 DIGlobalVariable DIBuilder::
884 createGlobalVariable(StringRef Name, DIFile F, unsigned LineNumber,
885 DIType Ty, bool isLocalToUnit, Value *Val) {
886 return createGlobalVariable(Name, Name, F, LineNumber, Ty, isLocalToUnit,
890 /// createStaticVariable - Create a new descriptor for the specified static
892 DIGlobalVariable DIBuilder::
893 createStaticVariable(DIDescriptor Context, StringRef Name,
894 StringRef LinkageName, DIFile F, unsigned LineNumber,
895 DIType Ty, bool isLocalToUnit, Value *Val, MDNode *Decl) {
897 GetTagConstant(VMContext, dwarf::DW_TAG_variable),
898 Constant::getNullValue(Type::getInt32Ty(VMContext)),
899 getNonCompileUnitScope(Context),
900 MDString::get(VMContext, Name),
901 MDString::get(VMContext, Name),
902 MDString::get(VMContext, LinkageName),
904 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
906 ConstantInt::get(Type::getInt32Ty(VMContext), isLocalToUnit),
907 ConstantInt::get(Type::getInt32Ty(VMContext), 1), /* isDefinition*/
911 MDNode *Node = MDNode::get(VMContext, Elts);
912 AllGVs.push_back(Node);
913 return DIGlobalVariable(Node);
916 /// createVariable - Create a new descriptor for the specified variable.
917 DIVariable DIBuilder::createLocalVariable(unsigned Tag, DIDescriptor Scope,
918 StringRef Name, DIFile File,
919 unsigned LineNo, DIType Ty,
920 bool AlwaysPreserve, unsigned Flags,
922 DIDescriptor Context(getNonCompileUnitScope(Scope));
923 assert((!Context || Context.Verify()) &&
924 "createLocalVariable should be called with a valid Context");
925 assert(Ty.Verify() &&
926 "createLocalVariable should be called with a valid type");
928 GetTagConstant(VMContext, Tag),
929 getNonCompileUnitScope(Scope),
930 MDString::get(VMContext, Name),
932 ConstantInt::get(Type::getInt32Ty(VMContext), (LineNo | (ArgNo << 24))),
934 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
935 Constant::getNullValue(Type::getInt32Ty(VMContext))
937 MDNode *Node = MDNode::get(VMContext, Elts);
938 if (AlwaysPreserve) {
939 // The optimizer may remove local variable. If there is an interest
940 // to preserve variable info in such situation then stash it in a
942 DISubprogram Fn(getDISubprogram(Scope));
943 NamedMDNode *FnLocals = getOrInsertFnSpecificMDNode(M, Fn);
944 FnLocals->addOperand(Node);
946 assert(DIVariable(Node).Verify() &&
947 "createLocalVariable should return a verifiable DIVariable");
948 return DIVariable(Node);
951 /// createComplexVariable - Create a new descriptor for the specified variable
952 /// which has a complex address expression for its address.
953 DIVariable DIBuilder::createComplexVariable(unsigned Tag, DIDescriptor Scope,
954 StringRef Name, DIFile F,
956 DIType Ty, ArrayRef<Value *> Addr,
958 SmallVector<Value *, 15> Elts;
959 Elts.push_back(GetTagConstant(VMContext, Tag));
960 Elts.push_back(getNonCompileUnitScope(Scope)),
961 Elts.push_back(MDString::get(VMContext, Name));
963 Elts.push_back(ConstantInt::get(Type::getInt32Ty(VMContext),
964 (LineNo | (ArgNo << 24))));
966 Elts.push_back(Constant::getNullValue(Type::getInt32Ty(VMContext)));
967 Elts.push_back(Constant::getNullValue(Type::getInt32Ty(VMContext)));
968 Elts.append(Addr.begin(), Addr.end());
970 return DIVariable(MDNode::get(VMContext, Elts));
973 /// createFunction - Create a new descriptor for the specified function.
974 DISubprogram DIBuilder::createFunction(DIDescriptor Context,
976 StringRef LinkageName,
977 DIFile File, unsigned LineNo,
979 bool isLocalToUnit, bool isDefinition,
981 unsigned Flags, bool isOptimized,
985 Value *TElts[] = { GetTagConstant(VMContext, DW_TAG_base_type) };
987 GetTagConstant(VMContext, dwarf::DW_TAG_subprogram),
989 NULL, // Imported modules
990 getNonCompileUnitScope(Context),
991 MDString::get(VMContext, Name),
992 MDString::get(VMContext, Name),
993 MDString::get(VMContext, LinkageName),
994 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
996 ConstantInt::get(Type::getInt1Ty(VMContext), isLocalToUnit),
997 ConstantInt::get(Type::getInt1Ty(VMContext), isDefinition),
998 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
999 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
1001 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
1002 ConstantInt::get(Type::getInt1Ty(VMContext), isOptimized),
1006 MDNode::getTemporary(VMContext, TElts),
1007 ConstantInt::get(Type::getInt32Ty(VMContext), ScopeLine)
1009 MDNode *Node = MDNode::get(VMContext, Elts);
1011 // Create a named metadata so that we do not lose this mdnode.
1013 AllSubprograms.push_back(Node);
1014 DISubprogram S(Node);
1015 assert(S.Verify() && "createFunction should return a valid DISubprogram");
1019 /// createMethod - Create a new descriptor for the specified C++ method.
1020 DISubprogram DIBuilder::createMethod(DIDescriptor Context,
1022 StringRef LinkageName,
1024 unsigned LineNo, DIType Ty,
1027 unsigned VK, unsigned VIndex,
1028 MDNode *VTableHolder,
1033 Value *TElts[] = { GetTagConstant(VMContext, DW_TAG_base_type) };
1035 GetTagConstant(VMContext, dwarf::DW_TAG_subprogram),
1037 NULL, // Imported modules
1038 getNonCompileUnitScope(Context),
1039 MDString::get(VMContext, Name),
1040 MDString::get(VMContext, Name),
1041 MDString::get(VMContext, LinkageName),
1042 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
1044 ConstantInt::get(Type::getInt1Ty(VMContext), isLocalToUnit),
1045 ConstantInt::get(Type::getInt1Ty(VMContext), isDefinition),
1046 ConstantInt::get(Type::getInt32Ty(VMContext), (unsigned)VK),
1047 ConstantInt::get(Type::getInt32Ty(VMContext), VIndex),
1049 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
1050 ConstantInt::get(Type::getInt1Ty(VMContext), isOptimized),
1053 Constant::getNullValue(Type::getInt32Ty(VMContext)),
1054 MDNode::getTemporary(VMContext, TElts),
1055 // FIXME: Do we want to use different scope/lines?
1056 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo)
1058 MDNode *Node = MDNode::get(VMContext, Elts);
1060 AllSubprograms.push_back(Node);
1061 DISubprogram S(Node);
1062 assert(S.Verify() && "createMethod should return a valid DISubprogram");
1066 /// createNameSpace - This creates new descriptor for a namespace
1067 /// with the specified parent scope.
1068 DINameSpace DIBuilder::createNameSpace(DIDescriptor Scope, StringRef Name,
1069 DIFile File, unsigned LineNo) {
1071 GetTagConstant(VMContext, dwarf::DW_TAG_namespace),
1073 NULL, // Imported modules
1074 getNonCompileUnitScope(Scope),
1075 MDString::get(VMContext, Name),
1076 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo)
1078 DINameSpace R(MDNode::get(VMContext, Elts));
1079 assert(R.Verify() &&
1080 "createNameSpace should return a verifiable DINameSpace");
1084 /// createLexicalBlockFile - This creates a new MDNode that encapsulates
1085 /// an existing scope with a new filename.
1086 DILexicalBlockFile DIBuilder::createLexicalBlockFile(DIDescriptor Scope,
1089 GetTagConstant(VMContext, dwarf::DW_TAG_lexical_block),
1091 NULL, // Imported modules
1094 DILexicalBlockFile R(MDNode::get(VMContext, Elts));
1097 "createLexicalBlockFile should return a verifiable DILexicalBlockFile");
1101 DILexicalBlock DIBuilder::createLexicalBlock(DIDescriptor Scope, DIFile File,
1102 unsigned Line, unsigned Col) {
1103 // Defeat MDNode uniqing for lexical blocks by using unique id.
1104 static unsigned int unique_id = 0;
1106 GetTagConstant(VMContext, dwarf::DW_TAG_lexical_block),
1108 NULL, // Imported modules
1109 getNonCompileUnitScope(Scope),
1110 ConstantInt::get(Type::getInt32Ty(VMContext), Line),
1111 ConstantInt::get(Type::getInt32Ty(VMContext), Col),
1112 ConstantInt::get(Type::getInt32Ty(VMContext), unique_id++)
1114 DILexicalBlock R(MDNode::get(VMContext, Elts));
1115 assert(R.Verify() &&
1116 "createLexicalBlock should return a verifiable DILexicalBlock");
1120 /// insertDeclare - Insert a new llvm.dbg.declare intrinsic call.
1121 Instruction *DIBuilder::insertDeclare(Value *Storage, DIVariable VarInfo,
1122 Instruction *InsertBefore) {
1123 assert(Storage && "no storage passed to dbg.declare");
1124 assert(VarInfo.Verify() && "empty DIVariable passed to dbg.declare");
1126 DeclareFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_declare);
1128 Value *Args[] = { MDNode::get(Storage->getContext(), Storage), VarInfo };
1129 return CallInst::Create(DeclareFn, Args, "", InsertBefore);
1132 /// insertDeclare - Insert a new llvm.dbg.declare intrinsic call.
1133 Instruction *DIBuilder::insertDeclare(Value *Storage, DIVariable VarInfo,
1134 BasicBlock *InsertAtEnd) {
1135 assert(Storage && "no storage passed to dbg.declare");
1136 assert(VarInfo.Verify() && "invalid DIVariable passed to dbg.declare");
1138 DeclareFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_declare);
1140 Value *Args[] = { MDNode::get(Storage->getContext(), Storage), VarInfo };
1142 // If this block already has a terminator then insert this intrinsic
1143 // before the terminator.
1144 if (TerminatorInst *T = InsertAtEnd->getTerminator())
1145 return CallInst::Create(DeclareFn, Args, "", T);
1147 return CallInst::Create(DeclareFn, Args, "", InsertAtEnd);
1150 /// insertDbgValueIntrinsic - Insert a new llvm.dbg.value intrinsic call.
1151 Instruction *DIBuilder::insertDbgValueIntrinsic(Value *V, uint64_t Offset,
1153 Instruction *InsertBefore) {
1154 assert(V && "no value passed to dbg.value");
1155 assert(VarInfo.Verify() && "invalid DIVariable passed to dbg.value");
1157 ValueFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_value);
1159 Value *Args[] = { MDNode::get(V->getContext(), V),
1160 ConstantInt::get(Type::getInt64Ty(V->getContext()), Offset),
1162 return CallInst::Create(ValueFn, Args, "", InsertBefore);
1165 /// insertDbgValueIntrinsic - Insert a new llvm.dbg.value intrinsic call.
1166 Instruction *DIBuilder::insertDbgValueIntrinsic(Value *V, uint64_t Offset,
1168 BasicBlock *InsertAtEnd) {
1169 assert(V && "no value passed to dbg.value");
1170 assert(VarInfo.Verify() && "invalid DIVariable passed to dbg.value");
1172 ValueFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_value);
1174 Value *Args[] = { MDNode::get(V->getContext(), V),
1175 ConstantInt::get(Type::getInt64Ty(V->getContext()), Offset),
1177 return CallInst::Create(ValueFn, Args, "", InsertAtEnd);