John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 1 | /* |
| 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 Stiles | 2d7973a | 2020-10-02 15:01:03 -0400 | [diff] [blame] | 10 | #include <limits.h> |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 11 | #include <memory> |
| 12 | #include <unordered_set> |
| 13 | |
Ethan Nicholas | daed259 | 2021-03-04 14:30:25 -0500 | [diff] [blame^] | 14 | #include "include/private/SkSLLayout.h" |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 15 | #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 Osman | be0b3b7 | 2021-01-06 14:27:35 -0500 | [diff] [blame] | 26 | #include "src/sksl/ir/SkSLExternalFunctionReference.h" |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 27 | #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 Stiles | 98c1f82 | 2020-09-09 14:18:53 -0400 | [diff] [blame] | 37 | #include "src/sksl/ir/SkSLInlineMarker.h" |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 38 | #include "src/sksl/ir/SkSLIntLiteral.h" |
| 39 | #include "src/sksl/ir/SkSLInterfaceBlock.h" |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 40 | #include "src/sksl/ir/SkSLNop.h" |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 41 | #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 Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 51 | #include "src/sksl/ir/SkSLVariable.h" |
| 52 | #include "src/sksl/ir/SkSLVariableReference.h" |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 53 | |
| 54 | namespace SkSL { |
| 55 | namespace { |
| 56 | |
John Stiles | 031a767 | 2020-11-13 16:13:18 -0500 | [diff] [blame] | 57 | static constexpr int kInlinedStatementLimit = 2500; |
| 58 | |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 59 | static 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 Nicholas | e659214 | 2020-09-08 10:22:09 -0400 | [diff] [blame] | 67 | switch (stmt.kind()) { |
| 68 | case Statement::Kind::kBlock: { |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 69 | // Check only the last statement of a block. |
Ethan Nicholas | 7bd6043 | 2020-09-25 14:31:59 -0400 | [diff] [blame] | 70 | const auto& block = stmt.as<Block>(); |
| 71 | return block.children().size() && |
| 72 | this->visitStatement(*block.children().back()); |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 73 | } |
Ethan Nicholas | e659214 | 2020-09-08 10:22:09 -0400 | [diff] [blame] | 74 | case Statement::Kind::kSwitch: |
Ethan Nicholas | e659214 | 2020-09-08 10:22:09 -0400 | [diff] [blame] | 75 | case Statement::Kind::kDo: |
| 76 | case Statement::Kind::kFor: |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 77 | // Don't introspect switches or loop structures at all. |
| 78 | return false; |
| 79 | |
Ethan Nicholas | e659214 | 2020-09-08 10:22:09 -0400 | [diff] [blame] | 80 | case Statement::Kind::kReturn: |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 81 | ++fNumReturns; |
| 82 | [[fallthrough]]; |
| 83 | |
| 84 | default: |
John Stiles | 9344262 | 2020-09-11 12:11:27 -0400 | [diff] [blame] | 85 | return INHERITED::visitStatement(stmt); |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 86 | } |
| 87 | } |
| 88 | |
| 89 | int fNumReturns = 0; |
| 90 | using INHERITED = ProgramVisitor; |
| 91 | }; |
| 92 | |
| 93 | return CountReturnsAtEndOfControlFlow{funcDef}.fNumReturns; |
| 94 | } |
| 95 | |
John Stiles | 74ebd7e | 2020-12-17 14:41:50 -0500 | [diff] [blame] | 96 | static int count_returns_in_continuable_constructs(const FunctionDefinition& funcDef) { |
| 97 | class CountReturnsInContinuableConstructs : public ProgramVisitor { |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 98 | public: |
John Stiles | 74ebd7e | 2020-12-17 14:41:50 -0500 | [diff] [blame] | 99 | CountReturnsInContinuableConstructs(const FunctionDefinition& funcDef) { |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 100 | this->visitProgramElement(funcDef); |
| 101 | } |
| 102 | |
| 103 | bool visitStatement(const Statement& stmt) override { |
Ethan Nicholas | e659214 | 2020-09-08 10:22:09 -0400 | [diff] [blame] | 104 | switch (stmt.kind()) { |
Ethan Nicholas | e659214 | 2020-09-08 10:22:09 -0400 | [diff] [blame] | 105 | case Statement::Kind::kDo: |
| 106 | case Statement::Kind::kFor: { |
John Stiles | 74ebd7e | 2020-12-17 14:41:50 -0500 | [diff] [blame] | 107 | ++fInsideContinuableConstruct; |
John Stiles | 9344262 | 2020-09-11 12:11:27 -0400 | [diff] [blame] | 108 | bool result = INHERITED::visitStatement(stmt); |
John Stiles | 74ebd7e | 2020-12-17 14:41:50 -0500 | [diff] [blame] | 109 | --fInsideContinuableConstruct; |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 110 | return result; |
| 111 | } |
| 112 | |
Ethan Nicholas | e659214 | 2020-09-08 10:22:09 -0400 | [diff] [blame] | 113 | case Statement::Kind::kReturn: |
John Stiles | 74ebd7e | 2020-12-17 14:41:50 -0500 | [diff] [blame] | 114 | fNumReturns += (fInsideContinuableConstruct > 0) ? 1 : 0; |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 115 | [[fallthrough]]; |
| 116 | |
| 117 | default: |
John Stiles | 9344262 | 2020-09-11 12:11:27 -0400 | [diff] [blame] | 118 | return INHERITED::visitStatement(stmt); |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 119 | } |
| 120 | } |
| 121 | |
| 122 | int fNumReturns = 0; |
John Stiles | 74ebd7e | 2020-12-17 14:41:50 -0500 | [diff] [blame] | 123 | int fInsideContinuableConstruct = 0; |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 124 | using INHERITED = ProgramVisitor; |
| 125 | }; |
| 126 | |
John Stiles | 74ebd7e | 2020-12-17 14:41:50 -0500 | [diff] [blame] | 127 | return CountReturnsInContinuableConstructs{funcDef}.fNumReturns; |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 128 | } |
| 129 | |
John Stiles | 991b09d | 2020-09-10 13:33:40 -0400 | [diff] [blame] | 130 | static bool contains_recursive_call(const FunctionDeclaration& funcDecl) { |
| 131 | class ContainsRecursiveCall : public ProgramVisitor { |
| 132 | public: |
| 133 | bool visit(const FunctionDeclaration& funcDecl) { |
| 134 | fFuncDecl = &funcDecl; |
Ethan Nicholas | ed84b73 | 2020-10-08 11:45:44 -0400 | [diff] [blame] | 135 | return funcDecl.definition() ? this->visitProgramElement(*funcDecl.definition()) |
| 136 | : false; |
John Stiles | 991b09d | 2020-09-10 13:33:40 -0400 | [diff] [blame] | 137 | } |
| 138 | |
| 139 | bool visitExpression(const Expression& expr) override { |
Ethan Nicholas | 0dec992 | 2020-10-05 15:51:52 -0400 | [diff] [blame] | 140 | if (expr.is<FunctionCall>() && expr.as<FunctionCall>().function().matches(*fFuncDecl)) { |
John Stiles | 991b09d | 2020-09-10 13:33:40 -0400 | [diff] [blame] | 141 | return true; |
| 142 | } |
| 143 | return INHERITED::visitExpression(expr); |
| 144 | } |
| 145 | |
| 146 | bool visitStatement(const Statement& stmt) override { |
Ethan Nicholas | ceb6214 | 2020-10-09 16:51:18 -0400 | [diff] [blame] | 147 | if (stmt.is<InlineMarker>() && |
| 148 | stmt.as<InlineMarker>().function().matches(*fFuncDecl)) { |
John Stiles | 991b09d | 2020-09-10 13:33:40 -0400 | [diff] [blame] | 149 | 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 Stiles | 6d69608 | 2020-10-01 10:18:54 -0400 | [diff] [blame] | 161 | static std::unique_ptr<Statement>* find_parent_statement( |
| 162 | const std::vector<std::unique_ptr<Statement>*>& stmtStack) { |
John Stiles | 915a38c | 2020-09-14 09:38:13 -0400 | [diff] [blame] | 163 | 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 Stiles | 6d69608 | 2020-10-01 10:18:54 -0400 | [diff] [blame] | 172 | std::unique_ptr<Statement>* stmt = *iter; |
| 173 | if (!(*stmt)->is<Block>() || (*stmt)->as<Block>().isScope()) { |
John Stiles | 915a38c | 2020-09-14 09:38:13 -0400 | [diff] [blame] | 174 | return stmt; |
| 175 | } |
| 176 | } |
| 177 | |
| 178 | // There wasn't any parent statement to be found. |
| 179 | return nullptr; |
| 180 | } |
| 181 | |
John Stiles | e41b4ee | 2020-09-28 12:28:16 -0400 | [diff] [blame] | 182 | std::unique_ptr<Expression> clone_with_ref_kind(const Expression& expr, |
| 183 | VariableReference::RefKind refKind) { |
| 184 | std::unique_ptr<Expression> clone = expr.clone(); |
John Stiles | 47c0a74 | 2021-02-09 09:30:35 -0500 | [diff] [blame] | 185 | Analysis::UpdateRefKind(clone.get(), refKind); |
John Stiles | e41b4ee | 2020-09-28 12:28:16 -0400 | [diff] [blame] | 186 | return clone; |
| 187 | } |
| 188 | |
John Stiles | 77702f1 | 2020-12-17 14:38:56 -0500 | [diff] [blame] | 189 | class CountReturnsWithLimit : public ProgramVisitor { |
| 190 | public: |
| 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 Stiles | c5ff486 | 2020-12-22 13:47:05 -0500 | [diff] [blame] | 202 | case Statement::Kind::kVarDeclaration: { |
| 203 | if (fScopedBlockDepth > 1) { |
| 204 | fVariablesInBlocks = true; |
| 205 | } |
| 206 | return INHERITED::visitStatement(stmt); |
| 207 | } |
John Stiles | 77702f1 | 2020-12-17 14:38:56 -0500 | [diff] [blame] | 208 | 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 Stiles | c5ff486 | 2020-12-22 13:47:05 -0500 | [diff] [blame] | 213 | 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 Stiles | 77702f1 | 2020-12-17 14:38:56 -0500 | [diff] [blame] | 220 | 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 Stiles | c5ff486 | 2020-12-22 13:47:05 -0500 | [diff] [blame] | 231 | bool fVariablesInBlocks = false; |
John Stiles | 77702f1 | 2020-12-17 14:38:56 -0500 | [diff] [blame] | 232 | using INHERITED = ProgramVisitor; |
| 233 | }; |
| 234 | |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 235 | } // namespace |
| 236 | |
John Stiles | 77702f1 | 2020-12-17 14:38:56 -0500 | [diff] [blame] | 237 | Inliner::ReturnComplexity Inliner::GetReturnComplexity(const FunctionDefinition& funcDef) { |
| 238 | int returnsAtEndOfControlFlow = count_returns_at_end_of_control_flow(funcDef); |
| 239 | CountReturnsWithLimit counter{funcDef, returnsAtEndOfControlFlow + 1}; |
John Stiles | 77702f1 | 2020-12-17 14:38:56 -0500 | [diff] [blame] | 240 | if (counter.fNumReturns > returnsAtEndOfControlFlow) { |
| 241 | return ReturnComplexity::kEarlyReturns; |
| 242 | } |
John Stiles | c5ff486 | 2020-12-22 13:47:05 -0500 | [diff] [blame] | 243 | if (counter.fNumReturns > 1) { |
John Stiles | 77702f1 | 2020-12-17 14:38:56 -0500 | [diff] [blame] | 244 | return ReturnComplexity::kScopedReturns; |
| 245 | } |
John Stiles | c5ff486 | 2020-12-22 13:47:05 -0500 | [diff] [blame] | 246 | if (counter.fVariablesInBlocks && counter.fDeepestReturn > 1) { |
| 247 | return ReturnComplexity::kScopedReturns; |
| 248 | } |
| 249 | return ReturnComplexity::kSingleSafeReturn; |
John Stiles | 77702f1 | 2020-12-17 14:38:56 -0500 | [diff] [blame] | 250 | } |
| 251 | |
John Stiles | b61ee90 | 2020-09-21 12:26:59 -0400 | [diff] [blame] | 252 | void 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 Osman | d6f2338 | 2020-12-15 17:08:59 -0500 | [diff] [blame] | 260 | parentStmt->is<DoStatement>())) { |
John Stiles | b61ee90 | 2020-09-21 12:26:59 -0400 | [diff] [blame] | 261 | 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 = █; ) { |
Ethan Nicholas | 7bd6043 | 2020-09-25 14:31:59 -0400 | [diff] [blame] | 274 | if (nestedBlock->isScope()) { |
John Stiles | b61ee90 | 2020-09-21 12:26:59 -0400 | [diff] [blame] | 275 | // We found an explicit scope; all is well. |
| 276 | return; |
| 277 | } |
Ethan Nicholas | 7bd6043 | 2020-09-25 14:31:59 -0400 | [diff] [blame] | 278 | if (nestedBlock->children().size() != 1) { |
John Stiles | b61ee90 | 2020-09-21 12:26:59 -0400 | [diff] [blame] | 279 | // We found a block with multiple (or zero) statements, but no scope? Let's add a scope |
| 280 | // to the outermost block. |
Ethan Nicholas | 7bd6043 | 2020-09-25 14:31:59 -0400 | [diff] [blame] | 281 | block.setIsScope(true); |
John Stiles | b61ee90 | 2020-09-21 12:26:59 -0400 | [diff] [blame] | 282 | return; |
| 283 | } |
Ethan Nicholas | 7bd6043 | 2020-09-25 14:31:59 -0400 | [diff] [blame] | 284 | if (!nestedBlock->children()[0]->is<Block>()) { |
John Stiles | b61ee90 | 2020-09-21 12:26:59 -0400 | [diff] [blame] | 285 | // 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 Nicholas | 7bd6043 | 2020-09-25 14:31:59 -0400 | [diff] [blame] | 290 | nestedBlock = &nestedBlock->children()[0]->as<Block>(); |
John Stiles | b61ee90 | 2020-09-21 12:26:59 -0400 | [diff] [blame] | 291 | } |
| 292 | } |
| 293 | |
John Stiles | d120464 | 2021-02-17 16:30:02 -0500 | [diff] [blame] | 294 | void Inliner::reset(ModifiersPool* modifiers) { |
Ethan Nicholas | 041fd0a | 2020-10-07 16:42:04 -0400 | [diff] [blame] | 295 | fModifiers = modifiers; |
Ethan Nicholas | 6f4eee2 | 2021-01-11 12:37:42 -0500 | [diff] [blame] | 296 | fMangler.reset(); |
John Stiles | 031a767 | 2020-11-13 16:13:18 -0500 | [diff] [blame] | 297 | fInlinedStatementCounter = 0; |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 298 | } |
| 299 | |
| 300 | std::unique_ptr<Expression> Inliner::inlineExpression(int offset, |
| 301 | VariableRewriteMap* varMap, |
John Stiles | d7cc093 | 2020-11-30 12:24:27 -0500 | [diff] [blame] | 302 | SymbolTable* symbolTableForExpression, |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 303 | const Expression& expression) { |
| 304 | auto expr = [&](const std::unique_ptr<Expression>& e) -> std::unique_ptr<Expression> { |
| 305 | if (e) { |
John Stiles | d7cc093 | 2020-11-30 12:24:27 -0500 | [diff] [blame] | 306 | return this->inlineExpression(offset, varMap, symbolTableForExpression, *e); |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 307 | } |
| 308 | return nullptr; |
| 309 | }; |
John Stiles | 8e3b6be | 2020-10-13 11:14:08 -0400 | [diff] [blame] | 310 | auto argList = [&](const ExpressionArray& originalArgs) -> ExpressionArray { |
| 311 | ExpressionArray args; |
John Stiles | f4bda74 | 2020-10-14 16:57:41 -0400 | [diff] [blame] | 312 | args.reserve_back(originalArgs.size()); |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 313 | for (const std::unique_ptr<Expression>& arg : originalArgs) { |
| 314 | args.push_back(expr(arg)); |
| 315 | } |
| 316 | return args; |
| 317 | }; |
| 318 | |
Ethan Nicholas | e659214 | 2020-09-08 10:22:09 -0400 | [diff] [blame] | 319 | switch (expression.kind()) { |
| 320 | case Expression::Kind::kBinary: { |
John Stiles | 6a1a98c | 2021-01-14 18:35:34 -0500 | [diff] [blame] | 321 | const BinaryExpression& binaryExpr = expression.as<BinaryExpression>(); |
John Stiles | e2aec43 | 2021-03-01 09:27:48 -0500 | [diff] [blame] | 322 | return BinaryExpression::Make(*fContext, |
| 323 | expr(binaryExpr.left()), |
| 324 | binaryExpr.getOperator(), |
| 325 | expr(binaryExpr.right())); |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 326 | } |
Ethan Nicholas | e659214 | 2020-09-08 10:22:09 -0400 | [diff] [blame] | 327 | case Expression::Kind::kBoolLiteral: |
| 328 | case Expression::Kind::kIntLiteral: |
| 329 | case Expression::Kind::kFloatLiteral: |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 330 | return expression.clone(); |
Ethan Nicholas | e659214 | 2020-09-08 10:22:09 -0400 | [diff] [blame] | 331 | case Expression::Kind::kConstructor: { |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 332 | const Constructor& constructor = expression.as<Constructor>(); |
John Stiles | 23521a8 | 2021-03-02 17:02:51 -0500 | [diff] [blame] | 333 | auto inlinedCtor = Constructor::Convert( |
| 334 | *fContext, offset, *constructor.type().clone(symbolTableForExpression), |
| 335 | argList(constructor.arguments())); |
| 336 | SkASSERT(inlinedCtor); |
| 337 | return inlinedCtor; |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 338 | } |
Ethan Nicholas | e659214 | 2020-09-08 10:22:09 -0400 | [diff] [blame] | 339 | case Expression::Kind::kExternalFunctionCall: { |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 340 | const ExternalFunctionCall& externalCall = expression.as<ExternalFunctionCall>(); |
Ethan Nicholas | 444ccc6 | 2020-10-09 10:16:22 -0400 | [diff] [blame] | 341 | return std::make_unique<ExternalFunctionCall>(offset, &externalCall.function(), |
Ethan Nicholas | 6e86ec9 | 2020-09-30 14:29:56 -0400 | [diff] [blame] | 342 | argList(externalCall.arguments())); |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 343 | } |
Brian Osman | be0b3b7 | 2021-01-06 14:27:35 -0500 | [diff] [blame] | 344 | case Expression::Kind::kExternalFunctionReference: |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 345 | return expression.clone(); |
Ethan Nicholas | e659214 | 2020-09-08 10:22:09 -0400 | [diff] [blame] | 346 | case Expression::Kind::kFieldAccess: { |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 347 | const FieldAccess& f = expression.as<FieldAccess>(); |
Ethan Nicholas | 7a95b20 | 2020-10-09 11:55:40 -0400 | [diff] [blame] | 348 | return std::make_unique<FieldAccess>(expr(f.base()), f.fieldIndex(), f.ownerKind()); |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 349 | } |
Ethan Nicholas | e659214 | 2020-09-08 10:22:09 -0400 | [diff] [blame] | 350 | case Expression::Kind::kFunctionCall: { |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 351 | const FunctionCall& funcCall = expression.as<FunctionCall>(); |
John Stiles | ddcc843 | 2021-01-15 15:32:32 -0500 | [diff] [blame] | 352 | return std::make_unique<FunctionCall>(offset, |
| 353 | funcCall.type().clone(symbolTableForExpression), |
| 354 | &funcCall.function(), |
Ethan Nicholas | 0dec992 | 2020-10-05 15:51:52 -0400 | [diff] [blame] | 355 | argList(funcCall.arguments())); |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 356 | } |
Ethan Nicholas | e659214 | 2020-09-08 10:22:09 -0400 | [diff] [blame] | 357 | case Expression::Kind::kFunctionReference: |
Brian Osman | 2b3b35f | 2020-09-08 09:17:36 -0400 | [diff] [blame] | 358 | return expression.clone(); |
Ethan Nicholas | e659214 | 2020-09-08 10:22:09 -0400 | [diff] [blame] | 359 | case Expression::Kind::kIndex: { |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 360 | const IndexExpression& idx = expression.as<IndexExpression>(); |
Ethan Nicholas | 2a4952d | 2020-10-08 15:35:56 -0400 | [diff] [blame] | 361 | return std::make_unique<IndexExpression>(*fContext, expr(idx.base()), |
| 362 | expr(idx.index())); |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 363 | } |
Ethan Nicholas | e659214 | 2020-09-08 10:22:09 -0400 | [diff] [blame] | 364 | case Expression::Kind::kPrefix: { |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 365 | const PrefixExpression& p = expression.as<PrefixExpression>(); |
John Stiles | b0eb20f | 2021-02-26 15:29:33 -0500 | [diff] [blame] | 366 | return PrefixExpression::Make(*fContext, p.getOperator(), expr(p.operand())); |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 367 | } |
Ethan Nicholas | e659214 | 2020-09-08 10:22:09 -0400 | [diff] [blame] | 368 | case Expression::Kind::kPostfix: { |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 369 | const PostfixExpression& p = expression.as<PostfixExpression>(); |
John Stiles | 52d3b01 | 2021-02-26 15:56:48 -0500 | [diff] [blame] | 370 | return PostfixExpression::Make(*fContext, expr(p.operand()), p.getOperator()); |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 371 | } |
Ethan Nicholas | e659214 | 2020-09-08 10:22:09 -0400 | [diff] [blame] | 372 | case Expression::Kind::kSetting: |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 373 | return expression.clone(); |
Ethan Nicholas | e659214 | 2020-09-08 10:22:09 -0400 | [diff] [blame] | 374 | case Expression::Kind::kSwizzle: { |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 375 | const Swizzle& s = expression.as<Swizzle>(); |
John Stiles | 6e88e04 | 2021-02-19 14:09:38 -0500 | [diff] [blame] | 376 | return Swizzle::Make(*fContext, expr(s.base()), s.components()); |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 377 | } |
Ethan Nicholas | e659214 | 2020-09-08 10:22:09 -0400 | [diff] [blame] | 378 | case Expression::Kind::kTernary: { |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 379 | const TernaryExpression& t = expression.as<TernaryExpression>(); |
John Stiles | 90518f7 | 2021-02-26 20:44:54 -0500 | [diff] [blame] | 380 | return TernaryExpression::Make(*fContext, expr(t.test()), |
| 381 | expr(t.ifTrue()), expr(t.ifFalse())); |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 382 | } |
Brian Osman | 83ba930 | 2020-09-11 13:33:46 -0400 | [diff] [blame] | 383 | case Expression::Kind::kTypeReference: |
| 384 | return expression.clone(); |
Ethan Nicholas | e659214 | 2020-09-08 10:22:09 -0400 | [diff] [blame] | 385 | case Expression::Kind::kVariableReference: { |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 386 | const VariableReference& v = expression.as<VariableReference>(); |
Ethan Nicholas | 7868692 | 2020-10-08 06:46:27 -0400 | [diff] [blame] | 387 | auto varMapIter = varMap->find(v.variable()); |
John Stiles | e41b4ee | 2020-09-28 12:28:16 -0400 | [diff] [blame] | 388 | if (varMapIter != varMap->end()) { |
Ethan Nicholas | 7868692 | 2020-10-08 06:46:27 -0400 | [diff] [blame] | 389 | return clone_with_ref_kind(*varMapIter->second, v.refKind()); |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 390 | } |
| 391 | return v.clone(); |
| 392 | } |
| 393 | default: |
| 394 | SkASSERT(false); |
| 395 | return nullptr; |
| 396 | } |
| 397 | } |
| 398 | |
| 399 | std::unique_ptr<Statement> Inliner::inlineStatement(int offset, |
| 400 | VariableRewriteMap* varMap, |
| 401 | SymbolTable* symbolTableForStatement, |
John Stiles | 77702f1 | 2020-12-17 14:38:56 -0500 | [diff] [blame] | 402 | std::unique_ptr<Expression>* resultExpr, |
| 403 | ReturnComplexity returnComplexity, |
Brian Osman | 3887a01 | 2020-09-30 13:22:27 -0400 | [diff] [blame] | 404 | const Statement& statement, |
| 405 | bool isBuiltinCode) { |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 406 | auto stmt = [&](const std::unique_ptr<Statement>& s) -> std::unique_ptr<Statement> { |
| 407 | if (s) { |
John Stiles | a5f3c31 | 2020-09-22 12:05:16 -0400 | [diff] [blame] | 408 | return this->inlineStatement(offset, varMap, symbolTableForStatement, resultExpr, |
John Stiles | 77702f1 | 2020-12-17 14:38:56 -0500 | [diff] [blame] | 409 | returnComplexity, *s, isBuiltinCode); |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 410 | } |
| 411 | return nullptr; |
| 412 | }; |
Ethan Nicholas | 7bd6043 | 2020-09-25 14:31:59 -0400 | [diff] [blame] | 413 | auto blockStmts = [&](const Block& block) { |
John Stiles | 8f2a0cf | 2020-10-13 12:48:21 -0400 | [diff] [blame] | 414 | StatementArray result; |
John Stiles | f4bda74 | 2020-10-14 16:57:41 -0400 | [diff] [blame] | 415 | result.reserve_back(block.children().size()); |
Ethan Nicholas | 7bd6043 | 2020-09-25 14:31:59 -0400 | [diff] [blame] | 416 | for (const std::unique_ptr<Statement>& child : block.children()) { |
| 417 | result.push_back(stmt(child)); |
| 418 | } |
| 419 | return result; |
| 420 | }; |
John Stiles | 8f2a0cf | 2020-10-13 12:48:21 -0400 | [diff] [blame] | 421 | auto stmts = [&](const StatementArray& ss) { |
| 422 | StatementArray result; |
John Stiles | f4bda74 | 2020-10-14 16:57:41 -0400 | [diff] [blame] | 423 | result.reserve_back(ss.size()); |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 424 | 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 Stiles | d7cc093 | 2020-11-30 12:24:27 -0500 | [diff] [blame] | 431 | return this->inlineExpression(offset, varMap, symbolTableForStatement, *e); |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 432 | } |
| 433 | return nullptr; |
| 434 | }; |
John Stiles | 031a767 | 2020-11-13 16:13:18 -0500 | [diff] [blame] | 435 | |
| 436 | ++fInlinedStatementCounter; |
| 437 | |
Ethan Nicholas | e659214 | 2020-09-08 10:22:09 -0400 | [diff] [blame] | 438 | switch (statement.kind()) { |
| 439 | case Statement::Kind::kBlock: { |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 440 | const Block& b = statement.as<Block>(); |
John Stiles | a1e2b41 | 2020-10-20 14:51:28 -0400 | [diff] [blame] | 441 | return std::make_unique<Block>(offset, blockStmts(b), |
| 442 | SymbolTable::WrapIfBuiltin(b.symbolTable()), |
| 443 | b.isScope()); |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 444 | } |
| 445 | |
Ethan Nicholas | e659214 | 2020-09-08 10:22:09 -0400 | [diff] [blame] | 446 | case Statement::Kind::kBreak: |
| 447 | case Statement::Kind::kContinue: |
| 448 | case Statement::Kind::kDiscard: |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 449 | return statement.clone(); |
| 450 | |
Ethan Nicholas | e659214 | 2020-09-08 10:22:09 -0400 | [diff] [blame] | 451 | case Statement::Kind::kDo: { |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 452 | const DoStatement& d = statement.as<DoStatement>(); |
John Stiles | ea5822e | 2021-02-26 11:18:20 -0500 | [diff] [blame] | 453 | return DoStatement::Make(*fContext, stmt(d.statement()), expr(d.test())); |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 454 | } |
Ethan Nicholas | e659214 | 2020-09-08 10:22:09 -0400 | [diff] [blame] | 455 | case Statement::Kind::kExpression: { |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 456 | const ExpressionStatement& e = statement.as<ExpressionStatement>(); |
John Stiles | 3e5871c | 2021-02-25 20:52:03 -0500 | [diff] [blame] | 457 | return ExpressionStatement::Make(*fContext, expr(e.expression())); |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 458 | } |
Ethan Nicholas | e659214 | 2020-09-08 10:22:09 -0400 | [diff] [blame] | 459 | case Statement::Kind::kFor: { |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 460 | 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 Nicholas | 0d31ed5 | 2020-10-05 14:47:09 -0400 | [diff] [blame] | 463 | std::unique_ptr<Statement> initializer = stmt(f.initializer()); |
John Stiles | b321a07 | 2021-02-25 16:24:19 -0500 | [diff] [blame] | 464 | return ForStatement::Make(*fContext, offset, std::move(initializer), expr(f.test()), |
| 465 | expr(f.next()), stmt(f.statement()), |
| 466 | SymbolTable::WrapIfBuiltin(f.symbols())); |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 467 | } |
Ethan Nicholas | e659214 | 2020-09-08 10:22:09 -0400 | [diff] [blame] | 468 | case Statement::Kind::kIf: { |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 469 | const IfStatement& i = statement.as<IfStatement>(); |
John Stiles | cf3059e | 2021-02-25 14:27:02 -0500 | [diff] [blame] | 470 | return IfStatement::Make(*fContext, offset, i.isStatic(), expr(i.test()), |
| 471 | stmt(i.ifTrue()), stmt(i.ifFalse())); |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 472 | } |
John Stiles | 98c1f82 | 2020-09-09 14:18:53 -0400 | [diff] [blame] | 473 | case Statement::Kind::kInlineMarker: |
Ethan Nicholas | e659214 | 2020-09-08 10:22:09 -0400 | [diff] [blame] | 474 | case Statement::Kind::kNop: |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 475 | return statement.clone(); |
John Stiles | ea5822e | 2021-02-26 11:18:20 -0500 | [diff] [blame] | 476 | |
Ethan Nicholas | e659214 | 2020-09-08 10:22:09 -0400 | [diff] [blame] | 477 | case Statement::Kind::kReturn: { |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 478 | const ReturnStatement& r = statement.as<ReturnStatement>(); |
John Stiles | 77702f1 | 2020-12-17 14:38:56 -0500 | [diff] [blame] | 479 | 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 Stiles | 7b92044 | 2020-12-17 10:43:41 -0500 | [diff] [blame] | 484 | return std::make_unique<ContinueStatement>(offset); |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 485 | } else { |
John Stiles | 77702f1 | 2020-12-17 14:38:56 -0500 | [diff] [blame] | 486 | // 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 Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 488 | return std::make_unique<Nop>(); |
| 489 | } |
| 490 | } |
John Stiles | 77702f1 | 2020-12-17 14:38:56 -0500 | [diff] [blame] | 491 | |
John Stiles | c5ff486 | 2020-12-22 13:47:05 -0500 | [diff] [blame] | 492 | // 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 Stiles | 77702f1 | 2020-12-17 14:38:56 -0500 | [diff] [blame] | 495 | SkASSERT(resultExpr); |
John Stiles | c5ff486 | 2020-12-22 13:47:05 -0500 | [diff] [blame] | 496 | if (returnComplexity <= ReturnComplexity::kSingleSafeReturn) { |
John Stiles | 77702f1 | 2020-12-17 14:38:56 -0500 | [diff] [blame] | 497 | *resultExpr = expr(r.expression()); |
| 498 | return std::make_unique<Nop>(); |
| 499 | } |
| 500 | |
| 501 | // For more complex functions, assign their result into a variable. |
John Stiles | 511c500 | 2021-02-25 11:17:02 -0500 | [diff] [blame] | 502 | SkASSERT(*resultExpr); |
John Stiles | 3e5871c | 2021-02-25 20:52:03 -0500 | [diff] [blame] | 503 | auto assignment = ExpressionStatement::Make( |
| 504 | *fContext, |
John Stiles | e2aec43 | 2021-03-01 09:27:48 -0500 | [diff] [blame] | 505 | BinaryExpression::Make( |
| 506 | *fContext, |
| 507 | clone_with_ref_kind(**resultExpr, VariableRefKind::kWrite), |
John Stiles | 77702f1 | 2020-12-17 14:38:56 -0500 | [diff] [blame] | 508 | Token::Kind::TK_EQ, |
John Stiles | e2aec43 | 2021-03-01 09:27:48 -0500 | [diff] [blame] | 509 | expr(r.expression()))); |
John Stiles | 77702f1 | 2020-12-17 14:38:56 -0500 | [diff] [blame] | 510 | |
| 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 Stiles | 3e5871c | 2021-02-25 20:52:03 -0500 | [diff] [blame] | 523 | return assignment; |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 524 | } |
Ethan Nicholas | e659214 | 2020-09-08 10:22:09 -0400 | [diff] [blame] | 525 | case Statement::Kind::kSwitch: { |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 526 | const SwitchStatement& ss = statement.as<SwitchStatement>(); |
| 527 | std::vector<std::unique_ptr<SwitchCase>> cases; |
John Stiles | 2d4f959 | 2020-10-30 10:29:12 -0400 | [diff] [blame] | 528 | 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 Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 532 | } |
John Stiles | e1d1b08 | 2021-02-23 13:44:36 -0500 | [diff] [blame] | 533 | return SwitchStatement::Make(*fContext, offset, ss.isStatic(), expr(ss.value()), |
| 534 | std::move(cases), SymbolTable::WrapIfBuiltin(ss.symbols())); |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 535 | } |
Ethan Nicholas | e659214 | 2020-09-08 10:22:09 -0400 | [diff] [blame] | 536 | case Statement::Kind::kVarDeclaration: { |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 537 | const VarDeclaration& decl = statement.as<VarDeclaration>(); |
John Stiles | 35fee4c | 2020-12-16 18:25:14 +0000 | [diff] [blame] | 538 | std::unique_ptr<Expression> initialValue = expr(decl.value()); |
John Stiles | ddcc843 | 2021-01-15 15:32:32 -0500 | [diff] [blame] | 539 | const Variable& variable = decl.var(); |
| 540 | |
John Stiles | 35fee4c | 2020-12-16 18:25:14 +0000 | [diff] [blame] | 541 | // 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 Stiles | ddcc843 | 2021-01-15 15:32:32 -0500 | [diff] [blame] | 544 | auto name = std::make_unique<String>(fMangler.uniqueName(variable.name(), |
Ethan Nicholas | 6f4eee2 | 2021-01-11 12:37:42 -0500 | [diff] [blame] | 545 | symbolTableForStatement)); |
John Stiles | 35fee4c | 2020-12-16 18:25:14 +0000 | [diff] [blame] | 546 | const String* namePtr = symbolTableForStatement->takeOwnershipOfString(std::move(name)); |
Ethan Nicholas | 5b9b0db | 2021-01-21 13:12:01 -0500 | [diff] [blame] | 547 | 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 Stiles | ddcc843 | 2021-01-15 15:32:32 -0500 | [diff] [blame] | 556 | decl.baseType().clone(symbolTableForStatement), |
| 557 | decl.arraySize(), |
John Stiles | 35fee4c | 2020-12-16 18:25:14 +0000 | [diff] [blame] | 558 | std::move(initialValue)); |
Ethan Nicholas | 5b9b0db | 2021-01-21 13:12:01 -0500 | [diff] [blame] | 559 | clonedVar->setDeclaration(result.get()); |
| 560 | symbolTableForStatement->takeOwnershipOfSymbol(std::move(clonedVar)); |
| 561 | return std::move(result); |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 562 | } |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 563 | default: |
| 564 | SkASSERT(false); |
| 565 | return nullptr; |
| 566 | } |
| 567 | } |
| 568 | |
John Stiles | 7b92044 | 2020-12-17 10:43:41 -0500 | [diff] [blame] | 569 | Inliner::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 Stiles | 1497527 | 2021-01-12 11:41:14 -0500 | [diff] [blame] | 578 | if (type->isLiteral()) { |
| 579 | SkDEBUGFAIL("found a $literal type while inlining"); |
| 580 | type = &type->scalarTypeForLiteral(); |
John Stiles | 7b92044 | 2020-12-17 10:43:41 -0500 | [diff] [blame] | 581 | } |
| 582 | |
| 583 | // Provide our new variable with a unique name, and add it to our symbol table. |
| 584 | const String* namePtr = symbolTable->takeOwnershipOfString( |
Ethan Nicholas | 6f4eee2 | 2021-01-11 12:37:42 -0500 | [diff] [blame] | 585 | std::make_unique<String>(fMangler.uniqueName(baseName, symbolTable))); |
John Stiles | 7b92044 | 2020-12-17 10:43:41 -0500 | [diff] [blame] | 586 | StringFragment nameFrag{namePtr->c_str(), namePtr->length()}; |
| 587 | |
| 588 | // Create our new variable and add it to the symbol table. |
| 589 | InlineVariable result; |
Ethan Nicholas | 5b9b0db | 2021-01-21 13:12:01 -0500 | [diff] [blame] | 590 | auto var = std::make_unique<Variable>(/*offset=*/-1, |
| 591 | fModifiers->addToPool(Modifiers()), |
| 592 | nameFrag, |
| 593 | type, |
| 594 | isBuiltinCode, |
| 595 | Variable::Storage::kLocal); |
John Stiles | 7b92044 | 2020-12-17 10:43:41 -0500 | [diff] [blame] | 596 | |
| 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 Nicholas | 5b9b0db | 2021-01-21 13:12:01 -0500 | [diff] [blame] | 600 | result.fVarDecl = std::make_unique<VarDeclaration>(var.get(), type, /*arraySize=*/0, |
John Stiles | 7b92044 | 2020-12-17 10:43:41 -0500 | [diff] [blame] | 601 | (*initialValue)->clone()); |
| 602 | } else { |
Ethan Nicholas | 5b9b0db | 2021-01-21 13:12:01 -0500 | [diff] [blame] | 603 | result.fVarDecl = std::make_unique<VarDeclaration>(var.get(), type, /*arraySize=*/0, |
John Stiles | 7b92044 | 2020-12-17 10:43:41 -0500 | [diff] [blame] | 604 | std::move(*initialValue)); |
| 605 | } |
Ethan Nicholas | 5b9b0db | 2021-01-21 13:12:01 -0500 | [diff] [blame] | 606 | var->setDeclaration(&result.fVarDecl->as<VarDeclaration>()); |
| 607 | result.fVarSymbol = symbolTable->add(std::move(var)); |
John Stiles | 7b92044 | 2020-12-17 10:43:41 -0500 | [diff] [blame] | 608 | return result; |
| 609 | } |
| 610 | |
John Stiles | 6eadf13 | 2020-09-08 10:16:10 -0400 | [diff] [blame] | 611 | Inliner::InlinedCall Inliner::inlineCall(FunctionCall* call, |
John Stiles | 7804758 | 2020-12-16 16:17:41 -0500 | [diff] [blame] | 612 | std::shared_ptr<SymbolTable> symbolTable, |
Brian Osman | 3887a01 | 2020-09-30 13:22:27 -0400 | [diff] [blame] | 613 | const FunctionDeclaration* caller) { |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 614 | // 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 Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 623 | SkASSERT(fContext); |
| 624 | SkASSERT(call); |
Ethan Nicholas | ed84b73 | 2020-10-08 11:45:44 -0400 | [diff] [blame] | 625 | SkASSERT(this->isSafeToInline(call->function().definition())); |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 626 | |
John Stiles | 8e3b6be | 2020-10-13 11:14:08 -0400 | [diff] [blame] | 627 | ExpressionArray& arguments = call->arguments(); |
John Stiles | 6eadf13 | 2020-09-08 10:16:10 -0400 | [diff] [blame] | 628 | const int offset = call->fOffset; |
Ethan Nicholas | ed84b73 | 2020-10-08 11:45:44 -0400 | [diff] [blame] | 629 | const FunctionDefinition& function = *call->function().definition(); |
John Stiles | 77702f1 | 2020-12-17 14:38:56 -0500 | [diff] [blame] | 630 | const ReturnComplexity returnComplexity = GetReturnComplexity(function); |
| 631 | bool hasEarlyReturn = (returnComplexity >= ReturnComplexity::kEarlyReturns); |
John Stiles | 6eadf13 | 2020-09-08 10:16:10 -0400 | [diff] [blame] | 632 | |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 633 | InlinedCall inlinedCall; |
John Stiles | 8f2a0cf | 2020-10-13 12:48:21 -0400 | [diff] [blame] | 634 | inlinedCall.fInlinedBody = std::make_unique<Block>(offset, StatementArray{}, |
John Stiles | 6eadf13 | 2020-09-08 10:16:10 -0400 | [diff] [blame] | 635 | /*symbols=*/nullptr, |
| 636 | /*isScope=*/false); |
John Stiles | 98c1f82 | 2020-09-09 14:18:53 -0400 | [diff] [blame] | 637 | |
Ethan Nicholas | 7bd6043 | 2020-09-25 14:31:59 -0400 | [diff] [blame] | 638 | Block& inlinedBody = *inlinedCall.fInlinedBody; |
John Stiles | 82f373c | 2020-10-20 13:58:05 -0400 | [diff] [blame] | 639 | 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 Stiles | 7b92044 | 2020-12-17 10:43:41 -0500 | [diff] [blame] | 644 | 1); // Block for inlined code |
John Stiles | 98c1f82 | 2020-09-09 14:18:53 -0400 | [diff] [blame] | 645 | |
Ethan Nicholas | ceb6214 | 2020-10-09 16:51:18 -0400 | [diff] [blame] | 646 | inlinedBody.children().push_back(std::make_unique<InlineMarker>(&call->function())); |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 647 | |
John Stiles | e41b4ee | 2020-09-28 12:28:16 -0400 | [diff] [blame] | 648 | std::unique_ptr<Expression> resultExpr; |
John Stiles | 511c500 | 2021-02-25 11:17:02 -0500 | [diff] [blame] | 649 | 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 Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 654 | std::unique_ptr<Expression> noInitialValue; |
John Stiles | 7b92044 | 2020-12-17 10:43:41 -0500 | [diff] [blame] | 655 | 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 Stiles | 511c500 | 2021-02-25 11:17:02 -0500 | [diff] [blame] | 661 | } |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 662 | |
| 663 | // Create variables in the extra statements to hold the arguments, and assign the arguments to |
| 664 | // them. |
| 665 | VariableRewriteMap varMap; |
John Stiles | e41b4ee | 2020-09-28 12:28:16 -0400 | [diff] [blame] | 666 | std::vector<int> argsToCopyBack; |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 667 | for (int i = 0; i < (int) arguments.size(); ++i) { |
Ethan Nicholas | 0a5d096 | 2020-10-14 13:33:18 -0400 | [diff] [blame] | 668 | const Variable* param = function.declaration().parameters()[i]; |
Ethan Nicholas | 041fd0a | 2020-10-07 16:42:04 -0400 | [diff] [blame] | 669 | bool isOutParam = param->modifiers().fFlags & Modifiers::kOut_Flag; |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 670 | |
John Stiles | 44733aa | 2020-09-29 17:42:23 -0400 | [diff] [blame] | 671 | // If this argument can be inlined trivially (e.g. a swizzle, or a constant array index)... |
John Stiles | c30fbca | 2020-11-19 16:25:49 -0500 | [diff] [blame] | 672 | if (Analysis::IsTrivialExpression(*arguments[i])) { |
John Stiles | e41b4ee | 2020-09-28 12:28:16 -0400 | [diff] [blame] | 673 | // ... and it's an `out` param, or it isn't written to within the inline function... |
Ethan Nicholas | 0a5d096 | 2020-10-14 13:33:18 -0400 | [diff] [blame] | 674 | if (isOutParam || !Analysis::StatementWritesToVariable(*function.body(), *param)) { |
John Stiles | f201af8 | 2020-09-29 16:57:55 -0400 | [diff] [blame] | 675 | // ... we don't need to copy it at all! We can just use the existing expression. |
| 676 | varMap[param] = arguments[i]->clone(); |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 677 | continue; |
| 678 | } |
| 679 | } |
John Stiles | e41b4ee | 2020-09-28 12:28:16 -0400 | [diff] [blame] | 680 | if (isOutParam) { |
| 681 | argsToCopyBack.push_back(i); |
| 682 | } |
John Stiles | 7b92044 | 2020-12-17 10:43:41 -0500 | [diff] [blame] | 683 | 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 Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 688 | } |
| 689 | |
Ethan Nicholas | 0a5d096 | 2020-10-14 13:33:18 -0400 | [diff] [blame] | 690 | const Block& body = function.body()->as<Block>(); |
John Stiles | 7b92044 | 2020-12-17 10:43:41 -0500 | [diff] [blame] | 691 | StatementArray* inlineStatements; |
| 692 | |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 693 | if (hasEarlyReturn) { |
| 694 | // Since we output to backends that don't have a goto statement (which would normally be |
John Stiles | 7b92044 | 2020-12-17 10:43:41 -0500 | [diff] [blame] | 695 | // 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 Stiles | 54e7c05 | 2021-01-11 14:22:36 -0500 | [diff] [blame] | 701 | const Type* intType = fContext->fTypes.fInt.get(); |
John Stiles | 7b92044 | 2020-12-17 10:43:41 -0500 | [diff] [blame] | 702 | 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 Stiles | e2aec43 | 2021-03-01 09:27:48 -0500 | [diff] [blame] | 710 | std::unique_ptr<Expression> test = BinaryExpression::Make( |
| 711 | *fContext, |
John Stiles | 7b92044 | 2020-12-17 10:43:41 -0500 | [diff] [blame] | 712 | std::make_unique<VariableReference>(/*offset=*/-1, loopVar.fVarSymbol), |
| 713 | Token::Kind::TK_LT, |
John Stiles | e2aec43 | 2021-03-01 09:27:48 -0500 | [diff] [blame] | 714 | std::make_unique<IntLiteral>(/*offset=*/-1, /*value=*/1, intType)); |
John Stiles | 7b92044 | 2020-12-17 10:43:41 -0500 | [diff] [blame] | 715 | |
| 716 | // _1_loop++ |
John Stiles | 52d3b01 | 2021-02-26 15:56:48 -0500 | [diff] [blame] | 717 | std::unique_ptr<Expression> increment = PostfixExpression::Make( |
| 718 | *fContext, |
John Stiles | 7b92044 | 2020-12-17 10:43:41 -0500 | [diff] [blame] | 719 | 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 Stiles | b321a07 | 2021-02-25 16:24:19 -0500 | [diff] [blame] | 729 | 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 Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 735 | } else { |
John Stiles | fa9a083 | 2020-12-17 10:43:58 -0500 | [diff] [blame] | 736 | // No early returns, so we can just dump the code into our existing scopeless block. |
| 737 | inlineStatements = &inlinedBody.children(); |
John Stiles | 7b92044 | 2020-12-17 10:43:41 -0500 | [diff] [blame] | 738 | } |
| 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 Stiles | 77702f1 | 2020-12-17 14:38:56 -0500 | [diff] [blame] | 743 | &resultExpr, returnComplexity, *stmt, |
John Stiles | 7b92044 | 2020-12-17 10:43:41 -0500 | [diff] [blame] | 744 | caller->isBuiltin())); |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 745 | } |
| 746 | |
John Stiles | e41b4ee | 2020-09-28 12:28:16 -0400 | [diff] [blame] | 747 | // Copy back the values of `out` parameters into their real destinations. |
| 748 | for (int i : argsToCopyBack) { |
Ethan Nicholas | 0a5d096 | 2020-10-14 13:33:18 -0400 | [diff] [blame] | 749 | const Variable* p = function.declaration().parameters()[i]; |
John Stiles | e41b4ee | 2020-09-28 12:28:16 -0400 | [diff] [blame] | 750 | SkASSERT(varMap.find(p) != varMap.end()); |
John Stiles | 3e5871c | 2021-02-25 20:52:03 -0500 | [diff] [blame] | 751 | inlineStatements->push_back(ExpressionStatement::Make( |
| 752 | *fContext, |
John Stiles | e2aec43 | 2021-03-01 09:27:48 -0500 | [diff] [blame] | 753 | BinaryExpression::Make(*fContext, |
| 754 | clone_with_ref_kind(*arguments[i], VariableRefKind::kWrite), |
| 755 | Token::Kind::TK_EQ, |
| 756 | std::move(varMap[p])))); |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 757 | } |
| 758 | |
John Stiles | 0c2d14a | 2021-03-01 10:08:08 -0500 | [diff] [blame] | 759 | if (resultExpr) { |
| 760 | // Return our result expression as-is. |
John Stiles | e41b4ee | 2020-09-28 12:28:16 -0400 | [diff] [blame] | 761 | inlinedCall.fReplacementExpr = std::move(resultExpr); |
John Stiles | 0c2d14a | 2021-03-01 10:08:08 -0500 | [diff] [blame] | 762 | } else if (function.declaration().returnType() == *fContext->fTypes.fVoid) { |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 763 | // 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 Nicholas | 041fd0a | 2020-10-07 16:42:04 -0400 | [diff] [blame] | 765 | inlinedCall.fReplacementExpr = std::make_unique<BoolLiteral>(*fContext, |
| 766 | offset, |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 767 | /*value=*/false); |
John Stiles | 0c2d14a | 2021-03-01 10:08:08 -0500 | [diff] [blame] | 768 | } else { |
| 769 | // It's a non-void function, but it never created a result expression--that is, it never |
John Stiles | 2dda50d | 2021-03-03 10:46:44 -0500 | [diff] [blame] | 770 | // returned anything on any path! This should have been detected in the function finalizer. |
| 771 | // Still, discard our output and generate an error. |
| 772 | SkDEBUGFAIL("inliner found non-void function that fails to return a value on any path"); |
| 773 | fContext->fErrors.error(function.fOffset, "inliner found non-void function '" + |
John Stiles | 0c2d14a | 2021-03-01 10:08:08 -0500 | [diff] [blame] | 774 | function.declaration().name() + |
John Stiles | 2dda50d | 2021-03-03 10:46:44 -0500 | [diff] [blame] | 775 | "' that fails to return a value on any path"); |
John Stiles | 0c2d14a | 2021-03-01 10:08:08 -0500 | [diff] [blame] | 776 | inlinedCall = {}; |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 777 | } |
| 778 | |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 779 | return inlinedCall; |
| 780 | } |
| 781 | |
John Stiles | 2d7973a | 2020-10-02 15:01:03 -0400 | [diff] [blame] | 782 | bool Inliner::isSafeToInline(const FunctionDefinition* functionDef) { |
John Stiles | 1c03d33 | 2020-10-13 10:30:23 -0400 | [diff] [blame] | 783 | // A threshold of zero indicates that the inliner is completely disabled, so we can just return. |
John Stiles | d120464 | 2021-02-17 16:30:02 -0500 | [diff] [blame] | 784 | if (this->settings().fInlineThreshold <= 0) { |
John Stiles | 1c03d33 | 2020-10-13 10:30:23 -0400 | [diff] [blame] | 785 | return false; |
| 786 | } |
| 787 | |
John Stiles | 031a767 | 2020-11-13 16:13:18 -0500 | [diff] [blame] | 788 | // Enforce a limit on inlining to avoid pathological cases. (inliner/ExponentialGrowth.sksl) |
| 789 | if (fInlinedStatementCounter >= kInlinedStatementLimit) { |
| 790 | return false; |
| 791 | } |
| 792 | |
John Stiles | 2d7973a | 2020-10-02 15:01:03 -0400 | [diff] [blame] | 793 | if (functionDef == nullptr) { |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 794 | // Can't inline something if we don't actually have its definition. |
| 795 | return false; |
| 796 | } |
John Stiles | 2d7973a | 2020-10-02 15:01:03 -0400 | [diff] [blame] | 797 | |
John Stiles | 74ebd7e | 2020-12-17 14:41:50 -0500 | [diff] [blame] | 798 | // We don't have any mechanism to simulate early returns within a construct that supports |
| 799 | // continues (for/do/while), so we can't inline if there's a return inside one. |
| 800 | bool hasReturnInContinuableConstruct = |
| 801 | (count_returns_in_continuable_constructs(*functionDef) > 0); |
| 802 | return !hasReturnInContinuableConstruct; |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 803 | } |
| 804 | |
John Stiles | 2d7973a | 2020-10-02 15:01:03 -0400 | [diff] [blame] | 805 | // A candidate function for inlining, containing everything that `inlineCall` needs. |
| 806 | struct InlineCandidate { |
John Stiles | 7804758 | 2020-12-16 16:17:41 -0500 | [diff] [blame] | 807 | std::shared_ptr<SymbolTable> fSymbols; // the SymbolTable of the candidate |
John Stiles | 2d7973a | 2020-10-02 15:01:03 -0400 | [diff] [blame] | 808 | std::unique_ptr<Statement>* fParentStmt; // the parent Statement of the enclosing stmt |
| 809 | std::unique_ptr<Statement>* fEnclosingStmt; // the Statement containing the candidate |
| 810 | std::unique_ptr<Expression>* fCandidateExpr; // the candidate FunctionCall to be inlined |
| 811 | FunctionDefinition* fEnclosingFunction; // the Function containing the candidate |
John Stiles | 2d7973a | 2020-10-02 15:01:03 -0400 | [diff] [blame] | 812 | }; |
John Stiles | 9344262 | 2020-09-11 12:11:27 -0400 | [diff] [blame] | 813 | |
John Stiles | 2d7973a | 2020-10-02 15:01:03 -0400 | [diff] [blame] | 814 | struct InlineCandidateList { |
| 815 | std::vector<InlineCandidate> fCandidates; |
| 816 | }; |
| 817 | |
| 818 | class InlineCandidateAnalyzer { |
John Stiles | 70957c8 | 2020-10-02 16:42:10 -0400 | [diff] [blame] | 819 | public: |
| 820 | // A list of all the inlining candidates we found during analysis. |
| 821 | InlineCandidateList* fCandidateList; |
John Stiles | 2d7973a | 2020-10-02 15:01:03 -0400 | [diff] [blame] | 822 | |
John Stiles | 70957c8 | 2020-10-02 16:42:10 -0400 | [diff] [blame] | 823 | // A stack of the symbol tables; since most nodes don't have one, expected to be shallower than |
| 824 | // the enclosing-statement stack. |
John Stiles | 7804758 | 2020-12-16 16:17:41 -0500 | [diff] [blame] | 825 | std::vector<std::shared_ptr<SymbolTable>> fSymbolTableStack; |
John Stiles | 70957c8 | 2020-10-02 16:42:10 -0400 | [diff] [blame] | 826 | // A stack of "enclosing" statements--these would be suitable for the inliner to use for adding |
| 827 | // new instructions. Not all statements are suitable (e.g. a for-loop's initializer). The |
| 828 | // inliner might replace a statement with a block containing the statement. |
| 829 | std::vector<std::unique_ptr<Statement>*> fEnclosingStmtStack; |
| 830 | // The function that we're currently processing (i.e. inlining into). |
| 831 | FunctionDefinition* fEnclosingFunction = nullptr; |
John Stiles | 9344262 | 2020-09-11 12:11:27 -0400 | [diff] [blame] | 832 | |
Brian Osman | 0006ad0 | 2020-11-18 15:38:39 -0500 | [diff] [blame] | 833 | void visit(const std::vector<std::unique_ptr<ProgramElement>>& elements, |
John Stiles | 7804758 | 2020-12-16 16:17:41 -0500 | [diff] [blame] | 834 | std::shared_ptr<SymbolTable> symbols, |
Brian Osman | 0006ad0 | 2020-11-18 15:38:39 -0500 | [diff] [blame] | 835 | InlineCandidateList* candidateList) { |
John Stiles | 70957c8 | 2020-10-02 16:42:10 -0400 | [diff] [blame] | 836 | fCandidateList = candidateList; |
Brian Osman | 0006ad0 | 2020-11-18 15:38:39 -0500 | [diff] [blame] | 837 | fSymbolTableStack.push_back(symbols); |
John Stiles | 9344262 | 2020-09-11 12:11:27 -0400 | [diff] [blame] | 838 | |
Brian Osman | 0006ad0 | 2020-11-18 15:38:39 -0500 | [diff] [blame] | 839 | for (const std::unique_ptr<ProgramElement>& pe : elements) { |
Brian Osman | 1179fcf | 2020-10-08 16:04:40 -0400 | [diff] [blame] | 840 | this->visitProgramElement(pe.get()); |
John Stiles | 9344262 | 2020-09-11 12:11:27 -0400 | [diff] [blame] | 841 | } |
| 842 | |
John Stiles | 70957c8 | 2020-10-02 16:42:10 -0400 | [diff] [blame] | 843 | fSymbolTableStack.pop_back(); |
| 844 | fCandidateList = nullptr; |
| 845 | } |
| 846 | |
| 847 | void visitProgramElement(ProgramElement* pe) { |
| 848 | switch (pe->kind()) { |
| 849 | case ProgramElement::Kind::kFunction: { |
| 850 | FunctionDefinition& funcDef = pe->as<FunctionDefinition>(); |
Brian Osman | 0006ad0 | 2020-11-18 15:38:39 -0500 | [diff] [blame] | 851 | fEnclosingFunction = &funcDef; |
| 852 | this->visitStatement(&funcDef.body()); |
John Stiles | 70957c8 | 2020-10-02 16:42:10 -0400 | [diff] [blame] | 853 | break; |
John Stiles | 9344262 | 2020-09-11 12:11:27 -0400 | [diff] [blame] | 854 | } |
John Stiles | 70957c8 | 2020-10-02 16:42:10 -0400 | [diff] [blame] | 855 | default: |
| 856 | // The inliner can't operate outside of a function's scope. |
| 857 | break; |
| 858 | } |
| 859 | } |
| 860 | |
| 861 | void visitStatement(std::unique_ptr<Statement>* stmt, |
| 862 | bool isViableAsEnclosingStatement = true) { |
| 863 | if (!*stmt) { |
| 864 | return; |
John Stiles | 9344262 | 2020-09-11 12:11:27 -0400 | [diff] [blame] | 865 | } |
| 866 | |
John Stiles | 70957c8 | 2020-10-02 16:42:10 -0400 | [diff] [blame] | 867 | size_t oldEnclosingStmtStackSize = fEnclosingStmtStack.size(); |
| 868 | size_t oldSymbolStackSize = fSymbolTableStack.size(); |
John Stiles | 9344262 | 2020-09-11 12:11:27 -0400 | [diff] [blame] | 869 | |
John Stiles | 70957c8 | 2020-10-02 16:42:10 -0400 | [diff] [blame] | 870 | if (isViableAsEnclosingStatement) { |
| 871 | fEnclosingStmtStack.push_back(stmt); |
John Stiles | 9344262 | 2020-09-11 12:11:27 -0400 | [diff] [blame] | 872 | } |
| 873 | |
John Stiles | 70957c8 | 2020-10-02 16:42:10 -0400 | [diff] [blame] | 874 | switch ((*stmt)->kind()) { |
| 875 | case Statement::Kind::kBreak: |
| 876 | case Statement::Kind::kContinue: |
| 877 | case Statement::Kind::kDiscard: |
| 878 | case Statement::Kind::kInlineMarker: |
| 879 | case Statement::Kind::kNop: |
| 880 | break; |
| 881 | |
| 882 | case Statement::Kind::kBlock: { |
| 883 | Block& block = (*stmt)->as<Block>(); |
| 884 | if (block.symbolTable()) { |
John Stiles | 7804758 | 2020-12-16 16:17:41 -0500 | [diff] [blame] | 885 | fSymbolTableStack.push_back(block.symbolTable()); |
John Stiles | 70957c8 | 2020-10-02 16:42:10 -0400 | [diff] [blame] | 886 | } |
| 887 | |
| 888 | for (std::unique_ptr<Statement>& stmt : block.children()) { |
| 889 | this->visitStatement(&stmt); |
| 890 | } |
| 891 | break; |
John Stiles | 9344262 | 2020-09-11 12:11:27 -0400 | [diff] [blame] | 892 | } |
John Stiles | 70957c8 | 2020-10-02 16:42:10 -0400 | [diff] [blame] | 893 | case Statement::Kind::kDo: { |
| 894 | DoStatement& doStmt = (*stmt)->as<DoStatement>(); |
| 895 | // The loop body is a candidate for inlining. |
| 896 | this->visitStatement(&doStmt.statement()); |
| 897 | // The inliner isn't smart enough to inline the test-expression for a do-while |
| 898 | // loop at this time. There are two limitations: |
| 899 | // - We would need to insert the inlined-body block at the very end of the do- |
| 900 | // statement's inner fStatement. We don't support that today, but it's doable. |
| 901 | // - We cannot inline the test expression if the loop uses `continue` anywhere; that |
| 902 | // would skip over the inlined block that evaluates the test expression. There |
| 903 | // isn't a good fix for this--any workaround would be more complex than the cost |
| 904 | // of a function call. However, loops that don't use `continue` would still be |
| 905 | // viable candidates for inlining. |
| 906 | break; |
John Stiles | 9344262 | 2020-09-11 12:11:27 -0400 | [diff] [blame] | 907 | } |
John Stiles | 70957c8 | 2020-10-02 16:42:10 -0400 | [diff] [blame] | 908 | case Statement::Kind::kExpression: { |
| 909 | ExpressionStatement& expr = (*stmt)->as<ExpressionStatement>(); |
| 910 | this->visitExpression(&expr.expression()); |
| 911 | break; |
| 912 | } |
| 913 | case Statement::Kind::kFor: { |
| 914 | ForStatement& forStmt = (*stmt)->as<ForStatement>(); |
Ethan Nicholas | 0d31ed5 | 2020-10-05 14:47:09 -0400 | [diff] [blame] | 915 | if (forStmt.symbols()) { |
John Stiles | 7804758 | 2020-12-16 16:17:41 -0500 | [diff] [blame] | 916 | fSymbolTableStack.push_back(forStmt.symbols()); |
John Stiles | 70957c8 | 2020-10-02 16:42:10 -0400 | [diff] [blame] | 917 | } |
| 918 | |
| 919 | // The initializer and loop body are candidates for inlining. |
Ethan Nicholas | 0d31ed5 | 2020-10-05 14:47:09 -0400 | [diff] [blame] | 920 | this->visitStatement(&forStmt.initializer(), |
John Stiles | 70957c8 | 2020-10-02 16:42:10 -0400 | [diff] [blame] | 921 | /*isViableAsEnclosingStatement=*/false); |
Ethan Nicholas | 0d31ed5 | 2020-10-05 14:47:09 -0400 | [diff] [blame] | 922 | this->visitStatement(&forStmt.statement()); |
John Stiles | 70957c8 | 2020-10-02 16:42:10 -0400 | [diff] [blame] | 923 | |
| 924 | // The inliner isn't smart enough to inline the test- or increment-expressions |
| 925 | // of a for loop loop at this time. There are a handful of limitations: |
| 926 | // - We would need to insert the test-expression block at the very beginning of the |
| 927 | // for-loop's inner fStatement, and the increment-expression block at the very |
| 928 | // end. We don't support that today, but it's doable. |
| 929 | // - The for-loop's built-in test-expression would need to be dropped entirely, |
| 930 | // and the loop would be halted via a break statement at the end of the inlined |
| 931 | // test-expression. This is again something we don't support today, but it could |
| 932 | // be implemented. |
| 933 | // - We cannot inline the increment-expression if the loop uses `continue` anywhere; |
| 934 | // that would skip over the inlined block that evaluates the increment expression. |
| 935 | // There isn't a good fix for this--any workaround would be more complex than the |
| 936 | // cost of a function call. However, loops that don't use `continue` would still |
| 937 | // be viable candidates for increment-expression inlining. |
| 938 | break; |
| 939 | } |
| 940 | case Statement::Kind::kIf: { |
| 941 | IfStatement& ifStmt = (*stmt)->as<IfStatement>(); |
Ethan Nicholas | 8c44eca | 2020-10-07 16:47:09 -0400 | [diff] [blame] | 942 | this->visitExpression(&ifStmt.test()); |
| 943 | this->visitStatement(&ifStmt.ifTrue()); |
| 944 | this->visitStatement(&ifStmt.ifFalse()); |
John Stiles | 70957c8 | 2020-10-02 16:42:10 -0400 | [diff] [blame] | 945 | break; |
| 946 | } |
| 947 | case Statement::Kind::kReturn: { |
| 948 | ReturnStatement& returnStmt = (*stmt)->as<ReturnStatement>(); |
Ethan Nicholas | 2a4952d | 2020-10-08 15:35:56 -0400 | [diff] [blame] | 949 | this->visitExpression(&returnStmt.expression()); |
John Stiles | 70957c8 | 2020-10-02 16:42:10 -0400 | [diff] [blame] | 950 | break; |
| 951 | } |
| 952 | case Statement::Kind::kSwitch: { |
| 953 | SwitchStatement& switchStmt = (*stmt)->as<SwitchStatement>(); |
Ethan Nicholas | 01b05e5 | 2020-10-22 15:53:41 -0400 | [diff] [blame] | 954 | if (switchStmt.symbols()) { |
John Stiles | 7804758 | 2020-12-16 16:17:41 -0500 | [diff] [blame] | 955 | fSymbolTableStack.push_back(switchStmt.symbols()); |
John Stiles | 70957c8 | 2020-10-02 16:42:10 -0400 | [diff] [blame] | 956 | } |
| 957 | |
Ethan Nicholas | 01b05e5 | 2020-10-22 15:53:41 -0400 | [diff] [blame] | 958 | this->visitExpression(&switchStmt.value()); |
John Stiles | 2d4f959 | 2020-10-30 10:29:12 -0400 | [diff] [blame] | 959 | for (const std::unique_ptr<SwitchCase>& switchCase : switchStmt.cases()) { |
John Stiles | 70957c8 | 2020-10-02 16:42:10 -0400 | [diff] [blame] | 960 | // The switch-case's fValue cannot be a FunctionCall; skip it. |
John Stiles | 2d4f959 | 2020-10-30 10:29:12 -0400 | [diff] [blame] | 961 | for (std::unique_ptr<Statement>& caseBlock : switchCase->statements()) { |
John Stiles | 70957c8 | 2020-10-02 16:42:10 -0400 | [diff] [blame] | 962 | this->visitStatement(&caseBlock); |
| 963 | } |
| 964 | } |
| 965 | break; |
| 966 | } |
| 967 | case Statement::Kind::kVarDeclaration: { |
| 968 | VarDeclaration& varDeclStmt = (*stmt)->as<VarDeclaration>(); |
| 969 | // Don't need to scan the declaration's sizes; those are always IntLiterals. |
Ethan Nicholas | c51f33e | 2020-10-13 13:49:44 -0400 | [diff] [blame] | 970 | this->visitExpression(&varDeclStmt.value()); |
John Stiles | 70957c8 | 2020-10-02 16:42:10 -0400 | [diff] [blame] | 971 | break; |
| 972 | } |
John Stiles | 70957c8 | 2020-10-02 16:42:10 -0400 | [diff] [blame] | 973 | default: |
| 974 | SkUNREACHABLE; |
John Stiles | 9344262 | 2020-09-11 12:11:27 -0400 | [diff] [blame] | 975 | } |
| 976 | |
John Stiles | 70957c8 | 2020-10-02 16:42:10 -0400 | [diff] [blame] | 977 | // Pop our symbol and enclosing-statement stacks. |
| 978 | fSymbolTableStack.resize(oldSymbolStackSize); |
| 979 | fEnclosingStmtStack.resize(oldEnclosingStmtStackSize); |
| 980 | } |
| 981 | |
| 982 | void visitExpression(std::unique_ptr<Expression>* expr) { |
| 983 | if (!*expr) { |
| 984 | return; |
John Stiles | 9344262 | 2020-09-11 12:11:27 -0400 | [diff] [blame] | 985 | } |
John Stiles | 70957c8 | 2020-10-02 16:42:10 -0400 | [diff] [blame] | 986 | |
| 987 | switch ((*expr)->kind()) { |
| 988 | case Expression::Kind::kBoolLiteral: |
| 989 | case Expression::Kind::kDefined: |
Brian Osman | be0b3b7 | 2021-01-06 14:27:35 -0500 | [diff] [blame] | 990 | case Expression::Kind::kExternalFunctionReference: |
John Stiles | 70957c8 | 2020-10-02 16:42:10 -0400 | [diff] [blame] | 991 | case Expression::Kind::kFieldAccess: |
| 992 | case Expression::Kind::kFloatLiteral: |
| 993 | case Expression::Kind::kFunctionReference: |
| 994 | case Expression::Kind::kIntLiteral: |
John Stiles | 70957c8 | 2020-10-02 16:42:10 -0400 | [diff] [blame] | 995 | case Expression::Kind::kSetting: |
| 996 | case Expression::Kind::kTypeReference: |
| 997 | case Expression::Kind::kVariableReference: |
| 998 | // Nothing to scan here. |
| 999 | break; |
| 1000 | |
| 1001 | case Expression::Kind::kBinary: { |
| 1002 | BinaryExpression& binaryExpr = (*expr)->as<BinaryExpression>(); |
John Stiles | 2d4f959 | 2020-10-30 10:29:12 -0400 | [diff] [blame] | 1003 | this->visitExpression(&binaryExpr.left()); |
John Stiles | 70957c8 | 2020-10-02 16:42:10 -0400 | [diff] [blame] | 1004 | |
| 1005 | // Logical-and and logical-or binary expressions do not inline the right side, |
| 1006 | // because that would invalidate short-circuiting. That is, when evaluating |
| 1007 | // expressions like these: |
| 1008 | // (false && x()) // always false |
| 1009 | // (true || y()) // always true |
| 1010 | // It is illegal for side-effects from x() or y() to occur. The simplest way to |
| 1011 | // enforce that rule is to avoid inlining the right side entirely. However, it is |
| 1012 | // safe for other types of binary expression to inline both sides. |
John Stiles | 4599050 | 2021-02-16 10:55:27 -0500 | [diff] [blame] | 1013 | Operator op = binaryExpr.getOperator(); |
| 1014 | bool shortCircuitable = (op.kind() == Token::Kind::TK_LOGICALAND || |
| 1015 | op.kind() == Token::Kind::TK_LOGICALOR); |
John Stiles | 70957c8 | 2020-10-02 16:42:10 -0400 | [diff] [blame] | 1016 | if (!shortCircuitable) { |
John Stiles | 2d4f959 | 2020-10-30 10:29:12 -0400 | [diff] [blame] | 1017 | this->visitExpression(&binaryExpr.right()); |
John Stiles | 70957c8 | 2020-10-02 16:42:10 -0400 | [diff] [blame] | 1018 | } |
| 1019 | break; |
| 1020 | } |
| 1021 | case Expression::Kind::kConstructor: { |
| 1022 | Constructor& constructorExpr = (*expr)->as<Constructor>(); |
| 1023 | for (std::unique_ptr<Expression>& arg : constructorExpr.arguments()) { |
| 1024 | this->visitExpression(&arg); |
| 1025 | } |
| 1026 | break; |
| 1027 | } |
| 1028 | case Expression::Kind::kExternalFunctionCall: { |
| 1029 | ExternalFunctionCall& funcCallExpr = (*expr)->as<ExternalFunctionCall>(); |
| 1030 | for (std::unique_ptr<Expression>& arg : funcCallExpr.arguments()) { |
| 1031 | this->visitExpression(&arg); |
| 1032 | } |
| 1033 | break; |
| 1034 | } |
| 1035 | case Expression::Kind::kFunctionCall: { |
| 1036 | FunctionCall& funcCallExpr = (*expr)->as<FunctionCall>(); |
Ethan Nicholas | 0dec992 | 2020-10-05 15:51:52 -0400 | [diff] [blame] | 1037 | for (std::unique_ptr<Expression>& arg : funcCallExpr.arguments()) { |
John Stiles | 70957c8 | 2020-10-02 16:42:10 -0400 | [diff] [blame] | 1038 | this->visitExpression(&arg); |
| 1039 | } |
| 1040 | this->addInlineCandidate(expr); |
| 1041 | break; |
| 1042 | } |
| 1043 | case Expression::Kind::kIndex:{ |
| 1044 | IndexExpression& indexExpr = (*expr)->as<IndexExpression>(); |
Ethan Nicholas | 2a4952d | 2020-10-08 15:35:56 -0400 | [diff] [blame] | 1045 | this->visitExpression(&indexExpr.base()); |
| 1046 | this->visitExpression(&indexExpr.index()); |
John Stiles | 70957c8 | 2020-10-02 16:42:10 -0400 | [diff] [blame] | 1047 | break; |
| 1048 | } |
| 1049 | case Expression::Kind::kPostfix: { |
| 1050 | PostfixExpression& postfixExpr = (*expr)->as<PostfixExpression>(); |
Ethan Nicholas | 444ccc6 | 2020-10-09 10:16:22 -0400 | [diff] [blame] | 1051 | this->visitExpression(&postfixExpr.operand()); |
John Stiles | 70957c8 | 2020-10-02 16:42:10 -0400 | [diff] [blame] | 1052 | break; |
| 1053 | } |
| 1054 | case Expression::Kind::kPrefix: { |
| 1055 | PrefixExpression& prefixExpr = (*expr)->as<PrefixExpression>(); |
Ethan Nicholas | 444ccc6 | 2020-10-09 10:16:22 -0400 | [diff] [blame] | 1056 | this->visitExpression(&prefixExpr.operand()); |
John Stiles | 70957c8 | 2020-10-02 16:42:10 -0400 | [diff] [blame] | 1057 | break; |
| 1058 | } |
| 1059 | case Expression::Kind::kSwizzle: { |
| 1060 | Swizzle& swizzleExpr = (*expr)->as<Swizzle>(); |
Ethan Nicholas | 6b4d581 | 2020-10-12 16:11:51 -0400 | [diff] [blame] | 1061 | this->visitExpression(&swizzleExpr.base()); |
John Stiles | 70957c8 | 2020-10-02 16:42:10 -0400 | [diff] [blame] | 1062 | break; |
| 1063 | } |
| 1064 | case Expression::Kind::kTernary: { |
| 1065 | TernaryExpression& ternaryExpr = (*expr)->as<TernaryExpression>(); |
| 1066 | // The test expression is a candidate for inlining. |
Ethan Nicholas | dd21816 | 2020-10-08 05:48:01 -0400 | [diff] [blame] | 1067 | this->visitExpression(&ternaryExpr.test()); |
John Stiles | 70957c8 | 2020-10-02 16:42:10 -0400 | [diff] [blame] | 1068 | // The true- and false-expressions cannot be inlined, because we are only allowed to |
| 1069 | // evaluate one side. |
| 1070 | break; |
| 1071 | } |
| 1072 | default: |
| 1073 | SkUNREACHABLE; |
| 1074 | } |
| 1075 | } |
| 1076 | |
| 1077 | void addInlineCandidate(std::unique_ptr<Expression>* candidate) { |
| 1078 | fCandidateList->fCandidates.push_back( |
| 1079 | InlineCandidate{fSymbolTableStack.back(), |
| 1080 | find_parent_statement(fEnclosingStmtStack), |
| 1081 | fEnclosingStmtStack.back(), |
| 1082 | candidate, |
John Stiles | 9b9415e | 2020-11-23 14:48:06 -0500 | [diff] [blame] | 1083 | fEnclosingFunction}); |
John Stiles | 70957c8 | 2020-10-02 16:42:10 -0400 | [diff] [blame] | 1084 | } |
John Stiles | 2d7973a | 2020-10-02 15:01:03 -0400 | [diff] [blame] | 1085 | }; |
John Stiles | 9344262 | 2020-09-11 12:11:27 -0400 | [diff] [blame] | 1086 | |
John Stiles | 9b9415e | 2020-11-23 14:48:06 -0500 | [diff] [blame] | 1087 | static const FunctionDeclaration& candidate_func(const InlineCandidate& candidate) { |
| 1088 | return (*candidate.fCandidateExpr)->as<FunctionCall>().function(); |
| 1089 | } |
John Stiles | 915a38c | 2020-09-14 09:38:13 -0400 | [diff] [blame] | 1090 | |
John Stiles | 9b9415e | 2020-11-23 14:48:06 -0500 | [diff] [blame] | 1091 | bool Inliner::candidateCanBeInlined(const InlineCandidate& candidate, InlinabilityCache* cache) { |
| 1092 | const FunctionDeclaration& funcDecl = candidate_func(candidate); |
John Stiles | 1c03d33 | 2020-10-13 10:30:23 -0400 | [diff] [blame] | 1093 | auto [iter, wasInserted] = cache->insert({&funcDecl, false}); |
John Stiles | 2d7973a | 2020-10-02 15:01:03 -0400 | [diff] [blame] | 1094 | if (wasInserted) { |
| 1095 | // Recursion is forbidden here to avoid an infinite death spiral of inlining. |
John Stiles | 1c03d33 | 2020-10-13 10:30:23 -0400 | [diff] [blame] | 1096 | iter->second = this->isSafeToInline(funcDecl.definition()) && |
| 1097 | !contains_recursive_call(funcDecl); |
John Stiles | 9344262 | 2020-09-11 12:11:27 -0400 | [diff] [blame] | 1098 | } |
| 1099 | |
John Stiles | 2d7973a | 2020-10-02 15:01:03 -0400 | [diff] [blame] | 1100 | return iter->second; |
| 1101 | } |
| 1102 | |
John Stiles | 9b9415e | 2020-11-23 14:48:06 -0500 | [diff] [blame] | 1103 | int Inliner::getFunctionSize(const FunctionDeclaration& funcDecl, FunctionSizeCache* cache) { |
| 1104 | auto [iter, wasInserted] = cache->insert({&funcDecl, 0}); |
John Stiles | 2d7973a | 2020-10-02 15:01:03 -0400 | [diff] [blame] | 1105 | if (wasInserted) { |
John Stiles | 9b9415e | 2020-11-23 14:48:06 -0500 | [diff] [blame] | 1106 | iter->second = Analysis::NodeCountUpToLimit(*funcDecl.definition(), |
John Stiles | d120464 | 2021-02-17 16:30:02 -0500 | [diff] [blame] | 1107 | this->settings().fInlineThreshold); |
John Stiles | 2d7973a | 2020-10-02 15:01:03 -0400 | [diff] [blame] | 1108 | } |
John Stiles | 2d7973a | 2020-10-02 15:01:03 -0400 | [diff] [blame] | 1109 | return iter->second; |
| 1110 | } |
| 1111 | |
Brian Osman | 0006ad0 | 2020-11-18 15:38:39 -0500 | [diff] [blame] | 1112 | void Inliner::buildCandidateList(const std::vector<std::unique_ptr<ProgramElement>>& elements, |
John Stiles | 7804758 | 2020-12-16 16:17:41 -0500 | [diff] [blame] | 1113 | std::shared_ptr<SymbolTable> symbols, ProgramUsage* usage, |
Brian Osman | 0006ad0 | 2020-11-18 15:38:39 -0500 | [diff] [blame] | 1114 | InlineCandidateList* candidateList) { |
John Stiles | 2d7973a | 2020-10-02 15:01:03 -0400 | [diff] [blame] | 1115 | // This is structured much like a ProgramVisitor, but does not actually use ProgramVisitor. |
| 1116 | // The analyzer needs to keep track of the `unique_ptr<T>*` of statements and expressions so |
| 1117 | // that they can later be replaced, and ProgramVisitor does not provide this; it only provides a |
| 1118 | // `const T&`. |
| 1119 | InlineCandidateAnalyzer analyzer; |
Brian Osman | 0006ad0 | 2020-11-18 15:38:39 -0500 | [diff] [blame] | 1120 | analyzer.visit(elements, symbols, candidateList); |
John Stiles | 2d7973a | 2020-10-02 15:01:03 -0400 | [diff] [blame] | 1121 | |
John Stiles | 0ad233f | 2020-11-25 11:02:05 -0500 | [diff] [blame] | 1122 | // Early out if there are no inlining candidates. |
John Stiles | 2d7973a | 2020-10-02 15:01:03 -0400 | [diff] [blame] | 1123 | std::vector<InlineCandidate>& candidates = candidateList->fCandidates; |
John Stiles | 0ad233f | 2020-11-25 11:02:05 -0500 | [diff] [blame] | 1124 | if (candidates.empty()) { |
| 1125 | return; |
| 1126 | } |
| 1127 | |
| 1128 | // Remove candidates that are not safe to inline. |
John Stiles | 2d7973a | 2020-10-02 15:01:03 -0400 | [diff] [blame] | 1129 | InlinabilityCache cache; |
| 1130 | candidates.erase(std::remove_if(candidates.begin(), |
| 1131 | candidates.end(), |
| 1132 | [&](const InlineCandidate& candidate) { |
| 1133 | return !this->candidateCanBeInlined(candidate, &cache); |
| 1134 | }), |
| 1135 | candidates.end()); |
| 1136 | |
John Stiles | 0ad233f | 2020-11-25 11:02:05 -0500 | [diff] [blame] | 1137 | // If the inline threshold is unlimited, or if we have no candidates left, our candidate list is |
| 1138 | // complete. |
John Stiles | d120464 | 2021-02-17 16:30:02 -0500 | [diff] [blame] | 1139 | if (this->settings().fInlineThreshold == INT_MAX || candidates.empty()) { |
John Stiles | 0ad233f | 2020-11-25 11:02:05 -0500 | [diff] [blame] | 1140 | return; |
John Stiles | 2d7973a | 2020-10-02 15:01:03 -0400 | [diff] [blame] | 1141 | } |
John Stiles | 0ad233f | 2020-11-25 11:02:05 -0500 | [diff] [blame] | 1142 | |
| 1143 | // Remove candidates on a per-function basis if the effect of inlining would be to make more |
| 1144 | // than `inlineThreshold` nodes. (i.e. if Func() would be inlined six times and its size is |
| 1145 | // 10 nodes, it should be inlined if the inlineThreshold is 60 or higher.) |
| 1146 | FunctionSizeCache functionSizeCache; |
| 1147 | FunctionSizeCache candidateTotalCost; |
| 1148 | for (InlineCandidate& candidate : candidates) { |
| 1149 | const FunctionDeclaration& fnDecl = candidate_func(candidate); |
| 1150 | candidateTotalCost[&fnDecl] += this->getFunctionSize(fnDecl, &functionSizeCache); |
| 1151 | } |
| 1152 | |
John Stiles | d120464 | 2021-02-17 16:30:02 -0500 | [diff] [blame] | 1153 | candidates.erase(std::remove_if(candidates.begin(), candidates.end(), |
| 1154 | [&](const InlineCandidate& candidate) { |
| 1155 | const FunctionDeclaration& fnDecl = candidate_func(candidate); |
| 1156 | if (fnDecl.modifiers().fFlags & Modifiers::kInline_Flag) { |
| 1157 | // Functions marked `inline` ignore size limitations. |
| 1158 | return false; |
| 1159 | } |
| 1160 | if (usage->get(fnDecl) == 1) { |
| 1161 | // If a function is only used once, it's cost-free to inline. |
| 1162 | return false; |
| 1163 | } |
| 1164 | if (candidateTotalCost[&fnDecl] <= this->settings().fInlineThreshold) { |
| 1165 | // We won't exceed the inline threshold by inlining this. |
| 1166 | return false; |
| 1167 | } |
| 1168 | // Inlining this function will add too many IRNodes. |
| 1169 | return true; |
| 1170 | }), |
| 1171 | candidates.end()); |
John Stiles | 2d7973a | 2020-10-02 15:01:03 -0400 | [diff] [blame] | 1172 | } |
| 1173 | |
Brian Osman | 0006ad0 | 2020-11-18 15:38:39 -0500 | [diff] [blame] | 1174 | bool Inliner::analyze(const std::vector<std::unique_ptr<ProgramElement>>& elements, |
John Stiles | 7804758 | 2020-12-16 16:17:41 -0500 | [diff] [blame] | 1175 | std::shared_ptr<SymbolTable> symbols, |
Brian Osman | 0006ad0 | 2020-11-18 15:38:39 -0500 | [diff] [blame] | 1176 | ProgramUsage* usage) { |
John Stiles | d34d56e | 2020-10-12 12:04:47 -0400 | [diff] [blame] | 1177 | // A threshold of zero indicates that the inliner is completely disabled, so we can just return. |
John Stiles | d120464 | 2021-02-17 16:30:02 -0500 | [diff] [blame] | 1178 | if (this->settings().fInlineThreshold <= 0) { |
John Stiles | d34d56e | 2020-10-12 12:04:47 -0400 | [diff] [blame] | 1179 | return false; |
| 1180 | } |
| 1181 | |
John Stiles | 031a767 | 2020-11-13 16:13:18 -0500 | [diff] [blame] | 1182 | // Enforce a limit on inlining to avoid pathological cases. (inliner/ExponentialGrowth.sksl) |
| 1183 | if (fInlinedStatementCounter >= kInlinedStatementLimit) { |
| 1184 | return false; |
| 1185 | } |
| 1186 | |
John Stiles | 2d7973a | 2020-10-02 15:01:03 -0400 | [diff] [blame] | 1187 | InlineCandidateList candidateList; |
John Stiles | 9b9415e | 2020-11-23 14:48:06 -0500 | [diff] [blame] | 1188 | this->buildCandidateList(elements, symbols, usage, &candidateList); |
John Stiles | 2d7973a | 2020-10-02 15:01:03 -0400 | [diff] [blame] | 1189 | |
John Stiles | 915a38c | 2020-09-14 09:38:13 -0400 | [diff] [blame] | 1190 | // Inline the candidates where we've determined that it's safe to do so. |
| 1191 | std::unordered_set<const std::unique_ptr<Statement>*> enclosingStmtSet; |
| 1192 | bool madeChanges = false; |
John Stiles | 2d7973a | 2020-10-02 15:01:03 -0400 | [diff] [blame] | 1193 | for (const InlineCandidate& candidate : candidateList.fCandidates) { |
John Stiles | 915a38c | 2020-09-14 09:38:13 -0400 | [diff] [blame] | 1194 | FunctionCall& funcCall = (*candidate.fCandidateExpr)->as<FunctionCall>(); |
John Stiles | 915a38c | 2020-09-14 09:38:13 -0400 | [diff] [blame] | 1195 | |
| 1196 | // Inlining two expressions using the same enclosing statement in the same inlining pass |
| 1197 | // does not work properly. If this happens, skip it; we'll get it in the next pass. |
| 1198 | auto [unusedIter, inserted] = enclosingStmtSet.insert(candidate.fEnclosingStmt); |
| 1199 | if (!inserted) { |
| 1200 | continue; |
| 1201 | } |
| 1202 | |
| 1203 | // Convert the function call to its inlined equivalent. |
Brian Osman | 3887a01 | 2020-09-30 13:22:27 -0400 | [diff] [blame] | 1204 | InlinedCall inlinedCall = this->inlineCall(&funcCall, candidate.fSymbols, |
Ethan Nicholas | 0a5d096 | 2020-10-14 13:33:18 -0400 | [diff] [blame] | 1205 | &candidate.fEnclosingFunction->declaration()); |
John Stiles | 915a38c | 2020-09-14 09:38:13 -0400 | [diff] [blame] | 1206 | |
John Stiles | 0c2d14a | 2021-03-01 10:08:08 -0500 | [diff] [blame] | 1207 | // Stop if an error was detected during the inlining process. |
| 1208 | if (!inlinedCall.fInlinedBody && !inlinedCall.fReplacementExpr) { |
| 1209 | break; |
John Stiles | 915a38c | 2020-09-14 09:38:13 -0400 | [diff] [blame] | 1210 | } |
| 1211 | |
John Stiles | 0c2d14a | 2021-03-01 10:08:08 -0500 | [diff] [blame] | 1212 | // Ensure that the inlined body has a scope if it needs one. |
| 1213 | this->ensureScopedBlocks(inlinedCall.fInlinedBody.get(), candidate.fParentStmt->get()); |
| 1214 | |
| 1215 | // Add references within the inlined body |
| 1216 | usage->add(inlinedCall.fInlinedBody.get()); |
| 1217 | |
| 1218 | // Move the enclosing statement to the end of the unscoped Block containing the inlined |
| 1219 | // function, then replace the enclosing statement with that Block. |
| 1220 | // Before: |
| 1221 | // fInlinedBody = Block{ stmt1, stmt2, stmt3 } |
| 1222 | // fEnclosingStmt = stmt4 |
| 1223 | // After: |
| 1224 | // fInlinedBody = null |
| 1225 | // fEnclosingStmt = Block{ stmt1, stmt2, stmt3, stmt4 } |
| 1226 | inlinedCall.fInlinedBody->children().push_back(std::move(*candidate.fEnclosingStmt)); |
| 1227 | *candidate.fEnclosingStmt = std::move(inlinedCall.fInlinedBody); |
| 1228 | |
John Stiles | 915a38c | 2020-09-14 09:38:13 -0400 | [diff] [blame] | 1229 | // Replace the candidate function call with our replacement expression. |
Brian Osman | 010ce6a | 2020-10-19 16:34:10 -0400 | [diff] [blame] | 1230 | usage->replace(candidate.fCandidateExpr->get(), inlinedCall.fReplacementExpr.get()); |
John Stiles | 915a38c | 2020-09-14 09:38:13 -0400 | [diff] [blame] | 1231 | *candidate.fCandidateExpr = std::move(inlinedCall.fReplacementExpr); |
| 1232 | madeChanges = true; |
| 1233 | |
John Stiles | 031a767 | 2020-11-13 16:13:18 -0500 | [diff] [blame] | 1234 | // Stop inlining if we've reached our hard cap on new statements. |
| 1235 | if (fInlinedStatementCounter >= kInlinedStatementLimit) { |
| 1236 | break; |
| 1237 | } |
| 1238 | |
John Stiles | 915a38c | 2020-09-14 09:38:13 -0400 | [diff] [blame] | 1239 | // Note that nothing was destroyed except for the FunctionCall. All other nodes should |
| 1240 | // remain valid. |
| 1241 | } |
| 1242 | |
| 1243 | return madeChanges; |
John Stiles | 9344262 | 2020-09-11 12:11:27 -0400 | [diff] [blame] | 1244 | } |
| 1245 | |
John Stiles | 44e96be | 2020-08-31 13:16:04 -0400 | [diff] [blame] | 1246 | } // namespace SkSL |