blob: 68cb8e90d30dad448b9bcc4cab37b550b319b554 [file] [log] [blame]
John Kessenicha0af4732012-12-12 21:15:54 +00001//
John Kessenich927608b2017-01-06 12:34:14 -07002// Copyright (C) 2002-2005 3Dlabs Inc. Ltd.
3// Copyright (C) 2013-2016 LunarG, Inc.
John Kessenichbd0747d2013-02-17 06:01:50 +00004//
John Kessenich927608b2017-01-06 12:34:14 -07005// All rights reserved.
John Kessenicha0af4732012-12-12 21:15:54 +00006//
John Kessenich927608b2017-01-06 12:34:14 -07007// Redistribution and use in source and binary forms, with or without
8// modification, are permitted provided that the following conditions
9// are met:
John Kessenicha0af4732012-12-12 21:15:54 +000010//
11// Redistributions of source code must retain the above copyright
12// notice, this list of conditions and the following disclaimer.
13//
14// Redistributions in binary form must reproduce the above
15// copyright notice, this list of conditions and the following
16// disclaimer in the documentation and/or other materials provided
17// with the distribution.
18//
19// Neither the name of 3Dlabs Inc. Ltd. nor the names of its
20// contributors may be used to endorse or promote products derived
21// from this software without specific prior written permission.
22//
John Kessenich927608b2017-01-06 12:34:14 -070023// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
26// FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
27// COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
28// INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
29// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
30// LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
31// CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32// LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
33// ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34// POSSIBILITY OF SUCH DAMAGE.
John Kessenicha0af4732012-12-12 21:15:54 +000035//
John Kessenich05a70632013-09-17 19:26:08 +000036
37// this only applies to the standalone wrapper, not the front end in general
Aras Pranckevicius8e204b22017-05-10 16:52:50 +030038#ifndef _CRT_SECURE_NO_WARNINGS
John Kessenich05a70632013-09-17 19:26:08 +000039#define _CRT_SECURE_NO_WARNINGS
Aras Pranckevicius8e204b22017-05-10 16:52:50 +030040#endif
John Kessenich05a70632013-09-17 19:26:08 +000041
Lei Zhang8a9b1ee2016-05-19 13:31:43 -040042#include "ResourceLimits.h"
John Kessenich2b07c7e2013-07-31 18:44:13 +000043#include "Worklist.h"
John Kessenich3494b4d2017-05-22 15:00:42 -060044#include "DirStackFileIncluder.h"
John Kessenicha0af4732012-12-12 21:15:54 +000045#include "./../glslang/Include/ShHandle.h"
John Kessenich0da9eaa2015-08-01 17:10:02 -060046#include "./../glslang/Include/revision.h"
John Kessenicha0af4732012-12-12 21:15:54 +000047#include "./../glslang/Public/ShaderLang.h"
John Kessenich0df0cde2015-03-03 17:09:43 +000048#include "../SPIRV/GlslangToSpv.h"
John Kessenich5e4b1242015-08-06 22:53:06 -060049#include "../SPIRV/GLSL.std.450.h"
John Kessenichacba7722015-03-04 03:48:38 +000050#include "../SPIRV/doc.h"
51#include "../SPIRV/disassemble.h"
John Kessenich3494b4d2017-05-22 15:00:42 -060052
John Kessenich66ec80e2016-08-05 14:04:23 -060053#include <cstring>
54#include <cstdlib>
steve-lunarg7f7c2ed2016-09-07 15:20:19 -060055#include <cctype>
John Kessenich66ec80e2016-08-05 14:04:23 -060056#include <cmath>
steve-lunarg7f7c2ed2016-09-07 15:20:19 -060057#include <array>
LoopDawg08a14422017-10-17 19:27:14 -060058#include <map>
Juan Lopeza558b262017-04-02 23:04:00 +020059#include <memory>
60#include <thread>
John Kessenicha0af4732012-12-12 21:15:54 +000061
baldurk876a0e32015-11-16 18:03:28 +010062#include "../glslang/OSDependent/osinclude.h"
John Kessenicha0af4732012-12-12 21:15:54 +000063
64extern "C" {
65 SH_IMPORT_EXPORT void ShOutputHtml();
66}
67
John Kessenich94a81fb2013-08-31 02:41:30 +000068// Command-line options
69enum TOptions {
John Kessenich906cc212016-12-09 19:22:20 -070070 EOptionNone = 0,
71 EOptionIntermediate = (1 << 0),
72 EOptionSuppressInfolog = (1 << 1),
73 EOptionMemoryLeakMode = (1 << 2),
74 EOptionRelaxedErrors = (1 << 3),
75 EOptionGiveWarnings = (1 << 4),
76 EOptionLinkProgram = (1 << 5),
77 EOptionMultiThreaded = (1 << 6),
78 EOptionDumpConfig = (1 << 7),
79 EOptionDumpReflection = (1 << 8),
80 EOptionSuppressWarnings = (1 << 9),
81 EOptionDumpVersions = (1 << 10),
82 EOptionSpv = (1 << 11),
83 EOptionHumanReadableSpv = (1 << 12),
84 EOptionVulkanRules = (1 << 13),
85 EOptionDefaultDesktop = (1 << 14),
86 EOptionOutputPreprocessed = (1 << 15),
87 EOptionOutputHexadecimal = (1 << 16),
88 EOptionReadHlsl = (1 << 17),
89 EOptionCascadingErrors = (1 << 18),
90 EOptionAutoMapBindings = (1 << 19),
steve-lunarge0b9deb2016-09-16 13:26:37 -060091 EOptionFlattenUniformArrays = (1 << 20),
John Kessenich906cc212016-12-09 19:22:20 -070092 EOptionNoStorageFormat = (1 << 21),
John Kessenich20f01e72016-12-12 11:41:43 -070093 EOptionKeepUncalled = (1 << 22),
John Kessenich4f1403e2017-04-05 17:38:20 -060094 EOptionHlslOffsets = (1 << 23),
steve-lunargbe283552017-04-18 12:18:01 -060095 EOptionHlslIoMapping = (1 << 24),
John Kessenich71facdf2017-05-17 18:28:19 -060096 EOptionAutoMapLocations = (1 << 25),
John Kessenich121853f2017-05-31 17:11:16 -060097 EOptionDebug = (1 << 26),
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +020098 EOptionStdin = (1 << 27),
GregFcd1f1692017-09-21 18:40:22 -060099 EOptionOptimizeDisable = (1 << 28),
100 EOptionOptimizeSize = (1 << 29),
LoopDawgb22c0692017-12-06 16:52:03 -0700101 EOptionInvertY = (1 << 30),
John Kessenichc6c80a62018-03-05 22:23:17 -0700102 EOptionDumpBareVersion = (1 << 31),
John Kessenich94a81fb2013-08-31 02:41:30 +0000103};
John Kessenich5d610ee2018-03-07 18:05:55 -0700104bool targetHlslFunctionality1 = false;
John Kesseniche2156222018-06-11 18:12:15 -0600105bool SpvToolsDisassembler = false;
John Kessenichc3404252018-08-23 15:29:08 -0600106bool SpvToolsValidate = false;
John Kessenich605afc72019-06-17 23:33:09 -0600107bool NaNClamp = false;
John Kessenich94a81fb2013-08-31 02:41:30 +0000108
John Kessenicha0af4732012-12-12 21:15:54 +0000109//
John Kessenich68d78fd2015-07-12 19:28:10 -0600110// Return codes from main/exit().
John Kessenicha0af4732012-12-12 21:15:54 +0000111//
112enum TFailCode {
113 ESuccess = 0,
114 EFailUsage,
115 EFailCompile,
116 EFailLink,
117 EFailCompilerCreate,
John Kessenich2b07c7e2013-07-31 18:44:13 +0000118 EFailThreadCreate,
John Kessenicha0af4732012-12-12 21:15:54 +0000119 EFailLinkerCreate
120};
121
122//
John Kessenich68d78fd2015-07-12 19:28:10 -0600123// Forward declarations.
John Kessenicha0af4732012-12-12 21:15:54 +0000124//
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600125EShLanguage FindLanguage(const std::string& name, bool parseSuffix=true);
John Kessenich51cdd902014-02-18 23:37:57 +0000126void CompileFile(const char* fileName, ShHandle);
John Kessenicha0af4732012-12-12 21:15:54 +0000127void usage();
John Kessenich04acb1b2017-06-14 17:36:50 -0600128char* ReadFileData(const char* fileName);
129void FreeFileData(char* data);
John Kessenich54d8cda2013-02-11 22:36:01 +0000130void InfoLogMsg(const char* msg, const char* name, const int num);
John Kessenich41cf6b52013-06-25 18:10:05 +0000131
John Kessenichc999ba22013-11-07 23:33:24 +0000132// Globally track if any compile or link failure.
133bool CompileFailed = false;
134bool LinkFailed = false;
135
John Kessenich94f28eb2017-11-13 01:32:06 -0700136// array of unique places to leave the shader names and infologs for the asynchronous compiles
137std::vector<std::unique_ptr<glslang::TWorkItem>> WorkItems;
138
John Kessenich05a70632013-09-17 19:26:08 +0000139TBuiltInResource Resources;
140std::string ConfigFile;
141
John Kessenicha0af4732012-12-12 21:15:54 +0000142//
John Kessenichf0bcb0a2016-04-02 13:09:14 -0600143// Parse either a .conf file provided by the user or the default from glslang::DefaultTBuiltInResource
John Kessenich05a70632013-09-17 19:26:08 +0000144//
145void ProcessConfigFile()
John Kessenichb51f62c2013-04-11 16:31:09 +0000146{
John Kessenich04acb1b2017-06-14 17:36:50 -0600147 if (ConfigFile.size() == 0)
Lei Zhang414eb602016-03-04 16:22:34 -0500148 Resources = glslang::DefaultTBuiltInResource;
John Kessenich23d27752019-07-28 02:12:10 -0600149#ifndef GLSLANG_WEB
John Kessenich04acb1b2017-06-14 17:36:50 -0600150 else {
151 char* configString = ReadFileData(ConfigFile.c_str());
152 glslang::DecodeResourceLimits(&Resources, configString);
153 FreeFileData(configString);
John Kessenich05a70632013-09-17 19:26:08 +0000154 }
John Kessenich23d27752019-07-28 02:12:10 -0600155#endif
John Kessenicha0af4732012-12-12 21:15:54 +0000156}
157
baldurk6d477852019-01-29 15:45:56 +0000158int ReflectOptions = EShReflectionDefault;
John Kessenich94a81fb2013-08-31 02:41:30 +0000159int Options = 0;
John Kessenich68d78fd2015-07-12 19:28:10 -0600160const char* ExecutableName = nullptr;
161const char* binaryFileName = nullptr;
John Kessenich4d65ee32016-03-12 18:17:47 -0700162const char* entryPointName = nullptr;
steve-lunargf1e0c872016-10-31 15:13:43 -0600163const char* sourceEntryPointName = nullptr;
Dan Bakerc6ede892016-08-11 14:06:06 -0400164const char* shaderStageName = nullptr;
Flavioaea3c892017-02-06 11:46:35 -0800165const char* variableName = nullptr;
Rex Xucb61eec2018-03-07 13:10:01 +0800166bool HlslEnable16BitTypes = false;
John Kessenichbd1c1832018-12-07 18:38:26 -0700167bool HlslDX9compatible = false;
Christoph Kubisch55ba3ea2019-04-13 22:18:16 +0200168bool DumpBuiltinSymbols = false;
John Kessenich971a0a82017-06-07 15:06:58 -0600169std::vector<std::string> IncludeDirectoryList;
John Kessenich8717a5d2018-10-26 10:12:32 -0600170
171// Source environment
172// (source 'Client' is currently the same as target 'Client')
173int ClientInputSemanticsVersion = 100;
174
175// Target environment
176glslang::EShClient Client = glslang::EShClientNone; // will stay EShClientNone if only validating
177glslang::EShTargetClientVersion ClientVersion; // not valid until Client is set
178glslang::EShTargetLanguage TargetLanguage = glslang::EShTargetNone;
179glslang::EShTargetLanguageVersion TargetVersion; // not valid until TargetLanguage is set
180
John Kessenich66011cb2018-03-06 16:12:04 -0700181std::vector<std::string> Processes; // what should be recorded by OpModuleProcessed, or equivalent
John Kessenich68d78fd2015-07-12 19:28:10 -0600182
LoopDawg08a14422017-10-17 19:27:14 -0600183// Per descriptor-set binding base data
184typedef std::map<unsigned int, unsigned int> TPerSetBaseBinding;
185
Neil Roberts16f53472018-03-20 17:30:53 +0100186std::vector<std::pair<std::string, int>> uniformLocationOverrides;
Neil Robertsb0f3d792018-03-20 17:41:05 +0100187int uniformBase = 0;
Neil Roberts16f53472018-03-20 17:30:53 +0100188
LoopDawg08a14422017-10-17 19:27:14 -0600189std::array<std::array<unsigned int, EShLangCount>, glslang::EResCount> baseBinding;
190std::array<std::array<TPerSetBaseBinding, EShLangCount>, glslang::EResCount> baseBindingForSet;
Hyangran Park36dc8292017-05-02 16:27:29 +0900191std::array<std::vector<std::string>, EShLangCount> baseResourceSetBinding;
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600192
John Kessenicha9313662017-06-15 10:40:49 -0600193// Add things like "#define ..." to a preamble to use in the beginning of the shader.
194class TPreamble {
195public:
196 TPreamble() { }
197
198 bool isSet() const { return text.size() > 0; }
199 const char* get() const { return text.c_str(); }
200
201 // #define...
202 void addDef(std::string def)
203 {
204 text.append("#define ");
205 fixLine(def);
206
John Kessenich2a271162017-07-20 20:00:36 -0600207 Processes.push_back("D");
208 Processes.back().append(def);
209
John Kessenicha9313662017-06-15 10:40:49 -0600210 // The first "=" needs to turn into a space
LoopDawgb97b25e2017-07-12 09:04:39 -0600211 const size_t equal = def.find_first_of("=");
John Kessenicha9313662017-06-15 10:40:49 -0600212 if (equal != def.npos)
213 def[equal] = ' ';
214
215 text.append(def);
216 text.append("\n");
217 }
218
219 // #undef...
220 void addUndef(std::string undef)
221 {
222 text.append("#undef ");
223 fixLine(undef);
John Kessenich2a271162017-07-20 20:00:36 -0600224
225 Processes.push_back("U");
226 Processes.back().append(undef);
227
John Kessenicha9313662017-06-15 10:40:49 -0600228 text.append(undef);
229 text.append("\n");
230 }
231
232protected:
233 void fixLine(std::string& line)
234 {
235 // Can't go past a newline in the line
LoopDawgb97b25e2017-07-12 09:04:39 -0600236 const size_t end = line.find_first_of("\n");
John Kessenicha9313662017-06-15 10:40:49 -0600237 if (end != line.npos)
238 line = line.substr(0, end);
239 }
240
241 std::string text; // contents of preamble
242};
243
244TPreamble UserPreamble;
245
John Kessenich68d78fd2015-07-12 19:28:10 -0600246//
247// Create the default name for saving a binary if -o is not provided.
248//
249const char* GetBinaryName(EShLanguage stage)
250{
251 const char* name;
252 if (binaryFileName == nullptr) {
253 switch (stage) {
254 case EShLangVertex: name = "vert.spv"; break;
255 case EShLangTessControl: name = "tesc.spv"; break;
256 case EShLangTessEvaluation: name = "tese.spv"; break;
257 case EShLangGeometry: name = "geom.spv"; break;
258 case EShLangFragment: name = "frag.spv"; break;
259 case EShLangCompute: name = "comp.spv"; break;
Chao Chen3c366992018-09-19 11:41:59 -0700260#ifdef NV_EXTENSIONS
Chao Chenb50c02e2018-09-19 11:42:24 -0700261 case EShLangRayGenNV: name = "rgen.spv"; break;
262 case EShLangIntersectNV: name = "rint.spv"; break;
263 case EShLangAnyHitNV: name = "rahit.spv"; break;
264 case EShLangClosestHitNV: name = "rchit.spv"; break;
265 case EShLangMissNV: name = "rmiss.spv"; break;
266 case EShLangCallableNV: name = "rcall.spv"; break;
Chao Chen3c366992018-09-19 11:41:59 -0700267 case EShLangMeshNV: name = "mesh.spv"; break;
268 case EShLangTaskNV: name = "task.spv"; break;
269#endif
John Kessenich68d78fd2015-07-12 19:28:10 -0600270 default: name = "unknown"; break;
271 }
272 } else
273 name = binaryFileName;
274
275 return name;
276}
John Kessenich2b07c7e2013-07-31 18:44:13 +0000277
John Kessenich05a70632013-09-17 19:26:08 +0000278//
279// *.conf => this is a config file that can set limits/resources
280//
281bool SetConfigFile(const std::string& name)
282{
283 if (name.size() < 5)
284 return false;
285
John Kessenich4c706852013-10-11 16:28:43 +0000286 if (name.compare(name.size() - 5, 5, ".conf") == 0) {
John Kessenich05a70632013-09-17 19:26:08 +0000287 ConfigFile = name;
288 return true;
289 }
290
291 return false;
292}
293
John Kessenich68d78fd2015-07-12 19:28:10 -0600294//
295// Give error and exit with failure code.
296//
297void Error(const char* message)
298{
John Kessenichaf527992017-11-02 22:48:15 -0600299 fprintf(stderr, "%s: Error %s (use -h for usage)\n", ExecutableName, message);
John Kessenich68d78fd2015-07-12 19:28:10 -0600300 exit(EFailUsage);
301}
302
303//
LoopDawg08a14422017-10-17 19:27:14 -0600304// Process an optional binding base of one the forms:
305// --argname [stage] base // base for stage (if given) or all stages (if not)
LoopDawge5709552017-10-21 10:46:39 -0600306// --argname [stage] [base set]... // set/base pairs: set the base for given binding set.
LoopDawg08a14422017-10-17 19:27:14 -0600307
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600308// Where stage is one of the forms accepted by FindLanguage, and base is an integer
309//
LoopDawg08a14422017-10-17 19:27:14 -0600310void ProcessBindingBase(int& argc, char**& argv, glslang::TResourceType res)
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600311{
312 if (argc < 2)
313 usage();
314
LoopDawg08a14422017-10-17 19:27:14 -0600315 EShLanguage lang = EShLangCount;
316 int singleBase = 0;
317 TPerSetBaseBinding perSetBase;
318 int arg = 1;
319
320 // Parse stage, if given
321 if (!isdigit(argv[arg][0])) {
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600322 if (argc < 3) // this form needs one more argument
323 usage();
John Kessenichecba76f2017-01-06 00:34:48 -0700324
LoopDawg08a14422017-10-17 19:27:14 -0600325 lang = FindLanguage(argv[arg++], false);
326 }
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600327
LoopDawg08a14422017-10-17 19:27:14 -0600328 if ((argc - arg) > 2 && isdigit(argv[arg+0][0]) && isdigit(argv[arg+1][0])) {
329 // Parse a per-set binding base
330 while ((argc - arg) > 2 && isdigit(argv[arg+0][0]) && isdigit(argv[arg+1][0])) {
LoopDawg08a14422017-10-17 19:27:14 -0600331 const int baseNum = atoi(argv[arg++]);
LoopDawge5709552017-10-21 10:46:39 -0600332 const int setNum = atoi(argv[arg++]);
LoopDawg08a14422017-10-17 19:27:14 -0600333 perSetBase[setNum] = baseNum;
334 }
335 } else {
336 // Parse single binding base
337 singleBase = atoi(argv[arg++]);
338 }
339
340 argc -= (arg-1);
341 argv += (arg-1);
342
343 // Set one or all languages
344 const int langMin = (lang < EShLangCount) ? lang+0 : 0;
345 const int langMax = (lang < EShLangCount) ? lang+1 : EShLangCount;
346
347 for (int lang = langMin; lang < langMax; ++lang) {
348 if (!perSetBase.empty())
John Kessenich251901a2018-08-12 22:05:59 -0600349 baseBindingForSet[res][lang].insert(perSetBase.begin(), perSetBase.end());
LoopDawg08a14422017-10-17 19:27:14 -0600350 else
351 baseBinding[res][lang] = singleBase;
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600352 }
353}
354
Hyangran Park36dc8292017-05-02 16:27:29 +0900355void ProcessResourceSetBindingBase(int& argc, char**& argv, std::array<std::vector<std::string>, EShLangCount>& base)
356{
357 if (argc < 2)
358 usage();
359
360 if (!isdigit(argv[1][0])) {
LoopDawg52017192017-07-14 15:15:47 -0600361 if (argc < 3) // this form needs one more argument
Hyangran Park36dc8292017-05-02 16:27:29 +0900362 usage();
363
LoopDawg52017192017-07-14 15:15:47 -0600364 // Parse form: --argname stage [regname set base...], or:
365 // --argname stage set
Hyangran Park36dc8292017-05-02 16:27:29 +0900366 const EShLanguage lang = FindLanguage(argv[1], false);
367
LoopDawg52017192017-07-14 15:15:47 -0600368 argc--;
369 argv++;
370
371 while (argc > 1 && argv[1] != nullptr && argv[1][0] != '-') {
372 base[lang].push_back(argv[1]);
373
374 argc--;
375 argv++;
Hyangran Park36dc8292017-05-02 16:27:29 +0900376 }
LoopDawg52017192017-07-14 15:15:47 -0600377
378 // Must have one arg, or a multiple of three (for [regname set binding] triples)
379 if (base[lang].size() != 1 && (base[lang].size() % 3) != 0)
380 usage();
381
Hyangran Park36dc8292017-05-02 16:27:29 +0900382 } else {
LoopDawg52017192017-07-14 15:15:47 -0600383 // Parse form: --argname set
Hyangran Park36dc8292017-05-02 16:27:29 +0900384 for (int lang=0; lang<EShLangCount; ++lang)
385 base[lang].push_back(argv[1]);
386
387 argc--;
388 argv++;
389 }
390}
391
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600392//
John Kessenich68d78fd2015-07-12 19:28:10 -0600393// Do all command-line argument parsing. This includes building up the work-items
394// to be processed later, and saving all the command-line options.
395//
396// Does not return (it exits) if command-line is fatally flawed.
397//
Juan Lopeza558b262017-04-02 23:04:00 +0200398void ProcessArguments(std::vector<std::unique_ptr<glslang::TWorkItem>>& workItems, int argc, char* argv[])
John Kessenich2b07c7e2013-07-31 18:44:13 +0000399{
LoopDawg08a14422017-10-17 19:27:14 -0600400 for (int res = 0; res < glslang::EResCount; ++res)
401 baseBinding[res].fill(0);
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600402
John Kessenich38f3b892013-09-06 19:52:57 +0000403 ExecutableName = argv[0];
Juan Lopeza558b262017-04-02 23:04:00 +0200404 workItems.reserve(argc);
John Kessenich38f3b892013-09-06 19:52:57 +0000405
John Kessenichc178f0a2017-06-23 10:58:31 -0600406 const auto bumpArg = [&]() {
407 if (argc > 0) {
408 argc--;
409 argv++;
410 }
411 };
412
413 // read a string directly attached to a single-letter option
John Kessenich6263fb12017-06-14 15:52:44 -0600414 const auto getStringOperand = [&](const char* desc) {
415 if (argv[0][2] == 0) {
416 printf("%s must immediately follow option (no spaces)\n", desc);
417 exit(EFailUsage);
418 }
419 return argv[0] + 2;
420 };
421
John Kessenich6353d552017-06-23 11:11:09 -0600422 // read a number attached to a single-letter option
423 const auto getAttachedNumber = [&](const char* desc) {
424 int num = atoi(argv[0] + 2);
425 if (num == 0) {
426 printf("%s: expected attached non-0 number\n", desc);
427 exit(EFailUsage);
428 }
429 return num;
430 };
431
432 // minimum needed (without overriding something else) to target Vulkan SPIR-V
433 const auto setVulkanSpv = []() {
John Kessenich8717a5d2018-10-26 10:12:32 -0600434 if (Client == glslang::EShClientNone)
435 ClientVersion = glslang::EShTargetVulkan_1_0;
436 Client = glslang::EShClientVulkan;
John Kessenich6353d552017-06-23 11:11:09 -0600437 Options |= EOptionSpv;
438 Options |= EOptionVulkanRules;
439 Options |= EOptionLinkProgram;
440 };
441
442 // minimum needed (without overriding something else) to target OpenGL SPIR-V
443 const auto setOpenGlSpv = []() {
John Kessenich8717a5d2018-10-26 10:12:32 -0600444 if (Client == glslang::EShClientNone)
445 ClientVersion = glslang::EShTargetOpenGL_450;
446 Client = glslang::EShClientOpenGL;
John Kessenich6353d552017-06-23 11:11:09 -0600447 Options |= EOptionSpv;
448 Options |= EOptionLinkProgram;
449 // undo a -H default to Vulkan
450 Options &= ~EOptionVulkanRules;
451 };
452
Neil Roberts16f53472018-03-20 17:30:53 +0100453 const auto getUniformOverride = [getStringOperand]() {
454 const char *arg = getStringOperand("-u<name>:<location>");
455 const char *split = strchr(arg, ':');
456 if (split == NULL) {
457 printf("%s: missing location\n", arg);
458 exit(EFailUsage);
459 }
460 errno = 0;
461 int location = ::strtol(split + 1, NULL, 10);
462 if (errno) {
463 printf("%s: invalid location\n", arg);
464 exit(EFailUsage);
465 }
466 return std::make_pair(std::string(arg, split - arg), location);
467 };
468
John Kessenichc178f0a2017-06-23 10:58:31 -0600469 for (bumpArg(); argc >= 1; bumpArg()) {
John Kessenich2b07c7e2013-07-31 18:44:13 +0000470 if (argv[0][0] == '-') {
John Kessenich2aa7f3a2015-05-15 16:02:07 +0000471 switch (argv[0][1]) {
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600472 case '-':
473 {
474 std::string lowerword(argv[0]+2);
475 std::transform(lowerword.begin(), lowerword.end(), lowerword.begin(), ::tolower);
476
477 // handle --word style options
John Kessenich6263fb12017-06-14 15:52:44 -0600478 if (lowerword == "auto-map-bindings" || // synonyms
John Kessenich6353d552017-06-23 11:11:09 -0600479 lowerword == "auto-map-binding" ||
480 lowerword == "amb") {
John Kessenich6263fb12017-06-14 15:52:44 -0600481 Options |= EOptionAutoMapBindings;
482 } else if (lowerword == "auto-map-locations" || // synonyms
483 lowerword == "aml") {
484 Options |= EOptionAutoMapLocations;
Neil Robertsb0f3d792018-03-20 17:41:05 +0100485 } else if (lowerword == "uniform-base") {
486 if (argc <= 1)
487 Error("no <base> provided for --uniform-base");
488 uniformBase = ::strtol(argv[1], NULL, 10);
489 bumpArg();
490 break;
John Kessenich6353d552017-06-23 11:11:09 -0600491 } else if (lowerword == "client") {
492 if (argc > 1) {
493 if (strcmp(argv[1], "vulkan100") == 0)
494 setVulkanSpv();
495 else if (strcmp(argv[1], "opengl100") == 0)
496 setOpenGlSpv();
497 else
498 Error("--client expects vulkan100 or opengl100");
499 }
500 bumpArg();
Christoph Kubisch55ba3ea2019-04-13 22:18:16 +0200501 } else if (lowerword == "dump-builtin-symbols") {
502 DumpBuiltinSymbols = true;
John Kessenich640bd092018-08-09 14:15:00 -0600503 } else if (lowerword == "entry-point") {
504 entryPointName = argv[1];
505 if (argc <= 1)
506 Error("no <name> provided for --entry-point");
507 bumpArg();
John Kessenich6263fb12017-06-14 15:52:44 -0600508 } else if (lowerword == "flatten-uniform-arrays" || // synonyms
509 lowerword == "flatten-uniform-array" ||
510 lowerword == "fua") {
511 Options |= EOptionFlattenUniformArrays;
512 } else if (lowerword == "hlsl-offsets") {
513 Options |= EOptionHlslOffsets;
514 } else if (lowerword == "hlsl-iomap" ||
515 lowerword == "hlsl-iomapper" ||
516 lowerword == "hlsl-iomapping") {
517 Options |= EOptionHlslIoMapping;
Rex Xucb61eec2018-03-07 13:10:01 +0800518 } else if (lowerword == "hlsl-enable-16bit-types") {
519 HlslEnable16BitTypes = true;
John Kessenichbd1c1832018-12-07 18:38:26 -0700520 } else if (lowerword == "hlsl-dx9-compatible") {
521 HlslDX9compatible = true;
John Kessenichc6c80a62018-03-05 22:23:17 -0700522 } else if (lowerword == "invert-y" || // synonyms
523 lowerword == "iy") {
524 Options |= EOptionInvertY;
John Kessenich6263fb12017-06-14 15:52:44 -0600525 } else if (lowerword == "keep-uncalled" || // synonyms
526 lowerword == "ku") {
527 Options |= EOptionKeepUncalled;
John Kessenich605afc72019-06-17 23:33:09 -0600528 } else if (lowerword == "nan-clamp") {
529 NaNClamp = true;
John Kessenich6263fb12017-06-14 15:52:44 -0600530 } else if (lowerword == "no-storage-format" || // synonyms
531 lowerword == "nsf") {
532 Options |= EOptionNoStorageFormat;
John Kessenich2a271162017-07-20 20:00:36 -0600533 } else if (lowerword == "relaxed-errors") {
534 Options |= EOptionRelaxedErrors;
baldurk15c37f72019-01-29 12:12:59 +0000535 } else if (lowerword == "reflect-strict-array-suffix") {
536 ReflectOptions |= EShReflectionStrictArraySuffix;
baldurkedf82122019-01-29 15:49:00 +0000537 } else if (lowerword == "reflect-basic-array-suffix") {
538 ReflectOptions |= EShReflectionBasicArraySuffix;
baldurk0af5e3e2019-01-29 16:04:44 +0000539 } else if (lowerword == "reflect-intermediate-io") {
540 ReflectOptions |= EShReflectionIntermediateIO;
baldurk657acc02019-01-30 14:18:43 +0000541 } else if (lowerword == "reflect-separate-buffers") {
542 ReflectOptions |= EShReflectionSeparateBuffers;
baldurka972e732019-01-30 15:34:02 +0000543 } else if (lowerword == "reflect-all-block-variables") {
544 ReflectOptions |= EShReflectionAllBlockVariables;
baldurk19050692019-02-11 11:50:24 +0000545 } else if (lowerword == "reflect-unwrap-io-blocks") {
546 ReflectOptions |= EShReflectionUnwrapIOBlocks;
John Kessenich6263fb12017-06-14 15:52:44 -0600547 } else if (lowerword == "resource-set-bindings" || // synonyms
548 lowerword == "resource-set-binding" ||
549 lowerword == "rsb") {
550 ProcessResourceSetBindingBase(argc, argv, baseResourceSetBinding);
steve-lunarg9088be42016-11-01 10:31:42 -0600551 } else if (lowerword == "shift-image-bindings" || // synonyms
552 lowerword == "shift-image-binding" ||
553 lowerword == "sib") {
LoopDawg08a14422017-10-17 19:27:14 -0600554 ProcessBindingBase(argc, argv, glslang::EResImage);
John Kessenich6263fb12017-06-14 15:52:44 -0600555 } else if (lowerword == "shift-sampler-bindings" || // synonyms
John Kessenichade8bbb2018-08-12 21:24:55 -0600556 lowerword == "shift-sampler-binding" ||
557 lowerword == "ssb") {
LoopDawg08a14422017-10-17 19:27:14 -0600558 ProcessBindingBase(argc, argv, glslang::EResSampler);
John Kessenich6263fb12017-06-14 15:52:44 -0600559 } else if (lowerword == "shift-uav-bindings" || // synonyms
560 lowerword == "shift-uav-binding" ||
561 lowerword == "suavb") {
LoopDawg08a14422017-10-17 19:27:14 -0600562 ProcessBindingBase(argc, argv, glslang::EResUav);
John Kessenich6263fb12017-06-14 15:52:44 -0600563 } else if (lowerword == "shift-texture-bindings" || // synonyms
564 lowerword == "shift-texture-binding" ||
565 lowerword == "stb") {
LoopDawg08a14422017-10-17 19:27:14 -0600566 ProcessBindingBase(argc, argv, glslang::EResTexture);
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600567 } else if (lowerword == "shift-ubo-bindings" || // synonyms
568 lowerword == "shift-ubo-binding" ||
steve-lunargbe283552017-04-18 12:18:01 -0600569 lowerword == "shift-cbuffer-bindings" ||
570 lowerword == "shift-cbuffer-binding" ||
571 lowerword == "sub" ||
572 lowerword == "scb") {
LoopDawg08a14422017-10-17 19:27:14 -0600573 ProcessBindingBase(argc, argv, glslang::EResUbo);
steve-lunarg932bb5c2017-02-21 17:19:08 -0700574 } else if (lowerword == "shift-ssbo-bindings" || // synonyms
575 lowerword == "shift-ssbo-binding" ||
576 lowerword == "sbb") {
LoopDawg08a14422017-10-17 19:27:14 -0600577 ProcessBindingBase(argc, argv, glslang::EResSsbo);
John Kessenich6263fb12017-06-14 15:52:44 -0600578 } else if (lowerword == "source-entrypoint" || // synonyms
579 lowerword == "sep") {
John Kessenichc178f0a2017-06-23 10:58:31 -0600580 if (argc <= 1)
John Kessenich6263fb12017-06-14 15:52:44 -0600581 Error("no <entry-point> provided for --source-entrypoint");
John Kessenichc178f0a2017-06-23 10:58:31 -0600582 sourceEntryPointName = argv[1];
583 bumpArg();
John Kessenich6263fb12017-06-14 15:52:44 -0600584 break;
John Kesseniche2156222018-06-11 18:12:15 -0600585 } else if (lowerword == "spirv-dis") {
586 SpvToolsDisassembler = true;
John Kessenichc3404252018-08-23 15:29:08 -0600587 } else if (lowerword == "spirv-val") {
588 SpvToolsValidate = true;
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +0200589 } else if (lowerword == "stdin") {
590 Options |= EOptionStdin;
591 shaderStageName = argv[1];
John Kessenich2a271162017-07-20 20:00:36 -0600592 } else if (lowerword == "suppress-warnings") {
593 Options |= EOptionSuppressWarnings;
John Kessenich6353d552017-06-23 11:11:09 -0600594 } else if (lowerword == "target-env") {
595 if (argc > 1) {
596 if (strcmp(argv[1], "vulkan1.0") == 0) {
597 setVulkanSpv();
John Kessenich8717a5d2018-10-26 10:12:32 -0600598 ClientVersion = glslang::EShTargetVulkan_1_0;
John Kessenich66011cb2018-03-06 16:12:04 -0700599 } else if (strcmp(argv[1], "vulkan1.1") == 0) {
600 setVulkanSpv();
John Kessenich8717a5d2018-10-26 10:12:32 -0600601 ClientVersion = glslang::EShTargetVulkan_1_1;
John Kessenich6353d552017-06-23 11:11:09 -0600602 } else if (strcmp(argv[1], "opengl") == 0) {
603 setOpenGlSpv();
John Kessenich8717a5d2018-10-26 10:12:32 -0600604 ClientVersion = glslang::EShTargetOpenGL_450;
605 } else if (strcmp(argv[1], "spirv1.0") == 0) {
606 TargetLanguage = glslang::EShTargetSpv;
607 TargetVersion = glslang::EShTargetSpv_1_0;
608 } else if (strcmp(argv[1], "spirv1.1") == 0) {
609 TargetLanguage = glslang::EShTargetSpv;
610 TargetVersion = glslang::EShTargetSpv_1_1;
611 } else if (strcmp(argv[1], "spirv1.2") == 0) {
612 TargetLanguage = glslang::EShTargetSpv;
613 TargetVersion = glslang::EShTargetSpv_1_2;
614 } else if (strcmp(argv[1], "spirv1.3") == 0) {
615 TargetLanguage = glslang::EShTargetSpv;
616 TargetVersion = glslang::EShTargetSpv_1_3;
617 } else if (strcmp(argv[1], "spirv1.4") == 0) {
618 TargetLanguage = glslang::EShTargetSpv;
619 TargetVersion = glslang::EShTargetSpv_1_4;
John Kessenich6353d552017-06-23 11:11:09 -0600620 } else
John Kessenich8717a5d2018-10-26 10:12:32 -0600621 Error("--target-env expected one of: vulkan1.0, vulkan1.1, opengl, spirv1.0, spirv1.1, spirv1.2, or spirv1.3");
John Kessenich6353d552017-06-23 11:11:09 -0600622 }
623 bumpArg();
Flavio15017db2017-02-15 14:29:33 -0800624 } else if (lowerword == "variable-name" || // synonyms
John Kessenich66011cb2018-03-06 16:12:04 -0700625 lowerword == "vn") {
Flavio15017db2017-02-15 14:29:33 -0800626 Options |= EOptionOutputHexadecimal;
John Kessenichc178f0a2017-06-23 10:58:31 -0600627 if (argc <= 1)
Flavio15017db2017-02-15 14:29:33 -0800628 Error("no <C-variable-name> provided for --variable-name");
John Kessenichc178f0a2017-06-23 10:58:31 -0600629 variableName = argv[1];
630 bumpArg();
Flavio15017db2017-02-15 14:29:33 -0800631 break;
John Kessenichc6c80a62018-03-05 22:23:17 -0700632 } else if (lowerword == "version") {
633 Options |= EOptionDumpVersions;
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600634 } else {
635 usage();
636 }
637 }
638 break;
John Kessenich6263fb12017-06-14 15:52:44 -0600639 case 'C':
640 Options |= EOptionCascadingErrors;
641 break;
642 case 'D':
John Kessenicha9313662017-06-15 10:40:49 -0600643 if (argv[0][2] == 0)
644 Options |= EOptionReadHlsl;
645 else
646 UserPreamble.addDef(getStringOperand("-D<macro> macro name"));
John Kessenich6263fb12017-06-14 15:52:44 -0600647 break;
Neil Roberts16f53472018-03-20 17:30:53 +0100648 case 'u':
649 uniformLocationOverrides.push_back(getUniformOverride());
650 break;
John Kessenich6263fb12017-06-14 15:52:44 -0600651 case 'E':
652 Options |= EOptionOutputPreprocessed;
653 break;
654 case 'G':
John Kessenich8717a5d2018-10-26 10:12:32 -0600655 // OpenGL client
John Kessenich6353d552017-06-23 11:11:09 -0600656 setOpenGlSpv();
657 if (argv[0][2] != 0)
658 ClientInputSemanticsVersion = getAttachedNumber("-G<num> client input semantics");
John Kessenich6263fb12017-06-14 15:52:44 -0600659 break;
John Kessenich2aa7f3a2015-05-15 16:02:07 +0000660 case 'H':
661 Options |= EOptionHumanReadableSpv;
John Kessenich91e4aa52016-07-07 17:46:42 -0600662 if ((Options & EOptionSpv) == 0) {
663 // default to Vulkan
John Kessenich6353d552017-06-23 11:11:09 -0600664 setVulkanSpv();
John Kessenich91e4aa52016-07-07 17:46:42 -0600665 }
666 break;
John Kessenich971a0a82017-06-07 15:06:58 -0600667 case 'I':
John Kessenicha9313662017-06-15 10:40:49 -0600668 IncludeDirectoryList.push_back(getStringOperand("-I<dir> include path"));
John Kessenich68d78fd2015-07-12 19:28:10 -0600669 break;
GregFcd1f1692017-09-21 18:40:22 -0600670 case 'O':
671 if (argv[0][2] == 'd')
672 Options |= EOptionOptimizeDisable;
673 else if (argv[0][2] == 's')
GregFfb03a552018-03-29 11:49:14 -0600674#if ENABLE_OPT
GregFcd1f1692017-09-21 18:40:22 -0600675 Options |= EOptionOptimizeSize;
676#else
677 Error("-Os not available; optimizer not linked");
678#endif
679 else
680 Error("unknown -O option");
681 break;
Dan Baker5afdd782016-08-11 17:53:57 -0400682 case 'S':
John Kessenichc178f0a2017-06-23 10:58:31 -0600683 if (argc <= 1)
Dan Baker5afdd782016-08-11 17:53:57 -0400684 Error("no <stage> specified for -S");
John Kessenichc178f0a2017-06-23 10:58:31 -0600685 shaderStageName = argv[1];
686 bumpArg();
dankbaker45d49bc2016-08-08 21:43:07 -0400687 break;
John Kessenicha9313662017-06-15 10:40:49 -0600688 case 'U':
689 UserPreamble.addUndef(getStringOperand("-U<macro>: macro name"));
690 break;
John Kessenich6263fb12017-06-14 15:52:44 -0600691 case 'V':
John Kessenich6353d552017-06-23 11:11:09 -0600692 setVulkanSpv();
693 if (argv[0][2] != 0)
David Neto506d2c22018-02-27 21:55:23 -0500694 ClientInputSemanticsVersion = getAttachedNumber("-V<num> client input semantics");
John Kessenichc555ddd2015-06-17 02:38:44 +0000695 break;
John Kessenich05a70632013-09-17 19:26:08 +0000696 case 'c':
697 Options |= EOptionDumpConfig;
698 break;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000699 case 'd':
John Kessenichc6c80a62018-03-05 22:23:17 -0700700 if (strncmp(&argv[0][1], "dumpversion", strlen(&argv[0][1]) + 1) == 0 ||
701 strncmp(&argv[0][1], "dumpfullversion", strlen(&argv[0][1]) + 1) == 0)
702 Options |= EOptionDumpBareVersion;
703 else
704 Options |= EOptionDefaultDesktop;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000705 break;
John Kessenich4d65ee32016-03-12 18:17:47 -0700706 case 'e':
John Kessenich4d65ee32016-03-12 18:17:47 -0700707 entryPointName = argv[1];
John Kessenichc178f0a2017-06-23 10:58:31 -0600708 if (argc <= 1)
John Kessenicha25530c2017-09-11 20:13:49 -0600709 Error("no <name> provided for -e");
John Kessenichc178f0a2017-06-23 10:58:31 -0600710 bumpArg();
John Kessenich4d65ee32016-03-12 18:17:47 -0700711 break;
John Kessenich5d610ee2018-03-07 18:05:55 -0700712 case 'f':
713 if (strcmp(&argv[0][2], "hlsl_functionality1") == 0)
714 targetHlslFunctionality1 = true;
715 else
716 Error("-f: expected hlsl_functionality1");
717 break;
John Kessenich121853f2017-05-31 17:11:16 -0600718 case 'g':
719 Options |= EOptionDebug;
720 break;
John Kessenich68d78fd2015-07-12 19:28:10 -0600721 case 'h':
722 usage();
723 break;
John Kessenich05a70632013-09-17 19:26:08 +0000724 case 'i':
John Kessenich94a81fb2013-08-31 02:41:30 +0000725 Options |= EOptionIntermediate;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000726 break;
727 case 'l':
John Kessenichd78e3512014-08-25 20:07:55 +0000728 Options |= EOptionLinkProgram;
John Kessenich94a81fb2013-08-31 02:41:30 +0000729 break;
730 case 'm':
731 Options |= EOptionMemoryLeakMode;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000732 break;
John Kessenich68d78fd2015-07-12 19:28:10 -0600733 case 'o':
John Kessenichc178f0a2017-06-23 10:58:31 -0600734 if (argc <= 1)
John Kessenich68d78fd2015-07-12 19:28:10 -0600735 Error("no <file> provided for -o");
John Kessenichc178f0a2017-06-23 10:58:31 -0600736 binaryFileName = argv[1];
737 bumpArg();
John Kessenich68d78fd2015-07-12 19:28:10 -0600738 break;
John Kessenich11f9fc72013-11-07 01:06:34 +0000739 case 'q':
740 Options |= EOptionDumpReflection;
741 break;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000742 case 'r':
John Kessenich94a81fb2013-08-31 02:41:30 +0000743 Options |= EOptionRelaxedErrors;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000744 break;
745 case 's':
John Kessenich94a81fb2013-08-31 02:41:30 +0000746 Options |= EOptionSuppressInfolog;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000747 break;
John Kessenich38f3b892013-09-06 19:52:57 +0000748 case 't':
Juan Lopeza558b262017-04-02 23:04:00 +0200749 Options |= EOptionMultiThreaded;
John Kessenich38f3b892013-09-06 19:52:57 +0000750 break;
John Kessenich319de232013-12-04 04:43:40 +0000751 case 'v':
752 Options |= EOptionDumpVersions;
753 break;
John Kessenichb0a7eb52013-11-07 17:44:20 +0000754 case 'w':
755 Options |= EOptionSuppressWarnings;
756 break;
Johannes van Waverenecb0f3b2016-05-27 12:55:53 -0500757 case 'x':
758 Options |= EOptionOutputHexadecimal;
Johannes van Waverenecb0f3b2016-05-27 12:55:53 -0500759 break;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000760 default:
John Kessenich68d78fd2015-07-12 19:28:10 -0600761 usage();
762 break;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000763 }
John Kessenich38f3b892013-09-06 19:52:57 +0000764 } else {
John Kessenich05a70632013-09-17 19:26:08 +0000765 std::string name(argv[0]);
766 if (! SetConfigFile(name)) {
Juan Lopeza558b262017-04-02 23:04:00 +0200767 workItems.push_back(std::unique_ptr<glslang::TWorkItem>(new glslang::TWorkItem(name)));
John Kessenich05a70632013-09-17 19:26:08 +0000768 }
John Kessenich38f3b892013-09-06 19:52:57 +0000769 }
John Kessenich2b07c7e2013-07-31 18:44:13 +0000770 }
771
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +0200772 // Make sure that -S is always specified if --stdin is specified
773 if ((Options & EOptionStdin) && shaderStageName == nullptr)
774 Error("must provide -S when --stdin is given");
775
John Kessenich68d78fd2015-07-12 19:28:10 -0600776 // Make sure that -E is not specified alongside linking (which includes SPV generation)
John Kesseniche5c394b2019-07-02 09:32:48 -0600777 // Or things that require linking
778 if (Options & EOptionOutputPreprocessed) {
779 if (Options & EOptionLinkProgram)
780 Error("can't use -E when linking is selected");
781 if (Options & EOptionDumpReflection)
782 Error("reflection requires linking, which can't be used when -E when is selected");
783 }
784
785 // reflection requires linking
786 if ((Options & EOptionDumpReflection) && !(Options & EOptionLinkProgram))
787 Error("reflection requires -l for linking");
John Kessenichc555ddd2015-06-17 02:38:44 +0000788
Johannes van Waverenecb0f3b2016-05-27 12:55:53 -0500789 // -o or -x makes no sense if there is no target binary
John Kessenich68d78fd2015-07-12 19:28:10 -0600790 if (binaryFileName && (Options & EOptionSpv) == 0)
791 Error("no binary generation requested (e.g., -V)");
steve-lunarge0b9deb2016-09-16 13:26:37 -0600792
793 if ((Options & EOptionFlattenUniformArrays) != 0 &&
794 (Options & EOptionReadHlsl) == 0)
795 Error("uniform array flattening only valid when compiling HLSL source.");
John Kessenich8717a5d2018-10-26 10:12:32 -0600796
797 // rationalize client and target language
798 if (TargetLanguage == glslang::EShTargetNone) {
799 switch (ClientVersion) {
800 case glslang::EShTargetVulkan_1_0:
801 TargetLanguage = glslang::EShTargetSpv;
802 TargetVersion = glslang::EShTargetSpv_1_0;
803 break;
804 case glslang::EShTargetVulkan_1_1:
805 TargetLanguage = glslang::EShTargetSpv;
806 TargetVersion = glslang::EShTargetSpv_1_3;
807 break;
808 case glslang::EShTargetOpenGL_450:
809 TargetLanguage = glslang::EShTargetSpv;
810 TargetVersion = glslang::EShTargetSpv_1_0;
811 break;
812 default:
813 break;
814 }
815 }
816 if (TargetLanguage != glslang::EShTargetNone && Client == glslang::EShClientNone)
817 Error("To generate SPIR-V, also specify client semantics. See -G and -V.");
John Kessenich2b07c7e2013-07-31 18:44:13 +0000818}
819
John Kessenich68d78fd2015-07-12 19:28:10 -0600820//
821// Translate the meaningful subset of command-line options to parser-behavior options.
822//
John Kessenichb0a7eb52013-11-07 17:44:20 +0000823void SetMessageOptions(EShMessages& messages)
824{
825 if (Options & EOptionRelaxedErrors)
826 messages = (EShMessages)(messages | EShMsgRelaxedErrors);
827 if (Options & EOptionIntermediate)
828 messages = (EShMessages)(messages | EShMsgAST);
829 if (Options & EOptionSuppressWarnings)
830 messages = (EShMessages)(messages | EShMsgSuppressWarnings);
John Kessenich68d78fd2015-07-12 19:28:10 -0600831 if (Options & EOptionSpv)
832 messages = (EShMessages)(messages | EShMsgSpvRules);
833 if (Options & EOptionVulkanRules)
834 messages = (EShMessages)(messages | EShMsgVulkanRules);
Andrew Woloszynaae1ad82015-06-24 17:00:46 -0400835 if (Options & EOptionOutputPreprocessed)
836 messages = (EShMessages)(messages | EShMsgOnlyPreprocessor);
John Kessenich66e2faf2016-03-12 18:34:36 -0700837 if (Options & EOptionReadHlsl)
838 messages = (EShMessages)(messages | EShMsgReadHlsl);
John Kessenicha86836e2016-07-09 14:50:57 -0600839 if (Options & EOptionCascadingErrors)
840 messages = (EShMessages)(messages | EShMsgCascadingErrors);
John Kessenich906cc212016-12-09 19:22:20 -0700841 if (Options & EOptionKeepUncalled)
842 messages = (EShMessages)(messages | EShMsgKeepUncalled);
John Kessenich4f1403e2017-04-05 17:38:20 -0600843 if (Options & EOptionHlslOffsets)
844 messages = (EShMessages)(messages | EShMsgHlslOffsets);
John Kessenich121853f2017-05-31 17:11:16 -0600845 if (Options & EOptionDebug)
846 messages = (EShMessages)(messages | EShMsgDebugInfo);
Rex Xucb61eec2018-03-07 13:10:01 +0800847 if (HlslEnable16BitTypes)
848 messages = (EShMessages)(messages | EShMsgHlslEnable16BitTypes);
GregFfb03a552018-03-29 11:49:14 -0600849 if ((Options & EOptionOptimizeDisable) || !ENABLE_OPT)
850 messages = (EShMessages)(messages | EShMsgHlslLegalization);
John Kessenichbd1c1832018-12-07 18:38:26 -0700851 if (HlslDX9compatible)
852 messages = (EShMessages)(messages | EShMsgHlslDX9Compatible);
Christoph Kubisch55ba3ea2019-04-13 22:18:16 +0200853 if (DumpBuiltinSymbols)
854 messages = (EShMessages)(messages | EShMsgBuiltinSymbolTable);
John Kessenichb0a7eb52013-11-07 17:44:20 +0000855}
856
John Kessenich68d78fd2015-07-12 19:28:10 -0600857//
John Kessenich69f4b512013-09-04 21:19:27 +0000858// Thread entry point, for non-linking asynchronous mode.
John Kessenichc999ba22013-11-07 23:33:24 +0000859//
Juan Lopeza558b262017-04-02 23:04:00 +0200860void CompileShaders(glslang::TWorklist& worklist)
John Kessenich2b07c7e2013-07-31 18:44:13 +0000861{
John Kessenich7f0bcfd2018-04-05 19:00:01 -0600862 if (Options & EOptionDebug)
863 Error("cannot generate debug information unless linking to generate code");
864
John Kessenich38f3b892013-09-06 19:52:57 +0000865 glslang::TWorkItem* workItem;
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +0200866 if (Options & EOptionStdin) {
John Kesseniche7f9cae2018-07-12 15:11:07 -0600867 if (worklist.remove(workItem)) {
868 ShHandle compiler = ShConstructCompiler(FindLanguage("stdin"), Options);
869 if (compiler == nullptr)
870 return;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000871
John Kesseniche7f9cae2018-07-12 15:11:07 -0600872 CompileFile("stdin", compiler);
John Kessenich2b07c7e2013-07-31 18:44:13 +0000873
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +0200874 if (! (Options & EOptionSuppressInfolog))
875 workItem->results = ShGetInfoLog(compiler);
John Kessenich2b07c7e2013-07-31 18:44:13 +0000876
John Kesseniche7f9cae2018-07-12 15:11:07 -0600877 ShDestruct(compiler);
878 }
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +0200879 } else {
880 while (worklist.remove(workItem)) {
881 ShHandle compiler = ShConstructCompiler(FindLanguage(workItem->name), Options);
882 if (compiler == 0)
883 return;
884
885 CompileFile(workItem->name.c_str(), compiler);
886
887 if (! (Options & EOptionSuppressInfolog))
888 workItem->results = ShGetInfoLog(compiler);
889
890 ShDestruct(compiler);
891 }
John Kessenich2b07c7e2013-07-31 18:44:13 +0000892 }
John Kessenich2b07c7e2013-07-31 18:44:13 +0000893}
894
John Kessenich6626cad2015-06-19 05:14:19 +0000895// Outputs the given string, but only if it is non-null and non-empty.
896// This prevents erroneous newlines from appearing.
Andrew Woloszynaae1ad82015-06-24 17:00:46 -0400897void PutsIfNonEmpty(const char* str)
John Kessenich6626cad2015-06-19 05:14:19 +0000898{
899 if (str && str[0]) {
900 puts(str);
901 }
902}
903
Andrew Woloszynaae1ad82015-06-24 17:00:46 -0400904// Outputs the given string to stderr, but only if it is non-null and non-empty.
905// This prevents erroneous newlines from appearing.
906void StderrIfNonEmpty(const char* str)
907{
John Kessenich04acb1b2017-06-14 17:36:50 -0600908 if (str && str[0])
909 fprintf(stderr, "%s\n", str);
Andrew Woloszynaae1ad82015-06-24 17:00:46 -0400910}
911
John Kessenichc57b2a92016-01-16 15:30:03 -0700912// Simple bundling of what makes a compilation unit for ease in passing around,
913// and separation of handling file IO versus API (programmatic) compilation.
914struct ShaderCompUnit {
915 EShLanguage stage;
John Kessenich04acb1b2017-06-14 17:36:50 -0600916 static const int maxCount = 1;
917 int count; // live number of strings/names
John Kessenicha9313662017-06-15 10:40:49 -0600918 const char* text[maxCount]; // memory owned/managed externally
John Kessenich04acb1b2017-06-14 17:36:50 -0600919 std::string fileName[maxCount]; // hold's the memory, but...
920 const char* fileNameList[maxCount]; // downstream interface wants pointers
dankbakerafe6e9c2016-08-21 12:29:08 -0400921
John Kessenich04acb1b2017-06-14 17:36:50 -0600922 ShaderCompUnit(EShLanguage stage) : stage(stage), count(0) { }
dankbakerafe6e9c2016-08-21 12:29:08 -0400923
John Kessenich04acb1b2017-06-14 17:36:50 -0600924 ShaderCompUnit(const ShaderCompUnit& rhs)
dankbakerafe6e9c2016-08-21 12:29:08 -0400925 {
926 stage = rhs.stage;
John Kessenich04acb1b2017-06-14 17:36:50 -0600927 count = rhs.count;
928 for (int i = 0; i < count; ++i) {
929 fileName[i] = rhs.fileName[i];
930 text[i] = rhs.text[i];
931 fileNameList[i] = rhs.fileName[i].c_str();
932 }
dankbakerafe6e9c2016-08-21 12:29:08 -0400933 }
934
John Kessenicha9313662017-06-15 10:40:49 -0600935 void addString(std::string& ifileName, const char* itext)
John Kessenich04acb1b2017-06-14 17:36:50 -0600936 {
937 assert(count < maxCount);
938 fileName[count] = ifileName;
939 text[count] = itext;
940 fileNameList[count] = fileName[count].c_str();
941 ++count;
942 }
John Kessenichc57b2a92016-01-16 15:30:03 -0700943};
944
John Kessenich69f4b512013-09-04 21:19:27 +0000945//
John Kessenichc57b2a92016-01-16 15:30:03 -0700946// For linking mode: Will independently parse each compilation unit, but then put them
947// in the same program and link them together, making at most one linked module per
948// pipeline stage.
John Kessenich69f4b512013-09-04 21:19:27 +0000949//
950// Uses the new C++ interface instead of the old handle-based interface.
951//
John Kessenichc57b2a92016-01-16 15:30:03 -0700952
953void CompileAndLinkShaderUnits(std::vector<ShaderCompUnit> compUnits)
John Kessenich69f4b512013-09-04 21:19:27 +0000954{
955 // keep track of what to free
956 std::list<glslang::TShader*> shaders;
John Kessenichc57b2a92016-01-16 15:30:03 -0700957
John Kessenich69f4b512013-09-04 21:19:27 +0000958 EShMessages messages = EShMsgDefault;
John Kessenichb0a7eb52013-11-07 17:44:20 +0000959 SetMessageOptions(messages);
John Kessenich69f4b512013-09-04 21:19:27 +0000960
John Kessenich69f4b512013-09-04 21:19:27 +0000961 //
962 // Per-shader processing...
963 //
964
John Kessenich5b0f13a2013-11-01 03:08:40 +0000965 glslang::TProgram& program = *new glslang::TProgram;
rdb32084e82016-02-23 22:17:38 +0100966 for (auto it = compUnits.cbegin(); it != compUnits.cend(); ++it) {
967 const auto &compUnit = *it;
John Kessenichc57b2a92016-01-16 15:30:03 -0700968 glslang::TShader* shader = new glslang::TShader(compUnit.stage);
John Kessenich04acb1b2017-06-14 17:36:50 -0600969 shader->setStringsWithLengthsAndNames(compUnit.text, NULL, compUnit.fileNameList, compUnit.count);
John Kessenich640bd092018-08-09 14:15:00 -0600970 if (entryPointName)
John Kessenich4d65ee32016-03-12 18:17:47 -0700971 shader->setEntryPoint(entryPointName);
John Kessenich3693e632017-09-29 17:51:52 -0600972 if (sourceEntryPointName) {
973 if (entryPointName == nullptr)
974 printf("Warning: Changing source entry point name without setting an entry-point name.\n"
975 "Use '-e <name>'.\n");
steve-lunargf1e0c872016-10-31 15:13:43 -0600976 shader->setSourceEntryPoint(sourceEntryPointName);
John Kessenich3693e632017-09-29 17:51:52 -0600977 }
John Kessenicha9313662017-06-15 10:40:49 -0600978 if (UserPreamble.isSet())
979 shader->setPreamble(UserPreamble.get());
John Kessenich2a271162017-07-20 20:00:36 -0600980 shader->addProcesses(Processes);
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600981
LoopDawg08a14422017-10-17 19:27:14 -0600982 // Set IO mapper binding shift values
983 for (int r = 0; r < glslang::EResCount; ++r) {
984 const glslang::TResourceType res = glslang::TResourceType(r);
985
986 // Set base bindings
987 shader->setShiftBinding(res, baseBinding[res][compUnit.stage]);
988
989 // Set bindings for particular resource sets
990 // TODO: use a range based for loop here, when available in all environments.
991 for (auto i = baseBindingForSet[res][compUnit.stage].begin();
992 i != baseBindingForSet[res][compUnit.stage].end(); ++i)
LoopDawge5709552017-10-21 10:46:39 -0600993 shader->setShiftBindingForSet(res, i->second, i->first);
LoopDawg08a14422017-10-17 19:27:14 -0600994 }
995
steve-lunarge0b9deb2016-09-16 13:26:37 -0600996 shader->setFlattenUniformArrays((Options & EOptionFlattenUniformArrays) != 0);
steve-lunargcce8d482016-10-14 18:36:42 -0600997 shader->setNoStorageFormat((Options & EOptionNoStorageFormat) != 0);
John Kessenich605afc72019-06-17 23:33:09 -0600998 shader->setNanMinMaxClamp(NaNClamp);
Hyangran Park36dc8292017-05-02 16:27:29 +0900999 shader->setResourceSetBinding(baseResourceSetBinding[compUnit.stage]);
steve-lunarg7f7c2ed2016-09-07 15:20:19 -06001000
John Kessenichd4ed5152019-07-27 05:22:30 -06001001#ifdef ENABLE_HLSL
steve-lunargbe283552017-04-18 12:18:01 -06001002 if (Options & EOptionHlslIoMapping)
1003 shader->setHlslIoMapping(true);
John Kessenichd4ed5152019-07-27 05:22:30 -06001004#endif
steve-lunargbe283552017-04-18 12:18:01 -06001005
steve-lunarg7f7c2ed2016-09-07 15:20:19 -06001006 if (Options & EOptionAutoMapBindings)
1007 shader->setAutoMapBindings(true);
John Kessenichecba76f2017-01-06 00:34:48 -07001008
John Kessenich71facdf2017-05-17 18:28:19 -06001009 if (Options & EOptionAutoMapLocations)
1010 shader->setAutoMapLocations(true);
1011
LoopDawgb22c0692017-12-06 16:52:03 -07001012 if (Options & EOptionInvertY)
1013 shader->setInvertY(true);
1014
Neil Roberts16f53472018-03-20 17:30:53 +01001015 for (auto& uniOverride : uniformLocationOverrides) {
1016 shader->addUniformLocationOverride(uniOverride.first.c_str(),
1017 uniOverride.second);
1018 }
1019
Neil Robertsb0f3d792018-03-20 17:41:05 +01001020 shader->setUniformLocationBase(uniformBase);
1021
John Kessenich4be4aeb2017-06-23 10:50:22 -06001022 // Set up the environment, some subsettings take precedence over earlier
1023 // ways of setting things.
1024 if (Options & EOptionSpv) {
John Kessenich8717a5d2018-10-26 10:12:32 -06001025 shader->setEnvInput((Options & EOptionReadHlsl) ? glslang::EShSourceHlsl
1026 : glslang::EShSourceGlsl,
1027 compUnit.stage, Client, ClientInputSemanticsVersion);
1028 shader->setEnvClient(Client, ClientVersion);
1029 shader->setEnvTarget(TargetLanguage, TargetVersion);
John Kessenichd4ed5152019-07-27 05:22:30 -06001030#ifdef ENABLE_HLSL
John Kessenich5d610ee2018-03-07 18:05:55 -07001031 if (targetHlslFunctionality1)
1032 shader->setEnvTargetHlslFunctionality1();
John Kessenichd4ed5152019-07-27 05:22:30 -06001033#endif
John Kessenich4be4aeb2017-06-23 10:50:22 -06001034 }
1035
John Kessenich69f4b512013-09-04 21:19:27 +00001036 shaders.push_back(shader);
John Kessenichb3297152015-07-11 18:01:03 -06001037
John Kessenich4be4aeb2017-06-23 10:50:22 -06001038 const int defaultVersion = Options & EOptionDefaultDesktop ? 110 : 100;
John Kessenich69f4b512013-09-04 21:19:27 +00001039
John Kessenich3494b4d2017-05-22 15:00:42 -06001040 DirStackFileIncluder includer;
John Kessenich971a0a82017-06-07 15:06:58 -06001041 std::for_each(IncludeDirectoryList.rbegin(), IncludeDirectoryList.rend(), [&includer](const std::string& dir) {
1042 includer.pushExternalLocalDirectory(dir); });
John Kessenichc555ddd2015-06-17 02:38:44 +00001043 if (Options & EOptionOutputPreprocessed) {
1044 std::string str;
John Kessenich086febc2018-10-25 12:43:02 -06001045 if (shader->preprocess(&Resources, defaultVersion, ENoProfile, false, false, messages, &str, includer)) {
Andrew Woloszynaae1ad82015-06-24 17:00:46 -04001046 PutsIfNonEmpty(str.c_str());
1047 } else {
1048 CompileFailed = true;
1049 }
1050 StderrIfNonEmpty(shader->getInfoLog());
1051 StderrIfNonEmpty(shader->getInfoDebugLog());
John Kessenichc555ddd2015-06-17 02:38:44 +00001052 continue;
1053 }
John Kessenich086febc2018-10-25 12:43:02 -06001054
John Kessenich3494b4d2017-05-22 15:00:42 -06001055 if (! shader->parse(&Resources, defaultVersion, false, messages, includer))
John Kessenichc999ba22013-11-07 23:33:24 +00001056 CompileFailed = true;
John Kessenichc555ddd2015-06-17 02:38:44 +00001057
John Kessenich69f4b512013-09-04 21:19:27 +00001058 program.addShader(shader);
1059
John Kessenichc57b2a92016-01-16 15:30:03 -07001060 if (! (Options & EOptionSuppressInfolog) &&
1061 ! (Options & EOptionMemoryLeakMode)) {
John Kessenich04acb1b2017-06-14 17:36:50 -06001062 PutsIfNonEmpty(compUnit.fileName[0].c_str());
Andrew Woloszynaae1ad82015-06-24 17:00:46 -04001063 PutsIfNonEmpty(shader->getInfoLog());
1064 PutsIfNonEmpty(shader->getInfoDebugLog());
John Kessenich69f4b512013-09-04 21:19:27 +00001065 }
John Kessenich69f4b512013-09-04 21:19:27 +00001066 }
1067
1068 //
1069 // Program-level processing...
1070 //
1071
John Kessenich4d65ee32016-03-12 18:17:47 -07001072 // Link
John Kessenich68d78fd2015-07-12 19:28:10 -06001073 if (! (Options & EOptionOutputPreprocessed) && ! program.link(messages))
John Kessenichc999ba22013-11-07 23:33:24 +00001074 LinkFailed = true;
1075
steve-lunarg9ae34742016-10-05 13:40:13 -06001076 // Map IO
1077 if (Options & EOptionSpv) {
1078 if (!program.mapIO())
1079 LinkFailed = true;
1080 }
John Kessenichecba76f2017-01-06 00:34:48 -07001081
John Kessenich4d65ee32016-03-12 18:17:47 -07001082 // Report
John Kessenichc57b2a92016-01-16 15:30:03 -07001083 if (! (Options & EOptionSuppressInfolog) &&
1084 ! (Options & EOptionMemoryLeakMode)) {
Andrew Woloszynaae1ad82015-06-24 17:00:46 -04001085 PutsIfNonEmpty(program.getInfoLog());
1086 PutsIfNonEmpty(program.getInfoDebugLog());
John Kessenich69f4b512013-09-04 21:19:27 +00001087 }
1088
John Kessenich4d65ee32016-03-12 18:17:47 -07001089 // Reflect
John Kessenich11f9fc72013-11-07 01:06:34 +00001090 if (Options & EOptionDumpReflection) {
baldurk6d477852019-01-29 15:45:56 +00001091 program.buildReflection(ReflectOptions);
John Kessenich11f9fc72013-11-07 01:06:34 +00001092 program.dumpReflection();
1093 }
1094
John Kessenich4d65ee32016-03-12 18:17:47 -07001095 // Dump SPIR-V
John Kessenich0df0cde2015-03-03 17:09:43 +00001096 if (Options & EOptionSpv) {
John Kessenich92f90382014-07-28 04:21:04 +00001097 if (CompileFailed || LinkFailed)
John Kessenich68d78fd2015-07-12 19:28:10 -06001098 printf("SPIR-V is not generated for failed compile or link\n");
John Kessenich92f90382014-07-28 04:21:04 +00001099 else {
1100 for (int stage = 0; stage < EShLangCount; ++stage) {
John Kessenicha7a68a92014-08-24 18:21:00 +00001101 if (program.getIntermediate((EShLanguage)stage)) {
John Kessenich0df0cde2015-03-03 17:09:43 +00001102 std::vector<unsigned int> spirv;
Lei Zhang09caf122016-05-02 18:11:54 -04001103 std::string warningsErrors;
Lei Zhang17535f72016-05-04 15:55:59 -04001104 spv::SpvBuildLogger logger;
John Kessenich121853f2017-05-31 17:11:16 -06001105 glslang::SpvOptions spvOptions;
1106 if (Options & EOptionDebug)
1107 spvOptions.generateDebugInfo = true;
GregF52fe3d52017-09-28 10:08:32 -06001108 spvOptions.disableOptimizer = (Options & EOptionOptimizeDisable) != 0;
1109 spvOptions.optimizeSize = (Options & EOptionOptimizeSize) != 0;
John Kessenich717c80a2018-08-23 15:17:10 -06001110 spvOptions.disassemble = SpvToolsDisassembler;
John Kessenichc3404252018-08-23 15:29:08 -06001111 spvOptions.validate = SpvToolsValidate;
John Kessenich121853f2017-05-31 17:11:16 -06001112 glslang::GlslangToSpv(*program.getIntermediate((EShLanguage)stage), spirv, &logger, &spvOptions);
John Kessenichc57b2a92016-01-16 15:30:03 -07001113
1114 // Dump the spv to a file or stdout, etc., but only if not doing
1115 // memory/perf testing, as it's not internal to programmatic use.
1116 if (! (Options & EOptionMemoryLeakMode)) {
Johannes van Waverenecb0f3b2016-05-27 12:55:53 -05001117 printf("%s", logger.getAllMessages().c_str());
1118 if (Options & EOptionOutputHexadecimal) {
John Kessenich8f674e82017-02-18 09:45:40 -07001119 glslang::OutputSpvHex(spirv, GetBinaryName((EShLanguage)stage), variableName);
Johannes van Waverenecb0f3b2016-05-27 12:55:53 -05001120 } else {
1121 glslang::OutputSpvBin(spirv, GetBinaryName((EShLanguage)stage));
1122 }
John Kessenich23d27752019-07-28 02:12:10 -06001123#ifndef GLSLANG_WEB
John Kesseniche2156222018-06-11 18:12:15 -06001124 if (!SpvToolsDisassembler && (Options & EOptionHumanReadableSpv))
John Kessenichc57b2a92016-01-16 15:30:03 -07001125 spv::Disassemble(std::cout, spirv);
John Kessenich23d27752019-07-28 02:12:10 -06001126#endif
John Kessenichacba7722015-03-04 03:48:38 +00001127 }
John Kessenicha7a68a92014-08-24 18:21:00 +00001128 }
John Kessenich92f90382014-07-28 04:21:04 +00001129 }
1130 }
1131 }
1132
John Kessenich5b0f13a2013-11-01 03:08:40 +00001133 // Free everything up, program has to go before the shaders
1134 // because it might have merged stuff from the shaders, and
1135 // the stuff from the shaders has to have its destructors called
1136 // before the pools holding the memory in the shaders is freed.
1137 delete &program;
John Kessenich69f4b512013-09-04 21:19:27 +00001138 while (shaders.size() > 0) {
1139 delete shaders.back();
1140 shaders.pop_back();
1141 }
John Kessenich69f4b512013-09-04 21:19:27 +00001142}
1143
John Kessenichc57b2a92016-01-16 15:30:03 -07001144//
1145// Do file IO part of compile and link, handing off the pure
1146// API/programmatic mode to CompileAndLinkShaderUnits(), which can
1147// be put in a loop for testing memory footprint and performance.
1148//
1149// This is just for linking mode: meaning all the shaders will be put into the
1150// the same program linked together.
1151//
1152// This means there are a limited number of work items (not multi-threading mode)
1153// and that the point is testing at the linking level. Hence, to enable
1154// performance and memory testing, the actual compile/link can be put in
1155// a loop, independent of processing the work items and file IO.
1156//
Juan Lopeza558b262017-04-02 23:04:00 +02001157void CompileAndLinkShaderFiles(glslang::TWorklist& Worklist)
John Kessenichc57b2a92016-01-16 15:30:03 -07001158{
1159 std::vector<ShaderCompUnit> compUnits;
1160
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001161 // If this is using stdin, we can't really detect multiple different file
1162 // units by input type. We need to assume that we're just being given one
1163 // file of a certain type.
1164 if ((Options & EOptionStdin) != 0) {
1165 ShaderCompUnit compUnit(FindLanguage("stdin"));
1166 std::istreambuf_iterator<char> begin(std::cin), end;
1167 std::string tempString(begin, end);
1168 char* fileText = strdup(tempString.c_str());
1169 std::string fileName = "stdin";
1170 compUnit.addString(fileName, fileText);
John Kessenichc57b2a92016-01-16 15:30:03 -07001171 compUnits.push_back(compUnit);
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001172 } else {
1173 // Transfer all the work items from to a simple list of
1174 // of compilation units. (We don't care about the thread
1175 // work-item distribution properties in this path, which
1176 // is okay due to the limited number of shaders, know since
1177 // they are all getting linked together.)
1178 glslang::TWorkItem* workItem;
1179 while (Worklist.remove(workItem)) {
1180 ShaderCompUnit compUnit(FindLanguage(workItem->name));
1181 char* fileText = ReadFileData(workItem->name.c_str());
1182 if (fileText == nullptr)
1183 usage();
1184 compUnit.addString(workItem->name, fileText);
1185 compUnits.push_back(compUnit);
1186 }
John Kessenichc57b2a92016-01-16 15:30:03 -07001187 }
1188
1189 // Actual call to programmatic processing of compile and link,
1190 // in a loop for testing memory and performance. This part contains
1191 // all the perf/memory that a programmatic consumer will care about.
1192 for (int i = 0; i < ((Options & EOptionMemoryLeakMode) ? 100 : 1); ++i) {
1193 for (int j = 0; j < ((Options & EOptionMemoryLeakMode) ? 100 : 1); ++j)
1194 CompileAndLinkShaderUnits(compUnits);
1195
1196 if (Options & EOptionMemoryLeakMode)
1197 glslang::OS_DumpMemoryCounters();
1198 }
1199
John Kessenicha9313662017-06-15 10:40:49 -06001200 // free memory from ReadFileData, which got stored in a const char*
1201 // as the first string above
rdb32084e82016-02-23 22:17:38 +01001202 for (auto it = compUnits.begin(); it != compUnits.end(); ++it)
John Kessenicha9313662017-06-15 10:40:49 -06001203 FreeFileData(const_cast<char*>(it->text[0]));
John Kessenichc57b2a92016-01-16 15:30:03 -07001204}
1205
John Kessenich94f28eb2017-11-13 01:32:06 -07001206int singleMain()
John Kessenicha0af4732012-12-12 21:15:54 +00001207{
Juan Lopeza558b262017-04-02 23:04:00 +02001208 glslang::TWorklist workList;
John Kessenich94f28eb2017-11-13 01:32:06 -07001209 std::for_each(WorkItems.begin(), WorkItems.end(), [&workList](std::unique_ptr<glslang::TWorkItem>& item) {
Juan Lopeza558b262017-04-02 23:04:00 +02001210 assert(item);
1211 workList.add(item.get());
1212 });
John Kessenich2b07c7e2013-07-31 18:44:13 +00001213
John Kessenich23d27752019-07-28 02:12:10 -06001214#ifndef GLSLANG_WEB
John Kessenich05a70632013-09-17 19:26:08 +00001215 if (Options & EOptionDumpConfig) {
Lei Zhang414eb602016-03-04 16:22:34 -05001216 printf("%s", glslang::GetDefaultTBuiltInResourceString().c_str());
Juan Lopeza558b262017-04-02 23:04:00 +02001217 if (workList.empty())
John Kessenich05a70632013-09-17 19:26:08 +00001218 return ESuccess;
1219 }
John Kessenich23d27752019-07-28 02:12:10 -06001220#endif
John Kessenich05a70632013-09-17 19:26:08 +00001221
John Kessenichc6c80a62018-03-05 22:23:17 -07001222 if (Options & EOptionDumpBareVersion) {
1223 printf("%d.%d.%d\n",
1224 glslang::GetSpirvGeneratorVersion(), GLSLANG_MINOR_VERSION, GLSLANG_PATCH_LEVEL);
1225 if (workList.empty())
1226 return ESuccess;
1227 } else if (Options & EOptionDumpVersions) {
1228 printf("Glslang Version: %d.%d.%d\n",
1229 glslang::GetSpirvGeneratorVersion(), GLSLANG_MINOR_VERSION, GLSLANG_PATCH_LEVEL);
John Kessenich319de232013-12-04 04:43:40 +00001230 printf("ESSL Version: %s\n", glslang::GetEsslVersionString());
1231 printf("GLSL Version: %s\n", glslang::GetGlslVersionString());
John Kessenich68d78fd2015-07-12 19:28:10 -06001232 std::string spirvVersion;
1233 glslang::GetSpirvVersion(spirvVersion);
John Kessenich0da9eaa2015-08-01 17:10:02 -06001234 printf("SPIR-V Version %s\n", spirvVersion.c_str());
John Kessenich5e4b1242015-08-06 22:53:06 -06001235 printf("GLSL.std.450 Version %d, Revision %d\n", GLSLstd450Version, GLSLstd450Revision);
John Kessenich55e7d112015-11-15 21:33:39 -07001236 printf("Khronos Tool ID %d\n", glslang::GetKhronosToolId());
John Kessenicha372a3e2017-11-02 22:32:14 -06001237 printf("SPIR-V Generator Version %d\n", glslang::GetSpirvGeneratorVersion());
John Kessenichb84313d2016-07-20 16:03:29 -06001238 printf("GL_KHR_vulkan_glsl version %d\n", 100);
1239 printf("ARB_GL_gl_spirv version %d\n", 100);
Juan Lopeza558b262017-04-02 23:04:00 +02001240 if (workList.empty())
John Kessenich319de232013-12-04 04:43:40 +00001241 return ESuccess;
1242 }
1243
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001244 if (workList.empty() && ((Options & EOptionStdin) == 0)) {
John Kessenich05a70632013-09-17 19:26:08 +00001245 usage();
John Kessenich05a70632013-09-17 19:26:08 +00001246 }
1247
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001248 if (Options & EOptionStdin) {
John Kessenich94f28eb2017-11-13 01:32:06 -07001249 WorkItems.push_back(std::unique_ptr<glslang::TWorkItem>{new glslang::TWorkItem("stdin")});
1250 workList.add(WorkItems.back().get());
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001251 }
1252
John Kessenich05a70632013-09-17 19:26:08 +00001253 ProcessConfigFile();
1254
John Kessenich086febc2018-10-25 12:43:02 -06001255 if ((Options & EOptionReadHlsl) && !((Options & EOptionOutputPreprocessed) || (Options & EOptionSpv)))
1256 Error("ERROR: HLSL requires SPIR-V code generation (or preprocessing only)");
1257
John Kessenich69f4b512013-09-04 21:19:27 +00001258 //
1259 // Two modes:
John Kessenich38f3b892013-09-06 19:52:57 +00001260 // 1) linking all arguments together, single-threaded, new C++ interface
1261 // 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 +00001262 //
John Kessenich086febc2018-10-25 12:43:02 -06001263 if (Options & (EOptionLinkProgram | EOptionOutputPreprocessed)) {
John Kessenichc36e1d82013-11-01 17:41:52 +00001264 glslang::InitializeProcess();
John Kesseniche2c15b42017-11-16 22:48:41 -07001265 glslang::InitializeProcess(); // also test reference counting of users
1266 glslang::InitializeProcess(); // also test reference counting of users
1267 glslang::FinalizeProcess(); // also test reference counting of users
1268 glslang::FinalizeProcess(); // also test reference counting of users
Juan Lopeza558b262017-04-02 23:04:00 +02001269 CompileAndLinkShaderFiles(workList);
John Kessenichc36e1d82013-11-01 17:41:52 +00001270 glslang::FinalizeProcess();
1271 } else {
1272 ShInitialize();
John Kesseniche2c15b42017-11-16 22:48:41 -07001273 ShInitialize(); // also test reference counting of users
1274 ShFinalize(); // also test reference counting of users
John Kessenichc36e1d82013-11-01 17:41:52 +00001275
Juan Lopeza558b262017-04-02 23:04:00 +02001276 bool printShaderNames = workList.size() > 1;
John Kessenich69f4b512013-09-04 21:19:27 +00001277
John Kesseniche2c15b42017-11-16 22:48:41 -07001278 if (Options & EOptionMultiThreaded) {
Juan Lopeza558b262017-04-02 23:04:00 +02001279 std::array<std::thread, 16> threads;
John Kesseniche2c15b42017-11-16 22:48:41 -07001280 for (unsigned int t = 0; t < threads.size(); ++t) {
Juan Lopeza558b262017-04-02 23:04:00 +02001281 threads[t] = std::thread(CompileShaders, std::ref(workList));
John Kesseniche2c15b42017-11-16 22:48:41 -07001282 if (threads[t].get_id() == std::thread::id()) {
John Kessenichaf527992017-11-02 22:48:15 -06001283 fprintf(stderr, "Failed to create thread\n");
John Kessenich38f3b892013-09-06 19:52:57 +00001284 return EFailThreadCreate;
1285 }
John Kessenicha0af4732012-12-12 21:15:54 +00001286 }
Juan Lopeza558b262017-04-02 23:04:00 +02001287
1288 std::for_each(threads.begin(), threads.end(), [](std::thread& t) { t.join(); });
John Kessenichc999ba22013-11-07 23:33:24 +00001289 } else
Juan Lopeza558b262017-04-02 23:04:00 +02001290 CompileShaders(workList);
John Kessenich38f3b892013-09-06 19:52:57 +00001291
1292 // Print out all the resulting infologs
John Kessenich94f28eb2017-11-13 01:32:06 -07001293 for (size_t w = 0; w < WorkItems.size(); ++w) {
1294 if (WorkItems[w]) {
1295 if (printShaderNames || WorkItems[w]->results.size() > 0)
1296 PutsIfNonEmpty(WorkItems[w]->name.c_str());
1297 PutsIfNonEmpty(WorkItems[w]->results.c_str());
John Kessenich38f3b892013-09-06 19:52:57 +00001298 }
1299 }
John Kessenichc36e1d82013-11-01 17:41:52 +00001300
1301 ShFinalize();
John Kessenicha0af4732012-12-12 21:15:54 +00001302 }
John Kessenich2b07c7e2013-07-31 18:44:13 +00001303
John Kessenichc999ba22013-11-07 23:33:24 +00001304 if (CompileFailed)
John Kessenicha0af4732012-12-12 21:15:54 +00001305 return EFailCompile;
John Kessenichc999ba22013-11-07 23:33:24 +00001306 if (LinkFailed)
John Kessenicha0af4732012-12-12 21:15:54 +00001307 return EFailLink;
1308
1309 return 0;
1310}
1311
John Kessenich94f28eb2017-11-13 01:32:06 -07001312int C_DECL main(int argc, char* argv[])
1313{
1314 ProcessArguments(WorkItems, argc, argv);
1315
1316 int ret = 0;
1317
1318 // Loop over the entire init/finalize cycle to watch memory changes
1319 const int iterations = 1;
1320 if (iterations > 1)
1321 glslang::OS_DumpMemoryCounters();
1322 for (int i = 0; i < iterations; ++i) {
1323 ret = singleMain();
1324 if (iterations > 1)
1325 glslang::OS_DumpMemoryCounters();
1326 }
1327
1328 return ret;
1329}
1330
John Kessenicha0af4732012-12-12 21:15:54 +00001331//
1332// Deduce the language from the filename. Files must end in one of the
1333// following extensions:
1334//
John Kessenich2b07c7e2013-07-31 18:44:13 +00001335// .vert = vertex
1336// .tesc = tessellation control
1337// .tese = tessellation evaluation
1338// .geom = geometry
1339// .frag = fragment
John Kessenich94a81fb2013-08-31 02:41:30 +00001340// .comp = compute
Chao Chenb50c02e2018-09-19 11:42:24 -07001341// .rgen = ray generation
1342// .rint = ray intersection
1343// .rahit = ray any hit
1344// .rchit = ray closest hit
1345// .rmiss = ray miss
1346// .rcall = ray callable
Sahil Parmar035cbbe2018-10-04 16:39:18 -07001347// .mesh = mesh
1348// .task = task
Grigory Dzhavadyan33507412018-04-12 14:35:24 -07001349// Additionally, the file names may end in .<stage>.glsl and .<stage>.hlsl
1350// where <stage> is one of the stages listed above.
1351//
1352EShLanguage FindLanguage(const std::string& name, bool parseStageName)
John Kessenicha0af4732012-12-12 21:15:54 +00001353{
John Kessenichfccbb8b2018-04-17 17:24:03 -06001354 std::string stageName;
Dan Bakerc6ede892016-08-11 14:06:06 -04001355 if (shaderStageName)
John Kessenichfccbb8b2018-04-17 17:24:03 -06001356 stageName = shaderStageName;
1357 else if (parseStageName) {
Grigory Dzhavadyan33507412018-04-12 14:35:24 -07001358 // Note: "first" extension means "first from the end", i.e.
1359 // if the file is named foo.vert.glsl, then "glsl" is first,
1360 // "vert" is second.
John Kessenichfccbb8b2018-04-17 17:24:03 -06001361 size_t firstExtStart = name.find_last_of(".");
1362 bool hasFirstExt = firstExtStart != std::string::npos;
1363 size_t secondExtStart = hasFirstExt ? name.find_last_of(".", firstExtStart - 1) : std::string::npos;
1364 bool hasSecondExt = secondExtStart != std::string::npos;
1365 std::string firstExt = name.substr(firstExtStart + 1, std::string::npos);
1366 bool usesUnifiedExt = hasFirstExt && (firstExt == "glsl" || firstExt == "hlsl");
John Kessenich3beac942018-04-17 21:02:19 -06001367 if (usesUnifiedExt && firstExt == "hlsl")
1368 Options |= EOptionReadHlsl;
1369 if (hasFirstExt && !usesUnifiedExt)
John Kessenichfccbb8b2018-04-17 17:24:03 -06001370 stageName = firstExt;
John Kessenich3beac942018-04-17 21:02:19 -06001371 else if (usesUnifiedExt && hasSecondExt)
John Kessenichfccbb8b2018-04-17 17:24:03 -06001372 stageName = name.substr(secondExtStart + 1, firstExtStart - secondExtStart - 1);
John Kessenich3beac942018-04-17 21:02:19 -06001373 else {
Grigory Dzhavadyan33507412018-04-12 14:35:24 -07001374 usage();
1375 return EShLangVertex;
John Kesseniche751bca2017-03-16 11:20:38 -06001376 }
John Kessenichfccbb8b2018-04-17 17:24:03 -06001377 } else
1378 stageName = name;
dankbaker45d49bc2016-08-08 21:43:07 -04001379
John Kessenichfccbb8b2018-04-17 17:24:03 -06001380 if (stageName == "vert")
John Kessenich2b07c7e2013-07-31 18:44:13 +00001381 return EShLangVertex;
John Kessenichfccbb8b2018-04-17 17:24:03 -06001382 else if (stageName == "tesc")
John Kessenich2b07c7e2013-07-31 18:44:13 +00001383 return EShLangTessControl;
John Kessenichfccbb8b2018-04-17 17:24:03 -06001384 else if (stageName == "tese")
John Kessenich2b07c7e2013-07-31 18:44:13 +00001385 return EShLangTessEvaluation;
John Kessenichfccbb8b2018-04-17 17:24:03 -06001386 else if (stageName == "geom")
John Kessenich2b07c7e2013-07-31 18:44:13 +00001387 return EShLangGeometry;
John Kessenichfccbb8b2018-04-17 17:24:03 -06001388 else if (stageName == "frag")
John Kessenich2b07c7e2013-07-31 18:44:13 +00001389 return EShLangFragment;
John Kessenichfccbb8b2018-04-17 17:24:03 -06001390 else if (stageName == "comp")
John Kessenichc0275792013-08-09 17:14:49 +00001391 return EShLangCompute;
Chao Chen3c366992018-09-19 11:41:59 -07001392#ifdef NV_EXTENSIONS
Chao Chenb50c02e2018-09-19 11:42:24 -07001393 else if (stageName == "rgen")
1394 return EShLangRayGenNV;
1395 else if (stageName == "rint")
1396 return EShLangIntersectNV;
1397 else if (stageName == "rahit")
1398 return EShLangAnyHitNV;
1399 else if (stageName == "rchit")
1400 return EShLangClosestHitNV;
1401 else if (stageName == "rmiss")
1402 return EShLangMissNV;
1403 else if (stageName == "rcall")
1404 return EShLangCallableNV;
Chao Chen3c366992018-09-19 11:41:59 -07001405 else if (stageName == "mesh")
1406 return EShLangMeshNV;
1407 else if (stageName == "task")
1408 return EShLangTaskNV;
1409#endif
John Kessenich2b07c7e2013-07-31 18:44:13 +00001410
1411 usage();
John Kesseniche95ecc52012-12-12 21:34:14 +00001412 return EShLangVertex;
John Kessenicha0af4732012-12-12 21:15:54 +00001413}
1414
John Kessenicha0af4732012-12-12 21:15:54 +00001415//
John Kessenichecba76f2017-01-06 00:34:48 -07001416// Read a file's data into a string, and compile it using the old interface ShCompile,
John Kessenich69f4b512013-09-04 21:19:27 +00001417// for non-linkable results.
John Kessenicha0af4732012-12-12 21:15:54 +00001418//
John Kessenich51cdd902014-02-18 23:37:57 +00001419void CompileFile(const char* fileName, ShHandle compiler)
John Kessenicha0af4732012-12-12 21:15:54 +00001420{
John Kessenichca3457f2015-05-18 01:59:45 +00001421 int ret = 0;
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001422 char* shaderString;
1423 if ((Options & EOptionStdin) != 0) {
1424 std::istreambuf_iterator<char> begin(std::cin), end;
1425 std::string tempString(begin, end);
1426 shaderString = strdup(tempString.c_str());
1427 } else {
1428 shaderString = ReadFileData(fileName);
1429 }
John Kessenich41cf6b52013-06-25 18:10:05 +00001430
1431 // move to length-based strings, rather than null-terminated strings
John Kessenich04acb1b2017-06-14 17:36:50 -06001432 int* lengths = new int[1];
1433 lengths[0] = (int)strlen(shaderString);
John Kessenicha0af4732012-12-12 21:15:54 +00001434
John Kessenich52ac67e2013-05-05 23:46:22 +00001435 EShMessages messages = EShMsgDefault;
John Kessenichb0a7eb52013-11-07 17:44:20 +00001436 SetMessageOptions(messages);
John Kessenichecba76f2017-01-06 00:34:48 -07001437
John Kessenicha9313662017-06-15 10:40:49 -06001438 if (UserPreamble.isSet())
1439 Error("-D and -U options require -l (linking)\n");
1440
John Kessenich94a81fb2013-08-31 02:41:30 +00001441 for (int i = 0; i < ((Options & EOptionMemoryLeakMode) ? 100 : 1); ++i) {
1442 for (int j = 0; j < ((Options & EOptionMemoryLeakMode) ? 100 : 1); ++j) {
John Kessenich927608b2017-01-06 12:34:14 -07001443 // ret = ShCompile(compiler, shaderStrings, NumShaderStrings, lengths, EShOptNone, &Resources, Options, (Options & EOptionDefaultDesktop) ? 110 : 100, false, messages);
John Kessenich04acb1b2017-06-14 17:36:50 -06001444 ret = ShCompile(compiler, &shaderString, 1, nullptr, EShOptNone, &Resources, Options, (Options & EOptionDefaultDesktop) ? 110 : 100, false, messages);
John Kessenich927608b2017-01-06 12:34:14 -07001445 // const char* multi[12] = { "# ve", "rsion", " 300 e", "s", "\n#err",
John Kessenichecba76f2017-01-06 00:34:48 -07001446 // "or should be l", "ine 1", "string 5\n", "float glo", "bal",
John Kessenichea869fb2013-10-28 18:12:06 +00001447 // ";\n#error should be line 2\n void main() {", "global = 2.3;}" };
John Kessenich927608b2017-01-06 12:34:14 -07001448 // const char* multi[7] = { "/", "/", "\\", "\n", "\n", "#", "version 300 es" };
1449 // ret = ShCompile(compiler, multi, 7, nullptr, EShOptNone, &Resources, Options, (Options & EOptionDefaultDesktop) ? 110 : 100, false, messages);
John Kessenich41cf6b52013-06-25 18:10:05 +00001450 }
John Kessenicha0af4732012-12-12 21:15:54 +00001451
John Kessenich94a81fb2013-08-31 02:41:30 +00001452 if (Options & EOptionMemoryLeakMode)
John Kessenich2b07c7e2013-07-31 18:44:13 +00001453 glslang::OS_DumpMemoryCounters();
John Kessenicha0af4732012-12-12 21:15:54 +00001454 }
John Kessenicha0af4732012-12-12 21:15:54 +00001455
John Kessenich41cf6b52013-06-25 18:10:05 +00001456 delete [] lengths;
John Kessenich04acb1b2017-06-14 17:36:50 -06001457 FreeFileData(shaderString);
John Kessenicha0af4732012-12-12 21:15:54 +00001458
John Kessenichc999ba22013-11-07 23:33:24 +00001459 if (ret == 0)
1460 CompileFailed = true;
John Kessenicha0af4732012-12-12 21:15:54 +00001461}
1462
John Kessenicha0af4732012-12-12 21:15:54 +00001463//
1464// print usage to stdout
1465//
1466void usage()
1467{
John Kessenich319de232013-12-04 04:43:40 +00001468 printf("Usage: glslangValidator [option]... [file]...\n"
1469 "\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001470 "'file' can end in .<stage> for auto-stage classification, where <stage> is:\n"
1471 " .conf to provide a config file that replaces the default configuration\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001472 " (see -c option below for generating a template)\n"
1473 " .vert for a vertex shader\n"
1474 " .tesc for a tessellation control shader\n"
1475 " .tese for a tessellation evaluation shader\n"
1476 " .geom for a geometry shader\n"
1477 " .frag for a fragment shader\n"
1478 " .comp for a compute shader\n"
Chao Chen3c366992018-09-19 11:41:59 -07001479#ifdef NV_EXTENSIONS
1480 " .mesh for a mesh shader\n"
1481 " .task for a task shader\n"
Chao Chenb50c02e2018-09-19 11:42:24 -07001482 " .rgen for a ray generation shader\n"
1483 " .rint for a ray intersection shader\n"
1484 " .rahit for a ray any hit shader\n"
1485 " .rchit for a ray closest hit shader\n"
1486 " .rmiss for a ray miss shader\n"
Sahil Parmar035cbbe2018-10-04 16:39:18 -07001487 " .rcall for a ray callable shader\n"
Chao Chen3c366992018-09-19 11:41:59 -07001488#endif
John Kessenich2ead40f2018-04-17 17:44:11 -06001489 " .glsl for .vert.glsl, .tesc.glsl, ..., .comp.glsl compound suffixes\n"
1490 " .hlsl for .vert.hlsl, .tesc.hlsl, ..., .comp.hlsl compound suffixes\n"
John Kessenich319de232013-12-04 04:43:40 +00001491 "\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001492 "Options:\n"
1493 " -C cascading errors; risk crash from accumulation of error recoveries\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001494 " -D input is HLSL (this is the default when any suffix is .hlsl)\n"
John Kessenicha9313662017-06-15 10:40:49 -06001495 " -D<macro=def>\n"
1496 " -D<macro> define a pre-processor macro\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001497 " -E print pre-processed GLSL; cannot be used with -l;\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001498 " errors will appear on stderr\n"
John Kessenich6353d552017-06-23 11:11:09 -06001499 " -G[ver] create SPIR-V binary, under OpenGL semantics; turns on -l;\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001500 " default file name is <stage>.spv (-o overrides this);\n"
John Kessenich6353d552017-06-23 11:11:09 -06001501 " 'ver', when present, is the version of the input semantics,\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001502 " which will appear in #define GL_SPIRV ver;\n"
1503 " '--client opengl100' is the same as -G100;\n"
John Kessenich6353d552017-06-23 11:11:09 -06001504 " a '--target-env' for OpenGL will also imply '-G'\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001505 " -H print human readable form of SPIR-V; turns on -V\n"
John Kessenich971a0a82017-06-07 15:06:58 -06001506 " -I<dir> add dir to the include search path; includer's directory\n"
1507 " is searched first, followed by left-to-right order of -I\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001508 " -Od disables optimization; may cause illegal SPIR-V for HLSL\n"
1509 " -Os optimizes SPIR-V to minimize size\n"
John Kesseniche751bca2017-03-16 11:20:38 -06001510 " -S <stage> uses specified stage rather than parsing the file extension\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001511 " choices for <stage> are vert, tesc, tese, geom, frag, or comp\n"
John Kessenich6353d552017-06-23 11:11:09 -06001512 " -U<macro> undefine a pre-processor macro\n"
1513 " -V[ver] create SPIR-V binary, under Vulkan semantics; turns on -l;\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001514 " default file name is <stage>.spv (-o overrides this)\n"
John Kessenich6353d552017-06-23 11:11:09 -06001515 " 'ver', when present, is the version of the input semantics,\n"
1516 " which will appear in #define VULKAN ver\n"
1517 " '--client vulkan100' is the same as -V100\n"
1518 " a '--target-env' for Vulkan will also imply '-V'\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001519 " -c configuration dump;\n"
1520 " creates the default configuration file (redirect to a .conf file)\n"
1521 " -d default to desktop (#version 110) when there is no shader #version\n"
1522 " (default is ES version 100)\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001523 " -e <name> | --entry-point <name>\n"
1524 " specify <name> as the entry-point function name\n"
John Kessenich5d610ee2018-03-07 18:05:55 -07001525 " -f{hlsl_functionality1}\n"
1526 " 'hlsl_functionality1' enables use of the\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001527 " SPV_GOOGLE_hlsl_functionality1 extension\n"
John Kessenich121853f2017-05-31 17:11:16 -06001528 " -g generate debug information\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001529 " -h print this usage message\n"
1530 " -i intermediate tree (glslang AST) is printed out\n"
1531 " -l link all input files together to form a single module\n"
1532 " -m memory leak mode\n"
John Kessenicha25530c2017-09-11 20:13:49 -06001533 " -o <file> save binary to <file>, requires a binary option (e.g., -V)\n"
John Kesseniche5c394b2019-07-02 09:32:48 -06001534 " -q dump reflection query database; requires -l for linking\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001535 " -r | --relaxed-errors"
1536 " relaxed GLSL semantic error-checking mode\n"
John Kessenichb63f4a32017-11-16 22:32:20 -07001537 " -s silence syntax and semantic error reporting\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001538 " -t multi-threaded mode\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001539 " -v | --version\n"
1540 " print version strings\n"
1541 " -w | --suppress-warnings\n"
1542 " suppress GLSL warnings, except as required by \"#extension : warn\"\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001543 " -x save binary output as text-based 32-bit hexadecimal numbers\n"
Neil Roberts16f53472018-03-20 17:30:53 +01001544 " -u<name>:<loc> specify a uniform location override for --aml\n"
Neil Robertsb0f3d792018-03-20 17:41:05 +01001545 " --uniform-base <base> set a base to use for generated uniform locations\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001546 " --auto-map-bindings | --amb automatically bind uniform variables\n"
1547 " without explicit bindings\n"
1548 " --auto-map-locations | --aml automatically locate input/output lacking\n"
1549 " 'location' (fragile, not cross stage)\n"
1550 " --client {vulkan<ver>|opengl<ver>} see -V and -G\n"
Christoph Kubisch412ff6e2019-04-13 22:57:33 +02001551 " --dump-builtin-symbols prints builtin symbol table prior each compile\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001552 " -dumpfullversion | -dumpversion print bare major.minor.patchlevel\n"
1553 " --flatten-uniform-arrays | --fua flatten uniform texture/sampler arrays to\n"
1554 " scalars\n"
1555 " --hlsl-offsets allow block offsets to follow HLSL rules\n"
1556 " works independently of source language\n"
1557 " --hlsl-iomap perform IO mapping in HLSL register space\n"
1558 " --hlsl-enable-16bit-types allow 16-bit types in SPIR-V for HLSL\n"
John Kessenich605afc72019-06-17 23:33:09 -06001559 " --hlsl-dx9-compatible interprets sampler declarations as a\n"
1560 " texture/sampler combo like DirectX9 would.\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001561 " --invert-y | --iy invert position.Y output in vertex shader\n"
1562 " --keep-uncalled | --ku don't eliminate uncalled functions\n"
John Kessenich605afc72019-06-17 23:33:09 -06001563 " --nan-clamp favor non-NaN operand in min, max, and clamp\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001564 " --no-storage-format | --nsf use Unknown image format\n"
baldurk4513df92019-02-08 10:48:48 +00001565 " --reflect-strict-array-suffix use strict array suffix rules when\n"
1566 " reflecting\n"
baldurkedf82122019-01-29 15:49:00 +00001567 " --reflect-basic-array-suffix arrays of basic types will have trailing [0]\n"
baldurk4513df92019-02-08 10:48:48 +00001568 " --reflect-intermediate-io reflection includes inputs/outputs of linked\n"
1569 " shaders rather than just vertex/fragment\n"
1570 " --reflect-separate-buffers reflect buffer variables and blocks\n"
1571 " separately to uniforms\n"
1572 " --reflect-all-block-variables reflect all variables in blocks, whether\n"
1573 " inactive or active\n"
baldurk19050692019-02-11 11:50:24 +00001574 " --reflect-unwrap-io-blocks unwrap input/output blocks the same as\n"
1575 " uniform blocks\n"
LoopDawg52017192017-07-14 15:15:47 -06001576 " --resource-set-binding [stage] name set binding\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001577 " set descriptor set and binding for\n"
1578 " individual resources\n"
LoopDawg52017192017-07-14 15:15:47 -06001579 " --resource-set-binding [stage] set\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001580 " set descriptor set for all resources\n"
1581 " --rsb synonym for --resource-set-binding\n"
1582 " --shift-image-binding [stage] num\n"
1583 " base binding number for images (uav)\n"
1584 " --shift-image-binding [stage] [num set]...\n"
1585 " per-descriptor-set shift values\n"
1586 " --sib synonym for --shift-image-binding\n"
1587 " --shift-sampler-binding [stage] num\n"
1588 " base binding number for samplers\n"
1589 " --shift-sampler-binding [stage] [num set]...\n"
1590 " per-descriptor-set shift values\n"
1591 " --ssb synonym for --shift-sampler-binding\n"
1592 " --shift-ssbo-binding [stage] num base binding number for SSBOs\n"
1593 " --shift-ssbo-binding [stage] [num set]...\n"
1594 " per-descriptor-set shift values\n"
1595 " --sbb synonym for --shift-ssbo-binding\n"
1596 " --shift-texture-binding [stage] num\n"
1597 " base binding number for textures\n"
1598 " --shift-texture-binding [stage] [num set]...\n"
1599 " per-descriptor-set shift values\n"
1600 " --stb synonym for --shift-texture-binding\n"
1601 " --shift-uav-binding [stage] num base binding number for UAVs\n"
1602 " --shift-uav-binding [stage] [num set]...\n"
1603 " per-descriptor-set shift values\n"
1604 " --suavb synonym for --shift-uav-binding\n"
1605 " --shift-UBO-binding [stage] num base binding number for UBOs\n"
1606 " --shift-UBO-binding [stage] [num set]...\n"
1607 " per-descriptor-set shift values\n"
1608 " --sub synonym for --shift-UBO-binding\n"
1609 " --shift-cbuffer-binding | --scb synonyms for --shift-UBO-binding\n"
1610 " --spirv-dis output standard-form disassembly; works only\n"
1611 " when a SPIR-V generation option is also used\n"
John Kessenichc3404252018-08-23 15:29:08 -06001612 " --spirv-val execute the SPIRV-Tools validator\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001613 " --source-entrypoint <name> the given shader source function is\n"
1614 " renamed to be the <name> given in -e\n"
1615 " --sep synonym for --source-entrypoint\n"
1616 " --stdin read from stdin instead of from a file;\n"
1617 " requires providing the shader stage using -S\n"
John Kessenich8717a5d2018-10-26 10:12:32 -06001618 " --target-env {vulkan1.0 | vulkan1.1 | opengl | \n"
1619 " spirv1.0 | spirv1.1 | spirv1.2 | spirv1.3}\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001620 " set execution environment that emitted code\n"
John Kessenich8717a5d2018-10-26 10:12:32 -06001621 " will execute in (versus source language\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001622 " semantics selected by --client) defaults:\n"
1623 " * 'vulkan1.0' under '--client vulkan<ver>'\n"
1624 " * 'opengl' under '--client opengl<ver>'\n"
John Kessenich8717a5d2018-10-26 10:12:32 -06001625 " * 'spirv1.0' under --target-env vulkan1.0\n"
1626 " * 'spirv1.3' under --target-env vulkan1.1\n"
1627 " multiple --targen-env can be specified.\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001628 " --variable-name <name>\n"
1629 " --vn <name> creates a C header file that contains a\n"
1630 " uint32_t array named <name>\n"
1631 " initialized with the shader binary code\n"
John Kessenichb0a7eb52013-11-07 17:44:20 +00001632 );
John Kessenich68d78fd2015-07-12 19:28:10 -06001633
1634 exit(EFailUsage);
John Kessenicha0af4732012-12-12 21:15:54 +00001635}
1636
John Kessenich3ce4e592014-10-06 19:57:34 +00001637#if !defined _MSC_VER && !defined MINGW_HAS_SECURE_API
John Kessenichcfd643e2013-03-08 23:14:42 +00001638
1639#include <errno.h>
1640
1641int fopen_s(
1642 FILE** pFile,
John Kessenich51cdd902014-02-18 23:37:57 +00001643 const char* filename,
1644 const char* mode
John Kessenichcfd643e2013-03-08 23:14:42 +00001645)
1646{
1647 if (!pFile || !filename || !mode) {
1648 return EINVAL;
1649 }
1650
1651 FILE* f = fopen(filename, mode);
1652 if (! f) {
1653 if (errno != 0) {
1654 return errno;
1655 } else {
1656 return ENOENT;
1657 }
1658 }
1659 *pFile = f;
1660
1661 return 0;
1662}
1663
1664#endif
1665
John Kessenicha0af4732012-12-12 21:15:54 +00001666//
1667// Malloc a string of sufficient size and read a string into it.
1668//
John Kessenich04acb1b2017-06-14 17:36:50 -06001669char* ReadFileData(const char* fileName)
John Kessenicha0af4732012-12-12 21:15:54 +00001670{
John Kessenichb3297152015-07-11 18:01:03 -06001671 FILE *in = nullptr;
John Kessenich3ce4e592014-10-06 19:57:34 +00001672 int errorCode = fopen_s(&in, fileName, "r");
John Kessenich68d78fd2015-07-12 19:28:10 -06001673 if (errorCode || in == nullptr)
1674 Error("unable to open input file");
John Kessenichecba76f2017-01-06 00:34:48 -07001675
John Kessenich04acb1b2017-06-14 17:36:50 -06001676 int count = 0;
John Kessenicha0af4732012-12-12 21:15:54 +00001677 while (fgetc(in) != EOF)
1678 count++;
1679
John Kessenichd6c72a42014-08-18 19:42:35 +00001680 fseek(in, 0, SEEK_SET);
John Kessenichca3457f2015-05-18 01:59:45 +00001681
John Kessenich04acb1b2017-06-14 17:36:50 -06001682 char* return_data = (char*)malloc(count + 1); // freed in FreeFileData()
1683 if ((int)fread(return_data, 1, count, in) != count) {
1684 free(return_data);
John Kessenich68d78fd2015-07-12 19:28:10 -06001685 Error("can't read input file");
John Kessenicha0af4732012-12-12 21:15:54 +00001686 }
John Kessenich68d78fd2015-07-12 19:28:10 -06001687
John Kessenich04acb1b2017-06-14 17:36:50 -06001688 return_data[count] = '\0';
John Kessenicha0af4732012-12-12 21:15:54 +00001689 fclose(in);
John Kessenichb3297152015-07-11 18:01:03 -06001690
John Kessenicha0af4732012-12-12 21:15:54 +00001691 return return_data;
1692}
1693
John Kessenich04acb1b2017-06-14 17:36:50 -06001694void FreeFileData(char* data)
John Kessenicha0af4732012-12-12 21:15:54 +00001695{
John Kessenichb3297152015-07-11 18:01:03 -06001696 free(data);
John Kessenicha0af4732012-12-12 21:15:54 +00001697}
1698
John Kessenich54d8cda2013-02-11 22:36:01 +00001699void InfoLogMsg(const char* msg, const char* name, const int num)
John Kessenicha0af4732012-12-12 21:15:54 +00001700{
John Kessenichfae38ee2015-06-10 23:23:12 +00001701 if (num >= 0 )
1702 printf("#### %s %s %d INFO LOG ####\n", msg, name, num);
1703 else
1704 printf("#### %s %s INFO LOG ####\n", msg, name);
John Kessenicha0af4732012-12-12 21:15:54 +00001705}