blob: 5dfe9da4a45c9604bd809f594b9bac85b3fc0471 [file] [log] [blame]
alokp@chromium.org07620a52010-09-23 17:53:56 +00001//
Jamie Madill88f6e942014-02-19 10:27:53 -05002// Copyright (c) 2002-2014 The ANGLE Project Authors. All rights reserved.
alokp@chromium.org07620a52010-09-23 17:53:56 +00003// Use of this source code is governed by a BSD-style license that can be
4// found in the LICENSE file.
5//
6
Corentin Wallez8b28a8b2016-09-15 19:47:56 -04007#include "compiler/translator/Compiler.h"
8
9#include <sstream>
10
11#include "angle_gl.h"
12#include "common/utilities.h"
Corentin Wallez71d147f2015-02-11 11:15:24 -080013#include "compiler/translator/CallDAG.h"
Olli Etuaho78ed6cd2017-08-09 16:19:00 +030014#include "compiler/translator/CollectVariables.h"
Geoff Lang17732822013-08-29 13:46:49 -040015#include "compiler/translator/Initialize.h"
Olli Etuahocccf2b02017-07-05 14:50:54 +030016#include "compiler/translator/IsASTDepthBelowLimit.h"
17#include "compiler/translator/OutputTree.h"
Jamie Madill6b9cb252013-10-17 10:45:47 -040018#include "compiler/translator/ParseContext.h"
Geoff Lang17732822013-08-29 13:46:49 -040019#include "compiler/translator/ValidateLimitations.h"
Olli Etuaho19d1dc92016-03-08 17:18:46 +020020#include "compiler/translator/ValidateMaxParameters.h"
Geoff Lang17732822013-08-29 13:46:49 -040021#include "compiler/translator/ValidateOutputs.h"
Jiawei Shao4cc89e22017-08-31 14:25:54 +080022#include "compiler/translator/ValidateVaryingLocations.h"
Geoff Lang17732822013-08-29 13:46:49 -040023#include "compiler/translator/VariablePacker.h"
Olli Etuahoa07b4212018-03-22 16:13:13 +020024#include "compiler/translator/tree_ops/AddAndTrueToLoopCondition.h"
25#include "compiler/translator/tree_ops/ClampFragDepth.h"
26#include "compiler/translator/tree_ops/ClampPointSize.h"
27#include "compiler/translator/tree_ops/DeclareAndInitBuiltinsForInstancedMultiview.h"
28#include "compiler/translator/tree_ops/DeferGlobalInitializers.h"
Austin Eng7cf9cd22018-10-09 15:27:32 -070029#include "compiler/translator/tree_ops/EmulateGLDrawID.h"
Olli Etuahoa07b4212018-03-22 16:13:13 +020030#include "compiler/translator/tree_ops/EmulateGLFragColorBroadcast.h"
31#include "compiler/translator/tree_ops/EmulatePrecision.h"
32#include "compiler/translator/tree_ops/FoldExpressions.h"
33#include "compiler/translator/tree_ops/InitializeVariables.h"
34#include "compiler/translator/tree_ops/PruneEmptyCases.h"
35#include "compiler/translator/tree_ops/PruneNoOps.h"
Shahbaz Youssefi216f73d2019-04-12 13:32:30 -040036#include "compiler/translator/tree_ops/RedefineInterfaceBlockLayoutQualifiersWithStd.h"
Olli Etuahoa07b4212018-03-22 16:13:13 +020037#include "compiler/translator/tree_ops/RegenerateStructNames.h"
38#include "compiler/translator/tree_ops/RemoveArrayLengthMethod.h"
39#include "compiler/translator/tree_ops/RemoveInvariantDeclaration.h"
40#include "compiler/translator/tree_ops/RemovePow.h"
41#include "compiler/translator/tree_ops/RemoveUnreferencedVariables.h"
42#include "compiler/translator/tree_ops/RewriteDoWhile.h"
Olli Etuaho983460e2018-05-02 17:57:39 +030043#include "compiler/translator/tree_ops/RewriteRepeatedAssignToSwizzled.h"
Olli Etuahoa07b4212018-03-22 16:13:13 +020044#include "compiler/translator/tree_ops/ScalarizeVecAndMatConstructorArgs.h"
45#include "compiler/translator/tree_ops/SeparateDeclarations.h"
46#include "compiler/translator/tree_ops/SimplifyLoopConditions.h"
47#include "compiler/translator/tree_ops/SplitSequenceOperator.h"
48#include "compiler/translator/tree_ops/UnfoldShortCircuitAST.h"
49#include "compiler/translator/tree_ops/UseInterfaceBlockFields.h"
50#include "compiler/translator/tree_ops/VectorizeVectorScalarArithmetic.h"
Olli Etuaho59c5b892018-04-03 11:44:50 +030051#include "compiler/translator/tree_util/BuiltIn_autogen.h"
Olli Etuahoc26214d2018-03-16 10:43:11 +020052#include "compiler/translator/tree_util/IntermNodePatternMatcher.h"
Olli Etuahob5601eb2017-11-15 18:08:04 +020053#include "compiler/translator/util.h"
shannon.woods@transgaming.comda1ed362013-01-25 21:54:57 +000054#include "third_party/compiler/ArrayBoundsClamper.h"
Corentin Wallez28b65282016-06-16 07:24:50 -070055
Jamie Madillacb4b812016-11-07 13:50:29 -050056namespace sh
57{
58
Corentin Wallez28b65282016-06-16 07:24:50 -070059namespace
60{
61
62#if defined(ANGLE_ENABLE_FUZZER_CORPUS_OUTPUT)
63void DumpFuzzerCase(char const *const *shaderStrings,
64 size_t numStrings,
65 uint32_t type,
66 uint32_t spec,
67 uint32_t output,
68 uint64_t options)
69{
70 static int fileIndex = 0;
71
Jonah Ryan-Davisf563fdc2019-01-31 13:53:59 -050072 std::ostringstream o = sh::InitializeStream<std::ostringstream>();
Corentin Wallez28b65282016-06-16 07:24:50 -070073 o << "corpus/" << fileIndex++ << ".sample";
74 std::string s = o.str();
75
76 // Must match the input format of the fuzzer
77 FILE *f = fopen(s.c_str(), "w");
78 fwrite(&type, sizeof(type), 1, f);
79 fwrite(&spec, sizeof(spec), 1, f);
80 fwrite(&output, sizeof(output), 1, f);
81 fwrite(&options, sizeof(options), 1, f);
82
83 char zero[128 - 20] = {0};
84 fwrite(&zero, 128 - 20, 1, f);
85
86 for (size_t i = 0; i < numStrings; i++)
87 {
88 fwrite(shaderStrings[i], sizeof(char), strlen(shaderStrings[i]), f);
89 }
90 fwrite(&zero, 1, 1, f);
91
92 fclose(f);
93}
94#endif // defined(ANGLE_ENABLE_FUZZER_CORPUS_OUTPUT)
95} // anonymous namespace
96
Qingqing Dengad0d0792015-04-08 14:25:06 -070097bool IsGLSL130OrNewer(ShShaderOutput output)
98{
Jamie Madillacb4b812016-11-07 13:50:29 -050099 return (output == SH_GLSL_130_OUTPUT || output == SH_GLSL_140_OUTPUT ||
100 output == SH_GLSL_150_CORE_OUTPUT || output == SH_GLSL_330_CORE_OUTPUT ||
101 output == SH_GLSL_400_CORE_OUTPUT || output == SH_GLSL_410_CORE_OUTPUT ||
102 output == SH_GLSL_420_CORE_OUTPUT || output == SH_GLSL_430_CORE_OUTPUT ||
103 output == SH_GLSL_440_CORE_OUTPUT || output == SH_GLSL_450_CORE_OUTPUT);
Qingqing Dengad0d0792015-04-08 14:25:06 -0700104}
105
Qiankun Miao705a9192016-08-29 10:05:27 +0800106bool IsGLSL420OrNewer(ShShaderOutput output)
107{
Jamie Madillacb4b812016-11-07 13:50:29 -0500108 return (output == SH_GLSL_420_CORE_OUTPUT || output == SH_GLSL_430_CORE_OUTPUT ||
109 output == SH_GLSL_440_CORE_OUTPUT || output == SH_GLSL_450_CORE_OUTPUT);
Qiankun Miao705a9192016-08-29 10:05:27 +0800110}
111
Zhenyao Mob7bf7422016-11-08 14:44:05 -0800112bool IsGLSL410OrOlder(ShShaderOutput output)
113{
114 return (output == SH_GLSL_130_OUTPUT || output == SH_GLSL_140_OUTPUT ||
115 output == SH_GLSL_150_CORE_OUTPUT || output == SH_GLSL_330_CORE_OUTPUT ||
116 output == SH_GLSL_400_CORE_OUTPUT || output == SH_GLSL_410_CORE_OUTPUT);
117}
118
Qiankun Miao89dd8f32016-11-09 12:59:30 +0000119bool RemoveInvariant(sh::GLenum shaderType,
120 int shaderVersion,
121 ShShaderOutput outputType,
122 ShCompileOptions compileOptions)
123{
Tobin Ehlise9421b22019-04-08 15:16:56 -0600124 if (shaderType == GL_FRAGMENT_SHADER && IsGLSL420OrNewer(outputType))
Qiankun Miao89dd8f32016-11-09 12:59:30 +0000125 return true;
126
127 if ((compileOptions & SH_REMOVE_INVARIANT_AND_CENTROID_FOR_ESSL3) != 0 &&
Qiankun Miao41f9f672016-11-16 17:04:36 +0800128 shaderVersion >= 300 && shaderType == GL_VERTEX_SHADER)
Qiankun Miao89dd8f32016-11-09 12:59:30 +0000129 return true;
130
131 return false;
132}
133
Zhenyao Mo7faf1a12014-04-25 18:03:56 -0700134size_t GetGlobalMaxTokenSize(ShShaderSpec spec)
Jamie Madill88f6e942014-02-19 10:27:53 -0500135{
He Yunchao29ab9ff2015-08-06 16:58:30 +0800136 // WebGL defines a max token length of 256, while ES2 leaves max token
Jamie Madill88f6e942014-02-19 10:27:53 -0500137 // size undefined. ES3 defines a max size of 1024 characters.
Zhenyao Modb9b40b2014-10-29 15:00:04 -0700138 switch (spec)
Jamie Madill88f6e942014-02-19 10:27:53 -0500139 {
Jamie Madillacb4b812016-11-07 13:50:29 -0500140 case SH_WEBGL_SPEC:
141 return 256;
142 default:
143 return 1024;
Jamie Madill88f6e942014-02-19 10:27:53 -0500144 }
145}
146
Shao77891c02017-06-23 16:30:17 +0800147int GetMaxUniformVectorsForShaderType(GLenum shaderType, const ShBuiltInResources &resources)
148{
149 switch (shaderType)
150 {
151 case GL_VERTEX_SHADER:
152 return resources.MaxVertexUniformVectors;
153 case GL_FRAGMENT_SHADER:
154 return resources.MaxFragmentUniformVectors;
Shaob5cc1192017-07-06 10:47:20 +0800155
156 // TODO (jiawei.shao@intel.com): check if we need finer-grained component counting
Shao77891c02017-06-23 16:30:17 +0800157 case GL_COMPUTE_SHADER:
Shao77891c02017-06-23 16:30:17 +0800158 return resources.MaxComputeUniformComponents / 4;
Jiawei Shaobd924af2017-11-16 15:28:04 +0800159 case GL_GEOMETRY_SHADER_EXT:
Shaob5cc1192017-07-06 10:47:20 +0800160 return resources.MaxGeometryUniformComponents / 4;
Shao77891c02017-06-23 16:30:17 +0800161 default:
Shaob5cc1192017-07-06 10:47:20 +0800162 UNREACHABLE();
Shao77891c02017-06-23 16:30:17 +0800163 return -1;
164 }
165}
166
Jamie Madilld7b1ab52016-12-12 14:42:19 -0500167namespace
168{
Zhenyao Modb9b40b2014-10-29 15:00:04 -0700169
Zhenyao Mo4a667fe2014-02-11 12:35:01 -0800170class TScopedPoolAllocator
171{
172 public:
Tobin Ehlis5546fb42019-01-17 12:25:54 -0500173 TScopedPoolAllocator(angle::PoolAllocator *allocator) : mAllocator(allocator)
Zhenyao Mo4a667fe2014-02-11 12:35:01 -0800174 {
Alok Priyadarshibc3f1ac2013-09-23 14:57:02 -0400175 mAllocator->push();
alokp@chromium.orgbafcbaa2010-11-23 19:07:43 +0000176 SetGlobalPoolAllocator(mAllocator);
177 }
Zhenyao Mo4a667fe2014-02-11 12:35:01 -0800178 ~TScopedPoolAllocator()
179 {
Yunchao Hef81ce4a2017-04-24 10:49:17 +0800180 SetGlobalPoolAllocator(nullptr);
Alok Priyadarshibc3f1ac2013-09-23 14:57:02 -0400181 mAllocator->pop();
alokp@chromium.orgbafcbaa2010-11-23 19:07:43 +0000182 }
183
Zhenyao Mo4a667fe2014-02-11 12:35:01 -0800184 private:
Tobin Ehlis5546fb42019-01-17 12:25:54 -0500185 angle::PoolAllocator *mAllocator;
Alok Priyadarshibc3f1ac2013-09-23 14:57:02 -0400186};
187
Zhenyao Mo4a667fe2014-02-11 12:35:01 -0800188class TScopedSymbolTableLevel
189{
190 public:
Jamie Madilld7b1ab52016-12-12 14:42:19 -0500191 TScopedSymbolTableLevel(TSymbolTable *table) : mTable(table)
Zhenyao Mo4a667fe2014-02-11 12:35:01 -0800192 {
Olli Etuaho437664b2018-02-28 15:38:14 +0200193 ASSERT(mTable->isEmpty());
Alok Priyadarshibc3f1ac2013-09-23 14:57:02 -0400194 mTable->push();
195 }
Zhenyao Mo4a667fe2014-02-11 12:35:01 -0800196 ~TScopedSymbolTableLevel()
197 {
Olli Etuaho437664b2018-02-28 15:38:14 +0200198 while (!mTable->isEmpty())
Alok Priyadarshibc3f1ac2013-09-23 14:57:02 -0400199 mTable->pop();
200 }
201
Zhenyao Mo4a667fe2014-02-11 12:35:01 -0800202 private:
Jamie Madilld7b1ab52016-12-12 14:42:19 -0500203 TSymbolTable *mTable;
alokp@chromium.orgbafcbaa2010-11-23 19:07:43 +0000204};
Zhenyao Modb9b40b2014-10-29 15:00:04 -0700205
206int MapSpecToShaderVersion(ShShaderSpec spec)
207{
208 switch (spec)
209 {
Jamie Madillacb4b812016-11-07 13:50:29 -0500210 case SH_GLES2_SPEC:
211 case SH_WEBGL_SPEC:
212 return 100;
213 case SH_GLES3_SPEC:
214 case SH_WEBGL2_SPEC:
215 return 300;
216 case SH_GLES3_1_SPEC:
217 case SH_WEBGL3_SPEC:
218 return 310;
219 default:
220 UNREACHABLE();
221 return 0;
Zhenyao Modb9b40b2014-10-29 15:00:04 -0700222 }
223}
224
Olli Etuaho59c5b892018-04-03 11:44:50 +0300225bool ValidateFragColorAndFragData(GLenum shaderType,
226 int shaderVersion,
227 const TSymbolTable &symbolTable,
228 TDiagnostics *diagnostics)
229{
230 if (shaderVersion > 100 || shaderType != GL_FRAGMENT_SHADER)
231 {
232 return true;
233 }
234
235 bool usesFragColor = false;
236 bool usesFragData = false;
237 // This validation is a bit stricter than the spec - it's only an error to write to
238 // both FragData and FragColor. But because it's better not to have reads from undefined
239 // variables, we always return an error if they are both referenced, rather than only if they
240 // are written.
241 if (symbolTable.isStaticallyUsed(*BuiltInVariable::gl_FragColor()) ||
242 symbolTable.isStaticallyUsed(*BuiltInVariable::gl_SecondaryFragColorEXT()))
243 {
244 usesFragColor = true;
245 }
246 // Extension variables may not always be initialized (saves some time at symbol table init).
247 bool secondaryFragDataUsed =
248 symbolTable.gl_SecondaryFragDataEXT() != nullptr &&
249 symbolTable.isStaticallyUsed(*symbolTable.gl_SecondaryFragDataEXT());
250 if (symbolTable.isStaticallyUsed(*symbolTable.gl_FragData()) || secondaryFragDataUsed)
251 {
252 usesFragData = true;
253 }
254 if (usesFragColor && usesFragData)
255 {
256 const char *errorMessage = "cannot use both gl_FragData and gl_FragColor";
257 if (symbolTable.isStaticallyUsed(*BuiltInVariable::gl_SecondaryFragColorEXT()) ||
258 secondaryFragDataUsed)
259 {
260 errorMessage =
261 "cannot use both output variable sets (gl_FragData, gl_SecondaryFragDataEXT)"
262 " and (gl_FragColor, gl_SecondaryFragColorEXT)";
263 }
264 diagnostics->globalError(errorMessage);
265 return false;
266 }
267 return true;
268}
269
alokp@chromium.orgbafcbaa2010-11-23 19:07:43 +0000270} // namespace
271
Zhenyao Mo4a667fe2014-02-11 12:35:01 -0800272TShHandleBase::TShHandleBase()
273{
alokp@chromium.orgbafcbaa2010-11-23 19:07:43 +0000274 allocator.push();
275 SetGlobalPoolAllocator(&allocator);
276}
277
Zhenyao Mo4a667fe2014-02-11 12:35:01 -0800278TShHandleBase::~TShHandleBase()
279{
Yunchao Hef81ce4a2017-04-24 10:49:17 +0800280 SetGlobalPoolAllocator(nullptr);
alokp@chromium.orgbafcbaa2010-11-23 19:07:43 +0000281 allocator.popAll();
282}
283
Jamie Madill183bde52014-07-02 15:31:19 -0400284TCompiler::TCompiler(sh::GLenum type, ShShaderSpec spec, ShShaderOutput output)
Olli Etuaho6f591c92018-09-21 11:20:47 +0300285 : mVariablesCollected(false),
Olli Etuahob12040c2017-06-27 14:20:45 +0300286 mGLPositionInitialized(false),
Olli Etuaho6f591c92018-09-21 11:20:47 +0300287 mShaderType(type),
288 mShaderSpec(spec),
289 mOutputType(output),
290 mBuiltInFunctionEmulator(),
291 mDiagnostics(mInfoSink.info),
Yunchao Hef81ce4a2017-04-24 10:49:17 +0800292 mSourcePath(nullptr),
Shaob5cc1192017-07-06 10:47:20 +0800293 mComputeShaderLocalSizeDeclared(false),
Jamie Madill2f294c92017-11-20 14:47:26 -0500294 mComputeShaderLocalSize(1),
Shaob5cc1192017-07-06 10:47:20 +0800295 mGeometryShaderMaxVertices(-1),
296 mGeometryShaderInvocations(0),
297 mGeometryShaderInputPrimitiveType(EptUndefined),
298 mGeometryShaderOutputPrimitiveType(EptUndefined)
Jamie Madillb980c562018-11-27 11:34:27 -0500299{}
alokp@chromium.org4888ceb2010-10-01 21:13:12 +0000300
Jamie Madillb980c562018-11-27 11:34:27 -0500301TCompiler::~TCompiler() {}
alokp@chromium.org4888ceb2010-10-01 21:13:12 +0000302
Qiankun Miao7ebb97f2016-09-08 18:01:50 +0800303bool TCompiler::shouldRunLoopAndIndexingValidation(ShCompileOptions compileOptions) const
Olli Etuaho5d91dda2015-06-18 15:47:46 +0300304{
305 // If compiling an ESSL 1.00 shader for WebGL, or if its been requested through the API,
306 // validate loop and indexing as well (to verify that the shader only uses minimal functionality
307 // of ESSL 1.00 as in Appendix A of the spec).
Olli Etuaho6f591c92018-09-21 11:20:47 +0300308 return (IsWebGLBasedSpec(mShaderSpec) && mShaderVersion == 100) ||
Olli Etuaho5d91dda2015-06-18 15:47:46 +0300309 (compileOptions & SH_VALIDATE_LOOP_INDEXING);
310}
311
Jamie Madilld7b1ab52016-12-12 14:42:19 -0500312bool TCompiler::Init(const ShBuiltInResources &resources)
alokp@chromium.org07620a52010-09-23 17:53:56 +0000313{
Alok Priyadarshibc3f1ac2013-09-23 14:57:02 -0400314 SetGlobalPoolAllocator(&allocator);
alokp@chromium.orgbafcbaa2010-11-23 19:07:43 +0000315
alokp@chromium.org07620a52010-09-23 17:53:56 +0000316 // Generate built-in symbol table.
Olli Etuaho6f591c92018-09-21 11:20:47 +0300317 if (!initBuiltInSymbolTable(resources))
alokp@chromium.org07620a52010-09-23 17:53:56 +0000318 return false;
alokp@chromium.orgbafcbaa2010-11-23 19:07:43 +0000319
Olli Etuaho6f591c92018-09-21 11:20:47 +0300320 mResources = resources;
321 setResourceString();
shannon.woods@transgaming.com1d432bb2013-01-25 21:57:28 +0000322
Olli Etuaho6f591c92018-09-21 11:20:47 +0300323 InitExtensionBehavior(resources, mExtensionBehavior);
324 mArrayBoundsClamper.SetClampingStrategy(resources.ArrayIndexClampingStrategy);
alokp@chromium.org07620a52010-09-23 17:53:56 +0000325 return true;
326}
327
Olli Etuaho6d40bbd2016-09-30 13:49:38 +0100328TIntermBlock *TCompiler::compileTreeForTesting(const char *const shaderStrings[],
329 size_t numStrings,
330 ShCompileOptions compileOptions)
alokp@chromium.org07620a52010-09-23 17:53:56 +0000331{
Olli Etuahoa3a5cc62015-02-13 13:12:22 +0200332 return compileTreeImpl(shaderStrings, numStrings, compileOptions);
333}
334
Olli Etuaho6d40bbd2016-09-30 13:49:38 +0100335TIntermBlock *TCompiler::compileTreeImpl(const char *const shaderStrings[],
336 size_t numStrings,
337 const ShCompileOptions compileOptions)
Olli Etuahoa3a5cc62015-02-13 13:12:22 +0200338{
alokp@chromium.org07620a52010-09-23 17:53:56 +0000339 clearResults();
340
Olli Etuahoa3a5cc62015-02-13 13:12:22 +0200341 ASSERT(numStrings > 0);
342 ASSERT(GetGlobalPoolAllocator());
alokp@chromium.org07620a52010-09-23 17:53:56 +0000343
David Yen0fbd1282015-02-02 14:46:09 -0800344 // Reset the extension behavior for each compilation unit.
Olli Etuaho6f591c92018-09-21 11:20:47 +0300345 ResetExtensionBehavior(mExtensionBehavior);
David Yen0fbd1282015-02-02 14:46:09 -0800346
Austin Eng7cf9cd22018-10-09 15:27:32 -0700347 // If gl_DrawID is not supported, remove it from the available extensions
348 // Currently we only allow emulation of gl_DrawID
349 const bool glDrawIDSupported = (compileOptions & SH_EMULATE_GL_DRAW_ID) != 0u;
350 if (!glDrawIDSupported)
351 {
352 auto it = mExtensionBehavior.find(TExtension::ANGLE_multi_draw);
353 if (it != mExtensionBehavior.end())
354 {
355 mExtensionBehavior.erase(it);
356 }
357 }
358
apatrick@chromium.org0f4cefe2011-01-26 19:30:57 +0000359 // First string is path of source file if flag is set. The actual source follows.
shannon.woods@transgaming.comd64b3da2013-02-28 23:19:26 +0000360 size_t firstSource = 0;
apatrick@chromium.org0f4cefe2011-01-26 19:30:57 +0000361 if (compileOptions & SH_SOURCE_PATH)
362 {
Olli Etuahoa3a5cc62015-02-13 13:12:22 +0200363 mSourcePath = shaderStrings[0];
apatrick@chromium.org0f4cefe2011-01-26 19:30:57 +0000364 ++firstSource;
365 }
366
Tobin Ehlise9421b22019-04-08 15:16:56 -0600367 TParseContext parseContext(mSymbolTable, mExtensionBehavior, mShaderType, mShaderSpec, true,
368 &mDiagnostics, getResources());
Olli Etuaho853dc1a2014-11-06 17:25:48 +0200369
Olli Etuaho6f591c92018-09-21 11:20:47 +0300370 parseContext.setFragmentPrecisionHighOnESSL1(mResources.FragmentPrecisionHigh == 1);
alokp@chromium.org07620a52010-09-23 17:53:56 +0000371
372 // We preserve symbols at the built-in level from compile-to-compile.
373 // Start pushing the user-defined symbols at global level.
Olli Etuaho6f591c92018-09-21 11:20:47 +0300374 TScopedSymbolTableLevel globalLevel(&mSymbolTable);
375 ASSERT(mSymbolTable.atGlobalLevel());
alokp@chromium.org07620a52010-09-23 17:53:56 +0000376
377 // Parse shader.
Olli Etuahod10cf692017-11-02 11:06:14 +0200378 if (PaParseStrings(numStrings - firstSource, &shaderStrings[firstSource], nullptr,
379 &parseContext) != 0)
380 {
381 return nullptr;
382 }
shannon.woods%transgaming.com@gtempaccount.com0bbed382013-04-13 03:38:07 +0000383
Olli Etuahod10cf692017-11-02 11:06:14 +0200384 if (parseContext.getTreeRoot() == nullptr)
385 {
386 return nullptr;
387 }
388
389 setASTMetadata(parseContext);
390
Jiawei Shaoe41df652018-02-09 14:31:39 +0800391 if (!checkShaderVersion(&parseContext))
Zhenyao Modb9b40b2014-10-29 15:00:04 -0700392 {
Olli Etuahod10cf692017-11-02 11:06:14 +0200393 return nullptr;
Zhenyao Modb9b40b2014-10-29 15:00:04 -0700394 }
shannon.woods%transgaming.com@gtempaccount.com0bbed382013-04-13 03:38:07 +0000395
Olli Etuahod10cf692017-11-02 11:06:14 +0200396 TIntermBlock *root = parseContext.getTreeRoot();
397 if (!checkAndSimplifyAST(root, parseContext, compileOptions))
Zhenyao Mo4a667fe2014-02-11 12:35:01 -0800398 {
Olli Etuahod10cf692017-11-02 11:06:14 +0200399 return nullptr;
400 }
Zhenyao Mo94ac7b72014-10-15 18:22:08 -0700401
Olli Etuahod10cf692017-11-02 11:06:14 +0200402 return root;
403}
Martin Radev802abe02016-08-04 17:48:32 +0300404
Jiawei Shaoe41df652018-02-09 14:31:39 +0800405bool TCompiler::checkShaderVersion(TParseContext *parseContext)
406{
Olli Etuaho6f591c92018-09-21 11:20:47 +0300407 if (MapSpecToShaderVersion(mShaderSpec) < mShaderVersion)
Jiawei Shaoe41df652018-02-09 14:31:39 +0800408 {
409 mDiagnostics.globalError("unsupported shader version");
410 return false;
411 }
412
413 ASSERT(parseContext);
Olli Etuaho6f591c92018-09-21 11:20:47 +0300414 switch (mShaderType)
Jiawei Shaoe41df652018-02-09 14:31:39 +0800415 {
416 case GL_COMPUTE_SHADER:
Olli Etuaho6f591c92018-09-21 11:20:47 +0300417 if (mShaderVersion < 310)
Jiawei Shaoe41df652018-02-09 14:31:39 +0800418 {
419 mDiagnostics.globalError("Compute shader is not supported in this shader version.");
420 return false;
421 }
422 break;
423
424 case GL_GEOMETRY_SHADER_EXT:
Olli Etuaho6f591c92018-09-21 11:20:47 +0300425 if (mShaderVersion < 310)
Jiawei Shaoe41df652018-02-09 14:31:39 +0800426 {
427 mDiagnostics.globalError(
428 "Geometry shader is not supported in this shader version.");
429 return false;
430 }
431 else
432 {
Olli Etuaho6f591c92018-09-21 11:20:47 +0300433 ASSERT(mShaderVersion == 310);
Jiawei Shaoe41df652018-02-09 14:31:39 +0800434 if (!parseContext->checkCanUseExtension(sh::TSourceLoc(),
435 TExtension::EXT_geometry_shader))
436 {
437 return false;
438 }
439 }
440 break;
441
442 default:
443 break;
444 }
445
446 return true;
447}
448
Olli Etuahod10cf692017-11-02 11:06:14 +0200449void TCompiler::setASTMetadata(const TParseContext &parseContext)
450{
Olli Etuaho6f591c92018-09-21 11:20:47 +0300451 mShaderVersion = parseContext.getShaderVersion();
Olli Etuaho09b04a22016-12-15 13:30:26 +0000452
Olli Etuahod10cf692017-11-02 11:06:14 +0200453 mPragma = parseContext.pragma();
Olli Etuaho6f591c92018-09-21 11:20:47 +0300454 mSymbolTable.setGlobalInvariant(mPragma.stdgl.invariantAll);
alokp@chromium.orgb59a7782010-11-24 18:38:33 +0000455
Olli Etuahod10cf692017-11-02 11:06:14 +0200456 mComputeShaderLocalSizeDeclared = parseContext.isComputeShaderLocalSizeDeclared();
457 mComputeShaderLocalSize = parseContext.getComputeShaderLocalSize();
Olli Etuahoa6996682015-10-12 14:32:30 +0300458
Olli Etuahod10cf692017-11-02 11:06:14 +0200459 mNumViews = parseContext.getNumViews();
460
Olli Etuaho6f591c92018-09-21 11:20:47 +0300461 if (mShaderType == GL_GEOMETRY_SHADER_EXT)
Olli Etuahod10cf692017-11-02 11:06:14 +0200462 {
463 mGeometryShaderInputPrimitiveType = parseContext.getGeometryShaderInputPrimitiveType();
464 mGeometryShaderOutputPrimitiveType = parseContext.getGeometryShaderOutputPrimitiveType();
465 mGeometryShaderMaxVertices = parseContext.getGeometryShaderMaxVertices();
466 mGeometryShaderInvocations = parseContext.getGeometryShaderInvocations();
467 }
468}
469
470bool TCompiler::checkAndSimplifyAST(TIntermBlock *root,
471 const TParseContext &parseContext,
472 ShCompileOptions compileOptions)
473{
474 // Disallow expressions deemed too complex.
475 if ((compileOptions & SH_LIMIT_EXPRESSION_COMPLEXITY) && !limitExpressionComplexity(root))
476 {
477 return false;
478 }
479
Olli Etuaho765924f2018-01-04 12:48:36 +0200480 if (shouldRunLoopAndIndexingValidation(compileOptions) &&
Olli Etuaho6f591c92018-09-21 11:20:47 +0300481 !ValidateLimitations(root, mShaderType, &mSymbolTable, &mDiagnostics))
Olli Etuaho765924f2018-01-04 12:48:36 +0200482 {
483 return false;
484 }
485
Olli Etuaho6f591c92018-09-21 11:20:47 +0300486 if (!ValidateFragColorAndFragData(mShaderType, mShaderVersion, mSymbolTable, &mDiagnostics))
Olli Etuaho59c5b892018-04-03 11:44:50 +0300487 {
488 return false;
489 }
490
Olli Etuaho765924f2018-01-04 12:48:36 +0200491 // Fold expressions that could not be folded before validation that was done as a part of
492 // parsing.
493 FoldExpressions(root, &mDiagnostics);
494 // Folding should only be able to generate warnings.
495 ASSERT(mDiagnostics.numErrors() == 0);
Shahbaz Youssefi91d469a2018-08-27 10:47:25 -0400496 if (!ValidateAST(root, &mDiagnostics, mValidateASTOptions))
497 {
498 return false;
499 }
Olli Etuaho765924f2018-01-04 12:48:36 +0200500
Olli Etuahod10cf692017-11-02 11:06:14 +0200501 // We prune no-ops to work around driver bugs and to keep AST processing and output simple.
502 // The following kinds of no-ops are pruned:
503 // 1. Empty declarations "int;".
504 // 2. Literal statements: "1.0;". The ESSL output doesn't define a default precision
505 // for float, so float literal statements would end up with no precision which is
506 // invalid ESSL.
507 // After this empty declarations are not allowed in the AST.
Olli Etuaho6f591c92018-09-21 11:20:47 +0300508 PruneNoOps(root, &mSymbolTable);
Shahbaz Youssefi91d469a2018-08-27 10:47:25 -0400509 if (!ValidateAST(root, &mDiagnostics, mValidateASTOptions))
510 {
511 return false;
512 }
Olli Etuahod10cf692017-11-02 11:06:14 +0200513
Olli Etuahod10cf692017-11-02 11:06:14 +0200514 // Create the function DAG and check there is no recursion
515 if (!initCallDag(root))
516 {
517 return false;
518 }
519
520 if ((compileOptions & SH_LIMIT_CALL_STACK_DEPTH) && !checkCallDepth())
521 {
522 return false;
523 }
524
525 // Checks which functions are used and if "main" exists
Olli Etuaho6f591c92018-09-21 11:20:47 +0300526 mFunctionMetadata.clear();
527 mFunctionMetadata.resize(mCallDag.size());
Olli Etuahod10cf692017-11-02 11:06:14 +0200528 if (!tagUsedFunctions())
529 {
530 return false;
531 }
532
533 if (!(compileOptions & SH_DONT_PRUNE_UNUSED_FUNCTIONS))
534 {
535 pruneUnusedFunctions(root);
Shahbaz Youssefi91d469a2018-08-27 10:47:25 -0400536 if (!ValidateAST(root, &mDiagnostics, mValidateASTOptions))
537 {
538 return false;
539 }
Olli Etuahod10cf692017-11-02 11:06:14 +0200540 }
541
Olli Etuaho6f591c92018-09-21 11:20:47 +0300542 if (mShaderVersion >= 310 && !ValidateVaryingLocations(root, &mDiagnostics, mShaderType))
Olli Etuahod10cf692017-11-02 11:06:14 +0200543 {
544 return false;
545 }
546
Olli Etuaho6f591c92018-09-21 11:20:47 +0300547 if (mShaderVersion >= 300 && mShaderType == GL_FRAGMENT_SHADER &&
548 !ValidateOutputs(root, getExtensionBehavior(), mResources.MaxDrawBuffers, &mDiagnostics))
Olli Etuahod10cf692017-11-02 11:06:14 +0200549 {
550 return false;
551 }
552
Olli Etuahod10cf692017-11-02 11:06:14 +0200553 // Fail compilation if precision emulation not supported.
554 if (getResources().WEBGL_debug_shader_precision && getPragma().debugShaderPrecision &&
Olli Etuaho6f591c92018-09-21 11:20:47 +0300555 !EmulatePrecision::SupportedInLanguage(mOutputType))
Olli Etuahod10cf692017-11-02 11:06:14 +0200556 {
557 mDiagnostics.globalError("Precision emulation not supported for this output type.");
558 return false;
559 }
560
Olli Etuahod10cf692017-11-02 11:06:14 +0200561 // Clamping uniform array bounds needs to happen after validateLimitations pass.
562 if (compileOptions & SH_CLAMP_INDIRECT_ARRAY_BOUNDS)
563 {
Olli Etuaho6f591c92018-09-21 11:20:47 +0300564 mArrayBoundsClamper.MarkIndirectArrayBoundsForClamping(root);
Olli Etuahod10cf692017-11-02 11:06:14 +0200565 }
566
567 if ((compileOptions & SH_INITIALIZE_BUILTINS_FOR_INSTANCED_MULTIVIEW) &&
Mingyu Huebab6702019-04-19 14:36:45 -0700568 (parseContext.isExtensionEnabled(TExtension::OVR_multiview2) ||
569 parseContext.isExtensionEnabled(TExtension::OVR_multiview)) &&
Olli Etuahod10cf692017-11-02 11:06:14 +0200570 getShaderType() != GL_COMPUTE_SHADER)
571 {
Olli Etuaho6f591c92018-09-21 11:20:47 +0300572 DeclareAndInitBuiltinsForInstancedMultiview(root, mNumViews, mShaderType, compileOptions,
573 mOutputType, &mSymbolTable);
Shahbaz Youssefi91d469a2018-08-27 10:47:25 -0400574 if (!ValidateAST(root, &mDiagnostics, mValidateASTOptions))
575 {
576 return false;
577 }
Olli Etuahod10cf692017-11-02 11:06:14 +0200578 }
579
580 // This pass might emit short circuits so keep it before the short circuit unfolding
581 if (compileOptions & SH_REWRITE_DO_WHILE_LOOPS)
Shahbaz Youssefi91d469a2018-08-27 10:47:25 -0400582 {
Olli Etuaho6f591c92018-09-21 11:20:47 +0300583 RewriteDoWhile(root, &mSymbolTable);
Shahbaz Youssefi91d469a2018-08-27 10:47:25 -0400584 if (!ValidateAST(root, &mDiagnostics, mValidateASTOptions))
585 {
586 return false;
587 }
588 }
Olli Etuahod10cf692017-11-02 11:06:14 +0200589
590 if (compileOptions & SH_ADD_AND_TRUE_TO_LOOP_CONDITION)
Shahbaz Youssefi91d469a2018-08-27 10:47:25 -0400591 {
Olli Etuaho1776fd02018-01-31 11:46:52 +0200592 AddAndTrueToLoopCondition(root);
Shahbaz Youssefi91d469a2018-08-27 10:47:25 -0400593 if (!ValidateAST(root, &mDiagnostics, mValidateASTOptions))
594 {
595 return false;
596 }
597 }
Olli Etuahod10cf692017-11-02 11:06:14 +0200598
599 if (compileOptions & SH_UNFOLD_SHORT_CIRCUIT)
600 {
Olli Etuaho1776fd02018-01-31 11:46:52 +0200601 UnfoldShortCircuitAST(root);
Shahbaz Youssefi91d469a2018-08-27 10:47:25 -0400602 if (!ValidateAST(root, &mDiagnostics, mValidateASTOptions))
603 {
604 return false;
605 }
Olli Etuahod10cf692017-11-02 11:06:14 +0200606 }
607
608 if (compileOptions & SH_REMOVE_POW_WITH_CONSTANT_EXPONENT)
609 {
Olli Etuaho6f591c92018-09-21 11:20:47 +0300610 RemovePow(root, &mSymbolTable);
Shahbaz Youssefi91d469a2018-08-27 10:47:25 -0400611 if (!ValidateAST(root, &mDiagnostics, mValidateASTOptions))
612 {
613 return false;
614 }
Olli Etuahod10cf692017-11-02 11:06:14 +0200615 }
616
Olli Etuahod10cf692017-11-02 11:06:14 +0200617 if (compileOptions & SH_REGENERATE_STRUCT_NAMES)
618 {
Olli Etuaho6f591c92018-09-21 11:20:47 +0300619 RegenerateStructNames gen(&mSymbolTable);
Olli Etuahod10cf692017-11-02 11:06:14 +0200620 root->traverse(&gen);
Shahbaz Youssefi91d469a2018-08-27 10:47:25 -0400621 if (!ValidateAST(root, &mDiagnostics, mValidateASTOptions))
622 {
623 return false;
624 }
Olli Etuahod10cf692017-11-02 11:06:14 +0200625 }
626
Austin Eng7cf9cd22018-10-09 15:27:32 -0700627 if (mShaderType == GL_VERTEX_SHADER &&
628 IsExtensionEnabled(mExtensionBehavior, TExtension::ANGLE_multi_draw))
629 {
630 if ((compileOptions & SH_EMULATE_GL_DRAW_ID) != 0)
631 {
632 EmulateGLDrawID(root, &mSymbolTable, &mUniforms,
633 shouldCollectVariables(compileOptions));
Shahbaz Youssefi91d469a2018-08-27 10:47:25 -0400634 if (!ValidateAST(root, &mDiagnostics, mValidateASTOptions))
635 {
636 return false;
637 }
Austin Eng7cf9cd22018-10-09 15:27:32 -0700638 }
639 }
640
Olli Etuaho6f591c92018-09-21 11:20:47 +0300641 if (mShaderType == GL_FRAGMENT_SHADER && mShaderVersion == 100 && mResources.EXT_draw_buffers &&
642 mResources.MaxDrawBuffers > 1 &&
643 IsExtensionEnabled(mExtensionBehavior, TExtension::EXT_draw_buffers))
Olli Etuahod10cf692017-11-02 11:06:14 +0200644 {
Olli Etuaho6f591c92018-09-21 11:20:47 +0300645 EmulateGLFragColorBroadcast(root, mResources.MaxDrawBuffers, &mOutputVariables,
646 &mSymbolTable, mShaderVersion);
Shahbaz Youssefi91d469a2018-08-27 10:47:25 -0400647 if (!ValidateAST(root, &mDiagnostics, mValidateASTOptions))
648 {
649 return false;
650 }
Olli Etuahod10cf692017-11-02 11:06:14 +0200651 }
652
Olli Etuahoae04e1e2017-11-27 16:00:39 +0200653 int simplifyScalarized = (compileOptions & SH_SCALARIZE_VEC_AND_MAT_CONSTRUCTOR_ARGS)
654 ? IntermNodePatternMatcher::kScalarizedVecOrMatConstructor
655 : 0;
656
Olli Etuahod10cf692017-11-02 11:06:14 +0200657 // Split multi declarations and remove calls to array length().
658 // Note that SimplifyLoopConditions needs to be run before any other AST transformations
659 // that may need to generate new statements from loop conditions or loop expressions.
Olli Etuahoae04e1e2017-11-27 16:00:39 +0200660 SimplifyLoopConditions(root,
661 IntermNodePatternMatcher::kMultiDeclaration |
662 IntermNodePatternMatcher::kArrayLengthMethod | simplifyScalarized,
Olli Etuaho68981eb2018-01-23 17:46:12 +0200663 &getSymbolTable());
Shahbaz Youssefi91d469a2018-08-27 10:47:25 -0400664 if (!ValidateAST(root, &mDiagnostics, mValidateASTOptions))
665 {
666 return false;
667 }
Olli Etuahod10cf692017-11-02 11:06:14 +0200668
669 // Note that separate declarations need to be run before other AST transformations that
670 // generate new statements from expressions.
671 SeparateDeclarations(root);
Shahbaz Youssefi91d469a2018-08-27 10:47:25 -0400672 mValidateASTOptions.validateMultiDeclarations = true;
673 if (!ValidateAST(root, &mDiagnostics, mValidateASTOptions))
674 {
675 return false;
676 }
Olli Etuahod10cf692017-11-02 11:06:14 +0200677
Olli Etuahoae04e1e2017-11-27 16:00:39 +0200678 SplitSequenceOperator(root, IntermNodePatternMatcher::kArrayLengthMethod | simplifyScalarized,
Olli Etuaho68981eb2018-01-23 17:46:12 +0200679 &getSymbolTable());
Shahbaz Youssefi91d469a2018-08-27 10:47:25 -0400680 if (!ValidateAST(root, &mDiagnostics, mValidateASTOptions))
681 {
682 return false;
683 }
Olli Etuahod10cf692017-11-02 11:06:14 +0200684
685 RemoveArrayLengthMethod(root);
Shahbaz Youssefi91d469a2018-08-27 10:47:25 -0400686 if (!ValidateAST(root, &mDiagnostics, mValidateASTOptions))
687 {
688 return false;
689 }
Olli Etuahod10cf692017-11-02 11:06:14 +0200690
Olli Etuaho6f591c92018-09-21 11:20:47 +0300691 RemoveUnreferencedVariables(root, &mSymbolTable);
Shahbaz Youssefi91d469a2018-08-27 10:47:25 -0400692 if (!ValidateAST(root, &mDiagnostics, mValidateASTOptions))
693 {
694 return false;
695 }
Olli Etuaho3d70ca92017-11-10 16:53:26 +0200696
Olli Etuaho41217992018-03-15 11:15:33 +0200697 // In case the last case inside a switch statement is a certain type of no-op, GLSL compilers in
698 // drivers may not accept it. In this case we clean up the dead code from the end of switch
699 // statements. This is also required because PruneNoOps or RemoveUnreferencedVariables may have
700 // left switch statements that only contained an empty declaration inside the final case in an
701 // invalid state. Relies on that PruneNoOps and RemoveUnreferencedVariables have already been
702 // run.
Olli Etuaho0b0dcbc2018-03-14 11:33:22 +0200703 PruneEmptyCases(root);
Shahbaz Youssefi91d469a2018-08-27 10:47:25 -0400704 if (!ValidateAST(root, &mDiagnostics, mValidateASTOptions))
705 {
706 return false;
707 }
Olli Etuaho0b0dcbc2018-03-14 11:33:22 +0200708
Olli Etuaho3d70ca92017-11-10 16:53:26 +0200709 // Built-in function emulation needs to happen after validateLimitations pass.
710 // TODO(jmadill): Remove global pool allocator.
711 GetGlobalPoolAllocator()->lock();
Olli Etuaho6f591c92018-09-21 11:20:47 +0300712 initBuiltInFunctionEmulator(&mBuiltInFunctionEmulator, compileOptions);
Olli Etuaho3d70ca92017-11-10 16:53:26 +0200713 GetGlobalPoolAllocator()->unlock();
Olli Etuaho6f591c92018-09-21 11:20:47 +0300714 mBuiltInFunctionEmulator.markBuiltInFunctionsForEmulation(root);
Olli Etuaho3d70ca92017-11-10 16:53:26 +0200715
Olli Etuaho6f591c92018-09-21 11:20:47 +0300716 bool highPrecisionSupported = mShaderVersion > 100 || mShaderType != GL_FRAGMENT_SHADER ||
717 mResources.FragmentPrecisionHigh == 1;
Olli Etuaho3d70ca92017-11-10 16:53:26 +0200718 if (compileOptions & SH_SCALARIZE_VEC_AND_MAT_CONSTRUCTOR_ARGS)
719 {
Olli Etuaho6f591c92018-09-21 11:20:47 +0300720 ScalarizeVecAndMatConstructorArgs(root, mShaderType, highPrecisionSupported, &mSymbolTable);
Shahbaz Youssefi91d469a2018-08-27 10:47:25 -0400721 if (!ValidateAST(root, &mDiagnostics, mValidateASTOptions))
722 {
723 return false;
724 }
Olli Etuaho3d70ca92017-11-10 16:53:26 +0200725 }
726
Shahbaz Youssefi216f73d2019-04-12 13:32:30 -0400727 if (compileOptions & SH_REDEFINE_INTERFACE_LAYOUT_QUALIFIERS_WITH_STD)
728 {
729 // Change the interface block layouts based on GL_KHR_vulkan_glsl. Only std140 and std430
730 // are allowed in Vulkan GLSL.
731 RedefineInterfaceBlockLayoutQualifiersWithStd(root, &mSymbolTable);
732 }
733
Olli Etuaho3d70ca92017-11-10 16:53:26 +0200734 if (shouldCollectVariables(compileOptions))
735 {
Olli Etuaho6f591c92018-09-21 11:20:47 +0300736 ASSERT(!mVariablesCollected);
737 CollectVariables(root, &mAttributes, &mOutputVariables, &mUniforms, &mInputVaryings,
738 &mOutputVaryings, &mUniformBlocks, &mShaderStorageBlocks, &mInBlocks,
739 mResources.HashFunction, &mSymbolTable, mShaderType, mExtensionBehavior);
Olli Etuaho3d70ca92017-11-10 16:53:26 +0200740 collectInterfaceBlocks();
Olli Etuaho6f591c92018-09-21 11:20:47 +0300741 mVariablesCollected = true;
Olli Etuaho3d70ca92017-11-10 16:53:26 +0200742 if (compileOptions & SH_USE_UNUSED_STANDARD_SHARED_BLOCKS)
743 {
744 useAllMembersInUnusedStandardAndSharedBlocks(root);
745 }
746 if (compileOptions & SH_ENFORCE_PACKING_RESTRICTIONS)
747 {
Olli Etuaho6f591c92018-09-21 11:20:47 +0300748 int maxUniformVectors = GetMaxUniformVectorsForShaderType(mShaderType, mResources);
Olli Etuaho3d70ca92017-11-10 16:53:26 +0200749 // Returns true if, after applying the packing rules in the GLSL ES 1.00.17 spec
750 // Appendix A, section 7, the shader does not use too many uniforms.
Olli Etuaho6f591c92018-09-21 11:20:47 +0300751 if (!CheckVariablesInPackingLimits(maxUniformVectors, mUniforms))
Olli Etuaho3d70ca92017-11-10 16:53:26 +0200752 {
753 mDiagnostics.globalError("too many uniforms");
754 return false;
755 }
756 }
Olli Etuaho6f591c92018-09-21 11:20:47 +0300757 if ((compileOptions & SH_INIT_OUTPUT_VARIABLES) && (mShaderType != GL_COMPUTE_SHADER))
Olli Etuaho3d70ca92017-11-10 16:53:26 +0200758 {
759 initializeOutputVariables(root);
Shahbaz Youssefi91d469a2018-08-27 10:47:25 -0400760 if (!ValidateAST(root, &mDiagnostics, mValidateASTOptions))
761 {
762 return false;
763 }
Olli Etuaho3d70ca92017-11-10 16:53:26 +0200764 }
765 }
766
767 // Removing invariant declarations must be done after collecting variables.
768 // Otherwise, built-in invariant declarations don't apply.
Olli Etuaho6f591c92018-09-21 11:20:47 +0300769 if (RemoveInvariant(mShaderType, mShaderVersion, mOutputType, compileOptions))
Olli Etuaho3d70ca92017-11-10 16:53:26 +0200770 {
771 RemoveInvariantDeclaration(root);
Shahbaz Youssefi91d469a2018-08-27 10:47:25 -0400772 if (!ValidateAST(root, &mDiagnostics, mValidateASTOptions))
773 {
774 return false;
775 }
Olli Etuaho3d70ca92017-11-10 16:53:26 +0200776 }
777
778 // gl_Position is always written in compatibility output mode.
779 // It may have been already initialized among other output variables, in that case we don't
780 // need to initialize it twice.
Olli Etuaho6f591c92018-09-21 11:20:47 +0300781 if (mShaderType == GL_VERTEX_SHADER && !mGLPositionInitialized &&
782 ((compileOptions & SH_INIT_GL_POSITION) || (mOutputType == SH_GLSL_COMPATIBILITY_OUTPUT)))
Olli Etuaho3d70ca92017-11-10 16:53:26 +0200783 {
784 initializeGLPosition(root);
785 mGLPositionInitialized = true;
Shahbaz Youssefi91d469a2018-08-27 10:47:25 -0400786 if (!ValidateAST(root, &mDiagnostics, mValidateASTOptions))
787 {
788 return false;
789 }
Olli Etuaho3d70ca92017-11-10 16:53:26 +0200790 }
791
Olli Etuahob5601eb2017-11-15 18:08:04 +0200792 // DeferGlobalInitializers needs to be run before other AST transformations that generate new
793 // statements from expressions. But it's fine to run DeferGlobalInitializers after the above
794 // SplitSequenceOperator and RemoveArrayLengthMethod since they only have an effect on the AST
795 // on ESSL >= 3.00, and the initializers that need to be deferred can only exist in ESSL < 3.00.
796 bool initializeLocalsAndGlobals =
797 (compileOptions & SH_INITIALIZE_UNINITIALIZED_LOCALS) && !IsOutputHLSL(getOutputType());
Olli Etuaho2c7f34c2017-10-09 17:18:02 +0300798 bool canUseLoopsToInitialize = !(compileOptions & SH_DONT_USE_LOOPS_TO_INITIALIZE_VARIABLES);
Olli Etuaho87cc90d2017-12-12 15:28:06 +0200799 DeferGlobalInitializers(root, initializeLocalsAndGlobals, canUseLoopsToInitialize,
Olli Etuaho6f591c92018-09-21 11:20:47 +0300800 highPrecisionSupported, &mSymbolTable);
Shahbaz Youssefi91d469a2018-08-27 10:47:25 -0400801 if (!ValidateAST(root, &mDiagnostics, mValidateASTOptions))
802 {
803 return false;
804 }
Olli Etuaho2c7f34c2017-10-09 17:18:02 +0300805
Olli Etuahob5601eb2017-11-15 18:08:04 +0200806 if (initializeLocalsAndGlobals)
Olli Etuahod10cf692017-11-02 11:06:14 +0200807 {
808 // Initialize uninitialized local variables.
809 // In some cases initializing can generate extra statements in the parent block, such as
810 // when initializing nameless structs or initializing arrays in ESSL 1.00. In that case
811 // we need to first simplify loop conditions. We've already separated declarations
812 // earlier, which is also required. If we don't follow the Appendix A limitations, loop
813 // init statements can declare arrays or nameless structs and have multiple
814 // declarations.
815
816 if (!shouldRunLoopAndIndexingValidation(compileOptions))
817 {
818 SimplifyLoopConditions(root,
819 IntermNodePatternMatcher::kArrayDeclaration |
820 IntermNodePatternMatcher::kNamelessStructDeclaration,
Olli Etuaho68981eb2018-01-23 17:46:12 +0200821 &getSymbolTable());
Shahbaz Youssefi91d469a2018-08-27 10:47:25 -0400822 if (!ValidateAST(root, &mDiagnostics, mValidateASTOptions))
823 {
824 return false;
825 }
Olli Etuahod10cf692017-11-02 11:06:14 +0200826 }
Olli Etuaho661fc482017-10-16 12:17:05 +0300827
Olli Etuaho2c7f34c2017-10-09 17:18:02 +0300828 InitializeUninitializedLocals(root, getShaderVersion(), canUseLoopsToInitialize,
Olli Etuaho87cc90d2017-12-12 15:28:06 +0200829 highPrecisionSupported, &getSymbolTable());
Shahbaz Youssefi91d469a2018-08-27 10:47:25 -0400830 if (!ValidateAST(root, &mDiagnostics, mValidateASTOptions))
831 {
832 return false;
833 }
Olli Etuahod10cf692017-11-02 11:06:14 +0200834 }
835
836 if (getShaderType() == GL_VERTEX_SHADER && (compileOptions & SH_CLAMP_POINT_SIZE))
837 {
Olli Etuaho6f591c92018-09-21 11:20:47 +0300838 ClampPointSize(root, mResources.MaxPointSize, &getSymbolTable());
Shahbaz Youssefi91d469a2018-08-27 10:47:25 -0400839 if (!ValidateAST(root, &mDiagnostics, mValidateASTOptions))
840 {
841 return false;
842 }
Olli Etuahod10cf692017-11-02 11:06:14 +0200843 }
844
Olli Etuaho0690e1a2017-12-21 20:51:38 +0200845 if (getShaderType() == GL_FRAGMENT_SHADER && (compileOptions & SH_CLAMP_FRAG_DEPTH))
846 {
847 ClampFragDepth(root, &getSymbolTable());
Shahbaz Youssefi91d469a2018-08-27 10:47:25 -0400848 if (!ValidateAST(root, &mDiagnostics, mValidateASTOptions))
849 {
850 return false;
851 }
Olli Etuaho0690e1a2017-12-21 20:51:38 +0200852 }
853
Olli Etuaho983460e2018-05-02 17:57:39 +0300854 if (compileOptions & SH_REWRITE_REPEATED_ASSIGN_TO_SWIZZLED)
855 {
856 sh::RewriteRepeatedAssignToSwizzled(root);
Shahbaz Youssefi91d469a2018-08-27 10:47:25 -0400857 if (!ValidateAST(root, &mDiagnostics, mValidateASTOptions))
858 {
859 return false;
860 }
Olli Etuaho983460e2018-05-02 17:57:39 +0300861 }
862
Olli Etuaho661fc482017-10-16 12:17:05 +0300863 if (compileOptions & SH_REWRITE_VECTOR_SCALAR_ARITHMETIC)
864 {
865 VectorizeVectorScalarArithmetic(root, &getSymbolTable());
Shahbaz Youssefi91d469a2018-08-27 10:47:25 -0400866 if (!ValidateAST(root, &mDiagnostics, mValidateASTOptions))
867 {
868 return false;
869 }
Olli Etuaho661fc482017-10-16 12:17:05 +0300870 }
871
Olli Etuahod10cf692017-11-02 11:06:14 +0200872 return true;
Olli Etuahoa3a5cc62015-02-13 13:12:22 +0200873}
874
Qiankun Miao7ebb97f2016-09-08 18:01:50 +0800875bool TCompiler::compile(const char *const shaderStrings[],
876 size_t numStrings,
877 ShCompileOptions compileOptionsIn)
Olli Etuahoa3a5cc62015-02-13 13:12:22 +0200878{
Corentin Wallez28b65282016-06-16 07:24:50 -0700879#if defined(ANGLE_ENABLE_FUZZER_CORPUS_OUTPUT)
Olli Etuaho6f591c92018-09-21 11:20:47 +0300880 DumpFuzzerCase(shaderStrings, numStrings, mShaderType, mShaderSpec, mOutputType,
881 compileOptionsIn);
Corentin Wallez28b65282016-06-16 07:24:50 -0700882#endif // defined(ANGLE_ENABLE_FUZZER_CORPUS_OUTPUT)
883
Olli Etuahoa3a5cc62015-02-13 13:12:22 +0200884 if (numStrings == 0)
885 return true;
886
Qiankun Miao7ebb97f2016-09-08 18:01:50 +0800887 ShCompileOptions compileOptions = compileOptionsIn;
Kenneth Russellbccc65d2016-07-19 16:48:43 -0700888
889 // Apply key workarounds.
890 if (shouldFlattenPragmaStdglInvariantAll())
891 {
892 // This should be harmless to do in all cases, but for the moment, do it only conditionally.
893 compileOptions |= SH_FLATTEN_PRAGMA_STDGL_INVARIANT_ALL;
894 }
895
Olli Etuahoa3a5cc62015-02-13 13:12:22 +0200896 TScopedPoolAllocator scopedAlloc(&allocator);
Olli Etuaho6d40bbd2016-09-30 13:49:38 +0100897 TIntermBlock *root = compileTreeImpl(shaderStrings, numStrings, compileOptions);
Olli Etuahoa3a5cc62015-02-13 13:12:22 +0200898
899 if (root)
900 {
901 if (compileOptions & SH_INTERMEDIATE_TREE)
Olli Etuaho6f591c92018-09-21 11:20:47 +0300902 OutputTree(root, mInfoSink.info);
Olli Etuahoa3a5cc62015-02-13 13:12:22 +0200903
904 if (compileOptions & SH_OBJECT_CODE)
Olli Etuaho89a69a02017-10-23 12:20:45 +0300905 {
906 PerformanceDiagnostics perfDiagnostics(&mDiagnostics);
907 translate(root, compileOptions, &perfDiagnostics);
908 }
Olli Etuahoa3a5cc62015-02-13 13:12:22 +0200909
Austin Eng7cf9cd22018-10-09 15:27:32 -0700910 if (mShaderType == GL_VERTEX_SHADER &&
911 IsExtensionEnabled(mExtensionBehavior, TExtension::ANGLE_multi_draw))
912 {
913 if ((compileOptions & SH_EMULATE_GL_DRAW_ID) != 0)
914 {
Jamie Madillb980c562018-11-27 11:34:27 -0500915 for (auto &uniform : mUniforms)
Austin Eng7cf9cd22018-10-09 15:27:32 -0700916 {
917 if (uniform.name == "angle_DrawID" && uniform.mappedName == "angle_DrawID")
918 {
919 uniform.name = "gl_DrawID";
920 break;
921 }
922 }
923 }
924 }
925
Olli Etuahoa3a5cc62015-02-13 13:12:22 +0200926 // The IntermNode tree doesn't need to be deleted here, since the
927 // memory will be freed in a big chunk by the PoolAllocator.
928 return true;
929 }
930 return false;
alokp@chromium.org07620a52010-09-23 17:53:56 +0000931}
932
Olli Etuaho6f591c92018-09-21 11:20:47 +0300933bool TCompiler::initBuiltInSymbolTable(const ShBuiltInResources &resources)
alokp@chromium.org07620a52010-09-23 17:53:56 +0000934{
Olli Etuaho28cb0362016-11-22 15:42:37 +0000935 if (resources.MaxDrawBuffers < 1)
936 {
937 return false;
938 }
939 if (resources.EXT_blend_func_extended && resources.MaxDualSourceDrawBuffers < 1)
940 {
941 return false;
942 }
943
Olli Etuaho6f591c92018-09-21 11:20:47 +0300944 mSymbolTable.initializeBuiltIns(mShaderType, mShaderSpec, resources);
Olli Etuaho5d69db12017-11-24 16:51:15 +0200945
Nicolas Capens49a88872013-06-20 09:54:03 -0400946 return true;
alokp@chromium.org07620a52010-09-23 17:53:56 +0000947}
948
Shannon Woods2d76e5f2014-05-16 17:46:41 -0400949void TCompiler::setResourceString()
950{
Jonah Ryan-Davisf563fdc2019-01-31 13:53:59 -0500951 std::ostringstream strstream = sh::InitializeStream<std::ostringstream>();
Geoff Langb66a9092016-05-16 15:59:14 -0400952
953 // clang-format off
Olli Etuaho6f591c92018-09-21 11:20:47 +0300954 strstream << ":MaxVertexAttribs:" << mResources.MaxVertexAttribs
955 << ":MaxVertexUniformVectors:" << mResources.MaxVertexUniformVectors
956 << ":MaxVaryingVectors:" << mResources.MaxVaryingVectors
957 << ":MaxVertexTextureImageUnits:" << mResources.MaxVertexTextureImageUnits
958 << ":MaxCombinedTextureImageUnits:" << mResources.MaxCombinedTextureImageUnits
959 << ":MaxTextureImageUnits:" << mResources.MaxTextureImageUnits
960 << ":MaxFragmentUniformVectors:" << mResources.MaxFragmentUniformVectors
961 << ":MaxDrawBuffers:" << mResources.MaxDrawBuffers
962 << ":OES_standard_derivatives:" << mResources.OES_standard_derivatives
963 << ":OES_EGL_image_external:" << mResources.OES_EGL_image_external
964 << ":OES_EGL_image_external_essl3:" << mResources.OES_EGL_image_external_essl3
965 << ":NV_EGL_stream_consumer_external:" << mResources.NV_EGL_stream_consumer_external
966 << ":ARB_texture_rectangle:" << mResources.ARB_texture_rectangle
967 << ":EXT_draw_buffers:" << mResources.EXT_draw_buffers
968 << ":FragmentPrecisionHigh:" << mResources.FragmentPrecisionHigh
969 << ":MaxExpressionComplexity:" << mResources.MaxExpressionComplexity
970 << ":MaxCallStackDepth:" << mResources.MaxCallStackDepth
971 << ":MaxFunctionParameters:" << mResources.MaxFunctionParameters
972 << ":EXT_blend_func_extended:" << mResources.EXT_blend_func_extended
973 << ":EXT_frag_depth:" << mResources.EXT_frag_depth
974 << ":EXT_shader_texture_lod:" << mResources.EXT_shader_texture_lod
975 << ":EXT_shader_framebuffer_fetch:" << mResources.EXT_shader_framebuffer_fetch
976 << ":NV_shader_framebuffer_fetch:" << mResources.NV_shader_framebuffer_fetch
977 << ":ARM_shader_framebuffer_fetch:" << mResources.ARM_shader_framebuffer_fetch
Mingyu Hu7d64c482019-03-12 14:27:40 -0700978 << ":OVR_multiview2:" << mResources.OVR_multiview2
Mingyu Huebab6702019-04-19 14:36:45 -0700979 << ":OVR_multiview:" << mResources.OVR_multiview
Olli Etuaho6f591c92018-09-21 11:20:47 +0300980 << ":EXT_YUV_target:" << mResources.EXT_YUV_target
981 << ":EXT_geometry_shader:" << mResources.EXT_geometry_shader
982 << ":MaxVertexOutputVectors:" << mResources.MaxVertexOutputVectors
983 << ":MaxFragmentInputVectors:" << mResources.MaxFragmentInputVectors
984 << ":MinProgramTexelOffset:" << mResources.MinProgramTexelOffset
985 << ":MaxProgramTexelOffset:" << mResources.MaxProgramTexelOffset
986 << ":MaxDualSourceDrawBuffers:" << mResources.MaxDualSourceDrawBuffers
987 << ":MaxViewsOVR:" << mResources.MaxViewsOVR
988 << ":NV_draw_buffers:" << mResources.NV_draw_buffers
989 << ":WEBGL_debug_shader_precision:" << mResources.WEBGL_debug_shader_precision
Austin Eng7cf9cd22018-10-09 15:27:32 -0700990 << ":ANGLE_multi_draw:" << mResources.ANGLE_multi_draw
Olli Etuaho6f591c92018-09-21 11:20:47 +0300991 << ":MinProgramTextureGatherOffset:" << mResources.MinProgramTextureGatherOffset
992 << ":MaxProgramTextureGatherOffset:" << mResources.MaxProgramTextureGatherOffset
993 << ":MaxImageUnits:" << mResources.MaxImageUnits
994 << ":MaxVertexImageUniforms:" << mResources.MaxVertexImageUniforms
995 << ":MaxFragmentImageUniforms:" << mResources.MaxFragmentImageUniforms
996 << ":MaxComputeImageUniforms:" << mResources.MaxComputeImageUniforms
997 << ":MaxCombinedImageUniforms:" << mResources.MaxCombinedImageUniforms
998 << ":MaxCombinedShaderOutputResources:" << mResources.MaxCombinedShaderOutputResources
999 << ":MaxComputeWorkGroupCountX:" << mResources.MaxComputeWorkGroupCount[0]
1000 << ":MaxComputeWorkGroupCountY:" << mResources.MaxComputeWorkGroupCount[1]
1001 << ":MaxComputeWorkGroupCountZ:" << mResources.MaxComputeWorkGroupCount[2]
1002 << ":MaxComputeWorkGroupSizeX:" << mResources.MaxComputeWorkGroupSize[0]
1003 << ":MaxComputeWorkGroupSizeY:" << mResources.MaxComputeWorkGroupSize[1]
1004 << ":MaxComputeWorkGroupSizeZ:" << mResources.MaxComputeWorkGroupSize[2]
1005 << ":MaxComputeUniformComponents:" << mResources.MaxComputeUniformComponents
1006 << ":MaxComputeTextureImageUnits:" << mResources.MaxComputeTextureImageUnits
1007 << ":MaxComputeAtomicCounters:" << mResources.MaxComputeAtomicCounters
1008 << ":MaxComputeAtomicCounterBuffers:" << mResources.MaxComputeAtomicCounterBuffers
1009 << ":MaxVertexAtomicCounters:" << mResources.MaxVertexAtomicCounters
1010 << ":MaxFragmentAtomicCounters:" << mResources.MaxFragmentAtomicCounters
1011 << ":MaxCombinedAtomicCounters:" << mResources.MaxCombinedAtomicCounters
1012 << ":MaxAtomicCounterBindings:" << mResources.MaxAtomicCounterBindings
1013 << ":MaxVertexAtomicCounterBuffers:" << mResources.MaxVertexAtomicCounterBuffers
1014 << ":MaxFragmentAtomicCounterBuffers:" << mResources.MaxFragmentAtomicCounterBuffers
1015 << ":MaxCombinedAtomicCounterBuffers:" << mResources.MaxCombinedAtomicCounterBuffers
1016 << ":MaxAtomicCounterBufferSize:" << mResources.MaxAtomicCounterBufferSize
1017 << ":MaxGeometryUniformComponents:" << mResources.MaxGeometryUniformComponents
1018 << ":MaxGeometryUniformBlocks:" << mResources.MaxGeometryUniformBlocks
1019 << ":MaxGeometryInputComponents:" << mResources.MaxGeometryInputComponents
1020 << ":MaxGeometryOutputComponents:" << mResources.MaxGeometryOutputComponents
1021 << ":MaxGeometryOutputVertices:" << mResources.MaxGeometryOutputVertices
1022 << ":MaxGeometryTotalOutputComponents:" << mResources.MaxGeometryTotalOutputComponents
1023 << ":MaxGeometryTextureImageUnits:" << mResources.MaxGeometryTextureImageUnits
1024 << ":MaxGeometryAtomicCounterBuffers:" << mResources.MaxGeometryAtomicCounterBuffers
1025 << ":MaxGeometryAtomicCounters:" << mResources.MaxGeometryAtomicCounters
1026 << ":MaxGeometryShaderStorageBlocks:" << mResources.MaxGeometryShaderStorageBlocks
1027 << ":MaxGeometryShaderInvocations:" << mResources.MaxGeometryShaderInvocations
1028 << ":MaxGeometryImageUniforms:" << mResources.MaxGeometryImageUniforms;
Geoff Langb66a9092016-05-16 15:59:14 -04001029 // clang-format on
Shannon Woods2d76e5f2014-05-16 17:46:41 -04001030
Olli Etuaho6f591c92018-09-21 11:20:47 +03001031 mBuiltInResourcesString = strstream.str();
Shannon Woods2d76e5f2014-05-16 17:46:41 -04001032}
1033
Jiajia Qin9b11ea42017-07-11 16:50:08 +08001034void TCompiler::collectInterfaceBlocks()
1035{
Olli Etuaho6f591c92018-09-21 11:20:47 +03001036 ASSERT(mInterfaceBlocks.empty());
1037 mInterfaceBlocks.reserve(mUniformBlocks.size() + mShaderStorageBlocks.size() +
1038 mInBlocks.size());
1039 mInterfaceBlocks.insert(mInterfaceBlocks.end(), mUniformBlocks.begin(), mUniformBlocks.end());
1040 mInterfaceBlocks.insert(mInterfaceBlocks.end(), mShaderStorageBlocks.begin(),
1041 mShaderStorageBlocks.end());
1042 mInterfaceBlocks.insert(mInterfaceBlocks.end(), mInBlocks.begin(), mInBlocks.end());
Jiajia Qin9b11ea42017-07-11 16:50:08 +08001043}
1044
alokp@chromium.org07620a52010-09-23 17:53:56 +00001045void TCompiler::clearResults()
1046{
Olli Etuaho6f591c92018-09-21 11:20:47 +03001047 mArrayBoundsClamper.Cleanup();
1048 mInfoSink.info.erase();
1049 mInfoSink.obj.erase();
1050 mInfoSink.debug.erase();
Olli Etuaho77ba4082016-12-16 12:01:18 +00001051 mDiagnostics.resetErrorCount();
alokp@chromium.org07620a52010-09-23 17:53:56 +00001052
Olli Etuaho6f591c92018-09-21 11:20:47 +03001053 mAttributes.clear();
1054 mOutputVariables.clear();
1055 mUniforms.clear();
1056 mInputVaryings.clear();
1057 mOutputVaryings.clear();
1058 mInterfaceBlocks.clear();
1059 mUniformBlocks.clear();
1060 mShaderStorageBlocks.clear();
1061 mInBlocks.clear();
1062 mVariablesCollected = false;
Olli Etuahob12040c2017-06-27 14:20:45 +03001063 mGLPositionInitialized = false;
zmo@google.coma3b4ab42011-09-16 00:53:26 +00001064
Olli Etuaho09b04a22016-12-15 13:30:26 +00001065 mNumViews = -1;
1066
Shaob5cc1192017-07-06 10:47:20 +08001067 mGeometryShaderInputPrimitiveType = EptUndefined;
1068 mGeometryShaderOutputPrimitiveType = EptUndefined;
1069 mGeometryShaderInvocations = 0;
1070 mGeometryShaderMaxVertices = -1;
1071
Olli Etuaho6f591c92018-09-21 11:20:47 +03001072 mBuiltInFunctionEmulator.cleanup();
daniel@transgaming.com0aa3b5a2012-11-28 19:43:24 +00001073
Olli Etuaho6f591c92018-09-21 11:20:47 +03001074 mNameMap.clear();
Olli Etuahoa3a5cc62015-02-13 13:12:22 +02001075
Jamie Madillb980c562018-11-27 11:34:27 -05001076 mSourcePath = nullptr;
Olli Etuaho5d69db12017-11-24 16:51:15 +02001077
Olli Etuaho6f591c92018-09-21 11:20:47 +03001078 mSymbolTable.clearCompilationResults();
alokp@chromium.org07620a52010-09-23 17:53:56 +00001079}
1080
Corentin Wallez71d147f2015-02-11 11:15:24 -08001081bool TCompiler::initCallDag(TIntermNode *root)
zmo@google.comb1762df2011-07-30 02:04:23 +00001082{
Corentin Wallez71d147f2015-02-11 11:15:24 -08001083 mCallDag.clear();
1084
Olli Etuaho77ba4082016-12-16 12:01:18 +00001085 switch (mCallDag.init(root, &mDiagnostics))
Zhenyao Mo4a667fe2014-02-11 12:35:01 -08001086 {
Jamie Madillacb4b812016-11-07 13:50:29 -05001087 case CallDAG::INITDAG_SUCCESS:
1088 return true;
1089 case CallDAG::INITDAG_RECURSION:
Jamie Madillacb4b812016-11-07 13:50:29 -05001090 case CallDAG::INITDAG_UNDEFINED:
Olli Etuaho77ba4082016-12-16 12:01:18 +00001091 // Error message has already been written out.
1092 ASSERT(mDiagnostics.numErrors() > 0);
Jamie Madillacb4b812016-11-07 13:50:29 -05001093 return false;
Corentin Wallez71d147f2015-02-11 11:15:24 -08001094 }
1095
1096 UNREACHABLE();
1097 return true;
1098}
1099
1100bool TCompiler::checkCallDepth()
1101{
1102 std::vector<int> depths(mCallDag.size());
1103
1104 for (size_t i = 0; i < mCallDag.size(); i++)
1105 {
Jonah Ryan-Davisf563fdc2019-01-31 13:53:59 -05001106 int depth = 0;
Jonah Ryan-Davisd4c09dd2019-01-29 11:22:54 -05001107 const CallDAG::Record &record = mCallDag.getRecordFromIndex(i);
Corentin Wallez71d147f2015-02-11 11:15:24 -08001108
Jonah Ryan-Davisd4c09dd2019-01-29 11:22:54 -05001109 for (const int &calleeIndex : record.callees)
Corentin Wallez71d147f2015-02-11 11:15:24 -08001110 {
1111 depth = std::max(depth, depths[calleeIndex] + 1);
1112 }
1113
1114 depths[i] = depth;
1115
Olli Etuaho6f591c92018-09-21 11:20:47 +03001116 if (depth >= mResources.MaxCallStackDepth)
Corentin Wallez71d147f2015-02-11 11:15:24 -08001117 {
1118 // Trace back the function chain to have a meaningful info log.
Jonah Ryan-Davisf563fdc2019-01-31 13:53:59 -05001119 std::stringstream errorStream = sh::InitializeStream<std::stringstream>();
Olli Etuaho6f591c92018-09-21 11:20:47 +03001120 errorStream << "Call stack too deep (larger than " << mResources.MaxCallStackDepth
Olli Etuahoc33f1e82017-12-29 16:55:29 +02001121 << ") with the following call chain: "
1122 << record.node->getFunction()->name();
Corentin Wallez71d147f2015-02-11 11:15:24 -08001123
Cooper Partin4d61f7e2015-08-12 10:56:50 -07001124 int currentFunction = static_cast<int>(i);
Jamie Madilld7b1ab52016-12-12 14:42:19 -05001125 int currentDepth = depth;
Corentin Wallez71d147f2015-02-11 11:15:24 -08001126
1127 while (currentFunction != -1)
1128 {
Olli Etuahoc33f1e82017-12-29 16:55:29 +02001129 errorStream
1130 << " -> "
1131 << mCallDag.getRecordFromIndex(currentFunction).node->getFunction()->name();
Corentin Wallez71d147f2015-02-11 11:15:24 -08001132
1133 int nextFunction = -1;
Jonah Ryan-Davisd4c09dd2019-01-29 11:22:54 -05001134 for (const int &calleeIndex : mCallDag.getRecordFromIndex(currentFunction).callees)
Corentin Wallez71d147f2015-02-11 11:15:24 -08001135 {
1136 if (depths[calleeIndex] == currentDepth - 1)
1137 {
1138 currentDepth--;
1139 nextFunction = calleeIndex;
1140 }
1141 }
1142
1143 currentFunction = nextFunction;
1144 }
1145
Olli Etuaho77ba4082016-12-16 12:01:18 +00001146 std::string errorStr = errorStream.str();
1147 mDiagnostics.globalError(errorStr.c_str());
1148
Corentin Wallez71d147f2015-02-11 11:15:24 -08001149 return false;
1150 }
1151 }
1152
1153 return true;
1154}
1155
1156bool TCompiler::tagUsedFunctions()
1157{
1158 // Search from main, starting from the end of the DAG as it usually is the root.
Cooper Partin4d61f7e2015-08-12 10:56:50 -07001159 for (size_t i = mCallDag.size(); i-- > 0;)
Corentin Wallez71d147f2015-02-11 11:15:24 -08001160 {
Olli Etuahoc33f1e82017-12-29 16:55:29 +02001161 if (mCallDag.getRecordFromIndex(i).node->getFunction()->isMain())
Corentin Wallez71d147f2015-02-11 11:15:24 -08001162 {
1163 internalTagUsedFunction(i);
1164 return true;
1165 }
1166 }
1167
Olli Etuaho77ba4082016-12-16 12:01:18 +00001168 mDiagnostics.globalError("Missing main()");
Corentin Wallez71d147f2015-02-11 11:15:24 -08001169 return false;
1170}
1171
1172void TCompiler::internalTagUsedFunction(size_t index)
1173{
Olli Etuaho6f591c92018-09-21 11:20:47 +03001174 if (mFunctionMetadata[index].used)
Corentin Wallez71d147f2015-02-11 11:15:24 -08001175 {
1176 return;
1177 }
1178
Olli Etuaho6f591c92018-09-21 11:20:47 +03001179 mFunctionMetadata[index].used = true;
Corentin Wallez71d147f2015-02-11 11:15:24 -08001180
1181 for (int calleeIndex : mCallDag.getRecordFromIndex(index).callees)
1182 {
1183 internalTagUsedFunction(calleeIndex);
zmo@google.comb1762df2011-07-30 02:04:23 +00001184 }
1185}
1186
Corentin Walleza094a8a2015-04-07 11:53:06 -07001187// A predicate for the stl that returns if a top-level node is unused
1188class TCompiler::UnusedPredicate
1189{
1190 public:
1191 UnusedPredicate(const CallDAG *callDag, const std::vector<FunctionMetadata> *metadatas)
Jamie Madillacb4b812016-11-07 13:50:29 -05001192 : mCallDag(callDag), mMetadatas(metadatas)
Jamie Madillb980c562018-11-27 11:34:27 -05001193 {}
Corentin Walleza094a8a2015-04-07 11:53:06 -07001194
Jamie Madilld7b1ab52016-12-12 14:42:19 -05001195 bool operator()(TIntermNode *node)
Corentin Walleza094a8a2015-04-07 11:53:06 -07001196 {
Olli Etuaho16c745a2017-01-16 17:02:27 +00001197 const TIntermFunctionPrototype *asFunctionPrototype = node->getAsFunctionPrototypeNode();
1198 const TIntermFunctionDefinition *asFunctionDefinition = node->getAsFunctionDefinition();
Corentin Walleza094a8a2015-04-07 11:53:06 -07001199
Olli Etuahobeb6dc72017-12-14 16:03:03 +02001200 const TFunction *func = nullptr;
Olli Etuaho336b1472016-10-05 16:37:55 +01001201
Olli Etuaho16c745a2017-01-16 17:02:27 +00001202 if (asFunctionDefinition)
Olli Etuaho336b1472016-10-05 16:37:55 +01001203 {
Olli Etuahobeb6dc72017-12-14 16:03:03 +02001204 func = asFunctionDefinition->getFunction();
Olli Etuaho336b1472016-10-05 16:37:55 +01001205 }
Olli Etuaho16c745a2017-01-16 17:02:27 +00001206 else if (asFunctionPrototype)
Olli Etuaho336b1472016-10-05 16:37:55 +01001207 {
Olli Etuahobeb6dc72017-12-14 16:03:03 +02001208 func = asFunctionPrototype->getFunction();
Olli Etuaho336b1472016-10-05 16:37:55 +01001209 }
Olli Etuahobeb6dc72017-12-14 16:03:03 +02001210 if (func == nullptr)
Corentin Walleza094a8a2015-04-07 11:53:06 -07001211 {
1212 return false;
1213 }
1214
Olli Etuahobeb6dc72017-12-14 16:03:03 +02001215 size_t callDagIndex = mCallDag->findIndex(func->uniqueId());
Corentin Walleza094a8a2015-04-07 11:53:06 -07001216 if (callDagIndex == CallDAG::InvalidIndex)
1217 {
1218 // This happens only for unimplemented prototypes which are thus unused
Olli Etuaho16c745a2017-01-16 17:02:27 +00001219 ASSERT(asFunctionPrototype);
Corentin Walleza094a8a2015-04-07 11:53:06 -07001220 return true;
1221 }
1222
1223 ASSERT(callDagIndex < mMetadatas->size());
1224 return !(*mMetadatas)[callDagIndex].used;
1225 }
1226
1227 private:
1228 const CallDAG *mCallDag;
1229 const std::vector<FunctionMetadata> *mMetadatas;
1230};
1231
Olli Etuahod10cf692017-11-02 11:06:14 +02001232void TCompiler::pruneUnusedFunctions(TIntermBlock *root)
Corentin Walleza094a8a2015-04-07 11:53:06 -07001233{
Olli Etuaho6f591c92018-09-21 11:20:47 +03001234 UnusedPredicate isUnused(&mCallDag, &mFunctionMetadata);
Olli Etuaho6d40bbd2016-09-30 13:49:38 +01001235 TIntermSequence *sequence = root->getSequence();
Corentin Wallezb081e782015-07-20 05:40:04 -07001236
1237 if (!sequence->empty())
1238 {
Jamie Madilld7b1ab52016-12-12 14:42:19 -05001239 sequence->erase(std::remove_if(sequence->begin(), sequence->end(), isUnused),
1240 sequence->end());
Corentin Wallezb081e782015-07-20 05:40:04 -07001241 }
Corentin Walleza094a8a2015-04-07 11:53:06 -07001242}
1243
Olli Etuahob4279202017-05-18 15:08:24 +03001244bool TCompiler::limitExpressionComplexity(TIntermBlock *root)
Jamie Madilleb1a0102013-07-08 13:31:38 -04001245{
Olli Etuaho6f591c92018-09-21 11:20:47 +03001246 if (!IsASTDepthBelowLimit(root, mResources.MaxExpressionComplexity))
Jamie Madill6654bc92014-03-26 14:01:57 -04001247 {
Olli Etuaho77ba4082016-12-16 12:01:18 +00001248 mDiagnostics.globalError("Expression too complex.");
Jamie Madill6654bc92014-03-26 14:01:57 -04001249 return false;
1250 }
1251
Olli Etuaho6f591c92018-09-21 11:20:47 +03001252 if (!ValidateMaxParameters(root, mResources.MaxFunctionParameters))
Olli Etuaho19d1dc92016-03-08 17:18:46 +02001253 {
Olli Etuaho77ba4082016-12-16 12:01:18 +00001254 mDiagnostics.globalError("Function has too many parameters.");
Olli Etuaho19d1dc92016-03-08 17:18:46 +02001255 return false;
1256 }
1257
Jamie Madilleb1a0102013-07-08 13:31:38 -04001258 return true;
1259}
1260
Corentin Wallez1df16022016-10-27 08:16:56 -04001261bool TCompiler::shouldCollectVariables(ShCompileOptions compileOptions)
1262{
1263 return (compileOptions & SH_VARIABLES) != 0;
1264}
1265
1266bool TCompiler::wereVariablesCollected() const
1267{
Olli Etuaho6f591c92018-09-21 11:20:47 +03001268 return mVariablesCollected;
Corentin Wallez1df16022016-10-27 08:16:56 -04001269}
1270
Olli Etuaho9cbc07c2017-05-10 18:22:01 +03001271void TCompiler::initializeGLPosition(TIntermBlock *root)
Zhenyao Mo4a667fe2014-02-11 12:35:01 -08001272{
Zhenyao Mo72111912016-07-20 17:45:56 -07001273 InitVariableList list;
Olli Etuahoe7c28572017-10-23 16:29:33 +03001274 sh::ShaderVariable var(GL_FLOAT_VEC4);
Zhenyao Mo72111912016-07-20 17:45:56 -07001275 var.name = "gl_Position";
1276 list.push_back(var);
Olli Etuaho6f591c92018-09-21 11:20:47 +03001277 InitializeVariables(root, list, &mSymbolTable, mShaderVersion, mExtensionBehavior, false,
1278 false);
Zhenyao Mo4a667fe2014-02-11 12:35:01 -08001279}
1280
Olli Etuaho9cbc07c2017-05-10 18:22:01 +03001281void TCompiler::useAllMembersInUnusedStandardAndSharedBlocks(TIntermBlock *root)
Qin Jiajia7835b522016-10-08 11:20:17 +08001282{
1283 sh::InterfaceBlockList list;
1284
Jonah Ryan-Davisd4c09dd2019-01-29 11:22:54 -05001285 for (const sh::InterfaceBlock &block : mUniformBlocks)
Qin Jiajia7835b522016-10-08 11:20:17 +08001286 {
1287 if (!block.staticUse &&
Qin Jiajiaca68d982017-09-18 16:41:56 +08001288 (block.layout == sh::BLOCKLAYOUT_STD140 || block.layout == sh::BLOCKLAYOUT_SHARED))
Qin Jiajia7835b522016-10-08 11:20:17 +08001289 {
1290 list.push_back(block);
1291 }
1292 }
1293
Olli Etuaho6f591c92018-09-21 11:20:47 +03001294 sh::UseInterfaceBlockFields(root, list, mSymbolTable);
Qin Jiajia7835b522016-10-08 11:20:17 +08001295}
1296
Olli Etuaho9cbc07c2017-05-10 18:22:01 +03001297void TCompiler::initializeOutputVariables(TIntermBlock *root)
Zhenyao Mo4a667fe2014-02-11 12:35:01 -08001298{
Zhenyao Mo72111912016-07-20 17:45:56 -07001299 InitVariableList list;
Olli Etuaho6f591c92018-09-21 11:20:47 +03001300 if (mShaderType == GL_VERTEX_SHADER || mShaderType == GL_GEOMETRY_SHADER_EXT)
Zhenyao Mo4a667fe2014-02-11 12:35:01 -08001301 {
Jonah Ryan-Davisd4c09dd2019-01-29 11:22:54 -05001302 for (const sh::Varying &var : mOutputVaryings)
Zhenyao Mo4a667fe2014-02-11 12:35:01 -08001303 {
Zhenyao Mof9312682016-07-22 12:51:31 -07001304 list.push_back(var);
Olli Etuahob12040c2017-06-27 14:20:45 +03001305 if (var.name == "gl_Position")
1306 {
1307 ASSERT(!mGLPositionInitialized);
1308 mGLPositionInitialized = true;
1309 }
Zhenyao Mo4a667fe2014-02-11 12:35:01 -08001310 }
Zhenyao Mo4a667fe2014-02-11 12:35:01 -08001311 }
Zhenyao Mo72111912016-07-20 17:45:56 -07001312 else
1313 {
Olli Etuaho6f591c92018-09-21 11:20:47 +03001314 ASSERT(mShaderType == GL_FRAGMENT_SHADER);
Jonah Ryan-Davisd4c09dd2019-01-29 11:22:54 -05001315 for (const sh::OutputVariable &var : mOutputVariables)
Zhenyao Mo72111912016-07-20 17:45:56 -07001316 {
1317 list.push_back(var);
1318 }
1319 }
Olli Etuaho6f591c92018-09-21 11:20:47 +03001320 InitializeVariables(root, list, &mSymbolTable, mShaderVersion, mExtensionBehavior, false,
1321 false);
Zhenyao Mo4a667fe2014-02-11 12:35:01 -08001322}
1323
Jamie Madilld7b1ab52016-12-12 14:42:19 -05001324const TExtensionBehavior &TCompiler::getExtensionBehavior() const
zmo@google.com5601ea02011-06-10 18:23:25 +00001325{
Olli Etuaho6f591c92018-09-21 11:20:47 +03001326 return mExtensionBehavior;
zmo@google.com5601ea02011-06-10 18:23:25 +00001327}
zmo@google.com32e97312011-08-24 01:03:11 +00001328
Olli Etuahoa3a5cc62015-02-13 13:12:22 +02001329const char *TCompiler::getSourcePath() const
1330{
1331 return mSourcePath;
1332}
1333
Jamie Madilld7b1ab52016-12-12 14:42:19 -05001334const ShBuiltInResources &TCompiler::getResources() const
shannon.woods%transgaming.com@gtempaccount.com18b4c4b2013-04-13 03:31:40 +00001335{
Olli Etuaho6f591c92018-09-21 11:20:47 +03001336 return mResources;
shannon.woods%transgaming.com@gtempaccount.com18b4c4b2013-04-13 03:31:40 +00001337}
1338
Jamie Madilld7b1ab52016-12-12 14:42:19 -05001339const ArrayBoundsClamper &TCompiler::getArrayBoundsClamper() const
daniel@transgaming.com4167cc92013-01-11 04:11:53 +00001340{
Olli Etuaho6f591c92018-09-21 11:20:47 +03001341 return mArrayBoundsClamper;
daniel@transgaming.com4167cc92013-01-11 04:11:53 +00001342}
1343
shannon.woods@transgaming.com1d432bb2013-01-25 21:57:28 +00001344ShArrayIndexClampingStrategy TCompiler::getArrayIndexClampingStrategy() const
1345{
Olli Etuaho6f591c92018-09-21 11:20:47 +03001346 return mResources.ArrayIndexClampingStrategy;
shannon.woods@transgaming.com1d432bb2013-01-25 21:57:28 +00001347}
1348
Jamie Madilld7b1ab52016-12-12 14:42:19 -05001349const BuiltInFunctionEmulator &TCompiler::getBuiltInFunctionEmulator() const
shannon.woods@transgaming.com1d432bb2013-01-25 21:57:28 +00001350{
Olli Etuaho6f591c92018-09-21 11:20:47 +03001351 return mBuiltInFunctionEmulator;
shannon.woods@transgaming.com1d432bb2013-01-25 21:57:28 +00001352}
Zhenyao Mo94ac7b72014-10-15 18:22:08 -07001353
Qiankun Miao7ebb97f2016-09-08 18:01:50 +08001354void TCompiler::writePragma(ShCompileOptions compileOptions)
Zhenyao Mo94ac7b72014-10-15 18:22:08 -07001355{
Kenneth Russellbccc65d2016-07-19 16:48:43 -07001356 if (!(compileOptions & SH_FLATTEN_PRAGMA_STDGL_INVARIANT_ALL))
1357 {
Olli Etuaho6f591c92018-09-21 11:20:47 +03001358 TInfoSinkBase &sink = mInfoSink.obj;
Kenneth Russellbccc65d2016-07-19 16:48:43 -07001359 if (mPragma.stdgl.invariantAll)
1360 sink << "#pragma STDGL invariant(all)\n";
1361 }
1362}
1363
1364bool TCompiler::isVaryingDefined(const char *varyingName)
1365{
Olli Etuaho6f591c92018-09-21 11:20:47 +03001366 ASSERT(mVariablesCollected);
1367 for (size_t ii = 0; ii < mInputVaryings.size(); ++ii)
Kenneth Russellbccc65d2016-07-19 16:48:43 -07001368 {
Olli Etuaho6f591c92018-09-21 11:20:47 +03001369 if (mInputVaryings[ii].name == varyingName)
Jiawei-Shaodf7d7c92017-07-31 09:34:04 +08001370 {
1371 return true;
1372 }
1373 }
Olli Etuaho6f591c92018-09-21 11:20:47 +03001374 for (size_t ii = 0; ii < mOutputVaryings.size(); ++ii)
Jiawei-Shaodf7d7c92017-07-31 09:34:04 +08001375 {
Olli Etuaho6f591c92018-09-21 11:20:47 +03001376 if (mOutputVaryings[ii].name == varyingName)
Kenneth Russellbccc65d2016-07-19 16:48:43 -07001377 {
1378 return true;
1379 }
1380 }
1381
1382 return false;
Zhenyao Mo94ac7b72014-10-15 18:22:08 -07001383}
Jamie Madillacb4b812016-11-07 13:50:29 -05001384
1385} // namespace sh