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
|
/* Copyright (c) 2024-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.
*/
#pragma once
#include <stdint.h>
#include "pass.h"
namespace gpuav {
namespace spirv {
// Create a pass to instrument descriptor indexing.
// This pass makes sure any index into an descriptor array is not OOB or uninitialized
class DescriptorIndexingOOBPass : public Pass {
public:
DescriptorIndexingOOBPass(Module& module);
const char* Name() const final { return "DescriptorIndexingOOBPass"; }
bool Instrument() final;
void PrintDebugInfo() const final;
private:
// This is metadata tied to a single instruction gathered during RequiresInstrumentation() to be used later
struct InstructionMeta {
const Instruction* target_instruction = nullptr;
const Instruction* var_inst = nullptr;
const Instruction* image_inst = nullptr;
uint32_t descriptor_set = 0;
uint32_t descriptor_binding = 0;
uint32_t descriptor_index_id = 0;
bool is_combined_image_sampler = false;
// Duplicate values if dealing with SAMPLED_IMAGE and SAMPLER together
const Instruction* sampler_var_inst = nullptr;
uint32_t sampler_descriptor_set = 0;
uint32_t sampler_descriptor_binding = 0;
uint32_t sampler_descriptor_index_id = 0;
};
bool RequiresInstrumentation(const Function& function, const Instruction& inst, InstructionMeta& meta);
uint32_t CreateFunctionCall(BasicBlock& block, InstructionIt* inst_it, const InstructionMeta& meta);
uint32_t GetLinkFunctionId(bool is_combined_image_sampler);
// < original ID, new CopyObject ID >
vvl::unordered_map<uint32_t, uint32_t> copy_object_map_;
// If the shader has a 'imageArray[]' the OpVariable will point to 'imageArray' then we only need to check (in unsafe mode) each
// index into it once to see if the descriptor is valid or not . We marks which variables were already instrumented
// < Variable ID, [descriptor index IDs accessed with this variable >
vvl::unordered_map<uint32_t, vvl::unordered_set<uint32_t>> block_instrumented_table_;
// Function IDs to link in
uint32_t link_bindless_id_ = 0;
uint32_t link_bindless_combined_image_sampler_id_ = 0;
uint32_t link_non_bindless_id_ = 0;
};
} // namespace spirv
} // namespace gpuav
|