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/MachineFrameInfo.h"
16 #include "llvm/CodeGen/Passes.h"
17 #include "llvm/IR/Function.h"
18 #include "llvm/IR/GCStrategy.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) {}
35 const char *getPassName() const override;
36 void getAnalysisUsage(AnalysisUsage &AU) const override;
38 bool runOnFunction(Function &F) override;
39 bool doFinalization(Module &M) override;
43 INITIALIZE_PASS(GCModuleInfo, "collector-metadata",
44 "Create Garbage Collector Module Metadata", false, false)
46 // -----------------------------------------------------------------------------
48 GCFunctionInfo::GCFunctionInfo(const Function &F, GCStrategy &S)
49 : F(F), S(S), FrameSize(~0LL) {}
51 GCFunctionInfo::~GCFunctionInfo() {}
53 // -----------------------------------------------------------------------------
55 char GCModuleInfo::ID = 0;
57 GCModuleInfo::GCModuleInfo() : ImmutablePass(ID) {
58 initializeGCModuleInfoPass(*PassRegistry::getPassRegistry());
61 GCFunctionInfo &GCModuleInfo::getFunctionInfo(const Function &F) {
62 assert(!F.isDeclaration() && "Can only get GCFunctionInfo for a definition!");
65 finfo_map_type::iterator I = FInfoMap.find(&F);
66 if (I != FInfoMap.end())
69 GCStrategy *S = F.getGCStrategy();
71 std::string error = std::string("unsupported GC: ") + F.getGC();
72 report_fatal_error(error);
74 // Save the fact this strategy is associated with this module. Note that
75 // these are non-owning references, the GCStrategy remains owned by the
77 StrategyList.push_back(S);
78 Functions.push_back(make_unique<GCFunctionInfo>(F, *S));
79 GCFunctionInfo *GFI = Functions.back().get();
84 void GCModuleInfo::clear() {
90 // -----------------------------------------------------------------------------
94 FunctionPass *llvm::createGCInfoPrinter(raw_ostream &OS) {
95 return new Printer(OS);
98 const char *Printer::getPassName() const {
99 return "Print Garbage Collector Information";
102 void Printer::getAnalysisUsage(AnalysisUsage &AU) const {
103 FunctionPass::getAnalysisUsage(AU);
104 AU.setPreservesAll();
105 AU.addRequired<GCModuleInfo>();
108 static const char *DescKind(GC::PointKind Kind) {
119 llvm_unreachable("Invalid point kind");
122 bool Printer::runOnFunction(Function &F) {
126 GCFunctionInfo *FD = &getAnalysis<GCModuleInfo>().getFunctionInfo(F);
128 OS << "GC roots for " << FD->getFunction().getName() << ":\n";
129 for (GCFunctionInfo::roots_iterator RI = FD->roots_begin(),
130 RE = FD->roots_end();
132 OS << "\t" << RI->Num << "\t" << RI->StackOffset << "[sp]\n";
134 OS << "GC safe points for " << FD->getFunction().getName() << ":\n";
135 for (GCFunctionInfo::iterator PI = FD->begin(), PE = FD->end(); PI != PE;
138 OS << "\t" << PI->Label->getName() << ": " << DescKind(PI->Kind)
141 for (GCFunctionInfo::live_iterator RI = FD->live_begin(PI),
142 RE = FD->live_end(PI);
144 OS << " " << RI->Num;
156 bool Printer::doFinalization(Module &M) {
157 GCModuleInfo *GMI = getAnalysisIfAvailable<GCModuleInfo>();
158 assert(GMI && "Printer didn't require GCModuleInfo?!");