tla-ts 0.0.3 → 0.0.4-dev.5f6a4bf
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 +32 -12
- package/dist/cli.cjs +1 -1
- package/dist/cli.js +1 -1
- package/dist/index.cjs +1 -1
- package/dist/index.d.cts +160 -8
- package/dist/index.d.ts +160 -8
- package/dist/index.js +1 -1
- package/dist/parallel-worker.cjs +2 -2
- package/dist/parallel-worker.js +2 -2
- package/dist/parallel.cjs +1 -1
- package/dist/parallel.js +2 -2
- package/dist/run-cli.cjs +45 -18
- package/dist/run-cli.js +45 -18
- package/dist/transfer.cjs +1393 -18
- package/dist/transfer.js +1393 -18
- package/package.json +5 -1
- package/src/ast.ts +147 -6
- package/src/bags.ts +4 -7
- package/src/builtins.ts +29 -11
- package/src/bundled-modules.ts +3 -3
- package/src/canonical.ts +4 -3
- package/src/check.ts +1539 -235
- package/src/cli-options.ts +11 -5
- package/src/cli.ts +8 -1
- package/src/codegen.ts +77 -37
- package/src/config.ts +254 -181
- package/src/dependencies.ts +2 -2
- package/src/environment.ts +540 -140
- package/src/errors.ts +224 -3
- package/src/evaluate.ts +796 -246
- package/src/exit-codes.ts +22 -43
- package/src/fingerprints.ts +46 -11
- package/src/index.ts +1 -0
- package/src/instances.ts +19 -16
- package/src/java-overrides.ts +104 -25
- package/src/levels.ts +191 -45
- package/src/lexer.ts +127 -30
- package/src/live-check.ts +828 -0
- package/src/liveness.ts +218 -572
- package/src/obligation-expression.ts +2 -2
- package/src/obligation-source.ts +2 -0
- package/src/parallel-worker.ts +174 -213
- package/src/parallel.ts +131 -39
- package/src/parser.ts +456 -147
- package/src/pcal-ast.ts +770 -0
- package/src/pcal-parse.ts +1523 -0
- package/src/pcal-tokenize.ts +516 -0
- package/src/pcal-translate.ts +1230 -0
- package/src/pcal-validate.ts +454 -0
- package/src/randomization.ts +24 -7
- package/src/resolve.ts +1481 -426
- package/src/run-cli.ts +1212 -143
- package/src/runtime.ts +19 -1
- package/src/sany-builtins.ts +147 -0
- package/src/sany-generator.ts +3128 -0
- package/src/sany-levels.ts +1208 -0
- package/src/sany-lexer.ts +545 -0
- package/src/sany-linter.ts +122 -0
- package/src/sany-modules.ts +1398 -0
- package/src/sany-nodes.ts +463 -0
- package/src/sany-parse-error.ts +2161 -0
- package/src/sany-report.ts +356 -0
- package/src/sany-selectors.ts +738 -0
- package/src/sany-source.ts +248 -0
- package/src/sany-xml.ts +1017 -0
- package/src/spec-description.ts +42 -11
- package/src/standard-modules.ts +200 -148
- package/src/standard-ranges.ts +116 -0
- package/src/state-graph.ts +180 -0
- package/src/subexpressions.ts +231 -171
- package/src/substitution-levels.ts +38 -17
- package/src/successors.ts +219 -107
- package/src/symmetry.ts +194 -54
- package/src/tableau.ts +54 -25
- package/src/tlc-ext.ts +42 -29
- package/src/tlc-messages.ts +329 -0
- package/src/tlc-module.ts +52 -43
- package/src/tlc-modules.ts +4 -0
- package/src/tlc-order.ts +78 -10
- package/src/tlc-random.ts +37 -9
- package/src/tlc-replay.ts +655 -0
- package/src/tlc-summary.ts +20 -5
- package/src/tlc-version.ts +18 -0
- package/src/transfer.ts +15 -3
- package/src/value-sources.ts +29 -0
- package/src/values.ts +731 -184
package/src/evaluate.ts
CHANGED
|
@@ -1,54 +1,74 @@
|
|
|
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
|
-
import { TlaEvaluationError } from "./errors";
|
|
16
|
+
import { isStackOverflow, TlaEvaluationError, TlaUnassignedError } from "./errors";
|
|
15
17
|
import { EXIT_STATUS, setExitCode } from "./exit-codes";
|
|
16
18
|
import { generateEvaluator } from "./codegen";
|
|
19
|
+
import { MESSAGE_CODE } from "./tlc-messages";
|
|
17
20
|
import type { CheckerRuntime } from "./runtime";
|
|
18
21
|
import { getReadVariables } from "./dependencies";
|
|
19
22
|
import { contextualApplications, mapChildren, substitutedExpressions } from "./instances";
|
|
23
|
+
import { prettyPrint } from "./pretty-print";
|
|
20
24
|
import { isEnabled } from "./successors";
|
|
21
25
|
import {
|
|
22
26
|
applyFunction,
|
|
27
|
+
describeMissingArgument,
|
|
23
28
|
combineHash,
|
|
24
29
|
compareValues,
|
|
25
30
|
createFunction,
|
|
31
|
+
createNonIntegerKeyError,
|
|
32
|
+
createRecord,
|
|
26
33
|
createEnumeratedSet,
|
|
27
34
|
createSortedFunction,
|
|
35
|
+
createSortedRecord,
|
|
28
36
|
createSortedSet,
|
|
29
37
|
createWrittenRecord,
|
|
30
38
|
createTuple,
|
|
31
39
|
formatValue,
|
|
40
|
+
getCardinality,
|
|
32
41
|
getDomain,
|
|
33
42
|
getFunctionDomain,
|
|
34
43
|
getIntervalElements,
|
|
44
|
+
getLazySubsets,
|
|
45
|
+
getStreamedElements,
|
|
46
|
+
getFunctionClass,
|
|
35
47
|
getSequenceElements,
|
|
36
48
|
getValueHash,
|
|
49
|
+
isElementOf,
|
|
37
50
|
isEnumerable,
|
|
38
51
|
isFunctionValue,
|
|
39
52
|
isOverriddenSet,
|
|
40
53
|
isSameValue,
|
|
41
54
|
markLambdaFunction,
|
|
55
|
+
isReducibleSet,
|
|
42
56
|
isSetValue,
|
|
43
57
|
MAXIMUM_INTEGER,
|
|
44
58
|
MINIMUM_INTEGER,
|
|
59
|
+
toFiniteFunction,
|
|
45
60
|
toFiniteSet,
|
|
46
61
|
updateFunction,
|
|
47
62
|
valuesEqual,
|
|
63
|
+
type FilteredSetValue,
|
|
48
64
|
type LazyFunctionSource,
|
|
49
65
|
type LazyFunctionValue,
|
|
66
|
+
type ObjectValue,
|
|
50
67
|
type Value,
|
|
68
|
+
markNormalized,
|
|
69
|
+
setTrace,
|
|
51
70
|
} from "./values";
|
|
71
|
+
import type { TlcVersion } from "./tlc-version";
|
|
52
72
|
|
|
53
73
|
export type State = (Value | undefined)[];
|
|
54
74
|
|
|
@@ -71,6 +91,8 @@ export interface Builtin {
|
|
|
71
91
|
evaluateUnary: ((value: Value) => Value) | undefined;
|
|
72
92
|
evaluateBinary: ((left: Value, right: Value) => Value) | undefined;
|
|
73
93
|
isStateLevel?: boolean;
|
|
94
|
+
// Whether TLC takes an application for a constant one although its value depends on the state.
|
|
95
|
+
isLevelConstant?: boolean;
|
|
74
96
|
isLazy?: boolean;
|
|
75
97
|
}
|
|
76
98
|
|
|
@@ -107,18 +129,89 @@ export interface Environment {
|
|
|
107
129
|
builtins: Map<string, Builtin>;
|
|
108
130
|
constants: Map<string, Value>;
|
|
109
131
|
substitutions: Map<string, string>;
|
|
132
|
+
// The name SANY gives each definition that a named instance such as `M == INSTANCE Module`
|
|
133
|
+
// copies, such as M!Op, by the key of the copy.
|
|
134
|
+
instanceNames: Map<string, string>;
|
|
110
135
|
variables: string[];
|
|
111
136
|
variableIndex: Map<string, number>;
|
|
112
137
|
definitionValues: Map<Definition, Value>;
|
|
113
138
|
constantLevels: Map<Definition, boolean>;
|
|
139
|
+
// The definitions an INSTANCE copies from a module that declares constants or variables. SANY
|
|
140
|
+
// wraps the body of each in its substitutions.
|
|
141
|
+
substitutedDefinitions: Set<Definition>;
|
|
114
142
|
evaluators: WeakMap<Expression, Evaluator>;
|
|
143
|
+
// The expressions being evaluated, outermost first, when the environment replays an error to
|
|
144
|
+
// find where it occurred, as TLC's CallStackTool does.
|
|
145
|
+
callStack?: CallStack;
|
|
146
|
+
}
|
|
147
|
+
|
|
148
|
+
export interface CallStack {
|
|
149
|
+
expressions: Expression[];
|
|
150
|
+
// TLC stops popping the stack once an evaluation fails, so it keeps where the failure occurred.
|
|
151
|
+
isFrozen: boolean;
|
|
152
|
+
// The expression that built each value of the replay that TLC's CallStackTool gives a source.
|
|
153
|
+
sources: WeakMap<ObjectValue, Expression>;
|
|
154
|
+
// The value each expression of the replay last evaluated to.
|
|
155
|
+
values: WeakMap<Expression, Value>;
|
|
156
|
+
// The expression each failure last left, which tells a failure of an operand from one of the
|
|
157
|
+
// method that computes the operator.
|
|
158
|
+
failures: WeakMap<Error, Expression>;
|
|
159
|
+
// The failure of a value with a source, which TLC raises as a FingerprintException.
|
|
160
|
+
fingerprint?: FingerprintFailure;
|
|
161
|
+
}
|
|
162
|
+
|
|
163
|
+
export interface FingerprintFailure {
|
|
164
|
+
// The sources of the values whose methods failed, outermost first.
|
|
165
|
+
sources: Expression[];
|
|
166
|
+
// The message of the error the innermost one raised.
|
|
167
|
+
reason: string;
|
|
115
168
|
}
|
|
116
169
|
|
|
170
|
+
// The operators of Tool#evalAppl whose value TLC's CallStackTool gives a source.
|
|
171
|
+
const SOURCED_OPERATORS = new Set(["SUBSET", "UNION", "DOMAIN", "\\cup", "\\cap", "\\"]);
|
|
172
|
+
|
|
173
|
+
// CallStackTool copies the SetPredValue, FcnLambdaValue and OpLambdaValue that an evaluation
|
|
174
|
+
// returns without their source, and a function TLC builds from a FcnLambdaValue has none.
|
|
175
|
+
const SOURCED_KINDS = new Set<Expression["kind"]>([
|
|
176
|
+
"SetEnumeration",
|
|
177
|
+
"SetFilter",
|
|
178
|
+
"SetMap",
|
|
179
|
+
"Tuple",
|
|
180
|
+
"FunctionSet",
|
|
181
|
+
"Record",
|
|
182
|
+
"RecordSet",
|
|
183
|
+
"Product",
|
|
184
|
+
]);
|
|
185
|
+
|
|
186
|
+
const isSourced = (expression: Expression) =>
|
|
187
|
+
SOURCED_KINDS.has(expression.kind) ||
|
|
188
|
+
(expression.kind === "Apply" && SOURCED_OPERATORS.has(expression.operator));
|
|
189
|
+
|
|
190
|
+
// The argument whose method Tool#evalAppl calls to compute an operator, as with S.member(e) for
|
|
191
|
+
// e \in S, f.apply(e) for f[e] when f is a function, or S.diff(T) for S \ T when S is Reducible.
|
|
192
|
+
const getReceiver = (expression: Expression, values: CallStack["values"]) => {
|
|
193
|
+
if (expression.kind === "FunctionApplication" || expression.kind === "Except") {
|
|
194
|
+
return expression.function;
|
|
195
|
+
}
|
|
196
|
+
if (expression.kind !== "Apply" || expression.args.length !== 2) return undefined;
|
|
197
|
+
if (["\\subseteq", "=", "#", "\\"].includes(expression.operator)) return expression.args[0];
|
|
198
|
+
if (expression.operator === "\\cap" || expression.operator === "\\cup") {
|
|
199
|
+
const left = values.get(expression.args[0]);
|
|
200
|
+
return left !== undefined && isReducibleSet(left) ? expression.args[0] : expression.args[1];
|
|
201
|
+
}
|
|
202
|
+
return expression.operator === "\\in" || expression.operator === "\\notin"
|
|
203
|
+
? expression.args[1]
|
|
204
|
+
: undefined;
|
|
205
|
+
};
|
|
206
|
+
|
|
117
207
|
export interface Context {
|
|
118
208
|
environment: Environment;
|
|
119
209
|
scope: Scope | undefined;
|
|
120
210
|
state: State | undefined;
|
|
121
211
|
next: State | undefined;
|
|
212
|
+
// EvalControl.KeepLazy, which Tool#evalAppl sets to evaluate the function it applies and which
|
|
213
|
+
// the evaluation passes on, so that a function constructor within builds a FcnLambdaValue.
|
|
214
|
+
isKeepLazy?: boolean;
|
|
122
215
|
}
|
|
123
216
|
|
|
124
217
|
export type Evaluator = (context: Context) => Value;
|
|
@@ -149,14 +242,20 @@ export const describeRange = (expression: Expression) => {
|
|
|
149
242
|
return range ? formatRange(range) : describeLocation(expression);
|
|
150
243
|
};
|
|
151
244
|
|
|
245
|
+
// SANY prints a numeral as written and any other expression by its location.
|
|
246
|
+
export const describeNode = (expression: Expression) =>
|
|
247
|
+
expression.kind === "Number"
|
|
248
|
+
? (expression.text ?? String(expression.value))
|
|
249
|
+
: describeRange(expression);
|
|
250
|
+
|
|
152
251
|
export const getConditionError = (expression: Expression, value: Value) =>
|
|
153
252
|
new TlaEvaluationError(
|
|
154
253
|
`A non-boolean expression (${getKindString(value)}) was used as the condition of an IF.\n${describeRange(expression)}`,
|
|
155
254
|
);
|
|
156
255
|
|
|
157
|
-
// TLC parses an infix chain of /\ as nested binary
|
|
158
|
-
//
|
|
159
|
-
export const
|
|
256
|
+
// TLC parses an infix chain of /\ or \/ as nested binary junctions and a bulleted list as one
|
|
257
|
+
// junction list, and it words the error differently for each.
|
|
258
|
+
export const getJunctionError = (
|
|
160
259
|
expression: Expression & { kind: "And" | "Or" },
|
|
161
260
|
index: number,
|
|
162
261
|
value: Value,
|
|
@@ -166,22 +265,48 @@ export const getConjunctError = (
|
|
|
166
265
|
range?.start.line === expression.location.line &&
|
|
167
266
|
range.start.column === expression.location.column;
|
|
168
267
|
if (isBulleted || !range) {
|
|
169
|
-
const operand = expression.operands[index];
|
|
170
|
-
// SANY prints a numeral as its value instead of its location.
|
|
171
|
-
const description = operand.kind === "Number" ? String(operand.value) : describeRange(operand);
|
|
172
268
|
return new TlaEvaluationError(
|
|
173
|
-
`A non-boolean expression (${getKindString(value)}) was used as a formula in a conjunction.\n${
|
|
269
|
+
`A non-boolean expression (${getKindString(value)}) was used as a formula in a ${expression.kind === "And" ? "conjunction" : "disjunction"}.\n${describeNode(expression.operands[index])}`,
|
|
174
270
|
);
|
|
175
271
|
}
|
|
176
|
-
const end = expression.
|
|
272
|
+
const end = expression.prefixEnds?.[Math.max(index, 1) - 1] ?? range.end;
|
|
177
273
|
return new TlaEvaluationError(
|
|
178
|
-
`Attempted to evaluate an expression of form P /\\ Q when ${index === 0 ? "P" : "Q"} was\n${getKindString(value)}.\n${describeRange({ ...expression, location: { ...expression.location, range: { ...range, end } } })}`,
|
|
274
|
+
`Attempted to evaluate an expression of form P ${expression.kind === "And" ? "/\\" : "\\/"} Q when ${index === 0 ? "P" : "Q"} was\n${getKindString(value)}.\n${describeRange({ ...expression, location: { ...expression.location, range: { ...range, end } } })}`,
|
|
179
275
|
);
|
|
180
276
|
};
|
|
181
277
|
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
278
|
+
// TLC selects a field of a record, and of another function from the function it converts it to,
|
|
279
|
+
// which for a tuple keeps its domain as an interval.
|
|
280
|
+
export const getFieldSelector = (expression: Expression & { kind: "FieldAccess" }) => {
|
|
281
|
+
const field = expression.field;
|
|
282
|
+
const describeMissing = (record: Value) =>
|
|
283
|
+
`Attempted to select nonexistent field "${field}" from the record\n${formatValue(record)}\n${describeRange(expression)}`;
|
|
284
|
+
const describeNotInDomain = (functionValue: Value) =>
|
|
285
|
+
`Attempted to apply function:\n${prettyPrint(formatValue(functionValue))}\nto argument "${field}", which is not in the domain of the function.`;
|
|
286
|
+
return (value: Value) => {
|
|
287
|
+
if (!isFunctionValue(value)) {
|
|
288
|
+
throw new TlaEvaluationError(
|
|
289
|
+
`Attempted to select field "${field}" from a non-record value ${prettyPrint(formatValue(value))}\n${describeRange(expression)}`,
|
|
290
|
+
);
|
|
291
|
+
}
|
|
292
|
+
const functionClass = getFunctionClass(value);
|
|
293
|
+
if (functionClass === "tuple") throw createNonIntegerKeyError(field);
|
|
294
|
+
// Only TLC's RecordValue names the field it lacks. Any other function, such as a FcnRcdValue
|
|
295
|
+
// whose keys are strings, reports an argument outside its domain.
|
|
296
|
+
return applyFunction(
|
|
297
|
+
value,
|
|
298
|
+
field,
|
|
299
|
+
functionClass === "record" ? describeMissing : describeNotInDomain,
|
|
300
|
+
);
|
|
301
|
+
};
|
|
302
|
+
};
|
|
303
|
+
|
|
304
|
+
// TLC 1.7.4 words what a tuple or a record lacks differently.
|
|
305
|
+
export const getMissingArgumentDescriber = (version: TlcVersion | undefined) =>
|
|
306
|
+
version === "1.7.4"
|
|
307
|
+
? (functionValue: Value, argument: Value) =>
|
|
308
|
+
describeMissingArgument(functionValue, argument, version)
|
|
309
|
+
: undefined;
|
|
185
310
|
|
|
186
311
|
export const getDomainOperator = (expression: Expression) => (value: Value) => {
|
|
187
312
|
if (!isFunctionValue(value)) {
|
|
@@ -246,11 +371,23 @@ const bindPattern = (scope: Scope | undefined, pattern: BoundPattern, value: Val
|
|
|
246
371
|
);
|
|
247
372
|
};
|
|
248
373
|
|
|
374
|
+
// Tool#evalAppl checks that it applies a function before it evaluates the argument.
|
|
375
|
+
export const expectFunction = (value: Value, application: Expression) => {
|
|
376
|
+
if (isFunctionValue(value)) return value;
|
|
377
|
+
throw new TlaEvaluationError(
|
|
378
|
+
`A non-function (${getKindString(value)}) was applied as a function.\n${describeRange(application)}`,
|
|
379
|
+
);
|
|
380
|
+
};
|
|
381
|
+
|
|
382
|
+
export const toKeepLazyContext = (context: Context): Context =>
|
|
383
|
+
context.isKeepLazy ? context : { ...context, isKeepLazy: true };
|
|
384
|
+
|
|
249
385
|
const withScope = (context: Context, scope: Scope | undefined): Context => ({
|
|
250
386
|
environment: context.environment,
|
|
251
387
|
scope,
|
|
252
388
|
state: context.state,
|
|
253
389
|
next: context.next,
|
|
390
|
+
isKeepLazy: context.isKeepLazy,
|
|
254
391
|
});
|
|
255
392
|
|
|
256
393
|
export const expectBoolean = (value: Value, description: string) => {
|
|
@@ -262,104 +399,29 @@ export const expectBoolean = (value: Value, description: string) => {
|
|
|
262
399
|
return value;
|
|
263
400
|
};
|
|
264
401
|
|
|
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
402
|
export const getDefinition = (name: string, environment: Environment) =>
|
|
356
403
|
environment.definitions.get(environment.substitutions.get(name) ?? name);
|
|
357
404
|
|
|
358
|
-
|
|
405
|
+
// TLC bounds the level of every action and temporal operator above constant, whatever its operands.
|
|
406
|
+
const NONCONSTANT_KINDS = new Set<Expression["kind"]>([
|
|
407
|
+
"Prime",
|
|
408
|
+
"Unchanged",
|
|
409
|
+
"Enabled",
|
|
410
|
+
"BoxAction",
|
|
411
|
+
"AngleAction",
|
|
412
|
+
"Always",
|
|
413
|
+
"Eventually",
|
|
414
|
+
"WeakFairness",
|
|
415
|
+
"StrongFairness",
|
|
416
|
+
]);
|
|
417
|
+
|
|
418
|
+
const NONCONSTANT_OPERATORS = new Set(["~>", "-+->", "\\cdot"]);
|
|
419
|
+
|
|
420
|
+
const isNonconstant = (expression: Expression, environment: Environment): boolean => {
|
|
359
421
|
if (
|
|
360
|
-
expression.kind
|
|
361
|
-
expression.kind === "
|
|
362
|
-
expression.kind === "
|
|
422
|
+
NONCONSTANT_KINDS.has(expression.kind) ||
|
|
423
|
+
(expression.kind === "UnboundedQuantifier" && expression.isTemporal === true) ||
|
|
424
|
+
(expression.kind === "Apply" && NONCONSTANT_OPERATORS.has(expression.operator))
|
|
363
425
|
) {
|
|
364
426
|
return true;
|
|
365
427
|
}
|
|
@@ -376,7 +438,7 @@ const isStateDependent = (expression: Expression, environment: Environment): boo
|
|
|
376
438
|
if (definition && !environment.constants.has(name) && !isConstantLevel(definition, environment))
|
|
377
439
|
return true;
|
|
378
440
|
}
|
|
379
|
-
return getChildren(expression).some((child) =>
|
|
441
|
+
return getChildren(expression).some((child) => isNonconstant(child, environment));
|
|
380
442
|
};
|
|
381
443
|
|
|
382
444
|
export const isConstantLevel = (definition: Definition, environment: Environment): boolean => {
|
|
@@ -384,9 +446,9 @@ export const isConstantLevel = (definition: Definition, environment: Environment
|
|
|
384
446
|
if (cached !== undefined) return cached;
|
|
385
447
|
environment.constantLevels.set(definition, true);
|
|
386
448
|
const isConstant =
|
|
387
|
-
!
|
|
449
|
+
!isNonconstant(definition.body, environment) &&
|
|
388
450
|
(definition.kind === "Operator" ||
|
|
389
|
-
!definition.bounds.some((bound) =>
|
|
451
|
+
!definition.bounds.some((bound) => isNonconstant(bound.set, environment)));
|
|
390
452
|
environment.constantLevels.set(definition, isConstant);
|
|
391
453
|
return isConstant;
|
|
392
454
|
};
|
|
@@ -409,38 +471,90 @@ const getBoundExplanation = (set: Value, text: string) => {
|
|
|
409
471
|
|
|
410
472
|
// TLC enumerates every set except the ones it implements in Java, so any other set fails as its own
|
|
411
473
|
// class does.
|
|
412
|
-
|
|
474
|
+
const checkEnumerable = (set: Value, expression: Expression, version: TlcVersion) => {
|
|
413
475
|
if (!isSetValue(set) || isOverriddenSet(set)) {
|
|
414
476
|
const text = formatValue(set);
|
|
415
|
-
|
|
477
|
+
// TLC 1.7.4 doesn't explain why it can't enumerate a set.
|
|
478
|
+
const explanation = version === "1.7.4" ? undefined : getBoundExplanation(set, text);
|
|
416
479
|
throw new TlaEvaluationError(
|
|
417
480
|
explanation === undefined
|
|
418
|
-
? `TLC encountered a non-enumerable quantifier bound\n${text}.\n${
|
|
419
|
-
: `TLC encountered the non-enumerable quantifier bound\n${text}\n${
|
|
481
|
+
? `TLC encountered a non-enumerable quantifier bound\n${text}.\n${describeNode(expression)}`
|
|
482
|
+
: `TLC encountered the non-enumerable quantifier bound\n${text}\n${describeNode(expression)}\n${explanation}`,
|
|
420
483
|
);
|
|
421
484
|
}
|
|
422
|
-
return typeof set === "object" && set.kind === "Interval"
|
|
423
|
-
? getIntervalElements(set)
|
|
424
|
-
: toFiniteSet(set).elements;
|
|
425
485
|
};
|
|
426
486
|
|
|
427
|
-
|
|
487
|
+
const getEnumeratedElements = (set: Value, expression: Expression, version: TlcVersion) => {
|
|
488
|
+
checkEnumerable(set, expression, version);
|
|
489
|
+
if (typeof set === "object" && set.kind === "Interval") return getIntervalElements(set);
|
|
490
|
+
return getLazySubsets(set) ?? toFiniteSet(set).elements;
|
|
491
|
+
};
|
|
492
|
+
|
|
493
|
+
// The elements Tool.contexts binds to the bound of a quantifier or a set map. TLC 1.7.4 streams a
|
|
494
|
+
// lazy set's elements, where later versions normalize the set first.
|
|
495
|
+
export const getContextElements = (set: Value, expression: Expression, version: TlcVersion) => {
|
|
496
|
+
if (version !== "1.7.4") return getEnumeratedElements(set, expression, version);
|
|
497
|
+
checkEnumerable(set, expression, version);
|
|
498
|
+
return getLazySubsets(set) ?? getStreamedElements(set);
|
|
499
|
+
};
|
|
500
|
+
|
|
501
|
+
// Like TLC, a quantifier keeps an interval as an interval, so that it can stop at the first witness
|
|
502
|
+
// in a large interval such as 1..2000000000 without listing it.
|
|
503
|
+
const getKeptInterval = (set: Value) => {
|
|
504
|
+
if (typeof set !== "object" || set.kind !== "Interval") return undefined;
|
|
505
|
+
getCardinality(set);
|
|
506
|
+
return set;
|
|
507
|
+
};
|
|
508
|
+
|
|
509
|
+
export const getQuantifierElements = (set: Value, expression: Expression, version: TlcVersion) =>
|
|
510
|
+
getKeptInterval(set) ?? getContextElements(set, expression, version);
|
|
511
|
+
|
|
512
|
+
// CHOOSE and a function constructor visit the elements of the normalized set.
|
|
513
|
+
const getNormalizedElements = (set: Value, expression: Expression, version: TlcVersion) =>
|
|
514
|
+
getKeptInterval(set) ?? getEnumeratedElements(set, expression, version);
|
|
515
|
+
|
|
516
|
+
const someElement = (
|
|
517
|
+
elements: ReturnType<typeof getQuantifierElements>,
|
|
518
|
+
visit: (element: Value) => boolean,
|
|
519
|
+
) => {
|
|
520
|
+
if (Array.isArray(elements)) return elements.some(visit);
|
|
521
|
+
for (let element = elements.low; element <= elements.high; element++) {
|
|
522
|
+
if (visit(element)) return true;
|
|
523
|
+
}
|
|
524
|
+
return false;
|
|
525
|
+
};
|
|
526
|
+
|
|
527
|
+
export const getBoundElements = (bounds: Bound[], context: Context) =>
|
|
528
|
+
bounds.map((bound) =>
|
|
529
|
+
getQuantifierElements(
|
|
530
|
+
evaluate(bound.set, context),
|
|
531
|
+
bound.set,
|
|
532
|
+
context.environment.runtime.version,
|
|
533
|
+
),
|
|
534
|
+
);
|
|
535
|
+
|
|
536
|
+
// Visits each binding of the bounds to the elements of their sets, until visit returns true.
|
|
537
|
+
export const forEachBoundElement = (
|
|
428
538
|
bounds: Bound[],
|
|
429
|
-
|
|
539
|
+
sets: ReturnType<typeof getBoundElements>,
|
|
540
|
+
scope: Scope | undefined,
|
|
430
541
|
visit: (scope: Scope | undefined) => boolean,
|
|
431
542
|
): boolean => {
|
|
432
|
-
const
|
|
433
|
-
|
|
434
|
-
|
|
435
|
-
|
|
436
|
-
if (index < 0) return visit(scope);
|
|
437
|
-
return sets[index].some((element) =>
|
|
438
|
-
visitBound(index - 1, bindPattern(scope, bounds[index].pattern, element)),
|
|
543
|
+
const visitBound = (index: number, bound: Scope | undefined): boolean => {
|
|
544
|
+
if (index < 0) return visit(bound);
|
|
545
|
+
return someElement(sets[index], (element) =>
|
|
546
|
+
visitBound(index - 1, bindPattern(bound, bounds[index].pattern, element)),
|
|
439
547
|
);
|
|
440
548
|
};
|
|
441
|
-
return visitBound(bounds.length - 1,
|
|
549
|
+
return visitBound(bounds.length - 1, scope);
|
|
442
550
|
};
|
|
443
551
|
|
|
552
|
+
export const forEachBinding = (
|
|
553
|
+
bounds: Bound[],
|
|
554
|
+
context: Context,
|
|
555
|
+
visit: (scope: Scope | undefined) => boolean,
|
|
556
|
+
) => forEachBoundElement(bounds, getBoundElements(bounds, context), context.scope, visit);
|
|
557
|
+
|
|
444
558
|
export const getBoundsDomain = (bounds: Bound[], context: Context): Value => {
|
|
445
559
|
const sets = bounds.map((bound) => evaluate(bound.set, context));
|
|
446
560
|
return sets.length === 1 ? sets[0] : { kind: "ProductSet", factors: sets };
|
|
@@ -455,6 +569,80 @@ export const bindArgument = (bounds: Bound[], scope: Scope | undefined, argument
|
|
|
455
569
|
);
|
|
456
570
|
};
|
|
457
571
|
|
|
572
|
+
// The parameters, body and scope of each function a constructor or a definition keeps lazy, whose
|
|
573
|
+
// body TLC's getInitStates and getNextStates walk for an argument, as they do a FcnLambdaValue's.
|
|
574
|
+
interface LazyFunction {
|
|
575
|
+
value: LazyFunctionValue;
|
|
576
|
+
bounds: Bound[];
|
|
577
|
+
body: Expression;
|
|
578
|
+
scope: Scope | undefined;
|
|
579
|
+
}
|
|
580
|
+
|
|
581
|
+
const lazyFunctions = new WeakMap<LazyFunctionValue, LazyFunction>();
|
|
582
|
+
|
|
583
|
+
const keepLambda = (lambda: LazyFunction) => {
|
|
584
|
+
lazyFunctions.set(lambda.value, lambda);
|
|
585
|
+
return lambda.value;
|
|
586
|
+
};
|
|
587
|
+
|
|
588
|
+
export const getLazyFunction = (value: Value) =>
|
|
589
|
+
typeof value === "object" && value.kind === "LazyFunction" ? lazyFunctions.get(value) : undefined;
|
|
590
|
+
|
|
591
|
+
// Tool.getFcnContext: the scope of a lazy function's body for the arguments of an application. It
|
|
592
|
+
// ignores arguments beyond the parameters.
|
|
593
|
+
export const bindLazyArguments = (
|
|
594
|
+
lambda: LazyFunction,
|
|
595
|
+
expression: Expression & { kind: "FunctionApplication" },
|
|
596
|
+
context: Context,
|
|
597
|
+
) => {
|
|
598
|
+
const value = lambda.value;
|
|
599
|
+
const args = expression.args.map((arg) => evaluate(arg, context));
|
|
600
|
+
const argument = args.length === 1 ? args[0] : createTuple(args);
|
|
601
|
+
const describeArgument = (ordinal: string, element: Value, problem: string) =>
|
|
602
|
+
`In applying the function\n${prettyPrint(formatValue(value))},\nthe ${ordinal} is:\n${prettyPrint(formatValue(element))}${problem}.\n${describeRange(expression.function)}`;
|
|
603
|
+
const bounds = lambda.bounds;
|
|
604
|
+
if (bounds.length === 1) {
|
|
605
|
+
if (!isElementOf(argument, value.domain)) {
|
|
606
|
+
throw new TlaEvaluationError(
|
|
607
|
+
describeArgument("first argument", argument, "which is not in its domain"),
|
|
608
|
+
);
|
|
609
|
+
}
|
|
610
|
+
return bindArgument(bounds, lambda.scope, argument);
|
|
611
|
+
}
|
|
612
|
+
const elements = getSequenceElements(argument);
|
|
613
|
+
const domains =
|
|
614
|
+
typeof value.domain === "object" && value.domain.kind === "ProductSet"
|
|
615
|
+
? value.domain.factors
|
|
616
|
+
: [];
|
|
617
|
+
if (elements === undefined || elements.length < bounds.length) {
|
|
618
|
+
throw new TlaEvaluationError(
|
|
619
|
+
`Attempted to apply a function to an argument not in its domain.\n${describeRange(expression.function)}`,
|
|
620
|
+
);
|
|
621
|
+
}
|
|
622
|
+
bounds.forEach((bound, index) => {
|
|
623
|
+
const element = elements[index];
|
|
624
|
+
const ordinal = `argument number ${index + 1}`;
|
|
625
|
+
if (!isElementOf(element, domains[index])) {
|
|
626
|
+
throw new TlaEvaluationError(
|
|
627
|
+
describeArgument(
|
|
628
|
+
ordinal,
|
|
629
|
+
element,
|
|
630
|
+
`${bound.pattern.kind === "Name" ? "" : "\n"}which is not in its domain`,
|
|
631
|
+
),
|
|
632
|
+
);
|
|
633
|
+
}
|
|
634
|
+
if (
|
|
635
|
+
bound.pattern.kind === "Tuple" &&
|
|
636
|
+
getSequenceElements(element)?.length !== bound.pattern.names.length
|
|
637
|
+
) {
|
|
638
|
+
throw new TlaEvaluationError(
|
|
639
|
+
describeArgument(ordinal, element, "which does not match its formal parameter"),
|
|
640
|
+
);
|
|
641
|
+
}
|
|
642
|
+
});
|
|
643
|
+
return bindArgument(bounds, lambda.scope, createTuple(elements.slice(0, bounds.length)));
|
|
644
|
+
};
|
|
645
|
+
|
|
458
646
|
// TLC prints a function it can't enumerate as its parameters and the location of its body. It
|
|
459
647
|
// prints only the first name of a group such as `m, n \in S`.
|
|
460
648
|
interface LazyFunctionTemplate {
|
|
@@ -533,6 +721,22 @@ const createLazyFunction = (
|
|
|
533
721
|
return self;
|
|
534
722
|
};
|
|
535
723
|
|
|
724
|
+
const definitionSources = new WeakMap<FunctionDefinition, Expression>();
|
|
725
|
+
|
|
726
|
+
// The function constructor of a definition, which SANY locates at the whole definition.
|
|
727
|
+
const getDefinitionSource = (definition: FunctionDefinition) => {
|
|
728
|
+
const cached = definitionSources.get(definition);
|
|
729
|
+
if (cached) return cached;
|
|
730
|
+
const source: Expression = {
|
|
731
|
+
kind: "FunctionConstruction",
|
|
732
|
+
bounds: definition.bounds,
|
|
733
|
+
body: definition.body,
|
|
734
|
+
location: definition.location,
|
|
735
|
+
};
|
|
736
|
+
definitionSources.set(definition, source);
|
|
737
|
+
return source;
|
|
738
|
+
};
|
|
739
|
+
|
|
536
740
|
const createRecursiveFunction = (definition: FunctionDefinition, context: Context) => {
|
|
537
741
|
const domain = getBoundsDomain(definition.bounds, context);
|
|
538
742
|
const functionValue = createLazyFunction(
|
|
@@ -547,13 +751,44 @@ const createRecursiveFunction = (definition: FunctionDefinition, context: Contex
|
|
|
547
751
|
),
|
|
548
752
|
getLazyFunctionSource(definition.bounds, definition.body, domain),
|
|
549
753
|
);
|
|
754
|
+
keepLambda({
|
|
755
|
+
value: functionValue,
|
|
756
|
+
bounds: definition.bounds,
|
|
757
|
+
body: definition.body,
|
|
758
|
+
scope: bindValue(undefined, definition.name, functionValue),
|
|
759
|
+
});
|
|
550
760
|
return definition.bounds.length === 1 ? markLambdaFunction(functionValue) : functionValue;
|
|
551
761
|
};
|
|
552
762
|
|
|
553
|
-
|
|
554
|
-
|
|
763
|
+
// TLC computes a constant definition when it starts, without keeping a function it constructs
|
|
764
|
+
// lazy, so a function over an interval or an enumerated set is a FcnRcdValue.
|
|
765
|
+
const toStartupValue = (definition: Definition, value: Value): Value => {
|
|
766
|
+
if (typeof value !== "object" || getFunctionClass(value) !== "lambda") return value;
|
|
767
|
+
if (
|
|
768
|
+
definition.kind === "Operator" ||
|
|
769
|
+
definition.isSelfReferential ||
|
|
770
|
+
value.kind !== "LazyFunction" ||
|
|
771
|
+
!isReducibleSet(value.domain)
|
|
772
|
+
) {
|
|
773
|
+
return value;
|
|
774
|
+
}
|
|
775
|
+
try {
|
|
776
|
+
const finite = toFiniteFunction(value);
|
|
777
|
+
return createSortedFunction(finite.domain, finite.range);
|
|
778
|
+
} catch (error) {
|
|
779
|
+
// TLC leaves a definition it fails to compute to evaluate where the spec uses it.
|
|
780
|
+
if (error instanceof TlaEvaluationError) return value;
|
|
781
|
+
throw error;
|
|
782
|
+
}
|
|
783
|
+
};
|
|
784
|
+
|
|
785
|
+
// TLC evaluates a function definition that isn't recursive as it does a function constructor.
|
|
786
|
+
const evaluateDefinitionBody = (definition: Definition, context: Context) => {
|
|
787
|
+
if (definition.kind !== "Function") return evaluate(definition.body, context);
|
|
788
|
+
return definition.isSelfReferential
|
|
555
789
|
? createRecursiveFunction(definition, context)
|
|
556
|
-
: evaluate(definition
|
|
790
|
+
: evaluate(getDefinitionSource(definition), context);
|
|
791
|
+
};
|
|
557
792
|
|
|
558
793
|
const evaluateDefinitionValue = (definition: Definition, context: Context) => {
|
|
559
794
|
const isConstant = isConstantLevel(definition, context.environment);
|
|
@@ -567,12 +802,35 @@ const evaluateDefinitionValue = (definition: Definition, context: Context) => {
|
|
|
567
802
|
const topLevel = withScope(context, undefined);
|
|
568
803
|
if (!isConstant) return evaluateDefinitionBody(definition, topLevel);
|
|
569
804
|
const value = context.environment.runtime.evaluateAtStartup(() =>
|
|
570
|
-
evaluateDefinitionBody(definition, topLevel),
|
|
805
|
+
toStartupValue(definition, evaluateDefinitionBody(definition, topLevel)),
|
|
571
806
|
);
|
|
572
807
|
context.environment.definitionValues.set(definition, value);
|
|
573
808
|
return value;
|
|
574
809
|
};
|
|
575
810
|
|
|
811
|
+
// TLC computes each constant definition the configuration doesn't replace when it starts, and
|
|
812
|
+
// leaves one it fails to compute to evaluate where the spec uses it.
|
|
813
|
+
export const evaluateStartupDefinitions = (definitions: Definition[], environment: Environment) =>
|
|
814
|
+
definitions.forEach((definition) => {
|
|
815
|
+
if (definition.kind === "Operator" && definition.params.length > 0) return;
|
|
816
|
+
const name = definition.name;
|
|
817
|
+
if (environment.constants.has(name) || environment.substitutions.has(name)) return;
|
|
818
|
+
if (!isConstantLevel(definition, environment)) return;
|
|
819
|
+
try {
|
|
820
|
+
markNormalized(
|
|
821
|
+
evaluateDefinitionValue(definition, {
|
|
822
|
+
environment,
|
|
823
|
+
scope: undefined,
|
|
824
|
+
state: undefined,
|
|
825
|
+
next: undefined,
|
|
826
|
+
}),
|
|
827
|
+
);
|
|
828
|
+
} catch (error) {
|
|
829
|
+
// TLC swallows whatever the definition throws, a stack overflow included.
|
|
830
|
+
if (!(error instanceof TlaEvaluationError) && !isStackOverflow(error)) throw error;
|
|
831
|
+
}
|
|
832
|
+
});
|
|
833
|
+
|
|
576
834
|
const forceThunk = (thunk: Thunk, context: Context) => {
|
|
577
835
|
const isSameState = thunk.state === context.state && thunk.next === context.next;
|
|
578
836
|
if (isSameState && thunk.cache !== undefined) return thunk.cache;
|
|
@@ -859,11 +1117,7 @@ const evaluateLocalIdentifier = (name: string, expression: Expression, context:
|
|
|
859
1117
|
const global = findGlobalName(name, context.environment);
|
|
860
1118
|
if (global?.kind === "Variable") {
|
|
861
1119
|
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
|
-
}
|
|
1120
|
+
if (value === undefined) throw createUnassignedError(name, expression);
|
|
867
1121
|
return value;
|
|
868
1122
|
}
|
|
869
1123
|
if (global?.kind === "Value") return global.value;
|
|
@@ -889,14 +1143,29 @@ const IMPURE_BUILTINS = new Set([
|
|
|
889
1143
|
export const isImpureBuiltin = (name: string, environment: Environment) =>
|
|
890
1144
|
IMPURE_BUILTINS.has(name) || environment.builtins.get(name)?.isStateLevel === true;
|
|
891
1145
|
|
|
892
|
-
|
|
1146
|
+
interface Impurity {
|
|
1147
|
+
builtins: Set<string>;
|
|
1148
|
+
definitions: WeakMap<Definition, boolean>;
|
|
1149
|
+
}
|
|
1150
|
+
|
|
1151
|
+
const ANY_EFFECT: Impurity = { builtins: IMPURE_BUILTINS, definitions: new WeakMap() };
|
|
1152
|
+
|
|
1153
|
+
// An Assert that held holds again, so evaluating it twice looks the same as evaluating it once.
|
|
1154
|
+
const REPEATED_EFFECT: Impurity = {
|
|
1155
|
+
builtins: new Set([...IMPURE_BUILTINS].filter((name) => name !== "Assert")),
|
|
1156
|
+
definitions: new WeakMap(),
|
|
1157
|
+
};
|
|
893
1158
|
|
|
894
1159
|
const isEvaluatedOnce = (definition: Definition, environment: Environment) =>
|
|
895
1160
|
definition.kind === "Operator" &&
|
|
896
1161
|
definition.params.length === 0 &&
|
|
897
1162
|
isConstantLevel(definition, environment);
|
|
898
1163
|
|
|
899
|
-
const callsImpureBuiltin = (
|
|
1164
|
+
const callsImpureBuiltin = (
|
|
1165
|
+
expression: Expression,
|
|
1166
|
+
environment: Environment,
|
|
1167
|
+
impurity: Impurity,
|
|
1168
|
+
): boolean => {
|
|
900
1169
|
const name =
|
|
901
1170
|
expression.kind === "Identifier"
|
|
902
1171
|
? expression.name
|
|
@@ -905,42 +1174,68 @@ const callsImpureBuiltin = (expression: Expression, environment: Environment): b
|
|
|
905
1174
|
: undefined;
|
|
906
1175
|
if (name !== undefined && !isLocallyResolved(expression)) {
|
|
907
1176
|
const definition = getDefinition(name, environment);
|
|
908
|
-
|
|
1177
|
+
const isImpureCall =
|
|
1178
|
+
impurity.builtins.has(name) || environment.builtins.get(name)?.isStateLevel === true;
|
|
1179
|
+
if (!definition && isImpureCall) return true;
|
|
909
1180
|
if (
|
|
910
1181
|
definition &&
|
|
911
1182
|
!isEvaluatedOnce(definition, environment) &&
|
|
912
|
-
isImpureDefinition(definition, environment)
|
|
1183
|
+
isImpureDefinition(definition, environment, impurity)
|
|
913
1184
|
) {
|
|
914
1185
|
return true;
|
|
915
1186
|
}
|
|
916
1187
|
}
|
|
917
|
-
return getChildren(expression).some((child) => callsImpureBuiltin(child, environment));
|
|
1188
|
+
return getChildren(expression).some((child) => callsImpureBuiltin(child, environment, impurity));
|
|
918
1189
|
};
|
|
919
1190
|
|
|
920
1191
|
// TLC evaluates a constant definition without parameters once, so only other definitions pass
|
|
921
1192
|
// on the side effects and random choices of the builtins they call.
|
|
922
|
-
const isImpureDefinition = (
|
|
923
|
-
|
|
1193
|
+
const isImpureDefinition = (
|
|
1194
|
+
definition: Definition,
|
|
1195
|
+
environment: Environment,
|
|
1196
|
+
impurity = ANY_EFFECT,
|
|
1197
|
+
): boolean => {
|
|
1198
|
+
const cached = impurity.definitions.get(definition);
|
|
924
1199
|
if (cached !== undefined) return cached;
|
|
925
|
-
|
|
1200
|
+
impurity.definitions.set(definition, false);
|
|
926
1201
|
const isImpure =
|
|
927
|
-
callsImpureBuiltin(definition.body, environment) ||
|
|
1202
|
+
callsImpureBuiltin(definition.body, environment, impurity) ||
|
|
928
1203
|
(definition.kind === "Function" &&
|
|
929
|
-
definition.bounds.some((bound) => callsImpureBuiltin(bound.set, environment)));
|
|
930
|
-
|
|
1204
|
+
definition.bounds.some((bound) => callsImpureBuiltin(bound.set, environment, impurity)));
|
|
1205
|
+
impurity.definitions.set(definition, isImpure);
|
|
931
1206
|
return isImpure;
|
|
932
1207
|
};
|
|
933
1208
|
|
|
1209
|
+
// UNION and \cup build sets that stream the sets they combine until TLC caches them, and TLC
|
|
1210
|
+
// builds a new one at each evaluation.
|
|
1211
|
+
const STREAMED_SET: Impurity = {
|
|
1212
|
+
builtins: new Set(["UNION", "\\cup"]),
|
|
1213
|
+
definitions: new WeakMap(),
|
|
1214
|
+
};
|
|
1215
|
+
|
|
934
1216
|
// TLC's next-state generator does not bind LET definitions to values, so each reference to one
|
|
935
|
-
// that calls an impure builtin
|
|
1217
|
+
// evaluates it again: one that calls an impure builtin repeats its effects, and a set one builds
|
|
1218
|
+
// with UNION or \cup starts out uncached.
|
|
936
1219
|
export const getReevaluatedDefinitions = (definitions: Definition[], environment: Environment) =>
|
|
937
|
-
new Set(
|
|
1220
|
+
new Set(
|
|
1221
|
+
definitions.filter(
|
|
1222
|
+
(definition) =>
|
|
1223
|
+
isImpureDefinition(definition, environment) ||
|
|
1224
|
+
isImpureDefinition(definition, environment, STREAMED_SET),
|
|
1225
|
+
),
|
|
1226
|
+
);
|
|
938
1227
|
|
|
939
1228
|
export const isImpure = (environment: Environment) =>
|
|
940
1229
|
[...environment.definitions.values()].some((definition) =>
|
|
941
1230
|
isImpureDefinition(definition, environment),
|
|
942
1231
|
);
|
|
943
1232
|
|
|
1233
|
+
// Whether evaluating a definition again can show, such as by printing twice.
|
|
1234
|
+
export const hasRepeatedEffects = (environment: Environment) =>
|
|
1235
|
+
[...environment.definitions.values()].some((definition) =>
|
|
1236
|
+
isImpureDefinition(definition, environment, REPEATED_EFFECT),
|
|
1237
|
+
);
|
|
1238
|
+
|
|
944
1239
|
const closedConstants = new WeakMap<Expression, boolean>();
|
|
945
1240
|
|
|
946
1241
|
export const isClosedConstant = (expression: Expression, environment: Environment): boolean => {
|
|
@@ -1004,7 +1299,11 @@ const computeIsClosedConstant = (
|
|
|
1004
1299
|
return global?.kind === "Definition" && isEvaluatedOnce(global.definition, environment);
|
|
1005
1300
|
}
|
|
1006
1301
|
if (expression.kind === "Apply") {
|
|
1007
|
-
if (
|
|
1302
|
+
if (
|
|
1303
|
+
isImpureBuiltin(expression.operator, environment) ||
|
|
1304
|
+
STREAMED_SET.builtins.has(expression.operator) ||
|
|
1305
|
+
expression.operator === "~>"
|
|
1306
|
+
) {
|
|
1008
1307
|
return false;
|
|
1009
1308
|
}
|
|
1010
1309
|
const operator = resolveGlobalOperator(expression.operator, environment);
|
|
@@ -1076,12 +1375,127 @@ const isStateCached = (expression: Expression, environment: Environment) =>
|
|
|
1076
1375
|
getReadVariables(expression, environment) !== undefined &&
|
|
1077
1376
|
!hasFreeLocals(expression, NO_BOUND_NAMES);
|
|
1078
1377
|
|
|
1378
|
+
// How to rebuild a set filter TLC evaluates lazily so that its predicate runs in another
|
|
1379
|
+
// environment.
|
|
1380
|
+
const filteredSetRebinders = new WeakMap<FilteredSetValue, (environment: Environment) => Value>();
|
|
1381
|
+
|
|
1382
|
+
// TLC's CallStackTool rebinds the lazy values its evaluations return, so their later evaluation
|
|
1383
|
+
// records its call stack too.
|
|
1384
|
+
const traceEvaluator =
|
|
1385
|
+
(
|
|
1386
|
+
expression: Expression,
|
|
1387
|
+
evaluator: Evaluator,
|
|
1388
|
+
environment: Environment,
|
|
1389
|
+
callStack: CallStack,
|
|
1390
|
+
): Evaluator =>
|
|
1391
|
+
(context) => {
|
|
1392
|
+
callStack.expressions.push(expression);
|
|
1393
|
+
const outerSets = setTrace.sets;
|
|
1394
|
+
const outerCallStack = setTrace.callStack;
|
|
1395
|
+
const sets = outerSets ?? [];
|
|
1396
|
+
const depth = sets.length;
|
|
1397
|
+
setTrace.sets = sets;
|
|
1398
|
+
setTrace.callStack = callStack;
|
|
1399
|
+
try {
|
|
1400
|
+
const computed = evaluator(context);
|
|
1401
|
+
const rebind =
|
|
1402
|
+
typeof computed === "object" && computed.kind === "FilteredSet"
|
|
1403
|
+
? filteredSetRebinders.get(computed)
|
|
1404
|
+
: undefined;
|
|
1405
|
+
const value = rebind ? rebind(environment) : computed;
|
|
1406
|
+
callStack.values.set(expression, value);
|
|
1407
|
+
if (typeof value === "object" && value.kind !== "FilteredSet" && isSourced(expression)) {
|
|
1408
|
+
callStack.sources.set(value, expression);
|
|
1409
|
+
}
|
|
1410
|
+
return value;
|
|
1411
|
+
} catch (error) {
|
|
1412
|
+
const failed = error instanceof Error ? callStack.failures.get(error) : undefined;
|
|
1413
|
+
if (error instanceof Error) callStack.failures.set(error, expression);
|
|
1414
|
+
const receiver = getReceiver(expression, callStack.values);
|
|
1415
|
+
const received =
|
|
1416
|
+
receiver && !getChildren(expression).some((child) => child === failed)
|
|
1417
|
+
? callStack.values.get(receiver)
|
|
1418
|
+
: undefined;
|
|
1419
|
+
const value =
|
|
1420
|
+
expression.kind === "FunctionApplication" &&
|
|
1421
|
+
received !== undefined &&
|
|
1422
|
+
!isFunctionValue(received)
|
|
1423
|
+
? undefined
|
|
1424
|
+
: received;
|
|
1425
|
+
freezeCallStack(
|
|
1426
|
+
callStack,
|
|
1427
|
+
[value, ...sets.slice(depth).filter((set) => set !== value)],
|
|
1428
|
+
error,
|
|
1429
|
+
);
|
|
1430
|
+
throw error;
|
|
1431
|
+
} finally {
|
|
1432
|
+
if (!callStack.isFrozen) callStack.expressions.pop();
|
|
1433
|
+
sets.length = depth;
|
|
1434
|
+
setTrace.sets = outerSets;
|
|
1435
|
+
setTrace.callStack = outerCallStack;
|
|
1436
|
+
}
|
|
1437
|
+
};
|
|
1438
|
+
|
|
1439
|
+
// A method of a value with a source raises a FingerprintException, which each value with a source
|
|
1440
|
+
// whose method called it heads in turn. CallStack#freeze adds their sources to the stack, outermost
|
|
1441
|
+
// first. The values are those whose methods failed, outermost first.
|
|
1442
|
+
export const freezeCallStack = (
|
|
1443
|
+
callStack: CallStack,
|
|
1444
|
+
values: (Value | undefined)[],
|
|
1445
|
+
error: unknown,
|
|
1446
|
+
) => {
|
|
1447
|
+
// A set that streams its elements enumerates itself too, so it can appear twice.
|
|
1448
|
+
const sources = [...new Set(values)].flatMap((item) => {
|
|
1449
|
+
const source = typeof item === "object" ? callStack.sources.get(item) : undefined;
|
|
1450
|
+
return source ? [source] : [];
|
|
1451
|
+
});
|
|
1452
|
+
// A value with a source raises a FingerprintException even when the stack is frozen already.
|
|
1453
|
+
if (sources.length > 0 && error instanceof TlaEvaluationError) {
|
|
1454
|
+
if (!callStack.isFrozen) callStack.expressions.push(...sources);
|
|
1455
|
+
const inner = callStack.fingerprint;
|
|
1456
|
+
callStack.fingerprint = {
|
|
1457
|
+
sources: [...sources, ...(inner?.sources ?? [])],
|
|
1458
|
+
reason: inner?.reason ?? error.message,
|
|
1459
|
+
};
|
|
1460
|
+
}
|
|
1461
|
+
callStack.isFrozen = true;
|
|
1462
|
+
};
|
|
1463
|
+
|
|
1464
|
+
// A FingerprintException that a method of a value with a source raises, or that passes through one,
|
|
1465
|
+
// takes the value's source as its new head.
|
|
1466
|
+
const headFingerprint = (callStack: CallStack, source: Expression, error: unknown) => {
|
|
1467
|
+
if (!(error instanceof TlaEvaluationError)) return;
|
|
1468
|
+
if (!callStack.isFrozen) callStack.expressions.push(source);
|
|
1469
|
+
callStack.isFrozen = true;
|
|
1470
|
+
const inner = callStack.fingerprint;
|
|
1471
|
+
callStack.fingerprint = {
|
|
1472
|
+
sources: [source, ...(inner?.sources ?? [])],
|
|
1473
|
+
reason: inner?.reason ?? error.message,
|
|
1474
|
+
};
|
|
1475
|
+
};
|
|
1476
|
+
|
|
1477
|
+
// A copy of the environment that records the call stack of each evaluation, with evaluators of its
|
|
1478
|
+
// own since the environment's evaluators record nothing.
|
|
1479
|
+
export const createTracingEnvironment = (environment: Environment): Environment => ({
|
|
1480
|
+
...environment,
|
|
1481
|
+
evaluators: new WeakMap(),
|
|
1482
|
+
callStack: {
|
|
1483
|
+
expressions: [],
|
|
1484
|
+
isFrozen: false,
|
|
1485
|
+
sources: new WeakMap(),
|
|
1486
|
+
values: new WeakMap(),
|
|
1487
|
+
failures: new WeakMap(),
|
|
1488
|
+
},
|
|
1489
|
+
});
|
|
1490
|
+
|
|
1079
1491
|
export const getEvaluator = (expression: Expression, environment: Environment): Evaluator => {
|
|
1080
1492
|
const cached = environment.evaluators.get(expression);
|
|
1081
1493
|
if (cached) return cached;
|
|
1082
1494
|
const compiled = compile(expression, environment);
|
|
1083
|
-
const
|
|
1084
|
-
|
|
1495
|
+
const callStack = environment.callStack;
|
|
1496
|
+
const evaluator = callStack
|
|
1497
|
+
? traceEvaluator(expression, compiled, environment, callStack)
|
|
1498
|
+
: isWorthCaching(expression) && isClosedConstant(expression, environment)
|
|
1085
1499
|
? cacheFirstValue(compiled)
|
|
1086
1500
|
: isStateCached(expression, environment)
|
|
1087
1501
|
? cacheStateValue(compiled)
|
|
@@ -1093,6 +1507,7 @@ export const getEvaluator = (expression: Expression, environment: Environment):
|
|
|
1093
1507
|
const entryEvaluators = new WeakMap<Expression, Evaluator>();
|
|
1094
1508
|
|
|
1095
1509
|
const getEntryEvaluator = (expression: Expression, environment: Environment) => {
|
|
1510
|
+
if (environment.callStack) return getEvaluator(expression, environment);
|
|
1096
1511
|
const cached = entryEvaluators.get(expression);
|
|
1097
1512
|
if (cached) return cached;
|
|
1098
1513
|
const evaluator =
|
|
@@ -1116,11 +1531,7 @@ const compileIdentifier = (
|
|
|
1116
1531
|
const index = global.index;
|
|
1117
1532
|
return (context) => {
|
|
1118
1533
|
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
|
-
}
|
|
1534
|
+
if (value === undefined) throw createUnassignedError(name, expression);
|
|
1124
1535
|
return value;
|
|
1125
1536
|
};
|
|
1126
1537
|
}
|
|
@@ -1320,14 +1731,21 @@ const compileClosureCall = (
|
|
|
1320
1731
|
const compiled = { body: undefined as Evaluator | undefined };
|
|
1321
1732
|
const evaluateBody = (scope: Scope | undefined, context: Context) => {
|
|
1322
1733
|
compiled.body ??= getEntryEvaluator(closure.body, environment);
|
|
1323
|
-
return compiled.body({
|
|
1734
|
+
return compiled.body({
|
|
1735
|
+
environment,
|
|
1736
|
+
scope,
|
|
1737
|
+
state: context.state,
|
|
1738
|
+
next: context.next,
|
|
1739
|
+
isKeepLazy: context.isKeepLazy,
|
|
1740
|
+
});
|
|
1324
1741
|
};
|
|
1325
1742
|
if (!isMemoized) return (context) => evaluateBody(bindArguments(context), context);
|
|
1326
1743
|
const memo = getCallMemo(closure);
|
|
1327
1744
|
return (context) => {
|
|
1328
1745
|
const scope = bindArguments(context);
|
|
1329
1746
|
const values = getArgumentValues(scope, args.length);
|
|
1330
|
-
|
|
1747
|
+
// A call TLC evaluates with EvalControl.KeepLazy builds what a memoized one wouldn't.
|
|
1748
|
+
if (!values || context.isKeepLazy) return evaluateBody(scope, context);
|
|
1331
1749
|
let hash = values.length;
|
|
1332
1750
|
for (const value of values) hash = combineHash(hash, getValueHash(value));
|
|
1333
1751
|
const bucket = memo.calls.get(hash);
|
|
@@ -1364,7 +1782,9 @@ const compileApply = (
|
|
|
1364
1782
|
? undefined
|
|
1365
1783
|
: resolveGlobalOperator(expression.operator, environment);
|
|
1366
1784
|
if (global?.kind === "Closure") {
|
|
1367
|
-
|
|
1785
|
+
// The replay records the evaluation of each call, which TLC repeats.
|
|
1786
|
+
const isMemoized = !environment.callStack && isMemoizable(expression, environment);
|
|
1787
|
+
return compileClosureCall(global, args, environment, isMemoized);
|
|
1368
1788
|
}
|
|
1369
1789
|
if (global?.kind === "Builtin" && global.name === "DOMAIN") {
|
|
1370
1790
|
const operand = getEvaluator(args[0], environment);
|
|
@@ -1374,7 +1794,7 @@ const compileApply = (
|
|
|
1374
1794
|
// TLC sorts the value of a constant TLCEval argument only where no context binds a name.
|
|
1375
1795
|
if (global?.kind === "Builtin" && global.name === "TLCEval" && args.length === 1) {
|
|
1376
1796
|
const operand = getEvaluator(args[0], environment);
|
|
1377
|
-
if (contextualApplications.has(expression) ||
|
|
1797
|
+
if (contextualApplications.has(expression) || isNonconstant(args[0], environment)) {
|
|
1378
1798
|
return operand;
|
|
1379
1799
|
}
|
|
1380
1800
|
return (context) =>
|
|
@@ -1387,6 +1807,16 @@ const compileApply = (
|
|
|
1387
1807
|
return (context) => subset(left(context), right(context));
|
|
1388
1808
|
}
|
|
1389
1809
|
if (global?.kind === "Builtin") return compileBuiltinCall(global, args, environment);
|
|
1810
|
+
// TLC refuses action composition unless a Java property enables its incomplete implementation.
|
|
1811
|
+
if (expression.operator === "\\cdot" && args.length === 2) {
|
|
1812
|
+
return () => {
|
|
1813
|
+
throw new TlaEvaluationError(
|
|
1814
|
+
environment.runtime.version === "1.7.4"
|
|
1815
|
+
? "The current version of TLC does not support action composition."
|
|
1816
|
+
: "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.",
|
|
1817
|
+
);
|
|
1818
|
+
};
|
|
1819
|
+
}
|
|
1390
1820
|
return (context) => {
|
|
1391
1821
|
const operator = resolveOperator(expression.operator, context);
|
|
1392
1822
|
if (operator) return callOperator(operator, args, context);
|
|
@@ -1412,15 +1842,15 @@ const compileQuantifier = (
|
|
|
1412
1842
|
const name = bound.pattern.name;
|
|
1413
1843
|
const set = getEvaluator(bound.set, environment);
|
|
1414
1844
|
return (context) => {
|
|
1415
|
-
const
|
|
1416
|
-
|
|
1417
|
-
|
|
1418
|
-
|
|
1419
|
-
|
|
1420
|
-
|
|
1421
|
-
|
|
1422
|
-
|
|
1423
|
-
return isForall;
|
|
1845
|
+
const isFound = someElement(
|
|
1846
|
+
getQuantifierElements(set(context), bound.set, environment.runtime.version),
|
|
1847
|
+
(element) =>
|
|
1848
|
+
expectBoolean(
|
|
1849
|
+
body(withScope(context, bindValue(context.scope, name, element))),
|
|
1850
|
+
description,
|
|
1851
|
+
) !== isForall,
|
|
1852
|
+
);
|
|
1853
|
+
return isFound ? !isForall : isForall;
|
|
1424
1854
|
};
|
|
1425
1855
|
}
|
|
1426
1856
|
const bounds = expression.bounds;
|
|
@@ -1429,17 +1859,15 @@ const compileQuantifier = (
|
|
|
1429
1859
|
const sets = bounds.map((item) => getEvaluator(item.set, environment));
|
|
1430
1860
|
return (context) => {
|
|
1431
1861
|
const lists = sets.map((set, index) =>
|
|
1432
|
-
|
|
1862
|
+
getQuantifierElements(set(context), bounds[index].set, environment.runtime.version),
|
|
1433
1863
|
);
|
|
1434
1864
|
const visit = (index: number, scope: Scope | undefined): boolean => {
|
|
1435
1865
|
if (index < 0) {
|
|
1436
1866
|
return expectBoolean(body(withScope(context, scope)), description) !== isForall;
|
|
1437
1867
|
}
|
|
1438
|
-
|
|
1439
|
-
|
|
1440
|
-
|
|
1441
|
-
}
|
|
1442
|
-
return false;
|
|
1868
|
+
return someElement(lists[index], (element) =>
|
|
1869
|
+
visit(index - 1, bindValue(scope, names[index], element)),
|
|
1870
|
+
);
|
|
1443
1871
|
};
|
|
1444
1872
|
return visit(bounds.length - 1, context.scope) ? !isForall : isForall;
|
|
1445
1873
|
};
|
|
@@ -1487,28 +1915,26 @@ const compileFunctionConstruction = (
|
|
|
1487
1915
|
const bound = bounds[0];
|
|
1488
1916
|
const isSingleName = bounds.length === 1 && bound.pattern.kind === "Name";
|
|
1489
1917
|
const set = getEvaluator(bound.set, environment);
|
|
1490
|
-
|
|
1491
|
-
const domain = isSingleName ? set(context) : getBoundsDomain(bounds, context);
|
|
1492
|
-
if (expression.isRecursive || isKeptLazy || !isEnumerable(domain)) {
|
|
1493
|
-
const functionValue = createLazyFunction(
|
|
1494
|
-
domain,
|
|
1495
|
-
(argument) => body(withScope(context, bindArgument(bounds, context.scope, argument))),
|
|
1496
|
-
getLazyFunctionSource(bounds, expression.body, domain),
|
|
1497
|
-
);
|
|
1498
|
-
return bounds.length === 1 ? markLambdaFunction(functionValue) : functionValue;
|
|
1499
|
-
}
|
|
1918
|
+
const construct = (domain: Value, context: Context) => {
|
|
1500
1919
|
if (isSingleName && bound.pattern.kind === "Name") {
|
|
1501
1920
|
const name = bound.pattern.name;
|
|
1502
1921
|
const keys = getFunctionDomain(domain);
|
|
1503
|
-
|
|
1504
|
-
|
|
1505
|
-
|
|
1506
|
-
keys.map((key) => body(withScope(context, bindValue(context.scope, name, key)))),
|
|
1507
|
-
),
|
|
1922
|
+
const functionValue = createSortedFunction(
|
|
1923
|
+
keys,
|
|
1924
|
+
keys.map((key) => body(withScope(context, bindValue(context.scope, name, key)))),
|
|
1508
1925
|
);
|
|
1926
|
+
// FcnLambdaValue#toFcnRcd builds a FcnRcdValue over an interval or an enumerated set.
|
|
1927
|
+
return isReducibleSet(domain) ? functionValue : markLambdaFunction(functionValue);
|
|
1509
1928
|
}
|
|
1510
1929
|
const pairs: [Value, Value][] = [];
|
|
1511
|
-
|
|
1930
|
+
const sets = bounds.map((item) =>
|
|
1931
|
+
getNormalizedElements(
|
|
1932
|
+
evaluate(item.set, context),
|
|
1933
|
+
item.set,
|
|
1934
|
+
context.environment.runtime.version,
|
|
1935
|
+
),
|
|
1936
|
+
);
|
|
1937
|
+
forEachBoundElement(bounds, sets, context.scope, (scope) => {
|
|
1512
1938
|
const key =
|
|
1513
1939
|
bounds.length === 1
|
|
1514
1940
|
? (lookupKey(bound.pattern, scope) ?? false)
|
|
@@ -1518,6 +1944,46 @@ const compileFunctionConstruction = (
|
|
|
1518
1944
|
});
|
|
1519
1945
|
return createFunction(pairs);
|
|
1520
1946
|
};
|
|
1947
|
+
const createLazy = (domain: Value, context: Context) => {
|
|
1948
|
+
const functionValue = keepLambda({
|
|
1949
|
+
value: createLazyFunction(
|
|
1950
|
+
domain,
|
|
1951
|
+
(argument) => body(withScope(context, bindArgument(bounds, context.scope, argument))),
|
|
1952
|
+
getLazyFunctionSource(bounds, expression.body, domain),
|
|
1953
|
+
),
|
|
1954
|
+
bounds,
|
|
1955
|
+
body: expression.body,
|
|
1956
|
+
scope: context.scope,
|
|
1957
|
+
});
|
|
1958
|
+
return bounds.length === 1 ? markLambdaFunction(functionValue) : functionValue;
|
|
1959
|
+
};
|
|
1960
|
+
const callStack = environment.callStack;
|
|
1961
|
+
return (context) => {
|
|
1962
|
+
const domain = isSingleName ? set(context) : getBoundsDomain(bounds, context);
|
|
1963
|
+
if (expression.isRecursive || isKeptLazy || context.isKeepLazy || !isEnumerable(domain)) {
|
|
1964
|
+
return createLazy(domain, context);
|
|
1965
|
+
}
|
|
1966
|
+
// TLC builds a function over a domain other than a set enumeration or an interval lazily, so
|
|
1967
|
+
// its body fails only where TLC forces it, as the replay does. Building it at once is faster
|
|
1968
|
+
// otherwise.
|
|
1969
|
+
if (!isReducibleSet(domain)) {
|
|
1970
|
+
if (callStack) return createLazy(domain, context);
|
|
1971
|
+
try {
|
|
1972
|
+
return construct(domain, context);
|
|
1973
|
+
} catch (error) {
|
|
1974
|
+
if (!(error instanceof TlaEvaluationError)) throw error;
|
|
1975
|
+
return createLazy(domain, context);
|
|
1976
|
+
}
|
|
1977
|
+
}
|
|
1978
|
+
if (!callStack) return construct(domain, context);
|
|
1979
|
+
// TLC builds the function in a method of the FcnLambdaValue that CallStackTool gives a source.
|
|
1980
|
+
try {
|
|
1981
|
+
return construct(domain, context);
|
|
1982
|
+
} catch (error) {
|
|
1983
|
+
headFingerprint(callStack, expression, error);
|
|
1984
|
+
throw error;
|
|
1985
|
+
}
|
|
1986
|
+
};
|
|
1521
1987
|
};
|
|
1522
1988
|
|
|
1523
1989
|
const compileExcept = (
|
|
@@ -1563,7 +2029,20 @@ const compileExcept = (
|
|
|
1563
2029
|
};
|
|
1564
2030
|
return (context) => {
|
|
1565
2031
|
let current = evaluateFunction(context);
|
|
1566
|
-
for (const item of updates)
|
|
2032
|
+
for (const item of updates) {
|
|
2033
|
+
// TLC leaves the value as it is when an update's path is not in it, and warns.
|
|
2034
|
+
const found = { value: false };
|
|
2035
|
+
current = update(current, item.path, 0, context, (inner) => {
|
|
2036
|
+
found.value = true;
|
|
2037
|
+
return item.value(inner);
|
|
2038
|
+
});
|
|
2039
|
+
if (!found.value) {
|
|
2040
|
+
context.environment.runtime.warn(
|
|
2041
|
+
MESSAGE_CODE.exceptAppliedToUnknownField,
|
|
2042
|
+
`The EXCEPT was applied to non-existing fields of the value at\n${describeRange(expression.function)}`,
|
|
2043
|
+
);
|
|
2044
|
+
}
|
|
2045
|
+
}
|
|
1567
2046
|
return current;
|
|
1568
2047
|
};
|
|
1569
2048
|
};
|
|
@@ -1576,23 +2055,41 @@ const compileSetComprehension = (
|
|
|
1576
2055
|
const predicate = getEvaluator(expression.predicate, environment);
|
|
1577
2056
|
const set = getEvaluator(expression.bound.set, environment);
|
|
1578
2057
|
const pattern = expression.bound.pattern;
|
|
2058
|
+
const range = expression.predicate.location.range;
|
|
2059
|
+
const source = range && {
|
|
2060
|
+
names: pattern.kind === "Name" ? pattern.name : pattern.names.join(", "),
|
|
2061
|
+
predicate: formatRange(range),
|
|
2062
|
+
};
|
|
2063
|
+
const createTest = (evaluator: Evaluator, context: Context) => (element: Value) =>
|
|
2064
|
+
expectBoolean(
|
|
2065
|
+
evaluator(withScope(context, bindPattern(context.scope, pattern, element))),
|
|
2066
|
+
"a set filter predicate",
|
|
2067
|
+
);
|
|
2068
|
+
const createFiltered = (
|
|
2069
|
+
base: Value,
|
|
2070
|
+
context: Context,
|
|
2071
|
+
evaluator: Evaluator,
|
|
2072
|
+
): FilteredSetValue => {
|
|
2073
|
+
const filtered: FilteredSetValue = {
|
|
2074
|
+
kind: "FilteredSet",
|
|
2075
|
+
base,
|
|
2076
|
+
test: createTest(evaluator, context),
|
|
2077
|
+
source,
|
|
2078
|
+
};
|
|
2079
|
+
filteredSetRebinders.set(filtered, (tracing) =>
|
|
2080
|
+
createFiltered(
|
|
2081
|
+
base,
|
|
2082
|
+
{ ...context, environment: tracing },
|
|
2083
|
+
getEvaluator(expression.predicate, tracing),
|
|
2084
|
+
),
|
|
2085
|
+
);
|
|
2086
|
+
return filtered;
|
|
2087
|
+
};
|
|
1579
2088
|
return (context) => {
|
|
1580
2089
|
const base = set(context);
|
|
1581
|
-
|
|
1582
|
-
|
|
1583
|
-
|
|
1584
|
-
"a set filter predicate",
|
|
1585
|
-
);
|
|
1586
|
-
const isReducible =
|
|
1587
|
-
typeof base === "object" &&
|
|
1588
|
-
(base.kind === "Set" || base.kind === "MixedSet" || base.kind === "Interval");
|
|
1589
|
-
if (!isReducible) {
|
|
1590
|
-
if (isSetValue(base)) return { kind: "FilteredSet", base, test };
|
|
1591
|
-
throw new TlaEvaluationError(
|
|
1592
|
-
`TLC encountered a non-enumerable quantifier bound ${formatValue(base)} at ${describeLocation(expression.bound.set)}`,
|
|
1593
|
-
);
|
|
1594
|
-
}
|
|
1595
|
-
return createSortedSet(toFiniteSet(base).elements.filter(test));
|
|
2090
|
+
// TLC filters any value it can't enumerate lazily, and fails only when it uses the result.
|
|
2091
|
+
if (!isReducibleSet(base)) return createFiltered(base, context, predicate);
|
|
2092
|
+
return createSortedSet(toFiniteSet(base).elements.filter(createTest(predicate, context)));
|
|
1596
2093
|
};
|
|
1597
2094
|
}
|
|
1598
2095
|
if (expression.kind === "SetMap") {
|
|
@@ -1615,10 +2112,18 @@ const compileSetComprehension = (
|
|
|
1615
2112
|
};
|
|
1616
2113
|
}
|
|
1617
2114
|
const body = getEvaluator(expression.body, environment);
|
|
1618
|
-
const
|
|
2115
|
+
const evaluateSet = getEvaluator(set, environment);
|
|
1619
2116
|
return (context) => {
|
|
2117
|
+
const base = evaluateSet(context);
|
|
2118
|
+
if (!isSetValue(base) || isOverriddenSet(base)) {
|
|
2119
|
+
throw new TlaEvaluationError(
|
|
2120
|
+
`Attempted to compute the value of an expression of\nform CHOOSE x \\in S: P, but S was not enumerable.\n${describeRange(expression)}`,
|
|
2121
|
+
);
|
|
2122
|
+
}
|
|
1620
2123
|
const chosen = { value: undefined as Value | undefined };
|
|
1621
|
-
|
|
2124
|
+
const elements = getNormalizedElements(base, set, context.environment.runtime.version);
|
|
2125
|
+
someElement(elements, (element) => {
|
|
2126
|
+
const scope = bindPattern(context.scope, expression.pattern, element);
|
|
1622
2127
|
if (!expectBoolean(body(withScope(context, scope)), "the body of CHOOSE")) return false;
|
|
1623
2128
|
chosen.value = lookupKey(expression.pattern, scope);
|
|
1624
2129
|
return true;
|
|
@@ -1632,16 +2137,42 @@ const compileSetComprehension = (
|
|
|
1632
2137
|
};
|
|
1633
2138
|
};
|
|
1634
2139
|
|
|
1635
|
-
|
|
1636
|
-
|
|
1637
|
-
|
|
1638
|
-
|
|
2140
|
+
// TLC orders a record's fields by name.
|
|
2141
|
+
export const getSortedFields = (fields: RecordField[]) =>
|
|
2142
|
+
[...fields].sort((left, right) => compareValues(left.name, right.name));
|
|
2143
|
+
|
|
2144
|
+
export const hasDuplicateFields = (sortedFields: RecordField[]) =>
|
|
2145
|
+
sortedFields.some((field, index) => index > 0 && sortedFields[index - 1].name === field.name);
|
|
2146
|
+
|
|
2147
|
+
// TLC's Tool#evalAppl fails to look up a variable the state doesn't assign.
|
|
2148
|
+
export const createUnassignedError = (name: string, expression: Expression) =>
|
|
2149
|
+
new TlaUnassignedError(
|
|
2150
|
+
`In evaluation, the identifier ${name} is either undefined or not an operator.\n${describeRange(expression)}`,
|
|
2151
|
+
name,
|
|
2152
|
+
);
|
|
2153
|
+
|
|
2154
|
+
// TLC's Tool#enabled reads the subscript of <<A>>_v in the successor as a state of its own, and
|
|
2155
|
+
// names the fairness condition when A leaves a variable of v unassigned, unlike TLC 1.7.4's.
|
|
2156
|
+
export const toUnspecifiedSubscriptError = (error: unknown, version: TlcVersion | undefined) =>
|
|
2157
|
+
error instanceof TlaUnassignedError && version !== "1.7.4"
|
|
2158
|
+
? new TlaEvaluationError(
|
|
2159
|
+
`The action formula A appearing in a WF_v(A) or SF_v(A) operator does not specify the primed value of the variable ${error.variable} occurring in the state formula v.\n`,
|
|
2160
|
+
)
|
|
2161
|
+
: error;
|
|
2162
|
+
|
|
2163
|
+
export const createPrimeOutsideActionError = (expression: Expression) =>
|
|
2164
|
+
new TlaEvaluationError(
|
|
2165
|
+
`A primed expression appears outside an action at ${describeLocation(expression)}`,
|
|
1639
2166
|
);
|
|
2167
|
+
|
|
2168
|
+
const compileRecord = (recordFields: RecordField[], environment: Environment): Evaluator => {
|
|
2169
|
+
const fields = getSortedFields(recordFields);
|
|
2170
|
+
const hasDuplicates = hasDuplicateFields(fields);
|
|
1640
2171
|
const values = fields.map((field) => getEvaluator(field.value, environment));
|
|
1641
2172
|
if (hasDuplicates) {
|
|
1642
2173
|
return (context) =>
|
|
1643
|
-
|
|
1644
|
-
fields.map((field, index): [
|
|
2174
|
+
createRecord(
|
|
2175
|
+
fields.map((field, index): [string, Value] => [field.name, values[index](context)]),
|
|
1645
2176
|
);
|
|
1646
2177
|
}
|
|
1647
2178
|
const names = fields.map((field) => field.name);
|
|
@@ -1655,7 +2186,7 @@ const compileRecord = (recordFields: RecordField[], environment: Environment): E
|
|
|
1655
2186
|
);
|
|
1656
2187
|
}
|
|
1657
2188
|
return (context) =>
|
|
1658
|
-
|
|
2189
|
+
createSortedRecord(
|
|
1659
2190
|
names,
|
|
1660
2191
|
values.map((value) => value(context)),
|
|
1661
2192
|
);
|
|
@@ -1684,6 +2215,12 @@ const compile = (expression: Expression, environment: Environment): Evaluator =>
|
|
|
1684
2215
|
return compileIdentifier(expression, environment);
|
|
1685
2216
|
case "Apply":
|
|
1686
2217
|
return compileApply(expression, environment);
|
|
2218
|
+
case "Bracket":
|
|
2219
|
+
return () => {
|
|
2220
|
+
throw new TlaEvaluationError(
|
|
2221
|
+
`A bracket without a function or subscript is not an expression at ${describeLocation(expression)}`,
|
|
2222
|
+
);
|
|
2223
|
+
};
|
|
1687
2224
|
case "OperatorReference":
|
|
1688
2225
|
case "Lambda":
|
|
1689
2226
|
return () => {
|
|
@@ -1696,7 +2233,7 @@ const compile = (expression: Expression, environment: Environment): Evaluator =>
|
|
|
1696
2233
|
return (context) => {
|
|
1697
2234
|
for (let index = 0; index < operands.length; index++) {
|
|
1698
2235
|
const value = operands[index](context);
|
|
1699
|
-
if (typeof value !== "boolean") throw
|
|
2236
|
+
if (typeof value !== "boolean") throw getJunctionError(expression, index, value);
|
|
1700
2237
|
if (!value) return false;
|
|
1701
2238
|
}
|
|
1702
2239
|
return true;
|
|
@@ -1706,7 +2243,9 @@ const compile = (expression: Expression, environment: Environment): Evaluator =>
|
|
|
1706
2243
|
const operands = expression.operands.map(child);
|
|
1707
2244
|
return (context) => {
|
|
1708
2245
|
for (let index = 0; index < operands.length; index++) {
|
|
1709
|
-
|
|
2246
|
+
const value = operands[index](context);
|
|
2247
|
+
if (typeof value !== "boolean") throw getJunctionError(expression, index, value);
|
|
2248
|
+
if (value) return true;
|
|
1710
2249
|
}
|
|
1711
2250
|
return false;
|
|
1712
2251
|
};
|
|
@@ -1714,16 +2253,13 @@ const compile = (expression: Expression, environment: Environment): Evaluator =>
|
|
|
1714
2253
|
case "Prime": {
|
|
1715
2254
|
const inner = child(expression.expression);
|
|
1716
2255
|
return (context) => {
|
|
1717
|
-
if (!context.next)
|
|
1718
|
-
throw new TlaEvaluationError(
|
|
1719
|
-
`A primed expression appears outside an action at ${describeLocation(expression)}`,
|
|
1720
|
-
);
|
|
1721
|
-
}
|
|
2256
|
+
if (!context.next) throw createPrimeOutsideActionError(expression);
|
|
1722
2257
|
return inner({
|
|
1723
2258
|
environment: context.environment,
|
|
1724
2259
|
scope: context.scope,
|
|
1725
2260
|
state: context.next,
|
|
1726
2261
|
next: undefined,
|
|
2262
|
+
isKeepLazy: context.isKeepLazy,
|
|
1727
2263
|
});
|
|
1728
2264
|
};
|
|
1729
2265
|
}
|
|
@@ -1748,16 +2284,25 @@ const compile = (expression: Expression, environment: Environment): Evaluator =>
|
|
|
1748
2284
|
}
|
|
1749
2285
|
case "Case": {
|
|
1750
2286
|
const arms = expression.arms.map((arm) => ({
|
|
2287
|
+
source: arm.condition,
|
|
1751
2288
|
condition: child(arm.condition),
|
|
1752
2289
|
body: child(arm.body),
|
|
1753
2290
|
}));
|
|
1754
2291
|
const other = expression.other ? child(expression.other) : undefined;
|
|
1755
2292
|
return (context) => {
|
|
1756
2293
|
for (const arm of arms) {
|
|
1757
|
-
|
|
2294
|
+
const value = arm.condition(context);
|
|
2295
|
+
if (typeof value !== "boolean") {
|
|
2296
|
+
throw new TlaEvaluationError(
|
|
2297
|
+
`A non-boolean expression (${getKindString(value)}) was used as a condition of a CASE. ${describeNode(arm.source)}`,
|
|
2298
|
+
);
|
|
2299
|
+
}
|
|
2300
|
+
if (value) return arm.body(context);
|
|
1758
2301
|
}
|
|
1759
2302
|
if (other) return other(context);
|
|
1760
|
-
throw new TlaEvaluationError(
|
|
2303
|
+
throw new TlaEvaluationError(
|
|
2304
|
+
`Attempted to evaluate a CASE with no conditions true.\n${describeRange(expression)}`,
|
|
2305
|
+
);
|
|
1761
2306
|
};
|
|
1762
2307
|
}
|
|
1763
2308
|
case "Let": {
|
|
@@ -1796,9 +2341,7 @@ const compile = (expression: Expression, environment: Environment): Evaluator =>
|
|
|
1796
2341
|
case "Record":
|
|
1797
2342
|
return compileRecord(expression.fields, environment);
|
|
1798
2343
|
case "RecordSet": {
|
|
1799
|
-
const fields =
|
|
1800
|
-
compareValues(left.name, right.name),
|
|
1801
|
-
);
|
|
2344
|
+
const fields = getSortedFields(expression.fields);
|
|
1802
2345
|
const names = fields.map((field) => field.name);
|
|
1803
2346
|
const sets = fields.map((field) => child(field.value));
|
|
1804
2347
|
return (context) => ({ kind: "RecordSet", names, sets: sets.map((set) => set(context)) });
|
|
@@ -1817,20 +2360,27 @@ const compile = (expression: Expression, environment: Environment): Evaluator =>
|
|
|
1817
2360
|
};
|
|
1818
2361
|
case "FunctionApplication": {
|
|
1819
2362
|
keepLazy(expression.function);
|
|
1820
|
-
const
|
|
2363
|
+
const evaluated = child(expression.function);
|
|
2364
|
+
const evaluateFunction = (context: Context) =>
|
|
2365
|
+
expectFunction(evaluated(toKeepLazyContext(context)), expression);
|
|
1821
2366
|
const args = expression.args.map(child);
|
|
2367
|
+
const describeMissing = getMissingArgumentDescriber(environment.runtime.version);
|
|
1822
2368
|
if (args.length === 1) {
|
|
1823
2369
|
const argument = args[0];
|
|
1824
|
-
return (context) =>
|
|
2370
|
+
return (context) =>
|
|
2371
|
+
applyFunction(evaluateFunction(context), argument(context), describeMissing);
|
|
1825
2372
|
}
|
|
1826
2373
|
return (context) =>
|
|
1827
|
-
applyFunction(
|
|
2374
|
+
applyFunction(
|
|
2375
|
+
evaluateFunction(context),
|
|
2376
|
+
createTuple(args.map((arg) => arg(context))),
|
|
2377
|
+
describeMissing,
|
|
2378
|
+
);
|
|
1828
2379
|
}
|
|
1829
2380
|
case "FieldAccess": {
|
|
1830
2381
|
const record = child(expression.record);
|
|
1831
|
-
const
|
|
1832
|
-
|
|
1833
|
-
return (context) => applyFunction(record(context), field, describeMissing);
|
|
2382
|
+
const select = getFieldSelector(expression);
|
|
2383
|
+
return (context) => select(record(context));
|
|
1834
2384
|
}
|
|
1835
2385
|
case "Product": {
|
|
1836
2386
|
const factors = expression.factors.map(child);
|