blob: 9fa311bce277ac1d66868d13142a9327ab65c887 [file] [log] [blame]
John Kessenicha0af4732012-12-12 21:15:54 +00001//
John Kessenich927608b2017-01-06 12:34:14 -07002// Copyright (C) 2002-2005 3Dlabs Inc. Ltd.
3// Copyright (C) 2013-2016 LunarG, Inc.
John Kessenichbd0747d2013-02-17 06:01:50 +00004//
John Kessenich927608b2017-01-06 12:34:14 -07005// All rights reserved.
John Kessenicha0af4732012-12-12 21:15:54 +00006//
John Kessenich927608b2017-01-06 12:34:14 -07007// Redistribution and use in source and binary forms, with or without
8// modification, are permitted provided that the following conditions
9// are met:
John Kessenicha0af4732012-12-12 21:15:54 +000010//
11// Redistributions of source code must retain the above copyright
12// notice, this list of conditions and the following disclaimer.
13//
14// Redistributions in binary form must reproduce the above
15// copyright notice, this list of conditions and the following
16// disclaimer in the documentation and/or other materials provided
17// with the distribution.
18//
19// Neither the name of 3Dlabs Inc. Ltd. nor the names of its
20// contributors may be used to endorse or promote products derived
21// from this software without specific prior written permission.
22//
John Kessenich927608b2017-01-06 12:34:14 -070023// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
26// FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
27// COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
28// INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
29// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
30// LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
31// CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32// LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
33// ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34// POSSIBILITY OF SUCH DAMAGE.
John Kessenicha0af4732012-12-12 21:15:54 +000035//
John Kessenich05a70632013-09-17 19:26:08 +000036
37// this only applies to the standalone wrapper, not the front end in general
Aras Pranckevicius8e204b22017-05-10 16:52:50 +030038#ifndef _CRT_SECURE_NO_WARNINGS
John Kessenich05a70632013-09-17 19:26:08 +000039#define _CRT_SECURE_NO_WARNINGS
Aras Pranckevicius8e204b22017-05-10 16:52:50 +030040#endif
John Kessenich05a70632013-09-17 19:26:08 +000041
Lei Zhang8a9b1ee2016-05-19 13:31:43 -040042#include "ResourceLimits.h"
John Kessenich2b07c7e2013-07-31 18:44:13 +000043#include "Worklist.h"
John Kessenich3494b4d2017-05-22 15:00:42 -060044#include "DirStackFileIncluder.h"
John Kessenicha0af4732012-12-12 21:15:54 +000045#include "./../glslang/Include/ShHandle.h"
John Kessenich0da9eaa2015-08-01 17:10:02 -060046#include "./../glslang/Include/revision.h"
John Kessenicha0af4732012-12-12 21:15:54 +000047#include "./../glslang/Public/ShaderLang.h"
John Kessenich0df0cde2015-03-03 17:09:43 +000048#include "../SPIRV/GlslangToSpv.h"
John Kessenich5e4b1242015-08-06 22:53:06 -060049#include "../SPIRV/GLSL.std.450.h"
John Kessenichacba7722015-03-04 03:48:38 +000050#include "../SPIRV/doc.h"
51#include "../SPIRV/disassemble.h"
John Kessenich3494b4d2017-05-22 15:00:42 -060052
John Kessenich66ec80e2016-08-05 14:04:23 -060053#include <cstring>
54#include <cstdlib>
steve-lunarg7f7c2ed2016-09-07 15:20:19 -060055#include <cctype>
John Kessenich66ec80e2016-08-05 14:04:23 -060056#include <cmath>
steve-lunarg7f7c2ed2016-09-07 15:20:19 -060057#include <array>
LoopDawg08a14422017-10-17 19:27:14 -060058#include <map>
Juan Lopeza558b262017-04-02 23:04:00 +020059#include <memory>
60#include <thread>
John Kessenicha0af4732012-12-12 21:15:54 +000061
baldurk876a0e32015-11-16 18:03:28 +010062#include "../glslang/OSDependent/osinclude.h"
John Kessenicha0af4732012-12-12 21:15:54 +000063
64extern "C" {
65 SH_IMPORT_EXPORT void ShOutputHtml();
66}
67
John Kessenich94a81fb2013-08-31 02:41:30 +000068// Command-line options
69enum TOptions {
John Kessenich906cc212016-12-09 19:22:20 -070070 EOptionNone = 0,
71 EOptionIntermediate = (1 << 0),
72 EOptionSuppressInfolog = (1 << 1),
73 EOptionMemoryLeakMode = (1 << 2),
74 EOptionRelaxedErrors = (1 << 3),
75 EOptionGiveWarnings = (1 << 4),
76 EOptionLinkProgram = (1 << 5),
77 EOptionMultiThreaded = (1 << 6),
78 EOptionDumpConfig = (1 << 7),
79 EOptionDumpReflection = (1 << 8),
80 EOptionSuppressWarnings = (1 << 9),
81 EOptionDumpVersions = (1 << 10),
82 EOptionSpv = (1 << 11),
83 EOptionHumanReadableSpv = (1 << 12),
84 EOptionVulkanRules = (1 << 13),
85 EOptionDefaultDesktop = (1 << 14),
86 EOptionOutputPreprocessed = (1 << 15),
87 EOptionOutputHexadecimal = (1 << 16),
88 EOptionReadHlsl = (1 << 17),
89 EOptionCascadingErrors = (1 << 18),
90 EOptionAutoMapBindings = (1 << 19),
steve-lunarge0b9deb2016-09-16 13:26:37 -060091 EOptionFlattenUniformArrays = (1 << 20),
John Kessenich906cc212016-12-09 19:22:20 -070092 EOptionNoStorageFormat = (1 << 21),
John Kessenich20f01e72016-12-12 11:41:43 -070093 EOptionKeepUncalled = (1 << 22),
John Kessenich4f1403e2017-04-05 17:38:20 -060094 EOptionHlslOffsets = (1 << 23),
steve-lunargbe283552017-04-18 12:18:01 -060095 EOptionHlslIoMapping = (1 << 24),
John Kessenich71facdf2017-05-17 18:28:19 -060096 EOptionAutoMapLocations = (1 << 25),
John Kessenich121853f2017-05-31 17:11:16 -060097 EOptionDebug = (1 << 26),
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +020098 EOptionStdin = (1 << 27),
GregFcd1f1692017-09-21 18:40:22 -060099 EOptionOptimizeDisable = (1 << 28),
100 EOptionOptimizeSize = (1 << 29),
LoopDawgb22c0692017-12-06 16:52:03 -0700101 EOptionInvertY = (1 << 30),
John Kessenichc6c80a62018-03-05 22:23:17 -0700102 EOptionDumpBareVersion = (1 << 31),
John Kessenich94a81fb2013-08-31 02:41:30 +0000103};
John Kessenich5d610ee2018-03-07 18:05:55 -0700104bool targetHlslFunctionality1 = false;
John Kesseniche2156222018-06-11 18:12:15 -0600105bool SpvToolsDisassembler = false;
John Kessenichc3404252018-08-23 15:29:08 -0600106bool SpvToolsValidate = false;
John Kessenich605afc72019-06-17 23:33:09 -0600107bool NaNClamp = false;
John Kessenich94a81fb2013-08-31 02:41:30 +0000108
John Kessenicha0af4732012-12-12 21:15:54 +0000109//
John Kessenich68d78fd2015-07-12 19:28:10 -0600110// Return codes from main/exit().
John Kessenicha0af4732012-12-12 21:15:54 +0000111//
112enum TFailCode {
113 ESuccess = 0,
114 EFailUsage,
115 EFailCompile,
116 EFailLink,
117 EFailCompilerCreate,
John Kessenich2b07c7e2013-07-31 18:44:13 +0000118 EFailThreadCreate,
John Kessenicha0af4732012-12-12 21:15:54 +0000119 EFailLinkerCreate
120};
121
122//
John Kessenich68d78fd2015-07-12 19:28:10 -0600123// Forward declarations.
John Kessenicha0af4732012-12-12 21:15:54 +0000124//
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600125EShLanguage FindLanguage(const std::string& name, bool parseSuffix=true);
John Kessenich51cdd902014-02-18 23:37:57 +0000126void CompileFile(const char* fileName, ShHandle);
John Kessenicha0af4732012-12-12 21:15:54 +0000127void usage();
John Kessenich04acb1b2017-06-14 17:36:50 -0600128char* ReadFileData(const char* fileName);
129void FreeFileData(char* data);
John Kessenich54d8cda2013-02-11 22:36:01 +0000130void InfoLogMsg(const char* msg, const char* name, const int num);
John Kessenich41cf6b52013-06-25 18:10:05 +0000131
John Kessenichc999ba22013-11-07 23:33:24 +0000132// Globally track if any compile or link failure.
133bool CompileFailed = false;
134bool LinkFailed = false;
135
John Kessenich94f28eb2017-11-13 01:32:06 -0700136// array of unique places to leave the shader names and infologs for the asynchronous compiles
137std::vector<std::unique_ptr<glslang::TWorkItem>> WorkItems;
138
John Kessenich05a70632013-09-17 19:26:08 +0000139TBuiltInResource Resources;
140std::string ConfigFile;
141
John Kessenicha0af4732012-12-12 21:15:54 +0000142//
John Kessenichf0bcb0a2016-04-02 13:09:14 -0600143// Parse either a .conf file provided by the user or the default from glslang::DefaultTBuiltInResource
John Kessenich05a70632013-09-17 19:26:08 +0000144//
145void ProcessConfigFile()
John Kessenichb51f62c2013-04-11 16:31:09 +0000146{
John Kessenich04acb1b2017-06-14 17:36:50 -0600147 if (ConfigFile.size() == 0)
Lei Zhang414eb602016-03-04 16:22:34 -0500148 Resources = glslang::DefaultTBuiltInResource;
John Kessenich23d27752019-07-28 02:12:10 -0600149#ifndef GLSLANG_WEB
John Kessenich04acb1b2017-06-14 17:36:50 -0600150 else {
151 char* configString = ReadFileData(ConfigFile.c_str());
152 glslang::DecodeResourceLimits(&Resources, configString);
153 FreeFileData(configString);
John Kessenich05a70632013-09-17 19:26:08 +0000154 }
John Kessenich23d27752019-07-28 02:12:10 -0600155#endif
John Kessenicha0af4732012-12-12 21:15:54 +0000156}
157
baldurk6d477852019-01-29 15:45:56 +0000158int ReflectOptions = EShReflectionDefault;
John Kessenich94a81fb2013-08-31 02:41:30 +0000159int Options = 0;
John Kessenich68d78fd2015-07-12 19:28:10 -0600160const char* ExecutableName = nullptr;
161const char* binaryFileName = nullptr;
John Kessenich4d65ee32016-03-12 18:17:47 -0700162const char* entryPointName = nullptr;
steve-lunargf1e0c872016-10-31 15:13:43 -0600163const char* sourceEntryPointName = nullptr;
Dan Bakerc6ede892016-08-11 14:06:06 -0400164const char* shaderStageName = nullptr;
Flavioaea3c892017-02-06 11:46:35 -0800165const char* variableName = nullptr;
Rex Xucb61eec2018-03-07 13:10:01 +0800166bool HlslEnable16BitTypes = false;
John Kessenichbd1c1832018-12-07 18:38:26 -0700167bool HlslDX9compatible = false;
Christoph Kubisch55ba3ea2019-04-13 22:18:16 +0200168bool DumpBuiltinSymbols = false;
John Kessenich971a0a82017-06-07 15:06:58 -0600169std::vector<std::string> IncludeDirectoryList;
John Kessenich8717a5d2018-10-26 10:12:32 -0600170
171// Source environment
172// (source 'Client' is currently the same as target 'Client')
173int ClientInputSemanticsVersion = 100;
174
175// Target environment
176glslang::EShClient Client = glslang::EShClientNone; // will stay EShClientNone if only validating
177glslang::EShTargetClientVersion ClientVersion; // not valid until Client is set
178glslang::EShTargetLanguage TargetLanguage = glslang::EShTargetNone;
179glslang::EShTargetLanguageVersion TargetVersion; // not valid until TargetLanguage is set
180
John Kessenich66011cb2018-03-06 16:12:04 -0700181std::vector<std::string> Processes; // what should be recorded by OpModuleProcessed, or equivalent
John Kessenich68d78fd2015-07-12 19:28:10 -0600182
LoopDawg08a14422017-10-17 19:27:14 -0600183// Per descriptor-set binding base data
184typedef std::map<unsigned int, unsigned int> TPerSetBaseBinding;
185
Neil Roberts16f53472018-03-20 17:30:53 +0100186std::vector<std::pair<std::string, int>> uniformLocationOverrides;
Neil Robertsb0f3d792018-03-20 17:41:05 +0100187int uniformBase = 0;
Neil Roberts16f53472018-03-20 17:30:53 +0100188
LoopDawg08a14422017-10-17 19:27:14 -0600189std::array<std::array<unsigned int, EShLangCount>, glslang::EResCount> baseBinding;
190std::array<std::array<TPerSetBaseBinding, EShLangCount>, glslang::EResCount> baseBindingForSet;
Hyangran Park36dc8292017-05-02 16:27:29 +0900191std::array<std::vector<std::string>, EShLangCount> baseResourceSetBinding;
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600192
John Kessenicha9313662017-06-15 10:40:49 -0600193// Add things like "#define ..." to a preamble to use in the beginning of the shader.
194class TPreamble {
195public:
196 TPreamble() { }
197
198 bool isSet() const { return text.size() > 0; }
199 const char* get() const { return text.c_str(); }
200
201 // #define...
202 void addDef(std::string def)
203 {
204 text.append("#define ");
205 fixLine(def);
206
John Kessenich2a271162017-07-20 20:00:36 -0600207 Processes.push_back("D");
208 Processes.back().append(def);
209
John Kessenicha9313662017-06-15 10:40:49 -0600210 // The first "=" needs to turn into a space
LoopDawgb97b25e2017-07-12 09:04:39 -0600211 const size_t equal = def.find_first_of("=");
John Kessenicha9313662017-06-15 10:40:49 -0600212 if (equal != def.npos)
213 def[equal] = ' ';
214
215 text.append(def);
216 text.append("\n");
217 }
218
219 // #undef...
220 void addUndef(std::string undef)
221 {
222 text.append("#undef ");
223 fixLine(undef);
John Kessenich2a271162017-07-20 20:00:36 -0600224
225 Processes.push_back("U");
226 Processes.back().append(undef);
227
John Kessenicha9313662017-06-15 10:40:49 -0600228 text.append(undef);
229 text.append("\n");
230 }
231
232protected:
233 void fixLine(std::string& line)
234 {
235 // Can't go past a newline in the line
LoopDawgb97b25e2017-07-12 09:04:39 -0600236 const size_t end = line.find_first_of("\n");
John Kessenicha9313662017-06-15 10:40:49 -0600237 if (end != line.npos)
238 line = line.substr(0, end);
239 }
240
241 std::string text; // contents of preamble
242};
243
244TPreamble UserPreamble;
245
John Kessenich68d78fd2015-07-12 19:28:10 -0600246//
247// Create the default name for saving a binary if -o is not provided.
248//
249const char* GetBinaryName(EShLanguage stage)
250{
251 const char* name;
252 if (binaryFileName == nullptr) {
253 switch (stage) {
254 case EShLangVertex: name = "vert.spv"; break;
255 case EShLangTessControl: name = "tesc.spv"; break;
256 case EShLangTessEvaluation: name = "tese.spv"; break;
257 case EShLangGeometry: name = "geom.spv"; break;
258 case EShLangFragment: name = "frag.spv"; break;
259 case EShLangCompute: name = "comp.spv"; break;
Chao 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//
295void Error(const char* message)
296{
John Kessenichaf527992017-11-02 22:48:15 -0600297 fprintf(stderr, "%s: Error %s (use -h for usage)\n", ExecutableName, message);
John Kessenich68d78fd2015-07-12 19:28:10 -0600298 exit(EFailUsage);
299}
300
301//
LoopDawg08a14422017-10-17 19:27:14 -0600302// Process an optional binding base of one the forms:
303// --argname [stage] base // base for stage (if given) or all stages (if not)
LoopDawge5709552017-10-21 10:46:39 -0600304// --argname [stage] [base set]... // set/base pairs: set the base for given binding set.
LoopDawg08a14422017-10-17 19:27:14 -0600305
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600306// Where stage is one of the forms accepted by FindLanguage, and base is an integer
307//
LoopDawg08a14422017-10-17 19:27:14 -0600308void ProcessBindingBase(int& argc, char**& argv, glslang::TResourceType res)
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600309{
310 if (argc < 2)
311 usage();
312
LoopDawg08a14422017-10-17 19:27:14 -0600313 EShLanguage lang = EShLangCount;
314 int singleBase = 0;
315 TPerSetBaseBinding perSetBase;
316 int arg = 1;
317
318 // Parse stage, if given
319 if (!isdigit(argv[arg][0])) {
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600320 if (argc < 3) // this form needs one more argument
321 usage();
John Kessenichecba76f2017-01-06 00:34:48 -0700322
LoopDawg08a14422017-10-17 19:27:14 -0600323 lang = FindLanguage(argv[arg++], false);
324 }
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600325
LoopDawg08a14422017-10-17 19:27:14 -0600326 if ((argc - arg) > 2 && isdigit(argv[arg+0][0]) && isdigit(argv[arg+1][0])) {
327 // Parse a per-set binding base
328 while ((argc - arg) > 2 && isdigit(argv[arg+0][0]) && isdigit(argv[arg+1][0])) {
LoopDawg08a14422017-10-17 19:27:14 -0600329 const int baseNum = atoi(argv[arg++]);
LoopDawge5709552017-10-21 10:46:39 -0600330 const int setNum = atoi(argv[arg++]);
LoopDawg08a14422017-10-17 19:27:14 -0600331 perSetBase[setNum] = baseNum;
332 }
333 } else {
334 // Parse single binding base
335 singleBase = atoi(argv[arg++]);
336 }
337
338 argc -= (arg-1);
339 argv += (arg-1);
340
341 // Set one or all languages
342 const int langMin = (lang < EShLangCount) ? lang+0 : 0;
343 const int langMax = (lang < EShLangCount) ? lang+1 : EShLangCount;
344
345 for (int lang = langMin; lang < langMax; ++lang) {
346 if (!perSetBase.empty())
John Kessenich251901a2018-08-12 22:05:59 -0600347 baseBindingForSet[res][lang].insert(perSetBase.begin(), perSetBase.end());
LoopDawg08a14422017-10-17 19:27:14 -0600348 else
349 baseBinding[res][lang] = singleBase;
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600350 }
351}
352
Hyangran Park36dc8292017-05-02 16:27:29 +0900353void ProcessResourceSetBindingBase(int& argc, char**& argv, std::array<std::vector<std::string>, EShLangCount>& base)
354{
355 if (argc < 2)
356 usage();
357
358 if (!isdigit(argv[1][0])) {
LoopDawg52017192017-07-14 15:15:47 -0600359 if (argc < 3) // this form needs one more argument
Hyangran Park36dc8292017-05-02 16:27:29 +0900360 usage();
361
LoopDawg52017192017-07-14 15:15:47 -0600362 // Parse form: --argname stage [regname set base...], or:
363 // --argname stage set
Hyangran Park36dc8292017-05-02 16:27:29 +0900364 const EShLanguage lang = FindLanguage(argv[1], false);
365
LoopDawg52017192017-07-14 15:15:47 -0600366 argc--;
367 argv++;
368
369 while (argc > 1 && argv[1] != nullptr && argv[1][0] != '-') {
370 base[lang].push_back(argv[1]);
371
372 argc--;
373 argv++;
Hyangran Park36dc8292017-05-02 16:27:29 +0900374 }
LoopDawg52017192017-07-14 15:15:47 -0600375
376 // Must have one arg, or a multiple of three (for [regname set binding] triples)
377 if (base[lang].size() != 1 && (base[lang].size() % 3) != 0)
378 usage();
379
Hyangran Park36dc8292017-05-02 16:27:29 +0900380 } else {
LoopDawg52017192017-07-14 15:15:47 -0600381 // Parse form: --argname set
Hyangran Park36dc8292017-05-02 16:27:29 +0900382 for (int lang=0; lang<EShLangCount; ++lang)
383 base[lang].push_back(argv[1]);
384
385 argc--;
386 argv++;
387 }
388}
389
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600390//
John Kessenich68d78fd2015-07-12 19:28:10 -0600391// Do all command-line argument parsing. This includes building up the work-items
392// to be processed later, and saving all the command-line options.
393//
394// Does not return (it exits) if command-line is fatally flawed.
395//
Juan Lopeza558b262017-04-02 23:04:00 +0200396void ProcessArguments(std::vector<std::unique_ptr<glslang::TWorkItem>>& workItems, int argc, char* argv[])
John Kessenich2b07c7e2013-07-31 18:44:13 +0000397{
LoopDawg08a14422017-10-17 19:27:14 -0600398 for (int res = 0; res < glslang::EResCount; ++res)
399 baseBinding[res].fill(0);
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600400
John Kessenich38f3b892013-09-06 19:52:57 +0000401 ExecutableName = argv[0];
Juan Lopeza558b262017-04-02 23:04:00 +0200402 workItems.reserve(argc);
John Kessenich38f3b892013-09-06 19:52:57 +0000403
John Kessenichc178f0a2017-06-23 10:58:31 -0600404 const auto bumpArg = [&]() {
405 if (argc > 0) {
406 argc--;
407 argv++;
408 }
409 };
410
411 // read a string directly attached to a single-letter option
John Kessenich6263fb12017-06-14 15:52:44 -0600412 const auto getStringOperand = [&](const char* desc) {
413 if (argv[0][2] == 0) {
414 printf("%s must immediately follow option (no spaces)\n", desc);
415 exit(EFailUsage);
416 }
417 return argv[0] + 2;
418 };
419
John Kessenich6353d552017-06-23 11:11:09 -0600420 // read a number attached to a single-letter option
421 const auto getAttachedNumber = [&](const char* desc) {
422 int num = atoi(argv[0] + 2);
423 if (num == 0) {
424 printf("%s: expected attached non-0 number\n", desc);
425 exit(EFailUsage);
426 }
427 return num;
428 };
429
430 // minimum needed (without overriding something else) to target Vulkan SPIR-V
431 const auto setVulkanSpv = []() {
John Kessenich8717a5d2018-10-26 10:12:32 -0600432 if (Client == glslang::EShClientNone)
433 ClientVersion = glslang::EShTargetVulkan_1_0;
434 Client = glslang::EShClientVulkan;
John Kessenich6353d552017-06-23 11:11:09 -0600435 Options |= EOptionSpv;
436 Options |= EOptionVulkanRules;
437 Options |= EOptionLinkProgram;
438 };
439
440 // minimum needed (without overriding something else) to target OpenGL SPIR-V
441 const auto setOpenGlSpv = []() {
John Kessenich8717a5d2018-10-26 10:12:32 -0600442 if (Client == glslang::EShClientNone)
443 ClientVersion = glslang::EShTargetOpenGL_450;
444 Client = glslang::EShClientOpenGL;
John Kessenich6353d552017-06-23 11:11:09 -0600445 Options |= EOptionSpv;
446 Options |= EOptionLinkProgram;
447 // undo a -H default to Vulkan
448 Options &= ~EOptionVulkanRules;
449 };
450
Neil Roberts16f53472018-03-20 17:30:53 +0100451 const auto getUniformOverride = [getStringOperand]() {
452 const char *arg = getStringOperand("-u<name>:<location>");
453 const char *split = strchr(arg, ':');
454 if (split == NULL) {
455 printf("%s: missing location\n", arg);
456 exit(EFailUsage);
457 }
458 errno = 0;
459 int location = ::strtol(split + 1, NULL, 10);
460 if (errno) {
461 printf("%s: invalid location\n", arg);
462 exit(EFailUsage);
463 }
464 return std::make_pair(std::string(arg, split - arg), location);
465 };
466
John Kessenichc178f0a2017-06-23 10:58:31 -0600467 for (bumpArg(); argc >= 1; bumpArg()) {
John Kessenich2b07c7e2013-07-31 18:44:13 +0000468 if (argv[0][0] == '-') {
John Kessenich2aa7f3a2015-05-15 16:02:07 +0000469 switch (argv[0][1]) {
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600470 case '-':
471 {
472 std::string lowerword(argv[0]+2);
473 std::transform(lowerword.begin(), lowerword.end(), lowerword.begin(), ::tolower);
474
475 // handle --word style options
John Kessenich6263fb12017-06-14 15:52:44 -0600476 if (lowerword == "auto-map-bindings" || // synonyms
John Kessenich6353d552017-06-23 11:11:09 -0600477 lowerword == "auto-map-binding" ||
478 lowerword == "amb") {
John Kessenich6263fb12017-06-14 15:52:44 -0600479 Options |= EOptionAutoMapBindings;
480 } else if (lowerword == "auto-map-locations" || // synonyms
481 lowerword == "aml") {
482 Options |= EOptionAutoMapLocations;
Neil Robertsb0f3d792018-03-20 17:41:05 +0100483 } else if (lowerword == "uniform-base") {
484 if (argc <= 1)
485 Error("no <base> provided for --uniform-base");
486 uniformBase = ::strtol(argv[1], NULL, 10);
487 bumpArg();
488 break;
John Kessenich6353d552017-06-23 11:11:09 -0600489 } else if (lowerword == "client") {
490 if (argc > 1) {
491 if (strcmp(argv[1], "vulkan100") == 0)
492 setVulkanSpv();
493 else if (strcmp(argv[1], "opengl100") == 0)
494 setOpenGlSpv();
495 else
496 Error("--client expects vulkan100 or opengl100");
497 }
498 bumpArg();
Christoph Kubisch55ba3ea2019-04-13 22:18:16 +0200499 } else if (lowerword == "dump-builtin-symbols") {
500 DumpBuiltinSymbols = true;
John Kessenich640bd092018-08-09 14:15:00 -0600501 } else if (lowerword == "entry-point") {
502 entryPointName = argv[1];
503 if (argc <= 1)
504 Error("no <name> provided for --entry-point");
505 bumpArg();
John Kessenich6263fb12017-06-14 15:52:44 -0600506 } else if (lowerword == "flatten-uniform-arrays" || // synonyms
507 lowerword == "flatten-uniform-array" ||
508 lowerword == "fua") {
509 Options |= EOptionFlattenUniformArrays;
510 } else if (lowerword == "hlsl-offsets") {
511 Options |= EOptionHlslOffsets;
512 } else if (lowerword == "hlsl-iomap" ||
513 lowerword == "hlsl-iomapper" ||
514 lowerword == "hlsl-iomapping") {
515 Options |= EOptionHlslIoMapping;
Rex Xucb61eec2018-03-07 13:10:01 +0800516 } else if (lowerword == "hlsl-enable-16bit-types") {
517 HlslEnable16BitTypes = true;
John Kessenichbd1c1832018-12-07 18:38:26 -0700518 } else if (lowerword == "hlsl-dx9-compatible") {
519 HlslDX9compatible = true;
John Kessenichc6c80a62018-03-05 22:23:17 -0700520 } else if (lowerword == "invert-y" || // synonyms
521 lowerword == "iy") {
522 Options |= EOptionInvertY;
John Kessenich6263fb12017-06-14 15:52:44 -0600523 } else if (lowerword == "keep-uncalled" || // synonyms
524 lowerword == "ku") {
525 Options |= EOptionKeepUncalled;
John Kessenich605afc72019-06-17 23:33:09 -0600526 } else if (lowerword == "nan-clamp") {
527 NaNClamp = true;
John Kessenich6263fb12017-06-14 15:52:44 -0600528 } else if (lowerword == "no-storage-format" || // synonyms
529 lowerword == "nsf") {
530 Options |= EOptionNoStorageFormat;
John Kessenich2a271162017-07-20 20:00:36 -0600531 } else if (lowerword == "relaxed-errors") {
532 Options |= EOptionRelaxedErrors;
baldurk15c37f72019-01-29 12:12:59 +0000533 } else if (lowerword == "reflect-strict-array-suffix") {
534 ReflectOptions |= EShReflectionStrictArraySuffix;
baldurkedf82122019-01-29 15:49:00 +0000535 } else if (lowerword == "reflect-basic-array-suffix") {
536 ReflectOptions |= EShReflectionBasicArraySuffix;
baldurk0af5e3e2019-01-29 16:04:44 +0000537 } else if (lowerword == "reflect-intermediate-io") {
538 ReflectOptions |= EShReflectionIntermediateIO;
baldurk657acc02019-01-30 14:18:43 +0000539 } else if (lowerword == "reflect-separate-buffers") {
540 ReflectOptions |= EShReflectionSeparateBuffers;
baldurka972e732019-01-30 15:34:02 +0000541 } else if (lowerword == "reflect-all-block-variables") {
542 ReflectOptions |= EShReflectionAllBlockVariables;
baldurk19050692019-02-11 11:50:24 +0000543 } else if (lowerword == "reflect-unwrap-io-blocks") {
544 ReflectOptions |= EShReflectionUnwrapIOBlocks;
John Kessenich6263fb12017-06-14 15:52:44 -0600545 } else if (lowerword == "resource-set-bindings" || // synonyms
546 lowerword == "resource-set-binding" ||
547 lowerword == "rsb") {
548 ProcessResourceSetBindingBase(argc, argv, baseResourceSetBinding);
steve-lunarg9088be42016-11-01 10:31:42 -0600549 } else if (lowerword == "shift-image-bindings" || // synonyms
550 lowerword == "shift-image-binding" ||
551 lowerword == "sib") {
LoopDawg08a14422017-10-17 19:27:14 -0600552 ProcessBindingBase(argc, argv, glslang::EResImage);
John Kessenich6263fb12017-06-14 15:52:44 -0600553 } else if (lowerword == "shift-sampler-bindings" || // synonyms
John Kessenichade8bbb2018-08-12 21:24:55 -0600554 lowerword == "shift-sampler-binding" ||
555 lowerword == "ssb") {
LoopDawg08a14422017-10-17 19:27:14 -0600556 ProcessBindingBase(argc, argv, glslang::EResSampler);
John Kessenich6263fb12017-06-14 15:52:44 -0600557 } else if (lowerword == "shift-uav-bindings" || // synonyms
558 lowerword == "shift-uav-binding" ||
559 lowerword == "suavb") {
LoopDawg08a14422017-10-17 19:27:14 -0600560 ProcessBindingBase(argc, argv, glslang::EResUav);
John Kessenich6263fb12017-06-14 15:52:44 -0600561 } else if (lowerword == "shift-texture-bindings" || // synonyms
562 lowerword == "shift-texture-binding" ||
563 lowerword == "stb") {
LoopDawg08a14422017-10-17 19:27:14 -0600564 ProcessBindingBase(argc, argv, glslang::EResTexture);
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600565 } else if (lowerword == "shift-ubo-bindings" || // synonyms
566 lowerword == "shift-ubo-binding" ||
steve-lunargbe283552017-04-18 12:18:01 -0600567 lowerword == "shift-cbuffer-bindings" ||
568 lowerword == "shift-cbuffer-binding" ||
569 lowerword == "sub" ||
570 lowerword == "scb") {
LoopDawg08a14422017-10-17 19:27:14 -0600571 ProcessBindingBase(argc, argv, glslang::EResUbo);
steve-lunarg932bb5c2017-02-21 17:19:08 -0700572 } else if (lowerword == "shift-ssbo-bindings" || // synonyms
573 lowerword == "shift-ssbo-binding" ||
574 lowerword == "sbb") {
LoopDawg08a14422017-10-17 19:27:14 -0600575 ProcessBindingBase(argc, argv, glslang::EResSsbo);
John Kessenich6263fb12017-06-14 15:52:44 -0600576 } else if (lowerword == "source-entrypoint" || // synonyms
577 lowerword == "sep") {
John Kessenichc178f0a2017-06-23 10:58:31 -0600578 if (argc <= 1)
John Kessenich6263fb12017-06-14 15:52:44 -0600579 Error("no <entry-point> provided for --source-entrypoint");
John Kessenichc178f0a2017-06-23 10:58:31 -0600580 sourceEntryPointName = argv[1];
581 bumpArg();
John Kessenich6263fb12017-06-14 15:52:44 -0600582 break;
John Kesseniche2156222018-06-11 18:12:15 -0600583 } else if (lowerword == "spirv-dis") {
584 SpvToolsDisassembler = true;
John Kessenichc3404252018-08-23 15:29:08 -0600585 } else if (lowerword == "spirv-val") {
586 SpvToolsValidate = true;
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +0200587 } else if (lowerword == "stdin") {
588 Options |= EOptionStdin;
589 shaderStageName = argv[1];
John Kessenich2a271162017-07-20 20:00:36 -0600590 } else if (lowerword == "suppress-warnings") {
591 Options |= EOptionSuppressWarnings;
John Kessenich6353d552017-06-23 11:11:09 -0600592 } else if (lowerword == "target-env") {
593 if (argc > 1) {
594 if (strcmp(argv[1], "vulkan1.0") == 0) {
595 setVulkanSpv();
John Kessenich8717a5d2018-10-26 10:12:32 -0600596 ClientVersion = glslang::EShTargetVulkan_1_0;
John Kessenich66011cb2018-03-06 16:12:04 -0700597 } else if (strcmp(argv[1], "vulkan1.1") == 0) {
598 setVulkanSpv();
John Kessenich8717a5d2018-10-26 10:12:32 -0600599 ClientVersion = glslang::EShTargetVulkan_1_1;
John Kessenich6353d552017-06-23 11:11:09 -0600600 } else if (strcmp(argv[1], "opengl") == 0) {
601 setOpenGlSpv();
John Kessenich8717a5d2018-10-26 10:12:32 -0600602 ClientVersion = glslang::EShTargetOpenGL_450;
603 } else if (strcmp(argv[1], "spirv1.0") == 0) {
604 TargetLanguage = glslang::EShTargetSpv;
605 TargetVersion = glslang::EShTargetSpv_1_0;
606 } else if (strcmp(argv[1], "spirv1.1") == 0) {
607 TargetLanguage = glslang::EShTargetSpv;
608 TargetVersion = glslang::EShTargetSpv_1_1;
609 } else if (strcmp(argv[1], "spirv1.2") == 0) {
610 TargetLanguage = glslang::EShTargetSpv;
611 TargetVersion = glslang::EShTargetSpv_1_2;
612 } else if (strcmp(argv[1], "spirv1.3") == 0) {
613 TargetLanguage = glslang::EShTargetSpv;
614 TargetVersion = glslang::EShTargetSpv_1_3;
615 } else if (strcmp(argv[1], "spirv1.4") == 0) {
616 TargetLanguage = glslang::EShTargetSpv;
617 TargetVersion = glslang::EShTargetSpv_1_4;
John Kessenich6353d552017-06-23 11:11:09 -0600618 } else
John Kessenich8717a5d2018-10-26 10:12:32 -0600619 Error("--target-env expected one of: vulkan1.0, vulkan1.1, opengl, spirv1.0, spirv1.1, spirv1.2, or spirv1.3");
John Kessenich6353d552017-06-23 11:11:09 -0600620 }
621 bumpArg();
Flavio15017db2017-02-15 14:29:33 -0800622 } else if (lowerword == "variable-name" || // synonyms
John Kessenich66011cb2018-03-06 16:12:04 -0700623 lowerword == "vn") {
Flavio15017db2017-02-15 14:29:33 -0800624 Options |= EOptionOutputHexadecimal;
John Kessenichc178f0a2017-06-23 10:58:31 -0600625 if (argc <= 1)
Flavio15017db2017-02-15 14:29:33 -0800626 Error("no <C-variable-name> provided for --variable-name");
John Kessenichc178f0a2017-06-23 10:58:31 -0600627 variableName = argv[1];
628 bumpArg();
Flavio15017db2017-02-15 14:29:33 -0800629 break;
John Kessenichc6c80a62018-03-05 22:23:17 -0700630 } else if (lowerword == "version") {
631 Options |= EOptionDumpVersions;
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600632 } else {
633 usage();
634 }
635 }
636 break;
John Kessenich6263fb12017-06-14 15:52:44 -0600637 case 'C':
638 Options |= EOptionCascadingErrors;
639 break;
640 case 'D':
John Kessenicha9313662017-06-15 10:40:49 -0600641 if (argv[0][2] == 0)
642 Options |= EOptionReadHlsl;
643 else
644 UserPreamble.addDef(getStringOperand("-D<macro> macro name"));
John Kessenich6263fb12017-06-14 15:52:44 -0600645 break;
Neil Roberts16f53472018-03-20 17:30:53 +0100646 case 'u':
647 uniformLocationOverrides.push_back(getUniformOverride());
648 break;
John Kessenich6263fb12017-06-14 15:52:44 -0600649 case 'E':
650 Options |= EOptionOutputPreprocessed;
651 break;
652 case 'G':
John Kessenich8717a5d2018-10-26 10:12:32 -0600653 // OpenGL client
John Kessenich6353d552017-06-23 11:11:09 -0600654 setOpenGlSpv();
655 if (argv[0][2] != 0)
656 ClientInputSemanticsVersion = getAttachedNumber("-G<num> client input semantics");
John Kessenich6263fb12017-06-14 15:52:44 -0600657 break;
John Kessenich2aa7f3a2015-05-15 16:02:07 +0000658 case 'H':
659 Options |= EOptionHumanReadableSpv;
John Kessenich91e4aa52016-07-07 17:46:42 -0600660 if ((Options & EOptionSpv) == 0) {
661 // default to Vulkan
John Kessenich6353d552017-06-23 11:11:09 -0600662 setVulkanSpv();
John Kessenich91e4aa52016-07-07 17:46:42 -0600663 }
664 break;
John Kessenich971a0a82017-06-07 15:06:58 -0600665 case 'I':
John Kessenicha9313662017-06-15 10:40:49 -0600666 IncludeDirectoryList.push_back(getStringOperand("-I<dir> include path"));
John Kessenich68d78fd2015-07-12 19:28:10 -0600667 break;
GregFcd1f1692017-09-21 18:40:22 -0600668 case 'O':
669 if (argv[0][2] == 'd')
670 Options |= EOptionOptimizeDisable;
671 else if (argv[0][2] == 's')
GregFfb03a552018-03-29 11:49:14 -0600672#if ENABLE_OPT
GregFcd1f1692017-09-21 18:40:22 -0600673 Options |= EOptionOptimizeSize;
674#else
675 Error("-Os not available; optimizer not linked");
676#endif
677 else
678 Error("unknown -O option");
679 break;
Dan Baker5afdd782016-08-11 17:53:57 -0400680 case 'S':
John Kessenichc178f0a2017-06-23 10:58:31 -0600681 if (argc <= 1)
Dan Baker5afdd782016-08-11 17:53:57 -0400682 Error("no <stage> specified for -S");
John Kessenichc178f0a2017-06-23 10:58:31 -0600683 shaderStageName = argv[1];
684 bumpArg();
dankbaker45d49bc2016-08-08 21:43:07 -0400685 break;
John Kessenicha9313662017-06-15 10:40:49 -0600686 case 'U':
687 UserPreamble.addUndef(getStringOperand("-U<macro>: macro name"));
688 break;
John Kessenich6263fb12017-06-14 15:52:44 -0600689 case 'V':
John Kessenich6353d552017-06-23 11:11:09 -0600690 setVulkanSpv();
691 if (argv[0][2] != 0)
David Neto506d2c22018-02-27 21:55:23 -0500692 ClientInputSemanticsVersion = getAttachedNumber("-V<num> client input semantics");
John Kessenichc555ddd2015-06-17 02:38:44 +0000693 break;
John Kessenich05a70632013-09-17 19:26:08 +0000694 case 'c':
695 Options |= EOptionDumpConfig;
696 break;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000697 case 'd':
John Kessenichc6c80a62018-03-05 22:23:17 -0700698 if (strncmp(&argv[0][1], "dumpversion", strlen(&argv[0][1]) + 1) == 0 ||
699 strncmp(&argv[0][1], "dumpfullversion", strlen(&argv[0][1]) + 1) == 0)
700 Options |= EOptionDumpBareVersion;
701 else
702 Options |= EOptionDefaultDesktop;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000703 break;
John Kessenich4d65ee32016-03-12 18:17:47 -0700704 case 'e':
John Kessenich4d65ee32016-03-12 18:17:47 -0700705 entryPointName = argv[1];
John Kessenichc178f0a2017-06-23 10:58:31 -0600706 if (argc <= 1)
John Kessenicha25530c2017-09-11 20:13:49 -0600707 Error("no <name> provided for -e");
John Kessenichc178f0a2017-06-23 10:58:31 -0600708 bumpArg();
John Kessenich4d65ee32016-03-12 18:17:47 -0700709 break;
John Kessenich5d610ee2018-03-07 18:05:55 -0700710 case 'f':
711 if (strcmp(&argv[0][2], "hlsl_functionality1") == 0)
712 targetHlslFunctionality1 = true;
713 else
714 Error("-f: expected hlsl_functionality1");
715 break;
John Kessenich121853f2017-05-31 17:11:16 -0600716 case 'g':
717 Options |= EOptionDebug;
718 break;
John Kessenich68d78fd2015-07-12 19:28:10 -0600719 case 'h':
720 usage();
721 break;
John Kessenich05a70632013-09-17 19:26:08 +0000722 case 'i':
John Kessenich94a81fb2013-08-31 02:41:30 +0000723 Options |= EOptionIntermediate;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000724 break;
725 case 'l':
John Kessenichd78e3512014-08-25 20:07:55 +0000726 Options |= EOptionLinkProgram;
John Kessenich94a81fb2013-08-31 02:41:30 +0000727 break;
728 case 'm':
729 Options |= EOptionMemoryLeakMode;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000730 break;
John Kessenich68d78fd2015-07-12 19:28:10 -0600731 case 'o':
John Kessenichc178f0a2017-06-23 10:58:31 -0600732 if (argc <= 1)
John Kessenich68d78fd2015-07-12 19:28:10 -0600733 Error("no <file> provided for -o");
John Kessenichc178f0a2017-06-23 10:58:31 -0600734 binaryFileName = argv[1];
735 bumpArg();
John Kessenich68d78fd2015-07-12 19:28:10 -0600736 break;
John Kessenich11f9fc72013-11-07 01:06:34 +0000737 case 'q':
738 Options |= EOptionDumpReflection;
739 break;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000740 case 'r':
John Kessenich94a81fb2013-08-31 02:41:30 +0000741 Options |= EOptionRelaxedErrors;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000742 break;
743 case 's':
John Kessenich94a81fb2013-08-31 02:41:30 +0000744 Options |= EOptionSuppressInfolog;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000745 break;
John Kessenich38f3b892013-09-06 19:52:57 +0000746 case 't':
Juan Lopeza558b262017-04-02 23:04:00 +0200747 Options |= EOptionMultiThreaded;
John Kessenich38f3b892013-09-06 19:52:57 +0000748 break;
John Kessenich319de232013-12-04 04:43:40 +0000749 case 'v':
750 Options |= EOptionDumpVersions;
751 break;
John Kessenichb0a7eb52013-11-07 17:44:20 +0000752 case 'w':
753 Options |= EOptionSuppressWarnings;
754 break;
Johannes van Waverenecb0f3b2016-05-27 12:55:53 -0500755 case 'x':
756 Options |= EOptionOutputHexadecimal;
Johannes van Waverenecb0f3b2016-05-27 12:55:53 -0500757 break;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000758 default:
John Kessenich68d78fd2015-07-12 19:28:10 -0600759 usage();
760 break;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000761 }
John Kessenich38f3b892013-09-06 19:52:57 +0000762 } else {
John Kessenich05a70632013-09-17 19:26:08 +0000763 std::string name(argv[0]);
764 if (! SetConfigFile(name)) {
Juan Lopeza558b262017-04-02 23:04:00 +0200765 workItems.push_back(std::unique_ptr<glslang::TWorkItem>(new glslang::TWorkItem(name)));
John Kessenich05a70632013-09-17 19:26:08 +0000766 }
John Kessenich38f3b892013-09-06 19:52:57 +0000767 }
John Kessenich2b07c7e2013-07-31 18:44:13 +0000768 }
769
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +0200770 // Make sure that -S is always specified if --stdin is specified
771 if ((Options & EOptionStdin) && shaderStageName == nullptr)
772 Error("must provide -S when --stdin is given");
773
John Kessenich68d78fd2015-07-12 19:28:10 -0600774 // Make sure that -E is not specified alongside linking (which includes SPV generation)
John Kesseniche5c394b2019-07-02 09:32:48 -0600775 // Or things that require linking
776 if (Options & EOptionOutputPreprocessed) {
777 if (Options & EOptionLinkProgram)
778 Error("can't use -E when linking is selected");
779 if (Options & EOptionDumpReflection)
780 Error("reflection requires linking, which can't be used when -E when is selected");
781 }
782
783 // reflection requires linking
784 if ((Options & EOptionDumpReflection) && !(Options & EOptionLinkProgram))
785 Error("reflection requires -l for linking");
John Kessenichc555ddd2015-06-17 02:38:44 +0000786
Johannes van Waverenecb0f3b2016-05-27 12:55:53 -0500787 // -o or -x makes no sense if there is no target binary
John Kessenich68d78fd2015-07-12 19:28:10 -0600788 if (binaryFileName && (Options & EOptionSpv) == 0)
789 Error("no binary generation requested (e.g., -V)");
steve-lunarge0b9deb2016-09-16 13:26:37 -0600790
791 if ((Options & EOptionFlattenUniformArrays) != 0 &&
792 (Options & EOptionReadHlsl) == 0)
793 Error("uniform array flattening only valid when compiling HLSL source.");
John Kessenich8717a5d2018-10-26 10:12:32 -0600794
795 // rationalize client and target language
796 if (TargetLanguage == glslang::EShTargetNone) {
797 switch (ClientVersion) {
798 case glslang::EShTargetVulkan_1_0:
799 TargetLanguage = glslang::EShTargetSpv;
800 TargetVersion = glslang::EShTargetSpv_1_0;
801 break;
802 case glslang::EShTargetVulkan_1_1:
803 TargetLanguage = glslang::EShTargetSpv;
804 TargetVersion = glslang::EShTargetSpv_1_3;
805 break;
806 case glslang::EShTargetOpenGL_450:
807 TargetLanguage = glslang::EShTargetSpv;
808 TargetVersion = glslang::EShTargetSpv_1_0;
809 break;
810 default:
811 break;
812 }
813 }
814 if (TargetLanguage != glslang::EShTargetNone && Client == glslang::EShClientNone)
815 Error("To generate SPIR-V, also specify client semantics. See -G and -V.");
John Kessenich2b07c7e2013-07-31 18:44:13 +0000816}
817
John Kessenich68d78fd2015-07-12 19:28:10 -0600818//
819// Translate the meaningful subset of command-line options to parser-behavior options.
820//
John Kessenichb0a7eb52013-11-07 17:44:20 +0000821void SetMessageOptions(EShMessages& messages)
822{
823 if (Options & EOptionRelaxedErrors)
824 messages = (EShMessages)(messages | EShMsgRelaxedErrors);
825 if (Options & EOptionIntermediate)
826 messages = (EShMessages)(messages | EShMsgAST);
827 if (Options & EOptionSuppressWarnings)
828 messages = (EShMessages)(messages | EShMsgSuppressWarnings);
John Kessenich68d78fd2015-07-12 19:28:10 -0600829 if (Options & EOptionSpv)
830 messages = (EShMessages)(messages | EShMsgSpvRules);
831 if (Options & EOptionVulkanRules)
832 messages = (EShMessages)(messages | EShMsgVulkanRules);
Andrew Woloszynaae1ad82015-06-24 17:00:46 -0400833 if (Options & EOptionOutputPreprocessed)
834 messages = (EShMessages)(messages | EShMsgOnlyPreprocessor);
John Kessenich66e2faf2016-03-12 18:34:36 -0700835 if (Options & EOptionReadHlsl)
836 messages = (EShMessages)(messages | EShMsgReadHlsl);
John Kessenicha86836e2016-07-09 14:50:57 -0600837 if (Options & EOptionCascadingErrors)
838 messages = (EShMessages)(messages | EShMsgCascadingErrors);
John Kessenich906cc212016-12-09 19:22:20 -0700839 if (Options & EOptionKeepUncalled)
840 messages = (EShMessages)(messages | EShMsgKeepUncalled);
John Kessenich4f1403e2017-04-05 17:38:20 -0600841 if (Options & EOptionHlslOffsets)
842 messages = (EShMessages)(messages | EShMsgHlslOffsets);
John Kessenich121853f2017-05-31 17:11:16 -0600843 if (Options & EOptionDebug)
844 messages = (EShMessages)(messages | EShMsgDebugInfo);
Rex Xucb61eec2018-03-07 13:10:01 +0800845 if (HlslEnable16BitTypes)
846 messages = (EShMessages)(messages | EShMsgHlslEnable16BitTypes);
GregFfb03a552018-03-29 11:49:14 -0600847 if ((Options & EOptionOptimizeDisable) || !ENABLE_OPT)
848 messages = (EShMessages)(messages | EShMsgHlslLegalization);
John Kessenichbd1c1832018-12-07 18:38:26 -0700849 if (HlslDX9compatible)
850 messages = (EShMessages)(messages | EShMsgHlslDX9Compatible);
Christoph Kubisch55ba3ea2019-04-13 22:18:16 +0200851 if (DumpBuiltinSymbols)
852 messages = (EShMessages)(messages | EShMsgBuiltinSymbolTable);
John Kessenichb0a7eb52013-11-07 17:44:20 +0000853}
854
John Kessenich68d78fd2015-07-12 19:28:10 -0600855//
John Kessenich69f4b512013-09-04 21:19:27 +0000856// Thread entry point, for non-linking asynchronous mode.
John Kessenichc999ba22013-11-07 23:33:24 +0000857//
Juan Lopeza558b262017-04-02 23:04:00 +0200858void CompileShaders(glslang::TWorklist& worklist)
John Kessenich2b07c7e2013-07-31 18:44:13 +0000859{
John Kessenich7f0bcfd2018-04-05 19:00:01 -0600860 if (Options & EOptionDebug)
861 Error("cannot generate debug information unless linking to generate code");
862
John Kessenich38f3b892013-09-06 19:52:57 +0000863 glslang::TWorkItem* workItem;
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +0200864 if (Options & EOptionStdin) {
John Kesseniche7f9cae2018-07-12 15:11:07 -0600865 if (worklist.remove(workItem)) {
866 ShHandle compiler = ShConstructCompiler(FindLanguage("stdin"), Options);
867 if (compiler == nullptr)
868 return;
John Kessenich2b07c7e2013-07-31 18:44:13 +0000869
John Kesseniche7f9cae2018-07-12 15:11:07 -0600870 CompileFile("stdin", compiler);
John Kessenich2b07c7e2013-07-31 18:44:13 +0000871
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +0200872 if (! (Options & EOptionSuppressInfolog))
873 workItem->results = ShGetInfoLog(compiler);
John Kessenich2b07c7e2013-07-31 18:44:13 +0000874
John Kesseniche7f9cae2018-07-12 15:11:07 -0600875 ShDestruct(compiler);
876 }
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +0200877 } else {
878 while (worklist.remove(workItem)) {
879 ShHandle compiler = ShConstructCompiler(FindLanguage(workItem->name), Options);
880 if (compiler == 0)
881 return;
882
883 CompileFile(workItem->name.c_str(), compiler);
884
885 if (! (Options & EOptionSuppressInfolog))
886 workItem->results = ShGetInfoLog(compiler);
887
888 ShDestruct(compiler);
889 }
John Kessenich2b07c7e2013-07-31 18:44:13 +0000890 }
John Kessenich2b07c7e2013-07-31 18:44:13 +0000891}
892
John Kessenich6626cad2015-06-19 05:14:19 +0000893// Outputs the given string, but only if it is non-null and non-empty.
894// This prevents erroneous newlines from appearing.
Andrew Woloszynaae1ad82015-06-24 17:00:46 -0400895void PutsIfNonEmpty(const char* str)
John Kessenich6626cad2015-06-19 05:14:19 +0000896{
897 if (str && str[0]) {
898 puts(str);
899 }
900}
901
Andrew Woloszynaae1ad82015-06-24 17:00:46 -0400902// Outputs the given string to stderr, but only if it is non-null and non-empty.
903// This prevents erroneous newlines from appearing.
904void StderrIfNonEmpty(const char* str)
905{
John Kessenich04acb1b2017-06-14 17:36:50 -0600906 if (str && str[0])
907 fprintf(stderr, "%s\n", str);
Andrew Woloszynaae1ad82015-06-24 17:00:46 -0400908}
909
John Kessenichc57b2a92016-01-16 15:30:03 -0700910// Simple bundling of what makes a compilation unit for ease in passing around,
911// and separation of handling file IO versus API (programmatic) compilation.
912struct ShaderCompUnit {
913 EShLanguage stage;
John Kessenich04acb1b2017-06-14 17:36:50 -0600914 static const int maxCount = 1;
915 int count; // live number of strings/names
John Kessenicha9313662017-06-15 10:40:49 -0600916 const char* text[maxCount]; // memory owned/managed externally
John Kessenich04acb1b2017-06-14 17:36:50 -0600917 std::string fileName[maxCount]; // hold's the memory, but...
918 const char* fileNameList[maxCount]; // downstream interface wants pointers
dankbakerafe6e9c2016-08-21 12:29:08 -0400919
John Kessenich04acb1b2017-06-14 17:36:50 -0600920 ShaderCompUnit(EShLanguage stage) : stage(stage), count(0) { }
dankbakerafe6e9c2016-08-21 12:29:08 -0400921
John Kessenich04acb1b2017-06-14 17:36:50 -0600922 ShaderCompUnit(const ShaderCompUnit& rhs)
dankbakerafe6e9c2016-08-21 12:29:08 -0400923 {
924 stage = rhs.stage;
John Kessenich04acb1b2017-06-14 17:36:50 -0600925 count = rhs.count;
926 for (int i = 0; i < count; ++i) {
927 fileName[i] = rhs.fileName[i];
928 text[i] = rhs.text[i];
929 fileNameList[i] = rhs.fileName[i].c_str();
930 }
dankbakerafe6e9c2016-08-21 12:29:08 -0400931 }
932
John Kessenicha9313662017-06-15 10:40:49 -0600933 void addString(std::string& ifileName, const char* itext)
John Kessenich04acb1b2017-06-14 17:36:50 -0600934 {
935 assert(count < maxCount);
936 fileName[count] = ifileName;
937 text[count] = itext;
938 fileNameList[count] = fileName[count].c_str();
939 ++count;
940 }
John Kessenichc57b2a92016-01-16 15:30:03 -0700941};
942
John Kessenich69f4b512013-09-04 21:19:27 +0000943//
John Kessenichc57b2a92016-01-16 15:30:03 -0700944// For linking mode: Will independently parse each compilation unit, but then put them
945// in the same program and link them together, making at most one linked module per
946// pipeline stage.
John Kessenich69f4b512013-09-04 21:19:27 +0000947//
948// Uses the new C++ interface instead of the old handle-based interface.
949//
John Kessenichc57b2a92016-01-16 15:30:03 -0700950
951void CompileAndLinkShaderUnits(std::vector<ShaderCompUnit> compUnits)
John Kessenich69f4b512013-09-04 21:19:27 +0000952{
953 // keep track of what to free
954 std::list<glslang::TShader*> shaders;
John Kessenichc57b2a92016-01-16 15:30:03 -0700955
John Kessenich69f4b512013-09-04 21:19:27 +0000956 EShMessages messages = EShMsgDefault;
John Kessenichb0a7eb52013-11-07 17:44:20 +0000957 SetMessageOptions(messages);
John Kessenich69f4b512013-09-04 21:19:27 +0000958
John Kessenich69f4b512013-09-04 21:19:27 +0000959 //
960 // Per-shader processing...
961 //
962
John Kessenich5b0f13a2013-11-01 03:08:40 +0000963 glslang::TProgram& program = *new glslang::TProgram;
rdb32084e82016-02-23 22:17:38 +0100964 for (auto it = compUnits.cbegin(); it != compUnits.cend(); ++it) {
965 const auto &compUnit = *it;
John Kessenichc57b2a92016-01-16 15:30:03 -0700966 glslang::TShader* shader = new glslang::TShader(compUnit.stage);
John Kessenich04acb1b2017-06-14 17:36:50 -0600967 shader->setStringsWithLengthsAndNames(compUnit.text, NULL, compUnit.fileNameList, compUnit.count);
John Kessenich640bd092018-08-09 14:15:00 -0600968 if (entryPointName)
John Kessenich4d65ee32016-03-12 18:17:47 -0700969 shader->setEntryPoint(entryPointName);
John Kessenich3693e632017-09-29 17:51:52 -0600970 if (sourceEntryPointName) {
971 if (entryPointName == nullptr)
972 printf("Warning: Changing source entry point name without setting an entry-point name.\n"
973 "Use '-e <name>'.\n");
steve-lunargf1e0c872016-10-31 15:13:43 -0600974 shader->setSourceEntryPoint(sourceEntryPointName);
John Kessenich3693e632017-09-29 17:51:52 -0600975 }
John Kessenicha9313662017-06-15 10:40:49 -0600976 if (UserPreamble.isSet())
977 shader->setPreamble(UserPreamble.get());
John Kessenich2a271162017-07-20 20:00:36 -0600978 shader->addProcesses(Processes);
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600979
John Kessenich155d3512019-08-08 23:29:20 -0600980#ifndef GLSLANG_WEB
LoopDawg08a14422017-10-17 19:27:14 -0600981 // Set IO mapper binding shift values
982 for (int r = 0; r < glslang::EResCount; ++r) {
983 const glslang::TResourceType res = glslang::TResourceType(r);
984
985 // Set base bindings
986 shader->setShiftBinding(res, baseBinding[res][compUnit.stage]);
987
988 // Set bindings for particular resource sets
989 // TODO: use a range based for loop here, when available in all environments.
990 for (auto i = baseBindingForSet[res][compUnit.stage].begin();
991 i != baseBindingForSet[res][compUnit.stage].end(); ++i)
LoopDawge5709552017-10-21 10:46:39 -0600992 shader->setShiftBindingForSet(res, i->second, i->first);
LoopDawg08a14422017-10-17 19:27:14 -0600993 }
steve-lunargcce8d482016-10-14 18:36:42 -0600994 shader->setNoStorageFormat((Options & EOptionNoStorageFormat) != 0);
Hyangran Park36dc8292017-05-02 16:27:29 +0900995 shader->setResourceSetBinding(baseResourceSetBinding[compUnit.stage]);
steve-lunarg7f7c2ed2016-09-07 15:20:19 -0600996
997 if (Options & EOptionAutoMapBindings)
998 shader->setAutoMapBindings(true);
John Kessenichecba76f2017-01-06 00:34:48 -0700999
John Kessenich71facdf2017-05-17 18:28:19 -06001000 if (Options & EOptionAutoMapLocations)
1001 shader->setAutoMapLocations(true);
1002
Neil Roberts16f53472018-03-20 17:30:53 +01001003 for (auto& uniOverride : uniformLocationOverrides) {
1004 shader->addUniformLocationOverride(uniOverride.first.c_str(),
1005 uniOverride.second);
1006 }
1007
Neil Robertsb0f3d792018-03-20 17:41:05 +01001008 shader->setUniformLocationBase(uniformBase);
John Kessenich155d3512019-08-08 23:29:20 -06001009#endif
1010
1011 shader->setNanMinMaxClamp(NaNClamp);
1012
1013#ifdef ENABLE_HLSL
1014 shader->setFlattenUniformArrays((Options & EOptionFlattenUniformArrays) != 0);
1015 if (Options & EOptionHlslIoMapping)
1016 shader->setHlslIoMapping(true);
1017#endif
1018
1019 if (Options & EOptionInvertY)
1020 shader->setInvertY(true);
Neil Robertsb0f3d792018-03-20 17:41:05 +01001021
John Kessenich4be4aeb2017-06-23 10:50:22 -06001022 // Set up the environment, some subsettings take precedence over earlier
1023 // ways of setting things.
1024 if (Options & EOptionSpv) {
John Kessenich8717a5d2018-10-26 10:12:32 -06001025 shader->setEnvInput((Options & EOptionReadHlsl) ? glslang::EShSourceHlsl
1026 : glslang::EShSourceGlsl,
1027 compUnit.stage, Client, ClientInputSemanticsVersion);
1028 shader->setEnvClient(Client, ClientVersion);
1029 shader->setEnvTarget(TargetLanguage, TargetVersion);
John Kessenichd4ed5152019-07-27 05:22:30 -06001030#ifdef ENABLE_HLSL
John Kessenich5d610ee2018-03-07 18:05:55 -07001031 if (targetHlslFunctionality1)
1032 shader->setEnvTargetHlslFunctionality1();
John Kessenichd4ed5152019-07-27 05:22:30 -06001033#endif
John Kessenich4be4aeb2017-06-23 10:50:22 -06001034 }
1035
John Kessenich69f4b512013-09-04 21:19:27 +00001036 shaders.push_back(shader);
John Kessenichb3297152015-07-11 18:01:03 -06001037
John Kessenich4be4aeb2017-06-23 10:50:22 -06001038 const int defaultVersion = Options & EOptionDefaultDesktop ? 110 : 100;
John Kessenich69f4b512013-09-04 21:19:27 +00001039
John Kessenich3494b4d2017-05-22 15:00:42 -06001040 DirStackFileIncluder includer;
John Kessenich971a0a82017-06-07 15:06:58 -06001041 std::for_each(IncludeDirectoryList.rbegin(), IncludeDirectoryList.rend(), [&includer](const std::string& dir) {
1042 includer.pushExternalLocalDirectory(dir); });
John Kessenichdeec1932019-08-13 08:00:30 -06001043#ifndef GLSLANG_WEB
John Kessenichc555ddd2015-06-17 02:38:44 +00001044 if (Options & EOptionOutputPreprocessed) {
1045 std::string str;
John Kessenich086febc2018-10-25 12:43:02 -06001046 if (shader->preprocess(&Resources, defaultVersion, ENoProfile, false, false, messages, &str, includer)) {
Andrew Woloszynaae1ad82015-06-24 17:00:46 -04001047 PutsIfNonEmpty(str.c_str());
1048 } else {
1049 CompileFailed = true;
1050 }
1051 StderrIfNonEmpty(shader->getInfoLog());
1052 StderrIfNonEmpty(shader->getInfoDebugLog());
John Kessenichc555ddd2015-06-17 02:38:44 +00001053 continue;
1054 }
John Kessenichdeec1932019-08-13 08:00:30 -06001055#endif
John Kessenich086febc2018-10-25 12:43:02 -06001056
John Kessenich3494b4d2017-05-22 15:00:42 -06001057 if (! shader->parse(&Resources, defaultVersion, false, messages, includer))
John Kessenichc999ba22013-11-07 23:33:24 +00001058 CompileFailed = true;
John Kessenichc555ddd2015-06-17 02:38:44 +00001059
John Kessenich69f4b512013-09-04 21:19:27 +00001060 program.addShader(shader);
1061
John Kessenichc57b2a92016-01-16 15:30:03 -07001062 if (! (Options & EOptionSuppressInfolog) &&
1063 ! (Options & EOptionMemoryLeakMode)) {
John Kessenich04acb1b2017-06-14 17:36:50 -06001064 PutsIfNonEmpty(compUnit.fileName[0].c_str());
Andrew Woloszynaae1ad82015-06-24 17:00:46 -04001065 PutsIfNonEmpty(shader->getInfoLog());
1066 PutsIfNonEmpty(shader->getInfoDebugLog());
John Kessenich69f4b512013-09-04 21:19:27 +00001067 }
John Kessenich69f4b512013-09-04 21:19:27 +00001068 }
1069
1070 //
1071 // Program-level processing...
1072 //
1073
John Kessenich4d65ee32016-03-12 18:17:47 -07001074 // Link
John Kessenich68d78fd2015-07-12 19:28:10 -06001075 if (! (Options & EOptionOutputPreprocessed) && ! program.link(messages))
John Kessenichc999ba22013-11-07 23:33:24 +00001076 LinkFailed = true;
1077
John Kessenichb6d3ee52019-08-06 02:20:45 -06001078#ifndef GLSLANG_WEB
steve-lunarg9ae34742016-10-05 13:40:13 -06001079 // Map IO
1080 if (Options & EOptionSpv) {
1081 if (!program.mapIO())
1082 LinkFailed = true;
1083 }
John Kessenichb6d3ee52019-08-06 02:20:45 -06001084#endif
John Kessenichecba76f2017-01-06 00:34:48 -07001085
John Kessenich4d65ee32016-03-12 18:17:47 -07001086 // Report
John Kessenichc57b2a92016-01-16 15:30:03 -07001087 if (! (Options & EOptionSuppressInfolog) &&
1088 ! (Options & EOptionMemoryLeakMode)) {
Andrew Woloszynaae1ad82015-06-24 17:00:46 -04001089 PutsIfNonEmpty(program.getInfoLog());
1090 PutsIfNonEmpty(program.getInfoDebugLog());
John Kessenich69f4b512013-09-04 21:19:27 +00001091 }
1092
John Kessenichb6d3ee52019-08-06 02:20:45 -06001093#ifndef GLSLANG_WEB
John Kessenich4d65ee32016-03-12 18:17:47 -07001094 // Reflect
John Kessenich11f9fc72013-11-07 01:06:34 +00001095 if (Options & EOptionDumpReflection) {
baldurk6d477852019-01-29 15:45:56 +00001096 program.buildReflection(ReflectOptions);
John Kessenich11f9fc72013-11-07 01:06:34 +00001097 program.dumpReflection();
1098 }
John Kessenichb6d3ee52019-08-06 02:20:45 -06001099#endif
John Kessenich11f9fc72013-11-07 01:06:34 +00001100
John Kessenich4d65ee32016-03-12 18:17:47 -07001101 // Dump SPIR-V
John Kessenich0df0cde2015-03-03 17:09:43 +00001102 if (Options & EOptionSpv) {
John Kessenich92f90382014-07-28 04:21:04 +00001103 if (CompileFailed || LinkFailed)
John Kessenich68d78fd2015-07-12 19:28:10 -06001104 printf("SPIR-V is not generated for failed compile or link\n");
John Kessenich92f90382014-07-28 04:21:04 +00001105 else {
1106 for (int stage = 0; stage < EShLangCount; ++stage) {
John Kessenicha7a68a92014-08-24 18:21:00 +00001107 if (program.getIntermediate((EShLanguage)stage)) {
John Kessenich0df0cde2015-03-03 17:09:43 +00001108 std::vector<unsigned int> spirv;
Lei Zhang09caf122016-05-02 18:11:54 -04001109 std::string warningsErrors;
Lei Zhang17535f72016-05-04 15:55:59 -04001110 spv::SpvBuildLogger logger;
John Kessenich121853f2017-05-31 17:11:16 -06001111 glslang::SpvOptions spvOptions;
1112 if (Options & EOptionDebug)
1113 spvOptions.generateDebugInfo = true;
GregF52fe3d52017-09-28 10:08:32 -06001114 spvOptions.disableOptimizer = (Options & EOptionOptimizeDisable) != 0;
1115 spvOptions.optimizeSize = (Options & EOptionOptimizeSize) != 0;
John Kessenich717c80a2018-08-23 15:17:10 -06001116 spvOptions.disassemble = SpvToolsDisassembler;
John Kessenichc3404252018-08-23 15:29:08 -06001117 spvOptions.validate = SpvToolsValidate;
John Kessenich121853f2017-05-31 17:11:16 -06001118 glslang::GlslangToSpv(*program.getIntermediate((EShLanguage)stage), spirv, &logger, &spvOptions);
John Kessenichc57b2a92016-01-16 15:30:03 -07001119
1120 // Dump the spv to a file or stdout, etc., but only if not doing
1121 // memory/perf testing, as it's not internal to programmatic use.
1122 if (! (Options & EOptionMemoryLeakMode)) {
Johannes van Waverenecb0f3b2016-05-27 12:55:53 -05001123 printf("%s", logger.getAllMessages().c_str());
1124 if (Options & EOptionOutputHexadecimal) {
John Kessenich8f674e82017-02-18 09:45:40 -07001125 glslang::OutputSpvHex(spirv, GetBinaryName((EShLanguage)stage), variableName);
Johannes van Waverenecb0f3b2016-05-27 12:55:53 -05001126 } else {
1127 glslang::OutputSpvBin(spirv, GetBinaryName((EShLanguage)stage));
1128 }
John Kessenich23d27752019-07-28 02:12:10 -06001129#ifndef GLSLANG_WEB
John Kesseniche2156222018-06-11 18:12:15 -06001130 if (!SpvToolsDisassembler && (Options & EOptionHumanReadableSpv))
John Kessenichc57b2a92016-01-16 15:30:03 -07001131 spv::Disassemble(std::cout, spirv);
John Kessenich23d27752019-07-28 02:12:10 -06001132#endif
John Kessenichacba7722015-03-04 03:48:38 +00001133 }
John Kessenicha7a68a92014-08-24 18:21:00 +00001134 }
John Kessenich92f90382014-07-28 04:21:04 +00001135 }
1136 }
1137 }
1138
John Kessenich5b0f13a2013-11-01 03:08:40 +00001139 // Free everything up, program has to go before the shaders
1140 // because it might have merged stuff from the shaders, and
1141 // the stuff from the shaders has to have its destructors called
1142 // before the pools holding the memory in the shaders is freed.
1143 delete &program;
John Kessenich69f4b512013-09-04 21:19:27 +00001144 while (shaders.size() > 0) {
1145 delete shaders.back();
1146 shaders.pop_back();
1147 }
John Kessenich69f4b512013-09-04 21:19:27 +00001148}
1149
John Kessenichc57b2a92016-01-16 15:30:03 -07001150//
1151// Do file IO part of compile and link, handing off the pure
1152// API/programmatic mode to CompileAndLinkShaderUnits(), which can
1153// be put in a loop for testing memory footprint and performance.
1154//
1155// This is just for linking mode: meaning all the shaders will be put into the
1156// the same program linked together.
1157//
1158// This means there are a limited number of work items (not multi-threading mode)
1159// and that the point is testing at the linking level. Hence, to enable
1160// performance and memory testing, the actual compile/link can be put in
1161// a loop, independent of processing the work items and file IO.
1162//
Juan Lopeza558b262017-04-02 23:04:00 +02001163void CompileAndLinkShaderFiles(glslang::TWorklist& Worklist)
John Kessenichc57b2a92016-01-16 15:30:03 -07001164{
1165 std::vector<ShaderCompUnit> compUnits;
1166
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001167 // If this is using stdin, we can't really detect multiple different file
1168 // units by input type. We need to assume that we're just being given one
1169 // file of a certain type.
1170 if ((Options & EOptionStdin) != 0) {
1171 ShaderCompUnit compUnit(FindLanguage("stdin"));
1172 std::istreambuf_iterator<char> begin(std::cin), end;
1173 std::string tempString(begin, end);
1174 char* fileText = strdup(tempString.c_str());
1175 std::string fileName = "stdin";
1176 compUnit.addString(fileName, fileText);
John Kessenichc57b2a92016-01-16 15:30:03 -07001177 compUnits.push_back(compUnit);
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001178 } else {
1179 // Transfer all the work items from to a simple list of
1180 // of compilation units. (We don't care about the thread
1181 // work-item distribution properties in this path, which
1182 // is okay due to the limited number of shaders, know since
1183 // they are all getting linked together.)
1184 glslang::TWorkItem* workItem;
1185 while (Worklist.remove(workItem)) {
1186 ShaderCompUnit compUnit(FindLanguage(workItem->name));
1187 char* fileText = ReadFileData(workItem->name.c_str());
1188 if (fileText == nullptr)
1189 usage();
1190 compUnit.addString(workItem->name, fileText);
1191 compUnits.push_back(compUnit);
1192 }
John Kessenichc57b2a92016-01-16 15:30:03 -07001193 }
1194
1195 // Actual call to programmatic processing of compile and link,
1196 // in a loop for testing memory and performance. This part contains
1197 // all the perf/memory that a programmatic consumer will care about.
1198 for (int i = 0; i < ((Options & EOptionMemoryLeakMode) ? 100 : 1); ++i) {
1199 for (int j = 0; j < ((Options & EOptionMemoryLeakMode) ? 100 : 1); ++j)
1200 CompileAndLinkShaderUnits(compUnits);
1201
1202 if (Options & EOptionMemoryLeakMode)
1203 glslang::OS_DumpMemoryCounters();
1204 }
1205
John Kessenicha9313662017-06-15 10:40:49 -06001206 // free memory from ReadFileData, which got stored in a const char*
1207 // as the first string above
rdb32084e82016-02-23 22:17:38 +01001208 for (auto it = compUnits.begin(); it != compUnits.end(); ++it)
John Kessenicha9313662017-06-15 10:40:49 -06001209 FreeFileData(const_cast<char*>(it->text[0]));
John Kessenichc57b2a92016-01-16 15:30:03 -07001210}
1211
John Kessenich94f28eb2017-11-13 01:32:06 -07001212int singleMain()
John Kessenicha0af4732012-12-12 21:15:54 +00001213{
Juan Lopeza558b262017-04-02 23:04:00 +02001214 glslang::TWorklist workList;
John Kessenich94f28eb2017-11-13 01:32:06 -07001215 std::for_each(WorkItems.begin(), WorkItems.end(), [&workList](std::unique_ptr<glslang::TWorkItem>& item) {
Juan Lopeza558b262017-04-02 23:04:00 +02001216 assert(item);
1217 workList.add(item.get());
1218 });
John Kessenich2b07c7e2013-07-31 18:44:13 +00001219
John Kessenich23d27752019-07-28 02:12:10 -06001220#ifndef GLSLANG_WEB
John Kessenich05a70632013-09-17 19:26:08 +00001221 if (Options & EOptionDumpConfig) {
Lei Zhang414eb602016-03-04 16:22:34 -05001222 printf("%s", glslang::GetDefaultTBuiltInResourceString().c_str());
Juan Lopeza558b262017-04-02 23:04:00 +02001223 if (workList.empty())
John Kessenich05a70632013-09-17 19:26:08 +00001224 return ESuccess;
1225 }
John Kessenich23d27752019-07-28 02:12:10 -06001226#endif
John Kessenich05a70632013-09-17 19:26:08 +00001227
John Kessenichc6c80a62018-03-05 22:23:17 -07001228 if (Options & EOptionDumpBareVersion) {
1229 printf("%d.%d.%d\n",
1230 glslang::GetSpirvGeneratorVersion(), GLSLANG_MINOR_VERSION, GLSLANG_PATCH_LEVEL);
1231 if (workList.empty())
1232 return ESuccess;
1233 } else if (Options & EOptionDumpVersions) {
1234 printf("Glslang Version: %d.%d.%d\n",
1235 glslang::GetSpirvGeneratorVersion(), GLSLANG_MINOR_VERSION, GLSLANG_PATCH_LEVEL);
John Kessenich319de232013-12-04 04:43:40 +00001236 printf("ESSL Version: %s\n", glslang::GetEsslVersionString());
1237 printf("GLSL Version: %s\n", glslang::GetGlslVersionString());
John Kessenich68d78fd2015-07-12 19:28:10 -06001238 std::string spirvVersion;
1239 glslang::GetSpirvVersion(spirvVersion);
John Kessenich0da9eaa2015-08-01 17:10:02 -06001240 printf("SPIR-V Version %s\n", spirvVersion.c_str());
John Kessenich5e4b1242015-08-06 22:53:06 -06001241 printf("GLSL.std.450 Version %d, Revision %d\n", GLSLstd450Version, GLSLstd450Revision);
John Kessenich55e7d112015-11-15 21:33:39 -07001242 printf("Khronos Tool ID %d\n", glslang::GetKhronosToolId());
John Kessenicha372a3e2017-11-02 22:32:14 -06001243 printf("SPIR-V Generator Version %d\n", glslang::GetSpirvGeneratorVersion());
John Kessenichb84313d2016-07-20 16:03:29 -06001244 printf("GL_KHR_vulkan_glsl version %d\n", 100);
1245 printf("ARB_GL_gl_spirv version %d\n", 100);
Juan Lopeza558b262017-04-02 23:04:00 +02001246 if (workList.empty())
John Kessenich319de232013-12-04 04:43:40 +00001247 return ESuccess;
1248 }
1249
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001250 if (workList.empty() && ((Options & EOptionStdin) == 0)) {
John Kessenich05a70632013-09-17 19:26:08 +00001251 usage();
John Kessenich05a70632013-09-17 19:26:08 +00001252 }
1253
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001254 if (Options & EOptionStdin) {
John Kessenich94f28eb2017-11-13 01:32:06 -07001255 WorkItems.push_back(std::unique_ptr<glslang::TWorkItem>{new glslang::TWorkItem("stdin")});
1256 workList.add(WorkItems.back().get());
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001257 }
1258
John Kessenich05a70632013-09-17 19:26:08 +00001259 ProcessConfigFile();
1260
John Kessenich086febc2018-10-25 12:43:02 -06001261 if ((Options & EOptionReadHlsl) && !((Options & EOptionOutputPreprocessed) || (Options & EOptionSpv)))
1262 Error("ERROR: HLSL requires SPIR-V code generation (or preprocessing only)");
1263
John Kessenich69f4b512013-09-04 21:19:27 +00001264 //
1265 // Two modes:
John Kessenich38f3b892013-09-06 19:52:57 +00001266 // 1) linking all arguments together, single-threaded, new C++ interface
1267 // 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 +00001268 //
John Kessenich086febc2018-10-25 12:43:02 -06001269 if (Options & (EOptionLinkProgram | EOptionOutputPreprocessed)) {
John Kessenichc36e1d82013-11-01 17:41:52 +00001270 glslang::InitializeProcess();
John Kesseniche2c15b42017-11-16 22:48:41 -07001271 glslang::InitializeProcess(); // also test reference counting of users
1272 glslang::InitializeProcess(); // also test reference counting of users
1273 glslang::FinalizeProcess(); // also test reference counting of users
1274 glslang::FinalizeProcess(); // also test reference counting of users
Juan Lopeza558b262017-04-02 23:04:00 +02001275 CompileAndLinkShaderFiles(workList);
John Kessenichc36e1d82013-11-01 17:41:52 +00001276 glslang::FinalizeProcess();
1277 } else {
1278 ShInitialize();
John Kesseniche2c15b42017-11-16 22:48:41 -07001279 ShInitialize(); // also test reference counting of users
1280 ShFinalize(); // also test reference counting of users
John Kessenichc36e1d82013-11-01 17:41:52 +00001281
Juan Lopeza558b262017-04-02 23:04:00 +02001282 bool printShaderNames = workList.size() > 1;
John Kessenich69f4b512013-09-04 21:19:27 +00001283
John Kesseniche2c15b42017-11-16 22:48:41 -07001284 if (Options & EOptionMultiThreaded) {
Juan Lopeza558b262017-04-02 23:04:00 +02001285 std::array<std::thread, 16> threads;
John Kesseniche2c15b42017-11-16 22:48:41 -07001286 for (unsigned int t = 0; t < threads.size(); ++t) {
Juan Lopeza558b262017-04-02 23:04:00 +02001287 threads[t] = std::thread(CompileShaders, std::ref(workList));
John Kesseniche2c15b42017-11-16 22:48:41 -07001288 if (threads[t].get_id() == std::thread::id()) {
John Kessenichaf527992017-11-02 22:48:15 -06001289 fprintf(stderr, "Failed to create thread\n");
John Kessenich38f3b892013-09-06 19:52:57 +00001290 return EFailThreadCreate;
1291 }
John Kessenicha0af4732012-12-12 21:15:54 +00001292 }
Juan Lopeza558b262017-04-02 23:04:00 +02001293
1294 std::for_each(threads.begin(), threads.end(), [](std::thread& t) { t.join(); });
John Kessenichc999ba22013-11-07 23:33:24 +00001295 } else
Juan Lopeza558b262017-04-02 23:04:00 +02001296 CompileShaders(workList);
John Kessenich38f3b892013-09-06 19:52:57 +00001297
1298 // Print out all the resulting infologs
John Kessenich94f28eb2017-11-13 01:32:06 -07001299 for (size_t w = 0; w < WorkItems.size(); ++w) {
1300 if (WorkItems[w]) {
1301 if (printShaderNames || WorkItems[w]->results.size() > 0)
1302 PutsIfNonEmpty(WorkItems[w]->name.c_str());
1303 PutsIfNonEmpty(WorkItems[w]->results.c_str());
John Kessenich38f3b892013-09-06 19:52:57 +00001304 }
1305 }
John Kessenichc36e1d82013-11-01 17:41:52 +00001306
1307 ShFinalize();
John Kessenicha0af4732012-12-12 21:15:54 +00001308 }
John Kessenich2b07c7e2013-07-31 18:44:13 +00001309
John Kessenichc999ba22013-11-07 23:33:24 +00001310 if (CompileFailed)
John Kessenicha0af4732012-12-12 21:15:54 +00001311 return EFailCompile;
John Kessenichc999ba22013-11-07 23:33:24 +00001312 if (LinkFailed)
John Kessenicha0af4732012-12-12 21:15:54 +00001313 return EFailLink;
1314
1315 return 0;
1316}
1317
John Kessenich94f28eb2017-11-13 01:32:06 -07001318int C_DECL main(int argc, char* argv[])
1319{
1320 ProcessArguments(WorkItems, argc, argv);
1321
1322 int ret = 0;
1323
1324 // Loop over the entire init/finalize cycle to watch memory changes
1325 const int iterations = 1;
1326 if (iterations > 1)
1327 glslang::OS_DumpMemoryCounters();
1328 for (int i = 0; i < iterations; ++i) {
1329 ret = singleMain();
1330 if (iterations > 1)
1331 glslang::OS_DumpMemoryCounters();
1332 }
1333
1334 return ret;
1335}
1336
John Kessenicha0af4732012-12-12 21:15:54 +00001337//
1338// Deduce the language from the filename. Files must end in one of the
1339// following extensions:
1340//
John Kessenich2b07c7e2013-07-31 18:44:13 +00001341// .vert = vertex
1342// .tesc = tessellation control
1343// .tese = tessellation evaluation
1344// .geom = geometry
1345// .frag = fragment
John Kessenich94a81fb2013-08-31 02:41:30 +00001346// .comp = compute
Chao Chenb50c02e2018-09-19 11:42:24 -07001347// .rgen = ray generation
1348// .rint = ray intersection
1349// .rahit = ray any hit
1350// .rchit = ray closest hit
1351// .rmiss = ray miss
1352// .rcall = ray callable
Sahil Parmar035cbbe2018-10-04 16:39:18 -07001353// .mesh = mesh
1354// .task = task
Grigory Dzhavadyan33507412018-04-12 14:35:24 -07001355// Additionally, the file names may end in .<stage>.glsl and .<stage>.hlsl
1356// where <stage> is one of the stages listed above.
1357//
1358EShLanguage FindLanguage(const std::string& name, bool parseStageName)
John Kessenicha0af4732012-12-12 21:15:54 +00001359{
John Kessenichfccbb8b2018-04-17 17:24:03 -06001360 std::string stageName;
Dan Bakerc6ede892016-08-11 14:06:06 -04001361 if (shaderStageName)
John Kessenichfccbb8b2018-04-17 17:24:03 -06001362 stageName = shaderStageName;
1363 else if (parseStageName) {
Grigory Dzhavadyan33507412018-04-12 14:35:24 -07001364 // Note: "first" extension means "first from the end", i.e.
1365 // if the file is named foo.vert.glsl, then "glsl" is first,
1366 // "vert" is second.
John Kessenichfccbb8b2018-04-17 17:24:03 -06001367 size_t firstExtStart = name.find_last_of(".");
1368 bool hasFirstExt = firstExtStart != std::string::npos;
1369 size_t secondExtStart = hasFirstExt ? name.find_last_of(".", firstExtStart - 1) : std::string::npos;
1370 bool hasSecondExt = secondExtStart != std::string::npos;
1371 std::string firstExt = name.substr(firstExtStart + 1, std::string::npos);
1372 bool usesUnifiedExt = hasFirstExt && (firstExt == "glsl" || firstExt == "hlsl");
John Kessenich3beac942018-04-17 21:02:19 -06001373 if (usesUnifiedExt && firstExt == "hlsl")
1374 Options |= EOptionReadHlsl;
1375 if (hasFirstExt && !usesUnifiedExt)
John Kessenichfccbb8b2018-04-17 17:24:03 -06001376 stageName = firstExt;
John Kessenich3beac942018-04-17 21:02:19 -06001377 else if (usesUnifiedExt && hasSecondExt)
John Kessenichfccbb8b2018-04-17 17:24:03 -06001378 stageName = name.substr(secondExtStart + 1, firstExtStart - secondExtStart - 1);
John Kessenich3beac942018-04-17 21:02:19 -06001379 else {
Grigory Dzhavadyan33507412018-04-12 14:35:24 -07001380 usage();
1381 return EShLangVertex;
John Kesseniche751bca2017-03-16 11:20:38 -06001382 }
John Kessenichfccbb8b2018-04-17 17:24:03 -06001383 } else
1384 stageName = name;
dankbaker45d49bc2016-08-08 21:43:07 -04001385
John Kessenichfccbb8b2018-04-17 17:24:03 -06001386 if (stageName == "vert")
John Kessenich2b07c7e2013-07-31 18:44:13 +00001387 return EShLangVertex;
John Kessenichfccbb8b2018-04-17 17:24:03 -06001388 else if (stageName == "tesc")
John Kessenich2b07c7e2013-07-31 18:44:13 +00001389 return EShLangTessControl;
John Kessenichfccbb8b2018-04-17 17:24:03 -06001390 else if (stageName == "tese")
John Kessenich2b07c7e2013-07-31 18:44:13 +00001391 return EShLangTessEvaluation;
John Kessenichfccbb8b2018-04-17 17:24:03 -06001392 else if (stageName == "geom")
John Kessenich2b07c7e2013-07-31 18:44:13 +00001393 return EShLangGeometry;
John Kessenichfccbb8b2018-04-17 17:24:03 -06001394 else if (stageName == "frag")
John Kessenich2b07c7e2013-07-31 18:44:13 +00001395 return EShLangFragment;
John Kessenichfccbb8b2018-04-17 17:24:03 -06001396 else if (stageName == "comp")
John Kessenichc0275792013-08-09 17:14:49 +00001397 return EShLangCompute;
Chao Chenb50c02e2018-09-19 11:42:24 -07001398 else if (stageName == "rgen")
1399 return EShLangRayGenNV;
1400 else if (stageName == "rint")
1401 return EShLangIntersectNV;
1402 else if (stageName == "rahit")
1403 return EShLangAnyHitNV;
1404 else if (stageName == "rchit")
1405 return EShLangClosestHitNV;
1406 else if (stageName == "rmiss")
1407 return EShLangMissNV;
1408 else if (stageName == "rcall")
1409 return EShLangCallableNV;
Chao Chen3c366992018-09-19 11:41:59 -07001410 else if (stageName == "mesh")
1411 return EShLangMeshNV;
1412 else if (stageName == "task")
1413 return EShLangTaskNV;
John Kessenich2b07c7e2013-07-31 18:44:13 +00001414
1415 usage();
John Kesseniche95ecc52012-12-12 21:34:14 +00001416 return EShLangVertex;
John Kessenicha0af4732012-12-12 21:15:54 +00001417}
1418
John Kessenicha0af4732012-12-12 21:15:54 +00001419//
John Kessenichecba76f2017-01-06 00:34:48 -07001420// Read a file's data into a string, and compile it using the old interface ShCompile,
John Kessenich69f4b512013-09-04 21:19:27 +00001421// for non-linkable results.
John Kessenicha0af4732012-12-12 21:15:54 +00001422//
John Kessenich51cdd902014-02-18 23:37:57 +00001423void CompileFile(const char* fileName, ShHandle compiler)
John Kessenicha0af4732012-12-12 21:15:54 +00001424{
John Kessenichca3457f2015-05-18 01:59:45 +00001425 int ret = 0;
Sven-Hendrik Haase0dd12852017-09-02 19:34:54 +02001426 char* shaderString;
1427 if ((Options & EOptionStdin) != 0) {
1428 std::istreambuf_iterator<char> begin(std::cin), end;
1429 std::string tempString(begin, end);
1430 shaderString = strdup(tempString.c_str());
1431 } else {
1432 shaderString = ReadFileData(fileName);
1433 }
John Kessenich41cf6b52013-06-25 18:10:05 +00001434
1435 // move to length-based strings, rather than null-terminated strings
John Kessenich04acb1b2017-06-14 17:36:50 -06001436 int* lengths = new int[1];
1437 lengths[0] = (int)strlen(shaderString);
John Kessenicha0af4732012-12-12 21:15:54 +00001438
John Kessenich52ac67e2013-05-05 23:46:22 +00001439 EShMessages messages = EShMsgDefault;
John Kessenichb0a7eb52013-11-07 17:44:20 +00001440 SetMessageOptions(messages);
John Kessenichecba76f2017-01-06 00:34:48 -07001441
John Kessenicha9313662017-06-15 10:40:49 -06001442 if (UserPreamble.isSet())
1443 Error("-D and -U options require -l (linking)\n");
1444
John Kessenich94a81fb2013-08-31 02:41:30 +00001445 for (int i = 0; i < ((Options & EOptionMemoryLeakMode) ? 100 : 1); ++i) {
1446 for (int j = 0; j < ((Options & EOptionMemoryLeakMode) ? 100 : 1); ++j) {
John Kessenich927608b2017-01-06 12:34:14 -07001447 // ret = ShCompile(compiler, shaderStrings, NumShaderStrings, lengths, EShOptNone, &Resources, Options, (Options & EOptionDefaultDesktop) ? 110 : 100, false, messages);
John Kessenich04acb1b2017-06-14 17:36:50 -06001448 ret = ShCompile(compiler, &shaderString, 1, nullptr, EShOptNone, &Resources, Options, (Options & EOptionDefaultDesktop) ? 110 : 100, false, messages);
John Kessenich927608b2017-01-06 12:34:14 -07001449 // const char* multi[12] = { "# ve", "rsion", " 300 e", "s", "\n#err",
John Kessenichecba76f2017-01-06 00:34:48 -07001450 // "or should be l", "ine 1", "string 5\n", "float glo", "bal",
John Kessenichea869fb2013-10-28 18:12:06 +00001451 // ";\n#error should be line 2\n void main() {", "global = 2.3;}" };
John Kessenich927608b2017-01-06 12:34:14 -07001452 // const char* multi[7] = { "/", "/", "\\", "\n", "\n", "#", "version 300 es" };
1453 // ret = ShCompile(compiler, multi, 7, nullptr, EShOptNone, &Resources, Options, (Options & EOptionDefaultDesktop) ? 110 : 100, false, messages);
John Kessenich41cf6b52013-06-25 18:10:05 +00001454 }
John Kessenicha0af4732012-12-12 21:15:54 +00001455
John Kessenich94a81fb2013-08-31 02:41:30 +00001456 if (Options & EOptionMemoryLeakMode)
John Kessenich2b07c7e2013-07-31 18:44:13 +00001457 glslang::OS_DumpMemoryCounters();
John Kessenicha0af4732012-12-12 21:15:54 +00001458 }
John Kessenicha0af4732012-12-12 21:15:54 +00001459
John Kessenich41cf6b52013-06-25 18:10:05 +00001460 delete [] lengths;
John Kessenich04acb1b2017-06-14 17:36:50 -06001461 FreeFileData(shaderString);
John Kessenicha0af4732012-12-12 21:15:54 +00001462
John Kessenichc999ba22013-11-07 23:33:24 +00001463 if (ret == 0)
1464 CompileFailed = true;
John Kessenicha0af4732012-12-12 21:15:54 +00001465}
1466
John Kessenicha0af4732012-12-12 21:15:54 +00001467//
1468// print usage to stdout
1469//
1470void usage()
1471{
John Kessenich319de232013-12-04 04:43:40 +00001472 printf("Usage: glslangValidator [option]... [file]...\n"
1473 "\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001474 "'file' can end in .<stage> for auto-stage classification, where <stage> is:\n"
1475 " .conf to provide a config file that replaces the default configuration\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001476 " (see -c option below for generating a template)\n"
1477 " .vert for a vertex shader\n"
1478 " .tesc for a tessellation control shader\n"
1479 " .tese for a tessellation evaluation shader\n"
1480 " .geom for a geometry shader\n"
1481 " .frag for a fragment shader\n"
1482 " .comp for a compute shader\n"
Chao Chen3c366992018-09-19 11:41:59 -07001483 " .mesh for a mesh shader\n"
1484 " .task for a task shader\n"
Chao Chenb50c02e2018-09-19 11:42:24 -07001485 " .rgen for a ray generation shader\n"
1486 " .rint for a ray intersection shader\n"
1487 " .rahit for a ray any hit shader\n"
1488 " .rchit for a ray closest hit shader\n"
1489 " .rmiss for a ray miss shader\n"
Sahil Parmar035cbbe2018-10-04 16:39:18 -07001490 " .rcall for a ray callable shader\n"
John Kessenich2ead40f2018-04-17 17:44:11 -06001491 " .glsl for .vert.glsl, .tesc.glsl, ..., .comp.glsl compound suffixes\n"
1492 " .hlsl for .vert.hlsl, .tesc.hlsl, ..., .comp.hlsl compound suffixes\n"
John Kessenich319de232013-12-04 04:43:40 +00001493 "\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001494 "Options:\n"
1495 " -C cascading errors; risk crash from accumulation of error recoveries\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001496 " -D input is HLSL (this is the default when any suffix is .hlsl)\n"
John Kessenicha9313662017-06-15 10:40:49 -06001497 " -D<macro=def>\n"
1498 " -D<macro> define a pre-processor macro\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001499 " -E print pre-processed GLSL; cannot be used with -l;\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001500 " errors will appear on stderr\n"
John Kessenich6353d552017-06-23 11:11:09 -06001501 " -G[ver] create SPIR-V binary, under OpenGL semantics; turns on -l;\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001502 " default file name is <stage>.spv (-o overrides this);\n"
John Kessenich6353d552017-06-23 11:11:09 -06001503 " 'ver', when present, is the version of the input semantics,\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001504 " which will appear in #define GL_SPIRV ver;\n"
1505 " '--client opengl100' is the same as -G100;\n"
John Kessenich6353d552017-06-23 11:11:09 -06001506 " a '--target-env' for OpenGL will also imply '-G'\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001507 " -H print human readable form of SPIR-V; turns on -V\n"
John Kessenich971a0a82017-06-07 15:06:58 -06001508 " -I<dir> add dir to the include search path; includer's directory\n"
1509 " is searched first, followed by left-to-right order of -I\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001510 " -Od disables optimization; may cause illegal SPIR-V for HLSL\n"
1511 " -Os optimizes SPIR-V to minimize size\n"
John Kesseniche751bca2017-03-16 11:20:38 -06001512 " -S <stage> uses specified stage rather than parsing the file extension\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001513 " choices for <stage> are vert, tesc, tese, geom, frag, or comp\n"
John Kessenich6353d552017-06-23 11:11:09 -06001514 " -U<macro> undefine a pre-processor macro\n"
1515 " -V[ver] create SPIR-V binary, under Vulkan semantics; turns on -l;\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001516 " default file name is <stage>.spv (-o overrides this)\n"
John Kessenich6353d552017-06-23 11:11:09 -06001517 " 'ver', when present, is the version of the input semantics,\n"
1518 " which will appear in #define VULKAN ver\n"
1519 " '--client vulkan100' is the same as -V100\n"
1520 " a '--target-env' for Vulkan will also imply '-V'\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001521 " -c configuration dump;\n"
1522 " creates the default configuration file (redirect to a .conf file)\n"
1523 " -d default to desktop (#version 110) when there is no shader #version\n"
1524 " (default is ES version 100)\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001525 " -e <name> | --entry-point <name>\n"
1526 " specify <name> as the entry-point function name\n"
John Kessenich5d610ee2018-03-07 18:05:55 -07001527 " -f{hlsl_functionality1}\n"
1528 " 'hlsl_functionality1' enables use of the\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001529 " SPV_GOOGLE_hlsl_functionality1 extension\n"
John Kessenich121853f2017-05-31 17:11:16 -06001530 " -g generate debug information\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001531 " -h print this usage message\n"
1532 " -i intermediate tree (glslang AST) is printed out\n"
1533 " -l link all input files together to form a single module\n"
1534 " -m memory leak mode\n"
John Kessenicha25530c2017-09-11 20:13:49 -06001535 " -o <file> save binary to <file>, requires a binary option (e.g., -V)\n"
John Kesseniche5c394b2019-07-02 09:32:48 -06001536 " -q dump reflection query database; requires -l for linking\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001537 " -r | --relaxed-errors"
1538 " relaxed GLSL semantic error-checking mode\n"
John Kessenichb63f4a32017-11-16 22:32:20 -07001539 " -s silence syntax and semantic error reporting\n"
John Kessenich68d78fd2015-07-12 19:28:10 -06001540 " -t multi-threaded mode\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001541 " -v | --version\n"
1542 " print version strings\n"
1543 " -w | --suppress-warnings\n"
1544 " suppress GLSL warnings, except as required by \"#extension : warn\"\n"
John Kessenich6263fb12017-06-14 15:52:44 -06001545 " -x save binary output as text-based 32-bit hexadecimal numbers\n"
Neil Roberts16f53472018-03-20 17:30:53 +01001546 " -u<name>:<loc> specify a uniform location override for --aml\n"
Neil Robertsb0f3d792018-03-20 17:41:05 +01001547 " --uniform-base <base> set a base to use for generated uniform locations\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001548 " --auto-map-bindings | --amb automatically bind uniform variables\n"
1549 " without explicit bindings\n"
1550 " --auto-map-locations | --aml automatically locate input/output lacking\n"
1551 " 'location' (fragile, not cross stage)\n"
1552 " --client {vulkan<ver>|opengl<ver>} see -V and -G\n"
Christoph Kubisch412ff6e2019-04-13 22:57:33 +02001553 " --dump-builtin-symbols prints builtin symbol table prior each compile\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001554 " -dumpfullversion | -dumpversion print bare major.minor.patchlevel\n"
1555 " --flatten-uniform-arrays | --fua flatten uniform texture/sampler arrays to\n"
1556 " scalars\n"
1557 " --hlsl-offsets allow block offsets to follow HLSL rules\n"
1558 " works independently of source language\n"
1559 " --hlsl-iomap perform IO mapping in HLSL register space\n"
1560 " --hlsl-enable-16bit-types allow 16-bit types in SPIR-V for HLSL\n"
John Kessenich605afc72019-06-17 23:33:09 -06001561 " --hlsl-dx9-compatible interprets sampler declarations as a\n"
1562 " texture/sampler combo like DirectX9 would.\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001563 " --invert-y | --iy invert position.Y output in vertex shader\n"
1564 " --keep-uncalled | --ku don't eliminate uncalled functions\n"
John Kessenich605afc72019-06-17 23:33:09 -06001565 " --nan-clamp favor non-NaN operand in min, max, and clamp\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001566 " --no-storage-format | --nsf use Unknown image format\n"
baldurk4513df92019-02-08 10:48:48 +00001567 " --reflect-strict-array-suffix use strict array suffix rules when\n"
1568 " reflecting\n"
baldurkedf82122019-01-29 15:49:00 +00001569 " --reflect-basic-array-suffix arrays of basic types will have trailing [0]\n"
baldurk4513df92019-02-08 10:48:48 +00001570 " --reflect-intermediate-io reflection includes inputs/outputs of linked\n"
1571 " shaders rather than just vertex/fragment\n"
1572 " --reflect-separate-buffers reflect buffer variables and blocks\n"
1573 " separately to uniforms\n"
1574 " --reflect-all-block-variables reflect all variables in blocks, whether\n"
1575 " inactive or active\n"
baldurk19050692019-02-11 11:50:24 +00001576 " --reflect-unwrap-io-blocks unwrap input/output blocks the same as\n"
1577 " uniform blocks\n"
LoopDawg52017192017-07-14 15:15:47 -06001578 " --resource-set-binding [stage] name set binding\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001579 " set descriptor set and binding for\n"
1580 " individual resources\n"
LoopDawg52017192017-07-14 15:15:47 -06001581 " --resource-set-binding [stage] set\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001582 " set descriptor set for all resources\n"
1583 " --rsb synonym for --resource-set-binding\n"
1584 " --shift-image-binding [stage] num\n"
1585 " base binding number for images (uav)\n"
1586 " --shift-image-binding [stage] [num set]...\n"
1587 " per-descriptor-set shift values\n"
1588 " --sib synonym for --shift-image-binding\n"
1589 " --shift-sampler-binding [stage] num\n"
1590 " base binding number for samplers\n"
1591 " --shift-sampler-binding [stage] [num set]...\n"
1592 " per-descriptor-set shift values\n"
1593 " --ssb synonym for --shift-sampler-binding\n"
1594 " --shift-ssbo-binding [stage] num base binding number for SSBOs\n"
1595 " --shift-ssbo-binding [stage] [num set]...\n"
1596 " per-descriptor-set shift values\n"
1597 " --sbb synonym for --shift-ssbo-binding\n"
1598 " --shift-texture-binding [stage] num\n"
1599 " base binding number for textures\n"
1600 " --shift-texture-binding [stage] [num set]...\n"
1601 " per-descriptor-set shift values\n"
1602 " --stb synonym for --shift-texture-binding\n"
1603 " --shift-uav-binding [stage] num base binding number for UAVs\n"
1604 " --shift-uav-binding [stage] [num set]...\n"
1605 " per-descriptor-set shift values\n"
1606 " --suavb synonym for --shift-uav-binding\n"
1607 " --shift-UBO-binding [stage] num base binding number for UBOs\n"
1608 " --shift-UBO-binding [stage] [num set]...\n"
1609 " per-descriptor-set shift values\n"
1610 " --sub synonym for --shift-UBO-binding\n"
1611 " --shift-cbuffer-binding | --scb synonyms for --shift-UBO-binding\n"
1612 " --spirv-dis output standard-form disassembly; works only\n"
1613 " when a SPIR-V generation option is also used\n"
John Kessenichc3404252018-08-23 15:29:08 -06001614 " --spirv-val execute the SPIRV-Tools validator\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001615 " --source-entrypoint <name> the given shader source function is\n"
1616 " renamed to be the <name> given in -e\n"
1617 " --sep synonym for --source-entrypoint\n"
1618 " --stdin read from stdin instead of from a file;\n"
1619 " requires providing the shader stage using -S\n"
John Kessenich8717a5d2018-10-26 10:12:32 -06001620 " --target-env {vulkan1.0 | vulkan1.1 | opengl | \n"
1621 " spirv1.0 | spirv1.1 | spirv1.2 | spirv1.3}\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001622 " set execution environment that emitted code\n"
John Kessenich8717a5d2018-10-26 10:12:32 -06001623 " will execute in (versus source language\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001624 " semantics selected by --client) defaults:\n"
1625 " * 'vulkan1.0' under '--client vulkan<ver>'\n"
1626 " * 'opengl' under '--client opengl<ver>'\n"
John Kessenich8717a5d2018-10-26 10:12:32 -06001627 " * 'spirv1.0' under --target-env vulkan1.0\n"
1628 " * 'spirv1.3' under --target-env vulkan1.1\n"
1629 " multiple --targen-env can be specified.\n"
John Kessenichade8bbb2018-08-12 21:24:55 -06001630 " --variable-name <name>\n"
1631 " --vn <name> creates a C header file that contains a\n"
1632 " uint32_t array named <name>\n"
1633 " initialized with the shader binary code\n"
John Kessenichb0a7eb52013-11-07 17:44:20 +00001634 );
John Kessenich68d78fd2015-07-12 19:28:10 -06001635
1636 exit(EFailUsage);
John Kessenicha0af4732012-12-12 21:15:54 +00001637}
1638
John Kessenich3ce4e592014-10-06 19:57:34 +00001639#if !defined _MSC_VER && !defined MINGW_HAS_SECURE_API
John Kessenichcfd643e2013-03-08 23:14:42 +00001640
1641#include <errno.h>
1642
1643int fopen_s(
1644 FILE** pFile,
John Kessenich51cdd902014-02-18 23:37:57 +00001645 const char* filename,
1646 const char* mode
John Kessenichcfd643e2013-03-08 23:14:42 +00001647)
1648{
1649 if (!pFile || !filename || !mode) {
1650 return EINVAL;
1651 }
1652
1653 FILE* f = fopen(filename, mode);
1654 if (! f) {
1655 if (errno != 0) {
1656 return errno;
1657 } else {
1658 return ENOENT;
1659 }
1660 }
1661 *pFile = f;
1662
1663 return 0;
1664}
1665
1666#endif
1667
John Kessenicha0af4732012-12-12 21:15:54 +00001668//
1669// Malloc a string of sufficient size and read a string into it.
1670//
John Kessenich04acb1b2017-06-14 17:36:50 -06001671char* ReadFileData(const char* fileName)
John Kessenicha0af4732012-12-12 21:15:54 +00001672{
John Kessenichb3297152015-07-11 18:01:03 -06001673 FILE *in = nullptr;
John Kessenich3ce4e592014-10-06 19:57:34 +00001674 int errorCode = fopen_s(&in, fileName, "r");
John Kessenich68d78fd2015-07-12 19:28:10 -06001675 if (errorCode || in == nullptr)
1676 Error("unable to open input file");
John Kessenichecba76f2017-01-06 00:34:48 -07001677
John Kessenich04acb1b2017-06-14 17:36:50 -06001678 int count = 0;
John Kessenicha0af4732012-12-12 21:15:54 +00001679 while (fgetc(in) != EOF)
1680 count++;
1681
John Kessenichd6c72a42014-08-18 19:42:35 +00001682 fseek(in, 0, SEEK_SET);
John Kessenichca3457f2015-05-18 01:59:45 +00001683
John Kessenich04acb1b2017-06-14 17:36:50 -06001684 char* return_data = (char*)malloc(count + 1); // freed in FreeFileData()
1685 if ((int)fread(return_data, 1, count, in) != count) {
1686 free(return_data);
John Kessenich68d78fd2015-07-12 19:28:10 -06001687 Error("can't read input file");
John Kessenicha0af4732012-12-12 21:15:54 +00001688 }
John Kessenich68d78fd2015-07-12 19:28:10 -06001689
John Kessenich04acb1b2017-06-14 17:36:50 -06001690 return_data[count] = '\0';
John Kessenicha0af4732012-12-12 21:15:54 +00001691 fclose(in);
John Kessenichb3297152015-07-11 18:01:03 -06001692
John Kessenicha0af4732012-12-12 21:15:54 +00001693 return return_data;
1694}
1695
John Kessenich04acb1b2017-06-14 17:36:50 -06001696void FreeFileData(char* data)
John Kessenicha0af4732012-12-12 21:15:54 +00001697{
John Kessenichb3297152015-07-11 18:01:03 -06001698 free(data);
John Kessenicha0af4732012-12-12 21:15:54 +00001699}
1700
John Kessenich54d8cda2013-02-11 22:36:01 +00001701void InfoLogMsg(const char* msg, const char* name, const int num)
John Kessenicha0af4732012-12-12 21:15:54 +00001702{
John Kessenichfae38ee2015-06-10 23:23:12 +00001703 if (num >= 0 )
1704 printf("#### %s %s %d INFO LOG ####\n", msg, name, num);
1705 else
1706 printf("#### %s %s INFO LOG ####\n", msg, name);
John Kessenicha0af4732012-12-12 21:15:54 +00001707}