blob: 9686dddc269ab9f2d1dab870d57c3e663055680e [file] [log] [blame]
// Copyright (c) 2016 Google Inc.
// 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
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// See the License for the specific language governing permissions and
// limitations under the License.
#include <memory>
#include <ostream>
#include <utility>
#include <vector>
#include "source/opt/log.h"
#include "source/opt/module.h"
#include "source/opt/pass.h"
#include "source/opt/ir_context.h"
#include "spirv-tools/libspirv.hpp"
namespace spvtools {
namespace opt {
// The pass manager, responsible for tracking and running passes.
// Clients should first call AddPass() to add passes and then call Run()
// to run on a module. Passes are executed in the exact order of addition.
class PassManager {
// Constructs a pass manager.
// The constructed instance will have an empty message consumer, which just
// ignores all messages from the library. Use SetMessageConsumer() to supply
// one if messages are of concern.
: consumer_(nullptr),
validate_after_all_(false) {}
// Sets the message consumer to the given |consumer|.
void SetMessageConsumer(MessageConsumer c) { consumer_ = std::move(c); }
// Adds an externally constructed pass.
void AddPass(std::unique_ptr<Pass> pass);
// Uses the argument |args| to construct a pass instance of type |T|, and adds
// the pass instance to this pass manger. The pass added will use this pass
// manager's message consumer.
template <typename T, typename... Args>
void AddPass(Args&&... args);
// Returns the number of passes added.
uint32_t NumPasses() const;
// Returns a pointer to the |index|th pass added.
inline Pass* GetPass(uint32_t index) const;
// Returns the message consumer.
inline const MessageConsumer& consumer() const;
// Runs all passes on the given |module|. Returns Status::Failure if errors
// occur when processing using one of the registered passes. All passes
// registered after the error-reporting pass will be skipped. Returns the
// corresponding Status::Success if processing is succesful to indicate
// whether changes are made to the module.
// After running all the passes, they are removed from the list.
Pass::Status Run(IRContext* context);
// Sets the option to print the disassembly before each pass and after the
// last pass. Output is written to |out| if that is not null. No output
// is generated if |out| is null.
PassManager& SetPrintAll(std::ostream* out) {
print_all_stream_ = out;
return *this;
// Sets the option to print the resource utilization of each pass. Output is
// written to |out| if that is not null. No output is generated if |out| is
// null.
PassManager& SetTimeReport(std::ostream* out) {
time_report_stream_ = out;
return *this;
// Sets the target environment for validation.
PassManager& SetTargetEnv(spv_target_env env) {
target_env_ = env;
return *this;
// Sets the validation options.
PassManager& SetValidatorOptions(spv_validator_options options) {
val_options_ = options;
return *this;
// Sets the option to validate after each pass.
PassManager& SetValidateAfterAll(bool validate) {
validate_after_all_ = validate;
return *this;
// Consumer for messages.
MessageConsumer consumer_;
// A vector of passes. Order matters.
std::vector<std::unique_ptr<Pass>> passes_;
// The output stream to write disassembly to before each pass, and after
// the last pass. If this is null, no output is generated.
std::ostream* print_all_stream_;
// The output stream to write the resource utilization of each pass. If this
// is null, no output is generated.
std::ostream* time_report_stream_;
// The target environment.
spv_target_env target_env_;
// The validator options (used when validating each pass).
spv_validator_options val_options_;
// Controls whether validation occurs after every pass.
bool validate_after_all_;
inline void PassManager::AddPass(std::unique_ptr<Pass> pass) {
template <typename T, typename... Args>
inline void PassManager::AddPass(Args&&... args) {
passes_.emplace_back(new T(std::forward<Args>(args)...));
inline uint32_t PassManager::NumPasses() const {
return static_cast<uint32_t>(passes_.size());
inline Pass* PassManager::GetPass(uint32_t index) const {
SPIRV_ASSERT(consumer_, index < passes_.size(), "index out of bound");
return passes_[index].get();
inline const MessageConsumer& PassManager::consumer() const {
return consumer_;
} // namespace opt
} // namespace spvtools