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
|
/* Copyright (c) 2015-2025 The Khronos Group Inc.
* Copyright (c) 2015-2025 Valve Corporation
* Copyright (c) 2015-2025 LunarG, Inc.
* Copyright (C) 2015-2025 Google Inc.
* Modifications Copyright (C) 2020 Advanced Micro Devices, Inc. All rights reserved.
*
* 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 "shader_utils.h"
#include "generated/device_features.h"
#include "generated/vk_api_version.h"
#include "generated/vk_extension_helper.h"
#include "utils/hash_util.h"
#include "generated/spirv_tools_commit_id.h"
#include <cstring>
#include <fstream>
// Profiled that having filesystem included in shader_utils.h adds significant compile time to all files
#include <filesystem>
namespace fs = std::filesystem;
void ValidationCache::GetUUID(uint8_t *uuid) {
const char *sha1_str = SPIRV_TOOLS_COMMIT_ID;
// Convert sha1_str from a hex string to binary. We only need VK_UUID_SIZE bytes of
// output, so pad with zeroes if the input string is shorter than that, and truncate
// if it's longer.
#if defined(__GNUC__) && (__GNUC__ > 8)
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wstringop-truncation"
#endif
char padded_sha1_str[2 * VK_UUID_SIZE + 1] = {}; // 2 hex digits == 1 byte
std::strncpy(padded_sha1_str, sha1_str, 2 * VK_UUID_SIZE);
#if defined(__GNUC__) && (__GNUC__ > 8)
#pragma GCC diagnostic pop
#endif
for (uint32_t i = 0; i < VK_UUID_SIZE; ++i) {
const char byte_str[] = {padded_sha1_str[2 * i + 0], padded_sha1_str[2 * i + 1], '\0'};
uuid[i] = static_cast<uint8_t>(std::strtoul(byte_str, nullptr, 16));
}
// Replace the last 4 bytes (likely padded with zero anyway)
std::memcpy(uuid + (VK_UUID_SIZE - sizeof(uint32_t)), &spirv_val_option_hash_, sizeof(uint32_t));
}
void ValidationCache::Load(VkValidationCacheCreateInfoEXT const *pCreateInfo) {
const auto headerSize = 2 * sizeof(uint32_t) + VK_UUID_SIZE;
auto size = headerSize;
if (!pCreateInfo->pInitialData || pCreateInfo->initialDataSize < size) return;
uint32_t const *data = (uint32_t const *)pCreateInfo->pInitialData;
if (data[0] != size) return;
if (data[1] != VK_VALIDATION_CACHE_HEADER_VERSION_ONE_EXT) return;
uint8_t expected_uuid[VK_UUID_SIZE];
GetUUID(expected_uuid);
if (memcmp(&data[2], expected_uuid, VK_UUID_SIZE) != 0) return; // different version
data = (uint32_t const *)(reinterpret_cast<uint8_t const *>(data) + headerSize);
auto guard = WriteLock();
for (; size < pCreateInfo->initialDataSize; data++, size += sizeof(uint32_t)) {
good_shader_hashes_.insert(*data);
}
}
void ValidationCache::Write(size_t *pDataSize, void *pData) {
const auto header_size = 2 * sizeof(uint32_t) + VK_UUID_SIZE; // 4 bytes for header size + 4 bytes for version number + UUID
if (!pData) {
*pDataSize = header_size + good_shader_hashes_.size() * sizeof(uint32_t);
return;
}
if (*pDataSize < header_size) {
*pDataSize = 0;
return; // Too small for even the header!
}
uint32_t *out = (uint32_t *)pData;
size_t actual_size = header_size;
// Write the header
*out++ = header_size;
*out++ = VK_VALIDATION_CACHE_HEADER_VERSION_ONE_EXT;
GetUUID(reinterpret_cast<uint8_t *>(out));
out = (uint32_t *)(reinterpret_cast<uint8_t *>(out) + VK_UUID_SIZE);
{
auto guard = ReadLock();
for (auto it = good_shader_hashes_.begin(); it != good_shader_hashes_.end() && actual_size < *pDataSize;
it++, out++, actual_size += sizeof(uint32_t)) {
*out = *it;
}
}
*pDataSize = actual_size;
}
void ValidationCache::Merge(ValidationCache const *other) {
// self-merging is invalid, but avoid deadlock below just in case.
if (other == this) {
return;
}
auto other_guard = other->ReadLock();
auto guard = WriteLock();
good_shader_hashes_.reserve(good_shader_hashes_.size() + other->good_shader_hashes_.size());
for (auto h : other->good_shader_hashes_) good_shader_hashes_.insert(h);
}
spv_target_env PickSpirvEnv(const APIVersion &api_version, bool spirv_1_4) {
if (api_version >= VK_API_VERSION_1_3) {
return SPV_ENV_VULKAN_1_3;
} else if (api_version >= VK_API_VERSION_1_2) {
return SPV_ENV_VULKAN_1_2;
} else if (api_version >= VK_API_VERSION_1_1) {
if (spirv_1_4) {
return SPV_ENV_VULKAN_1_1_SPIRV_1_4;
} else {
return SPV_ENV_VULKAN_1_1;
}
}
return SPV_ENV_VULKAN_1_0;
}
// Some Vulkan extensions/features are just all done in spirv-val behind optional settings
void AdjustValidatorOptions(const DeviceExtensions &device_extensions, const DeviceFeatures &enabled_features,
spvtools::ValidatorOptions &out_options, uint32_t *out_hash) {
struct Settings {
bool relax_block_layout;
bool uniform_buffer_standard_layout;
bool scalar_block_layout;
bool workgroup_scalar_block_layout;
bool allow_local_size_id;
bool allow_offset_texture_operand;
bool allow_vulkan_32_bit_bitwise;
} settings;
// VK_KHR_relaxed_block_layout never had a feature bit so just enabling the extension allows relaxed layout
// Was promotoed in Vulkan 1.1 so anyone using Vulkan 1.1 also gets this for free
settings.relax_block_layout = IsExtEnabled(device_extensions.vk_khr_relaxed_block_layout);
// The rest of the settings are controlled from a feature bit, which are set correctly in the state tracking. Regardless of
// Vulkan version used, the feature bit is needed (also described in the spec).
settings.uniform_buffer_standard_layout = enabled_features.uniformBufferStandardLayout == VK_TRUE;
settings.scalar_block_layout = enabled_features.scalarBlockLayout == VK_TRUE;
settings.workgroup_scalar_block_layout = enabled_features.workgroupMemoryExplicitLayoutScalarBlockLayout == VK_TRUE;
settings.allow_local_size_id = enabled_features.maintenance4 == VK_TRUE;
settings.allow_offset_texture_operand = enabled_features.maintenance8 == VK_TRUE;
settings.allow_vulkan_32_bit_bitwise = enabled_features.maintenance9 == VK_TRUE;
if (settings.relax_block_layout) {
// --relax-block-layout
out_options.SetRelaxBlockLayout(true);
}
if (settings.uniform_buffer_standard_layout) {
// --uniform-buffer-standard-layout
out_options.SetUniformBufferStandardLayout(true);
}
if (settings.scalar_block_layout) {
// --scalar-block-layout
out_options.SetScalarBlockLayout(true);
}
if (settings.workgroup_scalar_block_layout) {
// --workgroup-scalar-block-layout
out_options.SetWorkgroupScalarBlockLayout(true);
}
if (settings.allow_local_size_id) {
// --allow-localsizeid
out_options.SetAllowLocalSizeId(true);
}
if (settings.allow_offset_texture_operand) {
// --allow-offset-texture-operand
out_options.SetAllowOffsetTextureOperand(true);
}
if (settings.allow_vulkan_32_bit_bitwise) {
// --allow-vulkan-32-bit-bitwise
out_options.SetAllowVulkan32BitBitwise(true);
}
// Faster validation without friendly names.
out_options.SetFriendlyNames(false);
// The spv_validator_options_t in libspirv.h is hidden so we can't just hash that struct, so instead need to create our own.
if (out_hash) {
*out_hash = hash_util::Hash32(&settings, sizeof(Settings));
}
}
// This is used to help dump SPIR-V while debugging intermediate phases of any altercations to the SPIR-V
void DumpSpirvToFile(const std::string &file_path, const uint32_t *spirv, size_t spirv_dwords_count) {
std::ofstream debug_file(file_path, std::ios::out | std::ios::binary);
debug_file.write(reinterpret_cast<const char *>(spirv), spirv_dwords_count * sizeof(uint32_t));
}
|
