rust-cc 0.6.2

A cycle collector for Rust programs
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
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
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
use std::alloc::Layout;
use std::panic::{AssertUnwindSafe, catch_unwind};
use std::ptr::NonNull;

use test_case::{test_case, test_matrix};

use crate::{CcBox, Mark};
use crate::counter_marker::CounterMarker;
use crate::lists::*;
use crate::state::state;
use crate::utils::cc_dealloc;

fn assert_contains(list: &impl ListMethods, mut elements: Vec<i32>) {
    list.iter().for_each(|ptr| {
        // Test contains
        assert!(list.iter().contains(ptr));

        let elem = unsafe { *ptr.cast::<CcBox<i32>>().as_ref().get_elem() };
        let index = elements.iter().position(|&i| i == elem);
        assert!(index.is_some(), "Couldn't find element {} in list.", elem);
        elements.swap_remove(index.unwrap());
    });

    assert!(
        elements.is_empty(),
        "List does not contains: {:?}",
        elements
    );
}

fn new_collection(elements: &[i32], coll: &mut impl CommonMethods) -> Vec<NonNull<CcBox<i32>>> {
    elements
        .iter()
        .map(|&i| CcBox::new_for_tests(i))
        .inspect(|&ptr| coll.add(ptr.cast()))
        .collect()
}

fn deallocate(elements: Vec<NonNull<CcBox<i32>>>) {
    elements.into_iter().for_each(|ptr| unsafe {
        assert!(
            (*ptr.as_ref().get_next()).is_none(),
            "{} has a next",
            *ptr.as_ref().get_elem()
        );
        assert!(
            (*ptr.as_ref().get_prev()).is_none(),
            "{} has a prev",
            *ptr.as_ref().get_elem()
        );
        state(|state| cc_dealloc(ptr, Layout::new::<CcBox<i32>>(), state));
    });
}

fn check_list(list: &impl ListMethods) {
    let mut iter = list.iter();
    let Some(first) = iter.next() else {
        assert!(list.is_empty());
        list.assert_size(0);
        return;
    };
    let mut real_size = 1; // Already got 1 element from the iterator
    unsafe {
        assert_eq!(*first.as_ref().get_prev(), None);
        let mut prev = first;
        for elem in iter {
            real_size += 1;
            assert_eq!(*elem.as_ref().get_prev(), Some(prev));
            prev = elem;
        }
    }
    list.assert_size(real_size);
}

#[test_case(LinkedList::new())]
#[test_case(PossibleCycles::new())]
fn test_new(mut list: impl ListMethods) {
    assert!(list.is_empty());
    list.assert_size(0);
    assert!(list.first().is_none());
    assert!(list.remove_first().is_none());
}

#[test_case(LinkedList::new())]
#[test_case(PossibleCycles::new())]
fn test_add(mut list: impl ListMethods) {
    let vec: Vec<i32> = vec![0, 1, 2];

    assert!(list.is_empty());
    let elements = new_collection(&vec, &mut list);
    assert!(list.first().is_some());

    list.assert_size(vec.len());
    check_list(&list);
    assert_contains(&list, vec);

    drop(list);
    deallocate(elements);
}

#[test_matrix(
    [LinkedList::new(), PossibleCycles::new()],
    [0, 1, 2, 3]
)]
fn test_remove(mut list: impl ListMethods, index: usize) {
    let mut elements = vec![0, 1, 2, 3];
    let vec = new_collection(&elements, &mut list);

    list.assert_size(4);

    let removed = vec[index];
    list.remove(removed.cast());
    let removed_i = elements.swap_remove(index);

    unsafe {
        assert!(
            (*removed.as_ref().get_next()).is_none(),
            "Removed element has still a next."
        );
        assert!(
            (*removed.as_ref().get_prev()).is_none(),
            "Removed element has still a prev."
        );
        assert_eq!(
            *removed.as_ref().get_elem(),
            removed_i,
            "Removed wrong element"
        );
    }

    list.assert_size(3);
    check_list(&list);
    assert_contains(&list, elements);
    drop(list);
    deallocate(vec);
}

