blob: 871788e1d421ba324ee1a8814b7a15fdff721fe6 [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 Kessenich56364b62020-03-01 04:51:40 -07004// Copyright (C) 2016-2020 Google, Inc.
John Kessenichbd0747d2013-02-17 06:01:50 +00005//
John Kessenich927608b2017-01-06 12:34:14 -07006// All rights reserved.
John Kessenicha0af4732012-12-12 21:15:54 +00007//
John Kessenich927608b2017-01-06 12:34:14 -07008// Redistribution and use in source and binary forms, with or without
9// modification, are permitted provided that the following conditions
10// are met:
John Kessenicha0af4732012-12-12 21:15:54 +000011//
12// Redistributions of source code must retain the above copyright
13// notice, this list of conditions and the following disclaimer.
14//
15// Redistributions in binary form must reproduce the above
16// copyright notice, this list of conditions and the following
17// disclaimer in the documentation and/or other materials provided
18// with the distribution.
19//
20// Neither the name of 3Dlabs Inc. Ltd. nor the names of its
21// contributors may be used to endorse or promote products derived
22// from this software without specific prior written permission.
23//
John Kessenich927608b2017-01-06 12:34:14 -070024// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
25// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
26// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
27// FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
28// COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
29// INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
30// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
31// LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
32// CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
33// LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
34// ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35// POSSIBILITY OF SUCH DAMAGE.
John Kessenicha0af4732012-12-12 21:15:54 +000036//
John Kessenich05a70632013-09-17 19:26:08 +000037
38// this only applies to the standalone wrapper, not the front end in general
Aras Pranckevicius8e204b22017-05-10 16:52:50 +030039#ifndef _CRT_SECURE_NO_WARNINGS
John Kessenich05a70632013-09-17 19:26:08 +000040#define _CRT_SECURE_NO_WARNINGS
Aras Pranckevicius8e204b22017-05-10 16:52:50 +030041#endif
John Kessenich05a70632013-09-17 19:26:08 +000042
Lei Zhang8a9b1ee2016-05-19 13:31:43 -040043#include "ResourceLimits.h"
John Kessenich2b07c7e2013-07-31 18:44:13 +000044#include "Worklist.h"
John Kessenich3494b4d2017-05-22 15:00:42 -060045#include "DirStackFileIncluder.h"
John Kessenicha0af4732012-12-12 21:15:54 +000046#include "./../glslang/Include/ShHandle.h"
John Kessenich0da9eaa2015-08-01 17:10:02 -060047#include "./../glslang/Include/revision.h"
John Kessenicha0af4732012-12-12 21:15:54 +000048#include "./../glslang/Public/ShaderLang.h"
John Kessenich0df0cde2015-03-03 17:09:43 +000049#include "../SPIRV/GlslangToSpv.h"
John Kessenich5e4b1242015-08-06 22:53:06 -060050#include "../SPIRV/GLSL.std.450.h"
John Kessenichacba7722015-03-04 03:48:38 +000051#include "../SPIRV/doc.h"
52#include "../SPIRV/disassemble.h"
John Kessenich3494b4d2017-05-22 15:00:42 -060053
John Kessenich66ec80e2016-08-05 14:04:23 -060054#include <cstring>
55#include <cstdlib>
steve-lunarg7f7c2ed2016-09-07 15:20:19 -060056#include <cctype>
John Kessenich66ec80e2016-08-05 14:04:23 -060057#include <cmath>
steve-lunarg7f7c2ed2016-09-07 15:20:19 -060058#include <array>
LoopDawg08a14422017-10-17 19:27:14 -060059#include <map>
Juan Lopeza558b262017-04-02 23:04:00 +020060#include <memory>
61#include <thread>
John Kessenicha0af4732012-12-12 21:15:54 +000062
baldurk876a0e32015-11-16 18:03:28 +010063#include "../glslang/OSDependent/osinclude.h"
John Kessenicha0af4732012-12-12 21:15:54 +000064
65extern "C" {
66 SH_IMPORT_EXPORT void ShOutputHtml();
67}
68
John Kessenich94a81fb2013-08-31 02:41:30 +000069// Command-line options
70enum TOptions {
John Kessenich906cc212016-12-09 19:22:20 -070071 EOptionNone = 0,
72 EOptionIntermediate = (1 << 0),
73 EOptionSuppressInfolog = (1 << 1),
74 EOptionMemoryLeakMode = (1 << 2),
75 EOptionRelaxedErrors = (1 << 3),
76 EOptionGiveWarnings = (1 << 4),
77 EOptionLinkProgram = (1 << 5),
78 EOptionMultiThreaded = (1 << 6),
79 EOptionDumpConfig = (1 << 7),
80 EOptionDumpReflection = (1 << 8),
81 EOptionSuppressWarnings = (1 << 9),
82 EOptionDumpVersions = (1 << 10),
83 EOptionSpv = (1 << 11),
84 EOptionHumanReadableSpv = (1 << 12),
85 EOptionVulkanRules = (1 << 13),
86 EOptionDefaultDesktop = (1 << 14),
87 EOptionOutputPreprocessed = (1 << 15),
88 EOptionOutputHexadecimal = (1 << 16),
89 EOptionReadHlsl = (1 << 17),
90 EOptionCascadingErrors = (1 << 18),
91 EOptionAutoMapBindings = (1 << 19),
steve-lunarge0b9deb2016-09-16 13:26:37 -060092 EOptionFlattenUniformArrays = (1 << 20),
John Kessenich906cc212016-12-09 19:22:20 -070093 EOptionNoStorageFormat = (1 << 21),
John Kessenich20f01e72016-12-12 11:41:43 -070094 EOptionKeepUncalled = (1 << 22),
John Kessenich4f1403e2017-04-05 17:38:20 -060095 EOptionHlslOffsets = (1 << 23),
steve-lunargbe283552017-04-18 12:18:01 -060096 EOptionHlslIoMapping = (1 << 24),
John Kessenich71facdf2017-05-17 18:28:19 -060097 EOptionAutoMapLocations = (1 << 25),
John Kessenich121853f2017-05-31 17:11:16 -060098 EOptionDebug = (1 << 26),
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +020099 EOptionStdin = (1 << 27),
GregFcd1f1692017-09-21 18:40:22 -0600100 EOptionOptimizeDisable = (1 << 28),
101 EOptionOptimizeSize = (1 << 29),
LoopDawgb22c0692017-12-06 16:52:03 -0700102 EOptionInvertY = (1 << 30),
John Kessenichc6c80a62018-03-05 22:23:17 -0700103 EOptionDumpBareVersion = (1 << 31),
John Kessenich94a81fb2013-08-31 02:41:30 +0000104};
John Kessenich5d610ee2018-03-07 18:05:55 -0700105bool targetHlslFunctionality1 = false;
John Kesseniche2156222018-06-11 18:12:15 -0600106bool SpvToolsDisassembler = false;
John Kessenichc3404252018-08-23 15:29:08 -0600107bool SpvToolsValidate = false;
John Kessenich605afc72019-06-17 23:33:09 -0600108bool NaNClamp = false;
John Kessenich94a81fb2013-08-31 02:41:30 +0000109
John Kessenicha0af4732012-12-12 21:15:54 +0000110//
John Kessenich68d78fd2015-07-12 19:28:10 -0600111// Return codes from main/exit().
John Kessenicha0af4732012-12-12 21:15:54 +0000112//
113enum TFailCode {
114 ESuccess = 0,
115 EFailUsage,
116 EFailCompile,
117 EFailLink,
118 EFailCompilerCreate,
John Kessenich2b07c7e2013-07-31 18:44:13 +0000119 EFailThreadCreate,
John Kessenicha0af4732012-12-12 21:15:54 +0000120 EFailLinkerCreate
121};
122
123//
John Kessenich68d78fd2015-07-12 19:28:10 -0600124// Forward declarations.
John Kessenicha0af4732012-12-12 21:15:54 +0000125//
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600126EShLanguage FindLanguage(const std::string& name, bool parseSuffix=true);
John Kessenich51cdd902014-02-18 23:37:57 +0000127void CompileFile(const char* fileName, ShHandle);
John Kessenicha0af4732012-12-12 21:15:54 +0000128void usage();
John Kessenich04acb1b2017-06-14 17:36:50 -0600129char* ReadFileData(const char* fileName);
130void FreeFileData(char* data);
John Kessenich54d8cda2013-02-11 22:36:01 +0000131void InfoLogMsg(const char* msg, const char* name, const int num);
John Kessenich41cf6b52013-06-25 18:10:05 +0000132
John Kessenichc999ba22013-11-07 23:33:24 +0000133// Globally track if any compile or link failure.
134bool CompileFailed = false;
135bool LinkFailed = false;
136
John Kessenich94f28eb2017-11-13 01:32:06 -0700137// array of unique places to leave the shader names and infologs for the asynchronous compiles
138std::vector<std::unique_ptr<glslang::TWorkItem>> WorkItems;
139
John Kessenich05a70632013-09-17 19:26:08 +0000140TBuiltInResource Resources;
141std::string ConfigFile;
142
John Kessenicha0af4732012-12-12 21:15:54 +0000143//
John Kessenichf0bcb0a2016-04-02 13:09:14 -0600144// Parse either a .conf file provided by the user or the default from glslang::DefaultTBuiltInResource
John Kessenich05a70632013-09-17 19:26:08 +0000145//
146void ProcessConfigFile()
John Kessenichb51f62c2013-04-11 16:31:09 +0000147{
John Kessenich04acb1b2017-06-14 17:36:50 -0600148 if (ConfigFile.size() == 0)
Lei Zhang414eb602016-03-04 16:22:34 -0500149 Resources = glslang::DefaultTBuiltInResource;
John Kessenich23d27752019-07-28 02:12:10 -0600150#ifndef GLSLANG_WEB
John Kessenich04acb1b2017-06-14 17:36:50 -0600151 else {
152 char* configString = ReadFileData(ConfigFile.c_str());
153 glslang::DecodeResourceLimits(&Resources, configString);
154 FreeFileData(configString);
John Kessenich05a70632013-09-17 19:26:08 +0000155 }
John Kessenich23d27752019-07-28 02:12:10 -0600156#endif
John Kessenicha0af4732012-12-12 21:15:54 +0000157}
158
baldurk6d477852019-01-29 15:45:56 +0000159int ReflectOptions = EShReflectionDefault;
John Kessenich94a81fb2013-08-31 02:41:30 +0000160int Options = 0;
John Kessenich68d78fd2015-07-12 19:28:10 -0600161const char* ExecutableName = nullptr;
162const char* binaryFileName = nullptr;
John Kessenich4d65ee32016-03-12 18:17:47 -0700163const char* entryPointName = nullptr;
steve-lunargf1e0c872016-10-31 15:13:43 -0600164const char* sourceEntryPointName = nullptr;
Dan Bakerc6ede892016-08-11 14:06:06 -0400165const char* shaderStageName = nullptr;
Flavioaea3c892017-02-06 11:46:35 -0800166const char* variableName = nullptr;
Rex Xucb61eec2018-03-07 13:10:01 +0800167bool HlslEnable16BitTypes = false;
John Kessenichbd1c1832018-12-07 18:38:26 -0700168bool HlslDX9compatible = false;
Christoph Kubisch55ba3ea2019-04-13 22:18:16 +0200169bool DumpBuiltinSymbols = false;
John Kessenich971a0a82017-06-07 15:06:58 -0600170std::vector<std::string> IncludeDirectoryList;
John Kessenich8717a5d2018-10-26 10:12:32 -0600171
172// Source environment
173// (source 'Client' is currently the same as target 'Client')
174int ClientInputSemanticsVersion = 100;
175
176// Target environment
177glslang::EShClient Client = glslang::EShClientNone; // will stay EShClientNone if only validating
178glslang::EShTargetClientVersion ClientVersion; // not valid until Client is set
179glslang::EShTargetLanguage TargetLanguage = glslang::EShTargetNone;
180glslang::EShTargetLanguageVersion TargetVersion; // not valid until TargetLanguage is set
181
John Kessenich66011cb2018-03-06 16:12:04 -0700182std::vector<std::string> Processes; // what should be recorded by OpModuleProcessed, or equivalent
John Kessenich68d78fd2015-07-12 19:28:10 -0600183
LoopDawg08a14422017-10-17 19:27:14 -0600184// Per descriptor-set binding base data
185typedef std::map<unsigned int, unsigned int> TPerSetBaseBinding;
186
Neil Roberts16f53472018-03-20 17:30:53 +0100187std::vector<std::pair<std::string, int>> uniformLocationOverrides;
Neil Robertsb0f3d792018-03-20 17:41:05 +0100188int uniformBase = 0;
Neil Roberts16f53472018-03-20 17:30:53 +0100189
LoopDawg08a14422017-10-17 19:27:14 -0600190std::array<std::array<unsigned int, EShLangCount>, glslang::EResCount> baseBinding;
191std::array<std::array<TPerSetBaseBinding, EShLangCount>, glslang::EResCount> baseBindingForSet;
Hyangran Park36dc8292017-05-02 16:27:29 +0900192std::array<std::vector<std::string>, EShLangCount> baseResourceSetBinding;
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600193
John Kessenicha9313662017-06-15 10:40:49 -0600194// Add things like "#define ..." to a preamble to use in the beginning of the shader.
195class TPreamble {
196public:
197 TPreamble() { }
198
199 bool isSet() const { return text.size() > 0; }
200 const char* get() const { return text.c_str(); }
201
202 // #define...
203 void addDef(std::string def)
204 {
205 text.append("#define ");
206 fixLine(def);
207
John Kessenich6f988922020-01-07 07:03:11 -0700208 Processes.push_back("define-macro ");
John Kessenich2a271162017-07-20 20:00:36 -0600209 Processes.back().append(def);
210
John Kessenicha9313662017-06-15 10:40:49 -0600211 // The first "=" needs to turn into a space
LoopDawgb97b25e2017-07-12 09:04:39 -0600212 const size_t equal = def.find_first_of("=");
John Kessenicha9313662017-06-15 10:40:49 -0600213 if (equal != def.npos)
214 def[equal] = ' ';
215
216 text.append(def);
217 text.append("\n");
218 }
219
220 // #undef...
221 void addUndef(std::string undef)
222 {
223 text.append("#undef ");
224 fixLine(undef);
John Kessenich2a271162017-07-20 20:00:36 -0600225
John Kessenich6f988922020-01-07 07:03:11 -0700226 Processes.push_back("undef-macro ");
John Kessenich2a271162017-07-20 20:00:36 -0600227 Processes.back().append(undef);
228
John Kessenicha9313662017-06-15 10:40:49 -0600229 text.append(undef);
230 text.append("\n");
231 }
232
233protected:
234 void fixLine(std::string& line)
235 {
236 // Can't go past a newline in the line
LoopDawgb97b25e2017-07-12 09:04:39 -0600237 const size_t end = line.find_first_of("\n");
John Kessenicha9313662017-06-15 10:40:49 -0600238 if (end != line.npos)
239 line = line.substr(0, end);
240 }
241
242 std::string text; // contents of preamble
243};
244
John Kessenich83855b92020-03-30 00:27:31 -0600245// Track the user's #define and #undef from the command line.
John Kessenicha9313662017-06-15 10:40:49 -0600246TPreamble UserPreamble;
247
John Kessenich68d78fd2015-07-12 19:28:10 -0600248//
249// Create the default name for saving a binary if -o is not provided.
250//
251const char* GetBinaryName(EShLanguage stage)
252{
253 const char* name;
254 if (binaryFileName == nullptr) {
255 switch (stage) {
256 case EShLangVertex: name = "vert.spv"; break;
257 case EShLangTessControl: name = "tesc.spv"; break;
258 case EShLangTessEvaluation: name = "tese.spv"; break;
259 case EShLangGeometry: name = "geom.spv"; break;
260 case EShLangFragment: name = "frag.spv"; break;
261 case EShLangCompute: name = "comp.spv"; break;
Daniel Kochdb32b242020-03-17 20:42:47 -0400262 case EShLangRayGen: name = "rgen.spv"; break;
263 case EShLangIntersect: name = "rint.spv"; break;
264 case EShLangAnyHit: name = "rahit.spv"; break;
265 case EShLangClosestHit: name = "rchit.spv"; break;
266 case EShLangMiss: name = "rmiss.spv"; break;
267 case EShLangCallable: name = "rcall.spv"; break;
Chao Chen3c366992018-09-19 11:41:59 -0700268 case EShLangMeshNV: name = "mesh.spv"; break;
269 case EShLangTaskNV: name = "task.spv"; break;
John Kessenich68d78fd2015-07-12 19:28:10 -0600270 default: name = "unknown"; break;
271 }
272 } else
273 name = binaryFileName;
274
275 return name;
276}
John Kessenich2b07c7e2013-07-31 18:44:13 +0000277
John Kessenich05a70632013-09-17 19:26:08 +0000278//
279// *.conf => this is a config file that can set limits/resources
280//
281bool SetConfigFile(const std::string& name)
282{
283 if (name.size() < 5)
284 return false;
285
John Kessenich4c706852013-10-11 16:28:43 +0000286 if (name.compare(name.size() - 5, 5, ".conf") == 0) {
John Kessenich05a70632013-09-17 19:26:08 +0000287 ConfigFile = name;
288 return true;
289 }
290
291 return false;
292}
293
John Kessenich68d78fd2015-07-12 19:28:10 -0600294//
295// Give error and exit with failure code.
296//
John Kessenichbd97b6f2019-12-20 10:33:13 -0700297void Error(const char* message, const char* detail = nullptr)
John Kessenich68d78fd2015-07-12 19:28:10 -0600298{
John Kessenichbd97b6f2019-12-20 10:33:13 -0700299 fprintf(stderr, "%s: Error: ", ExecutableName);
300 if (detail != nullptr)
301 fprintf(stderr, "%s: ", detail);
302 fprintf(stderr, "%s (use -h for usage)\n", message);
John Kessenich68d78fd2015-07-12 19:28:10 -0600303 exit(EFailUsage);
304}
305
306//
LoopDawg08a14422017-10-17 19:27:14 -0600307// Process an optional binding base of one the forms:
308// --argname [stage] base // base for stage (if given) or all stages (if not)
LoopDawge5709552017-10-21 10:46:39 -0600309// --argname [stage] [base set]... // set/base pairs: set the base for given binding set.
LoopDawg08a14422017-10-17 19:27:14 -0600310
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600311// Where stage is one of the forms accepted by FindLanguage, and base is an integer
312//
LoopDawg08a14422017-10-17 19:27:14 -0600313void ProcessBindingBase(int& argc, char**& argv, glslang::TResourceType res)
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600314{
315 if (argc < 2)
316 usage();
317
LoopDawg08a14422017-10-17 19:27:14 -0600318 EShLanguage lang = EShLangCount;
319 int singleBase = 0;
320 TPerSetBaseBinding perSetBase;
321 int arg = 1;
322
323 // Parse stage, if given
324 if (!isdigit(argv[arg][0])) {
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600325 if (argc < 3) // this form needs one more argument
326 usage();
John Kessenichecba76f2017-01-06 00:34:48 -0700327
LoopDawg08a14422017-10-17 19:27:14 -0600328 lang = FindLanguage(argv[arg++], false);
329 }
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600330
LoopDawg08a14422017-10-17 19:27:14 -0600331 if ((argc - arg) > 2 && isdigit(argv[arg+0][0]) && isdigit(argv[arg+1][0])) {
332 // Parse a per-set binding base
333 while ((argc - arg) > 2 && isdigit(argv[arg+0][0]) && isdigit(argv[arg+1][0])) {
LoopDawg08a14422017-10-17 19:27:14 -0600334 const int baseNum = atoi(argv[arg++]);
LoopDawge5709552017-10-21 10:46:39 -0600335 const int setNum = atoi(argv[arg++]);
LoopDawg08a14422017-10-17 19:27:14 -0600336 perSetBase[setNum] = baseNum;
337 }
338 } else {
339 // Parse single binding base
340 singleBase = atoi(argv[arg++]);
341 }
342
343 argc -= (arg-1);
344 argv += (arg-1);
345
346 // Set one or all languages
347 const int langMin = (lang < EShLangCount) ? lang+0 : 0;
348 const int langMax = (lang < EShLangCount) ? lang+1 : EShLangCount;
349
350 for (int lang = langMin; lang < langMax; ++lang) {
351 if (!perSetBase.empty())
John Kessenich251901a2018-08-12 22:05:59 -0600352 baseBindingForSet[res][lang].insert(perSetBase.begin(), perSetBase.end());
LoopDawg08a14422017-10-17 19:27:14 -0600353 else
354 baseBinding[res][lang] = singleBase;
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600355 }
356}
357
Hyangran Park36dc8292017-05-02 16:27:29 +0900358void ProcessResourceSetBindingBase(int& argc, char**& argv, std::array<std::vector<std::string>, EShLangCount>& base)
359{
360 if (argc < 2)
361 usage();
362
363 if (!isdigit(argv[1][0])) {
LoopDawg52017192017-07-14 15:15:47 -0600364 if (argc < 3) // this form needs one more argument
Hyangran Park36dc8292017-05-02 16:27:29 +0900365 usage();
366
LoopDawg52017192017-07-14 15:15:47 -0600367 // Parse form: --argname stage [regname set base...], or:
368 // --argname stage set
Hyangran Park36dc8292017-05-02 16:27:29 +0900369 const EShLanguage lang = FindLanguage(argv[1], false);
370
LoopDawg52017192017-07-14 15:15:47 -0600371 argc--;
372 argv++;
373
374 while (argc > 1 && argv[1] != nullptr && argv[1][0] != '-') {
375 base[lang].push_back(argv[1]);
376
377 argc--;
378 argv++;
Hyangran Park36dc8292017-05-02 16:27:29 +0900379 }
LoopDawg52017192017-07-14 15:15:47 -0600380
381 // Must have one arg, or a multiple of three (for [regname set binding] triples)
382 if (base[lang].size() != 1 && (base[lang].size() % 3) != 0)
383 usage();
384
Hyangran Park36dc8292017-05-02 16:27:29 +0900385 } else {
LoopDawg52017192017-07-14 15:15:47 -0600386 // Parse form: --argname set
Hyangran Park36dc8292017-05-02 16:27:29 +0900387 for (int lang=0; lang<EShLangCount; ++lang)
388 base[lang].push_back(argv[1]);
389
390 argc--;
391 argv++;
392 }
393}
394
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600395//
John Kessenich68d78fd2015-07-12 19:28:10 -0600396// Do all command-line argument parsing. This includes building up the work-items
397// to be processed later, and saving all the command-line options.
398//
399// Does not return (it exits) if command-line is fatally flawed.
400//
Juan Lopeza558b262017-04-02 23:04:00 +0200401void ProcessArguments(std::vector<std::unique_ptr<glslang::TWorkItem>>& workItems, int argc, char* argv[])
John Kessenich2b07c7e2013-07-31 18:44:13 +0000402{
LoopDawg08a14422017-10-17 19:27:14 -0600403 for (int res = 0; res < glslang::EResCount; ++res)
404 baseBinding[res].fill(0);
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600405
John Kessenich38f3b892013-09-06 19:52:57 +0000406 ExecutableName = argv[0];
Juan Lopeza558b262017-04-02 23:04:00 +0200407 workItems.reserve(argc);
John Kessenich38f3b892013-09-06 19:52:57 +0000408
John Kessenichc178f0a2017-06-23 10:58:31 -0600409 const auto bumpArg = [&]() {
410 if (argc > 0) {
411 argc--;
412 argv++;
413 }
414 };
415
416 // read a string directly attached to a single-letter option
John Kessenich6263fb12017-06-14 15:52:44 -0600417 const auto getStringOperand = [&](const char* desc) {
418 if (argv[0][2] == 0) {
419 printf("%s must immediately follow option (no spaces)\n", desc);
420 exit(EFailUsage);
421 }
422 return argv[0] + 2;
423 };
424
John Kessenich6353d552017-06-23 11:11:09 -0600425 // read a number attached to a single-letter option
426 const auto getAttachedNumber = [&](const char* desc) {
427 int num = atoi(argv[0] + 2);
428 if (num == 0) {
429 printf("%s: expected attached non-0 number\n", desc);
430 exit(EFailUsage);
431 }
432 return num;
433 };
434
435 // minimum needed (without overriding something else) to target Vulkan SPIR-V
436 const auto setVulkanSpv = []() {
John Kessenich8717a5d2018-10-26 10:12:32 -0600437 if (Client == glslang::EShClientNone)
438 ClientVersion = glslang::EShTargetVulkan_1_0;
439 Client = glslang::EShClientVulkan;
John Kessenich6353d552017-06-23 11:11:09 -0600440 Options |= EOptionSpv;
441 Options |= EOptionVulkanRules;
442 Options |= EOptionLinkProgram;
443 };
444
445 // minimum needed (without overriding something else) to target OpenGL SPIR-V
446 const auto setOpenGlSpv = []() {
John Kessenich8717a5d2018-10-26 10:12:32 -0600447 if (Client == glslang::EShClientNone)
448 ClientVersion = glslang::EShTargetOpenGL_450;
449 Client = glslang::EShClientOpenGL;
John Kessenich6353d552017-06-23 11:11:09 -0600450 Options |= EOptionSpv;
451 Options |= EOptionLinkProgram;
452 // undo a -H default to Vulkan
453 Options &= ~EOptionVulkanRules;
454 };
455
Neil Roberts16f53472018-03-20 17:30:53 +0100456 const auto getUniformOverride = [getStringOperand]() {
457 const char *arg = getStringOperand("-u<name>:<location>");
458 const char *split = strchr(arg, ':');
459 if (split == NULL) {
460 printf("%s: missing location\n", arg);
461 exit(EFailUsage);
462 }
463 errno = 0;
464 int location = ::strtol(split + 1, NULL, 10);
465 if (errno) {
466 printf("%s: invalid location\n", arg);
467 exit(EFailUsage);
468 }
469 return std::make_pair(std::string(arg, split - arg), location);
470 };
471
John Kessenichc178f0a2017-06-23 10:58:31 -0600472 for (bumpArg(); argc >= 1; bumpArg()) {
John Kessenich2b07c7e2013-07-31 18:44:13 +0000473 if (argv[0][0] == '-') {
John Kessenich2aa7f3a2015-05-15 16:02:07 +0000474 switch (argv[0][1]) {
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600475 case '-':
476 {
477 std::string lowerword(argv[0]+2);
478 std::transform(lowerword.begin(), lowerword.end(), lowerword.begin(), ::tolower);
479
480 // handle --word style options
John Kessenich6263fb12017-06-14 15:52:44 -0600481 if (lowerword == "auto-map-bindings" || // synonyms
John Kessenich6353d552017-06-23 11:11:09 -0600482 lowerword == "auto-map-binding" ||
483 lowerword == "amb") {
John Kessenich6263fb12017-06-14 15:52:44 -0600484 Options |= EOptionAutoMapBindings;
485 } else if (lowerword == "auto-map-locations" || // synonyms
486 lowerword == "aml") {
487 Options |= EOptionAutoMapLocations;
Neil Robertsb0f3d792018-03-20 17:41:05 +0100488 } else if (lowerword == "uniform-base") {
489 if (argc <= 1)
John Kessenichbd97b6f2019-12-20 10:33:13 -0700490 Error("no <base> provided", lowerword.c_str());
Neil Robertsb0f3d792018-03-20 17:41:05 +0100491 uniformBase = ::strtol(argv[1], NULL, 10);
492 bumpArg();
493 break;
John Kessenich6353d552017-06-23 11:11:09 -0600494 } else if (lowerword == "client") {
495 if (argc > 1) {
496 if (strcmp(argv[1], "vulkan100") == 0)
497 setVulkanSpv();
498 else if (strcmp(argv[1], "opengl100") == 0)
499 setOpenGlSpv();
500 else
John Kessenichbd97b6f2019-12-20 10:33:13 -0700501 Error("expects vulkan100 or opengl100", lowerword.c_str());
502 } else
503 Error("expects vulkan100 or opengl100", lowerword.c_str());
John Kessenich6353d552017-06-23 11:11:09 -0600504 bumpArg();
John Kessenich6f988922020-01-07 07:03:11 -0700505 } else if (lowerword == "define-macro" ||
506 lowerword == "d") {
507 if (argc > 1)
508 UserPreamble.addDef(argv[1]);
509 else
510 Error("expects <name[=def]>", argv[0]);
511 bumpArg();
Christoph Kubisch55ba3ea2019-04-13 22:18:16 +0200512 } else if (lowerword == "dump-builtin-symbols") {
513 DumpBuiltinSymbols = true;
John Kessenich640bd092018-08-09 14:15:00 -0600514 } else if (lowerword == "entry-point") {
515 entryPointName = argv[1];
516 if (argc <= 1)
John Kessenichbd97b6f2019-12-20 10:33:13 -0700517 Error("no <name> provided", lowerword.c_str());
John Kessenich640bd092018-08-09 14:15:00 -0600518 bumpArg();
John Kessenich6263fb12017-06-14 15:52:44 -0600519 } else if (lowerword == "flatten-uniform-arrays" || // synonyms
520 lowerword == "flatten-uniform-array" ||
521 lowerword == "fua") {
522 Options |= EOptionFlattenUniformArrays;
523 } else if (lowerword == "hlsl-offsets") {
524 Options |= EOptionHlslOffsets;
525 } else if (lowerword == "hlsl-iomap" ||
526 lowerword == "hlsl-iomapper" ||
527 lowerword == "hlsl-iomapping") {
528 Options |= EOptionHlslIoMapping;
Rex Xucb61eec2018-03-07 13:10:01 +0800529 } else if (lowerword == "hlsl-enable-16bit-types") {
530 HlslEnable16BitTypes = true;
John Kessenichbd1c1832018-12-07 18:38:26 -0700531 } else if (lowerword == "hlsl-dx9-compatible") {
532 HlslDX9compatible = true;
John Kessenichc6c80a62018-03-05 22:23:17 -0700533 } else if (lowerword == "invert-y" || // synonyms
534 lowerword == "iy") {
535 Options |= EOptionInvertY;
John Kessenich6263fb12017-06-14 15:52:44 -0600536 } else if (lowerword == "keep-uncalled" || // synonyms
537 lowerword == "ku") {
538 Options |= EOptionKeepUncalled;
John Kessenich605afc72019-06-17 23:33:09 -0600539 } else if (lowerword == "nan-clamp") {
540 NaNClamp = true;
John Kessenich6263fb12017-06-14 15:52:44 -0600541 } else if (lowerword == "no-storage-format" || // synonyms
542 lowerword == "nsf") {
543 Options |= EOptionNoStorageFormat;
John Kessenich2a271162017-07-20 20:00:36 -0600544 } else if (lowerword == "relaxed-errors") {
545 Options |= EOptionRelaxedErrors;
baldurk15c37f72019-01-29 12:12:59 +0000546 } else if (lowerword == "reflect-strict-array-suffix") {
547 ReflectOptions |= EShReflectionStrictArraySuffix;
baldurkedf82122019-01-29 15:49:00 +0000548 } else if (lowerword == "reflect-basic-array-suffix") {
549 ReflectOptions |= EShReflectionBasicArraySuffix;
baldurk0af5e3e2019-01-29 16:04:44 +0000550 } else if (lowerword == "reflect-intermediate-io") {
551 ReflectOptions |= EShReflectionIntermediateIO;
baldurk657acc02019-01-30 14:18:43 +0000552 } else if (lowerword == "reflect-separate-buffers") {
553 ReflectOptions |= EShReflectionSeparateBuffers;
baldurka972e732019-01-30 15:34:02 +0000554 } else if (lowerword == "reflect-all-block-variables") {
555 ReflectOptions |= EShReflectionAllBlockVariables;
baldurk19050692019-02-11 11:50:24 +0000556 } else if (lowerword == "reflect-unwrap-io-blocks") {
557 ReflectOptions |= EShReflectionUnwrapIOBlocks;
John Kessenich6263fb12017-06-14 15:52:44 -0600558 } else if (lowerword == "resource-set-bindings" || // synonyms
559 lowerword == "resource-set-binding" ||
560 lowerword == "rsb") {
561 ProcessResourceSetBindingBase(argc, argv, baseResourceSetBinding);
steve-lunarg9088be42016-11-01 10:31:42 -0600562 } else if (lowerword == "shift-image-bindings" || // synonyms
563 lowerword == "shift-image-binding" ||
564 lowerword == "sib") {
LoopDawg08a14422017-10-17 19:27:14 -0600565 ProcessBindingBase(argc, argv, glslang::EResImage);
John Kessenich6263fb12017-06-14 15:52:44 -0600566 } else if (lowerword == "shift-sampler-bindings" || // synonyms
John Kessenichade8bbb2018-08-12 21:24:55 -0600567 lowerword == "shift-sampler-binding" ||
568 lowerword == "ssb") {
LoopDawg08a14422017-10-17 19:27:14 -0600569 ProcessBindingBase(argc, argv, glslang::EResSampler);
John Kessenich6263fb12017-06-14 15:52:44 -0600570 } else if (lowerword == "shift-uav-bindings" || // synonyms
571 lowerword == "shift-uav-binding" ||
572 lowerword == "suavb") {
LoopDawg08a14422017-10-17 19:27:14 -0600573 ProcessBindingBase(argc, argv, glslang::EResUav);
John Kessenich6263fb12017-06-14 15:52:44 -0600574 } else if (lowerword == "shift-texture-bindings" || // synonyms
575 lowerword == "shift-texture-binding" ||
576 lowerword == "stb") {
LoopDawg08a14422017-10-17 19:27:14 -0600577 ProcessBindingBase(argc, argv, glslang::EResTexture);
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600578 } else if (lowerword == "shift-ubo-bindings" || // synonyms
579 lowerword == "shift-ubo-binding" ||
steve-lunargbe283552017-04-18 12:18:01 -0600580 lowerword == "shift-cbuffer-bindings" ||
581 lowerword == "shift-cbuffer-binding" ||
582 lowerword == "sub" ||
583 lowerword == "scb") {
LoopDawg08a14422017-10-17 19:27:14 -0600584 ProcessBindingBase(argc, argv, glslang::EResUbo);
steve-lunarg932bb5c2017-02-21 17:19:08 -0700585 } else if (lowerword == "shift-ssbo-bindings" || // synonyms
586 lowerword == "shift-ssbo-binding" ||
587 lowerword == "sbb") {
LoopDawg08a14422017-10-17 19:27:14 -0600588 ProcessBindingBase(argc, argv, glslang::EResSsbo);
John Kessenich6263fb12017-06-14 15:52:44 -0600589 } else if (lowerword == "source-entrypoint" || // synonyms
590 lowerword == "sep") {
John Kessenichc178f0a2017-06-23 10:58:31 -0600591 if (argc <= 1)
John Kessenichbd97b6f2019-12-20 10:33:13 -0700592 Error("no <entry-point> provided", lowerword.c_str());
John Kessenichc178f0a2017-06-23 10:58:31 -0600593 sourceEntryPointName = argv[1];
594 bumpArg();
John Kessenich6263fb12017-06-14 15:52:44 -0600595 break;
John Kesseniche2156222018-06-11 18:12:15 -0600596 } else if (lowerword == "spirv-dis") {
597 SpvToolsDisassembler = true;
John Kessenichc3404252018-08-23 15:29:08 -0600598 } else if (lowerword == "spirv-val") {
599 SpvToolsValidate = true;
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +0200600 } else if (lowerword == "stdin") {
601 Options |= EOptionStdin;
602 shaderStageName = argv[1];
John Kessenich2a271162017-07-20 20:00:36 -0600603 } else if (lowerword == "suppress-warnings") {
604 Options |= EOptionSuppressWarnings;
John Kessenich6353d552017-06-23 11:11:09 -0600605 } else if (lowerword == "target-env") {
606 if (argc > 1) {
607 if (strcmp(argv[1], "vulkan1.0") == 0) {
608 setVulkanSpv();
John Kessenich8717a5d2018-10-26 10:12:32 -0600609 ClientVersion = glslang::EShTargetVulkan_1_0;
John Kessenich66011cb2018-03-06 16:12:04 -0700610 } else if (strcmp(argv[1], "vulkan1.1") == 0) {
611 setVulkanSpv();
John Kessenich8717a5d2018-10-26 10:12:32 -0600612 ClientVersion = glslang::EShTargetVulkan_1_1;
John Kessenich273d3a52020-01-15 00:10:41 -0700613 } else if (strcmp(argv[1], "vulkan1.2") == 0) {
614 setVulkanSpv();
615 ClientVersion = glslang::EShTargetVulkan_1_2;
John Kessenich6353d552017-06-23 11:11:09 -0600616 } else if (strcmp(argv[1], "opengl") == 0) {
617 setOpenGlSpv();
John Kessenich8717a5d2018-10-26 10:12:32 -0600618 ClientVersion = glslang::EShTargetOpenGL_450;
619 } else if (strcmp(argv[1], "spirv1.0") == 0) {
620 TargetLanguage = glslang::EShTargetSpv;
621 TargetVersion = glslang::EShTargetSpv_1_0;
622 } else if (strcmp(argv[1], "spirv1.1") == 0) {
623 TargetLanguage = glslang::EShTargetSpv;
624 TargetVersion = glslang::EShTargetSpv_1_1;
625 } else if (strcmp(argv[1], "spirv1.2") == 0) {
626 TargetLanguage = glslang::EShTargetSpv;
627 TargetVersion = glslang::EShTargetSpv_1_2;
628 } else if (strcmp(argv[1], "spirv1.3") == 0) {
629 TargetLanguage = glslang::EShTargetSpv;
630 TargetVersion = glslang::EShTargetSpv_1_3;
631 } else if (strcmp(argv[1], "spirv1.4") == 0) {
632 TargetLanguage = glslang::EShTargetSpv;
633 TargetVersion = glslang::EShTargetSpv_1_4;
John Kessenich8317e6c2019-08-18 23:58:08 -0600634 } else if (strcmp(argv[1], "spirv1.5") == 0) {
635 TargetLanguage = glslang::EShTargetSpv;
636 TargetVersion = glslang::EShTargetSpv_1_5;
John Kessenich6353d552017-06-23 11:11:09 -0600637 } else
John Kessenich273d3a52020-01-15 00:10:41 -0700638 Error("--target-env expected one of: vulkan1.0, vulkan1.1, vulkan1.2, opengl,\n"
John Kessenich8317e6c2019-08-18 23:58:08 -0600639 "spirv1.0, spirv1.1, spirv1.2, spirv1.3, spirv1.4, or spirv1.5");
John Kessenich6353d552017-06-23 11:11:09 -0600640 }
641 bumpArg();
John Kessenich6f988922020-01-07 07:03:11 -0700642 } else if (lowerword == "undef-macro" ||
643 lowerword == "u") {
644 if (argc > 1)
645 UserPreamble.addUndef(argv[1]);
646 else
647 Error("expects <name>", argv[0]);
648 bumpArg();
Flavio15017db2017-02-15 14:29:33 -0800649 } else if (lowerword == "variable-name" || // synonyms
John Kessenich66011cb2018-03-06 16:12:04 -0700650 lowerword == "vn") {
Flavio15017db2017-02-15 14:29:33 -0800651 Options |= EOptionOutputHexadecimal;
John Kessenichc178f0a2017-06-23 10:58:31 -0600652 if (argc <= 1)
John Kessenichbd97b6f2019-12-20 10:33:13 -0700653 Error("no <C-variable-name> provided", lowerword.c_str());
John Kessenichc178f0a2017-06-23 10:58:31 -0600654 variableName = argv[1];
655 bumpArg();
Flavio15017db2017-02-15 14:29:33 -0800656 break;
John Kessenichc6c80a62018-03-05 22:23:17 -0700657 } else if (lowerword == "version") {
658 Options |= EOptionDumpVersions;
Jordan Justen6ad120e2020-01-28 12:18:12 -0800659 } else if (lowerword == "help") {
660 usage();
661 break;
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600662 } else {
John Kessenichbd97b6f2019-12-20 10:33:13 -0700663 Error("unrecognized command-line option", argv[0]);
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600664 }
665 }
666 break;
John Kessenich6263fb12017-06-14 15:52:44 -0600667 case 'C':
668 Options |= EOptionCascadingErrors;
669 break;
670 case 'D':
John Kessenicha9313662017-06-15 10:40:49 -0600671 if (argv[0][2] == 0)
672 Options |= EOptionReadHlsl;
673 else
John Kessenich6f988922020-01-07 07:03:11 -0700674 UserPreamble.addDef(getStringOperand("-D<name[=def]>"));
John Kessenich6263fb12017-06-14 15:52:44 -0600675 break;
Neil Roberts16f53472018-03-20 17:30:53 +0100676 case 'u':
677 uniformLocationOverrides.push_back(getUniformOverride());
678 break;
John Kessenich6263fb12017-06-14 15:52:44 -0600679 case 'E':
680 Options |= EOptionOutputPreprocessed;
681 break;
682 case 'G':
John Kessenich8717a5d2018-10-26 10:12:32 -0600683 // OpenGL client
John Kessenich6353d552017-06-23 11:11:09 -0600684 setOpenGlSpv();
685 if (argv[0][2] != 0)
686 ClientInputSemanticsVersion = getAttachedNumber("-G<num> client input semantics");
John Kessenich6263fb12017-06-14 15:52:44 -0600687 break;
John Kessenich2aa7f3a2015-05-15 16:02:07 +0000688 case 'H':
689 Options |= EOptionHumanReadableSpv;
John Kessenich91e4aa52016-07-07 17:46:42 -0600690 if ((Options & EOptionSpv) == 0) {
691 // default to Vulkan
John Kessenich6353d552017-06-23 11:11:09 -0600692 setVulkanSpv();
John Kessenich91e4aa52016-07-07 17:46:42 -0600693 }
694 break;
John Kessenich971a0a82017-06-07 15:06:58 -0600695 case 'I':
John Kessenicha9313662017-06-15 10:40:49 -0600696 IncludeDirectoryList.push_back(getStringOperand("-I<dir> include path"));
John Kessenich68d78fd2015-07-12 19:28:10 -0600697 break;
GregFcd1f1692017-09-21 18:40:22 -0600698 case 'O':
699 if (argv[0][2] == 'd')
700 Options |= EOptionOptimizeDisable;
701 else if (argv[0][2] == 's')
GregFfb03a552018-03-29 11:49:14 -0600702#if ENABLE_OPT
GregFcd1f1692017-09-21 18:40:22 -0600703 Options |= EOptionOptimizeSize;
704#else
705 Error("-Os not available; optimizer not linked");
706#endif
707 else
708 Error("unknown -O option");
709 break;
Dan Baker5afdd782016-08-11 17:53:57 -0400710 case 'S':
John Kessenichc178f0a2017-06-23 10:58:31 -0600711 if (argc <= 1)
Dan Baker5afdd782016-08-11 17:53:57 -0400712 Error("no <stage> specified for -S");
John Kessenichc178f0a2017-06-23 10:58:31 -0600713 shaderStageName = argv[1];
714 bumpArg();
dankbaker45d49bc2016-08-08 21:43:07 -0400715 break;
John Kessenicha9313662017-06-15 10:40:49 -0600716 case 'U':
John Kessenich6f988922020-01-07 07:03:11 -0700717 UserPreamble.addUndef(getStringOperand("-U<name>"));
John Kessenicha9313662017-06-15 10:40:49 -0600718 break;
John Kessenich6263fb12017-06-14 15:52:44 -0600719 case 'V':
John Kessenich6353d552017-06-23 11:11:09 -0600720 setVulkanSpv();
721 if (argv[0][2] != 0)
David Neto506d2c22018-02-27 21:55:23 -0500722 ClientInputSemanticsVersion = getAttachedNumber("-V<num> client input semantics");
John Kessenichc555ddd2015-06-17 02:38:44 +0000723 break;
John Kessenich05a70632013-09-17 19:26:08 +0000724 case 'c':
725 Options |= EOptionDumpConfig;
726 break;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000727 case 'd':
John Kessenichc6c80a62018-03-05 22:23:17 -0700728 if (strncmp(&argv[0][1], "dumpversion", strlen(&argv[0][1]) + 1) == 0 ||
729 strncmp(&argv[0][1], "dumpfullversion", strlen(&argv[0][1]) + 1) == 0)
730 Options |= EOptionDumpBareVersion;
731 else
732 Options |= EOptionDefaultDesktop;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000733 break;
John Kessenich4d65ee32016-03-12 18:17:47 -0700734 case 'e':
John Kessenich4d65ee32016-03-12 18:17:47 -0700735 entryPointName = argv[1];
John Kessenichc178f0a2017-06-23 10:58:31 -0600736 if (argc <= 1)
John Kessenicha25530c2017-09-11 20:13:49 -0600737 Error("no <name> provided for -e");
John Kessenichc178f0a2017-06-23 10:58:31 -0600738 bumpArg();
John Kessenich4d65ee32016-03-12 18:17:47 -0700739 break;
John Kessenich5d610ee2018-03-07 18:05:55 -0700740 case 'f':
741 if (strcmp(&argv[0][2], "hlsl_functionality1") == 0)
742 targetHlslFunctionality1 = true;
743 else
744 Error("-f: expected hlsl_functionality1");
745 break;
John Kessenich121853f2017-05-31 17:11:16 -0600746 case 'g':
747 Options |= EOptionDebug;
748 break;
John Kessenich68d78fd2015-07-12 19:28:10 -0600749 case 'h':
750 usage();
751 break;
John Kessenich05a70632013-09-17 19:26:08 +0000752 case 'i':
John Kessenich94a81fb2013-08-31 02:41:30 +0000753 Options |= EOptionIntermediate;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000754 break;
755 case 'l':
John Kessenichd78e3512014-08-25 20:07:55 +0000756 Options |= EOptionLinkProgram;
John Kessenich94a81fb2013-08-31 02:41:30 +0000757 break;
758 case 'm':
759 Options |= EOptionMemoryLeakMode;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000760 break;
John Kessenich68d78fd2015-07-12 19:28:10 -0600761 case 'o':
John Kessenichc178f0a2017-06-23 10:58:31 -0600762 if (argc <= 1)
John Kessenich68d78fd2015-07-12 19:28:10 -0600763 Error("no <file> provided for -o");
John Kessenichc178f0a2017-06-23 10:58:31 -0600764 binaryFileName = argv[1];
765 bumpArg();
John Kessenich68d78fd2015-07-12 19:28:10 -0600766 break;
John Kessenich11f9fc72013-11-07 01:06:34 +0000767 case 'q':
768 Options |= EOptionDumpReflection;
769 break;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000770 case 'r':
John Kessenich94a81fb2013-08-31 02:41:30 +0000771 Options |= EOptionRelaxedErrors;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000772 break;
773 case 's':
John Kessenich94a81fb2013-08-31 02:41:30 +0000774 Options |= EOptionSuppressInfolog;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000775 break;
John Kessenich38f3b892013-09-06 19:52:57 +0000776 case 't':
Juan Lopeza558b262017-04-02 23:04:00 +0200777 Options |= EOptionMultiThreaded;
John Kessenich38f3b892013-09-06 19:52:57 +0000778 break;
John Kessenich319de232013-12-04 04:43:40 +0000779 case 'v':
780 Options |= EOptionDumpVersions;
781 break;
John Kessenichb0a7eb52013-11-07 17:44:20 +0000782 case 'w':
783 Options |= EOptionSuppressWarnings;
784 break;
Johannes van Waverenecb0f3b2016-05-27 12:55:53 -0500785 case 'x':
786 Options |= EOptionOutputHexadecimal;
Johannes van Waverenecb0f3b2016-05-27 12:55:53 -0500787 break;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000788 default:
John Kessenichbd97b6f2019-12-20 10:33:13 -0700789 Error("unrecognized command-line option", argv[0]);
John Kessenich68d78fd2015-07-12 19:28:10 -0600790 break;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000791 }
John Kessenich38f3b892013-09-06 19:52:57 +0000792 } else {
John Kessenich05a70632013-09-17 19:26:08 +0000793 std::string name(argv[0]);
794 if (! SetConfigFile(name)) {
Juan Lopeza558b262017-04-02 23:04:00 +0200795 workItems.push_back(std::unique_ptr<glslang::TWorkItem>(new glslang::TWorkItem(name)));
John Kessenich05a70632013-09-17 19:26:08 +0000796 }
John Kessenich38f3b892013-09-06 19:52:57 +0000797 }
John Kessenich2b07c7e2013-07-31 18:44:13 +0000798 }
799
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +0200800 // Make sure that -S is always specified if --stdin is specified
801 if ((Options & EOptionStdin) && shaderStageName == nullptr)
802 Error("must provide -S when --stdin is given");
803
John Kessenich68d78fd2015-07-12 19:28:10 -0600804 // Make sure that -E is not specified alongside linking (which includes SPV generation)
John Kesseniche5c394b2019-07-02 09:32:48 -0600805 // Or things that require linking
806 if (Options & EOptionOutputPreprocessed) {
807 if (Options & EOptionLinkProgram)
808 Error("can't use -E when linking is selected");
809 if (Options & EOptionDumpReflection)
810 Error("reflection requires linking, which can't be used when -E when is selected");
811 }
812
813 // reflection requires linking
814 if ((Options & EOptionDumpReflection) && !(Options & EOptionLinkProgram))
815 Error("reflection requires -l for linking");
John Kessenichc555ddd2015-06-17 02:38:44 +0000816
Johannes van Waverenecb0f3b2016-05-27 12:55:53 -0500817 // -o or -x makes no sense if there is no target binary
John Kessenich68d78fd2015-07-12 19:28:10 -0600818 if (binaryFileName && (Options & EOptionSpv) == 0)
819 Error("no binary generation requested (e.g., -V)");
steve-lunarge0b9deb2016-09-16 13:26:37 -0600820
821 if ((Options & EOptionFlattenUniformArrays) != 0 &&
822 (Options & EOptionReadHlsl) == 0)
823 Error("uniform array flattening only valid when compiling HLSL source.");
John Kessenich8717a5d2018-10-26 10:12:32 -0600824
825 // rationalize client and target language
826 if (TargetLanguage == glslang::EShTargetNone) {
827 switch (ClientVersion) {
828 case glslang::EShTargetVulkan_1_0:
829 TargetLanguage = glslang::EShTargetSpv;
830 TargetVersion = glslang::EShTargetSpv_1_0;
831 break;
832 case glslang::EShTargetVulkan_1_1:
833 TargetLanguage = glslang::EShTargetSpv;
834 TargetVersion = glslang::EShTargetSpv_1_3;
835 break;
John Kessenich273d3a52020-01-15 00:10:41 -0700836 case glslang::EShTargetVulkan_1_2:
837 TargetLanguage = glslang::EShTargetSpv;
838 TargetVersion = glslang::EShTargetSpv_1_5;
839 break;
John Kessenich8717a5d2018-10-26 10:12:32 -0600840 case glslang::EShTargetOpenGL_450:
841 TargetLanguage = glslang::EShTargetSpv;
842 TargetVersion = glslang::EShTargetSpv_1_0;
843 break;
844 default:
845 break;
846 }
847 }
848 if (TargetLanguage != glslang::EShTargetNone && Client == glslang::EShClientNone)
849 Error("To generate SPIR-V, also specify client semantics. See -G and -V.");
John Kessenich2b07c7e2013-07-31 18:44:13 +0000850}
851
John Kessenich68d78fd2015-07-12 19:28:10 -0600852//
853// Translate the meaningful subset of command-line options to parser-behavior options.
854//
John Kessenichb0a7eb52013-11-07 17:44:20 +0000855void SetMessageOptions(EShMessages& messages)
856{
857 if (Options & EOptionRelaxedErrors)
858 messages = (EShMessages)(messages | EShMsgRelaxedErrors);
859 if (Options & EOptionIntermediate)
860 messages = (EShMessages)(messages | EShMsgAST);
861 if (Options & EOptionSuppressWarnings)
862 messages = (EShMessages)(messages | EShMsgSuppressWarnings);
John Kessenich68d78fd2015-07-12 19:28:10 -0600863 if (Options & EOptionSpv)
864 messages = (EShMessages)(messages | EShMsgSpvRules);
865 if (Options & EOptionVulkanRules)
866 messages = (EShMessages)(messages | EShMsgVulkanRules);
Andrew Woloszynaae1ad82015-06-24 17:00:46 -0400867 if (Options & EOptionOutputPreprocessed)
868 messages = (EShMessages)(messages | EShMsgOnlyPreprocessor);
John Kessenich66e2faf2016-03-12 18:34:36 -0700869 if (Options & EOptionReadHlsl)
870 messages = (EShMessages)(messages | EShMsgReadHlsl);
John Kessenicha86836e2016-07-09 14:50:57 -0600871 if (Options & EOptionCascadingErrors)
872 messages = (EShMessages)(messages | EShMsgCascadingErrors);
John Kessenich906cc212016-12-09 19:22:20 -0700873 if (Options & EOptionKeepUncalled)
874 messages = (EShMessages)(messages | EShMsgKeepUncalled);
John Kessenich4f1403e2017-04-05 17:38:20 -0600875 if (Options & EOptionHlslOffsets)
876 messages = (EShMessages)(messages | EShMsgHlslOffsets);
John Kessenich121853f2017-05-31 17:11:16 -0600877 if (Options & EOptionDebug)
878 messages = (EShMessages)(messages | EShMsgDebugInfo);
Rex Xucb61eec2018-03-07 13:10:01 +0800879 if (HlslEnable16BitTypes)
880 messages = (EShMessages)(messages | EShMsgHlslEnable16BitTypes);
GregFfb03a552018-03-29 11:49:14 -0600881 if ((Options & EOptionOptimizeDisable) || !ENABLE_OPT)
882 messages = (EShMessages)(messages | EShMsgHlslLegalization);
John Kessenichbd1c1832018-12-07 18:38:26 -0700883 if (HlslDX9compatible)
884 messages = (EShMessages)(messages | EShMsgHlslDX9Compatible);
Christoph Kubisch55ba3ea2019-04-13 22:18:16 +0200885 if (DumpBuiltinSymbols)
886 messages = (EShMessages)(messages | EShMsgBuiltinSymbolTable);
John Kessenichb0a7eb52013-11-07 17:44:20 +0000887}
888
John Kessenich68d78fd2015-07-12 19:28:10 -0600889//
John Kessenich69f4b512013-09-04 21:19:27 +0000890// Thread entry point, for non-linking asynchronous mode.
John Kessenichc999ba22013-11-07 23:33:24 +0000891//
Juan Lopeza558b262017-04-02 23:04:00 +0200892void CompileShaders(glslang::TWorklist& worklist)
John Kessenich2b07c7e2013-07-31 18:44:13 +0000893{
John Kessenich7f0bcfd2018-04-05 19:00:01 -0600894 if (Options & EOptionDebug)
895 Error("cannot generate debug information unless linking to generate code");
896
John Kessenich38f3b892013-09-06 19:52:57 +0000897 glslang::TWorkItem* workItem;
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +0200898 if (Options & EOptionStdin) {
John Kesseniche7f9cae2018-07-12 15:11:07 -0600899 if (worklist.remove(workItem)) {
900 ShHandle compiler = ShConstructCompiler(FindLanguage("stdin"), Options);
901 if (compiler == nullptr)
902 return;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000903
John Kesseniche7f9cae2018-07-12 15:11:07 -0600904 CompileFile("stdin", compiler);
John Kessenich2b07c7e2013-07-31 18:44:13 +0000905
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +0200906 if (! (Options & EOptionSuppressInfolog))
907 workItem->results = ShGetInfoLog(compiler);
John Kessenich2b07c7e2013-07-31 18:44:13 +0000908
John Kesseniche7f9cae2018-07-12 15:11:07 -0600909 ShDestruct(compiler);
910 }
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +0200911 } else {
912 while (worklist.remove(workItem)) {
913 ShHandle compiler = ShConstructCompiler(FindLanguage(workItem->name), Options);
914 if (compiler == 0)
915 return;
916
917 CompileFile(workItem->name.c_str(), compiler);
918
919 if (! (Options & EOptionSuppressInfolog))
920 workItem->results = ShGetInfoLog(compiler);
921
922 ShDestruct(compiler);
923 }
John Kessenich2b07c7e2013-07-31 18:44:13 +0000924 }
John Kessenich2b07c7e2013-07-31 18:44:13 +0000925}
926
John Kessenich6626cad2015-06-19 05:14:19 +0000927// Outputs the given string, but only if it is non-null and non-empty.
928// This prevents erroneous newlines from appearing.
Andrew Woloszynaae1ad82015-06-24 17:00:46 -0400929void PutsIfNonEmpty(const char* str)
John Kessenich6626cad2015-06-19 05:14:19 +0000930{
931 if (str && str[0]) {
932 puts(str);
933 }
934}
935
Andrew Woloszynaae1ad82015-06-24 17:00:46 -0400936// Outputs the given string to stderr, but only if it is non-null and non-empty.
937// This prevents erroneous newlines from appearing.
938void StderrIfNonEmpty(const char* str)
939{
John Kessenich04acb1b2017-06-14 17:36:50 -0600940 if (str && str[0])
941 fprintf(stderr, "%s\n", str);
Andrew Woloszynaae1ad82015-06-24 17:00:46 -0400942}
943
John Kessenichc57b2a92016-01-16 15:30:03 -0700944// Simple bundling of what makes a compilation unit for ease in passing around,
945// and separation of handling file IO versus API (programmatic) compilation.
946struct ShaderCompUnit {
947 EShLanguage stage;
John Kessenich04acb1b2017-06-14 17:36:50 -0600948 static const int maxCount = 1;
949 int count; // live number of strings/names
John Kessenicha9313662017-06-15 10:40:49 -0600950 const char* text[maxCount]; // memory owned/managed externally
John Kessenich04acb1b2017-06-14 17:36:50 -0600951 std::string fileName[maxCount]; // hold's the memory, but...
952 const char* fileNameList[maxCount]; // downstream interface wants pointers
dankbakerafe6e9c2016-08-21 12:29:08 -0400953
John Kessenich04acb1b2017-06-14 17:36:50 -0600954 ShaderCompUnit(EShLanguage stage) : stage(stage), count(0) { }
dankbakerafe6e9c2016-08-21 12:29:08 -0400955
John Kessenich04acb1b2017-06-14 17:36:50 -0600956 ShaderCompUnit(const ShaderCompUnit& rhs)
dankbakerafe6e9c2016-08-21 12:29:08 -0400957 {
958 stage = rhs.stage;
John Kessenich04acb1b2017-06-14 17:36:50 -0600959 count = rhs.count;
960 for (int i = 0; i < count; ++i) {
961 fileName[i] = rhs.fileName[i];
962 text[i] = rhs.text[i];
963 fileNameList[i] = rhs.fileName[i].c_str();
964 }
dankbakerafe6e9c2016-08-21 12:29:08 -0400965 }
966
John Kessenicha9313662017-06-15 10:40:49 -0600967 void addString(std::string& ifileName, const char* itext)
John Kessenich04acb1b2017-06-14 17:36:50 -0600968 {
969 assert(count < maxCount);
970 fileName[count] = ifileName;
971 text[count] = itext;
972 fileNameList[count] = fileName[count].c_str();
973 ++count;
974 }
John Kessenichc57b2a92016-01-16 15:30:03 -0700975};
976
John Kessenich69f4b512013-09-04 21:19:27 +0000977//
John Kessenichc57b2a92016-01-16 15:30:03 -0700978// For linking mode: Will independently parse each compilation unit, but then put them
979// in the same program and link them together, making at most one linked module per
980// pipeline stage.
John Kessenich69f4b512013-09-04 21:19:27 +0000981//
982// Uses the new C++ interface instead of the old handle-based interface.
983//
John Kessenichc57b2a92016-01-16 15:30:03 -0700984
985void CompileAndLinkShaderUnits(std::vector<ShaderCompUnit> compUnits)
John Kessenich69f4b512013-09-04 21:19:27 +0000986{
987 // keep track of what to free
988 std::list<glslang::TShader*> shaders;
John Kessenichc57b2a92016-01-16 15:30:03 -0700989
John Kessenich69f4b512013-09-04 21:19:27 +0000990 EShMessages messages = EShMsgDefault;
John Kessenichb0a7eb52013-11-07 17:44:20 +0000991 SetMessageOptions(messages);
John Kessenich69f4b512013-09-04 21:19:27 +0000992
John Kessenich69f4b512013-09-04 21:19:27 +0000993 //
994 // Per-shader processing...
995 //
996
John Kessenich5b0f13a2013-11-01 03:08:40 +0000997 glslang::TProgram& program = *new glslang::TProgram;
rdb32084e82016-02-23 22:17:38 +0100998 for (auto it = compUnits.cbegin(); it != compUnits.cend(); ++it) {
999 const auto &compUnit = *it;
John Kessenichc57b2a92016-01-16 15:30:03 -07001000 glslang::TShader* shader = new glslang::TShader(compUnit.stage);
John Kessenich04acb1b2017-06-14 17:36:50 -06001001 shader->setStringsWithLengthsAndNames(compUnit.text, NULL, compUnit.fileNameList, compUnit.count);
John Kessenich640bd092018-08-09 14:15:00 -06001002 if (entryPointName)
John Kessenich4d65ee32016-03-12 18:17:47 -07001003 shader->setEntryPoint(entryPointName);
John Kessenich3693e632017-09-29 17:51:52 -06001004 if (sourceEntryPointName) {
1005 if (entryPointName == nullptr)
1006 printf("Warning: Changing source entry point name without setting an entry-point name.\n"
1007 "Use '-e <name>'.\n");
steve-lunargf1e0c872016-10-31 15:13:43 -06001008 shader->setSourceEntryPoint(sourceEntryPointName);
John Kessenich3693e632017-09-29 17:51:52 -06001009 }
John Kessenicha9313662017-06-15 10:40:49 -06001010 if (UserPreamble.isSet())
1011 shader->setPreamble(UserPreamble.get());
John Kessenich2a271162017-07-20 20:00:36 -06001012 shader->addProcesses(Processes);
steve-lunarg7f7c2ed2016-09-07 15:20:19 -06001013
John Kessenich155d3512019-08-08 23:29:20 -06001014#ifndef GLSLANG_WEB
LoopDawg08a14422017-10-17 19:27:14 -06001015 // Set IO mapper binding shift values
1016 for (int r = 0; r < glslang::EResCount; ++r) {
1017 const glslang::TResourceType res = glslang::TResourceType(r);
1018
1019 // Set base bindings
1020 shader->setShiftBinding(res, baseBinding[res][compUnit.stage]);
David Neto8c3d5b42019-10-21 14:50:31 -04001021
LoopDawg08a14422017-10-17 19:27:14 -06001022 // Set bindings for particular resource sets
1023 // TODO: use a range based for loop here, when available in all environments.
1024 for (auto i = baseBindingForSet[res][compUnit.stage].begin();
1025 i != baseBindingForSet[res][compUnit.stage].end(); ++i)
LoopDawge5709552017-10-21 10:46:39 -06001026 shader->setShiftBindingForSet(res, i->second, i->first);
LoopDawg08a14422017-10-17 19:27:14 -06001027 }
steve-lunargcce8d482016-10-14 18:36:42 -06001028 shader->setNoStorageFormat((Options & EOptionNoStorageFormat) != 0);
Hyangran Park36dc8292017-05-02 16:27:29 +09001029 shader->setResourceSetBinding(baseResourceSetBinding[compUnit.stage]);
steve-lunarg7f7c2ed2016-09-07 15:20:19 -06001030
1031 if (Options & EOptionAutoMapBindings)
1032 shader->setAutoMapBindings(true);
John Kessenichecba76f2017-01-06 00:34:48 -07001033
John Kessenich71facdf2017-05-17 18:28:19 -06001034 if (Options & EOptionAutoMapLocations)
1035 shader->setAutoMapLocations(true);
1036
Neil Roberts16f53472018-03-20 17:30:53 +01001037 for (auto& uniOverride : uniformLocationOverrides) {
1038 shader->addUniformLocationOverride(uniOverride.first.c_str(),
1039 uniOverride.second);
1040 }
1041
Neil Robertsb0f3d792018-03-20 17:41:05 +01001042 shader->setUniformLocationBase(uniformBase);
John Kessenich155d3512019-08-08 23:29:20 -06001043#endif
1044
1045 shader->setNanMinMaxClamp(NaNClamp);
1046
1047#ifdef ENABLE_HLSL
1048 shader->setFlattenUniformArrays((Options & EOptionFlattenUniformArrays) != 0);
1049 if (Options & EOptionHlslIoMapping)
1050 shader->setHlslIoMapping(true);
1051#endif
1052
1053 if (Options & EOptionInvertY)
1054 shader->setInvertY(true);
Neil Robertsb0f3d792018-03-20 17:41:05 +01001055
John Kessenich4be4aeb2017-06-23 10:50:22 -06001056 // Set up the environment, some subsettings take precedence over earlier
1057 // ways of setting things.
1058 if (Options & EOptionSpv) {
John Kessenich8717a5d2018-10-26 10:12:32 -06001059 shader->setEnvInput((Options & EOptionReadHlsl) ? glslang::EShSourceHlsl
1060 : glslang::EShSourceGlsl,
1061 compUnit.stage, Client, ClientInputSemanticsVersion);
1062 shader->setEnvClient(Client, ClientVersion);
1063 shader->setEnvTarget(TargetLanguage, TargetVersion);
John Kessenichd4ed5152019-07-27 05:22:30 -06001064#ifdef ENABLE_HLSL
John Kessenich5d610ee2018-03-07 18:05:55 -07001065 if (targetHlslFunctionality1)
1066 shader->setEnvTargetHlslFunctionality1();
John Kessenichd4ed5152019-07-27 05:22:30 -06001067#endif
John Kessenich4be4aeb2017-06-23 10:50:22 -06001068 }
1069
John Kessenich69f4b512013-09-04 21:19:27 +00001070 shaders.push_back(shader);
John Kessenichb3297152015-07-11 18:01:03 -06001071
John Kessenich4be4aeb2017-06-23 10:50:22 -06001072 const int defaultVersion = Options & EOptionDefaultDesktop ? 110 : 100;
John Kessenich69f4b512013-09-04 21:19:27 +00001073
John Kessenich3494b4d2017-05-22 15:00:42 -06001074 DirStackFileIncluder includer;
John Kessenich971a0a82017-06-07 15:06:58 -06001075 std::for_each(IncludeDirectoryList.rbegin(), IncludeDirectoryList.rend(), [&includer](const std::string& dir) {
1076 includer.pushExternalLocalDirectory(dir); });
John Kessenichdeec1932019-08-13 08:00:30 -06001077#ifndef GLSLANG_WEB
John Kessenichc555ddd2015-06-17 02:38:44 +00001078 if (Options & EOptionOutputPreprocessed) {
1079 std::string str;
John Kessenich086febc2018-10-25 12:43:02 -06001080 if (shader->preprocess(&Resources, defaultVersion, ENoProfile, false, false, messages, &str, includer)) {
Andrew Woloszynaae1ad82015-06-24 17:00:46 -04001081 PutsIfNonEmpty(str.c_str());
1082 } else {
1083 CompileFailed = true;
1084 }
1085 StderrIfNonEmpty(shader->getInfoLog());
1086 StderrIfNonEmpty(shader->getInfoDebugLog());
John Kessenichc555ddd2015-06-17 02:38:44 +00001087 continue;
1088 }
John Kessenichdeec1932019-08-13 08:00:30 -06001089#endif
John Kessenich086febc2018-10-25 12:43:02 -06001090
John Kessenich3494b4d2017-05-22 15:00:42 -06001091 if (! shader->parse(&Resources, defaultVersion, false, messages, includer))
John Kessenichc999ba22013-11-07 23:33:24 +00001092 CompileFailed = true;
John Kessenichc555ddd2015-06-17 02:38:44 +00001093
John Kessenich69f4b512013-09-04 21:19:27 +00001094 program.addShader(shader);
1095
John Kessenichc57b2a92016-01-16 15:30:03 -07001096 if (! (Options & EOptionSuppressInfolog) &&
1097 ! (Options & EOptionMemoryLeakMode)) {
John Kessenich04acb1b2017-06-14 17:36:50 -06001098 PutsIfNonEmpty(compUnit.fileName[0].c_str());
Andrew Woloszynaae1ad82015-06-24 17:00:46 -04001099 PutsIfNonEmpty(shader->getInfoLog());
1100 PutsIfNonEmpty(shader->getInfoDebugLog());
John Kessenich69f4b512013-09-04 21:19:27 +00001101 }
John Kessenich69f4b512013-09-04 21:19:27 +00001102 }
1103
1104 //
1105 // Program-level processing...
1106 //
1107
John Kessenich4d65ee32016-03-12 18:17:47 -07001108 // Link
John Kessenich68d78fd2015-07-12 19:28:10 -06001109 if (! (Options & EOptionOutputPreprocessed) && ! program.link(messages))
John Kessenichc999ba22013-11-07 23:33:24 +00001110 LinkFailed = true;
1111
John Kessenichb6d3ee52019-08-06 02:20:45 -06001112#ifndef GLSLANG_WEB
steve-lunarg9ae34742016-10-05 13:40:13 -06001113 // Map IO
1114 if (Options & EOptionSpv) {
1115 if (!program.mapIO())
1116 LinkFailed = true;
1117 }
John Kessenichb6d3ee52019-08-06 02:20:45 -06001118#endif
John Kessenichecba76f2017-01-06 00:34:48 -07001119
John Kessenich4d65ee32016-03-12 18:17:47 -07001120 // Report
John Kessenichc57b2a92016-01-16 15:30:03 -07001121 if (! (Options & EOptionSuppressInfolog) &&
1122 ! (Options & EOptionMemoryLeakMode)) {
Andrew Woloszynaae1ad82015-06-24 17:00:46 -04001123 PutsIfNonEmpty(program.getInfoLog());
1124 PutsIfNonEmpty(program.getInfoDebugLog());
John Kessenich69f4b512013-09-04 21:19:27 +00001125 }
1126
John Kessenichb6d3ee52019-08-06 02:20:45 -06001127#ifndef GLSLANG_WEB
John Kessenich4d65ee32016-03-12 18:17:47 -07001128 // Reflect
John Kessenich11f9fc72013-11-07 01:06:34 +00001129 if (Options & EOptionDumpReflection) {
baldurk6d477852019-01-29 15:45:56 +00001130 program.buildReflection(ReflectOptions);
John Kessenich11f9fc72013-11-07 01:06:34 +00001131 program.dumpReflection();
1132 }
John Kessenichb6d3ee52019-08-06 02:20:45 -06001133#endif
John Kessenich11f9fc72013-11-07 01:06:34 +00001134
John Kessenich4d65ee32016-03-12 18:17:47 -07001135 // Dump SPIR-V
John Kessenich0df0cde2015-03-03 17:09:43 +00001136 if (Options & EOptionSpv) {
John Kessenich92f90382014-07-28 04:21:04 +00001137 if (CompileFailed || LinkFailed)
John Kessenich68d78fd2015-07-12 19:28:10 -06001138 printf("SPIR-V is not generated for failed compile or link\n");
John Kessenich92f90382014-07-28 04:21:04 +00001139 else {
1140 for (int stage = 0; stage < EShLangCount; ++stage) {
John Kessenicha7a68a92014-08-24 18:21:00 +00001141 if (program.getIntermediate((EShLanguage)stage)) {
John Kessenich0df0cde2015-03-03 17:09:43 +00001142 std::vector<unsigned int> spirv;
Lei Zhang17535f72016-05-04 15:55:59 -04001143 spv::SpvBuildLogger logger;
John Kessenich121853f2017-05-31 17:11:16 -06001144 glslang::SpvOptions spvOptions;
1145 if (Options & EOptionDebug)
1146 spvOptions.generateDebugInfo = true;
GregF52fe3d52017-09-28 10:08:32 -06001147 spvOptions.disableOptimizer = (Options & EOptionOptimizeDisable) != 0;
1148 spvOptions.optimizeSize = (Options & EOptionOptimizeSize) != 0;
John Kessenich717c80a2018-08-23 15:17:10 -06001149 spvOptions.disassemble = SpvToolsDisassembler;
John Kessenichc3404252018-08-23 15:29:08 -06001150 spvOptions.validate = SpvToolsValidate;
John Kessenich121853f2017-05-31 17:11:16 -06001151 glslang::GlslangToSpv(*program.getIntermediate((EShLanguage)stage), spirv, &logger, &spvOptions);
John Kessenichc57b2a92016-01-16 15:30:03 -07001152
1153 // Dump the spv to a file or stdout, etc., but only if not doing
1154 // memory/perf testing, as it's not internal to programmatic use.
1155 if (! (Options & EOptionMemoryLeakMode)) {
Johannes van Waverenecb0f3b2016-05-27 12:55:53 -05001156 printf("%s", logger.getAllMessages().c_str());
1157 if (Options & EOptionOutputHexadecimal) {
John Kessenich8f674e82017-02-18 09:45:40 -07001158 glslang::OutputSpvHex(spirv, GetBinaryName((EShLanguage)stage), variableName);
Johannes van Waverenecb0f3b2016-05-27 12:55:53 -05001159 } else {
1160 glslang::OutputSpvBin(spirv, GetBinaryName((EShLanguage)stage));
1161 }
John Kessenich23d27752019-07-28 02:12:10 -06001162#ifndef GLSLANG_WEB
John Kesseniche2156222018-06-11 18:12:15 -06001163 if (!SpvToolsDisassembler && (Options & EOptionHumanReadableSpv))
John Kessenichc57b2a92016-01-16 15:30:03 -07001164 spv::Disassemble(std::cout, spirv);
John Kessenich23d27752019-07-28 02:12:10 -06001165#endif
John Kessenichacba7722015-03-04 03:48:38 +00001166 }
John Kessenicha7a68a92014-08-24 18:21:00 +00001167 }
John Kessenich92f90382014-07-28 04:21:04 +00001168 }
1169 }
1170 }
1171
John Kessenich5b0f13a2013-11-01 03:08:40 +00001172 // Free everything up, program has to go before the shaders
1173 // because it might have merged stuff from the shaders, and
1174 // the stuff from the shaders has to have its destructors called
1175 // before the pools holding the memory in the shaders is freed.
1176 delete &program;
John Kessenich69f4b512013-09-04 21:19:27 +00001177 while (shaders.size() > 0) {
1178 delete shaders.back();
1179 shaders.pop_back();
1180 }
John Kessenich69f4b512013-09-04 21:19:27 +00001181}
1182
John Kessenichc57b2a92016-01-16 15:30:03 -07001183//
1184// Do file IO part of compile and link, handing off the pure
1185// API/programmatic mode to CompileAndLinkShaderUnits(), which can
1186// be put in a loop for testing memory footprint and performance.
1187//
1188// This is just for linking mode: meaning all the shaders will be put into the
1189// the same program linked together.
1190//
1191// This means there are a limited number of work items (not multi-threading mode)
1192// and that the point is testing at the linking level. Hence, to enable
1193// performance and memory testing, the actual compile/link can be put in
1194// a loop, independent of processing the work items and file IO.
1195//
Juan Lopeza558b262017-04-02 23:04:00 +02001196void CompileAndLinkShaderFiles(glslang::TWorklist& Worklist)
John Kessenichc57b2a92016-01-16 15:30:03 -07001197{
1198 std::vector<ShaderCompUnit> compUnits;
1199
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001200 // If this is using stdin, we can't really detect multiple different file
1201 // units by input type. We need to assume that we're just being given one
1202 // file of a certain type.
1203 if ((Options & EOptionStdin) != 0) {
1204 ShaderCompUnit compUnit(FindLanguage("stdin"));
1205 std::istreambuf_iterator<char> begin(std::cin), end;
1206 std::string tempString(begin, end);
1207 char* fileText = strdup(tempString.c_str());
1208 std::string fileName = "stdin";
1209 compUnit.addString(fileName, fileText);
John Kessenichc57b2a92016-01-16 15:30:03 -07001210 compUnits.push_back(compUnit);
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001211 } else {
1212 // Transfer all the work items from to a simple list of
1213 // of compilation units. (We don't care about the thread
1214 // work-item distribution properties in this path, which
1215 // is okay due to the limited number of shaders, know since
1216 // they are all getting linked together.)
1217 glslang::TWorkItem* workItem;
1218 while (Worklist.remove(workItem)) {
1219 ShaderCompUnit compUnit(FindLanguage(workItem->name));
1220 char* fileText = ReadFileData(workItem->name.c_str());
1221 if (fileText == nullptr)
1222 usage();
1223 compUnit.addString(workItem->name, fileText);
1224 compUnits.push_back(compUnit);
1225 }
John Kessenichc57b2a92016-01-16 15:30:03 -07001226 }
1227
1228 // Actual call to programmatic processing of compile and link,
1229 // in a loop for testing memory and performance. This part contains
1230 // all the perf/memory that a programmatic consumer will care about.
1231 for (int i = 0; i < ((Options & EOptionMemoryLeakMode) ? 100 : 1); ++i) {
1232 for (int j = 0; j < ((Options & EOptionMemoryLeakMode) ? 100 : 1); ++j)
1233 CompileAndLinkShaderUnits(compUnits);
1234
1235 if (Options & EOptionMemoryLeakMode)
1236 glslang::OS_DumpMemoryCounters();
1237 }
1238
John Kessenicha9313662017-06-15 10:40:49 -06001239 // free memory from ReadFileData, which got stored in a const char*
1240 // as the first string above
rdb32084e82016-02-23 22:17:38 +01001241 for (auto it = compUnits.begin(); it != compUnits.end(); ++it)
John Kessenicha9313662017-06-15 10:40:49 -06001242 FreeFileData(const_cast<char*>(it->text[0]));
John Kessenichc57b2a92016-01-16 15:30:03 -07001243}
1244
John Kessenich94f28eb2017-11-13 01:32:06 -07001245int singleMain()
John Kessenicha0af4732012-12-12 21:15:54 +00001246{
Juan Lopeza558b262017-04-02 23:04:00 +02001247 glslang::TWorklist workList;
John Kessenich94f28eb2017-11-13 01:32:06 -07001248 std::for_each(WorkItems.begin(), WorkItems.end(), [&workList](std::unique_ptr<glslang::TWorkItem>& item) {
Juan Lopeza558b262017-04-02 23:04:00 +02001249 assert(item);
1250 workList.add(item.get());
1251 });
John Kessenich2b07c7e2013-07-31 18:44:13 +00001252
John Kessenich23d27752019-07-28 02:12:10 -06001253#ifndef GLSLANG_WEB
John Kessenich05a70632013-09-17 19:26:08 +00001254 if (Options & EOptionDumpConfig) {
Lei Zhang414eb602016-03-04 16:22:34 -05001255 printf("%s", glslang::GetDefaultTBuiltInResourceString().c_str());
Juan Lopeza558b262017-04-02 23:04:00 +02001256 if (workList.empty())
John Kessenich05a70632013-09-17 19:26:08 +00001257 return ESuccess;
1258 }
John Kessenich23d27752019-07-28 02:12:10 -06001259#endif
John Kessenich05a70632013-09-17 19:26:08 +00001260
John Kessenichc6c80a62018-03-05 22:23:17 -07001261 if (Options & EOptionDumpBareVersion) {
1262 printf("%d.%d.%d\n",
1263 glslang::GetSpirvGeneratorVersion(), GLSLANG_MINOR_VERSION, GLSLANG_PATCH_LEVEL);
1264 if (workList.empty())
1265 return ESuccess;
1266 } else if (Options & EOptionDumpVersions) {
1267 printf("Glslang Version: %d.%d.%d\n",
1268 glslang::GetSpirvGeneratorVersion(), GLSLANG_MINOR_VERSION, GLSLANG_PATCH_LEVEL);
John Kessenich319de232013-12-04 04:43:40 +00001269 printf("ESSL Version: %s\n", glslang::GetEsslVersionString());
1270 printf("GLSL Version: %s\n", glslang::GetGlslVersionString());
John Kessenich68d78fd2015-07-12 19:28:10 -06001271 std::string spirvVersion;
1272 glslang::GetSpirvVersion(spirvVersion);
John Kessenich0da9eaa2015-08-01 17:10:02 -06001273 printf("SPIR-V Version %s\n", spirvVersion.c_str());
John Kessenich5e4b1242015-08-06 22:53:06 -06001274 printf("GLSL.std.450 Version %d, Revision %d\n", GLSLstd450Version, GLSLstd450Revision);
John Kessenich55e7d112015-11-15 21:33:39 -07001275 printf("Khronos Tool ID %d\n", glslang::GetKhronosToolId());
John Kessenicha372a3e2017-11-02 22:32:14 -06001276 printf("SPIR-V Generator Version %d\n", glslang::GetSpirvGeneratorVersion());
John Kessenichb84313d2016-07-20 16:03:29 -06001277 printf("GL_KHR_vulkan_glsl version %d\n", 100);
1278 printf("ARB_GL_gl_spirv version %d\n", 100);
Juan Lopeza558b262017-04-02 23:04:00 +02001279 if (workList.empty())
John Kessenich319de232013-12-04 04:43:40 +00001280 return ESuccess;
1281 }
1282
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001283 if (workList.empty() && ((Options & EOptionStdin) == 0)) {
John Kessenich05a70632013-09-17 19:26:08 +00001284 usage();
John Kessenich05a70632013-09-17 19:26:08 +00001285 }
1286
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001287 if (Options & EOptionStdin) {
John Kessenich94f28eb2017-11-13 01:32:06 -07001288 WorkItems.push_back(std::unique_ptr<glslang::TWorkItem>{new glslang::TWorkItem("stdin")});
1289 workList.add(WorkItems.back().get());
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001290 }
1291
John Kessenich05a70632013-09-17 19:26:08 +00001292 ProcessConfigFile();
1293
John Kessenich086febc2018-10-25 12:43:02 -06001294 if ((Options & EOptionReadHlsl) && !((Options & EOptionOutputPreprocessed) || (Options & EOptionSpv)))
John Kessenichbd97b6f2019-12-20 10:33:13 -07001295 Error("HLSL requires SPIR-V code generation (or preprocessing only)");
John Kessenich086febc2018-10-25 12:43:02 -06001296
John Kessenich69f4b512013-09-04 21:19:27 +00001297 //
1298 // Two modes:
John Kessenich38f3b892013-09-06 19:52:57 +00001299 // 1) linking all arguments together, single-threaded, new C++ interface
1300 // 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 +00001301 //
John Kessenich086febc2018-10-25 12:43:02 -06001302 if (Options & (EOptionLinkProgram | EOptionOutputPreprocessed)) {
John Kessenichc36e1d82013-11-01 17:41:52 +00001303 glslang::InitializeProcess();
John Kesseniche2c15b42017-11-16 22:48:41 -07001304 glslang::InitializeProcess(); // also test reference counting of users
1305 glslang::InitializeProcess(); // also test reference counting of users
1306 glslang::FinalizeProcess(); // also test reference counting of users
1307 glslang::FinalizeProcess(); // also test reference counting of users
Juan Lopeza558b262017-04-02 23:04:00 +02001308 CompileAndLinkShaderFiles(workList);
John Kessenichc36e1d82013-11-01 17:41:52 +00001309 glslang::FinalizeProcess();
1310 } else {
1311 ShInitialize();
John Kesseniche2c15b42017-11-16 22:48:41 -07001312 ShInitialize(); // also test reference counting of users
1313 ShFinalize(); // also test reference counting of users
John Kessenichc36e1d82013-11-01 17:41:52 +00001314
Juan Lopeza558b262017-04-02 23:04:00 +02001315 bool printShaderNames = workList.size() > 1;
John Kessenich69f4b512013-09-04 21:19:27 +00001316
John Kesseniche2c15b42017-11-16 22:48:41 -07001317 if (Options & EOptionMultiThreaded) {
Juan Lopeza558b262017-04-02 23:04:00 +02001318 std::array<std::thread, 16> threads;
John Kesseniche2c15b42017-11-16 22:48:41 -07001319 for (unsigned int t = 0; t < threads.size(); ++t) {
Juan Lopeza558b262017-04-02 23:04:00 +02001320 threads[t] = std::thread(CompileShaders, std::ref(workList));
John Kesseniche2c15b42017-11-16 22:48:41 -07001321 if (threads[t].get_id() == std::thread::id()) {
John Kessenichaf527992017-11-02 22:48:15 -06001322 fprintf(stderr, "Failed to create thread\n");
John Kessenich38f3b892013-09-06 19:52:57 +00001323 return EFailThreadCreate;
1324 }
John Kessenicha0af4732012-12-12 21:15:54 +00001325 }
Juan Lopeza558b262017-04-02 23:04:00 +02001326
1327 std::for_each(threads.begin(), threads.end(), [](std::thread& t) { t.join(); });
John Kessenichc999ba22013-11-07 23:33:24 +00001328 } else
Juan Lopeza558b262017-04-02 23:04:00 +02001329 CompileShaders(workList);
John Kessenich38f3b892013-09-06 19:52:57 +00001330
1331 // Print out all the resulting infologs
John Kessenich94f28eb2017-11-13 01:32:06 -07001332 for (size_t w = 0; w < WorkItems.size(); ++w) {
1333 if (WorkItems[w]) {
1334 if (printShaderNames || WorkItems[w]->results.size() > 0)
1335 PutsIfNonEmpty(WorkItems[w]->name.c_str());
1336 PutsIfNonEmpty(WorkItems[w]->results.c_str());
John Kessenich38f3b892013-09-06 19:52:57 +00001337 }
1338 }
John Kessenichc36e1d82013-11-01 17:41:52 +00001339
1340 ShFinalize();
John Kessenicha0af4732012-12-12 21:15:54 +00001341 }
John Kessenich2b07c7e2013-07-31 18:44:13 +00001342
John Kessenichc999ba22013-11-07 23:33:24 +00001343 if (CompileFailed)
John Kessenicha0af4732012-12-12 21:15:54 +00001344 return EFailCompile;
John Kessenichc999ba22013-11-07 23:33:24 +00001345 if (LinkFailed)
John Kessenicha0af4732012-12-12 21:15:54 +00001346 return EFailLink;
1347
1348 return 0;
1349}
1350
John Kessenich94f28eb2017-11-13 01:32:06 -07001351int C_DECL main(int argc, char* argv[])
1352{
1353 ProcessArguments(WorkItems, argc, argv);
1354
1355 int ret = 0;
1356
1357 // Loop over the entire init/finalize cycle to watch memory changes
1358 const int iterations = 1;
1359 if (iterations > 1)
1360 glslang::OS_DumpMemoryCounters();
1361 for (int i = 0; i < iterations; ++i) {
1362 ret = singleMain();
1363 if (iterations > 1)
1364 glslang::OS_DumpMemoryCounters();
1365 }
1366
1367 return ret;
1368}
1369
John Kessenicha0af4732012-12-12 21:15:54 +00001370//
1371// Deduce the language from the filename. Files must end in one of the
1372// following extensions:
1373//
John Kessenich2b07c7e2013-07-31 18:44:13 +00001374// .vert = vertex
1375// .tesc = tessellation control
1376// .tese = tessellation evaluation
1377// .geom = geometry
1378// .frag = fragment
John Kessenich94a81fb2013-08-31 02:41:30 +00001379// .comp = compute
Chao Chenb50c02e2018-09-19 11:42:24 -07001380// .rgen = ray generation
1381// .rint = ray intersection
1382// .rahit = ray any hit
1383// .rchit = ray closest hit
1384// .rmiss = ray miss
1385// .rcall = ray callable
Sahil Parmar035cbbe2018-10-04 16:39:18 -07001386// .mesh = mesh
1387// .task = task
Grigory Dzhavadyan33507412018-04-12 14:35:24 -07001388// Additionally, the file names may end in .<stage>.glsl and .<stage>.hlsl
1389// where <stage> is one of the stages listed above.
1390//
1391EShLanguage FindLanguage(const std::string& name, bool parseStageName)
John Kessenicha0af4732012-12-12 21:15:54 +00001392{
John Kessenichfccbb8b2018-04-17 17:24:03 -06001393 std::string stageName;
Dan Bakerc6ede892016-08-11 14:06:06 -04001394 if (shaderStageName)
John Kessenichfccbb8b2018-04-17 17:24:03 -06001395 stageName = shaderStageName;
1396 else if (parseStageName) {
Grigory Dzhavadyan33507412018-04-12 14:35:24 -07001397 // Note: "first" extension means "first from the end", i.e.
1398 // if the file is named foo.vert.glsl, then "glsl" is first,
1399 // "vert" is second.
John Kessenichfccbb8b2018-04-17 17:24:03 -06001400 size_t firstExtStart = name.find_last_of(".");
1401 bool hasFirstExt = firstExtStart != std::string::npos;
1402 size_t secondExtStart = hasFirstExt ? name.find_last_of(".", firstExtStart - 1) : std::string::npos;
1403 bool hasSecondExt = secondExtStart != std::string::npos;
1404 std::string firstExt = name.substr(firstExtStart + 1, std::string::npos);
1405 bool usesUnifiedExt = hasFirstExt && (firstExt == "glsl" || firstExt == "hlsl");
John Kessenich3beac942018-04-17 21:02:19 -06001406 if (usesUnifiedExt && firstExt == "hlsl")
1407 Options |= EOptionReadHlsl;
1408 if (hasFirstExt && !usesUnifiedExt)
John Kessenichfccbb8b2018-04-17 17:24:03 -06001409 stageName = firstExt;
John Kessenich3beac942018-04-17 21:02:19 -06001410 else if (usesUnifiedExt && hasSecondExt)
John Kessenichfccbb8b2018-04-17 17:24:03 -06001411 stageName = name.substr(secondExtStart + 1, firstExtStart - secondExtStart - 1);
John Kessenich3beac942018-04-17 21:02:19 -06001412 else {
Grigory Dzhavadyan33507412018-04-12 14:35:24 -07001413 usage();
1414 return EShLangVertex;
John Kesseniche751bca2017-03-16 11:20:38 -06001415 }
John Kessenichfccbb8b2018-04-17 17:24:03 -06001416 } else
1417 stageName = name;
dankbaker45d49bc2016-08-08 21:43:07 -04001418
John Kessenichfccbb8b2018-04-17 17:24:03 -06001419 if (stageName == "vert")
John Kessenich2b07c7e2013-07-31 18:44:13 +00001420 return EShLangVertex;
John Kessenichfccbb8b2018-04-17 17:24:03 -06001421 else if (stageName == "tesc")
John Kessenich2b07c7e2013-07-31 18:44:13 +00001422 return EShLangTessControl;
John Kessenichfccbb8b2018-04-17 17:24:03 -06001423 else if (stageName == "tese")
John Kessenich2b07c7e2013-07-31 18:44:13 +00001424 return EShLangTessEvaluation;
John Kessenichfccbb8b2018-04-17 17:24:03 -06001425 else if (stageName == "geom")
John Kessenich2b07c7e2013-07-31 18:44:13 +00001426 return EShLangGeometry;
John Kessenichfccbb8b2018-04-17 17:24:03 -06001427 else if (stageName == "frag")
John Kessenich2b07c7e2013-07-31 18:44:13 +00001428 return EShLangFragment;
John Kessenichfccbb8b2018-04-17 17:24:03 -06001429 else if (stageName == "comp")
John Kessenichc0275792013-08-09 17:14:49 +00001430 return EShLangCompute;
Chao Chenb50c02e2018-09-19 11:42:24 -07001431 else if (stageName == "rgen")
Daniel Kochdb32b242020-03-17 20:42:47 -04001432 return EShLangRayGen;
Chao Chenb50c02e2018-09-19 11:42:24 -07001433 else if (stageName == "rint")
Daniel Kochdb32b242020-03-17 20:42:47 -04001434 return EShLangIntersect;
Chao Chenb50c02e2018-09-19 11:42:24 -07001435 else if (stageName == "rahit")
Daniel Kochdb32b242020-03-17 20:42:47 -04001436 return EShLangAnyHit;
Chao Chenb50c02e2018-09-19 11:42:24 -07001437 else if (stageName == "rchit")
Daniel Kochdb32b242020-03-17 20:42:47 -04001438 return EShLangClosestHit;
Chao Chenb50c02e2018-09-19 11:42:24 -07001439 else if (stageName == "rmiss")
Daniel Kochdb32b242020-03-17 20:42:47 -04001440 return EShLangMiss;
Chao Chenb50c02e2018-09-19 11:42:24 -07001441 else if (stageName == "rcall")
Daniel Kochdb32b242020-03-17 20:42:47 -04001442 return EShLangCallable;
Chao Chen3c366992018-09-19 11:41:59 -07001443 else if (stageName == "mesh")
1444 return EShLangMeshNV;
1445 else if (stageName == "task")
1446 return EShLangTaskNV;
John Kessenich2b07c7e2013-07-31 18:44:13 +00001447
1448 usage();
John Kesseniche95ecc52012-12-12 21:34:14 +00001449 return EShLangVertex;
John Kessenicha0af4732012-12-12 21:15:54 +00001450}
1451
John Kessenicha0af4732012-12-12 21:15:54 +00001452//
John Kessenichecba76f2017-01-06 00:34:48 -07001453// Read a file's data into a string, and compile it using the old interface ShCompile,
John Kessenich69f4b512013-09-04 21:19:27 +00001454// for non-linkable results.
John Kessenicha0af4732012-12-12 21:15:54 +00001455//
John Kessenich51cdd902014-02-18 23:37:57 +00001456void CompileFile(const char* fileName, ShHandle compiler)
John Kessenicha0af4732012-12-12 21:15:54 +00001457{
John Kessenichca3457f2015-05-18 01:59:45 +00001458 int ret = 0;
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001459 char* shaderString;
1460 if ((Options & EOptionStdin) != 0) {
1461 std::istreambuf_iterator<char> begin(std::cin), end;
1462 std::string tempString(begin, end);
1463 shaderString = strdup(tempString.c_str());
1464 } else {
1465 shaderString = ReadFileData(fileName);
1466 }
John Kessenich41cf6b52013-06-25 18:10:05 +00001467
1468 // move to length-based strings, rather than null-terminated strings
John Kessenich04acb1b2017-06-14 17:36:50 -06001469 int* lengths = new int[1];
1470 lengths[0] = (int)strlen(shaderString);
John Kessenicha0af4732012-12-12 21:15:54 +00001471
John Kessenich52ac67e2013-05-05 23:46:22 +00001472 EShMessages messages = EShMsgDefault;
John Kessenichb0a7eb52013-11-07 17:44:20 +00001473 SetMessageOptions(messages);
John Kessenichecba76f2017-01-06 00:34:48 -07001474
John Kessenicha9313662017-06-15 10:40:49 -06001475 if (UserPreamble.isSet())
1476 Error("-D and -U options require -l (linking)\n");
1477
John Kessenich94a81fb2013-08-31 02:41:30 +00001478 for (int i = 0; i < ((Options & EOptionMemoryLeakMode) ? 100 : 1); ++i) {
1479 for (int j = 0; j < ((Options & EOptionMemoryLeakMode) ? 100 : 1); ++j) {
John Kessenich927608b2017-01-06 12:34:14 -07001480 // ret = ShCompile(compiler, shaderStrings, NumShaderStrings, lengths, EShOptNone, &Resources, Options, (Options & EOptionDefaultDesktop) ? 110 : 100, false, messages);
John Kessenich04acb1b2017-06-14 17:36:50 -06001481 ret = ShCompile(compiler, &shaderString, 1, nullptr, EShOptNone, &Resources, Options, (Options & EOptionDefaultDesktop) ? 110 : 100, false, messages);
John Kessenich927608b2017-01-06 12:34:14 -07001482 // const char* multi[12] = { "# ve", "rsion", " 300 e", "s", "\n#err",
John Kessenichecba76f2017-01-06 00:34:48 -07001483 // "or should be l", "ine 1", "string 5\n", "float glo", "bal",
John Kessenichea869fb2013-10-28 18:12:06 +00001484 // ";\n#error should be line 2\n void main() {", "global = 2.3;}" };
John Kessenich927608b2017-01-06 12:34:14 -07001485 // const char* multi[7] = { "/", "/", "\\", "\n", "\n", "#", "version 300 es" };
1486 // ret = ShCompile(compiler, multi, 7, nullptr, EShOptNone, &Resources, Options, (Options & EOptionDefaultDesktop) ? 110 : 100, false, messages);
John Kessenich41cf6b52013-06-25 18:10:05 +00001487 }
John Kessenicha0af4732012-12-12 21:15:54 +00001488
John Kessenich94a81fb2013-08-31 02:41:30 +00001489 if (Options & EOptionMemoryLeakMode)
John Kessenich2b07c7e2013-07-31 18:44:13 +00001490 glslang::OS_DumpMemoryCounters();
John Kessenicha0af4732012-12-12 21:15:54 +00001491 }
John Kessenicha0af4732012-12-12 21:15:54 +00001492
John Kessenich41cf6b52013-06-25 18:10:05 +00001493 delete [] lengths;
John Kessenich04acb1b2017-06-14 17:36:50 -06001494 FreeFileData(shaderString);
John Kessenicha0af4732012-12-12 21:15:54 +00001495
John Kessenichc999ba22013-11-07 23:33:24 +00001496 if (ret == 0)
1497 CompileFailed = true;
John Kessenicha0af4732012-12-12 21:15:54 +00001498}
1499
John Kessenicha0af4732012-12-12 21:15:54 +00001500//
1501// print usage to stdout
1502//
1503void usage()
1504{
John Kessenich319de232013-12-04 04:43:40 +00001505 printf("Usage: glslangValidator [option]... [file]...\n"
1506 "\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001507 "'file' can end in .<stage> for auto-stage classification, where <stage> is:\n"
1508 " .conf to provide a config file that replaces the default configuration\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001509 " (see -c option below for generating a template)\n"
1510 " .vert for a vertex shader\n"
1511 " .tesc for a tessellation control shader\n"
1512 " .tese for a tessellation evaluation shader\n"
1513 " .geom for a geometry shader\n"
1514 " .frag for a fragment shader\n"
1515 " .comp for a compute shader\n"
Chao Chen3c366992018-09-19 11:41:59 -07001516 " .mesh for a mesh shader\n"
1517 " .task for a task shader\n"
Chao Chenb50c02e2018-09-19 11:42:24 -07001518 " .rgen for a ray generation shader\n"
1519 " .rint for a ray intersection shader\n"
1520 " .rahit for a ray any hit shader\n"
1521 " .rchit for a ray closest hit shader\n"
1522 " .rmiss for a ray miss shader\n"
Sahil Parmar035cbbe2018-10-04 16:39:18 -07001523 " .rcall for a ray callable shader\n"
John Kessenich2ead40f2018-04-17 17:44:11 -06001524 " .glsl for .vert.glsl, .tesc.glsl, ..., .comp.glsl compound suffixes\n"
1525 " .hlsl for .vert.hlsl, .tesc.hlsl, ..., .comp.hlsl compound suffixes\n"
John Kessenich319de232013-12-04 04:43:40 +00001526 "\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001527 "Options:\n"
1528 " -C cascading errors; risk crash from accumulation of error recoveries\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001529 " -D input is HLSL (this is the default when any suffix is .hlsl)\n"
John Kessenich6f988922020-01-07 07:03:11 -07001530 " -D<name[=def]> | --define-macro <name[=def]> | --D <name[=def]>\n"
1531 " define a pre-processor macro\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001532 " -E print pre-processed GLSL; cannot be used with -l;\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001533 " errors will appear on stderr\n"
John Kessenich6353d552017-06-23 11:11:09 -06001534 " -G[ver] create SPIR-V binary, under OpenGL semantics; turns on -l;\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001535 " default file name is <stage>.spv (-o overrides this);\n"
John Kessenich6353d552017-06-23 11:11:09 -06001536 " 'ver', when present, is the version of the input semantics,\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001537 " which will appear in #define GL_SPIRV ver;\n"
1538 " '--client opengl100' is the same as -G100;\n"
John Kessenich6353d552017-06-23 11:11:09 -06001539 " a '--target-env' for OpenGL will also imply '-G'\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001540 " -H print human readable form of SPIR-V; turns on -V\n"
John Kessenich971a0a82017-06-07 15:06:58 -06001541 " -I<dir> add dir to the include search path; includer's directory\n"
1542 " is searched first, followed by left-to-right order of -I\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001543 " -Od disables optimization; may cause illegal SPIR-V for HLSL\n"
1544 " -Os optimizes SPIR-V to minimize size\n"
John Kesseniche751bca2017-03-16 11:20:38 -06001545 " -S <stage> uses specified stage rather than parsing the file extension\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001546 " choices for <stage> are vert, tesc, tese, geom, frag, or comp\n"
John Kessenich6f988922020-01-07 07:03:11 -07001547 " -U<name> | --undef-macro <name> | --U <name>\n"
1548 " undefine a pre-processor macro\n"
John Kessenich6353d552017-06-23 11:11:09 -06001549 " -V[ver] create SPIR-V binary, under Vulkan semantics; turns on -l;\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001550 " default file name is <stage>.spv (-o overrides this)\n"
John Kessenich6353d552017-06-23 11:11:09 -06001551 " 'ver', when present, is the version of the input semantics,\n"
1552 " which will appear in #define VULKAN ver\n"
1553 " '--client vulkan100' is the same as -V100\n"
1554 " a '--target-env' for Vulkan will also imply '-V'\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001555 " -c configuration dump;\n"
1556 " creates the default configuration file (redirect to a .conf file)\n"
1557 " -d default to desktop (#version 110) when there is no shader #version\n"
1558 " (default is ES version 100)\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001559 " -e <name> | --entry-point <name>\n"
1560 " specify <name> as the entry-point function name\n"
John Kessenich5d610ee2018-03-07 18:05:55 -07001561 " -f{hlsl_functionality1}\n"
1562 " 'hlsl_functionality1' enables use of the\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001563 " SPV_GOOGLE_hlsl_functionality1 extension\n"
John Kessenich121853f2017-05-31 17:11:16 -06001564 " -g generate debug information\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001565 " -h print this usage message\n"
1566 " -i intermediate tree (glslang AST) is printed out\n"
1567 " -l link all input files together to form a single module\n"
1568 " -m memory leak mode\n"
John Kessenicha25530c2017-09-11 20:13:49 -06001569 " -o <file> save binary to <file>, requires a binary option (e.g., -V)\n"
John Kesseniche5c394b2019-07-02 09:32:48 -06001570 " -q dump reflection query database; requires -l for linking\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001571 " -r | --relaxed-errors"
1572 " relaxed GLSL semantic error-checking mode\n"
John Kessenichb63f4a32017-11-16 22:32:20 -07001573 " -s silence syntax and semantic error reporting\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001574 " -t multi-threaded mode\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001575 " -v | --version\n"
1576 " print version strings\n"
1577 " -w | --suppress-warnings\n"
1578 " suppress GLSL warnings, except as required by \"#extension : warn\"\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001579 " -x save binary output as text-based 32-bit hexadecimal numbers\n"
Neil Roberts16f53472018-03-20 17:30:53 +01001580 " -u<name>:<loc> specify a uniform location override for --aml\n"
Neil Robertsb0f3d792018-03-20 17:41:05 +01001581 " --uniform-base <base> set a base to use for generated uniform locations\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001582 " --auto-map-bindings | --amb automatically bind uniform variables\n"
1583 " without explicit bindings\n"
1584 " --auto-map-locations | --aml automatically locate input/output lacking\n"
1585 " 'location' (fragile, not cross stage)\n"
1586 " --client {vulkan<ver>|opengl<ver>} see -V and -G\n"
Christoph Kubisch412ff6e2019-04-13 22:57:33 +02001587 " --dump-builtin-symbols prints builtin symbol table prior each compile\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001588 " -dumpfullversion | -dumpversion print bare major.minor.patchlevel\n"
1589 " --flatten-uniform-arrays | --fua flatten uniform texture/sampler arrays to\n"
1590 " scalars\n"
1591 " --hlsl-offsets allow block offsets to follow HLSL rules\n"
1592 " works independently of source language\n"
1593 " --hlsl-iomap perform IO mapping in HLSL register space\n"
1594 " --hlsl-enable-16bit-types allow 16-bit types in SPIR-V for HLSL\n"
John Kessenich605afc72019-06-17 23:33:09 -06001595 " --hlsl-dx9-compatible interprets sampler declarations as a\n"
rdbb56e0e42020-06-02 08:30:50 +02001596 " texture/sampler combo like DirectX9 would,\n"
1597 " and recognizes DirectX9-specific semantics\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001598 " --invert-y | --iy invert position.Y output in vertex shader\n"
1599 " --keep-uncalled | --ku don't eliminate uncalled functions\n"
John Kessenich605afc72019-06-17 23:33:09 -06001600 " --nan-clamp favor non-NaN operand in min, max, and clamp\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001601 " --no-storage-format | --nsf use Unknown image format\n"
baldurk4513df92019-02-08 10:48:48 +00001602 " --reflect-strict-array-suffix use strict array suffix rules when\n"
1603 " reflecting\n"
baldurkedf82122019-01-29 15:49:00 +00001604 " --reflect-basic-array-suffix arrays of basic types will have trailing [0]\n"
baldurk4513df92019-02-08 10:48:48 +00001605 " --reflect-intermediate-io reflection includes inputs/outputs of linked\n"
1606 " shaders rather than just vertex/fragment\n"
1607 " --reflect-separate-buffers reflect buffer variables and blocks\n"
1608 " separately to uniforms\n"
1609 " --reflect-all-block-variables reflect all variables in blocks, whether\n"
1610 " inactive or active\n"
baldurk19050692019-02-11 11:50:24 +00001611 " --reflect-unwrap-io-blocks unwrap input/output blocks the same as\n"
1612 " uniform blocks\n"
LoopDawg52017192017-07-14 15:15:47 -06001613 " --resource-set-binding [stage] name set binding\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001614 " set descriptor set and binding for\n"
1615 " individual resources\n"
LoopDawg52017192017-07-14 15:15:47 -06001616 " --resource-set-binding [stage] set\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001617 " set descriptor set for all resources\n"
1618 " --rsb synonym for --resource-set-binding\n"
1619 " --shift-image-binding [stage] num\n"
1620 " base binding number for images (uav)\n"
1621 " --shift-image-binding [stage] [num set]...\n"
1622 " per-descriptor-set shift values\n"
1623 " --sib synonym for --shift-image-binding\n"
1624 " --shift-sampler-binding [stage] num\n"
1625 " base binding number for samplers\n"
1626 " --shift-sampler-binding [stage] [num set]...\n"
1627 " per-descriptor-set shift values\n"
1628 " --ssb synonym for --shift-sampler-binding\n"
1629 " --shift-ssbo-binding [stage] num base binding number for SSBOs\n"
1630 " --shift-ssbo-binding [stage] [num set]...\n"
1631 " per-descriptor-set shift values\n"
1632 " --sbb synonym for --shift-ssbo-binding\n"
1633 " --shift-texture-binding [stage] num\n"
1634 " base binding number for textures\n"
1635 " --shift-texture-binding [stage] [num set]...\n"
1636 " per-descriptor-set shift values\n"
1637 " --stb synonym for --shift-texture-binding\n"
1638 " --shift-uav-binding [stage] num base binding number for UAVs\n"
1639 " --shift-uav-binding [stage] [num set]...\n"
1640 " per-descriptor-set shift values\n"
1641 " --suavb synonym for --shift-uav-binding\n"
1642 " --shift-UBO-binding [stage] num base binding number for UBOs\n"
1643 " --shift-UBO-binding [stage] [num set]...\n"
1644 " per-descriptor-set shift values\n"
1645 " --sub synonym for --shift-UBO-binding\n"
1646 " --shift-cbuffer-binding | --scb synonyms for --shift-UBO-binding\n"
1647 " --spirv-dis output standard-form disassembly; works only\n"
1648 " when a SPIR-V generation option is also used\n"
John Kessenichc3404252018-08-23 15:29:08 -06001649 " --spirv-val execute the SPIRV-Tools validator\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001650 " --source-entrypoint <name> the given shader source function is\n"
1651 " renamed to be the <name> given in -e\n"
1652 " --sep synonym for --source-entrypoint\n"
1653 " --stdin read from stdin instead of from a file;\n"
1654 " requires providing the shader stage using -S\n"
John Kessenich273d3a52020-01-15 00:10:41 -07001655 " --target-env {vulkan1.0 | vulkan1.1 | vulkan1.2 | opengl | \n"
John Kessenich8317e6c2019-08-18 23:58:08 -06001656 " spirv1.0 | spirv1.1 | spirv1.2 | spirv1.3 | spirv1.4 | spirv1.5}\n"
John Kessenich273d3a52020-01-15 00:10:41 -07001657 " Set the execution environment that the\n"
1658 " generated code will be executed in.\n"
1659 " Defaults to:\n"
1660 " * vulkan1.0 under --client vulkan<ver>\n"
1661 " * opengl under --client opengl<ver>\n"
1662 " * spirv1.0 under --target-env vulkan1.0\n"
1663 " * spirv1.3 under --target-env vulkan1.1\n"
1664 " * spirv1.5 under --target-env vulkan1.2\n"
1665 " Multiple --target-env can be specified.\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001666 " --variable-name <name>\n"
1667 " --vn <name> creates a C header file that contains a\n"
1668 " uint32_t array named <name>\n"
1669 " initialized with the shader binary code\n"
John Kessenichb0a7eb52013-11-07 17:44:20 +00001670 );
John Kessenich68d78fd2015-07-12 19:28:10 -06001671
1672 exit(EFailUsage);
John Kessenicha0af4732012-12-12 21:15:54 +00001673}
1674
John Kessenich3ce4e592014-10-06 19:57:34 +00001675#if !defined _MSC_VER && !defined MINGW_HAS_SECURE_API
John Kessenichcfd643e2013-03-08 23:14:42 +00001676
1677#include <errno.h>
1678
1679int fopen_s(
1680 FILE** pFile,
John Kessenich51cdd902014-02-18 23:37:57 +00001681 const char* filename,
1682 const char* mode
John Kessenichcfd643e2013-03-08 23:14:42 +00001683)
1684{
1685 if (!pFile || !filename || !mode) {
1686 return EINVAL;
1687 }
1688
1689 FILE* f = fopen(filename, mode);
1690 if (! f) {
1691 if (errno != 0) {
1692 return errno;
1693 } else {
1694 return ENOENT;
1695 }
1696 }
1697 *pFile = f;
1698
1699 return 0;
1700}
1701
1702#endif
1703
John Kessenicha0af4732012-12-12 21:15:54 +00001704//
1705// Malloc a string of sufficient size and read a string into it.
1706//
John Kessenich04acb1b2017-06-14 17:36:50 -06001707char* ReadFileData(const char* fileName)
John Kessenicha0af4732012-12-12 21:15:54 +00001708{
John Kessenichb3297152015-07-11 18:01:03 -06001709 FILE *in = nullptr;
John Kessenich3ce4e592014-10-06 19:57:34 +00001710 int errorCode = fopen_s(&in, fileName, "r");
John Kessenich68d78fd2015-07-12 19:28:10 -06001711 if (errorCode || in == nullptr)
1712 Error("unable to open input file");
John Kessenichecba76f2017-01-06 00:34:48 -07001713
John Kessenich04acb1b2017-06-14 17:36:50 -06001714 int count = 0;
John Kessenicha0af4732012-12-12 21:15:54 +00001715 while (fgetc(in) != EOF)
1716 count++;
1717
John Kessenichd6c72a42014-08-18 19:42:35 +00001718 fseek(in, 0, SEEK_SET);
John Kessenichca3457f2015-05-18 01:59:45 +00001719
John Kessenich04acb1b2017-06-14 17:36:50 -06001720 char* return_data = (char*)malloc(count + 1); // freed in FreeFileData()
1721 if ((int)fread(return_data, 1, count, in) != count) {
1722 free(return_data);
John Kessenich68d78fd2015-07-12 19:28:10 -06001723 Error("can't read input file");
John Kessenicha0af4732012-12-12 21:15:54 +00001724 }
John Kessenich68d78fd2015-07-12 19:28:10 -06001725
John Kessenich04acb1b2017-06-14 17:36:50 -06001726 return_data[count] = '\0';
John Kessenicha0af4732012-12-12 21:15:54 +00001727 fclose(in);
John Kessenichb3297152015-07-11 18:01:03 -06001728
John Kessenicha0af4732012-12-12 21:15:54 +00001729 return return_data;
1730}
1731
John Kessenich04acb1b2017-06-14 17:36:50 -06001732void FreeFileData(char* data)
John Kessenicha0af4732012-12-12 21:15:54 +00001733{
John Kessenichb3297152015-07-11 18:01:03 -06001734 free(data);
John Kessenicha0af4732012-12-12 21:15:54 +00001735}
1736
John Kessenich54d8cda2013-02-11 22:36:01 +00001737void InfoLogMsg(const char* msg, const char* name, const int num)
John Kessenicha0af4732012-12-12 21:15:54 +00001738{
John Kessenichfae38ee2015-06-10 23:23:12 +00001739 if (num >= 0 )
1740 printf("#### %s %s %d INFO LOG ####\n", msg, name, num);
1741 else
1742 printf("#### %s %s INFO LOG ####\n", msg, name);
John Kessenicha0af4732012-12-12 21:15:54 +00001743}