mirror of
https://github.com/rtic-rs/rtic.git
synced 2024-11-29 15:04:32 +01:00
add Resource.read
method for atomic reads of a resource's value
this method lets you directly read the value of a resource without paying for synchronization overhead (no need for `Threshold.raise`). The catch is that resource value must have a size of 4-bytes or smaller to guarantee that the read operation is atomic -- atomic as in it can't be interrupted.
This commit is contained in:
parent
c1465b2117
commit
bad8851fee
1 changed files with 25 additions and 2 deletions
27
src/lib.rs
27
src/lib.rs
|
@ -426,9 +426,9 @@ extern crate cortex_m;
|
||||||
extern crate static_ref;
|
extern crate static_ref;
|
||||||
extern crate typenum;
|
extern crate typenum;
|
||||||
|
|
||||||
use core::cell::UnsafeCell;
|
use core::cell::{Cell, UnsafeCell};
|
||||||
use core::marker::PhantomData;
|
use core::marker::PhantomData;
|
||||||
use core::ptr;
|
use core::{mem, ptr};
|
||||||
|
|
||||||
use cortex_m::ctxt::Context;
|
use cortex_m::ctxt::Context;
|
||||||
use cortex_m::interrupt::Nr;
|
use cortex_m::interrupt::Nr;
|
||||||
|
@ -536,6 +536,29 @@ impl<T, RC> Resource<T, RC> {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
impl<T, RC> Resource<Cell<T>, RC> {
|
||||||
|
/// Performs an atomic read of the resource value
|
||||||
|
///
|
||||||
|
/// This method has no synchronization overhead, and doesn't impose
|
||||||
|
/// additional task blocking
|
||||||
|
///
|
||||||
|
/// # Panics
|
||||||
|
///
|
||||||
|
/// - This method will panic if the size of `T` is greater than the size
|
||||||
|
/// of a word (4 bytes)
|
||||||
|
pub fn read(&self) -> T {
|
||||||
|
assert!(mem::size_of::<T>() <= mem::size_of::<usize>());
|
||||||
|
|
||||||
|
// NOTE(volatile) this has to be volatile because unlike a read through
|
||||||
|
// `access` there's no guarantee that the resource value will *not*
|
||||||
|
// change between two consecutive reads (e.g. an interrupt may occur
|
||||||
|
// in between)
|
||||||
|
unsafe {
|
||||||
|
ptr::read_volatile(self.data.get() as *const _)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
unsafe impl<T, C> Sync for Resource<T, C>
|
unsafe impl<T, C> Sync for Resource<T, C>
|
||||||
where
|
where
|
||||||
T: Send,
|
T: Send,
|
||||||
|
|
Loading…
Reference in a new issue