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), DeclareFn(0), ValueFn(0) {}
34 /// finalize - Construct any deferred debug info descriptors.
35 void DIBuilder::finalize() {
38 /// createCompileUnit - A CompileUnit provides an anchor for all debugging
39 /// information generated during this instance of compilation.
40 void DIBuilder::createCompileUnit(unsigned Lang, StringRef Filename,
41 StringRef Directory, StringRef Producer,
42 bool isOptimized, StringRef Flags,
43 unsigned RunTimeVer) {
45 GetTagConstant(VMContext, dwarf::DW_TAG_compile_unit),
46 llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
47 ConstantInt::get(Type::getInt32Ty(VMContext), Lang),
48 MDString::get(VMContext, Filename),
49 MDString::get(VMContext, Directory),
50 MDString::get(VMContext, Producer),
51 // Deprecate isMain field.
52 ConstantInt::get(Type::getInt1Ty(VMContext), true), // isMain
53 ConstantInt::get(Type::getInt1Ty(VMContext), isOptimized),
54 MDString::get(VMContext, Flags),
55 ConstantInt::get(Type::getInt32Ty(VMContext), RunTimeVer)
57 TheCU = DICompileUnit(MDNode::get(VMContext, Elts));
59 // Create a named metadata so that it is easier to find cu in a module.
60 NamedMDNode *NMD = M.getOrInsertNamedMetadata("llvm.dbg.cu");
61 NMD->addOperand(TheCU);
64 /// createFile - Create a file descriptor to hold debugging information
66 DIFile DIBuilder::createFile(StringRef Filename, StringRef Directory) {
67 assert(TheCU && "Unable to create DW_TAG_file_type without CompileUnit");
69 GetTagConstant(VMContext, dwarf::DW_TAG_file_type),
70 MDString::get(VMContext, Filename),
71 MDString::get(VMContext, Directory),
74 return DIFile(MDNode::get(VMContext, Elts));
77 /// createEnumerator - Create a single enumerator value.
78 DIEnumerator DIBuilder::createEnumerator(StringRef Name, uint64_t Val) {
80 GetTagConstant(VMContext, dwarf::DW_TAG_enumerator),
81 MDString::get(VMContext, Name),
82 ConstantInt::get(Type::getInt64Ty(VMContext), Val)
84 return DIEnumerator(MDNode::get(VMContext, Elts));
87 /// createBasicType - Create debugging information entry for a basic
89 DIType DIBuilder::createBasicType(StringRef Name, uint64_t SizeInBits,
92 // Basic types are encoded in DIBasicType format. Line number, filename,
93 // offset and flags are always empty here.
95 GetTagConstant(VMContext, dwarf::DW_TAG_base_type),
97 MDString::get(VMContext, Name),
99 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
100 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
101 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
102 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
103 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags;
104 ConstantInt::get(Type::getInt32Ty(VMContext), Encoding)
106 return DIType(MDNode::get(VMContext, Elts));
109 /// createQaulifiedType - Create debugging information entry for a qualified
110 /// type, e.g. 'const int'.
111 DIType DIBuilder::createQualifiedType(unsigned Tag, DIType FromTy) {
112 // Qualified types are encoded in DIDerivedType format.
114 GetTagConstant(VMContext, Tag),
116 MDString::get(VMContext, StringRef()), // Empty name.
118 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
119 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Size
120 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Align
121 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
122 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags
125 return DIType(MDNode::get(VMContext, Elts));
128 /// createPointerType - Create debugging information entry for a pointer.
129 DIType DIBuilder::createPointerType(DIType PointeeTy, uint64_t SizeInBits,
130 uint64_t AlignInBits, StringRef Name) {
131 // Pointer types are encoded in DIDerivedType format.
133 GetTagConstant(VMContext, dwarf::DW_TAG_pointer_type),
135 MDString::get(VMContext, Name),
137 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
138 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
139 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
140 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
141 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags
144 return DIType(MDNode::get(VMContext, Elts));
147 /// createReferenceType - Create debugging information entry for a reference.
148 DIType DIBuilder::createReferenceType(DIType RTy) {
149 // References are encoded in DIDerivedType format.
151 GetTagConstant(VMContext, dwarf::DW_TAG_reference_type),
155 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
156 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Size
157 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Align
158 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
159 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags
162 return DIType(MDNode::get(VMContext, Elts));
165 /// createTypedef - Create debugging information entry for a typedef.
166 DIType DIBuilder::createTypedef(DIType Ty, StringRef Name, DIFile File,
167 unsigned LineNo, DIDescriptor Context) {
168 // typedefs are encoded in DIDerivedType format.
169 assert(Ty.Verify() && "Invalid typedef type!");
171 GetTagConstant(VMContext, dwarf::DW_TAG_typedef),
173 MDString::get(VMContext, Name),
175 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
176 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Size
177 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Align
178 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
179 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags
182 return DIType(MDNode::get(VMContext, Elts));
185 /// createFriend - Create debugging information entry for a 'friend'.
186 DIType DIBuilder::createFriend(DIType Ty, DIType FriendTy) {
187 // typedefs are encoded in DIDerivedType format.
188 assert(Ty.Verify() && "Invalid type!");
189 assert(FriendTy.Verify() && "Invalid friend type!");
191 GetTagConstant(VMContext, dwarf::DW_TAG_friend),
195 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
196 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Size
197 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Align
198 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
199 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags
202 return DIType(MDNode::get(VMContext, Elts));
205 /// createInheritance - Create debugging information entry to establish
206 /// inheritnace relationship between two types.
207 DIType DIBuilder::createInheritance(DIType Ty, DIType BaseTy,
208 uint64_t BaseOffset, unsigned Flags) {
209 // TAG_inheritance is encoded in DIDerivedType format.
211 GetTagConstant(VMContext, dwarf::DW_TAG_inheritance),
215 ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
216 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Size
217 ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Align
218 ConstantInt::get(Type::getInt64Ty(VMContext), BaseOffset),
219 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
222 return DIType(MDNode::get(VMContext, Elts));
225 /// createMemberType - Create debugging information entry for a member.
226 DIType DIBuilder::createMemberType(DIDescriptor Scope, StringRef Name,
227 DIFile File, unsigned LineNumber,
228 uint64_t SizeInBits, uint64_t AlignInBits,
229 uint64_t OffsetInBits, unsigned Flags,
231 // TAG_member is encoded in DIDerivedType format.
233 GetTagConstant(VMContext, dwarf::DW_TAG_member),
235 MDString::get(VMContext, Name),
237 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
238 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
239 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
240 ConstantInt::get(Type::getInt64Ty(VMContext), OffsetInBits),
241 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
244 return DIType(MDNode::get(VMContext, Elts));
247 /// createObjCIVar - Create debugging information entry for Objective-C
248 /// instance variable.
249 DIType DIBuilder::createObjCIVar(StringRef Name,
250 DIFile File, unsigned LineNumber,
251 uint64_t SizeInBits, uint64_t AlignInBits,
252 uint64_t OffsetInBits, unsigned Flags,
253 DIType Ty, StringRef PropertyName,
254 StringRef GetterName, StringRef SetterName,
255 unsigned PropertyAttributes) {
256 // TAG_member is encoded in DIDerivedType format.
258 GetTagConstant(VMContext, dwarf::DW_TAG_member),
259 File, // Or TheCU ? Ty ?
260 MDString::get(VMContext, Name),
262 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
263 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
264 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
265 ConstantInt::get(Type::getInt64Ty(VMContext), OffsetInBits),
266 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
268 MDString::get(VMContext, PropertyName),
269 MDString::get(VMContext, GetterName),
270 MDString::get(VMContext, SetterName),
271 ConstantInt::get(Type::getInt32Ty(VMContext), PropertyAttributes)
273 return DIType(MDNode::get(VMContext, Elts));
276 /// createClassType - Create debugging information entry for a class.
277 DIType DIBuilder::createClassType(DIDescriptor Context, StringRef Name,
278 DIFile File, unsigned LineNumber,
279 uint64_t SizeInBits, uint64_t AlignInBits,
280 uint64_t OffsetInBits, unsigned Flags,
281 DIType DerivedFrom, DIArray Elements,
282 MDNode *VTableHoder, MDNode *TemplateParams) {
283 // TAG_class_type is encoded in DICompositeType format.
285 GetTagConstant(VMContext, dwarf::DW_TAG_class_type),
287 MDString::get(VMContext, Name),
289 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
290 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
291 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
292 ConstantInt::get(Type::getInt32Ty(VMContext), OffsetInBits),
293 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
296 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
300 return DIType(MDNode::get(VMContext, Elts));
303 /// createTemplateTypeParameter - Create debugging information for template
305 DITemplateTypeParameter
306 DIBuilder::createTemplateTypeParameter(DIDescriptor Context, StringRef Name,
307 DIType Ty, MDNode *File, unsigned LineNo,
310 GetTagConstant(VMContext, dwarf::DW_TAG_template_type_parameter),
312 MDString::get(VMContext, Name),
315 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
316 ConstantInt::get(Type::getInt32Ty(VMContext), ColumnNo)
318 return DITemplateTypeParameter(MDNode::get(VMContext, Elts));
321 /// createTemplateValueParameter - Create debugging information for template
323 DITemplateValueParameter
324 DIBuilder::createTemplateValueParameter(DIDescriptor Context, StringRef Name,
325 DIType Ty, uint64_t Val,
326 MDNode *File, unsigned LineNo,
329 GetTagConstant(VMContext, dwarf::DW_TAG_template_value_parameter),
331 MDString::get(VMContext, Name),
333 ConstantInt::get(Type::getInt64Ty(VMContext), Val),
335 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
336 ConstantInt::get(Type::getInt32Ty(VMContext), ColumnNo)
338 return DITemplateValueParameter(MDNode::get(VMContext, Elts));
341 /// createStructType - Create debugging information entry for a struct.
342 DIType DIBuilder::createStructType(DIDescriptor Context, StringRef Name,
343 DIFile File, unsigned LineNumber,
344 uint64_t SizeInBits, uint64_t AlignInBits,
345 unsigned Flags, DIArray Elements,
346 unsigned RunTimeLang) {
347 // TAG_structure_type is encoded in DICompositeType format.
349 GetTagConstant(VMContext, dwarf::DW_TAG_structure_type),
351 MDString::get(VMContext, Name),
353 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
354 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
355 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
356 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
357 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
358 llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
360 ConstantInt::get(Type::getInt32Ty(VMContext), RunTimeLang),
361 llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
363 return DIType(MDNode::get(VMContext, Elts));
366 /// createUnionType - Create debugging information entry for an union.
367 DIType DIBuilder::createUnionType(DIDescriptor Scope, StringRef Name,
369 unsigned LineNumber, uint64_t SizeInBits,
370 uint64_t AlignInBits, unsigned Flags,
371 DIArray Elements, unsigned RunTimeLang) {
372 // TAG_union_type is encoded in DICompositeType format.
374 GetTagConstant(VMContext, dwarf::DW_TAG_union_type),
376 MDString::get(VMContext, Name),
378 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
379 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
380 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
381 ConstantInt::get(Type::getInt64Ty(VMContext), 0),
382 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
383 llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
385 ConstantInt::get(Type::getInt32Ty(VMContext), RunTimeLang),
386 llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
388 return DIType(MDNode::get(VMContext, Elts));
391 /// createSubroutineType - Create subroutine type.
392 DIType DIBuilder::createSubroutineType(DIFile File, DIArray ParameterTypes) {
393 // TAG_subroutine_type is encoded in DICompositeType format.
395 GetTagConstant(VMContext, dwarf::DW_TAG_subroutine_type),
397 MDString::get(VMContext, ""),
399 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
400 ConstantInt::get(Type::getInt64Ty(VMContext), 0),
401 ConstantInt::get(Type::getInt64Ty(VMContext), 0),
402 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
403 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
404 llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
406 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
407 llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
409 return DIType(MDNode::get(VMContext, Elts));
412 /// createEnumerationType - Create debugging information entry for an
414 DIType DIBuilder::createEnumerationType(DIDescriptor Scope, StringRef Name,
415 DIFile File, unsigned LineNumber,
417 uint64_t AlignInBits, DIArray Elements) {
418 // TAG_enumeration_type is encoded in DICompositeType format.
420 GetTagConstant(VMContext, dwarf::DW_TAG_enumeration_type),
422 MDString::get(VMContext, Name),
424 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
425 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
426 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
427 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
428 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
429 llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
431 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
432 llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
434 MDNode *Node = MDNode::get(VMContext, Elts);
435 NamedMDNode *NMD = M.getOrInsertNamedMetadata("llvm.dbg.enum");
436 NMD->addOperand(Node);
440 /// createArrayType - Create debugging information entry for an array.
441 DIType DIBuilder::createArrayType(uint64_t Size, uint64_t AlignInBits,
442 DIType Ty, DIArray Subscripts) {
443 // TAG_array_type is encoded in DICompositeType format.
445 GetTagConstant(VMContext, dwarf::DW_TAG_array_type),
447 MDString::get(VMContext, ""),
449 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
450 ConstantInt::get(Type::getInt64Ty(VMContext), Size),
451 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
452 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
453 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
456 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
457 llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
459 return DIType(MDNode::get(VMContext, Elts));
462 /// createVectorType - Create debugging information entry for a vector.
463 DIType DIBuilder::createVectorType(uint64_t Size, uint64_t AlignInBits,
464 DIType Ty, DIArray Subscripts) {
465 // TAG_vector_type is encoded in DICompositeType format.
467 GetTagConstant(VMContext, dwarf::DW_TAG_vector_type),
469 MDString::get(VMContext, ""),
471 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
472 ConstantInt::get(Type::getInt64Ty(VMContext), Size),
473 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
474 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
475 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
478 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
479 llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
481 return DIType(MDNode::get(VMContext, Elts));
484 /// createArtificialType - Create a new DIType with "artificial" flag set.
485 DIType DIBuilder::createArtificialType(DIType Ty) {
486 if (Ty.isArtificial())
489 SmallVector<Value *, 9> Elts;
491 assert (N && "Unexpected input DIType!");
492 for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i) {
493 if (Value *V = N->getOperand(i))
496 Elts.push_back(Constant::getNullValue(Type::getInt32Ty(VMContext)));
499 unsigned CurFlags = Ty.getFlags();
500 CurFlags = CurFlags | DIType::FlagArtificial;
502 // Flags are stored at this slot.
503 Elts[8] = ConstantInt::get(Type::getInt32Ty(VMContext), CurFlags);
505 return DIType(MDNode::get(VMContext, Elts));
508 /// retainType - Retain DIType in a module even if it is not referenced
509 /// through debug info anchors.
510 void DIBuilder::retainType(DIType T) {
511 NamedMDNode *NMD = M.getOrInsertNamedMetadata("llvm.dbg.ty");
515 /// createUnspecifiedParameter - Create unspeicified type descriptor
516 /// for the subroutine type.
517 DIDescriptor DIBuilder::createUnspecifiedParameter() {
519 GetTagConstant(VMContext, dwarf::DW_TAG_unspecified_parameters)
521 return DIDescriptor(MDNode::get(VMContext, Elts));
524 /// createTemporaryType - Create a temporary forward-declared type.
525 DIType DIBuilder::createTemporaryType() {
526 // Give the temporary MDNode a tag. It doesn't matter what tag we
527 // use here as long as DIType accepts it.
528 Value *Elts[] = { GetTagConstant(VMContext, DW_TAG_base_type) };
529 MDNode *Node = MDNode::getTemporary(VMContext, Elts);
533 /// createTemporaryType - Create a temporary forward-declared type.
534 DIType DIBuilder::createTemporaryType(DIFile F) {
535 // Give the temporary MDNode a tag. It doesn't matter what tag we
536 // use here as long as DIType accepts it.
538 GetTagConstant(VMContext, DW_TAG_base_type),
543 MDNode *Node = MDNode::getTemporary(VMContext, Elts);
547 /// getOrCreateArray - Get a DIArray, create one if required.
548 DIArray DIBuilder::getOrCreateArray(ArrayRef<Value *> Elements) {
549 if (Elements.empty()) {
550 Value *Null = llvm::Constant::getNullValue(Type::getInt32Ty(VMContext));
551 return DIArray(MDNode::get(VMContext, Null));
553 return DIArray(MDNode::get(VMContext, Elements));
556 /// getOrCreateSubrange - Create a descriptor for a value range. This
557 /// implicitly uniques the values returned.
558 DISubrange DIBuilder::getOrCreateSubrange(int64_t Lo, int64_t Hi) {
560 GetTagConstant(VMContext, dwarf::DW_TAG_subrange_type),
561 ConstantInt::get(Type::getInt64Ty(VMContext), Lo),
562 ConstantInt::get(Type::getInt64Ty(VMContext), Hi)
565 return DISubrange(MDNode::get(VMContext, Elts));
568 /// createGlobalVariable - Create a new descriptor for the specified global.
569 DIGlobalVariable DIBuilder::
570 createGlobalVariable(StringRef Name, DIFile F, unsigned LineNumber,
571 DIType Ty, bool isLocalToUnit, llvm::Value *Val) {
573 GetTagConstant(VMContext, dwarf::DW_TAG_variable),
574 llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
576 MDString::get(VMContext, Name),
577 MDString::get(VMContext, Name),
578 MDString::get(VMContext, Name),
580 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
582 ConstantInt::get(Type::getInt32Ty(VMContext), isLocalToUnit),
583 ConstantInt::get(Type::getInt32Ty(VMContext), 1), /* isDefinition*/
586 MDNode *Node = MDNode::get(VMContext, Elts);
587 // Create a named metadata so that we do not lose this mdnode.
588 NamedMDNode *NMD = M.getOrInsertNamedMetadata("llvm.dbg.gv");
589 NMD->addOperand(Node);
590 return DIGlobalVariable(Node);
593 /// createStaticVariable - Create a new descriptor for the specified static
595 DIGlobalVariable DIBuilder::
596 createStaticVariable(DIDescriptor Context, StringRef Name,
597 StringRef LinkageName, DIFile F, unsigned LineNumber,
598 DIType Ty, bool isLocalToUnit, llvm::Value *Val) {
600 GetTagConstant(VMContext, dwarf::DW_TAG_variable),
601 llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
603 MDString::get(VMContext, Name),
604 MDString::get(VMContext, Name),
605 MDString::get(VMContext, LinkageName),
607 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
609 ConstantInt::get(Type::getInt32Ty(VMContext), isLocalToUnit),
610 ConstantInt::get(Type::getInt32Ty(VMContext), 1), /* isDefinition*/
613 MDNode *Node = MDNode::get(VMContext, Elts);
614 // Create a named metadata so that we do not lose this mdnode.
615 NamedMDNode *NMD = M.getOrInsertNamedMetadata("llvm.dbg.gv");
616 NMD->addOperand(Node);
617 return DIGlobalVariable(Node);
620 /// createVariable - Create a new descriptor for the specified variable.
621 DIVariable DIBuilder::createLocalVariable(unsigned Tag, DIDescriptor Scope,
622 StringRef Name, DIFile File,
623 unsigned LineNo, DIType Ty,
624 bool AlwaysPreserve, unsigned Flags,
627 GetTagConstant(VMContext, Tag),
629 MDString::get(VMContext, Name),
631 ConstantInt::get(Type::getInt32Ty(VMContext), (LineNo | (ArgNo << 24))),
633 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
634 Constant::getNullValue(Type::getInt32Ty(VMContext)),
636 MDNode *Node = MDNode::get(VMContext, Elts);
637 if (AlwaysPreserve) {
638 // The optimizer may remove local variable. If there is an interest
639 // to preserve variable info in such situation then stash it in a
641 DISubprogram Fn(getDISubprogram(Scope));
642 StringRef FName = "fn";
643 if (Fn.getFunction())
644 FName = Fn.getFunction()->getName();
646 if (FName.startswith(StringRef(&One, 1)))
647 FName = FName.substr(1);
648 NamedMDNode *FnLocals = getOrInsertFnSpecificMDNode(M, FName);
649 FnLocals->addOperand(Node);
651 return DIVariable(Node);
654 /// createComplexVariable - Create a new descriptor for the specified variable
655 /// which has a complex address expression for its address.
656 DIVariable DIBuilder::createComplexVariable(unsigned Tag, DIDescriptor Scope,
657 StringRef Name, DIFile F,
659 DIType Ty, ArrayRef<Value *> Addr,
661 SmallVector<Value *, 15> Elts;
662 Elts.push_back(GetTagConstant(VMContext, Tag));
663 Elts.push_back(Scope);
664 Elts.push_back(MDString::get(VMContext, Name));
666 Elts.push_back(ConstantInt::get(Type::getInt32Ty(VMContext), (LineNo | (ArgNo << 24))));
668 Elts.push_back(llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)));
669 Elts.push_back(llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)));
670 Elts.append(Addr.begin(), Addr.end());
672 return DIVariable(MDNode::get(VMContext, Elts));
675 /// createFunction - Create a new descriptor for the specified function.
676 DISubprogram DIBuilder::createFunction(DIDescriptor Context,
678 StringRef LinkageName,
679 DIFile File, unsigned LineNo,
681 bool isLocalToUnit, bool isDefinition,
682 unsigned Flags, bool isOptimized,
687 GetTagConstant(VMContext, dwarf::DW_TAG_subprogram),
688 llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
690 MDString::get(VMContext, Name),
691 MDString::get(VMContext, Name),
692 MDString::get(VMContext, LinkageName),
694 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
696 ConstantInt::get(Type::getInt1Ty(VMContext), isLocalToUnit),
697 ConstantInt::get(Type::getInt1Ty(VMContext), isDefinition),
698 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
699 ConstantInt::get(Type::getInt32Ty(VMContext), 0),
700 llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
701 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
702 ConstantInt::get(Type::getInt1Ty(VMContext), isOptimized),
707 MDNode *Node = MDNode::get(VMContext, Elts);
709 // Create a named metadata so that we do not lose this mdnode.
710 NamedMDNode *NMD = M.getOrInsertNamedMetadata("llvm.dbg.sp");
711 NMD->addOperand(Node);
712 return DISubprogram(Node);
715 /// createMethod - Create a new descriptor for the specified C++ method.
716 DISubprogram DIBuilder::createMethod(DIDescriptor Context,
718 StringRef LinkageName,
720 unsigned LineNo, DIType Ty,
723 unsigned VK, unsigned VIndex,
724 MDNode *VTableHolder,
730 GetTagConstant(VMContext, dwarf::DW_TAG_subprogram),
731 llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
733 MDString::get(VMContext, Name),
734 MDString::get(VMContext, Name),
735 MDString::get(VMContext, LinkageName),
737 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
739 ConstantInt::get(Type::getInt1Ty(VMContext), isLocalToUnit),
740 ConstantInt::get(Type::getInt1Ty(VMContext), isDefinition),
741 ConstantInt::get(Type::getInt32Ty(VMContext), (unsigned)VK),
742 ConstantInt::get(Type::getInt32Ty(VMContext), VIndex),
744 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
745 ConstantInt::get(Type::getInt1Ty(VMContext), isOptimized),
749 MDNode *Node = MDNode::get(VMContext, Elts);
751 // Create a named metadata so that we do not lose this mdnode.
752 NamedMDNode *NMD = M.getOrInsertNamedMetadata("llvm.dbg.sp");
753 NMD->addOperand(Node);
754 return DISubprogram(Node);
757 /// createNameSpace - This creates new descriptor for a namespace
758 /// with the specified parent scope.
759 DINameSpace DIBuilder::createNameSpace(DIDescriptor Scope, StringRef Name,
760 DIFile File, unsigned LineNo) {
762 GetTagConstant(VMContext, dwarf::DW_TAG_namespace),
764 MDString::get(VMContext, Name),
766 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo)
768 return DINameSpace(MDNode::get(VMContext, Elts));
771 DILexicalBlock DIBuilder::createLexicalBlock(DIDescriptor Scope, DIFile File,
772 unsigned Line, unsigned Col) {
773 // Defeat MDNode uniqing for lexical blocks by using unique id.
774 static unsigned int unique_id = 0;
776 GetTagConstant(VMContext, dwarf::DW_TAG_lexical_block),
778 ConstantInt::get(Type::getInt32Ty(VMContext), Line),
779 ConstantInt::get(Type::getInt32Ty(VMContext), Col),
781 ConstantInt::get(Type::getInt32Ty(VMContext), unique_id++)
783 return DILexicalBlock(MDNode::get(VMContext, Elts));
786 /// insertDeclare - Insert a new llvm.dbg.declare intrinsic call.
787 Instruction *DIBuilder::insertDeclare(Value *Storage, DIVariable VarInfo,
788 Instruction *InsertBefore) {
789 assert(Storage && "no storage passed to dbg.declare");
790 assert(VarInfo.Verify() && "empty DIVariable passed to dbg.declare");
792 DeclareFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_declare);
794 Value *Args[] = { MDNode::get(Storage->getContext(), Storage), VarInfo };
795 return CallInst::Create(DeclareFn, Args, "", InsertBefore);
798 /// insertDeclare - Insert a new llvm.dbg.declare intrinsic call.
799 Instruction *DIBuilder::insertDeclare(Value *Storage, DIVariable VarInfo,
800 BasicBlock *InsertAtEnd) {
801 assert(Storage && "no storage passed to dbg.declare");
802 assert(VarInfo.Verify() && "invalid DIVariable passed to dbg.declare");
804 DeclareFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_declare);
806 Value *Args[] = { MDNode::get(Storage->getContext(), Storage), VarInfo };
808 // If this block already has a terminator then insert this intrinsic
809 // before the terminator.
810 if (TerminatorInst *T = InsertAtEnd->getTerminator())
811 return CallInst::Create(DeclareFn, Args, "", T);
813 return CallInst::Create(DeclareFn, Args, "", InsertAtEnd);
816 /// insertDbgValueIntrinsic - Insert a new llvm.dbg.value intrinsic call.
817 Instruction *DIBuilder::insertDbgValueIntrinsic(Value *V, uint64_t Offset,
819 Instruction *InsertBefore) {
820 assert(V && "no value passed to dbg.value");
821 assert(VarInfo.Verify() && "invalid DIVariable passed to dbg.value");
823 ValueFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_value);
825 Value *Args[] = { MDNode::get(V->getContext(), V),
826 ConstantInt::get(Type::getInt64Ty(V->getContext()), Offset),
828 return CallInst::Create(ValueFn, Args, "", InsertBefore);
831 /// insertDbgValueIntrinsic - Insert a new llvm.dbg.value intrinsic call.
832 Instruction *DIBuilder::insertDbgValueIntrinsic(Value *V, uint64_t Offset,
834 BasicBlock *InsertAtEnd) {
835 assert(V && "no value passed to dbg.value");
836 assert(VarInfo.Verify() && "invalid DIVariable passed to dbg.value");
838 ValueFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_value);
840 Value *Args[] = { MDNode::get(V->getContext(), V),
841 ConstantInt::get(Type::getInt64Ty(V->getContext()), Offset),
843 return CallInst::Create(ValueFn, Args, "", InsertAtEnd);