#[test_case(LinkedList::new())]
#[test_case(PossibleCycles::new())]
fn test_remove_first(mut list: impl ListMethods) {
    let mut elements = vec![0, 1, 2, 3];
    let vec = new_collection(&elements, &mut list);

    // Mark to test the removal of the mark
    list.iter().for_each(|ptr| unsafe {
        ptr.as_ref().counter_marker().mark(Mark::InList)
    });

    // Iterate over the list to get the elements in the correct order as in the list
    elements = list.iter().map(|ptr| unsafe {
        *ptr.cast::<CcBox<i32>>().as_ref().get_elem()
    }).collect();

    for element in elements {
        let removed = list.remove_first().expect("List has smaller size then expected");

        unsafe {
            assert!(
                (*removed.as_ref().get_next()).is_none(),
                "Removed element has still a next."
            );
            assert!(
                (*removed.as_ref().get_prev()).is_none(),
                "Removed element has still a prev."
            );
            assert_eq!(
                *removed.cast::<CcBox<i32>>().as_ref().get_elem(),
                element,
                "Removed wrong element"
            );
            let cm = removed.as_ref().counter_marker();
            assert!(
                cm.is_not_marked() && !cm.is_in_possible_cycles(),
                "Removed element is still marked"
            );
        }

        check_list(&list);
    }

    list.assert_size(0);
    assert!(list.is_empty());
    drop(list);
    deallocate(vec);
}

#[test]
fn test_for_each_clearing_panic() {
    let mut list = LinkedList::new();
    let mut vec = new_collection(&[0, 1, 2, 3], &mut list);

    for it in &mut vec {
        unsafe {
            it.as_ref().counter_marker().mark(Mark::PossibleCycles); // Just a random mark
        }
    }

    let res = catch_unwind(AssertUnwindSafe(|| list.into_iter().for_each(|ptr| {
        // Manually set mark for the first CcBox, the others should be handled by List::drop
        unsafe { ptr.as_ref().counter_marker().mark(Mark::NonMarked) };

        panic!("into_iter().for_each panic");
    })));

    assert!(res.is_err(), "Hasn't panicked.");

    for it in vec.iter() {
        fn counter_marker(it: &NonNull<CcBox<i32>>) -> &CounterMarker {
            unsafe { it.as_ref().counter_marker() }
        }

        let counter_marker = counter_marker(it);

        assert!(counter_marker.is_not_marked());
        assert!(!counter_marker.is_in_possible_cycles());
    }

    deallocate(vec);
}

#[test_case(LinkedList::new())]
#[test_case(PossibleCycles::new())]
fn test_list_moving(mut list: impl ListMethods) {
    let cc = CcBox::new_for_tests(5i32);
    list.add(cc.cast());

    let list_moved = list;

    list_moved.iter().for_each(|elem| unsafe {
        assert_eq!(*elem.cast::<CcBox<i32>>().as_ref().get_elem(), 5i32);
    });

    drop(list_moved);

    deallocate(vec![cc]);
}

#[cfg(feature = "finalization")]
#[test]
fn test_mark_self_and_append() {
    let mut list = PossibleCycles::new();
    let mut to_append = LinkedList::new();
    let elements: Vec<i32> = vec![0, 1, 2];
    let elements_to_append: Vec<i32> = vec![3, 4, 5];
    let elements_final: Vec<i32> = vec![0, 1, 2, 3, 4, 5];

    let vec = new_collection(&elements, &mut list);
    let vec_to_append = new_collection(&elements_to_append, &mut to_append);

    let list_size = list.iter().inspect(|elem| unsafe {
        elem.as_ref().counter_marker().mark(Mark::InList);
    }).count();
    let to_append_size = to_append.iter().inspect(|elem| unsafe {
        elem.as_ref().counter_marker().mark(Mark::PossibleCycles);
    }).count();

    unsafe {
        list.mark_self_and_append(Mark::PossibleCycles, to_append, to_append_size);
    }

    list.assert_size(list_size + to_append_size);

    check_list(&list);
    assert_contains(&list, elements_final);
    list.iter().for_each(|elem| unsafe {
        assert!(elem.as_ref().counter_marker().is_in_possible_cycles());
    });

    drop(list);
    deallocate(vec);
    deallocate(vec_to_append);
}

#[cfg(feature = "finalization")]
#[test]
fn test_mark_self_and_append_empty_list() {
    let mut list = PossibleCycles::new();
    let to_append = LinkedList::new();
    let elements: Vec<i32> = vec![0, 1, 2];

    let vec = new_collection(&elements, &mut list);

    list.iter().for_each(|elem| unsafe {
        elem.as_ref().counter_marker().mark(Mark::InList);
    });

    unsafe {
        list.mark_self_and_append(Mark::PossibleCycles, to_append, 0);
    }

    list.assert_size(vec.len());

    check_list(&list);
    assert_contains(&list, elements);
    list.iter().for_each(|elem| unsafe {
        assert!(elem.as_ref().counter_marker().is_in_possible_cycles());
    });

    drop(list);
    deallocate(vec);
}

