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
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
use super::*;
use crate::register::Register;
use std::borrow::Borrow;
use std::cmp::max;
use std::collections::HashMap;
use std::hash::Hash;

#[derive(Clone, Debug, Eq, PartialEq)]
struct SubRegister<Tag, CL>
where
    Tag: TagT,
    CL: CausalLength,
{
    tag: Tag,
    length: CL,
}

/// Causal Length Set
///
/// Set implements the set described in the paper, with the addition of a tag. Set only uses the
/// tag for garbage collection of old removed members.
#[derive(Clone, Debug, Default, PartialEq, Eq)]
pub struct Set<T, Tag, CL>
where
    T: Key,
    Tag: TagT,
    CL: CausalLength,
{
    // HashMap, because the "set" needs to allow mutating the tag and causal length.
    map: HashMap<T, SubRegister<Tag, CL>>,
}

impl<T, Tag, CL> Set<T, Tag, CL>
where
    T: Key,
    Tag: TagT,
    CL: CausalLength,
{
    /// Create a new empty `Set`
    pub fn new() -> Set<T, Tag, CL> {
        Set {
            map: HashMap::new(),
        }
    }

    /// Returns `None` if `member` is not present in the set. If present returns `Some(Tag)`
    pub fn get<Q>(&self, member: Q) -> Option<Tag>
    where
        Q: Borrow<T>,
    {
        if let Some(e) = self.map.get(member.borrow()).to_owned() {
            if e.length.is_odd() {
                return Some(e.tag);
            }
        }
        None
    }

    /// Returns true if the set contains a value.
    pub fn contains<Q>(&self, member: Q) -> bool
    where
        Q: Borrow<T>,
    {
        self.get(member).is_some()
    }

    /// Add a value to a set.
    pub fn add(&mut self, member: T, tag: Tag) {
        let one: CL = CL::one();
        let mut e = self
            .map
            .entry(member)
            .or_insert(SubRegister { tag, length: one });
        // s{e |-> s(e)+1} if even
        //s if odd s(e)
        if e.length.is_even() {
            e.length = e.length + one;
        }
        // always use the max value of tag
        e.tag = max(e.tag, tag);
    }

    /// Removes a value from the set.
    pub fn remove(&mut self, member: T, tag: Tag) {
        self.map.entry(member).and_modify(|e| {
            // {} if even(s(e))
            // { e |-> s(e) + 1 } if odd(s(e))
            if e.length.is_odd() {
                e.length = e.length + CL::one()
            }
            e.tag = max(e.tag, tag);
        });
        // ignore attempts to remove items that aren't present...
    }

    /// An iterator visiting all elements and tags in arbitrary order.
    pub fn iter(&self) -> impl Iterator<Item = (&T, Tag)> + '_ {
        self.map
            .iter()
            .filter(|(_k, v)| v.length.is_odd())
            .map(|(k, v)| (k, v.tag))
    }

    /// An iterator visiting all registers in arbitrary order.
    pub fn register_iter(&self) -> impl Iterator<Item = Register<T, Tag, CL>> + '_ {
        self.map.iter().map(|(k, v)| Register {
            item: k.clone(),
            tag: v.tag,
            length: v.length,
        })
    }

    /// Merge a delta [Register] into a set.
    ///
    /// Remove registers with a tag value less than `min_tag` will be ignored.
    pub fn merge_register(&mut self, delta: Register<T, Tag, CL>, min_tag: Tag) {
        if delta.length.is_even() && delta.tag < min_tag {
            // ignore excessively old remove records
            return;
        }
        let Register { item, tag, length } = delta;
        match self.map.entry(item) {
            Entry::Occupied(mut e) => {
                let e = e.get_mut();
                // (s⊔s′)(e) = max(s(e),s′(e))
                e.tag = max(e.tag, tag);
                e.length = max(e.length, length);
            }
            Entry::Vacant(e) => {
                e.insert(SubRegister { tag, length });
            }
        }
    }

    /// Merge two sets.
    ///
    /// Remove deltas with a tag value less than `min_tag` will be ignored.
    pub fn merge(&mut self, other: &Self, min_tag: Tag) {
        for delta in other.register_iter() {
            self.merge_register(delta, min_tag);
        }
    }

    /// Filter out old remove tombstone deltas from the set.
    ///
    /// Remove deltas with a tag value less than `min_tag` will be removed.
    pub fn retain(&mut self, min_tag: Tag) {
        self.map
            .retain(|_k, SubRegister { tag, length }| length.is_odd() || min_tag < *tag);
    }
}

#[cfg(feature = "serialization")]
mod serialization {
    use super::*;
    use serde::de::{SeqAccess, Visitor};
    use serde::ser::SerializeSeq;
    use serde::{Deserialize, Deserializer, Serialize, Serializer};
    use std::fmt::Formatter;
    use std::marker::PhantomData;

