1
//===- llvm/Support/PassNameParser.h ----------------------------*- 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 the PassNameParser and FilteredPassNameParser<> classes, which are
11
// used to add command line arguments to a utility for all of the passes that
12
// have been registered into the system.
14
// The PassNameParser class adds ALL passes linked into the system (that are
15
// creatable) as command line arguments to the tool (when instantiated with the
16
// appropriate command line option template). The FilteredPassNameParser<>
17
// template is used for the same purposes as PassNameParser, except that it only
18
// includes passes that have a PassType that are compatible with the filter
19
// (which is the template argument).
21
//===----------------------------------------------------------------------===//
23
#ifndef LLVM_SUPPORT_PASS_NAME_PARSER_H
24
#define LLVM_SUPPORT_PASS_NAME_PARSER_H
26
#include "llvm/Support/CommandLine.h"
27
#include "llvm/Support/ErrorHandling.h"
28
#include "llvm/Support/raw_ostream.h"
29
#include "llvm/Pass.h"
35
//===----------------------------------------------------------------------===//
36
// PassNameParser class - Make use of the pass registration mechanism to
37
// automatically add a command line argument to opt for each pass.
39
class PassNameParser : public PassRegistrationListener,
40
public cl::parser<const PassInfo*> {
43
PassNameParser() : Opt(0) {}
44
virtual ~PassNameParser();
47
void initialize(cl::Option &O) {
49
cl::parser<const PassInfo*>::initialize(O);
51
// Add all of the passes to the map that got initialized before 'this' did.
55
// ignorablePassImpl - Can be overriden in subclasses to refine the list of
56
// which passes we want to include.
58
virtual bool ignorablePassImpl(const PassInfo *P) const { return false; }
60
inline bool ignorablePass(const PassInfo *P) const {
61
// Ignore non-selectable and non-constructible passes! Ignore
63
return P->getPassArgument() == 0 || *P->getPassArgument() == 0 ||
64
P->getNormalCtor() == 0 || ignorablePassImpl(P);
67
// Implement the PassRegistrationListener callbacks used to populate our map
69
virtual void passRegistered(const PassInfo *P) {
70
if (ignorablePass(P) || !Opt) return;
71
if (findOption(P->getPassArgument()) != getNumOptions()) {
72
errs() << "Two passes with the same argument (-"
73
<< P->getPassArgument() << ") attempted to be registered!\n";
76
addLiteralOption(P->getPassArgument(), P, P->getPassName());
78
virtual void passEnumerate(const PassInfo *P) { passRegistered(P); }
80
// ValLessThan - Provide a sorting comparator for Values elements...
81
typedef std::pair<const char*,
82
std::pair<const PassInfo*, const char*> > ValType;
83
static bool ValLessThan(const ValType &VT1, const ValType &VT2) {
84
return std::string(VT1.first) < std::string(VT2.first);
87
// printOptionInfo - Print out information about this option. Override the
88
// default implementation to sort the table before we print...
89
virtual void printOptionInfo(const cl::Option &O, size_t GlobalWidth) const {
90
PassNameParser *PNP = const_cast<PassNameParser*>(this);
91
std::sort(PNP->Values.begin(), PNP->Values.end(), ValLessThan);
92
cl::parser<const PassInfo*>::printOptionInfo(O, GlobalWidth);
96
///===----------------------------------------------------------------------===//
97
/// FilteredPassNameParser class - Make use of the pass registration
98
/// mechanism to automatically add a command line argument to opt for
99
/// each pass that satisfies a filter criteria. Filter should return
100
/// true for passes to be registered as command-line options.
102
template<typename Filter>
103
class FilteredPassNameParser : public PassNameParser {
108
bool ignorablePassImpl(const PassInfo *P) const { return !filter(*P); }
111
///===----------------------------------------------------------------------===//
112
/// PassArgFilter - A filter for use with PassNameFilterParser that only
113
/// accepts a Pass whose Arg matches certain strings.
117
/// extern const char AllowedPassArgs[] = "-anders_aa -dse";
122
/// FilteredPassNameParser<PassArgFilter<AllowedPassArgs> > >
123
/// PassList(cl::desc("Passes available:"));
125
/// Only the -anders_aa and -dse options will be available to the user.
127
template<const char *Args>
128
class PassArgFilter {
130
bool operator()(const PassInfo &P) const {
131
return(std::strstr(Args, P.getPassArgument()));
135
} // End llvm namespace