kimojio 0.16.2

A thread-per-core Linux io_uring async runtime optimized for latency.
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

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
//! AsyncSemaphore is a counter representing "tokens" you can acquire. If the
//! count is zero you have to wait.  AsyncSemaphore is not scoped based as it is
//! intended for more complex scenarios. You have to be careful to acquire and
//! releas when appropriate. Unlike for locks, acquire and release do not
//! necessarily need to be balanced depending on your use case.
//!
//! If you need balanced access to resources protected by scopes, use AsyncLock
//! or AsyncReaderWriterLock.
//!
//! # Usage
//!
//! ```
//! async fn semaphore_example() {
//!     let tokens = std::rc::Rc::new(kimojio::AsyncSemaphore::new(3));
//!     tokens.acquire().await;
//!     tokens.release();
//! }
//! ```
//!
use crate::{CanceledError, async_event::AsyncEvent};
use std::cell::Cell;

/// A counting semaphore for limiting concurrent access to resources.
///
/// `AsyncSemaphore` manages a count of available tokens. Tasks can acquire
/// tokens (decrementing the count) and release them (incrementing the count).
/// If no tokens are available, acquiring tasks will be suspended until
/// tokens are released.
pub struct AsyncSemaphore {
    tokens: Cell<usize>,
    available: AsyncEvent,
}

// Ensure that AsyncSemaphore is always !Send and !Sync
static_assertions::const_assert!(impls::impls!(AsyncSemaphore: !Send & !Sync));

impl AsyncSemaphore {
    /// Creates a new `AsyncSemaphore` with the specified number of initial tokens.
    pub fn new(initial_count: usize) -> Self {
        let available = AsyncEvent::new();
        if initial_count > 0 {
            available.set();
        }
        Self {
            tokens: Cell::new(initial_count),
            available,
        }
    }

    /// Wait until at least one token is available and then grab it by
    /// decreasing token count by one.
    pub async fn acquire(&self) -> Result<(), CanceledError> {
        while self.tokens.get() == 0 {
            self.available.wait().await?;
        }
        let count = self.tokens.get() - 1;
        self.tokens.set(count);
        if count == 0 {
            self.available.reset();
        }
        Ok(())
    }

    /// Releases a token back to the semaphore, waking one waiting task if any.
    pub fn release(&self) {
        self.tokens.set(self.tokens.get() + 1);
        self.available.set_wake_one();
    }
}

#[cfg(test)]
mod test {
    use std::{cell::Cell, rc::Rc};

    use crate::{AsyncEvent, AsyncSemaphore, operations, run_test};

    #[test]
    fn semaphore_test() {
        run_test("semaphore_test", async {
            let semaphore = Rc::new(AsyncSemaphore::new(3));
            let counter = Rc::new(Cell::new(0i32));

            let mut tasks = Vec::new();
            for _ in 0..4 {
                let semaphore = semaphore.clone();
                let counter = counter.clone();
                let started = Rc::new(AsyncEvent::new());
                let started_copy = started.clone();
                tasks.push(operations::spawn_task(async move {
                    started_copy.set();
                    semaphore.acquire().await.unwrap();
                    counter.set(counter.get() + 1);
                }));

                started.wait().await.unwrap();
            }

            assert_eq!(counter.get(), 3);
            semaphore.release();

            for task in tasks {
                task.await.unwrap();
            }

            assert_eq!(counter.get(), 4);
        })
    }
}