zero-pool 0.9.0

High-performance thread pool with consistent low-latency task dispatch
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

//! # Zero-Pool
//!
//! High-performance thread pool with:
//! - Lock-free MPMC queue with epoch-based memory reclamation
//! - Function pointer dispatch (no trait objects / virtual dispatch)
//! - Zero external dependencies
//!
//! ```rust
//! use zero_pool::ZeroPool;
//!
//! struct Params { value: u64, result: *mut u64 }
//!
//! fn task(p: &Params) { unsafe { *p.result = p.value * 2; } }
//!
//! let pool = ZeroPool::new();
//! let mut result = 0;
//! pool.run(task, &[Params { value: 42, result: &raw mut result }]);
//! assert_eq!(result, 84);
//! ```

mod pool;
mod queue;
mod retired_list;
mod scope;
mod task_batch;
mod worker;

use std::ptr::NonNull;
use std::sync::OnceLock;

pub use pool::ZeroPool;
pub use scope::Scope;

static GLOBAL_ZP: OnceLock<ZeroPool> = OnceLock::new();

/// Returns a reference to the lazily initialized global pool.
#[inline]
pub fn global_pool() -> &'static ZeroPool {
    GLOBAL_ZP.get_or_init(ZeroPool::new)
}

pub(crate) type TaskParamPointer = NonNull<u8>;
pub(crate) type TaskFnPointer = fn(TaskParamPointer);

#[repr(align(64))]
pub(crate) struct PaddedType<T>(pub T);

impl<T> std::ops::Deref for PaddedType<T> {
    type Target = T;
    fn deref(&self) -> &Self::Target {
        &self.0
    }
}