Skip to content

Commit 1aa1a18

Browse files
akien-mgaakien-mga
committed
Merge pull request #94203 from RandomShaper/bye_bye_dxil_dll
D3D12: Get rid of `DXIL.dll`!
2 parents 6c2699c + ee2c158 commit 1aa1a18

File tree

10 files changed

+266
-124
lines changed

10 files changed

+266
-124
lines changed

‎drivers/d3d12/dxil_hash.cpp‎

Lines changed: 209 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,209 @@
1+
/**************************************************************************/
2+
/* dxil_hash.cpp */
3+
/**************************************************************************/
4+
/* This file is part of: */
5+
/* GODOT ENGINE */
6+
/* https://godotengine.org */
7+
/**************************************************************************/
8+
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
9+
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
10+
/* */
11+
/* Permission is hereby granted, free of charge, to any person obtaining */
12+
/* a copy of this software and associated documentation files (the */
13+
/* "Software"), to deal in the Software without restriction, including */
14+
/* without limitation the rights to use, copy, modify, merge, publish, */
15+
/* distribute, sublicense, and/or sell copies of the Software, and to */
16+
/* permit persons to whom the Software is furnished to do so, subject to */
17+
/* the following conditions: */
18+
/* */
19+
/* The above copyright notice and this permission notice shall be */
20+
/* included in all copies or substantial portions of the Software. */
21+
/* */
22+
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
23+
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
24+
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
25+
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
26+
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
27+
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
28+
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
29+
/**************************************************************************/
30+
31+
// Based on the patched public domain implementation released by Microsoft here:
32+
// https://github.com/microsoft/hlsl-specs/blob/main/proposals/infra/INF-0004-validator-hashing.md
33+
34+
#include "dxil_hash.h"
35+
36+
#include <memory.h>
37+
38+
#define S11 7
39+
#define S12 12
40+
#define S13 17
41+
#define S14 22
42+
#define S21 5
43+
#define S22 9
44+
#define S23 14
45+
#define S24 20
46+
#define S31 4
47+
#define S32 11
48+
#define S33 16
49+
#define S34 23
50+
#define S41 6
51+
#define S42 10
52+
#define S43 15
53+
#define S44 21
54+
55+
static const BYTE padding[64] = {
56+
0x80, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
57+
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
58+
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
59+
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0
60+
};
61+
62+
static void FF(UINT &a, UINT b, UINT c, UINT d, UINT x, UINT8 s, UINT ac) {
63+
a += ((b & c) | (~b & d)) + x + ac;
64+
a = ((a << s) | (a >> (32 - s))) + b;
65+
}
66+
67+
static void GG(UINT &a, UINT b, UINT c, UINT d, UINT x, UINT8 s, UINT ac) {
68+
a += ((b & d) | (c & ~d)) + x + ac;
69+
a = ((a << s) | (a >> (32 - s))) + b;
70+
}
71+
72+
static void HH(UINT &a, UINT b, UINT c, UINT d, UINT x, UINT8 s, UINT ac) {
73+
a += (b ^ c ^ d) + x + ac;
74+
a = ((a << s) | (a >> (32 - s))) + b;
75+
}
76+
77+
static void II(UINT &a, UINT b, UINT c, UINT d, UINT x, UINT8 s, UINT ac) {
78+
a += (c ^ (b | ~d)) + x + ac;
79+
a = ((a << s) | (a >> (32 - s))) + b;
80+
}
81+
82+
void compute_dxil_hash(const BYTE *pData, UINT byteCount, BYTE *pOutHash) {
83+
UINT leftOver = byteCount & 0x3f;
84+
UINT padAmount;
85+
bool bTwoRowsPadding = false;
86+
if (leftOver < 56) {
87+
padAmount = 56 - leftOver;
88+
} else {
89+
padAmount = 120 - leftOver;
90+
bTwoRowsPadding = true;
91+
}
92+
UINT padAmountPlusSize = padAmount + 8;
93+
UINT state[4] = { 0x67452301, 0xefcdab89, 0x98badcfe, 0x10325476 };
94+
UINT N = (byteCount + padAmountPlusSize) >> 6;
95+
UINT offset = 0;
96+
UINT NextEndState = bTwoRowsPadding ? N - 2 : N - 1;
97+
const BYTE *pCurrData = pData;
98+
for (UINT i = 0; i < N; i++, offset += 64, pCurrData += 64) {
99+
UINT x[16];
100+
const UINT *pX;
101+
if (i == NextEndState) {
102+
if (!bTwoRowsPadding && i == N - 1) {
103+
UINT remainder = byteCount - offset;
104+
x[0] = byteCount << 3;
105+
memcpy((BYTE *)x + 4, pCurrData, remainder);
106+
memcpy((BYTE *)x + 4 + remainder, padding, padAmount);
107+
x[15] = 1 | (byteCount << 1);
108+
} else if (bTwoRowsPadding) {
109+
if (i == N - 2) {
110+
UINT remainder = byteCount - offset;
111+
memcpy(x, pCurrData, remainder);
112+
memcpy((BYTE *)x + remainder, padding, padAmount - 56);
113+
NextEndState = N - 1;
114+
} else if (i == N - 1) {
115+
x[0] = byteCount << 3;
116+
memcpy((BYTE *)x + 4, padding + padAmount - 56, 56);
117+
x[15] = 1 | (byteCount << 1);
118+
}
119+
}
120+
pX = x;
121+
} else {
122+
pX = (const UINT *)pCurrData;
123+
}
124+
125+
UINT a = state[0];
126+
UINT b = state[1];
127+
UINT c = state[2];
128+
UINT d = state[3];
129+
130+
/* Round 1 */
131+
FF(a, b, c, d, pX[0], S11, 0xd76aa478); /* 1 */
132+
FF(d, a, b, c, pX[1], S12, 0xe8c7b756); /* 2 */
133+
FF(c, d, a, b, pX[2], S13, 0x242070db); /* 3 */
134+
FF(b, c, d, a, pX[3], S14, 0xc1bdceee); /* 4 */
135+
FF(a, b, c, d, pX[4], S11, 0xf57c0faf); /* 5 */
136+
FF(d, a, b, c, pX[5], S12, 0x4787c62a); /* 6 */
137+
FF(c, d, a, b, pX[6], S13, 0xa8304613); /* 7 */
138+
FF(b, c, d, a, pX[7], S14, 0xfd469501); /* 8 */
139+
FF(a, b, c, d, pX[8], S11, 0x698098d8); /* 9 */
140+
FF(d, a, b, c, pX[9], S12, 0x8b44f7af); /* 10 */
141+
FF(c, d, a, b, pX[10], S13, 0xffff5bb1); /* 11 */
142+
FF(b, c, d, a, pX[11], S14, 0x895cd7be); /* 12 */
143+
FF(a, b, c, d, pX[12], S11, 0x6b901122); /* 13 */
144+
FF(d, a, b, c, pX[13], S12, 0xfd987193); /* 14 */
145+
FF(c, d, a, b, pX[14], S13, 0xa679438e); /* 15 */
146+
FF(b, c, d, a, pX[15], S14, 0x49b40821); /* 16 */
147+
148+
/* Round 2 */
149+
GG(a, b, c, d, pX[1], S21, 0xf61e2562); /* 17 */
150+
GG(d, a, b, c, pX[6], S22, 0xc040b340); /* 18 */
151+
GG(c, d, a, b, pX[11], S23, 0x265e5a51); /* 19 */
152+
GG(b, c, d, a, pX[0], S24, 0xe9b6c7aa); /* 20 */
153+
GG(a, b, c, d, pX[5], S21, 0xd62f105d); /* 21 */
154+
GG(d, a, b, c, pX[10], S22, 0x2441453); /* 22 */
155+
GG(c, d, a, b, pX[15], S23, 0xd8a1e681); /* 23 */
156+
GG(b, c, d, a, pX[4], S24, 0xe7d3fbc8); /* 24 */
157+
GG(a, b, c, d, pX[9], S21, 0x21e1cde6); /* 25 */
158+
GG(d, a, b, c, pX[14], S22, 0xc33707d6); /* 26 */
159+
GG(c, d, a, b, pX[3], S23, 0xf4d50d87); /* 27 */
160+
GG(b, c, d, a, pX[8], S24, 0x455a14ed); /* 28 */
161+
GG(a, b, c, d, pX[13], S21, 0xa9e3e905); /* 29 */
162+
GG(d, a, b, c, pX[2], S22, 0xfcefa3f8); /* 30 */
163+
GG(c, d, a, b, pX[7], S23, 0x676f02d9); /* 31 */
164+
GG(b, c, d, a, pX[12], S24, 0x8d2a4c8a); /* 32 */
165+
166+
/* Round 3 */
167+
HH(a, b, c, d, pX[5], S31, 0xfffa3942); /* 33 */
168+
HH(d, a, b, c, pX[8], S32, 0x8771f681); /* 34 */
169+
HH(c, d, a, b, pX[11], S33, 0x6d9d6122); /* 35 */
170+
HH(b, c, d, a, pX[14], S34, 0xfde5380c); /* 36 */
171+
HH(a, b, c, d, pX[1], S31, 0xa4beea44); /* 37 */
172+
HH(d, a, b, c, pX[4], S32, 0x4bdecfa9); /* 38 */
173+
HH(c, d, a, b, pX[7], S33, 0xf6bb4b60); /* 39 */
174+
HH(b, c, d, a, pX[10], S34, 0xbebfbc70); /* 40 */
175+
HH(a, b, c, d, pX[13], S31, 0x289b7ec6); /* 41 */
176+
HH(d, a, b, c, pX[0], S32, 0xeaa127fa); /* 42 */
177+
HH(c, d, a, b, pX[3], S33, 0xd4ef3085); /* 43 */
178+
HH(b, c, d, a, pX[6], S34, 0x4881d05); /* 44 */
179+
HH(a, b, c, d, pX[9], S31, 0xd9d4d039); /* 45 */
180+
HH(d, a, b, c, pX[12], S32, 0xe6db99e5); /* 46 */
181+
HH(c, d, a, b, pX[15], S33, 0x1fa27cf8); /* 47 */
182+
HH(b, c, d, a, pX[2], S34, 0xc4ac5665); /* 48 */
183+
184+
/* Round 4 */
185+
II(a, b, c, d, pX[0], S41, 0xf4292244); /* 49 */
186+
II(d, a, b, c, pX[7], S42, 0x432aff97); /* 50 */
187+
II(c, d, a, b, pX[14], S43, 0xab9423a7); /* 51 */
188+
II(b, c, d, a, pX[5], S44, 0xfc93a039); /* 52 */
189+
II(a, b, c, d, pX[12], S41, 0x655b59c3); /* 53 */
190+
II(d, a, b, c, pX[3], S42, 0x8f0ccc92); /* 54 */
191+
II(c, d, a, b, pX[10], S43, 0xffeff47d); /* 55 */
192+
II(b, c, d, a, pX[1], S44, 0x85845dd1); /* 56 */
193+
II(a, b, c, d, pX[8], S41, 0x6fa87e4f); /* 57 */
194+
II(d, a, b, c, pX[15], S42, 0xfe2ce6e0); /* 58 */
195+
II(c, d, a, b, pX[6], S43, 0xa3014314); /* 59 */
196+
II(b, c, d, a, pX[13], S44, 0x4e0811a1); /* 60 */
197+
II(a, b, c, d, pX[4], S41, 0xf7537e82); /* 61 */
198+
II(d, a, b, c, pX[11], S42, 0xbd3af235); /* 62 */
199+
II(c, d, a, b, pX[2], S43, 0x2ad7d2bb); /* 63 */
200+
II(b, c, d, a, pX[9], S44, 0xeb86d391); /* 64 */
201+
202+
state[0] += a;
203+
state[1] += b;
204+
state[2] += c;
205+
state[3] += d;
206+
}
207+
208+
memcpy(pOutHash, state, 16);
209+
}

