1
//===- CallGraphSCCPass.h - Pass that operates BU on call graph -*- C++ -*-===//
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 defines the CallGraphSCCPass class, which is used for passes which
11
// are implemented as bottom-up traversals on the call graph. Because there may
12
// be cycles in the call graph, passes of this type operate on the call-graph in
13
// SCC order: that is, they process function bottom-up, except for recursive
14
// functions, which they process all at once.
16
// These passes are inherently interprocedural, and are required to keep the
17
// call graph up-to-date if they do anything which could modify it.
19
//===----------------------------------------------------------------------===//
21
#ifndef LLVM_CALL_GRAPH_SCC_PASS_H
22
#define LLVM_CALL_GRAPH_SCC_PASS_H
24
#include "llvm/Pass.h"
25
#include "llvm/Analysis/CallGraph.h"
33
struct CallGraphSCCPass : public Pass {
35
explicit CallGraphSCCPass(intptr_t pid) : Pass(PT_CallGraphSCC, pid) {}
36
explicit CallGraphSCCPass(void *pid) : Pass(PT_CallGraphSCC, pid) {}
38
/// doInitialization - This method is called before the SCC's of the program
39
/// has been processed, allowing the pass to do initialization as necessary.
40
virtual bool doInitialization(CallGraph &CG) {
44
/// runOnSCC - This method should be implemented by the subclass to perform
45
/// whatever action is necessary for the specified SCC. Note that
46
/// non-recursive (or only self-recursive) functions will have an SCC size of
47
/// 1, where recursive portions of the call graph will have SCC size > 1.
49
/// SCC passes that add or delete functions to the SCC are required to update
50
/// the SCC list, otherwise stale pointers may be dereferenced.
52
virtual bool runOnSCC(std::vector<CallGraphNode *> &SCC) = 0;
54
/// doFinalization - This method is called after the SCC's of the program has
55
/// been processed, allowing the pass to do final cleanup as necessary.
56
virtual bool doFinalization(CallGraph &CG) {
60
/// Assign pass manager to manager this pass
61
virtual void assignPassManager(PMStack &PMS,
62
PassManagerType PMT = PMT_CallGraphPassManager);
64
/// Return what kind of Pass Manager can manage this pass.
65
virtual PassManagerType getPotentialPassManagerType() const {
66
return PMT_CallGraphPassManager;
69
/// getAnalysisUsage - For this class, we declare that we require and preserve
70
/// the call graph. If the derived class implements this method, it should
71
/// always explicitly call the implementation here.
72
virtual void getAnalysisUsage(AnalysisUsage &Info) const;
75
} // End llvm namespace