nucleation 0.10.21 → 0.10.23

package/renderer/Routing.d.mts

@@ -0,0 +1,66 @@
+// generated by diplomat-tool
+import type { NucleationError } from "./NucleationError.mjs"
+import type { Schematic } from "./Schematic.mjs"
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+
+
+/**
+ * Namespacing opaque for routing entry points (static methods taking
+ * `&Schematic` explicitly, like `Autostack`).
+ */
+export class Routing {
+    /** @internal */
+    get ffiValue(): pointer;
+    /** @internal */
+    constructor();
+
+
+    /**
+     * Route one net from `(sx, sy, sz)` to `(dx, dy, dz)` with default
+     * rules (torch-ladder vias, stair cap 4, refresh 5) and write the
+     * emitted geometry into the schematic. Writes the routed path as a
+     * JSON array of `[x, y, z]` cells.
+     */
+    static routeNet(schematic: Schematic, sx: number, sy: number, sz: number, dx: number, dy: number, dz: number, label: string): string;
+
+    /**
+     * Route every net in `nets_json` with negotiated congestion
+     * (pnr-core PathFinder) in one labelled workspace, write the
+     * geometry into the schematic, and write the JSON report
+     * (`routes` with per-net `path`/`delay_rt`, `notes`,
+     * `violations`). Supports per-net-class rule overrides
+     * (`classes`: io_contract `NetClassRule`s, with `region`
+     * resolving named route zones tagged on the schematic's
+     * DefinitionRegions), plus `bounds`, `budget` and `congestion`
+     * options — see `crate::routing::route_all_schematic` for the
+     * exact request shape.
+     */
+    static routeAll(schematic: Schematic, netsJson: string): string;
+
+    /**
+     * LVS v1: compare an intended netlist (`{"nets": [{"name",
+     * "terminals": [[x,y,z], ...]}]}`) against the conduction
+     * netlist extracted statically from the schematic (dust
+     * adjacency incl. cut diagonals plus repeater/comparator/torch
+     * through-component edges). Writes `{"clean", "matched",
+     * "opens", "shorts", "cycles"}`.
+     */
+    static lvs(schematic: Schematic, intentJson: string): string;
+
+    /**
+     * Run design-rule checks (support audit, repeater-cycle detection,
+     * optional decay) over the schematic. Writes a JSON array; each
+     * element has `kind` plus violation-specific fields. Label-aware
+     * short checking needs a labelled workspace and stays native.
+     */
+    static drc(schematic: Schematic, checkDecay: boolean): string;
+
+    /**
+     * Static timing over the schematic plus a gate netlist given as
+     * JSON: `{"inputs": ["a", ...], "gates": [{"out": "y",
+     * "ins": ["a", "b"], "delay_rt": 2}, ...]}`. Writes
+     * `{"arrival_rt": {sig: rt}, "critical": [sig, ...]}`.
+     */
+    static sta(schematic: Schematic, netlistJson: string): string;
+}

package/renderer/Routing.d.ts

@@ -0,0 +1,66 @@
+// generated by diplomat-tool
+import type { NucleationError } from "./NucleationError.mjs"
+import type { Schematic } from "./Schematic.mjs"
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+
+
+/**
+ * Namespacing opaque for routing entry points (static methods taking
+ * `&Schematic` explicitly, like `Autostack`).
+ */
+export class Routing {
+    /** @internal */
+    get ffiValue(): pointer;
+    /** @internal */
+    constructor();
+
+
+    /**
+     * Route one net from `(sx, sy, sz)` to `(dx, dy, dz)` with default
+     * rules (torch-ladder vias, stair cap 4, refresh 5) and write the
+     * emitted geometry into the schematic. Writes the routed path as a
+     * JSON array of `[x, y, z]` cells.
+     */
+    static routeNet(schematic: Schematic, sx: number, sy: number, sz: number, dx: number, dy: number, dz: number, label: string): string;
+
+    /**
+     * Route every net in `nets_json` with negotiated congestion
+     * (pnr-core PathFinder) in one labelled workspace, write the
+     * geometry into the schematic, and write the JSON report
+     * (`routes` with per-net `path`/`delay_rt`, `notes`,
+     * `violations`). Supports per-net-class rule overrides
+     * (`classes`: io_contract `NetClassRule`s, with `region`
+     * resolving named route zones tagged on the schematic's
+     * DefinitionRegions), plus `bounds`, `budget` and `congestion`
+     * options — see `crate::routing::route_all_schematic` for the
+     * exact request shape.
+     */
+    static routeAll(schematic: Schematic, netsJson: string): string;
+
+    /**
+     * LVS v1: compare an intended netlist (`{"nets": [{"name",
+     * "terminals": [[x,y,z], ...]}]}`) against the conduction
+     * netlist extracted statically from the schematic (dust
+     * adjacency incl. cut diagonals plus repeater/comparator/torch
+     * through-component edges). Writes `{"clean", "matched",
+     * "opens", "shorts", "cycles"}`.
+     */
+    static lvs(schematic: Schematic, intentJson: string): string;
+
+    /**
+     * Run design-rule checks (support audit, repeater-cycle detection,
+     * optional decay) over the schematic. Writes a JSON array; each
+     * element has `kind` plus violation-specific fields. Label-aware
+     * short checking needs a labelled workspace and stays native.
+     */
+    static drc(schematic: Schematic, checkDecay: boolean): string;
+
+    /**
+     * Static timing over the schematic plus a gate netlist given as
+     * JSON: `{"inputs": ["a", ...], "gates": [{"out": "y",
+     * "ins": ["a", "b"], "delay_rt": 2}, ...]}`. Writes
+     * `{"arrival_rt": {sig: rt}, "critical": [sig, ...]}`.
+     */
+    static sta(schematic: Schematic, netlistJson: string): string;
+}

