forked from KhronosGroup/Vulkan-Loader
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathloader_windows.c
1171 lines (1036 loc) · 52.5 KB
/
loader_windows.c
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
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
*
* Copyright (c) 2014-2022 The Khronos Group Inc.
* Copyright (c) 2014-2022 Valve Corporation
* Copyright (c) 2014-2022 LunarG, Inc.
* Copyright (C) 2015 Google 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.
*
* Author: Jon Ashburn <jon@lunarg.com>
* Author: Courtney Goeltzenleuchter <courtney@LunarG.com>
* Author: Chia-I Wu <olvaffe@gmail.com>
* Author: Chia-I Wu <olv@lunarg.com>
* Author: Mark Lobodzinski <mark@LunarG.com>
* Author: Lenny Komow <lenny@lunarg.com>
* Author: Charles Giessen <charles@lunarg.com>
*
*/
// Windows only header file, guard it so that accidental inclusion doesn't cause unknown header include errors
#if defined(_WIN32)
// This needs to be defined first, or else we'll get redefinitions on NTSTATUS values
#define UMDF_USING_NTSTATUS
#include <ntstatus.h>
#include "loader_windows.h"
#include "allocation.h"
#include "loader_environment.h"
#include "loader.h"
#include "log.h"
#include <cfgmgr32.h>
#include <initguid.h>
#include <devpkey.h>
#include <winternl.h>
#include <strsafe.h>
#if defined(__MINGW32__)
#undef strcpy // fix error with redfined strcpy when building with MinGW-w64
#endif
#include <dxgi1_6.h>
#include "adapters.h"
#if !defined(__MINGW32__)
// not yet available with MinGW-w64 stable
#include <appmodel.h>
#endif
#if !defined(NDEBUG)
#include <crtdbg.h>
#endif
typedef HRESULT(APIENTRY *PFN_CreateDXGIFactory1)(REFIID riid, void **ppFactory);
PFN_CreateDXGIFactory1 fpCreateDXGIFactory1;
// Empty function just so windows_initialization can find the current module location
void function_for_finding_the_current_module(void) {}
void windows_initialization(void) {
char dll_location[MAX_PATH];
HMODULE module_handle = NULL;
// Get a module handle to a static function inside of this source
if (GetModuleHandleEx(GET_MODULE_HANDLE_EX_FLAG_FROM_ADDRESS | GET_MODULE_HANDLE_EX_FLAG_UNCHANGED_REFCOUNT,
(LPCSTR)&function_for_finding_the_current_module, &module_handle) != 0 &&
GetModuleFileName(module_handle, dll_location, sizeof(dll_location)) != 0) {
loader_log(NULL, VULKAN_LOADER_INFO_BIT, 0, "Using Vulkan Loader %s", dll_location);
}
// This is needed to ensure that newer APIs are available right away
// and not after the first call that has been statically linked
LoadLibrary("gdi32.dll");
wchar_t systemPath[MAX_PATH] = L"";
GetSystemDirectoryW(systemPath, MAX_PATH);
StringCchCatW(systemPath, MAX_PATH, L"\\dxgi.dll");
HMODULE dxgi_module = LoadLibraryW(systemPath);
fpCreateDXGIFactory1 =
dxgi_module == NULL ? NULL : (PFN_CreateDXGIFactory1)(void *)GetProcAddress(dxgi_module, "CreateDXGIFactory1");
#if !defined(NDEBUG)
_set_error_mode(_OUT_TO_STDERR);
_CrtSetReportMode(_CRT_ERROR, _CRTDBG_MODE_FILE);
_CrtSetReportFile(_CRT_ERROR, _CRTDBG_FILE_STDERR);
#endif
}
BOOL WINAPI DllMain(HINSTANCE hinst, DWORD reason, LPVOID reserved) {
(void)hinst;
switch (reason) {
case DLL_PROCESS_ATTACH:
loader_initialize();
break;
case DLL_PROCESS_DETACH:
if (NULL == reserved) {
loader_release();
}
break;
default:
// Do nothing
break;
}
return TRUE;
}
bool windows_add_json_entry(const struct loader_instance *inst,
char **reg_data, // list of JSON files
PDWORD total_size, // size of reg_data
LPCSTR key_name, // key name - used for debug prints - i.e. VulkanDriverName
DWORD key_type, // key data type
LPSTR json_path, // JSON string to add to the list reg_data
DWORD json_size, // size in bytes of json_path
VkResult *result) {
// Check for and ignore duplicates.
if (*reg_data && strstr(*reg_data, json_path)) {
// Success. The json_path is already in the list.
return true;
}
if (NULL == *reg_data) {
*reg_data = loader_instance_heap_alloc(inst, *total_size, VK_SYSTEM_ALLOCATION_SCOPE_INSTANCE);
if (NULL == *reg_data) {
loader_log(inst, VULKAN_LOADER_ERROR_BIT, 0,
"windows_add_json_entry: Failed to allocate space for registry data for key %s", json_path);
*result = VK_ERROR_OUT_OF_HOST_MEMORY;
return false;
}
*reg_data[0] = '\0';
} else if (strlen(*reg_data) + json_size + 1 > *total_size) {
void *new_ptr =
loader_instance_heap_realloc(inst, *reg_data, *total_size, *total_size * 2, VK_SYSTEM_ALLOCATION_SCOPE_INSTANCE);
if (NULL == new_ptr) {
loader_log(inst, VULKAN_LOADER_ERROR_BIT, 0,
"windows_add_json_entry: Failed to reallocate space for registry value of size %d for key %s",
*total_size * 2, json_path);
*result = VK_ERROR_OUT_OF_HOST_MEMORY;
return false;
}
*reg_data = new_ptr;
*total_size *= 2;
}
for (char *curr_filename = json_path; curr_filename[0] != '\0'; curr_filename += strlen(curr_filename) + 1) {
if (strlen(*reg_data) == 0) {
(void)snprintf(*reg_data, json_size + 1, "%s", curr_filename);
} else {
(void)snprintf(*reg_data + strlen(*reg_data), json_size + 2, "%c%s", PATH_SEPARATOR, curr_filename);
}
loader_log(inst, VULKAN_LOADER_INFO_BIT, 0, "%s: Located json file \"%s\" from PnP registry: %s", __FUNCTION__,
curr_filename, key_name);
if (key_type == REG_SZ) {
break;
}
}
return true;
}
bool windows_get_device_registry_entry(const struct loader_instance *inst, char **reg_data, PDWORD total_size, DEVINST dev_id,
LPCSTR value_name, VkResult *result) {
HKEY hkrKey = INVALID_HANDLE_VALUE;
DWORD requiredSize, data_type;
char *manifest_path = NULL;
bool found = false;
assert(reg_data != NULL && "windows_get_device_registry_entry: reg_data is a NULL pointer");
assert(total_size != NULL && "windows_get_device_registry_entry: total_size is a NULL pointer");
CONFIGRET status = CM_Open_DevNode_Key(dev_id, KEY_QUERY_VALUE, 0, RegDisposition_OpenExisting, &hkrKey, CM_REGISTRY_SOFTWARE);
if (status != CR_SUCCESS) {
loader_log(inst, VULKAN_LOADER_WARN_BIT | VULKAN_LOADER_DRIVER_BIT, 0,
"windows_get_device_registry_entry: Failed to open registry key for DeviceID(%d)", dev_id);
*result = VK_ERROR_INCOMPATIBLE_DRIVER;
return false;
}
// query value
LSTATUS ret = RegQueryValueEx(hkrKey, value_name, NULL, NULL, NULL, &requiredSize);
if (ret != ERROR_SUCCESS) {
if (ret == ERROR_FILE_NOT_FOUND) {
loader_log(inst, VULKAN_LOADER_INFO_BIT | VULKAN_LOADER_DRIVER_BIT, 0,
"windows_get_device_registry_entry: Device ID(%d) Does not contain a value for \"%s\"", dev_id, value_name);
} else {
loader_log(inst, VULKAN_LOADER_INFO_BIT | VULKAN_LOADER_DRIVER_BIT, 0,
"windows_get_device_registry_entry: DeviceID(%d) Failed to obtain %s size", dev_id, value_name);
}
goto out;
}
manifest_path = loader_instance_heap_alloc(inst, requiredSize, VK_SYSTEM_ALLOCATION_SCOPE_INSTANCE);
if (manifest_path == NULL) {
loader_log(inst, VULKAN_LOADER_ERROR_BIT | VULKAN_LOADER_DRIVER_BIT, 0,
"windows_get_device_registry_entry: Failed to allocate space for DriverName.");
*result = VK_ERROR_OUT_OF_HOST_MEMORY;
goto out;
}
ret = RegQueryValueEx(hkrKey, value_name, NULL, &data_type, (BYTE *)manifest_path, &requiredSize);
if (ret != ERROR_SUCCESS) {
loader_log(inst, VULKAN_LOADER_ERROR_BIT | VULKAN_LOADER_DRIVER_BIT, 0,
"windows_get_device_registry_entry: DeviceID(%d) Failed to obtain %s", value_name);
*result = VK_ERROR_INCOMPATIBLE_DRIVER;
goto out;
}
if (data_type != REG_SZ && data_type != REG_MULTI_SZ) {
loader_log(inst, VULKAN_LOADER_ERROR_BIT | VULKAN_LOADER_DRIVER_BIT, 0,
"windows_get_device_registry_entry: Invalid %s data type. Expected REG_SZ or REG_MULTI_SZ.", value_name);
*result = VK_ERROR_INCOMPATIBLE_DRIVER;
goto out;
}
found = windows_add_json_entry(inst, reg_data, total_size, value_name, data_type, manifest_path, requiredSize, result);
out:
loader_instance_heap_free(inst, manifest_path);
RegCloseKey(hkrKey);
return found;
}
VkResult windows_get_device_registry_files(const struct loader_instance *inst, uint32_t log_target_flag, char **reg_data,
PDWORD reg_data_size, LPCSTR value_name) {
const wchar_t *softwareComponentGUID = L"{5c4c3332-344d-483c-8739-259e934c9cc8}";
const wchar_t *displayGUID = L"{4d36e968-e325-11ce-bfc1-08002be10318}";
#if defined(CM_GETIDLIST_FILTER_PRESENT)
const ULONG flags = CM_GETIDLIST_FILTER_CLASS | CM_GETIDLIST_FILTER_PRESENT;
#else
const ULONG flags = 0x300;
#endif
wchar_t childGuid[MAX_GUID_STRING_LEN + 2]; // +2 for brackets {}
for (uint32_t i = 0; i < MAX_GUID_STRING_LEN + 2; i++) {
childGuid[i] = L'\0';
}
ULONG childGuidSize = sizeof(childGuid);
DEVINST devID = 0, childID = 0;
wchar_t *pDeviceNames = NULL;
ULONG deviceNamesSize = 0;
VkResult result = VK_SUCCESS;
bool found = false;
assert(reg_data != NULL && "windows_get_device_registry_files: reg_data is NULL");
// if after obtaining the DeviceNameSize, new device is added start over
do {
CM_Get_Device_ID_List_SizeW(&deviceNamesSize, displayGUID, flags);
loader_instance_heap_free(inst, pDeviceNames);
pDeviceNames = loader_instance_heap_alloc(inst, deviceNamesSize * sizeof(wchar_t), VK_SYSTEM_ALLOCATION_SCOPE_INSTANCE);
if (pDeviceNames == NULL) {
loader_log(inst, VULKAN_LOADER_ERROR_BIT | log_target_flag, 0,
"windows_get_device_registry_files: Failed to allocate space for display device names.");
result = VK_ERROR_OUT_OF_HOST_MEMORY;
return result;
}
} while (CM_Get_Device_ID_ListW(displayGUID, pDeviceNames, deviceNamesSize, flags) == CR_BUFFER_SMALL);
if (pDeviceNames) {
for (wchar_t *deviceName = pDeviceNames; *deviceName; deviceName += wcslen(deviceName) + 1) {
CONFIGRET status = CM_Locate_DevNodeW(&devID, deviceName, CM_LOCATE_DEVNODE_NORMAL);
if (CR_SUCCESS != status) {
loader_log(inst, VULKAN_LOADER_ERROR_BIT | log_target_flag, 0,
"windows_get_device_registry_files: failed to open DevNode %ls", deviceName);
continue;
}
ULONG ulStatus, ulProblem;
status = CM_Get_DevNode_Status(&ulStatus, &ulProblem, devID, 0);
if (CR_SUCCESS != status) {
loader_log(inst, VULKAN_LOADER_ERROR_BIT | log_target_flag, 0,
"windows_get_device_registry_files: failed to probe device status %ls", deviceName);
continue;
}
if ((ulStatus & DN_HAS_PROBLEM) && (ulProblem == CM_PROB_NEED_RESTART || ulProblem == DN_NEED_RESTART)) {
loader_log(inst, VULKAN_LOADER_INFO_BIT | log_target_flag, 0,
"windows_get_device_registry_files: device %ls is pending reboot, skipping ...", deviceName);
continue;
}
loader_log(inst, VULKAN_LOADER_INFO_BIT | log_target_flag, 0, "windows_get_device_registry_files: opening device %ls",
deviceName);
if (windows_get_device_registry_entry(inst, reg_data, reg_data_size, devID, value_name, &result)) {
found = true;
continue;
} else if (result == VK_ERROR_OUT_OF_HOST_MEMORY) {
break;
}
status = CM_Get_Child(&childID, devID, 0);
if (status != CR_SUCCESS) {
loader_log(inst, VULKAN_LOADER_INFO_BIT | log_target_flag, 0,
"windows_get_device_registry_files: unable to open child-device error:%d", status);
continue;
}
do {
wchar_t buffer[MAX_DEVICE_ID_LEN];
CM_Get_Device_IDW(childID, buffer, MAX_DEVICE_ID_LEN, 0);
loader_log(inst, VULKAN_LOADER_INFO_BIT | log_target_flag, 0,
"windows_get_device_registry_files: Opening child device %d - %ls", childID, buffer);
status = CM_Get_DevNode_Registry_PropertyW(childID, CM_DRP_CLASSGUID, NULL, &childGuid, &childGuidSize, 0);
if (status != CR_SUCCESS) {
loader_log(inst, VULKAN_LOADER_ERROR_BIT | log_target_flag, 0,
"windows_get_device_registry_files: unable to obtain GUID for:%d error:%d", childID, status);
result = VK_ERROR_INCOMPATIBLE_DRIVER;
continue;
}
if (wcscmp(childGuid, softwareComponentGUID) != 0) {
loader_log(inst, VULKAN_LOADER_DEBUG_BIT | log_target_flag, 0,
"windows_get_device_registry_files: GUID for %d is not SoftwareComponent skipping", childID);
continue;
}
if (windows_get_device_registry_entry(inst, reg_data, reg_data_size, childID, value_name, &result)) {
found = true;
break; // check next-display-device
}
} while (CM_Get_Sibling(&childID, childID, 0) == CR_SUCCESS);
}
loader_instance_heap_free(inst, pDeviceNames);
}
if (!found && result != VK_ERROR_OUT_OF_HOST_MEMORY) {
loader_log(inst, log_target_flag, 0, "windows_get_device_registry_files: found no registry files");
result = VK_ERROR_INCOMPATIBLE_DRIVER;
}
return result;
}
VkResult windows_get_registry_files(const struct loader_instance *inst, char *location, bool use_secondary_hive, char **reg_data,
PDWORD reg_data_size) {
// This list contains all of the allowed ICDs. This allows us to verify that a device is actually present from the vendor
// specified. This does disallow other vendors, but any new driver should use the device-specific registries anyway.
const struct {
const char *filename;
unsigned int vendor_id;
} known_drivers[] = {
#if defined(_WIN64)
{
.filename = "igvk64.json",
.vendor_id = 0x8086,
},
{
.filename = "nv-vk64.json",
.vendor_id = 0x10de,
},
{
.filename = "amd-vulkan64.json",
.vendor_id = 0x1002,
},
{
.filename = "amdvlk64.json",
.vendor_id = 0x1002,
},
#else
{
.filename = "igvk32.json",
.vendor_id = 0x8086,
},
{
.filename = "nv-vk32.json",
.vendor_id = 0x10de,
},
{
.filename = "amd-vulkan32.json",
.vendor_id = 0x1002,
},
{
.filename = "amdvlk32.json",
.vendor_id = 0x1002,
},
#endif
};
LONG rtn_value;
HKEY hive = DEFAULT_VK_REGISTRY_HIVE, key;
DWORD access_flags;
char name[2048];
char *loc = location;
char *next;
DWORD name_size = sizeof(name);
DWORD value;
DWORD value_size = sizeof(value);
VkResult result = VK_SUCCESS;
bool found = false;
IDXGIFactory1 *dxgi_factory = NULL;
bool is_driver = !strcmp(location, VK_DRIVERS_INFO_REGISTRY_LOC);
uint32_t log_target_flag = is_driver ? VULKAN_LOADER_DRIVER_BIT : VULKAN_LOADER_LAYER_BIT;
assert(reg_data != NULL && "windows_get_registry_files: reg_data is a NULL pointer");
if (is_driver) {
HRESULT hres = fpCreateDXGIFactory1(&IID_IDXGIFactory1, (void **)&dxgi_factory);
if (hres != S_OK) {
loader_log(inst, VULKAN_LOADER_WARN_BIT | log_target_flag, 0,
"windows_get_registry_files: Failed to create dxgi factory for ICD registry verification. No ICDs will be "
"added from "
"legacy registry locations");
goto out;
}
}
while (*loc) {
next = loader_get_next_path(loc);
access_flags = KEY_QUERY_VALUE;
rtn_value = RegOpenKeyEx(hive, loc, 0, access_flags, &key);
if (ERROR_SUCCESS == rtn_value) {
for (DWORD idx = 0;
(rtn_value = RegEnumValue(key, idx++, name, &name_size, NULL, NULL, (LPBYTE)&value, &value_size)) == ERROR_SUCCESS;
name_size = sizeof(name), value_size = sizeof(value)) {
if (value_size == sizeof(value) && value == 0) {
if (NULL == *reg_data) {
*reg_data = loader_instance_heap_alloc(inst, *reg_data_size, VK_SYSTEM_ALLOCATION_SCOPE_INSTANCE);
if (NULL == *reg_data) {
loader_log(inst, VULKAN_LOADER_ERROR_BIT | log_target_flag, 0,
"windows_get_registry_files: Failed to allocate space for registry data for key %s", name);
RegCloseKey(key);
result = VK_ERROR_OUT_OF_HOST_MEMORY;
goto out;
}
*reg_data[0] = '\0';
} else if (strlen(*reg_data) + name_size + 1 > *reg_data_size) {
void *new_ptr = loader_instance_heap_realloc(inst, *reg_data, *reg_data_size, *reg_data_size * 2,
VK_SYSTEM_ALLOCATION_SCOPE_INSTANCE);
if (NULL == new_ptr) {
loader_log(
inst, VULKAN_LOADER_ERROR_BIT | log_target_flag, 0,
"windows_get_registry_files: Failed to reallocate space for registry value of size %d for key %s",
*reg_data_size * 2, name);
RegCloseKey(key);
result = VK_ERROR_OUT_OF_HOST_MEMORY;
goto out;
}
*reg_data = new_ptr;
*reg_data_size *= 2;
}
// We've now found a json file. If this is an ICD, we still need to check if there is actually a device
// that matches this ICD
loader_log(inst, VULKAN_LOADER_INFO_BIT | log_target_flag, 0,
"Located json file \"%s\" from registry \"%s\\%s\"", name,
hive == DEFAULT_VK_REGISTRY_HIVE ? DEFAULT_VK_REGISTRY_HIVE_STR : SECONDARY_VK_REGISTRY_HIVE_STR,
location);
if (is_driver) {
uint32_t i = 0;
for (i = 0; i < sizeof(known_drivers) / sizeof(known_drivers[0]); ++i) {
if (!strcmp(name + strlen(name) - strlen(known_drivers[i].filename), known_drivers[i].filename)) {
break;
}
}
if (i == sizeof(known_drivers) / sizeof(known_drivers[0])) {
loader_log(inst, VULKAN_LOADER_INFO_BIT | log_target_flag, 0,
"Driver %s is not recognized as a known driver. It will be assumed to be active", name);
} else {
bool found_gpu = false;
for (int j = 0;; ++j) {
IDXGIAdapter1 *adapter;
HRESULT hres = dxgi_factory->lpVtbl->EnumAdapters1(dxgi_factory, j, &adapter);
if (hres == DXGI_ERROR_NOT_FOUND) {
break;
} else if (hres != S_OK) {
loader_log(inst, VULKAN_LOADER_WARN_BIT | log_target_flag, 0,
"Failed to enumerate DXGI adapters at index %d. As a result, drivers may be skipped",
j);
continue;
}
DXGI_ADAPTER_DESC1 description;
hres = adapter->lpVtbl->GetDesc1(adapter, &description);
if (hres != S_OK) {
loader_log(
inst, VULKAN_LOADER_INFO_BIT | log_target_flag, 0,
"Failed to get DXGI adapter information at index %d. As a result, drivers may be skipped",
j);
continue;
}
if (description.VendorId == known_drivers[i].vendor_id) {
found_gpu = true;
break;
}
}
if (!found_gpu) {
loader_log(inst, VULKAN_LOADER_INFO_BIT | log_target_flag, 0,
"Dropping driver %s as no corresponding DXGI adapter was found", name);
continue;
}
}
}
if (strlen(*reg_data) == 0) {
// The list is emtpy. Add the first entry.
(void)snprintf(*reg_data, name_size + 1, "%s", name);
found = true;
} else {
// At this point the reg_data variable contains other JSON paths, likely from the PNP/device section
// of the registry that we want to have precedence over this non-device specific section of the registry.
// To make sure we avoid enumerating old JSON files/drivers that might be present in the non-device specific
// area of the registry when a newer device specific JSON file is present, do a check before adding.
// Find the file name, without path, of the JSON file found in the non-device specific registry location.
// If the same JSON file name is already found in the list, don't add it again.
bool foundDuplicate = false;
char *pLastSlashName = strrchr(name, '\\');
if (pLastSlashName != NULL) {
char *foundMatch = strstr(*reg_data, pLastSlashName + 1);
if (foundMatch != NULL) {
foundDuplicate = true;
}
}
// Only skip if we are adding a driver and a duplicate was found
if (!is_driver || (is_driver && foundDuplicate == false)) {
// Add the new entry to the list.
(void)snprintf(*reg_data + strlen(*reg_data), name_size + 2, "%c%s", PATH_SEPARATOR, name);
found = true;
} else {
loader_log(
inst, VULKAN_LOADER_INFO_BIT | log_target_flag, 0,
"Skipping adding of json file \"%s\" from registry \"%s\\%s\" to the list due to duplication", name,
hive == DEFAULT_VK_REGISTRY_HIVE ? DEFAULT_VK_REGISTRY_HIVE_STR : SECONDARY_VK_REGISTRY_HIVE_STR,
location);
}
}
}
}
RegCloseKey(key);
}
// Advance the location - if the next location is in the secondary hive, then reset the locations and advance the hive
if (use_secondary_hive && (hive == DEFAULT_VK_REGISTRY_HIVE) && (*next == '\0')) {
loc = location;
hive = SECONDARY_VK_REGISTRY_HIVE;
} else {
loc = next;
}
}
if (!found && result != VK_ERROR_OUT_OF_HOST_MEMORY) {
loader_log(inst, log_target_flag, 0, "Found no registry files in %s\\%s",
(hive == DEFAULT_VK_REGISTRY_HIVE) ? DEFAULT_VK_REGISTRY_HIVE_STR : SECONDARY_VK_REGISTRY_HIVE_STR, location);
result = VK_ERROR_INCOMPATIBLE_DRIVER;
}
out:
if (is_driver && dxgi_factory != NULL) {
dxgi_factory->lpVtbl->Release(dxgi_factory);
}
return result;
}
// Read manifest JSON files using the Windows driver interface
VkResult windows_read_manifest_from_d3d_adapters(const struct loader_instance *inst, char **reg_data, PDWORD reg_data_size,
const wchar_t *value_name) {
VkResult result = VK_INCOMPLETE;
LoaderEnumAdapters2 adapters = {.adapter_count = 0, .adapters = NULL};
LoaderQueryRegistryInfo *full_info = NULL;
size_t full_info_size = 0;
char *json_path = NULL;
size_t json_path_size = 0;
HMODULE gdi32_dll = GetModuleHandle("gdi32.dll");
if (gdi32_dll == NULL) {
result = VK_ERROR_INCOMPATIBLE_DRIVER;
goto out;
}
PFN_LoaderEnumAdapters2 fpLoaderEnumAdapters2 =
(PFN_LoaderEnumAdapters2)(void *)GetProcAddress(gdi32_dll, "D3DKMTEnumAdapters2");
PFN_LoaderQueryAdapterInfo fpLoaderQueryAdapterInfo =
(PFN_LoaderQueryAdapterInfo)(void *)GetProcAddress(gdi32_dll, "D3DKMTQueryAdapterInfo");
if (fpLoaderEnumAdapters2 == NULL || fpLoaderQueryAdapterInfo == NULL) {
result = VK_ERROR_INCOMPATIBLE_DRIVER;
goto out;
}
// Get all of the adapters
NTSTATUS status = fpLoaderEnumAdapters2(&adapters);
if (status == STATUS_SUCCESS && adapters.adapter_count > 0) {
adapters.adapters = loader_instance_heap_alloc(inst, sizeof(*adapters.adapters) * adapters.adapter_count,
VK_SYSTEM_ALLOCATION_SCOPE_COMMAND);
if (adapters.adapters == NULL) {
goto out;
}
status = fpLoaderEnumAdapters2(&adapters);
}
if (status != STATUS_SUCCESS) {
goto out;
}
// If that worked, we need to get the manifest file(s) for each adapter
for (ULONG i = 0; i < adapters.adapter_count; ++i) {
// The first query should just check if the field exists and how big it is
LoaderQueryRegistryInfo filename_info = {
.query_type = LOADER_QUERY_REGISTRY_ADAPTER_KEY,
.query_flags =
{
.translate_path = true,
},
.value_type = REG_MULTI_SZ,
.physical_adapter_index = 0,
};
size_t value_name_size = wcslen(value_name);
wcsncpy_s(filename_info.value_name, MAX_PATH, value_name, value_name_size);
LoaderQueryAdapterInfo query_info;
query_info.handle = adapters.adapters[i].handle;
query_info.type = LOADER_QUERY_TYPE_REGISTRY;
query_info.private_data = &filename_info;
query_info.private_data_size = sizeof(filename_info);
status = fpLoaderQueryAdapterInfo(&query_info);
// This error indicates that the type didn't match, so we'll try a REG_SZ
if (status != STATUS_SUCCESS) {
filename_info.value_type = REG_SZ;
status = fpLoaderQueryAdapterInfo(&query_info);
}
if (status != STATUS_SUCCESS || filename_info.status != LOADER_QUERY_REGISTRY_STATUS_BUFFER_OVERFLOW) {
continue;
}
while (status == STATUS_SUCCESS &&
((LoaderQueryRegistryInfo *)query_info.private_data)->status == LOADER_QUERY_REGISTRY_STATUS_BUFFER_OVERFLOW) {
bool needs_copy = (full_info == NULL);
size_t full_size = sizeof(LoaderQueryRegistryInfo) + filename_info.output_value_size;
void *buffer =
loader_instance_heap_realloc(inst, full_info, full_info_size, full_size, VK_SYSTEM_ALLOCATION_SCOPE_COMMAND);
if (buffer == NULL) {
result = VK_ERROR_OUT_OF_HOST_MEMORY;
goto out;
}
full_info = buffer;
full_info_size = full_size;
if (needs_copy) {
memcpy(full_info, &filename_info, sizeof(LoaderQueryRegistryInfo));
}
query_info.private_data = full_info;
query_info.private_data_size = (UINT)full_info_size;
status = fpLoaderQueryAdapterInfo(&query_info);
}
if (status != STATUS_SUCCESS || full_info->status != LOADER_QUERY_REGISTRY_STATUS_SUCCESS) {
goto out;
}
// Convert the wide string to a narrow string
void *buffer = loader_instance_heap_realloc(inst, json_path, json_path_size, full_info->output_value_size,
VK_SYSTEM_ALLOCATION_SCOPE_COMMAND);
if (buffer == NULL) {
result = VK_ERROR_OUT_OF_HOST_MEMORY;
goto out;
}
json_path = buffer;
json_path_size = full_info->output_value_size;
// Iterate over each component string
for (const wchar_t *curr_path = full_info->output_string; curr_path[0] != '\0'; curr_path += wcslen(curr_path) + 1) {
WideCharToMultiByte(CP_UTF8, 0, curr_path, -1, json_path, (int)json_path_size, NULL, NULL);
// Add the string to the output list
result = VK_SUCCESS;
windows_add_json_entry(inst, reg_data, reg_data_size, (LPCTSTR)L"EnumAdapters", REG_SZ, json_path,
(DWORD)strlen(json_path) + 1, &result);
if (result != VK_SUCCESS) {
goto out;
}
// If this is a string and not a multi-string, we don't want to go throught the loop more than once
if (full_info->value_type == REG_SZ) {
break;
}
}
}
out:
loader_instance_heap_free(inst, json_path);
loader_instance_heap_free(inst, full_info);
loader_instance_heap_free(inst, adapters.adapters);
return result;
}
// Look for data files in the registry.
VkResult windows_read_data_files_in_registry(const struct loader_instance *inst, enum loader_data_files_type data_file_type,
bool warn_if_not_present, char *registry_location,
struct loader_string_list *out_files) {
VkResult vk_result = VK_SUCCESS;
char *search_path = NULL;
uint32_t log_target_flag = 0;
if (data_file_type == LOADER_DATA_FILE_MANIFEST_DRIVER) {
log_target_flag = VULKAN_LOADER_DRIVER_BIT;
loader_log(inst, log_target_flag, 0, "Checking for Driver Manifest files in Registry at %s\\%s",
DEFAULT_VK_REGISTRY_HIVE_STR, registry_location);
} else {
log_target_flag = VULKAN_LOADER_LAYER_BIT;
loader_log(inst, log_target_flag, 0, "Checking for Layer Manifest files in Registry at %s\\%s",
DEFAULT_VK_REGISTRY_HIVE_STR, registry_location);
}
// These calls look at the PNP/Device section of the registry.
VkResult regHKR_result = VK_SUCCESS;
DWORD reg_size = 4096;
if (!strncmp(registry_location, VK_DRIVERS_INFO_REGISTRY_LOC, sizeof(VK_DRIVERS_INFO_REGISTRY_LOC))) {
// If we're looking for drivers we need to try enumerating adapters
regHKR_result = windows_read_manifest_from_d3d_adapters(inst, &search_path, ®_size, LoaderPnpDriverRegistryWide());
if (regHKR_result == VK_INCOMPLETE) {
regHKR_result =
windows_get_device_registry_files(inst, log_target_flag, &search_path, ®_size, LoaderPnpDriverRegistry());
}
} else if (!strncmp(registry_location, VK_ELAYERS_INFO_REGISTRY_LOC, sizeof(VK_ELAYERS_INFO_REGISTRY_LOC))) {
regHKR_result = windows_read_manifest_from_d3d_adapters(inst, &search_path, ®_size, LoaderPnpELayerRegistryWide());
if (regHKR_result == VK_INCOMPLETE) {
regHKR_result =
windows_get_device_registry_files(inst, log_target_flag, &search_path, ®_size, LoaderPnpELayerRegistry());
}
} else if (!strncmp(registry_location, VK_ILAYERS_INFO_REGISTRY_LOC, sizeof(VK_ILAYERS_INFO_REGISTRY_LOC))) {
regHKR_result = windows_read_manifest_from_d3d_adapters(inst, &search_path, ®_size, LoaderPnpILayerRegistryWide());
if (regHKR_result == VK_INCOMPLETE) {
regHKR_result =
windows_get_device_registry_files(inst, log_target_flag, &search_path, ®_size, LoaderPnpILayerRegistry());
}
}
if (regHKR_result == VK_ERROR_OUT_OF_HOST_MEMORY) {
vk_result = VK_ERROR_OUT_OF_HOST_MEMORY;
goto out;
}
// This call looks into the Khronos non-device specific section of the registry for layer files.
bool use_secondary_hive = (data_file_type != LOADER_DATA_FILE_MANIFEST_DRIVER) && (!is_high_integrity());
VkResult reg_result = windows_get_registry_files(inst, registry_location, use_secondary_hive, &search_path, ®_size);
if (reg_result == VK_ERROR_OUT_OF_HOST_MEMORY) {
vk_result = VK_ERROR_OUT_OF_HOST_MEMORY;
goto out;
}
if ((VK_SUCCESS != reg_result && VK_SUCCESS != regHKR_result) || NULL == search_path) {
if (data_file_type == LOADER_DATA_FILE_MANIFEST_DRIVER) {
loader_log(inst, VULKAN_LOADER_ERROR_BIT | log_target_flag, 0,
"windows_read_data_files_in_registry: Registry lookup failed to get ICD manifest files. Possibly missing "
"Vulkan driver?");
vk_result = VK_ERROR_INCOMPATIBLE_DRIVER;
} else {
if (warn_if_not_present) {
if (data_file_type == LOADER_DATA_FILE_MANIFEST_IMPLICIT_LAYER ||
data_file_type == LOADER_DATA_FILE_MANIFEST_EXPLICIT_LAYER) {
// This is only a warning for layers
loader_log(inst, VULKAN_LOADER_WARN_BIT | log_target_flag, 0,
"windows_read_data_files_in_registry: Registry lookup failed to get layer manifest files.");
} else {
// This is only a warning for general data files
loader_log(inst, VULKAN_LOADER_WARN_BIT | log_target_flag, 0,
"windows_read_data_files_in_registry: Registry lookup failed to get data files.");
}
}
// Return success for now since it's not critical for layers
vk_result = VK_SUCCESS;
}
goto out;
}
// Now, parse the paths and add any manifest files found in them.
vk_result = add_data_files(inst, search_path, out_files, false);
out:
loader_instance_heap_free(inst, search_path);
return vk_result;
}
// This function allocates an array in sorted_devices which must be freed by the caller if not null
VkResult windows_read_sorted_physical_devices(struct loader_instance *inst, uint32_t *sorted_devices_count,
struct loader_phys_dev_per_icd **sorted_devices) {
VkResult res = VK_SUCCESS;
uint32_t sorted_alloc = 0;
struct loader_icd_term *icd_term = NULL;
IDXGIFactory6 *dxgi_factory = NULL;
HRESULT hres = fpCreateDXGIFactory1(&IID_IDXGIFactory6, (void **)&dxgi_factory);
if (hres != S_OK) {
loader_log(inst, VULKAN_LOADER_INFO_BIT, 0, "Failed to create DXGI factory 6. Physical devices will not be sorted");
goto out;
}
sorted_alloc = 16;
*sorted_devices = loader_instance_heap_calloc(inst, sorted_alloc * sizeof(struct loader_phys_dev_per_icd),
VK_SYSTEM_ALLOCATION_SCOPE_COMMAND);
if (*sorted_devices == NULL) {
res = VK_ERROR_OUT_OF_HOST_MEMORY;
goto out;
}
for (uint32_t i = 0;; ++i) {
IDXGIAdapter1 *adapter;
hres = dxgi_factory->lpVtbl->EnumAdapterByGpuPreference(dxgi_factory, i, DXGI_GPU_PREFERENCE_UNSPECIFIED,
&IID_IDXGIAdapter1, (void **)&adapter);
if (hres == DXGI_ERROR_NOT_FOUND) {
break; // No more adapters
} else if (hres != S_OK) {
loader_log(inst, VULKAN_LOADER_WARN_BIT, 0,
"Failed to enumerate adapters by GPU preference at index %u. This adapter will not be sorted", i);
break;
}
DXGI_ADAPTER_DESC1 description;
hres = adapter->lpVtbl->GetDesc1(adapter, &description);
if (hres != S_OK) {
loader_log(inst, VULKAN_LOADER_WARN_BIT, 0, "Failed to get adapter LUID index %u. This adapter will not be sorted", i);
continue;
}
if (sorted_alloc <= i) {
uint32_t old_size = sorted_alloc * sizeof(struct loader_phys_dev_per_icd);
*sorted_devices =
loader_instance_heap_realloc(inst, *sorted_devices, old_size, 2 * old_size, VK_SYSTEM_ALLOCATION_SCOPE_COMMAND);
if (*sorted_devices == NULL) {
adapter->lpVtbl->Release(adapter);
res = VK_ERROR_OUT_OF_HOST_MEMORY;
goto out;
}
sorted_alloc *= 2;
}
struct loader_phys_dev_per_icd *sorted_array = *sorted_devices;
sorted_array[*sorted_devices_count].device_count = 0;
sorted_array[*sorted_devices_count].physical_devices = NULL;
icd_term = inst->icd_terms;
for (uint32_t icd_idx = 0; NULL != icd_term; icd_term = icd_term->next, icd_idx++) {
// This is the new behavior, which cannot be run unless the ICD provides EnumerateAdapterPhysicalDevices
if (icd_term->scanned_icd->EnumerateAdapterPhysicalDevices == NULL) {
continue;
}
uint32_t count = 0;
VkResult vkres =
icd_term->scanned_icd->EnumerateAdapterPhysicalDevices(icd_term->instance, description.AdapterLuid, &count, NULL);
if (vkres == VK_ERROR_INCOMPATIBLE_DRIVER) {
continue; // This driver doesn't support the adapter
} else if (vkres == VK_ERROR_OUT_OF_HOST_MEMORY) {
res = VK_ERROR_OUT_OF_HOST_MEMORY;
goto out;
} else if (vkres != VK_SUCCESS) {
loader_log(inst, VULKAN_LOADER_WARN_BIT, 0,
"Failed to convert DXGI adapter into Vulkan physical device with unexpected error code");
continue;
}
// Get the actual physical devices
if (0 != count) {
do {
sorted_array[*sorted_devices_count].physical_devices =
loader_instance_heap_realloc(inst, sorted_array[*sorted_devices_count].physical_devices,
sorted_array[*sorted_devices_count].device_count * sizeof(VkPhysicalDevice),
count * sizeof(VkPhysicalDevice), VK_SYSTEM_ALLOCATION_SCOPE_COMMAND);
if (sorted_array[*sorted_devices_count].physical_devices == NULL) {
res = VK_ERROR_OUT_OF_HOST_MEMORY;
break;
}
sorted_array[*sorted_devices_count].device_count = count;
} while ((vkres = icd_term->scanned_icd->EnumerateAdapterPhysicalDevices(
icd_term->instance, description.AdapterLuid, &count,
sorted_array[*sorted_devices_count].physical_devices)) == VK_INCOMPLETE);
}
if (vkres != VK_SUCCESS) {
loader_instance_heap_free(inst, sorted_array[*sorted_devices_count].physical_devices);
sorted_array[*sorted_devices_count].physical_devices = NULL;
if (vkres == VK_ERROR_OUT_OF_HOST_MEMORY) {
res = VK_ERROR_OUT_OF_HOST_MEMORY;
goto out;
} else {
loader_log(inst, VULKAN_LOADER_WARN_BIT, 0, "Failed to convert DXGI adapter into Vulkan physical device");
continue;
}
}
sorted_array[*sorted_devices_count].device_count = count;
sorted_array[*sorted_devices_count].icd_index = icd_idx;
sorted_array[*sorted_devices_count].icd_term = icd_term;
(*sorted_devices_count)++;
}
adapter->lpVtbl->Release(adapter);
}
dxgi_factory->lpVtbl->Release(dxgi_factory);
out:
if (*sorted_devices_count == 0 && *sorted_devices != NULL) {
loader_instance_heap_free(inst, *sorted_devices);
*sorted_devices = NULL;
}
*sorted_devices_count = *sorted_devices_count;
*sorted_devices = *sorted_devices;
return res;
}
VkLoaderFeatureFlags windows_initialize_dxgi(void) {
VkLoaderFeatureFlags feature_flags = 0;
IDXGIFactory6 *dxgi_factory = NULL;
HRESULT hres = fpCreateDXGIFactory1(&IID_IDXGIFactory6, (void **)&dxgi_factory);
if (hres == S_OK) {
feature_flags |= VK_LOADER_FEATURE_PHYSICAL_DEVICE_SORTING;
dxgi_factory->lpVtbl->Release(dxgi_factory);
}
return feature_flags;
}
// Sort the VkPhysicalDevices that are part of the current group with the list passed in from the sorted list.
// Multiple groups could have devices out of the same sorted list, however, a single group's devices must all come
// from the same sorted list.
void windows_sort_devices_in_group(struct loader_instance *inst, struct VkPhysicalDeviceGroupProperties *group_props,
struct loader_phys_dev_per_icd *icd_sorted_list) {
uint32_t cur_index = 0;
for (uint32_t dev = 0; dev < icd_sorted_list->device_count; ++dev) {
for (uint32_t grp_dev = cur_index; grp_dev < group_props->physicalDeviceCount; ++grp_dev) {
if (icd_sorted_list->physical_devices[dev] == group_props->physicalDevices[grp_dev]) {
if (cur_index != grp_dev) {
VkPhysicalDevice swap_dev = group_props->physicalDevices[cur_index];
group_props->physicalDevices[cur_index] = group_props->physicalDevices[grp_dev];
group_props->physicalDevices[grp_dev] = swap_dev;
}
cur_index++;
break;
}
}
}
if (cur_index == 0) {
loader_log(inst, VULKAN_LOADER_WARN_BIT, 0,
"windows_sort_devices_in_group: Never encountered a device in the sorted list group");
}
}
// This function sorts an array in physical device groups based on the sorted physical device information
VkResult windows_sort_physical_device_groups(struct loader_instance *inst, const uint32_t group_count,
struct loader_physical_device_group_term *sorted_group_term,
const uint32_t sorted_device_count,
struct loader_phys_dev_per_icd *sorted_phys_dev_array) {
if (0 == group_count || NULL == sorted_group_term) {
loader_log(inst, VULKAN_LOADER_WARN_BIT, 0,
"windows_sort_physical_device_groups: Called with invalid information (Group count %d, Sorted Info %p)",
group_count, sorted_group_term);
return VK_ERROR_INITIALIZATION_FAILED;
}
uint32_t new_index = 0;
for (uint32_t icd = 0; icd < sorted_device_count; ++icd) {
for (uint32_t dev = 0; dev < sorted_phys_dev_array[icd].device_count; ++dev) {
// Find a group associated with a given device
for (uint32_t group = new_index; group < group_count; ++group) {
bool device_found = false;
// Look for the current sorted device in a group and put it in the correct location if it isn't already
for (uint32_t grp_dev = 0; grp_dev < sorted_group_term[group].group_props.physicalDeviceCount; ++grp_dev) {
if (sorted_group_term[group].group_props.physicalDevices[grp_dev] ==
sorted_phys_dev_array[icd].physical_devices[dev]) {
// First, sort devices inside of group to be in priority order
windows_sort_devices_in_group(inst, &sorted_group_term[group].group_props, &sorted_phys_dev_array[icd]);
// Second, move the group up in priority if it needs to be
if (new_index != group) {
struct loader_physical_device_group_term tmp = sorted_group_term[new_index];
sorted_group_term[new_index] = sorted_group_term[group];
sorted_group_term[group] = tmp;
}
device_found = true;
new_index++;
break;
}
}
if (device_found) {
break;
}
}
}
}
return VK_SUCCESS;
}