1 //===- llvm/PassInfo.h - Pass Info class ------------------------*- C++ -*-===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This file defines and implements the PassInfo class.
11 //
12 //===----------------------------------------------------------------------===//
13 #ifndef LLVM_PASSINFO_H
14 #define LLVM_PASSINFO_H
15 
16 #include <cassert>
17 #include <vector>
18 
19 namespace llvm {
20 
21 class Pass;
22 class TargetMachine;
23 
24 //===---------------------------------------------------------------------------
25 /// PassInfo class - An instance of this class exists for every pass known by
26 /// the system, and can be obtained from a live Pass by calling its
27 /// getPassInfo() method.  These objects are set up by the RegisterPass<>
28 /// template.
29 ///
30 class PassInfo {
31 public:
32   typedef Pass* (*NormalCtor_t)();
33   typedef Pass *(*TargetMachineCtor_t)(TargetMachine *);
34 
35 private:
36   const char *const PassName;     // Nice name for Pass
37   const char *const PassArgument; // Command Line argument to run this pass
38   const void *PassID;
39   const bool IsCFGOnlyPass;              // Pass only looks at the CFG.
40   const bool IsAnalysis;                 // True if an analysis pass.
41   const bool IsAnalysisGroup;            // True if an analysis group.
42   std::vector<const PassInfo *> ItfImpl; // Interfaces implemented by this pass
43 
44   NormalCtor_t NormalCtor;
45   TargetMachineCtor_t TargetMachineCtor;
46 
47 public:
48   /// PassInfo ctor - Do not call this directly, this should only be invoked
49   /// through RegisterPass.
50   PassInfo(const char *name, const char *arg, const void *pi,
51            NormalCtor_t normal, bool isCFGOnly, bool is_analysis,
52            TargetMachineCtor_t machine = nullptr)
PassName(name)53       : PassName(name), PassArgument(arg), PassID(pi), IsCFGOnlyPass(isCFGOnly),
54         IsAnalysis(is_analysis), IsAnalysisGroup(false), NormalCtor(normal),
55         TargetMachineCtor(machine) {}
56   /// PassInfo ctor - Do not call this directly, this should only be invoked
57   /// through RegisterPass. This version is for use by analysis groups; it
58   /// does not auto-register the pass.
PassInfo(const char * name,const void * pi)59   PassInfo(const char *name, const void *pi)
60       : PassName(name), PassArgument(""), PassID(pi), IsCFGOnlyPass(false),
61         IsAnalysis(false), IsAnalysisGroup(true), NormalCtor(nullptr),
62         TargetMachineCtor(nullptr) {}
63 
64   /// getPassName - Return the friendly name for the pass, never returns null
65   ///
getPassName()66   const char *getPassName() const { return PassName; }
67 
68   /// getPassArgument - Return the command line option that may be passed to
69   /// 'opt' that will cause this pass to be run.  This will return null if there
70   /// is no argument.
71   ///
getPassArgument()72   const char *getPassArgument() const { return PassArgument; }
73 
74   /// getTypeInfo - Return the id object for the pass...
75   /// TODO : Rename
getTypeInfo()76   const void *getTypeInfo() const { return PassID; }
77 
78   /// Return true if this PassID implements the specified ID pointer.
isPassID(const void * IDPtr)79   bool isPassID(const void *IDPtr) const { return PassID == IDPtr; }
80 
81   /// isAnalysisGroup - Return true if this is an analysis group, not a normal
82   /// pass.
83   ///
isAnalysisGroup()84   bool isAnalysisGroup() const { return IsAnalysisGroup; }
isAnalysis()85   bool isAnalysis() const { return IsAnalysis; }
86 
87   /// isCFGOnlyPass - return true if this pass only looks at the CFG for the
88   /// function.
isCFGOnlyPass()89   bool isCFGOnlyPass() const { return IsCFGOnlyPass; }
90 
91   /// getNormalCtor - Return a pointer to a function, that when called, creates
92   /// an instance of the pass and returns it.  This pointer may be null if there
93   /// is no default constructor for the pass.
94   ///
getNormalCtor()95   NormalCtor_t getNormalCtor() const {
96     return NormalCtor;
97   }
setNormalCtor(NormalCtor_t Ctor)98   void setNormalCtor(NormalCtor_t Ctor) {
99     NormalCtor = Ctor;
100   }
101 
102   /// getTargetMachineCtor - Return a pointer to a function, that when called
103   /// with a TargetMachine, creates an instance of the pass and returns it.
104   /// This pointer may be null if there is no constructor with a TargetMachine
105   /// for the pass.
106   ///
getTargetMachineCtor()107   TargetMachineCtor_t getTargetMachineCtor() const { return TargetMachineCtor; }
setTargetMachineCtor(TargetMachineCtor_t Ctor)108   void setTargetMachineCtor(TargetMachineCtor_t Ctor) {
109     TargetMachineCtor = Ctor;
110   }
111 
112   /// createPass() - Use this method to create an instance of this pass.
createPass()113   Pass *createPass() const {
114     assert((!isAnalysisGroup() || NormalCtor) &&
115            "No default implementation found for analysis group!");
116     assert(NormalCtor &&
117            "Cannot call createPass on PassInfo without default ctor!");
118     return NormalCtor();
119   }
120 
121   /// addInterfaceImplemented - This method is called when this pass is
122   /// registered as a member of an analysis group with the RegisterAnalysisGroup
123   /// template.
124   ///
addInterfaceImplemented(const PassInfo * ItfPI)125   void addInterfaceImplemented(const PassInfo *ItfPI) {
126     ItfImpl.push_back(ItfPI);
127   }
128 
129   /// getInterfacesImplemented - Return a list of all of the analysis group
130   /// interfaces implemented by this pass.
131   ///
getInterfacesImplemented()132   const std::vector<const PassInfo*> &getInterfacesImplemented() const {
133     return ItfImpl;
134   }
135 
136 private:
137   void operator=(const PassInfo &) = delete;
138   PassInfo(const PassInfo &) = delete;
139 };
140 
141 }
142 
143 #endif
144