blob: 7588320f14e033d4ca39f56e034764ef43282662 [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;
John Kessenich971a0a82017-06-07 15:06:58 -0600165std::vector<std::string> IncludeDirectoryList;
John Kessenich8717a5d2018-10-26 10:12:32 -0600166
167// Source environment
168// (source 'Client' is currently the same as target 'Client')
169int ClientInputSemanticsVersion = 100;
170
171// Target environment
172glslang::EShClient Client = glslang::EShClientNone; // will stay EShClientNone if only validating
173glslang::EShTargetClientVersion ClientVersion; // not valid until Client is set
174glslang::EShTargetLanguage TargetLanguage = glslang::EShTargetNone;
175glslang::EShTargetLanguageVersion TargetVersion; // not valid until TargetLanguage is set
176
John Kessenich66011cb2018-03-06 16:12:04 -0700177std::vector<std::string> Processes; // what should be recorded by OpModuleProcessed, or equivalent
John Kessenich68d78fd2015-07-12 19:28:10 -0600178
LoopDawg08a14422017-10-17 19:27:14 -0600179// Per descriptor-set binding base data
180typedef std::map<unsigned int, unsigned int> TPerSetBaseBinding;
181
Neil Roberts16f53472018-03-20 17:30:53 +0100182std::vector<std::pair<std::string, int>> uniformLocationOverrides;
Neil Robertsb0f3d792018-03-20 17:41:05 +0100183int uniformBase = 0;
Neil Roberts16f53472018-03-20 17:30:53 +0100184
LoopDawg08a14422017-10-17 19:27:14 -0600185std::array<std::array<unsigned int, EShLangCount>, glslang::EResCount> baseBinding;
186std::array<std::array<TPerSetBaseBinding, EShLangCount>, glslang::EResCount> baseBindingForSet;
Hyangran Park36dc8292017-05-02 16:27:29 +0900187std::array<std::vector<std::string>, EShLangCount> baseResourceSetBinding;
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600188
John Kessenicha9313662017-06-15 10:40:49 -0600189// Add things like "#define ..." to a preamble to use in the beginning of the shader.
190class TPreamble {
191public:
192 TPreamble() { }
193
194 bool isSet() const { return text.size() > 0; }
195 const char* get() const { return text.c_str(); }
196
197 // #define...
198 void addDef(std::string def)
199 {
200 text.append("#define ");
201 fixLine(def);
202
John Kessenich2a271162017-07-20 20:00:36 -0600203 Processes.push_back("D");
204 Processes.back().append(def);
205
John Kessenicha9313662017-06-15 10:40:49 -0600206 // The first "=" needs to turn into a space
LoopDawgb97b25e2017-07-12 09:04:39 -0600207 const size_t equal = def.find_first_of("=");
John Kessenicha9313662017-06-15 10:40:49 -0600208 if (equal != def.npos)
209 def[equal] = ' ';
210
211 text.append(def);
212 text.append("\n");
213 }
214
215 // #undef...
216 void addUndef(std::string undef)
217 {
218 text.append("#undef ");
219 fixLine(undef);
John Kessenich2a271162017-07-20 20:00:36 -0600220
221 Processes.push_back("U");
222 Processes.back().append(undef);
223
John Kessenicha9313662017-06-15 10:40:49 -0600224 text.append(undef);
225 text.append("\n");
226 }
227
228protected:
229 void fixLine(std::string& line)
230 {
231 // Can't go past a newline in the line
LoopDawgb97b25e2017-07-12 09:04:39 -0600232 const size_t end = line.find_first_of("\n");
John Kessenicha9313662017-06-15 10:40:49 -0600233 if (end != line.npos)
234 line = line.substr(0, end);
235 }
236
237 std::string text; // contents of preamble
238};
239
240TPreamble UserPreamble;
241
John Kessenich68d78fd2015-07-12 19:28:10 -0600242//
243// Create the default name for saving a binary if -o is not provided.
244//
245const char* GetBinaryName(EShLanguage stage)
246{
247 const char* name;
248 if (binaryFileName == nullptr) {
249 switch (stage) {
250 case EShLangVertex: name = "vert.spv"; break;
251 case EShLangTessControl: name = "tesc.spv"; break;
252 case EShLangTessEvaluation: name = "tese.spv"; break;
253 case EShLangGeometry: name = "geom.spv"; break;
254 case EShLangFragment: name = "frag.spv"; break;
255 case EShLangCompute: name = "comp.spv"; break;
Chao Chen3c366992018-09-19 11:41:59 -0700256#ifdef NV_EXTENSIONS
Chao Chenb50c02e2018-09-19 11:42:24 -0700257 case EShLangRayGenNV: name = "rgen.spv"; break;
258 case EShLangIntersectNV: name = "rint.spv"; break;
259 case EShLangAnyHitNV: name = "rahit.spv"; break;
260 case EShLangClosestHitNV: name = "rchit.spv"; break;
261 case EShLangMissNV: name = "rmiss.spv"; break;
262 case EShLangCallableNV: name = "rcall.spv"; break;
Chao Chen3c366992018-09-19 11:41:59 -0700263 case EShLangMeshNV: name = "mesh.spv"; break;
264 case EShLangTaskNV: name = "task.spv"; break;
265#endif
John Kessenich68d78fd2015-07-12 19:28:10 -0600266 default: name = "unknown"; break;
267 }
268 } else
269 name = binaryFileName;
270
271 return name;
272}
John Kessenich2b07c7e2013-07-31 18:44:13 +0000273
John Kessenich05a70632013-09-17 19:26:08 +0000274//
275// *.conf => this is a config file that can set limits/resources
276//
277bool SetConfigFile(const std::string& name)
278{
279 if (name.size() < 5)
280 return false;
281
John Kessenich4c706852013-10-11 16:28:43 +0000282 if (name.compare(name.size() - 5, 5, ".conf") == 0) {
John Kessenich05a70632013-09-17 19:26:08 +0000283 ConfigFile = name;
284 return true;
285 }
286
287 return false;
288}
289
John Kessenich68d78fd2015-07-12 19:28:10 -0600290//
291// Give error and exit with failure code.
292//
293void Error(const char* message)
294{
John Kessenichaf527992017-11-02 22:48:15 -0600295 fprintf(stderr, "%s: Error %s (use -h for usage)\n", ExecutableName, message);
John Kessenich68d78fd2015-07-12 19:28:10 -0600296 exit(EFailUsage);
297}
298
299//
LoopDawg08a14422017-10-17 19:27:14 -0600300// Process an optional binding base of one the forms:
301// --argname [stage] base // base for stage (if given) or all stages (if not)
LoopDawge5709552017-10-21 10:46:39 -0600302// --argname [stage] [base set]... // set/base pairs: set the base for given binding set.
LoopDawg08a14422017-10-17 19:27:14 -0600303
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600304// Where stage is one of the forms accepted by FindLanguage, and base is an integer
305//
LoopDawg08a14422017-10-17 19:27:14 -0600306void ProcessBindingBase(int& argc, char**& argv, glslang::TResourceType res)
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600307{
308 if (argc < 2)
309 usage();
310
LoopDawg08a14422017-10-17 19:27:14 -0600311 EShLanguage lang = EShLangCount;
312 int singleBase = 0;
313 TPerSetBaseBinding perSetBase;
314 int arg = 1;
315
316 // Parse stage, if given
317 if (!isdigit(argv[arg][0])) {
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600318 if (argc < 3) // this form needs one more argument
319 usage();
John Kessenichecba76f2017-01-06 00:34:48 -0700320
LoopDawg08a14422017-10-17 19:27:14 -0600321 lang = FindLanguage(argv[arg++], false);
322 }
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600323
LoopDawg08a14422017-10-17 19:27:14 -0600324 if ((argc - arg) > 2 && isdigit(argv[arg+0][0]) && isdigit(argv[arg+1][0])) {
325 // Parse a per-set binding base
326 while ((argc - arg) > 2 && isdigit(argv[arg+0][0]) && isdigit(argv[arg+1][0])) {
LoopDawg08a14422017-10-17 19:27:14 -0600327 const int baseNum = atoi(argv[arg++]);
LoopDawge5709552017-10-21 10:46:39 -0600328 const int setNum = atoi(argv[arg++]);
LoopDawg08a14422017-10-17 19:27:14 -0600329 perSetBase[setNum] = baseNum;
330 }
331 } else {
332 // Parse single binding base
333 singleBase = atoi(argv[arg++]);
334 }
335
336 argc -= (arg-1);
337 argv += (arg-1);
338
339 // Set one or all languages
340 const int langMin = (lang < EShLangCount) ? lang+0 : 0;
341 const int langMax = (lang < EShLangCount) ? lang+1 : EShLangCount;
342
343 for (int lang = langMin; lang < langMax; ++lang) {
344 if (!perSetBase.empty())
John Kessenich251901a2018-08-12 22:05:59 -0600345 baseBindingForSet[res][lang].insert(perSetBase.begin(), perSetBase.end());
LoopDawg08a14422017-10-17 19:27:14 -0600346 else
347 baseBinding[res][lang] = singleBase;
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600348 }
349}
350
Hyangran Park36dc8292017-05-02 16:27:29 +0900351void ProcessResourceSetBindingBase(int& argc, char**& argv, std::array<std::vector<std::string>, EShLangCount>& base)
352{
353 if (argc < 2)
354 usage();
355
356 if (!isdigit(argv[1][0])) {
LoopDawg52017192017-07-14 15:15:47 -0600357 if (argc < 3) // this form needs one more argument
Hyangran Park36dc8292017-05-02 16:27:29 +0900358 usage();
359
LoopDawg52017192017-07-14 15:15:47 -0600360 // Parse form: --argname stage [regname set base...], or:
361 // --argname stage set
Hyangran Park36dc8292017-05-02 16:27:29 +0900362 const EShLanguage lang = FindLanguage(argv[1], false);
363
LoopDawg52017192017-07-14 15:15:47 -0600364 argc--;
365 argv++;
366
367 while (argc > 1 && argv[1] != nullptr && argv[1][0] != '-') {
368 base[lang].push_back(argv[1]);
369
370 argc--;
371 argv++;
Hyangran Park36dc8292017-05-02 16:27:29 +0900372 }
LoopDawg52017192017-07-14 15:15:47 -0600373
374 // Must have one arg, or a multiple of three (for [regname set binding] triples)
375 if (base[lang].size() != 1 && (base[lang].size() % 3) != 0)
376 usage();
377
Hyangran Park36dc8292017-05-02 16:27:29 +0900378 } else {
LoopDawg52017192017-07-14 15:15:47 -0600379 // Parse form: --argname set
Hyangran Park36dc8292017-05-02 16:27:29 +0900380 for (int lang=0; lang<EShLangCount; ++lang)
381 base[lang].push_back(argv[1]);
382
383 argc--;
384 argv++;
385 }
386}
387
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600388//
John Kessenich68d78fd2015-07-12 19:28:10 -0600389// Do all command-line argument parsing. This includes building up the work-items
390// to be processed later, and saving all the command-line options.
391//
392// Does not return (it exits) if command-line is fatally flawed.
393//
Juan Lopeza558b262017-04-02 23:04:00 +0200394void ProcessArguments(std::vector<std::unique_ptr<glslang::TWorkItem>>& workItems, int argc, char* argv[])
John Kessenich2b07c7e2013-07-31 18:44:13 +0000395{
LoopDawg08a14422017-10-17 19:27:14 -0600396 for (int res = 0; res < glslang::EResCount; ++res)
397 baseBinding[res].fill(0);
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600398
John Kessenich38f3b892013-09-06 19:52:57 +0000399 ExecutableName = argv[0];
Juan Lopeza558b262017-04-02 23:04:00 +0200400 workItems.reserve(argc);
John Kessenich38f3b892013-09-06 19:52:57 +0000401
John Kessenichc178f0a2017-06-23 10:58:31 -0600402 const auto bumpArg = [&]() {
403 if (argc > 0) {
404 argc--;
405 argv++;
406 }
407 };
408
409 // read a string directly attached to a single-letter option
John Kessenich6263fb12017-06-14 15:52:44 -0600410 const auto getStringOperand = [&](const char* desc) {
411 if (argv[0][2] == 0) {
412 printf("%s must immediately follow option (no spaces)\n", desc);
413 exit(EFailUsage);
414 }
415 return argv[0] + 2;
416 };
417
John Kessenich6353d552017-06-23 11:11:09 -0600418 // read a number attached to a single-letter option
419 const auto getAttachedNumber = [&](const char* desc) {
420 int num = atoi(argv[0] + 2);
421 if (num == 0) {
422 printf("%s: expected attached non-0 number\n", desc);
423 exit(EFailUsage);
424 }
425 return num;
426 };
427
428 // minimum needed (without overriding something else) to target Vulkan SPIR-V
429 const auto setVulkanSpv = []() {
John Kessenich8717a5d2018-10-26 10:12:32 -0600430 if (Client == glslang::EShClientNone)
431 ClientVersion = glslang::EShTargetVulkan_1_0;
432 Client = glslang::EShClientVulkan;
John Kessenich6353d552017-06-23 11:11:09 -0600433 Options |= EOptionSpv;
434 Options |= EOptionVulkanRules;
435 Options |= EOptionLinkProgram;
436 };
437
438 // minimum needed (without overriding something else) to target OpenGL SPIR-V
439 const auto setOpenGlSpv = []() {
John Kessenich8717a5d2018-10-26 10:12:32 -0600440 if (Client == glslang::EShClientNone)
441 ClientVersion = glslang::EShTargetOpenGL_450;
442 Client = glslang::EShClientOpenGL;
John Kessenich6353d552017-06-23 11:11:09 -0600443 Options |= EOptionSpv;
444 Options |= EOptionLinkProgram;
445 // undo a -H default to Vulkan
446 Options &= ~EOptionVulkanRules;
447 };
448
Neil Roberts16f53472018-03-20 17:30:53 +0100449 const auto getUniformOverride = [getStringOperand]() {
450 const char *arg = getStringOperand("-u<name>:<location>");
451 const char *split = strchr(arg, ':');
452 if (split == NULL) {
453 printf("%s: missing location\n", arg);
454 exit(EFailUsage);
455 }
456 errno = 0;
457 int location = ::strtol(split + 1, NULL, 10);
458 if (errno) {
459 printf("%s: invalid location\n", arg);
460 exit(EFailUsage);
461 }
462 return std::make_pair(std::string(arg, split - arg), location);
463 };
464
John Kessenichc178f0a2017-06-23 10:58:31 -0600465 for (bumpArg(); argc >= 1; bumpArg()) {
John Kessenich2b07c7e2013-07-31 18:44:13 +0000466 if (argv[0][0] == '-') {
John Kessenich2aa7f3a2015-05-15 16:02:07 +0000467 switch (argv[0][1]) {
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600468 case '-':
469 {
470 std::string lowerword(argv[0]+2);
471 std::transform(lowerword.begin(), lowerword.end(), lowerword.begin(), ::tolower);
472
473 // handle --word style options
John Kessenich6263fb12017-06-14 15:52:44 -0600474 if (lowerword == "auto-map-bindings" || // synonyms
John Kessenich6353d552017-06-23 11:11:09 -0600475 lowerword == "auto-map-binding" ||
476 lowerword == "amb") {
John Kessenich6263fb12017-06-14 15:52:44 -0600477 Options |= EOptionAutoMapBindings;
478 } else if (lowerword == "auto-map-locations" || // synonyms
479 lowerword == "aml") {
480 Options |= EOptionAutoMapLocations;
Neil Robertsb0f3d792018-03-20 17:41:05 +0100481 } else if (lowerword == "uniform-base") {
482 if (argc <= 1)
483 Error("no <base> provided for --uniform-base");
484 uniformBase = ::strtol(argv[1], NULL, 10);
485 bumpArg();
486 break;
John Kessenich6353d552017-06-23 11:11:09 -0600487 } else if (lowerword == "client") {
488 if (argc > 1) {
489 if (strcmp(argv[1], "vulkan100") == 0)
490 setVulkanSpv();
491 else if (strcmp(argv[1], "opengl100") == 0)
492 setOpenGlSpv();
493 else
494 Error("--client expects vulkan100 or opengl100");
495 }
496 bumpArg();
John Kessenich640bd092018-08-09 14:15:00 -0600497 } else if (lowerword == "entry-point") {
498 entryPointName = argv[1];
499 if (argc <= 1)
500 Error("no <name> provided for --entry-point");
501 bumpArg();
John Kessenich6263fb12017-06-14 15:52:44 -0600502 } else if (lowerword == "flatten-uniform-arrays" || // synonyms
503 lowerword == "flatten-uniform-array" ||
504 lowerword == "fua") {
505 Options |= EOptionFlattenUniformArrays;
506 } else if (lowerword == "hlsl-offsets") {
507 Options |= EOptionHlslOffsets;
508 } else if (lowerword == "hlsl-iomap" ||
509 lowerword == "hlsl-iomapper" ||
510 lowerword == "hlsl-iomapping") {
511 Options |= EOptionHlslIoMapping;
Rex Xucb61eec2018-03-07 13:10:01 +0800512 } else if (lowerword == "hlsl-enable-16bit-types") {
513 HlslEnable16BitTypes = true;
John Kessenichbd1c1832018-12-07 18:38:26 -0700514 } else if (lowerword == "hlsl-dx9-compatible") {
515 HlslDX9compatible = true;
John Kessenichc6c80a62018-03-05 22:23:17 -0700516 } else if (lowerword == "invert-y" || // synonyms
517 lowerword == "iy") {
518 Options |= EOptionInvertY;
John Kessenich6263fb12017-06-14 15:52:44 -0600519 } else if (lowerword == "keep-uncalled" || // synonyms
520 lowerword == "ku") {
521 Options |= EOptionKeepUncalled;
522 } else if (lowerword == "no-storage-format" || // synonyms
523 lowerword == "nsf") {
524 Options |= EOptionNoStorageFormat;
John Kessenich2a271162017-07-20 20:00:36 -0600525 } else if (lowerword == "relaxed-errors") {
526 Options |= EOptionRelaxedErrors;
baldurk15c37f72019-01-29 12:12:59 +0000527 } else if (lowerword == "reflect-strict-array-suffix") {
528 ReflectOptions |= EShReflectionStrictArraySuffix;
baldurkedf82122019-01-29 15:49:00 +0000529 } else if (lowerword == "reflect-basic-array-suffix") {
530 ReflectOptions |= EShReflectionBasicArraySuffix;
baldurk0af5e3e2019-01-29 16:04:44 +0000531 } else if (lowerword == "reflect-intermediate-io") {
532 ReflectOptions |= EShReflectionIntermediateIO;
John Kessenich6263fb12017-06-14 15:52:44 -0600533 } else if (lowerword == "resource-set-bindings" || // synonyms
534 lowerword == "resource-set-binding" ||
535 lowerword == "rsb") {
536 ProcessResourceSetBindingBase(argc, argv, baseResourceSetBinding);
steve-lunarg9088be42016-11-01 10:31:42 -0600537 } else if (lowerword == "shift-image-bindings" || // synonyms
538 lowerword == "shift-image-binding" ||
539 lowerword == "sib") {
LoopDawg08a14422017-10-17 19:27:14 -0600540 ProcessBindingBase(argc, argv, glslang::EResImage);
John Kessenich6263fb12017-06-14 15:52:44 -0600541 } else if (lowerword == "shift-sampler-bindings" || // synonyms
John Kessenichade8bbb2018-08-12 21:24:55 -0600542 lowerword == "shift-sampler-binding" ||
543 lowerword == "ssb") {
LoopDawg08a14422017-10-17 19:27:14 -0600544 ProcessBindingBase(argc, argv, glslang::EResSampler);
John Kessenich6263fb12017-06-14 15:52:44 -0600545 } else if (lowerword == "shift-uav-bindings" || // synonyms
546 lowerword == "shift-uav-binding" ||
547 lowerword == "suavb") {
LoopDawg08a14422017-10-17 19:27:14 -0600548 ProcessBindingBase(argc, argv, glslang::EResUav);
John Kessenich6263fb12017-06-14 15:52:44 -0600549 } else if (lowerword == "shift-texture-bindings" || // synonyms
550 lowerword == "shift-texture-binding" ||
551 lowerword == "stb") {
LoopDawg08a14422017-10-17 19:27:14 -0600552 ProcessBindingBase(argc, argv, glslang::EResTexture);
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600553 } else if (lowerword == "shift-ubo-bindings" || // synonyms
554 lowerword == "shift-ubo-binding" ||
steve-lunargbe283552017-04-18 12:18:01 -0600555 lowerword == "shift-cbuffer-bindings" ||
556 lowerword == "shift-cbuffer-binding" ||
557 lowerword == "sub" ||
558 lowerword == "scb") {
LoopDawg08a14422017-10-17 19:27:14 -0600559 ProcessBindingBase(argc, argv, glslang::EResUbo);
steve-lunarg932bb5c2017-02-21 17:19:08 -0700560 } else if (lowerword == "shift-ssbo-bindings" || // synonyms
561 lowerword == "shift-ssbo-binding" ||
562 lowerword == "sbb") {
LoopDawg08a14422017-10-17 19:27:14 -0600563 ProcessBindingBase(argc, argv, glslang::EResSsbo);
John Kessenich6263fb12017-06-14 15:52:44 -0600564 } else if (lowerword == "source-entrypoint" || // synonyms
565 lowerword == "sep") {
John Kessenichc178f0a2017-06-23 10:58:31 -0600566 if (argc <= 1)
John Kessenich6263fb12017-06-14 15:52:44 -0600567 Error("no <entry-point> provided for --source-entrypoint");
John Kessenichc178f0a2017-06-23 10:58:31 -0600568 sourceEntryPointName = argv[1];
569 bumpArg();
John Kessenich6263fb12017-06-14 15:52:44 -0600570 break;
John Kesseniche2156222018-06-11 18:12:15 -0600571 } else if (lowerword == "spirv-dis") {
572 SpvToolsDisassembler = true;
John Kessenichc3404252018-08-23 15:29:08 -0600573 } else if (lowerword == "spirv-val") {
574 SpvToolsValidate = true;
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +0200575 } else if (lowerword == "stdin") {
576 Options |= EOptionStdin;
577 shaderStageName = argv[1];
John Kessenich2a271162017-07-20 20:00:36 -0600578 } else if (lowerword == "suppress-warnings") {
579 Options |= EOptionSuppressWarnings;
John Kessenich6353d552017-06-23 11:11:09 -0600580 } else if (lowerword == "target-env") {
581 if (argc > 1) {
582 if (strcmp(argv[1], "vulkan1.0") == 0) {
583 setVulkanSpv();
John Kessenich8717a5d2018-10-26 10:12:32 -0600584 ClientVersion = glslang::EShTargetVulkan_1_0;
John Kessenich66011cb2018-03-06 16:12:04 -0700585 } else if (strcmp(argv[1], "vulkan1.1") == 0) {
586 setVulkanSpv();
John Kessenich8717a5d2018-10-26 10:12:32 -0600587 ClientVersion = glslang::EShTargetVulkan_1_1;
John Kessenich6353d552017-06-23 11:11:09 -0600588 } else if (strcmp(argv[1], "opengl") == 0) {
589 setOpenGlSpv();
John Kessenich8717a5d2018-10-26 10:12:32 -0600590 ClientVersion = glslang::EShTargetOpenGL_450;
591 } else if (strcmp(argv[1], "spirv1.0") == 0) {
592 TargetLanguage = glslang::EShTargetSpv;
593 TargetVersion = glslang::EShTargetSpv_1_0;
594 } else if (strcmp(argv[1], "spirv1.1") == 0) {
595 TargetLanguage = glslang::EShTargetSpv;
596 TargetVersion = glslang::EShTargetSpv_1_1;
597 } else if (strcmp(argv[1], "spirv1.2") == 0) {
598 TargetLanguage = glslang::EShTargetSpv;
599 TargetVersion = glslang::EShTargetSpv_1_2;
600 } else if (strcmp(argv[1], "spirv1.3") == 0) {
601 TargetLanguage = glslang::EShTargetSpv;
602 TargetVersion = glslang::EShTargetSpv_1_3;
603 } else if (strcmp(argv[1], "spirv1.4") == 0) {
604 TargetLanguage = glslang::EShTargetSpv;
605 TargetVersion = glslang::EShTargetSpv_1_4;
John Kessenich6353d552017-06-23 11:11:09 -0600606 } else
John Kessenich8717a5d2018-10-26 10:12:32 -0600607 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 -0600608 }
609 bumpArg();
Flavio15017db2017-02-15 14:29:33 -0800610 } else if (lowerword == "variable-name" || // synonyms
John Kessenich66011cb2018-03-06 16:12:04 -0700611 lowerword == "vn") {
Flavio15017db2017-02-15 14:29:33 -0800612 Options |= EOptionOutputHexadecimal;
John Kessenichc178f0a2017-06-23 10:58:31 -0600613 if (argc <= 1)
Flavio15017db2017-02-15 14:29:33 -0800614 Error("no <C-variable-name> provided for --variable-name");
John Kessenichc178f0a2017-06-23 10:58:31 -0600615 variableName = argv[1];
616 bumpArg();
Flavio15017db2017-02-15 14:29:33 -0800617 break;
John Kessenichc6c80a62018-03-05 22:23:17 -0700618 } else if (lowerword == "version") {
619 Options |= EOptionDumpVersions;
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600620 } else {
621 usage();
622 }
623 }
624 break;
John Kessenich6263fb12017-06-14 15:52:44 -0600625 case 'C':
626 Options |= EOptionCascadingErrors;
627 break;
628 case 'D':
John Kessenicha9313662017-06-15 10:40:49 -0600629 if (argv[0][2] == 0)
630 Options |= EOptionReadHlsl;
631 else
632 UserPreamble.addDef(getStringOperand("-D<macro> macro name"));
John Kessenich6263fb12017-06-14 15:52:44 -0600633 break;
Neil Roberts16f53472018-03-20 17:30:53 +0100634 case 'u':
635 uniformLocationOverrides.push_back(getUniformOverride());
636 break;
John Kessenich6263fb12017-06-14 15:52:44 -0600637 case 'E':
638 Options |= EOptionOutputPreprocessed;
639 break;
640 case 'G':
John Kessenich8717a5d2018-10-26 10:12:32 -0600641 // OpenGL client
John Kessenich6353d552017-06-23 11:11:09 -0600642 setOpenGlSpv();
643 if (argv[0][2] != 0)
644 ClientInputSemanticsVersion = getAttachedNumber("-G<num> client input semantics");
John Kessenich6263fb12017-06-14 15:52:44 -0600645 break;
John Kessenich2aa7f3a2015-05-15 16:02:07 +0000646 case 'H':
647 Options |= EOptionHumanReadableSpv;
John Kessenich91e4aa52016-07-07 17:46:42 -0600648 if ((Options & EOptionSpv) == 0) {
649 // default to Vulkan
John Kessenich6353d552017-06-23 11:11:09 -0600650 setVulkanSpv();
John Kessenich91e4aa52016-07-07 17:46:42 -0600651 }
652 break;
John Kessenich971a0a82017-06-07 15:06:58 -0600653 case 'I':
John Kessenicha9313662017-06-15 10:40:49 -0600654 IncludeDirectoryList.push_back(getStringOperand("-I<dir> include path"));
John Kessenich68d78fd2015-07-12 19:28:10 -0600655 break;
GregFcd1f1692017-09-21 18:40:22 -0600656 case 'O':
657 if (argv[0][2] == 'd')
658 Options |= EOptionOptimizeDisable;
659 else if (argv[0][2] == 's')
GregFfb03a552018-03-29 11:49:14 -0600660#if ENABLE_OPT
GregFcd1f1692017-09-21 18:40:22 -0600661 Options |= EOptionOptimizeSize;
662#else
663 Error("-Os not available; optimizer not linked");
664#endif
665 else
666 Error("unknown -O option");
667 break;
Dan Baker5afdd782016-08-11 17:53:57 -0400668 case 'S':
John Kessenichc178f0a2017-06-23 10:58:31 -0600669 if (argc <= 1)
Dan Baker5afdd782016-08-11 17:53:57 -0400670 Error("no <stage> specified for -S");
John Kessenichc178f0a2017-06-23 10:58:31 -0600671 shaderStageName = argv[1];
672 bumpArg();
dankbaker45d49bc2016-08-08 21:43:07 -0400673 break;
John Kessenicha9313662017-06-15 10:40:49 -0600674 case 'U':
675 UserPreamble.addUndef(getStringOperand("-U<macro>: macro name"));
676 break;
John Kessenich6263fb12017-06-14 15:52:44 -0600677 case 'V':
John Kessenich6353d552017-06-23 11:11:09 -0600678 setVulkanSpv();
679 if (argv[0][2] != 0)
David Neto506d2c22018-02-27 21:55:23 -0500680 ClientInputSemanticsVersion = getAttachedNumber("-V<num> client input semantics");
John Kessenichc555ddd2015-06-17 02:38:44 +0000681 break;
John Kessenich05a70632013-09-17 19:26:08 +0000682 case 'c':
683 Options |= EOptionDumpConfig;
684 break;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000685 case 'd':
John Kessenichc6c80a62018-03-05 22:23:17 -0700686 if (strncmp(&argv[0][1], "dumpversion", strlen(&argv[0][1]) + 1) == 0 ||
687 strncmp(&argv[0][1], "dumpfullversion", strlen(&argv[0][1]) + 1) == 0)
688 Options |= EOptionDumpBareVersion;
689 else
690 Options |= EOptionDefaultDesktop;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000691 break;
John Kessenich4d65ee32016-03-12 18:17:47 -0700692 case 'e':
John Kessenich4d65ee32016-03-12 18:17:47 -0700693 entryPointName = argv[1];
John Kessenichc178f0a2017-06-23 10:58:31 -0600694 if (argc <= 1)
John Kessenicha25530c2017-09-11 20:13:49 -0600695 Error("no <name> provided for -e");
John Kessenichc178f0a2017-06-23 10:58:31 -0600696 bumpArg();
John Kessenich4d65ee32016-03-12 18:17:47 -0700697 break;
John Kessenich5d610ee2018-03-07 18:05:55 -0700698 case 'f':
699 if (strcmp(&argv[0][2], "hlsl_functionality1") == 0)
700 targetHlslFunctionality1 = true;
701 else
702 Error("-f: expected hlsl_functionality1");
703 break;
John Kessenich121853f2017-05-31 17:11:16 -0600704 case 'g':
705 Options |= EOptionDebug;
706 break;
John Kessenich68d78fd2015-07-12 19:28:10 -0600707 case 'h':
708 usage();
709 break;
John Kessenich05a70632013-09-17 19:26:08 +0000710 case 'i':
John Kessenich94a81fb2013-08-31 02:41:30 +0000711 Options |= EOptionIntermediate;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000712 break;
713 case 'l':
John Kessenichd78e3512014-08-25 20:07:55 +0000714 Options |= EOptionLinkProgram;
John Kessenich94a81fb2013-08-31 02:41:30 +0000715 break;
716 case 'm':
717 Options |= EOptionMemoryLeakMode;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000718 break;
John Kessenich68d78fd2015-07-12 19:28:10 -0600719 case 'o':
John Kessenichc178f0a2017-06-23 10:58:31 -0600720 if (argc <= 1)
John Kessenich68d78fd2015-07-12 19:28:10 -0600721 Error("no <file> provided for -o");
John Kessenichc178f0a2017-06-23 10:58:31 -0600722 binaryFileName = argv[1];
723 bumpArg();
John Kessenich68d78fd2015-07-12 19:28:10 -0600724 break;
John Kessenich11f9fc72013-11-07 01:06:34 +0000725 case 'q':
726 Options |= EOptionDumpReflection;
727 break;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000728 case 'r':
John Kessenich94a81fb2013-08-31 02:41:30 +0000729 Options |= EOptionRelaxedErrors;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000730 break;
731 case 's':
John Kessenich94a81fb2013-08-31 02:41:30 +0000732 Options |= EOptionSuppressInfolog;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000733 break;
John Kessenich38f3b892013-09-06 19:52:57 +0000734 case 't':
Juan Lopeza558b262017-04-02 23:04:00 +0200735 Options |= EOptionMultiThreaded;
John Kessenich38f3b892013-09-06 19:52:57 +0000736 break;
John Kessenich319de232013-12-04 04:43:40 +0000737 case 'v':
738 Options |= EOptionDumpVersions;
739 break;
John Kessenichb0a7eb52013-11-07 17:44:20 +0000740 case 'w':
741 Options |= EOptionSuppressWarnings;
742 break;
Johannes van Waverenecb0f3b2016-05-27 12:55:53 -0500743 case 'x':
744 Options |= EOptionOutputHexadecimal;
Johannes van Waverenecb0f3b2016-05-27 12:55:53 -0500745 break;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000746 default:
John Kessenich68d78fd2015-07-12 19:28:10 -0600747 usage();
748 break;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000749 }
John Kessenich38f3b892013-09-06 19:52:57 +0000750 } else {
John Kessenich05a70632013-09-17 19:26:08 +0000751 std::string name(argv[0]);
752 if (! SetConfigFile(name)) {
Juan Lopeza558b262017-04-02 23:04:00 +0200753 workItems.push_back(std::unique_ptr<glslang::TWorkItem>(new glslang::TWorkItem(name)));
John Kessenich05a70632013-09-17 19:26:08 +0000754 }
John Kessenich38f3b892013-09-06 19:52:57 +0000755 }
John Kessenich2b07c7e2013-07-31 18:44:13 +0000756 }
757
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +0200758 // Make sure that -S is always specified if --stdin is specified
759 if ((Options & EOptionStdin) && shaderStageName == nullptr)
760 Error("must provide -S when --stdin is given");
761
John Kessenich68d78fd2015-07-12 19:28:10 -0600762 // Make sure that -E is not specified alongside linking (which includes SPV generation)
763 if ((Options & EOptionOutputPreprocessed) && (Options & EOptionLinkProgram))
764 Error("can't use -E when linking is selected");
John Kessenichc555ddd2015-06-17 02:38:44 +0000765
Johannes van Waverenecb0f3b2016-05-27 12:55:53 -0500766 // -o or -x makes no sense if there is no target binary
John Kessenich68d78fd2015-07-12 19:28:10 -0600767 if (binaryFileName && (Options & EOptionSpv) == 0)
768 Error("no binary generation requested (e.g., -V)");
steve-lunarge0b9deb2016-09-16 13:26:37 -0600769
770 if ((Options & EOptionFlattenUniformArrays) != 0 &&
771 (Options & EOptionReadHlsl) == 0)
772 Error("uniform array flattening only valid when compiling HLSL source.");
John Kessenich8717a5d2018-10-26 10:12:32 -0600773
774 // rationalize client and target language
775 if (TargetLanguage == glslang::EShTargetNone) {
776 switch (ClientVersion) {
777 case glslang::EShTargetVulkan_1_0:
778 TargetLanguage = glslang::EShTargetSpv;
779 TargetVersion = glslang::EShTargetSpv_1_0;
780 break;
781 case glslang::EShTargetVulkan_1_1:
782 TargetLanguage = glslang::EShTargetSpv;
783 TargetVersion = glslang::EShTargetSpv_1_3;
784 break;
785 case glslang::EShTargetOpenGL_450:
786 TargetLanguage = glslang::EShTargetSpv;
787 TargetVersion = glslang::EShTargetSpv_1_0;
788 break;
789 default:
790 break;
791 }
792 }
793 if (TargetLanguage != glslang::EShTargetNone && Client == glslang::EShClientNone)
794 Error("To generate SPIR-V, also specify client semantics. See -G and -V.");
John Kessenich2b07c7e2013-07-31 18:44:13 +0000795}
796
John Kessenich68d78fd2015-07-12 19:28:10 -0600797//
798// Translate the meaningful subset of command-line options to parser-behavior options.
799//
John Kessenichb0a7eb52013-11-07 17:44:20 +0000800void SetMessageOptions(EShMessages& messages)
801{
802 if (Options & EOptionRelaxedErrors)
803 messages = (EShMessages)(messages | EShMsgRelaxedErrors);
804 if (Options & EOptionIntermediate)
805 messages = (EShMessages)(messages | EShMsgAST);
806 if (Options & EOptionSuppressWarnings)
807 messages = (EShMessages)(messages | EShMsgSuppressWarnings);
John Kessenich68d78fd2015-07-12 19:28:10 -0600808 if (Options & EOptionSpv)
809 messages = (EShMessages)(messages | EShMsgSpvRules);
810 if (Options & EOptionVulkanRules)
811 messages = (EShMessages)(messages | EShMsgVulkanRules);
Andrew Woloszynaae1ad82015-06-24 17:00:46 -0400812 if (Options & EOptionOutputPreprocessed)
813 messages = (EShMessages)(messages | EShMsgOnlyPreprocessor);
John Kessenich66e2faf2016-03-12 18:34:36 -0700814 if (Options & EOptionReadHlsl)
815 messages = (EShMessages)(messages | EShMsgReadHlsl);
John Kessenicha86836e2016-07-09 14:50:57 -0600816 if (Options & EOptionCascadingErrors)
817 messages = (EShMessages)(messages | EShMsgCascadingErrors);
John Kessenich906cc212016-12-09 19:22:20 -0700818 if (Options & EOptionKeepUncalled)
819 messages = (EShMessages)(messages | EShMsgKeepUncalled);
John Kessenich4f1403e2017-04-05 17:38:20 -0600820 if (Options & EOptionHlslOffsets)
821 messages = (EShMessages)(messages | EShMsgHlslOffsets);
John Kessenich121853f2017-05-31 17:11:16 -0600822 if (Options & EOptionDebug)
823 messages = (EShMessages)(messages | EShMsgDebugInfo);
Rex Xucb61eec2018-03-07 13:10:01 +0800824 if (HlslEnable16BitTypes)
825 messages = (EShMessages)(messages | EShMsgHlslEnable16BitTypes);
GregFfb03a552018-03-29 11:49:14 -0600826 if ((Options & EOptionOptimizeDisable) || !ENABLE_OPT)
827 messages = (EShMessages)(messages | EShMsgHlslLegalization);
John Kessenichbd1c1832018-12-07 18:38:26 -0700828 if (HlslDX9compatible)
829 messages = (EShMessages)(messages | EShMsgHlslDX9Compatible);
John Kessenichb0a7eb52013-11-07 17:44:20 +0000830}
831
John Kessenich68d78fd2015-07-12 19:28:10 -0600832//
John Kessenich69f4b512013-09-04 21:19:27 +0000833// Thread entry point, for non-linking asynchronous mode.
John Kessenichc999ba22013-11-07 23:33:24 +0000834//
Juan Lopeza558b262017-04-02 23:04:00 +0200835void CompileShaders(glslang::TWorklist& worklist)
John Kessenich2b07c7e2013-07-31 18:44:13 +0000836{
John Kessenich7f0bcfd2018-04-05 19:00:01 -0600837 if (Options & EOptionDebug)
838 Error("cannot generate debug information unless linking to generate code");
839
John Kessenich38f3b892013-09-06 19:52:57 +0000840 glslang::TWorkItem* workItem;
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +0200841 if (Options & EOptionStdin) {
John Kesseniche7f9cae2018-07-12 15:11:07 -0600842 if (worklist.remove(workItem)) {
843 ShHandle compiler = ShConstructCompiler(FindLanguage("stdin"), Options);
844 if (compiler == nullptr)
845 return;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000846
John Kesseniche7f9cae2018-07-12 15:11:07 -0600847 CompileFile("stdin", compiler);
John Kessenich2b07c7e2013-07-31 18:44:13 +0000848
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +0200849 if (! (Options & EOptionSuppressInfolog))
850 workItem->results = ShGetInfoLog(compiler);
John Kessenich2b07c7e2013-07-31 18:44:13 +0000851
John Kesseniche7f9cae2018-07-12 15:11:07 -0600852 ShDestruct(compiler);
853 }
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +0200854 } else {
855 while (worklist.remove(workItem)) {
856 ShHandle compiler = ShConstructCompiler(FindLanguage(workItem->name), Options);
857 if (compiler == 0)
858 return;
859
860 CompileFile(workItem->name.c_str(), compiler);
861
862 if (! (Options & EOptionSuppressInfolog))
863 workItem->results = ShGetInfoLog(compiler);
864
865 ShDestruct(compiler);
866 }
John Kessenich2b07c7e2013-07-31 18:44:13 +0000867 }
John Kessenich2b07c7e2013-07-31 18:44:13 +0000868}
869
John Kessenich6626cad2015-06-19 05:14:19 +0000870// Outputs the given string, but only if it is non-null and non-empty.
871// This prevents erroneous newlines from appearing.
Andrew Woloszynaae1ad82015-06-24 17:00:46 -0400872void PutsIfNonEmpty(const char* str)
John Kessenich6626cad2015-06-19 05:14:19 +0000873{
874 if (str && str[0]) {
875 puts(str);
876 }
877}
878
Andrew Woloszynaae1ad82015-06-24 17:00:46 -0400879// Outputs the given string to stderr, but only if it is non-null and non-empty.
880// This prevents erroneous newlines from appearing.
881void StderrIfNonEmpty(const char* str)
882{
John Kessenich04acb1b2017-06-14 17:36:50 -0600883 if (str && str[0])
884 fprintf(stderr, "%s\n", str);
Andrew Woloszynaae1ad82015-06-24 17:00:46 -0400885}
886
John Kessenichc57b2a92016-01-16 15:30:03 -0700887// Simple bundling of what makes a compilation unit for ease in passing around,
888// and separation of handling file IO versus API (programmatic) compilation.
889struct ShaderCompUnit {
890 EShLanguage stage;
John Kessenich04acb1b2017-06-14 17:36:50 -0600891 static const int maxCount = 1;
892 int count; // live number of strings/names
John Kessenicha9313662017-06-15 10:40:49 -0600893 const char* text[maxCount]; // memory owned/managed externally
John Kessenich04acb1b2017-06-14 17:36:50 -0600894 std::string fileName[maxCount]; // hold's the memory, but...
895 const char* fileNameList[maxCount]; // downstream interface wants pointers
dankbakerafe6e9c2016-08-21 12:29:08 -0400896
John Kessenich04acb1b2017-06-14 17:36:50 -0600897 ShaderCompUnit(EShLanguage stage) : stage(stage), count(0) { }
dankbakerafe6e9c2016-08-21 12:29:08 -0400898
John Kessenich04acb1b2017-06-14 17:36:50 -0600899 ShaderCompUnit(const ShaderCompUnit& rhs)
dankbakerafe6e9c2016-08-21 12:29:08 -0400900 {
901 stage = rhs.stage;
John Kessenich04acb1b2017-06-14 17:36:50 -0600902 count = rhs.count;
903 for (int i = 0; i < count; ++i) {
904 fileName[i] = rhs.fileName[i];
905 text[i] = rhs.text[i];
906 fileNameList[i] = rhs.fileName[i].c_str();
907 }
dankbakerafe6e9c2016-08-21 12:29:08 -0400908 }
909
John Kessenicha9313662017-06-15 10:40:49 -0600910 void addString(std::string& ifileName, const char* itext)
John Kessenich04acb1b2017-06-14 17:36:50 -0600911 {
912 assert(count < maxCount);
913 fileName[count] = ifileName;
914 text[count] = itext;
915 fileNameList[count] = fileName[count].c_str();
916 ++count;
917 }
John Kessenichc57b2a92016-01-16 15:30:03 -0700918};
919
John Kessenich69f4b512013-09-04 21:19:27 +0000920//
John Kessenichc57b2a92016-01-16 15:30:03 -0700921// For linking mode: Will independently parse each compilation unit, but then put them
922// in the same program and link them together, making at most one linked module per
923// pipeline stage.
John Kessenich69f4b512013-09-04 21:19:27 +0000924//
925// Uses the new C++ interface instead of the old handle-based interface.
926//
John Kessenichc57b2a92016-01-16 15:30:03 -0700927
928void CompileAndLinkShaderUnits(std::vector<ShaderCompUnit> compUnits)
John Kessenich69f4b512013-09-04 21:19:27 +0000929{
930 // keep track of what to free
931 std::list<glslang::TShader*> shaders;
John Kessenichc57b2a92016-01-16 15:30:03 -0700932
John Kessenich69f4b512013-09-04 21:19:27 +0000933 EShMessages messages = EShMsgDefault;
John Kessenichb0a7eb52013-11-07 17:44:20 +0000934 SetMessageOptions(messages);
John Kessenich69f4b512013-09-04 21:19:27 +0000935
John Kessenich69f4b512013-09-04 21:19:27 +0000936 //
937 // Per-shader processing...
938 //
939
John Kessenich5b0f13a2013-11-01 03:08:40 +0000940 glslang::TProgram& program = *new glslang::TProgram;
rdb32084e82016-02-23 22:17:38 +0100941 for (auto it = compUnits.cbegin(); it != compUnits.cend(); ++it) {
942 const auto &compUnit = *it;
John Kessenichc57b2a92016-01-16 15:30:03 -0700943 glslang::TShader* shader = new glslang::TShader(compUnit.stage);
John Kessenich04acb1b2017-06-14 17:36:50 -0600944 shader->setStringsWithLengthsAndNames(compUnit.text, NULL, compUnit.fileNameList, compUnit.count);
John Kessenich640bd092018-08-09 14:15:00 -0600945 if (entryPointName)
John Kessenich4d65ee32016-03-12 18:17:47 -0700946 shader->setEntryPoint(entryPointName);
John Kessenich3693e632017-09-29 17:51:52 -0600947 if (sourceEntryPointName) {
948 if (entryPointName == nullptr)
949 printf("Warning: Changing source entry point name without setting an entry-point name.\n"
950 "Use '-e <name>'.\n");
steve-lunargf1e0c872016-10-31 15:13:43 -0600951 shader->setSourceEntryPoint(sourceEntryPointName);
John Kessenich3693e632017-09-29 17:51:52 -0600952 }
John Kessenicha9313662017-06-15 10:40:49 -0600953 if (UserPreamble.isSet())
954 shader->setPreamble(UserPreamble.get());
John Kessenich2a271162017-07-20 20:00:36 -0600955 shader->addProcesses(Processes);
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600956
LoopDawg08a14422017-10-17 19:27:14 -0600957 // Set IO mapper binding shift values
958 for (int r = 0; r < glslang::EResCount; ++r) {
959 const glslang::TResourceType res = glslang::TResourceType(r);
960
961 // Set base bindings
962 shader->setShiftBinding(res, baseBinding[res][compUnit.stage]);
963
964 // Set bindings for particular resource sets
965 // TODO: use a range based for loop here, when available in all environments.
966 for (auto i = baseBindingForSet[res][compUnit.stage].begin();
967 i != baseBindingForSet[res][compUnit.stage].end(); ++i)
LoopDawge5709552017-10-21 10:46:39 -0600968 shader->setShiftBindingForSet(res, i->second, i->first);
LoopDawg08a14422017-10-17 19:27:14 -0600969 }
970
steve-lunarge0b9deb2016-09-16 13:26:37 -0600971 shader->setFlattenUniformArrays((Options & EOptionFlattenUniformArrays) != 0);
steve-lunargcce8d482016-10-14 18:36:42 -0600972 shader->setNoStorageFormat((Options & EOptionNoStorageFormat) != 0);
Hyangran Park36dc8292017-05-02 16:27:29 +0900973 shader->setResourceSetBinding(baseResourceSetBinding[compUnit.stage]);
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600974
steve-lunargbe283552017-04-18 12:18:01 -0600975 if (Options & EOptionHlslIoMapping)
976 shader->setHlslIoMapping(true);
977
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600978 if (Options & EOptionAutoMapBindings)
979 shader->setAutoMapBindings(true);
John Kessenichecba76f2017-01-06 00:34:48 -0700980
John Kessenich71facdf2017-05-17 18:28:19 -0600981 if (Options & EOptionAutoMapLocations)
982 shader->setAutoMapLocations(true);
983
LoopDawgb22c0692017-12-06 16:52:03 -0700984 if (Options & EOptionInvertY)
985 shader->setInvertY(true);
986
Neil Roberts16f53472018-03-20 17:30:53 +0100987 for (auto& uniOverride : uniformLocationOverrides) {
988 shader->addUniformLocationOverride(uniOverride.first.c_str(),
989 uniOverride.second);
990 }
991
Neil Robertsb0f3d792018-03-20 17:41:05 +0100992 shader->setUniformLocationBase(uniformBase);
993
John Kessenich4be4aeb2017-06-23 10:50:22 -0600994 // Set up the environment, some subsettings take precedence over earlier
995 // ways of setting things.
996 if (Options & EOptionSpv) {
John Kessenich8717a5d2018-10-26 10:12:32 -0600997 shader->setEnvInput((Options & EOptionReadHlsl) ? glslang::EShSourceHlsl
998 : glslang::EShSourceGlsl,
999 compUnit.stage, Client, ClientInputSemanticsVersion);
1000 shader->setEnvClient(Client, ClientVersion);
1001 shader->setEnvTarget(TargetLanguage, TargetVersion);
John Kessenich5d610ee2018-03-07 18:05:55 -07001002 if (targetHlslFunctionality1)
1003 shader->setEnvTargetHlslFunctionality1();
John Kessenich4be4aeb2017-06-23 10:50:22 -06001004 }
1005
John Kessenich69f4b512013-09-04 21:19:27 +00001006 shaders.push_back(shader);
John Kessenichb3297152015-07-11 18:01:03 -06001007
John Kessenich4be4aeb2017-06-23 10:50:22 -06001008 const int defaultVersion = Options & EOptionDefaultDesktop ? 110 : 100;
John Kessenich69f4b512013-09-04 21:19:27 +00001009
John Kessenich3494b4d2017-05-22 15:00:42 -06001010 DirStackFileIncluder includer;
John Kessenich971a0a82017-06-07 15:06:58 -06001011 std::for_each(IncludeDirectoryList.rbegin(), IncludeDirectoryList.rend(), [&includer](const std::string& dir) {
1012 includer.pushExternalLocalDirectory(dir); });
John Kessenichc555ddd2015-06-17 02:38:44 +00001013 if (Options & EOptionOutputPreprocessed) {
1014 std::string str;
John Kessenich086febc2018-10-25 12:43:02 -06001015 if (shader->preprocess(&Resources, defaultVersion, ENoProfile, false, false, messages, &str, includer)) {
Andrew Woloszynaae1ad82015-06-24 17:00:46 -04001016 PutsIfNonEmpty(str.c_str());
1017 } else {
1018 CompileFailed = true;
1019 }
1020 StderrIfNonEmpty(shader->getInfoLog());
1021 StderrIfNonEmpty(shader->getInfoDebugLog());
John Kessenichc555ddd2015-06-17 02:38:44 +00001022 continue;
1023 }
John Kessenich086febc2018-10-25 12:43:02 -06001024
John Kessenich3494b4d2017-05-22 15:00:42 -06001025 if (! shader->parse(&Resources, defaultVersion, false, messages, includer))
John Kessenichc999ba22013-11-07 23:33:24 +00001026 CompileFailed = true;
John Kessenichc555ddd2015-06-17 02:38:44 +00001027
John Kessenich69f4b512013-09-04 21:19:27 +00001028 program.addShader(shader);
1029
John Kessenichc57b2a92016-01-16 15:30:03 -07001030 if (! (Options & EOptionSuppressInfolog) &&
1031 ! (Options & EOptionMemoryLeakMode)) {
John Kessenich04acb1b2017-06-14 17:36:50 -06001032 PutsIfNonEmpty(compUnit.fileName[0].c_str());
Andrew Woloszynaae1ad82015-06-24 17:00:46 -04001033 PutsIfNonEmpty(shader->getInfoLog());
1034 PutsIfNonEmpty(shader->getInfoDebugLog());
John Kessenich69f4b512013-09-04 21:19:27 +00001035 }
John Kessenich69f4b512013-09-04 21:19:27 +00001036 }
1037
1038 //
1039 // Program-level processing...
1040 //
1041
John Kessenich4d65ee32016-03-12 18:17:47 -07001042 // Link
John Kessenich68d78fd2015-07-12 19:28:10 -06001043 if (! (Options & EOptionOutputPreprocessed) && ! program.link(messages))
John Kessenichc999ba22013-11-07 23:33:24 +00001044 LinkFailed = true;
1045
steve-lunarg9ae34742016-10-05 13:40:13 -06001046 // Map IO
1047 if (Options & EOptionSpv) {
1048 if (!program.mapIO())
1049 LinkFailed = true;
1050 }
John Kessenichecba76f2017-01-06 00:34:48 -07001051
John Kessenich4d65ee32016-03-12 18:17:47 -07001052 // Report
John Kessenichc57b2a92016-01-16 15:30:03 -07001053 if (! (Options & EOptionSuppressInfolog) &&
1054 ! (Options & EOptionMemoryLeakMode)) {
Andrew Woloszynaae1ad82015-06-24 17:00:46 -04001055 PutsIfNonEmpty(program.getInfoLog());
1056 PutsIfNonEmpty(program.getInfoDebugLog());
John Kessenich69f4b512013-09-04 21:19:27 +00001057 }
1058
John Kessenich4d65ee32016-03-12 18:17:47 -07001059 // Reflect
John Kessenich11f9fc72013-11-07 01:06:34 +00001060 if (Options & EOptionDumpReflection) {
baldurk6d477852019-01-29 15:45:56 +00001061 program.buildReflection(ReflectOptions);
John Kessenich11f9fc72013-11-07 01:06:34 +00001062 program.dumpReflection();
1063 }
1064
John Kessenich4d65ee32016-03-12 18:17:47 -07001065 // Dump SPIR-V
John Kessenich0df0cde2015-03-03 17:09:43 +00001066 if (Options & EOptionSpv) {
John Kessenich92f90382014-07-28 04:21:04 +00001067 if (CompileFailed || LinkFailed)
John Kessenich68d78fd2015-07-12 19:28:10 -06001068 printf("SPIR-V is not generated for failed compile or link\n");
John Kessenich92f90382014-07-28 04:21:04 +00001069 else {
1070 for (int stage = 0; stage < EShLangCount; ++stage) {
John Kessenicha7a68a92014-08-24 18:21:00 +00001071 if (program.getIntermediate((EShLanguage)stage)) {
John Kessenich0df0cde2015-03-03 17:09:43 +00001072 std::vector<unsigned int> spirv;
Lei Zhang09caf122016-05-02 18:11:54 -04001073 std::string warningsErrors;
Lei Zhang17535f72016-05-04 15:55:59 -04001074 spv::SpvBuildLogger logger;
John Kessenich121853f2017-05-31 17:11:16 -06001075 glslang::SpvOptions spvOptions;
1076 if (Options & EOptionDebug)
1077 spvOptions.generateDebugInfo = true;
GregF52fe3d52017-09-28 10:08:32 -06001078 spvOptions.disableOptimizer = (Options & EOptionOptimizeDisable) != 0;
1079 spvOptions.optimizeSize = (Options & EOptionOptimizeSize) != 0;
John Kessenich717c80a2018-08-23 15:17:10 -06001080 spvOptions.disassemble = SpvToolsDisassembler;
John Kessenichc3404252018-08-23 15:29:08 -06001081 spvOptions.validate = SpvToolsValidate;
John Kessenich121853f2017-05-31 17:11:16 -06001082 glslang::GlslangToSpv(*program.getIntermediate((EShLanguage)stage), spirv, &logger, &spvOptions);
John Kessenichc57b2a92016-01-16 15:30:03 -07001083
1084 // Dump the spv to a file or stdout, etc., but only if not doing
1085 // memory/perf testing, as it's not internal to programmatic use.
1086 if (! (Options & EOptionMemoryLeakMode)) {
Johannes van Waverenecb0f3b2016-05-27 12:55:53 -05001087 printf("%s", logger.getAllMessages().c_str());
1088 if (Options & EOptionOutputHexadecimal) {
John Kessenich8f674e82017-02-18 09:45:40 -07001089 glslang::OutputSpvHex(spirv, GetBinaryName((EShLanguage)stage), variableName);
Johannes van Waverenecb0f3b2016-05-27 12:55:53 -05001090 } else {
1091 glslang::OutputSpvBin(spirv, GetBinaryName((EShLanguage)stage));
1092 }
John Kesseniche2156222018-06-11 18:12:15 -06001093 if (!SpvToolsDisassembler && (Options & EOptionHumanReadableSpv))
John Kessenichc57b2a92016-01-16 15:30:03 -07001094 spv::Disassemble(std::cout, spirv);
John Kessenichacba7722015-03-04 03:48:38 +00001095 }
John Kessenicha7a68a92014-08-24 18:21:00 +00001096 }
John Kessenich92f90382014-07-28 04:21:04 +00001097 }
1098 }
1099 }
1100
John Kessenich5b0f13a2013-11-01 03:08:40 +00001101 // Free everything up, program has to go before the shaders
1102 // because it might have merged stuff from the shaders, and
1103 // the stuff from the shaders has to have its destructors called
1104 // before the pools holding the memory in the shaders is freed.
1105 delete &program;
John Kessenich69f4b512013-09-04 21:19:27 +00001106 while (shaders.size() > 0) {
1107 delete shaders.back();
1108 shaders.pop_back();
1109 }
John Kessenich69f4b512013-09-04 21:19:27 +00001110}
1111
John Kessenichc57b2a92016-01-16 15:30:03 -07001112//
1113// Do file IO part of compile and link, handing off the pure
1114// API/programmatic mode to CompileAndLinkShaderUnits(), which can
1115// be put in a loop for testing memory footprint and performance.
1116//
1117// This is just for linking mode: meaning all the shaders will be put into the
1118// the same program linked together.
1119//
1120// This means there are a limited number of work items (not multi-threading mode)
1121// and that the point is testing at the linking level. Hence, to enable
1122// performance and memory testing, the actual compile/link can be put in
1123// a loop, independent of processing the work items and file IO.
1124//
Juan Lopeza558b262017-04-02 23:04:00 +02001125void CompileAndLinkShaderFiles(glslang::TWorklist& Worklist)
John Kessenichc57b2a92016-01-16 15:30:03 -07001126{
1127 std::vector<ShaderCompUnit> compUnits;
1128
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001129 // If this is using stdin, we can't really detect multiple different file
1130 // units by input type. We need to assume that we're just being given one
1131 // file of a certain type.
1132 if ((Options & EOptionStdin) != 0) {
1133 ShaderCompUnit compUnit(FindLanguage("stdin"));
1134 std::istreambuf_iterator<char> begin(std::cin), end;
1135 std::string tempString(begin, end);
1136 char* fileText = strdup(tempString.c_str());
1137 std::string fileName = "stdin";
1138 compUnit.addString(fileName, fileText);
John Kessenichc57b2a92016-01-16 15:30:03 -07001139 compUnits.push_back(compUnit);
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001140 } else {
1141 // Transfer all the work items from to a simple list of
1142 // of compilation units. (We don't care about the thread
1143 // work-item distribution properties in this path, which
1144 // is okay due to the limited number of shaders, know since
1145 // they are all getting linked together.)
1146 glslang::TWorkItem* workItem;
1147 while (Worklist.remove(workItem)) {
1148 ShaderCompUnit compUnit(FindLanguage(workItem->name));
1149 char* fileText = ReadFileData(workItem->name.c_str());
1150 if (fileText == nullptr)
1151 usage();
1152 compUnit.addString(workItem->name, fileText);
1153 compUnits.push_back(compUnit);
1154 }
John Kessenichc57b2a92016-01-16 15:30:03 -07001155 }
1156
1157 // Actual call to programmatic processing of compile and link,
1158 // in a loop for testing memory and performance. This part contains
1159 // all the perf/memory that a programmatic consumer will care about.
1160 for (int i = 0; i < ((Options & EOptionMemoryLeakMode) ? 100 : 1); ++i) {
1161 for (int j = 0; j < ((Options & EOptionMemoryLeakMode) ? 100 : 1); ++j)
1162 CompileAndLinkShaderUnits(compUnits);
1163
1164 if (Options & EOptionMemoryLeakMode)
1165 glslang::OS_DumpMemoryCounters();
1166 }
1167
John Kessenicha9313662017-06-15 10:40:49 -06001168 // free memory from ReadFileData, which got stored in a const char*
1169 // as the first string above
rdb32084e82016-02-23 22:17:38 +01001170 for (auto it = compUnits.begin(); it != compUnits.end(); ++it)
John Kessenicha9313662017-06-15 10:40:49 -06001171 FreeFileData(const_cast<char*>(it->text[0]));
John Kessenichc57b2a92016-01-16 15:30:03 -07001172}
1173
John Kessenich94f28eb2017-11-13 01:32:06 -07001174int singleMain()
John Kessenicha0af4732012-12-12 21:15:54 +00001175{
Juan Lopeza558b262017-04-02 23:04:00 +02001176 glslang::TWorklist workList;
John Kessenich94f28eb2017-11-13 01:32:06 -07001177 std::for_each(WorkItems.begin(), WorkItems.end(), [&workList](std::unique_ptr<glslang::TWorkItem>& item) {
Juan Lopeza558b262017-04-02 23:04:00 +02001178 assert(item);
1179 workList.add(item.get());
1180 });
John Kessenich2b07c7e2013-07-31 18:44:13 +00001181
John Kessenich05a70632013-09-17 19:26:08 +00001182 if (Options & EOptionDumpConfig) {
Lei Zhang414eb602016-03-04 16:22:34 -05001183 printf("%s", glslang::GetDefaultTBuiltInResourceString().c_str());
Juan Lopeza558b262017-04-02 23:04:00 +02001184 if (workList.empty())
John Kessenich05a70632013-09-17 19:26:08 +00001185 return ESuccess;
1186 }
1187
John Kessenichc6c80a62018-03-05 22:23:17 -07001188 if (Options & EOptionDumpBareVersion) {
1189 printf("%d.%d.%d\n",
1190 glslang::GetSpirvGeneratorVersion(), GLSLANG_MINOR_VERSION, GLSLANG_PATCH_LEVEL);
1191 if (workList.empty())
1192 return ESuccess;
1193 } else if (Options & EOptionDumpVersions) {
1194 printf("Glslang Version: %d.%d.%d\n",
1195 glslang::GetSpirvGeneratorVersion(), GLSLANG_MINOR_VERSION, GLSLANG_PATCH_LEVEL);
John Kessenich319de232013-12-04 04:43:40 +00001196 printf("ESSL Version: %s\n", glslang::GetEsslVersionString());
1197 printf("GLSL Version: %s\n", glslang::GetGlslVersionString());
John Kessenich68d78fd2015-07-12 19:28:10 -06001198 std::string spirvVersion;
1199 glslang::GetSpirvVersion(spirvVersion);
John Kessenich0da9eaa2015-08-01 17:10:02 -06001200 printf("SPIR-V Version %s\n", spirvVersion.c_str());
John Kessenich5e4b1242015-08-06 22:53:06 -06001201 printf("GLSL.std.450 Version %d, Revision %d\n", GLSLstd450Version, GLSLstd450Revision);
John Kessenich55e7d112015-11-15 21:33:39 -07001202 printf("Khronos Tool ID %d\n", glslang::GetKhronosToolId());
John Kessenicha372a3e2017-11-02 22:32:14 -06001203 printf("SPIR-V Generator Version %d\n", glslang::GetSpirvGeneratorVersion());
John Kessenichb84313d2016-07-20 16:03:29 -06001204 printf("GL_KHR_vulkan_glsl version %d\n", 100);
1205 printf("ARB_GL_gl_spirv version %d\n", 100);
Juan Lopeza558b262017-04-02 23:04:00 +02001206 if (workList.empty())
John Kessenich319de232013-12-04 04:43:40 +00001207 return ESuccess;
1208 }
1209
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001210 if (workList.empty() && ((Options & EOptionStdin) == 0)) {
John Kessenich05a70632013-09-17 19:26:08 +00001211 usage();
John Kessenich05a70632013-09-17 19:26:08 +00001212 }
1213
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001214 if (Options & EOptionStdin) {
John Kessenich94f28eb2017-11-13 01:32:06 -07001215 WorkItems.push_back(std::unique_ptr<glslang::TWorkItem>{new glslang::TWorkItem("stdin")});
1216 workList.add(WorkItems.back().get());
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001217 }
1218
John Kessenich05a70632013-09-17 19:26:08 +00001219 ProcessConfigFile();
1220
John Kessenich086febc2018-10-25 12:43:02 -06001221 if ((Options & EOptionReadHlsl) && !((Options & EOptionOutputPreprocessed) || (Options & EOptionSpv)))
1222 Error("ERROR: HLSL requires SPIR-V code generation (or preprocessing only)");
1223
John Kessenich69f4b512013-09-04 21:19:27 +00001224 //
1225 // Two modes:
John Kessenich38f3b892013-09-06 19:52:57 +00001226 // 1) linking all arguments together, single-threaded, new C++ interface
1227 // 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 +00001228 //
John Kessenich086febc2018-10-25 12:43:02 -06001229 if (Options & (EOptionLinkProgram | EOptionOutputPreprocessed)) {
John Kessenichc36e1d82013-11-01 17:41:52 +00001230 glslang::InitializeProcess();
John Kesseniche2c15b42017-11-16 22:48:41 -07001231 glslang::InitializeProcess(); // also test reference counting of users
1232 glslang::InitializeProcess(); // also test reference counting of users
1233 glslang::FinalizeProcess(); // also test reference counting of users
1234 glslang::FinalizeProcess(); // also test reference counting of users
Juan Lopeza558b262017-04-02 23:04:00 +02001235 CompileAndLinkShaderFiles(workList);
John Kessenichc36e1d82013-11-01 17:41:52 +00001236 glslang::FinalizeProcess();
1237 } else {
1238 ShInitialize();
John Kesseniche2c15b42017-11-16 22:48:41 -07001239 ShInitialize(); // also test reference counting of users
1240 ShFinalize(); // also test reference counting of users
John Kessenichc36e1d82013-11-01 17:41:52 +00001241
Juan Lopeza558b262017-04-02 23:04:00 +02001242 bool printShaderNames = workList.size() > 1;
John Kessenich69f4b512013-09-04 21:19:27 +00001243
John Kesseniche2c15b42017-11-16 22:48:41 -07001244 if (Options & EOptionMultiThreaded) {
Juan Lopeza558b262017-04-02 23:04:00 +02001245 std::array<std::thread, 16> threads;
John Kesseniche2c15b42017-11-16 22:48:41 -07001246 for (unsigned int t = 0; t < threads.size(); ++t) {
Juan Lopeza558b262017-04-02 23:04:00 +02001247 threads[t] = std::thread(CompileShaders, std::ref(workList));
John Kesseniche2c15b42017-11-16 22:48:41 -07001248 if (threads[t].get_id() == std::thread::id()) {
John Kessenichaf527992017-11-02 22:48:15 -06001249 fprintf(stderr, "Failed to create thread\n");
John Kessenich38f3b892013-09-06 19:52:57 +00001250 return EFailThreadCreate;
1251 }
John Kessenicha0af4732012-12-12 21:15:54 +00001252 }
Juan Lopeza558b262017-04-02 23:04:00 +02001253
1254 std::for_each(threads.begin(), threads.end(), [](std::thread& t) { t.join(); });
John Kessenichc999ba22013-11-07 23:33:24 +00001255 } else
Juan Lopeza558b262017-04-02 23:04:00 +02001256 CompileShaders(workList);
John Kessenich38f3b892013-09-06 19:52:57 +00001257
1258 // Print out all the resulting infologs
John Kessenich94f28eb2017-11-13 01:32:06 -07001259 for (size_t w = 0; w < WorkItems.size(); ++w) {
1260 if (WorkItems[w]) {
1261 if (printShaderNames || WorkItems[w]->results.size() > 0)
1262 PutsIfNonEmpty(WorkItems[w]->name.c_str());
1263 PutsIfNonEmpty(WorkItems[w]->results.c_str());
John Kessenich38f3b892013-09-06 19:52:57 +00001264 }
1265 }
John Kessenichc36e1d82013-11-01 17:41:52 +00001266
1267 ShFinalize();
John Kessenicha0af4732012-12-12 21:15:54 +00001268 }
John Kessenich2b07c7e2013-07-31 18:44:13 +00001269
John Kessenichc999ba22013-11-07 23:33:24 +00001270 if (CompileFailed)
John Kessenicha0af4732012-12-12 21:15:54 +00001271 return EFailCompile;
John Kessenichc999ba22013-11-07 23:33:24 +00001272 if (LinkFailed)
John Kessenicha0af4732012-12-12 21:15:54 +00001273 return EFailLink;
1274
1275 return 0;
1276}
1277
John Kessenich94f28eb2017-11-13 01:32:06 -07001278int C_DECL main(int argc, char* argv[])
1279{
1280 ProcessArguments(WorkItems, argc, argv);
1281
1282 int ret = 0;
1283
1284 // Loop over the entire init/finalize cycle to watch memory changes
1285 const int iterations = 1;
1286 if (iterations > 1)
1287 glslang::OS_DumpMemoryCounters();
1288 for (int i = 0; i < iterations; ++i) {
1289 ret = singleMain();
1290 if (iterations > 1)
1291 glslang::OS_DumpMemoryCounters();
1292 }
1293
1294 return ret;
1295}
1296
John Kessenicha0af4732012-12-12 21:15:54 +00001297//
1298// Deduce the language from the filename. Files must end in one of the
1299// following extensions:
1300//
John Kessenich2b07c7e2013-07-31 18:44:13 +00001301// .vert = vertex
1302// .tesc = tessellation control
1303// .tese = tessellation evaluation
1304// .geom = geometry
1305// .frag = fragment
John Kessenich94a81fb2013-08-31 02:41:30 +00001306// .comp = compute
Chao Chenb50c02e2018-09-19 11:42:24 -07001307// .rgen = ray generation
1308// .rint = ray intersection
1309// .rahit = ray any hit
1310// .rchit = ray closest hit
1311// .rmiss = ray miss
1312// .rcall = ray callable
Sahil Parmar035cbbe2018-10-04 16:39:18 -07001313// .mesh = mesh
1314// .task = task
Grigory Dzhavadyan33507412018-04-12 14:35:24 -07001315// Additionally, the file names may end in .<stage>.glsl and .<stage>.hlsl
1316// where <stage> is one of the stages listed above.
1317//
1318EShLanguage FindLanguage(const std::string& name, bool parseStageName)
John Kessenicha0af4732012-12-12 21:15:54 +00001319{
John Kessenichfccbb8b2018-04-17 17:24:03 -06001320 std::string stageName;
Dan Bakerc6ede892016-08-11 14:06:06 -04001321 if (shaderStageName)
John Kessenichfccbb8b2018-04-17 17:24:03 -06001322 stageName = shaderStageName;
1323 else if (parseStageName) {
Grigory Dzhavadyan33507412018-04-12 14:35:24 -07001324 // Note: "first" extension means "first from the end", i.e.
1325 // if the file is named foo.vert.glsl, then "glsl" is first,
1326 // "vert" is second.
John Kessenichfccbb8b2018-04-17 17:24:03 -06001327 size_t firstExtStart = name.find_last_of(".");
1328 bool hasFirstExt = firstExtStart != std::string::npos;
1329 size_t secondExtStart = hasFirstExt ? name.find_last_of(".", firstExtStart - 1) : std::string::npos;
1330 bool hasSecondExt = secondExtStart != std::string::npos;
1331 std::string firstExt = name.substr(firstExtStart + 1, std::string::npos);
1332 bool usesUnifiedExt = hasFirstExt && (firstExt == "glsl" || firstExt == "hlsl");
John Kessenich3beac942018-04-17 21:02:19 -06001333 if (usesUnifiedExt && firstExt == "hlsl")
1334 Options |= EOptionReadHlsl;
1335 if (hasFirstExt && !usesUnifiedExt)
John Kessenichfccbb8b2018-04-17 17:24:03 -06001336 stageName = firstExt;
John Kessenich3beac942018-04-17 21:02:19 -06001337 else if (usesUnifiedExt && hasSecondExt)
John Kessenichfccbb8b2018-04-17 17:24:03 -06001338 stageName = name.substr(secondExtStart + 1, firstExtStart - secondExtStart - 1);
John Kessenich3beac942018-04-17 21:02:19 -06001339 else {
Grigory Dzhavadyan33507412018-04-12 14:35:24 -07001340 usage();
1341 return EShLangVertex;
John Kesseniche751bca2017-03-16 11:20:38 -06001342 }
John Kessenichfccbb8b2018-04-17 17:24:03 -06001343 } else
1344 stageName = name;
dankbaker45d49bc2016-08-08 21:43:07 -04001345
John Kessenichfccbb8b2018-04-17 17:24:03 -06001346 if (stageName == "vert")
John Kessenich2b07c7e2013-07-31 18:44:13 +00001347 return EShLangVertex;
John Kessenichfccbb8b2018-04-17 17:24:03 -06001348 else if (stageName == "tesc")
John Kessenich2b07c7e2013-07-31 18:44:13 +00001349 return EShLangTessControl;
John Kessenichfccbb8b2018-04-17 17:24:03 -06001350 else if (stageName == "tese")
John Kessenich2b07c7e2013-07-31 18:44:13 +00001351 return EShLangTessEvaluation;
John Kessenichfccbb8b2018-04-17 17:24:03 -06001352 else if (stageName == "geom")
John Kessenich2b07c7e2013-07-31 18:44:13 +00001353 return EShLangGeometry;
John Kessenichfccbb8b2018-04-17 17:24:03 -06001354 else if (stageName == "frag")
John Kessenich2b07c7e2013-07-31 18:44:13 +00001355 return EShLangFragment;
John Kessenichfccbb8b2018-04-17 17:24:03 -06001356 else if (stageName == "comp")
John Kessenichc0275792013-08-09 17:14:49 +00001357 return EShLangCompute;
Chao Chen3c366992018-09-19 11:41:59 -07001358#ifdef NV_EXTENSIONS
Chao Chenb50c02e2018-09-19 11:42:24 -07001359 else if (stageName == "rgen")
1360 return EShLangRayGenNV;
1361 else if (stageName == "rint")
1362 return EShLangIntersectNV;
1363 else if (stageName == "rahit")
1364 return EShLangAnyHitNV;
1365 else if (stageName == "rchit")
1366 return EShLangClosestHitNV;
1367 else if (stageName == "rmiss")
1368 return EShLangMissNV;
1369 else if (stageName == "rcall")
1370 return EShLangCallableNV;
Chao Chen3c366992018-09-19 11:41:59 -07001371 else if (stageName == "mesh")
1372 return EShLangMeshNV;
1373 else if (stageName == "task")
1374 return EShLangTaskNV;
1375#endif
John Kessenich2b07c7e2013-07-31 18:44:13 +00001376
1377 usage();
John Kesseniche95ecc52012-12-12 21:34:14 +00001378 return EShLangVertex;
John Kessenicha0af4732012-12-12 21:15:54 +00001379}
1380
John Kessenicha0af4732012-12-12 21:15:54 +00001381//
John Kessenichecba76f2017-01-06 00:34:48 -07001382// Read a file's data into a string, and compile it using the old interface ShCompile,
John Kessenich69f4b512013-09-04 21:19:27 +00001383// for non-linkable results.
John Kessenicha0af4732012-12-12 21:15:54 +00001384//
John Kessenich51cdd902014-02-18 23:37:57 +00001385void CompileFile(const char* fileName, ShHandle compiler)
John Kessenicha0af4732012-12-12 21:15:54 +00001386{
John Kessenichca3457f2015-05-18 01:59:45 +00001387 int ret = 0;
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001388 char* shaderString;
1389 if ((Options & EOptionStdin) != 0) {
1390 std::istreambuf_iterator<char> begin(std::cin), end;
1391 std::string tempString(begin, end);
1392 shaderString = strdup(tempString.c_str());
1393 } else {
1394 shaderString = ReadFileData(fileName);
1395 }
John Kessenich41cf6b52013-06-25 18:10:05 +00001396
1397 // move to length-based strings, rather than null-terminated strings
John Kessenich04acb1b2017-06-14 17:36:50 -06001398 int* lengths = new int[1];
1399 lengths[0] = (int)strlen(shaderString);
John Kessenicha0af4732012-12-12 21:15:54 +00001400
John Kessenich52ac67e2013-05-05 23:46:22 +00001401 EShMessages messages = EShMsgDefault;
John Kessenichb0a7eb52013-11-07 17:44:20 +00001402 SetMessageOptions(messages);
John Kessenichecba76f2017-01-06 00:34:48 -07001403
John Kessenicha9313662017-06-15 10:40:49 -06001404 if (UserPreamble.isSet())
1405 Error("-D and -U options require -l (linking)\n");
1406
John Kessenich94a81fb2013-08-31 02:41:30 +00001407 for (int i = 0; i < ((Options & EOptionMemoryLeakMode) ? 100 : 1); ++i) {
1408 for (int j = 0; j < ((Options & EOptionMemoryLeakMode) ? 100 : 1); ++j) {
John Kessenich927608b2017-01-06 12:34:14 -07001409 // ret = ShCompile(compiler, shaderStrings, NumShaderStrings, lengths, EShOptNone, &Resources, Options, (Options & EOptionDefaultDesktop) ? 110 : 100, false, messages);
John Kessenich04acb1b2017-06-14 17:36:50 -06001410 ret = ShCompile(compiler, &shaderString, 1, nullptr, EShOptNone, &Resources, Options, (Options & EOptionDefaultDesktop) ? 110 : 100, false, messages);
John Kessenich927608b2017-01-06 12:34:14 -07001411 // const char* multi[12] = { "# ve", "rsion", " 300 e", "s", "\n#err",
John Kessenichecba76f2017-01-06 00:34:48 -07001412 // "or should be l", "ine 1", "string 5\n", "float glo", "bal",
John Kessenichea869fb2013-10-28 18:12:06 +00001413 // ";\n#error should be line 2\n void main() {", "global = 2.3;}" };
John Kessenich927608b2017-01-06 12:34:14 -07001414 // const char* multi[7] = { "/", "/", "\\", "\n", "\n", "#", "version 300 es" };
1415 // ret = ShCompile(compiler, multi, 7, nullptr, EShOptNone, &Resources, Options, (Options & EOptionDefaultDesktop) ? 110 : 100, false, messages);
John Kessenich41cf6b52013-06-25 18:10:05 +00001416 }
John Kessenicha0af4732012-12-12 21:15:54 +00001417
John Kessenich94a81fb2013-08-31 02:41:30 +00001418 if (Options & EOptionMemoryLeakMode)
John Kessenich2b07c7e2013-07-31 18:44:13 +00001419 glslang::OS_DumpMemoryCounters();
John Kessenicha0af4732012-12-12 21:15:54 +00001420 }
John Kessenicha0af4732012-12-12 21:15:54 +00001421
John Kessenich41cf6b52013-06-25 18:10:05 +00001422 delete [] lengths;
John Kessenich04acb1b2017-06-14 17:36:50 -06001423 FreeFileData(shaderString);
John Kessenicha0af4732012-12-12 21:15:54 +00001424
John Kessenichc999ba22013-11-07 23:33:24 +00001425 if (ret == 0)
1426 CompileFailed = true;
John Kessenicha0af4732012-12-12 21:15:54 +00001427}
1428
John Kessenicha0af4732012-12-12 21:15:54 +00001429//
1430// print usage to stdout
1431//
1432void usage()
1433{
John Kessenich319de232013-12-04 04:43:40 +00001434 printf("Usage: glslangValidator [option]... [file]...\n"
1435 "\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001436 "'file' can end in .<stage> for auto-stage classification, where <stage> is:\n"
1437 " .conf to provide a config file that replaces the default configuration\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001438 " (see -c option below for generating a template)\n"
1439 " .vert for a vertex shader\n"
1440 " .tesc for a tessellation control shader\n"
1441 " .tese for a tessellation evaluation shader\n"
1442 " .geom for a geometry shader\n"
1443 " .frag for a fragment shader\n"
1444 " .comp for a compute shader\n"
Chao Chen3c366992018-09-19 11:41:59 -07001445#ifdef NV_EXTENSIONS
1446 " .mesh for a mesh shader\n"
1447 " .task for a task shader\n"
Chao Chenb50c02e2018-09-19 11:42:24 -07001448 " .rgen for a ray generation shader\n"
1449 " .rint for a ray intersection shader\n"
1450 " .rahit for a ray any hit shader\n"
1451 " .rchit for a ray closest hit shader\n"
1452 " .rmiss for a ray miss shader\n"
Sahil Parmar035cbbe2018-10-04 16:39:18 -07001453 " .rcall for a ray callable shader\n"
Chao Chen3c366992018-09-19 11:41:59 -07001454#endif
John Kessenich2ead40f2018-04-17 17:44:11 -06001455 " .glsl for .vert.glsl, .tesc.glsl, ..., .comp.glsl compound suffixes\n"
1456 " .hlsl for .vert.hlsl, .tesc.hlsl, ..., .comp.hlsl compound suffixes\n"
John Kessenich319de232013-12-04 04:43:40 +00001457 "\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001458 "Options:\n"
1459 " -C cascading errors; risk crash from accumulation of error recoveries\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001460 " -D input is HLSL (this is the default when any suffix is .hlsl)\n"
John Kessenicha9313662017-06-15 10:40:49 -06001461 " -D<macro=def>\n"
1462 " -D<macro> define a pre-processor macro\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001463 " -E print pre-processed GLSL; cannot be used with -l;\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001464 " errors will appear on stderr\n"
John Kessenich6353d552017-06-23 11:11:09 -06001465 " -G[ver] create SPIR-V binary, under OpenGL semantics; turns on -l;\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001466 " default file name is <stage>.spv (-o overrides this);\n"
John Kessenich6353d552017-06-23 11:11:09 -06001467 " 'ver', when present, is the version of the input semantics,\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001468 " which will appear in #define GL_SPIRV ver;\n"
1469 " '--client opengl100' is the same as -G100;\n"
John Kessenich6353d552017-06-23 11:11:09 -06001470 " a '--target-env' for OpenGL will also imply '-G'\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001471 " -H print human readable form of SPIR-V; turns on -V\n"
John Kessenich971a0a82017-06-07 15:06:58 -06001472 " -I<dir> add dir to the include search path; includer's directory\n"
1473 " is searched first, followed by left-to-right order of -I\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001474 " -Od disables optimization; may cause illegal SPIR-V for HLSL\n"
1475 " -Os optimizes SPIR-V to minimize size\n"
John Kesseniche751bca2017-03-16 11:20:38 -06001476 " -S <stage> uses specified stage rather than parsing the file extension\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001477 " choices for <stage> are vert, tesc, tese, geom, frag, or comp\n"
John Kessenich6353d552017-06-23 11:11:09 -06001478 " -U<macro> undefine a pre-processor macro\n"
1479 " -V[ver] create SPIR-V binary, under Vulkan semantics; turns on -l;\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001480 " default file name is <stage>.spv (-o overrides this)\n"
John Kessenich6353d552017-06-23 11:11:09 -06001481 " 'ver', when present, is the version of the input semantics,\n"
1482 " which will appear in #define VULKAN ver\n"
1483 " '--client vulkan100' is the same as -V100\n"
1484 " a '--target-env' for Vulkan will also imply '-V'\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001485 " -c configuration dump;\n"
1486 " creates the default configuration file (redirect to a .conf file)\n"
1487 " -d default to desktop (#version 110) when there is no shader #version\n"
1488 " (default is ES version 100)\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001489 " -e <name> | --entry-point <name>\n"
1490 " specify <name> as the entry-point function name\n"
John Kessenich5d610ee2018-03-07 18:05:55 -07001491 " -f{hlsl_functionality1}\n"
1492 " 'hlsl_functionality1' enables use of the\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001493 " SPV_GOOGLE_hlsl_functionality1 extension\n"
John Kessenich121853f2017-05-31 17:11:16 -06001494 " -g generate debug information\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001495 " -h print this usage message\n"
1496 " -i intermediate tree (glslang AST) is printed out\n"
1497 " -l link all input files together to form a single module\n"
1498 " -m memory leak mode\n"
John Kessenicha25530c2017-09-11 20:13:49 -06001499 " -o <file> save binary to <file>, requires a binary option (e.g., -V)\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001500 " -q dump reflection query database\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001501 " -r | --relaxed-errors"
1502 " relaxed GLSL semantic error-checking mode\n"
John Kessenichb63f4a32017-11-16 22:32:20 -07001503 " -s silence syntax and semantic error reporting\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001504 " -t multi-threaded mode\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001505 " -v | --version\n"
1506 " print version strings\n"
1507 " -w | --suppress-warnings\n"
1508 " suppress GLSL warnings, except as required by \"#extension : warn\"\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001509 " -x save binary output as text-based 32-bit hexadecimal numbers\n"
Neil Roberts16f53472018-03-20 17:30:53 +01001510 " -u<name>:<loc> specify a uniform location override for --aml\n"
Neil Robertsb0f3d792018-03-20 17:41:05 +01001511 " --uniform-base <base> set a base to use for generated uniform locations\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001512 " --auto-map-bindings | --amb automatically bind uniform variables\n"
1513 " without explicit bindings\n"
1514 " --auto-map-locations | --aml automatically locate input/output lacking\n"
1515 " 'location' (fragile, not cross stage)\n"
1516 " --client {vulkan<ver>|opengl<ver>} see -V and -G\n"
1517 " -dumpfullversion | -dumpversion print bare major.minor.patchlevel\n"
1518 " --flatten-uniform-arrays | --fua flatten uniform texture/sampler arrays to\n"
1519 " scalars\n"
1520 " --hlsl-offsets allow block offsets to follow HLSL rules\n"
1521 " works independently of source language\n"
1522 " --hlsl-iomap perform IO mapping in HLSL register space\n"
1523 " --hlsl-enable-16bit-types allow 16-bit types in SPIR-V for HLSL\n"
John Kessenichbd1c1832018-12-07 18:38:26 -07001524 " --hlsl-dx9-compatible interprets sampler declarations as a texture/sampler combo like DirectX9 would."
John Kessenichade8bbb2018-08-12 21:24:55 -06001525 " --invert-y | --iy invert position.Y output in vertex shader\n"
1526 " --keep-uncalled | --ku don't eliminate uncalled functions\n"
1527 " --no-storage-format | --nsf use Unknown image format\n"
baldurk15c37f72019-01-29 12:12:59 +00001528 " --reflect-strict-array-suffix use strict array suffix rules when reflecting\n"
baldurkedf82122019-01-29 15:49:00 +00001529 " --reflect-basic-array-suffix arrays of basic types will have trailing [0]\n"
baldurk0af5e3e2019-01-29 16:04:44 +00001530 " --reflect-intermediate-io reflection includes inputs/outputs of linked shaders\n"
1531 " rather than just vertex/fragment\n"
LoopDawg52017192017-07-14 15:15:47 -06001532 " --resource-set-binding [stage] name set binding\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001533 " set descriptor set and binding for\n"
1534 " individual resources\n"
LoopDawg52017192017-07-14 15:15:47 -06001535 " --resource-set-binding [stage] set\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001536 " set descriptor set for all resources\n"
1537 " --rsb synonym for --resource-set-binding\n"
1538 " --shift-image-binding [stage] num\n"
1539 " base binding number for images (uav)\n"
1540 " --shift-image-binding [stage] [num set]...\n"
1541 " per-descriptor-set shift values\n"
1542 " --sib synonym for --shift-image-binding\n"
1543 " --shift-sampler-binding [stage] num\n"
1544 " base binding number for samplers\n"
1545 " --shift-sampler-binding [stage] [num set]...\n"
1546 " per-descriptor-set shift values\n"
1547 " --ssb synonym for --shift-sampler-binding\n"
1548 " --shift-ssbo-binding [stage] num base binding number for SSBOs\n"
1549 " --shift-ssbo-binding [stage] [num set]...\n"
1550 " per-descriptor-set shift values\n"
1551 " --sbb synonym for --shift-ssbo-binding\n"
1552 " --shift-texture-binding [stage] num\n"
1553 " base binding number for textures\n"
1554 " --shift-texture-binding [stage] [num set]...\n"
1555 " per-descriptor-set shift values\n"
1556 " --stb synonym for --shift-texture-binding\n"
1557 " --shift-uav-binding [stage] num base binding number for UAVs\n"
1558 " --shift-uav-binding [stage] [num set]...\n"
1559 " per-descriptor-set shift values\n"
1560 " --suavb synonym for --shift-uav-binding\n"
1561 " --shift-UBO-binding [stage] num base binding number for UBOs\n"
1562 " --shift-UBO-binding [stage] [num set]...\n"
1563 " per-descriptor-set shift values\n"
1564 " --sub synonym for --shift-UBO-binding\n"
1565 " --shift-cbuffer-binding | --scb synonyms for --shift-UBO-binding\n"
1566 " --spirv-dis output standard-form disassembly; works only\n"
1567 " when a SPIR-V generation option is also used\n"
John Kessenichc3404252018-08-23 15:29:08 -06001568 " --spirv-val execute the SPIRV-Tools validator\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001569 " --source-entrypoint <name> the given shader source function is\n"
1570 " renamed to be the <name> given in -e\n"
1571 " --sep synonym for --source-entrypoint\n"
1572 " --stdin read from stdin instead of from a file;\n"
1573 " requires providing the shader stage using -S\n"
John Kessenich8717a5d2018-10-26 10:12:32 -06001574 " --target-env {vulkan1.0 | vulkan1.1 | opengl | \n"
1575 " spirv1.0 | spirv1.1 | spirv1.2 | spirv1.3}\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001576 " set execution environment that emitted code\n"
John Kessenich8717a5d2018-10-26 10:12:32 -06001577 " will execute in (versus source language\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001578 " semantics selected by --client) defaults:\n"
1579 " * 'vulkan1.0' under '--client vulkan<ver>'\n"
1580 " * 'opengl' under '--client opengl<ver>'\n"
John Kessenich8717a5d2018-10-26 10:12:32 -06001581 " * 'spirv1.0' under --target-env vulkan1.0\n"
1582 " * 'spirv1.3' under --target-env vulkan1.1\n"
1583 " multiple --targen-env can be specified.\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001584 " --variable-name <name>\n"
1585 " --vn <name> creates a C header file that contains a\n"
1586 " uint32_t array named <name>\n"
1587 " initialized with the shader binary code\n"
John Kessenichb0a7eb52013-11-07 17:44:20 +00001588 );
John Kessenich68d78fd2015-07-12 19:28:10 -06001589
1590 exit(EFailUsage);
John Kessenicha0af4732012-12-12 21:15:54 +00001591}
1592
John Kessenich3ce4e592014-10-06 19:57:34 +00001593#if !defined _MSC_VER && !defined MINGW_HAS_SECURE_API
John Kessenichcfd643e2013-03-08 23:14:42 +00001594
1595#include <errno.h>
1596
1597int fopen_s(
1598 FILE** pFile,
John Kessenich51cdd902014-02-18 23:37:57 +00001599 const char* filename,
1600 const char* mode
John Kessenichcfd643e2013-03-08 23:14:42 +00001601)
1602{
1603 if (!pFile || !filename || !mode) {
1604 return EINVAL;
1605 }
1606
1607 FILE* f = fopen(filename, mode);
1608 if (! f) {
1609 if (errno != 0) {
1610 return errno;
1611 } else {
1612 return ENOENT;
1613 }
1614 }
1615 *pFile = f;
1616
1617 return 0;
1618}
1619
1620#endif
1621
John Kessenicha0af4732012-12-12 21:15:54 +00001622//
1623// Malloc a string of sufficient size and read a string into it.
1624//
John Kessenich04acb1b2017-06-14 17:36:50 -06001625char* ReadFileData(const char* fileName)
John Kessenicha0af4732012-12-12 21:15:54 +00001626{
John Kessenichb3297152015-07-11 18:01:03 -06001627 FILE *in = nullptr;
John Kessenich3ce4e592014-10-06 19:57:34 +00001628 int errorCode = fopen_s(&in, fileName, "r");
John Kessenich68d78fd2015-07-12 19:28:10 -06001629 if (errorCode || in == nullptr)
1630 Error("unable to open input file");
John Kessenichecba76f2017-01-06 00:34:48 -07001631
John Kessenich04acb1b2017-06-14 17:36:50 -06001632 int count = 0;
John Kessenicha0af4732012-12-12 21:15:54 +00001633 while (fgetc(in) != EOF)
1634 count++;
1635
John Kessenichd6c72a42014-08-18 19:42:35 +00001636 fseek(in, 0, SEEK_SET);
John Kessenichca3457f2015-05-18 01:59:45 +00001637
John Kessenich04acb1b2017-06-14 17:36:50 -06001638 char* return_data = (char*)malloc(count + 1); // freed in FreeFileData()
1639 if ((int)fread(return_data, 1, count, in) != count) {
1640 free(return_data);
John Kessenich68d78fd2015-07-12 19:28:10 -06001641 Error("can't read input file");
John Kessenicha0af4732012-12-12 21:15:54 +00001642 }
John Kessenich68d78fd2015-07-12 19:28:10 -06001643
John Kessenich04acb1b2017-06-14 17:36:50 -06001644 return_data[count] = '\0';
John Kessenicha0af4732012-12-12 21:15:54 +00001645 fclose(in);
John Kessenichb3297152015-07-11 18:01:03 -06001646
John Kessenicha0af4732012-12-12 21:15:54 +00001647 return return_data;
1648}
1649
John Kessenich04acb1b2017-06-14 17:36:50 -06001650void FreeFileData(char* data)
John Kessenicha0af4732012-12-12 21:15:54 +00001651{
John Kessenichb3297152015-07-11 18:01:03 -06001652 free(data);
John Kessenicha0af4732012-12-12 21:15:54 +00001653}
1654
John Kessenich54d8cda2013-02-11 22:36:01 +00001655void InfoLogMsg(const char* msg, const char* name, const int num)
John Kessenicha0af4732012-12-12 21:15:54 +00001656{
John Kessenichfae38ee2015-06-10 23:23:12 +00001657 if (num >= 0 )
1658 printf("#### %s %s %d INFO LOG ####\n", msg, name, num);
1659 else
1660 printf("#### %s %s INFO LOG ####\n", msg, name);
John Kessenicha0af4732012-12-12 21:15:54 +00001661}