    impl<T, Tag, CL> Serialize for Set<T, Tag, CL>
    where
        T: Key + Serialize,
        Tag: TagT + Serialize,
        CL: CausalLength + Serialize,
    {
        fn serialize<S>(&self, serializer: S) -> std::result::Result<S::Ok, S::Error>
        where
            S: Serializer,
        {
            let mut seq = serializer.serialize_seq(Some(self.map.len()))?;
            for member in self.register_iter() {
                seq.serialize_element(&(member.item, member.tag, member.length))?;
            }
            seq.end()
        }
    }

    struct DeltaVisitor<T, Tag, CL>(PhantomData<T>, PhantomData<Tag>, PhantomData<CL>);

    impl<'de, T, Tag, CL> Visitor<'de> for DeltaVisitor<T, Tag, CL>
    where
        T: Key + Deserialize<'de>,
        Tag: TagT + Deserialize<'de>,
        CL: CausalLength + Deserialize<'de>,
    {
        type Value = HashMap<T, SubRegister<Tag, CL>>;

        fn expecting(&self, formatter: &mut Formatter<'_>) -> std::fmt::Result {
            formatter.write_str("a tuple of key, value, tag, and causal length")
        }

        fn visit_seq<A>(self, mut seq: A) -> std::result::Result<Self::Value, A::Error>
        where
            A: SeqAccess<'de>,
        {
            let mut map: HashMap<T, SubRegister<Tag, CL>> =
                HashMap::with_capacity(seq.size_hint().unwrap_or(0));
            while let Some(d) = seq.next_element::<(T, Tag, CL)>()? {
                map.insert(
                    d.0,
                    SubRegister {
                        tag: d.1,
                        length: d.2,
                    },
                );
            }
            Ok(map)
        }
    }

    impl<'de, T, Tag, CL> Deserialize<'de> for Set<T, Tag, CL>
    where
        T: Eq + Hash + Clone + Deserialize<'de>,
        Tag: TagT + Deserialize<'de>,
        CL: CausalLength + Deserialize<'de>,
    {
        fn deserialize<D>(deserializer: D) -> std::result::Result<Self, D::Error>
        where
            D: Deserializer<'de>,
        {
            let visitor = DeltaVisitor::<T, Tag, CL>(PhantomData, PhantomData, PhantomData);
            let map = deserializer.deserialize_seq(visitor)?;

            Ok(Set { map })
        }
    }
}

#[cfg(feature = "serialization")]
pub use serialization::*;
use std::collections::hash_map::Entry;

#[cfg(test)]
mod tests {
    use super::*;
    use quickcheck_macros::quickcheck;
    use rand::seq::SliceRandom;

    #[test]
    fn test_add() {
        let later_time = 1;
        let mut cls: Set<&str, u32, u16> = Set::new();

        cls.add("foo", later_time);
        cls.add("foo", later_time);
        cls.add("foo", later_time);
        assert_eq!(cls.map.len(), 1);
        assert_eq!(
            cls.map.get("foo"),
            Some(&SubRegister {
                tag: later_time,
                length: 1
            })
        );
        assert_eq!(cls.contains("foo"), true);
        assert_eq!(cls.get("bar"), None);
    }

    #[test]
    fn test_remove() {
        let time_1 = 1;
        let time_2 = 2;
        let time_3 = 3;
        let mut cls: Set<&str, u32, u16> = Set::new();

        cls.add("foo", time_1);
        cls.add("bar", time_1);
        cls.remove("foo", time_2);
        cls.remove("bar", time_2);
        cls.add("bar", time_3);
        // check map
        assert_eq!(cls.map.len(), 2);
        assert_eq!(
            cls.map.get(&"bar"),
            Some(&SubRegister {
                tag: time_3,
                length: 3
            })
        );
        assert_eq!(
            cls.map.get(&"foo"),
            Some(&SubRegister {
                tag: time_2,
                length: 2
            })
        );
        // check edges
        let values: Vec<(&&str, u32)> = cls.iter().collect();
        assert_eq!(values.len(), 1);
        assert_eq!(values[0], (&"bar", time_3));
    }

    #[test]
    fn test_merge() {
        let time_0 = 0;
        let time_1 = 1;
        let time_2 = 2;
        let time_3 = 3;
        let mut cls1: Set<&str, u32, u16> = Set::new();
        let mut cls2: Set<&str, u32, u16> = Set::new();

        cls1.add("foo", time_1);
        cls1.add("bar", time_1);
        cls2.merge(&cls1, time_0);
        cls2.remove("foo", time_2);
        cls1.remove("bar", time_2);
        cls1.remove("bar", time_2);
        cls2.merge(&cls1, time_0);
        cls2.add("bar", time_3);
        // check map
        assert_eq!(cls2.map.len(), 2);
        assert_eq!(
            cls2.map.get(&"bar"),
            Some(&SubRegister {
                tag: time_3,
                length: 3
            })
        );
        assert_eq!(
            cls2.map.get(&"foo"),
            Some(&SubRegister {
                tag: time_2,
                length: 2
            })
        );
        // check edges
        let values: Vec<(&&str, u32)> = cls2.iter().collect();
        assert_eq!(values.len(), 1);
        assert_eq!(values[0], (&"bar", time_3));
    }

