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 DIFile File, unsigned LineNumber,
390 StringRef GetterName,
391 StringRef SetterName,
392 unsigned PropertyAttributes,
395 GetTagConstant(VMContext, dwarf::DW_TAG_APPLE_property),
396 MDString::get(VMContext, Name),
398 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
399 MDString::get(VMContext, GetterName),
400 MDString::get(VMContext, SetterName),
401 ConstantInt::get(Type::getInt32Ty(VMContext), PropertyAttributes),
404 return DIObjCProperty(MDNode::get(VMContext, Elts));
407 /// createClassType - Create debugging information entry for a class.
408 DIType DIBuilder::createClassType(DIDescriptor Context, StringRef Name,
409 DIFile File, unsigned LineNumber,
410 uint64_t SizeInBits, uint64_t AlignInBits,
411 uint64_t OffsetInBits, unsigned Flags,
412 DIType DerivedFrom, DIArray Elements,
413 MDNode *VTableHolder, MDNode *TemplateParams) {
414 // TAG_class_type is encoded in DICompositeType format.
416 GetTagConstant(VMContext, dwarf::DW_TAG_class_type),
417 getNonCompileUnitScope(Context),
418 MDString::get(VMContext, Name),
420 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
421 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
422 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
423 ConstantInt::get(Type::getInt32Ty(VMContext), OffsetInBits),
424 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
427 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
431 return DIType(MDNode::get(VMContext, Elts));
434 /// createTemplateTypeParameter - Create debugging information for template
436 DITemplateTypeParameter
437 DIBuilder::createTemplateTypeParameter(DIDescriptor Context, StringRef Name,
438 DIType Ty, MDNode *File, unsigned LineNo,
441 GetTagConstant(VMContext, dwarf::DW_TAG_template_type_parameter),
442 getNonCompileUnitScope(Context),
443 MDString::get(VMContext, Name),
446 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
447 ConstantInt::get(Type::getInt32Ty(VMContext), ColumnNo)
449 return DITemplateTypeParameter(MDNode::get(VMContext, Elts));
452 /// createTemplateValueParameter - Create debugging information for template
454 DITemplateValueParameter
455 DIBuilder::createTemplateValueParameter(DIDescriptor Context, StringRef Name,
456 DIType Ty, uint64_t Val,
457 MDNode *File, unsigned LineNo,
460 GetTagConstant(VMContext, dwarf::DW_TAG_template_value_parameter),
461 getNonCompileUnitScope(Context),
462 MDString::get(VMContext, Name),
464 ConstantInt::get(Type::getInt64Ty(VMContext), Val),
466 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
467 ConstantInt::get(Type::getInt32Ty(VMContext), ColumnNo)
469 return DITemplateValueParameter(MDNode::get(VMContext, Elts));
472 /// createStructType - Create debugging information entry for a struct.
473 DIType DIBuilder::createStructType(DIDescriptor Context, StringRef Name,
474 DIFile File, unsigned LineNumber,
475 uint64_t SizeInBits, uint64_t AlignInBits,
476 unsigned Flags, DIArray Elements,
477 unsigned RunTimeLang) {
478 // TAG_structure_type is encoded in DICompositeType format.
480 GetTagConstant(VMContext, dwarf::DW_TAG_structure_type),
481 getNonCompileUnitScope(Context),
482 MDString::get(VMContext, Name),
484 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
485 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
486 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
487 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
488 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
491 ConstantInt::get(Type::getInt32Ty(VMContext), RunTimeLang),
492 llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
494 return DIType(MDNode::get(VMContext, Elts));
497 /// createUnionType - Create debugging information entry for an union.
498 DIType DIBuilder::createUnionType(DIDescriptor Scope, StringRef Name,
500 unsigned LineNumber, uint64_t SizeInBits,
501 uint64_t AlignInBits, unsigned Flags,
502 DIArray Elements, unsigned RunTimeLang) {
503 // TAG_union_type is encoded in DICompositeType format.
505 GetTagConstant(VMContext, dwarf::DW_TAG_union_type),
506 getNonCompileUnitScope(Scope),
507 MDString::get(VMContext, Name),
509 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
510 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
511 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
512 ConstantInt::get(Type::getInt64Ty(VMContext), 0),
513 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
516 ConstantInt::get(Type::getInt32Ty(VMContext), RunTimeLang),
517 llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
519 return DIType(MDNode::get(VMContext, Elts));
522 /// createSubroutineType - Create subroutine type.
523 DIType DIBuilder::createSubroutineType(DIFile File, DIArray ParameterTypes) {
524 // TAG_subroutine_type is encoded in DICompositeType format.
526 GetTagConstant(VMContext, dwarf::DW_TAG_subroutine_type),
527 llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
528 MDString::get(VMContext, ""),
529 llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
530 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
531 ConstantInt::get(Type::getInt64Ty(VMContext), 0),
532 ConstantInt::get(Type::getInt64Ty(VMContext), 0),
533 ConstantInt::get(Type::getInt64Ty(VMContext), 0),
534 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
537 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
538 llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
540 return DIType(MDNode::get(VMContext, Elts));
543 /// createEnumerationType - Create debugging information entry for an
545 DIType DIBuilder::createEnumerationType(DIDescriptor Scope, StringRef Name,
546 DIFile File, unsigned LineNumber,
548 uint64_t AlignInBits,
550 // TAG_enumeration_type is encoded in DICompositeType format.
552 GetTagConstant(VMContext, dwarf::DW_TAG_enumeration_type),
553 getNonCompileUnitScope(Scope),
554 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), 0),
560 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
563 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
564 llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
566 MDNode *Node = MDNode::get(VMContext, Elts);
567 AllEnumTypes.push_back(Node);
571 /// createArrayType - Create debugging information entry for an array.
572 DIType DIBuilder::createArrayType(uint64_t Size, uint64_t AlignInBits,
573 DIType Ty, DIArray Subscripts) {
574 // TAG_array_type is encoded in DICompositeType format.
576 GetTagConstant(VMContext, dwarf::DW_TAG_array_type),
578 MDString::get(VMContext, ""),
580 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
581 ConstantInt::get(Type::getInt64Ty(VMContext), Size),
582 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
583 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
584 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
587 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
588 llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
590 return DIType(MDNode::get(VMContext, Elts));
593 /// createVectorType - Create debugging information entry for a vector.
594 DIType DIBuilder::createVectorType(uint64_t Size, uint64_t AlignInBits,
595 DIType Ty, DIArray Subscripts) {
596 // TAG_vector_type is encoded in DICompositeType format.
598 GetTagConstant(VMContext, dwarf::DW_TAG_vector_type),
600 MDString::get(VMContext, ""),
602 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
603 ConstantInt::get(Type::getInt64Ty(VMContext), Size),
604 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
605 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
606 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
609 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
610 llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
612 return DIType(MDNode::get(VMContext, Elts));
615 /// createArtificialType - Create a new DIType with "artificial" flag set.
616 DIType DIBuilder::createArtificialType(DIType Ty) {
617 if (Ty.isArtificial())
620 SmallVector<Value *, 9> Elts;
622 assert (N && "Unexpected input DIType!");
623 for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i) {
624 if (Value *V = N->getOperand(i))
627 Elts.push_back(Constant::getNullValue(Type::getInt32Ty(VMContext)));
630 unsigned CurFlags = Ty.getFlags();
631 CurFlags = CurFlags | DIType::FlagArtificial;
633 // Flags are stored at this slot.
634 Elts[8] = ConstantInt::get(Type::getInt32Ty(VMContext), CurFlags);
636 return DIType(MDNode::get(VMContext, Elts));
639 /// retainType - Retain DIType in a module even if it is not referenced
640 /// through debug info anchors.
641 void DIBuilder::retainType(DIType T) {
642 AllRetainTypes.push_back(T);
645 /// createUnspecifiedParameter - Create unspeicified type descriptor
646 /// for the subroutine type.
647 DIDescriptor DIBuilder::createUnspecifiedParameter() {
649 GetTagConstant(VMContext, dwarf::DW_TAG_unspecified_parameters)
651 return DIDescriptor(MDNode::get(VMContext, Elts));
654 /// createTemporaryType - Create a temporary forward-declared type.
655 DIType DIBuilder::createTemporaryType() {
656 // Give the temporary MDNode a tag. It doesn't matter what tag we
657 // use here as long as DIType accepts it.
658 Value *Elts[] = { GetTagConstant(VMContext, DW_TAG_base_type) };
659 MDNode *Node = MDNode::getTemporary(VMContext, Elts);
663 /// createTemporaryType - Create a temporary forward-declared type.
664 DIType DIBuilder::createTemporaryType(DIFile F) {
665 // Give the temporary MDNode a tag. It doesn't matter what tag we
666 // use here as long as DIType accepts it.
668 GetTagConstant(VMContext, DW_TAG_base_type),
673 MDNode *Node = MDNode::getTemporary(VMContext, Elts);
677 /// createForwardDecl - Create a temporary forward-declared type that
678 /// can be RAUW'd if the full type is seen.
679 DIType DIBuilder::createForwardDecl(unsigned Tag, StringRef Name, DIFile F,
680 unsigned Line, unsigned RuntimeLang) {
681 // Create a temporary MDNode.
683 GetTagConstant(VMContext, Tag),
685 MDString::get(VMContext, Name),
687 ConstantInt::get(Type::getInt32Ty(VMContext), Line),
688 // To ease transition include sizes etc of 0.
689 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
690 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
691 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
692 ConstantInt::get(Type::getInt32Ty(VMContext),
693 DIDescriptor::FlagFwdDecl),
696 ConstantInt::get(Type::getInt32Ty(VMContext), RuntimeLang)
698 MDNode *Node = MDNode::getTemporary(VMContext, Elts);
702 /// getOrCreateArray - Get a DIArray, create one if required.
703 DIArray DIBuilder::getOrCreateArray(ArrayRef<Value *> Elements) {
704 if (Elements.empty()) {
705 Value *Null = llvm::Constant::getNullValue(Type::getInt32Ty(VMContext));
706 return DIArray(MDNode::get(VMContext, Null));
708 return DIArray(MDNode::get(VMContext, Elements));
711 /// getOrCreateSubrange - Create a descriptor for a value range. This
712 /// implicitly uniques the values returned.
713 DISubrange DIBuilder::getOrCreateSubrange(int64_t Lo, int64_t Hi) {
715 GetTagConstant(VMContext, dwarf::DW_TAG_subrange_type),
716 ConstantInt::get(Type::getInt64Ty(VMContext), Lo),
717 ConstantInt::get(Type::getInt64Ty(VMContext), Hi)
720 return DISubrange(MDNode::get(VMContext, Elts));
723 /// createGlobalVariable - Create a new descriptor for the specified global.
724 DIGlobalVariable DIBuilder::
725 createGlobalVariable(StringRef Name, DIFile F, unsigned LineNumber,
726 DIType Ty, bool isLocalToUnit, llvm::Value *Val) {
728 GetTagConstant(VMContext, dwarf::DW_TAG_variable),
729 llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
731 MDString::get(VMContext, Name),
732 MDString::get(VMContext, Name),
733 MDString::get(VMContext, Name),
735 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
737 ConstantInt::get(Type::getInt32Ty(VMContext), isLocalToUnit),
738 ConstantInt::get(Type::getInt32Ty(VMContext), 1), /* isDefinition*/
741 MDNode *Node = MDNode::get(VMContext, Elts);
742 AllGVs.push_back(Node);
743 return DIGlobalVariable(Node);
746 /// createStaticVariable - Create a new descriptor for the specified static
748 DIGlobalVariable DIBuilder::
749 createStaticVariable(DIDescriptor Context, StringRef Name,
750 StringRef LinkageName, DIFile F, unsigned LineNumber,
751 DIType Ty, bool isLocalToUnit, llvm::Value *Val) {
753 GetTagConstant(VMContext, dwarf::DW_TAG_variable),
754 llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
755 getNonCompileUnitScope(Context),
756 MDString::get(VMContext, Name),
757 MDString::get(VMContext, Name),
758 MDString::get(VMContext, LinkageName),
760 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
762 ConstantInt::get(Type::getInt32Ty(VMContext), isLocalToUnit),
763 ConstantInt::get(Type::getInt32Ty(VMContext), 1), /* isDefinition*/
766 MDNode *Node = MDNode::get(VMContext, Elts);
767 AllGVs.push_back(Node);
768 return DIGlobalVariable(Node);
771 /// createVariable - Create a new descriptor for the specified variable.
772 DIVariable DIBuilder::createLocalVariable(unsigned Tag, DIDescriptor Scope,
773 StringRef Name, DIFile File,
774 unsigned LineNo, DIType Ty,
775 bool AlwaysPreserve, unsigned Flags,
778 GetTagConstant(VMContext, Tag),
779 getNonCompileUnitScope(Scope),
780 MDString::get(VMContext, Name),
782 ConstantInt::get(Type::getInt32Ty(VMContext), (LineNo | (ArgNo << 24))),
784 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
785 Constant::getNullValue(Type::getInt32Ty(VMContext)),
787 MDNode *Node = MDNode::get(VMContext, Elts);
788 if (AlwaysPreserve) {
789 // The optimizer may remove local variable. If there is an interest
790 // to preserve variable info in such situation then stash it in a
792 DISubprogram Fn(getDISubprogram(Scope));
793 NamedMDNode *FnLocals = getOrInsertFnSpecificMDNode(M, Fn);
794 FnLocals->addOperand(Node);
796 return DIVariable(Node);
799 /// createComplexVariable - Create a new descriptor for the specified variable
800 /// which has a complex address expression for its address.
801 DIVariable DIBuilder::createComplexVariable(unsigned Tag, DIDescriptor Scope,
802 StringRef Name, DIFile F,
804 DIType Ty, ArrayRef<Value *> Addr,
806 SmallVector<Value *, 15> Elts;
807 Elts.push_back(GetTagConstant(VMContext, Tag));
808 Elts.push_back(getNonCompileUnitScope(Scope)),
809 Elts.push_back(MDString::get(VMContext, Name));
811 Elts.push_back(ConstantInt::get(Type::getInt32Ty(VMContext),
812 (LineNo | (ArgNo << 24))));
814 Elts.push_back(llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)));
815 Elts.push_back(llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)));
816 Elts.append(Addr.begin(), Addr.end());
818 return DIVariable(MDNode::get(VMContext, Elts));
821 /// createFunction - Create a new descriptor for the specified function.
822 DISubprogram DIBuilder::createFunction(DIDescriptor Context,
824 StringRef LinkageName,
825 DIFile File, unsigned LineNo,
827 bool isLocalToUnit, bool isDefinition,
828 unsigned Flags, bool isOptimized,
832 Value *TElts[] = { GetTagConstant(VMContext, DW_TAG_base_type) };
833 MDNode *Temp = MDNode::getTemporary(VMContext, TElts);
834 Value *TVElts[] = { Temp };
835 MDNode *THolder = MDNode::get(VMContext, TVElts);
838 GetTagConstant(VMContext, dwarf::DW_TAG_subprogram),
839 llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
840 getNonCompileUnitScope(Context),
841 MDString::get(VMContext, Name),
842 MDString::get(VMContext, Name),
843 MDString::get(VMContext, LinkageName),
845 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
847 ConstantInt::get(Type::getInt1Ty(VMContext), isLocalToUnit),
848 ConstantInt::get(Type::getInt1Ty(VMContext), isDefinition),
849 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
850 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
852 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
853 ConstantInt::get(Type::getInt1Ty(VMContext), isOptimized),
859 MDNode *Node = MDNode::get(VMContext, Elts);
861 // Create a named metadata so that we do not lose this mdnode.
862 AllSubprograms.push_back(Node);
863 return DISubprogram(Node);
866 /// createMethod - Create a new descriptor for the specified C++ method.
867 DISubprogram DIBuilder::createMethod(DIDescriptor Context,
869 StringRef LinkageName,
871 unsigned LineNo, DIType Ty,
874 unsigned VK, unsigned VIndex,
875 MDNode *VTableHolder,
880 Value *TElts[] = { GetTagConstant(VMContext, DW_TAG_base_type) };
881 MDNode *Temp = MDNode::getTemporary(VMContext, TElts);
882 Value *TVElts[] = { Temp };
883 MDNode *THolder = MDNode::get(VMContext, TVElts);
886 GetTagConstant(VMContext, dwarf::DW_TAG_subprogram),
887 llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
888 getNonCompileUnitScope(Context),
889 MDString::get(VMContext, Name),
890 MDString::get(VMContext, Name),
891 MDString::get(VMContext, LinkageName),
893 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
895 ConstantInt::get(Type::getInt1Ty(VMContext), isLocalToUnit),
896 ConstantInt::get(Type::getInt1Ty(VMContext), isDefinition),
897 ConstantInt::get(Type::getInt32Ty(VMContext), (unsigned)VK),
898 ConstantInt::get(Type::getInt32Ty(VMContext), VIndex),
900 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
901 ConstantInt::get(Type::getInt1Ty(VMContext), isOptimized),
904 llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
907 MDNode *Node = MDNode::get(VMContext, Elts);
908 return DISubprogram(Node);
911 /// createNameSpace - This creates new descriptor for a namespace
912 /// with the specified parent scope.
913 DINameSpace DIBuilder::createNameSpace(DIDescriptor Scope, StringRef Name,
914 DIFile File, unsigned LineNo) {
916 GetTagConstant(VMContext, dwarf::DW_TAG_namespace),
917 getNonCompileUnitScope(Scope),
918 MDString::get(VMContext, Name),
920 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo)
922 return DINameSpace(MDNode::get(VMContext, Elts));
925 /// createLexicalBlockFile - This creates a new MDNode that encapsulates
926 /// an existing scope with a new filename.
927 DILexicalBlockFile DIBuilder::createLexicalBlockFile(DIDescriptor Scope,
930 GetTagConstant(VMContext, dwarf::DW_TAG_lexical_block),
934 return DILexicalBlockFile(MDNode::get(VMContext, Elts));
937 DILexicalBlock DIBuilder::createLexicalBlock(DIDescriptor Scope, DIFile File,
938 unsigned Line, unsigned Col) {
939 // Defeat MDNode uniqing for lexical blocks by using unique id.
940 static unsigned int unique_id = 0;
942 GetTagConstant(VMContext, dwarf::DW_TAG_lexical_block),
943 getNonCompileUnitScope(Scope),
944 ConstantInt::get(Type::getInt32Ty(VMContext), Line),
945 ConstantInt::get(Type::getInt32Ty(VMContext), Col),
947 ConstantInt::get(Type::getInt32Ty(VMContext), unique_id++)
949 return DILexicalBlock(MDNode::get(VMContext, Elts));
952 /// insertDeclare - Insert a new llvm.dbg.declare intrinsic call.
953 Instruction *DIBuilder::insertDeclare(Value *Storage, DIVariable VarInfo,
954 Instruction *InsertBefore) {
955 assert(Storage && "no storage passed to dbg.declare");
956 assert(VarInfo.Verify() && "empty DIVariable passed to dbg.declare");
958 DeclareFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_declare);
960 Value *Args[] = { MDNode::get(Storage->getContext(), Storage), VarInfo };
961 return CallInst::Create(DeclareFn, Args, "", InsertBefore);
964 /// insertDeclare - Insert a new llvm.dbg.declare intrinsic call.
965 Instruction *DIBuilder::insertDeclare(Value *Storage, DIVariable VarInfo,
966 BasicBlock *InsertAtEnd) {
967 assert(Storage && "no storage passed to dbg.declare");
968 assert(VarInfo.Verify() && "invalid DIVariable passed to dbg.declare");
970 DeclareFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_declare);
972 Value *Args[] = { MDNode::get(Storage->getContext(), Storage), VarInfo };
974 // If this block already has a terminator then insert this intrinsic
975 // before the terminator.
976 if (TerminatorInst *T = InsertAtEnd->getTerminator())
977 return CallInst::Create(DeclareFn, Args, "", T);
979 return CallInst::Create(DeclareFn, Args, "", InsertAtEnd);
982 /// insertDbgValueIntrinsic - Insert a new llvm.dbg.value intrinsic call.
983 Instruction *DIBuilder::insertDbgValueIntrinsic(Value *V, uint64_t Offset,
985 Instruction *InsertBefore) {
986 assert(V && "no value passed to dbg.value");
987 assert(VarInfo.Verify() && "invalid DIVariable passed to dbg.value");
989 ValueFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_value);
991 Value *Args[] = { MDNode::get(V->getContext(), V),
992 ConstantInt::get(Type::getInt64Ty(V->getContext()), Offset),
994 return CallInst::Create(ValueFn, Args, "", InsertBefore);
997 /// insertDbgValueIntrinsic - Insert a new llvm.dbg.value intrinsic call.
998 Instruction *DIBuilder::insertDbgValueIntrinsic(Value *V, uint64_t Offset,
1000 BasicBlock *InsertAtEnd) {
1001 assert(V && "no value passed to dbg.value");
1002 assert(VarInfo.Verify() && "invalid DIVariable passed to dbg.value");
1004 ValueFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_value);
1006 Value *Args[] = { MDNode::get(V->getContext(), V),
1007 ConstantInt::get(Type::getInt64Ty(V->getContext()), Offset),
1009 return CallInst::Create(ValueFn, Args, "", InsertAtEnd);