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) {
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);
87 Value *THElts[] = { TempEnumTypes };
88 MDNode *EnumHolder = MDNode::get(VMContext, THElts);
90 TempRetainTypes = MDNode::getTemporary(VMContext, TElts);
91 Value *TRElts[] = { TempRetainTypes };
92 MDNode *RetainHolder = MDNode::get(VMContext, TRElts);
94 TempSubprograms = MDNode::getTemporary(VMContext, TElts);
95 Value *TSElts[] = { TempSubprograms };
96 MDNode *SPHolder = MDNode::get(VMContext, TSElts);
98 TempGVs = MDNode::getTemporary(VMContext, TElts);
99 Value *TVElts[] = { TempGVs };
100 MDNode *GVHolder = MDNode::get(VMContext, TVElts);
103 GetTagConstant(VMContext, dwarf::DW_TAG_compile_unit),
104 Constant::getNullValue(Type::getInt32Ty(VMContext)),
105 ConstantInt::get(Type::getInt32Ty(VMContext), Lang),
106 MDString::get(VMContext, Filename),
107 MDString::get(VMContext, Directory),
108 MDString::get(VMContext, Producer),
109 // Deprecate isMain field.
110 ConstantInt::get(Type::getInt1Ty(VMContext), true), // isMain
111 ConstantInt::get(Type::getInt1Ty(VMContext), isOptimized),
112 MDString::get(VMContext, Flags),
113 ConstantInt::get(Type::getInt32Ty(VMContext), RunTimeVer),
119 TheCU = DICompileUnit(MDNode::get(VMContext, Elts));
121 // Create a named metadata so that it is easier to find cu in a module.
122 NamedMDNode *NMD = M.getOrInsertNamedMetadata("llvm.dbg.cu");
123 NMD->addOperand(TheCU);
126 /// createFile - Create a file descriptor to hold debugging information
128 DIFile DIBuilder::createFile(StringRef Filename, StringRef Directory) {
129 assert(TheCU && "Unable to create DW_TAG_file_type without CompileUnit");
130 assert(!Filename.empty() && "Unable to create file without name");
132 GetTagConstant(VMContext, dwarf::DW_TAG_file_type),
133 MDString::get(VMContext, Filename),
134 MDString::get(VMContext, Directory),
137 return DIFile(MDNode::get(VMContext, Elts));
140 /// createEnumerator - Create a single enumerator value.
141 DIEnumerator DIBuilder::createEnumerator(StringRef Name, uint64_t Val) {
142 assert(!Name.empty() && "Unable to create enumerator without name");
144 GetTagConstant(VMContext, dwarf::DW_TAG_enumerator),
145 MDString::get(VMContext, Name),
146 ConstantInt::get(Type::getInt64Ty(VMContext), Val)
148 return DIEnumerator(MDNode::get(VMContext, Elts));
151 /// createNullPtrType - Create C++0x nullptr type.
152 DIType DIBuilder::createNullPtrType(StringRef Name) {
153 assert(!Name.empty() && "Unable to create type without name");
154 // nullptr is encoded in DIBasicType format. Line number, filename,
155 // ,size, alignment, offset and flags are always empty here.
157 GetTagConstant(VMContext, dwarf::DW_TAG_unspecified_type),
159 MDString::get(VMContext, Name),
161 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
162 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Size
163 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Align
164 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
165 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags;
166 ConstantInt::get(Type::getInt32Ty(VMContext), 0) // Encoding
168 return DIType(MDNode::get(VMContext, Elts));
171 /// createBasicType - Create debugging information entry for a basic
172 /// type, e.g 'char'.
173 DIType DIBuilder::createBasicType(StringRef Name, uint64_t SizeInBits,
174 uint64_t AlignInBits,
176 assert(!Name.empty() && "Unable to create type without name");
177 // Basic types are encoded in DIBasicType format. Line number, filename,
178 // offset and flags are always empty here.
180 GetTagConstant(VMContext, dwarf::DW_TAG_base_type),
182 MDString::get(VMContext, Name),
184 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
185 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
186 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
187 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
188 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags;
189 ConstantInt::get(Type::getInt32Ty(VMContext), Encoding)
191 return DIType(MDNode::get(VMContext, Elts));
194 /// createQualifiedType - Create debugging information entry for a qualified
195 /// type, e.g. 'const int'.
196 DIType DIBuilder::createQualifiedType(unsigned Tag, DIType FromTy) {
197 // Qualified types are encoded in DIDerivedType format.
199 GetTagConstant(VMContext, Tag),
201 MDString::get(VMContext, StringRef()), // Empty name.
203 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
204 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Size
205 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Align
206 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
207 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags
210 return DIType(MDNode::get(VMContext, Elts));
213 /// createPointerType - Create debugging information entry for a pointer.
214 DIType DIBuilder::createPointerType(DIType PointeeTy, uint64_t SizeInBits,
215 uint64_t AlignInBits, StringRef Name) {
216 // Pointer types are encoded in DIDerivedType format.
218 GetTagConstant(VMContext, dwarf::DW_TAG_pointer_type),
220 MDString::get(VMContext, Name),
222 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
223 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
224 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
225 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
226 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags
229 return DIType(MDNode::get(VMContext, Elts));
232 DIType DIBuilder::createMemberPointerType(DIType PointeeTy, DIType Base) {
233 // Pointer types are encoded in DIDerivedType format.
235 GetTagConstant(VMContext, dwarf::DW_TAG_ptr_to_member_type),
239 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
240 ConstantInt::get(Type::getInt64Ty(VMContext), 0),
241 ConstantInt::get(Type::getInt64Ty(VMContext), 0),
242 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
243 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags
247 return DIType(MDNode::get(VMContext, Elts));
250 /// createReferenceType - Create debugging information entry for a reference
252 DIType DIBuilder::createReferenceType(unsigned Tag, DIType RTy) {
253 assert(RTy.Verify() && "Unable to create reference type");
254 // References are encoded in DIDerivedType format.
256 GetTagConstant(VMContext, Tag),
260 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
261 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Size
262 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Align
263 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
264 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags
267 return DIType(MDNode::get(VMContext, Elts));
270 /// createTypedef - Create debugging information entry for a typedef.
271 DIType DIBuilder::createTypedef(DIType Ty, StringRef Name, DIFile File,
272 unsigned LineNo, DIDescriptor Context) {
273 // typedefs are encoded in DIDerivedType format.
274 assert(Ty.Verify() && "Invalid typedef type!");
276 GetTagConstant(VMContext, dwarf::DW_TAG_typedef),
277 getNonCompileUnitScope(Context),
278 MDString::get(VMContext, Name),
280 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
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 return DIType(MDNode::get(VMContext, Elts));
290 /// createFriend - Create debugging information entry for a 'friend'.
291 DIType DIBuilder::createFriend(DIType Ty, DIType FriendTy) {
292 // typedefs are encoded in DIDerivedType format.
293 assert(Ty.Verify() && "Invalid type!");
294 assert(FriendTy.Verify() && "Invalid friend type!");
296 GetTagConstant(VMContext, dwarf::DW_TAG_friend),
300 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
301 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Size
302 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Align
303 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
304 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags
307 return DIType(MDNode::get(VMContext, Elts));
310 /// createInheritance - Create debugging information entry to establish
311 /// inheritance relationship between two types.
312 DIType DIBuilder::createInheritance(DIType Ty, DIType BaseTy,
313 uint64_t BaseOffset, unsigned Flags) {
314 assert(Ty.Verify() && "Unable to create inheritance");
315 // TAG_inheritance is encoded in DIDerivedType format.
317 GetTagConstant(VMContext, dwarf::DW_TAG_inheritance),
321 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
322 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Size
323 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Align
324 ConstantInt::get(Type::getInt64Ty(VMContext), BaseOffset),
325 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
328 return DIType(MDNode::get(VMContext, Elts));
331 /// createMemberType - Create debugging information entry for a member.
332 DIType DIBuilder::createMemberType(DIDescriptor Scope, StringRef Name,
333 DIFile File, unsigned LineNumber,
334 uint64_t SizeInBits, uint64_t AlignInBits,
335 uint64_t OffsetInBits, unsigned Flags,
337 // TAG_member is encoded in DIDerivedType format.
339 GetTagConstant(VMContext, dwarf::DW_TAG_member),
340 getNonCompileUnitScope(Scope),
341 MDString::get(VMContext, Name),
343 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
344 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
345 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
346 ConstantInt::get(Type::getInt64Ty(VMContext), OffsetInBits),
347 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
350 return DIType(MDNode::get(VMContext, Elts));
353 /// createStaticMemberType - Create debugging information entry for a
354 /// C++ static data member.
355 DIType DIBuilder::createStaticMemberType(DIDescriptor Scope, StringRef Name,
356 DIFile File, unsigned LineNumber,
357 DIType Ty, unsigned Flags,
359 // TAG_member is encoded in DIDerivedType format.
360 Flags |= DIDescriptor::FlagStaticMember;
362 GetTagConstant(VMContext, dwarf::DW_TAG_member),
363 getNonCompileUnitScope(Scope),
364 MDString::get(VMContext, Name),
366 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
367 ConstantInt::get(Type::getInt64Ty(VMContext), 0/*SizeInBits*/),
368 ConstantInt::get(Type::getInt64Ty(VMContext), 0/*AlignInBits*/),
369 ConstantInt::get(Type::getInt64Ty(VMContext), 0/*OffsetInBits*/),
370 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
374 return DIType(MDNode::get(VMContext, Elts));
377 /// createObjCIVar - Create debugging information entry for Objective-C
378 /// instance variable.
379 DIType DIBuilder::createObjCIVar(StringRef Name,
380 DIFile File, unsigned LineNumber,
381 uint64_t SizeInBits, uint64_t AlignInBits,
382 uint64_t OffsetInBits, unsigned Flags,
383 DIType Ty, StringRef PropertyName,
384 StringRef GetterName, StringRef SetterName,
385 unsigned PropertyAttributes) {
386 // TAG_member is encoded in DIDerivedType format.
388 GetTagConstant(VMContext, dwarf::DW_TAG_member),
389 getNonCompileUnitScope(File),
390 MDString::get(VMContext, Name),
392 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
393 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
394 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
395 ConstantInt::get(Type::getInt64Ty(VMContext), OffsetInBits),
396 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
398 MDString::get(VMContext, PropertyName),
399 MDString::get(VMContext, GetterName),
400 MDString::get(VMContext, SetterName),
401 ConstantInt::get(Type::getInt32Ty(VMContext), PropertyAttributes)
403 return DIType(MDNode::get(VMContext, Elts));
406 /// createObjCIVar - Create debugging information entry for Objective-C
407 /// instance variable.
408 DIType DIBuilder::createObjCIVar(StringRef Name,
409 DIFile File, unsigned LineNumber,
410 uint64_t SizeInBits, uint64_t AlignInBits,
411 uint64_t OffsetInBits, unsigned Flags,
412 DIType Ty, MDNode *PropertyNode) {
413 // TAG_member is encoded in DIDerivedType format.
415 GetTagConstant(VMContext, dwarf::DW_TAG_member),
416 getNonCompileUnitScope(File),
417 MDString::get(VMContext, Name),
419 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
420 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
421 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
422 ConstantInt::get(Type::getInt64Ty(VMContext), OffsetInBits),
423 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
427 return DIType(MDNode::get(VMContext, Elts));
430 /// createObjCProperty - Create debugging information entry for Objective-C
432 DIObjCProperty DIBuilder::createObjCProperty(StringRef Name,
433 DIFile File, unsigned LineNumber,
434 StringRef GetterName,
435 StringRef SetterName,
436 unsigned PropertyAttributes,
439 GetTagConstant(VMContext, dwarf::DW_TAG_APPLE_property),
440 MDString::get(VMContext, Name),
442 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
443 MDString::get(VMContext, GetterName),
444 MDString::get(VMContext, SetterName),
445 ConstantInt::get(Type::getInt32Ty(VMContext), PropertyAttributes),
448 return DIObjCProperty(MDNode::get(VMContext, Elts));
451 /// createTemplateTypeParameter - Create debugging information for template
453 DITemplateTypeParameter
454 DIBuilder::createTemplateTypeParameter(DIDescriptor Context, StringRef Name,
455 DIType Ty, MDNode *File, unsigned LineNo,
458 GetTagConstant(VMContext, dwarf::DW_TAG_template_type_parameter),
459 getNonCompileUnitScope(Context),
460 MDString::get(VMContext, Name),
463 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
464 ConstantInt::get(Type::getInt32Ty(VMContext), ColumnNo)
466 return DITemplateTypeParameter(MDNode::get(VMContext, Elts));
469 /// createTemplateValueParameter - Create debugging information for template
471 DITemplateValueParameter
472 DIBuilder::createTemplateValueParameter(DIDescriptor Context, StringRef Name,
473 DIType Ty, uint64_t Val,
474 MDNode *File, unsigned LineNo,
477 GetTagConstant(VMContext, dwarf::DW_TAG_template_value_parameter),
478 getNonCompileUnitScope(Context),
479 MDString::get(VMContext, Name),
481 ConstantInt::get(Type::getInt64Ty(VMContext), Val),
483 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
484 ConstantInt::get(Type::getInt32Ty(VMContext), ColumnNo)
486 return DITemplateValueParameter(MDNode::get(VMContext, Elts));
489 /// createClassType - Create debugging information entry for a class.
490 DIType DIBuilder::createClassType(DIDescriptor Context, StringRef Name,
491 DIFile File, unsigned LineNumber,
492 uint64_t SizeInBits, uint64_t AlignInBits,
493 uint64_t OffsetInBits, unsigned Flags,
494 DIType DerivedFrom, DIArray Elements,
495 MDNode *VTableHolder,
496 MDNode *TemplateParams) {
497 // TAG_class_type is encoded in DICompositeType format.
499 GetTagConstant(VMContext, dwarf::DW_TAG_class_type),
500 getNonCompileUnitScope(Context),
501 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 return DIType(MDNode::get(VMContext, Elts));
517 /// createStructType - Create debugging information entry for a struct.
518 DIType DIBuilder::createStructType(DIDescriptor Context, StringRef Name,
519 DIFile File, unsigned LineNumber,
520 uint64_t SizeInBits, uint64_t AlignInBits,
521 unsigned Flags, DIArray Elements,
522 unsigned RunTimeLang) {
523 // TAG_structure_type is encoded in DICompositeType format.
525 GetTagConstant(VMContext, dwarf::DW_TAG_structure_type),
526 getNonCompileUnitScope(Context),
527 MDString::get(VMContext, Name),
529 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
530 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
531 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
532 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
533 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
536 ConstantInt::get(Type::getInt32Ty(VMContext), RunTimeLang),
537 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
538 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
540 return DIType(MDNode::get(VMContext, Elts));
543 /// createUnionType - Create debugging information entry for an union.
544 DIType DIBuilder::createUnionType(DIDescriptor Scope, StringRef Name,
546 unsigned LineNumber, uint64_t SizeInBits,
547 uint64_t AlignInBits, unsigned Flags,
548 DIArray Elements, unsigned RunTimeLang) {
549 // TAG_union_type is encoded in DICompositeType format.
551 GetTagConstant(VMContext, dwarf::DW_TAG_union_type),
552 getNonCompileUnitScope(Scope),
553 MDString::get(VMContext, Name),
555 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
556 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
557 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
558 ConstantInt::get(Type::getInt64Ty(VMContext), 0),
559 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
562 ConstantInt::get(Type::getInt32Ty(VMContext), RunTimeLang),
563 Constant::getNullValue(Type::getInt32Ty(VMContext))
565 return DIType(MDNode::get(VMContext, Elts));
568 /// createSubroutineType - Create subroutine type.
569 DIType DIBuilder::createSubroutineType(DIFile File, DIArray ParameterTypes) {
570 // TAG_subroutine_type is encoded in DICompositeType format.
572 GetTagConstant(VMContext, dwarf::DW_TAG_subroutine_type),
573 Constant::getNullValue(Type::getInt32Ty(VMContext)),
574 MDString::get(VMContext, ""),
575 Constant::getNullValue(Type::getInt32Ty(VMContext)),
576 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
577 ConstantInt::get(Type::getInt64Ty(VMContext), 0),
578 ConstantInt::get(Type::getInt64Ty(VMContext), 0),
579 ConstantInt::get(Type::getInt64Ty(VMContext), 0),
580 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
583 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
584 Constant::getNullValue(Type::getInt32Ty(VMContext))
586 return DIType(MDNode::get(VMContext, Elts));
589 /// createEnumerationType - Create debugging information entry for an
591 DIType DIBuilder::createEnumerationType(DIDescriptor Scope, StringRef Name,
592 DIFile File, unsigned LineNumber,
594 uint64_t AlignInBits,
597 // TAG_enumeration_type is encoded in DICompositeType format.
599 GetTagConstant(VMContext, dwarf::DW_TAG_enumeration_type),
600 getNonCompileUnitScope(Scope),
601 MDString::get(VMContext, Name),
603 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
604 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
605 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
606 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
607 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
610 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
611 Constant::getNullValue(Type::getInt32Ty(VMContext))
613 MDNode *Node = MDNode::get(VMContext, Elts);
614 AllEnumTypes.push_back(Node);
618 /// createArrayType - Create debugging information entry for an array.
619 DIType DIBuilder::createArrayType(uint64_t Size, uint64_t AlignInBits,
620 DIType Ty, DIArray Subscripts) {
621 // TAG_array_type is encoded in DICompositeType format.
623 GetTagConstant(VMContext, dwarf::DW_TAG_array_type),
625 MDString::get(VMContext, ""),
627 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
628 ConstantInt::get(Type::getInt64Ty(VMContext), Size),
629 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
630 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
631 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
634 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
635 Constant::getNullValue(Type::getInt32Ty(VMContext))
637 return DIType(MDNode::get(VMContext, Elts));
640 /// createVectorType - Create debugging information entry for a vector.
641 DIType DIBuilder::createVectorType(uint64_t Size, uint64_t AlignInBits,
642 DIType Ty, DIArray Subscripts) {
644 // A vector is an array type with the FlagVector flag applied.
646 GetTagConstant(VMContext, dwarf::DW_TAG_array_type),
648 MDString::get(VMContext, ""),
650 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
651 ConstantInt::get(Type::getInt64Ty(VMContext), Size),
652 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
653 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
654 ConstantInt::get(Type::getInt32Ty(VMContext), DIType::FlagVector),
657 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
658 Constant::getNullValue(Type::getInt32Ty(VMContext))
660 return DIType(MDNode::get(VMContext, Elts));
663 /// createArtificialType - Create a new DIType with "artificial" flag set.
664 DIType DIBuilder::createArtificialType(DIType Ty) {
665 if (Ty.isArtificial())
668 SmallVector<Value *, 9> Elts;
670 assert (N && "Unexpected input DIType!");
671 for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i) {
672 if (Value *V = N->getOperand(i))
675 Elts.push_back(Constant::getNullValue(Type::getInt32Ty(VMContext)));
678 unsigned CurFlags = Ty.getFlags();
679 CurFlags = CurFlags | DIType::FlagArtificial;
681 // Flags are stored at this slot.
682 Elts[8] = ConstantInt::get(Type::getInt32Ty(VMContext), CurFlags);
684 return DIType(MDNode::get(VMContext, Elts));
687 /// createObjectPointerType - Create a new type with both the object pointer
688 /// and artificial flags set.
689 DIType DIBuilder::createObjectPointerType(DIType Ty) {
690 if (Ty.isObjectPointer())
693 SmallVector<Value *, 9> Elts;
695 assert (N && "Unexpected input DIType!");
696 for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i) {
697 if (Value *V = N->getOperand(i))
700 Elts.push_back(Constant::getNullValue(Type::getInt32Ty(VMContext)));
703 unsigned CurFlags = Ty.getFlags();
704 CurFlags = CurFlags | (DIType::FlagObjectPointer | DIType::FlagArtificial);
706 // Flags are stored at this slot.
707 Elts[8] = ConstantInt::get(Type::getInt32Ty(VMContext), CurFlags);
709 return DIType(MDNode::get(VMContext, Elts));
712 /// retainType - Retain DIType in a module even if it is not referenced
713 /// through debug info anchors.
714 void DIBuilder::retainType(DIType T) {
715 AllRetainTypes.push_back(T);
718 /// createUnspecifiedParameter - Create unspeicified type descriptor
719 /// for the subroutine type.
720 DIDescriptor DIBuilder::createUnspecifiedParameter() {
722 GetTagConstant(VMContext, dwarf::DW_TAG_unspecified_parameters)
724 return DIDescriptor(MDNode::get(VMContext, Elts));
727 /// createTemporaryType - Create a temporary forward-declared type.
728 DIType DIBuilder::createTemporaryType() {
729 // Give the temporary MDNode a tag. It doesn't matter what tag we
730 // use here as long as DIType accepts it.
731 Value *Elts[] = { GetTagConstant(VMContext, DW_TAG_base_type) };
732 MDNode *Node = MDNode::getTemporary(VMContext, Elts);
736 /// createTemporaryType - Create a temporary forward-declared type.
737 DIType DIBuilder::createTemporaryType(DIFile F) {
738 // Give the temporary MDNode a tag. It doesn't matter what tag we
739 // use here as long as DIType accepts it.
741 GetTagConstant(VMContext, DW_TAG_base_type),
746 MDNode *Node = MDNode::getTemporary(VMContext, Elts);
750 /// createForwardDecl - Create a temporary forward-declared type that
751 /// can be RAUW'd if the full type is seen.
752 DIType DIBuilder::createForwardDecl(unsigned Tag, StringRef Name,
753 DIDescriptor Scope, DIFile F,
754 unsigned Line, unsigned RuntimeLang,
756 uint64_t AlignInBits) {
757 // Create a temporary MDNode.
759 GetTagConstant(VMContext, Tag),
760 getNonCompileUnitScope(Scope),
761 MDString::get(VMContext, Name),
763 ConstantInt::get(Type::getInt32Ty(VMContext), Line),
764 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
765 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
766 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
767 ConstantInt::get(Type::getInt32Ty(VMContext),
768 DIDescriptor::FlagFwdDecl),
771 ConstantInt::get(Type::getInt32Ty(VMContext), RuntimeLang)
773 MDNode *Node = MDNode::getTemporary(VMContext, Elts);
777 /// getOrCreateArray - Get a DIArray, create one if required.
778 DIArray DIBuilder::getOrCreateArray(ArrayRef<Value *> Elements) {
779 if (Elements.empty()) {
780 Value *Null = Constant::getNullValue(Type::getInt32Ty(VMContext));
781 return DIArray(MDNode::get(VMContext, Null));
783 return DIArray(MDNode::get(VMContext, Elements));
786 /// getOrCreateSubrange - Create a descriptor for a value range. This
787 /// implicitly uniques the values returned.
788 DISubrange DIBuilder::getOrCreateSubrange(int64_t Lo, int64_t Count) {
790 GetTagConstant(VMContext, dwarf::DW_TAG_subrange_type),
791 ConstantInt::get(Type::getInt64Ty(VMContext), Lo),
792 ConstantInt::get(Type::getInt64Ty(VMContext), Count)
795 return DISubrange(MDNode::get(VMContext, Elts));
798 /// createGlobalVariable - Create a new descriptor for the specified global.
799 DIGlobalVariable DIBuilder::
800 createGlobalVariable(StringRef Name, DIFile F, unsigned LineNumber,
801 DIType Ty, bool isLocalToUnit, Value *Val) {
803 GetTagConstant(VMContext, dwarf::DW_TAG_variable),
804 Constant::getNullValue(Type::getInt32Ty(VMContext)),
806 MDString::get(VMContext, Name),
807 MDString::get(VMContext, Name),
808 MDString::get(VMContext, Name),
810 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
812 ConstantInt::get(Type::getInt32Ty(VMContext), isLocalToUnit),
813 ConstantInt::get(Type::getInt32Ty(VMContext), 1), /* isDefinition*/
817 MDNode *Node = MDNode::get(VMContext, Elts);
818 AllGVs.push_back(Node);
819 return DIGlobalVariable(Node);
822 /// createStaticVariable - Create a new descriptor for the specified static
824 DIGlobalVariable DIBuilder::
825 createStaticVariable(DIDescriptor Context, StringRef Name,
826 StringRef LinkageName, DIFile F, unsigned LineNumber,
827 DIType Ty, bool isLocalToUnit, Value *Val, MDNode *Decl) {
829 GetTagConstant(VMContext, dwarf::DW_TAG_variable),
830 Constant::getNullValue(Type::getInt32Ty(VMContext)),
831 getNonCompileUnitScope(Context),
832 MDString::get(VMContext, Name),
833 MDString::get(VMContext, Name),
834 MDString::get(VMContext, LinkageName),
836 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
838 ConstantInt::get(Type::getInt32Ty(VMContext), isLocalToUnit),
839 ConstantInt::get(Type::getInt32Ty(VMContext), 1), /* isDefinition*/
843 MDNode *Node = MDNode::get(VMContext, Elts);
844 AllGVs.push_back(Node);
845 return DIGlobalVariable(Node);
848 /// createVariable - Create a new descriptor for the specified variable.
849 DIVariable DIBuilder::createLocalVariable(unsigned Tag, DIDescriptor Scope,
850 StringRef Name, DIFile File,
851 unsigned LineNo, DIType Ty,
852 bool AlwaysPreserve, unsigned Flags,
855 GetTagConstant(VMContext, Tag),
856 getNonCompileUnitScope(Scope),
857 MDString::get(VMContext, Name),
859 ConstantInt::get(Type::getInt32Ty(VMContext), (LineNo | (ArgNo << 24))),
861 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
862 Constant::getNullValue(Type::getInt32Ty(VMContext))
864 MDNode *Node = MDNode::get(VMContext, Elts);
865 if (AlwaysPreserve) {
866 // The optimizer may remove local variable. If there is an interest
867 // to preserve variable info in such situation then stash it in a
869 DISubprogram Fn(getDISubprogram(Scope));
870 NamedMDNode *FnLocals = getOrInsertFnSpecificMDNode(M, Fn);
871 FnLocals->addOperand(Node);
873 return DIVariable(Node);
876 /// createComplexVariable - Create a new descriptor for the specified variable
877 /// which has a complex address expression for its address.
878 DIVariable DIBuilder::createComplexVariable(unsigned Tag, DIDescriptor Scope,
879 StringRef Name, DIFile F,
881 DIType Ty, ArrayRef<Value *> Addr,
883 SmallVector<Value *, 15> Elts;
884 Elts.push_back(GetTagConstant(VMContext, Tag));
885 Elts.push_back(getNonCompileUnitScope(Scope)),
886 Elts.push_back(MDString::get(VMContext, Name));
888 Elts.push_back(ConstantInt::get(Type::getInt32Ty(VMContext),
889 (LineNo | (ArgNo << 24))));
891 Elts.push_back(Constant::getNullValue(Type::getInt32Ty(VMContext)));
892 Elts.push_back(Constant::getNullValue(Type::getInt32Ty(VMContext)));
893 Elts.append(Addr.begin(), Addr.end());
895 return DIVariable(MDNode::get(VMContext, Elts));
898 /// createFunction - Create a new descriptor for the specified function.
899 DISubprogram DIBuilder::createFunction(DIDescriptor Context,
901 StringRef LinkageName,
902 DIFile File, unsigned LineNo,
904 bool isLocalToUnit, bool isDefinition,
906 unsigned Flags, bool isOptimized,
910 Value *TElts[] = { GetTagConstant(VMContext, DW_TAG_base_type) };
911 MDNode *Temp = MDNode::getTemporary(VMContext, TElts);
912 Value *TVElts[] = { Temp };
913 MDNode *THolder = MDNode::get(VMContext, TVElts);
916 GetTagConstant(VMContext, dwarf::DW_TAG_subprogram),
917 Constant::getNullValue(Type::getInt32Ty(VMContext)),
918 getNonCompileUnitScope(Context),
919 MDString::get(VMContext, Name),
920 MDString::get(VMContext, Name),
921 MDString::get(VMContext, LinkageName),
923 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
925 ConstantInt::get(Type::getInt1Ty(VMContext), isLocalToUnit),
926 ConstantInt::get(Type::getInt1Ty(VMContext), isDefinition),
927 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
928 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
930 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
931 ConstantInt::get(Type::getInt1Ty(VMContext), isOptimized),
936 ConstantInt::get(Type::getInt32Ty(VMContext), ScopeLine)
938 MDNode *Node = MDNode::get(VMContext, Elts);
940 // Create a named metadata so that we do not lose this mdnode.
941 AllSubprograms.push_back(Node);
942 return DISubprogram(Node);
945 /// createMethod - Create a new descriptor for the specified C++ method.
946 DISubprogram DIBuilder::createMethod(DIDescriptor Context,
948 StringRef LinkageName,
950 unsigned LineNo, DIType Ty,
953 unsigned VK, unsigned VIndex,
954 MDNode *VTableHolder,
959 Value *TElts[] = { GetTagConstant(VMContext, DW_TAG_base_type) };
960 MDNode *Temp = MDNode::getTemporary(VMContext, TElts);
961 Value *TVElts[] = { Temp };
962 MDNode *THolder = MDNode::get(VMContext, TVElts);
965 GetTagConstant(VMContext, dwarf::DW_TAG_subprogram),
966 Constant::getNullValue(Type::getInt32Ty(VMContext)),
967 getNonCompileUnitScope(Context),
968 MDString::get(VMContext, Name),
969 MDString::get(VMContext, Name),
970 MDString::get(VMContext, LinkageName),
972 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
974 ConstantInt::get(Type::getInt1Ty(VMContext), isLocalToUnit),
975 ConstantInt::get(Type::getInt1Ty(VMContext), isDefinition),
976 ConstantInt::get(Type::getInt32Ty(VMContext), (unsigned)VK),
977 ConstantInt::get(Type::getInt32Ty(VMContext), VIndex),
979 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
980 ConstantInt::get(Type::getInt1Ty(VMContext), isOptimized),
983 Constant::getNullValue(Type::getInt32Ty(VMContext)),
985 // FIXME: Do we want to use different scope/lines?
986 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo)
988 MDNode *Node = MDNode::get(VMContext, Elts);
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 return DINameSpace(MDNode::get(VMContext, Elts));
1006 /// createLexicalBlockFile - This creates a new MDNode that encapsulates
1007 /// an existing scope with a new filename.
1008 DILexicalBlockFile DIBuilder::createLexicalBlockFile(DIDescriptor Scope,
1011 GetTagConstant(VMContext, dwarf::DW_TAG_lexical_block),
1015 return DILexicalBlockFile(MDNode::get(VMContext, Elts));
1018 DILexicalBlock DIBuilder::createLexicalBlock(DIDescriptor Scope, DIFile File,
1019 unsigned Line, unsigned Col) {
1020 // Defeat MDNode uniqing for lexical blocks by using unique id.
1021 static unsigned int unique_id = 0;
1023 GetTagConstant(VMContext, dwarf::DW_TAG_lexical_block),
1024 getNonCompileUnitScope(Scope),
1025 ConstantInt::get(Type::getInt32Ty(VMContext), Line),
1026 ConstantInt::get(Type::getInt32Ty(VMContext), Col),
1028 ConstantInt::get(Type::getInt32Ty(VMContext), unique_id++)
1030 return DILexicalBlock(MDNode::get(VMContext, Elts));
1033 /// insertDeclare - Insert a new llvm.dbg.declare intrinsic call.
1034 Instruction *DIBuilder::insertDeclare(Value *Storage, DIVariable VarInfo,
1035 Instruction *InsertBefore) {
1036 assert(Storage && "no storage passed to dbg.declare");
1037 assert(VarInfo.Verify() && "empty DIVariable passed to dbg.declare");
1039 DeclareFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_declare);
1041 Value *Args[] = { MDNode::get(Storage->getContext(), Storage), VarInfo };
1042 return CallInst::Create(DeclareFn, Args, "", InsertBefore);
1045 /// insertDeclare - Insert a new llvm.dbg.declare intrinsic call.
1046 Instruction *DIBuilder::insertDeclare(Value *Storage, DIVariable VarInfo,
1047 BasicBlock *InsertAtEnd) {
1048 assert(Storage && "no storage passed to dbg.declare");
1049 assert(VarInfo.Verify() && "invalid DIVariable passed to dbg.declare");
1051 DeclareFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_declare);
1053 Value *Args[] = { MDNode::get(Storage->getContext(), Storage), VarInfo };
1055 // If this block already has a terminator then insert this intrinsic
1056 // before the terminator.
1057 if (TerminatorInst *T = InsertAtEnd->getTerminator())
1058 return CallInst::Create(DeclareFn, Args, "", T);
1060 return CallInst::Create(DeclareFn, Args, "", InsertAtEnd);
1063 /// insertDbgValueIntrinsic - Insert a new llvm.dbg.value intrinsic call.
1064 Instruction *DIBuilder::insertDbgValueIntrinsic(Value *V, uint64_t Offset,
1066 Instruction *InsertBefore) {
1067 assert(V && "no value passed to dbg.value");
1068 assert(VarInfo.Verify() && "invalid DIVariable passed to dbg.value");
1070 ValueFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_value);
1072 Value *Args[] = { MDNode::get(V->getContext(), V),
1073 ConstantInt::get(Type::getInt64Ty(V->getContext()), Offset),
1075 return CallInst::Create(ValueFn, Args, "", InsertBefore);
1078 /// insertDbgValueIntrinsic - Insert a new llvm.dbg.value intrinsic call.
1079 Instruction *DIBuilder::insertDbgValueIntrinsic(Value *V, uint64_t Offset,
1081 BasicBlock *InsertAtEnd) {
1082 assert(V && "no value passed to dbg.value");
1083 assert(VarInfo.Verify() && "invalid DIVariable passed to dbg.value");
1085 ValueFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_value);
1087 Value *Args[] = { MDNode::get(V->getContext(), V),
1088 ConstantInt::get(Type::getInt64Ty(V->getContext()), Offset),
1090 return CallInst::Create(ValueFn, Args, "", InsertAtEnd);