‎drivers/d3d12/dxil_hash.h‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
/**************************************************************************/
2+
/* dxil_hash.h */
3+
/**************************************************************************/
4+
/* This file is part of: */
5+
/* GODOT ENGINE */
6+
/* https://godotengine.org */
7+
/**************************************************************************/
8+
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
9+
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
10+
/* */
11+
/* Permission is hereby granted, free of charge, to any person obtaining */
12+
/* a copy of this software and associated documentation files (the */
13+
/* "Software"), to deal in the Software without restriction, including */
14+
/* without limitation the rights to use, copy, modify, merge, publish, */
15+
/* distribute, sublicense, and/or sell copies of the Software, and to */
16+
/* permit persons to whom the Software is furnished to do so, subject to */
17+
/* the following conditions: */
18+
/* */
19+
/* The above copyright notice and this permission notice shall be */
20+
/* included in all copies or substantial portions of the Software. */
21+
/* */
22+
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
23+
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
24+
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
25+
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
26+
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
27+
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
28+
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
29+
/**************************************************************************/
30+
31+
#ifndef DXIL_HASH_H
32+
#define DXIL_HASH_H
33+
34+
#define WIN32_LEAN_AND_MEAN
35+
#include <windows.h>
36+
37+
void compute_dxil_hash(const BYTE *pData, UINT byteCount, BYTE *pOutHash);
38+
39+
#endif // DXIL_HASH_H

