tla-ts 0.0.3-dev.79f7ed7 → 0.0.3-dev.868dd4c

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 (47) hide show
  1. package/README.md +16 -2
  2. package/dist/index.cjs +1 -1
  3. package/dist/index.d.cts +10 -0
  4. package/dist/index.d.ts +10 -0
  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 +17 -16
  11. package/dist/run-cli.js +6 -5
  12. package/dist/transfer.cjs +27 -15
  13. package/dist/transfer.js +27 -15
  14. package/package.json +1 -1
  15. package/src/ast.ts +90 -0
  16. package/src/check.ts +259 -76
  17. package/src/cli-options.ts +11 -5
  18. package/src/codegen.ts +15 -22
  19. package/src/dependencies.ts +2 -2
  20. package/src/environment.ts +88 -20
  21. package/src/errors.ts +18 -2
  22. package/src/evaluate.ts +117 -147
  23. package/src/exit-codes.ts +21 -43
  24. package/src/instances.ts +15 -14
  25. package/src/levels.ts +8 -8
  26. package/src/lexer.ts +5 -1
  27. package/src/live-check.ts +770 -0
  28. package/src/liveness.ts +54 -535
  29. package/src/parallel-worker.ts +7 -3
  30. package/src/parallel.ts +20 -4
  31. package/src/parser.ts +12 -1
  32. package/src/resolve.ts +16 -15
  33. package/src/run-cli.ts +58 -13
  34. package/src/runtime.ts +3 -1
  35. package/src/spec-description.ts +18 -6
  36. package/src/standard-modules.ts +2 -7
  37. package/src/state-graph.ts +157 -0
  38. package/src/subexpressions.ts +10 -10
  39. package/src/successors.ts +78 -14
  40. package/src/symmetry.ts +30 -8
  41. package/src/tableau.ts +51 -24
  42. package/src/tlc-ext.ts +29 -12
  43. package/src/tlc-module.ts +9 -28
  44. package/src/tlc-order.ts +25 -7
  45. package/src/tlc-random.ts +9 -6
  46. package/src/tlc-summary.ts +20 -5
  47. package/src/values.ts +128 -24
package/src/values.ts CHANGED
@@ -5,6 +5,7 @@ export interface ModelValue {
5
5
  kind: "ModelValue";
6
6
  name: string;
7
7
  type: string | undefined;
8
+ rank: number;
8
9
  }
9
10
 
