tla-ts 0.0.3-dev.3cf2ad0 → 0.0.3-dev.40085a4

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.
Files changed (56) hide show
  1. package/README.md +16 -2
  2. package/dist/index.cjs +1 -1
  3. package/dist/index.d.cts +71 -22
  4. package/dist/index.d.ts +71 -22
  5. package/dist/index.js +1 -1
  6. package/dist/parallel-worker.cjs +1 -1
  7. package/dist/parallel-worker.js +2 -2
  8. package/dist/parallel.cjs +1 -1
  9. package/dist/parallel.js +2 -2
  10. package/dist/run-cli.cjs +20 -17
  11. package/dist/run-cli.js +22 -19
  12. package/dist/transfer.cjs +46 -16
  13. package/dist/transfer.js +46 -16
  14. package/package.json +1 -1
  15. package/src/ast.ts +121 -4
  16. package/src/builtins.ts +9 -3
  17. package/src/check.ts +514 -99
  18. package/src/cli-options.ts +11 -5
  19. package/src/codegen.ts +15 -22
  20. package/src/config.ts +224 -170
  21. package/src/dependencies.ts +2 -2
  22. package/src/environment.ts +410 -130
  23. package/src/errors.ts +109 -3
  24. package/src/evaluate.ts +255 -159
  25. package/src/exit-codes.ts +39 -42
  26. package/src/fingerprints.ts +2 -1
  27. package/src/instances.ts +17 -16
  28. package/src/levels.ts +185 -44
  29. package/src/lexer.ts +5 -1
  30. package/src/live-check.ts +772 -0
  31. package/src/liveness.ts +120 -543
  32. package/src/parallel-worker.ts +7 -3
  33. package/src/parallel.ts +20 -4
  34. package/src/parser.ts +184 -54
  35. package/src/resolve.ts +1378 -420
  36. package/src/run-cli.ts +115 -20
  37. package/src/runtime.ts +3 -1
  38. package/src/sany-lexer.ts +615 -0
  39. package/src/sany-parse-error.ts +3143 -0
  40. package/src/spec-description.ts +19 -8
  41. package/src/standard-modules.ts +54 -45
  42. package/src/standard-ranges.ts +116 -0
  43. package/src/state-graph.ts +157 -0
  44. package/src/subexpressions.ts +231 -171
  45. package/src/substitution-levels.ts +38 -17
  46. package/src/successors.ts +183 -39
  47. package/src/symmetry.ts +25 -7
  48. package/src/tableau.ts +51 -24
  49. package/src/tlc-ext.ts +29 -12
  50. package/src/tlc-module.ts +14 -33
  51. package/src/tlc-modules.ts +4 -0
  52. package/src/tlc-order.ts +25 -7
  53. package/src/tlc-random.ts +9 -6
  54. package/src/tlc-summary.ts +20 -5
  55. package/src/value-sources.ts +29 -0
  56. package/src/values.ts +242 -61
package/src/check.ts CHANGED
@@ -1,32 +1,46 @@
1
- import type { Assumption, Definition, Expression, SourceLocation } from "./ast";
1
+ import {
2
+ getChildren,
3
+ isLocallyResolved,
4
+ type Assumption,
5
+ type Definition,
6
+ type Expression,
7
+ type SourceLocation,
8
+ } from "./ast";
2
9
  import { parseConfig, type ConfigValue, type ModelConfig } from "./config";
3
10
  import { getReadVariables } from "./dependencies";
4
11
  import { createEnvironment } from "./environment";
5
- import { getErrorExitCode, TlaConfigError, TlaEvaluationError, TlaModuleError } from "./errors";
6
- import { EXIT_STATUS, setExitCode, setNextStatePhase, withLivenessExitCode } from "./exit-codes";
12
+ import {
13
+ getErrorExitCode,
14
+ isStackOverflow,
15
+ formatRange,
16
+ STACK_OVERFLOW,
17
+ TlaConfigError,
18
+ TlaEvaluationError,
19
+ TlaIllegalStateError,
20
+ TlaIncompleteStateError,
21
+ TlaModuleError,
22
+ UNEXPECTED_EXCEPTION,
23
+ } from "./errors";
24
+ import { EXIT_STATUS, setExitCode, withLivenessExitCode } from "./exit-codes";
7
25
  import {
8
26
  describeRange,
9
27
  evaluate,
10
28
  expectBoolean,
11
- formatRange,
12
- getChildren,
13
29
  getDefinition,
14
30
  isConstantLevel,
15
31
  isImpure,
16
- isLocallyResolved,
17
32
  type Context,
18
33
  type Environment,
19
34
  type Scope,
20
35
  } from "./evaluate";
21
36
  import {
22
37
  createLivenessChecker,
23
- expandTemporal,
24
- getLevel,
25
38
  type Lasso,
39
+ type LiveGraph,
40
+ type LivenessChecker,
26
41
  type LiveSuccessor,
27
- type ScopedExpression,
28
- type TemporalProperty,
29
- } from "./liveness";
42
+ } from "./live-check";
43
+ import { expandTemporal, getLevel, type ScopedExpression, type TemporalProperty } from "./liveness";
30
44
  import { ACTION_LEVEL, createLevelAnalyzer, TEMPORAL_LEVEL } from "./levels";
31
45
  import { prettyPrint } from "./pretty-print";
