blob: eedd3e71084985daccc2c519241ef07cb05c618f [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"
John Stilese6150002020-10-05 12:03:53 -040036#include "src/utils/SkBitSet.h"
ethannicholasb3058bd2016-07-01 08:22:01 -070037
Ethan Nicholasb33fa3f2020-08-06 13:00:19 -040038#include <fstream>
39
Ethan Nicholasa11035b2019-11-26 16:27:47 -050040#if !defined(SKSL_STANDALONE) & SK_SUPPORT_GPU
41#include "include/gpu/GrContextOptions.h"
42#include "src/gpu/GrShaderCaps.h"
43#endif
44
Ethan Nicholasa6ae1f72017-03-16 09:56:54 -040045#ifdef SK_ENABLE_SPIRV_VALIDATION
46#include "spirv-tools/libspirv.hpp"
47#endif
48
Brian Osmandd496172020-08-08 08:17:18 -040049#if !SKSL_STANDALONE
Ethan Nicholasc18bb512020-07-28 14:46:53 -040050
51#include "src/sksl/generated/sksl_fp.dehydrated.sksl"
52#include "src/sksl/generated/sksl_frag.dehydrated.sksl"
53#include "src/sksl/generated/sksl_geom.dehydrated.sksl"
54#include "src/sksl/generated/sksl_gpu.dehydrated.sksl"
55#include "src/sksl/generated/sksl_interp.dehydrated.sksl"
56#include "src/sksl/generated/sksl_pipeline.dehydrated.sksl"
57#include "src/sksl/generated/sksl_vert.dehydrated.sksl"
58
59#else
60
Brian Osmandd496172020-08-08 08:17:18 -040061// GN generates or copies all of these files to the skslc executable directory
62static const char SKSL_GPU_INCLUDE[] = "sksl_gpu.sksl";
63static const char SKSL_INTERP_INCLUDE[] = "sksl_interp.sksl";
64static const char SKSL_VERT_INCLUDE[] = "sksl_vert.sksl";
65static const char SKSL_FRAG_INCLUDE[] = "sksl_frag.sksl";
66static const char SKSL_GEOM_INCLUDE[] = "sksl_geom.sksl";
67static const char SKSL_FP_INCLUDE[] = "sksl_fp.sksl";
68static const char SKSL_PIPELINE_INCLUDE[] = "sksl_pipeline.sksl";
Ethan Nicholasc18bb512020-07-28 14:46:53 -040069
70#endif
Ethan Nicholas0d997662019-04-08 09:46:01 -040071
ethannicholasb3058bd2016-07-01 08:22:01 -070072namespace SkSL {
73
Ethan Nicholasdb80f692019-11-22 14:06:12 -050074static void grab_intrinsics(std::vector<std::unique_ptr<ProgramElement>>* src,
John Stiles810c8cf2020-08-26 19:46:27 -040075 IRIntrinsicMap* target) {
Brian Osmanafa18ee2020-10-07 17:47:45 -040076 for (std::unique_ptr<ProgramElement>& element : *src) {
Ethan Nicholase6592142020-09-08 10:22:09 -040077 switch (element->kind()) {
78 case ProgramElement::Kind::kFunction: {
Brian Osmanafa18ee2020-10-07 17:47:45 -040079 const FunctionDefinition& f = element->as<FunctionDefinition>();
Ethan Nicholased84b732020-10-08 11:45:44 -040080 SkASSERT(f.fDeclaration.isBuiltin());
Brian Osman2b469eb2020-09-21 11:32:10 -040081 target->insertOrDie(f.fDeclaration.description(), std::move(element));
Ethan Nicholasdb80f692019-11-22 14:06:12 -050082 break;
83 }
Ethan Nicholase6592142020-09-08 10:22:09 -040084 case ProgramElement::Kind::kEnum: {
Brian Osmanafa18ee2020-10-07 17:47:45 -040085 const Enum& e = element->as<Enum>();
86 SkASSERT(e.isBuiltin());
Ethan Nicholasd83ded82020-09-29 17:05:54 -040087 target->insertOrDie(e.typeName(), std::move(element));
Ethan Nicholasdb80f692019-11-22 14:06:12 -050088 break;
89 }
Brian Osmanc0213602020-10-06 14:43:32 -040090 case ProgramElement::Kind::kGlobalVar: {
Brian Osmanafa18ee2020-10-07 17:47:45 -040091 const Variable* var = element->as<GlobalVarDeclaration>().fDecl->fVar;
92 SkASSERT(var->isBuiltin());
Ethan Nicholase2c49992020-10-05 11:49:11 -040093 target->insertOrDie(var->name(), std::move(element));
Brian Osmanafa18ee2020-10-07 17:47:45 -040094 break;
95 }
96 case ProgramElement::Kind::kInterfaceBlock: {
97 const Variable* var = element->as<InterfaceBlock>().fVariable;
98 SkASSERT(var->isBuiltin());
99 target->insertOrDie(var->name(), std::move(element));
Brian Osman8e2ef022020-09-30 13:26:43 -0400100 break;
101 }
Ethan Nicholasdb80f692019-11-22 14:06:12 -0500102 default:
Brian Osman00a8b5b2020-10-02 09:06:04 -0400103 printf("Unsupported element: %s\n", element->description().c_str());
104 SkASSERT(false);
Brian Osman2b469eb2020-09-21 11:32:10 -0400105 break;
Ethan Nicholasdb80f692019-11-22 14:06:12 -0500106 }
107 }
108}
109
John Stilesbc0c29e2020-09-28 13:13:40 -0400110static void reset_call_counts(std::vector<std::unique_ptr<ProgramElement>>* src) {
111 for (std::unique_ptr<ProgramElement>& element : *src) {
112 if (element->is<FunctionDefinition>()) {
113 const FunctionDeclaration& fnDecl = element->as<FunctionDefinition>().fDeclaration;
Ethan Nicholased84b732020-10-08 11:45:44 -0400114 fnDecl.callCount() = 0;
John Stilesbc0c29e2020-09-28 13:13:40 -0400115 }
116 }
117}
118
Ethan Nicholas6e1cbc02017-07-14 10:12:15 -0400119Compiler::Compiler(Flags flags)
Brian Osman00a8b5b2020-10-02 09:06:04 -0400120: fFlags(flags)
John Stiles810c8cf2020-08-26 19:46:27 -0400121, fContext(std::make_shared<Context>())
Ethan Nicholas6e1cbc02017-07-14 10:12:15 -0400122, fErrorCount(0) {
Brian Osmaneac49832020-09-18 11:49:22 -0400123 fRootSymbolTable = std::make_shared<SymbolTable>(this);
John Stiles941fc712020-09-19 12:47:10 +0000124 fIRGenerator =
125 std::make_unique<IRGenerator>(fContext.get(), &fInliner, fRootSymbolTable, *this);
John Stilesb8cc6652020-10-08 09:12:07 -0400126 #define ADD_TYPE(t) fRootSymbolTable->addWithoutOwnership(fContext->f ## t ## _Type.get())
ethannicholasb3058bd2016-07-01 08:22:01 -0700127 ADD_TYPE(Void);
128 ADD_TYPE(Float);
Ethan Nicholas5af9ea32017-07-28 15:19:46 -0400129 ADD_TYPE(Float2);
130 ADD_TYPE(Float3);
131 ADD_TYPE(Float4);
Ethan Nicholasdcba08e2017-08-02 10:52:54 -0400132 ADD_TYPE(Half);
133 ADD_TYPE(Half2);
134 ADD_TYPE(Half3);
135 ADD_TYPE(Half4);
ethannicholasb3058bd2016-07-01 08:22:01 -0700136 ADD_TYPE(Int);
Ethan Nicholas5af9ea32017-07-28 15:19:46 -0400137 ADD_TYPE(Int2);
138 ADD_TYPE(Int3);
139 ADD_TYPE(Int4);
ethannicholasb3058bd2016-07-01 08:22:01 -0700140 ADD_TYPE(UInt);
Ethan Nicholas5af9ea32017-07-28 15:19:46 -0400141 ADD_TYPE(UInt2);
142 ADD_TYPE(UInt3);
143 ADD_TYPE(UInt4);
Ethan Nicholasdcba08e2017-08-02 10:52:54 -0400144 ADD_TYPE(Short);
145 ADD_TYPE(Short2);
146 ADD_TYPE(Short3);
147 ADD_TYPE(Short4);
148 ADD_TYPE(UShort);
149 ADD_TYPE(UShort2);
150 ADD_TYPE(UShort3);
151 ADD_TYPE(UShort4);
Ruiqi Maob609e6d2018-07-17 10:19:38 -0400152 ADD_TYPE(Byte);
153 ADD_TYPE(Byte2);
154 ADD_TYPE(Byte3);
155 ADD_TYPE(Byte4);
156 ADD_TYPE(UByte);
157 ADD_TYPE(UByte2);
158 ADD_TYPE(UByte3);
159 ADD_TYPE(UByte4);
ethannicholasb3058bd2016-07-01 08:22:01 -0700160 ADD_TYPE(Bool);
Ethan Nicholas5af9ea32017-07-28 15:19:46 -0400161 ADD_TYPE(Bool2);
162 ADD_TYPE(Bool3);
163 ADD_TYPE(Bool4);
164 ADD_TYPE(Float2x2);
165 ADD_TYPE(Float2x3);
166 ADD_TYPE(Float2x4);
167 ADD_TYPE(Float3x2);
168 ADD_TYPE(Float3x3);
169 ADD_TYPE(Float3x4);
170 ADD_TYPE(Float4x2);
171 ADD_TYPE(Float4x3);
172 ADD_TYPE(Float4x4);
Ethan Nicholasdcba08e2017-08-02 10:52:54 -0400173 ADD_TYPE(Half2x2);
174 ADD_TYPE(Half2x3);
175 ADD_TYPE(Half2x4);
176 ADD_TYPE(Half3x2);
177 ADD_TYPE(Half3x3);
178 ADD_TYPE(Half3x4);
179 ADD_TYPE(Half4x2);
180 ADD_TYPE(Half4x3);
181 ADD_TYPE(Half4x4);
ethannicholasb3058bd2016-07-01 08:22:01 -0700182 ADD_TYPE(GenType);
Ethan Nicholasdcba08e2017-08-02 10:52:54 -0400183 ADD_TYPE(GenHType);
ethannicholasb3058bd2016-07-01 08:22:01 -0700184 ADD_TYPE(GenIType);
185 ADD_TYPE(GenUType);
186 ADD_TYPE(GenBType);
187 ADD_TYPE(Mat);
188 ADD_TYPE(Vec);
189 ADD_TYPE(GVec);
190 ADD_TYPE(GVec2);
191 ADD_TYPE(GVec3);
192 ADD_TYPE(GVec4);
Ethan Nicholasdcba08e2017-08-02 10:52:54 -0400193 ADD_TYPE(HVec);
ethannicholasb3058bd2016-07-01 08:22:01 -0700194 ADD_TYPE(IVec);
195 ADD_TYPE(UVec);
Ethan Nicholasdcba08e2017-08-02 10:52:54 -0400196 ADD_TYPE(SVec);
197 ADD_TYPE(USVec);
Ruiqi Maob609e6d2018-07-17 10:19:38 -0400198 ADD_TYPE(ByteVec);
199 ADD_TYPE(UByteVec);
ethannicholasb3058bd2016-07-01 08:22:01 -0700200 ADD_TYPE(BVec);
201
202 ADD_TYPE(Sampler1D);
203 ADD_TYPE(Sampler2D);
204 ADD_TYPE(Sampler3D);
ethannicholas5961bc92016-10-12 06:39:56 -0700205 ADD_TYPE(SamplerExternalOES);
ethannicholasb3058bd2016-07-01 08:22:01 -0700206 ADD_TYPE(SamplerCube);
207 ADD_TYPE(Sampler2DRect);
208 ADD_TYPE(Sampler1DArray);
209 ADD_TYPE(Sampler2DArray);
210 ADD_TYPE(SamplerCubeArray);
211 ADD_TYPE(SamplerBuffer);
212 ADD_TYPE(Sampler2DMS);
213 ADD_TYPE(Sampler2DMSArray);
214
Brian Salomonbf7b6202016-11-11 16:08:03 -0500215 ADD_TYPE(ISampler2D);
216
Brian Salomon2a51de82016-11-16 12:06:01 -0500217 ADD_TYPE(Image2D);
218 ADD_TYPE(IImage2D);
219
Greg Daniel64773e62016-11-22 09:44:03 -0500220 ADD_TYPE(SubpassInput);
221 ADD_TYPE(SubpassInputMS);
222
ethannicholasb3058bd2016-07-01 08:22:01 -0700223 ADD_TYPE(GSampler1D);
224 ADD_TYPE(GSampler2D);
225 ADD_TYPE(GSampler3D);
226 ADD_TYPE(GSamplerCube);
227 ADD_TYPE(GSampler2DRect);
228 ADD_TYPE(GSampler1DArray);
229 ADD_TYPE(GSampler2DArray);
230 ADD_TYPE(GSamplerCubeArray);
231 ADD_TYPE(GSamplerBuffer);
232 ADD_TYPE(GSampler2DMS);
233 ADD_TYPE(GSampler2DMSArray);
234
235 ADD_TYPE(Sampler1DShadow);
236 ADD_TYPE(Sampler2DShadow);
237 ADD_TYPE(SamplerCubeShadow);
238 ADD_TYPE(Sampler2DRectShadow);
239 ADD_TYPE(Sampler1DArrayShadow);
240 ADD_TYPE(Sampler2DArrayShadow);
241 ADD_TYPE(SamplerCubeArrayShadow);
242 ADD_TYPE(GSampler2DArrayShadow);
243 ADD_TYPE(GSamplerCubeArrayShadow);
Ethan Nicholasc9472af2017-10-10 16:30:21 -0400244 ADD_TYPE(FragmentProcessor);
Stephen Whiteff5d7a22019-07-26 17:42:06 -0400245 ADD_TYPE(Sampler);
246 ADD_TYPE(Texture2D);
ethannicholasb3058bd2016-07-01 08:22:01 -0700247
Brian Osman28590d52020-03-23 16:59:08 -0400248 StringFragment fpAliasName("shader");
John Stiles49a547f2020-10-06 16:14:37 -0400249 fRootSymbolTable->addAlias(fpAliasName, fContext->fFragmentProcessor_Type.get());
Brian Osman28590d52020-03-23 16:59:08 -0400250
Brian Osman3887a012020-09-30 13:22:27 -0400251 // sk_Caps is "builtin", but all references to it are resolved to Settings, so we don't need to
252 // treat it as builtin (ie, no need to clone it into the Program).
Ethan Nicholas5b5f0962017-09-11 13:50:14 -0700253 StringFragment skCapsName("sk_Caps");
John Stilesb8cc6652020-10-08 09:12:07 -0400254 fRootSymbolTable->add(std::make_unique<Variable>(/*offset=*/-1,
Ethan Nicholas041fd0a2020-10-07 16:42:04 -0400255 fIRGenerator->fModifiers->handle(Modifiers()),
256 skCapsName, fContext->fSkCaps_Type.get(),
Brian Osman3887a012020-09-30 13:22:27 -0400257 /*builtin=*/false, Variable::kGlobal_Storage));
Ethan Nicholas3605ace2016-11-21 15:59:48 -0500258
Brian Osman00a8b5b2020-10-02 09:06:04 -0400259 fIRGenerator->fIntrinsics = nullptr;
260 std::vector<std::unique_ptr<ProgramElement>> gpuElements;
Brian Osmanafa18ee2020-10-07 17:47:45 -0400261 std::vector<std::unique_ptr<ProgramElement>> vertElements;
Brian Osman00a8b5b2020-10-02 09:06:04 -0400262 std::vector<std::unique_ptr<ProgramElement>> fragElements;
Brian Osmandd496172020-08-08 08:17:18 -0400263#if SKSL_STANDALONE
Brian Osmaneac49832020-09-18 11:49:22 -0400264 this->processIncludeFile(Program::kFragment_Kind, SKSL_GPU_INCLUDE, fRootSymbolTable,
Brian Osman00a8b5b2020-10-02 09:06:04 -0400265 &gpuElements, &fGpuSymbolTable);
Ethan Nicholasb33fa3f2020-08-06 13:00:19 -0400266 this->processIncludeFile(Program::kVertex_Kind, SKSL_VERT_INCLUDE, fGpuSymbolTable,
Brian Osmanafa18ee2020-10-07 17:47:45 -0400267 &vertElements, &fVertexSymbolTable);
Ethan Nicholasb33fa3f2020-08-06 13:00:19 -0400268 this->processIncludeFile(Program::kFragment_Kind, SKSL_FRAG_INCLUDE, fGpuSymbolTable,
Brian Osman00a8b5b2020-10-02 09:06:04 -0400269 &fragElements, &fFragmentSymbolTable);
Ethan Nicholasc18bb512020-07-28 14:46:53 -0400270#else
271 {
Ethan Nicholas041fd0a2020-10-07 16:42:04 -0400272 Rehydrator rehydrator(&fIRGenerator->fContext, fIRGenerator->fModifiers.get(),
273 fRootSymbolTable, this, SKSL_INCLUDE_sksl_gpu,
Brian Osmaneac49832020-09-18 11:49:22 -0400274 SKSL_INCLUDE_sksl_gpu_LENGTH);
Ethan Nicholasc18bb512020-07-28 14:46:53 -0400275 fGpuSymbolTable = rehydrator.symbolTable();
Brian Osman00a8b5b2020-10-02 09:06:04 -0400276 gpuElements = rehydrator.elements();
Ethan Nicholas041fd0a2020-10-07 16:42:04 -0400277 fModifiers.push_back(fIRGenerator->releaseModifiers());
Ethan Nicholasc18bb512020-07-28 14:46:53 -0400278 }
279 {
Ethan Nicholas041fd0a2020-10-07 16:42:04 -0400280 Rehydrator rehydrator(&fIRGenerator->fContext, fIRGenerator->fModifiers.get(),
281 fGpuSymbolTable, this, SKSL_INCLUDE_sksl_vert,
Brian Osmaneac49832020-09-18 11:49:22 -0400282 SKSL_INCLUDE_sksl_vert_LENGTH);
Ethan Nicholasc18bb512020-07-28 14:46:53 -0400283 fVertexSymbolTable = rehydrator.symbolTable();
Brian Osmanafa18ee2020-10-07 17:47:45 -0400284 vertElements = rehydrator.elements();
Ethan Nicholas041fd0a2020-10-07 16:42:04 -0400285 fModifiers.push_back(fIRGenerator->releaseModifiers());
Ethan Nicholasc18bb512020-07-28 14:46:53 -0400286 }
287 {
Ethan Nicholas041fd0a2020-10-07 16:42:04 -0400288 Rehydrator rehydrator(&fIRGenerator->fContext, fIRGenerator->fModifiers.get(),
289 fGpuSymbolTable, this, SKSL_INCLUDE_sksl_frag,
Brian Osmaneac49832020-09-18 11:49:22 -0400290 SKSL_INCLUDE_sksl_frag_LENGTH);
Ethan Nicholasc18bb512020-07-28 14:46:53 -0400291 fFragmentSymbolTable = rehydrator.symbolTable();
Brian Osman00a8b5b2020-10-02 09:06:04 -0400292 fragElements = rehydrator.elements();
Ethan Nicholas041fd0a2020-10-07 16:42:04 -0400293 fModifiers.push_back(fIRGenerator->releaseModifiers());
Ethan Nicholasc18bb512020-07-28 14:46:53 -0400294 }
295#endif
John Stilesbc0c29e2020-09-28 13:13:40 -0400296 // Call counts are used to track dead-stripping and inlinability within the program being
297 // currently compiled, and always should start at zero for a new program. Zero out any call
298 // counts that were registered during the assembly of the intrinsics/include data. (If we
299 // actually use calls from inside the intrinsics, we will clone them into the program and they
300 // will get new call counts.)
Brian Osman00a8b5b2020-10-02 09:06:04 -0400301 reset_call_counts(&gpuElements);
Brian Osmanafa18ee2020-10-07 17:47:45 -0400302 reset_call_counts(&vertElements);
Brian Osman00a8b5b2020-10-02 09:06:04 -0400303 reset_call_counts(&fragElements);
John Stilesbc0c29e2020-09-28 13:13:40 -0400304
Brian Osman00a8b5b2020-10-02 09:06:04 -0400305 fGPUIntrinsics = std::make_unique<IRIntrinsicMap>(/*parent=*/nullptr);
306 grab_intrinsics(&gpuElements, fGPUIntrinsics.get());
307
Brian Osmanafa18ee2020-10-07 17:47:45 -0400308 fVertexIntrinsics = std::make_unique<IRIntrinsicMap>(fGPUIntrinsics.get());
309 grab_intrinsics(&vertElements, fVertexIntrinsics.get());
310
Brian Osman00a8b5b2020-10-02 09:06:04 -0400311 fFragmentIntrinsics = std::make_unique<IRIntrinsicMap>(fGPUIntrinsics.get());
312 grab_intrinsics(&fragElements, fFragmentIntrinsics.get());
ethannicholasb3058bd2016-07-01 08:22:01 -0700313}
314
John Stiles656427a2020-08-27 15:26:26 -0400315Compiler::~Compiler() {}
ethannicholasb3058bd2016-07-01 08:22:01 -0700316
Ethan Nicholasc18bb512020-07-28 14:46:53 -0400317void Compiler::loadGeometryIntrinsics() {
318 if (fGeometrySymbolTable) {
319 return;
320 }
Brian Osmanafa18ee2020-10-07 17:47:45 -0400321 fGeometryIntrinsics = std::make_unique<IRIntrinsicMap>(fGPUIntrinsics.get());
322 std::vector<std::unique_ptr<ProgramElement>> geomElements;
Brian Osmandd496172020-08-08 08:17:18 -0400323 #if !SKSL_STANDALONE
Ethan Nicholasc18bb512020-07-28 14:46:53 -0400324 {
Ethan Nicholas041fd0a2020-10-07 16:42:04 -0400325 Rehydrator rehydrator(&fIRGenerator->fContext, fIRGenerator->fModifiers.get(),
326 fGpuSymbolTable, this, SKSL_INCLUDE_sksl_geom,
327 SKSL_INCLUDE_sksl_geom_LENGTH);
Ethan Nicholasc18bb512020-07-28 14:46:53 -0400328 fGeometrySymbolTable = rehydrator.symbolTable();
Brian Osmanafa18ee2020-10-07 17:47:45 -0400329 geomElements = rehydrator.elements();
Ethan Nicholas041fd0a2020-10-07 16:42:04 -0400330 fModifiers.push_back(fIRGenerator->releaseModifiers());
Ethan Nicholasc18bb512020-07-28 14:46:53 -0400331 }
332 #else
Ethan Nicholasb33fa3f2020-08-06 13:00:19 -0400333 this->processIncludeFile(Program::kGeometry_Kind, SKSL_GEOM_INCLUDE, fGpuSymbolTable,
Brian Osmanafa18ee2020-10-07 17:47:45 -0400334 &geomElements, &fGeometrySymbolTable);
Ethan Nicholasc18bb512020-07-28 14:46:53 -0400335 #endif
Brian Osmanafa18ee2020-10-07 17:47:45 -0400336 grab_intrinsics(&geomElements, fGeometryIntrinsics.get());
Ethan Nicholasc18bb512020-07-28 14:46:53 -0400337}
338
Brian Osman8e2ef022020-09-30 13:26:43 -0400339void Compiler::loadFPIntrinsics() {
340 if (fFPSymbolTable) {
341 return;
342 }
343 fFPIntrinsics = std::make_unique<IRIntrinsicMap>(fGPUIntrinsics.get());
344 std::vector<std::unique_ptr<ProgramElement>> fpElements;
345 #if !SKSL_STANDALONE
346 {
Ethan Nicholas041fd0a2020-10-07 16:42:04 -0400347 Rehydrator rehydrator(&fIRGenerator->fContext, fIRGenerator->fModifiers.get(),
348 fGpuSymbolTable, this, SKSL_INCLUDE_sksl_fp,
Brian Osman8e2ef022020-09-30 13:26:43 -0400349 SKSL_INCLUDE_sksl_fp_LENGTH);
350 fFPSymbolTable = rehydrator.symbolTable();
351 fpElements = rehydrator.elements();
352 }
353 #else
354 this->processIncludeFile(Program::kFragmentProcessor_Kind, SKSL_FP_INCLUDE, fGpuSymbolTable,
355 &fpElements, &fFPSymbolTable);
356 #endif
357 grab_intrinsics(&fpElements, fFPIntrinsics.get());
Brian Osman8e2ef022020-09-30 13:26:43 -0400358}
359
Ethan Nicholasc18bb512020-07-28 14:46:53 -0400360void Compiler::loadPipelineIntrinsics() {
361 if (fPipelineSymbolTable) {
362 return;
363 }
Brian Osman00a8b5b2020-10-02 09:06:04 -0400364 fPipelineIntrinsics = std::make_unique<IRIntrinsicMap>(fGPUIntrinsics.get());
Brian Osman8e2ef022020-09-30 13:26:43 -0400365 std::vector<std::unique_ptr<ProgramElement>> pipelineIntrinics;
Brian Osmandd496172020-08-08 08:17:18 -0400366 #if !SKSL_STANDALONE
Ethan Nicholasc18bb512020-07-28 14:46:53 -0400367 {
Ethan Nicholas041fd0a2020-10-07 16:42:04 -0400368 Rehydrator rehydrator(&fIRGenerator->fContext, fIRGenerator->fModifiers.get(),
369 fGpuSymbolTable, this, SKSL_INCLUDE_sksl_pipeline,
Ethan Nicholasc18bb512020-07-28 14:46:53 -0400370 SKSL_INCLUDE_sksl_pipeline_LENGTH);
371 fPipelineSymbolTable = rehydrator.symbolTable();
Brian Osman8e2ef022020-09-30 13:26:43 -0400372 pipelineIntrinics = rehydrator.elements();
Ethan Nicholas041fd0a2020-10-07 16:42:04 -0400373 fModifiers.push_back(fIRGenerator->releaseModifiers());
Ethan Nicholasc18bb512020-07-28 14:46:53 -0400374 }
375 #else
376 this->processIncludeFile(Program::kPipelineStage_Kind, SKSL_PIPELINE_INCLUDE,
Brian Osman8e2ef022020-09-30 13:26:43 -0400377 fGpuSymbolTable, &pipelineIntrinics, &fPipelineSymbolTable);
Ethan Nicholasc18bb512020-07-28 14:46:53 -0400378 #endif
Brian Osman8e2ef022020-09-30 13:26:43 -0400379 grab_intrinsics(&pipelineIntrinics, fPipelineIntrinsics.get());
Ethan Nicholasc18bb512020-07-28 14:46:53 -0400380}
381
382void Compiler::loadInterpreterIntrinsics() {
383 if (fInterpreterSymbolTable) {
384 return;
385 }
Brian Osman00a8b5b2020-10-02 09:06:04 -0400386 fInterpreterIntrinsics = std::make_unique<IRIntrinsicMap>(/*parent=*/nullptr);
387 std::vector<std::unique_ptr<ProgramElement>> interpElements;
Brian Osmandd496172020-08-08 08:17:18 -0400388 #if !SKSL_STANDALONE
Ethan Nicholasc18bb512020-07-28 14:46:53 -0400389 {
Ethan Nicholas041fd0a2020-10-07 16:42:04 -0400390 Rehydrator rehydrator(&fIRGenerator->fContext, fIRGenerator->fModifiers.get(),
391 fRootSymbolTable, this, SKSL_INCLUDE_sksl_interp,
Ethan Nicholasc18bb512020-07-28 14:46:53 -0400392 SKSL_INCLUDE_sksl_interp_LENGTH);
393 fInterpreterSymbolTable = rehydrator.symbolTable();
Brian Osman00a8b5b2020-10-02 09:06:04 -0400394 interpElements = rehydrator.elements();
Ethan Nicholas041fd0a2020-10-07 16:42:04 -0400395 fModifiers.push_back(fIRGenerator->releaseModifiers());
Ethan Nicholasc18bb512020-07-28 14:46:53 -0400396 }
397 #else
398 this->processIncludeFile(Program::kGeneric_Kind, SKSL_INTERP_INCLUDE,
Brian Osman00a8b5b2020-10-02 09:06:04 -0400399 fIRGenerator->fSymbolTable, &interpElements,
Ethan Nicholasb33fa3f2020-08-06 13:00:19 -0400400 &fInterpreterSymbolTable);
Ethan Nicholasc18bb512020-07-28 14:46:53 -0400401 #endif
Brian Osman00a8b5b2020-10-02 09:06:04 -0400402 grab_intrinsics(&interpElements, fInterpreterIntrinsics.get());
Ethan Nicholasc18bb512020-07-28 14:46:53 -0400403}
404
Ethan Nicholasb33fa3f2020-08-06 13:00:19 -0400405void Compiler::processIncludeFile(Program::Kind kind, const char* path,
Ethan Nicholas8da1e652019-05-24 11:01:59 -0400406 std::shared_ptr<SymbolTable> base,
407 std::vector<std::unique_ptr<ProgramElement>>* outElements,
408 std::shared_ptr<SymbolTable>* outSymbolTable) {
Ethan Nicholasb33fa3f2020-08-06 13:00:19 -0400409 std::ifstream in(path);
Brian Osmane498b3c2020-09-23 14:42:11 -0400410 std::unique_ptr<String> text = std::make_unique<String>(std::istreambuf_iterator<char>(in),
411 std::istreambuf_iterator<char>());
Ethan Nicholasb33fa3f2020-08-06 13:00:19 -0400412 if (in.rdstate()) {
413 printf("error reading %s\n", path);
414 abort();
415 }
Brian Osmane498b3c2020-09-23 14:42:11 -0400416 const String* source = fRootSymbolTable->takeOwnershipOfString(std::move(text));
Ethan Nicholasb33fa3f2020-08-06 13:00:19 -0400417 fSource = source;
Ethan Nicholas8da1e652019-05-24 11:01:59 -0400418 Program::Settings settings;
Ethan Nicholasa11035b2019-11-26 16:27:47 -0500419#if !defined(SKSL_STANDALONE) & SK_SUPPORT_GPU
420 GrContextOptions opts;
421 GrShaderCaps caps(opts);
422 settings.fCaps = &caps;
423#endif
John Stiles881a10c2020-09-19 10:13:24 -0400424 SkASSERT(fIRGenerator->fCanInline);
425 fIRGenerator->fCanInline = false;
Brian Osmane3dcb132020-10-08 10:27:29 -0400426 fIRGenerator->start(&settings, base ? base : fRootSymbolTable, true);
Ethan Nicholasb33fa3f2020-08-06 13:00:19 -0400427 fIRGenerator->convertProgram(kind, source->c_str(), source->length(), outElements);
John Stiles881a10c2020-09-19 10:13:24 -0400428 fIRGenerator->fCanInline = true;
Ethan Nicholas8da1e652019-05-24 11:01:59 -0400429 if (this->fErrorCount) {
430 printf("Unexpected errors: %s\n", this->fErrorText.c_str());
John Stiles88f3b682020-10-06 13:37:52 -0400431 SkDEBUGFAILF("%s %s\n", path, this->fErrorText.c_str());
Ethan Nicholas8da1e652019-05-24 11:01:59 -0400432 }
Ethan Nicholas8da1e652019-05-24 11:01:59 -0400433 *outSymbolTable = fIRGenerator->fSymbolTable;
Ethan Nicholasa11035b2019-11-26 16:27:47 -0500434#ifdef SK_DEBUG
435 fSource = nullptr;
436#endif
Ethan Nicholas041fd0a2020-10-07 16:42:04 -0400437 fModifiers.push_back(fIRGenerator->releaseModifiers());
Brian Osmane498b3c2020-09-23 14:42:11 -0400438 fIRGenerator->finish();
Ethan Nicholas8da1e652019-05-24 11:01:59 -0400439}
440
ethannicholas22f939e2016-10-13 13:25:34 -0700441// add the definition created by assigning to the lvalue to the definition set
Ethan Nicholas86a43402017-01-19 13:32:00 -0500442void Compiler::addDefinition(const Expression* lvalue, std::unique_ptr<Expression>* expr,
443 DefinitionMap* definitions) {
Ethan Nicholase6592142020-09-08 10:22:09 -0400444 switch (lvalue->kind()) {
445 case Expression::Kind::kVariableReference: {
Ethan Nicholas78686922020-10-08 06:46:27 -0400446 const Variable& var = *lvalue->as<VariableReference>().variable();
Ethan Nicholas041fd0a2020-10-07 16:42:04 -0400447 if (var.storage() == Variable::kLocal_Storage) {
John Stiles796cdb72020-10-08 12:06:53 -0400448 definitions->set(&var, expr);
ethannicholas22f939e2016-10-13 13:25:34 -0700449 }
450 break;
451 }
Ethan Nicholase6592142020-09-08 10:22:09 -0400452 case Expression::Kind::kSwizzle:
ethannicholas22f939e2016-10-13 13:25:34 -0700453 // We consider the variable written to as long as at least some of its components have
454 // been written to. This will lead to some false negatives (we won't catch it if you
455 // write to foo.x and then read foo.y), but being stricter could lead to false positives
Mike Klein6ad99092016-10-26 10:35:22 -0400456 // (we write to foo.x, and then pass foo to a function which happens to only read foo.x,
457 // 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 -0700458 // more complicated whole-program analysis. This is probably good enough.
John Stilesa5a97b42020-08-18 11:19:07 -0400459 this->addDefinition(lvalue->as<Swizzle>().fBase.get(),
Ethan Nicholas26a9aad2018-03-27 14:10:52 -0400460 (std::unique_ptr<Expression>*) &fContext->fDefined_Expression,
ethannicholas22f939e2016-10-13 13:25:34 -0700461 definitions);
462 break;
Ethan Nicholase6592142020-09-08 10:22:09 -0400463 case Expression::Kind::kIndex:
ethannicholas22f939e2016-10-13 13:25:34 -0700464 // see comments in Swizzle
John Stilesa5a97b42020-08-18 11:19:07 -0400465 this->addDefinition(lvalue->as<IndexExpression>().fBase.get(),
Ethan Nicholas26a9aad2018-03-27 14:10:52 -0400466 (std::unique_ptr<Expression>*) &fContext->fDefined_Expression,
ethannicholas22f939e2016-10-13 13:25:34 -0700467 definitions);
468 break;
Ethan Nicholase6592142020-09-08 10:22:09 -0400469 case Expression::Kind::kFieldAccess:
ethannicholas22f939e2016-10-13 13:25:34 -0700470 // see comments in Swizzle
John Stilesa5a97b42020-08-18 11:19:07 -0400471 this->addDefinition(lvalue->as<FieldAccess>().fBase.get(),
Ethan Nicholas26a9aad2018-03-27 14:10:52 -0400472 (std::unique_ptr<Expression>*) &fContext->fDefined_Expression,
ethannicholas22f939e2016-10-13 13:25:34 -0700473 definitions);
474 break;
Ethan Nicholase6592142020-09-08 10:22:09 -0400475 case Expression::Kind::kTernary:
Ethan Nicholasa583b812018-01-18 13:32:11 -0500476 // To simplify analysis, we just pretend that we write to both sides of the ternary.
477 // This allows for false positives (meaning we fail to detect that a variable might not
478 // have been assigned), but is preferable to false negatives.
Ethan Nicholasdd218162020-10-08 05:48:01 -0400479 this->addDefinition(lvalue->as<TernaryExpression>().ifTrue().get(),
Ethan Nicholas26a9aad2018-03-27 14:10:52 -0400480 (std::unique_ptr<Expression>*) &fContext->fDefined_Expression,
Ethan Nicholasa583b812018-01-18 13:32:11 -0500481 definitions);
Ethan Nicholasdd218162020-10-08 05:48:01 -0400482 this->addDefinition(lvalue->as<TernaryExpression>().ifFalse().get(),
Ethan Nicholas26a9aad2018-03-27 14:10:52 -0400483 (std::unique_ptr<Expression>*) &fContext->fDefined_Expression,
Ethan Nicholasa583b812018-01-18 13:32:11 -0500484 definitions);
485 break;
Ethan Nicholase6592142020-09-08 10:22:09 -0400486 case Expression::Kind::kExternalValue:
Ethan Nicholas91164d12019-05-15 15:29:54 -0400487 break;
ethannicholas22f939e2016-10-13 13:25:34 -0700488 default:
489 // not an lvalue, can't happen
Ethan Nicholasd9d33c32018-06-12 11:05:59 -0400490 SkASSERT(false);
ethannicholas22f939e2016-10-13 13:25:34 -0700491 }
492}
493
494// add local variables defined by this node to the set
John Stiles796cdb72020-10-08 12:06:53 -0400495void Compiler::addDefinitions(const BasicBlock::Node& node, DefinitionMap* definitions) {
John Stiles70025e52020-09-28 16:08:58 -0400496 if (node.isExpression()) {
497 Expression* expr = node.expression()->get();
498 switch (expr->kind()) {
499 case Expression::Kind::kBinary: {
500 BinaryExpression* b = &expr->as<BinaryExpression>();
501 if (b->getOperator() == Token::Kind::TK_EQ) {
502 this->addDefinition(&b->left(), &b->rightPointer(), definitions);
503 } else if (Compiler::IsAssignment(b->getOperator())) {
504 this->addDefinition(
505 &b->left(),
506 (std::unique_ptr<Expression>*) &fContext->fDefined_Expression,
507 definitions);
Ethan Nicholas86a43402017-01-19 13:32:00 -0500508
ethannicholas22f939e2016-10-13 13:25:34 -0700509 }
John Stiles70025e52020-09-28 16:08:58 -0400510 break;
ethannicholas22f939e2016-10-13 13:25:34 -0700511 }
John Stiles70025e52020-09-28 16:08:58 -0400512 case Expression::Kind::kFunctionCall: {
513 const FunctionCall& c = expr->as<FunctionCall>();
Ethan Nicholased84b732020-10-08 11:45:44 -0400514 const std::vector<Variable*>& parameters = c.function().parameters();
515 for (size_t i = 0; i < parameters.size(); ++i) {
516 if (parameters[i]->modifiers().fFlags & Modifiers::kOut_Flag) {
John Stiles70025e52020-09-28 16:08:58 -0400517 this->addDefinition(
Ethan Nicholas0dec9922020-10-05 15:51:52 -0400518 c.arguments()[i].get(),
John Stiles70025e52020-09-28 16:08:58 -0400519 (std::unique_ptr<Expression>*) &fContext->fDefined_Expression,
520 definitions);
521 }
522 }
523 break;
524 }
525 case Expression::Kind::kPrefix: {
526 const PrefixExpression* p = &expr->as<PrefixExpression>();
527 if (p->fOperator == Token::Kind::TK_MINUSMINUS ||
528 p->fOperator == Token::Kind::TK_PLUSPLUS) {
529 this->addDefinition(
530 p->fOperand.get(),
531 (std::unique_ptr<Expression>*) &fContext->fDefined_Expression,
532 definitions);
533 }
534 break;
535 }
536 case Expression::Kind::kPostfix: {
537 const PostfixExpression* p = &expr->as<PostfixExpression>();
538 if (p->fOperator == Token::Kind::TK_MINUSMINUS ||
539 p->fOperator == Token::Kind::TK_PLUSPLUS) {
540 this->addDefinition(
541 p->fOperand.get(),
542 (std::unique_ptr<Expression>*) &fContext->fDefined_Expression,
543 definitions);
544 }
545 break;
546 }
547 case Expression::Kind::kVariableReference: {
548 const VariableReference* v = &expr->as<VariableReference>();
Ethan Nicholas78686922020-10-08 06:46:27 -0400549 if (v->refKind() != VariableReference::kRead_RefKind) {
John Stiles70025e52020-09-28 16:08:58 -0400550 this->addDefinition(
551 v,
552 (std::unique_ptr<Expression>*) &fContext->fDefined_Expression,
553 definitions);
554 }
555 break;
556 }
557 default:
558 break;
ethannicholas22f939e2016-10-13 13:25:34 -0700559 }
John Stiles70025e52020-09-28 16:08:58 -0400560 } else if (node.isStatement()) {
561 Statement* stmt = node.statement()->get();
562 if (stmt->is<VarDeclaration>()) {
563 VarDeclaration& vd = stmt->as<VarDeclaration>();
564 if (vd.fValue) {
John Stiles796cdb72020-10-08 12:06:53 -0400565 definitions->set(vd.fVar, &vd.fValue);
ethannicholas22f939e2016-10-13 13:25:34 -0700566 }
ethannicholas22f939e2016-10-13 13:25:34 -0700567 }
568 }
569}
570
John Stilese6150002020-10-05 12:03:53 -0400571void Compiler::scanCFG(CFG* cfg, BlockId blockId, SkBitSet* processedSet) {
ethannicholas22f939e2016-10-13 13:25:34 -0700572 BasicBlock& block = cfg->fBlocks[blockId];
573
574 // compute definitions after this block
Ethan Nicholas86a43402017-01-19 13:32:00 -0500575 DefinitionMap after = block.fBefore;
ethannicholas22f939e2016-10-13 13:25:34 -0700576 for (const BasicBlock::Node& n : block.fNodes) {
577 this->addDefinitions(n, &after);
578 }
579
580 // propagate definitions to exits
581 for (BlockId exitId : block.fExits) {
Ethan Nicholas26a9aad2018-03-27 14:10:52 -0400582 if (exitId == blockId) {
583 continue;
584 }
ethannicholas22f939e2016-10-13 13:25:34 -0700585 BasicBlock& exit = cfg->fBlocks[exitId];
John Stiles796cdb72020-10-08 12:06:53 -0400586 after.foreach([&](const Variable* var, std::unique_ptr<Expression>** e1Ptr) {
587 std::unique_ptr<Expression>* e1 = *e1Ptr;
588 std::unique_ptr<Expression>** exitDef = exit.fBefore.find(var);
589 if (!exitDef) {
John Stilese6150002020-10-05 12:03:53 -0400590 // exit has no definition for it, just copy it and reprocess exit block
591 processedSet->reset(exitId);
John Stiles796cdb72020-10-08 12:06:53 -0400592 exit.fBefore[var] = e1;
ethannicholas22f939e2016-10-13 13:25:34 -0700593 } else {
Ethan Nicholas86a43402017-01-19 13:32:00 -0500594 // exit has a (possibly different) value already defined
John Stiles796cdb72020-10-08 12:06:53 -0400595 std::unique_ptr<Expression>* e2 = *exitDef;
ethannicholas22f939e2016-10-13 13:25:34 -0700596 if (e1 != e2) {
John Stilese6150002020-10-05 12:03:53 -0400597 // definition has changed, merge and reprocess the exit block
598 processedSet->reset(exitId);
Ethan Nicholasaf197692017-02-27 13:26:45 -0500599 if (e1 && e2) {
John Stiles796cdb72020-10-08 12:06:53 -0400600 *exitDef = (std::unique_ptr<Expression>*)&fContext->fDefined_Expression;
Ethan Nicholasaf197692017-02-27 13:26:45 -0500601 } else {
John Stiles796cdb72020-10-08 12:06:53 -0400602 *exitDef = nullptr;
Ethan Nicholasaf197692017-02-27 13:26:45 -0500603 }
ethannicholas22f939e2016-10-13 13:25:34 -0700604 }
605 }
John Stiles796cdb72020-10-08 12:06:53 -0400606 });
ethannicholas22f939e2016-10-13 13:25:34 -0700607 }
608}
609
610// returns a map which maps all local variables in the function to null, indicating that their value
611// is initially unknown
Ethan Nicholas86a43402017-01-19 13:32:00 -0500612static DefinitionMap compute_start_state(const CFG& cfg) {
613 DefinitionMap result;
Mike Klein6ad99092016-10-26 10:35:22 -0400614 for (const auto& block : cfg.fBlocks) {
615 for (const auto& node : block.fNodes) {
John Stiles70025e52020-09-28 16:08:58 -0400616 if (node.isStatement()) {
Ethan Nicholascb670962017-04-20 19:31:52 -0400617 const Statement* s = node.statement()->get();
Brian Osmanc0213602020-10-06 14:43:32 -0400618 if (s->is<VarDeclaration>()) {
619 result[s->as<VarDeclaration>().fVar] = nullptr;
ethannicholas22f939e2016-10-13 13:25:34 -0700620 }
621 }
622 }
623 }
624 return result;
625}
626
Ethan Nicholascb670962017-04-20 19:31:52 -0400627/**
628 * Returns true if assigning to this lvalue has no effect.
629 */
630static bool is_dead(const Expression& lvalue) {
Ethan Nicholase6592142020-09-08 10:22:09 -0400631 switch (lvalue.kind()) {
632 case Expression::Kind::kVariableReference:
Ethan Nicholas78686922020-10-08 06:46:27 -0400633 return lvalue.as<VariableReference>().variable()->dead();
Ethan Nicholase6592142020-09-08 10:22:09 -0400634 case Expression::Kind::kSwizzle:
John Stilesa5a97b42020-08-18 11:19:07 -0400635 return is_dead(*lvalue.as<Swizzle>().fBase);
Ethan Nicholase6592142020-09-08 10:22:09 -0400636 case Expression::Kind::kFieldAccess:
John Stilesa5a97b42020-08-18 11:19:07 -0400637 return is_dead(*lvalue.as<FieldAccess>().fBase);
Ethan Nicholase6592142020-09-08 10:22:09 -0400638 case Expression::Kind::kIndex: {
John Stilesa5a97b42020-08-18 11:19:07 -0400639 const IndexExpression& idx = lvalue.as<IndexExpression>();
Ethan Nicholas2a099da2020-01-02 14:40:54 -0500640 return is_dead(*idx.fBase) &&
641 !idx.fIndex->hasProperty(Expression::Property::kSideEffects);
Ethan Nicholascb670962017-04-20 19:31:52 -0400642 }
Ethan Nicholase6592142020-09-08 10:22:09 -0400643 case Expression::Kind::kTernary: {
John Stilesa5a97b42020-08-18 11:19:07 -0400644 const TernaryExpression& t = lvalue.as<TernaryExpression>();
Ethan Nicholasdd218162020-10-08 05:48:01 -0400645 return !t.test()->hasSideEffects() && is_dead(*t.ifTrue()) && is_dead(*t.ifFalse());
Ethan Nicholasa583b812018-01-18 13:32:11 -0500646 }
Ethan Nicholase6592142020-09-08 10:22:09 -0400647 case Expression::Kind::kExternalValue:
Ethan Nicholas91164d12019-05-15 15:29:54 -0400648 return false;
Ethan Nicholascb670962017-04-20 19:31:52 -0400649 default:
Ethan Nicholas2a099da2020-01-02 14:40:54 -0500650#ifdef SK_DEBUG
Ethan Nicholascb670962017-04-20 19:31:52 -0400651 ABORT("invalid lvalue: %s\n", lvalue.description().c_str());
Ethan Nicholas2a099da2020-01-02 14:40:54 -0500652#endif
653 return false;
Ethan Nicholascb670962017-04-20 19:31:52 -0400654 }
655}
ethannicholas22f939e2016-10-13 13:25:34 -0700656
Ethan Nicholascb670962017-04-20 19:31:52 -0400657/**
658 * Returns true if this is an assignment which can be collapsed down to just the right hand side due
659 * to a dead target and lack of side effects on the left hand side.
660 */
661static bool dead_assignment(const BinaryExpression& b) {
Ethan Nicholasc8d9c8e2020-09-22 15:05:37 -0400662 if (!Compiler::IsAssignment(b.getOperator())) {
Ethan Nicholascb670962017-04-20 19:31:52 -0400663 return false;
664 }
Ethan Nicholasc8d9c8e2020-09-22 15:05:37 -0400665 return is_dead(b.left());
Ethan Nicholascb670962017-04-20 19:31:52 -0400666}
667
668void Compiler::computeDataFlow(CFG* cfg) {
669 cfg->fBlocks[cfg->fStart].fBefore = compute_start_state(*cfg);
John Stilese6150002020-10-05 12:03:53 -0400670
671 // We set bits in the "processed" set after a block has been scanned.
672 SkBitSet processedSet(cfg->fBlocks.size());
673 while (SkBitSet::OptionalIndex blockId = processedSet.findFirstUnset()) {
674 processedSet.set(*blockId);
675 this->scanCFG(cfg, *blockId, &processedSet);
ethannicholas22f939e2016-10-13 13:25:34 -0700676 }
Ethan Nicholascb670962017-04-20 19:31:52 -0400677}
678
679/**
680 * Attempts to replace the expression pointed to by iter with a new one (in both the CFG and the
681 * IR). If the expression can be cleanly removed, returns true and updates the iterator to point to
682 * the newly-inserted element. Otherwise updates only the IR and returns false (and the CFG will
683 * need to be regenerated).
684 */
John Stilesafbf8992020-08-18 10:08:21 -0400685static bool try_replace_expression(BasicBlock* b,
686 std::vector<BasicBlock::Node>::iterator* iter,
687 std::unique_ptr<Expression>* newExpression) {
Ethan Nicholascb670962017-04-20 19:31:52 -0400688 std::unique_ptr<Expression>* target = (*iter)->expression();
689 if (!b->tryRemoveExpression(iter)) {
690 *target = std::move(*newExpression);
691 return false;
692 }
693 *target = std::move(*newExpression);
694 return b->tryInsertExpression(iter, target);
695}
696
697/**
Ethan Nicholasfe53e582017-04-27 16:24:51 -0400698 * Returns true if the expression is a constant numeric literal with the specified value, or a
699 * constant vector with all elements equal to the specified value.
Ethan Nicholascb670962017-04-20 19:31:52 -0400700 */
Ethan Nicholasa3f22f12020-10-01 12:13:17 -0400701template <typename T = SKSL_FLOAT>
John Stiles9d944232020-08-19 09:56:49 -0400702static bool is_constant(const Expression& expr, T value) {
Ethan Nicholase6592142020-09-08 10:22:09 -0400703 switch (expr.kind()) {
704 case Expression::Kind::kIntLiteral:
Ethan Nicholase96cdd12020-09-28 16:27:18 -0400705 return expr.as<IntLiteral>().value() == value;
John Stiles9d944232020-08-19 09:56:49 -0400706
Ethan Nicholase6592142020-09-08 10:22:09 -0400707 case Expression::Kind::kFloatLiteral:
Ethan Nicholasa3f22f12020-10-01 12:13:17 -0400708 return expr.as<FloatLiteral>().value() == value;
John Stiles9d944232020-08-19 09:56:49 -0400709
Ethan Nicholase6592142020-09-08 10:22:09 -0400710 case Expression::Kind::kConstructor: {
John Stiles9d944232020-08-19 09:56:49 -0400711 const Constructor& constructor = expr.as<Constructor>();
712 if (constructor.isCompileTimeConstant()) {
Ethan Nicholas30d30222020-09-11 12:27:26 -0400713 const Type& constructorType = constructor.type();
714 bool isFloat = constructorType.columns() > 1
715 ? constructorType.componentType().isFloat()
716 : constructorType.isFloat();
717 switch (constructorType.typeKind()) {
Ethan Nicholase6592142020-09-08 10:22:09 -0400718 case Type::TypeKind::kVector:
Ethan Nicholas30d30222020-09-11 12:27:26 -0400719 for (int i = 0; i < constructorType.columns(); ++i) {
John Stiles9d944232020-08-19 09:56:49 -0400720 if (isFloat) {
721 if (constructor.getFVecComponent(i) != value) {
722 return false;
723 }
724 } else {
725 if (constructor.getIVecComponent(i) != value) {
726 return false;
727 }
728 }
Ethan Nicholasd188c182019-06-10 15:55:38 -0400729 }
John Stiles9d944232020-08-19 09:56:49 -0400730 return true;
731
Ethan Nicholase6592142020-09-08 10:22:09 -0400732 case Type::TypeKind::kScalar:
Ethan Nicholasf70f0442020-09-29 12:41:35 -0400733 SkASSERT(constructor.arguments().size() == 1);
734 return is_constant<T>(*constructor.arguments()[0], value);
John Stiles9d944232020-08-19 09:56:49 -0400735
736 default:
Ethan Nicholasfe53e582017-04-27 16:24:51 -0400737 return false;
Ethan Nicholasfe53e582017-04-27 16:24:51 -0400738 }
Ethan Nicholasfe53e582017-04-27 16:24:51 -0400739 }
740 return false;
741 }
Ethan Nicholascb670962017-04-20 19:31:52 -0400742 default:
743 return false;
744 }
745}
746
747/**
748 * Collapses the binary expression pointed to by iter down to just the right side (in both the IR
749 * and CFG structures).
750 */
John Stilesafbf8992020-08-18 10:08:21 -0400751static void delete_left(BasicBlock* b,
752 std::vector<BasicBlock::Node>::iterator* iter,
753 bool* outUpdated,
754 bool* outNeedsRescan) {
Ethan Nicholascb670962017-04-20 19:31:52 -0400755 *outUpdated = true;
Ethan Nicholasc2371a42017-05-05 10:04:06 -0400756 std::unique_ptr<Expression>* target = (*iter)->expression();
John Stilesa5a97b42020-08-18 11:19:07 -0400757 BinaryExpression& bin = (*target)->as<BinaryExpression>();
Ethan Nicholasc8d9c8e2020-09-22 15:05:37 -0400758 Expression& left = bin.left();
759 std::unique_ptr<Expression>& rightPointer = bin.rightPointer();
760 SkASSERT(!left.hasSideEffects());
Ethan Nicholasc2371a42017-05-05 10:04:06 -0400761 bool result;
Ethan Nicholasc8d9c8e2020-09-22 15:05:37 -0400762 if (bin.getOperator() == Token::Kind::TK_EQ) {
763 result = b->tryRemoveLValueBefore(iter, &left);
Ethan Nicholasc2371a42017-05-05 10:04:06 -0400764 } else {
Ethan Nicholasc8d9c8e2020-09-22 15:05:37 -0400765 result = b->tryRemoveExpressionBefore(iter, &left);
Ethan Nicholascb670962017-04-20 19:31:52 -0400766 }
Ethan Nicholasc8d9c8e2020-09-22 15:05:37 -0400767 *target = std::move(rightPointer);
Ethan Nicholasc2371a42017-05-05 10:04:06 -0400768 if (!result) {
Ethan Nicholas4b330df2017-05-17 10:52:55 -0400769 *outNeedsRescan = true;
770 return;
771 }
772 if (*iter == b->fNodes.begin()) {
Ethan Nicholasc2371a42017-05-05 10:04:06 -0400773 *outNeedsRescan = true;
774 return;
775 }
776 --(*iter);
John Stiles70025e52020-09-28 16:08:58 -0400777 if (!(*iter)->isExpression() || (*iter)->expression() != &rightPointer) {
Ethan Nicholas4b330df2017-05-17 10:52:55 -0400778 *outNeedsRescan = true;
779 return;
780 }
Ethan Nicholasc2371a42017-05-05 10:04:06 -0400781 *iter = b->fNodes.erase(*iter);
Ethan Nicholasd9d33c32018-06-12 11:05:59 -0400782 SkASSERT((*iter)->expression() == target);
Ethan Nicholascb670962017-04-20 19:31:52 -0400783}
784
785/**
786 * Collapses the binary expression pointed to by iter down to just the left side (in both the IR and
787 * CFG structures).
788 */
John Stilesafbf8992020-08-18 10:08:21 -0400789static void delete_right(BasicBlock* b,
790 std::vector<BasicBlock::Node>::iterator* iter,
791 bool* outUpdated,
792 bool* outNeedsRescan) {
Ethan Nicholascb670962017-04-20 19:31:52 -0400793 *outUpdated = true;
Ethan Nicholasc2371a42017-05-05 10:04:06 -0400794 std::unique_ptr<Expression>* target = (*iter)->expression();
John Stilesa5a97b42020-08-18 11:19:07 -0400795 BinaryExpression& bin = (*target)->as<BinaryExpression>();
Ethan Nicholasc8d9c8e2020-09-22 15:05:37 -0400796 std::unique_ptr<Expression>& leftPointer = bin.leftPointer();
797 Expression& right = bin.right();
798 SkASSERT(!right.hasSideEffects());
799 if (!b->tryRemoveExpressionBefore(iter, &right)) {
800 *target = std::move(leftPointer);
Ethan Nicholascb670962017-04-20 19:31:52 -0400801 *outNeedsRescan = true;
Ethan Nicholasc2371a42017-05-05 10:04:06 -0400802 return;
Ethan Nicholascb670962017-04-20 19:31:52 -0400803 }
Ethan Nicholasc8d9c8e2020-09-22 15:05:37 -0400804 *target = std::move(leftPointer);
Ethan Nicholas4b330df2017-05-17 10:52:55 -0400805 if (*iter == b->fNodes.begin()) {
806 *outNeedsRescan = true;
807 return;
808 }
Ethan Nicholasc2371a42017-05-05 10:04:06 -0400809 --(*iter);
John Stiles70025e52020-09-28 16:08:58 -0400810 if ((!(*iter)->isExpression() || (*iter)->expression() != &leftPointer)) {
Ethan Nicholas4b330df2017-05-17 10:52:55 -0400811 *outNeedsRescan = true;
812 return;
813 }
Ethan Nicholasc2371a42017-05-05 10:04:06 -0400814 *iter = b->fNodes.erase(*iter);
Ethan Nicholasd9d33c32018-06-12 11:05:59 -0400815 SkASSERT((*iter)->expression() == target);
Ethan Nicholascb670962017-04-20 19:31:52 -0400816}
817
Ethan Nicholasfe53e582017-04-27 16:24:51 -0400818/**
819 * Constructs the specified type using a single argument.
820 */
Ethan Nicholas30d30222020-09-11 12:27:26 -0400821static std::unique_ptr<Expression> construct(const Type* type, std::unique_ptr<Expression> v) {
Ethan Nicholasfe53e582017-04-27 16:24:51 -0400822 std::vector<std::unique_ptr<Expression>> args;
823 args.push_back(std::move(v));
Ethan Nicholase6592142020-09-08 10:22:09 -0400824 std::unique_ptr<Expression> result = std::make_unique<Constructor>(-1, type, std::move(args));
Ethan Nicholasfe53e582017-04-27 16:24:51 -0400825 return result;
826}
827
828/**
829 * Used in the implementations of vectorize_left and vectorize_right. Given a vector type and an
830 * expression x, deletes the expression pointed to by iter and replaces it with <type>(x).
831 */
832static void vectorize(BasicBlock* b,
833 std::vector<BasicBlock::Node>::iterator* iter,
834 const Type& type,
835 std::unique_ptr<Expression>* otherExpression,
836 bool* outUpdated,
837 bool* outNeedsRescan) {
Ethan Nicholase6592142020-09-08 10:22:09 -0400838 SkASSERT((*(*iter)->expression())->kind() == Expression::Kind::kBinary);
839 SkASSERT(type.typeKind() == Type::TypeKind::kVector);
Ethan Nicholas30d30222020-09-11 12:27:26 -0400840 SkASSERT((*otherExpression)->type().typeKind() == Type::TypeKind::kScalar);
Ethan Nicholasfe53e582017-04-27 16:24:51 -0400841 *outUpdated = true;
842 std::unique_ptr<Expression>* target = (*iter)->expression();
843 if (!b->tryRemoveExpression(iter)) {
Ethan Nicholas30d30222020-09-11 12:27:26 -0400844 *target = construct(&type, std::move(*otherExpression));
Ethan Nicholasfe53e582017-04-27 16:24:51 -0400845 *outNeedsRescan = true;
846 } else {
Ethan Nicholas30d30222020-09-11 12:27:26 -0400847 *target = construct(&type, std::move(*otherExpression));
Ethan Nicholasfe53e582017-04-27 16:24:51 -0400848 if (!b->tryInsertExpression(iter, target)) {
849 *outNeedsRescan = true;
850 }
851 }
852}
853
854/**
855 * Given a binary expression of the form x <op> vec<n>(y), deletes the right side and vectorizes the
856 * left to yield vec<n>(x).
857 */
858static void vectorize_left(BasicBlock* b,
859 std::vector<BasicBlock::Node>::iterator* iter,
860 bool* outUpdated,
861 bool* outNeedsRescan) {
John Stilesa5a97b42020-08-18 11:19:07 -0400862 BinaryExpression& bin = (*(*iter)->expression())->as<BinaryExpression>();
Ethan Nicholasc8d9c8e2020-09-22 15:05:37 -0400863 vectorize(b, iter, bin.right().type(), &bin.leftPointer(), outUpdated, outNeedsRescan);
Ethan Nicholasfe53e582017-04-27 16:24:51 -0400864}
865
866/**
867 * Given a binary expression of the form vec<n>(x) <op> y, deletes the left side and vectorizes the
868 * right to yield vec<n>(y).
869 */
870static void vectorize_right(BasicBlock* b,
871 std::vector<BasicBlock::Node>::iterator* iter,
872 bool* outUpdated,
873 bool* outNeedsRescan) {
John Stilesa5a97b42020-08-18 11:19:07 -0400874 BinaryExpression& bin = (*(*iter)->expression())->as<BinaryExpression>();
Ethan Nicholasc8d9c8e2020-09-22 15:05:37 -0400875 vectorize(b, iter, bin.left().type(), &bin.rightPointer(), outUpdated, outNeedsRescan);
Ethan Nicholasfe53e582017-04-27 16:24:51 -0400876}
877
878// Mark that an expression which we were writing to is no longer being written to
John Stilesa5a97b42020-08-18 11:19:07 -0400879static void clear_write(Expression& expr) {
Ethan Nicholase6592142020-09-08 10:22:09 -0400880 switch (expr.kind()) {
881 case Expression::Kind::kVariableReference: {
John Stilesa5a97b42020-08-18 11:19:07 -0400882 expr.as<VariableReference>().setRefKind(VariableReference::kRead_RefKind);
Ethan Nicholasfe53e582017-04-27 16:24:51 -0400883 break;
884 }
Ethan Nicholase6592142020-09-08 10:22:09 -0400885 case Expression::Kind::kFieldAccess:
John Stilesa5a97b42020-08-18 11:19:07 -0400886 clear_write(*expr.as<FieldAccess>().fBase);
Ethan Nicholasfe53e582017-04-27 16:24:51 -0400887 break;
Ethan Nicholase6592142020-09-08 10:22:09 -0400888 case Expression::Kind::kSwizzle:
John Stilesa5a97b42020-08-18 11:19:07 -0400889 clear_write(*expr.as<Swizzle>().fBase);
Ethan Nicholasfe53e582017-04-27 16:24:51 -0400890 break;
Ethan Nicholase6592142020-09-08 10:22:09 -0400891 case Expression::Kind::kIndex:
John Stilesa5a97b42020-08-18 11:19:07 -0400892 clear_write(*expr.as<IndexExpression>().fBase);
Ethan Nicholasfe53e582017-04-27 16:24:51 -0400893 break;
894 default:
895 ABORT("shouldn't be writing to this kind of expression\n");
896 break;
897 }
898}
899
Ethan Nicholascb670962017-04-20 19:31:52 -0400900void Compiler::simplifyExpression(DefinitionMap& definitions,
901 BasicBlock& b,
902 std::vector<BasicBlock::Node>::iterator* iter,
903 std::unordered_set<const Variable*>* undefinedVariables,
904 bool* outUpdated,
905 bool* outNeedsRescan) {
906 Expression* expr = (*iter)->expression()->get();
Ethan Nicholasd9d33c32018-06-12 11:05:59 -0400907 SkASSERT(expr);
Ethan Nicholascb670962017-04-20 19:31:52 -0400908 if ((*iter)->fConstantPropagation) {
909 std::unique_ptr<Expression> optimized = expr->constantPropagate(*fIRGenerator, definitions);
910 if (optimized) {
Ethan Nicholas4b330df2017-05-17 10:52:55 -0400911 *outUpdated = true;
Ethan Nicholas30d30222020-09-11 12:27:26 -0400912 optimized = fIRGenerator->coerce(std::move(optimized), expr->type());
Ethan Nicholas1d881522020-09-11 09:32:54 -0400913 SkASSERT(optimized);
Ethan Nicholascb670962017-04-20 19:31:52 -0400914 if (!try_replace_expression(&b, iter, &optimized)) {
915 *outNeedsRescan = true;
Ethan Nicholas4b330df2017-05-17 10:52:55 -0400916 return;
Ethan Nicholascb670962017-04-20 19:31:52 -0400917 }
John Stiles70025e52020-09-28 16:08:58 -0400918 SkASSERT((*iter)->isExpression());
Ethan Nicholascb670962017-04-20 19:31:52 -0400919 expr = (*iter)->expression()->get();
Ethan Nicholascb670962017-04-20 19:31:52 -0400920 }
921 }
Ethan Nicholase6592142020-09-08 10:22:09 -0400922 switch (expr->kind()) {
923 case Expression::Kind::kVariableReference: {
John Stilesa5a97b42020-08-18 11:19:07 -0400924 const VariableReference& ref = expr->as<VariableReference>();
Ethan Nicholas78686922020-10-08 06:46:27 -0400925 const Variable* var = ref.variable();
Ethan Nicholas8f7e28f2018-03-26 14:24:27 -0400926 if (ref.refKind() != VariableReference::kWrite_RefKind &&
927 ref.refKind() != VariableReference::kPointer_RefKind &&
Ethan Nicholas041fd0a2020-10-07 16:42:04 -0400928 var->storage() == Variable::kLocal_Storage && !definitions[var] &&
Brian Osman79457ef2020-09-24 15:01:27 -0400929 (*undefinedVariables).find(var) == (*undefinedVariables).end()) {
930 (*undefinedVariables).insert(var);
Ethan Nicholas82a62d22017-11-07 14:42:10 +0000931 this->error(expr->fOffset,
Ethan Nicholase2c49992020-10-05 11:49:11 -0400932 "'" + var->name() + "' has not been assigned");
Ethan Nicholascb670962017-04-20 19:31:52 -0400933 }
934 break;
935 }
Ethan Nicholase6592142020-09-08 10:22:09 -0400936 case Expression::Kind::kTernary: {
John Stiles403a3632020-08-20 12:11:48 -0400937 TernaryExpression* t = &expr->as<TernaryExpression>();
Ethan Nicholasdd218162020-10-08 05:48:01 -0400938 if (t->test()->is<BoolLiteral>()) {
Ethan Nicholascb670962017-04-20 19:31:52 -0400939 // ternary has a constant test, replace it with either the true or
940 // false branch
Ethan Nicholasdd218162020-10-08 05:48:01 -0400941 if (t->test()->as<BoolLiteral>().value()) {
942 (*iter)->setExpression(std::move(t->ifTrue()));
Ethan Nicholascb670962017-04-20 19:31:52 -0400943 } else {
Ethan Nicholasdd218162020-10-08 05:48:01 -0400944 (*iter)->setExpression(std::move(t->ifFalse()));
Ethan Nicholascb670962017-04-20 19:31:52 -0400945 }
946 *outUpdated = true;
947 *outNeedsRescan = true;
948 }
949 break;
950 }
Ethan Nicholase6592142020-09-08 10:22:09 -0400951 case Expression::Kind::kBinary: {
John Stiles403a3632020-08-20 12:11:48 -0400952 BinaryExpression* bin = &expr->as<BinaryExpression>();
Ethan Nicholasc2371a42017-05-05 10:04:06 -0400953 if (dead_assignment(*bin)) {
954 delete_left(&b, iter, outUpdated, outNeedsRescan);
955 break;
956 }
Ethan Nicholasc8d9c8e2020-09-22 15:05:37 -0400957 Expression& left = bin->left();
958 Expression& right = bin->right();
959 const Type& leftType = left.type();
960 const Type& rightType = right.type();
Ethan Nicholasc2371a42017-05-05 10:04:06 -0400961 // collapse useless expressions like x * 1 or x + 0
Ethan Nicholas30d30222020-09-11 12:27:26 -0400962 if (((leftType.typeKind() != Type::TypeKind::kScalar) &&
963 (leftType.typeKind() != Type::TypeKind::kVector)) ||
964 ((rightType.typeKind() != Type::TypeKind::kScalar) &&
965 (rightType.typeKind() != Type::TypeKind::kVector))) {
Ethan Nicholasfe53e582017-04-27 16:24:51 -0400966 break;
967 }
Ethan Nicholasc8d9c8e2020-09-22 15:05:37 -0400968 switch (bin->getOperator()) {
Ethan Nicholas5a9e7fb2020-04-17 12:45:51 -0400969 case Token::Kind::TK_STAR:
Ethan Nicholasc8d9c8e2020-09-22 15:05:37 -0400970 if (is_constant(left, 1)) {
Ethan Nicholas30d30222020-09-11 12:27:26 -0400971 if (leftType.typeKind() == Type::TypeKind::kVector &&
972 rightType.typeKind() == Type::TypeKind::kScalar) {
Ethan Nicholas5af9ea32017-07-28 15:19:46 -0400973 // float4(1) * x -> float4(x)
Ethan Nicholasfe53e582017-04-27 16:24:51 -0400974 vectorize_right(&b, iter, outUpdated, outNeedsRescan);
975 } else {
976 // 1 * x -> x
Ethan Nicholas5af9ea32017-07-28 15:19:46 -0400977 // 1 * float4(x) -> float4(x)
978 // float4(1) * float4(x) -> float4(x)
Ethan Nicholasfe53e582017-04-27 16:24:51 -0400979 delete_left(&b, iter, outUpdated, outNeedsRescan);
980 }
981 }
Ethan Nicholasc8d9c8e2020-09-22 15:05:37 -0400982 else if (is_constant(left, 0)) {
Ethan Nicholas30d30222020-09-11 12:27:26 -0400983 if (leftType.typeKind() == Type::TypeKind::kScalar &&
984 rightType.typeKind() == Type::TypeKind::kVector &&
Ethan Nicholasc8d9c8e2020-09-22 15:05:37 -0400985 !right.hasSideEffects()) {
Ethan Nicholas5af9ea32017-07-28 15:19:46 -0400986 // 0 * float4(x) -> float4(0)
Ethan Nicholasfe53e582017-04-27 16:24:51 -0400987 vectorize_left(&b, iter, outUpdated, outNeedsRescan);
988 } else {
989 // 0 * x -> 0
Ethan Nicholas5af9ea32017-07-28 15:19:46 -0400990 // float4(0) * x -> float4(0)
991 // float4(0) * float4(x) -> float4(0)
Ethan Nicholasc8d9c8e2020-09-22 15:05:37 -0400992 if (!right.hasSideEffects()) {
Ethan Nicholas51493ee2017-12-11 12:34:33 -0500993 delete_right(&b, iter, outUpdated, outNeedsRescan);
994 }
Ethan Nicholasfe53e582017-04-27 16:24:51 -0400995 }
Ethan Nicholascb670962017-04-20 19:31:52 -0400996 }
Ethan Nicholasc8d9c8e2020-09-22 15:05:37 -0400997 else if (is_constant(right, 1)) {
Ethan Nicholas30d30222020-09-11 12:27:26 -0400998 if (leftType.typeKind() == Type::TypeKind::kScalar &&
999 rightType.typeKind() == Type::TypeKind::kVector) {
Ethan Nicholas5af9ea32017-07-28 15:19:46 -04001000 // x * float4(1) -> float4(x)
Ethan Nicholasfe53e582017-04-27 16:24:51 -04001001 vectorize_left(&b, iter, outUpdated, outNeedsRescan);
1002 } else {
1003 // x * 1 -> x
Ethan Nicholas5af9ea32017-07-28 15:19:46 -04001004 // float4(x) * 1 -> float4(x)
1005 // float4(x) * float4(1) -> float4(x)
Ethan Nicholasfe53e582017-04-27 16:24:51 -04001006 delete_right(&b, iter, outUpdated, outNeedsRescan);
1007 }
1008 }
Ethan Nicholasc8d9c8e2020-09-22 15:05:37 -04001009 else if (is_constant(right, 0)) {
Ethan Nicholas30d30222020-09-11 12:27:26 -04001010 if (leftType.typeKind() == Type::TypeKind::kVector &&
1011 rightType.typeKind() == Type::TypeKind::kScalar &&
Ethan Nicholasc8d9c8e2020-09-22 15:05:37 -04001012 !left.hasSideEffects()) {
Ethan Nicholas5af9ea32017-07-28 15:19:46 -04001013 // float4(x) * 0 -> float4(0)
Ethan Nicholasfe53e582017-04-27 16:24:51 -04001014 vectorize_right(&b, iter, outUpdated, outNeedsRescan);
1015 } else {
1016 // x * 0 -> 0
Ethan Nicholas5af9ea32017-07-28 15:19:46 -04001017 // x * float4(0) -> float4(0)
1018 // float4(x) * float4(0) -> float4(0)
Ethan Nicholasc8d9c8e2020-09-22 15:05:37 -04001019 if (!left.hasSideEffects()) {
Ethan Nicholas51493ee2017-12-11 12:34:33 -05001020 delete_left(&b, iter, outUpdated, outNeedsRescan);
1021 }
Ethan Nicholasfe53e582017-04-27 16:24:51 -04001022 }
Ethan Nicholascb670962017-04-20 19:31:52 -04001023 }
1024 break;
Ethan Nicholas5a9e7fb2020-04-17 12:45:51 -04001025 case Token::Kind::TK_PLUS:
Ethan Nicholasc8d9c8e2020-09-22 15:05:37 -04001026 if (is_constant(left, 0)) {
Ethan Nicholas30d30222020-09-11 12:27:26 -04001027 if (leftType.typeKind() == Type::TypeKind::kVector &&
1028 rightType.typeKind() == Type::TypeKind::kScalar) {
Ethan Nicholas5af9ea32017-07-28 15:19:46 -04001029 // float4(0) + x -> float4(x)
Ethan Nicholasfe53e582017-04-27 16:24:51 -04001030 vectorize_right(&b, iter, outUpdated, outNeedsRescan);
1031 } else {
1032 // 0 + x -> x
Ethan Nicholas5af9ea32017-07-28 15:19:46 -04001033 // 0 + float4(x) -> float4(x)
1034 // float4(0) + float4(x) -> float4(x)
Ethan Nicholasfe53e582017-04-27 16:24:51 -04001035 delete_left(&b, iter, outUpdated, outNeedsRescan);
1036 }
Ethan Nicholasc8d9c8e2020-09-22 15:05:37 -04001037 } else if (is_constant(right, 0)) {
Ethan Nicholas30d30222020-09-11 12:27:26 -04001038 if (leftType.typeKind() == Type::TypeKind::kScalar &&
1039 rightType.typeKind() == Type::TypeKind::kVector) {
Ethan Nicholas5af9ea32017-07-28 15:19:46 -04001040 // x + float4(0) -> float4(x)
Ethan Nicholasfe53e582017-04-27 16:24:51 -04001041 vectorize_left(&b, iter, outUpdated, outNeedsRescan);
1042 } else {
1043 // x + 0 -> x
Ethan Nicholas5af9ea32017-07-28 15:19:46 -04001044 // float4(x) + 0 -> float4(x)
1045 // float4(x) + float4(0) -> float4(x)
Ethan Nicholasfe53e582017-04-27 16:24:51 -04001046 delete_right(&b, iter, outUpdated, outNeedsRescan);
1047 }
Ethan Nicholas56e42712017-04-21 10:23:37 -04001048 }
1049 break;
Ethan Nicholas5a9e7fb2020-04-17 12:45:51 -04001050 case Token::Kind::TK_MINUS:
Ethan Nicholasc8d9c8e2020-09-22 15:05:37 -04001051 if (is_constant(right, 0)) {
Ethan Nicholas30d30222020-09-11 12:27:26 -04001052 if (leftType.typeKind() == Type::TypeKind::kScalar &&
1053 rightType.typeKind() == Type::TypeKind::kVector) {
Ethan Nicholas5af9ea32017-07-28 15:19:46 -04001054 // x - float4(0) -> float4(x)
Ethan Nicholasfe53e582017-04-27 16:24:51 -04001055 vectorize_left(&b, iter, outUpdated, outNeedsRescan);
1056 } else {
1057 // x - 0 -> x
Ethan Nicholas5af9ea32017-07-28 15:19:46 -04001058 // float4(x) - 0 -> float4(x)
1059 // float4(x) - float4(0) -> float4(x)
Ethan Nicholasfe53e582017-04-27 16:24:51 -04001060 delete_right(&b, iter, outUpdated, outNeedsRescan);
1061 }
Ethan Nicholascb670962017-04-20 19:31:52 -04001062 }
1063 break;
Ethan Nicholas5a9e7fb2020-04-17 12:45:51 -04001064 case Token::Kind::TK_SLASH:
Ethan Nicholasc8d9c8e2020-09-22 15:05:37 -04001065 if (is_constant(right, 1)) {
Ethan Nicholas30d30222020-09-11 12:27:26 -04001066 if (leftType.typeKind() == Type::TypeKind::kScalar &&
1067 rightType.typeKind() == Type::TypeKind::kVector) {
Ethan Nicholas5af9ea32017-07-28 15:19:46 -04001068 // x / float4(1) -> float4(x)
Ethan Nicholasfe53e582017-04-27 16:24:51 -04001069 vectorize_left(&b, iter, outUpdated, outNeedsRescan);
1070 } else {
1071 // x / 1 -> x
Ethan Nicholas5af9ea32017-07-28 15:19:46 -04001072 // float4(x) / 1 -> float4(x)
1073 // float4(x) / float4(1) -> float4(x)
Ethan Nicholasfe53e582017-04-27 16:24:51 -04001074 delete_right(&b, iter, outUpdated, outNeedsRescan);
1075 }
Ethan Nicholasc8d9c8e2020-09-22 15:05:37 -04001076 } else if (is_constant(left, 0)) {
Ethan Nicholas30d30222020-09-11 12:27:26 -04001077 if (leftType.typeKind() == Type::TypeKind::kScalar &&
1078 rightType.typeKind() == Type::TypeKind::kVector &&
Ethan Nicholasc8d9c8e2020-09-22 15:05:37 -04001079 !right.hasSideEffects()) {
Ethan Nicholas5af9ea32017-07-28 15:19:46 -04001080 // 0 / float4(x) -> float4(0)
Ethan Nicholasfe53e582017-04-27 16:24:51 -04001081 vectorize_left(&b, iter, outUpdated, outNeedsRescan);
1082 } else {
1083 // 0 / x -> 0
Ethan Nicholas5af9ea32017-07-28 15:19:46 -04001084 // float4(0) / x -> float4(0)
1085 // float4(0) / float4(x) -> float4(0)
Ethan Nicholasc8d9c8e2020-09-22 15:05:37 -04001086 if (!right.hasSideEffects()) {
Ethan Nicholas51493ee2017-12-11 12:34:33 -05001087 delete_right(&b, iter, outUpdated, outNeedsRescan);
1088 }
Ethan Nicholasfe53e582017-04-27 16:24:51 -04001089 }
1090 }
1091 break;
Ethan Nicholas5a9e7fb2020-04-17 12:45:51 -04001092 case Token::Kind::TK_PLUSEQ:
Ethan Nicholasc8d9c8e2020-09-22 15:05:37 -04001093 if (is_constant(right, 0)) {
1094 clear_write(left);
Ethan Nicholasfe53e582017-04-27 16:24:51 -04001095 delete_right(&b, iter, outUpdated, outNeedsRescan);
1096 }
1097 break;
Ethan Nicholas5a9e7fb2020-04-17 12:45:51 -04001098 case Token::Kind::TK_MINUSEQ:
Ethan Nicholasc8d9c8e2020-09-22 15:05:37 -04001099 if (is_constant(right, 0)) {
1100 clear_write(left);
Ethan Nicholasfe53e582017-04-27 16:24:51 -04001101 delete_right(&b, iter, outUpdated, outNeedsRescan);
1102 }
1103 break;
Ethan Nicholas5a9e7fb2020-04-17 12:45:51 -04001104 case Token::Kind::TK_STAREQ:
Ethan Nicholasc8d9c8e2020-09-22 15:05:37 -04001105 if (is_constant(right, 1)) {
1106 clear_write(left);
Ethan Nicholasfe53e582017-04-27 16:24:51 -04001107 delete_right(&b, iter, outUpdated, outNeedsRescan);
1108 }
1109 break;
Ethan Nicholas5a9e7fb2020-04-17 12:45:51 -04001110 case Token::Kind::TK_SLASHEQ:
Ethan Nicholasc8d9c8e2020-09-22 15:05:37 -04001111 if (is_constant(right, 1)) {
1112 clear_write(left);
Ethan Nicholascb670962017-04-20 19:31:52 -04001113 delete_right(&b, iter, outUpdated, outNeedsRescan);
1114 }
1115 break;
1116 default:
1117 break;
1118 }
Ethan Nicholas409f6f02019-09-17 12:34:39 -04001119 break;
1120 }
Ethan Nicholase6592142020-09-08 10:22:09 -04001121 case Expression::Kind::kSwizzle: {
John Stiles403a3632020-08-20 12:11:48 -04001122 Swizzle& s = expr->as<Swizzle>();
Ethan Nicholas409f6f02019-09-17 12:34:39 -04001123 // detect identity swizzles like foo.rgba
Ethan Nicholas30d30222020-09-11 12:27:26 -04001124 if ((int) s.fComponents.size() == s.fBase->type().columns()) {
Ethan Nicholas409f6f02019-09-17 12:34:39 -04001125 bool identity = true;
1126 for (int i = 0; i < (int) s.fComponents.size(); ++i) {
1127 if (s.fComponents[i] != i) {
1128 identity = false;
1129 break;
1130 }
1131 }
1132 if (identity) {
1133 *outUpdated = true;
1134 if (!try_replace_expression(&b, iter, &s.fBase)) {
1135 *outNeedsRescan = true;
1136 return;
1137 }
John Stiles70025e52020-09-28 16:08:58 -04001138 SkASSERT((*iter)->isExpression());
Ethan Nicholas409f6f02019-09-17 12:34:39 -04001139 break;
1140 }
1141 }
1142 // detect swizzles of swizzles, e.g. replace foo.argb.r000 with foo.a000
Ethan Nicholase6592142020-09-08 10:22:09 -04001143 if (s.fBase->kind() == Expression::Kind::kSwizzle) {
John Stilesa5a97b42020-08-18 11:19:07 -04001144 Swizzle& base = s.fBase->as<Swizzle>();
Ethan Nicholas409f6f02019-09-17 12:34:39 -04001145 std::vector<int> final;
1146 for (int c : s.fComponents) {
Brian Osman25647672020-09-15 15:16:56 -04001147 final.push_back(base.fComponents[c]);
Ethan Nicholas409f6f02019-09-17 12:34:39 -04001148 }
1149 *outUpdated = true;
1150 std::unique_ptr<Expression> replacement(new Swizzle(*fContext, base.fBase->clone(),
1151 std::move(final)));
1152 if (!try_replace_expression(&b, iter, &replacement)) {
1153 *outNeedsRescan = true;
1154 return;
1155 }
John Stiles70025e52020-09-28 16:08:58 -04001156 SkASSERT((*iter)->isExpression());
Ethan Nicholas409f6f02019-09-17 12:34:39 -04001157 }
John Stiles30212b72020-06-11 17:55:07 -04001158 break;
Ethan Nicholascb670962017-04-20 19:31:52 -04001159 }
1160 default:
1161 break;
1162 }
1163}
1164
John Stiles92219b42020-06-15 12:32:24 -04001165// Returns true if this statement could potentially execute a break at the current level. We ignore
1166// nested loops and switches, since any breaks inside of them will merely break the loop / switch.
John Stilesb92641c2020-08-31 18:09:01 -04001167static bool contains_conditional_break(Statement& stmt) {
1168 class ContainsConditionalBreak : public ProgramVisitor {
1169 public:
1170 bool visitStatement(const Statement& stmt) override {
Ethan Nicholase6592142020-09-08 10:22:09 -04001171 switch (stmt.kind()) {
1172 case Statement::Kind::kBlock:
John Stilesb92641c2020-08-31 18:09:01 -04001173 return this->INHERITED::visitStatement(stmt);
1174
Ethan Nicholase6592142020-09-08 10:22:09 -04001175 case Statement::Kind::kBreak:
John Stilesb92641c2020-08-31 18:09:01 -04001176 return fInConditional > 0;
1177
Ethan Nicholase6592142020-09-08 10:22:09 -04001178 case Statement::Kind::kIf: {
John Stilesb92641c2020-08-31 18:09:01 -04001179 ++fInConditional;
1180 bool result = this->INHERITED::visitStatement(stmt);
1181 --fInConditional;
1182 return result;
1183 }
1184
1185 default:
1186 return false;
1187 }
1188 }
1189
1190 int fInConditional = 0;
1191 using INHERITED = ProgramVisitor;
1192 };
1193
1194 return ContainsConditionalBreak{}.visitStatement(stmt);
John Stiles92219b42020-06-15 12:32:24 -04001195}
1196
Ethan Nicholas5005a222018-08-24 13:06:27 -04001197// returns true if this statement definitely executes a break at the current level (we ignore
1198// nested loops and switches, since any breaks inside of them will merely break the loop / switch)
John Stilesb92641c2020-08-31 18:09:01 -04001199static bool contains_unconditional_break(Statement& stmt) {
1200 class ContainsUnconditionalBreak : public ProgramVisitor {
1201 public:
1202 bool visitStatement(const Statement& stmt) override {
Ethan Nicholase6592142020-09-08 10:22:09 -04001203 switch (stmt.kind()) {
1204 case Statement::Kind::kBlock:
John Stilesb92641c2020-08-31 18:09:01 -04001205 return this->INHERITED::visitStatement(stmt);
1206
Ethan Nicholase6592142020-09-08 10:22:09 -04001207 case Statement::Kind::kBreak:
Ethan Nicholas5ac13c22017-05-10 15:06:17 -04001208 return true;
John Stilesb92641c2020-08-31 18:09:01 -04001209
1210 default:
1211 return false;
Ethan Nicholas5ac13c22017-05-10 15:06:17 -04001212 }
John Stilesb92641c2020-08-31 18:09:01 -04001213 }
John Stiles92219b42020-06-15 12:32:24 -04001214
John Stilesb92641c2020-08-31 18:09:01 -04001215 using INHERITED = ProgramVisitor;
1216 };
John Stiles92219b42020-06-15 12:32:24 -04001217
John Stilesb92641c2020-08-31 18:09:01 -04001218 return ContainsUnconditionalBreak{}.visitStatement(stmt);
Ethan Nicholas5ac13c22017-05-10 15:06:17 -04001219}
1220
John Stiles92219b42020-06-15 12:32:24 -04001221static void move_all_but_break(std::unique_ptr<Statement>& stmt,
1222 std::vector<std::unique_ptr<Statement>>* target) {
Ethan Nicholase6592142020-09-08 10:22:09 -04001223 switch (stmt->kind()) {
1224 case Statement::Kind::kBlock: {
John Stiles92219b42020-06-15 12:32:24 -04001225 // Recurse into the block.
1226 Block& block = static_cast<Block&>(*stmt);
1227
1228 std::vector<std::unique_ptr<Statement>> blockStmts;
Ethan Nicholas7bd60432020-09-25 14:31:59 -04001229 blockStmts.reserve(block.children().size());
1230 for (std::unique_ptr<Statement>& stmt : block.children()) {
1231 move_all_but_break(stmt, &blockStmts);
Ethan Nicholas739e1ca2020-06-11 12:16:14 -04001232 }
John Stiles92219b42020-06-15 12:32:24 -04001233
1234 target->push_back(std::make_unique<Block>(block.fOffset, std::move(blockStmts),
Ethan Nicholas7bd60432020-09-25 14:31:59 -04001235 block.symbolTable(), block.isScope()));
Ethan Nicholas739e1ca2020-06-11 12:16:14 -04001236 break;
John Stiles92219b42020-06-15 12:32:24 -04001237 }
1238
Ethan Nicholase6592142020-09-08 10:22:09 -04001239 case Statement::Kind::kBreak:
John Stiles92219b42020-06-15 12:32:24 -04001240 // Do not append a break to the target.
1241 break;
1242
Ethan Nicholas739e1ca2020-06-11 12:16:14 -04001243 default:
John Stiles92219b42020-06-15 12:32:24 -04001244 // Append normal statements to the target.
1245 target->push_back(std::move(stmt));
1246 break;
Ethan Nicholas739e1ca2020-06-11 12:16:14 -04001247 }
1248}
1249
Ethan Nicholas5ac13c22017-05-10 15:06:17 -04001250// Returns a block containing all of the statements that will be run if the given case matches
1251// (which, owing to the statements being owned by unique_ptrs, means the switch itself will be
1252// broken by this call and must then be discarded).
1253// Returns null (and leaves the switch unmodified) if no such simple reduction is possible, such as
1254// when break statements appear inside conditionals.
John Stiles92219b42020-06-15 12:32:24 -04001255static std::unique_ptr<Statement> block_for_case(SwitchStatement* switchStatement,
1256 SwitchCase* caseToCapture) {
1257 // We have to be careful to not move any of the pointers until after we're sure we're going to
1258 // succeed, so before we make any changes at all, we check the switch-cases to decide on a plan
1259 // of action. First, find the switch-case we are interested in.
1260 auto iter = switchStatement->fCases.begin();
1261 for (; iter != switchStatement->fCases.end(); ++iter) {
1262 if (iter->get() == caseToCapture) {
1263 break;
Ethan Nicholas5ac13c22017-05-10 15:06:17 -04001264 }
John Stiles92219b42020-06-15 12:32:24 -04001265 }
1266
1267 // Next, walk forward through the rest of the switch. If we find a conditional break, we're
1268 // stuck and can't simplify at all. If we find an unconditional break, we have a range of
1269 // statements that we can use for simplification.
1270 auto startIter = iter;
1271 Statement* unconditionalBreakStmt = nullptr;
1272 for (; iter != switchStatement->fCases.end(); ++iter) {
1273 for (std::unique_ptr<Statement>& stmt : (*iter)->fStatements) {
1274 if (contains_conditional_break(*stmt)) {
1275 // We can't reduce switch-cases to a block when they have conditional breaks.
1276 return nullptr;
Ethan Nicholas5ac13c22017-05-10 15:06:17 -04001277 }
John Stiles92219b42020-06-15 12:32:24 -04001278
1279 if (contains_unconditional_break(*stmt)) {
1280 // We found an unconditional break. We can use this block, but we need to strip
1281 // out the break statement.
1282 unconditionalBreakStmt = stmt.get();
Ethan Nicholas5ac13c22017-05-10 15:06:17 -04001283 break;
1284 }
1285 }
John Stiles92219b42020-06-15 12:32:24 -04001286
1287 if (unconditionalBreakStmt != nullptr) {
1288 break;
1289 }
Ethan Nicholas5ac13c22017-05-10 15:06:17 -04001290 }
John Stiles92219b42020-06-15 12:32:24 -04001291
1292 // We fell off the bottom of the switch or encountered a break. We know the range of statements
1293 // that we need to move over, and we know it's safe to do so.
1294 std::vector<std::unique_ptr<Statement>> caseStmts;
1295
1296 // We can move over most of the statements as-is.
1297 while (startIter != iter) {
1298 for (std::unique_ptr<Statement>& stmt : (*startIter)->fStatements) {
1299 caseStmts.push_back(std::move(stmt));
1300 }
1301 ++startIter;
Ethan Nicholas5ac13c22017-05-10 15:06:17 -04001302 }
John Stiles92219b42020-06-15 12:32:24 -04001303
1304 // If we found an unconditional break at the end, we need to move what we can while avoiding
1305 // that break.
1306 if (unconditionalBreakStmt != nullptr) {
1307 for (std::unique_ptr<Statement>& stmt : (*startIter)->fStatements) {
1308 if (stmt.get() == unconditionalBreakStmt) {
1309 move_all_but_break(stmt, &caseStmts);
1310 unconditionalBreakStmt = nullptr;
1311 break;
1312 }
1313
1314 caseStmts.push_back(std::move(stmt));
1315 }
1316 }
1317
1318 SkASSERT(unconditionalBreakStmt == nullptr); // Verify that we fixed the unconditional break.
1319
1320 // Return our newly-synthesized block.
1321 return std::make_unique<Block>(/*offset=*/-1, std::move(caseStmts), switchStatement->fSymbols);
Ethan Nicholas5ac13c22017-05-10 15:06:17 -04001322}
1323
Ethan Nicholascb670962017-04-20 19:31:52 -04001324void Compiler::simplifyStatement(DefinitionMap& definitions,
Ethan Nicholas5ac13c22017-05-10 15:06:17 -04001325 BasicBlock& b,
1326 std::vector<BasicBlock::Node>::iterator* iter,
1327 std::unordered_set<const Variable*>* undefinedVariables,
1328 bool* outUpdated,
1329 bool* outNeedsRescan) {
Ethan Nicholascb670962017-04-20 19:31:52 -04001330 Statement* stmt = (*iter)->statement()->get();
Ethan Nicholase6592142020-09-08 10:22:09 -04001331 switch (stmt->kind()) {
1332 case Statement::Kind::kVarDeclaration: {
John Stilesa5a97b42020-08-18 11:19:07 -04001333 const auto& varDecl = stmt->as<VarDeclaration>();
Ethan Nicholas82a62d22017-11-07 14:42:10 +00001334 if (varDecl.fVar->dead() &&
1335 (!varDecl.fValue ||
1336 !varDecl.fValue->hasSideEffects())) {
1337 if (varDecl.fValue) {
Ethan Nicholasd9d33c32018-06-12 11:05:59 -04001338 SkASSERT((*iter)->statement()->get() == stmt);
Ethan Nicholas82a62d22017-11-07 14:42:10 +00001339 if (!b.tryRemoveExpressionBefore(iter, varDecl.fValue.get())) {
1340 *outNeedsRescan = true;
Ethan Nicholascb670962017-04-20 19:31:52 -04001341 }
Ethan Nicholascb670962017-04-20 19:31:52 -04001342 }
Ethan Nicholascb670962017-04-20 19:31:52 -04001343 (*iter)->setStatement(std::unique_ptr<Statement>(new Nop()));
Ethan Nicholas82a62d22017-11-07 14:42:10 +00001344 *outUpdated = true;
Ethan Nicholascb670962017-04-20 19:31:52 -04001345 }
1346 break;
1347 }
Ethan Nicholase6592142020-09-08 10:22:09 -04001348 case Statement::Kind::kIf: {
John Stilesa5a97b42020-08-18 11:19:07 -04001349 IfStatement& i = stmt->as<IfStatement>();
Ethan Nicholas8c44eca2020-10-07 16:47:09 -04001350 if (i.test()->kind() == Expression::Kind::kBoolLiteral) {
Ethan Nicholas5ac13c22017-05-10 15:06:17 -04001351 // constant if, collapse down to a single branch
Ethan Nicholas8c44eca2020-10-07 16:47:09 -04001352 if (i.test()->as<BoolLiteral>().value()) {
1353 SkASSERT(i.ifTrue());
1354 (*iter)->setStatement(std::move(i.ifTrue()));
Ethan Nicholas5ac13c22017-05-10 15:06:17 -04001355 } else {
Ethan Nicholas8c44eca2020-10-07 16:47:09 -04001356 if (i.ifFalse()) {
1357 (*iter)->setStatement(std::move(i.ifFalse()));
Ethan Nicholas5ac13c22017-05-10 15:06:17 -04001358 } else {
1359 (*iter)->setStatement(std::unique_ptr<Statement>(new Nop()));
1360 }
1361 }
1362 *outUpdated = true;
1363 *outNeedsRescan = true;
1364 break;
1365 }
Ethan Nicholas8c44eca2020-10-07 16:47:09 -04001366 if (i.ifFalse() && i.ifFalse()->isEmpty()) {
Ethan Nicholascb670962017-04-20 19:31:52 -04001367 // else block doesn't do anything, remove it
Ethan Nicholas8c44eca2020-10-07 16:47:09 -04001368 i.ifFalse().reset();
Ethan Nicholascb670962017-04-20 19:31:52 -04001369 *outUpdated = true;
1370 *outNeedsRescan = true;
1371 }
Ethan Nicholas8c44eca2020-10-07 16:47:09 -04001372 if (!i.ifFalse() && i.ifTrue()->isEmpty()) {
Ethan Nicholascb670962017-04-20 19:31:52 -04001373 // if block doesn't do anything, no else block
Ethan Nicholas8c44eca2020-10-07 16:47:09 -04001374 if (i.test()->hasSideEffects()) {
Ethan Nicholascb670962017-04-20 19:31:52 -04001375 // test has side effects, keep it
1376 (*iter)->setStatement(std::unique_ptr<Statement>(
Ethan Nicholas8c44eca2020-10-07 16:47:09 -04001377 new ExpressionStatement(std::move(i.test()))));
Ethan Nicholascb670962017-04-20 19:31:52 -04001378 } else {
1379 // no if, no else, no test side effects, kill the whole if
1380 // statement
1381 (*iter)->setStatement(std::unique_ptr<Statement>(new Nop()));
1382 }
1383 *outUpdated = true;
1384 *outNeedsRescan = true;
1385 }
1386 break;
1387 }
Ethan Nicholase6592142020-09-08 10:22:09 -04001388 case Statement::Kind::kSwitch: {
John Stilesa5a97b42020-08-18 11:19:07 -04001389 SwitchStatement& s = stmt->as<SwitchStatement>();
Ethan Nicholas34b19c52020-09-14 11:33:47 -04001390 int64_t switchValue;
1391 if (fIRGenerator->getConstantInt(*s.fValue, &switchValue)) {
Ethan Nicholas5ac13c22017-05-10 15:06:17 -04001392 // switch is constant, replace it with the case that matches
1393 bool found = false;
1394 SwitchCase* defaultCase = nullptr;
John Stiles9d944232020-08-19 09:56:49 -04001395 for (const std::unique_ptr<SwitchCase>& c : s.fCases) {
Ethan Nicholas5ac13c22017-05-10 15:06:17 -04001396 if (!c->fValue) {
1397 defaultCase = c.get();
1398 continue;
1399 }
Ethan Nicholas34b19c52020-09-14 11:33:47 -04001400 int64_t caseValue;
1401 SkAssertResult(fIRGenerator->getConstantInt(*c->fValue, &caseValue));
1402 if (caseValue == switchValue) {
Ethan Nicholas5ac13c22017-05-10 15:06:17 -04001403 std::unique_ptr<Statement> newBlock = block_for_case(&s, c.get());
1404 if (newBlock) {
1405 (*iter)->setStatement(std::move(newBlock));
John Stiles9d944232020-08-19 09:56:49 -04001406 found = true;
Ethan Nicholas5ac13c22017-05-10 15:06:17 -04001407 break;
1408 } else {
Ethan Nicholas6e1cbc02017-07-14 10:12:15 -04001409 if (s.fIsStatic && !(fFlags & kPermitInvalidStaticTests_Flag)) {
Ethan Nicholas5b5f0962017-09-11 13:50:14 -07001410 this->error(s.fOffset,
Ethan Nicholas5ac13c22017-05-10 15:06:17 -04001411 "static switch contains non-static conditional break");
1412 s.fIsStatic = false;
1413 }
1414 return; // can't simplify
1415 }
1416 }
1417 }
1418 if (!found) {
1419 // no matching case. use default if it exists, or kill the whole thing
1420 if (defaultCase) {
1421 std::unique_ptr<Statement> newBlock = block_for_case(&s, defaultCase);
1422 if (newBlock) {
1423 (*iter)->setStatement(std::move(newBlock));
1424 } else {
Ethan Nicholas6e1cbc02017-07-14 10:12:15 -04001425 if (s.fIsStatic && !(fFlags & kPermitInvalidStaticTests_Flag)) {
Ethan Nicholas5b5f0962017-09-11 13:50:14 -07001426 this->error(s.fOffset,
Ethan Nicholas5ac13c22017-05-10 15:06:17 -04001427 "static switch contains non-static conditional break");
1428 s.fIsStatic = false;
1429 }
1430 return; // can't simplify
1431 }
1432 } else {
1433 (*iter)->setStatement(std::unique_ptr<Statement>(new Nop()));
1434 }
1435 }
1436 *outUpdated = true;
1437 *outNeedsRescan = true;
1438 }
1439 break;
1440 }
Ethan Nicholase6592142020-09-08 10:22:09 -04001441 case Statement::Kind::kExpression: {
John Stilesa5a97b42020-08-18 11:19:07 -04001442 ExpressionStatement& e = stmt->as<ExpressionStatement>();
Ethan Nicholasd9d33c32018-06-12 11:05:59 -04001443 SkASSERT((*iter)->statement()->get() == &e);
Ethan Nicholasd503a5a2020-09-30 09:29:55 -04001444 if (!e.expression()->hasSideEffects()) {
Ethan Nicholascb670962017-04-20 19:31:52 -04001445 // Expression statement with no side effects, kill it
Ethan Nicholasd503a5a2020-09-30 09:29:55 -04001446 if (!b.tryRemoveExpressionBefore(iter, e.expression().get())) {
Ethan Nicholascb670962017-04-20 19:31:52 -04001447 *outNeedsRescan = true;
1448 }
Ethan Nicholasd9d33c32018-06-12 11:05:59 -04001449 SkASSERT((*iter)->statement()->get() == stmt);
Ethan Nicholascb670962017-04-20 19:31:52 -04001450 (*iter)->setStatement(std::unique_ptr<Statement>(new Nop()));
1451 *outUpdated = true;
1452 }
1453 break;
1454 }
1455 default:
1456 break;
1457 }
1458}
1459
John Stiles0cc193a2020-09-09 09:39:34 -04001460bool Compiler::scanCFG(FunctionDefinition& f) {
1461 bool madeChanges = false;
1462
Ethan Nicholascb670962017-04-20 19:31:52 -04001463 CFG cfg = CFGGenerator().getCFG(f);
1464 this->computeDataFlow(&cfg);
ethannicholas22f939e2016-10-13 13:25:34 -07001465
1466 // check for unreachable code
1467 for (size_t i = 0; i < cfg.fBlocks.size(); i++) {
John Stiles0cc193a2020-09-09 09:39:34 -04001468 const BasicBlock& block = cfg.fBlocks[i];
John Stiles61e75e32020-10-01 15:42:37 -04001469 if (i != cfg.fStart && !block.fIsReachable && block.fNodes.size()) {
Ethan Nicholas5b5f0962017-09-11 13:50:14 -07001470 int offset;
John Stiles0cc193a2020-09-09 09:39:34 -04001471 const BasicBlock::Node& node = block.fNodes[0];
John Stiles70025e52020-09-28 16:08:58 -04001472 if (node.isStatement()) {
1473 offset = (*node.statement())->fOffset;
1474 } else {
1475 offset = (*node.expression())->fOffset;
1476 if ((*node.expression())->is<BoolLiteral>()) {
1477 // Function inlining can generate do { ... } while(false) loops which always
1478 // break, so the boolean condition is considered unreachable. Since not being
1479 // able to reach a literal is a non-issue in the first place, we don't report an
1480 // error in this case.
1481 continue;
1482 }
Ethan Nicholas86a43402017-01-19 13:32:00 -05001483 }
Ethan Nicholas5b5f0962017-09-11 13:50:14 -07001484 this->error(offset, String("unreachable"));
ethannicholas22f939e2016-10-13 13:25:34 -07001485 }
1486 }
1487 if (fErrorCount) {
John Stiles0cc193a2020-09-09 09:39:34 -04001488 return madeChanges;
ethannicholas22f939e2016-10-13 13:25:34 -07001489 }
1490
Ethan Nicholascb670962017-04-20 19:31:52 -04001491 // check for dead code & undefined variables, perform constant propagation
1492 std::unordered_set<const Variable*> undefinedVariables;
1493 bool updated;
1494 bool needsRescan = false;
1495 do {
1496 if (needsRescan) {
1497 cfg = CFGGenerator().getCFG(f);
1498 this->computeDataFlow(&cfg);
1499 needsRescan = false;
Ethan Nicholas113628d2017-02-02 16:11:39 -05001500 }
Ethan Nicholascb670962017-04-20 19:31:52 -04001501
1502 updated = false;
Ethan Nicholas1de14812020-06-19 15:32:49 -04001503 bool first = true;
Ethan Nicholascb670962017-04-20 19:31:52 -04001504 for (BasicBlock& b : cfg.fBlocks) {
John Stiles61e75e32020-10-01 15:42:37 -04001505 if (!first && !b.fIsReachable) {
Ethan Nicholas1de14812020-06-19 15:32:49 -04001506 // Block was reachable before optimization, but has since become unreachable. In
1507 // addition to being dead code, it's broken - since control flow can't reach it, no
1508 // prior variable definitions can reach it, and therefore variables might look to
Brian Osmanc0213602020-10-06 14:43:32 -04001509 // have not been properly assigned. Kill it by replacing all statements with Nops.
Ethan Nicholas1de14812020-06-19 15:32:49 -04001510 for (BasicBlock::Node& node : b.fNodes) {
John Stiles70025e52020-09-28 16:08:58 -04001511 if (node.isStatement() && !(*node.statement())->is<Nop>()) {
John Stiles0cc193a2020-09-09 09:39:34 -04001512 node.setStatement(std::make_unique<Nop>());
1513 madeChanges = true;
Ethan Nicholas1de14812020-06-19 15:32:49 -04001514 }
1515 }
1516 continue;
1517 }
1518 first = false;
Ethan Nicholascb670962017-04-20 19:31:52 -04001519 DefinitionMap definitions = b.fBefore;
1520
1521 for (auto iter = b.fNodes.begin(); iter != b.fNodes.end() && !needsRescan; ++iter) {
John Stiles70025e52020-09-28 16:08:58 -04001522 if (iter->isExpression()) {
Ethan Nicholascb670962017-04-20 19:31:52 -04001523 this->simplifyExpression(definitions, b, &iter, &undefinedVariables, &updated,
1524 &needsRescan);
1525 } else {
1526 this->simplifyStatement(definitions, b, &iter, &undefinedVariables, &updated,
John Stiles0cc193a2020-09-09 09:39:34 -04001527 &needsRescan);
Ethan Nicholascb670962017-04-20 19:31:52 -04001528 }
Ethan Nicholas4b330df2017-05-17 10:52:55 -04001529 if (needsRescan) {
1530 break;
1531 }
Ethan Nicholascb670962017-04-20 19:31:52 -04001532 this->addDefinitions(*iter, &definitions);
1533 }
Brian Osman01a3eb42020-09-14 11:32:49 -04001534
1535 if (needsRescan) {
1536 break;
1537 }
Ethan Nicholascb670962017-04-20 19:31:52 -04001538 }
John Stiles0cc193a2020-09-09 09:39:34 -04001539 madeChanges |= updated;
Ethan Nicholascb670962017-04-20 19:31:52 -04001540 } while (updated);
Ethan Nicholasd9d33c32018-06-12 11:05:59 -04001541 SkASSERT(!needsRescan);
ethannicholas22f939e2016-10-13 13:25:34 -07001542
Ethan Nicholas91a10532017-06-22 11:24:38 -04001543 // verify static ifs & switches, clean up dead variable decls
Ethan Nicholas5ac13c22017-05-10 15:06:17 -04001544 for (BasicBlock& b : cfg.fBlocks) {
Ethan Nicholas91a10532017-06-22 11:24:38 -04001545 for (auto iter = b.fNodes.begin(); iter != b.fNodes.end() && !needsRescan;) {
John Stiles70025e52020-09-28 16:08:58 -04001546 if (iter->isStatement()) {
Ethan Nicholas5ac13c22017-05-10 15:06:17 -04001547 const Statement& s = **iter->statement();
Ethan Nicholase6592142020-09-08 10:22:09 -04001548 switch (s.kind()) {
1549 case Statement::Kind::kIf:
Ethan Nicholas8c44eca2020-10-07 16:47:09 -04001550 if (s.as<IfStatement>().isStatic() &&
Ethan Nicholas6e1cbc02017-07-14 10:12:15 -04001551 !(fFlags & kPermitInvalidStaticTests_Flag)) {
Ethan Nicholas5b5f0962017-09-11 13:50:14 -07001552 this->error(s.fOffset, "static if has non-static test");
Ethan Nicholas5ac13c22017-05-10 15:06:17 -04001553 }
Ethan Nicholas91a10532017-06-22 11:24:38 -04001554 ++iter;
Ethan Nicholas5ac13c22017-05-10 15:06:17 -04001555 break;
Ethan Nicholase6592142020-09-08 10:22:09 -04001556 case Statement::Kind::kSwitch:
John Stilesa5a97b42020-08-18 11:19:07 -04001557 if (s.as<SwitchStatement>().fIsStatic &&
John Stiles0cc193a2020-09-09 09:39:34 -04001558 !(fFlags & kPermitInvalidStaticTests_Flag)) {
Ethan Nicholas5b5f0962017-09-11 13:50:14 -07001559 this->error(s.fOffset, "static switch has non-static test");
Ethan Nicholas5ac13c22017-05-10 15:06:17 -04001560 }
Ethan Nicholas91a10532017-06-22 11:24:38 -04001561 ++iter;
Ethan Nicholas5ac13c22017-05-10 15:06:17 -04001562 break;
1563 default:
Ethan Nicholas91a10532017-06-22 11:24:38 -04001564 ++iter;
Ethan Nicholas5ac13c22017-05-10 15:06:17 -04001565 break;
1566 }
Ethan Nicholas91a10532017-06-22 11:24:38 -04001567 } else {
1568 ++iter;
Ethan Nicholas5ac13c22017-05-10 15:06:17 -04001569 }
1570 }
1571 }
1572
ethannicholas22f939e2016-10-13 13:25:34 -07001573 // check for missing return
Ethan Nicholased84b732020-10-08 11:45:44 -04001574 if (f.fDeclaration.returnType() != *fContext->fVoid_Type) {
John Stiles61e75e32020-10-01 15:42:37 -04001575 if (cfg.fBlocks[cfg.fExit].fIsReachable) {
Ethan Nicholase2c49992020-10-05 11:49:11 -04001576 this->error(f.fOffset, String("function '" + String(f.fDeclaration.name()) +
Ethan Nicholasdb80f692019-11-22 14:06:12 -05001577 "' can exit without returning a value"));
ethannicholas22f939e2016-10-13 13:25:34 -07001578 }
1579 }
John Stiles0cc193a2020-09-09 09:39:34 -04001580
1581 return madeChanges;
ethannicholas22f939e2016-10-13 13:25:34 -07001582}
1583
Brian Osman32d53552020-09-23 13:55:20 -04001584std::unique_ptr<Program> Compiler::convertProgram(
1585 Program::Kind kind,
1586 String text,
1587 const Program::Settings& settings,
1588 const std::vector<std::unique_ptr<ExternalValue>>* externalValues) {
1589 SkASSERT(!externalValues || (kind == Program::kGeneric_Kind));
Ethan Nicholas91164d12019-05-15 15:29:54 -04001590
ethannicholasb3058bd2016-07-01 08:22:01 -07001591 fErrorText = "";
1592 fErrorCount = 0;
Ethan Nicholas041fd0a2020-10-07 16:42:04 -04001593 fInliner.reset(&fIRGenerator->fContext, fIRGenerator->fModifiers.get(), &settings);
ethannicholasd598f792016-07-25 10:08:54 -07001594 std::vector<std::unique_ptr<ProgramElement>> elements;
ethannicholasb3058bd2016-07-01 08:22:01 -07001595 switch (kind) {
1596 case Program::kVertex_Kind:
Brian Osmanafa18ee2020-10-07 17:47:45 -04001597 fIRGenerator->fIntrinsics = fVertexIntrinsics.get();
Brian Osmane3dcb132020-10-08 10:27:29 -04001598 fIRGenerator->start(&settings, fVertexSymbolTable);
ethannicholasb3058bd2016-07-01 08:22:01 -07001599 break;
1600 case Program::kFragment_Kind:
Brian Osman00a8b5b2020-10-02 09:06:04 -04001601 fIRGenerator->fIntrinsics = fFragmentIntrinsics.get();
Brian Osmane3dcb132020-10-08 10:27:29 -04001602 fIRGenerator->start(&settings, fFragmentSymbolTable);
ethannicholasb3058bd2016-07-01 08:22:01 -07001603 break;
Ethan Nicholas52cad152017-02-16 16:37:32 -05001604 case Program::kGeometry_Kind:
Ethan Nicholasc18bb512020-07-28 14:46:53 -04001605 this->loadGeometryIntrinsics();
Brian Osmanafa18ee2020-10-07 17:47:45 -04001606 fIRGenerator->fIntrinsics = fGeometryIntrinsics.get();
Brian Osmane3dcb132020-10-08 10:27:29 -04001607 fIRGenerator->start(&settings, fGeometrySymbolTable);
Ethan Nicholas52cad152017-02-16 16:37:32 -05001608 break;
Brian Osman8e2ef022020-09-30 13:26:43 -04001609 case Program::kFragmentProcessor_Kind:
1610 this->loadFPIntrinsics();
Brian Osman8e2ef022020-09-30 13:26:43 -04001611 fIRGenerator->fIntrinsics = fFPIntrinsics.get();
Brian Osmane3dcb132020-10-08 10:27:29 -04001612 fIRGenerator->start(&settings, fFPSymbolTable);
Ethan Nicholas762466e2017-06-29 10:03:38 -04001613 break;
Ethan Nicholas8da1e652019-05-24 11:01:59 -04001614 case Program::kPipelineStage_Kind:
Ethan Nicholasc18bb512020-07-28 14:46:53 -04001615 this->loadPipelineIntrinsics();
Brian Osman8e2ef022020-09-30 13:26:43 -04001616 fIRGenerator->fIntrinsics = fPipelineIntrinsics.get();
Brian Osmane3dcb132020-10-08 10:27:29 -04001617 fIRGenerator->start(&settings, fPipelineSymbolTable);
Ethan Nicholas8da1e652019-05-24 11:01:59 -04001618 break;
Ethan Nicholas746035a2019-04-23 13:31:09 -04001619 case Program::kGeneric_Kind:
Ethan Nicholasc18bb512020-07-28 14:46:53 -04001620 this->loadInterpreterIntrinsics();
John Stiles810c8cf2020-08-26 19:46:27 -04001621 fIRGenerator->fIntrinsics = fInterpreterIntrinsics.get();
Brian Osmane3dcb132020-10-08 10:27:29 -04001622 fIRGenerator->start(&settings, fInterpreterSymbolTable);
Ethan Nicholas0d997662019-04-08 09:46:01 -04001623 break;
ethannicholasb3058bd2016-07-01 08:22:01 -07001624 }
Brian Osman32d53552020-09-23 13:55:20 -04001625 if (externalValues) {
1626 // Add any external values to the symbol table. IRGenerator::start() has pushed a table, so
1627 // we're only making these visible to the current Program.
1628 for (const auto& ev : *externalValues) {
John Stilesb8cc6652020-10-08 09:12:07 -04001629 fIRGenerator->fSymbolTable->addWithoutOwnership(ev.get());
Brian Osman32d53552020-09-23 13:55:20 -04001630 }
1631 }
Ethan Nicholas5b5f0962017-09-11 13:50:14 -07001632 std::unique_ptr<String> textPtr(new String(std::move(text)));
1633 fSource = textPtr.get();
Ethan Nicholasc18bb512020-07-28 14:46:53 -04001634 fIRGenerator->convertProgram(kind, textPtr->c_str(), textPtr->size(), &elements);
John Stilesfbd050b2020-08-03 13:21:46 -04001635 auto result = std::make_unique<Program>(kind,
1636 std::move(textPtr),
1637 settings,
1638 fContext,
John Stilesfbd050b2020-08-03 13:21:46 -04001639 std::move(elements),
Ethan Nicholas041fd0a2020-10-07 16:42:04 -04001640 fIRGenerator->releaseModifiers(),
John Stilesfbd050b2020-08-03 13:21:46 -04001641 fIRGenerator->fSymbolTable,
1642 fIRGenerator->fInputs);
Brian Osmane498b3c2020-09-23 14:42:11 -04001643 fIRGenerator->finish();
Ethan Nicholas941e7e22016-12-12 15:33:30 -05001644 if (fErrorCount) {
1645 return nullptr;
1646 }
Ethan Nicholas34b19c52020-09-14 11:33:47 -04001647 if (settings.fOptimize && !this->optimize(*result)) {
1648 return nullptr;
1649 }
Ethan Nicholas941e7e22016-12-12 15:33:30 -05001650 return result;
1651}
1652
Ethan Nicholas00543112018-07-31 09:44:36 -04001653bool Compiler::optimize(Program& program) {
1654 SkASSERT(!fErrorCount);
Ethan Nicholas34b19c52020-09-14 11:33:47 -04001655 fIRGenerator->fKind = program.fKind;
1656 fIRGenerator->fSettings = &program.fSettings;
John Stiles7954d6c2020-09-01 10:53:02 -04001657
Ethan Nicholas34b19c52020-09-14 11:33:47 -04001658 while (fErrorCount == 0) {
1659 bool madeChanges = false;
John Stiles7954d6c2020-09-01 10:53:02 -04001660
Ethan Nicholas34b19c52020-09-14 11:33:47 -04001661 // Scan and optimize based on the control-flow graph for each function.
Brian Osman1179fcf2020-10-08 16:04:40 -04001662 for (const auto& element : program.elements()) {
1663 if (element->is<FunctionDefinition>()) {
1664 madeChanges |= this->scanCFG(element->as<FunctionDefinition>());
Ethan Nicholas34b19c52020-09-14 11:33:47 -04001665 }
1666 }
1667
1668 // Perform inline-candidate analysis and inline any functions deemed suitable.
John Stiles881a10c2020-09-19 10:13:24 -04001669 madeChanges |= fInliner.analyze(program);
Ethan Nicholas34b19c52020-09-14 11:33:47 -04001670
1671 // Remove dead functions. We wait until after analysis so that we still report errors,
1672 // even in unused code.
1673 if (program.fSettings.fRemoveDeadFunctions) {
1674 program.fElements.erase(
1675 std::remove_if(program.fElements.begin(),
1676 program.fElements.end(),
1677 [&](const std::unique_ptr<ProgramElement>& element) {
1678 if (!element->is<FunctionDefinition>()) {
1679 return false;
1680 }
1681 const auto& fn = element->as<FunctionDefinition>();
Ethan Nicholased84b732020-10-08 11:45:44 -04001682 bool dead = fn.fDeclaration.callCount() == 0 &&
Ethan Nicholase2c49992020-10-05 11:49:11 -04001683 fn.fDeclaration.name() != "main";
Ethan Nicholas34b19c52020-09-14 11:33:47 -04001684 madeChanges |= dead;
1685 return dead;
1686 }),
1687 program.fElements.end());
1688 }
1689
1690 if (program.fKind != Program::kFragmentProcessor_Kind) {
Brian Osmanc0213602020-10-06 14:43:32 -04001691 // Remove declarations of dead global variables
Ethan Nicholas34b19c52020-09-14 11:33:47 -04001692 program.fElements.erase(
1693 std::remove_if(program.fElements.begin(), program.fElements.end(),
1694 [&](const std::unique_ptr<ProgramElement>& element) {
Brian Osmanc0213602020-10-06 14:43:32 -04001695 if (!element->is<GlobalVarDeclaration>()) {
Ethan Nicholas34b19c52020-09-14 11:33:47 -04001696 return false;
1697 }
Brian Osmanc0213602020-10-06 14:43:32 -04001698 const auto& varDecl = element->as<GlobalVarDeclaration>();
1699 bool dead = varDecl.fDecl->fVar->dead();
Ethan Nicholas34b19c52020-09-14 11:33:47 -04001700 madeChanges |= dead;
1701 return dead;
1702 }),
1703 program.fElements.end());
1704 }
John Stiles73a6bff2020-09-09 13:40:37 -04001705
Ethan Nicholas34b19c52020-09-14 11:33:47 -04001706 if (!madeChanges) {
1707 break;
Ethan Nicholas0dc80872019-02-08 15:46:24 -05001708 }
Ethan Nicholas00543112018-07-31 09:44:36 -04001709 }
Ethan Nicholas041fd0a2020-10-07 16:42:04 -04001710 program.finish();
Ethan Nicholas00543112018-07-31 09:44:36 -04001711 return fErrorCount == 0;
1712}
1713
Brian Osmanfb32ddf2019-06-18 10:14:20 -04001714#if defined(SKSL_STANDALONE) || SK_SUPPORT_GPU
1715
Ethan Nicholas00543112018-07-31 09:44:36 -04001716bool Compiler::toSPIRV(Program& program, OutputStream& out) {
Ethan Nicholasa6ae1f72017-03-16 09:56:54 -04001717#ifdef SK_ENABLE_SPIRV_VALIDATION
Ethan Nicholas0df1b042017-03-31 13:56:23 -04001718 StringStream buffer;
Ethan Nicholas5b5f0962017-09-11 13:50:14 -07001719 fSource = program.fSource.get();
Ethan Nicholas041fd0a2020-10-07 16:42:04 -04001720 SPIRVCodeGenerator cg(&fIRGenerator->fContext, fIRGenerator->fModifiers.get(), &program, this,
1721 &buffer);
Ethan Nicholasa6ae1f72017-03-16 09:56:54 -04001722 bool result = cg.generateCode();
Ethan Nicholas5b5f0962017-09-11 13:50:14 -07001723 fSource = nullptr;
Ethan Nicholasa6ae1f72017-03-16 09:56:54 -04001724 if (result) {
Ethan Nicholasa6ae1f72017-03-16 09:56:54 -04001725 spvtools::SpirvTools tools(SPV_ENV_VULKAN_1_0);
Ethan Nicholas762466e2017-06-29 10:03:38 -04001726 const String& data = buffer.str();
Ethan Nicholasd9d33c32018-06-12 11:05:59 -04001727 SkASSERT(0 == data.size() % 4);
Ethan Nicholasa6ae1f72017-03-16 09:56:54 -04001728 auto dumpmsg = [](spv_message_level_t, const char*, const spv_position_t&, const char* m) {
1729 SkDebugf("SPIR-V validation error: %s\n", m);
1730 };
1731 tools.SetMessageConsumer(dumpmsg);
Ethan Nicholasd9d33c32018-06-12 11:05:59 -04001732 // Verify that the SPIR-V we produced is valid. If this SkASSERT fails, check the logs prior
Ethan Nicholasa6ae1f72017-03-16 09:56:54 -04001733 // to the failure to see the validation errors.
Ethan Nicholasd9d33c32018-06-12 11:05:59 -04001734 SkAssertResult(tools.Validate((const uint32_t*) data.c_str(), data.size() / 4));
Ethan Nicholas762466e2017-06-29 10:03:38 -04001735 out.write(data.c_str(), data.size());
Ethan Nicholasa6ae1f72017-03-16 09:56:54 -04001736 }
1737#else
Ethan Nicholas5b5f0962017-09-11 13:50:14 -07001738 fSource = program.fSource.get();
Ethan Nicholas041fd0a2020-10-07 16:42:04 -04001739 SPIRVCodeGenerator cg(&fIRGenerator->fContext, fIRGenerator->fModifiers.get(), &program, this,
1740 &out);
Ethan Nicholas941e7e22016-12-12 15:33:30 -05001741 bool result = cg.generateCode();
Ethan Nicholas5b5f0962017-09-11 13:50:14 -07001742 fSource = nullptr;
Ethan Nicholasa6ae1f72017-03-16 09:56:54 -04001743#endif
Ethan Nicholasce33f102016-12-09 17:22:59 -05001744 return result;
1745}
1746
Ethan Nicholas00543112018-07-31 09:44:36 -04001747bool Compiler::toSPIRV(Program& program, String* out) {
Ethan Nicholas0df1b042017-03-31 13:56:23 -04001748 StringStream buffer;
Ethan Nicholas941e7e22016-12-12 15:33:30 -05001749 bool result = this->toSPIRV(program, buffer);
1750 if (result) {
Ethan Nicholas762466e2017-06-29 10:03:38 -04001751 *out = buffer.str();
Ethan Nicholas941e7e22016-12-12 15:33:30 -05001752 }
1753 return result;
1754}
1755
Ethan Nicholas00543112018-07-31 09:44:36 -04001756bool Compiler::toGLSL(Program& program, OutputStream& out) {
Ethan Nicholas5b5f0962017-09-11 13:50:14 -07001757 fSource = program.fSource.get();
Ethan Nicholas26a9aad2018-03-27 14:10:52 -04001758 GLSLCodeGenerator cg(fContext.get(), &program, this, &out);
Ethan Nicholas941e7e22016-12-12 15:33:30 -05001759 bool result = cg.generateCode();
Ethan Nicholas5b5f0962017-09-11 13:50:14 -07001760 fSource = nullptr;
Ethan Nicholas941e7e22016-12-12 15:33:30 -05001761 return result;
1762}
1763
Ethan Nicholas00543112018-07-31 09:44:36 -04001764bool Compiler::toGLSL(Program& program, String* out) {
Ethan Nicholas0df1b042017-03-31 13:56:23 -04001765 StringStream buffer;
Ethan Nicholas941e7e22016-12-12 15:33:30 -05001766 bool result = this->toGLSL(program, buffer);
1767 if (result) {
Ethan Nicholas762466e2017-06-29 10:03:38 -04001768 *out = buffer.str();
Ethan Nicholas941e7e22016-12-12 15:33:30 -05001769 }
1770 return result;
1771}
1772
Brian Osmanc0243912020-02-19 15:35:26 -05001773bool Compiler::toHLSL(Program& program, String* out) {
1774 String spirv;
1775 if (!this->toSPIRV(program, &spirv)) {
1776 return false;
1777 }
1778
1779 return SPIRVtoHLSL(spirv, out);
1780}
1781
Ethan Nicholas00543112018-07-31 09:44:36 -04001782bool Compiler::toMetal(Program& program, OutputStream& out) {
Ethan Nicholas26a9aad2018-03-27 14:10:52 -04001783 MetalCodeGenerator cg(fContext.get(), &program, this, &out);
Ethan Nicholascc305772017-10-13 16:17:45 -04001784 bool result = cg.generateCode();
Ethan Nicholascc305772017-10-13 16:17:45 -04001785 return result;
1786}
1787
Ethan Nicholas00543112018-07-31 09:44:36 -04001788bool Compiler::toMetal(Program& program, String* out) {
Timothy Liangb8eeb802018-07-23 16:46:16 -04001789 StringStream buffer;
1790 bool result = this->toMetal(program, buffer);
1791 if (result) {
1792 *out = buffer.str();
1793 }
1794 return result;
1795}
1796
Greg Daniela28ea672020-09-25 11:12:56 -04001797#if defined(SKSL_STANDALONE) || GR_TEST_UTILS
Ethan Nicholas00543112018-07-31 09:44:36 -04001798bool Compiler::toCPP(Program& program, String name, OutputStream& out) {
Ethan Nicholas5b5f0962017-09-11 13:50:14 -07001799 fSource = program.fSource.get();
Ethan Nicholas26a9aad2018-03-27 14:10:52 -04001800 CPPCodeGenerator cg(fContext.get(), &program, this, name, &out);
Ethan Nicholas762466e2017-06-29 10:03:38 -04001801 bool result = cg.generateCode();
Ethan Nicholas5b5f0962017-09-11 13:50:14 -07001802 fSource = nullptr;
Ethan Nicholas762466e2017-06-29 10:03:38 -04001803 return result;
1804}
1805
Ethan Nicholas00543112018-07-31 09:44:36 -04001806bool Compiler::toH(Program& program, String name, OutputStream& out) {
Ethan Nicholas5b5f0962017-09-11 13:50:14 -07001807 fSource = program.fSource.get();
Ethan Nicholas26a9aad2018-03-27 14:10:52 -04001808 HCodeGenerator cg(fContext.get(), &program, this, name, &out);
Ethan Nicholas762466e2017-06-29 10:03:38 -04001809 bool result = cg.generateCode();
Ethan Nicholas5b5f0962017-09-11 13:50:14 -07001810 fSource = nullptr;
Ethan Nicholas00543112018-07-31 09:44:36 -04001811 return result;
1812}
Greg Daniela28ea672020-09-25 11:12:56 -04001813#endif // defined(SKSL_STANDALONE) || GR_TEST_UTILS
Ethan Nicholas00543112018-07-31 09:44:36 -04001814
Ethan Nicholas2a479a52020-08-18 16:29:45 -04001815#endif // defined(SKSL_STANDALONE) || SK_SUPPORT_GPU
Brian Osman2e29ab52019-09-20 12:19:11 -04001816
1817#if !defined(SKSL_STANDALONE) && SK_SUPPORT_GPU
Brian Osmana4b91692020-08-10 14:26:16 -04001818bool Compiler::toPipelineStage(Program& program, PipelineStageArgs* outArgs) {
Ethan Nicholas00543112018-07-31 09:44:36 -04001819 fSource = program.fSource.get();
1820 StringStream buffer;
Brian Osman300fe1d2020-01-23 15:42:43 -05001821 PipelineStageCodeGenerator cg(fContext.get(), &program, this, &buffer, outArgs);
Ethan Nicholas00543112018-07-31 09:44:36 -04001822 bool result = cg.generateCode();
1823 fSource = nullptr;
1824 if (result) {
Brian Osman107c6662019-12-30 15:02:30 -05001825 outArgs->fCode = buffer.str();
Ethan Nicholas00543112018-07-31 09:44:36 -04001826 }
Ethan Nicholas762466e2017-06-29 10:03:38 -04001827 return result;
1828}
Brian Osmanfb32ddf2019-06-18 10:14:20 -04001829#endif
1830
Ethan Nicholas0e9401d2019-03-21 11:05:37 -04001831std::unique_ptr<ByteCode> Compiler::toByteCode(Program& program) {
Mike Klein853d4ed2020-08-20 00:41:00 +00001832#if defined(SK_ENABLE_SKSL_INTERPRETER)
Brian Osman808f0212020-01-21 15:36:47 -05001833 fSource = program.fSource.get();
Ethan Nicholas0e9401d2019-03-21 11:05:37 -04001834 std::unique_ptr<ByteCode> result(new ByteCode());
Brian Osmanb08cc022020-04-02 11:38:40 -04001835 ByteCodeGenerator cg(fContext.get(), &program, this, result.get());
1836 bool success = cg.generateCode();
1837 fSource = nullptr;
1838 if (success) {
Ethan Nicholas0e9401d2019-03-21 11:05:37 -04001839 return result;
1840 }
Mike Klein853d4ed2020-08-20 00:41:00 +00001841#else
1842 ABORT("ByteCode interpreter not enabled");
1843#endif
Ethan Nicholas0e9401d2019-03-21 11:05:37 -04001844 return nullptr;
1845}
1846
Brian Osman401a0092020-09-10 14:47:24 -04001847const char* Compiler::OperatorName(Token::Kind op) {
1848 switch (op) {
Ethan Nicholas5a9e7fb2020-04-17 12:45:51 -04001849 case Token::Kind::TK_PLUS: return "+";
1850 case Token::Kind::TK_MINUS: return "-";
1851 case Token::Kind::TK_STAR: return "*";
1852 case Token::Kind::TK_SLASH: return "/";
1853 case Token::Kind::TK_PERCENT: return "%";
1854 case Token::Kind::TK_SHL: return "<<";
1855 case Token::Kind::TK_SHR: return ">>";
1856 case Token::Kind::TK_LOGICALNOT: return "!";
1857 case Token::Kind::TK_LOGICALAND: return "&&";
1858 case Token::Kind::TK_LOGICALOR: return "||";
1859 case Token::Kind::TK_LOGICALXOR: return "^^";
1860 case Token::Kind::TK_BITWISENOT: return "~";
1861 case Token::Kind::TK_BITWISEAND: return "&";
1862 case Token::Kind::TK_BITWISEOR: return "|";
1863 case Token::Kind::TK_BITWISEXOR: return "^";
1864 case Token::Kind::TK_EQ: return "=";
1865 case Token::Kind::TK_EQEQ: return "==";
1866 case Token::Kind::TK_NEQ: return "!=";
1867 case Token::Kind::TK_LT: return "<";
1868 case Token::Kind::TK_GT: return ">";
1869 case Token::Kind::TK_LTEQ: return "<=";
1870 case Token::Kind::TK_GTEQ: return ">=";
1871 case Token::Kind::TK_PLUSEQ: return "+=";
1872 case Token::Kind::TK_MINUSEQ: return "-=";
1873 case Token::Kind::TK_STAREQ: return "*=";
1874 case Token::Kind::TK_SLASHEQ: return "/=";
1875 case Token::Kind::TK_PERCENTEQ: return "%=";
1876 case Token::Kind::TK_SHLEQ: return "<<=";
1877 case Token::Kind::TK_SHREQ: return ">>=";
1878 case Token::Kind::TK_LOGICALANDEQ: return "&&=";
1879 case Token::Kind::TK_LOGICALOREQ: return "||=";
1880 case Token::Kind::TK_LOGICALXOREQ: return "^^=";
1881 case Token::Kind::TK_BITWISEANDEQ: return "&=";
1882 case Token::Kind::TK_BITWISEOREQ: return "|=";
1883 case Token::Kind::TK_BITWISEXOREQ: return "^=";
1884 case Token::Kind::TK_PLUSPLUS: return "++";
1885 case Token::Kind::TK_MINUSMINUS: return "--";
1886 case Token::Kind::TK_COMMA: return ",";
Ethan Nicholas5b5f0962017-09-11 13:50:14 -07001887 default:
Brian Osman401a0092020-09-10 14:47:24 -04001888 ABORT("unsupported operator: %d\n", (int) op);
Ethan Nicholas5b5f0962017-09-11 13:50:14 -07001889 }
1890}
1891
1892
1893bool Compiler::IsAssignment(Token::Kind op) {
1894 switch (op) {
Ethan Nicholas5a9e7fb2020-04-17 12:45:51 -04001895 case Token::Kind::TK_EQ: // fall through
1896 case Token::Kind::TK_PLUSEQ: // fall through
1897 case Token::Kind::TK_MINUSEQ: // fall through
1898 case Token::Kind::TK_STAREQ: // fall through
1899 case Token::Kind::TK_SLASHEQ: // fall through
1900 case Token::Kind::TK_PERCENTEQ: // fall through
1901 case Token::Kind::TK_SHLEQ: // fall through
1902 case Token::Kind::TK_SHREQ: // fall through
1903 case Token::Kind::TK_BITWISEOREQ: // fall through
1904 case Token::Kind::TK_BITWISEXOREQ: // fall through
1905 case Token::Kind::TK_BITWISEANDEQ: // fall through
1906 case Token::Kind::TK_LOGICALOREQ: // fall through
1907 case Token::Kind::TK_LOGICALXOREQ: // fall through
1908 case Token::Kind::TK_LOGICALANDEQ:
Ethan Nicholas5b5f0962017-09-11 13:50:14 -07001909 return true;
1910 default:
1911 return false;
1912 }
1913}
1914
Brian Osman401a0092020-09-10 14:47:24 -04001915Token::Kind Compiler::RemoveAssignment(Token::Kind op) {
1916 switch (op) {
1917 case Token::Kind::TK_PLUSEQ: return Token::Kind::TK_PLUS;
1918 case Token::Kind::TK_MINUSEQ: return Token::Kind::TK_MINUS;
1919 case Token::Kind::TK_STAREQ: return Token::Kind::TK_STAR;
1920 case Token::Kind::TK_SLASHEQ: return Token::Kind::TK_SLASH;
1921 case Token::Kind::TK_PERCENTEQ: return Token::Kind::TK_PERCENT;
1922 case Token::Kind::TK_SHLEQ: return Token::Kind::TK_SHL;
1923 case Token::Kind::TK_SHREQ: return Token::Kind::TK_SHR;
1924 case Token::Kind::TK_BITWISEOREQ: return Token::Kind::TK_BITWISEOR;
1925 case Token::Kind::TK_BITWISEXOREQ: return Token::Kind::TK_BITWISEXOR;
1926 case Token::Kind::TK_BITWISEANDEQ: return Token::Kind::TK_BITWISEAND;
1927 case Token::Kind::TK_LOGICALOREQ: return Token::Kind::TK_LOGICALOR;
1928 case Token::Kind::TK_LOGICALXOREQ: return Token::Kind::TK_LOGICALXOR;
1929 case Token::Kind::TK_LOGICALANDEQ: return Token::Kind::TK_LOGICALAND;
1930 default: return op;
1931 }
1932}
1933
Ethan Nicholas5b5f0962017-09-11 13:50:14 -07001934Position Compiler::position(int offset) {
Ethan Nicholasd9d33c32018-06-12 11:05:59 -04001935 SkASSERT(fSource);
Ethan Nicholas5b5f0962017-09-11 13:50:14 -07001936 int line = 1;
1937 int column = 1;
1938 for (int i = 0; i < offset; i++) {
1939 if ((*fSource)[i] == '\n') {
1940 ++line;
1941 column = 1;
1942 }
1943 else {
1944 ++column;
1945 }
1946 }
1947 return Position(line, column);
1948}
1949
1950void Compiler::error(int offset, String msg) {
ethannicholasb3058bd2016-07-01 08:22:01 -07001951 fErrorCount++;
Ethan Nicholas5b5f0962017-09-11 13:50:14 -07001952 Position pos = this->position(offset);
1953 fErrorText += "error: " + to_string(pos.fLine) + ": " + msg.c_str() + "\n";
ethannicholasb3058bd2016-07-01 08:22:01 -07001954}
1955
Ethan Nicholas0df1b042017-03-31 13:56:23 -04001956String Compiler::errorText() {
Ethan Nicholas00543112018-07-31 09:44:36 -04001957 this->writeErrorCount();
1958 fErrorCount = 0;
Ethan Nicholas0df1b042017-03-31 13:56:23 -04001959 String result = fErrorText;
ethannicholasb3058bd2016-07-01 08:22:01 -07001960 return result;
1961}
1962
1963void Compiler::writeErrorCount() {
1964 if (fErrorCount) {
1965 fErrorText += to_string(fErrorCount) + " error";
1966 if (fErrorCount > 1) {
1967 fErrorText += "s";
1968 }
1969 fErrorText += "\n";
1970 }
1971}
1972
John Stilesa6841be2020-08-06 14:11:56 -04001973} // namespace SkSL