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
|
/* Copyright (c) 2025 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 "mesh_shading_pass.h"
#include "module.h"
#include <cassert>
#include <spirv/unified1/spirv.hpp>
#include <iostream>
#include "generated/gpuav_offline_spirv.h"
namespace gpuav {
namespace spirv {
const static OfflineModule kOfflineModule = {instrumentation_mesh_shading_comp, instrumentation_mesh_shading_comp_size,
UseErrorPayloadVariable};
const static OfflineFunction kOfflineFunction = {"inst_set_mesh_output", instrumentation_mesh_shading_comp_function_0_offset};
MeshShading::MeshShading(Module& module) : Pass(module, kOfflineModule) {}
uint32_t MeshShading::GetLinkFunctionId() { return GetLinkFunction(link_function_id_, kOfflineFunction); }
uint32_t MeshShading::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 inst_position = meta.target_instruction->GetPositionOffset();
const uint32_t inst_position_id = type_manager_.CreateConstantUInt32(inst_position).Id();
const uint32_t bool_type = type_manager_.GetTypeBool().Id();
const uint32_t vertex_count = meta.target_instruction->Word(1);
const uint32_t primitive_count = meta.target_instruction->Word(2);
assert(output_vertices_id_ != 0 && output_primitives_id_ != 0);
block.CreateInstruction(spv::OpFunctionCall,
{bool_type, function_result, function_def, inst_position_id, vertex_count, primitive_count,
output_vertices_id_, output_primitives_id_},
inst_it);
module_.need_log_error_ = true;
return function_result;
}
bool MeshShading::RequiresInstrumentation(const Instruction& inst, InstructionMeta& meta) {
const uint32_t opcode = inst.Opcode();
if (opcode != spv::OpSetMeshOutputsEXT) {
return false;
}
meta.target_instruction = &inst;
return true;
}
bool MeshShading::Instrument() {
uint32_t mesh_entrypoint_id = 0;
for (const auto& entry_point_inst : module_.entry_points_) {
if (entry_point_inst->Word(1) == spv::ExecutionModelMeshEXT) {
if (mesh_entrypoint_id != 0) {
// TODO - Currently we have no good way to detect which entrypoint the instrumented instruction will be called from
module_.InternalWarning("MeshShading",
"Found 2 MeshEXT entrypoint, which is unsupported, skipping instrumentation.");
return false;
}
mesh_entrypoint_id = entry_point_inst->Word(2);
}
}
if (mesh_entrypoint_id == 0) {
return false; // no mesh shader
}
// Note - OpExecutionModeId can't be used if the extra operands are marked as "literal"
for (const auto& execution_mode_inst : module_.execution_modes_) {
if (execution_mode_inst->Word(1) != mesh_entrypoint_id) {
continue;
}
const spv::ExecutionMode mode = (spv::ExecutionMode)execution_mode_inst->Word(2);
if (mode == spv::ExecutionModeOutputVertices) {
output_vertices_id_ = type_manager_.CreateConstantUInt32(execution_mode_inst->Word(3)).Id();
} else if (mode == spv::ExecutionModeOutputPrimitivesEXT) {
output_primitives_id_ = type_manager_.CreateConstantUInt32(execution_mode_inst->Word(3)).Id();
}
}
// 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) {
CreateFunctionCall(current_block, &inst_it, meta);
} else {
InjectConditionalData ic_data = InjectFunctionPre(*function.get(), block_it, inst_it);
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 MeshShading::PrintDebugInfo() const { std::cout << "MeshShading instrumentation count: " << instrumentations_count_ << '\n'; }
} // namespace spirv
} // namespace gpuav
|