1 //===-- GCMetadata.cpp - Garbage collector metadata -----------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements the GCFunctionInfo class and GCModuleInfo pass.
12 //===----------------------------------------------------------------------===//
14 #include "llvm/CodeGen/GCMetadata.h"
15 #include "llvm/CodeGen/GCStrategy.h"
16 #include "llvm/CodeGen/MachineFrameInfo.h"
17 #include "llvm/Pass.h"
18 #include "llvm/CodeGen/Passes.h"
19 #include "llvm/Function.h"
20 #include "llvm/Support/Compiler.h"
26 class VISIBILITY_HIDDEN Printer : public FunctionPass {
31 explicit Printer(std::ostream &OS = *cerr);
33 const char *getPassName() const;
34 void getAnalysisUsage(AnalysisUsage &AU) const;
36 bool runOnFunction(Function &F);
39 class VISIBILITY_HIDDEN Deleter : public FunctionPass {
45 const char *getPassName() const;
46 void getAnalysisUsage(AnalysisUsage &AU) const;
48 bool runOnFunction(Function &F);
49 bool doFinalization(Module &M);
54 static RegisterPass<GCModuleInfo>
55 X("collector-metadata", "Create Garbage Collector Module Metadata");
57 // -----------------------------------------------------------------------------
59 GCFunctionInfo::GCFunctionInfo(const Function &F, GCStrategy &S)
60 : F(F), S(S), FrameSize(~0LL) {}
62 GCFunctionInfo::~GCFunctionInfo() {}
64 // -----------------------------------------------------------------------------
66 char GCModuleInfo::ID = 0;
68 GCModuleInfo::GCModuleInfo()
69 : ImmutablePass(&ID) {}
71 GCModuleInfo::~GCModuleInfo() {
75 GCStrategy *GCModuleInfo::getOrCreateStrategy(const Module *M,
76 const std::string &Name) {
77 const char *Start = Name.c_str();
79 strategy_map_type::iterator NMI =
80 StrategyMap.find(Start, Start + Name.size());
81 if (NMI != StrategyMap.end())
82 return NMI->getValue();
84 for (GCRegistry::iterator I = GCRegistry::begin(),
85 E = GCRegistry::end(); I != E; ++I) {
86 if (strcmp(Start, I->getName()) == 0) {
87 GCStrategy *S = I->instantiate();
90 StrategyMap.GetOrCreateValue(Start, Start + Name.size()).setValue(S);
91 StrategyList.push_back(S);
96 cerr << "unsupported GC: " << Name << "\n";
100 GCFunctionInfo &GCModuleInfo::getFunctionInfo(const Function &F) {
101 assert(!F.isDeclaration() && "Can only get GCFunctionInfo for a definition!");
104 finfo_map_type::iterator I = FInfoMap.find(&F);
105 if (I != FInfoMap.end())
108 GCStrategy *S = getOrCreateStrategy(F.getParent(), F.getGC());
109 GCFunctionInfo *GFI = S->insertFunctionInfo(F);
114 void GCModuleInfo::clear() {
118 for (iterator I = begin(), E = end(); I != E; ++I)
120 StrategyList.clear();
123 // -----------------------------------------------------------------------------
125 char Printer::ID = 0;
127 FunctionPass *llvm::createGCInfoPrinter(std::ostream &OS) {
128 return new Printer(OS);
131 Printer::Printer(std::ostream &OS)
132 : FunctionPass(intptr_t(&ID)), OS(OS) {}
134 const char *Printer::getPassName() const {
135 return "Print Garbage Collector Information";
138 void Printer::getAnalysisUsage(AnalysisUsage &AU) const {
139 FunctionPass::getAnalysisUsage(AU);
140 AU.setPreservesAll();
141 AU.addRequired<GCModuleInfo>();
144 static const char *DescKind(GC::PointKind Kind) {
146 default: assert(0 && "Unknown GC point kind");
147 case GC::Loop: return "loop";
148 case GC::Return: return "return";
149 case GC::PreCall: return "pre-call";
150 case GC::PostCall: return "post-call";
154 bool Printer::runOnFunction(Function &F) {
156 GCFunctionInfo *FD = &getAnalysis<GCModuleInfo>().getFunctionInfo(F);
158 OS << "GC roots for " << FD->getFunction().getNameStart() << ":\n";
159 for (GCFunctionInfo::roots_iterator RI = FD->roots_begin(),
160 RE = FD->roots_end(); RI != RE; ++RI)
161 OS << "\t" << RI->Num << "\t" << RI->StackOffset << "[sp]\n";
163 OS << "GC safe points for " << FD->getFunction().getNameStart() << ":\n";
164 for (GCFunctionInfo::iterator PI = FD->begin(),
165 PE = FD->end(); PI != PE; ++PI) {
167 OS << "\tlabel " << PI->Num << ": " << DescKind(PI->Kind) << ", live = {";
169 for (GCFunctionInfo::live_iterator RI = FD->live_begin(PI),
170 RE = FD->live_end(PI);;) {
171 OS << " " << RI->Num;
184 // -----------------------------------------------------------------------------
186 char Deleter::ID = 0;
188 FunctionPass *llvm::createGCInfoDeleter() {
189 return new Deleter();
192 Deleter::Deleter() : FunctionPass(intptr_t(&ID)) {}
194 const char *Deleter::getPassName() const {
195 return "Delete Garbage Collector Information";
198 void Deleter::getAnalysisUsage(AnalysisUsage &AU) const {
199 AU.setPreservesAll();
200 AU.addRequired<GCModuleInfo>();
203 bool Deleter::runOnFunction(Function &MF) {
207 bool Deleter::doFinalization(Module &M) {
208 GCModuleInfo *GMI = getAnalysisToUpdate<GCModuleInfo>();
209 assert(GMI && "Deleter didn't require GCModuleInfo?!");