dive-core 0.1.0

The dive execution core for TLA+: value store, plan compiler, interpreter and successor generation
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
//! Bounded symbolic finiteness and Product cardinality. Source: tlaplus value
//! isFinite/isEmpty/size methods, Sequences.isFinite and Nat/Int overrides,
//! 94d0c50.

use super::Machine;
use crate::node::Kind;
use crate::{Error, Handle};

fn refused() -> Error {
    Error::unsupported("Cardinality/IsFiniteSet of a Product with an unproved factor shape or size")
}

fn bounded(n: u64) -> Result<u64, Error> {
    if i32::try_from(n).is_ok() {
        Ok(n)
    } else {
        Err(refused())
    }
}

impl Machine {
    /// Whether an empty factor may decide finiteness before later factors
    /// are proved. TLC's `isFinite` stops at the first empty factor it meets,
    /// so a later non-set factor answers TRUE or fails by encounter order.
    /// Product and function-set operands are met in source order in both
    /// profiles, the order TLC uses, and the goldens pin those answers
    /// (`IsFiniteSet({} \X 0)` is TRUE). Record fields are met in TLC's
    /// intern order only under token string order; canonical field order
    /// would make `[a : {}, b : 0]` answer TRUE where TLC may fail, so there
    /// every field is proved first and an unproved one refuses.
    fn source_factor_order(&self, kind: Kind) -> bool {
        kind != Kind::RecSet
            || self.heap.store().semantics().string_order == crate::strings::StringOrder::Token
    }

    pub(super) fn symbolic_finiteness(&mut self, h: Handle) -> Result<bool, Error> {
        if matches!(
            self.heap.kind(h),
            Some(
                Kind::Product
                    | Kind::Subset
                    | Kind::FcnSet
                    | Kind::RecSet
                    | Kind::SeqSet
                    | Kind::Union
            )
        ) {
            self.factor_finiteness(h, 0)
        } else {
            self.charge(1)?;
            Ok(self.heap.is_finite(h))
        }
    }

    /// Mathematical Boolean finiteness, distinct from complete finite size admission.
    /// Known infinite factors never turn an unknown operand into a false answer.
    fn factor_finiteness(&mut self, h: Handle, depth: u8) -> Result<bool, Error> {
        self.charge(1)?;
        if depth >= 64 || !h.is_compound() || self.heap.is_lazy(h) {
            return Err(refused());
        }
        let view = self.heap.view(h);
        let (kind, len) = (view.kind, view.data.len());
        match kind {
            Kind::Nat | Kind::Int if len == 0 => Ok(false),
            Kind::Subset if len == 1 => {
                let base = view.data[0];
                self.factor_finiteness(base, depth + 1)
            }
            Kind::Union if len == 2 => {
                let left = view.data[0];
                let right = view.data[1];
                let left_finite = self.factor_finiteness(left, depth + 1)?;
                let right_finite = self.factor_finiteness(right, depth + 1)?;
                Ok(left_finite && right_finite)
            }
            Kind::SeqSet if len == 1 => {
                let range = view.data[0];
                if !self.factor_finiteness(range, depth + 1)? {
                    return Ok(false);
                }
                self.finite_empty(range, depth + 1)
            }
            Kind::Product | Kind::RecSet
                if (kind == Kind::Product && len >= 2)
                    || (kind == Kind::RecSet && len.is_multiple_of(2)) =>
            {
                let tlc_order = self.source_factor_order(kind);
                let (mut all_finite, mut any_empty) = (true, false);
                let start = if kind == Kind::RecSet { len / 2 } else { 0 };
                for index in start..len {
                    let child = self.heap.view(h).data[index];
                    if self.factor_finiteness(child, depth + 1)? {
                        if !any_empty && self.finite_empty(child, depth + 1)? {
                            if tlc_order {
                                return Ok(true);
                            }
                            any_empty = true;
                        }
                    } else {
                        all_finite = false;
                    }
                }
                Ok(any_empty || all_finite)
            }
            Kind::FcnSet if len == 2 => {
                let (domain, range) = (view.data[0], view.data[1]);
                let finite_domain = self.factor_finiteness(domain, depth + 1)?;
                if finite_domain && self.finite_empty(domain, depth + 1)? {
                    return Ok(true);
                }
                let finite_range = self.factor_finiteness(range, depth + 1)?;
                if finite_range && self.finite_empty(range, depth + 1)? {
                    return Ok(true);
                }
                if finite_domain && finite_range {
                    return Ok(true);
                }
                Ok(finite_range && self.finite_size(range, depth + 1)? == 1)
            }
            _ if self.finite_factor(h, depth)? => Ok(true),
            _ => Err(refused()),
        }
    }

