trending/scriptc
1
0
Fork 0
mirror of https://github.com/vercel-labs/scriptc.git synced 2026-11-07 08:33:50 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge main

Browse Source
This commit is contained in:
Chris Tate
2026-10-18 18:58:47 -05:00
parent 4bfced6008 6dff370714
commit 9414bdc5fe
320 changed files with 9886 additions and 861 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.gitignore
+2
View File
@@ -9,6 +9,7 @@ node_modules/
!tests/corpus/*/node_modules/
!tests/fixtures/npm-static/node_modules/
!tests/fixtures/npm-static/nested/inner/node_modules/
!tests/fixtures/npm-static/node_modules/*/node_modules/
!tests/fixtures/npm/store/*/node_modules/
!tests/fixtures/npm/cases/*/node_modules/
!tests/library-mode/*/node_modules/
@@ -32,6 +33,7 @@ output/
!tests/fixtures/npm/cases/workspace-copied/members/*/dist/
!tests/fixtures/npm/cases/workspace-copied/node_modules/*/dist/
!tests/fixtures/provenance/node_modules/*/dist/
!tests/fixtures/npm-static/node_modules/*/dist/
.scriptc/
*.log
.DS_Store
docs/content/docs/cli.mdx
+7 -1
View File
@@ -119,7 +119,7 @@ Verifies and loads the installed precompiled runtime objects and vendored librar
<dd>On Linux, when the program calls <code>process.exit()</code>, hand the release of its memory to a helper process so the parent sees the exit sooner. The kernel otherwise frees the whole address space before the exit is reported, which takes tens of milliseconds per gigabyte. Opt in only where the trade-offs are acceptable: for up to about 100 ms after the exit, the helper keeps the executable mapped (overwriting the binary in place fails with "text file busy"), its memory stays charged to the cgroup, and the teardown CPU time no longer appears in the parent's resource usage. Valid only for executable builds; it has no effect on other platforms.</dd>
<dt><code>--npm-static &lt;pkg[,pkg…]|auto&gt;</code></dt>
<dd>Name npm packages to compile even if they don't ship their own type declarations (repeatable). <code>auto</code> uses the default automatic selection. Packages that can't compile produce diagnostics. See <a href="/docs/dependencies#explicit-package-selection">npm Dependencies</a>.</dd>
<dd>Name npm packages to compile even if they don't ship their own type declarations (repeatable). A trailing <code>...</code>, as in <code>fs-extra...</code>, also names every package that package depends on. <code>auto</code> uses the default automatic selection. Packages that can't compile produce diagnostics. See <a href="/docs/dependencies#explicit-package-selection">npm Dependencies</a>.</dd>
<dt><code>--provenance-sources</code></dt>
<dd>Experimental. Compile npm dependencies from the source at the commit their provenance attestation names. Packages without a usable attestation compile from their installed files.</dd>
@@ -127,6 +127,12 @@ Verifies and loads the installed precompiled runtime objects and vendored librar
<dt><code>--external-types &lt;specifier=file.d.ts&gt;</code></dt>
<dd>Coverage only. Map an exact bare module specifier to a local declaration file supplied by an embedder. Repeat the option for multiple modules. The declaration supplies checker types so application coverage can continue; runtime imports and values remain explicit <code>SC1010</code> blockers. Relative paths resolve from the current working directory. Accepted files end in <code>.d.ts</code>, <code>.d.mts</code>, or <code>.d.cts</code>.</dd>
<dt><code>--tier &lt;auto|static-only&gt;</code></dt>
<dd>The tier policy for code that has no static lowering. <code>auto</code> is the default. <code>static-only</code> guarantees that the program contains no dynamic-tier demotions: every such construct stays a compile error in TypeScript and a deferred runtime error in JavaScript, which is how both modes behave today. Use it in CI to keep a program fully static. Library mode is always static-only. See <a href="/docs/coverage#dynamic-tier">Dynamic tier</a>.</dd>
<dt><code>--explain-dynamic[=&lt;name&gt;]</code></dt>
<dd>Coverage only. After the report, list the functions that already operate on values typed only at runtime and the bindings, fields, functions, classes and modules that unsupported constructs would move to the dynamic tier, each with the diagnostic behind it. With a name such as <code>x</code>, <code>Point</code>, or <code>Point.x</code>, show only the matching units. See <a href="/docs/coverage#dynamic-tier">Dynamic tier</a>.</dd>
<dt><code>--sanitize</code></dt>
<dd>Build an executable with AddressSanitizer and a reference-count audit at exit, the same checks scriptc's own test suite uses. Requires a C compiler and is available only for host builds. Not supported with <code>--emit=asm</code> or <code>--emit=obj</code>.</dd>
docs/content/docs/coverage.mdx
+12 -1
View File
@@ -36,6 +36,7 @@ When a program has unsupported operations, the report adds a group for each root
<tbody>
<tr><td><code>statements analyzed</code></td><td>Executable statements in application code, excluding dependency implementation code.</td></tr>
<tr><td><code>compile statically</code></td><td>Statements that compile to native instructions.</td></tr>
<tr><td><code>in dynamic tier</code></td><td>Of those, the statements in functions that operate on values typed only at runtime, such as <code>any</code> values and untyped JavaScript. Shown when there are any. See <a href="#dynamic-tier">Dynamic tier</a>.</td></tr>
<tr><td><code>blockers</code></td><td>Unsupported operations with counts, diagnostic codes, reasons, locations, and hints.</td></tr>
<tr><td><code>in unreached code</code></td><td>Blockers in code the entry never reaches. A build never compiles that code, so these cannot fail it.</td></tr>
<tr><td><code>differs from Node</code></td><td>Sites that compile but can behave differently from Node.js. See <a href="#node-divergences">Node divergences</a>.</td></tr>
@@ -51,6 +52,16 @@ If a function's signature can't compile, the statements in its body count as not
<span id="analyze-with-dynamic" />
<span id="embedded-nodejs-builtins" />
<span id="dynamic-tier" />
## Dynamic tier
Code that operates on values whose types are known only at runtime, such as `any` values, the result of an untyped `JSON.parse`, or untyped JavaScript, compiles into dynamic-tier functions. They are native code too, but they check types and look up properties at runtime, so they are slower than code with static types. The report's `in dynamic tier` line counts their statements.
`--explain-dynamic` lists those functions and the operation that makes each one dynamic. It also lists the units an unsupported construct would move to the dynamic tier: the binding, field, class, function, or module that has no static representation for the construct, with the diagnostic behind each one. These are the constructs the dynamic tier is planned to compile; today they remain blockers in TypeScript and deferred runtime errors in JavaScript. Add a name, such as `--explain-dynamic=Point`, to show only the matching units. With `--print=diagnostics`, the document gains a `tiers` object with the same information.
`--tier=static-only` keeps every unsupported construct a blocker instead of moving it to the dynamic tier; code that already operates on runtime-typed values compiles as before. Today `auto`, the default, behaves the same way.
## Diagnostic codes
Coverage and `scriptc build` report the same diagnostic codes. Common ones include:
@@ -159,7 +170,7 @@ For editors, CI annotations, and other tools, `scriptc coverage --print=diagnost
</tr>
<tr>
<td><code>stats</code></td>
<td>Coverage only, absent after a preflight failure: the report's statement counts. <code>statementsDynamic</code> is always 0 and remains for schema compatibility.</td>
<td>Coverage only, absent after a preflight failure: the report's statement counts. <code>statementsStatic</code> counts every statement that compiles to native code; <code>statementsDynamic</code> is the part of those in dynamic-tier functions.</td>
</tr>
<tr>
<td><code>category</code></td>
docs/content/docs/dependencies.mdx
+4 -2
View File
@@ -46,6 +46,8 @@ Your callback and the commander implementation both compile to native code. No e
scriptc finds packages in `node_modules` with Node.js's resolution rules, including the export conditions in `package.json`, and compiles their dependencies too. TypeScript workspace packages compile as part of your program, including `.js` import specifiers that resolve to `.ts` sources.
Type-only imports follow Node.js's type stripping. `import type` and `export type … from` statements are erased, so a package or module named only by them supplies types and isn't compiled or loaded; it can even be a package with no JavaScript, such as `type-fest`. A clause whose specifiers are all marked `type`, such as `import { type Options } from "./config.ts"`, still loads its module, as it does under Node.js.
## Which packages compile
scriptc compiles a package automatically when it:
@@ -53,7 +55,7 @@ scriptc compiles a package automatically when it:
- ships its own type declarations, and
- ships readable, unminified JavaScript.
A package that doesn't meet these requirements, or that uses something scriptc can't compile, gets a package-specific diagnostic that explains why. The usual fixes are to switch to a version or alternative package that compiles, or to replace the call with code you write yourself.
A package that doesn't meet these requirements, or that uses something scriptc can't compile, gets a package-specific diagnostic that explains why. The usual fixes are to switch to a version or alternative package that compiles, or to replace the call with code you write yourself. A package whose declarations come from a separate `@types/` package doesn't ship its own; its diagnostic names the package and the `--npm-static` option that compiles it anyway.
<span id="value-conversion" />
<span id="static-package-compilation-experimental" />
@@ -67,7 +69,7 @@ Some packages rely on separately installed declarations, such as an `@types/` pa
$ scriptc build app.ts --npm-static=three -o app >/dev/null
```
Naming a package skips the declaration requirement above, but the package still has to compile. `--npm-static=auto` uses the default automatic selection. The option accepts a comma-separated list and can be repeated.
Naming a package skips the declaration requirement above, but the package still has to compile. The option selects only the packages it names: a dependency of a named package that doesn't ship its own declarations is still refused. Add a trailing `...` to select a package together with every package it depends on, for example `--npm-static=fs-extra...`. `--npm-static=auto` uses the default automatic selection. The option accepts a comma-separated list and can be repeated.
## CommonJS packages
docs/content/docs/limitations.mdx
+2
View File
@@ -76,6 +76,8 @@ title: "Limitations"
<include>../limitations/builtin-apis/legacy-url-api.mdx</include>
<include>../limitations/builtin-apis/deprecated-modules.mdx</include>
<include>../limitations/builtin-apis/filesystem-flags.mdx</include>
<include>../limitations/builtin-apis/copy.mdx</include>
docs/content/limitations/builtin-apis/deprecated-modules.mdx
+1
View File
@@ -0,0 +1 @@
- **Deprecated `punycode` and `constants` modules:** `punycode.encode()`, `decode()`, `toASCII()`, `toUnicode()`, `ucs2.decode()`, `ucs2.encode()`, and `version` compile, with the `DEP0040` warning Node.js reports when the module loads. A `require("punycode")` made from inside `node_modules` doesn't warn; a `require()` used inside a larger expression, such as `require("punycode").toASCII(name)`, doesn't warn either. The `punycode.ucs2` object itself is unsupported as a value. The `constants` module is the frozen object Node.js builds from `os.constants` and `fs.constants`, plus the `crypto.constants` of Node.js 24.22.0.
docs/content/limitations/types-and-class-definitions/local-class-expressions.mdx
+1 -1
View File
@@ -1 +1 @@
- **Local class expressions:** Static members, decorators, private brands, generic members, explicitly generic factories returning local constructors, and references through the class's internal name are unsupported. Supported expressions preserve fresh constructor identity and shared captures across constructors, methods, accessors, and arrow fields. Local inheritance requires a compiled base class. Constructors retain identity, `typeof`, `name`, and `length` through `unknown`; cast back to their exact type before construction. Construction and static-member access directly through `unknown` are unsupported.
- **Local class expressions:** Static members, decorators, private brands, generic members, and references through the class's internal name are unsupported. Supported expressions preserve fresh constructor identity and shared captures across constructors, methods, accessors, and arrow fields. Local inheritance requires a compiled base class. Constructors retain identity, `typeof`, `name`, and `length` through `unknown`; cast back to their exact type before construction. Construction and static-member access directly through `unknown` are unsupported.
docs/src/generated/node-v24-compatibility-meta.json
+1 -1
View File
@@ -2,6 +2,6 @@
"schemaVersion": 3,
"nodeVersion": "24.22.0",
"nodeCommit": "f14cd3aa7bf9ca8df2cc5b8bb14beb0f335b1d93",
"artifactVersion": "a610bdd1ae56e1c4cd38",
"artifactVersion": "4421a7b808191ac7f410",
"rowCount": 3880
}
docs/src/generated/node-v24-compatibility.json
+24 -24
View File
@@ -584,9 +584,9 @@
"apiEntries": 9,
"static": {
"supported": 0,
"partial": 0,
"partial": 8,
"refused": 0,
"not-implemented": 9,
"not-implemented": 1,
"by-design": 0,
"unreviewed": 0,
"not-applicable": 0
@@ -58489,7 +58489,7 @@
"inherited": false
},
"static": {
"status": "not-implemented",
"status": "partial",
"detail": "Derived from the exact API rows in this chapter.",
"verification": "derived"
}
@@ -58512,9 +58512,9 @@
"inherited": true
},
"static": {
"status": "not-implemented",
"detail": "No static compiler lowering is registered for this API yet.",
"verification": "registry-gap"
"status": "partial",
"detail": "Implemented for the call shapes accepted by the compiler lowering.",
"verification": "test-backed"
}
},
{
@@ -58535,9 +58535,9 @@
"inherited": true
},
"static": {
"status": "not-implemented",
"detail": "No static compiler lowering is registered for this API yet.",
"verification": "registry-gap"
"status": "partial",
"detail": "Implemented for the call shapes accepted by the compiler lowering.",
"verification": "test-backed"
}
},
{
@@ -58558,9 +58558,9 @@
"inherited": true
},
"static": {
"status": "not-implemented",
"detail": "No static compiler lowering is registered for this API yet.",
"verification": "registry-gap"
"status": "partial",
"detail": "Implemented for the call shapes accepted by the compiler lowering.",
"verification": "test-backed"
}
},
{
@@ -58581,9 +58581,9 @@
"inherited": true
},
"static": {
"status": "not-implemented",
"detail": "No static compiler lowering is registered for this API yet.",
"verification": "registry-gap"
"status": "partial",
"detail": "Implemented for the call shapes accepted by the compiler lowering.",
"verification": "test-backed"
}
},
{
@@ -58627,9 +58627,9 @@
"inherited": true
},
"static": {
"status": "not-implemented",
"detail": "No static compiler lowering is registered for this API yet.",
"verification": "registry-gap"
"status": "partial",
"detail": "Implemented for the call shapes accepted by the compiler lowering.",
"verification": "test-backed"
}
},
{
@@ -58650,9 +58650,9 @@
"inherited": true
},
"static": {
"status": "not-implemented",
"detail": "No static compiler lowering is registered for this API yet.",
"verification": "registry-gap"
"status": "partial",
"detail": "Implemented for the call shapes accepted by the compiler lowering.",
"verification": "test-backed"
}
},
{
@@ -58673,9 +58673,9 @@
"inherited": true
},
"static": {
"status": "not-implemented",
"detail": "No static compiler lowering is registered for this API yet.",
"verification": "registry-gap"
"status": "partial",
"detail": "Implemented for the call shapes accepted by the compiler lowering.",
"verification": "test-backed"
}
},
{
internal/compatibility/generated/node-v24-backlog.json
+72 -44
View File
@@ -7,8 +7,8 @@
"tierItemCount": 3456,
"tiers": {
"static": {
"audit-partial": 1155,
"verify-gap": 2174,
"audit-partial": 1162,
"verify-gap": 2167,
"replace-refusal": 40,
"classify": 2,
"implement": 85
@@ -58559,12 +58559,16 @@
"priority": "low",
"tiers": {
"static": {
"status": "not-implemented",
"action": "verify-gap",
"verification": "registry-gap",
"confidence": "low",
"source": "compiler-unmatched:punycode",
"tests": []
"status": "partial",
"action": "audit-partial",
"verification": "test-backed",
"confidence": "high",
"source": "surface-manifest:node-builtin.punycode.decode",
"tests": [
"tests/corpus/6122-punycode-conversions.ts",
"tests/corpus/6124-punycode-require-warnings.cjs",
"tests/corpus/6126-punycode-dependency/main.cjs"
]
}
}
},
@@ -58584,12 +58588,16 @@
"priority": "low",
"tiers": {
"static": {
"status": "not-implemented",
"action": "verify-gap",
"verification": "registry-gap",
"confidence": "low",
"source": "compiler-unmatched:punycode",
"tests": []
"status": "partial",
"action": "audit-partial",
"verification": "test-backed",
"confidence": "high",
"source": "surface-manifest:node-builtin.punycode.encode",
"tests": [
"tests/corpus/6122-punycode-conversions.ts",
"tests/corpus/6124-punycode-require-warnings.cjs",
"tests/corpus/6126-punycode-dependency/main.cjs"
]
}
}
},
@@ -58609,12 +58617,16 @@
"priority": "low",
"tiers": {
"static": {
"status": "not-implemented",
"action": "verify-gap",
"verification": "registry-gap",
"confidence": "low",
"source": "compiler-unmatched:punycode",
"tests": []
"status": "partial",
"action": "audit-partial",
"verification": "test-backed",
"confidence": "high",
"source": "surface-manifest:node-builtin.punycode.toASCII",
"tests": [
"tests/corpus/6122-punycode-conversions.ts",
"tests/corpus/6124-punycode-require-warnings.cjs",
"tests/corpus/6126-punycode-dependency/main.cjs"
]
}
}
},
@@ -58634,12 +58646,16 @@
"priority": "low",
"tiers": {
"static": {
"status": "not-implemented",
"action": "verify-gap",
"verification": "registry-gap",
"confidence": "low",
"source": "compiler-unmatched:punycode",
"tests": []
"status": "partial",
"action": "audit-partial",
"verification": "test-backed",
"confidence": "high",
"source": "surface-manifest:node-builtin.punycode.toUnicode",
"tests": [
"tests/corpus/6122-punycode-conversions.ts",
"tests/corpus/6124-punycode-require-warnings.cjs",
"tests/corpus/6126-punycode-dependency/main.cjs"
]
}
}
},
@@ -58684,12 +58700,16 @@
"priority": "low",
"tiers": {
"static": {
"status": "not-implemented",
"action": "verify-gap",
"verification": "registry-gap",
"confidence": "low",
"source": "compiler-unmatched:punycode",
"tests": []
"status": "partial",
"action": "audit-partial",
"verification": "test-backed",
"confidence": "high",
"source": "surface-manifest:node-builtin.punycode.ucs2.decode",
"tests": [
"tests/corpus/6122-punycode-conversions.ts",
"tests/corpus/6124-punycode-require-warnings.cjs",
"tests/corpus/6126-punycode-dependency/main.cjs"
]
}
}
},
@@ -58709,12 +58729,16 @@
"priority": "low",
"tiers": {
"static": {
"status": "not-implemented",
"action": "verify-gap",
"verification": "registry-gap",
"confidence": "low",
"source": "compiler-unmatched:punycode",
"tests": []
"status": "partial",
"action": "audit-partial",
"verification": "test-backed",
"confidence": "high",
"source": "surface-manifest:node-builtin.punycode.ucs2.encode",
"tests": [
"tests/corpus/6122-punycode-conversions.ts",
"tests/corpus/6124-punycode-require-warnings.cjs",
"tests/corpus/6126-punycode-dependency/main.cjs"
]
}
}
},
@@ -58734,12 +58758,16 @@
"priority": "low",
"tiers": {
"static": {
"status": "not-implemented",
"action": "verify-gap",
"verification": "registry-gap",
"confidence": "low",
"source": "compiler-unmatched:punycode",
"tests": []
"status": "partial",
"action": "audit-partial",
"verification": "test-backed",
"confidence": "high",
"source": "surface-manifest:node-builtin.punycode.version",
"tests": [
"tests/corpus/6122-punycode-conversions.ts",
"tests/corpus/6124-punycode-require-warnings.cjs",
"tests/corpus/6126-punycode-dependency/main.cjs"
]
}
}
},
internal/compatibility/generated/node-v24-internal.json
+58 -18
View File
@@ -611,9 +611,9 @@
"apiEntries": 9,
"static": {
"supported": 0,
"partial": 0,
"partial": 8,
"refused": 0,
"not-implemented": 9,
"not-implemented": 1,
"by-design": 0,
"unreviewed": 0,
"not-applicable": 0
@@ -81945,8 +81945,13 @@
"inherited": false
},
"static": {
"status": "not-implemented",
"evidence": "derived:descendants"
"status": "partial",
"evidence": "derived:descendants",
"tests": [
"tests/corpus/6122-punycode-conversions.ts",
"tests/corpus/6124-punycode-require-warnings.cjs",
"tests/corpus/6126-punycode-dependency/main.cjs"
]
},
"anchorSource": "chapter"
},
@@ -81968,8 +81973,13 @@
"inherited": true
},
"static": {
"status": "not-implemented",
"evidence": "compiler-unmatched:punycode"
"status": "partial",
"evidence": "surface-manifest:node-builtin.punycode.decode",
"tests": [
"tests/corpus/6122-punycode-conversions.ts",
"tests/corpus/6124-punycode-require-warnings.cjs",
"tests/corpus/6126-punycode-dependency/main.cjs"
]
},
"anchorSource": "exact"
},
@@ -81991,8 +82001,13 @@
"inherited": true
},
"static": {
"status": "not-implemented",
"evidence": "compiler-unmatched:punycode"
"status": "partial",
"evidence": "surface-manifest:node-builtin.punycode.encode",
"tests": [
"tests/corpus/6122-punycode-conversions.ts",
"tests/corpus/6124-punycode-require-warnings.cjs",
"tests/corpus/6126-punycode-dependency/main.cjs"
]
},
"anchorSource": "exact"
},
@@ -82014,8 +82029,13 @@
"inherited": true
},
"static": {
"status": "not-implemented",
"evidence": "compiler-unmatched:punycode"
"status": "partial",
"evidence": "surface-manifest:node-builtin.punycode.toASCII",
"tests": [
"tests/corpus/6122-punycode-conversions.ts",
"tests/corpus/6124-punycode-require-warnings.cjs",
"tests/corpus/6126-punycode-dependency/main.cjs"
]
},
"anchorSource": "exact"
},
@@ -82037,8 +82057,13 @@
"inherited": true
},
"static": {
"status": "not-implemented",
"evidence": "compiler-unmatched:punycode"
"status": "partial",
"evidence": "surface-manifest:node-builtin.punycode.toUnicode",
"tests": [
"tests/corpus/6122-punycode-conversions.ts",
"tests/corpus/6124-punycode-require-warnings.cjs",
"tests/corpus/6126-punycode-dependency/main.cjs"
]
},
"anchorSource": "exact"
},
@@ -82083,8 +82108,13 @@
"inherited": true
},
"static": {
"status": "not-implemented",
"evidence": "compiler-unmatched:punycode"
"status": "partial",
"evidence": "surface-manifest:node-builtin.punycode.ucs2.decode",
"tests": [
"tests/corpus/6122-punycode-conversions.ts",
"tests/corpus/6124-punycode-require-warnings.cjs",
"tests/corpus/6126-punycode-dependency/main.cjs"
]
},
"anchorSource": "exact"
},
@@ -82106,8 +82136,13 @@
"inherited": true
},
"static": {
"status": "not-implemented",
"evidence": "compiler-unmatched:punycode"
"status": "partial",
"evidence": "surface-manifest:node-builtin.punycode.ucs2.encode",
"tests": [
"tests/corpus/6122-punycode-conversions.ts",
"tests/corpus/6124-punycode-require-warnings.cjs",
"tests/corpus/6126-punycode-dependency/main.cjs"
]
},
"anchorSource": "exact"
},
@@ -82129,8 +82164,13 @@
"inherited": true
},
"static": {
"status": "not-implemented",
"evidence": "compiler-unmatched:punycode"
"status": "partial",
"evidence": "surface-manifest:node-builtin.punycode.version",
"tests": [
"tests/corpus/6122-punycode-conversions.ts",
"tests/corpus/6124-punycode-require-warnings.cjs",
"tests/corpus/6126-punycode-dependency/main.cjs"
]
},
"anchorSource": "chapter"
},
internal/compatibility/static-support.json
+1
View File
@@ -147,6 +147,7 @@
"node-builtin.process.rows": ["tests/corpus/2992-stream-rows.ts", "tests/harness/terminal-geometry.test.ts"],
"node-builtin.process.columns": ["tests/corpus/1448-stream-columns.ts", "tests/harness/terminal-geometry.test.ts"],
"node-builtin.process.exitCode": ["tests/corpus/5809-process-exit-and-rejections.cjs", "tests/corpus/2941-process-exit-code.ts", "tests/corpus/2942-process-exit-code-override.ts", "tests/corpus/2943-process-exit-code-invalid.ts", "tests/corpus/2944-process-exit-code-wrap.ts"],
"node-builtin.punycode": ["tests/corpus/6122-punycode-conversions.ts", "tests/corpus/6124-punycode-require-warnings.cjs", "tests/corpus/6126-punycode-dependency/main.cjs"],
"node-builtin.querystring": ["tests/corpus/957-builtins-namespace.ts", "tests/corpus/2917-builtin-callable-widths.ts"],
"node-builtin.readline": ["tests/corpus/1475-readline-closed-stdin.ts"],
"node-builtin.stream": ["tests/corpus/1685-stream-readable-basics.ts", "tests/corpus/1746-stream-for-await.ts", "tests/corpus/1814-stream-pipeline.cjs", "tests/corpus/2629-stream-consumers.ts", "tests/corpus/2861-readable-iterator-close.ts"],
packages/compiler/ambient/scriptc-node-fallback.d.ts
Vendored
+33
View File
@@ -3762,6 +3762,39 @@ declare module "node:querystring" {
export * from "querystring";
}
/* node:punycode (deprecated, DEP0040) — punycode.js 2.1.0: decode and
* toUnicode throw its RangeErrors on malformed input; ucs2 converts
* between strings and UTF-16 code point arrays. */
declare module "punycode" {
export function decode(string: string): string;
export function encode(string: string): string;
export function toUnicode(domain: string): string;
export function toASCII(domain: string): string;
export namespace ucs2 {
function decode(string: string): number[];
function encode(codePoints: readonly number[]): string;
}
export const version: string;
}
declare module "node:punycode" {
export * from "punycode";
}
/* node:constants (deprecated, DEP0008) — one frozen object: os.constants'
* dlopen, errno, priority and signals groups, fs.constants, and
* crypto.constants. A platform's missing constant reads as undefined. */
declare module "constants" {
const constants: { readonly [name: string]: number } & {
readonly defaultCoreCipherList: string;
readonly defaultCipherList: string;
};
export = constants;
}
declare module "node:constants" {
import constants = require("constants");
export = constants;
}
/* node:readline — the question/close slice: createInterface over exactly
* { input: process.stdin, output: process.stdout }, question(query, cb)
* (the query writes to stdout, the callback gets the next line's text),
packages/compiler/src/backend/llvm/alloc.test.ts
+38 -1
View File
@@ -1,5 +1,11 @@
import { describe, expect, test } from "vitest";
import { type AllocHost, emitObjectAlloc, emitObjectFree, inlineAllocSupported } from "./alloc.js";
import {
type AllocHost,
disposeHookLoadLines,
emitObjectAlloc,
emitObjectFree,
inlineAllocSupported,
} from "./alloc.js";
function host(inlineAlloc: boolean): AllocHost & { decls: Set<string>; oom: boolean } {
const h = {
@@ -63,7 +69,12 @@ describe("emitted object allocation", () => {
]);
expect(emitObjectFree(h, false)).toEqual([
" call void @scr_obj_free_note()",
" %sf.obs = load i1, ptr @sc_weak_keys",
" br i1 %sf.obs, label %sf.observe, label %sf.block",
"sf.observe:",
" call void @scr_weak_dispose(ptr %o)",
" br label %sf.block",
"sf.block:",
" call void @scr_rt_free(ptr %o)",
]);
expect([...h.decls].some((d) => d.includes("@scr_sa"))).toBe(false);
@@ -167,4 +178,30 @@ describe("emitted object allocation", () => {
expect(lines.at(-1)).toBe("sf.done:");
}
});
test("frees test the dispose hook only where the program can observe them", () => {
const h = host(true);
const weak = emitObjectFree(h, false);
expectSingleDefinitions(weak);
expect(weak.slice(0, 2)).toEqual([
" %sf.obs = load i1, ptr @sc_weak_keys",
" br i1 %sf.obs, label %sf.hooked, label %sf.block",
]);
const records = emitObjectFree(h, true, "weak-or-source");
expectSingleDefinitions(records);
expect(records.slice(0, 4)).toEqual([
" %sf.obsw = load i1, ptr @sc_weak_keys",
" %sf.obss = load i1, ptr @sc_record_sources",
" %sf.obs = or i1 %sf.obsw, %sf.obss",
" br i1 %sf.obs, label %sf.hooked, label %sf.block",
]);
expect(records).toContain(" call void %sf.hook(ptr %o)");
});
test("loads the dispose hook from emitted code only with the inline allocator", () => {
expect(disposeHookLoadLines(host(false), "%t1")).toBeNull();
expect(disposeHookLoadLines(host(true), "%t1")).toEqual([
" %t1 = load ptr, ptr @scr_weak_dispose_hook",
]);
});
});
packages/compiler/src/backend/llvm/alloc.ts
+62 -7
View File
@@ -79,6 +79,17 @@ function threadLocalState(host: AllocHost, prefix: string, lines: string[]): str
return [...preamble, ...text.split("\n")];
}
/** Lines that load the runtime's dispose hook into `dest`, or null on
* targets without the inline allocator, where the hook's storage is not
* addressed from emitted code. The hook is NULL until a weak collection
* or a kept record source installs it, and then never NULL again. */
export function disposeHookLoadLines(host: AllocHost, dest: string): string[] | null {
if (host.inlineAlloc !== true) return null;
declareGlobal(host, `@scr_weak_dispose_hook = external global ptr`);
const prefix = dest.replace(/^%/, "").replace(/[^-$._A-Za-z0-9]/g, "_");
return threadLocalState(host, prefix, [` ${dest} = load ptr, ptr @scr_weak_dispose_hook`]);
}
/** Worker executables: the calling script thread's ScrThreadHot block into
* `dest`. Its address also identifies the thread (the owner word of a
* lifetime-region chunk; llvm/regions.ts). */
@@ -325,20 +336,56 @@ function allocLines(
return lines;
}
/* ── dispose observers ────────────────────────────────────────────────
* The runtime's dispose hook (scr_weak_dispose_hook) has two clients: weak
* collections, whose keys can be any object, and the kept sources of
* checked records (scr_record_source_note and the JSON schema parser),
* keyed by closed records. A program without either can never install the
* hook, so its frees need not test it. Whether the program has them is
* known only once every helper is emitted (dynCheck builders and JSON
* schemas are requested lazily), so the emitted frees and record writers
* test these two module constants, which the emitter defines last
* (LlvmEmitter.emitParts) and LLVM folds away. */
/** True when the program constructs a WeakMap or WeakSet. */
export const WEAK_KEYS_GATE = "@sc_weak_keys";
/** True when a checked conversion can keep a record's undeclared source. */
export const RECORD_SOURCES_GATE = "@sc_record_sources";
/** Which dispose observers an object type can have: weak-collection keys
* only, or (closed record layouts) kept record sources too. */
export type FreeObservers = "weak" | "weak-or-source";
/**
* Lines that free the object `%o` after its members were released: the
* RC-audit free note, the weak-collection dispose hook, and the block —
* `scr_cyc_free` for collector-headered objects, `scr_rt_free` otherwise.
* Labels use the `sf.` prefix; the lines end in an open block.
* RC-audit free note, the dispose hook (when the program can observe this
* type's disposals), and the block — `scr_cyc_free` for collector-headered
* objects, `scr_rt_free` otherwise. Labels use the `sf.` prefix; the lines
* end in an open block.
*/
export function emitObjectFree(host: AllocHost, cyc: boolean): string[] {
const lines = threadLocalState(host, "sf", freeLines(host, cyc));
export function emitObjectFree(
host: AllocHost,
cyc: boolean,
observers: FreeObservers = "weak",
): string[] {
const lines = threadLocalState(host, "sf", freeLines(host, cyc, observers));
if (host.objectAudit === false) return lines.filter((line) => line !== FREE_NOTE);
host.declare(`declare void @scr_obj_free_note()`);
return lines;
}
function freeLines(host: AllocHost, cyc: boolean): string[] {
/** Lines that leave in `%<prefix>.obs` whether the program can observe a
* disposal of this type (folds to a constant). */
function observedLines(prefix: string, observers: FreeObservers): string[] {
if (observers === "weak") return [` %${prefix}.obs = load i1, ptr ${WEAK_KEYS_GATE}`];
return [
` %${prefix}.obsw = load i1, ptr ${WEAK_KEYS_GATE}`,
` %${prefix}.obss = load i1, ptr ${RECORD_SOURCES_GATE}`,
` %${prefix}.obs = or i1 %${prefix}.obsw, %${prefix}.obss`,
];
}
function freeLines(host: AllocHost, cyc: boolean, observers: FreeObservers): string[] {
if (host.inlineAlloc !== true) {
if (cyc) {
host.declare(`declare void @scr_cyc_free(ptr)`);
@@ -348,7 +395,12 @@ function freeLines(host: AllocHost, cyc: boolean): string[] {
host.declare(`declare void @scr_weak_dispose(ptr)`);
return [
` call void @scr_obj_free_note()`,
...observedLines("sf", observers),
` br i1 %sf.obs, label %sf.observe, label %sf.block`,
`sf.observe:`,
` call void @scr_weak_dispose(ptr %o)`,
` br label %sf.block`,
`sf.block:`,
` call void @scr_rt_free(ptr %o)`,
];
}
@@ -356,11 +408,14 @@ function freeLines(host: AllocHost, cyc: boolean): string[] {
host.declare(`declare void @scr_rt_free(ptr)`);
declareGlobal(host, `@scr_weak_dispose_hook = external global ptr`);
const lines = [
...observedLines("sf", observers),
` br i1 %sf.obs, label %sf.hooked, label %sf.block`,
`sf.hooked:`,
` %sf.hook = load ptr, ptr @scr_weak_dispose_hook`,
` %sf.has = icmp ne ptr %sf.hook, null`,
` %sf.hasx = call i1 @llvm.expect.i1(i1 %sf.has, i1 false)`,
` br i1 %sf.hasx, label %sf.observe, label %sf.block`,
`sf.observe: ; weak collections observe the disposal`,
`sf.observe: ; a weak collection or a kept record source observes the disposal`,
` call void %sf.hook(ptr %o)`,
` br label %sf.block`,
`sf.block:`,
packages/compiler/src/backend/llvm/dyn.ts
+19 -9
View File
@@ -1106,6 +1106,10 @@ export class LlDyn {
private readonly jsonSchemas = new Map<string, string>();
private readonly jsonParsers = new Map<string, string>();
private readonly recordNameTables = new Map<string, { names: string; lens: string }>();
/** Some emitted helper can keep a record's undeclared source: a checked
* record builder that notes it, or a JSON schema of a closed record
* (alloc.ts RECORD_SOURCES_GATE). */
keepsRecordSources = false;
/** Targets the one-pass parser (scr_json_parse_schema) can build
* directly: number, boolean and string leaves inside arrays and records
@@ -1217,12 +1221,14 @@ export class LlDyn {
`llvm emitter bug: JSON schema of unknown shape ${t.shapeId}`,
);
const struct = mangleRecordStruct(t.shapeId);
const index = new Map(shape.fields.map((f, i) => [f.name, i + 1]));
const base = host.nullableUnions.fieldBase(t.shapeId);
const index = new Map(shape.fields.map((f, i) => [f.name, i + base]));
// The runtime names kept-source keys by this index (record-sources.ts).
const order = recordSourceFieldOrder(shape);
if (recordMayKeepSource(shape)) this.keepsRecordSources = true;
const fieldTy = `{ ptr, ${S}, ${S}, ptr }`;
const entries = order.map((fieldName) => {
const field = shape.fields[index.get(fieldName)! - 1]!;
const field = shape.fields[index.get(fieldName)! - base]!;
const sub = this.jsonSchema(field.type);
const offset = `ptrtoint (ptr getelementptr (%${struct}, ptr null, i64 0, i32 ${index.get(fieldName)}) to ${S})`;
return `${fieldTy} { ptr ${host.cstr(fieldName)}, ${S} ${Buffer.byteLength(fieldName, "utf8")}, ${S} ${offset}, ptr @${sub} }`;
@@ -1240,7 +1246,7 @@ export class LlDyn {
const overflow = shape.indexValue
? {
elem: `@${this.jsonSchema(shape.indexValue)}`,
offset: `ptrtoint (ptr getelementptr (%${struct}, ptr null, i64 0, i32 ${shape.fields.length + 1}) to ${S})`,
offset: `ptrtoint (ptr getelementptr (%${struct}, ptr null, i64 0, i32 ${shape.fields.length + base}) to ${S})`,
}
: { elem: "null", offset: "0" };
body = `${S} 3, ${S} ${entries.length}, ptr ${fields}, ptr ${overflow.elem}, ptr @${mangleRecordNew(t.shapeId)}, ptr null, ptr ${vAdapters(host, t).release}, ptr null, ${S} ${overflow.offset}`;
@@ -1547,18 +1553,19 @@ export class LlDyn {
B.line(`call void @scr_arr_outline(ptr ${cached})`);
B.line(`call void @scr_arr_outline(ptr ${checked})`);
}
const base = t.kind === "record" ? host.nullableUnions.fieldBase(t.shapeId) : 1;
const members =
t.kind === "record"
? [
...shape!.fields.map((field, index) => ({
index: index + 1,
index: index + base,
type: llFieldType(field.type, host.inlineUnions.record(field.type)),
name: field.name,
})),
...(shape!.indexValue
? [
{
index: shape!.fields.length + 1,
index: shape!.fields.length + base,
type: "ptr" as const,
name: "[key: string] overflow",
},
@@ -1819,7 +1826,8 @@ export class LlDyn {
`llvm emitter bug: dynCheck of unknown shape ${t.shapeId}`,
);
const struct = mangleRecordStruct(t.shapeId);
const fieldIndex = new Map(shape.fields.map((f, i) => [f.name, i + 1]));
const base = host.nullableUnions.fieldBase(t.shapeId);
const fieldIndex = new Map(shape.fields.map((f, i) => [f.name, i + base]));
const releaseR = (): void => {
B.line(`call void ${releaseSym(host, t)}(ptr %r0)`);
};
@@ -1978,6 +1986,7 @@ export class LlDyn {
// that has them stays beside the record so its reflective
// surfaces still observe them (scr_record_source_note).
if (recordMayKeepSource(shape)) {
this.keepsRecordSources = true;
const names = this.recordNameTable(t.shapeId, shape);
host.declare(
`declare void @scr_record_source_note(ptr, ptr, ptr, ptr, ${host.sizeType})`,
@@ -1996,7 +2005,7 @@ export class LlDyn {
const ovfp = B.tmp();
const ovf = B.tmp();
B.line(
`${ovfp} = getelementptr inbounds %${struct}, ptr %r0, i64 0, i32 ${shape.fields.length + 1}`,
`${ovfp} = getelementptr inbounds %${struct}, ptr %r0, i64 0, i32 ${shape.fields.length + base}`,
);
B.line(`${ovf} = load ptr, ptr ${ovfp} ; overflow map`);
if (shape.fields.length === 0) {
@@ -2578,7 +2587,8 @@ export class LlDyn {
if (!shape)
throw new InternalCompilerError(`llvm emitter bug: to-dyn of unknown shape ${t.shapeId}`);
const struct = mangleRecordStruct(t.shapeId);
const fieldIndex = new Map(shape.fields.map((f, i) => [f.name, i + 1]));
const base = host.nullableUnions.fieldBase(t.shapeId);
const fieldIndex = new Map(shape.fields.map((f, i) => [f.name, i + base]));
const loadFieldOf = (fname: string, ft: IrType): string => {
const p = B.tmp();
B.line(
@@ -2702,7 +2712,7 @@ export class LlDyn {
const ovfp = B.tmp();
const ovf = B.tmp();
B.line(
`${ovfp} = getelementptr inbounds %${struct}, ptr %v, i64 0, i32 ${shape.fields.length + 1}`,
`${ovfp} = getelementptr inbounds %${struct}, ptr %v, i64 0, i32 ${shape.fields.length + base}`,
);
B.line(`${ovf} = load ptr, ptr ${ovfp} ; overflow map`);
const ks = B.tmp();
packages/compiler/src/backend/llvm/emitter.ts
+76 -12
View File
@@ -2,7 +2,14 @@ import { type ArraySearchKind, emitArraySearchHelpers } from "./array-search.js"
import { emitStringInputs } from "./string-lifetimes.js";
import { emitLlvmLayouts } from "./layouts.js";
import { compileRegexMatcher, type RegexMatcherCode } from "./regex-matchers.js";
import { CYC_BUF, CYC_HDR, FIRST_EMITTED_CYC_KIND, inlineAllocSupported } from "./alloc.js";
import {
CYC_BUF,
CYC_HDR,
FIRST_EMITTED_CYC_KIND,
inlineAllocSupported,
RECORD_SOURCES_GATE,
WEAK_KEYS_GATE,
} from "./alloc.js";
import { hasLoneSurrogate, llvmBytes as llBytes, wtf8Bytes } from "../literals.js";
import { InternalCompilerError } from "../../errors.js";
import { createHash } from "node:crypto";
@@ -393,6 +400,7 @@ import {
elemAccess,
emitInlineRcHelpers,
emitNullableRetainWrappers,
emitShapeUnionHelpers,
FN_ATTRS,
inlineRcDecls,
type InlineRcMode,
@@ -1183,7 +1191,7 @@ export class LlEmitter {
expr: (expr) => !(expr.kind === "libCall" && expr.fn === "error.stack"),
}),
);
this.nullableUnions = new NullableUnions(mod);
this.nullableUnions = new NullableUnions(mod, options.debugSources === undefined);
this.mockTimers = moduleUsesMockTimers(mod);
this.debug =
options.debugSources === undefined
@@ -1282,8 +1290,10 @@ export class LlEmitter {
// Optional array reads also cover nullable unions: emitLocalArrayRead
// then yields the (borrowed or owned) element pointer, not a stack box.
// Arrays of such a union are read the same way.
this.optionalArrayReads = new OptionalArrayReads(this.fnByName, this.unionsById, (id) =>
this.nullableUnions.has(id),
this.optionalArrayReads = new OptionalArrayReads(
this.fnByName,
this.unionsById,
(id) => this.nullableUnions.single(id) !== null,
);
this.unionSources = {
unions: this.boxedUnionsById,
@@ -1336,7 +1346,8 @@ export class LlEmitter {
(type) =>
this.plainReference(type) &&
type.kind !== "string" &&
(type.kind !== "union" || this.nullableUnions.get(type.unionId)?.arm.kind !== "string"),
(type.kind !== "union" ||
this.nullableUnions.single(type.unionId)?.arm.kind !== "string"),
this.walkBorrowsByFunction.get(fn.name) ?? new Set(),
);
if (rebound.size === 0) continue;
@@ -1389,6 +1400,27 @@ export class LlEmitter {
const traced = computeTraced(mod);
this.tracedShapes = traced.shapes;
this.tracedUnions = traced.unions;
// A shape union's value is whichever record it holds, and the collector
// visits it as that record: when one arm carries a collector header,
// every arm must (nullable-unions.ts). Unions that share an arm pass a
// header on to each other's arms, so repeat until no union adds one.
const shapeUnions = this.nullableUnions.allShapeUnions();
for (let changed = true; changed;) {
changed = false;
for (const union of shapeUnions) {
if (
!this.tracedUnions.has(union.unionId) &&
!union.arms.some((arm) => this.tracedShapes.has(`record:${arm.shapeId}`))
)
continue;
for (const arm of union.arms) {
const key = `record:${arm.shapeId}`;
if (this.tracedShapes.has(key)) continue;
this.tracedShapes.add(key);
changed = true;
}
}
}
this.shapeHost = {
sizeType: this.sizeType,
cycleBufOffset: this.cycleBufOffset,
@@ -1939,7 +1971,10 @@ export class LlEmitter {
}
emitParts(): string[] {
const parts = limitInlineDynReleases(this.emitModuleParts());
const parts = [
...limitInlineDynReleases(this.emitModuleParts()),
...this.disposeObserverGates(),
];
if (!this.executableTls) return parts;
// A worker executable's thread-locals all live in the executable's own
// TLS block: the program's internal ones, and the runtime's external
@@ -1962,6 +1997,21 @@ export class LlEmitter {
);
}
/** The dispose-observer gates the emitted frees and record writers test
* (alloc.ts): defined after every helper is emitted, because dynCheck
* builders, JSON schemas and weak collection constructors are requested
* lazily. */
private disposeObserverGates(): string[] {
const weak = [...this.decls].some(
(d) => d.includes("@scr_weak_map_new(") || d.includes("@scr_weak_set_new("),
);
return [
`${WEAK_KEYS_GATE} = internal constant i1 ${weak}`,
`${RECORD_SOURCES_GATE} = internal constant i1 ${this.dyn.keepsRecordSources}`,
``,
];
}
private emitModuleParts(): string[] {
// Function bodies first (the literal/unit/fn-value tables fill as they
// emit), then the file assembles around them — the runtime ABI’s order.
@@ -3729,6 +3779,7 @@ export class LlEmitter {
return [
...late,
...emitNullableRetainWrappers(this.shapeHost),
...emitShapeUnionHelpers(this.shapeHost),
...emitInlineRcHelpers(this.shapeHost),
];
}
@@ -5896,7 +5947,11 @@ export class LlEmitter {
const nullable = this.nullableUnions.get(unionId);
if (nullable) {
// The owned payload IS the nullable union's value.
if (tag !== nullable.refTag)
if (
nullable.repr === "single"
? tag !== nullable.refTag
: !nullable.arms.some((arm) => arm.tag === tag)
)
throw new InternalCompilerError(
`llvm emitter bug: payload wrap into unit arm ${tag} of ${unionId}`,
);
@@ -6001,7 +6056,7 @@ export class LlEmitter {
const index = shape.fields.findIndex((entry) => entry.name === field);
if (index < 0)
throw new InternalCompilerError(`llvm emitter bug: missing union field ${field}`);
layout = "record:";
layout = this.nullableUnions.fieldBase(arm.shapeId) === 2 ? "record:tagged;" : "record:";
for (let i = 0; i <= index; i++) {
const type = shape.fields[i]!.type;
layout += `${llFieldType(type, this.inlineUnions.record(type))};`;
@@ -6037,7 +6092,7 @@ export class LlEmitter {
);
const p = this.B.tmp();
this.B.line(
`${p} = getelementptr inbounds %${mangleRecordStruct(shapeId)}, ptr ${objName}, i64 0, i32 ${idx + 1}`,
`${p} = getelementptr inbounds %${mangleRecordStruct(shapeId)}, ptr ${objName}, i64 0, i32 ${idx + this.nullableUnions.fieldBase(shapeId)}`,
);
const type = shape.fields[idx]!.type;
return { ptr: p, type, inline: this.inlineUnions.record(type) };
@@ -6051,7 +6106,7 @@ export class LlEmitter {
const p = this.B.tmp();
const v = this.B.tmp();
this.B.line(
`${p} = getelementptr inbounds %${mangleRecordStruct(shapeId)}, ptr ${objName}, i64 0, i32 ${shape.fields.length + 1}`,
`${p} = getelementptr inbounds %${mangleRecordStruct(shapeId)}, ptr ${objName}, i64 0, i32 ${shape.fields.length + this.nullableUnions.fieldBase(shapeId)}`,
);
this.B.line(`${v} = load ptr, ptr ${p}`);
return v;
@@ -10223,7 +10278,12 @@ export class LlEmitter {
unionsById: this.unionsById,
recordsById: this.recordsById,
inlineUnions: this.inlineUnions,
nullableArm: (t) => this.nullableUnions.of(t)?.arm ?? null,
nullableArm: (t) => {
const nullable = this.nullableUnions.of(t);
return nullable?.repr === "single" ? nullable.arm : null;
},
shapeUnion: (t) => this.nullableUnions.of(t)?.repr === "shapes",
fieldBase: (shapeId) => this.nullableUnions.fieldBase(shapeId),
classInfo: (className) => {
const meta = this.classMetaOf(className);
return {
@@ -10944,7 +11004,11 @@ export class LlEmitter {
const nullable = this.nullableUnions.get(e.unionId);
if (!nullable) return null;
if (isUnitType(e.value.type)) return e.value.kind === "unitLit" ? "unit" : null;
return e.tag === nullable.refTag && isRefCounted(e.value.type) ? "ref" : null;
const refArm =
nullable.repr === "single"
? e.tag === nullable.refTag
: nullable.arms.some((arm) => arm.tag === e.tag);
return refArm && isRefCounted(e.value.type) ? "ref" : null;
}
materializeSplitLocal(localId: string): void {
packages/compiler/src/backend/llvm/expr-callbacks.ts
+7 -5
View File
@@ -182,6 +182,7 @@ export function genResultThunkFor(
sym = mangleGenResThunk(host.resolveThunks.size);
host.resolveThunks.set(key, sym);
const shape = host.recordsById.get(recT.shapeId);
const base = host.nullableUnions.fieldBase(recT.shapeId);
const valueT = shape?.fields.find((f) => f.name === "value")?.type;
if (!shape || !valueT)
throw new InternalCompilerError("llvm emitter bug: genResume record lacks its value field");
@@ -242,7 +243,7 @@ export function genResultThunkFor(
` %r = call ptr @${mangleRecordNew(recT.shapeId)}()`,
` %d = call zeroext i1 @scr_gen_done(ptr %g)`,
` %dz = zext i1 %d to i8`,
` %dp = getelementptr inbounds %${mangleRecordStruct(recT.shapeId)}, ptr %r, i64 0, i32 ${doneIdxD + 1}`,
` %dp = getelementptr inbounds %${mangleRecordStruct(recT.shapeId)}, ptr %r, i64 0, i32 ${doneIdxD + base}`,
` store i8 %dz, ptr %dp`,
` %has = call zeroext i1 @scr_gen_out_has(ptr %g)`,
` br i1 %has, label %take, label %undefv`,
@@ -259,7 +260,7 @@ export function genResultThunkFor(
` br label %join`,
`join:`,
` %v = load ptr, ptr %vslot`,
` %vp = getelementptr inbounds %${mangleRecordStruct(recT.shapeId)}, ptr %r, i64 0, i32 ${valueIdxD + 1}`,
` %vp = getelementptr inbounds %${mangleRecordStruct(recT.shapeId)}, ptr %r, i64 0, i32 ${valueIdxD + base}`,
` store ptr %v, ptr %vp`,
` ret ptr %r`,
`}`,
@@ -293,7 +294,7 @@ export function genResultThunkFor(
` %r = call ptr @${mangleRecordNew(recT.shapeId)}()`,
` %d = call zeroext i1 @scr_gen_done(ptr %g)`,
` %dz = zext i1 %d to i8`,
` %dp = getelementptr inbounds %${mangleRecordStruct(recT.shapeId)}, ptr %r, i64 0, i32 ${doneIdx + 1}`,
` %dp = getelementptr inbounds %${mangleRecordStruct(recT.shapeId)}, ptr %r, i64 0, i32 ${doneIdx + base}`,
` store i8 %dz, ptr %dp`,
` br i1 %d, label %doneb, label %susp`,
];
@@ -410,7 +411,7 @@ export function genResultThunkFor(
` br label %join`,
`join:`,
` %v = load ptr, ptr %vslot`,
` %vp = getelementptr inbounds %${mangleRecordStruct(recT.shapeId)}, ptr %r, i64 0, i32 ${valueIdx + 1}`,
` %vp = getelementptr inbounds %${mangleRecordStruct(recT.shapeId)}, ptr %r, i64 0, i32 ${valueIdx + base}`,
// An inline value field copies the box's bits and drops the box.
...(host.inlineUnions.record(valueT)
? [
@@ -1092,7 +1093,8 @@ export function settledStoreFor(
return { tag, arm };
};
const fieldIndex = (arm: IrType & { kind: "record" }, field: string): number =>
host.recordsById.get(arm.shapeId)!.fields.findIndex((f) => f.name === field) + 1;
host.recordsById.get(arm.shapeId)!.fields.findIndex((f) => f.name === field) +
host.nullableUnions.fieldBase(arm.shapeId);
const fulfilled = armOf("value");
const rejected = armOf("reason");
const valueT = host.recordsById
packages/compiler/src/backend/llvm/expr-control.ts
+2 -2
View File
@@ -330,7 +330,7 @@ export function emitControlExpr(
);
B.line(`store ${ty} ${t}, ptr ${slot}`);
if (host.mayThrow.has(e.retag)) host.emitPendingCheck();
} else if (host.nullableUnions.has(e.left.type.unionId)) {
} else if (host.nullableUnions.single(e.left.type.unionId)) {
// The owned nullable pointer IS the owned arm value.
B.line(`store ${ty} ${l.name}, ptr ${slot}`);
} else {
@@ -440,7 +440,7 @@ export function emitControlExpr(
host.emitBranchInto(slot, e.right);
B.br(lj);
B.startBlock(lv);
if (typeEquals(e.type, e.left.type) || host.nullableUnions.has(def.id)) {
if (typeEquals(e.type, e.left.type) || host.nullableUnions.single(def.id)) {
// Pass-through, or a nullable pointer that IS its owned arm value.
B.line(`store ${ty} ${l.name}, ptr ${slot}`);
} else {
packages/compiler/src/backend/llvm/expr-records.ts
+11 -3
View File
@@ -62,9 +62,17 @@ export function emitUnionRetype(
const from = host.nullableUnions.get(e.fromId);
const to = host.nullableUnions.get(e.unionId);
if (from && to) {
// Equal encodings make the pointer itself the target value.
if (from.refTag === to.refTag && from.unitTag === to.unitTag && from.nullTag === to.nullTag)
return host.own({ name: value.name, type: e.type });
// Equal encodings make the pointer itself the target value. A shape
// union derives its record arms from the record, so only the unit
// encodings must agree.
const same =
from.repr === "single" && to.repr === "single"
? from.refTag === to.refTag && from.unitTag === to.unitTag && from.nullTag === to.nullTag
: from.repr === "shapes" &&
to.repr === "shapes" &&
from.unitTag === to.unitTag &&
from.nullTag === to.nullTag;
if (same) return host.own({ name: value.name, type: e.type });
return host.own({ name: rebuildRetype(host, value.name, e), type: e.type });
}
if (from || to) return host.own({ name: rebuildRetype(host, value.name, e), type: e.type });
packages/compiler/src/backend/llvm/expr-stream-bridges.ts
+6 -5
View File
@@ -500,16 +500,17 @@ export function streamTypedRefCommitAdapter(
` br i1 %missing, label %done, label %swap`,
`swap:`,
];
const base = host.nullableUnions.fieldBase(t.shapeId);
const members = [
...shape.fields.map((field, index) => ({
index: index + 1,
index: index + base,
type: llFieldType(field.type, host.inlineUnions.record(field.type)),
name: field.name,
})),
...(shape.indexValue
? [
{
index: shape.fields.length + 1,
index: shape.fields.length + base,
type: "ptr" as const,
name: "[key: string] overflow",
},
@@ -943,7 +944,7 @@ export function streamTypedRefMaterializeAdapter(
B.line(`${out} = call ptr @scr_dyn_new_arr()`);
const fields = [...shape.fields].sort((a, b) => Number(a.name) - Number(b.name));
for (const field of fields) {
const index = shape.fields.indexOf(field) + 1;
const index = shape.fields.indexOf(field) + host.nullableUnions.fieldBase(t.shapeId);
const fieldPtr = B.tmp();
B.line(
`${fieldPtr} = getelementptr inbounds %${mangleRecordStruct(t.shapeId)}, ptr %p, i64 0, i32 ${index}`,
@@ -980,7 +981,7 @@ export function streamTypedRefMaterializeAdapter(
liveRecordOps(host, t, snapshot, fields);
}
for (const field of fields) {
const index = shape.fields.indexOf(field) + 1;
const index = shape.fields.indexOf(field) + host.nullableUnions.fieldBase(t.shapeId);
const fieldPtr = B.tmp();
B.line(
`${fieldPtr} = getelementptr inbounds %${mangleRecordStruct(t.shapeId)}, ptr %p, i64 0, i32 ${index}`,
@@ -1202,7 +1203,7 @@ function liveRecordOps(
const names = `${snapshot}_names`;
const ops = `${snapshot}_rops`;
const loadField = (B: BlockBuilder, field: IrRecordShape["fields"][number]): string => {
const index = shape.fields.indexOf(field) + 1;
const index = shape.fields.indexOf(field) + host.nullableUnions.fieldBase(t.shapeId);
const fieldPtr = B.tmp();
B.line(`${fieldPtr} = getelementptr inbounds %${struct}, ptr %p, i64 0, i32 ${index}`);
return loadStructField(
packages/compiler/src/backend/llvm/lib-datagram.ts
+2 -2
View File
@@ -29,7 +29,7 @@ function messageAdapter(host: LlvmEmitterContext, type: IrType): string {
const isString = field === "address" || field === "family";
if (isString) lines.push(` %${field}.owned = call ptr @scr_str_retain_v(ptr %${field})`);
lines.push(
` %${field}.slot = getelementptr inbounds %${mangleRecordStruct(type.shapeId)}, ptr %record, i64 0, i32 ${index + 1}`,
` %${field}.slot = getelementptr inbounds %${mangleRecordStruct(type.shapeId)}, ptr %record, i64 0, i32 ${index + host.nullableUnions.fieldBase(type.shapeId)}`,
` store ${isString ? "ptr" : "double"} %${field}${isString ? ".owned" : ""}, ptr %${field}.slot`,
);
}
@@ -169,7 +169,7 @@ export function emitDatagramLibCall(host: LlvmEmitterContext, e: LibCallExpr): L
);
const slot = host.B.tmp();
host.B.line(
`${slot} = getelementptr inbounds %${mangleRecordStruct(type.shapeId)}, ptr ${record}, i64 0, i32 ${index + 1}`,
`${slot} = getelementptr inbounds %${mangleRecordStruct(type.shapeId)}, ptr ${record}, i64 0, i32 ${index + host.nullableUnions.fieldBase(type.shapeId)}`,
);
host.B.line(`store ${ty} ${value}, ptr ${slot}`);
}
packages/compiler/src/backend/llvm/lib-dispatch.ts
+62
View File
@@ -9,6 +9,7 @@ import { emitTestLibCall } from "./lib-test.js";
import { InternalCompilerError } from "../../errors.js";
import { MAY_THROW_LIB_FNS } from "../../ir/builtin-effects.js";
import type { IrExpr, IrType } from "../../ir/ir.js";
import { LlvmUnsupportedError } from "./unsupported.js";
import type { LlvmEmitterContext, LibCallExpr, LibCallPrefix, LlValue } from "./expr-context.js";
import {
@@ -21,6 +22,7 @@ import { isDynUndefined } from "../../ir/runtime-features.js";
import { DYN_KIND } from "./dyn.js";
import { rawBytes } from "./lib-abi.js";
import { emitInlineAtomicsOp } from "./expr-bytes.js";
import { regexLiteralCaptures } from "./regex-matchers.js";
export function emitAssertInspectLibCall(host: LlvmEmitterContext, e: LibCallExpr): LlValue {
const B = host.B;
@@ -642,8 +644,66 @@ function emitAssertFailing(
* `a.name.localeCompare(b.name)` reads both fields without retaining). */
const READ_ONLY_STRING_LIB_FNS: ReadonlySet<string> = new Set(["str.localeCompare"]);
/** The parameter count of a replace callback the runtime can call through
* the closure ABI (scr_regex_replace_fn), or null when it needs the dyn
* box. Each declared parameter must receive a value of its declared kind
* in every match: the match string at 0; with more than one parameter the
* pattern must be a literal whose captures are known, so position i is a
* capture that every match sets (a string), the offset (a number) right
* after the captures, or the subject (a string) after that. */
function typedReplacerArity(callback: IrType, pattern: IrExpr): number | null {
if (callback.kind !== "func" || callback.rest || callback.argumentsAll) return null;
if (callback.ret.kind !== "string") return null;
const params = callback.params;
if (params.length > 4) return null;
if (params.length === 0) return 0;
if (params[0]!.kind !== "string") return null;
if (params.length === 1) return 1;
if (pattern.kind !== "regexLit") return null;
const captures = regexLiteralCaptures(pattern.pattern, pattern.flags);
if (!captures) return null;
for (let i = 1; i < params.length; i++) {
const kind = params[i]!.kind;
const ok =
i < captures.count
? kind === "string" && captures.always[i] === true
: i === captures.count
? kind === "f64"
: i === captures.count + 1 && kind === "string";
if (!ok) return null;
}
return params.length;
}
/** `s.replace(re, fn)` / `replaceAll` with a typed callback the runtime can
* call directly: the dyn box the IR wraps it in is never observable (the
* runtime only calls it, with `this` undefined), so the closure goes to
* scr_regex_replace_fn as it is. Null keeps the generic path. */
function emitTypedRegexReplace(host: LlvmEmitterContext, e: LibCallExpr): LlValue | null {
const [subject, pattern, callback, all] = e.args;
if (!subject || !pattern || callback?.kind !== "dynFrom" || all?.kind !== "boolLit") return null;
const arity = typedReplacerArity(callback.value.type, pattern);
if (arity === null) return null;
const B = host.B;
const s = host.emitExpr(subject);
const re = host.emitExpr(pattern);
const fn = host.emitExpr(callback.value);
host.declare(`declare ptr @scr_regex_replace_fn(ptr, ptr, ptr, i32, i1 zeroext)`);
const result = B.tmp();
B.line(
`${result} = call ptr @scr_regex_replace_fn(ptr ${s.name}, ptr ${re.name}, ptr ${fn.name}, i32 ${arity}, i1 zeroext ${all.value})`,
);
const output = host.own({ name: result, type: e.type });
host.emitPendingCheck();
return output;
}
export function emitLibCall(host: LlvmEmitterContext, e: LibCallExpr): LlValue {
if (USES_TIMERS_LIB_FNS.has(e.fn)) host.usesTimers = true;
if (e.fn === "regex.replaceCallback") {
const typed = emitTypedRegexReplace(host, e);
if (typed) return typed;
}
if (e.fn === "process.nextTick") return host.emitAsyncContextLibCall(e);
if (
e.fn === "sp.pipeline" ||
@@ -774,6 +834,8 @@ export function emitLibCall(host: LlvmEmitterContext, e: LibCallExpr): LlValue {
case "blob":
case "record":
case "disposable":
case "punycode":
case "constants":
return host.emitGenericLibCall(e);
case "test":
return emitTestLibCall(host, e);
packages/compiler/src/backend/llvm/lib-filesystem.ts
+2 -5
View File
@@ -912,11 +912,8 @@ export function emitPathUrlLibCall(host: LlvmEmitterContext, e: LibCallExpr): Ll
scopeid.inline,
);
}
const rc = vAdapters(host.shapeHost, t);
const rowU = B.tmp();
B.line(
`${rowU} = call ptr @scr_union_new_ref(i32 ${tag}, ptr ${r}, ptr ${rc.retain}, ptr ${rc.release}, ptr ${traceArg(host.shapeHost, t)})`,
);
// The row (+1) moves into its union arm (a shape union is the row).
const rowU = host.unionNewOwned(infoT.unionId, tag, { name: r, type: t });
B.line(`store ptr ${rowU}, ptr ${rowSlot}`);
B.br(lRow);
};
packages/compiler/src/backend/llvm/lib-lookup.ts
+1 -1
View File
@@ -65,7 +65,7 @@ export function emitLookupConnect(host: LlvmEmitterContext, e: LibCallExpr): LlV
" br i1 %more, label %body, label %finish",
"body:",
" %record = call ptr @scr_arr_get_ref(ptr %addresses, double %index)",
` %addressp = getelementptr inbounds %${struct}, ptr %record, i64 0, i32 ${field + 1}`,
` %addressp = getelementptr inbounds %${struct}, ptr %record, i64 0, i32 ${field + host.nullableUnions.fieldBase(addresses.elem.shapeId)}`,
" %address = load ptr, ptr %addressp",
" %owned.address = call ptr @scr_str_retain_v(ptr %address)",
" call double @scr_arr_push_ref(ptr %ips, ptr %owned.address)",
packages/compiler/src/backend/llvm/lib-network.ts
+1 -1
View File
@@ -168,7 +168,7 @@ export function emitNetworkHttpLibCall(host: LlvmEmitterContext, e: LibCallExpr)
const i = shape.fields.findIndex((f) => f.name === name);
if (i < 0)
throw new InternalCompilerError(`llvm emitter bug: net.serverAddress record lacks ${name}`);
return i + 1;
return i + host.nullableUnions.fieldBase(recT.shapeId);
};
const store = (name: string, ty: string, v: string): void => {
const p = B.tmp();
packages/compiler/src/backend/llvm/lib-shared.ts
+9
View File
@@ -144,6 +144,7 @@ export const LIB_FN_SYMS: Record<string, string> = {
"num.toFixed0": "scr_num_to_fixed0",
"num.toFixed": "scr_num_to_fixed",
"num.toStringRadix": "scr_num_to_string_radix",
"num.toStringRadixF64": "scr_num_to_string_radix_f64",
"num.sameValue": "scr_num_same_value",
"intl.numFormatEnUs": "scr_intl_num_format_en_us",
"number.isFinite": "scr_num_is_finite",
@@ -194,6 +195,7 @@ export const LIB_FN_SYMS: Record<string, string> = {
"os.cpusModel": "scr_os_cpus_model",
"os.cpusField": "scr_os_cpus_field",
"os.constants": "scr_os_constants",
"constants.object": "scr_node_constants",
"os.release": "scr_os_release",
"os.userName": "scr_os_user_name",
"os.userShell": "scr_os_user_shell",
@@ -639,6 +641,13 @@ export const LIB_FN_SYMS: Record<string, string> = {
"url.legacyFormat": "scr_url_legacy_format",
"url.legacyResolve": "scr_url_legacy_resolve",
"url.domainToASCII": "scr_url_domain_to_ascii",
"punycode.decode": "scr_punycode_decode",
"punycode.encode": "scr_punycode_encode",
"punycode.toASCII": "scr_punycode_to_ascii",
"punycode.toUnicode": "scr_punycode_to_unicode",
"punycode.ucs2Decode": "scr_punycode_ucs2_decode",
"punycode.ucs2Encode": "scr_str_from_code_point",
"punycode.warn": "scr_punycode_warn",
"url.domainToUnicode": "scr_url_domain_to_unicode",
"url.pathToFileURL": "scr_url_from_path",
"url.pathToFileURLPlatform": "scr_url_from_path_platform",
packages/compiler/src/backend/llvm/nullable-unions.test.ts
+83
View File
@@ -0,0 +1,83 @@
import { expect, test } from "vitest";
import {
F64,
NULL_T,
UNDEFINED_T,
type IrModule,
type IrType,
type IrUnionDef,
} from "../../ir/ir.js";
import { NullableUnions } from "./nullable-unions.js";
const loc = { file: "nullable-unions.ts", start: 0, end: 0 };
const a: IrType = { kind: "record", shapeId: "a" };
const b: IrType = { kind: "record", shapeId: "b" };
const c: IrType = { kind: "record", shapeId: "c" };
function module(unions: IrUnionDef[], extra: Partial<IrModule> = {}): IrModule {
return {
irVersion: 16,
sourceFile: loc.file,
entry: "main",
records: ["a", "b", "c"].map((id) => ({ id, fields: [{ name: id, type: F64 }] })),
unions,
functions: [],
...extra,
};
}
test("unions of two or more records become shape unions", () => {
const unions = new NullableUnions(
module([
{ id: "ab", arms: [a, b] },
{ id: "abu", arms: [a, UNDEFINED_T, b] },
{ id: "abnu", arms: [a, b, NULL_T, UNDEFINED_T] },
{ id: "af", arms: [a, F64] },
{ id: "au", arms: [a, UNDEFINED_T] },
]),
);
expect(unions.shapes("ab")).toMatchObject({ unitTag: -1, nullTag: -1 });
expect(unions.shapes("abu")).toMatchObject({ unitTag: 1, nullTag: -1 });
expect(unions.shapes("abnu")).toMatchObject({ unitTag: 3, nullTag: 2 });
expect(unions.shapes("abnu")?.arms).toEqual([
{ tag: 0, shapeId: "a" },
{ tag: 1, shapeId: "b" },
]);
// A scalar arm keeps the box; one record arm is a single-arm nullable.
expect(unions.get("af")).toBeNull();
expect(unions.single("au")).not.toBeNull();
expect(unions.shapes("au")).toBeNull();
// Tagged shapes number from 2 and move their fields after the word.
expect([unions.shapeNumber("a"), unions.shapeNumber("b"), unions.shapeNumber("c")]).toEqual([
2, 3, 0,
]);
expect([unions.fieldBase("a"), unions.fieldBase("c")]).toEqual([2, 1]);
expect(unions.boxedUnions(new Map([["af", { id: "af", arms: [a, F64] }]])).size).toBe(1);
});
test("records of runtime-inspected unions keep every union over them boxed", () => {
const set: IrType = { kind: "set", elem: { kind: "union", unionId: "ab" } };
const unions = new NullableUnions(
module(
[
{ id: "ab", arms: [a, b] },
{ id: "abu", arms: [a, b, UNDEFINED_T] },
{ id: "bc", arms: [b, c] },
{ id: "ac", arms: [a, c] },
],
{ globals: [{ id: "%g.s", name: "s", type: set, mutable: false }] },
),
);
expect(unions.get("ab")).toBeNull();
expect(unions.get("abu")).toBeNull();
expect(unions.get("bc")).toBeNull();
expect(unions.get("ac")).toBeNull();
expect(unions.shapeNumber("c")).toBe(0);
});
test("library, lifetime-region and debug builds keep record unions boxed", () => {
const unions = [{ id: "ab", arms: [a, b] }];
expect(new NullableUnions(module(unions), false).get("ab")).toBeNull();
expect(new NullableUnions(module(unions, { lifetimeRegions: true })).get("ab")).toBeNull();
expect(new NullableUnions(module(unions)).shapes("ab")).not.toBeNull();
});
packages/compiler/src/backend/llvm/nullable-unions.ts
+145 -11
View File
@@ -17,6 +17,7 @@ import { everyModuleNode } from "../../ir/traverse.js";
* every container, field, capture, parameter, and return slot holds the
* plain pointer. Every other union keeps the tagged `%ScrUnion` box. */
export interface NullableUnion {
repr: "single";
unionId: string;
refTag: number;
/** The unit arm NULL encodes. */
@@ -24,7 +25,57 @@ export interface NullableUnion {
/** The `null` arm of a two-unit-arm union, encoded by NULLABLE_NULL;
* -1 when the union has one unit arm. */
nullTag: number;
arm: NullableRefArm;
/** One of NullableRefArm. Typed as the plain IrType so the self-hosted
* frontend keeps IrType's structurally identical arms one record shape
* (a PointerUnion arm holding the narrowed intersection would split them). */
arm: IrType;
}
/** A union of two or more record arms and at most two unit arms (`A | B`,
* `A | B | undefined`, discriminated unions of object literals) whose
* VALUES are the record pointer itself, like a NullableUnion: NULL is the
* unit arm (`undefined` when both exist, NULLABLE_NULL is then `null`).
* Every record shape that is an arm of such a union is a TAGGED shape: its
* struct carries the shape's module-wide number in a hidden `i32` word
* right after the reference count (struct index 1), stored by every
* allocation, so the arm of a pointer is that word mapped through the
* union's arm table (the per-union `@sc_stag.<id>` helper). Records share
* one retain; release and trace dispatch on the arm. */
export interface ShapeUnion {
repr: "shapes";
unionId: string;
/** The unit arm NULL encodes; -1 when the union has no unit arm. */
unitTag: number;
/** The `null` arm of a two-unit-arm union, encoded by NULLABLE_NULL;
* -1 otherwise. */
nullTag: number;
/** The record arms in tag order. */
arms: readonly { tag: number; shapeId: string }[];
}
/** A union whose values are plain pointers (no `%ScrUnion` box). */
export type PointerUnion = NullableUnion | ShapeUnion;
/** The struct index of a tagged record shape's hidden shape-number word. */
export const SHAPE_WORD_INDEX = 1;
/** The LLVM type through which any tagged record's shape word is read
* (the reference count, then the word). */
export function shapeWordHeader(sizeType: "i32" | "i64"): string {
return `{ ${sizeType}, i32 }`;
}
/** The per-union helper mapping a shape-union value to its tag. */
export function shapeTagFn(unionId: string): string {
return `@sc_stag.${unionId.replace(/[^A-Za-z0-9_.]/g, "_")}`;
}
/** The per-union release and trace dispatchers of a shape union. */
export function shapeReleaseFn(unionId: string): string {
return `@sc_srelease.${unionId.replace(/[^A-Za-z0-9_.]/g, "_")}`;
}
export function shapeTraceFn(unionId: string): string {
return `@sc_strace.${unionId.replace(/[^A-Za-z0-9_.]/g, "_")}`;
}
/** The module-scope immortal sentinel standing for `null` in a
@@ -48,44 +99,98 @@ export type NullableRefArm =
| (IrType & { kind: "array" | "map" | "set" });
/** The arm is a JS object: always truthy, compared by identity. */
export function isObjectArm(nullable: NullableUnion): boolean {
return nullable.arm.kind !== "string";
export function isObjectArm(nullable: PointerUnion): boolean {
return nullable.repr === "shapes" || nullable.arm.kind !== "string";
}
/** The representation decision for every union of one module. It is a
* pure function of the module, so serialized-IR and in-memory emission
* agree. */
export class NullableUnions {
private readonly byId = new Map<string, NullableUnion>();
private readonly byId = new Map<string, PointerUnion>();
/** Tagged record shapes (arms of a shape union) by their module-wide
* shape number (2 and up: 0 and 1 are the unit encodings' pseudo
* numbers, never stored). */
private readonly shapeNumbers = new Map<string, number>();
/** NULL-skipping retain wrappers requested so far: symbol → inner retain
* call target. The emitter defines each once. */
readonly retainWrappers = new Map<string, string>();
/** Some nullable union encodes `null` with NULLABLE_NULL. */
readonly usesNullSentinel: boolean = false;
constructor(mod: IrModule) {
/** `shapes`: allow shape unions (debug builds keep boxes, whose
* debug-info layouts describe every arm). */
constructor(mod: IrModule, shapes = true) {
const emitted = new Set<string>();
for (const cls of mod.classes ?? []) if (!cls.runtime) emitted.add(cls.name);
const records = new Set<string>();
for (const shape of mod.records ?? []) records.add(shape.id);
const boxed = boxedUnionIds(mod);
// Shape unions stay out of library builds (their host ABI marshals
// boxes) and of programs with lifetime regions (whose walks report a
// reference slot by its type's release entry point).
const allowShapes = shapes && mod.lib === undefined && mod.lifetimeRegions !== true;
// A record that is an arm of a boxed union never becomes a shape
// union's arm: conversions between unions over the same records then
// keep one representation.
const boxedRecords = new Set<string>();
for (const def of mod.unions ?? [])
if (boxed.has(def.id))
for (const arm of def.arms) if (arm.kind === "record") boxedRecords.add(arm.shapeId);
for (const def of mod.unions ?? []) {
if (boxed.has(def.id)) continue;
const nullable = nullableShape(def, emitted, records);
const nullable =
nullableShape(def, emitted, records) ??
(allowShapes ? shapeUnion(def, records, boxedRecords) : null);
if (!nullable) continue;
this.byId.set(def.id, nullable);
if (nullable.nullTag >= 0) this.usesNullSentinel = true;
if (nullable.repr === "shapes")
for (const arm of nullable.arms)
if (!this.shapeNumbers.has(arm.shapeId))
this.shapeNumbers.set(arm.shapeId, this.shapeNumbers.size + 2);
}
}
get(unionId: string): NullableUnion | null {
get(unionId: string): PointerUnion | null {
return this.byId.get(unionId) ?? null;
}
of(type: IrType): NullableUnion | null {
of(type: IrType): PointerUnion | null {
return type.kind === "union" ? this.get(type.unionId) : null;
}
/** The single-reference-arm form only (shape unions answer null). */
single(unionId: string): NullableUnion | null {
const nullable = this.byId.get(unionId);
return nullable?.repr === "single" ? nullable : null;
}
/** The shape-union form only. */
shapes(unionId: string): ShapeUnion | null {
const nullable = this.byId.get(unionId);
return nullable?.repr === "shapes" ? nullable : null;
}
/** Every shape union, in module order. */
allShapeUnions(): ShapeUnion[] {
const out: ShapeUnion[] = [];
for (const nullable of this.byId.values()) if (nullable.repr === "shapes") out.push(nullable);
return out;
}
/** The module-wide number a tagged record shape stores in its shape
* word, or 0 for shapes that carry none. */
shapeNumber(shapeId: string): number {
return this.shapeNumbers.get(shapeId) ?? 0;
}
/** The struct index of a record shape's first declared field: 2 for
* tagged shapes (after the shape word), 1 otherwise. */
fieldBase(shapeId: string): number {
return this.shapeNumbers.has(shapeId) ? 2 : 1;
}
has(unionId: string): boolean {
return this.byId.has(unionId);
}
@@ -94,10 +199,11 @@ export class NullableUnions {
return this.byId.size;
}
/** The reference arm of every nullable union, by union id. */
/** The reference arm of every single-arm nullable union, by union id. */
armTypes(): Map<string, IrType> {
const result = new Map<string, IrType>();
for (const [id, nullable] of this.byId) result.set(id, nullable.arm);
for (const [id, nullable] of this.byId)
if (nullable.repr === "single") result.set(id, nullable.arm);
return result;
}
@@ -129,7 +235,7 @@ function nullableShape(
if (unitTag < 0 || nullTag < 0) return null;
}
const arm = def.arms[refTag]!;
const base = { unionId: def.id, refTag, unitTag, nullTag };
const base = { repr: "single" as const, unionId: def.id, refTag, unitTag, nullTag };
if (arm.kind === "object" && emittedClasses.has(arm.className))
return { ...base, arm: { kind: "object", className: arm.className } };
if (arm.kind === "record" && records.has(arm.shapeId))
@@ -140,6 +246,34 @@ function nullableShape(
return null;
}
/** Two or more emitted record arms and at most two unit arms (both:
* undefined and null). */
function shapeUnion(
def: IrUnionDef,
records: ReadonlySet<string>,
boxedRecords: ReadonlySet<string>,
): ShapeUnion | null {
const units = def.arms.filter(isUnitType).length;
if (units > 2 || def.arms.length - units < 2) return null;
const arms: { tag: number; shapeId: string }[] = [];
for (let tag = 0; tag < def.arms.length; tag++) {
const arm = def.arms[tag]!;
if (isUnitType(arm)) continue;
if (arm.kind !== "record" || !records.has(arm.shapeId) || boxedRecords.has(arm.shapeId))
return null;
arms.push({ tag, shapeId: arm.shapeId });
}
let unitTag = -1,
nullTag = -1;
if (units === 1) unitTag = def.arms.findIndex(isUnitType);
else if (units === 2) {
unitTag = def.arms.findIndex((arm) => arm.kind === "undefinedT");
nullTag = def.arms.findIndex((arm) => arm.kind === "nullT");
if (unitTag < 0 || nullTag < 0) return null;
}
return { repr: "shapes", unionId: def.id, unitTag, nullTag, arms };
}
/** Unions the runtime itself inspects as tagged boxes keep that
* representation: Map keys and Set elements hash and compare union keys by
* tag and payload inside the C map. */
packages/compiler/src/backend/llvm/publish.ts
+21 -2
View File
@@ -25,6 +25,7 @@ import type { IrClassDef, IrRecordShape, IrType, IrUnionDef, SrcLoc } from "../.
import { mapOf, STRING, typeKey } from "../../ir/ir.js";
import { mangleClassStruct, mangleRecordStruct } from "../mangle.js";
import { FN_ATTRS } from "./shapes.js";
import { shapeTagFn } from "./nullable-unions.js";
import type { InlineUnionFields } from "./inline-unions.js";
import { LlvmUnsupportedError } from "./unsupported.js";
@@ -44,6 +45,10 @@ export interface PublishHost {
readonly inlineUnions: InlineUnionFields;
/** The nullable-pointer representation of a union, when it has one. */
nullableArm(t: IrType): IrType | null;
/** The union's values are tagged record pointers (nullable-unions.ts). */
shapeUnion(t: IrType): boolean;
/** The struct index of a record shape's first field. */
fieldBase(shapeId: string): number;
/** Class layout: hierarchy membership, preorder interval, field slots
* (with their storage types), runtime roots. */
classInfo(className: string): PublishClassInfo;
@@ -210,6 +215,19 @@ export class PublishWalkers {
if (def.arms.some((arm) => scalarRefusal(arm)))
throw new LlvmUnsupportedError(`publish of ${typeKey(t)}`, loc);
const live = arms.flatMap((a) => (a.fn === null ? [] : [{ tag: a.tag, fn: a.fn }]));
if (this.host.shapeUnion(t)) {
// The value is the record itself (or a unit encoding): no box to
// mark; the arm's walker marks and walks the record.
const lines = [head, `entry:`];
lines.push(
` %tag = call i32 ${shapeTagFn(t.unionId)}(ptr %o)`,
` switch i32 %tag, label %done [ ${live.map((a) => `i32 ${a.tag}, label %arm${a.tag}`).join(" ")} ]`,
);
for (const a of live)
lines.push(`arm${a.tag}:`, ` call void ${a.fn}(ptr %o, ptr %ctx)`, ` br label %done`);
lines.push(`done:`, ` ret void`, `}`);
return lines;
}
const lines = [
head,
`entry:`,
@@ -240,17 +258,18 @@ export class PublishWalkers {
const shape = this.host.recordsById.get(t.shapeId);
if (!shape)
throw new LlvmUnsupportedError(`publish of an unknown record ${t.shapeId}`, loc);
const base = this.host.fieldBase(shape.id);
const members = [
...shape.fields.flatMap((f, i) =>
this.host.inlineUnions.record(f.type)
? []
: [{ name: f.name, index: i + 1, type: f.type }],
: [{ name: f.name, index: i + base, type: f.type }],
),
...(shape.indexValue
? [
{
name: "[key: string]",
index: shape.fields.length + 1,
index: shape.fields.length + base,
type: mapOf(STRING, shape.indexValue),
},
]
packages/compiler/src/backend/llvm/regex-matchers.test.ts
+25
View File
@@ -2,6 +2,7 @@ import { describe, expect, test } from "vitest";
import {
compileRegexMatcher,
regexLiteralBailReason,
regexLiteralCaptures,
regexLiteralCompiles,
} from "./regex-matchers.js";
@@ -11,6 +12,30 @@ function body(pattern: string, flags = "", vector = true): string {
return code.lines.join("\n");
}
describe("regex literal captures", () => {
test("counts captures with the whole match and marks the ones every match sets", () => {
expect(regexLiteralCaptures("[&<>]", "g")).toEqual({ count: 1, always: [true] });
expect(regexLiteralCaptures("(\\w+)=(\\d)+", "")).toEqual({
count: 3,
always: [true, true, true],
});
expect(regexLiteralCaptures("(?<k>a)(b)?|(c)", "")).toEqual({
count: 4,
always: [true, false, false, false],
});
expect(regexLiteralCaptures("x(?:(a)|(b))y(c)*(d){0,2}(e){1,3}", "")).toEqual({
count: 6,
always: [true, false, false, false, false, true],
});
});
test("answers null outside the parsed subset", () => {
expect(regexLiteralCaptures("(?=a)(b)", "")).toBeNull();
expect(regexLiteralCaptures("(a)\\1", "")).toBeNull();
expect(regexLiteralCaptures("a", "v")).toBeNull();
});
});
describe("regex literal matcher subset", () => {
test.each([
['^(\\d+\\.\\d+\\.\\d+\\.\\d+) - - \\[([^\\]]+)\\] "(\\w+) ([^ ?"]+)(?:\\?([^ "]*))?$', ""],
packages/compiler/src/backend/llvm/regex-matchers.ts
+34
View File
@@ -1639,6 +1639,40 @@ function parseSubset(pattern: string, flags: string): { root: RxNode; ncap: numb
}
}
/** The capture count of a regex literal (the whole match included) and,
* per capture, whether every match sets it: no alternation of several
* branches and no repetition that can run zero times encloses it. Null
* when the pattern is outside the parsed subset. */
export function regexLiteralCaptures(
pattern: string,
flags: string,
): { count: number; always: boolean[] } | null {
const parsed = parseSubset(pattern, flags);
if (!parsed) return null;
const always = Array.from({ length: parsed.ncap }, (_, i) => i === 0);
const walk = (node: RxNode, sure: boolean): void => {
switch (node.kind) {
case "cap":
always[node.index] = sure;
walk(node.body, sure);
return;
case "seq":
for (const item of node.items) walk(item, sure);
return;
case "alt":
for (const alt of node.alts) walk(alt, sure && node.alts.length === 1);
return;
case "rep":
walk(node.body, sure && node.min > 0);
return;
default:
return;
}
};
walk(parsed.root, true);
return { count: parsed.ncap, always };
}
/** Whether a literal compiles to a native matcher (tests and size caps). */
export function regexLiteralCompiles(pattern: string, flags: string): boolean {
return parseSubset(pattern, flags) !== null;
packages/compiler/src/backend/llvm/regions.ts
+5 -4
View File
@@ -101,8 +101,8 @@ export class LifetimeRegions {
/** Can a value of type `t` hold (or own something that holds) a
* reference to a ProgramLifetime instance the walk can explain? */
private reaches(t: IrType): boolean {
const arm = this.host.nullableUnions.of(t)?.arm;
if (arm !== undefined) return this.reaches(arm);
const nullable = this.host.nullableUnions.of(t);
if (nullable?.repr === "single") return this.reaches(nullable.arm);
switch (t.kind) {
case "object":
return this.isLifetime(t.className) || this.reach.get(`object:${t.className}`) === true;
@@ -287,7 +287,8 @@ export class LifetimeRegions {
* ProgramLifetime instance). */
private reportLines(struct: string, f: Field, i: number): string[] {
if (!isRefCounted(f.type) || !this.reaches(f.type)) return [];
const arm = this.host.nullableUnions.of(f.type)?.arm ?? f.type;
const nullable = this.host.nullableUnions.of(f.type);
const arm = nullable?.repr === "single" ? nullable.arm : f.type;
const load = [
` %f${i} = getelementptr inbounds %${struct}, ptr %o, i64 0, i32 ${f.index}`,
` %v${i} = load ptr, ptr %f${i}`,
@@ -411,7 +412,7 @@ export class LifetimeRegions {
...this.reportBody(
`define internal void ${walk}(ptr %o, ptr %w) ${FN_ATTRS} { ; region walk record ${shape.id}`,
mangleRecordStruct(shape.id),
rcMembers(shape, this.host.inlineUnions),
rcMembers(shape, this.host.inlineUnions, this.host.nullableUnions.fieldBase(shape.id)),
),
);
rows.push(`{ ptr, ptr } { ptr @${mangleRecordRelease(shape.id)}, ptr ${walk} }`);
packages/compiler/src/backend/llvm/shapes.ts
+139 -11
View File
@@ -31,13 +31,23 @@ import {
import { cycTypeDescriptor, emitObjectAlloc, emitObjectFree } from "./alloc.js";
import type { BlockBuilder } from "./blocks.js";
import { SCR_ARR_FIELD, llvmCommentText } from "./common.js";
import type { NullableUnions } from "./nullable-unions.js";
import {
NULLABLE_NULL,
SHAPE_WORD_INDEX,
shapeReleaseFn,
shapeTagFn,
shapeTraceFn,
shapeWordHeader,
type NullableUnions,
type ShapeUnion,
} from "./nullable-unions.js";
import {
INLINE_UNION_FIELD,
loadInlineUnion,
stackUnionBox,
type InlineUnionFields,
} from "./inline-unions.js";
import { recordMayKeepSource } from "./record-sources.js";
import { LlvmUnsupportedError } from "./unsupported.js";
/** What the tables need from the emitter: the extern-declaration ledger
@@ -129,6 +139,7 @@ export { computeTraced } from "../cycle-analysis.js";
* `_v`-shaped. */
export function vAdapters(host: ShapeHost, t: IrType): { retain: string; release: string } {
const nullable = host.nullableUnions.of(t);
if (nullable?.repr === "shapes") return shapeUnionRc(nullable);
if (nullable) {
const arm = vAdapters(host, nullable.arm);
return { retain: nullableRetainSym(host, nullable.arm), release: arm.release };
@@ -184,6 +195,7 @@ export function vAdapters(host: ShapeHost, t: IrType): { retain: string; release
* Families with a mirrored fast path call the inline helper instead. */
export function retainSym(host: ShapeHost, t: IrType): string {
const nullable = host.nullableUnions.of(t);
if (nullable?.repr === "shapes") return shapeUnionRc(nullable).retain;
if (nullable) return nullableRetainSym(host, nullable.arm);
const stem = runtimeRcStem(t);
if (host.rcHelpers !== null && stem !== null && inlineRcFamily(host, stem, "retain") !== null) {
@@ -195,6 +207,99 @@ export function retainSym(host: ShapeHost, t: IrType): string {
return vAdapters(host, t).retain;
}
/** A shape union's RC entry points: every record retain is the same
* NULL- and immortal-skipping increment (the null sentinel is immortal),
* so the first arm's serves; release dispatches on the arm. */
function shapeUnionRc(union: ShapeUnion): { retain: string; release: string } {
return {
retain: `@${mangleRecordRetain(union.arms[0]!.shapeId)}`,
release: shapeReleaseFn(union.unionId),
};
}
/** The tag, release and trace helpers of every shape union
* (nullable-unions.ts). The tag helper maps a value to its arm: NULL and
* the null sentinel are the unit arms, anything else a tagged record whose
* shape word names its arm (the switch folds to a lookup table). */
export function emitShapeUnionHelpers(host: ShapeHost): string[] {
const out: string[] = [];
const S = host.sizeType;
for (const union of host.nullableUnions.allShapeUnions()) {
const header = shapeWordHeader(S);
const tagFn = shapeTagFn(union.unionId);
const cases = union.arms
.map((arm) => `i32 ${host.nullableUnions.shapeNumber(arm.shapeId)}, label %a${arm.tag}`)
.join(" ");
out.push(
`define internal i32 ${tagFn}(ptr %u) alwaysinline ${FN_ATTRS} { ; shape union tag`,
`entry:`,
` %isnull = icmp eq ptr %u, null`,
` br i1 %isnull, label %unit, label %ref`,
`unit:`,
` ret i32 ${union.unitTag}`,
`ref:`,
);
if (union.nullTag >= 0)
out.push(
` %isnullarm = icmp eq ptr %u, ${NULLABLE_NULL}`,
` br i1 %isnullarm, label %nullarm, label %rec`,
`nullarm:`,
` ret i32 ${union.nullTag}`,
`rec:`,
);
out.push(
` %wp = getelementptr inbounds ${header}, ptr %u, i32 0, i32 ${SHAPE_WORD_INDEX}`,
` %w = load i32, ptr %wp`,
` switch i32 %w, label %bad [ ${cases} ]`,
...union.arms.flatMap((arm) => [`a${arm.tag}:`, ` ret i32 ${arm.tag}`]),
`bad:`,
` ret i32 -1`,
`}`,
``,
);
// release: unit encodings are NULL or immortal; each arm releases
// through its own (NULL- and immortal-tolerant) helper.
out.push(
`define internal void ${shapeReleaseFn(union.unionId)}(ptr %u) ${FN_ATTRS} { ; shape union release`,
`entry:`,
` %t = call i32 ${tagFn}(ptr %u)`,
` switch i32 %t, label %done [ ${union.arms.map((arm) => `i32 ${arm.tag}, label %a${arm.tag}`).join(" ")} ]`,
...union.arms.flatMap((arm) => [
`a${arm.tag}:`,
` call void @${mangleRecordRelease(arm.shapeId)}(ptr %u)`,
` br label %done`,
]),
`done:`,
` ret void`,
`}`,
``,
);
if (shapeUnionTraced(host, union))
out.push(
`define internal void ${shapeTraceFn(union.unionId)}(ptr %u, ptr %visit, ptr %ctx) ${FN_ATTRS} { ; shape union trace`,
`entry:`,
` %t = call i32 ${tagFn}(ptr %u)`,
` switch i32 %t, label %done [ ${union.arms.map((arm) => `i32 ${arm.tag}, label %a${arm.tag}`).join(" ")} ]`,
...union.arms.flatMap((arm) => [
`a${arm.tag}:`,
` call void @${mangleRecordTrace(arm.shapeId)}(ptr %u, ptr %visit, ptr %ctx)`,
` br label %done`,
]),
`done:`,
` ret void`,
`}`,
``,
);
}
return out;
}
/** A shape union's arms carry collector headers (all or none: the emitter
* traces every arm of a union with one traced arm). */
function shapeUnionTraced(host: ShapeHost, union: ShapeUnion): boolean {
return union.arms.some((arm) => host.tracedShapes.has(`record:${arm.shapeId}`));
}
/** The retain entry point of a nullable union's value: the arm's own when
* it tolerates NULL (emitted class and record helpers), otherwise a
* NULL-skipping wrapper around it (the null sentinel and literals are
@@ -233,6 +338,7 @@ export function emitNullableRetainWrappers(host: ShapeHost): string[] {
* Families with a mirrored fast path call the inline helper instead. */
export function releaseSym(host: ShapeHost, t: IrType): string {
const nullable = host.nullableUnions.of(t);
if (nullable?.repr === "shapes") return shapeUnionRc(nullable).release;
if (nullable) return releaseSym(host, nullable.arm);
const stem = runtimeRcStem(t);
if (host.rcHelpers !== null && stem !== null && inlineRcFamily(host, stem, "release") !== null) {
@@ -643,6 +749,8 @@ export function traceAdapter(host: ShapeHost, t: IrType): string | null {
return "@scr_promise_trace_v";
case "union": {
const nullable = host.nullableUnions.get(t.unionId);
if (nullable?.repr === "shapes")
return shapeUnionTraced(host, nullable) ? shapeTraceFn(nullable.unionId) : null;
if (nullable) return traceAdapter(host, nullable.arm);
if (!host.tracedUnions.has(t.unionId)) return null;
host.declare(`declare void @scr_union_trace_v(ptr, ptr, ptr)`);
@@ -945,15 +1053,17 @@ export function mapValKindNum(value: IrType): number {
export function rcMembers(
shape: IrRecordShape,
inline: InlineUnionFields,
/** The struct index of the first field (2 on tagged shapes). */
base = 1,
): { index: number; type: IrType; name: string }[] {
return [
...shape.fields.flatMap((f, i) =>
inline.record(f.type) ? [] : [{ index: i + 1, type: f.type, name: f.name }],
inline.record(f.type) ? [] : [{ index: i + base, type: f.type, name: f.name }],
),
...(shape.indexValue
? [
{
index: shape.fields.length + 1,
index: shape.fields.length + base,
type: mapOf(STRING, shape.indexValue),
name: "[key: string] overflow",
},
@@ -1107,7 +1217,12 @@ export function directDestroyTarget(
}
function directDestroyKey(host: ShapeHost, type: IrType): string | null {
const t = host.nullableUnions.of(type)?.arm ?? type;
const nullable = host.nullableUnions.of(type);
let t = type;
if (nullable !== null) {
if (nullable.repr === "shapes") return null;
t = nullable.arm;
}
if (t.kind === "record") return `record:${t.shapeId}`;
return t.kind === "object" ? `object:${t.className}` : null;
}
@@ -1338,8 +1453,12 @@ export function emitRecordShapes(
for (const shape of records) {
const struct = mangleRecordStruct(shape.id);
const fieldTys = shape.fields.map((f) => llFieldType(f.type, host.inlineUnions.record(f.type)));
const fieldTys: string[] = shape.fields.map((f) =>
llFieldType(f.type, host.inlineUnions.record(f.type)),
);
if (shape.indexValue) fieldTys.push("ptr"); // the overflow ScrMap *
// A tagged shape (an arm of a shape union) carries its shape number.
if (host.nullableUnions.shapeNumber(shape.id) !== 0) fieldTys.unshift("i32");
typeDefs.push(
`%${struct} = type { ${host.sizeType}${fieldTys.length ? ", " + fieldTys.join(", ") : ""} } ` +
`; record ${shape.id} { ${shape.fields.map((f) => llvmCommentText(f.name)).join("; ")}${shape.indexValue ? "; [key: string]" : ""} }`,
@@ -1352,7 +1471,7 @@ export function emitRecordShapes(
const candidates: [string, DirectDestroy][] = [];
const memberTypes: IrType[] = [];
for (const shape of records) {
const members = rcMembers(shape, host.inlineUnions);
const members = rcMembers(shape, host.inlineUnions, host.nullableUnions.fieldBase(shape.id));
for (const m of members) memberTypes.push(m.type);
if (!members.some((m) => isRefCounted(m.type) && needsBoundedRelease(m.type))) continue;
const release = mangleRecordRelease(shape.id);
@@ -1370,7 +1489,9 @@ export function emitRecordShapes(
for (const shape of records) {
const struct = mangleRecordStruct(shape.id);
const traced = host.tracedShapes.has(`record:${shape.id}`);
const members = rcMembers(shape, host.inlineUnions);
const base = host.nullableUnions.fieldBase(shape.id);
const shapeNumber = host.nullableUnions.shapeNumber(shape.id);
const members = rcMembers(shape, host.inlineUnions, base);
const refMembers = members.filter((m) => isRefCounted(m.type));
const sizeOf = `ptrtoint (ptr getelementptr (%${struct}, ptr null, i32 1) to ${host.sizeType})`;
@@ -1404,7 +1525,9 @@ export function emitRecordShapes(
}
t++;
}
freeBody.push(...emitObjectFree(host, traced));
// Closed layouts can carry a kept record source (record-sources.ts).
const observers = recordMayKeepSource(shape) ? "weak-or-source" : "weak";
freeBody.push(...emitObjectFree(host, traced, observers));
defs.push(
...releaseBody(
host,
@@ -1439,6 +1562,11 @@ export function emitRecordShapes(
);
nw.push(...emitObjectAlloc(host, sizeOf, traced ? { type: cycType } : null));
nw.push(` store ${host.sizeType} 1, ptr %o`);
if (shapeNumber !== 0)
nw.push(
` %shp = getelementptr inbounds %${struct}, ptr %o, i64 0, i32 ${SHAPE_WORD_INDEX}`,
` store i32 ${shapeNumber}, ptr %shp ; shape number`,
);
if (shape.indexValue) {
// The overflow map (string-keyed): value handling is type-directed
// exactly like shapes.ts's overflowNewC.
@@ -1449,7 +1577,7 @@ export function emitRecordShapes(
const trace = valKind === 2 ? traceArg(host, v) : "null";
nw.push(
` %ovf = call ptr @scr_map_new(i32 1, i32 ${valKind}, ptr ${host.mapOps(["null", "null", "null", rc.retain, rc.release, trace, "null"])})`,
` %ovfp = getelementptr inbounds %${struct}, ptr %o, i64 0, i32 ${shape.fields.length + 1}`,
` %ovfp = getelementptr inbounds %${struct}, ptr %o, i64 0, i32 ${shape.fields.length + base}`,
` store ptr %ovf, ptr %ovfp`,
);
}
@@ -1465,7 +1593,7 @@ export function emitRecordShapes(
];
let i = 0;
for (const field of shape.fields) {
const index = i + 1;
const index = i + base;
const inline = host.inlineUnions.record(field.type);
const fieldTy = llFieldType(field.type, inline);
clone.push(
@@ -1514,7 +1642,7 @@ export function emitRecordShapes(
` call void ${releaseSym(host, m.type)}(ptr %v${i}) ; ${llvmCommentText(m.name)} (acyclic)`,
);
});
gf.push(...emitObjectFree(host, true), ` ret void`, `}`, ``);
gf.push(...emitObjectFree(host, true, observers), ` ret void`, `}`, ``);
defs.push(...gf);
}
}
packages/compiler/src/backend/llvm/stack-objects.ts
+14 -1
View File
@@ -21,6 +21,7 @@ import type { CallLifetimes } from "./call-lifetimes.js";
import { emitCallExpr, emitConstruction } from "./expr-calls.js";
import type { LlValue, LlvmEmitterContext } from "./expr-context.js";
import { emitRecordLitFields } from "./expr-primitives.js";
import { SHAPE_WORD_INDEX } from "./nullable-unions.js";
import { llFieldType } from "./shapes.js";
export type StackObjectSource = IrExpr & { kind: "recordLit" | "recordClone" | "new" | "call" };
@@ -196,12 +197,13 @@ export function stackObjectFields(
const cached = host.stackObjectFieldPtrs.get(slot);
if (cached) return cached;
const struct = stackObjectStruct(type);
const base = host.nullableUnions.fieldBase(type.shapeId);
const fields: StackObjectField[] = [];
host.recordShape(type.shapeId).fields.forEach((field, index) => {
if (!isRefCounted(field.type) || host.inlineUnions.record(field.type)) return;
const ptr = host.B.slot();
host.B.entryAllocas.push(
`${ptr} = getelementptr inbounds ${struct}, ptr ${slot}, i64 0, i32 ${index + 1}`,
`${ptr} = getelementptr inbounds ${struct}, ptr ${slot}, i64 0, i32 ${index + base}`,
);
fields.push({ name: field.name, ptr, type: field.type });
});
@@ -296,6 +298,17 @@ export function emitStackObject(
}
}
B.line(`store ${host.sizeType} -1, ptr ${slot}`);
if (type.kind === "record") {
// A tagged shape's word names it to every shape union's tag read.
const shapeNumber = host.nullableUnions.shapeNumber(type.shapeId);
if (shapeNumber !== 0) {
const p = B.tmp();
B.line(
`${p} = getelementptr inbounds ${struct}, ptr ${slot}, i64 0, i32 ${SHAPE_WORD_INDEX}`,
);
B.line(`store i32 ${shapeNumber}, ptr ${p}`);
}
}
if (e.kind === "call") {
// The entry writes the result into the slot it receives last.
emitCallExpr(
packages/compiler/src/backend/llvm/union-repr.ts
+27 -9
View File
@@ -2,14 +2,19 @@
* helper generators (walkers, dyn). A tagged union is a `%ScrUnion` box; a
* nullable union (nullable-unions.ts) is the arm pointer itself: NULL for
* its NULL-encoded unit arm and, in `C | null | undefined`, the immortal
* NULLABLE_NULL sentinel for `null`. Every structural read of a union value
* NULLABLE_NULL sentinel for `null`. A shape union's value is likewise the
* record pointer; its tag comes from the record's shape word. Every structural read of a union value
* goes through here. */
import type { BlockBuilder } from "./blocks.js";
import { NULLABLE_NULL, type NullableUnion } from "./nullable-unions.js";
import { NULLABLE_NULL, shapeTagFn, type PointerUnion } from "./nullable-unions.js";
/** The i32 tag of a union value. */
export function emitUnionTag(B: BlockBuilder, nullable: NullableUnion | null, u: string): string {
export function emitUnionTag(B: BlockBuilder, nullable: PointerUnion | null, u: string): string {
const t = B.tmp();
if (nullable?.repr === "shapes") {
B.line(`${t} = call i32 ${shapeTagFn(nullable.unionId)}(ptr ${u})`);
return t;
}
if (nullable) {
const isNull = B.tmp();
B.line(`${isNull} = icmp eq ptr ${u}, null`);
@@ -32,8 +37,13 @@ export function emitUnionTag(B: BlockBuilder, nullable: NullableUnion | null, u:
/** i1: a nullable union value holds its reference arm (neither NULL nor
* the `null` sentinel). */
export function emitNullablePresent(B: BlockBuilder, nullable: NullableUnion, u: string): string {
export function emitNullablePresent(B: BlockBuilder, nullable: PointerUnion, u: string): string {
const present = B.tmp();
if (nullable.repr === "shapes" && nullable.unitTag < 0) {
// No unit arm: every value is a record (NULL only as a pending dummy).
B.line(`${present} = icmp ne ptr ${u}, null`);
return present;
}
B.line(`${present} = icmp ne ptr ${u}, null`);
if (nullable.nullTag < 0) return present;
const notNullArm = B.tmp(),
@@ -46,12 +56,18 @@ export function emitNullablePresent(B: BlockBuilder, nullable: NullableUnion, u:
/** i1: a nullable union value holds the arm `tag` (`negated`: does not). */
export function emitNullableIsTag(
B: BlockBuilder,
nullable: NullableUnion,
nullable: PointerUnion,
u: string,
tag: number,
negated: boolean,
): string {
if (tag === nullable.refTag) {
if (nullable.repr === "shapes" && tag !== nullable.unitTag && tag !== nullable.nullTag) {
const actual = emitUnionTag(B, nullable, u),
t = B.tmp();
B.line(`${t} = icmp ${negated ? "ne" : "eq"} i32 ${actual}, ${tag}`);
return t;
}
if (nullable.repr === "single" && tag === nullable.refTag) {
const present = emitNullablePresent(B, nullable, u);
if (!negated) return present;
const t = B.tmp();
@@ -65,7 +81,7 @@ export function emitNullableIsTag(
}
/** The BORROWED payload pointer of a reference arm. */
export function emitUnionPeek(B: BlockBuilder, nullable: NullableUnion | null, u: string): string {
export function emitUnionPeek(B: BlockBuilder, nullable: PointerUnion | null, u: string): string {
if (nullable) return u;
const p = B.tmp();
const t = B.tmp();
@@ -76,7 +92,9 @@ export function emitUnionPeek(B: BlockBuilder, nullable: NullableUnion | null, u
/** Text-template forms for helpers written as raw LLVM lines: `%out`
* receives the tag / payload of `u`. */
export function unionTagLines(nullable: NullableUnion | null, u: string, out: string): string[] {
export function unionTagLines(nullable: PointerUnion | null, u: string, out: string): string[] {
if (nullable?.repr === "shapes")
return [` ${out} = call i32 ${shapeTagFn(nullable.unionId)}(ptr ${u})`];
if (nullable && nullable.nullTag < 0)
return [
` ${out}.isnull = icmp eq ptr ${u}, null`,
@@ -95,7 +113,7 @@ export function unionTagLines(nullable: NullableUnion | null, u: string, out: st
];
}
export function unionPeekLines(nullable: NullableUnion | null, u: string, out: string): string[] {
export function unionPeekLines(nullable: PointerUnion | null, u: string, out: string): string[] {
// A plain copy of the pointer (NULL included) under the template's name.
if (nullable) return [` ${out} = getelementptr i8, ptr ${u}, i64 0`];
return [
packages/compiler/src/backend/llvm/union-retype.test.ts
+17 -2
View File
@@ -183,7 +183,9 @@ test("a nullable-pointer source rebuilds the target box", () => {
expect(retag).not.toContain("retype.share");
});
async function llvmFor(source: string): Promise<{ module: IrModule; ir: string }> {
/** `boxed`: keep every union a tagged box (record unions otherwise become
* shape unions, which retype without any box). */
async function llvmFor(source: string, boxed = true): Promise<{ module: IrModule; ir: string }> {
const dir = await mkdtemp(join(tmpdir(), "scriptc-union-retype-"));
try {
const entry = join(dir, "main.ts"),
@@ -194,7 +196,7 @@ async function llvmFor(source: string): Promise<{ module: IrModule; ir: string }
throw new Error(result.diagnostics.map((item) => `${item.code}: ${item.message}`).join("\n"));
const module = deserializeModule(await readFile(output, "utf8"));
expect(validateModule(module)).toEqual([]);
return { module, ir: emitLlvmModule(module) };
return { module, ir: emitLlvmModule(boxed ? keepUnionsBoxed(module) : module) };
} finally {
await rm(dir, { recursive: true, force: true });
}
@@ -253,3 +255,16 @@ console.log(leafValue(parsed));
expect(stored).not.toBeNull();
expect(ir).toContain(`load i8, ptr ${stored![1]}`);
});
test("record unions retype as the record pointer itself", async () => {
const { module, ir } = await llvmFor(VISITOR, false);
const helpers = module.functions.filter((fn) => fn.name.startsWith("%union.retag."));
expect(helpers.length).toBeGreaterThan(0);
for (const helper of helpers) {
const symbol = `sc_bf__x25_union_retag_${helper.name.slice("%union.retag.".length)}`;
const retag = body(ir, symbol);
expect(retag).not.toMatch(/@scr_union_new|retype\.share|sc_retype_guard/);
}
// No record of the visitor is ever boxed.
expect(ir).not.toMatch(/call ptr @scr_union_new_ref/);
});
packages/compiler/src/backend/llvm/walkers.ts
+24 -3
View File
@@ -28,6 +28,7 @@ import {
traceAdapter,
type ShapeHost,
} from "./shapes.js";
import { disposeHookLoadLines, RECORD_SOURCES_GATE } from "./alloc.js";
import { recordMayKeepSource, recordSourceFieldOrder } from "./record-sources.js";
import { LlvmUnsupportedError } from "./unsupported.js";
import { emitUnionPeek, emitUnionTag } from "./union-repr.js";
@@ -284,7 +285,8 @@ export class LlWalkers {
throw new InternalCompilerError(
`llvm emitter bug: jsonStringify of unknown shape ${shapeId}`,
);
const fieldIndex = new Map(shape.fields.map((f, i) => [f.name, i + 1]));
const fieldBase = this.host.nullableUnions.fieldBase(shapeId);
const fieldIndex = new Map(shape.fields.map((f, i) => [f.name, i + fieldBase]));
if (recordMayKeepSource(shape)) this.emitRecordSourceWriter(B, shapeId);
// CYCLE-CAPABLE shapes bracket the walk with the circular-detection
// stack; edge labels stamp before members whose walk can re-enter —
@@ -396,6 +398,24 @@ export class LlWalkers {
const writer = this.recordFieldWriter(shapeId);
const lSource = B.newLabel("jw.source");
const lNative = B.newLabel("jw.native");
// Only a program that can keep record sources looks one up (the gate
// folds to a constant), and only once one was kept: keeping a source
// installs the dispose hook, so a NULL hook means the table is empty.
const lHooked = B.newLabel("jw.hooked");
const kept = B.tmp();
B.line(`${kept} = load i1, ptr ${RECORD_SOURCES_GATE}`);
B.condBr(kept, lHooked, lNative);
B.startBlock(lHooked);
const hook = B.tmp();
const hookLines = disposeHookLoadLines(host, hook);
if (hookLines !== null) {
const lProbe = B.newLabel("jw.probe");
for (const line of hookLines) B.line(line.trimStart());
const installed = B.tmp();
B.line(`${installed} = icmp ne ptr ${hook}, null`);
B.condBr(installed, lProbe, lNative);
B.startBlock(lProbe);
}
if (traceAdapter(host, { kind: "record", shapeId }) === null) {
// One lookup: the runtime writes the record when it kept a source.
host.declare(`declare zeroext i1 @scr_jb_try_record_source(ptr, ptr, ptr)`);
@@ -437,7 +457,8 @@ export class LlWalkers {
throw new InternalCompilerError(`llvm emitter bug: field writer of unknown shape ${shapeId}`);
const name = `sc_jwf_${this.recordFieldWriters.size}`;
this.recordFieldWriters.set(shapeId, name);
const fieldIndex = new Map(shape.fields.map((f, i) => [f.name, i + 1]));
const fieldBase = this.host.nullableUnions.fieldBase(shapeId);
const fieldIndex = new Map(shape.fields.map((f, i) => [f.name, i + fieldBase]));
const byName = new Map(shape.fields.map((f) => [f.name, f]));
const cyclic = traceAdapter(this.host, { kind: "record", shapeId }) !== null;
const order = recordSourceFieldOrder(shape);
@@ -534,7 +555,7 @@ export class LlWalkers {
const ovfp = B.tmp();
const ovf = B.tmp();
B.line(
`${ovfp} = getelementptr inbounds %${mangleRecordStruct(shape.id)}, ptr %v, i64 0, i32 ${shape.fields.length + 1}`,
`${ovfp} = getelementptr inbounds %${mangleRecordStruct(shape.id)}, ptr %v, i64 0, i32 ${shape.fields.length + this.host.nullableUnions.fieldBase(shape.id)}`,
);
B.line(`${ovf} = load ptr, ptr ${ovfp} ; overflow map`);
if (iv.kind === "dyn") {
packages/compiler/src/cli/command.ts
+40 -3
View File
@@ -7,8 +7,10 @@ import {
coverageEnvelope,
coveragePasses,
renderCoverage,
renderExplainDynamic,
type CoverageFailOn,
} from "../coverage/report.js";
import { TIER_MODES, type TierMode } from "../frontend/tier-analysis.js";
import { buildEnvelope } from "../diagnostics/envelope.js";
import { renderWarnings } from "../diagnostics/render.js";
import { isNativeOptimization } from "../backend/optimization.js";
@@ -45,8 +47,15 @@ function parseCli(
): ReturnType<
typeof parseArgs<{ options: typeof CLI_OPTIONS; allowPositionals: true; allowNegative: true }>
> {
// `--explain-dynamic` takes an optional value: alone it lists every unit.
const normalized = args.map((arg) => (arg === "--explain-dynamic" ? "--explain-dynamic=" : arg));
try {
return parseArgs({ args, options: CLI_OPTIONS, allowPositionals: true, allowNegative: true });
return parseArgs({
args: normalized,
options: CLI_OPTIONS,
allowPositionals: true,
allowNegative: true,
});
} catch (err) {
// parseArgs appends a paragraph about `--` and positionals to the
// unknown-option message; the first sentence is the part that names
@@ -91,6 +100,8 @@ async function main(args: string[], host: CliHost): Promise<number> {
externalTypeArgs.length > 0 ||
values.out !== undefined ||
values["emit-ir"] ||
values.tier !== undefined ||
values["explain-dynamic"] !== undefined ||
!values["keep-llvm"]
) {
fail(
@@ -152,10 +163,12 @@ async function main(args: string[], host: CliHost): Promise<number> {
values["windows-subsystem"] !== undefined ||
values["detached-exit"] ||
(values["npm-static"] ?? []).length > 0 ||
externalTypeArgs.length > 0
externalTypeArgs.length > 0 ||
values.tier !== undefined ||
values["explain-dynamic"] !== undefined
) {
fail(
"scriptc build --lib takes no --backend/--emit/--print/--optimization/--strip/--windows-subsystem/--detached-exit/--npm-static/--ffi/--external-types: the profile pins the emission and optimization, npm imports are judged automatically, outbound FFI belongs to executable builds, and external type mappings belong to coverage",
"scriptc build --lib takes no --backend/--emit/--print/--optimization/--strip/--windows-subsystem/--detached-exit/--npm-static/--ffi/--external-types/--tier/--explain-dynamic: the profile pins the emission and optimization, npm imports are judged automatically, outbound FFI belongs to executable builds, external type mappings belong to coverage, and library artifacts are static-tier only",
);
}
const profilePath = resolve(profileArg);
@@ -223,6 +236,15 @@ async function main(args: string[], host: CliHost): Promise<number> {
fail(`--fail-on is a coverage option (a build already fails on blockers)\n\n${USAGE}`);
}
const failOn = failOnRaw as CoverageFailOn | undefined;
const tierRaw = values.tier;
if (tierRaw !== undefined && !(TIER_MODES as readonly string[]).includes(tierRaw)) {
fail(`unknown --tier value "${tierRaw}" (supported: ${TIER_MODES.join(", ")})\n\n${USAGE}`);
}
const tier = tierRaw as TierMode | undefined;
const explainDynamic = values["explain-dynamic"];
if (explainDynamic !== undefined && command !== "coverage") {
fail(`--explain-dynamic is a coverage option\n\n${USAGE}`);
}
if (printNativeLinkInfo && command !== "build") {
fail(`--print=native-link-info is a build option\n\n${USAGE}`);
}
@@ -340,6 +362,8 @@ async function main(args: string[], host: CliHost): Promise<number> {
...(npmStatic !== undefined ? { npmStatic } : {}),
...(ffiProfilePath !== undefined ? { ffiProfilePath } : {}),
...(Object.keys(externalTypes).length > 0 ? { externalTypes } : {}),
...(tier !== undefined ? { tier } : {}),
...(explainDynamic !== undefined ? { explainDynamic: true } : {}),
});
if (printDiagnostics) {
// Keep stdout pure JSON for tooling.
@@ -354,6 +378,18 @@ async function main(args: string[], host: CliHost): Promise<number> {
process.stdout.write(
renderCoverage(coverage, { color, sourceTexts, root: process.cwd() }) + "\n",
);
if (explainDynamic !== undefined && coverage.tiers !== undefined) {
process.stdout.write(
"\n" +
renderExplainDynamic(coverage.tiers, {
color,
sourceTexts,
root: process.cwd(),
query: explainDynamic,
}) +
"\n",
);
}
}
return coveragePasses(coverage, failOn) ? 0 : 1;
}
@@ -386,6 +422,7 @@ async function main(args: string[], host: CliHost): Promise<number> {
...(npmStatic !== undefined ? { npmStatic } : {}),
...(ffiProfilePath !== undefined ? { ffiProfilePath } : {}),
...(printNativeLinkInfo ? { nativeLinkInfo: true } : {}),
...(tier !== undefined ? { tier } : {}),
});
if (!result.ok) {
if (printDiagnostics) {
packages/compiler/src/cli/usage.ts
+14 -1
View File
@@ -57,7 +57,8 @@ Options:
compile the named npm packages' shipped JS statically as
program modules (repeatable; "auto" opts in every eligible
direct import: own .d.ts, unminified JS, no build-transform
markers). Packages that fail preflight are refused with a
markers; "pkg..." also names every package pkg depends
on). Packages that fail preflight are refused with a
diagnostic. Eligible dependencies compile automatically.
--provenance-sources
EXPERIMENTAL: compile npm dependencies from their
@@ -69,6 +70,16 @@ Options:
local declaration file. The declaration supplies types
for analysis; the host module remains an explicit
external-boundary blocker (repeatable)
--tier <auto|static-only>
tier policy (default: auto). static-only keeps every
construct without a static lowering a compile error, so
the program has no dynamic-tier demotions. Both modes
currently compile identically
--explain-dynamic[=<name>]
coverage only: list the functions that operate on dynamic
values and the bindings, fields, functions, classes and
modules the dynamic tier would take over, with the
refusal behind each; a name shows only that unit's chain
-h, --help show this help
-v, --version print the version
`;
@@ -90,6 +101,8 @@ export const CLI_OPTIONS = {
"npm-static": { type: "string", multiple: true },
"provenance-sources": { type: "boolean", default: false },
"external-types": { type: "string", multiple: true },
tier: { type: "string" },
"explain-dynamic": { type: "string" },
lib: { type: "boolean", default: false },
profile: { type: "string" },
help: { type: "boolean", short: "h", default: false },
packages/compiler/src/compile-types.ts
+10
View File
@@ -3,6 +3,7 @@ import type { NativeLinkInfo } from "./backend/native-link-info.js";
import type { NativeOptimization } from "./backend/optimization.js";
import type { ScrDiagnostic } from "./diagnostics/diagnostic.js";
import type { CoverageInput } from "./coverage/report.js";
import type { TierMode } from "./frontend/tier-analysis.js";
export type CompileOutputKind = "ir" | "llvm" | "asm" | "obj" | "exe";
@@ -45,6 +46,10 @@ export interface CompileBaseOptions {
/** Attach the machine-readable external link recipe to an object result.
* Valid only with outputKind "obj"; it never invokes a linker. */
nativeLinkInfo?: boolean;
/** `--tier` (frontend/tier-analysis.ts). "static-only" keeps every demotion
* request a refusal (design invariant I2). Until demotion lands both modes
* compile exactly as before. */
tier?: TierMode;
}
/** Executable compile options. This remains the compatibility type for the
@@ -161,6 +166,11 @@ export interface AnalyzeOptions {
* to analyze project code, but imported runtime values remain explicit
* SC1010 blockers rather than being counted as executable. */
externalTypes?: Readonly<Record<string, string>>;
/** `--tier` (see CompileBaseOptions.tier). */
tier?: TierMode;
/** `--explain-dynamic`: attach the tier-assignment report
* (CoverageInput.tiers). Such analyses bypass the verdict cache. */
explainDynamic?: boolean;
}
export interface AnalyzeResult {
packages/compiler/src/coverage/report.ts
+149 -1
View File
@@ -17,10 +17,13 @@ import {
type DiagnosticsEnvelope,
type LocatedDiagnostic,
type SourcePosition,
type TierUnitPosition,
type TiersEnvelope,
} from "../diagnostics/envelope.js";
import { renderDiagnostics } from "../diagnostics/render.js";
import type { LowerStats } from "../frontend/lowering/lowerer.js";
import type { ProvenanceSources } from "../frontend/provenance-registry.js";
import type { DemotionUnit, TierReport } from "../frontend/tier-analysis.js";
export interface CoverageInput {
file: string;
@@ -51,6 +54,9 @@ export interface CoverageInput {
/** --provenance-sources: diagnostics of elided pure-annotated dead
* consts (off the build; the provenance section names them). */
provenanceElided?: ScrDiagnostic[];
/** --explain-dynamic: the report-only tier assignment (which bindings,
* fields, functions, classes and modules the dynamic tier would take). */
tiers?: TierReport;
/** True when tsc preflight failed — no coverage can be computed. */
preflightFailed: boolean;
}
@@ -61,6 +67,8 @@ export interface NpmStaticStatus {
status: "static" | "refused";
/** The first refusal reason for a refused package. */
detail?: string;
/** How to act on the refusal, when there is a specific remedy. */
hint?: string;
}
const GREEN = "\x1b[32m";
@@ -180,6 +188,12 @@ export function renderCoverage(input: CoverageInput, opts: CoverageRenderOptions
out.push(` statements analyzed ${total}`);
out.push(` compile statically ${ok} ${c(pctColor, c(BOLD, `(${pct}%)`))}`);
const dynamic = dynamicStatements(input);
if (dynamic > 0) {
out.push(
` in dynamic tier ${dynamic} ${c(DIM, "(operate on values typed only at runtime; --explain-dynamic lists them)")}`,
);
}
if (skipped > 0) {
out.push(
@@ -432,13 +446,147 @@ export function coverageEnvelope(
stats: {
statementsTotal: total,
statementsStatic: ok,
statementsDynamic: 0,
statementsDynamic: dynamicStatements(input),
statementsFailed: failed,
functionsSkipped: skipped,
percentStatic: total === 0 ? 100 : Math.floor((ok / total) * 100),
},
}),
...(input.tiers !== undefined ? { tiers: tiersEnvelope(input.tiers, locator) } : {}),
groups,
diagnostics: located,
};
}
/** Reached statements in dynamic-tier functions, never more than the
* compiled statements they are part of. */
function dynamicStatements(input: CoverageInput): number {
const compiled = input.stats.statementsTotal - input.stats.statementsFailed;
return Math.max(0, Math.min(input.stats.statementsDynamic ?? 0, compiled));
}
function tiersEnvelope(tiers: TierReport, locator: SourceLocator): TiersEnvelope {
const at = (loc: { file: string; start: number }): SourcePosition => ({
file: loc.file,
...locator.position(loc.file, loc.start),
});
const unit = (u: DemotionUnit): TierUnitPosition => ({
kind: u.kind,
name: u.name,
...(u.owner !== undefined ? { owner: u.owner } : {}),
...at(u.loc),
});
return {
mode: tiers.mode,
statementsDynamic: tiers.statementsDynamic,
dynamicFunctions: tiers.dynamicFunctions.map((fn) => ({
name: fn.name,
...at(fn.loc),
operation: fn.operation,
operationAt: at(fn.operationLoc),
statements: fn.statements,
})),
requests: tiers.requests.map((r) => ({
unit: unit(r.unit),
enclosing: unit(r.enclosing),
seed: r.seed,
scope: r.scope,
code: r.code,
message: r.message,
...at(r.loc),
})),
units: tiers.units.map((u) => ({ ...unit(u), requests: u.requests, sites: u.sites })),
};
}
/** IR function names as a user reads them: `%init.3` is a module's top
* level, `%Point.norm` the method `Point.norm`; generated helpers keep
* their `%`-prefixed names. */
function functionDisplayName(name: string): string {
if (name.startsWith("%init.")) return "<top level>";
if (/^%[A-Za-z_$][\w$]*\.[A-Za-z_$#][\w$]*$/.test(name)) return name.slice(1);
return name;
}
function unitLabel(u: DemotionUnit, root: string | undefined): string {
if (u.kind === "module") return `module ${displayPath(u.name, root)}`;
if (u.kind === "binding" && u.owner !== undefined) return `binding ${u.name} in ${u.owner}`;
return `${u.kind} ${u.name}`;
}
function unitMatches(u: DemotionUnit, query: string): boolean {
return (
u.name === query ||
u.name.endsWith(`.${query}`) ||
u.name.split(" ")[0] === query ||
`${u.owner ?? ""}:${u.name}` === query
);
}
/** `scriptc coverage --explain-dynamic[=<unit>]`: the dynamic tier today
* and the demotion chains the report-only analysis computed. With a query,
* only units whose name matches it (`x`, `Point.x`, `parse:x`). */
export function renderExplainDynamic(
tiers: TierReport,
opts: CoverageRenderOptions & { query?: string } = {},
): string {
const c = (code: string, s: string) => (opts.color ? code + s + RESET : s);
const locator = new SourceLocator(opts.sourceTexts);
const where = (loc: { file: string; start: number }) => {
const p = locator.position(loc.file, loc.start);
return `${displayPath(loc.file, opts.root)}:${p.line}:${p.column}`;
};
const query = opts.query !== undefined && opts.query !== "" ? opts.query : undefined;
const out: string[] = [];
out.push(
` ${c(BOLD, "dynamic tier")} ${c(DIM, `(tier assignment, report-only; --tier=${tiers.mode})`)}`,
);
if (query === undefined) {
const fns = tiers.dynamicFunctions;
out.push(
` ${fns.length} function${fns.length === 1 ? "" : "s"} already operate${fns.length === 1 ? "s" : ""} on dynamic values ${c(DIM, `(${tiers.statementsDynamic} statement${tiers.statementsDynamic === 1 ? "" : "s"})`)}`,
);
for (const fn of fns) {
out.push(
` ${functionDisplayName(fn.name)} ${c(DIM, `${where(fn.loc)}: ${fn.operation} at ${where(fn.operationLoc)}`)}`,
);
}
}
const live = tiers.requests.filter((r) => r.scope !== "unreached" && r.seed !== "excluded");
const excluded = tiers.requests.filter((r) => r.seed === "excluded").length;
const unreached = tiers.requests.filter((r) => r.scope === "unreached").length;
if (query === undefined) {
out.push("");
out.push(
` ${live.length} demotion request${live.length === 1 ? "" : "s"} ${c(DIM, "(refusals and fences the dynamic tier would replace)")}` +
(unreached > 0 ? c(DIM, `, ${unreached} more in unreached code`) : "") +
(excluded > 0 ? c(DIM, `, ${excluded} excluded by policy`) : ""),
);
}
const units = tiers.units.filter((u) => query === undefined || unitMatches(u, query));
if (query !== undefined && units.length === 0) {
out.push(` no demoted unit matches '${query}'`);
return out.join("\n");
}
for (const u of units) {
const counts = [
u.requests > 0 ? `${u.requests} request${u.requests === 1 ? "" : "s"}` : "",
u.sites > 0 ? `${u.sites} site${u.sites === 1 ? "" : "s"} inside` : "",
]
.filter((s) => s !== "")
.join(", ");
out.push(` ${unitLabel(u, opts.root)} ${c(DIM, `${where(u.loc)} (${counts})`)}`);
if (query === undefined && u.requests === 0) continue;
for (const r of live) {
if (r.unit.kind !== u.kind || r.unit.name !== u.name || r.unit.loc.start !== u.loc.start)
continue;
if (r.unit.loc.file !== u.loc.file) continue;
out.push(
` ${c(DIM, "<-")} ${r.code} ${r.seed} at ${where(r.loc)}: ${capMessage(r.message)}`,
);
if (r.enclosing.name !== r.unit.name || r.enclosing.kind !== r.unit.kind)
out.push(` ${c(DIM, "->")} ${unitLabel(r.enclosing, opts.root)} turns dynamic`);
}
}
return out.join("\n");
}
packages/compiler/src/coverage/verdict-cache.ts
+5
View File
@@ -89,6 +89,9 @@ export function verdictKey(
opts: AnalyzeOptions,
cache: VerdictCacheOptions,
): string | null {
// The tier report carries source locations the semantic replay does not
// move; explaining analyses always lower.
if (opts.explainDynamic === true) return null;
let ffi = "";
if (opts.ffiProfilePath !== undefined) {
try {
@@ -120,6 +123,8 @@ export function verdictKey(
opts.ffiProfilePath ?? "",
ffi,
external.join("\n"),
// Demotion (stage S6) makes the tier mode part of the verdict.
...(opts.tier === "static-only" ? ["tier=static-only"] : []),
].join("\0"),
);
}
packages/compiler/src/diagnostics/diagnostic.ts
+9 -2
View File
@@ -866,13 +866,20 @@ export function unsupportedPackageValueDiag(pkg: string, loc: SrcLoc): ScrDiagno
);
}
export function npmStaticRefusalDiag(pkg: string, detail: string, loc: SrcLoc): ScrDiagnostic {
export function npmStaticRefusalDiag(
pkg: string,
detail: string,
loc: SrcLoc,
hint?: string,
): ScrDiagnostic {
return {
code: "SC2013",
message: `cannot compile npm package '${pkg}' statically: ${detail}`,
loc,
milestone: "later",
hint: "use a dependency with supported source, or replace the unsupported operation; scriptc has no interpreter fallback",
hint:
hint ??
"use a dependency with supported source, or replace the unsupported operation; scriptc has no interpreter fallback",
};
}
packages/compiler/src/diagnostics/envelope.ts
+34 -2
View File
@@ -81,6 +81,34 @@ export interface DiagnosticGroup {
sites: SourcePosition[];
}
export interface TierUnitPosition extends SourcePosition {
kind: "binding" | "field" | "function" | "class" | "module";
name: string;
owner?: string;
}
/** `scriptc coverage --explain-dynamic --print=diagnostics`: the tier
* assignment of frontend/tier-analysis.ts with source positions. */
export interface TiersEnvelope {
mode: "auto" | "static-only";
statementsDynamic: number;
dynamicFunctions: (SourcePosition & {
name: string;
operation: string;
operationAt: SourcePosition;
statements: number;
})[];
requests: (SourcePosition & {
unit: TierUnitPosition;
enclosing: TierUnitPosition;
seed: string;
scope: string;
code: string;
message: string;
})[];
units: (TierUnitPosition & { requests: number; sites: number })[];
}
export interface DiagnosticsEnvelope {
schema: typeof DIAGNOSTICS_SCHEMA;
schemaVersion: typeof DIAGNOSTICS_SCHEMA_VERSION;
@@ -97,8 +125,10 @@ export interface DiagnosticsEnvelope {
stats?: {
statementsTotal: number;
statementsStatic: number;
/** Always 0: every compiled statement is native. Kept so schema
* version 1 consumers keep reading the same fields. */
/** The compiled statements (counted in statementsStatic, which covers
* every statement that compiles to native code) that belong to
* dynamic-tier functions: code operating on values whose types are only
* known at runtime. */
statementsDynamic: number;
statementsFailed: number;
functionsSkipped: number;
@@ -106,6 +136,8 @@ export interface DiagnosticsEnvelope {
};
/** build only: the produced artifact path. */
artifact?: string;
/** coverage --explain-dynamic only: the report-only tier assignment. */
tiers?: TiersEnvelope;
groups: DiagnosticGroup[];
diagnostics: LocatedDiagnostic[];
}
packages/compiler/src/executable/prepare.ts
+2
View File
@@ -59,6 +59,7 @@ export function prepareExecutableModule(
entry.package,
entry.detail ?? "its static compilation was refused",
fe.npmImportSites.get(entry.package) ?? { file: entryPath, start: 0, end: 0 },
entry.hint,
),
),
);
@@ -69,6 +70,7 @@ export function prepareExecutableModule(
lowered = fe.lower({
targetPlatform: buildPlatform,
...(ffi !== null ? { ffiImports: ffi.functions } : {}),
...(opts.tier !== undefined ? { tierMode: opts.tier } : {}),
});
timing("lower");
} catch (e) {
packages/compiler/src/frontend/analysis.ts
+4
View File
@@ -58,6 +58,7 @@ export function analyzeWithFrontend(
entry.package,
entry.detail ?? "its static compilation was refused",
fe.npmImportSites.get(entry.package) ?? { file: entryPath, start: 0, end: 0 },
entry.hint,
),
),
];
@@ -90,6 +91,8 @@ export function analyzeWithFrontend(
coverage: true,
targetPlatform: buildPlatform,
...(ffi !== null ? { ffiImports: ffi.functions } : {}),
...(opts.tier !== undefined ? { tierMode: opts.tier } : {}),
...(opts.explainDynamic === true ? { tierReport: { preflight } } : {}),
});
const provenance = provenanceSources();
return {
@@ -109,6 +112,7 @@ export function analyzeWithFrontend(
...(provenance !== null ? { provenance } : {}),
...(lowered.statsByFile ? { statsByFile: lowered.statsByFile } : {}),
...(lowered.provenanceElided ? { provenanceElided: lowered.provenanceElided } : {}),
...(lowered.tiers !== undefined ? { tiers: lowered.tiers } : {}),
preflightFailed: false,
},
sourceTexts: fe.sourceTexts(),
packages/compiler/src/frontend/builtin-modules.ts
+2
View File
@@ -42,6 +42,8 @@ export const SUPPORTED_BUILTIN_MODULES = [
"module",
"console",
"process",
"punycode",
"constants",
] as const;
/** Builtins Node itself serves ONLY under the node: prefix —
packages/compiler/src/frontend/lowering/builtins/class-values.ts
+159
View File
@@ -0,0 +1,159 @@
import * as ts from "../../ts7/adapter.js";
import { type Lowerer } from "../lowerer.js";
import { type ClassInfo } from "../lower-classes.js";
import { isJsSourceFile } from "../../program.js";
import { builtinMemberRequireDecl } from "./module-bindings.js";
import { stripTypeCasts } from "./arguments.js";
import { streamClassAliasDecl } from "../lower-stream.js";
import { zlibClassName, zlibStreamModeOf } from "./compression.js";
import { stdlibGlobalNameOf } from "../surfaces.js";
/** A builtin class an expression names at compile time: the error
* classes, node:events EventEmitter, the node:stream classes (each a
* runtime ClassInfo), the node:zlib stream classes (by node_zlib_mode),
* and the Map and Set constructors. `name` is the class's `name`
* property. */
export type BuiltinClassRef =
| { kind: "error" | "emitter" | "stream"; info: ClassInfo; name: string }
| { kind: "zlib"; mode: number; name: string }
| { kind: "collection"; which: "Map" | "Set"; name: string };
/** The builtin class `expr` names: a direct spelling (`EventEmitter`,
* `stream.Readable`, `zlib.Gzip`, `Map`, `globalThis.TypeError`) or a
* `const` binding of one (`const E = EventEmitter`, an alias of an alias,
* an imported alias), through parentheses and type assertions. Null for
* anything else. */
export function builtinClassRefOf(lowerer: Lowerer, expr: ts.Expression): BuiltinClassRef | null {
const e = stripTypeCasts(expr);
// Checker lookups only: answering must not run the fences and deferred
// diagnostics of a lowered reference (resolveValueSymbol).
let symbol: ts.Symbol | undefined;
if (ts.isIdentifier(e)) {
symbol = lowerer.checker.getSymbolAtLocation(e);
} else if (ts.isPropertyAccessExpression(e) && !e.questionDotToken) {
symbol = lowerer.checker.getSymbolAtLocation(e.name);
} else {
return null;
}
if (!symbol) return null;
const alias = builtinClassAliasOf(lowerer, symbol);
if (alias !== null) return alias;
if (symbol.flags & ts.SymbolFlags.Alias) symbol = lowerer.checker.getAliasedSymbol(symbol);
const which = stdlibGlobalNameOf(lowerer, e);
if (which === "Map" || which === "Set") return { kind: "collection", which, name: which };
const error = lowerer.builtinErrorInfoOf(symbol);
if (error) return { kind: "error", info: error, name: runtimeClassName(error) };
const emitter = lowerer.builtinEmitterInfoOf(symbol);
if (emitter) return { kind: "emitter", info: emitter, name: runtimeClassName(emitter) };
const stream = lowerer.builtinStreamInfoOf(symbol);
if (stream) return { kind: "stream", info: stream, name: runtimeClassName(stream) };
const mode = zlibStreamModeOf(lowerer, symbol);
if (mode !== null) return { kind: "zlib", mode, name: zlibClassName(mode) };
return null;
}
/** The builtin class a `const` binding names (`const E = EventEmitter`,
* `const M = Map`, `const C = zlib.Gzip`, or an alias of such a binding),
* or null. `let` and `var` bindings could be reassigned, and annotated
* bindings give the value another type, so they are not aliases. Resolved from the declaration, so uses lowered before the
* declaration statement (hoisted functions) see the same answer. */
export function builtinClassAliasOf(lowerer: Lowerer, symbol: ts.Symbol): BuiltinClassRef | null {
const cached = lowerer.builtinClassAliases.get(symbol);
if (cached !== undefined) return cached;
// An import of an exported alias names the exporting binding.
if (symbol.flags & ts.SymbolFlags.Alias) {
lowerer.builtinClassAliases.set(symbol, null);
const target = lowerer.checker.getAliasedSymbol(symbol);
const ref = target === symbol ? null : builtinClassAliasOf(lowerer, target);
lowerer.builtinClassAliases.set(symbol, ref);
return ref;
}
const init = constInitializerOf(lowerer, symbol);
if (init === null) {
lowerer.builtinClassAliases.set(symbol, null);
return null;
}
// Marked first: a cycle through other bindings answers null.
lowerer.builtinClassAliases.set(symbol, null);
const ref = builtinClassRefOf(lowerer, init);
lowerer.builtinClassAliases.set(symbol, ref);
return ref;
}
/** True when `symbol` is a builtin class alias whose declaration owns no
* runtime slot: new, instanceof, typeof, .name and === lower at each use,
* and other uses report SC1090. In JavaScript files, a binding whose
* initializer has a value (`const E = EventEmitter`, `const M =
* globalThis.Map`, both identity tokens) keeps its slot; only builtin
* module members (`zlib.Gzip`) and copies of slotless aliases own none.
* The `require("events").EventEmitter` and `stream.Writable` spellings
* keep their own declaration handling. */
export function builtinClassAliasOwnsNoSlot(lowerer: Lowerer, symbol: ts.Symbol): boolean {
if (builtinClassAliasOf(lowerer, symbol) === null) return false;
const binding =
symbol.flags & ts.SymbolFlags.Alias ? lowerer.checker.getAliasedSymbol(symbol) : symbol;
const decl = lowerer.checker.valueDeclarationOf(binding);
if (decl === undefined || !ts.isVariableDeclaration(decl)) return false;
if (builtinMemberRequireDecl(decl.name, decl.initializer)) return false;
if (streamClassAliasDecl(lowerer, decl.name, decl.initializer)) return false;
if (!isJsSourceFile(decl.getSourceFile())) return true;
let init = decl.initializer;
while (init !== undefined && ts.isParenthesizedExpression(init)) init = init.expression;
if (init === undefined) return true;
let source: ts.Symbol | undefined;
if (ts.isPropertyAccessExpression(init)) {
if (lowerer.builtinNamespaceModuleOf(init.expression) !== null) return true;
source = lowerer.checker.getSymbolAtLocation(init.name);
} else {
source = lowerer.checker.getSymbolAtLocation(init);
}
return source !== undefined && builtinClassAliasOwnsNoSlot(lowerer, source);
}
/** True for a `const` declaration that is a builtin class alias owning no
* runtime slot (see builtinClassAliasOwnsNoSlot): both declaration walks
* skip it. */
export function registerBuiltinClassAlias(
lowerer: Lowerer,
nameNode: ts.Node,
init: ts.Expression | undefined,
): boolean {
if (!ts.isIdentifier(nameNode) || init === undefined) return false;
const symbol = lowerer.checker.getSymbolAtLocation(nameNode);
return symbol !== undefined && builtinClassAliasOwnsNoSlot(lowerer, symbol);
}
/** True when two references name the same builtin class. */
export function sameBuiltinClass(a: BuiltinClassRef, b: BuiltinClassRef): boolean {
if (a.kind === "zlib") return b.kind === "zlib" && a.mode === b.mode;
if (a.kind === "collection") return b.kind === "collection" && a.which === b.which;
return b.kind === a.kind && b.info === a.info;
}
/** The initializer of an unannotated `const` binding whose initializer
* can name a class (an identifier or a property access), or null. */
function constInitializerOf(lowerer: Lowerer, symbol: ts.Symbol): ts.Expression | null {
if ((symbol.flags & ts.SymbolFlags.BlockScopedVariable) === 0) return null;
const decl = lowerer.checker.valueDeclarationOf(symbol);
if (
decl === undefined ||
!ts.isVariableDeclaration(decl) ||
!ts.isIdentifier(decl.name) ||
decl.type !== undefined
) {
return null;
}
const list = decl.parent;
if (!ts.isVariableDeclarationList(list) || (list.flags & ts.NodeFlags.Const) === 0) return null;
let init = decl.initializer;
while (init !== undefined && ts.isParenthesizedExpression(init)) init = init.expression;
if (init === undefined) return null;
if (ts.isIdentifier(init)) return init;
if (ts.isPropertyAccessExpression(init) && !init.questionDotToken) return init;
return null;
}
/** Node's constructor name of a runtime class (`%TypeError` → TypeError). */
function runtimeClassName(info: ClassInfo): string {
return info.def.name.startsWith("%") ? info.def.name.slice(1) : info.def.name;
}
packages/compiler/src/frontend/lowering/builtins/compression.ts
+2 -70
View File
@@ -132,8 +132,8 @@ export function zlibStreamModeOf(
symbol: ts.Symbol | null | undefined,
): number | null {
if (!symbol) return null;
const aliasMode = zlibClassAliasModeOf(lowerer, symbol, 0);
if (aliasMode !== undefined) return aliasMode;
const alias = lowerer.builtinClassAliasOf(symbol);
if (alias !== null) return alias.kind === "zlib" ? alias.mode : null;
const target =
symbol.flags & ts.SymbolFlags.Alias ? lowerer.checker.getAliasedSymbol(symbol) : symbol;
const mode = ZLIB_STREAM_MODES.get(target.name);
@@ -499,80 +499,12 @@ export function lowerZlibModuleCall(
throw new InternalCompilerError(`unhandled lowered zlib member ${bi.member}`);
}
/** The zlib stream class an expression names (`zlib.Gzip`, an imported
* `Gzip`, a `const C = zlib.Gzip` alias), as its node_zlib_mode, or null. */
export function zlibClassModeOfExpr(lowerer: Lowerer, expr: ts.Expression): number | null {
let e = expr;
while (ts.isParenthesizedExpression(e)) e = e.expression;
if (ts.isIdentifier(e)) return zlibStreamModeOf(lowerer, lowerer.checker.getSymbolAtLocation(e));
if (ts.isPropertyAccessExpression(e) && !e.questionDotToken) {
return zlibStreamModeOf(lowerer, lowerer.checker.getSymbolAtLocation(e.name));
}
return null;
}
/** The class name of a zlib stream mode (Node's constructor name). */
export function zlibClassName(mode: number): string {
for (const [name, m] of ZLIB_STREAM_MODES) if (m === mode) return name;
return "Zlib";
}
/** The mode of a `const C = zlib.Gzip` binding (or an alias of such a
* binding), null when the symbol is a const binding of something else,
* undefined when it is not a const binding. Resolved from the declaration,
* so uses lowered before the declaration statement see the same answer. */
function zlibClassAliasModeOf(
lowerer: Lowerer,
symbol: ts.Symbol,
depth: number,
): number | null | undefined {
const cached = lowerer.zlibClassAliases.get(symbol);
if (cached !== undefined) return cached;
if ((symbol.flags & ts.SymbolFlags.BlockScopedVariable) === 0) return undefined;
const decl = lowerer.checker.valueDeclarationOf(symbol);
if (decl === undefined || !ts.isVariableDeclaration(decl) || !ts.isIdentifier(decl.name)) {
return undefined;
}
// const only: a var or let binding could be reassigned
const list = decl.parent;
if (!ts.isVariableDeclarationList(list) || (list.flags & ts.NodeFlags.Const) === 0) {
return undefined;
}
let init = decl.initializer;
while (init !== undefined && ts.isParenthesizedExpression(init)) init = init.expression;
if (init === undefined || depth > 16) return null;
let mode: number | null = null;
if (ts.isIdentifier(init)) {
const next = lowerer.checker.getSymbolAtLocation(init);
if (next !== undefined) {
const nested = zlibClassAliasModeOf(lowerer, next, depth + 1);
mode = nested === undefined ? zlibStreamModeOf(lowerer, next) : nested;
}
} else if (ts.isPropertyAccessExpression(init) && !init.questionDotToken) {
mode = zlibStreamModeOf(lowerer, lowerer.checker.getSymbolAtLocation(init.name));
}
if (mode !== null) lowerer.zlibClassAliases.set(symbol, mode);
return mode;
}
/** True for `const C = zlib.Gzip` (or an alias of an alias): a
* compile-time zlib class alias that owns no runtime slot, so the
* statement lowering skips it. */
export function registerZlibClassAlias(
lowerer: Lowerer,
nameNode: ts.Node,
init: ts.Expression | undefined,
): boolean {
if (!ts.isIdentifier(nameNode) || init === undefined) return false;
const symbol = lowerer.checker.getSymbolAtLocation(nameNode);
return symbol !== undefined && zlibClassAliasOf(lowerer, symbol) !== null;
}
/** The mode of a `const C = zlib.Gzip` alias symbol, or null. */
export function zlibClassAliasOf(lowerer: Lowerer, symbol: ts.Symbol): number | null {
return zlibClassAliasModeOf(lowerer, symbol, 0) ?? null;
}
/** `value instanceof zlib.Gzip` (any spelling of the class, aliases
* included). zlib streams are runtime Transforms: a Transform operand asks
* the runtime for the stream's mode, and an operand typed as one of
packages/compiler/src/frontend/lowering/call-signatures.ts
+18
View File
@@ -503,6 +503,24 @@ export function requireExactArityValue(
? lowerer.mapTypeOf(lowerer.typeOf(contextual))
: null;
if (mapped && typeEquals(mapped, funcType)) return;
// An object-literal METHOD has no contextual type of its own: the
// literal's contextual type names the member slot it fills. An
// overloaded member's slot holds its erased function, which spells the
// completed parameters of an implementation like `m(a?: string)`.
if (
contextual === null &&
ts.isMethodDeclaration(blame) &&
blame.parent !== undefined &&
ts.isObjectLiteralExpression(blame.parent) &&
(ts.isIdentifier(blame.name) || ts.isStringLiteral(blame.name))
) {
const literalType = lowerer.checker.getContextualType(blame.parent);
const member = literalType
? lowerer.checker.getPropertyOfType(literalType, blame.name.text)
: undefined;
const slot = member ? lowerer.memberSlotTypeOf(lowerer.checker.getTypeOfSymbol(member)) : null;
if (slot && typeEquals(slot, funcType)) return;
}
// A union-typed slot (`runner || defaultRunner` under a
// `CommandRunner | undefined` context): the value can only inhabit
// the union's one func arm — judge by it.
packages/compiler/src/frontend/lowering/cjs-exports-object.ts
+430
View File
@@ -0,0 +1,430 @@
/* A CommonJS module's own exports object, seen from inside the module.
*
* The compiled module system has no reflective exports object: each export
* is a module global (collectGlobals) or alias plumbing to a declaration.
* Inside the module that is enough for
*
* - member reads and member calls (`exports.f`, `exports.f(x)`,
* `module.exports.f(x)`): they are the member's export global, the
* storage every `exports.f =` statement assigns;
* - identity comparisons of the object itself (`root === module.exports`,
* `exports === module.exports`): while the module never replaces
* `module.exports` and never rebinds `exports`, both name the module's
* original exports object, which top-level `this` already represents
* (lowerCjsTopLevelThis). `typeof` and truthiness keep their existing
* lowerings.
*
* Every other use of the object as a value (passing it to a function,
* storing it, reading a member through an alias) would need a real object
* whose properties are the exports; those uses keep a named refusal. The
* dynamic CommonJS module object is the two-tier design's S9 stage. */
import * as ts from "../ts7/adapter.js";
import type { Lowerer } from "./lowerer.js";
import {
cjsExportAssignmentOf,
cjsExportTargetLiteral,
isCjsJsFile,
isModuleExportsAccess,
isRequireStatement,
locOf,
} from "../program.js";
import { isCjsModuleGlobal } from "./lower-node-module.js";
import { DYN, type IrExpr, type IrGlobal } from "../../ir/ir.js";
/** True for the CommonJS wrapper's `exports` binding (not shadowed by any
* source declaration) in a CommonJS JS file. */
export function isCjsExportsIdentifier(lowerer: Lowerer, node: ts.Expression): boolean {
if (!ts.isIdentifier(node) || node.text !== "exports") return false;
if (!isCjsJsFile(node.getSourceFile(), lowerer.program)) return false;
const symbol = lowerer.checker.getSymbolAtLocation(node);
const decls = symbol ? lowerer.checker.declarationsOf(symbol) : [];
return !decls.some(
(d) =>
!d.getSourceFile().isDeclarationFile &&
(ts.isVariableDeclaration(d) ||
ts.isParameter(d) ||
ts.isBindingElement(d) ||
ts.isFunctionDeclaration(d) ||
ts.isClassDeclaration(d) ||
ts.isImportSpecifier(d) ||
ts.isNamespaceImport(d) ||
ts.isImportEqualsDeclaration(d)),
);
}
/** `module.exports` over the CommonJS `module` global in a CommonJS file. */
export function isCjsModuleExports(lowerer: Lowerer, node: ts.Expression): boolean {
return (
isModuleExportsAccess(node) &&
isCjsModuleGlobal(lowerer, node.expression) &&
isCjsJsFile(node.getSourceFile(), lowerer.program)
);
}
/** The export global behind a same-module member access `exports.<name>` /
* `module.exports.<name>`, or null (identifier-valued members are alias
* plumbing with no storage, and other receivers are not the exports
* object). */
export function cjsInFileExportGlobalOf(
lowerer: Lowerer,
access: ts.PropertyAccessExpression,
): IrGlobal | null {
if (access.questionDotToken || !ts.isIdentifier(access.name)) return null;
const sf = access.getSourceFile();
const recv =
isModuleExportsAccess(access.expression) ||
(ts.isIdentifier(access.expression) &&
access.expression.text === "exports" &&
!lowerer.resolveLocal(access.expression) &&
!lowerer.globalOf(access.expression));
if (!recv || !isCjsJsFile(sf, lowerer.program)) return null;
const sym =
lowerer.checker.getSymbolAtLocation(access.name) ??
lowerer.cjsModuleExportSymbol(sf, access.name.text);
const resolved =
sym !== undefined && sym.flags & ts.SymbolFlags.Alias
? lowerer.checker.getAliasedSymbol(sym)
: sym;
return (
(sym ? lowerer.globalsBySymbol.get(sym) : undefined) ??
(resolved ? lowerer.globalsBySymbol.get(resolved) : undefined) ??
null
);
}
/** Whether `node` is an operand of an equality operator: only its identity
* is observed. */
function identityUse(node: ts.Expression): boolean {
let child: ts.Node = node;
let parent = node.parent;
while (parent !== undefined && ts.isParenthesizedExpression(parent)) {
child = parent;
parent = parent.parent;
}
if (parent === undefined || !ts.isBinaryExpression(parent)) return false;
const op = parent.operatorToken.kind;
return (
(op === ts.SyntaxKind.EqualsEqualsEqualsToken ||
op === ts.SyntaxKind.ExclamationEqualsEqualsToken ||
op === ts.SyntaxKind.EqualsEqualsToken ||
op === ts.SyntaxKind.ExclamationEqualsToken) &&
(parent.left === child || parent.right === child)
);
}
/** Uses whose answer does not need the object: `typeof`, `void`, and
* truthiness tests (their existing lowerings answer them). */
function answeredWithoutObject(node: ts.Expression): boolean {
let child: ts.Node = node;
let parent = node.parent;
while (parent !== undefined && ts.isParenthesizedExpression(parent)) {
child = parent;
parent = parent.parent;
}
if (parent === undefined) return false;
if (ts.isTypeOfExpression(parent) || ts.isVoidExpression(parent)) return true;
return truthinessOnly(child as ts.Expression);
}
function truthinessOnly(node: ts.Expression): boolean {
let child: ts.Node = node;
for (let parent = node.parent; parent !== undefined; child = parent, parent = parent.parent) {
if (ts.isParenthesizedExpression(parent)) continue;
if (ts.isPrefixUnaryExpression(parent))
return parent.operator === ts.SyntaxKind.ExclamationToken;
if (
ts.isBinaryExpression(parent) &&
(parent.operatorToken.kind === ts.SyntaxKind.AmpersandAmpersandToken ||
parent.operatorToken.kind === ts.SyntaxKind.BarBarToken)
)
continue;
if (ts.isIfStatement(parent) || ts.isWhileStatement(parent) || ts.isDoStatement(parent))
return parent.expression === child;
if (ts.isForStatement(parent)) return parent.condition === child;
if (ts.isConditionalExpression(parent)) return parent.condition === child;
return false;
}
return false;
}
/** Which of the module's exports bindings the file ever assigns (any
* nesting, compound operators included), cached per file on the lowerer
* (Lowerer.cjsExportsAssignments). */
function exportsAssignments(
lowerer: Lowerer,
sf: ts.SourceFile,
): { exports: boolean; moduleExports: boolean } {
const cached = lowerer.cjsExportsAssignments.get(sf);
if (cached !== undefined) return cached;
const out = { exports: false, moduleExports: false };
lowerer.cjsExportsAssignments.set(sf, out);
ts.walkPreorder(sf, (node) => {
// A fresh `exports = module.exports = {}` reset leaves both bindings
// naming one (new, empty) exports object for the rest of the module.
if (ts.isExpressionStatement(node) && isFreshExportsReset(lowerer, node)) return "skip";
if (
!ts.isBinaryExpression(node) ||
node.operatorToken.kind < ts.SyntaxKind.FirstAssignment ||
node.operatorToken.kind > ts.SyntaxKind.LastAssignment
)
return undefined;
let target = node.left;
while (ts.isParenthesizedExpression(target)) target = target.expression;
if (isCjsModuleExports(lowerer, target)) out.moduleExports = true;
if (isCjsExportsIdentifier(lowerer, target)) out.exports = true;
return undefined;
});
return out;
}
/** Whether `node` still names the module's ORIGINAL exports object wherever
* it runs: `exports` unless the file rebinds it; `module.exports` unless the
* file rebinds `exports` or replaces `module.exports`. */
function namesOriginalExports(lowerer: Lowerer, node: ts.Expression): boolean {
const assigned = exportsAssignments(lowerer, node.getSourceFile());
if (assigned.exports) return false;
return ts.isIdentifier(node) || !assigned.moduleExports;
}
/** The uses this module answers with the original exports object: identity
* comparisons and `typeof` of either spelling, and truthiness or `void` of
* `exports` (`module.exports` truthiness keeps its existing fold). */
function objectAnsweredUse(node: ts.Expression): boolean {
if (identityUse(node)) return true;
let parent = node.parent;
while (parent !== undefined && ts.isParenthesizedExpression(parent)) parent = parent.parent;
if (parent !== undefined && ts.isTypeOfExpression(parent)) return true;
return ts.isIdentifier(node) && answeredWithoutObject(node);
}
/** Whether `node` (`exports` or `module.exports`) is a use of the module's
* exports object as a VALUE (not a member access receiver, not an
* assignment target). */
export function isCjsExportsObjectValue(lowerer: Lowerer, node: ts.Expression): boolean {
if (!isCjsExportsIdentifier(lowerer, node) && !isCjsModuleExports(lowerer, node)) return false;
let outer: ts.Node = node;
while (outer.parent !== undefined && ts.isParenthesizedExpression(outer.parent))
outer = outer.parent;
const parent = outer.parent;
if (parent === undefined) return false;
if (
(ts.isPropertyAccessExpression(parent) || ts.isElementAccessExpression(parent)) &&
parent.expression === outer
)
return false;
if (
ts.isBinaryExpression(parent) &&
parent.left === outer &&
parent.operatorToken.kind >= ts.SyntaxKind.FirstAssignment &&
parent.operatorToken.kind <= ts.SyntaxKind.LastAssignment
)
return false;
return true;
}
/** Files whose exports object is observed by identity somewhere: their top-
* level `this` object must exist (lowerFileInit creates it). */
export function usesCjsExportsIdentity(lowerer: Lowerer, sf: ts.SourceFile): boolean {
if (!isCjsJsFile(sf, lowerer.program)) return false;
let found = false;
ts.walkPreorder(sf, (node) => {
if (
(ts.isIdentifier(node) || ts.isPropertyAccessExpression(node)) &&
isCjsExportsObjectValue(lowerer, node) &&
objectAnsweredUse(node) &&
namesOriginalExports(lowerer, node)
) {
found = true;
return "stop";
}
return undefined;
});
return found;
}
/** `exports` / `module.exports` used as a value inside its own module: the
* original exports object for identity, typeof and truthiness, or a named
* refusal. Null when `node` is not such a use. */
export function lowerCjsExportsObjectValue(lowerer: Lowerer, node: ts.Expression): IrExpr | null {
if (!isCjsExportsObjectValue(lowerer, node)) return null;
const sf = node.getSourceFile();
// A module that replaces module.exports answers `module.exports` reads
// through the replacement's own machinery (the class-expression whole
// export, the replaced-exports reads).
if (!ts.isIdentifier(node) && exportsAssignments(lowerer, sf).moduleExports) return null;
const spelled = ts.isIdentifier(node) ? "exports" : "module.exports";
const original = lowerer.cjsExportsThis.get(sf);
if (objectAnsweredUse(node) && original !== undefined && namesOriginalExports(lowerer, node)) {
return { kind: "varRef", localId: original.id, type: DYN, loc: locOf(node) };
}
// `module.exports` truthiness keeps its existing fold (and anything the
// object is not needed for keeps whatever answered it before).
if (answeredWithoutObject(node)) return null;
lowerer.unsupported(
"SC1090",
node,
identityUse(node)
? `comparing '${spelled}' in a module that replaces module.exports or rebinds exports (the compiled exports are a static table, not an object with an identity)`
: `'${spelled}' as a value other than a member access, comparison, typeof or truthiness test (the compiled exports are a static table, not an object: read ${spelled}.<name>)`,
);
}
/** `exports = module.exports = {}` (either order) as a top-level statement
* that runs before anything could observe or extend the original exports
* object: only directives, require statements and function declarations
* precede it, and the module assigns neither binding anywhere else. Node
* swaps the original empty exports object for another empty one that both
* bindings name; the compiled module's static exports start out exactly
* the same, so the statement is a no-op (semver's internal/re.js). */
export function isFreshExportsReset(lowerer: Lowerer, stmt: ts.ExpressionStatement): boolean {
const sf = stmt.parent;
if (!ts.isSourceFile(sf) || !isCjsJsFile(sf, lowerer.program)) return false;
let e: ts.Expression = stmt.expression;
const targets: ts.Expression[] = [];
for (;;) {
while (ts.isParenthesizedExpression(e)) e = e.expression;
if (!ts.isBinaryExpression(e) || e.operatorToken.kind !== ts.SyntaxKind.EqualsToken) break;
targets.push(e.left);
e = e.right;
}
if (!ts.isObjectLiteralExpression(e) || e.properties.length !== 0) return false;
if (targets.length !== 2) return false;
const hasExports = targets.some((t) => isCjsExportsIdentifier(lowerer, t));
const hasModuleExports = targets.some((t) => isCjsModuleExports(lowerer, t));
if (!hasExports || !hasModuleExports) return false;
for (const prior of sf.statements) {
if (prior === stmt) break;
if (ts.isFunctionDeclaration(prior) || isRequireStatement(prior)) continue;
if (ts.isExpressionStatement(prior) && ts.isStringLiteral(prior.expression)) continue;
return false;
}
let others = 0;
ts.walkPreorder(sf, (node) => {
if (
!ts.isBinaryExpression(node) ||
node.operatorToken.kind < ts.SyntaxKind.FirstAssignment ||
node.operatorToken.kind > ts.SyntaxKind.LastAssignment
)
return undefined;
let target = node.left;
while (ts.isParenthesizedExpression(target)) target = target.expression;
if (isCjsModuleExports(lowerer, target) || isCjsExportsIdentifier(lowerer, target)) others++;
return undefined;
});
return others === 2;
}
/** The export global a WRITE `exports.<name> = v` / `module.exports.<name> =
* v` updates when it is not a top-level export statement (inside a
* function, or in value position): only while the module keeps its
* original exports object, which is then the object every requirer reads
* the member from. */
export function cjsExportMemberWriteGlobalOf(
lowerer: Lowerer,
target: ts.PropertyAccessExpression,
): IrGlobal | null {
const sf = target.getSourceFile();
if (!isCjsJsFile(sf, lowerer.program)) return null;
const assigned = exportsAssignments(lowerer, sf);
if (assigned.exports || assigned.moduleExports) return null;
return cjsInFileExportGlobalOf(lowerer, target);
}
/** Whether a function body reads `this` (arrow functions inherit it; other
* nested functions bind their own). */
function functionUsesThis(fn: ts.FunctionLikeDeclaration): boolean {
if (fn.body === undefined) return false;
let found = false;
ts.walkPreorder(fn.body, (node) => {
if (node !== fn.body && ts.isFunctionLike(node) && !ts.isArrowFunction(node)) return "skip";
if (node.kind === ts.SyntaxKind.ThisKeyword) {
found = true;
return "stop";
}
return undefined;
});
return found;
}
/** A function declaration, or a variable initialized with a function or
* arrow expression, that never reads `this`. */
function symbolIsThisFreeFunction(lowerer: Lowerer, sym: ts.Symbol | undefined): boolean {
const decls = sym ? lowerer.checker.declarationsOf(sym) : [];
const fn = decls.find(ts.isFunctionDeclaration);
if (fn !== undefined) return !functionUsesThis(fn);
const v = decls.find(ts.isVariableDeclaration);
let init = v?.initializer;
while (init !== undefined && ts.isParenthesizedExpression(init)) init = init.expression;
return (
init !== undefined &&
(ts.isFunctionExpression(init) || ts.isArrowFunction(init)) &&
!functionUsesThis(init)
);
}
/** True when every value the module assigns to its export `name` is a
* function that never reads `this`. A call through the exports object
* (`exports.f(x)`) binds `this` to that object, which the static export
* table cannot supply, so only these calls lower; the others keep a fence. */
export function cjsExportCallIgnoresThis(
lowerer: Lowerer,
sf: ts.SourceFile,
name: string,
depth = 0,
): boolean {
if (depth > 16) return false;
const values: ts.Expression[] = [];
ts.walkPreorder(sf, (node) => {
if (
ts.isBinaryExpression(node) &&
node.operatorToken.kind === ts.SyntaxKind.EqualsToken &&
ts.isPropertyAccessExpression(node.left) &&
node.left.name.text === name &&
(isCjsExportsIdentifier(lowerer, node.left.expression) ||
isCjsModuleExports(lowerer, node.left.expression))
) {
values.push(node.right);
}
return undefined;
});
// Entries of a `module.exports = { ... }` table (direct, or a const
// literal the statement names).
let methodEntry: ts.MethodDeclaration | null = null;
let shorthandOnly = false;
for (const stmt of sf.statements) {
const cjs = cjsExportAssignmentOf(stmt);
if (cjs?.kind !== "table") continue;
const table = cjs.obj ?? cjsExportTargetLiteral(cjs.expr.right, sf);
for (const prop of table?.properties ?? []) {
if (prop.name === undefined || !ts.isIdentifier(prop.name) || prop.name.text !== name)
continue;
if (ts.isPropertyAssignment(prop)) values.push(prop.initializer);
else if (ts.isShorthandPropertyAssignment(prop)) {
const value = lowerer.checker.getShorthandAssignmentValueSymbol(prop);
if (!symbolIsThisFreeFunction(lowerer, value)) return false;
shorthandOnly = true;
} else if (ts.isMethodDeclaration(prop)) methodEntry = prop;
}
}
if (methodEntry !== null) return values.length === 0 && !functionUsesThis(methodEntry);
if (values.length === 0) return shorthandOnly;
return values.every((v) => {
let e = v;
while (ts.isParenthesizedExpression(e)) e = e.expression;
if (ts.isFunctionExpression(e) || ts.isArrowFunction(e)) return !functionUsesThis(e);
if (ts.isIdentifier(e)) {
return symbolIsThisFreeFunction(lowerer, lowerer.checker.getSymbolAtLocation(e));
}
// Another module's member (`exports.f = require("./lib").f`, or through
// a module binding): that module's own export values decide.
if (ts.isPropertyAccessExpression(e) && ts.isIdentifier(e.name)) {
const dep = ts.isIdentifier(e.expression)
? lowerer.cjsLocalModuleBindingOf(e.expression)
? lowerer.cjsModuleBindingDepOf(e.expression)
: null
: lowerer.cjsModuleRefDepOf(e.expression);
return dep !== null && cjsExportCallIgnoresThis(lowerer, dep, e.name.text, depth + 1);
}
return false;
});
}
packages/compiler/src/frontend/lowering/cjs-inline-require.ts
+370
View File
@@ -0,0 +1,370 @@
/* Inline CommonJS `require("./x")` of a program module in expression
* position. A top-level `const m = require("./x")` binding is alias
* plumbing: member reads resolve to the exporter's declarations, and the
* statement lowers to the dependency's run-once %init call. An inline
* require is the same thing without the binding: the %init call runs at
* exactly the call's position (Node evaluates the module there, or
* answers from its cache), and the value is then read statically:
*
* - `require("./x").f` and `require("./x").f(...)` over a module whose
* exports are a table (member exports or `module.exports = {...}`)
* read the member like a binding would;
* - `require("./x")` as a value over a module whose whole export is one
* value (`module.exports = fn` / `= class {}` / `= make()` / `= 42` /
* `= require("./y")`) answers that value.
*
* A table module's exports object as a value has no static
* representation; it keeps a named refusal (a first-class CommonJS module
* object is the two-tier design's S9 stage). */
import * as ts from "../ts7/adapter.js";
import type { Lowerer } from "./lowerer.js";
import {
canonicalBuiltinModule,
cjsExportAssignmentOf,
cjsExportDiscardReason,
cjsExportTargetLiteral,
isCjsJsFile,
isJsSourceFile,
isModuleExportsAccess,
locOf,
npmStaticDepSf7,
requireSpecOf,
resolveImport,
} from "../program.js";
import { createRequireCalleeFileOf } from "./builtins/module-bindings.js";
import { isCjsRequireGlobal } from "./lower-node-module.js";
import { DYN, type IrExpr } from "../../ir/ir.js";
import { nodeThrowExpr } from "../../ir/build.js";
import { probeNodeRequireRefusal } from "../npm.js";
export interface InlineRequire {
call: ts.CallExpression;
spec: string;
dep: ts.SourceFile;
}
/** A `require("<literal>")` call of the CommonJS global in a CommonJS JS
* file whose target is a compiled program module (relative, aliased, or an
* opted-in --npm-static package). Builtins, JSON documents and
* createRequire bindings answer null: their own lowerings own them. */
export function inlineProgramRequireOf(
lowerer: Lowerer,
expr: ts.Expression,
): InlineRequire | null {
let e = expr;
while (ts.isParenthesizedExpression(e)) e = e.expression;
if (!ts.isCallExpression(e) || !ts.isIdentifier(e.expression)) return null;
const spec = requireSpecOf(e);
if (spec === null || canonicalBuiltinModule(spec) !== null) return null;
const sf = e.getSourceFile();
if (!isCjsJsFile(sf, lowerer.program)) return null;
if (!isCjsRequireGlobal(lowerer, e.expression)) return null;
if (createRequireCalleeFileOf(lowerer, e.expression) !== null) return null;
const dep =
resolveImport(lowerer.program, sf, spec, "require") ??
npmStaticDepSf7(lowerer.program, sf, spec, "require");
if (!dep || dep.isDeclarationFile || dep.fileName.endsWith(".json")) return null;
return { call: e, spec, dep };
}
/** The kept (last, not discarded) top-level `module.exports = <value>` of a
* CommonJS module whose whole export is a single value, or null when its
* exports are a table: member exports only, or a literal / const-literal /
* Proxy-over-literal table. */
export function cjsWholeExportValueOf(
sf: ts.SourceFile,
): { assign: ts.BinaryExpression; rhs: ts.Expression } | null {
let kept: ts.BinaryExpression | null = null;
for (const stmt of sf.statements) {
const cjs = cjsExportAssignmentOf(stmt);
if (cjs?.kind === "table" && cjsExportDiscardReason(stmt) === null) kept = cjs.expr;
}
if (kept === null) return null;
let rhs: ts.Expression = kept.right;
while (ts.isParenthesizedExpression(rhs)) rhs = rhs.expression;
if (ts.isObjectLiteralExpression(rhs) || cjsExportTargetLiteral(rhs, sf) !== null) return null;
return { assign: kept, rhs };
}
/** True when `dep`'s exports, through `module.exports = require("./y")`
* re-export chains, are a table that member reads resolve against. */
export function cjsNamespaceModule(lowerer: Lowerer, dep: ts.SourceFile, depth = 0): boolean {
const whole = cjsWholeExportValueOf(dep);
if (whole === null) return true;
const inner = inlineProgramRequireOf(lowerer, whole.rhs);
return inner !== null && depth < 32 && cjsNamespaceModule(lowerer, inner.dep, depth + 1);
}
/** An inline program-module require over a table module (member reads and
* member calls resolve through it), or null. */
export function inlineNamespaceRequireOf(
lowerer: Lowerer,
expr: ts.Expression,
): InlineRequire | null {
const req = inlineProgramRequireOf(lowerer, expr);
return req !== null && cjsNamespaceModule(lowerer, req.dep) ? req : null;
}
/** `value` evaluated after the required module's run-once %init (and its
* module-registry link) at the require's own position. */
export function withRequireInit(lowerer: Lowerer, req: InlineRequire, value: IrExpr): IrExpr {
if (lowerer.inlineRequireCycleCalls.has(req.call)) {
lowerer.unsupported(
"SC1090",
req.call,
`require() of '${req.spec}' while it is still evaluating (a require cycle: Node answers its partial exports, which the static export table does not model)`,
);
}
// Every inline program require is a preflight module edge, so its module
// has an initializer; never read its exports without evaluating it.
if (!lowerer.initNameOf.has(req.dep)) {
lowerer.unsupported(
"SC1090",
req.call,
`require() of '${req.spec}' here (the module is not part of the compiled module order)`,
);
}
const init = lowerer.requireInitStmt(req.spec, req.call);
if (init === null) return value;
return { kind: "seqExpr", stmts: [init], result: value, type: value.type, loc: value.loc };
}
/** The whole-export value of `dep` read from the requirer, following
* `module.exports = require("./y")` re-exports (the inner module already
* evaluated inside dep's own %init). Null for table modules and for
* whole-export shapes with no represented value. */
export function wholeExportValue(
lowerer: Lowerer,
dep: ts.SourceFile,
blame: ts.Node,
depth = 0,
): IrExpr | null {
const whole = cjsWholeExportValueOf(dep);
if (whole === null || depth > 32) return null;
const inner = inlineProgramRequireOf(lowerer, whole.rhs);
if (inner !== null) return wholeExportValue(lowerer, inner.dep, blame, depth + 1);
// An identifier names a declaration of the exporting module (or a
// builtin global): reading it IS the export, exactly what requirer
// bindings alias to.
if (ts.isIdentifier(whole.rhs)) return lowerer.lowerExpr(whole.rhs);
if (ts.isClassExpression(whole.rhs)) {
return lowerer.classValueRef(lowerer.lowerClassExpressionInfo(whole.rhs), blame);
}
const g = lowerer.globalsByDeclNode.get(whole.assign);
if (g === undefined) return null;
return { kind: "varRef", localId: g.id, type: g.type, loc: locOf(blame) };
}
/** `require("./x")` as a value (`require("debug")("ns")`, `new
* (require("./C"))()`, `{ verify: require("./verify") }`): the module's
* %init at this position, then its whole-export value. Null when `call`
* is not an inline program-module require. */
export function lowerInlineRequireValue(lowerer: Lowerer, call: ts.CallExpression): IrExpr | null {
const req = inlineProgramRequireOf(lowerer, call);
if (req === null) return null;
const value = wholeExportValue(lowerer, req.dep, call, 0);
if (value === null) {
lowerer.unsupported(
"SC1090",
call,
cjsNamespaceModule(lowerer, req.dep)
? `the exports object of '${req.spec}' as a value (its exports compile to a static table: read require(${JSON.stringify(req.spec)}).member directly, or bind const m = require(${JSON.stringify(req.spec)}) at the module's top level)`
: `the whole export of '${req.spec}' as a value (its 'module.exports =' value has no static representation)`,
);
}
return withRequireInit(lowerer, req, value);
}
/** Lowers `inner` (a member read or member call whose receiver is the
* inline require) with that require marked as handled, so the receiver
* resolves as a module binding, then sequences the module's %init first. */
export function lowerWithInlineRequireInit(
lowerer: Lowerer,
req: InlineRequire,
inner: () => IrExpr,
): IrExpr {
lowerer.inlineRequireInitDone.add(req.call);
try {
return withRequireInit(lowerer, req, inner());
} finally {
lowerer.inlineRequireInitDone.delete(req.call);
}
}
/** A `require(...)` call of the CommonJS global in a CommonJS file that no
* other lowering claimed (not a builtin, JSON document, program module or
* createRequire binding): a package nothing installed resolves throws
* Node's catchable MODULE_NOT_FOUND at the call, and every other form is
* refused by name instead of as an unlowerable `require` value. */
export function lowerUncompiledRequireCall(
lowerer: Lowerer,
call: ts.CallExpression,
): IrExpr | null {
if (!ts.isIdentifier(call.expression) || call.expression.text !== "require") return null;
const sf = call.getSourceFile();
if (!isCjsJsFile(sf, lowerer.program) || !isCjsRequireGlobal(lowerer, call.expression))
return null;
if (createRequireCalleeFileOf(lowerer, call.expression) !== null) return null;
const spec = requireSpecOf(call);
if (spec === null) {
lowerer.unsupported(
"SC1090",
call,
'require() with a computed specifier (the compiled module graph is fixed at build time: require("<string literal>") lowers)',
);
}
if (canonicalBuiltinModule(spec) !== null) return null;
if (!spec.startsWith(".") && !spec.startsWith("/") && !spec.startsWith("#")) {
const refusal = probeNodeRequireRefusal(sf.fileName, spec);
if (refusal !== null) {
return nodeThrowExpr(0, "MODULE_NOT_FOUND", refusal.message, DYN, locOf(call));
}
lowerer.unsupported(
"SC1090",
call,
`require() of the package '${spec}' in an expression (the package is not compiled into this program)`,
);
}
lowerer.unsupported(
"SC1090",
call,
`require() of '${spec}' in an expression (it does not resolve to a compiled program module)`,
);
}
/** The elements of a top-level `const { key: { ... } } = require("./x")`
* declaration over a program module whose nested pattern destructures the
* named export's value (preflight admits exactly these). Plain elements
* stay alias plumbing. */
export function requireNestedPatternsOf(decl: ts.VariableDeclaration): ts.BindingElement[] {
if (!ts.isObjectBindingPattern(decl.name) || decl.initializer === undefined) return [];
const spec = requireSpecOf(decl.initializer);
if (spec === null || canonicalBuiltinModule(spec) !== null) return [];
if (!isJsSourceFile(decl.getSourceFile())) return [];
return decl.name.elements.filter(
(e) =>
e.name !== undefined &&
ts.isObjectBindingPattern(e.name) &&
e.propertyName !== undefined &&
ts.isIdentifier(e.propertyName) &&
e.initializer === undefined &&
e.dotDotDotToken === undefined,
);
}
/** A plain method entry of a `module.exports = { ... }` table: identifier
* name, a body, not a generator. Its value is the method's function. */
export function cjsTableMethodEntry(
prop: ts.ObjectLiteralElementLike,
): (ts.MethodDeclaration & { name: ts.Identifier; body: ts.Block }) | null {
if (!ts.isMethodDeclaration(prop) || !ts.isIdentifier(prop.name) || prop.body === undefined)
return null;
if (prop.asteriskToken !== undefined) return null;
return prop as ts.MethodDeclaration & { name: ts.Identifier; body: ts.Block };
}
/** `exports.<name> = value` / `module.exports.<name> = value` assignments in
* VALUE position inside a top-level statement (`const src = exports.src =
* []`), outside function bodies and outside the statement's own export
* chain (`statementExport`, which the statement-level machinery owns). */
export function nestedCjsExportAssignmentsOf(
stmt: ts.Statement,
statementExport: ts.BinaryExpression | undefined,
): { name: ts.Identifier; value: ts.Expression }[] {
if (!ts.isVariableStatement(stmt) && !ts.isExpressionStatement(stmt)) return [];
const owned = new Set<ts.Node>();
for (let e: ts.Expression | undefined = statementExport; e !== undefined;) {
while (ts.isParenthesizedExpression(e)) e = e.expression;
if (!ts.isBinaryExpression(e) || e.operatorToken.kind !== ts.SyntaxKind.EqualsToken) break;
owned.add(e);
e = e.right;
}
const out: { name: ts.Identifier; value: ts.Expression }[] = [];
ts.walkPreorder(stmt, (node) => {
if (
node !== stmt &&
(ts.isFunctionLike(node) || ts.isClassDeclaration(node) || ts.isClassExpression(node))
)
return "skip";
if (
ts.isBinaryExpression(node) &&
node.operatorToken.kind === ts.SyntaxKind.EqualsToken &&
!owned.has(node) &&
ts.isPropertyAccessExpression(node.left) &&
node.left.questionDotToken === undefined &&
ts.isIdentifier(node.left.name) &&
((ts.isIdentifier(node.left.expression) && node.left.expression.text === "exports") ||
isModuleExportsAccess(node.left.expression))
) {
out.push({ name: node.left.name, value: node.right });
}
return undefined;
});
return out;
}
/** `const { A, B: b } = ns` at a module's top level, where `ns` is a
* CommonJS module binding over a table module (picomatch's `const {
* MAX_LENGTH, ... } = constants`): each name takes a snapshot of the named
* export's value at this statement, exactly like destructuring the exports
* object would. Null for every other declaration; the plain elements and
* their key names otherwise. */
export function cjsNamespaceDestructureOf(
lowerer: Lowerer,
decl: ts.VariableDeclaration,
): { dep: ts.SourceFile; elements: { name: ts.Identifier; key: string }[] } | null {
if (!ts.isObjectBindingPattern(decl.name) || decl.initializer === undefined) return null;
const stmt = decl.parent?.parent;
if (stmt === undefined || !ts.isVariableStatement(stmt) || !ts.isSourceFile(stmt.parent))
return null;
if (!isJsSourceFile(stmt.parent)) return null;
let init: ts.Expression = decl.initializer;
while (ts.isParenthesizedExpression(init)) init = init.expression;
if (!ts.isIdentifier(init) || !lowerer.cjsLocalModuleBindingOf(init)) return null;
const dep = lowerer.cjsModuleBindingDepOf(init);
if (dep === null) return null;
const elements: { name: ts.Identifier; key: string }[] = [];
for (const e of decl.name.elements) {
if (e.initializer !== undefined || e.dotDotDotToken !== undefined) return null;
if (e.name === undefined || !ts.isIdentifier(e.name)) return null;
const key =
e.propertyName === undefined
? e.name.text
: ts.isIdentifier(e.propertyName) || ts.isStringLiteral(e.propertyName)
? e.propertyName.text
: null;
if (key === null) return null;
elements.push({ name: e.name, key });
}
return { dep, elements };
}
/** The value of `dep`'s export `key` read from another module: its export
* global, or the function/class declaration it aliases. Null when it has no
* static value. */
export function cjsExportValueByName(
lowerer: Lowerer,
dep: ts.SourceFile,
key: string,
blame: ts.Node,
): IrExpr | null {
let sym = lowerer.cjsModuleExportSymbol(dep, key);
if (sym === undefined) return null;
if (sym.flags & ts.SymbolFlags.Alias) sym = lowerer.checker.getAliasedSymbol(sym);
const direct = lowerer.globalsBySymbol.get(sym);
if (direct) return { kind: "varRef", localId: direct.id, type: direct.type, loc: locOf(blame) };
for (const d of lowerer.checker.declarationsOf(sym)) {
const byDecl = lowerer.globalsByDeclNode.get(d);
if (byDecl) return { kind: "varRef", localId: byDecl.id, type: byDecl.type, loc: locOf(blame) };
// Alias plumbing: a shorthand/identifier table entry or a member
// export naming a declaration. Reading that identifier IS the value.
if (ts.isShorthandPropertyAssignment(d)) return lowerer.lowerShorthandValue(d);
if (ts.isPropertyAssignment(d) && ts.isIdentifier(d.initializer)) {
return lowerer.lowerExpr(d.initializer);
}
if ((ts.isFunctionDeclaration(d) || ts.isClassDeclaration(d)) && d.name !== undefined) {
return lowerer.lowerExpr(d.name);
}
}
return null;
}
packages/compiler/src/frontend/lowering/cjs-tsc-interop.ts
+223
View File
@@ -0,0 +1,223 @@
/* tsc's CommonJS import interop: `const x_1 = __importDefault(require("./m"))`
* and `const x_1 = __importStar(require("./m"))` at a module's top level,
* with the helpers tsc emits at the top of the file:
*
* var __importDefault = (this && this.__importDefault) || function (mod) {
* return (mod && mod.__esModule) ? mod : { "default": mod };
* };
*
* For a CommonJS dependency the helper's answer is fixed by the
* dependency's source: stamped with `__esModule` (tsc output), the binding
* IS the module's exports; otherwise `x_1.default` is the module's exports
* (and __importStar also copies every export onto x_1). Both are the
* static alias model a plain `const x_1 = require("./m")` already has, so
* the binding lowers as a require binding: the statement is the module's
* %init, `x_1.f` / `x_1.default.f` read the exports statically, and
* `x_1.default` over a single-value module is that value. The helper
* declarations themselves are dead once every call is such a binding (the
* self-probe `this.__importDefault` reads the pristine exports object,
* which never has the name), so they lower to nothing. */
import * as ts from "../ts7/adapter.js";
import type { Lowerer } from "./lowerer.js";
import {
isCjsJsFile,
isEsModuleStamp,
npmStaticDepSf7,
requireSpecOf,
resolveImport,
} from "../program.js";
import { cjsNamespaceModule } from "./cjs-inline-require.js";
const HELPERS = new Set([
"__importDefault",
"__importStar",
"__createBinding",
"__setModuleDefault",
]);
export interface TscInteropBinding {
helper: "__importDefault" | "__importStar";
spec: string;
dep: ts.SourceFile;
/** The dependency stamps `__esModule`: the binding IS its exports. */
stamped: boolean;
}
/** `var <helper> = (this && this.<helper>) || <function>` at a module's top
* level: the tsc helper declaration shape. */
function tscHelperDeclName(stmt: ts.Statement): string | null {
if (!ts.isVariableStatement(stmt)) return null;
const decls = stmt.declarationList.declarations;
if (decls.length !== 1) return null;
const d = decls[0]!;
if (!ts.isIdentifier(d.name) || !HELPERS.has(d.name.text) || d.initializer === undefined)
return null;
let init: ts.Expression = d.initializer;
while (ts.isParenthesizedExpression(init)) init = init.expression;
if (!ts.isBinaryExpression(init) || init.operatorToken.kind !== ts.SyntaxKind.BarBarToken)
return null;
let probe: ts.Expression = init.left;
while (ts.isParenthesizedExpression(probe)) probe = probe.expression;
if (
!ts.isBinaryExpression(probe) ||
probe.operatorToken.kind !== ts.SyntaxKind.AmpersandAmpersandToken ||
probe.left.kind !== ts.SyntaxKind.ThisKeyword ||
!ts.isPropertyAccessExpression(probe.right) ||
probe.right.expression.kind !== ts.SyntaxKind.ThisKeyword ||
probe.right.name.text !== d.name.text
)
return null;
// The fallback is the helper body: a function, or (newer tsc output) a
// conditional or IIFE producing one. It never runs when the helper is dead.
return d.name.text;
}
/** True when the dependency stamps itself as an ES module translation. */
function stampsEsModule(dep: ts.SourceFile): boolean {
return dep.statements.some((s) => {
if (!ts.isExpressionStatement(s)) return false;
if (isEsModuleStamp(s.expression)) return true;
const e = s.expression;
return (
ts.isBinaryExpression(e) &&
e.operatorToken.kind === ts.SyntaxKind.EqualsToken &&
ts.isPropertyAccessExpression(e.left) &&
ts.isIdentifier(e.left.expression) &&
e.left.expression.text === "exports" &&
e.left.name.text === "__esModule" &&
e.right.kind === ts.SyntaxKind.TrueKeyword
);
});
}
/** The interop binding a top-level `const x = __importDefault(require(s))` /
* `__importStar(require(s))` declaration makes, or null. The helper must be
* the module's own tsc helper declaration and the dependency a compiled
* CommonJS program module. */
export function tscInteropBindingOfDecl(
lowerer: Lowerer,
decl: ts.VariableDeclaration,
): TscInteropBinding | null {
if (!ts.isIdentifier(decl.name) || decl.initializer === undefined) return null;
const stmt = decl.parent?.parent;
if (stmt === undefined || !ts.isVariableStatement(stmt) || !ts.isSourceFile(stmt.parent))
return null;
const sf = stmt.parent;
if (!isCjsJsFile(sf, lowerer.program)) return null;
let init: ts.Expression = decl.initializer;
while (ts.isParenthesizedExpression(init)) init = init.expression;
if (!ts.isCallExpression(init) || init.arguments.length !== 1) return null;
const callee = init.expression;
if (!ts.isIdentifier(callee)) return null;
if (callee.text !== "__importDefault" && callee.text !== "__importStar") return null;
if (!sf.statements.some((s) => tscHelperDeclName(s) === callee.text)) return null;
const spec = requireSpecOf(init.arguments[0]!);
if (spec === null) return null;
const dep =
resolveImport(lowerer.program, sf, spec, "require") ??
npmStaticDepSf7(lowerer.program, sf, spec, "require");
if (!dep || dep.isDeclarationFile || !isCjsJsFile(dep, lowerer.program)) return null;
return {
helper: callee.text as TscInteropBinding["helper"],
spec,
dep,
stamped: stampsEsModule(dep),
};
}
/** The interop binding an identifier reads, or null. */
export function tscInteropBindingOf(
lowerer: Lowerer,
expr: ts.Expression,
): TscInteropBinding | null {
if (!ts.isIdentifier(expr)) return null;
const sym = lowerer.checker.getSymbolAtLocation(expr);
const decl = sym ? lowerer.checker.declarationsOf(sym).find(ts.isVariableDeclaration) : undefined;
return decl ? tscInteropBindingOfDecl(lowerer, decl) : null;
}
/** The module whose exports `expr` denotes through an interop binding:
* the binding itself when the dependency is stamped (or for __importStar,
* whose copy carries every export), and `binding.default` when it is not.
* Null for anything else. */
export function tscInteropModuleOf(
lowerer: Lowerer,
expr: ts.Expression,
): TscInteropBinding | null {
let e = expr;
while (ts.isParenthesizedExpression(e)) e = e.expression;
const direct = tscInteropBindingOf(lowerer, e);
if (direct !== null) {
return direct.stamped || direct.helper === "__importStar" ? direct : null;
}
if (ts.isPropertyAccessExpression(e) && !e.questionDotToken && e.name.text === "default") {
const via = tscInteropBindingOf(lowerer, e.expression);
if (via !== null && !via.stamped) return via;
}
return null;
}
/** `binding.default` over an unstamped single-value dependency: that value
* (the caller lowers the dependency's whole export). */
export function tscInteropDefaultValueOf(
lowerer: Lowerer,
expr: ts.PropertyAccessExpression,
): TscInteropBinding | null {
if (expr.questionDotToken || expr.name.text !== "default") return null;
const via = tscInteropBindingOf(lowerer, expr.expression);
if (via === null || via.stamped) return null;
return cjsNamespaceModule(lowerer, via.dep) ? null : via;
}
/** True for a tsc helper declaration every reference to which is a
* recognized interop binding's callee, its own self-probe, or a reference
* from another such dead helper: the statement lowers to nothing. */
export function isDeadTscHelperDecl(lowerer: Lowerer, stmt: ts.Statement): boolean {
const name = tscHelperDeclName(stmt);
if (name === null) return false;
const sf = stmt.getSourceFile();
const helperSpans = new Map<string, ts.Statement>();
for (const s of sf.statements) {
const n = tscHelperDeclName(s);
if (n !== null) helperSpans.set(n, s);
}
const dead = new Set<string>();
for (let changed = true; changed;) {
changed = false;
for (const [helper, decl] of helperSpans) {
if (dead.has(helper)) continue;
let live = false;
ts.walkPreorder(sf, (node) => {
if (!ts.isIdentifier(node) || node.text !== helper) return undefined;
const parent = node.parent;
if (parent !== undefined && ts.isVariableDeclaration(parent) && parent.name === node)
return undefined;
const at = node.getStart(sf);
if (at >= decl.getStart(sf) && at < decl.getEnd()) return undefined;
for (const [other, otherDecl] of helperSpans) {
if (other !== helper && dead.has(other)) {
if (at >= otherDecl.getStart(sf) && at < otherDecl.getEnd()) return undefined;
}
}
const call = parent;
const binding = call?.parent;
if (
call !== undefined &&
ts.isCallExpression(call) &&
call.expression === node &&
binding !== undefined &&
ts.isVariableDeclaration(binding) &&
tscInteropBindingOfDecl(lowerer, binding) !== null
)
return undefined;
live = true;
return "stop";
});
if (!live) {
dead.add(helper);
changed = true;
}
}
}
return dead.has(name);
}
packages/compiler/src/frontend/lowering/expressions/optional-chains.ts
+22 -7
View File
@@ -26,7 +26,8 @@ import type { Lowerer } from "../lowerer.js";
* deeper — `x?.trim().toLowerCase()` reads nothing past the guard when x
* is nullish, so the whole tail must lower inside it. Walks
* property/element accesses and call steps only (parens and `!` break
* the chain per the grammar: `(a?.b).c` throws on undefined in JS);
* the chain per the grammar: `(a?.b).c` throws on undefined in JS, while
* an unparenthesized `a?.b!.c` stays one chain, as TypeScript emits it);
* the node's OWN token — and a call's immediate callee token — are the
* plain entries' cases, not tails, and handled markers make the chain
* lowering's re-dispatch walk past its own step. `f?.()` steps stay out
@@ -41,6 +42,10 @@ function chainTailDot(
// An active chain's bound receiver read is a LEAF — its own token
// was consumed by the chain that bound it.
if (lowerer.chainRecvByNode.has(cur)) return null;
if (ts.isNonNullExpression(cur)) {
cur = cur.expression;
continue;
}
if (ts.isCallExpression(cur)) {
// `f?.()` steps route through their own entry (or are being
// handled); a deeper token under one is that chain's business.
@@ -91,20 +96,29 @@ export function isOptionalChainTail(lowerer: Lowerer, expr: ts.Expression): bool
if (!tail) return false;
const recvT = lowerer.mapTypeOf(lowerer.typeOf(tail.expression));
if (recvT?.kind === "dyn") return true;
if (recvT?.kind !== "union") return false;
const def = lowerer.unions.get(recvT.unionId);
return !!def && def.arms.some(isUnitType);
if (recvT?.kind === "union") {
const def = lowerer.unions.get(recvT.unionId);
if (def?.arms.some(isUnitType)) return true;
}
// The checker calls the receiver present, but an unchecked read (`a[0]`
// past the end, a missing index-signature key) can still lower to an
// undefined-armed value, and `a[0]?.b.c` must then short-circuit `.c`
// too. The chain lowering inspects the lowered receiver: a present value
// re-dispatches the plain lowering, so only genuinely optional receivers
// change shape.
return lowerer.isRuntimeOptionalOrigin(tail.expression);
}
/** True when an EARLIER step of this access chain carries `?.` — JS
* short-circuits the whole tail (`a?.b.c` reads nothing when a is
* nullish), so a dyn tail read must answer undefined instead of
* throwing. Walks the receiver spine only; the argument of the access
* itself is not part of the guard. */
* itself is not part of the guard. Parentheses end the chain
* (`(a?.b).c` reads `.c` from undefined); `!` does not. */
export function hasOptionalChainGuard(expr: ts.Expression): boolean {
let cur: ts.Expression = expr;
for (;;) {
if (ts.isParenthesizedExpression(cur) || ts.isNonNullExpression(cur)) {
if (ts.isNonNullExpression(cur)) {
cur = cur.expression;
continue;
}
@@ -393,7 +407,8 @@ export function lowerOptionalChain(
for (let cur: ts.Expression = expr; cur !== dotNode;) {
const next: ts.Expression = ts.isCallExpression(cur)
? cur.expression
: (cur as ts.PropertyAccessExpression | ts.ElementAccessExpression).expression;
: (cur as ts.PropertyAccessExpression | ts.ElementAccessExpression | ts.NonNullExpression)
.expression;
if (next === dotNode) break;
if (!lowerer.chainNarrowedType.has(next)) {
lowerer.chainNarrowedType.set(
packages/compiler/src/frontend/lowering/function-returns.ts
+7 -4
View File
@@ -429,11 +429,14 @@ export function resolveInferredReturn(
if (ice.length > 0) lowerer.diags.push(...ice);
lowerer.runtimeFences.push(...captured.filter((d) => d.code !== "SC9001"));
const first = captured.find((d) => d.code !== "SC9001");
// Property writes, not literal element writes: the class method
// census reads `x["kind"] = …` as a possible write to every method
// named `kind`, which would make those methods dynamic in native builds.
const mutable = e.stmt as unknown as Record<string, unknown>;
delete mutable["value"];
mutable["kind"] = "runtimeFence";
mutable["code"] = first?.code ?? "SC1090";
mutable["message"] = first
delete mutable.value;
mutable.kind = "runtimeFence";
mutable.code = first?.code ?? "SC1090";
mutable.message = first
? `${first.message} [${first.code}]`
: "this return value has no lowering onto the instance's settled return type [SC1090]";
}
packages/compiler/src/frontend/lowering/generic-functions.ts
+147 -1
View File
@@ -15,7 +15,7 @@ import { isJsSourceFile, locOf } from "../program.js";
import { typeKey } from "../type-mapper.js";
import { PoisonError, dynFallbackType, neverTaintedJsType, newFnCtx } from "./lowerer.js";
import { tryLowerExpression } from "./expressions/try-lower-expression.js";
import { findGenericMethodOn, type ClassInfo } from "./lower-classes.js";
import { findGenericMethodOn, storedClassValueType, type ClassInfo } from "./lower-classes.js";
import { nsPathPrefix } from "./lower-namespaces.js";
import { declSymbolOf } from "./lower-modules.js";
import { npmStaticPackageOfPath } from "../npm-static.js";
@@ -292,6 +292,8 @@ export function genericCallInstance(
(_param, i) => expr.arguments[i] ?? expr,
);
const retTs = lowerer.checker.getReturnTypeOfSignature(rsig);
const local = localClassResultInstance(lowerer, expr, info, rsig, params, retTs);
if (local) return local;
const returnType = lowerer.mapTypeOf(retTs);
if (!returnType) {
fenceGenericSignatureResult(lowerer, expr, retTs);
@@ -331,6 +333,150 @@ export function genericCallInstance(
);
}
/** A generic factory whose result is one of its own local classes
* (`function base<T>(v: T) { return class { value: T = v }; }`). Each
* instance has its own class, so the instance is keyed on its bindings and
* the result maps inside it, where the local class takes the instance's
* name and bindings. */
function localClassResultInstance(
lowerer: Lowerer,
expr: ts.CallExpression,
info: GenericFnInfo,
rsig: ts.Signature,
params: ParamShape[],
retTs: ts.Type,
): GenericInstance | null {
if (!localClassOfResult(lowerer, info, retTs)) return null;
const tsBindings = new Map<ts.Symbol, ts.Type>();
const bindings = lowerer.inferTypeParamBindings(expr, info, rsig, tsBindings);
const bindingKey = info.typeParams
.map((tp) => {
const bound = bindings.get(tp);
return bound ? typeKey(bound) : "?";
})
.join(",");
const pending: IrType = { kind: "void" };
const inst = internGenericInstance(lowerer, expr, info, params, pending, () => bindings, {
extraKey: `@class<${bindingKey}>`,
tsBindings,
});
if (inst.returnType !== pending) return inst;
const returnType = withInstanceScope(lowerer, info, inst, () => lowerer.mapTypeOf(retTs));
if (!returnType) {
fenceGenericSignatureResult(lowerer, expr, retTs);
lowerer.badType(expr, retTs);
}
inst.returnType = returnType;
// Values of the class outside the factory (`const b = new B()`, `b.read()`)
// carry the instantiated checker type; record which class it names. A
// call inside another generic instance can have a type that depends on
// that instance's parameters, which no single class answers.
if (lowerer.typeParamBindings !== null) return inst;
const instance =
returnType.kind === "classval"
? lowerer.checker
.getConstructSignatures(retTs)
.map((sig) => lowerer.checker.getReturnTypeOfSignature(sig))
: [retTs];
const className =
returnType.kind === "classval" || returnType.kind === "object" ? returnType.className : null;
if (className !== null)
for (const type of instance) lowerer.localClassInstanceTypes.set(type.id, className);
return inst;
}
/** The class value a call of a generic factory returns when the result is
* one of the factory's local classes (`class C extends base(42) {}`), or
* null for any other call. */
export function genericLocalClassResult(lowerer: Lowerer, expr: ts.CallExpression): IrType | null {
if (!ts.isIdentifier(expr.expression)) return null;
const info = lowerer.genericFnOf(expr.expression);
if (!info || info.implicitParams) return null;
const rsig = lowerer.checker.getResolvedSignature(expr);
if (!rsig || !localClassOfResult(lowerer, info, lowerer.checker.getReturnTypeOfSignature(rsig)))
return null;
return genericCallInstance(lowerer, expr, info).returnType;
}
/** The type of a `const` binding whose initializer calls a generic factory
* returning one of its local classes (`const B = base(7)`), or constructs
* such a class (`const b = new B()`); null for any other binding. */
export function genericLocalClassBinding(lowerer: Lowerer, node: ts.Node): IrType | null {
const decl = node.parent;
if (
!ts.isIdentifier(node) ||
!decl ||
!ts.isVariableDeclaration(decl) ||
decl.name !== node ||
!decl.initializer ||
(ts.getCombinedNodeFlags(decl) & ts.NodeFlags.Const) === 0
)
return null;
// An `any` binding keeps the checked-dynamic representation.
if ((lowerer.typeOf(node).flags & ts.TypeFlags.Any) !== 0) return null;
let init = decl.initializer;
while (ts.isParenthesizedExpression(init)) init = init.expression;
if (ts.isCallExpression(init)) return genericLocalClassResult(lowerer, init);
if (!ts.isNewExpression(init)) return null;
const constructed = storedClassValueType(lowerer, init.expression);
if (constructed?.kind !== "classval") return null;
const classDecl = lowerer.classes.get(constructed.className)?.decl;
return classDecl && insideGenericFunction(classDecl)
? { kind: "object", className: constructed.className }
: null;
}
/** Whether `node` is declared inside a function with type parameters. */
function insideGenericFunction(node: ts.Node): boolean {
for (let parent = node.parent; parent && !ts.isSourceFile(parent); parent = parent.parent)
if (ts.isFunctionLike(parent) && (parent.typeParameters?.length ?? 0) > 0) return true;
return false;
}
/** The class declared inside a generic function that `type` is the
* constructor or instance type of, or null. */
function localClassOfResult(
lowerer: Lowerer,
info: GenericFnInfo,
type: ts.Type,
): ts.ClassLikeDeclaration | null {
const symbol = type.getSymbol();
if (!symbol || !(symbol.flags & ts.SymbolFlags.Class)) return null;
const decl = lowerer.checker.valueDeclarationOf(symbol);
if (!decl || !(ts.isClassExpression(decl) || ts.isClassDeclaration(decl))) return null;
for (let parent = decl.parent; parent && !ts.isSourceFile(parent); parent = parent.parent)
if (parent === info.decl) return decl;
return null;
}
/** Runs `fn` under an instance's type bindings and local-class names, as
* its body lowers. */
function withInstanceScope<T>(
lowerer: Lowerer,
info: GenericFnInfo,
inst: GenericInstance,
fn: () => T,
): T {
const prevBindings = lowerer.typeParamBindings;
const prevTsBindings = lowerer.typeParamTsBindings;
const previousPath = lowerer.genericInstantiationPath;
const prevContext = lowerer.instantiationContext;
lowerer.typeParamBindings = inst.bindings;
lowerer.typeParamTsBindings = inst.tsBindings ?? null;
lowerer.genericInstantiationPath = inst.path;
lowerer.instantiationContext = `instantiating '${info.baseName}' with ${inst.typeArgsText}`;
lowerer.localClassInstantiations.push({ owner: info.decl, name: inst.name });
try {
return fn();
} finally {
lowerer.localClassInstantiations.pop();
lowerer.typeParamBindings = prevBindings;
lowerer.typeParamTsBindings = prevTsBindings;
lowerer.genericInstantiationPath = previousPath;
lowerer.instantiationContext = prevContext;
}
}
/** The one instance table both instantiation routes share: key identity IS
* signature identity, so a call (`identity(1)`) and a pinned VALUE
* (`const f: (x: number) => number = identity`) reuse one compiled
packages/compiler/src/frontend/lowering/lower-builtin-values.ts
+32
View File
@@ -23,6 +23,7 @@ import {
builtinModulesArrayLit,
stdlibGlobalNameOf,
} from "./surfaces.js";
import { CRYPTO_CONSTANTS } from "./crypto-tables.js";
const PROTOTYPE_METHODS: Record<string, readonly string[]> = {
Date: ["getTime", "valueOf", "toISOString", "toJSON"],
@@ -680,3 +681,34 @@ export function lowerBuiltinLoaderValue(lowerer: Lowerer, loc: SrcLoc): IrExpr {
loc,
};
}
/** The deprecated node:constants module object: the runtime merges
* os.constants' groups and fs.constants with crypto.constants, which a
* lifted function answers from the baked table the first time the object
* is built. */
export function builtinConstantsObject(lowerer: Lowerer, loc: SrcLoc): IrExpr {
const name = "%builtin.constants.crypto";
if (!lowerer.builtinCallableValueFns.has(name)) {
lowerer.builtinCallableValueFns.set(name, name);
const fields = Object.entries(CRYPTO_CONSTANTS).map(([key, value]) => ({
key: strLit(key, loc),
value: box(builtinConstLit(value, loc)),
}));
lowerer.liftedFns.push({
name,
params: [],
returnType: DYN,
locals: [],
body: [{ kind: "return", value: { kind: "dynObjLit", fields, type: DYN, loc }, loc }],
loc,
});
}
const table: IrExpr = {
kind: "closure",
fnName: name,
captures: [],
type: { kind: "func", params: [], ret: DYN },
loc,
};
return { kind: "libCall", fn: "constants.object", args: [box(table)], type: DYN, loc };
}
packages/compiler/src/frontend/lowering/lower-calls.ts
+136 -6
View File
@@ -24,6 +24,13 @@ import {
lowerZlibStreamMethodCall,
} from "./builtins/compression.js";
import type { Lowerer } from "./lowerer.js";
import {
inlineNamespaceRequireOf,
lowerInlineRequireValue,
lowerUncompiledRequireCall,
lowerWithInlineRequireInit,
} from "./cjs-inline-require.js";
import { cjsExportCallIgnoresThis, cjsInFileExportGlobalOf } from "./cjs-exports-object.js";
import { lowerGenMethodCall } from "./lower-generators.js";
import { lowerClassSymbolMethodCall } from "./symbol-methods.js";
import { errorToStringCall } from "./error-methods.js";
@@ -61,7 +68,11 @@ import { lowerProtocolMethodCall } from "./class-protocol-dispatch.js";
import { isJsSourceFile, locOf, requireSpecOf } from "../program.js";
import { lowerJsonRequireCall } from "./json-require.js";
import { lowerAssertInstanceCall } from "./assert-instances.js";
import { isGenericCallableMemberType, typeKey } from "../type-mapper.js";
import {
isGenericCallableMemberType,
isOverloadedCallableMemberType,
typeKey,
} from "../type-mapper.js";
import { dynFallbackType, jsFuncNameOf, newFnCtx, staticImportNamespaceType } from "./lowerer.js";
import {
NARROW_FIRST,
@@ -234,6 +245,32 @@ export function lowerCall(lowerer: Lowerer, expr: ts.CallExpression): IrExpr {
const json = lowerJsonRequireCall(lowerer, expr);
if (json) return json;
// Inline require() of a program module (cjs-inline-require.ts): a
// member call over its export table resolves like a binding's member
// call after the module's %init at this position; the require itself
// as a value answers the module's whole-export value.
if (ts.isPropertyAccessExpression(expr.expression) && !expr.expression.questionDotToken) {
const req = inlineNamespaceRequireOf(lowerer, expr.expression.expression);
if (req !== null && !lowerer.inlineRequireInitDone.has(req.call)) {
// Node calls the member with `this` bound to the module's exports.
if (
ts.isIdentifier(expr.expression.name) &&
!cjsExportCallIgnoresThis(lowerer, req.dep, expr.expression.name.text)
) {
lowerer.unsupported(
"SC1090",
expr,
`calling '${expr.expression.name.text}' through require(${JSON.stringify(req.spec)}) when the function may read 'this' (Node binds it to the module's exports object, which compiles to a static table — bind the module and call a local function instead)`,
);
}
return lowerWithInlineRequireInit(lowerer, req, () => lowerCall(lowerer, expr));
}
}
{
const inlineValue = lowerInlineRequireValue(lowerer, expr);
if (inlineValue) return inlineValue;
}
// A call whose chain ROOTS at an ambient-undefined name (`declare
// const value: Y | undefined; value?.foo("a")`, `declare function
// chain...; chain(o).mapValues(f).value()`, a trap binding's read):
@@ -310,6 +347,12 @@ export function lowerCall(lowerer: Lowerer, expr: ts.CallExpression): IrExpr {
lowerImportMetaResolveCall(lowerer, expr) ?? lowerRequireResolveCall(lowerer, expr);
if (resolved) return resolved;
}
// Any other require() call of the CommonJS global: MODULE_NOT_FOUND for
// packages nothing installed resolves, a named refusal otherwise.
{
const uncompiled = lowerUncompiledRequireCall(lowerer, expr);
if (uncompiled) return uncompiled;
}
// `process.getuid?.()` — intercepted BEFORE the optional-chain
// machinery (the member always exists on a POSIX target, so the
@@ -1274,6 +1317,32 @@ export function lowerCall(lowerer: Lowerer, expr: ts.CallExpression): IrExpr {
const args = completeFuncValueArgs(lowerer, expr, callee.type, loc);
return { kind: "callValue", callee, args, type: callee.type.ret, loc };
}
// `exports.f(x)` / `module.exports.f(x)` inside the module: a call of
// the member's export global (cjs-exports-object.ts), the value every
// `exports.f =` statement assigns.
if (ts.isPropertyAccessExpression(expr.expression) && !expr.questionDotToken) {
const g = cjsInFileExportGlobalOf(lowerer, expr.expression);
if (
g &&
(g.type.kind === "func" || g.type.kind === "dyn") &&
!cjsExportCallIgnoresThis(lowerer, expr.getSourceFile(), expr.expression.name.text)
) {
lowerer.unsupported(
"SC1090",
expr,
`calling '${expr.expression.getText()}' through the module's exports object when the function may read 'this' (Node binds it to the exports object, which compiles to a static table — call a local function instead)`,
);
}
if (g && (g.type.kind === "func" || g.type.kind === "dyn")) {
const callee: IrExpr = { kind: "varRef", localId: g.id, type: g.type, loc };
const checked = lowerCheckedCallableValue(lowerer, expr, callee, loc);
if (checked) return checked;
if (callee.type.kind === "func") {
const args = completeFuncValueArgs(lowerer, expr, callee.type, loc);
return { kind: "callValue", callee, args, type: callee.type.ret, loc };
}
}
}
if (ts.isPropertyAccessExpression(expr.expression)) {
const intrinsic =
fenceNodeModuleMutationCall(lowerer, expr, expr.expression) ??
@@ -4170,10 +4239,32 @@ function lowerNumberToStringCall(
}
if (call.arguments.length === 1) {
if (operand.type.kind !== "f64") return null;
const arg = call.arguments[0]!;
// A number radix needs no box: ToIntegerOrInfinity of a number is a
// truncation, which the typed entry point applies itself.
if (!ts.isSpreadElement(arg) && lowerer.mapTypeOf(lowerer.typeOf(arg))?.kind === "f64") {
const radix = lowerer.lowerExpr(arg);
if (radix.type.kind === "f64") {
return {
kind: "libCall",
fn: "num.toStringRadixF64",
args: [operand, radix],
type: STRING,
loc: locOf(call),
};
}
return {
kind: "libCall",
fn: "num.toStringRadix",
args: [operand, lowerer.coerceToExpected(radix, DYN)],
type: STRING,
loc: locOf(call),
};
}
return {
kind: "libCall",
fn: "num.toStringRadix",
args: [operand, lowerer.lowerExprExpecting(call.arguments[0]!, DYN)],
args: [operand, lowerer.lowerExprExpecting(arg, DYN)],
type: STRING,
loc: locOf(call),
};
@@ -8185,6 +8276,30 @@ function lowerObjectAssignHybrid(lowerer: Lowerer, call: ts.CallExpression): IrE
return { kind: "recordLit", fields, type: mapped, loc };
}
/** The accessed member is an overload set (isOverloadedCallableMemberType),
* also under an optional chain whose access still spells `| undefined`. */
function isOverloadedMemberAccess(lowerer: Lowerer, access: ts.PropertyAccessExpression): boolean {
return isOverloadedCallableMemberType(
lowerer.checker.getNonNullableType(lowerer.typeOf(access)),
lowerer.checker,
);
}
/** The result type of the overload a call through an overloaded member
* resolved to: the erased slot's result converts to it. A non-generic
* overload answers through its declaration, because the resolved signature
* of an optional-chain call (`api?.m(x)`) also carries the chain's
* undefined; a generic one answers through its instantiation. */
function resolvedOverloadResultType(lowerer: Lowerer, call: ts.CallExpression): IrType {
const { checker } = lowerer;
const signature = checker.getResolvedSignature(call);
const decl = signature ? checker.signatureDeclaration(signature) : undefined;
const declared = decl ? checker.getSignatureFromDeclaration(decl) : undefined;
const source = declared && declared.getTypeParameters().length === 0 ? declared : signature;
const result = source ? lowerer.mapTypeOf(checker.getReturnTypeOfSignature(source)) : null;
return result ?? lowerer.irTypeOf(call);
}
export function lowerRecordFieldCall(
lowerer: Lowerer,
call: ts.CallExpression,
@@ -8216,7 +8331,18 @@ export function lowerRecordFieldCall(
const callee = lowerer.lowerUnionProperty(access);
if (callee?.type.kind !== "func") return null;
const args = completeFuncValueArgs(lowerer, call, callee.type, locOf(call));
return { kind: "callValue", callee, args, type: callee.type.ret, loc: locOf(call) };
const value: IrExpr = {
kind: "callValue",
callee,
args,
type: callee.type.ret,
loc: locOf(call),
};
// An overloaded member's erased result converts to the resolved
// overload's type, as on a single record receiver below.
return isOverloadedMemberAccess(lowerer, access)
? lowerer.coerceInto(call, value, resolvedOverloadResultType(lowerer, call))
: value;
}
const target = lowerer.fieldTarget(access);
const loc = locOf(call);
@@ -8291,10 +8417,14 @@ export function lowerRecordFieldCall(
type: callee.type.ret,
loc,
};
// A generic member's field holds its erased instance: the result
// converts to this call's instantiated return type at the call.
if (isGenericCallableMemberType(lowerer.typeOf(access), lowerer.checker))
// A generic member's field holds its erased instance, and an overloaded
// member's field its erased function (the overloads joined): the result
// converts to this call's instantiated or resolved return type.
const memberType = lowerer.typeOf(access);
if (isGenericCallableMemberType(memberType, lowerer.checker))
result = lowerer.coerceInto(call, result, lowerer.irTypeOf(call));
else if (isOverloadedMemberAccess(lowerer, access))
result = lowerer.coerceInto(call, result, resolvedOverloadResultType(lowerer, call));
return init ? { kind: "seqExpr", stmts: [init], result, type: result.type, loc } : result;
}
packages/compiler/src/frontend/lowering/lower-classes.ts
+67 -17
View File
@@ -12,7 +12,13 @@ import { InternalCompilerError } from "../../errors.js";
import { fsStreamClassOf, lowerFsStreamNew } from "./builtins/fs-streams.js";
import * as ts from "../ts7/adapter.js";
import { lowerZlibStreamNew, zlibClassName, zlibStreamModeOf } from "./builtins/compression.js";
import {
type BuiltinClassRef,
builtinClassAliasOf,
builtinClassRefOf,
} from "./builtins/class-values.js";
import type { FnCtx, Lowerer } from "./lowerer.js";
import { inlineNamespaceRequireOf, lowerWithInlineRequireInit } from "./cjs-inline-require.js";
import {
BOOL,
DATE_T,
@@ -45,6 +51,7 @@ import {
implicitAnyParamSymbolsOf,
implicitCallInstance,
implicitMonoFile,
genericLocalClassResult,
type GenericFnInfo,
} from "./generic-functions.js";
import {
@@ -223,6 +230,11 @@ export function storedClassValueType(
if (value?.kind === "classval") return value;
}
}
// A generic factory's own local class has one class per instance.
if (ts.isCallExpression(expression)) {
const local = genericLocalClassResult(lowerer, expression);
if (local?.kind === "classval") return local;
}
const type = lowerer.typeOf(expression);
const mapped = lowerer.mapTypeOf(type);
if (mapped?.kind === "classval" && !lowerer.classes.has(mapped.className)) {
@@ -924,12 +936,15 @@ export function registerBuiltinStreamClasses(lowerer: Lowerer): void {
* "stream" ambient module, EXCLUDING @types/node's (whose stream.Readable
* also types child stdio — under @types/node the childStream mapping
* keeps priority and the static stream classes stand down; the shipped
* fallback declarations are the supported surface). */
* fallback declarations are the supported surface). A const binding of
* one (`const R = Readable`) names the same class (builtinClassAliasOf). */
export function builtinStreamInfoOf(
lowerer: Lowerer,
symbol: ts.Symbol | null | undefined,
): ClassInfo | null {
if (!symbol) return null;
const alias = builtinClassAliasOf(lowerer, symbol);
if (alias !== null) return alias.kind === "stream" ? alias.info : null;
if (!lowerer.isStdlibSymbol(symbol)) {
// A const ALIAS of a namespace member (`const Writable =
// stream.Writable` — the two-step spelling; the one-step
@@ -1284,12 +1299,16 @@ function undefArmedFieldType(lowerer: Lowerer, p: ts.Symbol): IrType | null {
* `extends EventEmitter`, `x instanceof EventEmitter`) — any import
* spelling (named/default/namespace member, CJS require) resolves to
* the ambient class. Provenance-checked like the error classes: only a
* stdlib-file declaration inside the "events" ambient module counts. */
* stdlib-file declaration inside the "events" ambient module counts. A
* const binding of it (`const E = EventEmitter`) names the same class
* (builtinClassAliasOf). */
export function builtinEmitterInfoOf(
lowerer: Lowerer,
symbol: ts.Symbol | null | undefined,
): ClassInfo | null {
if (!symbol) return null;
const alias = builtinClassAliasOf(lowerer, symbol);
if (alias !== null) return alias.kind === "emitter" ? alias.info : null;
if (!lowerer.isStdlibSymbol(symbol)) {
// A const ALIAS of the emitter class member (`const EventEmitter =
// require('node:events').EventEmitter` — commander's spelling; the
@@ -1330,12 +1349,17 @@ export function builtinEmitterInfoOf(
/** The builtin error ClassInfo a VALUE symbol refers to (`new Error`,
* `extends TypeError`, `x instanceof RangeError`), or null. Provenance-
* checked: only the standard library's declarations count — a user's own
* `class Error` resolves through classBySymbol instead. */
* `class Error` resolves through classBySymbol instead. A const binding
* of one (`const E = TypeError`) names the same class
* (builtinClassAliasOf). */
export function builtinErrorInfoOf(
lowerer: Lowerer,
symbol: ts.Symbol | null | undefined,
): ClassInfo | null {
if (!symbol || !lowerer.isStdlibSymbol(symbol)) return null;
if (!symbol) return null;
const alias = builtinClassAliasOf(lowerer, symbol);
if (alias !== null) return alias.kind === "error" ? alias.info : null;
if (!lowerer.isStdlibSymbol(symbol)) return null;
for (const [irName, rec] of RUNTIME_ERROR_CLASSES) {
if (rec.lib === symbol.name) return lowerer.classes.get(irName) ?? null;
}
@@ -4359,6 +4383,7 @@ export function lowerStaticFieldInits(lowerer: Lowerer, info: ClassInfo): IrStmt
// instantiation's bindings/context (a no-op for everything else —
// generic FAMILIES own their statics and carry no genericInstance).
const diagsBefore = lowerer.diags.length;
const sinkMark = lowerer.diagSinkMark();
try {
return withInstanceBindings(lowerer, info, () => lowerStaticFieldInitsInner(lowerer, info));
} catch (error) {
@@ -4366,8 +4391,11 @@ export function lowerStaticFieldInits(lowerer: Lowerer, info: ClassInfo): IrStmt
// Keep their refusal attached to the class declaration instead of
// letting a poisoned initializer escape the module lowering pass.
if (!(error instanceof PoisonError)) throw error;
if (info.decl && isJsSourceFile(info.decl.getSourceFile()) && lowerer.diagSink === null) {
const fence = lowerer.deferToRuntimeFence(diagsBefore, info.decl, { kind: "statement" });
if (info.decl && isJsSourceFile(info.decl.getSourceFile())) {
const fence =
lowerer.diagSink === null
? lowerer.deferToRuntimeFence(diagsBefore, info.decl, { kind: "statement" })
: lowerer.capturedRuntimeFence(sinkMark, info.decl);
if (fence) return [fence];
}
return [];
@@ -4504,6 +4532,7 @@ function lowerStaticFieldInitsInner(lowerer: Lowerer, info: ClassInfo): IrStmt[]
lowerer.stats.statementsTotal++;
lowerer.bumpFileStat(locOf(f.initializer).file, "total");
const diagsBefore = lowerer.diags.length;
const sinkMark = lowerer.diagSinkMark();
try {
const previousThis = lowerer.ctx.thisLocal;
const receiver =
@@ -4539,10 +4568,11 @@ function lowerStaticFieldInitsInner(lowerer: Lowerer, info: ClassInfo): IrStmt[]
if (!(e instanceof PoisonError)) throw e;
lowerer.stats.statementsFailed++;
lowerer.bumpFileStat(locOf(f.initializer).file, "failed");
if (isJsSourceFile(f.initializer.getSourceFile()) && lowerer.diagSink === null) {
const fence = lowerer.deferToRuntimeFence(diagsBefore, f.initializer, {
kind: "statement",
});
if (isJsSourceFile(f.initializer.getSourceFile())) {
const fence =
lowerer.diagSink === null
? lowerer.deferToRuntimeFence(diagsBefore, f.initializer, { kind: "statement" })
: lowerer.capturedRuntimeFence(sinkMark, f.initializer);
if (fence) out.push(fence);
}
}
@@ -7616,6 +7646,7 @@ export function fieldInitStmts(lowerer: Lowerer, info: ClassInfo, thisLocal: IrL
lowerer.stats.statementsTotal++;
lowerer.bumpFileStat(locOf(f.initializer).file, "total");
const diagsBefore = lowerer.diags.length;
const sinkMark = lowerer.diagSinkMark();
try {
const value = lowerer.lowerExprExpecting(f.initializer, f.type);
out.push({
@@ -7630,10 +7661,11 @@ export function fieldInitStmts(lowerer: Lowerer, info: ClassInfo, thisLocal: IrL
if (!(e instanceof PoisonError)) throw e;
lowerer.stats.statementsFailed++;
lowerer.bumpFileStat(locOf(f.initializer).file, "failed");
if (isJsSourceFile(f.initializer.getSourceFile()) && lowerer.diagSink === null) {
const fence = lowerer.deferToRuntimeFence(diagsBefore, f.initializer, {
kind: "statement",
});
if (isJsSourceFile(f.initializer.getSourceFile())) {
const fence =
lowerer.diagSink === null
? lowerer.deferToRuntimeFence(diagsBefore, f.initializer, { kind: "statement" })
: lowerer.capturedRuntimeFence(sinkMark, f.initializer);
if (fence) out.push(fence);
}
}
@@ -8435,8 +8467,22 @@ function assignedThisFieldType(lowerer: Lowerer, expr: ts.NewExpression): IrType
return lowerer.currentClass?.fields.get(parent.left.name.text) ?? null;
}
/** Map, Set and the error classes construct in lowerNew's identifier
* branch, which a module member alias of one (`new mod.M()`) also takes. */
function isCollectionOrErrorClass(ref: BuiltinClassRef | null): boolean {
return ref?.kind === "collection" || ref?.kind === "error";
}
export function lowerNew(lowerer: Lowerer, expr: ts.NewExpression): IrExpr {
const loc = locOf(expr);
// `new (require("./x").C)()`: the module's %init at the require's
// position, then construction through the member as for a binding.
if (ts.isPropertyAccessExpression(expr.expression) && !expr.expression.questionDotToken) {
const req = inlineNamespaceRequireOf(lowerer, expr.expression.expression);
if (req !== null && !lowerer.inlineRequireInitDone.has(req.call)) {
return lowerWithInlineRequireInit(lowerer, req, () => lowerNew(lowerer, expr));
}
}
const worker = lowerWorkerNew(lowerer, expr);
if (worker) return worker;
const readlineUi = lowerReadlineUiNew(lowerer, expr);
@@ -8729,7 +8775,10 @@ export function lowerNew(lowerer: Lowerer, expr: ts.NewExpression): IrExpr {
ts.isIdentifier(expr.expression) ||
(ts.isPropertyAccessExpression(expr.expression) &&
ts.isIdentifier(expr.expression.name) &&
lowerer.isStdlibGlobal(expr.expression.expression, "globalThis"))
(lowerer.isStdlibGlobal(expr.expression.expression, "globalThis") ||
// `new mod.M()` over an exported `const M = Map` or `const E =
// TypeError`
isCollectionOrErrorClass(builtinClassRefOf(lowerer, expr.expression))))
) {
// `import C = N.C; new C()` — the alias's own source-order guards
// (a no-op for every non-import= binding).
@@ -9133,7 +9182,8 @@ export function lowerNew(lowerer: Lowerer, expr: ts.NewExpression): IrExpr {
if (symbol?.name === "Array" && lowerer.isStdlibSymbol(symbol)) {
return lowerArrayConstructor(lowerer, expr, expr.arguments ?? []);
}
if (symbol?.name === "Map" && lowerer.isStdlibSymbol(symbol)) {
// A const alias (`const M = Map`) constructs the same Map.
if (ts.isIdentifier(identifier) && lowerer.isStdlibGlobal(identifier, "Map")) {
const seedArg = (expr.arguments?.length ?? 0) === 1 ? expr.arguments![0]! : null;
const isPairLit = (el: ts.Expression): el is ts.ArrayLiteralExpression =>
ts.isArrayLiteralExpression(el) &&
@@ -9265,7 +9315,7 @@ export function lowerNew(lowerer: Lowerer, expr: ts.NewExpression): IrExpr {
}
// `new Set<T>()`: construct + bulk add from supported values,
// including live collection cursors. Duplicates collapse in insertion order.
if (symbol?.name === "Set" && lowerer.isStdlibSymbol(symbol)) {
if (ts.isIdentifier(identifier) && lowerer.isStdlibGlobal(identifier, "Set")) {
const tsType = lowerer.typeOf(expr);
let mapped = lowerer.mapTypeOf(tsType);
const fieldType = assignedThisFieldType(lowerer, expr);
packages/compiler/src/frontend/lowering/lower-exprs.ts
+154 -45
View File
@@ -35,14 +35,28 @@ import {
isZlibStreamMember,
lowerZlibInstanceOf,
lowerZlibStreamBytesWritten,
zlibClassAliasOf,
zlibClassModeOfExpr,
zlibClassName,
} from "./builtins/compression.js";
import {
builtinClassAliasOwnsNoSlot,
builtinClassRefOf,
sameBuiltinClass,
} from "./builtins/class-values.js";
import { constituentTypes } from "../ts7/checker.js";
import { dirname } from "node:path";
import * as posix from "node:path/posix";
import type { Lowerer } from "./lowerer.js";
import {
inlineNamespaceRequireOf,
lowerWithInlineRequireInit,
wholeExportValue,
} from "./cjs-inline-require.js";
import { tscInteropDefaultValueOf } from "./cjs-tsc-interop.js";
import {
cjsExportMemberWriteGlobalOf,
cjsInFileExportGlobalOf,
isCjsExportsIdentifier,
lowerCjsExportsObjectValue,
} from "./cjs-exports-object.js";
import { checkedClassAssertion, checkedClassUnionAssertion } from "./class-assertions.js";
import { checkedArmExtraction } from "./coercions/unions.js";
import { narrowClassUnion, narrowStoredClassValue } from "./class-unions.js";
@@ -205,6 +219,7 @@ import {
isNodeModuleValue,
lowerCjsTopLevelThis,
lowerNodeModuleIdentifier,
isCjsModuleGlobal,
lowerNodeModuleProperty,
lowerRequireCacheElement,
lowerRequireCacheHas,
@@ -228,6 +243,7 @@ import {
} from "./class-prototypes.js";
import { isClassCallback } from "./class-callbacks.js";
import {
builtinConstantsObject,
builtinPrototypeMethod,
lowerArrayIsArrayValue,
lowerCheckedPredicateValue,
@@ -616,8 +632,9 @@ function lowerExprInner(lowerer: Lowerer, expr: ts.Expression): IrExpr {
if (isNodeModuleValue(lowerer, expr.expression)) {
return { kind: "strLit", value: "object", type: STRING, loc };
}
// `typeof zlib.Gzip`, `typeof C` over a zlib class alias.
if (zlibClassModeOfExpr(lowerer, expr.expression) !== null) {
// `typeof EventEmitter`, `typeof zlib.Gzip`, `typeof C` over a
// builtin class alias.
if (builtinClassRefOf(lowerer, expr.expression) !== null) {
return { kind: "strLit", value: "function", type: STRING, loc };
}
if (ts.isPropertyAccessExpression(expr.expression)) {
@@ -858,6 +875,10 @@ function lowerExprInner(lowerer: Lowerer, expr: ts.Expression): IrExpr {
const moduleValue = lowerNodeModuleIdentifier(lowerer, expr);
if (moduleValue) return moduleValue;
if (expr.text === "exports") {
const exportsValue = lowerCjsExportsObjectValue(lowerer, expr);
if (exportsValue) return exportsValue;
}
if (lowerer.isSelfReference(expr)) {
return { kind: "selfRef", type: lowerer.ctx.selfType!, loc };
}
@@ -902,13 +923,13 @@ function lowerExprInner(lowerer: Lowerer, expr: ts.Expression): IrExpr {
`a builtin function alias as an escaping value (call '${expr.text}' directly)`,
);
}
// `const C = zlib.Gzip` owns no runtime slot: construction,
// `const E = EventEmitter` owns no runtime slot: construction,
// instanceof, typeof and .name lower at their use sites.
if (sym && zlibClassAliasOf(lowerer, sym) !== null) {
if (sym && builtinClassAliasOwnsNoSlot(lowerer, sym)) {
lowerer.unsupported(
"SC1090",
expr,
`a zlib class alias as an escaping value (use '${expr.text}' with new, instanceof, typeof or .name)`,
`a builtin class alias as an escaping value (use '${expr.text}' with new, instanceof, typeof or .name)`,
);
}
}
@@ -1253,6 +1274,17 @@ function lowerExprInner(lowerer: Lowerer, expr: ts.Expression): IrExpr {
if (bi.module === "os" && bi.member === "constants") {
return { kind: "libCall", fn: "os.constants", args: [], type: DYN, loc };
}
// `import { O_RDONLY } from "constants"`: the member of the frozen
// module object.
if (bi.module === "constants") {
return {
kind: "dynKeyGet",
value: builtinConstantsObject(lowerer, loc),
key: { kind: "strLit", value: bi.member, type: STRING, loc },
type: DYN,
loc,
};
}
// tls.rootCertificates: a runtime-valued module constant (the
// cached bundled-CA array) — the one member read that lowers
// to a libCall instead of a baked literal.
@@ -1295,6 +1327,7 @@ function lowerExprInner(lowerer: Lowerer, expr: ts.Expression): IrExpr {
// their access sites only. The CommonJS namespace binding
// (`const lib = require("./lib.js")`) gets the same fence.
const builtinNamespace = lowerer.builtinNamespaceModuleOf(expr);
if (builtinNamespace === "constants") return builtinConstantsObject(lowerer, loc);
if (builtinNamespace !== null) {
const type: IrType = { kind: "moduleNs", moduleId: `builtin:${builtinNamespace}` };
return { kind: "moduleNsRef", moduleId: type.moduleId, type, loc };
@@ -1592,6 +1625,7 @@ function lowerExprInner(lowerer: Lowerer, expr: ts.Expression): IrExpr {
return { kind: "moduleNsRef", moduleId: moduleNs.moduleId, type: moduleNs, loc };
}
const builtinNs = lowerer.builtinNamespaceModuleOf(expr);
if (builtinNs === "constants") return builtinConstantsObject(lowerer, loc);
if (builtinNs !== null) {
const type: IrType = { kind: "moduleNs", moduleId: `builtin:${builtinNs}` };
return { kind: "moduleNsRef", moduleId: type.moduleId, type, loc };
@@ -1844,6 +1878,28 @@ function lowerExprInner(lowerer: Lowerer, expr: ts.Expression): IrExpr {
if (ts.isConditionalExpression(expr)) return lowerTernary(lowerer, expr);
if (ts.isPropertyAccessExpression(expr)) {
// `require("./x").member` over a program module's export table: the
// module's %init at this position, then the member read exactly like
// a `const m = require("./x")` binding's (cjs-inline-require.ts).
if (!expr.questionDotToken) {
const req = inlineNamespaceRequireOf(lowerer, expr.expression);
if (req !== null && !lowerer.inlineRequireInitDone.has(req.call)) {
return lowerWithInlineRequireInit(lowerer, req, () => lowerExpr(lowerer, expr));
}
// `module.exports` compared by identity inside its own module, or
// refused by name as any other value (cjs-exports-object.ts).
if (expr.name.text === "exports") {
const exportsValue = lowerCjsExportsObjectValue(lowerer, expr);
if (exportsValue) return exportsValue;
}
// tsc's `x_1.default` over a dependency whose whole export is one
// value: that value (cjs-tsc-interop.ts).
const interop = tscInteropDefaultValueOf(lowerer, expr);
if (interop !== null) {
const value = wholeExportValue(lowerer, interop.dep, expr);
if (value !== null) return value;
}
}
{
const member = lifetimeRegionMemberOf(lowerer.program, expr, lowerer.experimentalFiles);
if (member !== null)
@@ -1857,10 +1913,11 @@ function lowerExprInner(lowerer: Lowerer, expr: ts.Expression): IrExpr {
const table = lowerInternTableProperty(lowerer, expr);
if (table) return table;
}
// `zlib.Gzip.name`, `C.name` over a zlib class alias.
// `EventEmitter.name`, `zlib.Gzip.name`, `C.name` over a builtin
// class alias.
if (expr.name.text === "name" && !expr.questionDotToken) {
const mode = zlibClassModeOfExpr(lowerer, expr.expression);
if (mode !== null) return { kind: "strLit", value: zlibClassName(mode), type: STRING, loc };
const ref = builtinClassRefOf(lowerer, expr.expression);
if (ref !== null) return { kind: "strLit", value: ref.name, type: STRING, loc };
}
// Expando statics may still be absent even when JS inference sees
// the eventual assignment's scalar type. Preserve the checked value.
@@ -2189,35 +2246,12 @@ function lowerExprInner(lowerer: Lowerer, expr: ts.Expression): IrExpr {
// global (pure alias plumbing) and fall through unchanged; write
// positions belong to the export-assignment machinery.
{
const sf = expr.getSourceFile();
const cjsMemberRecv =
isModuleExportsAccess(expr.expression) ||
(ts.isIdentifier(expr.expression) &&
expr.expression.text === "exports" &&
!lowerer.resolveLocal(expr.expression) &&
!lowerer.globalOf(expr.expression));
const writePos =
ts.isBinaryExpression(expr.parent) &&
expr.parent.left === expr &&
expr.parent.operatorToken.kind === ts.SyntaxKind.EqualsToken;
if (
!expr.questionDotToken &&
cjsMemberRecv &&
!writePos &&
isCjsJsFile(sf, lowerer.program)
) {
const sym =
lowerer.checker.getSymbolAtLocation(expr.name) ??
lowerer.cjsModuleExportSymbol(sf, expr.name.text);
const resolved =
sym !== undefined && sym.flags & ts.SymbolFlags.Alias
? lowerer.checker.getAliasedSymbol(sym)
: sym;
const g =
(sym ? lowerer.globalsBySymbol.get(sym) : undefined) ??
(resolved ? lowerer.globalsBySymbol.get(resolved) : undefined);
if (g) return { kind: "varRef", localId: g.id, type: g.type, loc };
}
const g = cjsInFileExportGlobalOf(lowerer, expr);
if (g && !writePos) return { kind: "varRef", localId: g.id, type: g.type, loc };
}
// Namespace-qualified reads (`N.x`, `A.B.C.f`, import= alias
// chains): the member is a compile-time-known declaration of a
@@ -2859,6 +2893,23 @@ function lowerExprInner(lowerer: Lowerer, expr: ts.Expression): IrExpr {
);
}
}
// A member a JavaScript module attached to one of its functions
// (`status.message = codes; module.exports = status`), read from
// TypeScript: JavaScript stores such members on the function's own
// property table (`fn.member = v` writes through the function's
// checked-dynamic face), so the read takes the same path and enters
// the static code at the type inference gave the member.
if (recvLowered.type.kind === "func" && jsFunctionExpandoMember(lowerer, expr)) {
const read: IrExpr = {
kind: "dynKeyGet",
value: lowerer.coerceToExpected(recvLowered, DYN),
key: { kind: "strLit", value: expr.name.text, type: STRING, loc: locOf(expr.name) },
type: DYN,
loc,
};
const mapped = lowerer.mapTypeOf(lowerer.typeOf(expr));
return mapped && mapped.kind !== "void" ? lowerer.coerceInto(expr, read, mapped) : read;
}
lowerer.unsupported(
"SC1090",
expr,
@@ -10212,6 +10263,35 @@ export function lowerBinary(lowerer: Lowerer, expr: ts.BinaryExpression): IrExpr
// RHS value is the expression's value — its OWN type, so the
// consumer sees exactly what the checker typed.
if (ts.isPropertyAccessExpression(expr.left) && !expr.left.questionDotToken) {
// `const src = exports.src = []`: an export member assigned in
// value position writes its export global and yields the value.
{
let inFunction = false;
for (let p: ts.Node | undefined = expr.parent; p !== undefined; p = p.parent) {
if (ts.isFunctionLike(p) || ts.isClassDeclaration(p) || ts.isClassExpression(p)) {
inFunction = true;
break;
}
}
const g = inFunction
? cjsExportMemberWriteGlobalOf(lowerer, expr.left)
: cjsInFileExportGlobalOf(lowerer, expr.left);
if (g) {
const value = lowerer.lowerExprExpecting(expr.right, g.type);
const tmp = lowerer.declareHiddenLocal("%exportValue", value.type);
const result = varRef(tmp.id, value.type, loc);
return {
kind: "seqExpr",
stmts: [
{ kind: "varDecl", localId: tmp.id, init: value, loc },
{ kind: "assign", localId: g.id, value: result, loc },
],
result,
type: value.type,
loc,
};
}
}
const recv = tryLowerExpression(lowerer, expr.left.expression);
if (recv && recv.type.kind === "dyn") return lowerDynMemberAssignment(lowerer, expr, recv);
const unionWrite = lowerUnionFieldWrite(lowerer, expr.left, expr.right);
@@ -10327,17 +10407,18 @@ export function lowerBinary(lowerer: Lowerer, expr: ts.BinaryExpression): IrExpr
lowerUnionTypeofTest(lowerer, expr, loc);
if (test) return test;
}
// `C === zlib.Gzip` between two zlib class references: the classes
// are compile-time values, so the answer folds.
// `C === EventEmitter` between two builtin class references: the
// classes are compile-time values, so the answer folds.
if (
op === ts.SyntaxKind.EqualsEqualsEqualsToken ||
op === ts.SyntaxKind.ExclamationEqualsEqualsToken
) {
const leftClass = zlibClassModeOfExpr(lowerer, expr.left);
const rightClass = leftClass === null ? null : zlibClassModeOfExpr(lowerer, expr.right);
const leftClass = builtinClassRefOf(lowerer, expr.left);
const rightClass = leftClass === null ? null : builtinClassRefOf(lowerer, expr.right);
if (leftClass !== null && rightClass !== null) {
const negated = op === ts.SyntaxKind.ExclamationEqualsEqualsToken;
return { kind: "boolLit", value: (leftClass === rightClass) !== negated, type: BOOL, loc };
const same = sameBuiltinClass(leftClass, rightClass);
return { kind: "boolLit", value: same !== negated, type: BOOL, loc };
}
}
@@ -12413,11 +12494,11 @@ export function lowerInstanceOf(lowerer: Lowerer, expr: ts.BinaryExpression, loc
// h2 compat 'connect' narrowing (lower-server.ts): a union tag test.
const sockTest = lowerSocketInstanceOf(lowerer, expr, loc);
if (sockTest !== null) return sockTest;
const zlibMode = zlibClassModeOfExpr(lowerer, expr.right);
if (zlibMode !== null) return lowerZlibInstanceOf(lowerer, expr, zlibMode, loc);
const rightClass = builtinClassRefOf(lowerer, expr.right);
if (rightClass?.kind === "zlib") return lowerZlibInstanceOf(lowerer, expr, rightClass.mode, loc);
if (lowerer.isStdlibGlobal(expr.right, "Set") || lowerer.isStdlibGlobal(expr.right, "Map")) {
const collection = lowerer.isStdlibGlobal(expr.right, "Map") ? "map" : "set";
if (rightClass?.kind === "collection") {
const collection = rightClass.which === "Map" ? "map" : "set";
const value = lowerer.lowerExpr(expr.left);
if (value.type.kind === "union") {
const union = lowerer.unions.get(value.type.unionId);
@@ -15038,6 +15119,9 @@ export function fieldTarget(
access: ts.PropertyAccessExpression,
): FieldTarget | null {
if (lowerer.cjsLocalModuleBindingOf(access.expression)) return null;
// `module.exports` / `module.id`: CommonJS module surface, never a field.
if (isCjsModuleGlobal(lowerer, access.expression)) return null;
if (isCjsExportsIdentifier(lowerer, access.expression)) return null;
if (lowerer.chainBlocked(access)) return null;
if (
access.name.text === "stackTraceLimit" &&
@@ -16439,3 +16523,28 @@ export function primitiveConstructorOr(
}
return result;
}
/** True when `access` reads a member that JavaScript sources attach to a
* function by assignment (`fn.member = value`): the receiver's type is
* callable and every declaration of the member is such an assignment in a
* JS file. */
function jsFunctionExpandoMember(lowerer: Lowerer, access: ts.PropertyAccessExpression): boolean {
if (access.questionDotToken || !ts.isIdentifier(access.name)) return false;
const recvType = lowerer.typeOf(access.expression);
if (lowerer.checker.getCallSignatures(recvType).length === 0) return false;
const member = lowerer.checker.getPropertyOfType(recvType, access.name.text);
const decls = member ? lowerer.checker.declarationsOf(member) : [];
return (
decls.length > 0 &&
decls.every((d) => {
if (!isJsSourceFile(d.getSourceFile())) return false;
const assign = ts.isBinaryExpression(d) ? d : d.parent;
return (
assign !== undefined &&
ts.isBinaryExpression(assign) &&
assign.operatorToken.kind === ts.SyntaxKind.EqualsToken &&
ts.isPropertyAccessExpression(assign.left)
);
})
);
}
packages/compiler/src/frontend/lowering/lower-modules.ts
+87 -3
View File
@@ -18,7 +18,9 @@ import { isRelativeSpecifier } from "../workspace-registry.js";
import {
canonicalBuiltinModule,
cjsExportAssignmentOf,
cjsExportChainOf,
cjsExportDiscardReason,
cjsExportTargetLiteral,
entryPackageFilePredicate,
isCjsJsFile,
isJsSourceFile,
@@ -26,6 +28,7 @@ import {
locOf,
makeCycleAdmission,
orderedImportsOf,
requireSpecOf,
resolveImport,
resolveNpmImport,
} from "../program.js";
@@ -36,6 +39,13 @@ import {
withCycleInitFlags,
} from "./cycle-initialization.js";
import { markRequireEarlyBindings } from "./require-initialization.js";
import {
cjsTableMethodEntry,
inlineProgramRequireOf,
nestedCjsExportAssignmentsOf,
requireNestedPatternsOf,
} from "./cjs-inline-require.js";
import { isDeadTscHelperDecl, tscInteropBindingOfDecl } from "./cjs-tsc-interop.js";
import { collectJsonRequires, isJsonRequireDecl } from "./json-require.js";
import {
invalidJsonModuleDiag,
@@ -80,7 +90,7 @@ import {
createRequireProgramModuleDecl,
} from "./builtins/module-bindings.js";
import { isPromisifyCall, registerBuiltinCallableAlias } from "./builtins/callable-aliases.js";
import { registerZlibClassAlias } from "./builtins/compression.js";
import { registerBuiltinClassAlias } from "./builtins/class-values.js";
import { stripTypeCasts } from "./builtins/arguments.js";
import {
bindingContextualGenericFnNodeOf,
@@ -1391,6 +1401,11 @@ export function collectGlobals(
deferJsCollectionDiags(lowerer, sf, diagsBefore);
}
};
// Export members assigned in VALUE position at the module's top
// level (`const src = exports.src = []`) are exports too.
for (const nested of nestedCjsExportAssignmentsOf(stmt, cjs?.expr)) {
registerExport(nested.name, nested.name.text, nested.value);
}
if (cjs?.kind === "member" && ts.isIdentifier(cjs.name)) {
// `exports.C = C` naming a CLASS declaration: alias plumbing —
// no storage (a class VALUE global would fence for
@@ -1398,6 +1413,13 @@ export function collectGlobals(
// symbol (cjsMemberExportClassSymbol) and the class registry
// applies unchanged.
if (lowerer.cjsMemberExportClassSymbol(cjs.expr) !== null) continue;
// A chain `exports.a = exports.b = value`: every member is an
// export holding the chain's one value.
const chain = cjsExportChainOf(cjs.expr);
if (chain !== null) {
for (const nameNode of chain.names) registerExport(nameNode, nameNode.text, chain.value);
continue;
}
registerExport(cjs.name, cjs.name.text, cjs.value);
continue;
}
@@ -1429,7 +1451,22 @@ export function collectGlobals(
// statement lowering evaluates the call exactly once at its
// source position and assigns that slot. Unmappable calls retain
// the existing statement-level fence.
const factoryValued = ts.isCallExpression(rhs);
// Any other computed value (`os.homedir || function () {…}`,
// `cond ? a : b`, `new Registry()`, `ns.member`) is the same single
// snapshot: Node stores whatever the expression produced. A
// require() of a program module is not: the exporter re-exports
// that module's exports, which requirers resolve through the
// checker's alias (the statement lowers to the dep's %init).
const factoryValued =
!ts.isIdentifier(rhs) &&
!ts.isClassExpression(rhs) &&
!ts.isObjectLiteralExpression(rhs) &&
!(
requireSpecOf(rhs) !== null &&
inlineProgramRequireOf(lowerer, rhs) !== null &&
!sf.statements.some((s) => cjsExportAssignmentOf(s)?.kind === "member")
) &&
cjsExportTargetLiteral(rhs, sf) === null;
if (cjsScalarLiteral(rhs) || fnValued || factoryValued) {
const diagsBefore = lowerer.diags.length;
try {
@@ -1464,6 +1501,10 @@ export function collectGlobals(
if (ts.isPropertyAssignment(prop) && ts.isIdentifier(prop.name)) {
registerExport(prop.name, prop.name.text, prop.initializer);
}
// A METHOD entry (`module.exports = { f(x) { … } }`) is an
// expression-valued export whose value is the method's function.
const method = cjsTableMethodEntry(prop);
if (method !== null) registerExport(method.name, method.name.text, method.name);
// other property forms fence in the statement lowering
}
continue;
@@ -1527,6 +1568,16 @@ export function collectGlobals(
collectNestedVarGlobals(lowerer, sf, stmt, tag);
continue;
}
// tsc's interop bindings and its then-dead helper declarations own no
// storage either (cjs-tsc-interop.ts).
if (
isJsSourceFile(sf) &&
(isDeadTscHelperDecl(lowerer, stmt) ||
(stmt.declarationList.declarations.length === 1 &&
tscInteropBindingOfDecl(lowerer, stmt.declarationList.declarations[0]!) !== null))
) {
continue;
}
// CommonJS require declarations are alias plumbing (preflight owns
// the module edges; resolveValueSymbol routes reads through to the
// exporter's declarations): no storage, and the statement lowers to
@@ -1549,6 +1600,38 @@ export function collectGlobals(
stdlibGlobalAliasDecl(lowerer, decl.name, decl.initializer);
}
}
// `const { codes: { ERR_X } } = require("./errors")`: the outer
// keys stay alias plumbing, but a nested pattern destructures the
// export's value at the require, so its bindings own storage like
// any destructured declaration (lowerVarDeclarator assigns them).
if (ts.isVariableStatement(stmt)) {
const isLetList =
(stmt.declarationList.flags & ts.NodeFlags.Let) !== 0 ||
(stmt.declarationList.flags & ts.NodeFlags.BlockScoped) === 0;
for (const decl of stmt.declarationList.declarations) {
for (const element of requireNestedPatternsOf(decl)) {
for (const nameNode of boundIdentifiersOf(element.name!)) {
const symbol = lowerer.checker.getSymbolAtLocation(nameNode);
if (!symbol || lowerer.globalsBySymbol.has(symbol)) continue;
const mapped = lowerer.mapTypeOf(lowerer.typeOf(nameNode));
const type = mapped && mapped.kind !== "void" ? mapped : DYN;
const g: IrGlobal = {
id: `%g.${tag}${nameNode.text}`,
name: nameNode.text,
type,
mutable: isLetList,
source: bindingSource(nameNode),
...((type.kind === "func" || type.kind === "dyn") && !isVarDeclared(decl)
? { tdz: true as const }
: {}),
};
lowerer.globalsBySymbol.set(symbol, g);
lowerer.globalsList.push(g);
if (isVarDeclared(decl)) noteVarGlobalEntryInit(lowerer, sf, g);
}
}
}
}
continue;
}
// `declare const __VERSION__: string` — AMBIENT: no storage exists
@@ -1701,7 +1784,7 @@ export function collectGlobals(
// resolution and value reads reuse the source's interned closure.
if (isConst && registerOverloadedCallableAlias(lowerer, decl)) continue;
if (isConst && registerBuiltinCallableAlias(lowerer, decl.name, decl.initializer)) continue;
if (registerZlibClassAlias(lowerer, decl.name, decl.initializer)) continue;
if (registerBuiltinClassAlias(lowerer, decl.name, decl.initializer)) continue;
// `const f = (x) => ...` at file scope of an npm-static JS file
// whose params are implicit-any: the implicit-monomorphization
// twin of the generic binding above — no global exists; calls and
@@ -2664,6 +2747,7 @@ export function lowerFileInit(
loc: loc0,
});
}
if (sf === lowerer.entry) header.push(...lowerer.punycodeLinkWarning());
// Top-level `this` of a CommonJS module: its object exists before the
// module's first statement (lowerCjsTopLevelThis).
const exportsThis = lowerer.cjsExportsThis.get(sf);
packages/compiler/src/frontend/lowering/lower-node-module.ts
+18
View File
@@ -8,6 +8,7 @@ import * as win32 from "node:path/win32";
import * as ts from "../ts7/adapter.js";
import type { Lowerer } from "./lowerer.js";
import type { FileParts } from "./lower-modules.js";
import { lowerCjsExportsObjectValue } from "./cjs-exports-object.js";
import { isCjsJsFile, isNodeEsmFile, locOf } from "../program.js";
import { runtimePathForTarget } from "../runtime-resolve.js";
import {
@@ -177,6 +178,12 @@ export function cjsModuleRef(lowerer: Lowerer, node: ts.Node): IrExpr | null {
return id === undefined ? null : numLit(id, locOf(node));
}
/** True when `node` is the CommonJS `require` global (not shadowed by a
* source binding, and not in an ES module). */
export function isCjsRequireGlobal(lowerer: Lowerer, node: ts.Expression): boolean {
return cjsGlobal(lowerer, node, "require");
}
export function isCjsModuleGlobal(lowerer: Lowerer, node: ts.Expression): boolean {
return cjsGlobal(lowerer, node, "module");
}
@@ -428,6 +435,13 @@ export function lowerNodeModuleIdentifier(lowerer: Lowerer, expr: ts.Identifier)
if (!isCjsModuleGlobal(lowerer, expr)) return null;
const ref = cjsModuleRef(lowerer, expr);
if (ref) return ref;
if (isCjsJsFile(expr.getSourceFile(), lowerer.program)) {
lowerer.unsupported(
"SC1090",
expr,
"the CommonJS 'module' object in this position (module.exports members, the whole module.exports in comparisons, and the module metadata fields lower)",
);
}
lowerer.unsupported("SC1090", expr, "the CommonJS 'module' object in an ES module");
}
@@ -441,6 +455,10 @@ export function lowerNodeModuleProperty(
const member = expr.name.text;
if (member === "exports" && direct && moduleExportsAlwaysTruthy(lowerer, expr))
return boolLit(true, locOf(expr));
if (member === "exports" && direct) {
const value = lowerCjsExportsObjectValue(lowerer, expr);
if (value) return value;
}
if (member === "exports" || member === "require") return null;
let moduleRef = direct
? cjsModuleRef(lowerer, expr.expression)
packages/compiler/src/frontend/lowering/lower-stmts.ts
+211 -5
View File
@@ -15,6 +15,19 @@ import { requireInitFlagStmt } from "./require-initialization.js";
import { isJsonRequireDecl } from "./json-require.js";
import { bindingSource } from "../binding-source.js";
import type { Lowerer } from "./lowerer.js";
import {
cjsExportValueByName,
cjsNamespaceDestructureOf,
cjsTableMethodEntry,
inlineProgramRequireOf,
requireNestedPatternsOf,
} from "./cjs-inline-require.js";
import {
cjsExportMemberWriteGlobalOf,
isCjsExportsIdentifier,
isFreshExportsReset,
} from "./cjs-exports-object.js";
import { isDeadTscHelperDecl, tscInteropBindingOfDecl } from "./cjs-tsc-interop.js";
import {
arrayValueRead,
arrayValueStore,
@@ -60,6 +73,7 @@ import {
import { enforceLibBoundary, lowerSurplusCalls } from "./lib-boundary.js";
import {
cjsExportAssignmentOf,
cjsExportChainOf,
cjsExportDiscardReason,
cjsExportTargetLiteral,
isCjsJsFile,
@@ -107,6 +121,7 @@ import {
implicitLocalFnInfoOf,
implicitLocalFnNodeOf,
implicitMethodCallInfersReturn,
genericLocalClassBinding,
} from "./generic-functions.js";
import {
bindingNeverReassigned,
@@ -148,7 +163,7 @@ import {
} from "./builtins/module-bindings.js";
import { lowerNodeModuleCall } from "./builtins/module-resolution.js";
import { registerBuiltinCallableAlias } from "./builtins/callable-aliases.js";
import { registerZlibClassAlias } from "./builtins/compression.js";
import { builtinClassAliasOwnsNoSlot, registerBuiltinClassAlias } from "./builtins/class-values.js";
import { lowerEnumDeclaration } from "./lower-enums.js";
import {
abstractPropertyDeclOf,
@@ -673,6 +688,7 @@ export function lowerStmts(lowerer: Lowerer, stmts: readonly ts.Statement[]): Ir
if (sf !== undefined) lowerer.bumpFileStat(sf.fileName, "total");
}
const diagsBefore = lowerer.diags.length;
const sinkMark = lowerer.diagSinkMark();
try {
let lowered: IrStmt | IrStmt[] | null;
let appended = false;
@@ -757,6 +773,11 @@ export function lowerStmts(lowerer: Lowerer, stmts: readonly ts.Statement[]): Ir
},
});
if (fence) out.push(fence);
} else if (deferFences) {
// Inside a capture buffer the owner keeps the diagnostics, but
// the statement still must not vanish from a result it keeps.
const fence = lowerer.capturedRuntimeFence(sinkMark, stmt);
if (fence) out.push(fence);
}
}
}
@@ -848,6 +869,9 @@ export function predeclareForwardCapture(lowerer: Lowerer, symbol: ts.Symbol): b
if (!decl.initializer) return false;
const flags = ts.getCombinedNodeFlags(decl);
if ((flags & ts.NodeFlags.BlockScoped) === 0 || (flags & ts.NodeFlags.Using) !== 0) return false;
// `const E = EventEmitter` has no storage to box: uses resolve at
// compile time (builtinClassAliasOf).
if (builtinClassAliasOwnsNoSlot(lowerer, symbol)) return false;
// MODULE-scope bindings are pre-registered globals (collectGlobals):
// references resolve through globalOf after the local search fails, so
// a TDZ box here would SHADOW the global and never fill (the top-level
@@ -1548,6 +1572,16 @@ function lowerVarDeclarator(
const init = lowerer.requireInitStmt(target.spec, decl);
return init ? [init] : [];
}
// tsc's interop bindings (`const x_1 = __importDefault(require("./m"))`)
// are require bindings (cjs-tsc-interop.ts): the module's %init here.
if (ts.isSourceFile(stmt.parent)) {
const interop = tscInteropBindingOfDecl(lowerer, decl);
if (interop !== null) {
const init = lowerer.requireInitStmt(interop.spec, decl);
return init ? [init] : [];
}
if (isDeadTscHelperDecl(lowerer, stmt)) return [];
}
// CommonJS require declarations (JS files): at the module's top
// level the BINDINGS are alias plumbing (no storage;
// resolveValueSymbol routes the reads), but the require itself is
@@ -1568,7 +1602,21 @@ function lowerVarDeclarator(
if (lowerer.externalTypes.has(spec)) lowerer.externalHostFence(spec, decl, false);
if (ts.isSourceFile(stmt.parent)) {
const init = lowerer.requireInitStmt(spec, decl);
return init ? [init] : [];
const out: IrStmt[] = init ? [init] : [];
// Nested patterns destructure the named export's value right after
// the module evaluated (`const { codes: { ERR_X } } = require(...)`).
for (const element of requireNestedPatternsOf(decl)) {
const key = element.propertyName as ts.Identifier;
const value = lowerer.lowerExpr(key);
lowerer.lowerBindingPattern(
element.name as ts.ObjectBindingPattern,
() => lowerer.lowerExpr(key),
value.type,
isLet,
out,
);
}
return out;
}
// A nested BUILTIN require (`get inFreeBSDJail() { const { execSync }
// = require('child_process'); ... }` — test/common's lazy-getter
@@ -1578,7 +1626,9 @@ function lowerVarDeclarator(
// Relative requires keep the fence: their module-init-at-position
// semantics needs storage this model doesn't represent.
if (canonicalBuiltinModule(spec) !== null) {
return [];
return canonicalBuiltinModule(spec) === "punycode"
? [lowerer.punycodeRequireWarning(decl)]
: [];
}
lowerer.unsupported(
"SC1090",
@@ -1595,6 +1645,35 @@ function lowerVarDeclarator(
// `const { createSign } = crypto` over a builtin NAMESPACE binding:
// alias plumbing (builtinImportOf routes the reads) — no statement.
if (builtinNamespaceDestructureModuleOf(lowerer, decl) !== null) return [];
// `const { A, B } = ns` over a CommonJS module binding: each name
// snapshots the named export's value here (cjs-inline-require.ts).
{
const nsDestructure = cjsNamespaceDestructureOf(lowerer, decl);
if (nsDestructure !== null) {
const out: IrStmt[] = [];
for (const element of nsDestructure.elements) {
const target = lowerer.globalOf(element.name);
const value = cjsExportValueByName(lowerer, nsDestructure.dep, element.key, element.name);
if (target === null || value === null) {
lowerer.unsupported(
"SC1090",
element.name,
`destructuring the export '${element.key}' of a CommonJS module binding (it has no static value)`,
);
}
out.push({
kind: "assign",
localId: target.id,
value: typeEquals(value.type, target.type)
? value
: lowerer.coerceInto(element.name, value, target.type),
loc: locOf(element.name),
...("tdz" in target && target.tdz ? { initializes: true as const } : {}),
});
}
return out;
}
}
return lowerer.lowerDestructuringDecl(decl, isLet);
}
// STORED protocol values with statically closed representations:
@@ -4431,7 +4510,7 @@ export function lowerVarDecl(
// reads reuse its interned closure identity.
if (!isLet && registerOverloadedCallableAlias(lowerer, decl)) return null;
if (!isLet && registerBuiltinCallableAlias(lowerer, decl.name, decl.initializer)) return null;
if (registerZlibClassAlias(lowerer, decl.name, decl.initializer)) return null;
if (registerBuiltinClassAlias(lowerer, decl.name, decl.initializer)) return null;
// `const knownBy = (cmd) => ...` — an IMPLICIT-ANY function-value
// binding in npm-static JS (function-scope bindings register here, in
@@ -4910,6 +4989,9 @@ export function lowerVarDecl(
) {
type = init.type;
}
// `const B = factory(1)` inside a generic instance: the factory's local
// class for the instance the call names.
if (!type && !isLet) type = genericLocalClassBinding(lowerer, decl.name);
if (!type) {
// The JS declaration fallback (irTypeOf's story): the binding holds
// the checked-dynamic kind when even the initializer's type has no
@@ -6051,6 +6133,49 @@ function lowerCjsExportStatement(
if (whole?.kind !== "table" || cjsExportDiscardReason(stmt) !== null) continue;
root = lowerer.globalsByDeclNode.get(whole.expr);
}
// A CHAIN `exports.a = exports.b = value`: Node evaluates the value
// once, assigns the innermost member first, and every member holds
// the same value. Each member is its own export global
// (collectGlobals registers the inner ones too).
{
const chain = cjsExportChainOf(cjs.expr);
if (chain !== null && root?.type.kind !== "dyn") {
const globalOfName = (nameNode: ts.Identifier): IrGlobal => {
const symbol =
lowerer.checker.getSymbolAtLocation(nameNode) ??
lowerer.cjsModuleExportSymbol(sf, nameNode.text);
const g = symbol ? lowerer.globalsBySymbol.get(symbol) : undefined;
if (!g) {
lowerer.lowerExpr(chain.value);
lowerer.badType(chain.value, lowerer.typeOf(chain.value));
}
return g;
};
const inner = chain.names[chain.names.length - 1]!;
const innerG = globalOfName(inner);
const body: IrStmt[] = [
{
kind: "assign",
localId: innerG.id,
value: lowerer.lowerExprExpecting(chain.value, innerG.type),
loc: locOf(chain.value),
},
];
for (let i = chain.names.length - 2; i >= 0; i--) {
const g = globalOfName(chain.names[i]!);
const read: IrExpr = { kind: "varRef", localId: innerG.id, type: innerG.type, loc };
body.push({
kind: "assign",
localId: g.id,
value: typeEquals(g.type, innerG.type)
? read
: lowerer.coerceInto(chain.value, read, g.type),
loc,
});
}
return { kind: "block", body, loc };
}
}
return assignExport(cjs.name, cjs.value, root);
}
let tableObj = cjs.obj;
@@ -6116,6 +6241,30 @@ function lowerCjsExportStatement(
body.push(assignExport(prop.name, prop.initializer));
continue;
}
// METHOD entries: the export global holds the method's function,
// created at this statement like a function-expression entry. Node
// calls it with `this` bound to the table, which the static export
// table cannot represent, so a body that uses `this` keeps a fence.
{
const method = cjsTableMethodEntry(prop);
if (method !== null && !resolvedTarget) {
lowerer.rejectThisInObjectMethod(method.body);
const symbol =
lowerer.checker.getSymbolAtLocation(method.name) ??
lowerer.cjsModuleExportSymbol(cjs.expr.getSourceFile(), method.name.text);
const g = symbol ? lowerer.globalsBySymbol.get(symbol) : undefined;
if (g) {
const fn = lowerer.lowerLambda(method);
body.push({
kind: "assign",
localId: g.id,
value: typeEquals(fn.type, g.type) ? fn : lowerer.coerceInto(method, fn, g.type),
loc: locOf(method),
});
continue;
}
}
}
// ACCESSOR entries: no storage and no code here — reads lift the
// getter as a module-level function and call it per read
// (cjsExportAccessorRead); writes through the setter keep their
@@ -6131,7 +6280,15 @@ function lowerCjsExportStatement(
if (ts.isSpreadAssignment(prop)) {
let inner: ts.Expression = prop.expression;
while (ts.isParenthesizedExpression(inner)) inner = inner.expression;
if (requireSpecOf(inner) !== null) continue;
if (requireSpecOf(inner) !== null) {
// The spread still EVALUATES the module, at its place among the
// table's entries (a program module joins the graph through this
// inline require; cjs-inline-require.ts).
const req = inlineProgramRequireOf(lowerer, inner);
const init = req !== null ? lowerer.requireInitStmt(req.spec, req.call) : null;
if (init !== null && !resolvedTarget) body.push(init);
continue;
}
}
lowerer.unsupported(
"SC1090",
@@ -6164,6 +6321,16 @@ function lowerCjsSingleValueExport(
): IrStmt | null {
let rhs: ts.Expression = expr.right;
while (ts.isParenthesizedExpression(rhs)) rhs = rhs.expression;
// `module.exports = require("./x")`: the module re-exports x's exports.
// Requirers resolve through the checker's alias to x's own export
// machinery; this statement is x's evaluation at this position.
{
const req = inlineProgramRequireOf(lowerer, rhs);
// With later member exports (`module.exports.extra = …`) the module
// extends that object, so it keeps the factory root registration.
if (req !== null && !lowerer.globalsByDeclNode.has(expr))
return lowerer.requireInitStmt(req.spec, req.call) ?? { kind: "block", body: [], loc };
}
if (ts.isIdentifier(rhs)) {
const sym = lowerer.resolveValueSymbol(rhs);
if (!sym) return null;
@@ -6174,6 +6341,17 @@ function lowerCjsSingleValueExport(
) {
return { kind: "block", body: [], loc };
}
// A require binding (`const x = require("./x"); module.exports = x`)
// re-exports that module exactly like the inline form (the binding's
// own statement already evaluated it), and a builtin global
// (`module.exports = TypeError`) is the global itself: requirer
// bindings alias straight through to it, so nothing is stored.
if (
lowerer.checker.declarationsOf(sym).some((d) => ts.isSourceFile(d)) ||
lowerer.isStdlibSymbol(sym)
) {
return { kind: "block", body: [], loc };
}
const g = lowerer.globalsBySymbol.get(sym);
if (g) {
if (g.mutable) {
@@ -6395,6 +6573,21 @@ export function lowerExprStatement(lowerer: Lowerer, expr: ts.Expression): IrStm
);
}
if (topLevelJs && ts.isExpressionStatement(stmtNode)) {
if (isFreshExportsReset(lowerer, stmtNode))
return { kind: "block", body: [], loc: locOf(expr) };
// Any other `exports = …` rebinds the wrapper's exports binding: the
// members later attached through it belong to the new value.
if (
ts.isBinaryExpression(expr) &&
expr.operatorToken.kind === ts.SyntaxKind.EqualsToken &&
isCjsExportsIdentifier(lowerer, expr.left)
) {
lowerer.unsupported(
"SC1090",
expr.left,
"rebinding 'exports' (exports = module.exports = value): members attached through 'exports' afterwards are properties of that value, which the static export table does not model — write module.exports.<name> = … and module.exports = value",
);
}
const cjs = cjsExportAssignmentOf(stmtNode);
if (cjs) return lowerCjsExportStatement(lowerer, cjs);
// The tsc CJS interop stamp — `Object.defineProperty(exports,
@@ -6936,6 +7129,19 @@ export function lowerExprStatement(lowerer: Lowerer, expr: ts.Expression): IrStm
const parts = lowerDestructuringAssignParts(lowerer, expr.left, expr.right, locOf(expr));
return { kind: "block", body: parts.stmts, loc: locOf(expr) };
}
// `exports.x = v` inside a function updates the member's export
// global (cjs-exports-object.ts).
if (ts.isPropertyAccessExpression(expr.left)) {
const g = cjsExportMemberWriteGlobalOf(lowerer, expr.left);
if (g) {
return {
kind: "assign",
localId: g.id,
value: lowerer.lowerExprExpecting(expr.right, g.type),
loc: locOf(expr),
};
}
}
if (!ts.isIdentifier(expr.left)) {
lowerer.unsupported("SC1090", expr.left, "assignment to non-variables");
}
packages/compiler/src/frontend/lowering/lowerer.ts
+329 -63
View File
@@ -111,6 +111,13 @@ import { ClassDynamicDispatch, trackClassFieldCreation } from "./class-dynamic-d
import { ClassProtocols } from "./class-protocols.js";
import { earlyReadVarSymbols } from "./var-hoisting.js";
import { recordTextCodecClass } from "../../ir/ir.js";
import { assignLegacyTiers, type DynamicFunction } from "../../ir/tiers.js";
import {
analyzeTiers,
dynamicStatementCount,
type TierMode,
type TierReport,
} from "../tier-analysis.js";
import { DeferredModuleInitializers } from "./deferred-module-initializers.js";
import { finalizeClassMethodValues } from "./class-method-values.js";
import type { ClassSymbolKey } from "./symbol-fields.js";
@@ -135,6 +142,7 @@ import { resolve } from "node:path";
import { bindingSource } from "../binding-source.js";
import { tsgoPath } from "../dts-paths.js";
import * as ts from "../ts7/adapter.js";
import { erasedTypeOnlyImport } from "../type-only-imports.js";
import { literalValues } from "../literal-values.js";
import { discriminantOwners, literalUnionArm, type UnionLiteral } from "../union-discriminants.js";
import type { ScrDiagnostic } from "../../diagnostics/diagnostic.js";
@@ -223,9 +231,11 @@ import {
containsUnion,
describeComponentBlocker,
describeRecordMemberBlocker,
erasedOverloadMemberType,
formatIrType,
FETCH_AMBIENT_TYPES,
isOsConstantsSymbol,
isOverloadedCallableMemberType,
isUnitOnlyTsType,
isWorkerHandleType,
jsOpenObjectType,
@@ -254,6 +264,7 @@ import {
stdlibGlobalMember,
nodeTypesOnlySymbol,
} from "./surfaces.js";
import { type BuiltinClassRef, builtinClassAliasOf } from "./builtins/class-values.js";
import {
type FileParts,
splitFiles,
@@ -272,6 +283,13 @@ import {
appendWorkerModules,
} from "./lower-modules.js";
import { prepareCjsModuleGraph, usesCjsTopLevelThis } from "./lower-node-module.js";
import {
cjsNamespaceModule,
inlineNamespaceRequireOf,
inlineProgramRequireOf,
} from "./cjs-inline-require.js";
import { tscInteropModuleOf } from "./cjs-tsc-interop.js";
import { usesCjsExportsIdentity } from "./cjs-exports-object.js";
import { registerBuiltinEventTargetClasses } from "./lower-event-target.js";
import {
type ClassInfo,
@@ -358,6 +376,7 @@ import {
lowerGenericFnValue,
inferTypeParamBindings,
lowerGenericInstance,
genericLocalClassBinding,
} from "./generic-functions.js";
import { bindingNeverReassigned } from "./binding-analysis.js";
import type { InstantiationPath } from "./instantiation-path.js";
@@ -631,6 +650,9 @@ export interface LowerStats {
/** Functions whose signature couldn't be analyzed (bodies not counted). */
functionsSkipped: number;
/** Coverage only: reached statements that compile into dynamic-tier
* functions (tier-analysis.ts), a subset of the compiled statements. */
statementsDynamic?: number;
}
/** Every identifier a binding name binds: the identifier itself, or all
@@ -705,6 +727,11 @@ export interface LowerResult {
/** Compile-time-detectable behavior differences from Node (SC6xxx
* divergence warnings) in the program's own modules. Never failures. */
divergences?: ScrDiagnostic[];
/** Functions lowering placed in the dynamic tier (ir/tiers.ts), present
* when there are any. */
dynamicFunctions?: DynamicFunction[];
/** LowerOptions.tierReport: the report-only tier assignment. */
tiers?: TierReport;
}
export interface LowerOptions {
@@ -729,6 +756,8 @@ export interface LowerOptions {
* resolution walk and named-import link checks): the program
* compiles to that startup crash. */
startupCrash?: StartupCrash | null;
/** LoadResult.inlineRequireCycleCalls. */
inlineRequireCycleCalls?: ReadonlySet<ts.Node> | undefined;
/** LIBRARY mode's reachability roots: the profile-mapped exports of the
* entry module. Executable builds root at the entry's top level alone
* (an unreferenced export dead-strips); a library's exports are called from
@@ -754,6 +783,12 @@ export interface LowerOptions {
/** The mapped entries plus relative declaration dependencies, attributed
* to their owning external specifier. */
externalTypeSpecifiersByFile?: ReadonlyMap<string, readonly string[]>;
/** `--tier` (tier-analysis.ts); "auto" when absent. */
tierMode?: TierMode;
/** Coverage only: compute the tier-assignment report (`--explain-dynamic`).
* `preflight` holds the import and package refusals coverage reports
* beside the lowering's own blockers; they request module demotions. */
tierReport?: { preflight: readonly ScrDiagnostic[] };
}
interface RuntimeFenceFallback {
@@ -815,6 +850,8 @@ export interface LowererMode {
* module init — Node refuses the whole graph before anything evaluates,
* so nothing runs. */
startupCrash?: StartupCrash | null;
/** LoadResult.inlineRequireCycleCalls. */
inlineRequireCycleCalls?: ReadonlySet<ts.Node> | undefined;
/** The build's outbound native FFI declarations. */
ffiImports?: readonly IrFfiImport[];
/** LowerOptions.libraryCallbacks (see there). */
@@ -829,6 +866,8 @@ export interface LowererMode {
externalTypes?: ReadonlyMap<string, string>;
/** LowerOptions.externalTypeSpecifiersByFile, shared by every pass. */
externalTypeSpecifiersByFile?: ReadonlyMap<string, readonly string[]>;
/** LowerOptions.tierMode, shared by every pass. */
tierMode?: TierMode;
}
function directExternalTypeSpecifiersByFile(
@@ -920,17 +959,20 @@ export function lowerToIr(
const externalTypes = options.externalTypes ?? new Map<string, string>();
const externalTypeSpecifiersByFile =
options.externalTypeSpecifiersByFile ?? directExternalTypeSpecifiersByFile(externalTypes);
const tierMode = options.tierMode ?? "auto";
const validation = new Lowerer(program, entry, moduleOrder, {
frontendServices: options.frontendServices,
projectCheckJs: options.projectCheckJs ?? false,
targetPlatform,
startupCrash,
inlineRequireCycleCalls: options.inlineRequireCycleCalls,
ffiImports,
libraryCallbacks,
forkTargets,
workerTargets,
externalTypes,
externalTypeSpecifiersByFile,
tierMode,
});
const ffiValidation = validateFfiImports(validation);
timing("ffi-validate");
@@ -947,12 +989,14 @@ export function lowerToIr(
projectCheckJs: options.projectCheckJs ?? false,
targetPlatform,
startupCrash,
inlineRequireCycleCalls: options.inlineRequireCycleCalls,
ffiImports,
libraryCallbacks,
forkTargets,
workerTargets,
externalTypes,
externalTypeSpecifiersByFile,
tierMode,
ffiBindingSymbols: ffiValidation.symbolsByName,
});
for (const d of extraModuleCycleDiags) reachableEmit.pushDiag(d);
@@ -976,6 +1020,7 @@ export function lowerToIr(
reachable,
targetPlatform,
startupCrash,
inlineRequireCycleCalls: options.inlineRequireCycleCalls,
ffiImports,
libraryCallbacks,
forkTargets,
@@ -983,6 +1028,7 @@ export function lowerToIr(
ffiBindingSymbols: ffiValidation.symbolsByName,
externalTypes,
externalTypeSpecifiersByFile,
tierMode,
});
for (const d of extraModuleCycleDiags) emit.pushDiag(d);
for (const d of ffiValidation.diagnostics) emit.pushDiag(d);
@@ -1033,6 +1079,7 @@ export function lowerToIr(
reachable,
remainder: true,
alreadyFlushed: resultLowerer.flushedSymbols,
inlineRequireCycleCalls: options.inlineRequireCycleCalls,
targetPlatform,
ffiImports,
libraryCallbacks,
@@ -1041,19 +1088,44 @@ export function lowerToIr(
ffiBindingSymbols: ffiValidation.symbolsByName,
externalTypes,
externalTypeSpecifiersByFile,
tierMode,
});
const rem = remainder.run();
timing("coverage-remainder");
// Tiers (tier-analysis.ts): reached statements in dynamic-tier functions,
// and with tierReport the report-only demotion analysis.
const dynamicFunctions = resultLowerer.dynamicBodies;
const tiers =
options.tierReport === undefined
? undefined
: analyzeTiers(program, {
mode: tierMode,
dynamicFunctions,
reached: [...options.tierReport.preflight, ...result.diagnostics],
deferred: result.runtimeFences,
unreached: [...rem.diagnostics, ...rem.runtimeFences],
});
// A dynamic function's own statements can include ones that failed.
const statementsDynamic = Math.min(
tiers?.statementsDynamic ?? dynamicStatementCount(program, dynamicFunctions),
result.stats.statementsTotal - result.stats.statementsFailed,
);
if (tiers !== undefined) tiers.statementsDynamic = statementsDynamic;
timing("tier-analysis", { dynamic: dynamicFunctions.length });
// Unreached JS statements whose fences deferred to runtime count as
// failed statements in the remainder's stats, so their diagnostics must
// travel with them: a failed statement is never left unexplained.
return {
const covered: LowerResult = {
...result,
stats: { ...result.stats, statementsDynamic },
unreached: {
diagnostics: rem.diagnostics,
stats: rem.stats,
...(rem.runtimeFences.length > 0 ? { runtimeFences: rem.runtimeFences } : {}),
},
};
if (tiers !== undefined) covered.tiers = tiers;
return covered;
}
/** The native namespace type produced by a literal static import() of a
@@ -1567,6 +1639,15 @@ export class Lowerer {
readonly checker: ts.TypeChecker;
readonly diags: ScrDiagnostic[] = [];
readonly fnSigsBySymbol = new Map<ts.Symbol, FnSig>();
/** Per file: whether it assigns `exports` and `module.exports`
* (cjs-exports-object.ts). */
readonly cjsExportsAssignments = new Map<
ts.SourceFile,
{ exports: boolean; moduleExports: boolean }
>();
/** Inline require() calls whose module edge closes a require cycle
* (LoadResult.inlineRequireCycleCalls). */
readonly inlineRequireCycleCalls: ReadonlySet<ts.Node>;
/** Immutable callable aliases and compiler-generated adapters. The map
* is symbol-keyed, so shadowing and cross-module imports keep the same
* exact binding discipline as globals/functions. */
@@ -1793,6 +1874,9 @@ export class Lowerer {
* and erased instances). */
erasingDepth = 0;
localClassInstantiations: { owner: ts.FunctionLikeDeclaration; name: string }[] = [];
/** Instance types (by checker type id) of the local classes generic
* factory calls return, and the per-instance class each names. */
readonly localClassInstanceTypes = new Map<number, string>();
/** The ts-level twin of typeParamBindings, non-null while a CALL-keyed
* instance body lowers: type-parameter symbol → the bound CHECKER type,
* consulted where the mapped IrType has already widened away information
@@ -1806,11 +1890,11 @@ export class Lowerer {
* typeParamBindings — the checker has no `T` to substitute, so the
* binding rides the node-type accessor instead of mapType. */
implicitParamTypes: Map<ts.Symbol, ts.Type> | null = null;
/** Immutable bindings that name a zlib stream class (`const C =
* zlib.Gzip`), keyed by the binding's symbol: the class's
* node_zlib_mode. No runtime slot exists: new, typeof, .name and ===
* resolve at compile time, and instanceof checks the stream's mode. */
readonly zlibClassAliases = new Map<ts.Symbol, number>();
/** The builtin class each binding names (`const E = EventEmitter`,
* `const C = zlib.Gzip`), keyed by the binding's symbol; null for
* bindings that name none (builtinClassAliasOf). new, instanceof,
* typeof, .name and === resolve at compile time. */
readonly builtinClassAliases = new Map<ts.Symbol, BuiltinClassRef | null>();
/** Whether some net.Socket in this program may get an encoding: a
* setEncoding call whose receiver is a socket or an untyped value.
* Computed once on first use (null until then). */
@@ -1863,6 +1947,9 @@ export class Lowerer {
/** Per CommonJS file using top-level `this`: the global holding the
* object that stands for its original exports (lowerCjsTopLevelThis). */
readonly cjsExportsThis = new Map<ts.SourceFile, IrGlobal>();
/** Inline program-module require calls whose %init the enclosing member
* read or member call is already sequencing (cjs-inline-require.ts). */
readonly inlineRequireInitDone = new Set<ts.CallExpression>();
/** Bindings whose unchecked string arithmetic can produce either a number
* (NaN for an absent read) or a string. Preserve that result union at bare
* reads instead of applying the checker-bare string narrowing adapter. */
@@ -2019,6 +2106,42 @@ export class Lowerer {
};
}
/** True when `node`'s lowered value can hold a hidden `undefined` the
* checker type does not admit: an unchecked element or member read, a call
* whose lowered return admits undefined, or a binding whose storage the
* optional-read analysis marked. Whether the value actually carries the
* undefined arm is only known once it is lowered
* (runtimeOptionalSourceValue); this is the syntactic precondition. */
isRuntimeOptionalOrigin(node: ts.Expression): boolean {
let origin: ts.Expression = node;
while (ts.isParenthesizedExpression(origin)) origin = origin.expression;
if (ts.isElementAccessExpression(origin) || ts.isPropertyAccessExpression(origin)) return true;
if (ts.isCallExpression(origin)) {
const name = ts.isPropertyAccessExpression(origin.expression)
? origin.expression.name
: origin.expression;
const symbol = ts.isIdentifier(name) ? this.resolveValueSymbol(name) : undefined;
const signature = symbol ? this.fnSigsBySymbol.get(symbol) : undefined;
return (
this.runtimeOptionalFunctionReturns.has(origin) ||
(signature?.returnType.kind === "union" &&
this.armTag(signature.returnType.unionId, UNDEFINED_T) >= 0)
);
}
if (ts.isIdentifier(origin)) {
const local = this.resolveLocal(origin);
const root = local ? this.runtimeOptionalRootOf(local) : null;
const global = this.globalOf(origin);
return (
(!!root && this.runtimeOptionalStorageLocals.has(root)) ||
(!!global &&
(this.isRuntimeOptionalGlobal(global) ||
(global.type.kind === "union" && this.armTag(global.type.unionId, UNDEFINED_T) >= 0)))
);
}
return false;
}
/** Recover the original optional union when a checked single-arm helper
* was installed before a strict property consumer could name its member.
* Recovery covers member reads and storage roots marked by the
@@ -2027,32 +2150,7 @@ export class Lowerer {
runtimeOptionalSourceValue(node: ts.Expression, value: IrExpr): IrExpr | null {
const slot = this.deferredFieldSlot(value);
if (slot) return slot;
let origin: ts.Expression = node;
while (ts.isParenthesizedExpression(origin)) origin = origin.expression;
let optionalOrigin =
ts.isElementAccessExpression(origin) || ts.isPropertyAccessExpression(origin);
if (ts.isCallExpression(origin)) {
const name = ts.isPropertyAccessExpression(origin.expression)
? origin.expression.name
: origin.expression;
const symbol = ts.isIdentifier(name) ? this.resolveValueSymbol(name) : undefined;
const signature = symbol ? this.fnSigsBySymbol.get(symbol) : undefined;
optionalOrigin =
this.runtimeOptionalFunctionReturns.has(origin) ||
(signature?.returnType.kind === "union" &&
this.armTag(signature.returnType.unionId, UNDEFINED_T) >= 0);
}
if (ts.isIdentifier(origin)) {
const local = this.resolveLocal(origin);
const root = local ? this.runtimeOptionalRootOf(local) : null;
const global = this.globalOf(origin);
optionalOrigin =
(!!root && this.runtimeOptionalStorageLocals.has(root)) ||
(!!global &&
(this.isRuntimeOptionalGlobal(global) ||
(global.type.kind === "union" && this.armTag(global.type.unionId, UNDEFINED_T) >= 0)));
}
if (!optionalOrigin) return null;
if (!this.isRuntimeOptionalOrigin(node)) return null;
// A checked JavaScript indexed read can already be boxed. The checker
// calls the element present, but that inference is not a runtime guard.
@@ -2697,6 +2795,14 @@ export class Lowerer {
/** Coverage remainder mode: the reachability gate inverts (see wantBody)
* and no module is built. */
readonly remainder: boolean;
/** `--tier` (tier-analysis.ts). Stage S2 is report-only: both modes
* refuse and fence exactly as before. Stage S6 demotes the units of
* committed refusals in "auto" and keeps them refusals in "static-only". */
readonly tierMode: TierMode;
/** Functions finishModule placed in the dynamic tier (ir/tiers.ts). */
dynamicFunctions: DynamicFunction[] = [];
/** Their IR, for coverage's dynamic statement count. */
dynamicBodies: IrFunction[] = [];
/** Deferred collection diagnostics (failed signatures/class shapes) by
* declaration symbol: an unreached declaration must not fail the build,
* so its diagnostics wait until a reference makes them relevant. */
@@ -2783,9 +2889,11 @@ export class Lowerer {
this.frontendServices = mode.frontendServices;
this.reachable = mode.reachable ?? null;
this.remainder = mode.remainder ?? false;
this.tierMode = mode.tierMode ?? "auto";
this.alreadyFlushed = mode.alreadyFlushed ?? new Set();
this.targetPlatform = mode.targetPlatform ?? process.platform;
this.startupCrash = mode.startupCrash ?? null;
this.inlineRequireCycleCalls = mode.inlineRequireCycleCalls ?? new Set();
this.projectCheckJs = mode.projectCheckJs ?? false;
this.ffiImports = mode.ffiImports ?? [];
this.libraryCallbacks = mode.libraryCallbacks ?? false;
@@ -2817,7 +2925,11 @@ export class Lowerer {
this.mixinTypeContext && this.mixinTypeContext.classNode === decl
? { kind: "object", className: this.mixinTypeContext.className }
: null,
localClassInstance: (decl) => {
localClassInstance: (decl, instanceType) => {
// A generic factory's local class, by the instance type a call of
// the factory produced (localClassResultInstance).
const instanceClass = instanceType && this.localClassInstanceTypes.get(instanceType.id);
if (instanceClass) return { kind: "object", className: instanceClass };
// Computed heritage can close over parameters of its factory.
// A speculative checker query outside that factory must not lower
// the extends expression in the caller's lexical scope.
@@ -3012,6 +3124,10 @@ export class Lowerer {
return builtinStreamInfoOf(this, symbol);
}
builtinClassAliasOf(symbol: ts.Symbol): BuiltinClassRef | null {
return builtinClassAliasOf(this, symbol);
}
/** Program-wide qualified name for a top-level declaration. */
qualify(sf: ts.SourceFile, name: string): string {
return `${this.fileTag.get(sf) ?? ""}${name}`;
@@ -3093,8 +3209,10 @@ export class Lowerer {
ident.parent.name === ident
) {
const recv = ident.parent.expression;
if (ts.isIdentifier(recv) && this.cjsLocalModuleBindingOf(recv)) {
const dep = this.localModuleBindingDepOf(recv);
if (this.cjsLocalModuleBindingOf(recv)) {
const dep = ts.isIdentifier(recv)
? this.localModuleBindingDepOf(recv)
: this.cjsModuleRefDepOf(recv);
const exported = dep ? this.cjsModuleExportSymbol(dep, ident.text) : undefined;
// A createRequire call is typed as `any`, so tsgo can manufacture a
// transient property symbol with no relation to the target module.
@@ -3486,6 +3604,21 @@ export class Lowerer {
return dep;
}
/** The table module a non-identifier module reference names: an inline
* `require("./x")` (cjs-inline-require.ts) or tsc's unstamped
* `x_1.default` interop read (cjs-tsc-interop.ts). */
cjsModuleRefDepOf(expr: ts.Expression): ts.SourceFile | null {
const inline = inlineNamespaceRequireOf(this, expr);
if (inline !== null) return inline.dep;
const interop = tscInteropModuleOf(this, expr);
return interop !== null && cjsNamespaceModule(this, interop.dep) ? interop.dep : null;
}
/** The table module a CommonJS module binding identifier names. */
cjsModuleBindingDepOf(expr: ts.Identifier): ts.SourceFile | null {
return this.localModuleBindingDepOf(expr);
}
/** The compiled module behind a require-like namespace binding: an
* ordinary CommonJS require declaration, a canonical createRequire
* declaration, or an ESM default import of CommonJS. One resolver keeps
@@ -3498,6 +3631,10 @@ export class Lowerer {
if (ts.isImportClause(decl)) return this.cjsDefaultImportDepOf(decl);
if (!ts.isVariableDeclaration(decl) || !ts.isIdentifier(decl.name) || !decl.initializer)
return null;
{
const interop = tscInteropModuleOf(this, expr);
if (interop !== null) return cjsNamespaceModule(this, interop.dep) ? interop.dep : null;
}
const directSpec = requireSpecOf(decl.initializer);
if (directSpec !== null) {
if (isJsonRequireDecl(this, decl)) return null;
@@ -3544,6 +3681,10 @@ export class Lowerer {
if (wholeAssignment === undefined) return null;
let rhs: ts.Expression = wholeAssignment.right;
while (ts.isParenthesizedExpression(rhs)) rhs = rhs.expression;
// A pure re-export (`module.exports = require("./core")`) is the inner
// module's export table, read like any namespace binding.
if (inlineProgramRequireOf(this, rhs) !== null && !this.globalsByDeclNode.has(wholeAssignment))
return null;
if (ts.isIdentifier(rhs)) {
const value = this.checker.getSymbolAtLocation(rhs);
if (value) {
@@ -3596,7 +3737,9 @@ export class Lowerer {
* symbols → resolveValueSymbol); the bare value keeps the
* namespace-object fence, like ESM namespace imports of builtins. */
cjsLocalModuleBindingOf(expr: ts.Expression): boolean {
if (!ts.isIdentifier(expr)) return false;
// An inline `require("./x")` over a table module reads its members like
// a binding (cjs-inline-require.ts sequences the module's %init).
if (!ts.isIdentifier(expr)) return this.cjsModuleRefDepOf(expr) !== null;
const sym = this.checker.getSymbolAtLocation(expr);
if (this.localModuleBindingDepOf(expr) === null) return false;
if (this.createRequireWholeExportSymbolOf(expr) !== null) return false;
@@ -3609,6 +3752,8 @@ export class Lowerer {
// the object literal) keep the namespace reading — member accesses
// resolve through the table's property symbols.
if (sym && sym.flags & ts.SymbolFlags.Alias) {
// `module.exports = TypeError`: the binding IS the builtin global.
if (this.isStdlibSymbol(this.checker.getAliasedSymbol(sym))) return false;
const d = this.checker.declarationsOf(this.checker.getAliasedSymbol(sym))[0];
if (d && (ts.isClassDeclaration(d) || ts.isFunctionDeclaration(d))) return false;
if (d && ts.isVariableDeclaration(d)) {
@@ -3706,7 +3851,7 @@ export class Lowerer {
const id = `%g.${tag}%loaded`;
this.moduleGuardOf.set(fp.sf, id);
this.globalsList.push({ id, name: "%loaded", type: BOOL, mutable: true });
if (usesCjsTopLevelThis(this, fp.sf)) {
if (usesCjsTopLevelThis(this, fp.sf) || usesCjsExportsIdentity(this, fp.sf)) {
const exportsThis: IrGlobal = {
id: `%g.${tag}%exportsThis`,
name: "%exportsThis",
@@ -3835,6 +3980,65 @@ export class Lowerer {
for (const fp of parts) if (!indexOf.has(fp.sf)) visit(fp.sf);
}
/** node:punycode's load at a require() call: the module body reports
* DEP0040 when it first runs, unless isInsideNodeModules() finds the
* requiring frame in a dependency, and process.emitWarning delivers the
* report on the next tick. Later loads are cache hits either way. */
punycodeRequireWarning(node: ts.Node): IrStmt {
const loc = locOf(node);
const fromDependency = /[\\/]node_modules[\\/]/.test(node.getSourceFile().fileName);
return {
kind: "exprStmt",
expr: {
kind: "libCall",
fn: "punycode.warn",
args: [
{ kind: "boolLit", value: false, type: BOOL, loc },
{ kind: "boolLit", value: !fromDependency, type: BOOL, loc },
],
type: VOID,
loc,
},
loc,
};
}
/** node:punycode's DEP0040 for a static ES import anywhere in the module
* graph: Node links builtins before any module evaluates, so the report
* comes first, before the program can register a 'warning' listener —
* whichever file imports it (a dependency's ES import has no requiring
* frame either). Prepended to the entry's %init. */
punycodeLinkWarning(): IrStmt[] {
const imports = this.moduleOrder.some((sf) =>
sf.statements.some(
(stmt) =>
((ts.isImportDeclaration(stmt) && !erasedTypeOnlyImport(stmt)) ||
(ts.isExportDeclaration(stmt) && !stmt.isTypeOnly)) &&
stmt.moduleSpecifier !== undefined &&
ts.isStringLiteral(stmt.moduleSpecifier) &&
canonicalBuiltinModule(stmt.moduleSpecifier.text) === "punycode",
),
);
if (!imports) return [];
const loc: SrcLoc = { file: this.entry.fileName, start: 0, end: 0 };
return [
{
kind: "exprStmt",
expr: {
kind: "libCall",
fn: "punycode.warn",
args: [
{ kind: "boolLit", value: true, type: BOOL, loc },
{ kind: "boolLit", value: true, type: BOOL, loc },
],
type: VOID,
loc,
},
loc,
},
];
}
/** The lowering of a CommonJS `require("./local")` occurrence: a call of
* the required module's run-once %init at exactly this statement's
* position — Node's inline evaluation, with the guard supplying the
@@ -3844,6 +4048,7 @@ export class Lowerer {
* their external dependencies by name). Null for everything else
* (builtins load nothing; the rest kept its preflight fence). */
requireInitStmt(spec: string, node: ts.Node): IrStmt | null {
if (canonicalBuiltinModule(spec) === "punycode") return this.punycodeRequireWarning(node);
// Project requires resolve within the program; another bare require can
// be a program-module edge when it names an opted-in --npm-static package
// (one package requiring another — the resolution answered its shipped
@@ -6494,11 +6699,18 @@ export class Lowerer {
};
if (module) sanitizeUnregisteredClassTypes(module, (name) => this.classes.has(name));
if (module) checkCycleBindingAccesses(this, module);
// Execution tiers from the final bodies (ir/tiers.ts). Assigned with or
// without a module: coverage reports the dynamic tier of programs that
// still have blockers.
this.dynamicFunctions = assignLegacyTiers(functions);
if (this.dynamicFunctions.length > 0)
this.dynamicBodies = functions.filter((fn) => fn.tier === "dynamic");
return {
module,
diagnostics: this.diags,
runtimeFences: this.runtimeFences,
stats: this.stats,
...(this.dynamicFunctions.length > 0 ? { dynamicFunctions: this.dynamicFunctions } : {}),
...(this.statsByFile.size > 0 ? { statsByFile: this.statsByFile } : {}),
...(this.provenanceElided.length > 0 ? { provenanceElided: this.provenanceElided } : {}),
};
@@ -7126,23 +7338,8 @@ export class Lowerer {
}
this.runtimeFences.push(...captured);
const first = captured[0];
const fence = this.runtimeFenceStmt(captured[0], node, target.fallback, target.bareMessage);
const loc = locOf(node);
const code = first?.code ?? target.fallback!.code;
const baseMessage = first?.message ?? target.fallback!.message;
const messageLoc = first?.loc ?? loc;
const source = first
? (this.program.getSourceFile(messageLoc.file) ?? node.getSourceFile())
: node.getSourceFile();
const pos = ts.getLineAndCharacterOfPosition(source, messageLoc.start);
const fence: IrStmt = {
kind: "runtimeFence",
code,
message: target.bareMessage
? baseMessage
: `${baseMessage} [${code} at ${messageLoc.file}:${pos.line + 1}]`,
loc,
};
if (target.kind === "statement") return fence;
const params = target.params ?? [];
@@ -7170,6 +7367,54 @@ export class Lowerer {
return { kind: "closure", fnName: fn.name, captures: [], type: target.type, loc };
}
/** The runtimeFence statement that throws `first`'s message (or the
* fallback's) at `node`. */
private runtimeFenceStmt(
first: ScrDiagnostic | undefined,
node: ts.Node,
fallback: { code: string; message: string } | undefined,
bareMessage = false,
): IrStmt & { kind: "runtimeFence" } {
const loc = locOf(node);
const code = first?.code ?? fallback?.code ?? "SC1090";
const baseMessage =
first?.message ??
fallback?.message ??
"this statement uses a construct with no static lowering";
const messageLoc = first?.loc ?? loc;
const source = first
? (this.program.getSourceFile(messageLoc.file) ?? node.getSourceFile())
: node.getSourceFile();
const pos = ts.getLineAndCharacterOfPosition(source, messageLoc.start);
return {
kind: "runtimeFence",
code,
message: bareMessage
? baseMessage
: `${baseMessage} [${code} at ${messageLoc.file}:${pos.line + 1}]`,
loc,
};
}
/** The current length of the capture buffer (diagSink), or 0 without one:
* the mark capturedRuntimeFence reads the refusal from. */
diagSinkMark(): number {
return this.diagSink?.length ?? 0;
}
/** The runtimeFence for a JavaScript statement refused while a capture
* buffer (diagSink) is active. The buffer's owner decides whether its
* diagnostics report, and some owners keep the lowered result (a
* successful tryLowerExpression candidate, a computed class base whose
* diagnostics defer to the class). Without a fence the refused statement
* would vanish from that result; with one it throws the refusal when it
* runs, exactly like the fence lowerStmts emits outside a buffer. The
* diagnostics stay in the buffer for its owner. Null without a buffer. */
capturedRuntimeFence(sinkMark: number, node: ts.Node): IrStmt | null {
if (this.diagSink === null) return null;
return this.runtimeFenceStmt(this.diagSink[sinkMark], node, undefined);
}
/** All diagnostics land here; while a generic instance body is lowering,
* the instantiation context is appended so the user knows which concrete
* types made the (source-anchored) construct fail. */
@@ -7611,6 +7856,15 @@ export class Lowerer {
: mapped;
}
/** The runtime type of a record member slot typed `t`: an overloaded
* member's erased function (erasedOverloadMemberType — the type a record
* shape stores for it), otherwise mapTypeOf. */
memberSlotTypeOf(t: ts.Type): IrType | null {
if (isOverloadedCallableMemberType(t, this.checker))
return erasedOverloadMemberType(t, this.typeCtx) ?? null;
return this.mapTypeOf(t);
}
/** The one position where a contextual UNION must not be adopted over the
* expression's own: the LEFT operand of `&&`, `||`, or `??`. Adopting a
* contextual union is normally safe because tsc proved the value
@@ -7784,6 +8038,8 @@ export class Lowerer {
if (!mapped) {
const argumentsType = jsArgumentsFunctionType(this, t);
if (argumentsType !== null) return argumentsType;
const localClass = genericLocalClassBinding(this, node);
if (localClass !== null) return localClass;
// The checked-dynamic declaration fallback (dynFallbackType): a
// JAVASCRIPT binding of any inference residue, or a TypeScript
// binding of genuine checker-`any`, becomes the checked-dynamic
@@ -9804,27 +10060,21 @@ export class Lowerer {
* instance type. Collection and body lowering own a refusal of that
* class: the poison reaches the declaration or statement that asked, as
* before. A speculative whole-program analysis owns none, so there the
* class is unmappable for the query and its diagnostics are dropped;
* lowering the class's own declaration collects it again and reports
* them if the program reaches it. */
* refusal stays reported (the build fails with it, as it did where such
* an analysis already caught the poison) and the class is unmappable for
* the query instead of the poison escaping the compiler. */
collectLocalClassForType(decl: ts.ClassLikeDeclaration): boolean {
if (this.speculativeTypeQueryDepth === 0 || this.fnStack.length > 0) {
this.lowerClassExpressionInfo(decl);
return true;
}
const sink: ScrDiagnostic[] = [];
const previousSink = this.diagSink;
this.diagSink = sink;
try {
this.lowerClassExpressionInfo(decl);
return true;
} catch (e) {
if (e instanceof PoisonError) return false;
throw e;
} finally {
this.diagSink = previousSink;
}
for (const d of sink) this.pushDiag(d);
return true;
}
lowerClassExpression(expr: ts.ClassLikeDeclaration): IrExpr {
@@ -11631,7 +11881,23 @@ export class Lowerer {
return { module: "timers/promises", member: `scheduler.${access.name.text}` };
}
}
// punycode.ucs2.decode / encode: methods of the module's ucs2 object,
// dispatched as module members.
if (access.name.text === "decode" || access.name.text === "encode") {
const owner = access.expression;
const imported = ts.isIdentifier(owner)
? this.builtinImportOf(owner)
: ts.isPropertyAccessExpression(owner)
? this.builtinMemberOf(owner)
: null;
if (imported?.module === "punycode" && imported.member === "ucs2") {
return { module: "punycode", member: `ucs2.${access.name.text}` };
}
}
const module = this.builtinNamespaceModuleOf(access.expression);
// node:constants is one checked-dynamic object: its members read
// through the object itself (builtinConstantsObject), not the tables.
if (module === "constants") return null;
if (module !== null) return { module, member: access.name.text };
// The events module object IS the EventEmitter class, so the class's
// defaultMaxListeners is the module property.
packages/compiler/src/frontend/lowering/surfaces.ts
+22 -1
View File
@@ -1822,6 +1822,22 @@ export const BUILTIN_MODULE_FNS: Record<
valueParams: [{ mode: "required", type: STRING }],
},
},
// node:punycode (deprecated): punycode.js 2.1.0's conversions over
// strings (scr_url.c). ucs2.decode/encode are members of the module's
// ucs2 object, dispatched as module members (builtinMemberOf). The
// DEP0040 report rides the module's load sites (punycodeLoadWarning).
punycode: {
decode: { fn: "punycode.decode", params: [STRING], result: STRING },
encode: { fn: "punycode.encode", params: [STRING], result: STRING },
toASCII: { fn: "punycode.toASCII", params: [STRING], result: STRING },
toUnicode: { fn: "punycode.toUnicode", params: [STRING], result: STRING },
"ucs2.decode": { fn: "punycode.ucs2Decode", params: [STRING], result: arrayOf(F64) },
"ucs2.encode": { fn: "punycode.ucs2Encode", params: [arrayOf(F64)], result: STRING },
},
// node:constants (deprecated) is one frozen object (Object.assign of
// os.constants' groups, fs.constants and crypto.constants): bindings of
// the module read it as a checked-dynamic value (builtinConstantsObject).
constants: {},
// node:readline: createInterface's options are entirely special-cased
// (exactly { input: process.stdin, output?: process.stdout } — see
// lowerBuiltinModuleCall); the entry carries the canonical shape. The
@@ -1951,6 +1967,7 @@ export const BUILTIN_MODULE_CONSTS: Record<
os: { EOL: "\n", devNull: "/dev/null" },
worker_threads: { isMainThread: true, threadId: 0 },
cluster: { isPrimary: true, isMaster: true, isWorker: false },
punycode: { version: "2.1.0" },
// zlib's module-level copies of its constants (every member outside
// BROTLI_*, Node's own loop over zlib.constants).
zlib: Object.fromEntries(
@@ -3215,7 +3232,9 @@ export function isStdlibSymbol(lowerer: Lowerer, symbol: ts.Symbol | undefined):
* `global.process`) — `declare var` globals ARE properties of
* `typeof globalThis`, same symbol either way;
* - a local alias binding (`const process = globalThis.process`, the
* tamper-guard prologue) registered in stdlibGlobalAliases. */
* tamper-guard prologue) registered in stdlibGlobalAliases;
* - a const binding of the Map or Set constructor (`const M = Map`,
* builtinClassAliasOf). */
export function stdlibGlobalNameOf(lowerer: Lowerer, expr: ts.Expression): string | null {
if (ts.isParenthesizedExpression(expr)) return stdlibGlobalNameOf(lowerer, expr.expression);
if (ts.isIdentifier(expr)) {
@@ -3233,6 +3252,8 @@ export function stdlibGlobalNameOf(lowerer: Lowerer, expr: ts.Expression): strin
if (!symbol) return null;
const alias = lowerer.stdlibGlobalAliases.get(symbol);
if (alias !== undefined) return alias;
const classAlias = lowerer.builtinClassAliasOf(symbol);
if (classAlias?.kind === "collection") return classAlias.which;
const decl = lowerer.checker.declarationsOf(symbol)[0];
if (decl !== undefined && ts.isImportClause(decl) && decl.name !== undefined) {
const importDecl = decl.parent;
packages/compiler/src/frontend/npm-static-prune.ts
+6 -5
View File
@@ -10,6 +10,7 @@ import { nearestPackageType, resolveBareModule } from "./resolve.js";
import { npmStaticPackageOfPath } from "./npm-static.js";
import { trackedReadFile } from "./input-tracker.js";
import { npmPackageNameOf } from "./workspace-registry.js";
import { typeOnlyNamedImport } from "./type-only-imports.js";
export function isPrunedNpmReexport(program: ts.Program, stmt: ts.ExportDeclaration): boolean {
return program.analysis.prunedNpmReexports.has(stmt);
@@ -257,7 +258,9 @@ export function planNpmStaticReexports(
(clause.namedBindings !== undefined &&
(ts.isNamespaceImport(clause.namedBindings) ||
(ts.isNamedImports(clause.namedBindings) &&
clause.namedBindings.elements.length === 0)))
clause.namedBindings.elements.length === 0))) ||
// `import { type A }` still loads the module, like `import {}`.
typeOnlyNamedImport(stmt)
) {
request(dep, null);
} else {
@@ -269,12 +272,10 @@ export function planNpmStaticReexports(
}
}
} else if (ts.isExportDeclaration(stmt)) {
// `export { type A } from` still loads the module under Node's
// type stripping; only `export type … from` erases.
if (
stmt.isTypeOnly ||
(stmt.exportClause !== undefined &&
ts.isNamedExports(stmt.exportClause) &&
stmt.exportClause.elements.length > 0 &&
stmt.exportClause.elements.every((element) => element.isTypeOnly)) ||
stmt.moduleSpecifier === undefined ||
!ts.isStringLiteral(stmt.moduleSpecifier)
)
packages/compiler/src/frontend/npm-static.test.ts
+23 -1
View File
@@ -1,7 +1,7 @@
import { mkdtemp, rm } from "node:fs/promises";
import { join } from "node:path";
import { expect, test } from "vitest";
import { npmStaticIneligibleReason } from "./npm-static.js";
import { npmStaticIneligibleReason, npmStaticTransformPkgJson } from "./npm-static.js";
test("an unreadable runtime entry is an eligibility refusal", async () => {
const dir = await mkdtemp("/tmp/scriptc-npm-static-unreadable-");
@@ -14,3 +14,25 @@ test("an unreadable runtime entry is an eligibility refusal", async () => {
await rm(dir, { recursive: true, force: true });
}
});
test("a hoisted node condition leaves no types claim behind", () => {
// uuid 14: the node object carries its own "types" key. Left in place,
// tsgo maps the hidden declaration to its same-stem browser build.
const pkg: Record<string, unknown> = {
types: "./dist/index.d.ts",
exports: {
".": {
node: { types: "./dist/index.d.ts", default: "./dist-node/index.js" },
default: "./dist/index.js",
},
"./package.json": "./package.json",
},
};
npmStaticTransformPkgJson(pkg);
expect(pkg).toEqual({
exports: {
".": { default: "./dist-node/index.js" },
"./package.json": "./package.json",
},
});
});
packages/compiler/src/frontend/npm-static.ts
+30 -3
View File
@@ -157,8 +157,6 @@ export function npmStaticTransformPkgJson(pkg: Record<string, unknown>): void {
return;
}
const obj = v as Record<string, unknown>;
delete obj["types"];
delete obj["typings"];
// 0. The "node" condition HOISTS: Node's runtime resolution matches it
// (yaml's `{ types, node: "./dist/index.js", default: "./browser/
// index.js" }` runs the node dist; the browser dist is a DIFFERENT
@@ -187,6 +185,14 @@ export function npmStaticTransformPkgJson(pkg: Record<string, unknown>): void {
}
}
}
// 1. The types claims go AFTER the hoist: a node object's own
// "types" key (uuid's `node: { types: "./dist/index.d.ts", default:
// "./dist-node/index.js" }`) splices in with its siblings, and left
// in place tsgo follows it, maps the hidden declaration to its
// same-stem JS (dist/index.js, the browser build) and disagrees with
// this resolver's runtime answer.
delete obj["types"];
delete obj["typings"];
for (const value of Object.values(obj)) transform(value);
};
if (pkg["exports"] !== undefined) transform(pkg["exports"]);
@@ -208,6 +214,13 @@ function npmStaticTransformPkgJsonText(text: string): string {
}
if (doc === null || typeof doc !== "object" || Array.isArray(doc)) return text;
npmStaticTransformPkgJson(doc as Record<string, unknown>);
// tsgo deduplicates installs by package id (name + version): a second
// copy of the same name@version (express/node_modules/fresh beside
// send/node_modules/fresh) becomes a redirect to the first copy loaded,
// so its own path never joins the program. Node loads every installed
// copy as its own module, and resolve.ts answers each importer's own
// copy; without a version the checker keeps the copies apart too.
delete (doc as Record<string, unknown>)["version"];
return JSON.stringify(doc);
}
@@ -275,6 +288,20 @@ function packageIsUntyped(path: string): boolean {
return untyped;
}
/** An installed TypeScript source with no runtime JavaScript at its stem
* (tldts ships `index.ts` beside `main: "dist/cjs/index.js"`). Node never
* executes TypeScript under node_modules and resolve.ts answers only
* runtime JS for opted-in packages, yet tsgo's TypeScript-first lookup
* would take the package-root `index.ts` over `main`. A same-stem JS twin
* keeps the source visible: that pair is the shape npmStaticProgramDep
* accepts in the JavaScript's place. */
function isUnloadableInstalledTsSource(path: string): boolean {
if (!/\.(ts|tsx|mts|cts)$/.test(path) || isDeclarationFileName(path)) return false;
if (!isNodeModulesPathNorm(path)) return false;
const stem = path.replace(/\.(ts|tsx|mts|cts)$/, "");
return ![".js", ".jsx", ".mjs", ".cjs"].some((ext) => trackedExists(stem + ext));
}
export interface NpmStaticFsShadow {
/** Shadowed CONTENT for a real path (the types-stripped package.json),
* or undefined (no shadow — fall through). */
@@ -383,7 +410,7 @@ export function npmStaticFsShadow(services: FrontendServices): NpmStaticFsShadow
const target = shadowTargetOf(path);
if (!target) return false;
if (target.viaTypes) return true; // the @types twin hides whole
return isDeclarationFileName(path);
return isDeclarationFileName(path) || isUnloadableInstalledTsSource(path);
},
};
}
packages/compiler/src/frontend/pipeline.ts
+139 -21
View File
@@ -25,11 +25,35 @@ import { isJsSourceFileName } from "./tsc-codes.js";
import { isRelativeSpecifier, packageNameOfSpecifier } from "./workspace-registry.js";
import { lowerToIr, type LowerOptions, type LowerResult } from "./lowering/lowerer.js";
import type { FrontendServices } from "./services.js";
import { isImportDeclaration, isExportDeclaration, isStringLiteral } from "./ts7/adapter.js";
import {
isIdentifier,
isImportDeclaration,
isExportDeclaration,
isStringLiteral,
isStringLiteralLike,
SyntaxKind,
} from "./ts7/adapter.js";
import { moduleSourceCandidates } from "./module-source-candidates.js";
import { CONTRACT_TYPES_MODULE } from "./contract-types.js";
import { THREADS_MODULE } from "./threads-import.js";
import { erasedTypeOnlyImport } from "./type-only-imports.js";
import { EXPERIMENTAL_MODULE } from "./experimental-import.js";
/** Where a package-anchored preflight diagnostic sits, as
* `<package path>:<line>` — the SC2013 refusal that drops the package
* reports only at the consumer's import, so its reason carries the inner
* location. */
function packageDiagWhere(load: LoadResult, loc: SrcLoc): string {
const file = loc.file.split("\\").join("/");
const at = file.lastIndexOf("/node_modules/");
const shown = at >= 0 ? file.slice(at + "/node_modules/".length) : file;
const text = load.program.getSourceFile(loc.file)?.text;
if (text === undefined) return shown;
let line = 1;
for (let i = 0; i < loc.start && i < text.length; i++) if (text.charCodeAt(i) === 10) line++;
return `${shown}:${line}`;
}
export interface ProgramLoadOptions {
npmStatic?: readonly string[];
externalTypes?: Readonly<Record<string, string>> | undefined;
@@ -91,15 +115,36 @@ function detectAutoPackages(
mode: "auto" | "lib" = "auto",
judged?: Set<string>,
sites?: Map<string, SrcLoc>,
transitive: Set<string> = new Set(),
): string[] {
const chosen: string[] = [];
// package → the resolved types file AND the file whose import found it:
// the runtime-JS probe below must resolve from the SAME importing file,
// or a package visible only to a nested package.json realm (a pnpm
// monorepo's packages/*/node_modules, unreachable from the entry's own
// walk-up) answers "no runtime JS" for perfectly ordinary installs.
const seen = new Map<string, { typesFile: string; fromFile: string; spec: string }>();
for (const sf of [...load.moduleOrder, load.entry]) {
const seen = new Map<
string,
{ typesFile: string; fromFile: string; spec: string; owner: string | null }
>();
// A transitive package's files outside the module order (reached through
// nested require() calls the graph walk does not model) still name its
// dependencies.
const scanned = new Set([...load.moduleOrder, load.entry]);
const transitiveFiles =
transitive.size === 0
? []
: load.program.getImplementationSourceFiles().filter((sf) => {
const pkg = npmStaticPackageOfPath(sf.fileName);
return !scanned.has(sf) && pkg !== null && transitive.has(pkg);
});
for (const sf of [...scanned, ...transitiveFiles]) {
if (mode === "auto" && sf.fileName.includes("/node_modules/")) continue;
// `--npm-static=pkg...` opts pkg's whole dependency closure in: every
// package its compiled files import is selected the same explicit way,
// without the declaration eligibility bar.
const owner = npmStaticPackageOfPath(sf.fileName);
const viaTransitive = owner !== null && transitive.has(owner);
const edges: { spec: string; loc: SrcLoc }[] = [];
for (const stmt of sf.statements) {
if (
@@ -107,13 +152,31 @@ function detectAutoPackages(
stmt.moduleSpecifier &&
isStringLiteral(stmt.moduleSpecifier)
) {
// `import type` and `export type … from` erase under Node's type
// stripping: Node never loads the package, so it is no dependency
// to compile (its declarations still type the program).
if (isImportDeclaration(stmt) ? erasedTypeOnlyImport(stmt) : stmt.isTypeOnly) continue;
edges.push({ spec: stmt.moduleSpecifier.text, loc: locOf(stmt) });
} else if (mode === "lib") {
} else if (mode === "lib" && !viaTransitive) {
// CJS packages spell their dep edges as top-level requires; the
// import-statement scan alone would miss every one of them.
for (const req of requiresOf(stmt)) edges.push({ spec: req.spec, loc: locOf(req.node) });
}
}
// Transitive selection counts every literal require() and import()
// anywhere in the package, nested ones included.
if (viaTransitive) {
for (const call of moduleSourceCandidates(load.program, sf).calls) {
const arg = call.arguments[0];
if (
arg !== undefined &&
isStringLiteralLike(arg) &&
(call.expression.kind === SyntaxKind.ImportKeyword ||
(isIdentifier(call.expression) && call.expression.text === "require"))
)
edges.push({ spec: arg.text, loc: locOf(call) });
}
}
for (const { spec, loc } of edges) {
if (load.externalTypes?.has(spec)) continue;
// scriptc's own packages are not npm dependencies: contract types are
@@ -137,28 +200,51 @@ function detectAutoPackages(
if (judged?.has(packageNameOfSpecifier(spec))) continue;
const npm = resolveNpmImport(sf.fileName, spec);
if (npm !== null && isNodeTypesPath(npm.typesFile)) continue;
if (npm === null) {
if (mode !== "lib") continue;
const js = resolveBareModule(sf.fileName, spec, "js-only");
if (js === null || judged!.has(js.packageName)) continue;
judged!.add(js.packageName);
sites!.set(js.packageName, loc);
// The runtime package Node loads. Types-first resolution answers an
// @types twin's declarations for a package that ships none, but
// selection and every refusal name the package that has the code.
const js =
mode === "lib" && (npm === null || npm.packageName.startsWith("@types/"))
? resolveBareModule(sf.fileName, spec, "js-only")
: null;
const runtimePkg = js !== null && js.packageName !== npm?.packageName ? js.packageName : null;
if (npm === null || runtimePkg !== null) {
if (mode !== "lib" || runtimePkg === null || judged!.has(runtimePkg)) continue;
judged!.add(runtimePkg);
sites!.set(runtimePkg, loc);
if (viaTransitive) {
transitive.add(runtimePkg);
chosen.push(runtimePkg);
continue;
}
statuses.push({
package: js.packageName,
package: runtimePkg,
status: "refused",
detail: "it ships no own .d.ts declaration surface",
detail:
npm === null
? "it ships no own .d.ts declaration surface"
: `its declared types come from the separate ${npm.packageName} package, not the package itself`,
hint: npmStaticOptInHint(runtimePkg, owner),
});
continue;
}
if (judged?.has(npm.packageName)) continue;
// An @types twin with no runtime package installed has nothing to
// compile (Node cannot load it either).
if (viaTransitive && !npm.packageName.startsWith("@types/")) {
judged!.add(npm.packageName);
sites!.set(npm.packageName, loc);
transitive.add(npm.packageName);
chosen.push(npm.packageName);
continue;
}
if (!seen.has(npm.packageName)) {
seen.set(npm.packageName, { typesFile: npm.typesFile, fromFile: sf.fileName, spec });
seen.set(npm.packageName, { typesFile: npm.typesFile, fromFile: sf.fileName, spec, owner });
sites?.set(npm.packageName, loc);
}
}
}
const chosen: string[] = [];
for (const [pkg, { typesFile, fromFile, spec }] of seen) {
for (const [pkg, { typesFile, fromFile, spec, owner }] of seen) {
judged?.add(pkg);
// A package without a root entry (no "main", "exports" or index file)
// can still serve the subpath the program imports.
@@ -175,11 +261,23 @@ function detectAutoPackages(
package: pkg,
status: "refused",
detail: mode === "lib" ? reason : `auto: ${reason}`,
// Naming a package bypasses the declaration and shipped-JS
// heuristics; it cannot supply JavaScript that does not resolve.
...(mode === "lib" && jsEntry !== null ? { hint: npmStaticOptInHint(pkg, owner) } : {}),
});
}
return chosen;
}
/** How to compile a package the declaration bar refused anyway: name it,
* or (for a dependency of an opted-in package) opt in that package's
* whole dependency closure. */
function npmStaticOptInHint(pkg: string, importer: string | null): string {
return importer === null
? `to compile it anyway, name it with --npm-static=${pkg} (or --npm-static=${pkg}... to include its dependencies)`
: `to compile it anyway, name it with --npm-static=${pkg}, or use --npm-static=${importer}... to include all of ${importer}'s dependencies`;
}
/** The opted-in packages a consumer-anchored tsc message NAMES: module
* specifiers in `Module '"spec"'` phrasings, and resolved file paths in
* `import("…")` type spellings — the two ways the checker points at an
@@ -227,9 +325,23 @@ export function runFrontend(
// selections bypass eligibility heuristics, but never compilation checks.
const explicit: readonly string[] =
npmStatic !== undefined && typeof npmStatic !== "string" ? npmStatic : [];
return loadFrontend(entryPath, trackedLoader, "lib", externalTypes, [
...new Set([...libraryNpmStatic, ...explicit]),
]);
// A trailing "..." (`--npm-static=fs-extra...`) selects the package and
// its whole dependency closure, which the library fixpoint discovers.
const transitive = new Set<string>();
const names = [...libraryNpmStatic, ...explicit].map((name) => {
if (!name.endsWith("...") || name.length === 3) return name;
const base = name.slice(0, -3);
transitive.add(base);
return base;
});
return loadFrontend(
entryPath,
trackedLoader,
"lib",
externalTypes,
[...new Set(names)],
transitive,
);
} catch (error) {
for (const load of active) {
// Preserve the original failure and attempt every remaining cleanup.
@@ -249,6 +361,7 @@ function loadFrontend(
npmStatic?: readonly string[] | "auto" | "lib",
externalTypes?: Readonly<Record<string, string>>,
libraryNpmStatic: readonly string[] = [],
transitive: Set<string> = new Set(),
): Frontend {
// Resolver package/workspace metadata is intentionally shared across the
// several load attempts of ONE auto-detection fixpoint, but never across
@@ -270,7 +383,10 @@ function loadFrontend(
const scoutPreflight = checkPreflight(scout);
requested =
npmStatic === "lib"
? [...libraryNpmStatic, ...detectAutoPackages(scout, statuses, "lib", judged, npmSites)]
? [
...libraryNpmStatic,
...detectAutoPackages(scout, statuses, "lib", judged, npmSites, transitive),
]
: detectAutoPackages(scout, statuses);
// With no package to opt in, the scout already IS the final frontend:
// same roots, resolution posture, preflight, and module order. Retain it
@@ -328,7 +444,7 @@ function loadFrontend(
// at least one new package for good).
if (npmStatic === "lib") {
for (;;) {
const grown = detectAutoPackages(load, statuses, "lib", judged, npmSites);
const grown = detectAutoPackages(load, statuses, "lib", judged, npmSites, transitive);
if (grown.length === 0) break;
requested = [...requested, ...grown];
load.dispose();
@@ -344,7 +460,8 @@ function loadFrontend(
const reasons = new Map<string, string>(npmStaticOffenders());
for (const d of preflight) {
const pkg = npmStaticPackageOfPath(d.loc.file);
if (pkg !== null && !reasons.has(pkg)) reasons.set(pkg, `${d.code}: ${d.message}`);
if (pkg !== null && !reasons.has(pkg))
reasons.set(pkg, `${d.code} at ${packageDiagWhere(load, d.loc)}: ${d.message}`);
}
if (![...reasons.keys()].some((p) => effective.has(p))) {
const named = new Map<string, number>();
@@ -476,6 +593,7 @@ function loadFrontend(
...opts,
frontendServices: finalLoad.services,
startupCrash: finalLoad.startupCrash ?? null,
inlineRequireCycleCalls: finalLoad.inlineRequireCycleCalls,
projectCheckJs: finalLoad.typeWorld?.projectCheckJs ?? false,
externalTypes: finalLoad.externalTypes,
externalTypeSpecifiersByFile: finalLoad.externalTypeSpecifiersByFile,
packages/compiler/src/frontend/program.ts
+250 -69
View File
@@ -119,6 +119,11 @@ import {
import { trackedFileExists, trackedReadFile, trackedRealpath } from "./input-tracker.js";
import { forkTargetPaths } from "./fork-target.js";
import { workerTargetPaths } from "./worker-target.js";
import {
erasedTypeOnlyImport,
typeOnlyNamedImport,
typeOnlyReachedFiles,
} from "./type-only-imports.js";
import { moduleSourceCandidates } from "./module-source-candidates.js";
import { inferredJsDiagnosticSuppressed } from "./inferred-js-diagnostics.js";
@@ -333,6 +338,12 @@ export interface LoadResult {
* last. Empty until checkPreflight runs (and empty when preflight fails
* structurally). */
moduleOrder: ts.SourceFile[];
/** Inline require() calls whose edge closes a require cycle. Node answers
* them with the still-evaluating module's partial exports, which the
* static export globals do not model; their lowering refuses them by name
* at run time instead of refusing the whole program. Filled by
* checkPreflight. */
inlineRequireCycleCalls?: ReadonlySet<ts.Node>;
/** Node's startup refusal, when the graph carries an import edge Node
* rejects before ANY module evaluates — a RESOLUTION refusal (a bare
* specifier nothing installed resolves, an exports/imports map that
@@ -635,9 +646,14 @@ export function entryPackageFilePredicate(entryPath: string): (file: string) =>
}
/** maxNodeModuleJsDepth can omit relative imports within an admitted
* package. Discover its runtime sources to a fixpoint so the checker and
* module resolver see the same graph regardless of import traversal order. */
function entryPackageProgramRoots7(program: ts.Program, entryPath: string): string[] {
* package, and opted-in packages deep in the dependency graph. Discover
* their runtime sources to a fixpoint so the checker and module resolver
* see the same graph regardless of import traversal order or depth. */
function entryPackageProgramRoots7(
program: ts.Program,
entryPath: string,
rootNpmStaticEdges: boolean,
): string[] {
const belongsToEntry = entryPackageFilePredicate(entryPath);
const roots = new Set<string>();
for (const sf of program.getImplementationSourceFiles()) {
@@ -656,15 +672,63 @@ function entryPackageProgramRoots7(program: ts.Program, entryPath: string): stri
program.getSourceFile(target) === undefined
)
roots.add(target);
// An opted-in package's bare edge counts against the same depth
// budget: tsgo charges every node_modules JS hop, so express's
// body-parser → qs → side-channel → get-intrinsic chain runs out of
// depth before its leaves load. Root the runtime file this edge
// lowers to (preflight's own resolution and miss rule) so the leaf
// joins like a shallow one; complete programs add nothing. Only
// the shadowed lowering world does this (the authored world checks
// user code against declarations), and only from package files: a
// program file's own edges are never deeper than one hop.
// (resolveBareModule directly: resolveNpmImport7's workspace
// registration stays with preflight's own walk.)
if (
target === null &&
rootNpmStaticEdges &&
npmStaticPackageOfPath(sf.fileName) !== null &&
!isRelativeSpecifier(specifier.text)
) {
const spec = specifier.text;
if (spec.startsWith("#") || canonicalBuiltinModule(spec) !== null) continue;
const npm = resolveBareModule(
sf.fileName,
spec,
undefined,
moduleSpecifierKind7(specifier),
);
if (
npm !== null &&
isNpmStaticPackage(npm.packageName) &&
(isNodeModulesPath(npm.typesFile) || npm.workspaceDir !== undefined) &&
isJsSourceFileName(npm.typesFile) &&
npmStaticProgramFile(program, npm.typesFile) === null
)
roots.add(tsgoPath(resolve(npm.typesFile)));
}
}
}
return [...roots].sort();
}
/** "require" for a CommonJS edge (`require("x")`, `import x = require("x")`),
* "import" for every ESM form — the resolution kind preflight uses. */
function moduleSpecifierKind7(specifier: ts.StringLiteralLike): "import" | "require" {
const parent = specifier.parent;
if (ts.isExternalModuleReference(parent)) return "require";
return ts.isCallExpression(parent) &&
ts.isIdentifier(parent.expression) &&
parent.expression.text === "require"
? "require"
: "import";
}
function loadProgram7(
host: ts.Ts7Host,
entryPath: string,
externalTypes: ReadonlyMap<string, string> = new Map(),
/** The --npm-static lowering world: root opted-in packages' deep edges. */
rootNpmStaticEdges = false,
): LoadResult & { disposeAll: () => void } {
const config = adoptProjectConfig7(host, entryPath);
const configuredPaths = config.options["paths"];
@@ -712,7 +776,7 @@ function loadProgram7(
try {
for (let pass = 0; pass < 32; pass++) {
const candidates = [
...entryPackageProgramRoots7(program, entryPath),
...entryPackageProgramRoots7(program, entryPath, rootNpmStaticEdges),
...createRequireProgramRoots7(program),
...forkTargetPaths(program, program.getImplementationSourceFiles()),
...workerTargetPaths(program, program.getImplementationSourceFiles()),
@@ -926,7 +990,7 @@ export function loadProgram(
};
const host = services.createProgramHost({ cwd: dirname(entryPath), fsShadow });
try {
const load = loadProgram7(host, entryPath, externalTypes);
const load = loadProgram7(host, entryPath, externalTypes, npmStaticPackages.length > 0);
let authoredHost: ts.Ts7Host | null = null;
let authoredLoad: ReturnType<typeof loadProgram7> | null = null;
return {
@@ -970,9 +1034,10 @@ export function loadProgram(
* preflight diagnostics. Preserve the caller's complete load shape when
* mutating it, including its owned services and disposal callback. */
export function checkPreflight<T extends LoadResult>(load: T): ScrDiagnostic[] {
const { diags, moduleOrder, startupCrash } = preflight7(load);
const { diags, moduleOrder, startupCrash, inlineRequireCycleCalls } = preflight7(load);
load.moduleOrder = moduleOrder;
load.startupCrash = startupCrash;
load.inlineRequireCycleCalls = inlineRequireCycleCalls;
return diags;
}
@@ -1837,6 +1902,36 @@ function nestedBareRequiresOf7(sf: ts.SourceFile): ts.CallExpression[] {
return out;
}
/** INLINE `require("...")` calls in expression position anywhere in a file
* (`require("./x").f`, `require("debug")("ns")`, `module.exports =
* require("./y")`, `{ v: require("./v") }`): each evaluates its module at
* that position, exactly like a bare require statement. Top-level require
* statements and bare require statements are collected by their own
* scans; a require that initializes a nested declaration keeps its
* lowering fence and is not an edge. */
function inlineRequiresOf7(sf: ts.SourceFile): ts.CallExpression[] {
const out: ts.CallExpression[] = [];
ts.walkPreorder(sf, (n) => {
if (!ts.isCallExpression(n) || requireSpecOf7(n) === null) return;
let outer: ts.Node = n;
while (
outer.parent !== undefined &&
(ts.isParenthesizedExpression(outer.parent) ||
ts.isAsExpression(outer.parent) ||
ts.isTypeAssertion(outer.parent) ||
ts.isNonNullExpression(outer.parent))
) {
outer = outer.parent;
}
const parent = outer.parent;
if (parent !== undefined && ts.isExpressionStatement(parent)) return;
if (parent !== undefined && ts.isVariableDeclaration(parent) && parent.initializer === outer)
return;
out.push(n);
});
return out;
}
type RequireCallBindingKind7 = "ambient" | "createRequire" | "source";
function stripRequireCasts7(expr: ts.Expression): ts.Expression {
@@ -2146,7 +2241,7 @@ function insideFunctionLike7(node: ts.Node): boolean {
function nodeEsmSyntaxMarker7(sf: ts.SourceFile): ts.Node | null {
for (const stmt of sf.statements) {
if (ts.isImportDeclaration(stmt) && !erasedTypeOnlyImport(stmt)) return stmt;
if (ts.isExportDeclaration(stmt) && !stmt.isTypeOnly && !erasedTypeOnlyReexport(stmt)) {
if (ts.isExportDeclaration(stmt) && !stmt.isTypeOnly) {
return stmt;
}
if (ts.isExportAssignment(stmt)) return stmt;
@@ -2403,6 +2498,13 @@ function nsBindingUsesAreBareStatements7(
export interface CycleEdge {
dep: ts.SourceFile;
stmt?: ts.ImportDeclaration | ts.ExportDeclaration;
/** An inline require() in a deferred position (a function body): Node
* evaluates the dependency when that code runs, after this module's own
* top level, so the edge orders the dependency after the module and
* never closes a cycle through the module's initialization. */
lazy?: true;
/** The inline require() call behind the edge (inline edges only). */
call?: ts.CallExpression;
}
/** True when the reference at `node` can only evaluate AFTER the module
@@ -2829,6 +2931,7 @@ export function makeCycleAdmission(
const clause = e.stmt.importClause;
if (
clause === undefined ||
typeOnlyNamedImport(e.stmt) ||
(clause.name === undefined &&
(clause.namedBindings === undefined ||
(ts.isNamespaceImport(clause.namedBindings) &&
@@ -4000,6 +4103,24 @@ function locOf7(node: ts.Node): { file: string; start: number; end: number } {
return { file: sf.fileName, start: node.getStart(sf), end: node.getEnd() };
}
/** The program file holding an opted-in package's resolved runtime JS:
* the file itself, or its same-stem TypeScript twin. */
function npmStaticProgramFile(program: ts.Program, resolvedFile: string): ts.SourceFile | null {
let dep = program.getSourceFile(resolvedFile) ?? null;
if (dep === null) {
// A workspace-linked package shipping its .ts SOURCE beside the
// compiled .js: the checker's resolution preferred the source (it
// outranks the sibling .js under bundler resolution), so the program
// holds the .ts twin at the same stem — the same module, in its
// richer spelling.
for (const ext of [".ts", ".tsx", ".mts", ".cts"]) {
dep = program.getSourceFile(resolvedFile.replace(/\.(js|mjs|cjs)$/, ext)) ?? null;
if (dep !== null) break;
}
}
return dep;
}
/** The PROGRAM source file an opted-in --npm-static package's resolved
* entry maps to, or null with the package marked an offender (resolution
* still answering declarations, or the file missing from the type-checked
@@ -4016,18 +4137,7 @@ function npmStaticProgramDep(
);
return null;
}
let dep = program.getSourceFile(resolvedFile) ?? null;
if (dep === null) {
// A workspace-linked package shipping its .ts SOURCE beside the
// compiled .js: the checker's resolution preferred the source (it
// outranks the sibling .js under bundler resolution), so the program
// holds the .ts twin at the same stem — the same module, in its
// richer spelling.
for (const ext of [".ts", ".tsx", ".mts", ".cts"]) {
dep = program.getSourceFile(resolvedFile.replace(/\.(js|mjs|cjs)$/, ext)) ?? null;
if (dep !== null) break;
}
}
const dep = npmStaticProgramFile(program, resolvedFile);
if (dep === null) {
reportNpmStaticOffender(
packageName,
@@ -4079,6 +4189,7 @@ function preflight7(load: LoadResult): {
diags: ScrDiagnostic[];
moduleOrder: ts.SourceFile[];
startupCrash: StartupCrash | null;
inlineRequireCycleCalls: ReadonlySet<ts.Node>;
} {
const { program, entry } = load;
const diags: ScrDiagnostic[] = [...load.configDiags];
@@ -4299,21 +4410,41 @@ function preflight7(load: LoadResult): {
npmStaticPackageOfPath(sf.fileName) !== null) &&
!unselectedPackageJsFile(sf.fileName),
);
// Files reached only through `import type` / `export type … from` are
// checker input, never program modules: Node does not load them, so
// their imports and syntax must not fence the program.
const resolveRuntimeEdge = (
sf: ts.SourceFile,
spec: string,
resolutionKind?: "import" | "require",
): ts.SourceFile | null =>
resolveImport7(program, sf, spec, resolutionKind) ??
npmStaticDepSf7(program, sf, spec, resolutionKind);
const typeOnlyFiles = typeOnlyReachedFiles(
program,
entry,
programFiles,
() => [
...forkTargetPaths(program, program.getImplementationSourceFiles()),
...workerTargetPaths(program, program.getImplementationSourceFiles()),
],
resolveRuntimeEdge,
);
const runtimeFiles =
typeOnlyFiles.size === 0 ? programFiles : programFiles.filter((sf) => !typeOnlyFiles.has(sf));
const userFiles = npmStaticActive()
? planNpmStaticReexports(
program,
entry,
programFiles,
runtimeFiles,
[
...createRequireProgramRoots7(program),
...forkTargetPaths(program, program.getImplementationSourceFiles()),
...workerTargetPaths(program, program.getImplementationSourceFiles()),
],
(sf, spec, resolutionKind) =>
resolveImport7(program, sf, spec, resolutionKind) ??
npmStaticDepSf7(program, sf, spec, resolutionKind),
resolveRuntimeEdge,
)
: programFiles;
: runtimeFiles;
program.getTypeChecker().prefetchSourceFileStructures(userFiles);
// Unselected node_modules JS is not native program source even when
@@ -4438,8 +4569,7 @@ function preflight7(load: LoadResult): {
continue;
}
if (ts.isExportDeclaration(stmt)) {
if (stmt.isTypeOnly || erasedTypeOnlyReexport(stmt) || isPrunedNpmReexport(program, stmt))
continue;
if (stmt.isTypeOnly || isPrunedNpmReexport(program, stmt)) continue;
if (!stmt.moduleSpecifier) continue;
const fromSpec = ts.isStringLiteral(stmt.moduleSpecifier) ? stmt.moduleSpecifier.text : "";
if (load.externalTypes.has(fromSpec)) {
@@ -4860,6 +4990,21 @@ function preflight7(load: LoadResult): {
pattern.elements.every((e) => {
if (e.initializer !== undefined || e.dotDotDotToken !== undefined) return false;
if (e.name !== undefined && ts.isIdentifier(e.name)) return true;
// A nested pattern under a named export of a program module
// destructures that export's VALUE at the require
// (`const { codes: { ERR_X } } = require("./errors")`): the
// inner bindings are ordinary destructured storage.
if (
module === null &&
builtin === null &&
bindingKind !== "createRequire" &&
pattern === req.decl!.name &&
e.name !== undefined &&
ts.isObjectBindingPattern(e.name) &&
e.propertyName !== undefined &&
ts.isIdentifier(e.propertyName)
)
return true;
if (module === null || e.name === undefined || !ts.isObjectBindingPattern(e.name))
return false;
const key = e.propertyName;
@@ -4973,6 +5118,32 @@ function preflight7(load: LoadResult): {
continue;
}
}
// Inline requires of program modules are module edges like the bare
// statements above (cjs-inline-require.ts lowers each to the module's
// %init at its position). Only the CommonJS global in a CommonJS file
// counts, and targets outside the compiled graph add nothing here:
// their use sites keep their existing lowering fences.
if (jsRequireFile && !isNodeEsmFile7(sf, program)) {
for (const call of inlineRequiresOf7(sf)) {
if (requireCallBindingKind7(program, call) !== "ambient") continue;
const spec = requireSpecOf7(call)!;
if (load.externalTypes.has(spec) || canonicalBuiltinModule(spec) !== null) continue;
const lazy = inDeferredPosition7(call);
const edgeTo = (dep: ts.SourceFile): CycleEdge =>
lazy ? { dep, lazy: true, call } : { dep, call };
const projectDep = resolveImport7(program, sf, spec, "require");
if (projectDep !== null) {
if (!projectDep.fileName.endsWith(".json")) deps.push(edgeTo(projectDep));
continue;
}
if (isRelativeSpecifier(spec) || spec.startsWith("#")) continue;
const npmReq = resolveNpmImport7(sf.fileName, spec, "require");
if (npmReq !== null && isNpmStaticPackage(npmReq.packageName)) {
const nDep = npmStaticProgramDep(program, npmReq.packageName, npmReq.typesFile);
if (nDep !== null) deps.push(edgeTo(nDep));
}
}
}
}
}
@@ -4999,8 +5170,12 @@ function preflight7(load: LoadResult): {
// reads are all let/const bindings with module storage — the
// lowering checks each one (cycleEarlyBindings) and throws Node's
// ReferenceError on a read before the declaration ran.
const cycleAdmissionReason = makeCycleAdmission(program, (sf) => edges.get(sf) ?? []);
const cycleAdmissionReason = makeCycleAdmission(program, (sf) => {
const all = edges.get(sf) ?? [];
return all.some((e) => e.call !== undefined) ? all.filter((e) => e.call === undefined) : all;
});
const order: ts.SourceFile[] = [];
const inlineRequireCycleCalls = new Set<ts.Node>();
const state = new Map<ts.SourceFile, "visiting" | "done">();
const stack: string[] = [];
const visit = (sf: ts.SourceFile): void => {
@@ -5008,9 +5183,14 @@ function preflight7(load: LoadResult): {
stack.push(sf.fileName);
for (const e of edges.get(sf) ?? []) {
if (e.dep === sf) continue; // self-import: a Node cache hit, not a cycle
if (e.lazy === true) continue; // visited after this module completes
const s = state.get(e.dep);
if (s === "done") continue;
if (s === "visiting") {
if (e.call !== undefined) {
inlineRequireCycleCalls.add(e.call);
continue;
}
// A back-edge: Node answers it from the cache (the module is
// already evaluating) — admitted by the cheap per-edge rule, the
// declaration-only init window rule, or the exact initialization
@@ -5034,6 +5214,11 @@ function preflight7(load: LoadResult): {
stack.pop();
state.set(sf, "done");
order.push(sf);
// Lazy inline requires run after this module's top level: their
// modules join the order afterwards (cache hits when already loaded).
for (const e of edges.get(sf) ?? []) {
if (e.lazy === true && state.get(e.dep) === undefined) visit(e.dep);
}
};
visit(entry);
@@ -5087,7 +5272,12 @@ function preflight7(load: LoadResult): {
esmNamedImportLinkCheck(program, entry, order, diags),
);
return { diags, moduleOrder: order, startupCrash: resolveCrash ?? linkCrash };
return {
diags,
moduleOrder: order,
startupCrash: resolveCrash ?? linkCrash,
inlineRequireCycleCalls,
};
}
/* ── the CJS named-import link check ─────────────────────────────────────
@@ -5708,42 +5898,6 @@ export function isCheckedJsSourceFile(sf: ts.SourceFile, projectCheckJs: boolean
return checked;
}
/** `import type …` declarations and named clauses whose every element is
* `type`-qualified are ERASED by tsc at emit — Node's module graph has no
* edge there, so module order, cycle detection, init calls, and the
* startup-refusal probe must not count them either (zod v4's core modules
* are "cyclic" only through `import type * as ns` namespaces — 27 phantom
* SC1016 sites against 1 real value-level cycle; and a type-only import
* of a module Node cannot resolve is NOT a startup crash — Node never
* resolves it). Originated as the provenance-sources pilot's flag-gated
* prototype (SCRIPTC_TYPE_ONLY_EDGES), promoted to always-on with the
* full-suite differential green. Side-effect imports (no clause) stay
* real edges. */
function erasedTypeOnlyImport(stmt: ts.ImportDeclaration): boolean {
const clause = stmt.importClause;
if (clause === undefined) return false; // side-effect import: a real edge
if (clause.phaseModifier === ts.SyntaxKind.TypeKeyword) return true;
return (
clause.name === undefined &&
clause.namedBindings !== undefined &&
ts.isNamedImports(clause.namedBindings) &&
clause.namedBindings.elements.length > 0 &&
clause.namedBindings.elements.every((e) => e.isTypeOnly)
);
}
/** The re-export twin: `export { type X } from "./m"` with every element
* `type`-qualified erases at emit exactly like `export type { X } from`
* (which stmt.isTypeOnly already covers) — no module edge. */
function erasedTypeOnlyReexport(stmt: ts.ExportDeclaration): boolean {
return (
stmt.exportClause !== undefined &&
ts.isNamedExports(stmt.exportClause) &&
stmt.exportClause.elements.length > 0 &&
stmt.exportClause.elements.every((e) => e.isTypeOnly)
);
}
export function orderedImportsOf(
program: ts.Program,
sf: ts.SourceFile,
@@ -5751,11 +5905,7 @@ export function orderedImportsOf(
const out: { stmt: ts.Statement; dep: ts.SourceFile | null }[] = [];
for (const stmt of sf.statements) {
if (ts.isExportDeclaration(stmt) && isPrunedNpmReexport(program, stmt)) continue;
if (
ts.isExportDeclaration(stmt) &&
(stmt.isTypeOnly || erasedTypeOnlyReexport(stmt) || !stmt.moduleSpecifier)
)
continue;
if (ts.isExportDeclaration(stmt) && (stmt.isTypeOnly || !stmt.moduleSpecifier)) continue;
if (!ts.isImportDeclaration(stmt) && !ts.isExportDeclaration(stmt)) continue;
if (ts.isImportDeclaration(stmt) && erasedTypeOnlyImport(stmt)) continue;
if (!stmt.moduleSpecifier || !ts.isStringLiteral(stmt.moduleSpecifier)) continue;
@@ -5830,6 +5980,37 @@ export function cjsExportAssignmentOf(
return null;
}
/** The members and shared value of a CHAINED member export
* `exports.a = exports.b = module.exports.c = value` (outermost name
* first), or null when the assignment is not a chain of at least two
* identifier-named export members or its value is undefined. */
export function cjsExportChainOf(
e: ts.BinaryExpression,
): { names: ts.Identifier[]; value: ts.Expression } | null {
const names: ts.Identifier[] = [];
let cur: ts.Expression = e;
for (;;) {
while (ts.isParenthesizedExpression(cur)) cur = cur.expression;
if (!ts.isBinaryExpression(cur) || cur.operatorToken.kind !== ts.SyntaxKind.EqualsToken) break;
const left = cur.left;
if (
!ts.isPropertyAccessExpression(left) ||
left.questionDotToken ||
!ts.isIdentifier(left.name)
)
break;
const recv = left.expression;
if (!((ts.isIdentifier(recv) && recv.text === "exports") || isModuleExportsAccess(recv))) break;
names.push(left.name);
cur = cur.right;
}
// tsc's `exports.a = exports.b = void 0;` preamble is not a value chain
// (the export-statement lowering owns it).
const isVoid =
cur.kind === ts.SyntaxKind.VoidExpression || (ts.isIdentifier(cur) && cur.text === "undefined");
return names.length >= 2 && !isVoid ? { names, value: cur } : null;
}
/** Why Node would DISCARD this CommonJS export statement, or null when it
* survives (Node's export-object identity rules — checker-free, pure
* AST): `module.exports = {...}` REPLACES the export object, so members
packages/compiler/src/frontend/tier-analysis.ts
+629
View File
@@ -0,0 +1,629 @@
/* Tier assignment, report-only (two-tier design, stage S2).
*
* The design assigns every binding, field, function instance, class and
* module a tier. Static is today's compiler; dynamic code operates on
* dynamic values. Demotion from static to dynamic is monotone and is seeded
* by `any`, untyped JavaScript, types and operations without a static
* lowering, reflection a static layout cannot answer, and dynamic modules
* (DESIGN.md §6).
*
* Stage S2 computes what WOULD be demoted without demoting anything:
*
* 1. Existing dynamic code. Functions whose bodies already use the `dyn`
* vocabulary are the dynamic tier today (ir/tiers.ts assigns them). The
* source statements whose lowering performs a dynamic operation are the
* coverage report's statementsDynamic.
* 2. Demotion requests. Every refusal or runtime fence the lowerer commits
* (today's poison sites: the SC1xxx/SC2xxx families) and every refused
* import or package becomes a request, attributed to the unit whose
* static representation could not express the construct. The lowerer
* still refuses or fences exactly as before; the requests are recorded
* from the committed diagnostics, so speculative probes that roll back
* record nothing. Under `--tier=static-only` every request stays today's
* refusal; stage S6 turns requests into demotions in the default mode.
* 3. Demoted units. A request demotes its unit, and the function instance
* containing the site turns dynamic (it would hold dynamic operations,
* invariant I1). Units are deduplicated; each keeps its requests, which
* is the chain `--explain-dynamic` prints.
*
* Attribution is syntactic and approximate: the site's innermost node, the
* operand it acts on, and that operand's declaration. Stage S6 replaces it
* with requests the failing lowering names exactly. */
import type { ScrDiagnostic } from "../diagnostics/diagnostic.js";
import type { IrFunction, SrcLoc } from "../ir/ir.js";
import { dynamicOperationSites, type DynamicFunction } from "../ir/tiers.js";
import * as ts from "./ts7/adapter.js";
/** `--tier`: "auto" (the default) will demote; "static-only" keeps every
* demotion request a refusal (design invariant I2). Identical in S2. */
export type TierMode = "auto" | "static-only";
export const TIER_MODES: readonly TierMode[] = ["auto", "static-only"];
export type DemotionUnitKind = "binding" | "field" | "function" | "class" | "module";
export interface DemotionUnit {
kind: DemotionUnitKind;
/** Display name: `x`, `Point.x`, `parse`, `Parser.next`, `Point`, or the
* module's file path. */
name: string;
/** Bindings: the function declaring a local, absent for module scope. */
owner?: string;
/** The unit's declaration (the site itself when none is known). */
loc: SrcLoc;
}
/** Why a unit is demoted (DESIGN.md §6.2): a type with no static
* representation, an operation with no static lowering, reflection on a
* class, a use of a binding whose declaration was refused, a module or
* package that cannot be static, or a construct excluded by policy (no
* demotion: it stays a refusal). */
export type DemotionSeed = "type" | "operation" | "reflection" | "cascade" | "module" | "excluded";
export type DemotionScope = "reached" | "deferred" | "unreached";
export interface DemotionRequest {
unit: DemotionUnit;
/** The function instance (or module top level) containing the site. */
enclosing: DemotionUnit;
seed: DemotionSeed;
scope: DemotionScope;
code: string;
message: string;
loc: SrcLoc;
}
export interface DemotedUnit extends DemotionUnit {
/** Requests naming this unit directly. */
requests: number;
/** Requests whose sites this function instance or module contains. */
sites: number;
}
export interface TierDynamicFunction extends DynamicFunction {
/** Source statements with a dynamic operation in this function. */
statements: number;
}
export interface TierReport {
mode: TierMode;
/** Reached source statements that perform a dynamic operation. */
statementsDynamic: number;
dynamicFunctions: TierDynamicFunction[];
requests: DemotionRequest[];
/** Units the requests would demote (reached and deferred scopes),
* deduplicated, by kind then source order. */
units: DemotedUnit[];
}
/* ── statements of dynamic functions ─────────────────────────────────── */
function isClassLike(node: ts.Node): boolean {
return ts.isClassDeclaration(node) || ts.isClassExpression(node);
}
/** The innermost node spanning exactly or containing [start, end). */
function nodeAt(sf: ts.SourceFile, start: number, end: number): ts.Node {
let node: ts.Node = sf;
for (;;) {
let next: ts.Node | undefined;
node.forEachChild((child) => {
if (child.getStart(sf) <= start && end <= child.getEnd()) {
next = child;
return true;
}
return undefined;
});
if (next === undefined) return node;
node = next;
}
}
/** The source statement an IR location belongs to: the innermost
* statement containing it, or an arrow function's expression body. Null
* for synthetic locations. */
function statementAt(program: ts.Program, loc: SrcLoc): ts.Node | null {
if (loc.start === 0 && loc.end === 0) return null;
const sf = program.getSourceFile(loc.file);
if (sf === undefined) return null;
let node: ts.Node | undefined = nodeAt(sf, loc.start, loc.end);
while (node !== undefined && !ts.isSourceFile(node)) {
const parent: ts.Node | undefined = node.parent;
if (parent !== undefined && ts.isArrowFunction(parent) && parent.body === node) return node;
if (ts.isStatement(node) && !ts.isBlock(node)) return node;
node = parent;
}
return null;
}
/** Dynamic statements are the source statements whose lowering performs a
* dynamic operation (in the function itself or in a generated helper it
* calls). They count once however many functions and operations they
* involve. A function's tier is the unit of I1, but static operations
* inside a dynamic function stay static, so the statement is the honest
* measure of how much code is dynamic. */
function dynamicFunctionReports(
program: ts.Program,
bodies: readonly IrFunction[],
): { functions: TierDynamicFunction[]; statements: number } {
const byLoc = new Map<string, ts.Node | null>();
const all = new Set<ts.Node>();
const functions: TierDynamicFunction[] = [];
for (const fn of bodies) {
const sites = dynamicOperationSites(fn);
if (sites.length === 0) continue;
const own = new Set<ts.Node>();
for (const site of sites) {
const key = `${site.loc.file}\0${site.loc.start}\0${site.loc.end}`;
let statement = byLoc.get(key);
if (statement === undefined) {
statement = statementAt(program, site.loc);
byLoc.set(key, statement);
}
if (statement === null) continue;
own.add(statement);
all.add(statement);
}
functions.push({
name: fn.name,
loc: fn.loc,
operation: sites[0]!.operation,
operationLoc: sites[0]!.loc,
statements: own.size,
});
}
return { functions, statements: all.size };
}
/* ── demotion requests ───────────────────────────────────────────────── */
const TYPE_CODES = new Set([
"SC2001",
"SC2002",
"SC2003",
"SC2005",
"SC2006",
"SC2007",
"SC2008",
"SC2009",
"SC2011",
"SC1063",
"SC1100",
"SC1101",
]);
const MODULE_CODES = new Set([
"SC1010",
"SC1012",
"SC1013",
"SC1014",
"SC1015",
"SC1016",
"SC2013",
]);
/** Runtime code generation (`eval`, `new Function`): excluded by policy,
* since the dynamic tier compiles ahead of time (DESIGN.md §12 class X). */
const EXCLUDED_CODES = new Set(["SC2010"]);
const EXCLUDED_SURFACE = /^'(?:new Function|Function|eval)'/;
/** Refusals and fences that name a static-tier gap. Type errors,
* environment and target refusals, divergences and internal errors are
* not demotion requests. */
export function isDemotionCode(code: string): boolean {
return /^SC[12]\d{3}$/.test(code);
}
function isFunctionLikeOrFile(node: ts.Node): boolean {
return (
ts.isSourceFile(node) ||
ts.isFunctionLikeDeclaration(node) ||
ts.isClassStaticBlockDeclaration(node)
);
}
function nameText(name: ts.Node | undefined): string | null {
if (name === undefined) return null;
if (ts.isIdentifier(name) || ts.isPrivateIdentifier(name)) return name.text;
if (ts.isStringLiteral(name) || ts.isNumericLiteral(name)) return name.text;
return null;
}
function className(node: ts.Node | undefined): string {
if (node === undefined) return "<anonymous class>";
if ((ts.isClassDeclaration(node) || ts.isClassExpression(node)) && node.name !== undefined)
return node.name.text;
const parent = node.parent;
if (parent !== undefined && ts.isVariableDeclaration(parent) && ts.isIdentifier(parent.name))
return parent.name.text;
return "<anonymous class>";
}
/** The display name of a function-like node, as a user would look it up. */
function functionName(node: ts.Node): string {
if (ts.isSourceFile(node)) return "<module top level>";
if (ts.isClassStaticBlockDeclaration(node)) return `${className(node.parent)}.<static block>`;
if (ts.isConstructorDeclaration(node)) return `${className(node.parent)}.constructor`;
const own = ts.isFunctionLikeDeclaration(node) ? nameText(node.name) : null;
const parent = node.parent;
if (parent !== undefined && isClassLike(parent) && own !== null)
return `${className(parent)}.${own}`;
if (own !== null) return own;
if (parent !== undefined) {
if (ts.isVariableDeclaration(parent) || ts.isPropertyAssignment(parent)) {
const bound = nameText(parent.name);
if (bound !== null) return bound;
}
if (
ts.isPropertyDeclaration(parent) &&
parent.parent !== undefined &&
isClassLike(parent.parent)
) {
const field = nameText(parent.name);
if (field !== null) return `${className(parent.parent)}.${field}`;
}
if (ts.isBinaryExpression(parent) && parent.right === node) {
const left = parent.left;
if (ts.isIdentifier(left)) return left.text;
if (ts.isPropertyAccessExpression(left)) return left.getText();
}
}
const sf = node.getSourceFile();
const pos = ts.getLineAndCharacterOfPosition(sf, node.getStart(sf));
return `<anonymous ${pos.line + 1}:${pos.character + 1}>`;
}
function locOfNode(node: ts.Node): SrcLoc {
const sf = node.getSourceFile();
return { file: sf.fileName, start: node.getStart(sf), end: node.getEnd() };
}
function enclosingFunction(node: ts.Node): ts.Node {
let current: ts.Node | undefined = node.parent;
while (current !== undefined && !isFunctionLikeOrFile(current)) current = current.parent;
return current ?? node.getSourceFile();
}
function functionUnit(node: ts.Node, instance: string | null): DemotionUnit {
// Top-level code runs in the module's initializer function.
if (ts.isSourceFile(node))
return {
kind: "function",
name: "<top level>",
loc: { file: node.fileName, start: 0, end: 0 },
};
const name = functionName(node);
return {
kind: "function",
name: instance === null ? name : `${name} ${instance}`,
loc: locOfNode(node),
};
}
/** Generic instances append their instantiation context to diagnostics
* (Lowerer.pushDiag: ` (instantiating 'f' with <T>)`); the instance, not
* the source function, is the unit. Returns the type-argument text. */
function instanceOf(message: string): string | null {
const at = message.lastIndexOf(" (instantiating ");
if (at < 0 || !message.endsWith(")")) return null;
const context = message.slice(at + 2, -1);
const withAt = context.indexOf(" with ");
return withAt < 0 ? context : context.slice(withAt + 6);
}
/** Strip wrappers and walk receivers down to the value an operation acts
* on: `a.b.c(…)` → `a`, `(x as T)[k]` → `x`. Records whether the chain
* passes through `.prototype`. */
function rootOf(expr: ts.Node): { root: ts.Node; viaPrototype: boolean } {
let node = expr;
let viaPrototype = false;
for (;;) {
if (
ts.isParenthesizedExpression(node) ||
ts.isAsExpression(node) ||
ts.isNonNullExpression(node) ||
ts.isAssertionExpression(node) ||
ts.isSatisfiesExpression(node) ||
ts.isSpreadElement(node) ||
ts.isAwaitExpression(node)
) {
node = node.expression!;
} else if (ts.isPropertyAccessExpression(node)) {
if (node.name.text === "prototype") viaPrototype = true;
node = node.expression;
} else if (ts.isElementAccessExpression(node) || ts.isCallExpression(node)) {
node = node.expression;
} else if (
ts.isDeleteExpression(node) ||
ts.isTypeOfExpression(node) ||
ts.isVoidExpression(node)
) {
node = node.expression;
} else {
return { root: node, viaPrototype };
}
}
}
const REFLECTION_NAMESPACES = new Set(["Object", "Reflect"]);
/** The expression an operation at `node` acts on. Reflection calls
* (`Object.defineProperty(x, …)`, `Reflect.set(x, …)`) act on their first
* argument; `new C()` and `x instanceof C` on the class value. */
function subjectOf(node: ts.Node): ts.Node {
let current = node;
// A refused callee or member name: the whole call or access is the site.
const parent = current.parent;
if (parent !== undefined && ts.isPropertyAccessExpression(parent) && parent.name === current)
current = parent;
if (ts.isCallExpression(current)) {
const callee = current.expression;
if (
ts.isPropertyAccessExpression(callee) &&
ts.isIdentifier(callee.expression) &&
REFLECTION_NAMESPACES.has(callee.expression.text) &&
current.arguments.length > 0
) {
return current.arguments[0]!;
}
return callee;
}
if (ts.isNewExpression(current)) return current.expression;
if (ts.isBinaryExpression(current)) {
if (current.operatorToken.kind === ts.SyntaxKind.InstanceOfKeyword) return current.right;
if (current.operatorToken.kind === ts.SyntaxKind.EqualsToken) return current.left;
}
return current;
}
/** The declaration owning a type-refused node: the binding, parameter,
* field or function whose declared type has no static representation. */
function typeOwnerOf(node: ts.Node): ts.Node | null {
let current: ts.Node | undefined = node;
while (current !== undefined && !ts.isSourceFile(current)) {
if (
ts.isVariableDeclaration(current) ||
ts.isParameter(current) ||
ts.isBindingElement(current) ||
ts.isPropertyDeclaration(current) ||
ts.isPropertySignature(current) ||
ts.isCatchClause(current)
) {
return current;
}
if (ts.isFunctionLikeDeclaration(current) || isClassLike(current)) return current;
if (ts.isStatement(current)) return null;
current = current.parent;
}
return null;
}
function isModuleObjectName(node: ts.Node): boolean {
return ts.isIdentifier(node) && (node.text === "exports" || node.text === "module");
}
class UnitResolver {
constructor(private readonly checker: ts.TypeChecker) {}
/** The unit a declaration node denotes. */
declarationUnit(decl: ts.Node): DemotionUnit | null {
if (isClassLike(decl)) return { kind: "class", name: className(decl), loc: locOfNode(decl) };
if (ts.isFunctionLikeDeclaration(decl)) return functionUnit(decl, null);
if (ts.isPropertyDeclaration(decl) || ts.isPropertySignature(decl)) {
const field = nameText(decl.name) ?? "<computed>";
const owner = decl.parent;
const ownerName = owner !== undefined && isClassLike(owner) ? className(owner) : null;
return {
kind: ownerName === null ? "binding" : "field",
name: ownerName === null ? field : `${ownerName}.${field}`,
loc: locOfNode(decl),
};
}
if (ts.isCatchClause(decl)) {
const binding = decl.variableDeclaration;
if (binding === undefined) return null;
return this.declarationUnit(binding);
}
if (ts.isVariableDeclaration(decl) || ts.isParameter(decl) || ts.isBindingElement(decl)) {
const name = nameText(decl.name) ?? decl.name?.getText() ?? "<binding>";
const scope = enclosingFunction(decl);
const unit: DemotionUnit = { kind: "binding", name, loc: locOfNode(decl) };
if (ts.isParameter(decl) && ts.isFunctionLikeDeclaration(decl.parent))
unit.owner = functionName(decl.parent);
else if (!ts.isSourceFile(scope)) unit.owner = functionName(scope);
return unit;
}
return null;
}
/** The unit an operand expression denotes. */
valueUnit(expr: ts.Node): { unit: DemotionUnit; reflection: boolean } | null {
const { root, viaPrototype } = rootOf(expr);
const sf = root.getSourceFile();
if (root.kind === ts.SyntaxKind.ThisKeyword) {
const owner = enclosingFunction(root);
if (ts.isSourceFile(owner))
return {
unit: { kind: "module", name: sf.fileName, loc: locOfNode(sf) },
reflection: false,
};
const cls = owner.parent;
if (cls !== undefined && isClassLike(cls)) {
// `this.f` names a field; `this` itself is the instance.
const access = root.parent;
if (
access !== undefined &&
ts.isPropertyAccessExpression(access) &&
access.expression === root
) {
return {
unit: {
kind: "field",
name: `${className(cls)}.${access.name.text}`,
loc: locOfNode(access),
},
reflection: false,
};
}
return {
unit: { kind: "class", name: className(cls), loc: locOfNode(cls) },
reflection: viaPrototype,
};
}
return null;
}
if (!ts.isIdentifier(root)) return null;
let symbol = this.checker.getSymbolAtLocation(root);
if (symbol !== undefined && (symbol.flags & ts.SymbolFlags.Alias) !== 0)
symbol = this.checker.getAliasedSymbol(symbol);
const decls = symbol === undefined ? [] : this.checker.declarationsOf(symbol);
const decl = decls.find((d) => !d.getSourceFile().isDeclarationFile);
if (decl === undefined) {
// CommonJS `exports`/`module` as values: the module object.
if (isModuleObjectName(root))
return {
unit: { kind: "module", name: sf.fileName, loc: locOfNode(sf) },
reflection: false,
};
return null;
}
if (ts.isSourceFile(decl))
return {
unit: { kind: "module", name: decl.fileName, loc: locOfNode(decl) },
reflection: false,
};
const unit = this.declarationUnit(decl);
if (unit === null) return null;
// `C.prototype.m = …`, `Object.defineProperty(C.prototype, …)`: the
// class (or the constructor function's prototype object).
if (viaPrototype && (unit.kind === "class" || unit.kind === "function"))
return { unit: { ...unit, kind: "class" }, reflection: true };
return { unit, reflection: unit.kind === "class" };
}
}
function seedOf(code: string, message: string): DemotionSeed {
if (EXCLUDED_CODES.has(code) || EXCLUDED_SURFACE.test(message)) return "excluded";
if (code === "SC2004") return "cascade";
if (MODULE_CODES.has(code)) return "module";
if (TYPE_CODES.has(code)) return "type";
return "operation";
}
/** One request for a committed refusal or fence diagnostic. */
function requestFor(
program: ts.Program,
resolver: UnitResolver,
diag: ScrDiagnostic,
scope: DemotionScope,
): DemotionRequest | null {
if (!isDemotionCode(diag.code)) return null;
let seed = seedOf(diag.code, diag.message);
const base = { code: diag.code, message: diag.message, loc: diag.loc, scope };
const sf = program.getSourceFile(diag.loc.file);
if (sf === undefined) {
const unit: DemotionUnit = { kind: "module", name: diag.loc.file, loc: diag.loc };
return { ...base, unit, enclosing: unit, seed };
}
const moduleUnit: DemotionUnit = { kind: "module", name: sf.fileName, loc: locOfNode(sf) };
const node = nodeAt(sf, diag.loc.start, diag.loc.end);
const instance = instanceOf(diag.message);
const owner = ts.isSourceFile(node) ? sf : enclosingFunction(node);
const enclosing = functionUnit(owner, instance);
if (seed === "module" || ts.isSourceFile(node))
return { ...base, unit: moduleUnit, enclosing, seed };
let unit: DemotionUnit | null = null;
if (seed === "type") {
const decl = typeOwnerOf(node);
if (decl !== null) unit = resolver.declarationUnit(decl);
}
if (unit === null) {
const value = resolver.valueUnit(subjectOf(node));
if (value !== null) {
unit = value.unit;
if (value.reflection && seed === "operation") seed = "reflection";
}
}
return { ...base, unit: unit ?? enclosing, enclosing, seed };
}
function unitKey(unit: DemotionUnit): string {
return `${unit.kind}\0${unit.name}\0${unit.owner ?? ""}\0${unit.loc.file}\0${unit.loc.start}`;
}
const KIND_ORDER: readonly DemotionUnitKind[] = ["module", "class", "field", "function", "binding"];
function demotedUnits(requests: readonly DemotionRequest[]): DemotedUnit[] {
const units = new Map<string, DemotedUnit>();
const entry = (unit: DemotionUnit): DemotedUnit => {
const key = unitKey(unit);
let found = units.get(key);
if (found === undefined) units.set(key, (found = { ...unit, requests: 0, sites: 0 }));
return found;
};
for (const request of requests) {
if (request.scope === "unreached" || request.seed === "excluded") continue;
entry(request.unit).requests++;
entry(request.enclosing).sites++;
}
return [...units.values()].sort(
(a, b) =>
KIND_ORDER.indexOf(a.kind) - KIND_ORDER.indexOf(b.kind) ||
a.loc.file.localeCompare(b.loc.file) ||
a.loc.start - b.loc.start ||
a.name.localeCompare(b.name),
);
}
export interface TierAnalysisInput {
mode: TierMode;
/** The dynamic-tier IR functions of the reached program. */
dynamicFunctions: readonly IrFunction[];
reached: readonly ScrDiagnostic[];
deferred: readonly ScrDiagnostic[];
unreached: readonly ScrDiagnostic[];
}
/** Coverage's statementsDynamic (see dynamicFunctionReports). */
export function dynamicStatementCount(
program: ts.Program,
dynamicFunctions: readonly IrFunction[],
): number {
return dynamicFunctionReports(program, dynamicFunctions).statements;
}
export function analyzeTiers(program: ts.Program, input: TierAnalysisInput): TierReport {
const resolver = new UnitResolver(program.getTypeChecker());
const requests: DemotionRequest[] = [];
const add = (diags: readonly ScrDiagnostic[], scope: DemotionScope): void => {
for (const diag of diags) {
let request: DemotionRequest | null;
try {
request = requestFor(program, resolver, diag, scope);
} catch {
// Attribution is best effort; a report never fails an analysis.
if (!isDemotionCode(diag.code)) continue;
const unit: DemotionUnit = { kind: "module", name: diag.loc.file, loc: diag.loc };
request = {
unit,
enclosing: unit,
seed: seedOf(diag.code, diag.message),
scope,
code: diag.code,
message: diag.message,
loc: diag.loc,
};
}
if (request !== null) requests.push(request);
}
};
add(input.reached, "reached");
add(input.deferred, "deferred");
add(input.unreached, "unreached");
const dynamic = dynamicFunctionReports(program, input.dynamicFunctions);
return {
mode: input.mode,
statementsDynamic: dynamic.statements,
dynamicFunctions: dynamic.functions,
requests,
units: demotedUnits(requests),
};
}
packages/compiler/src/frontend/type-mapper.ts
+380 -169
View File
@@ -9,6 +9,7 @@ import {
BOOL,
bytesOf,
canConvertToDyn,
canDynCheckTo,
CHILD_T,
CRYPTOHASH_T,
CRYPTOHMAC_T,
@@ -1034,7 +1035,7 @@ export interface TypeMapperCtx {
* inside members, self-referential member types), null outside any
* mixin context (the type alone cannot name a call site). */
mixinClassInstance?: (decl: ts.ClassLikeDeclaration) => IrType | null;
localClassInstance?: (decl: ts.ClassLikeDeclaration) => IrType | null;
localClassInstance?: (decl: ts.ClassLikeDeclaration, instanceType?: ts.Type) => IrType | null;
/** Live class protocols retain identity and receiver dispatch rather than
* copying an instance into an unrelated record layout. */
classImplementedProtocol?: (type: ts.Type) => boolean;
@@ -1701,16 +1702,38 @@ function mapTypeInner(type: ts.Type, ctx: TypeMapperCtx): IrType | null {
// Declaration-only package types have no compiled implementation.
// Primitive and container types retain their structural mappings; types
// owned by the standard library or explicit host mappings are handled
// by their dedicated native rules.
const npmSym = widened.getAliasSymbol() ?? widened.getSymbol();
const npmDecls = npmSym ? checker.declarationsOf(npmSym) : undefined;
// by their dedicated native rules. Pure type shapes — interfaces, type
// aliases, and object or mapped type literals with no value declaration
// merged in — describe data, not an implementation: a program value of
// such a type is one the program built itself (`import type` from a
// types-only package), so it maps structurally like a local declaration.
// Values the package itself would produce stay refused at their import.
const packageOnly = (sym: ts.Symbol | undefined): readonly ts.Node[] | null => {
const decls = sym ? checker.declarationsOf(sym) : undefined;
return decls &&
decls.length > 0 &&
decls.every((d) => {
const sf = d.getSourceFile();
return sf.isDeclarationFile && !ctx.isStdlibFile(sf) && !ctx.isExternalTypeFile(sf);
})
? decls
: null;
};
const pureTypeShape = (decls: readonly ts.Node[] | null): boolean =>
decls === null ||
decls.every(
(d) =>
packageTypeFile(d.getSourceFile(), ctx) &&
(ts.isInterfaceDeclaration(d) ||
ts.isTypeAliasDeclaration(d) ||
ts.isTypeLiteralNode(d) ||
ts.isMappedTypeNode(d)),
);
const aliasDecls = packageOnly(widened.getAliasSymbol());
const ownDecls = packageOnly(widened.getSymbol());
if (
npmDecls &&
npmDecls.length > 0 &&
npmDecls.every((d) => {
const sf = d.getSourceFile();
return sf.isDeclarationFile && !ctx.isStdlibFile(sf) && !ctx.isExternalTypeFile(sf);
})
(aliasDecls !== null || (widened.getAliasSymbol() === undefined && ownDecls !== null)) &&
!(pureTypeShape(aliasDecls) && pureTypeShape(ownDecls))
) {
return null;
}
@@ -1927,7 +1950,7 @@ function mapTypeInner(type: ts.Type, ctx: TypeMapperCtx): IrType | null {
}
}
if (classExprNeedsContext(classDecl)) {
const local = ctx.localClassInstance?.(classDecl);
const local = ctx.localClassInstance?.(classDecl, widened);
if (local) contextResolutions++;
return local ?? null;
}
@@ -1966,7 +1989,11 @@ function mapTypeInner(type: ts.Type, ctx: TypeMapperCtx): IrType | null {
}
}
if (classExprNeedsContext(classDecl)) {
const local = ctx.localClassInstance?.(classDecl);
const ctorSigs = checker.getConstructSignatures(widened);
const local = ctx.localClassInstance?.(
classDecl,
ctorSigs.length === 1 ? checker.getReturnTypeOfSignature(ctorSigs[0]!) : undefined,
);
if (local?.kind === "object") {
contextResolutions++;
return { kind: "classval", className: local.className };
@@ -3892,158 +3919,7 @@ function mapTypeInner(type: ts.Type, ctx: TypeMapperCtx): IrType | null {
if (hybrid) return hybrid;
}
const callSigs = checker.getCallSignatures(widened);
if (callSigs.length === 1) {
const sig = callSigs[0]!;
if (sig.getTypeParameters().length && ctx.erasingSignature !== sig) return null;
// A SYNTHESIZED rest param (tsc's JS inference for a function body
// reading `arguments` — `(...args: any[]) => any` whose args symbol
// has no declaration): the dotDotDot check below can't see it, and a
// fixed-arity func mapping would LIE about the value's calling
// convention. Detected by the param-count mismatch against the
// signature's own declaration, excluding an erased `this` parameter.
{
const sigDecl = checker.signatureDeclaration(sig);
const declParams =
sigDecl !== undefined && ts.isFunctionLike(sigDecl) ? sigDecl.parameters : undefined;
if (
declParams !== undefined &&
runtimeParameterCount(declParams) !== sig.getParameters().length
) {
return null;
}
// tsgo never SYNTHESIZES that rest param into the inferred signature
// (5.9.3 did — the count mismatch above was the whole detector
// there), so the declaration's own body answers directly.
if (sigDecl !== undefined && ts.isFunctionLike(sigDecl) && bodyReadsArguments(sigDecl)) {
return null;
}
}
const params: IrType[] = [];
let typedRest = false;
for (const p of sig.getParameters()) {
const decl = checker.valueDeclarationOf(p);
const rest = decl !== undefined && ts.isParameter(decl) && decl.dotDotDotToken !== undefined;
// arity ABI selected by lambdaSignature. Treating an inferred any[]
// declaration as a typed packed-array closure would bypass its boxed
// spread/error semantics and change coverage classification.
if (rest && decl !== undefined && isJsSourceFile(decl.getSourceFile())) return null;
const optional =
decl !== undefined &&
ts.isParameter(decl) &&
(decl.questionToken !== undefined || decl.initializer !== undefined);
let pt = mapType(checker.getTypeOfSymbol(p), ctx);
if (
decl &&
ts.isParameter(decl) &&
ts.isSetAccessorDeclaration(decl.parent) &&
isJsSourceFile(decl.getSourceFile())
)
pt = DYN;
// An inferred JavaScript binding pattern consumes an iterable; it
// does not require the caller's array to have exactly this length.
const executor = decl && ts.isParameter(decl) ? decl.parent : null;
const construction = executor?.parent;
const constructorSymbol =
construction && ts.isNewExpression(construction)
? checker.getSymbolAtLocation(construction.expression)
: undefined;
const nativeExecutor =
executor &&
(ts.isArrowFunction(executor) || ts.isFunctionExpression(executor)) &&
construction &&
ts.isNewExpression(construction) &&
construction.arguments?.[0] === executor &&
ts.isIdentifier(construction.expression) &&
construction.expression.text === "Promise" &&
constructorSymbol &&
checker
.declarationsOf(constructorSymbol)
.some((site) => ctx.isStdlibFile(site.getSourceFile()));
if (
!nativeExecutor &&
decl &&
ts.isParameter(decl) &&
!decl.dotDotDotToken &&
!ts.isSetAccessorDeclaration(decl.parent) &&
isJsSourceFile(decl.getSourceFile()) &&
!decl.type &&
!/@(?:param|type)\b/.test(
decl.getSourceFile().text.slice(decl.parent?.pos ?? decl.pos, decl.getStart()),
)
)
pt = DYN;
if (pt) pt = jsOpenObjectType(decl, pt, ctx.shapes, ctx.unions);
// Belt and braces for non-strict type worlds: an optional param's
// ABI slot is always the undefined-armed union (strictNullChecks
// already spells it that way; arm it here if the world didn't).
if (optional && pt && pt.kind !== "void" && pt.kind !== "dyn") {
const armed = withUndefinedArm(pt, ctx.unions);
if (!armed) return null;
pt = armed;
}
if (!pt) return null;
if (rest) {
if (pt.kind !== "array") return null;
typedRest = true;
}
// `(value: void) => void` (Promise<void>'s resolve) is callable with
// no arguments — a void param is dropped, not a mapping failure.
if (pt.kind === "void") continue;
params.push(pt);
}
const retT = checker.getReturnTypeOfSignature(sig);
// `() => never` (a throw-only lambda's inferred type) is assignable to
// `() => void` and its calls never produce a value — map the return
// like declaredReturnType does for declarations. JS null/undefined
// returns can read mutable fields, so callable values use the same
// checked-native return ABI as their implementations.
const sigDecl = checker.signatureDeclaration(sig);
const jsUnitReturn =
sigDecl !== undefined &&
isJsSourceFile(sigDecl.getSourceFile()) &&
(retT.flags & (ts.TypeFlags.Null | ts.TypeFlags.Undefined)) !== 0;
let ret =
jsUnitReturn || (retT.flags & ts.TypeFlags.Any) !== 0
? DYN
: retT.flags & ts.TypeFlags.Never
? VOID
: mapType(retT, ctx);
if (sigDecl && ts.isGetAccessorDeclaration(sigDecl) && isJsSourceFile(sigDecl.getSourceFile()))
ret = DYN;
if (sigDecl && isJsSourceFile(sigDecl.getSourceFile()) && ret?.kind === "array") ret = DYN;
if (
sigDecl &&
ts.isFunctionLike(sigDecl) &&
isJsSourceFile(sigDecl.getSourceFile()) &&
!sigDecl.type &&
!/@returns?\b/.test(sigDecl.getSourceFile().text.slice(sigDecl.pos, sigDecl.getStart())) &&
ret?.kind === "record"
)
ret = DYN;
if (
sigDecl &&
ts.isFunctionLike(sigDecl) &&
isJsSourceFile(sigDecl.getSourceFile()) &&
!sigDecl.type &&
!/@returns?\b/.test(sigDecl.getSourceFile().text.slice(sigDecl.pos, sigDecl.getStart())) &&
(ret?.kind === "date" ||
(ret?.kind === "union" &&
ctx.unions.get(ret.unionId)?.arms.some((arm) => arm.kind === "func")))
)
ret = DYN;
if (
ret &&
sigDecl &&
isJsSourceFile(sigDecl.getSourceFile()) &&
functionCanReturnUndefined(sigDecl)
)
ret = withUndefinedArm(ret, ctx.unions) ?? ret;
if (!ret) return null;
return typedRest
? { kind: "func", params, ret, rest: true, restAbi: "typed" }
: funcOf(params, ret);
}
if (callSigs.length === 1) return mapCallSignature(callSigs[0]!, ctx);
// Records: object types whose members are all data properties (shorthand
// methods in type position count — they're func-typed fields) with
// mappable types; no call/construct signatures, no index signatures, not
@@ -4317,6 +4193,162 @@ function mapTypeInner(type: ts.Type, ctx: TypeMapperCtx): IrType | null {
return null;
}
/** One non-overloaded call signature's func type (mapTypeInner's
* single-signature rule; erasedOverloadMemberType maps each overload of a
* member through it). */
function mapCallSignature(sig: ts.Signature, ctx: TypeMapperCtx): IrType | null {
const { checker } = ctx;
if (sig.getTypeParameters().length && ctx.erasingSignature !== sig) return null;
// A SYNTHESIZED rest param (tsc's JS inference for a function body
// reading `arguments` — `(...args: any[]) => any` whose args symbol
// has no declaration): the dotDotDot check below can't see it, and a
// fixed-arity func mapping would LIE about the value's calling
// convention. Detected by the param-count mismatch against the
// signature's own declaration, excluding an erased `this` parameter.
{
const sigDecl = checker.signatureDeclaration(sig);
const declParams =
sigDecl !== undefined && ts.isFunctionLike(sigDecl) ? sigDecl.parameters : undefined;
if (
declParams !== undefined &&
runtimeParameterCount(declParams) !== sig.getParameters().length
) {
return null;
}
// tsgo never SYNTHESIZES that rest param into the inferred signature
// (5.9.3 did — the count mismatch above was the whole detector
// there), so the declaration's own body answers directly.
if (sigDecl !== undefined && ts.isFunctionLike(sigDecl) && bodyReadsArguments(sigDecl)) {
return null;
}
}
const params: IrType[] = [];
let typedRest = false;
for (const p of sig.getParameters()) {
const decl = checker.valueDeclarationOf(p);
const rest = decl !== undefined && ts.isParameter(decl) && decl.dotDotDotToken !== undefined;
// arity ABI selected by lambdaSignature. Treating an inferred any[]
// declaration as a typed packed-array closure would bypass its boxed
// spread/error semantics and change coverage classification.
if (rest && decl !== undefined && isJsSourceFile(decl.getSourceFile())) return null;
const optional =
decl !== undefined &&
ts.isParameter(decl) &&
(decl.questionToken !== undefined || decl.initializer !== undefined);
let pt = mapType(checker.getTypeOfSymbol(p), ctx);
if (
decl &&
ts.isParameter(decl) &&
ts.isSetAccessorDeclaration(decl.parent) &&
isJsSourceFile(decl.getSourceFile())
)
pt = DYN;
// An inferred JavaScript binding pattern consumes an iterable; it
// does not require the caller's array to have exactly this length.
const executor = decl && ts.isParameter(decl) ? decl.parent : null;
const construction = executor?.parent;
const constructorSymbol =
construction && ts.isNewExpression(construction)
? checker.getSymbolAtLocation(construction.expression)
: undefined;
const nativeExecutor =
executor &&
(ts.isArrowFunction(executor) || ts.isFunctionExpression(executor)) &&
construction &&
ts.isNewExpression(construction) &&
construction.arguments?.[0] === executor &&
ts.isIdentifier(construction.expression) &&
construction.expression.text === "Promise" &&
constructorSymbol &&
checker
.declarationsOf(constructorSymbol)
.some((site) => ctx.isStdlibFile(site.getSourceFile()));
if (
!nativeExecutor &&
decl &&
ts.isParameter(decl) &&
!decl.dotDotDotToken &&
!ts.isSetAccessorDeclaration(decl.parent) &&
isJsSourceFile(decl.getSourceFile()) &&
!decl.type &&
!/@(?:param|type)\b/.test(
decl.getSourceFile().text.slice(decl.parent?.pos ?? decl.pos, decl.getStart()),
)
)
pt = DYN;
if (pt) pt = jsOpenObjectType(decl, pt, ctx.shapes, ctx.unions);
// Belt and braces for non-strict type worlds: an optional param's
// ABI slot is always the undefined-armed union (strictNullChecks
// already spells it that way; arm it here if the world didn't).
if (optional && pt && pt.kind !== "void" && pt.kind !== "dyn") {
const armed = withUndefinedArm(pt, ctx.unions);
if (!armed) return null;
pt = armed;
}
if (!pt) return null;
if (rest) {
if (pt.kind !== "array") return null;
typedRest = true;
}
// `(value: void) => void` (Promise<void>'s resolve) is callable with
// no arguments — a void param is dropped, not a mapping failure.
if (pt.kind === "void") continue;
params.push(pt);
}
const retT = checker.getReturnTypeOfSignature(sig);
// `() => never` (a throw-only lambda's inferred type) is assignable to
// `() => void` and its calls never produce a value — map the return
// like declaredReturnType does for declarations. JS null/undefined
// returns can read mutable fields, so callable values use the same
// checked-native return ABI as their implementations.
const sigDecl = checker.signatureDeclaration(sig);
const jsUnitReturn =
sigDecl !== undefined &&
isJsSourceFile(sigDecl.getSourceFile()) &&
(retT.flags & (ts.TypeFlags.Null | ts.TypeFlags.Undefined)) !== 0;
let ret =
jsUnitReturn || (retT.flags & ts.TypeFlags.Any) !== 0
? DYN
: retT.flags & ts.TypeFlags.Never
? VOID
: mapType(retT, ctx);
if (sigDecl && ts.isGetAccessorDeclaration(sigDecl) && isJsSourceFile(sigDecl.getSourceFile()))
ret = DYN;
if (sigDecl && isJsSourceFile(sigDecl.getSourceFile()) && ret?.kind === "array") ret = DYN;
if (
sigDecl &&
ts.isFunctionLike(sigDecl) &&
isJsSourceFile(sigDecl.getSourceFile()) &&
!sigDecl.type &&
!/@returns?\b/.test(sigDecl.getSourceFile().text.slice(sigDecl.pos, sigDecl.getStart())) &&
ret?.kind === "record"
)
ret = DYN;
if (
sigDecl &&
ts.isFunctionLike(sigDecl) &&
isJsSourceFile(sigDecl.getSourceFile()) &&
!sigDecl.type &&
!/@returns?\b/.test(sigDecl.getSourceFile().text.slice(sigDecl.pos, sigDecl.getStart())) &&
(ret?.kind === "date" ||
(ret?.kind === "union" &&
ctx.unions.get(ret.unionId)?.arms.some((arm) => arm.kind === "func")))
)
ret = DYN;
if (
ret &&
sigDecl &&
isJsSourceFile(sigDecl.getSourceFile()) &&
functionCanReturnUndefined(sigDecl)
)
ret = withUndefinedArm(ret, ctx.unions) ?? ret;
if (!ret) return null;
return typedRest
? { kind: "func", params, ret, rest: true, restAbi: "typed" }
: funcOf(params, ret);
}
/** Retain a literal discriminator before widening erases its values. A
* structural match alone is insufficient: `{ kind: "loop", body: ... }`
* also fits a smaller `{ kind: "empty" }` record. Choosing that layout
@@ -5421,6 +5453,17 @@ function isMappedShape(t: ts.Type): boolean {
);
}
/** A declaration file an installed package ships (its own or an @types
* twin), outside the standard library and @types/node: the type surface
* of a package the program does not compile. Its pure type shapes —
* interfaces, aliases, type literals — describe data a program can build
* itself (`import type` from a types-only package such as type-fest). */
function packageTypeFile(sf: ts.SourceFile, ctx: Pick<TypeMapperCtx, "isStdlibFile">): boolean {
return (
sf.isDeclarationFile && /[\\/]node_modules[\\/]/.test(sf.fileName) && !ctx.isStdlibFile(sf)
);
}
/** The record path's provenance fence. Declared shapes (object literals,
* interfaces, type literals) must come from user code or an explicitly
* mapped external type surface, never an arbitrary .d.ts — the empty
@@ -5459,13 +5502,14 @@ function recordProvenanceOk(t: ts.Type, ctx: TypeMapperCtx): boolean {
.every(
(decl) =>
!decl.getSourceFile().isDeclarationFile ||
ctx.isExternalTypeFile(decl.getSourceFile()),
ctx.isExternalTypeFile(decl.getSourceFile()) ||
packageTypeFile(decl.getSourceFile(), ctx),
),
);
}
return !decls.some((d) => {
const sf = d.getSourceFile();
return sf.isDeclarationFile && !ctx.isExternalTypeFile(sf);
return sf.isDeclarationFile && !ctx.isExternalTypeFile(sf) && !packageTypeFile(sf, ctx);
});
}
@@ -5551,6 +5595,164 @@ export function erasedGenericMemberType(t: ts.Type, ctx: TypeMapperCtx): IrType
return erased?.kind === "func" ? erased : undefined;
}
/** An OVERLOADED callable member type (`on(event: "a", h: (x: number) =>
* void): () => void; on(event: "b", h: (x: string) => void): () => void`
* in a program interface or type literal): two or more call signatures and
* nothing else (no data properties, construct signatures, or index
* signatures), every one declared in TypeScript program source. Such a
* member keeps a record slot holding its erased runtime function
* (erasedOverloadMemberType); calls convert per their resolved overload
* (lowerRecordFieldCall). */
export function isOverloadedCallableMemberType(t: ts.Type, checker: ts.TypeChecker): boolean {
const sigs = checker.getCallSignatures(t);
if (sigs.length < 2) return false;
if (
checker.getConstructSignatures(t).length > 0 ||
checker.getPropertiesOfType(t).length > 0 ||
checker.getIndexInfosOfType(t).length > 0
)
return false;
return sigs.every((sig) => {
const decl = checker.signatureDeclaration(sig);
if (decl === undefined) return false;
if (!ts.isMethodSignatureDeclaration(decl) && !ts.isCallSignatureDeclaration(decl))
return false;
const file = decl.getSourceFile();
return !file.isDeclarationFile && !isJsSourceFile(file);
});
}
/** Scalar arms an overload join may combine into one union. */
const OVERLOAD_JOIN_SCALARS = new Set(["f64", "string", "bool", "undefinedT", "nullT"]);
/** The join of one position's types across an overload set: equal types
* stay; scalar mixes form their union; anything else is `unknown` when
* every joined type crosses the checked-dynamic boundary in both directions
* (the call site converts into the slot, the implementation converts out
* of it). Differing callbacks (`(x: number) => void` beside `(x: string) =>
* void`) therefore travel as checked function values, which any
* implementation's own callback type adapts from. Null when no join
* exists. */
function joinOverloadTypes(types: readonly IrType[], ctx: TypeMapperCtx): IrType | null {
const first = types[0]!;
if (types.every((t) => typeEquals(t, first))) return first;
const getRecord = (id: string) => ctx.shapes.get(id);
const getUnion = (id: string) => ctx.unions.get(id);
const arms = new Map<string, IrType>();
let scalar = true;
for (const t of types) {
const parts = t.kind === "union" ? (ctx.unions.get(t.unionId)?.arms ?? []) : [t];
if (parts.length === 0) scalar = false;
for (const part of parts) {
if (!OVERLOAD_JOIN_SCALARS.has(part.kind)) scalar = false;
arms.set(typeKey(part), part);
}
}
if (scalar && [...arms.values()].some((arm) => !isUnitType(arm))) {
const sorted = [...arms.values()].sort((a, b) => (typeKey(a) < typeKey(b) ? -1 : 1));
return { kind: "union", unionId: ctx.unions.intern(sorted) };
}
if (
types.every(
(t) =>
t.kind === "dyn" ||
(t.kind !== "void" &&
canConvertToDyn(t, getRecord, getUnion) &&
canDynCheckTo(t, getRecord, getUnion)),
)
)
return DYN;
return null;
}
/** An overloaded member's runtime type (isOverloadedCallableMemberType).
* JavaScript stores ONE function under the member; overload signatures only
* constrain call sites. The slot's type joins the overloads per parameter
* position and result (joinOverloadTypes), and a position some overloads
* omit is optional. Each overload's own type parameters erase to `unknown`
* first. Calls pick their overload statically, convert arguments into the
* slot's parameter types and the result back to the overload's; an
* implementation converts into the slot like any function value. Undefined
* when the set does not join (rest parameters, a void result beside a
* value result, a component outside the checked-dynamic boundary): the
* member keeps its fence. */
export function erasedOverloadMemberType(t: ts.Type, ctx: TypeMapperCtx): IrType | undefined {
const funcs: (IrType & { kind: "func" })[] = [];
for (const sig of ctx.checker.getCallSignatures(t)) {
const own = new Set(sig.getTypeParameters());
const outer = ctx.resolveTypeParam;
const mapped = mapCallSignature(
sig,
own.size === 0
? ctx
: {
...ctx,
erasingSignature: sig,
resolveTypeParam: (param) => (own.has(param) ? DYN : (outer?.(param) ?? null)),
},
);
if (mapped?.kind !== "func" || mapped.rest === true || mapped.argumentsAll === true)
return undefined;
funcs.push(mapped);
}
const arity = Math.max(...funcs.map((f) => f.params.length));
const params: IrType[] = [];
for (let i = 0; i < arity; i++) {
const present = funcs.filter((f) => i < f.params.length).map((f) => f.params[i]!);
let param = joinOverloadTypes(present, ctx);
if (param !== null && present.length < funcs.length && param.kind !== "dyn")
param = withUndefinedArm(param, ctx.unions);
if (param === null) return undefined;
params.push(param);
}
const voids = funcs.filter((f) => f.ret.kind === "void").length;
if (voids !== 0 && voids !== funcs.length) return undefined;
const ret =
voids === funcs.length
? VOID
: joinOverloadTypes(
funcs.map((f) => f.ret),
ctx,
);
if (ret === null) return undefined;
return funcOf(params, ret);
}
/** Why an overloaded member's set has no erased type
* (erasedOverloadMemberType): the first overload, and within it the first
* parameter or result, that does not map; otherwise the join itself. A
* message tail after "its member 'name'". */
function describeOverloadSetBlocker(t: ts.Type, ctx: TypeMapperCtx): string {
const { checker } = ctx;
for (const sig of checker.getCallSignatures(t)) {
const own = new Set(sig.getTypeParameters());
const outer = ctx.resolveTypeParam;
const sigCtx: TypeMapperCtx =
own.size === 0
? ctx
: {
...ctx,
erasingSignature: sig,
resolveTypeParam: (param) => (own.has(param) ? DYN : (outer?.(param) ?? null)),
};
const mapped = mapCallSignature(sig, sigCtx);
if (mapped?.kind === "func" && mapped.rest !== true && mapped.argumentsAll !== true) continue;
const decl = checker.signatureDeclaration(sig);
const spelled = decl ? decl.getText().replace(/\s+/g, " ").replace(/;$/, "") : "";
const which = spelled ? `overload '${spelled}'` : "one overload";
if (mapped?.kind === "func")
return `is an overload set, and its ${which} has a rest parameter (an overload set stores one fixed-arity function)`;
for (const param of sig.getParameters()) {
const paramTs = checker.getTypeOfSymbol(param);
if (!mapType(paramTs, sigCtx))
return `is an overload set, and its ${which} has parameter '${param.name}' of type '${checker.typeToString(paramTs)}', which does not compile`;
}
const retTs = checker.getReturnTypeOfSignature(sig);
return `is an overload set, and its ${which} returns '${checker.typeToString(retTs)}', which does not compile`;
}
return "is an overload set whose signatures do not join into one stored function (a void result beside a value result, or positions whose differing types do not cross the checked-dynamic boundary)";
}
/** The computed pieces of a record shape mapRecordTypeInner hands back for
* the OUTER frame to intern — or, when a back-reference minted a recursive
* placeholder for the type mid-construction, to finalize INTO that
@@ -5922,7 +6124,7 @@ function mapRecordTypeInner(
computed &&
checker.declarationsOf(p).some((d) => {
const sf = d.getSourceFile();
return sf.isDeclarationFile && !ctx.isExternalTypeFile(sf);
return sf.isDeclarationFile && !ctx.isExternalTypeFile(sf) && !packageTypeFile(sf, ctx);
})
) {
return null;
@@ -5932,9 +6134,14 @@ function mapRecordTypeInner(
// can hold them — see isGenericCallableMemberType): the shape keeps
// its data fields, and calls of the member monomorphize per call
// site against the defining object literal's declaration.
// OVERLOADED members hold their erased runtime function (see
// erasedOverloadMemberType); a set that does not join fails the
// shape as before.
let pt = isGenericCallableMemberType(fieldTs, checker)
? erasedGenericMemberType(fieldTs, ctx)
: mapType(fieldTs, ctx);
: isOverloadedCallableMemberType(fieldTs, checker)
? (erasedOverloadMemberType(fieldTs, ctx) ?? null)
: mapType(fieldTs, ctx);
if (pt === undefined) continue;
// tsgo PANICS computing `readonly []` through the symbol-type query
// (the TupleType conversion — the facade's panic fence answers
@@ -6249,12 +6456,16 @@ export function describeRecordMemberBlocker(widened: ts.Type, ctx: TypeMapperCtx
computed &&
checker.declarationsOf(p).some((d) => {
const sf = d.getSourceFile();
return sf.isDeclarationFile && !ctx.isExternalTypeFile(sf);
return sf.isDeclarationFile && !ctx.isExternalTypeFile(sf) && !packageTypeFile(sf, ctx);
})
) {
return null;
}
const fieldTs = checker.getTypeOfSymbol(p);
if (isOverloadedCallableMemberType(fieldTs, checker)) {
if (erasedOverloadMemberType(fieldTs, ctx) !== undefined) continue;
return `the record shape is supported, but its member '${p.name}' ${describeOverloadSetBlocker(fieldTs, ctx)}`;
}
let pt = isGenericCallableMemberType(fieldTs, checker)
? erasedGenericMemberType(fieldTs, ctx)
: mapType(fieldTs, ctx);
packages/compiler/src/frontend/type-only-imports.ts
+143
View File
@@ -0,0 +1,143 @@
/** Type-only module edges under Node's type stripping.
*
* Node runs TypeScript by erasing types in place, with the semantics of
* `verbatimModuleSyntax`: `import type …` and `export type … from` vanish,
* but `import { type A } from "./m"` and `export { type A } from "./m"`
* keep an empty clause (`import {} from "./m"`) and still load and
* evaluate `./m`. Only the erased forms are absent from Node's module
* graph. */
import * as ts from "./ts7/adapter.js";
import { moduleSourceCandidates } from "./module-source-candidates.js";
/** `import type …` (default, named, or namespace): erased by Node, so
* module order, cycle detection, init calls, package selection, and the
* startup-refusal probe must not count it (zod v4's core modules are
* "cyclic" only through `import type * as ns` namespaces, and a
* type-only import of a module Node cannot resolve is not a startup
* crash). Side-effect imports and inline `type` specifiers stay real
* edges. */
export function erasedTypeOnlyImport(stmt: ts.ImportDeclaration): boolean {
return stmt.importClause?.phaseModifier === ts.SyntaxKind.TypeKeyword;
}
/** `import { type A, type B } from "./m"`: a real module edge that binds
* nothing at runtime, exactly like a side-effect import. */
export function typeOnlyNamedImport(stmt: ts.ImportDeclaration): boolean {
const clause = stmt.importClause;
return (
clause !== undefined &&
clause.phaseModifier !== ts.SyntaxKind.TypeKeyword &&
clause.name === undefined &&
clause.namedBindings !== undefined &&
ts.isNamedImports(clause.namedBindings) &&
clause.namedBindings.elements.length > 0 &&
clause.namedBindings.elements.every((e) => e.isTypeOnly)
);
}
/** One module reference of a program file: its specifier and whether
* Node erases it. */
interface ModuleReference {
spec: string;
erased: boolean;
kind?: "import" | "require";
}
function declarationReferencesOf(sf: ts.SourceFile): ModuleReference[] {
const refs: ModuleReference[] = [];
for (const stmt of sf.statements) {
if (ts.isImportDeclaration(stmt)) {
if (ts.isStringLiteral(stmt.moduleSpecifier))
refs.push({ spec: stmt.moduleSpecifier.text, erased: erasedTypeOnlyImport(stmt) });
} else if (ts.isExportDeclaration(stmt)) {
if (stmt.moduleSpecifier !== undefined && ts.isStringLiteral(stmt.moduleSpecifier))
refs.push({ spec: stmt.moduleSpecifier.text, erased: stmt.isTypeOnly });
} else if (
ts.isImportEqualsDeclaration(stmt) &&
ts.isExternalModuleReference(stmt.moduleReference) &&
ts.isStringLiteralLike(stmt.moduleReference.expression)
) {
refs.push({
spec: stmt.moduleReference.expression.text,
erased: stmt.isTypeOnly,
kind: "require",
});
}
}
return refs;
}
/** Every call with a leading string literal counts as a loading edge —
* require(), import(), createRequire'd require functions, and loader
* helpers alike. Over-counting only keeps a file in the graph. */
function callReferencesOf(program: ts.Program, sf: ts.SourceFile): ModuleReference[] {
const refs: ModuleReference[] = [];
for (const node of moduleSourceCandidates(program, sf).calls) {
const arg = node.arguments[0];
if (arg === undefined || !ts.isStringLiteralLike(arg)) continue;
refs.push({
spec: arg.text,
erased: false,
kind: node.expression.kind === ts.SyntaxKind.ImportKeyword ? "import" : "require",
});
}
return refs;
}
/** The program files Node never loads because the only references that
* reach them are erased type-only forms (directly or through other such
* files). A file referenced by nothing at all (a program root, or a file
* reached through a reference this walk does not model, such as an
* `import("./m")` type query) keeps its place, as do `extraRoots` (fork
* and worker targets). Empty when no erased reference resolves to a
* program file — the common case pays one statement scan per file. */
export function typeOnlyReachedFiles(
program: ts.Program,
entry: ts.SourceFile,
files: readonly ts.SourceFile[],
extraRoots: () => readonly string[],
resolveEdge: (
from: ts.SourceFile,
spec: string,
resolutionKind?: "import" | "require",
) => ts.SourceFile | null,
): Set<ts.SourceFile> {
const available = new Set(files);
const declarationRefs = new Map(files.map((sf) => [sf, declarationReferencesOf(sf)] as const));
const target = (sf: ts.SourceFile, ref: ModuleReference): ts.SourceFile | null => {
const dep = resolveEdge(sf, ref.spec, ref.kind);
return dep === null || dep === sf || !available.has(dep) ? null : dep;
};
if (
!files.some((sf) =>
declarationRefs.get(sf)!.some((ref) => ref.erased && target(sf, ref) !== null),
)
)
return new Set();
const valueEdges = new Map<ts.SourceFile, ts.SourceFile[]>();
const referenced = new Set<ts.SourceFile>();
for (const sf of files) {
const deps: ts.SourceFile[] = [];
valueEdges.set(sf, deps);
for (const ref of [...declarationRefs.get(sf)!, ...callReferencesOf(program, sf)]) {
const dep = target(sf, ref);
if (dep === null) continue;
referenced.add(dep);
if (!ref.erased) deps.push(dep);
}
}
const roots = files.filter((sf) => sf === entry || !referenced.has(sf));
for (const path of extraRoots()) {
const sf = program.getSourceFile(path);
if (sf !== undefined && available.has(sf)) roots.push(sf);
}
const reached = new Set<ts.SourceFile>();
const queue = [...roots];
while (queue.length > 0) {
const sf = queue.pop()!;
if (reached.has(sf)) continue;
reached.add(sf);
for (const dep of valueEdges.get(sf) ?? []) if (!reached.has(dep)) queue.push(dep);
}
return new Set(files.filter((sf) => !reached.has(sf)));
}
packages/compiler/src/index.ts
+18
View File
@@ -172,11 +172,22 @@ export {
} from "./diagnostics/render.js";
export {
renderCoverage,
renderExplainDynamic,
coverageEnvelope,
coveragePasses,
type CoverageInput,
type CoverageFailOn,
} from "./coverage/report.js";
export {
TIER_MODES,
type DemotedUnit,
type DemotionRequest,
type DemotionSeed,
type DemotionUnit,
type DemotionUnitKind,
type TierMode,
type TierReport,
} from "./frontend/tier-analysis.js";
export {
buildEnvelope,
DIAGNOSTICS_SCHEMA_VERSION,
@@ -208,6 +219,13 @@ export {
} from "./compat/fetch-profile.js";
export { LIB_FN_SIGS } from "./ir/builtin-signatures.js";
export { validateModule } from "./ir/validate.js";
export {
assignLegacyTiers,
dynamicOperationOf,
functionTier,
type DynamicFunction,
type IrTier,
} from "./ir/tiers.js";
export {
deserializeModule,
deserializeModuleBytes,
packages/compiler/src/ir/builtin-effects.ts
+8
View File
@@ -137,6 +137,7 @@ export const MAY_THROW_LIB_FNS: ReadonlySet<IrLibFn> = new Set([
"fetch.streamFrom",
"num.toFixed",
"num.toStringRadix",
"num.toStringRadixF64",
"insp.jsonDyn",
// diagnostics_channel: publish runs subscribers synchronously (a throw
// propagates — the documented divergence from triggerUncaughtException);
@@ -491,6 +492,13 @@ export const MAY_THROW_LIB_FNS: ReadonlySet<IrLibFn> = new Set([
"str.encodeUri",
"qs.escape",
"qs.stringify",
// node:punycode's RangeErrors (encode/toASCII only past 32-bit deltas)
// and String.fromCodePoint's for ucs2.encode.
"punycode.decode",
"punycode.encode",
"punycode.toASCII",
"punycode.toUnicode",
"punycode.ucs2Encode",
// The base64 globals: atob/btoa throw the catchable DOMException
// InvalidCharacterError on malformed input; the zero-argument form
// always throws Node's TypeError [ERR_MISSING_ARGS].
packages/compiler/src/ir/builtin-signatures.ts
+20
View File
@@ -581,6 +581,10 @@ export const LIB_FN_SIGS = defineLibFnSignatures({
/** os.constants: the per-thread null-prototype constants object (dlopen,
* errno, signals, priority, UV_UDP_REUSEADDR). Never throws. */
"os.constants": { argTypes: [], result: DYN },
/** The deprecated node:constants object (scr_os.c): the os groups and
* fs.constants merged with the borrowed baked crypto.constants table,
* frozen, one per thread. */
"constants.object": { argTypes: [DYN], result: DYN },
/** umask(2): arg < 0 reads without setting (umask has no read-only form
* — set 0, restore); otherwise sets and answers the PREVIOUS mask.
* Never throws. */
@@ -769,6 +773,9 @@ export const LIB_FN_SIGS = defineLibFnSignatures({
"num.toFixed0": { argTypes: [F64], result: STRING },
"num.toFixed": { argTypes: [F64, F64], result: STRING },
"num.toStringRadix": { argTypes: [F64, DYN], result: STRING },
/** toString(radix) with a number radix (scr_lib.c): truncates it as
* ToIntegerOrInfinity does, THROWS RangeError outside 2..36. */
"num.toStringRadixF64": { argTypes: [F64, F64], result: STRING },
/** Object.is over two numbers — the spec's SameValue on doubles: NaN
* equals NaN, +0 differs from -0, everything else is `===`. Plain bool
* result; never throws. (Union-armed operands take unionEq's sameValue
@@ -879,6 +886,19 @@ export const LIB_FN_SIGS = defineLibFnSignatures({
"url.legacyResolve": { argTypes: [DYN, DYN, BOOL], result: STRING },
"url.domainToASCII": { argTypes: [DYN, BOOL], result: STRING },
"url.domainToUnicode": { argTypes: [DYN, BOOL], result: STRING },
/** node:punycode (scr_url.c): punycode.js 2.1.0's string conversions;
* decode/toUnicode (and, past 32-bit deltas, encode/toASCII) throw the
* module's RangeErrors, ucs2Encode String.fromCodePoint's. warn marks the
* module's first load (scr_async_dyn.c) and reports DEP0040 then unless
* the second argument is false: at once for a static ES import, on the
* next tick for a require() call. */
"punycode.decode": { argTypes: [STRING], result: STRING },
"punycode.encode": { argTypes: [STRING], result: STRING },
"punycode.toASCII": { argTypes: [STRING], result: STRING },
"punycode.toUnicode": { argTypes: [STRING], result: STRING },
"punycode.ucs2Decode": { argTypes: [STRING], result: arrayOf(F64) },
"punycode.ucs2Encode": { argTypes: [arrayOf(F64)], result: STRING },
"punycode.warn": { argTypes: [BOOL, BOOL], result: VOID },
"url.fileURLToPathBuffer": { argTypes: [DYN, DYN], result: BYTES_U8 },
"url.pathToFileURLChecked": { argTypes: [DYN, DYN], result: URL_T },
"url.fileURLToPathStr": { argTypes: [STRING], result: STRING },
packages/compiler/src/ir/ir.ts
+8
View File
@@ -1656,6 +1656,14 @@ export interface IrFunction {
sourceName?: string;
/** Ordinary authored function declarations/expressions own a prototype. */
ownsPrototype?: true;
/** The function's execution tier (ir/tiers.ts). Absent means static: the
* function may use dynamic values only through boundary operations
* (dynFrom, dynCheck, kind tests) and moves, which the validator enforces
* (invariant I1). "dynamic" admits the dynamic operation vocabulary
* (dynKeyGet, dynCall, dyn.* builtins, ...). Lowering assigns the field
* from the body (assignLegacyTiers); stage S2 of the two-tier design
* keeps it out of serialized IR, so loaders derive it again. */
tier?: "dynamic";
body: IrStmt[];
loc: SrcLoc;
}
packages/compiler/src/ir/runtime-features.ts
+2
View File
@@ -46,6 +46,8 @@ export interface RuntimeFeatures {
}
const DYN_ASYNC_LIB_FNS: ReadonlySet<IrLibFn> = new Set([
// DEP0040 rides the dyn-async unit's warning machinery.
"punycode.warn",
"fs.callbackValue",
"fs.callbackCall",
"fs.callbackGlob",
packages/compiler/src/ir/serialize.ts
+18 -6
View File
@@ -7,6 +7,7 @@
* text parts and decoded from bytes one function at a time; neither direction
* materializes the complete document as a single string. */
import type { IrExpr, IrFunction, IrModule, IrStmt } from "./ir.js";
import { deriveModuleTiers } from "./tiers.js";
// Version 16 removes embedded-engine types, operations, and module metadata.
// Older modules can require runtime support that no longer exists.
@@ -42,6 +43,19 @@ function encodeNumber(_key: string, value: unknown): unknown {
return value;
}
/** Stage S2 of the two-tier design keeps function tiers out of IR
* artifacts, so a report-only release changes no serialized byte; loaders
* derive them again (deriveModuleTiers). No IR node other than a function
* carries a `tier` key. */
function encodeWithoutTier(key: string, value: unknown): unknown {
return key === "tier" ? undefined : encodeNumber(key, value);
}
function encodeFunction(fn: IrFunction): string | undefined {
if (fn.tier !== undefined) return JSON.stringify(fn, encodeWithoutTier);
return ordinaryNumbers(fn) ? JSON.stringify(fn) : JSON.stringify(fn, encodeNumber);
}
/** The compact encoding as ordered parts: the module header up to the
* function array, one part per function (with separate comma parts), and the
* header's remainder. Concatenating the parts yields exactly
@@ -58,9 +72,7 @@ export function serializeModuleParts(mod: IrModule): string[] {
for (let index = 0; index < mod.functions.length; index++) {
const fn = mod.functions[index]!;
if (index > 0) parts.push(",");
parts.push(
(ordinaryNumbers(fn) ? JSON.stringify(fn) : JSON.stringify(fn, encodeNumber)) ?? "null",
);
parts.push(encodeFunction(fn) ?? "null");
}
parts.push("]" + header.slice(offset + slot.length));
return parts;
@@ -70,7 +82,7 @@ export function serializeModuleParts(mod: IrModule): string[] {
* readable default. Both return one string, so modules whose encoding
* exceeds the host's string limit must use `serializeModuleParts`. */
export function serializeModule(mod: IrModule, compact = false): string {
if (!compact) return JSON.stringify(mod, encodeNumber, 2);
if (!compact) return JSON.stringify(mod, encodeWithoutTier, 2);
return serializeModuleParts(mod).join("");
}
@@ -96,7 +108,7 @@ function checkedVersion(mod: IrModule): IrModule {
}
export function deserializeModule(json: string): IrModule {
return checkedVersion(JSON.parse(json, decodeNumber) as IrModule);
return deriveModuleTiers(checkedVersion(JSON.parse(json, decodeNumber) as IrModule));
}
/** A node as it reads back from the compact encoding: a fresh object, as
@@ -249,5 +261,5 @@ export function deserializeModuleBytes(bytes: Buffer): IrModule {
);
}
mod.functions = functions;
return mod;
return deriveModuleTiers(mod);
}
packages/compiler/src/ir/tiers.test.ts
+142
View File
@@ -0,0 +1,142 @@
import { expect, test } from "vitest";
import { BOOL, DYN, F64, STRING, VOID, type IrExpr, type IrFunction, type IrModule } from "./ir.js";
import {
deserializeModule,
deserializeModuleBytes,
serializeModule,
serializeModuleParts,
} from "./serialize.js";
import {
assignLegacyTiers,
dynamicOperationOf,
firstDynamicOperation,
functionTier,
} from "./tiers.js";
import { validateModule } from "./validate.js";
const loc = { file: "tiers.ts", start: 0, end: 0 };
const dynParam = { kind: "varRef", localId: "v", type: DYN, loc } as const satisfies IrExpr;
function fn(name: string, value: IrExpr): IrFunction {
return {
name,
params: [{ localId: "v", name: "v", type: DYN }],
returnType: value.type,
locals: [{ id: "v", name: "v", type: DYN, mutable: false }],
body: [{ kind: "return", value, loc }],
loc,
};
}
function moduleOf(...functions: IrFunction[]): IrModule {
const main: IrFunction = {
name: "%main",
params: [],
returnType: VOID,
locals: [],
body: [],
loc,
};
return { irVersion: 16, sourceFile: "tiers.ts", functions: [main, ...functions], entry: "%main" };
}
const keyGet: IrExpr = {
kind: "dynKeyGet",
key: { kind: "strLit", value: "name", type: STRING, loc },
value: dynParam,
type: DYN,
loc,
};
test("dynamic operations and boundary operations are told apart", () => {
expect(dynamicOperationOf(keyGet)).toBe("dynKeyGet");
expect(
dynamicOperationOf({
kind: "libCall",
fn: "dyn.add",
args: [dynParam, dynParam],
type: DYN,
loc,
}),
).toBe("dyn.add");
expect(
dynamicOperationOf({
kind: "call",
callee: "%dyn.class.property.12",
args: [dynParam],
type: DYN,
loc,
}),
).toBe("%dyn.class.property");
// Boundary operations: conversions and kind tests.
expect(dynamicOperationOf({ kind: "dynCheck", value: dynParam, type: F64, loc })).toBeNull();
expect(
dynamicOperationOf({
kind: "dynFrom",
value: { kind: "numLit", value: 1, type: F64, loc },
type: DYN,
loc,
}),
).toBeNull();
expect(
dynamicOperationOf({ kind: "dynTest", test: "string", value: dynParam, type: BOOL, loc }),
).toBeNull();
expect(
dynamicOperationOf({ kind: "libCall", fn: "dyn.typedRefIs", args: [dynParam], type: DYN, loc }),
).toBeNull();
// Moves and calls of ordinary functions.
expect(dynamicOperationOf(dynParam)).toBeNull();
expect(
dynamicOperationOf({ kind: "call", callee: "helper", args: [dynParam], type: DYN, loc }),
).toBeNull();
});
test("lowering's classification puts exactly the functions with dynamic operations in the dynamic tier", () => {
const reader = fn("reader", keyGet);
const mover = fn("mover", dynParam);
const dynamic = assignLegacyTiers([reader, mover]);
expect(dynamic.map((d) => [d.name, d.operation])).toEqual([["reader", "dynKeyGet"]]);
expect(functionTier(reader)).toBe("dynamic");
expect(functionTier(mover)).toBe("static");
expect(firstDynamicOperation(mover)).toBeNull();
});
test("the validator enforces I1: static functions perform no dynamic operation", () => {
const reader = fn("reader", keyGet);
const errors = validateModule(moduleOf(reader));
expect(errors.map((e) => e.message)).toEqual([
"in reader: static-tier function performs the dynamic operation dynKeyGet",
]);
reader.tier = "dynamic";
expect(validateModule(moduleOf(reader))).toEqual([]);
// A logical operator over dynamic values applies ToBoolean to them.
const either = fn("either", {
kind: "logical",
op: "||",
left: dynParam,
right: dynParam,
type: DYN,
loc,
});
expect(validateModule(moduleOf(either)).map((e) => e.message)).toEqual([
"in either: static-tier function performs the dynamic operation logical",
]);
});
test("serialized IR carries no tiers in stage S2, and loading derives them again", () => {
const reader = fn("reader", keyGet);
const mod = moduleOf(reader);
const untiered = serializeModule(mod, true);
assignLegacyTiers(mod.functions);
expect(reader.tier).toBe("dynamic");
expect(serializeModule(mod, true)).toBe(untiered);
expect(serializeModuleParts(mod).join("")).toBe(untiered);
expect(serializeModule(mod)).not.toContain('"tier"');
for (const loaded of [
deserializeModule(untiered),
deserializeModuleBytes(Buffer.from(untiered)),
]) {
expect(loaded.functions.map(functionTier)).toEqual(["static", "dynamic"]);
expect(validateModule(loaded)).toEqual([]);
}
});
packages/compiler/src/ir/tiers.ts
+157
View File
@@ -0,0 +1,157 @@
/* Execution tiers (two-tier design, stage S2: report-only).
*
* Every IR function belongs to one of two tiers:
*
* - static: today's compiler. Exact layouts, direct calls, unboxed values.
* A static function may hold dynamic (`dyn`) values, pass them to calls,
* return them and store them, and it may cross the boundary with the
* boundary operations below, but it never operates on a dynamic value.
* - dynamic: code that operates on dynamic values with JavaScript semantics
* (property reads and writes, generic operators, calls of dynamic values,
* dynamic object and array construction).
*
* Invariant I1 (validate.ts): a static function contains no dynamic
* operation. Only boundary operations and moves may mix the tiers. Calls
* of generated `%dyn.*` helpers count as dynamic operations: they are the
* dynamic dispatch the lowering placed out of line. Calls of other dynamic
* functions are boundaries (the design's "call to a dynamic function").
*
* Boundary operations:
* - `dynFrom` (static to dynamic, the design's `toJs`) and `caughtToDyn`;
* - `dynCheck` (dynamic to static, the design's `fromJs`);
* - kind tests that only inspect a dynamic value's tag (`dynTest`, the
* `dyn.*Is` and `dyn.typeof` builtins): the tag test of a conversion;
* - calls of non-`dyn.*` builtins whose signatures take or return `dyn`
* (typed APIs implemented through dyn, leak L6 of the design). They stay
* boundaries until stage S1 gives them typed signatures.
*
* Classification of existing code. The `dyn` vocabulary is today's
* dynamic tier (`ScrDyn`): `any`, untyped JavaScript, unschematized
* `JSON.parse`, and the generated dynamic dispatch helpers already lower to
* it. Lowering therefore assigns tiers from function bodies: a function
* containing a dynamic operation is dynamic, every other function is static
* (`assignLegacyTiers`). Demotion (stage S6) will add tier decisions that
* do not follow from a body; until then the classification is exact, and
* the validator guards it against later passes and hand-written IR.
*
* Serialization. Stage S2 must not change any artifact, so serialized IR
* omits `tier` (serialize.ts) and loaders derive it again with the same
* classification. The next IR version serializes the field. */
import type { IrExpr, IrFunction, IrModule, SrcLoc } from "./ir.js";
import { everyStmtList, type IrVisitor } from "./traverse.js";
export type IrTier = "static" | "dynamic";
export function functionTier(fn: IrFunction): IrTier {
return fn.tier === "dynamic" ? "dynamic" : "static";
}
/** `dyn.*` builtins that only inspect a dynamic value's kind: the tag test
* half of a dynamic-to-static conversion. */
const DYN_KIND_TESTS: ReadonlySet<string> = new Set([
"dyn.typedRefIs",
"dyn.typedRefKeyIs",
"dyn.classIs",
"dyn.nativeSetIs",
"dyn.nativeMapIs",
"dyn.nativeUrlIs",
"dyn.nativeDateIs",
"dyn.nativeRegexIs",
"dyn.dataViewIs",
"dyn.typeof",
]);
const DYN_HELPER_PREFIX = "%dyn.";
/** `%dyn.class.property.12` → `%dyn.class.property`. */
function dynHelperFamily(name: string): string {
return name.replace(/(\.\d+)+$/, "");
}
/** The dynamic operation an expression performs, named for reports
* (`dynKeyGet`, `dyn.keySet`, ...), or null for static operations, boundary
* operations and moves. Only the node itself is inspected. */
export function dynamicOperationOf(e: IrExpr): string | null {
switch (e.kind) {
case "dynCall":
case "dynInvoke":
case "dynObjLit":
case "dynArrLit":
case "dynKeyGet":
case "dynHasKey":
case "dynScalarEq":
case "dynDestrCheck":
case "dynIterN":
return e.kind;
case "logical":
// `a || b` over dyn operands applies ToBoolean to a dynamic value.
return e.type.kind === "dyn" ? "logical" : null;
case "libCall":
return e.fn.startsWith("dyn.") && !DYN_KIND_TESTS.has(e.fn) ? e.fn : null;
case "call":
// Generated `%dyn.*` helpers are dynamic operations lowered out of
// line (class dynamic dispatch, dynamic HOF adapters).
return e.callee.startsWith(DYN_HELPER_PREFIX) ? dynHelperFamily(e.callee) : null;
default:
return null;
}
}
export interface DynamicOperationSite {
operation: string;
loc: SrcLoc;
}
function collectDynamicOperations(fn: IrFunction, first: boolean): DynamicOperationSite[] {
const found: DynamicOperationSite[] = [];
const visitor: IrVisitor = {
expr: (e) => {
const operation = dynamicOperationOf(e);
if (operation === null) return true;
found.push({ operation, loc: e.loc });
return !first;
},
stmt: () => true,
};
everyStmtList(fn.body, visitor);
return found;
}
/** The first dynamic operation in a function body, in traversal order. */
export function firstDynamicOperation(fn: IrFunction): DynamicOperationSite | null {
return collectDynamicOperations(fn, true)[0] ?? null;
}
/** Every dynamic operation in a function body (coverage reports). */
export function dynamicOperationSites(fn: IrFunction): DynamicOperationSite[] {
return collectDynamicOperations(fn, false);
}
/** A function the classification placed in the dynamic tier, with the
* operation that put it there. */
export interface DynamicFunction {
name: string;
loc: SrcLoc;
operation: string;
operationLoc: SrcLoc;
}
/** Assign every function its tier from its body (see the header). Returns
* the dynamic functions in module order. */
export function assignLegacyTiers(functions: readonly IrFunction[]): DynamicFunction[] {
const dynamic: DynamicFunction[] = [];
for (const fn of functions) {
const site = firstDynamicOperation(fn);
if (site === null) continue;
fn.tier = "dynamic";
dynamic.push({ name: fn.name, loc: fn.loc, operation: site.operation, operationLoc: site.loc });
}
return dynamic;
}
/** Loaders call this on deserialized modules (stage S2 serializes no
* tiers). */
export function deriveModuleTiers(mod: IrModule): IrModule {
assignLegacyTiers(mod.functions);
return mod;
}
packages/compiler/src/ir/validate.test.ts
+5 -1
View File
@@ -20,6 +20,7 @@ import {
type IrUnionDef,
} from "./ir.js";
import { deserializeModule, serializeModule } from "./serialize.js";
import { assignLegacyTiers } from "./tiers.js";
import { validateModule } from "./validate.js";
const loc = { file: "numeric-read.ts", start: 0, end: 0 };
@@ -399,7 +400,7 @@ test.each(["sortPrimitive", "toSortedPrimitive"] as const)(
);
function expressionModule(expr: IrExpr, unions: IrUnionDef[]): IrModule {
return {
const mod: IrModule = {
irVersion: 16,
sourceFile: loc.file,
entry: "main",
@@ -415,6 +416,9 @@ function expressionModule(expr: IrExpr, unions: IrUnionDef[]): IrModule {
},
],
};
// Lowering assigns tiers from function bodies (ir/tiers.ts).
assignLegacyTiers(mod.functions);
return mod;
}
test("numeric byte tokens and DataView stores validate their storage before emission", () => {
packages/compiler/src/ir/validate.ts
+12
View File
@@ -59,6 +59,7 @@ import {
import { DYN_CLASS_PROPERTIES } from "./ir.js";
import { unionWideningTags } from "./analysis.js";
import { alwaysReturns } from "./control-flow.js";
import { dynamicOperationOf, functionTier } from "./tiers.js";
import { LIB_FN_SIGS } from "./builtin-signatures.js";
/** The promisified crypto calls' value kinds besides checked-dynamic. */
@@ -1019,6 +1020,14 @@ function validateFunction(
const locals = new Map(fn.locals.map((l) => [l.id, l]));
const err = (message: string, loc: SrcLoc) =>
errors.push({ message: `in ${fn.name}: ${message}`, loc });
// Invariant I1 (ir/tiers.ts): a static function reaches dynamic values
// only through boundary operations and moves.
const staticTier = functionTier(fn) === "static";
const checkTier = (e: IrExpr): void => {
const operation = dynamicOperationOf(e);
if (operation !== null)
err(`static-tier function performs the dynamic operation ${operation}`, e.loc);
};
const asyncCaches = [
["asyncCacheGlobal", fn.asyncCacheGlobal],
@@ -1263,6 +1272,8 @@ function validateFunction(
continue;
}
if (e.kind === "logical") {
// checkExpr already checked the root's tier.
if (staticTier && e !== root) checkTier(e);
if (
e.type.kind !== "f64" &&
e.type.kind !== "string" &&
@@ -1306,6 +1317,7 @@ function validateFunction(
}
function checkExpr(e: IrExpr): void {
if (staticTier) checkTier(e);
switch (e.kind) {
case "numLit":
case "strLit":
packages/compiler/src/library/prepare.ts
+2
View File
@@ -553,6 +553,8 @@ export function prepareLibrary(
try {
lowered = fe.lower({
targetPlatform: buildPlatform,
// Library artifacts are static-tier only (two-tier design I2).
tierMode: "static-only",
...(cbImports.length > 0 ? { ffiImports: cbImports } : {}),
...(cbImports.length > 0 ? { libraryCallbacks: true } : {}),
// The profile-mapped exports are called from OUTSIDE the graph:
packages/compiler/surface-manifest.json
+57
View File
@@ -466,6 +466,13 @@
"status": "static",
"note": "recognized module (bare and node:-prefixed specifiers)"
},
{
"id": "node-builtin.constants",
"kind": "node-builtin",
"name": "constants",
"status": "static",
"note": "recognized module (bare and node:-prefixed specifiers)"
},
{
"id": "node-builtin.crypto",
"kind": "node-builtin",
@@ -2107,6 +2114,56 @@
"status": "static",
"note": "shared version dictionary containing node and openssl; other components are absent unless defined by the program"
},
{
"id": "node-builtin.punycode",
"kind": "node-builtin",
"name": "punycode",
"status": "static",
"note": "recognized module (bare and node:-prefixed specifiers)"
},
{
"id": "node-builtin.punycode.decode",
"kind": "node-builtin",
"name": "punycode.decode",
"status": "static"
},
{
"id": "node-builtin.punycode.encode",
"kind": "node-builtin",
"name": "punycode.encode",
"status": "static"
},
{
"id": "node-builtin.punycode.toASCII",
"kind": "node-builtin",
"name": "punycode.toASCII",
"status": "static"
},
{
"id": "node-builtin.punycode.toUnicode",
"kind": "node-builtin",
"name": "punycode.toUnicode",
"status": "static"
},
{
"id": "node-builtin.punycode.ucs2.decode",
"kind": "node-builtin",
"name": "punycode.ucs2.decode",
"status": "static"
},
{
"id": "node-builtin.punycode.ucs2.encode",
"kind": "node-builtin",
"name": "punycode.ucs2.encode",
"status": "static"
},
{
"id": "node-builtin.punycode.version",
"kind": "node-builtin",
"name": "punycode.version",
"status": "static",
"note": "constant value read"
},
{
"id": "node-builtin.querystring",
"kind": "node-builtin",
packages/compiler/test/ts7/baselines/order-parity/tests/corpus/5633-zlib-typed-options.ts.json
+6
View File
@@ -0,0 +1,6 @@
{
"order": [
"<repo>/tests/corpus/5633-zlib-typed-options.ts"
],
"diags": []
}
packages/compiler/test/ts7/baselines/order-parity/tests/corpus/5919-record-unions-shared-arms.ts.json
+6
View File
@@ -0,0 +1,6 @@
{
"order": [
"<repo>/tests/corpus/5919-record-unions-shared-arms.ts"
],
"diags": []
}
packages/compiler/test/ts7/baselines/order-parity/tests/corpus/5930-record-union-pointers.ts.json
+6
View File
@@ -0,0 +1,6 @@
{
"order": [
"<repo>/tests/corpus/5930-record-union-pointers.ts"
],
"diags": []
}
packages/compiler/test/ts7/baselines/order-parity/tests/corpus/5931-record-union-unit-arms.ts.json
+6
View File
@@ -0,0 +1,6 @@
{
"order": [
"<repo>/tests/corpus/5931-record-union-unit-arms.ts"
],
"diags": []
}
packages/compiler/test/ts7/baselines/order-parity/tests/corpus/5932-record-union-trees.ts.json
+6
View File
@@ -0,0 +1,6 @@
{
"order": [
"<repo>/tests/corpus/5932-record-union-trees.ts"
],
"diags": []
}
packages/compiler/test/ts7/baselines/order-parity/tests/corpus/5933-record-union-conversions.ts.json
+6
View File
@@ -0,0 +1,6 @@
{
"order": [
"<repo>/tests/corpus/5933-record-union-conversions.ts"
],
"diags": []
}
packages/compiler/test/ts7/baselines/order-parity/tests/corpus/5934-record-union-set-members.ts.json
+6
View File
@@ -0,0 +1,6 @@
{
"order": [
"<repo>/tests/corpus/5934-record-union-set-members.ts"
],
"diags": []
}
packages/compiler/test/ts7/baselines/order-parity/tests/corpus/5976-builtin-class-aliases.ts.json
+6
View File
@@ -0,0 +1,6 @@
{
"order": [
"<repo>/tests/corpus/5976-builtin-class-aliases.ts"
],
"diags": []
}
packages/compiler/test/ts7/baselines/order-parity/tests/corpus/5977-builtin-class-aliases.cjs.json
+6
View File
@@ -0,0 +1,6 @@
{
"order": [
"<repo>/tests/corpus/5977-builtin-class-aliases.cjs"
],
"diags": []
}
packages/compiler/test/ts7/baselines/order-parity/tests/corpus/5978-builtin-class-alias-modules/main.ts.json
+7
View File
@@ -0,0 +1,7 @@
{
"order": [
"<repo>/tests/corpus/5978-builtin-class-alias-modules/classes.ts",
"<repo>/tests/corpus/5978-builtin-class-alias-modules/main.ts"
],
"diags": []
}
packages/compiler/test/ts7/baselines/order-parity/tests/corpus/5997-frame-records-in-record-unions.ts.json
+6
View File
@@ -0,0 +1,6 @@
{
"order": [
"<repo>/tests/corpus/5997-frame-records-in-record-unions.ts"
],
"diags": []
}
packages/compiler/test/ts7/baselines/order-parity/tests/corpus/6051-generic-class-factory-results.ts.json
+6
View File
@@ -0,0 +1,6 @@
{
"order": [
"<repo>/tests/corpus/6051-generic-class-factory-results.ts"
],
"diags": []
}
packages/compiler/test/ts7/baselines/order-parity/tests/corpus/6102-local-class-type-query.js.json
-6
View File
@@ -1,6 +0,0 @@
{
"order": [
"<repo>/tests/corpus/6102-local-class-type-query.js"
],
"diags": []
}
packages/compiler/test/ts7/baselines/order-parity/tests/corpus/6110-cjs-speculative-wrapper-fences.cjs.json
+6
View File
@@ -0,0 +1,6 @@
{
"order": [
"<repo>/tests/corpus/6110-cjs-speculative-wrapper-fences.cjs"
],
"diags": []
}

Some files were not shown because too many files have changed in this diff Show More