{"commit":{"revision":"c1c30889cc2fa92b92a477994bc5e91b16d888c3","authoredAt":"2023-01-20T14:01:51+00:00","shortRevision":"c1c30889cc","authorEmail":"gsathya.ceg@gmail.com","authorName":"Sathya Gunasekaran","subject":"[hir] Lower function expressions into HIR"},"patch":"diff --git a\/compiler\/forget\/src\/CompilerPipeline.ts b\/compiler\/forget\/src\/CompilerPipeline.ts\nindex e78516d424..deaeef6d30 100644\n--- a\/compiler\/forget\/src\/CompilerPipeline.ts\n+++ b\/compiler\/forget\/src\/CompilerPipeline.ts\n@@ -13,7 +13,11 @@ import {\n mergeConsecutiveBlocks,\n ReactiveFunction,\n } from \".\/HIR\";\n-import { inferMutableRanges, inferReferenceEffects } from \".\/Inference\";\n+import {\n+ analyseFunctions,\n+ inferMutableRanges,\n+ inferReferenceEffects,\n+} from \".\/Inference\";\n import { constantPropagation } from \".\/Optimization\";\n import {\n alignReactiveScopesToBlockScopes,\n@@ -65,6 +69,9 @@ export function* run(\n inferTypes(hir);\n yield log({ kind: \"hir\", name: \"InferTypes\", value: hir });\n \n+ analyseFunctions(hir);\n+ yield log({ kind: \"hir\", name: \"analyseFunctions\", value: hir });\n+\n inferReferenceEffects(hir);\n yield log({ kind: \"hir\", name: \"InferReferenceEffects\", value: hir });\n \n@@ -163,7 +170,7 @@ export function compile(func: NodePath): t.Function {\n }\n }\n \n-function log(value: CompilerPipelineValue): CompilerPipelineValue {\n+export function log(value: CompilerPipelineValue): CompilerPipelineValue {\n switch (value.kind) {\n case \"ast\": {\n break;\ndiff --git a\/compiler\/forget\/src\/HIR\/BuildHIR.ts b\/compiler\/forget\/src\/HIR\/BuildHIR.ts\nindex e44efa1507..e802cfd292 100644\n--- a\/compiler\/forget\/src\/HIR\/BuildHIR.ts\n+++ b\/compiler\/forget\/src\/HIR\/BuildHIR.ts\n@@ -1216,6 +1216,18 @@ function lowerExpression(\n componentScope\n );\n const body = expr.get(\"body\").node;\n+ const lowering = lower(expr);\n+ let loweredFunc: HIRFunction;\n+ if (lowering.isErr()) {\n+ lowering.unwrapErr().forEach((e) => builder.pushError(e));\n+ return {\n+ kind: \"OtherStatement\",\n+ node: expr.node,\n+ loc: exprLoc,\n+ };\n+ }\n+ loweredFunc = lowering.unwrap();\n+\n const params: Array = expr.get(\"params\").map((p) => {\n todoInvariant(p.isIdentifier(), \"handle non identifier params\");\n return p.node.name;\n@@ -1225,7 +1237,9 @@ function lowerExpression(\n name,\n body,\n params,\n+ loweredFunc,\n dependencies,\n+ mutatedDeps: [],\n loc: exprLoc,\n };\n }\ndiff --git a\/compiler\/forget\/src\/HIR\/HIR.ts b\/compiler\/forget\/src\/HIR\/HIR.ts\nindex 185cc007f6..9141a5c8b7 100644\n--- a\/compiler\/forget\/src\/HIR\/HIR.ts\n+++ b\/compiler\/forget\/src\/HIR\/HIR.ts\n@@ -403,6 +403,10 @@ export type InstructionData =\n name: string | null;\n params: Array;\n dependencies: Array;\n+ \/\/ TODO(gsn): Remove this mutatedDeps array and use dependencies as single\n+ \/\/ source of truth.\n+ mutatedDeps: Array;\n+ loweredFunc: HIRFunction;\n body: t.BlockStatement;\n }\n \n@@ -413,7 +417,11 @@ export type InstructionData =\n *\/\n | {\n kind: \"OtherStatement\";\n- node: t.Statement | t.JSXSpreadChild | t.JSXFragment;\n+ node:\n+ | t.Statement\n+ | t.JSXSpreadChild\n+ | t.JSXFragment\n+ | t.FunctionExpression;\n };\n \n \/**\ndiff --git a\/compiler\/forget\/src\/Inference\/AnalyseFunctions.ts b\/compiler\/forget\/src\/Inference\/AnalyseFunctions.ts\nnew file mode 100644\nindex 0000000000..ce245a5a20\n--- \/dev\/null\n+++ b\/compiler\/forget\/src\/Inference\/AnalyseFunctions.ts\n@@ -0,0 +1,128 @@\n+import {\n+ Effect,\n+ HIRFunction,\n+ Identifier,\n+ mergeConsecutiveBlocks,\n+ Place,\n+} from \"..\/HIR\";\n+import { eachInstructionOperand } from \"..\/HIR\/visitors\";\n+import { constantPropagation } from \"..\/Optimization\";\n+import { eliminateRedundantPhi, enterSSA } from \"..\/SSA\";\n+import { inferTypes } from \"..\/TypeInference\";\n+import { logHIRFunction } from \"..\/Utils\/logger\";\n+import { inferMutableRanges } from \".\/InferMutableRanges\";\n+import inferReferenceEffects from \".\/InferReferenceEffects\";\n+\n+type Dependency = {\n+ place: Place;\n+ path: Array | null;\n+};\n+\n+function declareProperty(\n+ properties: Map,\n+ lvalue: Place,\n+ object: Place,\n+ property: string\n+): void {\n+ const objectDependency = properties.get(object.identifier);\n+ let nextDependency: Dependency;\n+ if (objectDependency === undefined) {\n+ nextDependency = { place: object, path: [property] };\n+ } else {\n+ nextDependency = {\n+ place: objectDependency.place,\n+ path: [...(objectDependency.path ?? []), property],\n+ };\n+ }\n+ properties.set(lvalue.identifier, nextDependency);\n+}\n+\n+export default function (func: HIRFunction) {\n+ const properties: Map = new Map();\n+\n+ for (const [_, block] of func.body.blocks) {\n+ for (const instr of block.instructions) {\n+ switch (instr.value.kind) {\n+ case \"FunctionExpression\": {\n+ instr.value.mutatedDeps = buildMutatedDeps(\n+ analyzeMutatedPlaces(instr.value.loweredFunc),\n+ instr.value.dependencies,\n+ properties\n+ );\n+ break;\n+ }\n+ case \"PropertyLoad\": {\n+ declareProperty(\n+ properties,\n+ instr.lvalue.place,\n+ instr.value.object,\n+ instr.value.property\n+ );\n+ }\n+ }\n+ }\n+ }\n+}\n+\n+function buildMutatedDeps(\n+ mutations: Place[],\n+ capturedDeps: Place[],\n+ properties: Map\n+): Place[] {\n+ const mutatedIds: Set = new Set(\n+ mutations\n+ .map((m) => m.identifier.name)\n+ .filter((m) => m !== null) as string[]\n+ );\n+ const mutatedDeps: Place[] = [];\n+\n+ for (const dep of capturedDeps) {\n+ if (properties.has(dep.identifier)) {\n+ let captured = properties.get(dep.identifier)!;\n+ let name = captured.place.identifier.name;\n+\n+ if (name === null || !mutatedIds.has(name)) {\n+ continue;\n+ }\n+\n+ mutatedDeps.push(dep);\n+ }\n+ }\n+\n+ return mutatedDeps;\n+}\n+\n+function analyzeMutatedPlaces(func: HIRFunction): Array {\n+ mergeConsecutiveBlocks(func);\n+ enterSSA(func);\n+ eliminateRedundantPhi(func);\n+ constantPropagation(func);\n+ inferTypes(func);\n+ inferReferenceEffects(func);\n+ inferMutableRanges(func);\n+ logHIRFunction(\"AnalyseFunction (inner)\", func);\n+\n+ const mutations: Array = [];\n+ for (const [_, block] of func.body.blocks) {\n+ for (const instr of block.instructions) {\n+ if (\n+ instr.value.kind === \"FunctionExpression\" &&\n+ instr.value.loweredFunc !== null\n+ ) {\n+ mutations.push(...analyzeMutatedPlaces(instr.value.loweredFunc));\n+ }\n+\n+ for (const operand of eachInstructionOperand(instr)) {\n+ if (isMutated(operand)) {\n+ mutations.push(operand);\n+ }\n+ }\n+ }\n+ }\n+\n+ return mutations;\n+}\n+\n+function isMutated(place: Place): boolean {\n+ return place.effect === Effect.Mutate || place.effect === Effect.Store;\n+}\ndiff --git a\/compiler\/forget\/src\/Inference\/InferAliasForStores.ts b\/compiler\/forget\/src\/Inference\/InferAliasForStores.ts\nindex a98e013dba..3faf282942 100644\n--- a\/compiler\/forget\/src\/Inference\/InferAliasForStores.ts\n+++ b\/compiler\/forget\/src\/Inference\/InferAliasForStores.ts\n@@ -46,6 +46,11 @@ export function inferAliasForStores(\n maybeAlias(aliases, value.object, value.value, instr.id);\n break;\n }\n+ case \"FunctionExpression\": {\n+ for (const dep of value.mutatedDeps) {\n+ maybeAlias(aliases, lvalue.place, dep, instr.id);\n+ }\n+ }\n }\n }\n }\ndiff --git a\/compiler\/forget\/src\/Inference\/InferReferenceEffects.ts b\/compiler\/forget\/src\/Inference\/InferReferenceEffects.ts\nindex 5539035862..5d9c2e11ac 100644\n--- a\/compiler\/forget\/src\/Inference\/InferReferenceEffects.ts\n+++ b\/compiler\/forget\/src\/Inference\/InferReferenceEffects.ts\n@@ -211,11 +211,10 @@ class Environment {\n *\/\n alias(place: Place, value: Place) {\n const values = this.#variables.get(value.identifier.id);\n- invariant(\n- values != null,\n- \"Expected value for identifier `%s` to be initialized.\",\n- value.identifier.id\n- );\n+ \/\/ A value can be undefined if it has been captured from outside scope.\n+ if (value === undefined) {\n+ return;\n+ }\n this.#variables.set(place.identifier.id, new Set(values));\n }\n \ndiff --git a\/compiler\/forget\/src\/Inference\/index.ts b\/compiler\/forget\/src\/Inference\/index.ts\nindex e6508e1fae..907516d3c9 100644\n--- a\/compiler\/forget\/src\/Inference\/index.ts\n+++ b\/compiler\/forget\/src\/Inference\/index.ts\n@@ -6,4 +6,5 @@\n *\/\n \n export { inferMutableRanges } from \".\/InferMutableRanges\";\n+export { default as analyseFunctions } from \".\/AnalyseFunctions\";\n export { default as inferReferenceEffects } from \".\/InferReferenceEffects\";\ndiff --git a\/compiler\/forget\/src\/__tests__\/fixtures\/hir\/capturing-func-mutate-2.expect.md b\/compiler\/forget\/src\/__tests__\/fixtures\/hir\/capturing-func-mutate-2.expect.md\nnew file mode 100644\nindex 0000000000..78d77d3417\n--- \/dev\/null\n+++ b\/compiler\/forget\/src\/__tests__\/fixtures\/hir\/capturing-func-mutate-2.expect.md\n@@ -0,0 +1,52 @@\n+\n+## Input\n+\n+```javascript\n+function component(a, b) {\n+ let y = { b };\n+ let z = { a };\n+ let x = function () {\n+ z.a = 2;\n+ y.b;\n+ };\n+ x();\n+ return x;\n+}\n+\n+```\n+\n+## Code\n+\n+```javascript\n+function component(a, b) {\n+ const $ = React.useMemoCache();\n+ const c_0 = $[0] !== b;\n+ let y;\n+ if (c_0) {\n+ y = { b: b };\n+ $[0] = b;\n+ $[1] = y;\n+ } else {\n+ y = $[1];\n+ }\n+ const c_2 = $[2] !== a;\n+ const c_3 = $[3] !== y.b;\n+ let x;\n+ if (c_2 || c_3) {\n+ const z = { a: a };\n+ x = function () {\n+ z.a = 2;\n+ y.b;\n+ };\n+ x();\n+ $[2] = a;\n+ $[3] = y.b;\n+ $[4] = x;\n+ } else {\n+ x = $[4];\n+ }\n+ return x;\n+}\n+\n+```\n+ \n\\ No newline at end of file\ndiff --git a\/compiler\/forget\/src\/__tests__\/fixtures\/hir\/capturing-func-mutate-2.js b\/compiler\/forget\/src\/__tests__\/fixtures\/hir\/capturing-func-mutate-2.js\nnew file mode 100644\nindex 0000000000..31cc3c63de\n--- \/dev\/null\n+++ b\/compiler\/forget\/src\/__tests__\/fixtures\/hir\/capturing-func-mutate-2.js\n@@ -0,0 +1,10 @@\n+function component(a, b) {\n+ let y = { b };\n+ let z = { a };\n+ let x = function () {\n+ z.a = 2;\n+ y.b;\n+ };\n+ x();\n+ return x;\n+}\ndiff --git a\/compiler\/forget\/src\/__tests__\/fixtures\/hir\/capturing-func-mutate-3.expect.md b\/compiler\/forget\/src\/__tests__\/fixtures\/hir\/capturing-func-mutate-3.expect.md\nnew file mode 100644\nindex 0000000000..ab9bf89617\n--- \/dev\/null\n+++ b\/compiler\/forget\/src\/__tests__\/fixtures\/hir\/capturing-func-mutate-3.expect.md\n@@ -0,0 +1,58 @@\n+\n+## Input\n+\n+```javascript\n+function component(a, b) {\n+ let y = { b };\n+ let z = { a };\n+ let x = function () {\n+ z.a = 2;\n+ y.b;\n+ };\n+ return x;\n+}\n+\n+```\n+\n+## Code\n+\n+```javascript\n+function component(a, b) {\n+ const $ = React.useMemoCache();\n+ const c_0 = $[0] !== b;\n+ let y;\n+ if (c_0) {\n+ y = { b: b };\n+ $[0] = b;\n+ $[1] = y;\n+ } else {\n+ y = $[1];\n+ }\n+ const c_2 = $[2] !== a;\n+ let z;\n+ if (c_2) {\n+ z = { a: a };\n+ $[2] = a;\n+ $[3] = z;\n+ } else {\n+ z = $[3];\n+ }\n+ const c_4 = $[4] !== z.a;\n+ const c_5 = $[5] !== y.b;\n+ let x;\n+ if (c_4 || c_5) {\n+ x = function () {\n+ z.a = 2;\n+ y.b;\n+ };\n+ $[4] = z.a;\n+ $[5] = y.b;\n+ $[6] = x;\n+ } else {\n+ x = $[6];\n+ }\n+ return x;\n+}\n+\n+```\n+ \n\\ No newline at end of file\ndiff --git a\/compiler\/forget\/src\/__tests__\/fixtures\/hir\/capturing-func-mutate-3.js b\/compiler\/forget\/src\/__tests__\/fixtures\/hir\/capturing-func-mutate-3.js\nnew file mode 100644\nindex 0000000000..4468bd6d61\n--- \/dev\/null\n+++ b\/compiler\/forget\/src\/__tests__\/fixtures\/hir\/capturing-func-mutate-3.js\n@@ -0,0 +1,9 @@\n+function component(a, b) {\n+ let y = { b };\n+ let z = { a };\n+ let x = function () {\n+ z.a = 2;\n+ y.b;\n+ };\n+ return x;\n+}\ndiff --git a\/compiler\/forget\/src\/__tests__\/fixtures\/hir\/capturing-func-mutate-nested.js b\/compiler\/forget\/src\/__tests__\/fixtures\/hir\/capturing-func-mutate-nested.js\nnew file mode 100644\nindex 0000000000..9ad43aeb80\n--- \/dev\/null\n+++ b\/compiler\/forget\/src\/__tests__\/fixtures\/hir\/capturing-func-mutate-nested.js\n@@ -0,0 +1,10 @@\n+\/\/ @skip\n+\/\/ TODO(gsn): This doesn't seem to work correctly. Need to debug more.\n+function component(a) {\n+ let y = { b: { a } };\n+ let x = function () {\n+ y.b.a = 2;\n+ };\n+ x();\n+ return x;\n+}\ndiff --git a\/compiler\/forget\/src\/__tests__\/fixtures\/hir\/capturing-func-mutate.expect.md b\/compiler\/forget\/src\/__tests__\/fixtures\/hir\/capturing-func-mutate.expect.md\nnew file mode 100644\nindex 0000000000..b7996102f7\n--- \/dev\/null\n+++ b\/compiler\/forget\/src\/__tests__\/fixtures\/hir\/capturing-func-mutate.expect.md\n@@ -0,0 +1,52 @@\n+\n+## Input\n+\n+```javascript\n+function component(a, b) {\n+ let z = { a };\n+ let y = { b };\n+ let x = function () {\n+ z.a = 2;\n+ y.b;\n+ };\n+ x();\n+ return x;\n+}\n+\n+```\n+\n+## Code\n+\n+```javascript\n+function component(a, b) {\n+ const $ = React.useMemoCache();\n+ const c_0 = $[0] !== a;\n+ const c_1 = $[1] !== b;\n+ let x;\n+ if (c_0 || c_1) {\n+ const z = { a: a };\n+ const c_3 = $[3] !== b;\n+ let y;\n+ if (c_3) {\n+ y = { b: b };\n+ $[3] = b;\n+ $[4] = y;\n+ } else {\n+ y = $[4];\n+ }\n+ x = function () {\n+ z.a = 2;\n+ y.b;\n+ };\n+ x();\n+ $[0] = a;\n+ $[1] = b;\n+ $[2] = x;\n+ } else {\n+ x = $[2];\n+ }\n+ return x;\n+}\n+\n+```\n+ \n\\ No newline at end of file\ndiff --git a\/compiler\/forget\/src\/__tests__\/fixtures\/hir\/capturing-func-mutate.js b\/compiler\/forget\/src\/__tests__\/fixtures\/hir\/capturing-func-mutate.js\nnew file mode 100644\nindex 0000000000..3cbb540d16\n--- \/dev\/null\n+++ b\/compiler\/forget\/src\/__tests__\/fixtures\/hir\/capturing-func-mutate.js\n@@ -0,0 +1,10 @@\n+function component(a, b) {\n+ let z = { a };\n+ let y = { b };\n+ let x = function () {\n+ z.a = 2;\n+ y.b;\n+ };\n+ x();\n+ return x;\n+}\ndiff --git a\/compiler\/forget\/src\/__tests__\/fixtures\/hir\/capturing-var-in-nested-func-decl.js b\/compiler\/forget\/src\/__tests__\/fixtures\/hir\/capturing-var-in-nested-func-decl.js\nindex c600600ca4..5f6559dd33 100644\n--- a\/compiler\/forget\/src\/__tests__\/fixtures\/hir\/capturing-var-in-nested-func-decl.js\n+++ b\/compiler\/forget\/src\/__tests__\/fixtures\/hir\/capturing-var-in-nested-func-decl.js\n@@ -1,3 +1,4 @@\n+\/\/ @skip -- TODO: support lowering Function Declaration in HIR\n function component(a) {\n let z = { a };\n let x = function () {\n","files":[{"status":"M","path":"compiler\/forget\/src\/CompilerPipeline.ts"},{"status":"M","path":"compiler\/forget\/src\/HIR\/BuildHIR.ts"},{"status":"M","path":"compiler\/forget\/src\/HIR\/HIR.ts"},{"status":"A","path":"compiler\/forget\/src\/Inference\/AnalyseFunctions.ts"},{"status":"M","path":"compiler\/forget\/src\/Inference\/InferAliasForStores.ts"},{"status":"M","path":"compiler\/forget\/src\/Inference\/InferReferenceEffects.ts"},{"status":"M","path":"compiler\/forget\/src\/Inference\/index.ts"},{"status":"A","path":"compiler\/forget\/src\/__tests__\/fixtures\/hir\/capturing-func-mutate-2.expect.md"},{"status":"A","path":"compiler\/forget\/src\/__tests__\/fixtures\/hir\/capturing-func-mutate-2.js"},{"status":"A","path":"compiler\/forget\/src\/__tests__\/fixtures\/hir\/capturing-func-mutate-3.expect.md"},{"status":"A","path":"compiler\/forget\/src\/__tests__\/fixtures\/hir\/capturing-func-mutate-3.js"},{"status":"A","path":"compiler\/forget\/src\/__tests__\/fixtures\/hir\/capturing-func-mutate-nested.js"},{"status":"A","path":"compiler\/forget\/src\/__tests__\/fixtures\/hir\/capturing-func-mutate.expect.md"},{"status":"A","path":"compiler\/forget\/src\/__tests__\/fixtures\/hir\/capturing-func-mutate.js"},{"status":"M","path":"compiler\/forget\/src\/__tests__\/fixtures\/hir\/capturing-var-in-nested-func-decl.js"}],"body":"","parents":["b3fedd32735925b0514b452a1882f4efa076ff98"]}

dillon1000/react

Files changed