Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add const constructors to RwLock, Notify, and Semaphore. #2833

Merged
merged 2 commits into from Sep 12, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion tokio/src/loom/std/atomic_u16.rs
Expand Up @@ -11,7 +11,7 @@ unsafe impl Send for AtomicU16 {}
unsafe impl Sync for AtomicU16 {}

impl AtomicU16 {
pub(crate) fn new(val: u16) -> AtomicU16 {
pub(crate) const fn new(val: u16) -> AtomicU16 {
let inner = UnsafeCell::new(std::sync::atomic::AtomicU16::new(val));
AtomicU16 { inner }
}
Expand Down
2 changes: 1 addition & 1 deletion tokio/src/loom/std/atomic_u32.rs
Expand Up @@ -11,7 +11,7 @@ unsafe impl Send for AtomicU32 {}
unsafe impl Sync for AtomicU32 {}

impl AtomicU32 {
pub(crate) fn new(val: u32) -> AtomicU32 {
pub(crate) const fn new(val: u32) -> AtomicU32 {
let inner = UnsafeCell::new(std::sync::atomic::AtomicU32::new(val));
AtomicU32 { inner }
}
Expand Down
2 changes: 1 addition & 1 deletion tokio/src/loom/std/atomic_u8.rs
Expand Up @@ -11,7 +11,7 @@ unsafe impl Send for AtomicU8 {}
unsafe impl Sync for AtomicU8 {}

impl AtomicU8 {
pub(crate) fn new(val: u8) -> AtomicU8 {
pub(crate) const fn new(val: u8) -> AtomicU8 {
let inner = UnsafeCell::new(std::sync::atomic::AtomicU8::new(val));
AtomicU8 { inner }
}
Expand Down
2 changes: 1 addition & 1 deletion tokio/src/loom/std/unsafe_cell.rs
Expand Up @@ -2,7 +2,7 @@
pub(crate) struct UnsafeCell<T>(std::cell::UnsafeCell<T>);

impl<T> UnsafeCell<T> {
pub(crate) fn new(data: T) -> UnsafeCell<T> {
pub(crate) const fn new(data: T) -> UnsafeCell<T> {
UnsafeCell(std::cell::UnsafeCell::new(data))
}

Expand Down
18 changes: 18 additions & 0 deletions tokio/src/sync/notify.rs
Expand Up @@ -170,6 +170,24 @@ impl Notify {
}
}

/// Create a new `Notify`, initialized without a permit.
///
/// # Examples
///
/// ```
/// use tokio::sync::Notify;
///
/// static NOTIFY: Notify = Notify::const_new();
/// ```
#[cfg(all(feature = "parking_lot", not(all(loom, test))))]
#[cfg_attr(docsrs, doc(cfg(feature = "parking_lot")))]
pub const fn const_new() -> Notify {
Notify {
state: AtomicU8::new(0),
waiters: Mutex::const_new(LinkedList::new()),
}
}

/// Wait for a notification.
///
/// Equivalent to:
Expand Down
21 changes: 21 additions & 0 deletions tokio/src/sync/rwlock.rs
Expand Up @@ -485,6 +485,27 @@ impl<T: ?Sized> RwLock<T> {
}
}

/// Creates a new instance of an `RwLock<T>` which is unlocked.
///
/// # Examples
///
/// ```
/// use tokio::sync::RwLock;
///
/// static LOCK: RwLock<i32> = RwLock::const_new(5);
/// ```
#[cfg(all(feature = "parking_lot", not(all(loom, test))))]
#[cfg_attr(docsrs, doc(cfg(feature = "parking_lot")))]
pub const fn const_new(value: T) -> RwLock<T>
where
T: Sized,
{
RwLock {
c: UnsafeCell::new(value),
s: Semaphore::const_new(MAX_READS),
}
}

/// Locks this rwlock with shared read access, causing the current task
/// to yield until the lock has been acquired.
///
Expand Down
9 changes: 9 additions & 0 deletions tokio/src/sync/semaphore.rs
Expand Up @@ -74,6 +74,15 @@ impl Semaphore {
}
}

/// Creates a new semaphore with the initial number of permits.
#[cfg(all(feature = "parking_lot", not(all(loom, test))))]
#[cfg_attr(docsrs, doc(cfg(feature = "parking_lot")))]
pub const fn const_new(permits: usize) -> Self {
Self {
ll_sem: ll::Semaphore::const_new(permits),
}
}

/// Returns the current number of available permits.
pub fn available_permits(&self) -> usize {
self.ll_sem.available_permits()
Expand Down