tla-ts 0.0.3-dev.2032e26 → 0.0.3-dev.27a0c3a
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/README.md +5 -1
- package/dist/index.cjs +1 -1
- package/dist/index.d.cts +31 -22
- package/dist/index.d.ts +31 -22
- package/dist/index.js +1 -1
- package/dist/parallel-worker.cjs +1 -1
- package/dist/parallel-worker.js +2 -2
- package/dist/parallel.cjs +1 -1
- package/dist/parallel.js +2 -2
- package/dist/run-cli.cjs +17 -16
- package/dist/run-cli.js +6 -5
- package/dist/transfer.cjs +29 -15
- package/dist/transfer.js +29 -15
- package/package.json +1 -1
- package/src/ast.ts +90 -0
- package/src/check.ts +329 -89
- package/src/cli-options.ts +11 -5
- package/src/codegen.ts +15 -22
- package/src/config.ts +224 -170
- package/src/dependencies.ts +2 -2
- package/src/environment.ts +94 -24
- package/src/errors.ts +30 -2
- package/src/evaluate.ts +123 -147
- package/src/exit-codes.ts +39 -42
- package/src/instances.ts +15 -14
- package/src/levels.ts +8 -8
- package/src/live-check.ts +772 -0
- package/src/liveness.ts +116 -543
- package/src/parallel-worker.ts +2 -2
- package/src/parallel.ts +5 -2
- package/src/resolve.ts +16 -15
- package/src/run-cli.ts +58 -13
- package/src/runtime.ts +3 -1
- package/src/spec-description.ts +18 -6
- package/src/standard-modules.ts +2 -7
- package/src/state-graph.ts +157 -0
- package/src/subexpressions.ts +10 -10
- package/src/successors.ts +96 -25
- package/src/symmetry.ts +16 -6
- package/src/tableau.ts +51 -24
- package/src/tlc-ext.ts +29 -12
- package/src/tlc-module.ts +14 -33
- package/src/tlc-modules.ts +4 -0
- package/src/tlc-order.ts +8 -4
- package/src/tlc-random.ts +9 -6
- package/src/tlc-summary.ts +20 -5
- package/src/values.ts +121 -20
package/src/environment.ts
CHANGED
|
@@ -1,23 +1,24 @@
|
|
|
1
|
-
import
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
1
|
+
import {
|
|
2
|
+
getChildren,
|
|
3
|
+
type Assumption,
|
|
4
|
+
type Declaration,
|
|
5
|
+
type Definition,
|
|
6
|
+
type Expression,
|
|
7
|
+
type Instance,
|
|
8
|
+
type Module,
|
|
9
|
+
type OperatorParam,
|
|
10
|
+
type SourceLocation,
|
|
10
11
|
} from "./ast";
|
|
11
12
|
import { BUNDLED_MODULES } from "./bundled-modules";
|
|
12
13
|
import type { ConfigValue, ModelConfig } from "./config";
|
|
13
14
|
import type { FileSystem } from "./json";
|
|
14
|
-
import { TlaConfigError, TlaEvaluationError, TlaSyntaxError } from "./errors";
|
|
15
|
+
import { TlaConfigError, TlaEvaluationError, TlaModuleError, TlaSyntaxError } from "./errors";
|
|
15
16
|
import { EXIT_STATUS, setExitCode } from "./exit-codes";
|
|
16
17
|
import {
|
|
17
18
|
createBigNumberError,
|
|
18
19
|
createRealNumberError,
|
|
19
|
-
|
|
20
|
-
|
|
20
|
+
evaluate,
|
|
21
|
+
getDefinition,
|
|
21
22
|
isTlcInteger,
|
|
22
23
|
type Builtin,
|
|
23
24
|
type Environment,
|
|
@@ -44,8 +45,9 @@ import {
|
|
|
44
45
|
import { createRuntime } from "./runtime";
|
|
45
46
|
import { CORE_OPERATORS, getStandardModule, STANDARD_DEPENDENCIES } from "./standard-modules";
|
|
46
47
|
import { resolveInstanceSubexpressions, resolveModuleSubexpressions } from "./subexpressions";
|
|
47
|
-
import { checkModuleLevels } from "./levels";
|
|
48
|
+
import { checkModuleLevels, createLevelAnalyzer } from "./levels";
|
|
48
49
|
import { checkInstances, type InstanceCheck } from "./substitution-levels";
|
|
50
|
+
import { getTlcDeclarationOrder } from "./tlc-order";
|
|
49
51
|
import {
|
|
50
52
|
checkInteger,
|
|
51
53
|
createModelValue,
|
|
@@ -212,6 +214,8 @@ export const createEnvironment = (
|
|
|
212
214
|
const root = parseModule(options.source);
|
|
213
215
|
const definitions = new Map<string, Definition>();
|
|
214
216
|
const parameterized = new Map<string, boolean>();
|
|
217
|
+
// The definition each instance copy came from, and the instance parameters the copy adds.
|
|
218
|
+
const copySources = new Map<string, { source: string; prefix: number }>();
|
|
215
219
|
const builtins = new Map<string, Builtin>(
|
|
216
220
|
CORE_OPERATORS.map((operator) => [operator.name, operator]),
|
|
217
221
|
);
|
|
@@ -379,10 +383,11 @@ export const createEnvironment = (
|
|
|
379
383
|
variables: new Set(linked.variables),
|
|
380
384
|
getDefinition: (key) => definitions.get(key),
|
|
381
385
|
isParameterized: (key) => parameterized.get(key) === true,
|
|
382
|
-
addDefinition: (name, create) => {
|
|
386
|
+
addDefinition: (source, name, create) => {
|
|
383
387
|
const key = createName(`${name}@${module.name}`);
|
|
384
388
|
definitions.set(key, create(key));
|
|
385
389
|
parameterized.set(key, !isParameterFree);
|
|
390
|
+
copySources.set(key, { source, prefix: instance.params.length });
|
|
386
391
|
return key;
|
|
387
392
|
},
|
|
388
393
|
createName,
|
|
@@ -544,7 +549,7 @@ export const createEnvironment = (
|
|
|
544
549
|
variables: new Set(linked.variables),
|
|
545
550
|
getDefinition: (key) => definitions.get(key),
|
|
546
551
|
isParameterized: (key) => parameterized.get(key) === true,
|
|
547
|
-
addDefinition: (name, create) => {
|
|
552
|
+
addDefinition: (_source, name, create) => {
|
|
548
553
|
const key = `${name}${KEY_SEPARATOR}${instance.module}${suffix}.${copies.length}`;
|
|
549
554
|
const definition = create(key);
|
|
550
555
|
copies.push(
|
|
@@ -872,11 +877,51 @@ export const createEnvironment = (
|
|
|
872
877
|
);
|
|
873
878
|
}
|
|
874
879
|
});
|
|
875
|
-
|
|
876
|
-
|
|
877
|
-
|
|
878
|
-
|
|
880
|
+
// TLC sets a module-scoped entry on the body of the module's definition, which every instance of
|
|
881
|
+
// the module shares.
|
|
882
|
+
const scopedKeys = new Set(
|
|
883
|
+
[...config.constants, ...config.substitutions]
|
|
884
|
+
.filter((item) => item.module !== undefined)
|
|
885
|
+
.flatMap(getScopedKeys),
|
|
886
|
+
);
|
|
887
|
+
const getOverride = (
|
|
888
|
+
key: string,
|
|
889
|
+
prefix: number,
|
|
890
|
+
): { key: string; prefix: number } | undefined => {
|
|
891
|
+
if (scopedKeys.has(key)) return { key, prefix };
|
|
892
|
+
const copy = copySources.get(key);
|
|
893
|
+
return copy && getOverride(copy.source, prefix + copy.prefix);
|
|
894
|
+
};
|
|
895
|
+
copySources.forEach((copy, key) => {
|
|
896
|
+
const override = getOverride(copy.source, copy.prefix);
|
|
897
|
+
const definition = definitions.get(key);
|
|
898
|
+
if (!override || !definition) return;
|
|
899
|
+
const params = definition.kind === "Operator" ? definition.params : [];
|
|
900
|
+
const alias = createLocalAlias(
|
|
901
|
+
key,
|
|
902
|
+
override.key,
|
|
903
|
+
params,
|
|
904
|
+
params.slice(override.prefix),
|
|
905
|
+
definition.location,
|
|
906
|
+
);
|
|
907
|
+
definitions.set(key, alias);
|
|
908
|
+
linkedRoot.visible.forEach((symbol, name) => {
|
|
909
|
+
if (symbol.key === key && name !== key) definitions.set(name, alias);
|
|
910
|
+
});
|
|
879
911
|
});
|
|
912
|
+
const unassigned = declaredConstants.filter(
|
|
913
|
+
(name) => !constants.has(name) && !substitutions.has(name) && !operatorKeys.has(name),
|
|
914
|
+
);
|
|
915
|
+
if (unassigned.length > 0) {
|
|
916
|
+
// TLC reports the first constant it finds unassigned in SANY's order of declarations.
|
|
917
|
+
const name =
|
|
918
|
+
getTlcDeclarationOrder(options.source, options.loadModule, "constant").find((constant) =>
|
|
919
|
+
unassigned.includes(constant),
|
|
920
|
+
) ?? unassigned[0];
|
|
921
|
+
throw new TlaConfigError(
|
|
922
|
+
`The constant parameter ${name} is not assigned a value by the configuration file.`,
|
|
923
|
+
);
|
|
924
|
+
}
|
|
880
925
|
|
|
881
926
|
const environment: Environment = {
|
|
882
927
|
runtime,
|
|
@@ -907,18 +952,43 @@ export const createEnvironment = (
|
|
|
907
952
|
getDefinition: (symbol) => definitions.get(linked.visible.get(symbol)?.key ?? symbol),
|
|
908
953
|
};
|
|
909
954
|
});
|
|
955
|
+
// TLC evaluates a substitute at startup and rejects it only when that fails and the level bound it
|
|
956
|
+
// computes is above constant. The bound counts the operators that TLC's Java code overrides with
|
|
957
|
+
// a minimum level as state-level, so the analyzer takes them for variables.
|
|
958
|
+
const analyzer = createLevelAnalyzer({
|
|
959
|
+
constants: new Set(constants.keys()),
|
|
960
|
+
variables: new Set([
|
|
961
|
+
...variables,
|
|
962
|
+
...["TLCGet", "Trace", "CounterExample"].filter((name) => builtins.has(name)),
|
|
963
|
+
]),
|
|
964
|
+
getDefinition: (name) => getDefinition(name, environment),
|
|
965
|
+
});
|
|
966
|
+
const getEvaluationError = (body: Expression) => {
|
|
967
|
+
try {
|
|
968
|
+
evaluate(body, { environment, scope: undefined, state: undefined, next: undefined });
|
|
969
|
+
return undefined;
|
|
970
|
+
} catch (error) {
|
|
971
|
+
if (error instanceof TlaEvaluationError) return error;
|
|
972
|
+
throw error;
|
|
973
|
+
}
|
|
974
|
+
};
|
|
910
975
|
substitutions.forEach((target, name) => {
|
|
911
976
|
const definition = definitions.get(target);
|
|
912
|
-
|
|
977
|
+
const error =
|
|
913
978
|
declaredConstants.includes(name) &&
|
|
914
|
-
definition &&
|
|
915
|
-
|
|
916
|
-
|
|
979
|
+
definition?.kind === "Operator" &&
|
|
980
|
+
definition.params.length === 0 &&
|
|
981
|
+
analyzer.analyzeDefinition(definition, new Map()).level > 0
|
|
982
|
+
? getEvaluationError(definition.body)
|
|
983
|
+
: undefined;
|
|
984
|
+
// TLC adds the reason unless a standard module's Java code failed.
|
|
985
|
+
if (error) {
|
|
917
986
|
throw new TlaConfigError(
|
|
918
|
-
`The configuration file substitutes constant ${name} with non-constant ${target}`,
|
|
987
|
+
`The configuration file substitutes constant ${name} with non-constant ${target}${error instanceof TlaModuleError ? "" : ` - specifically: ${error.message}`}`,
|
|
919
988
|
);
|
|
920
989
|
}
|
|
921
990
|
});
|
|
991
|
+
runtime.isStarted = true;
|
|
922
992
|
return {
|
|
923
993
|
environment,
|
|
924
994
|
assumptions,
|
package/src/errors.ts
CHANGED
|
@@ -1,10 +1,18 @@
|
|
|
1
|
-
import { EXIT_STATUS, getExitCode
|
|
1
|
+
import { EXIT_STATUS, getExitCode } from "./exit-codes";
|
|
2
|
+
import type { Value } from "./values";
|
|
2
3
|
|
|
3
4
|
// How TLC reports a RuntimeException it did not expect, such as one raised while computing next
|
|
4
5
|
// states.
|
|
5
6
|
export const UNEXPECTED_EXCEPTION =
|
|
6
7
|
"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: ";
|
|
7
8
|
|
|
9
|
+
// How TLC reports a Java StackOverflowError, which V8 raises as this RangeError.
|
|
10
|
+
export const STACK_OVERFLOW =
|
|
11
|
+
"This was a Java StackOverflowError. It was probably the result\nof an incorrect recursive function definition that caused TLC to enter\nan infinite loop when trying to compute the function or its application\nto an element in its putative domain.";
|
|
12
|
+
|
|
13
|
+
export const isStackOverflow = (error: unknown) =>
|
|
14
|
+
error instanceof RangeError && error.message === "Maximum call stack size exceeded";
|
|
15
|
+
|
|
8
16
|
export class TlaError extends Error {
|
|
9
17
|
constructor(message: string, cause?: unknown) {
|
|
10
18
|
super(message, { cause });
|
|
@@ -46,10 +54,30 @@ export class TlaEvaluationError extends TlaError {
|
|
|
46
54
|
// An evaluation error that TLC raises as an EvalException from a standard module's Java code. It
|
|
47
55
|
// keeps the name TlaEvaluationError, and index.ts doesn't export it.
|
|
48
56
|
export class TlaModuleError extends TlaEvaluationError {
|
|
57
|
+
exitCode: number;
|
|
58
|
+
|
|
49
59
|
constructor(message: string, exitCode: number = EXIT_STATUS.error) {
|
|
50
60
|
super(message);
|
|
51
61
|
this.name = "TlaEvaluationError";
|
|
52
|
-
|
|
62
|
+
this.exitCode = exitCode;
|
|
63
|
+
}
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
// TLC reports a successor state that the next-state relation leaves incomplete as an error of its
|
|
67
|
+
// own, not as an exception. It keeps the name TlaEvaluationError, and index.ts doesn't export it.
|
|
68
|
+
export class TlaIncompleteStateError extends TlaEvaluationError {
|
|
69
|
+
state: (Value | undefined)[];
|
|
70
|
+
action: string | undefined;
|
|
71
|
+
missing: string[];
|
|
72
|
+
|
|
73
|
+
constructor(state: (Value | undefined)[], action: string | undefined, missing: string[]) {
|
|
74
|
+
super(
|
|
75
|
+
`Successor state is not completely specified by the next-state action. The following variable${missing.length > 1 ? "s are" : " is"} not defined: ${missing.join(", ")}.\n`,
|
|
76
|
+
);
|
|
77
|
+
this.name = "TlaEvaluationError";
|
|
78
|
+
this.state = state;
|
|
79
|
+
this.action = action;
|
|
80
|
+
this.missing = missing;
|
|
53
81
|
}
|
|
54
82
|
}
|
|
55
83
|
|
package/src/evaluate.ts
CHANGED
|
@@ -1,18 +1,20 @@
|
|
|
1
|
-
import
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
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,
|
|
13
|
+
type SourceRange,
|
|
12
14
|
} from "./ast";
|
|
13
15
|
import { getKindString } from "./builtins";
|
|
14
16
|
import { TlaEvaluationError } from "./errors";
|
|
15
|
-
import { EXIT_STATUS, setExitCode } from "./exit-codes";
|
|
17
|
+
import { EXIT_STATUS, setExitCode, setOwnExitCode } from "./exit-codes";
|
|
16
18
|
import { generateEvaluator } from "./codegen";
|
|
17
19
|
import type { CheckerRuntime } from "./runtime";
|
|
18
20
|
import { getReadVariables } from "./dependencies";
|
|
@@ -28,23 +30,26 @@ import {
|
|
|
28
30
|
createSortedSet,
|
|
29
31
|
createWrittenRecord,
|
|
30
32
|
createTuple,
|
|
33
|
+
describeMissingField,
|
|
31
34
|
formatValue,
|
|
32
35
|
getDomain,
|
|
33
36
|
getFunctionDomain,
|
|
34
37
|
getIntervalElements,
|
|
35
38
|
getSequenceElements,
|
|
36
39
|
getValueHash,
|
|
37
|
-
isEnumerable,
|
|
38
40
|
isFunctionValue,
|
|
39
41
|
isOverriddenSet,
|
|
42
|
+
isRecordValue,
|
|
40
43
|
isSameValue,
|
|
41
44
|
markLambdaFunction,
|
|
45
|
+
isReducible,
|
|
42
46
|
isSetValue,
|
|
43
47
|
MAXIMUM_INTEGER,
|
|
44
48
|
MINIMUM_INTEGER,
|
|
45
49
|
toFiniteSet,
|
|
46
50
|
updateFunction,
|
|
47
51
|
valuesEqual,
|
|
52
|
+
type FunctionValue,
|
|
48
53
|
type LazyFunctionSource,
|
|
49
54
|
type LazyFunctionValue,
|
|
50
55
|
type Value,
|
|
@@ -180,8 +185,17 @@ export const getConjunctError = (
|
|
|
180
185
|
};
|
|
181
186
|
|
|
182
187
|
export const getFieldError =
|
|
183
|
-
(expression: Expression & { kind: "FieldAccess" }) => (record:
|
|
184
|
-
|
|
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
|
|
|
@@ -859,11 +783,7 @@ const evaluateLocalIdentifier = (name: string, expression: Expression, context:
|
|
|
859
783
|
const global = findGlobalName(name, context.environment);
|
|
860
784
|
if (global?.kind === "Variable") {
|
|
861
785
|
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
|
-
}
|
|
786
|
+
if (value === undefined) throw createUnassignedError(name, expression);
|
|
867
787
|
return value;
|
|
868
788
|
}
|
|
869
789
|
if (global?.kind === "Value") return global.value;
|
|
@@ -889,14 +809,29 @@ const IMPURE_BUILTINS = new Set([
|
|
|
889
809
|
export const isImpureBuiltin = (name: string, environment: Environment) =>
|
|
890
810
|
IMPURE_BUILTINS.has(name) || environment.builtins.get(name)?.isStateLevel === true;
|
|
891
811
|
|
|
892
|
-
|
|
812
|
+
interface Impurity {
|
|
813
|
+
builtins: Set<string>;
|
|
814
|
+
definitions: WeakMap<Definition, boolean>;
|
|
815
|
+
}
|
|
816
|
+
|
|
817
|
+
const ANY_EFFECT: Impurity = { builtins: IMPURE_BUILTINS, definitions: new WeakMap() };
|
|
818
|
+
|
|
819
|
+
// An Assert that held holds again, so evaluating it twice looks the same as evaluating it once.
|
|
820
|
+
const REPEATED_EFFECT: Impurity = {
|
|
821
|
+
builtins: new Set([...IMPURE_BUILTINS].filter((name) => name !== "Assert")),
|
|
822
|
+
definitions: new WeakMap(),
|
|
823
|
+
};
|
|
893
824
|
|
|
894
825
|
const isEvaluatedOnce = (definition: Definition, environment: Environment) =>
|
|
895
826
|
definition.kind === "Operator" &&
|
|
896
827
|
definition.params.length === 0 &&
|
|
897
828
|
isConstantLevel(definition, environment);
|
|
898
829
|
|
|
899
|
-
const callsImpureBuiltin = (
|
|
830
|
+
const callsImpureBuiltin = (
|
|
831
|
+
expression: Expression,
|
|
832
|
+
environment: Environment,
|
|
833
|
+
impurity: Impurity,
|
|
834
|
+
): boolean => {
|
|
900
835
|
const name =
|
|
901
836
|
expression.kind === "Identifier"
|
|
902
837
|
? expression.name
|
|
@@ -905,29 +840,35 @@ const callsImpureBuiltin = (expression: Expression, environment: Environment): b
|
|
|
905
840
|
: undefined;
|
|
906
841
|
if (name !== undefined && !isLocallyResolved(expression)) {
|
|
907
842
|
const definition = getDefinition(name, environment);
|
|
908
|
-
|
|
843
|
+
const isImpureCall =
|
|
844
|
+
impurity.builtins.has(name) || environment.builtins.get(name)?.isStateLevel === true;
|
|
845
|
+
if (!definition && isImpureCall) return true;
|
|
909
846
|
if (
|
|
910
847
|
definition &&
|
|
911
848
|
!isEvaluatedOnce(definition, environment) &&
|
|
912
|
-
isImpureDefinition(definition, environment)
|
|
849
|
+
isImpureDefinition(definition, environment, impurity)
|
|
913
850
|
) {
|
|
914
851
|
return true;
|
|
915
852
|
}
|
|
916
853
|
}
|
|
917
|
-
return getChildren(expression).some((child) => callsImpureBuiltin(child, environment));
|
|
854
|
+
return getChildren(expression).some((child) => callsImpureBuiltin(child, environment, impurity));
|
|
918
855
|
};
|
|
919
856
|
|
|
920
857
|
// TLC evaluates a constant definition without parameters once, so only other definitions pass
|
|
921
858
|
// on the side effects and random choices of the builtins they call.
|
|
922
|
-
const isImpureDefinition = (
|
|
923
|
-
|
|
859
|
+
const isImpureDefinition = (
|
|
860
|
+
definition: Definition,
|
|
861
|
+
environment: Environment,
|
|
862
|
+
impurity = ANY_EFFECT,
|
|
863
|
+
): boolean => {
|
|
864
|
+
const cached = impurity.definitions.get(definition);
|
|
924
865
|
if (cached !== undefined) return cached;
|
|
925
|
-
|
|
866
|
+
impurity.definitions.set(definition, false);
|
|
926
867
|
const isImpure =
|
|
927
|
-
callsImpureBuiltin(definition.body, environment) ||
|
|
868
|
+
callsImpureBuiltin(definition.body, environment, impurity) ||
|
|
928
869
|
(definition.kind === "Function" &&
|
|
929
|
-
definition.bounds.some((bound) => callsImpureBuiltin(bound.set, environment)));
|
|
930
|
-
|
|
870
|
+
definition.bounds.some((bound) => callsImpureBuiltin(bound.set, environment, impurity)));
|
|
871
|
+
impurity.definitions.set(definition, isImpure);
|
|
931
872
|
return isImpure;
|
|
932
873
|
};
|
|
933
874
|
|
|
@@ -941,6 +882,12 @@ export const isImpure = (environment: Environment) =>
|
|
|
941
882
|
isImpureDefinition(definition, environment),
|
|
942
883
|
);
|
|
943
884
|
|
|
885
|
+
// Whether evaluating a definition again can show, such as by printing twice.
|
|
886
|
+
export const hasRepeatedEffects = (environment: Environment) =>
|
|
887
|
+
[...environment.definitions.values()].some((definition) =>
|
|
888
|
+
isImpureDefinition(definition, environment, REPEATED_EFFECT),
|
|
889
|
+
);
|
|
890
|
+
|
|
944
891
|
const closedConstants = new WeakMap<Expression, boolean>();
|
|
945
892
|
|
|
946
893
|
export const isClosedConstant = (expression: Expression, environment: Environment): boolean => {
|
|
@@ -1092,7 +1039,7 @@ export const getEvaluator = (expression: Expression, environment: Environment):
|
|
|
1092
1039
|
|
|
1093
1040
|
const entryEvaluators = new WeakMap<Expression, Evaluator>();
|
|
1094
1041
|
|
|
1095
|
-
const getEntryEvaluator = (expression: Expression, environment: Environment) => {
|
|
1042
|
+
export const getEntryEvaluator = (expression: Expression, environment: Environment) => {
|
|
1096
1043
|
const cached = entryEvaluators.get(expression);
|
|
1097
1044
|
if (cached) return cached;
|
|
1098
1045
|
const evaluator =
|
|
@@ -1116,11 +1063,7 @@ const compileIdentifier = (
|
|
|
1116
1063
|
const index = global.index;
|
|
1117
1064
|
return (context) => {
|
|
1118
1065
|
const value = context.state?.[index];
|
|
1119
|
-
if (value === undefined)
|
|
1120
|
-
throw new TlaEvaluationError(
|
|
1121
|
-
`The variable ${name} is not assigned at ${describeLocation(expression)}`,
|
|
1122
|
-
);
|
|
1123
|
-
}
|
|
1066
|
+
if (value === undefined) throw createUnassignedError(name, expression);
|
|
1124
1067
|
return value;
|
|
1125
1068
|
};
|
|
1126
1069
|
}
|
|
@@ -1394,6 +1337,11 @@ const compileApply = (
|
|
|
1394
1337
|
if (definition?.kind === "Function") {
|
|
1395
1338
|
throw new TlaEvaluationError(`${expression.operator} is a function; apply it with brackets`);
|
|
1396
1339
|
}
|
|
1340
|
+
if (expression.operator === "\\cdot") {
|
|
1341
|
+
throw new TlaEvaluationError(
|
|
1342
|
+
"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.",
|
|
1343
|
+
);
|
|
1344
|
+
}
|
|
1397
1345
|
throw new TlaEvaluationError(
|
|
1398
1346
|
`Unknown operator ${expression.operator} at ${describeLocation(expression)}`,
|
|
1399
1347
|
);
|
|
@@ -1489,7 +1437,13 @@ const compileFunctionConstruction = (
|
|
|
1489
1437
|
const set = getEvaluator(bound.set, environment);
|
|
1490
1438
|
return (context) => {
|
|
1491
1439
|
const domain = isSingleName ? set(context) : getBoundsDomain(bounds, context);
|
|
1492
|
-
|
|
1440
|
+
// TLC builds the function only when it reduces every domain, and evaluates the body lazily
|
|
1441
|
+
// otherwise.
|
|
1442
|
+
const domains =
|
|
1443
|
+
typeof domain === "object" && domain.kind === "ProductSet" && bounds.length > 1
|
|
1444
|
+
? domain.factors
|
|
1445
|
+
: [domain];
|
|
1446
|
+
if (expression.isRecursive || isKeptLazy || !domains.every(isReducible)) {
|
|
1493
1447
|
const functionValue = createLazyFunction(
|
|
1494
1448
|
domain,
|
|
1495
1449
|
(argument) => body(withScope(context, bindArgument(bounds, context.scope, argument))),
|
|
@@ -1583,10 +1537,7 @@ const compileSetComprehension = (
|
|
|
1583
1537
|
predicate(withScope(context, bindPattern(context.scope, pattern, element))),
|
|
1584
1538
|
"a set filter predicate",
|
|
1585
1539
|
);
|
|
1586
|
-
|
|
1587
|
-
typeof base === "object" &&
|
|
1588
|
-
(base.kind === "Set" || base.kind === "MixedSet" || base.kind === "Interval");
|
|
1589
|
-
if (!isReducible) {
|
|
1540
|
+
if (!isReducible(base)) {
|
|
1590
1541
|
if (isSetValue(base)) return { kind: "FilteredSet", base, test };
|
|
1591
1542
|
throw new TlaEvaluationError(
|
|
1592
1543
|
`TLC encountered a non-enumerable quantifier bound ${formatValue(base)} at ${describeLocation(expression.bound.set)}`,
|
|
@@ -1632,11 +1583,29 @@ const compileSetComprehension = (
|
|
|
1632
1583
|
};
|
|
1633
1584
|
};
|
|
1634
1585
|
|
|
1635
|
-
|
|
1636
|
-
|
|
1637
|
-
|
|
1638
|
-
|
|
1586
|
+
// TLC orders a record's fields by name.
|
|
1587
|
+
export const getSortedFields = (fields: RecordField[]) =>
|
|
1588
|
+
[...fields].sort((left, right) => compareValues(left.name, right.name));
|
|
1589
|
+
|
|
1590
|
+
export const hasDuplicateFields = (sortedFields: RecordField[]) =>
|
|
1591
|
+
sortedFields.some((field, index) => index > 0 && sortedFields[index - 1].name === field.name);
|
|
1592
|
+
|
|
1593
|
+
export const createUnassignedError = (name: string, expression: Expression) =>
|
|
1594
|
+
setOwnExitCode(
|
|
1595
|
+
new TlaEvaluationError(
|
|
1596
|
+
`In evaluation, the identifier ${name} is either undefined or not an operator.\n${describeRange(expression)}`,
|
|
1597
|
+
),
|
|
1598
|
+
EXIT_STATUS.configParseError,
|
|
1599
|
+
);
|
|
1600
|
+
|
|
1601
|
+
export const createPrimeOutsideActionError = (expression: Expression) =>
|
|
1602
|
+
new TlaEvaluationError(
|
|
1603
|
+
`A primed expression appears outside an action at ${describeLocation(expression)}`,
|
|
1639
1604
|
);
|
|
1605
|
+
|
|
1606
|
+
const compileRecord = (recordFields: RecordField[], environment: Environment): Evaluator => {
|
|
1607
|
+
const fields = getSortedFields(recordFields);
|
|
1608
|
+
const hasDuplicates = hasDuplicateFields(fields);
|
|
1640
1609
|
const values = fields.map((field) => getEvaluator(field.value, environment));
|
|
1641
1610
|
if (hasDuplicates) {
|
|
1642
1611
|
return (context) =>
|
|
@@ -1714,11 +1683,7 @@ const compile = (expression: Expression, environment: Environment): Evaluator =>
|
|
|
1714
1683
|
case "Prime": {
|
|
1715
1684
|
const inner = child(expression.expression);
|
|
1716
1685
|
return (context) => {
|
|
1717
|
-
if (!context.next)
|
|
1718
|
-
throw new TlaEvaluationError(
|
|
1719
|
-
`A primed expression appears outside an action at ${describeLocation(expression)}`,
|
|
1720
|
-
);
|
|
1721
|
-
}
|
|
1686
|
+
if (!context.next) throw createPrimeOutsideActionError(expression);
|
|
1722
1687
|
return inner({
|
|
1723
1688
|
environment: context.environment,
|
|
1724
1689
|
scope: context.scope,
|
|
@@ -1798,9 +1763,7 @@ const compile = (expression: Expression, environment: Environment): Evaluator =>
|
|
|
1798
1763
|
case "Record":
|
|
1799
1764
|
return compileRecord(expression.fields, environment);
|
|
1800
1765
|
case "RecordSet": {
|
|
1801
|
-
const fields =
|
|
1802
|
-
compareValues(left.name, right.name),
|
|
1803
|
-
);
|
|
1766
|
+
const fields = getSortedFields(expression.fields);
|
|
1804
1767
|
const names = fields.map((field) => field.name);
|
|
1805
1768
|
const sets = fields.map((field) => child(field.value));
|
|
1806
1769
|
return (context) => ({ kind: "RecordSet", names, sets: sets.map((set) => set(context)) });
|
|
@@ -1821,18 +1784,31 @@ const compile = (expression: Expression, environment: Environment): Evaluator =>
|
|
|
1821
1784
|
keepLazy(expression.function);
|
|
1822
1785
|
const evaluateFunction = child(expression.function);
|
|
1823
1786
|
const args = expression.args.map(child);
|
|
1787
|
+
const describeNonFunction = getNonFunctionError(expression);
|
|
1824
1788
|
if (args.length === 1) {
|
|
1825
1789
|
const argument = args[0];
|
|
1826
|
-
return (context) =>
|
|
1790
|
+
return (context) =>
|
|
1791
|
+
applyFunction(
|
|
1792
|
+
evaluateFunction(context),
|
|
1793
|
+
argument(context),
|
|
1794
|
+
undefined,
|
|
1795
|
+
describeNonFunction,
|
|
1796
|
+
);
|
|
1827
1797
|
}
|
|
1828
1798
|
return (context) =>
|
|
1829
|
-
applyFunction(
|
|
1799
|
+
applyFunction(
|
|
1800
|
+
evaluateFunction(context),
|
|
1801
|
+
createTuple(args.map((arg) => arg(context))),
|
|
1802
|
+
undefined,
|
|
1803
|
+
describeNonFunction,
|
|
1804
|
+
);
|
|
1830
1805
|
}
|
|
1831
1806
|
case "FieldAccess": {
|
|
1832
1807
|
const record = child(expression.record);
|
|
1833
1808
|
const field = expression.field;
|
|
1834
1809
|
const describeMissing = getFieldError(expression);
|
|
1835
|
-
|
|
1810
|
+
const describeNonRecord = getNonRecordError(expression);
|
|
1811
|
+
return (context) => applyFunction(record(context), field, describeMissing, describeNonRecord);
|
|
1836
1812
|
}
|
|
1837
1813
|
case "Product": {
|
|
1838
1814
|
const factors = expression.factors.map(child);
|