//
// The LLVM Compiler Infrastructure
//
-// This file was developed by the LLVM research group and is distributed under
-// the University of Illinois Open Source License. See LICENSE.TXT for details.
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
//
#ifndef LLVM_PASS_H
#define LLVM_PASS_H
-#include "llvm/Support/Streams.h"
-#include <vector>
-#include <deque>
-#include <map>
-#include <iosfwd>
+#include "llvm/System/DataTypes.h"
#include <cassert>
+#include <utility>
+#include <vector>
namespace llvm {
-class Value;
class BasicBlock;
class Function;
class Module;
class PMStack;
class AnalysisResolver;
class PMDataManager;
+class raw_ostream;
+class StringRef;
// AnalysisID - Use the PassInfo to identify a pass...
typedef const PassInfo* AnalysisID;
PMT_Last
};
-typedef enum PassManagerType PassManagerType;
-
//===----------------------------------------------------------------------===//
/// Pass interface - Implemented by all 'passes'. Subclass this if you are an
/// interprocedural optimization or you do not fit into any of the more
AnalysisResolver *Resolver; // Used to resolve analysis
intptr_t PassID;
- // AnalysisImpls - This keeps track of which passes implement the interfaces
- // that are required by the current pass (to implement getAnalysis()).
- //
- std::vector<std::pair<const PassInfo*, Pass*> > AnalysisImpls;
-
void operator=(const Pass&); // DO NOT IMPLEMENT
Pass(const Pass &); // DO NOT IMPLEMENT
+
public:
- explicit Pass(intptr_t pid) : Resolver(0), PassID(pid) {}
+ explicit Pass(intptr_t pid) : Resolver(0), PassID(pid) {
+ assert(pid && "pid cannot be 0");
+ }
+ explicit Pass(const void *pid) : Resolver(0), PassID((intptr_t)pid) {
+ assert(pid && "pid cannot be 0");
+ }
virtual ~Pass();
/// getPassName - Return a nice clean name for a pass. This usually
/// implemented in terms of the name that is registered by one of the
- /// Registration templates, but can be overloaded directly, and if nothing
- /// else is available, C++ RTTI will be consulted to get a SOMEWHAT
- /// intelligible name for the pass.
+ /// Registration templates, but can be overloaded directly.
///
virtual const char *getPassName() const;
///
const PassInfo *getPassInfo() const;
- /// runPass - Run this pass, returning true if a modification was made to the
- /// module argument. This should be implemented by all concrete subclasses.
- ///
- virtual bool runPass(Module &M) { return false; }
- virtual bool runPass(BasicBlock&) { return false; }
-
/// print - Print out the internal state of the pass. This is called by
/// Analyze to print out the contents of an analysis. Otherwise it is not
/// necessary to implement this method. Beware that the module pointer MAY be
/// provide the Module* in case the analysis doesn't need it it can just be
/// ignored.
///
- virtual void print(std::ostream &O, const Module *M) const;
- void print(std::ostream *O, const Module *M) const { if (O) print(*O, M); }
- void dump() const; // dump - call print(std::cerr, 0);
+ virtual void print(raw_ostream &O, const Module *M) const;
+ void dump() const; // dump - Print to stderr.
/// Each pass is responsible for assigning a pass manager to itself.
/// PMS is the stack of available pass manager.
- virtual void assignPassManager(PMStack &PMS,
- PassManagerType T = PMT_Unknown) {}
+ virtual void assignPassManager(PMStack &,
+ PassManagerType = PMT_Unknown) {}
/// Check if available pass managers are suitable for this pass or not.
- virtual void preparePassManager(PMStack &PMS) {}
+ virtual void preparePassManager(PMStack &) {}
/// Return what kind of Pass Manager can manage this pass.
virtual PassManagerType getPotentialPassManagerType() const {
Resolver = AR;
}
inline AnalysisResolver *getResolver() {
- assert (Resolver && "Resolver is not set");
return Resolver;
}
/// particular analysis result to this function, it can then use the
/// getAnalysis<AnalysisType>() function, below.
///
- virtual void getAnalysisUsage(AnalysisUsage &Info) const {
+ virtual void getAnalysisUsage(AnalysisUsage &) const {
// By default, no analysis results are used, all are invalidated.
}
// or null if it is not known.
static const PassInfo *lookupPassInfo(intptr_t TI);
- /// getAnalysisToUpdate<AnalysisType>() - This function is used by subclasses
- /// to get to the analysis information that might be around that needs to be
- /// updated. This is different than getAnalysis in that it can fail (ie the
- /// analysis results haven't been computed), so should only be used if you
- /// provide the capability to update an analysis that exists. This method is
- /// often used by transformation APIs to update analysis results for a pass
- /// automatically as the transform is performed.
+ // lookupPassInfo - Return the pass info object for the pass with the given
+ // argument string, or null if it is not known.
+ static const PassInfo *lookupPassInfo(const StringRef &Arg);
+
+ /// getAnalysisIfAvailable<AnalysisType>() - Subclasses use this function to
+ /// get analysis information that might be around, for example to update it.
+ /// This is different than getAnalysis in that it can fail (if the analysis
+ /// results haven't been computed), so should only be used if you can handle
+ /// the case when the analysis is not available. This method is often used by
+ /// transformation APIs to update analysis results for a pass automatically as
+ /// the transform is performed.
///
- template<typename AnalysisType>
- AnalysisType *getAnalysisToUpdate() const; // Defined in PassAnalysisSupport.h
+ template<typename AnalysisType> AnalysisType *
+ getAnalysisIfAvailable() const; // Defined in PassAnalysisSupport.h
/// mustPreserveAnalysisID - This method serves the same function as
- /// getAnalysisToUpdate, but works if you just have an AnalysisID. This
+ /// getAnalysisIfAvailable, but works if you just have an AnalysisID. This
/// obviously cannot give you a properly typed instance of the class if you
- /// don't have the class name available (use getAnalysisToUpdate if you do),
- /// but it can tell you if you need to preserve the pass at least.
+ /// don't have the class name available (use getAnalysisIfAvailable if you
+ /// do), but it can tell you if you need to preserve the pass at least.
///
bool mustPreserveAnalysisID(const PassInfo *AnalysisID) const;
AnalysisType &getAnalysis() const; // Defined in PassAnalysisSupport.h
template<typename AnalysisType>
- AnalysisType &getAnalysis(Function &F); // Defined in PassanalysisSupport.h
+ AnalysisType &getAnalysis(Function &F); // Defined in PassAnalysisSupport.h
template<typename AnalysisType>
AnalysisType &getAnalysisID(const PassInfo *PI) const;
AnalysisType &getAnalysisID(const PassInfo *PI, Function &F);
};
-inline std::ostream &operator<<(std::ostream &OS, const Pass &P) {
- P.print(OS, 0); return OS;
-}
//===----------------------------------------------------------------------===//
/// ModulePass class - This class is used to implement unstructured
/// being operated on.
virtual bool runOnModule(Module &M) = 0;
- virtual bool runPass(Module &M) { return runOnModule(M); }
- virtual bool runPass(BasicBlock&) { return false; }
-
virtual void assignPassManager(PMStack &PMS,
PassManagerType T = PMT_ModulePassManager);
}
explicit ModulePass(intptr_t pid) : Pass(pid) {}
+ explicit ModulePass(const void *pid) : Pass(pid) {}
// Force out-of-line virtual method.
virtual ~ModulePass();
};
/// ImmutablePasses are never run.
///
- bool runOnModule(Module &M) { return false; }
+ bool runOnModule(Module &) { return false; }
explicit ImmutablePass(intptr_t pid) : ModulePass(pid) {}
+ explicit ImmutablePass(const void *pid)
+ : ModulePass(pid) {}
+
// Force out-of-line virtual method.
virtual ~ImmutablePass();
};
class FunctionPass : public Pass {
public:
explicit FunctionPass(intptr_t pid) : Pass(pid) {}
+ explicit FunctionPass(const void *pid) : Pass(pid) {}
/// doInitialization - Virtual method overridden by subclasses to do
/// any necessary per-module initialization.
///
- virtual bool doInitialization(Module &M) { return false; }
-
+ virtual bool doInitialization(Module &) { return false; }
+
/// runOnFunction - Virtual method overriden by subclasses to do the
/// per-function processing of the pass.
///
/// doFinalization - Virtual method overriden by subclasses to do any post
/// processing needed after all passes have run.
///
- virtual bool doFinalization(Module &M) { return false; }
+ virtual bool doFinalization(Module &) { return false; }
/// runOnModule - On a module, we run this pass by initializing,
/// ronOnFunction'ing once for every function in the module, then by
class BasicBlockPass : public Pass {
public:
explicit BasicBlockPass(intptr_t pid) : Pass(pid) {}
+ explicit BasicBlockPass(const void *pid) : Pass(pid) {}
/// doInitialization - Virtual method overridden by subclasses to do
/// any necessary per-module initialization.
///
- virtual bool doInitialization(Module &M) { return false; }
+ virtual bool doInitialization(Module &) { return false; }
/// doInitialization - Virtual method overridden by BasicBlockPass subclasses
/// to do any necessary per-function initialization.
///
- virtual bool doInitialization(Function &F) { return false; }
+ virtual bool doInitialization(Function &) { return false; }
/// runOnBasicBlock - Virtual method overriden by subclasses to do the
/// per-basicblock processing of the pass.
/// doFinalization - Virtual method overriden by BasicBlockPass subclasses to
/// do any post processing needed after all passes have run.
///
- virtual bool doFinalization(Function &F) { return false; }
+ virtual bool doFinalization(Function &) { return false; }
/// doFinalization - Virtual method overriden by subclasses to do any post
/// processing needed after all passes have run.
///
- virtual bool doFinalization(Module &M) { return false; }
+ virtual bool doFinalization(Module &) { return false; }
// To run this pass on a function, we simply call runOnBasicBlock once for
//
bool runOnFunction(Function &F);
- /// To run directly on the basic block, we initialize, runOnBasicBlock, then
- /// finalize.
- ///
- virtual bool runPass(Module &M) { return false; }
- virtual bool runPass(BasicBlock &BB);
-
virtual void assignPassManager(PMStack &PMS,
PassManagerType T = PMT_BasicBlockPassManager);
}
};
-/// PMStack
-/// Top level pass manager (see PasManager.cpp) maintains active Pass Managers
-/// using PMStack. Each Pass implements assignPassManager() to connect itself
-/// with appropriate manager. assignPassManager() walks PMStack to find
-/// suitable manager.
-///
-/// PMStack is just a wrapper around standard deque that overrides pop() and
-/// push() methods.
-class PMStack {
-public:
- typedef std::deque<PMDataManager *>::reverse_iterator iterator;
- iterator begin() { return S.rbegin(); }
- iterator end() { return S.rend(); }
-
- void handleLastUserOverflow();
-
- void pop();
- inline PMDataManager *top() { return S.back(); }
- void push(Pass *P);
- inline bool empty() { return S.empty(); }
-
- void dump();
-private:
- std::deque<PMDataManager *> S;
-};
-
-
/// If the user specifies the -time-passes argument on an LLVM tool command line
/// then the value of this boolean will be true, otherwise false.
/// @brief This is the storage for the -time-passes option.
projects / oota-llvm.git / blobdiff