2003-09-30 18:37:50 +00:00
|
|
|
//===- llvm/Pass.h - Base class for Passes ----------------------*- C++ -*-===//
|
2005-04-21 20:19:05 +00:00
|
|
|
//
|
2003-10-20 20:19:47 +00:00
|
|
|
// 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.
|
2005-04-21 20:19:05 +00:00
|
|
|
//
|
2003-10-20 20:19:47 +00:00
|
|
|
//===----------------------------------------------------------------------===//
|
2001-10-15 17:31:51 +00:00
|
|
|
//
|
2001-10-18 20:19:09 +00:00
|
|
|
// This file defines a base class that indicates that a specified class is a
|
2001-10-15 17:31:51 +00:00
|
|
|
// transformation pass implementation.
|
|
|
|
//
|
2005-03-16 03:54:50 +00:00
|
|
|
// Passes are designed this way so that it is possible to run passes in a cache
|
2002-01-21 07:31:00 +00:00
|
|
|
// and organizationally optimal order without having to specify it at the front
|
|
|
|
// end. This allows arbitrary passes to be strung together and have them
|
|
|
|
// executed as effeciently as possible.
|
2001-10-15 17:31:51 +00:00
|
|
|
//
|
2002-01-21 07:31:00 +00:00
|
|
|
// Passes should extend one of the classes below, depending on the guarantees
|
|
|
|
// that it can make about what will be modified as it is run. For example, most
|
2002-04-27 06:56:12 +00:00
|
|
|
// global optimizations should derive from FunctionPass, because they do not add
|
2002-04-28 20:46:05 +00:00
|
|
|
// or delete functions, they operate on the internals of the function.
|
2001-10-15 17:31:51 +00:00
|
|
|
//
|
2002-07-23 17:59:55 +00:00
|
|
|
// Note that this file #includes PassSupport.h and PassAnalysisSupport.h (at the
|
|
|
|
// bottom), so the APIs exposed by these files are also automatically available
|
|
|
|
// to all users of this file.
|
|
|
|
//
|
2001-10-15 17:31:51 +00:00
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
|
2001-10-18 20:19:09 +00:00
|
|
|
#ifndef LLVM_PASS_H
|
|
|
|
#define LLVM_PASS_H
|
2001-10-15 17:31:51 +00:00
|
|
|
|
2006-11-28 22:21:29 +00:00
|
|
|
#include "llvm/Support/Streams.h"
|
2002-01-30 23:20:39 +00:00
|
|
|
#include <vector>
|
2007-01-08 19:29:38 +00:00
|
|
|
#include <deque>
|
2002-01-30 23:20:39 +00:00
|
|
|
#include <map>
|
2002-07-27 01:12:17 +00:00
|
|
|
#include <iosfwd>
|
2003-07-25 17:58:41 +00:00
|
|
|
#include <cassert>
|
2003-11-11 22:41:34 +00:00
|
|
|
|
|
|
|
namespace llvm {
|
|
|
|
|
2002-01-30 23:20:39 +00:00
|
|
|
class Value;
|
2004-10-27 16:14:51 +00:00
|
|
|
class BasicBlock;
|
2002-03-23 22:51:58 +00:00
|
|
|
class Function;
|
2002-01-30 23:20:39 +00:00
|
|
|
class Module;
|
2002-04-27 06:56:12 +00:00
|
|
|
class AnalysisUsage;
|
2002-07-23 17:59:55 +00:00
|
|
|
class PassInfo;
|
2002-09-25 21:59:11 +00:00
|
|
|
class ImmutablePass;
|
2007-01-08 19:29:38 +00:00
|
|
|
class PMStack;
|
2007-01-05 22:47:07 +00:00
|
|
|
class AnalysisResolver;
|
2007-01-11 00:19:00 +00:00
|
|
|
class PMDataManager;
|
2002-01-21 07:31:00 +00:00
|
|
|
|
2002-07-27 01:12:17 +00:00
|
|
|
// AnalysisID - Use the PassInfo to identify a pass...
|
|
|
|
typedef const PassInfo* AnalysisID;
|
|
|
|
|
2007-01-17 20:30:17 +00:00
|
|
|
/// Different types of internal pass managers. External pass managers
|
|
|
|
/// (PassManager and FunctionPassManager) are not represented here.
|
|
|
|
/// Ordering of pass manager types is important here.
|
|
|
|
enum PassManagerType {
|
|
|
|
PMT_Unknown = 0,
|
|
|
|
PMT_ModulePassManager = 1, /// MPPassManager
|
|
|
|
PMT_CallGraphPassManager, /// CGPassManager
|
|
|
|
PMT_FunctionPassManager, /// FPPassManager
|
|
|
|
PMT_LoopPassManager, /// LPPassManager
|
2007-03-06 01:55:46 +00:00
|
|
|
PMT_BasicBlockPassManager, /// BBPassManager
|
|
|
|
PMT_Last
|
2007-01-17 20:30:17 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
typedef enum PassManagerType PassManagerType;
|
|
|
|
|
2001-10-15 17:31:51 +00:00
|
|
|
//===----------------------------------------------------------------------===//
|
2002-08-25 22:54:55 +00:00
|
|
|
/// Pass interface - Implemented by all 'passes'. Subclass this if you are an
|
|
|
|
/// interprocedural optimization or you do not fit into any of the more
|
|
|
|
/// constrained passes described below.
|
|
|
|
///
|
2002-01-30 23:20:39 +00:00
|
|
|
class Pass {
|
2007-01-05 22:47:07 +00:00
|
|
|
AnalysisResolver *Resolver; // Used to resolve analysis
|
2007-05-02 20:38:25 +00:00
|
|
|
intptr_t PassID;
|
2002-08-30 20:19:49 +00:00
|
|
|
|
|
|
|
// 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;
|
|
|
|
|
2002-07-29 21:01:19 +00:00
|
|
|
void operator=(const Pass&); // DO NOT IMPLEMENT
|
|
|
|
Pass(const Pass &); // DO NOT IMPLEMENT
|
2002-01-30 23:20:39 +00:00
|
|
|
public:
|
2007-05-11 21:04:48 +00:00
|
|
|
explicit Pass(intptr_t pid) : Resolver(0), PassID(pid) {}
|
2007-04-26 21:33:42 +00:00
|
|
|
virtual ~Pass();
|
2002-01-30 23:20:39 +00:00
|
|
|
|
2002-08-25 22:54:55 +00:00
|
|
|
/// 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
|
2003-10-10 17:42:19 +00:00
|
|
|
/// intelligible name for the pass.
|
2002-08-25 22:54:55 +00:00
|
|
|
///
|
2002-04-29 14:57:45 +00:00
|
|
|
virtual const char *getPassName() const;
|
2002-01-21 07:31:00 +00:00
|
|
|
|
2002-08-25 22:54:55 +00:00
|
|
|
/// getPassInfo - Return the PassInfo data structure that corresponds to this
|
|
|
|
/// pass... If the pass has not been registered, this will return null.
|
|
|
|
///
|
2002-07-23 17:59:55 +00:00
|
|
|
const PassInfo *getPassInfo() const;
|
|
|
|
|
2004-09-20 04:48:05 +00:00
|
|
|
/// runPass - Run this pass, returning true if a modification was made to the
|
2002-08-25 22:54:55 +00:00
|
|
|
/// module argument. This should be implemented by all concrete subclasses.
|
|
|
|
///
|
2004-12-07 08:11:11 +00:00
|
|
|
virtual bool runPass(Module &M) { return false; }
|
|
|
|
virtual bool runPass(BasicBlock&) { return false; }
|
2002-01-30 23:20:39 +00:00
|
|
|
|
2002-08-25 22:54:55 +00:00
|
|
|
/// 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
|
2003-08-18 14:43:39 +00:00
|
|
|
/// necessary to implement this method. Beware that the module pointer MAY be
|
2002-08-25 22:54:55 +00:00
|
|
|
/// null. This automatically forwards to a virtual function that does not
|
|
|
|
/// provide the Module* in case the analysis doesn't need it it can just be
|
|
|
|
/// ignored.
|
|
|
|
///
|
2004-12-07 04:03:45 +00:00
|
|
|
virtual void print(std::ostream &O, const Module *M) const;
|
2006-12-17 05:15:13 +00:00
|
|
|
void print(std::ostream *O, const Module *M) const { if (O) print(*O, M); }
|
2002-07-27 01:12:17 +00:00
|
|
|
void dump() const; // dump - call print(std::cerr, 0);
|
|
|
|
|
2007-03-06 01:06:16 +00:00
|
|
|
/// Each pass is responsible for assigning a pass manager to itself.
|
|
|
|
/// PMS is the stack of available pass manager.
|
2007-01-17 20:30:17 +00:00
|
|
|
virtual void assignPassManager(PMStack &PMS,
|
2007-04-16 18:10:23 +00:00
|
|
|
PassManagerType T = PMT_Unknown) {}
|
2007-03-06 01:06:16 +00:00
|
|
|
/// Check if available pass managers are suitable for this pass or not.
|
|
|
|
virtual void preparePassManager(PMStack &PMS) {}
|
2007-04-16 18:51:25 +00:00
|
|
|
|
|
|
|
/// Return what kind of Pass Manager can manage this pass.
|
|
|
|
virtual PassManagerType getPotentialPassManagerType() const {
|
|
|
|
return PMT_Unknown;
|
|
|
|
}
|
2007-03-06 01:06:16 +00:00
|
|
|
|
2007-01-05 22:47:07 +00:00
|
|
|
// Access AnalysisResolver
|
|
|
|
inline void setResolver(AnalysisResolver *AR) { Resolver = AR; }
|
|
|
|
inline AnalysisResolver *getResolver() { return Resolver; }
|
2002-07-27 01:12:17 +00:00
|
|
|
|
2002-08-25 22:54:55 +00:00
|
|
|
/// getAnalysisUsage - This function should be overriden by passes that need
|
|
|
|
/// analysis information to do their job. If a pass specifies that it uses a
|
|
|
|
/// particular analysis result to this function, it can then use the
|
|
|
|
/// getAnalysis<AnalysisType>() function, below.
|
|
|
|
///
|
2002-04-27 06:56:12 +00:00
|
|
|
virtual void getAnalysisUsage(AnalysisUsage &Info) const {
|
|
|
|
// By default, no analysis results are used, all are invalidated.
|
2002-01-30 23:20:39 +00:00
|
|
|
}
|
|
|
|
|
2002-08-25 22:54:55 +00:00
|
|
|
/// releaseMemory() - This member can be implemented by a pass if it wants to
|
|
|
|
/// be able to release its memory when it is no longer needed. The default
|
|
|
|
/// behavior of passes is to hold onto memory for the entire duration of their
|
|
|
|
/// lifetime (which is the entire compile time). For pipelined passes, this
|
|
|
|
/// is not a big deal because that memory gets recycled every time the pass is
|
|
|
|
/// invoked on another program unit. For IP passes, it is more important to
|
|
|
|
/// free memory when it is unused.
|
|
|
|
///
|
|
|
|
/// Optionally implement this function to release pass memory when it is no
|
|
|
|
/// longer used.
|
|
|
|
///
|
2002-01-31 18:32:27 +00:00
|
|
|
virtual void releaseMemory() {}
|
|
|
|
|
2002-01-30 23:20:39 +00:00
|
|
|
// dumpPassStructure - Implement the -debug-passes=PassStructure option
|
|
|
|
virtual void dumpPassStructure(unsigned Offset = 0);
|
|
|
|
|
2002-08-21 17:08:37 +00:00
|
|
|
template<typename AnalysisClass>
|
|
|
|
static const PassInfo *getClassPassInfo() {
|
2007-05-02 20:38:25 +00:00
|
|
|
return lookupPassInfo((intptr_t)&AnalysisClass::ID);
|
2002-08-21 17:08:37 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// lookupPassInfo - Return the pass info object for the specified pass class,
|
|
|
|
// or null if it is not known.
|
2007-05-02 20:38:25 +00:00
|
|
|
static const PassInfo *lookupPassInfo(intptr_t TI);
|
2002-08-21 17:08:37 +00:00
|
|
|
|
2002-09-06 02:14:47 +00:00
|
|
|
/// 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.
|
|
|
|
///
|
|
|
|
template<typename AnalysisType>
|
2003-08-29 14:26:51 +00:00
|
|
|
AnalysisType *getAnalysisToUpdate() const; // Defined in PassAnalysisSupport.h
|
2002-09-06 02:14:47 +00:00
|
|
|
|
2003-03-21 21:41:02 +00:00
|
|
|
/// mustPreserveAnalysisID - This method serves the same function as
|
|
|
|
/// getAnalysisToUpdate, 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.
|
|
|
|
///
|
|
|
|
bool mustPreserveAnalysisID(const PassInfo *AnalysisID) const;
|
|
|
|
|
2002-08-25 22:54:55 +00:00
|
|
|
/// getAnalysis<AnalysisType>() - This function is used by subclasses to get
|
|
|
|
/// to the analysis information that they claim to use by overriding the
|
|
|
|
/// getAnalysisUsage function.
|
|
|
|
///
|
2002-01-30 23:20:39 +00:00
|
|
|
template<typename AnalysisType>
|
2006-12-13 00:23:44 +00:00
|
|
|
AnalysisType &getAnalysis() const; // Defined in PassAnalysisSupport.h
|
2002-08-30 20:19:49 +00:00
|
|
|
|
2007-04-16 20:56:24 +00:00
|
|
|
template<typename AnalysisType>
|
|
|
|
AnalysisType &getAnalysis(Function &F); // Defined in PassanalysisSupport.h
|
|
|
|
|
2002-08-30 20:19:49 +00:00
|
|
|
template<typename AnalysisType>
|
2006-12-13 00:23:44 +00:00
|
|
|
AnalysisType &getAnalysisID(const PassInfo *PI) const;
|
2007-04-16 18:51:25 +00:00
|
|
|
|
2007-04-16 20:56:24 +00:00
|
|
|
template<typename AnalysisType>
|
|
|
|
AnalysisType &getAnalysisID(const PassInfo *PI, Function &F);
|
2002-01-21 07:31:00 +00:00
|
|
|
};
|
|
|
|
|
2002-07-27 01:12:17 +00:00
|
|
|
inline std::ostream &operator<<(std::ostream &OS, const Pass &P) {
|
|
|
|
P.print(OS, 0); return OS;
|
|
|
|
}
|
2002-01-21 07:31:00 +00:00
|
|
|
|
2004-09-20 04:48:05 +00:00
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
/// ModulePass class - This class is used to implement unstructured
|
2005-03-16 03:54:50 +00:00
|
|
|
/// interprocedural optimizations and analyses. ModulePasses may do anything
|
2004-09-20 04:48:05 +00:00
|
|
|
/// they want to the program.
|
|
|
|
///
|
2004-10-27 16:14:51 +00:00
|
|
|
class ModulePass : public Pass {
|
|
|
|
public:
|
2004-09-20 04:48:05 +00:00
|
|
|
/// runOnModule - Virtual method overriden by subclasses to process the module
|
|
|
|
/// being operated on.
|
|
|
|
virtual bool runOnModule(Module &M) = 0;
|
|
|
|
|
2004-12-07 08:11:11 +00:00
|
|
|
virtual bool runPass(Module &M) { return runOnModule(M); }
|
|
|
|
virtual bool runPass(BasicBlock&) { return false; }
|
2004-09-20 04:48:05 +00:00
|
|
|
|
2007-01-17 20:30:17 +00:00
|
|
|
virtual void assignPassManager(PMStack &PMS,
|
2007-04-16 18:10:23 +00:00
|
|
|
PassManagerType T = PMT_ModulePassManager);
|
2007-04-16 18:51:25 +00:00
|
|
|
|
|
|
|
/// Return what kind of Pass Manager can manage this pass.
|
|
|
|
virtual PassManagerType getPotentialPassManagerType() const {
|
|
|
|
return PMT_ModulePassManager;
|
|
|
|
}
|
|
|
|
|
2007-05-11 21:04:48 +00:00
|
|
|
explicit ModulePass(intptr_t pid) : Pass(pid) {}
|
2006-12-22 22:49:00 +00:00
|
|
|
// Force out-of-line virtual method.
|
|
|
|
virtual ~ModulePass();
|
2004-09-20 04:48:05 +00:00
|
|
|
};
|
2002-09-25 21:59:11 +00:00
|
|
|
|
|
|
|
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
/// ImmutablePass class - This class is used to provide information that does
|
|
|
|
/// not need to be run. This is useful for things like target information and
|
|
|
|
/// "basic" versions of AnalysisGroups.
|
|
|
|
///
|
2004-10-27 16:14:51 +00:00
|
|
|
class ImmutablePass : public ModulePass {
|
|
|
|
public:
|
2003-02-26 19:10:28 +00:00
|
|
|
/// initializePass - This method may be overriden by immutable passes to allow
|
|
|
|
/// them to perform various initialization actions they require. This is
|
|
|
|
/// primarily because an ImmutablePass can "require" another ImmutablePass,
|
|
|
|
/// and if it does, the overloaded version of initializePass may get access to
|
|
|
|
/// these passes with getAnalysis<>.
|
|
|
|
///
|
|
|
|
virtual void initializePass() {}
|
2002-09-25 21:59:11 +00:00
|
|
|
|
2003-02-26 19:10:28 +00:00
|
|
|
/// ImmutablePasses are never run.
|
|
|
|
///
|
2004-09-20 04:48:05 +00:00
|
|
|
virtual bool runOnModule(Module &M) { return false; }
|
2002-09-25 21:59:11 +00:00
|
|
|
|
2007-05-11 21:04:48 +00:00
|
|
|
explicit ImmutablePass(intptr_t pid) : ModulePass(pid) {}
|
2006-12-22 22:49:00 +00:00
|
|
|
// Force out-of-line virtual method.
|
|
|
|
virtual ~ImmutablePass();
|
2002-09-25 21:59:11 +00:00
|
|
|
};
|
|
|
|
|
2002-01-21 07:31:00 +00:00
|
|
|
//===----------------------------------------------------------------------===//
|
2002-08-25 22:54:55 +00:00
|
|
|
/// FunctionPass class - This class is used to implement most global
|
|
|
|
/// optimizations. Optimizations should subclass this class if they meet the
|
|
|
|
/// following constraints:
|
|
|
|
///
|
2003-05-03 03:31:06 +00:00
|
|
|
/// 1. Optimizations are organized globally, i.e., a function at a time
|
2002-08-25 22:54:55 +00:00
|
|
|
/// 2. Optimizing a function does not cause the addition or removal of any
|
|
|
|
/// functions in the module
|
|
|
|
///
|
2007-01-26 00:23:00 +00:00
|
|
|
class FunctionPass : public Pass {
|
2004-10-27 16:14:51 +00:00
|
|
|
public:
|
2007-05-11 21:04:48 +00:00
|
|
|
explicit FunctionPass(intptr_t pid) : Pass(pid) {}
|
2007-05-02 20:38:25 +00:00
|
|
|
|
2002-08-25 22:54:55 +00:00
|
|
|
/// doInitialization - Virtual method overridden by subclasses to do
|
2003-08-18 14:43:39 +00:00
|
|
|
/// any necessary per-module initialization.
|
2002-08-25 22:54:55 +00:00
|
|
|
///
|
2002-06-25 16:12:52 +00:00
|
|
|
virtual bool doInitialization(Module &M) { return false; }
|
2001-10-15 17:31:51 +00:00
|
|
|
|
2002-08-25 22:54:55 +00:00
|
|
|
/// runOnFunction - Virtual method overriden by subclasses to do the
|
|
|
|
/// per-function processing of the pass.
|
|
|
|
///
|
2002-06-25 16:12:52 +00:00
|
|
|
virtual bool runOnFunction(Function &F) = 0;
|
2001-10-15 17:31:51 +00:00
|
|
|
|
2002-08-25 22:54:55 +00:00
|
|
|
/// doFinalization - Virtual method overriden by subclasses to do any post
|
|
|
|
/// processing needed after all passes have run.
|
|
|
|
///
|
2002-06-25 16:12:52 +00:00
|
|
|
virtual bool doFinalization(Module &M) { return false; }
|
2001-10-15 17:31:51 +00:00
|
|
|
|
2004-09-20 04:48:05 +00:00
|
|
|
/// runOnModule - On a module, we run this pass by initializing,
|
|
|
|
/// ronOnFunction'ing once for every function in the module, then by
|
|
|
|
/// finalizing.
|
2002-08-25 22:54:55 +00:00
|
|
|
///
|
2004-09-20 04:48:05 +00:00
|
|
|
virtual bool runOnModule(Module &M);
|
2001-10-15 17:31:51 +00:00
|
|
|
|
2002-08-25 22:54:55 +00:00
|
|
|
/// run - On a function, we simply initialize, run the function, then
|
|
|
|
/// finalize.
|
|
|
|
///
|
2002-06-25 16:12:52 +00:00
|
|
|
bool run(Function &F);
|
2002-01-30 23:20:39 +00:00
|
|
|
|
2007-01-17 20:30:17 +00:00
|
|
|
virtual void assignPassManager(PMStack &PMS,
|
2007-04-16 18:10:23 +00:00
|
|
|
PassManagerType T = PMT_FunctionPassManager);
|
2007-04-16 18:51:25 +00:00
|
|
|
|
|
|
|
/// Return what kind of Pass Manager can manage this pass.
|
|
|
|
virtual PassManagerType getPotentialPassManagerType() const {
|
|
|
|
return PMT_FunctionPassManager;
|
|
|
|
}
|
2002-01-21 07:31:00 +00:00
|
|
|
};
|
2001-10-15 17:31:51 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
2002-01-21 07:31:00 +00:00
|
|
|
//===----------------------------------------------------------------------===//
|
2002-08-25 22:54:55 +00:00
|
|
|
/// BasicBlockPass class - This class is used to implement most local
|
|
|
|
/// optimizations. Optimizations should subclass this class if they
|
|
|
|
/// meet the following constraints:
|
|
|
|
/// 1. Optimizations are local, operating on either a basic block or
|
|
|
|
/// instruction at a time.
|
|
|
|
/// 2. Optimizations do not modify the CFG of the contained function, or any
|
|
|
|
/// other basic block in the function.
|
2005-03-16 03:54:50 +00:00
|
|
|
/// 3. Optimizations conform to all of the constraints of FunctionPasses.
|
2002-08-25 22:54:55 +00:00
|
|
|
///
|
2007-01-25 23:23:25 +00:00
|
|
|
class BasicBlockPass : public Pass {
|
2006-01-04 17:21:23 +00:00
|
|
|
public:
|
2007-05-11 21:04:48 +00:00
|
|
|
explicit BasicBlockPass(intptr_t pid) : Pass(pid) {}
|
2007-05-02 20:38:25 +00:00
|
|
|
|
2002-09-12 17:06:43 +00:00
|
|
|
/// doInitialization - Virtual method overridden by subclasses to do
|
2003-08-18 14:43:39 +00:00
|
|
|
/// any necessary per-module initialization.
|
2002-09-12 17:06:43 +00:00
|
|
|
///
|
|
|
|
virtual bool doInitialization(Module &M) { return false; }
|
|
|
|
|
|
|
|
/// doInitialization - Virtual method overridden by BasicBlockPass subclasses
|
2003-08-18 14:43:39 +00:00
|
|
|
/// to do any necessary per-function initialization.
|
2002-09-12 17:06:43 +00:00
|
|
|
///
|
|
|
|
virtual bool doInitialization(Function &F) { return false; }
|
|
|
|
|
2002-08-25 22:54:55 +00:00
|
|
|
/// runOnBasicBlock - Virtual method overriden by subclasses to do the
|
|
|
|
/// per-basicblock processing of the pass.
|
|
|
|
///
|
2002-06-25 16:12:52 +00:00
|
|
|
virtual bool runOnBasicBlock(BasicBlock &BB) = 0;
|
2001-10-15 17:31:51 +00:00
|
|
|
|
2002-09-12 17:06:43 +00:00
|
|
|
/// doFinalization - Virtual method overriden by BasicBlockPass subclasses to
|
|
|
|
/// do any post processing needed after all passes have run.
|
2002-08-25 22:54:55 +00:00
|
|
|
///
|
2002-09-12 17:06:43 +00:00
|
|
|
virtual bool doFinalization(Function &F) { 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; }
|
|
|
|
|
|
|
|
|
|
|
|
// To run this pass on a function, we simply call runOnBasicBlock once for
|
|
|
|
// each function.
|
|
|
|
//
|
|
|
|
bool runOnFunction(Function &F);
|
2002-01-21 07:31:00 +00:00
|
|
|
|
2002-08-25 22:54:55 +00:00
|
|
|
/// To run directly on the basic block, we initialize, runOnBasicBlock, then
|
|
|
|
/// finalize.
|
|
|
|
///
|
2004-12-07 08:11:11 +00:00
|
|
|
virtual bool runPass(Module &M) { return false; }
|
|
|
|
virtual bool runPass(BasicBlock &BB);
|
2002-01-30 23:20:39 +00:00
|
|
|
|
2007-01-17 20:30:17 +00:00
|
|
|
virtual void assignPassManager(PMStack &PMS,
|
2007-04-16 18:10:23 +00:00
|
|
|
PassManagerType T = PMT_BasicBlockPassManager);
|
2007-04-16 18:51:25 +00:00
|
|
|
|
|
|
|
/// Return what kind of Pass Manager can manage this pass.
|
|
|
|
virtual PassManagerType getPotentialPassManagerType() const {
|
|
|
|
return PMT_BasicBlockPassManager;
|
|
|
|
}
|
2007-01-11 01:10:25 +00:00
|
|
|
};
|
|
|
|
|
2007-01-08 19:29:38 +00:00
|
|
|
/// PMStack
|
|
|
|
/// Top level pass manager (see PasManager.cpp) maintains active Pass Managers
|
2007-01-16 21:43:18 +00:00
|
|
|
/// using PMStack. Each Pass implements assignPassManager() to connect itself
|
|
|
|
/// with appropriate manager. assignPassManager() walks PMStack to find
|
2007-01-08 19:29:38 +00:00
|
|
|
/// 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(); }
|
2007-01-11 00:19:00 +00:00
|
|
|
void push(Pass *P);
|
2007-01-08 19:29:38 +00:00
|
|
|
inline bool empty() { return S.empty(); }
|
|
|
|
|
2007-01-11 00:19:00 +00:00
|
|
|
void dump();
|
2007-01-08 19:29:38 +00:00
|
|
|
private:
|
|
|
|
std::deque<PMDataManager *> S;
|
2002-01-21 07:31:00 +00:00
|
|
|
};
|
|
|
|
|
2007-01-08 19:29:38 +00:00
|
|
|
|
2004-08-24 17:52:35 +00:00
|
|
|
/// 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.
|
|
|
|
extern bool TimePassesIsEnabled;
|
|
|
|
|
2003-11-11 22:41:34 +00:00
|
|
|
} // End llvm namespace
|
|
|
|
|
2002-07-23 17:59:55 +00:00
|
|
|
// Include support files that contain important APIs commonly used by Passes,
|
2003-05-03 03:31:06 +00:00
|
|
|
// but that we want to separate out to make it easier to read the header files.
|
2002-04-27 06:56:12 +00:00
|
|
|
//
|
2002-07-23 17:59:55 +00:00
|
|
|
#include "llvm/PassSupport.h"
|
|
|
|
#include "llvm/PassAnalysisSupport.h"
|
2002-01-30 23:20:39 +00:00
|
|
|
|
2001-10-15 17:31:51 +00:00
|
|
|
#endif
|