@scriptc/compiler 0.0.26 → 0.0.28

package/dist/backend/cc.d.ts

@@ -248,6 +248,28 @@ export interface LibArchiveOptions {
      * matching compileC's arbitrary-input safety boundary. */
     cacheIdentity?: string;
     sanitize?: boolean;
+    /** Multi-instance library mode (the profile's abi.localize_runtime): the
+     * external symbols to KEEP global — every other scriptc external
+     * definition in the archive (the runtime's internals, the program TU's
+     * mangled functions and globals, vendor objects) is demoted to a local
+     * symbol. Toolchain sanitizer ABI remains external as required,
+     * so N archives built under pairwise-distinct prefixes link into one
+     * process with no symbol collisions and no shared mutable runtime state.
+     * Undefined references (the target C/math runtime and system APIs, plus
+     * sanitizer ABI in instrumented builds) keep their global binding. Windows
+     * embedders additionally link advapi32, iphlpapi, and ws2_32. Omitted = the
+     * classic archive, byte-for-byte. Admitted for darwin/linux/win32 native
+     * hosts, linux and windows cross triples from any host, and macos cross
+     * triples from a darwin host (compileLibrary owns the refusal fence). */
+    localizeSymbols?: readonly string[];
+    /** Thread-instanced state (the profile's abi.instance_per_thread): every
+     * TU of the archive compiles with -DSCR_THREAD_INSTANCES, moving the
+     * runtime units' mutable statics into thread-local storage (SCR_TL in
+     * scr_runtime.h) to match the program TU's thread-local globals — one
+     * complete instance per embedder thread. The define rides cflags, so
+     * every cache tier keys it automatically; omitted = the classic
+     * archive, byte-for-byte. */
+    threadInstances?: boolean;
     /** IR-detected link gates (the compileC precedent, refusal-narrowed). */
     regex?: boolean;
     assert?: boolean;

package/dist/backend/cc.js

@@ -6,6 +6,7 @@ import { access, chmod, copyFile, link, mkdir, mkdtemp, readdir, readFile, realp
 import { availableParallelism, homedir, tmpdir } from "node:os";
 import { basename, delimiter, dirname, extname, isAbsolute, join, resolve } from "node:path";
 import { promisify } from "node:util";
+import { localizeElfObject, mergeAndLocalizeCoffObjects } from "./object-localize.js";
 const execFileAsync = promisify(execFile);
 /** Test lanes run against one immutable checkout and one immutable toolchain
  * for the lifetime of each Vitest worker. Production deliberately rediscovers
@@ -712,9 +713,12 @@ async function ensureTlsArchive(sanitize, driver, buildIdentity, cacheRoot = ven
  * units a library may reach are the pure-data ones (regex + the vendored matcher, assert,
  * inspect, symbol, searchParams, emitter+dyn_handle, zlib); every
  * loop-hooked or ambient unit was refused at SC4005 before emission.
- * External-symbol contract: undefined references only to libc/libm — which
- * is why zlib rides the VENDORED per-flavor objects here even on hosts
- * (the executable lane's system `-lz` cannot ride inside an archive). */
+ * External-symbol contract: undefined references only to the target's C/math
+ * runtime and system APIs. Windows embedders additionally link advapi32,
+ * iphlpapi, and ws2_32; the platform driver supplies its ordinary CRT and
+ * kernel imports. Zlib rides the VENDORED per-flavor objects here even on
+ * hosts because the executable lane's system `-lz` cannot ride inside an
+ * archive. */
 /** The library base: the executable lane's unconditional sources minus the
  * fiber/loop and child-process units, plus the library-mode TU. */
 const LIB_RUNTIME_SOURCES = [
@@ -757,6 +761,7 @@ export async function compileLibArchive(opts) {
         "-fno-strict-aliasing", // the emitted object model type-puns — see compileC's buildArgs
         "-Wno-deprecated-declarations",
         "-DSCR_LIB",
+        ...(opts.threadInstances ? ["-DSCR_THREAD_INSTANCES"] : []),
         ...(opts.textDecoderLegacy ? ["-DSCR_TEXT_DECODER_LEGACY"] : []),
         "-I", rtDir,
         ...(regex ? ["-I", vendorEngineDir()] : []),
@@ -815,7 +820,13 @@ export async function compileLibArchive(opts) {
         }
     }
     const vendorBuildIdentity = await currentVendorCacheBuildIdentity(driver, `${toolchainEnv}\0${implicitToolchain ?? "<uncached>"}`);
-    const cacheCompleteArchive = root !== null && await archiverSupportsPersistentCache(arArgv, driver);
+    // Runtime-localized archives skip the completed-archive tier: their bytes
+    // additionally depend on the localization toolchain's identity (host ld/
+    // objcopy or the cross driver's lld), which the archive key does not
+    // fingerprint. The runtime-object tier still serves them (localization
+    // consumes the same per-flavor objects).
+    const cacheCompleteArchive = opts.localizeSymbols === undefined &&
+        root !== null && await archiverSupportsPersistentCache(arArgv, driver);
     let cachedArchive = null;
     let compilerVersion = "";
     let archiverVersion = "";
@@ -968,17 +979,29 @@ export async function compileLibArchive(opts) {
                 }
             }
             const objects = [programObject, ...runtimeObjects, ...lreObjects, ...zlibObjects];
-            // A cacheable build owns a private archive from `ar` through publication.
-            // The caller-visible output can be shared by another invocation without
-            // letting that invocation's bytes poison this key.
-            const archiveOutput = cachedArchive === null ? opts.outPath : join(buildDir, "artifact.lib.a");
+            // Multi-instance library mode: the archive's one member becomes the
+            // combined, symbol-localized object (cached vendor/runtime objects
+            // are read-only inputs here — the combine step never mutates them).
+            const archiveMembers = opts.localizeSymbols === undefined
+                ? objects
+                : [
+                    await localizeLibraryObjects(driver, arArgv, buildDir, programObject, [...runtimeObjects, ...lreObjects, ...zlibObjects], opts.localizeSymbols, stem),
+                ];
+            // A cacheable or runtime-localized build owns a private archive from
+            // `ar` through publication. Localized archives deliberately bypass the
+            // completed-artifact cache, but still need atomic installation so two
+            // invocations sharing a caller-visible output cannot race `rm`/`ar` on
+            // that path.
+            const archiveOutput = cachedArchive === null && opts.localizeSymbols === undefined
+                ? opts.outPath
+                : join(buildDir, "artifact.lib.a");
             await rm(archiveOutput, { force: true }); // `ar r` would append into a stale archive
             await mkdir(dirname(archiveOutput), { recursive: true });
             await execFileAsync(arArgv[0] ?? "ar", [
                 ...arArgv.slice(1),
                 "rcs",
                 archiveOutput,
-                ...objects,
+                ...archiveMembers,
             ]);
             if (archiveOutput !== opts.outPath)
                 await installArtifact(archiveOutput, opts.outPath);
@@ -1029,6 +1052,121 @@ export async function compileLibArchive(opts) {
     if (root !== null)
         await pruneCache(root).catch(() => undefined);
 }
+/* Multi-instance library mode's localization step: combine the program
+ * object with exactly the runtime/vendor members it reaches into ONE
+ * relocatable object, then demote every scriptc external definition except
+ * the profile-declared symbols to a local symbol. The internals are not
+ * renamed apart — they stop being visible to the embedder's linker at all,
+ * so a second archive built under a different prefix brings its own private
+ * copy of the whole runtime (allocator, collector, arena, panic sink) into
+ * the same process. Undefined references (the target C/math runtime and
+ * system APIs, plus sanitizer ABI in instrumented builds) keep their global
+ * binding: those platform services and the sanitizer are the embedder's,
+ * shared by design. Windows embedders additionally link advapi32, iphlpapi,
+ * and ws2_32.
+ *
+ * Member selection matters: a classic archive's unused members (and their
+ * undefined references to units library mode excludes, like the
+ * fs-promises unit's fiber symbols) never reach an embedder's link. A
+ * blind merge of every object would carry those references into the one
+ * combined member. Staging the support objects into an intermediate
+ * archive keeps the linker's own member semantics: `ld -r` pulls only the
+ * members the program object transitively needs (the COFF arm implements
+ * the same member semantics in process).
+ *
+ *   Mach-O — one host-ld64 invocation: -r merges program + needed members,
+ *            -exported_symbols_list demotes every unlisted global to
+ *            private extern, and -r without -keep_private_externs writes
+ *            private externs out as non-external symbols. Apple ASan's
+ *            image-registration COMMON remains shared so the final Mach-O
+ *            image registers its globals once. ld64 reads every macOS
+ *            architecture, so darwin-host macos cross triples ride the
+ *            same arm; compileLibrary refuses macos targets elsewhere.
+ *   ELF, native linux host — ld -r merges with --force-group-allocation
+ *            (ASan's instrumented globals ride ELF section groups whose
+ *            signatures repeat across archives sharing runtime objects;
+ *            resolving the groups into the combined member keeps a later
+ *            multi-archive link from discarding one archive's copies),
+ *            then binutils objcopy --keep-global-symbols localizes every
+ *            other DEFINED global (objcopy leaves undefined symbols
+ *            global by its own rule). The exact historical recipe.
+ *   ELF, cross triples from any host — `zig cc -target <triple> -r`
+ *            merges (zig is already the cross driver's hard requirement),
+ *            then localizeElfObject demotes in process and resolves
+ *            section groups the way --force-group-allocation does, with
+ *            no host binutils/llvm-objcopy dependency.
+ *   COFF, native win32 hosts and windows cross triples from any host —
+ *            mergeAndLocalizeCoffObjects performs member selection, the
+ *            merge, cross-object symbol resolution, and demotion in
+ *            process: no linker offers a COFF relocatable mode (lld-link
+ *            mirrors MSVC link.exe; zig's COFF driver refuses multi-object
+ *            merges) and llvm-objcopy rejects symbol-scope flags for
+ *            COFF, so no tool pairing exists to shell out to. */
+async function localizeLibraryObjects(driver, arArgv, buildDir, programObject, supportObjects, keepSymbols, stem) {
+    const platform = targetPlatform(driver);
+    const combined = join(buildDir, `${stem}.localized.o`);
+    const staging = join(buildDir, `${stem}.localize-staging.a`);
+    const keepFile = join(buildDir, "localize-keep.syms");
+    const run = async (argv) => {
+        try {
+            await execFileAsync(argv[0], [...argv.slice(1)]);
+        }
+        catch (err) {
+            const stderr = err.stderr ?? String(err);
+            throw new Error(`${argv[0]} failed while localizing the library archive's runtime symbols (abi.localize_runtime).\n` +
+                `Runtime symbol localization needs the ${platform === "darwin" ? "host toolchain's ld" : driver.target === null ? "host toolchain's ld and objcopy" : "cross driver's relocatable link"} beside the C compiler.\n\n${stderr}`);
+        }
+    };
+    if (platform === "win32") {
+        // COFF has no relocatable-link tool to stage through; the member
+        // selection and combine+demote happen in process over the object bytes.
+        const [program, ...support] = await Promise.all([programObject, ...supportObjects].map((path) => readFile(path)));
+        try {
+            await writeFile(combined, mergeAndLocalizeCoffObjects(program, support, new Set(keepSymbols), {
+                program: basename(programObject),
+                support: supportObjects.map((path) => basename(path)),
+            }));
+        }
+        catch (err) {
+            throw new Error(`COFF symbol localization failed while localizing the library archive's runtime symbols (abi.localize_runtime).\n\n${err.message}`);
+        }
+        return combined;
+    }
+    await run([arArgv[0] ?? "ar", ...arArgv.slice(1), "rcs", staging, ...supportObjects]);
+    if (platform === "darwin") {
+        await writeFile(keepFile, keepSymbols.map((s) => `_${s}\n`).join(""));
+        await run(["ld", "-r", programObject, staging, "-o", combined, "-exported_symbols_list", keepFile]);
+    }
+    else if (platform === "linux" && driver.target === null) {
+        await writeFile(keepFile, keepSymbols.map((s) => `${s}\n`).join(""));
+        await run(["ld", "-r", "--force-group-allocation", programObject, staging, "-o", combined]);
+        await run(["objcopy", `--keep-global-symbols=${keepFile}`, combined]);
+    }
+    else if (platform === "linux") {
+        // Cross ELF: the cross driver's own lld performs the relocatable merge
+        // (with the staging archive's member semantics); demotion and section-
+        // group resolution happen in process. -nostdlib keeps zig from feeding
+        // libc/compiler-rt inputs into the merge.
+        await run([
+            driver.argv[0] ?? "zig",
+            ...driver.argv.slice(1),
+            "-target", driver.target,
+            "-nostdlib",
+            "-r", programObject, staging,
+            "-o", combined,
+        ]);
+        try {
+            await writeFile(combined, localizeElfObject(await readFile(combined), new Set(keepSymbols)));
+        }
+        catch (err) {
+            throw new Error(`ELF symbol localization failed while localizing the library archive's runtime symbols (abi.localize_runtime).\n\n${err.message}`);
+        }
+    }
+    else {
+        throw new Error(`runtime symbol localization (abi.localize_runtime) has no ${platform} arm; compileLibrary admits darwin, linux, and win32 builds only`);
+    }
+    return combined;
+}
 /* -------------------------- persistent build cache ---------------------------
  * Content-addressed caches that let repeat builds of unchanged programs skip
  * payload code generation/linking — the test lanes' dominant cost. Executable