lib/CodeGen/GCMetadata.cpp

   1 //===-- GCMetadata.cpp - Garbage collector metadata -----------------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file implements the GCFunctionInfo class and GCModuleInfo pass.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  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"
  24 using namespace llvm;
  25
  26 namespace {
  27
  28   class Printer : public FunctionPass {
  29     static char ID;
  30     raw_ostream &OS;
  31
  32   public:
  33     explicit Printer(raw_ostream &OS) : FunctionPass(ID), OS(OS) {}
  34
  35
  36     const char *getPassName() const override;
  37     void getAnalysisUsage(AnalysisUsage &AU) const override;
  38
  39     bool runOnFunction(Function &F) override;
  40     bool doFinalization(Module &M) override;
  41   };
  42
  43 }
  44
  45 INITIALIZE_PASS(GCModuleInfo, "collector-metadata",
  46                 "Create Garbage Collector Module Metadata", false, false)
  47
  48 // -----------------------------------------------------------------------------
  49
  50 GCFunctionInfo::GCFunctionInfo(const Function &F, GCStrategy &S)
  51   : F(F), S(S), FrameSize(~0LL) {}
  52
  53 GCFunctionInfo::~GCFunctionInfo() {}
  54
  55 // -----------------------------------------------------------------------------
  56
  57 char GCModuleInfo::ID = 0;
  58
  59 GCModuleInfo::GCModuleInfo()
  60     : ImmutablePass(ID) {
  61   initializeGCModuleInfoPass(*PassRegistry::getPassRegistry());
  62 }
  63
  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();
  69
  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();
  74       S->Name = Name;
  75       StrategyMap[Name] = S.get();
  76       StrategyList.push_back(std::move(S));
  77       return StrategyList.back().get();
  78     }
  79   }
  80
  81   dbgs() << "unsupported GC: " << Name << "\n";
  82   llvm_unreachable(nullptr);
  83 }
  84
  85 GCFunctionInfo &GCModuleInfo::getFunctionInfo(const Function &F) {
  86   assert(!F.isDeclaration() && "Can only get GCFunctionInfo for a definition!");
  87   assert(F.hasGC());
  88
  89   finfo_map_type::iterator I = FInfoMap.find(&F);
  90   if (I != FInfoMap.end())
  91     return *I->second;
  92
  93   GCStrategy *S = getOrCreateStrategy(F.getParent(), F.getGC());
  94   GCFunctionInfo *GFI = S->insertFunctionInfo(F);
  95   FInfoMap[&F] = GFI;
  96   return *GFI;
  97 }
  98
  99 void GCModuleInfo::clear() {
 100   FInfoMap.clear();
 101   StrategyMap.clear();
 102   StrategyList.clear();
 103 }
 104
 105 // -----------------------------------------------------------------------------
 106
 107 char Printer::ID = 0;
 108
 109 FunctionPass *llvm::createGCInfoPrinter(raw_ostream &OS) {
 110   return new Printer(OS);
 111 }
 112
 113
 114 const char *Printer::getPassName() const {
 115   return "Print Garbage Collector Information";
 116 }
 117
 118 void Printer::getAnalysisUsage(AnalysisUsage &AU) const {
 119   FunctionPass::getAnalysisUsage(AU);
 120   AU.setPreservesAll();
 121   AU.addRequired<GCModuleInfo>();
 122 }
 123
 124 static const char *DescKind(GC::PointKind Kind) {
 125   switch (Kind) {
 126     case GC::Loop:     return "loop";
 127     case GC::Return:   return "return";
 128     case GC::PreCall:  return "pre-call";
 129     case GC::PostCall: return "post-call";
 130   }
 131   llvm_unreachable("Invalid point kind");
 132 }
 133
 134 bool Printer::runOnFunction(Function &F) {
 135   if (F.hasGC()) return false;
 136
 137   GCFunctionInfo *FD = &getAnalysis<GCModuleInfo>().getFunctionInfo(F);
 138
 139   OS << "GC roots for " << FD->getFunction().getName() << ":\n";
 140   for (GCFunctionInfo::roots_iterator RI = FD->roots_begin(),
 141                                       RE = FD->roots_end(); RI != RE; ++RI)
 142     OS << "\t" << RI->Num << "\t" << RI->StackOffset << "[sp]\n";
 143
 144   OS << "GC safe points for " << FD->getFunction().getName() << ":\n";
 145   for (GCFunctionInfo::iterator PI = FD->begin(),
 146                                 PE = FD->end(); PI != PE; ++PI) {
 147
 148     OS << "\t" << PI->Label->getName() << ": "
 149        << DescKind(PI->Kind) << ", live = {";
 150
 151     for (GCFunctionInfo::live_iterator RI = FD->live_begin(PI),
 152                                        RE = FD->live_end(PI);;) {
 153       OS << " " << RI->Num;
 154       if (++RI == RE)
 155         break;
 156       OS << ",";
 157     }
 158
 159     OS << " }\n";
 160   }
 161
 162   return false;
 163 }
 164
 165 bool Printer::doFinalization(Module &M) {
 166   GCModuleInfo *GMI = getAnalysisIfAvailable<GCModuleInfo>();
 167   assert(GMI && "Printer didn't require GCModuleInfo?!");
 168   GMI->clear();
 169   return false;
 170 }