range-lock 0.2.4

Range lock for std::vec::Vec
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

// -*- coding: utf-8 -*-
//
// Copyright 2021-2023 Michael Büsch <m@bues.ch>
//
// Licensed under the Apache License version 2.0
// or the MIT license, at your option.
// SPDX-License-Identifier: Apache-2.0 OR MIT
//

use range_lock::VecRangeLock;
use std::sync::{Arc, Barrier};
use std::thread;

#[test]
fn test_rangelock() {
    // The data that will simultaneously be accessed from the threads.
    let data = vec![10, 11, 12, 13];

    // Embed the data in a VecRangeLock
    // and clone atomic references to it for the threads.
    let data_lock0 = Arc::new(VecRangeLock::new(data));
    let data_lock1 = Arc::clone(&data_lock0);
    let data_lock2 = Arc::clone(&data_lock0);

    // Thread barrier, only for demonstration purposes.
    let barrier0 = Arc::new(Barrier::new(2));
    let barrier1 = Arc::clone(&barrier0);

    thread::scope(|s| {
        // Spawn first thread.
        s.spawn(move || {
            {
                let mut guard = data_lock0.try_lock(0..2).expect("T0: Failed to lock 0..2");
                guard[0] = 100; // Write to data[0]
            }
            barrier0.wait(); // Synchronize with second thread.
            {
                let guard = data_lock0.try_lock(2..4).expect("T0: Failed to lock 2..4");
                assert_eq!(guard[0], 200); // Read from data[2]
            }
        });

        // Spawn second thread.
        s.spawn(move || {
            {
                let mut guard = data_lock1.try_lock(2..4).expect("T1: Failed to lock 2..4");
                guard[0] = 200; // Write to data[2]
            }
            barrier1.wait(); // Synchronize with first thread.
            {
                let guard = data_lock1.try_lock(0..2).expect("T1: Failed to lock 0..2");
                assert_eq!(guard[0], 100); // Read from data[0]
            }
        });
    });

    // Unwrap the data from the lock.
    let data = Arc::try_unwrap(data_lock2)
        .expect("Arc unwrap failed")
        .into_inner();

    // Check the data that has been modified by the threads.
    assert_eq!(data, vec![100, 11, 200, 13]);
}

#[test]
fn test_conflict() {
    let data = vec![10, 11, 12, 13];

    let data_lock0 = Arc::new(VecRangeLock::new(data));
    let data_lock1 = Arc::clone(&data_lock0);

    let barrier0 = Arc::new(Barrier::new(2));
    let barrier1 = Arc::clone(&barrier0);

    thread::scope(|s| {
        s.spawn(move || {
            let mut _guard = data_lock0.try_lock(0..2).expect("T0: Failed to lock 0..2");
            barrier0.wait();
            // try_lock() conflict happens in second thread.
            barrier0.wait();
        });

        s.spawn(move || {
            barrier1.wait();
            // thread0 holds lock to 0..2, which conflicts with 1..4.
            assert!(data_lock1.try_lock(1..4).is_err());
            barrier1.wait();
        });
    });
}

// vim: ts=4 sw=4 expandtab