tla-ts 0.0.1 → 0.0.3-dev.6979965

package/src/parallel-worker.ts

@@ -1,30 +1,42 @@
 import { createCanonicalizer } from "./canonical";
 import { createSearch } from "./check";
 import { createEnvironment } from "./environment";
-import { createFingerprintTable, getFingerprintOwner, getStateFingerprint } from "./fingerprints";
-import type { LevelMessage, Port, StartMessage, WorkerMessage } from "./parallel";
-import { parseModule } from "./parser";
-import { getSuccessors } from "./successors";
+import {
+  createFingerprintTable,
+  insertSharedFingerprint,
+  isSharedFingerprintsFull,
+  writeStateFingerprint,
+} from "./fingerprints";
+import type {
+  CoordinatorMessage,
+  LevelMessage,
+  Port,
+  StartMessage,
+  WorkerMessage,
+} from "./parallel";
+import { getSuccessors, type Successor } from "./successors";
+import { getTlcStringOrder, getTlcVariableOrder } from "./tlc-order";
+import { OUT_DEGREE_BUCKETS } from "./tlc-summary";
 import { createStateDecoder, createStateEncoder, type EncodedStates } from "./transfer";
-import type { Value } from "./values";
+import { getRankedStringCount, setStringOrder, type Value } from "./values";
 
 const WORKER_THREADS_MODULE = "node:worker_threads";
 
