mirror of
https://github.com/KhronosGroup/SPIRV-Tools
synced 2024-10-18 11:10:05 +00:00
7fa9e746ef
spirv-diff is a new tool that produces diff-style output comparing two SPIR-V modules. The instructions between the src and dst modules are matched as best as the tool can, and output is produced (in src id-space) that shows which instructions are removed in src, added in dst or modified between them. The order of instructions are not retained. Matching instructions between two SPIR-V modules is not trivial, and thus a number of heuristics are applied in this tool. In particular, without debug information, it's hard to match functions as they can be reordered. As such, this tool is primarily useful to produce the diff of two SPIR-V modules derived from the same source. This tool can be useful in a number of scenarios: - Compare the SPIR-V before and after modifying a shader - Compare the SPIR-V produced from a shader before and after compiler codegen changes. - Compare the SPIR-V produced from a shader before and after some transformation or optimization. - Compare the SPIR-V produced from a shader with different compilers.
49 lines
1.7 KiB
C++
49 lines
1.7 KiB
C++
// Copyright (c) 2022 Google LLC.
|
|
//
|
|
// 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.
|
|
|
|
#ifndef SOURCE_DIFF_DIFF_H_
|
|
#define SOURCE_DIFF_DIFF_H_
|
|
|
|
#include "source/opt/ir_context.h"
|
|
|
|
namespace spvtools {
|
|
namespace diff {
|
|
|
|
struct Options {
|
|
bool ignore_set_binding = false;
|
|
bool ignore_location = false;
|
|
bool indent = false;
|
|
bool no_header = false;
|
|
bool color_output = false;
|
|
bool dump_id_map = false;
|
|
};
|
|
|
|
// Given two SPIR-V modules, this function outputs the textual diff of their
|
|
// assembly in `out`. The diff is *semantic*, so that the ordering of certain
|
|
// instructions wouldn't matter.
|
|
//
|
|
// The output is a disassembly of src, with diff(1)-style + and - lines that
|
|
// show how the src is changed into dst. To make this disassembly
|
|
// self-consistent, the ids that are output are all in the space of the src
|
|
// module; e.g. any + lines (showing instructions from the dst module) have
|
|
// their ids mapped to the matched instruction in the src module (or a new id
|
|
// allocated in the src module if unmatched).
|
|
spv_result_t Diff(opt::IRContext* src, opt::IRContext* dst, std::ostream& out,
|
|
Options options);
|
|
|
|
} // namespace diff
|
|
} // namespace spvtools
|
|
|
|
#endif // SOURCE_DIFF_DIFF_H_
|