blob: 3bb3af39e9f791c4879425d1418377005bc760b6 [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 Kessenich605afc72019-06-17 23:33:09 -0600107bool NaNClamp = false;
John Kessenich94a81fb2013-08-31 02:41:30 +0000108
John Kessenicha0af4732012-12-12 21:15:54 +0000109//
John Kessenich68d78fd2015-07-12 19:28:10 -0600110// Return codes from main/exit().
John Kessenicha0af4732012-12-12 21:15:54 +0000111//
112enum TFailCode {
113 ESuccess = 0,
114 EFailUsage,
115 EFailCompile,
116 EFailLink,
117 EFailCompilerCreate,
John Kessenich2b07c7e2013-07-31 18:44:13 +0000118 EFailThreadCreate,
John Kessenicha0af4732012-12-12 21:15:54 +0000119 EFailLinkerCreate
120};
121
122//
John Kessenich68d78fd2015-07-12 19:28:10 -0600123// Forward declarations.
John Kessenicha0af4732012-12-12 21:15:54 +0000124//
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600125EShLanguage FindLanguage(const std::string& name, bool parseSuffix=true);
John Kessenich51cdd902014-02-18 23:37:57 +0000126void CompileFile(const char* fileName, ShHandle);
John Kessenicha0af4732012-12-12 21:15:54 +0000127void usage();
John Kessenich04acb1b2017-06-14 17:36:50 -0600128char* ReadFileData(const char* fileName);
129void FreeFileData(char* data);
John Kessenich54d8cda2013-02-11 22:36:01 +0000130void InfoLogMsg(const char* msg, const char* name, const int num);
John Kessenich41cf6b52013-06-25 18:10:05 +0000131
John Kessenichc999ba22013-11-07 23:33:24 +0000132// Globally track if any compile or link failure.
133bool CompileFailed = false;
134bool LinkFailed = false;
135
John Kessenich94f28eb2017-11-13 01:32:06 -0700136// array of unique places to leave the shader names and infologs for the asynchronous compiles
137std::vector<std::unique_ptr<glslang::TWorkItem>> WorkItems;
138
John Kessenich05a70632013-09-17 19:26:08 +0000139TBuiltInResource Resources;
140std::string ConfigFile;
141
John Kessenicha0af4732012-12-12 21:15:54 +0000142//
John Kessenichf0bcb0a2016-04-02 13:09:14 -0600143// Parse either a .conf file provided by the user or the default from glslang::DefaultTBuiltInResource
John Kessenich05a70632013-09-17 19:26:08 +0000144//
145void ProcessConfigFile()
John Kessenichb51f62c2013-04-11 16:31:09 +0000146{
John Kessenich04acb1b2017-06-14 17:36:50 -0600147 if (ConfigFile.size() == 0)
Lei Zhang414eb602016-03-04 16:22:34 -0500148 Resources = glslang::DefaultTBuiltInResource;
John Kessenich04acb1b2017-06-14 17:36:50 -0600149 else {
150 char* configString = ReadFileData(ConfigFile.c_str());
151 glslang::DecodeResourceLimits(&Resources, configString);
152 FreeFileData(configString);
John Kessenich05a70632013-09-17 19:26:08 +0000153 }
John Kessenicha0af4732012-12-12 21:15:54 +0000154}
155
baldurk6d477852019-01-29 15:45:56 +0000156int ReflectOptions = EShReflectionDefault;
John Kessenich94a81fb2013-08-31 02:41:30 +0000157int Options = 0;
John Kessenich68d78fd2015-07-12 19:28:10 -0600158const char* ExecutableName = nullptr;
159const char* binaryFileName = nullptr;
John Kessenich4d65ee32016-03-12 18:17:47 -0700160const char* entryPointName = nullptr;
steve-lunargf1e0c872016-10-31 15:13:43 -0600161const char* sourceEntryPointName = nullptr;
Dan Bakerc6ede892016-08-11 14:06:06 -0400162const char* shaderStageName = nullptr;
Flavioaea3c892017-02-06 11:46:35 -0800163const char* variableName = nullptr;
Rex Xucb61eec2018-03-07 13:10:01 +0800164bool HlslEnable16BitTypes = false;
John Kessenichbd1c1832018-12-07 18:38:26 -0700165bool HlslDX9compatible = false;
Christoph Kubisch55ba3ea2019-04-13 22:18:16 +0200166bool DumpBuiltinSymbols = false;
John Kessenich971a0a82017-06-07 15:06:58 -0600167std::vector<std::string> IncludeDirectoryList;
John Kessenich8717a5d2018-10-26 10:12:32 -0600168
169// Source environment
170// (source 'Client' is currently the same as target 'Client')
171int ClientInputSemanticsVersion = 100;
172
173// Target environment
174glslang::EShClient Client = glslang::EShClientNone; // will stay EShClientNone if only validating
175glslang::EShTargetClientVersion ClientVersion; // not valid until Client is set
176glslang::EShTargetLanguage TargetLanguage = glslang::EShTargetNone;
177glslang::EShTargetLanguageVersion TargetVersion; // not valid until TargetLanguage is set
178
John Kessenich66011cb2018-03-06 16:12:04 -0700179std::vector<std::string> Processes; // what should be recorded by OpModuleProcessed, or equivalent
John Kessenich68d78fd2015-07-12 19:28:10 -0600180
LoopDawg08a14422017-10-17 19:27:14 -0600181// Per descriptor-set binding base data
182typedef std::map<unsigned int, unsigned int> TPerSetBaseBinding;
183
Neil Roberts16f53472018-03-20 17:30:53 +0100184std::vector<std::pair<std::string, int>> uniformLocationOverrides;
Neil Robertsb0f3d792018-03-20 17:41:05 +0100185int uniformBase = 0;
Neil Roberts16f53472018-03-20 17:30:53 +0100186
LoopDawg08a14422017-10-17 19:27:14 -0600187std::array<std::array<unsigned int, EShLangCount>, glslang::EResCount> baseBinding;
188std::array<std::array<TPerSetBaseBinding, EShLangCount>, glslang::EResCount> baseBindingForSet;
Hyangran Park36dc8292017-05-02 16:27:29 +0900189std::array<std::vector<std::string>, EShLangCount> baseResourceSetBinding;
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600190
John Kessenicha9313662017-06-15 10:40:49 -0600191// Add things like "#define ..." to a preamble to use in the beginning of the shader.
192class TPreamble {
193public:
194 TPreamble() { }
195
196 bool isSet() const { return text.size() > 0; }
197 const char* get() const { return text.c_str(); }
198
199 // #define...
200 void addDef(std::string def)
201 {
202 text.append("#define ");
203 fixLine(def);
204
John Kessenich2a271162017-07-20 20:00:36 -0600205 Processes.push_back("D");
206 Processes.back().append(def);
207
John Kessenicha9313662017-06-15 10:40:49 -0600208 // The first "=" needs to turn into a space
LoopDawgb97b25e2017-07-12 09:04:39 -0600209 const size_t equal = def.find_first_of("=");
John Kessenicha9313662017-06-15 10:40:49 -0600210 if (equal != def.npos)
211 def[equal] = ' ';
212
213 text.append(def);
214 text.append("\n");
215 }
216
217 // #undef...
218 void addUndef(std::string undef)
219 {
220 text.append("#undef ");
221 fixLine(undef);
John Kessenich2a271162017-07-20 20:00:36 -0600222
223 Processes.push_back("U");
224 Processes.back().append(undef);
225
John Kessenicha9313662017-06-15 10:40:49 -0600226 text.append(undef);
227 text.append("\n");
228 }
229
230protected:
231 void fixLine(std::string& line)
232 {
233 // Can't go past a newline in the line
LoopDawgb97b25e2017-07-12 09:04:39 -0600234 const size_t end = line.find_first_of("\n");
John Kessenicha9313662017-06-15 10:40:49 -0600235 if (end != line.npos)
236 line = line.substr(0, end);
237 }
238
239 std::string text; // contents of preamble
240};
241
242TPreamble UserPreamble;
243
John Kessenich68d78fd2015-07-12 19:28:10 -0600244//
245// Create the default name for saving a binary if -o is not provided.
246//
247const char* GetBinaryName(EShLanguage stage)
248{
249 const char* name;
250 if (binaryFileName == nullptr) {
251 switch (stage) {
252 case EShLangVertex: name = "vert.spv"; break;
253 case EShLangTessControl: name = "tesc.spv"; break;
254 case EShLangTessEvaluation: name = "tese.spv"; break;
255 case EShLangGeometry: name = "geom.spv"; break;
256 case EShLangFragment: name = "frag.spv"; break;
257 case EShLangCompute: name = "comp.spv"; break;
Chao Chen3c366992018-09-19 11:41:59 -0700258#ifdef NV_EXTENSIONS
Chao Chenb50c02e2018-09-19 11:42:24 -0700259 case EShLangRayGenNV: name = "rgen.spv"; break;
260 case EShLangIntersectNV: name = "rint.spv"; break;
261 case EShLangAnyHitNV: name = "rahit.spv"; break;
262 case EShLangClosestHitNV: name = "rchit.spv"; break;
263 case EShLangMissNV: name = "rmiss.spv"; break;
264 case EShLangCallableNV: name = "rcall.spv"; break;
Chao Chen3c366992018-09-19 11:41:59 -0700265 case EShLangMeshNV: name = "mesh.spv"; break;
266 case EShLangTaskNV: name = "task.spv"; break;
267#endif
John Kessenich68d78fd2015-07-12 19:28:10 -0600268 default: name = "unknown"; break;
269 }
270 } else
271 name = binaryFileName;
272
273 return name;
274}
John Kessenich2b07c7e2013-07-31 18:44:13 +0000275
John Kessenich05a70632013-09-17 19:26:08 +0000276//
277// *.conf => this is a config file that can set limits/resources
278//
279bool SetConfigFile(const std::string& name)
280{
281 if (name.size() < 5)
282 return false;
283
John Kessenich4c706852013-10-11 16:28:43 +0000284 if (name.compare(name.size() - 5, 5, ".conf") == 0) {
John Kessenich05a70632013-09-17 19:26:08 +0000285 ConfigFile = name;
286 return true;
287 }
288
289 return false;
290}
291
John Kessenich68d78fd2015-07-12 19:28:10 -0600292//
293// Give error and exit with failure code.
294//
295void Error(const char* message)
296{
John Kessenichaf527992017-11-02 22:48:15 -0600297 fprintf(stderr, "%s: Error %s (use -h for usage)\n", ExecutableName, message);
John Kessenich68d78fd2015-07-12 19:28:10 -0600298 exit(EFailUsage);
299}
300
301//
LoopDawg08a14422017-10-17 19:27:14 -0600302// Process an optional binding base of one the forms:
303// --argname [stage] base // base for stage (if given) or all stages (if not)
LoopDawge5709552017-10-21 10:46:39 -0600304// --argname [stage] [base set]... // set/base pairs: set the base for given binding set.
LoopDawg08a14422017-10-17 19:27:14 -0600305
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600306// Where stage is one of the forms accepted by FindLanguage, and base is an integer
307//
LoopDawg08a14422017-10-17 19:27:14 -0600308void ProcessBindingBase(int& argc, char**& argv, glslang::TResourceType res)
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600309{
310 if (argc < 2)
311 usage();
312
LoopDawg08a14422017-10-17 19:27:14 -0600313 EShLanguage lang = EShLangCount;
314 int singleBase = 0;
315 TPerSetBaseBinding perSetBase;
316 int arg = 1;
317
318 // Parse stage, if given
319 if (!isdigit(argv[arg][0])) {
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600320 if (argc < 3) // this form needs one more argument
321 usage();
John Kessenichecba76f2017-01-06 00:34:48 -0700322
LoopDawg08a14422017-10-17 19:27:14 -0600323 lang = FindLanguage(argv[arg++], false);
324 }
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600325
LoopDawg08a14422017-10-17 19:27:14 -0600326 if ((argc - arg) > 2 && isdigit(argv[arg+0][0]) && isdigit(argv[arg+1][0])) {
327 // Parse a per-set binding base
328 while ((argc - arg) > 2 && isdigit(argv[arg+0][0]) && isdigit(argv[arg+1][0])) {
LoopDawg08a14422017-10-17 19:27:14 -0600329 const int baseNum = atoi(argv[arg++]);
LoopDawge5709552017-10-21 10:46:39 -0600330 const int setNum = atoi(argv[arg++]);
LoopDawg08a14422017-10-17 19:27:14 -0600331 perSetBase[setNum] = baseNum;
332 }
333 } else {
334 // Parse single binding base
335 singleBase = atoi(argv[arg++]);
336 }
337
338 argc -= (arg-1);
339 argv += (arg-1);
340
341 // Set one or all languages
342 const int langMin = (lang < EShLangCount) ? lang+0 : 0;
343 const int langMax = (lang < EShLangCount) ? lang+1 : EShLangCount;
344
345 for (int lang = langMin; lang < langMax; ++lang) {
346 if (!perSetBase.empty())
John Kessenich251901a2018-08-12 22:05:59 -0600347 baseBindingForSet[res][lang].insert(perSetBase.begin(), perSetBase.end());
LoopDawg08a14422017-10-17 19:27:14 -0600348 else
349 baseBinding[res][lang] = singleBase;
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600350 }
351}
352
Hyangran Park36dc8292017-05-02 16:27:29 +0900353void ProcessResourceSetBindingBase(int& argc, char**& argv, std::array<std::vector<std::string>, EShLangCount>& base)
354{
355 if (argc < 2)
356 usage();
357
358 if (!isdigit(argv[1][0])) {
LoopDawg52017192017-07-14 15:15:47 -0600359 if (argc < 3) // this form needs one more argument
Hyangran Park36dc8292017-05-02 16:27:29 +0900360 usage();
361
LoopDawg52017192017-07-14 15:15:47 -0600362 // Parse form: --argname stage [regname set base...], or:
363 // --argname stage set
Hyangran Park36dc8292017-05-02 16:27:29 +0900364 const EShLanguage lang = FindLanguage(argv[1], false);
365
LoopDawg52017192017-07-14 15:15:47 -0600366 argc--;
367 argv++;
368
369 while (argc > 1 && argv[1] != nullptr && argv[1][0] != '-') {
370 base[lang].push_back(argv[1]);
371
372 argc--;
373 argv++;
Hyangran Park36dc8292017-05-02 16:27:29 +0900374 }
LoopDawg52017192017-07-14 15:15:47 -0600375
376 // Must have one arg, or a multiple of three (for [regname set binding] triples)
377 if (base[lang].size() != 1 && (base[lang].size() % 3) != 0)
378 usage();
379
Hyangran Park36dc8292017-05-02 16:27:29 +0900380 } else {
LoopDawg52017192017-07-14 15:15:47 -0600381 // Parse form: --argname set
Hyangran Park36dc8292017-05-02 16:27:29 +0900382 for (int lang=0; lang<EShLangCount; ++lang)
383 base[lang].push_back(argv[1]);
384
385 argc--;
386 argv++;
387 }
388}
389
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600390//
John Kessenich68d78fd2015-07-12 19:28:10 -0600391// Do all command-line argument parsing. This includes building up the work-items
392// to be processed later, and saving all the command-line options.
393//
394// Does not return (it exits) if command-line is fatally flawed.
395//
Juan Lopeza558b262017-04-02 23:04:00 +0200396void ProcessArguments(std::vector<std::unique_ptr<glslang::TWorkItem>>& workItems, int argc, char* argv[])
John Kessenich2b07c7e2013-07-31 18:44:13 +0000397{
LoopDawg08a14422017-10-17 19:27:14 -0600398 for (int res = 0; res < glslang::EResCount; ++res)
399 baseBinding[res].fill(0);
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600400
John Kessenich38f3b892013-09-06 19:52:57 +0000401 ExecutableName = argv[0];
Juan Lopeza558b262017-04-02 23:04:00 +0200402 workItems.reserve(argc);
John Kessenich38f3b892013-09-06 19:52:57 +0000403
John Kessenichc178f0a2017-06-23 10:58:31 -0600404 const auto bumpArg = [&]() {
405 if (argc > 0) {
406 argc--;
407 argv++;
408 }
409 };
410
411 // read a string directly attached to a single-letter option
John Kessenich6263fb12017-06-14 15:52:44 -0600412 const auto getStringOperand = [&](const char* desc) {
413 if (argv[0][2] == 0) {
414 printf("%s must immediately follow option (no spaces)\n", desc);
415 exit(EFailUsage);
416 }
417 return argv[0] + 2;
418 };
419
John Kessenich6353d552017-06-23 11:11:09 -0600420 // read a number attached to a single-letter option
421 const auto getAttachedNumber = [&](const char* desc) {
422 int num = atoi(argv[0] + 2);
423 if (num == 0) {
424 printf("%s: expected attached non-0 number\n", desc);
425 exit(EFailUsage);
426 }
427 return num;
428 };
429
430 // minimum needed (without overriding something else) to target Vulkan SPIR-V
431 const auto setVulkanSpv = []() {
John Kessenich8717a5d2018-10-26 10:12:32 -0600432 if (Client == glslang::EShClientNone)
433 ClientVersion = glslang::EShTargetVulkan_1_0;
434 Client = glslang::EShClientVulkan;
John Kessenich6353d552017-06-23 11:11:09 -0600435 Options |= EOptionSpv;
436 Options |= EOptionVulkanRules;
437 Options |= EOptionLinkProgram;
438 };
439
440 // minimum needed (without overriding something else) to target OpenGL SPIR-V
441 const auto setOpenGlSpv = []() {
John Kessenich8717a5d2018-10-26 10:12:32 -0600442 if (Client == glslang::EShClientNone)
443 ClientVersion = glslang::EShTargetOpenGL_450;
444 Client = glslang::EShClientOpenGL;
John Kessenich6353d552017-06-23 11:11:09 -0600445 Options |= EOptionSpv;
446 Options |= EOptionLinkProgram;
447 // undo a -H default to Vulkan
448 Options &= ~EOptionVulkanRules;
449 };
450
Neil Roberts16f53472018-03-20 17:30:53 +0100451 const auto getUniformOverride = [getStringOperand]() {
452 const char *arg = getStringOperand("-u<name>:<location>");
453 const char *split = strchr(arg, ':');
454 if (split == NULL) {
455 printf("%s: missing location\n", arg);
456 exit(EFailUsage);
457 }
458 errno = 0;
459 int location = ::strtol(split + 1, NULL, 10);
460 if (errno) {
461 printf("%s: invalid location\n", arg);
462 exit(EFailUsage);
463 }
464 return std::make_pair(std::string(arg, split - arg), location);
465 };
466
John Kessenichc178f0a2017-06-23 10:58:31 -0600467 for (bumpArg(); argc >= 1; bumpArg()) {
John Kessenich2b07c7e2013-07-31 18:44:13 +0000468 if (argv[0][0] == '-') {
John Kessenich2aa7f3a2015-05-15 16:02:07 +0000469 switch (argv[0][1]) {
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600470 case '-':
471 {
472 std::string lowerword(argv[0]+2);
473 std::transform(lowerword.begin(), lowerword.end(), lowerword.begin(), ::tolower);
474
475 // handle --word style options
John Kessenich6263fb12017-06-14 15:52:44 -0600476 if (lowerword == "auto-map-bindings" || // synonyms
John Kessenich6353d552017-06-23 11:11:09 -0600477 lowerword == "auto-map-binding" ||
478 lowerword == "amb") {
John Kessenich6263fb12017-06-14 15:52:44 -0600479 Options |= EOptionAutoMapBindings;
480 } else if (lowerword == "auto-map-locations" || // synonyms
481 lowerword == "aml") {
482 Options |= EOptionAutoMapLocations;
Neil Robertsb0f3d792018-03-20 17:41:05 +0100483 } else if (lowerword == "uniform-base") {
484 if (argc <= 1)
485 Error("no <base> provided for --uniform-base");
486 uniformBase = ::strtol(argv[1], NULL, 10);
487 bumpArg();
488 break;
John Kessenich6353d552017-06-23 11:11:09 -0600489 } else if (lowerword == "client") {
490 if (argc > 1) {
491 if (strcmp(argv[1], "vulkan100") == 0)
492 setVulkanSpv();
493 else if (strcmp(argv[1], "opengl100") == 0)
494 setOpenGlSpv();
495 else
496 Error("--client expects vulkan100 or opengl100");
497 }
498 bumpArg();
Christoph Kubisch55ba3ea2019-04-13 22:18:16 +0200499 } else if (lowerword == "dump-builtin-symbols") {
500 DumpBuiltinSymbols = true;
John Kessenich640bd092018-08-09 14:15:00 -0600501 } else if (lowerword == "entry-point") {
502 entryPointName = argv[1];
503 if (argc <= 1)
504 Error("no <name> provided for --entry-point");
505 bumpArg();
John Kessenich6263fb12017-06-14 15:52:44 -0600506 } else if (lowerword == "flatten-uniform-arrays" || // synonyms
507 lowerword == "flatten-uniform-array" ||
508 lowerword == "fua") {
509 Options |= EOptionFlattenUniformArrays;
510 } else if (lowerword == "hlsl-offsets") {
511 Options |= EOptionHlslOffsets;
512 } else if (lowerword == "hlsl-iomap" ||
513 lowerword == "hlsl-iomapper" ||
514 lowerword == "hlsl-iomapping") {
515 Options |= EOptionHlslIoMapping;
Rex Xucb61eec2018-03-07 13:10:01 +0800516 } else if (lowerword == "hlsl-enable-16bit-types") {
517 HlslEnable16BitTypes = true;
John Kessenichbd1c1832018-12-07 18:38:26 -0700518 } else if (lowerword == "hlsl-dx9-compatible") {
519 HlslDX9compatible = true;
John Kessenichc6c80a62018-03-05 22:23:17 -0700520 } else if (lowerword == "invert-y" || // synonyms
521 lowerword == "iy") {
522 Options |= EOptionInvertY;
John Kessenich6263fb12017-06-14 15:52:44 -0600523 } else if (lowerword == "keep-uncalled" || // synonyms
524 lowerword == "ku") {
525 Options |= EOptionKeepUncalled;
John Kessenich605afc72019-06-17 23:33:09 -0600526 } else if (lowerword == "nan-clamp") {
527 NaNClamp = true;
John Kessenich6263fb12017-06-14 15:52:44 -0600528 } else if (lowerword == "no-storage-format" || // synonyms
529 lowerword == "nsf") {
530 Options |= EOptionNoStorageFormat;
John Kessenich2a271162017-07-20 20:00:36 -0600531 } else if (lowerword == "relaxed-errors") {
532 Options |= EOptionRelaxedErrors;
baldurk15c37f72019-01-29 12:12:59 +0000533 } else if (lowerword == "reflect-strict-array-suffix") {
534 ReflectOptions |= EShReflectionStrictArraySuffix;
baldurkedf82122019-01-29 15:49:00 +0000535 } else if (lowerword == "reflect-basic-array-suffix") {
536 ReflectOptions |= EShReflectionBasicArraySuffix;
baldurk0af5e3e2019-01-29 16:04:44 +0000537 } else if (lowerword == "reflect-intermediate-io") {
538 ReflectOptions |= EShReflectionIntermediateIO;
baldurk657acc02019-01-30 14:18:43 +0000539 } else if (lowerword == "reflect-separate-buffers") {
540 ReflectOptions |= EShReflectionSeparateBuffers;
baldurka972e732019-01-30 15:34:02 +0000541 } else if (lowerword == "reflect-all-block-variables") {
542 ReflectOptions |= EShReflectionAllBlockVariables;
baldurk19050692019-02-11 11:50:24 +0000543 } else if (lowerword == "reflect-unwrap-io-blocks") {
544 ReflectOptions |= EShReflectionUnwrapIOBlocks;
John Kessenich6263fb12017-06-14 15:52:44 -0600545 } else if (lowerword == "resource-set-bindings" || // synonyms
546 lowerword == "resource-set-binding" ||
547 lowerword == "rsb") {
548 ProcessResourceSetBindingBase(argc, argv, baseResourceSetBinding);
steve-lunarg9088be42016-11-01 10:31:42 -0600549 } else if (lowerword == "shift-image-bindings" || // synonyms
550 lowerword == "shift-image-binding" ||
551 lowerword == "sib") {
LoopDawg08a14422017-10-17 19:27:14 -0600552 ProcessBindingBase(argc, argv, glslang::EResImage);
John Kessenich6263fb12017-06-14 15:52:44 -0600553 } else if (lowerword == "shift-sampler-bindings" || // synonyms
John Kessenichade8bbb2018-08-12 21:24:55 -0600554 lowerword == "shift-sampler-binding" ||
555 lowerword == "ssb") {
LoopDawg08a14422017-10-17 19:27:14 -0600556 ProcessBindingBase(argc, argv, glslang::EResSampler);
John Kessenich6263fb12017-06-14 15:52:44 -0600557 } else if (lowerword == "shift-uav-bindings" || // synonyms
558 lowerword == "shift-uav-binding" ||
559 lowerword == "suavb") {
LoopDawg08a14422017-10-17 19:27:14 -0600560 ProcessBindingBase(argc, argv, glslang::EResUav);
John Kessenich6263fb12017-06-14 15:52:44 -0600561 } else if (lowerword == "shift-texture-bindings" || // synonyms
562 lowerword == "shift-texture-binding" ||
563 lowerword == "stb") {
LoopDawg08a14422017-10-17 19:27:14 -0600564 ProcessBindingBase(argc, argv, glslang::EResTexture);
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600565 } else if (lowerword == "shift-ubo-bindings" || // synonyms
566 lowerword == "shift-ubo-binding" ||
steve-lunargbe283552017-04-18 12:18:01 -0600567 lowerword == "shift-cbuffer-bindings" ||
568 lowerword == "shift-cbuffer-binding" ||
569 lowerword == "sub" ||
570 lowerword == "scb") {
LoopDawg08a14422017-10-17 19:27:14 -0600571 ProcessBindingBase(argc, argv, glslang::EResUbo);
steve-lunarg932bb5c2017-02-21 17:19:08 -0700572 } else if (lowerword == "shift-ssbo-bindings" || // synonyms
573 lowerword == "shift-ssbo-binding" ||
574 lowerword == "sbb") {
LoopDawg08a14422017-10-17 19:27:14 -0600575 ProcessBindingBase(argc, argv, glslang::EResSsbo);
John Kessenich6263fb12017-06-14 15:52:44 -0600576 } else if (lowerword == "source-entrypoint" || // synonyms
577 lowerword == "sep") {
John Kessenichc178f0a2017-06-23 10:58:31 -0600578 if (argc <= 1)
John Kessenich6263fb12017-06-14 15:52:44 -0600579 Error("no <entry-point> provided for --source-entrypoint");
John Kessenichc178f0a2017-06-23 10:58:31 -0600580 sourceEntryPointName = argv[1];
581 bumpArg();
John Kessenich6263fb12017-06-14 15:52:44 -0600582 break;
John Kesseniche2156222018-06-11 18:12:15 -0600583 } else if (lowerword == "spirv-dis") {
584 SpvToolsDisassembler = true;
John Kessenichc3404252018-08-23 15:29:08 -0600585 } else if (lowerword == "spirv-val") {
586 SpvToolsValidate = true;
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +0200587 } else if (lowerword == "stdin") {
588 Options |= EOptionStdin;
589 shaderStageName = argv[1];
John Kessenich2a271162017-07-20 20:00:36 -0600590 } else if (lowerword == "suppress-warnings") {
591 Options |= EOptionSuppressWarnings;
John Kessenich6353d552017-06-23 11:11:09 -0600592 } else if (lowerword == "target-env") {
593 if (argc > 1) {
594 if (strcmp(argv[1], "vulkan1.0") == 0) {
595 setVulkanSpv();
John Kessenich8717a5d2018-10-26 10:12:32 -0600596 ClientVersion = glslang::EShTargetVulkan_1_0;
John Kessenich66011cb2018-03-06 16:12:04 -0700597 } else if (strcmp(argv[1], "vulkan1.1") == 0) {
598 setVulkanSpv();
John Kessenich8717a5d2018-10-26 10:12:32 -0600599 ClientVersion = glslang::EShTargetVulkan_1_1;
John Kessenich6353d552017-06-23 11:11:09 -0600600 } else if (strcmp(argv[1], "opengl") == 0) {
601 setOpenGlSpv();
John Kessenich8717a5d2018-10-26 10:12:32 -0600602 ClientVersion = glslang::EShTargetOpenGL_450;
603 } else if (strcmp(argv[1], "spirv1.0") == 0) {
604 TargetLanguage = glslang::EShTargetSpv;
605 TargetVersion = glslang::EShTargetSpv_1_0;
606 } else if (strcmp(argv[1], "spirv1.1") == 0) {
607 TargetLanguage = glslang::EShTargetSpv;
608 TargetVersion = glslang::EShTargetSpv_1_1;
609 } else if (strcmp(argv[1], "spirv1.2") == 0) {
610 TargetLanguage = glslang::EShTargetSpv;
611 TargetVersion = glslang::EShTargetSpv_1_2;
612 } else if (strcmp(argv[1], "spirv1.3") == 0) {
613 TargetLanguage = glslang::EShTargetSpv;
614 TargetVersion = glslang::EShTargetSpv_1_3;
615 } else if (strcmp(argv[1], "spirv1.4") == 0) {
616 TargetLanguage = glslang::EShTargetSpv;
617 TargetVersion = glslang::EShTargetSpv_1_4;
John Kessenich6353d552017-06-23 11:11:09 -0600618 } else
John Kessenich8717a5d2018-10-26 10:12:32 -0600619 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 -0600620 }
621 bumpArg();
Flavio15017db2017-02-15 14:29:33 -0800622 } else if (lowerword == "variable-name" || // synonyms
John Kessenich66011cb2018-03-06 16:12:04 -0700623 lowerword == "vn") {
Flavio15017db2017-02-15 14:29:33 -0800624 Options |= EOptionOutputHexadecimal;
John Kessenichc178f0a2017-06-23 10:58:31 -0600625 if (argc <= 1)
Flavio15017db2017-02-15 14:29:33 -0800626 Error("no <C-variable-name> provided for --variable-name");
John Kessenichc178f0a2017-06-23 10:58:31 -0600627 variableName = argv[1];
628 bumpArg();
Flavio15017db2017-02-15 14:29:33 -0800629 break;
John Kessenichc6c80a62018-03-05 22:23:17 -0700630 } else if (lowerword == "version") {
631 Options |= EOptionDumpVersions;
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600632 } else {
633 usage();
634 }
635 }
636 break;
John Kessenich6263fb12017-06-14 15:52:44 -0600637 case 'C':
638 Options |= EOptionCascadingErrors;
639 break;
640 case 'D':
John Kessenicha9313662017-06-15 10:40:49 -0600641 if (argv[0][2] == 0)
642 Options |= EOptionReadHlsl;
643 else
644 UserPreamble.addDef(getStringOperand("-D<macro> macro name"));
John Kessenich6263fb12017-06-14 15:52:44 -0600645 break;
Neil Roberts16f53472018-03-20 17:30:53 +0100646 case 'u':
647 uniformLocationOverrides.push_back(getUniformOverride());
648 break;
John Kessenich6263fb12017-06-14 15:52:44 -0600649 case 'E':
650 Options |= EOptionOutputPreprocessed;
651 break;
652 case 'G':
John Kessenich8717a5d2018-10-26 10:12:32 -0600653 // OpenGL client
John Kessenich6353d552017-06-23 11:11:09 -0600654 setOpenGlSpv();
655 if (argv[0][2] != 0)
656 ClientInputSemanticsVersion = getAttachedNumber("-G<num> client input semantics");
John Kessenich6263fb12017-06-14 15:52:44 -0600657 break;
John Kessenich2aa7f3a2015-05-15 16:02:07 +0000658 case 'H':
659 Options |= EOptionHumanReadableSpv;
John Kessenich91e4aa52016-07-07 17:46:42 -0600660 if ((Options & EOptionSpv) == 0) {
661 // default to Vulkan
John Kessenich6353d552017-06-23 11:11:09 -0600662 setVulkanSpv();
John Kessenich91e4aa52016-07-07 17:46:42 -0600663 }
664 break;
John Kessenich971a0a82017-06-07 15:06:58 -0600665 case 'I':
John Kessenicha9313662017-06-15 10:40:49 -0600666 IncludeDirectoryList.push_back(getStringOperand("-I<dir> include path"));
John Kessenich68d78fd2015-07-12 19:28:10 -0600667 break;
GregFcd1f1692017-09-21 18:40:22 -0600668 case 'O':
669 if (argv[0][2] == 'd')
670 Options |= EOptionOptimizeDisable;
671 else if (argv[0][2] == 's')
GregFfb03a552018-03-29 11:49:14 -0600672#if ENABLE_OPT
GregFcd1f1692017-09-21 18:40:22 -0600673 Options |= EOptionOptimizeSize;
674#else
675 Error("-Os not available; optimizer not linked");
676#endif
677 else
678 Error("unknown -O option");
679 break;
Dan Baker5afdd782016-08-11 17:53:57 -0400680 case 'S':
John Kessenichc178f0a2017-06-23 10:58:31 -0600681 if (argc <= 1)
Dan Baker5afdd782016-08-11 17:53:57 -0400682 Error("no <stage> specified for -S");
John Kessenichc178f0a2017-06-23 10:58:31 -0600683 shaderStageName = argv[1];
684 bumpArg();
dankbaker45d49bc2016-08-08 21:43:07 -0400685 break;
John Kessenicha9313662017-06-15 10:40:49 -0600686 case 'U':
687 UserPreamble.addUndef(getStringOperand("-U<macro>: macro name"));
688 break;
John Kessenich6263fb12017-06-14 15:52:44 -0600689 case 'V':
John Kessenich6353d552017-06-23 11:11:09 -0600690 setVulkanSpv();
691 if (argv[0][2] != 0)
David Neto506d2c22018-02-27 21:55:23 -0500692 ClientInputSemanticsVersion = getAttachedNumber("-V<num> client input semantics");
John Kessenichc555ddd2015-06-17 02:38:44 +0000693 break;
John Kessenich05a70632013-09-17 19:26:08 +0000694 case 'c':
695 Options |= EOptionDumpConfig;
696 break;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000697 case 'd':
John Kessenichc6c80a62018-03-05 22:23:17 -0700698 if (strncmp(&argv[0][1], "dumpversion", strlen(&argv[0][1]) + 1) == 0 ||
699 strncmp(&argv[0][1], "dumpfullversion", strlen(&argv[0][1]) + 1) == 0)
700 Options |= EOptionDumpBareVersion;
701 else
702 Options |= EOptionDefaultDesktop;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000703 break;
John Kessenich4d65ee32016-03-12 18:17:47 -0700704 case 'e':
John Kessenich4d65ee32016-03-12 18:17:47 -0700705 entryPointName = argv[1];
John Kessenichc178f0a2017-06-23 10:58:31 -0600706 if (argc <= 1)
John Kessenicha25530c2017-09-11 20:13:49 -0600707 Error("no <name> provided for -e");
John Kessenichc178f0a2017-06-23 10:58:31 -0600708 bumpArg();
John Kessenich4d65ee32016-03-12 18:17:47 -0700709 break;
John Kessenich5d610ee2018-03-07 18:05:55 -0700710 case 'f':
711 if (strcmp(&argv[0][2], "hlsl_functionality1") == 0)
712 targetHlslFunctionality1 = true;
713 else
714 Error("-f: expected hlsl_functionality1");
715 break;
John Kessenich121853f2017-05-31 17:11:16 -0600716 case 'g':
717 Options |= EOptionDebug;
718 break;
John Kessenich68d78fd2015-07-12 19:28:10 -0600719 case 'h':
720 usage();
721 break;
John Kessenich05a70632013-09-17 19:26:08 +0000722 case 'i':
John Kessenich94a81fb2013-08-31 02:41:30 +0000723 Options |= EOptionIntermediate;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000724 break;
725 case 'l':
John Kessenichd78e3512014-08-25 20:07:55 +0000726 Options |= EOptionLinkProgram;
John Kessenich94a81fb2013-08-31 02:41:30 +0000727 break;
728 case 'm':
729 Options |= EOptionMemoryLeakMode;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000730 break;
John Kessenich68d78fd2015-07-12 19:28:10 -0600731 case 'o':
John Kessenichc178f0a2017-06-23 10:58:31 -0600732 if (argc <= 1)
John Kessenich68d78fd2015-07-12 19:28:10 -0600733 Error("no <file> provided for -o");
John Kessenichc178f0a2017-06-23 10:58:31 -0600734 binaryFileName = argv[1];
735 bumpArg();
John Kessenich68d78fd2015-07-12 19:28:10 -0600736 break;
John Kessenich11f9fc72013-11-07 01:06:34 +0000737 case 'q':
738 Options |= EOptionDumpReflection;
739 break;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000740 case 'r':
John Kessenich94a81fb2013-08-31 02:41:30 +0000741 Options |= EOptionRelaxedErrors;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000742 break;
743 case 's':
John Kessenich94a81fb2013-08-31 02:41:30 +0000744 Options |= EOptionSuppressInfolog;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000745 break;
John Kessenich38f3b892013-09-06 19:52:57 +0000746 case 't':
Juan Lopeza558b262017-04-02 23:04:00 +0200747 Options |= EOptionMultiThreaded;
John Kessenich38f3b892013-09-06 19:52:57 +0000748 break;
John Kessenich319de232013-12-04 04:43:40 +0000749 case 'v':
750 Options |= EOptionDumpVersions;
751 break;
John Kessenichb0a7eb52013-11-07 17:44:20 +0000752 case 'w':
753 Options |= EOptionSuppressWarnings;
754 break;
Johannes van Waverenecb0f3b2016-05-27 12:55:53 -0500755 case 'x':
756 Options |= EOptionOutputHexadecimal;
Johannes van Waverenecb0f3b2016-05-27 12:55:53 -0500757 break;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000758 default:
John Kessenich68d78fd2015-07-12 19:28:10 -0600759 usage();
760 break;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000761 }
John Kessenich38f3b892013-09-06 19:52:57 +0000762 } else {
John Kessenich05a70632013-09-17 19:26:08 +0000763 std::string name(argv[0]);
764 if (! SetConfigFile(name)) {
Juan Lopeza558b262017-04-02 23:04:00 +0200765 workItems.push_back(std::unique_ptr<glslang::TWorkItem>(new glslang::TWorkItem(name)));
John Kessenich05a70632013-09-17 19:26:08 +0000766 }
John Kessenich38f3b892013-09-06 19:52:57 +0000767 }
John Kessenich2b07c7e2013-07-31 18:44:13 +0000768 }
769
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +0200770 // Make sure that -S is always specified if --stdin is specified
771 if ((Options & EOptionStdin) && shaderStageName == nullptr)
772 Error("must provide -S when --stdin is given");
773
John Kessenich68d78fd2015-07-12 19:28:10 -0600774 // Make sure that -E is not specified alongside linking (which includes SPV generation)
John Kesseniche5c394b2019-07-02 09:32:48 -0600775 // Or things that require linking
776 if (Options & EOptionOutputPreprocessed) {
777 if (Options & EOptionLinkProgram)
778 Error("can't use -E when linking is selected");
779 if (Options & EOptionDumpReflection)
780 Error("reflection requires linking, which can't be used when -E when is selected");
781 }
782
783 // reflection requires linking
784 if ((Options & EOptionDumpReflection) && !(Options & EOptionLinkProgram))
785 Error("reflection requires -l for linking");
John Kessenichc555ddd2015-06-17 02:38:44 +0000786
Johannes van Waverenecb0f3b2016-05-27 12:55:53 -0500787 // -o or -x makes no sense if there is no target binary
John Kessenich68d78fd2015-07-12 19:28:10 -0600788 if (binaryFileName && (Options & EOptionSpv) == 0)
789 Error("no binary generation requested (e.g., -V)");
steve-lunarge0b9deb2016-09-16 13:26:37 -0600790
791 if ((Options & EOptionFlattenUniformArrays) != 0 &&
792 (Options & EOptionReadHlsl) == 0)
793 Error("uniform array flattening only valid when compiling HLSL source.");
John Kessenich8717a5d2018-10-26 10:12:32 -0600794
795 // rationalize client and target language
796 if (TargetLanguage == glslang::EShTargetNone) {
797 switch (ClientVersion) {
798 case glslang::EShTargetVulkan_1_0:
799 TargetLanguage = glslang::EShTargetSpv;
800 TargetVersion = glslang::EShTargetSpv_1_0;
801 break;
802 case glslang::EShTargetVulkan_1_1:
803 TargetLanguage = glslang::EShTargetSpv;
804 TargetVersion = glslang::EShTargetSpv_1_3;
805 break;
806 case glslang::EShTargetOpenGL_450:
807 TargetLanguage = glslang::EShTargetSpv;
808 TargetVersion = glslang::EShTargetSpv_1_0;
809 break;
810 default:
811 break;
812 }
813 }
814 if (TargetLanguage != glslang::EShTargetNone && Client == glslang::EShClientNone)
815 Error("To generate SPIR-V, also specify client semantics. See -G and -V.");
John Kessenich2b07c7e2013-07-31 18:44:13 +0000816}
817
John Kessenich68d78fd2015-07-12 19:28:10 -0600818//
819// Translate the meaningful subset of command-line options to parser-behavior options.
820//
John Kessenichb0a7eb52013-11-07 17:44:20 +0000821void SetMessageOptions(EShMessages& messages)
822{
823 if (Options & EOptionRelaxedErrors)
824 messages = (EShMessages)(messages | EShMsgRelaxedErrors);
825 if (Options & EOptionIntermediate)
826 messages = (EShMessages)(messages | EShMsgAST);
827 if (Options & EOptionSuppressWarnings)
828 messages = (EShMessages)(messages | EShMsgSuppressWarnings);
John Kessenich68d78fd2015-07-12 19:28:10 -0600829 if (Options & EOptionSpv)
830 messages = (EShMessages)(messages | EShMsgSpvRules);
831 if (Options & EOptionVulkanRules)
832 messages = (EShMessages)(messages | EShMsgVulkanRules);
Andrew Woloszynaae1ad82015-06-24 17:00:46 -0400833 if (Options & EOptionOutputPreprocessed)
834 messages = (EShMessages)(messages | EShMsgOnlyPreprocessor);
John Kessenich66e2faf2016-03-12 18:34:36 -0700835 if (Options & EOptionReadHlsl)
836 messages = (EShMessages)(messages | EShMsgReadHlsl);
John Kessenicha86836e2016-07-09 14:50:57 -0600837 if (Options & EOptionCascadingErrors)
838 messages = (EShMessages)(messages | EShMsgCascadingErrors);
John Kessenich906cc212016-12-09 19:22:20 -0700839 if (Options & EOptionKeepUncalled)
840 messages = (EShMessages)(messages | EShMsgKeepUncalled);
John Kessenich4f1403e2017-04-05 17:38:20 -0600841 if (Options & EOptionHlslOffsets)
842 messages = (EShMessages)(messages | EShMsgHlslOffsets);
John Kessenich121853f2017-05-31 17:11:16 -0600843 if (Options & EOptionDebug)
844 messages = (EShMessages)(messages | EShMsgDebugInfo);
Rex Xucb61eec2018-03-07 13:10:01 +0800845 if (HlslEnable16BitTypes)
846 messages = (EShMessages)(messages | EShMsgHlslEnable16BitTypes);
GregFfb03a552018-03-29 11:49:14 -0600847 if ((Options & EOptionOptimizeDisable) || !ENABLE_OPT)
848 messages = (EShMessages)(messages | EShMsgHlslLegalization);
John Kessenichbd1c1832018-12-07 18:38:26 -0700849 if (HlslDX9compatible)
850 messages = (EShMessages)(messages | EShMsgHlslDX9Compatible);
Christoph Kubisch55ba3ea2019-04-13 22:18:16 +0200851 if (DumpBuiltinSymbols)
852 messages = (EShMessages)(messages | EShMsgBuiltinSymbolTable);
John Kessenichb0a7eb52013-11-07 17:44:20 +0000853}
854
John Kessenich68d78fd2015-07-12 19:28:10 -0600855//
John Kessenich69f4b512013-09-04 21:19:27 +0000856// Thread entry point, for non-linking asynchronous mode.
John Kessenichc999ba22013-11-07 23:33:24 +0000857//
Juan Lopeza558b262017-04-02 23:04:00 +0200858void CompileShaders(glslang::TWorklist& worklist)
John Kessenich2b07c7e2013-07-31 18:44:13 +0000859{
John Kessenich7f0bcfd2018-04-05 19:00:01 -0600860 if (Options & EOptionDebug)
861 Error("cannot generate debug information unless linking to generate code");
862
John Kessenich38f3b892013-09-06 19:52:57 +0000863 glslang::TWorkItem* workItem;
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +0200864 if (Options & EOptionStdin) {
John Kesseniche7f9cae2018-07-12 15:11:07 -0600865 if (worklist.remove(workItem)) {
866 ShHandle compiler = ShConstructCompiler(FindLanguage("stdin"), Options);
867 if (compiler == nullptr)
868 return;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000869
John Kesseniche7f9cae2018-07-12 15:11:07 -0600870 CompileFile("stdin", compiler);
John Kessenich2b07c7e2013-07-31 18:44:13 +0000871
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +0200872 if (! (Options & EOptionSuppressInfolog))
873 workItem->results = ShGetInfoLog(compiler);
John Kessenich2b07c7e2013-07-31 18:44:13 +0000874
John Kesseniche7f9cae2018-07-12 15:11:07 -0600875 ShDestruct(compiler);
876 }
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +0200877 } else {
878 while (worklist.remove(workItem)) {
879 ShHandle compiler = ShConstructCompiler(FindLanguage(workItem->name), Options);
880 if (compiler == 0)
881 return;
882
883 CompileFile(workItem->name.c_str(), compiler);
884
885 if (! (Options & EOptionSuppressInfolog))
886 workItem->results = ShGetInfoLog(compiler);
887
888 ShDestruct(compiler);
889 }
John Kessenich2b07c7e2013-07-31 18:44:13 +0000890 }
John Kessenich2b07c7e2013-07-31 18:44:13 +0000891}
892
John Kessenich6626cad2015-06-19 05:14:19 +0000893// Outputs the given string, but only if it is non-null and non-empty.
894// This prevents erroneous newlines from appearing.
Andrew Woloszynaae1ad82015-06-24 17:00:46 -0400895void PutsIfNonEmpty(const char* str)
John Kessenich6626cad2015-06-19 05:14:19 +0000896{
897 if (str && str[0]) {
898 puts(str);
899 }
900}
901
Andrew Woloszynaae1ad82015-06-24 17:00:46 -0400902// Outputs the given string to stderr, but only if it is non-null and non-empty.
903// This prevents erroneous newlines from appearing.
904void StderrIfNonEmpty(const char* str)
905{
John Kessenich04acb1b2017-06-14 17:36:50 -0600906 if (str && str[0])
907 fprintf(stderr, "%s\n", str);
Andrew Woloszynaae1ad82015-06-24 17:00:46 -0400908}
909
John Kessenichc57b2a92016-01-16 15:30:03 -0700910// Simple bundling of what makes a compilation unit for ease in passing around,
911// and separation of handling file IO versus API (programmatic) compilation.
912struct ShaderCompUnit {
913 EShLanguage stage;
John Kessenich04acb1b2017-06-14 17:36:50 -0600914 static const int maxCount = 1;
915 int count; // live number of strings/names
John Kessenicha9313662017-06-15 10:40:49 -0600916 const char* text[maxCount]; // memory owned/managed externally
John Kessenich04acb1b2017-06-14 17:36:50 -0600917 std::string fileName[maxCount]; // hold's the memory, but...
918 const char* fileNameList[maxCount]; // downstream interface wants pointers
dankbakerafe6e9c2016-08-21 12:29:08 -0400919
John Kessenich04acb1b2017-06-14 17:36:50 -0600920 ShaderCompUnit(EShLanguage stage) : stage(stage), count(0) { }
dankbakerafe6e9c2016-08-21 12:29:08 -0400921
John Kessenich04acb1b2017-06-14 17:36:50 -0600922 ShaderCompUnit(const ShaderCompUnit& rhs)
dankbakerafe6e9c2016-08-21 12:29:08 -0400923 {
924 stage = rhs.stage;
John Kessenich04acb1b2017-06-14 17:36:50 -0600925 count = rhs.count;
926 for (int i = 0; i < count; ++i) {
927 fileName[i] = rhs.fileName[i];
928 text[i] = rhs.text[i];
929 fileNameList[i] = rhs.fileName[i].c_str();
930 }
dankbakerafe6e9c2016-08-21 12:29:08 -0400931 }
932
John Kessenicha9313662017-06-15 10:40:49 -0600933 void addString(std::string& ifileName, const char* itext)
John Kessenich04acb1b2017-06-14 17:36:50 -0600934 {
935 assert(count < maxCount);
936 fileName[count] = ifileName;
937 text[count] = itext;
938 fileNameList[count] = fileName[count].c_str();
939 ++count;
940 }
John Kessenichc57b2a92016-01-16 15:30:03 -0700941};
942
John Kessenich69f4b512013-09-04 21:19:27 +0000943//
John Kessenichc57b2a92016-01-16 15:30:03 -0700944// For linking mode: Will independently parse each compilation unit, but then put them
945// in the same program and link them together, making at most one linked module per
946// pipeline stage.
John Kessenich69f4b512013-09-04 21:19:27 +0000947//
948// Uses the new C++ interface instead of the old handle-based interface.
949//
John Kessenichc57b2a92016-01-16 15:30:03 -0700950
951void CompileAndLinkShaderUnits(std::vector<ShaderCompUnit> compUnits)
John Kessenich69f4b512013-09-04 21:19:27 +0000952{
953 // keep track of what to free
954 std::list<glslang::TShader*> shaders;
John Kessenichc57b2a92016-01-16 15:30:03 -0700955
John Kessenich69f4b512013-09-04 21:19:27 +0000956 EShMessages messages = EShMsgDefault;
John Kessenichb0a7eb52013-11-07 17:44:20 +0000957 SetMessageOptions(messages);
John Kessenich69f4b512013-09-04 21:19:27 +0000958
John Kessenich69f4b512013-09-04 21:19:27 +0000959 //
960 // Per-shader processing...
961 //
962
John Kessenich5b0f13a2013-11-01 03:08:40 +0000963 glslang::TProgram& program = *new glslang::TProgram;
rdb32084e82016-02-23 22:17:38 +0100964 for (auto it = compUnits.cbegin(); it != compUnits.cend(); ++it) {
965 const auto &compUnit = *it;
John Kessenichc57b2a92016-01-16 15:30:03 -0700966 glslang::TShader* shader = new glslang::TShader(compUnit.stage);
John Kessenich04acb1b2017-06-14 17:36:50 -0600967 shader->setStringsWithLengthsAndNames(compUnit.text, NULL, compUnit.fileNameList, compUnit.count);
John Kessenich640bd092018-08-09 14:15:00 -0600968 if (entryPointName)
John Kessenich4d65ee32016-03-12 18:17:47 -0700969 shader->setEntryPoint(entryPointName);
John Kessenich3693e632017-09-29 17:51:52 -0600970 if (sourceEntryPointName) {
971 if (entryPointName == nullptr)
972 printf("Warning: Changing source entry point name without setting an entry-point name.\n"
973 "Use '-e <name>'.\n");
steve-lunargf1e0c872016-10-31 15:13:43 -0600974 shader->setSourceEntryPoint(sourceEntryPointName);
John Kessenich3693e632017-09-29 17:51:52 -0600975 }
John Kessenicha9313662017-06-15 10:40:49 -0600976 if (UserPreamble.isSet())
977 shader->setPreamble(UserPreamble.get());
John Kessenich2a271162017-07-20 20:00:36 -0600978 shader->addProcesses(Processes);
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600979
LoopDawg08a14422017-10-17 19:27:14 -0600980 // Set IO mapper binding shift values
981 for (int r = 0; r < glslang::EResCount; ++r) {
982 const glslang::TResourceType res = glslang::TResourceType(r);
983
984 // Set base bindings
985 shader->setShiftBinding(res, baseBinding[res][compUnit.stage]);
986
987 // Set bindings for particular resource sets
988 // TODO: use a range based for loop here, when available in all environments.
989 for (auto i = baseBindingForSet[res][compUnit.stage].begin();
990 i != baseBindingForSet[res][compUnit.stage].end(); ++i)
LoopDawge5709552017-10-21 10:46:39 -0600991 shader->setShiftBindingForSet(res, i->second, i->first);
LoopDawg08a14422017-10-17 19:27:14 -0600992 }
993
steve-lunarge0b9deb2016-09-16 13:26:37 -0600994 shader->setFlattenUniformArrays((Options & EOptionFlattenUniformArrays) != 0);
steve-lunargcce8d482016-10-14 18:36:42 -0600995 shader->setNoStorageFormat((Options & EOptionNoStorageFormat) != 0);
John Kessenich605afc72019-06-17 23:33:09 -0600996 shader->setNanMinMaxClamp(NaNClamp);
Hyangran Park36dc8292017-05-02 16:27:29 +0900997 shader->setResourceSetBinding(baseResourceSetBinding[compUnit.stage]);
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600998
steve-lunargbe283552017-04-18 12:18:01 -0600999 if (Options & EOptionHlslIoMapping)
1000 shader->setHlslIoMapping(true);
1001
steve-lunarg7f7c2ed2016-09-07 15:20:19 -06001002 if (Options & EOptionAutoMapBindings)
1003 shader->setAutoMapBindings(true);
John Kessenichecba76f2017-01-06 00:34:48 -07001004
John Kessenich71facdf2017-05-17 18:28:19 -06001005 if (Options & EOptionAutoMapLocations)
1006 shader->setAutoMapLocations(true);
1007
LoopDawgb22c0692017-12-06 16:52:03 -07001008 if (Options & EOptionInvertY)
1009 shader->setInvertY(true);
1010
Neil Roberts16f53472018-03-20 17:30:53 +01001011 for (auto& uniOverride : uniformLocationOverrides) {
1012 shader->addUniformLocationOverride(uniOverride.first.c_str(),
1013 uniOverride.second);
1014 }
1015
Neil Robertsb0f3d792018-03-20 17:41:05 +01001016 shader->setUniformLocationBase(uniformBase);
1017
John Kessenich4be4aeb2017-06-23 10:50:22 -06001018 // Set up the environment, some subsettings take precedence over earlier
1019 // ways of setting things.
1020 if (Options & EOptionSpv) {
John Kessenich8717a5d2018-10-26 10:12:32 -06001021 shader->setEnvInput((Options & EOptionReadHlsl) ? glslang::EShSourceHlsl
1022 : glslang::EShSourceGlsl,
1023 compUnit.stage, Client, ClientInputSemanticsVersion);
1024 shader->setEnvClient(Client, ClientVersion);
1025 shader->setEnvTarget(TargetLanguage, TargetVersion);
John Kessenich5d610ee2018-03-07 18:05:55 -07001026 if (targetHlslFunctionality1)
1027 shader->setEnvTargetHlslFunctionality1();
John Kessenich4be4aeb2017-06-23 10:50:22 -06001028 }
1029
John Kessenich69f4b512013-09-04 21:19:27 +00001030 shaders.push_back(shader);
John Kessenichb3297152015-07-11 18:01:03 -06001031
John Kessenich4be4aeb2017-06-23 10:50:22 -06001032 const int defaultVersion = Options & EOptionDefaultDesktop ? 110 : 100;
John Kessenich69f4b512013-09-04 21:19:27 +00001033
John Kessenich3494b4d2017-05-22 15:00:42 -06001034 DirStackFileIncluder includer;
John Kessenich971a0a82017-06-07 15:06:58 -06001035 std::for_each(IncludeDirectoryList.rbegin(), IncludeDirectoryList.rend(), [&includer](const std::string& dir) {
1036 includer.pushExternalLocalDirectory(dir); });
John Kessenichc555ddd2015-06-17 02:38:44 +00001037 if (Options & EOptionOutputPreprocessed) {
1038 std::string str;
John Kessenich086febc2018-10-25 12:43:02 -06001039 if (shader->preprocess(&Resources, defaultVersion, ENoProfile, false, false, messages, &str, includer)) {
Andrew Woloszynaae1ad82015-06-24 17:00:46 -04001040 PutsIfNonEmpty(str.c_str());
1041 } else {
1042 CompileFailed = true;
1043 }
1044 StderrIfNonEmpty(shader->getInfoLog());
1045 StderrIfNonEmpty(shader->getInfoDebugLog());
John Kessenichc555ddd2015-06-17 02:38:44 +00001046 continue;
1047 }
John Kessenich086febc2018-10-25 12:43:02 -06001048
John Kessenich3494b4d2017-05-22 15:00:42 -06001049 if (! shader->parse(&Resources, defaultVersion, false, messages, includer))
John Kessenichc999ba22013-11-07 23:33:24 +00001050 CompileFailed = true;
John Kessenichc555ddd2015-06-17 02:38:44 +00001051
John Kessenich69f4b512013-09-04 21:19:27 +00001052 program.addShader(shader);
1053
John Kessenichc57b2a92016-01-16 15:30:03 -07001054 if (! (Options & EOptionSuppressInfolog) &&
1055 ! (Options & EOptionMemoryLeakMode)) {
John Kessenich04acb1b2017-06-14 17:36:50 -06001056 PutsIfNonEmpty(compUnit.fileName[0].c_str());
Andrew Woloszynaae1ad82015-06-24 17:00:46 -04001057 PutsIfNonEmpty(shader->getInfoLog());
1058 PutsIfNonEmpty(shader->getInfoDebugLog());
John Kessenich69f4b512013-09-04 21:19:27 +00001059 }
John Kessenich69f4b512013-09-04 21:19:27 +00001060 }
1061
1062 //
1063 // Program-level processing...
1064 //
1065
John Kessenich4d65ee32016-03-12 18:17:47 -07001066 // Link
John Kessenich68d78fd2015-07-12 19:28:10 -06001067 if (! (Options & EOptionOutputPreprocessed) && ! program.link(messages))
John Kessenichc999ba22013-11-07 23:33:24 +00001068 LinkFailed = true;
1069
steve-lunarg9ae34742016-10-05 13:40:13 -06001070 // Map IO
1071 if (Options & EOptionSpv) {
1072 if (!program.mapIO())
1073 LinkFailed = true;
1074 }
John Kessenichecba76f2017-01-06 00:34:48 -07001075
John Kessenich4d65ee32016-03-12 18:17:47 -07001076 // Report
John Kessenichc57b2a92016-01-16 15:30:03 -07001077 if (! (Options & EOptionSuppressInfolog) &&
1078 ! (Options & EOptionMemoryLeakMode)) {
Andrew Woloszynaae1ad82015-06-24 17:00:46 -04001079 PutsIfNonEmpty(program.getInfoLog());
1080 PutsIfNonEmpty(program.getInfoDebugLog());
John Kessenich69f4b512013-09-04 21:19:27 +00001081 }
1082
John Kessenich4d65ee32016-03-12 18:17:47 -07001083 // Reflect
John Kessenich11f9fc72013-11-07 01:06:34 +00001084 if (Options & EOptionDumpReflection) {
baldurk6d477852019-01-29 15:45:56 +00001085 program.buildReflection(ReflectOptions);
John Kessenich11f9fc72013-11-07 01:06:34 +00001086 program.dumpReflection();
1087 }
1088
John Kessenich4d65ee32016-03-12 18:17:47 -07001089 // Dump SPIR-V
John Kessenich0df0cde2015-03-03 17:09:43 +00001090 if (Options & EOptionSpv) {
John Kessenich92f90382014-07-28 04:21:04 +00001091 if (CompileFailed || LinkFailed)
John Kessenich68d78fd2015-07-12 19:28:10 -06001092 printf("SPIR-V is not generated for failed compile or link\n");
John Kessenich92f90382014-07-28 04:21:04 +00001093 else {
1094 for (int stage = 0; stage < EShLangCount; ++stage) {
John Kessenicha7a68a92014-08-24 18:21:00 +00001095 if (program.getIntermediate((EShLanguage)stage)) {
John Kessenich0df0cde2015-03-03 17:09:43 +00001096 std::vector<unsigned int> spirv;
Lei Zhang09caf122016-05-02 18:11:54 -04001097 std::string warningsErrors;
Lei Zhang17535f72016-05-04 15:55:59 -04001098 spv::SpvBuildLogger logger;
John Kessenich121853f2017-05-31 17:11:16 -06001099 glslang::SpvOptions spvOptions;
1100 if (Options & EOptionDebug)
1101 spvOptions.generateDebugInfo = true;
GregF52fe3d52017-09-28 10:08:32 -06001102 spvOptions.disableOptimizer = (Options & EOptionOptimizeDisable) != 0;
1103 spvOptions.optimizeSize = (Options & EOptionOptimizeSize) != 0;
John Kessenich717c80a2018-08-23 15:17:10 -06001104 spvOptions.disassemble = SpvToolsDisassembler;
John Kessenichc3404252018-08-23 15:29:08 -06001105 spvOptions.validate = SpvToolsValidate;
John Kessenich121853f2017-05-31 17:11:16 -06001106 glslang::GlslangToSpv(*program.getIntermediate((EShLanguage)stage), spirv, &logger, &spvOptions);
John Kessenichc57b2a92016-01-16 15:30:03 -07001107
1108 // Dump the spv to a file or stdout, etc., but only if not doing
1109 // memory/perf testing, as it's not internal to programmatic use.
1110 if (! (Options & EOptionMemoryLeakMode)) {
Johannes van Waverenecb0f3b2016-05-27 12:55:53 -05001111 printf("%s", logger.getAllMessages().c_str());
1112 if (Options & EOptionOutputHexadecimal) {
John Kessenich8f674e82017-02-18 09:45:40 -07001113 glslang::OutputSpvHex(spirv, GetBinaryName((EShLanguage)stage), variableName);
Johannes van Waverenecb0f3b2016-05-27 12:55:53 -05001114 } else {
1115 glslang::OutputSpvBin(spirv, GetBinaryName((EShLanguage)stage));
1116 }
John Kesseniche2156222018-06-11 18:12:15 -06001117 if (!SpvToolsDisassembler && (Options & EOptionHumanReadableSpv))
John Kessenichc57b2a92016-01-16 15:30:03 -07001118 spv::Disassemble(std::cout, spirv);
John Kessenichacba7722015-03-04 03:48:38 +00001119 }
John Kessenicha7a68a92014-08-24 18:21:00 +00001120 }
John Kessenich92f90382014-07-28 04:21:04 +00001121 }
1122 }
1123 }
1124
John Kessenich5b0f13a2013-11-01 03:08:40 +00001125 // Free everything up, program has to go before the shaders
1126 // because it might have merged stuff from the shaders, and
1127 // the stuff from the shaders has to have its destructors called
1128 // before the pools holding the memory in the shaders is freed.
1129 delete &program;
John Kessenich69f4b512013-09-04 21:19:27 +00001130 while (shaders.size() > 0) {
1131 delete shaders.back();
1132 shaders.pop_back();
1133 }
John Kessenich69f4b512013-09-04 21:19:27 +00001134}
1135
John Kessenichc57b2a92016-01-16 15:30:03 -07001136//
1137// Do file IO part of compile and link, handing off the pure
1138// API/programmatic mode to CompileAndLinkShaderUnits(), which can
1139// be put in a loop for testing memory footprint and performance.
1140//
1141// This is just for linking mode: meaning all the shaders will be put into the
1142// the same program linked together.
1143//
1144// This means there are a limited number of work items (not multi-threading mode)
1145// and that the point is testing at the linking level. Hence, to enable
1146// performance and memory testing, the actual compile/link can be put in
1147// a loop, independent of processing the work items and file IO.
1148//
Juan Lopeza558b262017-04-02 23:04:00 +02001149void CompileAndLinkShaderFiles(glslang::TWorklist& Worklist)
John Kessenichc57b2a92016-01-16 15:30:03 -07001150{
1151 std::vector<ShaderCompUnit> compUnits;
1152
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001153 // If this is using stdin, we can't really detect multiple different file
1154 // units by input type. We need to assume that we're just being given one
1155 // file of a certain type.
1156 if ((Options & EOptionStdin) != 0) {
1157 ShaderCompUnit compUnit(FindLanguage("stdin"));
1158 std::istreambuf_iterator<char> begin(std::cin), end;
1159 std::string tempString(begin, end);
1160 char* fileText = strdup(tempString.c_str());
1161 std::string fileName = "stdin";
1162 compUnit.addString(fileName, fileText);
John Kessenichc57b2a92016-01-16 15:30:03 -07001163 compUnits.push_back(compUnit);
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001164 } else {
1165 // Transfer all the work items from to a simple list of
1166 // of compilation units. (We don't care about the thread
1167 // work-item distribution properties in this path, which
1168 // is okay due to the limited number of shaders, know since
1169 // they are all getting linked together.)
1170 glslang::TWorkItem* workItem;
1171 while (Worklist.remove(workItem)) {
1172 ShaderCompUnit compUnit(FindLanguage(workItem->name));
1173 char* fileText = ReadFileData(workItem->name.c_str());
1174 if (fileText == nullptr)
1175 usage();
1176 compUnit.addString(workItem->name, fileText);
1177 compUnits.push_back(compUnit);
1178 }
John Kessenichc57b2a92016-01-16 15:30:03 -07001179 }
1180
1181 // Actual call to programmatic processing of compile and link,
1182 // in a loop for testing memory and performance. This part contains
1183 // all the perf/memory that a programmatic consumer will care about.
1184 for (int i = 0; i < ((Options & EOptionMemoryLeakMode) ? 100 : 1); ++i) {
1185 for (int j = 0; j < ((Options & EOptionMemoryLeakMode) ? 100 : 1); ++j)
1186 CompileAndLinkShaderUnits(compUnits);
1187
1188 if (Options & EOptionMemoryLeakMode)
1189 glslang::OS_DumpMemoryCounters();
1190 }
1191
John Kessenicha9313662017-06-15 10:40:49 -06001192 // free memory from ReadFileData, which got stored in a const char*
1193 // as the first string above
rdb32084e82016-02-23 22:17:38 +01001194 for (auto it = compUnits.begin(); it != compUnits.end(); ++it)
John Kessenicha9313662017-06-15 10:40:49 -06001195 FreeFileData(const_cast<char*>(it->text[0]));
John Kessenichc57b2a92016-01-16 15:30:03 -07001196}
1197
John Kessenich94f28eb2017-11-13 01:32:06 -07001198int singleMain()
John Kessenicha0af4732012-12-12 21:15:54 +00001199{
Juan Lopeza558b262017-04-02 23:04:00 +02001200 glslang::TWorklist workList;
John Kessenich94f28eb2017-11-13 01:32:06 -07001201 std::for_each(WorkItems.begin(), WorkItems.end(), [&workList](std::unique_ptr<glslang::TWorkItem>& item) {
Juan Lopeza558b262017-04-02 23:04:00 +02001202 assert(item);
1203 workList.add(item.get());
1204 });
John Kessenich2b07c7e2013-07-31 18:44:13 +00001205
John Kessenich05a70632013-09-17 19:26:08 +00001206 if (Options & EOptionDumpConfig) {
Lei Zhang414eb602016-03-04 16:22:34 -05001207 printf("%s", glslang::GetDefaultTBuiltInResourceString().c_str());
Juan Lopeza558b262017-04-02 23:04:00 +02001208 if (workList.empty())
John Kessenich05a70632013-09-17 19:26:08 +00001209 return ESuccess;
1210 }
1211
John Kessenichc6c80a62018-03-05 22:23:17 -07001212 if (Options & EOptionDumpBareVersion) {
1213 printf("%d.%d.%d\n",
1214 glslang::GetSpirvGeneratorVersion(), GLSLANG_MINOR_VERSION, GLSLANG_PATCH_LEVEL);
1215 if (workList.empty())
1216 return ESuccess;
1217 } else if (Options & EOptionDumpVersions) {
1218 printf("Glslang Version: %d.%d.%d\n",
1219 glslang::GetSpirvGeneratorVersion(), GLSLANG_MINOR_VERSION, GLSLANG_PATCH_LEVEL);
John Kessenich319de232013-12-04 04:43:40 +00001220 printf("ESSL Version: %s\n", glslang::GetEsslVersionString());
1221 printf("GLSL Version: %s\n", glslang::GetGlslVersionString());
John Kessenich68d78fd2015-07-12 19:28:10 -06001222 std::string spirvVersion;
1223 glslang::GetSpirvVersion(spirvVersion);
John Kessenich0da9eaa2015-08-01 17:10:02 -06001224 printf("SPIR-V Version %s\n", spirvVersion.c_str());
John Kessenich5e4b1242015-08-06 22:53:06 -06001225 printf("GLSL.std.450 Version %d, Revision %d\n", GLSLstd450Version, GLSLstd450Revision);
John Kessenich55e7d112015-11-15 21:33:39 -07001226 printf("Khronos Tool ID %d\n", glslang::GetKhronosToolId());
John Kessenicha372a3e2017-11-02 22:32:14 -06001227 printf("SPIR-V Generator Version %d\n", glslang::GetSpirvGeneratorVersion());
John Kessenichb84313d2016-07-20 16:03:29 -06001228 printf("GL_KHR_vulkan_glsl version %d\n", 100);
1229 printf("ARB_GL_gl_spirv version %d\n", 100);
Juan Lopeza558b262017-04-02 23:04:00 +02001230 if (workList.empty())
John Kessenich319de232013-12-04 04:43:40 +00001231 return ESuccess;
1232 }
1233
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001234 if (workList.empty() && ((Options & EOptionStdin) == 0)) {
John Kessenich05a70632013-09-17 19:26:08 +00001235 usage();
John Kessenich05a70632013-09-17 19:26:08 +00001236 }
1237
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001238 if (Options & EOptionStdin) {
John Kessenich94f28eb2017-11-13 01:32:06 -07001239 WorkItems.push_back(std::unique_ptr<glslang::TWorkItem>{new glslang::TWorkItem("stdin")});
1240 workList.add(WorkItems.back().get());
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001241 }
1242
John Kessenich05a70632013-09-17 19:26:08 +00001243 ProcessConfigFile();
1244
John Kessenich086febc2018-10-25 12:43:02 -06001245 if ((Options & EOptionReadHlsl) && !((Options & EOptionOutputPreprocessed) || (Options & EOptionSpv)))
1246 Error("ERROR: HLSL requires SPIR-V code generation (or preprocessing only)");
1247
John Kessenich69f4b512013-09-04 21:19:27 +00001248 //
1249 // Two modes:
John Kessenich38f3b892013-09-06 19:52:57 +00001250 // 1) linking all arguments together, single-threaded, new C++ interface
1251 // 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 +00001252 //
John Kessenich086febc2018-10-25 12:43:02 -06001253 if (Options & (EOptionLinkProgram | EOptionOutputPreprocessed)) {
John Kessenichc36e1d82013-11-01 17:41:52 +00001254 glslang::InitializeProcess();
John Kesseniche2c15b42017-11-16 22:48:41 -07001255 glslang::InitializeProcess(); // also test reference counting of users
1256 glslang::InitializeProcess(); // also test reference counting of users
1257 glslang::FinalizeProcess(); // also test reference counting of users
1258 glslang::FinalizeProcess(); // also test reference counting of users
Juan Lopeza558b262017-04-02 23:04:00 +02001259 CompileAndLinkShaderFiles(workList);
John Kessenichc36e1d82013-11-01 17:41:52 +00001260 glslang::FinalizeProcess();
1261 } else {
1262 ShInitialize();
John Kesseniche2c15b42017-11-16 22:48:41 -07001263 ShInitialize(); // also test reference counting of users
1264 ShFinalize(); // also test reference counting of users
John Kessenichc36e1d82013-11-01 17:41:52 +00001265
Juan Lopeza558b262017-04-02 23:04:00 +02001266 bool printShaderNames = workList.size() > 1;
John Kessenich69f4b512013-09-04 21:19:27 +00001267
John Kesseniche2c15b42017-11-16 22:48:41 -07001268 if (Options & EOptionMultiThreaded) {
Juan Lopeza558b262017-04-02 23:04:00 +02001269 std::array<std::thread, 16> threads;
John Kesseniche2c15b42017-11-16 22:48:41 -07001270 for (unsigned int t = 0; t < threads.size(); ++t) {
Juan Lopeza558b262017-04-02 23:04:00 +02001271 threads[t] = std::thread(CompileShaders, std::ref(workList));
John Kesseniche2c15b42017-11-16 22:48:41 -07001272 if (threads[t].get_id() == std::thread::id()) {
John Kessenichaf527992017-11-02 22:48:15 -06001273 fprintf(stderr, "Failed to create thread\n");
John Kessenich38f3b892013-09-06 19:52:57 +00001274 return EFailThreadCreate;
1275 }
John Kessenicha0af4732012-12-12 21:15:54 +00001276 }
Juan Lopeza558b262017-04-02 23:04:00 +02001277
1278 std::for_each(threads.begin(), threads.end(), [](std::thread& t) { t.join(); });
John Kessenichc999ba22013-11-07 23:33:24 +00001279 } else
Juan Lopeza558b262017-04-02 23:04:00 +02001280 CompileShaders(workList);
John Kessenich38f3b892013-09-06 19:52:57 +00001281
1282 // Print out all the resulting infologs
John Kessenich94f28eb2017-11-13 01:32:06 -07001283 for (size_t w = 0; w < WorkItems.size(); ++w) {
1284 if (WorkItems[w]) {
1285 if (printShaderNames || WorkItems[w]->results.size() > 0)
1286 PutsIfNonEmpty(WorkItems[w]->name.c_str());
1287 PutsIfNonEmpty(WorkItems[w]->results.c_str());
John Kessenich38f3b892013-09-06 19:52:57 +00001288 }
1289 }
John Kessenichc36e1d82013-11-01 17:41:52 +00001290
1291 ShFinalize();
John Kessenicha0af4732012-12-12 21:15:54 +00001292 }
John Kessenich2b07c7e2013-07-31 18:44:13 +00001293
John Kessenichc999ba22013-11-07 23:33:24 +00001294 if (CompileFailed)
John Kessenicha0af4732012-12-12 21:15:54 +00001295 return EFailCompile;
John Kessenichc999ba22013-11-07 23:33:24 +00001296 if (LinkFailed)
John Kessenicha0af4732012-12-12 21:15:54 +00001297 return EFailLink;
1298
1299 return 0;
1300}
1301
John Kessenich94f28eb2017-11-13 01:32:06 -07001302int C_DECL main(int argc, char* argv[])
1303{
1304 ProcessArguments(WorkItems, argc, argv);
1305
1306 int ret = 0;
1307
1308 // Loop over the entire init/finalize cycle to watch memory changes
1309 const int iterations = 1;
1310 if (iterations > 1)
1311 glslang::OS_DumpMemoryCounters();
1312 for (int i = 0; i < iterations; ++i) {
1313 ret = singleMain();
1314 if (iterations > 1)
1315 glslang::OS_DumpMemoryCounters();
1316 }
1317
1318 return ret;
1319}
1320
John Kessenicha0af4732012-12-12 21:15:54 +00001321//
1322// Deduce the language from the filename. Files must end in one of the
1323// following extensions:
1324//
John Kessenich2b07c7e2013-07-31 18:44:13 +00001325// .vert = vertex
1326// .tesc = tessellation control
1327// .tese = tessellation evaluation
1328// .geom = geometry
1329// .frag = fragment
John Kessenich94a81fb2013-08-31 02:41:30 +00001330// .comp = compute
Chao Chenb50c02e2018-09-19 11:42:24 -07001331// .rgen = ray generation
1332// .rint = ray intersection
1333// .rahit = ray any hit
1334// .rchit = ray closest hit
1335// .rmiss = ray miss
1336// .rcall = ray callable
Sahil Parmar035cbbe2018-10-04 16:39:18 -07001337// .mesh = mesh
1338// .task = task
Grigory Dzhavadyan33507412018-04-12 14:35:24 -07001339// Additionally, the file names may end in .<stage>.glsl and .<stage>.hlsl
1340// where <stage> is one of the stages listed above.
1341//
1342EShLanguage FindLanguage(const std::string& name, bool parseStageName)
John Kessenicha0af4732012-12-12 21:15:54 +00001343{
John Kessenichfccbb8b2018-04-17 17:24:03 -06001344 std::string stageName;
Dan Bakerc6ede892016-08-11 14:06:06 -04001345 if (shaderStageName)
John Kessenichfccbb8b2018-04-17 17:24:03 -06001346 stageName = shaderStageName;
1347 else if (parseStageName) {
Grigory Dzhavadyan33507412018-04-12 14:35:24 -07001348 // Note: "first" extension means "first from the end", i.e.
1349 // if the file is named foo.vert.glsl, then "glsl" is first,
1350 // "vert" is second.
John Kessenichfccbb8b2018-04-17 17:24:03 -06001351 size_t firstExtStart = name.find_last_of(".");
1352 bool hasFirstExt = firstExtStart != std::string::npos;
1353 size_t secondExtStart = hasFirstExt ? name.find_last_of(".", firstExtStart - 1) : std::string::npos;
1354 bool hasSecondExt = secondExtStart != std::string::npos;
1355 std::string firstExt = name.substr(firstExtStart + 1, std::string::npos);
1356 bool usesUnifiedExt = hasFirstExt && (firstExt == "glsl" || firstExt == "hlsl");
John Kessenich3beac942018-04-17 21:02:19 -06001357 if (usesUnifiedExt && firstExt == "hlsl")
1358 Options |= EOptionReadHlsl;
1359 if (hasFirstExt && !usesUnifiedExt)
John Kessenichfccbb8b2018-04-17 17:24:03 -06001360 stageName = firstExt;
John Kessenich3beac942018-04-17 21:02:19 -06001361 else if (usesUnifiedExt && hasSecondExt)
John Kessenichfccbb8b2018-04-17 17:24:03 -06001362 stageName = name.substr(secondExtStart + 1, firstExtStart - secondExtStart - 1);
John Kessenich3beac942018-04-17 21:02:19 -06001363 else {
Grigory Dzhavadyan33507412018-04-12 14:35:24 -07001364 usage();
1365 return EShLangVertex;
John Kesseniche751bca2017-03-16 11:20:38 -06001366 }
John Kessenichfccbb8b2018-04-17 17:24:03 -06001367 } else
1368 stageName = name;
dankbaker45d49bc2016-08-08 21:43:07 -04001369
John Kessenichfccbb8b2018-04-17 17:24:03 -06001370 if (stageName == "vert")
John Kessenich2b07c7e2013-07-31 18:44:13 +00001371 return EShLangVertex;
John Kessenichfccbb8b2018-04-17 17:24:03 -06001372 else if (stageName == "tesc")
John Kessenich2b07c7e2013-07-31 18:44:13 +00001373 return EShLangTessControl;
John Kessenichfccbb8b2018-04-17 17:24:03 -06001374 else if (stageName == "tese")
John Kessenich2b07c7e2013-07-31 18:44:13 +00001375 return EShLangTessEvaluation;
John Kessenichfccbb8b2018-04-17 17:24:03 -06001376 else if (stageName == "geom")
John Kessenich2b07c7e2013-07-31 18:44:13 +00001377 return EShLangGeometry;
John Kessenichfccbb8b2018-04-17 17:24:03 -06001378 else if (stageName == "frag")
John Kessenich2b07c7e2013-07-31 18:44:13 +00001379 return EShLangFragment;
John Kessenichfccbb8b2018-04-17 17:24:03 -06001380 else if (stageName == "comp")
John Kessenichc0275792013-08-09 17:14:49 +00001381 return EShLangCompute;
Chao Chen3c366992018-09-19 11:41:59 -07001382#ifdef NV_EXTENSIONS
Chao Chenb50c02e2018-09-19 11:42:24 -07001383 else if (stageName == "rgen")
1384 return EShLangRayGenNV;
1385 else if (stageName == "rint")
1386 return EShLangIntersectNV;
1387 else if (stageName == "rahit")
1388 return EShLangAnyHitNV;
1389 else if (stageName == "rchit")
1390 return EShLangClosestHitNV;
1391 else if (stageName == "rmiss")
1392 return EShLangMissNV;
1393 else if (stageName == "rcall")
1394 return EShLangCallableNV;
Chao Chen3c366992018-09-19 11:41:59 -07001395 else if (stageName == "mesh")
1396 return EShLangMeshNV;
1397 else if (stageName == "task")
1398 return EShLangTaskNV;
1399#endif
John Kessenich2b07c7e2013-07-31 18:44:13 +00001400
1401 usage();
John Kesseniche95ecc52012-12-12 21:34:14 +00001402 return EShLangVertex;
John Kessenicha0af4732012-12-12 21:15:54 +00001403}
1404
John Kessenicha0af4732012-12-12 21:15:54 +00001405//
John Kessenichecba76f2017-01-06 00:34:48 -07001406// Read a file's data into a string, and compile it using the old interface ShCompile,
John Kessenich69f4b512013-09-04 21:19:27 +00001407// for non-linkable results.
John Kessenicha0af4732012-12-12 21:15:54 +00001408//
John Kessenich51cdd902014-02-18 23:37:57 +00001409void CompileFile(const char* fileName, ShHandle compiler)
John Kessenicha0af4732012-12-12 21:15:54 +00001410{
John Kessenichca3457f2015-05-18 01:59:45 +00001411 int ret = 0;
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001412 char* shaderString;
1413 if ((Options & EOptionStdin) != 0) {
1414 std::istreambuf_iterator<char> begin(std::cin), end;
1415 std::string tempString(begin, end);
1416 shaderString = strdup(tempString.c_str());
1417 } else {
1418 shaderString = ReadFileData(fileName);
1419 }
John Kessenich41cf6b52013-06-25 18:10:05 +00001420
1421 // move to length-based strings, rather than null-terminated strings
John Kessenich04acb1b2017-06-14 17:36:50 -06001422 int* lengths = new int[1];
1423 lengths[0] = (int)strlen(shaderString);
John Kessenicha0af4732012-12-12 21:15:54 +00001424
John Kessenich52ac67e2013-05-05 23:46:22 +00001425 EShMessages messages = EShMsgDefault;
John Kessenichb0a7eb52013-11-07 17:44:20 +00001426 SetMessageOptions(messages);
John Kessenichecba76f2017-01-06 00:34:48 -07001427
John Kessenicha9313662017-06-15 10:40:49 -06001428 if (UserPreamble.isSet())
1429 Error("-D and -U options require -l (linking)\n");
1430
John Kessenich94a81fb2013-08-31 02:41:30 +00001431 for (int i = 0; i < ((Options & EOptionMemoryLeakMode) ? 100 : 1); ++i) {
1432 for (int j = 0; j < ((Options & EOptionMemoryLeakMode) ? 100 : 1); ++j) {
John Kessenich927608b2017-01-06 12:34:14 -07001433 // ret = ShCompile(compiler, shaderStrings, NumShaderStrings, lengths, EShOptNone, &Resources, Options, (Options & EOptionDefaultDesktop) ? 110 : 100, false, messages);
John Kessenich04acb1b2017-06-14 17:36:50 -06001434 ret = ShCompile(compiler, &shaderString, 1, nullptr, EShOptNone, &Resources, Options, (Options & EOptionDefaultDesktop) ? 110 : 100, false, messages);
John Kessenich927608b2017-01-06 12:34:14 -07001435 // const char* multi[12] = { "# ve", "rsion", " 300 e", "s", "\n#err",
John Kessenichecba76f2017-01-06 00:34:48 -07001436 // "or should be l", "ine 1", "string 5\n", "float glo", "bal",
John Kessenichea869fb2013-10-28 18:12:06 +00001437 // ";\n#error should be line 2\n void main() {", "global = 2.3;}" };
John Kessenich927608b2017-01-06 12:34:14 -07001438 // const char* multi[7] = { "/", "/", "\\", "\n", "\n", "#", "version 300 es" };
1439 // ret = ShCompile(compiler, multi, 7, nullptr, EShOptNone, &Resources, Options, (Options & EOptionDefaultDesktop) ? 110 : 100, false, messages);
John Kessenich41cf6b52013-06-25 18:10:05 +00001440 }
John Kessenicha0af4732012-12-12 21:15:54 +00001441
John Kessenich94a81fb2013-08-31 02:41:30 +00001442 if (Options & EOptionMemoryLeakMode)
John Kessenich2b07c7e2013-07-31 18:44:13 +00001443 glslang::OS_DumpMemoryCounters();
John Kessenicha0af4732012-12-12 21:15:54 +00001444 }
John Kessenicha0af4732012-12-12 21:15:54 +00001445
John Kessenich41cf6b52013-06-25 18:10:05 +00001446 delete [] lengths;
John Kessenich04acb1b2017-06-14 17:36:50 -06001447 FreeFileData(shaderString);
John Kessenicha0af4732012-12-12 21:15:54 +00001448
John Kessenichc999ba22013-11-07 23:33:24 +00001449 if (ret == 0)
1450 CompileFailed = true;
John Kessenicha0af4732012-12-12 21:15:54 +00001451}
1452
John Kessenicha0af4732012-12-12 21:15:54 +00001453//
1454// print usage to stdout
1455//
1456void usage()
1457{
John Kessenich319de232013-12-04 04:43:40 +00001458 printf("Usage: glslangValidator [option]... [file]...\n"
1459 "\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001460 "'file' can end in .<stage> for auto-stage classification, where <stage> is:\n"
1461 " .conf to provide a config file that replaces the default configuration\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001462 " (see -c option below for generating a template)\n"
1463 " .vert for a vertex shader\n"
1464 " .tesc for a tessellation control shader\n"
1465 " .tese for a tessellation evaluation shader\n"
1466 " .geom for a geometry shader\n"
1467 " .frag for a fragment shader\n"
1468 " .comp for a compute shader\n"
Chao Chen3c366992018-09-19 11:41:59 -07001469#ifdef NV_EXTENSIONS
1470 " .mesh for a mesh shader\n"
1471 " .task for a task shader\n"
Chao Chenb50c02e2018-09-19 11:42:24 -07001472 " .rgen for a ray generation shader\n"
1473 " .rint for a ray intersection shader\n"
1474 " .rahit for a ray any hit shader\n"
1475 " .rchit for a ray closest hit shader\n"
1476 " .rmiss for a ray miss shader\n"
Sahil Parmar035cbbe2018-10-04 16:39:18 -07001477 " .rcall for a ray callable shader\n"
Chao Chen3c366992018-09-19 11:41:59 -07001478#endif
John Kessenich2ead40f2018-04-17 17:44:11 -06001479 " .glsl for .vert.glsl, .tesc.glsl, ..., .comp.glsl compound suffixes\n"
1480 " .hlsl for .vert.hlsl, .tesc.hlsl, ..., .comp.hlsl compound suffixes\n"
John Kessenich319de232013-12-04 04:43:40 +00001481 "\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001482 "Options:\n"
1483 " -C cascading errors; risk crash from accumulation of error recoveries\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001484 " -D input is HLSL (this is the default when any suffix is .hlsl)\n"
John Kessenicha9313662017-06-15 10:40:49 -06001485 " -D<macro=def>\n"
1486 " -D<macro> define a pre-processor macro\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001487 " -E print pre-processed GLSL; cannot be used with -l;\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001488 " errors will appear on stderr\n"
John Kessenich6353d552017-06-23 11:11:09 -06001489 " -G[ver] create SPIR-V binary, under OpenGL semantics; turns on -l;\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001490 " default file name is <stage>.spv (-o overrides this);\n"
John Kessenich6353d552017-06-23 11:11:09 -06001491 " 'ver', when present, is the version of the input semantics,\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001492 " which will appear in #define GL_SPIRV ver;\n"
1493 " '--client opengl100' is the same as -G100;\n"
John Kessenich6353d552017-06-23 11:11:09 -06001494 " a '--target-env' for OpenGL will also imply '-G'\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001495 " -H print human readable form of SPIR-V; turns on -V\n"
John Kessenich971a0a82017-06-07 15:06:58 -06001496 " -I<dir> add dir to the include search path; includer's directory\n"
1497 " is searched first, followed by left-to-right order of -I\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001498 " -Od disables optimization; may cause illegal SPIR-V for HLSL\n"
1499 " -Os optimizes SPIR-V to minimize size\n"
John Kesseniche751bca2017-03-16 11:20:38 -06001500 " -S <stage> uses specified stage rather than parsing the file extension\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001501 " choices for <stage> are vert, tesc, tese, geom, frag, or comp\n"
John Kessenich6353d552017-06-23 11:11:09 -06001502 " -U<macro> undefine a pre-processor macro\n"
1503 " -V[ver] create SPIR-V binary, under Vulkan semantics; turns on -l;\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001504 " default file name is <stage>.spv (-o overrides this)\n"
John Kessenich6353d552017-06-23 11:11:09 -06001505 " 'ver', when present, is the version of the input semantics,\n"
1506 " which will appear in #define VULKAN ver\n"
1507 " '--client vulkan100' is the same as -V100\n"
1508 " a '--target-env' for Vulkan will also imply '-V'\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001509 " -c configuration dump;\n"
1510 " creates the default configuration file (redirect to a .conf file)\n"
1511 " -d default to desktop (#version 110) when there is no shader #version\n"
1512 " (default is ES version 100)\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001513 " -e <name> | --entry-point <name>\n"
1514 " specify <name> as the entry-point function name\n"
John Kessenich5d610ee2018-03-07 18:05:55 -07001515 " -f{hlsl_functionality1}\n"
1516 " 'hlsl_functionality1' enables use of the\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001517 " SPV_GOOGLE_hlsl_functionality1 extension\n"
John Kessenich121853f2017-05-31 17:11:16 -06001518 " -g generate debug information\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001519 " -h print this usage message\n"
1520 " -i intermediate tree (glslang AST) is printed out\n"
1521 " -l link all input files together to form a single module\n"
1522 " -m memory leak mode\n"
John Kessenicha25530c2017-09-11 20:13:49 -06001523 " -o <file> save binary to <file>, requires a binary option (e.g., -V)\n"
John Kesseniche5c394b2019-07-02 09:32:48 -06001524 " -q dump reflection query database; requires -l for linking\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001525 " -r | --relaxed-errors"
1526 " relaxed GLSL semantic error-checking mode\n"
John Kessenichb63f4a32017-11-16 22:32:20 -07001527 " -s silence syntax and semantic error reporting\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001528 " -t multi-threaded mode\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001529 " -v | --version\n"
1530 " print version strings\n"
1531 " -w | --suppress-warnings\n"
1532 " suppress GLSL warnings, except as required by \"#extension : warn\"\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001533 " -x save binary output as text-based 32-bit hexadecimal numbers\n"
Neil Roberts16f53472018-03-20 17:30:53 +01001534 " -u<name>:<loc> specify a uniform location override for --aml\n"
Neil Robertsb0f3d792018-03-20 17:41:05 +01001535 " --uniform-base <base> set a base to use for generated uniform locations\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001536 " --auto-map-bindings | --amb automatically bind uniform variables\n"
1537 " without explicit bindings\n"
1538 " --auto-map-locations | --aml automatically locate input/output lacking\n"
1539 " 'location' (fragile, not cross stage)\n"
1540 " --client {vulkan<ver>|opengl<ver>} see -V and -G\n"
Christoph Kubisch412ff6e2019-04-13 22:57:33 +02001541 " --dump-builtin-symbols prints builtin symbol table prior each compile\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001542 " -dumpfullversion | -dumpversion print bare major.minor.patchlevel\n"
1543 " --flatten-uniform-arrays | --fua flatten uniform texture/sampler arrays to\n"
1544 " scalars\n"
1545 " --hlsl-offsets allow block offsets to follow HLSL rules\n"
1546 " works independently of source language\n"
1547 " --hlsl-iomap perform IO mapping in HLSL register space\n"
1548 " --hlsl-enable-16bit-types allow 16-bit types in SPIR-V for HLSL\n"
John Kessenich605afc72019-06-17 23:33:09 -06001549 " --hlsl-dx9-compatible interprets sampler declarations as a\n"
1550 " texture/sampler combo like DirectX9 would.\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001551 " --invert-y | --iy invert position.Y output in vertex shader\n"
1552 " --keep-uncalled | --ku don't eliminate uncalled functions\n"
John Kessenich605afc72019-06-17 23:33:09 -06001553 " --nan-clamp favor non-NaN operand in min, max, and clamp\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001554 " --no-storage-format | --nsf use Unknown image format\n"
baldurk4513df92019-02-08 10:48:48 +00001555 " --reflect-strict-array-suffix use strict array suffix rules when\n"
1556 " reflecting\n"
baldurkedf82122019-01-29 15:49:00 +00001557 " --reflect-basic-array-suffix arrays of basic types will have trailing [0]\n"
baldurk4513df92019-02-08 10:48:48 +00001558 " --reflect-intermediate-io reflection includes inputs/outputs of linked\n"
1559 " shaders rather than just vertex/fragment\n"
1560 " --reflect-separate-buffers reflect buffer variables and blocks\n"
1561 " separately to uniforms\n"
1562 " --reflect-all-block-variables reflect all variables in blocks, whether\n"
1563 " inactive or active\n"
baldurk19050692019-02-11 11:50:24 +00001564 " --reflect-unwrap-io-blocks unwrap input/output blocks the same as\n"
1565 " uniform blocks\n"
LoopDawg52017192017-07-14 15:15:47 -06001566 " --resource-set-binding [stage] name set binding\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001567 " set descriptor set and binding for\n"
1568 " individual resources\n"
LoopDawg52017192017-07-14 15:15:47 -06001569 " --resource-set-binding [stage] set\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001570 " set descriptor set for all resources\n"
1571 " --rsb synonym for --resource-set-binding\n"
1572 " --shift-image-binding [stage] num\n"
1573 " base binding number for images (uav)\n"
1574 " --shift-image-binding [stage] [num set]...\n"
1575 " per-descriptor-set shift values\n"
1576 " --sib synonym for --shift-image-binding\n"
1577 " --shift-sampler-binding [stage] num\n"
1578 " base binding number for samplers\n"
1579 " --shift-sampler-binding [stage] [num set]...\n"
1580 " per-descriptor-set shift values\n"
1581 " --ssb synonym for --shift-sampler-binding\n"
1582 " --shift-ssbo-binding [stage] num base binding number for SSBOs\n"
1583 " --shift-ssbo-binding [stage] [num set]...\n"
1584 " per-descriptor-set shift values\n"
1585 " --sbb synonym for --shift-ssbo-binding\n"
1586 " --shift-texture-binding [stage] num\n"
1587 " base binding number for textures\n"
1588 " --shift-texture-binding [stage] [num set]...\n"
1589 " per-descriptor-set shift values\n"
1590 " --stb synonym for --shift-texture-binding\n"
1591 " --shift-uav-binding [stage] num base binding number for UAVs\n"
1592 " --shift-uav-binding [stage] [num set]...\n"
1593 " per-descriptor-set shift values\n"
1594 " --suavb synonym for --shift-uav-binding\n"
1595 " --shift-UBO-binding [stage] num base binding number for UBOs\n"
1596 " --shift-UBO-binding [stage] [num set]...\n"
1597 " per-descriptor-set shift values\n"
1598 " --sub synonym for --shift-UBO-binding\n"
1599 " --shift-cbuffer-binding | --scb synonyms for --shift-UBO-binding\n"
1600 " --spirv-dis output standard-form disassembly; works only\n"
1601 " when a SPIR-V generation option is also used\n"
John Kessenichc3404252018-08-23 15:29:08 -06001602 " --spirv-val execute the SPIRV-Tools validator\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001603 " --source-entrypoint <name> the given shader source function is\n"
1604 " renamed to be the <name> given in -e\n"
1605 " --sep synonym for --source-entrypoint\n"
1606 " --stdin read from stdin instead of from a file;\n"
1607 " requires providing the shader stage using -S\n"
John Kessenich8717a5d2018-10-26 10:12:32 -06001608 " --target-env {vulkan1.0 | vulkan1.1 | opengl | \n"
1609 " spirv1.0 | spirv1.1 | spirv1.2 | spirv1.3}\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001610 " set execution environment that emitted code\n"
John Kessenich8717a5d2018-10-26 10:12:32 -06001611 " will execute in (versus source language\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001612 " semantics selected by --client) defaults:\n"
1613 " * 'vulkan1.0' under '--client vulkan<ver>'\n"
1614 " * 'opengl' under '--client opengl<ver>'\n"
John Kessenich8717a5d2018-10-26 10:12:32 -06001615 " * 'spirv1.0' under --target-env vulkan1.0\n"
1616 " * 'spirv1.3' under --target-env vulkan1.1\n"
1617 " multiple --targen-env can be specified.\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001618 " --variable-name <name>\n"
1619 " --vn <name> creates a C header file that contains a\n"
1620 " uint32_t array named <name>\n"
1621 " initialized with the shader binary code\n"
John Kessenichb0a7eb52013-11-07 17:44:20 +00001622 );
John Kessenich68d78fd2015-07-12 19:28:10 -06001623
1624 exit(EFailUsage);
John Kessenicha0af4732012-12-12 21:15:54 +00001625}
1626
John Kessenich3ce4e592014-10-06 19:57:34 +00001627#if !defined _MSC_VER && !defined MINGW_HAS_SECURE_API
John Kessenichcfd643e2013-03-08 23:14:42 +00001628
1629#include <errno.h>
1630
1631int fopen_s(
1632 FILE** pFile,
John Kessenich51cdd902014-02-18 23:37:57 +00001633 const char* filename,
1634 const char* mode
John Kessenichcfd643e2013-03-08 23:14:42 +00001635)
1636{
1637 if (!pFile || !filename || !mode) {
1638 return EINVAL;
1639 }
1640
1641 FILE* f = fopen(filename, mode);
1642 if (! f) {
1643 if (errno != 0) {
1644 return errno;
1645 } else {
1646 return ENOENT;
1647 }
1648 }
1649 *pFile = f;
1650
1651 return 0;
1652}
1653
1654#endif
1655
John Kessenicha0af4732012-12-12 21:15:54 +00001656//
1657// Malloc a string of sufficient size and read a string into it.
1658//
John Kessenich04acb1b2017-06-14 17:36:50 -06001659char* ReadFileData(const char* fileName)
John Kessenicha0af4732012-12-12 21:15:54 +00001660{
John Kessenichb3297152015-07-11 18:01:03 -06001661 FILE *in = nullptr;
John Kessenich3ce4e592014-10-06 19:57:34 +00001662 int errorCode = fopen_s(&in, fileName, "r");
John Kessenich68d78fd2015-07-12 19:28:10 -06001663 if (errorCode || in == nullptr)
1664 Error("unable to open input file");
John Kessenichecba76f2017-01-06 00:34:48 -07001665
John Kessenich04acb1b2017-06-14 17:36:50 -06001666 int count = 0;
John Kessenicha0af4732012-12-12 21:15:54 +00001667 while (fgetc(in) != EOF)
1668 count++;
1669
John Kessenichd6c72a42014-08-18 19:42:35 +00001670 fseek(in, 0, SEEK_SET);
John Kessenichca3457f2015-05-18 01:59:45 +00001671
John Kessenich04acb1b2017-06-14 17:36:50 -06001672 char* return_data = (char*)malloc(count + 1); // freed in FreeFileData()
1673 if ((int)fread(return_data, 1, count, in) != count) {
1674 free(return_data);
John Kessenich68d78fd2015-07-12 19:28:10 -06001675 Error("can't read input file");
John Kessenicha0af4732012-12-12 21:15:54 +00001676 }
John Kessenich68d78fd2015-07-12 19:28:10 -06001677
John Kessenich04acb1b2017-06-14 17:36:50 -06001678 return_data[count] = '\0';
John Kessenicha0af4732012-12-12 21:15:54 +00001679 fclose(in);
John Kessenichb3297152015-07-11 18:01:03 -06001680
John Kessenicha0af4732012-12-12 21:15:54 +00001681 return return_data;
1682}
1683
John Kessenich04acb1b2017-06-14 17:36:50 -06001684void FreeFileData(char* data)
John Kessenicha0af4732012-12-12 21:15:54 +00001685{
John Kessenichb3297152015-07-11 18:01:03 -06001686 free(data);
John Kessenicha0af4732012-12-12 21:15:54 +00001687}
1688
John Kessenich54d8cda2013-02-11 22:36:01 +00001689void InfoLogMsg(const char* msg, const char* name, const int num)
John Kessenicha0af4732012-12-12 21:15:54 +00001690{
John Kessenichfae38ee2015-06-10 23:23:12 +00001691 if (num >= 0 )
1692 printf("#### %s %s %d INFO LOG ####\n", msg, name, num);
1693 else
1694 printf("#### %s %s INFO LOG ####\n", msg, name);
John Kessenicha0af4732012-12-12 21:15:54 +00001695}