blob: 6e4c8d30d75a0bd833b14d824536b0b7be6556ae [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 Kessenich6f988922020-01-07 07:03:11 -0700207 Processes.push_back("define-macro ");
John Kessenich2a271162017-07-20 20:00:36 -0600208 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
John Kessenich6f988922020-01-07 07:03:11 -0700225 Processes.push_back("undef-macro ");
John Kessenich2a271162017-07-20 20:00:36 -0600226 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 Chenb50c02e2018-09-19 11:42:24 -0700260 case EShLangRayGenNV: name = "rgen.spv"; break;
261 case EShLangIntersectNV: name = "rint.spv"; break;
262 case EShLangAnyHitNV: name = "rahit.spv"; break;
263 case EShLangClosestHitNV: name = "rchit.spv"; break;
264 case EShLangMissNV: name = "rmiss.spv"; break;
265 case EShLangCallableNV: name = "rcall.spv"; break;
Chao Chen3c366992018-09-19 11:41:59 -0700266 case EShLangMeshNV: name = "mesh.spv"; break;
267 case EShLangTaskNV: name = "task.spv"; break;
John Kessenich68d78fd2015-07-12 19:28:10 -0600268 default: name = "unknown"; break;
269 }
270 } else
271 name = binaryFileName;
272
273 return name;
274}
John Kessenich2b07c7e2013-07-31 18:44:13 +0000275
John Kessenich05a70632013-09-17 19:26:08 +0000276//
277// *.conf => this is a config file that can set limits/resources
278//
279bool SetConfigFile(const std::string& name)
280{
281 if (name.size() < 5)
282 return false;
283
John Kessenich4c706852013-10-11 16:28:43 +0000284 if (name.compare(name.size() - 5, 5, ".conf") == 0) {
John Kessenich05a70632013-09-17 19:26:08 +0000285 ConfigFile = name;
286 return true;
287 }
288
289 return false;
290}
291
John Kessenich68d78fd2015-07-12 19:28:10 -0600292//
293// Give error and exit with failure code.
294//
John Kessenichbd97b6f2019-12-20 10:33:13 -0700295void Error(const char* message, const char* detail = nullptr)
John Kessenich68d78fd2015-07-12 19:28:10 -0600296{
John Kessenichbd97b6f2019-12-20 10:33:13 -0700297 fprintf(stderr, "%s: Error: ", ExecutableName);
298 if (detail != nullptr)
299 fprintf(stderr, "%s: ", detail);
300 fprintf(stderr, "%s (use -h for usage)\n", message);
John Kessenich68d78fd2015-07-12 19:28:10 -0600301 exit(EFailUsage);
302}
303
304//
LoopDawg08a14422017-10-17 19:27:14 -0600305// Process an optional binding base of one the forms:
306// --argname [stage] base // base for stage (if given) or all stages (if not)
LoopDawge5709552017-10-21 10:46:39 -0600307// --argname [stage] [base set]... // set/base pairs: set the base for given binding set.
LoopDawg08a14422017-10-17 19:27:14 -0600308
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600309// Where stage is one of the forms accepted by FindLanguage, and base is an integer
310//
LoopDawg08a14422017-10-17 19:27:14 -0600311void ProcessBindingBase(int& argc, char**& argv, glslang::TResourceType res)
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600312{
313 if (argc < 2)
314 usage();
315
LoopDawg08a14422017-10-17 19:27:14 -0600316 EShLanguage lang = EShLangCount;
317 int singleBase = 0;
318 TPerSetBaseBinding perSetBase;
319 int arg = 1;
320
321 // Parse stage, if given
322 if (!isdigit(argv[arg][0])) {
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600323 if (argc < 3) // this form needs one more argument
324 usage();
John Kessenichecba76f2017-01-06 00:34:48 -0700325
LoopDawg08a14422017-10-17 19:27:14 -0600326 lang = FindLanguage(argv[arg++], false);
327 }
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600328
LoopDawg08a14422017-10-17 19:27:14 -0600329 if ((argc - arg) > 2 && isdigit(argv[arg+0][0]) && isdigit(argv[arg+1][0])) {
330 // Parse a per-set binding base
331 while ((argc - arg) > 2 && isdigit(argv[arg+0][0]) && isdigit(argv[arg+1][0])) {
LoopDawg08a14422017-10-17 19:27:14 -0600332 const int baseNum = atoi(argv[arg++]);
LoopDawge5709552017-10-21 10:46:39 -0600333 const int setNum = atoi(argv[arg++]);
LoopDawg08a14422017-10-17 19:27:14 -0600334 perSetBase[setNum] = baseNum;
335 }
336 } else {
337 // Parse single binding base
338 singleBase = atoi(argv[arg++]);
339 }
340
341 argc -= (arg-1);
342 argv += (arg-1);
343
344 // Set one or all languages
345 const int langMin = (lang < EShLangCount) ? lang+0 : 0;
346 const int langMax = (lang < EShLangCount) ? lang+1 : EShLangCount;
347
348 for (int lang = langMin; lang < langMax; ++lang) {
349 if (!perSetBase.empty())
John Kessenich251901a2018-08-12 22:05:59 -0600350 baseBindingForSet[res][lang].insert(perSetBase.begin(), perSetBase.end());
LoopDawg08a14422017-10-17 19:27:14 -0600351 else
352 baseBinding[res][lang] = singleBase;
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600353 }
354}
355
Hyangran Park36dc8292017-05-02 16:27:29 +0900356void ProcessResourceSetBindingBase(int& argc, char**& argv, std::array<std::vector<std::string>, EShLangCount>& base)
357{
358 if (argc < 2)
359 usage();
360
361 if (!isdigit(argv[1][0])) {
LoopDawg52017192017-07-14 15:15:47 -0600362 if (argc < 3) // this form needs one more argument
Hyangran Park36dc8292017-05-02 16:27:29 +0900363 usage();
364
LoopDawg52017192017-07-14 15:15:47 -0600365 // Parse form: --argname stage [regname set base...], or:
366 // --argname stage set
Hyangran Park36dc8292017-05-02 16:27:29 +0900367 const EShLanguage lang = FindLanguage(argv[1], false);
368
LoopDawg52017192017-07-14 15:15:47 -0600369 argc--;
370 argv++;
371
372 while (argc > 1 && argv[1] != nullptr && argv[1][0] != '-') {
373 base[lang].push_back(argv[1]);
374
375 argc--;
376 argv++;
Hyangran Park36dc8292017-05-02 16:27:29 +0900377 }
LoopDawg52017192017-07-14 15:15:47 -0600378
379 // Must have one arg, or a multiple of three (for [regname set binding] triples)
380 if (base[lang].size() != 1 && (base[lang].size() % 3) != 0)
381 usage();
382
Hyangran Park36dc8292017-05-02 16:27:29 +0900383 } else {
LoopDawg52017192017-07-14 15:15:47 -0600384 // Parse form: --argname set
Hyangran Park36dc8292017-05-02 16:27:29 +0900385 for (int lang=0; lang<EShLangCount; ++lang)
386 base[lang].push_back(argv[1]);
387
388 argc--;
389 argv++;
390 }
391}
392
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600393//
John Kessenich68d78fd2015-07-12 19:28:10 -0600394// Do all command-line argument parsing. This includes building up the work-items
395// to be processed later, and saving all the command-line options.
396//
397// Does not return (it exits) if command-line is fatally flawed.
398//
Juan Lopeza558b262017-04-02 23:04:00 +0200399void ProcessArguments(std::vector<std::unique_ptr<glslang::TWorkItem>>& workItems, int argc, char* argv[])
John Kessenich2b07c7e2013-07-31 18:44:13 +0000400{
LoopDawg08a14422017-10-17 19:27:14 -0600401 for (int res = 0; res < glslang::EResCount; ++res)
402 baseBinding[res].fill(0);
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600403
John Kessenich38f3b892013-09-06 19:52:57 +0000404 ExecutableName = argv[0];
Juan Lopeza558b262017-04-02 23:04:00 +0200405 workItems.reserve(argc);
John Kessenich38f3b892013-09-06 19:52:57 +0000406
John Kessenichc178f0a2017-06-23 10:58:31 -0600407 const auto bumpArg = [&]() {
408 if (argc > 0) {
409 argc--;
410 argv++;
411 }
412 };
413
414 // read a string directly attached to a single-letter option
John Kessenich6263fb12017-06-14 15:52:44 -0600415 const auto getStringOperand = [&](const char* desc) {
416 if (argv[0][2] == 0) {
417 printf("%s must immediately follow option (no spaces)\n", desc);
418 exit(EFailUsage);
419 }
420 return argv[0] + 2;
421 };
422
John Kessenich6353d552017-06-23 11:11:09 -0600423 // read a number attached to a single-letter option
424 const auto getAttachedNumber = [&](const char* desc) {
425 int num = atoi(argv[0] + 2);
426 if (num == 0) {
427 printf("%s: expected attached non-0 number\n", desc);
428 exit(EFailUsage);
429 }
430 return num;
431 };
432
433 // minimum needed (without overriding something else) to target Vulkan SPIR-V
434 const auto setVulkanSpv = []() {
John Kessenich8717a5d2018-10-26 10:12:32 -0600435 if (Client == glslang::EShClientNone)
436 ClientVersion = glslang::EShTargetVulkan_1_0;
437 Client = glslang::EShClientVulkan;
John Kessenich6353d552017-06-23 11:11:09 -0600438 Options |= EOptionSpv;
439 Options |= EOptionVulkanRules;
440 Options |= EOptionLinkProgram;
441 };
442
443 // minimum needed (without overriding something else) to target OpenGL SPIR-V
444 const auto setOpenGlSpv = []() {
John Kessenich8717a5d2018-10-26 10:12:32 -0600445 if (Client == glslang::EShClientNone)
446 ClientVersion = glslang::EShTargetOpenGL_450;
447 Client = glslang::EShClientOpenGL;
John Kessenich6353d552017-06-23 11:11:09 -0600448 Options |= EOptionSpv;
449 Options |= EOptionLinkProgram;
450 // undo a -H default to Vulkan
451 Options &= ~EOptionVulkanRules;
452 };
453
Neil Roberts16f53472018-03-20 17:30:53 +0100454 const auto getUniformOverride = [getStringOperand]() {
455 const char *arg = getStringOperand("-u<name>:<location>");
456 const char *split = strchr(arg, ':');
457 if (split == NULL) {
458 printf("%s: missing location\n", arg);
459 exit(EFailUsage);
460 }
461 errno = 0;
462 int location = ::strtol(split + 1, NULL, 10);
463 if (errno) {
464 printf("%s: invalid location\n", arg);
465 exit(EFailUsage);
466 }
467 return std::make_pair(std::string(arg, split - arg), location);
468 };
469
John Kessenichc178f0a2017-06-23 10:58:31 -0600470 for (bumpArg(); argc >= 1; bumpArg()) {
John Kessenich2b07c7e2013-07-31 18:44:13 +0000471 if (argv[0][0] == '-') {
John Kessenich2aa7f3a2015-05-15 16:02:07 +0000472 switch (argv[0][1]) {
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600473 case '-':
474 {
475 std::string lowerword(argv[0]+2);
476 std::transform(lowerword.begin(), lowerword.end(), lowerword.begin(), ::tolower);
477
478 // handle --word style options
John Kessenich6263fb12017-06-14 15:52:44 -0600479 if (lowerword == "auto-map-bindings" || // synonyms
John Kessenich6353d552017-06-23 11:11:09 -0600480 lowerword == "auto-map-binding" ||
481 lowerword == "amb") {
John Kessenich6263fb12017-06-14 15:52:44 -0600482 Options |= EOptionAutoMapBindings;
483 } else if (lowerword == "auto-map-locations" || // synonyms
484 lowerword == "aml") {
485 Options |= EOptionAutoMapLocations;
Neil Robertsb0f3d792018-03-20 17:41:05 +0100486 } else if (lowerword == "uniform-base") {
487 if (argc <= 1)
John Kessenichbd97b6f2019-12-20 10:33:13 -0700488 Error("no <base> provided", lowerword.c_str());
Neil Robertsb0f3d792018-03-20 17:41:05 +0100489 uniformBase = ::strtol(argv[1], NULL, 10);
490 bumpArg();
491 break;
John Kessenich6353d552017-06-23 11:11:09 -0600492 } else if (lowerword == "client") {
493 if (argc > 1) {
494 if (strcmp(argv[1], "vulkan100") == 0)
495 setVulkanSpv();
496 else if (strcmp(argv[1], "opengl100") == 0)
497 setOpenGlSpv();
498 else
John Kessenichbd97b6f2019-12-20 10:33:13 -0700499 Error("expects vulkan100 or opengl100", lowerword.c_str());
500 } else
501 Error("expects vulkan100 or opengl100", lowerword.c_str());
John Kessenich6353d552017-06-23 11:11:09 -0600502 bumpArg();
John Kessenich6f988922020-01-07 07:03:11 -0700503 } else if (lowerword == "define-macro" ||
504 lowerword == "d") {
505 if (argc > 1)
506 UserPreamble.addDef(argv[1]);
507 else
508 Error("expects <name[=def]>", argv[0]);
509 bumpArg();
Christoph Kubisch55ba3ea2019-04-13 22:18:16 +0200510 } else if (lowerword == "dump-builtin-symbols") {
511 DumpBuiltinSymbols = true;
John Kessenich640bd092018-08-09 14:15:00 -0600512 } else if (lowerword == "entry-point") {
513 entryPointName = argv[1];
514 if (argc <= 1)
John Kessenichbd97b6f2019-12-20 10:33:13 -0700515 Error("no <name> provided", lowerword.c_str());
John Kessenich640bd092018-08-09 14:15:00 -0600516 bumpArg();
John Kessenich6263fb12017-06-14 15:52:44 -0600517 } else if (lowerword == "flatten-uniform-arrays" || // synonyms
518 lowerword == "flatten-uniform-array" ||
519 lowerword == "fua") {
520 Options |= EOptionFlattenUniformArrays;
521 } else if (lowerword == "hlsl-offsets") {
522 Options |= EOptionHlslOffsets;
523 } else if (lowerword == "hlsl-iomap" ||
524 lowerword == "hlsl-iomapper" ||
525 lowerword == "hlsl-iomapping") {
526 Options |= EOptionHlslIoMapping;
Rex Xucb61eec2018-03-07 13:10:01 +0800527 } else if (lowerword == "hlsl-enable-16bit-types") {
528 HlslEnable16BitTypes = true;
John Kessenichbd1c1832018-12-07 18:38:26 -0700529 } else if (lowerword == "hlsl-dx9-compatible") {
530 HlslDX9compatible = true;
John Kessenichc6c80a62018-03-05 22:23:17 -0700531 } else if (lowerword == "invert-y" || // synonyms
532 lowerword == "iy") {
533 Options |= EOptionInvertY;
John Kessenich6263fb12017-06-14 15:52:44 -0600534 } else if (lowerword == "keep-uncalled" || // synonyms
535 lowerword == "ku") {
536 Options |= EOptionKeepUncalled;
John Kessenich605afc72019-06-17 23:33:09 -0600537 } else if (lowerword == "nan-clamp") {
538 NaNClamp = true;
John Kessenich6263fb12017-06-14 15:52:44 -0600539 } else if (lowerword == "no-storage-format" || // synonyms
540 lowerword == "nsf") {
541 Options |= EOptionNoStorageFormat;
John Kessenich2a271162017-07-20 20:00:36 -0600542 } else if (lowerword == "relaxed-errors") {
543 Options |= EOptionRelaxedErrors;
baldurk15c37f72019-01-29 12:12:59 +0000544 } else if (lowerword == "reflect-strict-array-suffix") {
545 ReflectOptions |= EShReflectionStrictArraySuffix;
baldurkedf82122019-01-29 15:49:00 +0000546 } else if (lowerword == "reflect-basic-array-suffix") {
547 ReflectOptions |= EShReflectionBasicArraySuffix;
baldurk0af5e3e2019-01-29 16:04:44 +0000548 } else if (lowerword == "reflect-intermediate-io") {
549 ReflectOptions |= EShReflectionIntermediateIO;
baldurk657acc02019-01-30 14:18:43 +0000550 } else if (lowerword == "reflect-separate-buffers") {
551 ReflectOptions |= EShReflectionSeparateBuffers;
baldurka972e732019-01-30 15:34:02 +0000552 } else if (lowerword == "reflect-all-block-variables") {
553 ReflectOptions |= EShReflectionAllBlockVariables;
baldurk19050692019-02-11 11:50:24 +0000554 } else if (lowerword == "reflect-unwrap-io-blocks") {
555 ReflectOptions |= EShReflectionUnwrapIOBlocks;
John Kessenich6263fb12017-06-14 15:52:44 -0600556 } else if (lowerword == "resource-set-bindings" || // synonyms
557 lowerword == "resource-set-binding" ||
558 lowerword == "rsb") {
559 ProcessResourceSetBindingBase(argc, argv, baseResourceSetBinding);
steve-lunarg9088be42016-11-01 10:31:42 -0600560 } else if (lowerword == "shift-image-bindings" || // synonyms
561 lowerword == "shift-image-binding" ||
562 lowerword == "sib") {
LoopDawg08a14422017-10-17 19:27:14 -0600563 ProcessBindingBase(argc, argv, glslang::EResImage);
John Kessenich6263fb12017-06-14 15:52:44 -0600564 } else if (lowerword == "shift-sampler-bindings" || // synonyms
John Kessenichade8bbb2018-08-12 21:24:55 -0600565 lowerword == "shift-sampler-binding" ||
566 lowerword == "ssb") {
LoopDawg08a14422017-10-17 19:27:14 -0600567 ProcessBindingBase(argc, argv, glslang::EResSampler);
John Kessenich6263fb12017-06-14 15:52:44 -0600568 } else if (lowerword == "shift-uav-bindings" || // synonyms
569 lowerword == "shift-uav-binding" ||
570 lowerword == "suavb") {
LoopDawg08a14422017-10-17 19:27:14 -0600571 ProcessBindingBase(argc, argv, glslang::EResUav);
John Kessenich6263fb12017-06-14 15:52:44 -0600572 } else if (lowerword == "shift-texture-bindings" || // synonyms
573 lowerword == "shift-texture-binding" ||
574 lowerword == "stb") {
LoopDawg08a14422017-10-17 19:27:14 -0600575 ProcessBindingBase(argc, argv, glslang::EResTexture);
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600576 } else if (lowerword == "shift-ubo-bindings" || // synonyms
577 lowerword == "shift-ubo-binding" ||
steve-lunargbe283552017-04-18 12:18:01 -0600578 lowerword == "shift-cbuffer-bindings" ||
579 lowerword == "shift-cbuffer-binding" ||
580 lowerword == "sub" ||
581 lowerword == "scb") {
LoopDawg08a14422017-10-17 19:27:14 -0600582 ProcessBindingBase(argc, argv, glslang::EResUbo);
steve-lunarg932bb5c2017-02-21 17:19:08 -0700583 } else if (lowerword == "shift-ssbo-bindings" || // synonyms
584 lowerword == "shift-ssbo-binding" ||
585 lowerword == "sbb") {
LoopDawg08a14422017-10-17 19:27:14 -0600586 ProcessBindingBase(argc, argv, glslang::EResSsbo);
John Kessenich6263fb12017-06-14 15:52:44 -0600587 } else if (lowerword == "source-entrypoint" || // synonyms
588 lowerword == "sep") {
John Kessenichc178f0a2017-06-23 10:58:31 -0600589 if (argc <= 1)
John Kessenichbd97b6f2019-12-20 10:33:13 -0700590 Error("no <entry-point> provided", lowerword.c_str());
John Kessenichc178f0a2017-06-23 10:58:31 -0600591 sourceEntryPointName = argv[1];
592 bumpArg();
John Kessenich6263fb12017-06-14 15:52:44 -0600593 break;
John Kesseniche2156222018-06-11 18:12:15 -0600594 } else if (lowerword == "spirv-dis") {
595 SpvToolsDisassembler = true;
John Kessenichc3404252018-08-23 15:29:08 -0600596 } else if (lowerword == "spirv-val") {
597 SpvToolsValidate = true;
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +0200598 } else if (lowerword == "stdin") {
599 Options |= EOptionStdin;
600 shaderStageName = argv[1];
John Kessenich2a271162017-07-20 20:00:36 -0600601 } else if (lowerword == "suppress-warnings") {
602 Options |= EOptionSuppressWarnings;
John Kessenich6353d552017-06-23 11:11:09 -0600603 } else if (lowerword == "target-env") {
604 if (argc > 1) {
605 if (strcmp(argv[1], "vulkan1.0") == 0) {
606 setVulkanSpv();
John Kessenich8717a5d2018-10-26 10:12:32 -0600607 ClientVersion = glslang::EShTargetVulkan_1_0;
John Kessenich66011cb2018-03-06 16:12:04 -0700608 } else if (strcmp(argv[1], "vulkan1.1") == 0) {
609 setVulkanSpv();
John Kessenich8717a5d2018-10-26 10:12:32 -0600610 ClientVersion = glslang::EShTargetVulkan_1_1;
John Kessenich273d3a52020-01-15 00:10:41 -0700611 } else if (strcmp(argv[1], "vulkan1.2") == 0) {
612 setVulkanSpv();
613 ClientVersion = glslang::EShTargetVulkan_1_2;
John Kessenich6353d552017-06-23 11:11:09 -0600614 } else if (strcmp(argv[1], "opengl") == 0) {
615 setOpenGlSpv();
John Kessenich8717a5d2018-10-26 10:12:32 -0600616 ClientVersion = glslang::EShTargetOpenGL_450;
617 } else if (strcmp(argv[1], "spirv1.0") == 0) {
618 TargetLanguage = glslang::EShTargetSpv;
619 TargetVersion = glslang::EShTargetSpv_1_0;
620 } else if (strcmp(argv[1], "spirv1.1") == 0) {
621 TargetLanguage = glslang::EShTargetSpv;
622 TargetVersion = glslang::EShTargetSpv_1_1;
623 } else if (strcmp(argv[1], "spirv1.2") == 0) {
624 TargetLanguage = glslang::EShTargetSpv;
625 TargetVersion = glslang::EShTargetSpv_1_2;
626 } else if (strcmp(argv[1], "spirv1.3") == 0) {
627 TargetLanguage = glslang::EShTargetSpv;
628 TargetVersion = glslang::EShTargetSpv_1_3;
629 } else if (strcmp(argv[1], "spirv1.4") == 0) {
630 TargetLanguage = glslang::EShTargetSpv;
631 TargetVersion = glslang::EShTargetSpv_1_4;
John Kessenich8317e6c2019-08-18 23:58:08 -0600632 } else if (strcmp(argv[1], "spirv1.5") == 0) {
633 TargetLanguage = glslang::EShTargetSpv;
634 TargetVersion = glslang::EShTargetSpv_1_5;
John Kessenich6353d552017-06-23 11:11:09 -0600635 } else
John Kessenich273d3a52020-01-15 00:10:41 -0700636 Error("--target-env expected one of: vulkan1.0, vulkan1.1, vulkan1.2, opengl,\n"
John Kessenich8317e6c2019-08-18 23:58:08 -0600637 "spirv1.0, spirv1.1, spirv1.2, spirv1.3, spirv1.4, or spirv1.5");
John Kessenich6353d552017-06-23 11:11:09 -0600638 }
639 bumpArg();
John Kessenich6f988922020-01-07 07:03:11 -0700640 } else if (lowerword == "undef-macro" ||
641 lowerword == "u") {
642 if (argc > 1)
643 UserPreamble.addUndef(argv[1]);
644 else
645 Error("expects <name>", argv[0]);
646 bumpArg();
Flavio15017db2017-02-15 14:29:33 -0800647 } else if (lowerword == "variable-name" || // synonyms
John Kessenich66011cb2018-03-06 16:12:04 -0700648 lowerword == "vn") {
Flavio15017db2017-02-15 14:29:33 -0800649 Options |= EOptionOutputHexadecimal;
John Kessenichc178f0a2017-06-23 10:58:31 -0600650 if (argc <= 1)
John Kessenichbd97b6f2019-12-20 10:33:13 -0700651 Error("no <C-variable-name> provided", lowerword.c_str());
John Kessenichc178f0a2017-06-23 10:58:31 -0600652 variableName = argv[1];
653 bumpArg();
Flavio15017db2017-02-15 14:29:33 -0800654 break;
John Kessenichc6c80a62018-03-05 22:23:17 -0700655 } else if (lowerword == "version") {
656 Options |= EOptionDumpVersions;
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600657 } else {
John Kessenichbd97b6f2019-12-20 10:33:13 -0700658 Error("unrecognized command-line option", argv[0]);
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600659 }
660 }
661 break;
John Kessenich6263fb12017-06-14 15:52:44 -0600662 case 'C':
663 Options |= EOptionCascadingErrors;
664 break;
665 case 'D':
John Kessenicha9313662017-06-15 10:40:49 -0600666 if (argv[0][2] == 0)
667 Options |= EOptionReadHlsl;
668 else
John Kessenich6f988922020-01-07 07:03:11 -0700669 UserPreamble.addDef(getStringOperand("-D<name[=def]>"));
John Kessenich6263fb12017-06-14 15:52:44 -0600670 break;
Neil Roberts16f53472018-03-20 17:30:53 +0100671 case 'u':
672 uniformLocationOverrides.push_back(getUniformOverride());
673 break;
John Kessenich6263fb12017-06-14 15:52:44 -0600674 case 'E':
675 Options |= EOptionOutputPreprocessed;
676 break;
677 case 'G':
John Kessenich8717a5d2018-10-26 10:12:32 -0600678 // OpenGL client
John Kessenich6353d552017-06-23 11:11:09 -0600679 setOpenGlSpv();
680 if (argv[0][2] != 0)
681 ClientInputSemanticsVersion = getAttachedNumber("-G<num> client input semantics");
John Kessenich6263fb12017-06-14 15:52:44 -0600682 break;
John Kessenich2aa7f3a2015-05-15 16:02:07 +0000683 case 'H':
684 Options |= EOptionHumanReadableSpv;
John Kessenich91e4aa52016-07-07 17:46:42 -0600685 if ((Options & EOptionSpv) == 0) {
686 // default to Vulkan
John Kessenich6353d552017-06-23 11:11:09 -0600687 setVulkanSpv();
John Kessenich91e4aa52016-07-07 17:46:42 -0600688 }
689 break;
John Kessenich971a0a82017-06-07 15:06:58 -0600690 case 'I':
John Kessenicha9313662017-06-15 10:40:49 -0600691 IncludeDirectoryList.push_back(getStringOperand("-I<dir> include path"));
John Kessenich68d78fd2015-07-12 19:28:10 -0600692 break;
GregFcd1f1692017-09-21 18:40:22 -0600693 case 'O':
694 if (argv[0][2] == 'd')
695 Options |= EOptionOptimizeDisable;
696 else if (argv[0][2] == 's')
GregFfb03a552018-03-29 11:49:14 -0600697#if ENABLE_OPT
GregFcd1f1692017-09-21 18:40:22 -0600698 Options |= EOptionOptimizeSize;
699#else
700 Error("-Os not available; optimizer not linked");
701#endif
702 else
703 Error("unknown -O option");
704 break;
Dan Baker5afdd782016-08-11 17:53:57 -0400705 case 'S':
John Kessenichc178f0a2017-06-23 10:58:31 -0600706 if (argc <= 1)
Dan Baker5afdd782016-08-11 17:53:57 -0400707 Error("no <stage> specified for -S");
John Kessenichc178f0a2017-06-23 10:58:31 -0600708 shaderStageName = argv[1];
709 bumpArg();
dankbaker45d49bc2016-08-08 21:43:07 -0400710 break;
John Kessenicha9313662017-06-15 10:40:49 -0600711 case 'U':
John Kessenich6f988922020-01-07 07:03:11 -0700712 UserPreamble.addUndef(getStringOperand("-U<name>"));
John Kessenicha9313662017-06-15 10:40:49 -0600713 break;
John Kessenich6263fb12017-06-14 15:52:44 -0600714 case 'V':
John Kessenich6353d552017-06-23 11:11:09 -0600715 setVulkanSpv();
716 if (argv[0][2] != 0)
David Neto506d2c22018-02-27 21:55:23 -0500717 ClientInputSemanticsVersion = getAttachedNumber("-V<num> client input semantics");
John Kessenichc555ddd2015-06-17 02:38:44 +0000718 break;
John Kessenich05a70632013-09-17 19:26:08 +0000719 case 'c':
720 Options |= EOptionDumpConfig;
721 break;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000722 case 'd':
John Kessenichc6c80a62018-03-05 22:23:17 -0700723 if (strncmp(&argv[0][1], "dumpversion", strlen(&argv[0][1]) + 1) == 0 ||
724 strncmp(&argv[0][1], "dumpfullversion", strlen(&argv[0][1]) + 1) == 0)
725 Options |= EOptionDumpBareVersion;
726 else
727 Options |= EOptionDefaultDesktop;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000728 break;
John Kessenich4d65ee32016-03-12 18:17:47 -0700729 case 'e':
John Kessenich4d65ee32016-03-12 18:17:47 -0700730 entryPointName = argv[1];
John Kessenichc178f0a2017-06-23 10:58:31 -0600731 if (argc <= 1)
John Kessenicha25530c2017-09-11 20:13:49 -0600732 Error("no <name> provided for -e");
John Kessenichc178f0a2017-06-23 10:58:31 -0600733 bumpArg();
John Kessenich4d65ee32016-03-12 18:17:47 -0700734 break;
John Kessenich5d610ee2018-03-07 18:05:55 -0700735 case 'f':
736 if (strcmp(&argv[0][2], "hlsl_functionality1") == 0)
737 targetHlslFunctionality1 = true;
738 else
739 Error("-f: expected hlsl_functionality1");
740 break;
John Kessenich121853f2017-05-31 17:11:16 -0600741 case 'g':
742 Options |= EOptionDebug;
743 break;
John Kessenich68d78fd2015-07-12 19:28:10 -0600744 case 'h':
745 usage();
746 break;
John Kessenich05a70632013-09-17 19:26:08 +0000747 case 'i':
John Kessenich94a81fb2013-08-31 02:41:30 +0000748 Options |= EOptionIntermediate;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000749 break;
750 case 'l':
John Kessenichd78e3512014-08-25 20:07:55 +0000751 Options |= EOptionLinkProgram;
John Kessenich94a81fb2013-08-31 02:41:30 +0000752 break;
753 case 'm':
754 Options |= EOptionMemoryLeakMode;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000755 break;
John Kessenich68d78fd2015-07-12 19:28:10 -0600756 case 'o':
John Kessenichc178f0a2017-06-23 10:58:31 -0600757 if (argc <= 1)
John Kessenich68d78fd2015-07-12 19:28:10 -0600758 Error("no <file> provided for -o");
John Kessenichc178f0a2017-06-23 10:58:31 -0600759 binaryFileName = argv[1];
760 bumpArg();
John Kessenich68d78fd2015-07-12 19:28:10 -0600761 break;
John Kessenich11f9fc72013-11-07 01:06:34 +0000762 case 'q':
763 Options |= EOptionDumpReflection;
764 break;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000765 case 'r':
John Kessenich94a81fb2013-08-31 02:41:30 +0000766 Options |= EOptionRelaxedErrors;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000767 break;
768 case 's':
John Kessenich94a81fb2013-08-31 02:41:30 +0000769 Options |= EOptionSuppressInfolog;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000770 break;
John Kessenich38f3b892013-09-06 19:52:57 +0000771 case 't':
Juan Lopeza558b262017-04-02 23:04:00 +0200772 Options |= EOptionMultiThreaded;
John Kessenich38f3b892013-09-06 19:52:57 +0000773 break;
John Kessenich319de232013-12-04 04:43:40 +0000774 case 'v':
775 Options |= EOptionDumpVersions;
776 break;
John Kessenichb0a7eb52013-11-07 17:44:20 +0000777 case 'w':
778 Options |= EOptionSuppressWarnings;
779 break;
Johannes van Waverenecb0f3b2016-05-27 12:55:53 -0500780 case 'x':
781 Options |= EOptionOutputHexadecimal;
Johannes van Waverenecb0f3b2016-05-27 12:55:53 -0500782 break;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000783 default:
John Kessenichbd97b6f2019-12-20 10:33:13 -0700784 Error("unrecognized command-line option", argv[0]);
John Kessenich68d78fd2015-07-12 19:28:10 -0600785 break;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000786 }
John Kessenich38f3b892013-09-06 19:52:57 +0000787 } else {
John Kessenich05a70632013-09-17 19:26:08 +0000788 std::string name(argv[0]);
789 if (! SetConfigFile(name)) {
Juan Lopeza558b262017-04-02 23:04:00 +0200790 workItems.push_back(std::unique_ptr<glslang::TWorkItem>(new glslang::TWorkItem(name)));
John Kessenich05a70632013-09-17 19:26:08 +0000791 }
John Kessenich38f3b892013-09-06 19:52:57 +0000792 }
John Kessenich2b07c7e2013-07-31 18:44:13 +0000793 }
794
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +0200795 // Make sure that -S is always specified if --stdin is specified
796 if ((Options & EOptionStdin) && shaderStageName == nullptr)
797 Error("must provide -S when --stdin is given");
798
John Kessenich68d78fd2015-07-12 19:28:10 -0600799 // Make sure that -E is not specified alongside linking (which includes SPV generation)
John Kesseniche5c394b2019-07-02 09:32:48 -0600800 // Or things that require linking
801 if (Options & EOptionOutputPreprocessed) {
802 if (Options & EOptionLinkProgram)
803 Error("can't use -E when linking is selected");
804 if (Options & EOptionDumpReflection)
805 Error("reflection requires linking, which can't be used when -E when is selected");
806 }
807
808 // reflection requires linking
809 if ((Options & EOptionDumpReflection) && !(Options & EOptionLinkProgram))
810 Error("reflection requires -l for linking");
John Kessenichc555ddd2015-06-17 02:38:44 +0000811
Johannes van Waverenecb0f3b2016-05-27 12:55:53 -0500812 // -o or -x makes no sense if there is no target binary
John Kessenich68d78fd2015-07-12 19:28:10 -0600813 if (binaryFileName && (Options & EOptionSpv) == 0)
814 Error("no binary generation requested (e.g., -V)");
steve-lunarge0b9deb2016-09-16 13:26:37 -0600815
816 if ((Options & EOptionFlattenUniformArrays) != 0 &&
817 (Options & EOptionReadHlsl) == 0)
818 Error("uniform array flattening only valid when compiling HLSL source.");
John Kessenich8717a5d2018-10-26 10:12:32 -0600819
820 // rationalize client and target language
821 if (TargetLanguage == glslang::EShTargetNone) {
822 switch (ClientVersion) {
823 case glslang::EShTargetVulkan_1_0:
824 TargetLanguage = glslang::EShTargetSpv;
825 TargetVersion = glslang::EShTargetSpv_1_0;
826 break;
827 case glslang::EShTargetVulkan_1_1:
828 TargetLanguage = glslang::EShTargetSpv;
829 TargetVersion = glslang::EShTargetSpv_1_3;
830 break;
John Kessenich273d3a52020-01-15 00:10:41 -0700831 case glslang::EShTargetVulkan_1_2:
832 TargetLanguage = glslang::EShTargetSpv;
833 TargetVersion = glslang::EShTargetSpv_1_5;
834 break;
John Kessenich8717a5d2018-10-26 10:12:32 -0600835 case glslang::EShTargetOpenGL_450:
836 TargetLanguage = glslang::EShTargetSpv;
837 TargetVersion = glslang::EShTargetSpv_1_0;
838 break;
839 default:
840 break;
841 }
842 }
843 if (TargetLanguage != glslang::EShTargetNone && Client == glslang::EShClientNone)
844 Error("To generate SPIR-V, also specify client semantics. See -G and -V.");
John Kessenich2b07c7e2013-07-31 18:44:13 +0000845}
846
John Kessenich68d78fd2015-07-12 19:28:10 -0600847//
848// Translate the meaningful subset of command-line options to parser-behavior options.
849//
John Kessenichb0a7eb52013-11-07 17:44:20 +0000850void SetMessageOptions(EShMessages& messages)
851{
852 if (Options & EOptionRelaxedErrors)
853 messages = (EShMessages)(messages | EShMsgRelaxedErrors);
854 if (Options & EOptionIntermediate)
855 messages = (EShMessages)(messages | EShMsgAST);
856 if (Options & EOptionSuppressWarnings)
857 messages = (EShMessages)(messages | EShMsgSuppressWarnings);
John Kessenich68d78fd2015-07-12 19:28:10 -0600858 if (Options & EOptionSpv)
859 messages = (EShMessages)(messages | EShMsgSpvRules);
860 if (Options & EOptionVulkanRules)
861 messages = (EShMessages)(messages | EShMsgVulkanRules);
Andrew Woloszynaae1ad82015-06-24 17:00:46 -0400862 if (Options & EOptionOutputPreprocessed)
863 messages = (EShMessages)(messages | EShMsgOnlyPreprocessor);
John Kessenich66e2faf2016-03-12 18:34:36 -0700864 if (Options & EOptionReadHlsl)
865 messages = (EShMessages)(messages | EShMsgReadHlsl);
John Kessenicha86836e2016-07-09 14:50:57 -0600866 if (Options & EOptionCascadingErrors)
867 messages = (EShMessages)(messages | EShMsgCascadingErrors);
John Kessenich906cc212016-12-09 19:22:20 -0700868 if (Options & EOptionKeepUncalled)
869 messages = (EShMessages)(messages | EShMsgKeepUncalled);
John Kessenich4f1403e2017-04-05 17:38:20 -0600870 if (Options & EOptionHlslOffsets)
871 messages = (EShMessages)(messages | EShMsgHlslOffsets);
John Kessenich121853f2017-05-31 17:11:16 -0600872 if (Options & EOptionDebug)
873 messages = (EShMessages)(messages | EShMsgDebugInfo);
Rex Xucb61eec2018-03-07 13:10:01 +0800874 if (HlslEnable16BitTypes)
875 messages = (EShMessages)(messages | EShMsgHlslEnable16BitTypes);
GregFfb03a552018-03-29 11:49:14 -0600876 if ((Options & EOptionOptimizeDisable) || !ENABLE_OPT)
877 messages = (EShMessages)(messages | EShMsgHlslLegalization);
John Kessenichbd1c1832018-12-07 18:38:26 -0700878 if (HlslDX9compatible)
879 messages = (EShMessages)(messages | EShMsgHlslDX9Compatible);
Christoph Kubisch55ba3ea2019-04-13 22:18:16 +0200880 if (DumpBuiltinSymbols)
881 messages = (EShMessages)(messages | EShMsgBuiltinSymbolTable);
John Kessenichb0a7eb52013-11-07 17:44:20 +0000882}
883
John Kessenich68d78fd2015-07-12 19:28:10 -0600884//
John Kessenich69f4b512013-09-04 21:19:27 +0000885// Thread entry point, for non-linking asynchronous mode.
John Kessenichc999ba22013-11-07 23:33:24 +0000886//
Juan Lopeza558b262017-04-02 23:04:00 +0200887void CompileShaders(glslang::TWorklist& worklist)
John Kessenich2b07c7e2013-07-31 18:44:13 +0000888{
John Kessenich7f0bcfd2018-04-05 19:00:01 -0600889 if (Options & EOptionDebug)
890 Error("cannot generate debug information unless linking to generate code");
891
John Kessenich38f3b892013-09-06 19:52:57 +0000892 glslang::TWorkItem* workItem;
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +0200893 if (Options & EOptionStdin) {
John Kesseniche7f9cae2018-07-12 15:11:07 -0600894 if (worklist.remove(workItem)) {
895 ShHandle compiler = ShConstructCompiler(FindLanguage("stdin"), Options);
896 if (compiler == nullptr)
897 return;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000898
John Kesseniche7f9cae2018-07-12 15:11:07 -0600899 CompileFile("stdin", compiler);
John Kessenich2b07c7e2013-07-31 18:44:13 +0000900
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +0200901 if (! (Options & EOptionSuppressInfolog))
902 workItem->results = ShGetInfoLog(compiler);
John Kessenich2b07c7e2013-07-31 18:44:13 +0000903
John Kesseniche7f9cae2018-07-12 15:11:07 -0600904 ShDestruct(compiler);
905 }
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +0200906 } else {
907 while (worklist.remove(workItem)) {
908 ShHandle compiler = ShConstructCompiler(FindLanguage(workItem->name), Options);
909 if (compiler == 0)
910 return;
911
912 CompileFile(workItem->name.c_str(), compiler);
913
914 if (! (Options & EOptionSuppressInfolog))
915 workItem->results = ShGetInfoLog(compiler);
916
917 ShDestruct(compiler);
918 }
John Kessenich2b07c7e2013-07-31 18:44:13 +0000919 }
John Kessenich2b07c7e2013-07-31 18:44:13 +0000920}
921
John Kessenich6626cad2015-06-19 05:14:19 +0000922// Outputs the given string, but only if it is non-null and non-empty.
923// This prevents erroneous newlines from appearing.
Andrew Woloszynaae1ad82015-06-24 17:00:46 -0400924void PutsIfNonEmpty(const char* str)
John Kessenich6626cad2015-06-19 05:14:19 +0000925{
926 if (str && str[0]) {
927 puts(str);
928 }
929}
930
Andrew Woloszynaae1ad82015-06-24 17:00:46 -0400931// Outputs the given string to stderr, but only if it is non-null and non-empty.
932// This prevents erroneous newlines from appearing.
933void StderrIfNonEmpty(const char* str)
934{
John Kessenich04acb1b2017-06-14 17:36:50 -0600935 if (str && str[0])
936 fprintf(stderr, "%s\n", str);
Andrew Woloszynaae1ad82015-06-24 17:00:46 -0400937}
938
John Kessenichc57b2a92016-01-16 15:30:03 -0700939// Simple bundling of what makes a compilation unit for ease in passing around,
940// and separation of handling file IO versus API (programmatic) compilation.
941struct ShaderCompUnit {
942 EShLanguage stage;
John Kessenich04acb1b2017-06-14 17:36:50 -0600943 static const int maxCount = 1;
944 int count; // live number of strings/names
John Kessenicha9313662017-06-15 10:40:49 -0600945 const char* text[maxCount]; // memory owned/managed externally
John Kessenich04acb1b2017-06-14 17:36:50 -0600946 std::string fileName[maxCount]; // hold's the memory, but...
947 const char* fileNameList[maxCount]; // downstream interface wants pointers
dankbakerafe6e9c2016-08-21 12:29:08 -0400948
John Kessenich04acb1b2017-06-14 17:36:50 -0600949 ShaderCompUnit(EShLanguage stage) : stage(stage), count(0) { }
dankbakerafe6e9c2016-08-21 12:29:08 -0400950
John Kessenich04acb1b2017-06-14 17:36:50 -0600951 ShaderCompUnit(const ShaderCompUnit& rhs)
dankbakerafe6e9c2016-08-21 12:29:08 -0400952 {
953 stage = rhs.stage;
John Kessenich04acb1b2017-06-14 17:36:50 -0600954 count = rhs.count;
955 for (int i = 0; i < count; ++i) {
956 fileName[i] = rhs.fileName[i];
957 text[i] = rhs.text[i];
958 fileNameList[i] = rhs.fileName[i].c_str();
959 }
dankbakerafe6e9c2016-08-21 12:29:08 -0400960 }
961
John Kessenicha9313662017-06-15 10:40:49 -0600962 void addString(std::string& ifileName, const char* itext)
John Kessenich04acb1b2017-06-14 17:36:50 -0600963 {
964 assert(count < maxCount);
965 fileName[count] = ifileName;
966 text[count] = itext;
967 fileNameList[count] = fileName[count].c_str();
968 ++count;
969 }
John Kessenichc57b2a92016-01-16 15:30:03 -0700970};
971
John Kessenich69f4b512013-09-04 21:19:27 +0000972//
John Kessenichc57b2a92016-01-16 15:30:03 -0700973// For linking mode: Will independently parse each compilation unit, but then put them
974// in the same program and link them together, making at most one linked module per
975// pipeline stage.
John Kessenich69f4b512013-09-04 21:19:27 +0000976//
977// Uses the new C++ interface instead of the old handle-based interface.
978//
John Kessenichc57b2a92016-01-16 15:30:03 -0700979
980void CompileAndLinkShaderUnits(std::vector<ShaderCompUnit> compUnits)
John Kessenich69f4b512013-09-04 21:19:27 +0000981{
982 // keep track of what to free
983 std::list<glslang::TShader*> shaders;
John Kessenichc57b2a92016-01-16 15:30:03 -0700984
John Kessenich69f4b512013-09-04 21:19:27 +0000985 EShMessages messages = EShMsgDefault;
John Kessenichb0a7eb52013-11-07 17:44:20 +0000986 SetMessageOptions(messages);
John Kessenich69f4b512013-09-04 21:19:27 +0000987
John Kessenich69f4b512013-09-04 21:19:27 +0000988 //
989 // Per-shader processing...
990 //
991
John Kessenich5b0f13a2013-11-01 03:08:40 +0000992 glslang::TProgram& program = *new glslang::TProgram;
rdb32084e82016-02-23 22:17:38 +0100993 for (auto it = compUnits.cbegin(); it != compUnits.cend(); ++it) {
994 const auto &compUnit = *it;
John Kessenichc57b2a92016-01-16 15:30:03 -0700995 glslang::TShader* shader = new glslang::TShader(compUnit.stage);
John Kessenich04acb1b2017-06-14 17:36:50 -0600996 shader->setStringsWithLengthsAndNames(compUnit.text, NULL, compUnit.fileNameList, compUnit.count);
John Kessenich640bd092018-08-09 14:15:00 -0600997 if (entryPointName)
John Kessenich4d65ee32016-03-12 18:17:47 -0700998 shader->setEntryPoint(entryPointName);
John Kessenich3693e632017-09-29 17:51:52 -0600999 if (sourceEntryPointName) {
1000 if (entryPointName == nullptr)
1001 printf("Warning: Changing source entry point name without setting an entry-point name.\n"
1002 "Use '-e <name>'.\n");
steve-lunargf1e0c872016-10-31 15:13:43 -06001003 shader->setSourceEntryPoint(sourceEntryPointName);
John Kessenich3693e632017-09-29 17:51:52 -06001004 }
John Kessenicha9313662017-06-15 10:40:49 -06001005 if (UserPreamble.isSet())
1006 shader->setPreamble(UserPreamble.get());
John Kessenich2a271162017-07-20 20:00:36 -06001007 shader->addProcesses(Processes);
steve-lunarg7f7c2ed2016-09-07 15:20:19 -06001008
John Kessenich155d3512019-08-08 23:29:20 -06001009#ifndef GLSLANG_WEB
LoopDawg08a14422017-10-17 19:27:14 -06001010 // Set IO mapper binding shift values
1011 for (int r = 0; r < glslang::EResCount; ++r) {
1012 const glslang::TResourceType res = glslang::TResourceType(r);
1013
1014 // Set base bindings
1015 shader->setShiftBinding(res, baseBinding[res][compUnit.stage]);
David Neto8c3d5b42019-10-21 14:50:31 -04001016
LoopDawg08a14422017-10-17 19:27:14 -06001017 // Set bindings for particular resource sets
1018 // TODO: use a range based for loop here, when available in all environments.
1019 for (auto i = baseBindingForSet[res][compUnit.stage].begin();
1020 i != baseBindingForSet[res][compUnit.stage].end(); ++i)
LoopDawge5709552017-10-21 10:46:39 -06001021 shader->setShiftBindingForSet(res, i->second, i->first);
LoopDawg08a14422017-10-17 19:27:14 -06001022 }
steve-lunargcce8d482016-10-14 18:36:42 -06001023 shader->setNoStorageFormat((Options & EOptionNoStorageFormat) != 0);
Hyangran Park36dc8292017-05-02 16:27:29 +09001024 shader->setResourceSetBinding(baseResourceSetBinding[compUnit.stage]);
steve-lunarg7f7c2ed2016-09-07 15:20:19 -06001025
1026 if (Options & EOptionAutoMapBindings)
1027 shader->setAutoMapBindings(true);
John Kessenichecba76f2017-01-06 00:34:48 -07001028
John Kessenich71facdf2017-05-17 18:28:19 -06001029 if (Options & EOptionAutoMapLocations)
1030 shader->setAutoMapLocations(true);
1031
Neil Roberts16f53472018-03-20 17:30:53 +01001032 for (auto& uniOverride : uniformLocationOverrides) {
1033 shader->addUniformLocationOverride(uniOverride.first.c_str(),
1034 uniOverride.second);
1035 }
1036
Neil Robertsb0f3d792018-03-20 17:41:05 +01001037 shader->setUniformLocationBase(uniformBase);
John Kessenich155d3512019-08-08 23:29:20 -06001038#endif
1039
1040 shader->setNanMinMaxClamp(NaNClamp);
1041
1042#ifdef ENABLE_HLSL
1043 shader->setFlattenUniformArrays((Options & EOptionFlattenUniformArrays) != 0);
1044 if (Options & EOptionHlslIoMapping)
1045 shader->setHlslIoMapping(true);
1046#endif
1047
1048 if (Options & EOptionInvertY)
1049 shader->setInvertY(true);
Neil Robertsb0f3d792018-03-20 17:41:05 +01001050
John Kessenich4be4aeb2017-06-23 10:50:22 -06001051 // Set up the environment, some subsettings take precedence over earlier
1052 // ways of setting things.
1053 if (Options & EOptionSpv) {
John Kessenich8717a5d2018-10-26 10:12:32 -06001054 shader->setEnvInput((Options & EOptionReadHlsl) ? glslang::EShSourceHlsl
1055 : glslang::EShSourceGlsl,
1056 compUnit.stage, Client, ClientInputSemanticsVersion);
1057 shader->setEnvClient(Client, ClientVersion);
1058 shader->setEnvTarget(TargetLanguage, TargetVersion);
John Kessenichd4ed5152019-07-27 05:22:30 -06001059#ifdef ENABLE_HLSL
John Kessenich5d610ee2018-03-07 18:05:55 -07001060 if (targetHlslFunctionality1)
1061 shader->setEnvTargetHlslFunctionality1();
John Kessenichd4ed5152019-07-27 05:22:30 -06001062#endif
John Kessenich4be4aeb2017-06-23 10:50:22 -06001063 }
1064
John Kessenich69f4b512013-09-04 21:19:27 +00001065 shaders.push_back(shader);
John Kessenichb3297152015-07-11 18:01:03 -06001066
John Kessenich4be4aeb2017-06-23 10:50:22 -06001067 const int defaultVersion = Options & EOptionDefaultDesktop ? 110 : 100;
John Kessenich69f4b512013-09-04 21:19:27 +00001068
John Kessenich3494b4d2017-05-22 15:00:42 -06001069 DirStackFileIncluder includer;
John Kessenich971a0a82017-06-07 15:06:58 -06001070 std::for_each(IncludeDirectoryList.rbegin(), IncludeDirectoryList.rend(), [&includer](const std::string& dir) {
1071 includer.pushExternalLocalDirectory(dir); });
John Kessenichdeec1932019-08-13 08:00:30 -06001072#ifndef GLSLANG_WEB
John Kessenichc555ddd2015-06-17 02:38:44 +00001073 if (Options & EOptionOutputPreprocessed) {
1074 std::string str;
John Kessenich086febc2018-10-25 12:43:02 -06001075 if (shader->preprocess(&Resources, defaultVersion, ENoProfile, false, false, messages, &str, includer)) {
Andrew Woloszynaae1ad82015-06-24 17:00:46 -04001076 PutsIfNonEmpty(str.c_str());
1077 } else {
1078 CompileFailed = true;
1079 }
1080 StderrIfNonEmpty(shader->getInfoLog());
1081 StderrIfNonEmpty(shader->getInfoDebugLog());
John Kessenichc555ddd2015-06-17 02:38:44 +00001082 continue;
1083 }
John Kessenichdeec1932019-08-13 08:00:30 -06001084#endif
John Kessenich086febc2018-10-25 12:43:02 -06001085
John Kessenich3494b4d2017-05-22 15:00:42 -06001086 if (! shader->parse(&Resources, defaultVersion, false, messages, includer))
John Kessenichc999ba22013-11-07 23:33:24 +00001087 CompileFailed = true;
John Kessenichc555ddd2015-06-17 02:38:44 +00001088
John Kessenich69f4b512013-09-04 21:19:27 +00001089 program.addShader(shader);
1090
John Kessenichc57b2a92016-01-16 15:30:03 -07001091 if (! (Options & EOptionSuppressInfolog) &&
1092 ! (Options & EOptionMemoryLeakMode)) {
John Kessenich04acb1b2017-06-14 17:36:50 -06001093 PutsIfNonEmpty(compUnit.fileName[0].c_str());
Andrew Woloszynaae1ad82015-06-24 17:00:46 -04001094 PutsIfNonEmpty(shader->getInfoLog());
1095 PutsIfNonEmpty(shader->getInfoDebugLog());
John Kessenich69f4b512013-09-04 21:19:27 +00001096 }
John Kessenich69f4b512013-09-04 21:19:27 +00001097 }
1098
1099 //
1100 // Program-level processing...
1101 //
1102
John Kessenich4d65ee32016-03-12 18:17:47 -07001103 // Link
John Kessenich68d78fd2015-07-12 19:28:10 -06001104 if (! (Options & EOptionOutputPreprocessed) && ! program.link(messages))
John Kessenichc999ba22013-11-07 23:33:24 +00001105 LinkFailed = true;
1106
John Kessenichb6d3ee52019-08-06 02:20:45 -06001107#ifndef GLSLANG_WEB
steve-lunarg9ae34742016-10-05 13:40:13 -06001108 // Map IO
1109 if (Options & EOptionSpv) {
1110 if (!program.mapIO())
1111 LinkFailed = true;
1112 }
John Kessenichb6d3ee52019-08-06 02:20:45 -06001113#endif
John Kessenichecba76f2017-01-06 00:34:48 -07001114
John Kessenich4d65ee32016-03-12 18:17:47 -07001115 // Report
John Kessenichc57b2a92016-01-16 15:30:03 -07001116 if (! (Options & EOptionSuppressInfolog) &&
1117 ! (Options & EOptionMemoryLeakMode)) {
Andrew Woloszynaae1ad82015-06-24 17:00:46 -04001118 PutsIfNonEmpty(program.getInfoLog());
1119 PutsIfNonEmpty(program.getInfoDebugLog());
John Kessenich69f4b512013-09-04 21:19:27 +00001120 }
1121
John Kessenichb6d3ee52019-08-06 02:20:45 -06001122#ifndef GLSLANG_WEB
John Kessenich4d65ee32016-03-12 18:17:47 -07001123 // Reflect
John Kessenich11f9fc72013-11-07 01:06:34 +00001124 if (Options & EOptionDumpReflection) {
baldurk6d477852019-01-29 15:45:56 +00001125 program.buildReflection(ReflectOptions);
John Kessenich11f9fc72013-11-07 01:06:34 +00001126 program.dumpReflection();
1127 }
John Kessenichb6d3ee52019-08-06 02:20:45 -06001128#endif
John Kessenich11f9fc72013-11-07 01:06:34 +00001129
John Kessenich4d65ee32016-03-12 18:17:47 -07001130 // Dump SPIR-V
John Kessenich0df0cde2015-03-03 17:09:43 +00001131 if (Options & EOptionSpv) {
John Kessenich92f90382014-07-28 04:21:04 +00001132 if (CompileFailed || LinkFailed)
John Kessenich68d78fd2015-07-12 19:28:10 -06001133 printf("SPIR-V is not generated for failed compile or link\n");
John Kessenich92f90382014-07-28 04:21:04 +00001134 else {
1135 for (int stage = 0; stage < EShLangCount; ++stage) {
John Kessenicha7a68a92014-08-24 18:21:00 +00001136 if (program.getIntermediate((EShLanguage)stage)) {
John Kessenich0df0cde2015-03-03 17:09:43 +00001137 std::vector<unsigned int> spirv;
Lei Zhang09caf122016-05-02 18:11:54 -04001138 std::string warningsErrors;
Lei Zhang17535f72016-05-04 15:55:59 -04001139 spv::SpvBuildLogger logger;
John Kessenich121853f2017-05-31 17:11:16 -06001140 glslang::SpvOptions spvOptions;
1141 if (Options & EOptionDebug)
1142 spvOptions.generateDebugInfo = true;
GregF52fe3d52017-09-28 10:08:32 -06001143 spvOptions.disableOptimizer = (Options & EOptionOptimizeDisable) != 0;
1144 spvOptions.optimizeSize = (Options & EOptionOptimizeSize) != 0;
John Kessenich717c80a2018-08-23 15:17:10 -06001145 spvOptions.disassemble = SpvToolsDisassembler;
John Kessenichc3404252018-08-23 15:29:08 -06001146 spvOptions.validate = SpvToolsValidate;
John Kessenich121853f2017-05-31 17:11:16 -06001147 glslang::GlslangToSpv(*program.getIntermediate((EShLanguage)stage), spirv, &logger, &spvOptions);
John Kessenichc57b2a92016-01-16 15:30:03 -07001148
1149 // Dump the spv to a file or stdout, etc., but only if not doing
1150 // memory/perf testing, as it's not internal to programmatic use.
1151 if (! (Options & EOptionMemoryLeakMode)) {
Johannes van Waverenecb0f3b2016-05-27 12:55:53 -05001152 printf("%s", logger.getAllMessages().c_str());
1153 if (Options & EOptionOutputHexadecimal) {
John Kessenich8f674e82017-02-18 09:45:40 -07001154 glslang::OutputSpvHex(spirv, GetBinaryName((EShLanguage)stage), variableName);
Johannes van Waverenecb0f3b2016-05-27 12:55:53 -05001155 } else {
1156 glslang::OutputSpvBin(spirv, GetBinaryName((EShLanguage)stage));
1157 }
John Kessenich23d27752019-07-28 02:12:10 -06001158#ifndef GLSLANG_WEB
John Kesseniche2156222018-06-11 18:12:15 -06001159 if (!SpvToolsDisassembler && (Options & EOptionHumanReadableSpv))
John Kessenichc57b2a92016-01-16 15:30:03 -07001160 spv::Disassemble(std::cout, spirv);
John Kessenich23d27752019-07-28 02:12:10 -06001161#endif
John Kessenichacba7722015-03-04 03:48:38 +00001162 }
John Kessenicha7a68a92014-08-24 18:21:00 +00001163 }
John Kessenich92f90382014-07-28 04:21:04 +00001164 }
1165 }
1166 }
1167
John Kessenich5b0f13a2013-11-01 03:08:40 +00001168 // Free everything up, program has to go before the shaders
1169 // because it might have merged stuff from the shaders, and
1170 // the stuff from the shaders has to have its destructors called
1171 // before the pools holding the memory in the shaders is freed.
1172 delete &program;
John Kessenich69f4b512013-09-04 21:19:27 +00001173 while (shaders.size() > 0) {
1174 delete shaders.back();
1175 shaders.pop_back();
1176 }
John Kessenich69f4b512013-09-04 21:19:27 +00001177}
1178
John Kessenichc57b2a92016-01-16 15:30:03 -07001179//
1180// Do file IO part of compile and link, handing off the pure
1181// API/programmatic mode to CompileAndLinkShaderUnits(), which can
1182// be put in a loop for testing memory footprint and performance.
1183//
1184// This is just for linking mode: meaning all the shaders will be put into the
1185// the same program linked together.
1186//
1187// This means there are a limited number of work items (not multi-threading mode)
1188// and that the point is testing at the linking level. Hence, to enable
1189// performance and memory testing, the actual compile/link can be put in
1190// a loop, independent of processing the work items and file IO.
1191//
Juan Lopeza558b262017-04-02 23:04:00 +02001192void CompileAndLinkShaderFiles(glslang::TWorklist& Worklist)
John Kessenichc57b2a92016-01-16 15:30:03 -07001193{
1194 std::vector<ShaderCompUnit> compUnits;
1195
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001196 // If this is using stdin, we can't really detect multiple different file
1197 // units by input type. We need to assume that we're just being given one
1198 // file of a certain type.
1199 if ((Options & EOptionStdin) != 0) {
1200 ShaderCompUnit compUnit(FindLanguage("stdin"));
1201 std::istreambuf_iterator<char> begin(std::cin), end;
1202 std::string tempString(begin, end);
1203 char* fileText = strdup(tempString.c_str());
1204 std::string fileName = "stdin";
1205 compUnit.addString(fileName, fileText);
John Kessenichc57b2a92016-01-16 15:30:03 -07001206 compUnits.push_back(compUnit);
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001207 } else {
1208 // Transfer all the work items from to a simple list of
1209 // of compilation units. (We don't care about the thread
1210 // work-item distribution properties in this path, which
1211 // is okay due to the limited number of shaders, know since
1212 // they are all getting linked together.)
1213 glslang::TWorkItem* workItem;
1214 while (Worklist.remove(workItem)) {
1215 ShaderCompUnit compUnit(FindLanguage(workItem->name));
1216 char* fileText = ReadFileData(workItem->name.c_str());
1217 if (fileText == nullptr)
1218 usage();
1219 compUnit.addString(workItem->name, fileText);
1220 compUnits.push_back(compUnit);
1221 }
John Kessenichc57b2a92016-01-16 15:30:03 -07001222 }
1223
1224 // Actual call to programmatic processing of compile and link,
1225 // in a loop for testing memory and performance. This part contains
1226 // all the perf/memory that a programmatic consumer will care about.
1227 for (int i = 0; i < ((Options & EOptionMemoryLeakMode) ? 100 : 1); ++i) {
1228 for (int j = 0; j < ((Options & EOptionMemoryLeakMode) ? 100 : 1); ++j)
1229 CompileAndLinkShaderUnits(compUnits);
1230
1231 if (Options & EOptionMemoryLeakMode)
1232 glslang::OS_DumpMemoryCounters();
1233 }
1234
John Kessenicha9313662017-06-15 10:40:49 -06001235 // free memory from ReadFileData, which got stored in a const char*
1236 // as the first string above
rdb32084e82016-02-23 22:17:38 +01001237 for (auto it = compUnits.begin(); it != compUnits.end(); ++it)
John Kessenicha9313662017-06-15 10:40:49 -06001238 FreeFileData(const_cast<char*>(it->text[0]));
John Kessenichc57b2a92016-01-16 15:30:03 -07001239}
1240
John Kessenich94f28eb2017-11-13 01:32:06 -07001241int singleMain()
John Kessenicha0af4732012-12-12 21:15:54 +00001242{
Juan Lopeza558b262017-04-02 23:04:00 +02001243 glslang::TWorklist workList;
John Kessenich94f28eb2017-11-13 01:32:06 -07001244 std::for_each(WorkItems.begin(), WorkItems.end(), [&workList](std::unique_ptr<glslang::TWorkItem>& item) {
Juan Lopeza558b262017-04-02 23:04:00 +02001245 assert(item);
1246 workList.add(item.get());
1247 });
John Kessenich2b07c7e2013-07-31 18:44:13 +00001248
John Kessenich23d27752019-07-28 02:12:10 -06001249#ifndef GLSLANG_WEB
John Kessenich05a70632013-09-17 19:26:08 +00001250 if (Options & EOptionDumpConfig) {
Lei Zhang414eb602016-03-04 16:22:34 -05001251 printf("%s", glslang::GetDefaultTBuiltInResourceString().c_str());
Juan Lopeza558b262017-04-02 23:04:00 +02001252 if (workList.empty())
John Kessenich05a70632013-09-17 19:26:08 +00001253 return ESuccess;
1254 }
John Kessenich23d27752019-07-28 02:12:10 -06001255#endif
John Kessenich05a70632013-09-17 19:26:08 +00001256
John Kessenichc6c80a62018-03-05 22:23:17 -07001257 if (Options & EOptionDumpBareVersion) {
1258 printf("%d.%d.%d\n",
1259 glslang::GetSpirvGeneratorVersion(), GLSLANG_MINOR_VERSION, GLSLANG_PATCH_LEVEL);
1260 if (workList.empty())
1261 return ESuccess;
1262 } else if (Options & EOptionDumpVersions) {
1263 printf("Glslang Version: %d.%d.%d\n",
1264 glslang::GetSpirvGeneratorVersion(), GLSLANG_MINOR_VERSION, GLSLANG_PATCH_LEVEL);
John Kessenich319de232013-12-04 04:43:40 +00001265 printf("ESSL Version: %s\n", glslang::GetEsslVersionString());
1266 printf("GLSL Version: %s\n", glslang::GetGlslVersionString());
John Kessenich68d78fd2015-07-12 19:28:10 -06001267 std::string spirvVersion;
1268 glslang::GetSpirvVersion(spirvVersion);
John Kessenich0da9eaa2015-08-01 17:10:02 -06001269 printf("SPIR-V Version %s\n", spirvVersion.c_str());
John Kessenich5e4b1242015-08-06 22:53:06 -06001270 printf("GLSL.std.450 Version %d, Revision %d\n", GLSLstd450Version, GLSLstd450Revision);
John Kessenich55e7d112015-11-15 21:33:39 -07001271 printf("Khronos Tool ID %d\n", glslang::GetKhronosToolId());
John Kessenicha372a3e2017-11-02 22:32:14 -06001272 printf("SPIR-V Generator Version %d\n", glslang::GetSpirvGeneratorVersion());
John Kessenichb84313d2016-07-20 16:03:29 -06001273 printf("GL_KHR_vulkan_glsl version %d\n", 100);
1274 printf("ARB_GL_gl_spirv version %d\n", 100);
Juan Lopeza558b262017-04-02 23:04:00 +02001275 if (workList.empty())
John Kessenich319de232013-12-04 04:43:40 +00001276 return ESuccess;
1277 }
1278
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001279 if (workList.empty() && ((Options & EOptionStdin) == 0)) {
John Kessenich05a70632013-09-17 19:26:08 +00001280 usage();
John Kessenich05a70632013-09-17 19:26:08 +00001281 }
1282
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001283 if (Options & EOptionStdin) {
John Kessenich94f28eb2017-11-13 01:32:06 -07001284 WorkItems.push_back(std::unique_ptr<glslang::TWorkItem>{new glslang::TWorkItem("stdin")});
1285 workList.add(WorkItems.back().get());
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001286 }
1287
John Kessenich05a70632013-09-17 19:26:08 +00001288 ProcessConfigFile();
1289
John Kessenich086febc2018-10-25 12:43:02 -06001290 if ((Options & EOptionReadHlsl) && !((Options & EOptionOutputPreprocessed) || (Options & EOptionSpv)))
John Kessenichbd97b6f2019-12-20 10:33:13 -07001291 Error("HLSL requires SPIR-V code generation (or preprocessing only)");
John Kessenich086febc2018-10-25 12:43:02 -06001292
John Kessenich69f4b512013-09-04 21:19:27 +00001293 //
1294 // Two modes:
John Kessenich38f3b892013-09-06 19:52:57 +00001295 // 1) linking all arguments together, single-threaded, new C++ interface
1296 // 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 +00001297 //
John Kessenich086febc2018-10-25 12:43:02 -06001298 if (Options & (EOptionLinkProgram | EOptionOutputPreprocessed)) {
John Kessenichc36e1d82013-11-01 17:41:52 +00001299 glslang::InitializeProcess();
John Kesseniche2c15b42017-11-16 22:48:41 -07001300 glslang::InitializeProcess(); // also test reference counting of users
1301 glslang::InitializeProcess(); // also test reference counting of users
1302 glslang::FinalizeProcess(); // also test reference counting of users
1303 glslang::FinalizeProcess(); // also test reference counting of users
Juan Lopeza558b262017-04-02 23:04:00 +02001304 CompileAndLinkShaderFiles(workList);
John Kessenichc36e1d82013-11-01 17:41:52 +00001305 glslang::FinalizeProcess();
1306 } else {
1307 ShInitialize();
John Kesseniche2c15b42017-11-16 22:48:41 -07001308 ShInitialize(); // also test reference counting of users
1309 ShFinalize(); // also test reference counting of users
John Kessenichc36e1d82013-11-01 17:41:52 +00001310
Juan Lopeza558b262017-04-02 23:04:00 +02001311 bool printShaderNames = workList.size() > 1;
John Kessenich69f4b512013-09-04 21:19:27 +00001312
John Kesseniche2c15b42017-11-16 22:48:41 -07001313 if (Options & EOptionMultiThreaded) {
Juan Lopeza558b262017-04-02 23:04:00 +02001314 std::array<std::thread, 16> threads;
John Kesseniche2c15b42017-11-16 22:48:41 -07001315 for (unsigned int t = 0; t < threads.size(); ++t) {
Juan Lopeza558b262017-04-02 23:04:00 +02001316 threads[t] = std::thread(CompileShaders, std::ref(workList));
John Kesseniche2c15b42017-11-16 22:48:41 -07001317 if (threads[t].get_id() == std::thread::id()) {
John Kessenichaf527992017-11-02 22:48:15 -06001318 fprintf(stderr, "Failed to create thread\n");
John Kessenich38f3b892013-09-06 19:52:57 +00001319 return EFailThreadCreate;
1320 }
John Kessenicha0af4732012-12-12 21:15:54 +00001321 }
Juan Lopeza558b262017-04-02 23:04:00 +02001322
1323 std::for_each(threads.begin(), threads.end(), [](std::thread& t) { t.join(); });
John Kessenichc999ba22013-11-07 23:33:24 +00001324 } else
Juan Lopeza558b262017-04-02 23:04:00 +02001325 CompileShaders(workList);
John Kessenich38f3b892013-09-06 19:52:57 +00001326
1327 // Print out all the resulting infologs
John Kessenich94f28eb2017-11-13 01:32:06 -07001328 for (size_t w = 0; w < WorkItems.size(); ++w) {
1329 if (WorkItems[w]) {
1330 if (printShaderNames || WorkItems[w]->results.size() > 0)
1331 PutsIfNonEmpty(WorkItems[w]->name.c_str());
1332 PutsIfNonEmpty(WorkItems[w]->results.c_str());
John Kessenich38f3b892013-09-06 19:52:57 +00001333 }
1334 }
John Kessenichc36e1d82013-11-01 17:41:52 +00001335
1336 ShFinalize();
John Kessenicha0af4732012-12-12 21:15:54 +00001337 }
John Kessenich2b07c7e2013-07-31 18:44:13 +00001338
John Kessenichc999ba22013-11-07 23:33:24 +00001339 if (CompileFailed)
John Kessenicha0af4732012-12-12 21:15:54 +00001340 return EFailCompile;
John Kessenichc999ba22013-11-07 23:33:24 +00001341 if (LinkFailed)
John Kessenicha0af4732012-12-12 21:15:54 +00001342 return EFailLink;
1343
1344 return 0;
1345}
1346
John Kessenich94f28eb2017-11-13 01:32:06 -07001347int C_DECL main(int argc, char* argv[])
1348{
1349 ProcessArguments(WorkItems, argc, argv);
1350
1351 int ret = 0;
1352
1353 // Loop over the entire init/finalize cycle to watch memory changes
1354 const int iterations = 1;
1355 if (iterations > 1)
1356 glslang::OS_DumpMemoryCounters();
1357 for (int i = 0; i < iterations; ++i) {
1358 ret = singleMain();
1359 if (iterations > 1)
1360 glslang::OS_DumpMemoryCounters();
1361 }
1362
1363 return ret;
1364}
1365
John Kessenicha0af4732012-12-12 21:15:54 +00001366//
1367// Deduce the language from the filename. Files must end in one of the
1368// following extensions:
1369//
John Kessenich2b07c7e2013-07-31 18:44:13 +00001370// .vert = vertex
1371// .tesc = tessellation control
1372// .tese = tessellation evaluation
1373// .geom = geometry
1374// .frag = fragment
John Kessenich94a81fb2013-08-31 02:41:30 +00001375// .comp = compute
Chao Chenb50c02e2018-09-19 11:42:24 -07001376// .rgen = ray generation
1377// .rint = ray intersection
1378// .rahit = ray any hit
1379// .rchit = ray closest hit
1380// .rmiss = ray miss
1381// .rcall = ray callable
Sahil Parmar035cbbe2018-10-04 16:39:18 -07001382// .mesh = mesh
1383// .task = task
Grigory Dzhavadyan33507412018-04-12 14:35:24 -07001384// Additionally, the file names may end in .<stage>.glsl and .<stage>.hlsl
1385// where <stage> is one of the stages listed above.
1386//
1387EShLanguage FindLanguage(const std::string& name, bool parseStageName)
John Kessenicha0af4732012-12-12 21:15:54 +00001388{
John Kessenichfccbb8b2018-04-17 17:24:03 -06001389 std::string stageName;
Dan Bakerc6ede892016-08-11 14:06:06 -04001390 if (shaderStageName)
John Kessenichfccbb8b2018-04-17 17:24:03 -06001391 stageName = shaderStageName;
1392 else if (parseStageName) {
Grigory Dzhavadyan33507412018-04-12 14:35:24 -07001393 // Note: "first" extension means "first from the end", i.e.
1394 // if the file is named foo.vert.glsl, then "glsl" is first,
1395 // "vert" is second.
John Kessenichfccbb8b2018-04-17 17:24:03 -06001396 size_t firstExtStart = name.find_last_of(".");
1397 bool hasFirstExt = firstExtStart != std::string::npos;
1398 size_t secondExtStart = hasFirstExt ? name.find_last_of(".", firstExtStart - 1) : std::string::npos;
1399 bool hasSecondExt = secondExtStart != std::string::npos;
1400 std::string firstExt = name.substr(firstExtStart + 1, std::string::npos);
1401 bool usesUnifiedExt = hasFirstExt && (firstExt == "glsl" || firstExt == "hlsl");
John Kessenich3beac942018-04-17 21:02:19 -06001402 if (usesUnifiedExt && firstExt == "hlsl")
1403 Options |= EOptionReadHlsl;
1404 if (hasFirstExt && !usesUnifiedExt)
John Kessenichfccbb8b2018-04-17 17:24:03 -06001405 stageName = firstExt;
John Kessenich3beac942018-04-17 21:02:19 -06001406 else if (usesUnifiedExt && hasSecondExt)
John Kessenichfccbb8b2018-04-17 17:24:03 -06001407 stageName = name.substr(secondExtStart + 1, firstExtStart - secondExtStart - 1);
John Kessenich3beac942018-04-17 21:02:19 -06001408 else {
Grigory Dzhavadyan33507412018-04-12 14:35:24 -07001409 usage();
1410 return EShLangVertex;
John Kesseniche751bca2017-03-16 11:20:38 -06001411 }
John Kessenichfccbb8b2018-04-17 17:24:03 -06001412 } else
1413 stageName = name;
dankbaker45d49bc2016-08-08 21:43:07 -04001414
John Kessenichfccbb8b2018-04-17 17:24:03 -06001415 if (stageName == "vert")
John Kessenich2b07c7e2013-07-31 18:44:13 +00001416 return EShLangVertex;
John Kessenichfccbb8b2018-04-17 17:24:03 -06001417 else if (stageName == "tesc")
John Kessenich2b07c7e2013-07-31 18:44:13 +00001418 return EShLangTessControl;
John Kessenichfccbb8b2018-04-17 17:24:03 -06001419 else if (stageName == "tese")
John Kessenich2b07c7e2013-07-31 18:44:13 +00001420 return EShLangTessEvaluation;
John Kessenichfccbb8b2018-04-17 17:24:03 -06001421 else if (stageName == "geom")
John Kessenich2b07c7e2013-07-31 18:44:13 +00001422 return EShLangGeometry;
John Kessenichfccbb8b2018-04-17 17:24:03 -06001423 else if (stageName == "frag")
John Kessenich2b07c7e2013-07-31 18:44:13 +00001424 return EShLangFragment;
John Kessenichfccbb8b2018-04-17 17:24:03 -06001425 else if (stageName == "comp")
John Kessenichc0275792013-08-09 17:14:49 +00001426 return EShLangCompute;
Chao Chenb50c02e2018-09-19 11:42:24 -07001427 else if (stageName == "rgen")
1428 return EShLangRayGenNV;
1429 else if (stageName == "rint")
1430 return EShLangIntersectNV;
1431 else if (stageName == "rahit")
1432 return EShLangAnyHitNV;
1433 else if (stageName == "rchit")
1434 return EShLangClosestHitNV;
1435 else if (stageName == "rmiss")
1436 return EShLangMissNV;
1437 else if (stageName == "rcall")
1438 return EShLangCallableNV;
Chao Chen3c366992018-09-19 11:41:59 -07001439 else if (stageName == "mesh")
1440 return EShLangMeshNV;
1441 else if (stageName == "task")
1442 return EShLangTaskNV;
John Kessenich2b07c7e2013-07-31 18:44:13 +00001443
1444 usage();
John Kesseniche95ecc52012-12-12 21:34:14 +00001445 return EShLangVertex;
John Kessenicha0af4732012-12-12 21:15:54 +00001446}
1447
John Kessenicha0af4732012-12-12 21:15:54 +00001448//
John Kessenichecba76f2017-01-06 00:34:48 -07001449// Read a file's data into a string, and compile it using the old interface ShCompile,
John Kessenich69f4b512013-09-04 21:19:27 +00001450// for non-linkable results.
John Kessenicha0af4732012-12-12 21:15:54 +00001451//
John Kessenich51cdd902014-02-18 23:37:57 +00001452void CompileFile(const char* fileName, ShHandle compiler)
John Kessenicha0af4732012-12-12 21:15:54 +00001453{
John Kessenichca3457f2015-05-18 01:59:45 +00001454 int ret = 0;
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001455 char* shaderString;
1456 if ((Options & EOptionStdin) != 0) {
1457 std::istreambuf_iterator<char> begin(std::cin), end;
1458 std::string tempString(begin, end);
1459 shaderString = strdup(tempString.c_str());
1460 } else {
1461 shaderString = ReadFileData(fileName);
1462 }
John Kessenich41cf6b52013-06-25 18:10:05 +00001463
1464 // move to length-based strings, rather than null-terminated strings
John Kessenich04acb1b2017-06-14 17:36:50 -06001465 int* lengths = new int[1];
1466 lengths[0] = (int)strlen(shaderString);
John Kessenicha0af4732012-12-12 21:15:54 +00001467
John Kessenich52ac67e2013-05-05 23:46:22 +00001468 EShMessages messages = EShMsgDefault;
John Kessenichb0a7eb52013-11-07 17:44:20 +00001469 SetMessageOptions(messages);
John Kessenichecba76f2017-01-06 00:34:48 -07001470
John Kessenicha9313662017-06-15 10:40:49 -06001471 if (UserPreamble.isSet())
1472 Error("-D and -U options require -l (linking)\n");
1473
John Kessenich94a81fb2013-08-31 02:41:30 +00001474 for (int i = 0; i < ((Options & EOptionMemoryLeakMode) ? 100 : 1); ++i) {
1475 for (int j = 0; j < ((Options & EOptionMemoryLeakMode) ? 100 : 1); ++j) {
John Kessenich927608b2017-01-06 12:34:14 -07001476 // ret = ShCompile(compiler, shaderStrings, NumShaderStrings, lengths, EShOptNone, &Resources, Options, (Options & EOptionDefaultDesktop) ? 110 : 100, false, messages);
John Kessenich04acb1b2017-06-14 17:36:50 -06001477 ret = ShCompile(compiler, &shaderString, 1, nullptr, EShOptNone, &Resources, Options, (Options & EOptionDefaultDesktop) ? 110 : 100, false, messages);
John Kessenich927608b2017-01-06 12:34:14 -07001478 // const char* multi[12] = { "# ve", "rsion", " 300 e", "s", "\n#err",
John Kessenichecba76f2017-01-06 00:34:48 -07001479 // "or should be l", "ine 1", "string 5\n", "float glo", "bal",
John Kessenichea869fb2013-10-28 18:12:06 +00001480 // ";\n#error should be line 2\n void main() {", "global = 2.3;}" };
John Kessenich927608b2017-01-06 12:34:14 -07001481 // const char* multi[7] = { "/", "/", "\\", "\n", "\n", "#", "version 300 es" };
1482 // ret = ShCompile(compiler, multi, 7, nullptr, EShOptNone, &Resources, Options, (Options & EOptionDefaultDesktop) ? 110 : 100, false, messages);
John Kessenich41cf6b52013-06-25 18:10:05 +00001483 }
John Kessenicha0af4732012-12-12 21:15:54 +00001484
John Kessenich94a81fb2013-08-31 02:41:30 +00001485 if (Options & EOptionMemoryLeakMode)
John Kessenich2b07c7e2013-07-31 18:44:13 +00001486 glslang::OS_DumpMemoryCounters();
John Kessenicha0af4732012-12-12 21:15:54 +00001487 }
John Kessenicha0af4732012-12-12 21:15:54 +00001488
John Kessenich41cf6b52013-06-25 18:10:05 +00001489 delete [] lengths;
John Kessenich04acb1b2017-06-14 17:36:50 -06001490 FreeFileData(shaderString);
John Kessenicha0af4732012-12-12 21:15:54 +00001491
John Kessenichc999ba22013-11-07 23:33:24 +00001492 if (ret == 0)
1493 CompileFailed = true;
John Kessenicha0af4732012-12-12 21:15:54 +00001494}
1495
John Kessenicha0af4732012-12-12 21:15:54 +00001496//
1497// print usage to stdout
1498//
1499void usage()
1500{
John Kessenich319de232013-12-04 04:43:40 +00001501 printf("Usage: glslangValidator [option]... [file]...\n"
1502 "\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001503 "'file' can end in .<stage> for auto-stage classification, where <stage> is:\n"
1504 " .conf to provide a config file that replaces the default configuration\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001505 " (see -c option below for generating a template)\n"
1506 " .vert for a vertex shader\n"
1507 " .tesc for a tessellation control shader\n"
1508 " .tese for a tessellation evaluation shader\n"
1509 " .geom for a geometry shader\n"
1510 " .frag for a fragment shader\n"
1511 " .comp for a compute shader\n"
Chao Chen3c366992018-09-19 11:41:59 -07001512 " .mesh for a mesh shader\n"
1513 " .task for a task shader\n"
Chao Chenb50c02e2018-09-19 11:42:24 -07001514 " .rgen for a ray generation shader\n"
1515 " .rint for a ray intersection shader\n"
1516 " .rahit for a ray any hit shader\n"
1517 " .rchit for a ray closest hit shader\n"
1518 " .rmiss for a ray miss shader\n"
Sahil Parmar035cbbe2018-10-04 16:39:18 -07001519 " .rcall for a ray callable shader\n"
John Kessenich2ead40f2018-04-17 17:44:11 -06001520 " .glsl for .vert.glsl, .tesc.glsl, ..., .comp.glsl compound suffixes\n"
1521 " .hlsl for .vert.hlsl, .tesc.hlsl, ..., .comp.hlsl compound suffixes\n"
John Kessenich319de232013-12-04 04:43:40 +00001522 "\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001523 "Options:\n"
1524 " -C cascading errors; risk crash from accumulation of error recoveries\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001525 " -D input is HLSL (this is the default when any suffix is .hlsl)\n"
John Kessenich6f988922020-01-07 07:03:11 -07001526 " -D<name[=def]> | --define-macro <name[=def]> | --D <name[=def]>\n"
1527 " define a pre-processor macro\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001528 " -E print pre-processed GLSL; cannot be used with -l;\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001529 " errors will appear on stderr\n"
John Kessenich6353d552017-06-23 11:11:09 -06001530 " -G[ver] create SPIR-V binary, under OpenGL semantics; turns on -l;\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001531 " default file name is <stage>.spv (-o overrides this);\n"
John Kessenich6353d552017-06-23 11:11:09 -06001532 " 'ver', when present, is the version of the input semantics,\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001533 " which will appear in #define GL_SPIRV ver;\n"
1534 " '--client opengl100' is the same as -G100;\n"
John Kessenich6353d552017-06-23 11:11:09 -06001535 " a '--target-env' for OpenGL will also imply '-G'\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001536 " -H print human readable form of SPIR-V; turns on -V\n"
John Kessenich971a0a82017-06-07 15:06:58 -06001537 " -I<dir> add dir to the include search path; includer's directory\n"
1538 " is searched first, followed by left-to-right order of -I\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001539 " -Od disables optimization; may cause illegal SPIR-V for HLSL\n"
1540 " -Os optimizes SPIR-V to minimize size\n"
John Kesseniche751bca2017-03-16 11:20:38 -06001541 " -S <stage> uses specified stage rather than parsing the file extension\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001542 " choices for <stage> are vert, tesc, tese, geom, frag, or comp\n"
John Kessenich6f988922020-01-07 07:03:11 -07001543 " -U<name> | --undef-macro <name> | --U <name>\n"
1544 " undefine a pre-processor macro\n"
John Kessenich6353d552017-06-23 11:11:09 -06001545 " -V[ver] create SPIR-V binary, under Vulkan semantics; turns on -l;\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001546 " default file name is <stage>.spv (-o overrides this)\n"
John Kessenich6353d552017-06-23 11:11:09 -06001547 " 'ver', when present, is the version of the input semantics,\n"
1548 " which will appear in #define VULKAN ver\n"
1549 " '--client vulkan100' is the same as -V100\n"
1550 " a '--target-env' for Vulkan will also imply '-V'\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001551 " -c configuration dump;\n"
1552 " creates the default configuration file (redirect to a .conf file)\n"
1553 " -d default to desktop (#version 110) when there is no shader #version\n"
1554 " (default is ES version 100)\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001555 " -e <name> | --entry-point <name>\n"
1556 " specify <name> as the entry-point function name\n"
John Kessenich5d610ee2018-03-07 18:05:55 -07001557 " -f{hlsl_functionality1}\n"
1558 " 'hlsl_functionality1' enables use of the\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001559 " SPV_GOOGLE_hlsl_functionality1 extension\n"
John Kessenich121853f2017-05-31 17:11:16 -06001560 " -g generate debug information\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001561 " -h print this usage message\n"
1562 " -i intermediate tree (glslang AST) is printed out\n"
1563 " -l link all input files together to form a single module\n"
1564 " -m memory leak mode\n"
John Kessenicha25530c2017-09-11 20:13:49 -06001565 " -o <file> save binary to <file>, requires a binary option (e.g., -V)\n"
John Kesseniche5c394b2019-07-02 09:32:48 -06001566 " -q dump reflection query database; requires -l for linking\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001567 " -r | --relaxed-errors"
1568 " relaxed GLSL semantic error-checking mode\n"
John Kessenichb63f4a32017-11-16 22:32:20 -07001569 " -s silence syntax and semantic error reporting\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001570 " -t multi-threaded mode\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001571 " -v | --version\n"
1572 " print version strings\n"
1573 " -w | --suppress-warnings\n"
1574 " suppress GLSL warnings, except as required by \"#extension : warn\"\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001575 " -x save binary output as text-based 32-bit hexadecimal numbers\n"
Neil Roberts16f53472018-03-20 17:30:53 +01001576 " -u<name>:<loc> specify a uniform location override for --aml\n"
Neil Robertsb0f3d792018-03-20 17:41:05 +01001577 " --uniform-base <base> set a base to use for generated uniform locations\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001578 " --auto-map-bindings | --amb automatically bind uniform variables\n"
1579 " without explicit bindings\n"
1580 " --auto-map-locations | --aml automatically locate input/output lacking\n"
1581 " 'location' (fragile, not cross stage)\n"
1582 " --client {vulkan<ver>|opengl<ver>} see -V and -G\n"
Christoph Kubisch412ff6e2019-04-13 22:57:33 +02001583 " --dump-builtin-symbols prints builtin symbol table prior each compile\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001584 " -dumpfullversion | -dumpversion print bare major.minor.patchlevel\n"
1585 " --flatten-uniform-arrays | --fua flatten uniform texture/sampler arrays to\n"
1586 " scalars\n"
1587 " --hlsl-offsets allow block offsets to follow HLSL rules\n"
1588 " works independently of source language\n"
1589 " --hlsl-iomap perform IO mapping in HLSL register space\n"
1590 " --hlsl-enable-16bit-types allow 16-bit types in SPIR-V for HLSL\n"
John Kessenich605afc72019-06-17 23:33:09 -06001591 " --hlsl-dx9-compatible interprets sampler declarations as a\n"
1592 " texture/sampler combo like DirectX9 would.\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001593 " --invert-y | --iy invert position.Y output in vertex shader\n"
1594 " --keep-uncalled | --ku don't eliminate uncalled functions\n"
John Kessenich605afc72019-06-17 23:33:09 -06001595 " --nan-clamp favor non-NaN operand in min, max, and clamp\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001596 " --no-storage-format | --nsf use Unknown image format\n"
baldurk4513df92019-02-08 10:48:48 +00001597 " --reflect-strict-array-suffix use strict array suffix rules when\n"
1598 " reflecting\n"
baldurkedf82122019-01-29 15:49:00 +00001599 " --reflect-basic-array-suffix arrays of basic types will have trailing [0]\n"
baldurk4513df92019-02-08 10:48:48 +00001600 " --reflect-intermediate-io reflection includes inputs/outputs of linked\n"
1601 " shaders rather than just vertex/fragment\n"
1602 " --reflect-separate-buffers reflect buffer variables and blocks\n"
1603 " separately to uniforms\n"
1604 " --reflect-all-block-variables reflect all variables in blocks, whether\n"
1605 " inactive or active\n"
baldurk19050692019-02-11 11:50:24 +00001606 " --reflect-unwrap-io-blocks unwrap input/output blocks the same as\n"
1607 " uniform blocks\n"
LoopDawg52017192017-07-14 15:15:47 -06001608 " --resource-set-binding [stage] name set binding\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001609 " set descriptor set and binding for\n"
1610 " individual resources\n"
LoopDawg52017192017-07-14 15:15:47 -06001611 " --resource-set-binding [stage] set\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001612 " set descriptor set for all resources\n"
1613 " --rsb synonym for --resource-set-binding\n"
1614 " --shift-image-binding [stage] num\n"
1615 " base binding number for images (uav)\n"
1616 " --shift-image-binding [stage] [num set]...\n"
1617 " per-descriptor-set shift values\n"
1618 " --sib synonym for --shift-image-binding\n"
1619 " --shift-sampler-binding [stage] num\n"
1620 " base binding number for samplers\n"
1621 " --shift-sampler-binding [stage] [num set]...\n"
1622 " per-descriptor-set shift values\n"
1623 " --ssb synonym for --shift-sampler-binding\n"
1624 " --shift-ssbo-binding [stage] num base binding number for SSBOs\n"
1625 " --shift-ssbo-binding [stage] [num set]...\n"
1626 " per-descriptor-set shift values\n"
1627 " --sbb synonym for --shift-ssbo-binding\n"
1628 " --shift-texture-binding [stage] num\n"
1629 " base binding number for textures\n"
1630 " --shift-texture-binding [stage] [num set]...\n"
1631 " per-descriptor-set shift values\n"
1632 " --stb synonym for --shift-texture-binding\n"
1633 " --shift-uav-binding [stage] num base binding number for UAVs\n"
1634 " --shift-uav-binding [stage] [num set]...\n"
1635 " per-descriptor-set shift values\n"
1636 " --suavb synonym for --shift-uav-binding\n"
1637 " --shift-UBO-binding [stage] num base binding number for UBOs\n"
1638 " --shift-UBO-binding [stage] [num set]...\n"
1639 " per-descriptor-set shift values\n"
1640 " --sub synonym for --shift-UBO-binding\n"
1641 " --shift-cbuffer-binding | --scb synonyms for --shift-UBO-binding\n"
1642 " --spirv-dis output standard-form disassembly; works only\n"
1643 " when a SPIR-V generation option is also used\n"
John Kessenichc3404252018-08-23 15:29:08 -06001644 " --spirv-val execute the SPIRV-Tools validator\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001645 " --source-entrypoint <name> the given shader source function is\n"
1646 " renamed to be the <name> given in -e\n"
1647 " --sep synonym for --source-entrypoint\n"
1648 " --stdin read from stdin instead of from a file;\n"
1649 " requires providing the shader stage using -S\n"
John Kessenich273d3a52020-01-15 00:10:41 -07001650 " --target-env {vulkan1.0 | vulkan1.1 | vulkan1.2 | opengl | \n"
John Kessenich8317e6c2019-08-18 23:58:08 -06001651 " spirv1.0 | spirv1.1 | spirv1.2 | spirv1.3 | spirv1.4 | spirv1.5}\n"
John Kessenich273d3a52020-01-15 00:10:41 -07001652 " Set the execution environment that the\n"
1653 " generated code will be executed in.\n"
1654 " Defaults to:\n"
1655 " * vulkan1.0 under --client vulkan<ver>\n"
1656 " * opengl under --client opengl<ver>\n"
1657 " * spirv1.0 under --target-env vulkan1.0\n"
1658 " * spirv1.3 under --target-env vulkan1.1\n"
1659 " * spirv1.5 under --target-env vulkan1.2\n"
1660 " Multiple --target-env can be specified.\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001661 " --variable-name <name>\n"
1662 " --vn <name> creates a C header file that contains a\n"
1663 " uint32_t array named <name>\n"
1664 " initialized with the shader binary code\n"
John Kessenichb0a7eb52013-11-07 17:44:20 +00001665 );
John Kessenich68d78fd2015-07-12 19:28:10 -06001666
1667 exit(EFailUsage);
John Kessenicha0af4732012-12-12 21:15:54 +00001668}
1669
John Kessenich3ce4e592014-10-06 19:57:34 +00001670#if !defined _MSC_VER && !defined MINGW_HAS_SECURE_API
John Kessenichcfd643e2013-03-08 23:14:42 +00001671
1672#include <errno.h>
1673
1674int fopen_s(
1675 FILE** pFile,
John Kessenich51cdd902014-02-18 23:37:57 +00001676 const char* filename,
1677 const char* mode
John Kessenichcfd643e2013-03-08 23:14:42 +00001678)
1679{
1680 if (!pFile || !filename || !mode) {
1681 return EINVAL;
1682 }
1683
1684 FILE* f = fopen(filename, mode);
1685 if (! f) {
1686 if (errno != 0) {
1687 return errno;
1688 } else {
1689 return ENOENT;
1690 }
1691 }
1692 *pFile = f;
1693
1694 return 0;
1695}
1696
1697#endif
1698
John Kessenicha0af4732012-12-12 21:15:54 +00001699//
1700// Malloc a string of sufficient size and read a string into it.
1701//
John Kessenich04acb1b2017-06-14 17:36:50 -06001702char* ReadFileData(const char* fileName)
John Kessenicha0af4732012-12-12 21:15:54 +00001703{
John Kessenichb3297152015-07-11 18:01:03 -06001704 FILE *in = nullptr;
John Kessenich3ce4e592014-10-06 19:57:34 +00001705 int errorCode = fopen_s(&in, fileName, "r");
John Kessenich68d78fd2015-07-12 19:28:10 -06001706 if (errorCode || in == nullptr)
1707 Error("unable to open input file");
John Kessenichecba76f2017-01-06 00:34:48 -07001708
John Kessenich04acb1b2017-06-14 17:36:50 -06001709 int count = 0;
John Kessenicha0af4732012-12-12 21:15:54 +00001710 while (fgetc(in) != EOF)
1711 count++;
1712
John Kessenichd6c72a42014-08-18 19:42:35 +00001713 fseek(in, 0, SEEK_SET);
John Kessenichca3457f2015-05-18 01:59:45 +00001714
John Kessenich04acb1b2017-06-14 17:36:50 -06001715 char* return_data = (char*)malloc(count + 1); // freed in FreeFileData()
1716 if ((int)fread(return_data, 1, count, in) != count) {
1717 free(return_data);
John Kessenich68d78fd2015-07-12 19:28:10 -06001718 Error("can't read input file");
John Kessenicha0af4732012-12-12 21:15:54 +00001719 }
John Kessenich68d78fd2015-07-12 19:28:10 -06001720
John Kessenich04acb1b2017-06-14 17:36:50 -06001721 return_data[count] = '\0';
John Kessenicha0af4732012-12-12 21:15:54 +00001722 fclose(in);
John Kessenichb3297152015-07-11 18:01:03 -06001723
John Kessenicha0af4732012-12-12 21:15:54 +00001724 return return_data;
1725}
1726
John Kessenich04acb1b2017-06-14 17:36:50 -06001727void FreeFileData(char* data)
John Kessenicha0af4732012-12-12 21:15:54 +00001728{
John Kessenichb3297152015-07-11 18:01:03 -06001729 free(data);
John Kessenicha0af4732012-12-12 21:15:54 +00001730}
1731
John Kessenich54d8cda2013-02-11 22:36:01 +00001732void InfoLogMsg(const char* msg, const char* name, const int num)
John Kessenicha0af4732012-12-12 21:15:54 +00001733{
John Kessenichfae38ee2015-06-10 23:23:12 +00001734 if (num >= 0 )
1735 printf("#### %s %s %d INFO LOG ####\n", msg, name, num);
1736 else
1737 printf("#### %s %s INFO LOG ####\n", msg, name);
John Kessenicha0af4732012-12-12 21:15:54 +00001738}