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/Analysis/DIBuilder.h"
15 #include "llvm/Analysis/DebugInfo.h"
16 #include "llvm/Constants.h"
17 #include "llvm/IntrinsicInst.h"
18 #include "llvm/Module.h"
19 #include "llvm/ADT/STLExtras.h"
20 #include "llvm/Support/Dwarf.h"
23 using namespace llvm::dwarf;
25 static Constant *GetTagConstant(LLVMContext &VMContext, unsigned Tag) {
26 assert((Tag & LLVMDebugVersionMask) == 0 &&
27 "Tag too large for debug encoding!");
28 return ConstantInt::get(Type::getInt32Ty(VMContext), Tag | LLVMDebugVersion);
31 DIBuilder::DIBuilder(Module &m)
32 : M(m), VMContext(M.getContext()), TheCU(0), TempEnumTypes(0),
33 TempRetainTypes(0), TempSubprograms(0), TempGVs(0), DeclareFn(0),
37 /// finalize - Construct any deferred debug info descriptors.
38 void DIBuilder::finalize() {
39 DIArray Enums = getOrCreateArray(AllEnumTypes);
40 DIType(TempEnumTypes).replaceAllUsesWith(Enums);
42 DIArray RetainTypes = getOrCreateArray(AllRetainTypes);
43 DIType(TempRetainTypes).replaceAllUsesWith(RetainTypes);
45 DIArray SPs = getOrCreateArray(AllSubprograms);
46 DIType(TempSubprograms).replaceAllUsesWith(SPs);
47 for (unsigned i = 0, e = SPs.getNumElements(); i != e; ++i) {
48 DISubprogram SP(SPs.getElement(i));
49 if (NamedMDNode *NMD = getFnSpecificMDNode(M, SP)) {
50 SmallVector<Value *, 4> Variables;
51 for (unsigned ii = 0, ee = NMD->getNumOperands(); ii != ee; ++ii)
52 Variables.push_back(NMD->getOperand(ii));
53 if (MDNode *Temp = SP.getVariablesNodes()) {
54 DIArray AV = getOrCreateArray(Variables);
55 DIType(Temp).replaceAllUsesWith(AV);
57 NMD->eraseFromParent();
61 DIArray GVs = getOrCreateArray(AllGVs);
62 DIType(TempGVs).replaceAllUsesWith(GVs);
65 /// getNonCompileUnitScope - If N is compile unit return NULL otherwise return
67 static MDNode *getNonCompileUnitScope(MDNode *N) {
68 if (DIDescriptor(N).isCompileUnit())
73 /// createCompileUnit - A CompileUnit provides an anchor for all debugging
74 /// information generated during this instance of compilation.
75 void DIBuilder::createCompileUnit(unsigned Lang, StringRef Filename,
76 StringRef Directory, StringRef Producer,
77 bool isOptimized, StringRef Flags,
78 unsigned RunTimeVer) {
79 assert(((Lang <= dwarf::DW_LANG_Python && Lang >= dwarf::DW_LANG_C89) ||
80 (Lang <= dwarf::DW_LANG_hi_user && Lang >= dwarf::DW_LANG_lo_user)) &&
81 "Invalid Language tag");
82 assert(!Filename.empty() &&
83 "Unable to create compile unit without filename");
84 Value *TElts[] = { GetTagConstant(VMContext, DW_TAG_base_type) };
85 TempEnumTypes = MDNode::getTemporary(VMContext, TElts);
86 Value *THElts[] = { TempEnumTypes };
87 MDNode *EnumHolder = MDNode::get(VMContext, THElts);
89 TempRetainTypes = MDNode::getTemporary(VMContext, TElts);
90 Value *TRElts[] = { TempRetainTypes };
91 MDNode *RetainHolder = MDNode::get(VMContext, TRElts);
93 TempSubprograms = MDNode::getTemporary(VMContext, TElts);
94 Value *TSElts[] = { TempSubprograms };
95 MDNode *SPHolder = MDNode::get(VMContext, TSElts);
97 TempGVs = MDNode::getTemporary(VMContext, TElts);
98 Value *TVElts[] = { TempGVs };
99 MDNode *GVHolder = MDNode::get(VMContext, TVElts);
102 GetTagConstant(VMContext, dwarf::DW_TAG_compile_unit),
103 llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
104 ConstantInt::get(Type::getInt32Ty(VMContext), Lang),
105 MDString::get(VMContext, Filename),
106 MDString::get(VMContext, Directory),
107 MDString::get(VMContext, Producer),
108 // Deprecate isMain field.
109 ConstantInt::get(Type::getInt1Ty(VMContext), true), // isMain
110 ConstantInt::get(Type::getInt1Ty(VMContext), isOptimized),
111 MDString::get(VMContext, Flags),
112 ConstantInt::get(Type::getInt32Ty(VMContext), RunTimeVer),
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) {
128 assert(TheCU && "Unable to create DW_TAG_file_type without CompileUnit");
129 assert(!Filename.empty() && "Unable to create file without name");
131 GetTagConstant(VMContext, dwarf::DW_TAG_file_type),
132 MDString::get(VMContext, Filename),
133 MDString::get(VMContext, Directory),
136 return DIFile(MDNode::get(VMContext, Elts));
139 /// createEnumerator - Create a single enumerator value.
140 DIEnumerator DIBuilder::createEnumerator(StringRef Name, uint64_t Val) {
141 assert(!Name.empty() && "Unable to create enumerator without name");
143 GetTagConstant(VMContext, dwarf::DW_TAG_enumerator),
144 MDString::get(VMContext, Name),
145 ConstantInt::get(Type::getInt64Ty(VMContext), Val)
147 return DIEnumerator(MDNode::get(VMContext, Elts));
150 /// createNullPtrType - Create C++0x nullptr type.
151 DIType DIBuilder::createNullPtrType(StringRef Name) {
152 assert(!Name.empty() && "Unable to create type without name");
153 // nullptr is encoded in DIBasicType format. Line number, filename,
154 // ,size, alignment, offset and flags are always empty here.
156 GetTagConstant(VMContext, dwarf::DW_TAG_unspecified_type),
158 MDString::get(VMContext, Name),
160 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
161 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Size
162 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Align
163 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
164 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags;
165 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Encoding
167 return DIType(MDNode::get(VMContext, Elts));
170 /// createBasicType - Create debugging information entry for a basic
171 /// type, e.g 'char'.
172 DIType DIBuilder::createBasicType(StringRef Name, uint64_t SizeInBits,
173 uint64_t AlignInBits,
175 assert(!Name.empty() && "Unable to create type without name");
176 // Basic types are encoded in DIBasicType format. Line number, filename,
177 // offset and flags are always empty here.
179 GetTagConstant(VMContext, dwarf::DW_TAG_base_type),
181 MDString::get(VMContext, Name),
183 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
184 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
185 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
186 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
187 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags;
188 ConstantInt::get(Type::getInt32Ty(VMContext), Encoding)
190 return DIType(MDNode::get(VMContext, Elts));
193 /// createQualifiedType - Create debugging information entry for a qualified
194 /// type, e.g. 'const int'.
195 DIType DIBuilder::createQualifiedType(unsigned Tag, DIType FromTy) {
196 // Qualified types are encoded in DIDerivedType format.
198 GetTagConstant(VMContext, Tag),
200 MDString::get(VMContext, StringRef()), // Empty name.
202 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
203 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Size
204 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Align
205 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
206 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags
209 return DIType(MDNode::get(VMContext, Elts));
212 /// createPointerType - Create debugging information entry for a pointer.
213 DIType DIBuilder::createPointerType(DIType PointeeTy, uint64_t SizeInBits,
214 uint64_t AlignInBits, StringRef Name) {
215 // Pointer types are encoded in DIDerivedType format.
217 GetTagConstant(VMContext, dwarf::DW_TAG_pointer_type),
219 MDString::get(VMContext, Name),
221 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
222 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
223 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
224 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
225 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags
228 return DIType(MDNode::get(VMContext, Elts));
231 /// createReferenceType - Create debugging information entry for a reference.
232 DIType DIBuilder::createReferenceType(DIType RTy) {
233 assert(RTy.Verify() && "Unable to create reference type");
234 // References are encoded in DIDerivedType format.
236 GetTagConstant(VMContext, dwarf::DW_TAG_reference_type),
240 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
241 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Size
242 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Align
243 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
244 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags
247 return DIType(MDNode::get(VMContext, Elts));
250 /// createTypedef - Create debugging information entry for a typedef.
251 DIType DIBuilder::createTypedef(DIType Ty, StringRef Name, DIFile File,
252 unsigned LineNo, DIDescriptor Context) {
253 // typedefs are encoded in DIDerivedType format.
254 assert(Ty.Verify() && "Invalid typedef type!");
256 GetTagConstant(VMContext, dwarf::DW_TAG_typedef),
257 getNonCompileUnitScope(Context),
258 MDString::get(VMContext, Name),
260 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
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 /// createFriend - Create debugging information entry for a 'friend'.
271 DIType DIBuilder::createFriend(DIType Ty, DIType FriendTy) {
272 // typedefs are encoded in DIDerivedType format.
273 assert(Ty.Verify() && "Invalid type!");
274 assert(FriendTy.Verify() && "Invalid friend type!");
276 GetTagConstant(VMContext, dwarf::DW_TAG_friend),
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 return DIType(MDNode::get(VMContext, Elts));
290 /// createInheritance - Create debugging information entry to establish
291 /// inheritance relationship between two types.
292 DIType DIBuilder::createInheritance(DIType Ty, DIType BaseTy,
293 uint64_t BaseOffset, unsigned Flags) {
294 assert(Ty.Verify() && "Unable to create inheritance");
295 // TAG_inheritance is encoded in DIDerivedType format.
297 GetTagConstant(VMContext, dwarf::DW_TAG_inheritance),
301 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
302 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Size
303 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Align
304 ConstantInt::get(Type::getInt64Ty(VMContext), BaseOffset),
305 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
308 return DIType(MDNode::get(VMContext, Elts));
311 /// createMemberType - Create debugging information entry for a member.
312 DIType DIBuilder::createMemberType(DIDescriptor Scope, StringRef Name,
313 DIFile File, unsigned LineNumber,
314 uint64_t SizeInBits, uint64_t AlignInBits,
315 uint64_t OffsetInBits, unsigned Flags,
317 // TAG_member is encoded in DIDerivedType format.
319 GetTagConstant(VMContext, dwarf::DW_TAG_member),
320 getNonCompileUnitScope(Scope),
321 MDString::get(VMContext, Name),
323 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
324 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
325 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
326 ConstantInt::get(Type::getInt64Ty(VMContext), OffsetInBits),
327 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
330 return DIType(MDNode::get(VMContext, Elts));
333 /// createObjCIVar - Create debugging information entry for Objective-C
334 /// instance variable.
335 DIType DIBuilder::createObjCIVar(StringRef Name,
336 DIFile File, unsigned LineNumber,
337 uint64_t SizeInBits, uint64_t AlignInBits,
338 uint64_t OffsetInBits, unsigned Flags,
339 DIType Ty, StringRef PropertyName,
340 StringRef GetterName, StringRef SetterName,
341 unsigned PropertyAttributes) {
342 // TAG_member is encoded in DIDerivedType format.
344 GetTagConstant(VMContext, dwarf::DW_TAG_member),
345 getNonCompileUnitScope(File),
346 MDString::get(VMContext, Name),
348 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
349 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
350 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
351 ConstantInt::get(Type::getInt64Ty(VMContext), OffsetInBits),
352 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
354 MDString::get(VMContext, PropertyName),
355 MDString::get(VMContext, GetterName),
356 MDString::get(VMContext, SetterName),
357 ConstantInt::get(Type::getInt32Ty(VMContext), PropertyAttributes)
359 return DIType(MDNode::get(VMContext, Elts));
362 /// createObjCIVar - Create debugging information entry for Objective-C
363 /// instance variable.
364 DIType DIBuilder::createObjCIVar(StringRef Name,
365 DIFile File, unsigned LineNumber,
366 uint64_t SizeInBits, uint64_t AlignInBits,
367 uint64_t OffsetInBits, unsigned Flags,
368 DIType Ty, MDNode *PropertyNode) {
369 // TAG_member is encoded in DIDerivedType format.
371 GetTagConstant(VMContext, dwarf::DW_TAG_member),
372 getNonCompileUnitScope(File),
373 MDString::get(VMContext, Name),
375 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
376 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
377 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
378 ConstantInt::get(Type::getInt64Ty(VMContext), OffsetInBits),
379 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
383 return DIType(MDNode::get(VMContext, Elts));
386 /// createObjCProperty - Create debugging information entry for Objective-C
388 DIObjCProperty DIBuilder::createObjCProperty(StringRef Name,
389 StringRef GetterName,
390 StringRef SetterName,
391 unsigned PropertyAttributes) {
393 GetTagConstant(VMContext, dwarf::DW_TAG_APPLE_Property),
394 MDString::get(VMContext, Name),
395 MDString::get(VMContext, GetterName),
396 MDString::get(VMContext, SetterName),
397 ConstantInt::get(Type::getInt32Ty(VMContext), PropertyAttributes)
399 return DIObjCProperty(MDNode::get(VMContext, Elts));
402 /// createClassType - Create debugging information entry for a class.
403 DIType DIBuilder::createClassType(DIDescriptor Context, StringRef Name,
404 DIFile File, unsigned LineNumber,
405 uint64_t SizeInBits, uint64_t AlignInBits,
406 uint64_t OffsetInBits, unsigned Flags,
407 DIType DerivedFrom, DIArray Elements,
408 MDNode *VTableHolder, MDNode *TemplateParams) {
409 // TAG_class_type is encoded in DICompositeType format.
411 GetTagConstant(VMContext, dwarf::DW_TAG_class_type),
412 getNonCompileUnitScope(Context),
413 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::getInt32Ty(VMContext), OffsetInBits),
419 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
422 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
426 return DIType(MDNode::get(VMContext, Elts));
429 /// createTemplateTypeParameter - Create debugging information for template
431 DITemplateTypeParameter
432 DIBuilder::createTemplateTypeParameter(DIDescriptor Context, StringRef Name,
433 DIType Ty, MDNode *File, unsigned LineNo,
436 GetTagConstant(VMContext, dwarf::DW_TAG_template_type_parameter),
437 getNonCompileUnitScope(Context),
438 MDString::get(VMContext, Name),
441 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
442 ConstantInt::get(Type::getInt32Ty(VMContext), ColumnNo)
444 return DITemplateTypeParameter(MDNode::get(VMContext, Elts));
447 /// createTemplateValueParameter - Create debugging information for template
449 DITemplateValueParameter
450 DIBuilder::createTemplateValueParameter(DIDescriptor Context, StringRef Name,
451 DIType Ty, uint64_t Val,
452 MDNode *File, unsigned LineNo,
455 GetTagConstant(VMContext, dwarf::DW_TAG_template_value_parameter),
456 getNonCompileUnitScope(Context),
457 MDString::get(VMContext, Name),
459 ConstantInt::get(Type::getInt64Ty(VMContext), Val),
461 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
462 ConstantInt::get(Type::getInt32Ty(VMContext), ColumnNo)
464 return DITemplateValueParameter(MDNode::get(VMContext, Elts));
467 /// createStructType - Create debugging information entry for a struct.
468 DIType DIBuilder::createStructType(DIDescriptor Context, StringRef Name,
469 DIFile File, unsigned LineNumber,
470 uint64_t SizeInBits, uint64_t AlignInBits,
471 unsigned Flags, DIArray Elements,
472 unsigned RunTimeLang) {
473 // TAG_structure_type is encoded in DICompositeType format.
475 GetTagConstant(VMContext, dwarf::DW_TAG_structure_type),
476 getNonCompileUnitScope(Context),
477 MDString::get(VMContext, Name),
479 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
480 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
481 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
482 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
483 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
486 ConstantInt::get(Type::getInt32Ty(VMContext), RunTimeLang),
487 llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
489 return DIType(MDNode::get(VMContext, Elts));
492 /// createUnionType - Create debugging information entry for an union.
493 DIType DIBuilder::createUnionType(DIDescriptor Scope, StringRef Name,
495 unsigned LineNumber, uint64_t SizeInBits,
496 uint64_t AlignInBits, unsigned Flags,
497 DIArray Elements, unsigned RunTimeLang) {
498 // TAG_union_type is encoded in DICompositeType format.
500 GetTagConstant(VMContext, dwarf::DW_TAG_union_type),
501 getNonCompileUnitScope(Scope),
502 MDString::get(VMContext, Name),
504 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
505 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
506 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
507 ConstantInt::get(Type::getInt64Ty(VMContext), 0),
508 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
511 ConstantInt::get(Type::getInt32Ty(VMContext), RunTimeLang),
512 llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
514 return DIType(MDNode::get(VMContext, Elts));
517 /// createSubroutineType - Create subroutine type.
518 DIType DIBuilder::createSubroutineType(DIFile File, DIArray ParameterTypes) {
519 // TAG_subroutine_type is encoded in DICompositeType format.
521 GetTagConstant(VMContext, dwarf::DW_TAG_subroutine_type),
522 llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
523 MDString::get(VMContext, ""),
524 llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
525 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
526 ConstantInt::get(Type::getInt64Ty(VMContext), 0),
527 ConstantInt::get(Type::getInt64Ty(VMContext), 0),
528 ConstantInt::get(Type::getInt64Ty(VMContext), 0),
529 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
532 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
533 llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
535 return DIType(MDNode::get(VMContext, Elts));
538 /// createEnumerationType - Create debugging information entry for an
540 DIType DIBuilder::createEnumerationType(DIDescriptor Scope, StringRef Name,
541 DIFile File, unsigned LineNumber,
543 uint64_t AlignInBits,
545 // TAG_enumeration_type is encoded in DICompositeType format.
547 GetTagConstant(VMContext, dwarf::DW_TAG_enumeration_type),
548 getNonCompileUnitScope(Scope),
549 MDString::get(VMContext, Name),
551 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
552 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
553 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
554 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
555 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
558 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
559 llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
561 MDNode *Node = MDNode::get(VMContext, Elts);
562 AllEnumTypes.push_back(Node);
566 /// createArrayType - Create debugging information entry for an array.
567 DIType DIBuilder::createArrayType(uint64_t Size, uint64_t AlignInBits,
568 DIType Ty, DIArray Subscripts) {
569 // TAG_array_type is encoded in DICompositeType format.
571 GetTagConstant(VMContext, dwarf::DW_TAG_array_type),
573 MDString::get(VMContext, ""),
575 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
576 ConstantInt::get(Type::getInt64Ty(VMContext), Size),
577 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
578 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
579 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
582 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
583 llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
585 return DIType(MDNode::get(VMContext, Elts));
588 /// createVectorType - Create debugging information entry for a vector.
589 DIType DIBuilder::createVectorType(uint64_t Size, uint64_t AlignInBits,
590 DIType Ty, DIArray Subscripts) {
591 // TAG_vector_type is encoded in DICompositeType format.
593 GetTagConstant(VMContext, dwarf::DW_TAG_vector_type),
595 MDString::get(VMContext, ""),
597 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
598 ConstantInt::get(Type::getInt64Ty(VMContext), Size),
599 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
600 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
601 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
604 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
605 llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
607 return DIType(MDNode::get(VMContext, Elts));
610 /// createArtificialType - Create a new DIType with "artificial" flag set.
611 DIType DIBuilder::createArtificialType(DIType Ty) {
612 if (Ty.isArtificial())
615 SmallVector<Value *, 9> Elts;
617 assert (N && "Unexpected input DIType!");
618 for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i) {
619 if (Value *V = N->getOperand(i))
622 Elts.push_back(Constant::getNullValue(Type::getInt32Ty(VMContext)));
625 unsigned CurFlags = Ty.getFlags();
626 CurFlags = CurFlags | DIType::FlagArtificial;
628 // Flags are stored at this slot.
629 Elts[8] = ConstantInt::get(Type::getInt32Ty(VMContext), CurFlags);
631 return DIType(MDNode::get(VMContext, Elts));
634 /// retainType - Retain DIType in a module even if it is not referenced
635 /// through debug info anchors.
636 void DIBuilder::retainType(DIType T) {
637 AllRetainTypes.push_back(T);
640 /// createUnspecifiedParameter - Create unspeicified type descriptor
641 /// for the subroutine type.
642 DIDescriptor DIBuilder::createUnspecifiedParameter() {
644 GetTagConstant(VMContext, dwarf::DW_TAG_unspecified_parameters)
646 return DIDescriptor(MDNode::get(VMContext, Elts));
649 /// createTemporaryType - Create a temporary forward-declared type.
650 DIType DIBuilder::createTemporaryType() {
651 // Give the temporary MDNode a tag. It doesn't matter what tag we
652 // use here as long as DIType accepts it.
653 Value *Elts[] = { GetTagConstant(VMContext, DW_TAG_base_type) };
654 MDNode *Node = MDNode::getTemporary(VMContext, Elts);
658 /// createTemporaryType - Create a temporary forward-declared type.
659 DIType DIBuilder::createTemporaryType(DIFile F) {
660 // Give the temporary MDNode a tag. It doesn't matter what tag we
661 // use here as long as DIType accepts it.
663 GetTagConstant(VMContext, DW_TAG_base_type),
668 MDNode *Node = MDNode::getTemporary(VMContext, Elts);
672 /// createForwardDecl - Create a temporary forward-declared type that
673 /// can be RAUW'd if the full type is seen.
674 DIType DIBuilder::createForwardDecl(unsigned Tag, StringRef Name, DIFile F,
676 // Create a temporary MDNode.
678 GetTagConstant(VMContext, Tag),
680 MDString::get(VMContext, Name),
682 ConstantInt::get(Type::getInt32Ty(VMContext), Line),
683 // To ease transition include sizes etc of 0.
684 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
685 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
686 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
687 ConstantInt::get(Type::getInt32Ty(VMContext),
688 DIDescriptor::FlagFwdDecl)
690 MDNode *Node = MDNode::getTemporary(VMContext, Elts);
694 /// getOrCreateArray - Get a DIArray, create one if required.
695 DIArray DIBuilder::getOrCreateArray(ArrayRef<Value *> Elements) {
696 if (Elements.empty()) {
697 Value *Null = llvm::Constant::getNullValue(Type::getInt32Ty(VMContext));
698 return DIArray(MDNode::get(VMContext, Null));
700 return DIArray(MDNode::get(VMContext, Elements));
703 /// getOrCreateSubrange - Create a descriptor for a value range. This
704 /// implicitly uniques the values returned.
705 DISubrange DIBuilder::getOrCreateSubrange(int64_t Lo, int64_t Hi) {
707 GetTagConstant(VMContext, dwarf::DW_TAG_subrange_type),
708 ConstantInt::get(Type::getInt64Ty(VMContext), Lo),
709 ConstantInt::get(Type::getInt64Ty(VMContext), Hi)
712 return DISubrange(MDNode::get(VMContext, Elts));
715 /// createGlobalVariable - Create a new descriptor for the specified global.
716 DIGlobalVariable DIBuilder::
717 createGlobalVariable(StringRef Name, DIFile F, unsigned LineNumber,
718 DIType Ty, bool isLocalToUnit, llvm::Value *Val) {
720 GetTagConstant(VMContext, dwarf::DW_TAG_variable),
721 llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
723 MDString::get(VMContext, Name),
724 MDString::get(VMContext, Name),
725 MDString::get(VMContext, Name),
727 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
729 ConstantInt::get(Type::getInt32Ty(VMContext), isLocalToUnit),
730 ConstantInt::get(Type::getInt32Ty(VMContext), 1), /* isDefinition*/
733 MDNode *Node = MDNode::get(VMContext, Elts);
734 AllGVs.push_back(Node);
735 return DIGlobalVariable(Node);
738 /// createStaticVariable - Create a new descriptor for the specified static
740 DIGlobalVariable DIBuilder::
741 createStaticVariable(DIDescriptor Context, StringRef Name,
742 StringRef LinkageName, DIFile F, unsigned LineNumber,
743 DIType Ty, bool isLocalToUnit, llvm::Value *Val) {
745 GetTagConstant(VMContext, dwarf::DW_TAG_variable),
746 llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
747 getNonCompileUnitScope(Context),
748 MDString::get(VMContext, Name),
749 MDString::get(VMContext, Name),
750 MDString::get(VMContext, LinkageName),
752 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
754 ConstantInt::get(Type::getInt32Ty(VMContext), isLocalToUnit),
755 ConstantInt::get(Type::getInt32Ty(VMContext), 1), /* isDefinition*/
758 MDNode *Node = MDNode::get(VMContext, Elts);
759 AllGVs.push_back(Node);
760 return DIGlobalVariable(Node);
763 /// createVariable - Create a new descriptor for the specified variable.
764 DIVariable DIBuilder::createLocalVariable(unsigned Tag, DIDescriptor Scope,
765 StringRef Name, DIFile File,
766 unsigned LineNo, DIType Ty,
767 bool AlwaysPreserve, unsigned Flags,
770 GetTagConstant(VMContext, Tag),
771 getNonCompileUnitScope(Scope),
772 MDString::get(VMContext, Name),
774 ConstantInt::get(Type::getInt32Ty(VMContext), (LineNo | (ArgNo << 24))),
776 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
777 Constant::getNullValue(Type::getInt32Ty(VMContext)),
779 MDNode *Node = MDNode::get(VMContext, Elts);
780 if (AlwaysPreserve) {
781 // The optimizer may remove local variable. If there is an interest
782 // to preserve variable info in such situation then stash it in a
784 DISubprogram Fn(getDISubprogram(Scope));
785 NamedMDNode *FnLocals = getOrInsertFnSpecificMDNode(M, Fn);
786 FnLocals->addOperand(Node);
788 return DIVariable(Node);
791 /// createComplexVariable - Create a new descriptor for the specified variable
792 /// which has a complex address expression for its address.
793 DIVariable DIBuilder::createComplexVariable(unsigned Tag, DIDescriptor Scope,
794 StringRef Name, DIFile F,
796 DIType Ty, ArrayRef<Value *> Addr,
798 SmallVector<Value *, 15> Elts;
799 Elts.push_back(GetTagConstant(VMContext, Tag));
800 Elts.push_back(getNonCompileUnitScope(Scope)),
801 Elts.push_back(MDString::get(VMContext, Name));
803 Elts.push_back(ConstantInt::get(Type::getInt32Ty(VMContext),
804 (LineNo | (ArgNo << 24))));
806 Elts.push_back(llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)));
807 Elts.push_back(llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)));
808 Elts.append(Addr.begin(), Addr.end());
810 return DIVariable(MDNode::get(VMContext, Elts));
813 /// createFunction - Create a new descriptor for the specified function.
814 DISubprogram DIBuilder::createFunction(DIDescriptor Context,
816 StringRef LinkageName,
817 DIFile File, unsigned LineNo,
819 bool isLocalToUnit, bool isDefinition,
820 unsigned Flags, bool isOptimized,
824 Value *TElts[] = { GetTagConstant(VMContext, DW_TAG_base_type) };
825 MDNode *Temp = MDNode::getTemporary(VMContext, TElts);
826 Value *TVElts[] = { Temp };
827 MDNode *THolder = MDNode::get(VMContext, TVElts);
830 GetTagConstant(VMContext, dwarf::DW_TAG_subprogram),
831 llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
832 getNonCompileUnitScope(Context),
833 MDString::get(VMContext, Name),
834 MDString::get(VMContext, Name),
835 MDString::get(VMContext, LinkageName),
837 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
839 ConstantInt::get(Type::getInt1Ty(VMContext), isLocalToUnit),
840 ConstantInt::get(Type::getInt1Ty(VMContext), isDefinition),
841 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
842 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
844 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
845 ConstantInt::get(Type::getInt1Ty(VMContext), isOptimized),
851 MDNode *Node = MDNode::get(VMContext, Elts);
853 // Create a named metadata so that we do not lose this mdnode.
854 AllSubprograms.push_back(Node);
855 return DISubprogram(Node);
858 /// createMethod - Create a new descriptor for the specified C++ method.
859 DISubprogram DIBuilder::createMethod(DIDescriptor Context,
861 StringRef LinkageName,
863 unsigned LineNo, DIType Ty,
866 unsigned VK, unsigned VIndex,
867 MDNode *VTableHolder,
872 Value *TElts[] = { GetTagConstant(VMContext, DW_TAG_base_type) };
873 MDNode *Temp = MDNode::getTemporary(VMContext, TElts);
874 Value *TVElts[] = { Temp };
875 MDNode *THolder = MDNode::get(VMContext, TVElts);
878 GetTagConstant(VMContext, dwarf::DW_TAG_subprogram),
879 llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
880 getNonCompileUnitScope(Context),
881 MDString::get(VMContext, Name),
882 MDString::get(VMContext, Name),
883 MDString::get(VMContext, LinkageName),
885 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
887 ConstantInt::get(Type::getInt1Ty(VMContext), isLocalToUnit),
888 ConstantInt::get(Type::getInt1Ty(VMContext), isDefinition),
889 ConstantInt::get(Type::getInt32Ty(VMContext), (unsigned)VK),
890 ConstantInt::get(Type::getInt32Ty(VMContext), VIndex),
892 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
893 ConstantInt::get(Type::getInt1Ty(VMContext), isOptimized),
896 llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
899 MDNode *Node = MDNode::get(VMContext, Elts);
900 return DISubprogram(Node);
903 /// createNameSpace - This creates new descriptor for a namespace
904 /// with the specified parent scope.
905 DINameSpace DIBuilder::createNameSpace(DIDescriptor Scope, StringRef Name,
906 DIFile File, unsigned LineNo) {
908 GetTagConstant(VMContext, dwarf::DW_TAG_namespace),
909 getNonCompileUnitScope(Scope),
910 MDString::get(VMContext, Name),
912 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo)
914 return DINameSpace(MDNode::get(VMContext, Elts));
917 /// createLexicalBlockFile - This creates a new MDNode that encapsulates
918 /// an existing scope with a new filename.
919 DILexicalBlockFile DIBuilder::createLexicalBlockFile(DIDescriptor Scope,
922 GetTagConstant(VMContext, dwarf::DW_TAG_lexical_block),
926 return DILexicalBlockFile(MDNode::get(VMContext, Elts));
929 DILexicalBlock DIBuilder::createLexicalBlock(DIDescriptor Scope, DIFile File,
930 unsigned Line, unsigned Col) {
931 // Defeat MDNode uniqing for lexical blocks by using unique id.
932 static unsigned int unique_id = 0;
934 GetTagConstant(VMContext, dwarf::DW_TAG_lexical_block),
935 getNonCompileUnitScope(Scope),
936 ConstantInt::get(Type::getInt32Ty(VMContext), Line),
937 ConstantInt::get(Type::getInt32Ty(VMContext), Col),
939 ConstantInt::get(Type::getInt32Ty(VMContext), unique_id++)
941 return DILexicalBlock(MDNode::get(VMContext, Elts));
944 /// insertDeclare - Insert a new llvm.dbg.declare intrinsic call.
945 Instruction *DIBuilder::insertDeclare(Value *Storage, DIVariable VarInfo,
946 Instruction *InsertBefore) {
947 assert(Storage && "no storage passed to dbg.declare");
948 assert(VarInfo.Verify() && "empty DIVariable passed to dbg.declare");
950 DeclareFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_declare);
952 Value *Args[] = { MDNode::get(Storage->getContext(), Storage), VarInfo };
953 return CallInst::Create(DeclareFn, Args, "", InsertBefore);
956 /// insertDeclare - Insert a new llvm.dbg.declare intrinsic call.
957 Instruction *DIBuilder::insertDeclare(Value *Storage, DIVariable VarInfo,
958 BasicBlock *InsertAtEnd) {
959 assert(Storage && "no storage passed to dbg.declare");
960 assert(VarInfo.Verify() && "invalid DIVariable passed to dbg.declare");
962 DeclareFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_declare);
964 Value *Args[] = { MDNode::get(Storage->getContext(), Storage), VarInfo };
966 // If this block already has a terminator then insert this intrinsic
967 // before the terminator.
968 if (TerminatorInst *T = InsertAtEnd->getTerminator())
969 return CallInst::Create(DeclareFn, Args, "", T);
971 return CallInst::Create(DeclareFn, Args, "", InsertAtEnd);
974 /// insertDbgValueIntrinsic - Insert a new llvm.dbg.value intrinsic call.
975 Instruction *DIBuilder::insertDbgValueIntrinsic(Value *V, uint64_t Offset,
977 Instruction *InsertBefore) {
978 assert(V && "no value passed to dbg.value");
979 assert(VarInfo.Verify() && "invalid DIVariable passed to dbg.value");
981 ValueFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_value);
983 Value *Args[] = { MDNode::get(V->getContext(), V),
984 ConstantInt::get(Type::getInt64Ty(V->getContext()), Offset),
986 return CallInst::Create(ValueFn, Args, "", InsertBefore);
989 /// insertDbgValueIntrinsic - Insert a new llvm.dbg.value intrinsic call.
990 Instruction *DIBuilder::insertDbgValueIntrinsic(Value *V, uint64_t Offset,
992 BasicBlock *InsertAtEnd) {
993 assert(V && "no value passed to dbg.value");
994 assert(VarInfo.Verify() && "invalid DIVariable passed to dbg.value");
996 ValueFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_value);
998 Value *Args[] = { MDNode::get(V->getContext(), V),
999 ConstantInt::get(Type::getInt64Ty(V->getContext()), Offset),
1001 return CallInst::Create(ValueFn, Args, "", InsertAtEnd);