1 //===- llvm/PassInfo.h - Pass Info class ------------------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file defines and implements the PassInfo class.
12 //===----------------------------------------------------------------------===//
13 #ifndef LLVM_PASSINFO_H
14 #define LLVM_PASSINFO_H
16 #include "llvm/ADT/StringRef.h"
26 //===---------------------------------------------------------------------------
27 /// PassInfo class - An instance of this class exists for every pass known by
28 /// the system, and can be obtained from a live Pass by calling its
29 /// getPassInfo() method. These objects are set up by the RegisterPass<>
34 typedef Pass* (*NormalCtor_t)();
35 typedef Pass *(*TargetMachineCtor_t)(TargetMachine *);
38 StringRef PassName; // Nice name for Pass
39 StringRef PassArgument; // Command Line argument to run this pass
41 const bool IsCFGOnlyPass; // Pass only looks at the CFG.
42 const bool IsAnalysis; // True if an analysis pass.
43 const bool IsAnalysisGroup; // True if an analysis group.
44 std::vector<const PassInfo *> ItfImpl; // Interfaces implemented by this pass
46 NormalCtor_t NormalCtor;
47 TargetMachineCtor_t TargetMachineCtor;
50 /// PassInfo ctor - Do not call this directly, this should only be invoked
51 /// through RegisterPass.
52 PassInfo(StringRef name, StringRef arg, const void *pi, NormalCtor_t normal,
53 bool isCFGOnly, bool is_analysis,
54 TargetMachineCtor_t machine = nullptr)
55 : PassName(name), PassArgument(arg), PassID(pi), IsCFGOnlyPass(isCFGOnly),
56 IsAnalysis(is_analysis), IsAnalysisGroup(false), NormalCtor(normal),
57 TargetMachineCtor(machine) {}
58 /// PassInfo ctor - Do not call this directly, this should only be invoked
59 /// through RegisterPass. This version is for use by analysis groups; it
60 /// does not auto-register the pass.
61 PassInfo(StringRef name, const void *pi)
62 : PassName(name), PassArgument(""), PassID(pi), IsCFGOnlyPass(false),
63 IsAnalysis(false), IsAnalysisGroup(true), NormalCtor(nullptr),
64 TargetMachineCtor(nullptr) {}
66 /// getPassName - Return the friendly name for the pass, never returns null
68 StringRef getPassName() const { return PassName; }
70 /// getPassArgument - Return the command line option that may be passed to
71 /// 'opt' that will cause this pass to be run. This will return null if there
74 StringRef getPassArgument() const { return PassArgument; }
76 /// getTypeInfo - Return the id object for the pass...
78 const void *getTypeInfo() const { return PassID; }
80 /// Return true if this PassID implements the specified ID pointer.
81 bool isPassID(const void *IDPtr) const { return PassID == IDPtr; }
83 /// isAnalysisGroup - Return true if this is an analysis group, not a normal
86 bool isAnalysisGroup() const { return IsAnalysisGroup; }
87 bool isAnalysis() const { return IsAnalysis; }
89 /// isCFGOnlyPass - return true if this pass only looks at the CFG for the
91 bool isCFGOnlyPass() const { return IsCFGOnlyPass; }
93 /// getNormalCtor - Return a pointer to a function, that when called, creates
94 /// an instance of the pass and returns it. This pointer may be null if there
95 /// is no default constructor for the pass.
97 NormalCtor_t getNormalCtor() const {
100 void setNormalCtor(NormalCtor_t Ctor) {
104 /// getTargetMachineCtor - Return a pointer to a function, that when called
105 /// with a TargetMachine, creates an instance of the pass and returns it.
106 /// This pointer may be null if there is no constructor with a TargetMachine
109 TargetMachineCtor_t getTargetMachineCtor() const { return TargetMachineCtor; }
110 void setTargetMachineCtor(TargetMachineCtor_t Ctor) {
111 TargetMachineCtor = Ctor;
114 /// createPass() - Use this method to create an instance of this pass.
115 Pass *createPass() const {
116 assert((!isAnalysisGroup() || NormalCtor) &&
117 "No default implementation found for analysis group!");
119 "Cannot call createPass on PassInfo without default ctor!");
123 /// addInterfaceImplemented - This method is called when this pass is
124 /// registered as a member of an analysis group with the RegisterAnalysisGroup
127 void addInterfaceImplemented(const PassInfo *ItfPI) {
128 ItfImpl.push_back(ItfPI);
131 /// getInterfacesImplemented - Return a list of all of the analysis group
132 /// interfaces implemented by this pass.
134 const std::vector<const PassInfo*> &getInterfacesImplemented() const {
139 void operator=(const PassInfo &) = delete;
140 PassInfo(const PassInfo &) = delete;