diff options
| -rw-r--r-- | mlir/include/mlir/Pass/PassOptions.h | 97 | ||||
| -rw-r--r-- | mlir/include/mlir/Pass/PassRegistry.h | 68 |
2 files changed, 98 insertions, 67 deletions
diff --git a/mlir/include/mlir/Pass/PassOptions.h b/mlir/include/mlir/Pass/PassOptions.h new file mode 100644 index 00000000000..eabfa73a1b6 --- /dev/null +++ b/mlir/include/mlir/Pass/PassOptions.h @@ -0,0 +1,97 @@ +//===- PassOptions.h - Pass Option Utilities --------------------*- C++ -*-===// +// +// Copyright 2019 The MLIR Authors. +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// ============================================================================= +// +// This file contains utilities for registering options with compiler passes and +// pipelines. +// +//===----------------------------------------------------------------------===// + +#ifndef MLIR_PASS_PASSOPTIONS_H_ +#define MLIR_PASS_PASSOPTIONS_H_ + +#include "mlir/Support/LLVM.h" +#include "mlir/Support/LogicalResult.h" +#include "mlir/Support/STLExtras.h" +#include "llvm/ADT/StringRef.h" +#include "llvm/Support/CommandLine.h" +#include "llvm/Support/Compiler.h" +#include <memory> + +namespace mlir { +namespace detail { +/// Base class for PassOptions<T> that holds all of the non-CRTP features. +class PassOptionsBase : protected llvm::cl::SubCommand { +public: + /// This class represents a specific pass option, with a provided data type. + template <typename DataType> struct Option : public llvm::cl::opt<DataType> { + template <typename... Args> + Option(PassOptionsBase &parent, StringRef arg, Args &&... args) + : llvm::cl::opt<DataType>(arg, llvm::cl::sub(parent), + std::forward<Args>(args)...) { + assert(!this->isPositional() && !this->isSink() && + "sink and positional options are not supported"); + } + }; + + /// This class represents a specific pass option that contains a list of + /// values of the provided data type. + template <typename DataType> struct List : public llvm::cl::list<DataType> { + template <typename... Args> + List(PassOptionsBase &parent, StringRef arg, Args &&... args) + : llvm::cl::list<DataType>(arg, llvm::cl::sub(parent), + std::forward<Args>(args)...) { + assert(!this->isPositional() && !this->isSink() && + "sink and positional options are not supported"); + } + }; + + /// Parse options out as key=value pairs that can then be handed off to the + /// `llvm::cl` command line passing infrastructure. Everything is space + /// separated. + LogicalResult parseFromString(StringRef options); +}; +} // end namespace detail + +/// Subclasses of PassOptions provide a set of options that can be used to +/// initialize a pass instance. See PassRegistration for usage details. +/// +/// Usage: +/// +/// struct MyPassOptions : PassOptions<MyPassOptions> { +/// List<int> someListFlag{ +/// *this, "flag-name", llvm::cl::MiscFlags::CommaSeparated, +/// llvm::cl::desc("...")}; +/// }; +template <typename T> class PassOptions : public detail::PassOptionsBase { +public: + /// Factory that parses the provided options and returns a unique_ptr to the + /// struct. + static std::unique_ptr<T> createFromString(StringRef options) { + auto result = std::make_unique<T>(); + if (failed(result->parseFromString(options))) + return nullptr; + return result; + } +}; + +/// A default empty option struct to be used for passes that do not need to take +/// any options. +struct EmptyPassOptions : public PassOptions<EmptyPassOptions> {}; + +} // end namespace mlir + +#endif // MLIR_PASS_PASSOPTIONS_H_ diff --git a/mlir/include/mlir/Pass/PassRegistry.h b/mlir/include/mlir/Pass/PassRegistry.h index 356b13ec2f9..deb80ef765e 100644 --- a/mlir/include/mlir/Pass/PassRegistry.h +++ b/mlir/include/mlir/Pass/PassRegistry.h @@ -23,14 +23,8 @@ #ifndef MLIR_PASS_PASSREGISTRY_H_ #define MLIR_PASS_PASSREGISTRY_H_ -#include "mlir/Support/LLVM.h" -#include "mlir/Support/LogicalResult.h" -#include "mlir/Support/STLExtras.h" -#include "llvm/ADT/StringRef.h" -#include "llvm/Support/CommandLine.h" -#include "llvm/Support/Compiler.h" +#include "mlir/Pass/PassOptions.h" #include <functional> -#include <memory> namespace mlir { class OpPassManager; @@ -118,66 +112,6 @@ void registerPass(StringRef arg, StringRef description, const PassID *passID, const PassRegistryFunction &function); namespace detail { -/// Base class for PassOptions<T> that holds all of the non-CRTP features. -class PassOptionsBase : protected llvm::cl::SubCommand { -public: - /// This class represents a specific pass option, with a provided data type. - template <typename DataType> struct Option : public llvm::cl::opt<DataType> { - template <typename... Args> - Option(PassOptionsBase &parent, StringRef arg, Args &&... args) - : llvm::cl::opt<DataType>(arg, llvm::cl::sub(parent), - std::forward<Args>(args)...) { - assert(!this->isPositional() && !this->isSink() && - "sink and positional options are not supported"); - } - }; - - /// This class represents a specific pass option that contains a list of - /// values of the provided data type. - template <typename DataType> struct List : public llvm::cl::list<DataType> { - template <typename... Args> - List(PassOptionsBase &parent, StringRef arg, Args &&... args) - : llvm::cl::list<DataType>(arg, llvm::cl::sub(parent), - std::forward<Args>(args)...) { - assert(!this->isPositional() && !this->isSink() && - "sink and positional options are not supported"); - } - }; - - /// Parse options out as key=value pairs that can then be handed off to the - /// `llvm::cl` command line passing infrastructure. Everything is space - /// separated. - LogicalResult parseFromString(StringRef options); -}; -} // end namespace detail - -/// Subclasses of PassOptions provide a set of options that can be used to -/// initialize a pass instance. See PassRegistration for usage details. -/// -/// Usage: -/// -/// struct MyPassOptions : PassOptions<MyPassOptions> { -/// List<int> someListFlag{ -/// *this, "flag-name", llvm::cl::MiscFlags::CommaSeparated, -/// llvm::cl::desc("...")}; -/// }; -template <typename T> class PassOptions : public detail::PassOptionsBase { -public: - /// Factory that parses the provided options and returns a unique_ptr to the - /// struct. - static std::unique_ptr<T> createFromString(StringRef options) { - auto result = std::make_unique<T>(); - if (failed(result->parseFromString(options))) - return nullptr; - return result; - } -}; - -/// A default empty option struct to be used for passes that do not need to take -/// any options. -struct EmptyPassOptions : public PassOptions<EmptyPassOptions> {}; - -namespace detail { // Calls `pm.addPass(std::move(pass))` to avoid including the PassManager // header. Only used in `makePassRegistryFunction`. |