    pub(super) fn finite_product(&mut self, h: Handle) -> Result<(), Error> {
        if self.finite_factor(h, 0)? {
            Ok(())
        } else {
            Err(refused())
        }
    }

    /// Complete read-only admission: every constructor operand must itself be
    /// admitted. No scalar, infinite, deferred or unknown operand is guessed.
    fn finite_factor(&mut self, h: Handle, depth: u8) -> Result<bool, Error> {
        self.charge(1)?;
        if depth >= 64 || !h.is_compound() || self.heap.is_lazy(h) {
            return Ok(false);
        }
        let view = self.heap.view(h);
        let (kind, lo, len) = (view.kind, view.lo, view.data.len());
        match kind {
            Kind::Set | Kind::SetEnum => Ok(true),
            Kind::Interval => Ok(view
                .data
                .first()
                .and_then(|v| v.as_int())
                .is_some_and(|hi| {
                    hi < lo
                        || hi
                            .checked_sub(lo)
                            .and_then(|n| n.checked_add(1))
                            .is_some_and(|n| n <= i64::from(i32::MAX))
                })),
            Kind::Subset | Kind::FcnSet | Kind::Product | Kind::RecSet => {
                let valid = match kind {
                    Kind::Subset => len == 1,
                    Kind::FcnSet => len == 2,
                    Kind::Product => len >= 2,
                    Kind::RecSet => len.is_multiple_of(2),
                    _ => false,
                };
                if !valid {
                    return Ok(false);
                }
                let start = if kind == Kind::RecSet { len / 2 } else { 0 };
                for index in start..len {
                    let child = self.heap.view(h).data[index];
                    if !self.finite_factor(child, depth + 1)? {
                        return Ok(false);
                    }
                }
                Ok(true)
            }
            _ => Ok(false),
        }
    }

    /// Source emptiness for known shapes, refusing any demanded unknown shape.
    /// Explicit storage is counted without normalization; short circuits match TLC.
    fn finite_empty(&mut self, h: Handle, depth: u8) -> Result<bool, Error> {
        self.charge(1)?;
        if depth >= 64 {
            return Err(refused());
        }
        let view = self.heap.view(h);
        let (kind, lo, len) = (view.kind, view.lo, view.data.len());
        match kind {
            Kind::Nat | Kind::Int if len == 0 => Ok(false),
            Kind::Set | Kind::SetEnum => Ok(len == 0),
            Kind::Interval => Ok(view
                .data
                .first()
                .and_then(|v| v.as_int())
                .ok_or_else(refused)?
                < lo),
            Kind::Subset | Kind::SeqSet => Ok(false),
            Kind::FcnSet => {
                let (domain, range) = (view.data[0], view.data[1]);
                Ok(
                    !self.finite_empty(domain, depth + 1)?
                        && self.finite_empty(range, depth + 1)?,
                )
            }
            Kind::Product | Kind::RecSet => {
                let start = if kind == Kind::RecSet { len / 2 } else { 0 };
                for index in start..len {
                    let child = self.heap.view(h).data[index];
                    if self.finite_empty(child, depth + 1)? {
                        return Ok(true);
                    }
                }
                Ok(false)
            }
            _ => Err(refused()),
        }
    }

    pub(super) fn product_cardinality(&mut self, h: Handle) -> Result<Handle, Error> {
        self.finite_product(h)?;
        let size = self.finite_size(h, 0)?;
        Handle::int(i64::try_from(size).map_err(|_| refused())?).ok_or_else(refused)
    }

