{{ message }}
Repository navigation
Expand file tree
/
Copy pathwork-queue-formal-check.cjs
More file actions
323 lines (311 loc) · 14.1 KB
/
Copy pathwork-queue-formal-check.cjs
File metadata and controls
323 lines (311 loc) · 14.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
// @ts-check
"use strict";
const fs = require("node:fs");
const path = require("node:path");
const crypto = require("node:crypto");
const { spawn, spawnSync } = require("node:child_process");
const MODELS = Object.freeze({ WorkQueue: "WorkQueue", FairDAGGitHub: "FairWorkQueue", QueueOrdering: "WorkQueue" });
const TLC_SHA256 = "936a262061c914694dfd669a543be24573c45d5aa0ff20a8b96b23d01e050e88";
const DEFAULT_TIMEOUT_SECONDS = 280 * 60;
const CHECKPOINT_MAX_BYTES = 256 * 1024 * 1024;
function writeJSON(file, value) {
fs.writeFileSync(file, `${JSON.stringify(value, null, 2)}\n`);
}
function readFileDescriptor(fd, expectedPath) {
const { size } = fs.fstatSync(fd);
const buffer = Buffer.alloc(size);
let offset = 0;
while (offset < size) {
const bytesRead = fs.readSync(fd, buffer, offset, size - offset, offset);
if (bytesRead === 0) break;
offset += bytesRead;
}
if (expectedPath !== undefined) {
const original = fs.fstatSync(fd);
const current = fs.lstatSync(expectedPath);
if (!current.isFile() || current.dev !== original.dev || current.ino !== original.ino) {
throw new Error("TLC log path no longer identifies the opened evidence file");
}
}
return buffer.subarray(0, offset).toString("utf8");
}
function writeJSONToFileDescriptor(fd, value) {
const buffer = Buffer.from(`${JSON.stringify(value, null, 2)}\n`);
fs.ftruncateSync(fd, 0);
let offset = 0;
while (offset < buffer.length) {
const bytesWritten = fs.writeSync(fd, buffer, offset, buffer.length - offset, offset);
if (bytesWritten === 0) throw new Error("Unable to make progress writing JSON evidence");
offset += bytesWritten;
}
}
function classify(exitCode, signal, timedOut, log) {
if (timedOut) return "timed_out";
if (exitCode === 0 && !signal && log.includes("Model checking completed. No error has been found.") && /(?:^|\n)\d+ states generated, \d+ distinct states found, 0 states left on queue\.(?:\r?\n|$)/.test(log)) return "passed";
if ([12, 13].includes(exitCode) && /(?:Invariant|Action property|Temporal property) .+ is violated/.test(log)) return "violation";
if (exitCode === 151 && /(?:^|\n)Error: The invariant of \S+ is equal to FALSE(?:\r?\n|$)/.test(log)) return "violation";
return "tool_error";
}
function lastMatch(log, pattern) {
const matches = [...log.matchAll(pattern)];
return matches.length ? matches[matches.length - 1].slice(1) : null;
}
function inventory(directory) {
let bytes = 0;
let files = 0;
const checkpoints = [];
function visit(current) {
for (const entry of fs.readdirSync(current, { withFileTypes: true })) {
const file = path.join(current, entry.name);
if (entry.isDirectory()) visit(file);
else if (entry.isFile()) {
const size = fs.statSync(file).size;
bytes += size;
files++;
if (entry.name.endsWith(".chkpt")) checkpoints.push({ path: path.relative(directory, file), bytes: size });
}
}
}
if (fs.existsSync(directory)) visit(directory);
return { bytes, files, checkpoints };
}
function checkpointBundle(stateDir, bundleDir, maxBytes, checkpointConfirmed = false, env = process.env) {
let state;
try {
state = inventory(stateDir);
} catch (error) {
if (!(error && typeof error === "object" && "code" in error)) throw error;
return { bytes: null, files: null, checkpoints: [], archived: false, resumable: false, recovery_validation: "not_attempted", reason: "inventory_error", error: error.message };
}
const result = { ...state, archived: false, resumable: false, recovery_validation: "not_attempted", reason: "no_checkpoint" };
if (!state.checkpoints.length) return result;
if (state.bytes > maxBytes) return { ...result, reason: "state_size_limit" };
if (!checkpointConfirmed || !state.checkpoints.some(file => file.path.endsWith("vars.chkpt")) || !state.checkpoints.some(file => file.path.endsWith("queue.chkpt"))) {
return { ...result, reason: "incomplete_checkpoint" };
}
const archive = path.join(bundleDir, "checkpoint.tar.gz");
const packed = spawnSync("tar", ["-czf", archive, "-C", stateDir, "."], { timeout: 90_000, encoding: "utf8", env });
if (packed.error || packed.status !== 0) {
let cleanupError = null;
try {
if (fs.existsSync(archive)) fs.unlinkSync(archive);
} catch (error) {
if (!(error && typeof error === "object" && "code" in error)) throw error;
cleanupError = error.message;
}
return { ...result, reason: "archive_error", error: packed.error?.message || packed.stderr || `tar exited with status ${packed.status}, signal ${packed.signal}`, cleanup_error: cleanupError };
}
return { ...result, archived: true, reason: "unvalidated_checkpoint_candidate" };
}
/**
* Invocation environment overrides apply to subprocesses, provenance, and summary output.
* @param {{config: string, outputDir: string, jar: string, javaBin?: string, timeoutSeconds?: number, graceSeconds?: number, checkpointMaxBytes?: number, expectedJarSha256?: string, env?: NodeJS.ProcessEnv}} options
*/
async function runVerification(options) {
const { config, jar, outputDir } = options;
if (!Object.hasOwn(MODELS, config)) throw new Error("config must be WorkQueue, FairDAGGitHub, or QueueOrdering");
if (!path.isAbsolute(outputDir) || path.resolve(outputDir) === path.parse(outputDir).root) {
throw new Error("outputDir must be an absolute non-root directory");
}
if (!path.isAbsolute(jar)) throw new Error("jar must be an absolute file path");
const timeoutSeconds = options.timeoutSeconds ?? DEFAULT_TIMEOUT_SECONDS;
if (!Number.isFinite(timeoutSeconds) || timeoutSeconds <= 0 || timeoutSeconds > DEFAULT_TIMEOUT_SECONDS) {
throw new Error("timeoutSeconds must be positive and at most 16800 (4h40m)");
}
const env = { ...process.env, ...options.env };
const javaBin = options.javaBin || env.JAVA_BIN || "java";
const expectedJarSha256 = options.expectedJarSha256 || TLC_SHA256;
const root = path.resolve(__dirname, "../..");
const specDir = path.join(root, "specs/work-queue");
const bundleDir = path.join(outputDir, "bundle");
const stateDir = path.join(outputDir, "state");
fs.mkdirSync(bundleDir, { recursive: true });
fs.mkdirSync(stateDir, { recursive: true });
const moduleName = MODELS[config];
const sources = [`${moduleName}.tla`, `${config}.cfg`];
const sourceHashes = {};
for (const source of sources) {
const content = fs.readFileSync(path.join(specDir, source));
fs.writeFileSync(path.join(bundleDir, source), content);
sourceHashes[source] = crypto.createHash("sha256").update(content).digest("hex");
}
const args = [
"-XX:+UseParallelGC",
"-Xmx1g",
"-cp",
jar,
"tlc2.TLC",
"-workers",
"2",
"-seed",
"1",
"-fp",
"0",
"-checkpoint",
"5",
"-config",
path.join(bundleDir, `${config}.cfg`),
"-metadir",
stateDir,
path.join(bundleDir, `${moduleName}.tla`),
];
const started = new Date();
const base = {
schema_version: 1,
config,
module: moduleName,
status: "running",
exhausted: false,
repository: env.GITHUB_REPOSITORY || null,
sha: env.GITHUB_SHA || null,
server_url: env.GITHUB_SERVER_URL || "https://github.com",
run_id: env.GITHUB_RUN_ID || null,
run_attempt: env.GITHUB_RUN_ATTEMPT || null,
started_at: started.toISOString(),
timeout_seconds: timeoutSeconds,
tlc_sha256: expectedJarSha256,
tlc_actual_sha256: null,
source_sha256: sourceHashes,
command: [javaBin, ...args],
};
const resultPath = path.join(bundleDir, "result.json");
writeJSON(resultPath, base);
const jarHash = crypto.createHash("sha256").update(fs.readFileSync(jar)).digest("hex");
base.tlc_actual_sha256 = jarHash;
if (jarHash !== expectedJarSha256) {
const error = new Error("TLC jar checksum does not match the pinned release");
writeJSON(resultPath, { ...base, status: "tool_error", error: error.message, finished_at: new Date().toISOString() });
throw error;
}
writeJSON(resultPath, base);
const version = spawnSync(javaBin, ["-version"], { encoding: "utf8", timeout: 10_000, env });
fs.writeFileSync(path.join(bundleDir, "java-version.txt"), `${version.stdout || ""}${version.stderr || ""}`);
const logPath = path.join(bundleDir, "tlc.log");
const reservePath = path.join(outputDir, "result-space.reserve");
fs.writeFileSync(reservePath, Buffer.alloc(1024 * 1024), { flag: "wx", mode: 0o600 });
const fd = fs.openSync(logPath, "wx+", 0o600);
let timedOut = false;
let spawnError = null;
/** @type {NodeJS.Timeout | undefined} */
let killTimer;
const child = spawn(javaBin, args, { cwd: root, env, detached: true, stdio: ["ignore", fd, fd] });
const signalChild = signal => {
if (child.pid && child.exitCode === null) {
try {
process.kill(-child.pid, signal);
} catch (error) {
if (!(error && typeof error === "object" && "code" in error && error.code === "ESRCH")) throw error;
}
}
};
const timer = setTimeout(() => {
timedOut = true;
signalChild("SIGINT");
killTimer = setTimeout(() => signalChild("SIGKILL"), (options.graceSeconds ?? 30) * 1000);
}, timeoutSeconds * 1000);
const { exitCode, signal } = await new Promise(resolve => {
child.on("error", error => {
spawnError = error.message;
});
child.on("close", (exitCode, signal) => resolve({ exitCode, signal }));
});
clearTimeout(timer);
clearTimeout(killTimer);
let log;
let checkpoints;
try {
log = readFileDescriptor(fd, logPath);
checkpoints = checkpointBundle(stateDir, bundleDir, options.checkpointMaxBytes ?? CHECKPOINT_MAX_BYTES, log.includes("Checkpointing completed"), env);
} finally {
try {
fs.closeSync(fd);
} finally {
fs.unlinkSync(reservePath);
}
}
const finished = lastMatch(log, /(\d+) states generated, (\d+) distinct states found, (\d+) states left on queue\./g);
const progress = lastMatch(log, /Progress\((\d+)\).*?: ([\d,]+) states generated.*?, ([\d,]+) distinct states found.*?, ([\d,]+) states left on queue\./g);
writeJSON(path.join(bundleDir, "checkpoint-inventory.json"), checkpoints);
const status = classify(exitCode, signal, timedOut, log);
const result = {
...base,
status,
exhausted: status === "passed",
finished_at: new Date().toISOString(),
elapsed_seconds: Math.round((Date.now() - started.getTime()) / 1000),
exit_code: exitCode,
signal,
error: spawnError,
final_counts: finished ? { states_generated: finished[0], distinct_states: finished[1], states_remaining: finished[2] } : null,
latest_progress: progress
? {
depth: progress[0],
states_generated: progress[1].replaceAll(",", ""),
distinct_states: progress[2].replaceAll(",", ""),
states_remaining: progress[3].replaceAll(",", ""),
}
: null,
depth: lastMatch(log, /depth of the complete state graph search is (\d+)/g)?.[0] || null,
checkpoints,
};
writeJSON(resultPath, result);
const summary =
`### ${config}\n\nStatus: **${status}**. Exhausted: **${result.exhausted}**.\n\n` +
`Elapsed: ${result.elapsed_seconds}s. Exit: ${exitCode}. Signal: ${signal || "none"}.\n\n` +
`Checkpoint archive: ${checkpoints.archived ? "unvalidated candidate (recovery not tested)" : checkpoints.reason}.\n`;
fs.writeFileSync(path.join(bundleDir, "summary.md"), summary);
fs.writeFileSync(
path.join(bundleDir, "README.md"),
"# Formal verification evidence\n\n" +
"Read result.json and summary.md first. tlc.log contains progress and counterexamples. " +
"The model and configuration are exact source snapshots; verify their recorded SHA-256 hashes.\n\n" +
"A timed_out, tool_error, setup_incomplete, or missing result is not a proof. " +
"Decimal state counts are strings to avoid numeric precision loss.\n\n" +
"checkpoint-inventory.json states whether the complete state directory was archived. " +
"checkpoint.tar.gz is only an unvalidated candidate: completeness and recovery have not been tested, " +
"and resumable remains false. Omitted state is not recoverable from this artifact.\n\n" +
"To attempt recovery, first verify all required model and worker checkpoint files, extract the archive, " +
"locate the directory containing vars.chkpt, and use the pinned TLC jar, " +
"the snapshot model/configuration, -workers 2, -fp 0, and -recover /path/to/that/directory. " +
"Rewrite machine-specific source paths from command when replaying elsewhere. " +
"Only a successful restore and continued search establish recovery capability.\n"
);
if (env.GITHUB_STEP_SUMMARY) fs.appendFileSync(env.GITHUB_STEP_SUMMARY, summary);
return result;
}
if (require.main === module) {
runVerification({ config: process.env.FORMAL_CONFIG || "", outputDir: process.env.RESULTS_DIR || "", jar: process.env.TLA2TOOLS_JAR || "" })
.then(result => {
console.log(JSON.stringify({ config: result.config, status: result.status, exhausted: result.exhausted }));
process.exitCode = result.status === "passed" ? 0 : 1;
})
.catch(error => {
console.error(`Formal verification collection failed: ${error.message}`);
const outputDir = process.env.RESULTS_DIR || "";
const resultPath = path.join(outputDir, "bundle", "result.json");
if (path.isAbsolute(outputDir) && path.resolve(outputDir) !== path.parse(outputDir).root) {
let resultFd;
try {
resultFd = fs.openSync(resultPath, "r+");
} catch (openError) {
if (!openError || openError.code !== "ENOENT") throw openError;
}
if (resultFd !== undefined) {
try {
const result = JSON.parse(readFileDescriptor(resultFd));
writeJSONToFileDescriptor(resultFd, {
...result,
status: "tool_error",
exhausted: false,
error: error.message,
finished_at: new Date().toISOString(),
});
} finally {
fs.closeSync(resultFd);
}
}
}
process.exitCode = 1;
});
}
module.exports = { TLC_SHA256, classify, inventory, checkpointBundle, runVerification, readFileDescriptor, writeJSONToFileDescriptor };
You can’t perform that action at this time.