#[cfg(feature = "finalization")]
#[test]
fn test_mark_empty_self_and_append() {
    let list = PossibleCycles::new();
    let mut to_append = LinkedList::new();
    let elements: Vec<i32> = vec![0, 1, 2];

    let vec = new_collection(&elements, &mut to_append);

    to_append.iter().for_each(|elem| unsafe {
        elem.as_ref().counter_marker().mark(Mark::PossibleCycles);
    });

    unsafe {
        list.mark_self_and_append(Mark::PossibleCycles, to_append, vec.len());
    }

    list.assert_size(vec.len());

    check_list(&list);
    assert_contains(&list, elements);
    list.iter().for_each(|elem| unsafe {
        assert!(elem.as_ref().counter_marker().is_in_possible_cycles());
    });

    drop(list);
    deallocate(vec);
}

#[cfg(feature = "finalization")]
#[test]
fn test_mark_empty_self_and_append_empty_list() {
    let list = PossibleCycles::new();
    let to_append = LinkedList::new();

    unsafe {
        list.mark_self_and_append(Mark::PossibleCycles, to_append, 0);
    }

    list.assert_size(0);
    assert!(list.is_empty());
}

#[cfg(feature = "finalization")]
#[test]
fn test_swap_list() {
    let mut list = PossibleCycles::new();
    let mut to_swap = LinkedList::new();
    let elements: Vec<i32> = vec![0, 1, 2];
    let elements_to_swap: Vec<i32> = vec![3, 4, 5];

    let vec = new_collection(&elements, &mut list);
    let vec_to_swap = new_collection(&elements_to_swap, &mut to_swap);

    unsafe {
        list.swap_list(&mut to_swap, elements_to_swap.len());
    }

    list.assert_size(elements_to_swap.len());

    check_list(&list);
    check_list(&to_swap);
    assert_contains(&list, elements_to_swap);
    assert_contains(&to_swap, elements);

    drop(list);
    drop(to_swap);
    deallocate(vec);
    deallocate(vec_to_swap);
}

// Lists and queue common methods
trait CommonMethods {
    fn add(&mut self, ptr: NonNull<CcBox<()>>);
}

// Lists common methods to DRY in list's tests
// Also, mutating methods always take a &mut reference, even for PossibleCycles
trait ListMethods: CommonMethods {
    fn first(&self) -> Option<NonNull<CcBox<()>>>;

    fn remove(&mut self, ptr: NonNull<CcBox<()>>);

    fn remove_first(&mut self) -> Option<NonNull<CcBox<()>>>;

    fn is_empty(&self) -> bool;

    fn iter(&self) -> Iter;

    fn assert_size(&self, expected_size: usize);
}

impl CommonMethods for LinkedList {
    fn add(&mut self, ptr: NonNull<CcBox<()>>) {
        self.add(ptr)
    }
}

impl ListMethods for LinkedList {
    fn first(&self) -> Option<NonNull<CcBox<()>>> {
        self.first()
    }

    fn remove(&mut self, ptr: NonNull<CcBox<()>>) {
        self.remove(ptr)
    }

    fn remove_first(&mut self) -> Option<NonNull<CcBox<()>>> {
        self.remove_first()
    }

    fn is_empty(&self) -> bool {
        self.is_empty()
    }

    fn iter(&self) -> Iter {
        self.iter()
    }

    fn assert_size(&self, expected_size: usize) {
        assert_eq!(expected_size, self.iter().count());
    }
}

impl CommonMethods for PossibleCycles {
    fn add(&mut self, ptr: NonNull<CcBox<()>>) {
        Self::add(self, ptr)
    }
}

impl ListMethods for PossibleCycles {
    fn first(&self) -> Option<NonNull<CcBox<()>>> {
        self.first()
    }

    fn remove(&mut self, ptr: NonNull<CcBox<()>>) {
        Self::remove(self, ptr)
    }

    fn remove_first(&mut self) -> Option<NonNull<CcBox<()>>> {
        Self::remove_first(self)
    }

    fn is_empty(&self) -> bool {
        self.is_empty()
    }

