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/MC/MCSymbol.h"
21 #include "llvm/Support/Debug.h"
22 #include "llvm/Support/ErrorHandling.h"
23 #include "llvm/Support/raw_ostream.h"
28 class Printer : public FunctionPass {
33 Printer() : FunctionPass(ID), OS(errs()) {}
34 explicit Printer(raw_ostream &OS) : FunctionPass(ID), OS(OS) {}
37 const char *getPassName() const;
38 void getAnalysisUsage(AnalysisUsage &AU) const;
40 bool runOnFunction(Function &F);
43 class Deleter : public FunctionPass {
49 const char *getPassName() const;
50 void getAnalysisUsage(AnalysisUsage &AU) const;
52 bool runOnFunction(Function &F);
53 bool doFinalization(Module &M);
58 INITIALIZE_PASS(GCModuleInfo, "collector-metadata",
59 "Create Garbage Collector Module Metadata", false, false);
61 // -----------------------------------------------------------------------------
63 GCFunctionInfo::GCFunctionInfo(const Function &F, GCStrategy &S)
64 : F(F), S(S), FrameSize(~0LL) {}
66 GCFunctionInfo::~GCFunctionInfo() {}
68 // -----------------------------------------------------------------------------
70 char GCModuleInfo::ID = 0;
72 GCModuleInfo::GCModuleInfo()
73 : ImmutablePass(ID) {}
75 GCModuleInfo::~GCModuleInfo() {
79 GCStrategy *GCModuleInfo::getOrCreateStrategy(const Module *M,
80 const std::string &Name) {
81 strategy_map_type::iterator NMI = StrategyMap.find(Name);
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 (Name == I->getName()) {
88 GCStrategy *S = I->instantiate();
91 StrategyMap.GetOrCreateValue(Name).setValue(S);
92 StrategyList.push_back(S);
97 dbgs() << "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(raw_ostream &OS) {
129 return new Printer(OS);
133 const char *Printer::getPassName() const {
134 return "Print Garbage Collector Information";
137 void Printer::getAnalysisUsage(AnalysisUsage &AU) const {
138 FunctionPass::getAnalysisUsage(AU);
139 AU.setPreservesAll();
140 AU.addRequired<GCModuleInfo>();
143 static const char *DescKind(GC::PointKind Kind) {
145 default: llvm_unreachable("Unknown GC point kind");
146 case GC::Loop: return "loop";
147 case GC::Return: return "return";
148 case GC::PreCall: return "pre-call";
149 case GC::PostCall: return "post-call";
153 bool Printer::runOnFunction(Function &F) {
154 if (F.hasGC()) return false;
156 GCFunctionInfo *FD = &getAnalysis<GCModuleInfo>().getFunctionInfo(F);
158 OS << "GC roots for " << FD->getFunction().getNameStr() << ":\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().getNameStr() << ":\n";
164 for (GCFunctionInfo::iterator PI = FD->begin(),
165 PE = FD->end(); PI != PE; ++PI) {
167 OS << "\t" << PI->Label->getName() << ": "
168 << DescKind(PI->Kind) << ", live = {";
170 for (GCFunctionInfo::live_iterator RI = FD->live_begin(PI),
171 RE = FD->live_end(PI);;) {
172 OS << " " << RI->Num;
184 // -----------------------------------------------------------------------------
186 char Deleter::ID = 0;
188 FunctionPass *llvm::createGCInfoDeleter() {
189 return new Deleter();
192 Deleter::Deleter() : FunctionPass(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 = getAnalysisIfAvailable<GCModuleInfo>();
209 assert(GMI && "Deleter didn't require GCModuleInfo?!");