blob: bad482945f5c1c2fd8a8aa68f9f4bdff960b9f3f [file] [log] [blame]
John Stiles44e96be2020-08-31 13:16:04 -04001/*
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 "src/sksl/SkSLInliner.h"
9
John Stiles2d7973a2020-10-02 15:01:03 -040010#include <limits.h>
John Stiles44e96be2020-08-31 13:16:04 -040011#include <memory>
12#include <unordered_set>
13
14#include "src/sksl/SkSLAnalysis.h"
15#include "src/sksl/ir/SkSLBinaryExpression.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/SkSLDiscardStatement.h"
21#include "src/sksl/ir/SkSLDoStatement.h"
22#include "src/sksl/ir/SkSLEnum.h"
23#include "src/sksl/ir/SkSLExpressionStatement.h"
24#include "src/sksl/ir/SkSLExternalFunctionCall.h"
Brian Osmanbe0b3b72021-01-06 14:27:35 -050025#include "src/sksl/ir/SkSLExternalFunctionReference.h"
John Stiles44e96be2020-08-31 13:16:04 -040026#include "src/sksl/ir/SkSLField.h"
27#include "src/sksl/ir/SkSLFieldAccess.h"
28#include "src/sksl/ir/SkSLFloatLiteral.h"
29#include "src/sksl/ir/SkSLForStatement.h"
30#include "src/sksl/ir/SkSLFunctionCall.h"
31#include "src/sksl/ir/SkSLFunctionDeclaration.h"
32#include "src/sksl/ir/SkSLFunctionDefinition.h"
33#include "src/sksl/ir/SkSLFunctionReference.h"
34#include "src/sksl/ir/SkSLIfStatement.h"
35#include "src/sksl/ir/SkSLIndexExpression.h"
John Stiles98c1f822020-09-09 14:18:53 -040036#include "src/sksl/ir/SkSLInlineMarker.h"
John Stiles44e96be2020-08-31 13:16:04 -040037#include "src/sksl/ir/SkSLIntLiteral.h"
38#include "src/sksl/ir/SkSLInterfaceBlock.h"
39#include "src/sksl/ir/SkSLLayout.h"
40#include "src/sksl/ir/SkSLNop.h"
John Stiles44e96be2020-08-31 13:16:04 -040041#include "src/sksl/ir/SkSLPostfixExpression.h"
42#include "src/sksl/ir/SkSLPrefixExpression.h"
43#include "src/sksl/ir/SkSLReturnStatement.h"
44#include "src/sksl/ir/SkSLSetting.h"
45#include "src/sksl/ir/SkSLSwitchCase.h"
46#include "src/sksl/ir/SkSLSwitchStatement.h"
47#include "src/sksl/ir/SkSLSwizzle.h"
48#include "src/sksl/ir/SkSLTernaryExpression.h"
49#include "src/sksl/ir/SkSLUnresolvedFunction.h"
50#include "src/sksl/ir/SkSLVarDeclarations.h"
John Stiles44e96be2020-08-31 13:16:04 -040051#include "src/sksl/ir/SkSLVariable.h"
52#include "src/sksl/ir/SkSLVariableReference.h"
John Stiles44e96be2020-08-31 13:16:04 -040053
54namespace SkSL {
55namespace {
56
John Stiles031a7672020-11-13 16:13:18 -050057static constexpr int kInlinedStatementLimit = 2500;
58
John Stiles44e96be2020-08-31 13:16:04 -040059static int count_returns_at_end_of_control_flow(const FunctionDefinition& funcDef) {
60 class CountReturnsAtEndOfControlFlow : public ProgramVisitor {
61 public:
62 CountReturnsAtEndOfControlFlow(const FunctionDefinition& funcDef) {
63 this->visitProgramElement(funcDef);
64 }
65
66 bool visitStatement(const Statement& stmt) override {
Ethan Nicholase6592142020-09-08 10:22:09 -040067 switch (stmt.kind()) {
68 case Statement::Kind::kBlock: {
John Stiles44e96be2020-08-31 13:16:04 -040069 // Check only the last statement of a block.
Ethan Nicholas7bd60432020-09-25 14:31:59 -040070 const auto& block = stmt.as<Block>();
71 return block.children().size() &&
72 this->visitStatement(*block.children().back());
John Stiles44e96be2020-08-31 13:16:04 -040073 }
Ethan Nicholase6592142020-09-08 10:22:09 -040074 case Statement::Kind::kSwitch:
Ethan Nicholase6592142020-09-08 10:22:09 -040075 case Statement::Kind::kDo:
76 case Statement::Kind::kFor:
John Stiles44e96be2020-08-31 13:16:04 -040077 // Don't introspect switches or loop structures at all.
78 return false;
79
Ethan Nicholase6592142020-09-08 10:22:09 -040080 case Statement::Kind::kReturn:
John Stiles44e96be2020-08-31 13:16:04 -040081 ++fNumReturns;
82 [[fallthrough]];
83
84 default:
John Stiles93442622020-09-11 12:11:27 -040085 return INHERITED::visitStatement(stmt);
John Stiles44e96be2020-08-31 13:16:04 -040086 }
87 }
88
89 int fNumReturns = 0;
90 using INHERITED = ProgramVisitor;
91 };
92
93 return CountReturnsAtEndOfControlFlow{funcDef}.fNumReturns;
94}
95
John Stiles74ebd7e2020-12-17 14:41:50 -050096static int count_returns_in_continuable_constructs(const FunctionDefinition& funcDef) {
97 class CountReturnsInContinuableConstructs : public ProgramVisitor {
John Stiles44e96be2020-08-31 13:16:04 -040098 public:
John Stiles74ebd7e2020-12-17 14:41:50 -050099 CountReturnsInContinuableConstructs(const FunctionDefinition& funcDef) {
John Stiles44e96be2020-08-31 13:16:04 -0400100 this->visitProgramElement(funcDef);
101 }
102
103 bool visitStatement(const Statement& stmt) override {
Ethan Nicholase6592142020-09-08 10:22:09 -0400104 switch (stmt.kind()) {
Ethan Nicholase6592142020-09-08 10:22:09 -0400105 case Statement::Kind::kDo:
106 case Statement::Kind::kFor: {
John Stiles74ebd7e2020-12-17 14:41:50 -0500107 ++fInsideContinuableConstruct;
John Stiles93442622020-09-11 12:11:27 -0400108 bool result = INHERITED::visitStatement(stmt);
John Stiles74ebd7e2020-12-17 14:41:50 -0500109 --fInsideContinuableConstruct;
John Stiles44e96be2020-08-31 13:16:04 -0400110 return result;
111 }
112
Ethan Nicholase6592142020-09-08 10:22:09 -0400113 case Statement::Kind::kReturn:
John Stiles74ebd7e2020-12-17 14:41:50 -0500114 fNumReturns += (fInsideContinuableConstruct > 0) ? 1 : 0;
John Stiles44e96be2020-08-31 13:16:04 -0400115 [[fallthrough]];
116
117 default:
John Stiles93442622020-09-11 12:11:27 -0400118 return INHERITED::visitStatement(stmt);
John Stiles44e96be2020-08-31 13:16:04 -0400119 }
120 }
121
122 int fNumReturns = 0;
John Stiles74ebd7e2020-12-17 14:41:50 -0500123 int fInsideContinuableConstruct = 0;
John Stiles44e96be2020-08-31 13:16:04 -0400124 using INHERITED = ProgramVisitor;
125 };
126
John Stiles74ebd7e2020-12-17 14:41:50 -0500127 return CountReturnsInContinuableConstructs{funcDef}.fNumReturns;
John Stiles44e96be2020-08-31 13:16:04 -0400128}
129
John Stiles991b09d2020-09-10 13:33:40 -0400130static bool contains_recursive_call(const FunctionDeclaration& funcDecl) {
131 class ContainsRecursiveCall : public ProgramVisitor {
132 public:
133 bool visit(const FunctionDeclaration& funcDecl) {
134 fFuncDecl = &funcDecl;
Ethan Nicholased84b732020-10-08 11:45:44 -0400135 return funcDecl.definition() ? this->visitProgramElement(*funcDecl.definition())
136 : false;
John Stiles991b09d2020-09-10 13:33:40 -0400137 }
138
139 bool visitExpression(const Expression& expr) override {
Ethan Nicholas0dec9922020-10-05 15:51:52 -0400140 if (expr.is<FunctionCall>() && expr.as<FunctionCall>().function().matches(*fFuncDecl)) {
John Stiles991b09d2020-09-10 13:33:40 -0400141 return true;
142 }
143 return INHERITED::visitExpression(expr);
144 }
145
146 bool visitStatement(const Statement& stmt) override {
Ethan Nicholasceb62142020-10-09 16:51:18 -0400147 if (stmt.is<InlineMarker>() &&
148 stmt.as<InlineMarker>().function().matches(*fFuncDecl)) {
John Stiles991b09d2020-09-10 13:33:40 -0400149 return true;
150 }
151 return INHERITED::visitStatement(stmt);
152 }
153
154 const FunctionDeclaration* fFuncDecl;
155 using INHERITED = ProgramVisitor;
156 };
157
158 return ContainsRecursiveCall{}.visit(funcDecl);
159}
160
John Stiles6d696082020-10-01 10:18:54 -0400161static std::unique_ptr<Statement>* find_parent_statement(
162 const std::vector<std::unique_ptr<Statement>*>& stmtStack) {
John Stiles915a38c2020-09-14 09:38:13 -0400163 SkASSERT(!stmtStack.empty());
164
165 // Walk the statement stack from back to front, ignoring the last element (which is the
166 // enclosing statement).
167 auto iter = stmtStack.rbegin();
168 ++iter;
169
170 // Anything counts as a parent statement other than a scopeless Block.
171 for (; iter != stmtStack.rend(); ++iter) {
John Stiles6d696082020-10-01 10:18:54 -0400172 std::unique_ptr<Statement>* stmt = *iter;
173 if (!(*stmt)->is<Block>() || (*stmt)->as<Block>().isScope()) {
John Stiles915a38c2020-09-14 09:38:13 -0400174 return stmt;
175 }
176 }
177
178 // There wasn't any parent statement to be found.
179 return nullptr;
180}
181
John Stilese41b4ee2020-09-28 12:28:16 -0400182std::unique_ptr<Expression> clone_with_ref_kind(const Expression& expr,
183 VariableReference::RefKind refKind) {
184 std::unique_ptr<Expression> clone = expr.clone();
John Stiles47c0a742021-02-09 09:30:35 -0500185 Analysis::UpdateRefKind(clone.get(), refKind);
John Stilese41b4ee2020-09-28 12:28:16 -0400186 return clone;
187}
188
John Stiles77702f12020-12-17 14:38:56 -0500189class CountReturnsWithLimit : public ProgramVisitor {
190public:
191 CountReturnsWithLimit(const FunctionDefinition& funcDef, int limit) : fLimit(limit) {
192 this->visitProgramElement(funcDef);
193 }
194
195 bool visitStatement(const Statement& stmt) override {
196 switch (stmt.kind()) {
197 case Statement::Kind::kReturn: {
198 ++fNumReturns;
199 fDeepestReturn = std::max(fDeepestReturn, fScopedBlockDepth);
200 return (fNumReturns >= fLimit) || INHERITED::visitStatement(stmt);
201 }
John Stilesc5ff4862020-12-22 13:47:05 -0500202 case Statement::Kind::kVarDeclaration: {
203 if (fScopedBlockDepth > 1) {
204 fVariablesInBlocks = true;
205 }
206 return INHERITED::visitStatement(stmt);
207 }
John Stiles77702f12020-12-17 14:38:56 -0500208 case Statement::Kind::kBlock: {
209 int depthIncrement = stmt.as<Block>().isScope() ? 1 : 0;
210 fScopedBlockDepth += depthIncrement;
211 bool result = INHERITED::visitStatement(stmt);
212 fScopedBlockDepth -= depthIncrement;
John Stilesc5ff4862020-12-22 13:47:05 -0500213 if (fNumReturns == 0 && fScopedBlockDepth <= 1) {
214 // If closing this block puts us back at the top level, and we haven't
215 // encountered any return statements yet, any vardecls we may have encountered
216 // up until this point can be ignored. They are out of scope now, and they were
217 // never used in a return statement.
218 fVariablesInBlocks = false;
219 }
John Stiles77702f12020-12-17 14:38:56 -0500220 return result;
221 }
222 default:
223 return INHERITED::visitStatement(stmt);
224 }
225 }
226
227 int fNumReturns = 0;
228 int fDeepestReturn = 0;
229 int fLimit = 0;
230 int fScopedBlockDepth = 0;
John Stilesc5ff4862020-12-22 13:47:05 -0500231 bool fVariablesInBlocks = false;
John Stiles77702f12020-12-17 14:38:56 -0500232 using INHERITED = ProgramVisitor;
233};
234
John Stiles44e96be2020-08-31 13:16:04 -0400235} // namespace
236
John Stiles77702f12020-12-17 14:38:56 -0500237Inliner::ReturnComplexity Inliner::GetReturnComplexity(const FunctionDefinition& funcDef) {
238 int returnsAtEndOfControlFlow = count_returns_at_end_of_control_flow(funcDef);
239 CountReturnsWithLimit counter{funcDef, returnsAtEndOfControlFlow + 1};
John Stiles77702f12020-12-17 14:38:56 -0500240 if (counter.fNumReturns > returnsAtEndOfControlFlow) {
241 return ReturnComplexity::kEarlyReturns;
242 }
John Stilesc5ff4862020-12-22 13:47:05 -0500243 if (counter.fNumReturns > 1) {
John Stiles77702f12020-12-17 14:38:56 -0500244 return ReturnComplexity::kScopedReturns;
245 }
John Stilesc5ff4862020-12-22 13:47:05 -0500246 if (counter.fVariablesInBlocks && counter.fDeepestReturn > 1) {
247 return ReturnComplexity::kScopedReturns;
248 }
249 return ReturnComplexity::kSingleSafeReturn;
John Stiles77702f12020-12-17 14:38:56 -0500250}
251
John Stilesb61ee902020-09-21 12:26:59 -0400252void Inliner::ensureScopedBlocks(Statement* inlinedBody, Statement* parentStmt) {
253 // No changes necessary if this statement isn't actually a block.
254 if (!inlinedBody || !inlinedBody->is<Block>()) {
255 return;
256 }
257
258 // No changes necessary if the parent statement doesn't require a scope.
259 if (!parentStmt || !(parentStmt->is<IfStatement>() || parentStmt->is<ForStatement>() ||
Brian Osmand6f23382020-12-15 17:08:59 -0500260 parentStmt->is<DoStatement>())) {
John Stilesb61ee902020-09-21 12:26:59 -0400261 return;
262 }
263
264 Block& block = inlinedBody->as<Block>();
265
266 // The inliner will create inlined function bodies as a Block containing multiple statements,
267 // but no scope. Normally, this is fine, but if this block is used as the statement for a
268 // do/for/if/while, this isn't actually possible to represent textually; a scope must be added
269 // for the generated code to match the intent. In the case of Blocks nested inside other Blocks,
270 // we add the scope to the outermost block if needed. Zero-statement blocks have similar
271 // issues--if we don't represent the Block textually somehow, we run the risk of accidentally
272 // absorbing the following statement into our loop--so we also add a scope to these.
273 for (Block* nestedBlock = &block;; ) {
Ethan Nicholas7bd60432020-09-25 14:31:59 -0400274 if (nestedBlock->isScope()) {
John Stilesb61ee902020-09-21 12:26:59 -0400275 // We found an explicit scope; all is well.
276 return;
277 }
Ethan Nicholas7bd60432020-09-25 14:31:59 -0400278 if (nestedBlock->children().size() != 1) {
John Stilesb61ee902020-09-21 12:26:59 -0400279 // We found a block with multiple (or zero) statements, but no scope? Let's add a scope
280 // to the outermost block.
Ethan Nicholas7bd60432020-09-25 14:31:59 -0400281 block.setIsScope(true);
John Stilesb61ee902020-09-21 12:26:59 -0400282 return;
283 }
Ethan Nicholas7bd60432020-09-25 14:31:59 -0400284 if (!nestedBlock->children()[0]->is<Block>()) {
John Stilesb61ee902020-09-21 12:26:59 -0400285 // This block has exactly one thing inside, and it's not another block. No need to scope
286 // it.
287 return;
288 }
289 // We have to go deeper.
Ethan Nicholas7bd60432020-09-25 14:31:59 -0400290 nestedBlock = &nestedBlock->children()[0]->as<Block>();
John Stilesb61ee902020-09-21 12:26:59 -0400291 }
292}
293
John Stilesd1204642021-02-17 16:30:02 -0500294void Inliner::reset(ModifiersPool* modifiers) {
Ethan Nicholas041fd0a2020-10-07 16:42:04 -0400295 fModifiers = modifiers;
Ethan Nicholas6f4eee22021-01-11 12:37:42 -0500296 fMangler.reset();
John Stiles031a7672020-11-13 16:13:18 -0500297 fInlinedStatementCounter = 0;
John Stiles44e96be2020-08-31 13:16:04 -0400298}
299
300std::unique_ptr<Expression> Inliner::inlineExpression(int offset,
301 VariableRewriteMap* varMap,
John Stilesd7cc0932020-11-30 12:24:27 -0500302 SymbolTable* symbolTableForExpression,
John Stiles44e96be2020-08-31 13:16:04 -0400303 const Expression& expression) {
304 auto expr = [&](const std::unique_ptr<Expression>& e) -> std::unique_ptr<Expression> {
305 if (e) {
John Stilesd7cc0932020-11-30 12:24:27 -0500306 return this->inlineExpression(offset, varMap, symbolTableForExpression, *e);
John Stiles44e96be2020-08-31 13:16:04 -0400307 }
308 return nullptr;
309 };
John Stiles8e3b6be2020-10-13 11:14:08 -0400310 auto argList = [&](const ExpressionArray& originalArgs) -> ExpressionArray {
311 ExpressionArray args;
John Stilesf4bda742020-10-14 16:57:41 -0400312 args.reserve_back(originalArgs.size());
John Stiles44e96be2020-08-31 13:16:04 -0400313 for (const std::unique_ptr<Expression>& arg : originalArgs) {
314 args.push_back(expr(arg));
315 }
316 return args;
317 };
318
Ethan Nicholase6592142020-09-08 10:22:09 -0400319 switch (expression.kind()) {
320 case Expression::Kind::kBinary: {
John Stiles6a1a98c2021-01-14 18:35:34 -0500321 const BinaryExpression& binaryExpr = expression.as<BinaryExpression>();
John Stilese2aec432021-03-01 09:27:48 -0500322 return BinaryExpression::Make(*fContext,
323 expr(binaryExpr.left()),
324 binaryExpr.getOperator(),
325 expr(binaryExpr.right()));
John Stiles44e96be2020-08-31 13:16:04 -0400326 }
Ethan Nicholase6592142020-09-08 10:22:09 -0400327 case Expression::Kind::kBoolLiteral:
328 case Expression::Kind::kIntLiteral:
329 case Expression::Kind::kFloatLiteral:
John Stiles44e96be2020-08-31 13:16:04 -0400330 return expression.clone();
Ethan Nicholase6592142020-09-08 10:22:09 -0400331 case Expression::Kind::kConstructor: {
John Stiles44e96be2020-08-31 13:16:04 -0400332 const Constructor& constructor = expression.as<Constructor>();
John Stiles23521a82021-03-02 17:02:51 -0500333 auto inlinedCtor = Constructor::Convert(
334 *fContext, offset, *constructor.type().clone(symbolTableForExpression),
335 argList(constructor.arguments()));
336 SkASSERT(inlinedCtor);
337 return inlinedCtor;
John Stiles44e96be2020-08-31 13:16:04 -0400338 }
Ethan Nicholase6592142020-09-08 10:22:09 -0400339 case Expression::Kind::kExternalFunctionCall: {
John Stiles44e96be2020-08-31 13:16:04 -0400340 const ExternalFunctionCall& externalCall = expression.as<ExternalFunctionCall>();
Ethan Nicholas444ccc62020-10-09 10:16:22 -0400341 return std::make_unique<ExternalFunctionCall>(offset, &externalCall.function(),
Ethan Nicholas6e86ec92020-09-30 14:29:56 -0400342 argList(externalCall.arguments()));
John Stiles44e96be2020-08-31 13:16:04 -0400343 }
Brian Osmanbe0b3b72021-01-06 14:27:35 -0500344 case Expression::Kind::kExternalFunctionReference:
John Stiles44e96be2020-08-31 13:16:04 -0400345 return expression.clone();
Ethan Nicholase6592142020-09-08 10:22:09 -0400346 case Expression::Kind::kFieldAccess: {
John Stiles44e96be2020-08-31 13:16:04 -0400347 const FieldAccess& f = expression.as<FieldAccess>();
Ethan Nicholas7a95b202020-10-09 11:55:40 -0400348 return std::make_unique<FieldAccess>(expr(f.base()), f.fieldIndex(), f.ownerKind());
John Stiles44e96be2020-08-31 13:16:04 -0400349 }
Ethan Nicholase6592142020-09-08 10:22:09 -0400350 case Expression::Kind::kFunctionCall: {
John Stiles44e96be2020-08-31 13:16:04 -0400351 const FunctionCall& funcCall = expression.as<FunctionCall>();
John Stilesddcc8432021-01-15 15:32:32 -0500352 return std::make_unique<FunctionCall>(offset,
353 funcCall.type().clone(symbolTableForExpression),
354 &funcCall.function(),
Ethan Nicholas0dec9922020-10-05 15:51:52 -0400355 argList(funcCall.arguments()));
John Stiles44e96be2020-08-31 13:16:04 -0400356 }
Ethan Nicholase6592142020-09-08 10:22:09 -0400357 case Expression::Kind::kFunctionReference:
Brian Osman2b3b35f2020-09-08 09:17:36 -0400358 return expression.clone();
Ethan Nicholase6592142020-09-08 10:22:09 -0400359 case Expression::Kind::kIndex: {
John Stiles44e96be2020-08-31 13:16:04 -0400360 const IndexExpression& idx = expression.as<IndexExpression>();
Ethan Nicholas2a4952d2020-10-08 15:35:56 -0400361 return std::make_unique<IndexExpression>(*fContext, expr(idx.base()),
362 expr(idx.index()));
John Stiles44e96be2020-08-31 13:16:04 -0400363 }
Ethan Nicholase6592142020-09-08 10:22:09 -0400364 case Expression::Kind::kPrefix: {
John Stiles44e96be2020-08-31 13:16:04 -0400365 const PrefixExpression& p = expression.as<PrefixExpression>();
John Stilesb0eb20f2021-02-26 15:29:33 -0500366 return PrefixExpression::Make(*fContext, p.getOperator(), expr(p.operand()));
John Stiles44e96be2020-08-31 13:16:04 -0400367 }
Ethan Nicholase6592142020-09-08 10:22:09 -0400368 case Expression::Kind::kPostfix: {
John Stiles44e96be2020-08-31 13:16:04 -0400369 const PostfixExpression& p = expression.as<PostfixExpression>();
John Stiles52d3b012021-02-26 15:56:48 -0500370 return PostfixExpression::Make(*fContext, expr(p.operand()), p.getOperator());
John Stiles44e96be2020-08-31 13:16:04 -0400371 }
Ethan Nicholase6592142020-09-08 10:22:09 -0400372 case Expression::Kind::kSetting:
John Stiles44e96be2020-08-31 13:16:04 -0400373 return expression.clone();
Ethan Nicholase6592142020-09-08 10:22:09 -0400374 case Expression::Kind::kSwizzle: {
John Stiles44e96be2020-08-31 13:16:04 -0400375 const Swizzle& s = expression.as<Swizzle>();
John Stiles6e88e042021-02-19 14:09:38 -0500376 return Swizzle::Make(*fContext, expr(s.base()), s.components());
John Stiles44e96be2020-08-31 13:16:04 -0400377 }
Ethan Nicholase6592142020-09-08 10:22:09 -0400378 case Expression::Kind::kTernary: {
John Stiles44e96be2020-08-31 13:16:04 -0400379 const TernaryExpression& t = expression.as<TernaryExpression>();
John Stiles90518f72021-02-26 20:44:54 -0500380 return TernaryExpression::Make(*fContext, expr(t.test()),
381 expr(t.ifTrue()), expr(t.ifFalse()));
John Stiles44e96be2020-08-31 13:16:04 -0400382 }
Brian Osman83ba9302020-09-11 13:33:46 -0400383 case Expression::Kind::kTypeReference:
384 return expression.clone();
Ethan Nicholase6592142020-09-08 10:22:09 -0400385 case Expression::Kind::kVariableReference: {
John Stiles44e96be2020-08-31 13:16:04 -0400386 const VariableReference& v = expression.as<VariableReference>();
Ethan Nicholas78686922020-10-08 06:46:27 -0400387 auto varMapIter = varMap->find(v.variable());
John Stilese41b4ee2020-09-28 12:28:16 -0400388 if (varMapIter != varMap->end()) {
Ethan Nicholas78686922020-10-08 06:46:27 -0400389 return clone_with_ref_kind(*varMapIter->second, v.refKind());
John Stiles44e96be2020-08-31 13:16:04 -0400390 }
391 return v.clone();
392 }
393 default:
394 SkASSERT(false);
395 return nullptr;
396 }
397}
398
399std::unique_ptr<Statement> Inliner::inlineStatement(int offset,
400 VariableRewriteMap* varMap,
401 SymbolTable* symbolTableForStatement,
John Stiles77702f12020-12-17 14:38:56 -0500402 std::unique_ptr<Expression>* resultExpr,
403 ReturnComplexity returnComplexity,
Brian Osman3887a012020-09-30 13:22:27 -0400404 const Statement& statement,
405 bool isBuiltinCode) {
John Stiles44e96be2020-08-31 13:16:04 -0400406 auto stmt = [&](const std::unique_ptr<Statement>& s) -> std::unique_ptr<Statement> {
407 if (s) {
John Stilesa5f3c312020-09-22 12:05:16 -0400408 return this->inlineStatement(offset, varMap, symbolTableForStatement, resultExpr,
John Stiles77702f12020-12-17 14:38:56 -0500409 returnComplexity, *s, isBuiltinCode);
John Stiles44e96be2020-08-31 13:16:04 -0400410 }
411 return nullptr;
412 };
Ethan Nicholas7bd60432020-09-25 14:31:59 -0400413 auto blockStmts = [&](const Block& block) {
John Stiles8f2a0cf2020-10-13 12:48:21 -0400414 StatementArray result;
John Stilesf4bda742020-10-14 16:57:41 -0400415 result.reserve_back(block.children().size());
Ethan Nicholas7bd60432020-09-25 14:31:59 -0400416 for (const std::unique_ptr<Statement>& child : block.children()) {
417 result.push_back(stmt(child));
418 }
419 return result;
420 };
John Stiles8f2a0cf2020-10-13 12:48:21 -0400421 auto stmts = [&](const StatementArray& ss) {
422 StatementArray result;
John Stilesf4bda742020-10-14 16:57:41 -0400423 result.reserve_back(ss.size());
John Stiles44e96be2020-08-31 13:16:04 -0400424 for (const auto& s : ss) {
425 result.push_back(stmt(s));
426 }
427 return result;
428 };
429 auto expr = [&](const std::unique_ptr<Expression>& e) -> std::unique_ptr<Expression> {
430 if (e) {
John Stilesd7cc0932020-11-30 12:24:27 -0500431 return this->inlineExpression(offset, varMap, symbolTableForStatement, *e);
John Stiles44e96be2020-08-31 13:16:04 -0400432 }
433 return nullptr;
434 };
John Stiles031a7672020-11-13 16:13:18 -0500435
436 ++fInlinedStatementCounter;
437
Ethan Nicholase6592142020-09-08 10:22:09 -0400438 switch (statement.kind()) {
439 case Statement::Kind::kBlock: {
John Stiles44e96be2020-08-31 13:16:04 -0400440 const Block& b = statement.as<Block>();
John Stilesa1e2b412020-10-20 14:51:28 -0400441 return std::make_unique<Block>(offset, blockStmts(b),
442 SymbolTable::WrapIfBuiltin(b.symbolTable()),
443 b.isScope());
John Stiles44e96be2020-08-31 13:16:04 -0400444 }
445
Ethan Nicholase6592142020-09-08 10:22:09 -0400446 case Statement::Kind::kBreak:
447 case Statement::Kind::kContinue:
448 case Statement::Kind::kDiscard:
John Stiles44e96be2020-08-31 13:16:04 -0400449 return statement.clone();
450
Ethan Nicholase6592142020-09-08 10:22:09 -0400451 case Statement::Kind::kDo: {
John Stiles44e96be2020-08-31 13:16:04 -0400452 const DoStatement& d = statement.as<DoStatement>();
John Stilesea5822e2021-02-26 11:18:20 -0500453 return DoStatement::Make(*fContext, stmt(d.statement()), expr(d.test()));
John Stiles44e96be2020-08-31 13:16:04 -0400454 }
Ethan Nicholase6592142020-09-08 10:22:09 -0400455 case Statement::Kind::kExpression: {
John Stiles44e96be2020-08-31 13:16:04 -0400456 const ExpressionStatement& e = statement.as<ExpressionStatement>();
John Stiles3e5871c2021-02-25 20:52:03 -0500457 return ExpressionStatement::Make(*fContext, expr(e.expression()));
John Stiles44e96be2020-08-31 13:16:04 -0400458 }
Ethan Nicholase6592142020-09-08 10:22:09 -0400459 case Statement::Kind::kFor: {
John Stiles44e96be2020-08-31 13:16:04 -0400460 const ForStatement& f = statement.as<ForStatement>();
461 // need to ensure initializer is evaluated first so that we've already remapped its
462 // declarations by the time we evaluate test & next
Ethan Nicholas0d31ed52020-10-05 14:47:09 -0400463 std::unique_ptr<Statement> initializer = stmt(f.initializer());
John Stilesb321a072021-02-25 16:24:19 -0500464 return ForStatement::Make(*fContext, offset, std::move(initializer), expr(f.test()),
465 expr(f.next()), stmt(f.statement()),
466 SymbolTable::WrapIfBuiltin(f.symbols()));
John Stiles44e96be2020-08-31 13:16:04 -0400467 }
Ethan Nicholase6592142020-09-08 10:22:09 -0400468 case Statement::Kind::kIf: {
John Stiles44e96be2020-08-31 13:16:04 -0400469 const IfStatement& i = statement.as<IfStatement>();
John Stilescf3059e2021-02-25 14:27:02 -0500470 return IfStatement::Make(*fContext, offset, i.isStatic(), expr(i.test()),
471 stmt(i.ifTrue()), stmt(i.ifFalse()));
John Stiles44e96be2020-08-31 13:16:04 -0400472 }
John Stiles98c1f822020-09-09 14:18:53 -0400473 case Statement::Kind::kInlineMarker:
Ethan Nicholase6592142020-09-08 10:22:09 -0400474 case Statement::Kind::kNop:
John Stiles44e96be2020-08-31 13:16:04 -0400475 return statement.clone();
John Stilesea5822e2021-02-26 11:18:20 -0500476
Ethan Nicholase6592142020-09-08 10:22:09 -0400477 case Statement::Kind::kReturn: {
John Stiles44e96be2020-08-31 13:16:04 -0400478 const ReturnStatement& r = statement.as<ReturnStatement>();
John Stiles77702f12020-12-17 14:38:56 -0500479 if (!r.expression()) {
480 if (returnComplexity >= ReturnComplexity::kEarlyReturns) {
481 // This function doesn't return a value, but has early returns, so we've wrapped
482 // it in a for loop. Use a continue to jump to the end of the loop and "leave"
483 // the function.
John Stiles7b920442020-12-17 10:43:41 -0500484 return std::make_unique<ContinueStatement>(offset);
John Stiles44e96be2020-08-31 13:16:04 -0400485 } else {
John Stiles77702f12020-12-17 14:38:56 -0500486 // This function doesn't exit early or return a value. A return statement at the
487 // end is a no-op and can be treated as such.
John Stiles44e96be2020-08-31 13:16:04 -0400488 return std::make_unique<Nop>();
489 }
490 }
John Stiles77702f12020-12-17 14:38:56 -0500491
John Stilesc5ff4862020-12-22 13:47:05 -0500492 // If a function only contains a single return, and it doesn't reference variables from
493 // inside an Block's scope, we don't need to store the result in a variable at all. Just
494 // replace the function-call expression with the function's return expression.
John Stiles77702f12020-12-17 14:38:56 -0500495 SkASSERT(resultExpr);
John Stilesc5ff4862020-12-22 13:47:05 -0500496 if (returnComplexity <= ReturnComplexity::kSingleSafeReturn) {
John Stiles77702f12020-12-17 14:38:56 -0500497 *resultExpr = expr(r.expression());
498 return std::make_unique<Nop>();
499 }
500
501 // For more complex functions, assign their result into a variable.
John Stiles511c5002021-02-25 11:17:02 -0500502 SkASSERT(*resultExpr);
John Stiles3e5871c2021-02-25 20:52:03 -0500503 auto assignment = ExpressionStatement::Make(
504 *fContext,
John Stilese2aec432021-03-01 09:27:48 -0500505 BinaryExpression::Make(
506 *fContext,
507 clone_with_ref_kind(**resultExpr, VariableRefKind::kWrite),
John Stiles77702f12020-12-17 14:38:56 -0500508 Token::Kind::TK_EQ,
John Stilese2aec432021-03-01 09:27:48 -0500509 expr(r.expression())));
John Stiles77702f12020-12-17 14:38:56 -0500510
511 // Early returns are wrapped in a for loop; we need to synthesize a continue statement
512 // to "leave" the function.
513 if (returnComplexity >= ReturnComplexity::kEarlyReturns) {
514 StatementArray block;
515 block.reserve_back(2);
516 block.push_back(std::move(assignment));
517 block.push_back(std::make_unique<ContinueStatement>(offset));
518 return std::make_unique<Block>(offset, std::move(block), /*symbols=*/nullptr,
519 /*isScope=*/true);
520 }
521 // Functions without early returns aren't wrapped in a for loop and don't need to worry
522 // about breaking out of the control flow.
John Stiles3e5871c2021-02-25 20:52:03 -0500523 return assignment;
John Stiles44e96be2020-08-31 13:16:04 -0400524 }
Ethan Nicholase6592142020-09-08 10:22:09 -0400525 case Statement::Kind::kSwitch: {
John Stiles44e96be2020-08-31 13:16:04 -0400526 const SwitchStatement& ss = statement.as<SwitchStatement>();
527 std::vector<std::unique_ptr<SwitchCase>> cases;
John Stiles2d4f9592020-10-30 10:29:12 -0400528 cases.reserve(ss.cases().size());
529 for (const std::unique_ptr<SwitchCase>& sc : ss.cases()) {
530 cases.push_back(std::make_unique<SwitchCase>(offset, expr(sc->value()),
531 stmts(sc->statements())));
John Stiles44e96be2020-08-31 13:16:04 -0400532 }
John Stilese1d1b082021-02-23 13:44:36 -0500533 return SwitchStatement::Make(*fContext, offset, ss.isStatic(), expr(ss.value()),
534 std::move(cases), SymbolTable::WrapIfBuiltin(ss.symbols()));
John Stiles44e96be2020-08-31 13:16:04 -0400535 }
Ethan Nicholase6592142020-09-08 10:22:09 -0400536 case Statement::Kind::kVarDeclaration: {
John Stiles44e96be2020-08-31 13:16:04 -0400537 const VarDeclaration& decl = statement.as<VarDeclaration>();
John Stiles35fee4c2020-12-16 18:25:14 +0000538 std::unique_ptr<Expression> initialValue = expr(decl.value());
John Stilesddcc8432021-01-15 15:32:32 -0500539 const Variable& variable = decl.var();
540
John Stiles35fee4c2020-12-16 18:25:14 +0000541 // We assign unique names to inlined variables--scopes hide most of the problems in this
542 // regard, but see `InlinerAvoidsVariableNameOverlap` for a counterexample where unique
543 // names are important.
John Stilesddcc8432021-01-15 15:32:32 -0500544 auto name = std::make_unique<String>(fMangler.uniqueName(variable.name(),
Ethan Nicholas6f4eee22021-01-11 12:37:42 -0500545 symbolTableForStatement));
John Stiles35fee4c2020-12-16 18:25:14 +0000546 const String* namePtr = symbolTableForStatement->takeOwnershipOfString(std::move(name));
Ethan Nicholas5b9b0db2021-01-21 13:12:01 -0500547 auto clonedVar = std::make_unique<Variable>(
548 offset,
549 &variable.modifiers(),
550 namePtr->c_str(),
551 variable.type().clone(symbolTableForStatement),
552 isBuiltinCode,
553 variable.storage());
554 (*varMap)[&variable] = std::make_unique<VariableReference>(offset, clonedVar.get());
555 auto result = std::make_unique<VarDeclaration>(clonedVar.get(),
John Stilesddcc8432021-01-15 15:32:32 -0500556 decl.baseType().clone(symbolTableForStatement),
557 decl.arraySize(),
John Stiles35fee4c2020-12-16 18:25:14 +0000558 std::move(initialValue));
Ethan Nicholas5b9b0db2021-01-21 13:12:01 -0500559 clonedVar->setDeclaration(result.get());
560 symbolTableForStatement->takeOwnershipOfSymbol(std::move(clonedVar));
561 return std::move(result);
John Stiles44e96be2020-08-31 13:16:04 -0400562 }
John Stiles44e96be2020-08-31 13:16:04 -0400563 default:
564 SkASSERT(false);
565 return nullptr;
566 }
567}
568
John Stiles7b920442020-12-17 10:43:41 -0500569Inliner::InlineVariable Inliner::makeInlineVariable(const String& baseName,
570 const Type* type,
571 SymbolTable* symbolTable,
572 Modifiers modifiers,
573 bool isBuiltinCode,
574 std::unique_ptr<Expression>* initialValue) {
575 // $floatLiteral or $intLiteral aren't real types that we can use for scratch variables, so
576 // replace them if they ever appear here. If this happens, we likely forgot to coerce a type
577 // somewhere during compilation.
John Stiles14975272021-01-12 11:41:14 -0500578 if (type->isLiteral()) {
579 SkDEBUGFAIL("found a $literal type while inlining");
580 type = &type->scalarTypeForLiteral();
John Stiles7b920442020-12-17 10:43:41 -0500581 }
582
583 // Provide our new variable with a unique name, and add it to our symbol table.
584 const String* namePtr = symbolTable->takeOwnershipOfString(
Ethan Nicholas6f4eee22021-01-11 12:37:42 -0500585 std::make_unique<String>(fMangler.uniqueName(baseName, symbolTable)));
John Stiles7b920442020-12-17 10:43:41 -0500586 StringFragment nameFrag{namePtr->c_str(), namePtr->length()};
587
588 // Create our new variable and add it to the symbol table.
589 InlineVariable result;
Ethan Nicholas5b9b0db2021-01-21 13:12:01 -0500590 auto var = std::make_unique<Variable>(/*offset=*/-1,
591 fModifiers->addToPool(Modifiers()),
592 nameFrag,
593 type,
594 isBuiltinCode,
595 Variable::Storage::kLocal);
John Stiles7b920442020-12-17 10:43:41 -0500596
597 // Prepare the variable declaration (taking extra care with `out` params to not clobber any
598 // initial value).
599 if (*initialValue && (modifiers.fFlags & Modifiers::kOut_Flag)) {
Ethan Nicholas5b9b0db2021-01-21 13:12:01 -0500600 result.fVarDecl = std::make_unique<VarDeclaration>(var.get(), type, /*arraySize=*/0,
John Stiles7b920442020-12-17 10:43:41 -0500601 (*initialValue)->clone());
602 } else {
Ethan Nicholas5b9b0db2021-01-21 13:12:01 -0500603 result.fVarDecl = std::make_unique<VarDeclaration>(var.get(), type, /*arraySize=*/0,
John Stiles7b920442020-12-17 10:43:41 -0500604 std::move(*initialValue));
605 }
Ethan Nicholas5b9b0db2021-01-21 13:12:01 -0500606 var->setDeclaration(&result.fVarDecl->as<VarDeclaration>());
607 result.fVarSymbol = symbolTable->add(std::move(var));
John Stiles7b920442020-12-17 10:43:41 -0500608 return result;
609}
610
John Stiles6eadf132020-09-08 10:16:10 -0400611Inliner::InlinedCall Inliner::inlineCall(FunctionCall* call,
John Stiles78047582020-12-16 16:17:41 -0500612 std::shared_ptr<SymbolTable> symbolTable,
Brian Osman3887a012020-09-30 13:22:27 -0400613 const FunctionDeclaration* caller) {
John Stiles44e96be2020-08-31 13:16:04 -0400614 // Inlining is more complicated here than in a typical compiler, because we have to have a
615 // high-level IR and can't just drop statements into the middle of an expression or even use
616 // gotos.
617 //
618 // Since we can't insert statements into an expression, we run the inline function as extra
619 // statements before the statement we're currently processing, relying on a lack of execution
620 // order guarantees. Since we can't use gotos (which are normally used to replace return
621 // statements), we wrap the whole function in a loop and use break statements to jump to the
622 // end.
John Stiles44e96be2020-08-31 13:16:04 -0400623 SkASSERT(fContext);
624 SkASSERT(call);
Ethan Nicholased84b732020-10-08 11:45:44 -0400625 SkASSERT(this->isSafeToInline(call->function().definition()));
John Stiles44e96be2020-08-31 13:16:04 -0400626
John Stiles8e3b6be2020-10-13 11:14:08 -0400627 ExpressionArray& arguments = call->arguments();
John Stiles6eadf132020-09-08 10:16:10 -0400628 const int offset = call->fOffset;
Ethan Nicholased84b732020-10-08 11:45:44 -0400629 const FunctionDefinition& function = *call->function().definition();
John Stiles77702f12020-12-17 14:38:56 -0500630 const ReturnComplexity returnComplexity = GetReturnComplexity(function);
631 bool hasEarlyReturn = (returnComplexity >= ReturnComplexity::kEarlyReturns);
John Stiles6eadf132020-09-08 10:16:10 -0400632
John Stiles44e96be2020-08-31 13:16:04 -0400633 InlinedCall inlinedCall;
John Stiles8f2a0cf2020-10-13 12:48:21 -0400634 inlinedCall.fInlinedBody = std::make_unique<Block>(offset, StatementArray{},
John Stiles6eadf132020-09-08 10:16:10 -0400635 /*symbols=*/nullptr,
636 /*isScope=*/false);
John Stiles98c1f822020-09-09 14:18:53 -0400637
Ethan Nicholas7bd60432020-09-25 14:31:59 -0400638 Block& inlinedBody = *inlinedCall.fInlinedBody;
John Stiles82f373c2020-10-20 13:58:05 -0400639 inlinedBody.children().reserve_back(
640 1 + // Inline marker
641 1 + // Result variable
642 arguments.size() + // Function arguments (passing in)
643 arguments.size() + // Function arguments (copy out-params back)
John Stiles7b920442020-12-17 10:43:41 -0500644 1); // Block for inlined code
John Stiles98c1f822020-09-09 14:18:53 -0400645
Ethan Nicholasceb62142020-10-09 16:51:18 -0400646 inlinedBody.children().push_back(std::make_unique<InlineMarker>(&call->function()));
John Stiles44e96be2020-08-31 13:16:04 -0400647
John Stilese41b4ee2020-09-28 12:28:16 -0400648 std::unique_ptr<Expression> resultExpr;
John Stiles511c5002021-02-25 11:17:02 -0500649 if (returnComplexity > ReturnComplexity::kSingleSafeReturn &&
650 function.declaration().returnType() != *fContext->fTypes.fVoid) {
651 // Create a variable to hold the result in the extra statements. We don't need to do this
652 // for void-return functions, or in cases that are simple enough that we can just replace
653 // the function-call node with the result expression.
John Stiles44e96be2020-08-31 13:16:04 -0400654 std::unique_ptr<Expression> noInitialValue;
John Stiles7b920442020-12-17 10:43:41 -0500655 InlineVariable var = this->makeInlineVariable(function.declaration().name(),
656 &function.declaration().returnType(),
657 symbolTable.get(), Modifiers{},
658 caller->isBuiltin(), &noInitialValue);
659 inlinedBody.children().push_back(std::move(var.fVarDecl));
660 resultExpr = std::make_unique<VariableReference>(/*offset=*/-1, var.fVarSymbol);
John Stiles511c5002021-02-25 11:17:02 -0500661 }
John Stiles44e96be2020-08-31 13:16:04 -0400662
663 // Create variables in the extra statements to hold the arguments, and assign the arguments to
664 // them.
665 VariableRewriteMap varMap;
John Stilese41b4ee2020-09-28 12:28:16 -0400666 std::vector<int> argsToCopyBack;
John Stiles44e96be2020-08-31 13:16:04 -0400667 for (int i = 0; i < (int) arguments.size(); ++i) {
Ethan Nicholas0a5d0962020-10-14 13:33:18 -0400668 const Variable* param = function.declaration().parameters()[i];
Ethan Nicholas041fd0a2020-10-07 16:42:04 -0400669 bool isOutParam = param->modifiers().fFlags & Modifiers::kOut_Flag;
John Stiles44e96be2020-08-31 13:16:04 -0400670
John Stiles44733aa2020-09-29 17:42:23 -0400671 // If this argument can be inlined trivially (e.g. a swizzle, or a constant array index)...
John Stilesc30fbca2020-11-19 16:25:49 -0500672 if (Analysis::IsTrivialExpression(*arguments[i])) {
John Stilese41b4ee2020-09-28 12:28:16 -0400673 // ... and it's an `out` param, or it isn't written to within the inline function...
Ethan Nicholas0a5d0962020-10-14 13:33:18 -0400674 if (isOutParam || !Analysis::StatementWritesToVariable(*function.body(), *param)) {
John Stilesf201af82020-09-29 16:57:55 -0400675 // ... we don't need to copy it at all! We can just use the existing expression.
676 varMap[param] = arguments[i]->clone();
John Stiles44e96be2020-08-31 13:16:04 -0400677 continue;
678 }
679 }
John Stilese41b4ee2020-09-28 12:28:16 -0400680 if (isOutParam) {
681 argsToCopyBack.push_back(i);
682 }
John Stiles7b920442020-12-17 10:43:41 -0500683 InlineVariable var = this->makeInlineVariable(param->name(), &arguments[i]->type(),
684 symbolTable.get(), param->modifiers(),
685 caller->isBuiltin(), &arguments[i]);
686 inlinedBody.children().push_back(std::move(var.fVarDecl));
687 varMap[param] = std::make_unique<VariableReference>(/*offset=*/-1, var.fVarSymbol);
John Stiles44e96be2020-08-31 13:16:04 -0400688 }
689
Ethan Nicholas0a5d0962020-10-14 13:33:18 -0400690 const Block& body = function.body()->as<Block>();
John Stiles7b920442020-12-17 10:43:41 -0500691 StatementArray* inlineStatements;
692
John Stiles44e96be2020-08-31 13:16:04 -0400693 if (hasEarlyReturn) {
694 // Since we output to backends that don't have a goto statement (which would normally be
John Stiles7b920442020-12-17 10:43:41 -0500695 // used to perform an early return), we fake it by wrapping the function in a single-
696 // iteration for loop, and use a continue statement to jump to the end of the loop
697 // prematurely.
698
699 // int _1_loop = 0;
700 symbolTable = std::make_shared<SymbolTable>(std::move(symbolTable), caller->isBuiltin());
John Stiles54e7c052021-01-11 14:22:36 -0500701 const Type* intType = fContext->fTypes.fInt.get();
John Stiles7b920442020-12-17 10:43:41 -0500702 std::unique_ptr<Expression> initialValue = std::make_unique<IntLiteral>(/*offset=*/-1,
703 /*value=*/0,
704 intType);
705 InlineVariable loopVar = this->makeInlineVariable("loop", intType, symbolTable.get(),
706 Modifiers{}, caller->isBuiltin(),
707 &initialValue);
708
709 // _1_loop < 1;
John Stilese2aec432021-03-01 09:27:48 -0500710 std::unique_ptr<Expression> test = BinaryExpression::Make(
711 *fContext,
John Stiles7b920442020-12-17 10:43:41 -0500712 std::make_unique<VariableReference>(/*offset=*/-1, loopVar.fVarSymbol),
713 Token::Kind::TK_LT,
John Stilese2aec432021-03-01 09:27:48 -0500714 std::make_unique<IntLiteral>(/*offset=*/-1, /*value=*/1, intType));
John Stiles7b920442020-12-17 10:43:41 -0500715
716 // _1_loop++
John Stiles52d3b012021-02-26 15:56:48 -0500717 std::unique_ptr<Expression> increment = PostfixExpression::Make(
718 *fContext,
John Stiles7b920442020-12-17 10:43:41 -0500719 std::make_unique<VariableReference>(/*offset=*/-1, loopVar.fVarSymbol,
720 VariableReference::RefKind::kReadWrite),
721 Token::Kind::TK_PLUSPLUS);
722
723 // {...}
724 auto innerBlock = std::make_unique<Block>(offset, StatementArray{},
725 /*symbols=*/nullptr, /*isScope=*/true);
726 inlineStatements = &innerBlock->children();
727
728 // for (int _1_loop = 0; _1_loop < 1; _1_loop++) {...}
John Stilesb321a072021-02-25 16:24:19 -0500729 inlinedBody.children().push_back(ForStatement::Make(*fContext, /*offset=*/-1,
730 std::move(loopVar.fVarDecl),
731 std::move(test),
732 std::move(increment),
733 std::move(innerBlock),
734 symbolTable));
John Stiles44e96be2020-08-31 13:16:04 -0400735 } else {
John Stilesfa9a0832020-12-17 10:43:58 -0500736 // No early returns, so we can just dump the code into our existing scopeless block.
737 inlineStatements = &inlinedBody.children();
John Stiles7b920442020-12-17 10:43:41 -0500738 }
739
740 inlineStatements->reserve_back(body.children().size() + argsToCopyBack.size());
741 for (const std::unique_ptr<Statement>& stmt : body.children()) {
742 inlineStatements->push_back(this->inlineStatement(offset, &varMap, symbolTable.get(),
John Stiles77702f12020-12-17 14:38:56 -0500743 &resultExpr, returnComplexity, *stmt,
John Stiles7b920442020-12-17 10:43:41 -0500744 caller->isBuiltin()));
John Stiles44e96be2020-08-31 13:16:04 -0400745 }
746
John Stilese41b4ee2020-09-28 12:28:16 -0400747 // Copy back the values of `out` parameters into their real destinations.
748 for (int i : argsToCopyBack) {
Ethan Nicholas0a5d0962020-10-14 13:33:18 -0400749 const Variable* p = function.declaration().parameters()[i];
John Stilese41b4ee2020-09-28 12:28:16 -0400750 SkASSERT(varMap.find(p) != varMap.end());
John Stiles3e5871c2021-02-25 20:52:03 -0500751 inlineStatements->push_back(ExpressionStatement::Make(
752 *fContext,
John Stilese2aec432021-03-01 09:27:48 -0500753 BinaryExpression::Make(*fContext,
754 clone_with_ref_kind(*arguments[i], VariableRefKind::kWrite),
755 Token::Kind::TK_EQ,
756 std::move(varMap[p]))));
John Stiles44e96be2020-08-31 13:16:04 -0400757 }
758
John Stiles0c2d14a2021-03-01 10:08:08 -0500759 if (resultExpr) {
760 // Return our result expression as-is.
John Stilese41b4ee2020-09-28 12:28:16 -0400761 inlinedCall.fReplacementExpr = std::move(resultExpr);
John Stiles0c2d14a2021-03-01 10:08:08 -0500762 } else if (function.declaration().returnType() == *fContext->fTypes.fVoid) {
John Stiles44e96be2020-08-31 13:16:04 -0400763 // It's a void function, so it doesn't actually result in anything, but we have to return
764 // something non-null as a standin.
Ethan Nicholas041fd0a2020-10-07 16:42:04 -0400765 inlinedCall.fReplacementExpr = std::make_unique<BoolLiteral>(*fContext,
766 offset,
John Stiles44e96be2020-08-31 13:16:04 -0400767 /*value=*/false);
John Stiles0c2d14a2021-03-01 10:08:08 -0500768 } else {
769 // It's a non-void function, but it never created a result expression--that is, it never
770 // returned anything! Discard our output and generate an error.
771 fContext->fErrors.error(function.fOffset, String("function '") +
772 function.declaration().name() +
773 "' exits without returning a value");
774 inlinedCall = {};
John Stiles44e96be2020-08-31 13:16:04 -0400775 }
776
John Stiles44e96be2020-08-31 13:16:04 -0400777 return inlinedCall;
778}
779
John Stiles2d7973a2020-10-02 15:01:03 -0400780bool Inliner::isSafeToInline(const FunctionDefinition* functionDef) {
John Stiles1c03d332020-10-13 10:30:23 -0400781 // A threshold of zero indicates that the inliner is completely disabled, so we can just return.
John Stilesd1204642021-02-17 16:30:02 -0500782 if (this->settings().fInlineThreshold <= 0) {
John Stiles1c03d332020-10-13 10:30:23 -0400783 return false;
784 }
785
John Stiles031a7672020-11-13 16:13:18 -0500786 // Enforce a limit on inlining to avoid pathological cases. (inliner/ExponentialGrowth.sksl)
787 if (fInlinedStatementCounter >= kInlinedStatementLimit) {
788 return false;
789 }
790
John Stiles2d7973a2020-10-02 15:01:03 -0400791 if (functionDef == nullptr) {
John Stiles44e96be2020-08-31 13:16:04 -0400792 // Can't inline something if we don't actually have its definition.
793 return false;
794 }
John Stiles2d7973a2020-10-02 15:01:03 -0400795
John Stiles74ebd7e2020-12-17 14:41:50 -0500796 // We don't have any mechanism to simulate early returns within a construct that supports
797 // continues (for/do/while), so we can't inline if there's a return inside one.
798 bool hasReturnInContinuableConstruct =
799 (count_returns_in_continuable_constructs(*functionDef) > 0);
800 return !hasReturnInContinuableConstruct;
John Stiles44e96be2020-08-31 13:16:04 -0400801}
802
John Stiles2d7973a2020-10-02 15:01:03 -0400803// A candidate function for inlining, containing everything that `inlineCall` needs.
804struct InlineCandidate {
John Stiles78047582020-12-16 16:17:41 -0500805 std::shared_ptr<SymbolTable> fSymbols; // the SymbolTable of the candidate
John Stiles2d7973a2020-10-02 15:01:03 -0400806 std::unique_ptr<Statement>* fParentStmt; // the parent Statement of the enclosing stmt
807 std::unique_ptr<Statement>* fEnclosingStmt; // the Statement containing the candidate
808 std::unique_ptr<Expression>* fCandidateExpr; // the candidate FunctionCall to be inlined
809 FunctionDefinition* fEnclosingFunction; // the Function containing the candidate
John Stiles2d7973a2020-10-02 15:01:03 -0400810};
John Stiles93442622020-09-11 12:11:27 -0400811
John Stiles2d7973a2020-10-02 15:01:03 -0400812struct InlineCandidateList {
813 std::vector<InlineCandidate> fCandidates;
814};
815
816class InlineCandidateAnalyzer {
John Stiles70957c82020-10-02 16:42:10 -0400817public:
818 // A list of all the inlining candidates we found during analysis.
819 InlineCandidateList* fCandidateList;
John Stiles2d7973a2020-10-02 15:01:03 -0400820
John Stiles70957c82020-10-02 16:42:10 -0400821 // A stack of the symbol tables; since most nodes don't have one, expected to be shallower than
822 // the enclosing-statement stack.
John Stiles78047582020-12-16 16:17:41 -0500823 std::vector<std::shared_ptr<SymbolTable>> fSymbolTableStack;
John Stiles70957c82020-10-02 16:42:10 -0400824 // A stack of "enclosing" statements--these would be suitable for the inliner to use for adding
825 // new instructions. Not all statements are suitable (e.g. a for-loop's initializer). The
826 // inliner might replace a statement with a block containing the statement.
827 std::vector<std::unique_ptr<Statement>*> fEnclosingStmtStack;
828 // The function that we're currently processing (i.e. inlining into).
829 FunctionDefinition* fEnclosingFunction = nullptr;
John Stiles93442622020-09-11 12:11:27 -0400830
Brian Osman0006ad02020-11-18 15:38:39 -0500831 void visit(const std::vector<std::unique_ptr<ProgramElement>>& elements,
John Stiles78047582020-12-16 16:17:41 -0500832 std::shared_ptr<SymbolTable> symbols,
Brian Osman0006ad02020-11-18 15:38:39 -0500833 InlineCandidateList* candidateList) {
John Stiles70957c82020-10-02 16:42:10 -0400834 fCandidateList = candidateList;
Brian Osman0006ad02020-11-18 15:38:39 -0500835 fSymbolTableStack.push_back(symbols);
John Stiles93442622020-09-11 12:11:27 -0400836
Brian Osman0006ad02020-11-18 15:38:39 -0500837 for (const std::unique_ptr<ProgramElement>& pe : elements) {
Brian Osman1179fcf2020-10-08 16:04:40 -0400838 this->visitProgramElement(pe.get());
John Stiles93442622020-09-11 12:11:27 -0400839 }
840
John Stiles70957c82020-10-02 16:42:10 -0400841 fSymbolTableStack.pop_back();
842 fCandidateList = nullptr;
843 }
844
845 void visitProgramElement(ProgramElement* pe) {
846 switch (pe->kind()) {
847 case ProgramElement::Kind::kFunction: {
848 FunctionDefinition& funcDef = pe->as<FunctionDefinition>();
Brian Osman0006ad02020-11-18 15:38:39 -0500849 fEnclosingFunction = &funcDef;
850 this->visitStatement(&funcDef.body());
John Stiles70957c82020-10-02 16:42:10 -0400851 break;
John Stiles93442622020-09-11 12:11:27 -0400852 }
John Stiles70957c82020-10-02 16:42:10 -0400853 default:
854 // The inliner can't operate outside of a function's scope.
855 break;
856 }
857 }
858
859 void visitStatement(std::unique_ptr<Statement>* stmt,
860 bool isViableAsEnclosingStatement = true) {
861 if (!*stmt) {
862 return;
John Stiles93442622020-09-11 12:11:27 -0400863 }
864
John Stiles70957c82020-10-02 16:42:10 -0400865 size_t oldEnclosingStmtStackSize = fEnclosingStmtStack.size();
866 size_t oldSymbolStackSize = fSymbolTableStack.size();
John Stiles93442622020-09-11 12:11:27 -0400867
John Stiles70957c82020-10-02 16:42:10 -0400868 if (isViableAsEnclosingStatement) {
869 fEnclosingStmtStack.push_back(stmt);
John Stiles93442622020-09-11 12:11:27 -0400870 }
871
John Stiles70957c82020-10-02 16:42:10 -0400872 switch ((*stmt)->kind()) {
873 case Statement::Kind::kBreak:
874 case Statement::Kind::kContinue:
875 case Statement::Kind::kDiscard:
876 case Statement::Kind::kInlineMarker:
877 case Statement::Kind::kNop:
878 break;
879
880 case Statement::Kind::kBlock: {
881 Block& block = (*stmt)->as<Block>();
882 if (block.symbolTable()) {
John Stiles78047582020-12-16 16:17:41 -0500883 fSymbolTableStack.push_back(block.symbolTable());
John Stiles70957c82020-10-02 16:42:10 -0400884 }
885
886 for (std::unique_ptr<Statement>& stmt : block.children()) {
887 this->visitStatement(&stmt);
888 }
889 break;
John Stiles93442622020-09-11 12:11:27 -0400890 }
John Stiles70957c82020-10-02 16:42:10 -0400891 case Statement::Kind::kDo: {
892 DoStatement& doStmt = (*stmt)->as<DoStatement>();
893 // The loop body is a candidate for inlining.
894 this->visitStatement(&doStmt.statement());
895 // The inliner isn't smart enough to inline the test-expression for a do-while
896 // loop at this time. There are two limitations:
897 // - We would need to insert the inlined-body block at the very end of the do-
898 // statement's inner fStatement. We don't support that today, but it's doable.
899 // - We cannot inline the test expression if the loop uses `continue` anywhere; that
900 // would skip over the inlined block that evaluates the test expression. There
901 // isn't a good fix for this--any workaround would be more complex than the cost
902 // of a function call. However, loops that don't use `continue` would still be
903 // viable candidates for inlining.
904 break;
John Stiles93442622020-09-11 12:11:27 -0400905 }
John Stiles70957c82020-10-02 16:42:10 -0400906 case Statement::Kind::kExpression: {
907 ExpressionStatement& expr = (*stmt)->as<ExpressionStatement>();
908 this->visitExpression(&expr.expression());
909 break;
910 }
911 case Statement::Kind::kFor: {
912 ForStatement& forStmt = (*stmt)->as<ForStatement>();
Ethan Nicholas0d31ed52020-10-05 14:47:09 -0400913 if (forStmt.symbols()) {
John Stiles78047582020-12-16 16:17:41 -0500914 fSymbolTableStack.push_back(forStmt.symbols());
John Stiles70957c82020-10-02 16:42:10 -0400915 }
916
917 // The initializer and loop body are candidates for inlining.
Ethan Nicholas0d31ed52020-10-05 14:47:09 -0400918 this->visitStatement(&forStmt.initializer(),
John Stiles70957c82020-10-02 16:42:10 -0400919 /*isViableAsEnclosingStatement=*/false);
Ethan Nicholas0d31ed52020-10-05 14:47:09 -0400920 this->visitStatement(&forStmt.statement());
John Stiles70957c82020-10-02 16:42:10 -0400921
922 // The inliner isn't smart enough to inline the test- or increment-expressions
923 // of a for loop loop at this time. There are a handful of limitations:
924 // - We would need to insert the test-expression block at the very beginning of the
925 // for-loop's inner fStatement, and the increment-expression block at the very
926 // end. We don't support that today, but it's doable.
927 // - The for-loop's built-in test-expression would need to be dropped entirely,
928 // and the loop would be halted via a break statement at the end of the inlined
929 // test-expression. This is again something we don't support today, but it could
930 // be implemented.
931 // - We cannot inline the increment-expression if the loop uses `continue` anywhere;
932 // that would skip over the inlined block that evaluates the increment expression.
933 // There isn't a good fix for this--any workaround would be more complex than the
934 // cost of a function call. However, loops that don't use `continue` would still
935 // be viable candidates for increment-expression inlining.
936 break;
937 }
938 case Statement::Kind::kIf: {
939 IfStatement& ifStmt = (*stmt)->as<IfStatement>();
Ethan Nicholas8c44eca2020-10-07 16:47:09 -0400940 this->visitExpression(&ifStmt.test());
941 this->visitStatement(&ifStmt.ifTrue());
942 this->visitStatement(&ifStmt.ifFalse());
John Stiles70957c82020-10-02 16:42:10 -0400943 break;
944 }
945 case Statement::Kind::kReturn: {
946 ReturnStatement& returnStmt = (*stmt)->as<ReturnStatement>();
Ethan Nicholas2a4952d2020-10-08 15:35:56 -0400947 this->visitExpression(&returnStmt.expression());
John Stiles70957c82020-10-02 16:42:10 -0400948 break;
949 }
950 case Statement::Kind::kSwitch: {
951 SwitchStatement& switchStmt = (*stmt)->as<SwitchStatement>();
Ethan Nicholas01b05e52020-10-22 15:53:41 -0400952 if (switchStmt.symbols()) {
John Stiles78047582020-12-16 16:17:41 -0500953 fSymbolTableStack.push_back(switchStmt.symbols());
John Stiles70957c82020-10-02 16:42:10 -0400954 }
955
Ethan Nicholas01b05e52020-10-22 15:53:41 -0400956 this->visitExpression(&switchStmt.value());
John Stiles2d4f9592020-10-30 10:29:12 -0400957 for (const std::unique_ptr<SwitchCase>& switchCase : switchStmt.cases()) {
John Stiles70957c82020-10-02 16:42:10 -0400958 // The switch-case's fValue cannot be a FunctionCall; skip it.
John Stiles2d4f9592020-10-30 10:29:12 -0400959 for (std::unique_ptr<Statement>& caseBlock : switchCase->statements()) {
John Stiles70957c82020-10-02 16:42:10 -0400960 this->visitStatement(&caseBlock);
961 }
962 }
963 break;
964 }
965 case Statement::Kind::kVarDeclaration: {
966 VarDeclaration& varDeclStmt = (*stmt)->as<VarDeclaration>();
967 // Don't need to scan the declaration's sizes; those are always IntLiterals.
Ethan Nicholasc51f33e2020-10-13 13:49:44 -0400968 this->visitExpression(&varDeclStmt.value());
John Stiles70957c82020-10-02 16:42:10 -0400969 break;
970 }
John Stiles70957c82020-10-02 16:42:10 -0400971 default:
972 SkUNREACHABLE;
John Stiles93442622020-09-11 12:11:27 -0400973 }
974
John Stiles70957c82020-10-02 16:42:10 -0400975 // Pop our symbol and enclosing-statement stacks.
976 fSymbolTableStack.resize(oldSymbolStackSize);
977 fEnclosingStmtStack.resize(oldEnclosingStmtStackSize);
978 }
979
980 void visitExpression(std::unique_ptr<Expression>* expr) {
981 if (!*expr) {
982 return;
John Stiles93442622020-09-11 12:11:27 -0400983 }
John Stiles70957c82020-10-02 16:42:10 -0400984
985 switch ((*expr)->kind()) {
986 case Expression::Kind::kBoolLiteral:
987 case Expression::Kind::kDefined:
Brian Osmanbe0b3b72021-01-06 14:27:35 -0500988 case Expression::Kind::kExternalFunctionReference:
John Stiles70957c82020-10-02 16:42:10 -0400989 case Expression::Kind::kFieldAccess:
990 case Expression::Kind::kFloatLiteral:
991 case Expression::Kind::kFunctionReference:
992 case Expression::Kind::kIntLiteral:
John Stiles70957c82020-10-02 16:42:10 -0400993 case Expression::Kind::kSetting:
994 case Expression::Kind::kTypeReference:
995 case Expression::Kind::kVariableReference:
996 // Nothing to scan here.
997 break;
998
999 case Expression::Kind::kBinary: {
1000 BinaryExpression& binaryExpr = (*expr)->as<BinaryExpression>();
John Stiles2d4f9592020-10-30 10:29:12 -04001001 this->visitExpression(&binaryExpr.left());
John Stiles70957c82020-10-02 16:42:10 -04001002
1003 // Logical-and and logical-or binary expressions do not inline the right side,
1004 // because that would invalidate short-circuiting. That is, when evaluating
1005 // expressions like these:
1006 // (false && x()) // always false
1007 // (true || y()) // always true
1008 // It is illegal for side-effects from x() or y() to occur. The simplest way to
1009 // enforce that rule is to avoid inlining the right side entirely. However, it is
1010 // safe for other types of binary expression to inline both sides.
John Stiles45990502021-02-16 10:55:27 -05001011 Operator op = binaryExpr.getOperator();
1012 bool shortCircuitable = (op.kind() == Token::Kind::TK_LOGICALAND ||
1013 op.kind() == Token::Kind::TK_LOGICALOR);
John Stiles70957c82020-10-02 16:42:10 -04001014 if (!shortCircuitable) {
John Stiles2d4f9592020-10-30 10:29:12 -04001015 this->visitExpression(&binaryExpr.right());
John Stiles70957c82020-10-02 16:42:10 -04001016 }
1017 break;
1018 }
1019 case Expression::Kind::kConstructor: {
1020 Constructor& constructorExpr = (*expr)->as<Constructor>();
1021 for (std::unique_ptr<Expression>& arg : constructorExpr.arguments()) {
1022 this->visitExpression(&arg);
1023 }
1024 break;
1025 }
1026 case Expression::Kind::kExternalFunctionCall: {
1027 ExternalFunctionCall& funcCallExpr = (*expr)->as<ExternalFunctionCall>();
1028 for (std::unique_ptr<Expression>& arg : funcCallExpr.arguments()) {
1029 this->visitExpression(&arg);
1030 }
1031 break;
1032 }
1033 case Expression::Kind::kFunctionCall: {
1034 FunctionCall& funcCallExpr = (*expr)->as<FunctionCall>();
Ethan Nicholas0dec9922020-10-05 15:51:52 -04001035 for (std::unique_ptr<Expression>& arg : funcCallExpr.arguments()) {
John Stiles70957c82020-10-02 16:42:10 -04001036 this->visitExpression(&arg);
1037 }
1038 this->addInlineCandidate(expr);
1039 break;
1040 }
1041 case Expression::Kind::kIndex:{
1042 IndexExpression& indexExpr = (*expr)->as<IndexExpression>();
Ethan Nicholas2a4952d2020-10-08 15:35:56 -04001043 this->visitExpression(&indexExpr.base());
1044 this->visitExpression(&indexExpr.index());
John Stiles70957c82020-10-02 16:42:10 -04001045 break;
1046 }
1047 case Expression::Kind::kPostfix: {
1048 PostfixExpression& postfixExpr = (*expr)->as<PostfixExpression>();
Ethan Nicholas444ccc62020-10-09 10:16:22 -04001049 this->visitExpression(&postfixExpr.operand());
John Stiles70957c82020-10-02 16:42:10 -04001050 break;
1051 }
1052 case Expression::Kind::kPrefix: {
1053 PrefixExpression& prefixExpr = (*expr)->as<PrefixExpression>();
Ethan Nicholas444ccc62020-10-09 10:16:22 -04001054 this->visitExpression(&prefixExpr.operand());
John Stiles70957c82020-10-02 16:42:10 -04001055 break;
1056 }
1057 case Expression::Kind::kSwizzle: {
1058 Swizzle& swizzleExpr = (*expr)->as<Swizzle>();
Ethan Nicholas6b4d5812020-10-12 16:11:51 -04001059 this->visitExpression(&swizzleExpr.base());
John Stiles70957c82020-10-02 16:42:10 -04001060 break;
1061 }
1062 case Expression::Kind::kTernary: {
1063 TernaryExpression& ternaryExpr = (*expr)->as<TernaryExpression>();
1064 // The test expression is a candidate for inlining.
Ethan Nicholasdd218162020-10-08 05:48:01 -04001065 this->visitExpression(&ternaryExpr.test());
John Stiles70957c82020-10-02 16:42:10 -04001066 // The true- and false-expressions cannot be inlined, because we are only allowed to
1067 // evaluate one side.
1068 break;
1069 }
1070 default:
1071 SkUNREACHABLE;
1072 }
1073 }
1074
1075 void addInlineCandidate(std::unique_ptr<Expression>* candidate) {
1076 fCandidateList->fCandidates.push_back(
1077 InlineCandidate{fSymbolTableStack.back(),
1078 find_parent_statement(fEnclosingStmtStack),
1079 fEnclosingStmtStack.back(),
1080 candidate,
John Stiles9b9415e2020-11-23 14:48:06 -05001081 fEnclosingFunction});
John Stiles70957c82020-10-02 16:42:10 -04001082 }
John Stiles2d7973a2020-10-02 15:01:03 -04001083};
John Stiles93442622020-09-11 12:11:27 -04001084
John Stiles9b9415e2020-11-23 14:48:06 -05001085static const FunctionDeclaration& candidate_func(const InlineCandidate& candidate) {
1086 return (*candidate.fCandidateExpr)->as<FunctionCall>().function();
1087}
John Stiles915a38c2020-09-14 09:38:13 -04001088
John Stiles9b9415e2020-11-23 14:48:06 -05001089bool Inliner::candidateCanBeInlined(const InlineCandidate& candidate, InlinabilityCache* cache) {
1090 const FunctionDeclaration& funcDecl = candidate_func(candidate);
John Stiles1c03d332020-10-13 10:30:23 -04001091 auto [iter, wasInserted] = cache->insert({&funcDecl, false});
John Stiles2d7973a2020-10-02 15:01:03 -04001092 if (wasInserted) {
1093 // Recursion is forbidden here to avoid an infinite death spiral of inlining.
John Stiles1c03d332020-10-13 10:30:23 -04001094 iter->second = this->isSafeToInline(funcDecl.definition()) &&
1095 !contains_recursive_call(funcDecl);
John Stiles93442622020-09-11 12:11:27 -04001096 }
1097
John Stiles2d7973a2020-10-02 15:01:03 -04001098 return iter->second;
1099}
1100
John Stiles9b9415e2020-11-23 14:48:06 -05001101int Inliner::getFunctionSize(const FunctionDeclaration& funcDecl, FunctionSizeCache* cache) {
1102 auto [iter, wasInserted] = cache->insert({&funcDecl, 0});
John Stiles2d7973a2020-10-02 15:01:03 -04001103 if (wasInserted) {
John Stiles9b9415e2020-11-23 14:48:06 -05001104 iter->second = Analysis::NodeCountUpToLimit(*funcDecl.definition(),
John Stilesd1204642021-02-17 16:30:02 -05001105 this->settings().fInlineThreshold);
John Stiles2d7973a2020-10-02 15:01:03 -04001106 }
John Stiles2d7973a2020-10-02 15:01:03 -04001107 return iter->second;
1108}
1109
Brian Osman0006ad02020-11-18 15:38:39 -05001110void Inliner::buildCandidateList(const std::vector<std::unique_ptr<ProgramElement>>& elements,
John Stiles78047582020-12-16 16:17:41 -05001111 std::shared_ptr<SymbolTable> symbols, ProgramUsage* usage,
Brian Osman0006ad02020-11-18 15:38:39 -05001112 InlineCandidateList* candidateList) {
John Stiles2d7973a2020-10-02 15:01:03 -04001113 // This is structured much like a ProgramVisitor, but does not actually use ProgramVisitor.
1114 // The analyzer needs to keep track of the `unique_ptr<T>*` of statements and expressions so
1115 // that they can later be replaced, and ProgramVisitor does not provide this; it only provides a
1116 // `const T&`.
1117 InlineCandidateAnalyzer analyzer;
Brian Osman0006ad02020-11-18 15:38:39 -05001118 analyzer.visit(elements, symbols, candidateList);
John Stiles2d7973a2020-10-02 15:01:03 -04001119
John Stiles0ad233f2020-11-25 11:02:05 -05001120 // Early out if there are no inlining candidates.
John Stiles2d7973a2020-10-02 15:01:03 -04001121 std::vector<InlineCandidate>& candidates = candidateList->fCandidates;
John Stiles0ad233f2020-11-25 11:02:05 -05001122 if (candidates.empty()) {
1123 return;
1124 }
1125
1126 // Remove candidates that are not safe to inline.
John Stiles2d7973a2020-10-02 15:01:03 -04001127 InlinabilityCache cache;
1128 candidates.erase(std::remove_if(candidates.begin(),
1129 candidates.end(),
1130 [&](const InlineCandidate& candidate) {
1131 return !this->candidateCanBeInlined(candidate, &cache);
1132 }),
1133 candidates.end());
1134
John Stiles0ad233f2020-11-25 11:02:05 -05001135 // If the inline threshold is unlimited, or if we have no candidates left, our candidate list is
1136 // complete.
John Stilesd1204642021-02-17 16:30:02 -05001137 if (this->settings().fInlineThreshold == INT_MAX || candidates.empty()) {
John Stiles0ad233f2020-11-25 11:02:05 -05001138 return;
John Stiles2d7973a2020-10-02 15:01:03 -04001139 }
John Stiles0ad233f2020-11-25 11:02:05 -05001140
1141 // Remove candidates on a per-function basis if the effect of inlining would be to make more
1142 // than `inlineThreshold` nodes. (i.e. if Func() would be inlined six times and its size is
1143 // 10 nodes, it should be inlined if the inlineThreshold is 60 or higher.)
1144 FunctionSizeCache functionSizeCache;
1145 FunctionSizeCache candidateTotalCost;
1146 for (InlineCandidate& candidate : candidates) {
1147 const FunctionDeclaration& fnDecl = candidate_func(candidate);
1148 candidateTotalCost[&fnDecl] += this->getFunctionSize(fnDecl, &functionSizeCache);
1149 }
1150
John Stilesd1204642021-02-17 16:30:02 -05001151 candidates.erase(std::remove_if(candidates.begin(), candidates.end(),
1152 [&](const InlineCandidate& candidate) {
1153 const FunctionDeclaration& fnDecl = candidate_func(candidate);
1154 if (fnDecl.modifiers().fFlags & Modifiers::kInline_Flag) {
1155 // Functions marked `inline` ignore size limitations.
1156 return false;
1157 }
1158 if (usage->get(fnDecl) == 1) {
1159 // If a function is only used once, it's cost-free to inline.
1160 return false;
1161 }
1162 if (candidateTotalCost[&fnDecl] <= this->settings().fInlineThreshold) {
1163 // We won't exceed the inline threshold by inlining this.
1164 return false;
1165 }
1166 // Inlining this function will add too many IRNodes.
1167 return true;
1168 }),
1169 candidates.end());
John Stiles2d7973a2020-10-02 15:01:03 -04001170}
1171
Brian Osman0006ad02020-11-18 15:38:39 -05001172bool Inliner::analyze(const std::vector<std::unique_ptr<ProgramElement>>& elements,
John Stiles78047582020-12-16 16:17:41 -05001173 std::shared_ptr<SymbolTable> symbols,
Brian Osman0006ad02020-11-18 15:38:39 -05001174 ProgramUsage* usage) {
John Stilesd34d56e2020-10-12 12:04:47 -04001175 // A threshold of zero indicates that the inliner is completely disabled, so we can just return.
John Stilesd1204642021-02-17 16:30:02 -05001176 if (this->settings().fInlineThreshold <= 0) {
John Stilesd34d56e2020-10-12 12:04:47 -04001177 return false;
1178 }
1179
John Stiles031a7672020-11-13 16:13:18 -05001180 // Enforce a limit on inlining to avoid pathological cases. (inliner/ExponentialGrowth.sksl)
1181 if (fInlinedStatementCounter >= kInlinedStatementLimit) {
1182 return false;
1183 }
1184
John Stiles2d7973a2020-10-02 15:01:03 -04001185 InlineCandidateList candidateList;
John Stiles9b9415e2020-11-23 14:48:06 -05001186 this->buildCandidateList(elements, symbols, usage, &candidateList);
John Stiles2d7973a2020-10-02 15:01:03 -04001187
John Stiles915a38c2020-09-14 09:38:13 -04001188 // Inline the candidates where we've determined that it's safe to do so.
1189 std::unordered_set<const std::unique_ptr<Statement>*> enclosingStmtSet;
1190 bool madeChanges = false;
John Stiles2d7973a2020-10-02 15:01:03 -04001191 for (const InlineCandidate& candidate : candidateList.fCandidates) {
John Stiles915a38c2020-09-14 09:38:13 -04001192 FunctionCall& funcCall = (*candidate.fCandidateExpr)->as<FunctionCall>();
John Stiles915a38c2020-09-14 09:38:13 -04001193
1194 // Inlining two expressions using the same enclosing statement in the same inlining pass
1195 // does not work properly. If this happens, skip it; we'll get it in the next pass.
1196 auto [unusedIter, inserted] = enclosingStmtSet.insert(candidate.fEnclosingStmt);
1197 if (!inserted) {
1198 continue;
1199 }
1200
1201 // Convert the function call to its inlined equivalent.
Brian Osman3887a012020-09-30 13:22:27 -04001202 InlinedCall inlinedCall = this->inlineCall(&funcCall, candidate.fSymbols,
Ethan Nicholas0a5d0962020-10-14 13:33:18 -04001203 &candidate.fEnclosingFunction->declaration());
John Stiles915a38c2020-09-14 09:38:13 -04001204
John Stiles0c2d14a2021-03-01 10:08:08 -05001205 // Stop if an error was detected during the inlining process.
1206 if (!inlinedCall.fInlinedBody && !inlinedCall.fReplacementExpr) {
1207 break;
John Stiles915a38c2020-09-14 09:38:13 -04001208 }
1209
John Stiles0c2d14a2021-03-01 10:08:08 -05001210 // Ensure that the inlined body has a scope if it needs one.
1211 this->ensureScopedBlocks(inlinedCall.fInlinedBody.get(), candidate.fParentStmt->get());
1212
1213 // Add references within the inlined body
1214 usage->add(inlinedCall.fInlinedBody.get());
1215
1216 // Move the enclosing statement to the end of the unscoped Block containing the inlined
1217 // function, then replace the enclosing statement with that Block.
1218 // Before:
1219 // fInlinedBody = Block{ stmt1, stmt2, stmt3 }
1220 // fEnclosingStmt = stmt4
1221 // After:
1222 // fInlinedBody = null
1223 // fEnclosingStmt = Block{ stmt1, stmt2, stmt3, stmt4 }
1224 inlinedCall.fInlinedBody->children().push_back(std::move(*candidate.fEnclosingStmt));
1225 *candidate.fEnclosingStmt = std::move(inlinedCall.fInlinedBody);
1226
John Stiles915a38c2020-09-14 09:38:13 -04001227 // Replace the candidate function call with our replacement expression.
Brian Osman010ce6a2020-10-19 16:34:10 -04001228 usage->replace(candidate.fCandidateExpr->get(), inlinedCall.fReplacementExpr.get());
John Stiles915a38c2020-09-14 09:38:13 -04001229 *candidate.fCandidateExpr = std::move(inlinedCall.fReplacementExpr);
1230 madeChanges = true;
1231
John Stiles031a7672020-11-13 16:13:18 -05001232 // Stop inlining if we've reached our hard cap on new statements.
1233 if (fInlinedStatementCounter >= kInlinedStatementLimit) {
1234 break;
1235 }
1236
John Stiles915a38c2020-09-14 09:38:13 -04001237 // Note that nothing was destroyed except for the FunctionCall. All other nodes should
1238 // remain valid.
1239 }
1240
1241 return madeChanges;
John Stiles93442622020-09-11 12:11:27 -04001242}
1243
John Stiles44e96be2020-08-31 13:16:04 -04001244} // namespace SkSL