blob: 42a46cee09e0eb02569b5d757fd44bcdefc79e09 [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
John Kessenich94a81fb2013-08-31 02:41:30 +0000155int Options = 0;
John Kessenich68d78fd2015-07-12 19:28:10 -0600156const char* ExecutableName = nullptr;
157const char* binaryFileName = nullptr;
John Kessenich4d65ee32016-03-12 18:17:47 -0700158const char* entryPointName = nullptr;
steve-lunargf1e0c872016-10-31 15:13:43 -0600159const char* sourceEntryPointName = nullptr;
Dan Bakerc6ede892016-08-11 14:06:06 -0400160const char* shaderStageName = nullptr;
Flavioaea3c892017-02-06 11:46:35 -0800161const char* variableName = nullptr;
Rex Xucb61eec2018-03-07 13:10:01 +0800162bool HlslEnable16BitTypes = false;
John Kessenichbd1c1832018-12-07 18:38:26 -0700163bool HlslDX9compatible = false;
John Kessenich971a0a82017-06-07 15:06:58 -0600164std::vector<std::string> IncludeDirectoryList;
John Kessenich8717a5d2018-10-26 10:12:32 -0600165
166// Source environment
167// (source 'Client' is currently the same as target 'Client')
168int ClientInputSemanticsVersion = 100;
169
170// Target environment
171glslang::EShClient Client = glslang::EShClientNone; // will stay EShClientNone if only validating
172glslang::EShTargetClientVersion ClientVersion; // not valid until Client is set
173glslang::EShTargetLanguage TargetLanguage = glslang::EShTargetNone;
174glslang::EShTargetLanguageVersion TargetVersion; // not valid until TargetLanguage is set
175
John Kessenich66011cb2018-03-06 16:12:04 -0700176std::vector<std::string> Processes; // what should be recorded by OpModuleProcessed, or equivalent
John Kessenich68d78fd2015-07-12 19:28:10 -0600177
LoopDawg08a14422017-10-17 19:27:14 -0600178// Per descriptor-set binding base data
179typedef std::map<unsigned int, unsigned int> TPerSetBaseBinding;
180
Neil Roberts16f53472018-03-20 17:30:53 +0100181std::vector<std::pair<std::string, int>> uniformLocationOverrides;
Neil Robertsb0f3d792018-03-20 17:41:05 +0100182int uniformBase = 0;
Neil Roberts16f53472018-03-20 17:30:53 +0100183
LoopDawg08a14422017-10-17 19:27:14 -0600184std::array<std::array<unsigned int, EShLangCount>, glslang::EResCount> baseBinding;
185std::array<std::array<TPerSetBaseBinding, EShLangCount>, glslang::EResCount> baseBindingForSet;
Hyangran Park36dc8292017-05-02 16:27:29 +0900186std::array<std::vector<std::string>, EShLangCount> baseResourceSetBinding;
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600187
John Kessenicha9313662017-06-15 10:40:49 -0600188// Add things like "#define ..." to a preamble to use in the beginning of the shader.
189class TPreamble {
190public:
191 TPreamble() { }
192
193 bool isSet() const { return text.size() > 0; }
194 const char* get() const { return text.c_str(); }
195
196 // #define...
197 void addDef(std::string def)
198 {
199 text.append("#define ");
200 fixLine(def);
201
John Kessenich2a271162017-07-20 20:00:36 -0600202 Processes.push_back("D");
203 Processes.back().append(def);
204
John Kessenicha9313662017-06-15 10:40:49 -0600205 // The first "=" needs to turn into a space
LoopDawgb97b25e2017-07-12 09:04:39 -0600206 const size_t equal = def.find_first_of("=");
John Kessenicha9313662017-06-15 10:40:49 -0600207 if (equal != def.npos)
208 def[equal] = ' ';
209
210 text.append(def);
211 text.append("\n");
212 }
213
214 // #undef...
215 void addUndef(std::string undef)
216 {
217 text.append("#undef ");
218 fixLine(undef);
John Kessenich2a271162017-07-20 20:00:36 -0600219
220 Processes.push_back("U");
221 Processes.back().append(undef);
222
John Kessenicha9313662017-06-15 10:40:49 -0600223 text.append(undef);
224 text.append("\n");
225 }
226
227protected:
228 void fixLine(std::string& line)
229 {
230 // Can't go past a newline in the line
LoopDawgb97b25e2017-07-12 09:04:39 -0600231 const size_t end = line.find_first_of("\n");
John Kessenicha9313662017-06-15 10:40:49 -0600232 if (end != line.npos)
233 line = line.substr(0, end);
234 }
235
236 std::string text; // contents of preamble
237};
238
239TPreamble UserPreamble;
240
John Kessenich68d78fd2015-07-12 19:28:10 -0600241//
242// Create the default name for saving a binary if -o is not provided.
243//
244const char* GetBinaryName(EShLanguage stage)
245{
246 const char* name;
247 if (binaryFileName == nullptr) {
248 switch (stage) {
249 case EShLangVertex: name = "vert.spv"; break;
250 case EShLangTessControl: name = "tesc.spv"; break;
251 case EShLangTessEvaluation: name = "tese.spv"; break;
252 case EShLangGeometry: name = "geom.spv"; break;
253 case EShLangFragment: name = "frag.spv"; break;
254 case EShLangCompute: name = "comp.spv"; break;
Chao Chen3c366992018-09-19 11:41:59 -0700255#ifdef NV_EXTENSIONS
Chao Chenb50c02e2018-09-19 11:42:24 -0700256 case EShLangRayGenNV: name = "rgen.spv"; break;
257 case EShLangIntersectNV: name = "rint.spv"; break;
258 case EShLangAnyHitNV: name = "rahit.spv"; break;
259 case EShLangClosestHitNV: name = "rchit.spv"; break;
260 case EShLangMissNV: name = "rmiss.spv"; break;
261 case EShLangCallableNV: name = "rcall.spv"; break;
Chao Chen3c366992018-09-19 11:41:59 -0700262 case EShLangMeshNV: name = "mesh.spv"; break;
263 case EShLangTaskNV: name = "task.spv"; break;
264#endif
John Kessenich68d78fd2015-07-12 19:28:10 -0600265 default: name = "unknown"; break;
266 }
267 } else
268 name = binaryFileName;
269
270 return name;
271}
John Kessenich2b07c7e2013-07-31 18:44:13 +0000272
John Kessenich05a70632013-09-17 19:26:08 +0000273//
274// *.conf => this is a config file that can set limits/resources
275//
276bool SetConfigFile(const std::string& name)
277{
278 if (name.size() < 5)
279 return false;
280
John Kessenich4c706852013-10-11 16:28:43 +0000281 if (name.compare(name.size() - 5, 5, ".conf") == 0) {
John Kessenich05a70632013-09-17 19:26:08 +0000282 ConfigFile = name;
283 return true;
284 }
285
286 return false;
287}
288
John Kessenich68d78fd2015-07-12 19:28:10 -0600289//
290// Give error and exit with failure code.
291//
292void Error(const char* message)
293{
John Kessenichaf527992017-11-02 22:48:15 -0600294 fprintf(stderr, "%s: Error %s (use -h for usage)\n", ExecutableName, message);
John Kessenich68d78fd2015-07-12 19:28:10 -0600295 exit(EFailUsage);
296}
297
298//
LoopDawg08a14422017-10-17 19:27:14 -0600299// Process an optional binding base of one the forms:
300// --argname [stage] base // base for stage (if given) or all stages (if not)
LoopDawge5709552017-10-21 10:46:39 -0600301// --argname [stage] [base set]... // set/base pairs: set the base for given binding set.
LoopDawg08a14422017-10-17 19:27:14 -0600302
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600303// Where stage is one of the forms accepted by FindLanguage, and base is an integer
304//
LoopDawg08a14422017-10-17 19:27:14 -0600305void ProcessBindingBase(int& argc, char**& argv, glslang::TResourceType res)
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600306{
307 if (argc < 2)
308 usage();
309
LoopDawg08a14422017-10-17 19:27:14 -0600310 EShLanguage lang = EShLangCount;
311 int singleBase = 0;
312 TPerSetBaseBinding perSetBase;
313 int arg = 1;
314
315 // Parse stage, if given
316 if (!isdigit(argv[arg][0])) {
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600317 if (argc < 3) // this form needs one more argument
318 usage();
John Kessenichecba76f2017-01-06 00:34:48 -0700319
LoopDawg08a14422017-10-17 19:27:14 -0600320 lang = FindLanguage(argv[arg++], false);
321 }
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600322
LoopDawg08a14422017-10-17 19:27:14 -0600323 if ((argc - arg) > 2 && isdigit(argv[arg+0][0]) && isdigit(argv[arg+1][0])) {
324 // Parse a per-set binding base
325 while ((argc - arg) > 2 && isdigit(argv[arg+0][0]) && isdigit(argv[arg+1][0])) {
LoopDawg08a14422017-10-17 19:27:14 -0600326 const int baseNum = atoi(argv[arg++]);
LoopDawge5709552017-10-21 10:46:39 -0600327 const int setNum = atoi(argv[arg++]);
LoopDawg08a14422017-10-17 19:27:14 -0600328 perSetBase[setNum] = baseNum;
329 }
330 } else {
331 // Parse single binding base
332 singleBase = atoi(argv[arg++]);
333 }
334
335 argc -= (arg-1);
336 argv += (arg-1);
337
338 // Set one or all languages
339 const int langMin = (lang < EShLangCount) ? lang+0 : 0;
340 const int langMax = (lang < EShLangCount) ? lang+1 : EShLangCount;
341
342 for (int lang = langMin; lang < langMax; ++lang) {
343 if (!perSetBase.empty())
John Kessenich251901a2018-08-12 22:05:59 -0600344 baseBindingForSet[res][lang].insert(perSetBase.begin(), perSetBase.end());
LoopDawg08a14422017-10-17 19:27:14 -0600345 else
346 baseBinding[res][lang] = singleBase;
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600347 }
348}
349
Hyangran Park36dc8292017-05-02 16:27:29 +0900350void ProcessResourceSetBindingBase(int& argc, char**& argv, std::array<std::vector<std::string>, EShLangCount>& base)
351{
352 if (argc < 2)
353 usage();
354
355 if (!isdigit(argv[1][0])) {
LoopDawg52017192017-07-14 15:15:47 -0600356 if (argc < 3) // this form needs one more argument
Hyangran Park36dc8292017-05-02 16:27:29 +0900357 usage();
358
LoopDawg52017192017-07-14 15:15:47 -0600359 // Parse form: --argname stage [regname set base...], or:
360 // --argname stage set
Hyangran Park36dc8292017-05-02 16:27:29 +0900361 const EShLanguage lang = FindLanguage(argv[1], false);
362
LoopDawg52017192017-07-14 15:15:47 -0600363 argc--;
364 argv++;
365
366 while (argc > 1 && argv[1] != nullptr && argv[1][0] != '-') {
367 base[lang].push_back(argv[1]);
368
369 argc--;
370 argv++;
Hyangran Park36dc8292017-05-02 16:27:29 +0900371 }
LoopDawg52017192017-07-14 15:15:47 -0600372
373 // Must have one arg, or a multiple of three (for [regname set binding] triples)
374 if (base[lang].size() != 1 && (base[lang].size() % 3) != 0)
375 usage();
376
Hyangran Park36dc8292017-05-02 16:27:29 +0900377 } else {
LoopDawg52017192017-07-14 15:15:47 -0600378 // Parse form: --argname set
Hyangran Park36dc8292017-05-02 16:27:29 +0900379 for (int lang=0; lang<EShLangCount; ++lang)
380 base[lang].push_back(argv[1]);
381
382 argc--;
383 argv++;
384 }
385}
386
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600387//
John Kessenich68d78fd2015-07-12 19:28:10 -0600388// Do all command-line argument parsing. This includes building up the work-items
389// to be processed later, and saving all the command-line options.
390//
391// Does not return (it exits) if command-line is fatally flawed.
392//
Juan Lopeza558b262017-04-02 23:04:00 +0200393void ProcessArguments(std::vector<std::unique_ptr<glslang::TWorkItem>>& workItems, int argc, char* argv[])
John Kessenich2b07c7e2013-07-31 18:44:13 +0000394{
LoopDawg08a14422017-10-17 19:27:14 -0600395 for (int res = 0; res < glslang::EResCount; ++res)
396 baseBinding[res].fill(0);
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600397
John Kessenich38f3b892013-09-06 19:52:57 +0000398 ExecutableName = argv[0];
Juan Lopeza558b262017-04-02 23:04:00 +0200399 workItems.reserve(argc);
John Kessenich38f3b892013-09-06 19:52:57 +0000400
John Kessenichc178f0a2017-06-23 10:58:31 -0600401 const auto bumpArg = [&]() {
402 if (argc > 0) {
403 argc--;
404 argv++;
405 }
406 };
407
408 // read a string directly attached to a single-letter option
John Kessenich6263fb12017-06-14 15:52:44 -0600409 const auto getStringOperand = [&](const char* desc) {
410 if (argv[0][2] == 0) {
411 printf("%s must immediately follow option (no spaces)\n", desc);
412 exit(EFailUsage);
413 }
414 return argv[0] + 2;
415 };
416
John Kessenich6353d552017-06-23 11:11:09 -0600417 // read a number attached to a single-letter option
418 const auto getAttachedNumber = [&](const char* desc) {
419 int num = atoi(argv[0] + 2);
420 if (num == 0) {
421 printf("%s: expected attached non-0 number\n", desc);
422 exit(EFailUsage);
423 }
424 return num;
425 };
426
427 // minimum needed (without overriding something else) to target Vulkan SPIR-V
428 const auto setVulkanSpv = []() {
John Kessenich8717a5d2018-10-26 10:12:32 -0600429 if (Client == glslang::EShClientNone)
430 ClientVersion = glslang::EShTargetVulkan_1_0;
431 Client = glslang::EShClientVulkan;
John Kessenich6353d552017-06-23 11:11:09 -0600432 Options |= EOptionSpv;
433 Options |= EOptionVulkanRules;
434 Options |= EOptionLinkProgram;
435 };
436
437 // minimum needed (without overriding something else) to target OpenGL SPIR-V
438 const auto setOpenGlSpv = []() {
John Kessenich8717a5d2018-10-26 10:12:32 -0600439 if (Client == glslang::EShClientNone)
440 ClientVersion = glslang::EShTargetOpenGL_450;
441 Client = glslang::EShClientOpenGL;
John Kessenich6353d552017-06-23 11:11:09 -0600442 Options |= EOptionSpv;
443 Options |= EOptionLinkProgram;
444 // undo a -H default to Vulkan
445 Options &= ~EOptionVulkanRules;
446 };
447
Neil Roberts16f53472018-03-20 17:30:53 +0100448 const auto getUniformOverride = [getStringOperand]() {
449 const char *arg = getStringOperand("-u<name>:<location>");
450 const char *split = strchr(arg, ':');
451 if (split == NULL) {
452 printf("%s: missing location\n", arg);
453 exit(EFailUsage);
454 }
455 errno = 0;
456 int location = ::strtol(split + 1, NULL, 10);
457 if (errno) {
458 printf("%s: invalid location\n", arg);
459 exit(EFailUsage);
460 }
461 return std::make_pair(std::string(arg, split - arg), location);
462 };
463
John Kessenichc178f0a2017-06-23 10:58:31 -0600464 for (bumpArg(); argc >= 1; bumpArg()) {
John Kessenich2b07c7e2013-07-31 18:44:13 +0000465 if (argv[0][0] == '-') {
John Kessenich2aa7f3a2015-05-15 16:02:07 +0000466 switch (argv[0][1]) {
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600467 case '-':
468 {
469 std::string lowerword(argv[0]+2);
470 std::transform(lowerword.begin(), lowerword.end(), lowerword.begin(), ::tolower);
471
472 // handle --word style options
John Kessenich6263fb12017-06-14 15:52:44 -0600473 if (lowerword == "auto-map-bindings" || // synonyms
John Kessenich6353d552017-06-23 11:11:09 -0600474 lowerword == "auto-map-binding" ||
475 lowerword == "amb") {
John Kessenich6263fb12017-06-14 15:52:44 -0600476 Options |= EOptionAutoMapBindings;
477 } else if (lowerword == "auto-map-locations" || // synonyms
478 lowerword == "aml") {
479 Options |= EOptionAutoMapLocations;
Neil Robertsb0f3d792018-03-20 17:41:05 +0100480 } else if (lowerword == "uniform-base") {
481 if (argc <= 1)
482 Error("no <base> provided for --uniform-base");
483 uniformBase = ::strtol(argv[1], NULL, 10);
484 bumpArg();
485 break;
John Kessenich6353d552017-06-23 11:11:09 -0600486 } else if (lowerword == "client") {
487 if (argc > 1) {
488 if (strcmp(argv[1], "vulkan100") == 0)
489 setVulkanSpv();
490 else if (strcmp(argv[1], "opengl100") == 0)
491 setOpenGlSpv();
492 else
493 Error("--client expects vulkan100 or opengl100");
494 }
495 bumpArg();
John Kessenich640bd092018-08-09 14:15:00 -0600496 } else if (lowerword == "entry-point") {
497 entryPointName = argv[1];
498 if (argc <= 1)
499 Error("no <name> provided for --entry-point");
500 bumpArg();
John Kessenich6263fb12017-06-14 15:52:44 -0600501 } else if (lowerword == "flatten-uniform-arrays" || // synonyms
502 lowerword == "flatten-uniform-array" ||
503 lowerword == "fua") {
504 Options |= EOptionFlattenUniformArrays;
505 } else if (lowerword == "hlsl-offsets") {
506 Options |= EOptionHlslOffsets;
507 } else if (lowerword == "hlsl-iomap" ||
508 lowerword == "hlsl-iomapper" ||
509 lowerword == "hlsl-iomapping") {
510 Options |= EOptionHlslIoMapping;
Rex Xucb61eec2018-03-07 13:10:01 +0800511 } else if (lowerword == "hlsl-enable-16bit-types") {
512 HlslEnable16BitTypes = true;
John Kessenichbd1c1832018-12-07 18:38:26 -0700513 } else if (lowerword == "hlsl-dx9-compatible") {
514 HlslDX9compatible = true;
John Kessenichc6c80a62018-03-05 22:23:17 -0700515 } else if (lowerword == "invert-y" || // synonyms
516 lowerword == "iy") {
517 Options |= EOptionInvertY;
John Kessenich6263fb12017-06-14 15:52:44 -0600518 } else if (lowerword == "keep-uncalled" || // synonyms
519 lowerword == "ku") {
520 Options |= EOptionKeepUncalled;
521 } else if (lowerword == "no-storage-format" || // synonyms
522 lowerword == "nsf") {
523 Options |= EOptionNoStorageFormat;
John Kessenich2a271162017-07-20 20:00:36 -0600524 } else if (lowerword == "relaxed-errors") {
525 Options |= EOptionRelaxedErrors;
John Kessenich6263fb12017-06-14 15:52:44 -0600526 } else if (lowerword == "resource-set-bindings" || // synonyms
527 lowerword == "resource-set-binding" ||
528 lowerword == "rsb") {
529 ProcessResourceSetBindingBase(argc, argv, baseResourceSetBinding);
steve-lunarg9088be42016-11-01 10:31:42 -0600530 } else if (lowerword == "shift-image-bindings" || // synonyms
531 lowerword == "shift-image-binding" ||
532 lowerword == "sib") {
LoopDawg08a14422017-10-17 19:27:14 -0600533 ProcessBindingBase(argc, argv, glslang::EResImage);
John Kessenich6263fb12017-06-14 15:52:44 -0600534 } else if (lowerword == "shift-sampler-bindings" || // synonyms
John Kessenichade8bbb2018-08-12 21:24:55 -0600535 lowerword == "shift-sampler-binding" ||
536 lowerword == "ssb") {
LoopDawg08a14422017-10-17 19:27:14 -0600537 ProcessBindingBase(argc, argv, glslang::EResSampler);
John Kessenich6263fb12017-06-14 15:52:44 -0600538 } else if (lowerword == "shift-uav-bindings" || // synonyms
539 lowerword == "shift-uav-binding" ||
540 lowerword == "suavb") {
LoopDawg08a14422017-10-17 19:27:14 -0600541 ProcessBindingBase(argc, argv, glslang::EResUav);
John Kessenich6263fb12017-06-14 15:52:44 -0600542 } else if (lowerword == "shift-texture-bindings" || // synonyms
543 lowerword == "shift-texture-binding" ||
544 lowerword == "stb") {
LoopDawg08a14422017-10-17 19:27:14 -0600545 ProcessBindingBase(argc, argv, glslang::EResTexture);
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600546 } else if (lowerword == "shift-ubo-bindings" || // synonyms
547 lowerword == "shift-ubo-binding" ||
steve-lunargbe283552017-04-18 12:18:01 -0600548 lowerword == "shift-cbuffer-bindings" ||
549 lowerword == "shift-cbuffer-binding" ||
550 lowerword == "sub" ||
551 lowerword == "scb") {
LoopDawg08a14422017-10-17 19:27:14 -0600552 ProcessBindingBase(argc, argv, glslang::EResUbo);
steve-lunarg932bb5c2017-02-21 17:19:08 -0700553 } else if (lowerword == "shift-ssbo-bindings" || // synonyms
554 lowerword == "shift-ssbo-binding" ||
555 lowerword == "sbb") {
LoopDawg08a14422017-10-17 19:27:14 -0600556 ProcessBindingBase(argc, argv, glslang::EResSsbo);
John Kessenich6263fb12017-06-14 15:52:44 -0600557 } else if (lowerword == "source-entrypoint" || // synonyms
558 lowerword == "sep") {
John Kessenichc178f0a2017-06-23 10:58:31 -0600559 if (argc <= 1)
John Kessenich6263fb12017-06-14 15:52:44 -0600560 Error("no <entry-point> provided for --source-entrypoint");
John Kessenichc178f0a2017-06-23 10:58:31 -0600561 sourceEntryPointName = argv[1];
562 bumpArg();
John Kessenich6263fb12017-06-14 15:52:44 -0600563 break;
John Kesseniche2156222018-06-11 18:12:15 -0600564 } else if (lowerword == "spirv-dis") {
565 SpvToolsDisassembler = true;
John Kessenichc3404252018-08-23 15:29:08 -0600566 } else if (lowerword == "spirv-val") {
567 SpvToolsValidate = true;
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +0200568 } else if (lowerword == "stdin") {
569 Options |= EOptionStdin;
570 shaderStageName = argv[1];
John Kessenich2a271162017-07-20 20:00:36 -0600571 } else if (lowerword == "suppress-warnings") {
572 Options |= EOptionSuppressWarnings;
John Kessenich6353d552017-06-23 11:11:09 -0600573 } else if (lowerword == "target-env") {
574 if (argc > 1) {
575 if (strcmp(argv[1], "vulkan1.0") == 0) {
576 setVulkanSpv();
John Kessenich8717a5d2018-10-26 10:12:32 -0600577 ClientVersion = glslang::EShTargetVulkan_1_0;
John Kessenich66011cb2018-03-06 16:12:04 -0700578 } else if (strcmp(argv[1], "vulkan1.1") == 0) {
579 setVulkanSpv();
John Kessenich8717a5d2018-10-26 10:12:32 -0600580 ClientVersion = glslang::EShTargetVulkan_1_1;
John Kessenich6353d552017-06-23 11:11:09 -0600581 } else if (strcmp(argv[1], "opengl") == 0) {
582 setOpenGlSpv();
John Kessenich8717a5d2018-10-26 10:12:32 -0600583 ClientVersion = glslang::EShTargetOpenGL_450;
584 } else if (strcmp(argv[1], "spirv1.0") == 0) {
585 TargetLanguage = glslang::EShTargetSpv;
586 TargetVersion = glslang::EShTargetSpv_1_0;
587 } else if (strcmp(argv[1], "spirv1.1") == 0) {
588 TargetLanguage = glslang::EShTargetSpv;
589 TargetVersion = glslang::EShTargetSpv_1_1;
590 } else if (strcmp(argv[1], "spirv1.2") == 0) {
591 TargetLanguage = glslang::EShTargetSpv;
592 TargetVersion = glslang::EShTargetSpv_1_2;
593 } else if (strcmp(argv[1], "spirv1.3") == 0) {
594 TargetLanguage = glslang::EShTargetSpv;
595 TargetVersion = glslang::EShTargetSpv_1_3;
596 } else if (strcmp(argv[1], "spirv1.4") == 0) {
597 TargetLanguage = glslang::EShTargetSpv;
598 TargetVersion = glslang::EShTargetSpv_1_4;
John Kessenich6353d552017-06-23 11:11:09 -0600599 } else
John Kessenich8717a5d2018-10-26 10:12:32 -0600600 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 -0600601 }
602 bumpArg();
Flavio15017db2017-02-15 14:29:33 -0800603 } else if (lowerword == "variable-name" || // synonyms
John Kessenich66011cb2018-03-06 16:12:04 -0700604 lowerword == "vn") {
Flavio15017db2017-02-15 14:29:33 -0800605 Options |= EOptionOutputHexadecimal;
John Kessenichc178f0a2017-06-23 10:58:31 -0600606 if (argc <= 1)
Flavio15017db2017-02-15 14:29:33 -0800607 Error("no <C-variable-name> provided for --variable-name");
John Kessenichc178f0a2017-06-23 10:58:31 -0600608 variableName = argv[1];
609 bumpArg();
Flavio15017db2017-02-15 14:29:33 -0800610 break;
John Kessenichc6c80a62018-03-05 22:23:17 -0700611 } else if (lowerword == "version") {
612 Options |= EOptionDumpVersions;
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600613 } else {
614 usage();
615 }
616 }
617 break;
John Kessenich6263fb12017-06-14 15:52:44 -0600618 case 'C':
619 Options |= EOptionCascadingErrors;
620 break;
621 case 'D':
John Kessenicha9313662017-06-15 10:40:49 -0600622 if (argv[0][2] == 0)
623 Options |= EOptionReadHlsl;
624 else
625 UserPreamble.addDef(getStringOperand("-D<macro> macro name"));
John Kessenich6263fb12017-06-14 15:52:44 -0600626 break;
Neil Roberts16f53472018-03-20 17:30:53 +0100627 case 'u':
628 uniformLocationOverrides.push_back(getUniformOverride());
629 break;
John Kessenich6263fb12017-06-14 15:52:44 -0600630 case 'E':
631 Options |= EOptionOutputPreprocessed;
632 break;
633 case 'G':
John Kessenich8717a5d2018-10-26 10:12:32 -0600634 // OpenGL client
John Kessenich6353d552017-06-23 11:11:09 -0600635 setOpenGlSpv();
636 if (argv[0][2] != 0)
637 ClientInputSemanticsVersion = getAttachedNumber("-G<num> client input semantics");
John Kessenich6263fb12017-06-14 15:52:44 -0600638 break;
John Kessenich2aa7f3a2015-05-15 16:02:07 +0000639 case 'H':
640 Options |= EOptionHumanReadableSpv;
John Kessenich91e4aa52016-07-07 17:46:42 -0600641 if ((Options & EOptionSpv) == 0) {
642 // default to Vulkan
John Kessenich6353d552017-06-23 11:11:09 -0600643 setVulkanSpv();
John Kessenich91e4aa52016-07-07 17:46:42 -0600644 }
645 break;
John Kessenich971a0a82017-06-07 15:06:58 -0600646 case 'I':
John Kessenicha9313662017-06-15 10:40:49 -0600647 IncludeDirectoryList.push_back(getStringOperand("-I<dir> include path"));
John Kessenich68d78fd2015-07-12 19:28:10 -0600648 break;
GregFcd1f1692017-09-21 18:40:22 -0600649 case 'O':
650 if (argv[0][2] == 'd')
651 Options |= EOptionOptimizeDisable;
652 else if (argv[0][2] == 's')
GregFfb03a552018-03-29 11:49:14 -0600653#if ENABLE_OPT
GregFcd1f1692017-09-21 18:40:22 -0600654 Options |= EOptionOptimizeSize;
655#else
656 Error("-Os not available; optimizer not linked");
657#endif
658 else
659 Error("unknown -O option");
660 break;
Dan Baker5afdd782016-08-11 17:53:57 -0400661 case 'S':
John Kessenichc178f0a2017-06-23 10:58:31 -0600662 if (argc <= 1)
Dan Baker5afdd782016-08-11 17:53:57 -0400663 Error("no <stage> specified for -S");
John Kessenichc178f0a2017-06-23 10:58:31 -0600664 shaderStageName = argv[1];
665 bumpArg();
dankbaker45d49bc2016-08-08 21:43:07 -0400666 break;
John Kessenicha9313662017-06-15 10:40:49 -0600667 case 'U':
668 UserPreamble.addUndef(getStringOperand("-U<macro>: macro name"));
669 break;
John Kessenich6263fb12017-06-14 15:52:44 -0600670 case 'V':
John Kessenich6353d552017-06-23 11:11:09 -0600671 setVulkanSpv();
672 if (argv[0][2] != 0)
David Neto506d2c22018-02-27 21:55:23 -0500673 ClientInputSemanticsVersion = getAttachedNumber("-V<num> client input semantics");
John Kessenichc555ddd2015-06-17 02:38:44 +0000674 break;
John Kessenich05a70632013-09-17 19:26:08 +0000675 case 'c':
676 Options |= EOptionDumpConfig;
677 break;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000678 case 'd':
John Kessenichc6c80a62018-03-05 22:23:17 -0700679 if (strncmp(&argv[0][1], "dumpversion", strlen(&argv[0][1]) + 1) == 0 ||
680 strncmp(&argv[0][1], "dumpfullversion", strlen(&argv[0][1]) + 1) == 0)
681 Options |= EOptionDumpBareVersion;
682 else
683 Options |= EOptionDefaultDesktop;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000684 break;
John Kessenich4d65ee32016-03-12 18:17:47 -0700685 case 'e':
John Kessenich4d65ee32016-03-12 18:17:47 -0700686 entryPointName = argv[1];
John Kessenichc178f0a2017-06-23 10:58:31 -0600687 if (argc <= 1)
John Kessenicha25530c2017-09-11 20:13:49 -0600688 Error("no <name> provided for -e");
John Kessenichc178f0a2017-06-23 10:58:31 -0600689 bumpArg();
John Kessenich4d65ee32016-03-12 18:17:47 -0700690 break;
John Kessenich5d610ee2018-03-07 18:05:55 -0700691 case 'f':
692 if (strcmp(&argv[0][2], "hlsl_functionality1") == 0)
693 targetHlslFunctionality1 = true;
694 else
695 Error("-f: expected hlsl_functionality1");
696 break;
John Kessenich121853f2017-05-31 17:11:16 -0600697 case 'g':
698 Options |= EOptionDebug;
699 break;
John Kessenich68d78fd2015-07-12 19:28:10 -0600700 case 'h':
701 usage();
702 break;
John Kessenich05a70632013-09-17 19:26:08 +0000703 case 'i':
John Kessenich94a81fb2013-08-31 02:41:30 +0000704 Options |= EOptionIntermediate;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000705 break;
706 case 'l':
John Kessenichd78e3512014-08-25 20:07:55 +0000707 Options |= EOptionLinkProgram;
John Kessenich94a81fb2013-08-31 02:41:30 +0000708 break;
709 case 'm':
710 Options |= EOptionMemoryLeakMode;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000711 break;
John Kessenich68d78fd2015-07-12 19:28:10 -0600712 case 'o':
John Kessenichc178f0a2017-06-23 10:58:31 -0600713 if (argc <= 1)
John Kessenich68d78fd2015-07-12 19:28:10 -0600714 Error("no <file> provided for -o");
John Kessenichc178f0a2017-06-23 10:58:31 -0600715 binaryFileName = argv[1];
716 bumpArg();
John Kessenich68d78fd2015-07-12 19:28:10 -0600717 break;
John Kessenich11f9fc72013-11-07 01:06:34 +0000718 case 'q':
719 Options |= EOptionDumpReflection;
720 break;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000721 case 'r':
John Kessenich94a81fb2013-08-31 02:41:30 +0000722 Options |= EOptionRelaxedErrors;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000723 break;
724 case 's':
John Kessenich94a81fb2013-08-31 02:41:30 +0000725 Options |= EOptionSuppressInfolog;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000726 break;
John Kessenich38f3b892013-09-06 19:52:57 +0000727 case 't':
Juan Lopeza558b262017-04-02 23:04:00 +0200728 Options |= EOptionMultiThreaded;
John Kessenich38f3b892013-09-06 19:52:57 +0000729 break;
John Kessenich319de232013-12-04 04:43:40 +0000730 case 'v':
731 Options |= EOptionDumpVersions;
732 break;
John Kessenichb0a7eb52013-11-07 17:44:20 +0000733 case 'w':
734 Options |= EOptionSuppressWarnings;
735 break;
Johannes van Waverenecb0f3b2016-05-27 12:55:53 -0500736 case 'x':
737 Options |= EOptionOutputHexadecimal;
Johannes van Waverenecb0f3b2016-05-27 12:55:53 -0500738 break;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000739 default:
John Kessenich68d78fd2015-07-12 19:28:10 -0600740 usage();
741 break;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000742 }
John Kessenich38f3b892013-09-06 19:52:57 +0000743 } else {
John Kessenich05a70632013-09-17 19:26:08 +0000744 std::string name(argv[0]);
745 if (! SetConfigFile(name)) {
Juan Lopeza558b262017-04-02 23:04:00 +0200746 workItems.push_back(std::unique_ptr<glslang::TWorkItem>(new glslang::TWorkItem(name)));
John Kessenich05a70632013-09-17 19:26:08 +0000747 }
John Kessenich38f3b892013-09-06 19:52:57 +0000748 }
John Kessenich2b07c7e2013-07-31 18:44:13 +0000749 }
750
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +0200751 // Make sure that -S is always specified if --stdin is specified
752 if ((Options & EOptionStdin) && shaderStageName == nullptr)
753 Error("must provide -S when --stdin is given");
754
John Kessenich68d78fd2015-07-12 19:28:10 -0600755 // Make sure that -E is not specified alongside linking (which includes SPV generation)
756 if ((Options & EOptionOutputPreprocessed) && (Options & EOptionLinkProgram))
757 Error("can't use -E when linking is selected");
John Kessenichc555ddd2015-06-17 02:38:44 +0000758
Johannes van Waverenecb0f3b2016-05-27 12:55:53 -0500759 // -o or -x makes no sense if there is no target binary
John Kessenich68d78fd2015-07-12 19:28:10 -0600760 if (binaryFileName && (Options & EOptionSpv) == 0)
761 Error("no binary generation requested (e.g., -V)");
steve-lunarge0b9deb2016-09-16 13:26:37 -0600762
763 if ((Options & EOptionFlattenUniformArrays) != 0 &&
764 (Options & EOptionReadHlsl) == 0)
765 Error("uniform array flattening only valid when compiling HLSL source.");
John Kessenich8717a5d2018-10-26 10:12:32 -0600766
767 // rationalize client and target language
768 if (TargetLanguage == glslang::EShTargetNone) {
769 switch (ClientVersion) {
770 case glslang::EShTargetVulkan_1_0:
771 TargetLanguage = glslang::EShTargetSpv;
772 TargetVersion = glslang::EShTargetSpv_1_0;
773 break;
774 case glslang::EShTargetVulkan_1_1:
775 TargetLanguage = glslang::EShTargetSpv;
776 TargetVersion = glslang::EShTargetSpv_1_3;
777 break;
778 case glslang::EShTargetOpenGL_450:
779 TargetLanguage = glslang::EShTargetSpv;
780 TargetVersion = glslang::EShTargetSpv_1_0;
781 break;
782 default:
783 break;
784 }
785 }
786 if (TargetLanguage != glslang::EShTargetNone && Client == glslang::EShClientNone)
787 Error("To generate SPIR-V, also specify client semantics. See -G and -V.");
John Kessenich2b07c7e2013-07-31 18:44:13 +0000788}
789
John Kessenich68d78fd2015-07-12 19:28:10 -0600790//
791// Translate the meaningful subset of command-line options to parser-behavior options.
792//
John Kessenichb0a7eb52013-11-07 17:44:20 +0000793void SetMessageOptions(EShMessages& messages)
794{
795 if (Options & EOptionRelaxedErrors)
796 messages = (EShMessages)(messages | EShMsgRelaxedErrors);
797 if (Options & EOptionIntermediate)
798 messages = (EShMessages)(messages | EShMsgAST);
799 if (Options & EOptionSuppressWarnings)
800 messages = (EShMessages)(messages | EShMsgSuppressWarnings);
John Kessenich68d78fd2015-07-12 19:28:10 -0600801 if (Options & EOptionSpv)
802 messages = (EShMessages)(messages | EShMsgSpvRules);
803 if (Options & EOptionVulkanRules)
804 messages = (EShMessages)(messages | EShMsgVulkanRules);
Andrew Woloszynaae1ad82015-06-24 17:00:46 -0400805 if (Options & EOptionOutputPreprocessed)
806 messages = (EShMessages)(messages | EShMsgOnlyPreprocessor);
John Kessenich66e2faf2016-03-12 18:34:36 -0700807 if (Options & EOptionReadHlsl)
808 messages = (EShMessages)(messages | EShMsgReadHlsl);
John Kessenicha86836e2016-07-09 14:50:57 -0600809 if (Options & EOptionCascadingErrors)
810 messages = (EShMessages)(messages | EShMsgCascadingErrors);
John Kessenich906cc212016-12-09 19:22:20 -0700811 if (Options & EOptionKeepUncalled)
812 messages = (EShMessages)(messages | EShMsgKeepUncalled);
John Kessenich4f1403e2017-04-05 17:38:20 -0600813 if (Options & EOptionHlslOffsets)
814 messages = (EShMessages)(messages | EShMsgHlslOffsets);
John Kessenich121853f2017-05-31 17:11:16 -0600815 if (Options & EOptionDebug)
816 messages = (EShMessages)(messages | EShMsgDebugInfo);
Rex Xucb61eec2018-03-07 13:10:01 +0800817 if (HlslEnable16BitTypes)
818 messages = (EShMessages)(messages | EShMsgHlslEnable16BitTypes);
GregFfb03a552018-03-29 11:49:14 -0600819 if ((Options & EOptionOptimizeDisable) || !ENABLE_OPT)
820 messages = (EShMessages)(messages | EShMsgHlslLegalization);
John Kessenichbd1c1832018-12-07 18:38:26 -0700821 if (HlslDX9compatible)
822 messages = (EShMessages)(messages | EShMsgHlslDX9Compatible);
John Kessenichb0a7eb52013-11-07 17:44:20 +0000823}
824
John Kessenich68d78fd2015-07-12 19:28:10 -0600825//
John Kessenich69f4b512013-09-04 21:19:27 +0000826// Thread entry point, for non-linking asynchronous mode.
John Kessenichc999ba22013-11-07 23:33:24 +0000827//
Juan Lopeza558b262017-04-02 23:04:00 +0200828void CompileShaders(glslang::TWorklist& worklist)
John Kessenich2b07c7e2013-07-31 18:44:13 +0000829{
John Kessenich7f0bcfd2018-04-05 19:00:01 -0600830 if (Options & EOptionDebug)
831 Error("cannot generate debug information unless linking to generate code");
832
John Kessenich38f3b892013-09-06 19:52:57 +0000833 glslang::TWorkItem* workItem;
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +0200834 if (Options & EOptionStdin) {
John Kesseniche7f9cae2018-07-12 15:11:07 -0600835 if (worklist.remove(workItem)) {
836 ShHandle compiler = ShConstructCompiler(FindLanguage("stdin"), Options);
837 if (compiler == nullptr)
838 return;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000839
John Kesseniche7f9cae2018-07-12 15:11:07 -0600840 CompileFile("stdin", compiler);
John Kessenich2b07c7e2013-07-31 18:44:13 +0000841
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +0200842 if (! (Options & EOptionSuppressInfolog))
843 workItem->results = ShGetInfoLog(compiler);
John Kessenich2b07c7e2013-07-31 18:44:13 +0000844
John Kesseniche7f9cae2018-07-12 15:11:07 -0600845 ShDestruct(compiler);
846 }
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +0200847 } else {
848 while (worklist.remove(workItem)) {
849 ShHandle compiler = ShConstructCompiler(FindLanguage(workItem->name), Options);
850 if (compiler == 0)
851 return;
852
853 CompileFile(workItem->name.c_str(), compiler);
854
855 if (! (Options & EOptionSuppressInfolog))
856 workItem->results = ShGetInfoLog(compiler);
857
858 ShDestruct(compiler);
859 }
John Kessenich2b07c7e2013-07-31 18:44:13 +0000860 }
John Kessenich2b07c7e2013-07-31 18:44:13 +0000861}
862
John Kessenich6626cad2015-06-19 05:14:19 +0000863// Outputs the given string, but only if it is non-null and non-empty.
864// This prevents erroneous newlines from appearing.
Andrew Woloszynaae1ad82015-06-24 17:00:46 -0400865void PutsIfNonEmpty(const char* str)
John Kessenich6626cad2015-06-19 05:14:19 +0000866{
867 if (str && str[0]) {
868 puts(str);
869 }
870}
871
Andrew Woloszynaae1ad82015-06-24 17:00:46 -0400872// Outputs the given string to stderr, but only if it is non-null and non-empty.
873// This prevents erroneous newlines from appearing.
874void StderrIfNonEmpty(const char* str)
875{
John Kessenich04acb1b2017-06-14 17:36:50 -0600876 if (str && str[0])
877 fprintf(stderr, "%s\n", str);
Andrew Woloszynaae1ad82015-06-24 17:00:46 -0400878}
879
John Kessenichc57b2a92016-01-16 15:30:03 -0700880// Simple bundling of what makes a compilation unit for ease in passing around,
881// and separation of handling file IO versus API (programmatic) compilation.
882struct ShaderCompUnit {
883 EShLanguage stage;
John Kessenich04acb1b2017-06-14 17:36:50 -0600884 static const int maxCount = 1;
885 int count; // live number of strings/names
John Kessenicha9313662017-06-15 10:40:49 -0600886 const char* text[maxCount]; // memory owned/managed externally
John Kessenich04acb1b2017-06-14 17:36:50 -0600887 std::string fileName[maxCount]; // hold's the memory, but...
888 const char* fileNameList[maxCount]; // downstream interface wants pointers
dankbakerafe6e9c2016-08-21 12:29:08 -0400889
John Kessenich04acb1b2017-06-14 17:36:50 -0600890 ShaderCompUnit(EShLanguage stage) : stage(stage), count(0) { }
dankbakerafe6e9c2016-08-21 12:29:08 -0400891
John Kessenich04acb1b2017-06-14 17:36:50 -0600892 ShaderCompUnit(const ShaderCompUnit& rhs)
dankbakerafe6e9c2016-08-21 12:29:08 -0400893 {
894 stage = rhs.stage;
John Kessenich04acb1b2017-06-14 17:36:50 -0600895 count = rhs.count;
896 for (int i = 0; i < count; ++i) {
897 fileName[i] = rhs.fileName[i];
898 text[i] = rhs.text[i];
899 fileNameList[i] = rhs.fileName[i].c_str();
900 }
dankbakerafe6e9c2016-08-21 12:29:08 -0400901 }
902
John Kessenicha9313662017-06-15 10:40:49 -0600903 void addString(std::string& ifileName, const char* itext)
John Kessenich04acb1b2017-06-14 17:36:50 -0600904 {
905 assert(count < maxCount);
906 fileName[count] = ifileName;
907 text[count] = itext;
908 fileNameList[count] = fileName[count].c_str();
909 ++count;
910 }
John Kessenichc57b2a92016-01-16 15:30:03 -0700911};
912
John Kessenich69f4b512013-09-04 21:19:27 +0000913//
John Kessenichc57b2a92016-01-16 15:30:03 -0700914// For linking mode: Will independently parse each compilation unit, but then put them
915// in the same program and link them together, making at most one linked module per
916// pipeline stage.
John Kessenich69f4b512013-09-04 21:19:27 +0000917//
918// Uses the new C++ interface instead of the old handle-based interface.
919//
John Kessenichc57b2a92016-01-16 15:30:03 -0700920
921void CompileAndLinkShaderUnits(std::vector<ShaderCompUnit> compUnits)
John Kessenich69f4b512013-09-04 21:19:27 +0000922{
923 // keep track of what to free
924 std::list<glslang::TShader*> shaders;
John Kessenichc57b2a92016-01-16 15:30:03 -0700925
John Kessenich69f4b512013-09-04 21:19:27 +0000926 EShMessages messages = EShMsgDefault;
John Kessenichb0a7eb52013-11-07 17:44:20 +0000927 SetMessageOptions(messages);
John Kessenich69f4b512013-09-04 21:19:27 +0000928
John Kessenich69f4b512013-09-04 21:19:27 +0000929 //
930 // Per-shader processing...
931 //
932
John Kessenich5b0f13a2013-11-01 03:08:40 +0000933 glslang::TProgram& program = *new glslang::TProgram;
rdb32084e82016-02-23 22:17:38 +0100934 for (auto it = compUnits.cbegin(); it != compUnits.cend(); ++it) {
935 const auto &compUnit = *it;
John Kessenichc57b2a92016-01-16 15:30:03 -0700936 glslang::TShader* shader = new glslang::TShader(compUnit.stage);
John Kessenich04acb1b2017-06-14 17:36:50 -0600937 shader->setStringsWithLengthsAndNames(compUnit.text, NULL, compUnit.fileNameList, compUnit.count);
John Kessenich640bd092018-08-09 14:15:00 -0600938 if (entryPointName)
John Kessenich4d65ee32016-03-12 18:17:47 -0700939 shader->setEntryPoint(entryPointName);
John Kessenich3693e632017-09-29 17:51:52 -0600940 if (sourceEntryPointName) {
941 if (entryPointName == nullptr)
942 printf("Warning: Changing source entry point name without setting an entry-point name.\n"
943 "Use '-e <name>'.\n");
steve-lunargf1e0c872016-10-31 15:13:43 -0600944 shader->setSourceEntryPoint(sourceEntryPointName);
John Kessenich3693e632017-09-29 17:51:52 -0600945 }
John Kessenicha9313662017-06-15 10:40:49 -0600946 if (UserPreamble.isSet())
947 shader->setPreamble(UserPreamble.get());
John Kessenich2a271162017-07-20 20:00:36 -0600948 shader->addProcesses(Processes);
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600949
LoopDawg08a14422017-10-17 19:27:14 -0600950 // Set IO mapper binding shift values
951 for (int r = 0; r < glslang::EResCount; ++r) {
952 const glslang::TResourceType res = glslang::TResourceType(r);
953
954 // Set base bindings
955 shader->setShiftBinding(res, baseBinding[res][compUnit.stage]);
956
957 // Set bindings for particular resource sets
958 // TODO: use a range based for loop here, when available in all environments.
959 for (auto i = baseBindingForSet[res][compUnit.stage].begin();
960 i != baseBindingForSet[res][compUnit.stage].end(); ++i)
LoopDawge5709552017-10-21 10:46:39 -0600961 shader->setShiftBindingForSet(res, i->second, i->first);
LoopDawg08a14422017-10-17 19:27:14 -0600962 }
963
steve-lunarge0b9deb2016-09-16 13:26:37 -0600964 shader->setFlattenUniformArrays((Options & EOptionFlattenUniformArrays) != 0);
steve-lunargcce8d482016-10-14 18:36:42 -0600965 shader->setNoStorageFormat((Options & EOptionNoStorageFormat) != 0);
Hyangran Park36dc8292017-05-02 16:27:29 +0900966 shader->setResourceSetBinding(baseResourceSetBinding[compUnit.stage]);
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600967
steve-lunargbe283552017-04-18 12:18:01 -0600968 if (Options & EOptionHlslIoMapping)
969 shader->setHlslIoMapping(true);
970
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600971 if (Options & EOptionAutoMapBindings)
972 shader->setAutoMapBindings(true);
John Kessenichecba76f2017-01-06 00:34:48 -0700973
John Kessenich71facdf2017-05-17 18:28:19 -0600974 if (Options & EOptionAutoMapLocations)
975 shader->setAutoMapLocations(true);
976
LoopDawgb22c0692017-12-06 16:52:03 -0700977 if (Options & EOptionInvertY)
978 shader->setInvertY(true);
979
Neil Roberts16f53472018-03-20 17:30:53 +0100980 for (auto& uniOverride : uniformLocationOverrides) {
981 shader->addUniformLocationOverride(uniOverride.first.c_str(),
982 uniOverride.second);
983 }
984
Neil Robertsb0f3d792018-03-20 17:41:05 +0100985 shader->setUniformLocationBase(uniformBase);
986
John Kessenich4be4aeb2017-06-23 10:50:22 -0600987 // Set up the environment, some subsettings take precedence over earlier
988 // ways of setting things.
989 if (Options & EOptionSpv) {
John Kessenich8717a5d2018-10-26 10:12:32 -0600990 shader->setEnvInput((Options & EOptionReadHlsl) ? glslang::EShSourceHlsl
991 : glslang::EShSourceGlsl,
992 compUnit.stage, Client, ClientInputSemanticsVersion);
993 shader->setEnvClient(Client, ClientVersion);
994 shader->setEnvTarget(TargetLanguage, TargetVersion);
John Kessenich5d610ee2018-03-07 18:05:55 -0700995 if (targetHlslFunctionality1)
996 shader->setEnvTargetHlslFunctionality1();
John Kessenich4be4aeb2017-06-23 10:50:22 -0600997 }
998
John Kessenich69f4b512013-09-04 21:19:27 +0000999 shaders.push_back(shader);
John Kessenichb3297152015-07-11 18:01:03 -06001000
John Kessenich4be4aeb2017-06-23 10:50:22 -06001001 const int defaultVersion = Options & EOptionDefaultDesktop ? 110 : 100;
John Kessenich69f4b512013-09-04 21:19:27 +00001002
John Kessenich3494b4d2017-05-22 15:00:42 -06001003 DirStackFileIncluder includer;
John Kessenich971a0a82017-06-07 15:06:58 -06001004 std::for_each(IncludeDirectoryList.rbegin(), IncludeDirectoryList.rend(), [&includer](const std::string& dir) {
1005 includer.pushExternalLocalDirectory(dir); });
John Kessenichc555ddd2015-06-17 02:38:44 +00001006 if (Options & EOptionOutputPreprocessed) {
1007 std::string str;
John Kessenich086febc2018-10-25 12:43:02 -06001008 if (shader->preprocess(&Resources, defaultVersion, ENoProfile, false, false, messages, &str, includer)) {
Andrew Woloszynaae1ad82015-06-24 17:00:46 -04001009 PutsIfNonEmpty(str.c_str());
1010 } else {
1011 CompileFailed = true;
1012 }
1013 StderrIfNonEmpty(shader->getInfoLog());
1014 StderrIfNonEmpty(shader->getInfoDebugLog());
John Kessenichc555ddd2015-06-17 02:38:44 +00001015 continue;
1016 }
John Kessenich086febc2018-10-25 12:43:02 -06001017
John Kessenich3494b4d2017-05-22 15:00:42 -06001018 if (! shader->parse(&Resources, defaultVersion, false, messages, includer))
John Kessenichc999ba22013-11-07 23:33:24 +00001019 CompileFailed = true;
John Kessenichc555ddd2015-06-17 02:38:44 +00001020
John Kessenich69f4b512013-09-04 21:19:27 +00001021 program.addShader(shader);
1022
John Kessenichc57b2a92016-01-16 15:30:03 -07001023 if (! (Options & EOptionSuppressInfolog) &&
1024 ! (Options & EOptionMemoryLeakMode)) {
John Kessenich04acb1b2017-06-14 17:36:50 -06001025 PutsIfNonEmpty(compUnit.fileName[0].c_str());
Andrew Woloszynaae1ad82015-06-24 17:00:46 -04001026 PutsIfNonEmpty(shader->getInfoLog());
1027 PutsIfNonEmpty(shader->getInfoDebugLog());
John Kessenich69f4b512013-09-04 21:19:27 +00001028 }
John Kessenich69f4b512013-09-04 21:19:27 +00001029 }
1030
1031 //
1032 // Program-level processing...
1033 //
1034
John Kessenich4d65ee32016-03-12 18:17:47 -07001035 // Link
John Kessenich68d78fd2015-07-12 19:28:10 -06001036 if (! (Options & EOptionOutputPreprocessed) && ! program.link(messages))
John Kessenichc999ba22013-11-07 23:33:24 +00001037 LinkFailed = true;
1038
steve-lunarg9ae34742016-10-05 13:40:13 -06001039 // Map IO
1040 if (Options & EOptionSpv) {
1041 if (!program.mapIO())
1042 LinkFailed = true;
1043 }
John Kessenichecba76f2017-01-06 00:34:48 -07001044
John Kessenich4d65ee32016-03-12 18:17:47 -07001045 // Report
John Kessenichc57b2a92016-01-16 15:30:03 -07001046 if (! (Options & EOptionSuppressInfolog) &&
1047 ! (Options & EOptionMemoryLeakMode)) {
Andrew Woloszynaae1ad82015-06-24 17:00:46 -04001048 PutsIfNonEmpty(program.getInfoLog());
1049 PutsIfNonEmpty(program.getInfoDebugLog());
John Kessenich69f4b512013-09-04 21:19:27 +00001050 }
1051
John Kessenich4d65ee32016-03-12 18:17:47 -07001052 // Reflect
John Kessenich11f9fc72013-11-07 01:06:34 +00001053 if (Options & EOptionDumpReflection) {
1054 program.buildReflection();
1055 program.dumpReflection();
1056 }
1057
John Kessenich4d65ee32016-03-12 18:17:47 -07001058 // Dump SPIR-V
John Kessenich0df0cde2015-03-03 17:09:43 +00001059 if (Options & EOptionSpv) {
John Kessenich92f90382014-07-28 04:21:04 +00001060 if (CompileFailed || LinkFailed)
John Kessenich68d78fd2015-07-12 19:28:10 -06001061 printf("SPIR-V is not generated for failed compile or link\n");
John Kessenich92f90382014-07-28 04:21:04 +00001062 else {
1063 for (int stage = 0; stage < EShLangCount; ++stage) {
John Kessenicha7a68a92014-08-24 18:21:00 +00001064 if (program.getIntermediate((EShLanguage)stage)) {
John Kessenich0df0cde2015-03-03 17:09:43 +00001065 std::vector<unsigned int> spirv;
Lei Zhang09caf122016-05-02 18:11:54 -04001066 std::string warningsErrors;
Lei Zhang17535f72016-05-04 15:55:59 -04001067 spv::SpvBuildLogger logger;
John Kessenich121853f2017-05-31 17:11:16 -06001068 glslang::SpvOptions spvOptions;
1069 if (Options & EOptionDebug)
1070 spvOptions.generateDebugInfo = true;
GregF52fe3d52017-09-28 10:08:32 -06001071 spvOptions.disableOptimizer = (Options & EOptionOptimizeDisable) != 0;
1072 spvOptions.optimizeSize = (Options & EOptionOptimizeSize) != 0;
John Kessenich717c80a2018-08-23 15:17:10 -06001073 spvOptions.disassemble = SpvToolsDisassembler;
John Kessenichc3404252018-08-23 15:29:08 -06001074 spvOptions.validate = SpvToolsValidate;
John Kessenich121853f2017-05-31 17:11:16 -06001075 glslang::GlslangToSpv(*program.getIntermediate((EShLanguage)stage), spirv, &logger, &spvOptions);
John Kessenichc57b2a92016-01-16 15:30:03 -07001076
1077 // Dump the spv to a file or stdout, etc., but only if not doing
1078 // memory/perf testing, as it's not internal to programmatic use.
1079 if (! (Options & EOptionMemoryLeakMode)) {
Johannes van Waverenecb0f3b2016-05-27 12:55:53 -05001080 printf("%s", logger.getAllMessages().c_str());
1081 if (Options & EOptionOutputHexadecimal) {
John Kessenich8f674e82017-02-18 09:45:40 -07001082 glslang::OutputSpvHex(spirv, GetBinaryName((EShLanguage)stage), variableName);
Johannes van Waverenecb0f3b2016-05-27 12:55:53 -05001083 } else {
1084 glslang::OutputSpvBin(spirv, GetBinaryName((EShLanguage)stage));
1085 }
John Kesseniche2156222018-06-11 18:12:15 -06001086 if (!SpvToolsDisassembler && (Options & EOptionHumanReadableSpv))
John Kessenichc57b2a92016-01-16 15:30:03 -07001087 spv::Disassemble(std::cout, spirv);
John Kessenichacba7722015-03-04 03:48:38 +00001088 }
John Kessenicha7a68a92014-08-24 18:21:00 +00001089 }
John Kessenich92f90382014-07-28 04:21:04 +00001090 }
1091 }
1092 }
1093
John Kessenich5b0f13a2013-11-01 03:08:40 +00001094 // Free everything up, program has to go before the shaders
1095 // because it might have merged stuff from the shaders, and
1096 // the stuff from the shaders has to have its destructors called
1097 // before the pools holding the memory in the shaders is freed.
1098 delete &program;
John Kessenich69f4b512013-09-04 21:19:27 +00001099 while (shaders.size() > 0) {
1100 delete shaders.back();
1101 shaders.pop_back();
1102 }
John Kessenich69f4b512013-09-04 21:19:27 +00001103}
1104
John Kessenichc57b2a92016-01-16 15:30:03 -07001105//
1106// Do file IO part of compile and link, handing off the pure
1107// API/programmatic mode to CompileAndLinkShaderUnits(), which can
1108// be put in a loop for testing memory footprint and performance.
1109//
1110// This is just for linking mode: meaning all the shaders will be put into the
1111// the same program linked together.
1112//
1113// This means there are a limited number of work items (not multi-threading mode)
1114// and that the point is testing at the linking level. Hence, to enable
1115// performance and memory testing, the actual compile/link can be put in
1116// a loop, independent of processing the work items and file IO.
1117//
Juan Lopeza558b262017-04-02 23:04:00 +02001118void CompileAndLinkShaderFiles(glslang::TWorklist& Worklist)
John Kessenichc57b2a92016-01-16 15:30:03 -07001119{
1120 std::vector<ShaderCompUnit> compUnits;
1121
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001122 // If this is using stdin, we can't really detect multiple different file
1123 // units by input type. We need to assume that we're just being given one
1124 // file of a certain type.
1125 if ((Options & EOptionStdin) != 0) {
1126 ShaderCompUnit compUnit(FindLanguage("stdin"));
1127 std::istreambuf_iterator<char> begin(std::cin), end;
1128 std::string tempString(begin, end);
1129 char* fileText = strdup(tempString.c_str());
1130 std::string fileName = "stdin";
1131 compUnit.addString(fileName, fileText);
John Kessenichc57b2a92016-01-16 15:30:03 -07001132 compUnits.push_back(compUnit);
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001133 } else {
1134 // Transfer all the work items from to a simple list of
1135 // of compilation units. (We don't care about the thread
1136 // work-item distribution properties in this path, which
1137 // is okay due to the limited number of shaders, know since
1138 // they are all getting linked together.)
1139 glslang::TWorkItem* workItem;
1140 while (Worklist.remove(workItem)) {
1141 ShaderCompUnit compUnit(FindLanguage(workItem->name));
1142 char* fileText = ReadFileData(workItem->name.c_str());
1143 if (fileText == nullptr)
1144 usage();
1145 compUnit.addString(workItem->name, fileText);
1146 compUnits.push_back(compUnit);
1147 }
John Kessenichc57b2a92016-01-16 15:30:03 -07001148 }
1149
1150 // Actual call to programmatic processing of compile and link,
1151 // in a loop for testing memory and performance. This part contains
1152 // all the perf/memory that a programmatic consumer will care about.
1153 for (int i = 0; i < ((Options & EOptionMemoryLeakMode) ? 100 : 1); ++i) {
1154 for (int j = 0; j < ((Options & EOptionMemoryLeakMode) ? 100 : 1); ++j)
1155 CompileAndLinkShaderUnits(compUnits);
1156
1157 if (Options & EOptionMemoryLeakMode)
1158 glslang::OS_DumpMemoryCounters();
1159 }
1160
John Kessenicha9313662017-06-15 10:40:49 -06001161 // free memory from ReadFileData, which got stored in a const char*
1162 // as the first string above
rdb32084e82016-02-23 22:17:38 +01001163 for (auto it = compUnits.begin(); it != compUnits.end(); ++it)
John Kessenicha9313662017-06-15 10:40:49 -06001164 FreeFileData(const_cast<char*>(it->text[0]));
John Kessenichc57b2a92016-01-16 15:30:03 -07001165}
1166
John Kessenich94f28eb2017-11-13 01:32:06 -07001167int singleMain()
John Kessenicha0af4732012-12-12 21:15:54 +00001168{
Juan Lopeza558b262017-04-02 23:04:00 +02001169 glslang::TWorklist workList;
John Kessenich94f28eb2017-11-13 01:32:06 -07001170 std::for_each(WorkItems.begin(), WorkItems.end(), [&workList](std::unique_ptr<glslang::TWorkItem>& item) {
Juan Lopeza558b262017-04-02 23:04:00 +02001171 assert(item);
1172 workList.add(item.get());
1173 });
John Kessenich2b07c7e2013-07-31 18:44:13 +00001174
John Kessenich05a70632013-09-17 19:26:08 +00001175 if (Options & EOptionDumpConfig) {
Lei Zhang414eb602016-03-04 16:22:34 -05001176 printf("%s", glslang::GetDefaultTBuiltInResourceString().c_str());
Juan Lopeza558b262017-04-02 23:04:00 +02001177 if (workList.empty())
John Kessenich05a70632013-09-17 19:26:08 +00001178 return ESuccess;
1179 }
1180
John Kessenichc6c80a62018-03-05 22:23:17 -07001181 if (Options & EOptionDumpBareVersion) {
1182 printf("%d.%d.%d\n",
1183 glslang::GetSpirvGeneratorVersion(), GLSLANG_MINOR_VERSION, GLSLANG_PATCH_LEVEL);
1184 if (workList.empty())
1185 return ESuccess;
1186 } else if (Options & EOptionDumpVersions) {
1187 printf("Glslang Version: %d.%d.%d\n",
1188 glslang::GetSpirvGeneratorVersion(), GLSLANG_MINOR_VERSION, GLSLANG_PATCH_LEVEL);
John Kessenich319de232013-12-04 04:43:40 +00001189 printf("ESSL Version: %s\n", glslang::GetEsslVersionString());
1190 printf("GLSL Version: %s\n", glslang::GetGlslVersionString());
John Kessenich68d78fd2015-07-12 19:28:10 -06001191 std::string spirvVersion;
1192 glslang::GetSpirvVersion(spirvVersion);
John Kessenich0da9eaa2015-08-01 17:10:02 -06001193 printf("SPIR-V Version %s\n", spirvVersion.c_str());
John Kessenich5e4b1242015-08-06 22:53:06 -06001194 printf("GLSL.std.450 Version %d, Revision %d\n", GLSLstd450Version, GLSLstd450Revision);
John Kessenich55e7d112015-11-15 21:33:39 -07001195 printf("Khronos Tool ID %d\n", glslang::GetKhronosToolId());
John Kessenicha372a3e2017-11-02 22:32:14 -06001196 printf("SPIR-V Generator Version %d\n", glslang::GetSpirvGeneratorVersion());
John Kessenichb84313d2016-07-20 16:03:29 -06001197 printf("GL_KHR_vulkan_glsl version %d\n", 100);
1198 printf("ARB_GL_gl_spirv version %d\n", 100);
Juan Lopeza558b262017-04-02 23:04:00 +02001199 if (workList.empty())
John Kessenich319de232013-12-04 04:43:40 +00001200 return ESuccess;
1201 }
1202
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001203 if (workList.empty() && ((Options & EOptionStdin) == 0)) {
John Kessenich05a70632013-09-17 19:26:08 +00001204 usage();
John Kessenich05a70632013-09-17 19:26:08 +00001205 }
1206
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001207 if (Options & EOptionStdin) {
John Kessenich94f28eb2017-11-13 01:32:06 -07001208 WorkItems.push_back(std::unique_ptr<glslang::TWorkItem>{new glslang::TWorkItem("stdin")});
1209 workList.add(WorkItems.back().get());
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001210 }
1211
John Kessenich05a70632013-09-17 19:26:08 +00001212 ProcessConfigFile();
1213
John Kessenich086febc2018-10-25 12:43:02 -06001214 if ((Options & EOptionReadHlsl) && !((Options & EOptionOutputPreprocessed) || (Options & EOptionSpv)))
1215 Error("ERROR: HLSL requires SPIR-V code generation (or preprocessing only)");
1216
John Kessenich69f4b512013-09-04 21:19:27 +00001217 //
1218 // Two modes:
John Kessenich38f3b892013-09-06 19:52:57 +00001219 // 1) linking all arguments together, single-threaded, new C++ interface
1220 // 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 +00001221 //
John Kessenich086febc2018-10-25 12:43:02 -06001222 if (Options & (EOptionLinkProgram | EOptionOutputPreprocessed)) {
John Kessenichc36e1d82013-11-01 17:41:52 +00001223 glslang::InitializeProcess();
John Kesseniche2c15b42017-11-16 22:48:41 -07001224 glslang::InitializeProcess(); // also test reference counting of users
1225 glslang::InitializeProcess(); // also test reference counting of users
1226 glslang::FinalizeProcess(); // also test reference counting of users
1227 glslang::FinalizeProcess(); // also test reference counting of users
Juan Lopeza558b262017-04-02 23:04:00 +02001228 CompileAndLinkShaderFiles(workList);
John Kessenichc36e1d82013-11-01 17:41:52 +00001229 glslang::FinalizeProcess();
1230 } else {
1231 ShInitialize();
John Kesseniche2c15b42017-11-16 22:48:41 -07001232 ShInitialize(); // also test reference counting of users
1233 ShFinalize(); // also test reference counting of users
John Kessenichc36e1d82013-11-01 17:41:52 +00001234
Juan Lopeza558b262017-04-02 23:04:00 +02001235 bool printShaderNames = workList.size() > 1;
John Kessenich69f4b512013-09-04 21:19:27 +00001236
John Kesseniche2c15b42017-11-16 22:48:41 -07001237 if (Options & EOptionMultiThreaded) {
Juan Lopeza558b262017-04-02 23:04:00 +02001238 std::array<std::thread, 16> threads;
John Kesseniche2c15b42017-11-16 22:48:41 -07001239 for (unsigned int t = 0; t < threads.size(); ++t) {
Juan Lopeza558b262017-04-02 23:04:00 +02001240 threads[t] = std::thread(CompileShaders, std::ref(workList));
John Kesseniche2c15b42017-11-16 22:48:41 -07001241 if (threads[t].get_id() == std::thread::id()) {
John Kessenichaf527992017-11-02 22:48:15 -06001242 fprintf(stderr, "Failed to create thread\n");
John Kessenich38f3b892013-09-06 19:52:57 +00001243 return EFailThreadCreate;
1244 }
John Kessenicha0af4732012-12-12 21:15:54 +00001245 }
Juan Lopeza558b262017-04-02 23:04:00 +02001246
1247 std::for_each(threads.begin(), threads.end(), [](std::thread& t) { t.join(); });
John Kessenichc999ba22013-11-07 23:33:24 +00001248 } else
Juan Lopeza558b262017-04-02 23:04:00 +02001249 CompileShaders(workList);
John Kessenich38f3b892013-09-06 19:52:57 +00001250
1251 // Print out all the resulting infologs
John Kessenich94f28eb2017-11-13 01:32:06 -07001252 for (size_t w = 0; w < WorkItems.size(); ++w) {
1253 if (WorkItems[w]) {
1254 if (printShaderNames || WorkItems[w]->results.size() > 0)
1255 PutsIfNonEmpty(WorkItems[w]->name.c_str());
1256 PutsIfNonEmpty(WorkItems[w]->results.c_str());
John Kessenich38f3b892013-09-06 19:52:57 +00001257 }
1258 }
John Kessenichc36e1d82013-11-01 17:41:52 +00001259
1260 ShFinalize();
John Kessenicha0af4732012-12-12 21:15:54 +00001261 }
John Kessenich2b07c7e2013-07-31 18:44:13 +00001262
John Kessenichc999ba22013-11-07 23:33:24 +00001263 if (CompileFailed)
John Kessenicha0af4732012-12-12 21:15:54 +00001264 return EFailCompile;
John Kessenichc999ba22013-11-07 23:33:24 +00001265 if (LinkFailed)
John Kessenicha0af4732012-12-12 21:15:54 +00001266 return EFailLink;
1267
1268 return 0;
1269}
1270
John Kessenich94f28eb2017-11-13 01:32:06 -07001271int C_DECL main(int argc, char* argv[])
1272{
1273 ProcessArguments(WorkItems, argc, argv);
1274
1275 int ret = 0;
1276
1277 // Loop over the entire init/finalize cycle to watch memory changes
1278 const int iterations = 1;
1279 if (iterations > 1)
1280 glslang::OS_DumpMemoryCounters();
1281 for (int i = 0; i < iterations; ++i) {
1282 ret = singleMain();
1283 if (iterations > 1)
1284 glslang::OS_DumpMemoryCounters();
1285 }
1286
1287 return ret;
1288}
1289
John Kessenicha0af4732012-12-12 21:15:54 +00001290//
1291// Deduce the language from the filename. Files must end in one of the
1292// following extensions:
1293//
John Kessenich2b07c7e2013-07-31 18:44:13 +00001294// .vert = vertex
1295// .tesc = tessellation control
1296// .tese = tessellation evaluation
1297// .geom = geometry
1298// .frag = fragment
John Kessenich94a81fb2013-08-31 02:41:30 +00001299// .comp = compute
Chao Chenb50c02e2018-09-19 11:42:24 -07001300// .rgen = ray generation
1301// .rint = ray intersection
1302// .rahit = ray any hit
1303// .rchit = ray closest hit
1304// .rmiss = ray miss
1305// .rcall = ray callable
Sahil Parmar035cbbe2018-10-04 16:39:18 -07001306// .mesh = mesh
1307// .task = task
Grigory Dzhavadyan33507412018-04-12 14:35:24 -07001308// Additionally, the file names may end in .<stage>.glsl and .<stage>.hlsl
1309// where <stage> is one of the stages listed above.
1310//
1311EShLanguage FindLanguage(const std::string& name, bool parseStageName)
John Kessenicha0af4732012-12-12 21:15:54 +00001312{
John Kessenichfccbb8b2018-04-17 17:24:03 -06001313 std::string stageName;
Dan Bakerc6ede892016-08-11 14:06:06 -04001314 if (shaderStageName)
John Kessenichfccbb8b2018-04-17 17:24:03 -06001315 stageName = shaderStageName;
1316 else if (parseStageName) {
Grigory Dzhavadyan33507412018-04-12 14:35:24 -07001317 // Note: "first" extension means "first from the end", i.e.
1318 // if the file is named foo.vert.glsl, then "glsl" is first,
1319 // "vert" is second.
John Kessenichfccbb8b2018-04-17 17:24:03 -06001320 size_t firstExtStart = name.find_last_of(".");
1321 bool hasFirstExt = firstExtStart != std::string::npos;
1322 size_t secondExtStart = hasFirstExt ? name.find_last_of(".", firstExtStart - 1) : std::string::npos;
1323 bool hasSecondExt = secondExtStart != std::string::npos;
1324 std::string firstExt = name.substr(firstExtStart + 1, std::string::npos);
1325 bool usesUnifiedExt = hasFirstExt && (firstExt == "glsl" || firstExt == "hlsl");
John Kessenich3beac942018-04-17 21:02:19 -06001326 if (usesUnifiedExt && firstExt == "hlsl")
1327 Options |= EOptionReadHlsl;
1328 if (hasFirstExt && !usesUnifiedExt)
John Kessenichfccbb8b2018-04-17 17:24:03 -06001329 stageName = firstExt;
John Kessenich3beac942018-04-17 21:02:19 -06001330 else if (usesUnifiedExt && hasSecondExt)
John Kessenichfccbb8b2018-04-17 17:24:03 -06001331 stageName = name.substr(secondExtStart + 1, firstExtStart - secondExtStart - 1);
John Kessenich3beac942018-04-17 21:02:19 -06001332 else {
Grigory Dzhavadyan33507412018-04-12 14:35:24 -07001333 usage();
1334 return EShLangVertex;
John Kesseniche751bca2017-03-16 11:20:38 -06001335 }
John Kessenichfccbb8b2018-04-17 17:24:03 -06001336 } else
1337 stageName = name;
dankbaker45d49bc2016-08-08 21:43:07 -04001338
John Kessenichfccbb8b2018-04-17 17:24:03 -06001339 if (stageName == "vert")
John Kessenich2b07c7e2013-07-31 18:44:13 +00001340 return EShLangVertex;
John Kessenichfccbb8b2018-04-17 17:24:03 -06001341 else if (stageName == "tesc")
John Kessenich2b07c7e2013-07-31 18:44:13 +00001342 return EShLangTessControl;
John Kessenichfccbb8b2018-04-17 17:24:03 -06001343 else if (stageName == "tese")
John Kessenich2b07c7e2013-07-31 18:44:13 +00001344 return EShLangTessEvaluation;
John Kessenichfccbb8b2018-04-17 17:24:03 -06001345 else if (stageName == "geom")
John Kessenich2b07c7e2013-07-31 18:44:13 +00001346 return EShLangGeometry;
John Kessenichfccbb8b2018-04-17 17:24:03 -06001347 else if (stageName == "frag")
John Kessenich2b07c7e2013-07-31 18:44:13 +00001348 return EShLangFragment;
John Kessenichfccbb8b2018-04-17 17:24:03 -06001349 else if (stageName == "comp")
John Kessenichc0275792013-08-09 17:14:49 +00001350 return EShLangCompute;
Chao Chen3c366992018-09-19 11:41:59 -07001351#ifdef NV_EXTENSIONS
Chao Chenb50c02e2018-09-19 11:42:24 -07001352 else if (stageName == "rgen")
1353 return EShLangRayGenNV;
1354 else if (stageName == "rint")
1355 return EShLangIntersectNV;
1356 else if (stageName == "rahit")
1357 return EShLangAnyHitNV;
1358 else if (stageName == "rchit")
1359 return EShLangClosestHitNV;
1360 else if (stageName == "rmiss")
1361 return EShLangMissNV;
1362 else if (stageName == "rcall")
1363 return EShLangCallableNV;
Chao Chen3c366992018-09-19 11:41:59 -07001364 else if (stageName == "mesh")
1365 return EShLangMeshNV;
1366 else if (stageName == "task")
1367 return EShLangTaskNV;
1368#endif
John Kessenich2b07c7e2013-07-31 18:44:13 +00001369
1370 usage();
John Kesseniche95ecc52012-12-12 21:34:14 +00001371 return EShLangVertex;
John Kessenicha0af4732012-12-12 21:15:54 +00001372}
1373
John Kessenicha0af4732012-12-12 21:15:54 +00001374//
John Kessenichecba76f2017-01-06 00:34:48 -07001375// Read a file's data into a string, and compile it using the old interface ShCompile,
John Kessenich69f4b512013-09-04 21:19:27 +00001376// for non-linkable results.
John Kessenicha0af4732012-12-12 21:15:54 +00001377//
John Kessenich51cdd902014-02-18 23:37:57 +00001378void CompileFile(const char* fileName, ShHandle compiler)
John Kessenicha0af4732012-12-12 21:15:54 +00001379{
John Kessenichca3457f2015-05-18 01:59:45 +00001380 int ret = 0;
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001381 char* shaderString;
1382 if ((Options & EOptionStdin) != 0) {
1383 std::istreambuf_iterator<char> begin(std::cin), end;
1384 std::string tempString(begin, end);
1385 shaderString = strdup(tempString.c_str());
1386 } else {
1387 shaderString = ReadFileData(fileName);
1388 }
John Kessenich41cf6b52013-06-25 18:10:05 +00001389
1390 // move to length-based strings, rather than null-terminated strings
John Kessenich04acb1b2017-06-14 17:36:50 -06001391 int* lengths = new int[1];
1392 lengths[0] = (int)strlen(shaderString);
John Kessenicha0af4732012-12-12 21:15:54 +00001393
John Kessenich52ac67e2013-05-05 23:46:22 +00001394 EShMessages messages = EShMsgDefault;
John Kessenichb0a7eb52013-11-07 17:44:20 +00001395 SetMessageOptions(messages);
John Kessenichecba76f2017-01-06 00:34:48 -07001396
John Kessenicha9313662017-06-15 10:40:49 -06001397 if (UserPreamble.isSet())
1398 Error("-D and -U options require -l (linking)\n");
1399
John Kessenich94a81fb2013-08-31 02:41:30 +00001400 for (int i = 0; i < ((Options & EOptionMemoryLeakMode) ? 100 : 1); ++i) {
1401 for (int j = 0; j < ((Options & EOptionMemoryLeakMode) ? 100 : 1); ++j) {
John Kessenich927608b2017-01-06 12:34:14 -07001402 // ret = ShCompile(compiler, shaderStrings, NumShaderStrings, lengths, EShOptNone, &Resources, Options, (Options & EOptionDefaultDesktop) ? 110 : 100, false, messages);
John Kessenich04acb1b2017-06-14 17:36:50 -06001403 ret = ShCompile(compiler, &shaderString, 1, nullptr, EShOptNone, &Resources, Options, (Options & EOptionDefaultDesktop) ? 110 : 100, false, messages);
John Kessenich927608b2017-01-06 12:34:14 -07001404 // const char* multi[12] = { "# ve", "rsion", " 300 e", "s", "\n#err",
John Kessenichecba76f2017-01-06 00:34:48 -07001405 // "or should be l", "ine 1", "string 5\n", "float glo", "bal",
John Kessenichea869fb2013-10-28 18:12:06 +00001406 // ";\n#error should be line 2\n void main() {", "global = 2.3;}" };
John Kessenich927608b2017-01-06 12:34:14 -07001407 // const char* multi[7] = { "/", "/", "\\", "\n", "\n", "#", "version 300 es" };
1408 // ret = ShCompile(compiler, multi, 7, nullptr, EShOptNone, &Resources, Options, (Options & EOptionDefaultDesktop) ? 110 : 100, false, messages);
John Kessenich41cf6b52013-06-25 18:10:05 +00001409 }
John Kessenicha0af4732012-12-12 21:15:54 +00001410
John Kessenich94a81fb2013-08-31 02:41:30 +00001411 if (Options & EOptionMemoryLeakMode)
John Kessenich2b07c7e2013-07-31 18:44:13 +00001412 glslang::OS_DumpMemoryCounters();
John Kessenicha0af4732012-12-12 21:15:54 +00001413 }
John Kessenicha0af4732012-12-12 21:15:54 +00001414
John Kessenich41cf6b52013-06-25 18:10:05 +00001415 delete [] lengths;
John Kessenich04acb1b2017-06-14 17:36:50 -06001416 FreeFileData(shaderString);
John Kessenicha0af4732012-12-12 21:15:54 +00001417
John Kessenichc999ba22013-11-07 23:33:24 +00001418 if (ret == 0)
1419 CompileFailed = true;
John Kessenicha0af4732012-12-12 21:15:54 +00001420}
1421
John Kessenicha0af4732012-12-12 21:15:54 +00001422//
1423// print usage to stdout
1424//
1425void usage()
1426{
John Kessenich319de232013-12-04 04:43:40 +00001427 printf("Usage: glslangValidator [option]... [file]...\n"
1428 "\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001429 "'file' can end in .<stage> for auto-stage classification, where <stage> is:\n"
1430 " .conf to provide a config file that replaces the default configuration\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001431 " (see -c option below for generating a template)\n"
1432 " .vert for a vertex shader\n"
1433 " .tesc for a tessellation control shader\n"
1434 " .tese for a tessellation evaluation shader\n"
1435 " .geom for a geometry shader\n"
1436 " .frag for a fragment shader\n"
1437 " .comp for a compute shader\n"
Chao Chen3c366992018-09-19 11:41:59 -07001438#ifdef NV_EXTENSIONS
1439 " .mesh for a mesh shader\n"
1440 " .task for a task shader\n"
Chao Chenb50c02e2018-09-19 11:42:24 -07001441 " .rgen for a ray generation shader\n"
1442 " .rint for a ray intersection shader\n"
1443 " .rahit for a ray any hit shader\n"
1444 " .rchit for a ray closest hit shader\n"
1445 " .rmiss for a ray miss shader\n"
Sahil Parmar035cbbe2018-10-04 16:39:18 -07001446 " .rcall for a ray callable shader\n"
Chao Chen3c366992018-09-19 11:41:59 -07001447#endif
John Kessenich2ead40f2018-04-17 17:44:11 -06001448 " .glsl for .vert.glsl, .tesc.glsl, ..., .comp.glsl compound suffixes\n"
1449 " .hlsl for .vert.hlsl, .tesc.hlsl, ..., .comp.hlsl compound suffixes\n"
John Kessenich319de232013-12-04 04:43:40 +00001450 "\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001451 "Options:\n"
1452 " -C cascading errors; risk crash from accumulation of error recoveries\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001453 " -D input is HLSL (this is the default when any suffix is .hlsl)\n"
John Kessenicha9313662017-06-15 10:40:49 -06001454 " -D<macro=def>\n"
1455 " -D<macro> define a pre-processor macro\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001456 " -E print pre-processed GLSL; cannot be used with -l;\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001457 " errors will appear on stderr\n"
John Kessenich6353d552017-06-23 11:11:09 -06001458 " -G[ver] create SPIR-V binary, under OpenGL semantics; turns on -l;\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001459 " default file name is <stage>.spv (-o overrides this);\n"
John Kessenich6353d552017-06-23 11:11:09 -06001460 " 'ver', when present, is the version of the input semantics,\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001461 " which will appear in #define GL_SPIRV ver;\n"
1462 " '--client opengl100' is the same as -G100;\n"
John Kessenich6353d552017-06-23 11:11:09 -06001463 " a '--target-env' for OpenGL will also imply '-G'\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001464 " -H print human readable form of SPIR-V; turns on -V\n"
John Kessenich971a0a82017-06-07 15:06:58 -06001465 " -I<dir> add dir to the include search path; includer's directory\n"
1466 " is searched first, followed by left-to-right order of -I\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001467 " -Od disables optimization; may cause illegal SPIR-V for HLSL\n"
1468 " -Os optimizes SPIR-V to minimize size\n"
John Kesseniche751bca2017-03-16 11:20:38 -06001469 " -S <stage> uses specified stage rather than parsing the file extension\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001470 " choices for <stage> are vert, tesc, tese, geom, frag, or comp\n"
John Kessenich6353d552017-06-23 11:11:09 -06001471 " -U<macro> undefine a pre-processor macro\n"
1472 " -V[ver] create SPIR-V binary, under Vulkan semantics; turns on -l;\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001473 " default file name is <stage>.spv (-o overrides this)\n"
John Kessenich6353d552017-06-23 11:11:09 -06001474 " 'ver', when present, is the version of the input semantics,\n"
1475 " which will appear in #define VULKAN ver\n"
1476 " '--client vulkan100' is the same as -V100\n"
1477 " a '--target-env' for Vulkan will also imply '-V'\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001478 " -c configuration dump;\n"
1479 " creates the default configuration file (redirect to a .conf file)\n"
1480 " -d default to desktop (#version 110) when there is no shader #version\n"
1481 " (default is ES version 100)\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001482 " -e <name> | --entry-point <name>\n"
1483 " specify <name> as the entry-point function name\n"
John Kessenich5d610ee2018-03-07 18:05:55 -07001484 " -f{hlsl_functionality1}\n"
1485 " 'hlsl_functionality1' enables use of the\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001486 " SPV_GOOGLE_hlsl_functionality1 extension\n"
John Kessenich121853f2017-05-31 17:11:16 -06001487 " -g generate debug information\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001488 " -h print this usage message\n"
1489 " -i intermediate tree (glslang AST) is printed out\n"
1490 " -l link all input files together to form a single module\n"
1491 " -m memory leak mode\n"
John Kessenicha25530c2017-09-11 20:13:49 -06001492 " -o <file> save binary to <file>, requires a binary option (e.g., -V)\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001493 " -q dump reflection query database\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001494 " -r | --relaxed-errors"
1495 " relaxed GLSL semantic error-checking mode\n"
John Kessenichb63f4a32017-11-16 22:32:20 -07001496 " -s silence syntax and semantic error reporting\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001497 " -t multi-threaded mode\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001498 " -v | --version\n"
1499 " print version strings\n"
1500 " -w | --suppress-warnings\n"
1501 " suppress GLSL warnings, except as required by \"#extension : warn\"\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001502 " -x save binary output as text-based 32-bit hexadecimal numbers\n"
Neil Roberts16f53472018-03-20 17:30:53 +01001503 " -u<name>:<loc> specify a uniform location override for --aml\n"
Neil Robertsb0f3d792018-03-20 17:41:05 +01001504 " --uniform-base <base> set a base to use for generated uniform locations\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001505 " --auto-map-bindings | --amb automatically bind uniform variables\n"
1506 " without explicit bindings\n"
1507 " --auto-map-locations | --aml automatically locate input/output lacking\n"
1508 " 'location' (fragile, not cross stage)\n"
1509 " --client {vulkan<ver>|opengl<ver>} see -V and -G\n"
1510 " -dumpfullversion | -dumpversion print bare major.minor.patchlevel\n"
1511 " --flatten-uniform-arrays | --fua flatten uniform texture/sampler arrays to\n"
1512 " scalars\n"
1513 " --hlsl-offsets allow block offsets to follow HLSL rules\n"
1514 " works independently of source language\n"
1515 " --hlsl-iomap perform IO mapping in HLSL register space\n"
1516 " --hlsl-enable-16bit-types allow 16-bit types in SPIR-V for HLSL\n"
John Kessenichbd1c1832018-12-07 18:38:26 -07001517 " --hlsl-dx9-compatible interprets sampler declarations as a texture/sampler combo like DirectX9 would."
John Kessenichade8bbb2018-08-12 21:24:55 -06001518 " --invert-y | --iy invert position.Y output in vertex shader\n"
1519 " --keep-uncalled | --ku don't eliminate uncalled functions\n"
1520 " --no-storage-format | --nsf use Unknown image format\n"
LoopDawg52017192017-07-14 15:15:47 -06001521 " --resource-set-binding [stage] name set binding\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001522 " set descriptor set and binding for\n"
1523 " individual resources\n"
LoopDawg52017192017-07-14 15:15:47 -06001524 " --resource-set-binding [stage] set\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001525 " set descriptor set for all resources\n"
1526 " --rsb synonym for --resource-set-binding\n"
1527 " --shift-image-binding [stage] num\n"
1528 " base binding number for images (uav)\n"
1529 " --shift-image-binding [stage] [num set]...\n"
1530 " per-descriptor-set shift values\n"
1531 " --sib synonym for --shift-image-binding\n"
1532 " --shift-sampler-binding [stage] num\n"
1533 " base binding number for samplers\n"
1534 " --shift-sampler-binding [stage] [num set]...\n"
1535 " per-descriptor-set shift values\n"
1536 " --ssb synonym for --shift-sampler-binding\n"
1537 " --shift-ssbo-binding [stage] num base binding number for SSBOs\n"
1538 " --shift-ssbo-binding [stage] [num set]...\n"
1539 " per-descriptor-set shift values\n"
1540 " --sbb synonym for --shift-ssbo-binding\n"
1541 " --shift-texture-binding [stage] num\n"
1542 " base binding number for textures\n"
1543 " --shift-texture-binding [stage] [num set]...\n"
1544 " per-descriptor-set shift values\n"
1545 " --stb synonym for --shift-texture-binding\n"
1546 " --shift-uav-binding [stage] num base binding number for UAVs\n"
1547 " --shift-uav-binding [stage] [num set]...\n"
1548 " per-descriptor-set shift values\n"
1549 " --suavb synonym for --shift-uav-binding\n"
1550 " --shift-UBO-binding [stage] num base binding number for UBOs\n"
1551 " --shift-UBO-binding [stage] [num set]...\n"
1552 " per-descriptor-set shift values\n"
1553 " --sub synonym for --shift-UBO-binding\n"
1554 " --shift-cbuffer-binding | --scb synonyms for --shift-UBO-binding\n"
1555 " --spirv-dis output standard-form disassembly; works only\n"
1556 " when a SPIR-V generation option is also used\n"
John Kessenichc3404252018-08-23 15:29:08 -06001557 " --spirv-val execute the SPIRV-Tools validator\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001558 " --source-entrypoint <name> the given shader source function is\n"
1559 " renamed to be the <name> given in -e\n"
1560 " --sep synonym for --source-entrypoint\n"
1561 " --stdin read from stdin instead of from a file;\n"
1562 " requires providing the shader stage using -S\n"
John Kessenich8717a5d2018-10-26 10:12:32 -06001563 " --target-env {vulkan1.0 | vulkan1.1 | opengl | \n"
1564 " spirv1.0 | spirv1.1 | spirv1.2 | spirv1.3}\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001565 " set execution environment that emitted code\n"
John Kessenich8717a5d2018-10-26 10:12:32 -06001566 " will execute in (versus source language\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001567 " semantics selected by --client) defaults:\n"
1568 " * 'vulkan1.0' under '--client vulkan<ver>'\n"
1569 " * 'opengl' under '--client opengl<ver>'\n"
John Kessenich8717a5d2018-10-26 10:12:32 -06001570 " * 'spirv1.0' under --target-env vulkan1.0\n"
1571 " * 'spirv1.3' under --target-env vulkan1.1\n"
1572 " multiple --targen-env can be specified.\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001573 " --variable-name <name>\n"
1574 " --vn <name> creates a C header file that contains a\n"
1575 " uint32_t array named <name>\n"
1576 " initialized with the shader binary code\n"
John Kessenichb0a7eb52013-11-07 17:44:20 +00001577 );
John Kessenich68d78fd2015-07-12 19:28:10 -06001578
1579 exit(EFailUsage);
John Kessenicha0af4732012-12-12 21:15:54 +00001580}
1581
John Kessenich3ce4e592014-10-06 19:57:34 +00001582#if !defined _MSC_VER && !defined MINGW_HAS_SECURE_API
John Kessenichcfd643e2013-03-08 23:14:42 +00001583
1584#include <errno.h>
1585
1586int fopen_s(
1587 FILE** pFile,
John Kessenich51cdd902014-02-18 23:37:57 +00001588 const char* filename,
1589 const char* mode
John Kessenichcfd643e2013-03-08 23:14:42 +00001590)
1591{
1592 if (!pFile || !filename || !mode) {
1593 return EINVAL;
1594 }
1595
1596 FILE* f = fopen(filename, mode);
1597 if (! f) {
1598 if (errno != 0) {
1599 return errno;
1600 } else {
1601 return ENOENT;
1602 }
1603 }
1604 *pFile = f;
1605
1606 return 0;
1607}
1608
1609#endif
1610
John Kessenicha0af4732012-12-12 21:15:54 +00001611//
1612// Malloc a string of sufficient size and read a string into it.
1613//
John Kessenich04acb1b2017-06-14 17:36:50 -06001614char* ReadFileData(const char* fileName)
John Kessenicha0af4732012-12-12 21:15:54 +00001615{
John Kessenichb3297152015-07-11 18:01:03 -06001616 FILE *in = nullptr;
John Kessenich3ce4e592014-10-06 19:57:34 +00001617 int errorCode = fopen_s(&in, fileName, "r");
John Kessenich68d78fd2015-07-12 19:28:10 -06001618 if (errorCode || in == nullptr)
1619 Error("unable to open input file");
John Kessenichecba76f2017-01-06 00:34:48 -07001620
John Kessenich04acb1b2017-06-14 17:36:50 -06001621 int count = 0;
John Kessenicha0af4732012-12-12 21:15:54 +00001622 while (fgetc(in) != EOF)
1623 count++;
1624
John Kessenichd6c72a42014-08-18 19:42:35 +00001625 fseek(in, 0, SEEK_SET);
John Kessenichca3457f2015-05-18 01:59:45 +00001626
John Kessenich04acb1b2017-06-14 17:36:50 -06001627 char* return_data = (char*)malloc(count + 1); // freed in FreeFileData()
1628 if ((int)fread(return_data, 1, count, in) != count) {
1629 free(return_data);
John Kessenich68d78fd2015-07-12 19:28:10 -06001630 Error("can't read input file");
John Kessenicha0af4732012-12-12 21:15:54 +00001631 }
John Kessenich68d78fd2015-07-12 19:28:10 -06001632
John Kessenich04acb1b2017-06-14 17:36:50 -06001633 return_data[count] = '\0';
John Kessenicha0af4732012-12-12 21:15:54 +00001634 fclose(in);
John Kessenichb3297152015-07-11 18:01:03 -06001635
John Kessenicha0af4732012-12-12 21:15:54 +00001636 return return_data;
1637}
1638
John Kessenich04acb1b2017-06-14 17:36:50 -06001639void FreeFileData(char* data)
John Kessenicha0af4732012-12-12 21:15:54 +00001640{
John Kessenichb3297152015-07-11 18:01:03 -06001641 free(data);
John Kessenicha0af4732012-12-12 21:15:54 +00001642}
1643
John Kessenich54d8cda2013-02-11 22:36:01 +00001644void InfoLogMsg(const char* msg, const char* name, const int num)
John Kessenicha0af4732012-12-12 21:15:54 +00001645{
John Kessenichfae38ee2015-06-10 23:23:12 +00001646 if (num >= 0 )
1647 printf("#### %s %s %d INFO LOG ####\n", msg, name, num);
1648 else
1649 printf("#### %s %s INFO LOG ####\n", msg, name);
John Kessenicha0af4732012-12-12 21:15:54 +00001650}