tla-ts 0.0.3-dev.6a30eee → 0.0.3-dev.6d0aeb6

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 (54) hide show
  1. package/README.md +5 -1
  2. package/dist/index.cjs +1 -1
  3. package/dist/index.d.cts +58 -22
  4. package/dist/index.d.ts +58 -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 -18
  11. package/dist/run-cli.js +22 -20
  12. package/dist/transfer.cjs +40 -15
  13. package/dist/transfer.js +40 -15
  14. package/package.json +1 -1
  15. package/src/ast.ts +101 -1
  16. package/src/builtins.ts +9 -3
  17. package/src/check.ts +473 -100
  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 +158 -49
  23. package/src/errors.ts +93 -3
  24. package/src/evaluate.ts +214 -147
  25. package/src/exit-codes.ts +21 -14
  26. package/src/fingerprints.ts +2 -1
  27. package/src/instances.ts +16 -15
  28. package/src/levels.ts +181 -45
  29. package/src/live-check.ts +132 -70
  30. package/src/liveness.ts +118 -24
  31. package/src/parallel-worker.ts +2 -2
  32. package/src/parallel.ts +5 -2
  33. package/src/parser.ts +71 -19
  34. package/src/resolve.ts +490 -95
  35. package/src/run-cli.ts +104 -18
  36. package/src/runtime.ts +2 -0
  37. package/src/sany-lexer.ts +615 -0
  38. package/src/sany-parse-error.ts +3143 -0
  39. package/src/spec-description.ts +19 -8
  40. package/src/standard-modules.ts +54 -45
  41. package/src/state-graph.ts +157 -0
  42. package/src/subexpressions.ts +35 -23
  43. package/src/substitution-levels.ts +38 -17
  44. package/src/successors.ts +176 -36
  45. package/src/symmetry.ts +16 -6
  46. package/src/tableau.ts +51 -24
  47. package/src/tlc-ext.ts +29 -12
  48. package/src/tlc-module.ts +14 -33
  49. package/src/tlc-modules.ts +4 -0
  50. package/src/tlc-order.ts +8 -4
  51. package/src/tlc-random.ts +9 -6
  52. package/src/tlc-summary.ts +20 -5
  53. package/src/value-sources.ts +29 -0
  54. package/src/values.ts +242 -61
