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"
21 #include "llvm/Support/ErrorHandling.h"
27 class VISIBILITY_HIDDEN Printer : public FunctionPass {
32 explicit Printer(std::ostream &OS = *cerr);
34 const char *getPassName() const;
35 void getAnalysisUsage(AnalysisUsage &AU) const;
37 bool runOnFunction(Function &F);
40 class VISIBILITY_HIDDEN Deleter : public FunctionPass {
46 const char *getPassName() const;
47 void getAnalysisUsage(AnalysisUsage &AU) const;
49 bool runOnFunction(Function &F);
50 bool doFinalization(Module &M);
55 static RegisterPass<GCModuleInfo>
56 X("collector-metadata", "Create Garbage Collector Module Metadata");
58 // -----------------------------------------------------------------------------
60 GCFunctionInfo::GCFunctionInfo(const Function &F, GCStrategy &S)
61 : F(F), S(S), FrameSize(~0LL) {}
63 GCFunctionInfo::~GCFunctionInfo() {}
65 // -----------------------------------------------------------------------------
67 char GCModuleInfo::ID = 0;
69 GCModuleInfo::GCModuleInfo()
70 : ImmutablePass(&ID) {}
72 GCModuleInfo::~GCModuleInfo() {
76 GCStrategy *GCModuleInfo::getOrCreateStrategy(const Module *M,
77 const std::string &Name) {
78 const char *Start = Name.c_str();
80 strategy_map_type::iterator NMI =
81 StrategyMap.find(Start, Start + Name.size());
82 if (NMI != StrategyMap.end())
83 return NMI->getValue();
85 for (GCRegistry::iterator I = GCRegistry::begin(),
86 E = GCRegistry::end(); I != E; ++I) {
87 if (strcmp(Start, I->getName()) == 0) {
88 GCStrategy *S = I->instantiate();
91 StrategyMap.GetOrCreateValue(Start, Start + Name.size()).setValue(S);
92 StrategyList.push_back(S);
97 cerr << "unsupported GC: " << Name << "\n";
101 GCFunctionInfo &GCModuleInfo::getFunctionInfo(const Function &F) {
102 assert(!F.isDeclaration() && "Can only get GCFunctionInfo for a definition!");
105 finfo_map_type::iterator I = FInfoMap.find(&F);
106 if (I != FInfoMap.end())
109 GCStrategy *S = getOrCreateStrategy(F.getParent(), F.getGC());
110 GCFunctionInfo *GFI = S->insertFunctionInfo(F);
115 void GCModuleInfo::clear() {
119 for (iterator I = begin(), E = end(); I != E; ++I)
121 StrategyList.clear();
124 // -----------------------------------------------------------------------------
126 char Printer::ID = 0;
128 FunctionPass *llvm::createGCInfoPrinter(std::ostream &OS) {
129 return new Printer(OS);
132 Printer::Printer(std::ostream &OS)
133 : FunctionPass(&ID), OS(OS) {}
135 const char *Printer::getPassName() const {
136 return "Print Garbage Collector Information";
139 void Printer::getAnalysisUsage(AnalysisUsage &AU) const {
140 FunctionPass::getAnalysisUsage(AU);
141 AU.setPreservesAll();
142 AU.addRequired<GCModuleInfo>();
145 static const char *DescKind(GC::PointKind Kind) {
147 default: LLVM_UNREACHABLE("Unknown GC point kind");
148 case GC::Loop: return "loop";
149 case GC::Return: return "return";
150 case GC::PreCall: return "pre-call";
151 case GC::PostCall: return "post-call";
155 bool Printer::runOnFunction(Function &F) {
157 GCFunctionInfo *FD = &getAnalysis<GCModuleInfo>().getFunctionInfo(F);
159 OS << "GC roots for " << FD->getFunction().getNameStart() << ":\n";
160 for (GCFunctionInfo::roots_iterator RI = FD->roots_begin(),
161 RE = FD->roots_end(); RI != RE; ++RI)
162 OS << "\t" << RI->Num << "\t" << RI->StackOffset << "[sp]\n";
164 OS << "GC safe points for " << FD->getFunction().getNameStart() << ":\n";
165 for (GCFunctionInfo::iterator PI = FD->begin(),
166 PE = FD->end(); PI != PE; ++PI) {
168 OS << "\tlabel " << PI->Num << ": " << DescKind(PI->Kind) << ", live = {";
170 for (GCFunctionInfo::live_iterator RI = FD->live_begin(PI),
171 RE = FD->live_end(PI);;) {
172 OS << " " << RI->Num;
185 // -----------------------------------------------------------------------------
187 char Deleter::ID = 0;
189 FunctionPass *llvm::createGCInfoDeleter() {
190 return new Deleter();
193 Deleter::Deleter() : FunctionPass(&ID) {}
195 const char *Deleter::getPassName() const {
196 return "Delete Garbage Collector Information";
199 void Deleter::getAnalysisUsage(AnalysisUsage &AU) const {
200 AU.setPreservesAll();
201 AU.addRequired<GCModuleInfo>();
204 bool Deleter::runOnFunction(Function &MF) {
208 bool Deleter::doFinalization(Module &M) {
209 GCModuleInfo *GMI = getAnalysisIfAvailable<GCModuleInfo>();
210 assert(GMI && "Deleter didn't require GCModuleInfo?!");