| // Copyright (c) 2018 The Khronos Group Inc. |
| // Copyright (c) 2018 Valve Corporation |
| // Copyright (c) 2018 LunarG 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. |
| |
| #ifndef INCLUDE_SPIRV_TOOLS_INSTRUMENT_HPP_ |
| #define INCLUDE_SPIRV_TOOLS_INSTRUMENT_HPP_ |
| |
| // Shader Instrumentation Interface |
| // |
| // This file provides an external interface for applications that wish to |
| // communicate with shaders instrumented by passes created by: |
| // |
| // CreateInstBindlessCheckPass |
| // CreateInstBuffAddrCheckPass |
| // CreateInstDebugPrintfPass |
| // |
| // More detailed documentation of these routines can be found in optimizer.hpp |
| |
| namespace spvtools { |
| |
| // Stream Output Buffer Offsets |
| // |
| // The following values provide offsets into the output buffer struct |
| // generated by InstrumentPass::GenDebugStreamWrite. This method is utilized |
| // by InstBindlessCheckPass, InstBuffAddrCheckPass, and InstDebugPrintfPass. |
| // |
| // The 1st member of the debug output buffer contains a set of flags |
| // controlling the behavior of instrumentation code. |
| static const int kDebugOutputFlagsOffset = 0; |
| |
| // Values stored at kDebugOutputFlagsOffset |
| enum kInstFlags : unsigned int { |
| kInstBufferOOBEnable = 0x1, |
| }; |
| |
| // The 2nd member of the debug output buffer contains the next available word |
| // in the data stream to be written. Shaders will atomically read and update |
| // this value so as not to overwrite each others records. This value must be |
| // initialized to zero |
| static const int kDebugOutputSizeOffset = 1; |
| |
| // The 3rd member of the output buffer is the start of the stream of records |
| // written by the instrumented shaders. Each record represents a validation |
| // error. The format of the records is documented below. |
| static const int kDebugOutputDataOffset = 2; |
| |
| // Common Stream Record Offsets |
| // |
| // The following are offsets to fields which are common to all records written |
| // to the output stream. |
| // |
| // Each record first contains the size of the record in 32-bit words, including |
| // the size word. |
| static const int kInstCommonOutSize = 0; |
| |
| // This is the shader id passed by the layer when the instrumentation pass is |
| // created. |
| static const int kInstCommonOutShaderId = 1; |
| |
| // This is the ordinal position of the instruction within the SPIR-V shader |
| // which generated the validation error. |
| static const int kInstCommonOutInstructionIdx = 2; |
| |
| // Debug Buffer Bindings |
| // |
| // These are the bindings for the different buffers which are |
| // read or written by the instrumentation passes. |
| // |
| // This is the output buffer written by InstDebugPrintfPass. |
| static const int kDebugOutputPrintfStream = 3; |
| |
| } // namespace spvtools |
| |
| #endif // INCLUDE_SPIRV_TOOLS_INSTRUMENT_HPP_ |
