forked from microsoft/DirectXShaderCompiler
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathHLSLOptions.cpp
More file actions
1444 lines (1296 loc) · 54.9 KB
/
HLSLOptions.cpp
File metadata and controls
1444 lines (1296 loc) · 54.9 KB
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
//===--- HLSLOptions.cpp - Driver Options Table ---------------------------===//
///////////////////////////////////////////////////////////////////////////////
// //
// HLSLOptions.cpp //
// Copyright (C) Microsoft Corporation. All rights reserved. //
// This file is distributed under the University of Illinois Open Source //
// License. See LICENSE.TXT for details. //
// //
///////////////////////////////////////////////////////////////////////////////
#include "dxc/Support/WinIncludes.h"
#include "dxc/Support/dxcapi.use.h"
#include "dxc/DXIL/DxilShaderModel.h"
#include "dxc/DxilContainer/DxilContainer.h"
#include "dxc/Support/Global.h"
#include "dxc/Support/HLSLOptions.h"
#include "dxc/Support/Unicode.h"
#include "llvm/ADT/APInt.h"
#include "llvm/ADT/STLExtras.h"
#include "llvm/ADT/StringRef.h"
#include "llvm/ADT/StringSwitch.h"
#include "llvm/Option/OptTable.h"
#include "llvm/Option/Option.h"
#include "llvm/Support/Path.h"
#include "llvm/Support/raw_ostream.h"
#include <optional>
using namespace llvm::opt;
using namespace dxc;
using namespace hlsl;
using namespace hlsl::options;
#ifdef ENABLE_SPIRV_CODEGEN
using namespace clang::spirv;
#endif
#define PREFIX(NAME, VALUE) static const char *const NAME[] = VALUE;
#include "dxc/Support/HLSLOptions.inc"
#undef PREFIX
static const OptTable::Info HlslInfoTable[] = {
#define OPTION(PREFIX, NAME, ID, KIND, GROUP, ALIAS, ALIASARGS, FLAGS, PARAM, \
HELPTEXT, METAVAR) \
{PREFIX, NAME, HELPTEXT, METAVAR, OPT_##ID, Option::KIND##Class, \
PARAM, FLAGS, OPT_##GROUP, OPT_##ALIAS, ALIASARGS},
#include "dxc/Support/HLSLOptions.inc"
#undef OPTION
};
namespace {
class HlslOptTable : public OptTable {
public:
HlslOptTable()
: OptTable(HlslInfoTable, llvm::array_lengthof(HlslInfoTable)) {}
};
} // namespace
static HlslOptTable *g_HlslOptTable;
std::error_code hlsl::options::initHlslOptTable() {
DXASSERT(g_HlslOptTable == nullptr, "else double-init");
g_HlslOptTable = new (std::nothrow) HlslOptTable();
if (g_HlslOptTable == nullptr)
return std::error_code(E_OUTOFMEMORY, std::system_category());
return std::error_code();
}
void hlsl::options::cleanupHlslOptTable() {
delete g_HlslOptTable;
g_HlslOptTable = nullptr;
}
const OptTable *hlsl::options::getHlslOptTable() { return g_HlslOptTable; }
void DxcDefines::push_back(llvm::StringRef value) {
// Skip empty defines.
if (value.size() > 0) {
DefineStrings.push_back(value);
}
}
UINT32 DxcDefines::ComputeNumberOfWCharsNeededForDefines() {
UINT32 wcharSize = 0;
for (llvm::StringRef &S : DefineStrings) {
DXASSERT(S.size() > 0,
"else DxcDefines::push_back should not have added this");
const int wideLength = ::MultiByteToWideChar(
CP_UTF8, MB_ERR_INVALID_CHARS, S.data(), S.size(), nullptr, 0);
IFTARG(wideLength != 0);
wcharSize += wideLength + 1; // adding null terminated character
}
return wcharSize;
}
void DxcDefines::BuildDefines() {
// Calculate and prepare the size of the backing buffer.
DXASSERT(DefineValues == nullptr, "else DxcDefines is already built");
UINT32 wcharSize = ComputeNumberOfWCharsNeededForDefines();
DefineValues = new wchar_t[wcharSize];
DefineVector.resize(DefineStrings.size());
// Build up the define structures while filling in the backing buffer.
UINT32 remaining = wcharSize;
LPWSTR pWriteCursor = DefineValues;
for (size_t i = 0; i < DefineStrings.size(); ++i) {
llvm::StringRef &S = DefineStrings[i];
DxcDefine &D = DefineVector[i];
const int wideLength =
::MultiByteToWideChar(CP_UTF8, MB_ERR_INVALID_CHARS, S.data(), S.size(),
pWriteCursor, remaining);
DXASSERT(wideLength > 0,
"else it should have failed during size calculation");
LPWSTR pDefineEnd = pWriteCursor + wideLength;
D.Name = pWriteCursor;
LPWSTR pEquals = std::find(pWriteCursor, pDefineEnd, L'=');
if (pEquals == pDefineEnd) {
D.Value = nullptr;
} else {
*pEquals = L'\0';
D.Value = pEquals + 1;
}
// Advance past converted characters and include the null terminator.
pWriteCursor += wideLength;
*pWriteCursor = L'\0';
++pWriteCursor;
DXASSERT(pWriteCursor <= DefineValues + wcharSize,
"else this function is calculating this incorrectly");
remaining -= (wideLength + 1);
}
}
bool DxcOpts::IsRootSignatureProfile() const {
return TargetProfile == "rootsig_1_0" || TargetProfile == "rootsig_1_1";
}
bool DxcOpts::IsLibraryProfile() const {
return TargetProfile.startswith("lib_");
}
bool DxcOpts::GenerateFullDebugInfo() const { return DebugInfo; }
bool DxcOpts::GeneratePDB() const { return DebugInfo || SourceOnlyDebug; }
bool DxcOpts::EmbedDebugInfo() const { return EmbedDebug; }
bool DxcOpts::EmbedPDBName() const {
return GeneratePDB() || !DebugFile.empty();
}
bool DxcOpts::DebugFileIsDirectory() const {
return !DebugFile.empty() &&
llvm::sys::path::is_separator(DebugFile[DebugFile.size() - 1]);
}
llvm::StringRef DxcOpts::GetPDBName() const {
if (!DebugFileIsDirectory())
return DebugFile;
return llvm::StringRef();
}
bool DxcOpts::ProduceDxModule() const {
return !AstDump && !OptDump &&
#ifdef ENABLE_SPIRV_CODEGEN
!GenSPIRV &&
#endif
!DumpDependencies && !VerifyDiagnostics && !IsRootSignatureProfile() &&
Preprocess.empty();
}
bool DxcOpts::ProduceFullContainer() const {
return DxcOpts::ProduceDxModule() && !CodeGenHighLevel;
}
bool DxcOpts::NeedsValidation() const {
return ProduceFullContainer() && !DisableValidation;
}
MainArgs::MainArgs(int argc, const wchar_t **argv, int skipArgCount) {
if (argc > skipArgCount) {
Utf8StringVector.reserve(argc - skipArgCount);
Utf8CharPtrVector.reserve(argc - skipArgCount);
for (int i = skipArgCount; i < argc; ++i) {
Utf8StringVector.emplace_back(Unicode::WideToUTF8StringOrThrow(argv[i]));
Utf8CharPtrVector.push_back(Utf8StringVector.back().data());
}
}
}
MainArgs::MainArgs(int argc, const char **argv, int skipArgCount) {
if (argc > skipArgCount) {
Utf8StringVector.reserve(argc - skipArgCount);
Utf8CharPtrVector.reserve(argc - skipArgCount);
for (int i = skipArgCount; i < argc; ++i) {
Utf8StringVector.emplace_back(argv[i]);
Utf8CharPtrVector.push_back(Utf8StringVector.back().data());
}
}
}
MainArgs::MainArgs(llvm::ArrayRef<llvm::StringRef> args) {
Utf8StringVector.reserve(args.size());
Utf8CharPtrVector.reserve(args.size());
for (llvm::StringRef str : args) {
Utf8StringVector.emplace_back(str.str());
Utf8CharPtrVector.push_back(Utf8StringVector.back().data());
}
}
MainArgs &MainArgs::operator=(const MainArgs &other) {
Utf8StringVector.clear();
Utf8CharPtrVector.clear();
Utf8StringVector.reserve(other.Utf8StringVector.size());
Utf8CharPtrVector.reserve(other.Utf8StringVector.size());
for (const std::string &str : other.Utf8StringVector) {
Utf8StringVector.emplace_back(str);
Utf8CharPtrVector.push_back(Utf8StringVector.back().data());
}
return *this;
}
StringRefWide::StringRefWide(llvm::StringRef value) {
if (!value.empty())
m_value = Unicode::UTF8ToWideStringOrThrow(value.data());
}
// Copied from CompilerInvocation since we parse our own diagnostic arguments
static void addDiagnosticArgs(ArgList &Args, OptSpecifier Group,
OptSpecifier GroupWithValue,
std::vector<std::string> &Diagnostics) {
for (Arg *A : Args.filtered(Group)) {
if (A->getOption().getKind() == Option::FlagClass) {
// The argument is a pure flag (such as OPT_Wall or OPT_Wdeprecated). Add
// its name (minus the "W" or "R" at the beginning) to the warning list.
Diagnostics.push_back(A->getOption().getName().drop_front(1));
} else if (A->getOption().matches(GroupWithValue)) {
// This is -Wfoo= or -Rfoo=, where foo is the name of the diagnostic
// group.
Diagnostics.push_back(A->getOption().getName().drop_front(1).rtrim("=-"));
} else {
// Otherwise, add its value (for OPT_W_Joined and similar).
for (const char *Arg : A->getValues())
Diagnostics.emplace_back(Arg);
}
}
}
static std::pair<std::string, std::string> ParseDefine(std::string &argVal) {
std::pair<std::string, std::string> result = std::make_pair("", "");
if (argVal.empty())
return result;
auto defEndPos =
argVal.find('=') == std::string::npos ? argVal.size() : argVal.find('=');
result.first = argVal.substr(0, defEndPos);
if (!result.first.empty() && defEndPos < argVal.size() - 1) {
result.second = argVal.substr(defEndPos + 1, argVal.size() - defEndPos - 1);
}
return result;
}
// SPIRV Change Starts
#ifdef ENABLE_SPIRV_CODEGEN
/// Checks and collects the arguments for -fvk-{b|s|t|u}-shift into *shifts.
static bool handleVkShiftArgs(const InputArgList &args, OptSpecifier id,
const char *name,
llvm::SmallVectorImpl<int32_t> *shifts,
llvm::raw_ostream &errors) {
const auto values = args.getAllArgValues(id);
if (values.empty())
return true;
if (!args.hasArg(OPT_spirv)) {
errors << "-fvk-" << name << "-shift requires -spirv";
return false;
}
if (!args.getLastArgValue(OPT_fvk_bind_register).empty()) {
errors << "-fvk-" << name
<< "-shift cannot be used together with -fvk-bind-register";
return false;
}
shifts->clear();
bool setForAll = false;
for (const auto &val : values) {
int32_t number = 0;
if (val == "all") {
number = -1;
setForAll = true;
} else {
if (llvm::StringRef(val).getAsInteger(10, number)) {
errors << "invalid -fvk-" << name << "-shift argument: " << val;
return false;
}
if (number < 0) {
errors << "negative -fvk-" << name << "-shift argument: " << val;
return false;
}
}
shifts->push_back(number);
}
if (setForAll && shifts->size() > 2) {
errors << "setting all sets via -fvk-" << name
<< "-shift argument should be used alone";
return false;
}
return true;
}
// Parses the given flag |id| in |args|. If present and valid, sets |info| to
// the correct value. Returns true if parsing succeeded. Returns false if
// parsing failed, and outputs in |errors| a message using |name| as pretty name
// for the flag.
static bool
handleFixedBinding(const InputArgList &args, OptSpecifier id,
std::optional<SpirvCodeGenOptions::BindingInfo> *info,
llvm::StringRef name, llvm::raw_ostream &errors) {
const auto values = args.getAllArgValues(id);
if (values.size() == 0) {
*info = std::nullopt;
return true;
}
if (!args.hasArg(OPT_spirv)) {
errors << name << " requires -spirv";
return false;
}
assert(values.size() == 2);
size_t output[2] = {0, 0};
for (unsigned i = 0; i < 2; ++i) {
int number = 0;
if (llvm::StringRef(values[i]).getAsInteger(10, number)) {
errors << "invalid " << name << " argument: '" << values[i] << "'";
return false;
}
if (number < 0) {
errors << "expected positive integer for " << name
<< ", got: " << values[i];
return false;
}
output[i] = number;
}
*info = {output[0], output[1]};
return true;
}
// Check if any options that are unsupported with SPIR-V are used.
static bool hasUnsupportedSpirvOption(const InputArgList &args,
llvm::raw_ostream &errors) {
// Note: The options checked here are non-exhaustive. A thorough audit of
// available options and their current compatibility is needed to generate a
// complete list.
std::vector<OptSpecifier> unsupportedOpts = {OPT_Fd, OPT_Fre, OPT_Gec,
OPT_Qstrip_reflect};
for (const auto &id : unsupportedOpts) {
if (Arg *arg = args.getLastArg(id)) {
errors << "-" << arg->getOption().getName()
<< " is not supported with -spirv";
return true;
}
}
return false;
}
namespace {
/// Maximum size of OpString instruction minus two operands
static const uint32_t kDefaultMaximumSourceLength = 0xFFFDu;
static const uint32_t kTestingMaximumSourceLength = 13u;
} // namespace
#endif // ENABLE_SPIRV_CODEGEN
// SPIRV Change Ends
namespace hlsl {
LangStd parseHLSLVersion(llvm::StringRef Ver) {
return llvm::StringSwitch<hlsl::LangStd>(Ver)
.Case("2015", hlsl::LangStd::v2015)
.Case("2016", hlsl::LangStd::v2016)
.Case("2017", hlsl::LangStd::v2017)
.Case("2018", hlsl::LangStd::v2018)
.Case("2021", hlsl::LangStd::v2021)
.Case("202x", hlsl::LangStd::v202x)
.Default(hlsl::LangStd::vError);
}
namespace options {
/// Reads all options from the given argument strings, populates opts, and
/// validates reporting errors and warnings.
int ReadDxcOpts(const OptTable *optionTable, unsigned flagsToInclude,
const MainArgs &argStrings, DxcOpts &opts,
llvm::raw_ostream &errors) {
DXASSERT_NOMSG(optionTable != nullptr);
opts.DefaultTextCodePage = DXC_CP_UTF8;
unsigned missingArgIndex = 0, missingArgCount = 0;
InputArgList Args =
optionTable->ParseArgs(argStrings.getArrayRef(), missingArgIndex,
missingArgCount, flagsToInclude);
// Set DefaultTextCodePage early so it may influence error buffer
// Default to UTF8 for compatibility
llvm::StringRef encoding = Args.getLastArgValue(OPT_encoding);
if (!encoding.empty()) {
if (encoding.equals_lower("utf8")) {
opts.DefaultTextCodePage = DXC_CP_UTF8;
#ifdef _WIN32
} else if (encoding.equals_lower("utf16")) {
opts.DefaultTextCodePage = DXC_CP_UTF16; // Only on Windows
#else
} else if (encoding.equals_lower("utf32")) {
opts.DefaultTextCodePage = DXC_CP_UTF32; // Only on *nix
#endif
} else if (encoding.equals_lower("wide")) {
opts.DefaultTextCodePage = DXC_CP_WIDE;
} else {
errors << "Unsupported value '" << encoding
<< "for -encoding option. Allowed values: wide, utf8, "
#ifdef _WIN32
"utf16.";
#else
"utf32.";
#endif
return 1;
}
}
// Verify consistency for external library support.
opts.ExternalLib = Args.getLastArgValue(OPT_external_lib);
opts.ExternalFn = Args.getLastArgValue(OPT_external_fn);
if (opts.ExternalLib.empty()) {
if (!opts.ExternalFn.empty()) {
errors << "External function cannot be specified without an external "
"library name.";
return 1;
}
} else {
if (opts.ExternalFn.empty()) {
errors << "External library name requires specifying an external "
"function name.";
return 1;
}
}
opts.ShowHelp = Args.hasFlag(OPT_help, OPT_INVALID, false);
opts.ShowHelp |= (opts.ShowHelpHidden =
Args.hasFlag(OPT__help_hidden, OPT_INVALID, false));
if (opts.ShowHelp) {
return 0;
}
opts.ShowVersion = Args.hasFlag(OPT__version, OPT_INVALID, false);
if (opts.ShowVersion) {
return 0;
}
if (missingArgCount) {
errors << "Argument to '" << Args.getArgString(missingArgIndex)
<< "' is missing.";
return 1;
}
if (!Args.hasArg(hlsl::options::OPT_Qunused_arguments)) {
for (const Arg *A : Args.filtered(OPT_UNKNOWN)) {
errors << "Unknown argument: '" << A->getAsString(Args).c_str() << "'";
return 1;
}
}
// Add macros from the command line.
for (const Arg *A : Args.filtered(OPT_D)) {
opts.Defines.push_back(A->getValue());
// If supporting OPT_U and included in filter, handle undefs.
}
opts.Defines
.BuildDefines(); // Must be called after all defines are pushed back
DXASSERT(opts.ExternalLib.empty() == opts.ExternalFn.empty(),
"else flow above is incorrect");
opts.PreciseOutputs = Args.getAllArgValues(OPT_precise_output);
// when no-warnings option is present, do not output warnings.
opts.OutputWarnings = Args.hasFlag(OPT_INVALID, OPT_no_warnings, true);
opts.EntryPoint = Args.getLastArgValue(OPT_entrypoint);
// Entry point is required in arguments only for drivers; APIs take this
// through an argument. The value should default to 'main', but we let the
// caller apply this policy.
if (opts.TargetProfile.empty()) {
opts.TargetProfile = Args.getLastArgValue(OPT_target_profile);
}
if (opts.IsLibraryProfile()) {
// Don't bother erroring out when entry is specified. We weren't always
// doing this before, so doing so will break existing code.
// Set entry point to impossible name.
opts.EntryPoint = "lib.no::entry";
} else {
if (Args.getLastArg(OPT_exports)) {
errors << "library profile required when using -exports option";
return 1;
} else if (Args.hasFlag(OPT_export_shaders_only, OPT_INVALID, false)) {
errors
<< "library profile required when using -export-shaders-only option";
return 1;
} else if (Args.getLastArg(OPT_default_linkage)) {
errors << "library profile required when using -default-linkage option";
return 1;
}
}
opts.EnableDX9CompatMode = Args.hasFlag(OPT_Gec, OPT_INVALID, false);
llvm::StringRef ver = Args.getLastArgValue(OPT_hlsl_version);
if (ver.empty()) {
if (opts.EnableDX9CompatMode)
opts.HLSLVersion = hlsl::LangStd::v2016; // Default to max supported
// version with /Gec flag
else
opts.HLSLVersion = hlsl::LangStd::vLatest; // Default to latest version
} else {
opts.HLSLVersion = parseHLSLVersion(ver);
if (opts.HLSLVersion == hlsl::LangStd::vError) {
errors << "Unknown HLSL version: " << ver
<< ". Valid versions: " << hlsl::ValidVersionsStr;
return 1;
}
}
if (opts.HLSLVersion == hlsl::LangStd::v2015 &&
!(flagsToInclude & HlslFlags::ISenseOption)) {
errors << "HLSL Version 2015 is only supported for language services";
return 1;
}
if (opts.EnableDX9CompatMode && opts.HLSLVersion > hlsl::LangStd::v2016) {
errors << "/Gec is not supported with HLSLVersion "
<< (unsigned long)opts.HLSLVersion;
return 1;
}
if (opts.HLSLVersion <= hlsl::LangStd::v2016) {
opts.EnableFXCCompatMode = true;
}
// AssemblyCodeHex not supported (Fx)
// OutputLibrary not supported (Fl)
opts.AssemblyCode = Args.getLastArgValue(OPT_Fc);
opts.DebugFile = Args.getLastArgValue(OPT_Fd);
opts.ImportBindingTable = Args.getLastArgValue(OPT_import_binding_table);
opts.BindingTableDefine = Args.getLastArgValue(OPT_binding_table_define);
opts.ExtractPrivateFile = Args.getLastArgValue(OPT_getprivate);
opts.Enable16BitTypes =
Args.hasFlag(OPT_enable_16bit_types, OPT_INVALID, false);
opts.OutputObject = Args.getLastArgValue(OPT_Fo);
opts.OutputHeader = Args.getLastArgValue(OPT_Fh);
opts.OutputWarningsFile = Args.getLastArgValue(OPT_Fe);
opts.OutputReflectionFile = Args.getLastArgValue(OPT_Fre);
opts.OutputRootSigFile = Args.getLastArgValue(OPT_Frs);
opts.OutputShaderHashFile = Args.getLastArgValue(OPT_Fsh);
opts.DiagnosticsFormat =
Args.getLastArgValue(OPT_fdiagnostics_format_EQ, "clang");
opts.ShowOptionNames = Args.hasFlag(OPT_fdiagnostics_show_option,
OPT_fno_diagnostics_show_option, true);
opts.UseColor = Args.hasFlag(OPT_Cc, OPT_INVALID, false);
opts.UseInstructionNumbers = Args.hasFlag(OPT_Ni, OPT_INVALID, false);
opts.UseInstructionByteOffsets = Args.hasFlag(OPT_No, OPT_INVALID, false);
opts.UseHexLiterals = Args.hasFlag(OPT_Lx, OPT_INVALID, false);
if (Args.hasFlag(OPT_P, OPT_INVALID, false)) {
// Default preprocess filename is InputName.i.
llvm::SmallString<128> Path(Args.getLastArgValue(OPT_INPUT));
llvm::sys::path::replace_extension(Path, "i");
// Try to get preprocess filename from Fi.
opts.Preprocess = Args.getLastArgValue(OPT_Fi, Path).str();
// Hack to support fxc style /P preprocess_filename.
// When there're more than 1 Input file, use the input which is after /P as
// preprocess.
if (!Args.hasArg(OPT_Fi)) {
std::vector<std::string> Inputs = Args.getAllArgValues(OPT_INPUT);
if (Inputs.size() > 1) {
llvm::opt::Arg *PArg = Args.getLastArg(OPT_P);
std::string LastInput = Inputs.back();
llvm::opt::Arg *PrevInputArg = nullptr;
for (llvm::opt::Arg *InputArg : Args.filtered(OPT_INPUT)) {
// Find Input after /P.
if ((PArg->getIndex() + 1) == InputArg->getIndex()) {
opts.Preprocess = InputArg->getValue();
if (LastInput == opts.Preprocess && PrevInputArg) {
// When InputArg is last Input, update it to other Input so
// Args.getLastArgValue(OPT_INPUT) get expect Input.
InputArg->getValues()[0] = PrevInputArg->getValues()[0];
}
errors << "warning: -P " << opts.Preprocess
<< " is deprecated, please use -P -Fi " << opts.Preprocess
<< " instead.\n";
break;
}
PrevInputArg = InputArg;
}
}
}
}
opts.AstDumpImplicit =
Args.hasFlag(OPT_ast_dump_implicit, OPT_INVALID, false);
// -ast-dump-implicit should imply -ast-dump.
opts.AstDump =
Args.hasFlag(OPT_ast_dump, OPT_INVALID, false) || opts.AstDumpImplicit;
opts.WriteDependencies =
Args.hasFlag(OPT_write_dependencies, OPT_INVALID, false);
opts.OutputFileForDependencies =
Args.getLastArgValue(OPT_write_dependencies_to);
opts.DumpDependencies =
Args.hasFlag(OPT_dump_dependencies, OPT_INVALID, false) ||
opts.WriteDependencies || !opts.OutputFileForDependencies.empty();
opts.CodeGenHighLevel = Args.hasFlag(OPT_fcgl, OPT_INVALID, false);
opts.AllowPreserveValues =
Args.hasFlag(OPT_preserve_intermediate_values, OPT_INVALID, false);
opts.DebugInfo = Args.hasFlag(OPT__SLASH_Zi, OPT_INVALID, false);
opts.DebugNameForBinary = Args.hasFlag(OPT_Zsb, OPT_INVALID, false);
opts.DebugNameForSource = Args.hasFlag(OPT_Zss, OPT_INVALID, false);
opts.VariableName = Args.getLastArgValue(OPT_Vn);
opts.InputFile = Args.getLastArgValue(OPT_INPUT);
opts.ForceRootSigVer = Args.getLastArgValue(OPT_force_rootsig_ver);
if (opts.ForceRootSigVer.empty())
opts.ForceRootSigVer = Args.getLastArgValue(OPT_force_rootsig_ver_);
opts.PrivateSource = Args.getLastArgValue(OPT_setprivate);
opts.RootSignatureSource = Args.getLastArgValue(OPT_setrootsignature);
opts.VerifyRootSignatureSource =
Args.getLastArgValue(OPT_verifyrootsignature);
opts.RootSignatureDefine = Args.getLastArgValue(OPT_rootsig_define);
opts.ScanLimit = 0;
llvm::StringRef limit = Args.getLastArgValue(OPT_memdep_block_scan_limit);
if (!limit.empty())
opts.ScanLimit = std::stoul(std::string(limit));
for (std::string opt : Args.getAllArgValues(OPT_opt_disable))
opts.OptToggles.Toggles[llvm::StringRef(opt).lower()] = false;
for (std::string opt : Args.getAllArgValues(OPT_opt_enable)) {
std::string optimization = llvm::StringRef(opt).lower();
if (opts.OptToggles.Toggles.count(optimization) &&
!opts.OptToggles.Toggles[optimization]) {
errors << "Contradictory use of -opt-disable and -opt-enable with \""
<< llvm::StringRef(opt).lower() << "\"";
return 1;
}
opts.OptToggles.Toggles[optimization] = true;
}
std::vector<std::string> ignoreSemDefs =
Args.getAllArgValues(OPT_ignore_semdef);
for (std::string &ignoreSemDef : ignoreSemDefs) {
opts.IgnoreSemDefs.insert(ignoreSemDef);
}
std::vector<std::string> overrideSemDefs =
Args.getAllArgValues(OPT_override_semdef);
for (std::string &overrideSemDef : overrideSemDefs) {
auto kv = ParseDefine(overrideSemDef);
if (kv.first.empty())
continue;
if (opts.OverrideSemDefs.find(kv.first) == opts.OverrideSemDefs.end()) {
opts.OverrideSemDefs.insert(std::make_pair(kv.first, kv.second));
} else {
opts.OverrideSemDefs[kv.first] = kv.second;
}
}
std::vector<std::string> optSelects = Args.getAllArgValues(OPT_opt_select);
for (unsigned i = 0; i + 1 < optSelects.size(); i += 2) {
std::string optimization = llvm::StringRef(optSelects[i]).lower();
std::string selection = optSelects[i + 1];
if (opts.OptToggles.Selects.count(optimization) &&
selection.compare(opts.OptToggles.Selects[optimization])) {
errors << "Contradictory -opt-selects for \"" << optimization << "\"";
return 1;
}
opts.OptToggles.Selects[optimization] = selection;
}
if (!opts.ForceRootSigVer.empty() && opts.ForceRootSigVer != "rootsig_1_0" &&
opts.ForceRootSigVer != "rootsig_1_1") {
errors << "Unsupported value '" << opts.ForceRootSigVer
<< "' for root signature profile.";
return 1;
}
opts.IEEEStrict = Args.hasFlag(OPT_Gis, OPT_INVALID, false);
opts.IgnoreLineDirectives =
Args.hasFlag(OPT_ignore_line_directives, OPT_INVALID, false);
opts.FloatDenormalMode = Args.getLastArgValue(OPT_denorm);
// Check if a given denormalized value is valid
if (!opts.FloatDenormalMode.empty()) {
if (!(opts.FloatDenormalMode.equals_lower("preserve") ||
opts.FloatDenormalMode.equals_lower("ftz") ||
opts.FloatDenormalMode.equals_lower("any"))) {
errors << "Unsupported value '" << opts.FloatDenormalMode
<< "' for denorm option.";
return 1;
}
}
llvm::StringRef auto_binding_space =
Args.getLastArgValue(OPT_auto_binding_space);
if (!auto_binding_space.empty()) {
if (auto_binding_space.getAsInteger(10, opts.AutoBindingSpace)) {
errors << "Unsupported value '" << auto_binding_space
<< "' for auto binding space.";
return 1;
}
}
opts.Exports = Args.getAllArgValues(OPT_exports);
opts.DefaultLinkage = Args.getLastArgValue(OPT_default_linkage);
if (!opts.DefaultLinkage.empty()) {
if (!(opts.DefaultLinkage.equals_lower("internal") ||
opts.DefaultLinkage.equals_lower("external"))) {
errors << "Unsupported value '" << opts.DefaultLinkage
<< "for -default-linkage option.";
return 1;
}
}
// Check options only allowed in shader model >= 6.2FPDenormalMode
unsigned Major = 0;
unsigned Minor = 0;
llvm::StringRef Stage;
if (!opts.TargetProfile.empty()) {
if (!hlsl::ShaderModel::ParseTargetProfile(opts.TargetProfile, Stage, Major,
Minor)) {
errors << "unable to parse shader model.";
return 1;
}
}
if (opts.TargetProfile.empty() || Major < 6 || (Major == 6 && Minor < 2)) {
if (!opts.FloatDenormalMode.empty()) {
errors << "denorm option is only allowed for shader model 6.2 and above.";
return 1;
}
}
// /enable-16bit-types only allowed for HLSL 2018 and shader model 6.2
if (opts.Enable16BitTypes) {
if (opts.TargetProfile.empty() || opts.HLSLVersion < hlsl::LangStd::v2018 ||
Major < 6 || (Major == 6 && Minor < 2)) {
errors << "enable-16bit-types is only allowed for shader model >= 6.2 "
"and HLSL Language >= 2018.";
return 1;
}
}
opts.DisableOptimizations = false;
if (Arg *A = Args.getLastArg(OPT_O0, OPT_O1, OPT_O2, OPT_O3, OPT_Od)) {
if (A->getOption().matches(OPT_O0))
opts.OptLevel = 0;
if (A->getOption().matches(OPT_O1))
opts.OptLevel = 1;
if (A->getOption().matches(OPT_O2))
opts.OptLevel = 2;
if (A->getOption().matches(OPT_O3))
opts.OptLevel = 3;
if (A->getOption().matches(OPT_Od)) {
opts.DisableOptimizations = true;
opts.OptLevel = 0;
}
} else
opts.OptLevel = 3;
opts.OptDump = Args.hasFlag(OPT_Odump, OPT_INVALID, false);
opts.DisableValidation = Args.hasFlag(OPT_VD, OPT_INVALID, false);
opts.AllResourcesBound =
Args.hasFlag(OPT_all_resources_bound, OPT_INVALID, false);
opts.AllResourcesBound = Args.hasFlag(OPT_all_resources_bound_, OPT_INVALID,
opts.AllResourcesBound);
opts.IgnoreOptSemDefs =
Args.hasFlag(OPT_ignore_opt_semdefs, OPT_INVALID, false);
opts.ColorCodeAssembly = Args.hasFlag(OPT_Cc, OPT_INVALID, false);
opts.DefaultRowMajor = Args.hasFlag(OPT_Zpr, OPT_INVALID, false);
opts.DefaultColMajor = Args.hasFlag(OPT_Zpc, OPT_INVALID, false);
opts.DumpBin = Args.hasFlag(OPT_dumpbin, OPT_INVALID, false);
opts.Link = Args.hasFlag(OPT_link, OPT_INVALID, false);
bool NotUseLegacyCBufLoad =
Args.hasFlag(OPT_no_legacy_cbuf_layout, OPT_INVALID, false);
NotUseLegacyCBufLoad = Args.hasFlag(OPT_not_use_legacy_cbuf_load_,
OPT_INVALID, NotUseLegacyCBufLoad);
if (NotUseLegacyCBufLoad)
errors << "warning: -no-legacy-cbuf-layout"
<< " is no longer supported and will be ignored."
<< " Future releases will not recognize it.\n";
opts.PackPrefixStable =
Args.hasFlag(OPT_pack_prefix_stable, OPT_INVALID, false);
opts.PackPrefixStable =
Args.hasFlag(OPT_pack_prefix_stable_, OPT_INVALID, opts.PackPrefixStable);
opts.PackOptimized = Args.hasFlag(OPT_pack_optimized, OPT_INVALID, false);
opts.PackOptimized =
Args.hasFlag(OPT_pack_optimized_, OPT_INVALID, opts.PackOptimized);
opts.DisplayIncludeProcess = Args.hasFlag(OPT_H, OPT_INVALID, false);
opts.WarningAsError = Args.hasFlag(OPT__SLASH_WX, OPT_INVALID, false);
opts.AvoidFlowControl = Args.hasFlag(OPT_Gfa, OPT_INVALID, false);
opts.PreferFlowControl = Args.hasFlag(OPT_Gfp, OPT_INVALID, false);
opts.RecompileFromBinary = Args.hasFlag(OPT_recompile, OPT_INVALID, false);
opts.StripDebug = Args.hasFlag(OPT_Qstrip_debug, OPT_INVALID, false);
opts.EmbedDebug = Args.hasFlag(OPT_Qembed_debug, OPT_INVALID, false);
opts.SourceInDebugModule =
Args.hasFlag(OPT_Qsource_in_debug_module, OPT_INVALID, false);
opts.SourceOnlyDebug = Args.hasFlag(OPT_Zs, OPT_INVALID, false);
opts.PdbInPrivate = Args.hasFlag(OPT_Qpdb_in_private, OPT_INVALID, false);
opts.StripRootSignature =
Args.hasFlag(OPT_Qstrip_rootsignature, OPT_INVALID, false);
opts.StripPrivate = Args.hasFlag(OPT_Qstrip_priv, OPT_INVALID, false);
opts.StripReflection = Args.hasFlag(OPT_Qstrip_reflect, OPT_INVALID, false);
opts.KeepReflectionInDxil =
Args.hasFlag(OPT_Qkeep_reflect_in_dxil, OPT_INVALID, false);
opts.StripReflectionFromDxil =
Args.hasFlag(OPT_Qstrip_reflect_from_dxil, OPT_INVALID, false);
opts.ExtractRootSignature =
Args.hasFlag(OPT_extractrootsignature, OPT_INVALID, false);
opts.DisassembleColorCoded = Args.hasFlag(OPT_Cc, OPT_INVALID, false);
opts.DisassembleInstNumbers = Args.hasFlag(OPT_Ni, OPT_INVALID, false);
opts.DisassembleByteOffset = Args.hasFlag(OPT_No, OPT_INVALID, false);
opts.DisaseembleHex = Args.hasFlag(OPT_Lx, OPT_INVALID, false);
opts.LegacyMacroExpansion =
Args.hasFlag(OPT_flegacy_macro_expansion, OPT_INVALID, false);
opts.LegacyResourceReservation =
Args.hasFlag(OPT_flegacy_resource_reservation, OPT_INVALID, false);
opts.ExportShadersOnly =
Args.hasFlag(OPT_export_shaders_only, OPT_INVALID, false);
opts.PrintBeforeAll = Args.hasFlag(OPT_print_before_all, OPT_INVALID, false);
opts.PrintAfterAll = Args.hasFlag(OPT_print_after_all, OPT_INVALID, false);
opts.ResMayAlias = Args.hasFlag(OPT_res_may_alias, OPT_INVALID, false);
opts.ResMayAlias =
Args.hasFlag(OPT_res_may_alias_, OPT_INVALID, opts.ResMayAlias);
opts.ForceZeroStoreLifetimes =
Args.hasFlag(OPT_force_zero_store_lifetimes, OPT_INVALID, false);
// Lifetime markers on by default in 6.6 unless disabled explicitly
opts.EnableLifetimeMarkers =
Args.hasFlag(OPT_enable_lifetime_markers, OPT_disable_lifetime_markers,
DXIL::CompareVersions(Major, Minor, 6, 6) >= 0);
opts.ForceDisableLocTracking =
Args.hasFlag(OPT_fdisable_loc_tracking, OPT_INVALID, false);
opts.NewInlining =
Args.hasFlag(OPT_fnew_inlining_behavior, OPT_INVALID, false);
opts.TimeReport = Args.hasFlag(OPT_ftime_report, OPT_INVALID, false);
opts.TimeTrace = Args.hasFlag(OPT_ftime_trace, OPT_INVALID, false) ? "-" : "";
opts.VerifyDiagnostics = Args.hasFlag(OPT_verify, OPT_INVALID, false);
opts.Verbose = Args.hasFlag(OPT_verbose, OPT_INVALID, false);
if (Args.hasArg(OPT_ftime_trace_EQ))
opts.TimeTrace = Args.getLastArgValue(OPT_ftime_trace_EQ);
if (Arg *A = Args.getLastArg(OPT_ftime_trace_granularity_EQ)) {
if (llvm::StringRef(A->getValue())
.getAsInteger(10, opts.TimeTraceGranularity)) {
opts.TimeTraceGranularity = 500;
errors << "Warning: Invalid value for -ftime-trace-granularity option "
"specified, defaulting to "
<< opts.TimeTraceGranularity << " microseconds.";
}
}
opts.EnablePayloadQualifiers =
Args.hasFlag(OPT_enable_payload_qualifiers, OPT_INVALID,
DXIL::CompareVersions(Major, Minor, 6, 7) >= 0);
for (const std::string &value : Args.getAllArgValues(OPT_print_before)) {
opts.PrintBefore.insert(value);
}
for (const std::string &value : Args.getAllArgValues(OPT_print_after)) {
opts.PrintAfter.insert(value);
}
opts.EnablePayloadQualifiers &=
!Args.hasFlag(OPT_disable_payload_qualifiers, OPT_INVALID, false);
if (opts.EnablePayloadQualifiers &&
DXIL::CompareVersions(Major, Minor, 6, 6) < 0) {
errors << "Invalid target for payload access qualifiers. Only lib_6_6 and "
"beyond are supported.";
return 1;
}
opts.HandleExceptions =
!Args.hasFlag(OPT_disable_exception_handling, OPT_INVALID, false);
if (opts.DefaultColMajor && opts.DefaultRowMajor) {
errors << "Cannot specify /Zpr and /Zpc together, use /? to get usage "
"information";
return 1;
}
if (opts.AvoidFlowControl && opts.PreferFlowControl) {
errors << "Cannot specify /Gfa and /Gfp together, use /? to get usage "
"information";
return 1;
}
if (opts.PackPrefixStable && opts.PackOptimized) {
errors << "Cannot specify /pack_prefix_stable and /pack_optimized "
"together, use /? to get usage information";
return 1;
}
// TODO: more fxc option check.
// ERR_RES_MAY_ALIAS_ONLY_IN_CS_5
// ERR_NOT_ABLE_TO_FLATTEN on if that contain side effects
// TODO: other front-end error.
// ERR_RESOURCE_NOT_IN_TEMPLATE
// ERR_COMPLEX_TEMPLATE_RESOURCE
// ERR_RESOURCE_BIND_CONFLICT
// ERR_TEMPLATE_VAR_CONFLICT
// ERR_ATTRIBUTE_PARAM_SIDE_EFFECT
if (opts.StripPrivate && !opts.PrivateSource.empty()) {
errors << "Cannot specify /Qstrip_priv and /setprivate together.";
return 1;
}
if (opts.PdbInPrivate && !opts.PrivateSource.empty()) {
errors << "Cannot specify /Qpdb_in_private and /setprivate together.";
return 1;
}
if (opts.StripPrivate && opts.PdbInPrivate) {
errors << "Cannot specify /Qstrip_priv and /Qpdb_in_private together.";
return 1;
}
if ((flagsToInclude & hlsl::options::DriverOption) &&
opts.InputFile.empty()) {
// Input file is required in arguments only for drivers; APIs take this
// through an argument.
errors << "Required input file argument is missing. use -help to get more "
"information.";
return 1;
}
if (opts.OutputHeader.empty() && !opts.VariableName.empty()) {
errors
<< "Cannot specify a header variable name when not writing a header.";
return 1;
}
if (!opts.Preprocess.empty() &&
(!opts.OutputHeader.empty() || !opts.OutputObject.empty() ||
!opts.OutputWarnings || !opts.OutputWarningsFile.empty() ||
!opts.OutputReflectionFile.empty() || !opts.OutputRootSigFile.empty() ||
!opts.OutputShaderHashFile.empty())) {
opts.OutputHeader = "";
opts.OutputObject = "";
opts.OutputWarnings = true;
opts.OutputWarningsFile = "";
opts.OutputReflectionFile = "";
opts.OutputRootSigFile = "";
opts.OutputShaderHashFile = "";
errors << "Warning: compiler options ignored with Preprocess.";
}
if (opts.DumpBin) {
if (opts.DisplayIncludeProcess || opts.AstDump || opts.DumpDependencies) {
errors << "Cannot perform actions related to sources from a binary file.";
return 1;
}
if (opts.AllResourcesBound || opts.AvoidFlowControl ||
opts.CodeGenHighLevel || opts.DebugInfo || opts.DefaultColMajor ||
opts.DefaultRowMajor || opts.Defines.size() != 0 ||
opts.DisableOptimizations || !opts.EntryPoint.empty() ||
!opts.ForceRootSigVer.empty() || opts.PreferFlowControl ||
!opts.TargetProfile.empty()) {
errors
<< "Cannot specify compilation options when reading a binary file.";
return 1;
}
}
// XXX TODO: Sort this out, since it's required for new API, but a separate
// argument for old APIs.
if ((flagsToInclude & hlsl::options::DriverOption) &&
!(flagsToInclude & hlsl::options::RewriteOption) &&
opts.TargetProfile.empty() && !opts.DumpBin && opts.Preprocess.empty() &&
!opts.RecompileFromBinary) {
// Target profile is required in arguments only for drivers when compiling;
// APIs take this through an argument.
errors << "Target profile argument is missing";
return 1;