blob: 79f13afefa497df62d0762b7274b781a4acc87aa [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" {
Ben Claytond64e8592020-06-29 14:20:19 +010066 GLSLANG_EXPORT void ShOutputHtml();
John Kessenicha0af4732012-12-12 21:15:54 +000067}
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;
Shahbaz Youssefid52dce52020-06-17 12:47:44 -0400109bool stripDebugInfo = false;
Marcin Åšlusarz245c30c2020-07-03 14:55:29 +0200110bool beQuiet = false;
John Kessenich94a81fb2013-08-31 02:41:30 +0000111
John Kessenicha0af4732012-12-12 21:15:54 +0000112//
John Kessenich68d78fd2015-07-12 19:28:10 -0600113// Return codes from main/exit().
John Kessenicha0af4732012-12-12 21:15:54 +0000114//
115enum TFailCode {
116 ESuccess = 0,
117 EFailUsage,
118 EFailCompile,
119 EFailLink,
120 EFailCompilerCreate,
John Kessenich2b07c7e2013-07-31 18:44:13 +0000121 EFailThreadCreate,
John Kessenicha0af4732012-12-12 21:15:54 +0000122 EFailLinkerCreate
123};
124
125//
John Kessenich68d78fd2015-07-12 19:28:10 -0600126// Forward declarations.
John Kessenicha0af4732012-12-12 21:15:54 +0000127//
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600128EShLanguage FindLanguage(const std::string& name, bool parseSuffix=true);
John Kessenich51cdd902014-02-18 23:37:57 +0000129void CompileFile(const char* fileName, ShHandle);
John Kessenicha0af4732012-12-12 21:15:54 +0000130void usage();
John Kessenich04acb1b2017-06-14 17:36:50 -0600131char* ReadFileData(const char* fileName);
132void FreeFileData(char* data);
John Kessenich54d8cda2013-02-11 22:36:01 +0000133void InfoLogMsg(const char* msg, const char* name, const int num);
John Kessenich41cf6b52013-06-25 18:10:05 +0000134
John Kessenichc999ba22013-11-07 23:33:24 +0000135// Globally track if any compile or link failure.
136bool CompileFailed = false;
137bool LinkFailed = false;
138
John Kessenich94f28eb2017-11-13 01:32:06 -0700139// array of unique places to leave the shader names and infologs for the asynchronous compiles
140std::vector<std::unique_ptr<glslang::TWorkItem>> WorkItems;
141
John Kessenich05a70632013-09-17 19:26:08 +0000142TBuiltInResource Resources;
143std::string ConfigFile;
144
John Kessenicha0af4732012-12-12 21:15:54 +0000145//
John Kessenichf0bcb0a2016-04-02 13:09:14 -0600146// Parse either a .conf file provided by the user or the default from glslang::DefaultTBuiltInResource
John Kessenich05a70632013-09-17 19:26:08 +0000147//
148void ProcessConfigFile()
John Kessenichb51f62c2013-04-11 16:31:09 +0000149{
John Kessenich04acb1b2017-06-14 17:36:50 -0600150 if (ConfigFile.size() == 0)
Lei Zhang414eb602016-03-04 16:22:34 -0500151 Resources = glslang::DefaultTBuiltInResource;
John Kessenich23d27752019-07-28 02:12:10 -0600152#ifndef GLSLANG_WEB
John Kessenich04acb1b2017-06-14 17:36:50 -0600153 else {
154 char* configString = ReadFileData(ConfigFile.c_str());
155 glslang::DecodeResourceLimits(&Resources, configString);
156 FreeFileData(configString);
John Kessenich05a70632013-09-17 19:26:08 +0000157 }
John Kessenich23d27752019-07-28 02:12:10 -0600158#endif
John Kessenicha0af4732012-12-12 21:15:54 +0000159}
160
baldurk6d477852019-01-29 15:45:56 +0000161int ReflectOptions = EShReflectionDefault;
John Kessenich94a81fb2013-08-31 02:41:30 +0000162int Options = 0;
John Kessenich68d78fd2015-07-12 19:28:10 -0600163const char* ExecutableName = nullptr;
164const char* binaryFileName = nullptr;
John Kessenich4d65ee32016-03-12 18:17:47 -0700165const char* entryPointName = nullptr;
steve-lunargf1e0c872016-10-31 15:13:43 -0600166const char* sourceEntryPointName = nullptr;
Dan Bakerc6ede892016-08-11 14:06:06 -0400167const char* shaderStageName = nullptr;
Flavioaea3c892017-02-06 11:46:35 -0800168const char* variableName = nullptr;
Rex Xucb61eec2018-03-07 13:10:01 +0800169bool HlslEnable16BitTypes = false;
John Kessenichbd1c1832018-12-07 18:38:26 -0700170bool HlslDX9compatible = false;
Christoph Kubisch55ba3ea2019-04-13 22:18:16 +0200171bool DumpBuiltinSymbols = false;
John Kessenich971a0a82017-06-07 15:06:58 -0600172std::vector<std::string> IncludeDirectoryList;
John Kessenich8717a5d2018-10-26 10:12:32 -0600173
174// Source environment
175// (source 'Client' is currently the same as target 'Client')
176int ClientInputSemanticsVersion = 100;
177
178// Target environment
179glslang::EShClient Client = glslang::EShClientNone; // will stay EShClientNone if only validating
180glslang::EShTargetClientVersion ClientVersion; // not valid until Client is set
181glslang::EShTargetLanguage TargetLanguage = glslang::EShTargetNone;
182glslang::EShTargetLanguageVersion TargetVersion; // not valid until TargetLanguage is set
183
John Kessenich66011cb2018-03-06 16:12:04 -0700184std::vector<std::string> Processes; // what should be recorded by OpModuleProcessed, or equivalent
John Kessenich68d78fd2015-07-12 19:28:10 -0600185
LoopDawg08a14422017-10-17 19:27:14 -0600186// Per descriptor-set binding base data
187typedef std::map<unsigned int, unsigned int> TPerSetBaseBinding;
188
Neil Roberts16f53472018-03-20 17:30:53 +0100189std::vector<std::pair<std::string, int>> uniformLocationOverrides;
Neil Robertsb0f3d792018-03-20 17:41:05 +0100190int uniformBase = 0;
Neil Roberts16f53472018-03-20 17:30:53 +0100191
LoopDawg08a14422017-10-17 19:27:14 -0600192std::array<std::array<unsigned int, EShLangCount>, glslang::EResCount> baseBinding;
193std::array<std::array<TPerSetBaseBinding, EShLangCount>, glslang::EResCount> baseBindingForSet;
Hyangran Park36dc8292017-05-02 16:27:29 +0900194std::array<std::vector<std::string>, EShLangCount> baseResourceSetBinding;
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600195
John Kessenicha9313662017-06-15 10:40:49 -0600196// Add things like "#define ..." to a preamble to use in the beginning of the shader.
197class TPreamble {
198public:
199 TPreamble() { }
200
201 bool isSet() const { return text.size() > 0; }
202 const char* get() const { return text.c_str(); }
203
204 // #define...
205 void addDef(std::string def)
206 {
207 text.append("#define ");
208 fixLine(def);
209
John Kessenich6f988922020-01-07 07:03:11 -0700210 Processes.push_back("define-macro ");
John Kessenich2a271162017-07-20 20:00:36 -0600211 Processes.back().append(def);
212
John Kessenicha9313662017-06-15 10:40:49 -0600213 // The first "=" needs to turn into a space
LoopDawgb97b25e2017-07-12 09:04:39 -0600214 const size_t equal = def.find_first_of("=");
John Kessenicha9313662017-06-15 10:40:49 -0600215 if (equal != def.npos)
216 def[equal] = ' ';
217
218 text.append(def);
219 text.append("\n");
220 }
221
222 // #undef...
223 void addUndef(std::string undef)
224 {
225 text.append("#undef ");
226 fixLine(undef);
John Kessenich2a271162017-07-20 20:00:36 -0600227
John Kessenich6f988922020-01-07 07:03:11 -0700228 Processes.push_back("undef-macro ");
John Kessenich2a271162017-07-20 20:00:36 -0600229 Processes.back().append(undef);
230
John Kessenicha9313662017-06-15 10:40:49 -0600231 text.append(undef);
232 text.append("\n");
233 }
234
235protected:
236 void fixLine(std::string& line)
237 {
238 // Can't go past a newline in the line
LoopDawgb97b25e2017-07-12 09:04:39 -0600239 const size_t end = line.find_first_of("\n");
John Kessenicha9313662017-06-15 10:40:49 -0600240 if (end != line.npos)
241 line = line.substr(0, end);
242 }
243
244 std::string text; // contents of preamble
245};
246
John Kessenich83855b92020-03-30 00:27:31 -0600247// Track the user's #define and #undef from the command line.
John Kessenicha9313662017-06-15 10:40:49 -0600248TPreamble UserPreamble;
249
John Kessenich68d78fd2015-07-12 19:28:10 -0600250//
251// Create the default name for saving a binary if -o is not provided.
252//
253const char* GetBinaryName(EShLanguage stage)
254{
255 const char* name;
256 if (binaryFileName == nullptr) {
257 switch (stage) {
258 case EShLangVertex: name = "vert.spv"; break;
259 case EShLangTessControl: name = "tesc.spv"; break;
260 case EShLangTessEvaluation: name = "tese.spv"; break;
261 case EShLangGeometry: name = "geom.spv"; break;
262 case EShLangFragment: name = "frag.spv"; break;
263 case EShLangCompute: name = "comp.spv"; break;
Daniel Kochdb32b242020-03-17 20:42:47 -0400264 case EShLangRayGen: name = "rgen.spv"; break;
265 case EShLangIntersect: name = "rint.spv"; break;
266 case EShLangAnyHit: name = "rahit.spv"; break;
267 case EShLangClosestHit: name = "rchit.spv"; break;
268 case EShLangMiss: name = "rmiss.spv"; break;
269 case EShLangCallable: name = "rcall.spv"; break;
Chao Chen3c366992018-09-19 11:41:59 -0700270 case EShLangMeshNV: name = "mesh.spv"; break;
271 case EShLangTaskNV: name = "task.spv"; break;
John Kessenich68d78fd2015-07-12 19:28:10 -0600272 default: name = "unknown"; break;
273 }
274 } else
275 name = binaryFileName;
276
277 return name;
278}
John Kessenich2b07c7e2013-07-31 18:44:13 +0000279
John Kessenich05a70632013-09-17 19:26:08 +0000280//
281// *.conf => this is a config file that can set limits/resources
282//
283bool SetConfigFile(const std::string& name)
284{
285 if (name.size() < 5)
286 return false;
287
John Kessenich4c706852013-10-11 16:28:43 +0000288 if (name.compare(name.size() - 5, 5, ".conf") == 0) {
John Kessenich05a70632013-09-17 19:26:08 +0000289 ConfigFile = name;
290 return true;
291 }
292
293 return false;
294}
295
John Kessenich68d78fd2015-07-12 19:28:10 -0600296//
297// Give error and exit with failure code.
298//
John Kessenichbd97b6f2019-12-20 10:33:13 -0700299void Error(const char* message, const char* detail = nullptr)
John Kessenich68d78fd2015-07-12 19:28:10 -0600300{
John Kessenichbd97b6f2019-12-20 10:33:13 -0700301 fprintf(stderr, "%s: Error: ", ExecutableName);
302 if (detail != nullptr)
303 fprintf(stderr, "%s: ", detail);
304 fprintf(stderr, "%s (use -h for usage)\n", message);
John Kessenich68d78fd2015-07-12 19:28:10 -0600305 exit(EFailUsage);
306}
307
308//
LoopDawg08a14422017-10-17 19:27:14 -0600309// Process an optional binding base of one the forms:
310// --argname [stage] base // base for stage (if given) or all stages (if not)
LoopDawge5709552017-10-21 10:46:39 -0600311// --argname [stage] [base set]... // set/base pairs: set the base for given binding set.
LoopDawg08a14422017-10-17 19:27:14 -0600312
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600313// Where stage is one of the forms accepted by FindLanguage, and base is an integer
314//
LoopDawg08a14422017-10-17 19:27:14 -0600315void ProcessBindingBase(int& argc, char**& argv, glslang::TResourceType res)
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600316{
317 if (argc < 2)
318 usage();
319
LoopDawg08a14422017-10-17 19:27:14 -0600320 EShLanguage lang = EShLangCount;
321 int singleBase = 0;
322 TPerSetBaseBinding perSetBase;
323 int arg = 1;
324
325 // Parse stage, if given
326 if (!isdigit(argv[arg][0])) {
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600327 if (argc < 3) // this form needs one more argument
328 usage();
John Kessenichecba76f2017-01-06 00:34:48 -0700329
LoopDawg08a14422017-10-17 19:27:14 -0600330 lang = FindLanguage(argv[arg++], false);
331 }
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600332
LoopDawg08a14422017-10-17 19:27:14 -0600333 if ((argc - arg) > 2 && isdigit(argv[arg+0][0]) && isdigit(argv[arg+1][0])) {
334 // Parse a per-set binding base
335 while ((argc - arg) > 2 && isdigit(argv[arg+0][0]) && isdigit(argv[arg+1][0])) {
LoopDawg08a14422017-10-17 19:27:14 -0600336 const int baseNum = atoi(argv[arg++]);
LoopDawge5709552017-10-21 10:46:39 -0600337 const int setNum = atoi(argv[arg++]);
LoopDawg08a14422017-10-17 19:27:14 -0600338 perSetBase[setNum] = baseNum;
339 }
340 } else {
341 // Parse single binding base
342 singleBase = atoi(argv[arg++]);
343 }
344
345 argc -= (arg-1);
346 argv += (arg-1);
347
348 // Set one or all languages
349 const int langMin = (lang < EShLangCount) ? lang+0 : 0;
350 const int langMax = (lang < EShLangCount) ? lang+1 : EShLangCount;
351
352 for (int lang = langMin; lang < langMax; ++lang) {
353 if (!perSetBase.empty())
John Kessenich251901a2018-08-12 22:05:59 -0600354 baseBindingForSet[res][lang].insert(perSetBase.begin(), perSetBase.end());
LoopDawg08a14422017-10-17 19:27:14 -0600355 else
356 baseBinding[res][lang] = singleBase;
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600357 }
358}
359
Hyangran Park36dc8292017-05-02 16:27:29 +0900360void ProcessResourceSetBindingBase(int& argc, char**& argv, std::array<std::vector<std::string>, EShLangCount>& base)
361{
362 if (argc < 2)
363 usage();
364
365 if (!isdigit(argv[1][0])) {
LoopDawg52017192017-07-14 15:15:47 -0600366 if (argc < 3) // this form needs one more argument
Hyangran Park36dc8292017-05-02 16:27:29 +0900367 usage();
368
LoopDawg52017192017-07-14 15:15:47 -0600369 // Parse form: --argname stage [regname set base...], or:
370 // --argname stage set
Hyangran Park36dc8292017-05-02 16:27:29 +0900371 const EShLanguage lang = FindLanguage(argv[1], false);
372
LoopDawg52017192017-07-14 15:15:47 -0600373 argc--;
374 argv++;
375
376 while (argc > 1 && argv[1] != nullptr && argv[1][0] != '-') {
377 base[lang].push_back(argv[1]);
378
379 argc--;
380 argv++;
Hyangran Park36dc8292017-05-02 16:27:29 +0900381 }
LoopDawg52017192017-07-14 15:15:47 -0600382
383 // Must have one arg, or a multiple of three (for [regname set binding] triples)
384 if (base[lang].size() != 1 && (base[lang].size() % 3) != 0)
385 usage();
386
Hyangran Park36dc8292017-05-02 16:27:29 +0900387 } else {
LoopDawg52017192017-07-14 15:15:47 -0600388 // Parse form: --argname set
Hyangran Park36dc8292017-05-02 16:27:29 +0900389 for (int lang=0; lang<EShLangCount; ++lang)
390 base[lang].push_back(argv[1]);
391
392 argc--;
393 argv++;
394 }
395}
396
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600397//
John Kessenich68d78fd2015-07-12 19:28:10 -0600398// Do all command-line argument parsing. This includes building up the work-items
399// to be processed later, and saving all the command-line options.
400//
401// Does not return (it exits) if command-line is fatally flawed.
402//
Juan Lopeza558b262017-04-02 23:04:00 +0200403void ProcessArguments(std::vector<std::unique_ptr<glslang::TWorkItem>>& workItems, int argc, char* argv[])
John Kessenich2b07c7e2013-07-31 18:44:13 +0000404{
LoopDawg08a14422017-10-17 19:27:14 -0600405 for (int res = 0; res < glslang::EResCount; ++res)
406 baseBinding[res].fill(0);
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600407
John Kessenich38f3b892013-09-06 19:52:57 +0000408 ExecutableName = argv[0];
Juan Lopeza558b262017-04-02 23:04:00 +0200409 workItems.reserve(argc);
John Kessenich38f3b892013-09-06 19:52:57 +0000410
John Kessenichc178f0a2017-06-23 10:58:31 -0600411 const auto bumpArg = [&]() {
412 if (argc > 0) {
413 argc--;
414 argv++;
415 }
416 };
417
418 // read a string directly attached to a single-letter option
John Kessenich6263fb12017-06-14 15:52:44 -0600419 const auto getStringOperand = [&](const char* desc) {
420 if (argv[0][2] == 0) {
421 printf("%s must immediately follow option (no spaces)\n", desc);
422 exit(EFailUsage);
423 }
424 return argv[0] + 2;
425 };
426
John Kessenich6353d552017-06-23 11:11:09 -0600427 // read a number attached to a single-letter option
428 const auto getAttachedNumber = [&](const char* desc) {
429 int num = atoi(argv[0] + 2);
430 if (num == 0) {
431 printf("%s: expected attached non-0 number\n", desc);
432 exit(EFailUsage);
433 }
434 return num;
435 };
436
437 // minimum needed (without overriding something else) to target Vulkan SPIR-V
438 const auto setVulkanSpv = []() {
John Kessenich8717a5d2018-10-26 10:12:32 -0600439 if (Client == glslang::EShClientNone)
440 ClientVersion = glslang::EShTargetVulkan_1_0;
441 Client = glslang::EShClientVulkan;
John Kessenich6353d552017-06-23 11:11:09 -0600442 Options |= EOptionSpv;
443 Options |= EOptionVulkanRules;
444 Options |= EOptionLinkProgram;
445 };
446
447 // minimum needed (without overriding something else) to target OpenGL SPIR-V
448 const auto setOpenGlSpv = []() {
John Kessenich8717a5d2018-10-26 10:12:32 -0600449 if (Client == glslang::EShClientNone)
450 ClientVersion = glslang::EShTargetOpenGL_450;
451 Client = glslang::EShClientOpenGL;
John Kessenich6353d552017-06-23 11:11:09 -0600452 Options |= EOptionSpv;
453 Options |= EOptionLinkProgram;
454 // undo a -H default to Vulkan
455 Options &= ~EOptionVulkanRules;
456 };
457
Neil Roberts16f53472018-03-20 17:30:53 +0100458 const auto getUniformOverride = [getStringOperand]() {
459 const char *arg = getStringOperand("-u<name>:<location>");
460 const char *split = strchr(arg, ':');
461 if (split == NULL) {
462 printf("%s: missing location\n", arg);
463 exit(EFailUsage);
464 }
465 errno = 0;
466 int location = ::strtol(split + 1, NULL, 10);
467 if (errno) {
468 printf("%s: invalid location\n", arg);
469 exit(EFailUsage);
470 }
471 return std::make_pair(std::string(arg, split - arg), location);
472 };
473
John Kessenichc178f0a2017-06-23 10:58:31 -0600474 for (bumpArg(); argc >= 1; bumpArg()) {
John Kessenich2b07c7e2013-07-31 18:44:13 +0000475 if (argv[0][0] == '-') {
John Kessenich2aa7f3a2015-05-15 16:02:07 +0000476 switch (argv[0][1]) {
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600477 case '-':
478 {
479 std::string lowerword(argv[0]+2);
480 std::transform(lowerword.begin(), lowerword.end(), lowerword.begin(), ::tolower);
481
482 // handle --word style options
John Kessenich6263fb12017-06-14 15:52:44 -0600483 if (lowerword == "auto-map-bindings" || // synonyms
John Kessenich6353d552017-06-23 11:11:09 -0600484 lowerword == "auto-map-binding" ||
485 lowerword == "amb") {
John Kessenich6263fb12017-06-14 15:52:44 -0600486 Options |= EOptionAutoMapBindings;
487 } else if (lowerword == "auto-map-locations" || // synonyms
488 lowerword == "aml") {
489 Options |= EOptionAutoMapLocations;
Neil Robertsb0f3d792018-03-20 17:41:05 +0100490 } else if (lowerword == "uniform-base") {
491 if (argc <= 1)
John Kessenichbd97b6f2019-12-20 10:33:13 -0700492 Error("no <base> provided", lowerword.c_str());
Neil Robertsb0f3d792018-03-20 17:41:05 +0100493 uniformBase = ::strtol(argv[1], NULL, 10);
494 bumpArg();
495 break;
John Kessenich6353d552017-06-23 11:11:09 -0600496 } else if (lowerword == "client") {
497 if (argc > 1) {
498 if (strcmp(argv[1], "vulkan100") == 0)
499 setVulkanSpv();
500 else if (strcmp(argv[1], "opengl100") == 0)
501 setOpenGlSpv();
502 else
John Kessenichbd97b6f2019-12-20 10:33:13 -0700503 Error("expects vulkan100 or opengl100", lowerword.c_str());
504 } else
505 Error("expects vulkan100 or opengl100", lowerword.c_str());
John Kessenich6353d552017-06-23 11:11:09 -0600506 bumpArg();
John Kessenich6f988922020-01-07 07:03:11 -0700507 } else if (lowerword == "define-macro" ||
508 lowerword == "d") {
509 if (argc > 1)
510 UserPreamble.addDef(argv[1]);
511 else
512 Error("expects <name[=def]>", argv[0]);
513 bumpArg();
Christoph Kubisch55ba3ea2019-04-13 22:18:16 +0200514 } else if (lowerword == "dump-builtin-symbols") {
515 DumpBuiltinSymbols = true;
John Kessenich640bd092018-08-09 14:15:00 -0600516 } else if (lowerword == "entry-point") {
517 entryPointName = argv[1];
518 if (argc <= 1)
John Kessenichbd97b6f2019-12-20 10:33:13 -0700519 Error("no <name> provided", lowerword.c_str());
John Kessenich640bd092018-08-09 14:15:00 -0600520 bumpArg();
John Kessenich6263fb12017-06-14 15:52:44 -0600521 } else if (lowerword == "flatten-uniform-arrays" || // synonyms
522 lowerword == "flatten-uniform-array" ||
523 lowerword == "fua") {
524 Options |= EOptionFlattenUniformArrays;
525 } else if (lowerword == "hlsl-offsets") {
526 Options |= EOptionHlslOffsets;
527 } else if (lowerword == "hlsl-iomap" ||
528 lowerword == "hlsl-iomapper" ||
529 lowerword == "hlsl-iomapping") {
530 Options |= EOptionHlslIoMapping;
Rex Xucb61eec2018-03-07 13:10:01 +0800531 } else if (lowerword == "hlsl-enable-16bit-types") {
532 HlslEnable16BitTypes = true;
John Kessenichbd1c1832018-12-07 18:38:26 -0700533 } else if (lowerword == "hlsl-dx9-compatible") {
534 HlslDX9compatible = true;
John Kessenichc6c80a62018-03-05 22:23:17 -0700535 } else if (lowerword == "invert-y" || // synonyms
536 lowerword == "iy") {
537 Options |= EOptionInvertY;
John Kessenich6263fb12017-06-14 15:52:44 -0600538 } else if (lowerword == "keep-uncalled" || // synonyms
539 lowerword == "ku") {
540 Options |= EOptionKeepUncalled;
John Kessenich605afc72019-06-17 23:33:09 -0600541 } else if (lowerword == "nan-clamp") {
542 NaNClamp = true;
John Kessenich6263fb12017-06-14 15:52:44 -0600543 } else if (lowerword == "no-storage-format" || // synonyms
544 lowerword == "nsf") {
545 Options |= EOptionNoStorageFormat;
John Kessenich2a271162017-07-20 20:00:36 -0600546 } else if (lowerword == "relaxed-errors") {
547 Options |= EOptionRelaxedErrors;
baldurk15c37f72019-01-29 12:12:59 +0000548 } else if (lowerword == "reflect-strict-array-suffix") {
549 ReflectOptions |= EShReflectionStrictArraySuffix;
baldurkedf82122019-01-29 15:49:00 +0000550 } else if (lowerword == "reflect-basic-array-suffix") {
551 ReflectOptions |= EShReflectionBasicArraySuffix;
baldurk0af5e3e2019-01-29 16:04:44 +0000552 } else if (lowerword == "reflect-intermediate-io") {
553 ReflectOptions |= EShReflectionIntermediateIO;
baldurk657acc02019-01-30 14:18:43 +0000554 } else if (lowerword == "reflect-separate-buffers") {
555 ReflectOptions |= EShReflectionSeparateBuffers;
baldurka972e732019-01-30 15:34:02 +0000556 } else if (lowerword == "reflect-all-block-variables") {
557 ReflectOptions |= EShReflectionAllBlockVariables;
baldurk19050692019-02-11 11:50:24 +0000558 } else if (lowerword == "reflect-unwrap-io-blocks") {
559 ReflectOptions |= EShReflectionUnwrapIOBlocks;
Chow81112682020-06-04 15:47:18 +0800560 } else if (lowerword == "reflect-all-io-variables") {
561 ReflectOptions |= EShReflectionAllIOVariables;
562 } else if (lowerword == "reflect-shared-std140-ubo") {
563 ReflectOptions |= EShReflectionSharedStd140UBO;
564 } else if (lowerword == "reflect-shared-std140-ssbo") {
565 ReflectOptions |= EShReflectionSharedStd140SSBO;
John Kessenich6263fb12017-06-14 15:52:44 -0600566 } else if (lowerword == "resource-set-bindings" || // synonyms
567 lowerword == "resource-set-binding" ||
568 lowerword == "rsb") {
569 ProcessResourceSetBindingBase(argc, argv, baseResourceSetBinding);
steve-lunarg9088be42016-11-01 10:31:42 -0600570 } else if (lowerword == "shift-image-bindings" || // synonyms
571 lowerword == "shift-image-binding" ||
572 lowerword == "sib") {
LoopDawg08a14422017-10-17 19:27:14 -0600573 ProcessBindingBase(argc, argv, glslang::EResImage);
John Kessenich6263fb12017-06-14 15:52:44 -0600574 } else if (lowerword == "shift-sampler-bindings" || // synonyms
John Kessenichade8bbb2018-08-12 21:24:55 -0600575 lowerword == "shift-sampler-binding" ||
576 lowerword == "ssb") {
LoopDawg08a14422017-10-17 19:27:14 -0600577 ProcessBindingBase(argc, argv, glslang::EResSampler);
John Kessenich6263fb12017-06-14 15:52:44 -0600578 } else if (lowerword == "shift-uav-bindings" || // synonyms
579 lowerword == "shift-uav-binding" ||
580 lowerword == "suavb") {
LoopDawg08a14422017-10-17 19:27:14 -0600581 ProcessBindingBase(argc, argv, glslang::EResUav);
John Kessenich6263fb12017-06-14 15:52:44 -0600582 } else if (lowerword == "shift-texture-bindings" || // synonyms
583 lowerword == "shift-texture-binding" ||
584 lowerword == "stb") {
LoopDawg08a14422017-10-17 19:27:14 -0600585 ProcessBindingBase(argc, argv, glslang::EResTexture);
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600586 } else if (lowerword == "shift-ubo-bindings" || // synonyms
587 lowerword == "shift-ubo-binding" ||
steve-lunargbe283552017-04-18 12:18:01 -0600588 lowerword == "shift-cbuffer-bindings" ||
589 lowerword == "shift-cbuffer-binding" ||
590 lowerword == "sub" ||
591 lowerword == "scb") {
LoopDawg08a14422017-10-17 19:27:14 -0600592 ProcessBindingBase(argc, argv, glslang::EResUbo);
steve-lunarg932bb5c2017-02-21 17:19:08 -0700593 } else if (lowerword == "shift-ssbo-bindings" || // synonyms
594 lowerword == "shift-ssbo-binding" ||
595 lowerword == "sbb") {
LoopDawg08a14422017-10-17 19:27:14 -0600596 ProcessBindingBase(argc, argv, glslang::EResSsbo);
John Kessenich6263fb12017-06-14 15:52:44 -0600597 } else if (lowerword == "source-entrypoint" || // synonyms
598 lowerword == "sep") {
John Kessenichc178f0a2017-06-23 10:58:31 -0600599 if (argc <= 1)
John Kessenichbd97b6f2019-12-20 10:33:13 -0700600 Error("no <entry-point> provided", lowerword.c_str());
John Kessenichc178f0a2017-06-23 10:58:31 -0600601 sourceEntryPointName = argv[1];
602 bumpArg();
John Kessenich6263fb12017-06-14 15:52:44 -0600603 break;
John Kesseniche2156222018-06-11 18:12:15 -0600604 } else if (lowerword == "spirv-dis") {
605 SpvToolsDisassembler = true;
John Kessenichc3404252018-08-23 15:29:08 -0600606 } else if (lowerword == "spirv-val") {
607 SpvToolsValidate = true;
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +0200608 } else if (lowerword == "stdin") {
609 Options |= EOptionStdin;
610 shaderStageName = argv[1];
John Kessenich2a271162017-07-20 20:00:36 -0600611 } else if (lowerword == "suppress-warnings") {
612 Options |= EOptionSuppressWarnings;
John Kessenich6353d552017-06-23 11:11:09 -0600613 } else if (lowerword == "target-env") {
614 if (argc > 1) {
615 if (strcmp(argv[1], "vulkan1.0") == 0) {
616 setVulkanSpv();
John Kessenich8717a5d2018-10-26 10:12:32 -0600617 ClientVersion = glslang::EShTargetVulkan_1_0;
John Kessenich66011cb2018-03-06 16:12:04 -0700618 } else if (strcmp(argv[1], "vulkan1.1") == 0) {
619 setVulkanSpv();
John Kessenich8717a5d2018-10-26 10:12:32 -0600620 ClientVersion = glslang::EShTargetVulkan_1_1;
John Kessenich273d3a52020-01-15 00:10:41 -0700621 } else if (strcmp(argv[1], "vulkan1.2") == 0) {
622 setVulkanSpv();
623 ClientVersion = glslang::EShTargetVulkan_1_2;
John Kessenich6353d552017-06-23 11:11:09 -0600624 } else if (strcmp(argv[1], "opengl") == 0) {
625 setOpenGlSpv();
John Kessenich8717a5d2018-10-26 10:12:32 -0600626 ClientVersion = glslang::EShTargetOpenGL_450;
627 } else if (strcmp(argv[1], "spirv1.0") == 0) {
628 TargetLanguage = glslang::EShTargetSpv;
629 TargetVersion = glslang::EShTargetSpv_1_0;
630 } else if (strcmp(argv[1], "spirv1.1") == 0) {
631 TargetLanguage = glslang::EShTargetSpv;
632 TargetVersion = glslang::EShTargetSpv_1_1;
633 } else if (strcmp(argv[1], "spirv1.2") == 0) {
634 TargetLanguage = glslang::EShTargetSpv;
635 TargetVersion = glslang::EShTargetSpv_1_2;
636 } else if (strcmp(argv[1], "spirv1.3") == 0) {
637 TargetLanguage = glslang::EShTargetSpv;
638 TargetVersion = glslang::EShTargetSpv_1_3;
639 } else if (strcmp(argv[1], "spirv1.4") == 0) {
640 TargetLanguage = glslang::EShTargetSpv;
641 TargetVersion = glslang::EShTargetSpv_1_4;
John Kessenich8317e6c2019-08-18 23:58:08 -0600642 } else if (strcmp(argv[1], "spirv1.5") == 0) {
643 TargetLanguage = glslang::EShTargetSpv;
644 TargetVersion = glslang::EShTargetSpv_1_5;
John Kessenich6353d552017-06-23 11:11:09 -0600645 } else
John Kessenich273d3a52020-01-15 00:10:41 -0700646 Error("--target-env expected one of: vulkan1.0, vulkan1.1, vulkan1.2, opengl,\n"
John Kessenich8317e6c2019-08-18 23:58:08 -0600647 "spirv1.0, spirv1.1, spirv1.2, spirv1.3, spirv1.4, or spirv1.5");
John Kessenich6353d552017-06-23 11:11:09 -0600648 }
649 bumpArg();
John Kessenich6f988922020-01-07 07:03:11 -0700650 } else if (lowerword == "undef-macro" ||
651 lowerword == "u") {
652 if (argc > 1)
653 UserPreamble.addUndef(argv[1]);
654 else
655 Error("expects <name>", argv[0]);
656 bumpArg();
Flavio15017db2017-02-15 14:29:33 -0800657 } else if (lowerword == "variable-name" || // synonyms
John Kessenich66011cb2018-03-06 16:12:04 -0700658 lowerword == "vn") {
Flavio15017db2017-02-15 14:29:33 -0800659 Options |= EOptionOutputHexadecimal;
John Kessenichc178f0a2017-06-23 10:58:31 -0600660 if (argc <= 1)
John Kessenichbd97b6f2019-12-20 10:33:13 -0700661 Error("no <C-variable-name> provided", lowerword.c_str());
John Kessenichc178f0a2017-06-23 10:58:31 -0600662 variableName = argv[1];
663 bumpArg();
Flavio15017db2017-02-15 14:29:33 -0800664 break;
Marcin Åšlusarz245c30c2020-07-03 14:55:29 +0200665 } else if (lowerword == "quiet") {
666 beQuiet = true;
John Kessenichc6c80a62018-03-05 22:23:17 -0700667 } else if (lowerword == "version") {
668 Options |= EOptionDumpVersions;
Jordan Justen6ad120e2020-01-28 12:18:12 -0800669 } else if (lowerword == "help") {
670 usage();
671 break;
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600672 } else {
John Kessenichbd97b6f2019-12-20 10:33:13 -0700673 Error("unrecognized command-line option", argv[0]);
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600674 }
675 }
676 break;
John Kessenich6263fb12017-06-14 15:52:44 -0600677 case 'C':
678 Options |= EOptionCascadingErrors;
679 break;
680 case 'D':
John Kessenicha9313662017-06-15 10:40:49 -0600681 if (argv[0][2] == 0)
682 Options |= EOptionReadHlsl;
683 else
John Kessenich6f988922020-01-07 07:03:11 -0700684 UserPreamble.addDef(getStringOperand("-D<name[=def]>"));
John Kessenich6263fb12017-06-14 15:52:44 -0600685 break;
Neil Roberts16f53472018-03-20 17:30:53 +0100686 case 'u':
687 uniformLocationOverrides.push_back(getUniformOverride());
688 break;
John Kessenich6263fb12017-06-14 15:52:44 -0600689 case 'E':
690 Options |= EOptionOutputPreprocessed;
691 break;
692 case 'G':
John Kessenich8717a5d2018-10-26 10:12:32 -0600693 // OpenGL client
John Kessenich6353d552017-06-23 11:11:09 -0600694 setOpenGlSpv();
695 if (argv[0][2] != 0)
696 ClientInputSemanticsVersion = getAttachedNumber("-G<num> client input semantics");
John Kessenich6263fb12017-06-14 15:52:44 -0600697 break;
John Kessenich2aa7f3a2015-05-15 16:02:07 +0000698 case 'H':
699 Options |= EOptionHumanReadableSpv;
John Kessenich91e4aa52016-07-07 17:46:42 -0600700 if ((Options & EOptionSpv) == 0) {
701 // default to Vulkan
John Kessenich6353d552017-06-23 11:11:09 -0600702 setVulkanSpv();
John Kessenich91e4aa52016-07-07 17:46:42 -0600703 }
704 break;
John Kessenich971a0a82017-06-07 15:06:58 -0600705 case 'I':
John Kessenicha9313662017-06-15 10:40:49 -0600706 IncludeDirectoryList.push_back(getStringOperand("-I<dir> include path"));
John Kessenich68d78fd2015-07-12 19:28:10 -0600707 break;
GregFcd1f1692017-09-21 18:40:22 -0600708 case 'O':
709 if (argv[0][2] == 'd')
710 Options |= EOptionOptimizeDisable;
711 else if (argv[0][2] == 's')
GregFfb03a552018-03-29 11:49:14 -0600712#if ENABLE_OPT
GregFcd1f1692017-09-21 18:40:22 -0600713 Options |= EOptionOptimizeSize;
714#else
715 Error("-Os not available; optimizer not linked");
716#endif
717 else
718 Error("unknown -O option");
719 break;
Dan Baker5afdd782016-08-11 17:53:57 -0400720 case 'S':
John Kessenichc178f0a2017-06-23 10:58:31 -0600721 if (argc <= 1)
Dan Baker5afdd782016-08-11 17:53:57 -0400722 Error("no <stage> specified for -S");
John Kessenichc178f0a2017-06-23 10:58:31 -0600723 shaderStageName = argv[1];
724 bumpArg();
dankbaker45d49bc2016-08-08 21:43:07 -0400725 break;
John Kessenicha9313662017-06-15 10:40:49 -0600726 case 'U':
John Kessenich6f988922020-01-07 07:03:11 -0700727 UserPreamble.addUndef(getStringOperand("-U<name>"));
John Kessenicha9313662017-06-15 10:40:49 -0600728 break;
John Kessenich6263fb12017-06-14 15:52:44 -0600729 case 'V':
John Kessenich6353d552017-06-23 11:11:09 -0600730 setVulkanSpv();
731 if (argv[0][2] != 0)
David Neto506d2c22018-02-27 21:55:23 -0500732 ClientInputSemanticsVersion = getAttachedNumber("-V<num> client input semantics");
John Kessenichc555ddd2015-06-17 02:38:44 +0000733 break;
John Kessenich05a70632013-09-17 19:26:08 +0000734 case 'c':
735 Options |= EOptionDumpConfig;
736 break;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000737 case 'd':
John Kessenichc6c80a62018-03-05 22:23:17 -0700738 if (strncmp(&argv[0][1], "dumpversion", strlen(&argv[0][1]) + 1) == 0 ||
739 strncmp(&argv[0][1], "dumpfullversion", strlen(&argv[0][1]) + 1) == 0)
740 Options |= EOptionDumpBareVersion;
741 else
742 Options |= EOptionDefaultDesktop;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000743 break;
John Kessenich4d65ee32016-03-12 18:17:47 -0700744 case 'e':
John Kessenich4d65ee32016-03-12 18:17:47 -0700745 entryPointName = argv[1];
John Kessenichc178f0a2017-06-23 10:58:31 -0600746 if (argc <= 1)
John Kessenicha25530c2017-09-11 20:13:49 -0600747 Error("no <name> provided for -e");
John Kessenichc178f0a2017-06-23 10:58:31 -0600748 bumpArg();
John Kessenich4d65ee32016-03-12 18:17:47 -0700749 break;
John Kessenich5d610ee2018-03-07 18:05:55 -0700750 case 'f':
751 if (strcmp(&argv[0][2], "hlsl_functionality1") == 0)
752 targetHlslFunctionality1 = true;
753 else
754 Error("-f: expected hlsl_functionality1");
755 break;
John Kessenich121853f2017-05-31 17:11:16 -0600756 case 'g':
Shahbaz Youssefid52dce52020-06-17 12:47:44 -0400757 // Override previous -g or -g0 argument
758 stripDebugInfo = false;
759 Options &= ~EOptionDebug;
760 if (argv[0][2] == '0')
761 stripDebugInfo = true;
762 else
763 Options |= EOptionDebug;
John Kessenich121853f2017-05-31 17:11:16 -0600764 break;
John Kessenich68d78fd2015-07-12 19:28:10 -0600765 case 'h':
766 usage();
767 break;
John Kessenich05a70632013-09-17 19:26:08 +0000768 case 'i':
John Kessenich94a81fb2013-08-31 02:41:30 +0000769 Options |= EOptionIntermediate;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000770 break;
771 case 'l':
John Kessenichd78e3512014-08-25 20:07:55 +0000772 Options |= EOptionLinkProgram;
John Kessenich94a81fb2013-08-31 02:41:30 +0000773 break;
774 case 'm':
775 Options |= EOptionMemoryLeakMode;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000776 break;
John Kessenich68d78fd2015-07-12 19:28:10 -0600777 case 'o':
John Kessenichc178f0a2017-06-23 10:58:31 -0600778 if (argc <= 1)
John Kessenich68d78fd2015-07-12 19:28:10 -0600779 Error("no <file> provided for -o");
John Kessenichc178f0a2017-06-23 10:58:31 -0600780 binaryFileName = argv[1];
781 bumpArg();
John Kessenich68d78fd2015-07-12 19:28:10 -0600782 break;
John Kessenich11f9fc72013-11-07 01:06:34 +0000783 case 'q':
784 Options |= EOptionDumpReflection;
785 break;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000786 case 'r':
John Kessenich94a81fb2013-08-31 02:41:30 +0000787 Options |= EOptionRelaxedErrors;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000788 break;
789 case 's':
John Kessenich94a81fb2013-08-31 02:41:30 +0000790 Options |= EOptionSuppressInfolog;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000791 break;
John Kessenich38f3b892013-09-06 19:52:57 +0000792 case 't':
Juan Lopeza558b262017-04-02 23:04:00 +0200793 Options |= EOptionMultiThreaded;
John Kessenich38f3b892013-09-06 19:52:57 +0000794 break;
John Kessenich319de232013-12-04 04:43:40 +0000795 case 'v':
796 Options |= EOptionDumpVersions;
797 break;
John Kessenichb0a7eb52013-11-07 17:44:20 +0000798 case 'w':
799 Options |= EOptionSuppressWarnings;
800 break;
Johannes van Waverenecb0f3b2016-05-27 12:55:53 -0500801 case 'x':
802 Options |= EOptionOutputHexadecimal;
Johannes van Waverenecb0f3b2016-05-27 12:55:53 -0500803 break;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000804 default:
John Kessenichbd97b6f2019-12-20 10:33:13 -0700805 Error("unrecognized command-line option", argv[0]);
John Kessenich68d78fd2015-07-12 19:28:10 -0600806 break;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000807 }
John Kessenich38f3b892013-09-06 19:52:57 +0000808 } else {
John Kessenich05a70632013-09-17 19:26:08 +0000809 std::string name(argv[0]);
810 if (! SetConfigFile(name)) {
Juan Lopeza558b262017-04-02 23:04:00 +0200811 workItems.push_back(std::unique_ptr<glslang::TWorkItem>(new glslang::TWorkItem(name)));
John Kessenich05a70632013-09-17 19:26:08 +0000812 }
John Kessenich38f3b892013-09-06 19:52:57 +0000813 }
John Kessenich2b07c7e2013-07-31 18:44:13 +0000814 }
815
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +0200816 // Make sure that -S is always specified if --stdin is specified
817 if ((Options & EOptionStdin) && shaderStageName == nullptr)
818 Error("must provide -S when --stdin is given");
819
John Kessenich68d78fd2015-07-12 19:28:10 -0600820 // Make sure that -E is not specified alongside linking (which includes SPV generation)
John Kesseniche5c394b2019-07-02 09:32:48 -0600821 // Or things that require linking
822 if (Options & EOptionOutputPreprocessed) {
823 if (Options & EOptionLinkProgram)
824 Error("can't use -E when linking is selected");
825 if (Options & EOptionDumpReflection)
826 Error("reflection requires linking, which can't be used when -E when is selected");
827 }
828
829 // reflection requires linking
830 if ((Options & EOptionDumpReflection) && !(Options & EOptionLinkProgram))
831 Error("reflection requires -l for linking");
John Kessenichc555ddd2015-06-17 02:38:44 +0000832
Johannes van Waverenecb0f3b2016-05-27 12:55:53 -0500833 // -o or -x makes no sense if there is no target binary
John Kessenich68d78fd2015-07-12 19:28:10 -0600834 if (binaryFileName && (Options & EOptionSpv) == 0)
835 Error("no binary generation requested (e.g., -V)");
steve-lunarge0b9deb2016-09-16 13:26:37 -0600836
837 if ((Options & EOptionFlattenUniformArrays) != 0 &&
838 (Options & EOptionReadHlsl) == 0)
839 Error("uniform array flattening only valid when compiling HLSL source.");
John Kessenich8717a5d2018-10-26 10:12:32 -0600840
841 // rationalize client and target language
842 if (TargetLanguage == glslang::EShTargetNone) {
843 switch (ClientVersion) {
844 case glslang::EShTargetVulkan_1_0:
845 TargetLanguage = glslang::EShTargetSpv;
846 TargetVersion = glslang::EShTargetSpv_1_0;
847 break;
848 case glslang::EShTargetVulkan_1_1:
849 TargetLanguage = glslang::EShTargetSpv;
850 TargetVersion = glslang::EShTargetSpv_1_3;
851 break;
John Kessenich273d3a52020-01-15 00:10:41 -0700852 case glslang::EShTargetVulkan_1_2:
853 TargetLanguage = glslang::EShTargetSpv;
854 TargetVersion = glslang::EShTargetSpv_1_5;
855 break;
John Kessenich8717a5d2018-10-26 10:12:32 -0600856 case glslang::EShTargetOpenGL_450:
857 TargetLanguage = glslang::EShTargetSpv;
858 TargetVersion = glslang::EShTargetSpv_1_0;
859 break;
860 default:
861 break;
862 }
863 }
864 if (TargetLanguage != glslang::EShTargetNone && Client == glslang::EShClientNone)
865 Error("To generate SPIR-V, also specify client semantics. See -G and -V.");
John Kessenich2b07c7e2013-07-31 18:44:13 +0000866}
867
John Kessenich68d78fd2015-07-12 19:28:10 -0600868//
869// Translate the meaningful subset of command-line options to parser-behavior options.
870//
John Kessenichb0a7eb52013-11-07 17:44:20 +0000871void SetMessageOptions(EShMessages& messages)
872{
873 if (Options & EOptionRelaxedErrors)
874 messages = (EShMessages)(messages | EShMsgRelaxedErrors);
875 if (Options & EOptionIntermediate)
876 messages = (EShMessages)(messages | EShMsgAST);
877 if (Options & EOptionSuppressWarnings)
878 messages = (EShMessages)(messages | EShMsgSuppressWarnings);
John Kessenich68d78fd2015-07-12 19:28:10 -0600879 if (Options & EOptionSpv)
880 messages = (EShMessages)(messages | EShMsgSpvRules);
881 if (Options & EOptionVulkanRules)
882 messages = (EShMessages)(messages | EShMsgVulkanRules);
Andrew Woloszynaae1ad82015-06-24 17:00:46 -0400883 if (Options & EOptionOutputPreprocessed)
884 messages = (EShMessages)(messages | EShMsgOnlyPreprocessor);
John Kessenich66e2faf2016-03-12 18:34:36 -0700885 if (Options & EOptionReadHlsl)
886 messages = (EShMessages)(messages | EShMsgReadHlsl);
John Kessenicha86836e2016-07-09 14:50:57 -0600887 if (Options & EOptionCascadingErrors)
888 messages = (EShMessages)(messages | EShMsgCascadingErrors);
John Kessenich906cc212016-12-09 19:22:20 -0700889 if (Options & EOptionKeepUncalled)
890 messages = (EShMessages)(messages | EShMsgKeepUncalled);
John Kessenich4f1403e2017-04-05 17:38:20 -0600891 if (Options & EOptionHlslOffsets)
892 messages = (EShMessages)(messages | EShMsgHlslOffsets);
John Kessenich121853f2017-05-31 17:11:16 -0600893 if (Options & EOptionDebug)
894 messages = (EShMessages)(messages | EShMsgDebugInfo);
Rex Xucb61eec2018-03-07 13:10:01 +0800895 if (HlslEnable16BitTypes)
896 messages = (EShMessages)(messages | EShMsgHlslEnable16BitTypes);
GregFfb03a552018-03-29 11:49:14 -0600897 if ((Options & EOptionOptimizeDisable) || !ENABLE_OPT)
898 messages = (EShMessages)(messages | EShMsgHlslLegalization);
John Kessenichbd1c1832018-12-07 18:38:26 -0700899 if (HlslDX9compatible)
900 messages = (EShMessages)(messages | EShMsgHlslDX9Compatible);
Christoph Kubisch55ba3ea2019-04-13 22:18:16 +0200901 if (DumpBuiltinSymbols)
902 messages = (EShMessages)(messages | EShMsgBuiltinSymbolTable);
John Kessenichb0a7eb52013-11-07 17:44:20 +0000903}
904
John Kessenich68d78fd2015-07-12 19:28:10 -0600905//
John Kessenich69f4b512013-09-04 21:19:27 +0000906// Thread entry point, for non-linking asynchronous mode.
John Kessenichc999ba22013-11-07 23:33:24 +0000907//
Juan Lopeza558b262017-04-02 23:04:00 +0200908void CompileShaders(glslang::TWorklist& worklist)
John Kessenich2b07c7e2013-07-31 18:44:13 +0000909{
John Kessenich7f0bcfd2018-04-05 19:00:01 -0600910 if (Options & EOptionDebug)
911 Error("cannot generate debug information unless linking to generate code");
912
John Kessenich38f3b892013-09-06 19:52:57 +0000913 glslang::TWorkItem* workItem;
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +0200914 if (Options & EOptionStdin) {
John Kesseniche7f9cae2018-07-12 15:11:07 -0600915 if (worklist.remove(workItem)) {
916 ShHandle compiler = ShConstructCompiler(FindLanguage("stdin"), Options);
917 if (compiler == nullptr)
918 return;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000919
John Kesseniche7f9cae2018-07-12 15:11:07 -0600920 CompileFile("stdin", compiler);
John Kessenich2b07c7e2013-07-31 18:44:13 +0000921
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +0200922 if (! (Options & EOptionSuppressInfolog))
923 workItem->results = ShGetInfoLog(compiler);
John Kessenich2b07c7e2013-07-31 18:44:13 +0000924
John Kesseniche7f9cae2018-07-12 15:11:07 -0600925 ShDestruct(compiler);
926 }
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +0200927 } else {
928 while (worklist.remove(workItem)) {
929 ShHandle compiler = ShConstructCompiler(FindLanguage(workItem->name), Options);
930 if (compiler == 0)
931 return;
932
933 CompileFile(workItem->name.c_str(), compiler);
934
935 if (! (Options & EOptionSuppressInfolog))
936 workItem->results = ShGetInfoLog(compiler);
937
938 ShDestruct(compiler);
939 }
John Kessenich2b07c7e2013-07-31 18:44:13 +0000940 }
John Kessenich2b07c7e2013-07-31 18:44:13 +0000941}
942
John Kessenich6626cad2015-06-19 05:14:19 +0000943// Outputs the given string, but only if it is non-null and non-empty.
944// This prevents erroneous newlines from appearing.
Andrew Woloszynaae1ad82015-06-24 17:00:46 -0400945void PutsIfNonEmpty(const char* str)
John Kessenich6626cad2015-06-19 05:14:19 +0000946{
947 if (str && str[0]) {
948 puts(str);
949 }
950}
951
Andrew Woloszynaae1ad82015-06-24 17:00:46 -0400952// Outputs the given string to stderr, but only if it is non-null and non-empty.
953// This prevents erroneous newlines from appearing.
954void StderrIfNonEmpty(const char* str)
955{
John Kessenich04acb1b2017-06-14 17:36:50 -0600956 if (str && str[0])
957 fprintf(stderr, "%s\n", str);
Andrew Woloszynaae1ad82015-06-24 17:00:46 -0400958}
959
John Kessenichc57b2a92016-01-16 15:30:03 -0700960// Simple bundling of what makes a compilation unit for ease in passing around,
961// and separation of handling file IO versus API (programmatic) compilation.
962struct ShaderCompUnit {
963 EShLanguage stage;
John Kessenich04acb1b2017-06-14 17:36:50 -0600964 static const int maxCount = 1;
965 int count; // live number of strings/names
John Kessenicha9313662017-06-15 10:40:49 -0600966 const char* text[maxCount]; // memory owned/managed externally
John Kessenich04acb1b2017-06-14 17:36:50 -0600967 std::string fileName[maxCount]; // hold's the memory, but...
968 const char* fileNameList[maxCount]; // downstream interface wants pointers
dankbakerafe6e9c2016-08-21 12:29:08 -0400969
John Kessenich04acb1b2017-06-14 17:36:50 -0600970 ShaderCompUnit(EShLanguage stage) : stage(stage), count(0) { }
dankbakerafe6e9c2016-08-21 12:29:08 -0400971
John Kessenich04acb1b2017-06-14 17:36:50 -0600972 ShaderCompUnit(const ShaderCompUnit& rhs)
dankbakerafe6e9c2016-08-21 12:29:08 -0400973 {
974 stage = rhs.stage;
John Kessenich04acb1b2017-06-14 17:36:50 -0600975 count = rhs.count;
976 for (int i = 0; i < count; ++i) {
977 fileName[i] = rhs.fileName[i];
978 text[i] = rhs.text[i];
979 fileNameList[i] = rhs.fileName[i].c_str();
980 }
dankbakerafe6e9c2016-08-21 12:29:08 -0400981 }
982
John Kessenicha9313662017-06-15 10:40:49 -0600983 void addString(std::string& ifileName, const char* itext)
John Kessenich04acb1b2017-06-14 17:36:50 -0600984 {
985 assert(count < maxCount);
986 fileName[count] = ifileName;
987 text[count] = itext;
988 fileNameList[count] = fileName[count].c_str();
989 ++count;
990 }
John Kessenichc57b2a92016-01-16 15:30:03 -0700991};
992
John Kessenich69f4b512013-09-04 21:19:27 +0000993//
John Kessenichc57b2a92016-01-16 15:30:03 -0700994// For linking mode: Will independently parse each compilation unit, but then put them
995// in the same program and link them together, making at most one linked module per
996// pipeline stage.
John Kessenich69f4b512013-09-04 21:19:27 +0000997//
998// Uses the new C++ interface instead of the old handle-based interface.
999//
John Kessenichc57b2a92016-01-16 15:30:03 -07001000
1001void CompileAndLinkShaderUnits(std::vector<ShaderCompUnit> compUnits)
John Kessenich69f4b512013-09-04 21:19:27 +00001002{
1003 // keep track of what to free
1004 std::list<glslang::TShader*> shaders;
John Kessenichc57b2a92016-01-16 15:30:03 -07001005
John Kessenich69f4b512013-09-04 21:19:27 +00001006 EShMessages messages = EShMsgDefault;
John Kessenichb0a7eb52013-11-07 17:44:20 +00001007 SetMessageOptions(messages);
John Kessenich69f4b512013-09-04 21:19:27 +00001008
John Kessenich69f4b512013-09-04 21:19:27 +00001009 //
1010 // Per-shader processing...
1011 //
1012
John Kessenich5b0f13a2013-11-01 03:08:40 +00001013 glslang::TProgram& program = *new glslang::TProgram;
rdb32084e82016-02-23 22:17:38 +01001014 for (auto it = compUnits.cbegin(); it != compUnits.cend(); ++it) {
1015 const auto &compUnit = *it;
John Kessenichc57b2a92016-01-16 15:30:03 -07001016 glslang::TShader* shader = new glslang::TShader(compUnit.stage);
John Kessenich04acb1b2017-06-14 17:36:50 -06001017 shader->setStringsWithLengthsAndNames(compUnit.text, NULL, compUnit.fileNameList, compUnit.count);
John Kessenich640bd092018-08-09 14:15:00 -06001018 if (entryPointName)
John Kessenich4d65ee32016-03-12 18:17:47 -07001019 shader->setEntryPoint(entryPointName);
John Kessenich3693e632017-09-29 17:51:52 -06001020 if (sourceEntryPointName) {
1021 if (entryPointName == nullptr)
1022 printf("Warning: Changing source entry point name without setting an entry-point name.\n"
1023 "Use '-e <name>'.\n");
steve-lunargf1e0c872016-10-31 15:13:43 -06001024 shader->setSourceEntryPoint(sourceEntryPointName);
John Kessenich3693e632017-09-29 17:51:52 -06001025 }
John Kessenicha9313662017-06-15 10:40:49 -06001026 if (UserPreamble.isSet())
1027 shader->setPreamble(UserPreamble.get());
John Kessenich2a271162017-07-20 20:00:36 -06001028 shader->addProcesses(Processes);
steve-lunarg7f7c2ed2016-09-07 15:20:19 -06001029
John Kessenich155d3512019-08-08 23:29:20 -06001030#ifndef GLSLANG_WEB
LoopDawg08a14422017-10-17 19:27:14 -06001031 // Set IO mapper binding shift values
1032 for (int r = 0; r < glslang::EResCount; ++r) {
1033 const glslang::TResourceType res = glslang::TResourceType(r);
1034
1035 // Set base bindings
1036 shader->setShiftBinding(res, baseBinding[res][compUnit.stage]);
David Neto8c3d5b42019-10-21 14:50:31 -04001037
LoopDawg08a14422017-10-17 19:27:14 -06001038 // Set bindings for particular resource sets
1039 // TODO: use a range based for loop here, when available in all environments.
1040 for (auto i = baseBindingForSet[res][compUnit.stage].begin();
1041 i != baseBindingForSet[res][compUnit.stage].end(); ++i)
LoopDawge5709552017-10-21 10:46:39 -06001042 shader->setShiftBindingForSet(res, i->second, i->first);
LoopDawg08a14422017-10-17 19:27:14 -06001043 }
steve-lunargcce8d482016-10-14 18:36:42 -06001044 shader->setNoStorageFormat((Options & EOptionNoStorageFormat) != 0);
Hyangran Park36dc8292017-05-02 16:27:29 +09001045 shader->setResourceSetBinding(baseResourceSetBinding[compUnit.stage]);
steve-lunarg7f7c2ed2016-09-07 15:20:19 -06001046
1047 if (Options & EOptionAutoMapBindings)
1048 shader->setAutoMapBindings(true);
John Kessenichecba76f2017-01-06 00:34:48 -07001049
John Kessenich71facdf2017-05-17 18:28:19 -06001050 if (Options & EOptionAutoMapLocations)
1051 shader->setAutoMapLocations(true);
1052
Neil Roberts16f53472018-03-20 17:30:53 +01001053 for (auto& uniOverride : uniformLocationOverrides) {
1054 shader->addUniformLocationOverride(uniOverride.first.c_str(),
1055 uniOverride.second);
1056 }
1057
Neil Robertsb0f3d792018-03-20 17:41:05 +01001058 shader->setUniformLocationBase(uniformBase);
John Kessenich155d3512019-08-08 23:29:20 -06001059#endif
1060
1061 shader->setNanMinMaxClamp(NaNClamp);
1062
1063#ifdef ENABLE_HLSL
1064 shader->setFlattenUniformArrays((Options & EOptionFlattenUniformArrays) != 0);
1065 if (Options & EOptionHlslIoMapping)
1066 shader->setHlslIoMapping(true);
1067#endif
1068
1069 if (Options & EOptionInvertY)
1070 shader->setInvertY(true);
Neil Robertsb0f3d792018-03-20 17:41:05 +01001071
John Kessenich4be4aeb2017-06-23 10:50:22 -06001072 // Set up the environment, some subsettings take precedence over earlier
1073 // ways of setting things.
1074 if (Options & EOptionSpv) {
John Kessenich8717a5d2018-10-26 10:12:32 -06001075 shader->setEnvInput((Options & EOptionReadHlsl) ? glslang::EShSourceHlsl
1076 : glslang::EShSourceGlsl,
1077 compUnit.stage, Client, ClientInputSemanticsVersion);
1078 shader->setEnvClient(Client, ClientVersion);
1079 shader->setEnvTarget(TargetLanguage, TargetVersion);
John Kessenichd4ed5152019-07-27 05:22:30 -06001080#ifdef ENABLE_HLSL
John Kessenich5d610ee2018-03-07 18:05:55 -07001081 if (targetHlslFunctionality1)
1082 shader->setEnvTargetHlslFunctionality1();
John Kessenichd4ed5152019-07-27 05:22:30 -06001083#endif
John Kessenich4be4aeb2017-06-23 10:50:22 -06001084 }
1085
John Kessenich69f4b512013-09-04 21:19:27 +00001086 shaders.push_back(shader);
John Kessenichb3297152015-07-11 18:01:03 -06001087
John Kessenich4be4aeb2017-06-23 10:50:22 -06001088 const int defaultVersion = Options & EOptionDefaultDesktop ? 110 : 100;
John Kessenich69f4b512013-09-04 21:19:27 +00001089
John Kessenich3494b4d2017-05-22 15:00:42 -06001090 DirStackFileIncluder includer;
John Kessenich971a0a82017-06-07 15:06:58 -06001091 std::for_each(IncludeDirectoryList.rbegin(), IncludeDirectoryList.rend(), [&includer](const std::string& dir) {
1092 includer.pushExternalLocalDirectory(dir); });
John Kessenichdeec1932019-08-13 08:00:30 -06001093#ifndef GLSLANG_WEB
John Kessenichc555ddd2015-06-17 02:38:44 +00001094 if (Options & EOptionOutputPreprocessed) {
1095 std::string str;
John Kessenich086febc2018-10-25 12:43:02 -06001096 if (shader->preprocess(&Resources, defaultVersion, ENoProfile, false, false, messages, &str, includer)) {
Andrew Woloszynaae1ad82015-06-24 17:00:46 -04001097 PutsIfNonEmpty(str.c_str());
1098 } else {
1099 CompileFailed = true;
1100 }
1101 StderrIfNonEmpty(shader->getInfoLog());
1102 StderrIfNonEmpty(shader->getInfoDebugLog());
John Kessenichc555ddd2015-06-17 02:38:44 +00001103 continue;
1104 }
John Kessenichdeec1932019-08-13 08:00:30 -06001105#endif
John Kessenich086febc2018-10-25 12:43:02 -06001106
John Kessenich3494b4d2017-05-22 15:00:42 -06001107 if (! shader->parse(&Resources, defaultVersion, false, messages, includer))
John Kessenichc999ba22013-11-07 23:33:24 +00001108 CompileFailed = true;
John Kessenichc555ddd2015-06-17 02:38:44 +00001109
John Kessenich69f4b512013-09-04 21:19:27 +00001110 program.addShader(shader);
1111
John Kessenichc57b2a92016-01-16 15:30:03 -07001112 if (! (Options & EOptionSuppressInfolog) &&
1113 ! (Options & EOptionMemoryLeakMode)) {
Marcin Åšlusarz245c30c2020-07-03 14:55:29 +02001114 if (!beQuiet)
1115 PutsIfNonEmpty(compUnit.fileName[0].c_str());
Andrew Woloszynaae1ad82015-06-24 17:00:46 -04001116 PutsIfNonEmpty(shader->getInfoLog());
1117 PutsIfNonEmpty(shader->getInfoDebugLog());
John Kessenich69f4b512013-09-04 21:19:27 +00001118 }
John Kessenich69f4b512013-09-04 21:19:27 +00001119 }
1120
1121 //
1122 // Program-level processing...
1123 //
1124
John Kessenich4d65ee32016-03-12 18:17:47 -07001125 // Link
John Kessenich68d78fd2015-07-12 19:28:10 -06001126 if (! (Options & EOptionOutputPreprocessed) && ! program.link(messages))
John Kessenichc999ba22013-11-07 23:33:24 +00001127 LinkFailed = true;
1128
John Kessenichb6d3ee52019-08-06 02:20:45 -06001129#ifndef GLSLANG_WEB
steve-lunarg9ae34742016-10-05 13:40:13 -06001130 // Map IO
1131 if (Options & EOptionSpv) {
1132 if (!program.mapIO())
1133 LinkFailed = true;
1134 }
John Kessenichb6d3ee52019-08-06 02:20:45 -06001135#endif
John Kessenichecba76f2017-01-06 00:34:48 -07001136
John Kessenich4d65ee32016-03-12 18:17:47 -07001137 // Report
John Kessenichc57b2a92016-01-16 15:30:03 -07001138 if (! (Options & EOptionSuppressInfolog) &&
1139 ! (Options & EOptionMemoryLeakMode)) {
Andrew Woloszynaae1ad82015-06-24 17:00:46 -04001140 PutsIfNonEmpty(program.getInfoLog());
1141 PutsIfNonEmpty(program.getInfoDebugLog());
John Kessenich69f4b512013-09-04 21:19:27 +00001142 }
1143
John Kessenichb6d3ee52019-08-06 02:20:45 -06001144#ifndef GLSLANG_WEB
John Kessenich4d65ee32016-03-12 18:17:47 -07001145 // Reflect
John Kessenich11f9fc72013-11-07 01:06:34 +00001146 if (Options & EOptionDumpReflection) {
baldurk6d477852019-01-29 15:45:56 +00001147 program.buildReflection(ReflectOptions);
John Kessenich11f9fc72013-11-07 01:06:34 +00001148 program.dumpReflection();
1149 }
John Kessenichb6d3ee52019-08-06 02:20:45 -06001150#endif
John Kessenich11f9fc72013-11-07 01:06:34 +00001151
John Kessenich4d65ee32016-03-12 18:17:47 -07001152 // Dump SPIR-V
John Kessenich0df0cde2015-03-03 17:09:43 +00001153 if (Options & EOptionSpv) {
John Kessenich92f90382014-07-28 04:21:04 +00001154 if (CompileFailed || LinkFailed)
John Kessenich68d78fd2015-07-12 19:28:10 -06001155 printf("SPIR-V is not generated for failed compile or link\n");
John Kessenich92f90382014-07-28 04:21:04 +00001156 else {
1157 for (int stage = 0; stage < EShLangCount; ++stage) {
John Kessenicha7a68a92014-08-24 18:21:00 +00001158 if (program.getIntermediate((EShLanguage)stage)) {
John Kessenich0df0cde2015-03-03 17:09:43 +00001159 std::vector<unsigned int> spirv;
Lei Zhang17535f72016-05-04 15:55:59 -04001160 spv::SpvBuildLogger logger;
John Kessenich121853f2017-05-31 17:11:16 -06001161 glslang::SpvOptions spvOptions;
1162 if (Options & EOptionDebug)
1163 spvOptions.generateDebugInfo = true;
Shahbaz Youssefid52dce52020-06-17 12:47:44 -04001164 else if (stripDebugInfo)
1165 spvOptions.stripDebugInfo = true;
GregF52fe3d52017-09-28 10:08:32 -06001166 spvOptions.disableOptimizer = (Options & EOptionOptimizeDisable) != 0;
1167 spvOptions.optimizeSize = (Options & EOptionOptimizeSize) != 0;
John Kessenich717c80a2018-08-23 15:17:10 -06001168 spvOptions.disassemble = SpvToolsDisassembler;
John Kessenichc3404252018-08-23 15:29:08 -06001169 spvOptions.validate = SpvToolsValidate;
John Kessenich121853f2017-05-31 17:11:16 -06001170 glslang::GlslangToSpv(*program.getIntermediate((EShLanguage)stage), spirv, &logger, &spvOptions);
John Kessenichc57b2a92016-01-16 15:30:03 -07001171
1172 // Dump the spv to a file or stdout, etc., but only if not doing
1173 // memory/perf testing, as it's not internal to programmatic use.
1174 if (! (Options & EOptionMemoryLeakMode)) {
Johannes van Waverenecb0f3b2016-05-27 12:55:53 -05001175 printf("%s", logger.getAllMessages().c_str());
1176 if (Options & EOptionOutputHexadecimal) {
John Kessenich8f674e82017-02-18 09:45:40 -07001177 glslang::OutputSpvHex(spirv, GetBinaryName((EShLanguage)stage), variableName);
Johannes van Waverenecb0f3b2016-05-27 12:55:53 -05001178 } else {
1179 glslang::OutputSpvBin(spirv, GetBinaryName((EShLanguage)stage));
1180 }
John Kessenich23d27752019-07-28 02:12:10 -06001181#ifndef GLSLANG_WEB
John Kesseniche2156222018-06-11 18:12:15 -06001182 if (!SpvToolsDisassembler && (Options & EOptionHumanReadableSpv))
John Kessenichc57b2a92016-01-16 15:30:03 -07001183 spv::Disassemble(std::cout, spirv);
John Kessenich23d27752019-07-28 02:12:10 -06001184#endif
John Kessenichacba7722015-03-04 03:48:38 +00001185 }
John Kessenicha7a68a92014-08-24 18:21:00 +00001186 }
John Kessenich92f90382014-07-28 04:21:04 +00001187 }
1188 }
1189 }
1190
John Kessenich5b0f13a2013-11-01 03:08:40 +00001191 // Free everything up, program has to go before the shaders
1192 // because it might have merged stuff from the shaders, and
1193 // the stuff from the shaders has to have its destructors called
1194 // before the pools holding the memory in the shaders is freed.
1195 delete &program;
John Kessenich69f4b512013-09-04 21:19:27 +00001196 while (shaders.size() > 0) {
1197 delete shaders.back();
1198 shaders.pop_back();
1199 }
John Kessenich69f4b512013-09-04 21:19:27 +00001200}
1201
John Kessenichc57b2a92016-01-16 15:30:03 -07001202//
1203// Do file IO part of compile and link, handing off the pure
1204// API/programmatic mode to CompileAndLinkShaderUnits(), which can
1205// be put in a loop for testing memory footprint and performance.
1206//
1207// This is just for linking mode: meaning all the shaders will be put into the
1208// the same program linked together.
1209//
1210// This means there are a limited number of work items (not multi-threading mode)
1211// and that the point is testing at the linking level. Hence, to enable
1212// performance and memory testing, the actual compile/link can be put in
1213// a loop, independent of processing the work items and file IO.
1214//
Juan Lopeza558b262017-04-02 23:04:00 +02001215void CompileAndLinkShaderFiles(glslang::TWorklist& Worklist)
John Kessenichc57b2a92016-01-16 15:30:03 -07001216{
1217 std::vector<ShaderCompUnit> compUnits;
1218
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001219 // If this is using stdin, we can't really detect multiple different file
1220 // units by input type. We need to assume that we're just being given one
1221 // file of a certain type.
1222 if ((Options & EOptionStdin) != 0) {
1223 ShaderCompUnit compUnit(FindLanguage("stdin"));
1224 std::istreambuf_iterator<char> begin(std::cin), end;
1225 std::string tempString(begin, end);
1226 char* fileText = strdup(tempString.c_str());
1227 std::string fileName = "stdin";
1228 compUnit.addString(fileName, fileText);
John Kessenichc57b2a92016-01-16 15:30:03 -07001229 compUnits.push_back(compUnit);
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001230 } else {
1231 // Transfer all the work items from to a simple list of
1232 // of compilation units. (We don't care about the thread
1233 // work-item distribution properties in this path, which
1234 // is okay due to the limited number of shaders, know since
1235 // they are all getting linked together.)
1236 glslang::TWorkItem* workItem;
1237 while (Worklist.remove(workItem)) {
1238 ShaderCompUnit compUnit(FindLanguage(workItem->name));
1239 char* fileText = ReadFileData(workItem->name.c_str());
1240 if (fileText == nullptr)
1241 usage();
1242 compUnit.addString(workItem->name, fileText);
1243 compUnits.push_back(compUnit);
1244 }
John Kessenichc57b2a92016-01-16 15:30:03 -07001245 }
1246
1247 // Actual call to programmatic processing of compile and link,
1248 // in a loop for testing memory and performance. This part contains
1249 // all the perf/memory that a programmatic consumer will care about.
1250 for (int i = 0; i < ((Options & EOptionMemoryLeakMode) ? 100 : 1); ++i) {
1251 for (int j = 0; j < ((Options & EOptionMemoryLeakMode) ? 100 : 1); ++j)
1252 CompileAndLinkShaderUnits(compUnits);
1253
1254 if (Options & EOptionMemoryLeakMode)
1255 glslang::OS_DumpMemoryCounters();
1256 }
1257
John Kessenicha9313662017-06-15 10:40:49 -06001258 // free memory from ReadFileData, which got stored in a const char*
1259 // as the first string above
rdb32084e82016-02-23 22:17:38 +01001260 for (auto it = compUnits.begin(); it != compUnits.end(); ++it)
John Kessenicha9313662017-06-15 10:40:49 -06001261 FreeFileData(const_cast<char*>(it->text[0]));
John Kessenichc57b2a92016-01-16 15:30:03 -07001262}
1263
John Kessenich94f28eb2017-11-13 01:32:06 -07001264int singleMain()
John Kessenicha0af4732012-12-12 21:15:54 +00001265{
Juan Lopeza558b262017-04-02 23:04:00 +02001266 glslang::TWorklist workList;
John Kessenich94f28eb2017-11-13 01:32:06 -07001267 std::for_each(WorkItems.begin(), WorkItems.end(), [&workList](std::unique_ptr<glslang::TWorkItem>& item) {
Juan Lopeza558b262017-04-02 23:04:00 +02001268 assert(item);
1269 workList.add(item.get());
1270 });
John Kessenich2b07c7e2013-07-31 18:44:13 +00001271
John Kessenich23d27752019-07-28 02:12:10 -06001272#ifndef GLSLANG_WEB
John Kessenich05a70632013-09-17 19:26:08 +00001273 if (Options & EOptionDumpConfig) {
Lei Zhang414eb602016-03-04 16:22:34 -05001274 printf("%s", glslang::GetDefaultTBuiltInResourceString().c_str());
Juan Lopeza558b262017-04-02 23:04:00 +02001275 if (workList.empty())
John Kessenich05a70632013-09-17 19:26:08 +00001276 return ESuccess;
1277 }
John Kessenich23d27752019-07-28 02:12:10 -06001278#endif
John Kessenich05a70632013-09-17 19:26:08 +00001279
John Kessenichc6c80a62018-03-05 22:23:17 -07001280 if (Options & EOptionDumpBareVersion) {
1281 printf("%d.%d.%d\n",
1282 glslang::GetSpirvGeneratorVersion(), GLSLANG_MINOR_VERSION, GLSLANG_PATCH_LEVEL);
1283 if (workList.empty())
1284 return ESuccess;
1285 } else if (Options & EOptionDumpVersions) {
1286 printf("Glslang Version: %d.%d.%d\n",
1287 glslang::GetSpirvGeneratorVersion(), GLSLANG_MINOR_VERSION, GLSLANG_PATCH_LEVEL);
John Kessenich319de232013-12-04 04:43:40 +00001288 printf("ESSL Version: %s\n", glslang::GetEsslVersionString());
1289 printf("GLSL Version: %s\n", glslang::GetGlslVersionString());
John Kessenich68d78fd2015-07-12 19:28:10 -06001290 std::string spirvVersion;
1291 glslang::GetSpirvVersion(spirvVersion);
John Kessenich0da9eaa2015-08-01 17:10:02 -06001292 printf("SPIR-V Version %s\n", spirvVersion.c_str());
John Kessenich5e4b1242015-08-06 22:53:06 -06001293 printf("GLSL.std.450 Version %d, Revision %d\n", GLSLstd450Version, GLSLstd450Revision);
John Kessenich55e7d112015-11-15 21:33:39 -07001294 printf("Khronos Tool ID %d\n", glslang::GetKhronosToolId());
John Kessenicha372a3e2017-11-02 22:32:14 -06001295 printf("SPIR-V Generator Version %d\n", glslang::GetSpirvGeneratorVersion());
John Kessenichb84313d2016-07-20 16:03:29 -06001296 printf("GL_KHR_vulkan_glsl version %d\n", 100);
1297 printf("ARB_GL_gl_spirv version %d\n", 100);
Juan Lopeza558b262017-04-02 23:04:00 +02001298 if (workList.empty())
John Kessenich319de232013-12-04 04:43:40 +00001299 return ESuccess;
1300 }
1301
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001302 if (workList.empty() && ((Options & EOptionStdin) == 0)) {
John Kessenich05a70632013-09-17 19:26:08 +00001303 usage();
John Kessenich05a70632013-09-17 19:26:08 +00001304 }
1305
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001306 if (Options & EOptionStdin) {
John Kessenich94f28eb2017-11-13 01:32:06 -07001307 WorkItems.push_back(std::unique_ptr<glslang::TWorkItem>{new glslang::TWorkItem("stdin")});
1308 workList.add(WorkItems.back().get());
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001309 }
1310
John Kessenich05a70632013-09-17 19:26:08 +00001311 ProcessConfigFile();
1312
John Kessenich086febc2018-10-25 12:43:02 -06001313 if ((Options & EOptionReadHlsl) && !((Options & EOptionOutputPreprocessed) || (Options & EOptionSpv)))
John Kessenichbd97b6f2019-12-20 10:33:13 -07001314 Error("HLSL requires SPIR-V code generation (or preprocessing only)");
John Kessenich086febc2018-10-25 12:43:02 -06001315
John Kessenich69f4b512013-09-04 21:19:27 +00001316 //
1317 // Two modes:
John Kessenich38f3b892013-09-06 19:52:57 +00001318 // 1) linking all arguments together, single-threaded, new C++ interface
1319 // 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 +00001320 //
John Kessenich086febc2018-10-25 12:43:02 -06001321 if (Options & (EOptionLinkProgram | EOptionOutputPreprocessed)) {
John Kessenichc36e1d82013-11-01 17:41:52 +00001322 glslang::InitializeProcess();
John Kesseniche2c15b42017-11-16 22:48:41 -07001323 glslang::InitializeProcess(); // also test reference counting of users
1324 glslang::InitializeProcess(); // also test reference counting of users
1325 glslang::FinalizeProcess(); // also test reference counting of users
1326 glslang::FinalizeProcess(); // also test reference counting of users
Juan Lopeza558b262017-04-02 23:04:00 +02001327 CompileAndLinkShaderFiles(workList);
John Kessenichc36e1d82013-11-01 17:41:52 +00001328 glslang::FinalizeProcess();
1329 } else {
1330 ShInitialize();
John Kesseniche2c15b42017-11-16 22:48:41 -07001331 ShInitialize(); // also test reference counting of users
1332 ShFinalize(); // also test reference counting of users
John Kessenichc36e1d82013-11-01 17:41:52 +00001333
Juan Lopeza558b262017-04-02 23:04:00 +02001334 bool printShaderNames = workList.size() > 1;
John Kessenich69f4b512013-09-04 21:19:27 +00001335
John Kesseniche2c15b42017-11-16 22:48:41 -07001336 if (Options & EOptionMultiThreaded) {
Juan Lopeza558b262017-04-02 23:04:00 +02001337 std::array<std::thread, 16> threads;
John Kesseniche2c15b42017-11-16 22:48:41 -07001338 for (unsigned int t = 0; t < threads.size(); ++t) {
Juan Lopeza558b262017-04-02 23:04:00 +02001339 threads[t] = std::thread(CompileShaders, std::ref(workList));
John Kesseniche2c15b42017-11-16 22:48:41 -07001340 if (threads[t].get_id() == std::thread::id()) {
John Kessenichaf527992017-11-02 22:48:15 -06001341 fprintf(stderr, "Failed to create thread\n");
John Kessenich38f3b892013-09-06 19:52:57 +00001342 return EFailThreadCreate;
1343 }
John Kessenicha0af4732012-12-12 21:15:54 +00001344 }
Juan Lopeza558b262017-04-02 23:04:00 +02001345
1346 std::for_each(threads.begin(), threads.end(), [](std::thread& t) { t.join(); });
John Kessenichc999ba22013-11-07 23:33:24 +00001347 } else
Juan Lopeza558b262017-04-02 23:04:00 +02001348 CompileShaders(workList);
John Kessenich38f3b892013-09-06 19:52:57 +00001349
1350 // Print out all the resulting infologs
John Kessenich94f28eb2017-11-13 01:32:06 -07001351 for (size_t w = 0; w < WorkItems.size(); ++w) {
1352 if (WorkItems[w]) {
1353 if (printShaderNames || WorkItems[w]->results.size() > 0)
1354 PutsIfNonEmpty(WorkItems[w]->name.c_str());
1355 PutsIfNonEmpty(WorkItems[w]->results.c_str());
John Kessenich38f3b892013-09-06 19:52:57 +00001356 }
1357 }
John Kessenichc36e1d82013-11-01 17:41:52 +00001358
1359 ShFinalize();
John Kessenicha0af4732012-12-12 21:15:54 +00001360 }
John Kessenich2b07c7e2013-07-31 18:44:13 +00001361
John Kessenichc999ba22013-11-07 23:33:24 +00001362 if (CompileFailed)
John Kessenicha0af4732012-12-12 21:15:54 +00001363 return EFailCompile;
John Kessenichc999ba22013-11-07 23:33:24 +00001364 if (LinkFailed)
John Kessenicha0af4732012-12-12 21:15:54 +00001365 return EFailLink;
1366
1367 return 0;
1368}
1369
John Kessenich94f28eb2017-11-13 01:32:06 -07001370int C_DECL main(int argc, char* argv[])
1371{
1372 ProcessArguments(WorkItems, argc, argv);
1373
1374 int ret = 0;
1375
1376 // Loop over the entire init/finalize cycle to watch memory changes
1377 const int iterations = 1;
1378 if (iterations > 1)
1379 glslang::OS_DumpMemoryCounters();
1380 for (int i = 0; i < iterations; ++i) {
1381 ret = singleMain();
1382 if (iterations > 1)
1383 glslang::OS_DumpMemoryCounters();
1384 }
1385
1386 return ret;
1387}
1388
John Kessenicha0af4732012-12-12 21:15:54 +00001389//
1390// Deduce the language from the filename. Files must end in one of the
1391// following extensions:
1392//
John Kessenich2b07c7e2013-07-31 18:44:13 +00001393// .vert = vertex
1394// .tesc = tessellation control
1395// .tese = tessellation evaluation
1396// .geom = geometry
1397// .frag = fragment
John Kessenich94a81fb2013-08-31 02:41:30 +00001398// .comp = compute
Chao Chenb50c02e2018-09-19 11:42:24 -07001399// .rgen = ray generation
1400// .rint = ray intersection
1401// .rahit = ray any hit
1402// .rchit = ray closest hit
1403// .rmiss = ray miss
1404// .rcall = ray callable
Sahil Parmar035cbbe2018-10-04 16:39:18 -07001405// .mesh = mesh
1406// .task = task
Grigory Dzhavadyan33507412018-04-12 14:35:24 -07001407// Additionally, the file names may end in .<stage>.glsl and .<stage>.hlsl
1408// where <stage> is one of the stages listed above.
1409//
1410EShLanguage FindLanguage(const std::string& name, bool parseStageName)
John Kessenicha0af4732012-12-12 21:15:54 +00001411{
John Kessenichfccbb8b2018-04-17 17:24:03 -06001412 std::string stageName;
Dan Bakerc6ede892016-08-11 14:06:06 -04001413 if (shaderStageName)
John Kessenichfccbb8b2018-04-17 17:24:03 -06001414 stageName = shaderStageName;
1415 else if (parseStageName) {
Grigory Dzhavadyan33507412018-04-12 14:35:24 -07001416 // Note: "first" extension means "first from the end", i.e.
1417 // if the file is named foo.vert.glsl, then "glsl" is first,
1418 // "vert" is second.
John Kessenichfccbb8b2018-04-17 17:24:03 -06001419 size_t firstExtStart = name.find_last_of(".");
1420 bool hasFirstExt = firstExtStart != std::string::npos;
1421 size_t secondExtStart = hasFirstExt ? name.find_last_of(".", firstExtStart - 1) : std::string::npos;
1422 bool hasSecondExt = secondExtStart != std::string::npos;
1423 std::string firstExt = name.substr(firstExtStart + 1, std::string::npos);
1424 bool usesUnifiedExt = hasFirstExt && (firstExt == "glsl" || firstExt == "hlsl");
John Kessenich3beac942018-04-17 21:02:19 -06001425 if (usesUnifiedExt && firstExt == "hlsl")
1426 Options |= EOptionReadHlsl;
1427 if (hasFirstExt && !usesUnifiedExt)
John Kessenichfccbb8b2018-04-17 17:24:03 -06001428 stageName = firstExt;
John Kessenich3beac942018-04-17 21:02:19 -06001429 else if (usesUnifiedExt && hasSecondExt)
John Kessenichfccbb8b2018-04-17 17:24:03 -06001430 stageName = name.substr(secondExtStart + 1, firstExtStart - secondExtStart - 1);
John Kessenich3beac942018-04-17 21:02:19 -06001431 else {
Grigory Dzhavadyan33507412018-04-12 14:35:24 -07001432 usage();
1433 return EShLangVertex;
John Kesseniche751bca2017-03-16 11:20:38 -06001434 }
John Kessenichfccbb8b2018-04-17 17:24:03 -06001435 } else
1436 stageName = name;
dankbaker45d49bc2016-08-08 21:43:07 -04001437
John Kessenichfccbb8b2018-04-17 17:24:03 -06001438 if (stageName == "vert")
John Kessenich2b07c7e2013-07-31 18:44:13 +00001439 return EShLangVertex;
John Kessenichfccbb8b2018-04-17 17:24:03 -06001440 else if (stageName == "tesc")
John Kessenich2b07c7e2013-07-31 18:44:13 +00001441 return EShLangTessControl;
John Kessenichfccbb8b2018-04-17 17:24:03 -06001442 else if (stageName == "tese")
John Kessenich2b07c7e2013-07-31 18:44:13 +00001443 return EShLangTessEvaluation;
John Kessenichfccbb8b2018-04-17 17:24:03 -06001444 else if (stageName == "geom")
John Kessenich2b07c7e2013-07-31 18:44:13 +00001445 return EShLangGeometry;
John Kessenichfccbb8b2018-04-17 17:24:03 -06001446 else if (stageName == "frag")
John Kessenich2b07c7e2013-07-31 18:44:13 +00001447 return EShLangFragment;
John Kessenichfccbb8b2018-04-17 17:24:03 -06001448 else if (stageName == "comp")
John Kessenichc0275792013-08-09 17:14:49 +00001449 return EShLangCompute;
Chao Chenb50c02e2018-09-19 11:42:24 -07001450 else if (stageName == "rgen")
Daniel Kochdb32b242020-03-17 20:42:47 -04001451 return EShLangRayGen;
Chao Chenb50c02e2018-09-19 11:42:24 -07001452 else if (stageName == "rint")
Daniel Kochdb32b242020-03-17 20:42:47 -04001453 return EShLangIntersect;
Chao Chenb50c02e2018-09-19 11:42:24 -07001454 else if (stageName == "rahit")
Daniel Kochdb32b242020-03-17 20:42:47 -04001455 return EShLangAnyHit;
Chao Chenb50c02e2018-09-19 11:42:24 -07001456 else if (stageName == "rchit")
Daniel Kochdb32b242020-03-17 20:42:47 -04001457 return EShLangClosestHit;
Chao Chenb50c02e2018-09-19 11:42:24 -07001458 else if (stageName == "rmiss")
Daniel Kochdb32b242020-03-17 20:42:47 -04001459 return EShLangMiss;
Chao Chenb50c02e2018-09-19 11:42:24 -07001460 else if (stageName == "rcall")
Daniel Kochdb32b242020-03-17 20:42:47 -04001461 return EShLangCallable;
Chao Chen3c366992018-09-19 11:41:59 -07001462 else if (stageName == "mesh")
1463 return EShLangMeshNV;
1464 else if (stageName == "task")
1465 return EShLangTaskNV;
John Kessenich2b07c7e2013-07-31 18:44:13 +00001466
1467 usage();
John Kesseniche95ecc52012-12-12 21:34:14 +00001468 return EShLangVertex;
John Kessenicha0af4732012-12-12 21:15:54 +00001469}
1470
John Kessenicha0af4732012-12-12 21:15:54 +00001471//
John Kessenichecba76f2017-01-06 00:34:48 -07001472// Read a file's data into a string, and compile it using the old interface ShCompile,
John Kessenich69f4b512013-09-04 21:19:27 +00001473// for non-linkable results.
John Kessenicha0af4732012-12-12 21:15:54 +00001474//
John Kessenich51cdd902014-02-18 23:37:57 +00001475void CompileFile(const char* fileName, ShHandle compiler)
John Kessenicha0af4732012-12-12 21:15:54 +00001476{
John Kessenichca3457f2015-05-18 01:59:45 +00001477 int ret = 0;
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001478 char* shaderString;
1479 if ((Options & EOptionStdin) != 0) {
1480 std::istreambuf_iterator<char> begin(std::cin), end;
1481 std::string tempString(begin, end);
1482 shaderString = strdup(tempString.c_str());
1483 } else {
1484 shaderString = ReadFileData(fileName);
1485 }
John Kessenich41cf6b52013-06-25 18:10:05 +00001486
1487 // move to length-based strings, rather than null-terminated strings
John Kessenich04acb1b2017-06-14 17:36:50 -06001488 int* lengths = new int[1];
1489 lengths[0] = (int)strlen(shaderString);
John Kessenicha0af4732012-12-12 21:15:54 +00001490
John Kessenich52ac67e2013-05-05 23:46:22 +00001491 EShMessages messages = EShMsgDefault;
John Kessenichb0a7eb52013-11-07 17:44:20 +00001492 SetMessageOptions(messages);
John Kessenichecba76f2017-01-06 00:34:48 -07001493
John Kessenicha9313662017-06-15 10:40:49 -06001494 if (UserPreamble.isSet())
1495 Error("-D and -U options require -l (linking)\n");
1496
John Kessenich94a81fb2013-08-31 02:41:30 +00001497 for (int i = 0; i < ((Options & EOptionMemoryLeakMode) ? 100 : 1); ++i) {
1498 for (int j = 0; j < ((Options & EOptionMemoryLeakMode) ? 100 : 1); ++j) {
John Kessenich927608b2017-01-06 12:34:14 -07001499 // ret = ShCompile(compiler, shaderStrings, NumShaderStrings, lengths, EShOptNone, &Resources, Options, (Options & EOptionDefaultDesktop) ? 110 : 100, false, messages);
John Kessenich04acb1b2017-06-14 17:36:50 -06001500 ret = ShCompile(compiler, &shaderString, 1, nullptr, EShOptNone, &Resources, Options, (Options & EOptionDefaultDesktop) ? 110 : 100, false, messages);
John Kessenich927608b2017-01-06 12:34:14 -07001501 // const char* multi[12] = { "# ve", "rsion", " 300 e", "s", "\n#err",
John Kessenichecba76f2017-01-06 00:34:48 -07001502 // "or should be l", "ine 1", "string 5\n", "float glo", "bal",
John Kessenichea869fb2013-10-28 18:12:06 +00001503 // ";\n#error should be line 2\n void main() {", "global = 2.3;}" };
John Kessenich927608b2017-01-06 12:34:14 -07001504 // const char* multi[7] = { "/", "/", "\\", "\n", "\n", "#", "version 300 es" };
1505 // ret = ShCompile(compiler, multi, 7, nullptr, EShOptNone, &Resources, Options, (Options & EOptionDefaultDesktop) ? 110 : 100, false, messages);
John Kessenich41cf6b52013-06-25 18:10:05 +00001506 }
John Kessenicha0af4732012-12-12 21:15:54 +00001507
John Kessenich94a81fb2013-08-31 02:41:30 +00001508 if (Options & EOptionMemoryLeakMode)
John Kessenich2b07c7e2013-07-31 18:44:13 +00001509 glslang::OS_DumpMemoryCounters();
John Kessenicha0af4732012-12-12 21:15:54 +00001510 }
John Kessenicha0af4732012-12-12 21:15:54 +00001511
John Kessenich41cf6b52013-06-25 18:10:05 +00001512 delete [] lengths;
John Kessenich04acb1b2017-06-14 17:36:50 -06001513 FreeFileData(shaderString);
John Kessenicha0af4732012-12-12 21:15:54 +00001514
John Kessenichc999ba22013-11-07 23:33:24 +00001515 if (ret == 0)
1516 CompileFailed = true;
John Kessenicha0af4732012-12-12 21:15:54 +00001517}
1518
John Kessenicha0af4732012-12-12 21:15:54 +00001519//
1520// print usage to stdout
1521//
1522void usage()
1523{
John Kessenich319de232013-12-04 04:43:40 +00001524 printf("Usage: glslangValidator [option]... [file]...\n"
1525 "\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001526 "'file' can end in .<stage> for auto-stage classification, where <stage> is:\n"
1527 " .conf to provide a config file that replaces the default configuration\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001528 " (see -c option below for generating a template)\n"
1529 " .vert for a vertex shader\n"
1530 " .tesc for a tessellation control shader\n"
1531 " .tese for a tessellation evaluation shader\n"
1532 " .geom for a geometry shader\n"
1533 " .frag for a fragment shader\n"
1534 " .comp for a compute shader\n"
Chao Chen3c366992018-09-19 11:41:59 -07001535 " .mesh for a mesh shader\n"
1536 " .task for a task shader\n"
Chao Chenb50c02e2018-09-19 11:42:24 -07001537 " .rgen for a ray generation shader\n"
1538 " .rint for a ray intersection shader\n"
1539 " .rahit for a ray any hit shader\n"
1540 " .rchit for a ray closest hit shader\n"
1541 " .rmiss for a ray miss shader\n"
Sahil Parmar035cbbe2018-10-04 16:39:18 -07001542 " .rcall for a ray callable shader\n"
John Kessenich2ead40f2018-04-17 17:44:11 -06001543 " .glsl for .vert.glsl, .tesc.glsl, ..., .comp.glsl compound suffixes\n"
1544 " .hlsl for .vert.hlsl, .tesc.hlsl, ..., .comp.hlsl compound suffixes\n"
John Kessenich319de232013-12-04 04:43:40 +00001545 "\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001546 "Options:\n"
1547 " -C cascading errors; risk crash from accumulation of error recoveries\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001548 " -D input is HLSL (this is the default when any suffix is .hlsl)\n"
John Kessenich6f988922020-01-07 07:03:11 -07001549 " -D<name[=def]> | --define-macro <name[=def]> | --D <name[=def]>\n"
1550 " define a pre-processor macro\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001551 " -E print pre-processed GLSL; cannot be used with -l;\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001552 " errors will appear on stderr\n"
John Kessenich6353d552017-06-23 11:11:09 -06001553 " -G[ver] create SPIR-V binary, under OpenGL semantics; turns on -l;\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001554 " default file name is <stage>.spv (-o overrides this);\n"
John Kessenich6353d552017-06-23 11:11:09 -06001555 " 'ver', when present, is the version of the input semantics,\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001556 " which will appear in #define GL_SPIRV ver;\n"
1557 " '--client opengl100' is the same as -G100;\n"
John Kessenich6353d552017-06-23 11:11:09 -06001558 " a '--target-env' for OpenGL will also imply '-G'\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001559 " -H print human readable form of SPIR-V; turns on -V\n"
John Kessenich971a0a82017-06-07 15:06:58 -06001560 " -I<dir> add dir to the include search path; includer's directory\n"
1561 " is searched first, followed by left-to-right order of -I\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001562 " -Od disables optimization; may cause illegal SPIR-V for HLSL\n"
1563 " -Os optimizes SPIR-V to minimize size\n"
John Kesseniche751bca2017-03-16 11:20:38 -06001564 " -S <stage> uses specified stage rather than parsing the file extension\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001565 " choices for <stage> are vert, tesc, tese, geom, frag, or comp\n"
John Kessenich6f988922020-01-07 07:03:11 -07001566 " -U<name> | --undef-macro <name> | --U <name>\n"
1567 " undefine a pre-processor macro\n"
John Kessenich6353d552017-06-23 11:11:09 -06001568 " -V[ver] create SPIR-V binary, under Vulkan semantics; turns on -l;\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001569 " default file name is <stage>.spv (-o overrides this)\n"
John Kessenich6353d552017-06-23 11:11:09 -06001570 " 'ver', when present, is the version of the input semantics,\n"
1571 " which will appear in #define VULKAN ver\n"
1572 " '--client vulkan100' is the same as -V100\n"
1573 " a '--target-env' for Vulkan will also imply '-V'\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001574 " -c configuration dump;\n"
1575 " creates the default configuration file (redirect to a .conf file)\n"
1576 " -d default to desktop (#version 110) when there is no shader #version\n"
1577 " (default is ES version 100)\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001578 " -e <name> | --entry-point <name>\n"
1579 " specify <name> as the entry-point function name\n"
John Kessenich5d610ee2018-03-07 18:05:55 -07001580 " -f{hlsl_functionality1}\n"
1581 " 'hlsl_functionality1' enables use of the\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001582 " SPV_GOOGLE_hlsl_functionality1 extension\n"
John Kessenich121853f2017-05-31 17:11:16 -06001583 " -g generate debug information\n"
Shahbaz Youssefid52dce52020-06-17 12:47:44 -04001584 " -g0 strip debug information\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001585 " -h print this usage message\n"
1586 " -i intermediate tree (glslang AST) is printed out\n"
1587 " -l link all input files together to form a single module\n"
1588 " -m memory leak mode\n"
John Kessenicha25530c2017-09-11 20:13:49 -06001589 " -o <file> save binary to <file>, requires a binary option (e.g., -V)\n"
John Kesseniche5c394b2019-07-02 09:32:48 -06001590 " -q dump reflection query database; requires -l for linking\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001591 " -r | --relaxed-errors"
1592 " relaxed GLSL semantic error-checking mode\n"
John Kessenichb63f4a32017-11-16 22:32:20 -07001593 " -s silence syntax and semantic error reporting\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001594 " -t multi-threaded mode\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001595 " -v | --version\n"
1596 " print version strings\n"
1597 " -w | --suppress-warnings\n"
1598 " suppress GLSL warnings, except as required by \"#extension : warn\"\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001599 " -x save binary output as text-based 32-bit hexadecimal numbers\n"
Neil Roberts16f53472018-03-20 17:30:53 +01001600 " -u<name>:<loc> specify a uniform location override for --aml\n"
Neil Robertsb0f3d792018-03-20 17:41:05 +01001601 " --uniform-base <base> set a base to use for generated uniform locations\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001602 " --auto-map-bindings | --amb automatically bind uniform variables\n"
1603 " without explicit bindings\n"
1604 " --auto-map-locations | --aml automatically locate input/output lacking\n"
1605 " 'location' (fragile, not cross stage)\n"
1606 " --client {vulkan<ver>|opengl<ver>} see -V and -G\n"
Christoph Kubisch412ff6e2019-04-13 22:57:33 +02001607 " --dump-builtin-symbols prints builtin symbol table prior each compile\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001608 " -dumpfullversion | -dumpversion print bare major.minor.patchlevel\n"
1609 " --flatten-uniform-arrays | --fua flatten uniform texture/sampler arrays to\n"
1610 " scalars\n"
1611 " --hlsl-offsets allow block offsets to follow HLSL rules\n"
1612 " works independently of source language\n"
1613 " --hlsl-iomap perform IO mapping in HLSL register space\n"
1614 " --hlsl-enable-16bit-types allow 16-bit types in SPIR-V for HLSL\n"
John Kessenich605afc72019-06-17 23:33:09 -06001615 " --hlsl-dx9-compatible interprets sampler declarations as a\n"
rdbb56e0e42020-06-02 08:30:50 +02001616 " texture/sampler combo like DirectX9 would,\n"
1617 " and recognizes DirectX9-specific semantics\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001618 " --invert-y | --iy invert position.Y output in vertex shader\n"
1619 " --keep-uncalled | --ku don't eliminate uncalled functions\n"
John Kessenich605afc72019-06-17 23:33:09 -06001620 " --nan-clamp favor non-NaN operand in min, max, and clamp\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001621 " --no-storage-format | --nsf use Unknown image format\n"
Marcin Åšlusarz245c30c2020-07-03 14:55:29 +02001622 " --quiet do not print anything to stdout, unless\n"
1623 " requested by another option\n"
baldurk4513df92019-02-08 10:48:48 +00001624 " --reflect-strict-array-suffix use strict array suffix rules when\n"
1625 " reflecting\n"
baldurkedf82122019-01-29 15:49:00 +00001626 " --reflect-basic-array-suffix arrays of basic types will have trailing [0]\n"
baldurk4513df92019-02-08 10:48:48 +00001627 " --reflect-intermediate-io reflection includes inputs/outputs of linked\n"
1628 " shaders rather than just vertex/fragment\n"
1629 " --reflect-separate-buffers reflect buffer variables and blocks\n"
1630 " separately to uniforms\n"
1631 " --reflect-all-block-variables reflect all variables in blocks, whether\n"
1632 " inactive or active\n"
baldurk19050692019-02-11 11:50:24 +00001633 " --reflect-unwrap-io-blocks unwrap input/output blocks the same as\n"
1634 " uniform blocks\n"
LoopDawg52017192017-07-14 15:15:47 -06001635 " --resource-set-binding [stage] name set binding\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001636 " set descriptor set and binding for\n"
1637 " individual resources\n"
LoopDawg52017192017-07-14 15:15:47 -06001638 " --resource-set-binding [stage] set\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001639 " set descriptor set for all resources\n"
1640 " --rsb synonym for --resource-set-binding\n"
1641 " --shift-image-binding [stage] num\n"
1642 " base binding number for images (uav)\n"
1643 " --shift-image-binding [stage] [num set]...\n"
1644 " per-descriptor-set shift values\n"
1645 " --sib synonym for --shift-image-binding\n"
1646 " --shift-sampler-binding [stage] num\n"
1647 " base binding number for samplers\n"
1648 " --shift-sampler-binding [stage] [num set]...\n"
1649 " per-descriptor-set shift values\n"
1650 " --ssb synonym for --shift-sampler-binding\n"
1651 " --shift-ssbo-binding [stage] num base binding number for SSBOs\n"
1652 " --shift-ssbo-binding [stage] [num set]...\n"
1653 " per-descriptor-set shift values\n"
1654 " --sbb synonym for --shift-ssbo-binding\n"
1655 " --shift-texture-binding [stage] num\n"
1656 " base binding number for textures\n"
1657 " --shift-texture-binding [stage] [num set]...\n"
1658 " per-descriptor-set shift values\n"
1659 " --stb synonym for --shift-texture-binding\n"
1660 " --shift-uav-binding [stage] num base binding number for UAVs\n"
1661 " --shift-uav-binding [stage] [num set]...\n"
1662 " per-descriptor-set shift values\n"
1663 " --suavb synonym for --shift-uav-binding\n"
1664 " --shift-UBO-binding [stage] num base binding number for UBOs\n"
1665 " --shift-UBO-binding [stage] [num set]...\n"
1666 " per-descriptor-set shift values\n"
1667 " --sub synonym for --shift-UBO-binding\n"
1668 " --shift-cbuffer-binding | --scb synonyms for --shift-UBO-binding\n"
1669 " --spirv-dis output standard-form disassembly; works only\n"
1670 " when a SPIR-V generation option is also used\n"
John Kessenichc3404252018-08-23 15:29:08 -06001671 " --spirv-val execute the SPIRV-Tools validator\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001672 " --source-entrypoint <name> the given shader source function is\n"
1673 " renamed to be the <name> given in -e\n"
1674 " --sep synonym for --source-entrypoint\n"
1675 " --stdin read from stdin instead of from a file;\n"
1676 " requires providing the shader stage using -S\n"
John Kessenich273d3a52020-01-15 00:10:41 -07001677 " --target-env {vulkan1.0 | vulkan1.1 | vulkan1.2 | opengl | \n"
John Kessenich8317e6c2019-08-18 23:58:08 -06001678 " spirv1.0 | spirv1.1 | spirv1.2 | spirv1.3 | spirv1.4 | spirv1.5}\n"
John Kessenich273d3a52020-01-15 00:10:41 -07001679 " Set the execution environment that the\n"
1680 " generated code will be executed in.\n"
1681 " Defaults to:\n"
1682 " * vulkan1.0 under --client vulkan<ver>\n"
1683 " * opengl under --client opengl<ver>\n"
1684 " * spirv1.0 under --target-env vulkan1.0\n"
1685 " * spirv1.3 under --target-env vulkan1.1\n"
1686 " * spirv1.5 under --target-env vulkan1.2\n"
1687 " Multiple --target-env can be specified.\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001688 " --variable-name <name>\n"
1689 " --vn <name> creates a C header file that contains a\n"
1690 " uint32_t array named <name>\n"
1691 " initialized with the shader binary code\n"
John Kessenichb0a7eb52013-11-07 17:44:20 +00001692 );
John Kessenich68d78fd2015-07-12 19:28:10 -06001693
1694 exit(EFailUsage);
John Kessenicha0af4732012-12-12 21:15:54 +00001695}
1696
John Kessenich3ce4e592014-10-06 19:57:34 +00001697#if !defined _MSC_VER && !defined MINGW_HAS_SECURE_API
John Kessenichcfd643e2013-03-08 23:14:42 +00001698
1699#include <errno.h>
1700
1701int fopen_s(
1702 FILE** pFile,
John Kessenich51cdd902014-02-18 23:37:57 +00001703 const char* filename,
1704 const char* mode
John Kessenichcfd643e2013-03-08 23:14:42 +00001705)
1706{
1707 if (!pFile || !filename || !mode) {
1708 return EINVAL;
1709 }
1710
1711 FILE* f = fopen(filename, mode);
1712 if (! f) {
1713 if (errno != 0) {
1714 return errno;
1715 } else {
1716 return ENOENT;
1717 }
1718 }
1719 *pFile = f;
1720
1721 return 0;
1722}
1723
1724#endif
1725
John Kessenicha0af4732012-12-12 21:15:54 +00001726//
1727// Malloc a string of sufficient size and read a string into it.
1728//
John Kessenich04acb1b2017-06-14 17:36:50 -06001729char* ReadFileData(const char* fileName)
John Kessenicha0af4732012-12-12 21:15:54 +00001730{
John Kessenichb3297152015-07-11 18:01:03 -06001731 FILE *in = nullptr;
John Kessenich3ce4e592014-10-06 19:57:34 +00001732 int errorCode = fopen_s(&in, fileName, "r");
John Kessenich68d78fd2015-07-12 19:28:10 -06001733 if (errorCode || in == nullptr)
1734 Error("unable to open input file");
John Kessenichecba76f2017-01-06 00:34:48 -07001735
John Kessenich04acb1b2017-06-14 17:36:50 -06001736 int count = 0;
John Kessenicha0af4732012-12-12 21:15:54 +00001737 while (fgetc(in) != EOF)
1738 count++;
1739
John Kessenichd6c72a42014-08-18 19:42:35 +00001740 fseek(in, 0, SEEK_SET);
John Kessenichca3457f2015-05-18 01:59:45 +00001741
John Kessenich04acb1b2017-06-14 17:36:50 -06001742 char* return_data = (char*)malloc(count + 1); // freed in FreeFileData()
1743 if ((int)fread(return_data, 1, count, in) != count) {
1744 free(return_data);
John Kessenich68d78fd2015-07-12 19:28:10 -06001745 Error("can't read input file");
John Kessenicha0af4732012-12-12 21:15:54 +00001746 }
John Kessenich68d78fd2015-07-12 19:28:10 -06001747
John Kessenich04acb1b2017-06-14 17:36:50 -06001748 return_data[count] = '\0';
John Kessenicha0af4732012-12-12 21:15:54 +00001749 fclose(in);
John Kessenichb3297152015-07-11 18:01:03 -06001750
John Kessenicha0af4732012-12-12 21:15:54 +00001751 return return_data;
1752}
1753
John Kessenich04acb1b2017-06-14 17:36:50 -06001754void FreeFileData(char* data)
John Kessenicha0af4732012-12-12 21:15:54 +00001755{
John Kessenichb3297152015-07-11 18:01:03 -06001756 free(data);
John Kessenicha0af4732012-12-12 21:15:54 +00001757}
1758
John Kessenich54d8cda2013-02-11 22:36:01 +00001759void InfoLogMsg(const char* msg, const char* name, const int num)
John Kessenicha0af4732012-12-12 21:15:54 +00001760{
John Kessenichfae38ee2015-06-10 23:23:12 +00001761 if (num >= 0 )
1762 printf("#### %s %s %d INFO LOG ####\n", msg, name, num);
1763 else
1764 printf("#### %s %s INFO LOG ####\n", msg, name);
John Kessenicha0af4732012-12-12 21:15:54 +00001765}