-interface Pending {
-  states: Value[][];
-  parents: Value[][];
-  fingerprints: number[];
-}
-
 interface PeerMessage {
-  phase: "query" | "answer" | "sizes" | "balance";
+  phase: "balance";
   level: number;
   from: number;
-  fingerprints?: Int32Array;
-  bits?: Uint8Array;
-  states?: EncodedStates;
-  unmarks?: Int32Array;
-  size?: number;
+  states: EncodedStates;
+}
+
+interface Expansion {
+  origin: number;
+  successors: Successor[] | undefined;
+  index: number;
+  generated: number;
+  newStates: Int32Array;
+  next: Value[][];
+  fingerprintStates: Value[][];
 }
 
 interface Transfer {
@@ -33,12 +45,12 @@ interface Transfer {
   count: number;
 }
 
-const getBalancePlan = (sizes: number[]): Transfer[] => {
+const getBalancePlan = (sizes: number[]) => {
   const total = sizes.reduce((sum, size) => sum + size, 0);
   const average = total / sizes.length;
   if (Math.max(...sizes) - Math.min(...sizes) <= Math.max(64, average / 4)) return [];
   const targets = sizes.map(
-    (_, index) => Math.floor(total / sizes.length) + (index < total % sizes.length ? 1 : 0),
+    (_, index) => Math.floor(average) + (index < total % sizes.length ? 1 : 0),
   );
   const donors = sizes.flatMap((size, index) =>
     size > targets[index] ? [{ index, amount: size - targets[index] }] : [],
@@ -59,7 +71,7 @@ const getBalancePlan = (sizes: number[]): Transfer[] => {
   return transfers;
 };
 
-const getParentPort = async (): Promise<Port> => {
+const getParentPort = async () => {
   if (typeof (globalThis as { postMessage?: unknown }).postMessage === "function") {
     return globalThis as unknown as Port;
   }
@@ -98,21 +110,31 @@ const createInbox = () => {
 
 const run = (start: StartMessage, parent: Port) => {
   const modules = new Map(start.modules);
-  const specification = createEnvironment(parseModule(start.source), start.config, {
-    loadModule: (name) => modules.get(name),
+  const loadModule = (name: string) => modules.get(name);
+  const classes = new Map(start.classes);
+  setStringOrder(getTlcStringOrder(start.source, start.config, loadModule));
+  const startupStrings = getRankedStringCount();
+  const specification = createEnvironment(start.config, {
+    source: start.source,
+    loadModule,
+    loadClass: (name) => classes.get(name),
     print: () => {},
     files: { readFile: undefined, writeFile: undefined },
   });
   const environment = specification.environment;
-  const search = createSearch(start.config, environment);
-  if (!search) return parent.postMessage({ type: "abort" } satisfies WorkerMessage);
-  const width = environment.variables.length;
-  const count = start.count;
+  const search = createSearch(start.config, environment, () =>
+    getTlcVariableOrder(start.source, loadModule),
+  );
+  const nextAction = search?.spec.next;
+  if (!search || nextAction === undefined)
+    return parent.postMessage({ type: "abort" } satisfies WorkerMessage);
   const self = start.index;
   const canonicalize = createCanonicalizer();
-  const decode = createStateDecoder(width);
-  const table = createFingerprintTable();
-  const known = createFingerprintTable();
+  const decode = createStateDecoder(environment.variables.length);
+  const shared = { fingerprints: start.fingerprints };
+  // Under symmetry, a successor the worker generated before has the representative it had then,
+  // so the worker skips the search for one.
+  const generatedStates = search.isSymmetric ? createFingerprintTable() : undefined;
   const fingerprint = new Int32Array(2);
   const inbox = createInbox();
   const peers = start.ports.flatMap((port, index) => (port ? [{ port, index }] : []));
@@ -120,75 +142,44 @@ const run = (start: StartMessage, parent: Port) => {
     peer.port.addEventListener("message", (event) => inbox.deliver(event.data as PeerMessage));
     peer.port.start?.();
   });
-  for (let index = 0; index < start.seedFingerprints.length; index += 2) {
-    table.insert(start.seedFingerprints[index], start.seedFingerprints[index + 1]);
-  }
   const frontier = { states: decode(start.seed).map(canonicalize) };
   const send = (index: number, message: PeerMessage, transfer: unknown[]) =>
     start.ports[index]?.postMessage(message, transfer);
 
-  const expand = (states: Value[][], next: Value[][]) => {
-    const pending: Pending[] = Array.from({ length: count }, () => ({
-      states: [],
-      parents: [],
-      fingerprints: [],
-    }));
-    const statistics = { generated: 0 };
-    for (const state of states) {
-      const successors = getSuccessors(search.spec.next, state, environment);
-      statistics.generated += successors.length;
-      if (successors.length === 0 && start.config.checkDeadlock) return undefined;
-      for (const successor of successors) {
+  // The worker pauses before a successor when the shared table needs to grow, and resumes there.
+  const expand = (expansion: Expansion) => {
+    const states = frontier.states;
+    for (; expansion.origin < states.length; expansion.origin++) {
+      const state = states[expansion.origin];
+      if (!expansion.successors) {
+        expansion.successors = getSuccessors(nextAction, state, environment, search.spec.scope);
+        expansion.generated += expansion.successors.length;
+        if (expansion.successors.length === 0 && start.config.checkDeadlock) return undefined;
+      }
+      const successors = expansion.successors;
+      for (; expansion.index < successors.length; expansion.index++) {
+        if (isSharedFingerprintsFull(shared.fingerprints)) return "paused";
+        const successor = successors[expansion.index];
         if (search.findViolatedActionProperty(state, successor.state)) return undefined;
         if (!search.satisfiesActionConstraints(state, successor.state)) continue;
-        canonicalize(successor.state);
-        getStateFingerprint(search.getFingerprintState(successor.state), fingerprint);
-        const owner = getFingerprintOwner(fingerprint[1], count);
-        if (owner === self) {
-          if (!table.insert(fingerprint[0], fingerprint[1])) continue;
-          if (search.findViolatedInvariant(successor.state, state)) return undefined;
-          if (search.satisfiesConstraints(successor.state, state)) next.push(successor.state);
-          else table.remove(fingerprint[0], fingerprint[1]);
-          continue;
+        if (generatedStates) {
+          writeStateFingerprint(successor.state, fingerprint);
+          if (!generatedStates.insert(fingerprint[0], fingerprint[1])) continue;
         }
-        if (!known.insert(fingerprint[0], fingerprint[1])) continue;
-        pending[owner].states.push(successor.state);
-        pending[owner].parents.push(state);
-        pending[owner].fingerprints.push(fingerprint[0], fingerprint[1]);
-      }
-    }
-    return { pending, generated: statistics.generated };
-  };
-
-  const answer = (fingerprints: Int32Array | number[]) => {
-    const bits = new Uint8Array(fingerprints.length / 2);
-    for (let index = 0; index < bits.length; index++) {
-      bits[index] = table.insert(fingerprints[index * 2], fingerprints[index * 2 + 1]) ? 1 : 0;
-    }
-    return bits;
-  };
-
-  const commit = (pending: Pending, bits: Uint8Array, next: Value[][]) => {
-    const unmarks: number[] = [];
-    for (let index = 0; index < bits.length; index++) {
-      if (bits[index] === 0) continue;
-      const state = pending.states[index];
-      const parentState = pending.parents[index];
-      if (search.findViolatedInvariant(state, parentState)) return undefined;
-      if (search.satisfiesConstraints(state, parentState)) {
-        next.push(state);
-        continue;
+        canonicalize(successor.state);
+        const fingerprintState = search.getFingerprintState(successor.state);
+        writeStateFingerprint(fingerprintState, fingerprint);
+        if (!insertSharedFingerprint(shared.fingerprints, fingerprint[0], fingerprint[1])) continue;
+        if (search.findViolatedInvariant(successor.state, state)) return undefined;
+        if (!search.satisfiesConstraints(successor.state, state)) continue;
+        expansion.next.push(successor.state);
+        expansion.fingerprintStates.push(fingerprintState);
+        expansion.newStates[expansion.origin]++;
       }
-      known.remove(pending.fingerprints[index * 2], pending.fingerprints[index * 2 + 1]);
-      unmarks.push(pending.fingerprints[index * 2], pending.fingerprints[index * 2 + 1]);
-    }
-    return Int32Array.from(unmarks);
-  };
-
-  const removeAll = (fingerprints: Int32Array) => {
-    for (let index = 0; index < fingerprints.length; index += 2) {
-      table.remove(fingerprints[index], fingerprints[index + 1]);
+      expansion.successors = undefined;
+      expansion.index = 0;
     }
+    return "done";
   };
 
   const balance = async (level: number, next: Value[][], sizes: number[]) => {
@@ -205,48 +196,50 @@ const run = (start: StartMessage, parent: Port) => {
       send(index, { phase: "balance", level, from: self, states }, [states.words.buffer]);
     });
     const incoming = await inbox.receive("balance", level, peers.length);
-    incoming.forEach((message) => {
-      if (message.states) next.push(...decode(message.states).map(canonicalize));
-    });
+    incoming.forEach((message) => next.push(...decode(message.states).map(canonicalize)));
     return true;
   };
 
+  const waiters = { resume: () => {}, balance: (_sizes: number[]) => {} };
+  const report = (message: WorkerMessage) =>
+    parent.postMessage(message, message.type === "level" ? [message.fingerprints.buffer] : []);
+
   const runLevel = async (level: number): Promise<LevelMessage | undefined> => {
-    const next: Value[][] = [];
-    const expanded = expand(frontier.states, next);
-    if (!expanded) return undefined;
-    peers.forEach((peer) => {
-      const fingerprints = Int32Array.from(expanded.pending[peer.index].fingerprints);
-      send(peer.index, { phase: "query", level, from: self, fingerprints }, [fingerprints.buffer]);
-    });
-    const queries = await inbox.receive("query", level, peers.length);
-    queries.forEach((query) => {
-      const bits = answer(query.fingerprints ?? []);
-      send(query.from, { phase: "answer", level, from: self, bits }, [bits.buffer]);
-    });
-    const answers = await inbox.receive("answer", level, peers.length);
-    for (const reply of answers) {
-      const unmarks = commit(expanded.pending[reply.from], reply.bits ?? new Uint8Array(), next);
-      if (!unmarks) return undefined;
-      send(reply.from, { phase: "sizes", level, from: self, unmarks, size: 0 }, [unmarks.buffer]);
+    const expansion: Expansion = {
+      origin: 0,
+      successors: undefined,
+      index: 0,
+      generated: 0,
+      newStates: new Int32Array(frontier.states.length),
+      next: [],
+      fingerprintStates: [],
+    };
+    for (let status = expand(expansion); status !== "done"; status = expand(expansion)) {
+      if (status === undefined) return undefined;
+      const resumed = new Promise<void>((resolve) => (waiters.resume = resolve));
+      report({ type: "paused" });
+      await resumed;
     }
+    if (getRankedStringCount() !== startupStrings) return undefined;
+    const next = expansion.next;
     const added = next.length;
-    const sizes = Array.from({ length: count }, () => 0);
-    sizes[self] = added;
-    peers.forEach((peer) =>
-      send(peer.index, { phase: "sizes", level, from: self, size: added }, []),
-    );
-    const received = await inbox.receive("sizes", level, peers.length * 2);
-    received.forEach((message) => {
-      if (message.unmarks) removeAll(message.unmarks);
-      else sizes[message.from] = message.size ?? 0;
-    });
-    if (!(await balance(level, next, sizes))) return undefined;
+    const outDegrees = Array.from({ length: OUT_DEGREE_BUCKETS }, () => 0);
+    expansion.newStates.forEach((degree) => outDegrees[Math.min(degree, OUT_DEGREE_BUCKETS - 1)]++);
+    const fingerprints = search.getStoredFingerprints(next, expansion.fingerprintStates);
+    const sizes = new Promise<number[]>((resolve) => (waiters.balance = resolve));
+    report({ type: "expanded", from: self, added });
+    if (!(await balance(level, next, await sizes))) return undefined;
     frontier.states = next;
-    return { type: "level", level, generated: expanded.generated, added };
+    return {
+      type: "level",
+      level,
+      generated: expansion.generated,
+      added,
+      outDegrees,
+      fingerprints,
+    };
   };
 
-  const report = (message: WorkerMessage) => parent.postMessage(message);
   const step = (level: number) => {
     runLevel(level).then(
       (message) => report(message ?? { type: "abort" }),
@@ -254,8 +247,13 @@ const run = (start: StartMessage, parent: Port) => {
     );
   };
   parent.addEventListener("message", (event) => {
-    const message = event.data as { type: string; level: number };
+    const message = event.data as CoordinatorMessage;
     if (message.type === "level") step(message.level);
+    if (message.type === "resize") {
+      shared.fingerprints = message.fingerprints;
+      waiters.resume();
+    }
+    if (message.type === "balance") waiters.balance(message.sizes);
   });
   report({ type: "ready" });
 };