blob: 923ded3052eba5290969fd6dcb8bfed2a4c7aa10 [file] [log] [blame]
John Kessenicha0af4732012-12-12 21:15:54 +00001//
John Kessenich927608b2017-01-06 12:34:14 -07002// Copyright (C) 2002-2005 3Dlabs Inc. Ltd.
3// Copyright (C) 2013-2016 LunarG, Inc.
John Kessenich56364b62020-03-01 04:51:40 -07004// Copyright (C) 2016-2020 Google, Inc.
John Kessenichbd0747d2013-02-17 06:01:50 +00005//
John Kessenich927608b2017-01-06 12:34:14 -07006// All rights reserved.
John Kessenicha0af4732012-12-12 21:15:54 +00007//
John Kessenich927608b2017-01-06 12:34:14 -07008// Redistribution and use in source and binary forms, with or without
9// modification, are permitted provided that the following conditions
10// are met:
John Kessenicha0af4732012-12-12 21:15:54 +000011//
12// Redistributions of source code must retain the above copyright
13// notice, this list of conditions and the following disclaimer.
14//
15// Redistributions in binary form must reproduce the above
16// copyright notice, this list of conditions and the following
17// disclaimer in the documentation and/or other materials provided
18// with the distribution.
19//
20// Neither the name of 3Dlabs Inc. Ltd. nor the names of its
21// contributors may be used to endorse or promote products derived
22// from this software without specific prior written permission.
23//
John Kessenich927608b2017-01-06 12:34:14 -070024// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
25// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
26// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
27// FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
28// COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
29// INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
30// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
31// LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
32// CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
33// LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
34// ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35// POSSIBILITY OF SUCH DAMAGE.
John Kessenicha0af4732012-12-12 21:15:54 +000036//
John Kessenich05a70632013-09-17 19:26:08 +000037
38// this only applies to the standalone wrapper, not the front end in general
Aras Pranckevicius8e204b22017-05-10 16:52:50 +030039#ifndef _CRT_SECURE_NO_WARNINGS
John Kessenich05a70632013-09-17 19:26:08 +000040#define _CRT_SECURE_NO_WARNINGS
Aras Pranckevicius8e204b22017-05-10 16:52:50 +030041#endif
John Kessenich05a70632013-09-17 19:26:08 +000042
Lei Zhang8a9b1ee2016-05-19 13:31:43 -040043#include "ResourceLimits.h"
John Kessenich2b07c7e2013-07-31 18:44:13 +000044#include "Worklist.h"
John Kessenich3494b4d2017-05-22 15:00:42 -060045#include "DirStackFileIncluder.h"
John Kessenicha0af4732012-12-12 21:15:54 +000046#include "./../glslang/Include/ShHandle.h"
47#include "./../glslang/Public/ShaderLang.h"
John Kessenich0df0cde2015-03-03 17:09:43 +000048#include "../SPIRV/GlslangToSpv.h"
John Kessenich5e4b1242015-08-06 22:53:06 -060049#include "../SPIRV/GLSL.std.450.h"
John Kessenichacba7722015-03-04 03:48:38 +000050#include "../SPIRV/doc.h"
51#include "../SPIRV/disassemble.h"
John Kessenich3494b4d2017-05-22 15:00:42 -060052
John Kessenich66ec80e2016-08-05 14:04:23 -060053#include <cstring>
54#include <cstdlib>
steve-lunarg7f7c2ed2016-09-07 15:20:19 -060055#include <cctype>
John Kessenich66ec80e2016-08-05 14:04:23 -060056#include <cmath>
steve-lunarg7f7c2ed2016-09-07 15:20:19 -060057#include <array>
LoopDawg08a14422017-10-17 19:27:14 -060058#include <map>
Juan Lopeza558b262017-04-02 23:04:00 +020059#include <memory>
60#include <thread>
John Kessenicha0af4732012-12-12 21:15:54 +000061
baldurk876a0e32015-11-16 18:03:28 +010062#include "../glslang/OSDependent/osinclude.h"
John Kessenicha0af4732012-12-12 21:15:54 +000063
Ben Claytonfbe9a232020-06-17 11:17:19 +010064// Build-time generated includes
65#include "glslang/build_info.h"
66
John Kessenicha0af4732012-12-12 21:15:54 +000067extern "C" {
Ben Claytond64e8592020-06-29 14:20:19 +010068 GLSLANG_EXPORT void ShOutputHtml();
John Kessenicha0af4732012-12-12 21:15:54 +000069}
70
John Kessenich94a81fb2013-08-31 02:41:30 +000071// Command-line options
72enum TOptions {
John Kessenich906cc212016-12-09 19:22:20 -070073 EOptionNone = 0,
74 EOptionIntermediate = (1 << 0),
75 EOptionSuppressInfolog = (1 << 1),
76 EOptionMemoryLeakMode = (1 << 2),
77 EOptionRelaxedErrors = (1 << 3),
78 EOptionGiveWarnings = (1 << 4),
79 EOptionLinkProgram = (1 << 5),
80 EOptionMultiThreaded = (1 << 6),
81 EOptionDumpConfig = (1 << 7),
82 EOptionDumpReflection = (1 << 8),
83 EOptionSuppressWarnings = (1 << 9),
84 EOptionDumpVersions = (1 << 10),
85 EOptionSpv = (1 << 11),
86 EOptionHumanReadableSpv = (1 << 12),
87 EOptionVulkanRules = (1 << 13),
88 EOptionDefaultDesktop = (1 << 14),
89 EOptionOutputPreprocessed = (1 << 15),
90 EOptionOutputHexadecimal = (1 << 16),
91 EOptionReadHlsl = (1 << 17),
92 EOptionCascadingErrors = (1 << 18),
93 EOptionAutoMapBindings = (1 << 19),
steve-lunarge0b9deb2016-09-16 13:26:37 -060094 EOptionFlattenUniformArrays = (1 << 20),
John Kessenich906cc212016-12-09 19:22:20 -070095 EOptionNoStorageFormat = (1 << 21),
John Kessenich20f01e72016-12-12 11:41:43 -070096 EOptionKeepUncalled = (1 << 22),
John Kessenich4f1403e2017-04-05 17:38:20 -060097 EOptionHlslOffsets = (1 << 23),
steve-lunargbe283552017-04-18 12:18:01 -060098 EOptionHlslIoMapping = (1 << 24),
John Kessenich71facdf2017-05-17 18:28:19 -060099 EOptionAutoMapLocations = (1 << 25),
John Kessenich121853f2017-05-31 17:11:16 -0600100 EOptionDebug = (1 << 26),
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +0200101 EOptionStdin = (1 << 27),
GregFcd1f1692017-09-21 18:40:22 -0600102 EOptionOptimizeDisable = (1 << 28),
103 EOptionOptimizeSize = (1 << 29),
LoopDawgb22c0692017-12-06 16:52:03 -0700104 EOptionInvertY = (1 << 30),
John Kessenichc6c80a62018-03-05 22:23:17 -0700105 EOptionDumpBareVersion = (1 << 31),
John Kessenich94a81fb2013-08-31 02:41:30 +0000106};
John Kessenich5d610ee2018-03-07 18:05:55 -0700107bool targetHlslFunctionality1 = false;
John Kesseniche2156222018-06-11 18:12:15 -0600108bool SpvToolsDisassembler = false;
John Kessenichc3404252018-08-23 15:29:08 -0600109bool SpvToolsValidate = false;
John Kessenich605afc72019-06-17 23:33:09 -0600110bool NaNClamp = false;
Shahbaz Youssefid52dce52020-06-17 12:47:44 -0400111bool stripDebugInfo = false;
Marcin Åšlusarz245c30c2020-07-03 14:55:29 +0200112bool beQuiet = false;
greg-lunarg4e064ee2021-03-15 11:26:11 -0600113bool VulkanRulesRelaxed = false;
John Kessenich94a81fb2013-08-31 02:41:30 +0000114
John Kessenicha0af4732012-12-12 21:15:54 +0000115//
John Kessenich68d78fd2015-07-12 19:28:10 -0600116// Return codes from main/exit().
John Kessenicha0af4732012-12-12 21:15:54 +0000117//
118enum TFailCode {
119 ESuccess = 0,
120 EFailUsage,
121 EFailCompile,
122 EFailLink,
123 EFailCompilerCreate,
John Kessenich2b07c7e2013-07-31 18:44:13 +0000124 EFailThreadCreate,
John Kessenicha0af4732012-12-12 21:15:54 +0000125 EFailLinkerCreate
126};
127
128//
John Kessenich68d78fd2015-07-12 19:28:10 -0600129// Forward declarations.
John Kessenicha0af4732012-12-12 21:15:54 +0000130//
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600131EShLanguage FindLanguage(const std::string& name, bool parseSuffix=true);
John Kessenich51cdd902014-02-18 23:37:57 +0000132void CompileFile(const char* fileName, ShHandle);
John Kessenicha0af4732012-12-12 21:15:54 +0000133void usage();
John Kessenich04acb1b2017-06-14 17:36:50 -0600134char* ReadFileData(const char* fileName);
135void FreeFileData(char* data);
John Kessenich54d8cda2013-02-11 22:36:01 +0000136void InfoLogMsg(const char* msg, const char* name, const int num);
John Kessenich41cf6b52013-06-25 18:10:05 +0000137
John Kessenichc999ba22013-11-07 23:33:24 +0000138// Globally track if any compile or link failure.
139bool CompileFailed = false;
140bool LinkFailed = false;
141
John Kessenich94f28eb2017-11-13 01:32:06 -0700142// array of unique places to leave the shader names and infologs for the asynchronous compiles
143std::vector<std::unique_ptr<glslang::TWorkItem>> WorkItems;
144
John Kessenich05a70632013-09-17 19:26:08 +0000145TBuiltInResource Resources;
146std::string ConfigFile;
147
John Kessenicha0af4732012-12-12 21:15:54 +0000148//
John Kessenichf0bcb0a2016-04-02 13:09:14 -0600149// Parse either a .conf file provided by the user or the default from glslang::DefaultTBuiltInResource
John Kessenich05a70632013-09-17 19:26:08 +0000150//
151void ProcessConfigFile()
John Kessenichb51f62c2013-04-11 16:31:09 +0000152{
John Kessenich04acb1b2017-06-14 17:36:50 -0600153 if (ConfigFile.size() == 0)
Lei Zhang414eb602016-03-04 16:22:34 -0500154 Resources = glslang::DefaultTBuiltInResource;
John Kessenich23d27752019-07-28 02:12:10 -0600155#ifndef GLSLANG_WEB
John Kessenich04acb1b2017-06-14 17:36:50 -0600156 else {
157 char* configString = ReadFileData(ConfigFile.c_str());
158 glslang::DecodeResourceLimits(&Resources, configString);
159 FreeFileData(configString);
John Kessenich05a70632013-09-17 19:26:08 +0000160 }
John Kessenich23d27752019-07-28 02:12:10 -0600161#endif
John Kessenicha0af4732012-12-12 21:15:54 +0000162}
163
baldurk6d477852019-01-29 15:45:56 +0000164int ReflectOptions = EShReflectionDefault;
John Kessenich94a81fb2013-08-31 02:41:30 +0000165int Options = 0;
John Kessenich68d78fd2015-07-12 19:28:10 -0600166const char* ExecutableName = nullptr;
167const char* binaryFileName = nullptr;
John Kessenich4d65ee32016-03-12 18:17:47 -0700168const char* entryPointName = nullptr;
steve-lunargf1e0c872016-10-31 15:13:43 -0600169const char* sourceEntryPointName = nullptr;
Dan Bakerc6ede892016-08-11 14:06:06 -0400170const char* shaderStageName = nullptr;
Flavioaea3c892017-02-06 11:46:35 -0800171const char* variableName = nullptr;
Rex Xucb61eec2018-03-07 13:10:01 +0800172bool HlslEnable16BitTypes = false;
John Kessenichbd1c1832018-12-07 18:38:26 -0700173bool HlslDX9compatible = false;
Christoph Kubisch55ba3ea2019-04-13 22:18:16 +0200174bool DumpBuiltinSymbols = false;
John Kessenich971a0a82017-06-07 15:06:58 -0600175std::vector<std::string> IncludeDirectoryList;
John Kessenich8717a5d2018-10-26 10:12:32 -0600176
177// Source environment
178// (source 'Client' is currently the same as target 'Client')
179int ClientInputSemanticsVersion = 100;
180
181// Target environment
182glslang::EShClient Client = glslang::EShClientNone; // will stay EShClientNone if only validating
183glslang::EShTargetClientVersion ClientVersion; // not valid until Client is set
184glslang::EShTargetLanguage TargetLanguage = glslang::EShTargetNone;
185glslang::EShTargetLanguageVersion TargetVersion; // not valid until TargetLanguage is set
186
John Kessenich66011cb2018-03-06 16:12:04 -0700187std::vector<std::string> Processes; // what should be recorded by OpModuleProcessed, or equivalent
John Kessenich68d78fd2015-07-12 19:28:10 -0600188
LoopDawg08a14422017-10-17 19:27:14 -0600189// Per descriptor-set binding base data
190typedef std::map<unsigned int, unsigned int> TPerSetBaseBinding;
191
Neil Roberts16f53472018-03-20 17:30:53 +0100192std::vector<std::pair<std::string, int>> uniformLocationOverrides;
Neil Robertsb0f3d792018-03-20 17:41:05 +0100193int uniformBase = 0;
Neil Roberts16f53472018-03-20 17:30:53 +0100194
LoopDawg08a14422017-10-17 19:27:14 -0600195std::array<std::array<unsigned int, EShLangCount>, glslang::EResCount> baseBinding;
196std::array<std::array<TPerSetBaseBinding, EShLangCount>, glslang::EResCount> baseBindingForSet;
Hyangran Park36dc8292017-05-02 16:27:29 +0900197std::array<std::vector<std::string>, EShLangCount> baseResourceSetBinding;
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600198
greg-lunarg4e064ee2021-03-15 11:26:11 -0600199std::vector<std::pair<std::string, glslang::TBlockStorageClass>> blockStorageOverrides;
200
201bool setGlobalUniformBlock = false;
202std::string globalUniformName;
203unsigned int globalUniformBinding;
204unsigned int globalUniformSet;
205
206bool setGlobalBufferBlock = false;
207std::string atomicCounterBlockName;
208unsigned int atomicCounterBlockSet;
209
John Kessenicha9313662017-06-15 10:40:49 -0600210// Add things like "#define ..." to a preamble to use in the beginning of the shader.
211class TPreamble {
212public:
213 TPreamble() { }
214
215 bool isSet() const { return text.size() > 0; }
216 const char* get() const { return text.c_str(); }
217
218 // #define...
219 void addDef(std::string def)
220 {
221 text.append("#define ");
222 fixLine(def);
223
John Kessenich6f988922020-01-07 07:03:11 -0700224 Processes.push_back("define-macro ");
John Kessenich2a271162017-07-20 20:00:36 -0600225 Processes.back().append(def);
226
John Kessenicha9313662017-06-15 10:40:49 -0600227 // The first "=" needs to turn into a space
LoopDawgb97b25e2017-07-12 09:04:39 -0600228 const size_t equal = def.find_first_of("=");
John Kessenicha9313662017-06-15 10:40:49 -0600229 if (equal != def.npos)
230 def[equal] = ' ';
231
232 text.append(def);
233 text.append("\n");
234 }
235
236 // #undef...
237 void addUndef(std::string undef)
238 {
239 text.append("#undef ");
240 fixLine(undef);
John Kessenich2a271162017-07-20 20:00:36 -0600241
John Kessenich6f988922020-01-07 07:03:11 -0700242 Processes.push_back("undef-macro ");
John Kessenich2a271162017-07-20 20:00:36 -0600243 Processes.back().append(undef);
244
John Kessenicha9313662017-06-15 10:40:49 -0600245 text.append(undef);
246 text.append("\n");
247 }
248
249protected:
250 void fixLine(std::string& line)
251 {
252 // Can't go past a newline in the line
LoopDawgb97b25e2017-07-12 09:04:39 -0600253 const size_t end = line.find_first_of("\n");
John Kessenicha9313662017-06-15 10:40:49 -0600254 if (end != line.npos)
255 line = line.substr(0, end);
256 }
257
258 std::string text; // contents of preamble
259};
260
John Kessenich83855b92020-03-30 00:27:31 -0600261// Track the user's #define and #undef from the command line.
John Kessenicha9313662017-06-15 10:40:49 -0600262TPreamble UserPreamble;
263
John Kessenich68d78fd2015-07-12 19:28:10 -0600264//
265// Create the default name for saving a binary if -o is not provided.
266//
267const char* GetBinaryName(EShLanguage stage)
268{
269 const char* name;
270 if (binaryFileName == nullptr) {
271 switch (stage) {
272 case EShLangVertex: name = "vert.spv"; break;
273 case EShLangTessControl: name = "tesc.spv"; break;
274 case EShLangTessEvaluation: name = "tese.spv"; break;
275 case EShLangGeometry: name = "geom.spv"; break;
276 case EShLangFragment: name = "frag.spv"; break;
277 case EShLangCompute: name = "comp.spv"; break;
Daniel Kochdb32b242020-03-17 20:42:47 -0400278 case EShLangRayGen: name = "rgen.spv"; break;
279 case EShLangIntersect: name = "rint.spv"; break;
280 case EShLangAnyHit: name = "rahit.spv"; break;
281 case EShLangClosestHit: name = "rchit.spv"; break;
282 case EShLangMiss: name = "rmiss.spv"; break;
283 case EShLangCallable: name = "rcall.spv"; break;
Chao Chen3c366992018-09-19 11:41:59 -0700284 case EShLangMeshNV: name = "mesh.spv"; break;
285 case EShLangTaskNV: name = "task.spv"; break;
John Kessenich68d78fd2015-07-12 19:28:10 -0600286 default: name = "unknown"; break;
287 }
288 } else
289 name = binaryFileName;
290
291 return name;
292}
John Kessenich2b07c7e2013-07-31 18:44:13 +0000293
John Kessenich05a70632013-09-17 19:26:08 +0000294//
295// *.conf => this is a config file that can set limits/resources
296//
297bool SetConfigFile(const std::string& name)
298{
299 if (name.size() < 5)
300 return false;
301
John Kessenich4c706852013-10-11 16:28:43 +0000302 if (name.compare(name.size() - 5, 5, ".conf") == 0) {
John Kessenich05a70632013-09-17 19:26:08 +0000303 ConfigFile = name;
304 return true;
305 }
306
307 return false;
308}
309
John Kessenich68d78fd2015-07-12 19:28:10 -0600310//
311// Give error and exit with failure code.
312//
John Kessenichbd97b6f2019-12-20 10:33:13 -0700313void Error(const char* message, const char* detail = nullptr)
John Kessenich68d78fd2015-07-12 19:28:10 -0600314{
John Kessenichbd97b6f2019-12-20 10:33:13 -0700315 fprintf(stderr, "%s: Error: ", ExecutableName);
316 if (detail != nullptr)
317 fprintf(stderr, "%s: ", detail);
318 fprintf(stderr, "%s (use -h for usage)\n", message);
John Kessenich68d78fd2015-07-12 19:28:10 -0600319 exit(EFailUsage);
320}
321
322//
LoopDawg08a14422017-10-17 19:27:14 -0600323// Process an optional binding base of one the forms:
324// --argname [stage] base // base for stage (if given) or all stages (if not)
LoopDawge5709552017-10-21 10:46:39 -0600325// --argname [stage] [base set]... // set/base pairs: set the base for given binding set.
LoopDawg08a14422017-10-17 19:27:14 -0600326
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600327// Where stage is one of the forms accepted by FindLanguage, and base is an integer
328//
LoopDawg08a14422017-10-17 19:27:14 -0600329void ProcessBindingBase(int& argc, char**& argv, glslang::TResourceType res)
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600330{
331 if (argc < 2)
332 usage();
333
LoopDawg08a14422017-10-17 19:27:14 -0600334 EShLanguage lang = EShLangCount;
335 int singleBase = 0;
336 TPerSetBaseBinding perSetBase;
337 int arg = 1;
338
339 // Parse stage, if given
340 if (!isdigit(argv[arg][0])) {
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600341 if (argc < 3) // this form needs one more argument
342 usage();
John Kessenichecba76f2017-01-06 00:34:48 -0700343
LoopDawg08a14422017-10-17 19:27:14 -0600344 lang = FindLanguage(argv[arg++], false);
345 }
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600346
LoopDawg08a14422017-10-17 19:27:14 -0600347 if ((argc - arg) > 2 && isdigit(argv[arg+0][0]) && isdigit(argv[arg+1][0])) {
348 // Parse a per-set binding base
349 while ((argc - arg) > 2 && isdigit(argv[arg+0][0]) && isdigit(argv[arg+1][0])) {
LoopDawg08a14422017-10-17 19:27:14 -0600350 const int baseNum = atoi(argv[arg++]);
LoopDawge5709552017-10-21 10:46:39 -0600351 const int setNum = atoi(argv[arg++]);
LoopDawg08a14422017-10-17 19:27:14 -0600352 perSetBase[setNum] = baseNum;
353 }
354 } else {
355 // Parse single binding base
356 singleBase = atoi(argv[arg++]);
357 }
358
359 argc -= (arg-1);
360 argv += (arg-1);
361
362 // Set one or all languages
363 const int langMin = (lang < EShLangCount) ? lang+0 : 0;
364 const int langMax = (lang < EShLangCount) ? lang+1 : EShLangCount;
365
366 for (int lang = langMin; lang < langMax; ++lang) {
367 if (!perSetBase.empty())
John Kessenich251901a2018-08-12 22:05:59 -0600368 baseBindingForSet[res][lang].insert(perSetBase.begin(), perSetBase.end());
LoopDawg08a14422017-10-17 19:27:14 -0600369 else
370 baseBinding[res][lang] = singleBase;
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600371 }
372}
373
Hyangran Park36dc8292017-05-02 16:27:29 +0900374void ProcessResourceSetBindingBase(int& argc, char**& argv, std::array<std::vector<std::string>, EShLangCount>& base)
375{
376 if (argc < 2)
377 usage();
378
379 if (!isdigit(argv[1][0])) {
LoopDawg52017192017-07-14 15:15:47 -0600380 if (argc < 3) // this form needs one more argument
Hyangran Park36dc8292017-05-02 16:27:29 +0900381 usage();
382
LoopDawg52017192017-07-14 15:15:47 -0600383 // Parse form: --argname stage [regname set base...], or:
384 // --argname stage set
Hyangran Park36dc8292017-05-02 16:27:29 +0900385 const EShLanguage lang = FindLanguage(argv[1], false);
386
LoopDawg52017192017-07-14 15:15:47 -0600387 argc--;
388 argv++;
389
390 while (argc > 1 && argv[1] != nullptr && argv[1][0] != '-') {
391 base[lang].push_back(argv[1]);
392
393 argc--;
394 argv++;
Hyangran Park36dc8292017-05-02 16:27:29 +0900395 }
LoopDawg52017192017-07-14 15:15:47 -0600396
397 // Must have one arg, or a multiple of three (for [regname set binding] triples)
398 if (base[lang].size() != 1 && (base[lang].size() % 3) != 0)
399 usage();
400
Hyangran Park36dc8292017-05-02 16:27:29 +0900401 } else {
LoopDawg52017192017-07-14 15:15:47 -0600402 // Parse form: --argname set
Hyangran Park36dc8292017-05-02 16:27:29 +0900403 for (int lang=0; lang<EShLangCount; ++lang)
404 base[lang].push_back(argv[1]);
405
406 argc--;
407 argv++;
408 }
409}
410
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600411//
greg-lunarg4e064ee2021-03-15 11:26:11 -0600412// Process an optional binding base of one the forms:
413// --argname name {uniform|buffer|push_constant}
414void ProcessBlockStorage(int& argc, char**& argv, std::vector<std::pair<std::string, glslang::TBlockStorageClass>>& storage)
415{
416 if (argc < 3)
417 usage();
418
419 glslang::TBlockStorageClass blockStorage = glslang::EbsNone;
420
421 std::string strBacking(argv[2]);
422 if (strBacking == "uniform")
423 blockStorage = glslang::EbsUniform;
424 else if (strBacking == "buffer")
425 blockStorage = glslang::EbsStorageBuffer;
426 else if (strBacking == "push_constant")
427 blockStorage = glslang::EbsPushConstant;
428 else {
429 printf("%s: invalid block storage\n", strBacking.c_str());
430 usage();
431 }
432
433 storage.push_back(std::make_pair(std::string(argv[1]), blockStorage));
434
435 argc -= 2;
436 argv += 2;
437}
438
439inline bool isNonDigit(char c) {
440 // a non-digit character valid in a glsl identifier
441 return (c == '_') || (c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z');
442}
443
444// whether string isa valid identifier to be used in glsl
445bool isValidIdentifier(const char* str) {
446 std::string idn(str);
447
448 if (idn.length() == 0) {
449 return false;
450 }
451
452 if (idn.length() >= 3 && idn.substr(0, 3) == "gl_") {
453 // identifiers startin with "gl_" are reserved
454 return false;
455 }
456
457 if (!isNonDigit(idn[0])) {
458 return false;
459 }
460
461 for (unsigned int i = 1; i < idn.length(); ++i) {
462 if (!(isdigit(idn[i]) || isNonDigit(idn[i]))) {
463 return false;
464 }
465 }
466
467 return true;
468}
469
470// Process settings for either the global buffer block or global unfirom block
471// of the form:
472// --argname name set binding
473void ProcessGlobalBlockSettings(int& argc, char**& argv, std::string* name, unsigned int* set, unsigned int* binding)
474{
475 if (argc < 4)
476 usage();
477
478 unsigned int curArg = 1;
479
480 assert(name || set || binding);
481
482 if (name) {
483 if (!isValidIdentifier(argv[curArg])) {
484 printf("%s: invalid identifier\n", argv[curArg]);
485 usage();
486 }
487 *name = argv[curArg];
488
489 curArg++;
490 }
491
492 if (set) {
493 errno = 0;
494 int setVal = ::strtol(argv[curArg], NULL, 10);
495 if (errno || setVal < 0) {
496 printf("%s: invalid set\n", argv[curArg]);
497 usage();
498 }
499 *set = setVal;
500
501 curArg++;
502 }
503
504 if (binding) {
505 errno = 0;
506 int bindingVal = ::strtol(argv[curArg], NULL, 10);
507 if (errno || bindingVal < 0) {
508 printf("%s: invalid binding\n", argv[curArg]);
509 usage();
510 }
511 *binding = bindingVal;
512
513 curArg++;
514 }
515
516 argc -= (curArg - 1);
517 argv += (curArg - 1);
518}
519
520//
John Kessenich68d78fd2015-07-12 19:28:10 -0600521// Do all command-line argument parsing. This includes building up the work-items
522// to be processed later, and saving all the command-line options.
523//
524// Does not return (it exits) if command-line is fatally flawed.
525//
Juan Lopeza558b262017-04-02 23:04:00 +0200526void ProcessArguments(std::vector<std::unique_ptr<glslang::TWorkItem>>& workItems, int argc, char* argv[])
John Kessenich2b07c7e2013-07-31 18:44:13 +0000527{
LoopDawg08a14422017-10-17 19:27:14 -0600528 for (int res = 0; res < glslang::EResCount; ++res)
529 baseBinding[res].fill(0);
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600530
John Kessenich38f3b892013-09-06 19:52:57 +0000531 ExecutableName = argv[0];
Juan Lopeza558b262017-04-02 23:04:00 +0200532 workItems.reserve(argc);
John Kessenich38f3b892013-09-06 19:52:57 +0000533
John Kessenichc178f0a2017-06-23 10:58:31 -0600534 const auto bumpArg = [&]() {
535 if (argc > 0) {
536 argc--;
537 argv++;
538 }
539 };
540
541 // read a string directly attached to a single-letter option
John Kessenich6263fb12017-06-14 15:52:44 -0600542 const auto getStringOperand = [&](const char* desc) {
543 if (argv[0][2] == 0) {
544 printf("%s must immediately follow option (no spaces)\n", desc);
545 exit(EFailUsage);
546 }
547 return argv[0] + 2;
548 };
549
John Kessenich6353d552017-06-23 11:11:09 -0600550 // read a number attached to a single-letter option
551 const auto getAttachedNumber = [&](const char* desc) {
552 int num = atoi(argv[0] + 2);
553 if (num == 0) {
554 printf("%s: expected attached non-0 number\n", desc);
555 exit(EFailUsage);
556 }
557 return num;
558 };
559
560 // minimum needed (without overriding something else) to target Vulkan SPIR-V
561 const auto setVulkanSpv = []() {
John Kessenich8717a5d2018-10-26 10:12:32 -0600562 if (Client == glslang::EShClientNone)
563 ClientVersion = glslang::EShTargetVulkan_1_0;
564 Client = glslang::EShClientVulkan;
John Kessenich6353d552017-06-23 11:11:09 -0600565 Options |= EOptionSpv;
566 Options |= EOptionVulkanRules;
567 Options |= EOptionLinkProgram;
568 };
569
570 // minimum needed (without overriding something else) to target OpenGL SPIR-V
571 const auto setOpenGlSpv = []() {
John Kessenich8717a5d2018-10-26 10:12:32 -0600572 if (Client == glslang::EShClientNone)
573 ClientVersion = glslang::EShTargetOpenGL_450;
574 Client = glslang::EShClientOpenGL;
John Kessenich6353d552017-06-23 11:11:09 -0600575 Options |= EOptionSpv;
576 Options |= EOptionLinkProgram;
577 // undo a -H default to Vulkan
578 Options &= ~EOptionVulkanRules;
579 };
580
Neil Roberts16f53472018-03-20 17:30:53 +0100581 const auto getUniformOverride = [getStringOperand]() {
582 const char *arg = getStringOperand("-u<name>:<location>");
583 const char *split = strchr(arg, ':');
584 if (split == NULL) {
585 printf("%s: missing location\n", arg);
586 exit(EFailUsage);
587 }
588 errno = 0;
589 int location = ::strtol(split + 1, NULL, 10);
590 if (errno) {
591 printf("%s: invalid location\n", arg);
592 exit(EFailUsage);
593 }
594 return std::make_pair(std::string(arg, split - arg), location);
595 };
596
John Kessenichc178f0a2017-06-23 10:58:31 -0600597 for (bumpArg(); argc >= 1; bumpArg()) {
John Kessenich2b07c7e2013-07-31 18:44:13 +0000598 if (argv[0][0] == '-') {
John Kessenich2aa7f3a2015-05-15 16:02:07 +0000599 switch (argv[0][1]) {
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600600 case '-':
601 {
602 std::string lowerword(argv[0]+2);
603 std::transform(lowerword.begin(), lowerword.end(), lowerword.begin(), ::tolower);
604
605 // handle --word style options
John Kessenich6263fb12017-06-14 15:52:44 -0600606 if (lowerword == "auto-map-bindings" || // synonyms
John Kessenich6353d552017-06-23 11:11:09 -0600607 lowerword == "auto-map-binding" ||
608 lowerword == "amb") {
John Kessenich6263fb12017-06-14 15:52:44 -0600609 Options |= EOptionAutoMapBindings;
610 } else if (lowerword == "auto-map-locations" || // synonyms
611 lowerword == "aml") {
612 Options |= EOptionAutoMapLocations;
Neil Robertsb0f3d792018-03-20 17:41:05 +0100613 } else if (lowerword == "uniform-base") {
614 if (argc <= 1)
John Kessenichbd97b6f2019-12-20 10:33:13 -0700615 Error("no <base> provided", lowerword.c_str());
Neil Robertsb0f3d792018-03-20 17:41:05 +0100616 uniformBase = ::strtol(argv[1], NULL, 10);
617 bumpArg();
618 break;
John Kessenich6353d552017-06-23 11:11:09 -0600619 } else if (lowerword == "client") {
620 if (argc > 1) {
621 if (strcmp(argv[1], "vulkan100") == 0)
622 setVulkanSpv();
623 else if (strcmp(argv[1], "opengl100") == 0)
624 setOpenGlSpv();
625 else
John Kessenichbd97b6f2019-12-20 10:33:13 -0700626 Error("expects vulkan100 or opengl100", lowerword.c_str());
627 } else
628 Error("expects vulkan100 or opengl100", lowerword.c_str());
John Kessenich6353d552017-06-23 11:11:09 -0600629 bumpArg();
John Kessenich6f988922020-01-07 07:03:11 -0700630 } else if (lowerword == "define-macro" ||
631 lowerword == "d") {
632 if (argc > 1)
633 UserPreamble.addDef(argv[1]);
634 else
635 Error("expects <name[=def]>", argv[0]);
636 bumpArg();
Christoph Kubisch55ba3ea2019-04-13 22:18:16 +0200637 } else if (lowerword == "dump-builtin-symbols") {
638 DumpBuiltinSymbols = true;
John Kessenich640bd092018-08-09 14:15:00 -0600639 } else if (lowerword == "entry-point") {
640 entryPointName = argv[1];
641 if (argc <= 1)
John Kessenichbd97b6f2019-12-20 10:33:13 -0700642 Error("no <name> provided", lowerword.c_str());
John Kessenich640bd092018-08-09 14:15:00 -0600643 bumpArg();
John Kessenich6263fb12017-06-14 15:52:44 -0600644 } else if (lowerword == "flatten-uniform-arrays" || // synonyms
645 lowerword == "flatten-uniform-array" ||
646 lowerword == "fua") {
647 Options |= EOptionFlattenUniformArrays;
648 } else if (lowerword == "hlsl-offsets") {
649 Options |= EOptionHlslOffsets;
650 } else if (lowerword == "hlsl-iomap" ||
651 lowerword == "hlsl-iomapper" ||
652 lowerword == "hlsl-iomapping") {
653 Options |= EOptionHlslIoMapping;
Rex Xucb61eec2018-03-07 13:10:01 +0800654 } else if (lowerword == "hlsl-enable-16bit-types") {
655 HlslEnable16BitTypes = true;
John Kessenichbd1c1832018-12-07 18:38:26 -0700656 } else if (lowerword == "hlsl-dx9-compatible") {
657 HlslDX9compatible = true;
John Kessenichc6c80a62018-03-05 22:23:17 -0700658 } else if (lowerword == "invert-y" || // synonyms
659 lowerword == "iy") {
660 Options |= EOptionInvertY;
John Kessenich6263fb12017-06-14 15:52:44 -0600661 } else if (lowerword == "keep-uncalled" || // synonyms
662 lowerword == "ku") {
663 Options |= EOptionKeepUncalled;
John Kessenich605afc72019-06-17 23:33:09 -0600664 } else if (lowerword == "nan-clamp") {
665 NaNClamp = true;
John Kessenich6263fb12017-06-14 15:52:44 -0600666 } else if (lowerword == "no-storage-format" || // synonyms
667 lowerword == "nsf") {
668 Options |= EOptionNoStorageFormat;
John Kessenich2a271162017-07-20 20:00:36 -0600669 } else if (lowerword == "relaxed-errors") {
670 Options |= EOptionRelaxedErrors;
baldurk15c37f72019-01-29 12:12:59 +0000671 } else if (lowerword == "reflect-strict-array-suffix") {
672 ReflectOptions |= EShReflectionStrictArraySuffix;
baldurkedf82122019-01-29 15:49:00 +0000673 } else if (lowerword == "reflect-basic-array-suffix") {
674 ReflectOptions |= EShReflectionBasicArraySuffix;
baldurk0af5e3e2019-01-29 16:04:44 +0000675 } else if (lowerword == "reflect-intermediate-io") {
676 ReflectOptions |= EShReflectionIntermediateIO;
baldurk657acc02019-01-30 14:18:43 +0000677 } else if (lowerword == "reflect-separate-buffers") {
678 ReflectOptions |= EShReflectionSeparateBuffers;
baldurka972e732019-01-30 15:34:02 +0000679 } else if (lowerword == "reflect-all-block-variables") {
680 ReflectOptions |= EShReflectionAllBlockVariables;
baldurk19050692019-02-11 11:50:24 +0000681 } else if (lowerword == "reflect-unwrap-io-blocks") {
682 ReflectOptions |= EShReflectionUnwrapIOBlocks;
Chow81112682020-06-04 15:47:18 +0800683 } else if (lowerword == "reflect-all-io-variables") {
684 ReflectOptions |= EShReflectionAllIOVariables;
685 } else if (lowerword == "reflect-shared-std140-ubo") {
686 ReflectOptions |= EShReflectionSharedStd140UBO;
687 } else if (lowerword == "reflect-shared-std140-ssbo") {
688 ReflectOptions |= EShReflectionSharedStd140SSBO;
John Kessenich6263fb12017-06-14 15:52:44 -0600689 } else if (lowerword == "resource-set-bindings" || // synonyms
690 lowerword == "resource-set-binding" ||
691 lowerword == "rsb") {
692 ProcessResourceSetBindingBase(argc, argv, baseResourceSetBinding);
greg-lunarg4e064ee2021-03-15 11:26:11 -0600693 } else if (lowerword == "set-block-storage" ||
694 lowerword == "sbs") {
695 ProcessBlockStorage(argc, argv, blockStorageOverrides);
696 } else if (lowerword == "set-atomic-counter-block" ||
697 lowerword == "sacb") {
698 ProcessGlobalBlockSettings(argc, argv, &atomicCounterBlockName, &atomicCounterBlockSet, nullptr);
699 setGlobalBufferBlock = true;
700 } else if (lowerword == "set-default-uniform-block" ||
701 lowerword == "sdub") {
702 ProcessGlobalBlockSettings(argc, argv, &globalUniformName, &globalUniformSet, &globalUniformBinding);
703 setGlobalUniformBlock = true;
steve-lunarg9088be42016-11-01 10:31:42 -0600704 } else if (lowerword == "shift-image-bindings" || // synonyms
705 lowerword == "shift-image-binding" ||
706 lowerword == "sib") {
LoopDawg08a14422017-10-17 19:27:14 -0600707 ProcessBindingBase(argc, argv, glslang::EResImage);
John Kessenich6263fb12017-06-14 15:52:44 -0600708 } else if (lowerword == "shift-sampler-bindings" || // synonyms
John Kessenichade8bbb2018-08-12 21:24:55 -0600709 lowerword == "shift-sampler-binding" ||
710 lowerword == "ssb") {
LoopDawg08a14422017-10-17 19:27:14 -0600711 ProcessBindingBase(argc, argv, glslang::EResSampler);
John Kessenich6263fb12017-06-14 15:52:44 -0600712 } else if (lowerword == "shift-uav-bindings" || // synonyms
713 lowerword == "shift-uav-binding" ||
714 lowerword == "suavb") {
LoopDawg08a14422017-10-17 19:27:14 -0600715 ProcessBindingBase(argc, argv, glslang::EResUav);
John Kessenich6263fb12017-06-14 15:52:44 -0600716 } else if (lowerword == "shift-texture-bindings" || // synonyms
717 lowerword == "shift-texture-binding" ||
718 lowerword == "stb") {
LoopDawg08a14422017-10-17 19:27:14 -0600719 ProcessBindingBase(argc, argv, glslang::EResTexture);
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600720 } else if (lowerword == "shift-ubo-bindings" || // synonyms
721 lowerword == "shift-ubo-binding" ||
steve-lunargbe283552017-04-18 12:18:01 -0600722 lowerword == "shift-cbuffer-bindings" ||
723 lowerword == "shift-cbuffer-binding" ||
724 lowerword == "sub" ||
725 lowerword == "scb") {
LoopDawg08a14422017-10-17 19:27:14 -0600726 ProcessBindingBase(argc, argv, glslang::EResUbo);
steve-lunarg932bb5c2017-02-21 17:19:08 -0700727 } else if (lowerword == "shift-ssbo-bindings" || // synonyms
728 lowerword == "shift-ssbo-binding" ||
729 lowerword == "sbb") {
LoopDawg08a14422017-10-17 19:27:14 -0600730 ProcessBindingBase(argc, argv, glslang::EResSsbo);
John Kessenich6263fb12017-06-14 15:52:44 -0600731 } else if (lowerword == "source-entrypoint" || // synonyms
732 lowerword == "sep") {
John Kessenichc178f0a2017-06-23 10:58:31 -0600733 if (argc <= 1)
John Kessenichbd97b6f2019-12-20 10:33:13 -0700734 Error("no <entry-point> provided", lowerword.c_str());
John Kessenichc178f0a2017-06-23 10:58:31 -0600735 sourceEntryPointName = argv[1];
736 bumpArg();
John Kessenich6263fb12017-06-14 15:52:44 -0600737 break;
John Kesseniche2156222018-06-11 18:12:15 -0600738 } else if (lowerword == "spirv-dis") {
739 SpvToolsDisassembler = true;
John Kessenichc3404252018-08-23 15:29:08 -0600740 } else if (lowerword == "spirv-val") {
741 SpvToolsValidate = true;
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +0200742 } else if (lowerword == "stdin") {
743 Options |= EOptionStdin;
744 shaderStageName = argv[1];
John Kessenich2a271162017-07-20 20:00:36 -0600745 } else if (lowerword == "suppress-warnings") {
746 Options |= EOptionSuppressWarnings;
John Kessenich6353d552017-06-23 11:11:09 -0600747 } else if (lowerword == "target-env") {
748 if (argc > 1) {
749 if (strcmp(argv[1], "vulkan1.0") == 0) {
750 setVulkanSpv();
John Kessenich8717a5d2018-10-26 10:12:32 -0600751 ClientVersion = glslang::EShTargetVulkan_1_0;
John Kessenich66011cb2018-03-06 16:12:04 -0700752 } else if (strcmp(argv[1], "vulkan1.1") == 0) {
753 setVulkanSpv();
John Kessenich8717a5d2018-10-26 10:12:32 -0600754 ClientVersion = glslang::EShTargetVulkan_1_1;
John Kessenich273d3a52020-01-15 00:10:41 -0700755 } else if (strcmp(argv[1], "vulkan1.2") == 0) {
756 setVulkanSpv();
757 ClientVersion = glslang::EShTargetVulkan_1_2;
John Kessenich6353d552017-06-23 11:11:09 -0600758 } else if (strcmp(argv[1], "opengl") == 0) {
759 setOpenGlSpv();
John Kessenich8717a5d2018-10-26 10:12:32 -0600760 ClientVersion = glslang::EShTargetOpenGL_450;
761 } else if (strcmp(argv[1], "spirv1.0") == 0) {
762 TargetLanguage = glslang::EShTargetSpv;
763 TargetVersion = glslang::EShTargetSpv_1_0;
764 } else if (strcmp(argv[1], "spirv1.1") == 0) {
765 TargetLanguage = glslang::EShTargetSpv;
766 TargetVersion = glslang::EShTargetSpv_1_1;
767 } else if (strcmp(argv[1], "spirv1.2") == 0) {
768 TargetLanguage = glslang::EShTargetSpv;
769 TargetVersion = glslang::EShTargetSpv_1_2;
770 } else if (strcmp(argv[1], "spirv1.3") == 0) {
771 TargetLanguage = glslang::EShTargetSpv;
772 TargetVersion = glslang::EShTargetSpv_1_3;
773 } else if (strcmp(argv[1], "spirv1.4") == 0) {
774 TargetLanguage = glslang::EShTargetSpv;
775 TargetVersion = glslang::EShTargetSpv_1_4;
John Kessenich8317e6c2019-08-18 23:58:08 -0600776 } else if (strcmp(argv[1], "spirv1.5") == 0) {
777 TargetLanguage = glslang::EShTargetSpv;
778 TargetVersion = glslang::EShTargetSpv_1_5;
John Kessenich6353d552017-06-23 11:11:09 -0600779 } else
John Kessenich273d3a52020-01-15 00:10:41 -0700780 Error("--target-env expected one of: vulkan1.0, vulkan1.1, vulkan1.2, opengl,\n"
John Kessenich8317e6c2019-08-18 23:58:08 -0600781 "spirv1.0, spirv1.1, spirv1.2, spirv1.3, spirv1.4, or spirv1.5");
John Kessenich6353d552017-06-23 11:11:09 -0600782 }
783 bumpArg();
John Kessenich6f988922020-01-07 07:03:11 -0700784 } else if (lowerword == "undef-macro" ||
785 lowerword == "u") {
786 if (argc > 1)
787 UserPreamble.addUndef(argv[1]);
788 else
789 Error("expects <name>", argv[0]);
790 bumpArg();
Flavio15017db2017-02-15 14:29:33 -0800791 } else if (lowerword == "variable-name" || // synonyms
John Kessenich66011cb2018-03-06 16:12:04 -0700792 lowerword == "vn") {
Flavio15017db2017-02-15 14:29:33 -0800793 Options |= EOptionOutputHexadecimal;
John Kessenichc178f0a2017-06-23 10:58:31 -0600794 if (argc <= 1)
John Kessenichbd97b6f2019-12-20 10:33:13 -0700795 Error("no <C-variable-name> provided", lowerword.c_str());
John Kessenichc178f0a2017-06-23 10:58:31 -0600796 variableName = argv[1];
797 bumpArg();
Flavio15017db2017-02-15 14:29:33 -0800798 break;
Marcin Åšlusarz245c30c2020-07-03 14:55:29 +0200799 } else if (lowerword == "quiet") {
800 beQuiet = true;
John Kessenichc6c80a62018-03-05 22:23:17 -0700801 } else if (lowerword == "version") {
802 Options |= EOptionDumpVersions;
Jordan Justen6ad120e2020-01-28 12:18:12 -0800803 } else if (lowerword == "help") {
804 usage();
805 break;
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600806 } else {
John Kessenichbd97b6f2019-12-20 10:33:13 -0700807 Error("unrecognized command-line option", argv[0]);
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600808 }
809 }
810 break;
John Kessenich6263fb12017-06-14 15:52:44 -0600811 case 'C':
812 Options |= EOptionCascadingErrors;
813 break;
814 case 'D':
John Kessenicha9313662017-06-15 10:40:49 -0600815 if (argv[0][2] == 0)
816 Options |= EOptionReadHlsl;
817 else
John Kessenich6f988922020-01-07 07:03:11 -0700818 UserPreamble.addDef(getStringOperand("-D<name[=def]>"));
John Kessenich6263fb12017-06-14 15:52:44 -0600819 break;
Neil Roberts16f53472018-03-20 17:30:53 +0100820 case 'u':
821 uniformLocationOverrides.push_back(getUniformOverride());
822 break;
John Kessenich6263fb12017-06-14 15:52:44 -0600823 case 'E':
824 Options |= EOptionOutputPreprocessed;
825 break;
826 case 'G':
John Kessenich8717a5d2018-10-26 10:12:32 -0600827 // OpenGL client
John Kessenich6353d552017-06-23 11:11:09 -0600828 setOpenGlSpv();
829 if (argv[0][2] != 0)
830 ClientInputSemanticsVersion = getAttachedNumber("-G<num> client input semantics");
johnkslang2de6d652020-08-04 07:17:39 -0600831 if (ClientInputSemanticsVersion != 100)
832 Error("unknown client version for -G, should be 100");
John Kessenich6263fb12017-06-14 15:52:44 -0600833 break;
John Kessenich2aa7f3a2015-05-15 16:02:07 +0000834 case 'H':
835 Options |= EOptionHumanReadableSpv;
John Kessenich91e4aa52016-07-07 17:46:42 -0600836 if ((Options & EOptionSpv) == 0) {
837 // default to Vulkan
John Kessenich6353d552017-06-23 11:11:09 -0600838 setVulkanSpv();
John Kessenich91e4aa52016-07-07 17:46:42 -0600839 }
840 break;
John Kessenich971a0a82017-06-07 15:06:58 -0600841 case 'I':
John Kessenicha9313662017-06-15 10:40:49 -0600842 IncludeDirectoryList.push_back(getStringOperand("-I<dir> include path"));
John Kessenich68d78fd2015-07-12 19:28:10 -0600843 break;
GregFcd1f1692017-09-21 18:40:22 -0600844 case 'O':
845 if (argv[0][2] == 'd')
846 Options |= EOptionOptimizeDisable;
847 else if (argv[0][2] == 's')
GregFfb03a552018-03-29 11:49:14 -0600848#if ENABLE_OPT
GregFcd1f1692017-09-21 18:40:22 -0600849 Options |= EOptionOptimizeSize;
850#else
851 Error("-Os not available; optimizer not linked");
852#endif
853 else
854 Error("unknown -O option");
855 break;
greg-lunarg4e064ee2021-03-15 11:26:11 -0600856 case 'R':
857 VulkanRulesRelaxed = true;
858 break;
Dan Baker5afdd782016-08-11 17:53:57 -0400859 case 'S':
John Kessenichc178f0a2017-06-23 10:58:31 -0600860 if (argc <= 1)
Dan Baker5afdd782016-08-11 17:53:57 -0400861 Error("no <stage> specified for -S");
John Kessenichc178f0a2017-06-23 10:58:31 -0600862 shaderStageName = argv[1];
863 bumpArg();
dankbaker45d49bc2016-08-08 21:43:07 -0400864 break;
John Kessenicha9313662017-06-15 10:40:49 -0600865 case 'U':
John Kessenich6f988922020-01-07 07:03:11 -0700866 UserPreamble.addUndef(getStringOperand("-U<name>"));
John Kessenicha9313662017-06-15 10:40:49 -0600867 break;
John Kessenich6263fb12017-06-14 15:52:44 -0600868 case 'V':
John Kessenich6353d552017-06-23 11:11:09 -0600869 setVulkanSpv();
870 if (argv[0][2] != 0)
David Neto506d2c22018-02-27 21:55:23 -0500871 ClientInputSemanticsVersion = getAttachedNumber("-V<num> client input semantics");
johnkslang2de6d652020-08-04 07:17:39 -0600872 if (ClientInputSemanticsVersion != 100)
873 Error("unknown client version for -V, should be 100");
John Kessenichc555ddd2015-06-17 02:38:44 +0000874 break;
John Kessenich05a70632013-09-17 19:26:08 +0000875 case 'c':
876 Options |= EOptionDumpConfig;
877 break;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000878 case 'd':
John Kessenichc6c80a62018-03-05 22:23:17 -0700879 if (strncmp(&argv[0][1], "dumpversion", strlen(&argv[0][1]) + 1) == 0 ||
880 strncmp(&argv[0][1], "dumpfullversion", strlen(&argv[0][1]) + 1) == 0)
881 Options |= EOptionDumpBareVersion;
882 else
883 Options |= EOptionDefaultDesktop;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000884 break;
John Kessenich4d65ee32016-03-12 18:17:47 -0700885 case 'e':
John Kessenich4d65ee32016-03-12 18:17:47 -0700886 entryPointName = argv[1];
John Kessenichc178f0a2017-06-23 10:58:31 -0600887 if (argc <= 1)
John Kessenicha25530c2017-09-11 20:13:49 -0600888 Error("no <name> provided for -e");
John Kessenichc178f0a2017-06-23 10:58:31 -0600889 bumpArg();
John Kessenich4d65ee32016-03-12 18:17:47 -0700890 break;
John Kessenich5d610ee2018-03-07 18:05:55 -0700891 case 'f':
892 if (strcmp(&argv[0][2], "hlsl_functionality1") == 0)
893 targetHlslFunctionality1 = true;
894 else
895 Error("-f: expected hlsl_functionality1");
896 break;
John Kessenich121853f2017-05-31 17:11:16 -0600897 case 'g':
Shahbaz Youssefid52dce52020-06-17 12:47:44 -0400898 // Override previous -g or -g0 argument
899 stripDebugInfo = false;
900 Options &= ~EOptionDebug;
901 if (argv[0][2] == '0')
902 stripDebugInfo = true;
903 else
904 Options |= EOptionDebug;
John Kessenich121853f2017-05-31 17:11:16 -0600905 break;
John Kessenich68d78fd2015-07-12 19:28:10 -0600906 case 'h':
907 usage();
908 break;
John Kessenich05a70632013-09-17 19:26:08 +0000909 case 'i':
John Kessenich94a81fb2013-08-31 02:41:30 +0000910 Options |= EOptionIntermediate;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000911 break;
912 case 'l':
John Kessenichd78e3512014-08-25 20:07:55 +0000913 Options |= EOptionLinkProgram;
John Kessenich94a81fb2013-08-31 02:41:30 +0000914 break;
915 case 'm':
916 Options |= EOptionMemoryLeakMode;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000917 break;
John Kessenich68d78fd2015-07-12 19:28:10 -0600918 case 'o':
John Kessenichc178f0a2017-06-23 10:58:31 -0600919 if (argc <= 1)
John Kessenich68d78fd2015-07-12 19:28:10 -0600920 Error("no <file> provided for -o");
John Kessenichc178f0a2017-06-23 10:58:31 -0600921 binaryFileName = argv[1];
922 bumpArg();
John Kessenich68d78fd2015-07-12 19:28:10 -0600923 break;
John Kessenich11f9fc72013-11-07 01:06:34 +0000924 case 'q':
925 Options |= EOptionDumpReflection;
926 break;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000927 case 'r':
John Kessenich94a81fb2013-08-31 02:41:30 +0000928 Options |= EOptionRelaxedErrors;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000929 break;
930 case 's':
John Kessenich94a81fb2013-08-31 02:41:30 +0000931 Options |= EOptionSuppressInfolog;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000932 break;
John Kessenich38f3b892013-09-06 19:52:57 +0000933 case 't':
Juan Lopeza558b262017-04-02 23:04:00 +0200934 Options |= EOptionMultiThreaded;
John Kessenich38f3b892013-09-06 19:52:57 +0000935 break;
John Kessenich319de232013-12-04 04:43:40 +0000936 case 'v':
937 Options |= EOptionDumpVersions;
938 break;
John Kessenichb0a7eb52013-11-07 17:44:20 +0000939 case 'w':
940 Options |= EOptionSuppressWarnings;
941 break;
Johannes van Waverenecb0f3b2016-05-27 12:55:53 -0500942 case 'x':
943 Options |= EOptionOutputHexadecimal;
Johannes van Waverenecb0f3b2016-05-27 12:55:53 -0500944 break;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000945 default:
John Kessenichbd97b6f2019-12-20 10:33:13 -0700946 Error("unrecognized command-line option", argv[0]);
John Kessenich68d78fd2015-07-12 19:28:10 -0600947 break;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000948 }
John Kessenich38f3b892013-09-06 19:52:57 +0000949 } else {
John Kessenich05a70632013-09-17 19:26:08 +0000950 std::string name(argv[0]);
951 if (! SetConfigFile(name)) {
Juan Lopeza558b262017-04-02 23:04:00 +0200952 workItems.push_back(std::unique_ptr<glslang::TWorkItem>(new glslang::TWorkItem(name)));
John Kessenich05a70632013-09-17 19:26:08 +0000953 }
John Kessenich38f3b892013-09-06 19:52:57 +0000954 }
John Kessenich2b07c7e2013-07-31 18:44:13 +0000955 }
956
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +0200957 // Make sure that -S is always specified if --stdin is specified
958 if ((Options & EOptionStdin) && shaderStageName == nullptr)
959 Error("must provide -S when --stdin is given");
960
John Kessenich68d78fd2015-07-12 19:28:10 -0600961 // Make sure that -E is not specified alongside linking (which includes SPV generation)
John Kesseniche5c394b2019-07-02 09:32:48 -0600962 // Or things that require linking
963 if (Options & EOptionOutputPreprocessed) {
964 if (Options & EOptionLinkProgram)
965 Error("can't use -E when linking is selected");
966 if (Options & EOptionDumpReflection)
967 Error("reflection requires linking, which can't be used when -E when is selected");
968 }
969
970 // reflection requires linking
971 if ((Options & EOptionDumpReflection) && !(Options & EOptionLinkProgram))
972 Error("reflection requires -l for linking");
John Kessenichc555ddd2015-06-17 02:38:44 +0000973
Johannes van Waverenecb0f3b2016-05-27 12:55:53 -0500974 // -o or -x makes no sense if there is no target binary
John Kessenich68d78fd2015-07-12 19:28:10 -0600975 if (binaryFileName && (Options & EOptionSpv) == 0)
976 Error("no binary generation requested (e.g., -V)");
steve-lunarge0b9deb2016-09-16 13:26:37 -0600977
978 if ((Options & EOptionFlattenUniformArrays) != 0 &&
979 (Options & EOptionReadHlsl) == 0)
980 Error("uniform array flattening only valid when compiling HLSL source.");
John Kessenich8717a5d2018-10-26 10:12:32 -0600981
Jeremy Hayesb73afa82021-01-05 15:54:41 -0700982 if ((Options & EOptionReadHlsl) && (Client == glslang::EShClientOpenGL)) {
983 Error("Using HLSL input under OpenGL semantics is not currently supported.");
984 }
985
John Kessenich8717a5d2018-10-26 10:12:32 -0600986 // rationalize client and target language
987 if (TargetLanguage == glslang::EShTargetNone) {
988 switch (ClientVersion) {
989 case glslang::EShTargetVulkan_1_0:
990 TargetLanguage = glslang::EShTargetSpv;
991 TargetVersion = glslang::EShTargetSpv_1_0;
992 break;
993 case glslang::EShTargetVulkan_1_1:
994 TargetLanguage = glslang::EShTargetSpv;
995 TargetVersion = glslang::EShTargetSpv_1_3;
996 break;
John Kessenich273d3a52020-01-15 00:10:41 -0700997 case glslang::EShTargetVulkan_1_2:
998 TargetLanguage = glslang::EShTargetSpv;
999 TargetVersion = glslang::EShTargetSpv_1_5;
1000 break;
John Kessenich8717a5d2018-10-26 10:12:32 -06001001 case glslang::EShTargetOpenGL_450:
1002 TargetLanguage = glslang::EShTargetSpv;
1003 TargetVersion = glslang::EShTargetSpv_1_0;
1004 break;
1005 default:
1006 break;
1007 }
1008 }
1009 if (TargetLanguage != glslang::EShTargetNone && Client == glslang::EShClientNone)
1010 Error("To generate SPIR-V, also specify client semantics. See -G and -V.");
John Kessenich2b07c7e2013-07-31 18:44:13 +00001011}
1012
John Kessenich68d78fd2015-07-12 19:28:10 -06001013//
1014// Translate the meaningful subset of command-line options to parser-behavior options.
1015//
John Kessenichb0a7eb52013-11-07 17:44:20 +00001016void SetMessageOptions(EShMessages& messages)
1017{
1018 if (Options & EOptionRelaxedErrors)
1019 messages = (EShMessages)(messages | EShMsgRelaxedErrors);
1020 if (Options & EOptionIntermediate)
1021 messages = (EShMessages)(messages | EShMsgAST);
1022 if (Options & EOptionSuppressWarnings)
1023 messages = (EShMessages)(messages | EShMsgSuppressWarnings);
John Kessenich68d78fd2015-07-12 19:28:10 -06001024 if (Options & EOptionSpv)
1025 messages = (EShMessages)(messages | EShMsgSpvRules);
1026 if (Options & EOptionVulkanRules)
1027 messages = (EShMessages)(messages | EShMsgVulkanRules);
Andrew Woloszynaae1ad82015-06-24 17:00:46 -04001028 if (Options & EOptionOutputPreprocessed)
1029 messages = (EShMessages)(messages | EShMsgOnlyPreprocessor);
John Kessenich66e2faf2016-03-12 18:34:36 -07001030 if (Options & EOptionReadHlsl)
1031 messages = (EShMessages)(messages | EShMsgReadHlsl);
John Kessenicha86836e2016-07-09 14:50:57 -06001032 if (Options & EOptionCascadingErrors)
1033 messages = (EShMessages)(messages | EShMsgCascadingErrors);
John Kessenich906cc212016-12-09 19:22:20 -07001034 if (Options & EOptionKeepUncalled)
1035 messages = (EShMessages)(messages | EShMsgKeepUncalled);
John Kessenich4f1403e2017-04-05 17:38:20 -06001036 if (Options & EOptionHlslOffsets)
1037 messages = (EShMessages)(messages | EShMsgHlslOffsets);
John Kessenich121853f2017-05-31 17:11:16 -06001038 if (Options & EOptionDebug)
1039 messages = (EShMessages)(messages | EShMsgDebugInfo);
Rex Xucb61eec2018-03-07 13:10:01 +08001040 if (HlslEnable16BitTypes)
1041 messages = (EShMessages)(messages | EShMsgHlslEnable16BitTypes);
GregFfb03a552018-03-29 11:49:14 -06001042 if ((Options & EOptionOptimizeDisable) || !ENABLE_OPT)
1043 messages = (EShMessages)(messages | EShMsgHlslLegalization);
John Kessenichbd1c1832018-12-07 18:38:26 -07001044 if (HlslDX9compatible)
1045 messages = (EShMessages)(messages | EShMsgHlslDX9Compatible);
Christoph Kubisch55ba3ea2019-04-13 22:18:16 +02001046 if (DumpBuiltinSymbols)
1047 messages = (EShMessages)(messages | EShMsgBuiltinSymbolTable);
John Kessenichb0a7eb52013-11-07 17:44:20 +00001048}
1049
John Kessenich68d78fd2015-07-12 19:28:10 -06001050//
John Kessenich69f4b512013-09-04 21:19:27 +00001051// Thread entry point, for non-linking asynchronous mode.
John Kessenichc999ba22013-11-07 23:33:24 +00001052//
Juan Lopeza558b262017-04-02 23:04:00 +02001053void CompileShaders(glslang::TWorklist& worklist)
John Kessenich2b07c7e2013-07-31 18:44:13 +00001054{
John Kessenich7f0bcfd2018-04-05 19:00:01 -06001055 if (Options & EOptionDebug)
1056 Error("cannot generate debug information unless linking to generate code");
1057
John Kessenich38f3b892013-09-06 19:52:57 +00001058 glslang::TWorkItem* workItem;
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001059 if (Options & EOptionStdin) {
John Kesseniche7f9cae2018-07-12 15:11:07 -06001060 if (worklist.remove(workItem)) {
1061 ShHandle compiler = ShConstructCompiler(FindLanguage("stdin"), Options);
1062 if (compiler == nullptr)
1063 return;
John Kessenich2b07c7e2013-07-31 18:44:13 +00001064
John Kesseniche7f9cae2018-07-12 15:11:07 -06001065 CompileFile("stdin", compiler);
John Kessenich2b07c7e2013-07-31 18:44:13 +00001066
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001067 if (! (Options & EOptionSuppressInfolog))
1068 workItem->results = ShGetInfoLog(compiler);
John Kessenich2b07c7e2013-07-31 18:44:13 +00001069
John Kesseniche7f9cae2018-07-12 15:11:07 -06001070 ShDestruct(compiler);
1071 }
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001072 } else {
1073 while (worklist.remove(workItem)) {
1074 ShHandle compiler = ShConstructCompiler(FindLanguage(workItem->name), Options);
1075 if (compiler == 0)
1076 return;
1077
1078 CompileFile(workItem->name.c_str(), compiler);
1079
1080 if (! (Options & EOptionSuppressInfolog))
1081 workItem->results = ShGetInfoLog(compiler);
1082
1083 ShDestruct(compiler);
1084 }
John Kessenich2b07c7e2013-07-31 18:44:13 +00001085 }
John Kessenich2b07c7e2013-07-31 18:44:13 +00001086}
1087
John Kessenich6626cad2015-06-19 05:14:19 +00001088// Outputs the given string, but only if it is non-null and non-empty.
1089// This prevents erroneous newlines from appearing.
Andrew Woloszynaae1ad82015-06-24 17:00:46 -04001090void PutsIfNonEmpty(const char* str)
John Kessenich6626cad2015-06-19 05:14:19 +00001091{
1092 if (str && str[0]) {
1093 puts(str);
1094 }
1095}
1096
Andrew Woloszynaae1ad82015-06-24 17:00:46 -04001097// Outputs the given string to stderr, but only if it is non-null and non-empty.
1098// This prevents erroneous newlines from appearing.
1099void StderrIfNonEmpty(const char* str)
1100{
John Kessenich04acb1b2017-06-14 17:36:50 -06001101 if (str && str[0])
1102 fprintf(stderr, "%s\n", str);
Andrew Woloszynaae1ad82015-06-24 17:00:46 -04001103}
1104
John Kessenichc57b2a92016-01-16 15:30:03 -07001105// Simple bundling of what makes a compilation unit for ease in passing around,
1106// and separation of handling file IO versus API (programmatic) compilation.
1107struct ShaderCompUnit {
1108 EShLanguage stage;
John Kessenich04acb1b2017-06-14 17:36:50 -06001109 static const int maxCount = 1;
1110 int count; // live number of strings/names
John Kessenicha9313662017-06-15 10:40:49 -06001111 const char* text[maxCount]; // memory owned/managed externally
John Kessenich04acb1b2017-06-14 17:36:50 -06001112 std::string fileName[maxCount]; // hold's the memory, but...
1113 const char* fileNameList[maxCount]; // downstream interface wants pointers
dankbakerafe6e9c2016-08-21 12:29:08 -04001114
John Kessenich04acb1b2017-06-14 17:36:50 -06001115 ShaderCompUnit(EShLanguage stage) : stage(stage), count(0) { }
dankbakerafe6e9c2016-08-21 12:29:08 -04001116
John Kessenich04acb1b2017-06-14 17:36:50 -06001117 ShaderCompUnit(const ShaderCompUnit& rhs)
dankbakerafe6e9c2016-08-21 12:29:08 -04001118 {
1119 stage = rhs.stage;
John Kessenich04acb1b2017-06-14 17:36:50 -06001120 count = rhs.count;
1121 for (int i = 0; i < count; ++i) {
1122 fileName[i] = rhs.fileName[i];
1123 text[i] = rhs.text[i];
1124 fileNameList[i] = rhs.fileName[i].c_str();
1125 }
dankbakerafe6e9c2016-08-21 12:29:08 -04001126 }
1127
John Kessenicha9313662017-06-15 10:40:49 -06001128 void addString(std::string& ifileName, const char* itext)
John Kessenich04acb1b2017-06-14 17:36:50 -06001129 {
1130 assert(count < maxCount);
1131 fileName[count] = ifileName;
1132 text[count] = itext;
1133 fileNameList[count] = fileName[count].c_str();
1134 ++count;
1135 }
John Kessenichc57b2a92016-01-16 15:30:03 -07001136};
1137
John Kessenich69f4b512013-09-04 21:19:27 +00001138//
John Kessenichc57b2a92016-01-16 15:30:03 -07001139// For linking mode: Will independently parse each compilation unit, but then put them
1140// in the same program and link them together, making at most one linked module per
1141// pipeline stage.
John Kessenich69f4b512013-09-04 21:19:27 +00001142//
1143// Uses the new C++ interface instead of the old handle-based interface.
1144//
John Kessenichc57b2a92016-01-16 15:30:03 -07001145
1146void CompileAndLinkShaderUnits(std::vector<ShaderCompUnit> compUnits)
John Kessenich69f4b512013-09-04 21:19:27 +00001147{
1148 // keep track of what to free
1149 std::list<glslang::TShader*> shaders;
John Kessenichc57b2a92016-01-16 15:30:03 -07001150
John Kessenich69f4b512013-09-04 21:19:27 +00001151 EShMessages messages = EShMsgDefault;
John Kessenichb0a7eb52013-11-07 17:44:20 +00001152 SetMessageOptions(messages);
John Kessenich69f4b512013-09-04 21:19:27 +00001153
John Kessenich69f4b512013-09-04 21:19:27 +00001154 //
1155 // Per-shader processing...
1156 //
1157
John Kessenich5b0f13a2013-11-01 03:08:40 +00001158 glslang::TProgram& program = *new glslang::TProgram;
rdb32084e82016-02-23 22:17:38 +01001159 for (auto it = compUnits.cbegin(); it != compUnits.cend(); ++it) {
1160 const auto &compUnit = *it;
John Kessenichc57b2a92016-01-16 15:30:03 -07001161 glslang::TShader* shader = new glslang::TShader(compUnit.stage);
John Kessenich04acb1b2017-06-14 17:36:50 -06001162 shader->setStringsWithLengthsAndNames(compUnit.text, NULL, compUnit.fileNameList, compUnit.count);
John Kessenich640bd092018-08-09 14:15:00 -06001163 if (entryPointName)
John Kessenich4d65ee32016-03-12 18:17:47 -07001164 shader->setEntryPoint(entryPointName);
John Kessenich3693e632017-09-29 17:51:52 -06001165 if (sourceEntryPointName) {
1166 if (entryPointName == nullptr)
1167 printf("Warning: Changing source entry point name without setting an entry-point name.\n"
1168 "Use '-e <name>'.\n");
steve-lunargf1e0c872016-10-31 15:13:43 -06001169 shader->setSourceEntryPoint(sourceEntryPointName);
John Kessenich3693e632017-09-29 17:51:52 -06001170 }
John Kessenicha9313662017-06-15 10:40:49 -06001171 if (UserPreamble.isSet())
1172 shader->setPreamble(UserPreamble.get());
John Kessenich2a271162017-07-20 20:00:36 -06001173 shader->addProcesses(Processes);
steve-lunarg7f7c2ed2016-09-07 15:20:19 -06001174
John Kessenich155d3512019-08-08 23:29:20 -06001175#ifndef GLSLANG_WEB
LoopDawg08a14422017-10-17 19:27:14 -06001176 // Set IO mapper binding shift values
1177 for (int r = 0; r < glslang::EResCount; ++r) {
1178 const glslang::TResourceType res = glslang::TResourceType(r);
1179
1180 // Set base bindings
1181 shader->setShiftBinding(res, baseBinding[res][compUnit.stage]);
David Neto8c3d5b42019-10-21 14:50:31 -04001182
LoopDawg08a14422017-10-17 19:27:14 -06001183 // Set bindings for particular resource sets
1184 // TODO: use a range based for loop here, when available in all environments.
1185 for (auto i = baseBindingForSet[res][compUnit.stage].begin();
1186 i != baseBindingForSet[res][compUnit.stage].end(); ++i)
LoopDawge5709552017-10-21 10:46:39 -06001187 shader->setShiftBindingForSet(res, i->second, i->first);
LoopDawg08a14422017-10-17 19:27:14 -06001188 }
steve-lunargcce8d482016-10-14 18:36:42 -06001189 shader->setNoStorageFormat((Options & EOptionNoStorageFormat) != 0);
Hyangran Park36dc8292017-05-02 16:27:29 +09001190 shader->setResourceSetBinding(baseResourceSetBinding[compUnit.stage]);
steve-lunarg7f7c2ed2016-09-07 15:20:19 -06001191
1192 if (Options & EOptionAutoMapBindings)
1193 shader->setAutoMapBindings(true);
John Kessenichecba76f2017-01-06 00:34:48 -07001194
John Kessenich71facdf2017-05-17 18:28:19 -06001195 if (Options & EOptionAutoMapLocations)
1196 shader->setAutoMapLocations(true);
1197
Neil Roberts16f53472018-03-20 17:30:53 +01001198 for (auto& uniOverride : uniformLocationOverrides) {
1199 shader->addUniformLocationOverride(uniOverride.first.c_str(),
1200 uniOverride.second);
1201 }
1202
Neil Robertsb0f3d792018-03-20 17:41:05 +01001203 shader->setUniformLocationBase(uniformBase);
John Kessenich155d3512019-08-08 23:29:20 -06001204#endif
1205
greg-lunarg4e064ee2021-03-15 11:26:11 -06001206 if (VulkanRulesRelaxed) {
1207 for (auto& storageOverride : blockStorageOverrides) {
1208 shader->addBlockStorageOverride(storageOverride.first.c_str(),
1209 storageOverride.second);
1210 }
1211
1212 if (setGlobalBufferBlock) {
1213 shader->setAtomicCounterBlockName(atomicCounterBlockName.c_str());
1214 shader->setAtomicCounterBlockSet(atomicCounterBlockSet);
1215 }
1216
1217 if (setGlobalUniformBlock) {
1218 shader->setGlobalUniformBlockName(globalUniformName.c_str());
1219 shader->setGlobalUniformSet(globalUniformSet);
1220 shader->setGlobalUniformBinding(globalUniformBinding);
1221 }
1222 }
1223
John Kessenich155d3512019-08-08 23:29:20 -06001224 shader->setNanMinMaxClamp(NaNClamp);
1225
1226#ifdef ENABLE_HLSL
1227 shader->setFlattenUniformArrays((Options & EOptionFlattenUniformArrays) != 0);
1228 if (Options & EOptionHlslIoMapping)
1229 shader->setHlslIoMapping(true);
1230#endif
1231
1232 if (Options & EOptionInvertY)
1233 shader->setInvertY(true);
Neil Robertsb0f3d792018-03-20 17:41:05 +01001234
John Kessenich4be4aeb2017-06-23 10:50:22 -06001235 // Set up the environment, some subsettings take precedence over earlier
1236 // ways of setting things.
1237 if (Options & EOptionSpv) {
John Kessenich8717a5d2018-10-26 10:12:32 -06001238 shader->setEnvInput((Options & EOptionReadHlsl) ? glslang::EShSourceHlsl
1239 : glslang::EShSourceGlsl,
1240 compUnit.stage, Client, ClientInputSemanticsVersion);
1241 shader->setEnvClient(Client, ClientVersion);
1242 shader->setEnvTarget(TargetLanguage, TargetVersion);
John Kessenichd4ed5152019-07-27 05:22:30 -06001243#ifdef ENABLE_HLSL
John Kessenich5d610ee2018-03-07 18:05:55 -07001244 if (targetHlslFunctionality1)
1245 shader->setEnvTargetHlslFunctionality1();
John Kessenichd4ed5152019-07-27 05:22:30 -06001246#endif
greg-lunarg4e064ee2021-03-15 11:26:11 -06001247 if (VulkanRulesRelaxed)
1248 shader->setEnvInputVulkanRulesRelaxed();
John Kessenich4be4aeb2017-06-23 10:50:22 -06001249 }
1250
John Kessenich69f4b512013-09-04 21:19:27 +00001251 shaders.push_back(shader);
John Kessenichb3297152015-07-11 18:01:03 -06001252
John Kessenich4be4aeb2017-06-23 10:50:22 -06001253 const int defaultVersion = Options & EOptionDefaultDesktop ? 110 : 100;
John Kessenich69f4b512013-09-04 21:19:27 +00001254
John Kessenich3494b4d2017-05-22 15:00:42 -06001255 DirStackFileIncluder includer;
John Kessenich971a0a82017-06-07 15:06:58 -06001256 std::for_each(IncludeDirectoryList.rbegin(), IncludeDirectoryList.rend(), [&includer](const std::string& dir) {
1257 includer.pushExternalLocalDirectory(dir); });
John Kessenichdeec1932019-08-13 08:00:30 -06001258#ifndef GLSLANG_WEB
John Kessenichc555ddd2015-06-17 02:38:44 +00001259 if (Options & EOptionOutputPreprocessed) {
1260 std::string str;
John Kessenich086febc2018-10-25 12:43:02 -06001261 if (shader->preprocess(&Resources, defaultVersion, ENoProfile, false, false, messages, &str, includer)) {
Andrew Woloszynaae1ad82015-06-24 17:00:46 -04001262 PutsIfNonEmpty(str.c_str());
1263 } else {
1264 CompileFailed = true;
1265 }
1266 StderrIfNonEmpty(shader->getInfoLog());
1267 StderrIfNonEmpty(shader->getInfoDebugLog());
John Kessenichc555ddd2015-06-17 02:38:44 +00001268 continue;
1269 }
John Kessenichdeec1932019-08-13 08:00:30 -06001270#endif
John Kessenich086febc2018-10-25 12:43:02 -06001271
John Kessenich3494b4d2017-05-22 15:00:42 -06001272 if (! shader->parse(&Resources, defaultVersion, false, messages, includer))
John Kessenichc999ba22013-11-07 23:33:24 +00001273 CompileFailed = true;
John Kessenichc555ddd2015-06-17 02:38:44 +00001274
John Kessenich69f4b512013-09-04 21:19:27 +00001275 program.addShader(shader);
1276
John Kessenichc57b2a92016-01-16 15:30:03 -07001277 if (! (Options & EOptionSuppressInfolog) &&
1278 ! (Options & EOptionMemoryLeakMode)) {
Marcin Åšlusarz245c30c2020-07-03 14:55:29 +02001279 if (!beQuiet)
1280 PutsIfNonEmpty(compUnit.fileName[0].c_str());
Andrew Woloszynaae1ad82015-06-24 17:00:46 -04001281 PutsIfNonEmpty(shader->getInfoLog());
1282 PutsIfNonEmpty(shader->getInfoDebugLog());
John Kessenich69f4b512013-09-04 21:19:27 +00001283 }
John Kessenich69f4b512013-09-04 21:19:27 +00001284 }
1285
1286 //
1287 // Program-level processing...
1288 //
1289
John Kessenich4d65ee32016-03-12 18:17:47 -07001290 // Link
John Kessenich68d78fd2015-07-12 19:28:10 -06001291 if (! (Options & EOptionOutputPreprocessed) && ! program.link(messages))
John Kessenichc999ba22013-11-07 23:33:24 +00001292 LinkFailed = true;
1293
John Kessenichb6d3ee52019-08-06 02:20:45 -06001294#ifndef GLSLANG_WEB
steve-lunarg9ae34742016-10-05 13:40:13 -06001295 // Map IO
1296 if (Options & EOptionSpv) {
1297 if (!program.mapIO())
1298 LinkFailed = true;
1299 }
John Kessenichb6d3ee52019-08-06 02:20:45 -06001300#endif
John Kessenichecba76f2017-01-06 00:34:48 -07001301
John Kessenich4d65ee32016-03-12 18:17:47 -07001302 // Report
John Kessenichc57b2a92016-01-16 15:30:03 -07001303 if (! (Options & EOptionSuppressInfolog) &&
1304 ! (Options & EOptionMemoryLeakMode)) {
Andrew Woloszynaae1ad82015-06-24 17:00:46 -04001305 PutsIfNonEmpty(program.getInfoLog());
1306 PutsIfNonEmpty(program.getInfoDebugLog());
John Kessenich69f4b512013-09-04 21:19:27 +00001307 }
1308
John Kessenichb6d3ee52019-08-06 02:20:45 -06001309#ifndef GLSLANG_WEB
John Kessenich4d65ee32016-03-12 18:17:47 -07001310 // Reflect
John Kessenich11f9fc72013-11-07 01:06:34 +00001311 if (Options & EOptionDumpReflection) {
baldurk6d477852019-01-29 15:45:56 +00001312 program.buildReflection(ReflectOptions);
John Kessenich11f9fc72013-11-07 01:06:34 +00001313 program.dumpReflection();
1314 }
John Kessenichb6d3ee52019-08-06 02:20:45 -06001315#endif
John Kessenich11f9fc72013-11-07 01:06:34 +00001316
John Kessenich4d65ee32016-03-12 18:17:47 -07001317 // Dump SPIR-V
John Kessenich0df0cde2015-03-03 17:09:43 +00001318 if (Options & EOptionSpv) {
John Kessenich92f90382014-07-28 04:21:04 +00001319 if (CompileFailed || LinkFailed)
John Kessenich68d78fd2015-07-12 19:28:10 -06001320 printf("SPIR-V is not generated for failed compile or link\n");
John Kessenich92f90382014-07-28 04:21:04 +00001321 else {
1322 for (int stage = 0; stage < EShLangCount; ++stage) {
John Kessenicha7a68a92014-08-24 18:21:00 +00001323 if (program.getIntermediate((EShLanguage)stage)) {
John Kessenich0df0cde2015-03-03 17:09:43 +00001324 std::vector<unsigned int> spirv;
Lei Zhang17535f72016-05-04 15:55:59 -04001325 spv::SpvBuildLogger logger;
John Kessenich121853f2017-05-31 17:11:16 -06001326 glslang::SpvOptions spvOptions;
1327 if (Options & EOptionDebug)
1328 spvOptions.generateDebugInfo = true;
Shahbaz Youssefid52dce52020-06-17 12:47:44 -04001329 else if (stripDebugInfo)
1330 spvOptions.stripDebugInfo = true;
GregF52fe3d52017-09-28 10:08:32 -06001331 spvOptions.disableOptimizer = (Options & EOptionOptimizeDisable) != 0;
1332 spvOptions.optimizeSize = (Options & EOptionOptimizeSize) != 0;
John Kessenich717c80a2018-08-23 15:17:10 -06001333 spvOptions.disassemble = SpvToolsDisassembler;
John Kessenichc3404252018-08-23 15:29:08 -06001334 spvOptions.validate = SpvToolsValidate;
John Kessenich121853f2017-05-31 17:11:16 -06001335 glslang::GlslangToSpv(*program.getIntermediate((EShLanguage)stage), spirv, &logger, &spvOptions);
John Kessenichc57b2a92016-01-16 15:30:03 -07001336
1337 // Dump the spv to a file or stdout, etc., but only if not doing
1338 // memory/perf testing, as it's not internal to programmatic use.
1339 if (! (Options & EOptionMemoryLeakMode)) {
Johannes van Waverenecb0f3b2016-05-27 12:55:53 -05001340 printf("%s", logger.getAllMessages().c_str());
1341 if (Options & EOptionOutputHexadecimal) {
John Kessenich8f674e82017-02-18 09:45:40 -07001342 glslang::OutputSpvHex(spirv, GetBinaryName((EShLanguage)stage), variableName);
Johannes van Waverenecb0f3b2016-05-27 12:55:53 -05001343 } else {
1344 glslang::OutputSpvBin(spirv, GetBinaryName((EShLanguage)stage));
1345 }
John Kessenich23d27752019-07-28 02:12:10 -06001346#ifndef GLSLANG_WEB
John Kesseniche2156222018-06-11 18:12:15 -06001347 if (!SpvToolsDisassembler && (Options & EOptionHumanReadableSpv))
John Kessenichc57b2a92016-01-16 15:30:03 -07001348 spv::Disassemble(std::cout, spirv);
John Kessenich23d27752019-07-28 02:12:10 -06001349#endif
John Kessenichacba7722015-03-04 03:48:38 +00001350 }
John Kessenicha7a68a92014-08-24 18:21:00 +00001351 }
John Kessenich92f90382014-07-28 04:21:04 +00001352 }
1353 }
1354 }
1355
John Kessenich5b0f13a2013-11-01 03:08:40 +00001356 // Free everything up, program has to go before the shaders
1357 // because it might have merged stuff from the shaders, and
1358 // the stuff from the shaders has to have its destructors called
1359 // before the pools holding the memory in the shaders is freed.
1360 delete &program;
John Kessenich69f4b512013-09-04 21:19:27 +00001361 while (shaders.size() > 0) {
1362 delete shaders.back();
1363 shaders.pop_back();
1364 }
John Kessenich69f4b512013-09-04 21:19:27 +00001365}
1366
John Kessenichc57b2a92016-01-16 15:30:03 -07001367//
1368// Do file IO part of compile and link, handing off the pure
1369// API/programmatic mode to CompileAndLinkShaderUnits(), which can
1370// be put in a loop for testing memory footprint and performance.
1371//
1372// This is just for linking mode: meaning all the shaders will be put into the
1373// the same program linked together.
1374//
1375// This means there are a limited number of work items (not multi-threading mode)
1376// and that the point is testing at the linking level. Hence, to enable
1377// performance and memory testing, the actual compile/link can be put in
1378// a loop, independent of processing the work items and file IO.
1379//
Juan Lopeza558b262017-04-02 23:04:00 +02001380void CompileAndLinkShaderFiles(glslang::TWorklist& Worklist)
John Kessenichc57b2a92016-01-16 15:30:03 -07001381{
1382 std::vector<ShaderCompUnit> compUnits;
1383
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001384 // If this is using stdin, we can't really detect multiple different file
1385 // units by input type. We need to assume that we're just being given one
1386 // file of a certain type.
1387 if ((Options & EOptionStdin) != 0) {
1388 ShaderCompUnit compUnit(FindLanguage("stdin"));
1389 std::istreambuf_iterator<char> begin(std::cin), end;
1390 std::string tempString(begin, end);
1391 char* fileText = strdup(tempString.c_str());
1392 std::string fileName = "stdin";
1393 compUnit.addString(fileName, fileText);
John Kessenichc57b2a92016-01-16 15:30:03 -07001394 compUnits.push_back(compUnit);
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001395 } else {
1396 // Transfer all the work items from to a simple list of
1397 // of compilation units. (We don't care about the thread
1398 // work-item distribution properties in this path, which
1399 // is okay due to the limited number of shaders, know since
1400 // they are all getting linked together.)
1401 glslang::TWorkItem* workItem;
1402 while (Worklist.remove(workItem)) {
1403 ShaderCompUnit compUnit(FindLanguage(workItem->name));
1404 char* fileText = ReadFileData(workItem->name.c_str());
1405 if (fileText == nullptr)
1406 usage();
1407 compUnit.addString(workItem->name, fileText);
1408 compUnits.push_back(compUnit);
1409 }
John Kessenichc57b2a92016-01-16 15:30:03 -07001410 }
1411
1412 // Actual call to programmatic processing of compile and link,
1413 // in a loop for testing memory and performance. This part contains
1414 // all the perf/memory that a programmatic consumer will care about.
1415 for (int i = 0; i < ((Options & EOptionMemoryLeakMode) ? 100 : 1); ++i) {
1416 for (int j = 0; j < ((Options & EOptionMemoryLeakMode) ? 100 : 1); ++j)
1417 CompileAndLinkShaderUnits(compUnits);
1418
1419 if (Options & EOptionMemoryLeakMode)
1420 glslang::OS_DumpMemoryCounters();
1421 }
1422
John Kessenicha9313662017-06-15 10:40:49 -06001423 // free memory from ReadFileData, which got stored in a const char*
1424 // as the first string above
rdb32084e82016-02-23 22:17:38 +01001425 for (auto it = compUnits.begin(); it != compUnits.end(); ++it)
John Kessenicha9313662017-06-15 10:40:49 -06001426 FreeFileData(const_cast<char*>(it->text[0]));
John Kessenichc57b2a92016-01-16 15:30:03 -07001427}
1428
John Kessenich94f28eb2017-11-13 01:32:06 -07001429int singleMain()
John Kessenicha0af4732012-12-12 21:15:54 +00001430{
Juan Lopeza558b262017-04-02 23:04:00 +02001431 glslang::TWorklist workList;
John Kessenich94f28eb2017-11-13 01:32:06 -07001432 std::for_each(WorkItems.begin(), WorkItems.end(), [&workList](std::unique_ptr<glslang::TWorkItem>& item) {
Juan Lopeza558b262017-04-02 23:04:00 +02001433 assert(item);
1434 workList.add(item.get());
1435 });
John Kessenich2b07c7e2013-07-31 18:44:13 +00001436
John Kessenich23d27752019-07-28 02:12:10 -06001437#ifndef GLSLANG_WEB
John Kessenich05a70632013-09-17 19:26:08 +00001438 if (Options & EOptionDumpConfig) {
Lei Zhang414eb602016-03-04 16:22:34 -05001439 printf("%s", glslang::GetDefaultTBuiltInResourceString().c_str());
Juan Lopeza558b262017-04-02 23:04:00 +02001440 if (workList.empty())
John Kessenich05a70632013-09-17 19:26:08 +00001441 return ESuccess;
1442 }
John Kessenich23d27752019-07-28 02:12:10 -06001443#endif
John Kessenich05a70632013-09-17 19:26:08 +00001444
John Kessenichc6c80a62018-03-05 22:23:17 -07001445 if (Options & EOptionDumpBareVersion) {
Ben Claytonfbe9a232020-06-17 11:17:19 +01001446 printf("%d:%d.%d.%d%s\n", glslang::GetSpirvGeneratorVersion(), GLSLANG_VERSION_MAJOR, GLSLANG_VERSION_MINOR,
1447 GLSLANG_VERSION_PATCH, GLSLANG_VERSION_FLAVOR);
John Kessenichc6c80a62018-03-05 22:23:17 -07001448 if (workList.empty())
1449 return ESuccess;
1450 } else if (Options & EOptionDumpVersions) {
Ben Claytonfbe9a232020-06-17 11:17:19 +01001451 printf("Glslang Version: %d:%d.%d.%d%s\n", glslang::GetSpirvGeneratorVersion(), GLSLANG_VERSION_MAJOR,
1452 GLSLANG_VERSION_MINOR, GLSLANG_VERSION_PATCH, GLSLANG_VERSION_FLAVOR);
John Kessenich319de232013-12-04 04:43:40 +00001453 printf("ESSL Version: %s\n", glslang::GetEsslVersionString());
1454 printf("GLSL Version: %s\n", glslang::GetGlslVersionString());
John Kessenich68d78fd2015-07-12 19:28:10 -06001455 std::string spirvVersion;
1456 glslang::GetSpirvVersion(spirvVersion);
John Kessenich0da9eaa2015-08-01 17:10:02 -06001457 printf("SPIR-V Version %s\n", spirvVersion.c_str());
John Kessenich5e4b1242015-08-06 22:53:06 -06001458 printf("GLSL.std.450 Version %d, Revision %d\n", GLSLstd450Version, GLSLstd450Revision);
John Kessenich55e7d112015-11-15 21:33:39 -07001459 printf("Khronos Tool ID %d\n", glslang::GetKhronosToolId());
John Kessenicha372a3e2017-11-02 22:32:14 -06001460 printf("SPIR-V Generator Version %d\n", glslang::GetSpirvGeneratorVersion());
John Kessenichb84313d2016-07-20 16:03:29 -06001461 printf("GL_KHR_vulkan_glsl version %d\n", 100);
1462 printf("ARB_GL_gl_spirv version %d\n", 100);
Juan Lopeza558b262017-04-02 23:04:00 +02001463 if (workList.empty())
John Kessenich319de232013-12-04 04:43:40 +00001464 return ESuccess;
1465 }
1466
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001467 if (workList.empty() && ((Options & EOptionStdin) == 0)) {
John Kessenich05a70632013-09-17 19:26:08 +00001468 usage();
John Kessenich05a70632013-09-17 19:26:08 +00001469 }
1470
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001471 if (Options & EOptionStdin) {
John Kessenich94f28eb2017-11-13 01:32:06 -07001472 WorkItems.push_back(std::unique_ptr<glslang::TWorkItem>{new glslang::TWorkItem("stdin")});
1473 workList.add(WorkItems.back().get());
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001474 }
1475
John Kessenich05a70632013-09-17 19:26:08 +00001476 ProcessConfigFile();
1477
John Kessenich086febc2018-10-25 12:43:02 -06001478 if ((Options & EOptionReadHlsl) && !((Options & EOptionOutputPreprocessed) || (Options & EOptionSpv)))
John Kessenichbd97b6f2019-12-20 10:33:13 -07001479 Error("HLSL requires SPIR-V code generation (or preprocessing only)");
John Kessenich086febc2018-10-25 12:43:02 -06001480
John Kessenich69f4b512013-09-04 21:19:27 +00001481 //
1482 // Two modes:
John Kessenich38f3b892013-09-06 19:52:57 +00001483 // 1) linking all arguments together, single-threaded, new C++ interface
1484 // 2) independent arguments, can be tackled by multiple asynchronous threads, for testing thread safety, using the old handle interface
John Kessenich69f4b512013-09-04 21:19:27 +00001485 //
John Kessenich086febc2018-10-25 12:43:02 -06001486 if (Options & (EOptionLinkProgram | EOptionOutputPreprocessed)) {
John Kessenichc36e1d82013-11-01 17:41:52 +00001487 glslang::InitializeProcess();
John Kesseniche2c15b42017-11-16 22:48:41 -07001488 glslang::InitializeProcess(); // also test reference counting of users
1489 glslang::InitializeProcess(); // also test reference counting of users
1490 glslang::FinalizeProcess(); // also test reference counting of users
1491 glslang::FinalizeProcess(); // also test reference counting of users
Juan Lopeza558b262017-04-02 23:04:00 +02001492 CompileAndLinkShaderFiles(workList);
John Kessenichc36e1d82013-11-01 17:41:52 +00001493 glslang::FinalizeProcess();
1494 } else {
1495 ShInitialize();
John Kesseniche2c15b42017-11-16 22:48:41 -07001496 ShInitialize(); // also test reference counting of users
1497 ShFinalize(); // also test reference counting of users
John Kessenichc36e1d82013-11-01 17:41:52 +00001498
Juan Lopeza558b262017-04-02 23:04:00 +02001499 bool printShaderNames = workList.size() > 1;
John Kessenich69f4b512013-09-04 21:19:27 +00001500
John Kesseniche2c15b42017-11-16 22:48:41 -07001501 if (Options & EOptionMultiThreaded) {
Juan Lopeza558b262017-04-02 23:04:00 +02001502 std::array<std::thread, 16> threads;
John Kesseniche2c15b42017-11-16 22:48:41 -07001503 for (unsigned int t = 0; t < threads.size(); ++t) {
Juan Lopeza558b262017-04-02 23:04:00 +02001504 threads[t] = std::thread(CompileShaders, std::ref(workList));
John Kesseniche2c15b42017-11-16 22:48:41 -07001505 if (threads[t].get_id() == std::thread::id()) {
John Kessenichaf527992017-11-02 22:48:15 -06001506 fprintf(stderr, "Failed to create thread\n");
John Kessenich38f3b892013-09-06 19:52:57 +00001507 return EFailThreadCreate;
1508 }
John Kessenicha0af4732012-12-12 21:15:54 +00001509 }
Juan Lopeza558b262017-04-02 23:04:00 +02001510
1511 std::for_each(threads.begin(), threads.end(), [](std::thread& t) { t.join(); });
John Kessenichc999ba22013-11-07 23:33:24 +00001512 } else
Juan Lopeza558b262017-04-02 23:04:00 +02001513 CompileShaders(workList);
John Kessenich38f3b892013-09-06 19:52:57 +00001514
1515 // Print out all the resulting infologs
John Kessenich94f28eb2017-11-13 01:32:06 -07001516 for (size_t w = 0; w < WorkItems.size(); ++w) {
1517 if (WorkItems[w]) {
1518 if (printShaderNames || WorkItems[w]->results.size() > 0)
1519 PutsIfNonEmpty(WorkItems[w]->name.c_str());
1520 PutsIfNonEmpty(WorkItems[w]->results.c_str());
John Kessenich38f3b892013-09-06 19:52:57 +00001521 }
1522 }
John Kessenichc36e1d82013-11-01 17:41:52 +00001523
1524 ShFinalize();
John Kessenicha0af4732012-12-12 21:15:54 +00001525 }
John Kessenich2b07c7e2013-07-31 18:44:13 +00001526
John Kessenichc999ba22013-11-07 23:33:24 +00001527 if (CompileFailed)
John Kessenicha0af4732012-12-12 21:15:54 +00001528 return EFailCompile;
John Kessenichc999ba22013-11-07 23:33:24 +00001529 if (LinkFailed)
John Kessenicha0af4732012-12-12 21:15:54 +00001530 return EFailLink;
1531
1532 return 0;
1533}
1534
John Kessenich94f28eb2017-11-13 01:32:06 -07001535int C_DECL main(int argc, char* argv[])
1536{
1537 ProcessArguments(WorkItems, argc, argv);
1538
1539 int ret = 0;
1540
1541 // Loop over the entire init/finalize cycle to watch memory changes
1542 const int iterations = 1;
1543 if (iterations > 1)
1544 glslang::OS_DumpMemoryCounters();
1545 for (int i = 0; i < iterations; ++i) {
1546 ret = singleMain();
1547 if (iterations > 1)
1548 glslang::OS_DumpMemoryCounters();
1549 }
1550
1551 return ret;
1552}
1553
John Kessenicha0af4732012-12-12 21:15:54 +00001554//
1555// Deduce the language from the filename. Files must end in one of the
1556// following extensions:
1557//
John Kessenich2b07c7e2013-07-31 18:44:13 +00001558// .vert = vertex
1559// .tesc = tessellation control
1560// .tese = tessellation evaluation
1561// .geom = geometry
1562// .frag = fragment
John Kessenich94a81fb2013-08-31 02:41:30 +00001563// .comp = compute
Chao Chenb50c02e2018-09-19 11:42:24 -07001564// .rgen = ray generation
1565// .rint = ray intersection
1566// .rahit = ray any hit
1567// .rchit = ray closest hit
1568// .rmiss = ray miss
1569// .rcall = ray callable
Sahil Parmar035cbbe2018-10-04 16:39:18 -07001570// .mesh = mesh
1571// .task = task
Grigory Dzhavadyan33507412018-04-12 14:35:24 -07001572// Additionally, the file names may end in .<stage>.glsl and .<stage>.hlsl
1573// where <stage> is one of the stages listed above.
1574//
1575EShLanguage FindLanguage(const std::string& name, bool parseStageName)
John Kessenicha0af4732012-12-12 21:15:54 +00001576{
John Kessenichfccbb8b2018-04-17 17:24:03 -06001577 std::string stageName;
Dan Bakerc6ede892016-08-11 14:06:06 -04001578 if (shaderStageName)
John Kessenichfccbb8b2018-04-17 17:24:03 -06001579 stageName = shaderStageName;
1580 else if (parseStageName) {
Grigory Dzhavadyan33507412018-04-12 14:35:24 -07001581 // Note: "first" extension means "first from the end", i.e.
1582 // if the file is named foo.vert.glsl, then "glsl" is first,
1583 // "vert" is second.
John Kessenichfccbb8b2018-04-17 17:24:03 -06001584 size_t firstExtStart = name.find_last_of(".");
1585 bool hasFirstExt = firstExtStart != std::string::npos;
1586 size_t secondExtStart = hasFirstExt ? name.find_last_of(".", firstExtStart - 1) : std::string::npos;
1587 bool hasSecondExt = secondExtStart != std::string::npos;
1588 std::string firstExt = name.substr(firstExtStart + 1, std::string::npos);
1589 bool usesUnifiedExt = hasFirstExt && (firstExt == "glsl" || firstExt == "hlsl");
John Kessenich3beac942018-04-17 21:02:19 -06001590 if (usesUnifiedExt && firstExt == "hlsl")
1591 Options |= EOptionReadHlsl;
1592 if (hasFirstExt && !usesUnifiedExt)
John Kessenichfccbb8b2018-04-17 17:24:03 -06001593 stageName = firstExt;
John Kessenich3beac942018-04-17 21:02:19 -06001594 else if (usesUnifiedExt && hasSecondExt)
John Kessenichfccbb8b2018-04-17 17:24:03 -06001595 stageName = name.substr(secondExtStart + 1, firstExtStart - secondExtStart - 1);
John Kessenich3beac942018-04-17 21:02:19 -06001596 else {
Grigory Dzhavadyan33507412018-04-12 14:35:24 -07001597 usage();
1598 return EShLangVertex;
John Kesseniche751bca2017-03-16 11:20:38 -06001599 }
John Kessenichfccbb8b2018-04-17 17:24:03 -06001600 } else
1601 stageName = name;
dankbaker45d49bc2016-08-08 21:43:07 -04001602
John Kessenichfccbb8b2018-04-17 17:24:03 -06001603 if (stageName == "vert")
John Kessenich2b07c7e2013-07-31 18:44:13 +00001604 return EShLangVertex;
John Kessenichfccbb8b2018-04-17 17:24:03 -06001605 else if (stageName == "tesc")
John Kessenich2b07c7e2013-07-31 18:44:13 +00001606 return EShLangTessControl;
John Kessenichfccbb8b2018-04-17 17:24:03 -06001607 else if (stageName == "tese")
John Kessenich2b07c7e2013-07-31 18:44:13 +00001608 return EShLangTessEvaluation;
John Kessenichfccbb8b2018-04-17 17:24:03 -06001609 else if (stageName == "geom")
John Kessenich2b07c7e2013-07-31 18:44:13 +00001610 return EShLangGeometry;
John Kessenichfccbb8b2018-04-17 17:24:03 -06001611 else if (stageName == "frag")
John Kessenich2b07c7e2013-07-31 18:44:13 +00001612 return EShLangFragment;
John Kessenichfccbb8b2018-04-17 17:24:03 -06001613 else if (stageName == "comp")
John Kessenichc0275792013-08-09 17:14:49 +00001614 return EShLangCompute;
Chao Chenb50c02e2018-09-19 11:42:24 -07001615 else if (stageName == "rgen")
Daniel Kochdb32b242020-03-17 20:42:47 -04001616 return EShLangRayGen;
Chao Chenb50c02e2018-09-19 11:42:24 -07001617 else if (stageName == "rint")
Daniel Kochdb32b242020-03-17 20:42:47 -04001618 return EShLangIntersect;
Chao Chenb50c02e2018-09-19 11:42:24 -07001619 else if (stageName == "rahit")
Daniel Kochdb32b242020-03-17 20:42:47 -04001620 return EShLangAnyHit;
Chao Chenb50c02e2018-09-19 11:42:24 -07001621 else if (stageName == "rchit")
Daniel Kochdb32b242020-03-17 20:42:47 -04001622 return EShLangClosestHit;
Chao Chenb50c02e2018-09-19 11:42:24 -07001623 else if (stageName == "rmiss")
Daniel Kochdb32b242020-03-17 20:42:47 -04001624 return EShLangMiss;
Chao Chenb50c02e2018-09-19 11:42:24 -07001625 else if (stageName == "rcall")
Daniel Kochdb32b242020-03-17 20:42:47 -04001626 return EShLangCallable;
Chao Chen3c366992018-09-19 11:41:59 -07001627 else if (stageName == "mesh")
1628 return EShLangMeshNV;
1629 else if (stageName == "task")
1630 return EShLangTaskNV;
John Kessenich2b07c7e2013-07-31 18:44:13 +00001631
1632 usage();
John Kesseniche95ecc52012-12-12 21:34:14 +00001633 return EShLangVertex;
John Kessenicha0af4732012-12-12 21:15:54 +00001634}
1635
John Kessenicha0af4732012-12-12 21:15:54 +00001636//
John Kessenichecba76f2017-01-06 00:34:48 -07001637// Read a file's data into a string, and compile it using the old interface ShCompile,
John Kessenich69f4b512013-09-04 21:19:27 +00001638// for non-linkable results.
John Kessenicha0af4732012-12-12 21:15:54 +00001639//
John Kessenich51cdd902014-02-18 23:37:57 +00001640void CompileFile(const char* fileName, ShHandle compiler)
John Kessenicha0af4732012-12-12 21:15:54 +00001641{
John Kessenichca3457f2015-05-18 01:59:45 +00001642 int ret = 0;
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001643 char* shaderString;
1644 if ((Options & EOptionStdin) != 0) {
1645 std::istreambuf_iterator<char> begin(std::cin), end;
1646 std::string tempString(begin, end);
1647 shaderString = strdup(tempString.c_str());
1648 } else {
1649 shaderString = ReadFileData(fileName);
1650 }
John Kessenich41cf6b52013-06-25 18:10:05 +00001651
1652 // move to length-based strings, rather than null-terminated strings
John Kessenich04acb1b2017-06-14 17:36:50 -06001653 int* lengths = new int[1];
1654 lengths[0] = (int)strlen(shaderString);
John Kessenicha0af4732012-12-12 21:15:54 +00001655
John Kessenich52ac67e2013-05-05 23:46:22 +00001656 EShMessages messages = EShMsgDefault;
John Kessenichb0a7eb52013-11-07 17:44:20 +00001657 SetMessageOptions(messages);
John Kessenichecba76f2017-01-06 00:34:48 -07001658
John Kessenicha9313662017-06-15 10:40:49 -06001659 if (UserPreamble.isSet())
1660 Error("-D and -U options require -l (linking)\n");
1661
John Kessenich94a81fb2013-08-31 02:41:30 +00001662 for (int i = 0; i < ((Options & EOptionMemoryLeakMode) ? 100 : 1); ++i) {
1663 for (int j = 0; j < ((Options & EOptionMemoryLeakMode) ? 100 : 1); ++j) {
John Kessenich927608b2017-01-06 12:34:14 -07001664 // ret = ShCompile(compiler, shaderStrings, NumShaderStrings, lengths, EShOptNone, &Resources, Options, (Options & EOptionDefaultDesktop) ? 110 : 100, false, messages);
John Kessenich04acb1b2017-06-14 17:36:50 -06001665 ret = ShCompile(compiler, &shaderString, 1, nullptr, EShOptNone, &Resources, Options, (Options & EOptionDefaultDesktop) ? 110 : 100, false, messages);
John Kessenich927608b2017-01-06 12:34:14 -07001666 // const char* multi[12] = { "# ve", "rsion", " 300 e", "s", "\n#err",
John Kessenichecba76f2017-01-06 00:34:48 -07001667 // "or should be l", "ine 1", "string 5\n", "float glo", "bal",
John Kessenichea869fb2013-10-28 18:12:06 +00001668 // ";\n#error should be line 2\n void main() {", "global = 2.3;}" };
John Kessenich927608b2017-01-06 12:34:14 -07001669 // const char* multi[7] = { "/", "/", "\\", "\n", "\n", "#", "version 300 es" };
1670 // ret = ShCompile(compiler, multi, 7, nullptr, EShOptNone, &Resources, Options, (Options & EOptionDefaultDesktop) ? 110 : 100, false, messages);
John Kessenich41cf6b52013-06-25 18:10:05 +00001671 }
John Kessenicha0af4732012-12-12 21:15:54 +00001672
John Kessenich94a81fb2013-08-31 02:41:30 +00001673 if (Options & EOptionMemoryLeakMode)
John Kessenich2b07c7e2013-07-31 18:44:13 +00001674 glslang::OS_DumpMemoryCounters();
John Kessenicha0af4732012-12-12 21:15:54 +00001675 }
John Kessenicha0af4732012-12-12 21:15:54 +00001676
John Kessenich41cf6b52013-06-25 18:10:05 +00001677 delete [] lengths;
John Kessenich04acb1b2017-06-14 17:36:50 -06001678 FreeFileData(shaderString);
John Kessenicha0af4732012-12-12 21:15:54 +00001679
John Kessenichc999ba22013-11-07 23:33:24 +00001680 if (ret == 0)
1681 CompileFailed = true;
John Kessenicha0af4732012-12-12 21:15:54 +00001682}
1683
John Kessenicha0af4732012-12-12 21:15:54 +00001684//
1685// print usage to stdout
1686//
1687void usage()
1688{
John Kessenich319de232013-12-04 04:43:40 +00001689 printf("Usage: glslangValidator [option]... [file]...\n"
1690 "\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001691 "'file' can end in .<stage> for auto-stage classification, where <stage> is:\n"
1692 " .conf to provide a config file that replaces the default configuration\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001693 " (see -c option below for generating a template)\n"
1694 " .vert for a vertex shader\n"
1695 " .tesc for a tessellation control shader\n"
1696 " .tese for a tessellation evaluation shader\n"
1697 " .geom for a geometry shader\n"
1698 " .frag for a fragment shader\n"
1699 " .comp for a compute shader\n"
Chao Chen3c366992018-09-19 11:41:59 -07001700 " .mesh for a mesh shader\n"
1701 " .task for a task shader\n"
Chao Chenb50c02e2018-09-19 11:42:24 -07001702 " .rgen for a ray generation shader\n"
1703 " .rint for a ray intersection shader\n"
1704 " .rahit for a ray any hit shader\n"
1705 " .rchit for a ray closest hit shader\n"
1706 " .rmiss for a ray miss shader\n"
Sahil Parmar035cbbe2018-10-04 16:39:18 -07001707 " .rcall for a ray callable shader\n"
John Kessenich2ead40f2018-04-17 17:44:11 -06001708 " .glsl for .vert.glsl, .tesc.glsl, ..., .comp.glsl compound suffixes\n"
1709 " .hlsl for .vert.hlsl, .tesc.hlsl, ..., .comp.hlsl compound suffixes\n"
John Kessenich319de232013-12-04 04:43:40 +00001710 "\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001711 "Options:\n"
1712 " -C cascading errors; risk crash from accumulation of error recoveries\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001713 " -D input is HLSL (this is the default when any suffix is .hlsl)\n"
John Kessenich6f988922020-01-07 07:03:11 -07001714 " -D<name[=def]> | --define-macro <name[=def]> | --D <name[=def]>\n"
1715 " define a pre-processor macro\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001716 " -E print pre-processed GLSL; cannot be used with -l;\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001717 " errors will appear on stderr\n"
John Kessenich6353d552017-06-23 11:11:09 -06001718 " -G[ver] create SPIR-V binary, under OpenGL semantics; turns on -l;\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001719 " default file name is <stage>.spv (-o overrides this);\n"
John Kessenich6353d552017-06-23 11:11:09 -06001720 " 'ver', when present, is the version of the input semantics,\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001721 " which will appear in #define GL_SPIRV ver;\n"
1722 " '--client opengl100' is the same as -G100;\n"
Jeremy Hayesb73afa82021-01-05 15:54:41 -07001723 " a '--target-env' for OpenGL will also imply '-G';\n"
1724 " currently only supports GLSL\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001725 " -H print human readable form of SPIR-V; turns on -V\n"
John Kessenich971a0a82017-06-07 15:06:58 -06001726 " -I<dir> add dir to the include search path; includer's directory\n"
1727 " is searched first, followed by left-to-right order of -I\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001728 " -Od disables optimization; may cause illegal SPIR-V for HLSL\n"
1729 " -Os optimizes SPIR-V to minimize size\n"
greg-lunarg4e064ee2021-03-15 11:26:11 -06001730 " -R use relaxed verification rules for generating Vulkan SPIR-V,\n"
1731 " allowing the use of default uniforms, atomic_uints, and\n"
1732 " gl_VertexID and gl_InstanceID keywords.\n"
John Kesseniche751bca2017-03-16 11:20:38 -06001733 " -S <stage> uses specified stage rather than parsing the file extension\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001734 " choices for <stage> are vert, tesc, tese, geom, frag, or comp\n"
John Kessenich6f988922020-01-07 07:03:11 -07001735 " -U<name> | --undef-macro <name> | --U <name>\n"
1736 " undefine a pre-processor macro\n"
John Kessenich6353d552017-06-23 11:11:09 -06001737 " -V[ver] create SPIR-V binary, under Vulkan semantics; turns on -l;\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001738 " default file name is <stage>.spv (-o overrides this)\n"
John Kessenich6353d552017-06-23 11:11:09 -06001739 " 'ver', when present, is the version of the input semantics,\n"
1740 " which will appear in #define VULKAN ver\n"
1741 " '--client vulkan100' is the same as -V100\n"
1742 " a '--target-env' for Vulkan will also imply '-V'\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001743 " -c configuration dump;\n"
1744 " creates the default configuration file (redirect to a .conf file)\n"
1745 " -d default to desktop (#version 110) when there is no shader #version\n"
1746 " (default is ES version 100)\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001747 " -e <name> | --entry-point <name>\n"
1748 " specify <name> as the entry-point function name\n"
John Kessenich5d610ee2018-03-07 18:05:55 -07001749 " -f{hlsl_functionality1}\n"
1750 " 'hlsl_functionality1' enables use of the\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001751 " SPV_GOOGLE_hlsl_functionality1 extension\n"
John Kessenich121853f2017-05-31 17:11:16 -06001752 " -g generate debug information\n"
Shahbaz Youssefid52dce52020-06-17 12:47:44 -04001753 " -g0 strip debug information\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001754 " -h print this usage message\n"
1755 " -i intermediate tree (glslang AST) is printed out\n"
1756 " -l link all input files together to form a single module\n"
1757 " -m memory leak mode\n"
John Kessenicha25530c2017-09-11 20:13:49 -06001758 " -o <file> save binary to <file>, requires a binary option (e.g., -V)\n"
John Kesseniche5c394b2019-07-02 09:32:48 -06001759 " -q dump reflection query database; requires -l for linking\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001760 " -r | --relaxed-errors"
1761 " relaxed GLSL semantic error-checking mode\n"
John Kessenichb63f4a32017-11-16 22:32:20 -07001762 " -s silence syntax and semantic error reporting\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001763 " -t multi-threaded mode\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001764 " -v | --version\n"
1765 " print version strings\n"
1766 " -w | --suppress-warnings\n"
1767 " suppress GLSL warnings, except as required by \"#extension : warn\"\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001768 " -x save binary output as text-based 32-bit hexadecimal numbers\n"
Neil Roberts16f53472018-03-20 17:30:53 +01001769 " -u<name>:<loc> specify a uniform location override for --aml\n"
Neil Robertsb0f3d792018-03-20 17:41:05 +01001770 " --uniform-base <base> set a base to use for generated uniform locations\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001771 " --auto-map-bindings | --amb automatically bind uniform variables\n"
1772 " without explicit bindings\n"
1773 " --auto-map-locations | --aml automatically locate input/output lacking\n"
1774 " 'location' (fragile, not cross stage)\n"
1775 " --client {vulkan<ver>|opengl<ver>} see -V and -G\n"
Christoph Kubisch412ff6e2019-04-13 22:57:33 +02001776 " --dump-builtin-symbols prints builtin symbol table prior each compile\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001777 " -dumpfullversion | -dumpversion print bare major.minor.patchlevel\n"
1778 " --flatten-uniform-arrays | --fua flatten uniform texture/sampler arrays to\n"
1779 " scalars\n"
1780 " --hlsl-offsets allow block offsets to follow HLSL rules\n"
1781 " works independently of source language\n"
1782 " --hlsl-iomap perform IO mapping in HLSL register space\n"
1783 " --hlsl-enable-16bit-types allow 16-bit types in SPIR-V for HLSL\n"
John Kessenich605afc72019-06-17 23:33:09 -06001784 " --hlsl-dx9-compatible interprets sampler declarations as a\n"
rdbb56e0e42020-06-02 08:30:50 +02001785 " texture/sampler combo like DirectX9 would,\n"
1786 " and recognizes DirectX9-specific semantics\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001787 " --invert-y | --iy invert position.Y output in vertex shader\n"
1788 " --keep-uncalled | --ku don't eliminate uncalled functions\n"
John Kessenich605afc72019-06-17 23:33:09 -06001789 " --nan-clamp favor non-NaN operand in min, max, and clamp\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001790 " --no-storage-format | --nsf use Unknown image format\n"
Marcin Åšlusarz245c30c2020-07-03 14:55:29 +02001791 " --quiet do not print anything to stdout, unless\n"
1792 " requested by another option\n"
baldurk4513df92019-02-08 10:48:48 +00001793 " --reflect-strict-array-suffix use strict array suffix rules when\n"
1794 " reflecting\n"
baldurkedf82122019-01-29 15:49:00 +00001795 " --reflect-basic-array-suffix arrays of basic types will have trailing [0]\n"
baldurk4513df92019-02-08 10:48:48 +00001796 " --reflect-intermediate-io reflection includes inputs/outputs of linked\n"
1797 " shaders rather than just vertex/fragment\n"
1798 " --reflect-separate-buffers reflect buffer variables and blocks\n"
1799 " separately to uniforms\n"
1800 " --reflect-all-block-variables reflect all variables in blocks, whether\n"
1801 " inactive or active\n"
baldurk19050692019-02-11 11:50:24 +00001802 " --reflect-unwrap-io-blocks unwrap input/output blocks the same as\n"
1803 " uniform blocks\n"
LoopDawg52017192017-07-14 15:15:47 -06001804 " --resource-set-binding [stage] name set binding\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001805 " set descriptor set and binding for\n"
1806 " individual resources\n"
LoopDawg52017192017-07-14 15:15:47 -06001807 " --resource-set-binding [stage] set\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001808 " set descriptor set for all resources\n"
1809 " --rsb synonym for --resource-set-binding\n"
greg-lunarg4e064ee2021-03-15 11:26:11 -06001810 " --set-block-backing name {uniform|buffer|push_constant}\n"
1811 " changes the backing type of a uniform, buffer,\n"
1812 " or push_constant block declared in\n"
1813 " in the program, when using -R option.\n"
1814 " This can be used to change the backing\n"
1815 " for existing blocks as well as implicit ones\n"
1816 " such as 'gl_DefaultUniformBlock'.\n"
1817 " --sbs synonym for set-block-storage\n"
1818 " --set-atomic-counter-block name set\n"
1819 " set name, and descriptor set for\n"
1820 " atomic counter blocks, with -R opt\n"
1821 " --sacb synonym for set-atomic-counter-block\n"
1822 " --set-default-uniform-block name set binding\n"
1823 " set name, descriptor set, and binding for\n"
1824 " global default-uniform-block, with -R opt\n"
1825 " --sdub synonym for set-default-uniform-block\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001826 " --shift-image-binding [stage] num\n"
1827 " base binding number for images (uav)\n"
1828 " --shift-image-binding [stage] [num set]...\n"
1829 " per-descriptor-set shift values\n"
1830 " --sib synonym for --shift-image-binding\n"
1831 " --shift-sampler-binding [stage] num\n"
1832 " base binding number for samplers\n"
1833 " --shift-sampler-binding [stage] [num set]...\n"
1834 " per-descriptor-set shift values\n"
1835 " --ssb synonym for --shift-sampler-binding\n"
1836 " --shift-ssbo-binding [stage] num base binding number for SSBOs\n"
1837 " --shift-ssbo-binding [stage] [num set]...\n"
1838 " per-descriptor-set shift values\n"
1839 " --sbb synonym for --shift-ssbo-binding\n"
1840 " --shift-texture-binding [stage] num\n"
1841 " base binding number for textures\n"
1842 " --shift-texture-binding [stage] [num set]...\n"
1843 " per-descriptor-set shift values\n"
1844 " --stb synonym for --shift-texture-binding\n"
1845 " --shift-uav-binding [stage] num base binding number for UAVs\n"
1846 " --shift-uav-binding [stage] [num set]...\n"
1847 " per-descriptor-set shift values\n"
1848 " --suavb synonym for --shift-uav-binding\n"
1849 " --shift-UBO-binding [stage] num base binding number for UBOs\n"
1850 " --shift-UBO-binding [stage] [num set]...\n"
1851 " per-descriptor-set shift values\n"
1852 " --sub synonym for --shift-UBO-binding\n"
1853 " --shift-cbuffer-binding | --scb synonyms for --shift-UBO-binding\n"
1854 " --spirv-dis output standard-form disassembly; works only\n"
1855 " when a SPIR-V generation option is also used\n"
John Kessenichc3404252018-08-23 15:29:08 -06001856 " --spirv-val execute the SPIRV-Tools validator\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001857 " --source-entrypoint <name> the given shader source function is\n"
1858 " renamed to be the <name> given in -e\n"
1859 " --sep synonym for --source-entrypoint\n"
1860 " --stdin read from stdin instead of from a file;\n"
1861 " requires providing the shader stage using -S\n"
John Kessenich273d3a52020-01-15 00:10:41 -07001862 " --target-env {vulkan1.0 | vulkan1.1 | vulkan1.2 | opengl | \n"
John Kessenich8317e6c2019-08-18 23:58:08 -06001863 " spirv1.0 | spirv1.1 | spirv1.2 | spirv1.3 | spirv1.4 | spirv1.5}\n"
John Kessenich273d3a52020-01-15 00:10:41 -07001864 " Set the execution environment that the\n"
1865 " generated code will be executed in.\n"
1866 " Defaults to:\n"
1867 " * vulkan1.0 under --client vulkan<ver>\n"
1868 " * opengl under --client opengl<ver>\n"
1869 " * spirv1.0 under --target-env vulkan1.0\n"
1870 " * spirv1.3 under --target-env vulkan1.1\n"
1871 " * spirv1.5 under --target-env vulkan1.2\n"
1872 " Multiple --target-env can be specified.\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001873 " --variable-name <name>\n"
1874 " --vn <name> creates a C header file that contains a\n"
1875 " uint32_t array named <name>\n"
1876 " initialized with the shader binary code\n"
John Kessenichb0a7eb52013-11-07 17:44:20 +00001877 );
John Kessenich68d78fd2015-07-12 19:28:10 -06001878
1879 exit(EFailUsage);
John Kessenicha0af4732012-12-12 21:15:54 +00001880}
1881
John Kessenich3ce4e592014-10-06 19:57:34 +00001882#if !defined _MSC_VER && !defined MINGW_HAS_SECURE_API
John Kessenichcfd643e2013-03-08 23:14:42 +00001883
1884#include <errno.h>
1885
1886int fopen_s(
1887 FILE** pFile,
John Kessenich51cdd902014-02-18 23:37:57 +00001888 const char* filename,
1889 const char* mode
John Kessenichcfd643e2013-03-08 23:14:42 +00001890)
1891{
1892 if (!pFile || !filename || !mode) {
1893 return EINVAL;
1894 }
1895
1896 FILE* f = fopen(filename, mode);
1897 if (! f) {
1898 if (errno != 0) {
1899 return errno;
1900 } else {
1901 return ENOENT;
1902 }
1903 }
1904 *pFile = f;
1905
1906 return 0;
1907}
1908
1909#endif
1910
John Kessenicha0af4732012-12-12 21:15:54 +00001911//
1912// Malloc a string of sufficient size and read a string into it.
1913//
John Kessenich04acb1b2017-06-14 17:36:50 -06001914char* ReadFileData(const char* fileName)
John Kessenicha0af4732012-12-12 21:15:54 +00001915{
John Kessenichb3297152015-07-11 18:01:03 -06001916 FILE *in = nullptr;
John Kessenich3ce4e592014-10-06 19:57:34 +00001917 int errorCode = fopen_s(&in, fileName, "r");
John Kessenich68d78fd2015-07-12 19:28:10 -06001918 if (errorCode || in == nullptr)
1919 Error("unable to open input file");
John Kessenichecba76f2017-01-06 00:34:48 -07001920
John Kessenich04acb1b2017-06-14 17:36:50 -06001921 int count = 0;
John Kessenicha0af4732012-12-12 21:15:54 +00001922 while (fgetc(in) != EOF)
1923 count++;
1924
John Kessenichd6c72a42014-08-18 19:42:35 +00001925 fseek(in, 0, SEEK_SET);
John Kessenichca3457f2015-05-18 01:59:45 +00001926
John Kessenich04acb1b2017-06-14 17:36:50 -06001927 char* return_data = (char*)malloc(count + 1); // freed in FreeFileData()
1928 if ((int)fread(return_data, 1, count, in) != count) {
1929 free(return_data);
John Kessenich68d78fd2015-07-12 19:28:10 -06001930 Error("can't read input file");
John Kessenicha0af4732012-12-12 21:15:54 +00001931 }
John Kessenich68d78fd2015-07-12 19:28:10 -06001932
John Kessenich04acb1b2017-06-14 17:36:50 -06001933 return_data[count] = '\0';
John Kessenicha0af4732012-12-12 21:15:54 +00001934 fclose(in);
John Kessenichb3297152015-07-11 18:01:03 -06001935
John Kessenicha0af4732012-12-12 21:15:54 +00001936 return return_data;
1937}
1938
John Kessenich04acb1b2017-06-14 17:36:50 -06001939void FreeFileData(char* data)
John Kessenicha0af4732012-12-12 21:15:54 +00001940{
John Kessenichb3297152015-07-11 18:01:03 -06001941 free(data);
John Kessenicha0af4732012-12-12 21:15:54 +00001942}
1943
John Kessenich54d8cda2013-02-11 22:36:01 +00001944void InfoLogMsg(const char* msg, const char* name, const int num)
John Kessenicha0af4732012-12-12 21:15:54 +00001945{
John Kessenichfae38ee2015-06-10 23:23:12 +00001946 if (num >= 0 )
1947 printf("#### %s %s %d INFO LOG ####\n", msg, name, num);
1948 else
1949 printf("#### %s %s INFO LOG ####\n", msg, name);
John Kessenicha0af4732012-12-12 21:15:54 +00001950}