blob: 011c443bd6560fb4728270cd3a4d3ca3f9db4027 [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
Ethan Nicholasdaed2592021-03-04 14:30:25 -050014#include "include/private/SkSLLayout.h"
John Stiles44e96be2020-08-31 13:16:04 -040015#include "src/sksl/SkSLAnalysis.h"
16#include "src/sksl/ir/SkSLBinaryExpression.h"
17#include "src/sksl/ir/SkSLBoolLiteral.h"
18#include "src/sksl/ir/SkSLBreakStatement.h"
19#include "src/sksl/ir/SkSLConstructor.h"
20#include "src/sksl/ir/SkSLContinueStatement.h"
21#include "src/sksl/ir/SkSLDiscardStatement.h"
22#include "src/sksl/ir/SkSLDoStatement.h"
23#include "src/sksl/ir/SkSLEnum.h"
24#include "src/sksl/ir/SkSLExpressionStatement.h"
25#include "src/sksl/ir/SkSLExternalFunctionCall.h"
Brian Osmanbe0b3b72021-01-06 14:27:35 -050026#include "src/sksl/ir/SkSLExternalFunctionReference.h"
John Stiles44e96be2020-08-31 13:16:04 -040027#include "src/sksl/ir/SkSLField.h"
28#include "src/sksl/ir/SkSLFieldAccess.h"
29#include "src/sksl/ir/SkSLFloatLiteral.h"
30#include "src/sksl/ir/SkSLForStatement.h"
31#include "src/sksl/ir/SkSLFunctionCall.h"
32#include "src/sksl/ir/SkSLFunctionDeclaration.h"
33#include "src/sksl/ir/SkSLFunctionDefinition.h"
34#include "src/sksl/ir/SkSLFunctionReference.h"
35#include "src/sksl/ir/SkSLIfStatement.h"
36#include "src/sksl/ir/SkSLIndexExpression.h"
John Stiles98c1f822020-09-09 14:18:53 -040037#include "src/sksl/ir/SkSLInlineMarker.h"
John Stiles44e96be2020-08-31 13:16:04 -040038#include "src/sksl/ir/SkSLIntLiteral.h"
39#include "src/sksl/ir/SkSLInterfaceBlock.h"
John Stiles44e96be2020-08-31 13:16:04 -040040#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>();
John Stiles06d600f2021-03-08 09:18:21 -0500348 return FieldAccess::Make(*fContext, 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>();
John Stiles51d33982021-03-08 09:18:07 -0500361 return IndexExpression::Make(*fContext, expr(idx.base()), expr(idx.index()));
John Stiles44e96be2020-08-31 13:16:04 -0400362 }
Ethan Nicholase6592142020-09-08 10:22:09 -0400363 case Expression::Kind::kPrefix: {
John Stiles44e96be2020-08-31 13:16:04 -0400364 const PrefixExpression& p = expression.as<PrefixExpression>();
John Stilesb0eb20f2021-02-26 15:29:33 -0500365 return PrefixExpression::Make(*fContext, p.getOperator(), expr(p.operand()));
John Stiles44e96be2020-08-31 13:16:04 -0400366 }
Ethan Nicholase6592142020-09-08 10:22:09 -0400367 case Expression::Kind::kPostfix: {
John Stiles44e96be2020-08-31 13:16:04 -0400368 const PostfixExpression& p = expression.as<PostfixExpression>();
John Stiles52d3b012021-02-26 15:56:48 -0500369 return PostfixExpression::Make(*fContext, expr(p.operand()), p.getOperator());
John Stiles44e96be2020-08-31 13:16:04 -0400370 }
Ethan Nicholase6592142020-09-08 10:22:09 -0400371 case Expression::Kind::kSetting:
John Stiles44e96be2020-08-31 13:16:04 -0400372 return expression.clone();
Ethan Nicholase6592142020-09-08 10:22:09 -0400373 case Expression::Kind::kSwizzle: {
John Stiles44e96be2020-08-31 13:16:04 -0400374 const Swizzle& s = expression.as<Swizzle>();
John Stiles6e88e042021-02-19 14:09:38 -0500375 return Swizzle::Make(*fContext, expr(s.base()), s.components());
John Stiles44e96be2020-08-31 13:16:04 -0400376 }
Ethan Nicholase6592142020-09-08 10:22:09 -0400377 case Expression::Kind::kTernary: {
John Stiles44e96be2020-08-31 13:16:04 -0400378 const TernaryExpression& t = expression.as<TernaryExpression>();
John Stiles90518f72021-02-26 20:44:54 -0500379 return TernaryExpression::Make(*fContext, expr(t.test()),
380 expr(t.ifTrue()), expr(t.ifFalse()));
John Stiles44e96be2020-08-31 13:16:04 -0400381 }
Brian Osman83ba9302020-09-11 13:33:46 -0400382 case Expression::Kind::kTypeReference:
383 return expression.clone();
Ethan Nicholase6592142020-09-08 10:22:09 -0400384 case Expression::Kind::kVariableReference: {
John Stiles44e96be2020-08-31 13:16:04 -0400385 const VariableReference& v = expression.as<VariableReference>();
Ethan Nicholas78686922020-10-08 06:46:27 -0400386 auto varMapIter = varMap->find(v.variable());
John Stilese41b4ee2020-09-28 12:28:16 -0400387 if (varMapIter != varMap->end()) {
Ethan Nicholas78686922020-10-08 06:46:27 -0400388 return clone_with_ref_kind(*varMapIter->second, v.refKind());
John Stiles44e96be2020-08-31 13:16:04 -0400389 }
390 return v.clone();
391 }
392 default:
393 SkASSERT(false);
394 return nullptr;
395 }
396}
397
398std::unique_ptr<Statement> Inliner::inlineStatement(int offset,
399 VariableRewriteMap* varMap,
400 SymbolTable* symbolTableForStatement,
John Stiles77702f12020-12-17 14:38:56 -0500401 std::unique_ptr<Expression>* resultExpr,
402 ReturnComplexity returnComplexity,
Brian Osman3887a012020-09-30 13:22:27 -0400403 const Statement& statement,
404 bool isBuiltinCode) {
John Stiles44e96be2020-08-31 13:16:04 -0400405 auto stmt = [&](const std::unique_ptr<Statement>& s) -> std::unique_ptr<Statement> {
406 if (s) {
John Stilesa5f3c312020-09-22 12:05:16 -0400407 return this->inlineStatement(offset, varMap, symbolTableForStatement, resultExpr,
John Stiles77702f12020-12-17 14:38:56 -0500408 returnComplexity, *s, isBuiltinCode);
John Stiles44e96be2020-08-31 13:16:04 -0400409 }
410 return nullptr;
411 };
Ethan Nicholas7bd60432020-09-25 14:31:59 -0400412 auto blockStmts = [&](const Block& block) {
John Stiles8f2a0cf2020-10-13 12:48:21 -0400413 StatementArray result;
John Stilesf4bda742020-10-14 16:57:41 -0400414 result.reserve_back(block.children().size());
Ethan Nicholas7bd60432020-09-25 14:31:59 -0400415 for (const std::unique_ptr<Statement>& child : block.children()) {
416 result.push_back(stmt(child));
417 }
418 return result;
419 };
John Stiles44e96be2020-08-31 13:16:04 -0400420 auto expr = [&](const std::unique_ptr<Expression>& e) -> std::unique_ptr<Expression> {
421 if (e) {
John Stilesd7cc0932020-11-30 12:24:27 -0500422 return this->inlineExpression(offset, varMap, symbolTableForStatement, *e);
John Stiles44e96be2020-08-31 13:16:04 -0400423 }
424 return nullptr;
425 };
John Stiles031a7672020-11-13 16:13:18 -0500426
427 ++fInlinedStatementCounter;
428
Ethan Nicholase6592142020-09-08 10:22:09 -0400429 switch (statement.kind()) {
430 case Statement::Kind::kBlock: {
John Stiles44e96be2020-08-31 13:16:04 -0400431 const Block& b = statement.as<Block>();
John Stilesbf16b6c2021-03-12 19:24:31 -0500432 return Block::Make(offset, blockStmts(b),
433 SymbolTable::WrapIfBuiltin(b.symbolTable()),
434 b.isScope());
John Stiles44e96be2020-08-31 13:16:04 -0400435 }
436
Ethan Nicholase6592142020-09-08 10:22:09 -0400437 case Statement::Kind::kBreak:
438 case Statement::Kind::kContinue:
439 case Statement::Kind::kDiscard:
John Stiles44e96be2020-08-31 13:16:04 -0400440 return statement.clone();
441
Ethan Nicholase6592142020-09-08 10:22:09 -0400442 case Statement::Kind::kDo: {
John Stiles44e96be2020-08-31 13:16:04 -0400443 const DoStatement& d = statement.as<DoStatement>();
John Stilesea5822e2021-02-26 11:18:20 -0500444 return DoStatement::Make(*fContext, stmt(d.statement()), expr(d.test()));
John Stiles44e96be2020-08-31 13:16:04 -0400445 }
Ethan Nicholase6592142020-09-08 10:22:09 -0400446 case Statement::Kind::kExpression: {
John Stiles44e96be2020-08-31 13:16:04 -0400447 const ExpressionStatement& e = statement.as<ExpressionStatement>();
John Stiles3e5871c2021-02-25 20:52:03 -0500448 return ExpressionStatement::Make(*fContext, expr(e.expression()));
John Stiles44e96be2020-08-31 13:16:04 -0400449 }
Ethan Nicholase6592142020-09-08 10:22:09 -0400450 case Statement::Kind::kFor: {
John Stiles44e96be2020-08-31 13:16:04 -0400451 const ForStatement& f = statement.as<ForStatement>();
452 // need to ensure initializer is evaluated first so that we've already remapped its
453 // declarations by the time we evaluate test & next
Ethan Nicholas0d31ed52020-10-05 14:47:09 -0400454 std::unique_ptr<Statement> initializer = stmt(f.initializer());
John Stilesb321a072021-02-25 16:24:19 -0500455 return ForStatement::Make(*fContext, offset, std::move(initializer), expr(f.test()),
456 expr(f.next()), stmt(f.statement()),
457 SymbolTable::WrapIfBuiltin(f.symbols()));
John Stiles44e96be2020-08-31 13:16:04 -0400458 }
Ethan Nicholase6592142020-09-08 10:22:09 -0400459 case Statement::Kind::kIf: {
John Stiles44e96be2020-08-31 13:16:04 -0400460 const IfStatement& i = statement.as<IfStatement>();
John Stilescf3059e2021-02-25 14:27:02 -0500461 return IfStatement::Make(*fContext, offset, i.isStatic(), expr(i.test()),
462 stmt(i.ifTrue()), stmt(i.ifFalse()));
John Stiles44e96be2020-08-31 13:16:04 -0400463 }
John Stiles98c1f822020-09-09 14:18:53 -0400464 case Statement::Kind::kInlineMarker:
Ethan Nicholase6592142020-09-08 10:22:09 -0400465 case Statement::Kind::kNop:
John Stiles44e96be2020-08-31 13:16:04 -0400466 return statement.clone();
John Stilesea5822e2021-02-26 11:18:20 -0500467
Ethan Nicholase6592142020-09-08 10:22:09 -0400468 case Statement::Kind::kReturn: {
John Stiles44e96be2020-08-31 13:16:04 -0400469 const ReturnStatement& r = statement.as<ReturnStatement>();
John Stiles77702f12020-12-17 14:38:56 -0500470 if (!r.expression()) {
471 if (returnComplexity >= ReturnComplexity::kEarlyReturns) {
472 // This function doesn't return a value, but has early returns, so we've wrapped
473 // it in a for loop. Use a continue to jump to the end of the loop and "leave"
474 // the function.
John Stilesa0c04d62021-03-11 23:07:24 -0500475 return ContinueStatement::Make(offset);
John Stiles44e96be2020-08-31 13:16:04 -0400476 } else {
John Stiles77702f12020-12-17 14:38:56 -0500477 // This function doesn't exit early or return a value. A return statement at the
478 // end is a no-op and can be treated as such.
John Stilesa0c04d62021-03-11 23:07:24 -0500479 return Nop::Make();
John Stiles44e96be2020-08-31 13:16:04 -0400480 }
481 }
John Stiles77702f12020-12-17 14:38:56 -0500482
John Stilesc5ff4862020-12-22 13:47:05 -0500483 // If a function only contains a single return, and it doesn't reference variables from
484 // inside an Block's scope, we don't need to store the result in a variable at all. Just
485 // replace the function-call expression with the function's return expression.
John Stiles77702f12020-12-17 14:38:56 -0500486 SkASSERT(resultExpr);
John Stilesc5ff4862020-12-22 13:47:05 -0500487 if (returnComplexity <= ReturnComplexity::kSingleSafeReturn) {
John Stiles77702f12020-12-17 14:38:56 -0500488 *resultExpr = expr(r.expression());
John Stilesa0c04d62021-03-11 23:07:24 -0500489 return Nop::Make();
John Stiles77702f12020-12-17 14:38:56 -0500490 }
491
492 // For more complex functions, assign their result into a variable.
John Stiles511c5002021-02-25 11:17:02 -0500493 SkASSERT(*resultExpr);
John Stiles3e5871c2021-02-25 20:52:03 -0500494 auto assignment = ExpressionStatement::Make(
495 *fContext,
John Stilese2aec432021-03-01 09:27:48 -0500496 BinaryExpression::Make(
497 *fContext,
498 clone_with_ref_kind(**resultExpr, VariableRefKind::kWrite),
John Stiles77702f12020-12-17 14:38:56 -0500499 Token::Kind::TK_EQ,
John Stilese2aec432021-03-01 09:27:48 -0500500 expr(r.expression())));
John Stiles77702f12020-12-17 14:38:56 -0500501
502 // Early returns are wrapped in a for loop; we need to synthesize a continue statement
503 // to "leave" the function.
504 if (returnComplexity >= ReturnComplexity::kEarlyReturns) {
505 StatementArray block;
506 block.reserve_back(2);
507 block.push_back(std::move(assignment));
John Stilesa0c04d62021-03-11 23:07:24 -0500508 block.push_back(ContinueStatement::Make(offset));
John Stilesbf16b6c2021-03-12 19:24:31 -0500509 return Block::Make(offset, std::move(block), /*symbols=*/nullptr, /*isScope=*/true);
John Stiles77702f12020-12-17 14:38:56 -0500510 }
511 // Functions without early returns aren't wrapped in a for loop and don't need to worry
512 // about breaking out of the control flow.
John Stiles3e5871c2021-02-25 20:52:03 -0500513 return assignment;
John Stiles44e96be2020-08-31 13:16:04 -0400514 }
Ethan Nicholase6592142020-09-08 10:22:09 -0400515 case Statement::Kind::kSwitch: {
John Stiles44e96be2020-08-31 13:16:04 -0400516 const SwitchStatement& ss = statement.as<SwitchStatement>();
John Stilesb23a64b2021-03-11 08:27:59 -0500517 StatementArray cases;
518 cases.reserve_back(ss.cases().size());
519 for (const std::unique_ptr<Statement>& statement : ss.cases()) {
520 const SwitchCase& sc = statement->as<SwitchCase>();
521 cases.push_back(std::make_unique<SwitchCase>(offset, expr(sc.value()),
522 stmt(sc.statement())));
John Stiles44e96be2020-08-31 13:16:04 -0400523 }
John Stilese1d1b082021-02-23 13:44:36 -0500524 return SwitchStatement::Make(*fContext, offset, ss.isStatic(), expr(ss.value()),
525 std::move(cases), SymbolTable::WrapIfBuiltin(ss.symbols()));
John Stiles44e96be2020-08-31 13:16:04 -0400526 }
Ethan Nicholase6592142020-09-08 10:22:09 -0400527 case Statement::Kind::kVarDeclaration: {
John Stiles44e96be2020-08-31 13:16:04 -0400528 const VarDeclaration& decl = statement.as<VarDeclaration>();
John Stiles35fee4c2020-12-16 18:25:14 +0000529 std::unique_ptr<Expression> initialValue = expr(decl.value());
John Stilesddcc8432021-01-15 15:32:32 -0500530 const Variable& variable = decl.var();
531
John Stiles35fee4c2020-12-16 18:25:14 +0000532 // We assign unique names to inlined variables--scopes hide most of the problems in this
533 // regard, but see `InlinerAvoidsVariableNameOverlap` for a counterexample where unique
534 // names are important.
John Stilesddcc8432021-01-15 15:32:32 -0500535 auto name = std::make_unique<String>(fMangler.uniqueName(variable.name(),
Ethan Nicholas6f4eee22021-01-11 12:37:42 -0500536 symbolTableForStatement));
John Stiles35fee4c2020-12-16 18:25:14 +0000537 const String* namePtr = symbolTableForStatement->takeOwnershipOfString(std::move(name));
Ethan Nicholas5b9b0db2021-01-21 13:12:01 -0500538 auto clonedVar = std::make_unique<Variable>(
539 offset,
540 &variable.modifiers(),
541 namePtr->c_str(),
542 variable.type().clone(symbolTableForStatement),
543 isBuiltinCode,
544 variable.storage());
545 (*varMap)[&variable] = std::make_unique<VariableReference>(offset, clonedVar.get());
546 auto result = std::make_unique<VarDeclaration>(clonedVar.get(),
John Stilesddcc8432021-01-15 15:32:32 -0500547 decl.baseType().clone(symbolTableForStatement),
548 decl.arraySize(),
John Stiles35fee4c2020-12-16 18:25:14 +0000549 std::move(initialValue));
Ethan Nicholas5b9b0db2021-01-21 13:12:01 -0500550 clonedVar->setDeclaration(result.get());
551 symbolTableForStatement->takeOwnershipOfSymbol(std::move(clonedVar));
552 return std::move(result);
John Stiles44e96be2020-08-31 13:16:04 -0400553 }
John Stiles44e96be2020-08-31 13:16:04 -0400554 default:
555 SkASSERT(false);
556 return nullptr;
557 }
558}
559
John Stiles7b920442020-12-17 10:43:41 -0500560Inliner::InlineVariable Inliner::makeInlineVariable(const String& baseName,
561 const Type* type,
562 SymbolTable* symbolTable,
563 Modifiers modifiers,
564 bool isBuiltinCode,
565 std::unique_ptr<Expression>* initialValue) {
566 // $floatLiteral or $intLiteral aren't real types that we can use for scratch variables, so
567 // replace them if they ever appear here. If this happens, we likely forgot to coerce a type
568 // somewhere during compilation.
John Stiles14975272021-01-12 11:41:14 -0500569 if (type->isLiteral()) {
570 SkDEBUGFAIL("found a $literal type while inlining");
571 type = &type->scalarTypeForLiteral();
John Stiles7b920442020-12-17 10:43:41 -0500572 }
573
574 // Provide our new variable with a unique name, and add it to our symbol table.
575 const String* namePtr = symbolTable->takeOwnershipOfString(
Ethan Nicholas6f4eee22021-01-11 12:37:42 -0500576 std::make_unique<String>(fMangler.uniqueName(baseName, symbolTable)));
John Stiles7b920442020-12-17 10:43:41 -0500577 StringFragment nameFrag{namePtr->c_str(), namePtr->length()};
578
579 // Create our new variable and add it to the symbol table.
580 InlineVariable result;
Ethan Nicholas5b9b0db2021-01-21 13:12:01 -0500581 auto var = std::make_unique<Variable>(/*offset=*/-1,
582 fModifiers->addToPool(Modifiers()),
583 nameFrag,
584 type,
585 isBuiltinCode,
586 Variable::Storage::kLocal);
John Stiles7b920442020-12-17 10:43:41 -0500587
588 // Prepare the variable declaration (taking extra care with `out` params to not clobber any
589 // initial value).
590 if (*initialValue && (modifiers.fFlags & Modifiers::kOut_Flag)) {
Ethan Nicholas5b9b0db2021-01-21 13:12:01 -0500591 result.fVarDecl = std::make_unique<VarDeclaration>(var.get(), type, /*arraySize=*/0,
John Stiles7b920442020-12-17 10:43:41 -0500592 (*initialValue)->clone());
593 } else {
Ethan Nicholas5b9b0db2021-01-21 13:12:01 -0500594 result.fVarDecl = std::make_unique<VarDeclaration>(var.get(), type, /*arraySize=*/0,
John Stiles7b920442020-12-17 10:43:41 -0500595 std::move(*initialValue));
596 }
Ethan Nicholas5b9b0db2021-01-21 13:12:01 -0500597 var->setDeclaration(&result.fVarDecl->as<VarDeclaration>());
598 result.fVarSymbol = symbolTable->add(std::move(var));
John Stiles7b920442020-12-17 10:43:41 -0500599 return result;
600}
601
John Stiles6eadf132020-09-08 10:16:10 -0400602Inliner::InlinedCall Inliner::inlineCall(FunctionCall* call,
John Stiles78047582020-12-16 16:17:41 -0500603 std::shared_ptr<SymbolTable> symbolTable,
Brian Osman3887a012020-09-30 13:22:27 -0400604 const FunctionDeclaration* caller) {
John Stiles44e96be2020-08-31 13:16:04 -0400605 // Inlining is more complicated here than in a typical compiler, because we have to have a
606 // high-level IR and can't just drop statements into the middle of an expression or even use
607 // gotos.
608 //
609 // Since we can't insert statements into an expression, we run the inline function as extra
610 // statements before the statement we're currently processing, relying on a lack of execution
611 // order guarantees. Since we can't use gotos (which are normally used to replace return
612 // statements), we wrap the whole function in a loop and use break statements to jump to the
613 // end.
John Stiles44e96be2020-08-31 13:16:04 -0400614 SkASSERT(fContext);
615 SkASSERT(call);
Ethan Nicholased84b732020-10-08 11:45:44 -0400616 SkASSERT(this->isSafeToInline(call->function().definition()));
John Stiles44e96be2020-08-31 13:16:04 -0400617
John Stiles8e3b6be2020-10-13 11:14:08 -0400618 ExpressionArray& arguments = call->arguments();
John Stiles6eadf132020-09-08 10:16:10 -0400619 const int offset = call->fOffset;
Ethan Nicholased84b732020-10-08 11:45:44 -0400620 const FunctionDefinition& function = *call->function().definition();
John Stiles77702f12020-12-17 14:38:56 -0500621 const ReturnComplexity returnComplexity = GetReturnComplexity(function);
622 bool hasEarlyReturn = (returnComplexity >= ReturnComplexity::kEarlyReturns);
John Stiles6eadf132020-09-08 10:16:10 -0400623
John Stiles44e96be2020-08-31 13:16:04 -0400624 InlinedCall inlinedCall;
John Stilesbf16b6c2021-03-12 19:24:31 -0500625 StatementArray inlinedBlockStmts;
626 inlinedBlockStmts.reserve_back(1 + // Inline marker
627 1 + // Result variable
628 arguments.size() + // Function arguments (passing in)
629 arguments.size() + // Function arguments (copy out-params back)
630 1); // Block for inlined code
John Stiles98c1f822020-09-09 14:18:53 -0400631
John Stilesbf16b6c2021-03-12 19:24:31 -0500632 inlinedBlockStmts.push_back(InlineMarker::Make(&call->function()));
John Stiles44e96be2020-08-31 13:16:04 -0400633
John Stilese41b4ee2020-09-28 12:28:16 -0400634 std::unique_ptr<Expression> resultExpr;
John Stiles511c5002021-02-25 11:17:02 -0500635 if (returnComplexity > ReturnComplexity::kSingleSafeReturn &&
636 function.declaration().returnType() != *fContext->fTypes.fVoid) {
637 // Create a variable to hold the result in the extra statements. We don't need to do this
638 // for void-return functions, or in cases that are simple enough that we can just replace
639 // the function-call node with the result expression.
John Stiles44e96be2020-08-31 13:16:04 -0400640 std::unique_ptr<Expression> noInitialValue;
John Stiles7b920442020-12-17 10:43:41 -0500641 InlineVariable var = this->makeInlineVariable(function.declaration().name(),
642 &function.declaration().returnType(),
643 symbolTable.get(), Modifiers{},
644 caller->isBuiltin(), &noInitialValue);
John Stilesbf16b6c2021-03-12 19:24:31 -0500645 inlinedBlockStmts.push_back(std::move(var.fVarDecl));
John Stiles7b920442020-12-17 10:43:41 -0500646 resultExpr = std::make_unique<VariableReference>(/*offset=*/-1, var.fVarSymbol);
John Stiles511c5002021-02-25 11:17:02 -0500647 }
John Stiles44e96be2020-08-31 13:16:04 -0400648
649 // Create variables in the extra statements to hold the arguments, and assign the arguments to
650 // them.
651 VariableRewriteMap varMap;
John Stilese41b4ee2020-09-28 12:28:16 -0400652 std::vector<int> argsToCopyBack;
John Stiles44e96be2020-08-31 13:16:04 -0400653 for (int i = 0; i < (int) arguments.size(); ++i) {
Ethan Nicholas0a5d0962020-10-14 13:33:18 -0400654 const Variable* param = function.declaration().parameters()[i];
Ethan Nicholas041fd0a2020-10-07 16:42:04 -0400655 bool isOutParam = param->modifiers().fFlags & Modifiers::kOut_Flag;
John Stiles44e96be2020-08-31 13:16:04 -0400656
John Stiles44733aa2020-09-29 17:42:23 -0400657 // If this argument can be inlined trivially (e.g. a swizzle, or a constant array index)...
John Stilesc30fbca2020-11-19 16:25:49 -0500658 if (Analysis::IsTrivialExpression(*arguments[i])) {
John Stilese41b4ee2020-09-28 12:28:16 -0400659 // ... and it's an `out` param, or it isn't written to within the inline function...
Ethan Nicholas0a5d0962020-10-14 13:33:18 -0400660 if (isOutParam || !Analysis::StatementWritesToVariable(*function.body(), *param)) {
John Stilesf201af82020-09-29 16:57:55 -0400661 // ... we don't need to copy it at all! We can just use the existing expression.
662 varMap[param] = arguments[i]->clone();
John Stiles44e96be2020-08-31 13:16:04 -0400663 continue;
664 }
665 }
John Stilese41b4ee2020-09-28 12:28:16 -0400666 if (isOutParam) {
667 argsToCopyBack.push_back(i);
668 }
John Stiles7b920442020-12-17 10:43:41 -0500669 InlineVariable var = this->makeInlineVariable(param->name(), &arguments[i]->type(),
670 symbolTable.get(), param->modifiers(),
671 caller->isBuiltin(), &arguments[i]);
John Stilesbf16b6c2021-03-12 19:24:31 -0500672 inlinedBlockStmts.push_back(std::move(var.fVarDecl));
John Stiles7b920442020-12-17 10:43:41 -0500673 varMap[param] = std::make_unique<VariableReference>(/*offset=*/-1, var.fVarSymbol);
John Stiles44e96be2020-08-31 13:16:04 -0400674 }
675
Ethan Nicholas0a5d0962020-10-14 13:33:18 -0400676 const Block& body = function.body()->as<Block>();
John Stiles7b920442020-12-17 10:43:41 -0500677 StatementArray* inlineStatements;
678
John Stiles44e96be2020-08-31 13:16:04 -0400679 if (hasEarlyReturn) {
680 // Since we output to backends that don't have a goto statement (which would normally be
John Stiles7b920442020-12-17 10:43:41 -0500681 // used to perform an early return), we fake it by wrapping the function in a single-
682 // iteration for loop, and use a continue statement to jump to the end of the loop
683 // prematurely.
684
685 // int _1_loop = 0;
686 symbolTable = std::make_shared<SymbolTable>(std::move(symbolTable), caller->isBuiltin());
John Stiles54e7c052021-01-11 14:22:36 -0500687 const Type* intType = fContext->fTypes.fInt.get();
John Stiles9ce80f72021-03-11 22:35:19 -0500688 std::unique_ptr<Expression> initialValue = IntLiteral::Make(/*offset=*/-1,
689 /*value=*/0,
690 intType);
John Stiles7b920442020-12-17 10:43:41 -0500691 InlineVariable loopVar = this->makeInlineVariable("loop", intType, symbolTable.get(),
692 Modifiers{}, caller->isBuiltin(),
693 &initialValue);
694
695 // _1_loop < 1;
John Stilese2aec432021-03-01 09:27:48 -0500696 std::unique_ptr<Expression> test = BinaryExpression::Make(
697 *fContext,
John Stiles7b920442020-12-17 10:43:41 -0500698 std::make_unique<VariableReference>(/*offset=*/-1, loopVar.fVarSymbol),
699 Token::Kind::TK_LT,
John Stiles9ce80f72021-03-11 22:35:19 -0500700 IntLiteral::Make(/*offset=*/-1, /*value=*/1, intType));
John Stiles7b920442020-12-17 10:43:41 -0500701
702 // _1_loop++
John Stiles52d3b012021-02-26 15:56:48 -0500703 std::unique_ptr<Expression> increment = PostfixExpression::Make(
704 *fContext,
John Stiles7b920442020-12-17 10:43:41 -0500705 std::make_unique<VariableReference>(/*offset=*/-1, loopVar.fVarSymbol,
706 VariableReference::RefKind::kReadWrite),
707 Token::Kind::TK_PLUSPLUS);
708
709 // {...}
John Stilesbf16b6c2021-03-12 19:24:31 -0500710 auto innerBlock = Block::Make(offset, StatementArray{},
711 /*symbols=*/nullptr, /*isScope=*/true);
John Stiles7b920442020-12-17 10:43:41 -0500712 inlineStatements = &innerBlock->children();
713
714 // for (int _1_loop = 0; _1_loop < 1; _1_loop++) {...}
John Stilesbf16b6c2021-03-12 19:24:31 -0500715 inlinedBlockStmts.push_back(ForStatement::Make(*fContext, /*offset=*/-1,
716 std::move(loopVar.fVarDecl),
717 std::move(test),
718 std::move(increment),
719 std::move(innerBlock),
720 symbolTable));
John Stiles44e96be2020-08-31 13:16:04 -0400721 } else {
John Stilesfa9a0832020-12-17 10:43:58 -0500722 // No early returns, so we can just dump the code into our existing scopeless block.
John Stilesbf16b6c2021-03-12 19:24:31 -0500723 inlineStatements = &inlinedBlockStmts;
John Stiles7b920442020-12-17 10:43:41 -0500724 }
725
726 inlineStatements->reserve_back(body.children().size() + argsToCopyBack.size());
727 for (const std::unique_ptr<Statement>& stmt : body.children()) {
728 inlineStatements->push_back(this->inlineStatement(offset, &varMap, symbolTable.get(),
John Stiles77702f12020-12-17 14:38:56 -0500729 &resultExpr, returnComplexity, *stmt,
John Stiles7b920442020-12-17 10:43:41 -0500730 caller->isBuiltin()));
John Stiles44e96be2020-08-31 13:16:04 -0400731 }
732
John Stilese41b4ee2020-09-28 12:28:16 -0400733 // Copy back the values of `out` parameters into their real destinations.
734 for (int i : argsToCopyBack) {
Ethan Nicholas0a5d0962020-10-14 13:33:18 -0400735 const Variable* p = function.declaration().parameters()[i];
John Stilese41b4ee2020-09-28 12:28:16 -0400736 SkASSERT(varMap.find(p) != varMap.end());
John Stiles3e5871c2021-02-25 20:52:03 -0500737 inlineStatements->push_back(ExpressionStatement::Make(
738 *fContext,
John Stilese2aec432021-03-01 09:27:48 -0500739 BinaryExpression::Make(*fContext,
740 clone_with_ref_kind(*arguments[i], VariableRefKind::kWrite),
741 Token::Kind::TK_EQ,
742 std::move(varMap[p]))));
John Stiles44e96be2020-08-31 13:16:04 -0400743 }
744
John Stilesbf16b6c2021-03-12 19:24:31 -0500745 // Wrap all of the generated statements in a block. We need a real Block here, so we can't use
746 // MakeUnscoped. This is because we need to add another child statement to the Block later.
747 inlinedCall.fInlinedBody = Block::Make(offset, std::move(inlinedBlockStmts),
748 /*symbols=*/nullptr, /*isScope=*/false);
749
John Stiles0c2d14a2021-03-01 10:08:08 -0500750 if (resultExpr) {
751 // Return our result expression as-is.
John Stilese41b4ee2020-09-28 12:28:16 -0400752 inlinedCall.fReplacementExpr = std::move(resultExpr);
John Stiles0c2d14a2021-03-01 10:08:08 -0500753 } else if (function.declaration().returnType() == *fContext->fTypes.fVoid) {
John Stiles44e96be2020-08-31 13:16:04 -0400754 // It's a void function, so it doesn't actually result in anything, but we have to return
755 // something non-null as a standin.
John Stiles9ce80f72021-03-11 22:35:19 -0500756 inlinedCall.fReplacementExpr = BoolLiteral::Make(*fContext, offset, /*value=*/false);
John Stiles0c2d14a2021-03-01 10:08:08 -0500757 } else {
758 // It's a non-void function, but it never created a result expression--that is, it never
John Stiles2dda50d2021-03-03 10:46:44 -0500759 // returned anything on any path! This should have been detected in the function finalizer.
760 // Still, discard our output and generate an error.
761 SkDEBUGFAIL("inliner found non-void function that fails to return a value on any path");
762 fContext->fErrors.error(function.fOffset, "inliner found non-void function '" +
John Stiles0c2d14a2021-03-01 10:08:08 -0500763 function.declaration().name() +
John Stiles2dda50d2021-03-03 10:46:44 -0500764 "' that fails to return a value on any path");
John Stiles0c2d14a2021-03-01 10:08:08 -0500765 inlinedCall = {};
John Stiles44e96be2020-08-31 13:16:04 -0400766 }
767
John Stiles44e96be2020-08-31 13:16:04 -0400768 return inlinedCall;
769}
770
John Stiles2d7973a2020-10-02 15:01:03 -0400771bool Inliner::isSafeToInline(const FunctionDefinition* functionDef) {
John Stiles1c03d332020-10-13 10:30:23 -0400772 // A threshold of zero indicates that the inliner is completely disabled, so we can just return.
John Stilesd1204642021-02-17 16:30:02 -0500773 if (this->settings().fInlineThreshold <= 0) {
John Stiles1c03d332020-10-13 10:30:23 -0400774 return false;
775 }
776
John Stiles031a7672020-11-13 16:13:18 -0500777 // Enforce a limit on inlining to avoid pathological cases. (inliner/ExponentialGrowth.sksl)
778 if (fInlinedStatementCounter >= kInlinedStatementLimit) {
779 return false;
780 }
781
John Stiles2d7973a2020-10-02 15:01:03 -0400782 if (functionDef == nullptr) {
John Stiles44e96be2020-08-31 13:16:04 -0400783 // Can't inline something if we don't actually have its definition.
784 return false;
785 }
John Stiles2d7973a2020-10-02 15:01:03 -0400786
John Stiles0dd1a772021-03-09 22:14:27 -0500787 if (functionDef->declaration().modifiers().fFlags & Modifiers::kNoInline_Flag) {
788 // Refuse to inline functions decorated with `noinline`.
789 return false;
790 }
791
John Stiles74ebd7e2020-12-17 14:41:50 -0500792 // We don't have any mechanism to simulate early returns within a construct that supports
793 // continues (for/do/while), so we can't inline if there's a return inside one.
794 bool hasReturnInContinuableConstruct =
795 (count_returns_in_continuable_constructs(*functionDef) > 0);
796 return !hasReturnInContinuableConstruct;
John Stiles44e96be2020-08-31 13:16:04 -0400797}
798
John Stiles2d7973a2020-10-02 15:01:03 -0400799// A candidate function for inlining, containing everything that `inlineCall` needs.
800struct InlineCandidate {
John Stiles78047582020-12-16 16:17:41 -0500801 std::shared_ptr<SymbolTable> fSymbols; // the SymbolTable of the candidate
John Stiles2d7973a2020-10-02 15:01:03 -0400802 std::unique_ptr<Statement>* fParentStmt; // the parent Statement of the enclosing stmt
803 std::unique_ptr<Statement>* fEnclosingStmt; // the Statement containing the candidate
804 std::unique_ptr<Expression>* fCandidateExpr; // the candidate FunctionCall to be inlined
805 FunctionDefinition* fEnclosingFunction; // the Function containing the candidate
John Stiles2d7973a2020-10-02 15:01:03 -0400806};
John Stiles93442622020-09-11 12:11:27 -0400807
John Stiles2d7973a2020-10-02 15:01:03 -0400808struct InlineCandidateList {
809 std::vector<InlineCandidate> fCandidates;
810};
811
812class InlineCandidateAnalyzer {
John Stiles70957c82020-10-02 16:42:10 -0400813public:
814 // A list of all the inlining candidates we found during analysis.
815 InlineCandidateList* fCandidateList;
John Stiles2d7973a2020-10-02 15:01:03 -0400816
John Stiles70957c82020-10-02 16:42:10 -0400817 // A stack of the symbol tables; since most nodes don't have one, expected to be shallower than
818 // the enclosing-statement stack.
John Stiles78047582020-12-16 16:17:41 -0500819 std::vector<std::shared_ptr<SymbolTable>> fSymbolTableStack;
John Stiles70957c82020-10-02 16:42:10 -0400820 // A stack of "enclosing" statements--these would be suitable for the inliner to use for adding
821 // new instructions. Not all statements are suitable (e.g. a for-loop's initializer). The
822 // inliner might replace a statement with a block containing the statement.
823 std::vector<std::unique_ptr<Statement>*> fEnclosingStmtStack;
824 // The function that we're currently processing (i.e. inlining into).
825 FunctionDefinition* fEnclosingFunction = nullptr;
John Stiles93442622020-09-11 12:11:27 -0400826
Brian Osman0006ad02020-11-18 15:38:39 -0500827 void visit(const std::vector<std::unique_ptr<ProgramElement>>& elements,
John Stiles78047582020-12-16 16:17:41 -0500828 std::shared_ptr<SymbolTable> symbols,
Brian Osman0006ad02020-11-18 15:38:39 -0500829 InlineCandidateList* candidateList) {
John Stiles70957c82020-10-02 16:42:10 -0400830 fCandidateList = candidateList;
Brian Osman0006ad02020-11-18 15:38:39 -0500831 fSymbolTableStack.push_back(symbols);
John Stiles93442622020-09-11 12:11:27 -0400832
Brian Osman0006ad02020-11-18 15:38:39 -0500833 for (const std::unique_ptr<ProgramElement>& pe : elements) {
Brian Osman1179fcf2020-10-08 16:04:40 -0400834 this->visitProgramElement(pe.get());
John Stiles93442622020-09-11 12:11:27 -0400835 }
836
John Stiles70957c82020-10-02 16:42:10 -0400837 fSymbolTableStack.pop_back();
838 fCandidateList = nullptr;
839 }
840
841 void visitProgramElement(ProgramElement* pe) {
842 switch (pe->kind()) {
843 case ProgramElement::Kind::kFunction: {
844 FunctionDefinition& funcDef = pe->as<FunctionDefinition>();
Brian Osman0006ad02020-11-18 15:38:39 -0500845 fEnclosingFunction = &funcDef;
846 this->visitStatement(&funcDef.body());
John Stiles70957c82020-10-02 16:42:10 -0400847 break;
John Stiles93442622020-09-11 12:11:27 -0400848 }
John Stiles70957c82020-10-02 16:42:10 -0400849 default:
850 // The inliner can't operate outside of a function's scope.
851 break;
852 }
853 }
854
855 void visitStatement(std::unique_ptr<Statement>* stmt,
856 bool isViableAsEnclosingStatement = true) {
857 if (!*stmt) {
858 return;
John Stiles93442622020-09-11 12:11:27 -0400859 }
860
John Stiles70957c82020-10-02 16:42:10 -0400861 size_t oldEnclosingStmtStackSize = fEnclosingStmtStack.size();
862 size_t oldSymbolStackSize = fSymbolTableStack.size();
John Stiles93442622020-09-11 12:11:27 -0400863
John Stiles70957c82020-10-02 16:42:10 -0400864 if (isViableAsEnclosingStatement) {
865 fEnclosingStmtStack.push_back(stmt);
John Stiles93442622020-09-11 12:11:27 -0400866 }
867
John Stiles70957c82020-10-02 16:42:10 -0400868 switch ((*stmt)->kind()) {
869 case Statement::Kind::kBreak:
870 case Statement::Kind::kContinue:
871 case Statement::Kind::kDiscard:
872 case Statement::Kind::kInlineMarker:
873 case Statement::Kind::kNop:
874 break;
875
876 case Statement::Kind::kBlock: {
877 Block& block = (*stmt)->as<Block>();
878 if (block.symbolTable()) {
John Stiles78047582020-12-16 16:17:41 -0500879 fSymbolTableStack.push_back(block.symbolTable());
John Stiles70957c82020-10-02 16:42:10 -0400880 }
881
882 for (std::unique_ptr<Statement>& stmt : block.children()) {
883 this->visitStatement(&stmt);
884 }
885 break;
John Stiles93442622020-09-11 12:11:27 -0400886 }
John Stiles70957c82020-10-02 16:42:10 -0400887 case Statement::Kind::kDo: {
888 DoStatement& doStmt = (*stmt)->as<DoStatement>();
889 // The loop body is a candidate for inlining.
890 this->visitStatement(&doStmt.statement());
891 // The inliner isn't smart enough to inline the test-expression for a do-while
892 // loop at this time. There are two limitations:
893 // - We would need to insert the inlined-body block at the very end of the do-
894 // statement's inner fStatement. We don't support that today, but it's doable.
895 // - We cannot inline the test expression if the loop uses `continue` anywhere; that
896 // would skip over the inlined block that evaluates the test expression. There
897 // isn't a good fix for this--any workaround would be more complex than the cost
898 // of a function call. However, loops that don't use `continue` would still be
899 // viable candidates for inlining.
900 break;
John Stiles93442622020-09-11 12:11:27 -0400901 }
John Stiles70957c82020-10-02 16:42:10 -0400902 case Statement::Kind::kExpression: {
903 ExpressionStatement& expr = (*stmt)->as<ExpressionStatement>();
904 this->visitExpression(&expr.expression());
905 break;
906 }
907 case Statement::Kind::kFor: {
908 ForStatement& forStmt = (*stmt)->as<ForStatement>();
Ethan Nicholas0d31ed52020-10-05 14:47:09 -0400909 if (forStmt.symbols()) {
John Stiles78047582020-12-16 16:17:41 -0500910 fSymbolTableStack.push_back(forStmt.symbols());
John Stiles70957c82020-10-02 16:42:10 -0400911 }
912
913 // The initializer and loop body are candidates for inlining.
Ethan Nicholas0d31ed52020-10-05 14:47:09 -0400914 this->visitStatement(&forStmt.initializer(),
John Stiles70957c82020-10-02 16:42:10 -0400915 /*isViableAsEnclosingStatement=*/false);
Ethan Nicholas0d31ed52020-10-05 14:47:09 -0400916 this->visitStatement(&forStmt.statement());
John Stiles70957c82020-10-02 16:42:10 -0400917
918 // The inliner isn't smart enough to inline the test- or increment-expressions
919 // of a for loop loop at this time. There are a handful of limitations:
920 // - We would need to insert the test-expression block at the very beginning of the
921 // for-loop's inner fStatement, and the increment-expression block at the very
922 // end. We don't support that today, but it's doable.
923 // - The for-loop's built-in test-expression would need to be dropped entirely,
924 // and the loop would be halted via a break statement at the end of the inlined
925 // test-expression. This is again something we don't support today, but it could
926 // be implemented.
927 // - We cannot inline the increment-expression if the loop uses `continue` anywhere;
928 // that would skip over the inlined block that evaluates the increment expression.
929 // There isn't a good fix for this--any workaround would be more complex than the
930 // cost of a function call. However, loops that don't use `continue` would still
931 // be viable candidates for increment-expression inlining.
932 break;
933 }
934 case Statement::Kind::kIf: {
935 IfStatement& ifStmt = (*stmt)->as<IfStatement>();
Ethan Nicholas8c44eca2020-10-07 16:47:09 -0400936 this->visitExpression(&ifStmt.test());
937 this->visitStatement(&ifStmt.ifTrue());
938 this->visitStatement(&ifStmt.ifFalse());
John Stiles70957c82020-10-02 16:42:10 -0400939 break;
940 }
941 case Statement::Kind::kReturn: {
942 ReturnStatement& returnStmt = (*stmt)->as<ReturnStatement>();
Ethan Nicholas2a4952d2020-10-08 15:35:56 -0400943 this->visitExpression(&returnStmt.expression());
John Stiles70957c82020-10-02 16:42:10 -0400944 break;
945 }
946 case Statement::Kind::kSwitch: {
947 SwitchStatement& switchStmt = (*stmt)->as<SwitchStatement>();
Ethan Nicholas01b05e52020-10-22 15:53:41 -0400948 if (switchStmt.symbols()) {
John Stiles78047582020-12-16 16:17:41 -0500949 fSymbolTableStack.push_back(switchStmt.symbols());
John Stiles70957c82020-10-02 16:42:10 -0400950 }
951
Ethan Nicholas01b05e52020-10-22 15:53:41 -0400952 this->visitExpression(&switchStmt.value());
John Stilesb23a64b2021-03-11 08:27:59 -0500953 for (const std::unique_ptr<Statement>& switchCase : switchStmt.cases()) {
John Stiles70957c82020-10-02 16:42:10 -0400954 // The switch-case's fValue cannot be a FunctionCall; skip it.
John Stilesb23a64b2021-03-11 08:27:59 -0500955 this->visitStatement(&switchCase->as<SwitchCase>().statement());
John Stiles70957c82020-10-02 16:42:10 -0400956 }
957 break;
958 }
959 case Statement::Kind::kVarDeclaration: {
960 VarDeclaration& varDeclStmt = (*stmt)->as<VarDeclaration>();
961 // Don't need to scan the declaration's sizes; those are always IntLiterals.
Ethan Nicholasc51f33e2020-10-13 13:49:44 -0400962 this->visitExpression(&varDeclStmt.value());
John Stiles70957c82020-10-02 16:42:10 -0400963 break;
964 }
John Stiles70957c82020-10-02 16:42:10 -0400965 default:
966 SkUNREACHABLE;
John Stiles93442622020-09-11 12:11:27 -0400967 }
968
John Stiles70957c82020-10-02 16:42:10 -0400969 // Pop our symbol and enclosing-statement stacks.
970 fSymbolTableStack.resize(oldSymbolStackSize);
971 fEnclosingStmtStack.resize(oldEnclosingStmtStackSize);
972 }
973
974 void visitExpression(std::unique_ptr<Expression>* expr) {
975 if (!*expr) {
976 return;
John Stiles93442622020-09-11 12:11:27 -0400977 }
John Stiles70957c82020-10-02 16:42:10 -0400978
979 switch ((*expr)->kind()) {
980 case Expression::Kind::kBoolLiteral:
981 case Expression::Kind::kDefined:
Brian Osmanbe0b3b72021-01-06 14:27:35 -0500982 case Expression::Kind::kExternalFunctionReference:
John Stiles70957c82020-10-02 16:42:10 -0400983 case Expression::Kind::kFieldAccess:
984 case Expression::Kind::kFloatLiteral:
985 case Expression::Kind::kFunctionReference:
986 case Expression::Kind::kIntLiteral:
John Stiles70957c82020-10-02 16:42:10 -0400987 case Expression::Kind::kSetting:
988 case Expression::Kind::kTypeReference:
989 case Expression::Kind::kVariableReference:
990 // Nothing to scan here.
991 break;
992
993 case Expression::Kind::kBinary: {
994 BinaryExpression& binaryExpr = (*expr)->as<BinaryExpression>();
John Stiles2d4f9592020-10-30 10:29:12 -0400995 this->visitExpression(&binaryExpr.left());
John Stiles70957c82020-10-02 16:42:10 -0400996
997 // Logical-and and logical-or binary expressions do not inline the right side,
998 // because that would invalidate short-circuiting. That is, when evaluating
999 // expressions like these:
1000 // (false && x()) // always false
1001 // (true || y()) // always true
1002 // It is illegal for side-effects from x() or y() to occur. The simplest way to
1003 // enforce that rule is to avoid inlining the right side entirely. However, it is
1004 // safe for other types of binary expression to inline both sides.
John Stiles45990502021-02-16 10:55:27 -05001005 Operator op = binaryExpr.getOperator();
1006 bool shortCircuitable = (op.kind() == Token::Kind::TK_LOGICALAND ||
1007 op.kind() == Token::Kind::TK_LOGICALOR);
John Stiles70957c82020-10-02 16:42:10 -04001008 if (!shortCircuitable) {
John Stiles2d4f9592020-10-30 10:29:12 -04001009 this->visitExpression(&binaryExpr.right());
John Stiles70957c82020-10-02 16:42:10 -04001010 }
1011 break;
1012 }
1013 case Expression::Kind::kConstructor: {
1014 Constructor& constructorExpr = (*expr)->as<Constructor>();
1015 for (std::unique_ptr<Expression>& arg : constructorExpr.arguments()) {
1016 this->visitExpression(&arg);
1017 }
1018 break;
1019 }
1020 case Expression::Kind::kExternalFunctionCall: {
1021 ExternalFunctionCall& funcCallExpr = (*expr)->as<ExternalFunctionCall>();
1022 for (std::unique_ptr<Expression>& arg : funcCallExpr.arguments()) {
1023 this->visitExpression(&arg);
1024 }
1025 break;
1026 }
1027 case Expression::Kind::kFunctionCall: {
1028 FunctionCall& funcCallExpr = (*expr)->as<FunctionCall>();
Ethan Nicholas0dec9922020-10-05 15:51:52 -04001029 for (std::unique_ptr<Expression>& arg : funcCallExpr.arguments()) {
John Stiles70957c82020-10-02 16:42:10 -04001030 this->visitExpression(&arg);
1031 }
1032 this->addInlineCandidate(expr);
1033 break;
1034 }
1035 case Expression::Kind::kIndex:{
1036 IndexExpression& indexExpr = (*expr)->as<IndexExpression>();
Ethan Nicholas2a4952d2020-10-08 15:35:56 -04001037 this->visitExpression(&indexExpr.base());
1038 this->visitExpression(&indexExpr.index());
John Stiles70957c82020-10-02 16:42:10 -04001039 break;
1040 }
1041 case Expression::Kind::kPostfix: {
1042 PostfixExpression& postfixExpr = (*expr)->as<PostfixExpression>();
Ethan Nicholas444ccc62020-10-09 10:16:22 -04001043 this->visitExpression(&postfixExpr.operand());
John Stiles70957c82020-10-02 16:42:10 -04001044 break;
1045 }
1046 case Expression::Kind::kPrefix: {
1047 PrefixExpression& prefixExpr = (*expr)->as<PrefixExpression>();
Ethan Nicholas444ccc62020-10-09 10:16:22 -04001048 this->visitExpression(&prefixExpr.operand());
John Stiles70957c82020-10-02 16:42:10 -04001049 break;
1050 }
1051 case Expression::Kind::kSwizzle: {
1052 Swizzle& swizzleExpr = (*expr)->as<Swizzle>();
Ethan Nicholas6b4d5812020-10-12 16:11:51 -04001053 this->visitExpression(&swizzleExpr.base());
John Stiles70957c82020-10-02 16:42:10 -04001054 break;
1055 }
1056 case Expression::Kind::kTernary: {
1057 TernaryExpression& ternaryExpr = (*expr)->as<TernaryExpression>();
1058 // The test expression is a candidate for inlining.
Ethan Nicholasdd218162020-10-08 05:48:01 -04001059 this->visitExpression(&ternaryExpr.test());
John Stiles70957c82020-10-02 16:42:10 -04001060 // The true- and false-expressions cannot be inlined, because we are only allowed to
1061 // evaluate one side.
1062 break;
1063 }
1064 default:
1065 SkUNREACHABLE;
1066 }
1067 }
1068
1069 void addInlineCandidate(std::unique_ptr<Expression>* candidate) {
1070 fCandidateList->fCandidates.push_back(
1071 InlineCandidate{fSymbolTableStack.back(),
1072 find_parent_statement(fEnclosingStmtStack),
1073 fEnclosingStmtStack.back(),
1074 candidate,
John Stiles9b9415e2020-11-23 14:48:06 -05001075 fEnclosingFunction});
John Stiles70957c82020-10-02 16:42:10 -04001076 }
John Stiles2d7973a2020-10-02 15:01:03 -04001077};
John Stiles93442622020-09-11 12:11:27 -04001078
John Stiles9b9415e2020-11-23 14:48:06 -05001079static const FunctionDeclaration& candidate_func(const InlineCandidate& candidate) {
1080 return (*candidate.fCandidateExpr)->as<FunctionCall>().function();
1081}
John Stiles915a38c2020-09-14 09:38:13 -04001082
John Stiles9b9415e2020-11-23 14:48:06 -05001083bool Inliner::candidateCanBeInlined(const InlineCandidate& candidate, InlinabilityCache* cache) {
1084 const FunctionDeclaration& funcDecl = candidate_func(candidate);
John Stiles1c03d332020-10-13 10:30:23 -04001085 auto [iter, wasInserted] = cache->insert({&funcDecl, false});
John Stiles2d7973a2020-10-02 15:01:03 -04001086 if (wasInserted) {
1087 // Recursion is forbidden here to avoid an infinite death spiral of inlining.
John Stiles1c03d332020-10-13 10:30:23 -04001088 iter->second = this->isSafeToInline(funcDecl.definition()) &&
1089 !contains_recursive_call(funcDecl);
John Stiles93442622020-09-11 12:11:27 -04001090 }
1091
John Stiles2d7973a2020-10-02 15:01:03 -04001092 return iter->second;
1093}
1094
John Stiles9b9415e2020-11-23 14:48:06 -05001095int Inliner::getFunctionSize(const FunctionDeclaration& funcDecl, FunctionSizeCache* cache) {
1096 auto [iter, wasInserted] = cache->insert({&funcDecl, 0});
John Stiles2d7973a2020-10-02 15:01:03 -04001097 if (wasInserted) {
John Stiles9b9415e2020-11-23 14:48:06 -05001098 iter->second = Analysis::NodeCountUpToLimit(*funcDecl.definition(),
John Stilesd1204642021-02-17 16:30:02 -05001099 this->settings().fInlineThreshold);
John Stiles2d7973a2020-10-02 15:01:03 -04001100 }
John Stiles2d7973a2020-10-02 15:01:03 -04001101 return iter->second;
1102}
1103
Brian Osman0006ad02020-11-18 15:38:39 -05001104void Inliner::buildCandidateList(const std::vector<std::unique_ptr<ProgramElement>>& elements,
John Stiles78047582020-12-16 16:17:41 -05001105 std::shared_ptr<SymbolTable> symbols, ProgramUsage* usage,
Brian Osman0006ad02020-11-18 15:38:39 -05001106 InlineCandidateList* candidateList) {
John Stiles2d7973a2020-10-02 15:01:03 -04001107 // This is structured much like a ProgramVisitor, but does not actually use ProgramVisitor.
1108 // The analyzer needs to keep track of the `unique_ptr<T>*` of statements and expressions so
1109 // that they can later be replaced, and ProgramVisitor does not provide this; it only provides a
1110 // `const T&`.
1111 InlineCandidateAnalyzer analyzer;
Brian Osman0006ad02020-11-18 15:38:39 -05001112 analyzer.visit(elements, symbols, candidateList);
John Stiles2d7973a2020-10-02 15:01:03 -04001113
John Stiles0ad233f2020-11-25 11:02:05 -05001114 // Early out if there are no inlining candidates.
John Stiles2d7973a2020-10-02 15:01:03 -04001115 std::vector<InlineCandidate>& candidates = candidateList->fCandidates;
John Stiles0ad233f2020-11-25 11:02:05 -05001116 if (candidates.empty()) {
1117 return;
1118 }
1119
1120 // Remove candidates that are not safe to inline.
John Stiles2d7973a2020-10-02 15:01:03 -04001121 InlinabilityCache cache;
1122 candidates.erase(std::remove_if(candidates.begin(),
1123 candidates.end(),
1124 [&](const InlineCandidate& candidate) {
1125 return !this->candidateCanBeInlined(candidate, &cache);
1126 }),
1127 candidates.end());
1128
John Stiles0ad233f2020-11-25 11:02:05 -05001129 // If the inline threshold is unlimited, or if we have no candidates left, our candidate list is
1130 // complete.
John Stilesd1204642021-02-17 16:30:02 -05001131 if (this->settings().fInlineThreshold == INT_MAX || candidates.empty()) {
John Stiles0ad233f2020-11-25 11:02:05 -05001132 return;
John Stiles2d7973a2020-10-02 15:01:03 -04001133 }
John Stiles0ad233f2020-11-25 11:02:05 -05001134
1135 // Remove candidates on a per-function basis if the effect of inlining would be to make more
1136 // than `inlineThreshold` nodes. (i.e. if Func() would be inlined six times and its size is
1137 // 10 nodes, it should be inlined if the inlineThreshold is 60 or higher.)
1138 FunctionSizeCache functionSizeCache;
1139 FunctionSizeCache candidateTotalCost;
1140 for (InlineCandidate& candidate : candidates) {
1141 const FunctionDeclaration& fnDecl = candidate_func(candidate);
1142 candidateTotalCost[&fnDecl] += this->getFunctionSize(fnDecl, &functionSizeCache);
1143 }
1144
John Stilesd1204642021-02-17 16:30:02 -05001145 candidates.erase(std::remove_if(candidates.begin(), candidates.end(),
1146 [&](const InlineCandidate& candidate) {
1147 const FunctionDeclaration& fnDecl = candidate_func(candidate);
1148 if (fnDecl.modifiers().fFlags & Modifiers::kInline_Flag) {
1149 // Functions marked `inline` ignore size limitations.
1150 return false;
1151 }
1152 if (usage->get(fnDecl) == 1) {
1153 // If a function is only used once, it's cost-free to inline.
1154 return false;
1155 }
1156 if (candidateTotalCost[&fnDecl] <= this->settings().fInlineThreshold) {
1157 // We won't exceed the inline threshold by inlining this.
1158 return false;
1159 }
1160 // Inlining this function will add too many IRNodes.
1161 return true;
1162 }),
1163 candidates.end());
John Stiles2d7973a2020-10-02 15:01:03 -04001164}
1165
Brian Osman0006ad02020-11-18 15:38:39 -05001166bool Inliner::analyze(const std::vector<std::unique_ptr<ProgramElement>>& elements,
John Stiles78047582020-12-16 16:17:41 -05001167 std::shared_ptr<SymbolTable> symbols,
Brian Osman0006ad02020-11-18 15:38:39 -05001168 ProgramUsage* usage) {
John Stilesd34d56e2020-10-12 12:04:47 -04001169 // A threshold of zero indicates that the inliner is completely disabled, so we can just return.
John Stilesd1204642021-02-17 16:30:02 -05001170 if (this->settings().fInlineThreshold <= 0) {
John Stilesd34d56e2020-10-12 12:04:47 -04001171 return false;
1172 }
1173
John Stiles031a7672020-11-13 16:13:18 -05001174 // Enforce a limit on inlining to avoid pathological cases. (inliner/ExponentialGrowth.sksl)
1175 if (fInlinedStatementCounter >= kInlinedStatementLimit) {
1176 return false;
1177 }
1178
John Stiles2d7973a2020-10-02 15:01:03 -04001179 InlineCandidateList candidateList;
John Stiles9b9415e2020-11-23 14:48:06 -05001180 this->buildCandidateList(elements, symbols, usage, &candidateList);
John Stiles2d7973a2020-10-02 15:01:03 -04001181
John Stiles915a38c2020-09-14 09:38:13 -04001182 // Inline the candidates where we've determined that it's safe to do so.
1183 std::unordered_set<const std::unique_ptr<Statement>*> enclosingStmtSet;
1184 bool madeChanges = false;
John Stiles2d7973a2020-10-02 15:01:03 -04001185 for (const InlineCandidate& candidate : candidateList.fCandidates) {
John Stiles915a38c2020-09-14 09:38:13 -04001186 FunctionCall& funcCall = (*candidate.fCandidateExpr)->as<FunctionCall>();
John Stiles915a38c2020-09-14 09:38:13 -04001187
1188 // Inlining two expressions using the same enclosing statement in the same inlining pass
1189 // does not work properly. If this happens, skip it; we'll get it in the next pass.
1190 auto [unusedIter, inserted] = enclosingStmtSet.insert(candidate.fEnclosingStmt);
1191 if (!inserted) {
1192 continue;
1193 }
1194
1195 // Convert the function call to its inlined equivalent.
Brian Osman3887a012020-09-30 13:22:27 -04001196 InlinedCall inlinedCall = this->inlineCall(&funcCall, candidate.fSymbols,
Ethan Nicholas0a5d0962020-10-14 13:33:18 -04001197 &candidate.fEnclosingFunction->declaration());
John Stiles915a38c2020-09-14 09:38:13 -04001198
John Stiles0c2d14a2021-03-01 10:08:08 -05001199 // Stop if an error was detected during the inlining process.
1200 if (!inlinedCall.fInlinedBody && !inlinedCall.fReplacementExpr) {
1201 break;
John Stiles915a38c2020-09-14 09:38:13 -04001202 }
1203
John Stiles0c2d14a2021-03-01 10:08:08 -05001204 // Ensure that the inlined body has a scope if it needs one.
1205 this->ensureScopedBlocks(inlinedCall.fInlinedBody.get(), candidate.fParentStmt->get());
1206
1207 // Add references within the inlined body
1208 usage->add(inlinedCall.fInlinedBody.get());
1209
1210 // Move the enclosing statement to the end of the unscoped Block containing the inlined
1211 // function, then replace the enclosing statement with that Block.
1212 // Before:
1213 // fInlinedBody = Block{ stmt1, stmt2, stmt3 }
1214 // fEnclosingStmt = stmt4
1215 // After:
1216 // fInlinedBody = null
1217 // fEnclosingStmt = Block{ stmt1, stmt2, stmt3, stmt4 }
1218 inlinedCall.fInlinedBody->children().push_back(std::move(*candidate.fEnclosingStmt));
1219 *candidate.fEnclosingStmt = std::move(inlinedCall.fInlinedBody);
1220
John Stiles915a38c2020-09-14 09:38:13 -04001221 // Replace the candidate function call with our replacement expression.
Brian Osman010ce6a2020-10-19 16:34:10 -04001222 usage->replace(candidate.fCandidateExpr->get(), inlinedCall.fReplacementExpr.get());
John Stiles915a38c2020-09-14 09:38:13 -04001223 *candidate.fCandidateExpr = std::move(inlinedCall.fReplacementExpr);
1224 madeChanges = true;
1225
John Stiles031a7672020-11-13 16:13:18 -05001226 // Stop inlining if we've reached our hard cap on new statements.
1227 if (fInlinedStatementCounter >= kInlinedStatementLimit) {
1228 break;
1229 }
1230
John Stiles915a38c2020-09-14 09:38:13 -04001231 // Note that nothing was destroyed except for the FunctionCall. All other nodes should
1232 // remain valid.
1233 }
1234
1235 return madeChanges;
John Stiles93442622020-09-11 12:11:27 -04001236}
1237
John Stiles44e96be2020-08-31 13:16:04 -04001238} // namespace SkSL