package/src/evaluate.ts CHANGED
@@ -1,23 +1,25 @@
1
- import type {
2
- Bound,
3
- BoundPattern,
4
- DecimalExpression,
5
- Definition,
6
- Expression,
7
- FunctionDefinition,
8
- NumberExpression,
9
- OperatorParam,
10
- RecordField,
11
- SourceRange,
1
+ import {
2
+ getChildren,
3
+ isLocallyResolved,
4
+ type Bound,
5
+ type BoundPattern,
6
+ type DecimalExpression,
7
+ type Definition,
8
+ type Expression,
9
+ type FunctionDefinition,
10
+ type NumberExpression,
11
+ type OperatorParam,
12
+ type RecordField,
12
13
  } from "./ast";
13
14
  import { getKindString } from "./builtins";
14
- import { TlaEvaluationError } from "./errors";
15
- import { EXIT_STATUS, setExitCode } from "./exit-codes";
15
+ import { formatRange, TlaEvaluationError, TlaUnassignedError } from "./errors";
16
+ import { EXIT_STATUS, setExitCode, setOwnExitCode } from "./exit-codes";
16
17
  import { generateEvaluator } from "./codegen";
17
18
  import type { CheckerRuntime } from "./runtime";
18
19
  import { getReadVariables } from "./dependencies";
19
20
  import { contextualApplications, mapChildren, substitutedExpressions } from "./instances";
20
21
  import { isEnabled } from "./successors";
22
+ import { getFingerprintTrace, valueSources, withSource } from "./value-sources";
21
23
  import {
22
24
  applyFunction,
23
25
  combineHash,
@@ -28,23 +30,28 @@ import {
28
30
  createSortedSet,
29
31
  createWrittenRecord,
30
32
  createTuple,
33
+ describeMissingField,
31
34
  formatValue,
32
35
  getDomain,
33
36
  getFunctionDomain,
34
37
  getIntervalElements,
38
+ getLazySubsets,
35
39
  getSequenceElements,
36
40
  getValueHash,
37
- isEnumerable,
38
41
  isFunctionValue,
39
42
  isOverriddenSet,
43
+ isRecordValue,
40
44
  isSameValue,
41
45
  markLambdaFunction,
46
+ isReducible,
42
47
  isSetValue,
43
48
  MAXIMUM_INTEGER,
44
49
  MINIMUM_INTEGER,
45
50
  toFiniteSet,
46
51
  updateFunction,
47
52
  valuesEqual,
53
+ type FilteredSetValue,
54
+ type FunctionValue,
48
55
  type LazyFunctionSource,
49
56
  type LazyFunctionValue,
50
57
  type Value,
@@ -112,6 +119,7 @@ export interface Environment {
112
119
  definitionValues: Map<Definition, Value>;
113
120
  constantLevels: Map<Definition, boolean>;
114
121
  evaluators: WeakMap<Expression, Evaluator>;
122
+ trace?: Expression[];
115
123
  }
116
124
 
117
125
  export interface Context {
@@ -141,9 +149,6 @@ const EXCEPT_AT = "@";
141
149
  export const describeLocation = (expression: Expression) =>
142
150
  `line ${expression.location.line}, column ${expression.location.column}`;
143
151
 
144
- export const formatRange = (range: SourceRange) =>
145
- `line ${range.start.line}, col ${range.start.column} to line ${range.end.line}, col ${range.end.column} of module ${range.module}`;
146
-
147
152
  export const describeRange = (expression: Expression) => {
148
153
  const range = expression.location.range;
149
154
  return range ? formatRange(range) : describeLocation(expression);
@@ -180,8 +185,17 @@ export const getConjunctError = (
180
185
  };
181
186
 
182
187
  export const getFieldError =
183
- (expression: Expression & { kind: "FieldAccess" }) => (record: Value) =>
184
- `Attempted to select nonexistent field "${expression.field}" from the record\n${formatValue(record)}\n${describeRange(expression)}`;
188
+ (expression: Expression & { kind: "FieldAccess" }) => (record: FunctionValue) =>
189
+ isRecordValue(record)
190
+ ? `Attempted to select nonexistent field "${expression.field}" from the record\n${formatValue(record)}\n${describeRange(expression)}`
191
+ : describeMissingField(record, expression.field);
192
+
193
+ export const getNonFunctionError = (expression: Expression) => (value: Value) =>
194
+ `A non-function (${getKindString(value)}) was applied as a function.\n${describeRange(expression)}`;
195
+
196
+ export const getNonRecordError =
197
+ (expression: Expression & { kind: "FieldAccess" }) => (value: Value) =>
198
+ `Attempted to select field "${expression.field}" from a non-record value ${formatValue(value)}\n${describeRange(expression)}`;
185
199
 
186
200
  export const getDomainOperator = (expression: Expression) => (value: Value) => {
187
201
  if (!isFunctionValue(value)) {
@@ -262,96 +276,6 @@ export const expectBoolean = (value: Value, description: string) => {
262
276
  return value;
263
277
  };
264
278
 
265
- export const getChildren = (expression: Expression): Expression[] => {
266
- switch (expression.kind) {
267
- case "Number":
268
- case "Decimal":
269
- case "String":
270
- case "Identifier":
271
- case "OperatorReference":
272
- case "ExceptAt":
273
- return [];
274
- case "Apply":
275
- return expression.args;
276
- case "Lambda":
277
- return [expression.body];
278
- case "And":
279
- case "Or":
280
- return expression.operands;
281
- case "Prime":
282
- case "Unchanged":
283
- case "Enabled":
284
- case "Always":
285
- case "Eventually":
286
- return [expression.expression];
287
- case "If":
288
- return [expression.condition, expression.consequent, expression.alternative];
289
- case "Case":
290
- return [
291
- ...expression.arms.flatMap((arm) => [arm.condition, arm.body]),
292
- ...(expression.other ? [expression.other] : []),
293
- ];
294
- case "Let":
295
- return [
296
- ...expression.definitions.flatMap((definition) =>
297
- definition.kind === "Function"
298
- ? [...definition.bounds.map((bound) => bound.set), definition.body]
299
- : [definition.body],
300
- ),
301
- expression.body,
302
- ];
303
- case "Forall":
304
- case "Exists":
305
- return [...expression.bounds.map((bound) => bound.set), expression.body];
306
- case "UnboundedQuantifier":
307
- return [expression.body];
308
- case "Choose":
309
- return [...(expression.set ? [expression.set] : []), expression.body];
310
- case "SetEnumeration":
311
- case "Tuple":
312
- return expression.elements;
313
- case "SetFilter":
314
- return [expression.bound.set, expression.predicate];
315
- case "SetMap":
316
- return [expression.expression, ...expression.bounds.map((bound) => bound.set)];
317
- case "FunctionConstruction":
318
- return [...expression.bounds.map((bound) => bound.set), expression.body];
319
- case "FunctionSet":
320
- return [expression.domain, expression.range];
321
- case "Record":
322
- case "RecordSet":
323
- return expression.fields.map((field) => field.value);
324
- case "Except":
325
- return [
326
- expression.function,
327
- ...expression.updates.flatMap((update) => [
328
- ...update.path.flatMap((step) => (step.kind === "Index" ? step.args : [])),
329
- update.value,
330
- ]),
331
- ];
332
- case "FunctionApplication":
333
- return [expression.function, ...expression.args];
334
- case "FieldAccess":
335
- return [expression.record];
336
- case "Product":
337
- return expression.factors;
338
- case "BoxAction":
339
- case "AngleAction":
340
- return [expression.action, expression.subscript];
341
- case "WeakFairness":
342
- case "StrongFairness":
343
- return [expression.subscript, expression.action];
344
- case "Label":
345
- return [expression.body];
346
- case "Subexpression":
347
- return expression.selectors.flatMap((selector) => ("args" in selector ? selector.args : []));
348
- }
349
- };
350
-
351
- export const isLocallyResolved = (expression: Expression) =>
352
- (expression.kind === "Identifier" || expression.kind === "Apply") &&
353
- expression.resolution?.kind === "Local";
354
-
355
279
  export const getDefinition = (name: string, environment: Environment) =>
356
280
  environment.definitions.get(environment.substitutions.get(name) ?? name);
357
281
 
@@ -419,9 +343,8 @@ export const getEnumeratedElements = (set: Value, expression: Expression) => {
419
343
  : `TLC encountered the non-enumerable quantifier bound\n${text}\n${describeRange(expression)}\n${explanation}`,
420
344
  );
421
345
  }
422
- return typeof set === "object" && set.kind === "Interval"
423
- ? getIntervalElements(set)
424
- : toFiniteSet(set).elements;
346
+ if (typeof set === "object" && set.kind === "Interval") return getIntervalElements(set);
347
+ return getLazySubsets(set) ?? toFiniteSet(set).elements;
425
348
  };
426
349
 
427
350
  export const forEachBinding = (
@@ -859,11 +782,7 @@ const evaluateLocalIdentifier = (name: string, expression: Expression, context:
859
782
  const global = findGlobalName(name, context.environment);
860
783
  if (global?.kind === "Variable") {
861
784
  const value = context.state?.[global.index];
862
- if (value === undefined) {
863
- throw new TlaEvaluationError(
864
- `The variable ${name} is not assigned at ${describeLocation(expression)}`,
865
- );
866
- }
785
+ if (value === undefined) throw createUnassignedError(name, expression);
867
786
  return value;
868
787
  }
869
788
  if (global?.kind === "Value") return global.value;
@@ -1103,23 +1022,88 @@ const isStateCached = (expression: Expression, environment: Environment) =>
1103
1022
  getReadVariables(expression, environment) !== undefined &&
1104
1023
  !hasFreeLocals(expression, NO_BOUND_NAMES);
1105
1024
 
1025
+ // CallStackTool also evaluates the predicate of a lazy set filter it returns, even one that TLC
1026
+ // made before the replay.
1027
+ const filteredSetRetracers = new WeakMap<
1028
+ FilteredSetValue,
1029
+ (environment: Environment) => FilteredSetValue
1030
+ >();
1031
+
1032
+ const SOURCED_KINDS = new Set<Expression["kind"]>([
1033
+ "SetEnumeration",
1034
+ "SetMap",
1035
+ "SetFilter",
1036
+ "Tuple",
1037
+ "Record",
1038
+ "RecordSet",
1039
+ "FunctionSet",
1040
+ "Product",
1041
+ ]);
1042
+
1043
+ const SOURCED_OPERATORS = new Set(["SUBSET", "UNION", "DOMAIN", "\\cup", "\\cap", "\\"]);
1044
+
1045
+ // CallStackTool gives a set, tuple or record it builds the expression as its source, but not a lazy
1046
+ // set filter, which it returns as a copy.
1047
+ const isSourced = (expression: Expression, environment: Environment) =>
1048
+ SOURCED_KINDS.has(expression.kind) ||
1049
+ (expression.kind === "Apply" &&
1050
+ SOURCED_OPERATORS.has(expression.operator) &&
1051
+ !isLocallyResolved(expression) &&
1052
+ resolveGlobalOperator(expression.operator, environment)?.kind === "Builtin");
1053
+
1054
+ // When an evaluation fails, CallStackTool freezes the stack at the innermost expression and pushes
1055
+ // the source of each value whose method failed.
1056
+ const evaluateTraced = (
1057
+ evaluator: Evaluator,
1058
+ context: Context,
1059
+ trace: Expression[],
1060
+ depth: number,
1061
+ ) => {
1062
+ try {
1063
+ return evaluator(context);
1064
+ } catch (error) {
1065
+ if (trace.length === depth + 1) trace.push(...(getFingerprintTrace(error) ?? []));
1066
+ throw error;
1067
+ }
1068
+ };
1069
+
1106
1070
  export const getEvaluator = (expression: Expression, environment: Environment): Evaluator => {
1107
1071
  const cached = environment.evaluators.get(expression);
1108
1072
  if (cached) return cached;
1109
1073
  const compiled = compile(expression, environment);
1110
- const evaluator =
1074
+ const cachedEvaluator =
1111
1075
  isWorthCaching(expression) && isClosedConstant(expression, environment)
1112
1076
  ? cacheFirstValue(compiled)
1113
1077
  : isStateCached(expression, environment)
1114
1078
  ? cacheStateValue(compiled)
1115
1079
  : compiled;
1080
+ const trace = environment.trace;
1081
+ const isSourcedExpression = trace !== undefined && isSourced(expression, environment);
1082
+ // TLC's CallStackTool pushes each expression it evaluates and keeps the stack when one fails.
1083
+ const evaluator: Evaluator = trace
1084
+ ? (context) => {
1085
+ const depth = trace.length;
1086
+ trace.push(expression);
1087
+ const value = evaluateTraced(cachedEvaluator, context, trace, depth);
1088
+ trace.length = depth;
1089
+ if (isSourcedExpression && typeof value === "object" && value.kind !== "FilteredSet") {
1090
+ valueSources.current?.set(value, expression);
1091
+ }
1092
+ const retrace =
1093
+ typeof value === "object" && value.kind === "FilteredSet"
1094
+ ? filteredSetRetracers.get(value)
1095
+ : undefined;
1096
+ return retrace ? retrace(environment) : value;
1097
+ }
1098
+ : cachedEvaluator;
1116
1099
  environment.evaluators.set(expression, evaluator);
1117
1100
  return evaluator;
1118
1101
  };
1119
1102
 
1120
1103
  const entryEvaluators = new WeakMap<Expression, Evaluator>();
1121
1104
 
1122
- const getEntryEvaluator = (expression: Expression, environment: Environment) => {
1105
+ export const getEntryEvaluator = (expression: Expression, environment: Environment) => {
1106
+ if (environment.trace) return getEvaluator(expression, environment);
1123
1107
  const cached = entryEvaluators.get(expression);
1124
1108
  if (cached) return cached;
1125
1109
  const evaluator =
@@ -1143,11 +1127,7 @@ const compileIdentifier = (
1143
1127
  const index = global.index;
1144
1128
  return (context) => {
1145
1129
  const value = context.state?.[index];
1146
- if (value === undefined) {
1147
- throw new TlaEvaluationError(
1148
- `The variable ${name} is not assigned at ${describeLocation(expression)}`,
1149
- );
1150
- }
1130
+ if (value === undefined) throw createUnassignedError(name, expression);
1151
1131
  return value;
1152
1132
  };
1153
1133
  }
@@ -1232,11 +1212,32 @@ const getLazyArguments = (args: Expression[], context: Context): OperatorValue[]
1232
1212
  expression: arg,
1233
1213
  }));
1234
1214
 
1215
+ const RECEIVING_OPERATORS = new Set(["=", "#", "\\in", "\\notin", "\\cup", "\\cap", "\\"]);
1216
+
1217
+ // The argument whose method TLC calls to apply a built-in operator.
1218
+ const getReceiver = (name: string, left: Value, right: Value) =>
1219
+ name === "\\in" ||
1220
+ name === "\\notin" ||
1221
+ ((name === "\\cup" || name === "\\cap") && !isReducible(left))
1222
+ ? right
1223
+ : left;
1224
+
1235
1225
  const compileBuiltinCall = (
1236
1226
  builtin: Builtin,
1237
1227
  args: Expression[],
1238
1228
  environment: Environment,
1239
1229
  ): Evaluator => {
1230
+ if (environment.trace && RECEIVING_OPERATORS.has(builtin.name) && args.length === 2) {
1231
+ const evaluateLeft = getEvaluator(args[0], environment);
1232
+ const evaluateRight = getEvaluator(args[1], environment);
1233
+ return (context) => {
1234
+ const left = evaluateLeft(context);
1235
+ const right = evaluateRight(context);
1236
+ return withSource(getReceiver(builtin.name, left, right), () =>
1237
+ builtin.evaluate([left, right], context),
1238
+ );
1239
+ };
1240
+ }
1240
1241
  if (builtin.isLazy) {
1241
1242
  return (context) => builtin.evaluate(getLazyArguments(args, context), context);
1242
1243
  }
@@ -1396,6 +1397,13 @@ const compileApply = (
1396
1397
  if (global?.kind === "Builtin" && global.name === "DOMAIN") {
1397
1398
  const operand = getEvaluator(args[0], environment);
1398
1399
  const domain = getDomainOperator(expression);
1400
+ // TLC builds a new interval for the domain of a tuple, so the source it gives one stays its own.
1401
+ if (environment.trace) {
1402
+ return (context) => {
1403
+ const value = domain(operand(context));
1404
+ return typeof value === "object" && value.kind === "Interval" ? { ...value } : value;
1405
+ };
1406
+ }
1399
1407
  return (context) => domain(operand(context));
1400
1408
  }
1401
1409
  // TLC sorts the value of a constant TLCEval argument only where no context binds a name.
@@ -1411,6 +1419,13 @@ const compileApply = (
1411
1419
  const left = getEvaluator(args[0], environment);
1412
1420
  const right = getEvaluator(args[1], environment);
1413
1421
  const subset = getSubsetOperator(expression, global);
1422
+ if (environment.trace) {
1423
+ return (context) => {
1424
+ const subsetValue = left(context);
1425
+ const superset = right(context);
1426
+ return withSource(subsetValue, () => subset(subsetValue, superset));
1427
+ };
1428
+ }
1414
1429
  return (context) => subset(left(context), right(context));
1415
1430
  }
1416
1431
  if (global?.kind === "Builtin") return compileBuiltinCall(global, args, environment);
@@ -1421,6 +1436,11 @@ const compileApply = (
1421
1436
  if (definition?.kind === "Function") {
1422
1437
  throw new TlaEvaluationError(`${expression.operator} is a function; apply it with brackets`);
1423
1438
  }
1439
+ if (expression.operator === "\\cdot") {
1440
+ throw new TlaEvaluationError(
1441
+ "The current version of TLC does not support action composition. An incomplete implementation can be enabled via the tlc2.tool.impl.Tool.cdot=true java property.",
1442
+ );
1443
+ }
1424
1444
  throw new TlaEvaluationError(
1425
1445
  `Unknown operator ${expression.operator} at ${describeLocation(expression)}`,
1426
1446
  );
@@ -1516,7 +1536,13 @@ const compileFunctionConstruction = (
1516
1536
  const set = getEvaluator(bound.set, environment);
1517
1537
  return (context) => {
1518
1538
  const domain = isSingleName ? set(context) : getBoundsDomain(bounds, context);
1519
- if (expression.isRecursive || isKeptLazy || !isEnumerable(domain)) {
1539
+ // TLC builds the function only when it reduces every domain, and evaluates the body lazily
1540
+ // otherwise.
1541
+ const domains =
1542
+ typeof domain === "object" && domain.kind === "ProductSet" && bounds.length > 1
1543
+ ? domain.factors
1544
+ : [domain];
1545
+ if (expression.isRecursive || isKeptLazy || !domains.every(isReducible)) {
1520
1546
  const functionValue = createLazyFunction(
1521
1547
  domain,
1522
1548
  (argument) => body(withScope(context, bindArgument(bounds, context.scope, argument))),
@@ -1605,16 +1631,21 @@ const compileSetComprehension = (
1605
1631
  const pattern = expression.bound.pattern;
1606
1632
  return (context) => {
1607
1633
  const base = set(context);
1608
- const test = (element: Value) =>
1634
+ const getTest = (evaluatePredicate: Evaluator) => (element: Value) =>
1609
1635
  expectBoolean(
1610
- predicate(withScope(context, bindPattern(context.scope, pattern, element))),
1636
+ evaluatePredicate(withScope(context, bindPattern(context.scope, pattern, element))),
1611
1637
  "a set filter predicate",
1612
1638
  );
1613
- const isReducible =
1614
- typeof base === "object" &&
1615
- (base.kind === "Set" || base.kind === "MixedSet" || base.kind === "Interval");
1616
- if (!isReducible) {
1617
- if (isSetValue(base)) return { kind: "FilteredSet", base, test };
1639
+ const test = getTest(predicate);
1640
+ if (!isReducible(base)) {
1641
+ if (isSetValue(base)) {
1642
+ const filtered: FilteredSetValue = { kind: "FilteredSet", base, test };
1643
+ filteredSetRetracers.set(filtered, (traced) => ({
1644
+ ...filtered,
1645
+ test: getTest(getEvaluator(expression.predicate, traced)),
1646
+ }));
1647
+ return filtered;
1648
+ }
1618
1649
  throw new TlaEvaluationError(
1619
1650
  `TLC encountered a non-enumerable quantifier bound ${formatValue(base)} at ${describeLocation(expression.bound.set)}`,
1620
1651
  );
@@ -1659,11 +1690,30 @@ const compileSetComprehension = (
1659
1690
  };
1660
1691
  };
1661
1692
 
1662
- const compileRecord = (recordFields: RecordField[], environment: Environment): Evaluator => {
1663
- const fields = [...recordFields].sort((left, right) => compareValues(left.name, right.name));
1664
- const hasDuplicates = fields.some(
1665
- (field, index) => index > 0 && fields[index - 1].name === field.name,
1693
+ // TLC orders a record's fields by name.
1694
+ export const getSortedFields = (fields: RecordField[]) =>
1695
+ [...fields].sort((left, right) => compareValues(left.name, right.name));
1696
+
1697
+ export const hasDuplicateFields = (sortedFields: RecordField[]) =>
1698
+ sortedFields.some((field, index) => index > 0 && sortedFields[index - 1].name === field.name);
1699
+
1700
+ export const createUnassignedError = (name: string, expression: Expression) =>
1701
+ setOwnExitCode(
1702
+ new TlaUnassignedError(
1703
+ `In evaluation, the identifier ${name} is either undefined or not an operator.\n${describeRange(expression)}`,
1704
+ name,
1705
+ ),
1706
+ EXIT_STATUS.configParseError,
1707
+ );
1708
+
1709
+ export const createPrimeOutsideActionError = (expression: Expression) =>
1710
+ new TlaEvaluationError(
1711
+ `A primed expression appears outside an action at ${describeLocation(expression)}`,
1666
1712
  );
1713
+
1714
+ const compileRecord = (recordFields: RecordField[], environment: Environment): Evaluator => {
1715
+ const fields = getSortedFields(recordFields);
1716
+ const hasDuplicates = hasDuplicateFields(fields);
1667
1717
  const values = fields.map((field) => getEvaluator(field.value, environment));
1668
1718
  if (hasDuplicates) {
1669
1719
  return (context) =>
@@ -1741,11 +1791,7 @@ const compile = (expression: Expression, environment: Environment): Evaluator =>
1741
1791
  case "Prime": {
1742
1792
  const inner = child(expression.expression);
1743
1793
  return (context) => {
1744
- if (!context.next) {
1745
- throw new TlaEvaluationError(
1746
- `A primed expression appears outside an action at ${describeLocation(expression)}`,
1747
- );
1748
- }
1794
+ if (!context.next) throw createPrimeOutsideActionError(expression);
1749
1795
  return inner({
1750
1796
  environment: context.environment,
1751
1797
  scope: context.scope,
@@ -1825,9 +1871,7 @@ const compile = (expression: Expression, environment: Environment): Evaluator =>
1825
1871
  case "Record":
1826
1872
  return compileRecord(expression.fields, environment);
1827
1873
  case "RecordSet": {
1828
- const fields = [...expression.fields].sort((left, right) =>
1829
- compareValues(left.name, right.name),
1830
- );
1874
+ const fields = getSortedFields(expression.fields);
1831
1875
  const names = fields.map((field) => field.name);
1832
1876
  const sets = fields.map((field) => child(field.value));
1833
1877
  return (context) => ({ kind: "RecordSet", names, sets: sets.map((set) => set(context)) });
@@ -1848,18 +1892,41 @@ const compile = (expression: Expression, environment: Environment): Evaluator =>
1848
1892
  keepLazy(expression.function);
1849
1893
  const evaluateFunction = child(expression.function);
1850
1894
  const args = expression.args.map(child);
1895
+ const describeNonFunction = getNonFunctionError(expression);
1896
+ if (args.length === 1 && environment.trace) {
1897
+ const argument = args[0];
1898
+ return (context) => {
1899
+ const functionValue = evaluateFunction(context);
1900
+ const argumentValue = argument(context);
1901
+ const apply = () =>
1902
+ applyFunction(functionValue, argumentValue, undefined, describeNonFunction);
1903
+ return isFunctionValue(functionValue) ? withSource(functionValue, apply) : apply();
1904
+ };
1905
+ }
1851
1906
  if (args.length === 1) {
1852
1907
  const argument = args[0];
1853
- return (context) => applyFunction(evaluateFunction(context), argument(context));
1908
+ return (context) =>
1909
+ applyFunction(
1910
+ evaluateFunction(context),
1911
+ argument(context),
1912
+ undefined,
1913
+ describeNonFunction,
1914
+ );
1854
1915
  }
1855
1916
  return (context) =>
1856
- applyFunction(evaluateFunction(context), createTuple(args.map((arg) => arg(context))));
1917
+ applyFunction(
1918
+ evaluateFunction(context),
1919
+ createTuple(args.map((arg) => arg(context))),
1920
+ undefined,
1921
+ describeNonFunction,
1922
+ );
1857
1923
  }
1858
1924
  case "FieldAccess": {
1859
1925
  const record = child(expression.record);
1860
1926
  const field = expression.field;
1861
1927
  const describeMissing = getFieldError(expression);
1862
- return (context) => applyFunction(record(context), field, describeMissing);
1928
+ const describeNonRecord = getNonRecordError(expression);
1929
+ return (context) => applyFunction(record(context), field, describeMissing, describeNonRecord);
1863
1930
  }
1864
1931
  case "Product": {
1865
1932
  const factors = expression.factors.map(child);
package/src/exit-codes.ts CHANGED
@@ -17,12 +17,6 @@ export const EXIT_STATUS = {
17
17
  } as const;
18
18
 
19
19
  const exitCodes = new WeakMap<Error, number>();
20
- const moduleExitCodes = new WeakMap<Error, number>();
21
- const phase = { isNextState: false };
22
-
23
- export const setNextStatePhase = (isNextState: boolean) => {
24
- phase.isNextState = isNextState;
25
- };
26
20
 
27
21
  // The innermost site that knows TLC's exit status for an error sets it first and wins.
28
22
  export const setExitCode = <Thrown>(error: Thrown, code: number) => {
@@ -30,15 +24,21 @@ export const setExitCode = <Thrown>(error: Thrown, code: number) => {
30
24
  return error;
31
25
  };
32
26
 
33
- // TLC exits with the code of an exception from a standard module's Java code only when the exception
34
- // escapes the computation of next states. In every other phase, the phase decides the code.
35
- export const setModuleExitCode = (error: Error, code: number) => {
36
- if (phase.isNextState) moduleExitCodes.set(error, code);
27
+ export const getExitCode = (error: Error) => exitCodes.get(error);
28
+
29
+ const ownExitCodes = new WeakMap<Error, number>();
30
+
31
+ // The exit status of the error code TLC gives an EvalException, which TLC uses only where it
32
+ // doesn't report the error again as a nested expression.
33
+ export const setOwnExitCode = <Thrown extends Error>(error: Thrown, code: number) => {
34
+ ownExitCodes.set(error, code);
35
+ return error;
37
36
  };
38
37
 
39
- export const getExitCode = (error: Error) => exitCodes.get(error) ?? moduleExitCodes.get(error);
38
+ export const getOwnExitCode = (error: unknown) =>
39
+ error instanceof Error ? ownExitCodes.get(error) : undefined;
40
40
 
41
- // TLC exits with 255 when it fails to process or evaluate a liveness property, in any phase.
41
+ // TLC exits with 255 when it fails to process or evaluate a liveness property.
42
42
  const withErrorExitCode = <Result>(run: () => Result) => {
43
43
  try {
44
44
  return run();
@@ -53,8 +53,15 @@ export const withLivenessExitCode = (
53
53
  const checker = withErrorExitCode(create);
54
54
  return (
55
55
  checker && {
56
- addInitialState: (index, state) =>
57
- withErrorExitCode(() => checker.addInitialState(index, state)),
56
+ // TLC replays the initial states to report an error, but skips the liveness check of a
57
+ // state it has already seen, so it exits with the status of the error's own code.
58
+ addInitialState: (index, state) => {
59
+ try {
60
+ checker.addInitialState(index, state);
61
+ } catch (error) {
62
+ throw setExitCode(error, getOwnExitCode(error) ?? EXIT_STATUS.error);
63
+ }
64
+ },
58
65
  addState: (index, state, successors) =>
59
66
  withErrorExitCode(() => checker.addState(index, state, successors)),
60
67
  findViolation: () => withErrorExitCode(() => checker.findViolation()),
@@ -1,4 +1,4 @@
1
- import { getValueFingerprint, getValueHash, type Value } from "./values";
1
+ import { assertFingerprintable, getValueFingerprint, getValueHash, type Value } from "./values";
2
2
 
3
3
  const EMPTY = 0;
4
4
  const INITIAL_CAPACITY = 1 << 12;
@@ -20,6 +20,7 @@ export const writeStateFingerprint = (state: Value[], fingerprint: Int32Array) =
20
20
  first = Math.imul(first ^ getValueHash(state[index]), 0x01000193);
21
21
  second = Math.imul(second ^ getValueFingerprint(state[index]), 0x5bd1e995);
22
22
  }
23
+ assertFingerprintable(state);
23
24
  fingerprint[0] = mix(first) || 1;
24
25
  fingerprint[1] = mix(second);
25
26
  };
package/src/instances.ts CHANGED
@@ -1,16 +1,17 @@
1
- import type {
2
- Bound,
3
- BoundPattern,
4
- Definition,
5
- Expression,
6
- Instance,
7
- Module,
8
- OperatorParam,
9
- SourceLocation,
10
- Theorem,
1
+ import {
2
+ getChildren,
3
+ isLocallyResolved,
4
+ type Bound,
5
+ type BoundPattern,
6
+ type Definition,
7
+ type Expression,
8
+ type Instance,
9
+ type Module,
10
+ type OperatorParam,
11
+ type SourceLocation,
12
+ type Theorem,
11
13
  } from "./ast";
12
14
  import { TlaSyntaxError } from "./errors";
13
- import { getChildren, isLocallyResolved } from "./evaluate";
14
15
  import { getArity, getBoundNames, getPatternNames, isBefore } from "./resolve";
15
16
 
16
17
  export const substitutedExpressions = new WeakSet<Expression>();
@@ -163,7 +164,7 @@ export const mapChildren = (
163
164
  case "RecordSet":
164
165
  return {
165
166
  ...expression,
166
- fields: expression.fields.map((field) => ({ name: field.name, value: plain(field.value) })),
167
+ fields: expression.fields.map((field) => ({ ...field, value: plain(field.value) })),
167
168
  };
168
169
  case "Except":
169
170
  return {
@@ -218,7 +219,7 @@ interface Instantiation {
218
219
  variables: Set<string>;
219
220
  getDefinition: (key: string) => Definition | undefined;
220
221
  isParameterized: (key: string) => boolean;
221
- addDefinition: (name: string, create: (key: string) => Definition) => string;
222
+ addDefinition: (source: string, name: string, create: (key: string) => Definition) => string;
222
223
  createName: (name: string) => string;
223
224
  }
224
225
 
@@ -639,7 +640,7 @@ const copyDefinition = (rewrite: Rewrite, key: string): string => {
639
640
  const instantiation = rewrite.instantiation;
640
641
  const definition = instantiation.getDefinition(key);
641
642
  if (!definition) return key;
642
- return instantiation.addDefinition(definition.name, (copyKey) => {
643
+ return instantiation.addDefinition(key, definition.name, (copyKey) => {
643
644
  rewrite.copies.set(key, copyKey);
644
645
  const rename = createRenamer(rewrite);
645
646
  const mapped = renameParams(
@@ -678,7 +679,7 @@ export const createInstantiation = (instantiation: Instantiation) => {
678
679
  if (copy !== undefined) return copy;
679
680
  const definition = instantiation.getDefinition(key);
680
681
  if (!definition) return key;
681
- return instantiation.addDefinition(definition.name, () =>
682
+ return instantiation.addDefinition(key, definition.name, () =>
682
683
  withInstanceParams(definition, instantiation.params, definition.location),
683
684
  );
684
685
  },