commit | 27001789535520113b730c4dd927bc40b67f65ca | [log] [tgz] |
---|---|---|
author | Alan Stokes <alanstokes@google.com> | Wed Jun 23 09:19:06 2021 +0000 |
committer | Automerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com> | Wed Jun 23 09:19:06 2021 +0000 |
tree | 6b1faad5ae4c75165c2b12384b50b287e7cc6957 | |
parent | 2356e2e0ff30d40cd6803691a7cbd5c64f2c08cf [diff] | |
parent | fe95f6957f82d9aba62ff8b46975ec8a045571b0 [diff] |
Allow CompOS APEX to access Ring. am: f42cceecce am: 960d204952 am: fe95f6957f Original change: https://android-review.googlesource.com/c/platform/external/rust/crates/spin/+/1742963 Change-Id: I683cd003c67fc6eeb114bed2fdac58a3c158f713
Spin-based synchronization primitives.
This crate provides spin-based versions of the primitives in std::sync
. Because synchronization is done through spinning, the primitives are suitable for use in no_std
environments.
Before deciding to use spin
, we recommend reading this superb blog post by @matklad that discusses the pros and cons of spinlocks. If you have access to std
, it's likely that the primitives in std::sync
will serve you better except in very specific circumstances.
Mutex
, RwLock
and Once
equivalentsno_std
environmentslock_api
compatibilityRwLock
guardsstd
feature to enable yield to the OS scheduler in busy loopsMutex
can become a ticket lockInclude the following under the [dependencies]
section in your Cargo.toml
file.
spin = "x.y"
When calling lock
on a Mutex
you will get a guard value that provides access to the data. When this guard is dropped, the lock will be unlocked.
extern crate spin; use std::{sync::Arc, thread}; fn main() { let counter = Arc::new(spin::Mutex::new(0)); let thread = thread::spawn({ let counter = counter.clone(); move || { for _ in 0..10 { *counter.lock() += 1; } } }); for _ in 0..10 { *counter.lock() += 1; } thread.join().unwrap(); assert_eq!(*counter.lock(), 20); }
The crate comes with a few feature flags that you may wish to use.
lock_api
enabled support for lock_api
ticket_mutex
uses a ticket lock for the implementation of Mutex
std
enables support for thread yielding instead of spinning
It is often desirable to have a lock shared between threads. Wrapping the lock in an std::sync::Arc
is route through which this might be achieved.
Locks provide zero-overhead access to their data when accessed through a mutable reference by using their get_mut
methods.
The behaviour of these lock is similar to their namesakes in std::sync
. they differ on the following:
spin
is distributed under the MIT License, (See LICENSE
).