//===- llvm/PassSupport.h - Pass Support code -------------------*- C++ -*-===//
//
+// The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+//
// This file defines stuff that is used to define and "use" Passes. This file
// is automatically #included by Pass.h, so:
//
// No need to include Pass.h, we are being included by it!
-class TargetData;
+namespace llvm {
+
class TargetMachine;
//===---------------------------------------------------------------------------
class PassInfo {
const char *PassName; // Nice name for Pass
const char *PassArgument; // Command Line argument to run this pass
- const std::type_info &TypeInfo; // type_info object for this Pass class
- unsigned char PassType; // Set of enums values below...
+ intptr_t PassID;
+ bool IsCFGOnlyPass; // Pass only looks at the CFG.
+ bool IsAnalysis; // True if an analysis pass.
+ bool IsAnalysisGroup; // True if an analysis group.
std::vector<const PassInfo*> ItfImpl;// Interfaces implemented by this pass
- Pass *(*NormalCtor)(); // No argument ctor
- Pass *(*DataCtor)(const TargetData&);// Ctor taking TargetData object...
+ Pass *(*NormalCtor)();
public:
- /// PassType - Define symbolic constants that can be used to test to see if
- /// this pass should be listed by analyze or opt. Passes can use none, one or
- /// many of these flags or'd together. It is not legal to combine the
- /// AnalysisGroup flag with others.
- ///
- enum {
- Analysis = 1, Optimization = 2, LLC = 4, AnalysisGroup = 8
- };
-
/// PassInfo ctor - Do not call this directly, this should only be invoked
/// through RegisterPass.
- PassInfo(const char *name, const char *arg, const std::type_info &ti,
- unsigned pt, Pass *(*normal)(), Pass *(*data)(const TargetData &))
- : PassName(name), PassArgument(arg), TypeInfo(ti), PassType(pt),
- NormalCtor(normal), DataCtor(data) {
+ PassInfo(const char *name, const char *arg, intptr_t pi,
+ Pass *(*normal)() = 0, bool isCFGOnly = false, bool isAnalysis = false)
+ : PassName(name), PassArgument(arg), PassID(pi),
+ IsCFGOnlyPass(isCFGOnly),
+ IsAnalysis(isAnalysis), IsAnalysisGroup(false), NormalCtor(normal) {
}
/// getPassName - Return the friendly name for the pass, never returns null
///
const char *getPassArgument() const { return PassArgument; }
- /// getTypeInfo - Return the type_info object for the pass...
- ///
- const std::type_info &getTypeInfo() const { return TypeInfo; }
+ /// getTypeInfo - Return the id object for the pass...
+ /// TODO : Rename
+ intptr_t getTypeInfo() const { return PassID; }
- /// getPassType - Return the PassType of a pass. Note that this can be
- /// several different types or'd together. This is _strictly_ for use by opt,
- /// analyze and llc for deciding which passes to use as command line options.
+ /// isAnalysisGroup - Return true if this is an analysis group, not a normal
+ /// pass.
///
- unsigned getPassType() const { return PassType; }
+ bool isAnalysisGroup() const { return IsAnalysisGroup; }
+ bool isAnalysis() const { return IsAnalysis; }
+ void SetIsAnalysisGroup() { IsAnalysisGroup = true; }
+ /// isCFGOnlyPass - return true if this pass only looks at the CFG for the
+ /// function.
+ bool isCFGOnlyPass() const { return IsCFGOnlyPass; }
+
/// getNormalCtor - Return a pointer to a function, that when called, creates
/// an instance of the pass and returns it. This pointer may be null if there
/// is no default constructor for the pass.
- ///
+ ///
Pass *(*getNormalCtor() const)() {
return NormalCtor;
}
/// createPass() - Use this method to create an instance of this pass.
Pass *createPass() const {
- assert((PassType != AnalysisGroup || NormalCtor) &&
+ assert((!isAnalysisGroup() || NormalCtor) &&
"No default implementation found for analysis group!");
assert(NormalCtor &&
"Cannot call createPass on PassInfo without default ctor!");
return NormalCtor();
}
- /// getDataCtor - Return a pointer to a function that creates an instance of
- /// the pass and returns it. This returns a constructor for a version of the
- /// pass that takes a TArgetData object as a parameter.
- ///
- Pass *(*getDataCtor() const)(const TargetData &) {
- return DataCtor;
- }
-
/// addInterfaceImplemented - This method is called when this pass is
/// registered as a member of an analysis group with the RegisterAnalysisGroup
/// template.
/// for example will not be able to see the pass and attempts to create the pass
/// will fail. This template is used in the follow manner (at global scope, in
/// your .cpp file):
-///
+///
/// static RegisterPass<YourPassClassName> tmp("passopt", "My Pass Name");
///
/// This statement will cause your pass to be created by calling the default
/// must be called, create a global constructor function (which takes the
/// arguments you need and returns a Pass*) and register your pass like this:
///
-/// Pass *createMyPass(foo &opt) { return new MyPass(opt); }
-/// static RegisterPass<PassClassName> tmp("passopt", "My Name", createMyPass);
-///
+/// static RegisterPass<PassClassName> tmp("passopt", "My Name");
+///
struct RegisterPassBase {
/// getPassInfo - Get the pass info for the registered class...
///
- const PassInfo *getPassInfo() const { return PIObj; }
+ const PassInfo *getPassInfo() const { return &PIObj; }
- RegisterPassBase() : PIObj(0) {}
- ~RegisterPassBase() { // Intentionally non-virtual...
- if (PIObj) unregisterPass(PIObj);
+ typedef Pass* (*NormalCtor_t)();
+
+ RegisterPassBase(const char *Name, const char *Arg, intptr_t TI,
+ NormalCtor_t NormalCtor = 0, bool CFGOnly = false,
+ bool IsAnalysis = false)
+ : PIObj(Name, Arg, TI, NormalCtor, CFGOnly, IsAnalysis) {
+ registerPass();
+ }
+ explicit RegisterPassBase(intptr_t TI)
+ : PIObj("", "", TI) {
+ // This ctor may only be used for analysis groups: it does not auto-register
+ // the pass.
+ PIObj.SetIsAnalysisGroup();
}
protected:
- PassInfo *PIObj; // The PassInfo object for this pass
- void registerPass(PassInfo *);
- void unregisterPass(PassInfo *);
-
- /// setPreservesCFG - Notice that this pass only depends on the CFG, so
- /// transformations that do not modify the CFG do not invalidate this pass.
- ///
- void setPreservesCFG();
+ PassInfo PIObj; // The PassInfo object for this pass
+ void registerPass();
+ void unregisterPass();
};
template<typename PassName>
template<typename PassName>
struct RegisterPass : public RegisterPassBase {
-
- // Register Pass using default constructor...
- RegisterPass(const char *PassArg, const char *Name, unsigned PassTy = 0) {
- registerPass(new PassInfo(Name, PassArg, typeid(PassName), PassTy,
- callDefaultCtor<PassName>, 0));
- }
-
- // Register Pass using default constructor explicitly...
- RegisterPass(const char *PassArg, const char *Name, unsigned PassTy,
- Pass *(*ctor)()) {
- registerPass(new PassInfo(Name, PassArg, typeid(PassName), PassTy, ctor,0));
- }
-
- // Register Pass using TargetData constructor...
- RegisterPass(const char *PassArg, const char *Name, unsigned PassTy,
- Pass *(*datactor)(const TargetData &)) {
- registerPass(new PassInfo(Name, PassArg, typeid(PassName), PassTy,
- 0, datactor));
- }
-
- // Generic constructor version that has an unknown ctor type...
- template<typename CtorType>
- RegisterPass(const char *PassArg, const char *Name, unsigned PassTy,
- CtorType *Fn) {
- registerPass(new PassInfo(Name, PassArg, typeid(PassName), PassTy, 0, 0));
- }
-};
-
-/// RegisterOpt - Register something that is to show up in Opt, this is just a
-/// shortcut for specifying RegisterPass...
-///
-template<typename PassName>
-struct RegisterOpt : public RegisterPassBase {
- RegisterOpt(const char *PassArg, const char *Name) {
- registerPass(new PassInfo(Name, PassArg, typeid(PassName),
- PassInfo::Optimization,
- callDefaultCtor<PassName>, 0));
- }
- /// Register Pass using default constructor explicitly...
- ///
- RegisterOpt(const char *PassArg, const char *Name, Pass *(*ctor)()) {
- registerPass(new PassInfo(Name, PassArg, typeid(PassName),
- PassInfo::Optimization, ctor, 0));
- }
-
- /// Register Pass using TargetData constructor...
- ///
- RegisterOpt(const char *PassArg, const char *Name,
- Pass *(*datactor)(const TargetData &)) {
- registerPass(new PassInfo(Name, PassArg, typeid(PassName),
- PassInfo::Optimization, 0, datactor));
- }
-};
-
-/// RegisterAnalysis - Register something that is to show up in Analysis, this
-/// is just a shortcut for specifying RegisterPass... Analyses take a special
-/// argument that, when set to true, tells the system that the analysis ONLY
-/// depends on the shape of the CFG, so if a transformation preserves the CFG
-/// that the analysis is not invalidated.
-///
-template<typename PassName>
-struct RegisterAnalysis : public RegisterPassBase {
- RegisterAnalysis(const char *PassArg, const char *Name,
- bool CFGOnly = false) {
- registerPass(new PassInfo(Name, PassArg, typeid(PassName),
- PassInfo::Analysis,
- callDefaultCtor<PassName>, 0));
- if (CFGOnly)
- setPreservesCFG();
- }
-};
-
-/// RegisterLLC - Register something that is to show up in LLC, this is just a
-/// shortcut for specifying RegisterPass...
-///
-template<typename PassName>
-struct RegisterLLC : public RegisterPassBase {
- RegisterLLC(const char *PassArg, const char *Name) {
- registerPass(new PassInfo(Name, PassArg, typeid(PassName),
- PassInfo::LLC,
- callDefaultCtor<PassName>, 0));
- }
-
- /// Register Pass using default constructor explicitly...
- ///
- RegisterLLC(const char *PassArg, const char *Name, Pass *(*ctor)()) {
- registerPass(new PassInfo(Name, PassArg, typeid(PassName),
- PassInfo::LLC, ctor, 0));
- }
-
- /// Register Pass using TargetData constructor...
- ///
- RegisterLLC(const char *PassArg, const char *Name,
- Pass *(*datactor)(const TargetData &)) {
- registerPass(new PassInfo(Name, PassArg, typeid(PassName),
- PassInfo::LLC, 0, datactor));
- }
-
- /// Register Pass using TargetMachine constructor...
- ///
- RegisterLLC(const char *PassArg, const char *Name,
- Pass *(*datactor)(TargetMachine &)) {
- registerPass(new PassInfo(Name, PassArg, typeid(PassName),
- PassInfo::LLC, 0, 0));
+ // Register Pass using default constructor...
+ RegisterPass(const char *PassArg, const char *Name, bool CFGOnly = false,
+ bool IsAnalysis = false)
+ : RegisterPassBase(Name, PassArg, intptr_t(&PassName::ID),
+ RegisterPassBase::NormalCtor_t(callDefaultCtor<PassName>),
+ CFGOnly, IsAnalysis) {
}
};
const PassInfo *ImplementationInfo;
bool isDefaultImplementation;
protected:
- RegisterAGBase(const std::type_info &Interface,
- const std::type_info *Pass = 0,
- bool isDefault = false);
+ explicit RegisterAGBase(intptr_t InterfaceID,
+ intptr_t PassID = 0,
+ bool isDefault = false);
void setGroupName(const char *Name);
-public:
- ~RegisterAGBase();
};
-
-template<typename Interface, typename DefaultImplementationPass = void,
- bool Default = false>
+template<typename Interface, bool Default = false>
struct RegisterAnalysisGroup : public RegisterAGBase {
- RegisterAnalysisGroup() : RegisterAGBase(typeid(Interface),
- &typeid(DefaultImplementationPass),
- Default) {
+ explicit RegisterAnalysisGroup(RegisterPassBase &RPB)
+ : RegisterAGBase(intptr_t(&Interface::ID), RPB.getPassInfo()->getTypeInfo(),
+ Default) {
}
-};
-/// Define a specialization of RegisterAnalysisGroup that is used to set the
-/// name for the analysis group.
-///
-template<typename Interface>
-struct RegisterAnalysisGroup<Interface, void, false> : public RegisterAGBase {
- RegisterAnalysisGroup(const char *Name)
- : RegisterAGBase(typeid(Interface)) {
+ explicit RegisterAnalysisGroup(const char *Name)
+ : RegisterAGBase(intptr_t(&Interface::ID)) {
setGroupName(Name);
}
};
/// or removed from the current executable.
///
virtual void passRegistered(const PassInfo *P) {}
- virtual void passUnregistered(const PassInfo *P) {}
/// enumeratePasses - Iterate over the registered passes, calling the
/// passEnumerate callback on each PassInfo object.
};
-//===---------------------------------------------------------------------------
-/// IncludeFile class - This class is used as a hack to make sure that the
-/// implementation of a header file is included into a tool that uses the
-/// header. This is solely to overcome problems linking .a files and not
-/// getting the implementation of passes we need.
-///
-struct IncludeFile {
- IncludeFile(void *);
-};
+} // End llvm namespace
+
#endif
projects / oota-llvm.git / blobdiff