1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
|
/* 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 "ray_hit_object_pass.h"
#include "containers/container_utils.h"
#include "module.h"
#include <spirv/unified1/spirv.hpp>
#include <iostream>
#include "generated/gpuav_offline_spirv.h"
namespace gpuav {
namespace spirv {
const static OfflineModule kOfflineModule = {instrumentation_ray_hit_object_comp, instrumentation_ray_hit_object_comp_size,
UseErrorPayloadVariable};
const static OfflineFunction kOfflineFunction = {"inst_ray_hit_object", instrumentation_ray_hit_object_comp_function_0_offset};
const static OfflineFunction kSBTIndexCheckFunction = {"inst_ray_hit_object_sbt_index_check", instrumentation_ray_hit_object_comp_function_1_offset};
RayHitObjectPass::RayHitObjectPass(Module& module) : Pass(module, kOfflineModule) { module.use_bda_ = true; }
uint32_t RayHitObjectPass::GetLinkFunctionId() { return GetLinkFunction(link_function_id_, kOfflineFunction); }
uint32_t RayHitObjectPass::GetSBTIndexCheckFunctionId() { return GetLinkFunction(sbt_index_check_function_id_, kSBTIndexCheckFunction); }
// OpHitObjectTraceRayEXT
// OpHitObjectTraceRayMotionEXT
// OpHitObjectTraceReorderExecuteEXT
// OpHitObjectTraceMotionReorderExecuteEXT
uint32_t RayHitObjectPass::CreateFunctionCall(BasicBlock& block, InstructionIt* inst_it, const InstructionMeta& meta) {
const uint32_t function_result = module_.TakeNextId();
const uint32_t function_def = GetLinkFunctionId();
const uint32_t bool_type = type_manager_.GetTypeBool().Id();
const uint32_t opcode = meta.target_instruction->Opcode();
// All HitObject opcodes have ray parameters at the same positions
const uint32_t ray_flags_id = meta.target_instruction->Operand(2);
const uint32_t ray_origin_id = meta.target_instruction->Operand(7);
const uint32_t ray_tmin_id = meta.target_instruction->Operand(8);
const uint32_t ray_direction_id = meta.target_instruction->Operand(9);
const uint32_t ray_tmax_id = meta.target_instruction->Operand(10);
uint32_t time_id = 0;
if (opcode == spv::OpHitObjectTraceRayMotionEXT || opcode == spv::OpHitObjectTraceMotionReorderExecuteEXT) {
time_id = meta.target_instruction->Operand(11);
}
const uint32_t inst_position = meta.target_instruction->GetPositionOffset();
const uint32_t inst_position_id = type_manager_.CreateConstantUInt32(inst_position).Id();
const uint32_t opcode_type_id = type_manager_.CreateConstantUInt32(opcode).Id();
const uint32_t pipeline_flags =
(module_.settings_.pipeline_has_skip_aabbs_flag ? 1u : 0u) |
(module_.settings_.pipeline_has_skip_triangles_flag ? 2u : 0u);
const uint32_t pipeline_flags_id = type_manager_.CreateConstantUInt32(pipeline_flags).Id();
// For non-motion opcodes, pass 0.0 as time (valid value, won't trigger error)
if (time_id == 0) {
time_id = type_manager_.GetConstantZeroFloat32().Id();
}
block.CreateInstruction(spv::OpFunctionCall,
{bool_type, function_result, function_def, inst_position_id, opcode_type_id, ray_flags_id, ray_origin_id, ray_tmin_id,
ray_direction_id, ray_tmax_id, pipeline_flags_id, time_id},
inst_it);
module_.need_log_error_ = true;
return function_result;
}
// OpHitObjectSetShaderBindingTableRecordIndexEXT
uint32_t RayHitObjectPass::CreateSBTIndexCheckFunctionCall(BasicBlock& block, InstructionIt* inst_it, const InstructionMeta& meta) {
const uint32_t function_result = module_.TakeNextId();
const uint32_t function_def = GetSBTIndexCheckFunctionId();
const uint32_t bool_type = type_manager_.GetTypeBool().Id();
const uint32_t sbt_index_id = meta.target_instruction->Operand(1);
const uint32_t inst_position = meta.target_instruction->GetPositionOffset();
const uint32_t inst_position_id = type_manager_.CreateConstantUInt32(inst_position).Id();
const uint32_t max_sbt_index_id = type_manager_.CreateConstantUInt32(module_.settings_.max_shader_binding_table_record_index).Id();
block.CreateInstruction(spv::OpFunctionCall,
{bool_type, function_result, function_def, inst_position_id, sbt_index_id, max_sbt_index_id},
inst_it);
module_.need_log_error_ = true;
return function_result;
}
bool RayHitObjectPass::RequiresInstrumentation(const Instruction& inst, InstructionMeta& meta) {
const spv::Op opcode = (spv::Op)inst.Opcode();
if (opcode == spv::OpHitObjectSetShaderBindingTableRecordIndexEXT) {
meta.target_instruction = &inst;
meta.is_sbt_index_check = true;
return true;
}
if (!IsValueIn(opcode, {spv::OpHitObjectTraceRayEXT, spv::OpHitObjectTraceReorderExecuteEXT, spv::OpHitObjectTraceRayMotionEXT,
spv::OpHitObjectTraceMotionReorderExecuteEXT})) {
return false;
}
meta.target_instruction = &inst;
meta.is_sbt_index_check = false;
return true;
}
bool RayHitObjectPass::Instrument() {
// Can safely loop function list as there is no injecting of new Functions until linking time
for (const auto& function : module_.functions_) {
if (function->instrumentation_added_) {
continue;
}
for (auto block_it = function->blocks_.begin(); block_it != function->blocks_.end(); ++block_it) {
BasicBlock& current_block = **block_it;
cf_.Update(current_block);
if (debug_disable_loops_ && cf_.in_loop) {
continue;
}
if (current_block.IsLoopHeader()) {
continue; // Currently can't properly handle injecting CFG logic into a loop header block
}
auto& block_instructions = current_block.instructions_;
for (auto inst_it = block_instructions.begin(); inst_it != block_instructions.end(); ++inst_it) {
InstructionMeta meta;
// Every instruction is analyzed by the specific pass and lets us know if we need to inject a function or not
if (!RequiresInstrumentation(*(inst_it->get()), meta)) {
continue;
}
if (IsMaxInstrumentationsCount()) {
continue;
}
instrumentations_count_++;
if (!module_.settings_.safe_mode) {
if (meta.is_sbt_index_check) {
CreateSBTIndexCheckFunctionCall(current_block, &inst_it, meta);
} else {
CreateFunctionCall(current_block, &inst_it, meta);
}
} else {
InjectConditionalData ic_data = InjectFunctionPre(*function.get(), block_it, inst_it);
if (meta.is_sbt_index_check) {
ic_data.function_result_id = CreateSBTIndexCheckFunctionCall(current_block, nullptr, meta);
} else {
ic_data.function_result_id = CreateFunctionCall(current_block, nullptr, meta);
}
InjectFunctionPost(current_block, ic_data);
// Skip the newly added valid and invalid block. Start searching again from newly split merge block
block_it++;
block_it++;
break;
}
}
}
}
return instrumentations_count_ != 0;
}
void RayHitObjectPass::PrintDebugInfo() const {
std::cout << "RayHitObjectPass instrumentation count: " << instrumentations_count_ << '\n';
}
} // namespace spirv
} // namespace gpuav
|
