tla-ts 0.0.1 → 0.0.3-dev.2032e26
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +95 -40
- package/dist/index.cjs +1 -1
- package/dist/index.d.cts +216 -30
- package/dist/index.d.ts +216 -30
- package/dist/index.js +1 -1
- package/dist/parallel-worker.cjs +2 -2
- package/dist/parallel-worker.js +2 -2
- package/dist/parallel.cjs +1 -1
- package/dist/parallel.js +2 -2
- package/dist/run-cli.cjs +20 -1
- package/dist/run-cli.js +20 -1
- package/dist/transfer.cjs +392 -39
- package/dist/transfer.js +392 -39
- package/package.json +6 -2
- package/src/ast.ts +122 -5
- package/src/bags.ts +161 -71
- package/src/builtins.ts +203 -23
- package/src/bundled-modules.ts +63 -32
- package/src/check.ts +950 -238
- package/src/cli-options.ts +58 -0
- package/src/codegen.ts +52 -18
- package/src/config.ts +39 -11
- package/src/environment.ts +485 -140
- package/src/errors.ts +64 -1
- package/src/evaluate.ts +492 -138
- package/src/exit-codes.ts +75 -0
- package/src/fingerprints.ts +48 -13
- package/src/index.ts +9 -4
- package/src/instances.ts +221 -66
- package/src/java-overrides.ts +241 -0
- package/src/json.ts +153 -72
- package/src/levels.ts +850 -0
- package/src/lexer.ts +108 -29
- package/src/liveness.ts +47 -91
- package/src/obligation-action.ts +384 -0
- package/src/obligation-anon.ts +575 -0
- package/src/obligation-deref.ts +637 -0
- package/src/obligation-expression.ts +1060 -0
- package/src/obligation-format.ts +406 -0
- package/src/obligation-generate.ts +1074 -0
- package/src/obligation-levels.ts +329 -0
- package/src/obligation-module.ts +1042 -0
- package/src/obligation-printer.ts +889 -0
- package/src/obligation-proof.ts +76 -0
- package/src/obligation-source.ts +1084 -0
- package/src/obligation-tuples.ts +184 -0
- package/src/obligations.ts +316 -0
- package/src/parallel-worker.ts +186 -201
- package/src/parallel.ts +176 -84
- package/src/parser.ts +970 -206
- package/src/pretty-print.ts +259 -0
- package/src/randomization.ts +24 -113
- package/src/resolve.ts +472 -41
- package/src/run-cli.ts +427 -61
- package/src/runtime.ts +63 -28
- package/src/spec-description.ts +509 -0
- package/src/standard-levels.ts +105 -0
- package/src/standard-modules.ts +223 -92
- package/src/subexpressions.ts +21 -35
- package/src/substitution-levels.ts +184 -0
- package/src/successors.ts +266 -48
- package/src/symmetry.ts +79 -23
- package/src/tableau.ts +43 -37
- package/src/tlc-ext.ts +120 -33
- package/src/tlc-module.ts +71 -47
- package/src/tlc-modules.ts +1022 -0
- package/src/tlc-order.ts +511 -0
- package/src/tlc-random.ts +411 -0
- package/src/tlc-summary.ts +109 -0
- package/src/transfer.ts +26 -5
- package/src/values.ts +1234 -176
package/src/parallel.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import type { Expression } from "./ast";
|
|
2
2
|
import { createCanonicalizer } from "./canonical";
|
|
3
3
|
import {
|
|
4
|
-
|
|
4
|
+
checkSequentially,
|
|
5
5
|
createSearch,
|
|
6
6
|
findAssumptionViolation,
|
|
7
7
|
type CheckOptions,
|
|
@@ -9,11 +9,21 @@ import {
|
|
|
9
9
|
} from "./check";
|
|
10
10
|
import { parseConfig, type ModelConfig } from "./config";
|
|
11
11
|
import { createEnvironment } from "./environment";
|
|
12
|
-
import {
|
|
13
|
-
import {
|
|
14
|
-
import {
|
|
12
|
+
import { TlaEvaluationError } from "./errors";
|
|
13
|
+
import { isImpure } from "./evaluate";
|
|
14
|
+
import {
|
|
15
|
+
createSharedFingerprints,
|
|
16
|
+
growSharedFingerprints,
|
|
17
|
+
insertSharedFingerprint,
|
|
18
|
+
isSharedFingerprintsFull,
|
|
19
|
+
writeStateFingerprint,
|
|
20
|
+
type SharedFingerprints,
|
|
21
|
+
} from "./fingerprints";
|
|
15
22
|
import { getInitialStates } from "./successors";
|
|
23
|
+
import { getTlcStringOrder, getTlcVariableOrder } from "./tlc-order";
|
|
24
|
+
import { getFingerprintDistance, OUT_DEGREE_BUCKETS } from "./tlc-summary";
|
|
16
25
|
import { createStateEncoder, type EncodedStates } from "./transfer";
|
|
26
|
+
import { getRankedStringCount, setStringOrder, type Value } from "./values";
|
|
17
27
|
|
|
18
28
|
const WORKER_THREADS_MODULE = "node:worker_threads";
|
|
19
29
|
|
|
@@ -29,11 +39,13 @@ export interface StartMessage {
|
|
|
29
39
|
source: string;
|
|
30
40
|
config: ModelConfig;
|
|
31
41
|
modules: [string, string | undefined][];
|
|
42
|
+
classes: [string, Uint8Array | undefined][];
|
|
32
43
|
index: number;
|
|
33
|
-
count: number;
|
|
34
44
|
ports: (Port | undefined)[];
|
|
35
45
|
seed: EncodedStates;
|
|
36
|
-
|
|
46
|
+
fingerprints: SharedFingerprints;
|
|
47
|
+
requests: Int32Array;
|
|
48
|
+
remaining: Int32Array;
|
|
37
49
|
}
|
|
38
50
|
|
|
39
51
|
export interface LevelMessage {
|
|
@@ -41,13 +53,19 @@ export interface LevelMessage {
|
|
|
41
53
|
level: number;
|
|
42
54
|
generated: number;
|
|
43
55
|
added: number;
|
|
56
|
+
outDegrees: number[];
|
|
57
|
+
fingerprints: BigInt64Array;
|
|
44
58
|
}
|
|
45
59
|
|
|
46
|
-
export type WorkerMessage =
|
|
60
|
+
export type WorkerMessage =
|
|
61
|
+
| { type: "ready" }
|
|
62
|
+
| { type: "abort" }
|
|
63
|
+
| { type: "paused" }
|
|
64
|
+
| LevelMessage;
|
|
47
65
|
|
|
48
|
-
export
|
|
49
|
-
|
|
50
|
-
}
|
|
66
|
+
export type CoordinatorMessage =
|
|
67
|
+
| { type: "level"; level: number }
|
|
68
|
+
| { type: "resize"; fingerprints: SharedFingerprints };
|
|
51
69
|
|
|
52
70
|
interface WorkerHandle {
|
|
53
71
|
postMessage: (message: unknown, transfer?: unknown[]) => void;
|
|
@@ -73,7 +91,7 @@ const spawnWorker = async (onMessage: (message: WorkerMessage) => void): Promise
|
|
|
73
91
|
/* @vite-ignore */ /* webpackIgnore: true */ WORKER_THREADS_MODULE
|
|
74
92
|
);
|
|
75
93
|
const worker = new threads.Worker(new URL("./parallel-worker.js", import.meta.url));
|
|
76
|
-
worker.on("message",
|
|
94
|
+
worker.on("message", onMessage);
|
|
77
95
|
worker.on("error", () => onMessage({ type: "abort" }));
|
|
78
96
|
return {
|
|
79
97
|
postMessage: (message, transfer) =>
|
|
@@ -82,93 +100,150 @@ const spawnWorker = async (onMessage: (message: WorkerMessage) => void): Promise
|
|
|
82
100
|
};
|
|
83
101
|
};
|
|
84
102
|
|
|
85
|
-
const
|
|
86
|
-
((expression.kind === "Apply" || expression.kind === "OperatorReference") &&
|
|
87
|
-
isImpureBuiltin(expression.operator, environment)) ||
|
|
88
|
-
(expression.kind === "Identifier" && isImpureBuiltin(expression.name, environment)) ||
|
|
89
|
-
getChildren(expression).some((child) => usesImpureBuiltin(child, environment));
|
|
90
|
-
|
|
91
|
-
const isImpure = (environment: Environment) =>
|
|
92
|
-
[...environment.definitions.values()].some(
|
|
93
|
-
(definition) =>
|
|
94
|
-
usesImpureBuiltin(definition.body, environment) ||
|
|
95
|
-
(definition.kind === "Function" &&
|
|
96
|
-
definition.bounds.some((bound) => usesImpureBuiltin(bound.set, environment))),
|
|
97
|
-
);
|
|
98
|
-
|
|
99
|
-
export const checkInParallel = async (options: ParallelCheckOptions): Promise<CheckResult> => {
|
|
103
|
+
export const check = async (options: CheckOptions): Promise<CheckResult> => {
|
|
100
104
|
const config = typeof options.config === "string" ? parseConfig(options.config) : options.config;
|
|
101
|
-
const
|
|
105
|
+
const print = options.onPrint ?? console.log;
|
|
106
|
+
const printed = { count: 0 };
|
|
107
|
+
// The search on the calling thread prints what this one printed while it started, so it skips that.
|
|
108
|
+
const fallBack = () => {
|
|
109
|
+
const skipped = { count: printed.count };
|
|
110
|
+
return checkSequentially({
|
|
111
|
+
...options,
|
|
112
|
+
config,
|
|
113
|
+
onPrint: (text) => (skipped.count-- > 0 ? undefined : print(text)),
|
|
114
|
+
});
|
|
115
|
+
};
|
|
116
|
+
const count = options.workers ?? 1;
|
|
102
117
|
const isSequential =
|
|
103
|
-
|
|
118
|
+
count < 2 ||
|
|
119
|
+
typeof SharedArrayBuffer !== "function" ||
|
|
104
120
|
config.view !== undefined ||
|
|
105
121
|
config.postconditions.length > 0 ||
|
|
106
122
|
config.possible.length > 0;
|
|
107
|
-
if (isSequential) return
|
|
123
|
+
if (isSequential) return fallBack();
|
|
108
124
|
const modules = new Map<string, string | undefined>();
|
|
109
|
-
const
|
|
110
|
-
loadModule
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
125
|
+
const loadModule = (name: string) => {
|
|
126
|
+
const source = options.loadModule?.(name);
|
|
127
|
+
modules.set(name, source);
|
|
128
|
+
return source;
|
|
129
|
+
};
|
|
130
|
+
const classes = new Map<string, Uint8Array | undefined>();
|
|
131
|
+
const loadClass = (name: string) => {
|
|
132
|
+
const bytes = options.loadClass?.(name);
|
|
133
|
+
classes.set(name, bytes);
|
|
134
|
+
return bytes;
|
|
135
|
+
};
|
|
136
|
+
setStringOrder(getTlcStringOrder(options.source, config, loadModule));
|
|
137
|
+
const startupStrings = getRankedStringCount();
|
|
138
|
+
const specification = createEnvironment(config, {
|
|
139
|
+
source: options.source,
|
|
140
|
+
loadModule,
|
|
141
|
+
loadClass,
|
|
142
|
+
print: (text) => {
|
|
143
|
+
printed.count++;
|
|
144
|
+
print(text);
|
|
114
145
|
},
|
|
115
|
-
print: options.onPrint ?? console.log,
|
|
116
146
|
files: { readFile: options.readFile, writeFile: options.writeFile },
|
|
117
147
|
});
|
|
118
148
|
const environment = specification.environment;
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
149
|
+
const search = createSearch(config, environment, () =>
|
|
150
|
+
getTlcVariableOrder(options.source, loadModule),
|
|
151
|
+
);
|
|
152
|
+
if (findAssumptionViolation(specification.assumptions, environment)) return fallBack();
|
|
153
|
+
if (
|
|
154
|
+
!search ||
|
|
155
|
+
search.spec.init === undefined ||
|
|
156
|
+
search.spec.next === undefined ||
|
|
157
|
+
search.properties.liveness.length > 0 ||
|
|
158
|
+
isImpure(environment)
|
|
159
|
+
) {
|
|
160
|
+
return fallBack();
|
|
123
161
|
}
|
|
124
162
|
|
|
125
|
-
const count = options.workers;
|
|
126
163
|
const canonicalize = createCanonicalizer();
|
|
127
|
-
const
|
|
164
|
+
const shared = { fingerprints: createSharedFingerprints() };
|
|
128
165
|
const fingerprint = new Int32Array(2);
|
|
129
|
-
const seeds = Array.from({ length: count },
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
166
|
+
const seeds = Array.from({ length: count }, createStateEncoder);
|
|
167
|
+
const statistics = {
|
|
168
|
+
generatedStates: 0,
|
|
169
|
+
distinctStates: 0,
|
|
170
|
+
queuedStates: 0,
|
|
171
|
+
depth: 0,
|
|
172
|
+
outDegrees: Array.from({ length: OUT_DEGREE_BUCKETS }, () => 0),
|
|
173
|
+
};
|
|
174
|
+
const tlcFingerprints: BigInt64Array[] = [];
|
|
175
|
+
const createSuccess = (): CheckResult => ({
|
|
176
|
+
status: "success",
|
|
177
|
+
violation: undefined,
|
|
178
|
+
failure: undefined,
|
|
179
|
+
...statistics,
|
|
180
|
+
fingerprintDistance: getFingerprintDistance(
|
|
181
|
+
statistics.distinctStates,
|
|
182
|
+
statistics.generatedStates,
|
|
183
|
+
() => {
|
|
184
|
+
const fingerprints = new BigInt64Array(statistics.distinctStates);
|
|
185
|
+
tlcFingerprints.reduce((offset, level) => {
|
|
186
|
+
fingerprints.set(level, offset);
|
|
187
|
+
return offset + level.length;
|
|
188
|
+
}, 0);
|
|
189
|
+
return fingerprints;
|
|
190
|
+
},
|
|
191
|
+
),
|
|
192
|
+
});
|
|
193
|
+
const seedInitialStates = (init: Expression) => {
|
|
194
|
+
const seeded: Value[][] = [];
|
|
195
|
+
for (const state of getInitialStates(init, environment, search.spec.scope)) {
|
|
196
|
+
canonicalize(state);
|
|
197
|
+
statistics.generatedStates++;
|
|
198
|
+
writeStateFingerprint(search.getFingerprintState(state), fingerprint);
|
|
199
|
+
if (isSharedFingerprintsFull(shared.fingerprints)) {
|
|
200
|
+
shared.fingerprints = growSharedFingerprints(shared.fingerprints);
|
|
201
|
+
}
|
|
202
|
+
if (!insertSharedFingerprint(shared.fingerprints, fingerprint[0], fingerprint[1])) continue;
|
|
203
|
+
if (search.findViolatedInvariant(state) || search.findFailedInitialPredicate(state)) {
|
|
204
|
+
return false;
|
|
205
|
+
}
|
|
206
|
+
if (!search.satisfiesConstraints(state)) continue;
|
|
207
|
+
if (!seeds[seeded.length % count].encode(state)) return false;
|
|
208
|
+
seeded.push(state);
|
|
209
|
+
statistics.distinctStates++;
|
|
145
210
|
}
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
211
|
+
tlcFingerprints.push(
|
|
212
|
+
BigInt64Array.from(seeded, (state) => environment.runtime.getFingerprint(state)),
|
|
213
|
+
);
|
|
214
|
+
return true;
|
|
215
|
+
};
|
|
216
|
+
// The sequential search reports a violation or a failed evaluation in the initial states.
|
|
217
|
+
try {
|
|
218
|
+
if (!seedInitialStates(search.spec.init)) return fallBack();
|
|
219
|
+
} catch (error) {
|
|
220
|
+
if (!(error instanceof TlaEvaluationError)) throw error;
|
|
221
|
+
return fallBack();
|
|
150
222
|
}
|
|
151
|
-
if (
|
|
152
|
-
|
|
153
|
-
statistics.
|
|
223
|
+
if (getRankedStringCount() !== startupStrings) return fallBack();
|
|
224
|
+
statistics.depth = statistics.generatedStates === 0 ? 0 : 1;
|
|
225
|
+
if (statistics.distinctStates === 0) return createSuccess();
|
|
154
226
|
|
|
155
227
|
const reports: WorkerMessage[] = [];
|
|
156
|
-
const pending = { resolve: (
|
|
228
|
+
const pending = { count, resolve: (_reports: WorkerMessage[]) => {} };
|
|
157
229
|
const onMessage = (message: WorkerMessage) => {
|
|
158
230
|
reports.push(message);
|
|
159
|
-
if (message.type === "abort" || reports.length === count) {
|
|
231
|
+
if (message.type === "abort" || reports.length === pending.count) {
|
|
160
232
|
pending.resolve(reports.splice(0));
|
|
161
233
|
}
|
|
162
234
|
};
|
|
163
|
-
const waitForReports = () =>
|
|
235
|
+
const waitForReports = (expected: number) =>
|
|
164
236
|
new Promise<WorkerMessage[]>((resolve) => {
|
|
237
|
+
pending.count = expected;
|
|
165
238
|
pending.resolve = resolve;
|
|
166
239
|
});
|
|
167
|
-
const ready = waitForReports();
|
|
240
|
+
const ready = waitForReports(count);
|
|
241
|
+
const requests = new Int32Array(new SharedArrayBuffer(count * 4));
|
|
242
|
+
const remaining = new Int32Array(new SharedArrayBuffer(count * 4));
|
|
168
243
|
const workers = await Promise.all(Array.from({ length: count }, () => spawnWorker(onMessage)));
|
|
169
244
|
const terminate = () => workers.forEach((worker) => worker.terminate());
|
|
170
245
|
const channels = new Map<string, MessageChannel>();
|
|
171
|
-
const getPort = (from: number, to: number)
|
|
246
|
+
const getPort = (from: number, to: number) => {
|
|
172
247
|
const key = from < to ? `${from}:${to}` : `${to}:${from}`;
|
|
173
248
|
const channel = channels.get(key) ?? new MessageChannel();
|
|
174
249
|
channels.set(key, channel);
|
|
@@ -178,46 +253,63 @@ export const checkInParallel = async (options: ParallelCheckOptions): Promise<Ch
|
|
|
178
253
|
const ports = Array.from({ length: count }, (_, peer) =>
|
|
179
254
|
peer === index ? undefined : getPort(index, peer),
|
|
180
255
|
);
|
|
181
|
-
const seed = seeds[index].
|
|
182
|
-
const seedFingerprints = Int32Array.from(seeds[index].fingerprints);
|
|
256
|
+
const seed = seeds[index].finish();
|
|
183
257
|
const message: StartMessage = {
|
|
184
258
|
type: "start",
|
|
185
259
|
source: options.source,
|
|
186
260
|
config,
|
|
187
261
|
modules: [...modules],
|
|
262
|
+
classes: [...classes],
|
|
188
263
|
index,
|
|
189
|
-
count,
|
|
190
264
|
ports,
|
|
191
265
|
seed,
|
|
192
|
-
|
|
266
|
+
fingerprints: shared.fingerprints,
|
|
267
|
+
requests,
|
|
268
|
+
remaining,
|
|
193
269
|
};
|
|
194
|
-
worker.postMessage(message, [
|
|
195
|
-
...ports.filter((port) => port !== undefined),
|
|
196
|
-
seed.words.buffer,
|
|
197
|
-
seedFingerprints.buffer,
|
|
198
|
-
]);
|
|
270
|
+
worker.postMessage(message, [...ports.filter((port) => port !== undefined), seed.words.buffer]);
|
|
199
271
|
});
|
|
200
272
|
const isAborted = (messages: WorkerMessage[]) =>
|
|
201
273
|
messages.some((message) => message.type === "abort");
|
|
274
|
+
const send = (message: CoordinatorMessage) =>
|
|
275
|
+
workers.forEach((worker) => worker.postMessage(message));
|
|
276
|
+
// Workers pause when the shared table needs to grow, and resume once it has.
|
|
277
|
+
const collectLevels = async (messages: WorkerMessage[]): Promise<WorkerMessage[]> => {
|
|
278
|
+
const paused = messages.filter((message) => message.type === "paused").length;
|
|
279
|
+
if (paused === 0 || isAborted(messages)) return messages;
|
|
280
|
+
shared.fingerprints = growSharedFingerprints(shared.fingerprints);
|
|
281
|
+
const resumed = waitForReports(paused);
|
|
282
|
+
send({ type: "resize", fingerprints: shared.fingerprints });
|
|
283
|
+
const reported = messages.filter((message) => message.type !== "paused");
|
|
284
|
+
return [...reported, ...(await collectLevels(await resumed))];
|
|
285
|
+
};
|
|
202
286
|
if (isAborted(await ready)) {
|
|
203
287
|
terminate();
|
|
204
|
-
return
|
|
288
|
+
return fallBack();
|
|
205
289
|
}
|
|
206
290
|
for (let level = 1; ; level++) {
|
|
207
|
-
const reported = waitForReports();
|
|
208
|
-
|
|
209
|
-
|
|
291
|
+
const reported = waitForReports(count);
|
|
292
|
+
// Every worker is idle, so peers can ask any of them for states once the level starts.
|
|
293
|
+
requests.forEach((_, index) => Atomics.store(requests, index, 0));
|
|
294
|
+
send({ type: "level", level });
|
|
295
|
+
const messages = await collectLevels(await reported);
|
|
210
296
|
if (isAborted(messages)) {
|
|
211
297
|
terminate();
|
|
212
|
-
return
|
|
298
|
+
return fallBack();
|
|
213
299
|
}
|
|
214
300
|
const levels = messages.flatMap((message) => (message.type === "level" ? [message] : []));
|
|
215
301
|
const added = levels.reduce((sum, message) => sum + message.added, 0);
|
|
216
302
|
statistics.generatedStates += levels.reduce((sum, message) => sum + message.generated, 0);
|
|
217
303
|
statistics.distinctStates += added;
|
|
304
|
+
levels.forEach((message) => {
|
|
305
|
+
message.outDegrees.forEach(
|
|
306
|
+
(degreeCount, degree) => (statistics.outDegrees[degree] += degreeCount),
|
|
307
|
+
);
|
|
308
|
+
tlcFingerprints.push(message.fingerprints);
|
|
309
|
+
});
|
|
218
310
|
if (added === 0) {
|
|
219
311
|
terminate();
|
|
220
|
-
return
|
|
312
|
+
return createSuccess();
|
|
221
313
|
}
|
|
222
314
|
statistics.depth++;
|
|
223
315
|
}
|