1 //===-- llvm/CodeGen/MachineModuleInfo.cpp ----------------------*- C++ -*-===//
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 #include "llvm/CodeGen/MachineModuleInfo.h"
12 #include "llvm/Constants.h"
13 #include "llvm/Analysis/ValueTracking.h"
14 #include "llvm/CodeGen/MachineFunctionPass.h"
15 #include "llvm/CodeGen/MachineFunction.h"
16 #include "llvm/CodeGen/MachineLocation.h"
17 #include "llvm/Target/TargetInstrInfo.h"
18 #include "llvm/Target/TargetMachine.h"
19 #include "llvm/Target/TargetOptions.h"
20 #include "llvm/DerivedTypes.h"
21 #include "llvm/GlobalVariable.h"
22 #include "llvm/Intrinsics.h"
23 #include "llvm/Instructions.h"
24 #include "llvm/Module.h"
25 #include "llvm/Support/Dwarf.h"
26 #include "llvm/Support/Streams.h"
28 using namespace llvm::dwarf;
30 // Handle the Pass registration stuff necessary to use TargetData's.
31 static RegisterPass<MachineModuleInfo>
32 X("machinemoduleinfo", "Module Information");
33 char MachineModuleInfo::ID = 0;
35 //===----------------------------------------------------------------------===//
37 /// getGlobalVariablesUsing - Return all of the GlobalVariables which have the
38 /// specified value in their initializer somewhere.
40 getGlobalVariablesUsing(Value *V, std::vector<GlobalVariable*> &Result) {
41 // Scan though value users.
42 for (Value::use_iterator I = V->use_begin(), E = V->use_end(); I != E; ++I) {
43 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(*I)) {
44 // If the user is a GlobalVariable then add to result.
46 } else if (Constant *C = dyn_cast<Constant>(*I)) {
47 // If the user is a constant variable then scan its users
48 getGlobalVariablesUsing(C, Result);
53 /// getGlobalVariablesUsing - Return all of the GlobalVariables that use the
54 /// named GlobalVariable.
55 static std::vector<GlobalVariable*>
56 getGlobalVariablesUsing(Module &M, const std::string &RootName) {
57 std::vector<GlobalVariable*> Result; // GlobalVariables matching criteria.
59 std::vector<const Type*> FieldTypes;
60 FieldTypes.push_back(Type::Int32Ty);
61 FieldTypes.push_back(Type::Int32Ty);
63 // Get the GlobalVariable root.
64 GlobalVariable *UseRoot = M.getGlobalVariable(RootName,
65 StructType::get(FieldTypes));
67 // If present and linkonce then scan for users.
68 if (UseRoot && UseRoot->hasLinkOnceLinkage()) {
69 getGlobalVariablesUsing(UseRoot, Result);
75 /// isStringValue - Return true if the given value can be coerced to a string.
77 static bool isStringValue(Value *V) {
78 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(V)) {
79 if (GV->hasInitializer() && isa<ConstantArray>(GV->getInitializer())) {
80 ConstantArray *Init = cast<ConstantArray>(GV->getInitializer());
81 return Init->isString();
83 } else if (Constant *C = dyn_cast<Constant>(V)) {
84 if (GlobalValue *GV = dyn_cast<GlobalValue>(C))
85 return isStringValue(GV);
86 else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(C)) {
87 if (CE->getOpcode() == Instruction::GetElementPtr) {
88 if (CE->getNumOperands() == 3 &&
89 cast<Constant>(CE->getOperand(1))->isNullValue() &&
90 isa<ConstantInt>(CE->getOperand(2))) {
91 return isStringValue(CE->getOperand(0));
99 /// getGlobalVariable - Return either a direct or cast Global value.
101 static GlobalVariable *getGlobalVariable(Value *V) {
102 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(V)) {
104 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(V)) {
105 if (CE->getOpcode() == Instruction::BitCast) {
106 return dyn_cast<GlobalVariable>(CE->getOperand(0));
107 } else if (CE->getOpcode() == Instruction::GetElementPtr) {
108 for (unsigned int i=1; i<CE->getNumOperands(); i++) {
109 if (!CE->getOperand(i)->isNullValue())
112 return dyn_cast<GlobalVariable>(CE->getOperand(0));
118 /// isGlobalVariable - Return true if the given value can be coerced to a
120 static bool isGlobalVariable(Value *V) {
121 if (isa<GlobalVariable>(V) || isa<ConstantPointerNull>(V)) {
123 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(V)) {
124 if (CE->getOpcode() == Instruction::BitCast) {
125 return isa<GlobalVariable>(CE->getOperand(0));
126 } else if (CE->getOpcode() == Instruction::GetElementPtr) {
127 for (unsigned int i=1; i<CE->getNumOperands(); i++) {
128 if (!CE->getOperand(i)->isNullValue())
131 return isa<GlobalVariable>(CE->getOperand(0));
137 /// getUIntOperand - Return ith operand if it is an unsigned integer.
139 static ConstantInt *getUIntOperand(GlobalVariable *GV, unsigned i) {
140 // Make sure the GlobalVariable has an initializer.
141 if (!GV->hasInitializer()) return NULL;
143 // Get the initializer constant.
144 ConstantStruct *CI = dyn_cast<ConstantStruct>(GV->getInitializer());
145 if (!CI) return NULL;
147 // Check if there is at least i + 1 operands.
148 unsigned N = CI->getNumOperands();
149 if (i >= N) return NULL;
152 return dyn_cast<ConstantInt>(CI->getOperand(i));
155 //===----------------------------------------------------------------------===//
157 /// ApplyToFields - Target the visitor to each field of the debug information
159 void DIVisitor::ApplyToFields(DebugInfoDesc *DD) {
160 DD->ApplyToFields(this);
165 //===----------------------------------------------------------------------===//
166 /// DICountVisitor - This DIVisitor counts all the fields in the supplied debug
167 /// the supplied DebugInfoDesc.
168 class DICountVisitor : public DIVisitor {
170 unsigned Count; // Running count of fields.
173 DICountVisitor() : DIVisitor(), Count(0) {}
176 unsigned getCount() const { return Count; }
178 /// Apply - Count each of the fields.
180 virtual void Apply(int &Field) { ++Count; }
181 virtual void Apply(unsigned &Field) { ++Count; }
182 virtual void Apply(int64_t &Field) { ++Count; }
183 virtual void Apply(uint64_t &Field) { ++Count; }
184 virtual void Apply(bool &Field) { ++Count; }
185 virtual void Apply(std::string &Field) { ++Count; }
186 virtual void Apply(DebugInfoDesc *&Field) { ++Count; }
187 virtual void Apply(GlobalVariable *&Field) { ++Count; }
188 virtual void Apply(std::vector<DebugInfoDesc *> &Field) {
193 //===----------------------------------------------------------------------===//
194 /// DIDeserializeVisitor - This DIVisitor deserializes all the fields in the
195 /// supplied DebugInfoDesc.
196 class DIDeserializeVisitor : public DIVisitor {
198 DIDeserializer &DR; // Active deserializer.
199 unsigned I; // Current operand index.
200 ConstantStruct *CI; // GlobalVariable constant initializer.
203 DIDeserializeVisitor(DIDeserializer &D, GlobalVariable *GV)
204 : DIVisitor(), DR(D), I(0), CI(cast<ConstantStruct>(GV->getInitializer()))
207 /// Apply - Set the value of each of the fields.
209 virtual void Apply(int &Field) {
210 Constant *C = CI->getOperand(I++);
211 Field = cast<ConstantInt>(C)->getSExtValue();
213 virtual void Apply(unsigned &Field) {
214 Constant *C = CI->getOperand(I++);
215 Field = cast<ConstantInt>(C)->getZExtValue();
217 virtual void Apply(int64_t &Field) {
218 Constant *C = CI->getOperand(I++);
219 Field = cast<ConstantInt>(C)->getSExtValue();
221 virtual void Apply(uint64_t &Field) {
222 Constant *C = CI->getOperand(I++);
223 Field = cast<ConstantInt>(C)->getZExtValue();
225 virtual void Apply(bool &Field) {
226 Constant *C = CI->getOperand(I++);
227 Field = cast<ConstantInt>(C)->getZExtValue();
229 virtual void Apply(std::string &Field) {
230 Constant *C = CI->getOperand(I++);
231 // Fills in the string if it succeeds
232 if (!GetConstantStringInfo(C, Field))
235 virtual void Apply(DebugInfoDesc *&Field) {
236 Constant *C = CI->getOperand(I++);
237 Field = DR.Deserialize(C);
239 virtual void Apply(GlobalVariable *&Field) {
240 Constant *C = CI->getOperand(I++);
241 Field = getGlobalVariable(C);
243 virtual void Apply(std::vector<DebugInfoDesc *> &Field) {
245 Constant *C = CI->getOperand(I++);
246 GlobalVariable *GV = getGlobalVariable(C);
247 if (GV->hasInitializer()) {
248 if (ConstantArray *CA = dyn_cast<ConstantArray>(GV->getInitializer())) {
249 for (unsigned i = 0, N = CA->getNumOperands(); i < N; ++i) {
250 GlobalVariable *GVE = getGlobalVariable(CA->getOperand(i));
251 DebugInfoDesc *DE = DR.Deserialize(GVE);
254 } else if (GV->getInitializer()->isNullValue()) {
255 if (const ArrayType *T =
256 dyn_cast<ArrayType>(GV->getType()->getElementType())) {
257 Field.resize(T->getNumElements());
264 //===----------------------------------------------------------------------===//
265 /// DISerializeVisitor - This DIVisitor serializes all the fields in
266 /// the supplied DebugInfoDesc.
267 class DISerializeVisitor : public DIVisitor {
269 DISerializer &SR; // Active serializer.
270 std::vector<Constant*> &Elements; // Element accumulator.
273 DISerializeVisitor(DISerializer &S, std::vector<Constant*> &E)
279 /// Apply - Set the value of each of the fields.
281 virtual void Apply(int &Field) {
282 Elements.push_back(ConstantInt::get(Type::Int32Ty, int32_t(Field)));
284 virtual void Apply(unsigned &Field) {
285 Elements.push_back(ConstantInt::get(Type::Int32Ty, uint32_t(Field)));
287 virtual void Apply(int64_t &Field) {
288 Elements.push_back(ConstantInt::get(Type::Int64Ty, int64_t(Field)));
290 virtual void Apply(uint64_t &Field) {
291 Elements.push_back(ConstantInt::get(Type::Int64Ty, uint64_t(Field)));
293 virtual void Apply(bool &Field) {
294 Elements.push_back(ConstantInt::get(Type::Int1Ty, Field));
296 virtual void Apply(std::string &Field) {
297 Elements.push_back(SR.getString(Field));
299 virtual void Apply(DebugInfoDesc *&Field) {
300 GlobalVariable *GV = NULL;
302 // If non-NULL then convert to global.
303 if (Field) GV = SR.Serialize(Field);
305 // FIXME - At some point should use specific type.
306 const PointerType *EmptyTy = SR.getEmptyStructPtrType();
309 // Set to pointer to global.
310 Elements.push_back(ConstantExpr::getBitCast(GV, EmptyTy));
313 Elements.push_back(ConstantPointerNull::get(EmptyTy));
316 virtual void Apply(GlobalVariable *&Field) {
317 const PointerType *EmptyTy = SR.getEmptyStructPtrType();
319 Elements.push_back(ConstantExpr::getBitCast(Field, EmptyTy));
321 Elements.push_back(ConstantPointerNull::get(EmptyTy));
324 virtual void Apply(std::vector<DebugInfoDesc *> &Field) {
325 const PointerType *EmptyTy = SR.getEmptyStructPtrType();
326 unsigned N = Field.size();
327 ArrayType *AT = ArrayType::get(EmptyTy, N);
328 std::vector<Constant *> ArrayElements;
330 for (unsigned i = 0, N = Field.size(); i < N; ++i) {
331 if (DebugInfoDesc *Element = Field[i]) {
332 GlobalVariable *GVE = SR.Serialize(Element);
333 Constant *CE = ConstantExpr::getBitCast(GVE, EmptyTy);
334 ArrayElements.push_back(cast<Constant>(CE));
336 ArrayElements.push_back(ConstantPointerNull::get(EmptyTy));
340 Constant *CA = ConstantArray::get(AT, ArrayElements);
341 GlobalVariable *CAGV = new GlobalVariable(AT, true,
342 GlobalValue::InternalLinkage,
343 CA, "llvm.dbg.array",
345 CAGV->setSection("llvm.metadata");
346 Constant *CAE = ConstantExpr::getBitCast(CAGV, EmptyTy);
347 Elements.push_back(CAE);
351 //===----------------------------------------------------------------------===//
352 /// DIGetTypesVisitor - This DIVisitor gathers all the field types in
353 /// the supplied DebugInfoDesc.
354 class DIGetTypesVisitor : public DIVisitor {
356 DISerializer &SR; // Active serializer.
357 std::vector<const Type*> &Fields; // Type accumulator.
360 DIGetTypesVisitor(DISerializer &S, std::vector<const Type*> &F)
366 /// Apply - Set the value of each of the fields.
368 virtual void Apply(int &Field) {
369 Fields.push_back(Type::Int32Ty);
371 virtual void Apply(unsigned &Field) {
372 Fields.push_back(Type::Int32Ty);
374 virtual void Apply(int64_t &Field) {
375 Fields.push_back(Type::Int64Ty);
377 virtual void Apply(uint64_t &Field) {
378 Fields.push_back(Type::Int64Ty);
380 virtual void Apply(bool &Field) {
381 Fields.push_back(Type::Int1Ty);
383 virtual void Apply(std::string &Field) {
384 Fields.push_back(SR.getStrPtrType());
386 virtual void Apply(DebugInfoDesc *&Field) {
387 // FIXME - At some point should use specific type.
388 const PointerType *EmptyTy = SR.getEmptyStructPtrType();
389 Fields.push_back(EmptyTy);
391 virtual void Apply(GlobalVariable *&Field) {
392 const PointerType *EmptyTy = SR.getEmptyStructPtrType();
393 Fields.push_back(EmptyTy);
395 virtual void Apply(std::vector<DebugInfoDesc *> &Field) {
396 const PointerType *EmptyTy = SR.getEmptyStructPtrType();
397 Fields.push_back(EmptyTy);
401 //===----------------------------------------------------------------------===//
402 /// DIVerifyVisitor - This DIVisitor verifies all the field types against
403 /// a constant initializer.
404 class DIVerifyVisitor : public DIVisitor {
406 DIVerifier &VR; // Active verifier.
407 bool IsValid; // Validity status.
408 unsigned I; // Current operand index.
409 ConstantStruct *CI; // GlobalVariable constant initializer.
412 DIVerifyVisitor(DIVerifier &V, GlobalVariable *GV)
417 , CI(cast<ConstantStruct>(GV->getInitializer()))
422 bool isValid() const { return IsValid; }
424 /// Apply - Set the value of each of the fields.
426 virtual void Apply(int &Field) {
427 Constant *C = CI->getOperand(I++);
428 IsValid = IsValid && isa<ConstantInt>(C);
430 virtual void Apply(unsigned &Field) {
431 Constant *C = CI->getOperand(I++);
432 IsValid = IsValid && isa<ConstantInt>(C);
434 virtual void Apply(int64_t &Field) {
435 Constant *C = CI->getOperand(I++);
436 IsValid = IsValid && isa<ConstantInt>(C);
438 virtual void Apply(uint64_t &Field) {
439 Constant *C = CI->getOperand(I++);
440 IsValid = IsValid && isa<ConstantInt>(C);
442 virtual void Apply(bool &Field) {
443 Constant *C = CI->getOperand(I++);
444 IsValid = IsValid && isa<ConstantInt>(C) && C->getType() == Type::Int1Ty;
446 virtual void Apply(std::string &Field) {
447 Constant *C = CI->getOperand(I++);
449 (!C || isStringValue(C) || C->isNullValue());
451 virtual void Apply(DebugInfoDesc *&Field) {
452 // FIXME - Prepare the correct descriptor.
453 Constant *C = CI->getOperand(I++);
454 IsValid = IsValid && isGlobalVariable(C);
456 virtual void Apply(GlobalVariable *&Field) {
457 Constant *C = CI->getOperand(I++);
458 IsValid = IsValid && isGlobalVariable(C);
460 virtual void Apply(std::vector<DebugInfoDesc *> &Field) {
461 Constant *C = CI->getOperand(I++);
462 IsValid = IsValid && isGlobalVariable(C);
463 if (!IsValid) return;
465 GlobalVariable *GV = getGlobalVariable(C);
466 IsValid = IsValid && GV && GV->hasInitializer();
467 if (!IsValid) return;
469 ConstantArray *CA = dyn_cast<ConstantArray>(GV->getInitializer());
470 IsValid = IsValid && CA;
471 if (!IsValid) return;
473 for (unsigned i = 0, N = CA->getNumOperands(); IsValid && i < N; ++i) {
474 IsValid = IsValid && isGlobalVariable(CA->getOperand(i));
475 if (!IsValid) return;
477 GlobalVariable *GVE = getGlobalVariable(CA->getOperand(i));
485 //===----------------------------------------------------------------------===//
487 /// TagFromGlobal - Returns the tag number from a debug info descriptor
488 /// GlobalVariable. Return DIIValid if operand is not an unsigned int.
489 unsigned DebugInfoDesc::TagFromGlobal(GlobalVariable *GV) {
490 ConstantInt *C = getUIntOperand(GV, 0);
491 return C ? ((unsigned)C->getZExtValue() & ~LLVMDebugVersionMask) :
492 (unsigned)DW_TAG_invalid;
495 /// VersionFromGlobal - Returns the version number from a debug info
496 /// descriptor GlobalVariable. Return DIIValid if operand is not an unsigned
498 unsigned DebugInfoDesc::VersionFromGlobal(GlobalVariable *GV) {
499 ConstantInt *C = getUIntOperand(GV, 0);
500 return C ? ((unsigned)C->getZExtValue() & LLVMDebugVersionMask) :
501 (unsigned)DW_TAG_invalid;
504 /// DescFactory - Create an instance of debug info descriptor based on Tag.
505 /// Return NULL if not a recognized Tag.
506 DebugInfoDesc *DebugInfoDesc::DescFactory(unsigned Tag) {
508 case DW_TAG_anchor: return new AnchorDesc();
509 case DW_TAG_compile_unit: return new CompileUnitDesc();
510 case DW_TAG_variable: return new GlobalVariableDesc();
511 case DW_TAG_subprogram: return new SubprogramDesc();
512 case DW_TAG_lexical_block: return new BlockDesc();
513 case DW_TAG_base_type: return new BasicTypeDesc();
515 case DW_TAG_pointer_type:
516 case DW_TAG_reference_type:
517 case DW_TAG_const_type:
518 case DW_TAG_volatile_type:
519 case DW_TAG_restrict_type:
521 case DW_TAG_inheritance: return new DerivedTypeDesc(Tag);
522 case DW_TAG_array_type:
523 case DW_TAG_structure_type:
524 case DW_TAG_union_type:
525 case DW_TAG_enumeration_type:
526 case DW_TAG_vector_type:
527 case DW_TAG_subroutine_type: return new CompositeTypeDesc(Tag);
528 case DW_TAG_subrange_type: return new SubrangeDesc();
529 case DW_TAG_enumerator: return new EnumeratorDesc();
530 case DW_TAG_return_variable:
531 case DW_TAG_arg_variable:
532 case DW_TAG_auto_variable: return new VariableDesc(Tag);
538 /// getLinkage - get linkage appropriate for this type of descriptor.
540 GlobalValue::LinkageTypes DebugInfoDesc::getLinkage() const {
541 return GlobalValue::InternalLinkage;
544 /// ApplyToFields - Target the vistor to the fields of the descriptor.
546 void DebugInfoDesc::ApplyToFields(DIVisitor *Visitor) {
550 //===----------------------------------------------------------------------===//
552 AnchorDesc::AnchorDesc()
553 : DebugInfoDesc(DW_TAG_anchor)
556 AnchorDesc::AnchorDesc(AnchoredDesc *D)
557 : DebugInfoDesc(DW_TAG_anchor)
558 , AnchorTag(D->getTag())
561 // Implement isa/cast/dyncast.
562 bool AnchorDesc::classof(const DebugInfoDesc *D) {
563 return D->getTag() == DW_TAG_anchor;
566 /// getLinkage - get linkage appropriate for this type of descriptor.
568 GlobalValue::LinkageTypes AnchorDesc::getLinkage() const {
569 return GlobalValue::LinkOnceLinkage;
572 /// ApplyToFields - Target the visitor to the fields of the TransUnitDesc.
574 void AnchorDesc::ApplyToFields(DIVisitor *Visitor) {
575 DebugInfoDesc::ApplyToFields(Visitor);
577 Visitor->Apply(AnchorTag);
580 /// getDescString - Return a string used to compose global names and labels. A
581 /// A global variable name needs to be defined for each debug descriptor that is
582 /// anchored. NOTE: that each global variable named here also needs to be added
583 /// to the list of names left external in the internalizer.
584 /// ExternalNames.insert("llvm.dbg.compile_units");
585 /// ExternalNames.insert("llvm.dbg.global_variables");
586 /// ExternalNames.insert("llvm.dbg.subprograms");
587 const char *AnchorDesc::getDescString() const {
589 case DW_TAG_compile_unit: return CompileUnitDesc::AnchorString;
590 case DW_TAG_variable: return GlobalVariableDesc::AnchorString;
591 case DW_TAG_subprogram: return SubprogramDesc::AnchorString;
595 assert(0 && "Tag does not have a case for anchor string");
599 /// getTypeString - Return a string used to label this descriptors type.
601 const char *AnchorDesc::getTypeString() const {
602 return "llvm.dbg.anchor.type";
606 void AnchorDesc::dump() {
607 cerr << getDescString() << " "
608 << "Version(" << getVersion() << "), "
609 << "Tag(" << getTag() << "), "
610 << "AnchorTag(" << AnchorTag << ")\n";
614 //===----------------------------------------------------------------------===//
616 AnchoredDesc::AnchoredDesc(unsigned T)
621 /// ApplyToFields - Target the visitor to the fields of the AnchoredDesc.
623 void AnchoredDesc::ApplyToFields(DIVisitor *Visitor) {
624 DebugInfoDesc::ApplyToFields(Visitor);
626 Visitor->Apply(Anchor);
629 //===----------------------------------------------------------------------===//
631 CompileUnitDesc::CompileUnitDesc()
632 : AnchoredDesc(DW_TAG_compile_unit)
639 // Implement isa/cast/dyncast.
640 bool CompileUnitDesc::classof(const DebugInfoDesc *D) {
641 return D->getTag() == DW_TAG_compile_unit;
644 /// ApplyToFields - Target the visitor to the fields of the CompileUnitDesc.
646 void CompileUnitDesc::ApplyToFields(DIVisitor *Visitor) {
647 AnchoredDesc::ApplyToFields(Visitor);
649 // Handle cases out of sync with compiler.
650 if (getVersion() == 0) {
651 unsigned DebugVersion;
652 Visitor->Apply(DebugVersion);
655 Visitor->Apply(Language);
656 Visitor->Apply(FileName);
657 Visitor->Apply(Directory);
658 Visitor->Apply(Producer);
661 /// getDescString - Return a string used to compose global names and labels.
663 const char *CompileUnitDesc::getDescString() const {
664 return "llvm.dbg.compile_unit";
667 /// getTypeString - Return a string used to label this descriptors type.
669 const char *CompileUnitDesc::getTypeString() const {
670 return "llvm.dbg.compile_unit.type";
673 /// getAnchorString - Return a string used to label this descriptor's anchor.
675 const char *const CompileUnitDesc::AnchorString = "llvm.dbg.compile_units";
676 const char *CompileUnitDesc::getAnchorString() const {
681 void CompileUnitDesc::dump() {
682 cerr << getDescString() << " "
683 << "Version(" << getVersion() << "), "
684 << "Tag(" << getTag() << "), "
685 << "Anchor(" << getAnchor() << "), "
686 << "Language(" << Language << "), "
687 << "FileName(\"" << FileName << "\"), "
688 << "Directory(\"" << Directory << "\"), "
689 << "Producer(\"" << Producer << "\")\n";
693 //===----------------------------------------------------------------------===//
695 TypeDesc::TypeDesc(unsigned T)
707 /// ApplyToFields - Target the visitor to the fields of the TypeDesc.
709 void TypeDesc::ApplyToFields(DIVisitor *Visitor) {
710 DebugInfoDesc::ApplyToFields(Visitor);
712 Visitor->Apply(Context);
713 Visitor->Apply(Name);
714 Visitor->Apply(File);
715 Visitor->Apply(Line);
716 Visitor->Apply(Size);
717 Visitor->Apply(Align);
718 Visitor->Apply(Offset);
719 if (getVersion() > LLVMDebugVersion4) Visitor->Apply(Flags);
722 /// getDescString - Return a string used to compose global names and labels.
724 const char *TypeDesc::getDescString() const {
725 return "llvm.dbg.type";
728 /// getTypeString - Return a string used to label this descriptor's type.
730 const char *TypeDesc::getTypeString() const {
731 return "llvm.dbg.type.type";
735 void TypeDesc::dump() {
736 cerr << getDescString() << " "
737 << "Version(" << getVersion() << "), "
738 << "Tag(" << getTag() << "), "
739 << "Context(" << Context << "), "
740 << "Name(\"" << Name << "\"), "
741 << "File(" << File << "), "
742 << "Line(" << Line << "), "
743 << "Size(" << Size << "), "
744 << "Align(" << Align << "), "
745 << "Offset(" << Offset << "), "
746 << "Flags(" << Flags << ")\n";
750 //===----------------------------------------------------------------------===//
752 BasicTypeDesc::BasicTypeDesc()
753 : TypeDesc(DW_TAG_base_type)
757 // Implement isa/cast/dyncast.
758 bool BasicTypeDesc::classof(const DebugInfoDesc *D) {
759 return D->getTag() == DW_TAG_base_type;
762 /// ApplyToFields - Target the visitor to the fields of the BasicTypeDesc.
764 void BasicTypeDesc::ApplyToFields(DIVisitor *Visitor) {
765 TypeDesc::ApplyToFields(Visitor);
767 Visitor->Apply(Encoding);
770 /// getDescString - Return a string used to compose global names and labels.
772 const char *BasicTypeDesc::getDescString() const {
773 return "llvm.dbg.basictype";
776 /// getTypeString - Return a string used to label this descriptor's type.
778 const char *BasicTypeDesc::getTypeString() const {
779 return "llvm.dbg.basictype.type";
783 void BasicTypeDesc::dump() {
784 cerr << getDescString() << " "
785 << "Version(" << getVersion() << "), "
786 << "Tag(" << getTag() << "), "
787 << "Context(" << getContext() << "), "
788 << "Name(\"" << getName() << "\"), "
789 << "Size(" << getSize() << "), "
790 << "Encoding(" << Encoding << ")\n";
794 //===----------------------------------------------------------------------===//
796 DerivedTypeDesc::DerivedTypeDesc(unsigned T)
801 // Implement isa/cast/dyncast.
802 bool DerivedTypeDesc::classof(const DebugInfoDesc *D) {
803 unsigned T = D->getTag();
806 case DW_TAG_pointer_type:
807 case DW_TAG_reference_type:
808 case DW_TAG_const_type:
809 case DW_TAG_volatile_type:
810 case DW_TAG_restrict_type:
812 case DW_TAG_inheritance:
819 /// ApplyToFields - Target the visitor to the fields of the DerivedTypeDesc.
821 void DerivedTypeDesc::ApplyToFields(DIVisitor *Visitor) {
822 TypeDesc::ApplyToFields(Visitor);
824 Visitor->Apply(FromType);
827 /// getDescString - Return a string used to compose global names and labels.
829 const char *DerivedTypeDesc::getDescString() const {
830 return "llvm.dbg.derivedtype";
833 /// getTypeString - Return a string used to label this descriptor's type.
835 const char *DerivedTypeDesc::getTypeString() const {
836 return "llvm.dbg.derivedtype.type";
840 void DerivedTypeDesc::dump() {
841 cerr << getDescString() << " "
842 << "Version(" << getVersion() << "), "
843 << "Tag(" << getTag() << "), "
844 << "Context(" << getContext() << "), "
845 << "Name(\"" << getName() << "\"), "
846 << "Size(" << getSize() << "), "
847 << "File(" << getFile() << "), "
848 << "Line(" << getLine() << "), "
849 << "FromType(" << FromType << ")\n";
853 //===----------------------------------------------------------------------===//
855 CompositeTypeDesc::CompositeTypeDesc(unsigned T)
860 // Implement isa/cast/dyncast.
861 bool CompositeTypeDesc::classof(const DebugInfoDesc *D) {
862 unsigned T = D->getTag();
864 case DW_TAG_array_type:
865 case DW_TAG_structure_type:
866 case DW_TAG_union_type:
867 case DW_TAG_enumeration_type:
868 case DW_TAG_vector_type:
869 case DW_TAG_subroutine_type:
876 /// ApplyToFields - Target the visitor to the fields of the CompositeTypeDesc.
878 void CompositeTypeDesc::ApplyToFields(DIVisitor *Visitor) {
879 DerivedTypeDesc::ApplyToFields(Visitor);
881 Visitor->Apply(Elements);
884 /// getDescString - Return a string used to compose global names and labels.
886 const char *CompositeTypeDesc::getDescString() const {
887 return "llvm.dbg.compositetype";
890 /// getTypeString - Return a string used to label this descriptor's type.
892 const char *CompositeTypeDesc::getTypeString() const {
893 return "llvm.dbg.compositetype.type";
897 void CompositeTypeDesc::dump() {
898 cerr << getDescString() << " "
899 << "Version(" << getVersion() << "), "
900 << "Tag(" << getTag() << "), "
901 << "Context(" << getContext() << "), "
902 << "Name(\"" << getName() << "\"), "
903 << "Size(" << getSize() << "), "
904 << "File(" << getFile() << "), "
905 << "Line(" << getLine() << "), "
906 << "FromType(" << getFromType() << "), "
907 << "Elements.size(" << Elements.size() << ")\n";
911 //===----------------------------------------------------------------------===//
913 SubrangeDesc::SubrangeDesc()
914 : DebugInfoDesc(DW_TAG_subrange_type)
919 // Implement isa/cast/dyncast.
920 bool SubrangeDesc::classof(const DebugInfoDesc *D) {
921 return D->getTag() == DW_TAG_subrange_type;
924 /// ApplyToFields - Target the visitor to the fields of the SubrangeDesc.
926 void SubrangeDesc::ApplyToFields(DIVisitor *Visitor) {
927 DebugInfoDesc::ApplyToFields(Visitor);
933 /// getDescString - Return a string used to compose global names and labels.
935 const char *SubrangeDesc::getDescString() const {
936 return "llvm.dbg.subrange";
939 /// getTypeString - Return a string used to label this descriptor's type.
941 const char *SubrangeDesc::getTypeString() const {
942 return "llvm.dbg.subrange.type";
946 void SubrangeDesc::dump() {
947 cerr << getDescString() << " "
948 << "Version(" << getVersion() << "), "
949 << "Tag(" << getTag() << "), "
950 << "Lo(" << Lo << "), "
951 << "Hi(" << Hi << ")\n";
955 //===----------------------------------------------------------------------===//
957 EnumeratorDesc::EnumeratorDesc()
958 : DebugInfoDesc(DW_TAG_enumerator)
963 // Implement isa/cast/dyncast.
964 bool EnumeratorDesc::classof(const DebugInfoDesc *D) {
965 return D->getTag() == DW_TAG_enumerator;
968 /// ApplyToFields - Target the visitor to the fields of the EnumeratorDesc.
970 void EnumeratorDesc::ApplyToFields(DIVisitor *Visitor) {
971 DebugInfoDesc::ApplyToFields(Visitor);
973 Visitor->Apply(Name);
974 Visitor->Apply(Value);
977 /// getDescString - Return a string used to compose global names and labels.
979 const char *EnumeratorDesc::getDescString() const {
980 return "llvm.dbg.enumerator";
983 /// getTypeString - Return a string used to label this descriptor's type.
985 const char *EnumeratorDesc::getTypeString() const {
986 return "llvm.dbg.enumerator.type";
990 void EnumeratorDesc::dump() {
991 cerr << getDescString() << " "
992 << "Version(" << getVersion() << "), "
993 << "Tag(" << getTag() << "), "
994 << "Name(" << Name << "), "
995 << "Value(" << Value << ")\n";
999 //===----------------------------------------------------------------------===//
1001 VariableDesc::VariableDesc(unsigned T)
1010 // Implement isa/cast/dyncast.
1011 bool VariableDesc::classof(const DebugInfoDesc *D) {
1012 unsigned T = D->getTag();
1014 case DW_TAG_auto_variable:
1015 case DW_TAG_arg_variable:
1016 case DW_TAG_return_variable:
1023 /// ApplyToFields - Target the visitor to the fields of the VariableDesc.
1025 void VariableDesc::ApplyToFields(DIVisitor *Visitor) {
1026 DebugInfoDesc::ApplyToFields(Visitor);
1028 Visitor->Apply(Context);
1029 Visitor->Apply(Name);
1030 Visitor->Apply(File);
1031 Visitor->Apply(Line);
1032 Visitor->Apply(TyDesc);
1035 /// getDescString - Return a string used to compose global names and labels.
1037 const char *VariableDesc::getDescString() const {
1038 return "llvm.dbg.variable";
1041 /// getTypeString - Return a string used to label this descriptor's type.
1043 const char *VariableDesc::getTypeString() const {
1044 return "llvm.dbg.variable.type";
1048 void VariableDesc::dump() {
1049 cerr << getDescString() << " "
1050 << "Version(" << getVersion() << "), "
1051 << "Tag(" << getTag() << "), "
1052 << "Context(" << Context << "), "
1053 << "Name(\"" << Name << "\"), "
1054 << "File(" << File << "), "
1055 << "Line(" << Line << "), "
1056 << "TyDesc(" << TyDesc << ")\n";
1060 //===----------------------------------------------------------------------===//
1062 GlobalDesc::GlobalDesc(unsigned T)
1072 , IsDefinition(false)
1075 /// ApplyToFields - Target the visitor to the fields of the global.
1077 void GlobalDesc::ApplyToFields(DIVisitor *Visitor) {
1078 AnchoredDesc::ApplyToFields(Visitor);
1080 Visitor->Apply(Context);
1081 Visitor->Apply(Name);
1082 Visitor->Apply(FullName);
1083 Visitor->Apply(LinkageName);
1084 Visitor->Apply(File);
1085 Visitor->Apply(Line);
1086 Visitor->Apply(TyDesc);
1087 Visitor->Apply(IsStatic);
1088 Visitor->Apply(IsDefinition);
1091 //===----------------------------------------------------------------------===//
1093 GlobalVariableDesc::GlobalVariableDesc()
1094 : GlobalDesc(DW_TAG_variable)
1098 // Implement isa/cast/dyncast.
1099 bool GlobalVariableDesc::classof(const DebugInfoDesc *D) {
1100 return D->getTag() == DW_TAG_variable;
1103 /// ApplyToFields - Target the visitor to the fields of the GlobalVariableDesc.
1105 void GlobalVariableDesc::ApplyToFields(DIVisitor *Visitor) {
1106 GlobalDesc::ApplyToFields(Visitor);
1108 Visitor->Apply(Global);
1111 /// getDescString - Return a string used to compose global names and labels.
1113 const char *GlobalVariableDesc::getDescString() const {
1114 return "llvm.dbg.global_variable";
1117 /// getTypeString - Return a string used to label this descriptors type.
1119 const char *GlobalVariableDesc::getTypeString() const {
1120 return "llvm.dbg.global_variable.type";
1123 /// getAnchorString - Return a string used to label this descriptor's anchor.
1125 const char *const GlobalVariableDesc::AnchorString = "llvm.dbg.global_variables";
1126 const char *GlobalVariableDesc::getAnchorString() const {
1127 return AnchorString;
1131 void GlobalVariableDesc::dump() {
1132 cerr << getDescString() << " "
1133 << "Version(" << getVersion() << "), "
1134 << "Tag(" << getTag() << "), "
1135 << "Anchor(" << getAnchor() << "), "
1136 << "Name(\"" << getName() << "\"), "
1137 << "FullName(\"" << getFullName() << "\"), "
1138 << "LinkageName(\"" << getLinkageName() << "\"), "
1139 << "File(" << getFile() << "),"
1140 << "Line(" << getLine() << "),"
1141 << "Type(" << getType() << "), "
1142 << "IsStatic(" << (isStatic() ? "true" : "false") << "), "
1143 << "IsDefinition(" << (isDefinition() ? "true" : "false") << "), "
1144 << "Global(" << Global << ")\n";
1148 //===----------------------------------------------------------------------===//
1150 SubprogramDesc::SubprogramDesc()
1151 : GlobalDesc(DW_TAG_subprogram)
1154 // Implement isa/cast/dyncast.
1155 bool SubprogramDesc::classof(const DebugInfoDesc *D) {
1156 return D->getTag() == DW_TAG_subprogram;
1159 /// ApplyToFields - Target the visitor to the fields of the
1161 void SubprogramDesc::ApplyToFields(DIVisitor *Visitor) {
1162 GlobalDesc::ApplyToFields(Visitor);
1165 /// getDescString - Return a string used to compose global names and labels.
1167 const char *SubprogramDesc::getDescString() const {
1168 return "llvm.dbg.subprogram";
1171 /// getTypeString - Return a string used to label this descriptors type.
1173 const char *SubprogramDesc::getTypeString() const {
1174 return "llvm.dbg.subprogram.type";
1177 /// getAnchorString - Return a string used to label this descriptor's anchor.
1179 const char *const SubprogramDesc::AnchorString = "llvm.dbg.subprograms";
1180 const char *SubprogramDesc::getAnchorString() const {
1181 return AnchorString;
1185 void SubprogramDesc::dump() {
1186 cerr << getDescString() << " "
1187 << "Version(" << getVersion() << "), "
1188 << "Tag(" << getTag() << "), "
1189 << "Anchor(" << getAnchor() << "), "
1190 << "Name(\"" << getName() << "\"), "
1191 << "FullName(\"" << getFullName() << "\"), "
1192 << "LinkageName(\"" << getLinkageName() << "\"), "
1193 << "File(" << getFile() << "),"
1194 << "Line(" << getLine() << "),"
1195 << "Type(" << getType() << "), "
1196 << "IsStatic(" << (isStatic() ? "true" : "false") << "), "
1197 << "IsDefinition(" << (isDefinition() ? "true" : "false") << ")\n";
1201 //===----------------------------------------------------------------------===//
1203 BlockDesc::BlockDesc()
1204 : DebugInfoDesc(DW_TAG_lexical_block)
1208 // Implement isa/cast/dyncast.
1209 bool BlockDesc::classof(const DebugInfoDesc *D) {
1210 return D->getTag() == DW_TAG_lexical_block;
1213 /// ApplyToFields - Target the visitor to the fields of the BlockDesc.
1215 void BlockDesc::ApplyToFields(DIVisitor *Visitor) {
1216 DebugInfoDesc::ApplyToFields(Visitor);
1218 Visitor->Apply(Context);
1221 /// getDescString - Return a string used to compose global names and labels.
1223 const char *BlockDesc::getDescString() const {
1224 return "llvm.dbg.block";
1227 /// getTypeString - Return a string used to label this descriptors type.
1229 const char *BlockDesc::getTypeString() const {
1230 return "llvm.dbg.block.type";
1234 void BlockDesc::dump() {
1235 cerr << getDescString() << " "
1236 << "Version(" << getVersion() << "), "
1237 << "Tag(" << getTag() << "),"
1238 << "Context(" << Context << ")\n";
1242 //===----------------------------------------------------------------------===//
1244 DebugInfoDesc *DIDeserializer::Deserialize(Value *V) {
1245 return Deserialize(getGlobalVariable(V));
1247 DebugInfoDesc *DIDeserializer::Deserialize(GlobalVariable *GV) {
1249 if (!GV) return NULL;
1251 // Check to see if it has been already deserialized.
1252 DebugInfoDesc *&Slot = GlobalDescs[GV];
1253 if (Slot) return Slot;
1255 // Get the Tag from the global.
1256 unsigned Tag = DebugInfoDesc::TagFromGlobal(GV);
1258 // Create an empty instance of the correct sort.
1259 Slot = DebugInfoDesc::DescFactory(Tag);
1261 // If not a user defined descriptor.
1263 // Deserialize the fields.
1264 DIDeserializeVisitor DRAM(*this, GV);
1265 DRAM.ApplyToFields(Slot);
1271 //===----------------------------------------------------------------------===//
1273 /// getStrPtrType - Return a "sbyte *" type.
1275 const PointerType *DISerializer::getStrPtrType() {
1276 // If not already defined.
1278 // Construct the pointer to signed bytes.
1279 StrPtrTy = PointerType::getUnqual(Type::Int8Ty);
1285 /// getEmptyStructPtrType - Return a "{ }*" type.
1287 const PointerType *DISerializer::getEmptyStructPtrType() {
1288 // If not already defined.
1289 if (EmptyStructPtrTy) return EmptyStructPtrTy;
1291 // Construct the pointer to empty structure type.
1292 const StructType *EmptyStructTy =
1293 StructType::get(std::vector<const Type*>());
1295 // Construct the pointer to empty structure type.
1296 EmptyStructPtrTy = PointerType::getUnqual(EmptyStructTy);
1297 return EmptyStructPtrTy;
1300 /// getTagType - Return the type describing the specified descriptor (via tag.)
1302 const StructType *DISerializer::getTagType(DebugInfoDesc *DD) {
1303 // Attempt to get the previously defined type.
1304 StructType *&Ty = TagTypes[DD->getTag()];
1306 // If not already defined.
1308 // Set up fields vector.
1309 std::vector<const Type*> Fields;
1310 // Get types of fields.
1311 DIGetTypesVisitor GTAM(*this, Fields);
1312 GTAM.ApplyToFields(DD);
1314 // Construct structured type.
1315 Ty = StructType::get(Fields);
1317 // Register type name with module.
1318 M->addTypeName(DD->getTypeString(), Ty);
1324 /// getString - Construct the string as constant string global.
1326 Constant *DISerializer::getString(const std::string &String) {
1327 // Check string cache for previous edition.
1328 Constant *&Slot = StringCache[String.c_str()];
1330 // Return Constant if previously defined.
1331 if (Slot) return Slot;
1333 // If empty string then use a sbyte* null instead.
1334 if (String.empty()) {
1335 Slot = ConstantPointerNull::get(getStrPtrType());
1337 // Construct string as an llvm constant.
1338 Constant *ConstStr = ConstantArray::get(String);
1340 // Otherwise create and return a new string global.
1341 GlobalVariable *StrGV = new GlobalVariable(ConstStr->getType(), true,
1342 GlobalVariable::InternalLinkage,
1343 ConstStr, ".str", M);
1344 StrGV->setSection("llvm.metadata");
1346 // Convert to generic string pointer.
1347 Slot = ConstantExpr::getBitCast(StrGV, getStrPtrType());
1354 /// Serialize - Recursively cast the specified descriptor into a GlobalVariable
1355 /// so that it can be serialized to a .bc or .ll file.
1356 GlobalVariable *DISerializer::Serialize(DebugInfoDesc *DD) {
1357 // Check if the DebugInfoDesc is already in the map.
1358 GlobalVariable *&Slot = DescGlobals[DD];
1360 // See if DebugInfoDesc exists, if so return prior GlobalVariable.
1361 if (Slot) return Slot;
1363 // Get the type associated with the Tag.
1364 const StructType *Ty = getTagType(DD);
1366 // Create the GlobalVariable early to prevent infinite recursion.
1367 GlobalVariable *GV = new GlobalVariable(Ty, true, DD->getLinkage(),
1368 NULL, DD->getDescString(), M);
1369 GV->setSection("llvm.metadata");
1371 // Insert new GlobalVariable in DescGlobals map.
1374 // Set up elements vector
1375 std::vector<Constant*> Elements;
1377 DISerializeVisitor SRAM(*this, Elements);
1378 SRAM.ApplyToFields(DD);
1380 // Set the globals initializer.
1381 GV->setInitializer(ConstantStruct::get(Ty, Elements));
1386 /// addDescriptor - Directly connect DD with existing GV.
1387 void DISerializer::addDescriptor(DebugInfoDesc *DD,
1388 GlobalVariable *GV) {
1389 DescGlobals[DD] = GV;
1392 //===----------------------------------------------------------------------===//
1394 /// Verify - Return true if the GlobalVariable appears to be a valid
1395 /// serialization of a DebugInfoDesc.
1396 bool DIVerifier::Verify(Value *V) {
1397 return !V || Verify(getGlobalVariable(V));
1399 bool DIVerifier::Verify(GlobalVariable *GV) {
1401 if (!GV) return true;
1403 // Check prior validity.
1404 unsigned &ValiditySlot = Validity[GV];
1406 // If visited before then use old state.
1407 if (ValiditySlot) return ValiditySlot == Valid;
1409 // Assume validity for the time being (recursion.)
1410 ValiditySlot = Valid;
1412 // Make sure the global is internal or link once (anchor.)
1413 if (GV->getLinkage() != GlobalValue::InternalLinkage &&
1414 GV->getLinkage() != GlobalValue::LinkOnceLinkage) {
1415 ValiditySlot = Invalid;
1420 unsigned Tag = DebugInfoDesc::TagFromGlobal(GV);
1422 // Check for user defined descriptors.
1423 if (Tag == DW_TAG_invalid) {
1424 ValiditySlot = Valid;
1429 unsigned Version = DebugInfoDesc::VersionFromGlobal(GV);
1431 // Check for version mismatch.
1432 if (Version != LLVMDebugVersion) {
1433 ValiditySlot = Invalid;
1437 // Construct an empty DebugInfoDesc.
1438 DebugInfoDesc *DD = DebugInfoDesc::DescFactory(Tag);
1440 // Allow for user defined descriptors.
1441 if (!DD) return true;
1443 // Get the initializer constant.
1444 ConstantStruct *CI = cast<ConstantStruct>(GV->getInitializer());
1446 // Get the operand count.
1447 unsigned N = CI->getNumOperands();
1449 // Get the field count.
1450 unsigned &CountSlot = Counts[Tag];
1452 // Check the operand count to the field count
1453 DICountVisitor CTAM;
1454 CTAM.ApplyToFields(DD);
1455 CountSlot = CTAM.getCount();
1458 // Field count must be at most equal operand count.
1459 if (CountSlot > N) {
1461 ValiditySlot = Invalid;
1465 // Check each field for valid type.
1466 DIVerifyVisitor VRAM(*this, GV);
1467 VRAM.ApplyToFields(DD);
1469 // Release empty DebugInfoDesc.
1472 // If fields are not valid.
1473 if (!VRAM.isValid()) {
1474 ValiditySlot = Invalid;
1481 /// isVerified - Return true if the specified GV has already been
1482 /// verified as a debug information descriptor.
1483 bool DIVerifier::isVerified(GlobalVariable *GV) {
1484 unsigned &ValiditySlot = Validity[GV];
1485 if (ValiditySlot) return ValiditySlot == Valid;
1489 //===----------------------------------------------------------------------===//
1491 DebugScope::~DebugScope() {
1492 for (unsigned i = 0, N = Scopes.size(); i < N; ++i) delete Scopes[i];
1493 for (unsigned j = 0, M = Variables.size(); j < M; ++j) delete Variables[j];
1496 //===----------------------------------------------------------------------===//
1498 MachineModuleInfo::MachineModuleInfo()
1499 : ImmutablePass((intptr_t)&ID)
1513 , CallsUnwindInit(0)
1515 // Always emit "no personality" info
1516 Personalities.push_back(NULL);
1518 MachineModuleInfo::~MachineModuleInfo() {
1522 /// doInitialization - Initialize the state for a new module.
1524 bool MachineModuleInfo::doInitialization() {
1528 /// doFinalization - Tear down the state after completion of a module.
1530 bool MachineModuleInfo::doFinalization() {
1534 /// BeginFunction - Begin gathering function meta information.
1536 void MachineModuleInfo::BeginFunction(MachineFunction *MF) {
1540 /// EndFunction - Discard function meta information.
1542 void MachineModuleInfo::EndFunction() {
1543 // Clean up scope information.
1550 // Clean up line info.
1553 // Clean up frame info.
1556 // Clean up exception info.
1557 LandingPads.clear();
1562 CallsUnwindInit = 0;
1565 /// getDescFor - Convert a Value to a debug information descriptor.
1567 // FIXME - use new Value type when available.
1568 DebugInfoDesc *MachineModuleInfo::getDescFor(Value *V) {
1569 return DR.Deserialize(V);
1572 /// AnalyzeModule - Scan the module for global debug information.
1574 void MachineModuleInfo::AnalyzeModule(Module &M) {
1575 SetupCompileUnits(M);
1577 // Insert functions in the llvm.used array into UsedFunctions.
1578 GlobalVariable *GV = M.getGlobalVariable("llvm.used");
1579 if (!GV || !GV->hasInitializer()) return;
1581 // Should be an array of 'i8*'.
1582 ConstantArray *InitList = dyn_cast<ConstantArray>(GV->getInitializer());
1583 if (InitList == 0) return;
1585 for (unsigned i = 0, e = InitList->getNumOperands(); i != e; ++i) {
1586 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(InitList->getOperand(i)))
1587 if (CE->getOpcode() == Instruction::BitCast)
1588 if (Function *F = dyn_cast<Function>(CE->getOperand(0)))
1589 UsedFunctions.insert(F);
1593 /// SetupCompileUnits - Set up the unique vector of compile units.
1595 void MachineModuleInfo::SetupCompileUnits(Module &M) {
1596 std::vector<CompileUnitDesc *>CU = getAnchoredDescriptors<CompileUnitDesc>(M);
1598 for (unsigned i = 0, N = CU.size(); i < N; i++) {
1599 CompileUnits.insert(CU[i]);
1603 /// getCompileUnits - Return a vector of debug compile units.
1605 const UniqueVector<CompileUnitDesc *> MachineModuleInfo::getCompileUnits()const{
1606 return CompileUnits;
1609 /// getGlobalVariablesUsing - Return all of the GlobalVariables that use the
1610 /// named GlobalVariable.
1611 std::vector<GlobalVariable*>
1612 MachineModuleInfo::getGlobalVariablesUsing(Module &M,
1613 const std::string &RootName) {
1614 return ::getGlobalVariablesUsing(M, RootName);
1617 /// RecordSourceLine - Records location information and associates it with a
1618 /// debug label. Returns a unique label ID used to generate a label and
1619 /// provide correspondence to the source line list.
1620 unsigned MachineModuleInfo::RecordSourceLine(unsigned Line, unsigned Column,
1622 unsigned ID = NextLabelID();
1623 Lines.push_back(SourceLineInfo(Line, Column, Source, ID));
1627 /// RecordSource - Register a source file with debug info. Returns an source
1629 unsigned MachineModuleInfo::RecordSource(const std::string &Directory,
1630 const std::string &Source) {
1631 unsigned DirectoryID = Directories.insert(Directory);
1632 return SourceFiles.insert(SourceFileInfo(DirectoryID, Source));
1634 unsigned MachineModuleInfo::RecordSource(const CompileUnitDesc *CompileUnit) {
1635 return RecordSource(CompileUnit->getDirectory(),
1636 CompileUnit->getFileName());
1639 /// RecordRegionStart - Indicate the start of a region.
1641 unsigned MachineModuleInfo::RecordRegionStart(Value *V) {
1642 // FIXME - need to be able to handle split scopes because of bb cloning.
1643 DebugInfoDesc *ScopeDesc = DR.Deserialize(V);
1644 DebugScope *Scope = getOrCreateScope(ScopeDesc);
1645 unsigned ID = NextLabelID();
1646 if (!Scope->getStartLabelID()) Scope->setStartLabelID(ID);
1650 /// RecordRegionEnd - Indicate the end of a region.
1652 unsigned MachineModuleInfo::RecordRegionEnd(Value *V) {
1653 // FIXME - need to be able to handle split scopes because of bb cloning.
1654 DebugInfoDesc *ScopeDesc = DR.Deserialize(V);
1655 DebugScope *Scope = getOrCreateScope(ScopeDesc);
1656 unsigned ID = NextLabelID();
1657 Scope->setEndLabelID(ID);
1661 /// RecordVariable - Indicate the declaration of a local variable.
1663 void MachineModuleInfo::RecordVariable(GlobalValue *GV, unsigned FrameIndex) {
1664 VariableDesc *VD = cast<VariableDesc>(DR.Deserialize(GV));
1665 DebugScope *Scope = getOrCreateScope(VD->getContext());
1666 DebugVariable *DV = new DebugVariable(VD, FrameIndex);
1667 Scope->AddVariable(DV);
1670 /// getOrCreateScope - Returns the scope associated with the given descriptor.
1672 DebugScope *MachineModuleInfo::getOrCreateScope(DebugInfoDesc *ScopeDesc) {
1673 DebugScope *&Slot = ScopeMap[ScopeDesc];
1675 // FIXME - breaks down when the context is an inlined function.
1676 DebugInfoDesc *ParentDesc = NULL;
1677 if (BlockDesc *Block = dyn_cast<BlockDesc>(ScopeDesc)) {
1678 ParentDesc = Block->getContext();
1680 DebugScope *Parent = ParentDesc ? getOrCreateScope(ParentDesc) : NULL;
1681 Slot = new DebugScope(Parent, ScopeDesc);
1683 Parent->AddScope(Slot);
1684 } else if (RootScope) {
1685 // FIXME - Add inlined function scopes to the root so we can delete
1686 // them later. Long term, handle inlined functions properly.
1687 RootScope->AddScope(Slot);
1689 // First function is top level function.
1696 //===-EH-------------------------------------------------------------------===//
1698 /// getOrCreateLandingPadInfo - Find or create an LandingPadInfo for the
1699 /// specified MachineBasicBlock.
1700 LandingPadInfo &MachineModuleInfo::getOrCreateLandingPadInfo
1701 (MachineBasicBlock *LandingPad) {
1702 unsigned N = LandingPads.size();
1703 for (unsigned i = 0; i < N; ++i) {
1704 LandingPadInfo &LP = LandingPads[i];
1705 if (LP.LandingPadBlock == LandingPad)
1709 LandingPads.push_back(LandingPadInfo(LandingPad));
1710 return LandingPads[N];
1713 /// addInvoke - Provide the begin and end labels of an invoke style call and
1714 /// associate it with a try landing pad block.
1715 void MachineModuleInfo::addInvoke(MachineBasicBlock *LandingPad,
1716 unsigned BeginLabel, unsigned EndLabel) {
1717 LandingPadInfo &LP = getOrCreateLandingPadInfo(LandingPad);
1718 LP.BeginLabels.push_back(BeginLabel);
1719 LP.EndLabels.push_back(EndLabel);
1722 /// addLandingPad - Provide the label of a try LandingPad block.
1724 unsigned MachineModuleInfo::addLandingPad(MachineBasicBlock *LandingPad) {
1725 unsigned LandingPadLabel = NextLabelID();
1726 LandingPadInfo &LP = getOrCreateLandingPadInfo(LandingPad);
1727 LP.LandingPadLabel = LandingPadLabel;
1728 return LandingPadLabel;
1731 /// addPersonality - Provide the personality function for the exception
1733 void MachineModuleInfo::addPersonality(MachineBasicBlock *LandingPad,
1734 Function *Personality) {
1735 LandingPadInfo &LP = getOrCreateLandingPadInfo(LandingPad);
1736 LP.Personality = Personality;
1738 for (unsigned i = 0; i < Personalities.size(); ++i)
1739 if (Personalities[i] == Personality)
1742 Personalities.push_back(Personality);
1745 /// addCatchTypeInfo - Provide the catch typeinfo for a landing pad.
1747 void MachineModuleInfo::addCatchTypeInfo(MachineBasicBlock *LandingPad,
1748 std::vector<GlobalVariable *> &TyInfo) {
1749 LandingPadInfo &LP = getOrCreateLandingPadInfo(LandingPad);
1750 for (unsigned N = TyInfo.size(); N; --N)
1751 LP.TypeIds.push_back(getTypeIDFor(TyInfo[N - 1]));
1754 /// addFilterTypeInfo - Provide the filter typeinfo for a landing pad.
1756 void MachineModuleInfo::addFilterTypeInfo(MachineBasicBlock *LandingPad,
1757 std::vector<GlobalVariable *> &TyInfo) {
1758 LandingPadInfo &LP = getOrCreateLandingPadInfo(LandingPad);
1759 std::vector<unsigned> IdsInFilter (TyInfo.size());
1760 for (unsigned I = 0, E = TyInfo.size(); I != E; ++I)
1761 IdsInFilter[I] = getTypeIDFor(TyInfo[I]);
1762 LP.TypeIds.push_back(getFilterIDFor(IdsInFilter));
1765 /// addCleanup - Add a cleanup action for a landing pad.
1767 void MachineModuleInfo::addCleanup(MachineBasicBlock *LandingPad) {
1768 LandingPadInfo &LP = getOrCreateLandingPadInfo(LandingPad);
1769 LP.TypeIds.push_back(0);
1772 /// TidyLandingPads - Remap landing pad labels and remove any deleted landing
1774 void MachineModuleInfo::TidyLandingPads() {
1775 for (unsigned i = 0; i != LandingPads.size(); ) {
1776 LandingPadInfo &LandingPad = LandingPads[i];
1777 LandingPad.LandingPadLabel = MappedLabel(LandingPad.LandingPadLabel);
1779 // Special case: we *should* emit LPs with null LP MBB. This indicates
1781 if (!LandingPad.LandingPadLabel && LandingPad.LandingPadBlock) {
1782 LandingPads.erase(LandingPads.begin() + i);
1786 for (unsigned j=0; j != LandingPads[i].BeginLabels.size(); ) {
1787 unsigned BeginLabel = MappedLabel(LandingPad.BeginLabels[j]);
1788 unsigned EndLabel = MappedLabel(LandingPad.EndLabels[j]);
1790 if (!BeginLabel || !EndLabel) {
1791 LandingPad.BeginLabels.erase(LandingPad.BeginLabels.begin() + j);
1792 LandingPad.EndLabels.erase(LandingPad.EndLabels.begin() + j);
1796 LandingPad.BeginLabels[j] = BeginLabel;
1797 LandingPad.EndLabels[j] = EndLabel;
1801 // Remove landing pads with no try-ranges.
1802 if (LandingPads[i].BeginLabels.empty()) {
1803 LandingPads.erase(LandingPads.begin() + i);
1807 // If there is no landing pad, ensure that the list of typeids is empty.
1808 // If the only typeid is a cleanup, this is the same as having no typeids.
1809 if (!LandingPad.LandingPadBlock ||
1810 (LandingPad.TypeIds.size() == 1 && !LandingPad.TypeIds[0]))
1811 LandingPad.TypeIds.clear();
1817 /// getTypeIDFor - Return the type id for the specified typeinfo. This is
1819 unsigned MachineModuleInfo::getTypeIDFor(GlobalVariable *TI) {
1820 for (unsigned i = 0, N = TypeInfos.size(); i != N; ++i)
1821 if (TypeInfos[i] == TI) return i + 1;
1823 TypeInfos.push_back(TI);
1824 return TypeInfos.size();
1827 /// getFilterIDFor - Return the filter id for the specified typeinfos. This is
1829 int MachineModuleInfo::getFilterIDFor(std::vector<unsigned> &TyIds) {
1830 // If the new filter coincides with the tail of an existing filter, then
1831 // re-use the existing filter. Folding filters more than this requires
1832 // re-ordering filters and/or their elements - probably not worth it.
1833 for (std::vector<unsigned>::iterator I = FilterEnds.begin(),
1834 E = FilterEnds.end(); I != E; ++I) {
1835 unsigned i = *I, j = TyIds.size();
1838 if (FilterIds[--i] != TyIds[--j])
1842 // The new filter coincides with range [i, end) of the existing filter.
1848 // Add the new filter.
1849 int FilterID = -(1 + FilterIds.size());
1850 FilterIds.reserve(FilterIds.size() + TyIds.size() + 1);
1851 for (unsigned I = 0, N = TyIds.size(); I != N; ++I)
1852 FilterIds.push_back(TyIds[I]);
1853 FilterEnds.push_back(FilterIds.size());
1854 FilterIds.push_back(0); // terminator
1858 /// getPersonality - Return the personality function for the current function.
1859 Function *MachineModuleInfo::getPersonality() const {
1860 // FIXME: Until PR1414 will be fixed, we're using 1 personality function per
1862 return !LandingPads.empty() ? LandingPads[0].Personality : NULL;
1865 /// getPersonalityIndex - Return unique index for current personality
1866 /// function. NULL personality function should always get zero index.
1867 unsigned MachineModuleInfo::getPersonalityIndex() const {
1868 const Function* Personality = NULL;
1870 // Scan landing pads. If there is at least one non-NULL personality - use it.
1871 for (unsigned i = 0; i != LandingPads.size(); ++i)
1872 if (LandingPads[i].Personality) {
1873 Personality = LandingPads[i].Personality;
1877 for (unsigned i = 0; i < Personalities.size(); ++i) {
1878 if (Personalities[i] == Personality)
1882 // This should never happen
1883 assert(0 && "Personality function should be set!");
1887 //===----------------------------------------------------------------------===//
1888 /// DebugLabelFolding pass - This pass prunes out redundant labels. This allows
1889 /// a info consumer to determine if the range of two labels is empty, by seeing
1890 /// if the labels map to the same reduced label.
1894 struct DebugLabelFolder : public MachineFunctionPass {
1896 DebugLabelFolder() : MachineFunctionPass((intptr_t)&ID) {}
1898 virtual bool runOnMachineFunction(MachineFunction &MF);
1899 virtual const char *getPassName() const { return "Label Folder"; }
1902 char DebugLabelFolder::ID = 0;
1904 bool DebugLabelFolder::runOnMachineFunction(MachineFunction &MF) {
1905 // Get machine module info.
1906 MachineModuleInfo *MMI = getAnalysisToUpdate<MachineModuleInfo>();
1907 if (!MMI) return false;
1909 // Track if change is made.
1910 bool MadeChange = false;
1911 // No prior label to begin.
1912 unsigned PriorLabel = 0;
1914 // Iterate through basic blocks.
1915 for (MachineFunction::iterator BB = MF.begin(), E = MF.end();
1917 // Iterate through instructions.
1918 for (MachineBasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ) {
1920 if (I->isDebugLabel()) {
1921 // The label ID # is always operand #0, an immediate.
1922 unsigned NextLabel = I->getOperand(0).getImm();
1924 // If there was an immediate prior label.
1926 // Remap the current label to prior label.
1927 MMI->RemapLabel(NextLabel, PriorLabel);
1928 // Delete the current label.
1930 // Indicate a change has been made.
1934 // Start a new round.
1935 PriorLabel = NextLabel;
1938 // No consecutive labels.
1949 FunctionPass *createDebugLabelFoldingPass() { return new DebugLabelFolder(); }