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/CodeGen/Passes.h"
18 #include "llvm/IR/Function.h"
19 #include "llvm/MC/MCSymbol.h"
20 #include "llvm/Pass.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 explicit Printer(raw_ostream &OS) : FunctionPass(ID), OS(OS) {}
36 const char *getPassName() const override;
37 void getAnalysisUsage(AnalysisUsage &AU) const override;
39 bool runOnFunction(Function &F) override;
40 bool doFinalization(Module &M) override;
45 INITIALIZE_PASS(GCModuleInfo, "collector-metadata",
46 "Create Garbage Collector Module Metadata", false, false)
48 // -----------------------------------------------------------------------------
50 GCFunctionInfo::GCFunctionInfo(const Function &F, GCStrategy &S)
51 : F(F), S(S), FrameSize(~0LL) {}
53 GCFunctionInfo::~GCFunctionInfo() {}
55 // -----------------------------------------------------------------------------
57 char GCModuleInfo::ID = 0;
59 GCModuleInfo::GCModuleInfo()
61 initializeGCModuleInfoPass(*PassRegistry::getPassRegistry());
64 GCStrategy *GCModuleInfo::getOrCreateStrategy(const Module *M,
65 const std::string &Name) {
66 strategy_map_type::iterator NMI = StrategyMap.find(Name);
67 if (NMI != StrategyMap.end())
68 return NMI->getValue();
70 for (GCRegistry::iterator I = GCRegistry::begin(),
71 E = GCRegistry::end(); I != E; ++I) {
72 if (Name == I->getName()) {
73 std::unique_ptr<GCStrategy> S = I->instantiate();
76 StrategyMap.GetOrCreateValue(Name).setValue(S.get());
77 StrategyList.push_back(std::move(S));
78 return StrategyList.back().get();
82 dbgs() << "unsupported GC: " << Name << "\n";
83 llvm_unreachable(nullptr);
86 GCFunctionInfo &GCModuleInfo::getFunctionInfo(const Function &F) {
87 assert(!F.isDeclaration() && "Can only get GCFunctionInfo for a definition!");
90 finfo_map_type::iterator I = FInfoMap.find(&F);
91 if (I != FInfoMap.end())
94 GCStrategy *S = getOrCreateStrategy(F.getParent(), F.getGC());
95 GCFunctionInfo *GFI = S->insertFunctionInfo(F);
100 void GCModuleInfo::clear() {
103 StrategyList.clear();
106 // -----------------------------------------------------------------------------
108 char Printer::ID = 0;
110 FunctionPass *llvm::createGCInfoPrinter(raw_ostream &OS) {
111 return new Printer(OS);
115 const char *Printer::getPassName() const {
116 return "Print Garbage Collector Information";
119 void Printer::getAnalysisUsage(AnalysisUsage &AU) const {
120 FunctionPass::getAnalysisUsage(AU);
121 AU.setPreservesAll();
122 AU.addRequired<GCModuleInfo>();
125 static const char *DescKind(GC::PointKind Kind) {
127 case GC::Loop: return "loop";
128 case GC::Return: return "return";
129 case GC::PreCall: return "pre-call";
130 case GC::PostCall: return "post-call";
132 llvm_unreachable("Invalid point kind");
135 bool Printer::runOnFunction(Function &F) {
136 if (F.hasGC()) return false;
138 GCFunctionInfo *FD = &getAnalysis<GCModuleInfo>().getFunctionInfo(F);
140 OS << "GC roots for " << FD->getFunction().getName() << ":\n";
141 for (GCFunctionInfo::roots_iterator RI = FD->roots_begin(),
142 RE = FD->roots_end(); RI != RE; ++RI)
143 OS << "\t" << RI->Num << "\t" << RI->StackOffset << "[sp]\n";
145 OS << "GC safe points for " << FD->getFunction().getName() << ":\n";
146 for (GCFunctionInfo::iterator PI = FD->begin(),
147 PE = FD->end(); PI != PE; ++PI) {
149 OS << "\t" << PI->Label->getName() << ": "
150 << DescKind(PI->Kind) << ", live = {";
152 for (GCFunctionInfo::live_iterator RI = FD->live_begin(PI),
153 RE = FD->live_end(PI);;) {
154 OS << " " << RI->Num;
166 bool Printer::doFinalization(Module &M) {
167 GCModuleInfo *GMI = getAnalysisIfAvailable<GCModuleInfo>();
168 assert(GMI && "Printer didn't require GCModuleInfo?!");