-
Notifications
You must be signed in to change notification settings - Fork 170
/
Copy pathigc_regkeys.cpp
1398 lines (1236 loc) · 47.2 KB
/
igc_regkeys.cpp
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
/*========================== begin_copyright_notice ============================
Copyright (C) 2017-2021 Intel Corporation
SPDX-License-Identifier: MIT
============================= end_copyright_notice ===========================*/
#include "igc_regkeys.hpp"
#if defined(IGC_DEBUG_VARIABLES)
#include "common/LLVMWarningsPush.hpp"
#include <llvm/ADT/StringRef.h>
#include <llvm/ADT/StringSwitch.h>
#include <llvm/Support/CommandLine.h>
#include "common/LLVMWarningsPop.hpp"
#include "3d/common/iStdLib/File.h"
#include "secure_mem.h"
#include "secure_string.h"
#include "AdaptorCommon/customApi.hpp"
#if defined(_WIN64) || defined(_WIN32)
#include <devguid.h> // for GUID_DEVCLASS_DISPLAY
#include <initguid.h> // for DEVPKEY_*
#include <Devpkey.h> // for DEVPKEY_*
#include <SetupAPI.h>
#include <Shlwapi.h>
#include <algorithm>
#endif
#include <list>
#include <vector>
#include <string>
#include <utility>
#include <fstream>
#include <sstream>
#include <iostream>
#include <mutex>
#include <algorithm>
#include <optional>
#include "Probe/Assertion.h"
#include "common/Types.hpp"
// path for IGC registry keys
#define IGC_REGISTRY_KEY "SOFTWARE\\INTEL\\IGFX\\IGC"
SRegKeysList g_RegKeyList;
#if defined(_WIN64) || defined(_WIN32)
DEVICE_INFO::DEVICE_INFO(DEVINST deviceInstance)
{
deviceID = 0;
revisionID = 0;
pciBus = 0;
pciDevice = 0;
pciFunction = 0;
get_device_property(deviceInstance, CM_DRP_DEVICEDESC);
get_device_property(deviceInstance, CM_DRP_COMPATIBLEIDS);
get_device_property(deviceInstance, CM_DRP_DRIVER);
get_device_property(deviceInstance, CM_DRP_LOCATION_INFORMATION);
}
void DEVICE_INFO::get_device_property(DEVINST deviceInstace, DWORD property)
{
wchar_t propertyData[MAX_PATH];
DWORD propertyDataLength = 0;
// First get the size of the data
CONFIGRET status = CM_Get_DevNode_Registry_PropertyW(
deviceInstace,
property,
NULL,
NULL,
&propertyDataLength,
0);
// Then fetch the actual property data
if(CR_BUFFER_SMALL == status)
{
status = CM_Get_DevNode_Registry_PropertyW(
deviceInstace,
property,
NULL,
&propertyData[0],
&propertyDataLength,
0);
}
if(CR_SUCCESS == status)
{
// Convert from UTF-16 (wide char) to UTF-8
DWORD convertedStringSize = WideCharToMultiByte(CP_UTF8, 0, &propertyData[0], sizeof(propertyData), NULL, 0, NULL, NULL);
std::string propertyString(convertedStringSize, 0);
WideCharToMultiByte(CP_UTF8, 0, &propertyData[0], sizeof(propertyData), &propertyString[0], convertedStringSize, NULL, NULL);
switch(property)
{
case CM_DRP_COMPATIBLEIDS:
// PCI\VEN_8086&DEV_1912&REV_06
sscanf_s(propertyString.c_str(), "PCI\\VEN_8086&DEV_%x&REV_%x", &deviceID, &revisionID);
break;
case CM_DRP_DEVICEDESC:
// Intel(R) HD Graphics 530
description = propertyString.c_str();
break;
case CM_DRP_DRIVER:
// {4d36e968-e325-11ce-bfc1-08002be10318}\0001
driverRegistryPath = propertyString.c_str();
break;
case CM_DRP_LOCATION_INFORMATION:
// PCI bus 0, device 2, function 0
sscanf_s(propertyString.c_str(), "PCI bus %u, device %u, function %u", &pciBus, &pciDevice, &pciFunction);
break;
}
}
else if(CR_NO_SUCH_VALUE == status)
{
IGC_ASSERT_MESSAGE(0, "No such property value");
}
else
{
IGC_ASSERT_MESSAGE(0, "Failed to get DevNode property");
}
}
/********************************************************************************************/
/* Function: ConvertDoubleNullTermStringToVector */
/* */
/* Converts a Unicode string with embedded null characters */
/* into a vector of strings */
/* */
/********************************************************************************************/
static void ConvertDoubleNullTermStringToVector(std::vector<wchar_t>& input_str, std::vector<std::wstring>& output_vec)
{
// Remove terminating null character to avoid adding empty string at the end
input_str.resize(input_str.size() - 1);
std::wstring str;
std::for_each(input_str.cbegin(), input_str.cend(), [&](const wchar_t& w)
{
if (w != L'\0')
{
str += w;
}
else
{
output_vec.push_back(str);
str = L"";
}
});
}
/*********************************************************************************************/
/* GetPropertyFromDevice */
/* */
/* This function can be used to request a value of any device property. */
/* There are many types of properties values. Refer to devpkey.h for more details. */
/* Function SetupDiGetDeviceProperty() inside GetPropertyFromDevice() fills a property value */
/* in a correct format, but always returns the value as a pointer to a string of bytes. */
/* The string of bytes must be casted outside of the function GetPropertyFromDevice() */
/* to get a value in a format suitable for the given type of property. */
/* */
/*********************************************************************************************/
static bool GetPropertyFromDevice(
DEVINST devInst,
const DEVPROPKEY& PropertyKey,
std::vector<BYTE>& PropertyData)
{
unsigned long propertySize = 0;
DEVPROPTYPE propertyType;
// request a size, in bytes, required for a buffer in which property value will be stored.
// CM_Get_DevNode_PropertyW() returns false and ERROR_INSUFFICIENT_BUFFER for the call
CONFIGRET status = CM_Get_DevNode_PropertyW(devInst, &PropertyKey, &propertyType, NULL, &propertySize, 0);
if (status != CR_BUFFER_SMALL)
{
IGC_ASSERT_MESSAGE(0, "CM_Get_DevNode_PropertyW() failed, status indicates error code");
return false;
}
// allocate memory for the buffer
PropertyData.clear();
PropertyData.resize(propertySize, 0);
// fill in the buffer with property value
status = CM_Get_DevNode_PropertyW(devInst, &PropertyKey, &propertyType, &PropertyData[0], &propertySize, 0);
if (status != CR_SUCCESS)
{
IGC_ASSERT_MESSAGE(0, "CM_Get_DevNode_PropertyW() failed, status indicates error code");
PropertyData.clear();
return false;
}
return true;
}
/********************************************************************************************/
/* ObtainDeviceInstance */
/* */
/* Obtains a device instance for the Intel graphics adapter */
/********************************************************************************************/
static HRESULT ObtainDeviceInstances(std::vector<DEVINST>* pDevInstances)
{
CONFIGRET cr = CR_SUCCESS;
ULONG DeviceIDListSize = 0;
std::vector<wchar_t> DeviceIDList;
std::vector<std::wstring> Devices;
std::wstring IntelDeviceID;
wchar_t DisplayDevClassGUID[40];
do
{
if (pDevInstances == nullptr)
{
cr = CR_INVALID_POINTER;
break;
}
StringFromGUID2(GUID_DEVCLASS_DISPLAY, DisplayDevClassGUID, sizeof(DisplayDevClassGUID));
do
{
DeviceIDListSize = 0;
cr = CM_Get_Device_ID_List_SizeW(
&DeviceIDListSize,
DisplayDevClassGUID,
CM_GETIDLIST_FILTER_CLASS); // we don't want to use CM_GETIDLIST_FILTER_PRESENT in order to support safe mode.
if (cr != CR_SUCCESS)
{
break;
}
if (DeviceIDList.max_size() >= DeviceIDListSize && DeviceIDListSize > 0)
DeviceIDList.resize(DeviceIDListSize);
else
{
return E_ABORT;
}
cr = CM_Get_Device_ID_ListW(
DisplayDevClassGUID,
DeviceIDList.data(),
DeviceIDListSize,
CM_GETIDLIST_FILTER_CLASS);
} while (cr == CR_BUFFER_SMALL);
if (cr != CR_SUCCESS)
{
break;
}
ConvertDoubleNullTermStringToVector(DeviceIDList, Devices);
for (auto device : Devices)
{
if ((device.find(L"VEN_8086") != std::wstring::npos) ||
(device.find(L"ven_8086") != std::wstring::npos))
{
// Found an intel device, add it to the list
DEVINST devInst;
CONFIGRET crLocateDevNode = CM_Locate_DevNodeW(
&devInst,
const_cast<wchar_t*>(device.c_str()),
CM_LOCATE_DEVNODE_NORMAL);
if (crLocateDevNode == CR_NO_SUCH_DEVNODE)
{
// There can be many drivers on the system from past installs.
// CR_NO_SUCH_DEVNODE is returned for drivers that don't match any devices.
// It's ok to skip these.
continue;
}
else
{
if (crLocateDevNode == CR_SUCCESS)
{
pDevInstances->push_back(devInst);
}
// Update the overall status
cr |= crLocateDevNode;
}
}
}
} while (FALSE);
return HRESULT_FROM_WIN32(CM_MapCrToWin32Err(cr, ERROR_FILE_NOT_FOUND));
}
/************************************************************************/
/* GetIntelDriverPaths */
/* */
/* Build a list of Intel graphics driver installation paths. */
/* */
/************************************************************************/
static size_t GetIntelDriverPaths(std::vector<DEVINST>& drivers)
{
drivers.clear();
HRESULT hr = ObtainDeviceInstances(&drivers);
if (FAILED(hr))
{
IGC_ASSERT_MESSAGE(0, "Failed to find any graphics device instances");
return 0;
}
return drivers.size();
}
std::string getNewRegistryPath(DEVINST deviceInstance)
{
DEVICE_INFO devInfo(deviceInstance);
return devInfo.driverRegistryPath;
}
#endif
/*****************************************************************************\
ReadIGCEnv
\*****************************************************************************/
static bool ReadIGCEnv(
const char* pName,
void* pValue,
unsigned int size )
{
if( pName != NULL )
{
const char nameTag[] = "IGC_";
std::string pKey = std::string(nameTag) + std::string(pName);
const char* envVal = getenv(pKey.c_str());
if( envVal != NULL )
{
if( size >= sizeof( unsigned int ) )
{
// Try integer conversion
if (envVal[0] == '0' && std::tolower(envVal[1]) == 'b')
{
// Binary literals, like in C++14
// Example: 0b0110'11'01
std::string str(envVal + 2); // -> 0110'11'01
// Remove optional C++14 digit separators and squeeze the result
str.erase(std::remove(str.begin(), str.end(), '\''), str.end()); // -> 01101101
std::size_t pos = 0;
int val = std::stoi(str, &pos, 2);
if (pos > 0 && pos == str.size())
{
*reinterpret_cast<unsigned int*>(pValue) = int_cast<unsigned int>(val);
return true;
}
else
{
// Like "0b", "0b1EFF", "0b''"
IGC_ASSERT_MESSAGE(0, "Invalid binary literal.");
}
}
else
{
char* pStopped = nullptr;
unsigned int* puVal = (unsigned int*)pValue;
*puVal = strtoul(envVal, &pStopped, 0);
if (pStopped == envVal + std::strlen(envVal))
{
return true;
}
}
}
// Just return the string
strncpy_s( (char*)pValue, size, envVal, size );
return true;
}
}
return false;
}
/*****************************************************************************\
ReadIGCRegistry
\*****************************************************************************/
bool ReadIGCRegistry(
const char* pName,
void* pValue,
unsigned int size ,
bool readFromEnv)
{
// All platforms can retrieve settings from environment
if( readFromEnv && ReadIGCEnv( pName, pValue, size ))
{
return true;
}
#if defined _WIN32
LONG success = ERROR_SUCCESS;
static std::vector<std::string> registrykeypaths;
if (registrykeypaths.empty())
{
registrykeypaths.push_back(IGC_REGISTRY_KEY);
std::vector<DEVINST> drivers;
std::list<std::string> registrypaths;
GetIntelDriverPaths(drivers);
for (auto driverInfo : drivers)
{
std::string driverStoreRegKeyPath = getNewRegistryPath(driverInfo);
std::string registryKeyPath = "SYSTEM\\ControlSet001\\Control\\Class\\" + driverStoreRegKeyPath + "\\IGC";
registrykeypaths.push_back(registryKeyPath);
}
}
for (const std::string& registrykeypath : registrykeypaths)
{
HKEY uscKey;
success = RegOpenKeyExA(
HKEY_LOCAL_MACHINE,
registrykeypath.c_str(),
0,
KEY_READ,
&uscKey);
if (ERROR_SUCCESS == success)
{
DWORD dwSize = size;
success = RegQueryValueExA(
uscKey,
pName,
NULL,
NULL,
(LPBYTE)pValue,
&dwSize);
RegCloseKey(uscKey);
}
if (ERROR_SUCCESS == success)
{
return true;
}
}
#endif // defined _WIN32
return false;
}
/*****************************************************************************\
Function:
DumpIGCRegistryKeyDefinitions
Description:
Dumps registry key definitions to an XML file.
Input:
none
Output:
none
\*****************************************************************************/
static const char* ConvertType(const char* flagType)
{
if (strcmp(flagType, "int") == 0)
return "DWORD";
else if(strcmp(flagType, "debugString") == 0)
return "string";
return flagType;
}
template <typename T>
static std::string ConvertDefault(
const std::string &Type, T Val, const std::string &ValStr)
{
if (Type == "bool")
{
return std::to_string(static_cast<bool>(Val) ? 1U : 0U);
}
else if (Type == "string")
{
if (Val == 0)
return "";
else if constexpr (std::is_convertible_v<T, std::string>)
return Val;
}
return ValStr;
}
static void DumpIGCRegistryKeyDefinitions(
const char* registryKeyPath, const char* xmlPath)
{
#ifdef _WIN32
// Create the directory path
iSTD::DirectoryCreate("C:\\Intel");
iSTD::DirectoryCreate("C:\\Intel\\IGfx");
iSTD::DirectoryCreate("C:\\Intel\\IGfx\\GfxRegistryManager");
iSTD::DirectoryCreate("C:\\Intel\\IGfx\\GfxRegistryManager\\Keys");
// Create the XML file to hold the debug variable definitions
FILE* fp = fopen(xmlPath, "w");
if (fp == NULL)
{
return;
}
#define DECLARE_IGC_REGKEY( dataType, regkeyName, defaultValue, descriptionText, releaseMode ) \
fprintf(fp, " <Key name=\"%s\" type=\"%s\" location=\"%s\" default=\"%s\" description=\"%s\" />\n", \
#regkeyName, \
ConvertType(#dataType), \
registryKeyPath, \
ConvertDefault(ConvertType(#dataType), defaultValue, #defaultValue).c_str(), \
descriptionText);
#define DECLARE_IGC_REGKEY_ENUM(regkeyName, defaultValue, description, values, releaseMode) \
DECLARE_IGC_REGKEY(enum, regkeyName, defaultValue, description "[VALUES]" values, releaseMode)
#define DECLARE_IGC_REGKEY_BITMASK(regkeyName, defaultValue, description, values, releaseMode) \
DECLARE_IGC_REGKEY(bitmask, regkeyName, defaultValue, description "[VALUES]" values, releaseMode)
#define DECLARE_IGC_GROUP( groupName ) \
if(!firstGroup) \
{ \
fprintf(fp, " </Group>\n"); \
} \
firstGroup = false; \
fprintf(fp, " <Group name=\"%s\">\n", groupName);
bool firstGroup = true;
// Generate the XML
fprintf(fp, "<RegistryKeys>\n");
#include "igc_regkeys.h"
fprintf(fp, " </Group>\n");
fprintf(fp, "</RegistryKeys>\n");
fclose(fp);
fp = NULL;
#undef DECLARE_IGC_REGKEY
#undef DECLARE_IGC_GROUP
#undef DECLARE_IGC_REGKEY_ENUM
#undef DECLARE_IGC_REGKEY_BITMASK
#endif // _WIN32
}
void DumpIGCRegistryKeyDefinitions()
{
constexpr char* registryKeyPath = "HKLM\\" IGC_REGISTRY_KEY;
constexpr char* xmlPath =
"C:\\Intel\\IGfx\\GfxRegistryManager\\Keys\\IGC.xml";
DumpIGCRegistryKeyDefinitions(registryKeyPath, xmlPath);
}
void DumpIGCRegistryKeyDefinitions3(std::string driverRegistryPath, unsigned long pciBus, unsigned long pciDevice, unsigned long pciFunction)
{
if (driverRegistryPath.empty())
{
IGC_ASSERT_MESSAGE(0, "Failed to find the driver registry path, cannot create the debug variable XML file.");
return;
}
const std::string registryKeyPath =
"HKLM\\SYSTEM\\ControlSet001\\Control\\Class\\" + driverRegistryPath + "\\IGC";
const std::string xmlPath =
"C:\\Intel\\IGfx\\GfxRegistryManager\\Keys\\IGC." +
std::to_string(pciBus) + "." +
std::to_string(pciDevice) + "." +
std::to_string(pciFunction) + ".xml";
DumpIGCRegistryKeyDefinitions(registryKeyPath.c_str(), xmlPath.c_str());
}
static void checkAndSetIfKeyHasNoDefaultValue(SRegKeyVariableMetaData* pRegKeyVariable)
{
// Todo: need to interpret value based on its type
if (pRegKeyVariable->m_Value != pRegKeyVariable->GetDefault())
{
pRegKeyVariable->SetToNonDefaultValue();
}
}
/// Function taken from LLVM CommandLine.cpp file
/// ParseCStringVector - Break INPUT up wherever one or more
/// whitespace characters are found, and store the resulting tokens in
/// OUTPUT. The tokens stored in OUTPUT are dynamically allocated
/// using strdup(), so it is the caller's responsibility to free()
/// them later.
///
static void ParseCStringVector(std::vector<char *> &OutputVector,
const char *Input) {
// Characters which will be treated as token separators:
llvm::StringRef Delims = " \v\f\t\r\n";
llvm::StringRef WorkStr(Input);
while(!WorkStr.empty()) {
// If the first character is a delimiter, strip them off.
if(Delims.find(WorkStr[0]) != llvm::StringRef::npos) {
size_t Pos = WorkStr.find_first_not_of(Delims);
if(Pos == llvm::StringRef::npos) Pos = WorkStr.size();
WorkStr = WorkStr.substr(Pos);
continue;
}
// Find position of first delimiter.
size_t Pos = WorkStr.find_first_of(Delims);
if(Pos == llvm::StringRef::npos) Pos = WorkStr.size();
// Everything from 0 to Pos is the next word to copy.
char *NewStr = (char*)malloc(Pos + 1);
memcpy_s(NewStr, Pos + 1, WorkStr.data(), Pos);
NewStr[Pos] = 0;
OutputVector.push_back(NewStr);
WorkStr = WorkStr.substr(Pos);
}
}
static void setRegkeyFromOption(
const std::string& optionValue,
const char* dataTypeName,
const char* regkeyName,
void* pRegkeyVar,
bool& isKeySet)
{
size_t sPos = optionValue.find(regkeyName);
if(sPos == std::string::npos)
{
return;
}
size_t pos = sPos + std::strlen(regkeyName);
pos = (pos < optionValue.size()) ? pos : std::string::npos;
std::string vstring, exactNameStr;
if(pos != std::string::npos && optionValue.at(pos) == '=')
{
// Get value for this option, ',' is a value separator.
sPos = pos + 1;
pos = optionValue.find(',', sPos);
size_t len = (pos == std::string::npos) ? pos : (pos - sPos);
vstring = optionValue.substr(sPos, len);
exactNameStr = optionValue.substr(0, optionValue.find('='));
}
if (!exactNameStr.empty())
{
bool reqKeysNotEqual = (exactNameStr.compare(regkeyName) != 0) ? true : false;
if (reqKeysNotEqual)
return;
}
bool isBool = (strcmp(dataTypeName, "bool") == 0);
bool isInt = (strcmp(dataTypeName, "int") == 0) ||
(strcmp(dataTypeName, "DWORD") == 0);
bool isString = (strcmp(dataTypeName, "debugString") == 0);
if(isBool)
{
// ignore if there is no value
if(vstring.size() == 1)
{
bool bval = (vstring.at(0) == '0') ? false : true;
*((bool*)pRegkeyVar) = bval;
isKeySet = true;
}
}
else if(isInt)
{
// ignore if there is no value
if(!vstring.empty())
{
// assume vstring has the valid value!
int intval;
if (vstring.find("0x", 0) == std::string::npos)
intval = stoi(vstring, nullptr, 10);
else
intval = stoi(vstring, nullptr, 16);
*((int*)pRegkeyVar) = intval;
isKeySet = true;
}
}
else if(isString)
{
// ignore if there is no value
if(!vstring.empty())
{
char* s = (char*)pRegkeyVar;
strcpy_s(s, sizeof(debugString), vstring.c_str());
isKeySet = true;
}
}
}
static const std::string GetOptionFilePath()
{
#if defined(_WIN64) || defined(_WIN32)
char path[256] = "c:\\Intel\\IGC\\debugFlags\\";
std::string testFilename = std::string(path) + "testfile";
HANDLE testFile =
CreateFileA(testFilename.c_str(), GENERIC_WRITE, 0, NULL, CREATE_ALWAYS, FILE_FLAG_DELETE_ON_CLOSE, NULL);
if (testFile == INVALID_HANDLE_VALUE)
{
char temppath[256];
if (GetTempPathA(sizeof(temppath), temppath) != 0)
{
sprintf_s(path, "%sIGC\\debugFlags\\", temppath);
}
}
else
{
CloseHandle(testFile);
}
return path;
#else
return "/tmp/IntelIGC/debugFlags/";
#endif
}
static const std::string GetOptionFile()
{
std::string fname = "Options.txt";
return (GetOptionFilePath() + fname);
}
static
std::optional<std::pair<HashRange::Type, llvm::StringRef>>
parseHashType(llvm::StringRef line)
{
using namespace llvm;
size_t Loc = line.find_first_of(':');
if (Loc == StringRef::npos)
return {};
auto Ty = StringSwitch<std::optional<HashRange::Type>>(line.substr(0, Loc))
.Cases("hash", "asmhash", HashRange::Type::Asm)
.Case("psohash", HashRange::Type::Pso)
.Default({});
if (!Ty)
return {};
return { std::make_pair(*Ty, line.substr(Loc + 1)) };
}
static
std::optional<std::pair<bool, llvm::StringRef>>
detectEntryPoints(llvm::StringRef &line)
{
using namespace llvm;
size_t Loc = line.find_first_of(':');
if (Loc == StringRef::npos)
return {};
auto key = line.substr(0, Loc);
bool isEntryPoint = false;
if (key == "entry_point") {
isEntryPoint = true;
}
return { std::make_pair(isEntryPoint, line.substr(Loc + 1)) };
}
// parses this syntax:
// Each hash may be optionally prefixed with "0x" (e.g., 0xaaaaaaaaaaaaaaaa)
// hash:abcdabcdabcdabcd-ffffffffffffffff,aaaaaaaaaaaaaaaa
// asmhash:abcdabcdabcdabcd-ffffffffffffffff,aaaaaaaaaaaaaaaa
// psohash:abcdabcdabcdabcd-ffffffffffffffff,aaaaaaaaaaaaaaaa
static void ParseHashRange(llvm::StringRef line, std::vector<HashRange>& ranges)
{
using namespace llvm;
auto Result = parseHashType(line);
if (!Result)
return;
auto parseAsInt = [](StringRef S) {
unsigned Radix = S.startswith("0x") ? 0 : 16;
uint64_t Result;
bool Err = S.getAsInteger(Radix, Result);
IGC_ASSERT(!Err);
return Result;
};
// re-initialize ranges
ranges.clear();
auto [HashType, vString] = *Result;
do {
auto [token, RHS] = vString.split(',');
size_t dash = token.find('-');
StringRef start = token.substr(0, dash);
StringRef end = (dash == StringRef::npos) ?
start : token.substr(dash + 1);
HashRange range = {};
range.start = parseAsInt(start);
range.end = parseAsInt(end);
range.Ty = HashType;
ranges.push_back(range);
vString = RHS;
} while (!vString.empty());
}
// parses this syntax:
// each seperated by comma
// entry_point:MicropolyRasterize, CS
static void ParseEntryPoint(llvm::StringRef line, std::vector<EntryPoint>& entry_points)
{
auto Result = detectEntryPoints(line);
if (!Result)
return;
auto [isEntryPoint, vString] = *Result;
if (!isEntryPoint)
return;
// re-initialize entries
entry_points.clear();
do {
auto [token, RHS] = vString.split(',');
EntryPoint entry_point {};
entry_point.entry_point_name = token.str();
entry_points.push_back(entry_point);
vString = RHS;
} while (!vString.empty());
}
static void setIGCKeyOnHash(
std::vector<HashRange>& hashes, const unsigned value,
SRegKeyVariableMetaData* var)
{
// hashes can be empty if the var is not set via Options.txt
for (size_t i = 0; i < hashes.size(); i++)
var->hashes.push_back(hashes[i]);
var->Set();
var->m_Value = value;
}
static void setIGCKeyOnEntryPoints(
std::vector<EntryPoint>& entry_points, const unsigned value,
SRegKeyVariableMetaData* var)
{
// hashes can be empty if the var is not set via Options.txt
var->entry_points.insert(var->entry_points.end(), entry_points.begin(), entry_points.end());
var->Set();
var->m_Value = value;
}
// Implicitly set the subkeys
static void setImpliedIGCKeys()
{
IGC_SET_IMPLIED_REGKEY(DisableIGCOptimizations, 1, DisableLLVMGenericOptimizations, true);
IGC_SET_IMPLIED_REGKEY(DisableIGCOptimizations, 1, DisableCodeSinking, true);
IGC_SET_IMPLIED_REGKEY(DisableIGCOptimizations, 1, EnableDeSSA, false);
//disable now until we figure out the issue
//IGC_SET_IMPLIED_REGKEY(DisableIGCOptimizations, DisablePayloadCoalescing, true);
IGC_SET_IMPLIED_REGKEY(DisableIGCOptimizations, 1, EnableVISANoSchedule, true);
IGC_SET_IMPLIED_REGKEY(DisableIGCOptimizations, 1, DisableUniformAnalysis, true);
IGC_SET_IMPLIED_REGKEY(DisableIGCOptimizations, 1, DisablePushConstant, true);
IGC_SET_IMPLIED_REGKEY(DisableIGCOptimizations, 1, DisableConstantCoalescing, true);
IGC_SET_IMPLIED_REGKEY(DisableIGCOptimizations, 1, DisableURBWriteMerge, true);
IGC_SET_IMPLIED_REGKEY(DisableIGCOptimizations, 1, DisableCodeHoisting, true);
IGC_SET_IMPLIED_REGKEY(DisableIGCOptimizations, 1, DisableEmptyBlockRemoval, true);
IGC_SET_IMPLIED_REGKEY(DisableIGCOptimizations, 1, DisableSIMD32Slicing, true);
IGC_SET_IMPLIED_REGKEY(DisableIGCOptimizations, 1, DisableCSEL, true);
IGC_SET_IMPLIED_REGKEY(DisableIGCOptimizations, 1, DisableFlagOpt, true);
IGC_SET_IMPLIED_REGKEY(DisableIGCOptimizations, 1, DisableScalarAtomics, true);
IGC_SET_IMPLIED_REGKEY(DisableRayTracingOptimizations, 1, DisablePayloadSinking, true);
IGC_SET_IMPLIED_REGKEY(DisableRayTracingOptimizations, 1, DisablePromoteToScratch, true);
IGC_SET_IMPLIED_REGKEY(DisableRayTracingOptimizations, 1, DisableEarlyRemat, true);
IGC_SET_IMPLIED_REGKEY(DisableRayTracingOptimizations, 1, DisableLateRemat, true);
IGC_SET_IMPLIED_REGKEY(DisableRayTracingOptimizations, 1, DisableRTGlobalsKnownValues, true);
IGC_SET_IMPLIED_REGKEY(DisableRayTracingOptimizations, 1, DisablePreSplitOpts, true);
IGC_SET_IMPLIED_REGKEY(DisableRayTracingOptimizations, 1, DisableInvariantLoad, true);
IGC_SET_IMPLIED_REGKEY(DisableRayTracingOptimizations, 1, DisableRTStackOpts, true);
IGC_SET_IMPLIED_REGKEY(DisableRayTracingOptimizations, 1, DisablePrepareLoadsStores, true);
IGC_SET_IMPLIED_REGKEY(DisableRayTracingOptimizations, 1, DisableRayTracingConstantCoalescing, true);
IGC_SET_IMPLIED_REGKEY(DisableRayTracingOptimizations, 1, DisableMatchRegisterRegion, true);
IGC_SET_IMPLIED_REGKEY(DisableRayTracingOptimizations, 1, DisableFuseContinuations, true);
IGC_SET_IMPLIED_REGKEY(DisableRayTracingOptimizations, 1, DisableRaytracingIntrinsicAttributes, true);
IGC_SET_IMPLIED_REGKEY(DisableRayTracingOptimizations, 1, DisableShaderFusion, true);
IGC_SET_IMPLIED_REGKEY(DisableRayTracingOptimizations, 1, DisableExamineRayFlag, true);
IGC_SET_IMPLIED_REGKEY(DisableRayTracingOptimizations, 1, DisableSpillReorder, true);
IGC_SET_IMPLIED_REGKEY(DisableRayTracingOptimizations, 1, DisableCrossFillRemat, true);
IGC_SET_IMPLIED_REGKEY(DisableRayTracingOptimizations, 1, DisablePromoteContinuation, true);
IGC_SET_IMPLIED_REGKEY(DisableRayTracingOptimizations, 1, DisableRTAliasAnalysis, true);
IGC_SET_IMPLIED_REGKEY(DisableRayTracingOptimizations, 1, DisableRTFenceElision, true);
IGC_SET_IMPLIED_REGKEY(DisableRayTracingOptimizations, 1, DisableRTMemDSE, true);
IGC_SET_IMPLIED_REGKEY(DisableRayTracingOptimizations, 1, RematThreshold, 0);
IGC_SET_IMPLIED_REGKEY(DisableRayTracingOptimizations, 1, DisableDPSE, true);
IGC_SET_IMPLIED_REGKEY(DisableRayTracingOptimizations, 1, DisableSWStackOffsetElision, true);
IGC_SET_IMPLIED_REGKEY(DisableRayTracingOptimizations, 1, DisableInvalidateRTStackAfterLastRead, true);
IGC_SET_IMPLIED_REGKEY(DisableRayTracingOptimizations, 1, DisableMergeAllocas, true);
IGC_SET_IMPLIED_REGKEY(DisableRayTracingOptimizations, 1, DisableLoadAsFenceOpInRaytracing, true);
IGC_SET_IMPLIED_REGKEY(ForceRTRetry, 1, RetryManagerFirstStateId, 1);
IGC_SET_IMPLIED_REGKEY(DumpVISAASMToConsole, 1, EnableVISASlowpath, true);
IGC_SET_IMPLIED_REGKEY(ShaderDumpEnableAll, 1, ShaderDumpEnable, true);
IGC_SET_IMPLIED_REGKEY(ShaderDumpEnableAll, 1, EnableVISASlowpath, true);
IGC_SET_IMPLIED_REGKEY(ShaderDumpEnable, 1, DumpLLVMIR, true);
IGC_SET_IMPLIED_REGKEY(ShaderDumpEnable, 1, EnableCosDump, true);
IGC_SET_IMPLIED_REGKEY(ShaderDumpEnable, 1, DumpOCLProgramInfo, true);
IGC_SET_IMPLIED_REGKEY(ShaderDumpEnable, 1, EnableVISAOutput, true);
IGC_SET_IMPLIED_REGKEY(ShaderDumpEnable, 1, EnableVISABinary, true);
IGC_SET_IMPLIED_REGKEY(ShaderDumpEnable, 1, EnableVISADumpCommonISA, true);
IGC_SET_IMPLIED_REGKEY(ShaderDumpEnable, 1, EnableCapsDump, true);
IGC_SET_IMPLIED_REGKEY(ShaderDumpEnable, 1, DumpPatchTokens, true);
IGC_SET_IMPLIED_REGKEY(ShaderDumpEnable, 1, RayTracingDumpYaml, true);
IGC_SET_IMPLIED_REGKEY(DumpTimeStatsPerPass, 1, DumpTimeStats, true);
IGC_SET_IMPLIED_REGKEY(DumpTimeStatsCoarse, 1, DumpTimeStats, true);
if (IGC_IS_FLAG_ENABLED(DumpTimeStatsPerPass) ||
IGC_IS_FLAG_ENABLED(DumpTimeStatsCoarse) ||
IGC_IS_FLAG_ENABLED(DumpTimeStats))
{
// Need to turn on this setting so per-shader .csv is generated
IGC::Debug::SetDebugFlag(IGC::Debug::DebugFlag::TIME_STATS_PER_SHADER, true);
}
IGC_SET_IMPLIED_REGKEY(ForceOCLSIMDWidth, 32, EnableOCLSIMD32, true);
IGC_SET_IMPLIED_REGKEY(ForceOCLSIMDWidth, 32, EnableOCLSIMD16, false);
IGC_SET_IMPLIED_REGKEY(ForceOCLSIMDWidth, 16, EnableOCLSIMD32, false);
IGC_SET_IMPLIED_REGKEY(ForceOCLSIMDWidth, 16, EnableOCLSIMD16, true);
IGC_SET_IMPLIED_REGKEY(ForceOCLSIMDWidth, 8, EnableOCLSIMD32, false);
IGC_SET_IMPLIED_REGKEY(ForceOCLSIMDWidth, 8, EnableOCLSIMD16, false);
}
void setImpliedRegkey(SRegKeyVariableMetaData& name,
const bool set,
SRegKeyVariableMetaData& subname,
const unsigned subvalue)
{
if (set)
{
setIGCKeyOnHash(name.hashes, subvalue, &subname);
setIGCKeyOnEntryPoints(name.entry_points, subvalue, &subname);
}
}
static void declareIGCKey(
const std::string& line, const char* dataType, const char* regkeyName,
std::vector<HashRange>& hashes, std::vector<EntryPoint>& entry_points, SRegKeyVariableMetaData* regKey)
{
bool isSet = false;
debugString value = { 0 };
setRegkeyFromOption(line, dataType, regkeyName, &value, isSet);
if (isSet && !hashes.empty())
{
std::cout << std::endl << "** hashes ";
for (size_t i = 0; i < hashes.size(); i++)
{
memcpy_s(hashes[i].m_string, sizeof(value), value, sizeof(value));
regKey->hashes.push_back(hashes[i]);
if (hashes[i].end == hashes[i].start)
std::cout << std::hex << std::showbase << hashes[i].start << ", ";
else
std::cout << std::hex << std::showbase << hashes[i].start << "-" << hashes[i].end << ", ";
}
std::cout << std::endl;
std::cout << "** regkey " << line << std::endl;
regKey->Set();
memcpy_s(regKey->m_string, sizeof(value), value, sizeof(value));
}
if (isSet && !entry_points.empty())
{
std::cout << std::endl << "** entry point ";
for (auto entry_point : entry_points)
{
strcpy_s(entry_point.m_string,sizeof(value), value);
regKey->entry_points.push_back(entry_point);
std::cout << entry_point.entry_point_name << ", ";
}
std::cout << std::endl;
std::cout << "** regkey " << line << std::endl;
regKey->Set();
memcpy_s(regKey->m_string, sizeof(value), value, sizeof(value));
}
}
static void LoadDebugFlagsFromFile()
{
std::ifstream input(GetOptionFile());
std::string line;
std::vector<HashRange> hashes;
std::vector<EntryPoint> entry_points;
if (input.is_open())
std::cout << std::endl << "** DebugFlags " << GetOptionFile() << " is opened" << std::endl;
while (std::getline(input, line)) {
if (line.empty() || line.front() == '#')
continue;
ParseHashRange(line, hashes);
ParseEntryPoint(line, entry_points);
#define DECLARE_IGC_REGKEY(dataType, regkeyName, defaultValue, description, releaseMode) \
{ \
declareIGCKey(line, #dataType, #regkeyName, hashes, entry_points, &(g_RegKeyList.regkeyName));\
}
#include "igc_regkeys.h"
DECLARE_IGC_REGKEY(bool, ShaderDumpEnable, false, "dump LLVM IR, visaasm, and GenISA", true)
#undef DECLARE_IGC_REGKEY
}
setImpliedIGCKeys();