X-Git-Url: http://demsky.eecs.uci.edu/git/?a=blobdiff_plain;f=include%2Fllvm%2FPassSupport.h;h=ccc79345e0304e9410084aa35c1de60e80c89f99;hb=a249914462c7b8f0c25b21eca77df264455290ee;hp=f594d45f1522b83cd73d288662cf226131ae2b9c;hpb=eae540a037d17d218767f21b6d3b45f395df4619;p=oota-llvm.git diff --git a/include/llvm/PassSupport.h b/include/llvm/PassSupport.h index f594d45f152..ccc79345e03 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. // //===----------------------------------------------------------------------===// // @@ -18,16 +18,18 @@ // //===----------------------------------------------------------------------===// -#ifndef LLVM_PASS_SUPPORT_H -#define LLVM_PASS_SUPPORT_H +#ifndef LLVM_PASSSUPPORT_H +#define LLVM_PASSSUPPORT_H -#include "llvm/System/IncludeFile.h" -// No need to include Pass.h, we are being included by it! +#include "Pass.h" +#include "llvm/InitializePasses.h" +#include "llvm/PassRegistry.h" +#include "llvm/Support/Atomic.h" +#include "llvm/Support/Valgrind.h" +#include namespace llvm { -class TargetMachine; - //===--------------------------------------------------------------------------- /// PassInfo class - An instance of this class exists for every pass known by /// the system, and can be obtained from a live Pass by calling its @@ -35,28 +37,39 @@ class TargetMachine; /// template, defined below. /// class PassInfo { - const char *PassName; // Nice name for Pass - const char *PassArgument; // Command Line argument to run this pass - intptr_t PassID; - bool IsCFGOnlyPass; // Pass only looks at the CFG. - bool IsAnalysisGroup; // True if an analysis group. +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 void *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)(); + NormalCtor_t NormalCtor; public: /// PassInfo ctor - Do not call this directly, this should only be invoked /// through RegisterPass. - PassInfo(const char *name, const char *arg, intptr_t pi, - Pass *(*normal)() = 0, bool isCFGOnly = false) + PassInfo(const char *name, const char *arg, const void *pi, + NormalCtor_t normal, bool isCFGOnly, bool is_analysis) : PassName(name), PassArgument(arg), PassID(pi), - IsCFGOnlyPass(isCFGOnly), IsAnalysisGroup(false), NormalCtor(normal) { - } + IsCFGOnlyPass(isCFGOnly), + IsAnalysis(is_analysis), IsAnalysisGroup(false), NormalCtor(normal) { } + /// 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, const void *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 @@ -64,15 +77,20 @@ public: /// const char *getPassArgument() const { return PassArgument; } - /// getTypeInfo - Return the type_info object for the pass... + /// getTypeInfo - Return the id object for the pass... /// TODO : Rename - intptr_t getTypeInfo() const { return PassID; } + const void *getTypeInfo() const { return PassID; } + /// Return true if this PassID implements the specified ID pointer. + bool isPassID(const void *IDPtr) const { + return PassID == IDPtr; + } + /// isAnalysisGroup - Return true if this is an analysis group, not a normal /// pass. /// bool isAnalysisGroup() const { return IsAnalysisGroup; } - void SetIsAnalysisGroup() { IsAnalysisGroup = true; } + bool isAnalysis() const { return IsAnalysis; } /// isCFGOnlyPass - return true if this pass only looks at the CFG for the /// function. @@ -82,21 +100,15 @@ public: /// 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((!isAnalysisGroup() || NormalCtor) && - "No default implementation found for analysis group!"); - assert(NormalCtor && - "Cannot call createPass on PassInfo without default ctor!"); - return NormalCtor(); - } + Pass *createPass() const; /// addInterfaceImplemented - This method is called when this pass is /// registered as a member of an analysis group with the RegisterAnalysisGroup @@ -112,8 +124,63 @@ public: const std::vector &getInterfacesImplemented() const { return ItfImpl; } + +private: + void operator=(const PassInfo &) LLVM_DELETED_FUNCTION; + PassInfo(const PassInfo &) LLVM_DELETED_FUNCTION; }; +#define CALL_ONCE_INITIALIZATION(function) \ + static volatile sys::cas_flag initialized = 0; \ + sys::cas_flag old_val = sys::CompareAndSwap(&initialized, 1, 0); \ + if (old_val == 0) { \ + function(Registry); \ + sys::MemoryFence(); \ + TsanIgnoreWritesBegin(); \ + TsanHappensBefore(&initialized); \ + initialized = 2; \ + TsanIgnoreWritesEnd(); \ + } else { \ + sys::cas_flag tmp = initialized; \ + sys::MemoryFence(); \ + while (tmp != 2) { \ + tmp = initialized; \ + sys::MemoryFence(); \ + } \ + } \ + TsanHappensAfter(&initialized); + +#define INITIALIZE_PASS(passName, arg, name, cfg, analysis) \ + static void* initialize##passName##PassOnce(PassRegistry &Registry) { \ + PassInfo *PI = new PassInfo(name, arg, & passName ::ID, \ + PassInfo::NormalCtor_t(callDefaultCtor< passName >), cfg, analysis); \ + Registry.registerPass(*PI, true); \ + return PI; \ + } \ + void llvm::initialize##passName##Pass(PassRegistry &Registry) { \ + CALL_ONCE_INITIALIZATION(initialize##passName##PassOnce) \ + } + +#define INITIALIZE_PASS_BEGIN(passName, arg, name, cfg, analysis) \ + static void* initialize##passName##PassOnce(PassRegistry &Registry) { + +#define INITIALIZE_PASS_DEPENDENCY(depName) \ + initialize##depName##Pass(Registry); +#define INITIALIZE_AG_DEPENDENCY(depName) \ + initialize##depName##AnalysisGroup(Registry); + +#define INITIALIZE_PASS_END(passName, arg, name, cfg, analysis) \ + PassInfo *PI = new PassInfo(name, arg, & passName ::ID, \ + PassInfo::NormalCtor_t(callDefaultCtor< passName >), cfg, analysis); \ + Registry.registerPass(*PI, true); \ + return PI; \ + } \ + void llvm::initialize##passName##Pass(PassRegistry &Registry) { \ + CALL_ONCE_INITIALIZATION(initialize##passName##PassOnce) \ + } + +template +Pass *callDefaultCtor() { return new PassName(); } //===--------------------------------------------------------------------------- /// RegisterPass template - This template class is used to notify the system @@ -132,41 +199,16 @@ public: /// /// static RegisterPass tmp("passopt", "My Name"); /// -struct RegisterPassBase { - /// getPassInfo - Get the pass info for the registered class... - /// - const PassInfo *getPassInfo() const { return &PIObj; } - - typedef Pass* (*NormalCtor_t)(); - - RegisterPassBase(const char *Name, const char *Arg, intptr_t TI, - NormalCtor_t NormalCtor = 0, bool CFGOnly = false) - : PIObj(Name, Arg, TI, NormalCtor, CFGOnly) { - registerPass(); - } - 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(); - void unregisterPass(); -}; - -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, bool CFGOnly = false) - : RegisterPassBase(Name, PassArg, (intptr_t)&PassName::ID, - (RegisterPassBase::NormalCtor_t)callDefaultCtor, CFGOnly) { + RegisterPass(const char *PassArg, const char *Name, bool CFGOnly = false, + bool is_analysis = false) + : PassInfo(Name, PassArg, &passName::ID, + PassInfo::NormalCtor_t(callDefaultCtor), + CFGOnly, is_analysis) { + PassRegistry::getPassRegistry()->registerPass(*this); } }; @@ -179,7 +221,7 @@ struct RegisterPass : public RegisterPassBase { /// /// If no analysis implementing the interface is available, a default /// implementation is created and added. A pass registers itself as the default -/// implementation by specifying 'true' as the third template argument of this +/// implementation by specifying 'true' as the second template argument of this /// class. /// /// In addition to registering itself as an analysis group member, a pass must @@ -190,38 +232,80 @@ struct RegisterPass : public RegisterPassBase { /// second template argument). The interface should be registered to associate /// a nice name with the interface. /// -class RegisterAGBase : public RegisterPassBase { - PassInfo *InterfaceInfo; - const PassInfo *ImplementationInfo; - bool isDefaultImplementation; -protected: - explicit RegisterAGBase(intptr_t InterfaceID, - intptr_t PassID = 0, - bool isDefault = false); - void setGroupName(const char *Name); +class RegisterAGBase : public PassInfo { +public: + RegisterAGBase(const char *Name, + const void *InterfaceID, + const void *PassID = 0, + bool isDefault = false); }; template struct RegisterAnalysisGroup : public RegisterAGBase { - explicit RegisterAnalysisGroup(RegisterPassBase &RPB) - : RegisterAGBase((intptr_t) &Interface::ID, RPB.getPassInfo()->getTypeInfo(), + explicit RegisterAnalysisGroup(PassInfo &RPB) + : RegisterAGBase(RPB.getPassName(), + &Interface::ID, RPB.getTypeInfo(), Default) { } explicit RegisterAnalysisGroup(const char *Name) - : RegisterAGBase((intptr_t) &Interface::ID) { - setGroupName(Name); + : RegisterAGBase(Name, &Interface::ID) { } }; +#define INITIALIZE_ANALYSIS_GROUP(agName, name, defaultPass) \ + static void* initialize##agName##AnalysisGroupOnce(PassRegistry &Registry) { \ + initialize##defaultPass##Pass(Registry); \ + PassInfo *AI = new PassInfo(name, & agName :: ID); \ + Registry.registerAnalysisGroup(& agName ::ID, 0, *AI, false, true); \ + return AI; \ + } \ + void llvm::initialize##agName##AnalysisGroup(PassRegistry &Registry) { \ + CALL_ONCE_INITIALIZATION(initialize##agName##AnalysisGroupOnce) \ + } + +#define INITIALIZE_AG_PASS(passName, agName, arg, name, cfg, analysis, def) \ + static void* initialize##passName##PassOnce(PassRegistry &Registry) { \ + if (!def) initialize##agName##AnalysisGroup(Registry); \ + PassInfo *PI = new PassInfo(name, arg, & passName ::ID, \ + PassInfo::NormalCtor_t(callDefaultCtor< passName >), cfg, analysis); \ + Registry.registerPass(*PI, true); \ + \ + PassInfo *AI = new PassInfo(name, & agName :: ID); \ + Registry.registerAnalysisGroup(& agName ::ID, & passName ::ID, \ + *AI, def, true); \ + return AI; \ + } \ + void llvm::initialize##passName##Pass(PassRegistry &Registry) { \ + CALL_ONCE_INITIALIZATION(initialize##passName##PassOnce) \ + } + + +#define INITIALIZE_AG_PASS_BEGIN(passName, agName, arg, n, cfg, analysis, def) \ + static void* initialize##passName##PassOnce(PassRegistry &Registry) { \ + if (!def) initialize##agName##AnalysisGroup(Registry); + +#define INITIALIZE_AG_PASS_END(passName, agName, arg, n, cfg, analysis, def) \ + PassInfo *PI = new PassInfo(n, arg, & passName ::ID, \ + PassInfo::NormalCtor_t(callDefaultCtor< passName >), cfg, analysis); \ + Registry.registerPass(*PI, true); \ + \ + PassInfo *AI = new PassInfo(n, & agName :: ID); \ + Registry.registerAnalysisGroup(& agName ::ID, & passName ::ID, \ + *AI, def, true); \ + return AI; \ + } \ + void llvm::initialize##passName##Pass(PassRegistry &Registry) { \ + CALL_ONCE_INITIALIZATION(initialize##passName##PassOnce) \ + } //===--------------------------------------------------------------------------- /// PassRegistrationListener class - This class is meant to be derived from by /// clients that are interested in which passes get registered and unregistered /// at runtime (which can be because of the RegisterPass constructors being run /// as the program starts up, or may be because a shared object just got -/// loaded). Deriving from the PassRegistationListener class automatically +/// loaded). Deriving from the PassRegistrationListener class automatically /// registers your object to receive callbacks indicating when passes are loaded /// and removed. /// @@ -238,7 +322,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 passRegistered(const PassInfo *) {} /// enumeratePasses - Iterate over the registered passes, calling the /// passEnumerate callback on each PassInfo object. @@ -248,7 +332,7 @@ struct PassRegistrationListener { /// passEnumerate - Callback function invoked when someone calls /// enumeratePasses on this PassRegistrationListener object. /// - virtual void passEnumerate(const PassInfo *P) {} + virtual void passEnumerate(const PassInfo *) {} };