10
11
  export interface SetValue {
@@ -136,6 +137,13 @@ export const isSetValue = (value: Value) =>
136
137
  value.kind !== "Function" &&
137
138
  value.kind !== "LazyFunction";
138
139
 
140
+ export type ReducibleSet = SetValue | MixedSetValue | IntervalValue;
141
+
142
+ // TLC reduces a set enumeration or an interval eagerly, and keeps every other set lazy.
143
+ export const isReducible = (value: Value): value is ReducibleSet =>
144
+ typeof value === "object" &&
145
+ (value.kind === "Set" || value.kind === "MixedSet" || value.kind === "Interval");
146
+
139
147
  export const isFunctionValue = (value: Value): value is FunctionValue | LazyFunctionValue =>
140
148
  typeof value === "object" && (value.kind === "Function" || value.kind === "LazyFunction");
141
149
 
@@ -264,6 +272,7 @@ const stringOrder = { ranks: Object.create(null) as Record<string, number>, size
264
272
  export const setStringOrder = (texts: Iterable<string>) => {
265
273
  stringOrder.ranks = Object.create(null);
266
274
  stringOrder.size = 0;
275
+ modelValues.clear();
267
276
  for (const text of texts) rankString(text);
268
277
  };
269
278
 
@@ -353,7 +362,7 @@ export const compareValues = (left: Value, right: Value): number => {
353
362
  if (left.type !== undefined && right.type !== undefined) {
354
363
  checkModelValueTypes(left, right, false);
355
364
  }
356
- return compareStrings(left.name, right.name);
365
+ return left.rank - right.rank;
357
366
  }
358
367
  if (leftKind === "ModelValue" || rightKind === "ModelValue") {
359
368
  checkModelValueTypes(left, right, false);
@@ -369,7 +378,7 @@ export const compareValues = (left: Value, right: Value): number => {
369
378
  `Attempted to compare ${describeKind(left)} ${formatValue(left)} with ${describeKind(right)} ${formatValue(right)}`,
370
379
  );
371
380
  }
372
- if (isLeftSet) return compareSets(toFiniteSet(left), toFiniteSet(right));
381
+ if (isLeftSet) return compareSets(toFiniteSet(left), toComparedSet(right));
373
382
  return compareFunctions(toFiniteFunction(left), toFiniteFunction(right));
374
383
  }
375
384
  if (typeof left === "number" && typeof right === "number") return left - right;
@@ -385,14 +394,15 @@ export const compareValues = (left: Value, right: Value): number => {
385
394
 
386
395
  const modelValues = new Map<string, ModelValue>();
387
396
 
397
+ // A check ranks every model value's name when it creates the value, and creates its own values.
388
398
  export const createModelValue = (name: string): ModelValue => {
389
- rankString(name);
390
399
  const known = modelValues.get(name);
391
400
  if (known) return known;
392
401
  const value: ModelValue = {
393
402
  kind: "ModelValue",
394
403
  name,
395
404
  type: name.length > 2 && name[1] === "_" ? name[0] : undefined,
405
+ rank: getStringRank(name),
396
406
  };
397
407
  modelValues.set(name, value);
398
408
  return value;
@@ -562,7 +572,7 @@ const equalsModelValueWith = (modelValue: ModelValue, other: Value) => {
562
572
 
563
573
  const compareModelValue = (left: ModelValue, right: Value) => {
564
574
  const type = getModelValueType(left);
565
- if (type === undefined) return isModelValue(right) ? compareStrings(left.name, right.name) : -1;
575
+ if (type === undefined) return isModelValue(right) ? left.rank - right.rank : -1;
566
576
  if (!isModelValue(right)) {
567
577
  throw new TlaEvaluationError(
568
578
  `Attempted to compare the typed model value ${formatValue(left)} and non-model value\n${formatValue(right)}`,
@@ -574,7 +584,7 @@ const compareModelValue = (left: ModelValue, right: Value) => {
574
584
  `Attempted to compare the differently-typed model values ${formatValue(left)} and ${formatValue(right)}`,
575
585
  );
576
586
  }
577
- return compareStrings(left.name, right.name);
587
+ return left.rank - right.rank;
578
588
  };
579
589
 
580
590
  const equalsModelValue = (left: ModelValue, right: Value) => {
@@ -861,9 +871,11 @@ export const isEqualLikeTlc = (left: Value, right: Value) => {
861
871
  }
862
872
  };
863
873
 
874
+ // TLC sorts a set by comparing each element with the ones before it, so the later element converts
875
+ // a lazy set it compares and caches it.
864
876
  const isStrictlySorted = (elements: Value[]) => {
865
877
  for (let index = 1; index < elements.length; index++) {
866
- if (compareValues(elements[index - 1], elements[index]) >= 0) return false;
878
+ if (compareValues(elements[index], elements[index - 1]) <= 0) return false;
867
879
  }
868
880
  return true;
869
881
  };
@@ -1066,13 +1078,16 @@ const isTlcEnumerable = (value: Value) => isSetValue(value) && !isOverriddenSet(
1066
1078
  const formatUnion = (value: UnionValue, isStrict = false) =>
1067
1079
  `UNION(${formatValue(value.base, isStrict)})`;
1068
1080
 
1069
- const getUnionSets = (value: UnionValue) => {
1081
+ const getUnionSets = (
1082
+ value: UnionValue,
1083
+ getElements = (set: Value) => toFiniteSet(set).elements,
1084
+ ) => {
1070
1085
  if (!isTlcEnumerable(value.base)) {
1071
1086
  throw new TlaEvaluationError(
1072
1087
  `Attempted to enumerate the nonenumerable set:\n${formatUnion(value)}`,
1073
1088
  );
1074
1089
  }
1075
- return toFiniteSet(value.base).elements;
1090
+ return getElements(value.base);
1076
1091
  };
1077
1092
 
1078
1093
  const getUnionSet = (set: Value, index: number, union: UnionValue) => {
@@ -1108,7 +1123,7 @@ export const isEnumerable = (value: Value): boolean => {
1108
1123
  case "ProductSet":
1109
1124
  return value.factors.every(isEnumerable) || getEmptiness(value) === true;
1110
1125
  case "Union":
1111
- return isEnumerable(value.base) && toFiniteSet(value.base).elements.every(isEnumerable);
1126
+ return isEnumerable(value.base) && getStreamedElements(value.base).every(isEnumerable);
1112
1127
  case "SetOperation":
1113
1128
  if (value.operator === "\\cup") return isEnumerable(value.left) && isEnumerable(value.right);
1114
1129
  if (value.operator === "\\cap") return isEnumerable(value.left) || isEnumerable(value.right);
@@ -1209,9 +1224,7 @@ const enumerateSet = (value: Value): Value[] => {
1209
1224
  if (isOverriddenSet(value.base)) getCardinality(value.base);
1210
1225
  const base = toFiniteSet(value.base).elements;
1211
1226
  if (base.length > MAXIMUM_ENUMERATED_SUBSET_BASE) {
1212
- throw new TlaEvaluationError(
1213
- `SUBSET of a set with ${base.length} elements is too large to enumerate`,
1214
- );
1227
+ throw new TlaEvaluationError(describeOverflow(value));
1215
1228
  }
1216
1229
  return getSortedSubsets(base);
1217
1230
  }
@@ -1315,6 +1328,7 @@ const enumerateSet = (value: Value): Value[] => {
1315
1328
  };
1316
1329
 
1317
1330
  const finiteSets = new WeakMap<ObjectValue, SetValue>();
1331
+ const comparedSets = new WeakMap<ObjectValue, SetValue>();
1318
1332
 
1319
1333
  export const toFiniteSet = (value: Value): SetValue => {
1320
1334
  if (typeof value === "object" && value.kind === "Set") return value;
@@ -1323,6 +1337,13 @@ export const toFiniteSet = (value: Value): SetValue => {
1323
1337
  }
1324
1338
  const cached = typeof value === "object" ? finiteSets.get(value) : undefined;
1325
1339
  if (cached) return cached;
1340
+ const set =
1341
+ (typeof value === "object" ? comparedSets.get(value) : undefined) ?? enumerateFiniteSet(value);
1342
+ if (typeof value === "object") finiteSets.set(value, set);
1343
+ return set;
1344
+ };
1345
+
1346
+ const enumerateFiniteSet = (value: Value) => {
1326
1347
  const elements = enumerateSet(value);
1327
1348
  const isSorted =
1328
1349
  typeof value === "object" &&
@@ -1333,8 +1354,20 @@ export const toFiniteSet = (value: Value): SetValue => {
1333
1354
  value.kind === "ProductSet" ||
1334
1355
  value.kind === "FunctionSet" ||
1335
1356
  value.kind === "Subset");
1336
- const set = isSorted ? createSortedSet(elements) : createSet(elements);
1337
- if (typeof value === "object") finiteSets.set(value, set);
1357
+ return isSorted ? createSortedSet(elements) : createSet(elements);
1358
+ };
1359
+
1360
+ // TLC converts the set a comparison receives as its argument without caching it, so a lazy set
1361
+ // compared that way still streams the sets it combines.
1362
+ const toComparedSet = (value: Value) => {
1363
+ const isStreamed =
1364
+ typeof value === "object" &&
1365
+ (value.kind === "Union" || value.kind === "SetOperation" || value.kind === "FilteredSet");
1366
+ if (!isStreamed || finiteSets.has(value)) return toFiniteSet(value);
1367
+ const compared = comparedSets.get(value);
1368
+ if (compared) return compared;
1369
+ const set = enumerateFiniteSet(value);
1370
+ comparedSets.set(value, set);
1338
1371
  return set;
1339
1372
  };
1340
1373
 
@@ -1342,8 +1375,10 @@ export const toFiniteSet = (value: Value): SetValue => {
1342
1375
  // so an element that two of them share comes up once for each.
1343
1376
  export const getStreamedElements = (value: Value): Value[] => {
1344
1377
  if (typeof value !== "object" || finiteSets.has(value)) return toFiniteSet(value).elements;
1378
+ // TLC streams the sets of a UNION it hasn't enumerated, so a set that appears twice there yields
1379
+ // its elements twice.
1345
1380
  if (value.kind === "Union") {
1346
- return getUnionSets(value).flatMap((set, index) =>
1381
+ return getUnionSets(value, getStreamedElements).flatMap((set, index) =>
1347
1382
  getStreamedElements(getUnionSet(set, index, value)),
1348
1383
  );
1349
1384
  }
@@ -1715,10 +1750,61 @@ export const markLambdaFunction = <FunctionLike extends FunctionValue | LazyFunc
1715
1750
  return functionValue;
1716
1751
  };
1717
1752
 
1718
- const describeMissingArgument = (functionValue: Value, argument: Value) =>
1719
- typeof functionValue === "object" && lambdaFunctions.has(functionValue)
1720
- ? `In applying the function\n${prettyPrint(formatValue(functionValue))},\nthe first argument is:\n${prettyPrint(formatValue(argument))}\nwhich is not in its domain.\n`
1721
- : `Attempted to apply function ${formatValue(functionValue)} to ${formatValue(argument)}, which is not in its domain`;
1753
+ // TLC applies a tuple, a record and a function over an interval with their own classes, and each
1754
+ // reports a missing argument in its own words.
1755
+ const getFunctionClass = (functionValue: FunctionValue) => {
1756
+ const domain = functionValue.domain;
1757
+ if (domain.length === 0) return lambdaFunctions.has(functionValue) ? "FcnRcdValue" : "TupleValue";
1758
+ if (domain === intervalDomains[domain.length]) return "TupleValue";
1759
+ if (intervalArrays.has(domain)) return "IntervalFcnRcdValue";
1760
+ return domain.every((key) => typeof key === "string") ? "RecordValue" : "FcnRcdValue";
1761
+ };
1762
+
1763
+ const describeNotInDomain = (functionValue: FunctionValue, argument: Value) =>
1764
+ `Attempted to apply function:\n${prettyPrint(formatValue(functionValue))}\nto argument ${prettyPrint(formatValue(argument))}, which is not in the domain of the function.`;
1765
+
1766
+ const describeNonIntegerArgument = (argument: Value) =>
1767
+ `Attempted to apply function with integer domain to the non-integer argument ${prettyPrint(formatValue(argument))}`;
1768
+
1769
+ const describeMissingArgument = (
1770
+ functionValue: FunctionValue | LazyFunctionValue,
1771
+ argument: Value,
1772
+ ) => {
1773
+ if (lambdaFunctions.has(functionValue) || functionValue.kind === "LazyFunction")
1774
+ return `In applying the function\n${prettyPrint(formatValue(functionValue))},\nthe first argument is:\n${prettyPrint(formatValue(argument))}\nwhich is not in its domain.\n`;
1775
+ const functionClass = getFunctionClass(functionValue);
1776
+ if (functionClass === "TupleValue")
1777
+ return typeof argument === "number"
1778
+ ? `Attempted to access index ${argument} of tuple\n${prettyPrint(formatValue(functionValue))}\nwhich is out of bounds.`
1779
+ : `Attempted to access tuple at a non integral index: ${prettyPrint(formatValue(argument))}`;
1780
+ if (functionClass === "RecordValue")
1781
+ return typeof argument === "string"
1782
+ ? `Attempted to access nonexistent field '${argument}' of record\n${prettyPrint(formatValue(functionValue))}`
1783
+ : `Attempted to access record by a non-string argument: ${prettyPrint(formatValue(argument))}`;
1784
+ return functionClass === "IntervalFcnRcdValue" && typeof argument !== "number"
1785
+ ? describeNonIntegerArgument(argument)
1786
+ : describeNotInDomain(functionValue, argument);
1787
+ };
1788
+
1789
+ // TLC selects a field of a value that isn't a record from the function the value converts to,
1790
+ // which keeps a tuple's domain as an interval.
1791
+ export const describeMissingField = (functionValue: FunctionValue, field: string) =>
1792
+ getFunctionClass(functionValue) === "FcnRcdValue"
1793
+ ? describeNotInDomain(functionValue, field)
1794
+ : describeNonIntegerArgument(field);
1795
+
1796
+ export const isRecordValue = (functionValue: FunctionValue) =>
1797
+ getFunctionClass(functionValue) === "RecordValue";
1798
+
1799
+ // TLC checks the type of an argument to a tuple or a record before it looks the argument up, so
1800
+ // it never compares the argument with a key of another type.
1801
+ const isForeignKey = (domain: Value[], argument: Value) => {
1802
+ const first = domain[0];
1803
+ return typeof first === "number"
1804
+ ? typeof argument !== "number" &&
1805
+ (domain === intervalDomains[domain.length] || intervalArrays.has(domain))
1806
+ : typeof first === "string" && typeof argument !== "string";
1807
+ };
1722
1808
 
1723
1809
  const findKeyIndex = (domain: Value[], argument: Value) => {
1724
1810
  const first = domain[0];
@@ -1737,6 +1823,7 @@ export const applyFunction = (
1737
1823
  functionValue: Value,
1738
1824
  argument: Value,
1739
1825
  describeMissing?: (functionValue: FunctionValue) => string,
1826
+ describeNonFunction?: (value: Value) => string,
1740
1827
  ): Value => {
1741
1828
  if (typeof functionValue === "object" && functionValue.kind === "LazyFunction") {
1742
1829
  if (!isElementOf(argument, functionValue.domain)) {
@@ -1750,10 +1837,13 @@ export const applyFunction = (
1750
1837
  }
1751
1838
  if (typeof functionValue !== "object" || functionValue.kind !== "Function") {
1752
1839
  throw new TlaEvaluationError(
1753
- `Attempted to apply ${formatValue(functionValue)}, which is not a function`,
1840
+ describeNonFunction?.(functionValue) ??
1841
+ `Attempted to apply ${formatValue(functionValue)}, which is not a function`,
1754
1842
  );
1755
1843
  }
1756
- const position = findKeyIndex(functionValue.domain, argument);
1844
+ const position = isForeignKey(functionValue.domain, argument)
1845
+ ? -1
1846
+ : findKeyIndex(functionValue.domain, argument);
1757
1847
  if (position === -1) {
1758
1848
  throw new TlaEvaluationError(
1759
1849
  describeMissing?.(functionValue) ?? describeMissingArgument(functionValue, argument),
@@ -2098,8 +2188,11 @@ export const formatValue = (value: Value, isStrict = false, isNormalized = false
2098
2188
  return `[${parameters} |-> <expression ${source.body}>]`;
2099
2189
  }
2100
2190
  const functionValue = toFiniteFunction(value);
2191
+ // TLC normalizes a lambda's domain to print it, but evaluates its body afterward.
2192
+ const formatRange = (inner: Value) =>
2193
+ formatValue(inner, isStrict, isNormalized && value.kind === "Function");
2101
2194
  if (functionValue.domain.every((key, index) => key === index + 1)) {
2102
- return `<<${functionValue.range.map(format).join(", ")}>>`;
2195
+ return `<<${functionValue.range.map(formatRange).join(", ")}>>`;
2103
2196
  }
2104
2197
  if (functionValue.domain.every((key) => typeof key === "string" && isFieldName(key))) {
2105
2198
  const isSorted =
@@ -2107,9 +2200,20 @@ export const formatValue = (value: Value, isStrict = false, isNormalized = false
2107
2200
  const pairs = isSorted
2108
2201
  ? functionValue.domain.map((key, index) => [key, functionValue.range[index]])
2109
2202
  : getWrittenPairs(functionValue);
2110
- return `[${pairs.map((pair) => `${String(pair[0])} |-> ${format(pair[1])}`).join(", ")}]`;
2203
+ return `[${pairs.map((pair) => `${String(pair[0])} |-> ${formatRange(pair[1])}`).join(", ")}]`;
2111
2204
  }
2112
- return `(${functionValue.domain.map((key, index) => `${format(key)} :> ${format(functionValue.range[index])}`).join(" @@ ")})`;
2205
+ return `(${functionValue.domain.map((key, index) => `${format(key)} :> ${formatRange(functionValue.range[index])}`).join(" @@ ")})`;
2113
2206
  }
2114
2207
  }
2115
2208
  };
2209
+
2210
+ // TLC's TLCState.toString: a line per variable, as a conjunction when there are several.
2211
+ export const formatState = (state: Record<string, Value>) => {
2212
+ const entries = Object.entries(state);
2213
+ return entries
2214
+ .map(
2215
+ ([name, value]) =>
2216
+ `${entries.length === 1 ? "" : "/\\ "}${name} = ${prettyPrint(formatValue(value))}\n`,
2217
+ )
2218
+ .join("");
2219
+ };