X-Git-Url: http://demsky.eecs.uci.edu/git/?a=blobdiff_plain;f=include%2Fllvm%2FPassSupport.h;h=7121835a7e524f88be44c505583039aad3f54528;hb=4d515d0b09d43af59cd040bfb8bf1b7a2b992980;hp=a33b166d5ba1798d7866e7deff4c26b6fbfb316a;hpb=33a0a6ddf5427e05b1d9477075c6f6bf60aa7e62;p=oota-llvm.git diff --git a/include/llvm/PassSupport.h b/include/llvm/PassSupport.h index a33b166d5ba..7121835a7e5 100644 --- a/include/llvm/PassSupport.h +++ b/include/llvm/PassSupport.h @@ -2,8 +2,8 @@ // // 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. // //===----------------------------------------------------------------------===// // @@ -21,7 +21,6 @@ #ifndef LLVM_PASS_SUPPORT_H #define LLVM_PASS_SUPPORT_H -#include "llvm/System/IncludeFile.h" // No need to include Pass.h, we are being included by it! namespace llvm { @@ -35,38 +34,43 @@ class TargetMachine; /// template, defined below. /// 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... +public: + typedef Pass* (*NormalCtor_t)(); + +private: + const char *const PassName; // Nice name for Pass + const char *const PassArgument; // Command Line argument to run this pass + const intptr_t PassID; + const bool IsCFGOnlyPass; // Pass only looks at the CFG. + const bool IsAnalysis; // True if an analysis pass. + const bool IsAnalysisGroup; // True if an analysis group. std::vector ItfImpl;// Interfaces implemented by this pass - Pass *(*NormalCtor)(); // No argument ctor - Pass *(*TargetCtor)(TargetMachine&); // Ctor taking TargetMachine object... + NormalCtor_t 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, AnalysisGroup = 4 - }; - /// 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 char pt, Pass *(*normal)() = 0, - Pass *(*targetctor)(TargetMachine &) = 0) - : PassName(name), PassArgument(arg), TypeInfo(ti), PassType(pt), - NormalCtor(normal), TargetCtor(targetctor) { + PassInfo(const char *name, const char *arg, intptr_t pi, + NormalCtor_t normal = 0, + bool isCFGOnly = false, bool is_analysis = false) + : PassName(name), PassArgument(arg), PassID(pi), + IsCFGOnlyPass(isCFGOnly), + IsAnalysis(is_analysis), IsAnalysisGroup(false), NormalCtor(normal) { + registerPass(); + } + /// PassInfo ctor - Do not call this directly, this should only be invoked + /// through RegisterPass. This version is for use by analysis groups; it + /// does not auto-register the pass. + PassInfo(const char *name, intptr_t pi) + : PassName(name), PassArgument(""), PassID(pi), + IsCFGOnlyPass(false), + IsAnalysis(false), IsAnalysisGroup(true), NormalCtor(0) { } /// getPassName - Return the friendly name for the pass, never returns null /// const char *getPassName() const { return PassName; } - void setPassName(const char *Name) { PassName = Name; } /// getPassArgument - Return the command line option that may be passed to /// 'opt' that will cause this pass to be run. This will return null if there @@ -74,44 +78,40 @@ public: /// 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; } + /// 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)() { + NormalCtor_t getNormalCtor() const { return NormalCtor; } - void setNormalCtor(Pass *(*Ctor)()) { + void setNormalCtor(NormalCtor_t Ctor) { NormalCtor = Ctor; } /// 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(); } - /// getTargetCtor - 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 TargetMachine object as a parameter. - /// - Pass *(*getTargetCtor() const)(TargetMachine &) { - return TargetCtor; - } - /// addInterfaceImplemented - This method is called when this pass is /// registered as a member of an analysis group with the RegisterAnalysisGroup /// template. @@ -126,9 +126,27 @@ public: const std::vector &getInterfacesImplemented() const { return ItfImpl; } + + /// getPassInfo - Deprecated API compaatibility function. This function + /// just returns 'this'. + /// + const PassInfo *getPassInfo() const { + return this; + } + +protected: + void registerPass(); + void unregisterPass(); + +private: + void operator=(const PassInfo &); // do not implement + PassInfo(const PassInfo &); // do not implement }; +template +Pass *callDefaultCtor() { return new PassName(); } + //===--------------------------------------------------------------------------- /// RegisterPass template - This template class is used to notify the system /// that a Pass is available for use, and registers it into the internal @@ -144,135 +162,17 @@ public: /// 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 tmp("passopt", "My Name", createMyPass); +/// static RegisterPass tmp("passopt", "My Name"); /// -struct RegisterPassBase { - /// getPassInfo - Get the pass info for the registered class... - /// - const PassInfo *getPassInfo() const { return &PIObj; } - - RegisterPassBase(const char *Name, const char *Arg, const std::type_info &TI, - unsigned char PT, Pass *(*Normal)() = 0, - Pass *(*TargetCtor)(TargetMachine &) = 0) - : PIObj(Name, Arg, TI, PT, Normal, TargetCtor) { - registerPass(); - } - RegisterPassBase(const std::type_info &TI, unsigned char PT) - : PIObj("", "", TI, PT, 0, 0) { - // This ctor may only be used for analysis groups: it does not auto-register - // the pass. - assert(PT == PassInfo::AnalysisGroup && "Not an AnalysisGroup!"); - } - - ~RegisterPassBase() { // Intentionally non-virtual. - // Analysis groups are registered/unregistered by their dtor. - if (PIObj.getPassType() != PassInfo::AnalysisGroup) - unregisterPass(); - } - -protected: - PassInfo PIObj; // The PassInfo object for this pass - void registerPass(); - void unregisterPass(); - - /// setOnlyUsesCFG - Notice that this pass only depends on the CFG, so - /// transformations that do not modify the CFG do not invalidate this pass. - /// - void setOnlyUsesCFG(); -}; - -template -Pass *callDefaultCtor() { return new PassName(); } - -template -struct RegisterPass : public RegisterPassBase { +template +struct RegisterPass : public PassInfo { // Register Pass using default constructor... - RegisterPass(const char *PassArg, const char *Name, unsigned char PassTy = 0) - : RegisterPassBase(Name, PassArg, typeid(PassName), PassTy, - callDefaultCtor) {} - - // Register Pass using default constructor explicitly... - RegisterPass(const char *PassArg, const char *Name, unsigned char PassTy, - Pass *(*ctor)()) - : RegisterPassBase(Name, PassArg, typeid(PassName), PassTy, ctor) {} - - // Register Pass using TargetMachine constructor... - RegisterPass(const char *PassArg, const char *Name, unsigned char PassTy, - Pass *(*targetctor)(TargetMachine &)) - : RegisterPassBase(Name, PassArg, typeid(PassName), PassTy, - 0, targetctor) {} - - // Generic constructor version that has an unknown ctor type... - template - RegisterPass(const char *PassArg, const char *Name, unsigned char PassTy, - CtorType *Fn) - : RegisterPassBase(Name, PassArg, typeid(PassName), PassTy, 0) {} -}; - -/// RegisterOpt - Register something that is to show up in Opt, this is just a -/// shortcut for specifying RegisterPass... -/// -template -struct RegisterOpt : public RegisterPassBase { - RegisterOpt(const char *PassArg, const char *Name, bool CFGOnly = false) - : RegisterPassBase(Name, PassArg, typeid(PassName), PassInfo::Optimization, - callDefaultCtor) { - if (CFGOnly) setOnlyUsesCFG(); - } - - /// Register Pass using default constructor explicitly... - /// - RegisterOpt(const char *PassArg, const char *Name, Pass *(*ctor)(), - bool CFGOnly = false) - : RegisterPassBase(Name, PassArg, typeid(PassName), - PassInfo::Optimization, ctor) { - if (CFGOnly) setOnlyUsesCFG(); - } - - /// Register FunctionPass using default constructor explicitly... - /// - RegisterOpt(const char *PassArg, const char *Name, FunctionPass *(*ctor)(), - bool CFGOnly = false) - : RegisterPassBase(Name, PassArg, typeid(PassName), PassInfo::Optimization, - static_cast(ctor)) { - if (CFGOnly) setOnlyUsesCFG(); - } - - /// Register Pass using TargetMachine constructor... - /// - RegisterOpt(const char *PassArg, const char *Name, - Pass *(*targetctor)(TargetMachine &), bool CFGOnly = false) - : RegisterPassBase(Name, PassArg, typeid(PassName), - PassInfo::Optimization, 0, targetctor) { - if (CFGOnly) setOnlyUsesCFG(); - } - - /// Register FunctionPass using TargetMachine constructor... - /// - RegisterOpt(const char *PassArg, const char *Name, - FunctionPass *(*targetctor)(TargetMachine &), - bool CFGOnly = false) - : RegisterPassBase(Name, PassArg, typeid(PassName), PassInfo::Optimization, 0, - static_cast(targetctor)) { - if (CFGOnly) setOnlyUsesCFG(); - } -}; - -/// 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 -struct RegisterAnalysis : public RegisterPassBase { - RegisterAnalysis(const char *PassArg, const char *Name, - bool CFGOnly = false) - : RegisterPassBase(Name, PassArg, typeid(PassName), PassInfo::Analysis, - callDefaultCtor) { - if (CFGOnly) setOnlyUsesCFG(); + RegisterPass(const char *PassArg, const char *Name, bool CFGOnly = false, + bool is_analysis = false) + : PassInfo(Name, PassArg, intptr_t(&passName::ID), + PassInfo::NormalCtor_t(callDefaultCtor), + CFGOnly, is_analysis) { } }; @@ -296,37 +196,27 @@ struct RegisterAnalysis : public RegisterPassBase { /// second template argument). The interface should be registered to associate /// a nice name with the interface. /// -class RegisterAGBase : public RegisterPassBase { +class RegisterAGBase : public PassInfo { PassInfo *InterfaceInfo; const PassInfo *ImplementationInfo; bool isDefaultImplementation; protected: - RegisterAGBase(const std::type_info &Interface, - const std::type_info *Pass = 0, - bool isDefault = false); - void setGroupName(const char *Name); -public: - ~RegisterAGBase(); + explicit RegisterAGBase(const char *Name, + intptr_t InterfaceID, + intptr_t PassID = 0, + bool isDefault = false); }; - -template +template struct RegisterAnalysisGroup : public RegisterAGBase { - RegisterAnalysisGroup() : RegisterAGBase(typeid(Interface), - &typeid(DefaultImplementationPass), - Default) { + explicit RegisterAnalysisGroup(PassInfo &RPB) + : RegisterAGBase(RPB.getPassName(), + intptr_t(&Interface::ID), RPB.getTypeInfo(), + Default) { } -}; -/// Define a specialization of RegisterAnalysisGroup that is used to set the -/// name for the analysis group. -/// -template -struct RegisterAnalysisGroup : public RegisterAGBase { - RegisterAnalysisGroup(const char *Name) - : RegisterAGBase(typeid(Interface)) { - setGroupName(Name); + explicit RegisterAnalysisGroup(const char *Name) + : RegisterAGBase(Name, intptr_t(&Interface::ID)) { } }; @@ -354,8 +244,7 @@ struct PassRegistrationListener { /// Callback functions - These functions are invoked whenever a pass is loaded /// or removed from the current executable. /// - virtual void passRegistered(const PassInfo *P) {} - virtual void passUnregistered(const PassInfo *P) {} + virtual void passRegistered(const PassInfo *) {} /// enumeratePasses - Iterate over the registered passes, calling the /// passEnumerate callback on each PassInfo object. @@ -365,76 +254,7 @@ struct PassRegistrationListener { /// passEnumerate - Callback function invoked when someone calls /// enumeratePasses on this PassRegistrationListener object. /// - virtual void passEnumerate(const PassInfo *P) {} -}; - - -//===---------------------------------------------------------------------===// -/// -/// RegisterRegAlloc class - Track the registration of register allocators. -/// -class RegisterRegAlloc { - -public: - - typedef FunctionPass *(*FunctionPassCtor)(); - -private: - - static RegisterRegAlloc *List; // Linked list of register allocators. - - RegisterRegAlloc *Next; // Next allocation scheme in list. - const char *Name; // Name of register allocator. - const char *Description; // Description string. - FunctionPassCtor Ctor; // Function to construct register - // allocator pass. -public: - - RegisterRegAlloc(const char *N, const char *D, FunctionPassCtor C) - : Name(N) - , Description(D) - , Ctor(C) { - Add(); - } - - ~RegisterRegAlloc() { - Remove(); - } - - - // Accessors - const char *getName() const { return Name; } - const char *getDescription() const { return Description; } - FunctionPassCtor getCtor() const { return Ctor; } - - - /// Add - Adds a register allocator to the registration list. - /// - void Add() { - Next = List; - List = this; - } - - - /// Remove - Removes a register allocator from the registration list. - /// - void Remove() { - for (RegisterRegAlloc **RA = &List; *RA; RA = &(*RA)->Next) { - if (*RA == this) { - *RA = Next; - break; - } - } - } - - - /// Find - Finds a register allocator in registration list. - /// - static FunctionPassCtor Find(const char *N); - -#ifndef NDEBUG - static void print(); -#endif + virtual void passEnumerate(const PassInfo *) {} };