LLVM  9.0.0svn
LegacyPassNameParser.h
Go to the documentation of this file.
1 //===- LegacyPassNameParser.h -----------------------------------*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This file contains the PassNameParser and FilteredPassNameParser<> classes,
10 // which are used to add command line arguments to a utility for all of the
11 // passes that have been registered into the system.
12 //
13 // The PassNameParser class adds ALL passes linked into the system (that are
14 // creatable) as command line arguments to the tool (when instantiated with the
15 // appropriate command line option template). The FilteredPassNameParser<>
16 // template is used for the same purposes as PassNameParser, except that it only
17 // includes passes that have a PassType that are compatible with the filter
18 // (which is the template argument).
19 //
20 // Note that this is part of the legacy pass manager infrastructure and will be
21 // (eventually) going away.
22 //
23 //===----------------------------------------------------------------------===//
24 
25 #ifndef LLVM_IR_LEGACYPASSNAMEPARSER_H
26 #define LLVM_IR_LEGACYPASSNAMEPARSER_H
27 
28 #include "llvm/ADT/STLExtras.h"
29 #include "llvm/Pass.h"
33 #include <cstring>
34 
35 namespace llvm {
36 
37 //===----------------------------------------------------------------------===//
38 // PassNameParser class - Make use of the pass registration mechanism to
39 // automatically add a command line argument to opt for each pass.
40 //
42  public cl::parser<const PassInfo*> {
43 public:
45  ~PassNameParser() override;
46 
47  void initialize() {
49 
50  // Add all of the passes to the map that got initialized before 'this' did.
52  }
53 
54  // ignorablePassImpl - Can be overriden in subclasses to refine the list of
55  // which passes we want to include.
56  //
57  virtual bool ignorablePassImpl(const PassInfo *P) const { return false; }
58 
59  inline bool ignorablePass(const PassInfo *P) const {
60  // Ignore non-selectable and non-constructible passes! Ignore
61  // non-optimizations.
62  return P->getPassArgument().empty() || P->getNormalCtor() == nullptr ||
64  }
65 
66  // Implement the PassRegistrationListener callbacks used to populate our map
67  //
68  void passRegistered(const PassInfo *P) override {
69  if (ignorablePass(P)) return;
70  if (findOption(P->getPassArgument().data()) != getNumOptions()) {
71  errs() << "Two passes with the same argument (-"
72  << P->getPassArgument() << ") attempted to be registered!\n";
73  llvm_unreachable(nullptr);
74  }
76  }
77  void passEnumerate(const PassInfo *P) override { passRegistered(P); }
78 
79  // printOptionInfo - Print out information about this option. Override the
80  // default implementation to sort the table before we print...
81  void printOptionInfo(const cl::Option &O, size_t GlobalWidth) const override {
82  PassNameParser *PNP = const_cast<PassNameParser*>(this);
83  array_pod_sort(PNP->Values.begin(), PNP->Values.end(), ValCompare);
85  }
86 
87 private:
88  // ValCompare - Provide a sorting comparator for Values elements...
89  static int ValCompare(const PassNameParser::OptionInfo *VT1,
90  const PassNameParser::OptionInfo *VT2) {
91  return VT1->Name.compare(VT2->Name);
92  }
93 };
94 
95 ///===----------------------------------------------------------------------===//
96 /// FilteredPassNameParser class - Make use of the pass registration
97 /// mechanism to automatically add a command line argument to opt for
98 /// each pass that satisfies a filter criteria. Filter should return
99 /// true for passes to be registered as command-line options.
100 ///
101 template<typename Filter>
103 private:
104  Filter filter;
105 
106 public:
107  bool ignorablePassImpl(const PassInfo *P) const override {
108  return !filter(*P);
109  }
110 };
111 
112 ///===----------------------------------------------------------------------===//
113 /// PassArgFilter - A filter for use with PassNameFilterParser that only
114 /// accepts a Pass whose Arg matches certain strings.
115 ///
116 /// Use like this:
117 ///
118 /// extern const char AllowedPassArgs[] = "-anders_aa -dse";
119 ///
120 /// static cl::list<
121 /// const PassInfo*,
122 /// bool,
123 /// FilteredPassNameParser<PassArgFilter<AllowedPassArgs> > >
124 /// PassList(cl::desc("Passes available:"));
125 ///
126 /// Only the -anders_aa and -dse options will be available to the user.
127 ///
128 template<const char *Args>
130 public:
131  bool operator()(const PassInfo &P) const {
132  return StringRef(Args).contains(P.getPassArgument());
133  }
134 };
135 
136 } // End llvm namespace
137 
138 #endif
SmallVector< OptionInfo, 8 > Values
Definition: CommandLine.h:768
void enumeratePasses()
enumeratePasses - Iterate over the registered passes, calling the passEnumerate callback on each Pass...
Definition: Pass.cpp:258
raw_ostream & errs()
This returns a reference to a raw_ostream for standard error.
PassNameParser(cl::Option &O)
Definition: Pass.cpp:262
This class represents lattice values for constants.
Definition: AllocatorList.h:23
unsigned getNumOptions() const override
Definition: CommandLine.h:776
bool ignorablePassImpl(const PassInfo *P) const override
===-------------------------------------------------------------------—===// FilteredPassNameParser ...
~PassNameParser() override
virtual void printOptionInfo(const Option &O, size_t GlobalWidth) const
NormalCtor_t getNormalCtor() const
getNormalCtor - Return a pointer to a function, that when called, creates an instance of the pass and...
Definition: PassInfo.h:88
LLVM_NODISCARD bool empty() const
empty - Check if the string is empty.
Definition: StringRef.h:126
bool ignorablePass(const PassInfo *P) const
#define P(N)
void array_pod_sort(IteratorTy Start, IteratorTy End)
array_pod_sort - This sorts an array with the specified start and end extent.
Definition: STLExtras.h:1082
bool operator()(const PassInfo &P) const
void passEnumerate(const PassInfo *P) override
passEnumerate - Callback function invoked when someone calls enumeratePasses on this PassRegistration...
LLVM_NODISCARD bool contains(StringRef Other) const
Return true if the given string is a substring of *this, and false otherwise.
Definition: StringRef.h:432
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 getPassInfo() method.
Definition: PassInfo.h:30
#define llvm_unreachable(msg)
Marks that the current location is not supposed to be reachable.
===-------------------------------------------------------------------—===// PassArgFilter - A filte...
void addLiteralOption(StringRef Name, const DT &V, StringRef HelpStr)
addLiteralOption - Add an entry to the mapping table.
Definition: CommandLine.h:807
void printOptionInfo(const cl::Option &O, size_t GlobalWidth) const override
StringRef getPassName() const
getPassName - Return the friendly name for the pass, never returns null
Definition: PassInfo.h:62
PassRegistrationListener class - This class is meant to be derived from by clients that are intereste...
Definition: PassSupport.h:196
void passRegistered(const PassInfo *P) override
Callback functions - These functions are invoked whenever a pass is loaded or removed from the curren...
LLVM_NODISCARD const char * data() const
data - Get a pointer to the start of the string (which may not be null terminated).
Definition: StringRef.h:122
virtual bool ignorablePassImpl(const PassInfo *P) const
StringRef getPassArgument() const
getPassArgument - Return the command line option that may be passed to &#39;opt&#39; that will cause this pas...
Definition: PassInfo.h:67
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:48
unsigned findOption(StringRef Name)
constexpr char Args[]
Key for Kernel::Metadata::mArgs.