    fn iter(&self) -> Iter {
        self.iter()
    }

    fn assert_size(&self, expected_size: usize) {
        assert_eq!(expected_size, self.size());
    }
}

mod queue {
    use super::*;

    fn check_queue(queue: &LinkedQueue) {
        let mut iter = queue.into_iter();
        let Some(first) = iter.next() else {
            assert!(queue.is_empty());
            return;
        };
        unsafe {
            assert_eq!(*first.as_ref().get_prev(), None);
            let mut last = first;
            for elem in iter {
                assert_eq!(*elem.as_ref().get_prev(), None);
                last = elem;
            }
            assert_eq!(*last.as_ref().get_next(), None);
            assert_eq!(*last.as_ref().get_prev(), None);
        }
    }

    fn assert_queue_contains(queue: &LinkedQueue, mut elements: Vec<i32>) {
        queue.into_iter().for_each(|ptr| {
            // Test contains
            assert!(queue.into_iter().contains(ptr));

            let elem = unsafe { *ptr.cast::<CcBox<i32>>().as_ref().get_elem() };
            let index = elements.iter().position(|&i| i == elem);
            assert!(index.is_some(), "Couldn't find element {} in queue.", elem);
            elements.swap_remove(index.unwrap());
        });

        assert!(
            elements.is_empty(),
            "Queue does not contains: {:?}",
            elements
        );
    }

    impl CommonMethods for LinkedQueue {
        fn add(&mut self, ptr: NonNull<CcBox<()>>) {
            self.add(ptr)
        }
    }

    #[test]
    fn test_new() {
        let mut queue = LinkedQueue::new();
        assert!(queue.is_empty());
        assert!(queue.peek().is_none());
        assert!(queue.poll().is_none());
    }

    #[test]
    fn test_add() {
        let mut queue = LinkedQueue::new();
        let vec: Vec<i32> = vec![0, 1, 2];

        assert!(queue.is_empty());
        let elements = new_collection(&vec, &mut queue);
        assert!(queue.peek().is_some());

        check_queue(&queue);
        assert_queue_contains(&queue, vec);

        drop(queue);
        deallocate(elements);
    }

    #[test]
    fn test_peek() {
        let mut queue = LinkedQueue::new();
        let elements = new_collection(&[5], &mut queue);
        let peek = queue.peek();

        assert!(peek.is_some());
        assert_eq!(peek.unwrap().cast(), elements[0]);

        // Test that peek doesn't remove the first element
        assert_eq!(peek, queue.peek());

        drop(queue);
        deallocate(elements);
    }

    #[test]
    fn test_poll() {
        let mut queue = LinkedQueue::new();
        let vec: Vec<i32> = vec![0, 1, 2];
        let elements = new_collection(&vec, &mut queue);

        // Mark to test the removal of the mark
        queue.into_iter().for_each(|ptr| unsafe {
            ptr.as_ref().counter_marker().mark(Mark::InList)
        });

        for elem in vec {
            let removed = queue.poll().expect("Queue has smaller size then expected");

            unsafe {
                assert!(
                    (*removed.as_ref().get_next()).is_none(),
                    "Removed element has still a next."
                );
                assert!(
                    (*removed.as_ref().get_prev()).is_none(),
                    "Removed element has a prev."
                );
                assert_eq!(
                    *removed.cast::<CcBox<i32>>().as_ref().get_elem(),
                    elem,
                    "Removed wrong element"
                );
                let cm = removed.as_ref().counter_marker();
                assert!(
                    cm.is_not_marked() && !cm.is_in_possible_cycles(),
                    "Removed element is still marked"
                );
            }

            check_queue(&queue);
        }
        
        assert!(queue.is_empty());
        assert!(queue.peek().is_none());

        drop(queue);
        deallocate(elements);
    }

    #[test]
    fn test_clearing_mark() {
        let mut queue = LinkedQueue::new();
        let vec = new_collection(&[0, 1, 2, 3], &mut queue);

        // Mark to test the removal of the mark
        queue.into_iter().for_each(|ptr| unsafe {
            ptr.as_ref().counter_marker().mark(Mark::InList)
        });

        drop(queue);

        for elem in &vec {
            let counter_marker = unsafe { elem.as_ref().counter_marker() };

            assert!(counter_marker.is_not_marked());
            assert!(!counter_marker.is_in_possible_cycles());
        }

        deallocate(vec);
    }
}