‎drivers/d3d12/rendering_context_driver_d3d12.cpp‎

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -71,10 +71,6 @@ const GUID CLSID_D3D12DeviceFactoryGodot = { 0x114863bf, 0xc386, 0x4aee, { 0xb3,
7171
const GUID CLSID_D3D12DebugGodot = { 0xf2352aeb, 0xdd84, 0x49fe, { 0xb9, 0x7b, 0xa9, 0xdc, 0xfd, 0xcc, 0x1b, 0x4f } };
7272
const GUID CLSID_D3D12SDKConfigurationGodot = { 0x7cda6aca, 0xa03e, 0x49c8, { 0x94, 0x58, 0x03, 0x34, 0xd2, 0x0e, 0x07, 0xce } };
7373

74-
extern "C" {
75-
char godot_nir_arch_name[32];
76-
}
77-
7874
#ifdef PIX_ENABLED
7975
#if defined(__GNUC__)
8076
#define _MSC_VER 1800
@@ -86,10 +82,7 @@ char godot_nir_arch_name[32];
8682
#endif
8783
#endif
8884

89-
RenderingContextDriverD3D12::RenderingContextDriverD3D12() {
90-
CharString cs = Engine::get_singleton()->get_architecture_name().ascii();
91-
memcpy(godot_nir_arch_name, (const char *)cs.get_data(), cs.size());
92-
}
85+
RenderingContextDriverD3D12::RenderingContextDriverD3D12() {}
9386

9487
RenderingContextDriverD3D12::~RenderingContextDriverD3D12() {
9588
if (lib_d3d12) {

‎drivers/d3d12/rendering_device_driver_d3d12.cpp‎

Lines changed: 8 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@
3636
#include "thirdparty/zlib/zlib.h"
3737

3838
#include "d3d12_godot_nir_bridge.h"
39+
#include "dxil_hash.h"
3940
#include "rendering_context_driver_d3d12.h"
4041

4142
// No point in fighting warnings in Mesa.
@@ -59,7 +60,6 @@
5960
#pragma clang diagnostic ignored "-Wmissing-field-initializers"
6061
#endif
6162

62-
#include "dxil_validator.h"
6363
#include "nir_spirv.h"
6464
#include "nir_to_dxil.h"
6565
#include "spirv_to_dxil.h"
@@ -2867,23 +2867,6 @@ static uint32_t SHADER_STAGES_BIT_OFFSET_INDICES[RenderingDevice::SHADER_STAGE_M
28672867
/* SHADER_STAGE_COMPUTE */ 2,
28682868
};
28692869

2870-
dxil_validator *RenderingDeviceDriverD3D12::_get_dxil_validator_for_current_thread() {
2871-
MutexLock lock(dxil_mutex);
2872-
2873-
int thread_idx = WorkerThreadPool::get_singleton()->get_thread_index();
2874-
if (dxil_validators.has(thread_idx)) {
2875-
return dxil_validators[thread_idx];
2876-
}
2877-
2878-
#ifdef DEV_ENABLED
2879-
print_verbose("Creating DXIL validator for worker thread index " + itos(thread_idx));
2880-
#endif
2881-
2882-
dxil_validator *dxil_validator = dxil_create_validator(nullptr);
2883-
dxil_validators.insert(thread_idx, dxil_validator);
2884-
return dxil_validator;
2885-
}
2886-
28872870
uint32_t RenderingDeviceDriverD3D12::_shader_patch_dxil_specialization_constant(
28882871
PipelineSpecializationConstantType p_type,
28892872
const void *p_value,
@@ -3006,40 +2989,20 @@ bool RenderingDeviceDriverD3D12::_shader_apply_specialization_constants(
30062989
ShaderStage stage = E.key;
30072990
if ((stages_re_sign_mask & (1 << stage))) {
30082991
Vector<uint8_t> &bytecode = E.value;
3009-
bool sign_ok = _shader_sign_dxil_bytecode(stage, bytecode);
3010-
ERR_FAIL_COND_V(!sign_ok, false);
2992+
_shader_sign_dxil_bytecode(stage, bytecode);
30112993
}
30122994
}
30132995

30142996
return true;
30152997
}
30162998

3017-
bool RenderingDeviceDriverD3D12::_shader_sign_dxil_bytecode(ShaderStage p_stage, Vector<uint8_t> &r_dxil_blob) {
3018-
dxil_validator *validator = _get_dxil_validator_for_current_thread();
3019-
if (!validator) {
3020-
if (is_in_developer_mode()) {
3021-
return true;
3022-
} else {
3023-
OS::get_singleton()->alert("Shader validation failed: DXIL.dll was not found, and developer mode is disabled.\n\nClick OK to exit.");
3024-
CRASH_NOW();
3025-
}
3026-
}
3027-
3028-
char *err = nullptr;
3029-
bool res = dxil_validate_module(validator, r_dxil_blob.ptrw(), r_dxil_blob.size(), &err);
3030-
if (!res) {
3031-
if (err) {
3032-
ERR_FAIL_COND_V_MSG(!res, false, "Shader signing invocation at stage " + String(SHADER_STAGE_NAMES[p_stage]) + " failed:\n" + String(err));
3033-
} else {
3034-
ERR_FAIL_COND_V_MSG(!res, false, "Shader signing invocation at stage " + String(SHADER_STAGE_NAMES[p_stage]) + " failed.");
3035-
}
3036-
}
3037-
3038-
return true;
2999+
void RenderingDeviceDriverD3D12::_shader_sign_dxil_bytecode(ShaderStage p_stage, Vector<uint8_t> &r_dxil_blob) {
3000+
uint8_t *w = r_dxil_blob.ptrw();
3001+
compute_dxil_hash(w + 20, r_dxil_blob.size() - 20, w + 4);
30393002
}
30403003

30413004
String RenderingDeviceDriverD3D12::shader_get_binary_cache_key() {
3042-
return "D3D12-SV" + uitos(ShaderBinary::VERSION) + "-" + itos(shader_capabilities.shader_model) + (is_in_developer_mode() ? "dev" : "");
3005+
return "D3D12-SV" + uitos(ShaderBinary::VERSION) + "-" + itos(shader_capabilities.shader_model);
30433006
}
30443007

30453008
Vector<uint8_t> RenderingDeviceDriverD3D12::shader_compile_binary_from_spirv(VectorView<ShaderStageSPIRVData> p_spirv, const String &p_shader_name) {
@@ -3307,10 +3270,7 @@ Vector<uint8_t> RenderingDeviceDriverD3D12::shader_compile_binary_from_spirv(Vec
33073270
nir_to_dxil_options nir_to_dxil_options = {};
33083271
nir_to_dxil_options.environment = DXIL_ENVIRONMENT_VULKAN;
33093272
nir_to_dxil_options.shader_model_max = shader_model_d3d_to_dxil(shader_capabilities.shader_model);
3310-
dxil_validator *validator = _get_dxil_validator_for_current_thread();
3311-
if (validator) {
3312-
nir_to_dxil_options.validator_version_max = dxil_get_validator_version(validator);
3313-
}
3273+
nir_to_dxil_options.validator_version_max = NO_DXIL_VALIDATION;
33143274
nir_to_dxil_options.godot_nir_callbacks = &godot_nir_callbacks;
33153275

33163276
dxil_logger logger = {};
@@ -3361,8 +3321,7 @@ Vector<uint8_t> RenderingDeviceDriverD3D12::shader_compile_binary_from_spirv(Vec
33613321
for (KeyValue<ShaderStage, Vector<uint8_t>> &E : dxil_blobs) {
33623322
ShaderStage stage = E.key;
33633323
Vector<uint8_t> &dxil_blob = E.value;
3364-
bool sign_ok = _shader_sign_dxil_bytecode(stage, dxil_blob);
3365-
ERR_FAIL_COND_V(!sign_ok, Vector<uint8_t>());
3324+
_shader_sign_dxil_bytecode(stage, dxil_blob);
33663325
}
33673326

33683327
// Build the root signature.
@@ -6287,15 +6246,6 @@ RenderingDeviceDriverD3D12::RenderingDeviceDriverD3D12(RenderingContextDriverD3D
62876246
}
62886247

62896248
RenderingDeviceDriverD3D12::~RenderingDeviceDriverD3D12() {
6290-
{
6291-
MutexLock lock(dxil_mutex);
6292-
for (const KeyValue<int, dxil_validator *> &E : dxil_validators) {
6293-
if (E.value) {
6294-
dxil_destroy_validator(E.value);
6295-
}
6296-
}
6297-
}
6298-
62996249
glsl_type_singleton_decref();
63006250
}
63016251

0 commit comments

Comments
 (0)