blob: 9af2596c5961050513338a7f4157b105be3d89db [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)
775 if ((Options & EOptionOutputPreprocessed) && (Options & EOptionLinkProgram))
776 Error("can't use -E when linking is selected");
John Kessenichc555ddd2015-06-17 02:38:44 +0000777
Johannes van Waverenecb0f3b2016-05-27 12:55:53 -0500778 // -o or -x makes no sense if there is no target binary
John Kessenich68d78fd2015-07-12 19:28:10 -0600779 if (binaryFileName && (Options & EOptionSpv) == 0)
780 Error("no binary generation requested (e.g., -V)");
steve-lunarge0b9deb2016-09-16 13:26:37 -0600781
782 if ((Options & EOptionFlattenUniformArrays) != 0 &&
783 (Options & EOptionReadHlsl) == 0)
784 Error("uniform array flattening only valid when compiling HLSL source.");
John Kessenich8717a5d2018-10-26 10:12:32 -0600785
786 // rationalize client and target language
787 if (TargetLanguage == glslang::EShTargetNone) {
788 switch (ClientVersion) {
789 case glslang::EShTargetVulkan_1_0:
790 TargetLanguage = glslang::EShTargetSpv;
791 TargetVersion = glslang::EShTargetSpv_1_0;
792 break;
793 case glslang::EShTargetVulkan_1_1:
794 TargetLanguage = glslang::EShTargetSpv;
795 TargetVersion = glslang::EShTargetSpv_1_3;
796 break;
797 case glslang::EShTargetOpenGL_450:
798 TargetLanguage = glslang::EShTargetSpv;
799 TargetVersion = glslang::EShTargetSpv_1_0;
800 break;
801 default:
802 break;
803 }
804 }
805 if (TargetLanguage != glslang::EShTargetNone && Client == glslang::EShClientNone)
806 Error("To generate SPIR-V, also specify client semantics. See -G and -V.");
John Kessenich2b07c7e2013-07-31 18:44:13 +0000807}
808
John Kessenich68d78fd2015-07-12 19:28:10 -0600809//
810// Translate the meaningful subset of command-line options to parser-behavior options.
811//
John Kessenichb0a7eb52013-11-07 17:44:20 +0000812void SetMessageOptions(EShMessages& messages)
813{
814 if (Options & EOptionRelaxedErrors)
815 messages = (EShMessages)(messages | EShMsgRelaxedErrors);
816 if (Options & EOptionIntermediate)
817 messages = (EShMessages)(messages | EShMsgAST);
818 if (Options & EOptionSuppressWarnings)
819 messages = (EShMessages)(messages | EShMsgSuppressWarnings);
John Kessenich68d78fd2015-07-12 19:28:10 -0600820 if (Options & EOptionSpv)
821 messages = (EShMessages)(messages | EShMsgSpvRules);
822 if (Options & EOptionVulkanRules)
823 messages = (EShMessages)(messages | EShMsgVulkanRules);
Andrew Woloszynaae1ad82015-06-24 17:00:46 -0400824 if (Options & EOptionOutputPreprocessed)
825 messages = (EShMessages)(messages | EShMsgOnlyPreprocessor);
John Kessenich66e2faf2016-03-12 18:34:36 -0700826 if (Options & EOptionReadHlsl)
827 messages = (EShMessages)(messages | EShMsgReadHlsl);
John Kessenicha86836e2016-07-09 14:50:57 -0600828 if (Options & EOptionCascadingErrors)
829 messages = (EShMessages)(messages | EShMsgCascadingErrors);
John Kessenich906cc212016-12-09 19:22:20 -0700830 if (Options & EOptionKeepUncalled)
831 messages = (EShMessages)(messages | EShMsgKeepUncalled);
John Kessenich4f1403e2017-04-05 17:38:20 -0600832 if (Options & EOptionHlslOffsets)
833 messages = (EShMessages)(messages | EShMsgHlslOffsets);
John Kessenich121853f2017-05-31 17:11:16 -0600834 if (Options & EOptionDebug)
835 messages = (EShMessages)(messages | EShMsgDebugInfo);
Rex Xucb61eec2018-03-07 13:10:01 +0800836 if (HlslEnable16BitTypes)
837 messages = (EShMessages)(messages | EShMsgHlslEnable16BitTypes);
GregFfb03a552018-03-29 11:49:14 -0600838 if ((Options & EOptionOptimizeDisable) || !ENABLE_OPT)
839 messages = (EShMessages)(messages | EShMsgHlslLegalization);
John Kessenichbd1c1832018-12-07 18:38:26 -0700840 if (HlslDX9compatible)
841 messages = (EShMessages)(messages | EShMsgHlslDX9Compatible);
Christoph Kubisch55ba3ea2019-04-13 22:18:16 +0200842 if (DumpBuiltinSymbols)
843 messages = (EShMessages)(messages | EShMsgBuiltinSymbolTable);
John Kessenichb0a7eb52013-11-07 17:44:20 +0000844}
845
John Kessenich68d78fd2015-07-12 19:28:10 -0600846//
John Kessenich69f4b512013-09-04 21:19:27 +0000847// Thread entry point, for non-linking asynchronous mode.
John Kessenichc999ba22013-11-07 23:33:24 +0000848//
Juan Lopeza558b262017-04-02 23:04:00 +0200849void CompileShaders(glslang::TWorklist& worklist)
John Kessenich2b07c7e2013-07-31 18:44:13 +0000850{
John Kessenich7f0bcfd2018-04-05 19:00:01 -0600851 if (Options & EOptionDebug)
852 Error("cannot generate debug information unless linking to generate code");
853
John Kessenich38f3b892013-09-06 19:52:57 +0000854 glslang::TWorkItem* workItem;
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +0200855 if (Options & EOptionStdin) {
John Kesseniche7f9cae2018-07-12 15:11:07 -0600856 if (worklist.remove(workItem)) {
857 ShHandle compiler = ShConstructCompiler(FindLanguage("stdin"), Options);
858 if (compiler == nullptr)
859 return;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000860
John Kesseniche7f9cae2018-07-12 15:11:07 -0600861 CompileFile("stdin", compiler);
John Kessenich2b07c7e2013-07-31 18:44:13 +0000862
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +0200863 if (! (Options & EOptionSuppressInfolog))
864 workItem->results = ShGetInfoLog(compiler);
John Kessenich2b07c7e2013-07-31 18:44:13 +0000865
John Kesseniche7f9cae2018-07-12 15:11:07 -0600866 ShDestruct(compiler);
867 }
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +0200868 } else {
869 while (worklist.remove(workItem)) {
870 ShHandle compiler = ShConstructCompiler(FindLanguage(workItem->name), Options);
871 if (compiler == 0)
872 return;
873
874 CompileFile(workItem->name.c_str(), compiler);
875
876 if (! (Options & EOptionSuppressInfolog))
877 workItem->results = ShGetInfoLog(compiler);
878
879 ShDestruct(compiler);
880 }
John Kessenich2b07c7e2013-07-31 18:44:13 +0000881 }
John Kessenich2b07c7e2013-07-31 18:44:13 +0000882}
883
John Kessenich6626cad2015-06-19 05:14:19 +0000884// Outputs the given string, but only if it is non-null and non-empty.
885// This prevents erroneous newlines from appearing.
Andrew Woloszynaae1ad82015-06-24 17:00:46 -0400886void PutsIfNonEmpty(const char* str)
John Kessenich6626cad2015-06-19 05:14:19 +0000887{
888 if (str && str[0]) {
889 puts(str);
890 }
891}
892
Andrew Woloszynaae1ad82015-06-24 17:00:46 -0400893// Outputs the given string to stderr, but only if it is non-null and non-empty.
894// This prevents erroneous newlines from appearing.
895void StderrIfNonEmpty(const char* str)
896{
John Kessenich04acb1b2017-06-14 17:36:50 -0600897 if (str && str[0])
898 fprintf(stderr, "%s\n", str);
Andrew Woloszynaae1ad82015-06-24 17:00:46 -0400899}
900
John Kessenichc57b2a92016-01-16 15:30:03 -0700901// Simple bundling of what makes a compilation unit for ease in passing around,
902// and separation of handling file IO versus API (programmatic) compilation.
903struct ShaderCompUnit {
904 EShLanguage stage;
John Kessenich04acb1b2017-06-14 17:36:50 -0600905 static const int maxCount = 1;
906 int count; // live number of strings/names
John Kessenicha9313662017-06-15 10:40:49 -0600907 const char* text[maxCount]; // memory owned/managed externally
John Kessenich04acb1b2017-06-14 17:36:50 -0600908 std::string fileName[maxCount]; // hold's the memory, but...
909 const char* fileNameList[maxCount]; // downstream interface wants pointers
dankbakerafe6e9c2016-08-21 12:29:08 -0400910
John Kessenich04acb1b2017-06-14 17:36:50 -0600911 ShaderCompUnit(EShLanguage stage) : stage(stage), count(0) { }
dankbakerafe6e9c2016-08-21 12:29:08 -0400912
John Kessenich04acb1b2017-06-14 17:36:50 -0600913 ShaderCompUnit(const ShaderCompUnit& rhs)
dankbakerafe6e9c2016-08-21 12:29:08 -0400914 {
915 stage = rhs.stage;
John Kessenich04acb1b2017-06-14 17:36:50 -0600916 count = rhs.count;
917 for (int i = 0; i < count; ++i) {
918 fileName[i] = rhs.fileName[i];
919 text[i] = rhs.text[i];
920 fileNameList[i] = rhs.fileName[i].c_str();
921 }
dankbakerafe6e9c2016-08-21 12:29:08 -0400922 }
923
John Kessenicha9313662017-06-15 10:40:49 -0600924 void addString(std::string& ifileName, const char* itext)
John Kessenich04acb1b2017-06-14 17:36:50 -0600925 {
926 assert(count < maxCount);
927 fileName[count] = ifileName;
928 text[count] = itext;
929 fileNameList[count] = fileName[count].c_str();
930 ++count;
931 }
John Kessenichc57b2a92016-01-16 15:30:03 -0700932};
933
John Kessenich69f4b512013-09-04 21:19:27 +0000934//
John Kessenichc57b2a92016-01-16 15:30:03 -0700935// For linking mode: Will independently parse each compilation unit, but then put them
936// in the same program and link them together, making at most one linked module per
937// pipeline stage.
John Kessenich69f4b512013-09-04 21:19:27 +0000938//
939// Uses the new C++ interface instead of the old handle-based interface.
940//
John Kessenichc57b2a92016-01-16 15:30:03 -0700941
942void CompileAndLinkShaderUnits(std::vector<ShaderCompUnit> compUnits)
John Kessenich69f4b512013-09-04 21:19:27 +0000943{
944 // keep track of what to free
945 std::list<glslang::TShader*> shaders;
John Kessenichc57b2a92016-01-16 15:30:03 -0700946
John Kessenich69f4b512013-09-04 21:19:27 +0000947 EShMessages messages = EShMsgDefault;
John Kessenichb0a7eb52013-11-07 17:44:20 +0000948 SetMessageOptions(messages);
John Kessenich69f4b512013-09-04 21:19:27 +0000949
John Kessenich69f4b512013-09-04 21:19:27 +0000950 //
951 // Per-shader processing...
952 //
953
John Kessenich5b0f13a2013-11-01 03:08:40 +0000954 glslang::TProgram& program = *new glslang::TProgram;
rdb32084e82016-02-23 22:17:38 +0100955 for (auto it = compUnits.cbegin(); it != compUnits.cend(); ++it) {
956 const auto &compUnit = *it;
John Kessenichc57b2a92016-01-16 15:30:03 -0700957 glslang::TShader* shader = new glslang::TShader(compUnit.stage);
John Kessenich04acb1b2017-06-14 17:36:50 -0600958 shader->setStringsWithLengthsAndNames(compUnit.text, NULL, compUnit.fileNameList, compUnit.count);
John Kessenich640bd092018-08-09 14:15:00 -0600959 if (entryPointName)
John Kessenich4d65ee32016-03-12 18:17:47 -0700960 shader->setEntryPoint(entryPointName);
John Kessenich3693e632017-09-29 17:51:52 -0600961 if (sourceEntryPointName) {
962 if (entryPointName == nullptr)
963 printf("Warning: Changing source entry point name without setting an entry-point name.\n"
964 "Use '-e <name>'.\n");
steve-lunargf1e0c872016-10-31 15:13:43 -0600965 shader->setSourceEntryPoint(sourceEntryPointName);
John Kessenich3693e632017-09-29 17:51:52 -0600966 }
John Kessenicha9313662017-06-15 10:40:49 -0600967 if (UserPreamble.isSet())
968 shader->setPreamble(UserPreamble.get());
John Kessenich2a271162017-07-20 20:00:36 -0600969 shader->addProcesses(Processes);
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600970
LoopDawg08a14422017-10-17 19:27:14 -0600971 // Set IO mapper binding shift values
972 for (int r = 0; r < glslang::EResCount; ++r) {
973 const glslang::TResourceType res = glslang::TResourceType(r);
974
975 // Set base bindings
976 shader->setShiftBinding(res, baseBinding[res][compUnit.stage]);
977
978 // Set bindings for particular resource sets
979 // TODO: use a range based for loop here, when available in all environments.
980 for (auto i = baseBindingForSet[res][compUnit.stage].begin();
981 i != baseBindingForSet[res][compUnit.stage].end(); ++i)
LoopDawge5709552017-10-21 10:46:39 -0600982 shader->setShiftBindingForSet(res, i->second, i->first);
LoopDawg08a14422017-10-17 19:27:14 -0600983 }
984
steve-lunarge0b9deb2016-09-16 13:26:37 -0600985 shader->setFlattenUniformArrays((Options & EOptionFlattenUniformArrays) != 0);
steve-lunargcce8d482016-10-14 18:36:42 -0600986 shader->setNoStorageFormat((Options & EOptionNoStorageFormat) != 0);
John Kessenich605afc72019-06-17 23:33:09 -0600987 shader->setNanMinMaxClamp(NaNClamp);
Hyangran Park36dc8292017-05-02 16:27:29 +0900988 shader->setResourceSetBinding(baseResourceSetBinding[compUnit.stage]);
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600989
steve-lunargbe283552017-04-18 12:18:01 -0600990 if (Options & EOptionHlslIoMapping)
991 shader->setHlslIoMapping(true);
992
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600993 if (Options & EOptionAutoMapBindings)
994 shader->setAutoMapBindings(true);
John Kessenichecba76f2017-01-06 00:34:48 -0700995
John Kessenich71facdf2017-05-17 18:28:19 -0600996 if (Options & EOptionAutoMapLocations)
997 shader->setAutoMapLocations(true);
998
LoopDawgb22c0692017-12-06 16:52:03 -0700999 if (Options & EOptionInvertY)
1000 shader->setInvertY(true);
1001
Neil Roberts16f53472018-03-20 17:30:53 +01001002 for (auto& uniOverride : uniformLocationOverrides) {
1003 shader->addUniformLocationOverride(uniOverride.first.c_str(),
1004 uniOverride.second);
1005 }
1006
Neil Robertsb0f3d792018-03-20 17:41:05 +01001007 shader->setUniformLocationBase(uniformBase);
1008
John Kessenich4be4aeb2017-06-23 10:50:22 -06001009 // Set up the environment, some subsettings take precedence over earlier
1010 // ways of setting things.
1011 if (Options & EOptionSpv) {
John Kessenich8717a5d2018-10-26 10:12:32 -06001012 shader->setEnvInput((Options & EOptionReadHlsl) ? glslang::EShSourceHlsl
1013 : glslang::EShSourceGlsl,
1014 compUnit.stage, Client, ClientInputSemanticsVersion);
1015 shader->setEnvClient(Client, ClientVersion);
1016 shader->setEnvTarget(TargetLanguage, TargetVersion);
John Kessenich5d610ee2018-03-07 18:05:55 -07001017 if (targetHlslFunctionality1)
1018 shader->setEnvTargetHlslFunctionality1();
John Kessenich4be4aeb2017-06-23 10:50:22 -06001019 }
1020
John Kessenich69f4b512013-09-04 21:19:27 +00001021 shaders.push_back(shader);
John Kessenichb3297152015-07-11 18:01:03 -06001022
John Kessenich4be4aeb2017-06-23 10:50:22 -06001023 const int defaultVersion = Options & EOptionDefaultDesktop ? 110 : 100;
John Kessenich69f4b512013-09-04 21:19:27 +00001024
John Kessenich3494b4d2017-05-22 15:00:42 -06001025 DirStackFileIncluder includer;
John Kessenich971a0a82017-06-07 15:06:58 -06001026 std::for_each(IncludeDirectoryList.rbegin(), IncludeDirectoryList.rend(), [&includer](const std::string& dir) {
1027 includer.pushExternalLocalDirectory(dir); });
John Kessenichc555ddd2015-06-17 02:38:44 +00001028 if (Options & EOptionOutputPreprocessed) {
1029 std::string str;
John Kessenich086febc2018-10-25 12:43:02 -06001030 if (shader->preprocess(&Resources, defaultVersion, ENoProfile, false, false, messages, &str, includer)) {
Andrew Woloszynaae1ad82015-06-24 17:00:46 -04001031 PutsIfNonEmpty(str.c_str());
1032 } else {
1033 CompileFailed = true;
1034 }
1035 StderrIfNonEmpty(shader->getInfoLog());
1036 StderrIfNonEmpty(shader->getInfoDebugLog());
John Kessenichc555ddd2015-06-17 02:38:44 +00001037 continue;
1038 }
John Kessenich086febc2018-10-25 12:43:02 -06001039
John Kessenich3494b4d2017-05-22 15:00:42 -06001040 if (! shader->parse(&Resources, defaultVersion, false, messages, includer))
John Kessenichc999ba22013-11-07 23:33:24 +00001041 CompileFailed = true;
John Kessenichc555ddd2015-06-17 02:38:44 +00001042
John Kessenich69f4b512013-09-04 21:19:27 +00001043 program.addShader(shader);
1044
John Kessenichc57b2a92016-01-16 15:30:03 -07001045 if (! (Options & EOptionSuppressInfolog) &&
1046 ! (Options & EOptionMemoryLeakMode)) {
John Kessenich04acb1b2017-06-14 17:36:50 -06001047 PutsIfNonEmpty(compUnit.fileName[0].c_str());
Andrew Woloszynaae1ad82015-06-24 17:00:46 -04001048 PutsIfNonEmpty(shader->getInfoLog());
1049 PutsIfNonEmpty(shader->getInfoDebugLog());
John Kessenich69f4b512013-09-04 21:19:27 +00001050 }
John Kessenich69f4b512013-09-04 21:19:27 +00001051 }
1052
1053 //
1054 // Program-level processing...
1055 //
1056
John Kessenich4d65ee32016-03-12 18:17:47 -07001057 // Link
John Kessenich68d78fd2015-07-12 19:28:10 -06001058 if (! (Options & EOptionOutputPreprocessed) && ! program.link(messages))
John Kessenichc999ba22013-11-07 23:33:24 +00001059 LinkFailed = true;
1060
steve-lunarg9ae34742016-10-05 13:40:13 -06001061 // Map IO
1062 if (Options & EOptionSpv) {
1063 if (!program.mapIO())
1064 LinkFailed = true;
1065 }
John Kessenichecba76f2017-01-06 00:34:48 -07001066
John Kessenich4d65ee32016-03-12 18:17:47 -07001067 // Report
John Kessenichc57b2a92016-01-16 15:30:03 -07001068 if (! (Options & EOptionSuppressInfolog) &&
1069 ! (Options & EOptionMemoryLeakMode)) {
Andrew Woloszynaae1ad82015-06-24 17:00:46 -04001070 PutsIfNonEmpty(program.getInfoLog());
1071 PutsIfNonEmpty(program.getInfoDebugLog());
John Kessenich69f4b512013-09-04 21:19:27 +00001072 }
1073
John Kessenich4d65ee32016-03-12 18:17:47 -07001074 // Reflect
John Kessenich11f9fc72013-11-07 01:06:34 +00001075 if (Options & EOptionDumpReflection) {
baldurk6d477852019-01-29 15:45:56 +00001076 program.buildReflection(ReflectOptions);
John Kessenich11f9fc72013-11-07 01:06:34 +00001077 program.dumpReflection();
1078 }
1079
John Kessenich4d65ee32016-03-12 18:17:47 -07001080 // Dump SPIR-V
John Kessenich0df0cde2015-03-03 17:09:43 +00001081 if (Options & EOptionSpv) {
John Kessenich92f90382014-07-28 04:21:04 +00001082 if (CompileFailed || LinkFailed)
John Kessenich68d78fd2015-07-12 19:28:10 -06001083 printf("SPIR-V is not generated for failed compile or link\n");
John Kessenich92f90382014-07-28 04:21:04 +00001084 else {
1085 for (int stage = 0; stage < EShLangCount; ++stage) {
John Kessenicha7a68a92014-08-24 18:21:00 +00001086 if (program.getIntermediate((EShLanguage)stage)) {
John Kessenich0df0cde2015-03-03 17:09:43 +00001087 std::vector<unsigned int> spirv;
Lei Zhang09caf122016-05-02 18:11:54 -04001088 std::string warningsErrors;
Lei Zhang17535f72016-05-04 15:55:59 -04001089 spv::SpvBuildLogger logger;
John Kessenich121853f2017-05-31 17:11:16 -06001090 glslang::SpvOptions spvOptions;
1091 if (Options & EOptionDebug)
1092 spvOptions.generateDebugInfo = true;
GregF52fe3d52017-09-28 10:08:32 -06001093 spvOptions.disableOptimizer = (Options & EOptionOptimizeDisable) != 0;
1094 spvOptions.optimizeSize = (Options & EOptionOptimizeSize) != 0;
John Kessenich717c80a2018-08-23 15:17:10 -06001095 spvOptions.disassemble = SpvToolsDisassembler;
John Kessenichc3404252018-08-23 15:29:08 -06001096 spvOptions.validate = SpvToolsValidate;
John Kessenich121853f2017-05-31 17:11:16 -06001097 glslang::GlslangToSpv(*program.getIntermediate((EShLanguage)stage), spirv, &logger, &spvOptions);
John Kessenichc57b2a92016-01-16 15:30:03 -07001098
1099 // Dump the spv to a file or stdout, etc., but only if not doing
1100 // memory/perf testing, as it's not internal to programmatic use.
1101 if (! (Options & EOptionMemoryLeakMode)) {
Johannes van Waverenecb0f3b2016-05-27 12:55:53 -05001102 printf("%s", logger.getAllMessages().c_str());
1103 if (Options & EOptionOutputHexadecimal) {
John Kessenich8f674e82017-02-18 09:45:40 -07001104 glslang::OutputSpvHex(spirv, GetBinaryName((EShLanguage)stage), variableName);
Johannes van Waverenecb0f3b2016-05-27 12:55:53 -05001105 } else {
1106 glslang::OutputSpvBin(spirv, GetBinaryName((EShLanguage)stage));
1107 }
John Kesseniche2156222018-06-11 18:12:15 -06001108 if (!SpvToolsDisassembler && (Options & EOptionHumanReadableSpv))
John Kessenichc57b2a92016-01-16 15:30:03 -07001109 spv::Disassemble(std::cout, spirv);
John Kessenichacba7722015-03-04 03:48:38 +00001110 }
John Kessenicha7a68a92014-08-24 18:21:00 +00001111 }
John Kessenich92f90382014-07-28 04:21:04 +00001112 }
1113 }
1114 }
1115
John Kessenich5b0f13a2013-11-01 03:08:40 +00001116 // Free everything up, program has to go before the shaders
1117 // because it might have merged stuff from the shaders, and
1118 // the stuff from the shaders has to have its destructors called
1119 // before the pools holding the memory in the shaders is freed.
1120 delete &program;
John Kessenich69f4b512013-09-04 21:19:27 +00001121 while (shaders.size() > 0) {
1122 delete shaders.back();
1123 shaders.pop_back();
1124 }
John Kessenich69f4b512013-09-04 21:19:27 +00001125}
1126
John Kessenichc57b2a92016-01-16 15:30:03 -07001127//
1128// Do file IO part of compile and link, handing off the pure
1129// API/programmatic mode to CompileAndLinkShaderUnits(), which can
1130// be put in a loop for testing memory footprint and performance.
1131//
1132// This is just for linking mode: meaning all the shaders will be put into the
1133// the same program linked together.
1134//
1135// This means there are a limited number of work items (not multi-threading mode)
1136// and that the point is testing at the linking level. Hence, to enable
1137// performance and memory testing, the actual compile/link can be put in
1138// a loop, independent of processing the work items and file IO.
1139//
Juan Lopeza558b262017-04-02 23:04:00 +02001140void CompileAndLinkShaderFiles(glslang::TWorklist& Worklist)
John Kessenichc57b2a92016-01-16 15:30:03 -07001141{
1142 std::vector<ShaderCompUnit> compUnits;
1143
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001144 // If this is using stdin, we can't really detect multiple different file
1145 // units by input type. We need to assume that we're just being given one
1146 // file of a certain type.
1147 if ((Options & EOptionStdin) != 0) {
1148 ShaderCompUnit compUnit(FindLanguage("stdin"));
1149 std::istreambuf_iterator<char> begin(std::cin), end;
1150 std::string tempString(begin, end);
1151 char* fileText = strdup(tempString.c_str());
1152 std::string fileName = "stdin";
1153 compUnit.addString(fileName, fileText);
John Kessenichc57b2a92016-01-16 15:30:03 -07001154 compUnits.push_back(compUnit);
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001155 } else {
1156 // Transfer all the work items from to a simple list of
1157 // of compilation units. (We don't care about the thread
1158 // work-item distribution properties in this path, which
1159 // is okay due to the limited number of shaders, know since
1160 // they are all getting linked together.)
1161 glslang::TWorkItem* workItem;
1162 while (Worklist.remove(workItem)) {
1163 ShaderCompUnit compUnit(FindLanguage(workItem->name));
1164 char* fileText = ReadFileData(workItem->name.c_str());
1165 if (fileText == nullptr)
1166 usage();
1167 compUnit.addString(workItem->name, fileText);
1168 compUnits.push_back(compUnit);
1169 }
John Kessenichc57b2a92016-01-16 15:30:03 -07001170 }
1171
1172 // Actual call to programmatic processing of compile and link,
1173 // in a loop for testing memory and performance. This part contains
1174 // all the perf/memory that a programmatic consumer will care about.
1175 for (int i = 0; i < ((Options & EOptionMemoryLeakMode) ? 100 : 1); ++i) {
1176 for (int j = 0; j < ((Options & EOptionMemoryLeakMode) ? 100 : 1); ++j)
1177 CompileAndLinkShaderUnits(compUnits);
1178
1179 if (Options & EOptionMemoryLeakMode)
1180 glslang::OS_DumpMemoryCounters();
1181 }
1182
John Kessenicha9313662017-06-15 10:40:49 -06001183 // free memory from ReadFileData, which got stored in a const char*
1184 // as the first string above
rdb32084e82016-02-23 22:17:38 +01001185 for (auto it = compUnits.begin(); it != compUnits.end(); ++it)
John Kessenicha9313662017-06-15 10:40:49 -06001186 FreeFileData(const_cast<char*>(it->text[0]));
John Kessenichc57b2a92016-01-16 15:30:03 -07001187}
1188
John Kessenich94f28eb2017-11-13 01:32:06 -07001189int singleMain()
John Kessenicha0af4732012-12-12 21:15:54 +00001190{
Juan Lopeza558b262017-04-02 23:04:00 +02001191 glslang::TWorklist workList;
John Kessenich94f28eb2017-11-13 01:32:06 -07001192 std::for_each(WorkItems.begin(), WorkItems.end(), [&workList](std::unique_ptr<glslang::TWorkItem>& item) {
Juan Lopeza558b262017-04-02 23:04:00 +02001193 assert(item);
1194 workList.add(item.get());
1195 });
John Kessenich2b07c7e2013-07-31 18:44:13 +00001196
John Kessenich05a70632013-09-17 19:26:08 +00001197 if (Options & EOptionDumpConfig) {
Lei Zhang414eb602016-03-04 16:22:34 -05001198 printf("%s", glslang::GetDefaultTBuiltInResourceString().c_str());
Juan Lopeza558b262017-04-02 23:04:00 +02001199 if (workList.empty())
John Kessenich05a70632013-09-17 19:26:08 +00001200 return ESuccess;
1201 }
1202
John Kessenichc6c80a62018-03-05 22:23:17 -07001203 if (Options & EOptionDumpBareVersion) {
1204 printf("%d.%d.%d\n",
1205 glslang::GetSpirvGeneratorVersion(), GLSLANG_MINOR_VERSION, GLSLANG_PATCH_LEVEL);
1206 if (workList.empty())
1207 return ESuccess;
1208 } else if (Options & EOptionDumpVersions) {
1209 printf("Glslang Version: %d.%d.%d\n",
1210 glslang::GetSpirvGeneratorVersion(), GLSLANG_MINOR_VERSION, GLSLANG_PATCH_LEVEL);
John Kessenich319de232013-12-04 04:43:40 +00001211 printf("ESSL Version: %s\n", glslang::GetEsslVersionString());
1212 printf("GLSL Version: %s\n", glslang::GetGlslVersionString());
John Kessenich68d78fd2015-07-12 19:28:10 -06001213 std::string spirvVersion;
1214 glslang::GetSpirvVersion(spirvVersion);
John Kessenich0da9eaa2015-08-01 17:10:02 -06001215 printf("SPIR-V Version %s\n", spirvVersion.c_str());
John Kessenich5e4b1242015-08-06 22:53:06 -06001216 printf("GLSL.std.450 Version %d, Revision %d\n", GLSLstd450Version, GLSLstd450Revision);
John Kessenich55e7d112015-11-15 21:33:39 -07001217 printf("Khronos Tool ID %d\n", glslang::GetKhronosToolId());
John Kessenicha372a3e2017-11-02 22:32:14 -06001218 printf("SPIR-V Generator Version %d\n", glslang::GetSpirvGeneratorVersion());
John Kessenichb84313d2016-07-20 16:03:29 -06001219 printf("GL_KHR_vulkan_glsl version %d\n", 100);
1220 printf("ARB_GL_gl_spirv version %d\n", 100);
Juan Lopeza558b262017-04-02 23:04:00 +02001221 if (workList.empty())
John Kessenich319de232013-12-04 04:43:40 +00001222 return ESuccess;
1223 }
1224
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001225 if (workList.empty() && ((Options & EOptionStdin) == 0)) {
John Kessenich05a70632013-09-17 19:26:08 +00001226 usage();
John Kessenich05a70632013-09-17 19:26:08 +00001227 }
1228
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001229 if (Options & EOptionStdin) {
John Kessenich94f28eb2017-11-13 01:32:06 -07001230 WorkItems.push_back(std::unique_ptr<glslang::TWorkItem>{new glslang::TWorkItem("stdin")});
1231 workList.add(WorkItems.back().get());
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001232 }
1233
John Kessenich05a70632013-09-17 19:26:08 +00001234 ProcessConfigFile();
1235
John Kessenich086febc2018-10-25 12:43:02 -06001236 if ((Options & EOptionReadHlsl) && !((Options & EOptionOutputPreprocessed) || (Options & EOptionSpv)))
1237 Error("ERROR: HLSL requires SPIR-V code generation (or preprocessing only)");
1238
John Kessenich69f4b512013-09-04 21:19:27 +00001239 //
1240 // Two modes:
John Kessenich38f3b892013-09-06 19:52:57 +00001241 // 1) linking all arguments together, single-threaded, new C++ interface
1242 // 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 +00001243 //
John Kessenich086febc2018-10-25 12:43:02 -06001244 if (Options & (EOptionLinkProgram | EOptionOutputPreprocessed)) {
John Kessenichc36e1d82013-11-01 17:41:52 +00001245 glslang::InitializeProcess();
John Kesseniche2c15b42017-11-16 22:48:41 -07001246 glslang::InitializeProcess(); // also test reference counting of users
1247 glslang::InitializeProcess(); // also test reference counting of users
1248 glslang::FinalizeProcess(); // also test reference counting of users
1249 glslang::FinalizeProcess(); // also test reference counting of users
Juan Lopeza558b262017-04-02 23:04:00 +02001250 CompileAndLinkShaderFiles(workList);
John Kessenichc36e1d82013-11-01 17:41:52 +00001251 glslang::FinalizeProcess();
1252 } else {
1253 ShInitialize();
John Kesseniche2c15b42017-11-16 22:48:41 -07001254 ShInitialize(); // also test reference counting of users
1255 ShFinalize(); // also test reference counting of users
John Kessenichc36e1d82013-11-01 17:41:52 +00001256
Juan Lopeza558b262017-04-02 23:04:00 +02001257 bool printShaderNames = workList.size() > 1;
John Kessenich69f4b512013-09-04 21:19:27 +00001258
John Kesseniche2c15b42017-11-16 22:48:41 -07001259 if (Options & EOptionMultiThreaded) {
Juan Lopeza558b262017-04-02 23:04:00 +02001260 std::array<std::thread, 16> threads;
John Kesseniche2c15b42017-11-16 22:48:41 -07001261 for (unsigned int t = 0; t < threads.size(); ++t) {
Juan Lopeza558b262017-04-02 23:04:00 +02001262 threads[t] = std::thread(CompileShaders, std::ref(workList));
John Kesseniche2c15b42017-11-16 22:48:41 -07001263 if (threads[t].get_id() == std::thread::id()) {
John Kessenichaf527992017-11-02 22:48:15 -06001264 fprintf(stderr, "Failed to create thread\n");
John Kessenich38f3b892013-09-06 19:52:57 +00001265 return EFailThreadCreate;
1266 }
John Kessenicha0af4732012-12-12 21:15:54 +00001267 }
Juan Lopeza558b262017-04-02 23:04:00 +02001268
1269 std::for_each(threads.begin(), threads.end(), [](std::thread& t) { t.join(); });
John Kessenichc999ba22013-11-07 23:33:24 +00001270 } else
Juan Lopeza558b262017-04-02 23:04:00 +02001271 CompileShaders(workList);
John Kessenich38f3b892013-09-06 19:52:57 +00001272
1273 // Print out all the resulting infologs
John Kessenich94f28eb2017-11-13 01:32:06 -07001274 for (size_t w = 0; w < WorkItems.size(); ++w) {
1275 if (WorkItems[w]) {
1276 if (printShaderNames || WorkItems[w]->results.size() > 0)
1277 PutsIfNonEmpty(WorkItems[w]->name.c_str());
1278 PutsIfNonEmpty(WorkItems[w]->results.c_str());
John Kessenich38f3b892013-09-06 19:52:57 +00001279 }
1280 }
John Kessenichc36e1d82013-11-01 17:41:52 +00001281
1282 ShFinalize();
John Kessenicha0af4732012-12-12 21:15:54 +00001283 }
John Kessenich2b07c7e2013-07-31 18:44:13 +00001284
John Kessenichc999ba22013-11-07 23:33:24 +00001285 if (CompileFailed)
John Kessenicha0af4732012-12-12 21:15:54 +00001286 return EFailCompile;
John Kessenichc999ba22013-11-07 23:33:24 +00001287 if (LinkFailed)
John Kessenicha0af4732012-12-12 21:15:54 +00001288 return EFailLink;
1289
1290 return 0;
1291}
1292
John Kessenich94f28eb2017-11-13 01:32:06 -07001293int C_DECL main(int argc, char* argv[])
1294{
1295 ProcessArguments(WorkItems, argc, argv);
1296
1297 int ret = 0;
1298
1299 // Loop over the entire init/finalize cycle to watch memory changes
1300 const int iterations = 1;
1301 if (iterations > 1)
1302 glslang::OS_DumpMemoryCounters();
1303 for (int i = 0; i < iterations; ++i) {
1304 ret = singleMain();
1305 if (iterations > 1)
1306 glslang::OS_DumpMemoryCounters();
1307 }
1308
1309 return ret;
1310}
1311
John Kessenicha0af4732012-12-12 21:15:54 +00001312//
1313// Deduce the language from the filename. Files must end in one of the
1314// following extensions:
1315//
John Kessenich2b07c7e2013-07-31 18:44:13 +00001316// .vert = vertex
1317// .tesc = tessellation control
1318// .tese = tessellation evaluation
1319// .geom = geometry
1320// .frag = fragment
John Kessenich94a81fb2013-08-31 02:41:30 +00001321// .comp = compute
Chao Chenb50c02e2018-09-19 11:42:24 -07001322// .rgen = ray generation
1323// .rint = ray intersection
1324// .rahit = ray any hit
1325// .rchit = ray closest hit
1326// .rmiss = ray miss
1327// .rcall = ray callable
Sahil Parmar035cbbe2018-10-04 16:39:18 -07001328// .mesh = mesh
1329// .task = task
Grigory Dzhavadyan33507412018-04-12 14:35:24 -07001330// Additionally, the file names may end in .<stage>.glsl and .<stage>.hlsl
1331// where <stage> is one of the stages listed above.
1332//
1333EShLanguage FindLanguage(const std::string& name, bool parseStageName)
John Kessenicha0af4732012-12-12 21:15:54 +00001334{
John Kessenichfccbb8b2018-04-17 17:24:03 -06001335 std::string stageName;
Dan Bakerc6ede892016-08-11 14:06:06 -04001336 if (shaderStageName)
John Kessenichfccbb8b2018-04-17 17:24:03 -06001337 stageName = shaderStageName;
1338 else if (parseStageName) {
Grigory Dzhavadyan33507412018-04-12 14:35:24 -07001339 // Note: "first" extension means "first from the end", i.e.
1340 // if the file is named foo.vert.glsl, then "glsl" is first,
1341 // "vert" is second.
John Kessenichfccbb8b2018-04-17 17:24:03 -06001342 size_t firstExtStart = name.find_last_of(".");
1343 bool hasFirstExt = firstExtStart != std::string::npos;
1344 size_t secondExtStart = hasFirstExt ? name.find_last_of(".", firstExtStart - 1) : std::string::npos;
1345 bool hasSecondExt = secondExtStart != std::string::npos;
1346 std::string firstExt = name.substr(firstExtStart + 1, std::string::npos);
1347 bool usesUnifiedExt = hasFirstExt && (firstExt == "glsl" || firstExt == "hlsl");
John Kessenich3beac942018-04-17 21:02:19 -06001348 if (usesUnifiedExt && firstExt == "hlsl")
1349 Options |= EOptionReadHlsl;
1350 if (hasFirstExt && !usesUnifiedExt)
John Kessenichfccbb8b2018-04-17 17:24:03 -06001351 stageName = firstExt;
John Kessenich3beac942018-04-17 21:02:19 -06001352 else if (usesUnifiedExt && hasSecondExt)
John Kessenichfccbb8b2018-04-17 17:24:03 -06001353 stageName = name.substr(secondExtStart + 1, firstExtStart - secondExtStart - 1);
John Kessenich3beac942018-04-17 21:02:19 -06001354 else {
Grigory Dzhavadyan33507412018-04-12 14:35:24 -07001355 usage();
1356 return EShLangVertex;
John Kesseniche751bca2017-03-16 11:20:38 -06001357 }
John Kessenichfccbb8b2018-04-17 17:24:03 -06001358 } else
1359 stageName = name;
dankbaker45d49bc2016-08-08 21:43:07 -04001360
John Kessenichfccbb8b2018-04-17 17:24:03 -06001361 if (stageName == "vert")
John Kessenich2b07c7e2013-07-31 18:44:13 +00001362 return EShLangVertex;
John Kessenichfccbb8b2018-04-17 17:24:03 -06001363 else if (stageName == "tesc")
John Kessenich2b07c7e2013-07-31 18:44:13 +00001364 return EShLangTessControl;
John Kessenichfccbb8b2018-04-17 17:24:03 -06001365 else if (stageName == "tese")
John Kessenich2b07c7e2013-07-31 18:44:13 +00001366 return EShLangTessEvaluation;
John Kessenichfccbb8b2018-04-17 17:24:03 -06001367 else if (stageName == "geom")
John Kessenich2b07c7e2013-07-31 18:44:13 +00001368 return EShLangGeometry;
John Kessenichfccbb8b2018-04-17 17:24:03 -06001369 else if (stageName == "frag")
John Kessenich2b07c7e2013-07-31 18:44:13 +00001370 return EShLangFragment;
John Kessenichfccbb8b2018-04-17 17:24:03 -06001371 else if (stageName == "comp")
John Kessenichc0275792013-08-09 17:14:49 +00001372 return EShLangCompute;
Chao Chen3c366992018-09-19 11:41:59 -07001373#ifdef NV_EXTENSIONS
Chao Chenb50c02e2018-09-19 11:42:24 -07001374 else if (stageName == "rgen")
1375 return EShLangRayGenNV;
1376 else if (stageName == "rint")
1377 return EShLangIntersectNV;
1378 else if (stageName == "rahit")
1379 return EShLangAnyHitNV;
1380 else if (stageName == "rchit")
1381 return EShLangClosestHitNV;
1382 else if (stageName == "rmiss")
1383 return EShLangMissNV;
1384 else if (stageName == "rcall")
1385 return EShLangCallableNV;
Chao Chen3c366992018-09-19 11:41:59 -07001386 else if (stageName == "mesh")
1387 return EShLangMeshNV;
1388 else if (stageName == "task")
1389 return EShLangTaskNV;
1390#endif
John Kessenich2b07c7e2013-07-31 18:44:13 +00001391
1392 usage();
John Kesseniche95ecc52012-12-12 21:34:14 +00001393 return EShLangVertex;
John Kessenicha0af4732012-12-12 21:15:54 +00001394}
1395
John Kessenicha0af4732012-12-12 21:15:54 +00001396//
John Kessenichecba76f2017-01-06 00:34:48 -07001397// Read a file's data into a string, and compile it using the old interface ShCompile,
John Kessenich69f4b512013-09-04 21:19:27 +00001398// for non-linkable results.
John Kessenicha0af4732012-12-12 21:15:54 +00001399//
John Kessenich51cdd902014-02-18 23:37:57 +00001400void CompileFile(const char* fileName, ShHandle compiler)
John Kessenicha0af4732012-12-12 21:15:54 +00001401{
John Kessenichca3457f2015-05-18 01:59:45 +00001402 int ret = 0;
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001403 char* shaderString;
1404 if ((Options & EOptionStdin) != 0) {
1405 std::istreambuf_iterator<char> begin(std::cin), end;
1406 std::string tempString(begin, end);
1407 shaderString = strdup(tempString.c_str());
1408 } else {
1409 shaderString = ReadFileData(fileName);
1410 }
John Kessenich41cf6b52013-06-25 18:10:05 +00001411
1412 // move to length-based strings, rather than null-terminated strings
John Kessenich04acb1b2017-06-14 17:36:50 -06001413 int* lengths = new int[1];
1414 lengths[0] = (int)strlen(shaderString);
John Kessenicha0af4732012-12-12 21:15:54 +00001415
John Kessenich52ac67e2013-05-05 23:46:22 +00001416 EShMessages messages = EShMsgDefault;
John Kessenichb0a7eb52013-11-07 17:44:20 +00001417 SetMessageOptions(messages);
John Kessenichecba76f2017-01-06 00:34:48 -07001418
John Kessenicha9313662017-06-15 10:40:49 -06001419 if (UserPreamble.isSet())
1420 Error("-D and -U options require -l (linking)\n");
1421
John Kessenich94a81fb2013-08-31 02:41:30 +00001422 for (int i = 0; i < ((Options & EOptionMemoryLeakMode) ? 100 : 1); ++i) {
1423 for (int j = 0; j < ((Options & EOptionMemoryLeakMode) ? 100 : 1); ++j) {
John Kessenich927608b2017-01-06 12:34:14 -07001424 // ret = ShCompile(compiler, shaderStrings, NumShaderStrings, lengths, EShOptNone, &Resources, Options, (Options & EOptionDefaultDesktop) ? 110 : 100, false, messages);
John Kessenich04acb1b2017-06-14 17:36:50 -06001425 ret = ShCompile(compiler, &shaderString, 1, nullptr, EShOptNone, &Resources, Options, (Options & EOptionDefaultDesktop) ? 110 : 100, false, messages);
John Kessenich927608b2017-01-06 12:34:14 -07001426 // const char* multi[12] = { "# ve", "rsion", " 300 e", "s", "\n#err",
John Kessenichecba76f2017-01-06 00:34:48 -07001427 // "or should be l", "ine 1", "string 5\n", "float glo", "bal",
John Kessenichea869fb2013-10-28 18:12:06 +00001428 // ";\n#error should be line 2\n void main() {", "global = 2.3;}" };
John Kessenich927608b2017-01-06 12:34:14 -07001429 // const char* multi[7] = { "/", "/", "\\", "\n", "\n", "#", "version 300 es" };
1430 // ret = ShCompile(compiler, multi, 7, nullptr, EShOptNone, &Resources, Options, (Options & EOptionDefaultDesktop) ? 110 : 100, false, messages);
John Kessenich41cf6b52013-06-25 18:10:05 +00001431 }
John Kessenicha0af4732012-12-12 21:15:54 +00001432
John Kessenich94a81fb2013-08-31 02:41:30 +00001433 if (Options & EOptionMemoryLeakMode)
John Kessenich2b07c7e2013-07-31 18:44:13 +00001434 glslang::OS_DumpMemoryCounters();
John Kessenicha0af4732012-12-12 21:15:54 +00001435 }
John Kessenicha0af4732012-12-12 21:15:54 +00001436
John Kessenich41cf6b52013-06-25 18:10:05 +00001437 delete [] lengths;
John Kessenich04acb1b2017-06-14 17:36:50 -06001438 FreeFileData(shaderString);
John Kessenicha0af4732012-12-12 21:15:54 +00001439
John Kessenichc999ba22013-11-07 23:33:24 +00001440 if (ret == 0)
1441 CompileFailed = true;
John Kessenicha0af4732012-12-12 21:15:54 +00001442}
1443
John Kessenicha0af4732012-12-12 21:15:54 +00001444//
1445// print usage to stdout
1446//
1447void usage()
1448{
John Kessenich319de232013-12-04 04:43:40 +00001449 printf("Usage: glslangValidator [option]... [file]...\n"
1450 "\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001451 "'file' can end in .<stage> for auto-stage classification, where <stage> is:\n"
1452 " .conf to provide a config file that replaces the default configuration\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001453 " (see -c option below for generating a template)\n"
1454 " .vert for a vertex shader\n"
1455 " .tesc for a tessellation control shader\n"
1456 " .tese for a tessellation evaluation shader\n"
1457 " .geom for a geometry shader\n"
1458 " .frag for a fragment shader\n"
1459 " .comp for a compute shader\n"
Chao Chen3c366992018-09-19 11:41:59 -07001460#ifdef NV_EXTENSIONS
1461 " .mesh for a mesh shader\n"
1462 " .task for a task shader\n"
Chao Chenb50c02e2018-09-19 11:42:24 -07001463 " .rgen for a ray generation shader\n"
1464 " .rint for a ray intersection shader\n"
1465 " .rahit for a ray any hit shader\n"
1466 " .rchit for a ray closest hit shader\n"
1467 " .rmiss for a ray miss shader\n"
Sahil Parmar035cbbe2018-10-04 16:39:18 -07001468 " .rcall for a ray callable shader\n"
Chao Chen3c366992018-09-19 11:41:59 -07001469#endif
John Kessenich2ead40f2018-04-17 17:44:11 -06001470 " .glsl for .vert.glsl, .tesc.glsl, ..., .comp.glsl compound suffixes\n"
1471 " .hlsl for .vert.hlsl, .tesc.hlsl, ..., .comp.hlsl compound suffixes\n"
John Kessenich319de232013-12-04 04:43:40 +00001472 "\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001473 "Options:\n"
1474 " -C cascading errors; risk crash from accumulation of error recoveries\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001475 " -D input is HLSL (this is the default when any suffix is .hlsl)\n"
John Kessenicha9313662017-06-15 10:40:49 -06001476 " -D<macro=def>\n"
1477 " -D<macro> define a pre-processor macro\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001478 " -E print pre-processed GLSL; cannot be used with -l;\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001479 " errors will appear on stderr\n"
John Kessenich6353d552017-06-23 11:11:09 -06001480 " -G[ver] create SPIR-V binary, under OpenGL semantics; turns on -l;\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001481 " default file name is <stage>.spv (-o overrides this);\n"
John Kessenich6353d552017-06-23 11:11:09 -06001482 " 'ver', when present, is the version of the input semantics,\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001483 " which will appear in #define GL_SPIRV ver;\n"
1484 " '--client opengl100' is the same as -G100;\n"
John Kessenich6353d552017-06-23 11:11:09 -06001485 " a '--target-env' for OpenGL will also imply '-G'\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001486 " -H print human readable form of SPIR-V; turns on -V\n"
John Kessenich971a0a82017-06-07 15:06:58 -06001487 " -I<dir> add dir to the include search path; includer's directory\n"
1488 " is searched first, followed by left-to-right order of -I\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001489 " -Od disables optimization; may cause illegal SPIR-V for HLSL\n"
1490 " -Os optimizes SPIR-V to minimize size\n"
John Kesseniche751bca2017-03-16 11:20:38 -06001491 " -S <stage> uses specified stage rather than parsing the file extension\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001492 " choices for <stage> are vert, tesc, tese, geom, frag, or comp\n"
John Kessenich6353d552017-06-23 11:11:09 -06001493 " -U<macro> undefine a pre-processor macro\n"
1494 " -V[ver] create SPIR-V binary, under Vulkan semantics; turns on -l;\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001495 " default file name is <stage>.spv (-o overrides this)\n"
John Kessenich6353d552017-06-23 11:11:09 -06001496 " 'ver', when present, is the version of the input semantics,\n"
1497 " which will appear in #define VULKAN ver\n"
1498 " '--client vulkan100' is the same as -V100\n"
1499 " a '--target-env' for Vulkan will also imply '-V'\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001500 " -c configuration dump;\n"
1501 " creates the default configuration file (redirect to a .conf file)\n"
1502 " -d default to desktop (#version 110) when there is no shader #version\n"
1503 " (default is ES version 100)\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001504 " -e <name> | --entry-point <name>\n"
1505 " specify <name> as the entry-point function name\n"
John Kessenich5d610ee2018-03-07 18:05:55 -07001506 " -f{hlsl_functionality1}\n"
1507 " 'hlsl_functionality1' enables use of the\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001508 " SPV_GOOGLE_hlsl_functionality1 extension\n"
John Kessenich121853f2017-05-31 17:11:16 -06001509 " -g generate debug information\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001510 " -h print this usage message\n"
1511 " -i intermediate tree (glslang AST) is printed out\n"
1512 " -l link all input files together to form a single module\n"
1513 " -m memory leak mode\n"
John Kessenicha25530c2017-09-11 20:13:49 -06001514 " -o <file> save binary to <file>, requires a binary option (e.g., -V)\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001515 " -q dump reflection query database\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001516 " -r | --relaxed-errors"
1517 " relaxed GLSL semantic error-checking mode\n"
John Kessenichb63f4a32017-11-16 22:32:20 -07001518 " -s silence syntax and semantic error reporting\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001519 " -t multi-threaded mode\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001520 " -v | --version\n"
1521 " print version strings\n"
1522 " -w | --suppress-warnings\n"
1523 " suppress GLSL warnings, except as required by \"#extension : warn\"\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001524 " -x save binary output as text-based 32-bit hexadecimal numbers\n"
Neil Roberts16f53472018-03-20 17:30:53 +01001525 " -u<name>:<loc> specify a uniform location override for --aml\n"
Neil Robertsb0f3d792018-03-20 17:41:05 +01001526 " --uniform-base <base> set a base to use for generated uniform locations\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001527 " --auto-map-bindings | --amb automatically bind uniform variables\n"
1528 " without explicit bindings\n"
1529 " --auto-map-locations | --aml automatically locate input/output lacking\n"
1530 " 'location' (fragile, not cross stage)\n"
1531 " --client {vulkan<ver>|opengl<ver>} see -V and -G\n"
Christoph Kubisch412ff6e2019-04-13 22:57:33 +02001532 " --dump-builtin-symbols prints builtin symbol table prior each compile\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001533 " -dumpfullversion | -dumpversion print bare major.minor.patchlevel\n"
1534 " --flatten-uniform-arrays | --fua flatten uniform texture/sampler arrays to\n"
1535 " scalars\n"
1536 " --hlsl-offsets allow block offsets to follow HLSL rules\n"
1537 " works independently of source language\n"
1538 " --hlsl-iomap perform IO mapping in HLSL register space\n"
1539 " --hlsl-enable-16bit-types allow 16-bit types in SPIR-V for HLSL\n"
John Kessenich605afc72019-06-17 23:33:09 -06001540 " --hlsl-dx9-compatible interprets sampler declarations as a\n"
1541 " texture/sampler combo like DirectX9 would.\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001542 " --invert-y | --iy invert position.Y output in vertex shader\n"
1543 " --keep-uncalled | --ku don't eliminate uncalled functions\n"
John Kessenich605afc72019-06-17 23:33:09 -06001544 " --nan-clamp favor non-NaN operand in min, max, and clamp\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001545 " --no-storage-format | --nsf use Unknown image format\n"
baldurk4513df92019-02-08 10:48:48 +00001546 " --reflect-strict-array-suffix use strict array suffix rules when\n"
1547 " reflecting\n"
baldurkedf82122019-01-29 15:49:00 +00001548 " --reflect-basic-array-suffix arrays of basic types will have trailing [0]\n"
baldurk4513df92019-02-08 10:48:48 +00001549 " --reflect-intermediate-io reflection includes inputs/outputs of linked\n"
1550 " shaders rather than just vertex/fragment\n"
1551 " --reflect-separate-buffers reflect buffer variables and blocks\n"
1552 " separately to uniforms\n"
1553 " --reflect-all-block-variables reflect all variables in blocks, whether\n"
1554 " inactive or active\n"
baldurk19050692019-02-11 11:50:24 +00001555 " --reflect-unwrap-io-blocks unwrap input/output blocks the same as\n"
1556 " uniform blocks\n"
LoopDawg52017192017-07-14 15:15:47 -06001557 " --resource-set-binding [stage] name set binding\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001558 " set descriptor set and binding for\n"
1559 " individual resources\n"
LoopDawg52017192017-07-14 15:15:47 -06001560 " --resource-set-binding [stage] set\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001561 " set descriptor set for all resources\n"
1562 " --rsb synonym for --resource-set-binding\n"
1563 " --shift-image-binding [stage] num\n"
1564 " base binding number for images (uav)\n"
1565 " --shift-image-binding [stage] [num set]...\n"
1566 " per-descriptor-set shift values\n"
1567 " --sib synonym for --shift-image-binding\n"
1568 " --shift-sampler-binding [stage] num\n"
1569 " base binding number for samplers\n"
1570 " --shift-sampler-binding [stage] [num set]...\n"
1571 " per-descriptor-set shift values\n"
1572 " --ssb synonym for --shift-sampler-binding\n"
1573 " --shift-ssbo-binding [stage] num base binding number for SSBOs\n"
1574 " --shift-ssbo-binding [stage] [num set]...\n"
1575 " per-descriptor-set shift values\n"
1576 " --sbb synonym for --shift-ssbo-binding\n"
1577 " --shift-texture-binding [stage] num\n"
1578 " base binding number for textures\n"
1579 " --shift-texture-binding [stage] [num set]...\n"
1580 " per-descriptor-set shift values\n"
1581 " --stb synonym for --shift-texture-binding\n"
1582 " --shift-uav-binding [stage] num base binding number for UAVs\n"
1583 " --shift-uav-binding [stage] [num set]...\n"
1584 " per-descriptor-set shift values\n"
1585 " --suavb synonym for --shift-uav-binding\n"
1586 " --shift-UBO-binding [stage] num base binding number for UBOs\n"
1587 " --shift-UBO-binding [stage] [num set]...\n"
1588 " per-descriptor-set shift values\n"
1589 " --sub synonym for --shift-UBO-binding\n"
1590 " --shift-cbuffer-binding | --scb synonyms for --shift-UBO-binding\n"
1591 " --spirv-dis output standard-form disassembly; works only\n"
1592 " when a SPIR-V generation option is also used\n"
John Kessenichc3404252018-08-23 15:29:08 -06001593 " --spirv-val execute the SPIRV-Tools validator\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001594 " --source-entrypoint <name> the given shader source function is\n"
1595 " renamed to be the <name> given in -e\n"
1596 " --sep synonym for --source-entrypoint\n"
1597 " --stdin read from stdin instead of from a file;\n"
1598 " requires providing the shader stage using -S\n"
John Kessenich8717a5d2018-10-26 10:12:32 -06001599 " --target-env {vulkan1.0 | vulkan1.1 | opengl | \n"
1600 " spirv1.0 | spirv1.1 | spirv1.2 | spirv1.3}\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001601 " set execution environment that emitted code\n"
John Kessenich8717a5d2018-10-26 10:12:32 -06001602 " will execute in (versus source language\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001603 " semantics selected by --client) defaults:\n"
1604 " * 'vulkan1.0' under '--client vulkan<ver>'\n"
1605 " * 'opengl' under '--client opengl<ver>'\n"
John Kessenich8717a5d2018-10-26 10:12:32 -06001606 " * 'spirv1.0' under --target-env vulkan1.0\n"
1607 " * 'spirv1.3' under --target-env vulkan1.1\n"
1608 " multiple --targen-env can be specified.\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001609 " --variable-name <name>\n"
1610 " --vn <name> creates a C header file that contains a\n"
1611 " uint32_t array named <name>\n"
1612 " initialized with the shader binary code\n"
John Kessenichb0a7eb52013-11-07 17:44:20 +00001613 );
John Kessenich68d78fd2015-07-12 19:28:10 -06001614
1615 exit(EFailUsage);
John Kessenicha0af4732012-12-12 21:15:54 +00001616}
1617
John Kessenich3ce4e592014-10-06 19:57:34 +00001618#if !defined _MSC_VER && !defined MINGW_HAS_SECURE_API
John Kessenichcfd643e2013-03-08 23:14:42 +00001619
1620#include <errno.h>
1621
1622int fopen_s(
1623 FILE** pFile,
John Kessenich51cdd902014-02-18 23:37:57 +00001624 const char* filename,
1625 const char* mode
John Kessenichcfd643e2013-03-08 23:14:42 +00001626)
1627{
1628 if (!pFile || !filename || !mode) {
1629 return EINVAL;
1630 }
1631
1632 FILE* f = fopen(filename, mode);
1633 if (! f) {
1634 if (errno != 0) {
1635 return errno;
1636 } else {
1637 return ENOENT;
1638 }
1639 }
1640 *pFile = f;
1641
1642 return 0;
1643}
1644
1645#endif
1646
John Kessenicha0af4732012-12-12 21:15:54 +00001647//
1648// Malloc a string of sufficient size and read a string into it.
1649//
John Kessenich04acb1b2017-06-14 17:36:50 -06001650char* ReadFileData(const char* fileName)
John Kessenicha0af4732012-12-12 21:15:54 +00001651{
John Kessenichb3297152015-07-11 18:01:03 -06001652 FILE *in = nullptr;
John Kessenich3ce4e592014-10-06 19:57:34 +00001653 int errorCode = fopen_s(&in, fileName, "r");
John Kessenich68d78fd2015-07-12 19:28:10 -06001654 if (errorCode || in == nullptr)
1655 Error("unable to open input file");
John Kessenichecba76f2017-01-06 00:34:48 -07001656
John Kessenich04acb1b2017-06-14 17:36:50 -06001657 int count = 0;
John Kessenicha0af4732012-12-12 21:15:54 +00001658 while (fgetc(in) != EOF)
1659 count++;
1660
John Kessenichd6c72a42014-08-18 19:42:35 +00001661 fseek(in, 0, SEEK_SET);
John Kessenichca3457f2015-05-18 01:59:45 +00001662
John Kessenich04acb1b2017-06-14 17:36:50 -06001663 char* return_data = (char*)malloc(count + 1); // freed in FreeFileData()
1664 if ((int)fread(return_data, 1, count, in) != count) {
1665 free(return_data);
John Kessenich68d78fd2015-07-12 19:28:10 -06001666 Error("can't read input file");
John Kessenicha0af4732012-12-12 21:15:54 +00001667 }
John Kessenich68d78fd2015-07-12 19:28:10 -06001668
John Kessenich04acb1b2017-06-14 17:36:50 -06001669 return_data[count] = '\0';
John Kessenicha0af4732012-12-12 21:15:54 +00001670 fclose(in);
John Kessenichb3297152015-07-11 18:01:03 -06001671
John Kessenicha0af4732012-12-12 21:15:54 +00001672 return return_data;
1673}
1674
John Kessenich04acb1b2017-06-14 17:36:50 -06001675void FreeFileData(char* data)
John Kessenicha0af4732012-12-12 21:15:54 +00001676{
John Kessenichb3297152015-07-11 18:01:03 -06001677 free(data);
John Kessenicha0af4732012-12-12 21:15:54 +00001678}
1679
John Kessenich54d8cda2013-02-11 22:36:01 +00001680void InfoLogMsg(const char* msg, const char* name, const int num)
John Kessenicha0af4732012-12-12 21:15:54 +00001681{
John Kessenichfae38ee2015-06-10 23:23:12 +00001682 if (num >= 0 )
1683 printf("#### %s %s %d INFO LOG ####\n", msg, name, num);
1684 else
1685 printf("#### %s %s INFO LOG ####\n", msg, name);
John Kessenicha0af4732012-12-12 21:15:54 +00001686}