| /* Copyright (c) 2024-2026 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. |
| */ |
| |
| #include "generated/spirv_grammar_helper.h" |
| #include "gpuav/core/gpuav.h" |
| #include "gpuav/resources/gpuav_state_trackers.h" |
| #include "gpuav/shaders/gpuav_error_codes.h" |
| #include "gpuav/shaders/gpuav_error_header.h" |
| |
| namespace gpuav { |
| |
| void RegisterTraceRayValidation(Validator& gpuav, CommandBufferSubState& cb) { |
| if (!gpuav.gpuav_settings.shader_instrumentation.trace_ray) { |
| return; |
| } |
| |
| cb.on_instrumentation_error_logger_register_functions.emplace_back( |
| [](Validator& gpuav, CommandBufferSubState& cb, const LastBound& last_bound) { |
| CommandBufferSubState::InstrumentationErrorLogger inst_error_logger = |
| [](Validator& gpuav, const Location& loc, const uint32_t* error_record, const InstrumentedShader*, |
| std::string& out_error_msg, std::string& out_vuid_msg) { |
| using namespace glsl; |
| bool error_found = false; |
| if (GetErrorGroup(error_record) != kErrorGroup_TraceRay) { |
| return error_found; |
| } |
| error_found = true; |
| |
| std::ostringstream strm; |
| |
| const uint32_t error_sub_code = GetSubError(error_record); |
| const uint32_t opcode = error_record[kInst_LogError_ParameterOffset_2]; |
| |
| switch (error_sub_code) { |
| case kErrorSubCode_RayHitObject_NegativeMin: { |
| // Should use std::bit_cast but requires c++20 |
| const float tmin = *(float*)(error_record + kInst_LogError_ParameterOffset_0); |
| strm << string_SpvOpcode(opcode) << " operand Ray Tmin value (" << tmin << ") is negative. "; |
| out_vuid_msg = "VUID-RuntimeSpirv-OpHitObjectTraceRayEXT-11879"; |
| } break; |
| case kErrorSubCode_RayHitObject_NegativeMax: { |
| const float tmax = *(float*)(error_record + kInst_LogError_ParameterOffset_0); |
| strm << string_SpvOpcode(opcode) << " operand Ray Tmax value (" << tmax << ") is negative. "; |
| out_vuid_msg = "VUID-RuntimeSpirv-OpHitObjectTraceRayEXT-11879"; |
| } break; |
| case kErrorSubCode_RayHitObject_MinMax: { |
| const float tmin = *(float*)(error_record + kInst_LogError_ParameterOffset_0); |
| const float tmax = *(float*)(error_record + kInst_LogError_ParameterOffset_1); |
| strm << string_SpvOpcode(opcode) << " operand Ray Tmax (" << tmax << ") is less than Ray Tmin (" << tmin |
| << "). "; |
| out_vuid_msg = "VUID-RuntimeSpirv-OpHitObjectTraceRayEXT-11880"; |
| } break; |
| case kErrorSubCode_RayHitObject_MinNaN: { |
| strm << string_SpvOpcode(opcode) << " operand Ray Tmin is NaN. "; |
| out_vuid_msg = "VUID-RuntimeSpirv-OpHitObjectTraceRayEXT-11881"; |
| } break; |
| case kErrorSubCode_RayHitObject_MaxNaN: { |
| strm << string_SpvOpcode(opcode) << " operand Ray Tmax is NaN. "; |
| out_vuid_msg = "VUID-RuntimeSpirv-OpHitObjectTraceRayEXT-11881"; |
| } break; |
| case kErrorSubCode_RayHitObject_OriginNaN: { |
| strm << string_SpvOpcode(opcode) << " operand Ray Origin contains a NaN. "; |
| out_vuid_msg = "VUID-RuntimeSpirv-OpHitObjectTraceRayEXT-11881"; |
| } break; |
| case kErrorSubCode_RayHitObject_DirectionNaN: { |
| strm << string_SpvOpcode(opcode) << " operand Ray Direction contains a NaN. "; |
| out_vuid_msg = "VUID-RuntimeSpirv-OpHitObjectTraceRayEXT-11881"; |
| } break; |
| case kErrorSubCode_RayHitObject_OriginFinite: { |
| strm << string_SpvOpcode(opcode) << " operand Ray Origin contains a non-finite value. "; |
| out_vuid_msg = "VUID-RuntimeSpirv-OpHitObjectTraceRayEXT-11878"; |
| } break; |
| case kErrorSubCode_RayHitObject_DirectionFinite: { |
| strm << string_SpvOpcode(opcode) << " operand Ray Direction contains a non-finite value. "; |
| out_vuid_msg = "VUID-RuntimeSpirv-OpHitObjectTraceRayEXT-11878"; |
| } break; |
| case kErrorSubCode_RayHitObject_BothSkip: { |
| const uint32_t value = error_record[kInst_LogError_ParameterOffset_0]; |
| strm << string_SpvOpcode(opcode) << " operand Ray Flags is 0x" << std::hex << value << ". "; |
| out_vuid_msg = "VUID-RuntimeSpirv-OpHitObjectTraceRayEXT-11883"; |
| } break; |
| case kErrorSubCode_RayHitObject_SkipCull: { |
| const uint32_t value = error_record[kInst_LogError_ParameterOffset_0]; |
| strm << string_SpvOpcode(opcode) << " operand Ray Flags is 0x" << std::hex << value << ". "; |
| out_vuid_msg = "VUID-RuntimeSpirv-OpHitObjectTraceRayEXT-11884"; |
| } break; |
| case kErrorSubCode_RayHitObject_Opaque: { |
| const uint32_t value = error_record[kInst_LogError_ParameterOffset_0]; |
| strm << string_SpvOpcode(opcode) << " operand Ray Flags is 0x" << std::hex << value << ". "; |
| out_vuid_msg = "VUID-RuntimeSpirv-OpHitObjectTraceRayEXT-11885"; |
| } break; |
| case kErrorSubCode_RayHitObject_SkipTrianglesWithPipelineSkipAABBs: { |
| const uint32_t value = error_record[kInst_LogError_ParameterOffset_0]; |
| strm << string_SpvOpcode(opcode) << " operand Ray Flags (0x" << std::hex << value |
| << ") contains SkipTrianglesKHR, but pipeline was created with " |
| "VK_PIPELINE_CREATE_RAY_TRACING_SKIP_AABBS_BIT_KHR. "; |
| out_vuid_msg = "VUID-RuntimeSpirv-OpHitObjectTraceRayEXT-11886"; |
| } break; |
| case kErrorSubCode_RayHitObject_SkipAABBsWithPipelineSkipTriangles: { |
| const uint32_t value = error_record[kInst_LogError_ParameterOffset_0]; |
| strm << string_SpvOpcode(opcode) << " operand Ray Flags (0x" << std::hex << value |
| << ") contains SkipAABBsKHR, but pipeline was created with " |
| "VK_PIPELINE_CREATE_RAY_TRACING_SKIP_TRIANGLES_BIT_KHR. "; |
| out_vuid_msg = "VUID-RuntimeSpirv-OpHitObjectTraceRayEXT-11887"; |
| } break; |
| case kErrorSubCode_RayHitObject_TimeOutOfRange: { |
| strm << string_SpvOpcode(opcode) << " operand time is not between 0.0 and 1.0. "; |
| out_vuid_msg = "VUID-RuntimeSpirv-OpHitObjectTraceRayEXT-11882"; |
| } break; |
| case kErrorSubCode_RayHitObject_SBTIndexExceedsLimit: { |
| // For this case, param_0 contains the SBT index and opcode_type slot contains the max SBT index |
| const uint32_t sbt_index = error_record[kInst_LogError_ParameterOffset_0]; |
| const uint32_t max_sbt_index = error_record[kInst_LogError_ParameterOffset_1]; |
| strm << "OpHitObjectSetShaderBindingTableRecordIndexEXT SBT index (" << std::dec << sbt_index |
| << ") exceeds " |
| "VkPhysicalDeviceRayTracingInvocationReorderPropertiesEXT::maxShaderBindingTableRecordIndex (" |
| << max_sbt_index << "). "; |
| out_vuid_msg = "VUID-RuntimeSpirv-maxShaderBindingTableRecordIndex-11888"; |
| } break; |
| case kErrorSubCode_TraceRay_TrianglesFlags: { |
| const uint32_t ray_flags = error_record[kInst_LogError_ParameterOffset_0]; |
| strm << "OpTraceRayKHR operand Ray Flags (" << string_SpvRayFlagsMask(ray_flags) |
| << ") form an invalid combination of mutually exclusive flags."; |
| out_vuid_msg = "VUID-RuntimeSpirv-OpTraceRayKHR-06892"; |
| } break; |
| case kErrorSubCode_TraceRay_OpaqueFlags: { |
| const uint32_t ray_flags = error_record[kInst_LogError_ParameterOffset_0]; |
| strm << "OpTraceRayKHR operand Ray Flags (" << string_SpvRayFlagsMask(ray_flags) |
| << ") form an invalid combination of mutually exclusive flags."; |
| out_vuid_msg = "VUID-RuntimeSpirv-OpTraceRayKHR-06893"; |
| } break; |
| case kErrorSubCode_TraceRay_BothSkip: { |
| const uint32_t ray_flags = error_record[kInst_LogError_ParameterOffset_0]; |
| strm << "OpTraceRayKHR operand Ray Flags (" << string_SpvRayFlagsMask(ray_flags) |
| << ") form an invalid combination of mutually exclusive flags."; |
| out_vuid_msg = "VUID-RuntimeSpirv-OpTraceRayKHR-06552"; |
| } break; |
| case kErrorSubCode_TraceRay_OriginNaNOrInf: { |
| const float ray_origin_x = *(float*)(error_record + kInst_LogError_ParameterOffset_0); |
| const float ray_origin_y = *(float*)(error_record + kInst_LogError_ParameterOffset_1); |
| const float ray_origin_z = *(float*)(error_record + kInst_LogError_ParameterOffset_2); |
| strm << "OpTraceRayKHR operand Ray Origin (" << ray_origin_x << ", " << ray_origin_y << ", " |
| << ray_origin_z << ") has a component with non-finite floating-point value."; |
| out_vuid_msg = "VUID-RuntimeSpirv-OpTraceRayKHR-06355"; |
| } break; |
| case kErrorSubCode_TraceRay_DirectionNaNOrInf: { |
| const float ray_direction_x = *(float*)(error_record + kInst_LogError_ParameterOffset_0); |
| const float ray_direction_y = *(float*)(error_record + kInst_LogError_ParameterOffset_1); |
| const float ray_direction_z = *(float*)(error_record + kInst_LogError_ParameterOffset_2); |
| strm << "OpTraceRayKHR operand Ray Direction (" << ray_direction_x << ", " << ray_direction_y << ", " |
| << ray_direction_z << ") has a component with non-finite floating-point value."; |
| out_vuid_msg = "VUID-RuntimeSpirv-OpTraceRayKHR-06355"; |
| } break; |
| case kErrorSubCode_TraceRay_TNegative: { |
| const float t_min = *(float*)(error_record + kInst_LogError_ParameterOffset_0); |
| const float t_max = *(float*)(error_record + kInst_LogError_ParameterOffset_1); |
| strm << "OpTraceRayKHR operand Ray Tmin or Ray Tmax is negative (Tmin: " << t_min << ", Tmax: " << t_max |
| << ")."; |
| out_vuid_msg = "VUID-RuntimeSpirv-OpTraceRayKHR-06356"; |
| } break; |
| case kErrorSubCode_TraceRay_TMaxLessThanTMin: { |
| const float t_min = *(float*)(error_record + kInst_LogError_ParameterOffset_0); |
| const float t_max = *(float*)(error_record + kInst_LogError_ParameterOffset_1); |
| strm << "OpTraceRayKHR operand Ray Tmin (" << t_min << ") is greater than Ray Tmax (" << t_max << ")."; |
| out_vuid_msg = "VUID-RuntimeSpirv-OpTraceRayKHR-06357"; |
| } break; |
| case kErrorSubCode_TraceRay_RayParametersNans: { |
| const float t_min = *(float*)(error_record + kInst_LogError_ParameterOffset_0); |
| const float t_max = *(float*)(error_record + kInst_LogError_ParameterOffset_1); |
| strm << "OpTraceRayKHR operand Ray Tmin (" << t_min << ") or Ray Tmax (" << t_max << ") are NaNs."; |
| out_vuid_msg = "VUID-RuntimeSpirv-OpTraceRayKHR-06358"; |
| } break; |
| default: |
| error_found = false; |
| break; |
| } |
| out_error_msg += strm.str(); |
| return error_found; |
| }; |
| |
| return inst_error_logger; |
| }); |
| } |
| |
| } // namespace gpuav |
