blob: b757c8d97e8f3f6b4235d5a73cb8dd14f38ed804 [file] [log] [blame]
ethannicholasb3058bd2016-07-01 08:22:01 -07001/*
2 * Copyright 2016 Google Inc.
3 *
4 * Use of this source code is governed by a BSD-style license that can be
5 * found in the LICENSE file.
6 */
Mike Klein6ad99092016-10-26 10:35:22 -04007
Mike Kleinc0bd9f92019-04-23 12:05:21 -05008#include "src/sksl/SkSLCompiler.h"
ethannicholasb3058bd2016-07-01 08:22:01 -07009
John Stilesfbd050b2020-08-03 13:21:46 -040010#include <memory>
John Stilesb8e010c2020-08-11 18:05:39 -040011#include <unordered_set>
John Stilesfbd050b2020-08-03 13:21:46 -040012
John Stilesb92641c2020-08-31 18:09:01 -040013#include "src/sksl/SkSLAnalysis.h"
Mike Kleinc0bd9f92019-04-23 12:05:21 -050014#include "src/sksl/SkSLByteCodeGenerator.h"
15#include "src/sksl/SkSLCFGGenerator.h"
16#include "src/sksl/SkSLCPPCodeGenerator.h"
17#include "src/sksl/SkSLGLSLCodeGenerator.h"
18#include "src/sksl/SkSLHCodeGenerator.h"
19#include "src/sksl/SkSLIRGenerator.h"
20#include "src/sksl/SkSLMetalCodeGenerator.h"
21#include "src/sksl/SkSLPipelineStageCodeGenerator.h"
Ethan Nicholasc18bb512020-07-28 14:46:53 -040022#include "src/sksl/SkSLRehydrator.h"
Mike Kleinc0bd9f92019-04-23 12:05:21 -050023#include "src/sksl/SkSLSPIRVCodeGenerator.h"
Brian Osmanc0243912020-02-19 15:35:26 -050024#include "src/sksl/SkSLSPIRVtoHLSL.h"
Mike Kleinc0bd9f92019-04-23 12:05:21 -050025#include "src/sksl/ir/SkSLEnum.h"
26#include "src/sksl/ir/SkSLExpression.h"
27#include "src/sksl/ir/SkSLExpressionStatement.h"
28#include "src/sksl/ir/SkSLFunctionCall.h"
29#include "src/sksl/ir/SkSLIntLiteral.h"
30#include "src/sksl/ir/SkSLModifiersDeclaration.h"
31#include "src/sksl/ir/SkSLNop.h"
32#include "src/sksl/ir/SkSLSymbolTable.h"
33#include "src/sksl/ir/SkSLTernaryExpression.h"
34#include "src/sksl/ir/SkSLUnresolvedFunction.h"
35#include "src/sksl/ir/SkSLVarDeclarations.h"
ethannicholasb3058bd2016-07-01 08:22:01 -070036
Ethan Nicholasb33fa3f2020-08-06 13:00:19 -040037#include <fstream>
38
Ethan Nicholasa11035b2019-11-26 16:27:47 -050039#if !defined(SKSL_STANDALONE) & SK_SUPPORT_GPU
40#include "include/gpu/GrContextOptions.h"
41#include "src/gpu/GrShaderCaps.h"
42#endif
43
Ethan Nicholasa6ae1f72017-03-16 09:56:54 -040044#ifdef SK_ENABLE_SPIRV_VALIDATION
45#include "spirv-tools/libspirv.hpp"
46#endif
47
Brian Osmandd496172020-08-08 08:17:18 -040048#if !SKSL_STANDALONE
Ethan Nicholasc18bb512020-07-28 14:46:53 -040049
50#include "src/sksl/generated/sksl_fp.dehydrated.sksl"
51#include "src/sksl/generated/sksl_frag.dehydrated.sksl"
52#include "src/sksl/generated/sksl_geom.dehydrated.sksl"
53#include "src/sksl/generated/sksl_gpu.dehydrated.sksl"
54#include "src/sksl/generated/sksl_interp.dehydrated.sksl"
55#include "src/sksl/generated/sksl_pipeline.dehydrated.sksl"
56#include "src/sksl/generated/sksl_vert.dehydrated.sksl"
57
58#else
59
Brian Osmandd496172020-08-08 08:17:18 -040060// GN generates or copies all of these files to the skslc executable directory
61static const char SKSL_GPU_INCLUDE[] = "sksl_gpu.sksl";
62static const char SKSL_INTERP_INCLUDE[] = "sksl_interp.sksl";
63static const char SKSL_VERT_INCLUDE[] = "sksl_vert.sksl";
64static const char SKSL_FRAG_INCLUDE[] = "sksl_frag.sksl";
65static const char SKSL_GEOM_INCLUDE[] = "sksl_geom.sksl";
66static const char SKSL_FP_INCLUDE[] = "sksl_fp.sksl";
67static const char SKSL_PIPELINE_INCLUDE[] = "sksl_pipeline.sksl";
Ethan Nicholasc18bb512020-07-28 14:46:53 -040068
69#endif
Ethan Nicholas0d997662019-04-08 09:46:01 -040070
ethannicholasb3058bd2016-07-01 08:22:01 -070071namespace SkSL {
72
Ethan Nicholasdb80f692019-11-22 14:06:12 -050073static void grab_intrinsics(std::vector<std::unique_ptr<ProgramElement>>* src,
John Stiles810c8cf2020-08-26 19:46:27 -040074 IRIntrinsicMap* target) {
Brian Osman08f986d2020-05-13 17:06:46 -040075 for (auto iter = src->begin(); iter != src->end(); ) {
76 std::unique_ptr<ProgramElement>& element = *iter;
Ethan Nicholase6592142020-09-08 10:22:09 -040077 switch (element->kind()) {
78 case ProgramElement::Kind::kFunction: {
John Stiles3dc0da62020-08-19 17:48:31 -040079 FunctionDefinition& f = element->as<FunctionDefinition>();
Brian Osman08f986d2020-05-13 17:06:46 -040080 SkASSERT(f.fDeclaration.fBuiltin);
Brian Osman2b469eb2020-09-21 11:32:10 -040081 target->insertOrDie(f.fDeclaration.description(), std::move(element));
Brian Osman08f986d2020-05-13 17:06:46 -040082 iter = src->erase(iter);
Ethan Nicholasdb80f692019-11-22 14:06:12 -050083 break;
84 }
Ethan Nicholase6592142020-09-08 10:22:09 -040085 case ProgramElement::Kind::kEnum: {
John Stiles3dc0da62020-08-19 17:48:31 -040086 Enum& e = element->as<Enum>();
Ethan Nicholasd83ded82020-09-29 17:05:54 -040087 target->insertOrDie(e.typeName(), std::move(element));
Brian Osman08f986d2020-05-13 17:06:46 -040088 iter = src->erase(iter);
Ethan Nicholasdb80f692019-11-22 14:06:12 -050089 break;
90 }
91 default:
Brian Osman2b469eb2020-09-21 11:32:10 -040092 // Unsupported element, leave it in the list.
93 ++iter;
94 break;
Ethan Nicholasdb80f692019-11-22 14:06:12 -050095 }
96 }
97}
98
John Stilesbc0c29e2020-09-28 13:13:40 -040099static void reset_call_counts(std::vector<std::unique_ptr<ProgramElement>>* src) {
100 for (std::unique_ptr<ProgramElement>& element : *src) {
101 if (element->is<FunctionDefinition>()) {
102 const FunctionDeclaration& fnDecl = element->as<FunctionDefinition>().fDeclaration;
103 fnDecl.fCallCount = 0;
104 }
105 }
106}
107
Ethan Nicholas6e1cbc02017-07-14 10:12:15 -0400108Compiler::Compiler(Flags flags)
Brian Osman2b469eb2020-09-21 11:32:10 -0400109: fGPUIntrinsics(std::make_unique<IRIntrinsicMap>(/*parent=*/nullptr))
110, fInterpreterIntrinsics(std::make_unique<IRIntrinsicMap>(/*parent=*/nullptr))
John Stiles810c8cf2020-08-26 19:46:27 -0400111, fFlags(flags)
112, fContext(std::make_shared<Context>())
Ethan Nicholas6e1cbc02017-07-14 10:12:15 -0400113, fErrorCount(0) {
Brian Osmaneac49832020-09-18 11:49:22 -0400114 fRootSymbolTable = std::make_shared<SymbolTable>(this);
John Stiles941fc712020-09-19 12:47:10 +0000115 fIRGenerator =
116 std::make_unique<IRGenerator>(fContext.get(), &fInliner, fRootSymbolTable, *this);
Brian Osmaneac49832020-09-18 11:49:22 -0400117 #define ADD_TYPE(t) fRootSymbolTable->addWithoutOwnership(fContext->f ## t ## _Type->fName, \
118 fContext->f ## t ## _Type.get())
ethannicholasb3058bd2016-07-01 08:22:01 -0700119 ADD_TYPE(Void);
120 ADD_TYPE(Float);
Ethan Nicholas5af9ea32017-07-28 15:19:46 -0400121 ADD_TYPE(Float2);
122 ADD_TYPE(Float3);
123 ADD_TYPE(Float4);
Ethan Nicholasdcba08e2017-08-02 10:52:54 -0400124 ADD_TYPE(Half);
125 ADD_TYPE(Half2);
126 ADD_TYPE(Half3);
127 ADD_TYPE(Half4);
ethannicholasb3058bd2016-07-01 08:22:01 -0700128 ADD_TYPE(Int);
Ethan Nicholas5af9ea32017-07-28 15:19:46 -0400129 ADD_TYPE(Int2);
130 ADD_TYPE(Int3);
131 ADD_TYPE(Int4);
ethannicholasb3058bd2016-07-01 08:22:01 -0700132 ADD_TYPE(UInt);
Ethan Nicholas5af9ea32017-07-28 15:19:46 -0400133 ADD_TYPE(UInt2);
134 ADD_TYPE(UInt3);
135 ADD_TYPE(UInt4);
Ethan Nicholasdcba08e2017-08-02 10:52:54 -0400136 ADD_TYPE(Short);
137 ADD_TYPE(Short2);
138 ADD_TYPE(Short3);
139 ADD_TYPE(Short4);
140 ADD_TYPE(UShort);
141 ADD_TYPE(UShort2);
142 ADD_TYPE(UShort3);
143 ADD_TYPE(UShort4);
Ruiqi Maob609e6d2018-07-17 10:19:38 -0400144 ADD_TYPE(Byte);
145 ADD_TYPE(Byte2);
146 ADD_TYPE(Byte3);
147 ADD_TYPE(Byte4);
148 ADD_TYPE(UByte);
149 ADD_TYPE(UByte2);
150 ADD_TYPE(UByte3);
151 ADD_TYPE(UByte4);
ethannicholasb3058bd2016-07-01 08:22:01 -0700152 ADD_TYPE(Bool);
Ethan Nicholas5af9ea32017-07-28 15:19:46 -0400153 ADD_TYPE(Bool2);
154 ADD_TYPE(Bool3);
155 ADD_TYPE(Bool4);
156 ADD_TYPE(Float2x2);
157 ADD_TYPE(Float2x3);
158 ADD_TYPE(Float2x4);
159 ADD_TYPE(Float3x2);
160 ADD_TYPE(Float3x3);
161 ADD_TYPE(Float3x4);
162 ADD_TYPE(Float4x2);
163 ADD_TYPE(Float4x3);
164 ADD_TYPE(Float4x4);
Ethan Nicholasdcba08e2017-08-02 10:52:54 -0400165 ADD_TYPE(Half2x2);
166 ADD_TYPE(Half2x3);
167 ADD_TYPE(Half2x4);
168 ADD_TYPE(Half3x2);
169 ADD_TYPE(Half3x3);
170 ADD_TYPE(Half3x4);
171 ADD_TYPE(Half4x2);
172 ADD_TYPE(Half4x3);
173 ADD_TYPE(Half4x4);
ethannicholasb3058bd2016-07-01 08:22:01 -0700174 ADD_TYPE(GenType);
Ethan Nicholasdcba08e2017-08-02 10:52:54 -0400175 ADD_TYPE(GenHType);
ethannicholasb3058bd2016-07-01 08:22:01 -0700176 ADD_TYPE(GenIType);
177 ADD_TYPE(GenUType);
178 ADD_TYPE(GenBType);
179 ADD_TYPE(Mat);
180 ADD_TYPE(Vec);
181 ADD_TYPE(GVec);
182 ADD_TYPE(GVec2);
183 ADD_TYPE(GVec3);
184 ADD_TYPE(GVec4);
Ethan Nicholasdcba08e2017-08-02 10:52:54 -0400185 ADD_TYPE(HVec);
ethannicholasb3058bd2016-07-01 08:22:01 -0700186 ADD_TYPE(IVec);
187 ADD_TYPE(UVec);
Ethan Nicholasdcba08e2017-08-02 10:52:54 -0400188 ADD_TYPE(SVec);
189 ADD_TYPE(USVec);
Ruiqi Maob609e6d2018-07-17 10:19:38 -0400190 ADD_TYPE(ByteVec);
191 ADD_TYPE(UByteVec);
ethannicholasb3058bd2016-07-01 08:22:01 -0700192 ADD_TYPE(BVec);
193
194 ADD_TYPE(Sampler1D);
195 ADD_TYPE(Sampler2D);
196 ADD_TYPE(Sampler3D);
ethannicholas5961bc92016-10-12 06:39:56 -0700197 ADD_TYPE(SamplerExternalOES);
ethannicholasb3058bd2016-07-01 08:22:01 -0700198 ADD_TYPE(SamplerCube);
199 ADD_TYPE(Sampler2DRect);
200 ADD_TYPE(Sampler1DArray);
201 ADD_TYPE(Sampler2DArray);
202 ADD_TYPE(SamplerCubeArray);
203 ADD_TYPE(SamplerBuffer);
204 ADD_TYPE(Sampler2DMS);
205 ADD_TYPE(Sampler2DMSArray);
206
Brian Salomonbf7b6202016-11-11 16:08:03 -0500207 ADD_TYPE(ISampler2D);
208
Brian Salomon2a51de82016-11-16 12:06:01 -0500209 ADD_TYPE(Image2D);
210 ADD_TYPE(IImage2D);
211
Greg Daniel64773e62016-11-22 09:44:03 -0500212 ADD_TYPE(SubpassInput);
213 ADD_TYPE(SubpassInputMS);
214
ethannicholasb3058bd2016-07-01 08:22:01 -0700215 ADD_TYPE(GSampler1D);
216 ADD_TYPE(GSampler2D);
217 ADD_TYPE(GSampler3D);
218 ADD_TYPE(GSamplerCube);
219 ADD_TYPE(GSampler2DRect);
220 ADD_TYPE(GSampler1DArray);
221 ADD_TYPE(GSampler2DArray);
222 ADD_TYPE(GSamplerCubeArray);
223 ADD_TYPE(GSamplerBuffer);
224 ADD_TYPE(GSampler2DMS);
225 ADD_TYPE(GSampler2DMSArray);
226
227 ADD_TYPE(Sampler1DShadow);
228 ADD_TYPE(Sampler2DShadow);
229 ADD_TYPE(SamplerCubeShadow);
230 ADD_TYPE(Sampler2DRectShadow);
231 ADD_TYPE(Sampler1DArrayShadow);
232 ADD_TYPE(Sampler2DArrayShadow);
233 ADD_TYPE(SamplerCubeArrayShadow);
234 ADD_TYPE(GSampler2DArrayShadow);
235 ADD_TYPE(GSamplerCubeArrayShadow);
Ethan Nicholasc9472af2017-10-10 16:30:21 -0400236 ADD_TYPE(FragmentProcessor);
Stephen Whiteff5d7a22019-07-26 17:42:06 -0400237 ADD_TYPE(Sampler);
238 ADD_TYPE(Texture2D);
ethannicholasb3058bd2016-07-01 08:22:01 -0700239
Brian Osman28590d52020-03-23 16:59:08 -0400240 StringFragment fpAliasName("shader");
Brian Osmaneac49832020-09-18 11:49:22 -0400241 fRootSymbolTable->addWithoutOwnership(fpAliasName, fContext->fFragmentProcessor_Type.get());
Brian Osman28590d52020-03-23 16:59:08 -0400242
Brian Osman3887a012020-09-30 13:22:27 -0400243 // sk_Caps is "builtin", but all references to it are resolved to Settings, so we don't need to
244 // treat it as builtin (ie, no need to clone it into the Program).
Ethan Nicholas5b5f0962017-09-11 13:50:14 -0700245 StringFragment skCapsName("sk_Caps");
Brian Osman3887a012020-09-30 13:22:27 -0400246 fRootSymbolTable->add(skCapsName,
247 std::make_unique<Variable>(/*offset=*/-1, Modifiers(), skCapsName,
248 fContext->fSkCaps_Type.get(),
249 /*builtin=*/false, Variable::kGlobal_Storage));
Ethan Nicholas3605ace2016-11-21 15:59:48 -0500250
John Stiles810c8cf2020-08-26 19:46:27 -0400251 fIRGenerator->fIntrinsics = fGPUIntrinsics.get();
Ethan Nicholasdb80f692019-11-22 14:06:12 -0500252 std::vector<std::unique_ptr<ProgramElement>> gpuIntrinsics;
Brian Osmandd496172020-08-08 08:17:18 -0400253#if SKSL_STANDALONE
Brian Osmaneac49832020-09-18 11:49:22 -0400254 this->processIncludeFile(Program::kFragment_Kind, SKSL_GPU_INCLUDE, fRootSymbolTable,
255 &gpuIntrinsics, &fGpuSymbolTable);
Ethan Nicholasb33fa3f2020-08-06 13:00:19 -0400256 this->processIncludeFile(Program::kVertex_Kind, SKSL_VERT_INCLUDE, fGpuSymbolTable,
257 &fVertexInclude, &fVertexSymbolTable);
258 this->processIncludeFile(Program::kFragment_Kind, SKSL_FRAG_INCLUDE, fGpuSymbolTable,
259 &fFragmentInclude, &fFragmentSymbolTable);
Ethan Nicholasc18bb512020-07-28 14:46:53 -0400260#else
261 {
Brian Osmaneac49832020-09-18 11:49:22 -0400262 Rehydrator rehydrator(fContext.get(), fRootSymbolTable, this, SKSL_INCLUDE_sksl_gpu,
263 SKSL_INCLUDE_sksl_gpu_LENGTH);
Ethan Nicholasc18bb512020-07-28 14:46:53 -0400264 fGpuSymbolTable = rehydrator.symbolTable();
265 gpuIntrinsics = rehydrator.elements();
266 }
267 {
268 Rehydrator rehydrator(fContext.get(), fGpuSymbolTable, this, SKSL_INCLUDE_sksl_vert,
Brian Osmaneac49832020-09-18 11:49:22 -0400269 SKSL_INCLUDE_sksl_vert_LENGTH);
Ethan Nicholasc18bb512020-07-28 14:46:53 -0400270 fVertexSymbolTable = rehydrator.symbolTable();
271 fVertexInclude = rehydrator.elements();
272 }
273 {
274 Rehydrator rehydrator(fContext.get(), fGpuSymbolTable, this, SKSL_INCLUDE_sksl_frag,
Brian Osmaneac49832020-09-18 11:49:22 -0400275 SKSL_INCLUDE_sksl_frag_LENGTH);
Ethan Nicholasc18bb512020-07-28 14:46:53 -0400276 fFragmentSymbolTable = rehydrator.symbolTable();
277 fFragmentInclude = rehydrator.elements();
278 }
279#endif
John Stilesbc0c29e2020-09-28 13:13:40 -0400280 // Call counts are used to track dead-stripping and inlinability within the program being
281 // currently compiled, and always should start at zero for a new program. Zero out any call
282 // counts that were registered during the assembly of the intrinsics/include data. (If we
283 // actually use calls from inside the intrinsics, we will clone them into the program and they
284 // will get new call counts.)
285 reset_call_counts(&gpuIntrinsics);
286 reset_call_counts(&fVertexInclude);
287 reset_call_counts(&fFragmentInclude);
288
John Stiles810c8cf2020-08-26 19:46:27 -0400289 grab_intrinsics(&gpuIntrinsics, fGPUIntrinsics.get());
Brian Osman2b469eb2020-09-21 11:32:10 -0400290 SkASSERT(gpuIntrinsics.empty());
ethannicholasb3058bd2016-07-01 08:22:01 -0700291}
292
John Stiles656427a2020-08-27 15:26:26 -0400293Compiler::~Compiler() {}
ethannicholasb3058bd2016-07-01 08:22:01 -0700294
Ethan Nicholasc18bb512020-07-28 14:46:53 -0400295void Compiler::loadGeometryIntrinsics() {
296 if (fGeometrySymbolTable) {
297 return;
298 }
Brian Osmandd496172020-08-08 08:17:18 -0400299 #if !SKSL_STANDALONE
Ethan Nicholasc18bb512020-07-28 14:46:53 -0400300 {
301 Rehydrator rehydrator(fContext.get(), fGpuSymbolTable, this, SKSL_INCLUDE_sksl_geom,
302 SKSL_INCLUDE_sksl_geom_LENGTH);
303 fGeometrySymbolTable = rehydrator.symbolTable();
304 fGeometryInclude = rehydrator.elements();
305 }
306 #else
Ethan Nicholasb33fa3f2020-08-06 13:00:19 -0400307 this->processIncludeFile(Program::kGeometry_Kind, SKSL_GEOM_INCLUDE, fGpuSymbolTable,
308 &fGeometryInclude, &fGeometrySymbolTable);
Ethan Nicholasc18bb512020-07-28 14:46:53 -0400309 #endif
310}
311
312void Compiler::loadPipelineIntrinsics() {
313 if (fPipelineSymbolTable) {
314 return;
315 }
Brian Osmandd496172020-08-08 08:17:18 -0400316 #if !SKSL_STANDALONE
Ethan Nicholasc18bb512020-07-28 14:46:53 -0400317 {
318 Rehydrator rehydrator(fContext.get(), fGpuSymbolTable, this,
319 SKSL_INCLUDE_sksl_pipeline,
320 SKSL_INCLUDE_sksl_pipeline_LENGTH);
321 fPipelineSymbolTable = rehydrator.symbolTable();
322 fPipelineInclude = rehydrator.elements();
323 }
324 #else
325 this->processIncludeFile(Program::kPipelineStage_Kind, SKSL_PIPELINE_INCLUDE,
Ethan Nicholasb33fa3f2020-08-06 13:00:19 -0400326 fGpuSymbolTable, &fPipelineInclude, &fPipelineSymbolTable);
Ethan Nicholasc18bb512020-07-28 14:46:53 -0400327 #endif
328}
329
330void Compiler::loadInterpreterIntrinsics() {
331 if (fInterpreterSymbolTable) {
332 return;
333 }
Brian Osmaneac49832020-09-18 11:49:22 -0400334 std::vector<std::unique_ptr<ProgramElement>> interpIntrinsics;
Brian Osmandd496172020-08-08 08:17:18 -0400335 #if !SKSL_STANDALONE
Ethan Nicholasc18bb512020-07-28 14:46:53 -0400336 {
Brian Osmaneac49832020-09-18 11:49:22 -0400337 Rehydrator rehydrator(fContext.get(), fRootSymbolTable, this,
Ethan Nicholasc18bb512020-07-28 14:46:53 -0400338 SKSL_INCLUDE_sksl_interp,
339 SKSL_INCLUDE_sksl_interp_LENGTH);
340 fInterpreterSymbolTable = rehydrator.symbolTable();
Brian Osmaneac49832020-09-18 11:49:22 -0400341 interpIntrinsics = rehydrator.elements();
Ethan Nicholasc18bb512020-07-28 14:46:53 -0400342 }
343 #else
344 this->processIncludeFile(Program::kGeneric_Kind, SKSL_INTERP_INCLUDE,
Brian Osmaneac49832020-09-18 11:49:22 -0400345 fIRGenerator->fSymbolTable, &interpIntrinsics,
Ethan Nicholasb33fa3f2020-08-06 13:00:19 -0400346 &fInterpreterSymbolTable);
Ethan Nicholasc18bb512020-07-28 14:46:53 -0400347 #endif
Brian Osmaneac49832020-09-18 11:49:22 -0400348 grab_intrinsics(&interpIntrinsics, fInterpreterIntrinsics.get());
Brian Osman2b469eb2020-09-21 11:32:10 -0400349 SkASSERT(interpIntrinsics.empty());
Ethan Nicholasc18bb512020-07-28 14:46:53 -0400350}
351
Ethan Nicholasb33fa3f2020-08-06 13:00:19 -0400352void Compiler::processIncludeFile(Program::Kind kind, const char* path,
Ethan Nicholas8da1e652019-05-24 11:01:59 -0400353 std::shared_ptr<SymbolTable> base,
354 std::vector<std::unique_ptr<ProgramElement>>* outElements,
355 std::shared_ptr<SymbolTable>* outSymbolTable) {
Ethan Nicholasb33fa3f2020-08-06 13:00:19 -0400356 std::ifstream in(path);
Brian Osmane498b3c2020-09-23 14:42:11 -0400357 std::unique_ptr<String> text = std::make_unique<String>(std::istreambuf_iterator<char>(in),
358 std::istreambuf_iterator<char>());
Ethan Nicholasb33fa3f2020-08-06 13:00:19 -0400359 if (in.rdstate()) {
360 printf("error reading %s\n", path);
361 abort();
362 }
Brian Osmane498b3c2020-09-23 14:42:11 -0400363 const String* source = fRootSymbolTable->takeOwnershipOfString(std::move(text));
Ethan Nicholasb33fa3f2020-08-06 13:00:19 -0400364 fSource = source;
Ethan Nicholas8da1e652019-05-24 11:01:59 -0400365 Program::Settings settings;
Ethan Nicholasa11035b2019-11-26 16:27:47 -0500366#if !defined(SKSL_STANDALONE) & SK_SUPPORT_GPU
367 GrContextOptions opts;
368 GrShaderCaps caps(opts);
369 settings.fCaps = &caps;
370#endif
John Stiles881a10c2020-09-19 10:13:24 -0400371 SkASSERT(fIRGenerator->fCanInline);
372 fIRGenerator->fCanInline = false;
Brian Osmane498b3c2020-09-23 14:42:11 -0400373 fIRGenerator->start(&settings, base ? base : fRootSymbolTable, nullptr, true);
Ethan Nicholasb33fa3f2020-08-06 13:00:19 -0400374 fIRGenerator->convertProgram(kind, source->c_str(), source->length(), outElements);
John Stiles881a10c2020-09-19 10:13:24 -0400375 fIRGenerator->fCanInline = true;
Ethan Nicholas8da1e652019-05-24 11:01:59 -0400376 if (this->fErrorCount) {
377 printf("Unexpected errors: %s\n", this->fErrorText.c_str());
378 }
379 SkASSERT(!fErrorCount);
Ethan Nicholas8da1e652019-05-24 11:01:59 -0400380 *outSymbolTable = fIRGenerator->fSymbolTable;
Ethan Nicholasa11035b2019-11-26 16:27:47 -0500381#ifdef SK_DEBUG
382 fSource = nullptr;
383#endif
Brian Osmane498b3c2020-09-23 14:42:11 -0400384 fIRGenerator->finish();
Ethan Nicholas8da1e652019-05-24 11:01:59 -0400385}
386
ethannicholas22f939e2016-10-13 13:25:34 -0700387// add the definition created by assigning to the lvalue to the definition set
Ethan Nicholas86a43402017-01-19 13:32:00 -0500388void Compiler::addDefinition(const Expression* lvalue, std::unique_ptr<Expression>* expr,
389 DefinitionMap* definitions) {
Ethan Nicholase6592142020-09-08 10:22:09 -0400390 switch (lvalue->kind()) {
391 case Expression::Kind::kVariableReference: {
Brian Osman79457ef2020-09-24 15:01:27 -0400392 const Variable& var = *lvalue->as<VariableReference>().fVariable;
ethannicholas22f939e2016-10-13 13:25:34 -0700393 if (var.fStorage == Variable::kLocal_Storage) {
394 (*definitions)[&var] = expr;
395 }
396 break;
397 }
Ethan Nicholase6592142020-09-08 10:22:09 -0400398 case Expression::Kind::kSwizzle:
ethannicholas22f939e2016-10-13 13:25:34 -0700399 // We consider the variable written to as long as at least some of its components have
400 // been written to. This will lead to some false negatives (we won't catch it if you
401 // write to foo.x and then read foo.y), but being stricter could lead to false positives
Mike Klein6ad99092016-10-26 10:35:22 -0400402 // (we write to foo.x, and then pass foo to a function which happens to only read foo.x,
403 // but since we pass foo as a whole it is flagged as an error) unless we perform a much
ethannicholas22f939e2016-10-13 13:25:34 -0700404 // more complicated whole-program analysis. This is probably good enough.
John Stilesa5a97b42020-08-18 11:19:07 -0400405 this->addDefinition(lvalue->as<Swizzle>().fBase.get(),
Ethan Nicholas26a9aad2018-03-27 14:10:52 -0400406 (std::unique_ptr<Expression>*) &fContext->fDefined_Expression,
ethannicholas22f939e2016-10-13 13:25:34 -0700407 definitions);
408 break;
Ethan Nicholase6592142020-09-08 10:22:09 -0400409 case Expression::Kind::kIndex:
ethannicholas22f939e2016-10-13 13:25:34 -0700410 // see comments in Swizzle
John Stilesa5a97b42020-08-18 11:19:07 -0400411 this->addDefinition(lvalue->as<IndexExpression>().fBase.get(),
Ethan Nicholas26a9aad2018-03-27 14:10:52 -0400412 (std::unique_ptr<Expression>*) &fContext->fDefined_Expression,
ethannicholas22f939e2016-10-13 13:25:34 -0700413 definitions);
414 break;
Ethan Nicholase6592142020-09-08 10:22:09 -0400415 case Expression::Kind::kFieldAccess:
ethannicholas22f939e2016-10-13 13:25:34 -0700416 // see comments in Swizzle
John Stilesa5a97b42020-08-18 11:19:07 -0400417 this->addDefinition(lvalue->as<FieldAccess>().fBase.get(),
Ethan Nicholas26a9aad2018-03-27 14:10:52 -0400418 (std::unique_ptr<Expression>*) &fContext->fDefined_Expression,
ethannicholas22f939e2016-10-13 13:25:34 -0700419 definitions);
420 break;
Ethan Nicholase6592142020-09-08 10:22:09 -0400421 case Expression::Kind::kTernary:
Ethan Nicholasa583b812018-01-18 13:32:11 -0500422 // To simplify analysis, we just pretend that we write to both sides of the ternary.
423 // This allows for false positives (meaning we fail to detect that a variable might not
424 // have been assigned), but is preferable to false negatives.
John Stilesa5a97b42020-08-18 11:19:07 -0400425 this->addDefinition(lvalue->as<TernaryExpression>().fIfTrue.get(),
Ethan Nicholas26a9aad2018-03-27 14:10:52 -0400426 (std::unique_ptr<Expression>*) &fContext->fDefined_Expression,
Ethan Nicholasa583b812018-01-18 13:32:11 -0500427 definitions);
John Stilesa5a97b42020-08-18 11:19:07 -0400428 this->addDefinition(lvalue->as<TernaryExpression>().fIfFalse.get(),
Ethan Nicholas26a9aad2018-03-27 14:10:52 -0400429 (std::unique_ptr<Expression>*) &fContext->fDefined_Expression,
Ethan Nicholasa583b812018-01-18 13:32:11 -0500430 definitions);
431 break;
Ethan Nicholase6592142020-09-08 10:22:09 -0400432 case Expression::Kind::kExternalValue:
Ethan Nicholas91164d12019-05-15 15:29:54 -0400433 break;
ethannicholas22f939e2016-10-13 13:25:34 -0700434 default:
435 // not an lvalue, can't happen
Ethan Nicholasd9d33c32018-06-12 11:05:59 -0400436 SkASSERT(false);
ethannicholas22f939e2016-10-13 13:25:34 -0700437 }
438}
439
440// add local variables defined by this node to the set
Mike Klein6ad99092016-10-26 10:35:22 -0400441void Compiler::addDefinitions(const BasicBlock::Node& node,
Ethan Nicholas86a43402017-01-19 13:32:00 -0500442 DefinitionMap* definitions) {
John Stiles70025e52020-09-28 16:08:58 -0400443 if (node.isExpression()) {
444 Expression* expr = node.expression()->get();
445 switch (expr->kind()) {
446 case Expression::Kind::kBinary: {
447 BinaryExpression* b = &expr->as<BinaryExpression>();
448 if (b->getOperator() == Token::Kind::TK_EQ) {
449 this->addDefinition(&b->left(), &b->rightPointer(), definitions);
450 } else if (Compiler::IsAssignment(b->getOperator())) {
451 this->addDefinition(
452 &b->left(),
453 (std::unique_ptr<Expression>*) &fContext->fDefined_Expression,
454 definitions);
Ethan Nicholas86a43402017-01-19 13:32:00 -0500455
ethannicholas22f939e2016-10-13 13:25:34 -0700456 }
John Stiles70025e52020-09-28 16:08:58 -0400457 break;
ethannicholas22f939e2016-10-13 13:25:34 -0700458 }
John Stiles70025e52020-09-28 16:08:58 -0400459 case Expression::Kind::kFunctionCall: {
460 const FunctionCall& c = expr->as<FunctionCall>();
461 for (size_t i = 0; i < c.fFunction.fParameters.size(); ++i) {
462 if (c.fFunction.fParameters[i]->fModifiers.fFlags & Modifiers::kOut_Flag) {
463 this->addDefinition(
464 c.fArguments[i].get(),
465 (std::unique_ptr<Expression>*) &fContext->fDefined_Expression,
466 definitions);
467 }
468 }
469 break;
470 }
471 case Expression::Kind::kPrefix: {
472 const PrefixExpression* p = &expr->as<PrefixExpression>();
473 if (p->fOperator == Token::Kind::TK_MINUSMINUS ||
474 p->fOperator == Token::Kind::TK_PLUSPLUS) {
475 this->addDefinition(
476 p->fOperand.get(),
477 (std::unique_ptr<Expression>*) &fContext->fDefined_Expression,
478 definitions);
479 }
480 break;
481 }
482 case Expression::Kind::kPostfix: {
483 const PostfixExpression* p = &expr->as<PostfixExpression>();
484 if (p->fOperator == Token::Kind::TK_MINUSMINUS ||
485 p->fOperator == Token::Kind::TK_PLUSPLUS) {
486 this->addDefinition(
487 p->fOperand.get(),
488 (std::unique_ptr<Expression>*) &fContext->fDefined_Expression,
489 definitions);
490 }
491 break;
492 }
493 case Expression::Kind::kVariableReference: {
494 const VariableReference* v = &expr->as<VariableReference>();
495 if (v->fRefKind != VariableReference::kRead_RefKind) {
496 this->addDefinition(
497 v,
498 (std::unique_ptr<Expression>*) &fContext->fDefined_Expression,
499 definitions);
500 }
501 break;
502 }
503 default:
504 break;
ethannicholas22f939e2016-10-13 13:25:34 -0700505 }
John Stiles70025e52020-09-28 16:08:58 -0400506 } else if (node.isStatement()) {
507 Statement* stmt = node.statement()->get();
508 if (stmt->is<VarDeclaration>()) {
509 VarDeclaration& vd = stmt->as<VarDeclaration>();
510 if (vd.fValue) {
511 (*definitions)[vd.fVar] = &vd.fValue;
ethannicholas22f939e2016-10-13 13:25:34 -0700512 }
ethannicholas22f939e2016-10-13 13:25:34 -0700513 }
514 }
515}
516
517void Compiler::scanCFG(CFG* cfg, BlockId blockId, std::set<BlockId>* workList) {
518 BasicBlock& block = cfg->fBlocks[blockId];
519
520 // compute definitions after this block
Ethan Nicholas86a43402017-01-19 13:32:00 -0500521 DefinitionMap after = block.fBefore;
ethannicholas22f939e2016-10-13 13:25:34 -0700522 for (const BasicBlock::Node& n : block.fNodes) {
523 this->addDefinitions(n, &after);
524 }
525
526 // propagate definitions to exits
527 for (BlockId exitId : block.fExits) {
Ethan Nicholas26a9aad2018-03-27 14:10:52 -0400528 if (exitId == blockId) {
529 continue;
530 }
ethannicholas22f939e2016-10-13 13:25:34 -0700531 BasicBlock& exit = cfg->fBlocks[exitId];
532 for (const auto& pair : after) {
Ethan Nicholas86a43402017-01-19 13:32:00 -0500533 std::unique_ptr<Expression>* e1 = pair.second;
534 auto found = exit.fBefore.find(pair.first);
535 if (found == exit.fBefore.end()) {
536 // exit has no definition for it, just copy it
537 workList->insert(exitId);
ethannicholas22f939e2016-10-13 13:25:34 -0700538 exit.fBefore[pair.first] = e1;
539 } else {
Ethan Nicholas86a43402017-01-19 13:32:00 -0500540 // exit has a (possibly different) value already defined
541 std::unique_ptr<Expression>* e2 = exit.fBefore[pair.first];
ethannicholas22f939e2016-10-13 13:25:34 -0700542 if (e1 != e2) {
543 // definition has changed, merge and add exit block to worklist
544 workList->insert(exitId);
Ethan Nicholasaf197692017-02-27 13:26:45 -0500545 if (e1 && e2) {
546 exit.fBefore[pair.first] =
Ethan Nicholas26a9aad2018-03-27 14:10:52 -0400547 (std::unique_ptr<Expression>*) &fContext->fDefined_Expression;
Ethan Nicholasaf197692017-02-27 13:26:45 -0500548 } else {
549 exit.fBefore[pair.first] = nullptr;
550 }
ethannicholas22f939e2016-10-13 13:25:34 -0700551 }
552 }
553 }
554 }
555}
556
557// returns a map which maps all local variables in the function to null, indicating that their value
558// is initially unknown
Ethan Nicholas86a43402017-01-19 13:32:00 -0500559static DefinitionMap compute_start_state(const CFG& cfg) {
560 DefinitionMap result;
Mike Klein6ad99092016-10-26 10:35:22 -0400561 for (const auto& block : cfg.fBlocks) {
562 for (const auto& node : block.fNodes) {
John Stiles70025e52020-09-28 16:08:58 -0400563 if (node.isStatement()) {
Ethan Nicholascb670962017-04-20 19:31:52 -0400564 const Statement* s = node.statement()->get();
Brian Osman79457ef2020-09-24 15:01:27 -0400565 if (s->is<VarDeclarationsStatement>()) {
John Stilesa5a97b42020-08-18 11:19:07 -0400566 const VarDeclarationsStatement* vd = &s->as<VarDeclarationsStatement>();
Ethan Nicholas82a62d22017-11-07 14:42:10 +0000567 for (const auto& decl : vd->fDeclaration->fVars) {
Ethan Nicholase6592142020-09-08 10:22:09 -0400568 if (decl->kind() == Statement::Kind::kVarDeclaration) {
John Stilesa5a97b42020-08-18 11:19:07 -0400569 result[decl->as<VarDeclaration>().fVar] = nullptr;
Ethan Nicholas82a62d22017-11-07 14:42:10 +0000570 }
Mike Klein6ad99092016-10-26 10:35:22 -0400571 }
ethannicholas22f939e2016-10-13 13:25:34 -0700572 }
573 }
574 }
575 }
576 return result;
577}
578
Ethan Nicholascb670962017-04-20 19:31:52 -0400579/**
580 * Returns true if assigning to this lvalue has no effect.
581 */
582static bool is_dead(const Expression& lvalue) {
Ethan Nicholase6592142020-09-08 10:22:09 -0400583 switch (lvalue.kind()) {
584 case Expression::Kind::kVariableReference:
Brian Osman79457ef2020-09-24 15:01:27 -0400585 return lvalue.as<VariableReference>().fVariable->dead();
Ethan Nicholase6592142020-09-08 10:22:09 -0400586 case Expression::Kind::kSwizzle:
John Stilesa5a97b42020-08-18 11:19:07 -0400587 return is_dead(*lvalue.as<Swizzle>().fBase);
Ethan Nicholase6592142020-09-08 10:22:09 -0400588 case Expression::Kind::kFieldAccess:
John Stilesa5a97b42020-08-18 11:19:07 -0400589 return is_dead(*lvalue.as<FieldAccess>().fBase);
Ethan Nicholase6592142020-09-08 10:22:09 -0400590 case Expression::Kind::kIndex: {
John Stilesa5a97b42020-08-18 11:19:07 -0400591 const IndexExpression& idx = lvalue.as<IndexExpression>();
Ethan Nicholas2a099da2020-01-02 14:40:54 -0500592 return is_dead(*idx.fBase) &&
593 !idx.fIndex->hasProperty(Expression::Property::kSideEffects);
Ethan Nicholascb670962017-04-20 19:31:52 -0400594 }
Ethan Nicholase6592142020-09-08 10:22:09 -0400595 case Expression::Kind::kTernary: {
John Stilesa5a97b42020-08-18 11:19:07 -0400596 const TernaryExpression& t = lvalue.as<TernaryExpression>();
Ethan Nicholasa583b812018-01-18 13:32:11 -0500597 return !t.fTest->hasSideEffects() && is_dead(*t.fIfTrue) && is_dead(*t.fIfFalse);
598 }
Ethan Nicholase6592142020-09-08 10:22:09 -0400599 case Expression::Kind::kExternalValue:
Ethan Nicholas91164d12019-05-15 15:29:54 -0400600 return false;
Ethan Nicholascb670962017-04-20 19:31:52 -0400601 default:
Ethan Nicholas2a099da2020-01-02 14:40:54 -0500602#ifdef SK_DEBUG
Ethan Nicholascb670962017-04-20 19:31:52 -0400603 ABORT("invalid lvalue: %s\n", lvalue.description().c_str());
Ethan Nicholas2a099da2020-01-02 14:40:54 -0500604#endif
605 return false;
Ethan Nicholascb670962017-04-20 19:31:52 -0400606 }
607}
ethannicholas22f939e2016-10-13 13:25:34 -0700608
Ethan Nicholascb670962017-04-20 19:31:52 -0400609/**
610 * Returns true if this is an assignment which can be collapsed down to just the right hand side due
611 * to a dead target and lack of side effects on the left hand side.
612 */
613static bool dead_assignment(const BinaryExpression& b) {
Ethan Nicholasc8d9c8e2020-09-22 15:05:37 -0400614 if (!Compiler::IsAssignment(b.getOperator())) {
Ethan Nicholascb670962017-04-20 19:31:52 -0400615 return false;
616 }
Ethan Nicholasc8d9c8e2020-09-22 15:05:37 -0400617 return is_dead(b.left());
Ethan Nicholascb670962017-04-20 19:31:52 -0400618}
619
620void Compiler::computeDataFlow(CFG* cfg) {
621 cfg->fBlocks[cfg->fStart].fBefore = compute_start_state(*cfg);
ethannicholas22f939e2016-10-13 13:25:34 -0700622 std::set<BlockId> workList;
Ethan Nicholascb670962017-04-20 19:31:52 -0400623 for (BlockId i = 0; i < cfg->fBlocks.size(); i++) {
ethannicholas22f939e2016-10-13 13:25:34 -0700624 workList.insert(i);
625 }
626 while (workList.size()) {
627 BlockId next = *workList.begin();
628 workList.erase(workList.begin());
Ethan Nicholascb670962017-04-20 19:31:52 -0400629 this->scanCFG(cfg, next, &workList);
ethannicholas22f939e2016-10-13 13:25:34 -0700630 }
Ethan Nicholascb670962017-04-20 19:31:52 -0400631}
632
633/**
634 * Attempts to replace the expression pointed to by iter with a new one (in both the CFG and the
635 * IR). If the expression can be cleanly removed, returns true and updates the iterator to point to
636 * the newly-inserted element. Otherwise updates only the IR and returns false (and the CFG will
637 * need to be regenerated).
638 */
John Stilesafbf8992020-08-18 10:08:21 -0400639static bool try_replace_expression(BasicBlock* b,
640 std::vector<BasicBlock::Node>::iterator* iter,
641 std::unique_ptr<Expression>* newExpression) {
Ethan Nicholascb670962017-04-20 19:31:52 -0400642 std::unique_ptr<Expression>* target = (*iter)->expression();
643 if (!b->tryRemoveExpression(iter)) {
644 *target = std::move(*newExpression);
645 return false;
646 }
647 *target = std::move(*newExpression);
648 return b->tryInsertExpression(iter, target);
649}
650
651/**
Ethan Nicholasfe53e582017-04-27 16:24:51 -0400652 * Returns true if the expression is a constant numeric literal with the specified value, or a
653 * constant vector with all elements equal to the specified value.
Ethan Nicholascb670962017-04-20 19:31:52 -0400654 */
Ethan Nicholas135e2372020-09-29 10:21:29 -0400655template <typename T = SKSL_FLOAT>
John Stiles9d944232020-08-19 09:56:49 -0400656static bool is_constant(const Expression& expr, T value) {
Ethan Nicholase6592142020-09-08 10:22:09 -0400657 switch (expr.kind()) {
658 case Expression::Kind::kIntLiteral:
Ethan Nicholase96cdd12020-09-28 16:27:18 -0400659 return expr.as<IntLiteral>().value() == value;
John Stiles9d944232020-08-19 09:56:49 -0400660
Ethan Nicholase6592142020-09-08 10:22:09 -0400661 case Expression::Kind::kFloatLiteral:
Ethan Nicholas135e2372020-09-29 10:21:29 -0400662 return expr.as<FloatLiteral>().value() == value;
John Stiles9d944232020-08-19 09:56:49 -0400663
Ethan Nicholase6592142020-09-08 10:22:09 -0400664 case Expression::Kind::kConstructor: {
John Stiles9d944232020-08-19 09:56:49 -0400665 const Constructor& constructor = expr.as<Constructor>();
666 if (constructor.isCompileTimeConstant()) {
Ethan Nicholas30d30222020-09-11 12:27:26 -0400667 const Type& constructorType = constructor.type();
668 bool isFloat = constructorType.columns() > 1
669 ? constructorType.componentType().isFloat()
670 : constructorType.isFloat();
671 switch (constructorType.typeKind()) {
Ethan Nicholase6592142020-09-08 10:22:09 -0400672 case Type::TypeKind::kVector:
Ethan Nicholas30d30222020-09-11 12:27:26 -0400673 for (int i = 0; i < constructorType.columns(); ++i) {
John Stiles9d944232020-08-19 09:56:49 -0400674 if (isFloat) {
675 if (constructor.getFVecComponent(i) != value) {
676 return false;
677 }
678 } else {
679 if (constructor.getIVecComponent(i) != value) {
680 return false;
681 }
682 }
Ethan Nicholasd188c182019-06-10 15:55:38 -0400683 }
John Stiles9d944232020-08-19 09:56:49 -0400684 return true;
685
Ethan Nicholase6592142020-09-08 10:22:09 -0400686 case Type::TypeKind::kScalar:
Ethan Nicholasf70f0442020-09-29 12:41:35 -0400687 SkASSERT(constructor.arguments().size() == 1);
688 return is_constant<T>(*constructor.arguments()[0], value);
John Stiles9d944232020-08-19 09:56:49 -0400689
690 default:
Ethan Nicholasfe53e582017-04-27 16:24:51 -0400691 return false;
Ethan Nicholasfe53e582017-04-27 16:24:51 -0400692 }
Ethan Nicholasfe53e582017-04-27 16:24:51 -0400693 }
694 return false;
695 }
Ethan Nicholascb670962017-04-20 19:31:52 -0400696 default:
697 return false;
698 }
699}
700
701/**
702 * Collapses the binary expression pointed to by iter down to just the right side (in both the IR
703 * and CFG structures).
704 */
John Stilesafbf8992020-08-18 10:08:21 -0400705static void delete_left(BasicBlock* b,
706 std::vector<BasicBlock::Node>::iterator* iter,
707 bool* outUpdated,
708 bool* outNeedsRescan) {
Ethan Nicholascb670962017-04-20 19:31:52 -0400709 *outUpdated = true;
Ethan Nicholasc2371a42017-05-05 10:04:06 -0400710 std::unique_ptr<Expression>* target = (*iter)->expression();
John Stilesa5a97b42020-08-18 11:19:07 -0400711 BinaryExpression& bin = (*target)->as<BinaryExpression>();
Ethan Nicholasc8d9c8e2020-09-22 15:05:37 -0400712 Expression& left = bin.left();
713 std::unique_ptr<Expression>& rightPointer = bin.rightPointer();
714 SkASSERT(!left.hasSideEffects());
Ethan Nicholasc2371a42017-05-05 10:04:06 -0400715 bool result;
Ethan Nicholasc8d9c8e2020-09-22 15:05:37 -0400716 if (bin.getOperator() == Token::Kind::TK_EQ) {
717 result = b->tryRemoveLValueBefore(iter, &left);
Ethan Nicholasc2371a42017-05-05 10:04:06 -0400718 } else {
Ethan Nicholasc8d9c8e2020-09-22 15:05:37 -0400719 result = b->tryRemoveExpressionBefore(iter, &left);
Ethan Nicholascb670962017-04-20 19:31:52 -0400720 }
Ethan Nicholasc8d9c8e2020-09-22 15:05:37 -0400721 *target = std::move(rightPointer);
Ethan Nicholasc2371a42017-05-05 10:04:06 -0400722 if (!result) {
Ethan Nicholas4b330df2017-05-17 10:52:55 -0400723 *outNeedsRescan = true;
724 return;
725 }
726 if (*iter == b->fNodes.begin()) {
Ethan Nicholasc2371a42017-05-05 10:04:06 -0400727 *outNeedsRescan = true;
728 return;
729 }
730 --(*iter);
John Stiles70025e52020-09-28 16:08:58 -0400731 if (!(*iter)->isExpression() || (*iter)->expression() != &rightPointer) {
Ethan Nicholas4b330df2017-05-17 10:52:55 -0400732 *outNeedsRescan = true;
733 return;
734 }
Ethan Nicholasc2371a42017-05-05 10:04:06 -0400735 *iter = b->fNodes.erase(*iter);
Ethan Nicholasd9d33c32018-06-12 11:05:59 -0400736 SkASSERT((*iter)->expression() == target);
Ethan Nicholascb670962017-04-20 19:31:52 -0400737}
738
739/**
740 * Collapses the binary expression pointed to by iter down to just the left side (in both the IR and
741 * CFG structures).
742 */
John Stilesafbf8992020-08-18 10:08:21 -0400743static void delete_right(BasicBlock* b,
744 std::vector<BasicBlock::Node>::iterator* iter,
745 bool* outUpdated,
746 bool* outNeedsRescan) {
Ethan Nicholascb670962017-04-20 19:31:52 -0400747 *outUpdated = true;
Ethan Nicholasc2371a42017-05-05 10:04:06 -0400748 std::unique_ptr<Expression>* target = (*iter)->expression();
John Stilesa5a97b42020-08-18 11:19:07 -0400749 BinaryExpression& bin = (*target)->as<BinaryExpression>();
Ethan Nicholasc8d9c8e2020-09-22 15:05:37 -0400750 std::unique_ptr<Expression>& leftPointer = bin.leftPointer();
751 Expression& right = bin.right();
752 SkASSERT(!right.hasSideEffects());
753 if (!b->tryRemoveExpressionBefore(iter, &right)) {
754 *target = std::move(leftPointer);
Ethan Nicholascb670962017-04-20 19:31:52 -0400755 *outNeedsRescan = true;
Ethan Nicholasc2371a42017-05-05 10:04:06 -0400756 return;
Ethan Nicholascb670962017-04-20 19:31:52 -0400757 }
Ethan Nicholasc8d9c8e2020-09-22 15:05:37 -0400758 *target = std::move(leftPointer);
Ethan Nicholas4b330df2017-05-17 10:52:55 -0400759 if (*iter == b->fNodes.begin()) {
760 *outNeedsRescan = true;
761 return;
762 }
Ethan Nicholasc2371a42017-05-05 10:04:06 -0400763 --(*iter);
John Stiles70025e52020-09-28 16:08:58 -0400764 if ((!(*iter)->isExpression() || (*iter)->expression() != &leftPointer)) {
Ethan Nicholas4b330df2017-05-17 10:52:55 -0400765 *outNeedsRescan = true;
766 return;
767 }
Ethan Nicholasc2371a42017-05-05 10:04:06 -0400768 *iter = b->fNodes.erase(*iter);
Ethan Nicholasd9d33c32018-06-12 11:05:59 -0400769 SkASSERT((*iter)->expression() == target);
Ethan Nicholascb670962017-04-20 19:31:52 -0400770}
771
Ethan Nicholasfe53e582017-04-27 16:24:51 -0400772/**
773 * Constructs the specified type using a single argument.
774 */
Ethan Nicholas30d30222020-09-11 12:27:26 -0400775static std::unique_ptr<Expression> construct(const Type* type, std::unique_ptr<Expression> v) {
Ethan Nicholasfe53e582017-04-27 16:24:51 -0400776 std::vector<std::unique_ptr<Expression>> args;
777 args.push_back(std::move(v));
Ethan Nicholase6592142020-09-08 10:22:09 -0400778 std::unique_ptr<Expression> result = std::make_unique<Constructor>(-1, type, std::move(args));
Ethan Nicholasfe53e582017-04-27 16:24:51 -0400779 return result;
780}
781
782/**
783 * Used in the implementations of vectorize_left and vectorize_right. Given a vector type and an
784 * expression x, deletes the expression pointed to by iter and replaces it with <type>(x).
785 */
786static void vectorize(BasicBlock* b,
787 std::vector<BasicBlock::Node>::iterator* iter,
788 const Type& type,
789 std::unique_ptr<Expression>* otherExpression,
790 bool* outUpdated,
791 bool* outNeedsRescan) {
Ethan Nicholase6592142020-09-08 10:22:09 -0400792 SkASSERT((*(*iter)->expression())->kind() == Expression::Kind::kBinary);
793 SkASSERT(type.typeKind() == Type::TypeKind::kVector);
Ethan Nicholas30d30222020-09-11 12:27:26 -0400794 SkASSERT((*otherExpression)->type().typeKind() == Type::TypeKind::kScalar);
Ethan Nicholasfe53e582017-04-27 16:24:51 -0400795 *outUpdated = true;
796 std::unique_ptr<Expression>* target = (*iter)->expression();
797 if (!b->tryRemoveExpression(iter)) {
Ethan Nicholas30d30222020-09-11 12:27:26 -0400798 *target = construct(&type, std::move(*otherExpression));
Ethan Nicholasfe53e582017-04-27 16:24:51 -0400799 *outNeedsRescan = true;
800 } else {
Ethan Nicholas30d30222020-09-11 12:27:26 -0400801 *target = construct(&type, std::move(*otherExpression));
Ethan Nicholasfe53e582017-04-27 16:24:51 -0400802 if (!b->tryInsertExpression(iter, target)) {
803 *outNeedsRescan = true;
804 }
805 }
806}
807
808/**
809 * Given a binary expression of the form x <op> vec<n>(y), deletes the right side and vectorizes the
810 * left to yield vec<n>(x).
811 */
812static void vectorize_left(BasicBlock* b,
813 std::vector<BasicBlock::Node>::iterator* iter,
814 bool* outUpdated,
815 bool* outNeedsRescan) {
John Stilesa5a97b42020-08-18 11:19:07 -0400816 BinaryExpression& bin = (*(*iter)->expression())->as<BinaryExpression>();
Ethan Nicholasc8d9c8e2020-09-22 15:05:37 -0400817 vectorize(b, iter, bin.right().type(), &bin.leftPointer(), outUpdated, outNeedsRescan);
Ethan Nicholasfe53e582017-04-27 16:24:51 -0400818}
819
820/**
821 * Given a binary expression of the form vec<n>(x) <op> y, deletes the left side and vectorizes the
822 * right to yield vec<n>(y).
823 */
824static void vectorize_right(BasicBlock* b,
825 std::vector<BasicBlock::Node>::iterator* iter,
826 bool* outUpdated,
827 bool* outNeedsRescan) {
John Stilesa5a97b42020-08-18 11:19:07 -0400828 BinaryExpression& bin = (*(*iter)->expression())->as<BinaryExpression>();
Ethan Nicholasc8d9c8e2020-09-22 15:05:37 -0400829 vectorize(b, iter, bin.left().type(), &bin.rightPointer(), outUpdated, outNeedsRescan);
Ethan Nicholasfe53e582017-04-27 16:24:51 -0400830}
831
832// Mark that an expression which we were writing to is no longer being written to
John Stilesa5a97b42020-08-18 11:19:07 -0400833static void clear_write(Expression& expr) {
Ethan Nicholase6592142020-09-08 10:22:09 -0400834 switch (expr.kind()) {
835 case Expression::Kind::kVariableReference: {
John Stilesa5a97b42020-08-18 11:19:07 -0400836 expr.as<VariableReference>().setRefKind(VariableReference::kRead_RefKind);
Ethan Nicholasfe53e582017-04-27 16:24:51 -0400837 break;
838 }
Ethan Nicholase6592142020-09-08 10:22:09 -0400839 case Expression::Kind::kFieldAccess:
John Stilesa5a97b42020-08-18 11:19:07 -0400840 clear_write(*expr.as<FieldAccess>().fBase);
Ethan Nicholasfe53e582017-04-27 16:24:51 -0400841 break;
Ethan Nicholase6592142020-09-08 10:22:09 -0400842 case Expression::Kind::kSwizzle:
John Stilesa5a97b42020-08-18 11:19:07 -0400843 clear_write(*expr.as<Swizzle>().fBase);
Ethan Nicholasfe53e582017-04-27 16:24:51 -0400844 break;
Ethan Nicholase6592142020-09-08 10:22:09 -0400845 case Expression::Kind::kIndex:
John Stilesa5a97b42020-08-18 11:19:07 -0400846 clear_write(*expr.as<IndexExpression>().fBase);
Ethan Nicholasfe53e582017-04-27 16:24:51 -0400847 break;
848 default:
849 ABORT("shouldn't be writing to this kind of expression\n");
850 break;
851 }
852}
853
Ethan Nicholascb670962017-04-20 19:31:52 -0400854void Compiler::simplifyExpression(DefinitionMap& definitions,
855 BasicBlock& b,
856 std::vector<BasicBlock::Node>::iterator* iter,
857 std::unordered_set<const Variable*>* undefinedVariables,
858 bool* outUpdated,
859 bool* outNeedsRescan) {
860 Expression* expr = (*iter)->expression()->get();
Ethan Nicholasd9d33c32018-06-12 11:05:59 -0400861 SkASSERT(expr);
Ethan Nicholascb670962017-04-20 19:31:52 -0400862 if ((*iter)->fConstantPropagation) {
863 std::unique_ptr<Expression> optimized = expr->constantPropagate(*fIRGenerator, definitions);
864 if (optimized) {
Ethan Nicholas4b330df2017-05-17 10:52:55 -0400865 *outUpdated = true;
Ethan Nicholas30d30222020-09-11 12:27:26 -0400866 optimized = fIRGenerator->coerce(std::move(optimized), expr->type());
Ethan Nicholas1d881522020-09-11 09:32:54 -0400867 SkASSERT(optimized);
Ethan Nicholascb670962017-04-20 19:31:52 -0400868 if (!try_replace_expression(&b, iter, &optimized)) {
869 *outNeedsRescan = true;
Ethan Nicholas4b330df2017-05-17 10:52:55 -0400870 return;
Ethan Nicholascb670962017-04-20 19:31:52 -0400871 }
John Stiles70025e52020-09-28 16:08:58 -0400872 SkASSERT((*iter)->isExpression());
Ethan Nicholascb670962017-04-20 19:31:52 -0400873 expr = (*iter)->expression()->get();
Ethan Nicholascb670962017-04-20 19:31:52 -0400874 }
875 }
Ethan Nicholase6592142020-09-08 10:22:09 -0400876 switch (expr->kind()) {
877 case Expression::Kind::kVariableReference: {
John Stilesa5a97b42020-08-18 11:19:07 -0400878 const VariableReference& ref = expr->as<VariableReference>();
Brian Osman79457ef2020-09-24 15:01:27 -0400879 const Variable* var = ref.fVariable;
Ethan Nicholas8f7e28f2018-03-26 14:24:27 -0400880 if (ref.refKind() != VariableReference::kWrite_RefKind &&
881 ref.refKind() != VariableReference::kPointer_RefKind &&
Brian Osman79457ef2020-09-24 15:01:27 -0400882 var->fStorage == Variable::kLocal_Storage && !definitions[var] &&
883 (*undefinedVariables).find(var) == (*undefinedVariables).end()) {
884 (*undefinedVariables).insert(var);
Ethan Nicholas82a62d22017-11-07 14:42:10 +0000885 this->error(expr->fOffset,
Brian Osman79457ef2020-09-24 15:01:27 -0400886 "'" + var->fName + "' has not been assigned");
Ethan Nicholascb670962017-04-20 19:31:52 -0400887 }
888 break;
889 }
Ethan Nicholase6592142020-09-08 10:22:09 -0400890 case Expression::Kind::kTernary: {
John Stiles403a3632020-08-20 12:11:48 -0400891 TernaryExpression* t = &expr->as<TernaryExpression>();
Ethan Nicholase6592142020-09-08 10:22:09 -0400892 if (t->fTest->kind() == Expression::Kind::kBoolLiteral) {
Ethan Nicholascb670962017-04-20 19:31:52 -0400893 // ternary has a constant test, replace it with either the true or
894 // false branch
Ethan Nicholas59d660c2020-09-28 09:18:15 -0400895 if (t->fTest->as<BoolLiteral>().value()) {
Ethan Nicholascb670962017-04-20 19:31:52 -0400896 (*iter)->setExpression(std::move(t->fIfTrue));
897 } else {
898 (*iter)->setExpression(std::move(t->fIfFalse));
899 }
900 *outUpdated = true;
901 *outNeedsRescan = true;
902 }
903 break;
904 }
Ethan Nicholase6592142020-09-08 10:22:09 -0400905 case Expression::Kind::kBinary: {
John Stiles403a3632020-08-20 12:11:48 -0400906 BinaryExpression* bin = &expr->as<BinaryExpression>();
Ethan Nicholasc2371a42017-05-05 10:04:06 -0400907 if (dead_assignment(*bin)) {
908 delete_left(&b, iter, outUpdated, outNeedsRescan);
909 break;
910 }
Ethan Nicholasc8d9c8e2020-09-22 15:05:37 -0400911 Expression& left = bin->left();
912 Expression& right = bin->right();
913 const Type& leftType = left.type();
914 const Type& rightType = right.type();
Ethan Nicholasc2371a42017-05-05 10:04:06 -0400915 // collapse useless expressions like x * 1 or x + 0
Ethan Nicholas30d30222020-09-11 12:27:26 -0400916 if (((leftType.typeKind() != Type::TypeKind::kScalar) &&
917 (leftType.typeKind() != Type::TypeKind::kVector)) ||
918 ((rightType.typeKind() != Type::TypeKind::kScalar) &&
919 (rightType.typeKind() != Type::TypeKind::kVector))) {
Ethan Nicholasfe53e582017-04-27 16:24:51 -0400920 break;
921 }
Ethan Nicholasc8d9c8e2020-09-22 15:05:37 -0400922 switch (bin->getOperator()) {
Ethan Nicholas5a9e7fb2020-04-17 12:45:51 -0400923 case Token::Kind::TK_STAR:
Ethan Nicholasc8d9c8e2020-09-22 15:05:37 -0400924 if (is_constant(left, 1)) {
Ethan Nicholas30d30222020-09-11 12:27:26 -0400925 if (leftType.typeKind() == Type::TypeKind::kVector &&
926 rightType.typeKind() == Type::TypeKind::kScalar) {
Ethan Nicholas5af9ea32017-07-28 15:19:46 -0400927 // float4(1) * x -> float4(x)
Ethan Nicholasfe53e582017-04-27 16:24:51 -0400928 vectorize_right(&b, iter, outUpdated, outNeedsRescan);
929 } else {
930 // 1 * x -> x
Ethan Nicholas5af9ea32017-07-28 15:19:46 -0400931 // 1 * float4(x) -> float4(x)
932 // float4(1) * float4(x) -> float4(x)
Ethan Nicholasfe53e582017-04-27 16:24:51 -0400933 delete_left(&b, iter, outUpdated, outNeedsRescan);
934 }
935 }
Ethan Nicholasc8d9c8e2020-09-22 15:05:37 -0400936 else if (is_constant(left, 0)) {
Ethan Nicholas30d30222020-09-11 12:27:26 -0400937 if (leftType.typeKind() == Type::TypeKind::kScalar &&
938 rightType.typeKind() == Type::TypeKind::kVector &&
Ethan Nicholasc8d9c8e2020-09-22 15:05:37 -0400939 !right.hasSideEffects()) {
Ethan Nicholas5af9ea32017-07-28 15:19:46 -0400940 // 0 * float4(x) -> float4(0)
Ethan Nicholasfe53e582017-04-27 16:24:51 -0400941 vectorize_left(&b, iter, outUpdated, outNeedsRescan);
942 } else {
943 // 0 * x -> 0
Ethan Nicholas5af9ea32017-07-28 15:19:46 -0400944 // float4(0) * x -> float4(0)
945 // float4(0) * float4(x) -> float4(0)
Ethan Nicholasc8d9c8e2020-09-22 15:05:37 -0400946 if (!right.hasSideEffects()) {
Ethan Nicholas51493ee2017-12-11 12:34:33 -0500947 delete_right(&b, iter, outUpdated, outNeedsRescan);
948 }
Ethan Nicholasfe53e582017-04-27 16:24:51 -0400949 }
Ethan Nicholascb670962017-04-20 19:31:52 -0400950 }
Ethan Nicholasc8d9c8e2020-09-22 15:05:37 -0400951 else if (is_constant(right, 1)) {
Ethan Nicholas30d30222020-09-11 12:27:26 -0400952 if (leftType.typeKind() == Type::TypeKind::kScalar &&
953 rightType.typeKind() == Type::TypeKind::kVector) {
Ethan Nicholas5af9ea32017-07-28 15:19:46 -0400954 // x * float4(1) -> float4(x)
Ethan Nicholasfe53e582017-04-27 16:24:51 -0400955 vectorize_left(&b, iter, outUpdated, outNeedsRescan);
956 } else {
957 // x * 1 -> x
Ethan Nicholas5af9ea32017-07-28 15:19:46 -0400958 // float4(x) * 1 -> float4(x)
959 // float4(x) * float4(1) -> float4(x)
Ethan Nicholasfe53e582017-04-27 16:24:51 -0400960 delete_right(&b, iter, outUpdated, outNeedsRescan);
961 }
962 }
Ethan Nicholasc8d9c8e2020-09-22 15:05:37 -0400963 else if (is_constant(right, 0)) {
Ethan Nicholas30d30222020-09-11 12:27:26 -0400964 if (leftType.typeKind() == Type::TypeKind::kVector &&
965 rightType.typeKind() == Type::TypeKind::kScalar &&
Ethan Nicholasc8d9c8e2020-09-22 15:05:37 -0400966 !left.hasSideEffects()) {
Ethan Nicholas5af9ea32017-07-28 15:19:46 -0400967 // float4(x) * 0 -> float4(0)
Ethan Nicholasfe53e582017-04-27 16:24:51 -0400968 vectorize_right(&b, iter, outUpdated, outNeedsRescan);
969 } else {
970 // x * 0 -> 0
Ethan Nicholas5af9ea32017-07-28 15:19:46 -0400971 // x * float4(0) -> float4(0)
972 // float4(x) * float4(0) -> float4(0)
Ethan Nicholasc8d9c8e2020-09-22 15:05:37 -0400973 if (!left.hasSideEffects()) {
Ethan Nicholas51493ee2017-12-11 12:34:33 -0500974 delete_left(&b, iter, outUpdated, outNeedsRescan);
975 }
Ethan Nicholasfe53e582017-04-27 16:24:51 -0400976 }
Ethan Nicholascb670962017-04-20 19:31:52 -0400977 }
978 break;
Ethan Nicholas5a9e7fb2020-04-17 12:45:51 -0400979 case Token::Kind::TK_PLUS:
Ethan Nicholasc8d9c8e2020-09-22 15:05:37 -0400980 if (is_constant(left, 0)) {
Ethan Nicholas30d30222020-09-11 12:27:26 -0400981 if (leftType.typeKind() == Type::TypeKind::kVector &&
982 rightType.typeKind() == Type::TypeKind::kScalar) {
Ethan Nicholas5af9ea32017-07-28 15:19:46 -0400983 // float4(0) + x -> float4(x)
Ethan Nicholasfe53e582017-04-27 16:24:51 -0400984 vectorize_right(&b, iter, outUpdated, outNeedsRescan);
985 } else {
986 // 0 + x -> x
Ethan Nicholas5af9ea32017-07-28 15:19:46 -0400987 // 0 + float4(x) -> float4(x)
988 // float4(0) + float4(x) -> float4(x)
Ethan Nicholasfe53e582017-04-27 16:24:51 -0400989 delete_left(&b, iter, outUpdated, outNeedsRescan);
990 }
Ethan Nicholasc8d9c8e2020-09-22 15:05:37 -0400991 } else if (is_constant(right, 0)) {
Ethan Nicholas30d30222020-09-11 12:27:26 -0400992 if (leftType.typeKind() == Type::TypeKind::kScalar &&
993 rightType.typeKind() == Type::TypeKind::kVector) {
Ethan Nicholas5af9ea32017-07-28 15:19:46 -0400994 // x + float4(0) -> float4(x)
Ethan Nicholasfe53e582017-04-27 16:24:51 -0400995 vectorize_left(&b, iter, outUpdated, outNeedsRescan);
996 } else {
997 // x + 0 -> x
Ethan Nicholas5af9ea32017-07-28 15:19:46 -0400998 // float4(x) + 0 -> float4(x)
999 // float4(x) + float4(0) -> float4(x)
Ethan Nicholasfe53e582017-04-27 16:24:51 -04001000 delete_right(&b, iter, outUpdated, outNeedsRescan);
1001 }
Ethan Nicholas56e42712017-04-21 10:23:37 -04001002 }
1003 break;
Ethan Nicholas5a9e7fb2020-04-17 12:45:51 -04001004 case Token::Kind::TK_MINUS:
Ethan Nicholasc8d9c8e2020-09-22 15:05:37 -04001005 if (is_constant(right, 0)) {
Ethan Nicholas30d30222020-09-11 12:27:26 -04001006 if (leftType.typeKind() == Type::TypeKind::kScalar &&
1007 rightType.typeKind() == Type::TypeKind::kVector) {
Ethan Nicholas5af9ea32017-07-28 15:19:46 -04001008 // x - float4(0) -> float4(x)
Ethan Nicholasfe53e582017-04-27 16:24:51 -04001009 vectorize_left(&b, iter, outUpdated, outNeedsRescan);
1010 } else {
1011 // x - 0 -> x
Ethan Nicholas5af9ea32017-07-28 15:19:46 -04001012 // float4(x) - 0 -> float4(x)
1013 // float4(x) - float4(0) -> float4(x)
Ethan Nicholasfe53e582017-04-27 16:24:51 -04001014 delete_right(&b, iter, outUpdated, outNeedsRescan);
1015 }
Ethan Nicholascb670962017-04-20 19:31:52 -04001016 }
1017 break;
Ethan Nicholas5a9e7fb2020-04-17 12:45:51 -04001018 case Token::Kind::TK_SLASH:
Ethan Nicholasc8d9c8e2020-09-22 15:05:37 -04001019 if (is_constant(right, 1)) {
Ethan Nicholas30d30222020-09-11 12:27:26 -04001020 if (leftType.typeKind() == Type::TypeKind::kScalar &&
1021 rightType.typeKind() == Type::TypeKind::kVector) {
Ethan Nicholas5af9ea32017-07-28 15:19:46 -04001022 // x / float4(1) -> float4(x)
Ethan Nicholasfe53e582017-04-27 16:24:51 -04001023 vectorize_left(&b, iter, outUpdated, outNeedsRescan);
1024 } else {
1025 // x / 1 -> x
Ethan Nicholas5af9ea32017-07-28 15:19:46 -04001026 // float4(x) / 1 -> float4(x)
1027 // float4(x) / float4(1) -> float4(x)
Ethan Nicholasfe53e582017-04-27 16:24:51 -04001028 delete_right(&b, iter, outUpdated, outNeedsRescan);
1029 }
Ethan Nicholasc8d9c8e2020-09-22 15:05:37 -04001030 } else if (is_constant(left, 0)) {
Ethan Nicholas30d30222020-09-11 12:27:26 -04001031 if (leftType.typeKind() == Type::TypeKind::kScalar &&
1032 rightType.typeKind() == Type::TypeKind::kVector &&
Ethan Nicholasc8d9c8e2020-09-22 15:05:37 -04001033 !right.hasSideEffects()) {
Ethan Nicholas5af9ea32017-07-28 15:19:46 -04001034 // 0 / float4(x) -> float4(0)
Ethan Nicholasfe53e582017-04-27 16:24:51 -04001035 vectorize_left(&b, iter, outUpdated, outNeedsRescan);
1036 } else {
1037 // 0 / x -> 0
Ethan Nicholas5af9ea32017-07-28 15:19:46 -04001038 // float4(0) / x -> float4(0)
1039 // float4(0) / float4(x) -> float4(0)
Ethan Nicholasc8d9c8e2020-09-22 15:05:37 -04001040 if (!right.hasSideEffects()) {
Ethan Nicholas51493ee2017-12-11 12:34:33 -05001041 delete_right(&b, iter, outUpdated, outNeedsRescan);
1042 }
Ethan Nicholasfe53e582017-04-27 16:24:51 -04001043 }
1044 }
1045 break;
Ethan Nicholas5a9e7fb2020-04-17 12:45:51 -04001046 case Token::Kind::TK_PLUSEQ:
Ethan Nicholasc8d9c8e2020-09-22 15:05:37 -04001047 if (is_constant(right, 0)) {
1048 clear_write(left);
Ethan Nicholasfe53e582017-04-27 16:24:51 -04001049 delete_right(&b, iter, outUpdated, outNeedsRescan);
1050 }
1051 break;
Ethan Nicholas5a9e7fb2020-04-17 12:45:51 -04001052 case Token::Kind::TK_MINUSEQ:
Ethan Nicholasc8d9c8e2020-09-22 15:05:37 -04001053 if (is_constant(right, 0)) {
1054 clear_write(left);
Ethan Nicholasfe53e582017-04-27 16:24:51 -04001055 delete_right(&b, iter, outUpdated, outNeedsRescan);
1056 }
1057 break;
Ethan Nicholas5a9e7fb2020-04-17 12:45:51 -04001058 case Token::Kind::TK_STAREQ:
Ethan Nicholasc8d9c8e2020-09-22 15:05:37 -04001059 if (is_constant(right, 1)) {
1060 clear_write(left);
Ethan Nicholasfe53e582017-04-27 16:24:51 -04001061 delete_right(&b, iter, outUpdated, outNeedsRescan);
1062 }
1063 break;
Ethan Nicholas5a9e7fb2020-04-17 12:45:51 -04001064 case Token::Kind::TK_SLASHEQ:
Ethan Nicholasc8d9c8e2020-09-22 15:05:37 -04001065 if (is_constant(right, 1)) {
1066 clear_write(left);
Ethan Nicholascb670962017-04-20 19:31:52 -04001067 delete_right(&b, iter, outUpdated, outNeedsRescan);
1068 }
1069 break;
1070 default:
1071 break;
1072 }
Ethan Nicholas409f6f02019-09-17 12:34:39 -04001073 break;
1074 }
Ethan Nicholase6592142020-09-08 10:22:09 -04001075 case Expression::Kind::kSwizzle: {
John Stiles403a3632020-08-20 12:11:48 -04001076 Swizzle& s = expr->as<Swizzle>();
Ethan Nicholas409f6f02019-09-17 12:34:39 -04001077 // detect identity swizzles like foo.rgba
Ethan Nicholas30d30222020-09-11 12:27:26 -04001078 if ((int) s.fComponents.size() == s.fBase->type().columns()) {
Ethan Nicholas409f6f02019-09-17 12:34:39 -04001079 bool identity = true;
1080 for (int i = 0; i < (int) s.fComponents.size(); ++i) {
1081 if (s.fComponents[i] != i) {
1082 identity = false;
1083 break;
1084 }
1085 }
1086 if (identity) {
1087 *outUpdated = true;
1088 if (!try_replace_expression(&b, iter, &s.fBase)) {
1089 *outNeedsRescan = true;
1090 return;
1091 }
John Stiles70025e52020-09-28 16:08:58 -04001092 SkASSERT((*iter)->isExpression());
Ethan Nicholas409f6f02019-09-17 12:34:39 -04001093 break;
1094 }
1095 }
1096 // detect swizzles of swizzles, e.g. replace foo.argb.r000 with foo.a000
Ethan Nicholase6592142020-09-08 10:22:09 -04001097 if (s.fBase->kind() == Expression::Kind::kSwizzle) {
John Stilesa5a97b42020-08-18 11:19:07 -04001098 Swizzle& base = s.fBase->as<Swizzle>();
Ethan Nicholas409f6f02019-09-17 12:34:39 -04001099 std::vector<int> final;
1100 for (int c : s.fComponents) {
Brian Osman25647672020-09-15 15:16:56 -04001101 final.push_back(base.fComponents[c]);
Ethan Nicholas409f6f02019-09-17 12:34:39 -04001102 }
1103 *outUpdated = true;
1104 std::unique_ptr<Expression> replacement(new Swizzle(*fContext, base.fBase->clone(),
1105 std::move(final)));
1106 if (!try_replace_expression(&b, iter, &replacement)) {
1107 *outNeedsRescan = true;
1108 return;
1109 }
John Stiles70025e52020-09-28 16:08:58 -04001110 SkASSERT((*iter)->isExpression());
Ethan Nicholas409f6f02019-09-17 12:34:39 -04001111 }
John Stiles30212b72020-06-11 17:55:07 -04001112 break;
Ethan Nicholascb670962017-04-20 19:31:52 -04001113 }
1114 default:
1115 break;
1116 }
1117}
1118
John Stiles92219b42020-06-15 12:32:24 -04001119// Returns true if this statement could potentially execute a break at the current level. We ignore
1120// nested loops and switches, since any breaks inside of them will merely break the loop / switch.
John Stilesb92641c2020-08-31 18:09:01 -04001121static bool contains_conditional_break(Statement& stmt) {
1122 class ContainsConditionalBreak : public ProgramVisitor {
1123 public:
1124 bool visitStatement(const Statement& stmt) override {
Ethan Nicholase6592142020-09-08 10:22:09 -04001125 switch (stmt.kind()) {
1126 case Statement::Kind::kBlock:
John Stilesb92641c2020-08-31 18:09:01 -04001127 return this->INHERITED::visitStatement(stmt);
1128
Ethan Nicholase6592142020-09-08 10:22:09 -04001129 case Statement::Kind::kBreak:
John Stilesb92641c2020-08-31 18:09:01 -04001130 return fInConditional > 0;
1131
Ethan Nicholase6592142020-09-08 10:22:09 -04001132 case Statement::Kind::kIf: {
John Stilesb92641c2020-08-31 18:09:01 -04001133 ++fInConditional;
1134 bool result = this->INHERITED::visitStatement(stmt);
1135 --fInConditional;
1136 return result;
1137 }
1138
1139 default:
1140 return false;
1141 }
1142 }
1143
1144 int fInConditional = 0;
1145 using INHERITED = ProgramVisitor;
1146 };
1147
1148 return ContainsConditionalBreak{}.visitStatement(stmt);
John Stiles92219b42020-06-15 12:32:24 -04001149}
1150
Ethan Nicholas5005a222018-08-24 13:06:27 -04001151// returns true if this statement definitely executes a break at the current level (we ignore
1152// nested loops and switches, since any breaks inside of them will merely break the loop / switch)
John Stilesb92641c2020-08-31 18:09:01 -04001153static bool contains_unconditional_break(Statement& stmt) {
1154 class ContainsUnconditionalBreak : public ProgramVisitor {
1155 public:
1156 bool visitStatement(const Statement& stmt) override {
Ethan Nicholase6592142020-09-08 10:22:09 -04001157 switch (stmt.kind()) {
1158 case Statement::Kind::kBlock:
John Stilesb92641c2020-08-31 18:09:01 -04001159 return this->INHERITED::visitStatement(stmt);
1160
Ethan Nicholase6592142020-09-08 10:22:09 -04001161 case Statement::Kind::kBreak:
Ethan Nicholas5ac13c22017-05-10 15:06:17 -04001162 return true;
John Stilesb92641c2020-08-31 18:09:01 -04001163
1164 default:
1165 return false;
Ethan Nicholas5ac13c22017-05-10 15:06:17 -04001166 }
John Stilesb92641c2020-08-31 18:09:01 -04001167 }
John Stiles92219b42020-06-15 12:32:24 -04001168
John Stilesb92641c2020-08-31 18:09:01 -04001169 using INHERITED = ProgramVisitor;
1170 };
John Stiles92219b42020-06-15 12:32:24 -04001171
John Stilesb92641c2020-08-31 18:09:01 -04001172 return ContainsUnconditionalBreak{}.visitStatement(stmt);
Ethan Nicholas5ac13c22017-05-10 15:06:17 -04001173}
1174
John Stiles92219b42020-06-15 12:32:24 -04001175static void move_all_but_break(std::unique_ptr<Statement>& stmt,
1176 std::vector<std::unique_ptr<Statement>>* target) {
Ethan Nicholase6592142020-09-08 10:22:09 -04001177 switch (stmt->kind()) {
1178 case Statement::Kind::kBlock: {
John Stiles92219b42020-06-15 12:32:24 -04001179 // Recurse into the block.
1180 Block& block = static_cast<Block&>(*stmt);
1181
1182 std::vector<std::unique_ptr<Statement>> blockStmts;
Ethan Nicholas7bd60432020-09-25 14:31:59 -04001183 blockStmts.reserve(block.children().size());
1184 for (std::unique_ptr<Statement>& stmt : block.children()) {
1185 move_all_but_break(stmt, &blockStmts);
Ethan Nicholas739e1ca2020-06-11 12:16:14 -04001186 }
John Stiles92219b42020-06-15 12:32:24 -04001187
1188 target->push_back(std::make_unique<Block>(block.fOffset, std::move(blockStmts),
Ethan Nicholas7bd60432020-09-25 14:31:59 -04001189 block.symbolTable(), block.isScope()));
Ethan Nicholas739e1ca2020-06-11 12:16:14 -04001190 break;
John Stiles92219b42020-06-15 12:32:24 -04001191 }
1192
Ethan Nicholase6592142020-09-08 10:22:09 -04001193 case Statement::Kind::kBreak:
John Stiles92219b42020-06-15 12:32:24 -04001194 // Do not append a break to the target.
1195 break;
1196
Ethan Nicholas739e1ca2020-06-11 12:16:14 -04001197 default:
John Stiles92219b42020-06-15 12:32:24 -04001198 // Append normal statements to the target.
1199 target->push_back(std::move(stmt));
1200 break;
Ethan Nicholas739e1ca2020-06-11 12:16:14 -04001201 }
1202}
1203
Ethan Nicholas5ac13c22017-05-10 15:06:17 -04001204// Returns a block containing all of the statements that will be run if the given case matches
1205// (which, owing to the statements being owned by unique_ptrs, means the switch itself will be
1206// broken by this call and must then be discarded).
1207// Returns null (and leaves the switch unmodified) if no such simple reduction is possible, such as
1208// when break statements appear inside conditionals.
John Stiles92219b42020-06-15 12:32:24 -04001209static std::unique_ptr<Statement> block_for_case(SwitchStatement* switchStatement,
1210 SwitchCase* caseToCapture) {
1211 // We have to be careful to not move any of the pointers until after we're sure we're going to
1212 // succeed, so before we make any changes at all, we check the switch-cases to decide on a plan
1213 // of action. First, find the switch-case we are interested in.
1214 auto iter = switchStatement->fCases.begin();
1215 for (; iter != switchStatement->fCases.end(); ++iter) {
1216 if (iter->get() == caseToCapture) {
1217 break;
Ethan Nicholas5ac13c22017-05-10 15:06:17 -04001218 }
John Stiles92219b42020-06-15 12:32:24 -04001219 }
1220
1221 // Next, walk forward through the rest of the switch. If we find a conditional break, we're
1222 // stuck and can't simplify at all. If we find an unconditional break, we have a range of
1223 // statements that we can use for simplification.
1224 auto startIter = iter;
1225 Statement* unconditionalBreakStmt = nullptr;
1226 for (; iter != switchStatement->fCases.end(); ++iter) {
1227 for (std::unique_ptr<Statement>& stmt : (*iter)->fStatements) {
1228 if (contains_conditional_break(*stmt)) {
1229 // We can't reduce switch-cases to a block when they have conditional breaks.
1230 return nullptr;
Ethan Nicholas5ac13c22017-05-10 15:06:17 -04001231 }
John Stiles92219b42020-06-15 12:32:24 -04001232
1233 if (contains_unconditional_break(*stmt)) {
1234 // We found an unconditional break. We can use this block, but we need to strip
1235 // out the break statement.
1236 unconditionalBreakStmt = stmt.get();
Ethan Nicholas5ac13c22017-05-10 15:06:17 -04001237 break;
1238 }
1239 }
John Stiles92219b42020-06-15 12:32:24 -04001240
1241 if (unconditionalBreakStmt != nullptr) {
1242 break;
1243 }
Ethan Nicholas5ac13c22017-05-10 15:06:17 -04001244 }
John Stiles92219b42020-06-15 12:32:24 -04001245
1246 // We fell off the bottom of the switch or encountered a break. We know the range of statements
1247 // that we need to move over, and we know it's safe to do so.
1248 std::vector<std::unique_ptr<Statement>> caseStmts;
1249
1250 // We can move over most of the statements as-is.
1251 while (startIter != iter) {
1252 for (std::unique_ptr<Statement>& stmt : (*startIter)->fStatements) {
1253 caseStmts.push_back(std::move(stmt));
1254 }
1255 ++startIter;
Ethan Nicholas5ac13c22017-05-10 15:06:17 -04001256 }
John Stiles92219b42020-06-15 12:32:24 -04001257
1258 // If we found an unconditional break at the end, we need to move what we can while avoiding
1259 // that break.
1260 if (unconditionalBreakStmt != nullptr) {
1261 for (std::unique_ptr<Statement>& stmt : (*startIter)->fStatements) {
1262 if (stmt.get() == unconditionalBreakStmt) {
1263 move_all_but_break(stmt, &caseStmts);
1264 unconditionalBreakStmt = nullptr;
1265 break;
1266 }
1267
1268 caseStmts.push_back(std::move(stmt));
1269 }
1270 }
1271
1272 SkASSERT(unconditionalBreakStmt == nullptr); // Verify that we fixed the unconditional break.
1273
1274 // Return our newly-synthesized block.
1275 return std::make_unique<Block>(/*offset=*/-1, std::move(caseStmts), switchStatement->fSymbols);
Ethan Nicholas5ac13c22017-05-10 15:06:17 -04001276}
1277
Ethan Nicholascb670962017-04-20 19:31:52 -04001278void Compiler::simplifyStatement(DefinitionMap& definitions,
Ethan Nicholas5ac13c22017-05-10 15:06:17 -04001279 BasicBlock& b,
1280 std::vector<BasicBlock::Node>::iterator* iter,
1281 std::unordered_set<const Variable*>* undefinedVariables,
1282 bool* outUpdated,
1283 bool* outNeedsRescan) {
Ethan Nicholascb670962017-04-20 19:31:52 -04001284 Statement* stmt = (*iter)->statement()->get();
Ethan Nicholase6592142020-09-08 10:22:09 -04001285 switch (stmt->kind()) {
1286 case Statement::Kind::kVarDeclaration: {
John Stilesa5a97b42020-08-18 11:19:07 -04001287 const auto& varDecl = stmt->as<VarDeclaration>();
Ethan Nicholas82a62d22017-11-07 14:42:10 +00001288 if (varDecl.fVar->dead() &&
1289 (!varDecl.fValue ||
1290 !varDecl.fValue->hasSideEffects())) {
1291 if (varDecl.fValue) {
Ethan Nicholasd9d33c32018-06-12 11:05:59 -04001292 SkASSERT((*iter)->statement()->get() == stmt);
Ethan Nicholas82a62d22017-11-07 14:42:10 +00001293 if (!b.tryRemoveExpressionBefore(iter, varDecl.fValue.get())) {
1294 *outNeedsRescan = true;
Ethan Nicholascb670962017-04-20 19:31:52 -04001295 }
Ethan Nicholascb670962017-04-20 19:31:52 -04001296 }
Ethan Nicholascb670962017-04-20 19:31:52 -04001297 (*iter)->setStatement(std::unique_ptr<Statement>(new Nop()));
Ethan Nicholas82a62d22017-11-07 14:42:10 +00001298 *outUpdated = true;
Ethan Nicholascb670962017-04-20 19:31:52 -04001299 }
1300 break;
1301 }
Ethan Nicholase6592142020-09-08 10:22:09 -04001302 case Statement::Kind::kIf: {
John Stilesa5a97b42020-08-18 11:19:07 -04001303 IfStatement& i = stmt->as<IfStatement>();
Ethan Nicholase6592142020-09-08 10:22:09 -04001304 if (i.fTest->kind() == Expression::Kind::kBoolLiteral) {
Ethan Nicholas5ac13c22017-05-10 15:06:17 -04001305 // constant if, collapse down to a single branch
Ethan Nicholas59d660c2020-09-28 09:18:15 -04001306 if (i.fTest->as<BoolLiteral>().value()) {
Ethan Nicholasd9d33c32018-06-12 11:05:59 -04001307 SkASSERT(i.fIfTrue);
Ethan Nicholas5ac13c22017-05-10 15:06:17 -04001308 (*iter)->setStatement(std::move(i.fIfTrue));
1309 } else {
1310 if (i.fIfFalse) {
1311 (*iter)->setStatement(std::move(i.fIfFalse));
1312 } else {
1313 (*iter)->setStatement(std::unique_ptr<Statement>(new Nop()));
1314 }
1315 }
1316 *outUpdated = true;
1317 *outNeedsRescan = true;
1318 break;
1319 }
Ethan Nicholascb670962017-04-20 19:31:52 -04001320 if (i.fIfFalse && i.fIfFalse->isEmpty()) {
1321 // else block doesn't do anything, remove it
1322 i.fIfFalse.reset();
1323 *outUpdated = true;
1324 *outNeedsRescan = true;
1325 }
1326 if (!i.fIfFalse && i.fIfTrue->isEmpty()) {
1327 // if block doesn't do anything, no else block
1328 if (i.fTest->hasSideEffects()) {
1329 // test has side effects, keep it
1330 (*iter)->setStatement(std::unique_ptr<Statement>(
1331 new ExpressionStatement(std::move(i.fTest))));
1332 } else {
1333 // no if, no else, no test side effects, kill the whole if
1334 // statement
1335 (*iter)->setStatement(std::unique_ptr<Statement>(new Nop()));
1336 }
1337 *outUpdated = true;
1338 *outNeedsRescan = true;
1339 }
1340 break;
1341 }
Ethan Nicholase6592142020-09-08 10:22:09 -04001342 case Statement::Kind::kSwitch: {
John Stilesa5a97b42020-08-18 11:19:07 -04001343 SwitchStatement& s = stmt->as<SwitchStatement>();
Ethan Nicholas34b19c52020-09-14 11:33:47 -04001344 int64_t switchValue;
1345 if (fIRGenerator->getConstantInt(*s.fValue, &switchValue)) {
Ethan Nicholas5ac13c22017-05-10 15:06:17 -04001346 // switch is constant, replace it with the case that matches
1347 bool found = false;
1348 SwitchCase* defaultCase = nullptr;
John Stiles9d944232020-08-19 09:56:49 -04001349 for (const std::unique_ptr<SwitchCase>& c : s.fCases) {
Ethan Nicholas5ac13c22017-05-10 15:06:17 -04001350 if (!c->fValue) {
1351 defaultCase = c.get();
1352 continue;
1353 }
Ethan Nicholas34b19c52020-09-14 11:33:47 -04001354 int64_t caseValue;
1355 SkAssertResult(fIRGenerator->getConstantInt(*c->fValue, &caseValue));
1356 if (caseValue == switchValue) {
Ethan Nicholas5ac13c22017-05-10 15:06:17 -04001357 std::unique_ptr<Statement> newBlock = block_for_case(&s, c.get());
1358 if (newBlock) {
1359 (*iter)->setStatement(std::move(newBlock));
John Stiles9d944232020-08-19 09:56:49 -04001360 found = true;
Ethan Nicholas5ac13c22017-05-10 15:06:17 -04001361 break;
1362 } else {
Ethan Nicholas6e1cbc02017-07-14 10:12:15 -04001363 if (s.fIsStatic && !(fFlags & kPermitInvalidStaticTests_Flag)) {
Ethan Nicholas5b5f0962017-09-11 13:50:14 -07001364 this->error(s.fOffset,
Ethan Nicholas5ac13c22017-05-10 15:06:17 -04001365 "static switch contains non-static conditional break");
1366 s.fIsStatic = false;
1367 }
1368 return; // can't simplify
1369 }
1370 }
1371 }
1372 if (!found) {
1373 // no matching case. use default if it exists, or kill the whole thing
1374 if (defaultCase) {
1375 std::unique_ptr<Statement> newBlock = block_for_case(&s, defaultCase);
1376 if (newBlock) {
1377 (*iter)->setStatement(std::move(newBlock));
1378 } else {
Ethan Nicholas6e1cbc02017-07-14 10:12:15 -04001379 if (s.fIsStatic && !(fFlags & kPermitInvalidStaticTests_Flag)) {
Ethan Nicholas5b5f0962017-09-11 13:50:14 -07001380 this->error(s.fOffset,
Ethan Nicholas5ac13c22017-05-10 15:06:17 -04001381 "static switch contains non-static conditional break");
1382 s.fIsStatic = false;
1383 }
1384 return; // can't simplify
1385 }
1386 } else {
1387 (*iter)->setStatement(std::unique_ptr<Statement>(new Nop()));
1388 }
1389 }
1390 *outUpdated = true;
1391 *outNeedsRescan = true;
1392 }
1393 break;
1394 }
Ethan Nicholase6592142020-09-08 10:22:09 -04001395 case Statement::Kind::kExpression: {
John Stilesa5a97b42020-08-18 11:19:07 -04001396 ExpressionStatement& e = stmt->as<ExpressionStatement>();
Ethan Nicholasd9d33c32018-06-12 11:05:59 -04001397 SkASSERT((*iter)->statement()->get() == &e);
Ethan Nicholasd503a5a2020-09-30 09:29:55 -04001398 if (!e.expression()->hasSideEffects()) {
Ethan Nicholascb670962017-04-20 19:31:52 -04001399 // Expression statement with no side effects, kill it
Ethan Nicholasd503a5a2020-09-30 09:29:55 -04001400 if (!b.tryRemoveExpressionBefore(iter, e.expression().get())) {
Ethan Nicholascb670962017-04-20 19:31:52 -04001401 *outNeedsRescan = true;
1402 }
Ethan Nicholasd9d33c32018-06-12 11:05:59 -04001403 SkASSERT((*iter)->statement()->get() == stmt);
Ethan Nicholascb670962017-04-20 19:31:52 -04001404 (*iter)->setStatement(std::unique_ptr<Statement>(new Nop()));
1405 *outUpdated = true;
1406 }
1407 break;
1408 }
1409 default:
1410 break;
1411 }
1412}
1413
John Stiles0cc193a2020-09-09 09:39:34 -04001414bool Compiler::scanCFG(FunctionDefinition& f) {
1415 bool madeChanges = false;
1416
Ethan Nicholascb670962017-04-20 19:31:52 -04001417 CFG cfg = CFGGenerator().getCFG(f);
1418 this->computeDataFlow(&cfg);
ethannicholas22f939e2016-10-13 13:25:34 -07001419
1420 // check for unreachable code
1421 for (size_t i = 0; i < cfg.fBlocks.size(); i++) {
John Stiles0cc193a2020-09-09 09:39:34 -04001422 const BasicBlock& block = cfg.fBlocks[i];
1423 if (i != cfg.fStart && !block.fEntrances.size() && block.fNodes.size()) {
Ethan Nicholas5b5f0962017-09-11 13:50:14 -07001424 int offset;
John Stiles0cc193a2020-09-09 09:39:34 -04001425 const BasicBlock::Node& node = block.fNodes[0];
John Stiles70025e52020-09-28 16:08:58 -04001426 if (node.isStatement()) {
1427 offset = (*node.statement())->fOffset;
1428 } else {
1429 offset = (*node.expression())->fOffset;
1430 if ((*node.expression())->is<BoolLiteral>()) {
1431 // Function inlining can generate do { ... } while(false) loops which always
1432 // break, so the boolean condition is considered unreachable. Since not being
1433 // able to reach a literal is a non-issue in the first place, we don't report an
1434 // error in this case.
1435 continue;
1436 }
Ethan Nicholas86a43402017-01-19 13:32:00 -05001437 }
Ethan Nicholas5b5f0962017-09-11 13:50:14 -07001438 this->error(offset, String("unreachable"));
ethannicholas22f939e2016-10-13 13:25:34 -07001439 }
1440 }
1441 if (fErrorCount) {
John Stiles0cc193a2020-09-09 09:39:34 -04001442 return madeChanges;
ethannicholas22f939e2016-10-13 13:25:34 -07001443 }
1444
Ethan Nicholascb670962017-04-20 19:31:52 -04001445 // check for dead code & undefined variables, perform constant propagation
1446 std::unordered_set<const Variable*> undefinedVariables;
1447 bool updated;
1448 bool needsRescan = false;
1449 do {
1450 if (needsRescan) {
1451 cfg = CFGGenerator().getCFG(f);
1452 this->computeDataFlow(&cfg);
1453 needsRescan = false;
Ethan Nicholas113628d2017-02-02 16:11:39 -05001454 }
Ethan Nicholascb670962017-04-20 19:31:52 -04001455
1456 updated = false;
Ethan Nicholas1de14812020-06-19 15:32:49 -04001457 bool first = true;
Ethan Nicholascb670962017-04-20 19:31:52 -04001458 for (BasicBlock& b : cfg.fBlocks) {
Ethan Nicholas1de14812020-06-19 15:32:49 -04001459 if (!first && b.fEntrances.empty()) {
1460 // Block was reachable before optimization, but has since become unreachable. In
1461 // addition to being dead code, it's broken - since control flow can't reach it, no
1462 // prior variable definitions can reach it, and therefore variables might look to
1463 // have not been properly assigned. Kill it.
Brian Osmandb16c482020-09-09 15:15:06 -04001464
1465 // We need to do this in two steps. For any variable declarations, the node list
1466 // will contain statement nodes for each VarDeclaration, and then a statement for
1467 // the VarDeclarationsStatement. When we replace the VDS with a Nop, we delete the
1468 // storage of the unique_ptr that the VD nodes are pointing to. So we remove those
1469 // from the node list entirely, first.
John Stiles70025e52020-09-28 16:08:58 -04001470 b.fNodes.erase(std::remove_if(b.fNodes.begin(), b.fNodes.end(),
1471 [](const BasicBlock::Node& node) {
1472 return node.isStatement() &&
1473 (*node.statement())->is<VarDeclaration>();
1474 }),
1475 b.fNodes.end());
Brian Osmandb16c482020-09-09 15:15:06 -04001476
1477 // Now replace any remaining statements in the block with Nops.
Ethan Nicholas1de14812020-06-19 15:32:49 -04001478 for (BasicBlock::Node& node : b.fNodes) {
John Stiles70025e52020-09-28 16:08:58 -04001479 if (node.isStatement() && !(*node.statement())->is<Nop>()) {
John Stiles0cc193a2020-09-09 09:39:34 -04001480 node.setStatement(std::make_unique<Nop>());
1481 madeChanges = true;
Ethan Nicholas1de14812020-06-19 15:32:49 -04001482 }
1483 }
1484 continue;
1485 }
1486 first = false;
Ethan Nicholascb670962017-04-20 19:31:52 -04001487 DefinitionMap definitions = b.fBefore;
1488
1489 for (auto iter = b.fNodes.begin(); iter != b.fNodes.end() && !needsRescan; ++iter) {
John Stiles70025e52020-09-28 16:08:58 -04001490 if (iter->isExpression()) {
Ethan Nicholascb670962017-04-20 19:31:52 -04001491 this->simplifyExpression(definitions, b, &iter, &undefinedVariables, &updated,
1492 &needsRescan);
1493 } else {
1494 this->simplifyStatement(definitions, b, &iter, &undefinedVariables, &updated,
John Stiles0cc193a2020-09-09 09:39:34 -04001495 &needsRescan);
Ethan Nicholascb670962017-04-20 19:31:52 -04001496 }
Ethan Nicholas4b330df2017-05-17 10:52:55 -04001497 if (needsRescan) {
1498 break;
1499 }
Ethan Nicholascb670962017-04-20 19:31:52 -04001500 this->addDefinitions(*iter, &definitions);
1501 }
Brian Osman01a3eb42020-09-14 11:32:49 -04001502
1503 if (needsRescan) {
1504 break;
1505 }
Ethan Nicholascb670962017-04-20 19:31:52 -04001506 }
John Stiles0cc193a2020-09-09 09:39:34 -04001507 madeChanges |= updated;
Ethan Nicholascb670962017-04-20 19:31:52 -04001508 } while (updated);
Ethan Nicholasd9d33c32018-06-12 11:05:59 -04001509 SkASSERT(!needsRescan);
ethannicholas22f939e2016-10-13 13:25:34 -07001510
Ethan Nicholas91a10532017-06-22 11:24:38 -04001511 // verify static ifs & switches, clean up dead variable decls
Ethan Nicholas5ac13c22017-05-10 15:06:17 -04001512 for (BasicBlock& b : cfg.fBlocks) {
1513 DefinitionMap definitions = b.fBefore;
1514
Ethan Nicholas91a10532017-06-22 11:24:38 -04001515 for (auto iter = b.fNodes.begin(); iter != b.fNodes.end() && !needsRescan;) {
John Stiles70025e52020-09-28 16:08:58 -04001516 if (iter->isStatement()) {
Ethan Nicholas5ac13c22017-05-10 15:06:17 -04001517 const Statement& s = **iter->statement();
Ethan Nicholase6592142020-09-08 10:22:09 -04001518 switch (s.kind()) {
1519 case Statement::Kind::kIf:
John Stilesa5a97b42020-08-18 11:19:07 -04001520 if (s.as<IfStatement>().fIsStatic &&
Ethan Nicholas6e1cbc02017-07-14 10:12:15 -04001521 !(fFlags & kPermitInvalidStaticTests_Flag)) {
Ethan Nicholas5b5f0962017-09-11 13:50:14 -07001522 this->error(s.fOffset, "static if has non-static test");
Ethan Nicholas5ac13c22017-05-10 15:06:17 -04001523 }
Ethan Nicholas91a10532017-06-22 11:24:38 -04001524 ++iter;
Ethan Nicholas5ac13c22017-05-10 15:06:17 -04001525 break;
Ethan Nicholase6592142020-09-08 10:22:09 -04001526 case Statement::Kind::kSwitch:
John Stilesa5a97b42020-08-18 11:19:07 -04001527 if (s.as<SwitchStatement>().fIsStatic &&
John Stiles0cc193a2020-09-09 09:39:34 -04001528 !(fFlags & kPermitInvalidStaticTests_Flag)) {
Ethan Nicholas5b5f0962017-09-11 13:50:14 -07001529 this->error(s.fOffset, "static switch has non-static test");
Ethan Nicholas5ac13c22017-05-10 15:06:17 -04001530 }
Ethan Nicholas91a10532017-06-22 11:24:38 -04001531 ++iter;
Ethan Nicholas5ac13c22017-05-10 15:06:17 -04001532 break;
Ethan Nicholase6592142020-09-08 10:22:09 -04001533 case Statement::Kind::kVarDeclarations: {
John Stilesa5a97b42020-08-18 11:19:07 -04001534 VarDeclarations& decls = *s.as<VarDeclarationsStatement>().fDeclaration;
John Stiles0cc193a2020-09-09 09:39:34 -04001535 decls.fVars.erase(
1536 std::remove_if(decls.fVars.begin(), decls.fVars.end(),
1537 [&](const std::unique_ptr<Statement>& var) {
1538 bool nop = var->is<Nop>();
1539 madeChanges |= nop;
1540 return nop;
1541 }),
1542 decls.fVars.end());
1543 if (decls.fVars.empty()) {
Ethan Nicholas82a62d22017-11-07 14:42:10 +00001544 iter = b.fNodes.erase(iter);
1545 } else {
1546 ++iter;
1547 }
1548 break;
1549 }
Ethan Nicholas5ac13c22017-05-10 15:06:17 -04001550 default:
Ethan Nicholas91a10532017-06-22 11:24:38 -04001551 ++iter;
Ethan Nicholas5ac13c22017-05-10 15:06:17 -04001552 break;
1553 }
Ethan Nicholas91a10532017-06-22 11:24:38 -04001554 } else {
1555 ++iter;
Ethan Nicholas5ac13c22017-05-10 15:06:17 -04001556 }
1557 }
1558 }
1559
ethannicholas22f939e2016-10-13 13:25:34 -07001560 // check for missing return
Ethan Nicholas26a9aad2018-03-27 14:10:52 -04001561 if (f.fDeclaration.fReturnType != *fContext->fVoid_Type) {
ethannicholas22f939e2016-10-13 13:25:34 -07001562 if (cfg.fBlocks[cfg.fExit].fEntrances.size()) {
Ethan Nicholasdb80f692019-11-22 14:06:12 -05001563 this->error(f.fOffset, String("function '" + String(f.fDeclaration.fName) +
1564 "' can exit without returning a value"));
ethannicholas22f939e2016-10-13 13:25:34 -07001565 }
1566 }
John Stiles0cc193a2020-09-09 09:39:34 -04001567
1568 return madeChanges;
ethannicholas22f939e2016-10-13 13:25:34 -07001569}
1570
Brian Osman32d53552020-09-23 13:55:20 -04001571std::unique_ptr<Program> Compiler::convertProgram(
1572 Program::Kind kind,
1573 String text,
1574 const Program::Settings& settings,
1575 const std::vector<std::unique_ptr<ExternalValue>>* externalValues) {
1576 SkASSERT(!externalValues || (kind == Program::kGeneric_Kind));
Ethan Nicholas91164d12019-05-15 15:29:54 -04001577
ethannicholasb3058bd2016-07-01 08:22:01 -07001578 fErrorText = "";
1579 fErrorCount = 0;
John Stiles7b463002020-08-31 17:29:21 -04001580 fInliner.reset(context(), settings);
Ethan Nicholas3c6ae622018-04-24 13:06:09 -04001581 std::vector<std::unique_ptr<ProgramElement>>* inherited;
ethannicholasd598f792016-07-25 10:08:54 -07001582 std::vector<std::unique_ptr<ProgramElement>> elements;
ethannicholasb3058bd2016-07-01 08:22:01 -07001583 switch (kind) {
1584 case Program::kVertex_Kind:
Ethan Nicholas3c6ae622018-04-24 13:06:09 -04001585 inherited = &fVertexInclude;
John Stiles810c8cf2020-08-26 19:46:27 -04001586 fIRGenerator->fIntrinsics = fGPUIntrinsics.get();
Brian Osmane498b3c2020-09-23 14:42:11 -04001587 fIRGenerator->start(&settings, fVertexSymbolTable, inherited);
ethannicholasb3058bd2016-07-01 08:22:01 -07001588 break;
1589 case Program::kFragment_Kind:
Ethan Nicholas3c6ae622018-04-24 13:06:09 -04001590 inherited = &fFragmentInclude;
John Stiles810c8cf2020-08-26 19:46:27 -04001591 fIRGenerator->fIntrinsics = fGPUIntrinsics.get();
Brian Osmane498b3c2020-09-23 14:42:11 -04001592 fIRGenerator->start(&settings, fFragmentSymbolTable, inherited);
ethannicholasb3058bd2016-07-01 08:22:01 -07001593 break;
Ethan Nicholas52cad152017-02-16 16:37:32 -05001594 case Program::kGeometry_Kind:
Ethan Nicholasc18bb512020-07-28 14:46:53 -04001595 this->loadGeometryIntrinsics();
Ethan Nicholas3c6ae622018-04-24 13:06:09 -04001596 inherited = &fGeometryInclude;
John Stiles810c8cf2020-08-26 19:46:27 -04001597 fIRGenerator->fIntrinsics = fGPUIntrinsics.get();
Brian Osmane498b3c2020-09-23 14:42:11 -04001598 fIRGenerator->start(&settings, fGeometrySymbolTable, inherited);
Ethan Nicholas52cad152017-02-16 16:37:32 -05001599 break;
Ethan Nicholasb33fa3f2020-08-06 13:00:19 -04001600 case Program::kFragmentProcessor_Kind: {
Brian Osmandd496172020-08-08 08:17:18 -04001601#if !SKSL_STANDALONE
Ethan Nicholasc18bb512020-07-28 14:46:53 -04001602 {
1603 Rehydrator rehydrator(fContext.get(), fGpuSymbolTable, this,
1604 SKSL_INCLUDE_sksl_fp,
1605 SKSL_INCLUDE_sksl_fp_LENGTH);
1606 fFPSymbolTable = rehydrator.symbolTable();
1607 fFPInclude = rehydrator.elements();
1608 }
Brian Osman2b469eb2020-09-21 11:32:10 -04001609 fFPIntrinsics = std::make_unique<IRIntrinsicMap>(fGPUIntrinsics.get());
1610 grab_intrinsics(&fFPInclude, fFPIntrinsics.get());
1611
Ethan Nicholasc18bb512020-07-28 14:46:53 -04001612 inherited = &fFPInclude;
Brian Osman2b469eb2020-09-21 11:32:10 -04001613 fIRGenerator->fIntrinsics = fFPIntrinsics.get();
Brian Osmane498b3c2020-09-23 14:42:11 -04001614 fIRGenerator->start(&settings, fFPSymbolTable, inherited);
Ethan Nicholasc18bb512020-07-28 14:46:53 -04001615 break;
1616#else
Ethan Nicholas3c6ae622018-04-24 13:06:09 -04001617 inherited = nullptr;
Brian Osmane498b3c2020-09-23 14:42:11 -04001618 fIRGenerator->start(&settings, fGpuSymbolTable, /*inherited=*/nullptr,
1619 /*builtin=*/true);
John Stiles810c8cf2020-08-26 19:46:27 -04001620 fIRGenerator->fIntrinsics = fGPUIntrinsics.get();
Ethan Nicholasb33fa3f2020-08-06 13:00:19 -04001621 std::ifstream in(SKSL_FP_INCLUDE);
1622 std::string stdText{std::istreambuf_iterator<char>(in),
1623 std::istreambuf_iterator<char>()};
1624 if (in.rdstate()) {
1625 printf("error reading %s\n", SKSL_FP_INCLUDE);
1626 abort();
1627 }
Brian Osmane498b3c2020-09-23 14:42:11 -04001628 const String* source = fRootSymbolTable->takeOwnershipOfString(
Ethan Nicholasb33fa3f2020-08-06 13:00:19 -04001629 std::make_unique<String>(stdText.c_str()));
1630 fIRGenerator->convertProgram(kind, source->c_str(), source->length(), &elements);
Ethan Nicholasc18bb512020-07-28 14:46:53 -04001631 fIRGenerator->fIsBuiltinCode = false;
Ethan Nicholas762466e2017-06-29 10:03:38 -04001632 break;
Ethan Nicholasc18bb512020-07-28 14:46:53 -04001633#endif
Ethan Nicholasb33fa3f2020-08-06 13:00:19 -04001634 }
Ethan Nicholas8da1e652019-05-24 11:01:59 -04001635 case Program::kPipelineStage_Kind:
Ethan Nicholasc18bb512020-07-28 14:46:53 -04001636 this->loadPipelineIntrinsics();
Ethan Nicholas8da1e652019-05-24 11:01:59 -04001637 inherited = &fPipelineInclude;
John Stiles810c8cf2020-08-26 19:46:27 -04001638 fIRGenerator->fIntrinsics = fGPUIntrinsics.get();
Brian Osmane498b3c2020-09-23 14:42:11 -04001639 fIRGenerator->start(&settings, fPipelineSymbolTable, inherited);
Ethan Nicholas8da1e652019-05-24 11:01:59 -04001640 break;
Ethan Nicholas746035a2019-04-23 13:31:09 -04001641 case Program::kGeneric_Kind:
Ethan Nicholasc18bb512020-07-28 14:46:53 -04001642 this->loadInterpreterIntrinsics();
Brian Osmaneac49832020-09-18 11:49:22 -04001643 inherited = nullptr;
John Stiles810c8cf2020-08-26 19:46:27 -04001644 fIRGenerator->fIntrinsics = fInterpreterIntrinsics.get();
Brian Osmane498b3c2020-09-23 14:42:11 -04001645 fIRGenerator->start(&settings, fInterpreterSymbolTable, /*inherited=*/nullptr);
Ethan Nicholas0d997662019-04-08 09:46:01 -04001646 break;
ethannicholasb3058bd2016-07-01 08:22:01 -07001647 }
Brian Osman32d53552020-09-23 13:55:20 -04001648 if (externalValues) {
1649 // Add any external values to the symbol table. IRGenerator::start() has pushed a table, so
1650 // we're only making these visible to the current Program.
1651 for (const auto& ev : *externalValues) {
1652 fIRGenerator->fSymbolTable->addWithoutOwnership(ev->fName, ev.get());
1653 }
1654 }
Ethan Nicholas5b5f0962017-09-11 13:50:14 -07001655 std::unique_ptr<String> textPtr(new String(std::move(text)));
1656 fSource = textPtr.get();
Ethan Nicholasc18bb512020-07-28 14:46:53 -04001657 fIRGenerator->convertProgram(kind, textPtr->c_str(), textPtr->size(), &elements);
John Stilesfbd050b2020-08-03 13:21:46 -04001658 auto result = std::make_unique<Program>(kind,
1659 std::move(textPtr),
1660 settings,
1661 fContext,
1662 inherited,
1663 std::move(elements),
1664 fIRGenerator->fSymbolTable,
1665 fIRGenerator->fInputs);
Brian Osmane498b3c2020-09-23 14:42:11 -04001666 fIRGenerator->finish();
Ethan Nicholas941e7e22016-12-12 15:33:30 -05001667 if (fErrorCount) {
1668 return nullptr;
1669 }
Ethan Nicholas34b19c52020-09-14 11:33:47 -04001670 if (settings.fOptimize && !this->optimize(*result)) {
1671 return nullptr;
1672 }
Ethan Nicholas941e7e22016-12-12 15:33:30 -05001673 return result;
1674}
1675
Ethan Nicholas00543112018-07-31 09:44:36 -04001676bool Compiler::optimize(Program& program) {
1677 SkASSERT(!fErrorCount);
Ethan Nicholas34b19c52020-09-14 11:33:47 -04001678 fIRGenerator->fKind = program.fKind;
1679 fIRGenerator->fSettings = &program.fSettings;
John Stiles7954d6c2020-09-01 10:53:02 -04001680
Ethan Nicholas34b19c52020-09-14 11:33:47 -04001681 while (fErrorCount == 0) {
1682 bool madeChanges = false;
John Stiles7954d6c2020-09-01 10:53:02 -04001683
Ethan Nicholas34b19c52020-09-14 11:33:47 -04001684 // Scan and optimize based on the control-flow graph for each function.
1685 for (ProgramElement& element : program) {
1686 if (element.is<FunctionDefinition>()) {
1687 madeChanges |= this->scanCFG(element.as<FunctionDefinition>());
1688 }
1689 }
1690
1691 // Perform inline-candidate analysis and inline any functions deemed suitable.
John Stiles881a10c2020-09-19 10:13:24 -04001692 madeChanges |= fInliner.analyze(program);
Ethan Nicholas34b19c52020-09-14 11:33:47 -04001693
1694 // Remove dead functions. We wait until after analysis so that we still report errors,
1695 // even in unused code.
1696 if (program.fSettings.fRemoveDeadFunctions) {
1697 program.fElements.erase(
1698 std::remove_if(program.fElements.begin(),
1699 program.fElements.end(),
1700 [&](const std::unique_ptr<ProgramElement>& element) {
1701 if (!element->is<FunctionDefinition>()) {
1702 return false;
1703 }
1704 const auto& fn = element->as<FunctionDefinition>();
1705 bool dead = fn.fDeclaration.fCallCount == 0 &&
1706 fn.fDeclaration.fName != "main";
1707 madeChanges |= dead;
1708 return dead;
1709 }),
1710 program.fElements.end());
1711 }
1712
1713 if (program.fKind != Program::kFragmentProcessor_Kind) {
1714 // Remove dead variables.
John Stileseadfc3b2020-09-02 14:12:41 -04001715 for (ProgramElement& element : program) {
Ethan Nicholas34b19c52020-09-14 11:33:47 -04001716 if (!element.is<VarDeclarations>()) {
1717 continue;
Ethan Nicholas0dc80872019-02-08 15:46:24 -05001718 }
Ethan Nicholas34b19c52020-09-14 11:33:47 -04001719 VarDeclarations& vars = element.as<VarDeclarations>();
1720 vars.fVars.erase(
1721 std::remove_if(vars.fVars.begin(), vars.fVars.end(),
1722 [&](const std::unique_ptr<Statement>& stmt) {
1723 bool dead = stmt->as<VarDeclaration>().fVar->dead();
John Stiles73a6bff2020-09-09 13:40:37 -04001724 madeChanges |= dead;
1725 return dead;
1726 }),
Ethan Nicholas34b19c52020-09-14 11:33:47 -04001727 vars.fVars.end());
John Stiles73a6bff2020-09-09 13:40:37 -04001728 }
1729
Ethan Nicholas34b19c52020-09-14 11:33:47 -04001730 // Remove empty variable declarations with no variables left inside of them.
1731 program.fElements.erase(
1732 std::remove_if(program.fElements.begin(), program.fElements.end(),
1733 [&](const std::unique_ptr<ProgramElement>& element) {
1734 if (!element->is<VarDeclarations>()) {
1735 return false;
1736 }
1737 bool dead = element->as<VarDeclarations>().fVars.empty();
1738 madeChanges |= dead;
1739 return dead;
1740 }),
1741 program.fElements.end());
1742 }
John Stiles73a6bff2020-09-09 13:40:37 -04001743
Ethan Nicholas34b19c52020-09-14 11:33:47 -04001744 if (!madeChanges) {
1745 break;
Ethan Nicholas0dc80872019-02-08 15:46:24 -05001746 }
Ethan Nicholas00543112018-07-31 09:44:36 -04001747 }
1748 return fErrorCount == 0;
1749}
1750
Brian Osmanfb32ddf2019-06-18 10:14:20 -04001751#if defined(SKSL_STANDALONE) || SK_SUPPORT_GPU
1752
Ethan Nicholas00543112018-07-31 09:44:36 -04001753bool Compiler::toSPIRV(Program& program, OutputStream& out) {
Ethan Nicholasa6ae1f72017-03-16 09:56:54 -04001754#ifdef SK_ENABLE_SPIRV_VALIDATION
Ethan Nicholas0df1b042017-03-31 13:56:23 -04001755 StringStream buffer;
Ethan Nicholas5b5f0962017-09-11 13:50:14 -07001756 fSource = program.fSource.get();
Ethan Nicholas26a9aad2018-03-27 14:10:52 -04001757 SPIRVCodeGenerator cg(fContext.get(), &program, this, &buffer);
Ethan Nicholasa6ae1f72017-03-16 09:56:54 -04001758 bool result = cg.generateCode();
Ethan Nicholas5b5f0962017-09-11 13:50:14 -07001759 fSource = nullptr;
Ethan Nicholasa6ae1f72017-03-16 09:56:54 -04001760 if (result) {
Ethan Nicholasa6ae1f72017-03-16 09:56:54 -04001761 spvtools::SpirvTools tools(SPV_ENV_VULKAN_1_0);
Ethan Nicholas762466e2017-06-29 10:03:38 -04001762 const String& data = buffer.str();
Ethan Nicholasd9d33c32018-06-12 11:05:59 -04001763 SkASSERT(0 == data.size() % 4);
Ethan Nicholasa6ae1f72017-03-16 09:56:54 -04001764 auto dumpmsg = [](spv_message_level_t, const char*, const spv_position_t&, const char* m) {
1765 SkDebugf("SPIR-V validation error: %s\n", m);
1766 };
1767 tools.SetMessageConsumer(dumpmsg);
Ethan Nicholasd9d33c32018-06-12 11:05:59 -04001768 // Verify that the SPIR-V we produced is valid. If this SkASSERT fails, check the logs prior
Ethan Nicholasa6ae1f72017-03-16 09:56:54 -04001769 // to the failure to see the validation errors.
Ethan Nicholasd9d33c32018-06-12 11:05:59 -04001770 SkAssertResult(tools.Validate((const uint32_t*) data.c_str(), data.size() / 4));
Ethan Nicholas762466e2017-06-29 10:03:38 -04001771 out.write(data.c_str(), data.size());
Ethan Nicholasa6ae1f72017-03-16 09:56:54 -04001772 }
1773#else
Ethan Nicholas5b5f0962017-09-11 13:50:14 -07001774 fSource = program.fSource.get();
Ethan Nicholas26a9aad2018-03-27 14:10:52 -04001775 SPIRVCodeGenerator cg(fContext.get(), &program, this, &out);
Ethan Nicholas941e7e22016-12-12 15:33:30 -05001776 bool result = cg.generateCode();
Ethan Nicholas5b5f0962017-09-11 13:50:14 -07001777 fSource = nullptr;
Ethan Nicholasa6ae1f72017-03-16 09:56:54 -04001778#endif
Ethan Nicholasce33f102016-12-09 17:22:59 -05001779 return result;
1780}
1781
Ethan Nicholas00543112018-07-31 09:44:36 -04001782bool Compiler::toSPIRV(Program& program, String* out) {
Ethan Nicholas0df1b042017-03-31 13:56:23 -04001783 StringStream buffer;
Ethan Nicholas941e7e22016-12-12 15:33:30 -05001784 bool result = this->toSPIRV(program, buffer);
1785 if (result) {
Ethan Nicholas762466e2017-06-29 10:03:38 -04001786 *out = buffer.str();
Ethan Nicholas941e7e22016-12-12 15:33:30 -05001787 }
1788 return result;
1789}
1790
Ethan Nicholas00543112018-07-31 09:44:36 -04001791bool Compiler::toGLSL(Program& program, OutputStream& out) {
Ethan Nicholas5b5f0962017-09-11 13:50:14 -07001792 fSource = program.fSource.get();
Ethan Nicholas26a9aad2018-03-27 14:10:52 -04001793 GLSLCodeGenerator cg(fContext.get(), &program, this, &out);
Ethan Nicholas941e7e22016-12-12 15:33:30 -05001794 bool result = cg.generateCode();
Ethan Nicholas5b5f0962017-09-11 13:50:14 -07001795 fSource = nullptr;
Ethan Nicholas941e7e22016-12-12 15:33:30 -05001796 return result;
1797}
1798
Ethan Nicholas00543112018-07-31 09:44:36 -04001799bool Compiler::toGLSL(Program& program, String* out) {
Ethan Nicholas0df1b042017-03-31 13:56:23 -04001800 StringStream buffer;
Ethan Nicholas941e7e22016-12-12 15:33:30 -05001801 bool result = this->toGLSL(program, buffer);
1802 if (result) {
Ethan Nicholas762466e2017-06-29 10:03:38 -04001803 *out = buffer.str();
Ethan Nicholas941e7e22016-12-12 15:33:30 -05001804 }
1805 return result;
1806}
1807
Brian Osmanc0243912020-02-19 15:35:26 -05001808bool Compiler::toHLSL(Program& program, String* out) {
1809 String spirv;
1810 if (!this->toSPIRV(program, &spirv)) {
1811 return false;
1812 }
1813
1814 return SPIRVtoHLSL(spirv, out);
1815}
1816
Ethan Nicholas00543112018-07-31 09:44:36 -04001817bool Compiler::toMetal(Program& program, OutputStream& out) {
Ethan Nicholas26a9aad2018-03-27 14:10:52 -04001818 MetalCodeGenerator cg(fContext.get(), &program, this, &out);
Ethan Nicholascc305772017-10-13 16:17:45 -04001819 bool result = cg.generateCode();
Ethan Nicholascc305772017-10-13 16:17:45 -04001820 return result;
1821}
1822
Ethan Nicholas00543112018-07-31 09:44:36 -04001823bool Compiler::toMetal(Program& program, String* out) {
Timothy Liangb8eeb802018-07-23 16:46:16 -04001824 StringStream buffer;
1825 bool result = this->toMetal(program, buffer);
1826 if (result) {
1827 *out = buffer.str();
1828 }
1829 return result;
1830}
1831
Greg Daniela28ea672020-09-25 11:12:56 -04001832#if defined(SKSL_STANDALONE) || GR_TEST_UTILS
Ethan Nicholas00543112018-07-31 09:44:36 -04001833bool Compiler::toCPP(Program& program, String name, OutputStream& out) {
Ethan Nicholas5b5f0962017-09-11 13:50:14 -07001834 fSource = program.fSource.get();
Ethan Nicholas26a9aad2018-03-27 14:10:52 -04001835 CPPCodeGenerator cg(fContext.get(), &program, this, name, &out);
Ethan Nicholas762466e2017-06-29 10:03:38 -04001836 bool result = cg.generateCode();
Ethan Nicholas5b5f0962017-09-11 13:50:14 -07001837 fSource = nullptr;
Ethan Nicholas762466e2017-06-29 10:03:38 -04001838 return result;
1839}
1840
Ethan Nicholas00543112018-07-31 09:44:36 -04001841bool Compiler::toH(Program& program, String name, OutputStream& out) {
Ethan Nicholas5b5f0962017-09-11 13:50:14 -07001842 fSource = program.fSource.get();
Ethan Nicholas26a9aad2018-03-27 14:10:52 -04001843 HCodeGenerator cg(fContext.get(), &program, this, name, &out);
Ethan Nicholas762466e2017-06-29 10:03:38 -04001844 bool result = cg.generateCode();
Ethan Nicholas5b5f0962017-09-11 13:50:14 -07001845 fSource = nullptr;
Ethan Nicholas00543112018-07-31 09:44:36 -04001846 return result;
1847}
Greg Daniela28ea672020-09-25 11:12:56 -04001848#endif // defined(SKSL_STANDALONE) || GR_TEST_UTILS
Ethan Nicholas00543112018-07-31 09:44:36 -04001849
Ethan Nicholas2a479a52020-08-18 16:29:45 -04001850#endif // defined(SKSL_STANDALONE) || SK_SUPPORT_GPU
Brian Osman2e29ab52019-09-20 12:19:11 -04001851
1852#if !defined(SKSL_STANDALONE) && SK_SUPPORT_GPU
Brian Osmana4b91692020-08-10 14:26:16 -04001853bool Compiler::toPipelineStage(Program& program, PipelineStageArgs* outArgs) {
Ethan Nicholas00543112018-07-31 09:44:36 -04001854 fSource = program.fSource.get();
1855 StringStream buffer;
Brian Osman300fe1d2020-01-23 15:42:43 -05001856 PipelineStageCodeGenerator cg(fContext.get(), &program, this, &buffer, outArgs);
Ethan Nicholas00543112018-07-31 09:44:36 -04001857 bool result = cg.generateCode();
1858 fSource = nullptr;
1859 if (result) {
Brian Osman107c6662019-12-30 15:02:30 -05001860 outArgs->fCode = buffer.str();
Ethan Nicholas00543112018-07-31 09:44:36 -04001861 }
Ethan Nicholas762466e2017-06-29 10:03:38 -04001862 return result;
1863}
Brian Osmanfb32ddf2019-06-18 10:14:20 -04001864#endif
1865
Ethan Nicholas0e9401d2019-03-21 11:05:37 -04001866std::unique_ptr<ByteCode> Compiler::toByteCode(Program& program) {
Mike Klein853d4ed2020-08-20 00:41:00 +00001867#if defined(SK_ENABLE_SKSL_INTERPRETER)
Brian Osman808f0212020-01-21 15:36:47 -05001868 fSource = program.fSource.get();
Ethan Nicholas0e9401d2019-03-21 11:05:37 -04001869 std::unique_ptr<ByteCode> result(new ByteCode());
Brian Osmanb08cc022020-04-02 11:38:40 -04001870 ByteCodeGenerator cg(fContext.get(), &program, this, result.get());
1871 bool success = cg.generateCode();
1872 fSource = nullptr;
1873 if (success) {
Ethan Nicholas0e9401d2019-03-21 11:05:37 -04001874 return result;
1875 }
Mike Klein853d4ed2020-08-20 00:41:00 +00001876#else
1877 ABORT("ByteCode interpreter not enabled");
1878#endif
Ethan Nicholas0e9401d2019-03-21 11:05:37 -04001879 return nullptr;
1880}
1881
Brian Osman401a0092020-09-10 14:47:24 -04001882const char* Compiler::OperatorName(Token::Kind op) {
1883 switch (op) {
Ethan Nicholas5a9e7fb2020-04-17 12:45:51 -04001884 case Token::Kind::TK_PLUS: return "+";
1885 case Token::Kind::TK_MINUS: return "-";
1886 case Token::Kind::TK_STAR: return "*";
1887 case Token::Kind::TK_SLASH: return "/";
1888 case Token::Kind::TK_PERCENT: return "%";
1889 case Token::Kind::TK_SHL: return "<<";
1890 case Token::Kind::TK_SHR: return ">>";
1891 case Token::Kind::TK_LOGICALNOT: return "!";
1892 case Token::Kind::TK_LOGICALAND: return "&&";
1893 case Token::Kind::TK_LOGICALOR: return "||";
1894 case Token::Kind::TK_LOGICALXOR: return "^^";
1895 case Token::Kind::TK_BITWISENOT: return "~";
1896 case Token::Kind::TK_BITWISEAND: return "&";
1897 case Token::Kind::TK_BITWISEOR: return "|";
1898 case Token::Kind::TK_BITWISEXOR: return "^";
1899 case Token::Kind::TK_EQ: return "=";
1900 case Token::Kind::TK_EQEQ: return "==";
1901 case Token::Kind::TK_NEQ: return "!=";
1902 case Token::Kind::TK_LT: return "<";
1903 case Token::Kind::TK_GT: return ">";
1904 case Token::Kind::TK_LTEQ: return "<=";
1905 case Token::Kind::TK_GTEQ: return ">=";
1906 case Token::Kind::TK_PLUSEQ: return "+=";
1907 case Token::Kind::TK_MINUSEQ: return "-=";
1908 case Token::Kind::TK_STAREQ: return "*=";
1909 case Token::Kind::TK_SLASHEQ: return "/=";
1910 case Token::Kind::TK_PERCENTEQ: return "%=";
1911 case Token::Kind::TK_SHLEQ: return "<<=";
1912 case Token::Kind::TK_SHREQ: return ">>=";
1913 case Token::Kind::TK_LOGICALANDEQ: return "&&=";
1914 case Token::Kind::TK_LOGICALOREQ: return "||=";
1915 case Token::Kind::TK_LOGICALXOREQ: return "^^=";
1916 case Token::Kind::TK_BITWISEANDEQ: return "&=";
1917 case Token::Kind::TK_BITWISEOREQ: return "|=";
1918 case Token::Kind::TK_BITWISEXOREQ: return "^=";
1919 case Token::Kind::TK_PLUSPLUS: return "++";
1920 case Token::Kind::TK_MINUSMINUS: return "--";
1921 case Token::Kind::TK_COMMA: return ",";
Ethan Nicholas5b5f0962017-09-11 13:50:14 -07001922 default:
Brian Osman401a0092020-09-10 14:47:24 -04001923 ABORT("unsupported operator: %d\n", (int) op);
Ethan Nicholas5b5f0962017-09-11 13:50:14 -07001924 }
1925}
1926
1927
1928bool Compiler::IsAssignment(Token::Kind op) {
1929 switch (op) {
Ethan Nicholas5a9e7fb2020-04-17 12:45:51 -04001930 case Token::Kind::TK_EQ: // fall through
1931 case Token::Kind::TK_PLUSEQ: // fall through
1932 case Token::Kind::TK_MINUSEQ: // fall through
1933 case Token::Kind::TK_STAREQ: // fall through
1934 case Token::Kind::TK_SLASHEQ: // fall through
1935 case Token::Kind::TK_PERCENTEQ: // fall through
1936 case Token::Kind::TK_SHLEQ: // fall through
1937 case Token::Kind::TK_SHREQ: // fall through
1938 case Token::Kind::TK_BITWISEOREQ: // fall through
1939 case Token::Kind::TK_BITWISEXOREQ: // fall through
1940 case Token::Kind::TK_BITWISEANDEQ: // fall through
1941 case Token::Kind::TK_LOGICALOREQ: // fall through
1942 case Token::Kind::TK_LOGICALXOREQ: // fall through
1943 case Token::Kind::TK_LOGICALANDEQ:
Ethan Nicholas5b5f0962017-09-11 13:50:14 -07001944 return true;
1945 default:
1946 return false;
1947 }
1948}
1949
Brian Osman401a0092020-09-10 14:47:24 -04001950Token::Kind Compiler::RemoveAssignment(Token::Kind op) {
1951 switch (op) {
1952 case Token::Kind::TK_PLUSEQ: return Token::Kind::TK_PLUS;
1953 case Token::Kind::TK_MINUSEQ: return Token::Kind::TK_MINUS;
1954 case Token::Kind::TK_STAREQ: return Token::Kind::TK_STAR;
1955 case Token::Kind::TK_SLASHEQ: return Token::Kind::TK_SLASH;
1956 case Token::Kind::TK_PERCENTEQ: return Token::Kind::TK_PERCENT;
1957 case Token::Kind::TK_SHLEQ: return Token::Kind::TK_SHL;
1958 case Token::Kind::TK_SHREQ: return Token::Kind::TK_SHR;
1959 case Token::Kind::TK_BITWISEOREQ: return Token::Kind::TK_BITWISEOR;
1960 case Token::Kind::TK_BITWISEXOREQ: return Token::Kind::TK_BITWISEXOR;
1961 case Token::Kind::TK_BITWISEANDEQ: return Token::Kind::TK_BITWISEAND;
1962 case Token::Kind::TK_LOGICALOREQ: return Token::Kind::TK_LOGICALOR;
1963 case Token::Kind::TK_LOGICALXOREQ: return Token::Kind::TK_LOGICALXOR;
1964 case Token::Kind::TK_LOGICALANDEQ: return Token::Kind::TK_LOGICALAND;
1965 default: return op;
1966 }
1967}
1968
Ethan Nicholas5b5f0962017-09-11 13:50:14 -07001969Position Compiler::position(int offset) {
Ethan Nicholasd9d33c32018-06-12 11:05:59 -04001970 SkASSERT(fSource);
Ethan Nicholas5b5f0962017-09-11 13:50:14 -07001971 int line = 1;
1972 int column = 1;
1973 for (int i = 0; i < offset; i++) {
1974 if ((*fSource)[i] == '\n') {
1975 ++line;
1976 column = 1;
1977 }
1978 else {
1979 ++column;
1980 }
1981 }
1982 return Position(line, column);
1983}
1984
1985void Compiler::error(int offset, String msg) {
ethannicholasb3058bd2016-07-01 08:22:01 -07001986 fErrorCount++;
Ethan Nicholas5b5f0962017-09-11 13:50:14 -07001987 Position pos = this->position(offset);
1988 fErrorText += "error: " + to_string(pos.fLine) + ": " + msg.c_str() + "\n";
ethannicholasb3058bd2016-07-01 08:22:01 -07001989}
1990
Ethan Nicholas0df1b042017-03-31 13:56:23 -04001991String Compiler::errorText() {
Ethan Nicholas00543112018-07-31 09:44:36 -04001992 this->writeErrorCount();
1993 fErrorCount = 0;
Ethan Nicholas0df1b042017-03-31 13:56:23 -04001994 String result = fErrorText;
ethannicholasb3058bd2016-07-01 08:22:01 -07001995 return result;
1996}
1997
1998void Compiler::writeErrorCount() {
1999 if (fErrorCount) {
2000 fErrorText += to_string(fErrorCount) + " error";
2001 if (fErrorCount > 1) {
2002 fErrorText += "s";
2003 }
2004 fErrorText += "\n";
2005 }
2006}
2007
John Stilesa6841be2020-08-06 14:11:56 -04002008} // namespace SkSL