    /// Source `size()` demand order, retaining the original Product. Only actual
    /// explicit-set size demands normalize owned axes; no Product is interned.
    fn finite_size(&mut self, h: Handle, depth: u8) -> Result<u64, Error> {
        self.charge(1)?;
        if depth >= 64 {
            return Err(refused());
        }
        let view = self.heap.view(h);
        let (kind, len) = (view.kind, view.data.len());
        match kind {
            Kind::Set | Kind::SetEnum | Kind::Interval => bounded(self.work_cardinality(h)?),
            Kind::Subset => {
                let base = view.data[0];
                let size = self.finite_size(base, depth + 1)?;
                if size >= 31 {
                    return Err(refused());
                }
                Ok(1u64 << size)
            }
            Kind::FcnSet => {
                let (domain, range) = (view.data[0], view.data[1]);
                if self.finite_empty(domain, depth + 1)? {
                    return Ok(1);
                }
                if self.finite_empty(range, depth + 1)? {
                    return Ok(0);
                }
                if self.finite_size(range, depth + 1)? == 1 {
                    return Ok(1);
                }
                let domain_size = self.finite_size(domain, depth + 1)?;
                let range_size = self.finite_size(range, depth + 1)?;
                let power = u32::try_from(domain_size).map_err(|_| refused())?;
                bounded(range_size.checked_pow(power).ok_or_else(refused)?)
            }
            Kind::Product | Kind::RecSet => {
                if self.finite_empty(h, depth)? {
                    return Ok(0);
                }
                let mut size = 1u64;
                let start = if kind == Kind::RecSet { len / 2 } else { 0 };
                for index in start..len {
                    let child = self.heap.view(h).data[index];
                    let child_size = self.finite_size(child, depth + 1)?;
                    size = bounded(size.checked_mul(child_size).ok_or_else(refused)?)?;
                }
                Ok(size)
            }
            _ => Err(refused()),
        }
    }
}

#[cfg(test)]
mod tests {
    #![allow(clippy::unwrap_used, reason = "closed test values")]
    use super::*;
    use crate::{Opts, Semantics, Store, memo::Memo};
    use std::sync::Arc;

    #[test]
    fn sequence_finiteness_keeps_empty_infinite_unknown_and_stop_cases() {
        for semantics in [Semantics::default(), Semantics::tlc()] {
            let mut m = Machine::new(
                Arc::new(Store::with_semantics(true, semantics)),
                0,
                Opts::default(),
                Memo::new(&[]),
            );
            let zero = Handle::int(0).unwrap();
            let raw = m.heap.set_from(&mut vec![zero, Handle::TRUE]);
            let empty = m.heap.interval(1, 0);
            let product = m.heap.symbolic(Kind::Product, 0, &[empty, raw]);
            let sequences = m.heap.symbolic(Kind::SeqSet, 0, &[product]);
            assert_eq!(m.symbolic_finiteness(sequences), Ok(true));

            assert_eq!(m.heap.view(sequences).data, &[product]);
            assert_eq!(m.heap.view(product).data, &[empty, raw]);
            let subset = m.heap.symbolic(Kind::Subset, 0, &[sequences]);
            assert_eq!(m.symbolic_finiteness(subset), Ok(true));
            let outer_sequences = m.heap.symbolic(Kind::SeqSet, 0, &[sequences]);
            assert_eq!(m.symbolic_finiteness(outer_sequences), Ok(false));
            let finite_union = m.heap.symbolic(Kind::Union, 0, &[sequences, empty]);
            assert_eq!(m.symbolic_finiteness(finite_union), Ok(true));
            let unknown = m.heap.symbolic(Kind::Union, 0, &[sequences, zero]);
            let error = m.symbolic_finiteness(unknown).unwrap_err();
            assert_eq!(error.kind(), crate::ErrorKind::Unsupported);
            assert!(error.message().contains("unproved factor"));
            let nonempty = m.heap.interval(0, 0);
            let malformed = m.heap.symbolic(Kind::Product, 0, &[nonempty, zero]);
            let malformed_sequences = m.heap.symbolic(Kind::SeqSet, 0, &[malformed]);
            assert!(m.symbolic_finiteness(malformed_sequences).is_err());

            assert_eq!(m.work_cardinality(raw), Ok(2));
            m.set_fuel(0);
            assert!(m.symbolic_finiteness(sequences).is_err());
            assert!(!m.heap.poisoned());
        }
    }