32
46
  import {
@@ -38,19 +52,30 @@ import {
38
52
  } from "./successors";
39
53
  import {
40
54
  getActionLabel,
55
+ getActionSignature,
41
56
  getNextActions,
42
57
  getSpecificationValue,
43
58
  type SpecAction,
44
59
  } from "./spec-description";
60
+ import {
61
+ createStateWriter,
62
+ type GraphState,
63
+ type StateDump,
64
+ type StateWriter,
65
+ } from "./state-graph";
45
66
  import { getRepresentative, getSymmetryGroup } from "./symmetry";
46
- import { getTlcStringOrder, getTlcVariableOrder } from "./tlc-order";
67
+ import { getTlcStringOrder, getTlcDeclarationOrder } from "./tlc-order";
47
68
  import { createTlcFingerprinter, getTlcFingerprint } from "./tlc-random";
48
69
  import { createCanonicalizer } from "./canonical";
49
70
  import { getPossibleCounts, type CheckerRuntime } from "./runtime";
50
71
  import { createCounterExample } from "./tlc-ext";
72
+ import { getFingerprintTrace, valueSources } from "./value-sources";
51
73
  import { getFingerprintDistance, OUT_DEGREE_BUCKETS } from "./tlc-summary";
52
74
  import {
75
+ assertFingerprintable,
53
76
  combineHash,
77
+ createModelValue,
78
+ formatState,
54
79
  formatValue,
55
80
  getValueHash,
56
81
  isFunctionValue,
@@ -74,6 +99,8 @@ export interface CheckOptions {
74
99
  workers?: number;
75
100
  // TLC's -lncheck: "final" checks liveness only on the complete state graph.
76
101
  livenessCheck?: "default" | "final";
102
+ // TLC's -dump: writes the reachable states, or with `dot` the state graph, through writeFile.
103
+ dump?: StateDump;
77
104
  }
78
105
 
79
106
  export type CheckStatus =
@@ -95,6 +122,8 @@ export interface TraceStep {
95
122
 
96
123
  export interface Violation {
97
124
  name: string;
125
+ // Every temporal property that a liveness counterexample violates, in the configuration's order.
126
+ properties?: string[];
98
127
  trace: TraceStep[];
99
128
  loopStart: number | undefined;
100
129
  loopLabel?: string;
@@ -115,6 +144,25 @@ export interface EvaluationFailure {
115
144
  trace: TraceStep[];
116
145
  initialState: Record<string, Value> | undefined;
117
146
  exitCode: number;
147
+ replay?: Replay;
148
+ isWithoutStatistics?: boolean;
149
+ }
150
+
151
+ // TLC replays a failed step to print the expressions it was evaluating when the replay failed.
152
+ export interface Replay {
153
+ output: string[];
154
+ callStack: string[] | undefined;
155
+ fingerprint?: Fingerprint;
156
+ // The worker that fails to check liveness replays the step at once, so TLC prints the stack
157
+ // before the error, and only when it holds a frame.
158
+ isBeforeError?: boolean;
159
+ }
160
+
161
+ // TLC reports an error from a method of a value that has a source as one it was unable to
162
+ // fingerprint. With an empty stack, it lists the sources of the values instead.
163
+ export interface Fingerprint {
164
+ sources: string[];
165
+ reason: string;
118
166
  }
119
167
 
120
168
  export interface CheckResult {
@@ -226,7 +274,7 @@ const getConstantValue = (name: string, definition: Definition, environment: Env
226
274
  try {
227
275
  return evaluate(createIdentifier(name), getContext(environment, undefined, undefined));
228
276
  } catch (error) {
229
- if (error instanceof TlaEvaluationError) return undefined;
277
+ if (error instanceof TlaEvaluationError || isStackOverflow(error)) return undefined;
230
278
  throw error;
231
279
  }
232
280
  };
@@ -255,8 +303,11 @@ const getInvariants = (names: string[], environment: Environment) => {
255
303
  levels.params.size === 0
256
304
  ? ""
257
305
  : "\nNote that a bug can cause TLC to incorrectly report this error.\nIf you believe your TLA+ or PlusCal specification to be correct,\nplease check if this bug described in LevelNode.java starting at line 590ff affects you.";
258
- throw new TlaConfigError(
259
- `The invariant ${name} is not a state predicate (one with no primes or temporal operators).${note}`,
306
+ throw setExitCode(
307
+ new TlaConfigError(
308
+ `The invariant ${name} is not a state predicate (one with no primes or temporal operators).${note}`,
309
+ ),
310
+ EXIT_STATUS.safetyEvaluationFailure,
260
311
  );
261
312
  }
262
313
  return [{ name, expression: createIdentifier(name), scope: undefined }];
@@ -354,8 +405,11 @@ const getSpecification = (config: ModelConfig, environment: Environment): Specif
354
405
  conjunct.kind === "Always" &&
355
406
  getLevel(conjunct.expression, item.scope, environment) < ACTION_LEVEL
356
407
  ) {
357
- throw new TlaConfigError(
358
- `TLC cannot handle []P in the specification ${config.specification} when P is a state predicate`,
408
+ throw setExitCode(
409
+ new TlaConfigError(
410
+ `TLC cannot handle the temporal formula ${describeRange(conjunct.expression)}`,
411
+ ),
412
+ EXIT_STATUS.error,
359
413
  );
360
414
  }
361
415
  const level = getLevel(conjunct, item.scope, environment);
@@ -425,12 +479,12 @@ const getProperties = (config: ModelConfig, environment: Environment): Propertie
425
479
  config.properties.forEach((name) => {
426
480
  const definition = getConfigPredicate("property", name, environment);
427
481
  if (!definition) return;
428
- expandTemporal(definition.body, undefined, environment, true).forEach((item) => {
482
+ expandTemporal(definition.body, undefined, environment, true, name).forEach((item) => {
429
483
  const conjunct = item.expression;
430
484
  if (isConstantTrue(item, environment, "property")) return;
431
485
  if (conjunct.kind === "Always" && conjunct.expression.kind === "BoxAction") {
432
486
  properties.actionProperties.push({
433
- name,
487
+ name: item.name,
434
488
  box: conjunct.expression,
435
489
  action: conjunct.expression.action,
436
490
  subscript: conjunct.expression.subscript,
@@ -442,12 +496,22 @@ const getProperties = (config: ModelConfig, environment: Environment): Propertie
442
496
  conjunct.kind === "Always" &&
443
497
  getLevel(conjunct.expression, item.scope, environment) <= 1
444
498
  ) {
445
- properties.invariants.push({ name, expression: conjunct.expression, scope: item.scope });
499
+ // TLC names the invariant []P after P when P is an operator name.
500
+ const expression = conjunct.expression;
501
+ properties.invariants.push({
502
+ name: expression.kind === "Identifier" ? expression.name : item.name,
503
+ expression,
504
+ scope: item.scope,
505
+ });
446
506
  return;
447
507
  }
448
508
  const level = getLevel(conjunct, item.scope, environment);
449
509
  if (level < ACTION_LEVEL) {
450
- properties.initialPredicates.push({ name, expression: conjunct, scope: item.scope });
510
+ properties.initialPredicates.push({
511
+ name: item.name,
512
+ expression: conjunct,
513
+ scope: item.scope,
514
+ });
451
515
  return;
452
516
  }
453
517
  if (level === ACTION_LEVEL) {
@@ -507,7 +571,9 @@ const getMembership = (
507
571
  const getStateChecks = (named: NamedExpression[], environment: Environment): StateCheck[] =>
508
572
  named.flatMap((item) =>
509
573
  getConjuncts(item.expression, environment).map((expression) => {
510
- const variables = getReadVariables(expression, environment);
574
+ // A LET or an argument in the scope can read variables the expression doesn't name.
575
+ const variables =
576
+ item.scope === undefined ? getReadVariables(expression, environment) : undefined;
511
577
  return {
512
578
  name: item.name,
513
579
  expression,
@@ -754,11 +820,13 @@ export const createSearch = (
754
820
  if (view !== undefined || isFingerprintedLikeTlc) {
755
821
  return BigInt64Array.from(states, getTlcStateFingerprint);
756
822
  }
757
- const indices = getTlcOrder();
758
- const getFingerprint = createTlcFingerprinter();
759
- return BigInt64Array.from(fingerprintStates, (state) =>
760
- getFingerprint(indices.map((index) => state[index])),
823
+ const fingerprints = new BigInt64Array(fingerprintStates.length);
824
+ const fingerprint = createTlcFingerprinter(
825
+ getTlcOrder(),
826
+ new Int32Array(fingerprints.buffer),
761
827
  );
828
+ fingerprintStates.forEach(fingerprint);
829
+ return fingerprints;
762
830
  },
763
831
  getFingerprintState: (state) => {
764
832
  if (isFingerprintedLikeTlc) return [String(getTlcStateFingerprint(state))];
@@ -790,11 +858,17 @@ export const createSearch = (
790
858
  }
791
859
  }),
792
860
  satisfiesConstraints: (state, parent) =>
793
- constraints.every(
794
- (constraint) =>
795
- isUnchangedFor(constraint, state, parent) ||
796
- holdsLikeTlc(constraint.expression, getContext(environment, state, undefined)),
797
- ),
861
+ constraints.every((constraint) => {
862
+ try {
863
+ return (
864
+ isUnchangedFor(constraint, state, parent) ||
865
+ holdsLikeTlc(constraint.expression, getContext(environment, state, undefined))
866
+ );
867
+ } catch (error) {
868
+ // TLC reports a failing constraint on a successor like a failure of the next-state relation.
869
+ throw parent ? toNextStateError(error) : error;
870
+ }
871
+ }),
798
872
  findFailedInitialPredicate: (state) =>
799
873
  properties.initialPredicates.find(
800
874
  (predicate) =>
@@ -820,18 +894,20 @@ export const createSearch = (
820
894
  )
821
895
  );
822
896
  } catch (error) {
823
- throw withHeadline(error, `Evaluating action property ${property.name} failed.`);
897
+ throw withHeadline(
898
+ withNextStateExitCode(error),
899
+ `Evaluating action property ${property.name} failed.`,
900
+ );
824
901
  }
825
902
  }),
826
903
  satisfiesActionConstraints: (state, next) =>
827
- actionConstraints.every((constraint) =>
828
- holdsLikeTlc(
829
- constraint.expression,
830
- getContext(environment, state, next),
831
- (expression) =>
832
- `TLC threw an unexpected exception.\nThis was probably caused by an error in the spec or model.\nSee the User Output or TLC Console for clues to what happened.\nThe exception was a java.lang.RuntimeException\n: ${getExpectedBoolean(expression, environment)}`,
833
- ),
834
- ),
904
+ actionConstraints.every((constraint) => {
905
+ try {
906
+ return holdsLikeTlc(constraint.expression, getContext(environment, state, next));
907
+ } catch (error) {
908
+ throw toNextStateError(error);
909
+ }
910
+ }),
835
911
  trackStatePossible:
836
912
  statePossible.length === 0
837
913
  ? ignorePossible
@@ -857,6 +933,64 @@ export const createSearch = (
857
933
  };
858
934
  };
859
935
 
936
+ // TLC exits with the code of a standard module's failure only when the failure escapes the
937
+ // computation of next states. In every other phase, the phase decides the code.
938
+ const withNextStateExitCode = (error: unknown) =>
939
+ error instanceof TlaModuleError ? setExitCode(error, error.exitCode) : error;
940
+
941
+ // TLC reports a failure of the next-state relation, or of the liveness check of a step, as an
942
+ // unexpected exception, unless a standard module raised it as an EvalException.
943
+ const toNextStateError = (error: unknown) =>
944
+ error instanceof TlaEvaluationError &&
945
+ !(error instanceof TlaModuleError) &&
946
+ !(error instanceof TlaIncompleteStateError)
947
+ ? setExitCode(
948
+ new TlaEvaluationError(`${UNEXPECTED_EXCEPTION}${error.message}`, error),
949
+ getErrorExitCode(error),
950
+ )
951
+ : withNextStateExitCode(error);
952
+
953
+ const isRepeated = (frame: string, index: number, frames: string[]) =>
954
+ index > 0 && frames[index - 1] === frame;
955
+
956
+ // FingerprintException#getTrace numbers the sources from the outermost value and lists the innermost
957
+ // first.
958
+ const getSourceTrace = (sources: Expression[]) =>
959
+ sources
960
+ .flatMap((source) => (source.location.range ? [formatRange(source.location.range)] : []))
961
+ .filter((source, index, all) => !isRepeated(source, index, all))
962
+ .map((source, index) => `${index}) ${source}`)
963
+ .reverse();
964
+
965
+ // TLC keeps the stack only when an evaluation fails, and prints each expression on it once, however
966
+ // many times in a row it pushed it.
967
+ const getReplayedCallStack = (
968
+ replay: () => void,
969
+ trace: Expression[],
970
+ ): Pick<Replay, "callStack" | "fingerprint"> => {
971
+ try {
972
+ replay();
973
+ return { callStack: undefined };
974
+ } catch (error) {
975
+ if (!(error instanceof TlaEvaluationError)) return { callStack: [] };
976
+ const callStack = trace
977
+ .flatMap((expression) => {
978
+ const range = expression.location.range;
979
+ return range
980
+ ? [
981
+ `Line ${range.start.line}, column ${range.start.column} to line ${range.end.line}, column ${range.end.column} in ${range.module}`,
982
+ ]
983
+ : [];
984
+ })
985
+ .filter((frame, index, frames) => !isRepeated(frame, index, frames));
986
+ const sources = getFingerprintTrace(error);
987
+ return {
988
+ callStack,
989
+ fingerprint: sources && { sources: getSourceTrace(sources), reason: error.message },
990
+ };
991
+ }
992
+ };
993
+
860
994
  const withHeadline = (error: unknown, headline: string) =>
861
995
  error instanceof TlaEvaluationError
862
996
  ? setExitCode(
@@ -865,15 +999,30 @@ const withHeadline = (error: unknown, headline: string) =>
865
999
  )
866
1000
  : error;
867
1001
 
1002
+ // TLC finishes the -dump file whether or not the search finds a violation.
868
1003
  export const checkSequentially = (options: CheckOptions): CheckResult => {
869
- setNextStatePhase(false);
1004
+ const stateWriter = options.dump && createStateWriter(options.dump, options.writeFile);
1005
+ try {
1006
+ return searchStates(options, stateWriter);
1007
+ } catch (error) {
1008
+ // TLC reports a stack overflow outside the search as a failure of its own, with exit code 255.
1009
+ throw isStackOverflow(error)
1010
+ ? setExitCode(new TlaEvaluationError(STACK_OVERFLOW), EXIT_STATUS.error)
1011
+ : error;
1012
+ } finally {
1013
+ stateWriter?.close();
1014
+ }
1015
+ };
1016
+
1017
+ const searchStates = (options: CheckOptions, stateWriter: StateWriter | undefined): CheckResult => {
870
1018
  const config = typeof options.config === "string" ? parseConfig(options.config) : options.config;
871
1019
  const onPrint = options.onPrint ?? console.log;
872
1020
  // TLC prints again while it rebuilds a trace, between the states it prints. Printing those lines
873
1021
  // before the trace would misplace them, so rebuilding a trace prints nothing.
874
- const output = { isMuted: false };
1022
+ const output = { isMuted: false, replayed: undefined as string[] | undefined };
875
1023
  const print = (text: string) => {
876
- if (!output.isMuted) onPrint(text);
1024
+ if (output.replayed) output.replayed.push(text);
1025
+ else if (!output.isMuted) onPrint(text);
877
1026
  };
878
1027
  const withoutOutput = <Result>(rebuild: () => Result) => {
879
1028
  output.isMuted = true;
@@ -935,9 +1084,9 @@ export const checkSequentially = (options: CheckOptions): CheckResult => {
935
1084
  ),
936
1085
  });
937
1086
 
938
- const search = createSearch(config, environment, () =>
939
- getTlcVariableOrder(options.source, options.loadModule),
940
- );
1087
+ const getVariableOrder = () =>
1088
+ getTlcDeclarationOrder(options.source, options.loadModule, "variable");
1089
+ const search = createSearch(config, environment, getVariableOrder);
941
1090
  const assumptionViolation = findAssumptionViolation(specification.assumptions, environment);
942
1091
  if (assumptionViolation) return createResult("assumption-violation", assumptionViolation);
943
1092
  if (!search) return createSuccess();
@@ -961,9 +1110,114 @@ export const checkSequentially = (options: CheckOptions): CheckResult => {
961
1110
  const spec = search.spec;
962
1111
  const getFingerprintState = search.getFingerprintState;
963
1112
  const nextActions = { value: undefined as SpecAction[] | undefined };
1113
+ const replayFailure = (
1114
+ result: CheckResult,
1115
+ replay: (tracedSearch: Search, traced: Environment) => void,
1116
+ isBeforeError = false,
1117
+ ): CheckResult => {
1118
+ if (!result.failure) return result;
1119
+ const trace: Expression[] = [];
1120
+ const traced: Environment = { ...environment, evaluators: new WeakMap(), trace };
1121
+ const tracedSearch = createSearch(config, traced, getVariableOrder);
1122
+ if (!tracedSearch) return result;
1123
+ const replayed: string[] = [];
1124
+ output.replayed = replayed;
1125
+ valueSources.current = new WeakMap();
1126
+ const replayedStack = getReplayedCallStack(() => replay(tracedSearch, traced), trace);
1127
+ valueSources.current = undefined;
1128
+ output.replayed = undefined;
1129
+ return {
1130
+ ...result,
1131
+ failure: { ...result.failure, replay: { output: replayed, ...replayedStack, isBeforeError } },
1132
+ };
1133
+ };
1134
+ // TLC fingerprints a state outside CallStackTool, so a failure of a value with a source leaves
1135
+ // the stack empty. Any other failure keeps the stack of the initial predicate.
1136
+ const fingerprintReplayed = (state: Value[], traced: Environment) => {
1137
+ try {
1138
+ getStateHash(getFingerprintState(state));
1139
+ } catch (error) {
1140
+ if (traced.trace && getFingerprintTrace(error)) traced.trace.length = 0;
1141
+ throw error;
1142
+ }
1143
+ };
1144
+ // TLC checks every initial state again, as when it first generated them.
1145
+ const replayInitialStates = (result: CheckResult) =>
1146
+ replayFailure(result, (tracedSearch, traced) => {
1147
+ if (spec.init === undefined) return;
1148
+ forEachInitialState(
1149
+ spec.init,
1150
+ traced,
1151
+ (state) => {
1152
+ if (tracedSearch.satisfiesConstraints(state)) fingerprintReplayed(state, traced);
1153
+ return (
1154
+ tracedSearch.findViolatedInvariant(state) !== undefined ||
1155
+ tracedSearch.findFailedInitialPredicate(state) !== undefined
1156
+ );
1157
+ },
1158
+ spec.scope,
1159
+ );
1160
+ });
1161
+ // TLC rebuilds the behavior up to the state it expanded before it replays the step.
1162
+ const rebuildBehavior = (index: number): void => {
1163
+ const parent = parents[index];
1164
+ if (parent === -1) {
1165
+ getSpecInitialStates();
1166
+ return;
1167
+ }
1168
+ rebuildBehavior(parent);
1169
+ getLabel(parent, states[parent], states[index]);
1170
+ };
1171
+ // TLC generates the successors of each action before it checks them. It checks the invariants
1172
+ // only of a successor outside the model, since it has seen the others.
1173
+ const replaySuccessors = (result: CheckResult, index: number) =>
1174
+ replayFailure(result, (tracedSearch, traced) => {
1175
+ rebuildBehavior(index);
1176
+ const state = states[index];
1177
+ nextActions.value ??= getNextActions(config, environment, specification.instanceActions);
1178
+ nextActions.value.find((action) =>
1179
+ getSuccessors(action.expression, state, traced, action.scope).some((successor) => {
1180
+ const isInModel =
1181
+ tracedSearch.satisfiesConstraints(successor.state) &&
1182
+ tracedSearch.satisfiesActionConstraints(state, successor.state);
1183
+ if (isInModel) fingerprintReplayed(successor.state, traced);
1184
+ return (
1185
+ (!isInModel && tracedSearch.findViolatedInvariant(successor.state) !== undefined) ||
1186
+ tracedSearch.findViolatedActionProperty(state, successor.state) !== undefined
1187
+ );
1188
+ }),
1189
+ );
1190
+ });
964
1191
  const isReducing = config.view !== undefined || config.symmetry !== undefined;
1192
+ const tlcFingerprints: number[] = [];
1193
+ const liveGraph: LiveGraph = {
1194
+ getFingerprint: (index) =>
1195
+ (tlcFingerprints[index] ??= Number(BigInt.asIntN(32, runtime.getFingerprint(states[index])))),
1196
+ getSuccessors: (state) => {
1197
+ const successors: LiveSuccessor[] = [];
1198
+ if (spec.next === undefined) return successors;
1199
+ forEachSuccessor(
1200
+ spec.next,
1201
+ state,
1202
+ environment,
1203
+ (successor) => {
1204
+ canonicalizeState(successor.state);
1205
+ const isInModel =
1206
+ search.satisfiesConstraints(successor.state, state) &&
1207
+ search.satisfiesActionConstraints(state, successor.state);
1208
+ if (!isInModel) return false;
1209
+ const fingerprintState = getFingerprintState(successor.state);
1210
+ const index = findStateIndex(getStateHash(fingerprintState), fingerprintState);
1211
+ successors.push({ index, state: successor.state });
1212
+ return false;
1213
+ },
1214
+ spec.scope,
1215
+ );
1216
+ return successors;
1217
+ },
1218
+ };
965
1219
  const liveness = withLivenessExitCode(() =>
966
- createLivenessChecker(search.properties.liveness, spec.temporals, environment),
1220
+ createLivenessChecker(search.properties.liveness, spec.temporals, environment, liveGraph),
967
1221
  );
968
1222
  const isCanonicalizedFirst = search.isSymmetric || liveness !== undefined;
969
1223
 
@@ -972,7 +1226,9 @@ export const checkSequentially = (options: CheckOptions): CheckResult => {
972
1226
  const parents: number[] = [];
973
1227
  const actions: (string | undefined)[] = [];
974
1228
  const depths: number[] = [];
975
- const buckets = new Map<number, number | number[]>();
1229
+ // A Map holds at most 2^24 entries, so an open-addressing table keeps each seen state's hash
1230
+ // and its index plus one side by side, probed by the hash.
1231
+ const seen = { slots: new Int32Array(1 << 17), size: 0, shift: 16 };
976
1232
  const canonicalizeState = createCanonicalizer();
977
1233
 
978
1234
  const toRecord = (state: Value[]): Record<string, Value> =>
@@ -985,11 +1241,16 @@ export const checkSequentially = (options: CheckOptions): CheckResult => {
985
1241
  position: number,
986
1242
  loopStart: number | undefined,
987
1243
  ) => {
988
- const state = steps[position].state;
989
- const next = (steps[position + 1] ?? steps[loopStart ?? position]).state;
990
1244
  // TLC evaluates TLCGet("level") and Trace in an alias at the state's position in the trace.
991
1245
  runtime.getLevel = () => position + 1;
992
1246
  runtime.getBehavior = () => steps.slice(0, position + 1).map((step) => step.state);
1247
+ return evaluateAlias(
1248
+ alias,
1249
+ steps[position].state,
1250
+ (steps[position + 1] ?? steps[loopStart ?? position]).state,
1251
+ );
1252
+ };
1253
+ const evaluateAlias = (alias: string, state: Value[], next: Value[] | undefined) => {
993
1254
  try {
994
1255
  const body = getConfigDefinition("alias", alias, environment).body;
995
1256
  const value = evaluate(createIdentifier(alias), getContext(environment, state, next));
@@ -1091,7 +1352,17 @@ export const checkSequentially = (options: CheckOptions): CheckResult => {
1091
1352
  trace: TraceStep[],
1092
1353
  initialState?: Value[],
1093
1354
  failureOutDegrees?: number[],
1094
- ) => {
1355
+ ): CheckResult => {
1356
+ // TLC exits with 255 on a stack overflow while it computes next states, and prints the
1357
+ // behavior up to the state it was expanding.
1358
+ if (isStackOverflow(error)) {
1359
+ return current.isExpanding
1360
+ ? toFailure(
1361
+ setExitCode(new TlaEvaluationError(STACK_OVERFLOW), EXIT_STATUS.error),
1362
+ getStateTrace(current.index),
1363
+ )
1364
+ : toFailure(new TlaEvaluationError(STACK_OVERFLOW), trace, initialState);
1365
+ }
1095
1366
  if (!(error instanceof TlaEvaluationError)) throw error;
1096
1367
  return {
1097
1368
  ...createResult("error", undefined, {
@@ -1104,7 +1375,7 @@ export const checkSequentially = (options: CheckOptions): CheckResult => {
1104
1375
  outDegrees: failureOutDegrees,
1105
1376
  };
1106
1377
  };
1107
- const getPathTrace = (path: number[], loopStart?: number) => {
1378
+ const getPathSteps = (path: number[], loopStart?: number) => {
1108
1379
  const steps = getPathStates(path, NEXT_RECOVERY_FAILURE);
1109
1380
  const last = steps[steps.length - 1].state;
1110
1381
  const isClosed =
@@ -1113,12 +1384,13 @@ export const checkSequentially = (options: CheckOptions): CheckResult => {
1113
1384
  loopStart === path.length - 1 ||
1114
1385
  findSuccessorWithFingerprint(last, path[loopStart]) !== undefined;
1115
1386
  if (!isClosed) throw new TlaEvaluationError(NEXT_RECOVERY_FAILURE);
1116
- return toTrace(steps, path, loopStart);
1387
+ return steps;
1117
1388
  };
1118
1389
  const getStateHash = (state: Value[]) => {
1119
1390
  let hash = 0x811c9dc5;
1120
1391
  for (let index = 0; index < state.length; index++)
1121
1392
  hash = combineHash(hash, getValueHash(state[index]));
1393
+ assertFingerprintable(state);
1122
1394
  return hash & 0x3fffffff;
1123
1395
  };
1124
1396
  const isSameState = (stored: Value[], state: Value[]) => {
@@ -1127,19 +1399,35 @@ export const checkSequentially = (options: CheckOptions): CheckResult => {
1127
1399
  }
1128
1400
  return true;
1129
1401
  };
1402
+ const getSlot = (hash: number) => (Math.imul(hash, 0x9e3779b1) >>> seen.shift) << 1;
1130
1403
  const findStateIndex = (hash: number, state: Value[]) => {
1131
- const bucket = buckets.get(hash);
1132
- if (bucket === undefined) return -1;
1133
- if (typeof bucket === "number") {
1134
- return isSameState(fingerprintStates[bucket], state) ? bucket : -1;
1404
+ const mask = seen.slots.length - 1;
1405
+ for (let slot = getSlot(hash); ; slot = (slot + 2) & mask) {
1406
+ const entry = seen.slots[slot + 1];
1407
+ if (entry === 0) return -1;
1408
+ if (seen.slots[slot] === hash && isSameState(fingerprintStates[entry - 1], state)) {
1409
+ return entry - 1;
1410
+ }
1135
1411
  }
1136
- return bucket.find((index) => isSameState(fingerprintStates[index], state)) ?? -1;
1412
+ };
1413
+ const insertSeen = (hash: number, entry: number) => {
1414
+ const mask = seen.slots.length - 1;
1415
+ let slot = getSlot(hash);
1416
+ while (seen.slots[slot + 1] !== 0) slot = (slot + 2) & mask;
1417
+ seen.slots[slot] = hash;
1418
+ seen.slots[slot + 1] = entry;
1137
1419
  };
1138
1420
  const markSeen = (hash: number, index: number) => {
1139
- const bucket = buckets.get(hash);
1140
- if (bucket === undefined) buckets.set(hash, index);
1141
- else if (typeof bucket === "number") buckets.set(hash, [bucket, index]);
1142
- else bucket.push(index);
1421
+ seen.size++;
1422
+ if (seen.size * 4 > seen.slots.length) {
1423
+ const slots = seen.slots;
1424
+ seen.slots = new Int32Array(slots.length * 2);
1425
+ seen.shift--;
1426
+ for (let slot = 0; slot < slots.length; slot += 2) {
1427
+ if (slots[slot + 1] !== 0) insertSeen(slots[slot], slots[slot + 1]);
1428
+ }
1429
+ }
1430
+ insertSeen(hash, index + 1);
1143
1431
  };
1144
1432
  const countDistinctState = (depth: number) => {
1145
1433
  runtime.distinctStates = states.length + 1;
@@ -1165,6 +1453,7 @@ export const checkSequentially = (options: CheckOptions): CheckResult => {
1165
1453
  isExpanding: false,
1166
1454
  candidate: undefined as Value[] | undefined,
1167
1455
  candidateLevel: 0,
1456
+ isFingerprinting: false,
1168
1457
  livenessSource: -1,
1169
1458
  };
1170
1459
  const getPath = (index: number): Value[][] =>
@@ -1179,7 +1468,7 @@ export const checkSequentially = (options: CheckOptions): CheckResult => {
1179
1468
  };
1180
1469
  runtime.getCurrentState = () => (current.index === -1 ? undefined : states[current.index]);
1181
1470
  runtime.setLivenessSource = (index) => {
1182
- current.livenessSource = index;
1471
+ current.livenessSource = index ?? -1;
1183
1472
  };
1184
1473
  runtime.getLevel = (state) => {
1185
1474
  const source = current.livenessSource;
@@ -1190,6 +1479,18 @@ export const checkSequentially = (options: CheckOptions): CheckResult => {
1190
1479
  return current.isExpanding ? depths[current.index] + 1 : 0;
1191
1480
  };
1192
1481
 
1482
+ const getGraphState = (state: Value[], level: number): GraphState => ({
1483
+ fingerprint: BigInt.asIntN(64, runtime.getFingerprint(state)),
1484
+ level,
1485
+ getLabel: () =>
1486
+ formatState(
1487
+ config.alias === undefined
1488
+ ? toRecord(state)
1489
+ : evaluateAlias(config.alias, state, undefined),
1490
+ ),
1491
+ getText: () => formatState(toRecord(state)),
1492
+ });
1493
+
1193
1494
  const visitInitialState = (state: Value[]) => {
1194
1495
  canonicalizeState(state);
1195
1496
  runtime.generatedStates++;
@@ -1206,6 +1507,7 @@ export const checkSequentially = (options: CheckOptions): CheckResult => {
1206
1507
  countDistinctState(1);
1207
1508
  runtime.queueSize++;
1208
1509
  liveness?.addInitialState(states.length, state);
1510
+ stateWriter?.writeInitialState(getGraphState(state, 1));
1209
1511
  }
1210
1512
  const violated = search.findViolatedInvariant(state);
1211
1513
  if (violated) {
@@ -1226,20 +1528,36 @@ export const checkSequentially = (options: CheckOptions): CheckResult => {
1226
1528
  addState(state, fingerprintState, -1, undefined);
1227
1529
  return undefined;
1228
1530
  };
1229
- const visitSuccessor = (index: number, successor: Successor, liveSuccessors: LiveSuccessor[]) => {
1531
+ const visitSuccessor = (
1532
+ index: number,
1533
+ successor: Successor,
1534
+ liveSuccessors: LiveSuccessor[],
1535
+ source: GraphState | undefined,
1536
+ action: SpecAction | undefined,
1537
+ ) => {
1230
1538
  const state = states[index];
1231
1539
  runtime.generatedStates++;
1232
1540
  current.candidate = successor.state;
1233
1541
  current.candidateLevel = depths[index] + 1;
1234
1542
  if (isCanonicalizedFirst) canonicalizeState(successor.state);
1543
+ current.isFingerprinting = true;
1235
1544
  const fingerprintState = getFingerprintState(successor.state);
1236
1545
  const hash = getStateHash(fingerprintState);
1546
+ current.isFingerprinting = false;
1237
1547
  const found = findStateIndex(hash, fingerprintState);
1238
1548
  const isStateInModel = search.satisfiesConstraints(successor.state, state);
1239
1549
  if (isStateInModel) search.trackStatePossible(successor.state);
1240
1550
  const isInModel = isStateInModel && search.satisfiesActionConstraints(state, successor.state);
1241
1551
  if (isInModel) search.trackActionPossible(state, successor.state);
1242
1552
  const existing = isInModel ? found : -1;
1553
+ if (source && isInModel) {
1554
+ stateWriter?.writeSuccessor(
1555
+ source,
1556
+ getGraphState(successor.state, depths[index] + 1),
1557
+ existing !== -1,
1558
+ action && { name: action.name, signature: getActionSignature(action) },
1559
+ );
1560
+ }
1243
1561
  if (existing !== -1 && liveness) {
1244
1562
  const stored = states[existing];
1245
1563
  const isStored = stored.every((value, position) => value === successor.state[position]);
@@ -1297,10 +1615,22 @@ export const checkSequentially = (options: CheckOptions): CheckResult => {
1297
1615
  spec.scope,
1298
1616
  );
1299
1617
  } catch (error) {
1300
- return toFailure(error, []);
1618
+ if (!(error instanceof TlaIllegalStateError))
1619
+ return replayInitialStates(toFailure(error, []));
1620
+ // TLC prints an illegal initial state with null for each variable it leaves undefined, and
1621
+ // stops before it prints the statistics.
1622
+ const illegal = toFailure(
1623
+ error,
1624
+ [],
1625
+ error.state.map((value) => value ?? createModelValue("null")),
1626
+ );
1627
+ return {
1628
+ ...illegal,
1629
+ failure: illegal.failure && { ...illegal.failure, isWithoutStatistics: true },
1630
+ };
1301
1631
  }
1302
1632
  }
1303
- if (outcome.result) return outcome.result;
1633
+ if (outcome.result) return replayInitialStates(outcome.result);
1304
1634
 
1305
1635
  const next = spec.next;
1306
1636
  if (next === undefined) {
@@ -1311,23 +1641,58 @@ export const checkSequentially = (options: CheckOptions): CheckResult => {
1311
1641
  }
1312
1642
  return createSuccess();
1313
1643
  }
1644
+ // TLC labels and colors an edge of the -dump state graph by the action that generated it. When
1645
+ // the graph names its edges, the search generates successors action by action, as TLC does.
1646
+ const isNamingEdges = Boolean(
1647
+ options.dump?.dot && (options.dump.actionLabels || options.dump.colorize),
1648
+ );
1649
+ const forEachActionSuccessor = (
1650
+ state: Value[],
1651
+ onSuccessor: (successor: Successor, action: SpecAction | undefined) => boolean,
1652
+ ) => {
1653
+ if (!isNamingEdges) {
1654
+ return forEachSuccessor(
1655
+ next,
1656
+ state,
1657
+ environment,
1658
+ (successor) => onSuccessor(successor, undefined),
1659
+ spec.scope,
1660
+ );
1661
+ }
1662
+ nextActions.value ??= getNextActions(config, environment, specification.instanceActions);
1663
+ const progress = { isStopped: false };
1664
+ return nextActions.value.reduce((count, action) => {
1665
+ if (progress.isStopped) return count;
1666
+ return (
1667
+ count +
1668
+ forEachSuccessor(
1669
+ action.expression,
1670
+ state,
1671
+ environment,
1672
+ (successor) => {
1673
+ progress.isStopped = onSuccessor(successor, action);
1674
+ return progress.isStopped;
1675
+ },
1676
+ action.scope,
1677
+ )
1678
+ );
1679
+ }, 0);
1680
+ };
1314
1681
  const expandState = (index: number) => {
1315
1682
  const state = states[index];
1316
1683
  const liveSuccessors: LiveSuccessor[] = [];
1317
- const successorCount = forEachSuccessor(
1318
- next,
1319
- state,
1320
- environment,
1321
- (successor) => {
1322
- try {
1323
- outcome.result = visitSuccessor(index, successor, liveSuccessors);
1324
- } catch (error) {
1325
- outcome.result = toFailure(error, getTrace(index, successor));
1326
- }
1327
- return outcome.result !== undefined;
1328
- },
1329
- spec.scope,
1330
- );
1684
+ const source = stateWriter && getGraphState(state, depths[index]);
1685
+ const successorCount = forEachActionSuccessor(state, (successor, action) => {
1686
+ try {
1687
+ outcome.result = visitSuccessor(index, successor, liveSuccessors, source, action);
1688
+ } catch (error) {
1689
+ // TLC reports a successor it cannot fingerprint as a failure of the state it expands.
1690
+ if (current.isFingerprinting) throw error;
1691
+ const failure = toFailure(error, getTrace(index, successor));
1692
+ outcome.result = isStackOverflow(error) ? failure : replaySuccessors(failure, index);
1693
+ }
1694
+ return outcome.result !== undefined;
1695
+ });
1331
1696
  current.isExpanding = false;
1332
1697
  if (outcome.result) return outcome.result;
1333
1698
  if (successorCount === 0 && config.checkDeadlock) {
@@ -1335,32 +1700,78 @@ export const checkSequentially = (options: CheckOptions): CheckResult => {
1335
1700
  }
1336
1701
  try {
1337
1702
  const accepted = liveness?.addState(index, state, liveSuccessors);
1338
- current.livenessSource = -1;
1339
- if (!accepted) return undefined;
1703
+ if (!liveness || !accepted) return undefined;
1704
+ const steps = getPathSteps(accepted);
1705
+ const properties = liveness.getViolatedProperties(
1706
+ steps.map((step) => step.state),
1707
+ steps.length - 1,
1708
+ );
1340
1709
  return reportViolation("property-violation", {
1341
- name: accepted.name,
1342
- trace: getPathTrace(accepted.path),
1710
+ name: properties[0],
1711
+ properties,
1712
+ trace: toTrace(steps, accepted),
1343
1713
  });
1344
1714
  } catch (error) {
1345
- return toFailure(error, getStateTrace(index), undefined, getPartialOutDegrees());
1715
+ return replayFailure(
1716
+ toFailure(toNextStateError(error), getStateTrace(index), undefined, getPartialOutDegrees()),
1717
+ (_, traced) =>
1718
+ createLivenessChecker(
1719
+ search.properties.liveness,
1720
+ spec.temporals,
1721
+ traced,
1722
+ liveGraph,
1723
+ )?.addState(index, state, liveSuccessors),
1724
+ true,
1725
+ );
1346
1726
  }
1347
1727
  };
1348
- const reportLasso = (lasso: Lasso) => {
1728
+ // TLC names the action when the next-state relation has more than one, and prints the
1729
+ // incomplete successor with null for each variable it leaves undefined.
1730
+ const reportIncompleteSuccessor = (error: TlaIncompleteStateError, index: number) => {
1731
+ nextActions.value ??= getNextActions(config, environment, specification.instanceActions);
1732
+ const actions = nextActions.value;
1733
+ const action =
1734
+ actions.length === 1 ? actions[0] : actions.find((item) => item.name === error.action);
1735
+ const variables = `variable${error.missing.length > 1 ? "s are" : " is"} not defined: ${error.missing.join(", ")}.\n`;
1736
+ runtime.generatedStates++;
1737
+ return toFailure(
1738
+ actions.length === 1
1739
+ ? error
1740
+ : new TlaEvaluationError(
1741
+ `Successor state is not completely specified by action ${error.action} of the next-state relation. The following ${variables}`,
1742
+ ),
1743
+ [
1744
+ ...getStateTrace(index),
1745
+ {
1746
+ action: error.action,
1747
+ label: action && getActionLabel(action),
1748
+ state: toRecord(error.state.map((value) => value ?? createModelValue("null"))),
1749
+ },
1750
+ ],
1751
+ );
1752
+ };
1753
+ // TLC names the properties and the step back into the cycle from the states it prints.
1754
+ const reportLasso = (checker: LivenessChecker, lasso: Lasso) => {
1349
1755
  const path = [...lasso.prefix, ...lasso.cycle];
1350
- const trace = getPathTrace(path, lasso.prefix.length);
1351
- const back = path[lasso.prefix.length];
1756
+ const loopStart = lasso.prefix.length;
1757
+ const steps = getPathSteps(path, loopStart);
1758
+ const trace = toTrace(steps, path, loopStart);
1759
+ const properties = checker.getViolatedProperties(
1760
+ steps.map((step) => step.state),
1761
+ loopStart,
1762
+ );
1763
+ const back = path[loopStart];
1352
1764
  const last = path[path.length - 1];
1765
+ const lastState = steps[steps.length - 1].state;
1353
1766
  const loopLabel =
1354
- back === last ? undefined : withoutOutput(() => getLabel(last, states[last], states[back]));
1767
+ back === last ? undefined : withoutOutput(() => getLabel(last, lastState, states[back]));
1355
1768
  return reportViolation(
1356
1769
  "liveness-violation",
1357
- { name: lasso.name, trace, loopStart: lasso.prefix.length, loopLabel },
1770
+ { name: properties[0], properties, trace, loopStart, loopLabel },
1358
1771
  () =>
1359
1772
  back === last
1360
1773
  ? trace[trace.length - 1].action
1361
- : getTraceSuccessors(states[last]).find((successor) =>
1362
- isSameState(successor.state, states[back]),
1363
- )?.action,
1774
+ : findSuccessorWithFingerprint(lastState, back)?.action,
1364
1775
  );
1365
1776
  };
1366
1777
  const isPeriodic = liveness !== undefined && options.livenessCheck !== "final";
@@ -1373,11 +1784,9 @@ export const checkSequentially = (options: CheckOptions): CheckResult => {
1373
1784
  if (!isGrown || periodic.time > (now - startedAt) * LIVENESS_RATIO) return undefined;
1374
1785
  periodic.size = expanded;
1375
1786
  const lasso = liveness?.findViolation();
1376
- current.livenessSource = -1;
1377
1787
  periodic.time += performance.now() - now;
1378
1788
  return lasso;
1379
1789
  };
1380
- setNextStatePhase(true);
1381
1790
  for (let index = 0; index < states.length && !runtime.isStopped; index++) {
1382
1791
  current.index = index;
1383
1792
  current.candidate = undefined;
@@ -1386,22 +1795,28 @@ export const checkSequentially = (options: CheckOptions): CheckResult => {
1386
1795
  try {
1387
1796
  outcome.result = expandState(index);
1388
1797
  } catch (error) {
1389
- outcome.result = toFailure(error, getStateTrace(index));
1798
+ const failure =
1799
+ error instanceof TlaIncompleteStateError
1800
+ ? reportIncompleteSuccessor(error, index)
1801
+ : toFailure(toNextStateError(error), getStateTrace(index));
1802
+ outcome.result =
1803
+ error instanceof TlaIncompleteStateError || isStackOverflow(error)
1804
+ ? failure
1805
+ : replaySuccessors(failure, index);
1390
1806
  }
1391
1807
  if (outcome.result) return outcome.result;
1392
1808
  outDegrees[getOutDegreeBucket()]++;
1393
1809
  expansion.newStates = 0;
1394
1810
  if (isPeriodic && performance.now() >= periodic.at) {
1395
1811
  const lasso = findPeriodicViolation(index + 1);
1396
- if (lasso) return reportLasso(lasso);
1812
+ if (liveness && lasso) return reportLasso(liveness, lasso);
1397
1813
  }
1398
1814
  }
1399
1815
 
1400
1816
  current.index = -1;
1401
1817
  current.candidate = undefined;
1402
1818
  const lasso = liveness?.findViolation();
1403
- current.livenessSource = -1;
1404
- if (lasso) return reportLasso(lasso);
1819
+ if (liveness && lasso) return reportLasso(liveness, lasso);
1405
1820
 
1406
1821
  const postconditionViolation = search.findPostconditionViolation();
1407
1822
  if (postconditionViolation) {