tla-ts 0.0.3-dev.bffbba3 → 0.0.3-dev.c8c988d

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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "tla-ts",
3
- "version": "0.0.3-dev.bffbba3",
3
+ "version": "0.0.3-dev.c8c988d",
4
4
  "description": "A TLA+ interpreter and model checker in TypeScript, 2× faster than TLC",
5
5
  "keywords": [
6
6
  "formal verification",
package/src/ast.ts CHANGED
@@ -47,6 +47,8 @@ export interface ApplyExpression {
47
47
  // The number of args each part of a name like F(x)!l(y) takes, when a part before the last takes
48
48
  // some.
49
49
  argumentCounts?: number[];
50
+ // The range of the parenthesized arguments of a named operator, where SANY reports their count.
51
+ argumentsRange?: SourceRange;
50
52
  location: SourceLocation;
51
53
  resolution?: LocalResolution;
52
54
  }
@@ -192,6 +194,7 @@ export interface FunctionSetExpression {
192
194
  export interface RecordField {
193
195
  name: string;
194
196
  value: Expression;
197
+ location: SourceLocation;
195
198
  }
196
199
 
197
200
  export interface RecordExpression {
@@ -442,12 +445,14 @@ export type StepBody =
442
445
  | { kind: "Assert"; isSuffices: boolean; statement: Expression | AssumeProve }
443
446
  | { kind: "Qed" };
444
447
 
445
- // head is the range of the step number and its statement, without the proof.
448
+ // head is the range of the step number and its statement, without the proof, and statement is the
449
+ // range of the statement alone.
446
450
  export interface ProofStep {
447
451
  name: string | undefined;
448
452
  token: string;
449
453
  body: StepBody;
450
454
  head: SourceRange;
455
+ statement: SourceRange;
451
456
  proof: Proof | undefined;
452
457
  location: SourceLocation;
453
458
  }
package/src/builtins.ts CHANGED
@@ -297,15 +297,21 @@ export const getJavaInteger = (value: Value, signature: string) => {
297
297
  return value;
298
298
  };
299
299
 
300
- export const getIntegersSignature = (method: string, result: string, arity: number) =>
301
- `public static tlc2.value.impl.${result} tlc2.module.Integers.${method}(${Array.from({ length: arity }, () => "tlc2.value.impl.IntValue").join(",")})`;
300
+ export const getArithmeticSignature = (
301
+ javaClass: "Naturals" | "Integers",
302
+ method: string,
303
+ result: string,
304
+ arity: number,
305
+ ) =>
306
+ `public static tlc2.value.impl.${result} tlc2.module.${javaClass}.${method}(${Array.from({ length: arity }, () => "tlc2.value.impl.IntValue").join(",")})`;
302
307
 
303
308
  export const defineArithmetic = (
309
+ javaClass: "Naturals" | "Integers",
304
310
  name: string,
305
311
  method: string,
306
312
  compute: (left: number, right: number) => number,
307
313
  ) => {
308
- const signature = getIntegersSignature(method, "IntValue", 2);
314
+ const signature = getArithmeticSignature(javaClass, method, "IntValue", 2);
309
315
  return defineBinary(name, (left, right) => {
310
316
  const leftNumber = getJavaInteger(left, signature);
311
317
  const rightNumber = getJavaInteger(right, signature);
package/src/check.ts CHANGED
@@ -11,8 +11,13 @@ import { getReadVariables } from "./dependencies";
11
11
  import { createEnvironment } from "./environment";
12
12
  import {
13
13
  getErrorExitCode,
14
+ isStackOverflow,
15
+ formatRange,
16
+ STACK_OVERFLOW,
14
17
  TlaConfigError,
15
18
  TlaEvaluationError,
19
+ TlaIllegalStateError,
20
+ TlaIncompleteStateError,
16
21
  TlaModuleError,
17
22
  UNEXPECTED_EXCEPTION,
18
23
  } from "./errors";
@@ -21,7 +26,6 @@ import {
21
26
  describeRange,
22
27
  evaluate,
23
28
  expectBoolean,
24
- formatRange,
25
29
  getDefinition,
26
30
  isConstantLevel,
27
31
  isImpure,
@@ -32,6 +36,7 @@ import {
32
36
  import {
33
37
  createLivenessChecker,
34
38
  type Lasso,
39
+ type LiveGraph,
35
40
  type LivenessChecker,
36
41
  type LiveSuccessor,
37
42
  } from "./live-check";
@@ -59,14 +64,17 @@ import {
59
64
  type StateWriter,
60
65
  } from "./state-graph";
61
66
  import { getRepresentative, getSymmetryGroup } from "./symmetry";
62
- import { getTlcStringOrder, getTlcVariableOrder } from "./tlc-order";
67
+ import { getTlcStringOrder, getTlcDeclarationOrder } from "./tlc-order";
63
68
  import { createTlcFingerprinter, getTlcFingerprint } from "./tlc-random";
64
69
  import { createCanonicalizer } from "./canonical";
65
70
  import { getPossibleCounts, type CheckerRuntime } from "./runtime";
66
71
  import { createCounterExample } from "./tlc-ext";
72
+ import { getFingerprintTrace, valueSources } from "./value-sources";
67
73
  import { getFingerprintDistance, OUT_DEGREE_BUCKETS } from "./tlc-summary";
68
74
  import {
75
+ assertFingerprintable,
69
76
  combineHash,
77
+ createModelValue,
70
78
  formatState,
71
79
  formatValue,
72
80
  getValueHash,
@@ -136,6 +144,25 @@ export interface EvaluationFailure {
136
144
  trace: TraceStep[];
137
145
  initialState: Record<string, Value> | undefined;
138
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;
139
166
  }
140
167
 
141
168
  export interface CheckResult {
@@ -247,7 +274,7 @@ const getConstantValue = (name: string, definition: Definition, environment: Env
247
274
  try {
248
275
  return evaluate(createIdentifier(name), getContext(environment, undefined, undefined));
249
276
  } catch (error) {
250
- if (error instanceof TlaEvaluationError) return undefined;
277
+ if (error instanceof TlaEvaluationError || isStackOverflow(error)) return undefined;
251
278
  throw error;
252
279
  }
253
280
  };
@@ -276,8 +303,11 @@ const getInvariants = (names: string[], environment: Environment) => {
276
303
  levels.params.size === 0
277
304
  ? ""
278
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.";
279
- throw new TlaConfigError(
280
- `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,
281
311
  );
282
312
  }
283
313
  return [{ name, expression: createIdentifier(name), scope: undefined }];
@@ -375,8 +405,11 @@ const getSpecification = (config: ModelConfig, environment: Environment): Specif
375
405
  conjunct.kind === "Always" &&
376
406
  getLevel(conjunct.expression, item.scope, environment) < ACTION_LEVEL
377
407
  ) {
378
- throw new TlaConfigError(
379
- `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,
380
413
  );
381
414
  }
382
415
  const level = getLevel(conjunct, item.scope, environment);
@@ -787,11 +820,13 @@ export const createSearch = (
787
820
  if (view !== undefined || isFingerprintedLikeTlc) {
788
821
  return BigInt64Array.from(states, getTlcStateFingerprint);
789
822
  }
790
- const indices = getTlcOrder();
791
- const getFingerprint = createTlcFingerprinter();
792
- return BigInt64Array.from(fingerprintStates, (state) =>
793
- getFingerprint(indices.map((index) => state[index])),
823
+ const fingerprints = new BigInt64Array(fingerprintStates.length);
824
+ const fingerprint = createTlcFingerprinter(
825
+ getTlcOrder(),
826
+ new Int32Array(fingerprints.buffer),
794
827
  );
828
+ fingerprintStates.forEach(fingerprint);
829
+ return fingerprints;
795
830
  },
796
831
  getFingerprintState: (state) => {
797
832
  if (isFingerprintedLikeTlc) return [String(getTlcStateFingerprint(state))];
@@ -823,11 +858,17 @@ export const createSearch = (
823
858
  }
824
859
  }),
825
860
  satisfiesConstraints: (state, parent) =>
826
- constraints.every(
827
- (constraint) =>
828
- isUnchangedFor(constraint, state, parent) ||
829
- holdsLikeTlc(constraint.expression, getContext(environment, state, undefined)),
830
- ),
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
+ }),
831
872
  findFailedInitialPredicate: (state) =>
832
873
  properties.initialPredicates.find(
833
874
  (predicate) =>
@@ -860,13 +901,13 @@ export const createSearch = (
860
901
  }
861
902
  }),
862
903
  satisfiesActionConstraints: (state, next) =>
863
- actionConstraints.every((constraint) =>
864
- holdsLikeTlc(
865
- constraint.expression,
866
- getContext(environment, state, next),
867
- (expression) => `${UNEXPECTED_EXCEPTION}${getExpectedBoolean(expression, environment)}`,
868
- ),
869
- ),
904
+ actionConstraints.every((constraint) => {
905
+ try {
906
+ return holdsLikeTlc(constraint.expression, getContext(environment, state, next));
907
+ } catch (error) {
908
+ throw toNextStateError(error);
909
+ }
910
+ }),
870
911
  trackStatePossible:
871
912
  statePossible.length === 0
872
913
  ? ignorePossible
@@ -897,6 +938,59 @@ export const createSearch = (
897
938
  const withNextStateExitCode = (error: unknown) =>
898
939
  error instanceof TlaModuleError ? setExitCode(error, error.exitCode) : error;
899
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
+
900
994
  const withHeadline = (error: unknown, headline: string) =>
901
995
  error instanceof TlaEvaluationError
902
996
  ? setExitCode(
@@ -908,9 +1002,16 @@ const withHeadline = (error: unknown, headline: string) =>
908
1002
  // TLC finishes the -dump file whether or not the search finds a violation.
909
1003
  export const checkSequentially = (options: CheckOptions): CheckResult => {
910
1004
  const stateWriter = options.dump && createStateWriter(options.dump, options.writeFile);
911
- const result = searchStates(options, stateWriter);
912
- stateWriter?.close();
913
- return result;
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
+ }
914
1015
  };
915
1016
 
916
1017
  const searchStates = (options: CheckOptions, stateWriter: StateWriter | undefined): CheckResult => {
@@ -918,9 +1019,10 @@ const searchStates = (options: CheckOptions, stateWriter: StateWriter | undefine
918
1019
  const onPrint = options.onPrint ?? console.log;
919
1020
  // TLC prints again while it rebuilds a trace, between the states it prints. Printing those lines
920
1021
  // before the trace would misplace them, so rebuilding a trace prints nothing.
921
- const output = { isMuted: false };
1022
+ const output = { isMuted: false, replayed: undefined as string[] | undefined };
922
1023
  const print = (text: string) => {
923
- if (!output.isMuted) onPrint(text);
1024
+ if (output.replayed) output.replayed.push(text);
1025
+ else if (!output.isMuted) onPrint(text);
924
1026
  };
925
1027
  const withoutOutput = <Result>(rebuild: () => Result) => {
926
1028
  output.isMuted = true;
@@ -982,9 +1084,9 @@ const searchStates = (options: CheckOptions, stateWriter: StateWriter | undefine
982
1084
  ),
983
1085
  });
984
1086
 
985
- const search = createSearch(config, environment, () =>
986
- getTlcVariableOrder(options.source, options.loadModule),
987
- );
1087
+ const getVariableOrder = () =>
1088
+ getTlcDeclarationOrder(options.source, options.loadModule, "variable");
1089
+ const search = createSearch(config, environment, getVariableOrder);
988
1090
  const assumptionViolation = findAssumptionViolation(specification.assumptions, environment);
989
1091
  if (assumptionViolation) return createResult("assumption-violation", assumptionViolation);
990
1092
  if (!search) return createSuccess();
@@ -1008,37 +1110,114 @@ const searchStates = (options: CheckOptions, stateWriter: StateWriter | undefine
1008
1110
  const spec = search.spec;
1009
1111
  const getFingerprintState = search.getFingerprintState;
1010
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
+ });
1011
1191
  const isReducing = config.view !== undefined || config.symmetry !== undefined;
1012
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
+ };
1013
1219
  const liveness = withLivenessExitCode(() =>
1014
- createLivenessChecker(search.properties.liveness, spec.temporals, environment, {
1015
- getFingerprint: (index) =>
1016
- (tlcFingerprints[index] ??= Number(
1017
- BigInt.asIntN(32, runtime.getFingerprint(states[index])),
1018
- )),
1019
- getSuccessors: (state) => {
1020
- const successors: LiveSuccessor[] = [];
1021
- if (spec.next === undefined) return successors;
1022
- forEachSuccessor(
1023
- spec.next,
1024
- state,
1025
- environment,
1026
- (successor) => {
1027
- canonicalizeState(successor.state);
1028
- const isInModel =
1029
- search.satisfiesConstraints(successor.state, state) &&
1030
- search.satisfiesActionConstraints(state, successor.state);
1031
- if (!isInModel) return false;
1032
- const fingerprintState = getFingerprintState(successor.state);
1033
- const index = findStateIndex(getStateHash(fingerprintState), fingerprintState);
1034
- successors.push({ index, state: successor.state });
1035
- return false;
1036
- },
1037
- spec.scope,
1038
- );
1039
- return successors;
1040
- },
1041
- }),
1220
+ createLivenessChecker(search.properties.liveness, spec.temporals, environment, liveGraph),
1042
1221
  );
1043
1222
  const isCanonicalizedFirst = search.isSymmetric || liveness !== undefined;
1044
1223
 
@@ -1173,7 +1352,17 @@ const searchStates = (options: CheckOptions, stateWriter: StateWriter | undefine
1173
1352
  trace: TraceStep[],
1174
1353
  initialState?: Value[],
1175
1354
  failureOutDegrees?: number[],
1176
- ) => {
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
+ }
1177
1366
  if (!(error instanceof TlaEvaluationError)) throw error;
1178
1367
  return {
1179
1368
  ...createResult("error", undefined, {
@@ -1201,6 +1390,7 @@ const searchStates = (options: CheckOptions, stateWriter: StateWriter | undefine
1201
1390
  let hash = 0x811c9dc5;
1202
1391
  for (let index = 0; index < state.length; index++)
1203
1392
  hash = combineHash(hash, getValueHash(state[index]));
1393
+ assertFingerprintable(state);
1204
1394
  return hash & 0x3fffffff;
1205
1395
  };
1206
1396
  const isSameState = (stored: Value[], state: Value[]) => {
@@ -1263,6 +1453,7 @@ const searchStates = (options: CheckOptions, stateWriter: StateWriter | undefine
1263
1453
  isExpanding: false,
1264
1454
  candidate: undefined as Value[] | undefined,
1265
1455
  candidateLevel: 0,
1456
+ isFingerprinting: false,
1266
1457
  livenessSource: -1,
1267
1458
  };
1268
1459
  const getPath = (index: number): Value[][] =>
@@ -1349,8 +1540,10 @@ const searchStates = (options: CheckOptions, stateWriter: StateWriter | undefine
1349
1540
  current.candidate = successor.state;
1350
1541
  current.candidateLevel = depths[index] + 1;
1351
1542
  if (isCanonicalizedFirst) canonicalizeState(successor.state);
1543
+ current.isFingerprinting = true;
1352
1544
  const fingerprintState = getFingerprintState(successor.state);
1353
1545
  const hash = getStateHash(fingerprintState);
1546
+ current.isFingerprinting = false;
1354
1547
  const found = findStateIndex(hash, fingerprintState);
1355
1548
  const isStateInModel = search.satisfiesConstraints(successor.state, state);
1356
1549
  if (isStateInModel) search.trackStatePossible(successor.state);
@@ -1422,10 +1615,22 @@ const searchStates = (options: CheckOptions, stateWriter: StateWriter | undefine
1422
1615
  spec.scope,
1423
1616
  );
1424
1617
  } catch (error) {
1425
- 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
+ };
1426
1631
  }
1427
1632
  }
1428
- if (outcome.result) return outcome.result;
1633
+ if (outcome.result) return replayInitialStates(outcome.result);
1429
1634
 
1430
1635
  const next = spec.next;
1431
1636
  if (next === undefined) {
@@ -1481,7 +1686,10 @@ const searchStates = (options: CheckOptions, stateWriter: StateWriter | undefine
1481
1686
  try {
1482
1687
  outcome.result = visitSuccessor(index, successor, liveSuccessors, source, action);
1483
1688
  } catch (error) {
1484
- outcome.result = toFailure(error, getTrace(index, successor));
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);
1485
1693
  }
1486
1694
  return outcome.result !== undefined;
1487
1695
  });
@@ -1504,9 +1712,44 @@ const searchStates = (options: CheckOptions, stateWriter: StateWriter | undefine
1504
1712
  trace: toTrace(steps, accepted),
1505
1713
  });
1506
1714
  } catch (error) {
1507
- 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
+ );
1508
1726
  }
1509
1727
  };
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
+ };
1510
1753
  // TLC names the properties and the step back into the cycle from the states it prints.
1511
1754
  const reportLasso = (checker: LivenessChecker, lasso: Lasso) => {
1512
1755
  const path = [...lasso.prefix, ...lasso.cycle];
@@ -1552,7 +1795,14 @@ const searchStates = (options: CheckOptions, stateWriter: StateWriter | undefine
1552
1795
  try {
1553
1796
  outcome.result = expandState(index);
1554
1797
  } catch (error) {
1555
- outcome.result = toFailure(withNextStateExitCode(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);
1556
1806
  }
1557
1807
  if (outcome.result) return outcome.result;
1558
1808
  outDegrees[getOutDegreeBucket()]++;
package/src/codegen.ts CHANGED
@@ -10,6 +10,8 @@ import {
10
10
  getSubsetOperator,
11
11
  getEvaluator,
12
12
  getFieldError,
13
+ getNonFunctionError,
14
+ getNonRecordError,
13
15
  isClosedConstant,
14
16
  isTlcInteger,
15
17
  isValueArgument,
@@ -250,12 +252,13 @@ const generateExpression = (generator: Generator, expression: Expression, frame:
250
252
  case "FunctionApplication": {
251
253
  keepLazy(expression.function);
252
254
  const functionCode = generate(expression.function);
255
+ const describeNonFunction = addReference(generator, getNonFunctionError(expression));
253
256
  if (expression.args.length === 1)
254
- return `apply(${functionCode}, ${generate(expression.args[0])})`;
255
- return `apply(${functionCode}, tuple([${expression.args.map((arg) => generate(arg)).join(", ")}]))`;
257
+ return `apply(${functionCode}, ${generate(expression.args[0])}, undefined, ${describeNonFunction})`;
258
+ return `apply(${functionCode}, tuple([${expression.args.map((arg) => generate(arg)).join(", ")}]), undefined, ${describeNonFunction})`;
256
259
  }
257
260
  case "FieldAccess":
258
- return `apply(${generate(expression.record)}, ${JSON.stringify(expression.field)}, ${addReference(generator, getFieldError(expression))})`;
261
+ return `apply(${generate(expression.record)}, ${JSON.stringify(expression.field)}, ${addReference(generator, getFieldError(expression))}, ${addReference(generator, getNonRecordError(expression))})`;
259
262
  case "Record": {
260
263
  const fields = getSortedFields(expression.fields);
261
264
  if (hasDuplicateFields(fields)) return generateDelegate(generator, expression, frame);