blob: d26040c62e0043a26ed1096b551fa958c8599c80 [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;
John Kessenich6263fb12017-06-14 15:52:44 -0600527 } else if (lowerword == "resource-set-bindings" || // synonyms
528 lowerword == "resource-set-binding" ||
529 lowerword == "rsb") {
530 ProcessResourceSetBindingBase(argc, argv, baseResourceSetBinding);
steve-lunarg9088be42016-11-01 10:31:42 -0600531 } else if (lowerword == "shift-image-bindings" || // synonyms
532 lowerword == "shift-image-binding" ||
533 lowerword == "sib") {
LoopDawg08a14422017-10-17 19:27:14 -0600534 ProcessBindingBase(argc, argv, glslang::EResImage);
John Kessenich6263fb12017-06-14 15:52:44 -0600535 } else if (lowerword == "shift-sampler-bindings" || // synonyms
John Kessenichade8bbb2018-08-12 21:24:55 -0600536 lowerword == "shift-sampler-binding" ||
537 lowerword == "ssb") {
LoopDawg08a14422017-10-17 19:27:14 -0600538 ProcessBindingBase(argc, argv, glslang::EResSampler);
John Kessenich6263fb12017-06-14 15:52:44 -0600539 } else if (lowerword == "shift-uav-bindings" || // synonyms
540 lowerword == "shift-uav-binding" ||
541 lowerword == "suavb") {
LoopDawg08a14422017-10-17 19:27:14 -0600542 ProcessBindingBase(argc, argv, glslang::EResUav);
John Kessenich6263fb12017-06-14 15:52:44 -0600543 } else if (lowerword == "shift-texture-bindings" || // synonyms
544 lowerword == "shift-texture-binding" ||
545 lowerword == "stb") {
LoopDawg08a14422017-10-17 19:27:14 -0600546 ProcessBindingBase(argc, argv, glslang::EResTexture);
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600547 } else if (lowerword == "shift-ubo-bindings" || // synonyms
548 lowerword == "shift-ubo-binding" ||
steve-lunargbe283552017-04-18 12:18:01 -0600549 lowerword == "shift-cbuffer-bindings" ||
550 lowerword == "shift-cbuffer-binding" ||
551 lowerword == "sub" ||
552 lowerword == "scb") {
LoopDawg08a14422017-10-17 19:27:14 -0600553 ProcessBindingBase(argc, argv, glslang::EResUbo);
steve-lunarg932bb5c2017-02-21 17:19:08 -0700554 } else if (lowerword == "shift-ssbo-bindings" || // synonyms
555 lowerword == "shift-ssbo-binding" ||
556 lowerword == "sbb") {
LoopDawg08a14422017-10-17 19:27:14 -0600557 ProcessBindingBase(argc, argv, glslang::EResSsbo);
John Kessenich6263fb12017-06-14 15:52:44 -0600558 } else if (lowerword == "source-entrypoint" || // synonyms
559 lowerword == "sep") {
John Kessenichc178f0a2017-06-23 10:58:31 -0600560 if (argc <= 1)
John Kessenich6263fb12017-06-14 15:52:44 -0600561 Error("no <entry-point> provided for --source-entrypoint");
John Kessenichc178f0a2017-06-23 10:58:31 -0600562 sourceEntryPointName = argv[1];
563 bumpArg();
John Kessenich6263fb12017-06-14 15:52:44 -0600564 break;
John Kesseniche2156222018-06-11 18:12:15 -0600565 } else if (lowerword == "spirv-dis") {
566 SpvToolsDisassembler = true;
John Kessenichc3404252018-08-23 15:29:08 -0600567 } else if (lowerword == "spirv-val") {
568 SpvToolsValidate = true;
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +0200569 } else if (lowerword == "stdin") {
570 Options |= EOptionStdin;
571 shaderStageName = argv[1];
John Kessenich2a271162017-07-20 20:00:36 -0600572 } else if (lowerword == "suppress-warnings") {
573 Options |= EOptionSuppressWarnings;
John Kessenich6353d552017-06-23 11:11:09 -0600574 } else if (lowerword == "target-env") {
575 if (argc > 1) {
576 if (strcmp(argv[1], "vulkan1.0") == 0) {
577 setVulkanSpv();
John Kessenich8717a5d2018-10-26 10:12:32 -0600578 ClientVersion = glslang::EShTargetVulkan_1_0;
John Kessenich66011cb2018-03-06 16:12:04 -0700579 } else if (strcmp(argv[1], "vulkan1.1") == 0) {
580 setVulkanSpv();
John Kessenich8717a5d2018-10-26 10:12:32 -0600581 ClientVersion = glslang::EShTargetVulkan_1_1;
John Kessenich6353d552017-06-23 11:11:09 -0600582 } else if (strcmp(argv[1], "opengl") == 0) {
583 setOpenGlSpv();
John Kessenich8717a5d2018-10-26 10:12:32 -0600584 ClientVersion = glslang::EShTargetOpenGL_450;
585 } else if (strcmp(argv[1], "spirv1.0") == 0) {
586 TargetLanguage = glslang::EShTargetSpv;
587 TargetVersion = glslang::EShTargetSpv_1_0;
588 } else if (strcmp(argv[1], "spirv1.1") == 0) {
589 TargetLanguage = glslang::EShTargetSpv;
590 TargetVersion = glslang::EShTargetSpv_1_1;
591 } else if (strcmp(argv[1], "spirv1.2") == 0) {
592 TargetLanguage = glslang::EShTargetSpv;
593 TargetVersion = glslang::EShTargetSpv_1_2;
594 } else if (strcmp(argv[1], "spirv1.3") == 0) {
595 TargetLanguage = glslang::EShTargetSpv;
596 TargetVersion = glslang::EShTargetSpv_1_3;
597 } else if (strcmp(argv[1], "spirv1.4") == 0) {
598 TargetLanguage = glslang::EShTargetSpv;
599 TargetVersion = glslang::EShTargetSpv_1_4;
John Kessenich6353d552017-06-23 11:11:09 -0600600 } else
John Kessenich8717a5d2018-10-26 10:12:32 -0600601 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 -0600602 }
603 bumpArg();
Flavio15017db2017-02-15 14:29:33 -0800604 } else if (lowerword == "variable-name" || // synonyms
John Kessenich66011cb2018-03-06 16:12:04 -0700605 lowerword == "vn") {
Flavio15017db2017-02-15 14:29:33 -0800606 Options |= EOptionOutputHexadecimal;
John Kessenichc178f0a2017-06-23 10:58:31 -0600607 if (argc <= 1)
Flavio15017db2017-02-15 14:29:33 -0800608 Error("no <C-variable-name> provided for --variable-name");
John Kessenichc178f0a2017-06-23 10:58:31 -0600609 variableName = argv[1];
610 bumpArg();
Flavio15017db2017-02-15 14:29:33 -0800611 break;
John Kessenichc6c80a62018-03-05 22:23:17 -0700612 } else if (lowerword == "version") {
613 Options |= EOptionDumpVersions;
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600614 } else {
615 usage();
616 }
617 }
618 break;
John Kessenich6263fb12017-06-14 15:52:44 -0600619 case 'C':
620 Options |= EOptionCascadingErrors;
621 break;
622 case 'D':
John Kessenicha9313662017-06-15 10:40:49 -0600623 if (argv[0][2] == 0)
624 Options |= EOptionReadHlsl;
625 else
626 UserPreamble.addDef(getStringOperand("-D<macro> macro name"));
John Kessenich6263fb12017-06-14 15:52:44 -0600627 break;
Neil Roberts16f53472018-03-20 17:30:53 +0100628 case 'u':
629 uniformLocationOverrides.push_back(getUniformOverride());
630 break;
John Kessenich6263fb12017-06-14 15:52:44 -0600631 case 'E':
632 Options |= EOptionOutputPreprocessed;
633 break;
634 case 'G':
John Kessenich8717a5d2018-10-26 10:12:32 -0600635 // OpenGL client
John Kessenich6353d552017-06-23 11:11:09 -0600636 setOpenGlSpv();
637 if (argv[0][2] != 0)
638 ClientInputSemanticsVersion = getAttachedNumber("-G<num> client input semantics");
John Kessenich6263fb12017-06-14 15:52:44 -0600639 break;
John Kessenich2aa7f3a2015-05-15 16:02:07 +0000640 case 'H':
641 Options |= EOptionHumanReadableSpv;
John Kessenich91e4aa52016-07-07 17:46:42 -0600642 if ((Options & EOptionSpv) == 0) {
643 // default to Vulkan
John Kessenich6353d552017-06-23 11:11:09 -0600644 setVulkanSpv();
John Kessenich91e4aa52016-07-07 17:46:42 -0600645 }
646 break;
John Kessenich971a0a82017-06-07 15:06:58 -0600647 case 'I':
John Kessenicha9313662017-06-15 10:40:49 -0600648 IncludeDirectoryList.push_back(getStringOperand("-I<dir> include path"));
John Kessenich68d78fd2015-07-12 19:28:10 -0600649 break;
GregFcd1f1692017-09-21 18:40:22 -0600650 case 'O':
651 if (argv[0][2] == 'd')
652 Options |= EOptionOptimizeDisable;
653 else if (argv[0][2] == 's')
GregFfb03a552018-03-29 11:49:14 -0600654#if ENABLE_OPT
GregFcd1f1692017-09-21 18:40:22 -0600655 Options |= EOptionOptimizeSize;
656#else
657 Error("-Os not available; optimizer not linked");
658#endif
659 else
660 Error("unknown -O option");
661 break;
Dan Baker5afdd782016-08-11 17:53:57 -0400662 case 'S':
John Kessenichc178f0a2017-06-23 10:58:31 -0600663 if (argc <= 1)
Dan Baker5afdd782016-08-11 17:53:57 -0400664 Error("no <stage> specified for -S");
John Kessenichc178f0a2017-06-23 10:58:31 -0600665 shaderStageName = argv[1];
666 bumpArg();
dankbaker45d49bc2016-08-08 21:43:07 -0400667 break;
John Kessenicha9313662017-06-15 10:40:49 -0600668 case 'U':
669 UserPreamble.addUndef(getStringOperand("-U<macro>: macro name"));
670 break;
John Kessenich6263fb12017-06-14 15:52:44 -0600671 case 'V':
John Kessenich6353d552017-06-23 11:11:09 -0600672 setVulkanSpv();
673 if (argv[0][2] != 0)
David Neto506d2c22018-02-27 21:55:23 -0500674 ClientInputSemanticsVersion = getAttachedNumber("-V<num> client input semantics");
John Kessenichc555ddd2015-06-17 02:38:44 +0000675 break;
John Kessenich05a70632013-09-17 19:26:08 +0000676 case 'c':
677 Options |= EOptionDumpConfig;
678 break;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000679 case 'd':
John Kessenichc6c80a62018-03-05 22:23:17 -0700680 if (strncmp(&argv[0][1], "dumpversion", strlen(&argv[0][1]) + 1) == 0 ||
681 strncmp(&argv[0][1], "dumpfullversion", strlen(&argv[0][1]) + 1) == 0)
682 Options |= EOptionDumpBareVersion;
683 else
684 Options |= EOptionDefaultDesktop;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000685 break;
John Kessenich4d65ee32016-03-12 18:17:47 -0700686 case 'e':
John Kessenich4d65ee32016-03-12 18:17:47 -0700687 entryPointName = argv[1];
John Kessenichc178f0a2017-06-23 10:58:31 -0600688 if (argc <= 1)
John Kessenicha25530c2017-09-11 20:13:49 -0600689 Error("no <name> provided for -e");
John Kessenichc178f0a2017-06-23 10:58:31 -0600690 bumpArg();
John Kessenich4d65ee32016-03-12 18:17:47 -0700691 break;
John Kessenich5d610ee2018-03-07 18:05:55 -0700692 case 'f':
693 if (strcmp(&argv[0][2], "hlsl_functionality1") == 0)
694 targetHlslFunctionality1 = true;
695 else
696 Error("-f: expected hlsl_functionality1");
697 break;
John Kessenich121853f2017-05-31 17:11:16 -0600698 case 'g':
699 Options |= EOptionDebug;
700 break;
John Kessenich68d78fd2015-07-12 19:28:10 -0600701 case 'h':
702 usage();
703 break;
John Kessenich05a70632013-09-17 19:26:08 +0000704 case 'i':
John Kessenich94a81fb2013-08-31 02:41:30 +0000705 Options |= EOptionIntermediate;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000706 break;
707 case 'l':
John Kessenichd78e3512014-08-25 20:07:55 +0000708 Options |= EOptionLinkProgram;
John Kessenich94a81fb2013-08-31 02:41:30 +0000709 break;
710 case 'm':
711 Options |= EOptionMemoryLeakMode;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000712 break;
John Kessenich68d78fd2015-07-12 19:28:10 -0600713 case 'o':
John Kessenichc178f0a2017-06-23 10:58:31 -0600714 if (argc <= 1)
John Kessenich68d78fd2015-07-12 19:28:10 -0600715 Error("no <file> provided for -o");
John Kessenichc178f0a2017-06-23 10:58:31 -0600716 binaryFileName = argv[1];
717 bumpArg();
John Kessenich68d78fd2015-07-12 19:28:10 -0600718 break;
John Kessenich11f9fc72013-11-07 01:06:34 +0000719 case 'q':
720 Options |= EOptionDumpReflection;
721 break;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000722 case 'r':
John Kessenich94a81fb2013-08-31 02:41:30 +0000723 Options |= EOptionRelaxedErrors;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000724 break;
725 case 's':
John Kessenich94a81fb2013-08-31 02:41:30 +0000726 Options |= EOptionSuppressInfolog;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000727 break;
John Kessenich38f3b892013-09-06 19:52:57 +0000728 case 't':
Juan Lopeza558b262017-04-02 23:04:00 +0200729 Options |= EOptionMultiThreaded;
John Kessenich38f3b892013-09-06 19:52:57 +0000730 break;
John Kessenich319de232013-12-04 04:43:40 +0000731 case 'v':
732 Options |= EOptionDumpVersions;
733 break;
John Kessenichb0a7eb52013-11-07 17:44:20 +0000734 case 'w':
735 Options |= EOptionSuppressWarnings;
736 break;
Johannes van Waverenecb0f3b2016-05-27 12:55:53 -0500737 case 'x':
738 Options |= EOptionOutputHexadecimal;
Johannes van Waverenecb0f3b2016-05-27 12:55:53 -0500739 break;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000740 default:
John Kessenich68d78fd2015-07-12 19:28:10 -0600741 usage();
742 break;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000743 }
John Kessenich38f3b892013-09-06 19:52:57 +0000744 } else {
John Kessenich05a70632013-09-17 19:26:08 +0000745 std::string name(argv[0]);
746 if (! SetConfigFile(name)) {
Juan Lopeza558b262017-04-02 23:04:00 +0200747 workItems.push_back(std::unique_ptr<glslang::TWorkItem>(new glslang::TWorkItem(name)));
John Kessenich05a70632013-09-17 19:26:08 +0000748 }
John Kessenich38f3b892013-09-06 19:52:57 +0000749 }
John Kessenich2b07c7e2013-07-31 18:44:13 +0000750 }
751
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +0200752 // Make sure that -S is always specified if --stdin is specified
753 if ((Options & EOptionStdin) && shaderStageName == nullptr)
754 Error("must provide -S when --stdin is given");
755
John Kessenich68d78fd2015-07-12 19:28:10 -0600756 // Make sure that -E is not specified alongside linking (which includes SPV generation)
757 if ((Options & EOptionOutputPreprocessed) && (Options & EOptionLinkProgram))
758 Error("can't use -E when linking is selected");
John Kessenichc555ddd2015-06-17 02:38:44 +0000759
Johannes van Waverenecb0f3b2016-05-27 12:55:53 -0500760 // -o or -x makes no sense if there is no target binary
John Kessenich68d78fd2015-07-12 19:28:10 -0600761 if (binaryFileName && (Options & EOptionSpv) == 0)
762 Error("no binary generation requested (e.g., -V)");
steve-lunarge0b9deb2016-09-16 13:26:37 -0600763
764 if ((Options & EOptionFlattenUniformArrays) != 0 &&
765 (Options & EOptionReadHlsl) == 0)
766 Error("uniform array flattening only valid when compiling HLSL source.");
John Kessenich8717a5d2018-10-26 10:12:32 -0600767
768 // rationalize client and target language
769 if (TargetLanguage == glslang::EShTargetNone) {
770 switch (ClientVersion) {
771 case glslang::EShTargetVulkan_1_0:
772 TargetLanguage = glslang::EShTargetSpv;
773 TargetVersion = glslang::EShTargetSpv_1_0;
774 break;
775 case glslang::EShTargetVulkan_1_1:
776 TargetLanguage = glslang::EShTargetSpv;
777 TargetVersion = glslang::EShTargetSpv_1_3;
778 break;
779 case glslang::EShTargetOpenGL_450:
780 TargetLanguage = glslang::EShTargetSpv;
781 TargetVersion = glslang::EShTargetSpv_1_0;
782 break;
783 default:
784 break;
785 }
786 }
787 if (TargetLanguage != glslang::EShTargetNone && Client == glslang::EShClientNone)
788 Error("To generate SPIR-V, also specify client semantics. See -G and -V.");
John Kessenich2b07c7e2013-07-31 18:44:13 +0000789}
790
John Kessenich68d78fd2015-07-12 19:28:10 -0600791//
792// Translate the meaningful subset of command-line options to parser-behavior options.
793//
John Kessenichb0a7eb52013-11-07 17:44:20 +0000794void SetMessageOptions(EShMessages& messages)
795{
796 if (Options & EOptionRelaxedErrors)
797 messages = (EShMessages)(messages | EShMsgRelaxedErrors);
798 if (Options & EOptionIntermediate)
799 messages = (EShMessages)(messages | EShMsgAST);
800 if (Options & EOptionSuppressWarnings)
801 messages = (EShMessages)(messages | EShMsgSuppressWarnings);
John Kessenich68d78fd2015-07-12 19:28:10 -0600802 if (Options & EOptionSpv)
803 messages = (EShMessages)(messages | EShMsgSpvRules);
804 if (Options & EOptionVulkanRules)
805 messages = (EShMessages)(messages | EShMsgVulkanRules);
Andrew Woloszynaae1ad82015-06-24 17:00:46 -0400806 if (Options & EOptionOutputPreprocessed)
807 messages = (EShMessages)(messages | EShMsgOnlyPreprocessor);
John Kessenich66e2faf2016-03-12 18:34:36 -0700808 if (Options & EOptionReadHlsl)
809 messages = (EShMessages)(messages | EShMsgReadHlsl);
John Kessenicha86836e2016-07-09 14:50:57 -0600810 if (Options & EOptionCascadingErrors)
811 messages = (EShMessages)(messages | EShMsgCascadingErrors);
John Kessenich906cc212016-12-09 19:22:20 -0700812 if (Options & EOptionKeepUncalled)
813 messages = (EShMessages)(messages | EShMsgKeepUncalled);
John Kessenich4f1403e2017-04-05 17:38:20 -0600814 if (Options & EOptionHlslOffsets)
815 messages = (EShMessages)(messages | EShMsgHlslOffsets);
John Kessenich121853f2017-05-31 17:11:16 -0600816 if (Options & EOptionDebug)
817 messages = (EShMessages)(messages | EShMsgDebugInfo);
Rex Xucb61eec2018-03-07 13:10:01 +0800818 if (HlslEnable16BitTypes)
819 messages = (EShMessages)(messages | EShMsgHlslEnable16BitTypes);
GregFfb03a552018-03-29 11:49:14 -0600820 if ((Options & EOptionOptimizeDisable) || !ENABLE_OPT)
821 messages = (EShMessages)(messages | EShMsgHlslLegalization);
John Kessenichbd1c1832018-12-07 18:38:26 -0700822 if (HlslDX9compatible)
823 messages = (EShMessages)(messages | EShMsgHlslDX9Compatible);
John Kessenichb0a7eb52013-11-07 17:44:20 +0000824}
825
John Kessenich68d78fd2015-07-12 19:28:10 -0600826//
John Kessenich69f4b512013-09-04 21:19:27 +0000827// Thread entry point, for non-linking asynchronous mode.
John Kessenichc999ba22013-11-07 23:33:24 +0000828//
Juan Lopeza558b262017-04-02 23:04:00 +0200829void CompileShaders(glslang::TWorklist& worklist)
John Kessenich2b07c7e2013-07-31 18:44:13 +0000830{
John Kessenich7f0bcfd2018-04-05 19:00:01 -0600831 if (Options & EOptionDebug)
832 Error("cannot generate debug information unless linking to generate code");
833
John Kessenich38f3b892013-09-06 19:52:57 +0000834 glslang::TWorkItem* workItem;
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +0200835 if (Options & EOptionStdin) {
John Kesseniche7f9cae2018-07-12 15:11:07 -0600836 if (worklist.remove(workItem)) {
837 ShHandle compiler = ShConstructCompiler(FindLanguage("stdin"), Options);
838 if (compiler == nullptr)
839 return;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000840
John Kesseniche7f9cae2018-07-12 15:11:07 -0600841 CompileFile("stdin", compiler);
John Kessenich2b07c7e2013-07-31 18:44:13 +0000842
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +0200843 if (! (Options & EOptionSuppressInfolog))
844 workItem->results = ShGetInfoLog(compiler);
John Kessenich2b07c7e2013-07-31 18:44:13 +0000845
John Kesseniche7f9cae2018-07-12 15:11:07 -0600846 ShDestruct(compiler);
847 }
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +0200848 } else {
849 while (worklist.remove(workItem)) {
850 ShHandle compiler = ShConstructCompiler(FindLanguage(workItem->name), Options);
851 if (compiler == 0)
852 return;
853
854 CompileFile(workItem->name.c_str(), compiler);
855
856 if (! (Options & EOptionSuppressInfolog))
857 workItem->results = ShGetInfoLog(compiler);
858
859 ShDestruct(compiler);
860 }
John Kessenich2b07c7e2013-07-31 18:44:13 +0000861 }
John Kessenich2b07c7e2013-07-31 18:44:13 +0000862}
863
John Kessenich6626cad2015-06-19 05:14:19 +0000864// Outputs the given string, but only if it is non-null and non-empty.
865// This prevents erroneous newlines from appearing.
Andrew Woloszynaae1ad82015-06-24 17:00:46 -0400866void PutsIfNonEmpty(const char* str)
John Kessenich6626cad2015-06-19 05:14:19 +0000867{
868 if (str && str[0]) {
869 puts(str);
870 }
871}
872
Andrew Woloszynaae1ad82015-06-24 17:00:46 -0400873// Outputs the given string to stderr, but only if it is non-null and non-empty.
874// This prevents erroneous newlines from appearing.
875void StderrIfNonEmpty(const char* str)
876{
John Kessenich04acb1b2017-06-14 17:36:50 -0600877 if (str && str[0])
878 fprintf(stderr, "%s\n", str);
Andrew Woloszynaae1ad82015-06-24 17:00:46 -0400879}
880
John Kessenichc57b2a92016-01-16 15:30:03 -0700881// Simple bundling of what makes a compilation unit for ease in passing around,
882// and separation of handling file IO versus API (programmatic) compilation.
883struct ShaderCompUnit {
884 EShLanguage stage;
John Kessenich04acb1b2017-06-14 17:36:50 -0600885 static const int maxCount = 1;
886 int count; // live number of strings/names
John Kessenicha9313662017-06-15 10:40:49 -0600887 const char* text[maxCount]; // memory owned/managed externally
John Kessenich04acb1b2017-06-14 17:36:50 -0600888 std::string fileName[maxCount]; // hold's the memory, but...
889 const char* fileNameList[maxCount]; // downstream interface wants pointers
dankbakerafe6e9c2016-08-21 12:29:08 -0400890
John Kessenich04acb1b2017-06-14 17:36:50 -0600891 ShaderCompUnit(EShLanguage stage) : stage(stage), count(0) { }
dankbakerafe6e9c2016-08-21 12:29:08 -0400892
John Kessenich04acb1b2017-06-14 17:36:50 -0600893 ShaderCompUnit(const ShaderCompUnit& rhs)
dankbakerafe6e9c2016-08-21 12:29:08 -0400894 {
895 stage = rhs.stage;
John Kessenich04acb1b2017-06-14 17:36:50 -0600896 count = rhs.count;
897 for (int i = 0; i < count; ++i) {
898 fileName[i] = rhs.fileName[i];
899 text[i] = rhs.text[i];
900 fileNameList[i] = rhs.fileName[i].c_str();
901 }
dankbakerafe6e9c2016-08-21 12:29:08 -0400902 }
903
John Kessenicha9313662017-06-15 10:40:49 -0600904 void addString(std::string& ifileName, const char* itext)
John Kessenich04acb1b2017-06-14 17:36:50 -0600905 {
906 assert(count < maxCount);
907 fileName[count] = ifileName;
908 text[count] = itext;
909 fileNameList[count] = fileName[count].c_str();
910 ++count;
911 }
John Kessenichc57b2a92016-01-16 15:30:03 -0700912};
913
John Kessenich69f4b512013-09-04 21:19:27 +0000914//
John Kessenichc57b2a92016-01-16 15:30:03 -0700915// For linking mode: Will independently parse each compilation unit, but then put them
916// in the same program and link them together, making at most one linked module per
917// pipeline stage.
John Kessenich69f4b512013-09-04 21:19:27 +0000918//
919// Uses the new C++ interface instead of the old handle-based interface.
920//
John Kessenichc57b2a92016-01-16 15:30:03 -0700921
922void CompileAndLinkShaderUnits(std::vector<ShaderCompUnit> compUnits)
John Kessenich69f4b512013-09-04 21:19:27 +0000923{
924 // keep track of what to free
925 std::list<glslang::TShader*> shaders;
John Kessenichc57b2a92016-01-16 15:30:03 -0700926
John Kessenich69f4b512013-09-04 21:19:27 +0000927 EShMessages messages = EShMsgDefault;
John Kessenichb0a7eb52013-11-07 17:44:20 +0000928 SetMessageOptions(messages);
John Kessenich69f4b512013-09-04 21:19:27 +0000929
John Kessenich69f4b512013-09-04 21:19:27 +0000930 //
931 // Per-shader processing...
932 //
933
John Kessenich5b0f13a2013-11-01 03:08:40 +0000934 glslang::TProgram& program = *new glslang::TProgram;
rdb32084e82016-02-23 22:17:38 +0100935 for (auto it = compUnits.cbegin(); it != compUnits.cend(); ++it) {
936 const auto &compUnit = *it;
John Kessenichc57b2a92016-01-16 15:30:03 -0700937 glslang::TShader* shader = new glslang::TShader(compUnit.stage);
John Kessenich04acb1b2017-06-14 17:36:50 -0600938 shader->setStringsWithLengthsAndNames(compUnit.text, NULL, compUnit.fileNameList, compUnit.count);
John Kessenich640bd092018-08-09 14:15:00 -0600939 if (entryPointName)
John Kessenich4d65ee32016-03-12 18:17:47 -0700940 shader->setEntryPoint(entryPointName);
John Kessenich3693e632017-09-29 17:51:52 -0600941 if (sourceEntryPointName) {
942 if (entryPointName == nullptr)
943 printf("Warning: Changing source entry point name without setting an entry-point name.\n"
944 "Use '-e <name>'.\n");
steve-lunargf1e0c872016-10-31 15:13:43 -0600945 shader->setSourceEntryPoint(sourceEntryPointName);
John Kessenich3693e632017-09-29 17:51:52 -0600946 }
John Kessenicha9313662017-06-15 10:40:49 -0600947 if (UserPreamble.isSet())
948 shader->setPreamble(UserPreamble.get());
John Kessenich2a271162017-07-20 20:00:36 -0600949 shader->addProcesses(Processes);
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600950
LoopDawg08a14422017-10-17 19:27:14 -0600951 // Set IO mapper binding shift values
952 for (int r = 0; r < glslang::EResCount; ++r) {
953 const glslang::TResourceType res = glslang::TResourceType(r);
954
955 // Set base bindings
956 shader->setShiftBinding(res, baseBinding[res][compUnit.stage]);
957
958 // Set bindings for particular resource sets
959 // TODO: use a range based for loop here, when available in all environments.
960 for (auto i = baseBindingForSet[res][compUnit.stage].begin();
961 i != baseBindingForSet[res][compUnit.stage].end(); ++i)
LoopDawge5709552017-10-21 10:46:39 -0600962 shader->setShiftBindingForSet(res, i->second, i->first);
LoopDawg08a14422017-10-17 19:27:14 -0600963 }
964
steve-lunarge0b9deb2016-09-16 13:26:37 -0600965 shader->setFlattenUniformArrays((Options & EOptionFlattenUniformArrays) != 0);
steve-lunargcce8d482016-10-14 18:36:42 -0600966 shader->setNoStorageFormat((Options & EOptionNoStorageFormat) != 0);
Hyangran Park36dc8292017-05-02 16:27:29 +0900967 shader->setResourceSetBinding(baseResourceSetBinding[compUnit.stage]);
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600968
steve-lunargbe283552017-04-18 12:18:01 -0600969 if (Options & EOptionHlslIoMapping)
970 shader->setHlslIoMapping(true);
971
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600972 if (Options & EOptionAutoMapBindings)
973 shader->setAutoMapBindings(true);
John Kessenichecba76f2017-01-06 00:34:48 -0700974
John Kessenich71facdf2017-05-17 18:28:19 -0600975 if (Options & EOptionAutoMapLocations)
976 shader->setAutoMapLocations(true);
977
LoopDawgb22c0692017-12-06 16:52:03 -0700978 if (Options & EOptionInvertY)
979 shader->setInvertY(true);
980
Neil Roberts16f53472018-03-20 17:30:53 +0100981 for (auto& uniOverride : uniformLocationOverrides) {
982 shader->addUniformLocationOverride(uniOverride.first.c_str(),
983 uniOverride.second);
984 }
985
Neil Robertsb0f3d792018-03-20 17:41:05 +0100986 shader->setUniformLocationBase(uniformBase);
987
John Kessenich4be4aeb2017-06-23 10:50:22 -0600988 // Set up the environment, some subsettings take precedence over earlier
989 // ways of setting things.
990 if (Options & EOptionSpv) {
John Kessenich8717a5d2018-10-26 10:12:32 -0600991 shader->setEnvInput((Options & EOptionReadHlsl) ? glslang::EShSourceHlsl
992 : glslang::EShSourceGlsl,
993 compUnit.stage, Client, ClientInputSemanticsVersion);
994 shader->setEnvClient(Client, ClientVersion);
995 shader->setEnvTarget(TargetLanguage, TargetVersion);
John Kessenich5d610ee2018-03-07 18:05:55 -0700996 if (targetHlslFunctionality1)
997 shader->setEnvTargetHlslFunctionality1();
John Kessenich4be4aeb2017-06-23 10:50:22 -0600998 }
999
John Kessenich69f4b512013-09-04 21:19:27 +00001000 shaders.push_back(shader);
John Kessenichb3297152015-07-11 18:01:03 -06001001
John Kessenich4be4aeb2017-06-23 10:50:22 -06001002 const int defaultVersion = Options & EOptionDefaultDesktop ? 110 : 100;
John Kessenich69f4b512013-09-04 21:19:27 +00001003
John Kessenich3494b4d2017-05-22 15:00:42 -06001004 DirStackFileIncluder includer;
John Kessenich971a0a82017-06-07 15:06:58 -06001005 std::for_each(IncludeDirectoryList.rbegin(), IncludeDirectoryList.rend(), [&includer](const std::string& dir) {
1006 includer.pushExternalLocalDirectory(dir); });
John Kessenichc555ddd2015-06-17 02:38:44 +00001007 if (Options & EOptionOutputPreprocessed) {
1008 std::string str;
John Kessenich086febc2018-10-25 12:43:02 -06001009 if (shader->preprocess(&Resources, defaultVersion, ENoProfile, false, false, messages, &str, includer)) {
Andrew Woloszynaae1ad82015-06-24 17:00:46 -04001010 PutsIfNonEmpty(str.c_str());
1011 } else {
1012 CompileFailed = true;
1013 }
1014 StderrIfNonEmpty(shader->getInfoLog());
1015 StderrIfNonEmpty(shader->getInfoDebugLog());
John Kessenichc555ddd2015-06-17 02:38:44 +00001016 continue;
1017 }
John Kessenich086febc2018-10-25 12:43:02 -06001018
John Kessenich3494b4d2017-05-22 15:00:42 -06001019 if (! shader->parse(&Resources, defaultVersion, false, messages, includer))
John Kessenichc999ba22013-11-07 23:33:24 +00001020 CompileFailed = true;
John Kessenichc555ddd2015-06-17 02:38:44 +00001021
John Kessenich69f4b512013-09-04 21:19:27 +00001022 program.addShader(shader);
1023
John Kessenichc57b2a92016-01-16 15:30:03 -07001024 if (! (Options & EOptionSuppressInfolog) &&
1025 ! (Options & EOptionMemoryLeakMode)) {
John Kessenich04acb1b2017-06-14 17:36:50 -06001026 PutsIfNonEmpty(compUnit.fileName[0].c_str());
Andrew Woloszynaae1ad82015-06-24 17:00:46 -04001027 PutsIfNonEmpty(shader->getInfoLog());
1028 PutsIfNonEmpty(shader->getInfoDebugLog());
John Kessenich69f4b512013-09-04 21:19:27 +00001029 }
John Kessenich69f4b512013-09-04 21:19:27 +00001030 }
1031
1032 //
1033 // Program-level processing...
1034 //
1035
John Kessenich4d65ee32016-03-12 18:17:47 -07001036 // Link
John Kessenich68d78fd2015-07-12 19:28:10 -06001037 if (! (Options & EOptionOutputPreprocessed) && ! program.link(messages))
John Kessenichc999ba22013-11-07 23:33:24 +00001038 LinkFailed = true;
1039
steve-lunarg9ae34742016-10-05 13:40:13 -06001040 // Map IO
1041 if (Options & EOptionSpv) {
1042 if (!program.mapIO())
1043 LinkFailed = true;
1044 }
John Kessenichecba76f2017-01-06 00:34:48 -07001045
John Kessenich4d65ee32016-03-12 18:17:47 -07001046 // Report
John Kessenichc57b2a92016-01-16 15:30:03 -07001047 if (! (Options & EOptionSuppressInfolog) &&
1048 ! (Options & EOptionMemoryLeakMode)) {
Andrew Woloszynaae1ad82015-06-24 17:00:46 -04001049 PutsIfNonEmpty(program.getInfoLog());
1050 PutsIfNonEmpty(program.getInfoDebugLog());
John Kessenich69f4b512013-09-04 21:19:27 +00001051 }
1052
John Kessenich4d65ee32016-03-12 18:17:47 -07001053 // Reflect
John Kessenich11f9fc72013-11-07 01:06:34 +00001054 if (Options & EOptionDumpReflection) {
baldurk6d477852019-01-29 15:45:56 +00001055 program.buildReflection(ReflectOptions);
John Kessenich11f9fc72013-11-07 01:06:34 +00001056 program.dumpReflection();
1057 }
1058
John Kessenich4d65ee32016-03-12 18:17:47 -07001059 // Dump SPIR-V
John Kessenich0df0cde2015-03-03 17:09:43 +00001060 if (Options & EOptionSpv) {
John Kessenich92f90382014-07-28 04:21:04 +00001061 if (CompileFailed || LinkFailed)
John Kessenich68d78fd2015-07-12 19:28:10 -06001062 printf("SPIR-V is not generated for failed compile or link\n");
John Kessenich92f90382014-07-28 04:21:04 +00001063 else {
1064 for (int stage = 0; stage < EShLangCount; ++stage) {
John Kessenicha7a68a92014-08-24 18:21:00 +00001065 if (program.getIntermediate((EShLanguage)stage)) {
John Kessenich0df0cde2015-03-03 17:09:43 +00001066 std::vector<unsigned int> spirv;
Lei Zhang09caf122016-05-02 18:11:54 -04001067 std::string warningsErrors;
Lei Zhang17535f72016-05-04 15:55:59 -04001068 spv::SpvBuildLogger logger;
John Kessenich121853f2017-05-31 17:11:16 -06001069 glslang::SpvOptions spvOptions;
1070 if (Options & EOptionDebug)
1071 spvOptions.generateDebugInfo = true;
GregF52fe3d52017-09-28 10:08:32 -06001072 spvOptions.disableOptimizer = (Options & EOptionOptimizeDisable) != 0;
1073 spvOptions.optimizeSize = (Options & EOptionOptimizeSize) != 0;
John Kessenich717c80a2018-08-23 15:17:10 -06001074 spvOptions.disassemble = SpvToolsDisassembler;
John Kessenichc3404252018-08-23 15:29:08 -06001075 spvOptions.validate = SpvToolsValidate;
John Kessenich121853f2017-05-31 17:11:16 -06001076 glslang::GlslangToSpv(*program.getIntermediate((EShLanguage)stage), spirv, &logger, &spvOptions);
John Kessenichc57b2a92016-01-16 15:30:03 -07001077
1078 // Dump the spv to a file or stdout, etc., but only if not doing
1079 // memory/perf testing, as it's not internal to programmatic use.
1080 if (! (Options & EOptionMemoryLeakMode)) {
Johannes van Waverenecb0f3b2016-05-27 12:55:53 -05001081 printf("%s", logger.getAllMessages().c_str());
1082 if (Options & EOptionOutputHexadecimal) {
John Kessenich8f674e82017-02-18 09:45:40 -07001083 glslang::OutputSpvHex(spirv, GetBinaryName((EShLanguage)stage), variableName);
Johannes van Waverenecb0f3b2016-05-27 12:55:53 -05001084 } else {
1085 glslang::OutputSpvBin(spirv, GetBinaryName((EShLanguage)stage));
1086 }
John Kesseniche2156222018-06-11 18:12:15 -06001087 if (!SpvToolsDisassembler && (Options & EOptionHumanReadableSpv))
John Kessenichc57b2a92016-01-16 15:30:03 -07001088 spv::Disassemble(std::cout, spirv);
John Kessenichacba7722015-03-04 03:48:38 +00001089 }
John Kessenicha7a68a92014-08-24 18:21:00 +00001090 }
John Kessenich92f90382014-07-28 04:21:04 +00001091 }
1092 }
1093 }
1094
John Kessenich5b0f13a2013-11-01 03:08:40 +00001095 // Free everything up, program has to go before the shaders
1096 // because it might have merged stuff from the shaders, and
1097 // the stuff from the shaders has to have its destructors called
1098 // before the pools holding the memory in the shaders is freed.
1099 delete &program;
John Kessenich69f4b512013-09-04 21:19:27 +00001100 while (shaders.size() > 0) {
1101 delete shaders.back();
1102 shaders.pop_back();
1103 }
John Kessenich69f4b512013-09-04 21:19:27 +00001104}
1105
John Kessenichc57b2a92016-01-16 15:30:03 -07001106//
1107// Do file IO part of compile and link, handing off the pure
1108// API/programmatic mode to CompileAndLinkShaderUnits(), which can
1109// be put in a loop for testing memory footprint and performance.
1110//
1111// This is just for linking mode: meaning all the shaders will be put into the
1112// the same program linked together.
1113//
1114// This means there are a limited number of work items (not multi-threading mode)
1115// and that the point is testing at the linking level. Hence, to enable
1116// performance and memory testing, the actual compile/link can be put in
1117// a loop, independent of processing the work items and file IO.
1118//
Juan Lopeza558b262017-04-02 23:04:00 +02001119void CompileAndLinkShaderFiles(glslang::TWorklist& Worklist)
John Kessenichc57b2a92016-01-16 15:30:03 -07001120{
1121 std::vector<ShaderCompUnit> compUnits;
1122
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001123 // If this is using stdin, we can't really detect multiple different file
1124 // units by input type. We need to assume that we're just being given one
1125 // file of a certain type.
1126 if ((Options & EOptionStdin) != 0) {
1127 ShaderCompUnit compUnit(FindLanguage("stdin"));
1128 std::istreambuf_iterator<char> begin(std::cin), end;
1129 std::string tempString(begin, end);
1130 char* fileText = strdup(tempString.c_str());
1131 std::string fileName = "stdin";
1132 compUnit.addString(fileName, fileText);
John Kessenichc57b2a92016-01-16 15:30:03 -07001133 compUnits.push_back(compUnit);
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001134 } else {
1135 // Transfer all the work items from to a simple list of
1136 // of compilation units. (We don't care about the thread
1137 // work-item distribution properties in this path, which
1138 // is okay due to the limited number of shaders, know since
1139 // they are all getting linked together.)
1140 glslang::TWorkItem* workItem;
1141 while (Worklist.remove(workItem)) {
1142 ShaderCompUnit compUnit(FindLanguage(workItem->name));
1143 char* fileText = ReadFileData(workItem->name.c_str());
1144 if (fileText == nullptr)
1145 usage();
1146 compUnit.addString(workItem->name, fileText);
1147 compUnits.push_back(compUnit);
1148 }
John Kessenichc57b2a92016-01-16 15:30:03 -07001149 }
1150
1151 // Actual call to programmatic processing of compile and link,
1152 // in a loop for testing memory and performance. This part contains
1153 // all the perf/memory that a programmatic consumer will care about.
1154 for (int i = 0; i < ((Options & EOptionMemoryLeakMode) ? 100 : 1); ++i) {
1155 for (int j = 0; j < ((Options & EOptionMemoryLeakMode) ? 100 : 1); ++j)
1156 CompileAndLinkShaderUnits(compUnits);
1157
1158 if (Options & EOptionMemoryLeakMode)
1159 glslang::OS_DumpMemoryCounters();
1160 }
1161
John Kessenicha9313662017-06-15 10:40:49 -06001162 // free memory from ReadFileData, which got stored in a const char*
1163 // as the first string above
rdb32084e82016-02-23 22:17:38 +01001164 for (auto it = compUnits.begin(); it != compUnits.end(); ++it)
John Kessenicha9313662017-06-15 10:40:49 -06001165 FreeFileData(const_cast<char*>(it->text[0]));
John Kessenichc57b2a92016-01-16 15:30:03 -07001166}
1167
John Kessenich94f28eb2017-11-13 01:32:06 -07001168int singleMain()
John Kessenicha0af4732012-12-12 21:15:54 +00001169{
Juan Lopeza558b262017-04-02 23:04:00 +02001170 glslang::TWorklist workList;
John Kessenich94f28eb2017-11-13 01:32:06 -07001171 std::for_each(WorkItems.begin(), WorkItems.end(), [&workList](std::unique_ptr<glslang::TWorkItem>& item) {
Juan Lopeza558b262017-04-02 23:04:00 +02001172 assert(item);
1173 workList.add(item.get());
1174 });
John Kessenich2b07c7e2013-07-31 18:44:13 +00001175
John Kessenich05a70632013-09-17 19:26:08 +00001176 if (Options & EOptionDumpConfig) {
Lei Zhang414eb602016-03-04 16:22:34 -05001177 printf("%s", glslang::GetDefaultTBuiltInResourceString().c_str());
Juan Lopeza558b262017-04-02 23:04:00 +02001178 if (workList.empty())
John Kessenich05a70632013-09-17 19:26:08 +00001179 return ESuccess;
1180 }
1181
John Kessenichc6c80a62018-03-05 22:23:17 -07001182 if (Options & EOptionDumpBareVersion) {
1183 printf("%d.%d.%d\n",
1184 glslang::GetSpirvGeneratorVersion(), GLSLANG_MINOR_VERSION, GLSLANG_PATCH_LEVEL);
1185 if (workList.empty())
1186 return ESuccess;
1187 } else if (Options & EOptionDumpVersions) {
1188 printf("Glslang Version: %d.%d.%d\n",
1189 glslang::GetSpirvGeneratorVersion(), GLSLANG_MINOR_VERSION, GLSLANG_PATCH_LEVEL);
John Kessenich319de232013-12-04 04:43:40 +00001190 printf("ESSL Version: %s\n", glslang::GetEsslVersionString());
1191 printf("GLSL Version: %s\n", glslang::GetGlslVersionString());
John Kessenich68d78fd2015-07-12 19:28:10 -06001192 std::string spirvVersion;
1193 glslang::GetSpirvVersion(spirvVersion);
John Kessenich0da9eaa2015-08-01 17:10:02 -06001194 printf("SPIR-V Version %s\n", spirvVersion.c_str());
John Kessenich5e4b1242015-08-06 22:53:06 -06001195 printf("GLSL.std.450 Version %d, Revision %d\n", GLSLstd450Version, GLSLstd450Revision);
John Kessenich55e7d112015-11-15 21:33:39 -07001196 printf("Khronos Tool ID %d\n", glslang::GetKhronosToolId());
John Kessenicha372a3e2017-11-02 22:32:14 -06001197 printf("SPIR-V Generator Version %d\n", glslang::GetSpirvGeneratorVersion());
John Kessenichb84313d2016-07-20 16:03:29 -06001198 printf("GL_KHR_vulkan_glsl version %d\n", 100);
1199 printf("ARB_GL_gl_spirv version %d\n", 100);
Juan Lopeza558b262017-04-02 23:04:00 +02001200 if (workList.empty())
John Kessenich319de232013-12-04 04:43:40 +00001201 return ESuccess;
1202 }
1203
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001204 if (workList.empty() && ((Options & EOptionStdin) == 0)) {
John Kessenich05a70632013-09-17 19:26:08 +00001205 usage();
John Kessenich05a70632013-09-17 19:26:08 +00001206 }
1207
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001208 if (Options & EOptionStdin) {
John Kessenich94f28eb2017-11-13 01:32:06 -07001209 WorkItems.push_back(std::unique_ptr<glslang::TWorkItem>{new glslang::TWorkItem("stdin")});
1210 workList.add(WorkItems.back().get());
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001211 }
1212
John Kessenich05a70632013-09-17 19:26:08 +00001213 ProcessConfigFile();
1214
John Kessenich086febc2018-10-25 12:43:02 -06001215 if ((Options & EOptionReadHlsl) && !((Options & EOptionOutputPreprocessed) || (Options & EOptionSpv)))
1216 Error("ERROR: HLSL requires SPIR-V code generation (or preprocessing only)");
1217
John Kessenich69f4b512013-09-04 21:19:27 +00001218 //
1219 // Two modes:
John Kessenich38f3b892013-09-06 19:52:57 +00001220 // 1) linking all arguments together, single-threaded, new C++ interface
1221 // 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 +00001222 //
John Kessenich086febc2018-10-25 12:43:02 -06001223 if (Options & (EOptionLinkProgram | EOptionOutputPreprocessed)) {
John Kessenichc36e1d82013-11-01 17:41:52 +00001224 glslang::InitializeProcess();
John Kesseniche2c15b42017-11-16 22:48:41 -07001225 glslang::InitializeProcess(); // also test reference counting of users
1226 glslang::InitializeProcess(); // also test reference counting of users
1227 glslang::FinalizeProcess(); // also test reference counting of users
1228 glslang::FinalizeProcess(); // also test reference counting of users
Juan Lopeza558b262017-04-02 23:04:00 +02001229 CompileAndLinkShaderFiles(workList);
John Kessenichc36e1d82013-11-01 17:41:52 +00001230 glslang::FinalizeProcess();
1231 } else {
1232 ShInitialize();
John Kesseniche2c15b42017-11-16 22:48:41 -07001233 ShInitialize(); // also test reference counting of users
1234 ShFinalize(); // also test reference counting of users
John Kessenichc36e1d82013-11-01 17:41:52 +00001235
Juan Lopeza558b262017-04-02 23:04:00 +02001236 bool printShaderNames = workList.size() > 1;
John Kessenich69f4b512013-09-04 21:19:27 +00001237
John Kesseniche2c15b42017-11-16 22:48:41 -07001238 if (Options & EOptionMultiThreaded) {
Juan Lopeza558b262017-04-02 23:04:00 +02001239 std::array<std::thread, 16> threads;
John Kesseniche2c15b42017-11-16 22:48:41 -07001240 for (unsigned int t = 0; t < threads.size(); ++t) {
Juan Lopeza558b262017-04-02 23:04:00 +02001241 threads[t] = std::thread(CompileShaders, std::ref(workList));
John Kesseniche2c15b42017-11-16 22:48:41 -07001242 if (threads[t].get_id() == std::thread::id()) {
John Kessenichaf527992017-11-02 22:48:15 -06001243 fprintf(stderr, "Failed to create thread\n");
John Kessenich38f3b892013-09-06 19:52:57 +00001244 return EFailThreadCreate;
1245 }
John Kessenicha0af4732012-12-12 21:15:54 +00001246 }
Juan Lopeza558b262017-04-02 23:04:00 +02001247
1248 std::for_each(threads.begin(), threads.end(), [](std::thread& t) { t.join(); });
John Kessenichc999ba22013-11-07 23:33:24 +00001249 } else
Juan Lopeza558b262017-04-02 23:04:00 +02001250 CompileShaders(workList);
John Kessenich38f3b892013-09-06 19:52:57 +00001251
1252 // Print out all the resulting infologs
John Kessenich94f28eb2017-11-13 01:32:06 -07001253 for (size_t w = 0; w < WorkItems.size(); ++w) {
1254 if (WorkItems[w]) {
1255 if (printShaderNames || WorkItems[w]->results.size() > 0)
1256 PutsIfNonEmpty(WorkItems[w]->name.c_str());
1257 PutsIfNonEmpty(WorkItems[w]->results.c_str());
John Kessenich38f3b892013-09-06 19:52:57 +00001258 }
1259 }
John Kessenichc36e1d82013-11-01 17:41:52 +00001260
1261 ShFinalize();
John Kessenicha0af4732012-12-12 21:15:54 +00001262 }
John Kessenich2b07c7e2013-07-31 18:44:13 +00001263
John Kessenichc999ba22013-11-07 23:33:24 +00001264 if (CompileFailed)
John Kessenicha0af4732012-12-12 21:15:54 +00001265 return EFailCompile;
John Kessenichc999ba22013-11-07 23:33:24 +00001266 if (LinkFailed)
John Kessenicha0af4732012-12-12 21:15:54 +00001267 return EFailLink;
1268
1269 return 0;
1270}
1271
John Kessenich94f28eb2017-11-13 01:32:06 -07001272int C_DECL main(int argc, char* argv[])
1273{
1274 ProcessArguments(WorkItems, argc, argv);
1275
1276 int ret = 0;
1277
1278 // Loop over the entire init/finalize cycle to watch memory changes
1279 const int iterations = 1;
1280 if (iterations > 1)
1281 glslang::OS_DumpMemoryCounters();
1282 for (int i = 0; i < iterations; ++i) {
1283 ret = singleMain();
1284 if (iterations > 1)
1285 glslang::OS_DumpMemoryCounters();
1286 }
1287
1288 return ret;
1289}
1290
John Kessenicha0af4732012-12-12 21:15:54 +00001291//
1292// Deduce the language from the filename. Files must end in one of the
1293// following extensions:
1294//
John Kessenich2b07c7e2013-07-31 18:44:13 +00001295// .vert = vertex
1296// .tesc = tessellation control
1297// .tese = tessellation evaluation
1298// .geom = geometry
1299// .frag = fragment
John Kessenich94a81fb2013-08-31 02:41:30 +00001300// .comp = compute
Chao Chenb50c02e2018-09-19 11:42:24 -07001301// .rgen = ray generation
1302// .rint = ray intersection
1303// .rahit = ray any hit
1304// .rchit = ray closest hit
1305// .rmiss = ray miss
1306// .rcall = ray callable
Sahil Parmar035cbbe2018-10-04 16:39:18 -07001307// .mesh = mesh
1308// .task = task
Grigory Dzhavadyan33507412018-04-12 14:35:24 -07001309// Additionally, the file names may end in .<stage>.glsl and .<stage>.hlsl
1310// where <stage> is one of the stages listed above.
1311//
1312EShLanguage FindLanguage(const std::string& name, bool parseStageName)
John Kessenicha0af4732012-12-12 21:15:54 +00001313{
John Kessenichfccbb8b2018-04-17 17:24:03 -06001314 std::string stageName;
Dan Bakerc6ede892016-08-11 14:06:06 -04001315 if (shaderStageName)
John Kessenichfccbb8b2018-04-17 17:24:03 -06001316 stageName = shaderStageName;
1317 else if (parseStageName) {
Grigory Dzhavadyan33507412018-04-12 14:35:24 -07001318 // Note: "first" extension means "first from the end", i.e.
1319 // if the file is named foo.vert.glsl, then "glsl" is first,
1320 // "vert" is second.
John Kessenichfccbb8b2018-04-17 17:24:03 -06001321 size_t firstExtStart = name.find_last_of(".");
1322 bool hasFirstExt = firstExtStart != std::string::npos;
1323 size_t secondExtStart = hasFirstExt ? name.find_last_of(".", firstExtStart - 1) : std::string::npos;
1324 bool hasSecondExt = secondExtStart != std::string::npos;
1325 std::string firstExt = name.substr(firstExtStart + 1, std::string::npos);
1326 bool usesUnifiedExt = hasFirstExt && (firstExt == "glsl" || firstExt == "hlsl");
John Kessenich3beac942018-04-17 21:02:19 -06001327 if (usesUnifiedExt && firstExt == "hlsl")
1328 Options |= EOptionReadHlsl;
1329 if (hasFirstExt && !usesUnifiedExt)
John Kessenichfccbb8b2018-04-17 17:24:03 -06001330 stageName = firstExt;
John Kessenich3beac942018-04-17 21:02:19 -06001331 else if (usesUnifiedExt && hasSecondExt)
John Kessenichfccbb8b2018-04-17 17:24:03 -06001332 stageName = name.substr(secondExtStart + 1, firstExtStart - secondExtStart - 1);
John Kessenich3beac942018-04-17 21:02:19 -06001333 else {
Grigory Dzhavadyan33507412018-04-12 14:35:24 -07001334 usage();
1335 return EShLangVertex;
John Kesseniche751bca2017-03-16 11:20:38 -06001336 }
John Kessenichfccbb8b2018-04-17 17:24:03 -06001337 } else
1338 stageName = name;
dankbaker45d49bc2016-08-08 21:43:07 -04001339
John Kessenichfccbb8b2018-04-17 17:24:03 -06001340 if (stageName == "vert")
John Kessenich2b07c7e2013-07-31 18:44:13 +00001341 return EShLangVertex;
John Kessenichfccbb8b2018-04-17 17:24:03 -06001342 else if (stageName == "tesc")
John Kessenich2b07c7e2013-07-31 18:44:13 +00001343 return EShLangTessControl;
John Kessenichfccbb8b2018-04-17 17:24:03 -06001344 else if (stageName == "tese")
John Kessenich2b07c7e2013-07-31 18:44:13 +00001345 return EShLangTessEvaluation;
John Kessenichfccbb8b2018-04-17 17:24:03 -06001346 else if (stageName == "geom")
John Kessenich2b07c7e2013-07-31 18:44:13 +00001347 return EShLangGeometry;
John Kessenichfccbb8b2018-04-17 17:24:03 -06001348 else if (stageName == "frag")
John Kessenich2b07c7e2013-07-31 18:44:13 +00001349 return EShLangFragment;
John Kessenichfccbb8b2018-04-17 17:24:03 -06001350 else if (stageName == "comp")
John Kessenichc0275792013-08-09 17:14:49 +00001351 return EShLangCompute;
Chao Chen3c366992018-09-19 11:41:59 -07001352#ifdef NV_EXTENSIONS
Chao Chenb50c02e2018-09-19 11:42:24 -07001353 else if (stageName == "rgen")
1354 return EShLangRayGenNV;
1355 else if (stageName == "rint")
1356 return EShLangIntersectNV;
1357 else if (stageName == "rahit")
1358 return EShLangAnyHitNV;
1359 else if (stageName == "rchit")
1360 return EShLangClosestHitNV;
1361 else if (stageName == "rmiss")
1362 return EShLangMissNV;
1363 else if (stageName == "rcall")
1364 return EShLangCallableNV;
Chao Chen3c366992018-09-19 11:41:59 -07001365 else if (stageName == "mesh")
1366 return EShLangMeshNV;
1367 else if (stageName == "task")
1368 return EShLangTaskNV;
1369#endif
John Kessenich2b07c7e2013-07-31 18:44:13 +00001370
1371 usage();
John Kesseniche95ecc52012-12-12 21:34:14 +00001372 return EShLangVertex;
John Kessenicha0af4732012-12-12 21:15:54 +00001373}
1374
John Kessenicha0af4732012-12-12 21:15:54 +00001375//
John Kessenichecba76f2017-01-06 00:34:48 -07001376// Read a file's data into a string, and compile it using the old interface ShCompile,
John Kessenich69f4b512013-09-04 21:19:27 +00001377// for non-linkable results.
John Kessenicha0af4732012-12-12 21:15:54 +00001378//
John Kessenich51cdd902014-02-18 23:37:57 +00001379void CompileFile(const char* fileName, ShHandle compiler)
John Kessenicha0af4732012-12-12 21:15:54 +00001380{
John Kessenichca3457f2015-05-18 01:59:45 +00001381 int ret = 0;
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001382 char* shaderString;
1383 if ((Options & EOptionStdin) != 0) {
1384 std::istreambuf_iterator<char> begin(std::cin), end;
1385 std::string tempString(begin, end);
1386 shaderString = strdup(tempString.c_str());
1387 } else {
1388 shaderString = ReadFileData(fileName);
1389 }
John Kessenich41cf6b52013-06-25 18:10:05 +00001390
1391 // move to length-based strings, rather than null-terminated strings
John Kessenich04acb1b2017-06-14 17:36:50 -06001392 int* lengths = new int[1];
1393 lengths[0] = (int)strlen(shaderString);
John Kessenicha0af4732012-12-12 21:15:54 +00001394
John Kessenich52ac67e2013-05-05 23:46:22 +00001395 EShMessages messages = EShMsgDefault;
John Kessenichb0a7eb52013-11-07 17:44:20 +00001396 SetMessageOptions(messages);
John Kessenichecba76f2017-01-06 00:34:48 -07001397
John Kessenicha9313662017-06-15 10:40:49 -06001398 if (UserPreamble.isSet())
1399 Error("-D and -U options require -l (linking)\n");
1400
John Kessenich94a81fb2013-08-31 02:41:30 +00001401 for (int i = 0; i < ((Options & EOptionMemoryLeakMode) ? 100 : 1); ++i) {
1402 for (int j = 0; j < ((Options & EOptionMemoryLeakMode) ? 100 : 1); ++j) {
John Kessenich927608b2017-01-06 12:34:14 -07001403 // ret = ShCompile(compiler, shaderStrings, NumShaderStrings, lengths, EShOptNone, &Resources, Options, (Options & EOptionDefaultDesktop) ? 110 : 100, false, messages);
John Kessenich04acb1b2017-06-14 17:36:50 -06001404 ret = ShCompile(compiler, &shaderString, 1, nullptr, EShOptNone, &Resources, Options, (Options & EOptionDefaultDesktop) ? 110 : 100, false, messages);
John Kessenich927608b2017-01-06 12:34:14 -07001405 // const char* multi[12] = { "# ve", "rsion", " 300 e", "s", "\n#err",
John Kessenichecba76f2017-01-06 00:34:48 -07001406 // "or should be l", "ine 1", "string 5\n", "float glo", "bal",
John Kessenichea869fb2013-10-28 18:12:06 +00001407 // ";\n#error should be line 2\n void main() {", "global = 2.3;}" };
John Kessenich927608b2017-01-06 12:34:14 -07001408 // const char* multi[7] = { "/", "/", "\\", "\n", "\n", "#", "version 300 es" };
1409 // ret = ShCompile(compiler, multi, 7, nullptr, EShOptNone, &Resources, Options, (Options & EOptionDefaultDesktop) ? 110 : 100, false, messages);
John Kessenich41cf6b52013-06-25 18:10:05 +00001410 }
John Kessenicha0af4732012-12-12 21:15:54 +00001411
John Kessenich94a81fb2013-08-31 02:41:30 +00001412 if (Options & EOptionMemoryLeakMode)
John Kessenich2b07c7e2013-07-31 18:44:13 +00001413 glslang::OS_DumpMemoryCounters();
John Kessenicha0af4732012-12-12 21:15:54 +00001414 }
John Kessenicha0af4732012-12-12 21:15:54 +00001415
John Kessenich41cf6b52013-06-25 18:10:05 +00001416 delete [] lengths;
John Kessenich04acb1b2017-06-14 17:36:50 -06001417 FreeFileData(shaderString);
John Kessenicha0af4732012-12-12 21:15:54 +00001418
John Kessenichc999ba22013-11-07 23:33:24 +00001419 if (ret == 0)
1420 CompileFailed = true;
John Kessenicha0af4732012-12-12 21:15:54 +00001421}
1422
John Kessenicha0af4732012-12-12 21:15:54 +00001423//
1424// print usage to stdout
1425//
1426void usage()
1427{
John Kessenich319de232013-12-04 04:43:40 +00001428 printf("Usage: glslangValidator [option]... [file]...\n"
1429 "\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001430 "'file' can end in .<stage> for auto-stage classification, where <stage> is:\n"
1431 " .conf to provide a config file that replaces the default configuration\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001432 " (see -c option below for generating a template)\n"
1433 " .vert for a vertex shader\n"
1434 " .tesc for a tessellation control shader\n"
1435 " .tese for a tessellation evaluation shader\n"
1436 " .geom for a geometry shader\n"
1437 " .frag for a fragment shader\n"
1438 " .comp for a compute shader\n"
Chao Chen3c366992018-09-19 11:41:59 -07001439#ifdef NV_EXTENSIONS
1440 " .mesh for a mesh shader\n"
1441 " .task for a task shader\n"
Chao Chenb50c02e2018-09-19 11:42:24 -07001442 " .rgen for a ray generation shader\n"
1443 " .rint for a ray intersection shader\n"
1444 " .rahit for a ray any hit shader\n"
1445 " .rchit for a ray closest hit shader\n"
1446 " .rmiss for a ray miss shader\n"
Sahil Parmar035cbbe2018-10-04 16:39:18 -07001447 " .rcall for a ray callable shader\n"
Chao Chen3c366992018-09-19 11:41:59 -07001448#endif
John Kessenich2ead40f2018-04-17 17:44:11 -06001449 " .glsl for .vert.glsl, .tesc.glsl, ..., .comp.glsl compound suffixes\n"
1450 " .hlsl for .vert.hlsl, .tesc.hlsl, ..., .comp.hlsl compound suffixes\n"
John Kessenich319de232013-12-04 04:43:40 +00001451 "\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001452 "Options:\n"
1453 " -C cascading errors; risk crash from accumulation of error recoveries\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001454 " -D input is HLSL (this is the default when any suffix is .hlsl)\n"
John Kessenicha9313662017-06-15 10:40:49 -06001455 " -D<macro=def>\n"
1456 " -D<macro> define a pre-processor macro\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001457 " -E print pre-processed GLSL; cannot be used with -l;\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001458 " errors will appear on stderr\n"
John Kessenich6353d552017-06-23 11:11:09 -06001459 " -G[ver] create SPIR-V binary, under OpenGL semantics; turns on -l;\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001460 " default file name is <stage>.spv (-o overrides this);\n"
John Kessenich6353d552017-06-23 11:11:09 -06001461 " 'ver', when present, is the version of the input semantics,\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001462 " which will appear in #define GL_SPIRV ver;\n"
1463 " '--client opengl100' is the same as -G100;\n"
John Kessenich6353d552017-06-23 11:11:09 -06001464 " a '--target-env' for OpenGL will also imply '-G'\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001465 " -H print human readable form of SPIR-V; turns on -V\n"
John Kessenich971a0a82017-06-07 15:06:58 -06001466 " -I<dir> add dir to the include search path; includer's directory\n"
1467 " is searched first, followed by left-to-right order of -I\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001468 " -Od disables optimization; may cause illegal SPIR-V for HLSL\n"
1469 " -Os optimizes SPIR-V to minimize size\n"
John Kesseniche751bca2017-03-16 11:20:38 -06001470 " -S <stage> uses specified stage rather than parsing the file extension\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001471 " choices for <stage> are vert, tesc, tese, geom, frag, or comp\n"
John Kessenich6353d552017-06-23 11:11:09 -06001472 " -U<macro> undefine a pre-processor macro\n"
1473 " -V[ver] create SPIR-V binary, under Vulkan semantics; turns on -l;\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001474 " default file name is <stage>.spv (-o overrides this)\n"
John Kessenich6353d552017-06-23 11:11:09 -06001475 " 'ver', when present, is the version of the input semantics,\n"
1476 " which will appear in #define VULKAN ver\n"
1477 " '--client vulkan100' is the same as -V100\n"
1478 " a '--target-env' for Vulkan will also imply '-V'\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001479 " -c configuration dump;\n"
1480 " creates the default configuration file (redirect to a .conf file)\n"
1481 " -d default to desktop (#version 110) when there is no shader #version\n"
1482 " (default is ES version 100)\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001483 " -e <name> | --entry-point <name>\n"
1484 " specify <name> as the entry-point function name\n"
John Kessenich5d610ee2018-03-07 18:05:55 -07001485 " -f{hlsl_functionality1}\n"
1486 " 'hlsl_functionality1' enables use of the\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001487 " SPV_GOOGLE_hlsl_functionality1 extension\n"
John Kessenich121853f2017-05-31 17:11:16 -06001488 " -g generate debug information\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001489 " -h print this usage message\n"
1490 " -i intermediate tree (glslang AST) is printed out\n"
1491 " -l link all input files together to form a single module\n"
1492 " -m memory leak mode\n"
John Kessenicha25530c2017-09-11 20:13:49 -06001493 " -o <file> save binary to <file>, requires a binary option (e.g., -V)\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001494 " -q dump reflection query database\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001495 " -r | --relaxed-errors"
1496 " relaxed GLSL semantic error-checking mode\n"
John Kessenichb63f4a32017-11-16 22:32:20 -07001497 " -s silence syntax and semantic error reporting\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001498 " -t multi-threaded mode\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001499 " -v | --version\n"
1500 " print version strings\n"
1501 " -w | --suppress-warnings\n"
1502 " suppress GLSL warnings, except as required by \"#extension : warn\"\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001503 " -x save binary output as text-based 32-bit hexadecimal numbers\n"
Neil Roberts16f53472018-03-20 17:30:53 +01001504 " -u<name>:<loc> specify a uniform location override for --aml\n"
Neil Robertsb0f3d792018-03-20 17:41:05 +01001505 " --uniform-base <base> set a base to use for generated uniform locations\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001506 " --auto-map-bindings | --amb automatically bind uniform variables\n"
1507 " without explicit bindings\n"
1508 " --auto-map-locations | --aml automatically locate input/output lacking\n"
1509 " 'location' (fragile, not cross stage)\n"
1510 " --client {vulkan<ver>|opengl<ver>} see -V and -G\n"
1511 " -dumpfullversion | -dumpversion print bare major.minor.patchlevel\n"
1512 " --flatten-uniform-arrays | --fua flatten uniform texture/sampler arrays to\n"
1513 " scalars\n"
1514 " --hlsl-offsets allow block offsets to follow HLSL rules\n"
1515 " works independently of source language\n"
1516 " --hlsl-iomap perform IO mapping in HLSL register space\n"
1517 " --hlsl-enable-16bit-types allow 16-bit types in SPIR-V for HLSL\n"
John Kessenichbd1c1832018-12-07 18:38:26 -07001518 " --hlsl-dx9-compatible interprets sampler declarations as a texture/sampler combo like DirectX9 would."
John Kessenichade8bbb2018-08-12 21:24:55 -06001519 " --invert-y | --iy invert position.Y output in vertex shader\n"
1520 " --keep-uncalled | --ku don't eliminate uncalled functions\n"
1521 " --no-storage-format | --nsf use Unknown image format\n"
LoopDawg52017192017-07-14 15:15:47 -06001522 " --resource-set-binding [stage] name set binding\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001523 " set descriptor set and binding for\n"
1524 " individual resources\n"
LoopDawg52017192017-07-14 15:15:47 -06001525 " --resource-set-binding [stage] set\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001526 " set descriptor set for all resources\n"
1527 " --rsb synonym for --resource-set-binding\n"
1528 " --shift-image-binding [stage] num\n"
1529 " base binding number for images (uav)\n"
1530 " --shift-image-binding [stage] [num set]...\n"
1531 " per-descriptor-set shift values\n"
1532 " --sib synonym for --shift-image-binding\n"
1533 " --shift-sampler-binding [stage] num\n"
1534 " base binding number for samplers\n"
1535 " --shift-sampler-binding [stage] [num set]...\n"
1536 " per-descriptor-set shift values\n"
1537 " --ssb synonym for --shift-sampler-binding\n"
1538 " --shift-ssbo-binding [stage] num base binding number for SSBOs\n"
1539 " --shift-ssbo-binding [stage] [num set]...\n"
1540 " per-descriptor-set shift values\n"
1541 " --sbb synonym for --shift-ssbo-binding\n"
1542 " --shift-texture-binding [stage] num\n"
1543 " base binding number for textures\n"
1544 " --shift-texture-binding [stage] [num set]...\n"
1545 " per-descriptor-set shift values\n"
1546 " --stb synonym for --shift-texture-binding\n"
1547 " --shift-uav-binding [stage] num base binding number for UAVs\n"
1548 " --shift-uav-binding [stage] [num set]...\n"
1549 " per-descriptor-set shift values\n"
1550 " --suavb synonym for --shift-uav-binding\n"
1551 " --shift-UBO-binding [stage] num base binding number for UBOs\n"
1552 " --shift-UBO-binding [stage] [num set]...\n"
1553 " per-descriptor-set shift values\n"
1554 " --sub synonym for --shift-UBO-binding\n"
1555 " --shift-cbuffer-binding | --scb synonyms for --shift-UBO-binding\n"
1556 " --spirv-dis output standard-form disassembly; works only\n"
1557 " when a SPIR-V generation option is also used\n"
John Kessenichc3404252018-08-23 15:29:08 -06001558 " --spirv-val execute the SPIRV-Tools validator\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001559 " --source-entrypoint <name> the given shader source function is\n"
1560 " renamed to be the <name> given in -e\n"
1561 " --sep synonym for --source-entrypoint\n"
1562 " --stdin read from stdin instead of from a file;\n"
1563 " requires providing the shader stage using -S\n"
John Kessenich8717a5d2018-10-26 10:12:32 -06001564 " --target-env {vulkan1.0 | vulkan1.1 | opengl | \n"
1565 " spirv1.0 | spirv1.1 | spirv1.2 | spirv1.3}\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001566 " set execution environment that emitted code\n"
John Kessenich8717a5d2018-10-26 10:12:32 -06001567 " will execute in (versus source language\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001568 " semantics selected by --client) defaults:\n"
1569 " * 'vulkan1.0' under '--client vulkan<ver>'\n"
1570 " * 'opengl' under '--client opengl<ver>'\n"
John Kessenich8717a5d2018-10-26 10:12:32 -06001571 " * 'spirv1.0' under --target-env vulkan1.0\n"
1572 " * 'spirv1.3' under --target-env vulkan1.1\n"
1573 " multiple --targen-env can be specified.\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001574 " --variable-name <name>\n"
1575 " --vn <name> creates a C header file that contains a\n"
1576 " uint32_t array named <name>\n"
1577 " initialized with the shader binary code\n"
John Kessenichb0a7eb52013-11-07 17:44:20 +00001578 );
John Kessenich68d78fd2015-07-12 19:28:10 -06001579
1580 exit(EFailUsage);
John Kessenicha0af4732012-12-12 21:15:54 +00001581}
1582
John Kessenich3ce4e592014-10-06 19:57:34 +00001583#if !defined _MSC_VER && !defined MINGW_HAS_SECURE_API
John Kessenichcfd643e2013-03-08 23:14:42 +00001584
1585#include <errno.h>
1586
1587int fopen_s(
1588 FILE** pFile,
John Kessenich51cdd902014-02-18 23:37:57 +00001589 const char* filename,
1590 const char* mode
John Kessenichcfd643e2013-03-08 23:14:42 +00001591)
1592{
1593 if (!pFile || !filename || !mode) {
1594 return EINVAL;
1595 }
1596
1597 FILE* f = fopen(filename, mode);
1598 if (! f) {
1599 if (errno != 0) {
1600 return errno;
1601 } else {
1602 return ENOENT;
1603 }
1604 }
1605 *pFile = f;
1606
1607 return 0;
1608}
1609
1610#endif
1611
John Kessenicha0af4732012-12-12 21:15:54 +00001612//
1613// Malloc a string of sufficient size and read a string into it.
1614//
John Kessenich04acb1b2017-06-14 17:36:50 -06001615char* ReadFileData(const char* fileName)
John Kessenicha0af4732012-12-12 21:15:54 +00001616{
John Kessenichb3297152015-07-11 18:01:03 -06001617 FILE *in = nullptr;
John Kessenich3ce4e592014-10-06 19:57:34 +00001618 int errorCode = fopen_s(&in, fileName, "r");
John Kessenich68d78fd2015-07-12 19:28:10 -06001619 if (errorCode || in == nullptr)
1620 Error("unable to open input file");
John Kessenichecba76f2017-01-06 00:34:48 -07001621
John Kessenich04acb1b2017-06-14 17:36:50 -06001622 int count = 0;
John Kessenicha0af4732012-12-12 21:15:54 +00001623 while (fgetc(in) != EOF)
1624 count++;
1625
John Kessenichd6c72a42014-08-18 19:42:35 +00001626 fseek(in, 0, SEEK_SET);
John Kessenichca3457f2015-05-18 01:59:45 +00001627
John Kessenich04acb1b2017-06-14 17:36:50 -06001628 char* return_data = (char*)malloc(count + 1); // freed in FreeFileData()
1629 if ((int)fread(return_data, 1, count, in) != count) {
1630 free(return_data);
John Kessenich68d78fd2015-07-12 19:28:10 -06001631 Error("can't read input file");
John Kessenicha0af4732012-12-12 21:15:54 +00001632 }
John Kessenich68d78fd2015-07-12 19:28:10 -06001633
John Kessenich04acb1b2017-06-14 17:36:50 -06001634 return_data[count] = '\0';
John Kessenicha0af4732012-12-12 21:15:54 +00001635 fclose(in);
John Kessenichb3297152015-07-11 18:01:03 -06001636
John Kessenicha0af4732012-12-12 21:15:54 +00001637 return return_data;
1638}
1639
John Kessenich04acb1b2017-06-14 17:36:50 -06001640void FreeFileData(char* data)
John Kessenicha0af4732012-12-12 21:15:54 +00001641{
John Kessenichb3297152015-07-11 18:01:03 -06001642 free(data);
John Kessenicha0af4732012-12-12 21:15:54 +00001643}
1644
John Kessenich54d8cda2013-02-11 22:36:01 +00001645void InfoLogMsg(const char* msg, const char* name, const int num)
John Kessenicha0af4732012-12-12 21:15:54 +00001646{
John Kessenichfae38ee2015-06-10 23:23:12 +00001647 if (num >= 0 )
1648 printf("#### %s %s %d INFO LOG ####\n", msg, name, num);
1649 else
1650 printf("#### %s %s INFO LOG ####\n", msg, name);
John Kessenicha0af4732012-12-12 21:15:54 +00001651}