1 //===-- llvm/CodeGen/MachineDebugInfo.cpp -----------------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file was developed by James M. Laskey and is distributed under
6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 #include "llvm/CodeGen/MachineDebugInfo.h"
12 #include "llvm/Constants.h"
13 #include "llvm/DerivedTypes.h"
14 #include "llvm/GlobalVariable.h"
15 #include "llvm/Intrinsics.h"
16 #include "llvm/Instructions.h"
17 #include "llvm/Module.h"
18 #include "llvm/Support/Dwarf.h"
23 using namespace llvm::dwarf;
25 // Handle the Pass registration stuff necessary to use TargetData's.
27 RegisterPass<MachineDebugInfo> X("machinedebuginfo", "Debug Information");
30 //===----------------------------------------------------------------------===//
32 /// getGlobalVariablesUsing - Return all of the GlobalVariables which have the
33 /// specified value in their initializer somewhere.
35 getGlobalVariablesUsing(Value *V, std::vector<GlobalVariable*> &Result) {
36 // Scan though value users.
37 for (Value::use_iterator I = V->use_begin(), E = V->use_end(); I != E; ++I) {
38 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(*I)) {
39 // If the user is a GlobalVariable then add to result.
41 } else if (Constant *C = dyn_cast<Constant>(*I)) {
42 // If the user is a constant variable then scan its users
43 getGlobalVariablesUsing(C, Result);
48 /// getGlobalVariablesUsing - Return all of the GlobalVariables that use the
49 /// named GlobalVariable.
50 static std::vector<GlobalVariable*>
51 getGlobalVariablesUsing(Module &M, const std::string &RootName) {
52 std::vector<GlobalVariable*> Result; // GlobalVariables matching criteria.
54 std::vector<const Type*> FieldTypes;
55 FieldTypes.push_back(Type::UIntTy);
56 FieldTypes.push_back(Type::UIntTy);
58 // Get the GlobalVariable root.
59 GlobalVariable *UseRoot = M.getGlobalVariable(RootName,
60 StructType::get(FieldTypes));
62 // If present and linkonce then scan for users.
63 if (UseRoot && UseRoot->hasLinkOnceLinkage()) {
64 getGlobalVariablesUsing(UseRoot, Result);
70 /// isStringValue - Return true if the given value can be coerced to a string.
72 static bool isStringValue(Value *V) {
73 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(V)) {
74 if (GV->hasInitializer() && isa<ConstantArray>(GV->getInitializer())) {
75 ConstantArray *Init = cast<ConstantArray>(GV->getInitializer());
76 return Init->isString();
78 } else if (Constant *C = dyn_cast<Constant>(V)) {
79 if (GlobalValue *GV = dyn_cast<GlobalValue>(C))
80 return isStringValue(GV);
81 else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(C)) {
82 if (CE->getOpcode() == Instruction::GetElementPtr) {
83 if (CE->getNumOperands() == 3 &&
84 cast<Constant>(CE->getOperand(1))->isNullValue() &&
85 isa<ConstantInt>(CE->getOperand(2))) {
86 return isStringValue(CE->getOperand(0));
94 /// getGlobalVariable - Return either a direct or cast Global value.
96 static GlobalVariable *getGlobalVariable(Value *V) {
97 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(V)) {
99 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(V)) {
100 if (CE->getOpcode() == Instruction::Cast) {
101 return dyn_cast<GlobalVariable>(CE->getOperand(0));
107 /// isGlobalVariable - Return true if the given value can be coerced to a
109 static bool isGlobalVariable(Value *V) {
110 if (isa<GlobalVariable>(V) || isa<ConstantPointerNull>(V)) {
112 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(V)) {
113 if (CE->getOpcode() == Instruction::Cast) {
114 return isa<GlobalVariable>(CE->getOperand(0));
120 /// getUIntOperand - Return ith operand if it is an unsigned integer.
122 static ConstantUInt *getUIntOperand(GlobalVariable *GV, unsigned i) {
123 // Make sure the GlobalVariable has an initializer.
124 if (!GV->hasInitializer()) return NULL;
126 // Get the initializer constant.
127 ConstantStruct *CI = dyn_cast<ConstantStruct>(GV->getInitializer());
128 if (!CI) return NULL;
130 // Check if there is at least i + 1 operands.
131 unsigned N = CI->getNumOperands();
132 if (i >= N) return NULL;
135 return dyn_cast<ConstantUInt>(CI->getOperand(i));
137 //===----------------------------------------------------------------------===//
139 /// ApplyToFields - Target the visitor to each field of the debug information
141 void DIVisitor::ApplyToFields(DebugInfoDesc *DD) {
142 DD->ApplyToFields(this);
145 //===----------------------------------------------------------------------===//
146 /// DICountVisitor - This DIVisitor counts all the fields in the supplied debug
147 /// the supplied DebugInfoDesc.
148 class DICountVisitor : public DIVisitor {
150 unsigned Count; // Running count of fields.
153 DICountVisitor() : DIVisitor(), Count(0) {}
156 unsigned getCount() const { return Count; }
158 /// Apply - Count each of the fields.
160 virtual void Apply(int &Field) { ++Count; }
161 virtual void Apply(unsigned &Field) { ++Count; }
162 virtual void Apply(int64_t &Field) { ++Count; }
163 virtual void Apply(uint64_t &Field) { ++Count; }
164 virtual void Apply(bool &Field) { ++Count; }
165 virtual void Apply(std::string &Field) { ++Count; }
166 virtual void Apply(DebugInfoDesc *&Field) { ++Count; }
167 virtual void Apply(GlobalVariable *&Field) { ++Count; }
168 virtual void Apply(std::vector<DebugInfoDesc *> &Field) {
173 //===----------------------------------------------------------------------===//
174 /// DIDeserializeVisitor - This DIVisitor deserializes all the fields in the
175 /// supplied DebugInfoDesc.
176 class DIDeserializeVisitor : public DIVisitor {
178 DIDeserializer &DR; // Active deserializer.
179 unsigned I; // Current operand index.
180 ConstantStruct *CI; // GlobalVariable constant initializer.
183 DIDeserializeVisitor(DIDeserializer &D, GlobalVariable *GV)
187 , CI(cast<ConstantStruct>(GV->getInitializer()))
190 /// Apply - Set the value of each of the fields.
192 virtual void Apply(int &Field) {
193 Constant *C = CI->getOperand(I++);
194 Field = cast<ConstantSInt>(C)->getValue();
196 virtual void Apply(unsigned &Field) {
197 Constant *C = CI->getOperand(I++);
198 Field = cast<ConstantUInt>(C)->getValue();
200 virtual void Apply(int64_t &Field) {
201 Constant *C = CI->getOperand(I++);
202 Field = cast<ConstantSInt>(C)->getValue();
204 virtual void Apply(uint64_t &Field) {
205 Constant *C = CI->getOperand(I++);
206 Field = cast<ConstantUInt>(C)->getValue();
208 virtual void Apply(bool &Field) {
209 Constant *C = CI->getOperand(I++);
210 Field = cast<ConstantBool>(C)->getValue();
212 virtual void Apply(std::string &Field) {
213 Constant *C = CI->getOperand(I++);
214 Field = C->getStringValue();
216 virtual void Apply(DebugInfoDesc *&Field) {
217 Constant *C = CI->getOperand(I++);
218 Field = DR.Deserialize(C);
220 virtual void Apply(GlobalVariable *&Field) {
221 Constant *C = CI->getOperand(I++);
222 Field = getGlobalVariable(C);
224 virtual void Apply(std::vector<DebugInfoDesc *> &Field) {
225 Constant *C = CI->getOperand(I++);
226 GlobalVariable *GV = getGlobalVariable(C);
228 // Have to be able to deal with the empty array case (zero initializer)
229 if (!GV->hasInitializer()) return;
230 if (ConstantArray *CA = dyn_cast<ConstantArray>(GV->getInitializer())) {
231 for (unsigned i = 0, N = CA->getNumOperands(); i < N; ++i) {
232 GlobalVariable *GVE = getGlobalVariable(CA->getOperand(i));
233 DebugInfoDesc *DE = DR.Deserialize(GVE);
240 //===----------------------------------------------------------------------===//
241 /// DISerializeVisitor - This DIVisitor serializes all the fields in
242 /// the supplied DebugInfoDesc.
243 class DISerializeVisitor : public DIVisitor {
245 DISerializer &SR; // Active serializer.
246 std::vector<Constant*> &Elements; // Element accumulator.
249 DISerializeVisitor(DISerializer &S, std::vector<Constant*> &E)
255 /// Apply - Set the value of each of the fields.
257 virtual void Apply(int &Field) {
258 Elements.push_back(ConstantSInt::get(Type::IntTy, Field));
260 virtual void Apply(unsigned &Field) {
261 Elements.push_back(ConstantUInt::get(Type::UIntTy, Field));
263 virtual void Apply(int64_t &Field) {
264 Elements.push_back(ConstantSInt::get(Type::IntTy, Field));
266 virtual void Apply(uint64_t &Field) {
267 Elements.push_back(ConstantUInt::get(Type::UIntTy, Field));
269 virtual void Apply(bool &Field) {
270 Elements.push_back(ConstantBool::get(Field));
272 virtual void Apply(std::string &Field) {
273 Elements.push_back(SR.getString(Field));
275 virtual void Apply(DebugInfoDesc *&Field) {
276 GlobalVariable *GV = NULL;
278 // If non-NULL then convert to global.
279 if (Field) GV = SR.Serialize(Field);
281 // FIXME - At some point should use specific type.
282 const PointerType *EmptyTy = SR.getEmptyStructPtrType();
285 // Set to pointer to global.
286 Elements.push_back(ConstantExpr::getCast(GV, EmptyTy));
289 Elements.push_back(ConstantPointerNull::get(EmptyTy));
292 virtual void Apply(GlobalVariable *&Field) {
293 const PointerType *EmptyTy = SR.getEmptyStructPtrType();
295 Elements.push_back(ConstantExpr::getCast(Field, EmptyTy));
297 Elements.push_back(ConstantPointerNull::get(EmptyTy));
300 virtual void Apply(std::vector<DebugInfoDesc *> &Field) {
301 const PointerType *EmptyTy = SR.getEmptyStructPtrType();
302 unsigned N = Field.size();
303 ArrayType *AT = ArrayType::get(EmptyTy, N);
304 std::vector<Constant *> ArrayElements;
306 for (unsigned i = 0, N = Field.size(); i < N; ++i) {
307 GlobalVariable *GVE = SR.Serialize(Field[i]);
308 Constant *CE = ConstantExpr::getCast(GVE, EmptyTy);
309 ArrayElements.push_back(cast<Constant>(CE));
312 Constant *CA = ConstantArray::get(AT, ArrayElements);
313 GlobalVariable *CAGV = new GlobalVariable(AT, true,
314 GlobalValue::InternalLinkage,
315 CA, "llvm.dbg.array",
317 CAGV->setSection("llvm.metadata");
318 Constant *CAE = ConstantExpr::getCast(CAGV, EmptyTy);
319 Elements.push_back(CAE);
323 //===----------------------------------------------------------------------===//
324 /// DIGetTypesVisitor - This DIVisitor gathers all the field types in
325 /// the supplied DebugInfoDesc.
326 class DIGetTypesVisitor : public DIVisitor {
328 DISerializer &SR; // Active serializer.
329 std::vector<const Type*> &Fields; // Type accumulator.
332 DIGetTypesVisitor(DISerializer &S, std::vector<const Type*> &F)
338 /// Apply - Set the value of each of the fields.
340 virtual void Apply(int &Field) {
341 Fields.push_back(Type::IntTy);
343 virtual void Apply(unsigned &Field) {
344 Fields.push_back(Type::UIntTy);
346 virtual void Apply(int64_t &Field) {
347 Fields.push_back(Type::IntTy);
349 virtual void Apply(uint64_t &Field) {
350 Fields.push_back(Type::UIntTy);
352 virtual void Apply(bool &Field) {
353 Fields.push_back(Type::BoolTy);
355 virtual void Apply(std::string &Field) {
356 Fields.push_back(SR.getStrPtrType());
358 virtual void Apply(DebugInfoDesc *&Field) {
359 // FIXME - At some point should use specific type.
360 const PointerType *EmptyTy = SR.getEmptyStructPtrType();
361 Fields.push_back(EmptyTy);
363 virtual void Apply(GlobalVariable *&Field) {
364 const PointerType *EmptyTy = SR.getEmptyStructPtrType();
365 Fields.push_back(EmptyTy);
367 virtual void Apply(std::vector<DebugInfoDesc *> &Field) {
368 const PointerType *EmptyTy = SR.getEmptyStructPtrType();
369 Fields.push_back(EmptyTy);
373 //===----------------------------------------------------------------------===//
374 /// DIVerifyVisitor - This DIVisitor verifies all the field types against
375 /// a constant initializer.
376 class DIVerifyVisitor : public DIVisitor {
378 DIVerifier &VR; // Active verifier.
379 bool IsValid; // Validity status.
380 unsigned I; // Current operand index.
381 ConstantStruct *CI; // GlobalVariable constant initializer.
384 DIVerifyVisitor(DIVerifier &V, GlobalVariable *GV)
389 , CI(cast<ConstantStruct>(GV->getInitializer()))
394 bool isValid() const { return IsValid; }
396 /// Apply - Set the value of each of the fields.
398 virtual void Apply(int &Field) {
399 Constant *C = CI->getOperand(I++);
400 IsValid = IsValid && isa<ConstantInt>(C);
402 virtual void Apply(unsigned &Field) {
403 Constant *C = CI->getOperand(I++);
404 IsValid = IsValid && isa<ConstantInt>(C);
406 virtual void Apply(int64_t &Field) {
407 Constant *C = CI->getOperand(I++);
408 IsValid = IsValid && isa<ConstantInt>(C);
410 virtual void Apply(uint64_t &Field) {
411 Constant *C = CI->getOperand(I++);
412 IsValid = IsValid && isa<ConstantInt>(C);
414 virtual void Apply(bool &Field) {
415 Constant *C = CI->getOperand(I++);
416 IsValid = IsValid && isa<ConstantBool>(C);
418 virtual void Apply(std::string &Field) {
419 Constant *C = CI->getOperand(I++);
420 IsValid = IsValid && (!C || isStringValue(C));
422 virtual void Apply(DebugInfoDesc *&Field) {
423 // FIXME - Prepare the correct descriptor.
424 Constant *C = CI->getOperand(I++);
425 IsValid = IsValid && isGlobalVariable(C);
427 virtual void Apply(GlobalVariable *&Field) {
428 Constant *C = CI->getOperand(I++);
429 IsValid = IsValid && isGlobalVariable(C);
431 virtual void Apply(std::vector<DebugInfoDesc *> &Field) {
432 Constant *C = CI->getOperand(I++);
433 IsValid = IsValid && isGlobalVariable(C);
434 if (!IsValid) return;
436 GlobalVariable *GV = getGlobalVariable(C);
437 IsValid = IsValid && GV && GV->hasInitializer();
438 if (!IsValid) return;
440 ConstantArray *CA = dyn_cast<ConstantArray>(GV->getInitializer());
441 IsValid = IsValid && CA;
442 if (!IsValid) return;
444 for (unsigned i = 0, N = CA->getNumOperands(); IsValid && i < N; ++i) {
445 IsValid = IsValid && isGlobalVariable(CA->getOperand(i));
446 if (!IsValid) return;
448 GlobalVariable *GVE = getGlobalVariable(CA->getOperand(i));
455 //===----------------------------------------------------------------------===//
457 /// TagFromGlobal - Returns the Tag number from a debug info descriptor
459 unsigned DebugInfoDesc::TagFromGlobal(GlobalVariable *GV) {
460 ConstantUInt *C = getUIntOperand(GV, 0);
461 return C ? (unsigned)C->getValue() : (unsigned)DW_TAG_invalid;
464 /// DescFactory - Create an instance of debug info descriptor based on Tag.
465 /// Return NULL if not a recognized Tag.
466 DebugInfoDesc *DebugInfoDesc::DescFactory(unsigned Tag) {
468 case DW_TAG_anchor: return new AnchorDesc();
469 case DW_TAG_compile_unit: return new CompileUnitDesc();
470 case DW_TAG_variable: return new GlobalVariableDesc();
471 case DW_TAG_subprogram: return new SubprogramDesc();
472 case DW_TAG_lexical_block: return new BlockDesc();
473 case DW_TAG_base_type: return new BasicTypeDesc();
475 case DW_TAG_pointer_type:
476 case DW_TAG_reference_type:
477 case DW_TAG_const_type:
478 case DW_TAG_volatile_type:
479 case DW_TAG_restrict_type:
480 case DW_TAG_formal_parameter:
481 case DW_TAG_member: return new DerivedTypeDesc(Tag);
482 case DW_TAG_array_type:
483 case DW_TAG_structure_type:
484 case DW_TAG_union_type:
485 case DW_TAG_enumeration_type: return new CompositeTypeDesc(Tag);
486 case DW_TAG_subrange_type: return new SubrangeDesc();
487 case DW_TAG_enumerator: return new EnumeratorDesc();
493 /// getLinkage - get linkage appropriate for this type of descriptor.
495 GlobalValue::LinkageTypes DebugInfoDesc::getLinkage() const {
496 return GlobalValue::InternalLinkage;
499 /// ApplyToFields - Target the vistor to the fields of the descriptor.
501 void DebugInfoDesc::ApplyToFields(DIVisitor *Visitor) {
505 //===----------------------------------------------------------------------===//
507 AnchorDesc::AnchorDesc()
508 : DebugInfoDesc(DW_TAG_anchor)
511 AnchorDesc::AnchorDesc(AnchoredDesc *D)
512 : DebugInfoDesc(DW_TAG_anchor)
513 , AnchorTag(D->getTag())
516 // Implement isa/cast/dyncast.
517 bool AnchorDesc::classof(const DebugInfoDesc *D) {
518 return D->getTag() == DW_TAG_anchor;
521 /// getLinkage - get linkage appropriate for this type of descriptor.
523 GlobalValue::LinkageTypes AnchorDesc::getLinkage() const {
524 return GlobalValue::LinkOnceLinkage;
527 /// ApplyToFields - Target the visitor to the fields of the TransUnitDesc.
529 void AnchorDesc::ApplyToFields(DIVisitor *Visitor) {
530 DebugInfoDesc::ApplyToFields(Visitor);
532 Visitor->Apply(AnchorTag);
535 /// getDescString - Return a string used to compose global names and labels. A
536 /// A global variable name needs to be defined for each debug descriptor that is
537 /// anchored. NOTE: that each global variable named here also needs to be added
538 /// to the list of names left external in the internalizer.
539 /// ExternalNames.insert("llvm.dbg.compile_units");
540 /// ExternalNames.insert("llvm.dbg.global_variables");
541 /// ExternalNames.insert("llvm.dbg.subprograms");
542 const char *AnchorDesc::getDescString() const {
544 case DW_TAG_compile_unit: return CompileUnitDesc::AnchorString;
545 case DW_TAG_variable: return GlobalVariableDesc::AnchorString;
546 case DW_TAG_subprogram: return SubprogramDesc::AnchorString;
550 assert(0 && "Tag does not have a case for anchor string");
554 /// getTypeString - Return a string used to label this descriptors type.
556 const char *AnchorDesc::getTypeString() const {
557 return "llvm.dbg.anchor.type";
561 void AnchorDesc::dump() {
562 std::cerr << getDescString() << " "
563 << "Tag(" << getTag() << "), "
564 << "AnchorTag(" << AnchorTag << ")\n";
568 //===----------------------------------------------------------------------===//
570 AnchoredDesc::AnchoredDesc(unsigned T)
575 /// ApplyToFields - Target the visitor to the fields of the AnchoredDesc.
577 void AnchoredDesc::ApplyToFields(DIVisitor *Visitor) {
578 DebugInfoDesc::ApplyToFields(Visitor);
580 Visitor->Apply((DebugInfoDesc *&)Anchor);
583 //===----------------------------------------------------------------------===//
585 CompileUnitDesc::CompileUnitDesc()
586 : AnchoredDesc(DW_TAG_compile_unit)
587 , DebugVersion(LLVMDebugVersion)
594 // Implement isa/cast/dyncast.
595 bool CompileUnitDesc::classof(const DebugInfoDesc *D) {
596 return D->getTag() == DW_TAG_compile_unit;
599 /// DebugVersionFromGlobal - Returns the version number from a compile unit
601 unsigned CompileUnitDesc::DebugVersionFromGlobal(GlobalVariable *GV) {
602 ConstantUInt *C = getUIntOperand(GV, 2);
603 return C ? (unsigned)C->getValue() : (unsigned)DW_TAG_invalid;
606 /// ApplyToFields - Target the visitor to the fields of the CompileUnitDesc.
608 void CompileUnitDesc::ApplyToFields(DIVisitor *Visitor) {
609 AnchoredDesc::ApplyToFields(Visitor);
611 Visitor->Apply(DebugVersion);
612 Visitor->Apply(Language);
613 Visitor->Apply(FileName);
614 Visitor->Apply(Directory);
615 Visitor->Apply(Producer);
618 /// getDescString - Return a string used to compose global names and labels.
620 const char *CompileUnitDesc::getDescString() const {
621 return "llvm.dbg.compile_unit";
624 /// getTypeString - Return a string used to label this descriptors type.
626 const char *CompileUnitDesc::getTypeString() const {
627 return "llvm.dbg.compile_unit.type";
630 /// getAnchorString - Return a string used to label this descriptor's anchor.
632 const char *CompileUnitDesc::AnchorString = "llvm.dbg.compile_units";
633 const char *CompileUnitDesc::getAnchorString() const {
638 void CompileUnitDesc::dump() {
639 std::cerr << getDescString() << " "
640 << "Tag(" << getTag() << "), "
641 << "Anchor(" << getAnchor() << "), "
642 << "DebugVersion(" << DebugVersion << "), "
643 << "Language(" << Language << "), "
644 << "FileName(\"" << FileName << "\"), "
645 << "Directory(\"" << Directory << "\"), "
646 << "Producer(\"" << Producer << "\")\n";
650 //===----------------------------------------------------------------------===//
652 TypeDesc::TypeDesc(unsigned T)
662 /// ApplyToFields - Target the visitor to the fields of the TypeDesc.
664 void TypeDesc::ApplyToFields(DIVisitor *Visitor) {
665 DebugInfoDesc::ApplyToFields(Visitor);
667 Visitor->Apply(Context);
668 Visitor->Apply(Name);
669 Visitor->Apply((DebugInfoDesc *&)File);
670 Visitor->Apply(Line);
671 Visitor->Apply(Size);
672 Visitor->Apply(Align);
673 Visitor->Apply(Offset);
676 /// getDescString - Return a string used to compose global names and labels.
678 const char *TypeDesc::getDescString() const {
679 return "llvm.dbg.type";
682 /// getTypeString - Return a string used to label this descriptor's type.
684 const char *TypeDesc::getTypeString() const {
685 return "llvm.dbg.type.type";
689 void TypeDesc::dump() {
690 std::cerr << getDescString() << " "
691 << "Tag(" << getTag() << "), "
692 << "Context(" << Context << "), "
693 << "Name(\"" << Name << "\"), "
694 << "File(" << File << "), "
695 << "Line(" << Line << "), "
696 << "Size(" << Size << "), "
697 << "Align(" << Align << "), "
698 << "Offset(" << Offset << ")\n";
702 //===----------------------------------------------------------------------===//
704 BasicTypeDesc::BasicTypeDesc()
705 : TypeDesc(DW_TAG_base_type)
709 // Implement isa/cast/dyncast.
710 bool BasicTypeDesc::classof(const DebugInfoDesc *D) {
711 return D->getTag() == DW_TAG_base_type;
714 /// ApplyToFields - Target the visitor to the fields of the BasicTypeDesc.
716 void BasicTypeDesc::ApplyToFields(DIVisitor *Visitor) {
717 TypeDesc::ApplyToFields(Visitor);
719 Visitor->Apply(Encoding);
722 /// getDescString - Return a string used to compose global names and labels.
724 const char *BasicTypeDesc::getDescString() const {
725 return "llvm.dbg.basictype";
728 /// getTypeString - Return a string used to label this descriptor's type.
730 const char *BasicTypeDesc::getTypeString() const {
731 return "llvm.dbg.basictype.type";
735 void BasicTypeDesc::dump() {
736 std::cerr << getDescString() << " "
737 << "Tag(" << getTag() << "), "
738 << "Context(" << getContext() << "), "
739 << "Name(\"" << getName() << "\"), "
740 << "Size(" << getSize() << "), "
741 << "Encoding(" << Encoding << ")\n";
745 //===----------------------------------------------------------------------===//
747 DerivedTypeDesc::DerivedTypeDesc(unsigned T)
752 // Implement isa/cast/dyncast.
753 bool DerivedTypeDesc::classof(const DebugInfoDesc *D) {
754 unsigned T = D->getTag();
757 case DW_TAG_pointer_type:
758 case DW_TAG_reference_type:
759 case DW_TAG_const_type:
760 case DW_TAG_volatile_type:
761 case DW_TAG_restrict_type:
762 case DW_TAG_formal_parameter:
770 /// ApplyToFields - Target the visitor to the fields of the DerivedTypeDesc.
772 void DerivedTypeDesc::ApplyToFields(DIVisitor *Visitor) {
773 TypeDesc::ApplyToFields(Visitor);
775 Visitor->Apply((DebugInfoDesc *&)FromType);
778 /// getDescString - Return a string used to compose global names and labels.
780 const char *DerivedTypeDesc::getDescString() const {
781 return "llvm.dbg.derivedtype";
784 /// getTypeString - Return a string used to label this descriptor's type.
786 const char *DerivedTypeDesc::getTypeString() const {
787 return "llvm.dbg.derivedtype.type";
791 void DerivedTypeDesc::dump() {
792 std::cerr << getDescString() << " "
793 << "Tag(" << getTag() << "), "
794 << "Context(" << getContext() << "), "
795 << "Name(\"" << getName() << "\"), "
796 << "Size(" << getSize() << "), "
797 << "File(" << getFile() << "), "
798 << "Line(" << getLine() << "), "
799 << "FromType(" << FromType << ")\n";
803 //===----------------------------------------------------------------------===//
805 CompositeTypeDesc::CompositeTypeDesc(unsigned T)
810 // Implement isa/cast/dyncast.
811 bool CompositeTypeDesc::classof(const DebugInfoDesc *D) {
812 unsigned T = D->getTag();
814 case DW_TAG_array_type:
815 case DW_TAG_structure_type:
816 case DW_TAG_union_type:
817 case DW_TAG_enumeration_type:
824 /// ApplyToFields - Target the visitor to the fields of the CompositeTypeDesc.
826 void CompositeTypeDesc::ApplyToFields(DIVisitor *Visitor) {
827 DerivedTypeDesc::ApplyToFields(Visitor);
829 Visitor->Apply(Elements);
832 /// getDescString - Return a string used to compose global names and labels.
834 const char *CompositeTypeDesc::getDescString() const {
835 return "llvm.dbg.compositetype";
838 /// getTypeString - Return a string used to label this descriptor's type.
840 const char *CompositeTypeDesc::getTypeString() const {
841 return "llvm.dbg.compositetype.type";
845 void CompositeTypeDesc::dump() {
846 std::cerr << getDescString() << " "
847 << "Tag(" << getTag() << "), "
848 << "Context(" << getContext() << "), "
849 << "Name(\"" << getName() << "\"), "
850 << "Size(" << getSize() << "), "
851 << "File(" << getFile() << "), "
852 << "Line(" << getLine() << "), "
853 << "FromType(" << getFromType() << "), "
854 << "Elements.size(" << Elements.size() << ")\n";
858 //===----------------------------------------------------------------------===//
860 SubrangeDesc::SubrangeDesc()
861 : DebugInfoDesc(DW_TAG_subrange_type)
866 // Implement isa/cast/dyncast.
867 bool SubrangeDesc::classof(const DebugInfoDesc *D) {
868 return D->getTag() == DW_TAG_subrange_type;
871 /// ApplyToFields - Target the visitor to the fields of the SubrangeDesc.
873 void SubrangeDesc::ApplyToFields(DIVisitor *Visitor) {
874 DebugInfoDesc::ApplyToFields(Visitor);
880 /// getDescString - Return a string used to compose global names and labels.
882 const char *SubrangeDesc::getDescString() const {
883 return "llvm.dbg.subrange";
886 /// getTypeString - Return a string used to label this descriptor's type.
888 const char *SubrangeDesc::getTypeString() const {
889 return "llvm.dbg.subrange.type";
893 void SubrangeDesc::dump() {
894 std::cerr << getDescString() << " "
895 << "Tag(" << getTag() << "), "
896 << "Lo(" << Lo << "), "
897 << "Hi(" << Hi << ")\n";
901 //===----------------------------------------------------------------------===//
903 EnumeratorDesc::EnumeratorDesc()
904 : DebugInfoDesc(DW_TAG_enumerator)
909 // Implement isa/cast/dyncast.
910 bool EnumeratorDesc::classof(const DebugInfoDesc *D) {
911 return D->getTag() == DW_TAG_enumerator;
914 /// ApplyToFields - Target the visitor to the fields of the EnumeratorDesc.
916 void EnumeratorDesc::ApplyToFields(DIVisitor *Visitor) {
917 DebugInfoDesc::ApplyToFields(Visitor);
919 Visitor->Apply(Name);
920 Visitor->Apply(Value);
923 /// getDescString - Return a string used to compose global names and labels.
925 const char *EnumeratorDesc::getDescString() const {
926 return "llvm.dbg.enumerator";
929 /// getTypeString - Return a string used to label this descriptor's type.
931 const char *EnumeratorDesc::getTypeString() const {
932 return "llvm.dbg.enumerator.type";
936 void EnumeratorDesc::dump() {
937 std::cerr << getDescString() << " "
938 << "Tag(" << getTag() << "), "
939 << "Name(" << Name << "), "
940 << "Value(" << Value << ")\n";
944 //===----------------------------------------------------------------------===//
946 GlobalDesc::GlobalDesc(unsigned T)
954 , IsDefinition(false)
957 /// ApplyToFields - Target the visitor to the fields of the global.
959 void GlobalDesc::ApplyToFields(DIVisitor *Visitor) {
960 AnchoredDesc::ApplyToFields(Visitor);
962 Visitor->Apply(Context);
963 Visitor->Apply(Name);
964 Visitor->Apply((DebugInfoDesc *&)File);
965 Visitor->Apply(Line);
966 Visitor->Apply((DebugInfoDesc *&)TyDesc);
967 Visitor->Apply(IsStatic);
968 Visitor->Apply(IsDefinition);
971 //===----------------------------------------------------------------------===//
973 GlobalVariableDesc::GlobalVariableDesc()
974 : GlobalDesc(DW_TAG_variable)
978 // Implement isa/cast/dyncast.
979 bool GlobalVariableDesc::classof(const DebugInfoDesc *D) {
980 return D->getTag() == DW_TAG_variable;
983 /// ApplyToFields - Target the visitor to the fields of the GlobalVariableDesc.
985 void GlobalVariableDesc::ApplyToFields(DIVisitor *Visitor) {
986 GlobalDesc::ApplyToFields(Visitor);
988 Visitor->Apply(Global);
991 /// getDescString - Return a string used to compose global names and labels.
993 const char *GlobalVariableDesc::getDescString() const {
994 return "llvm.dbg.global_variable";
997 /// getTypeString - Return a string used to label this descriptors type.
999 const char *GlobalVariableDesc::getTypeString() const {
1000 return "llvm.dbg.global_variable.type";
1003 /// getAnchorString - Return a string used to label this descriptor's anchor.
1005 const char *GlobalVariableDesc::AnchorString = "llvm.dbg.global_variables";
1006 const char *GlobalVariableDesc::getAnchorString() const {
1007 return AnchorString;
1011 void GlobalVariableDesc::dump() {
1012 std::cerr << getDescString() << " "
1013 << "Tag(" << getTag() << "), "
1014 << "Anchor(" << getAnchor() << "), "
1015 << "Name(\"" << getName() << "\"), "
1016 << "File(" << getFile() << "),"
1017 << "Line(" << getLine() << "),"
1018 << "Type(\"" << getTypeDesc() << "\"), "
1019 << "IsStatic(" << (isStatic() ? "true" : "false") << "), "
1020 << "IsDefinition(" << (isDefinition() ? "true" : "false") << "), "
1021 << "Global(" << Global << ")\n";
1025 //===----------------------------------------------------------------------===//
1027 SubprogramDesc::SubprogramDesc()
1028 : GlobalDesc(DW_TAG_subprogram)
1031 // Implement isa/cast/dyncast.
1032 bool SubprogramDesc::classof(const DebugInfoDesc *D) {
1033 return D->getTag() == DW_TAG_subprogram;
1036 /// ApplyToFields - Target the visitor to the fields of the
1038 void SubprogramDesc::ApplyToFields(DIVisitor *Visitor) {
1039 GlobalDesc::ApplyToFields(Visitor);
1041 Visitor->Apply(Elements);
1044 /// getDescString - Return a string used to compose global names and labels.
1046 const char *SubprogramDesc::getDescString() const {
1047 return "llvm.dbg.subprogram";
1050 /// getTypeString - Return a string used to label this descriptors type.
1052 const char *SubprogramDesc::getTypeString() const {
1053 return "llvm.dbg.subprogram.type";
1056 /// getAnchorString - Return a string used to label this descriptor's anchor.
1058 const char *SubprogramDesc::AnchorString = "llvm.dbg.subprograms";
1059 const char *SubprogramDesc::getAnchorString() const {
1060 return AnchorString;
1064 void SubprogramDesc::dump() {
1065 std::cerr << getDescString() << " "
1066 << "Tag(" << getTag() << "), "
1067 << "Anchor(" << getAnchor() << "), "
1068 << "Name(\"" << getName() << "\"), "
1069 << "File(" << getFile() << "),"
1070 << "Line(" << getLine() << "),"
1071 << "Type(\"" << getTypeDesc() << "\"), "
1072 << "IsStatic(" << (isStatic() ? "true" : "false") << "), "
1073 << "IsDefinition(" << (isDefinition() ? "true" : "false") << ")\n";
1077 //===----------------------------------------------------------------------===//
1079 BlockDesc::BlockDesc()
1080 : DebugInfoDesc(DW_TAG_lexical_block)
1083 // Implement isa/cast/dyncast.
1084 bool BlockDesc::classof(const DebugInfoDesc *D) {
1085 return D->getTag() == DW_TAG_lexical_block;
1088 /// ApplyToFields - Target the visitor to the fields of the BlockDesc.
1090 void BlockDesc::ApplyToFields(DIVisitor *Visitor) {
1091 DebugInfoDesc::ApplyToFields(Visitor);
1093 Visitor->Apply(Elements);
1096 /// getDescString - Return a string used to compose global names and labels.
1098 const char *BlockDesc::getDescString() const {
1099 return "llvm.dbg.block";
1102 /// getTypeString - Return a string used to label this descriptors type.
1104 const char *BlockDesc::getTypeString() const {
1105 return "llvm.dbg.block.type";
1109 void BlockDesc::dump() {
1110 std::cerr << getDescString() << " "
1111 << "Tag(" << getTag() << ")\n";
1115 //===----------------------------------------------------------------------===//
1117 DebugInfoDesc *DIDeserializer::Deserialize(Value *V) {
1118 return Deserialize(getGlobalVariable(V));
1120 DebugInfoDesc *DIDeserializer::Deserialize(GlobalVariable *GV) {
1122 if (!GV) return NULL;
1124 // Check to see if it has been already deserialized.
1125 DebugInfoDesc *&Slot = GlobalDescs[GV];
1126 if (Slot) return Slot;
1128 // Get the Tag from the global.
1129 unsigned Tag = DebugInfoDesc::TagFromGlobal(GV);
1131 // Get the debug version if a compile unit.
1132 if (Tag == DW_TAG_compile_unit) {
1133 DebugVersion = CompileUnitDesc::DebugVersionFromGlobal(GV);
1136 // Create an empty instance of the correct sort.
1137 Slot = DebugInfoDesc::DescFactory(Tag);
1139 // If not a user defined descriptor.
1141 // Deserialize the fields.
1142 DIDeserializeVisitor DRAM(*this, GV);
1143 DRAM.ApplyToFields(Slot);
1149 //===----------------------------------------------------------------------===//
1151 /// getStrPtrType - Return a "sbyte *" type.
1153 const PointerType *DISerializer::getStrPtrType() {
1154 // If not already defined.
1156 // Construct the pointer to signed bytes.
1157 StrPtrTy = PointerType::get(Type::SByteTy);
1163 /// getEmptyStructPtrType - Return a "{ }*" type.
1165 const PointerType *DISerializer::getEmptyStructPtrType() {
1166 // If not already defined.
1167 if (!EmptyStructPtrTy) {
1168 // Construct the empty structure type.
1169 const StructType *EmptyStructTy =
1170 StructType::get(std::vector<const Type*>());
1171 // Construct the pointer to empty structure type.
1172 EmptyStructPtrTy = PointerType::get(EmptyStructTy);
1175 return EmptyStructPtrTy;
1178 /// getTagType - Return the type describing the specified descriptor (via tag.)
1180 const StructType *DISerializer::getTagType(DebugInfoDesc *DD) {
1181 // Attempt to get the previously defined type.
1182 StructType *&Ty = TagTypes[DD->getTag()];
1184 // If not already defined.
1186 // Set up fields vector.
1187 std::vector<const Type*> Fields;
1188 // Get types of fields.
1189 DIGetTypesVisitor GTAM(*this, Fields);
1190 GTAM.ApplyToFields(DD);
1192 // Construct structured type.
1193 Ty = StructType::get(Fields);
1195 // Register type name with module.
1196 M->addTypeName(DD->getTypeString(), Ty);
1202 /// getString - Construct the string as constant string global.
1204 Constant *DISerializer::getString(const std::string &String) {
1205 // Check string cache for previous edition.
1206 Constant *&Slot = StringCache[String];
1207 // Return Constant if previously defined.
1208 if (Slot) return Slot;
1209 // If empty string then use a sbyte* null instead.
1210 if (String.empty()) {
1211 Slot = ConstantPointerNull::get(getStrPtrType());
1213 // Construct string as an llvm constant.
1214 Constant *ConstStr = ConstantArray::get(String);
1215 // Otherwise create and return a new string global.
1216 GlobalVariable *StrGV = new GlobalVariable(ConstStr->getType(), true,
1217 GlobalVariable::InternalLinkage,
1218 ConstStr, "str", M);
1219 StrGV->setSection("llvm.metadata");
1220 // Convert to generic string pointer.
1221 Slot = ConstantExpr::getCast(StrGV, getStrPtrType());
1227 /// Serialize - Recursively cast the specified descriptor into a GlobalVariable
1228 /// so that it can be serialized to a .bc or .ll file.
1229 GlobalVariable *DISerializer::Serialize(DebugInfoDesc *DD) {
1230 // Check if the DebugInfoDesc is already in the map.
1231 GlobalVariable *&Slot = DescGlobals[DD];
1233 // See if DebugInfoDesc exists, if so return prior GlobalVariable.
1234 if (Slot) return Slot;
1236 // Get the type associated with the Tag.
1237 const StructType *Ty = getTagType(DD);
1239 // Create the GlobalVariable early to prevent infinite recursion.
1240 GlobalVariable *GV = new GlobalVariable(Ty, true, DD->getLinkage(),
1241 NULL, DD->getDescString(), M);
1242 GV->setSection("llvm.metadata");
1244 // Insert new GlobalVariable in DescGlobals map.
1247 // Set up elements vector
1248 std::vector<Constant*> Elements;
1250 DISerializeVisitor SRAM(*this, Elements);
1251 SRAM.ApplyToFields(DD);
1253 // Set the globals initializer.
1254 GV->setInitializer(ConstantStruct::get(Ty, Elements));
1259 //===----------------------------------------------------------------------===//
1261 /// markVisited - Return true if the GlobalVariable hase been "seen" before.
1262 /// Mark visited otherwise.
1263 bool DIVerifier::markVisited(GlobalVariable *GV) {
1264 // Check if the GlobalVariable is already in the Visited set.
1265 std::set<GlobalVariable *>::iterator VI = Visited.lower_bound(GV);
1267 // See if GlobalVariable exists.
1268 bool Exists = VI != Visited.end() && *VI == GV;
1271 if (!Exists) Visited.insert(VI, GV);
1276 /// Verify - Return true if the GlobalVariable appears to be a valid
1277 /// serialization of a DebugInfoDesc.
1278 bool DIVerifier::Verify(Value *V) {
1279 return Verify(getGlobalVariable(V));
1281 bool DIVerifier::Verify(GlobalVariable *GV) {
1282 // Check if seen before.
1283 if (markVisited(GV)) return true;
1286 unsigned Tag = DebugInfoDesc::TagFromGlobal(GV);
1287 if (Tag == DW_TAG_invalid) return false;
1289 // If a compile unit we need the debug version.
1290 if (Tag == DW_TAG_compile_unit) {
1291 DebugVersion = CompileUnitDesc::DebugVersionFromGlobal(GV);
1292 if (DebugVersion == DW_TAG_invalid) return false;
1295 // Construct an empty DebugInfoDesc.
1296 DebugInfoDesc *DD = DebugInfoDesc::DescFactory(Tag);
1298 // Allow for user defined descriptors.
1299 if (!DD) return true;
1301 // Get the initializer constant.
1302 ConstantStruct *CI = cast<ConstantStruct>(GV->getInitializer());
1304 // Get the operand count.
1305 unsigned N = CI->getNumOperands();
1307 // Get the field count.
1308 unsigned &Slot = Counts[Tag];
1310 // Check the operand count to the field count
1311 DICountVisitor CTAM;
1312 CTAM.ApplyToFields(DD);
1313 Slot = CTAM.getCount();
1316 // Field count must be at most equal operand count.
1322 // Check each field for valid type.
1323 DIVerifyVisitor VRAM(*this, GV);
1324 VRAM.ApplyToFields(DD);
1326 // Release empty DebugInfoDesc.
1329 // Return result of field tests.
1330 return VRAM.isValid();
1333 //===----------------------------------------------------------------------===//
1336 MachineDebugInfo::MachineDebugInfo()
1345 MachineDebugInfo::~MachineDebugInfo() {
1349 /// doInitialization - Initialize the debug state for a new module.
1351 bool MachineDebugInfo::doInitialization() {
1355 /// doFinalization - Tear down the debug state after completion of a module.
1357 bool MachineDebugInfo::doFinalization() {
1361 /// getDescFor - Convert a Value to a debug information descriptor.
1363 // FIXME - use new Value type when available.
1364 DebugInfoDesc *MachineDebugInfo::getDescFor(Value *V) {
1365 return DR.Deserialize(V);
1368 /// Verify - Verify that a Value is debug information descriptor.
1370 bool MachineDebugInfo::Verify(Value *V) {
1372 return VR.Verify(V);
1375 /// AnalyzeModule - Scan the module for global debug information.
1377 void MachineDebugInfo::AnalyzeModule(Module &M) {
1378 SetupCompileUnits(M);
1381 /// SetupCompileUnits - Set up the unique vector of compile units.
1383 void MachineDebugInfo::SetupCompileUnits(Module &M) {
1384 std::vector<CompileUnitDesc *>CU = getAnchoredDescriptors<CompileUnitDesc>(M);
1386 for (unsigned i = 0, N = CU.size(); i < N; i++) {
1387 CompileUnits.insert(CU[i]);
1391 /// getCompileUnits - Return a vector of debug compile units.
1393 const UniqueVector<CompileUnitDesc *> MachineDebugInfo::getCompileUnits()const{
1394 return CompileUnits;
1397 /// getGlobalVariablesUsing - Return all of the GlobalVariables that use the
1398 /// named GlobalVariable.
1399 std::vector<GlobalVariable*>
1400 MachineDebugInfo::getGlobalVariablesUsing(Module &M,
1401 const std::string &RootName) {
1402 return ::getGlobalVariablesUsing(M, RootName);