    #[test]
    fn finite_product_cardinality_accepts_canonical_mixed_axes() {
        for semantics in [Semantics::default(), Semantics::tlc()] {
            let mut m = Machine::new(
                Arc::new(Store::with_semantics(true, semantics)),
                0,
                Opts::default(),
                Memo::new(&[]),
            );
            let zero = Handle::int(0).unwrap();
            let one = Handle::int(1).unwrap();
            let raw = m.heap.set_from(&mut vec![one, zero, one]);
            let axis = m.heap.interval(0, 0);
            let product = m.heap.symbolic(Kind::Product, 0, &[raw, axis]);
            m.finite_product(product).unwrap();

            assert_eq!(m.product_cardinality(product).unwrap().as_int(), Some(2));

            assert_eq!(m.heap.kind(product), Some(Kind::Product));
            assert!(m.member(zero, product).is_err());
            let mixed = m.heap.set_from(&mut vec![zero, Handle::TRUE]);
            let empty = m.heap.empty_set();
            let functions = m.heap.symbolic(Kind::FcnSet, 0, &[empty, mixed]);
            let skipped = m.heap.symbolic(Kind::Product, 0, &[functions, axis]);
            assert_eq!(m.product_cardinality(skipped).unwrap().as_int(), Some(1));

            let demanded = m.heap.symbolic(Kind::Product, 0, &[mixed, axis]);
            assert_eq!(m.product_cardinality(demanded).unwrap().as_int(), Some(2));
            assert!(!m.heap.poisoned());
        }
    }

    #[test]
    fn incomplete_factor_trees_and_exhausted_work_never_answer() {
        let mut m = Machine::new(
            Arc::new(Store::default()),
            0,
            Opts::default(),
            Memo::new(&[]),
        );
        let zero = Handle::int(0).unwrap();
        let axis = m.heap.interval(0, 1);
        let invalid = m.heap.symbolic(Kind::Product, 0, &[axis, zero]);
        assert!(m.finite_product(invalid).is_err());
        let valid = m.heap.symbolic(Kind::Product, 0, &[axis, axis]);
        m.set_fuel(0);
        assert!(m.finite_product(valid).is_err());
        assert!(m.product_cardinality(valid).is_err());
        assert!(!m.heap.poisoned());
    }

    #[test]
    fn source_order_factors_keep_the_empty_first_answer_in_both_profiles() {
        for semantics in [Semantics::default(), Semantics::tlc()] {
            let mut m = Machine::new(
                Arc::new(Store::with_semantics(true, semantics)),
                0,
                Opts::default(),
                Memo::new(&[]),
            );
            let zero = Handle::int(0).unwrap();
            let empty = m.heap.empty_set();
            let empty_first = m.heap.symbolic(Kind::Product, 0, &[empty, zero]);
            let functions = m.heap.symbolic(Kind::FcnSet, 0, &[empty, zero]);
            assert_eq!(m.symbolic_finiteness(empty_first), Ok(true));
            assert_eq!(m.symbolic_finiteness(functions), Ok(true));
            let scalar_first = m.heap.symbolic(Kind::Product, 0, &[zero, empty]);
            assert!(m.symbolic_finiteness(scalar_first).is_err());
            assert!(!m.heap.poisoned());
        }
    }

    #[test]
    fn boolean_finiteness_keeps_unknown_factor_refusals() {
        for semantics in [Semantics::default(), Semantics::tlc()] {
            let mut m = Machine::new(
                Arc::new(Store::with_semantics(true, semantics)),
                0,
                Opts::default(),
                Memo::new(&[]),
            );
            let zero = Handle::int(0).unwrap();
            let raw = m.heap.set_from(&mut vec![zero, Handle::TRUE]);
            let empty = m.heap.empty_set();
            for kind in [Kind::Nat, Kind::Int] {
                let infinite = m.heap.symbolic(kind, 0, &[]);
                for axes in [[infinite, raw], [raw, infinite]] {
                    let product = m.heap.symbolic(Kind::Product, 0, &axes);
                    assert!(!m.symbolic_finiteness(product).unwrap());
                    assert_eq!(m.heap.kind(product), Some(Kind::Product));

                    assert!(m.product_cardinality(product).is_err());
                }
                let nested = m.heap.symbolic(Kind::Product, 0, &[infinite, empty]);
                let outer = m.heap.symbolic(Kind::Product, 0, &[nested, raw]);
                assert!(m.symbolic_finiteness(outer).unwrap());
                for axes in [[infinite, zero], [zero, infinite]] {
                    let invalid = m.heap.symbolic(Kind::Product, 0, &axes);
                    assert!(m.symbolic_finiteness(invalid).is_err());
                }
                let invalid = m.heap.symbolic(kind, 0, &[zero]);
                let product = m.heap.symbolic(Kind::Product, 0, &[raw, invalid]);
                assert!(m.symbolic_finiteness(product).is_err());
            }
            assert!(!m.heap.poisoned());
        }
    }
}