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 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244
#![no_std]
#![doc = include_str!("../README.md")]
#![cfg_attr(docsrs, feature(doc_cfg))]
use core::cell::UnsafeCell;
use core::mem::MaybeUninit;
use portable_atomic::{AtomicBool, Ordering};
/// Statically allocated, initialized at runtime cell.
///
/// It has two states: "empty" and "full". It is created "empty", and obtaining a reference
/// to the contents permanently changes it to "full". This allows that reference to be valid
/// forever.
///
/// If your value can be initialized as a `const` value, consider using [`ConstStaticCell`]
/// instead if you only need to take the value at runtime.
///
/// See the [crate-level docs](crate) for usage.
pub struct StaticCell<T> {
used: AtomicBool,
val: UnsafeCell<MaybeUninit<T>>,
}
unsafe impl<T> Send for StaticCell<T> {}
unsafe impl<T> Sync for StaticCell<T> {}
impl<T> StaticCell<T> {
/// Create a new, empty `StaticCell`.
///
/// It can be initialized at runtime with [`StaticCell::init()`] or similar methods.
#[inline]
pub const fn new() -> Self {
Self {
used: AtomicBool::new(false),
val: UnsafeCell::new(MaybeUninit::uninit()),
}
}
/// Initialize the `StaticCell` with a value, returning a mutable reference to it.
///
/// Using this method, the compiler usually constructs `val` in the stack and then moves
/// it into the `StaticCell`. If `T` is big, this is likely to cause stack overflows.
/// Considering using [`StaticCell::init_with`] instead, which will construct it in-place inside the `StaticCell`.
///
/// # Panics
///
/// Panics if this `StaticCell` is already full.
#[inline]
#[allow(clippy::mut_from_ref)]
pub fn init(&'static self, val: T) -> &'static mut T {
self.uninit().write(val)
}
/// Initialize the `StaticCell` with the closure's return value, returning a mutable reference to it.
///
/// The advantage over [`StaticCell::init`] is that this method allows the closure to construct
/// the `T` value in-place directly inside the `StaticCell`, saving stack space.
///
/// # Panics
///
/// Panics if this `StaticCell` is already full.
#[inline]
#[allow(clippy::mut_from_ref)]
pub fn init_with(&'static self, val: impl FnOnce() -> T) -> &'static mut T {
self.uninit().write(val())
}
/// Return a mutable reference to the uninitialized memory owned by the `StaticCell`.
///
/// Using this method directly is not recommended, but it can be used to construct `T` in-place directly
/// in a guaranteed fashion.
///
/// # Panics
///
/// Panics if this `StaticCell` is already full.
#[inline]
#[allow(clippy::mut_from_ref)]
pub fn uninit(&'static self) -> &'static mut MaybeUninit<T> {
if let Some(val) = self.try_uninit() {
val
} else {
panic!("`StaticCell` is already full, it can't be initialized twice.");
}
}
/// Try initializing the `StaticCell` with a value, returning a mutable reference to it.
///
/// If this `StaticCell` is already full, it returns `None`.
///
/// Using this method, the compiler usually constructs `val` in the stack and then moves
/// it into the `StaticCell`. If `T` is big, this is likely to cause stack overflows.
/// Considering using [`StaticCell::try_init_with`] instead, which will construct it in-place inside the `StaticCell`.
///
/// Will only return a Some(&'static mut T) when the `StaticCell` was not yet initialized.
#[inline]
#[allow(clippy::mut_from_ref)]
pub fn try_init(&'static self, val: T) -> Option<&'static mut T> {
Some(self.try_uninit()?.write(val))
}
/// Try initializing the `StaticCell` with the closure's return value, returning a mutable reference to it.
///
/// If this `StaticCell` is already full, it returns `None`.
///
/// The advantage over [`StaticCell::init`] is that this method allows the closure to construct
/// the `T` value in-place directly inside the `StaticCell`, saving stack space.
///
#[inline]
#[allow(clippy::mut_from_ref)]
pub fn try_init_with(&'static self, val: impl FnOnce() -> T) -> Option<&'static mut T> {
Some(self.try_uninit()?.write(val()))
}
/// Try returning a mutable reference to the uninitialized memory owned by the `StaticCell`.
///
/// If this `StaticCell` is already full, it returns `None`.
///
/// Using this method directly is not recommended, but it can be used to construct `T` in-place directly
/// in a guaranteed fashion.
#[inline]
pub fn try_uninit(&'static self) -> Option<&'static mut MaybeUninit<T>> {
if self
.used
.compare_exchange(false, true, Ordering::Acquire, Ordering::Relaxed)
.is_ok()
{
// SAFETY: We just checked that the value is not yet taken and marked it as taken.
let val = unsafe { &mut *self.val.get() };
Some(val)
} else {
None
}
}
}
// ---
/// Statically allocated and initialized, taken at runtime cell.
///
/// It has two states: "untaken" and "taken". It is created "untaken", and obtaining a reference
/// to the contents permanently changes it to "taken". This allows that reference to be valid
/// forever.
///
/// If your value can be const defined, for example a large, zero filled buffer used for DMA
/// or other scratch memory usage, `ConstStaticCell` can be used to guarantee the initializer
/// will never take up stack memory.
///
/// If your values are all zero initialized, the resulting `ConstStaticCell` should be placed
/// in `.bss`, not taking flash space for initialization either.
///
/// See the [crate-level docs](crate) for usage.
pub struct ConstStaticCell<T> {
taken: AtomicBool,
val: UnsafeCell<T>,
}
unsafe impl<T> Send for ConstStaticCell<T> {}
unsafe impl<T> Sync for ConstStaticCell<T> {}
impl<T> ConstStaticCell<T> {
/// Create a new, empty `ConstStaticCell`.
///
/// It can be taken at runtime with [`ConstStaticCell::take()`] or similar methods.
#[inline]
pub const fn new(value: T) -> Self {
Self {
taken: AtomicBool::new(false),
val: UnsafeCell::new(value),
}
}
/// Take the `ConstStaticCell`, returning a mutable reference to it.
///
/// # Panics
///
/// Panics if this `ConstStaticCell` was already taken.
#[inline]
#[allow(clippy::mut_from_ref)]
pub fn take(&'static self) -> &'static mut T {
if let Some(val) = self.try_take() {
val
} else {
panic!("`ConstStaticCell` is already taken, it can't be taken twice")
}
}
/// Try to take the `ConstStaticCell`, returning None if it was already taken
#[inline]
#[allow(clippy::mut_from_ref)]
pub fn try_take(&'static self) -> Option<&'static mut T> {
if self
.taken
.compare_exchange(false, true, Ordering::Acquire, Ordering::Relaxed)
.is_ok()
{
// SAFETY: We just checked that the value is not yet taken and marked it as taken.
let val = unsafe { &mut *self.val.get() };
Some(val)
} else {
None
}
}
}
/// Convert a `T` to a `&'static mut T`.
///
/// The macro declares a `static StaticCell` and then initializes it when run, returning the `&'static mut`.
/// Therefore, each instance can only be run once. Next runs will panic. The `static` can additionally be
/// decorated with attributes, such as `#[link_section]`, `#[used]`, et al.
///
/// This macro is nightly-only. It requires `#![feature(type_alias_impl_trait)]` in the crate using it.
///
/// # Examples
///
/// ```
/// # #![feature(type_alias_impl_trait)]
/// use static_cell::make_static;
///
/// # fn main() {
/// let x: &'static mut u32 = make_static!(42);
///
/// // This attribute instructs the linker to allocate it in the external RAM's BSS segment.
/// // This specific example is for ESP32S3 with PSRAM support.
/// let buf = make_static!([0u8; 4096], #[link_section = ".ext_ram.bss.buf"]);
///
/// // Multiple attributes can be supplied.
/// let s = make_static!(0usize, #[used] #[export_name = "exported_symbol_name"]);
/// # }
/// ```
#[cfg(feature = "nightly")]
#[cfg_attr(docsrs, doc(cfg(feature = "nightly")))]
#[macro_export]
macro_rules! make_static {
($val:expr) => ($crate::make_static!($val, ));
($val:expr, $(#[$m:meta])*) => {{
type T = impl ::core::marker::Sized;
$(#[$m])*
static STATIC_CELL: $crate::StaticCell<T> = $crate::StaticCell::new();
#[deny(unused_attributes)]
let (x,) = unsafe { STATIC_CELL.uninit().write(($val,)) };
x
}};
}