package/renderer/Routing.mjs

@@ -0,0 +1,220 @@
+// generated by diplomat-tool
+import { NucleationError } from "./NucleationError.mjs"
+import { Schematic } from "./Schematic.mjs"
+import wasm from "./diplomat-wasm.mjs";
+import * as diplomatRuntime from "./diplomat-runtime.mjs";
+
+const Routing_box_destroy_registry = new FinalizationRegistry((ptr) => {
+    wasm.Routing_destroy(ptr);
+});
+
+/**
+ * Namespacing opaque for routing entry points (static methods taking
+ * `&Schematic` explicitly, like `Autostack`).
+ */
+export class Routing {
+    // Internal ptr reference:
+    #ptr = null;
+
+    // Lifetimes are only to keep dependencies alive.
+    // Since JS won't garbage collect until there are no incoming edges.
+    #selfEdge = [];
+
+    #internalConstructor(symbol, ptr, selfEdge) {
+        if (symbol !== diplomatRuntime.internalConstructor) {
+            console.error("Routing is an Opaque type. You cannot call its constructor.");
+            return;
+        }
+        this.#ptr = ptr;
+        this.#selfEdge = selfEdge;
+
+        // Are we being borrowed? If not, we can register.
+        if (this.#selfEdge.length === 0) {
+            Routing_box_destroy_registry.register(this, this.#ptr);
+        }
+
+        return this;
+    }
+    /** @internal */
+    get ffiValue() {
+        return this.#ptr;
+    }
+
+
+    /**
+     * Route one net from `(sx, sy, sz)` to `(dx, dy, dz)` with default
+     * rules (torch-ladder vias, stair cap 4, refresh 5) and write the
+     * emitted geometry into the schematic. Writes the routed path as a
+     * JSON array of `[x, y, z]` cells.
+     */
+    static routeNet(schematic, sx, sy, sz, dx, dy, dz, label) {
+        let functionCleanupArena = new diplomatRuntime.CleanupArena();
+
+        const labelSlice = functionCleanupArena.alloc(diplomatRuntime.DiplomatBuf.sliceWrapper(wasm, diplomatRuntime.DiplomatBuf.str8(wasm, label)));
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+        const write = new diplomatRuntime.DiplomatWriteBuf(wasm);
+
+
+        const result = wasm.Routing_route_net(diplomatReceive.buffer, schematic.ffiValue, sx, sy, sz, dx, dy, dz, labelSlice.ptr, write.buffer);
+
+        try {
+            if (!diplomatReceive.resultFlag) {
+                const cause = new NucleationError(diplomatRuntime.internalConstructor, diplomatRuntime.enumDiscriminant(wasm, diplomatReceive.buffer));
+                throw new globalThis.Error('NucleationError.' + cause.value, { cause });
+            }
+            return write.readString8();
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            functionCleanupArena.free();
+
+            diplomatReceive.free();
+            write.free();
+        }
+    }
+
+    /**
+     * Route every net in `nets_json` with negotiated congestion
+     * (pnr-core PathFinder) in one labelled workspace, write the
+     * geometry into the schematic, and write the JSON report
+     * (`routes` with per-net `path`/`delay_rt`, `notes`,
+     * `violations`). Supports per-net-class rule overrides
+     * (`classes`: io_contract `NetClassRule`s, with `region`
+     * resolving named route zones tagged on the schematic's
+     * DefinitionRegions), plus `bounds`, `budget` and `congestion`
+     * options — see `crate::routing::route_all_schematic` for the
+     * exact request shape.
+     */
+    static routeAll(schematic, netsJson) {
+        let functionCleanupArena = new diplomatRuntime.CleanupArena();
+
+        const netsJsonSlice = functionCleanupArena.alloc(diplomatRuntime.DiplomatBuf.sliceWrapper(wasm, diplomatRuntime.DiplomatBuf.str8(wasm, netsJson)));
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+        const write = new diplomatRuntime.DiplomatWriteBuf(wasm);
+
+
+        const result = wasm.Routing_route_all(diplomatReceive.buffer, schematic.ffiValue, netsJsonSlice.ptr, write.buffer);
+
+        try {
+            if (!diplomatReceive.resultFlag) {
+                const cause = new NucleationError(diplomatRuntime.internalConstructor, diplomatRuntime.enumDiscriminant(wasm, diplomatReceive.buffer));
+                throw new globalThis.Error('NucleationError.' + cause.value, { cause });
+            }
+            return write.readString8();
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            functionCleanupArena.free();
+
+            diplomatReceive.free();
+            write.free();
+        }
+    }
+
+    /**
+     * LVS v1: compare an intended netlist (`{"nets": [{"name",
+     * "terminals": [[x,y,z], ...]}]}`) against the conduction
+     * netlist extracted statically from the schematic (dust
+     * adjacency incl. cut diagonals plus repeater/comparator/torch
+     * through-component edges). Writes `{"clean", "matched",
+     * "opens", "shorts", "cycles"}`.
+     */
+    static lvs(schematic, intentJson) {
+        let functionCleanupArena = new diplomatRuntime.CleanupArena();
+
+        const intentJsonSlice = functionCleanupArena.alloc(diplomatRuntime.DiplomatBuf.sliceWrapper(wasm, diplomatRuntime.DiplomatBuf.str8(wasm, intentJson)));
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+        const write = new diplomatRuntime.DiplomatWriteBuf(wasm);
+
+
+        const result = wasm.Routing_lvs(diplomatReceive.buffer, schematic.ffiValue, intentJsonSlice.ptr, write.buffer);
+
+        try {
+            if (!diplomatReceive.resultFlag) {
+                const cause = new NucleationError(diplomatRuntime.internalConstructor, diplomatRuntime.enumDiscriminant(wasm, diplomatReceive.buffer));
+                throw new globalThis.Error('NucleationError.' + cause.value, { cause });
+            }
+            return write.readString8();
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            functionCleanupArena.free();
+
+            diplomatReceive.free();
+            write.free();
+        }
+    }
+
+    /**
+     * Run design-rule checks (support audit, repeater-cycle detection,
+     * optional decay) over the schematic. Writes a JSON array; each
+     * element has `kind` plus violation-specific fields. Label-aware
+     * short checking needs a labelled workspace and stays native.
+     */
+    static drc(schematic, checkDecay) {
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+        const write = new diplomatRuntime.DiplomatWriteBuf(wasm);
+
+
+        const result = wasm.Routing_drc(diplomatReceive.buffer, schematic.ffiValue, checkDecay, write.buffer);
+
+        try {
+            if (!diplomatReceive.resultFlag) {
+                const cause = new NucleationError(diplomatRuntime.internalConstructor, diplomatRuntime.enumDiscriminant(wasm, diplomatReceive.buffer));
+                throw new globalThis.Error('NucleationError.' + cause.value, { cause });
+            }
+            return write.readString8();
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            diplomatReceive.free();
+            write.free();
+        }
+    }
+
+    /**
+     * Static timing over the schematic plus a gate netlist given as
+     * JSON: `{"inputs": ["a", ...], "gates": [{"out": "y",
+     * "ins": ["a", "b"], "delay_rt": 2}, ...]}`. Writes
+     * `{"arrival_rt": {sig: rt}, "critical": [sig, ...]}`.
+     */
+    static sta(schematic, netlistJson) {
+        let functionCleanupArena = new diplomatRuntime.CleanupArena();
+
+        const netlistJsonSlice = functionCleanupArena.alloc(diplomatRuntime.DiplomatBuf.sliceWrapper(wasm, diplomatRuntime.DiplomatBuf.str8(wasm, netlistJson)));
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+        const write = new diplomatRuntime.DiplomatWriteBuf(wasm);
+
+
+        const result = wasm.Routing_sta(diplomatReceive.buffer, schematic.ffiValue, netlistJsonSlice.ptr, write.buffer);
+
+        try {
+            if (!diplomatReceive.resultFlag) {
+                const cause = new NucleationError(diplomatRuntime.internalConstructor, diplomatRuntime.enumDiscriminant(wasm, diplomatReceive.buffer));
+                throw new globalThis.Error('NucleationError.' + cause.value, { cause });
+            }
+            return write.readString8();
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            functionCleanupArena.free();
+
+            diplomatReceive.free();
+            write.free();
+        }
+    }
+
+    constructor(symbol, ptr, selfEdge) {
+        return this.#internalConstructor(...arguments)
+    }
+}