    #[test]
    fn test_retain() {
        let time_0 = 0;
        let time_1 = 1;
        let time_2 = 2;
        let time_3 = 3;
        let mut cls: Set<&str, u32, u16> = Set::new();

        cls.add("foo", time_0);
        cls.add("bar", time_0);
        cls.remove("foo", time_1);
        cls.remove("bar", time_1);
        cls.add("bar", time_2);
        // check map
        assert_eq!(cls.map.len(), 2);
        assert_eq!(
            cls.map.get(&"bar"),
            Some(&SubRegister {
                tag: time_2,
                length: 3
            })
        );
        assert_eq!(
            cls.map.get(&"foo"),
            Some(&SubRegister {
                tag: time_1,
                length: 2
            })
        );
        // check edges
        let values: Vec<(&&str, u32)> = cls.iter().collect();
        assert_eq!(values.len(), 1);
        assert_eq!(values[0], (&"bar", time_2));
        // now clear old removes
        cls.retain(time_3);
        assert_eq!(cls.map.len(), 1);
        assert_eq!(
            cls.map.get(&"bar"),
            Some(&SubRegister {
                tag: time_2,
                length: 3
            })
        );
        // attempt to merge an out of date remove
        cls.merge_register(
            Register {
                item: &"bar",
                tag: time_2,
                length: 2,
            },
            time_0,
        );
        assert_eq!(cls.map.len(), 1);
        assert_eq!(
            cls.map.get(&"bar"),
            Some(&SubRegister {
                tag: time_2,
                length: 3
            })
        );
    }

    #[cfg(feature = "serialization")]
    #[test]
    fn test_serialization() {
        let time_1 = 1;
        let time_2 = 2;
        let time_3 = 3;
        let mut cls: Set<&str, u32, u16> = Set::new();

        cls.add("foo", time_1);
        cls.add("bar", time_1);
        cls.remove("foo", time_2);
        cls.remove("bar", time_2);
        cls.add("bar", time_3);

        let data = serde_json::to_vec(&cls).unwrap();
        let cls2: Set<&str, u32, u16> = serde_json::from_slice(&data).unwrap();
        assert_eq!(cls.map, cls2.map);
    }

    #[test]
    fn test_order_independence() {
        let mut m: Set<&str, u32, u16> = Set::new();
        let mut v: Vec<Register<&str, u32, u16>> = vec![];

        for i in 0..1000 {
            v.push(Register {
                item: "foo",
                tag: i as u32,
                length: i as u16,
            });
        }

        // now randomize the updates
        v.shuffle(&mut rand::thread_rng());

        for r in v {
            m.merge_register(r, 0);
        }
        assert_eq!(
            m.map.get("foo"),
            Some(&SubRegister {
                tag: 999,
                length: 999
            })
        );
    }

    fn merge(mut acc: Set<u8, u8, u8>, el: &Register<u8, u8, u8>) -> Set<u8, u8, u8> {
        acc.merge_register(el.clone(), 0);
        acc
    }

    #[quickcheck]
    fn is_merge_commutative(xs: Vec<Register<u8, u8, u8>>) -> bool {
        let left = xs.iter().fold(Set::default(), merge);
        let right = xs.iter().rfold(Set::default(), merge);
        left == right
    }

    #[quickcheck]
    fn is_merge_order_independent(xs: Vec<Register<u8, u8, u8>>) -> bool {
        let mut copy = xs.clone();
        copy.shuffle(&mut rand::thread_rng());
        let left = xs.iter().fold(Set::default(), merge);
        let right = copy.iter().rfold(Set::default(), merge);
        left == right
    }

    use quickcheck::{Arbitrary, Gen};
    #[derive(Clone, Debug)]
    enum Op {
        Insert(u8),
        Get(u8),
        Delete(u8),
    }

    const KEY_SPACE: u8 = 20;

    impl Arbitrary for Op {
        fn arbitrary(g: &mut Gen) -> Op {
            let k: u8 = u8::arbitrary(g) % KEY_SPACE;
            let n: u8 = u8::arbitrary(g) % 4;

            match n {
                0 => Op::Insert(k),
                1 => Op::Delete(k),
                2 | 3 => Op::Get(k),
                _ => Op::Get(k),
            }
        }
    }

    #[quickcheck]
    fn implementation_matches_model(ops: Vec<Op>) -> bool {
        let mut implementation: Set<u8, u8, u8> = Set::new();
        let mut model = std::collections::HashSet::new();

        for op in ops {
            match op {
                Op::Insert(k) => {
                    implementation.add(k, 0);
                    model.insert(k);
                }
                Op::Get(k) => {
                    if implementation.get(&k).is_some() != model.get(&k).is_some() {
                        return false;
                    }
                }
                Op::Delete(k) => {
                    implementation.remove(k, 0);
                    model.remove(&k);
                }
            }
        }

        true
    }
}