blob: 1f294b0744d0de3abcd8c0eb687b8ffdd914fc89 [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"
47#include "./../glslang/Public/ShaderLang.h"
John Kessenich0df0cde2015-03-03 17:09:43 +000048#include "../SPIRV/GlslangToSpv.h"
John Kessenich5e4b1242015-08-06 22:53:06 -060049#include "../SPIRV/GLSL.std.450.h"
John Kessenichacba7722015-03-04 03:48:38 +000050#include "../SPIRV/doc.h"
51#include "../SPIRV/disassemble.h"
John Kessenich3494b4d2017-05-22 15:00:42 -060052
John Kessenich66ec80e2016-08-05 14:04:23 -060053#include <cstring>
54#include <cstdlib>
steve-lunarg7f7c2ed2016-09-07 15:20:19 -060055#include <cctype>
John Kessenich66ec80e2016-08-05 14:04:23 -060056#include <cmath>
steve-lunarg7f7c2ed2016-09-07 15:20:19 -060057#include <array>
LoopDawg08a14422017-10-17 19:27:14 -060058#include <map>
Juan Lopeza558b262017-04-02 23:04:00 +020059#include <memory>
60#include <thread>
John Kessenicha0af4732012-12-12 21:15:54 +000061
baldurk876a0e32015-11-16 18:03:28 +010062#include "../glslang/OSDependent/osinclude.h"
John Kessenicha0af4732012-12-12 21:15:54 +000063
Ben Claytonfbe9a232020-06-17 11:17:19 +010064// Build-time generated includes
65#include "glslang/build_info.h"
66
John Kessenicha0af4732012-12-12 21:15:54 +000067extern "C" {
Ben Claytond64e8592020-06-29 14:20:19 +010068 GLSLANG_EXPORT void ShOutputHtml();
John Kessenicha0af4732012-12-12 21:15:54 +000069}
70
John Kessenich94a81fb2013-08-31 02:41:30 +000071// Command-line options
72enum TOptions {
John Kessenich906cc212016-12-09 19:22:20 -070073 EOptionNone = 0,
74 EOptionIntermediate = (1 << 0),
75 EOptionSuppressInfolog = (1 << 1),
76 EOptionMemoryLeakMode = (1 << 2),
77 EOptionRelaxedErrors = (1 << 3),
78 EOptionGiveWarnings = (1 << 4),
79 EOptionLinkProgram = (1 << 5),
80 EOptionMultiThreaded = (1 << 6),
81 EOptionDumpConfig = (1 << 7),
82 EOptionDumpReflection = (1 << 8),
83 EOptionSuppressWarnings = (1 << 9),
84 EOptionDumpVersions = (1 << 10),
85 EOptionSpv = (1 << 11),
86 EOptionHumanReadableSpv = (1 << 12),
87 EOptionVulkanRules = (1 << 13),
88 EOptionDefaultDesktop = (1 << 14),
89 EOptionOutputPreprocessed = (1 << 15),
90 EOptionOutputHexadecimal = (1 << 16),
91 EOptionReadHlsl = (1 << 17),
92 EOptionCascadingErrors = (1 << 18),
93 EOptionAutoMapBindings = (1 << 19),
steve-lunarge0b9deb2016-09-16 13:26:37 -060094 EOptionFlattenUniformArrays = (1 << 20),
John Kessenich906cc212016-12-09 19:22:20 -070095 EOptionNoStorageFormat = (1 << 21),
John Kessenich20f01e72016-12-12 11:41:43 -070096 EOptionKeepUncalled = (1 << 22),
John Kessenich4f1403e2017-04-05 17:38:20 -060097 EOptionHlslOffsets = (1 << 23),
steve-lunargbe283552017-04-18 12:18:01 -060098 EOptionHlslIoMapping = (1 << 24),
John Kessenich71facdf2017-05-17 18:28:19 -060099 EOptionAutoMapLocations = (1 << 25),
John Kessenich121853f2017-05-31 17:11:16 -0600100 EOptionDebug = (1 << 26),
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +0200101 EOptionStdin = (1 << 27),
GregFcd1f1692017-09-21 18:40:22 -0600102 EOptionOptimizeDisable = (1 << 28),
103 EOptionOptimizeSize = (1 << 29),
LoopDawgb22c0692017-12-06 16:52:03 -0700104 EOptionInvertY = (1 << 30),
John Kessenichc6c80a62018-03-05 22:23:17 -0700105 EOptionDumpBareVersion = (1 << 31),
John Kessenich94a81fb2013-08-31 02:41:30 +0000106};
John Kessenich5d610ee2018-03-07 18:05:55 -0700107bool targetHlslFunctionality1 = false;
John Kesseniche2156222018-06-11 18:12:15 -0600108bool SpvToolsDisassembler = false;
John Kessenichc3404252018-08-23 15:29:08 -0600109bool SpvToolsValidate = false;
John Kessenich605afc72019-06-17 23:33:09 -0600110bool NaNClamp = false;
Shahbaz Youssefid52dce52020-06-17 12:47:44 -0400111bool stripDebugInfo = false;
Marcin Åšlusarz245c30c2020-07-03 14:55:29 +0200112bool beQuiet = false;
John Kessenich94a81fb2013-08-31 02:41:30 +0000113
John Kessenicha0af4732012-12-12 21:15:54 +0000114//
John Kessenich68d78fd2015-07-12 19:28:10 -0600115// Return codes from main/exit().
John Kessenicha0af4732012-12-12 21:15:54 +0000116//
117enum TFailCode {
118 ESuccess = 0,
119 EFailUsage,
120 EFailCompile,
121 EFailLink,
122 EFailCompilerCreate,
John Kessenich2b07c7e2013-07-31 18:44:13 +0000123 EFailThreadCreate,
John Kessenicha0af4732012-12-12 21:15:54 +0000124 EFailLinkerCreate
125};
126
127//
John Kessenich68d78fd2015-07-12 19:28:10 -0600128// Forward declarations.
John Kessenicha0af4732012-12-12 21:15:54 +0000129//
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600130EShLanguage FindLanguage(const std::string& name, bool parseSuffix=true);
John Kessenich51cdd902014-02-18 23:37:57 +0000131void CompileFile(const char* fileName, ShHandle);
John Kessenicha0af4732012-12-12 21:15:54 +0000132void usage();
John Kessenich04acb1b2017-06-14 17:36:50 -0600133char* ReadFileData(const char* fileName);
134void FreeFileData(char* data);
John Kessenich54d8cda2013-02-11 22:36:01 +0000135void InfoLogMsg(const char* msg, const char* name, const int num);
John Kessenich41cf6b52013-06-25 18:10:05 +0000136
John Kessenichc999ba22013-11-07 23:33:24 +0000137// Globally track if any compile or link failure.
138bool CompileFailed = false;
139bool LinkFailed = false;
140
John Kessenich94f28eb2017-11-13 01:32:06 -0700141// array of unique places to leave the shader names and infologs for the asynchronous compiles
142std::vector<std::unique_ptr<glslang::TWorkItem>> WorkItems;
143
John Kessenich05a70632013-09-17 19:26:08 +0000144TBuiltInResource Resources;
145std::string ConfigFile;
146
John Kessenicha0af4732012-12-12 21:15:54 +0000147//
John Kessenichf0bcb0a2016-04-02 13:09:14 -0600148// Parse either a .conf file provided by the user or the default from glslang::DefaultTBuiltInResource
John Kessenich05a70632013-09-17 19:26:08 +0000149//
150void ProcessConfigFile()
John Kessenichb51f62c2013-04-11 16:31:09 +0000151{
John Kessenich04acb1b2017-06-14 17:36:50 -0600152 if (ConfigFile.size() == 0)
Lei Zhang414eb602016-03-04 16:22:34 -0500153 Resources = glslang::DefaultTBuiltInResource;
John Kessenich23d27752019-07-28 02:12:10 -0600154#ifndef GLSLANG_WEB
John Kessenich04acb1b2017-06-14 17:36:50 -0600155 else {
156 char* configString = ReadFileData(ConfigFile.c_str());
157 glslang::DecodeResourceLimits(&Resources, configString);
158 FreeFileData(configString);
John Kessenich05a70632013-09-17 19:26:08 +0000159 }
John Kessenich23d27752019-07-28 02:12:10 -0600160#endif
John Kessenicha0af4732012-12-12 21:15:54 +0000161}
162
baldurk6d477852019-01-29 15:45:56 +0000163int ReflectOptions = EShReflectionDefault;
John Kessenich94a81fb2013-08-31 02:41:30 +0000164int Options = 0;
John Kessenich68d78fd2015-07-12 19:28:10 -0600165const char* ExecutableName = nullptr;
166const char* binaryFileName = nullptr;
John Kessenich4d65ee32016-03-12 18:17:47 -0700167const char* entryPointName = nullptr;
steve-lunargf1e0c872016-10-31 15:13:43 -0600168const char* sourceEntryPointName = nullptr;
Dan Bakerc6ede892016-08-11 14:06:06 -0400169const char* shaderStageName = nullptr;
Flavioaea3c892017-02-06 11:46:35 -0800170const char* variableName = nullptr;
Rex Xucb61eec2018-03-07 13:10:01 +0800171bool HlslEnable16BitTypes = false;
John Kessenichbd1c1832018-12-07 18:38:26 -0700172bool HlslDX9compatible = false;
Christoph Kubisch55ba3ea2019-04-13 22:18:16 +0200173bool DumpBuiltinSymbols = false;
John Kessenich971a0a82017-06-07 15:06:58 -0600174std::vector<std::string> IncludeDirectoryList;
John Kessenich8717a5d2018-10-26 10:12:32 -0600175
176// Source environment
177// (source 'Client' is currently the same as target 'Client')
178int ClientInputSemanticsVersion = 100;
179
180// Target environment
181glslang::EShClient Client = glslang::EShClientNone; // will stay EShClientNone if only validating
182glslang::EShTargetClientVersion ClientVersion; // not valid until Client is set
183glslang::EShTargetLanguage TargetLanguage = glslang::EShTargetNone;
184glslang::EShTargetLanguageVersion TargetVersion; // not valid until TargetLanguage is set
185
John Kessenich66011cb2018-03-06 16:12:04 -0700186std::vector<std::string> Processes; // what should be recorded by OpModuleProcessed, or equivalent
John Kessenich68d78fd2015-07-12 19:28:10 -0600187
LoopDawg08a14422017-10-17 19:27:14 -0600188// Per descriptor-set binding base data
189typedef std::map<unsigned int, unsigned int> TPerSetBaseBinding;
190
Neil Roberts16f53472018-03-20 17:30:53 +0100191std::vector<std::pair<std::string, int>> uniformLocationOverrides;
Neil Robertsb0f3d792018-03-20 17:41:05 +0100192int uniformBase = 0;
Neil Roberts16f53472018-03-20 17:30:53 +0100193
LoopDawg08a14422017-10-17 19:27:14 -0600194std::array<std::array<unsigned int, EShLangCount>, glslang::EResCount> baseBinding;
195std::array<std::array<TPerSetBaseBinding, EShLangCount>, glslang::EResCount> baseBindingForSet;
Hyangran Park36dc8292017-05-02 16:27:29 +0900196std::array<std::vector<std::string>, EShLangCount> baseResourceSetBinding;
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600197
John Kessenicha9313662017-06-15 10:40:49 -0600198// Add things like "#define ..." to a preamble to use in the beginning of the shader.
199class TPreamble {
200public:
201 TPreamble() { }
202
203 bool isSet() const { return text.size() > 0; }
204 const char* get() const { return text.c_str(); }
205
206 // #define...
207 void addDef(std::string def)
208 {
209 text.append("#define ");
210 fixLine(def);
211
John Kessenich6f988922020-01-07 07:03:11 -0700212 Processes.push_back("define-macro ");
John Kessenich2a271162017-07-20 20:00:36 -0600213 Processes.back().append(def);
214
John Kessenicha9313662017-06-15 10:40:49 -0600215 // The first "=" needs to turn into a space
LoopDawgb97b25e2017-07-12 09:04:39 -0600216 const size_t equal = def.find_first_of("=");
John Kessenicha9313662017-06-15 10:40:49 -0600217 if (equal != def.npos)
218 def[equal] = ' ';
219
220 text.append(def);
221 text.append("\n");
222 }
223
224 // #undef...
225 void addUndef(std::string undef)
226 {
227 text.append("#undef ");
228 fixLine(undef);
John Kessenich2a271162017-07-20 20:00:36 -0600229
John Kessenich6f988922020-01-07 07:03:11 -0700230 Processes.push_back("undef-macro ");
John Kessenich2a271162017-07-20 20:00:36 -0600231 Processes.back().append(undef);
232
John Kessenicha9313662017-06-15 10:40:49 -0600233 text.append(undef);
234 text.append("\n");
235 }
236
237protected:
238 void fixLine(std::string& line)
239 {
240 // Can't go past a newline in the line
LoopDawgb97b25e2017-07-12 09:04:39 -0600241 const size_t end = line.find_first_of("\n");
John Kessenicha9313662017-06-15 10:40:49 -0600242 if (end != line.npos)
243 line = line.substr(0, end);
244 }
245
246 std::string text; // contents of preamble
247};
248
John Kessenich83855b92020-03-30 00:27:31 -0600249// Track the user's #define and #undef from the command line.
John Kessenicha9313662017-06-15 10:40:49 -0600250TPreamble UserPreamble;
251
John Kessenich68d78fd2015-07-12 19:28:10 -0600252//
253// Create the default name for saving a binary if -o is not provided.
254//
255const char* GetBinaryName(EShLanguage stage)
256{
257 const char* name;
258 if (binaryFileName == nullptr) {
259 switch (stage) {
260 case EShLangVertex: name = "vert.spv"; break;
261 case EShLangTessControl: name = "tesc.spv"; break;
262 case EShLangTessEvaluation: name = "tese.spv"; break;
263 case EShLangGeometry: name = "geom.spv"; break;
264 case EShLangFragment: name = "frag.spv"; break;
265 case EShLangCompute: name = "comp.spv"; break;
Daniel Kochdb32b242020-03-17 20:42:47 -0400266 case EShLangRayGen: name = "rgen.spv"; break;
267 case EShLangIntersect: name = "rint.spv"; break;
268 case EShLangAnyHit: name = "rahit.spv"; break;
269 case EShLangClosestHit: name = "rchit.spv"; break;
270 case EShLangMiss: name = "rmiss.spv"; break;
271 case EShLangCallable: name = "rcall.spv"; break;
Chao Chen3c366992018-09-19 11:41:59 -0700272 case EShLangMeshNV: name = "mesh.spv"; break;
273 case EShLangTaskNV: name = "task.spv"; break;
John Kessenich68d78fd2015-07-12 19:28:10 -0600274 default: name = "unknown"; break;
275 }
276 } else
277 name = binaryFileName;
278
279 return name;
280}
John Kessenich2b07c7e2013-07-31 18:44:13 +0000281
John Kessenich05a70632013-09-17 19:26:08 +0000282//
283// *.conf => this is a config file that can set limits/resources
284//
285bool SetConfigFile(const std::string& name)
286{
287 if (name.size() < 5)
288 return false;
289
John Kessenich4c706852013-10-11 16:28:43 +0000290 if (name.compare(name.size() - 5, 5, ".conf") == 0) {
John Kessenich05a70632013-09-17 19:26:08 +0000291 ConfigFile = name;
292 return true;
293 }
294
295 return false;
296}
297
John Kessenich68d78fd2015-07-12 19:28:10 -0600298//
299// Give error and exit with failure code.
300//
John Kessenichbd97b6f2019-12-20 10:33:13 -0700301void Error(const char* message, const char* detail = nullptr)
John Kessenich68d78fd2015-07-12 19:28:10 -0600302{
John Kessenichbd97b6f2019-12-20 10:33:13 -0700303 fprintf(stderr, "%s: Error: ", ExecutableName);
304 if (detail != nullptr)
305 fprintf(stderr, "%s: ", detail);
306 fprintf(stderr, "%s (use -h for usage)\n", message);
John Kessenich68d78fd2015-07-12 19:28:10 -0600307 exit(EFailUsage);
308}
309
310//
LoopDawg08a14422017-10-17 19:27:14 -0600311// Process an optional binding base of one the forms:
312// --argname [stage] base // base for stage (if given) or all stages (if not)
LoopDawge5709552017-10-21 10:46:39 -0600313// --argname [stage] [base set]... // set/base pairs: set the base for given binding set.
LoopDawg08a14422017-10-17 19:27:14 -0600314
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600315// Where stage is one of the forms accepted by FindLanguage, and base is an integer
316//
LoopDawg08a14422017-10-17 19:27:14 -0600317void ProcessBindingBase(int& argc, char**& argv, glslang::TResourceType res)
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600318{
319 if (argc < 2)
320 usage();
321
LoopDawg08a14422017-10-17 19:27:14 -0600322 EShLanguage lang = EShLangCount;
323 int singleBase = 0;
324 TPerSetBaseBinding perSetBase;
325 int arg = 1;
326
327 // Parse stage, if given
328 if (!isdigit(argv[arg][0])) {
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600329 if (argc < 3) // this form needs one more argument
330 usage();
John Kessenichecba76f2017-01-06 00:34:48 -0700331
LoopDawg08a14422017-10-17 19:27:14 -0600332 lang = FindLanguage(argv[arg++], false);
333 }
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600334
LoopDawg08a14422017-10-17 19:27:14 -0600335 if ((argc - arg) > 2 && isdigit(argv[arg+0][0]) && isdigit(argv[arg+1][0])) {
336 // Parse a per-set binding base
337 while ((argc - arg) > 2 && isdigit(argv[arg+0][0]) && isdigit(argv[arg+1][0])) {
LoopDawg08a14422017-10-17 19:27:14 -0600338 const int baseNum = atoi(argv[arg++]);
LoopDawge5709552017-10-21 10:46:39 -0600339 const int setNum = atoi(argv[arg++]);
LoopDawg08a14422017-10-17 19:27:14 -0600340 perSetBase[setNum] = baseNum;
341 }
342 } else {
343 // Parse single binding base
344 singleBase = atoi(argv[arg++]);
345 }
346
347 argc -= (arg-1);
348 argv += (arg-1);
349
350 // Set one or all languages
351 const int langMin = (lang < EShLangCount) ? lang+0 : 0;
352 const int langMax = (lang < EShLangCount) ? lang+1 : EShLangCount;
353
354 for (int lang = langMin; lang < langMax; ++lang) {
355 if (!perSetBase.empty())
John Kessenich251901a2018-08-12 22:05:59 -0600356 baseBindingForSet[res][lang].insert(perSetBase.begin(), perSetBase.end());
LoopDawg08a14422017-10-17 19:27:14 -0600357 else
358 baseBinding[res][lang] = singleBase;
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600359 }
360}
361
Hyangran Park36dc8292017-05-02 16:27:29 +0900362void ProcessResourceSetBindingBase(int& argc, char**& argv, std::array<std::vector<std::string>, EShLangCount>& base)
363{
364 if (argc < 2)
365 usage();
366
367 if (!isdigit(argv[1][0])) {
LoopDawg52017192017-07-14 15:15:47 -0600368 if (argc < 3) // this form needs one more argument
Hyangran Park36dc8292017-05-02 16:27:29 +0900369 usage();
370
LoopDawg52017192017-07-14 15:15:47 -0600371 // Parse form: --argname stage [regname set base...], or:
372 // --argname stage set
Hyangran Park36dc8292017-05-02 16:27:29 +0900373 const EShLanguage lang = FindLanguage(argv[1], false);
374
LoopDawg52017192017-07-14 15:15:47 -0600375 argc--;
376 argv++;
377
378 while (argc > 1 && argv[1] != nullptr && argv[1][0] != '-') {
379 base[lang].push_back(argv[1]);
380
381 argc--;
382 argv++;
Hyangran Park36dc8292017-05-02 16:27:29 +0900383 }
LoopDawg52017192017-07-14 15:15:47 -0600384
385 // Must have one arg, or a multiple of three (for [regname set binding] triples)
386 if (base[lang].size() != 1 && (base[lang].size() % 3) != 0)
387 usage();
388
Hyangran Park36dc8292017-05-02 16:27:29 +0900389 } else {
LoopDawg52017192017-07-14 15:15:47 -0600390 // Parse form: --argname set
Hyangran Park36dc8292017-05-02 16:27:29 +0900391 for (int lang=0; lang<EShLangCount; ++lang)
392 base[lang].push_back(argv[1]);
393
394 argc--;
395 argv++;
396 }
397}
398
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600399//
John Kessenich68d78fd2015-07-12 19:28:10 -0600400// Do all command-line argument parsing. This includes building up the work-items
401// to be processed later, and saving all the command-line options.
402//
403// Does not return (it exits) if command-line is fatally flawed.
404//
Juan Lopeza558b262017-04-02 23:04:00 +0200405void ProcessArguments(std::vector<std::unique_ptr<glslang::TWorkItem>>& workItems, int argc, char* argv[])
John Kessenich2b07c7e2013-07-31 18:44:13 +0000406{
LoopDawg08a14422017-10-17 19:27:14 -0600407 for (int res = 0; res < glslang::EResCount; ++res)
408 baseBinding[res].fill(0);
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600409
John Kessenich38f3b892013-09-06 19:52:57 +0000410 ExecutableName = argv[0];
Juan Lopeza558b262017-04-02 23:04:00 +0200411 workItems.reserve(argc);
John Kessenich38f3b892013-09-06 19:52:57 +0000412
John Kessenichc178f0a2017-06-23 10:58:31 -0600413 const auto bumpArg = [&]() {
414 if (argc > 0) {
415 argc--;
416 argv++;
417 }
418 };
419
420 // read a string directly attached to a single-letter option
John Kessenich6263fb12017-06-14 15:52:44 -0600421 const auto getStringOperand = [&](const char* desc) {
422 if (argv[0][2] == 0) {
423 printf("%s must immediately follow option (no spaces)\n", desc);
424 exit(EFailUsage);
425 }
426 return argv[0] + 2;
427 };
428
John Kessenich6353d552017-06-23 11:11:09 -0600429 // read a number attached to a single-letter option
430 const auto getAttachedNumber = [&](const char* desc) {
431 int num = atoi(argv[0] + 2);
432 if (num == 0) {
433 printf("%s: expected attached non-0 number\n", desc);
434 exit(EFailUsage);
435 }
436 return num;
437 };
438
439 // minimum needed (without overriding something else) to target Vulkan SPIR-V
440 const auto setVulkanSpv = []() {
John Kessenich8717a5d2018-10-26 10:12:32 -0600441 if (Client == glslang::EShClientNone)
442 ClientVersion = glslang::EShTargetVulkan_1_0;
443 Client = glslang::EShClientVulkan;
John Kessenich6353d552017-06-23 11:11:09 -0600444 Options |= EOptionSpv;
445 Options |= EOptionVulkanRules;
446 Options |= EOptionLinkProgram;
447 };
448
449 // minimum needed (without overriding something else) to target OpenGL SPIR-V
450 const auto setOpenGlSpv = []() {
John Kessenich8717a5d2018-10-26 10:12:32 -0600451 if (Client == glslang::EShClientNone)
452 ClientVersion = glslang::EShTargetOpenGL_450;
453 Client = glslang::EShClientOpenGL;
John Kessenich6353d552017-06-23 11:11:09 -0600454 Options |= EOptionSpv;
455 Options |= EOptionLinkProgram;
456 // undo a -H default to Vulkan
457 Options &= ~EOptionVulkanRules;
458 };
459
Neil Roberts16f53472018-03-20 17:30:53 +0100460 const auto getUniformOverride = [getStringOperand]() {
461 const char *arg = getStringOperand("-u<name>:<location>");
462 const char *split = strchr(arg, ':');
463 if (split == NULL) {
464 printf("%s: missing location\n", arg);
465 exit(EFailUsage);
466 }
467 errno = 0;
468 int location = ::strtol(split + 1, NULL, 10);
469 if (errno) {
470 printf("%s: invalid location\n", arg);
471 exit(EFailUsage);
472 }
473 return std::make_pair(std::string(arg, split - arg), location);
474 };
475
John Kessenichc178f0a2017-06-23 10:58:31 -0600476 for (bumpArg(); argc >= 1; bumpArg()) {
John Kessenich2b07c7e2013-07-31 18:44:13 +0000477 if (argv[0][0] == '-') {
John Kessenich2aa7f3a2015-05-15 16:02:07 +0000478 switch (argv[0][1]) {
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600479 case '-':
480 {
481 std::string lowerword(argv[0]+2);
482 std::transform(lowerword.begin(), lowerword.end(), lowerword.begin(), ::tolower);
483
484 // handle --word style options
John Kessenich6263fb12017-06-14 15:52:44 -0600485 if (lowerword == "auto-map-bindings" || // synonyms
John Kessenich6353d552017-06-23 11:11:09 -0600486 lowerword == "auto-map-binding" ||
487 lowerword == "amb") {
John Kessenich6263fb12017-06-14 15:52:44 -0600488 Options |= EOptionAutoMapBindings;
489 } else if (lowerword == "auto-map-locations" || // synonyms
490 lowerword == "aml") {
491 Options |= EOptionAutoMapLocations;
Neil Robertsb0f3d792018-03-20 17:41:05 +0100492 } else if (lowerword == "uniform-base") {
493 if (argc <= 1)
John Kessenichbd97b6f2019-12-20 10:33:13 -0700494 Error("no <base> provided", lowerword.c_str());
Neil Robertsb0f3d792018-03-20 17:41:05 +0100495 uniformBase = ::strtol(argv[1], NULL, 10);
496 bumpArg();
497 break;
John Kessenich6353d552017-06-23 11:11:09 -0600498 } else if (lowerword == "client") {
499 if (argc > 1) {
500 if (strcmp(argv[1], "vulkan100") == 0)
501 setVulkanSpv();
502 else if (strcmp(argv[1], "opengl100") == 0)
503 setOpenGlSpv();
504 else
John Kessenichbd97b6f2019-12-20 10:33:13 -0700505 Error("expects vulkan100 or opengl100", lowerword.c_str());
506 } else
507 Error("expects vulkan100 or opengl100", lowerword.c_str());
John Kessenich6353d552017-06-23 11:11:09 -0600508 bumpArg();
John Kessenich6f988922020-01-07 07:03:11 -0700509 } else if (lowerword == "define-macro" ||
510 lowerword == "d") {
511 if (argc > 1)
512 UserPreamble.addDef(argv[1]);
513 else
514 Error("expects <name[=def]>", argv[0]);
515 bumpArg();
Christoph Kubisch55ba3ea2019-04-13 22:18:16 +0200516 } else if (lowerword == "dump-builtin-symbols") {
517 DumpBuiltinSymbols = true;
John Kessenich640bd092018-08-09 14:15:00 -0600518 } else if (lowerword == "entry-point") {
519 entryPointName = argv[1];
520 if (argc <= 1)
John Kessenichbd97b6f2019-12-20 10:33:13 -0700521 Error("no <name> provided", lowerword.c_str());
John Kessenich640bd092018-08-09 14:15:00 -0600522 bumpArg();
John Kessenich6263fb12017-06-14 15:52:44 -0600523 } else if (lowerword == "flatten-uniform-arrays" || // synonyms
524 lowerword == "flatten-uniform-array" ||
525 lowerword == "fua") {
526 Options |= EOptionFlattenUniformArrays;
527 } else if (lowerword == "hlsl-offsets") {
528 Options |= EOptionHlslOffsets;
529 } else if (lowerword == "hlsl-iomap" ||
530 lowerword == "hlsl-iomapper" ||
531 lowerword == "hlsl-iomapping") {
532 Options |= EOptionHlslIoMapping;
Rex Xucb61eec2018-03-07 13:10:01 +0800533 } else if (lowerword == "hlsl-enable-16bit-types") {
534 HlslEnable16BitTypes = true;
John Kessenichbd1c1832018-12-07 18:38:26 -0700535 } else if (lowerword == "hlsl-dx9-compatible") {
536 HlslDX9compatible = true;
John Kessenichc6c80a62018-03-05 22:23:17 -0700537 } else if (lowerword == "invert-y" || // synonyms
538 lowerword == "iy") {
539 Options |= EOptionInvertY;
John Kessenich6263fb12017-06-14 15:52:44 -0600540 } else if (lowerword == "keep-uncalled" || // synonyms
541 lowerword == "ku") {
542 Options |= EOptionKeepUncalled;
John Kessenich605afc72019-06-17 23:33:09 -0600543 } else if (lowerword == "nan-clamp") {
544 NaNClamp = true;
John Kessenich6263fb12017-06-14 15:52:44 -0600545 } else if (lowerword == "no-storage-format" || // synonyms
546 lowerword == "nsf") {
547 Options |= EOptionNoStorageFormat;
John Kessenich2a271162017-07-20 20:00:36 -0600548 } else if (lowerword == "relaxed-errors") {
549 Options |= EOptionRelaxedErrors;
baldurk15c37f72019-01-29 12:12:59 +0000550 } else if (lowerword == "reflect-strict-array-suffix") {
551 ReflectOptions |= EShReflectionStrictArraySuffix;
baldurkedf82122019-01-29 15:49:00 +0000552 } else if (lowerword == "reflect-basic-array-suffix") {
553 ReflectOptions |= EShReflectionBasicArraySuffix;
baldurk0af5e3e2019-01-29 16:04:44 +0000554 } else if (lowerword == "reflect-intermediate-io") {
555 ReflectOptions |= EShReflectionIntermediateIO;
baldurk657acc02019-01-30 14:18:43 +0000556 } else if (lowerword == "reflect-separate-buffers") {
557 ReflectOptions |= EShReflectionSeparateBuffers;
baldurka972e732019-01-30 15:34:02 +0000558 } else if (lowerword == "reflect-all-block-variables") {
559 ReflectOptions |= EShReflectionAllBlockVariables;
baldurk19050692019-02-11 11:50:24 +0000560 } else if (lowerword == "reflect-unwrap-io-blocks") {
561 ReflectOptions |= EShReflectionUnwrapIOBlocks;
Chow81112682020-06-04 15:47:18 +0800562 } else if (lowerword == "reflect-all-io-variables") {
563 ReflectOptions |= EShReflectionAllIOVariables;
564 } else if (lowerword == "reflect-shared-std140-ubo") {
565 ReflectOptions |= EShReflectionSharedStd140UBO;
566 } else if (lowerword == "reflect-shared-std140-ssbo") {
567 ReflectOptions |= EShReflectionSharedStd140SSBO;
John Kessenich6263fb12017-06-14 15:52:44 -0600568 } else if (lowerword == "resource-set-bindings" || // synonyms
569 lowerword == "resource-set-binding" ||
570 lowerword == "rsb") {
571 ProcessResourceSetBindingBase(argc, argv, baseResourceSetBinding);
steve-lunarg9088be42016-11-01 10:31:42 -0600572 } else if (lowerword == "shift-image-bindings" || // synonyms
573 lowerword == "shift-image-binding" ||
574 lowerword == "sib") {
LoopDawg08a14422017-10-17 19:27:14 -0600575 ProcessBindingBase(argc, argv, glslang::EResImage);
John Kessenich6263fb12017-06-14 15:52:44 -0600576 } else if (lowerword == "shift-sampler-bindings" || // synonyms
John Kessenichade8bbb2018-08-12 21:24:55 -0600577 lowerword == "shift-sampler-binding" ||
578 lowerword == "ssb") {
LoopDawg08a14422017-10-17 19:27:14 -0600579 ProcessBindingBase(argc, argv, glslang::EResSampler);
John Kessenich6263fb12017-06-14 15:52:44 -0600580 } else if (lowerword == "shift-uav-bindings" || // synonyms
581 lowerword == "shift-uav-binding" ||
582 lowerword == "suavb") {
LoopDawg08a14422017-10-17 19:27:14 -0600583 ProcessBindingBase(argc, argv, glslang::EResUav);
John Kessenich6263fb12017-06-14 15:52:44 -0600584 } else if (lowerword == "shift-texture-bindings" || // synonyms
585 lowerword == "shift-texture-binding" ||
586 lowerword == "stb") {
LoopDawg08a14422017-10-17 19:27:14 -0600587 ProcessBindingBase(argc, argv, glslang::EResTexture);
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600588 } else if (lowerword == "shift-ubo-bindings" || // synonyms
589 lowerword == "shift-ubo-binding" ||
steve-lunargbe283552017-04-18 12:18:01 -0600590 lowerword == "shift-cbuffer-bindings" ||
591 lowerword == "shift-cbuffer-binding" ||
592 lowerword == "sub" ||
593 lowerword == "scb") {
LoopDawg08a14422017-10-17 19:27:14 -0600594 ProcessBindingBase(argc, argv, glslang::EResUbo);
steve-lunarg932bb5c2017-02-21 17:19:08 -0700595 } else if (lowerword == "shift-ssbo-bindings" || // synonyms
596 lowerword == "shift-ssbo-binding" ||
597 lowerword == "sbb") {
LoopDawg08a14422017-10-17 19:27:14 -0600598 ProcessBindingBase(argc, argv, glslang::EResSsbo);
John Kessenich6263fb12017-06-14 15:52:44 -0600599 } else if (lowerword == "source-entrypoint" || // synonyms
600 lowerword == "sep") {
John Kessenichc178f0a2017-06-23 10:58:31 -0600601 if (argc <= 1)
John Kessenichbd97b6f2019-12-20 10:33:13 -0700602 Error("no <entry-point> provided", lowerword.c_str());
John Kessenichc178f0a2017-06-23 10:58:31 -0600603 sourceEntryPointName = argv[1];
604 bumpArg();
John Kessenich6263fb12017-06-14 15:52:44 -0600605 break;
John Kesseniche2156222018-06-11 18:12:15 -0600606 } else if (lowerword == "spirv-dis") {
607 SpvToolsDisassembler = true;
John Kessenichc3404252018-08-23 15:29:08 -0600608 } else if (lowerword == "spirv-val") {
609 SpvToolsValidate = true;
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +0200610 } else if (lowerword == "stdin") {
611 Options |= EOptionStdin;
612 shaderStageName = argv[1];
John Kessenich2a271162017-07-20 20:00:36 -0600613 } else if (lowerword == "suppress-warnings") {
614 Options |= EOptionSuppressWarnings;
John Kessenich6353d552017-06-23 11:11:09 -0600615 } else if (lowerword == "target-env") {
616 if (argc > 1) {
617 if (strcmp(argv[1], "vulkan1.0") == 0) {
618 setVulkanSpv();
John Kessenich8717a5d2018-10-26 10:12:32 -0600619 ClientVersion = glslang::EShTargetVulkan_1_0;
John Kessenich66011cb2018-03-06 16:12:04 -0700620 } else if (strcmp(argv[1], "vulkan1.1") == 0) {
621 setVulkanSpv();
John Kessenich8717a5d2018-10-26 10:12:32 -0600622 ClientVersion = glslang::EShTargetVulkan_1_1;
John Kessenich273d3a52020-01-15 00:10:41 -0700623 } else if (strcmp(argv[1], "vulkan1.2") == 0) {
624 setVulkanSpv();
625 ClientVersion = glslang::EShTargetVulkan_1_2;
John Kessenich6353d552017-06-23 11:11:09 -0600626 } else if (strcmp(argv[1], "opengl") == 0) {
627 setOpenGlSpv();
John Kessenich8717a5d2018-10-26 10:12:32 -0600628 ClientVersion = glslang::EShTargetOpenGL_450;
629 } else if (strcmp(argv[1], "spirv1.0") == 0) {
630 TargetLanguage = glslang::EShTargetSpv;
631 TargetVersion = glslang::EShTargetSpv_1_0;
632 } else if (strcmp(argv[1], "spirv1.1") == 0) {
633 TargetLanguage = glslang::EShTargetSpv;
634 TargetVersion = glslang::EShTargetSpv_1_1;
635 } else if (strcmp(argv[1], "spirv1.2") == 0) {
636 TargetLanguage = glslang::EShTargetSpv;
637 TargetVersion = glslang::EShTargetSpv_1_2;
638 } else if (strcmp(argv[1], "spirv1.3") == 0) {
639 TargetLanguage = glslang::EShTargetSpv;
640 TargetVersion = glslang::EShTargetSpv_1_3;
641 } else if (strcmp(argv[1], "spirv1.4") == 0) {
642 TargetLanguage = glslang::EShTargetSpv;
643 TargetVersion = glslang::EShTargetSpv_1_4;
John Kessenich8317e6c2019-08-18 23:58:08 -0600644 } else if (strcmp(argv[1], "spirv1.5") == 0) {
645 TargetLanguage = glslang::EShTargetSpv;
646 TargetVersion = glslang::EShTargetSpv_1_5;
John Kessenich6353d552017-06-23 11:11:09 -0600647 } else
John Kessenich273d3a52020-01-15 00:10:41 -0700648 Error("--target-env expected one of: vulkan1.0, vulkan1.1, vulkan1.2, opengl,\n"
John Kessenich8317e6c2019-08-18 23:58:08 -0600649 "spirv1.0, spirv1.1, spirv1.2, spirv1.3, spirv1.4, or spirv1.5");
John Kessenich6353d552017-06-23 11:11:09 -0600650 }
651 bumpArg();
John Kessenich6f988922020-01-07 07:03:11 -0700652 } else if (lowerword == "undef-macro" ||
653 lowerword == "u") {
654 if (argc > 1)
655 UserPreamble.addUndef(argv[1]);
656 else
657 Error("expects <name>", argv[0]);
658 bumpArg();
Flavio15017db2017-02-15 14:29:33 -0800659 } else if (lowerword == "variable-name" || // synonyms
John Kessenich66011cb2018-03-06 16:12:04 -0700660 lowerword == "vn") {
Flavio15017db2017-02-15 14:29:33 -0800661 Options |= EOptionOutputHexadecimal;
John Kessenichc178f0a2017-06-23 10:58:31 -0600662 if (argc <= 1)
John Kessenichbd97b6f2019-12-20 10:33:13 -0700663 Error("no <C-variable-name> provided", lowerword.c_str());
John Kessenichc178f0a2017-06-23 10:58:31 -0600664 variableName = argv[1];
665 bumpArg();
Flavio15017db2017-02-15 14:29:33 -0800666 break;
Marcin Åšlusarz245c30c2020-07-03 14:55:29 +0200667 } else if (lowerword == "quiet") {
668 beQuiet = true;
John Kessenichc6c80a62018-03-05 22:23:17 -0700669 } else if (lowerword == "version") {
670 Options |= EOptionDumpVersions;
Jordan Justen6ad120e2020-01-28 12:18:12 -0800671 } else if (lowerword == "help") {
672 usage();
673 break;
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600674 } else {
John Kessenichbd97b6f2019-12-20 10:33:13 -0700675 Error("unrecognized command-line option", argv[0]);
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600676 }
677 }
678 break;
John Kessenich6263fb12017-06-14 15:52:44 -0600679 case 'C':
680 Options |= EOptionCascadingErrors;
681 break;
682 case 'D':
John Kessenicha9313662017-06-15 10:40:49 -0600683 if (argv[0][2] == 0)
684 Options |= EOptionReadHlsl;
685 else
John Kessenich6f988922020-01-07 07:03:11 -0700686 UserPreamble.addDef(getStringOperand("-D<name[=def]>"));
John Kessenich6263fb12017-06-14 15:52:44 -0600687 break;
Neil Roberts16f53472018-03-20 17:30:53 +0100688 case 'u':
689 uniformLocationOverrides.push_back(getUniformOverride());
690 break;
John Kessenich6263fb12017-06-14 15:52:44 -0600691 case 'E':
692 Options |= EOptionOutputPreprocessed;
693 break;
694 case 'G':
John Kessenich8717a5d2018-10-26 10:12:32 -0600695 // OpenGL client
John Kessenich6353d552017-06-23 11:11:09 -0600696 setOpenGlSpv();
697 if (argv[0][2] != 0)
698 ClientInputSemanticsVersion = getAttachedNumber("-G<num> client input semantics");
johnkslang2de6d652020-08-04 07:17:39 -0600699 if (ClientInputSemanticsVersion != 100)
700 Error("unknown client version for -G, should be 100");
John Kessenich6263fb12017-06-14 15:52:44 -0600701 break;
John Kessenich2aa7f3a2015-05-15 16:02:07 +0000702 case 'H':
703 Options |= EOptionHumanReadableSpv;
John Kessenich91e4aa52016-07-07 17:46:42 -0600704 if ((Options & EOptionSpv) == 0) {
705 // default to Vulkan
John Kessenich6353d552017-06-23 11:11:09 -0600706 setVulkanSpv();
John Kessenich91e4aa52016-07-07 17:46:42 -0600707 }
708 break;
John Kessenich971a0a82017-06-07 15:06:58 -0600709 case 'I':
John Kessenicha9313662017-06-15 10:40:49 -0600710 IncludeDirectoryList.push_back(getStringOperand("-I<dir> include path"));
John Kessenich68d78fd2015-07-12 19:28:10 -0600711 break;
GregFcd1f1692017-09-21 18:40:22 -0600712 case 'O':
713 if (argv[0][2] == 'd')
714 Options |= EOptionOptimizeDisable;
715 else if (argv[0][2] == 's')
GregFfb03a552018-03-29 11:49:14 -0600716#if ENABLE_OPT
GregFcd1f1692017-09-21 18:40:22 -0600717 Options |= EOptionOptimizeSize;
718#else
719 Error("-Os not available; optimizer not linked");
720#endif
721 else
722 Error("unknown -O option");
723 break;
Dan Baker5afdd782016-08-11 17:53:57 -0400724 case 'S':
John Kessenichc178f0a2017-06-23 10:58:31 -0600725 if (argc <= 1)
Dan Baker5afdd782016-08-11 17:53:57 -0400726 Error("no <stage> specified for -S");
John Kessenichc178f0a2017-06-23 10:58:31 -0600727 shaderStageName = argv[1];
728 bumpArg();
dankbaker45d49bc2016-08-08 21:43:07 -0400729 break;
John Kessenicha9313662017-06-15 10:40:49 -0600730 case 'U':
John Kessenich6f988922020-01-07 07:03:11 -0700731 UserPreamble.addUndef(getStringOperand("-U<name>"));
John Kessenicha9313662017-06-15 10:40:49 -0600732 break;
John Kessenich6263fb12017-06-14 15:52:44 -0600733 case 'V':
John Kessenich6353d552017-06-23 11:11:09 -0600734 setVulkanSpv();
735 if (argv[0][2] != 0)
David Neto506d2c22018-02-27 21:55:23 -0500736 ClientInputSemanticsVersion = getAttachedNumber("-V<num> client input semantics");
johnkslang2de6d652020-08-04 07:17:39 -0600737 if (ClientInputSemanticsVersion != 100)
738 Error("unknown client version for -V, should be 100");
John Kessenichc555ddd2015-06-17 02:38:44 +0000739 break;
John Kessenich05a70632013-09-17 19:26:08 +0000740 case 'c':
741 Options |= EOptionDumpConfig;
742 break;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000743 case 'd':
John Kessenichc6c80a62018-03-05 22:23:17 -0700744 if (strncmp(&argv[0][1], "dumpversion", strlen(&argv[0][1]) + 1) == 0 ||
745 strncmp(&argv[0][1], "dumpfullversion", strlen(&argv[0][1]) + 1) == 0)
746 Options |= EOptionDumpBareVersion;
747 else
748 Options |= EOptionDefaultDesktop;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000749 break;
John Kessenich4d65ee32016-03-12 18:17:47 -0700750 case 'e':
John Kessenich4d65ee32016-03-12 18:17:47 -0700751 entryPointName = argv[1];
John Kessenichc178f0a2017-06-23 10:58:31 -0600752 if (argc <= 1)
John Kessenicha25530c2017-09-11 20:13:49 -0600753 Error("no <name> provided for -e");
John Kessenichc178f0a2017-06-23 10:58:31 -0600754 bumpArg();
John Kessenich4d65ee32016-03-12 18:17:47 -0700755 break;
John Kessenich5d610ee2018-03-07 18:05:55 -0700756 case 'f':
757 if (strcmp(&argv[0][2], "hlsl_functionality1") == 0)
758 targetHlslFunctionality1 = true;
759 else
760 Error("-f: expected hlsl_functionality1");
761 break;
John Kessenich121853f2017-05-31 17:11:16 -0600762 case 'g':
Shahbaz Youssefid52dce52020-06-17 12:47:44 -0400763 // Override previous -g or -g0 argument
764 stripDebugInfo = false;
765 Options &= ~EOptionDebug;
766 if (argv[0][2] == '0')
767 stripDebugInfo = true;
768 else
769 Options |= EOptionDebug;
John Kessenich121853f2017-05-31 17:11:16 -0600770 break;
John Kessenich68d78fd2015-07-12 19:28:10 -0600771 case 'h':
772 usage();
773 break;
John Kessenich05a70632013-09-17 19:26:08 +0000774 case 'i':
John Kessenich94a81fb2013-08-31 02:41:30 +0000775 Options |= EOptionIntermediate;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000776 break;
777 case 'l':
John Kessenichd78e3512014-08-25 20:07:55 +0000778 Options |= EOptionLinkProgram;
John Kessenich94a81fb2013-08-31 02:41:30 +0000779 break;
780 case 'm':
781 Options |= EOptionMemoryLeakMode;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000782 break;
John Kessenich68d78fd2015-07-12 19:28:10 -0600783 case 'o':
John Kessenichc178f0a2017-06-23 10:58:31 -0600784 if (argc <= 1)
John Kessenich68d78fd2015-07-12 19:28:10 -0600785 Error("no <file> provided for -o");
John Kessenichc178f0a2017-06-23 10:58:31 -0600786 binaryFileName = argv[1];
787 bumpArg();
John Kessenich68d78fd2015-07-12 19:28:10 -0600788 break;
John Kessenich11f9fc72013-11-07 01:06:34 +0000789 case 'q':
790 Options |= EOptionDumpReflection;
791 break;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000792 case 'r':
John Kessenich94a81fb2013-08-31 02:41:30 +0000793 Options |= EOptionRelaxedErrors;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000794 break;
795 case 's':
John Kessenich94a81fb2013-08-31 02:41:30 +0000796 Options |= EOptionSuppressInfolog;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000797 break;
John Kessenich38f3b892013-09-06 19:52:57 +0000798 case 't':
Juan Lopeza558b262017-04-02 23:04:00 +0200799 Options |= EOptionMultiThreaded;
John Kessenich38f3b892013-09-06 19:52:57 +0000800 break;
John Kessenich319de232013-12-04 04:43:40 +0000801 case 'v':
802 Options |= EOptionDumpVersions;
803 break;
John Kessenichb0a7eb52013-11-07 17:44:20 +0000804 case 'w':
805 Options |= EOptionSuppressWarnings;
806 break;
Johannes van Waverenecb0f3b2016-05-27 12:55:53 -0500807 case 'x':
808 Options |= EOptionOutputHexadecimal;
Johannes van Waverenecb0f3b2016-05-27 12:55:53 -0500809 break;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000810 default:
John Kessenichbd97b6f2019-12-20 10:33:13 -0700811 Error("unrecognized command-line option", argv[0]);
John Kessenich68d78fd2015-07-12 19:28:10 -0600812 break;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000813 }
John Kessenich38f3b892013-09-06 19:52:57 +0000814 } else {
John Kessenich05a70632013-09-17 19:26:08 +0000815 std::string name(argv[0]);
816 if (! SetConfigFile(name)) {
Juan Lopeza558b262017-04-02 23:04:00 +0200817 workItems.push_back(std::unique_ptr<glslang::TWorkItem>(new glslang::TWorkItem(name)));
John Kessenich05a70632013-09-17 19:26:08 +0000818 }
John Kessenich38f3b892013-09-06 19:52:57 +0000819 }
John Kessenich2b07c7e2013-07-31 18:44:13 +0000820 }
821
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +0200822 // Make sure that -S is always specified if --stdin is specified
823 if ((Options & EOptionStdin) && shaderStageName == nullptr)
824 Error("must provide -S when --stdin is given");
825
John Kessenich68d78fd2015-07-12 19:28:10 -0600826 // Make sure that -E is not specified alongside linking (which includes SPV generation)
John Kesseniche5c394b2019-07-02 09:32:48 -0600827 // Or things that require linking
828 if (Options & EOptionOutputPreprocessed) {
829 if (Options & EOptionLinkProgram)
830 Error("can't use -E when linking is selected");
831 if (Options & EOptionDumpReflection)
832 Error("reflection requires linking, which can't be used when -E when is selected");
833 }
834
835 // reflection requires linking
836 if ((Options & EOptionDumpReflection) && !(Options & EOptionLinkProgram))
837 Error("reflection requires -l for linking");
John Kessenichc555ddd2015-06-17 02:38:44 +0000838
Johannes van Waverenecb0f3b2016-05-27 12:55:53 -0500839 // -o or -x makes no sense if there is no target binary
John Kessenich68d78fd2015-07-12 19:28:10 -0600840 if (binaryFileName && (Options & EOptionSpv) == 0)
841 Error("no binary generation requested (e.g., -V)");
steve-lunarge0b9deb2016-09-16 13:26:37 -0600842
843 if ((Options & EOptionFlattenUniformArrays) != 0 &&
844 (Options & EOptionReadHlsl) == 0)
845 Error("uniform array flattening only valid when compiling HLSL source.");
John Kessenich8717a5d2018-10-26 10:12:32 -0600846
847 // rationalize client and target language
848 if (TargetLanguage == glslang::EShTargetNone) {
849 switch (ClientVersion) {
850 case glslang::EShTargetVulkan_1_0:
851 TargetLanguage = glslang::EShTargetSpv;
852 TargetVersion = glslang::EShTargetSpv_1_0;
853 break;
854 case glslang::EShTargetVulkan_1_1:
855 TargetLanguage = glslang::EShTargetSpv;
856 TargetVersion = glslang::EShTargetSpv_1_3;
857 break;
John Kessenich273d3a52020-01-15 00:10:41 -0700858 case glslang::EShTargetVulkan_1_2:
859 TargetLanguage = glslang::EShTargetSpv;
860 TargetVersion = glslang::EShTargetSpv_1_5;
861 break;
John Kessenich8717a5d2018-10-26 10:12:32 -0600862 case glslang::EShTargetOpenGL_450:
863 TargetLanguage = glslang::EShTargetSpv;
864 TargetVersion = glslang::EShTargetSpv_1_0;
865 break;
866 default:
867 break;
868 }
869 }
870 if (TargetLanguage != glslang::EShTargetNone && Client == glslang::EShClientNone)
871 Error("To generate SPIR-V, also specify client semantics. See -G and -V.");
John Kessenich2b07c7e2013-07-31 18:44:13 +0000872}
873
John Kessenich68d78fd2015-07-12 19:28:10 -0600874//
875// Translate the meaningful subset of command-line options to parser-behavior options.
876//
John Kessenichb0a7eb52013-11-07 17:44:20 +0000877void SetMessageOptions(EShMessages& messages)
878{
879 if (Options & EOptionRelaxedErrors)
880 messages = (EShMessages)(messages | EShMsgRelaxedErrors);
881 if (Options & EOptionIntermediate)
882 messages = (EShMessages)(messages | EShMsgAST);
883 if (Options & EOptionSuppressWarnings)
884 messages = (EShMessages)(messages | EShMsgSuppressWarnings);
John Kessenich68d78fd2015-07-12 19:28:10 -0600885 if (Options & EOptionSpv)
886 messages = (EShMessages)(messages | EShMsgSpvRules);
887 if (Options & EOptionVulkanRules)
888 messages = (EShMessages)(messages | EShMsgVulkanRules);
Andrew Woloszynaae1ad82015-06-24 17:00:46 -0400889 if (Options & EOptionOutputPreprocessed)
890 messages = (EShMessages)(messages | EShMsgOnlyPreprocessor);
John Kessenich66e2faf2016-03-12 18:34:36 -0700891 if (Options & EOptionReadHlsl)
892 messages = (EShMessages)(messages | EShMsgReadHlsl);
John Kessenicha86836e2016-07-09 14:50:57 -0600893 if (Options & EOptionCascadingErrors)
894 messages = (EShMessages)(messages | EShMsgCascadingErrors);
John Kessenich906cc212016-12-09 19:22:20 -0700895 if (Options & EOptionKeepUncalled)
896 messages = (EShMessages)(messages | EShMsgKeepUncalled);
John Kessenich4f1403e2017-04-05 17:38:20 -0600897 if (Options & EOptionHlslOffsets)
898 messages = (EShMessages)(messages | EShMsgHlslOffsets);
John Kessenich121853f2017-05-31 17:11:16 -0600899 if (Options & EOptionDebug)
900 messages = (EShMessages)(messages | EShMsgDebugInfo);
Rex Xucb61eec2018-03-07 13:10:01 +0800901 if (HlslEnable16BitTypes)
902 messages = (EShMessages)(messages | EShMsgHlslEnable16BitTypes);
GregFfb03a552018-03-29 11:49:14 -0600903 if ((Options & EOptionOptimizeDisable) || !ENABLE_OPT)
904 messages = (EShMessages)(messages | EShMsgHlslLegalization);
John Kessenichbd1c1832018-12-07 18:38:26 -0700905 if (HlslDX9compatible)
906 messages = (EShMessages)(messages | EShMsgHlslDX9Compatible);
Christoph Kubisch55ba3ea2019-04-13 22:18:16 +0200907 if (DumpBuiltinSymbols)
908 messages = (EShMessages)(messages | EShMsgBuiltinSymbolTable);
John Kessenichb0a7eb52013-11-07 17:44:20 +0000909}
910
John Kessenich68d78fd2015-07-12 19:28:10 -0600911//
John Kessenich69f4b512013-09-04 21:19:27 +0000912// Thread entry point, for non-linking asynchronous mode.
John Kessenichc999ba22013-11-07 23:33:24 +0000913//
Juan Lopeza558b262017-04-02 23:04:00 +0200914void CompileShaders(glslang::TWorklist& worklist)
John Kessenich2b07c7e2013-07-31 18:44:13 +0000915{
John Kessenich7f0bcfd2018-04-05 19:00:01 -0600916 if (Options & EOptionDebug)
917 Error("cannot generate debug information unless linking to generate code");
918
John Kessenich38f3b892013-09-06 19:52:57 +0000919 glslang::TWorkItem* workItem;
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +0200920 if (Options & EOptionStdin) {
John Kesseniche7f9cae2018-07-12 15:11:07 -0600921 if (worklist.remove(workItem)) {
922 ShHandle compiler = ShConstructCompiler(FindLanguage("stdin"), Options);
923 if (compiler == nullptr)
924 return;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000925
John Kesseniche7f9cae2018-07-12 15:11:07 -0600926 CompileFile("stdin", compiler);
John Kessenich2b07c7e2013-07-31 18:44:13 +0000927
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +0200928 if (! (Options & EOptionSuppressInfolog))
929 workItem->results = ShGetInfoLog(compiler);
John Kessenich2b07c7e2013-07-31 18:44:13 +0000930
John Kesseniche7f9cae2018-07-12 15:11:07 -0600931 ShDestruct(compiler);
932 }
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +0200933 } else {
934 while (worklist.remove(workItem)) {
935 ShHandle compiler = ShConstructCompiler(FindLanguage(workItem->name), Options);
936 if (compiler == 0)
937 return;
938
939 CompileFile(workItem->name.c_str(), compiler);
940
941 if (! (Options & EOptionSuppressInfolog))
942 workItem->results = ShGetInfoLog(compiler);
943
944 ShDestruct(compiler);
945 }
John Kessenich2b07c7e2013-07-31 18:44:13 +0000946 }
John Kessenich2b07c7e2013-07-31 18:44:13 +0000947}
948
John Kessenich6626cad2015-06-19 05:14:19 +0000949// Outputs the given string, but only if it is non-null and non-empty.
950// This prevents erroneous newlines from appearing.
Andrew Woloszynaae1ad82015-06-24 17:00:46 -0400951void PutsIfNonEmpty(const char* str)
John Kessenich6626cad2015-06-19 05:14:19 +0000952{
953 if (str && str[0]) {
954 puts(str);
955 }
956}
957
Andrew Woloszynaae1ad82015-06-24 17:00:46 -0400958// Outputs the given string to stderr, but only if it is non-null and non-empty.
959// This prevents erroneous newlines from appearing.
960void StderrIfNonEmpty(const char* str)
961{
John Kessenich04acb1b2017-06-14 17:36:50 -0600962 if (str && str[0])
963 fprintf(stderr, "%s\n", str);
Andrew Woloszynaae1ad82015-06-24 17:00:46 -0400964}
965
John Kessenichc57b2a92016-01-16 15:30:03 -0700966// Simple bundling of what makes a compilation unit for ease in passing around,
967// and separation of handling file IO versus API (programmatic) compilation.
968struct ShaderCompUnit {
969 EShLanguage stage;
John Kessenich04acb1b2017-06-14 17:36:50 -0600970 static const int maxCount = 1;
971 int count; // live number of strings/names
John Kessenicha9313662017-06-15 10:40:49 -0600972 const char* text[maxCount]; // memory owned/managed externally
John Kessenich04acb1b2017-06-14 17:36:50 -0600973 std::string fileName[maxCount]; // hold's the memory, but...
974 const char* fileNameList[maxCount]; // downstream interface wants pointers
dankbakerafe6e9c2016-08-21 12:29:08 -0400975
John Kessenich04acb1b2017-06-14 17:36:50 -0600976 ShaderCompUnit(EShLanguage stage) : stage(stage), count(0) { }
dankbakerafe6e9c2016-08-21 12:29:08 -0400977
John Kessenich04acb1b2017-06-14 17:36:50 -0600978 ShaderCompUnit(const ShaderCompUnit& rhs)
dankbakerafe6e9c2016-08-21 12:29:08 -0400979 {
980 stage = rhs.stage;
John Kessenich04acb1b2017-06-14 17:36:50 -0600981 count = rhs.count;
982 for (int i = 0; i < count; ++i) {
983 fileName[i] = rhs.fileName[i];
984 text[i] = rhs.text[i];
985 fileNameList[i] = rhs.fileName[i].c_str();
986 }
dankbakerafe6e9c2016-08-21 12:29:08 -0400987 }
988
John Kessenicha9313662017-06-15 10:40:49 -0600989 void addString(std::string& ifileName, const char* itext)
John Kessenich04acb1b2017-06-14 17:36:50 -0600990 {
991 assert(count < maxCount);
992 fileName[count] = ifileName;
993 text[count] = itext;
994 fileNameList[count] = fileName[count].c_str();
995 ++count;
996 }
John Kessenichc57b2a92016-01-16 15:30:03 -0700997};
998
John Kessenich69f4b512013-09-04 21:19:27 +0000999//
John Kessenichc57b2a92016-01-16 15:30:03 -07001000// For linking mode: Will independently parse each compilation unit, but then put them
1001// in the same program and link them together, making at most one linked module per
1002// pipeline stage.
John Kessenich69f4b512013-09-04 21:19:27 +00001003//
1004// Uses the new C++ interface instead of the old handle-based interface.
1005//
John Kessenichc57b2a92016-01-16 15:30:03 -07001006
1007void CompileAndLinkShaderUnits(std::vector<ShaderCompUnit> compUnits)
John Kessenich69f4b512013-09-04 21:19:27 +00001008{
1009 // keep track of what to free
1010 std::list<glslang::TShader*> shaders;
John Kessenichc57b2a92016-01-16 15:30:03 -07001011
John Kessenich69f4b512013-09-04 21:19:27 +00001012 EShMessages messages = EShMsgDefault;
John Kessenichb0a7eb52013-11-07 17:44:20 +00001013 SetMessageOptions(messages);
John Kessenich69f4b512013-09-04 21:19:27 +00001014
John Kessenich69f4b512013-09-04 21:19:27 +00001015 //
1016 // Per-shader processing...
1017 //
1018
John Kessenich5b0f13a2013-11-01 03:08:40 +00001019 glslang::TProgram& program = *new glslang::TProgram;
rdb32084e82016-02-23 22:17:38 +01001020 for (auto it = compUnits.cbegin(); it != compUnits.cend(); ++it) {
1021 const auto &compUnit = *it;
John Kessenichc57b2a92016-01-16 15:30:03 -07001022 glslang::TShader* shader = new glslang::TShader(compUnit.stage);
John Kessenich04acb1b2017-06-14 17:36:50 -06001023 shader->setStringsWithLengthsAndNames(compUnit.text, NULL, compUnit.fileNameList, compUnit.count);
John Kessenich640bd092018-08-09 14:15:00 -06001024 if (entryPointName)
John Kessenich4d65ee32016-03-12 18:17:47 -07001025 shader->setEntryPoint(entryPointName);
John Kessenich3693e632017-09-29 17:51:52 -06001026 if (sourceEntryPointName) {
1027 if (entryPointName == nullptr)
1028 printf("Warning: Changing source entry point name without setting an entry-point name.\n"
1029 "Use '-e <name>'.\n");
steve-lunargf1e0c872016-10-31 15:13:43 -06001030 shader->setSourceEntryPoint(sourceEntryPointName);
John Kessenich3693e632017-09-29 17:51:52 -06001031 }
John Kessenicha9313662017-06-15 10:40:49 -06001032 if (UserPreamble.isSet())
1033 shader->setPreamble(UserPreamble.get());
John Kessenich2a271162017-07-20 20:00:36 -06001034 shader->addProcesses(Processes);
steve-lunarg7f7c2ed2016-09-07 15:20:19 -06001035
John Kessenich155d3512019-08-08 23:29:20 -06001036#ifndef GLSLANG_WEB
LoopDawg08a14422017-10-17 19:27:14 -06001037 // Set IO mapper binding shift values
1038 for (int r = 0; r < glslang::EResCount; ++r) {
1039 const glslang::TResourceType res = glslang::TResourceType(r);
1040
1041 // Set base bindings
1042 shader->setShiftBinding(res, baseBinding[res][compUnit.stage]);
David Neto8c3d5b42019-10-21 14:50:31 -04001043
LoopDawg08a14422017-10-17 19:27:14 -06001044 // Set bindings for particular resource sets
1045 // TODO: use a range based for loop here, when available in all environments.
1046 for (auto i = baseBindingForSet[res][compUnit.stage].begin();
1047 i != baseBindingForSet[res][compUnit.stage].end(); ++i)
LoopDawge5709552017-10-21 10:46:39 -06001048 shader->setShiftBindingForSet(res, i->second, i->first);
LoopDawg08a14422017-10-17 19:27:14 -06001049 }
steve-lunargcce8d482016-10-14 18:36:42 -06001050 shader->setNoStorageFormat((Options & EOptionNoStorageFormat) != 0);
Hyangran Park36dc8292017-05-02 16:27:29 +09001051 shader->setResourceSetBinding(baseResourceSetBinding[compUnit.stage]);
steve-lunarg7f7c2ed2016-09-07 15:20:19 -06001052
1053 if (Options & EOptionAutoMapBindings)
1054 shader->setAutoMapBindings(true);
John Kessenichecba76f2017-01-06 00:34:48 -07001055
John Kessenich71facdf2017-05-17 18:28:19 -06001056 if (Options & EOptionAutoMapLocations)
1057 shader->setAutoMapLocations(true);
1058
Neil Roberts16f53472018-03-20 17:30:53 +01001059 for (auto& uniOverride : uniformLocationOverrides) {
1060 shader->addUniformLocationOverride(uniOverride.first.c_str(),
1061 uniOverride.second);
1062 }
1063
Neil Robertsb0f3d792018-03-20 17:41:05 +01001064 shader->setUniformLocationBase(uniformBase);
John Kessenich155d3512019-08-08 23:29:20 -06001065#endif
1066
1067 shader->setNanMinMaxClamp(NaNClamp);
1068
1069#ifdef ENABLE_HLSL
1070 shader->setFlattenUniformArrays((Options & EOptionFlattenUniformArrays) != 0);
1071 if (Options & EOptionHlslIoMapping)
1072 shader->setHlslIoMapping(true);
1073#endif
1074
1075 if (Options & EOptionInvertY)
1076 shader->setInvertY(true);
Neil Robertsb0f3d792018-03-20 17:41:05 +01001077
John Kessenich4be4aeb2017-06-23 10:50:22 -06001078 // Set up the environment, some subsettings take precedence over earlier
1079 // ways of setting things.
1080 if (Options & EOptionSpv) {
John Kessenich8717a5d2018-10-26 10:12:32 -06001081 shader->setEnvInput((Options & EOptionReadHlsl) ? glslang::EShSourceHlsl
1082 : glslang::EShSourceGlsl,
1083 compUnit.stage, Client, ClientInputSemanticsVersion);
1084 shader->setEnvClient(Client, ClientVersion);
1085 shader->setEnvTarget(TargetLanguage, TargetVersion);
John Kessenichd4ed5152019-07-27 05:22:30 -06001086#ifdef ENABLE_HLSL
John Kessenich5d610ee2018-03-07 18:05:55 -07001087 if (targetHlslFunctionality1)
1088 shader->setEnvTargetHlslFunctionality1();
John Kessenichd4ed5152019-07-27 05:22:30 -06001089#endif
John Kessenich4be4aeb2017-06-23 10:50:22 -06001090 }
1091
John Kessenich69f4b512013-09-04 21:19:27 +00001092 shaders.push_back(shader);
John Kessenichb3297152015-07-11 18:01:03 -06001093
John Kessenich4be4aeb2017-06-23 10:50:22 -06001094 const int defaultVersion = Options & EOptionDefaultDesktop ? 110 : 100;
John Kessenich69f4b512013-09-04 21:19:27 +00001095
John Kessenich3494b4d2017-05-22 15:00:42 -06001096 DirStackFileIncluder includer;
John Kessenich971a0a82017-06-07 15:06:58 -06001097 std::for_each(IncludeDirectoryList.rbegin(), IncludeDirectoryList.rend(), [&includer](const std::string& dir) {
1098 includer.pushExternalLocalDirectory(dir); });
John Kessenichdeec1932019-08-13 08:00:30 -06001099#ifndef GLSLANG_WEB
John Kessenichc555ddd2015-06-17 02:38:44 +00001100 if (Options & EOptionOutputPreprocessed) {
1101 std::string str;
John Kessenich086febc2018-10-25 12:43:02 -06001102 if (shader->preprocess(&Resources, defaultVersion, ENoProfile, false, false, messages, &str, includer)) {
Andrew Woloszynaae1ad82015-06-24 17:00:46 -04001103 PutsIfNonEmpty(str.c_str());
1104 } else {
1105 CompileFailed = true;
1106 }
1107 StderrIfNonEmpty(shader->getInfoLog());
1108 StderrIfNonEmpty(shader->getInfoDebugLog());
John Kessenichc555ddd2015-06-17 02:38:44 +00001109 continue;
1110 }
John Kessenichdeec1932019-08-13 08:00:30 -06001111#endif
John Kessenich086febc2018-10-25 12:43:02 -06001112
John Kessenich3494b4d2017-05-22 15:00:42 -06001113 if (! shader->parse(&Resources, defaultVersion, false, messages, includer))
John Kessenichc999ba22013-11-07 23:33:24 +00001114 CompileFailed = true;
John Kessenichc555ddd2015-06-17 02:38:44 +00001115
John Kessenich69f4b512013-09-04 21:19:27 +00001116 program.addShader(shader);
1117
John Kessenichc57b2a92016-01-16 15:30:03 -07001118 if (! (Options & EOptionSuppressInfolog) &&
1119 ! (Options & EOptionMemoryLeakMode)) {
Marcin Åšlusarz245c30c2020-07-03 14:55:29 +02001120 if (!beQuiet)
1121 PutsIfNonEmpty(compUnit.fileName[0].c_str());
Andrew Woloszynaae1ad82015-06-24 17:00:46 -04001122 PutsIfNonEmpty(shader->getInfoLog());
1123 PutsIfNonEmpty(shader->getInfoDebugLog());
John Kessenich69f4b512013-09-04 21:19:27 +00001124 }
John Kessenich69f4b512013-09-04 21:19:27 +00001125 }
1126
1127 //
1128 // Program-level processing...
1129 //
1130
John Kessenich4d65ee32016-03-12 18:17:47 -07001131 // Link
John Kessenich68d78fd2015-07-12 19:28:10 -06001132 if (! (Options & EOptionOutputPreprocessed) && ! program.link(messages))
John Kessenichc999ba22013-11-07 23:33:24 +00001133 LinkFailed = true;
1134
John Kessenichb6d3ee52019-08-06 02:20:45 -06001135#ifndef GLSLANG_WEB
steve-lunarg9ae34742016-10-05 13:40:13 -06001136 // Map IO
1137 if (Options & EOptionSpv) {
1138 if (!program.mapIO())
1139 LinkFailed = true;
1140 }
John Kessenichb6d3ee52019-08-06 02:20:45 -06001141#endif
John Kessenichecba76f2017-01-06 00:34:48 -07001142
John Kessenich4d65ee32016-03-12 18:17:47 -07001143 // Report
John Kessenichc57b2a92016-01-16 15:30:03 -07001144 if (! (Options & EOptionSuppressInfolog) &&
1145 ! (Options & EOptionMemoryLeakMode)) {
Andrew Woloszynaae1ad82015-06-24 17:00:46 -04001146 PutsIfNonEmpty(program.getInfoLog());
1147 PutsIfNonEmpty(program.getInfoDebugLog());
John Kessenich69f4b512013-09-04 21:19:27 +00001148 }
1149
John Kessenichb6d3ee52019-08-06 02:20:45 -06001150#ifndef GLSLANG_WEB
John Kessenich4d65ee32016-03-12 18:17:47 -07001151 // Reflect
John Kessenich11f9fc72013-11-07 01:06:34 +00001152 if (Options & EOptionDumpReflection) {
baldurk6d477852019-01-29 15:45:56 +00001153 program.buildReflection(ReflectOptions);
John Kessenich11f9fc72013-11-07 01:06:34 +00001154 program.dumpReflection();
1155 }
John Kessenichb6d3ee52019-08-06 02:20:45 -06001156#endif
John Kessenich11f9fc72013-11-07 01:06:34 +00001157
John Kessenich4d65ee32016-03-12 18:17:47 -07001158 // Dump SPIR-V
John Kessenich0df0cde2015-03-03 17:09:43 +00001159 if (Options & EOptionSpv) {
John Kessenich92f90382014-07-28 04:21:04 +00001160 if (CompileFailed || LinkFailed)
John Kessenich68d78fd2015-07-12 19:28:10 -06001161 printf("SPIR-V is not generated for failed compile or link\n");
John Kessenich92f90382014-07-28 04:21:04 +00001162 else {
1163 for (int stage = 0; stage < EShLangCount; ++stage) {
John Kessenicha7a68a92014-08-24 18:21:00 +00001164 if (program.getIntermediate((EShLanguage)stage)) {
John Kessenich0df0cde2015-03-03 17:09:43 +00001165 std::vector<unsigned int> spirv;
Lei Zhang17535f72016-05-04 15:55:59 -04001166 spv::SpvBuildLogger logger;
John Kessenich121853f2017-05-31 17:11:16 -06001167 glslang::SpvOptions spvOptions;
1168 if (Options & EOptionDebug)
1169 spvOptions.generateDebugInfo = true;
Shahbaz Youssefid52dce52020-06-17 12:47:44 -04001170 else if (stripDebugInfo)
1171 spvOptions.stripDebugInfo = true;
GregF52fe3d52017-09-28 10:08:32 -06001172 spvOptions.disableOptimizer = (Options & EOptionOptimizeDisable) != 0;
1173 spvOptions.optimizeSize = (Options & EOptionOptimizeSize) != 0;
John Kessenich717c80a2018-08-23 15:17:10 -06001174 spvOptions.disassemble = SpvToolsDisassembler;
John Kessenichc3404252018-08-23 15:29:08 -06001175 spvOptions.validate = SpvToolsValidate;
John Kessenich121853f2017-05-31 17:11:16 -06001176 glslang::GlslangToSpv(*program.getIntermediate((EShLanguage)stage), spirv, &logger, &spvOptions);
John Kessenichc57b2a92016-01-16 15:30:03 -07001177
1178 // Dump the spv to a file or stdout, etc., but only if not doing
1179 // memory/perf testing, as it's not internal to programmatic use.
1180 if (! (Options & EOptionMemoryLeakMode)) {
Johannes van Waverenecb0f3b2016-05-27 12:55:53 -05001181 printf("%s", logger.getAllMessages().c_str());
1182 if (Options & EOptionOutputHexadecimal) {
John Kessenich8f674e82017-02-18 09:45:40 -07001183 glslang::OutputSpvHex(spirv, GetBinaryName((EShLanguage)stage), variableName);
Johannes van Waverenecb0f3b2016-05-27 12:55:53 -05001184 } else {
1185 glslang::OutputSpvBin(spirv, GetBinaryName((EShLanguage)stage));
1186 }
John Kessenich23d27752019-07-28 02:12:10 -06001187#ifndef GLSLANG_WEB
John Kesseniche2156222018-06-11 18:12:15 -06001188 if (!SpvToolsDisassembler && (Options & EOptionHumanReadableSpv))
John Kessenichc57b2a92016-01-16 15:30:03 -07001189 spv::Disassemble(std::cout, spirv);
John Kessenich23d27752019-07-28 02:12:10 -06001190#endif
John Kessenichacba7722015-03-04 03:48:38 +00001191 }
John Kessenicha7a68a92014-08-24 18:21:00 +00001192 }
John Kessenich92f90382014-07-28 04:21:04 +00001193 }
1194 }
1195 }
1196
John Kessenich5b0f13a2013-11-01 03:08:40 +00001197 // Free everything up, program has to go before the shaders
1198 // because it might have merged stuff from the shaders, and
1199 // the stuff from the shaders has to have its destructors called
1200 // before the pools holding the memory in the shaders is freed.
1201 delete &program;
John Kessenich69f4b512013-09-04 21:19:27 +00001202 while (shaders.size() > 0) {
1203 delete shaders.back();
1204 shaders.pop_back();
1205 }
John Kessenich69f4b512013-09-04 21:19:27 +00001206}
1207
John Kessenichc57b2a92016-01-16 15:30:03 -07001208//
1209// Do file IO part of compile and link, handing off the pure
1210// API/programmatic mode to CompileAndLinkShaderUnits(), which can
1211// be put in a loop for testing memory footprint and performance.
1212//
1213// This is just for linking mode: meaning all the shaders will be put into the
1214// the same program linked together.
1215//
1216// This means there are a limited number of work items (not multi-threading mode)
1217// and that the point is testing at the linking level. Hence, to enable
1218// performance and memory testing, the actual compile/link can be put in
1219// a loop, independent of processing the work items and file IO.
1220//
Juan Lopeza558b262017-04-02 23:04:00 +02001221void CompileAndLinkShaderFiles(glslang::TWorklist& Worklist)
John Kessenichc57b2a92016-01-16 15:30:03 -07001222{
1223 std::vector<ShaderCompUnit> compUnits;
1224
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001225 // If this is using stdin, we can't really detect multiple different file
1226 // units by input type. We need to assume that we're just being given one
1227 // file of a certain type.
1228 if ((Options & EOptionStdin) != 0) {
1229 ShaderCompUnit compUnit(FindLanguage("stdin"));
1230 std::istreambuf_iterator<char> begin(std::cin), end;
1231 std::string tempString(begin, end);
1232 char* fileText = strdup(tempString.c_str());
1233 std::string fileName = "stdin";
1234 compUnit.addString(fileName, fileText);
John Kessenichc57b2a92016-01-16 15:30:03 -07001235 compUnits.push_back(compUnit);
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001236 } else {
1237 // Transfer all the work items from to a simple list of
1238 // of compilation units. (We don't care about the thread
1239 // work-item distribution properties in this path, which
1240 // is okay due to the limited number of shaders, know since
1241 // they are all getting linked together.)
1242 glslang::TWorkItem* workItem;
1243 while (Worklist.remove(workItem)) {
1244 ShaderCompUnit compUnit(FindLanguage(workItem->name));
1245 char* fileText = ReadFileData(workItem->name.c_str());
1246 if (fileText == nullptr)
1247 usage();
1248 compUnit.addString(workItem->name, fileText);
1249 compUnits.push_back(compUnit);
1250 }
John Kessenichc57b2a92016-01-16 15:30:03 -07001251 }
1252
1253 // Actual call to programmatic processing of compile and link,
1254 // in a loop for testing memory and performance. This part contains
1255 // all the perf/memory that a programmatic consumer will care about.
1256 for (int i = 0; i < ((Options & EOptionMemoryLeakMode) ? 100 : 1); ++i) {
1257 for (int j = 0; j < ((Options & EOptionMemoryLeakMode) ? 100 : 1); ++j)
1258 CompileAndLinkShaderUnits(compUnits);
1259
1260 if (Options & EOptionMemoryLeakMode)
1261 glslang::OS_DumpMemoryCounters();
1262 }
1263
John Kessenicha9313662017-06-15 10:40:49 -06001264 // free memory from ReadFileData, which got stored in a const char*
1265 // as the first string above
rdb32084e82016-02-23 22:17:38 +01001266 for (auto it = compUnits.begin(); it != compUnits.end(); ++it)
John Kessenicha9313662017-06-15 10:40:49 -06001267 FreeFileData(const_cast<char*>(it->text[0]));
John Kessenichc57b2a92016-01-16 15:30:03 -07001268}
1269
John Kessenich94f28eb2017-11-13 01:32:06 -07001270int singleMain()
John Kessenicha0af4732012-12-12 21:15:54 +00001271{
Juan Lopeza558b262017-04-02 23:04:00 +02001272 glslang::TWorklist workList;
John Kessenich94f28eb2017-11-13 01:32:06 -07001273 std::for_each(WorkItems.begin(), WorkItems.end(), [&workList](std::unique_ptr<glslang::TWorkItem>& item) {
Juan Lopeza558b262017-04-02 23:04:00 +02001274 assert(item);
1275 workList.add(item.get());
1276 });
John Kessenich2b07c7e2013-07-31 18:44:13 +00001277
John Kessenich23d27752019-07-28 02:12:10 -06001278#ifndef GLSLANG_WEB
John Kessenich05a70632013-09-17 19:26:08 +00001279 if (Options & EOptionDumpConfig) {
Lei Zhang414eb602016-03-04 16:22:34 -05001280 printf("%s", glslang::GetDefaultTBuiltInResourceString().c_str());
Juan Lopeza558b262017-04-02 23:04:00 +02001281 if (workList.empty())
John Kessenich05a70632013-09-17 19:26:08 +00001282 return ESuccess;
1283 }
John Kessenich23d27752019-07-28 02:12:10 -06001284#endif
John Kessenich05a70632013-09-17 19:26:08 +00001285
John Kessenichc6c80a62018-03-05 22:23:17 -07001286 if (Options & EOptionDumpBareVersion) {
Ben Claytonfbe9a232020-06-17 11:17:19 +01001287 printf("%d:%d.%d.%d%s\n", glslang::GetSpirvGeneratorVersion(), GLSLANG_VERSION_MAJOR, GLSLANG_VERSION_MINOR,
1288 GLSLANG_VERSION_PATCH, GLSLANG_VERSION_FLAVOR);
John Kessenichc6c80a62018-03-05 22:23:17 -07001289 if (workList.empty())
1290 return ESuccess;
1291 } else if (Options & EOptionDumpVersions) {
Ben Claytonfbe9a232020-06-17 11:17:19 +01001292 printf("Glslang Version: %d:%d.%d.%d%s\n", glslang::GetSpirvGeneratorVersion(), GLSLANG_VERSION_MAJOR,
1293 GLSLANG_VERSION_MINOR, GLSLANG_VERSION_PATCH, GLSLANG_VERSION_FLAVOR);
John Kessenich319de232013-12-04 04:43:40 +00001294 printf("ESSL Version: %s\n", glslang::GetEsslVersionString());
1295 printf("GLSL Version: %s\n", glslang::GetGlslVersionString());
John Kessenich68d78fd2015-07-12 19:28:10 -06001296 std::string spirvVersion;
1297 glslang::GetSpirvVersion(spirvVersion);
John Kessenich0da9eaa2015-08-01 17:10:02 -06001298 printf("SPIR-V Version %s\n", spirvVersion.c_str());
John Kessenich5e4b1242015-08-06 22:53:06 -06001299 printf("GLSL.std.450 Version %d, Revision %d\n", GLSLstd450Version, GLSLstd450Revision);
John Kessenich55e7d112015-11-15 21:33:39 -07001300 printf("Khronos Tool ID %d\n", glslang::GetKhronosToolId());
John Kessenicha372a3e2017-11-02 22:32:14 -06001301 printf("SPIR-V Generator Version %d\n", glslang::GetSpirvGeneratorVersion());
John Kessenichb84313d2016-07-20 16:03:29 -06001302 printf("GL_KHR_vulkan_glsl version %d\n", 100);
1303 printf("ARB_GL_gl_spirv version %d\n", 100);
Juan Lopeza558b262017-04-02 23:04:00 +02001304 if (workList.empty())
John Kessenich319de232013-12-04 04:43:40 +00001305 return ESuccess;
1306 }
1307
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001308 if (workList.empty() && ((Options & EOptionStdin) == 0)) {
John Kessenich05a70632013-09-17 19:26:08 +00001309 usage();
John Kessenich05a70632013-09-17 19:26:08 +00001310 }
1311
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001312 if (Options & EOptionStdin) {
John Kessenich94f28eb2017-11-13 01:32:06 -07001313 WorkItems.push_back(std::unique_ptr<glslang::TWorkItem>{new glslang::TWorkItem("stdin")});
1314 workList.add(WorkItems.back().get());
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001315 }
1316
John Kessenich05a70632013-09-17 19:26:08 +00001317 ProcessConfigFile();
1318
John Kessenich086febc2018-10-25 12:43:02 -06001319 if ((Options & EOptionReadHlsl) && !((Options & EOptionOutputPreprocessed) || (Options & EOptionSpv)))
John Kessenichbd97b6f2019-12-20 10:33:13 -07001320 Error("HLSL requires SPIR-V code generation (or preprocessing only)");
John Kessenich086febc2018-10-25 12:43:02 -06001321
John Kessenich69f4b512013-09-04 21:19:27 +00001322 //
1323 // Two modes:
John Kessenich38f3b892013-09-06 19:52:57 +00001324 // 1) linking all arguments together, single-threaded, new C++ interface
1325 // 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 +00001326 //
John Kessenich086febc2018-10-25 12:43:02 -06001327 if (Options & (EOptionLinkProgram | EOptionOutputPreprocessed)) {
John Kessenichc36e1d82013-11-01 17:41:52 +00001328 glslang::InitializeProcess();
John Kesseniche2c15b42017-11-16 22:48:41 -07001329 glslang::InitializeProcess(); // also test reference counting of users
1330 glslang::InitializeProcess(); // also test reference counting of users
1331 glslang::FinalizeProcess(); // also test reference counting of users
1332 glslang::FinalizeProcess(); // also test reference counting of users
Juan Lopeza558b262017-04-02 23:04:00 +02001333 CompileAndLinkShaderFiles(workList);
John Kessenichc36e1d82013-11-01 17:41:52 +00001334 glslang::FinalizeProcess();
1335 } else {
1336 ShInitialize();
John Kesseniche2c15b42017-11-16 22:48:41 -07001337 ShInitialize(); // also test reference counting of users
1338 ShFinalize(); // also test reference counting of users
John Kessenichc36e1d82013-11-01 17:41:52 +00001339
Juan Lopeza558b262017-04-02 23:04:00 +02001340 bool printShaderNames = workList.size() > 1;
John Kessenich69f4b512013-09-04 21:19:27 +00001341
John Kesseniche2c15b42017-11-16 22:48:41 -07001342 if (Options & EOptionMultiThreaded) {
Juan Lopeza558b262017-04-02 23:04:00 +02001343 std::array<std::thread, 16> threads;
John Kesseniche2c15b42017-11-16 22:48:41 -07001344 for (unsigned int t = 0; t < threads.size(); ++t) {
Juan Lopeza558b262017-04-02 23:04:00 +02001345 threads[t] = std::thread(CompileShaders, std::ref(workList));
John Kesseniche2c15b42017-11-16 22:48:41 -07001346 if (threads[t].get_id() == std::thread::id()) {
John Kessenichaf527992017-11-02 22:48:15 -06001347 fprintf(stderr, "Failed to create thread\n");
John Kessenich38f3b892013-09-06 19:52:57 +00001348 return EFailThreadCreate;
1349 }
John Kessenicha0af4732012-12-12 21:15:54 +00001350 }
Juan Lopeza558b262017-04-02 23:04:00 +02001351
1352 std::for_each(threads.begin(), threads.end(), [](std::thread& t) { t.join(); });
John Kessenichc999ba22013-11-07 23:33:24 +00001353 } else
Juan Lopeza558b262017-04-02 23:04:00 +02001354 CompileShaders(workList);
John Kessenich38f3b892013-09-06 19:52:57 +00001355
1356 // Print out all the resulting infologs
John Kessenich94f28eb2017-11-13 01:32:06 -07001357 for (size_t w = 0; w < WorkItems.size(); ++w) {
1358 if (WorkItems[w]) {
1359 if (printShaderNames || WorkItems[w]->results.size() > 0)
1360 PutsIfNonEmpty(WorkItems[w]->name.c_str());
1361 PutsIfNonEmpty(WorkItems[w]->results.c_str());
John Kessenich38f3b892013-09-06 19:52:57 +00001362 }
1363 }
John Kessenichc36e1d82013-11-01 17:41:52 +00001364
1365 ShFinalize();
John Kessenicha0af4732012-12-12 21:15:54 +00001366 }
John Kessenich2b07c7e2013-07-31 18:44:13 +00001367
John Kessenichc999ba22013-11-07 23:33:24 +00001368 if (CompileFailed)
John Kessenicha0af4732012-12-12 21:15:54 +00001369 return EFailCompile;
John Kessenichc999ba22013-11-07 23:33:24 +00001370 if (LinkFailed)
John Kessenicha0af4732012-12-12 21:15:54 +00001371 return EFailLink;
1372
1373 return 0;
1374}
1375
John Kessenich94f28eb2017-11-13 01:32:06 -07001376int C_DECL main(int argc, char* argv[])
1377{
1378 ProcessArguments(WorkItems, argc, argv);
1379
1380 int ret = 0;
1381
1382 // Loop over the entire init/finalize cycle to watch memory changes
1383 const int iterations = 1;
1384 if (iterations > 1)
1385 glslang::OS_DumpMemoryCounters();
1386 for (int i = 0; i < iterations; ++i) {
1387 ret = singleMain();
1388 if (iterations > 1)
1389 glslang::OS_DumpMemoryCounters();
1390 }
1391
1392 return ret;
1393}
1394
John Kessenicha0af4732012-12-12 21:15:54 +00001395//
1396// Deduce the language from the filename. Files must end in one of the
1397// following extensions:
1398//
John Kessenich2b07c7e2013-07-31 18:44:13 +00001399// .vert = vertex
1400// .tesc = tessellation control
1401// .tese = tessellation evaluation
1402// .geom = geometry
1403// .frag = fragment
John Kessenich94a81fb2013-08-31 02:41:30 +00001404// .comp = compute
Chao Chenb50c02e2018-09-19 11:42:24 -07001405// .rgen = ray generation
1406// .rint = ray intersection
1407// .rahit = ray any hit
1408// .rchit = ray closest hit
1409// .rmiss = ray miss
1410// .rcall = ray callable
Sahil Parmar035cbbe2018-10-04 16:39:18 -07001411// .mesh = mesh
1412// .task = task
Grigory Dzhavadyan33507412018-04-12 14:35:24 -07001413// Additionally, the file names may end in .<stage>.glsl and .<stage>.hlsl
1414// where <stage> is one of the stages listed above.
1415//
1416EShLanguage FindLanguage(const std::string& name, bool parseStageName)
John Kessenicha0af4732012-12-12 21:15:54 +00001417{
John Kessenichfccbb8b2018-04-17 17:24:03 -06001418 std::string stageName;
Dan Bakerc6ede892016-08-11 14:06:06 -04001419 if (shaderStageName)
John Kessenichfccbb8b2018-04-17 17:24:03 -06001420 stageName = shaderStageName;
1421 else if (parseStageName) {
Grigory Dzhavadyan33507412018-04-12 14:35:24 -07001422 // Note: "first" extension means "first from the end", i.e.
1423 // if the file is named foo.vert.glsl, then "glsl" is first,
1424 // "vert" is second.
John Kessenichfccbb8b2018-04-17 17:24:03 -06001425 size_t firstExtStart = name.find_last_of(".");
1426 bool hasFirstExt = firstExtStart != std::string::npos;
1427 size_t secondExtStart = hasFirstExt ? name.find_last_of(".", firstExtStart - 1) : std::string::npos;
1428 bool hasSecondExt = secondExtStart != std::string::npos;
1429 std::string firstExt = name.substr(firstExtStart + 1, std::string::npos);
1430 bool usesUnifiedExt = hasFirstExt && (firstExt == "glsl" || firstExt == "hlsl");
John Kessenich3beac942018-04-17 21:02:19 -06001431 if (usesUnifiedExt && firstExt == "hlsl")
1432 Options |= EOptionReadHlsl;
1433 if (hasFirstExt && !usesUnifiedExt)
John Kessenichfccbb8b2018-04-17 17:24:03 -06001434 stageName = firstExt;
John Kessenich3beac942018-04-17 21:02:19 -06001435 else if (usesUnifiedExt && hasSecondExt)
John Kessenichfccbb8b2018-04-17 17:24:03 -06001436 stageName = name.substr(secondExtStart + 1, firstExtStart - secondExtStart - 1);
John Kessenich3beac942018-04-17 21:02:19 -06001437 else {
Grigory Dzhavadyan33507412018-04-12 14:35:24 -07001438 usage();
1439 return EShLangVertex;
John Kesseniche751bca2017-03-16 11:20:38 -06001440 }
John Kessenichfccbb8b2018-04-17 17:24:03 -06001441 } else
1442 stageName = name;
dankbaker45d49bc2016-08-08 21:43:07 -04001443
John Kessenichfccbb8b2018-04-17 17:24:03 -06001444 if (stageName == "vert")
John Kessenich2b07c7e2013-07-31 18:44:13 +00001445 return EShLangVertex;
John Kessenichfccbb8b2018-04-17 17:24:03 -06001446 else if (stageName == "tesc")
John Kessenich2b07c7e2013-07-31 18:44:13 +00001447 return EShLangTessControl;
John Kessenichfccbb8b2018-04-17 17:24:03 -06001448 else if (stageName == "tese")
John Kessenich2b07c7e2013-07-31 18:44:13 +00001449 return EShLangTessEvaluation;
John Kessenichfccbb8b2018-04-17 17:24:03 -06001450 else if (stageName == "geom")
John Kessenich2b07c7e2013-07-31 18:44:13 +00001451 return EShLangGeometry;
John Kessenichfccbb8b2018-04-17 17:24:03 -06001452 else if (stageName == "frag")
John Kessenich2b07c7e2013-07-31 18:44:13 +00001453 return EShLangFragment;
John Kessenichfccbb8b2018-04-17 17:24:03 -06001454 else if (stageName == "comp")
John Kessenichc0275792013-08-09 17:14:49 +00001455 return EShLangCompute;
Chao Chenb50c02e2018-09-19 11:42:24 -07001456 else if (stageName == "rgen")
Daniel Kochdb32b242020-03-17 20:42:47 -04001457 return EShLangRayGen;
Chao Chenb50c02e2018-09-19 11:42:24 -07001458 else if (stageName == "rint")
Daniel Kochdb32b242020-03-17 20:42:47 -04001459 return EShLangIntersect;
Chao Chenb50c02e2018-09-19 11:42:24 -07001460 else if (stageName == "rahit")
Daniel Kochdb32b242020-03-17 20:42:47 -04001461 return EShLangAnyHit;
Chao Chenb50c02e2018-09-19 11:42:24 -07001462 else if (stageName == "rchit")
Daniel Kochdb32b242020-03-17 20:42:47 -04001463 return EShLangClosestHit;
Chao Chenb50c02e2018-09-19 11:42:24 -07001464 else if (stageName == "rmiss")
Daniel Kochdb32b242020-03-17 20:42:47 -04001465 return EShLangMiss;
Chao Chenb50c02e2018-09-19 11:42:24 -07001466 else if (stageName == "rcall")
Daniel Kochdb32b242020-03-17 20:42:47 -04001467 return EShLangCallable;
Chao Chen3c366992018-09-19 11:41:59 -07001468 else if (stageName == "mesh")
1469 return EShLangMeshNV;
1470 else if (stageName == "task")
1471 return EShLangTaskNV;
John Kessenich2b07c7e2013-07-31 18:44:13 +00001472
1473 usage();
John Kesseniche95ecc52012-12-12 21:34:14 +00001474 return EShLangVertex;
John Kessenicha0af4732012-12-12 21:15:54 +00001475}
1476
John Kessenicha0af4732012-12-12 21:15:54 +00001477//
John Kessenichecba76f2017-01-06 00:34:48 -07001478// Read a file's data into a string, and compile it using the old interface ShCompile,
John Kessenich69f4b512013-09-04 21:19:27 +00001479// for non-linkable results.
John Kessenicha0af4732012-12-12 21:15:54 +00001480//
John Kessenich51cdd902014-02-18 23:37:57 +00001481void CompileFile(const char* fileName, ShHandle compiler)
John Kessenicha0af4732012-12-12 21:15:54 +00001482{
John Kessenichca3457f2015-05-18 01:59:45 +00001483 int ret = 0;
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001484 char* shaderString;
1485 if ((Options & EOptionStdin) != 0) {
1486 std::istreambuf_iterator<char> begin(std::cin), end;
1487 std::string tempString(begin, end);
1488 shaderString = strdup(tempString.c_str());
1489 } else {
1490 shaderString = ReadFileData(fileName);
1491 }
John Kessenich41cf6b52013-06-25 18:10:05 +00001492
1493 // move to length-based strings, rather than null-terminated strings
John Kessenich04acb1b2017-06-14 17:36:50 -06001494 int* lengths = new int[1];
1495 lengths[0] = (int)strlen(shaderString);
John Kessenicha0af4732012-12-12 21:15:54 +00001496
John Kessenich52ac67e2013-05-05 23:46:22 +00001497 EShMessages messages = EShMsgDefault;
John Kessenichb0a7eb52013-11-07 17:44:20 +00001498 SetMessageOptions(messages);
John Kessenichecba76f2017-01-06 00:34:48 -07001499
John Kessenicha9313662017-06-15 10:40:49 -06001500 if (UserPreamble.isSet())
1501 Error("-D and -U options require -l (linking)\n");
1502
John Kessenich94a81fb2013-08-31 02:41:30 +00001503 for (int i = 0; i < ((Options & EOptionMemoryLeakMode) ? 100 : 1); ++i) {
1504 for (int j = 0; j < ((Options & EOptionMemoryLeakMode) ? 100 : 1); ++j) {
John Kessenich927608b2017-01-06 12:34:14 -07001505 // ret = ShCompile(compiler, shaderStrings, NumShaderStrings, lengths, EShOptNone, &Resources, Options, (Options & EOptionDefaultDesktop) ? 110 : 100, false, messages);
John Kessenich04acb1b2017-06-14 17:36:50 -06001506 ret = ShCompile(compiler, &shaderString, 1, nullptr, EShOptNone, &Resources, Options, (Options & EOptionDefaultDesktop) ? 110 : 100, false, messages);
John Kessenich927608b2017-01-06 12:34:14 -07001507 // const char* multi[12] = { "# ve", "rsion", " 300 e", "s", "\n#err",
John Kessenichecba76f2017-01-06 00:34:48 -07001508 // "or should be l", "ine 1", "string 5\n", "float glo", "bal",
John Kessenichea869fb2013-10-28 18:12:06 +00001509 // ";\n#error should be line 2\n void main() {", "global = 2.3;}" };
John Kessenich927608b2017-01-06 12:34:14 -07001510 // const char* multi[7] = { "/", "/", "\\", "\n", "\n", "#", "version 300 es" };
1511 // ret = ShCompile(compiler, multi, 7, nullptr, EShOptNone, &Resources, Options, (Options & EOptionDefaultDesktop) ? 110 : 100, false, messages);
John Kessenich41cf6b52013-06-25 18:10:05 +00001512 }
John Kessenicha0af4732012-12-12 21:15:54 +00001513
John Kessenich94a81fb2013-08-31 02:41:30 +00001514 if (Options & EOptionMemoryLeakMode)
John Kessenich2b07c7e2013-07-31 18:44:13 +00001515 glslang::OS_DumpMemoryCounters();
John Kessenicha0af4732012-12-12 21:15:54 +00001516 }
John Kessenicha0af4732012-12-12 21:15:54 +00001517
John Kessenich41cf6b52013-06-25 18:10:05 +00001518 delete [] lengths;
John Kessenich04acb1b2017-06-14 17:36:50 -06001519 FreeFileData(shaderString);
John Kessenicha0af4732012-12-12 21:15:54 +00001520
John Kessenichc999ba22013-11-07 23:33:24 +00001521 if (ret == 0)
1522 CompileFailed = true;
John Kessenicha0af4732012-12-12 21:15:54 +00001523}
1524
John Kessenicha0af4732012-12-12 21:15:54 +00001525//
1526// print usage to stdout
1527//
1528void usage()
1529{
John Kessenich319de232013-12-04 04:43:40 +00001530 printf("Usage: glslangValidator [option]... [file]...\n"
1531 "\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001532 "'file' can end in .<stage> for auto-stage classification, where <stage> is:\n"
1533 " .conf to provide a config file that replaces the default configuration\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001534 " (see -c option below for generating a template)\n"
1535 " .vert for a vertex shader\n"
1536 " .tesc for a tessellation control shader\n"
1537 " .tese for a tessellation evaluation shader\n"
1538 " .geom for a geometry shader\n"
1539 " .frag for a fragment shader\n"
1540 " .comp for a compute shader\n"
Chao Chen3c366992018-09-19 11:41:59 -07001541 " .mesh for a mesh shader\n"
1542 " .task for a task shader\n"
Chao Chenb50c02e2018-09-19 11:42:24 -07001543 " .rgen for a ray generation shader\n"
1544 " .rint for a ray intersection shader\n"
1545 " .rahit for a ray any hit shader\n"
1546 " .rchit for a ray closest hit shader\n"
1547 " .rmiss for a ray miss shader\n"
Sahil Parmar035cbbe2018-10-04 16:39:18 -07001548 " .rcall for a ray callable shader\n"
John Kessenich2ead40f2018-04-17 17:44:11 -06001549 " .glsl for .vert.glsl, .tesc.glsl, ..., .comp.glsl compound suffixes\n"
1550 " .hlsl for .vert.hlsl, .tesc.hlsl, ..., .comp.hlsl compound suffixes\n"
John Kessenich319de232013-12-04 04:43:40 +00001551 "\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001552 "Options:\n"
1553 " -C cascading errors; risk crash from accumulation of error recoveries\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001554 " -D input is HLSL (this is the default when any suffix is .hlsl)\n"
John Kessenich6f988922020-01-07 07:03:11 -07001555 " -D<name[=def]> | --define-macro <name[=def]> | --D <name[=def]>\n"
1556 " define a pre-processor macro\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001557 " -E print pre-processed GLSL; cannot be used with -l;\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001558 " errors will appear on stderr\n"
John Kessenich6353d552017-06-23 11:11:09 -06001559 " -G[ver] create SPIR-V binary, under OpenGL semantics; turns on -l;\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001560 " default file name is <stage>.spv (-o overrides this);\n"
John Kessenich6353d552017-06-23 11:11:09 -06001561 " 'ver', when present, is the version of the input semantics,\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001562 " which will appear in #define GL_SPIRV ver;\n"
1563 " '--client opengl100' is the same as -G100;\n"
John Kessenich6353d552017-06-23 11:11:09 -06001564 " a '--target-env' for OpenGL will also imply '-G'\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001565 " -H print human readable form of SPIR-V; turns on -V\n"
John Kessenich971a0a82017-06-07 15:06:58 -06001566 " -I<dir> add dir to the include search path; includer's directory\n"
1567 " is searched first, followed by left-to-right order of -I\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001568 " -Od disables optimization; may cause illegal SPIR-V for HLSL\n"
1569 " -Os optimizes SPIR-V to minimize size\n"
John Kesseniche751bca2017-03-16 11:20:38 -06001570 " -S <stage> uses specified stage rather than parsing the file extension\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001571 " choices for <stage> are vert, tesc, tese, geom, frag, or comp\n"
John Kessenich6f988922020-01-07 07:03:11 -07001572 " -U<name> | --undef-macro <name> | --U <name>\n"
1573 " undefine a pre-processor macro\n"
John Kessenich6353d552017-06-23 11:11:09 -06001574 " -V[ver] create SPIR-V binary, under Vulkan semantics; turns on -l;\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001575 " default file name is <stage>.spv (-o overrides this)\n"
John Kessenich6353d552017-06-23 11:11:09 -06001576 " 'ver', when present, is the version of the input semantics,\n"
1577 " which will appear in #define VULKAN ver\n"
1578 " '--client vulkan100' is the same as -V100\n"
1579 " a '--target-env' for Vulkan will also imply '-V'\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001580 " -c configuration dump;\n"
1581 " creates the default configuration file (redirect to a .conf file)\n"
1582 " -d default to desktop (#version 110) when there is no shader #version\n"
1583 " (default is ES version 100)\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001584 " -e <name> | --entry-point <name>\n"
1585 " specify <name> as the entry-point function name\n"
John Kessenich5d610ee2018-03-07 18:05:55 -07001586 " -f{hlsl_functionality1}\n"
1587 " 'hlsl_functionality1' enables use of the\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001588 " SPV_GOOGLE_hlsl_functionality1 extension\n"
John Kessenich121853f2017-05-31 17:11:16 -06001589 " -g generate debug information\n"
Shahbaz Youssefid52dce52020-06-17 12:47:44 -04001590 " -g0 strip debug information\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001591 " -h print this usage message\n"
1592 " -i intermediate tree (glslang AST) is printed out\n"
1593 " -l link all input files together to form a single module\n"
1594 " -m memory leak mode\n"
John Kessenicha25530c2017-09-11 20:13:49 -06001595 " -o <file> save binary to <file>, requires a binary option (e.g., -V)\n"
John Kesseniche5c394b2019-07-02 09:32:48 -06001596 " -q dump reflection query database; requires -l for linking\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001597 " -r | --relaxed-errors"
1598 " relaxed GLSL semantic error-checking mode\n"
John Kessenichb63f4a32017-11-16 22:32:20 -07001599 " -s silence syntax and semantic error reporting\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001600 " -t multi-threaded mode\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001601 " -v | --version\n"
1602 " print version strings\n"
1603 " -w | --suppress-warnings\n"
1604 " suppress GLSL warnings, except as required by \"#extension : warn\"\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001605 " -x save binary output as text-based 32-bit hexadecimal numbers\n"
Neil Roberts16f53472018-03-20 17:30:53 +01001606 " -u<name>:<loc> specify a uniform location override for --aml\n"
Neil Robertsb0f3d792018-03-20 17:41:05 +01001607 " --uniform-base <base> set a base to use for generated uniform locations\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001608 " --auto-map-bindings | --amb automatically bind uniform variables\n"
1609 " without explicit bindings\n"
1610 " --auto-map-locations | --aml automatically locate input/output lacking\n"
1611 " 'location' (fragile, not cross stage)\n"
1612 " --client {vulkan<ver>|opengl<ver>} see -V and -G\n"
Christoph Kubisch412ff6e2019-04-13 22:57:33 +02001613 " --dump-builtin-symbols prints builtin symbol table prior each compile\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001614 " -dumpfullversion | -dumpversion print bare major.minor.patchlevel\n"
1615 " --flatten-uniform-arrays | --fua flatten uniform texture/sampler arrays to\n"
1616 " scalars\n"
1617 " --hlsl-offsets allow block offsets to follow HLSL rules\n"
1618 " works independently of source language\n"
1619 " --hlsl-iomap perform IO mapping in HLSL register space\n"
1620 " --hlsl-enable-16bit-types allow 16-bit types in SPIR-V for HLSL\n"
John Kessenich605afc72019-06-17 23:33:09 -06001621 " --hlsl-dx9-compatible interprets sampler declarations as a\n"
rdbb56e0e42020-06-02 08:30:50 +02001622 " texture/sampler combo like DirectX9 would,\n"
1623 " and recognizes DirectX9-specific semantics\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001624 " --invert-y | --iy invert position.Y output in vertex shader\n"
1625 " --keep-uncalled | --ku don't eliminate uncalled functions\n"
John Kessenich605afc72019-06-17 23:33:09 -06001626 " --nan-clamp favor non-NaN operand in min, max, and clamp\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001627 " --no-storage-format | --nsf use Unknown image format\n"
Marcin Åšlusarz245c30c2020-07-03 14:55:29 +02001628 " --quiet do not print anything to stdout, unless\n"
1629 " requested by another option\n"
baldurk4513df92019-02-08 10:48:48 +00001630 " --reflect-strict-array-suffix use strict array suffix rules when\n"
1631 " reflecting\n"
baldurkedf82122019-01-29 15:49:00 +00001632 " --reflect-basic-array-suffix arrays of basic types will have trailing [0]\n"
baldurk4513df92019-02-08 10:48:48 +00001633 " --reflect-intermediate-io reflection includes inputs/outputs of linked\n"
1634 " shaders rather than just vertex/fragment\n"
1635 " --reflect-separate-buffers reflect buffer variables and blocks\n"
1636 " separately to uniforms\n"
1637 " --reflect-all-block-variables reflect all variables in blocks, whether\n"
1638 " inactive or active\n"
baldurk19050692019-02-11 11:50:24 +00001639 " --reflect-unwrap-io-blocks unwrap input/output blocks the same as\n"
1640 " uniform blocks\n"
LoopDawg52017192017-07-14 15:15:47 -06001641 " --resource-set-binding [stage] name set binding\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001642 " set descriptor set and binding for\n"
1643 " individual resources\n"
LoopDawg52017192017-07-14 15:15:47 -06001644 " --resource-set-binding [stage] set\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001645 " set descriptor set for all resources\n"
1646 " --rsb synonym for --resource-set-binding\n"
1647 " --shift-image-binding [stage] num\n"
1648 " base binding number for images (uav)\n"
1649 " --shift-image-binding [stage] [num set]...\n"
1650 " per-descriptor-set shift values\n"
1651 " --sib synonym for --shift-image-binding\n"
1652 " --shift-sampler-binding [stage] num\n"
1653 " base binding number for samplers\n"
1654 " --shift-sampler-binding [stage] [num set]...\n"
1655 " per-descriptor-set shift values\n"
1656 " --ssb synonym for --shift-sampler-binding\n"
1657 " --shift-ssbo-binding [stage] num base binding number for SSBOs\n"
1658 " --shift-ssbo-binding [stage] [num set]...\n"
1659 " per-descriptor-set shift values\n"
1660 " --sbb synonym for --shift-ssbo-binding\n"
1661 " --shift-texture-binding [stage] num\n"
1662 " base binding number for textures\n"
1663 " --shift-texture-binding [stage] [num set]...\n"
1664 " per-descriptor-set shift values\n"
1665 " --stb synonym for --shift-texture-binding\n"
1666 " --shift-uav-binding [stage] num base binding number for UAVs\n"
1667 " --shift-uav-binding [stage] [num set]...\n"
1668 " per-descriptor-set shift values\n"
1669 " --suavb synonym for --shift-uav-binding\n"
1670 " --shift-UBO-binding [stage] num base binding number for UBOs\n"
1671 " --shift-UBO-binding [stage] [num set]...\n"
1672 " per-descriptor-set shift values\n"
1673 " --sub synonym for --shift-UBO-binding\n"
1674 " --shift-cbuffer-binding | --scb synonyms for --shift-UBO-binding\n"
1675 " --spirv-dis output standard-form disassembly; works only\n"
1676 " when a SPIR-V generation option is also used\n"
John Kessenichc3404252018-08-23 15:29:08 -06001677 " --spirv-val execute the SPIRV-Tools validator\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001678 " --source-entrypoint <name> the given shader source function is\n"
1679 " renamed to be the <name> given in -e\n"
1680 " --sep synonym for --source-entrypoint\n"
1681 " --stdin read from stdin instead of from a file;\n"
1682 " requires providing the shader stage using -S\n"
John Kessenich273d3a52020-01-15 00:10:41 -07001683 " --target-env {vulkan1.0 | vulkan1.1 | vulkan1.2 | opengl | \n"
John Kessenich8317e6c2019-08-18 23:58:08 -06001684 " spirv1.0 | spirv1.1 | spirv1.2 | spirv1.3 | spirv1.4 | spirv1.5}\n"
John Kessenich273d3a52020-01-15 00:10:41 -07001685 " Set the execution environment that the\n"
1686 " generated code will be executed in.\n"
1687 " Defaults to:\n"
1688 " * vulkan1.0 under --client vulkan<ver>\n"
1689 " * opengl under --client opengl<ver>\n"
1690 " * spirv1.0 under --target-env vulkan1.0\n"
1691 " * spirv1.3 under --target-env vulkan1.1\n"
1692 " * spirv1.5 under --target-env vulkan1.2\n"
1693 " Multiple --target-env can be specified.\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001694 " --variable-name <name>\n"
1695 " --vn <name> creates a C header file that contains a\n"
1696 " uint32_t array named <name>\n"
1697 " initialized with the shader binary code\n"
John Kessenichb0a7eb52013-11-07 17:44:20 +00001698 );
John Kessenich68d78fd2015-07-12 19:28:10 -06001699
1700 exit(EFailUsage);
John Kessenicha0af4732012-12-12 21:15:54 +00001701}
1702
John Kessenich3ce4e592014-10-06 19:57:34 +00001703#if !defined _MSC_VER && !defined MINGW_HAS_SECURE_API
John Kessenichcfd643e2013-03-08 23:14:42 +00001704
1705#include <errno.h>
1706
1707int fopen_s(
1708 FILE** pFile,
John Kessenich51cdd902014-02-18 23:37:57 +00001709 const char* filename,
1710 const char* mode
John Kessenichcfd643e2013-03-08 23:14:42 +00001711)
1712{
1713 if (!pFile || !filename || !mode) {
1714 return EINVAL;
1715 }
1716
1717 FILE* f = fopen(filename, mode);
1718 if (! f) {
1719 if (errno != 0) {
1720 return errno;
1721 } else {
1722 return ENOENT;
1723 }
1724 }
1725 *pFile = f;
1726
1727 return 0;
1728}
1729
1730#endif
1731
John Kessenicha0af4732012-12-12 21:15:54 +00001732//
1733// Malloc a string of sufficient size and read a string into it.
1734//
John Kessenich04acb1b2017-06-14 17:36:50 -06001735char* ReadFileData(const char* fileName)
John Kessenicha0af4732012-12-12 21:15:54 +00001736{
John Kessenichb3297152015-07-11 18:01:03 -06001737 FILE *in = nullptr;
John Kessenich3ce4e592014-10-06 19:57:34 +00001738 int errorCode = fopen_s(&in, fileName, "r");
John Kessenich68d78fd2015-07-12 19:28:10 -06001739 if (errorCode || in == nullptr)
1740 Error("unable to open input file");
John Kessenichecba76f2017-01-06 00:34:48 -07001741
John Kessenich04acb1b2017-06-14 17:36:50 -06001742 int count = 0;
John Kessenicha0af4732012-12-12 21:15:54 +00001743 while (fgetc(in) != EOF)
1744 count++;
1745
John Kessenichd6c72a42014-08-18 19:42:35 +00001746 fseek(in, 0, SEEK_SET);
John Kessenichca3457f2015-05-18 01:59:45 +00001747
John Kessenich04acb1b2017-06-14 17:36:50 -06001748 char* return_data = (char*)malloc(count + 1); // freed in FreeFileData()
1749 if ((int)fread(return_data, 1, count, in) != count) {
1750 free(return_data);
John Kessenich68d78fd2015-07-12 19:28:10 -06001751 Error("can't read input file");
John Kessenicha0af4732012-12-12 21:15:54 +00001752 }
John Kessenich68d78fd2015-07-12 19:28:10 -06001753
John Kessenich04acb1b2017-06-14 17:36:50 -06001754 return_data[count] = '\0';
John Kessenicha0af4732012-12-12 21:15:54 +00001755 fclose(in);
John Kessenichb3297152015-07-11 18:01:03 -06001756
John Kessenicha0af4732012-12-12 21:15:54 +00001757 return return_data;
1758}
1759
John Kessenich04acb1b2017-06-14 17:36:50 -06001760void FreeFileData(char* data)
John Kessenicha0af4732012-12-12 21:15:54 +00001761{
John Kessenichb3297152015-07-11 18:01:03 -06001762 free(data);
John Kessenicha0af4732012-12-12 21:15:54 +00001763}
1764
John Kessenich54d8cda2013-02-11 22:36:01 +00001765void InfoLogMsg(const char* msg, const char* name, const int num)
John Kessenicha0af4732012-12-12 21:15:54 +00001766{
John Kessenichfae38ee2015-06-10 23:23:12 +00001767 if (num >= 0 )
1768 printf("#### %s %s %d INFO LOG ####\n", msg, name, num);
1769 else
1770 printf("#### %s %s INFO LOG ####\n", msg, name);
John Kessenicha0af4732012-12-12 21:15:54 +00001771}