blob: 278c52eb00cdc17d00155fde7762f90a28b4869f [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 Kessenichbd0747d2013-02-17 06:01:50 +00004//
John Kessenich927608b2017-01-06 12:34:14 -07005// All rights reserved.
John Kessenicha0af4732012-12-12 21:15:54 +00006//
John Kessenich927608b2017-01-06 12:34:14 -07007// Redistribution and use in source and binary forms, with or without
8// modification, are permitted provided that the following conditions
9// are met:
John Kessenicha0af4732012-12-12 21:15:54 +000010//
11// Redistributions of source code must retain the above copyright
12// notice, this list of conditions and the following disclaimer.
13//
14// Redistributions in binary form must reproduce the above
15// copyright notice, this list of conditions and the following
16// disclaimer in the documentation and/or other materials provided
17// with the distribution.
18//
19// Neither the name of 3Dlabs Inc. Ltd. nor the names of its
20// contributors may be used to endorse or promote products derived
21// from this software without specific prior written permission.
22//
John Kessenich927608b2017-01-06 12:34:14 -070023// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
26// FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
27// COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
28// INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
29// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
30// LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
31// CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32// LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
33// ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34// POSSIBILITY OF SUCH DAMAGE.
John Kessenicha0af4732012-12-12 21:15:54 +000035//
John Kessenich05a70632013-09-17 19:26:08 +000036
37// this only applies to the standalone wrapper, not the front end in general
Aras Pranckevicius8e204b22017-05-10 16:52:50 +030038#ifndef _CRT_SECURE_NO_WARNINGS
John Kessenich05a70632013-09-17 19:26:08 +000039#define _CRT_SECURE_NO_WARNINGS
Aras Pranckevicius8e204b22017-05-10 16:52:50 +030040#endif
John Kessenich05a70632013-09-17 19:26:08 +000041
Lei Zhang8a9b1ee2016-05-19 13:31:43 -040042#include "ResourceLimits.h"
John Kessenich2b07c7e2013-07-31 18:44:13 +000043#include "Worklist.h"
John Kessenich3494b4d2017-05-22 15:00:42 -060044#include "DirStackFileIncluder.h"
John Kessenicha0af4732012-12-12 21:15:54 +000045#include "./../glslang/Include/ShHandle.h"
John Kessenich0da9eaa2015-08-01 17:10:02 -060046#include "./../glslang/Include/revision.h"
John Kessenicha0af4732012-12-12 21:15:54 +000047#include "./../glslang/Public/ShaderLang.h"
John Kessenich0df0cde2015-03-03 17:09:43 +000048#include "../SPIRV/GlslangToSpv.h"
John Kessenich5e4b1242015-08-06 22:53:06 -060049#include "../SPIRV/GLSL.std.450.h"
John Kessenichacba7722015-03-04 03:48:38 +000050#include "../SPIRV/doc.h"
51#include "../SPIRV/disassemble.h"
John Kessenich3494b4d2017-05-22 15:00:42 -060052
John Kessenich66ec80e2016-08-05 14:04:23 -060053#include <cstring>
54#include <cstdlib>
steve-lunarg7f7c2ed2016-09-07 15:20:19 -060055#include <cctype>
John Kessenich66ec80e2016-08-05 14:04:23 -060056#include <cmath>
steve-lunarg7f7c2ed2016-09-07 15:20:19 -060057#include <array>
LoopDawg08a14422017-10-17 19:27:14 -060058#include <map>
Juan Lopeza558b262017-04-02 23:04:00 +020059#include <memory>
60#include <thread>
John Kessenicha0af4732012-12-12 21:15:54 +000061
baldurk876a0e32015-11-16 18:03:28 +010062#include "../glslang/OSDependent/osinclude.h"
John Kessenicha0af4732012-12-12 21:15:54 +000063
64extern "C" {
65 SH_IMPORT_EXPORT void ShOutputHtml();
66}
67
John Kessenich94a81fb2013-08-31 02:41:30 +000068// Command-line options
69enum TOptions {
John Kessenich906cc212016-12-09 19:22:20 -070070 EOptionNone = 0,
71 EOptionIntermediate = (1 << 0),
72 EOptionSuppressInfolog = (1 << 1),
73 EOptionMemoryLeakMode = (1 << 2),
74 EOptionRelaxedErrors = (1 << 3),
75 EOptionGiveWarnings = (1 << 4),
76 EOptionLinkProgram = (1 << 5),
77 EOptionMultiThreaded = (1 << 6),
78 EOptionDumpConfig = (1 << 7),
79 EOptionDumpReflection = (1 << 8),
80 EOptionSuppressWarnings = (1 << 9),
81 EOptionDumpVersions = (1 << 10),
82 EOptionSpv = (1 << 11),
83 EOptionHumanReadableSpv = (1 << 12),
84 EOptionVulkanRules = (1 << 13),
85 EOptionDefaultDesktop = (1 << 14),
86 EOptionOutputPreprocessed = (1 << 15),
87 EOptionOutputHexadecimal = (1 << 16),
88 EOptionReadHlsl = (1 << 17),
89 EOptionCascadingErrors = (1 << 18),
90 EOptionAutoMapBindings = (1 << 19),
steve-lunarge0b9deb2016-09-16 13:26:37 -060091 EOptionFlattenUniformArrays = (1 << 20),
John Kessenich906cc212016-12-09 19:22:20 -070092 EOptionNoStorageFormat = (1 << 21),
John Kessenich20f01e72016-12-12 11:41:43 -070093 EOptionKeepUncalled = (1 << 22),
John Kessenich4f1403e2017-04-05 17:38:20 -060094 EOptionHlslOffsets = (1 << 23),
steve-lunargbe283552017-04-18 12:18:01 -060095 EOptionHlslIoMapping = (1 << 24),
John Kessenich71facdf2017-05-17 18:28:19 -060096 EOptionAutoMapLocations = (1 << 25),
John Kessenich121853f2017-05-31 17:11:16 -060097 EOptionDebug = (1 << 26),
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +020098 EOptionStdin = (1 << 27),
GregFcd1f1692017-09-21 18:40:22 -060099 EOptionOptimizeDisable = (1 << 28),
100 EOptionOptimizeSize = (1 << 29),
LoopDawgb22c0692017-12-06 16:52:03 -0700101 EOptionInvertY = (1 << 30),
John Kessenichc6c80a62018-03-05 22:23:17 -0700102 EOptionDumpBareVersion = (1 << 31),
John Kessenich94a81fb2013-08-31 02:41:30 +0000103};
John Kessenich5d610ee2018-03-07 18:05:55 -0700104bool targetHlslFunctionality1 = false;
John Kesseniche2156222018-06-11 18:12:15 -0600105bool SpvToolsDisassembler = false;
John Kessenichc3404252018-08-23 15:29:08 -0600106bool SpvToolsValidate = false;
John Kessenich94a81fb2013-08-31 02:41:30 +0000107
John Kessenicha0af4732012-12-12 21:15:54 +0000108//
John Kessenich68d78fd2015-07-12 19:28:10 -0600109// Return codes from main/exit().
John Kessenicha0af4732012-12-12 21:15:54 +0000110//
111enum TFailCode {
112 ESuccess = 0,
113 EFailUsage,
114 EFailCompile,
115 EFailLink,
116 EFailCompilerCreate,
John Kessenich2b07c7e2013-07-31 18:44:13 +0000117 EFailThreadCreate,
John Kessenicha0af4732012-12-12 21:15:54 +0000118 EFailLinkerCreate
119};
120
121//
John Kessenich68d78fd2015-07-12 19:28:10 -0600122// Forward declarations.
John Kessenicha0af4732012-12-12 21:15:54 +0000123//
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600124EShLanguage FindLanguage(const std::string& name, bool parseSuffix=true);
John Kessenich51cdd902014-02-18 23:37:57 +0000125void CompileFile(const char* fileName, ShHandle);
John Kessenicha0af4732012-12-12 21:15:54 +0000126void usage();
John Kessenich04acb1b2017-06-14 17:36:50 -0600127char* ReadFileData(const char* fileName);
128void FreeFileData(char* data);
John Kessenich54d8cda2013-02-11 22:36:01 +0000129void InfoLogMsg(const char* msg, const char* name, const int num);
John Kessenich41cf6b52013-06-25 18:10:05 +0000130
John Kessenichc999ba22013-11-07 23:33:24 +0000131// Globally track if any compile or link failure.
132bool CompileFailed = false;
133bool LinkFailed = false;
134
John Kessenich94f28eb2017-11-13 01:32:06 -0700135// array of unique places to leave the shader names and infologs for the asynchronous compiles
136std::vector<std::unique_ptr<glslang::TWorkItem>> WorkItems;
137
John Kessenich05a70632013-09-17 19:26:08 +0000138TBuiltInResource Resources;
139std::string ConfigFile;
140
John Kessenicha0af4732012-12-12 21:15:54 +0000141//
John Kessenichf0bcb0a2016-04-02 13:09:14 -0600142// Parse either a .conf file provided by the user or the default from glslang::DefaultTBuiltInResource
John Kessenich05a70632013-09-17 19:26:08 +0000143//
144void ProcessConfigFile()
John Kessenichb51f62c2013-04-11 16:31:09 +0000145{
John Kessenich04acb1b2017-06-14 17:36:50 -0600146 if (ConfigFile.size() == 0)
Lei Zhang414eb602016-03-04 16:22:34 -0500147 Resources = glslang::DefaultTBuiltInResource;
John Kessenich04acb1b2017-06-14 17:36:50 -0600148 else {
149 char* configString = ReadFileData(ConfigFile.c_str());
150 glslang::DecodeResourceLimits(&Resources, configString);
151 FreeFileData(configString);
John Kessenich05a70632013-09-17 19:26:08 +0000152 }
John Kessenicha0af4732012-12-12 21:15:54 +0000153}
154
baldurk6d477852019-01-29 15:45:56 +0000155int ReflectOptions = EShReflectionDefault;
John Kessenich94a81fb2013-08-31 02:41:30 +0000156int Options = 0;
John Kessenich68d78fd2015-07-12 19:28:10 -0600157const char* ExecutableName = nullptr;
158const char* binaryFileName = nullptr;
John Kessenich4d65ee32016-03-12 18:17:47 -0700159const char* entryPointName = nullptr;
steve-lunargf1e0c872016-10-31 15:13:43 -0600160const char* sourceEntryPointName = nullptr;
Dan Bakerc6ede892016-08-11 14:06:06 -0400161const char* shaderStageName = nullptr;
Flavioaea3c892017-02-06 11:46:35 -0800162const char* variableName = nullptr;
Rex Xucb61eec2018-03-07 13:10:01 +0800163bool HlslEnable16BitTypes = false;
John Kessenichbd1c1832018-12-07 18:38:26 -0700164bool HlslDX9compatible = false;
Christoph Kubisch55ba3ea2019-04-13 22:18:16 +0200165bool DumpBuiltinSymbols = false;
John Kessenich971a0a82017-06-07 15:06:58 -0600166std::vector<std::string> IncludeDirectoryList;
John Kessenich8717a5d2018-10-26 10:12:32 -0600167
168// Source environment
169// (source 'Client' is currently the same as target 'Client')
170int ClientInputSemanticsVersion = 100;
171
172// Target environment
173glslang::EShClient Client = glslang::EShClientNone; // will stay EShClientNone if only validating
174glslang::EShTargetClientVersion ClientVersion; // not valid until Client is set
175glslang::EShTargetLanguage TargetLanguage = glslang::EShTargetNone;
176glslang::EShTargetLanguageVersion TargetVersion; // not valid until TargetLanguage is set
177
John Kessenich66011cb2018-03-06 16:12:04 -0700178std::vector<std::string> Processes; // what should be recorded by OpModuleProcessed, or equivalent
John Kessenich68d78fd2015-07-12 19:28:10 -0600179
LoopDawg08a14422017-10-17 19:27:14 -0600180// Per descriptor-set binding base data
181typedef std::map<unsigned int, unsigned int> TPerSetBaseBinding;
182
Neil Roberts16f53472018-03-20 17:30:53 +0100183std::vector<std::pair<std::string, int>> uniformLocationOverrides;
Neil Robertsb0f3d792018-03-20 17:41:05 +0100184int uniformBase = 0;
Neil Roberts16f53472018-03-20 17:30:53 +0100185
LoopDawg08a14422017-10-17 19:27:14 -0600186std::array<std::array<unsigned int, EShLangCount>, glslang::EResCount> baseBinding;
187std::array<std::array<TPerSetBaseBinding, EShLangCount>, glslang::EResCount> baseBindingForSet;
Hyangran Park36dc8292017-05-02 16:27:29 +0900188std::array<std::vector<std::string>, EShLangCount> baseResourceSetBinding;
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600189
John Kessenicha9313662017-06-15 10:40:49 -0600190// Add things like "#define ..." to a preamble to use in the beginning of the shader.
191class TPreamble {
192public:
193 TPreamble() { }
194
195 bool isSet() const { return text.size() > 0; }
196 const char* get() const { return text.c_str(); }
197
198 // #define...
199 void addDef(std::string def)
200 {
201 text.append("#define ");
202 fixLine(def);
203
John Kessenich2a271162017-07-20 20:00:36 -0600204 Processes.push_back("D");
205 Processes.back().append(def);
206
John Kessenicha9313662017-06-15 10:40:49 -0600207 // The first "=" needs to turn into a space
LoopDawgb97b25e2017-07-12 09:04:39 -0600208 const size_t equal = def.find_first_of("=");
John Kessenicha9313662017-06-15 10:40:49 -0600209 if (equal != def.npos)
210 def[equal] = ' ';
211
212 text.append(def);
213 text.append("\n");
214 }
215
216 // #undef...
217 void addUndef(std::string undef)
218 {
219 text.append("#undef ");
220 fixLine(undef);
John Kessenich2a271162017-07-20 20:00:36 -0600221
222 Processes.push_back("U");
223 Processes.back().append(undef);
224
John Kessenicha9313662017-06-15 10:40:49 -0600225 text.append(undef);
226 text.append("\n");
227 }
228
229protected:
230 void fixLine(std::string& line)
231 {
232 // Can't go past a newline in the line
LoopDawgb97b25e2017-07-12 09:04:39 -0600233 const size_t end = line.find_first_of("\n");
John Kessenicha9313662017-06-15 10:40:49 -0600234 if (end != line.npos)
235 line = line.substr(0, end);
236 }
237
238 std::string text; // contents of preamble
239};
240
241TPreamble UserPreamble;
242
John Kessenich68d78fd2015-07-12 19:28:10 -0600243//
244// Create the default name for saving a binary if -o is not provided.
245//
246const char* GetBinaryName(EShLanguage stage)
247{
248 const char* name;
249 if (binaryFileName == nullptr) {
250 switch (stage) {
251 case EShLangVertex: name = "vert.spv"; break;
252 case EShLangTessControl: name = "tesc.spv"; break;
253 case EShLangTessEvaluation: name = "tese.spv"; break;
254 case EShLangGeometry: name = "geom.spv"; break;
255 case EShLangFragment: name = "frag.spv"; break;
256 case EShLangCompute: name = "comp.spv"; break;
Chao Chen3c366992018-09-19 11:41:59 -0700257#ifdef NV_EXTENSIONS
Chao Chenb50c02e2018-09-19 11:42:24 -0700258 case EShLangRayGenNV: name = "rgen.spv"; break;
259 case EShLangIntersectNV: name = "rint.spv"; break;
260 case EShLangAnyHitNV: name = "rahit.spv"; break;
261 case EShLangClosestHitNV: name = "rchit.spv"; break;
262 case EShLangMissNV: name = "rmiss.spv"; break;
263 case EShLangCallableNV: name = "rcall.spv"; break;
Chao Chen3c366992018-09-19 11:41:59 -0700264 case EShLangMeshNV: name = "mesh.spv"; break;
265 case EShLangTaskNV: name = "task.spv"; break;
266#endif
John Kessenich68d78fd2015-07-12 19:28:10 -0600267 default: name = "unknown"; break;
268 }
269 } else
270 name = binaryFileName;
271
272 return name;
273}
John Kessenich2b07c7e2013-07-31 18:44:13 +0000274
John Kessenich05a70632013-09-17 19:26:08 +0000275//
276// *.conf => this is a config file that can set limits/resources
277//
278bool SetConfigFile(const std::string& name)
279{
280 if (name.size() < 5)
281 return false;
282
John Kessenich4c706852013-10-11 16:28:43 +0000283 if (name.compare(name.size() - 5, 5, ".conf") == 0) {
John Kessenich05a70632013-09-17 19:26:08 +0000284 ConfigFile = name;
285 return true;
286 }
287
288 return false;
289}
290
John Kessenich68d78fd2015-07-12 19:28:10 -0600291//
292// Give error and exit with failure code.
293//
294void Error(const char* message)
295{
John Kessenichaf527992017-11-02 22:48:15 -0600296 fprintf(stderr, "%s: Error %s (use -h for usage)\n", ExecutableName, message);
John Kessenich68d78fd2015-07-12 19:28:10 -0600297 exit(EFailUsage);
298}
299
300//
LoopDawg08a14422017-10-17 19:27:14 -0600301// Process an optional binding base of one the forms:
302// --argname [stage] base // base for stage (if given) or all stages (if not)
LoopDawge5709552017-10-21 10:46:39 -0600303// --argname [stage] [base set]... // set/base pairs: set the base for given binding set.
LoopDawg08a14422017-10-17 19:27:14 -0600304
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600305// Where stage is one of the forms accepted by FindLanguage, and base is an integer
306//
LoopDawg08a14422017-10-17 19:27:14 -0600307void ProcessBindingBase(int& argc, char**& argv, glslang::TResourceType res)
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600308{
309 if (argc < 2)
310 usage();
311
LoopDawg08a14422017-10-17 19:27:14 -0600312 EShLanguage lang = EShLangCount;
313 int singleBase = 0;
314 TPerSetBaseBinding perSetBase;
315 int arg = 1;
316
317 // Parse stage, if given
318 if (!isdigit(argv[arg][0])) {
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600319 if (argc < 3) // this form needs one more argument
320 usage();
John Kessenichecba76f2017-01-06 00:34:48 -0700321
LoopDawg08a14422017-10-17 19:27:14 -0600322 lang = FindLanguage(argv[arg++], false);
323 }
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600324
LoopDawg08a14422017-10-17 19:27:14 -0600325 if ((argc - arg) > 2 && isdigit(argv[arg+0][0]) && isdigit(argv[arg+1][0])) {
326 // Parse a per-set binding base
327 while ((argc - arg) > 2 && isdigit(argv[arg+0][0]) && isdigit(argv[arg+1][0])) {
LoopDawg08a14422017-10-17 19:27:14 -0600328 const int baseNum = atoi(argv[arg++]);
LoopDawge5709552017-10-21 10:46:39 -0600329 const int setNum = atoi(argv[arg++]);
LoopDawg08a14422017-10-17 19:27:14 -0600330 perSetBase[setNum] = baseNum;
331 }
332 } else {
333 // Parse single binding base
334 singleBase = atoi(argv[arg++]);
335 }
336
337 argc -= (arg-1);
338 argv += (arg-1);
339
340 // Set one or all languages
341 const int langMin = (lang < EShLangCount) ? lang+0 : 0;
342 const int langMax = (lang < EShLangCount) ? lang+1 : EShLangCount;
343
344 for (int lang = langMin; lang < langMax; ++lang) {
345 if (!perSetBase.empty())
John Kessenich251901a2018-08-12 22:05:59 -0600346 baseBindingForSet[res][lang].insert(perSetBase.begin(), perSetBase.end());
LoopDawg08a14422017-10-17 19:27:14 -0600347 else
348 baseBinding[res][lang] = singleBase;
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600349 }
350}
351
Hyangran Park36dc8292017-05-02 16:27:29 +0900352void ProcessResourceSetBindingBase(int& argc, char**& argv, std::array<std::vector<std::string>, EShLangCount>& base)
353{
354 if (argc < 2)
355 usage();
356
357 if (!isdigit(argv[1][0])) {
LoopDawg52017192017-07-14 15:15:47 -0600358 if (argc < 3) // this form needs one more argument
Hyangran Park36dc8292017-05-02 16:27:29 +0900359 usage();
360
LoopDawg52017192017-07-14 15:15:47 -0600361 // Parse form: --argname stage [regname set base...], or:
362 // --argname stage set
Hyangran Park36dc8292017-05-02 16:27:29 +0900363 const EShLanguage lang = FindLanguage(argv[1], false);
364
LoopDawg52017192017-07-14 15:15:47 -0600365 argc--;
366 argv++;
367
368 while (argc > 1 && argv[1] != nullptr && argv[1][0] != '-') {
369 base[lang].push_back(argv[1]);
370
371 argc--;
372 argv++;
Hyangran Park36dc8292017-05-02 16:27:29 +0900373 }
LoopDawg52017192017-07-14 15:15:47 -0600374
375 // Must have one arg, or a multiple of three (for [regname set binding] triples)
376 if (base[lang].size() != 1 && (base[lang].size() % 3) != 0)
377 usage();
378
Hyangran Park36dc8292017-05-02 16:27:29 +0900379 } else {
LoopDawg52017192017-07-14 15:15:47 -0600380 // Parse form: --argname set
Hyangran Park36dc8292017-05-02 16:27:29 +0900381 for (int lang=0; lang<EShLangCount; ++lang)
382 base[lang].push_back(argv[1]);
383
384 argc--;
385 argv++;
386 }
387}
388
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600389//
John Kessenich68d78fd2015-07-12 19:28:10 -0600390// Do all command-line argument parsing. This includes building up the work-items
391// to be processed later, and saving all the command-line options.
392//
393// Does not return (it exits) if command-line is fatally flawed.
394//
Juan Lopeza558b262017-04-02 23:04:00 +0200395void ProcessArguments(std::vector<std::unique_ptr<glslang::TWorkItem>>& workItems, int argc, char* argv[])
John Kessenich2b07c7e2013-07-31 18:44:13 +0000396{
LoopDawg08a14422017-10-17 19:27:14 -0600397 for (int res = 0; res < glslang::EResCount; ++res)
398 baseBinding[res].fill(0);
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600399
John Kessenich38f3b892013-09-06 19:52:57 +0000400 ExecutableName = argv[0];
Juan Lopeza558b262017-04-02 23:04:00 +0200401 workItems.reserve(argc);
John Kessenich38f3b892013-09-06 19:52:57 +0000402
John Kessenichc178f0a2017-06-23 10:58:31 -0600403 const auto bumpArg = [&]() {
404 if (argc > 0) {
405 argc--;
406 argv++;
407 }
408 };
409
410 // read a string directly attached to a single-letter option
John Kessenich6263fb12017-06-14 15:52:44 -0600411 const auto getStringOperand = [&](const char* desc) {
412 if (argv[0][2] == 0) {
413 printf("%s must immediately follow option (no spaces)\n", desc);
414 exit(EFailUsage);
415 }
416 return argv[0] + 2;
417 };
418
John Kessenich6353d552017-06-23 11:11:09 -0600419 // read a number attached to a single-letter option
420 const auto getAttachedNumber = [&](const char* desc) {
421 int num = atoi(argv[0] + 2);
422 if (num == 0) {
423 printf("%s: expected attached non-0 number\n", desc);
424 exit(EFailUsage);
425 }
426 return num;
427 };
428
429 // minimum needed (without overriding something else) to target Vulkan SPIR-V
430 const auto setVulkanSpv = []() {
John Kessenich8717a5d2018-10-26 10:12:32 -0600431 if (Client == glslang::EShClientNone)
432 ClientVersion = glslang::EShTargetVulkan_1_0;
433 Client = glslang::EShClientVulkan;
John Kessenich6353d552017-06-23 11:11:09 -0600434 Options |= EOptionSpv;
435 Options |= EOptionVulkanRules;
436 Options |= EOptionLinkProgram;
437 };
438
439 // minimum needed (without overriding something else) to target OpenGL SPIR-V
440 const auto setOpenGlSpv = []() {
John Kessenich8717a5d2018-10-26 10:12:32 -0600441 if (Client == glslang::EShClientNone)
442 ClientVersion = glslang::EShTargetOpenGL_450;
443 Client = glslang::EShClientOpenGL;
John Kessenich6353d552017-06-23 11:11:09 -0600444 Options |= EOptionSpv;
445 Options |= EOptionLinkProgram;
446 // undo a -H default to Vulkan
447 Options &= ~EOptionVulkanRules;
448 };
449
Neil Roberts16f53472018-03-20 17:30:53 +0100450 const auto getUniformOverride = [getStringOperand]() {
451 const char *arg = getStringOperand("-u<name>:<location>");
452 const char *split = strchr(arg, ':');
453 if (split == NULL) {
454 printf("%s: missing location\n", arg);
455 exit(EFailUsage);
456 }
457 errno = 0;
458 int location = ::strtol(split + 1, NULL, 10);
459 if (errno) {
460 printf("%s: invalid location\n", arg);
461 exit(EFailUsage);
462 }
463 return std::make_pair(std::string(arg, split - arg), location);
464 };
465
John Kessenichc178f0a2017-06-23 10:58:31 -0600466 for (bumpArg(); argc >= 1; bumpArg()) {
John Kessenich2b07c7e2013-07-31 18:44:13 +0000467 if (argv[0][0] == '-') {
John Kessenich2aa7f3a2015-05-15 16:02:07 +0000468 switch (argv[0][1]) {
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600469 case '-':
470 {
471 std::string lowerword(argv[0]+2);
472 std::transform(lowerword.begin(), lowerword.end(), lowerword.begin(), ::tolower);
473
474 // handle --word style options
John Kessenich6263fb12017-06-14 15:52:44 -0600475 if (lowerword == "auto-map-bindings" || // synonyms
John Kessenich6353d552017-06-23 11:11:09 -0600476 lowerword == "auto-map-binding" ||
477 lowerword == "amb") {
John Kessenich6263fb12017-06-14 15:52:44 -0600478 Options |= EOptionAutoMapBindings;
479 } else if (lowerword == "auto-map-locations" || // synonyms
480 lowerword == "aml") {
481 Options |= EOptionAutoMapLocations;
Neil Robertsb0f3d792018-03-20 17:41:05 +0100482 } else if (lowerword == "uniform-base") {
483 if (argc <= 1)
484 Error("no <base> provided for --uniform-base");
485 uniformBase = ::strtol(argv[1], NULL, 10);
486 bumpArg();
487 break;
John Kessenich6353d552017-06-23 11:11:09 -0600488 } else if (lowerword == "client") {
489 if (argc > 1) {
490 if (strcmp(argv[1], "vulkan100") == 0)
491 setVulkanSpv();
492 else if (strcmp(argv[1], "opengl100") == 0)
493 setOpenGlSpv();
494 else
495 Error("--client expects vulkan100 or opengl100");
496 }
497 bumpArg();
Christoph Kubisch55ba3ea2019-04-13 22:18:16 +0200498 } else if (lowerword == "dump-builtin-symbols") {
499 DumpBuiltinSymbols = true;
John Kessenich640bd092018-08-09 14:15:00 -0600500 } else if (lowerword == "entry-point") {
501 entryPointName = argv[1];
502 if (argc <= 1)
503 Error("no <name> provided for --entry-point");
504 bumpArg();
John Kessenich6263fb12017-06-14 15:52:44 -0600505 } else if (lowerword == "flatten-uniform-arrays" || // synonyms
506 lowerword == "flatten-uniform-array" ||
507 lowerword == "fua") {
508 Options |= EOptionFlattenUniformArrays;
509 } else if (lowerword == "hlsl-offsets") {
510 Options |= EOptionHlslOffsets;
511 } else if (lowerword == "hlsl-iomap" ||
512 lowerword == "hlsl-iomapper" ||
513 lowerword == "hlsl-iomapping") {
514 Options |= EOptionHlslIoMapping;
Rex Xucb61eec2018-03-07 13:10:01 +0800515 } else if (lowerword == "hlsl-enable-16bit-types") {
516 HlslEnable16BitTypes = true;
John Kessenichbd1c1832018-12-07 18:38:26 -0700517 } else if (lowerword == "hlsl-dx9-compatible") {
518 HlslDX9compatible = true;
John Kessenichc6c80a62018-03-05 22:23:17 -0700519 } else if (lowerword == "invert-y" || // synonyms
520 lowerword == "iy") {
521 Options |= EOptionInvertY;
John Kessenich6263fb12017-06-14 15:52:44 -0600522 } else if (lowerword == "keep-uncalled" || // synonyms
523 lowerword == "ku") {
524 Options |= EOptionKeepUncalled;
525 } else if (lowerword == "no-storage-format" || // synonyms
526 lowerword == "nsf") {
527 Options |= EOptionNoStorageFormat;
John Kessenich2a271162017-07-20 20:00:36 -0600528 } else if (lowerword == "relaxed-errors") {
529 Options |= EOptionRelaxedErrors;
baldurk15c37f72019-01-29 12:12:59 +0000530 } else if (lowerword == "reflect-strict-array-suffix") {
531 ReflectOptions |= EShReflectionStrictArraySuffix;
baldurkedf82122019-01-29 15:49:00 +0000532 } else if (lowerword == "reflect-basic-array-suffix") {
533 ReflectOptions |= EShReflectionBasicArraySuffix;
baldurk0af5e3e2019-01-29 16:04:44 +0000534 } else if (lowerword == "reflect-intermediate-io") {
535 ReflectOptions |= EShReflectionIntermediateIO;
baldurk657acc02019-01-30 14:18:43 +0000536 } else if (lowerword == "reflect-separate-buffers") {
537 ReflectOptions |= EShReflectionSeparateBuffers;
baldurka972e732019-01-30 15:34:02 +0000538 } else if (lowerword == "reflect-all-block-variables") {
539 ReflectOptions |= EShReflectionAllBlockVariables;
baldurk19050692019-02-11 11:50:24 +0000540 } else if (lowerword == "reflect-unwrap-io-blocks") {
541 ReflectOptions |= EShReflectionUnwrapIOBlocks;
John Kessenich6263fb12017-06-14 15:52:44 -0600542 } else if (lowerword == "resource-set-bindings" || // synonyms
543 lowerword == "resource-set-binding" ||
544 lowerword == "rsb") {
545 ProcessResourceSetBindingBase(argc, argv, baseResourceSetBinding);
steve-lunarg9088be42016-11-01 10:31:42 -0600546 } else if (lowerword == "shift-image-bindings" || // synonyms
547 lowerword == "shift-image-binding" ||
548 lowerword == "sib") {
LoopDawg08a14422017-10-17 19:27:14 -0600549 ProcessBindingBase(argc, argv, glslang::EResImage);
John Kessenich6263fb12017-06-14 15:52:44 -0600550 } else if (lowerword == "shift-sampler-bindings" || // synonyms
John Kessenichade8bbb2018-08-12 21:24:55 -0600551 lowerword == "shift-sampler-binding" ||
552 lowerword == "ssb") {
LoopDawg08a14422017-10-17 19:27:14 -0600553 ProcessBindingBase(argc, argv, glslang::EResSampler);
John Kessenich6263fb12017-06-14 15:52:44 -0600554 } else if (lowerword == "shift-uav-bindings" || // synonyms
555 lowerword == "shift-uav-binding" ||
556 lowerword == "suavb") {
LoopDawg08a14422017-10-17 19:27:14 -0600557 ProcessBindingBase(argc, argv, glslang::EResUav);
John Kessenich6263fb12017-06-14 15:52:44 -0600558 } else if (lowerword == "shift-texture-bindings" || // synonyms
559 lowerword == "shift-texture-binding" ||
560 lowerword == "stb") {
LoopDawg08a14422017-10-17 19:27:14 -0600561 ProcessBindingBase(argc, argv, glslang::EResTexture);
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600562 } else if (lowerword == "shift-ubo-bindings" || // synonyms
563 lowerword == "shift-ubo-binding" ||
steve-lunargbe283552017-04-18 12:18:01 -0600564 lowerword == "shift-cbuffer-bindings" ||
565 lowerword == "shift-cbuffer-binding" ||
566 lowerword == "sub" ||
567 lowerword == "scb") {
LoopDawg08a14422017-10-17 19:27:14 -0600568 ProcessBindingBase(argc, argv, glslang::EResUbo);
steve-lunarg932bb5c2017-02-21 17:19:08 -0700569 } else if (lowerword == "shift-ssbo-bindings" || // synonyms
570 lowerword == "shift-ssbo-binding" ||
571 lowerword == "sbb") {
LoopDawg08a14422017-10-17 19:27:14 -0600572 ProcessBindingBase(argc, argv, glslang::EResSsbo);
John Kessenich6263fb12017-06-14 15:52:44 -0600573 } else if (lowerword == "source-entrypoint" || // synonyms
574 lowerword == "sep") {
John Kessenichc178f0a2017-06-23 10:58:31 -0600575 if (argc <= 1)
John Kessenich6263fb12017-06-14 15:52:44 -0600576 Error("no <entry-point> provided for --source-entrypoint");
John Kessenichc178f0a2017-06-23 10:58:31 -0600577 sourceEntryPointName = argv[1];
578 bumpArg();
John Kessenich6263fb12017-06-14 15:52:44 -0600579 break;
John Kesseniche2156222018-06-11 18:12:15 -0600580 } else if (lowerword == "spirv-dis") {
581 SpvToolsDisassembler = true;
John Kessenichc3404252018-08-23 15:29:08 -0600582 } else if (lowerword == "spirv-val") {
583 SpvToolsValidate = true;
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +0200584 } else if (lowerword == "stdin") {
585 Options |= EOptionStdin;
586 shaderStageName = argv[1];
John Kessenich2a271162017-07-20 20:00:36 -0600587 } else if (lowerword == "suppress-warnings") {
588 Options |= EOptionSuppressWarnings;
John Kessenich6353d552017-06-23 11:11:09 -0600589 } else if (lowerword == "target-env") {
590 if (argc > 1) {
591 if (strcmp(argv[1], "vulkan1.0") == 0) {
592 setVulkanSpv();
John Kessenich8717a5d2018-10-26 10:12:32 -0600593 ClientVersion = glslang::EShTargetVulkan_1_0;
John Kessenich66011cb2018-03-06 16:12:04 -0700594 } else if (strcmp(argv[1], "vulkan1.1") == 0) {
595 setVulkanSpv();
John Kessenich8717a5d2018-10-26 10:12:32 -0600596 ClientVersion = glslang::EShTargetVulkan_1_1;
John Kessenich6353d552017-06-23 11:11:09 -0600597 } else if (strcmp(argv[1], "opengl") == 0) {
598 setOpenGlSpv();
John Kessenich8717a5d2018-10-26 10:12:32 -0600599 ClientVersion = glslang::EShTargetOpenGL_450;
600 } else if (strcmp(argv[1], "spirv1.0") == 0) {
601 TargetLanguage = glslang::EShTargetSpv;
602 TargetVersion = glslang::EShTargetSpv_1_0;
603 } else if (strcmp(argv[1], "spirv1.1") == 0) {
604 TargetLanguage = glslang::EShTargetSpv;
605 TargetVersion = glslang::EShTargetSpv_1_1;
606 } else if (strcmp(argv[1], "spirv1.2") == 0) {
607 TargetLanguage = glslang::EShTargetSpv;
608 TargetVersion = glslang::EShTargetSpv_1_2;
609 } else if (strcmp(argv[1], "spirv1.3") == 0) {
610 TargetLanguage = glslang::EShTargetSpv;
611 TargetVersion = glslang::EShTargetSpv_1_3;
612 } else if (strcmp(argv[1], "spirv1.4") == 0) {
613 TargetLanguage = glslang::EShTargetSpv;
614 TargetVersion = glslang::EShTargetSpv_1_4;
John Kessenich6353d552017-06-23 11:11:09 -0600615 } else
John Kessenich8717a5d2018-10-26 10:12:32 -0600616 Error("--target-env expected one of: vulkan1.0, vulkan1.1, opengl, spirv1.0, spirv1.1, spirv1.2, or spirv1.3");
John Kessenich6353d552017-06-23 11:11:09 -0600617 }
618 bumpArg();
Flavio15017db2017-02-15 14:29:33 -0800619 } else if (lowerword == "variable-name" || // synonyms
John Kessenich66011cb2018-03-06 16:12:04 -0700620 lowerword == "vn") {
Flavio15017db2017-02-15 14:29:33 -0800621 Options |= EOptionOutputHexadecimal;
John Kessenichc178f0a2017-06-23 10:58:31 -0600622 if (argc <= 1)
Flavio15017db2017-02-15 14:29:33 -0800623 Error("no <C-variable-name> provided for --variable-name");
John Kessenichc178f0a2017-06-23 10:58:31 -0600624 variableName = argv[1];
625 bumpArg();
Flavio15017db2017-02-15 14:29:33 -0800626 break;
John Kessenichc6c80a62018-03-05 22:23:17 -0700627 } else if (lowerword == "version") {
628 Options |= EOptionDumpVersions;
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600629 } else {
630 usage();
631 }
632 }
633 break;
John Kessenich6263fb12017-06-14 15:52:44 -0600634 case 'C':
635 Options |= EOptionCascadingErrors;
636 break;
637 case 'D':
John Kessenicha9313662017-06-15 10:40:49 -0600638 if (argv[0][2] == 0)
639 Options |= EOptionReadHlsl;
640 else
641 UserPreamble.addDef(getStringOperand("-D<macro> macro name"));
John Kessenich6263fb12017-06-14 15:52:44 -0600642 break;
Neil Roberts16f53472018-03-20 17:30:53 +0100643 case 'u':
644 uniformLocationOverrides.push_back(getUniformOverride());
645 break;
John Kessenich6263fb12017-06-14 15:52:44 -0600646 case 'E':
647 Options |= EOptionOutputPreprocessed;
648 break;
649 case 'G':
John Kessenich8717a5d2018-10-26 10:12:32 -0600650 // OpenGL client
John Kessenich6353d552017-06-23 11:11:09 -0600651 setOpenGlSpv();
652 if (argv[0][2] != 0)
653 ClientInputSemanticsVersion = getAttachedNumber("-G<num> client input semantics");
John Kessenich6263fb12017-06-14 15:52:44 -0600654 break;
John Kessenich2aa7f3a2015-05-15 16:02:07 +0000655 case 'H':
656 Options |= EOptionHumanReadableSpv;
John Kessenich91e4aa52016-07-07 17:46:42 -0600657 if ((Options & EOptionSpv) == 0) {
658 // default to Vulkan
John Kessenich6353d552017-06-23 11:11:09 -0600659 setVulkanSpv();
John Kessenich91e4aa52016-07-07 17:46:42 -0600660 }
661 break;
John Kessenich971a0a82017-06-07 15:06:58 -0600662 case 'I':
John Kessenicha9313662017-06-15 10:40:49 -0600663 IncludeDirectoryList.push_back(getStringOperand("-I<dir> include path"));
John Kessenich68d78fd2015-07-12 19:28:10 -0600664 break;
GregFcd1f1692017-09-21 18:40:22 -0600665 case 'O':
666 if (argv[0][2] == 'd')
667 Options |= EOptionOptimizeDisable;
668 else if (argv[0][2] == 's')
GregFfb03a552018-03-29 11:49:14 -0600669#if ENABLE_OPT
GregFcd1f1692017-09-21 18:40:22 -0600670 Options |= EOptionOptimizeSize;
671#else
672 Error("-Os not available; optimizer not linked");
673#endif
674 else
675 Error("unknown -O option");
676 break;
Dan Baker5afdd782016-08-11 17:53:57 -0400677 case 'S':
John Kessenichc178f0a2017-06-23 10:58:31 -0600678 if (argc <= 1)
Dan Baker5afdd782016-08-11 17:53:57 -0400679 Error("no <stage> specified for -S");
John Kessenichc178f0a2017-06-23 10:58:31 -0600680 shaderStageName = argv[1];
681 bumpArg();
dankbaker45d49bc2016-08-08 21:43:07 -0400682 break;
John Kessenicha9313662017-06-15 10:40:49 -0600683 case 'U':
684 UserPreamble.addUndef(getStringOperand("-U<macro>: macro name"));
685 break;
John Kessenich6263fb12017-06-14 15:52:44 -0600686 case 'V':
John Kessenich6353d552017-06-23 11:11:09 -0600687 setVulkanSpv();
688 if (argv[0][2] != 0)
David Neto506d2c22018-02-27 21:55:23 -0500689 ClientInputSemanticsVersion = getAttachedNumber("-V<num> client input semantics");
John Kessenichc555ddd2015-06-17 02:38:44 +0000690 break;
John Kessenich05a70632013-09-17 19:26:08 +0000691 case 'c':
692 Options |= EOptionDumpConfig;
693 break;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000694 case 'd':
John Kessenichc6c80a62018-03-05 22:23:17 -0700695 if (strncmp(&argv[0][1], "dumpversion", strlen(&argv[0][1]) + 1) == 0 ||
696 strncmp(&argv[0][1], "dumpfullversion", strlen(&argv[0][1]) + 1) == 0)
697 Options |= EOptionDumpBareVersion;
698 else
699 Options |= EOptionDefaultDesktop;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000700 break;
John Kessenich4d65ee32016-03-12 18:17:47 -0700701 case 'e':
John Kessenich4d65ee32016-03-12 18:17:47 -0700702 entryPointName = argv[1];
John Kessenichc178f0a2017-06-23 10:58:31 -0600703 if (argc <= 1)
John Kessenicha25530c2017-09-11 20:13:49 -0600704 Error("no <name> provided for -e");
John Kessenichc178f0a2017-06-23 10:58:31 -0600705 bumpArg();
John Kessenich4d65ee32016-03-12 18:17:47 -0700706 break;
John Kessenich5d610ee2018-03-07 18:05:55 -0700707 case 'f':
708 if (strcmp(&argv[0][2], "hlsl_functionality1") == 0)
709 targetHlslFunctionality1 = true;
710 else
711 Error("-f: expected hlsl_functionality1");
712 break;
John Kessenich121853f2017-05-31 17:11:16 -0600713 case 'g':
714 Options |= EOptionDebug;
715 break;
John Kessenich68d78fd2015-07-12 19:28:10 -0600716 case 'h':
717 usage();
718 break;
John Kessenich05a70632013-09-17 19:26:08 +0000719 case 'i':
John Kessenich94a81fb2013-08-31 02:41:30 +0000720 Options |= EOptionIntermediate;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000721 break;
722 case 'l':
John Kessenichd78e3512014-08-25 20:07:55 +0000723 Options |= EOptionLinkProgram;
John Kessenich94a81fb2013-08-31 02:41:30 +0000724 break;
725 case 'm':
726 Options |= EOptionMemoryLeakMode;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000727 break;
John Kessenich68d78fd2015-07-12 19:28:10 -0600728 case 'o':
John Kessenichc178f0a2017-06-23 10:58:31 -0600729 if (argc <= 1)
John Kessenich68d78fd2015-07-12 19:28:10 -0600730 Error("no <file> provided for -o");
John Kessenichc178f0a2017-06-23 10:58:31 -0600731 binaryFileName = argv[1];
732 bumpArg();
John Kessenich68d78fd2015-07-12 19:28:10 -0600733 break;
John Kessenich11f9fc72013-11-07 01:06:34 +0000734 case 'q':
735 Options |= EOptionDumpReflection;
736 break;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000737 case 'r':
John Kessenich94a81fb2013-08-31 02:41:30 +0000738 Options |= EOptionRelaxedErrors;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000739 break;
740 case 's':
John Kessenich94a81fb2013-08-31 02:41:30 +0000741 Options |= EOptionSuppressInfolog;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000742 break;
John Kessenich38f3b892013-09-06 19:52:57 +0000743 case 't':
Juan Lopeza558b262017-04-02 23:04:00 +0200744 Options |= EOptionMultiThreaded;
John Kessenich38f3b892013-09-06 19:52:57 +0000745 break;
John Kessenich319de232013-12-04 04:43:40 +0000746 case 'v':
747 Options |= EOptionDumpVersions;
748 break;
John Kessenichb0a7eb52013-11-07 17:44:20 +0000749 case 'w':
750 Options |= EOptionSuppressWarnings;
751 break;
Johannes van Waverenecb0f3b2016-05-27 12:55:53 -0500752 case 'x':
753 Options |= EOptionOutputHexadecimal;
Johannes van Waverenecb0f3b2016-05-27 12:55:53 -0500754 break;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000755 default:
John Kessenich68d78fd2015-07-12 19:28:10 -0600756 usage();
757 break;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000758 }
John Kessenich38f3b892013-09-06 19:52:57 +0000759 } else {
John Kessenich05a70632013-09-17 19:26:08 +0000760 std::string name(argv[0]);
761 if (! SetConfigFile(name)) {
Juan Lopeza558b262017-04-02 23:04:00 +0200762 workItems.push_back(std::unique_ptr<glslang::TWorkItem>(new glslang::TWorkItem(name)));
John Kessenich05a70632013-09-17 19:26:08 +0000763 }
John Kessenich38f3b892013-09-06 19:52:57 +0000764 }
John Kessenich2b07c7e2013-07-31 18:44:13 +0000765 }
766
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +0200767 // Make sure that -S is always specified if --stdin is specified
768 if ((Options & EOptionStdin) && shaderStageName == nullptr)
769 Error("must provide -S when --stdin is given");
770
John Kessenich68d78fd2015-07-12 19:28:10 -0600771 // Make sure that -E is not specified alongside linking (which includes SPV generation)
772 if ((Options & EOptionOutputPreprocessed) && (Options & EOptionLinkProgram))
773 Error("can't use -E when linking is selected");
John Kessenichc555ddd2015-06-17 02:38:44 +0000774
Johannes van Waverenecb0f3b2016-05-27 12:55:53 -0500775 // -o or -x makes no sense if there is no target binary
John Kessenich68d78fd2015-07-12 19:28:10 -0600776 if (binaryFileName && (Options & EOptionSpv) == 0)
777 Error("no binary generation requested (e.g., -V)");
steve-lunarge0b9deb2016-09-16 13:26:37 -0600778
779 if ((Options & EOptionFlattenUniformArrays) != 0 &&
780 (Options & EOptionReadHlsl) == 0)
781 Error("uniform array flattening only valid when compiling HLSL source.");
John Kessenich8717a5d2018-10-26 10:12:32 -0600782
783 // rationalize client and target language
784 if (TargetLanguage == glslang::EShTargetNone) {
785 switch (ClientVersion) {
786 case glslang::EShTargetVulkan_1_0:
787 TargetLanguage = glslang::EShTargetSpv;
788 TargetVersion = glslang::EShTargetSpv_1_0;
789 break;
790 case glslang::EShTargetVulkan_1_1:
791 TargetLanguage = glslang::EShTargetSpv;
792 TargetVersion = glslang::EShTargetSpv_1_3;
793 break;
794 case glslang::EShTargetOpenGL_450:
795 TargetLanguage = glslang::EShTargetSpv;
796 TargetVersion = glslang::EShTargetSpv_1_0;
797 break;
798 default:
799 break;
800 }
801 }
802 if (TargetLanguage != glslang::EShTargetNone && Client == glslang::EShClientNone)
803 Error("To generate SPIR-V, also specify client semantics. See -G and -V.");
John Kessenich2b07c7e2013-07-31 18:44:13 +0000804}
805
John Kessenich68d78fd2015-07-12 19:28:10 -0600806//
807// Translate the meaningful subset of command-line options to parser-behavior options.
808//
John Kessenichb0a7eb52013-11-07 17:44:20 +0000809void SetMessageOptions(EShMessages& messages)
810{
811 if (Options & EOptionRelaxedErrors)
812 messages = (EShMessages)(messages | EShMsgRelaxedErrors);
813 if (Options & EOptionIntermediate)
814 messages = (EShMessages)(messages | EShMsgAST);
815 if (Options & EOptionSuppressWarnings)
816 messages = (EShMessages)(messages | EShMsgSuppressWarnings);
John Kessenich68d78fd2015-07-12 19:28:10 -0600817 if (Options & EOptionSpv)
818 messages = (EShMessages)(messages | EShMsgSpvRules);
819 if (Options & EOptionVulkanRules)
820 messages = (EShMessages)(messages | EShMsgVulkanRules);
Andrew Woloszynaae1ad82015-06-24 17:00:46 -0400821 if (Options & EOptionOutputPreprocessed)
822 messages = (EShMessages)(messages | EShMsgOnlyPreprocessor);
John Kessenich66e2faf2016-03-12 18:34:36 -0700823 if (Options & EOptionReadHlsl)
824 messages = (EShMessages)(messages | EShMsgReadHlsl);
John Kessenicha86836e2016-07-09 14:50:57 -0600825 if (Options & EOptionCascadingErrors)
826 messages = (EShMessages)(messages | EShMsgCascadingErrors);
John Kessenich906cc212016-12-09 19:22:20 -0700827 if (Options & EOptionKeepUncalled)
828 messages = (EShMessages)(messages | EShMsgKeepUncalled);
John Kessenich4f1403e2017-04-05 17:38:20 -0600829 if (Options & EOptionHlslOffsets)
830 messages = (EShMessages)(messages | EShMsgHlslOffsets);
John Kessenich121853f2017-05-31 17:11:16 -0600831 if (Options & EOptionDebug)
832 messages = (EShMessages)(messages | EShMsgDebugInfo);
Rex Xucb61eec2018-03-07 13:10:01 +0800833 if (HlslEnable16BitTypes)
834 messages = (EShMessages)(messages | EShMsgHlslEnable16BitTypes);
GregFfb03a552018-03-29 11:49:14 -0600835 if ((Options & EOptionOptimizeDisable) || !ENABLE_OPT)
836 messages = (EShMessages)(messages | EShMsgHlslLegalization);
John Kessenichbd1c1832018-12-07 18:38:26 -0700837 if (HlslDX9compatible)
838 messages = (EShMessages)(messages | EShMsgHlslDX9Compatible);
Christoph Kubisch55ba3ea2019-04-13 22:18:16 +0200839 if (DumpBuiltinSymbols)
840 messages = (EShMessages)(messages | EShMsgBuiltinSymbolTable);
John Kessenichb0a7eb52013-11-07 17:44:20 +0000841}
842
John Kessenich68d78fd2015-07-12 19:28:10 -0600843//
John Kessenich69f4b512013-09-04 21:19:27 +0000844// Thread entry point, for non-linking asynchronous mode.
John Kessenichc999ba22013-11-07 23:33:24 +0000845//
Juan Lopeza558b262017-04-02 23:04:00 +0200846void CompileShaders(glslang::TWorklist& worklist)
John Kessenich2b07c7e2013-07-31 18:44:13 +0000847{
John Kessenich7f0bcfd2018-04-05 19:00:01 -0600848 if (Options & EOptionDebug)
849 Error("cannot generate debug information unless linking to generate code");
850
John Kessenich38f3b892013-09-06 19:52:57 +0000851 glslang::TWorkItem* workItem;
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +0200852 if (Options & EOptionStdin) {
John Kesseniche7f9cae2018-07-12 15:11:07 -0600853 if (worklist.remove(workItem)) {
854 ShHandle compiler = ShConstructCompiler(FindLanguage("stdin"), Options);
855 if (compiler == nullptr)
856 return;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000857
John Kesseniche7f9cae2018-07-12 15:11:07 -0600858 CompileFile("stdin", compiler);
John Kessenich2b07c7e2013-07-31 18:44:13 +0000859
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +0200860 if (! (Options & EOptionSuppressInfolog))
861 workItem->results = ShGetInfoLog(compiler);
John Kessenich2b07c7e2013-07-31 18:44:13 +0000862
John Kesseniche7f9cae2018-07-12 15:11:07 -0600863 ShDestruct(compiler);
864 }
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +0200865 } else {
866 while (worklist.remove(workItem)) {
867 ShHandle compiler = ShConstructCompiler(FindLanguage(workItem->name), Options);
868 if (compiler == 0)
869 return;
870
871 CompileFile(workItem->name.c_str(), compiler);
872
873 if (! (Options & EOptionSuppressInfolog))
874 workItem->results = ShGetInfoLog(compiler);
875
876 ShDestruct(compiler);
877 }
John Kessenich2b07c7e2013-07-31 18:44:13 +0000878 }
John Kessenich2b07c7e2013-07-31 18:44:13 +0000879}
880
John Kessenich6626cad2015-06-19 05:14:19 +0000881// Outputs the given string, but only if it is non-null and non-empty.
882// This prevents erroneous newlines from appearing.
Andrew Woloszynaae1ad82015-06-24 17:00:46 -0400883void PutsIfNonEmpty(const char* str)
John Kessenich6626cad2015-06-19 05:14:19 +0000884{
885 if (str && str[0]) {
886 puts(str);
887 }
888}
889
Andrew Woloszynaae1ad82015-06-24 17:00:46 -0400890// Outputs the given string to stderr, but only if it is non-null and non-empty.
891// This prevents erroneous newlines from appearing.
892void StderrIfNonEmpty(const char* str)
893{
John Kessenich04acb1b2017-06-14 17:36:50 -0600894 if (str && str[0])
895 fprintf(stderr, "%s\n", str);
Andrew Woloszynaae1ad82015-06-24 17:00:46 -0400896}
897
John Kessenichc57b2a92016-01-16 15:30:03 -0700898// Simple bundling of what makes a compilation unit for ease in passing around,
899// and separation of handling file IO versus API (programmatic) compilation.
900struct ShaderCompUnit {
901 EShLanguage stage;
John Kessenich04acb1b2017-06-14 17:36:50 -0600902 static const int maxCount = 1;
903 int count; // live number of strings/names
John Kessenicha9313662017-06-15 10:40:49 -0600904 const char* text[maxCount]; // memory owned/managed externally
John Kessenich04acb1b2017-06-14 17:36:50 -0600905 std::string fileName[maxCount]; // hold's the memory, but...
906 const char* fileNameList[maxCount]; // downstream interface wants pointers
dankbakerafe6e9c2016-08-21 12:29:08 -0400907
John Kessenich04acb1b2017-06-14 17:36:50 -0600908 ShaderCompUnit(EShLanguage stage) : stage(stage), count(0) { }
dankbakerafe6e9c2016-08-21 12:29:08 -0400909
John Kessenich04acb1b2017-06-14 17:36:50 -0600910 ShaderCompUnit(const ShaderCompUnit& rhs)
dankbakerafe6e9c2016-08-21 12:29:08 -0400911 {
912 stage = rhs.stage;
John Kessenich04acb1b2017-06-14 17:36:50 -0600913 count = rhs.count;
914 for (int i = 0; i < count; ++i) {
915 fileName[i] = rhs.fileName[i];
916 text[i] = rhs.text[i];
917 fileNameList[i] = rhs.fileName[i].c_str();
918 }
dankbakerafe6e9c2016-08-21 12:29:08 -0400919 }
920
John Kessenicha9313662017-06-15 10:40:49 -0600921 void addString(std::string& ifileName, const char* itext)
John Kessenich04acb1b2017-06-14 17:36:50 -0600922 {
923 assert(count < maxCount);
924 fileName[count] = ifileName;
925 text[count] = itext;
926 fileNameList[count] = fileName[count].c_str();
927 ++count;
928 }
John Kessenichc57b2a92016-01-16 15:30:03 -0700929};
930
John Kessenich69f4b512013-09-04 21:19:27 +0000931//
John Kessenichc57b2a92016-01-16 15:30:03 -0700932// For linking mode: Will independently parse each compilation unit, but then put them
933// in the same program and link them together, making at most one linked module per
934// pipeline stage.
John Kessenich69f4b512013-09-04 21:19:27 +0000935//
936// Uses the new C++ interface instead of the old handle-based interface.
937//
John Kessenichc57b2a92016-01-16 15:30:03 -0700938
939void CompileAndLinkShaderUnits(std::vector<ShaderCompUnit> compUnits)
John Kessenich69f4b512013-09-04 21:19:27 +0000940{
941 // keep track of what to free
942 std::list<glslang::TShader*> shaders;
John Kessenichc57b2a92016-01-16 15:30:03 -0700943
John Kessenich69f4b512013-09-04 21:19:27 +0000944 EShMessages messages = EShMsgDefault;
John Kessenichb0a7eb52013-11-07 17:44:20 +0000945 SetMessageOptions(messages);
John Kessenich69f4b512013-09-04 21:19:27 +0000946
John Kessenich69f4b512013-09-04 21:19:27 +0000947 //
948 // Per-shader processing...
949 //
950
John Kessenich5b0f13a2013-11-01 03:08:40 +0000951 glslang::TProgram& program = *new glslang::TProgram;
rdb32084e82016-02-23 22:17:38 +0100952 for (auto it = compUnits.cbegin(); it != compUnits.cend(); ++it) {
953 const auto &compUnit = *it;
John Kessenichc57b2a92016-01-16 15:30:03 -0700954 glslang::TShader* shader = new glslang::TShader(compUnit.stage);
John Kessenich04acb1b2017-06-14 17:36:50 -0600955 shader->setStringsWithLengthsAndNames(compUnit.text, NULL, compUnit.fileNameList, compUnit.count);
John Kessenich640bd092018-08-09 14:15:00 -0600956 if (entryPointName)
John Kessenich4d65ee32016-03-12 18:17:47 -0700957 shader->setEntryPoint(entryPointName);
John Kessenich3693e632017-09-29 17:51:52 -0600958 if (sourceEntryPointName) {
959 if (entryPointName == nullptr)
960 printf("Warning: Changing source entry point name without setting an entry-point name.\n"
961 "Use '-e <name>'.\n");
steve-lunargf1e0c872016-10-31 15:13:43 -0600962 shader->setSourceEntryPoint(sourceEntryPointName);
John Kessenich3693e632017-09-29 17:51:52 -0600963 }
John Kessenicha9313662017-06-15 10:40:49 -0600964 if (UserPreamble.isSet())
965 shader->setPreamble(UserPreamble.get());
John Kessenich2a271162017-07-20 20:00:36 -0600966 shader->addProcesses(Processes);
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600967
LoopDawg08a14422017-10-17 19:27:14 -0600968 // Set IO mapper binding shift values
969 for (int r = 0; r < glslang::EResCount; ++r) {
970 const glslang::TResourceType res = glslang::TResourceType(r);
971
972 // Set base bindings
973 shader->setShiftBinding(res, baseBinding[res][compUnit.stage]);
974
975 // Set bindings for particular resource sets
976 // TODO: use a range based for loop here, when available in all environments.
977 for (auto i = baseBindingForSet[res][compUnit.stage].begin();
978 i != baseBindingForSet[res][compUnit.stage].end(); ++i)
LoopDawge5709552017-10-21 10:46:39 -0600979 shader->setShiftBindingForSet(res, i->second, i->first);
LoopDawg08a14422017-10-17 19:27:14 -0600980 }
981
steve-lunarge0b9deb2016-09-16 13:26:37 -0600982 shader->setFlattenUniformArrays((Options & EOptionFlattenUniformArrays) != 0);
steve-lunargcce8d482016-10-14 18:36:42 -0600983 shader->setNoStorageFormat((Options & EOptionNoStorageFormat) != 0);
Hyangran Park36dc8292017-05-02 16:27:29 +0900984 shader->setResourceSetBinding(baseResourceSetBinding[compUnit.stage]);
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600985
steve-lunargbe283552017-04-18 12:18:01 -0600986 if (Options & EOptionHlslIoMapping)
987 shader->setHlslIoMapping(true);
988
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600989 if (Options & EOptionAutoMapBindings)
990 shader->setAutoMapBindings(true);
John Kessenichecba76f2017-01-06 00:34:48 -0700991
John Kessenich71facdf2017-05-17 18:28:19 -0600992 if (Options & EOptionAutoMapLocations)
993 shader->setAutoMapLocations(true);
994
LoopDawgb22c0692017-12-06 16:52:03 -0700995 if (Options & EOptionInvertY)
996 shader->setInvertY(true);
997
Neil Roberts16f53472018-03-20 17:30:53 +0100998 for (auto& uniOverride : uniformLocationOverrides) {
999 shader->addUniformLocationOverride(uniOverride.first.c_str(),
1000 uniOverride.second);
1001 }
1002
Neil Robertsb0f3d792018-03-20 17:41:05 +01001003 shader->setUniformLocationBase(uniformBase);
1004
John Kessenich4be4aeb2017-06-23 10:50:22 -06001005 // Set up the environment, some subsettings take precedence over earlier
1006 // ways of setting things.
1007 if (Options & EOptionSpv) {
John Kessenich8717a5d2018-10-26 10:12:32 -06001008 shader->setEnvInput((Options & EOptionReadHlsl) ? glslang::EShSourceHlsl
1009 : glslang::EShSourceGlsl,
1010 compUnit.stage, Client, ClientInputSemanticsVersion);
1011 shader->setEnvClient(Client, ClientVersion);
1012 shader->setEnvTarget(TargetLanguage, TargetVersion);
John Kessenich5d610ee2018-03-07 18:05:55 -07001013 if (targetHlslFunctionality1)
1014 shader->setEnvTargetHlslFunctionality1();
John Kessenich4be4aeb2017-06-23 10:50:22 -06001015 }
1016
John Kessenich69f4b512013-09-04 21:19:27 +00001017 shaders.push_back(shader);
John Kessenichb3297152015-07-11 18:01:03 -06001018
John Kessenich4be4aeb2017-06-23 10:50:22 -06001019 const int defaultVersion = Options & EOptionDefaultDesktop ? 110 : 100;
John Kessenich69f4b512013-09-04 21:19:27 +00001020
John Kessenich3494b4d2017-05-22 15:00:42 -06001021 DirStackFileIncluder includer;
John Kessenich971a0a82017-06-07 15:06:58 -06001022 std::for_each(IncludeDirectoryList.rbegin(), IncludeDirectoryList.rend(), [&includer](const std::string& dir) {
1023 includer.pushExternalLocalDirectory(dir); });
John Kessenichc555ddd2015-06-17 02:38:44 +00001024 if (Options & EOptionOutputPreprocessed) {
1025 std::string str;
John Kessenich086febc2018-10-25 12:43:02 -06001026 if (shader->preprocess(&Resources, defaultVersion, ENoProfile, false, false, messages, &str, includer)) {
Andrew Woloszynaae1ad82015-06-24 17:00:46 -04001027 PutsIfNonEmpty(str.c_str());
1028 } else {
1029 CompileFailed = true;
1030 }
1031 StderrIfNonEmpty(shader->getInfoLog());
1032 StderrIfNonEmpty(shader->getInfoDebugLog());
John Kessenichc555ddd2015-06-17 02:38:44 +00001033 continue;
1034 }
John Kessenich086febc2018-10-25 12:43:02 -06001035
John Kessenich3494b4d2017-05-22 15:00:42 -06001036 if (! shader->parse(&Resources, defaultVersion, false, messages, includer))
John Kessenichc999ba22013-11-07 23:33:24 +00001037 CompileFailed = true;
John Kessenichc555ddd2015-06-17 02:38:44 +00001038
John Kessenich69f4b512013-09-04 21:19:27 +00001039 program.addShader(shader);
1040
John Kessenichc57b2a92016-01-16 15:30:03 -07001041 if (! (Options & EOptionSuppressInfolog) &&
1042 ! (Options & EOptionMemoryLeakMode)) {
John Kessenich04acb1b2017-06-14 17:36:50 -06001043 PutsIfNonEmpty(compUnit.fileName[0].c_str());
Andrew Woloszynaae1ad82015-06-24 17:00:46 -04001044 PutsIfNonEmpty(shader->getInfoLog());
1045 PutsIfNonEmpty(shader->getInfoDebugLog());
John Kessenich69f4b512013-09-04 21:19:27 +00001046 }
John Kessenich69f4b512013-09-04 21:19:27 +00001047 }
1048
1049 //
1050 // Program-level processing...
1051 //
1052
John Kessenich4d65ee32016-03-12 18:17:47 -07001053 // Link
John Kessenich68d78fd2015-07-12 19:28:10 -06001054 if (! (Options & EOptionOutputPreprocessed) && ! program.link(messages))
John Kessenichc999ba22013-11-07 23:33:24 +00001055 LinkFailed = true;
1056
steve-lunarg9ae34742016-10-05 13:40:13 -06001057 // Map IO
1058 if (Options & EOptionSpv) {
1059 if (!program.mapIO())
1060 LinkFailed = true;
1061 }
John Kessenichecba76f2017-01-06 00:34:48 -07001062
John Kessenich4d65ee32016-03-12 18:17:47 -07001063 // Report
John Kessenichc57b2a92016-01-16 15:30:03 -07001064 if (! (Options & EOptionSuppressInfolog) &&
1065 ! (Options & EOptionMemoryLeakMode)) {
Andrew Woloszynaae1ad82015-06-24 17:00:46 -04001066 PutsIfNonEmpty(program.getInfoLog());
1067 PutsIfNonEmpty(program.getInfoDebugLog());
John Kessenich69f4b512013-09-04 21:19:27 +00001068 }
1069
John Kessenich4d65ee32016-03-12 18:17:47 -07001070 // Reflect
John Kessenich11f9fc72013-11-07 01:06:34 +00001071 if (Options & EOptionDumpReflection) {
baldurk6d477852019-01-29 15:45:56 +00001072 program.buildReflection(ReflectOptions);
John Kessenich11f9fc72013-11-07 01:06:34 +00001073 program.dumpReflection();
1074 }
1075
John Kessenich4d65ee32016-03-12 18:17:47 -07001076 // Dump SPIR-V
John Kessenich0df0cde2015-03-03 17:09:43 +00001077 if (Options & EOptionSpv) {
John Kessenich92f90382014-07-28 04:21:04 +00001078 if (CompileFailed || LinkFailed)
John Kessenich68d78fd2015-07-12 19:28:10 -06001079 printf("SPIR-V is not generated for failed compile or link\n");
John Kessenich92f90382014-07-28 04:21:04 +00001080 else {
1081 for (int stage = 0; stage < EShLangCount; ++stage) {
John Kessenicha7a68a92014-08-24 18:21:00 +00001082 if (program.getIntermediate((EShLanguage)stage)) {
John Kessenich0df0cde2015-03-03 17:09:43 +00001083 std::vector<unsigned int> spirv;
Lei Zhang09caf122016-05-02 18:11:54 -04001084 std::string warningsErrors;
Lei Zhang17535f72016-05-04 15:55:59 -04001085 spv::SpvBuildLogger logger;
John Kessenich121853f2017-05-31 17:11:16 -06001086 glslang::SpvOptions spvOptions;
1087 if (Options & EOptionDebug)
1088 spvOptions.generateDebugInfo = true;
GregF52fe3d52017-09-28 10:08:32 -06001089 spvOptions.disableOptimizer = (Options & EOptionOptimizeDisable) != 0;
1090 spvOptions.optimizeSize = (Options & EOptionOptimizeSize) != 0;
John Kessenich717c80a2018-08-23 15:17:10 -06001091 spvOptions.disassemble = SpvToolsDisassembler;
John Kessenichc3404252018-08-23 15:29:08 -06001092 spvOptions.validate = SpvToolsValidate;
John Kessenich121853f2017-05-31 17:11:16 -06001093 glslang::GlslangToSpv(*program.getIntermediate((EShLanguage)stage), spirv, &logger, &spvOptions);
John Kessenichc57b2a92016-01-16 15:30:03 -07001094
1095 // Dump the spv to a file or stdout, etc., but only if not doing
1096 // memory/perf testing, as it's not internal to programmatic use.
1097 if (! (Options & EOptionMemoryLeakMode)) {
Johannes van Waverenecb0f3b2016-05-27 12:55:53 -05001098 printf("%s", logger.getAllMessages().c_str());
1099 if (Options & EOptionOutputHexadecimal) {
John Kessenich8f674e82017-02-18 09:45:40 -07001100 glslang::OutputSpvHex(spirv, GetBinaryName((EShLanguage)stage), variableName);
Johannes van Waverenecb0f3b2016-05-27 12:55:53 -05001101 } else {
1102 glslang::OutputSpvBin(spirv, GetBinaryName((EShLanguage)stage));
1103 }
John Kesseniche2156222018-06-11 18:12:15 -06001104 if (!SpvToolsDisassembler && (Options & EOptionHumanReadableSpv))
John Kessenichc57b2a92016-01-16 15:30:03 -07001105 spv::Disassemble(std::cout, spirv);
John Kessenichacba7722015-03-04 03:48:38 +00001106 }
John Kessenicha7a68a92014-08-24 18:21:00 +00001107 }
John Kessenich92f90382014-07-28 04:21:04 +00001108 }
1109 }
1110 }
1111
John Kessenich5b0f13a2013-11-01 03:08:40 +00001112 // Free everything up, program has to go before the shaders
1113 // because it might have merged stuff from the shaders, and
1114 // the stuff from the shaders has to have its destructors called
1115 // before the pools holding the memory in the shaders is freed.
1116 delete &program;
John Kessenich69f4b512013-09-04 21:19:27 +00001117 while (shaders.size() > 0) {
1118 delete shaders.back();
1119 shaders.pop_back();
1120 }
John Kessenich69f4b512013-09-04 21:19:27 +00001121}
1122
John Kessenichc57b2a92016-01-16 15:30:03 -07001123//
1124// Do file IO part of compile and link, handing off the pure
1125// API/programmatic mode to CompileAndLinkShaderUnits(), which can
1126// be put in a loop for testing memory footprint and performance.
1127//
1128// This is just for linking mode: meaning all the shaders will be put into the
1129// the same program linked together.
1130//
1131// This means there are a limited number of work items (not multi-threading mode)
1132// and that the point is testing at the linking level. Hence, to enable
1133// performance and memory testing, the actual compile/link can be put in
1134// a loop, independent of processing the work items and file IO.
1135//
Juan Lopeza558b262017-04-02 23:04:00 +02001136void CompileAndLinkShaderFiles(glslang::TWorklist& Worklist)
John Kessenichc57b2a92016-01-16 15:30:03 -07001137{
1138 std::vector<ShaderCompUnit> compUnits;
1139
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001140 // If this is using stdin, we can't really detect multiple different file
1141 // units by input type. We need to assume that we're just being given one
1142 // file of a certain type.
1143 if ((Options & EOptionStdin) != 0) {
1144 ShaderCompUnit compUnit(FindLanguage("stdin"));
1145 std::istreambuf_iterator<char> begin(std::cin), end;
1146 std::string tempString(begin, end);
1147 char* fileText = strdup(tempString.c_str());
1148 std::string fileName = "stdin";
1149 compUnit.addString(fileName, fileText);
John Kessenichc57b2a92016-01-16 15:30:03 -07001150 compUnits.push_back(compUnit);
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001151 } else {
1152 // Transfer all the work items from to a simple list of
1153 // of compilation units. (We don't care about the thread
1154 // work-item distribution properties in this path, which
1155 // is okay due to the limited number of shaders, know since
1156 // they are all getting linked together.)
1157 glslang::TWorkItem* workItem;
1158 while (Worklist.remove(workItem)) {
1159 ShaderCompUnit compUnit(FindLanguage(workItem->name));
1160 char* fileText = ReadFileData(workItem->name.c_str());
1161 if (fileText == nullptr)
1162 usage();
1163 compUnit.addString(workItem->name, fileText);
1164 compUnits.push_back(compUnit);
1165 }
John Kessenichc57b2a92016-01-16 15:30:03 -07001166 }
1167
1168 // Actual call to programmatic processing of compile and link,
1169 // in a loop for testing memory and performance. This part contains
1170 // all the perf/memory that a programmatic consumer will care about.
1171 for (int i = 0; i < ((Options & EOptionMemoryLeakMode) ? 100 : 1); ++i) {
1172 for (int j = 0; j < ((Options & EOptionMemoryLeakMode) ? 100 : 1); ++j)
1173 CompileAndLinkShaderUnits(compUnits);
1174
1175 if (Options & EOptionMemoryLeakMode)
1176 glslang::OS_DumpMemoryCounters();
1177 }
1178
John Kessenicha9313662017-06-15 10:40:49 -06001179 // free memory from ReadFileData, which got stored in a const char*
1180 // as the first string above
rdb32084e82016-02-23 22:17:38 +01001181 for (auto it = compUnits.begin(); it != compUnits.end(); ++it)
John Kessenicha9313662017-06-15 10:40:49 -06001182 FreeFileData(const_cast<char*>(it->text[0]));
John Kessenichc57b2a92016-01-16 15:30:03 -07001183}
1184
John Kessenich94f28eb2017-11-13 01:32:06 -07001185int singleMain()
John Kessenicha0af4732012-12-12 21:15:54 +00001186{
Juan Lopeza558b262017-04-02 23:04:00 +02001187 glslang::TWorklist workList;
John Kessenich94f28eb2017-11-13 01:32:06 -07001188 std::for_each(WorkItems.begin(), WorkItems.end(), [&workList](std::unique_ptr<glslang::TWorkItem>& item) {
Juan Lopeza558b262017-04-02 23:04:00 +02001189 assert(item);
1190 workList.add(item.get());
1191 });
John Kessenich2b07c7e2013-07-31 18:44:13 +00001192
John Kessenich05a70632013-09-17 19:26:08 +00001193 if (Options & EOptionDumpConfig) {
Lei Zhang414eb602016-03-04 16:22:34 -05001194 printf("%s", glslang::GetDefaultTBuiltInResourceString().c_str());
Juan Lopeza558b262017-04-02 23:04:00 +02001195 if (workList.empty())
John Kessenich05a70632013-09-17 19:26:08 +00001196 return ESuccess;
1197 }
1198
John Kessenichc6c80a62018-03-05 22:23:17 -07001199 if (Options & EOptionDumpBareVersion) {
1200 printf("%d.%d.%d\n",
1201 glslang::GetSpirvGeneratorVersion(), GLSLANG_MINOR_VERSION, GLSLANG_PATCH_LEVEL);
1202 if (workList.empty())
1203 return ESuccess;
1204 } else if (Options & EOptionDumpVersions) {
1205 printf("Glslang Version: %d.%d.%d\n",
1206 glslang::GetSpirvGeneratorVersion(), GLSLANG_MINOR_VERSION, GLSLANG_PATCH_LEVEL);
John Kessenich319de232013-12-04 04:43:40 +00001207 printf("ESSL Version: %s\n", glslang::GetEsslVersionString());
1208 printf("GLSL Version: %s\n", glslang::GetGlslVersionString());
John Kessenich68d78fd2015-07-12 19:28:10 -06001209 std::string spirvVersion;
1210 glslang::GetSpirvVersion(spirvVersion);
John Kessenich0da9eaa2015-08-01 17:10:02 -06001211 printf("SPIR-V Version %s\n", spirvVersion.c_str());
John Kessenich5e4b1242015-08-06 22:53:06 -06001212 printf("GLSL.std.450 Version %d, Revision %d\n", GLSLstd450Version, GLSLstd450Revision);
John Kessenich55e7d112015-11-15 21:33:39 -07001213 printf("Khronos Tool ID %d\n", glslang::GetKhronosToolId());
John Kessenicha372a3e2017-11-02 22:32:14 -06001214 printf("SPIR-V Generator Version %d\n", glslang::GetSpirvGeneratorVersion());
John Kessenichb84313d2016-07-20 16:03:29 -06001215 printf("GL_KHR_vulkan_glsl version %d\n", 100);
1216 printf("ARB_GL_gl_spirv version %d\n", 100);
Juan Lopeza558b262017-04-02 23:04:00 +02001217 if (workList.empty())
John Kessenich319de232013-12-04 04:43:40 +00001218 return ESuccess;
1219 }
1220
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001221 if (workList.empty() && ((Options & EOptionStdin) == 0)) {
John Kessenich05a70632013-09-17 19:26:08 +00001222 usage();
John Kessenich05a70632013-09-17 19:26:08 +00001223 }
1224
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001225 if (Options & EOptionStdin) {
John Kessenich94f28eb2017-11-13 01:32:06 -07001226 WorkItems.push_back(std::unique_ptr<glslang::TWorkItem>{new glslang::TWorkItem("stdin")});
1227 workList.add(WorkItems.back().get());
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001228 }
1229
John Kessenich05a70632013-09-17 19:26:08 +00001230 ProcessConfigFile();
1231
John Kessenich086febc2018-10-25 12:43:02 -06001232 if ((Options & EOptionReadHlsl) && !((Options & EOptionOutputPreprocessed) || (Options & EOptionSpv)))
1233 Error("ERROR: HLSL requires SPIR-V code generation (or preprocessing only)");
1234
John Kessenich69f4b512013-09-04 21:19:27 +00001235 //
1236 // Two modes:
John Kessenich38f3b892013-09-06 19:52:57 +00001237 // 1) linking all arguments together, single-threaded, new C++ interface
1238 // 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 +00001239 //
John Kessenich086febc2018-10-25 12:43:02 -06001240 if (Options & (EOptionLinkProgram | EOptionOutputPreprocessed)) {
John Kessenichc36e1d82013-11-01 17:41:52 +00001241 glslang::InitializeProcess();
John Kesseniche2c15b42017-11-16 22:48:41 -07001242 glslang::InitializeProcess(); // also test reference counting of users
1243 glslang::InitializeProcess(); // also test reference counting of users
1244 glslang::FinalizeProcess(); // also test reference counting of users
1245 glslang::FinalizeProcess(); // also test reference counting of users
Juan Lopeza558b262017-04-02 23:04:00 +02001246 CompileAndLinkShaderFiles(workList);
John Kessenichc36e1d82013-11-01 17:41:52 +00001247 glslang::FinalizeProcess();
1248 } else {
1249 ShInitialize();
John Kesseniche2c15b42017-11-16 22:48:41 -07001250 ShInitialize(); // also test reference counting of users
1251 ShFinalize(); // also test reference counting of users
John Kessenichc36e1d82013-11-01 17:41:52 +00001252
Juan Lopeza558b262017-04-02 23:04:00 +02001253 bool printShaderNames = workList.size() > 1;
John Kessenich69f4b512013-09-04 21:19:27 +00001254
John Kesseniche2c15b42017-11-16 22:48:41 -07001255 if (Options & EOptionMultiThreaded) {
Juan Lopeza558b262017-04-02 23:04:00 +02001256 std::array<std::thread, 16> threads;
John Kesseniche2c15b42017-11-16 22:48:41 -07001257 for (unsigned int t = 0; t < threads.size(); ++t) {
Juan Lopeza558b262017-04-02 23:04:00 +02001258 threads[t] = std::thread(CompileShaders, std::ref(workList));
John Kesseniche2c15b42017-11-16 22:48:41 -07001259 if (threads[t].get_id() == std::thread::id()) {
John Kessenichaf527992017-11-02 22:48:15 -06001260 fprintf(stderr, "Failed to create thread\n");
John Kessenich38f3b892013-09-06 19:52:57 +00001261 return EFailThreadCreate;
1262 }
John Kessenicha0af4732012-12-12 21:15:54 +00001263 }
Juan Lopeza558b262017-04-02 23:04:00 +02001264
1265 std::for_each(threads.begin(), threads.end(), [](std::thread& t) { t.join(); });
John Kessenichc999ba22013-11-07 23:33:24 +00001266 } else
Juan Lopeza558b262017-04-02 23:04:00 +02001267 CompileShaders(workList);
John Kessenich38f3b892013-09-06 19:52:57 +00001268
1269 // Print out all the resulting infologs
John Kessenich94f28eb2017-11-13 01:32:06 -07001270 for (size_t w = 0; w < WorkItems.size(); ++w) {
1271 if (WorkItems[w]) {
1272 if (printShaderNames || WorkItems[w]->results.size() > 0)
1273 PutsIfNonEmpty(WorkItems[w]->name.c_str());
1274 PutsIfNonEmpty(WorkItems[w]->results.c_str());
John Kessenich38f3b892013-09-06 19:52:57 +00001275 }
1276 }
John Kessenichc36e1d82013-11-01 17:41:52 +00001277
1278 ShFinalize();
John Kessenicha0af4732012-12-12 21:15:54 +00001279 }
John Kessenich2b07c7e2013-07-31 18:44:13 +00001280
John Kessenichc999ba22013-11-07 23:33:24 +00001281 if (CompileFailed)
John Kessenicha0af4732012-12-12 21:15:54 +00001282 return EFailCompile;
John Kessenichc999ba22013-11-07 23:33:24 +00001283 if (LinkFailed)
John Kessenicha0af4732012-12-12 21:15:54 +00001284 return EFailLink;
1285
1286 return 0;
1287}
1288
John Kessenich94f28eb2017-11-13 01:32:06 -07001289int C_DECL main(int argc, char* argv[])
1290{
1291 ProcessArguments(WorkItems, argc, argv);
1292
1293 int ret = 0;
1294
1295 // Loop over the entire init/finalize cycle to watch memory changes
1296 const int iterations = 1;
1297 if (iterations > 1)
1298 glslang::OS_DumpMemoryCounters();
1299 for (int i = 0; i < iterations; ++i) {
1300 ret = singleMain();
1301 if (iterations > 1)
1302 glslang::OS_DumpMemoryCounters();
1303 }
1304
1305 return ret;
1306}
1307
John Kessenicha0af4732012-12-12 21:15:54 +00001308//
1309// Deduce the language from the filename. Files must end in one of the
1310// following extensions:
1311//
John Kessenich2b07c7e2013-07-31 18:44:13 +00001312// .vert = vertex
1313// .tesc = tessellation control
1314// .tese = tessellation evaluation
1315// .geom = geometry
1316// .frag = fragment
John Kessenich94a81fb2013-08-31 02:41:30 +00001317// .comp = compute
Chao Chenb50c02e2018-09-19 11:42:24 -07001318// .rgen = ray generation
1319// .rint = ray intersection
1320// .rahit = ray any hit
1321// .rchit = ray closest hit
1322// .rmiss = ray miss
1323// .rcall = ray callable
Sahil Parmar035cbbe2018-10-04 16:39:18 -07001324// .mesh = mesh
1325// .task = task
Grigory Dzhavadyan33507412018-04-12 14:35:24 -07001326// Additionally, the file names may end in .<stage>.glsl and .<stage>.hlsl
1327// where <stage> is one of the stages listed above.
1328//
1329EShLanguage FindLanguage(const std::string& name, bool parseStageName)
John Kessenicha0af4732012-12-12 21:15:54 +00001330{
John Kessenichfccbb8b2018-04-17 17:24:03 -06001331 std::string stageName;
Dan Bakerc6ede892016-08-11 14:06:06 -04001332 if (shaderStageName)
John Kessenichfccbb8b2018-04-17 17:24:03 -06001333 stageName = shaderStageName;
1334 else if (parseStageName) {
Grigory Dzhavadyan33507412018-04-12 14:35:24 -07001335 // Note: "first" extension means "first from the end", i.e.
1336 // if the file is named foo.vert.glsl, then "glsl" is first,
1337 // "vert" is second.
John Kessenichfccbb8b2018-04-17 17:24:03 -06001338 size_t firstExtStart = name.find_last_of(".");
1339 bool hasFirstExt = firstExtStart != std::string::npos;
1340 size_t secondExtStart = hasFirstExt ? name.find_last_of(".", firstExtStart - 1) : std::string::npos;
1341 bool hasSecondExt = secondExtStart != std::string::npos;
1342 std::string firstExt = name.substr(firstExtStart + 1, std::string::npos);
1343 bool usesUnifiedExt = hasFirstExt && (firstExt == "glsl" || firstExt == "hlsl");
John Kessenich3beac942018-04-17 21:02:19 -06001344 if (usesUnifiedExt && firstExt == "hlsl")
1345 Options |= EOptionReadHlsl;
1346 if (hasFirstExt && !usesUnifiedExt)
John Kessenichfccbb8b2018-04-17 17:24:03 -06001347 stageName = firstExt;
John Kessenich3beac942018-04-17 21:02:19 -06001348 else if (usesUnifiedExt && hasSecondExt)
John Kessenichfccbb8b2018-04-17 17:24:03 -06001349 stageName = name.substr(secondExtStart + 1, firstExtStart - secondExtStart - 1);
John Kessenich3beac942018-04-17 21:02:19 -06001350 else {
Grigory Dzhavadyan33507412018-04-12 14:35:24 -07001351 usage();
1352 return EShLangVertex;
John Kesseniche751bca2017-03-16 11:20:38 -06001353 }
John Kessenichfccbb8b2018-04-17 17:24:03 -06001354 } else
1355 stageName = name;
dankbaker45d49bc2016-08-08 21:43:07 -04001356
John Kessenichfccbb8b2018-04-17 17:24:03 -06001357 if (stageName == "vert")
John Kessenich2b07c7e2013-07-31 18:44:13 +00001358 return EShLangVertex;
John Kessenichfccbb8b2018-04-17 17:24:03 -06001359 else if (stageName == "tesc")
John Kessenich2b07c7e2013-07-31 18:44:13 +00001360 return EShLangTessControl;
John Kessenichfccbb8b2018-04-17 17:24:03 -06001361 else if (stageName == "tese")
John Kessenich2b07c7e2013-07-31 18:44:13 +00001362 return EShLangTessEvaluation;
John Kessenichfccbb8b2018-04-17 17:24:03 -06001363 else if (stageName == "geom")
John Kessenich2b07c7e2013-07-31 18:44:13 +00001364 return EShLangGeometry;
John Kessenichfccbb8b2018-04-17 17:24:03 -06001365 else if (stageName == "frag")
John Kessenich2b07c7e2013-07-31 18:44:13 +00001366 return EShLangFragment;
John Kessenichfccbb8b2018-04-17 17:24:03 -06001367 else if (stageName == "comp")
John Kessenichc0275792013-08-09 17:14:49 +00001368 return EShLangCompute;
Chao Chen3c366992018-09-19 11:41:59 -07001369#ifdef NV_EXTENSIONS
Chao Chenb50c02e2018-09-19 11:42:24 -07001370 else if (stageName == "rgen")
1371 return EShLangRayGenNV;
1372 else if (stageName == "rint")
1373 return EShLangIntersectNV;
1374 else if (stageName == "rahit")
1375 return EShLangAnyHitNV;
1376 else if (stageName == "rchit")
1377 return EShLangClosestHitNV;
1378 else if (stageName == "rmiss")
1379 return EShLangMissNV;
1380 else if (stageName == "rcall")
1381 return EShLangCallableNV;
Chao Chen3c366992018-09-19 11:41:59 -07001382 else if (stageName == "mesh")
1383 return EShLangMeshNV;
1384 else if (stageName == "task")
1385 return EShLangTaskNV;
1386#endif
John Kessenich2b07c7e2013-07-31 18:44:13 +00001387
1388 usage();
John Kesseniche95ecc52012-12-12 21:34:14 +00001389 return EShLangVertex;
John Kessenicha0af4732012-12-12 21:15:54 +00001390}
1391
John Kessenicha0af4732012-12-12 21:15:54 +00001392//
John Kessenichecba76f2017-01-06 00:34:48 -07001393// Read a file's data into a string, and compile it using the old interface ShCompile,
John Kessenich69f4b512013-09-04 21:19:27 +00001394// for non-linkable results.
John Kessenicha0af4732012-12-12 21:15:54 +00001395//
John Kessenich51cdd902014-02-18 23:37:57 +00001396void CompileFile(const char* fileName, ShHandle compiler)
John Kessenicha0af4732012-12-12 21:15:54 +00001397{
John Kessenichca3457f2015-05-18 01:59:45 +00001398 int ret = 0;
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001399 char* shaderString;
1400 if ((Options & EOptionStdin) != 0) {
1401 std::istreambuf_iterator<char> begin(std::cin), end;
1402 std::string tempString(begin, end);
1403 shaderString = strdup(tempString.c_str());
1404 } else {
1405 shaderString = ReadFileData(fileName);
1406 }
John Kessenich41cf6b52013-06-25 18:10:05 +00001407
1408 // move to length-based strings, rather than null-terminated strings
John Kessenich04acb1b2017-06-14 17:36:50 -06001409 int* lengths = new int[1];
1410 lengths[0] = (int)strlen(shaderString);
John Kessenicha0af4732012-12-12 21:15:54 +00001411
John Kessenich52ac67e2013-05-05 23:46:22 +00001412 EShMessages messages = EShMsgDefault;
John Kessenichb0a7eb52013-11-07 17:44:20 +00001413 SetMessageOptions(messages);
John Kessenichecba76f2017-01-06 00:34:48 -07001414
John Kessenicha9313662017-06-15 10:40:49 -06001415 if (UserPreamble.isSet())
1416 Error("-D and -U options require -l (linking)\n");
1417
John Kessenich94a81fb2013-08-31 02:41:30 +00001418 for (int i = 0; i < ((Options & EOptionMemoryLeakMode) ? 100 : 1); ++i) {
1419 for (int j = 0; j < ((Options & EOptionMemoryLeakMode) ? 100 : 1); ++j) {
John Kessenich927608b2017-01-06 12:34:14 -07001420 // ret = ShCompile(compiler, shaderStrings, NumShaderStrings, lengths, EShOptNone, &Resources, Options, (Options & EOptionDefaultDesktop) ? 110 : 100, false, messages);
John Kessenich04acb1b2017-06-14 17:36:50 -06001421 ret = ShCompile(compiler, &shaderString, 1, nullptr, EShOptNone, &Resources, Options, (Options & EOptionDefaultDesktop) ? 110 : 100, false, messages);
John Kessenich927608b2017-01-06 12:34:14 -07001422 // const char* multi[12] = { "# ve", "rsion", " 300 e", "s", "\n#err",
John Kessenichecba76f2017-01-06 00:34:48 -07001423 // "or should be l", "ine 1", "string 5\n", "float glo", "bal",
John Kessenichea869fb2013-10-28 18:12:06 +00001424 // ";\n#error should be line 2\n void main() {", "global = 2.3;}" };
John Kessenich927608b2017-01-06 12:34:14 -07001425 // const char* multi[7] = { "/", "/", "\\", "\n", "\n", "#", "version 300 es" };
1426 // ret = ShCompile(compiler, multi, 7, nullptr, EShOptNone, &Resources, Options, (Options & EOptionDefaultDesktop) ? 110 : 100, false, messages);
John Kessenich41cf6b52013-06-25 18:10:05 +00001427 }
John Kessenicha0af4732012-12-12 21:15:54 +00001428
John Kessenich94a81fb2013-08-31 02:41:30 +00001429 if (Options & EOptionMemoryLeakMode)
John Kessenich2b07c7e2013-07-31 18:44:13 +00001430 glslang::OS_DumpMemoryCounters();
John Kessenicha0af4732012-12-12 21:15:54 +00001431 }
John Kessenicha0af4732012-12-12 21:15:54 +00001432
John Kessenich41cf6b52013-06-25 18:10:05 +00001433 delete [] lengths;
John Kessenich04acb1b2017-06-14 17:36:50 -06001434 FreeFileData(shaderString);
John Kessenicha0af4732012-12-12 21:15:54 +00001435
John Kessenichc999ba22013-11-07 23:33:24 +00001436 if (ret == 0)
1437 CompileFailed = true;
John Kessenicha0af4732012-12-12 21:15:54 +00001438}
1439
John Kessenicha0af4732012-12-12 21:15:54 +00001440//
1441// print usage to stdout
1442//
1443void usage()
1444{
John Kessenich319de232013-12-04 04:43:40 +00001445 printf("Usage: glslangValidator [option]... [file]...\n"
1446 "\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001447 "'file' can end in .<stage> for auto-stage classification, where <stage> is:\n"
1448 " .conf to provide a config file that replaces the default configuration\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001449 " (see -c option below for generating a template)\n"
1450 " .vert for a vertex shader\n"
1451 " .tesc for a tessellation control shader\n"
1452 " .tese for a tessellation evaluation shader\n"
1453 " .geom for a geometry shader\n"
1454 " .frag for a fragment shader\n"
1455 " .comp for a compute shader\n"
Chao Chen3c366992018-09-19 11:41:59 -07001456#ifdef NV_EXTENSIONS
1457 " .mesh for a mesh shader\n"
1458 " .task for a task shader\n"
Chao Chenb50c02e2018-09-19 11:42:24 -07001459 " .rgen for a ray generation shader\n"
1460 " .rint for a ray intersection shader\n"
1461 " .rahit for a ray any hit shader\n"
1462 " .rchit for a ray closest hit shader\n"
1463 " .rmiss for a ray miss shader\n"
Sahil Parmar035cbbe2018-10-04 16:39:18 -07001464 " .rcall for a ray callable shader\n"
Chao Chen3c366992018-09-19 11:41:59 -07001465#endif
John Kessenich2ead40f2018-04-17 17:44:11 -06001466 " .glsl for .vert.glsl, .tesc.glsl, ..., .comp.glsl compound suffixes\n"
1467 " .hlsl for .vert.hlsl, .tesc.hlsl, ..., .comp.hlsl compound suffixes\n"
John Kessenich319de232013-12-04 04:43:40 +00001468 "\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001469 "Options:\n"
1470 " -C cascading errors; risk crash from accumulation of error recoveries\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001471 " -D input is HLSL (this is the default when any suffix is .hlsl)\n"
John Kessenicha9313662017-06-15 10:40:49 -06001472 " -D<macro=def>\n"
1473 " -D<macro> define a pre-processor macro\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001474 " -E print pre-processed GLSL; cannot be used with -l;\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001475 " errors will appear on stderr\n"
John Kessenich6353d552017-06-23 11:11:09 -06001476 " -G[ver] create SPIR-V binary, under OpenGL semantics; turns on -l;\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001477 " default file name is <stage>.spv (-o overrides this);\n"
John Kessenich6353d552017-06-23 11:11:09 -06001478 " 'ver', when present, is the version of the input semantics,\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001479 " which will appear in #define GL_SPIRV ver;\n"
1480 " '--client opengl100' is the same as -G100;\n"
John Kessenich6353d552017-06-23 11:11:09 -06001481 " a '--target-env' for OpenGL will also imply '-G'\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001482 " -H print human readable form of SPIR-V; turns on -V\n"
John Kessenich971a0a82017-06-07 15:06:58 -06001483 " -I<dir> add dir to the include search path; includer's directory\n"
1484 " is searched first, followed by left-to-right order of -I\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001485 " -Od disables optimization; may cause illegal SPIR-V for HLSL\n"
1486 " -Os optimizes SPIR-V to minimize size\n"
John Kesseniche751bca2017-03-16 11:20:38 -06001487 " -S <stage> uses specified stage rather than parsing the file extension\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001488 " choices for <stage> are vert, tesc, tese, geom, frag, or comp\n"
John Kessenich6353d552017-06-23 11:11:09 -06001489 " -U<macro> undefine a pre-processor macro\n"
1490 " -V[ver] create SPIR-V binary, under Vulkan semantics; turns on -l;\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001491 " default file name is <stage>.spv (-o overrides this)\n"
John Kessenich6353d552017-06-23 11:11:09 -06001492 " 'ver', when present, is the version of the input semantics,\n"
1493 " which will appear in #define VULKAN ver\n"
1494 " '--client vulkan100' is the same as -V100\n"
1495 " a '--target-env' for Vulkan will also imply '-V'\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001496 " -c configuration dump;\n"
1497 " creates the default configuration file (redirect to a .conf file)\n"
1498 " -d default to desktop (#version 110) when there is no shader #version\n"
1499 " (default is ES version 100)\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001500 " -e <name> | --entry-point <name>\n"
1501 " specify <name> as the entry-point function name\n"
John Kessenich5d610ee2018-03-07 18:05:55 -07001502 " -f{hlsl_functionality1}\n"
1503 " 'hlsl_functionality1' enables use of the\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001504 " SPV_GOOGLE_hlsl_functionality1 extension\n"
John Kessenich121853f2017-05-31 17:11:16 -06001505 " -g generate debug information\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001506 " -h print this usage message\n"
1507 " -i intermediate tree (glslang AST) is printed out\n"
1508 " -l link all input files together to form a single module\n"
1509 " -m memory leak mode\n"
John Kessenicha25530c2017-09-11 20:13:49 -06001510 " -o <file> save binary to <file>, requires a binary option (e.g., -V)\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001511 " -q dump reflection query database\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001512 " -r | --relaxed-errors"
1513 " relaxed GLSL semantic error-checking mode\n"
John Kessenichb63f4a32017-11-16 22:32:20 -07001514 " -s silence syntax and semantic error reporting\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001515 " -t multi-threaded mode\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001516 " -v | --version\n"
1517 " print version strings\n"
1518 " -w | --suppress-warnings\n"
1519 " suppress GLSL warnings, except as required by \"#extension : warn\"\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001520 " -x save binary output as text-based 32-bit hexadecimal numbers\n"
Neil Roberts16f53472018-03-20 17:30:53 +01001521 " -u<name>:<loc> specify a uniform location override for --aml\n"
Neil Robertsb0f3d792018-03-20 17:41:05 +01001522 " --uniform-base <base> set a base to use for generated uniform locations\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001523 " --auto-map-bindings | --amb automatically bind uniform variables\n"
1524 " without explicit bindings\n"
1525 " --auto-map-locations | --aml automatically locate input/output lacking\n"
1526 " 'location' (fragile, not cross stage)\n"
1527 " --client {vulkan<ver>|opengl<ver>} see -V and -G\n"
Christoph Kubisch55ba3ea2019-04-13 22:18:16 +02001528 " --dump-builtin-symbols prints builint symbol table prior each stage\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001529 " -dumpfullversion | -dumpversion print bare major.minor.patchlevel\n"
1530 " --flatten-uniform-arrays | --fua flatten uniform texture/sampler arrays to\n"
1531 " scalars\n"
1532 " --hlsl-offsets allow block offsets to follow HLSL rules\n"
1533 " works independently of source language\n"
1534 " --hlsl-iomap perform IO mapping in HLSL register space\n"
1535 " --hlsl-enable-16bit-types allow 16-bit types in SPIR-V for HLSL\n"
John Kessenichbd1c1832018-12-07 18:38:26 -07001536 " --hlsl-dx9-compatible interprets sampler declarations as a texture/sampler combo like DirectX9 would."
John Kessenichade8bbb2018-08-12 21:24:55 -06001537 " --invert-y | --iy invert position.Y output in vertex shader\n"
1538 " --keep-uncalled | --ku don't eliminate uncalled functions\n"
1539 " --no-storage-format | --nsf use Unknown image format\n"
baldurk4513df92019-02-08 10:48:48 +00001540 " --reflect-strict-array-suffix use strict array suffix rules when\n"
1541 " reflecting\n"
baldurkedf82122019-01-29 15:49:00 +00001542 " --reflect-basic-array-suffix arrays of basic types will have trailing [0]\n"
baldurk4513df92019-02-08 10:48:48 +00001543 " --reflect-intermediate-io reflection includes inputs/outputs of linked\n"
1544 " shaders rather than just vertex/fragment\n"
1545 " --reflect-separate-buffers reflect buffer variables and blocks\n"
1546 " separately to uniforms\n"
1547 " --reflect-all-block-variables reflect all variables in blocks, whether\n"
1548 " inactive or active\n"
baldurk19050692019-02-11 11:50:24 +00001549 " --reflect-unwrap-io-blocks unwrap input/output blocks the same as\n"
1550 " uniform blocks\n"
LoopDawg52017192017-07-14 15:15:47 -06001551 " --resource-set-binding [stage] name set binding\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001552 " set descriptor set and binding for\n"
1553 " individual resources\n"
LoopDawg52017192017-07-14 15:15:47 -06001554 " --resource-set-binding [stage] set\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001555 " set descriptor set for all resources\n"
1556 " --rsb synonym for --resource-set-binding\n"
1557 " --shift-image-binding [stage] num\n"
1558 " base binding number for images (uav)\n"
1559 " --shift-image-binding [stage] [num set]...\n"
1560 " per-descriptor-set shift values\n"
1561 " --sib synonym for --shift-image-binding\n"
1562 " --shift-sampler-binding [stage] num\n"
1563 " base binding number for samplers\n"
1564 " --shift-sampler-binding [stage] [num set]...\n"
1565 " per-descriptor-set shift values\n"
1566 " --ssb synonym for --shift-sampler-binding\n"
1567 " --shift-ssbo-binding [stage] num base binding number for SSBOs\n"
1568 " --shift-ssbo-binding [stage] [num set]...\n"
1569 " per-descriptor-set shift values\n"
1570 " --sbb synonym for --shift-ssbo-binding\n"
1571 " --shift-texture-binding [stage] num\n"
1572 " base binding number for textures\n"
1573 " --shift-texture-binding [stage] [num set]...\n"
1574 " per-descriptor-set shift values\n"
1575 " --stb synonym for --shift-texture-binding\n"
1576 " --shift-uav-binding [stage] num base binding number for UAVs\n"
1577 " --shift-uav-binding [stage] [num set]...\n"
1578 " per-descriptor-set shift values\n"
1579 " --suavb synonym for --shift-uav-binding\n"
1580 " --shift-UBO-binding [stage] num base binding number for UBOs\n"
1581 " --shift-UBO-binding [stage] [num set]...\n"
1582 " per-descriptor-set shift values\n"
1583 " --sub synonym for --shift-UBO-binding\n"
1584 " --shift-cbuffer-binding | --scb synonyms for --shift-UBO-binding\n"
1585 " --spirv-dis output standard-form disassembly; works only\n"
1586 " when a SPIR-V generation option is also used\n"
John Kessenichc3404252018-08-23 15:29:08 -06001587 " --spirv-val execute the SPIRV-Tools validator\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001588 " --source-entrypoint <name> the given shader source function is\n"
1589 " renamed to be the <name> given in -e\n"
1590 " --sep synonym for --source-entrypoint\n"
1591 " --stdin read from stdin instead of from a file;\n"
1592 " requires providing the shader stage using -S\n"
John Kessenich8717a5d2018-10-26 10:12:32 -06001593 " --target-env {vulkan1.0 | vulkan1.1 | opengl | \n"
1594 " spirv1.0 | spirv1.1 | spirv1.2 | spirv1.3}\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001595 " set execution environment that emitted code\n"
John Kessenich8717a5d2018-10-26 10:12:32 -06001596 " will execute in (versus source language\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001597 " semantics selected by --client) defaults:\n"
1598 " * 'vulkan1.0' under '--client vulkan<ver>'\n"
1599 " * 'opengl' under '--client opengl<ver>'\n"
John Kessenich8717a5d2018-10-26 10:12:32 -06001600 " * 'spirv1.0' under --target-env vulkan1.0\n"
1601 " * 'spirv1.3' under --target-env vulkan1.1\n"
1602 " multiple --targen-env can be specified.\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001603 " --variable-name <name>\n"
1604 " --vn <name> creates a C header file that contains a\n"
1605 " uint32_t array named <name>\n"
1606 " initialized with the shader binary code\n"
John Kessenichb0a7eb52013-11-07 17:44:20 +00001607 );
John Kessenich68d78fd2015-07-12 19:28:10 -06001608
1609 exit(EFailUsage);
John Kessenicha0af4732012-12-12 21:15:54 +00001610}
1611
John Kessenich3ce4e592014-10-06 19:57:34 +00001612#if !defined _MSC_VER && !defined MINGW_HAS_SECURE_API
John Kessenichcfd643e2013-03-08 23:14:42 +00001613
1614#include <errno.h>
1615
1616int fopen_s(
1617 FILE** pFile,
John Kessenich51cdd902014-02-18 23:37:57 +00001618 const char* filename,
1619 const char* mode
John Kessenichcfd643e2013-03-08 23:14:42 +00001620)
1621{
1622 if (!pFile || !filename || !mode) {
1623 return EINVAL;
1624 }
1625
1626 FILE* f = fopen(filename, mode);
1627 if (! f) {
1628 if (errno != 0) {
1629 return errno;
1630 } else {
1631 return ENOENT;
1632 }
1633 }
1634 *pFile = f;
1635
1636 return 0;
1637}
1638
1639#endif
1640
John Kessenicha0af4732012-12-12 21:15:54 +00001641//
1642// Malloc a string of sufficient size and read a string into it.
1643//
John Kessenich04acb1b2017-06-14 17:36:50 -06001644char* ReadFileData(const char* fileName)
John Kessenicha0af4732012-12-12 21:15:54 +00001645{
John Kessenichb3297152015-07-11 18:01:03 -06001646 FILE *in = nullptr;
John Kessenich3ce4e592014-10-06 19:57:34 +00001647 int errorCode = fopen_s(&in, fileName, "r");
John Kessenich68d78fd2015-07-12 19:28:10 -06001648 if (errorCode || in == nullptr)
1649 Error("unable to open input file");
John Kessenichecba76f2017-01-06 00:34:48 -07001650
John Kessenich04acb1b2017-06-14 17:36:50 -06001651 int count = 0;
John Kessenicha0af4732012-12-12 21:15:54 +00001652 while (fgetc(in) != EOF)
1653 count++;
1654
John Kessenichd6c72a42014-08-18 19:42:35 +00001655 fseek(in, 0, SEEK_SET);
John Kessenichca3457f2015-05-18 01:59:45 +00001656
John Kessenich04acb1b2017-06-14 17:36:50 -06001657 char* return_data = (char*)malloc(count + 1); // freed in FreeFileData()
1658 if ((int)fread(return_data, 1, count, in) != count) {
1659 free(return_data);
John Kessenich68d78fd2015-07-12 19:28:10 -06001660 Error("can't read input file");
John Kessenicha0af4732012-12-12 21:15:54 +00001661 }
John Kessenich68d78fd2015-07-12 19:28:10 -06001662
John Kessenich04acb1b2017-06-14 17:36:50 -06001663 return_data[count] = '\0';
John Kessenicha0af4732012-12-12 21:15:54 +00001664 fclose(in);
John Kessenichb3297152015-07-11 18:01:03 -06001665
John Kessenicha0af4732012-12-12 21:15:54 +00001666 return return_data;
1667}
1668
John Kessenich04acb1b2017-06-14 17:36:50 -06001669void FreeFileData(char* data)
John Kessenicha0af4732012-12-12 21:15:54 +00001670{
John Kessenichb3297152015-07-11 18:01:03 -06001671 free(data);
John Kessenicha0af4732012-12-12 21:15:54 +00001672}
1673
John Kessenich54d8cda2013-02-11 22:36:01 +00001674void InfoLogMsg(const char* msg, const char* name, const int num)
John Kessenicha0af4732012-12-12 21:15:54 +00001675{
John Kessenichfae38ee2015-06-10 23:23:12 +00001676 if (num >= 0 )
1677 printf("#### %s %s %d INFO LOG ####\n", msg, name, num);
1678 else
1679 printf("#### %s %s INFO LOG ####\n", msg, name);
John Kessenicha0af4732012-12-12 21:15:54 +00001680}