blob: ab821e6295ddc8d01bbbedb4d2254d62b2004201 [file] [log] [blame]
Brian Osman0a442b72020-12-02 11:12:51 -05001/*
2 * Copyright 2020 Google LLC
3 *
4 * Use of this source code is governed by a BSD-style license that can be
5 * found in the LICENSE file.
6 */
7
8#include "include/private/SkTArray.h"
Brian Osmanb8ebe232021-01-19 16:33:11 -05009#include "include/private/SkTPin.h"
Brian Osman0a442b72020-12-02 11:12:51 -050010#include "src/sksl/SkSLCodeGenerator.h"
Brian Osman00185012021-02-04 16:07:11 -050011#include "src/sksl/SkSLCompiler.h"
12#include "src/sksl/SkSLOperators.h"
Brian Osman0a442b72020-12-02 11:12:51 -050013#include "src/sksl/SkSLVMGenerator.h"
14#include "src/sksl/ir/SkSLBinaryExpression.h"
15#include "src/sksl/ir/SkSLBlock.h"
16#include "src/sksl/ir/SkSLBoolLiteral.h"
17#include "src/sksl/ir/SkSLBreakStatement.h"
18#include "src/sksl/ir/SkSLConstructor.h"
19#include "src/sksl/ir/SkSLContinueStatement.h"
20#include "src/sksl/ir/SkSLDoStatement.h"
21#include "src/sksl/ir/SkSLExpressionStatement.h"
22#include "src/sksl/ir/SkSLExternalFunctionCall.h"
Brian Osmanbe0b3b72021-01-06 14:27:35 -050023#include "src/sksl/ir/SkSLExternalFunctionReference.h"
Brian Osman0a442b72020-12-02 11:12:51 -050024#include "src/sksl/ir/SkSLFieldAccess.h"
25#include "src/sksl/ir/SkSLFloatLiteral.h"
26#include "src/sksl/ir/SkSLForStatement.h"
27#include "src/sksl/ir/SkSLFunctionCall.h"
28#include "src/sksl/ir/SkSLFunctionDeclaration.h"
29#include "src/sksl/ir/SkSLFunctionDefinition.h"
30#include "src/sksl/ir/SkSLIfStatement.h"
31#include "src/sksl/ir/SkSLIndexExpression.h"
32#include "src/sksl/ir/SkSLIntLiteral.h"
Brian Osman0a442b72020-12-02 11:12:51 -050033#include "src/sksl/ir/SkSLPostfixExpression.h"
34#include "src/sksl/ir/SkSLPrefixExpression.h"
35#include "src/sksl/ir/SkSLProgramElement.h"
36#include "src/sksl/ir/SkSLReturnStatement.h"
37#include "src/sksl/ir/SkSLStatement.h"
38#include "src/sksl/ir/SkSLSwitchStatement.h"
39#include "src/sksl/ir/SkSLSwizzle.h"
40#include "src/sksl/ir/SkSLTernaryExpression.h"
41#include "src/sksl/ir/SkSLVarDeclarations.h"
42#include "src/sksl/ir/SkSLVariableReference.h"
43
44#include <algorithm>
45#include <unordered_map>
46
Mike Kleinff4decc2021-02-10 16:13:35 -060047namespace {
48 // sksl allows the optimizations of fast_mul(), so we want to use that most of the time.
49 // This little sneaky snippet of code lets us use ** as a fast multiply infix operator.
50 struct FastF32 { skvm::F32 val; };
51 static FastF32 operator*(skvm::F32 y) { return {y}; }
52 static skvm::F32 operator*(skvm::F32 x, FastF32 y) { return fast_mul(x, y.val); }
53 static skvm::F32 operator*(float x, FastF32 y) { return fast_mul(x, y.val); }
54}
55
Brian Osman0a442b72020-12-02 11:12:51 -050056namespace SkSL {
57
58namespace {
59
Brian Osman0a442b72020-12-02 11:12:51 -050060// Holds scalars, vectors, or matrices
61struct Value {
62 Value() = default;
63 explicit Value(size_t slots) {
64 fVals.resize(slots);
65 }
66 Value(skvm::F32 x) : fVals({ x.id }) {}
67 Value(skvm::I32 x) : fVals({ x.id }) {}
68
69 explicit operator bool() const { return !fVals.empty(); }
70
71 size_t slots() const { return fVals.size(); }
72
73 struct ValRef {
74 ValRef(skvm::Val& val) : fVal(val) {}
75
76 ValRef& operator=(ValRef v) { fVal = v.fVal; return *this; }
77 ValRef& operator=(skvm::Val v) { fVal = v; return *this; }
78 ValRef& operator=(skvm::F32 v) { fVal = v.id; return *this; }
79 ValRef& operator=(skvm::I32 v) { fVal = v.id; return *this; }
80
81 operator skvm::Val() { return fVal; }
82
83 skvm::Val& fVal;
84 };
85
Brian Osmanf932c692021-01-26 13:54:07 -050086 ValRef operator[](size_t i) {
87 // These redundant asserts work around what we think is a codegen bug in GCC 8.x for
88 // 32-bit x86 Debug builds.
89 SkASSERT(i < fVals.size());
90 return fVals[i];
91 }
92 skvm::Val operator[](size_t i) const {
93 // These redundant asserts work around what we think is a codegen bug in GCC 8.x for
94 // 32-bit x86 Debug builds.
95 SkASSERT(i < fVals.size());
96 return fVals[i];
97 }
Brian Osman0a442b72020-12-02 11:12:51 -050098
Brian Osman54515b72021-01-07 14:38:08 -050099 SkSpan<skvm::Val> asSpan() { return fVals; }
100
Brian Osman0a442b72020-12-02 11:12:51 -0500101private:
102 SkSTArray<4, skvm::Val, true> fVals;
103};
104
105} // namespace
106
107class SkVMGenerator {
108public:
109 SkVMGenerator(const Program& program,
Brian Osman0a442b72020-12-02 11:12:51 -0500110 skvm::Builder* builder,
111 SkSpan<skvm::Val> uniforms,
Brian Osman0a442b72020-12-02 11:12:51 -0500112 skvm::Coord device,
113 skvm::Coord local,
Brian Osmandb2dad52021-01-07 14:08:30 -0500114 SampleChildFn sampleChild);
Brian Osman0a442b72020-12-02 11:12:51 -0500115
Brian Osmandb2dad52021-01-07 14:08:30 -0500116 void writeFunction(const FunctionDefinition& function,
117 SkSpan<skvm::Val> arguments,
118 SkSpan<skvm::Val> outReturn);
Brian Osman0a442b72020-12-02 11:12:51 -0500119
120private:
121 enum class Intrinsic {
122 // sksl_public.sksl declares these intrinsics (and defines some other inline)
123
124 // Angle & Trigonometry
Brian Osman22cc3be2020-12-30 10:38:15 -0500125 kRadians,
126 kDegrees,
Brian Osman0a442b72020-12-02 11:12:51 -0500127 kSin,
128 kCos,
129 kTan,
130
131 kASin,
132 kACos,
133 kATan,
134
135 // Exponential
136 kPow,
137 kExp,
138 kLog,
139 kExp2,
140 kLog2,
141
142 kSqrt,
143 kInverseSqrt,
144
145 // Common
146 kAbs,
147 kSign,
148 kFloor,
149 kCeil,
150 kFract,
151 kMod,
152
153 kMin,
154 kMax,
155 kClamp,
156 kSaturate,
157 kMix,
158 kStep,
159 kSmoothstep,
160
161 // Geometric
162 kLength,
163 kDistance,
164 kDot,
Brian Osman22cc3be2020-12-30 10:38:15 -0500165 kCross,
Brian Osman0a442b72020-12-02 11:12:51 -0500166 kNormalize,
Brian Osman22cc3be2020-12-30 10:38:15 -0500167 kFaceforward,
168 kReflect,
169 kRefract,
Brian Osman0a442b72020-12-02 11:12:51 -0500170
171 // Matrix
Brian Osman93aed9a2020-12-28 15:18:46 -0500172 kMatrixCompMult,
Brian Osman0a442b72020-12-02 11:12:51 -0500173 kInverse,
174
175 // Vector Relational
176 kLessThan,
177 kLessThanEqual,
178 kGreaterThan,
179 kGreaterThanEqual,
180 kEqual,
181 kNotEqual,
182
183 kAny,
184 kAll,
185 kNot,
186
187 // SkSL
188 kSample,
189 };
190
Brian Osman0a442b72020-12-02 11:12:51 -0500191 /**
192 * In SkSL, a Variable represents a named, typed value (along with qualifiers, etc).
Brian Osman21f57072021-01-25 13:51:57 -0500193 * Every Variable is mapped to one (or several, contiguous) indices into our vector of
Brian Osman0a442b72020-12-02 11:12:51 -0500194 * skvm::Val. Those skvm::Val entries hold the current actual value of that variable.
195 *
196 * NOTE: Conceptually, each Variable is just mapped to a Value. We could implement it that way,
Brian Osman21f57072021-01-25 13:51:57 -0500197 * (and eliminate the indirection), but it would add overhead for each Variable,
Brian Osman0a442b72020-12-02 11:12:51 -0500198 * and add additional (different) bookkeeping for things like lvalue-swizzles.
199 *
200 * Any time a variable appears in an expression, that's a VariableReference, which is a kind of
201 * Expression. Evaluating that VariableReference (or any other Expression) produces a Value,
202 * which is a set of skvm::Val. (This allows an Expression to produce a vector or matrix, in
203 * addition to a scalar).
204 *
Brian Osman21f57072021-01-25 13:51:57 -0500205 * For a VariableReference, producing a Value is straightforward - we get the slot of the
206 * Variable (from fVariableMap), use that to look up the current skvm::Vals holding the
207 * variable's contents, and construct a Value with those ids.
Brian Osman0a442b72020-12-02 11:12:51 -0500208 */
209
210 /**
Brian Osman21f57072021-01-25 13:51:57 -0500211 * Returns the slot holding v's Val(s). Allocates storage if this is first time 'v' is
Brian Osman0a442b72020-12-02 11:12:51 -0500212 * referenced. Compound variables (e.g. vectors) will consume more than one slot, with
213 * getSlot returning the start of the contiguous chunk of slots.
214 */
Brian Osman21f57072021-01-25 13:51:57 -0500215 size_t getSlot(const Variable& v);
Brian Osman0a442b72020-12-02 11:12:51 -0500216
Mike Kleinaebcf732021-01-14 10:15:00 -0600217 skvm::F32 f32(skvm::Val id) { SkASSERT(id != skvm::NA); return {fBuilder, id}; }
218 skvm::I32 i32(skvm::Val id) { SkASSERT(id != skvm::NA); return {fBuilder, id}; }
Brian Osman0a442b72020-12-02 11:12:51 -0500219
220 // Shorthand for scalars
221 skvm::F32 f32(const Value& v) { SkASSERT(v.slots() == 1); return f32(v[0]); }
222 skvm::I32 i32(const Value& v) { SkASSERT(v.slots() == 1); return i32(v[0]); }
223
224 template <typename Fn>
225 Value unary(const Value& v, Fn&& fn) {
226 Value result(v.slots());
227 for (size_t i = 0; i < v.slots(); ++i) {
228 result[i] = fn({fBuilder, v[i]});
229 }
230 return result;
231 }
232
Brian Osman54515b72021-01-07 14:38:08 -0500233 skvm::I32 mask() {
234 // As we encounter (possibly conditional) return statements, fReturned is updated to store
235 // the lanes that have already returned. For the remainder of the current function, those
236 // lanes should be disabled.
Brian Osman9333c872021-01-13 15:06:17 -0500237 return fConditionMask & fLoopMask & ~currentFunction().fReturned;
Brian Osman54515b72021-01-07 14:38:08 -0500238 }
Brian Osman0a442b72020-12-02 11:12:51 -0500239
Brian Osmanfa71ffa2021-01-26 14:05:31 -0500240 size_t fieldSlotOffset(const FieldAccess& expr);
241 size_t indexSlotOffset(const IndexExpression& expr);
242
Brian Osman0a442b72020-12-02 11:12:51 -0500243 Value writeExpression(const Expression& expr);
244 Value writeBinaryExpression(const BinaryExpression& b);
245 Value writeConstructor(const Constructor& c);
246 Value writeFunctionCall(const FunctionCall& c);
Brian Osmandd50b0c2021-01-11 17:04:29 -0500247 Value writeExternalFunctionCall(const ExternalFunctionCall& c);
Brian Osmanfa71ffa2021-01-26 14:05:31 -0500248 Value writeFieldAccess(const FieldAccess& expr);
249 Value writeIndexExpression(const IndexExpression& expr);
Brian Osman0a442b72020-12-02 11:12:51 -0500250 Value writeIntrinsicCall(const FunctionCall& c);
251 Value writePostfixExpression(const PostfixExpression& p);
252 Value writePrefixExpression(const PrefixExpression& p);
253 Value writeSwizzle(const Swizzle& swizzle);
254 Value writeTernaryExpression(const TernaryExpression& t);
Brian Osmanfa71ffa2021-01-26 14:05:31 -0500255 Value writeVariableExpression(const VariableReference& expr);
Brian Osman0a442b72020-12-02 11:12:51 -0500256
257 void writeStatement(const Statement& s);
258 void writeBlock(const Block& b);
Brian Osman9333c872021-01-13 15:06:17 -0500259 void writeBreakStatement();
260 void writeContinueStatement();
261 void writeForStatement(const ForStatement& f);
Brian Osman0a442b72020-12-02 11:12:51 -0500262 void writeIfStatement(const IfStatement& stmt);
263 void writeReturnStatement(const ReturnStatement& r);
264 void writeVarDeclaration(const VarDeclaration& decl);
265
266 Value writeStore(const Expression& lhs, const Value& rhs);
267
268 Value writeMatrixInverse2x2(const Value& m);
269 Value writeMatrixInverse3x3(const Value& m);
270 Value writeMatrixInverse4x4(const Value& m);
271
Brian Osmandb2dad52021-01-07 14:08:30 -0500272 //
273 // Global state for the lifetime of the generator:
274 //
Brian Osman0a442b72020-12-02 11:12:51 -0500275 const Program& fProgram;
Brian Osman0a442b72020-12-02 11:12:51 -0500276 skvm::Builder* fBuilder;
277
Brian Osman0a442b72020-12-02 11:12:51 -0500278 const skvm::Coord fLocalCoord;
279 const SampleChildFn fSampleChild;
Brian Osmandb2dad52021-01-07 14:08:30 -0500280 const std::unordered_map<String, Intrinsic> fIntrinsics;
Brian Osman0a442b72020-12-02 11:12:51 -0500281
282 // [Variable, first slot in fSlots]
Brian Osman21f57072021-01-25 13:51:57 -0500283 std::unordered_map<const Variable*, size_t> fVariableMap;
Brian Osmandb2dad52021-01-07 14:08:30 -0500284 std::vector<skvm::Val> fSlots;
Brian Osman0a442b72020-12-02 11:12:51 -0500285
Brian Osman9333c872021-01-13 15:06:17 -0500286 // Conditional execution mask (managed by ScopedCondition, and tied to control-flow scopes)
287 skvm::I32 fConditionMask;
288
289 // Similar: loop execution masks. Each loop starts with all lanes active (fLoopMask).
290 // 'break' disables a lane in fLoopMask until the loop finishes
291 // 'continue' disables a lane in fLoopMask, and sets fContinueMask to be re-enabled on the next
292 // iteration
293 skvm::I32 fLoopMask;
294 skvm::I32 fContinueMask;
Brian Osman54515b72021-01-07 14:38:08 -0500295
Brian Osmandb2dad52021-01-07 14:08:30 -0500296 //
297 // State that's local to the generation of a single function:
298 //
Brian Osman54515b72021-01-07 14:38:08 -0500299 struct Function {
300 const SkSpan<skvm::Val> fReturnValue;
301 skvm::I32 fReturned;
302 };
303 std::vector<Function> fFunctionStack;
304 Function& currentFunction() { return fFunctionStack.back(); }
Brian Osman0a442b72020-12-02 11:12:51 -0500305
Brian Osman9333c872021-01-13 15:06:17 -0500306 class ScopedCondition {
Brian Osman0a442b72020-12-02 11:12:51 -0500307 public:
Brian Osman9333c872021-01-13 15:06:17 -0500308 ScopedCondition(SkVMGenerator* generator, skvm::I32 mask)
309 : fGenerator(generator), fOldConditionMask(fGenerator->fConditionMask) {
310 fGenerator->fConditionMask &= mask;
Brian Osman0a442b72020-12-02 11:12:51 -0500311 }
312
Brian Osman9333c872021-01-13 15:06:17 -0500313 ~ScopedCondition() { fGenerator->fConditionMask = fOldConditionMask; }
Brian Osman0a442b72020-12-02 11:12:51 -0500314
315 private:
316 SkVMGenerator* fGenerator;
Brian Osman9333c872021-01-13 15:06:17 -0500317 skvm::I32 fOldConditionMask;
Brian Osman0a442b72020-12-02 11:12:51 -0500318 };
319};
320
321static Type::NumberKind base_number_kind(const Type& type) {
322 if (type.typeKind() == Type::TypeKind::kMatrix || type.typeKind() == Type::TypeKind::kVector) {
323 return base_number_kind(type.componentType());
324 }
325 return type.numberKind();
326}
327
328static inline bool is_uniform(const SkSL::Variable& var) {
329 return var.modifiers().fFlags & Modifiers::kUniform_Flag;
330}
331
332static size_t slot_count(const Type& type) {
333 switch (type.typeKind()) {
334 case Type::TypeKind::kOther:
335 return 0;
336 case Type::TypeKind::kStruct: {
337 size_t slots = 0;
338 for (const auto& f : type.fields()) {
339 slots += slot_count(*f.fType);
340 }
341 return slots;
342 }
343 case Type::TypeKind::kArray:
344 SkASSERT(type.columns() > 0);
345 return type.columns() * slot_count(type.componentType());
346 default:
347 return type.columns() * type.rows();
348 }
349}
350
351SkVMGenerator::SkVMGenerator(const Program& program,
Brian Osman0a442b72020-12-02 11:12:51 -0500352 skvm::Builder* builder,
353 SkSpan<skvm::Val> uniforms,
Brian Osman0a442b72020-12-02 11:12:51 -0500354 skvm::Coord device,
355 skvm::Coord local,
Brian Osmandb2dad52021-01-07 14:08:30 -0500356 SampleChildFn sampleChild)
Brian Osman0a442b72020-12-02 11:12:51 -0500357 : fProgram(program)
Brian Osman0a442b72020-12-02 11:12:51 -0500358 , fBuilder(builder)
359 , fLocalCoord(local)
360 , fSampleChild(std::move(sampleChild))
Brian Osman0a442b72020-12-02 11:12:51 -0500361 , fIntrinsics {
Brian Osman22cc3be2020-12-30 10:38:15 -0500362 { "radians", Intrinsic::kRadians },
363 { "degrees", Intrinsic::kDegrees },
364 { "sin", Intrinsic::kSin },
365 { "cos", Intrinsic::kCos },
366 { "tan", Intrinsic::kTan },
367 { "asin", Intrinsic::kASin },
368 { "acos", Intrinsic::kACos },
369 { "atan", Intrinsic::kATan },
Brian Osman0a442b72020-12-02 11:12:51 -0500370
Brian Osman22cc3be2020-12-30 10:38:15 -0500371 { "pow", Intrinsic::kPow },
372 { "exp", Intrinsic::kExp },
373 { "log", Intrinsic::kLog },
Brian Osman0a442b72020-12-02 11:12:51 -0500374 { "exp2", Intrinsic::kExp2 },
375 { "log2", Intrinsic::kLog2 },
376 { "sqrt", Intrinsic::kSqrt },
377 { "inversesqrt", Intrinsic::kInverseSqrt },
378
379 { "abs", Intrinsic::kAbs },
380 { "sign", Intrinsic::kSign },
381 { "floor", Intrinsic::kFloor },
382 { "ceil", Intrinsic::kCeil },
383 { "fract", Intrinsic::kFract },
384 { "mod", Intrinsic::kMod },
385
386 { "min", Intrinsic::kMin },
387 { "max", Intrinsic::kMax },
388 { "clamp", Intrinsic::kClamp },
389 { "saturate", Intrinsic::kSaturate },
390 { "mix", Intrinsic::kMix },
391 { "step", Intrinsic::kStep },
392 { "smoothstep", Intrinsic::kSmoothstep },
393
Brian Osman22cc3be2020-12-30 10:38:15 -0500394 { "length", Intrinsic::kLength },
395 { "distance", Intrinsic::kDistance },
396 { "dot", Intrinsic::kDot },
397 { "cross", Intrinsic::kCross },
398 { "normalize", Intrinsic::kNormalize },
399 { "faceforward", Intrinsic::kFaceforward },
400 { "reflect", Intrinsic::kReflect },
401 { "refract", Intrinsic::kRefract },
Brian Osman0a442b72020-12-02 11:12:51 -0500402
Brian Osman93aed9a2020-12-28 15:18:46 -0500403 { "matrixCompMult", Intrinsic::kMatrixCompMult },
404 { "inverse", Intrinsic::kInverse },
Brian Osman0a442b72020-12-02 11:12:51 -0500405
406 { "lessThan", Intrinsic::kLessThan },
407 { "lessThanEqual", Intrinsic::kLessThanEqual },
408 { "greaterThan", Intrinsic::kGreaterThan },
409 { "greaterThanEqual", Intrinsic::kGreaterThanEqual },
410 { "equal", Intrinsic::kEqual },
411 { "notEqual", Intrinsic::kNotEqual },
412
413 { "any", Intrinsic::kAny },
414 { "all", Intrinsic::kAll },
415 { "not", Intrinsic::kNot },
416
417 { "sample", Intrinsic::kSample },
418 } {
Brian Osman9333c872021-01-13 15:06:17 -0500419 fConditionMask = fLoopMask = fBuilder->splat(0xffff'ffff);
Brian Osman0a442b72020-12-02 11:12:51 -0500420
421 // Now, add storage for each global variable (including uniforms) to fSlots, and entries in
422 // fVariableMap to remember where every variable is stored.
423 const skvm::Val* uniformIter = uniforms.begin();
424 size_t fpCount = 0;
425 for (const ProgramElement* e : fProgram.elements()) {
426 if (e->is<GlobalVarDeclaration>()) {
Brian Osmanc0576692021-02-17 13:52:35 -0500427 const GlobalVarDeclaration& gvd = e->as<GlobalVarDeclaration>();
428 const VarDeclaration& decl = gvd.declaration()->as<VarDeclaration>();
429 const Variable& var = decl.var();
Brian Osman0a442b72020-12-02 11:12:51 -0500430 SkASSERT(fVariableMap.find(&var) == fVariableMap.end());
431
432 // For most variables, fVariableMap stores an index into fSlots, but for fragment
433 // processors (child shaders), fVariableMap stores the index to pass to fSampleChild().
John Stiles54e7c052021-01-11 14:22:36 -0500434 if (var.type() == *fProgram.fContext->fTypes.fFragmentProcessor) {
Brian Osman0a442b72020-12-02 11:12:51 -0500435 fVariableMap[&var] = fpCount++;
436 continue;
437 }
438
439 // Opaque types include fragment processors, GL objects (samplers, textures, etc), and
440 // special types like 'void'. Of those, only fragment processors are legal variables.
441 SkASSERT(!var.type().isOpaque());
442
Brian Osmanc0576692021-02-17 13:52:35 -0500443 // getSlot() allocates space for the variable's value in fSlots, initializes it to zero,
444 // and populates fVariableMap.
445 size_t slot = this->getSlot(var),
446 nslots = slot_count(var.type());
Brian Osman0a442b72020-12-02 11:12:51 -0500447
448 if (int builtin = var.modifiers().fLayout.fBuiltin; builtin >= 0) {
449 // builtin variables are system-defined, with special semantics. The only builtin
450 // variable exposed to runtime effects is sk_FragCoord.
451 switch (builtin) {
452 case SK_FRAGCOORD_BUILTIN:
453 SkASSERT(nslots == 4);
Brian Osmanc0576692021-02-17 13:52:35 -0500454 fSlots[slot + 0] = device.x.id;
455 fSlots[slot + 1] = device.y.id;
456 fSlots[slot + 2] = fBuilder->splat(0.0f).id;
457 fSlots[slot + 3] = fBuilder->splat(1.0f).id;
Brian Osman0a442b72020-12-02 11:12:51 -0500458 break;
459 default:
460 SkDEBUGFAIL("Unsupported builtin");
461 }
462 } else if (is_uniform(var)) {
463 // For uniforms, copy the supplied IDs over
464 SkASSERT(uniformIter + nslots <= uniforms.end());
Brian Osmanc0576692021-02-17 13:52:35 -0500465 std::copy(uniformIter, uniformIter + nslots, fSlots.begin() + slot);
Brian Osman0a442b72020-12-02 11:12:51 -0500466 uniformIter += nslots;
Brian Osmanc0576692021-02-17 13:52:35 -0500467 } else if (decl.value()) {
468 // For other globals, populate with the initializer expression (if there is one)
469 Value val = this->writeExpression(*decl.value());
470 for (size_t i = 0; i < nslots; ++i) {
471 fSlots[slot + i] = val[i];
472 }
Brian Osman0a442b72020-12-02 11:12:51 -0500473 }
474 }
475 }
476 SkASSERT(uniformIter == uniforms.end());
Brian Osman0a442b72020-12-02 11:12:51 -0500477}
478
Brian Osmandb2dad52021-01-07 14:08:30 -0500479void SkVMGenerator::writeFunction(const FunctionDefinition& function,
480 SkSpan<skvm::Val> arguments,
481 SkSpan<skvm::Val> outReturn) {
Brian Osmandb2dad52021-01-07 14:08:30 -0500482 const FunctionDeclaration& decl = function.declaration();
Brian Osman54515b72021-01-07 14:38:08 -0500483 SkASSERT(slot_count(decl.returnType()) == outReturn.size());
Brian Osmandb2dad52021-01-07 14:08:30 -0500484
Brian Osman54515b72021-01-07 14:38:08 -0500485 fFunctionStack.push_back({outReturn, /*returned=*/fBuilder->splat(0)});
Brian Osmandb2dad52021-01-07 14:08:30 -0500486
487 // For all parameters, copy incoming argument IDs to our vector of (all) variable IDs
Brian Osman5933d4c2021-01-05 13:02:20 -0500488 size_t argIdx = 0;
Brian Osmandb2dad52021-01-07 14:08:30 -0500489 for (const Variable* p : decl.parameters()) {
Brian Osman21f57072021-01-25 13:51:57 -0500490 size_t paramSlot = this->getSlot(*p),
491 nslots = slot_count(p->type());
Brian Osman5933d4c2021-01-05 13:02:20 -0500492
Brian Osmandb2dad52021-01-07 14:08:30 -0500493 for (size_t i = 0; i < nslots; ++i) {
494 fSlots[paramSlot + i] = arguments[argIdx + i];
495 }
496 argIdx += nslots;
497 }
498 SkASSERT(argIdx == arguments.size());
499
500 this->writeStatement(*function.body());
501
502 // Copy 'out' and 'inout' parameters back to their caller-supplied argument storage
503 argIdx = 0;
504 for (const Variable* p : decl.parameters()) {
505 size_t nslots = slot_count(p->type());
506
Brian Osman5933d4c2021-01-05 13:02:20 -0500507 if (p->modifiers().fFlags & Modifiers::kOut_Flag) {
Brian Osman21f57072021-01-25 13:51:57 -0500508 size_t paramSlot = this->getSlot(*p);
Brian Osman5933d4c2021-01-05 13:02:20 -0500509 for (size_t i = 0; i < nslots; ++i) {
Brian Osmandb2dad52021-01-07 14:08:30 -0500510 arguments[argIdx + i] = fSlots[paramSlot + i];
Brian Osman5933d4c2021-01-05 13:02:20 -0500511 }
512 }
513 argIdx += nslots;
514 }
Brian Osmandb2dad52021-01-07 14:08:30 -0500515 SkASSERT(argIdx == arguments.size());
Brian Osman54515b72021-01-07 14:38:08 -0500516
517 fFunctionStack.pop_back();
Brian Osman0a442b72020-12-02 11:12:51 -0500518}
519
Brian Osman21f57072021-01-25 13:51:57 -0500520size_t SkVMGenerator::getSlot(const Variable& v) {
Brian Osman0a442b72020-12-02 11:12:51 -0500521 auto entry = fVariableMap.find(&v);
522 if (entry != fVariableMap.end()) {
523 return entry->second;
524 }
525
Brian Osman0a442b72020-12-02 11:12:51 -0500526 size_t slot = fSlots.size(),
527 nslots = slot_count(v.type());
528 fSlots.resize(slot + nslots, fBuilder->splat(0.0f).id);
529 fVariableMap[&v] = slot;
530 return slot;
531}
532
Brian Osman0a442b72020-12-02 11:12:51 -0500533Value SkVMGenerator::writeBinaryExpression(const BinaryExpression& b) {
534 const Expression& left = *b.left();
535 const Expression& right = *b.right();
John Stiles45990502021-02-16 10:55:27 -0500536 Operator op = b.getOperator();
537 if (op.kind() == Token::Kind::TK_EQ) {
Brian Osman0a442b72020-12-02 11:12:51 -0500538 return this->writeStore(left, this->writeExpression(right));
539 }
540
541 const Type& lType = left.type();
542 const Type& rType = right.type();
543 bool lVecOrMtx = (lType.isVector() || lType.isMatrix());
544 bool rVecOrMtx = (rType.isVector() || rType.isMatrix());
John Stiles45990502021-02-16 10:55:27 -0500545 bool isAssignment = op.isAssignment();
Brian Osman0a442b72020-12-02 11:12:51 -0500546 if (isAssignment) {
John Stiles45990502021-02-16 10:55:27 -0500547 op = op.removeAssignment();
Brian Osman0a442b72020-12-02 11:12:51 -0500548 }
549 Type::NumberKind nk = base_number_kind(lType);
550
551 // A few ops require special treatment:
John Stiles45990502021-02-16 10:55:27 -0500552 switch (op.kind()) {
Brian Osman0a442b72020-12-02 11:12:51 -0500553 case Token::Kind::TK_LOGICALAND: {
554 SkASSERT(!isAssignment);
555 SkASSERT(nk == Type::NumberKind::kBoolean);
556 skvm::I32 lVal = i32(this->writeExpression(left));
Brian Osman9333c872021-01-13 15:06:17 -0500557 ScopedCondition shortCircuit(this, lVal);
Brian Osman0a442b72020-12-02 11:12:51 -0500558 skvm::I32 rVal = i32(this->writeExpression(right));
559 return lVal & rVal;
560 }
561 case Token::Kind::TK_LOGICALOR: {
562 SkASSERT(!isAssignment);
563 SkASSERT(nk == Type::NumberKind::kBoolean);
564 skvm::I32 lVal = i32(this->writeExpression(left));
Brian Osman9333c872021-01-13 15:06:17 -0500565 ScopedCondition shortCircuit(this, ~lVal);
Brian Osman0a442b72020-12-02 11:12:51 -0500566 skvm::I32 rVal = i32(this->writeExpression(right));
567 return lVal | rVal;
568 }
John Stiles94e72b92021-01-30 11:06:18 -0500569 case Token::Kind::TK_COMMA:
570 // We write the left side of the expression to preserve its side effects, even though we
571 // immediately discard the result.
572 this->writeExpression(left);
573 return this->writeExpression(right);
Brian Osman0a442b72020-12-02 11:12:51 -0500574 default:
575 break;
576 }
577
578 // All of the other ops always evaluate both sides of the expression
579 Value lVal = this->writeExpression(left),
580 rVal = this->writeExpression(right);
581
582 // Special case for M*V, V*M, M*M (but not V*V!)
John Stiles45990502021-02-16 10:55:27 -0500583 if (op.kind() == Token::Kind::TK_STAR
Brian Osman0a442b72020-12-02 11:12:51 -0500584 && lVecOrMtx && rVecOrMtx && !(lType.isVector() && rType.isVector())) {
585 int rCols = rType.columns(),
586 rRows = rType.rows(),
587 lCols = lType.columns(),
588 lRows = lType.rows();
589 // M*V treats the vector as a column
590 if (rType.isVector()) {
591 std::swap(rCols, rRows);
592 }
593 SkASSERT(lCols == rRows);
594 SkASSERT(slot_count(b.type()) == static_cast<size_t>(lRows * rCols));
595 Value result(lRows * rCols);
596 size_t resultIdx = 0;
597 for (int c = 0; c < rCols; ++c)
598 for (int r = 0; r < lRows; ++r) {
599 skvm::F32 sum = fBuilder->splat(0.0f);
600 for (int j = 0; j < lCols; ++j) {
601 sum += f32(lVal[j*lRows + r]) * f32(rVal[c*rRows + j]);
602 }
603 result[resultIdx++] = sum;
604 }
605 SkASSERT(resultIdx == result.slots());
606 return isAssignment ? this->writeStore(left, result) : result;
607 }
608
609 size_t nslots = std::max(lVal.slots(), rVal.slots());
610
Brian Osman0a442b72020-12-02 11:12:51 -0500611 auto binary = [&](auto&& f_fn, auto&& i_fn) {
612 Value result(nslots);
613 for (size_t i = 0; i < nslots; ++i) {
614 // If one side is scalar, replicate it to all channels
615 skvm::Val L = lVal.slots() == 1 ? lVal[0] : lVal[i],
616 R = rVal.slots() == 1 ? rVal[0] : rVal[i];
617 if (nk == Type::NumberKind::kFloat) {
618 result[i] = f_fn(f32(L), f32(R));
619 } else {
620 result[i] = i_fn(i32(L), i32(R));
621 }
622 }
623 return isAssignment ? this->writeStore(left, result) : result;
624 };
625
626 auto unsupported_f = [&](skvm::F32, skvm::F32) {
627 SkDEBUGFAIL("Unsupported operator");
628 return skvm::F32{};
629 };
630
John Stiles45990502021-02-16 10:55:27 -0500631 switch (op.kind()) {
Brian Osman0a442b72020-12-02 11:12:51 -0500632 case Token::Kind::TK_EQEQ: {
633 SkASSERT(!isAssignment);
634 Value cmp = binary([](skvm::F32 x, skvm::F32 y) { return x == y; },
635 [](skvm::I32 x, skvm::I32 y) { return x == y; });
636 skvm::I32 folded = i32(cmp[0]);
637 for (size_t i = 1; i < nslots; ++i) {
638 folded &= i32(cmp[i]);
639 }
640 return folded;
641 }
642 case Token::Kind::TK_NEQ: {
643 SkASSERT(!isAssignment);
644 Value cmp = binary([](skvm::F32 x, skvm::F32 y) { return x != y; },
645 [](skvm::I32 x, skvm::I32 y) { return x != y; });
646 skvm::I32 folded = i32(cmp[0]);
647 for (size_t i = 1; i < nslots; ++i) {
648 folded |= i32(cmp[i]);
649 }
650 return folded;
651 }
652 case Token::Kind::TK_GT:
653 return binary([](skvm::F32 x, skvm::F32 y) { return x > y; },
654 [](skvm::I32 x, skvm::I32 y) { return x > y; });
655 case Token::Kind::TK_GTEQ:
656 return binary([](skvm::F32 x, skvm::F32 y) { return x >= y; },
657 [](skvm::I32 x, skvm::I32 y) { return x >= y; });
658 case Token::Kind::TK_LT:
659 return binary([](skvm::F32 x, skvm::F32 y) { return x < y; },
660 [](skvm::I32 x, skvm::I32 y) { return x < y; });
661 case Token::Kind::TK_LTEQ:
662 return binary([](skvm::F32 x, skvm::F32 y) { return x <= y; },
663 [](skvm::I32 x, skvm::I32 y) { return x <= y; });
664
665 case Token::Kind::TK_PLUS:
666 return binary([](skvm::F32 x, skvm::F32 y) { return x + y; },
667 [](skvm::I32 x, skvm::I32 y) { return x + y; });
668 case Token::Kind::TK_MINUS:
669 return binary([](skvm::F32 x, skvm::F32 y) { return x - y; },
670 [](skvm::I32 x, skvm::I32 y) { return x - y; });
671 case Token::Kind::TK_STAR:
Mike Kleinff4decc2021-02-10 16:13:35 -0600672 return binary([](skvm::F32 x, skvm::F32 y) { return x ** y; },
Brian Osman0a442b72020-12-02 11:12:51 -0500673 [](skvm::I32 x, skvm::I32 y) { return x * y; });
674 case Token::Kind::TK_SLASH:
675 // Minimum spec (GLSL ES 1.0) has very loose requirements for integer operations.
676 // (Low-end GPUs may not have integer ALUs). Given that, we are allowed to do floating
677 // point division plus rounding. Section 10.28 of the spec even clarifies that the
678 // rounding mode is undefined (but round-towards-zero is the obvious/common choice).
679 return binary([](skvm::F32 x, skvm::F32 y) { return x / y; },
680 [](skvm::I32 x, skvm::I32 y) {
681 return skvm::trunc(skvm::to_F32(x) / skvm::to_F32(y));
682 });
683
684 case Token::Kind::TK_BITWISEXOR:
685 case Token::Kind::TK_LOGICALXOR:
686 return binary(unsupported_f, [](skvm::I32 x, skvm::I32 y) { return x ^ y; });
687 case Token::Kind::TK_BITWISEAND:
688 return binary(unsupported_f, [](skvm::I32 x, skvm::I32 y) { return x & y; });
689 case Token::Kind::TK_BITWISEOR:
690 return binary(unsupported_f, [](skvm::I32 x, skvm::I32 y) { return x | y; });
691
692 // These three operators are all 'reserved' (illegal) in our minimum spec, but will require
693 // implementation in the future.
694 case Token::Kind::TK_PERCENT:
695 case Token::Kind::TK_SHL:
696 case Token::Kind::TK_SHR:
697 default:
698 SkDEBUGFAIL("Unsupported operator");
699 return {};
700 }
701}
702
703Value SkVMGenerator::writeConstructor(const Constructor& c) {
704 if (c.arguments().size() > 1) {
705 // Multi-argument constructors just aggregate their arguments, with no conversion
706 // NOTE: This (SkSL rule) is actually more restrictive than GLSL.
707 Value result(slot_count(c.type()));
708 size_t resultIdx = 0;
709 for (const auto &arg : c.arguments()) {
710 Value tmp = this->writeExpression(*arg);
711 for (size_t tmpSlot = 0; tmpSlot < tmp.slots(); ++tmpSlot) {
712 result[resultIdx++] = tmp[tmpSlot];
713 }
714 }
715 return result;
716 }
717
718 const Type& srcType = c.arguments()[0]->type();
719 const Type& dstType = c.type();
720 Type::NumberKind srcKind = base_number_kind(srcType),
John Stiles32d68532021-01-05 21:38:59 -0500721 dstKind = base_number_kind(dstType);
Brian Osman0a442b72020-12-02 11:12:51 -0500722 Value src = this->writeExpression(*c.arguments()[0]);
723 size_t dstSlots = slot_count(dstType);
724
725 // Conversion among "similar" types (floatN <-> halfN), (shortN <-> intN), etc. is a no-op
726 if (srcKind == dstKind && src.slots() == dstSlots) {
727 return src;
728 }
729
John Stiles32d68532021-01-05 21:38:59 -0500730 // TODO: Handle signed vs. unsigned. GLSL ES 1.0 only has 'int', so no problem yet.
Brian Osman0a442b72020-12-02 11:12:51 -0500731 if (srcKind != dstKind) {
732 // One argument constructors can do type conversion
733 Value dst(src.slots());
John Stiles32d68532021-01-05 21:38:59 -0500734 switch (dstKind) {
735 case Type::NumberKind::kFloat:
736 if (srcKind == Type::NumberKind::kSigned) {
737 // int -> float
738 for (size_t i = 0; i < src.slots(); ++i) {
739 dst[i] = skvm::to_F32(i32(src[i]));
740 }
741 return dst;
742 } else if (srcKind == Type::NumberKind::kBoolean) {
743 // bool -> float
744 for (size_t i = 0; i < src.slots(); ++i) {
745 dst[i] = skvm::select(i32(src[i]), 1.0f, 0.0f);
746 }
747 return dst;
748 }
749 break;
750
751 case Type::NumberKind::kSigned:
752 if (srcKind == Type::NumberKind::kFloat) {
753 // float -> int
754 for (size_t i = 0; i < src.slots(); ++i) {
755 dst[i] = skvm::trunc(f32(src[i]));
756 }
757 return dst;
758 } else if (srcKind == Type::NumberKind::kBoolean) {
759 // bool -> int
760 for (size_t i = 0; i < src.slots(); ++i) {
Mike Kleina738fb52021-01-14 12:11:48 -0600761 dst[i] = skvm::select(i32(src[i]), 1, 0);
John Stiles32d68532021-01-05 21:38:59 -0500762 }
763 return dst;
764 }
765 break;
766
767 case Type::NumberKind::kBoolean:
768 if (srcKind == Type::NumberKind::kSigned) {
769 // int -> bool
770 for (size_t i = 0; i < src.slots(); ++i) {
771 dst[i] = i32(src[i]) != 0;
772 }
773 return dst;
774 } else if (srcKind == Type::NumberKind::kFloat) {
775 // float -> bool
776 for (size_t i = 0; i < src.slots(); ++i) {
777 dst[i] = f32(src[i]) != 0.0;
778 }
779 return dst;
780 }
781 break;
782
783 default:
784 break;
Brian Osman0a442b72020-12-02 11:12:51 -0500785 }
John Stiles32d68532021-01-05 21:38:59 -0500786 SkDEBUGFAILF("Unsupported type conversion: %s -> %s", srcType.displayName().c_str(),
787 dstType.displayName().c_str());
788 return {};
Brian Osman0a442b72020-12-02 11:12:51 -0500789 }
790
791 // Matrices can be constructed from scalars or other matrices
792 if (dstType.isMatrix()) {
793 Value dst(dstType.rows() * dstType.columns());
794 size_t dstIndex = 0;
795 if (srcType.isMatrix()) {
796 // Matrix-from-matrix uses src where it overlaps, fills in missing with identity
797 for (int c = 0; c < dstType.columns(); ++c)
798 for (int r = 0; r < dstType.rows(); ++r) {
799 if (c < srcType.columns() && r < srcType.rows()) {
800 dst[dstIndex++] = src[c * srcType.rows() + r];
801 } else {
802 dst[dstIndex++] = fBuilder->splat(c == r ? 1.0f : 0.0f);
803 }
804 }
805 } else if (srcType.isScalar()) {
806 // Matrix-from-scalar builds a diagonal scale matrix
807 for (int c = 0; c < dstType.columns(); ++c)
808 for (int r = 0; r < dstType.rows(); ++r) {
809 dst[dstIndex++] = (c == r ? f32(src) : fBuilder->splat(0.0f));
810 }
811 } else {
812 SkDEBUGFAIL("Invalid matrix constructor");
813 }
814 SkASSERT(dstIndex == dst.slots());
815 return dst;
816 }
817
818 // We can splat scalars to all components of a vector
819 if (dstType.isVector() && srcType.isScalar()) {
820 Value dst(dstType.columns());
821 for (int i = 0; i < dstType.columns(); ++i) {
822 dst[i] = src[0];
823 }
824 return dst;
825 }
826
827 SkDEBUGFAIL("Invalid constructor");
828 return {};
829}
830
Brian Osmanfa71ffa2021-01-26 14:05:31 -0500831size_t SkVMGenerator::fieldSlotOffset(const FieldAccess& expr) {
Brian Osman21f57072021-01-25 13:51:57 -0500832 size_t offset = 0;
Brian Osmanfa71ffa2021-01-26 14:05:31 -0500833 for (int i = 0; i < expr.fieldIndex(); ++i) {
834 offset += slot_count(*expr.base()->type().fields()[i].fType);
835 }
836 return offset;
837}
838
839Value SkVMGenerator::writeFieldAccess(const FieldAccess& expr) {
840 Value base = this->writeExpression(*expr.base());
841 Value field(slot_count(expr.type()));
842 size_t offset = this->fieldSlotOffset(expr);
843 for (size_t i = 0; i < field.slots(); ++i) {
844 field[i] = base[offset + i];
845 }
846 return field;
847}
848
849size_t SkVMGenerator::indexSlotOffset(const IndexExpression& expr) {
850 Value index = this->writeExpression(*expr.index());
851 int indexValue = -1;
852 SkAssertResult(fBuilder->allImm(index[0], &indexValue));
853
854 // When indexing by a literal, the front-end guarantees that we don't go out of bounds.
855 // But when indexing by a loop variable, it's possible to generate out-of-bounds access.
856 // The GLSL spec leaves that behavior undefined - we'll just clamp everything here.
857 indexValue = SkTPin(indexValue, 0, expr.base()->type().columns() - 1);
858
859 size_t stride = slot_count(expr.type());
860 return indexValue * stride;
861}
862
863Value SkVMGenerator::writeIndexExpression(const IndexExpression& expr) {
864 Value base = this->writeExpression(*expr.base());
865 Value element(slot_count(expr.type()));
866 size_t offset = this->indexSlotOffset(expr);
867 for (size_t i = 0; i < element.slots(); ++i) {
868 element[i] = base[offset + i];
869 }
870 return element;
871}
872
873Value SkVMGenerator::writeVariableExpression(const VariableReference& expr) {
Brian Osman21f57072021-01-25 13:51:57 -0500874 size_t slot = this->getSlot(*expr.variable());
Brian Osmanfa71ffa2021-01-26 14:05:31 -0500875 Value val(slot_count(expr.type()));
Brian Osman0a442b72020-12-02 11:12:51 -0500876 for (size_t i = 0; i < val.slots(); ++i) {
877 val[i] = fSlots[slot + i];
878 }
879 return val;
880}
881
882Value SkVMGenerator::writeMatrixInverse2x2(const Value& m) {
883 SkASSERT(m.slots() == 4);
884 skvm::F32 a = f32(m[0]),
885 b = f32(m[1]),
886 c = f32(m[2]),
887 d = f32(m[3]);
888 skvm::F32 idet = 1.0f / (a*d - b*c);
889
890 Value result(m.slots());
Mike Kleinff4decc2021-02-10 16:13:35 -0600891 result[0] = ( d ** idet);
892 result[1] = (-b ** idet);
893 result[2] = (-c ** idet);
894 result[3] = ( a ** idet);
Brian Osman0a442b72020-12-02 11:12:51 -0500895 return result;
896}
897
898Value SkVMGenerator::writeMatrixInverse3x3(const Value& m) {
899 SkASSERT(m.slots() == 9);
900 skvm::F32 a11 = f32(m[0]), a12 = f32(m[3]), a13 = f32(m[6]),
901 a21 = f32(m[1]), a22 = f32(m[4]), a23 = f32(m[7]),
902 a31 = f32(m[2]), a32 = f32(m[5]), a33 = f32(m[8]);
903 skvm::F32 idet = 1.0f / (a11*a22*a33 + a12*a23*a31 + a13*a21*a32 -
904 a11*a23*a32 - a12*a21*a33 - a13*a22*a31);
905
906 Value result(m.slots());
Mike Kleinff4decc2021-02-10 16:13:35 -0600907 result[0] = ((a22**a33 - a23**a32) ** idet);
908 result[1] = ((a23**a31 - a21**a33) ** idet);
909 result[2] = ((a21**a32 - a22**a31) ** idet);
910 result[3] = ((a13**a32 - a12**a33) ** idet);
911 result[4] = ((a11**a33 - a13**a31) ** idet);
912 result[5] = ((a12**a31 - a11**a32) ** idet);
913 result[6] = ((a12**a23 - a13**a22) ** idet);
914 result[7] = ((a13**a21 - a11**a23) ** idet);
915 result[8] = ((a11**a22 - a12**a21) ** idet);
Brian Osman0a442b72020-12-02 11:12:51 -0500916 return result;
917}
918
919Value SkVMGenerator::writeMatrixInverse4x4(const Value& m) {
920 SkASSERT(m.slots() == 16);
921 skvm::F32 a00 = f32(m[0]), a10 = f32(m[4]), a20 = f32(m[ 8]), a30 = f32(m[12]),
922 a01 = f32(m[1]), a11 = f32(m[5]), a21 = f32(m[ 9]), a31 = f32(m[13]),
923 a02 = f32(m[2]), a12 = f32(m[6]), a22 = f32(m[10]), a32 = f32(m[14]),
924 a03 = f32(m[3]), a13 = f32(m[7]), a23 = f32(m[11]), a33 = f32(m[15]);
925
Mike Kleinff4decc2021-02-10 16:13:35 -0600926 skvm::F32 b00 = a00**a11 - a01**a10,
927 b01 = a00**a12 - a02**a10,
928 b02 = a00**a13 - a03**a10,
929 b03 = a01**a12 - a02**a11,
930 b04 = a01**a13 - a03**a11,
931 b05 = a02**a13 - a03**a12,
932 b06 = a20**a31 - a21**a30,
933 b07 = a20**a32 - a22**a30,
934 b08 = a20**a33 - a23**a30,
935 b09 = a21**a32 - a22**a31,
936 b10 = a21**a33 - a23**a31,
937 b11 = a22**a33 - a23**a32;
Brian Osman0a442b72020-12-02 11:12:51 -0500938
Mike Kleinff4decc2021-02-10 16:13:35 -0600939 skvm::F32 idet = 1.0f / (b00**b11 - b01**b10 + b02**b09 + b03**b08 - b04**b07 + b05**b06);
Brian Osman0a442b72020-12-02 11:12:51 -0500940
941 b00 *= idet;
942 b01 *= idet;
943 b02 *= idet;
944 b03 *= idet;
945 b04 *= idet;
946 b05 *= idet;
947 b06 *= idet;
948 b07 *= idet;
949 b08 *= idet;
950 b09 *= idet;
951 b10 *= idet;
952 b11 *= idet;
953
954 Value result(m.slots());
955 result[ 0] = (a11*b11 - a12*b10 + a13*b09);
956 result[ 1] = (a02*b10 - a01*b11 - a03*b09);
957 result[ 2] = (a31*b05 - a32*b04 + a33*b03);
958 result[ 3] = (a22*b04 - a21*b05 - a23*b03);
959 result[ 4] = (a12*b08 - a10*b11 - a13*b07);
960 result[ 5] = (a00*b11 - a02*b08 + a03*b07);
961 result[ 6] = (a32*b02 - a30*b05 - a33*b01);
962 result[ 7] = (a20*b05 - a22*b02 + a23*b01);
963 result[ 8] = (a10*b10 - a11*b08 + a13*b06);
964 result[ 9] = (a01*b08 - a00*b10 - a03*b06);
965 result[10] = (a30*b04 - a31*b02 + a33*b00);
966 result[11] = (a21*b02 - a20*b04 - a23*b00);
967 result[12] = (a11*b07 - a10*b09 - a12*b06);
968 result[13] = (a00*b09 - a01*b07 + a02*b06);
969 result[14] = (a31*b01 - a30*b03 - a32*b00);
970 result[15] = (a20*b03 - a21*b01 + a22*b00);
971 return result;
972}
973
974Value SkVMGenerator::writeIntrinsicCall(const FunctionCall& c) {
975 auto found = fIntrinsics.find(c.function().name());
976 if (found == fIntrinsics.end()) {
Brian Osman47726a12020-12-17 16:02:08 -0500977 SkDEBUGFAILF("Missing intrinsic: '%s'", String(c.function().name()).c_str());
Brian Osman0a442b72020-12-02 11:12:51 -0500978 return {};
979 }
980
981 const size_t nargs = c.arguments().size();
982
983 if (found->second == Intrinsic::kSample) {
984 // Sample is very special, the first argument is an FP, which can't be evaluated
985 const Context& ctx = *fProgram.fContext;
John Stiles54e7c052021-01-11 14:22:36 -0500986 if (nargs > 2 || c.arguments()[0]->type() != *ctx.fTypes.fFragmentProcessor ||
987 (nargs == 2 && (c.arguments()[1]->type() != *ctx.fTypes.fFloat2 &&
988 c.arguments()[1]->type() != *ctx.fTypes.fFloat3x3))) {
Brian Osman0a442b72020-12-02 11:12:51 -0500989 SkDEBUGFAIL("Invalid call to sample");
990 return {};
991 }
992
993 auto fp_it = fVariableMap.find(c.arguments()[0]->as<VariableReference>().variable());
994 SkASSERT(fp_it != fVariableMap.end());
995
996 skvm::Coord coord = fLocalCoord;
997 if (nargs == 2) {
998 Value arg = this->writeExpression(*c.arguments()[1]);
999 if (arg.slots() == 2) {
1000 // explicit sampling
1001 coord = {f32(arg[0]), f32(arg[1])};
1002 } else {
1003 // matrix sampling
1004 SkASSERT(arg.slots() == 9);
Mike Kleinff4decc2021-02-10 16:13:35 -06001005 skvm::F32 x = f32(arg[0])**coord.x + f32(arg[3])**coord.y + f32(arg[6]),
1006 y = f32(arg[1])**coord.x + f32(arg[4])**coord.y + f32(arg[7]),
1007 w = f32(arg[2])**coord.x + f32(arg[5])**coord.y + f32(arg[8]);
1008 x = x ** (1.0f / w);
1009 y = y ** (1.0f / w);
Brian Osman0a442b72020-12-02 11:12:51 -05001010 coord = {x, y};
1011 }
1012 }
1013
1014 skvm::Color color = fSampleChild(fp_it->second, coord);
1015 Value result(4);
1016 result[0] = color.r;
1017 result[1] = color.g;
1018 result[2] = color.b;
1019 result[3] = color.a;
1020 return result;
1021 }
1022
1023 const size_t kMaxArgs = 3; // eg: clamp, mix, smoothstep
1024 Value args[kMaxArgs];
1025 SkASSERT(nargs >= 1 && nargs <= SK_ARRAY_COUNT(args));
1026
1027 // All other intrinsics have at most three args, and those can all be evaluated up front:
1028 for (size_t i = 0; i < nargs; ++i) {
1029 args[i] = this->writeExpression(*c.arguments()[i]);
1030 }
1031 Type::NumberKind nk = base_number_kind(c.arguments()[0]->type());
1032
1033 auto binary = [&](auto&& fn) {
1034 // Binary intrinsics are (vecN, vecN), (vecN, float), or (float, vecN)
1035 size_t nslots = std::max(args[0].slots(), args[1].slots());
1036 Value result(nslots);
1037 SkASSERT(args[0].slots() == nslots || args[0].slots() == 1);
1038 SkASSERT(args[1].slots() == nslots || args[1].slots() == 1);
1039
1040 for (size_t i = 0; i < nslots; ++i) {
1041 result[i] = fn({fBuilder, args[0][args[0].slots() == 1 ? 0 : i]},
1042 {fBuilder, args[1][args[1].slots() == 1 ? 0 : i]});
1043 }
1044 return result;
1045 };
1046
1047 auto ternary = [&](auto&& fn) {
1048 // Ternary intrinsics are some combination of vecN and float
1049 size_t nslots = std::max({args[0].slots(), args[1].slots(), args[2].slots()});
1050 Value result(nslots);
1051 SkASSERT(args[0].slots() == nslots || args[0].slots() == 1);
1052 SkASSERT(args[1].slots() == nslots || args[1].slots() == 1);
1053 SkASSERT(args[2].slots() == nslots || args[2].slots() == 1);
1054
1055 for (size_t i = 0; i < nslots; ++i) {
1056 result[i] = fn({fBuilder, args[0][args[0].slots() == 1 ? 0 : i]},
1057 {fBuilder, args[1][args[1].slots() == 1 ? 0 : i]},
1058 {fBuilder, args[2][args[2].slots() == 1 ? 0 : i]});
1059 }
1060 return result;
1061 };
1062
1063 auto dot = [&](const Value& x, const Value& y) {
1064 SkASSERT(x.slots() == y.slots());
1065 skvm::F32 result = f32(x[0]) * f32(y[0]);
1066 for (size_t i = 1; i < x.slots(); ++i) {
1067 result += f32(x[i]) * f32(y[i]);
1068 }
1069 return result;
1070 };
1071
1072 switch (found->second) {
Brian Osman22cc3be2020-12-30 10:38:15 -05001073 case Intrinsic::kRadians:
1074 return unary(args[0], [](skvm::F32 deg) { return deg * (SK_FloatPI / 180); });
1075 case Intrinsic::kDegrees:
1076 return unary(args[0], [](skvm::F32 rad) { return rad * (180 / SK_FloatPI); });
1077
Brian Osman0a442b72020-12-02 11:12:51 -05001078 case Intrinsic::kSin: return unary(args[0], skvm::approx_sin);
1079 case Intrinsic::kCos: return unary(args[0], skvm::approx_cos);
1080 case Intrinsic::kTan: return unary(args[0], skvm::approx_tan);
1081
1082 case Intrinsic::kASin: return unary(args[0], skvm::approx_asin);
1083 case Intrinsic::kACos: return unary(args[0], skvm::approx_acos);
1084
1085 case Intrinsic::kATan: return nargs == 1 ? unary(args[0], skvm::approx_atan)
1086 : binary(skvm::approx_atan2);
1087
1088 case Intrinsic::kPow:
1089 return binary([](skvm::F32 x, skvm::F32 y) { return skvm::approx_powf(x, y); });
1090 case Intrinsic::kExp: return unary(args[0], skvm::approx_exp);
1091 case Intrinsic::kLog: return unary(args[0], skvm::approx_log);
1092 case Intrinsic::kExp2: return unary(args[0], skvm::approx_pow2);
1093 case Intrinsic::kLog2: return unary(args[0], skvm::approx_log2);
1094
1095 case Intrinsic::kSqrt: return unary(args[0], skvm::sqrt);
1096 case Intrinsic::kInverseSqrt:
1097 return unary(args[0], [](skvm::F32 x) { return 1.0f / skvm::sqrt(x); });
1098
1099 case Intrinsic::kAbs: return unary(args[0], skvm::abs);
1100 case Intrinsic::kSign:
1101 return unary(args[0], [](skvm::F32 x) { return select(x < 0, -1.0f,
1102 select(x > 0, +1.0f, 0.0f)); });
1103 case Intrinsic::kFloor: return unary(args[0], skvm::floor);
1104 case Intrinsic::kCeil: return unary(args[0], skvm::ceil);
1105 case Intrinsic::kFract: return unary(args[0], skvm::fract);
1106 case Intrinsic::kMod:
1107 return binary([](skvm::F32 x, skvm::F32 y) { return x - y*skvm::floor(x / y); });
1108
1109 case Intrinsic::kMin:
1110 return binary([](skvm::F32 x, skvm::F32 y) { return skvm::min(x, y); });
1111 case Intrinsic::kMax:
1112 return binary([](skvm::F32 x, skvm::F32 y) { return skvm::max(x, y); });
1113 case Intrinsic::kClamp:
1114 return ternary(
1115 [](skvm::F32 x, skvm::F32 lo, skvm::F32 hi) { return skvm::clamp(x, lo, hi); });
1116 case Intrinsic::kSaturate:
1117 return unary(args[0], [](skvm::F32 x) { return skvm::clamp01(x); });
1118 case Intrinsic::kMix:
1119 return ternary(
1120 [](skvm::F32 x, skvm::F32 y, skvm::F32 t) { return skvm::lerp(x, y, t); });
1121 case Intrinsic::kStep:
1122 return binary([](skvm::F32 edge, skvm::F32 x) { return select(x < edge, 0.0f, 1.0f); });
1123 case Intrinsic::kSmoothstep:
1124 return ternary([](skvm::F32 edge0, skvm::F32 edge1, skvm::F32 x) {
1125 skvm::F32 t = skvm::clamp01((x - edge0) / (edge1 - edge0));
Mike Kleinff4decc2021-02-10 16:13:35 -06001126 return t ** t ** (3 - 2 ** t);
Brian Osman0a442b72020-12-02 11:12:51 -05001127 });
1128
1129 case Intrinsic::kLength: return skvm::sqrt(dot(args[0], args[0]));
1130 case Intrinsic::kDistance: {
1131 Value vec = binary([](skvm::F32 x, skvm::F32 y) { return x - y; });
1132 return skvm::sqrt(dot(vec, vec));
1133 }
1134 case Intrinsic::kDot: return dot(args[0], args[1]);
Brian Osman22cc3be2020-12-30 10:38:15 -05001135 case Intrinsic::kCross: {
1136 skvm::F32 ax = f32(args[0][0]), ay = f32(args[0][1]), az = f32(args[0][2]),
1137 bx = f32(args[1][0]), by = f32(args[1][1]), bz = f32(args[1][2]);
1138 Value result(3);
Mike Kleinff4decc2021-02-10 16:13:35 -06001139 result[0] = ay**bz - az**by;
1140 result[1] = az**bx - ax**bz;
1141 result[2] = ax**by - ay**bx;
Brian Osman22cc3be2020-12-30 10:38:15 -05001142 return result;
1143 }
Brian Osman0a442b72020-12-02 11:12:51 -05001144 case Intrinsic::kNormalize: {
1145 skvm::F32 invLen = 1.0f / skvm::sqrt(dot(args[0], args[0]));
Mike Kleinff4decc2021-02-10 16:13:35 -06001146 return unary(args[0], [&](skvm::F32 x) { return x ** invLen; });
Brian Osman0a442b72020-12-02 11:12:51 -05001147 }
Brian Osman22cc3be2020-12-30 10:38:15 -05001148 case Intrinsic::kFaceforward: {
1149 const Value &N = args[0],
1150 &I = args[1],
1151 &Nref = args[2];
1152
1153 skvm::F32 dotNrefI = dot(Nref, I);
1154 return unary(N, [&](skvm::F32 n) { return select(dotNrefI<0, n, -n); });
1155 }
1156 case Intrinsic::kReflect: {
1157 const Value &I = args[0],
1158 &N = args[1];
1159
1160 skvm::F32 dotNI = dot(N, I);
1161 return binary([&](skvm::F32 i, skvm::F32 n) {
Mike Kleinff4decc2021-02-10 16:13:35 -06001162 return i - 2**dotNI**n;
Brian Osman22cc3be2020-12-30 10:38:15 -05001163 });
1164 }
1165 case Intrinsic::kRefract: {
1166 const Value &I = args[0],
1167 &N = args[1];
1168 skvm::F32 eta = f32(args[2]);
1169
1170 skvm::F32 dotNI = dot(N, I),
Mike Kleinff4decc2021-02-10 16:13:35 -06001171 k = 1 - eta**eta**(1 - dotNI**dotNI);
Brian Osman22cc3be2020-12-30 10:38:15 -05001172 return binary([&](skvm::F32 i, skvm::F32 n) {
Mike Kleinff4decc2021-02-10 16:13:35 -06001173 return select(k<0, 0.0f, eta**i - (eta**dotNI + sqrt(k))**n);
Brian Osman22cc3be2020-12-30 10:38:15 -05001174 });
1175 }
Brian Osman0a442b72020-12-02 11:12:51 -05001176
Brian Osman93aed9a2020-12-28 15:18:46 -05001177 case Intrinsic::kMatrixCompMult:
Mike Kleinff4decc2021-02-10 16:13:35 -06001178 return binary([](skvm::F32 x, skvm::F32 y) { return x ** y; });
Brian Osman0a442b72020-12-02 11:12:51 -05001179 case Intrinsic::kInverse: {
1180 switch (args[0].slots()) {
1181 case 4: return this->writeMatrixInverse2x2(args[0]);
1182 case 9: return this->writeMatrixInverse3x3(args[0]);
1183 case 16: return this->writeMatrixInverse4x4(args[0]);
1184 default:
1185 SkDEBUGFAIL("Invalid call to inverse");
1186 return {};
1187 }
1188 }
1189
1190 case Intrinsic::kLessThan:
Brian Osman30b67292020-12-23 13:02:09 -05001191 return nk == Type::NumberKind::kFloat
1192 ? binary([](skvm::F32 x, skvm::F32 y) { return x < y; })
1193 : binary([](skvm::I32 x, skvm::I32 y) { return x < y; });
Brian Osman0a442b72020-12-02 11:12:51 -05001194 case Intrinsic::kLessThanEqual:
Brian Osman30b67292020-12-23 13:02:09 -05001195 return nk == Type::NumberKind::kFloat
1196 ? binary([](skvm::F32 x, skvm::F32 y) { return x <= y; })
1197 : binary([](skvm::I32 x, skvm::I32 y) { return x <= y; });
Brian Osman0a442b72020-12-02 11:12:51 -05001198 case Intrinsic::kGreaterThan:
Brian Osman30b67292020-12-23 13:02:09 -05001199 return nk == Type::NumberKind::kFloat
1200 ? binary([](skvm::F32 x, skvm::F32 y) { return x > y; })
1201 : binary([](skvm::I32 x, skvm::I32 y) { return x > y; });
Brian Osman0a442b72020-12-02 11:12:51 -05001202 case Intrinsic::kGreaterThanEqual:
Brian Osman30b67292020-12-23 13:02:09 -05001203 return nk == Type::NumberKind::kFloat
1204 ? binary([](skvm::F32 x, skvm::F32 y) { return x >= y; })
1205 : binary([](skvm::I32 x, skvm::I32 y) { return x >= y; });
Brian Osman0a442b72020-12-02 11:12:51 -05001206
1207 case Intrinsic::kEqual:
1208 return nk == Type::NumberKind::kFloat
1209 ? binary([](skvm::F32 x, skvm::F32 y) { return x == y; })
1210 : binary([](skvm::I32 x, skvm::I32 y) { return x == y; });
1211 case Intrinsic::kNotEqual:
1212 return nk == Type::NumberKind::kFloat
1213 ? binary([](skvm::F32 x, skvm::F32 y) { return x != y; })
1214 : binary([](skvm::I32 x, skvm::I32 y) { return x != y; });
1215
1216 case Intrinsic::kAny: {
1217 skvm::I32 result = i32(args[0][0]);
1218 for (size_t i = 1; i < args[0].slots(); ++i) {
1219 result |= i32(args[0][i]);
1220 }
1221 return result;
1222 }
1223 case Intrinsic::kAll: {
1224 skvm::I32 result = i32(args[0][0]);
1225 for (size_t i = 1; i < args[0].slots(); ++i) {
1226 result &= i32(args[0][i]);
1227 }
1228 return result;
1229 }
1230 case Intrinsic::kNot: return unary(args[0], [](skvm::I32 x) { return ~x; });
1231
1232 case Intrinsic::kSample:
1233 // Handled earlier
1234 SkASSERT(false);
1235 return {};
1236 }
1237 SkUNREACHABLE;
1238}
1239
1240Value SkVMGenerator::writeFunctionCall(const FunctionCall& f) {
Brian Osman54515b72021-01-07 14:38:08 -05001241 if (f.function().isBuiltin() && !f.function().definition()) {
Brian Osman0a442b72020-12-02 11:12:51 -05001242 return this->writeIntrinsicCall(f);
1243 }
1244
Brian Osman54515b72021-01-07 14:38:08 -05001245 const FunctionDeclaration& decl = f.function();
1246
1247 // Evaluate all arguments, gather the results into a contiguous list of IDs
1248 std::vector<skvm::Val> argVals;
1249 for (const auto& arg : f.arguments()) {
1250 Value v = this->writeExpression(*arg);
1251 for (size_t i = 0; i < v.slots(); ++i) {
1252 argVals.push_back(v[i]);
1253 }
1254 }
1255
1256 // Create storage for the return value
1257 size_t nslots = slot_count(f.type());
1258 Value result(nslots);
1259 for (size_t i = 0; i < nslots; ++i) {
1260 result[i] = fBuilder->splat(0.0f);
1261 }
1262
1263 {
Brian Osman9333c872021-01-13 15:06:17 -05001264 // This merges currentFunction().fReturned into fConditionMask. Lanes that conditionally
Brian Osman54515b72021-01-07 14:38:08 -05001265 // returned in the current function would otherwise resume execution within the child.
Brian Osman9333c872021-01-13 15:06:17 -05001266 ScopedCondition m(this, ~currentFunction().fReturned);
Brian Osman54515b72021-01-07 14:38:08 -05001267 this->writeFunction(*f.function().definition(), argVals, result.asSpan());
1268 }
1269
1270 // Propagate new values of any 'out' params back to the original arguments
1271 const std::unique_ptr<Expression>* argIter = f.arguments().begin();
1272 size_t valIdx = 0;
1273 for (const Variable* p : decl.parameters()) {
1274 size_t nslots = slot_count(p->type());
1275 if (p->modifiers().fFlags & Modifiers::kOut_Flag) {
1276 Value v(nslots);
1277 for (size_t i = 0; i < nslots; ++i) {
1278 v[i] = argVals[valIdx + i];
1279 }
1280 const std::unique_ptr<Expression>& arg = *argIter;
1281 this->writeStore(*arg, v);
1282 }
1283 valIdx += nslots;
1284 argIter++;
1285 }
1286
1287 return result;
Brian Osman0a442b72020-12-02 11:12:51 -05001288}
1289
Brian Osmandd50b0c2021-01-11 17:04:29 -05001290Value SkVMGenerator::writeExternalFunctionCall(const ExternalFunctionCall& c) {
1291 // Evaluate all arguments, gather the results into a contiguous list of F32
1292 std::vector<skvm::F32> args;
1293 for (const auto& arg : c.arguments()) {
1294 Value v = this->writeExpression(*arg);
1295 for (size_t i = 0; i < v.slots(); ++i) {
1296 args.push_back(f32(v[i]));
1297 }
1298 }
1299
1300 // Create storage for the return value
1301 size_t nslots = slot_count(c.type());
1302 std::vector<skvm::F32> result(nslots, fBuilder->splat(0.0f));
1303
1304 c.function().call(fBuilder, args.data(), result.data(), this->mask());
1305
1306 // Convert from 'vector of F32' to Value
1307 Value resultVal(nslots);
1308 for (size_t i = 0; i < nslots; ++i) {
1309 resultVal[i] = result[i];
1310 }
1311
1312 return resultVal;
1313}
1314
Brian Osman0a442b72020-12-02 11:12:51 -05001315Value SkVMGenerator::writePrefixExpression(const PrefixExpression& p) {
1316 Value val = this->writeExpression(*p.operand());
1317
John Stiles45990502021-02-16 10:55:27 -05001318 switch (p.getOperator().kind()) {
Brian Osman0a442b72020-12-02 11:12:51 -05001319 case Token::Kind::TK_PLUSPLUS:
1320 case Token::Kind::TK_MINUSMINUS: {
John Stiles45990502021-02-16 10:55:27 -05001321 bool incr = p.getOperator().kind() == Token::Kind::TK_PLUSPLUS;
Brian Osman0a442b72020-12-02 11:12:51 -05001322
1323 switch (base_number_kind(p.type())) {
1324 case Type::NumberKind::kFloat:
1325 val = f32(val) + fBuilder->splat(incr ? 1.0f : -1.0f);
1326 break;
1327 case Type::NumberKind::kSigned:
1328 val = i32(val) + fBuilder->splat(incr ? 1 : -1);
1329 break;
1330 default:
1331 SkASSERT(false);
1332 return {};
1333 }
1334 return this->writeStore(*p.operand(), val);
1335 }
1336 case Token::Kind::TK_MINUS: {
1337 switch (base_number_kind(p.type())) {
1338 case Type::NumberKind::kFloat:
1339 return this->unary(val, [](skvm::F32 x) { return -x; });
1340 case Type::NumberKind::kSigned:
1341 return this->unary(val, [](skvm::I32 x) { return -x; });
1342 default:
1343 SkASSERT(false);
1344 return {};
1345 }
1346 }
1347 case Token::Kind::TK_LOGICALNOT:
1348 case Token::Kind::TK_BITWISENOT:
1349 return this->unary(val, [](skvm::I32 x) { return ~x; });
1350 default:
1351 SkASSERT(false);
1352 return {};
1353 }
1354}
1355
1356Value SkVMGenerator::writePostfixExpression(const PostfixExpression& p) {
John Stiles45990502021-02-16 10:55:27 -05001357 switch (p.getOperator().kind()) {
Brian Osman0a442b72020-12-02 11:12:51 -05001358 case Token::Kind::TK_PLUSPLUS:
1359 case Token::Kind::TK_MINUSMINUS: {
1360 Value old = this->writeExpression(*p.operand()),
1361 val = old;
1362 SkASSERT(val.slots() == 1);
John Stiles45990502021-02-16 10:55:27 -05001363 bool incr = p.getOperator().kind() == Token::Kind::TK_PLUSPLUS;
Brian Osman0a442b72020-12-02 11:12:51 -05001364
1365 switch (base_number_kind(p.type())) {
1366 case Type::NumberKind::kFloat:
1367 val = f32(val) + fBuilder->splat(incr ? 1.0f : -1.0f);
1368 break;
1369 case Type::NumberKind::kSigned:
1370 val = i32(val) + fBuilder->splat(incr ? 1 : -1);
1371 break;
1372 default:
1373 SkASSERT(false);
1374 return {};
1375 }
1376 this->writeStore(*p.operand(), val);
1377 return old;
1378 }
1379 default:
1380 SkASSERT(false);
1381 return {};
1382 }
1383}
1384
1385Value SkVMGenerator::writeSwizzle(const Swizzle& s) {
1386 Value base = this->writeExpression(*s.base());
1387 Value swizzled(s.components().size());
1388 for (size_t i = 0; i < s.components().size(); ++i) {
1389 swizzled[i] = base[s.components()[i]];
1390 }
1391 return swizzled;
1392}
1393
1394Value SkVMGenerator::writeTernaryExpression(const TernaryExpression& t) {
1395 skvm::I32 test = i32(this->writeExpression(*t.test()));
1396 Value ifTrue, ifFalse;
1397
1398 {
Brian Osman9333c872021-01-13 15:06:17 -05001399 ScopedCondition m(this, test);
Brian Osman0a442b72020-12-02 11:12:51 -05001400 ifTrue = this->writeExpression(*t.ifTrue());
1401 }
1402 {
Brian Osman9333c872021-01-13 15:06:17 -05001403 ScopedCondition m(this, ~test);
Brian Osman0a442b72020-12-02 11:12:51 -05001404 ifFalse = this->writeExpression(*t.ifFalse());
1405 }
1406
1407 size_t nslots = ifTrue.slots();
1408 SkASSERT(nslots == ifFalse.slots());
1409
1410 Value result(nslots);
1411 for (size_t i = 0; i < nslots; ++i) {
1412 result[i] = skvm::select(test, i32(ifTrue[i]), i32(ifFalse[i]));
1413 }
1414 return result;
1415}
1416
1417Value SkVMGenerator::writeExpression(const Expression& e) {
1418 switch (e.kind()) {
1419 case Expression::Kind::kBinary:
1420 return this->writeBinaryExpression(e.as<BinaryExpression>());
1421 case Expression::Kind::kBoolLiteral:
1422 return fBuilder->splat(e.as<BoolLiteral>().value() ? ~0 : 0);
1423 case Expression::Kind::kConstructor:
1424 return this->writeConstructor(e.as<Constructor>());
1425 case Expression::Kind::kFieldAccess:
Brian Osmanfa71ffa2021-01-26 14:05:31 -05001426 return this->writeFieldAccess(e.as<FieldAccess>());
Brian Osman0a442b72020-12-02 11:12:51 -05001427 case Expression::Kind::kIndex:
Brian Osmanfa71ffa2021-01-26 14:05:31 -05001428 return this->writeIndexExpression(e.as<IndexExpression>());
Brian Osman0a442b72020-12-02 11:12:51 -05001429 case Expression::Kind::kVariableReference:
Brian Osmanfa71ffa2021-01-26 14:05:31 -05001430 return this->writeVariableExpression(e.as<VariableReference>());
Brian Osman0a442b72020-12-02 11:12:51 -05001431 case Expression::Kind::kFloatLiteral:
1432 return fBuilder->splat(e.as<FloatLiteral>().value());
1433 case Expression::Kind::kFunctionCall:
1434 return this->writeFunctionCall(e.as<FunctionCall>());
Brian Osmandd50b0c2021-01-11 17:04:29 -05001435 case Expression::Kind::kExternalFunctionCall:
1436 return this->writeExternalFunctionCall(e.as<ExternalFunctionCall>());
Brian Osman0a442b72020-12-02 11:12:51 -05001437 case Expression::Kind::kIntLiteral:
1438 return fBuilder->splat(static_cast<int>(e.as<IntLiteral>().value()));
Brian Osman0a442b72020-12-02 11:12:51 -05001439 case Expression::Kind::kPrefix:
1440 return this->writePrefixExpression(e.as<PrefixExpression>());
1441 case Expression::Kind::kPostfix:
1442 return this->writePostfixExpression(e.as<PostfixExpression>());
1443 case Expression::Kind::kSwizzle:
1444 return this->writeSwizzle(e.as<Swizzle>());
1445 case Expression::Kind::kTernary:
1446 return this->writeTernaryExpression(e.as<TernaryExpression>());
Brian Osmanbe0b3b72021-01-06 14:27:35 -05001447 case Expression::Kind::kExternalFunctionReference:
Brian Osman0a442b72020-12-02 11:12:51 -05001448 default:
1449 SkDEBUGFAIL("Unsupported expression");
1450 return {};
1451 }
1452}
1453
1454Value SkVMGenerator::writeStore(const Expression& lhs, const Value& rhs) {
John Stiles94e72b92021-01-30 11:06:18 -05001455 SkASSERTF(rhs.slots() == slot_count(lhs.type()),
1456 "lhs=%s (%s)\nrhs=%d slot",
1457 lhs.type().description().c_str(), lhs.description().c_str(), rhs.slots());
Brian Osman0a442b72020-12-02 11:12:51 -05001458
Brian Osman21f57072021-01-25 13:51:57 -05001459 // We need to figure out the collection of slots that we're storing into. The l-value (lhs)
1460 // is always a VariableReference, possibly wrapped by one or more Swizzle, FieldAccess, or
1461 // IndexExpressions. The underlying VariableReference has a range of slots for its storage,
1462 // and each expression wrapped around that selects a sub-set of those slots (Field/Index),
1463 // or rearranges them (Swizzle).
1464 SkSTArray<4, size_t, true> slots;
1465 slots.resize(rhs.slots());
1466
1467 // Start with the identity slot map - this basically says that the values from rhs belong in
1468 // slots [0, 1, 2 ... N] of the lhs.
1469 for (size_t i = 0; i < slots.size(); ++i) {
1470 slots[i] = i;
1471 }
1472
1473 // Now, as we peel off each outer expression, adjust 'slots' to be the locations relative to
1474 // the next (inner) expression:
1475 const Expression* expr = &lhs;
1476 while (!expr->is<VariableReference>()) {
1477 switch (expr->kind()) {
1478 case Expression::Kind::kFieldAccess: {
1479 const FieldAccess& fld = expr->as<FieldAccess>();
1480 size_t offset = this->fieldSlotOffset(fld);
1481 for (size_t& s : slots) {
1482 s += offset;
1483 }
1484 expr = fld.base().get();
1485 } break;
1486 case Expression::Kind::kIndex: {
1487 const IndexExpression& idx = expr->as<IndexExpression>();
1488 size_t offset = this->indexSlotOffset(idx);
1489 for (size_t& s : slots) {
1490 s += offset;
1491 }
1492 expr = idx.base().get();
1493 } break;
1494 case Expression::Kind::kSwizzle: {
1495 const Swizzle& swz = expr->as<Swizzle>();
1496 for (size_t& s : slots) {
1497 s = swz.components()[s];
1498 }
1499 expr = swz.base().get();
1500 } break;
1501 default:
1502 // No other kinds of expressions are valid in lvalues. (see Analysis::IsAssignable)
1503 SkDEBUGFAIL("Invalid expression type");
1504 return {};
1505 }
1506 }
1507
1508 // When we get here, 'slots' are all relative to the first slot holding 'var's storage
1509 const Variable& var = *expr->as<VariableReference>().variable();
1510 size_t varSlot = this->getSlot(var);
Brian Osman0a442b72020-12-02 11:12:51 -05001511 skvm::I32 mask = this->mask();
1512 for (size_t i = rhs.slots(); i --> 0;) {
Brian Osman21f57072021-01-25 13:51:57 -05001513 SkASSERT(slots[i] < slot_count(var.type()));
1514 skvm::F32 curr = f32(fSlots[varSlot + slots[i]]),
Brian Osman0a442b72020-12-02 11:12:51 -05001515 next = f32(rhs[i]);
Brian Osman21f57072021-01-25 13:51:57 -05001516 fSlots[varSlot + slots[i]] = select(mask, next, curr).id;
Brian Osman0a442b72020-12-02 11:12:51 -05001517 }
1518 return rhs;
1519}
1520
1521void SkVMGenerator::writeBlock(const Block& b) {
1522 for (const std::unique_ptr<Statement>& stmt : b.children()) {
1523 this->writeStatement(*stmt);
1524 }
1525}
1526
Brian Osman9333c872021-01-13 15:06:17 -05001527void SkVMGenerator::writeBreakStatement() {
1528 // Any active lanes stop executing for the duration of the current loop
1529 fLoopMask &= ~this->mask();
1530}
1531
1532void SkVMGenerator::writeContinueStatement() {
1533 // Any active lanes stop executing for the current iteration.
1534 // Remember them in fContinueMask, to be re-enabled later.
1535 skvm::I32 mask = this->mask();
1536 fLoopMask &= ~mask;
1537 fContinueMask |= mask;
1538}
1539
1540void SkVMGenerator::writeForStatement(const ForStatement& f) {
1541 // We require that all loops be ES2-compliant (unrollable), and actually unroll them here
1542 Analysis::UnrollableLoopInfo loop;
John Stiles232b4ce2021-03-01 22:14:22 -05001543 SkAssertResult(Analysis::ForLoopIsValidForES2(f.fOffset, f.initializer().get(), f.test().get(),
1544 f.next().get(), f.statement().get(), &loop,
1545 /*errors=*/nullptr));
Brian Osman9333c872021-01-13 15:06:17 -05001546 SkASSERT(slot_count(loop.fIndex->type()) == 1);
1547
Brian Osman21f57072021-01-25 13:51:57 -05001548 size_t indexSlot = this->getSlot(*loop.fIndex);
Brian Osman9333c872021-01-13 15:06:17 -05001549 double val = loop.fStart;
1550
1551 skvm::I32 oldLoopMask = fLoopMask,
1552 oldContinueMask = fContinueMask;
1553
1554 for (int i = 0; i < loop.fCount; ++i) {
Brian Osman21f57072021-01-25 13:51:57 -05001555 fSlots[indexSlot] = loop.fIndex->type().isInteger()
1556 ? fBuilder->splat(static_cast<int>(val)).id
1557 : fBuilder->splat(static_cast<float>(val)).id;
Brian Osman9333c872021-01-13 15:06:17 -05001558
1559 fContinueMask = fBuilder->splat(0);
1560 this->writeStatement(*f.statement());
1561 fLoopMask |= fContinueMask;
1562
1563 val += loop.fDelta;
1564 }
1565
1566 fLoopMask = oldLoopMask;
1567 fContinueMask = oldContinueMask;
1568}
1569
Brian Osman0a442b72020-12-02 11:12:51 -05001570void SkVMGenerator::writeIfStatement(const IfStatement& i) {
1571 Value test = this->writeExpression(*i.test());
1572 {
Brian Osman9333c872021-01-13 15:06:17 -05001573 ScopedCondition ifTrue(this, i32(test));
Brian Osman0a442b72020-12-02 11:12:51 -05001574 this->writeStatement(*i.ifTrue());
1575 }
1576 if (i.ifFalse()) {
Brian Osman9333c872021-01-13 15:06:17 -05001577 ScopedCondition ifFalse(this, ~i32(test));
Brian Osman0a442b72020-12-02 11:12:51 -05001578 this->writeStatement(*i.ifFalse());
1579 }
1580}
1581
1582void SkVMGenerator::writeReturnStatement(const ReturnStatement& r) {
Brian Osman54515b72021-01-07 14:38:08 -05001583 skvm::I32 returnsHere = this->mask();
Brian Osman0a442b72020-12-02 11:12:51 -05001584
Brian Osman54515b72021-01-07 14:38:08 -05001585 if (r.expression()) {
1586 Value val = this->writeExpression(*r.expression());
Brian Osman0a442b72020-12-02 11:12:51 -05001587
Brian Osman54515b72021-01-07 14:38:08 -05001588 int i = 0;
1589 for (skvm::Val& slot : currentFunction().fReturnValue) {
1590 slot = select(returnsHere, f32(val[i]), f32(slot)).id;
1591 i++;
1592 }
Brian Osman0a442b72020-12-02 11:12:51 -05001593 }
1594
Brian Osman54515b72021-01-07 14:38:08 -05001595 currentFunction().fReturned |= returnsHere;
Brian Osman0a442b72020-12-02 11:12:51 -05001596}
1597
1598void SkVMGenerator::writeVarDeclaration(const VarDeclaration& decl) {
Brian Osman21f57072021-01-25 13:51:57 -05001599 size_t slot = this->getSlot(decl.var()),
1600 nslots = slot_count(decl.var().type());
Brian Osman0a442b72020-12-02 11:12:51 -05001601
1602 Value val = decl.value() ? this->writeExpression(*decl.value()) : Value{};
1603 for (size_t i = 0; i < nslots; ++i) {
1604 fSlots[slot + i] = val ? val[i] : fBuilder->splat(0.0f).id;
1605 }
1606}
1607
1608void SkVMGenerator::writeStatement(const Statement& s) {
1609 switch (s.kind()) {
1610 case Statement::Kind::kBlock:
1611 this->writeBlock(s.as<Block>());
1612 break;
Brian Osman9333c872021-01-13 15:06:17 -05001613 case Statement::Kind::kBreak:
1614 this->writeBreakStatement();
1615 break;
1616 case Statement::Kind::kContinue:
1617 this->writeContinueStatement();
1618 break;
Brian Osman0a442b72020-12-02 11:12:51 -05001619 case Statement::Kind::kExpression:
1620 this->writeExpression(*s.as<ExpressionStatement>().expression());
1621 break;
Brian Osman9333c872021-01-13 15:06:17 -05001622 case Statement::Kind::kFor:
1623 this->writeForStatement(s.as<ForStatement>());
1624 break;
Brian Osman0a442b72020-12-02 11:12:51 -05001625 case Statement::Kind::kIf:
1626 this->writeIfStatement(s.as<IfStatement>());
1627 break;
1628 case Statement::Kind::kReturn:
1629 this->writeReturnStatement(s.as<ReturnStatement>());
1630 break;
1631 case Statement::Kind::kVarDeclaration:
1632 this->writeVarDeclaration(s.as<VarDeclaration>());
1633 break;
Brian Osman0a442b72020-12-02 11:12:51 -05001634 case Statement::Kind::kDiscard:
1635 case Statement::Kind::kDo:
Brian Osman0a442b72020-12-02 11:12:51 -05001636 case Statement::Kind::kSwitch:
Brian Osman57e353f2021-01-07 15:55:20 -05001637 SkDEBUGFAIL("Unsupported control flow");
Brian Osman0a442b72020-12-02 11:12:51 -05001638 break;
1639 case Statement::Kind::kInlineMarker:
1640 case Statement::Kind::kNop:
1641 break;
1642 default:
1643 SkASSERT(false);
1644 }
1645}
1646
1647skvm::Color ProgramToSkVM(const Program& program,
1648 const FunctionDefinition& function,
1649 skvm::Builder* builder,
1650 SkSpan<skvm::Val> uniforms,
1651 skvm::Coord device,
1652 skvm::Coord local,
1653 SampleChildFn sampleChild) {
Brian Osman5933d4c2021-01-05 13:02:20 -05001654 skvm::Val args[2] = {local.x.id, local.y.id};
Mike Kleinaebcf732021-01-14 10:15:00 -06001655 skvm::Val zero = builder->splat(0.0f).id;
1656 skvm::Val result[4] = {zero,zero,zero,zero};
Brian Osman0a442b72020-12-02 11:12:51 -05001657 size_t paramSlots = 0;
1658 for (const SkSL::Variable* param : function.declaration().parameters()) {
1659 paramSlots += slot_count(param->type());
1660 }
Brian Osman5933d4c2021-01-05 13:02:20 -05001661 SkASSERT(paramSlots <= SK_ARRAY_COUNT(args));
Brian Osman0a442b72020-12-02 11:12:51 -05001662
Brian Osmandb2dad52021-01-07 14:08:30 -05001663 SkVMGenerator generator(program, builder, uniforms, device, local, std::move(sampleChild));
1664 generator.writeFunction(function, {args, paramSlots}, result);
Brian Osman0a442b72020-12-02 11:12:51 -05001665
Brian Osman57e353f2021-01-07 15:55:20 -05001666 return skvm::Color{{builder, result[0]},
1667 {builder, result[1]},
1668 {builder, result[2]},
1669 {builder, result[3]}};
Brian Osman0a442b72020-12-02 11:12:51 -05001670}
1671
Brian Osmanf4a77732020-12-28 09:03:00 -05001672bool ProgramToSkVM(const Program& program,
1673 const FunctionDefinition& function,
1674 skvm::Builder* b,
Brian Osmanc92df392021-01-11 13:16:28 -05001675 SkSpan<skvm::Val> uniforms,
Brian Osmanf4a77732020-12-28 09:03:00 -05001676 SkVMSignature* outSignature) {
Brian Osmanf4a77732020-12-28 09:03:00 -05001677 SkVMSignature ignored,
1678 *signature = outSignature ? outSignature : &ignored;
1679
Mike Klein00e43df2021-01-08 13:45:42 -06001680 std::vector<skvm::Ptr> argPtrs;
Brian Osmanf4a77732020-12-28 09:03:00 -05001681 std::vector<skvm::Val> argVals;
1682
1683 for (const Variable* p : function.declaration().parameters()) {
1684 size_t slots = slot_count(p->type());
1685 signature->fParameterSlots += slots;
1686 for (size_t i = 0; i < slots; ++i) {
1687 argPtrs.push_back(b->varying<float>());
1688 argVals.push_back(b->loadF(argPtrs.back()).id);
1689 }
1690 }
1691
Mike Klein00e43df2021-01-08 13:45:42 -06001692 std::vector<skvm::Ptr> returnPtrs;
Brian Osmanf4a77732020-12-28 09:03:00 -05001693 std::vector<skvm::Val> returnVals;
1694
1695 signature->fReturnSlots = slot_count(function.declaration().returnType());
1696 for (size_t i = 0; i < signature->fReturnSlots; ++i) {
1697 returnPtrs.push_back(b->varying<float>());
1698 returnVals.push_back(b->splat(0.0f).id);
1699 }
1700
1701 skvm::Coord zeroCoord = {b->splat(0.0f), b->splat(0.0f)};
Brian Osmanc92df392021-01-11 13:16:28 -05001702 SkVMGenerator generator(program, b, uniforms, /*device=*/zeroCoord, /*local=*/zeroCoord,
Brian Osmandb2dad52021-01-07 14:08:30 -05001703 /*sampleChild=*/{});
1704 generator.writeFunction(function, argVals, returnVals);
Brian Osmanf4a77732020-12-28 09:03:00 -05001705
1706 // generateCode has updated the contents of 'argVals' for any 'out' or 'inout' parameters.
1707 // Propagate those changes back to our varying buffers:
1708 size_t argIdx = 0;
1709 for (const Variable* p : function.declaration().parameters()) {
1710 size_t nslots = slot_count(p->type());
1711 if (p->modifiers().fFlags & Modifiers::kOut_Flag) {
1712 for (size_t i = 0; i < nslots; ++i) {
1713 b->storeF(argPtrs[argIdx + i], skvm::F32{b, argVals[argIdx + i]});
1714 }
1715 }
1716 argIdx += nslots;
1717 }
1718
1719 // It's also updated the contents of 'returnVals' with the return value of the entry point.
1720 // Store that as well:
1721 for (size_t i = 0; i < signature->fReturnSlots; ++i) {
1722 b->storeF(returnPtrs[i], skvm::F32{b, returnVals[i]});
1723 }
1724
1725 return true;
1726}
1727
Brian Osman5933d4c2021-01-05 13:02:20 -05001728const FunctionDefinition* Program_GetFunction(const Program& program, const char* function) {
1729 for (const ProgramElement* e : program.elements()) {
1730 if (e->is<FunctionDefinition>() &&
1731 e->as<FunctionDefinition>().declaration().name() == function) {
1732 return &e->as<FunctionDefinition>();
1733 }
1734 }
1735 return nullptr;
1736}
1737
Brian Osmane89d8ea2021-01-20 14:01:30 -05001738static void gather_uniforms(UniformInfo* info, const Type& type, const String& name) {
1739 switch (type.typeKind()) {
1740 case Type::TypeKind::kStruct:
1741 for (const auto& f : type.fields()) {
1742 gather_uniforms(info, *f.fType, name + "." + f.fName);
1743 }
1744 break;
1745 case Type::TypeKind::kArray:
1746 for (int i = 0; i < type.columns(); ++i) {
1747 gather_uniforms(info, type.componentType(),
1748 String::printf("%s[%d]", name.c_str(), i));
1749 }
1750 break;
1751 case Type::TypeKind::kScalar:
1752 case Type::TypeKind::kVector:
1753 case Type::TypeKind::kMatrix:
1754 info->fUniforms.push_back({name, base_number_kind(type), type.rows(), type.columns(),
1755 info->fUniformSlotCount});
1756 info->fUniformSlotCount += type.columns() * type.rows();
1757 break;
1758 default:
1759 break;
1760 }
1761}
1762
1763std::unique_ptr<UniformInfo> Program_GetUniformInfo(const Program& program) {
1764 auto info = std::make_unique<UniformInfo>();
1765 for (const ProgramElement* e : program.elements()) {
1766 if (!e->is<GlobalVarDeclaration>()) {
1767 continue;
1768 }
1769 const GlobalVarDeclaration& decl = e->as<GlobalVarDeclaration>();
1770 const Variable& var = decl.declaration()->as<VarDeclaration>().var();
1771 if (var.modifiers().fFlags & Modifiers::kUniform_Flag) {
1772 gather_uniforms(info.get(), var.type(), var.name());
1773 }
1774 }
1775 return info;
1776}
1777
Brian Osman47726a12020-12-17 16:02:08 -05001778/*
1779 * Testing utility function that emits program's "main" with a minimal harness. Used to create
1780 * representative skvm op sequences for SkSL tests.
1781 */
1782bool testingOnly_ProgramToSkVMShader(const Program& program, skvm::Builder* builder) {
Brian Osman5933d4c2021-01-05 13:02:20 -05001783 const SkSL::FunctionDefinition* main = Program_GetFunction(program, "main");
1784 if (!main) {
1785 return false;
1786 }
1787
Brian Osman47726a12020-12-17 16:02:08 -05001788 size_t uniformSlots = 0;
1789 int childSlots = 0;
1790 for (const SkSL::ProgramElement* e : program.elements()) {
Brian Osman47726a12020-12-17 16:02:08 -05001791 if (e->is<GlobalVarDeclaration>()) {
1792 const GlobalVarDeclaration& decl = e->as<GlobalVarDeclaration>();
1793 const Variable& var = decl.declaration()->as<VarDeclaration>().var();
John Stiles54e7c052021-01-11 14:22:36 -05001794 if (var.type() == *program.fContext->fTypes.fFragmentProcessor) {
Brian Osman47726a12020-12-17 16:02:08 -05001795 childSlots++;
1796 } else if (is_uniform(var)) {
1797 uniformSlots += slot_count(var.type());
1798 }
1799 }
1800 }
Brian Osman0a442b72020-12-02 11:12:51 -05001801
Mike Kleinae562bd2021-01-08 14:15:55 -06001802 skvm::Uniforms uniforms(builder->uniform(), 0);
Brian Osman47726a12020-12-17 16:02:08 -05001803
1804 auto new_uni = [&]() { return builder->uniformF(uniforms.pushF(0.0f)); };
1805
1806 // Assume identity CTM
1807 skvm::Coord device = {pun_to_F32(builder->index()), new_uni()};
1808 skvm::Coord local = device;
1809
1810 struct Child {
1811 skvm::Uniform addr;
1812 skvm::I32 rowBytesAsPixels;
1813 };
1814
1815 std::vector<Child> children;
1816 for (int i = 0; i < childSlots; ++i) {
1817 children.push_back({uniforms.pushPtr(nullptr), builder->uniform32(uniforms.push(0))});
1818 }
1819
1820 auto sampleChild = [&](int i, skvm::Coord coord) {
Mike Klein447f3312021-02-08 09:46:59 -06001821 skvm::PixelFormat pixelFormat = skvm::SkColorType_to_PixelFormat(kRGBA_F32_SkColorType);
Brian Osman3f904db2021-01-28 13:24:31 -05001822 skvm::I32 index = trunc(coord.x);
1823 index += trunc(coord.y) * children[i].rowBytesAsPixels;
Brian Osman47726a12020-12-17 16:02:08 -05001824 return gather(pixelFormat, children[i].addr, index);
1825 };
1826
1827 std::vector<skvm::Val> uniformVals;
1828 for (size_t i = 0; i < uniformSlots; ++i) {
1829 uniformVals.push_back(new_uni().id);
1830 }
1831
1832 skvm::Color result =
1833 SkSL::ProgramToSkVM(program, *main, builder, uniformVals, device, local, sampleChild);
1834
1835 storeF(builder->varying<float>(), result.r);
1836 storeF(builder->varying<float>(), result.g);
1837 storeF(builder->varying<float>(), result.b);
1838 storeF(builder->varying<float>(), result.a);
1839
1840 return true;
1841
1842}
1843
1844} // namespace SkSL