SPIRV-Tools/source/opt/pass_manager.cpp
Nathan Gauër 0ebcdc4d19
Allow spirv-opt print-all to show pretty IDs (#4888)
Disassembler was called with non-default params, loosing FRIENDLY_NAMES.
This commit changes the call options to allow the spirv-opt to show
friendly names instead of raw-ids. Might be more helpful when reading
the SPIRV-opt output.

Fixes #4882

Signed-off-by: Nathan Gauër <brioche@google.com>
2022-08-09 14:10:36 -04:00

94 lines
3.3 KiB
C++

// 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
//
// 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.
#include "source/opt/pass_manager.h"
#include <iostream>
#include <string>
#include <vector>
#include "source/opt/ir_context.h"
#include "source/util/timer.h"
#include "spirv-tools/libspirv.hpp"
namespace spvtools {
namespace opt {
Pass::Status PassManager::Run(IRContext* context) {
auto status = Pass::Status::SuccessWithoutChange;
// If print_all_stream_ is not null, prints the disassembly of the module
// to that stream, with the given preamble and optionally the pass name.
auto print_disassembly = [&context, this](const char* preamble, Pass* pass) {
if (print_all_stream_) {
std::vector<uint32_t> binary;
context->module()->ToBinary(&binary, false);
SpirvTools t(target_env_);
t.SetMessageConsumer(consumer());
std::string disassembly;
std::string pass_name = (pass ? pass->name() : "");
if (!t.Disassemble(binary, &disassembly)) {
std::string msg = "Disassembly failed before pass ";
msg += pass_name + "\n";
spv_position_t null_pos{0, 0, 0};
consumer()(SPV_MSG_WARNING, "", null_pos, msg.c_str());
return;
}
*print_all_stream_ << preamble << pass_name << "\n"
<< disassembly << std::endl;
}
};
SPIRV_TIMER_DESCRIPTION(time_report_stream_, /* measure_mem_usage = */ true);
for (auto& pass : passes_) {
print_disassembly("; IR before pass ", pass.get());
SPIRV_TIMER_SCOPED(time_report_stream_, (pass ? pass->name() : ""), true);
const auto one_status = pass->Run(context);
if (one_status == Pass::Status::Failure) return one_status;
if (one_status == Pass::Status::SuccessWithChange) status = one_status;
if (validate_after_all_) {
spvtools::SpirvTools tools(target_env_);
tools.SetMessageConsumer(consumer());
std::vector<uint32_t> binary;
context->module()->ToBinary(&binary, true);
if (!tools.Validate(binary.data(), binary.size(), val_options_)) {
std::string msg = "Validation failed after pass ";
msg += pass->name();
spv_position_t null_pos{0, 0, 0};
consumer()(SPV_MSG_INTERNAL_ERROR, "", null_pos, msg.c_str());
return Pass::Status::Failure;
}
}
// Reset the pass to free any memory used by the pass.
pass.reset(nullptr);
}
print_disassembly("; IR after last pass", nullptr);
// Set the Id bound in the header in case a pass forgot to do so.
//
// TODO(dnovillo): This should be unnecessary and automatically maintained by
// the IRContext.
if (status == Pass::Status::SuccessWithChange) {
context->module()->SetIdBound(context->module()->ComputeIdBound());
}
passes_.clear();
return status;
}
} // namespace opt
} // namespace spvtools