blob: ab8d904d0349fe0c5450250214ebec51307ad3e7 [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"
John Kessenich0da9eaa2015-08-01 17:10:02 -060047#include "./../glslang/Include/revision.h"
John Kessenicha0af4732012-12-12 21:15:54 +000048#include "./../glslang/Public/ShaderLang.h"
John Kessenich0df0cde2015-03-03 17:09:43 +000049#include "../SPIRV/GlslangToSpv.h"
John Kessenich5e4b1242015-08-06 22:53:06 -060050#include "../SPIRV/GLSL.std.450.h"
John Kessenichacba7722015-03-04 03:48:38 +000051#include "../SPIRV/doc.h"
52#include "../SPIRV/disassemble.h"
John Kessenich3494b4d2017-05-22 15:00:42 -060053
John Kessenich66ec80e2016-08-05 14:04:23 -060054#include <cstring>
55#include <cstdlib>
steve-lunarg7f7c2ed2016-09-07 15:20:19 -060056#include <cctype>
John Kessenich66ec80e2016-08-05 14:04:23 -060057#include <cmath>
steve-lunarg7f7c2ed2016-09-07 15:20:19 -060058#include <array>
LoopDawg08a14422017-10-17 19:27:14 -060059#include <map>
Juan Lopeza558b262017-04-02 23:04:00 +020060#include <memory>
61#include <thread>
John Kessenicha0af4732012-12-12 21:15:54 +000062
baldurk876a0e32015-11-16 18:03:28 +010063#include "../glslang/OSDependent/osinclude.h"
John Kessenicha0af4732012-12-12 21:15:54 +000064
65extern "C" {
66 SH_IMPORT_EXPORT void ShOutputHtml();
67}
68
John Kessenich94a81fb2013-08-31 02:41:30 +000069// Command-line options
70enum TOptions {
John Kessenich906cc212016-12-09 19:22:20 -070071 EOptionNone = 0,
72 EOptionIntermediate = (1 << 0),
73 EOptionSuppressInfolog = (1 << 1),
74 EOptionMemoryLeakMode = (1 << 2),
75 EOptionRelaxedErrors = (1 << 3),
76 EOptionGiveWarnings = (1 << 4),
77 EOptionLinkProgram = (1 << 5),
78 EOptionMultiThreaded = (1 << 6),
79 EOptionDumpConfig = (1 << 7),
80 EOptionDumpReflection = (1 << 8),
81 EOptionSuppressWarnings = (1 << 9),
82 EOptionDumpVersions = (1 << 10),
83 EOptionSpv = (1 << 11),
84 EOptionHumanReadableSpv = (1 << 12),
85 EOptionVulkanRules = (1 << 13),
86 EOptionDefaultDesktop = (1 << 14),
87 EOptionOutputPreprocessed = (1 << 15),
88 EOptionOutputHexadecimal = (1 << 16),
89 EOptionReadHlsl = (1 << 17),
90 EOptionCascadingErrors = (1 << 18),
91 EOptionAutoMapBindings = (1 << 19),
steve-lunarge0b9deb2016-09-16 13:26:37 -060092 EOptionFlattenUniformArrays = (1 << 20),
John Kessenich906cc212016-12-09 19:22:20 -070093 EOptionNoStorageFormat = (1 << 21),
John Kessenich20f01e72016-12-12 11:41:43 -070094 EOptionKeepUncalled = (1 << 22),
John Kessenich4f1403e2017-04-05 17:38:20 -060095 EOptionHlslOffsets = (1 << 23),
steve-lunargbe283552017-04-18 12:18:01 -060096 EOptionHlslIoMapping = (1 << 24),
John Kessenich71facdf2017-05-17 18:28:19 -060097 EOptionAutoMapLocations = (1 << 25),
John Kessenich121853f2017-05-31 17:11:16 -060098 EOptionDebug = (1 << 26),
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +020099 EOptionStdin = (1 << 27),
GregFcd1f1692017-09-21 18:40:22 -0600100 EOptionOptimizeDisable = (1 << 28),
101 EOptionOptimizeSize = (1 << 29),
LoopDawgb22c0692017-12-06 16:52:03 -0700102 EOptionInvertY = (1 << 30),
John Kessenichc6c80a62018-03-05 22:23:17 -0700103 EOptionDumpBareVersion = (1 << 31),
John Kessenich94a81fb2013-08-31 02:41:30 +0000104};
John Kessenich5d610ee2018-03-07 18:05:55 -0700105bool targetHlslFunctionality1 = false;
John Kesseniche2156222018-06-11 18:12:15 -0600106bool SpvToolsDisassembler = false;
John Kessenichc3404252018-08-23 15:29:08 -0600107bool SpvToolsValidate = false;
John Kessenich605afc72019-06-17 23:33:09 -0600108bool NaNClamp = false;
John Kessenich94a81fb2013-08-31 02:41:30 +0000109
John Kessenicha0af4732012-12-12 21:15:54 +0000110//
John Kessenich68d78fd2015-07-12 19:28:10 -0600111// Return codes from main/exit().
John Kessenicha0af4732012-12-12 21:15:54 +0000112//
113enum TFailCode {
114 ESuccess = 0,
115 EFailUsage,
116 EFailCompile,
117 EFailLink,
118 EFailCompilerCreate,
John Kessenich2b07c7e2013-07-31 18:44:13 +0000119 EFailThreadCreate,
John Kessenicha0af4732012-12-12 21:15:54 +0000120 EFailLinkerCreate
121};
122
123//
John Kessenich68d78fd2015-07-12 19:28:10 -0600124// Forward declarations.
John Kessenicha0af4732012-12-12 21:15:54 +0000125//
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600126EShLanguage FindLanguage(const std::string& name, bool parseSuffix=true);
John Kessenich51cdd902014-02-18 23:37:57 +0000127void CompileFile(const char* fileName, ShHandle);
John Kessenicha0af4732012-12-12 21:15:54 +0000128void usage();
John Kessenich04acb1b2017-06-14 17:36:50 -0600129char* ReadFileData(const char* fileName);
130void FreeFileData(char* data);
John Kessenich54d8cda2013-02-11 22:36:01 +0000131void InfoLogMsg(const char* msg, const char* name, const int num);
John Kessenich41cf6b52013-06-25 18:10:05 +0000132
John Kessenichc999ba22013-11-07 23:33:24 +0000133// Globally track if any compile or link failure.
134bool CompileFailed = false;
135bool LinkFailed = false;
136
John Kessenich94f28eb2017-11-13 01:32:06 -0700137// array of unique places to leave the shader names and infologs for the asynchronous compiles
138std::vector<std::unique_ptr<glslang::TWorkItem>> WorkItems;
139
John Kessenich05a70632013-09-17 19:26:08 +0000140TBuiltInResource Resources;
141std::string ConfigFile;
142
John Kessenicha0af4732012-12-12 21:15:54 +0000143//
John Kessenichf0bcb0a2016-04-02 13:09:14 -0600144// Parse either a .conf file provided by the user or the default from glslang::DefaultTBuiltInResource
John Kessenich05a70632013-09-17 19:26:08 +0000145//
146void ProcessConfigFile()
John Kessenichb51f62c2013-04-11 16:31:09 +0000147{
John Kessenich04acb1b2017-06-14 17:36:50 -0600148 if (ConfigFile.size() == 0)
Lei Zhang414eb602016-03-04 16:22:34 -0500149 Resources = glslang::DefaultTBuiltInResource;
John Kessenich23d27752019-07-28 02:12:10 -0600150#ifndef GLSLANG_WEB
John Kessenich04acb1b2017-06-14 17:36:50 -0600151 else {
152 char* configString = ReadFileData(ConfigFile.c_str());
153 glslang::DecodeResourceLimits(&Resources, configString);
154 FreeFileData(configString);
John Kessenich05a70632013-09-17 19:26:08 +0000155 }
John Kessenich23d27752019-07-28 02:12:10 -0600156#endif
John Kessenicha0af4732012-12-12 21:15:54 +0000157}
158
baldurk6d477852019-01-29 15:45:56 +0000159int ReflectOptions = EShReflectionDefault;
John Kessenich94a81fb2013-08-31 02:41:30 +0000160int Options = 0;
John Kessenich68d78fd2015-07-12 19:28:10 -0600161const char* ExecutableName = nullptr;
162const char* binaryFileName = nullptr;
John Kessenich4d65ee32016-03-12 18:17:47 -0700163const char* entryPointName = nullptr;
steve-lunargf1e0c872016-10-31 15:13:43 -0600164const char* sourceEntryPointName = nullptr;
Dan Bakerc6ede892016-08-11 14:06:06 -0400165const char* shaderStageName = nullptr;
Flavioaea3c892017-02-06 11:46:35 -0800166const char* variableName = nullptr;
Rex Xucb61eec2018-03-07 13:10:01 +0800167bool HlslEnable16BitTypes = false;
John Kessenichbd1c1832018-12-07 18:38:26 -0700168bool HlslDX9compatible = false;
Christoph Kubisch55ba3ea2019-04-13 22:18:16 +0200169bool DumpBuiltinSymbols = false;
John Kessenich971a0a82017-06-07 15:06:58 -0600170std::vector<std::string> IncludeDirectoryList;
John Kessenich8717a5d2018-10-26 10:12:32 -0600171
172// Source environment
173// (source 'Client' is currently the same as target 'Client')
174int ClientInputSemanticsVersion = 100;
175
176// Target environment
177glslang::EShClient Client = glslang::EShClientNone; // will stay EShClientNone if only validating
178glslang::EShTargetClientVersion ClientVersion; // not valid until Client is set
179glslang::EShTargetLanguage TargetLanguage = glslang::EShTargetNone;
180glslang::EShTargetLanguageVersion TargetVersion; // not valid until TargetLanguage is set
181
John Kessenich66011cb2018-03-06 16:12:04 -0700182std::vector<std::string> Processes; // what should be recorded by OpModuleProcessed, or equivalent
John Kessenich68d78fd2015-07-12 19:28:10 -0600183
LoopDawg08a14422017-10-17 19:27:14 -0600184// Per descriptor-set binding base data
185typedef std::map<unsigned int, unsigned int> TPerSetBaseBinding;
186
Neil Roberts16f53472018-03-20 17:30:53 +0100187std::vector<std::pair<std::string, int>> uniformLocationOverrides;
Neil Robertsb0f3d792018-03-20 17:41:05 +0100188int uniformBase = 0;
Neil Roberts16f53472018-03-20 17:30:53 +0100189
LoopDawg08a14422017-10-17 19:27:14 -0600190std::array<std::array<unsigned int, EShLangCount>, glslang::EResCount> baseBinding;
191std::array<std::array<TPerSetBaseBinding, EShLangCount>, glslang::EResCount> baseBindingForSet;
Hyangran Park36dc8292017-05-02 16:27:29 +0900192std::array<std::vector<std::string>, EShLangCount> baseResourceSetBinding;
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600193
John Kessenicha9313662017-06-15 10:40:49 -0600194// Add things like "#define ..." to a preamble to use in the beginning of the shader.
195class TPreamble {
196public:
197 TPreamble() { }
198
199 bool isSet() const { return text.size() > 0; }
200 const char* get() const { return text.c_str(); }
201
202 // #define...
203 void addDef(std::string def)
204 {
205 text.append("#define ");
206 fixLine(def);
207
John Kessenich6f988922020-01-07 07:03:11 -0700208 Processes.push_back("define-macro ");
John Kessenich2a271162017-07-20 20:00:36 -0600209 Processes.back().append(def);
210
John Kessenicha9313662017-06-15 10:40:49 -0600211 // The first "=" needs to turn into a space
LoopDawgb97b25e2017-07-12 09:04:39 -0600212 const size_t equal = def.find_first_of("=");
John Kessenicha9313662017-06-15 10:40:49 -0600213 if (equal != def.npos)
214 def[equal] = ' ';
215
216 text.append(def);
217 text.append("\n");
218 }
219
220 // #undef...
221 void addUndef(std::string undef)
222 {
223 text.append("#undef ");
224 fixLine(undef);
John Kessenich2a271162017-07-20 20:00:36 -0600225
John Kessenich6f988922020-01-07 07:03:11 -0700226 Processes.push_back("undef-macro ");
John Kessenich2a271162017-07-20 20:00:36 -0600227 Processes.back().append(undef);
228
John Kessenicha9313662017-06-15 10:40:49 -0600229 text.append(undef);
230 text.append("\n");
231 }
232
233protected:
234 void fixLine(std::string& line)
235 {
236 // Can't go past a newline in the line
LoopDawgb97b25e2017-07-12 09:04:39 -0600237 const size_t end = line.find_first_of("\n");
John Kessenicha9313662017-06-15 10:40:49 -0600238 if (end != line.npos)
239 line = line.substr(0, end);
240 }
241
242 std::string text; // contents of preamble
243};
244
John Kessenich83855b92020-03-30 00:27:31 -0600245// Track the user's #define and #undef from the command line.
John Kessenicha9313662017-06-15 10:40:49 -0600246TPreamble UserPreamble;
247
John Kessenich68d78fd2015-07-12 19:28:10 -0600248//
249// Create the default name for saving a binary if -o is not provided.
250//
251const char* GetBinaryName(EShLanguage stage)
252{
253 const char* name;
254 if (binaryFileName == nullptr) {
255 switch (stage) {
256 case EShLangVertex: name = "vert.spv"; break;
257 case EShLangTessControl: name = "tesc.spv"; break;
258 case EShLangTessEvaluation: name = "tese.spv"; break;
259 case EShLangGeometry: name = "geom.spv"; break;
260 case EShLangFragment: name = "frag.spv"; break;
261 case EShLangCompute: name = "comp.spv"; break;
Daniel Kochdb32b242020-03-17 20:42:47 -0400262 case EShLangRayGen: name = "rgen.spv"; break;
263 case EShLangIntersect: name = "rint.spv"; break;
264 case EShLangAnyHit: name = "rahit.spv"; break;
265 case EShLangClosestHit: name = "rchit.spv"; break;
266 case EShLangMiss: name = "rmiss.spv"; break;
267 case EShLangCallable: name = "rcall.spv"; break;
Chao Chen3c366992018-09-19 11:41:59 -0700268 case EShLangMeshNV: name = "mesh.spv"; break;
269 case EShLangTaskNV: name = "task.spv"; break;
John Kessenich68d78fd2015-07-12 19:28:10 -0600270 default: name = "unknown"; break;
271 }
272 } else
273 name = binaryFileName;
274
275 return name;
276}
John Kessenich2b07c7e2013-07-31 18:44:13 +0000277
John Kessenich05a70632013-09-17 19:26:08 +0000278//
279// *.conf => this is a config file that can set limits/resources
280//
281bool SetConfigFile(const std::string& name)
282{
283 if (name.size() < 5)
284 return false;
285
John Kessenich4c706852013-10-11 16:28:43 +0000286 if (name.compare(name.size() - 5, 5, ".conf") == 0) {
John Kessenich05a70632013-09-17 19:26:08 +0000287 ConfigFile = name;
288 return true;
289 }
290
291 return false;
292}
293
John Kessenich68d78fd2015-07-12 19:28:10 -0600294//
295// Give error and exit with failure code.
296//
John Kessenichbd97b6f2019-12-20 10:33:13 -0700297void Error(const char* message, const char* detail = nullptr)
John Kessenich68d78fd2015-07-12 19:28:10 -0600298{
John Kessenichbd97b6f2019-12-20 10:33:13 -0700299 fprintf(stderr, "%s: Error: ", ExecutableName);
300 if (detail != nullptr)
301 fprintf(stderr, "%s: ", detail);
302 fprintf(stderr, "%s (use -h for usage)\n", message);
John Kessenich68d78fd2015-07-12 19:28:10 -0600303 exit(EFailUsage);
304}
305
306//
LoopDawg08a14422017-10-17 19:27:14 -0600307// Process an optional binding base of one the forms:
308// --argname [stage] base // base for stage (if given) or all stages (if not)
LoopDawge5709552017-10-21 10:46:39 -0600309// --argname [stage] [base set]... // set/base pairs: set the base for given binding set.
LoopDawg08a14422017-10-17 19:27:14 -0600310
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600311// Where stage is one of the forms accepted by FindLanguage, and base is an integer
312//
LoopDawg08a14422017-10-17 19:27:14 -0600313void ProcessBindingBase(int& argc, char**& argv, glslang::TResourceType res)
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600314{
315 if (argc < 2)
316 usage();
317
LoopDawg08a14422017-10-17 19:27:14 -0600318 EShLanguage lang = EShLangCount;
319 int singleBase = 0;
320 TPerSetBaseBinding perSetBase;
321 int arg = 1;
322
323 // Parse stage, if given
324 if (!isdigit(argv[arg][0])) {
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600325 if (argc < 3) // this form needs one more argument
326 usage();
John Kessenichecba76f2017-01-06 00:34:48 -0700327
LoopDawg08a14422017-10-17 19:27:14 -0600328 lang = FindLanguage(argv[arg++], false);
329 }
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600330
LoopDawg08a14422017-10-17 19:27:14 -0600331 if ((argc - arg) > 2 && isdigit(argv[arg+0][0]) && isdigit(argv[arg+1][0])) {
332 // Parse a per-set binding base
333 while ((argc - arg) > 2 && isdigit(argv[arg+0][0]) && isdigit(argv[arg+1][0])) {
LoopDawg08a14422017-10-17 19:27:14 -0600334 const int baseNum = atoi(argv[arg++]);
LoopDawge5709552017-10-21 10:46:39 -0600335 const int setNum = atoi(argv[arg++]);
LoopDawg08a14422017-10-17 19:27:14 -0600336 perSetBase[setNum] = baseNum;
337 }
338 } else {
339 // Parse single binding base
340 singleBase = atoi(argv[arg++]);
341 }
342
343 argc -= (arg-1);
344 argv += (arg-1);
345
346 // Set one or all languages
347 const int langMin = (lang < EShLangCount) ? lang+0 : 0;
348 const int langMax = (lang < EShLangCount) ? lang+1 : EShLangCount;
349
350 for (int lang = langMin; lang < langMax; ++lang) {
351 if (!perSetBase.empty())
John Kessenich251901a2018-08-12 22:05:59 -0600352 baseBindingForSet[res][lang].insert(perSetBase.begin(), perSetBase.end());
LoopDawg08a14422017-10-17 19:27:14 -0600353 else
354 baseBinding[res][lang] = singleBase;
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600355 }
356}
357
Hyangran Park36dc8292017-05-02 16:27:29 +0900358void ProcessResourceSetBindingBase(int& argc, char**& argv, std::array<std::vector<std::string>, EShLangCount>& base)
359{
360 if (argc < 2)
361 usage();
362
363 if (!isdigit(argv[1][0])) {
LoopDawg52017192017-07-14 15:15:47 -0600364 if (argc < 3) // this form needs one more argument
Hyangran Park36dc8292017-05-02 16:27:29 +0900365 usage();
366
LoopDawg52017192017-07-14 15:15:47 -0600367 // Parse form: --argname stage [regname set base...], or:
368 // --argname stage set
Hyangran Park36dc8292017-05-02 16:27:29 +0900369 const EShLanguage lang = FindLanguage(argv[1], false);
370
LoopDawg52017192017-07-14 15:15:47 -0600371 argc--;
372 argv++;
373
374 while (argc > 1 && argv[1] != nullptr && argv[1][0] != '-') {
375 base[lang].push_back(argv[1]);
376
377 argc--;
378 argv++;
Hyangran Park36dc8292017-05-02 16:27:29 +0900379 }
LoopDawg52017192017-07-14 15:15:47 -0600380
381 // Must have one arg, or a multiple of three (for [regname set binding] triples)
382 if (base[lang].size() != 1 && (base[lang].size() % 3) != 0)
383 usage();
384
Hyangran Park36dc8292017-05-02 16:27:29 +0900385 } else {
LoopDawg52017192017-07-14 15:15:47 -0600386 // Parse form: --argname set
Hyangran Park36dc8292017-05-02 16:27:29 +0900387 for (int lang=0; lang<EShLangCount; ++lang)
388 base[lang].push_back(argv[1]);
389
390 argc--;
391 argv++;
392 }
393}
394
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600395//
John Kessenich68d78fd2015-07-12 19:28:10 -0600396// Do all command-line argument parsing. This includes building up the work-items
397// to be processed later, and saving all the command-line options.
398//
399// Does not return (it exits) if command-line is fatally flawed.
400//
Juan Lopeza558b262017-04-02 23:04:00 +0200401void ProcessArguments(std::vector<std::unique_ptr<glslang::TWorkItem>>& workItems, int argc, char* argv[])
John Kessenich2b07c7e2013-07-31 18:44:13 +0000402{
LoopDawg08a14422017-10-17 19:27:14 -0600403 for (int res = 0; res < glslang::EResCount; ++res)
404 baseBinding[res].fill(0);
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600405
John Kessenich38f3b892013-09-06 19:52:57 +0000406 ExecutableName = argv[0];
Juan Lopeza558b262017-04-02 23:04:00 +0200407 workItems.reserve(argc);
John Kessenich38f3b892013-09-06 19:52:57 +0000408
John Kessenichc178f0a2017-06-23 10:58:31 -0600409 const auto bumpArg = [&]() {
410 if (argc > 0) {
411 argc--;
412 argv++;
413 }
414 };
415
416 // read a string directly attached to a single-letter option
John Kessenich6263fb12017-06-14 15:52:44 -0600417 const auto getStringOperand = [&](const char* desc) {
418 if (argv[0][2] == 0) {
419 printf("%s must immediately follow option (no spaces)\n", desc);
420 exit(EFailUsage);
421 }
422 return argv[0] + 2;
423 };
424
John Kessenich6353d552017-06-23 11:11:09 -0600425 // read a number attached to a single-letter option
426 const auto getAttachedNumber = [&](const char* desc) {
427 int num = atoi(argv[0] + 2);
428 if (num == 0) {
429 printf("%s: expected attached non-0 number\n", desc);
430 exit(EFailUsage);
431 }
432 return num;
433 };
434
435 // minimum needed (without overriding something else) to target Vulkan SPIR-V
436 const auto setVulkanSpv = []() {
John Kessenich8717a5d2018-10-26 10:12:32 -0600437 if (Client == glslang::EShClientNone)
438 ClientVersion = glslang::EShTargetVulkan_1_0;
439 Client = glslang::EShClientVulkan;
John Kessenich6353d552017-06-23 11:11:09 -0600440 Options |= EOptionSpv;
441 Options |= EOptionVulkanRules;
442 Options |= EOptionLinkProgram;
443 };
444
445 // minimum needed (without overriding something else) to target OpenGL SPIR-V
446 const auto setOpenGlSpv = []() {
John Kessenich8717a5d2018-10-26 10:12:32 -0600447 if (Client == glslang::EShClientNone)
448 ClientVersion = glslang::EShTargetOpenGL_450;
449 Client = glslang::EShClientOpenGL;
John Kessenich6353d552017-06-23 11:11:09 -0600450 Options |= EOptionSpv;
451 Options |= EOptionLinkProgram;
452 // undo a -H default to Vulkan
453 Options &= ~EOptionVulkanRules;
454 };
455
Neil Roberts16f53472018-03-20 17:30:53 +0100456 const auto getUniformOverride = [getStringOperand]() {
457 const char *arg = getStringOperand("-u<name>:<location>");
458 const char *split = strchr(arg, ':');
459 if (split == NULL) {
460 printf("%s: missing location\n", arg);
461 exit(EFailUsage);
462 }
463 errno = 0;
464 int location = ::strtol(split + 1, NULL, 10);
465 if (errno) {
466 printf("%s: invalid location\n", arg);
467 exit(EFailUsage);
468 }
469 return std::make_pair(std::string(arg, split - arg), location);
470 };
471
John Kessenichc178f0a2017-06-23 10:58:31 -0600472 for (bumpArg(); argc >= 1; bumpArg()) {
John Kessenich2b07c7e2013-07-31 18:44:13 +0000473 if (argv[0][0] == '-') {
John Kessenich2aa7f3a2015-05-15 16:02:07 +0000474 switch (argv[0][1]) {
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600475 case '-':
476 {
477 std::string lowerword(argv[0]+2);
478 std::transform(lowerword.begin(), lowerword.end(), lowerword.begin(), ::tolower);
479
480 // handle --word style options
John Kessenich6263fb12017-06-14 15:52:44 -0600481 if (lowerword == "auto-map-bindings" || // synonyms
John Kessenich6353d552017-06-23 11:11:09 -0600482 lowerword == "auto-map-binding" ||
483 lowerword == "amb") {
John Kessenich6263fb12017-06-14 15:52:44 -0600484 Options |= EOptionAutoMapBindings;
485 } else if (lowerword == "auto-map-locations" || // synonyms
486 lowerword == "aml") {
487 Options |= EOptionAutoMapLocations;
Neil Robertsb0f3d792018-03-20 17:41:05 +0100488 } else if (lowerword == "uniform-base") {
489 if (argc <= 1)
John Kessenichbd97b6f2019-12-20 10:33:13 -0700490 Error("no <base> provided", lowerword.c_str());
Neil Robertsb0f3d792018-03-20 17:41:05 +0100491 uniformBase = ::strtol(argv[1], NULL, 10);
492 bumpArg();
493 break;
John Kessenich6353d552017-06-23 11:11:09 -0600494 } else if (lowerword == "client") {
495 if (argc > 1) {
496 if (strcmp(argv[1], "vulkan100") == 0)
497 setVulkanSpv();
498 else if (strcmp(argv[1], "opengl100") == 0)
499 setOpenGlSpv();
500 else
John Kessenichbd97b6f2019-12-20 10:33:13 -0700501 Error("expects vulkan100 or opengl100", lowerword.c_str());
502 } else
503 Error("expects vulkan100 or opengl100", lowerword.c_str());
John Kessenich6353d552017-06-23 11:11:09 -0600504 bumpArg();
John Kessenich6f988922020-01-07 07:03:11 -0700505 } else if (lowerword == "define-macro" ||
506 lowerword == "d") {
507 if (argc > 1)
508 UserPreamble.addDef(argv[1]);
509 else
510 Error("expects <name[=def]>", argv[0]);
511 bumpArg();
Christoph Kubisch55ba3ea2019-04-13 22:18:16 +0200512 } else if (lowerword == "dump-builtin-symbols") {
513 DumpBuiltinSymbols = true;
John Kessenich640bd092018-08-09 14:15:00 -0600514 } else if (lowerword == "entry-point") {
515 entryPointName = argv[1];
516 if (argc <= 1)
John Kessenichbd97b6f2019-12-20 10:33:13 -0700517 Error("no <name> provided", lowerword.c_str());
John Kessenich640bd092018-08-09 14:15:00 -0600518 bumpArg();
John Kessenich6263fb12017-06-14 15:52:44 -0600519 } else if (lowerword == "flatten-uniform-arrays" || // synonyms
520 lowerword == "flatten-uniform-array" ||
521 lowerword == "fua") {
522 Options |= EOptionFlattenUniformArrays;
523 } else if (lowerword == "hlsl-offsets") {
524 Options |= EOptionHlslOffsets;
525 } else if (lowerword == "hlsl-iomap" ||
526 lowerword == "hlsl-iomapper" ||
527 lowerword == "hlsl-iomapping") {
528 Options |= EOptionHlslIoMapping;
Rex Xucb61eec2018-03-07 13:10:01 +0800529 } else if (lowerword == "hlsl-enable-16bit-types") {
530 HlslEnable16BitTypes = true;
John Kessenichbd1c1832018-12-07 18:38:26 -0700531 } else if (lowerword == "hlsl-dx9-compatible") {
532 HlslDX9compatible = true;
John Kessenichc6c80a62018-03-05 22:23:17 -0700533 } else if (lowerword == "invert-y" || // synonyms
534 lowerword == "iy") {
535 Options |= EOptionInvertY;
John Kessenich6263fb12017-06-14 15:52:44 -0600536 } else if (lowerword == "keep-uncalled" || // synonyms
537 lowerword == "ku") {
538 Options |= EOptionKeepUncalled;
John Kessenich605afc72019-06-17 23:33:09 -0600539 } else if (lowerword == "nan-clamp") {
540 NaNClamp = true;
John Kessenich6263fb12017-06-14 15:52:44 -0600541 } else if (lowerword == "no-storage-format" || // synonyms
542 lowerword == "nsf") {
543 Options |= EOptionNoStorageFormat;
John Kessenich2a271162017-07-20 20:00:36 -0600544 } else if (lowerword == "relaxed-errors") {
545 Options |= EOptionRelaxedErrors;
baldurk15c37f72019-01-29 12:12:59 +0000546 } else if (lowerword == "reflect-strict-array-suffix") {
547 ReflectOptions |= EShReflectionStrictArraySuffix;
baldurkedf82122019-01-29 15:49:00 +0000548 } else if (lowerword == "reflect-basic-array-suffix") {
549 ReflectOptions |= EShReflectionBasicArraySuffix;
baldurk0af5e3e2019-01-29 16:04:44 +0000550 } else if (lowerword == "reflect-intermediate-io") {
551 ReflectOptions |= EShReflectionIntermediateIO;
baldurk657acc02019-01-30 14:18:43 +0000552 } else if (lowerword == "reflect-separate-buffers") {
553 ReflectOptions |= EShReflectionSeparateBuffers;
baldurka972e732019-01-30 15:34:02 +0000554 } else if (lowerword == "reflect-all-block-variables") {
555 ReflectOptions |= EShReflectionAllBlockVariables;
baldurk19050692019-02-11 11:50:24 +0000556 } else if (lowerword == "reflect-unwrap-io-blocks") {
557 ReflectOptions |= EShReflectionUnwrapIOBlocks;
Chow81112682020-06-04 15:47:18 +0800558 } else if (lowerword == "reflect-all-io-variables") {
559 ReflectOptions |= EShReflectionAllIOVariables;
560 } else if (lowerword == "reflect-shared-std140-ubo") {
561 ReflectOptions |= EShReflectionSharedStd140UBO;
562 } else if (lowerword == "reflect-shared-std140-ssbo") {
563 ReflectOptions |= EShReflectionSharedStd140SSBO;
John Kessenich6263fb12017-06-14 15:52:44 -0600564 } else if (lowerword == "resource-set-bindings" || // synonyms
565 lowerword == "resource-set-binding" ||
566 lowerword == "rsb") {
567 ProcessResourceSetBindingBase(argc, argv, baseResourceSetBinding);
steve-lunarg9088be42016-11-01 10:31:42 -0600568 } else if (lowerword == "shift-image-bindings" || // synonyms
569 lowerword == "shift-image-binding" ||
570 lowerword == "sib") {
LoopDawg08a14422017-10-17 19:27:14 -0600571 ProcessBindingBase(argc, argv, glslang::EResImage);
John Kessenich6263fb12017-06-14 15:52:44 -0600572 } else if (lowerword == "shift-sampler-bindings" || // synonyms
John Kessenichade8bbb2018-08-12 21:24:55 -0600573 lowerword == "shift-sampler-binding" ||
574 lowerword == "ssb") {
LoopDawg08a14422017-10-17 19:27:14 -0600575 ProcessBindingBase(argc, argv, glslang::EResSampler);
John Kessenich6263fb12017-06-14 15:52:44 -0600576 } else if (lowerword == "shift-uav-bindings" || // synonyms
577 lowerword == "shift-uav-binding" ||
578 lowerword == "suavb") {
LoopDawg08a14422017-10-17 19:27:14 -0600579 ProcessBindingBase(argc, argv, glslang::EResUav);
John Kessenich6263fb12017-06-14 15:52:44 -0600580 } else if (lowerword == "shift-texture-bindings" || // synonyms
581 lowerword == "shift-texture-binding" ||
582 lowerword == "stb") {
LoopDawg08a14422017-10-17 19:27:14 -0600583 ProcessBindingBase(argc, argv, glslang::EResTexture);
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600584 } else if (lowerword == "shift-ubo-bindings" || // synonyms
585 lowerword == "shift-ubo-binding" ||
steve-lunargbe283552017-04-18 12:18:01 -0600586 lowerword == "shift-cbuffer-bindings" ||
587 lowerword == "shift-cbuffer-binding" ||
588 lowerword == "sub" ||
589 lowerword == "scb") {
LoopDawg08a14422017-10-17 19:27:14 -0600590 ProcessBindingBase(argc, argv, glslang::EResUbo);
steve-lunarg932bb5c2017-02-21 17:19:08 -0700591 } else if (lowerword == "shift-ssbo-bindings" || // synonyms
592 lowerword == "shift-ssbo-binding" ||
593 lowerword == "sbb") {
LoopDawg08a14422017-10-17 19:27:14 -0600594 ProcessBindingBase(argc, argv, glslang::EResSsbo);
John Kessenich6263fb12017-06-14 15:52:44 -0600595 } else if (lowerword == "source-entrypoint" || // synonyms
596 lowerword == "sep") {
John Kessenichc178f0a2017-06-23 10:58:31 -0600597 if (argc <= 1)
John Kessenichbd97b6f2019-12-20 10:33:13 -0700598 Error("no <entry-point> provided", lowerword.c_str());
John Kessenichc178f0a2017-06-23 10:58:31 -0600599 sourceEntryPointName = argv[1];
600 bumpArg();
John Kessenich6263fb12017-06-14 15:52:44 -0600601 break;
John Kesseniche2156222018-06-11 18:12:15 -0600602 } else if (lowerword == "spirv-dis") {
603 SpvToolsDisassembler = true;
John Kessenichc3404252018-08-23 15:29:08 -0600604 } else if (lowerword == "spirv-val") {
605 SpvToolsValidate = true;
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +0200606 } else if (lowerword == "stdin") {
607 Options |= EOptionStdin;
608 shaderStageName = argv[1];
John Kessenich2a271162017-07-20 20:00:36 -0600609 } else if (lowerword == "suppress-warnings") {
610 Options |= EOptionSuppressWarnings;
John Kessenich6353d552017-06-23 11:11:09 -0600611 } else if (lowerword == "target-env") {
612 if (argc > 1) {
613 if (strcmp(argv[1], "vulkan1.0") == 0) {
614 setVulkanSpv();
John Kessenich8717a5d2018-10-26 10:12:32 -0600615 ClientVersion = glslang::EShTargetVulkan_1_0;
John Kessenich66011cb2018-03-06 16:12:04 -0700616 } else if (strcmp(argv[1], "vulkan1.1") == 0) {
617 setVulkanSpv();
John Kessenich8717a5d2018-10-26 10:12:32 -0600618 ClientVersion = glslang::EShTargetVulkan_1_1;
John Kessenich273d3a52020-01-15 00:10:41 -0700619 } else if (strcmp(argv[1], "vulkan1.2") == 0) {
620 setVulkanSpv();
621 ClientVersion = glslang::EShTargetVulkan_1_2;
John Kessenich6353d552017-06-23 11:11:09 -0600622 } else if (strcmp(argv[1], "opengl") == 0) {
623 setOpenGlSpv();
John Kessenich8717a5d2018-10-26 10:12:32 -0600624 ClientVersion = glslang::EShTargetOpenGL_450;
625 } else if (strcmp(argv[1], "spirv1.0") == 0) {
626 TargetLanguage = glslang::EShTargetSpv;
627 TargetVersion = glslang::EShTargetSpv_1_0;
628 } else if (strcmp(argv[1], "spirv1.1") == 0) {
629 TargetLanguage = glslang::EShTargetSpv;
630 TargetVersion = glslang::EShTargetSpv_1_1;
631 } else if (strcmp(argv[1], "spirv1.2") == 0) {
632 TargetLanguage = glslang::EShTargetSpv;
633 TargetVersion = glslang::EShTargetSpv_1_2;
634 } else if (strcmp(argv[1], "spirv1.3") == 0) {
635 TargetLanguage = glslang::EShTargetSpv;
636 TargetVersion = glslang::EShTargetSpv_1_3;
637 } else if (strcmp(argv[1], "spirv1.4") == 0) {
638 TargetLanguage = glslang::EShTargetSpv;
639 TargetVersion = glslang::EShTargetSpv_1_4;
John Kessenich8317e6c2019-08-18 23:58:08 -0600640 } else if (strcmp(argv[1], "spirv1.5") == 0) {
641 TargetLanguage = glslang::EShTargetSpv;
642 TargetVersion = glslang::EShTargetSpv_1_5;
John Kessenich6353d552017-06-23 11:11:09 -0600643 } else
John Kessenich273d3a52020-01-15 00:10:41 -0700644 Error("--target-env expected one of: vulkan1.0, vulkan1.1, vulkan1.2, opengl,\n"
John Kessenich8317e6c2019-08-18 23:58:08 -0600645 "spirv1.0, spirv1.1, spirv1.2, spirv1.3, spirv1.4, or spirv1.5");
John Kessenich6353d552017-06-23 11:11:09 -0600646 }
647 bumpArg();
John Kessenich6f988922020-01-07 07:03:11 -0700648 } else if (lowerword == "undef-macro" ||
649 lowerword == "u") {
650 if (argc > 1)
651 UserPreamble.addUndef(argv[1]);
652 else
653 Error("expects <name>", argv[0]);
654 bumpArg();
Flavio15017db2017-02-15 14:29:33 -0800655 } else if (lowerword == "variable-name" || // synonyms
John Kessenich66011cb2018-03-06 16:12:04 -0700656 lowerword == "vn") {
Flavio15017db2017-02-15 14:29:33 -0800657 Options |= EOptionOutputHexadecimal;
John Kessenichc178f0a2017-06-23 10:58:31 -0600658 if (argc <= 1)
John Kessenichbd97b6f2019-12-20 10:33:13 -0700659 Error("no <C-variable-name> provided", lowerword.c_str());
John Kessenichc178f0a2017-06-23 10:58:31 -0600660 variableName = argv[1];
661 bumpArg();
Flavio15017db2017-02-15 14:29:33 -0800662 break;
John Kessenichc6c80a62018-03-05 22:23:17 -0700663 } else if (lowerword == "version") {
664 Options |= EOptionDumpVersions;
Jordan Justen6ad120e2020-01-28 12:18:12 -0800665 } else if (lowerword == "help") {
666 usage();
667 break;
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600668 } else {
John Kessenichbd97b6f2019-12-20 10:33:13 -0700669 Error("unrecognized command-line option", argv[0]);
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600670 }
671 }
672 break;
John Kessenich6263fb12017-06-14 15:52:44 -0600673 case 'C':
674 Options |= EOptionCascadingErrors;
675 break;
676 case 'D':
John Kessenicha9313662017-06-15 10:40:49 -0600677 if (argv[0][2] == 0)
678 Options |= EOptionReadHlsl;
679 else
John Kessenich6f988922020-01-07 07:03:11 -0700680 UserPreamble.addDef(getStringOperand("-D<name[=def]>"));
John Kessenich6263fb12017-06-14 15:52:44 -0600681 break;
Neil Roberts16f53472018-03-20 17:30:53 +0100682 case 'u':
683 uniformLocationOverrides.push_back(getUniformOverride());
684 break;
John Kessenich6263fb12017-06-14 15:52:44 -0600685 case 'E':
686 Options |= EOptionOutputPreprocessed;
687 break;
688 case 'G':
John Kessenich8717a5d2018-10-26 10:12:32 -0600689 // OpenGL client
John Kessenich6353d552017-06-23 11:11:09 -0600690 setOpenGlSpv();
691 if (argv[0][2] != 0)
692 ClientInputSemanticsVersion = getAttachedNumber("-G<num> client input semantics");
John Kessenich6263fb12017-06-14 15:52:44 -0600693 break;
John Kessenich2aa7f3a2015-05-15 16:02:07 +0000694 case 'H':
695 Options |= EOptionHumanReadableSpv;
John Kessenich91e4aa52016-07-07 17:46:42 -0600696 if ((Options & EOptionSpv) == 0) {
697 // default to Vulkan
John Kessenich6353d552017-06-23 11:11:09 -0600698 setVulkanSpv();
John Kessenich91e4aa52016-07-07 17:46:42 -0600699 }
700 break;
John Kessenich971a0a82017-06-07 15:06:58 -0600701 case 'I':
John Kessenicha9313662017-06-15 10:40:49 -0600702 IncludeDirectoryList.push_back(getStringOperand("-I<dir> include path"));
John Kessenich68d78fd2015-07-12 19:28:10 -0600703 break;
GregFcd1f1692017-09-21 18:40:22 -0600704 case 'O':
705 if (argv[0][2] == 'd')
706 Options |= EOptionOptimizeDisable;
707 else if (argv[0][2] == 's')
GregFfb03a552018-03-29 11:49:14 -0600708#if ENABLE_OPT
GregFcd1f1692017-09-21 18:40:22 -0600709 Options |= EOptionOptimizeSize;
710#else
711 Error("-Os not available; optimizer not linked");
712#endif
713 else
714 Error("unknown -O option");
715 break;
Dan Baker5afdd782016-08-11 17:53:57 -0400716 case 'S':
John Kessenichc178f0a2017-06-23 10:58:31 -0600717 if (argc <= 1)
Dan Baker5afdd782016-08-11 17:53:57 -0400718 Error("no <stage> specified for -S");
John Kessenichc178f0a2017-06-23 10:58:31 -0600719 shaderStageName = argv[1];
720 bumpArg();
dankbaker45d49bc2016-08-08 21:43:07 -0400721 break;
John Kessenicha9313662017-06-15 10:40:49 -0600722 case 'U':
John Kessenich6f988922020-01-07 07:03:11 -0700723 UserPreamble.addUndef(getStringOperand("-U<name>"));
John Kessenicha9313662017-06-15 10:40:49 -0600724 break;
John Kessenich6263fb12017-06-14 15:52:44 -0600725 case 'V':
John Kessenich6353d552017-06-23 11:11:09 -0600726 setVulkanSpv();
727 if (argv[0][2] != 0)
David Neto506d2c22018-02-27 21:55:23 -0500728 ClientInputSemanticsVersion = getAttachedNumber("-V<num> client input semantics");
John Kessenichc555ddd2015-06-17 02:38:44 +0000729 break;
John Kessenich05a70632013-09-17 19:26:08 +0000730 case 'c':
731 Options |= EOptionDumpConfig;
732 break;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000733 case 'd':
John Kessenichc6c80a62018-03-05 22:23:17 -0700734 if (strncmp(&argv[0][1], "dumpversion", strlen(&argv[0][1]) + 1) == 0 ||
735 strncmp(&argv[0][1], "dumpfullversion", strlen(&argv[0][1]) + 1) == 0)
736 Options |= EOptionDumpBareVersion;
737 else
738 Options |= EOptionDefaultDesktop;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000739 break;
John Kessenich4d65ee32016-03-12 18:17:47 -0700740 case 'e':
John Kessenich4d65ee32016-03-12 18:17:47 -0700741 entryPointName = argv[1];
John Kessenichc178f0a2017-06-23 10:58:31 -0600742 if (argc <= 1)
John Kessenicha25530c2017-09-11 20:13:49 -0600743 Error("no <name> provided for -e");
John Kessenichc178f0a2017-06-23 10:58:31 -0600744 bumpArg();
John Kessenich4d65ee32016-03-12 18:17:47 -0700745 break;
John Kessenich5d610ee2018-03-07 18:05:55 -0700746 case 'f':
747 if (strcmp(&argv[0][2], "hlsl_functionality1") == 0)
748 targetHlslFunctionality1 = true;
749 else
750 Error("-f: expected hlsl_functionality1");
751 break;
John Kessenich121853f2017-05-31 17:11:16 -0600752 case 'g':
753 Options |= EOptionDebug;
754 break;
John Kessenich68d78fd2015-07-12 19:28:10 -0600755 case 'h':
756 usage();
757 break;
John Kessenich05a70632013-09-17 19:26:08 +0000758 case 'i':
John Kessenich94a81fb2013-08-31 02:41:30 +0000759 Options |= EOptionIntermediate;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000760 break;
761 case 'l':
John Kessenichd78e3512014-08-25 20:07:55 +0000762 Options |= EOptionLinkProgram;
John Kessenich94a81fb2013-08-31 02:41:30 +0000763 break;
764 case 'm':
765 Options |= EOptionMemoryLeakMode;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000766 break;
John Kessenich68d78fd2015-07-12 19:28:10 -0600767 case 'o':
John Kessenichc178f0a2017-06-23 10:58:31 -0600768 if (argc <= 1)
John Kessenich68d78fd2015-07-12 19:28:10 -0600769 Error("no <file> provided for -o");
John Kessenichc178f0a2017-06-23 10:58:31 -0600770 binaryFileName = argv[1];
771 bumpArg();
John Kessenich68d78fd2015-07-12 19:28:10 -0600772 break;
John Kessenich11f9fc72013-11-07 01:06:34 +0000773 case 'q':
774 Options |= EOptionDumpReflection;
775 break;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000776 case 'r':
John Kessenich94a81fb2013-08-31 02:41:30 +0000777 Options |= EOptionRelaxedErrors;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000778 break;
779 case 's':
John Kessenich94a81fb2013-08-31 02:41:30 +0000780 Options |= EOptionSuppressInfolog;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000781 break;
John Kessenich38f3b892013-09-06 19:52:57 +0000782 case 't':
Juan Lopeza558b262017-04-02 23:04:00 +0200783 Options |= EOptionMultiThreaded;
John Kessenich38f3b892013-09-06 19:52:57 +0000784 break;
John Kessenich319de232013-12-04 04:43:40 +0000785 case 'v':
786 Options |= EOptionDumpVersions;
787 break;
John Kessenichb0a7eb52013-11-07 17:44:20 +0000788 case 'w':
789 Options |= EOptionSuppressWarnings;
790 break;
Johannes van Waverenecb0f3b2016-05-27 12:55:53 -0500791 case 'x':
792 Options |= EOptionOutputHexadecimal;
Johannes van Waverenecb0f3b2016-05-27 12:55:53 -0500793 break;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000794 default:
John Kessenichbd97b6f2019-12-20 10:33:13 -0700795 Error("unrecognized command-line option", argv[0]);
John Kessenich68d78fd2015-07-12 19:28:10 -0600796 break;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000797 }
John Kessenich38f3b892013-09-06 19:52:57 +0000798 } else {
John Kessenich05a70632013-09-17 19:26:08 +0000799 std::string name(argv[0]);
800 if (! SetConfigFile(name)) {
Juan Lopeza558b262017-04-02 23:04:00 +0200801 workItems.push_back(std::unique_ptr<glslang::TWorkItem>(new glslang::TWorkItem(name)));
John Kessenich05a70632013-09-17 19:26:08 +0000802 }
John Kessenich38f3b892013-09-06 19:52:57 +0000803 }
John Kessenich2b07c7e2013-07-31 18:44:13 +0000804 }
805
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +0200806 // Make sure that -S is always specified if --stdin is specified
807 if ((Options & EOptionStdin) && shaderStageName == nullptr)
808 Error("must provide -S when --stdin is given");
809
John Kessenich68d78fd2015-07-12 19:28:10 -0600810 // Make sure that -E is not specified alongside linking (which includes SPV generation)
John Kesseniche5c394b2019-07-02 09:32:48 -0600811 // Or things that require linking
812 if (Options & EOptionOutputPreprocessed) {
813 if (Options & EOptionLinkProgram)
814 Error("can't use -E when linking is selected");
815 if (Options & EOptionDumpReflection)
816 Error("reflection requires linking, which can't be used when -E when is selected");
817 }
818
819 // reflection requires linking
820 if ((Options & EOptionDumpReflection) && !(Options & EOptionLinkProgram))
821 Error("reflection requires -l for linking");
John Kessenichc555ddd2015-06-17 02:38:44 +0000822
Johannes van Waverenecb0f3b2016-05-27 12:55:53 -0500823 // -o or -x makes no sense if there is no target binary
John Kessenich68d78fd2015-07-12 19:28:10 -0600824 if (binaryFileName && (Options & EOptionSpv) == 0)
825 Error("no binary generation requested (e.g., -V)");
steve-lunarge0b9deb2016-09-16 13:26:37 -0600826
827 if ((Options & EOptionFlattenUniformArrays) != 0 &&
828 (Options & EOptionReadHlsl) == 0)
829 Error("uniform array flattening only valid when compiling HLSL source.");
John Kessenich8717a5d2018-10-26 10:12:32 -0600830
831 // rationalize client and target language
832 if (TargetLanguage == glslang::EShTargetNone) {
833 switch (ClientVersion) {
834 case glslang::EShTargetVulkan_1_0:
835 TargetLanguage = glslang::EShTargetSpv;
836 TargetVersion = glslang::EShTargetSpv_1_0;
837 break;
838 case glslang::EShTargetVulkan_1_1:
839 TargetLanguage = glslang::EShTargetSpv;
840 TargetVersion = glslang::EShTargetSpv_1_3;
841 break;
John Kessenich273d3a52020-01-15 00:10:41 -0700842 case glslang::EShTargetVulkan_1_2:
843 TargetLanguage = glslang::EShTargetSpv;
844 TargetVersion = glslang::EShTargetSpv_1_5;
845 break;
John Kessenich8717a5d2018-10-26 10:12:32 -0600846 case glslang::EShTargetOpenGL_450:
847 TargetLanguage = glslang::EShTargetSpv;
848 TargetVersion = glslang::EShTargetSpv_1_0;
849 break;
850 default:
851 break;
852 }
853 }
854 if (TargetLanguage != glslang::EShTargetNone && Client == glslang::EShClientNone)
855 Error("To generate SPIR-V, also specify client semantics. See -G and -V.");
John Kessenich2b07c7e2013-07-31 18:44:13 +0000856}
857
John Kessenich68d78fd2015-07-12 19:28:10 -0600858//
859// Translate the meaningful subset of command-line options to parser-behavior options.
860//
John Kessenichb0a7eb52013-11-07 17:44:20 +0000861void SetMessageOptions(EShMessages& messages)
862{
863 if (Options & EOptionRelaxedErrors)
864 messages = (EShMessages)(messages | EShMsgRelaxedErrors);
865 if (Options & EOptionIntermediate)
866 messages = (EShMessages)(messages | EShMsgAST);
867 if (Options & EOptionSuppressWarnings)
868 messages = (EShMessages)(messages | EShMsgSuppressWarnings);
John Kessenich68d78fd2015-07-12 19:28:10 -0600869 if (Options & EOptionSpv)
870 messages = (EShMessages)(messages | EShMsgSpvRules);
871 if (Options & EOptionVulkanRules)
872 messages = (EShMessages)(messages | EShMsgVulkanRules);
Andrew Woloszynaae1ad82015-06-24 17:00:46 -0400873 if (Options & EOptionOutputPreprocessed)
874 messages = (EShMessages)(messages | EShMsgOnlyPreprocessor);
John Kessenich66e2faf2016-03-12 18:34:36 -0700875 if (Options & EOptionReadHlsl)
876 messages = (EShMessages)(messages | EShMsgReadHlsl);
John Kessenicha86836e2016-07-09 14:50:57 -0600877 if (Options & EOptionCascadingErrors)
878 messages = (EShMessages)(messages | EShMsgCascadingErrors);
John Kessenich906cc212016-12-09 19:22:20 -0700879 if (Options & EOptionKeepUncalled)
880 messages = (EShMessages)(messages | EShMsgKeepUncalled);
John Kessenich4f1403e2017-04-05 17:38:20 -0600881 if (Options & EOptionHlslOffsets)
882 messages = (EShMessages)(messages | EShMsgHlslOffsets);
John Kessenich121853f2017-05-31 17:11:16 -0600883 if (Options & EOptionDebug)
884 messages = (EShMessages)(messages | EShMsgDebugInfo);
Rex Xucb61eec2018-03-07 13:10:01 +0800885 if (HlslEnable16BitTypes)
886 messages = (EShMessages)(messages | EShMsgHlslEnable16BitTypes);
GregFfb03a552018-03-29 11:49:14 -0600887 if ((Options & EOptionOptimizeDisable) || !ENABLE_OPT)
888 messages = (EShMessages)(messages | EShMsgHlslLegalization);
John Kessenichbd1c1832018-12-07 18:38:26 -0700889 if (HlslDX9compatible)
890 messages = (EShMessages)(messages | EShMsgHlslDX9Compatible);
Christoph Kubisch55ba3ea2019-04-13 22:18:16 +0200891 if (DumpBuiltinSymbols)
892 messages = (EShMessages)(messages | EShMsgBuiltinSymbolTable);
John Kessenichb0a7eb52013-11-07 17:44:20 +0000893}
894
John Kessenich68d78fd2015-07-12 19:28:10 -0600895//
John Kessenich69f4b512013-09-04 21:19:27 +0000896// Thread entry point, for non-linking asynchronous mode.
John Kessenichc999ba22013-11-07 23:33:24 +0000897//
Juan Lopeza558b262017-04-02 23:04:00 +0200898void CompileShaders(glslang::TWorklist& worklist)
John Kessenich2b07c7e2013-07-31 18:44:13 +0000899{
John Kessenich7f0bcfd2018-04-05 19:00:01 -0600900 if (Options & EOptionDebug)
901 Error("cannot generate debug information unless linking to generate code");
902
John Kessenich38f3b892013-09-06 19:52:57 +0000903 glslang::TWorkItem* workItem;
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +0200904 if (Options & EOptionStdin) {
John Kesseniche7f9cae2018-07-12 15:11:07 -0600905 if (worklist.remove(workItem)) {
906 ShHandle compiler = ShConstructCompiler(FindLanguage("stdin"), Options);
907 if (compiler == nullptr)
908 return;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000909
John Kesseniche7f9cae2018-07-12 15:11:07 -0600910 CompileFile("stdin", compiler);
John Kessenich2b07c7e2013-07-31 18:44:13 +0000911
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +0200912 if (! (Options & EOptionSuppressInfolog))
913 workItem->results = ShGetInfoLog(compiler);
John Kessenich2b07c7e2013-07-31 18:44:13 +0000914
John Kesseniche7f9cae2018-07-12 15:11:07 -0600915 ShDestruct(compiler);
916 }
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +0200917 } else {
918 while (worklist.remove(workItem)) {
919 ShHandle compiler = ShConstructCompiler(FindLanguage(workItem->name), Options);
920 if (compiler == 0)
921 return;
922
923 CompileFile(workItem->name.c_str(), compiler);
924
925 if (! (Options & EOptionSuppressInfolog))
926 workItem->results = ShGetInfoLog(compiler);
927
928 ShDestruct(compiler);
929 }
John Kessenich2b07c7e2013-07-31 18:44:13 +0000930 }
John Kessenich2b07c7e2013-07-31 18:44:13 +0000931}
932
John Kessenich6626cad2015-06-19 05:14:19 +0000933// Outputs the given string, but only if it is non-null and non-empty.
934// This prevents erroneous newlines from appearing.
Andrew Woloszynaae1ad82015-06-24 17:00:46 -0400935void PutsIfNonEmpty(const char* str)
John Kessenich6626cad2015-06-19 05:14:19 +0000936{
937 if (str && str[0]) {
938 puts(str);
939 }
940}
941
Andrew Woloszynaae1ad82015-06-24 17:00:46 -0400942// Outputs the given string to stderr, but only if it is non-null and non-empty.
943// This prevents erroneous newlines from appearing.
944void StderrIfNonEmpty(const char* str)
945{
John Kessenich04acb1b2017-06-14 17:36:50 -0600946 if (str && str[0])
947 fprintf(stderr, "%s\n", str);
Andrew Woloszynaae1ad82015-06-24 17:00:46 -0400948}
949
John Kessenichc57b2a92016-01-16 15:30:03 -0700950// Simple bundling of what makes a compilation unit for ease in passing around,
951// and separation of handling file IO versus API (programmatic) compilation.
952struct ShaderCompUnit {
953 EShLanguage stage;
John Kessenich04acb1b2017-06-14 17:36:50 -0600954 static const int maxCount = 1;
955 int count; // live number of strings/names
John Kessenicha9313662017-06-15 10:40:49 -0600956 const char* text[maxCount]; // memory owned/managed externally
John Kessenich04acb1b2017-06-14 17:36:50 -0600957 std::string fileName[maxCount]; // hold's the memory, but...
958 const char* fileNameList[maxCount]; // downstream interface wants pointers
dankbakerafe6e9c2016-08-21 12:29:08 -0400959
John Kessenich04acb1b2017-06-14 17:36:50 -0600960 ShaderCompUnit(EShLanguage stage) : stage(stage), count(0) { }
dankbakerafe6e9c2016-08-21 12:29:08 -0400961
John Kessenich04acb1b2017-06-14 17:36:50 -0600962 ShaderCompUnit(const ShaderCompUnit& rhs)
dankbakerafe6e9c2016-08-21 12:29:08 -0400963 {
964 stage = rhs.stage;
John Kessenich04acb1b2017-06-14 17:36:50 -0600965 count = rhs.count;
966 for (int i = 0; i < count; ++i) {
967 fileName[i] = rhs.fileName[i];
968 text[i] = rhs.text[i];
969 fileNameList[i] = rhs.fileName[i].c_str();
970 }
dankbakerafe6e9c2016-08-21 12:29:08 -0400971 }
972
John Kessenicha9313662017-06-15 10:40:49 -0600973 void addString(std::string& ifileName, const char* itext)
John Kessenich04acb1b2017-06-14 17:36:50 -0600974 {
975 assert(count < maxCount);
976 fileName[count] = ifileName;
977 text[count] = itext;
978 fileNameList[count] = fileName[count].c_str();
979 ++count;
980 }
John Kessenichc57b2a92016-01-16 15:30:03 -0700981};
982
John Kessenich69f4b512013-09-04 21:19:27 +0000983//
John Kessenichc57b2a92016-01-16 15:30:03 -0700984// For linking mode: Will independently parse each compilation unit, but then put them
985// in the same program and link them together, making at most one linked module per
986// pipeline stage.
John Kessenich69f4b512013-09-04 21:19:27 +0000987//
988// Uses the new C++ interface instead of the old handle-based interface.
989//
John Kessenichc57b2a92016-01-16 15:30:03 -0700990
991void CompileAndLinkShaderUnits(std::vector<ShaderCompUnit> compUnits)
John Kessenich69f4b512013-09-04 21:19:27 +0000992{
993 // keep track of what to free
994 std::list<glslang::TShader*> shaders;
John Kessenichc57b2a92016-01-16 15:30:03 -0700995
John Kessenich69f4b512013-09-04 21:19:27 +0000996 EShMessages messages = EShMsgDefault;
John Kessenichb0a7eb52013-11-07 17:44:20 +0000997 SetMessageOptions(messages);
John Kessenich69f4b512013-09-04 21:19:27 +0000998
John Kessenich69f4b512013-09-04 21:19:27 +0000999 //
1000 // Per-shader processing...
1001 //
1002
John Kessenich5b0f13a2013-11-01 03:08:40 +00001003 glslang::TProgram& program = *new glslang::TProgram;
rdb32084e82016-02-23 22:17:38 +01001004 for (auto it = compUnits.cbegin(); it != compUnits.cend(); ++it) {
1005 const auto &compUnit = *it;
John Kessenichc57b2a92016-01-16 15:30:03 -07001006 glslang::TShader* shader = new glslang::TShader(compUnit.stage);
John Kessenich04acb1b2017-06-14 17:36:50 -06001007 shader->setStringsWithLengthsAndNames(compUnit.text, NULL, compUnit.fileNameList, compUnit.count);
John Kessenich640bd092018-08-09 14:15:00 -06001008 if (entryPointName)
John Kessenich4d65ee32016-03-12 18:17:47 -07001009 shader->setEntryPoint(entryPointName);
John Kessenich3693e632017-09-29 17:51:52 -06001010 if (sourceEntryPointName) {
1011 if (entryPointName == nullptr)
1012 printf("Warning: Changing source entry point name without setting an entry-point name.\n"
1013 "Use '-e <name>'.\n");
steve-lunargf1e0c872016-10-31 15:13:43 -06001014 shader->setSourceEntryPoint(sourceEntryPointName);
John Kessenich3693e632017-09-29 17:51:52 -06001015 }
John Kessenicha9313662017-06-15 10:40:49 -06001016 if (UserPreamble.isSet())
1017 shader->setPreamble(UserPreamble.get());
John Kessenich2a271162017-07-20 20:00:36 -06001018 shader->addProcesses(Processes);
steve-lunarg7f7c2ed2016-09-07 15:20:19 -06001019
John Kessenich155d3512019-08-08 23:29:20 -06001020#ifndef GLSLANG_WEB
LoopDawg08a14422017-10-17 19:27:14 -06001021 // Set IO mapper binding shift values
1022 for (int r = 0; r < glslang::EResCount; ++r) {
1023 const glslang::TResourceType res = glslang::TResourceType(r);
1024
1025 // Set base bindings
1026 shader->setShiftBinding(res, baseBinding[res][compUnit.stage]);
David Neto8c3d5b42019-10-21 14:50:31 -04001027
LoopDawg08a14422017-10-17 19:27:14 -06001028 // Set bindings for particular resource sets
1029 // TODO: use a range based for loop here, when available in all environments.
1030 for (auto i = baseBindingForSet[res][compUnit.stage].begin();
1031 i != baseBindingForSet[res][compUnit.stage].end(); ++i)
LoopDawge5709552017-10-21 10:46:39 -06001032 shader->setShiftBindingForSet(res, i->second, i->first);
LoopDawg08a14422017-10-17 19:27:14 -06001033 }
steve-lunargcce8d482016-10-14 18:36:42 -06001034 shader->setNoStorageFormat((Options & EOptionNoStorageFormat) != 0);
Hyangran Park36dc8292017-05-02 16:27:29 +09001035 shader->setResourceSetBinding(baseResourceSetBinding[compUnit.stage]);
steve-lunarg7f7c2ed2016-09-07 15:20:19 -06001036
1037 if (Options & EOptionAutoMapBindings)
1038 shader->setAutoMapBindings(true);
John Kessenichecba76f2017-01-06 00:34:48 -07001039
John Kessenich71facdf2017-05-17 18:28:19 -06001040 if (Options & EOptionAutoMapLocations)
1041 shader->setAutoMapLocations(true);
1042
Neil Roberts16f53472018-03-20 17:30:53 +01001043 for (auto& uniOverride : uniformLocationOverrides) {
1044 shader->addUniformLocationOverride(uniOverride.first.c_str(),
1045 uniOverride.second);
1046 }
1047
Neil Robertsb0f3d792018-03-20 17:41:05 +01001048 shader->setUniformLocationBase(uniformBase);
John Kessenich155d3512019-08-08 23:29:20 -06001049#endif
1050
1051 shader->setNanMinMaxClamp(NaNClamp);
1052
1053#ifdef ENABLE_HLSL
1054 shader->setFlattenUniformArrays((Options & EOptionFlattenUniformArrays) != 0);
1055 if (Options & EOptionHlslIoMapping)
1056 shader->setHlslIoMapping(true);
1057#endif
1058
1059 if (Options & EOptionInvertY)
1060 shader->setInvertY(true);
Neil Robertsb0f3d792018-03-20 17:41:05 +01001061
John Kessenich4be4aeb2017-06-23 10:50:22 -06001062 // Set up the environment, some subsettings take precedence over earlier
1063 // ways of setting things.
1064 if (Options & EOptionSpv) {
John Kessenich8717a5d2018-10-26 10:12:32 -06001065 shader->setEnvInput((Options & EOptionReadHlsl) ? glslang::EShSourceHlsl
1066 : glslang::EShSourceGlsl,
1067 compUnit.stage, Client, ClientInputSemanticsVersion);
1068 shader->setEnvClient(Client, ClientVersion);
1069 shader->setEnvTarget(TargetLanguage, TargetVersion);
John Kessenichd4ed5152019-07-27 05:22:30 -06001070#ifdef ENABLE_HLSL
John Kessenich5d610ee2018-03-07 18:05:55 -07001071 if (targetHlslFunctionality1)
1072 shader->setEnvTargetHlslFunctionality1();
John Kessenichd4ed5152019-07-27 05:22:30 -06001073#endif
John Kessenich4be4aeb2017-06-23 10:50:22 -06001074 }
1075
John Kessenich69f4b512013-09-04 21:19:27 +00001076 shaders.push_back(shader);
John Kessenichb3297152015-07-11 18:01:03 -06001077
John Kessenich4be4aeb2017-06-23 10:50:22 -06001078 const int defaultVersion = Options & EOptionDefaultDesktop ? 110 : 100;
John Kessenich69f4b512013-09-04 21:19:27 +00001079
John Kessenich3494b4d2017-05-22 15:00:42 -06001080 DirStackFileIncluder includer;
John Kessenich971a0a82017-06-07 15:06:58 -06001081 std::for_each(IncludeDirectoryList.rbegin(), IncludeDirectoryList.rend(), [&includer](const std::string& dir) {
1082 includer.pushExternalLocalDirectory(dir); });
John Kessenichdeec1932019-08-13 08:00:30 -06001083#ifndef GLSLANG_WEB
John Kessenichc555ddd2015-06-17 02:38:44 +00001084 if (Options & EOptionOutputPreprocessed) {
1085 std::string str;
John Kessenich086febc2018-10-25 12:43:02 -06001086 if (shader->preprocess(&Resources, defaultVersion, ENoProfile, false, false, messages, &str, includer)) {
Andrew Woloszynaae1ad82015-06-24 17:00:46 -04001087 PutsIfNonEmpty(str.c_str());
1088 } else {
1089 CompileFailed = true;
1090 }
1091 StderrIfNonEmpty(shader->getInfoLog());
1092 StderrIfNonEmpty(shader->getInfoDebugLog());
John Kessenichc555ddd2015-06-17 02:38:44 +00001093 continue;
1094 }
John Kessenichdeec1932019-08-13 08:00:30 -06001095#endif
John Kessenich086febc2018-10-25 12:43:02 -06001096
John Kessenich3494b4d2017-05-22 15:00:42 -06001097 if (! shader->parse(&Resources, defaultVersion, false, messages, includer))
John Kessenichc999ba22013-11-07 23:33:24 +00001098 CompileFailed = true;
John Kessenichc555ddd2015-06-17 02:38:44 +00001099
John Kessenich69f4b512013-09-04 21:19:27 +00001100 program.addShader(shader);
1101
John Kessenichc57b2a92016-01-16 15:30:03 -07001102 if (! (Options & EOptionSuppressInfolog) &&
1103 ! (Options & EOptionMemoryLeakMode)) {
John Kessenich04acb1b2017-06-14 17:36:50 -06001104 PutsIfNonEmpty(compUnit.fileName[0].c_str());
Andrew Woloszynaae1ad82015-06-24 17:00:46 -04001105 PutsIfNonEmpty(shader->getInfoLog());
1106 PutsIfNonEmpty(shader->getInfoDebugLog());
John Kessenich69f4b512013-09-04 21:19:27 +00001107 }
John Kessenich69f4b512013-09-04 21:19:27 +00001108 }
1109
1110 //
1111 // Program-level processing...
1112 //
1113
John Kessenich4d65ee32016-03-12 18:17:47 -07001114 // Link
John Kessenich68d78fd2015-07-12 19:28:10 -06001115 if (! (Options & EOptionOutputPreprocessed) && ! program.link(messages))
John Kessenichc999ba22013-11-07 23:33:24 +00001116 LinkFailed = true;
1117
John Kessenichb6d3ee52019-08-06 02:20:45 -06001118#ifndef GLSLANG_WEB
steve-lunarg9ae34742016-10-05 13:40:13 -06001119 // Map IO
1120 if (Options & EOptionSpv) {
1121 if (!program.mapIO())
1122 LinkFailed = true;
1123 }
John Kessenichb6d3ee52019-08-06 02:20:45 -06001124#endif
John Kessenichecba76f2017-01-06 00:34:48 -07001125
John Kessenich4d65ee32016-03-12 18:17:47 -07001126 // Report
John Kessenichc57b2a92016-01-16 15:30:03 -07001127 if (! (Options & EOptionSuppressInfolog) &&
1128 ! (Options & EOptionMemoryLeakMode)) {
Andrew Woloszynaae1ad82015-06-24 17:00:46 -04001129 PutsIfNonEmpty(program.getInfoLog());
1130 PutsIfNonEmpty(program.getInfoDebugLog());
John Kessenich69f4b512013-09-04 21:19:27 +00001131 }
1132
John Kessenichb6d3ee52019-08-06 02:20:45 -06001133#ifndef GLSLANG_WEB
John Kessenich4d65ee32016-03-12 18:17:47 -07001134 // Reflect
John Kessenich11f9fc72013-11-07 01:06:34 +00001135 if (Options & EOptionDumpReflection) {
baldurk6d477852019-01-29 15:45:56 +00001136 program.buildReflection(ReflectOptions);
John Kessenich11f9fc72013-11-07 01:06:34 +00001137 program.dumpReflection();
1138 }
John Kessenichb6d3ee52019-08-06 02:20:45 -06001139#endif
John Kessenich11f9fc72013-11-07 01:06:34 +00001140
John Kessenich4d65ee32016-03-12 18:17:47 -07001141 // Dump SPIR-V
John Kessenich0df0cde2015-03-03 17:09:43 +00001142 if (Options & EOptionSpv) {
John Kessenich92f90382014-07-28 04:21:04 +00001143 if (CompileFailed || LinkFailed)
John Kessenich68d78fd2015-07-12 19:28:10 -06001144 printf("SPIR-V is not generated for failed compile or link\n");
John Kessenich92f90382014-07-28 04:21:04 +00001145 else {
1146 for (int stage = 0; stage < EShLangCount; ++stage) {
John Kessenicha7a68a92014-08-24 18:21:00 +00001147 if (program.getIntermediate((EShLanguage)stage)) {
John Kessenich0df0cde2015-03-03 17:09:43 +00001148 std::vector<unsigned int> spirv;
Lei Zhang17535f72016-05-04 15:55:59 -04001149 spv::SpvBuildLogger logger;
John Kessenich121853f2017-05-31 17:11:16 -06001150 glslang::SpvOptions spvOptions;
1151 if (Options & EOptionDebug)
1152 spvOptions.generateDebugInfo = true;
GregF52fe3d52017-09-28 10:08:32 -06001153 spvOptions.disableOptimizer = (Options & EOptionOptimizeDisable) != 0;
1154 spvOptions.optimizeSize = (Options & EOptionOptimizeSize) != 0;
John Kessenich717c80a2018-08-23 15:17:10 -06001155 spvOptions.disassemble = SpvToolsDisassembler;
John Kessenichc3404252018-08-23 15:29:08 -06001156 spvOptions.validate = SpvToolsValidate;
John Kessenich121853f2017-05-31 17:11:16 -06001157 glslang::GlslangToSpv(*program.getIntermediate((EShLanguage)stage), spirv, &logger, &spvOptions);
John Kessenichc57b2a92016-01-16 15:30:03 -07001158
1159 // Dump the spv to a file or stdout, etc., but only if not doing
1160 // memory/perf testing, as it's not internal to programmatic use.
1161 if (! (Options & EOptionMemoryLeakMode)) {
Johannes van Waverenecb0f3b2016-05-27 12:55:53 -05001162 printf("%s", logger.getAllMessages().c_str());
1163 if (Options & EOptionOutputHexadecimal) {
John Kessenich8f674e82017-02-18 09:45:40 -07001164 glslang::OutputSpvHex(spirv, GetBinaryName((EShLanguage)stage), variableName);
Johannes van Waverenecb0f3b2016-05-27 12:55:53 -05001165 } else {
1166 glslang::OutputSpvBin(spirv, GetBinaryName((EShLanguage)stage));
1167 }
John Kessenich23d27752019-07-28 02:12:10 -06001168#ifndef GLSLANG_WEB
John Kesseniche2156222018-06-11 18:12:15 -06001169 if (!SpvToolsDisassembler && (Options & EOptionHumanReadableSpv))
John Kessenichc57b2a92016-01-16 15:30:03 -07001170 spv::Disassemble(std::cout, spirv);
John Kessenich23d27752019-07-28 02:12:10 -06001171#endif
John Kessenichacba7722015-03-04 03:48:38 +00001172 }
John Kessenicha7a68a92014-08-24 18:21:00 +00001173 }
John Kessenich92f90382014-07-28 04:21:04 +00001174 }
1175 }
1176 }
1177
John Kessenich5b0f13a2013-11-01 03:08:40 +00001178 // Free everything up, program has to go before the shaders
1179 // because it might have merged stuff from the shaders, and
1180 // the stuff from the shaders has to have its destructors called
1181 // before the pools holding the memory in the shaders is freed.
1182 delete &program;
John Kessenich69f4b512013-09-04 21:19:27 +00001183 while (shaders.size() > 0) {
1184 delete shaders.back();
1185 shaders.pop_back();
1186 }
John Kessenich69f4b512013-09-04 21:19:27 +00001187}
1188
John Kessenichc57b2a92016-01-16 15:30:03 -07001189//
1190// Do file IO part of compile and link, handing off the pure
1191// API/programmatic mode to CompileAndLinkShaderUnits(), which can
1192// be put in a loop for testing memory footprint and performance.
1193//
1194// This is just for linking mode: meaning all the shaders will be put into the
1195// the same program linked together.
1196//
1197// This means there are a limited number of work items (not multi-threading mode)
1198// and that the point is testing at the linking level. Hence, to enable
1199// performance and memory testing, the actual compile/link can be put in
1200// a loop, independent of processing the work items and file IO.
1201//
Juan Lopeza558b262017-04-02 23:04:00 +02001202void CompileAndLinkShaderFiles(glslang::TWorklist& Worklist)
John Kessenichc57b2a92016-01-16 15:30:03 -07001203{
1204 std::vector<ShaderCompUnit> compUnits;
1205
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001206 // If this is using stdin, we can't really detect multiple different file
1207 // units by input type. We need to assume that we're just being given one
1208 // file of a certain type.
1209 if ((Options & EOptionStdin) != 0) {
1210 ShaderCompUnit compUnit(FindLanguage("stdin"));
1211 std::istreambuf_iterator<char> begin(std::cin), end;
1212 std::string tempString(begin, end);
1213 char* fileText = strdup(tempString.c_str());
1214 std::string fileName = "stdin";
1215 compUnit.addString(fileName, fileText);
John Kessenichc57b2a92016-01-16 15:30:03 -07001216 compUnits.push_back(compUnit);
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001217 } else {
1218 // Transfer all the work items from to a simple list of
1219 // of compilation units. (We don't care about the thread
1220 // work-item distribution properties in this path, which
1221 // is okay due to the limited number of shaders, know since
1222 // they are all getting linked together.)
1223 glslang::TWorkItem* workItem;
1224 while (Worklist.remove(workItem)) {
1225 ShaderCompUnit compUnit(FindLanguage(workItem->name));
1226 char* fileText = ReadFileData(workItem->name.c_str());
1227 if (fileText == nullptr)
1228 usage();
1229 compUnit.addString(workItem->name, fileText);
1230 compUnits.push_back(compUnit);
1231 }
John Kessenichc57b2a92016-01-16 15:30:03 -07001232 }
1233
1234 // Actual call to programmatic processing of compile and link,
1235 // in a loop for testing memory and performance. This part contains
1236 // all the perf/memory that a programmatic consumer will care about.
1237 for (int i = 0; i < ((Options & EOptionMemoryLeakMode) ? 100 : 1); ++i) {
1238 for (int j = 0; j < ((Options & EOptionMemoryLeakMode) ? 100 : 1); ++j)
1239 CompileAndLinkShaderUnits(compUnits);
1240
1241 if (Options & EOptionMemoryLeakMode)
1242 glslang::OS_DumpMemoryCounters();
1243 }
1244
John Kessenicha9313662017-06-15 10:40:49 -06001245 // free memory from ReadFileData, which got stored in a const char*
1246 // as the first string above
rdb32084e82016-02-23 22:17:38 +01001247 for (auto it = compUnits.begin(); it != compUnits.end(); ++it)
John Kessenicha9313662017-06-15 10:40:49 -06001248 FreeFileData(const_cast<char*>(it->text[0]));
John Kessenichc57b2a92016-01-16 15:30:03 -07001249}
1250
John Kessenich94f28eb2017-11-13 01:32:06 -07001251int singleMain()
John Kessenicha0af4732012-12-12 21:15:54 +00001252{
Juan Lopeza558b262017-04-02 23:04:00 +02001253 glslang::TWorklist workList;
John Kessenich94f28eb2017-11-13 01:32:06 -07001254 std::for_each(WorkItems.begin(), WorkItems.end(), [&workList](std::unique_ptr<glslang::TWorkItem>& item) {
Juan Lopeza558b262017-04-02 23:04:00 +02001255 assert(item);
1256 workList.add(item.get());
1257 });
John Kessenich2b07c7e2013-07-31 18:44:13 +00001258
John Kessenich23d27752019-07-28 02:12:10 -06001259#ifndef GLSLANG_WEB
John Kessenich05a70632013-09-17 19:26:08 +00001260 if (Options & EOptionDumpConfig) {
Lei Zhang414eb602016-03-04 16:22:34 -05001261 printf("%s", glslang::GetDefaultTBuiltInResourceString().c_str());
Juan Lopeza558b262017-04-02 23:04:00 +02001262 if (workList.empty())
John Kessenich05a70632013-09-17 19:26:08 +00001263 return ESuccess;
1264 }
John Kessenich23d27752019-07-28 02:12:10 -06001265#endif
John Kessenich05a70632013-09-17 19:26:08 +00001266
John Kessenichc6c80a62018-03-05 22:23:17 -07001267 if (Options & EOptionDumpBareVersion) {
1268 printf("%d.%d.%d\n",
1269 glslang::GetSpirvGeneratorVersion(), GLSLANG_MINOR_VERSION, GLSLANG_PATCH_LEVEL);
1270 if (workList.empty())
1271 return ESuccess;
1272 } else if (Options & EOptionDumpVersions) {
1273 printf("Glslang Version: %d.%d.%d\n",
1274 glslang::GetSpirvGeneratorVersion(), GLSLANG_MINOR_VERSION, GLSLANG_PATCH_LEVEL);
John Kessenich319de232013-12-04 04:43:40 +00001275 printf("ESSL Version: %s\n", glslang::GetEsslVersionString());
1276 printf("GLSL Version: %s\n", glslang::GetGlslVersionString());
John Kessenich68d78fd2015-07-12 19:28:10 -06001277 std::string spirvVersion;
1278 glslang::GetSpirvVersion(spirvVersion);
John Kessenich0da9eaa2015-08-01 17:10:02 -06001279 printf("SPIR-V Version %s\n", spirvVersion.c_str());
John Kessenich5e4b1242015-08-06 22:53:06 -06001280 printf("GLSL.std.450 Version %d, Revision %d\n", GLSLstd450Version, GLSLstd450Revision);
John Kessenich55e7d112015-11-15 21:33:39 -07001281 printf("Khronos Tool ID %d\n", glslang::GetKhronosToolId());
John Kessenicha372a3e2017-11-02 22:32:14 -06001282 printf("SPIR-V Generator Version %d\n", glslang::GetSpirvGeneratorVersion());
John Kessenichb84313d2016-07-20 16:03:29 -06001283 printf("GL_KHR_vulkan_glsl version %d\n", 100);
1284 printf("ARB_GL_gl_spirv version %d\n", 100);
Juan Lopeza558b262017-04-02 23:04:00 +02001285 if (workList.empty())
John Kessenich319de232013-12-04 04:43:40 +00001286 return ESuccess;
1287 }
1288
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001289 if (workList.empty() && ((Options & EOptionStdin) == 0)) {
John Kessenich05a70632013-09-17 19:26:08 +00001290 usage();
John Kessenich05a70632013-09-17 19:26:08 +00001291 }
1292
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001293 if (Options & EOptionStdin) {
John Kessenich94f28eb2017-11-13 01:32:06 -07001294 WorkItems.push_back(std::unique_ptr<glslang::TWorkItem>{new glslang::TWorkItem("stdin")});
1295 workList.add(WorkItems.back().get());
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001296 }
1297
John Kessenich05a70632013-09-17 19:26:08 +00001298 ProcessConfigFile();
1299
John Kessenich086febc2018-10-25 12:43:02 -06001300 if ((Options & EOptionReadHlsl) && !((Options & EOptionOutputPreprocessed) || (Options & EOptionSpv)))
John Kessenichbd97b6f2019-12-20 10:33:13 -07001301 Error("HLSL requires SPIR-V code generation (or preprocessing only)");
John Kessenich086febc2018-10-25 12:43:02 -06001302
John Kessenich69f4b512013-09-04 21:19:27 +00001303 //
1304 // Two modes:
John Kessenich38f3b892013-09-06 19:52:57 +00001305 // 1) linking all arguments together, single-threaded, new C++ interface
1306 // 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 +00001307 //
John Kessenich086febc2018-10-25 12:43:02 -06001308 if (Options & (EOptionLinkProgram | EOptionOutputPreprocessed)) {
John Kessenichc36e1d82013-11-01 17:41:52 +00001309 glslang::InitializeProcess();
John Kesseniche2c15b42017-11-16 22:48:41 -07001310 glslang::InitializeProcess(); // also test reference counting of users
1311 glslang::InitializeProcess(); // also test reference counting of users
1312 glslang::FinalizeProcess(); // also test reference counting of users
1313 glslang::FinalizeProcess(); // also test reference counting of users
Juan Lopeza558b262017-04-02 23:04:00 +02001314 CompileAndLinkShaderFiles(workList);
John Kessenichc36e1d82013-11-01 17:41:52 +00001315 glslang::FinalizeProcess();
1316 } else {
1317 ShInitialize();
John Kesseniche2c15b42017-11-16 22:48:41 -07001318 ShInitialize(); // also test reference counting of users
1319 ShFinalize(); // also test reference counting of users
John Kessenichc36e1d82013-11-01 17:41:52 +00001320
Juan Lopeza558b262017-04-02 23:04:00 +02001321 bool printShaderNames = workList.size() > 1;
John Kessenich69f4b512013-09-04 21:19:27 +00001322
John Kesseniche2c15b42017-11-16 22:48:41 -07001323 if (Options & EOptionMultiThreaded) {
Juan Lopeza558b262017-04-02 23:04:00 +02001324 std::array<std::thread, 16> threads;
John Kesseniche2c15b42017-11-16 22:48:41 -07001325 for (unsigned int t = 0; t < threads.size(); ++t) {
Juan Lopeza558b262017-04-02 23:04:00 +02001326 threads[t] = std::thread(CompileShaders, std::ref(workList));
John Kesseniche2c15b42017-11-16 22:48:41 -07001327 if (threads[t].get_id() == std::thread::id()) {
John Kessenichaf527992017-11-02 22:48:15 -06001328 fprintf(stderr, "Failed to create thread\n");
John Kessenich38f3b892013-09-06 19:52:57 +00001329 return EFailThreadCreate;
1330 }
John Kessenicha0af4732012-12-12 21:15:54 +00001331 }
Juan Lopeza558b262017-04-02 23:04:00 +02001332
1333 std::for_each(threads.begin(), threads.end(), [](std::thread& t) { t.join(); });
John Kessenichc999ba22013-11-07 23:33:24 +00001334 } else
Juan Lopeza558b262017-04-02 23:04:00 +02001335 CompileShaders(workList);
John Kessenich38f3b892013-09-06 19:52:57 +00001336
1337 // Print out all the resulting infologs
John Kessenich94f28eb2017-11-13 01:32:06 -07001338 for (size_t w = 0; w < WorkItems.size(); ++w) {
1339 if (WorkItems[w]) {
1340 if (printShaderNames || WorkItems[w]->results.size() > 0)
1341 PutsIfNonEmpty(WorkItems[w]->name.c_str());
1342 PutsIfNonEmpty(WorkItems[w]->results.c_str());
John Kessenich38f3b892013-09-06 19:52:57 +00001343 }
1344 }
John Kessenichc36e1d82013-11-01 17:41:52 +00001345
1346 ShFinalize();
John Kessenicha0af4732012-12-12 21:15:54 +00001347 }
John Kessenich2b07c7e2013-07-31 18:44:13 +00001348
John Kessenichc999ba22013-11-07 23:33:24 +00001349 if (CompileFailed)
John Kessenicha0af4732012-12-12 21:15:54 +00001350 return EFailCompile;
John Kessenichc999ba22013-11-07 23:33:24 +00001351 if (LinkFailed)
John Kessenicha0af4732012-12-12 21:15:54 +00001352 return EFailLink;
1353
1354 return 0;
1355}
1356
John Kessenich94f28eb2017-11-13 01:32:06 -07001357int C_DECL main(int argc, char* argv[])
1358{
1359 ProcessArguments(WorkItems, argc, argv);
1360
1361 int ret = 0;
1362
1363 // Loop over the entire init/finalize cycle to watch memory changes
1364 const int iterations = 1;
1365 if (iterations > 1)
1366 glslang::OS_DumpMemoryCounters();
1367 for (int i = 0; i < iterations; ++i) {
1368 ret = singleMain();
1369 if (iterations > 1)
1370 glslang::OS_DumpMemoryCounters();
1371 }
1372
1373 return ret;
1374}
1375
John Kessenicha0af4732012-12-12 21:15:54 +00001376//
1377// Deduce the language from the filename. Files must end in one of the
1378// following extensions:
1379//
John Kessenich2b07c7e2013-07-31 18:44:13 +00001380// .vert = vertex
1381// .tesc = tessellation control
1382// .tese = tessellation evaluation
1383// .geom = geometry
1384// .frag = fragment
John Kessenich94a81fb2013-08-31 02:41:30 +00001385// .comp = compute
Chao Chenb50c02e2018-09-19 11:42:24 -07001386// .rgen = ray generation
1387// .rint = ray intersection
1388// .rahit = ray any hit
1389// .rchit = ray closest hit
1390// .rmiss = ray miss
1391// .rcall = ray callable
Sahil Parmar035cbbe2018-10-04 16:39:18 -07001392// .mesh = mesh
1393// .task = task
Grigory Dzhavadyan33507412018-04-12 14:35:24 -07001394// Additionally, the file names may end in .<stage>.glsl and .<stage>.hlsl
1395// where <stage> is one of the stages listed above.
1396//
1397EShLanguage FindLanguage(const std::string& name, bool parseStageName)
John Kessenicha0af4732012-12-12 21:15:54 +00001398{
John Kessenichfccbb8b2018-04-17 17:24:03 -06001399 std::string stageName;
Dan Bakerc6ede892016-08-11 14:06:06 -04001400 if (shaderStageName)
John Kessenichfccbb8b2018-04-17 17:24:03 -06001401 stageName = shaderStageName;
1402 else if (parseStageName) {
Grigory Dzhavadyan33507412018-04-12 14:35:24 -07001403 // Note: "first" extension means "first from the end", i.e.
1404 // if the file is named foo.vert.glsl, then "glsl" is first,
1405 // "vert" is second.
John Kessenichfccbb8b2018-04-17 17:24:03 -06001406 size_t firstExtStart = name.find_last_of(".");
1407 bool hasFirstExt = firstExtStart != std::string::npos;
1408 size_t secondExtStart = hasFirstExt ? name.find_last_of(".", firstExtStart - 1) : std::string::npos;
1409 bool hasSecondExt = secondExtStart != std::string::npos;
1410 std::string firstExt = name.substr(firstExtStart + 1, std::string::npos);
1411 bool usesUnifiedExt = hasFirstExt && (firstExt == "glsl" || firstExt == "hlsl");
John Kessenich3beac942018-04-17 21:02:19 -06001412 if (usesUnifiedExt && firstExt == "hlsl")
1413 Options |= EOptionReadHlsl;
1414 if (hasFirstExt && !usesUnifiedExt)
John Kessenichfccbb8b2018-04-17 17:24:03 -06001415 stageName = firstExt;
John Kessenich3beac942018-04-17 21:02:19 -06001416 else if (usesUnifiedExt && hasSecondExt)
John Kessenichfccbb8b2018-04-17 17:24:03 -06001417 stageName = name.substr(secondExtStart + 1, firstExtStart - secondExtStart - 1);
John Kessenich3beac942018-04-17 21:02:19 -06001418 else {
Grigory Dzhavadyan33507412018-04-12 14:35:24 -07001419 usage();
1420 return EShLangVertex;
John Kesseniche751bca2017-03-16 11:20:38 -06001421 }
John Kessenichfccbb8b2018-04-17 17:24:03 -06001422 } else
1423 stageName = name;
dankbaker45d49bc2016-08-08 21:43:07 -04001424
John Kessenichfccbb8b2018-04-17 17:24:03 -06001425 if (stageName == "vert")
John Kessenich2b07c7e2013-07-31 18:44:13 +00001426 return EShLangVertex;
John Kessenichfccbb8b2018-04-17 17:24:03 -06001427 else if (stageName == "tesc")
John Kessenich2b07c7e2013-07-31 18:44:13 +00001428 return EShLangTessControl;
John Kessenichfccbb8b2018-04-17 17:24:03 -06001429 else if (stageName == "tese")
John Kessenich2b07c7e2013-07-31 18:44:13 +00001430 return EShLangTessEvaluation;
John Kessenichfccbb8b2018-04-17 17:24:03 -06001431 else if (stageName == "geom")
John Kessenich2b07c7e2013-07-31 18:44:13 +00001432 return EShLangGeometry;
John Kessenichfccbb8b2018-04-17 17:24:03 -06001433 else if (stageName == "frag")
John Kessenich2b07c7e2013-07-31 18:44:13 +00001434 return EShLangFragment;
John Kessenichfccbb8b2018-04-17 17:24:03 -06001435 else if (stageName == "comp")
John Kessenichc0275792013-08-09 17:14:49 +00001436 return EShLangCompute;
Chao Chenb50c02e2018-09-19 11:42:24 -07001437 else if (stageName == "rgen")
Daniel Kochdb32b242020-03-17 20:42:47 -04001438 return EShLangRayGen;
Chao Chenb50c02e2018-09-19 11:42:24 -07001439 else if (stageName == "rint")
Daniel Kochdb32b242020-03-17 20:42:47 -04001440 return EShLangIntersect;
Chao Chenb50c02e2018-09-19 11:42:24 -07001441 else if (stageName == "rahit")
Daniel Kochdb32b242020-03-17 20:42:47 -04001442 return EShLangAnyHit;
Chao Chenb50c02e2018-09-19 11:42:24 -07001443 else if (stageName == "rchit")
Daniel Kochdb32b242020-03-17 20:42:47 -04001444 return EShLangClosestHit;
Chao Chenb50c02e2018-09-19 11:42:24 -07001445 else if (stageName == "rmiss")
Daniel Kochdb32b242020-03-17 20:42:47 -04001446 return EShLangMiss;
Chao Chenb50c02e2018-09-19 11:42:24 -07001447 else if (stageName == "rcall")
Daniel Kochdb32b242020-03-17 20:42:47 -04001448 return EShLangCallable;
Chao Chen3c366992018-09-19 11:41:59 -07001449 else if (stageName == "mesh")
1450 return EShLangMeshNV;
1451 else if (stageName == "task")
1452 return EShLangTaskNV;
John Kessenich2b07c7e2013-07-31 18:44:13 +00001453
1454 usage();
John Kesseniche95ecc52012-12-12 21:34:14 +00001455 return EShLangVertex;
John Kessenicha0af4732012-12-12 21:15:54 +00001456}
1457
John Kessenicha0af4732012-12-12 21:15:54 +00001458//
John Kessenichecba76f2017-01-06 00:34:48 -07001459// Read a file's data into a string, and compile it using the old interface ShCompile,
John Kessenich69f4b512013-09-04 21:19:27 +00001460// for non-linkable results.
John Kessenicha0af4732012-12-12 21:15:54 +00001461//
John Kessenich51cdd902014-02-18 23:37:57 +00001462void CompileFile(const char* fileName, ShHandle compiler)
John Kessenicha0af4732012-12-12 21:15:54 +00001463{
John Kessenichca3457f2015-05-18 01:59:45 +00001464 int ret = 0;
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001465 char* shaderString;
1466 if ((Options & EOptionStdin) != 0) {
1467 std::istreambuf_iterator<char> begin(std::cin), end;
1468 std::string tempString(begin, end);
1469 shaderString = strdup(tempString.c_str());
1470 } else {
1471 shaderString = ReadFileData(fileName);
1472 }
John Kessenich41cf6b52013-06-25 18:10:05 +00001473
1474 // move to length-based strings, rather than null-terminated strings
John Kessenich04acb1b2017-06-14 17:36:50 -06001475 int* lengths = new int[1];
1476 lengths[0] = (int)strlen(shaderString);
John Kessenicha0af4732012-12-12 21:15:54 +00001477
John Kessenich52ac67e2013-05-05 23:46:22 +00001478 EShMessages messages = EShMsgDefault;
John Kessenichb0a7eb52013-11-07 17:44:20 +00001479 SetMessageOptions(messages);
John Kessenichecba76f2017-01-06 00:34:48 -07001480
John Kessenicha9313662017-06-15 10:40:49 -06001481 if (UserPreamble.isSet())
1482 Error("-D and -U options require -l (linking)\n");
1483
John Kessenich94a81fb2013-08-31 02:41:30 +00001484 for (int i = 0; i < ((Options & EOptionMemoryLeakMode) ? 100 : 1); ++i) {
1485 for (int j = 0; j < ((Options & EOptionMemoryLeakMode) ? 100 : 1); ++j) {
John Kessenich927608b2017-01-06 12:34:14 -07001486 // ret = ShCompile(compiler, shaderStrings, NumShaderStrings, lengths, EShOptNone, &Resources, Options, (Options & EOptionDefaultDesktop) ? 110 : 100, false, messages);
John Kessenich04acb1b2017-06-14 17:36:50 -06001487 ret = ShCompile(compiler, &shaderString, 1, nullptr, EShOptNone, &Resources, Options, (Options & EOptionDefaultDesktop) ? 110 : 100, false, messages);
John Kessenich927608b2017-01-06 12:34:14 -07001488 // const char* multi[12] = { "# ve", "rsion", " 300 e", "s", "\n#err",
John Kessenichecba76f2017-01-06 00:34:48 -07001489 // "or should be l", "ine 1", "string 5\n", "float glo", "bal",
John Kessenichea869fb2013-10-28 18:12:06 +00001490 // ";\n#error should be line 2\n void main() {", "global = 2.3;}" };
John Kessenich927608b2017-01-06 12:34:14 -07001491 // const char* multi[7] = { "/", "/", "\\", "\n", "\n", "#", "version 300 es" };
1492 // ret = ShCompile(compiler, multi, 7, nullptr, EShOptNone, &Resources, Options, (Options & EOptionDefaultDesktop) ? 110 : 100, false, messages);
John Kessenich41cf6b52013-06-25 18:10:05 +00001493 }
John Kessenicha0af4732012-12-12 21:15:54 +00001494
John Kessenich94a81fb2013-08-31 02:41:30 +00001495 if (Options & EOptionMemoryLeakMode)
John Kessenich2b07c7e2013-07-31 18:44:13 +00001496 glslang::OS_DumpMemoryCounters();
John Kessenicha0af4732012-12-12 21:15:54 +00001497 }
John Kessenicha0af4732012-12-12 21:15:54 +00001498
John Kessenich41cf6b52013-06-25 18:10:05 +00001499 delete [] lengths;
John Kessenich04acb1b2017-06-14 17:36:50 -06001500 FreeFileData(shaderString);
John Kessenicha0af4732012-12-12 21:15:54 +00001501
John Kessenichc999ba22013-11-07 23:33:24 +00001502 if (ret == 0)
1503 CompileFailed = true;
John Kessenicha0af4732012-12-12 21:15:54 +00001504}
1505
John Kessenicha0af4732012-12-12 21:15:54 +00001506//
1507// print usage to stdout
1508//
1509void usage()
1510{
John Kessenich319de232013-12-04 04:43:40 +00001511 printf("Usage: glslangValidator [option]... [file]...\n"
1512 "\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001513 "'file' can end in .<stage> for auto-stage classification, where <stage> is:\n"
1514 " .conf to provide a config file that replaces the default configuration\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001515 " (see -c option below for generating a template)\n"
1516 " .vert for a vertex shader\n"
1517 " .tesc for a tessellation control shader\n"
1518 " .tese for a tessellation evaluation shader\n"
1519 " .geom for a geometry shader\n"
1520 " .frag for a fragment shader\n"
1521 " .comp for a compute shader\n"
Chao Chen3c366992018-09-19 11:41:59 -07001522 " .mesh for a mesh shader\n"
1523 " .task for a task shader\n"
Chao Chenb50c02e2018-09-19 11:42:24 -07001524 " .rgen for a ray generation shader\n"
1525 " .rint for a ray intersection shader\n"
1526 " .rahit for a ray any hit shader\n"
1527 " .rchit for a ray closest hit shader\n"
1528 " .rmiss for a ray miss shader\n"
Sahil Parmar035cbbe2018-10-04 16:39:18 -07001529 " .rcall for a ray callable shader\n"
John Kessenich2ead40f2018-04-17 17:44:11 -06001530 " .glsl for .vert.glsl, .tesc.glsl, ..., .comp.glsl compound suffixes\n"
1531 " .hlsl for .vert.hlsl, .tesc.hlsl, ..., .comp.hlsl compound suffixes\n"
John Kessenich319de232013-12-04 04:43:40 +00001532 "\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001533 "Options:\n"
1534 " -C cascading errors; risk crash from accumulation of error recoveries\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001535 " -D input is HLSL (this is the default when any suffix is .hlsl)\n"
John Kessenich6f988922020-01-07 07:03:11 -07001536 " -D<name[=def]> | --define-macro <name[=def]> | --D <name[=def]>\n"
1537 " define a pre-processor macro\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001538 " -E print pre-processed GLSL; cannot be used with -l;\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001539 " errors will appear on stderr\n"
John Kessenich6353d552017-06-23 11:11:09 -06001540 " -G[ver] create SPIR-V binary, under OpenGL semantics; turns on -l;\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001541 " default file name is <stage>.spv (-o overrides this);\n"
John Kessenich6353d552017-06-23 11:11:09 -06001542 " 'ver', when present, is the version of the input semantics,\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001543 " which will appear in #define GL_SPIRV ver;\n"
1544 " '--client opengl100' is the same as -G100;\n"
John Kessenich6353d552017-06-23 11:11:09 -06001545 " a '--target-env' for OpenGL will also imply '-G'\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001546 " -H print human readable form of SPIR-V; turns on -V\n"
John Kessenich971a0a82017-06-07 15:06:58 -06001547 " -I<dir> add dir to the include search path; includer's directory\n"
1548 " is searched first, followed by left-to-right order of -I\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001549 " -Od disables optimization; may cause illegal SPIR-V for HLSL\n"
1550 " -Os optimizes SPIR-V to minimize size\n"
John Kesseniche751bca2017-03-16 11:20:38 -06001551 " -S <stage> uses specified stage rather than parsing the file extension\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001552 " choices for <stage> are vert, tesc, tese, geom, frag, or comp\n"
John Kessenich6f988922020-01-07 07:03:11 -07001553 " -U<name> | --undef-macro <name> | --U <name>\n"
1554 " undefine a pre-processor macro\n"
John Kessenich6353d552017-06-23 11:11:09 -06001555 " -V[ver] create SPIR-V binary, under Vulkan semantics; turns on -l;\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001556 " default file name is <stage>.spv (-o overrides this)\n"
John Kessenich6353d552017-06-23 11:11:09 -06001557 " 'ver', when present, is the version of the input semantics,\n"
1558 " which will appear in #define VULKAN ver\n"
1559 " '--client vulkan100' is the same as -V100\n"
1560 " a '--target-env' for Vulkan will also imply '-V'\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001561 " -c configuration dump;\n"
1562 " creates the default configuration file (redirect to a .conf file)\n"
1563 " -d default to desktop (#version 110) when there is no shader #version\n"
1564 " (default is ES version 100)\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001565 " -e <name> | --entry-point <name>\n"
1566 " specify <name> as the entry-point function name\n"
John Kessenich5d610ee2018-03-07 18:05:55 -07001567 " -f{hlsl_functionality1}\n"
1568 " 'hlsl_functionality1' enables use of the\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001569 " SPV_GOOGLE_hlsl_functionality1 extension\n"
John Kessenich121853f2017-05-31 17:11:16 -06001570 " -g generate debug information\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001571 " -h print this usage message\n"
1572 " -i intermediate tree (glslang AST) is printed out\n"
1573 " -l link all input files together to form a single module\n"
1574 " -m memory leak mode\n"
John Kessenicha25530c2017-09-11 20:13:49 -06001575 " -o <file> save binary to <file>, requires a binary option (e.g., -V)\n"
John Kesseniche5c394b2019-07-02 09:32:48 -06001576 " -q dump reflection query database; requires -l for linking\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001577 " -r | --relaxed-errors"
1578 " relaxed GLSL semantic error-checking mode\n"
John Kessenichb63f4a32017-11-16 22:32:20 -07001579 " -s silence syntax and semantic error reporting\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001580 " -t multi-threaded mode\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001581 " -v | --version\n"
1582 " print version strings\n"
1583 " -w | --suppress-warnings\n"
1584 " suppress GLSL warnings, except as required by \"#extension : warn\"\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001585 " -x save binary output as text-based 32-bit hexadecimal numbers\n"
Neil Roberts16f53472018-03-20 17:30:53 +01001586 " -u<name>:<loc> specify a uniform location override for --aml\n"
Neil Robertsb0f3d792018-03-20 17:41:05 +01001587 " --uniform-base <base> set a base to use for generated uniform locations\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001588 " --auto-map-bindings | --amb automatically bind uniform variables\n"
1589 " without explicit bindings\n"
1590 " --auto-map-locations | --aml automatically locate input/output lacking\n"
1591 " 'location' (fragile, not cross stage)\n"
1592 " --client {vulkan<ver>|opengl<ver>} see -V and -G\n"
Christoph Kubisch412ff6e2019-04-13 22:57:33 +02001593 " --dump-builtin-symbols prints builtin symbol table prior each compile\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001594 " -dumpfullversion | -dumpversion print bare major.minor.patchlevel\n"
1595 " --flatten-uniform-arrays | --fua flatten uniform texture/sampler arrays to\n"
1596 " scalars\n"
1597 " --hlsl-offsets allow block offsets to follow HLSL rules\n"
1598 " works independently of source language\n"
1599 " --hlsl-iomap perform IO mapping in HLSL register space\n"
1600 " --hlsl-enable-16bit-types allow 16-bit types in SPIR-V for HLSL\n"
John Kessenich605afc72019-06-17 23:33:09 -06001601 " --hlsl-dx9-compatible interprets sampler declarations as a\n"
rdbb56e0e42020-06-02 08:30:50 +02001602 " texture/sampler combo like DirectX9 would,\n"
1603 " and recognizes DirectX9-specific semantics\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001604 " --invert-y | --iy invert position.Y output in vertex shader\n"
1605 " --keep-uncalled | --ku don't eliminate uncalled functions\n"
John Kessenich605afc72019-06-17 23:33:09 -06001606 " --nan-clamp favor non-NaN operand in min, max, and clamp\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001607 " --no-storage-format | --nsf use Unknown image format\n"
baldurk4513df92019-02-08 10:48:48 +00001608 " --reflect-strict-array-suffix use strict array suffix rules when\n"
1609 " reflecting\n"
baldurkedf82122019-01-29 15:49:00 +00001610 " --reflect-basic-array-suffix arrays of basic types will have trailing [0]\n"
baldurk4513df92019-02-08 10:48:48 +00001611 " --reflect-intermediate-io reflection includes inputs/outputs of linked\n"
1612 " shaders rather than just vertex/fragment\n"
1613 " --reflect-separate-buffers reflect buffer variables and blocks\n"
1614 " separately to uniforms\n"
1615 " --reflect-all-block-variables reflect all variables in blocks, whether\n"
1616 " inactive or active\n"
baldurk19050692019-02-11 11:50:24 +00001617 " --reflect-unwrap-io-blocks unwrap input/output blocks the same as\n"
1618 " uniform blocks\n"
LoopDawg52017192017-07-14 15:15:47 -06001619 " --resource-set-binding [stage] name set binding\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001620 " set descriptor set and binding for\n"
1621 " individual resources\n"
LoopDawg52017192017-07-14 15:15:47 -06001622 " --resource-set-binding [stage] set\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001623 " set descriptor set for all resources\n"
1624 " --rsb synonym for --resource-set-binding\n"
1625 " --shift-image-binding [stage] num\n"
1626 " base binding number for images (uav)\n"
1627 " --shift-image-binding [stage] [num set]...\n"
1628 " per-descriptor-set shift values\n"
1629 " --sib synonym for --shift-image-binding\n"
1630 " --shift-sampler-binding [stage] num\n"
1631 " base binding number for samplers\n"
1632 " --shift-sampler-binding [stage] [num set]...\n"
1633 " per-descriptor-set shift values\n"
1634 " --ssb synonym for --shift-sampler-binding\n"
1635 " --shift-ssbo-binding [stage] num base binding number for SSBOs\n"
1636 " --shift-ssbo-binding [stage] [num set]...\n"
1637 " per-descriptor-set shift values\n"
1638 " --sbb synonym for --shift-ssbo-binding\n"
1639 " --shift-texture-binding [stage] num\n"
1640 " base binding number for textures\n"
1641 " --shift-texture-binding [stage] [num set]...\n"
1642 " per-descriptor-set shift values\n"
1643 " --stb synonym for --shift-texture-binding\n"
1644 " --shift-uav-binding [stage] num base binding number for UAVs\n"
1645 " --shift-uav-binding [stage] [num set]...\n"
1646 " per-descriptor-set shift values\n"
1647 " --suavb synonym for --shift-uav-binding\n"
1648 " --shift-UBO-binding [stage] num base binding number for UBOs\n"
1649 " --shift-UBO-binding [stage] [num set]...\n"
1650 " per-descriptor-set shift values\n"
1651 " --sub synonym for --shift-UBO-binding\n"
1652 " --shift-cbuffer-binding | --scb synonyms for --shift-UBO-binding\n"
1653 " --spirv-dis output standard-form disassembly; works only\n"
1654 " when a SPIR-V generation option is also used\n"
John Kessenichc3404252018-08-23 15:29:08 -06001655 " --spirv-val execute the SPIRV-Tools validator\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001656 " --source-entrypoint <name> the given shader source function is\n"
1657 " renamed to be the <name> given in -e\n"
1658 " --sep synonym for --source-entrypoint\n"
1659 " --stdin read from stdin instead of from a file;\n"
1660 " requires providing the shader stage using -S\n"
John Kessenich273d3a52020-01-15 00:10:41 -07001661 " --target-env {vulkan1.0 | vulkan1.1 | vulkan1.2 | opengl | \n"
John Kessenich8317e6c2019-08-18 23:58:08 -06001662 " spirv1.0 | spirv1.1 | spirv1.2 | spirv1.3 | spirv1.4 | spirv1.5}\n"
John Kessenich273d3a52020-01-15 00:10:41 -07001663 " Set the execution environment that the\n"
1664 " generated code will be executed in.\n"
1665 " Defaults to:\n"
1666 " * vulkan1.0 under --client vulkan<ver>\n"
1667 " * opengl under --client opengl<ver>\n"
1668 " * spirv1.0 under --target-env vulkan1.0\n"
1669 " * spirv1.3 under --target-env vulkan1.1\n"
1670 " * spirv1.5 under --target-env vulkan1.2\n"
1671 " Multiple --target-env can be specified.\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001672 " --variable-name <name>\n"
1673 " --vn <name> creates a C header file that contains a\n"
1674 " uint32_t array named <name>\n"
1675 " initialized with the shader binary code\n"
John Kessenichb0a7eb52013-11-07 17:44:20 +00001676 );
John Kessenich68d78fd2015-07-12 19:28:10 -06001677
1678 exit(EFailUsage);
John Kessenicha0af4732012-12-12 21:15:54 +00001679}
1680
John Kessenich3ce4e592014-10-06 19:57:34 +00001681#if !defined _MSC_VER && !defined MINGW_HAS_SECURE_API
John Kessenichcfd643e2013-03-08 23:14:42 +00001682
1683#include <errno.h>
1684
1685int fopen_s(
1686 FILE** pFile,
John Kessenich51cdd902014-02-18 23:37:57 +00001687 const char* filename,
1688 const char* mode
John Kessenichcfd643e2013-03-08 23:14:42 +00001689)
1690{
1691 if (!pFile || !filename || !mode) {
1692 return EINVAL;
1693 }
1694
1695 FILE* f = fopen(filename, mode);
1696 if (! f) {
1697 if (errno != 0) {
1698 return errno;
1699 } else {
1700 return ENOENT;
1701 }
1702 }
1703 *pFile = f;
1704
1705 return 0;
1706}
1707
1708#endif
1709
John Kessenicha0af4732012-12-12 21:15:54 +00001710//
1711// Malloc a string of sufficient size and read a string into it.
1712//
John Kessenich04acb1b2017-06-14 17:36:50 -06001713char* ReadFileData(const char* fileName)
John Kessenicha0af4732012-12-12 21:15:54 +00001714{
John Kessenichb3297152015-07-11 18:01:03 -06001715 FILE *in = nullptr;
John Kessenich3ce4e592014-10-06 19:57:34 +00001716 int errorCode = fopen_s(&in, fileName, "r");
John Kessenich68d78fd2015-07-12 19:28:10 -06001717 if (errorCode || in == nullptr)
1718 Error("unable to open input file");
John Kessenichecba76f2017-01-06 00:34:48 -07001719
John Kessenich04acb1b2017-06-14 17:36:50 -06001720 int count = 0;
John Kessenicha0af4732012-12-12 21:15:54 +00001721 while (fgetc(in) != EOF)
1722 count++;
1723
John Kessenichd6c72a42014-08-18 19:42:35 +00001724 fseek(in, 0, SEEK_SET);
John Kessenichca3457f2015-05-18 01:59:45 +00001725
John Kessenich04acb1b2017-06-14 17:36:50 -06001726 char* return_data = (char*)malloc(count + 1); // freed in FreeFileData()
1727 if ((int)fread(return_data, 1, count, in) != count) {
1728 free(return_data);
John Kessenich68d78fd2015-07-12 19:28:10 -06001729 Error("can't read input file");
John Kessenicha0af4732012-12-12 21:15:54 +00001730 }
John Kessenich68d78fd2015-07-12 19:28:10 -06001731
John Kessenich04acb1b2017-06-14 17:36:50 -06001732 return_data[count] = '\0';
John Kessenicha0af4732012-12-12 21:15:54 +00001733 fclose(in);
John Kessenichb3297152015-07-11 18:01:03 -06001734
John Kessenicha0af4732012-12-12 21:15:54 +00001735 return return_data;
1736}
1737
John Kessenich04acb1b2017-06-14 17:36:50 -06001738void FreeFileData(char* data)
John Kessenicha0af4732012-12-12 21:15:54 +00001739{
John Kessenichb3297152015-07-11 18:01:03 -06001740 free(data);
John Kessenicha0af4732012-12-12 21:15:54 +00001741}
1742
John Kessenich54d8cda2013-02-11 22:36:01 +00001743void InfoLogMsg(const char* msg, const char* name, const int num)
John Kessenicha0af4732012-12-12 21:15:54 +00001744{
John Kessenichfae38ee2015-06-10 23:23:12 +00001745 if (num >= 0 )
1746 printf("#### %s %s %d INFO LOG ####\n", msg, name, num);
1747 else
1748 printf("#### %s %s INFO LOG ####\n", msg, name);
John Kessenicha0af4732012-12-12 21:15:54 +00001749}