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
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
|
/* 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 <cstdint>
#include <vector>
#include <memory>
#include "containers/custom_containers.h"
#include "state_tracker/shader_instruction.h"
#include "generated/spirv_grammar_helper.h"
namespace gpuav {
namespace spirv {
using Instruction = ::spirv::Instruction;
class Module;
class TypeManager;
// These are the constant operations that we plan to handle in for shader instrumentation
static constexpr bool ConstantOperation(uint32_t opcode) {
switch (opcode) {
case spv::OpConstant:
case spv::OpConstantTrue:
case spv::OpConstantFalse:
case spv::OpConstantComposite:
case spv::OpConstantNull:
return true;
// Using a spec constant is bad as we might alias the value and have it change on use at pipeline creation time
case spv::OpSpecConstant:
case spv::OpSpecConstantTrue:
case spv::OpSpecConstantFalse:
case spv::OpSpecConstantComposite:
case spv::OpSpecConstantOp: // always must be in function block
default:
return false;
}
}
// There is a LOT that can be done with types, but for simplicity it only does what is needed.
// The main thing is to try find the type so we don't add a duplicate (but not end of the world if 1 or 2 are duplicated as a
// trade-off to doing complex logic to resolve more complex types). The class also takes advantage that while Instrumenting we are
// always aware of our types we are adding or just explictly found.
struct Type {
Type(SpvType spv_type, const Instruction& inst) : spv_type_(spv_type), inst_(inst) {}
bool operator==(Type const& other) const;
uint32_t Id() const { return inst_.ResultId(); }
// Helpers to detect what the type is
bool IsArray() const;
bool IsSignedInt() const;
bool IsIVec3(const TypeManager& type_manager) const;
const SpvType spv_type_;
const Instruction& inst_;
};
static bool IsSpecConstant(uint32_t opcode) {
return opcode == spv::OpSpecConstant || opcode == spv::OpSpecConstantTrue || opcode == spv::OpSpecConstantFalse ||
opcode == spv::OpSpecConstantComposite || opcode == spv::OpSpecConstantOp;
}
// Represents a OpConstant* or OpSpecConstant*
// (Currently doesn't handle OpSpecConstantComposite or OpSpecConstantOp)
struct Constant {
Constant(const Type& type, const Instruction& inst)
: type_(type), inst_(inst), is_spec_constant_(IsSpecConstant(inst.Opcode())) {}
uint32_t Id() const { return inst_.ResultId(); }
// Only for cases where we know the constant value
uint32_t GetValueUint32() const;
const Type& type_;
const Instruction& inst_;
// Most times we just need Constant to get type or id, so being a spec const doesn't matter.
// This boolean is here incase we do care about the value of the constant.
const bool is_spec_constant_;
};
// Represents a global OpVariable found before the first function
struct Variable {
Variable(const Type& type, const Instruction& inst) : type_(type), inst_(inst) {}
uint32_t Id() const { return inst_.ResultId(); }
spv::StorageClass StorageClass() const { return spv::StorageClass(inst_.Word(3)); }
const Type* PointerType(TypeManager& type_manager_) const;
const Type& type_;
const Instruction& inst_;
};
// In charge of tracking all Types, Constants, and Variable in the module.
// Since both Variable and Constant both rely on Types, the Types are the core thing we track
//
// Function naming guide:
// Find*() - searches if type/constant/var is already there, will return null if not
// Get*() - searches if type/constant/var is already there, will create one if not
// Create*() - just makes the type/constant/var, doesn't attempt to search for a duplicate
class TypeManager {
public:
TypeManager(Module& module) : module_(module) {}
const Type& AddType(std::unique_ptr<Instruction> new_inst, SpvType spv_type);
const Type* FindTypeById(uint32_t id) const;
const Type* FindValueTypeById(uint32_t id) const;
const Type* FindFunctionType(const Instruction& inst) const;
// There shouldn't be a case where we need to query for a specific type, but then not add it if not found.
const Type& GetTypeVoid();
const Type& GetTypeBool();
const Type& GetTypeSampler();
const Type& GetTypeRayQuery();
const Type& GetTypeAccelerationStructure();
const Type& GetTypeInt(uint32_t bit_width, bool is_signed);
const Type& GetTypeFloat(uint32_t bit_width);
const Type& GetTypeArray(const Type& element_type, const Constant& length);
const Type& GetTypeRuntimeArray(const Type& element_type);
const Type& GetTypeVector(const Type& component_type, uint32_t component_count);
const Type& GetTypeMatrix(const Type& column_type, uint32_t column_count);
const Type& GetTypeSampledImage(const Type& image_type);
const Type& GetTypePointer(spv::StorageClass storage_class, const Type& pointer_type);
const Type& GetTypePointerBuiltInInput(spv::BuiltIn built_in);
uint32_t TypeLength(const Type& type);
// Special struct type helpers for Linking
void AddStructTypeForLinking(const Type* new_type);
uint32_t FindLinkingStructType(const Instruction& inst, vvl::unordered_map<uint32_t, uint32_t>& id_swap_map) const;
const Constant& AddConstant(std::unique_ptr<Instruction> new_inst, const Type& type);
const Constant* FindConstantById(uint32_t id) const;
const Constant* FindConstantInt32(uint32_t type_id, uint32_t value) const;
const Constant* FindConstantFloat32(uint32_t type_id, uint32_t value) const;
// most constants are uint
const Constant& CreateConstantUInt32(uint32_t value);
const Constant& GetConstantUInt32(uint32_t value);
const Constant& GetConstantZeroUint32();
const Constant& GetConstantZeroFloat32();
const Constant& GetConstantZeroVec3();
const Constant& GetConstantZeroUvec4();
const Constant& GetConstantNull(const Type& type);
const Variable& AddVariable(std::unique_ptr<Instruction> new_inst, const Type& type);
const Variable* FindVariableById(uint32_t id) const;
const Variable* FindPushConstantVariable() const;
private:
Module& module_;
// Currently we don't worry about duplicated types. If duplicate types are added from the original SPIR-V, we just use the first
// one we fine. We should only be adding a new object because it currently doesn't exists.
vvl::unordered_map<uint32_t, std::unique_ptr<Type>> id_to_type_;
vvl::unordered_map<uint32_t, std::unique_ptr<Constant>> id_to_constant_;
vvl::unordered_map<uint32_t, std::unique_ptr<Variable>> id_to_variable_;
// Create faster lookups for specific types
// some types are base types and only will be one
const Type* void_type = nullptr;
const Type* bool_type = nullptr;
const Type* sampler_type = nullptr;
const Type* ray_query_type = nullptr;
const Type* acceleration_structure_type = nullptr;
std::vector<const Type*> int_types_;
std::vector<const Type*> float_types_;
std::vector<const Type*> vector_types_;
std::vector<const Type*> matrix_types_;
std::vector<const Type*> image_types_;
std::vector<const Type*> sampled_image_types_;
std::vector<const Type*> array_types_;
std::vector<const Type*> runtime_array_types_;
std::vector<const Type*> pointer_types_;
std::vector<const Type*> forward_pointer_types_;
std::vector<const Type*> function_types_;
// Only for types we want to avoid when linking
std::vector<const Type*> linking_struct_types_;
std::vector<const Constant*> int_32bit_constants_;
std::vector<const Constant*> float_32bit_constants_;
const Constant* uint_32bit_zero_constants_ = nullptr;
const Constant* float_32bit_zero_constants_ = nullptr;
const Constant* vec3_zero_constants_ = nullptr;
const Constant* uvec4_zero_constants_ = nullptr;
std::vector<const Constant*> null_constants_;
std::vector<const Variable*> input_variables_;
std::vector<const Variable*> output_variables_;
// There is invalid to have more than 1 push constant variable per entrypoint
const Variable* push_constant_variable_ = nullptr;
// Save the length of a struct so we don't have to look it up everytime
// <struct_id, struct size>
vvl::unordered_map<uint32_t, uint32_t> struct_size_map_;
};
} // namespace spirv
} // namespace gpuav
|
