lib/Analysis/LazyCallGraph.cpp

   1 //===- LazyCallGraph.cpp - Analysis of a Module's call graph --------------===//
   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 #include "llvm/Analysis/LazyCallGraph.h"
  11 #include "llvm/ADT/STLExtras.h"
  12 #include "llvm/IR/CallSite.h"
  13 #include "llvm/IR/InstVisitor.h"
  14 #include "llvm/IR/Instructions.h"
  15 #include "llvm/IR/PassManager.h"
  16 #include "llvm/Support/Debug.h"
  17 #include "llvm/Support/raw_ostream.h"
  18
  19 using namespace llvm;
  20
  21 #define DEBUG_TYPE "lcg"
  22
  23 static void findCallees(
  24     SmallVectorImpl<Constant *> &Worklist, SmallPtrSetImpl<Constant *> &Visited,
  25     SmallVectorImpl<PointerUnion<Function *, LazyCallGraph::Node *>> &Callees,
  26     DenseMap<Function *, size_t> &CalleeIndexMap) {
  27   while (!Worklist.empty()) {
  28     Constant *C = Worklist.pop_back_val();
  29
  30     if (Function *F = dyn_cast<Function>(C)) {
  31       // Note that we consider *any* function with a definition to be a viable
  32       // edge. Even if the function's definition is subject to replacement by
  33       // some other module (say, a weak definition) there may still be
  34       // optimizations which essentially speculate based on the definition and
  35       // a way to check that the specific definition is in fact the one being
  36       // used. For example, this could be done by moving the weak definition to
  37       // a strong (internal) definition and making the weak definition be an
  38       // alias. Then a test of the address of the weak function against the new
  39       // strong definition's address would be an effective way to determine the
  40       // safety of optimizing a direct call edge.
  41       if (!F->isDeclaration() &&
  42           CalleeIndexMap.insert(std::make_pair(F, Callees.size())).second) {
  43         DEBUG(dbgs() << "    Added callable function: " << F->getName()
  44                      << "\n");
  45         Callees.push_back(F);
  46       }
  47       continue;
  48     }
  49
  50     for (Value *Op : C->operand_values())
  51       if (Visited.insert(cast<Constant>(Op)))
  52         Worklist.push_back(cast<Constant>(Op));
  53   }
  54 }
  55
  56 LazyCallGraph::Node::Node(LazyCallGraph &G, Function &F)
  57     : G(&G), F(F), DFSNumber(0), LowLink(0) {
  58   DEBUG(dbgs() << "  Adding functions called by '" << F.getName()
  59                << "' to the graph.\n");
  60
  61   SmallVector<Constant *, 16> Worklist;
  62   SmallPtrSet<Constant *, 16> Visited;
  63   // Find all the potential callees in this function. First walk the
  64   // instructions and add every operand which is a constant to the worklist.
  65   for (BasicBlock &BB : F)
  66     for (Instruction &I : BB)
  67       for (Value *Op : I.operand_values())
  68         if (Constant *C = dyn_cast<Constant>(Op))
  69           if (Visited.insert(C))
  70             Worklist.push_back(C);
  71
  72   // We've collected all the constant (and thus potentially function or
  73   // function containing) operands to all of the instructions in the function.
  74   // Process them (recursively) collecting every function found.
  75   findCallees(Worklist, Visited, Callees, CalleeIndexMap);
  76 }
  77
  78 LazyCallGraph::LazyCallGraph(Module &M) : NextDFSNumber(0) {
  79   DEBUG(dbgs() << "Building CG for module: " << M.getModuleIdentifier()
  80                << "\n");
  81   for (Function &F : M)
  82     if (!F.isDeclaration() && !F.hasLocalLinkage())
  83       if (EntryIndexMap.insert(std::make_pair(&F, EntryNodes.size())).second) {
  84         DEBUG(dbgs() << "  Adding '" << F.getName()
  85                      << "' to entry set of the graph.\n");
  86         EntryNodes.push_back(&F);
  87       }
  88
  89   // Now add entry nodes for functions reachable via initializers to globals.
  90   SmallVector<Constant *, 16> Worklist;
  91   SmallPtrSet<Constant *, 16> Visited;
  92   for (GlobalVariable &GV : M.globals())
  93     if (GV.hasInitializer())
  94       if (Visited.insert(GV.getInitializer()))
  95         Worklist.push_back(GV.getInitializer());
  96
  97   DEBUG(dbgs() << "  Adding functions referenced by global initializers to the "
  98                   "entry set.\n");
  99   findCallees(Worklist, Visited, EntryNodes, EntryIndexMap);
 100
 101   for (auto &Entry : EntryNodes)
 102     if (Function *F = Entry.dyn_cast<Function *>())
 103       SCCEntryNodes.insert(F);
 104     else
 105       SCCEntryNodes.insert(&Entry.get<Node *>()->getFunction());
 106 }
 107
 108 LazyCallGraph::LazyCallGraph(LazyCallGraph &&G)
 109     : BPA(std::move(G.BPA)), NodeMap(std::move(G.NodeMap)),
 110       EntryNodes(std::move(G.EntryNodes)),
 111       EntryIndexMap(std::move(G.EntryIndexMap)), SCCBPA(std::move(G.SCCBPA)),
 112       SCCMap(std::move(G.SCCMap)), LeafSCCs(std::move(G.LeafSCCs)),
 113       DFSStack(std::move(G.DFSStack)),
 114       SCCEntryNodes(std::move(G.SCCEntryNodes)),
 115       NextDFSNumber(G.NextDFSNumber) {
 116   updateGraphPtrs();
 117 }
 118
 119 LazyCallGraph &LazyCallGraph::operator=(LazyCallGraph &&G) {
 120   BPA = std::move(G.BPA);
 121   NodeMap = std::move(G.NodeMap);
 122   EntryNodes = std::move(G.EntryNodes);
 123   EntryIndexMap = std::move(G.EntryIndexMap);
 124   SCCBPA = std::move(G.SCCBPA);
 125   SCCMap = std::move(G.SCCMap);
 126   LeafSCCs = std::move(G.LeafSCCs);
 127   DFSStack = std::move(G.DFSStack);
 128   SCCEntryNodes = std::move(G.SCCEntryNodes);
 129   NextDFSNumber = G.NextDFSNumber;
 130   updateGraphPtrs();
 131   return *this;
 132 }
 133
 134 LazyCallGraph::Node *LazyCallGraph::insertInto(Function &F, Node *&MappedN) {
 135   return new (MappedN = BPA.Allocate()) Node(*this, F);
 136 }
 137
 138 void LazyCallGraph::updateGraphPtrs() {
 139   // Process all nodes updating the graph pointers.
 140   SmallVector<Node *, 16> Worklist;
 141   for (auto &Entry : EntryNodes)
 142     if (Node *EntryN = Entry.dyn_cast<Node *>())
 143       Worklist.push_back(EntryN);
 144
 145   while (!Worklist.empty()) {
 146     Node *N = Worklist.pop_back_val();
 147     N->G = this;
 148     for (auto &Callee : N->Callees)
 149       if (Node *CalleeN = Callee.dyn_cast<Node *>())
 150         Worklist.push_back(CalleeN);
 151   }
 152 }
 153
 154 LazyCallGraph::SCC *LazyCallGraph::formSCCFromDFSStack(
 155     SmallVectorImpl<std::pair<Node *, Node::iterator>> &DFSStack) {
 156   // The tail of the stack is the new SCC. Allocate the SCC and pop the stack
 157   // into it.
 158   SCC *NewSCC = new (SCCBPA.Allocate()) SCC();
 159
 160   // Because we don't follow the strict Tarjan recursive formulation, walk
 161   // from the top of the stack down, propagating the lowest link and stopping
 162   // when the DFS number is the lowest link.
 163   int LowestLink = DFSStack.back().first->LowLink;
 164   do {
 165     Node *SCCN = DFSStack.pop_back_val().first;
 166     SCCMap[&SCCN->getFunction()] = NewSCC;
 167     NewSCC->Nodes.push_back(SCCN);
 168     LowestLink = std::min(LowestLink, SCCN->LowLink);
 169     bool Inserted =
 170         NewSCC->NodeSet.insert(&SCCN->getFunction());
 171     (void)Inserted;
 172     assert(Inserted && "Cannot have duplicates in the DFSStack!");
 173   } while (!DFSStack.empty() && LowestLink <= DFSStack.back().first->DFSNumber);
 174   assert(LowestLink == NewSCC->Nodes.back()->DFSNumber &&
 175          "Cannot stop with a DFS number greater than the lowest link!");
 176
 177   // A final pass over all edges in the SCC (this remains linear as we only
 178   // do this once when we build the SCC) to connect it to the parent sets of
 179   // its children.
 180   bool IsLeafSCC = true;
 181   for (Node *SCCN : NewSCC->Nodes)
 182     for (Node *SCCChildN : *SCCN) {
 183       if (NewSCC->NodeSet.count(&SCCChildN->getFunction()))
 184         continue;
 185       SCC *ChildSCC = SCCMap.lookup(&SCCChildN->getFunction());
 186       assert(ChildSCC &&
 187              "Must have all child SCCs processed when building a new SCC!");
 188       ChildSCC->ParentSCCs.insert(NewSCC);
 189       IsLeafSCC = false;
 190     }
 191
 192   // For the SCCs where we fine no child SCCs, add them to the leaf list.
 193   if (IsLeafSCC)
 194     LeafSCCs.push_back(NewSCC);
 195
 196   return NewSCC;
 197 }
 198
 199 LazyCallGraph::SCC *LazyCallGraph::getNextSCCInPostOrder() {
 200   // When the stack is empty, there are no more SCCs to walk in this graph.
 201   if (DFSStack.empty()) {
 202     // If we've handled all candidate entry nodes to the SCC forest, we're done.
 203     if (SCCEntryNodes.empty())
 204       return nullptr;
 205
 206     // Reset the DFS numbering.
 207     NextDFSNumber = 1;
 208     Node *N = get(*SCCEntryNodes.pop_back_val());
 209     DFSStack.push_back(std::make_pair(N, N->begin()));
 210   }
 211
 212   Node *N = DFSStack.back().first;
 213   if (N->DFSNumber == 0) {
 214     // This node hasn't been visited before, assign it a DFS number and remove
 215     // it from the entry set.
 216     N->LowLink = N->DFSNumber = NextDFSNumber++;
 217     SCCEntryNodes.remove(&N->getFunction());
 218   }
 219
 220   for (auto I = DFSStack.back().second, E = N->end(); I != E; ++I) {
 221     Node *ChildN = *I;
 222     if (ChildN->DFSNumber == 0) {
 223       // Mark that we should start at this child when next this node is the
 224       // top of the stack. We don't start at the next child to ensure this
 225       // child's lowlink is reflected.
 226       // FIXME: I don't actually think this is required, and we could start
 227       // at the next child.
 228       DFSStack.back().second = I;
 229
 230       // Recurse onto this node via a tail call.
 231       DFSStack.push_back(std::make_pair(ChildN, ChildN->begin()));
 232       return LazyCallGraph::getNextSCCInPostOrder();
 233     }
 234
 235     // Track the lowest link of the childen, if any are still in the stack.
 236     if (ChildN->LowLink < N->LowLink && !SCCMap.count(&ChildN->getFunction()))
 237       N->LowLink = ChildN->LowLink;
 238   }
 239
 240   // Form the new SCC out of the top of the DFS stack.
 241   return formSCCFromDFSStack(DFSStack);
 242 }
 243
 244 char LazyCallGraphAnalysis::PassID;
 245
 246 LazyCallGraphPrinterPass::LazyCallGraphPrinterPass(raw_ostream &OS) : OS(OS) {}
 247
 248 static void printNodes(raw_ostream &OS, LazyCallGraph::Node &N,
 249                        SmallPtrSetImpl<LazyCallGraph::Node *> &Printed) {
 250   // Recurse depth first through the nodes.
 251   for (LazyCallGraph::Node *ChildN : N)
 252     if (Printed.insert(ChildN))
 253       printNodes(OS, *ChildN, Printed);
 254
 255   OS << "  Call edges in function: " << N.getFunction().getName() << "\n";
 256   for (LazyCallGraph::iterator I = N.begin(), E = N.end(); I != E; ++I)
 257     OS << "    -> " << I->getFunction().getName() << "\n";
 258
 259   OS << "\n";
 260 }
 261
 262 static void printSCC(raw_ostream &OS, LazyCallGraph::SCC &SCC) {
 263   ptrdiff_t SCCSize = std::distance(SCC.begin(), SCC.end());
 264   OS << "  SCC with " << SCCSize << " functions:\n";
 265
 266   for (LazyCallGraph::Node *N : SCC)
 267     OS << "    " << N->getFunction().getName() << "\n";
 268
 269   OS << "\n";
 270 }
 271
 272 PreservedAnalyses LazyCallGraphPrinterPass::run(Module *M,
 273                                                 ModuleAnalysisManager *AM) {
 274   LazyCallGraph &G = AM->getResult<LazyCallGraphAnalysis>(M);
 275
 276   OS << "Printing the call graph for module: " << M->getModuleIdentifier()
 277      << "\n\n";
 278
 279   SmallPtrSet<LazyCallGraph::Node *, 16> Printed;
 280   for (LazyCallGraph::Node *N : G)
 281     if (Printed.insert(N))
 282       printNodes(OS, *N, Printed);
 283
 284   for (LazyCallGraph::SCC *SCC : G.postorder_sccs())
 285     printSCC(OS, *SCC);
 286
 287   return PreservedAnalyses::all();
 288
 289 }