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 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354
use super::*;
#[derive(Debug)]
enum Kind<T> {
Slot(MaybeUninit<T>),
Inline(NonNull<T>),
/// zero-sized type
Dangling(NonNull<T>),
}
impl<T> Default for Kind<T> {
fn default() -> Self {
if mem::size_of::<T>() == 0 {
Kind::Dangling(NonNull::dangling())
} else if mem::needs_drop::<T>() {
Kind::Slot(MaybeUninit::uninit())
} else {
Kind::Inline(NonNull::dangling())
}
}
}
/// An owned to a value `T` in the ARENA.
#[derive(Debug)]
#[must_use = "The `T` is uninitialized, and must be initialized by `write` before it is used, if `T` is not zero sized type."]
pub struct Owned<T> {
kind: Kind<T>,
arena: Arena,
detached: bool,
pub(super) allocated: Meta,
}
impl<T> Owned<T> {
/// Detach the value from the ARENA, which means when the value is dropped,
/// the underlying memory will not be collected for futhur allocation.
///
/// # Safety
/// - If `T` is not inlined ([`core::mem::needs_drop::<T>()`](core::mem::needs_drop) returns `true`), then users should take care of dropping the value by themselves.
#[inline]
pub unsafe fn detach(&mut self) {
self.detached = true;
}
/// Write a value to the `RefMut`.
#[inline]
pub fn write(&mut self, value: T) {
match &mut self.kind {
Kind::Slot(slot) => unsafe {
slot.as_mut_ptr().write(value);
},
Kind::Inline(ptr) => unsafe {
ptr.as_ptr().write(value);
},
Kind::Dangling(_) => {}
}
}
/// Returns how many bytes of `T` occupies.
///
/// If this value is `0`, then the `T` is ZST (zero sized type).
#[inline]
pub const fn size(&self) -> usize {
self.allocated.ptr_size as usize
}
/// Returns the offset of `T` to the pointer of the ARENA.
///
/// If this value is `0`, then the `T` is ZST (zero sized type).
#[inline]
pub const fn offset(&self) -> usize {
self.allocated.ptr_offset as usize
}
/// Returns how many bytes of memory the value occupies.
///
/// If this value is `0`, then the `T` is ZST (zero sized type).
#[inline]
pub const fn memory_size(&self) -> usize {
self.allocated.memory_size as usize
}
/// Returns the offset to the pointer of the ARENA.
///
/// If this value is `0`, then the `T` is ZST (zero sized type).
#[inline]
pub const fn memory_offset(&self) -> usize {
self.allocated.memory_offset as usize
}
/// Returns a shared reference to the value.
///
/// # Safety
/// - The value must be initialized.
pub unsafe fn as_ref(&self) -> &T {
match &self.kind {
Kind::Slot(slot) => slot.as_ptr().as_ref().unwrap(),
Kind::Inline(ptr) => ptr.as_ref(),
Kind::Dangling(val) => val.as_ref(),
}
}
/// Returns a mutable reference to the value.
///
/// # Safety
/// - The value must be initialized.
pub unsafe fn as_mut(&mut self) -> &mut T {
match &mut self.kind {
Kind::Slot(slot) => slot.as_mut_ptr().as_mut().unwrap(),
Kind::Inline(ptr) => ptr.as_mut(),
Kind::Dangling(val) => val.as_mut(),
}
}
/// Returns the pointer to the `T`, the pointer may not be initialized.
/// If the pointer is not initialized, then [`NonNull::dangling()`] is returned.
pub fn as_mut_ptr(&mut self) -> NonNull<T> {
match &mut self.kind {
Kind::Slot(slot) => {
if slot.as_ptr().is_null() {
NonNull::dangling()
} else {
// SAFETY: we have checked that the pointer is not null.
unsafe { NonNull::new_unchecked(slot.as_mut_ptr()) }
}
}
Kind::Inline(ptr) => *ptr,
Kind::Dangling(val) => *val,
}
}
}
impl<T> Drop for Owned<T> {
fn drop(&mut self) {
match &mut self.kind {
Kind::Slot(slot) => {
if !self.detached {
unsafe {
if mem::needs_drop::<T>() {
let ptr = slot.as_mut_ptr();
if !ptr.is_null() {
ptr::drop_in_place(ptr);
}
}
}
// SAFETY: offset and offset + size are inbounds of the ARENA.
unsafe {
self
.arena
.dealloc(self.allocated.memory_offset, self.allocated.memory_size);
}
}
}
Kind::Inline(_) => {
if !self.detached {
// SAFETY: offset and offset + size are inbounds of the ARENA.
unsafe {
self
.arena
.dealloc(self.allocated.memory_offset, self.allocated.memory_size);
}
}
}
Kind::Dangling(_) => {}
}
}
}
/// A mutable reference to a value `T` in the ARENA.
#[derive(Debug)]
#[must_use = "The `T` is uninitialized, and must be initialized by `write` before it is used, if `T` is not zero sized type."]
pub struct RefMut<'a, T> {
kind: Kind<T>,
arena: &'a Arena,
detached: bool,
pub(super) allocated: Meta,
}
impl<'a, T> RefMut<'a, T> {
/// Detach the value from the ARENA, which means when the value is dropped,
/// the underlying memory will not be collected for futhur allocation.
///
/// # Safety
/// - If `T` is not inlined ([`core::mem::needs_drop::<T>()`](core::mem::needs_drop) returns `true`), then users should take care of dropping the value by themselves.
#[inline]
pub unsafe fn detach(&mut self) {
self.detached = true;
}
/// Write a value to the `RefMut`.
#[inline]
pub fn write(&mut self, value: T) {
match &mut self.kind {
Kind::Slot(slot) => unsafe {
slot.as_mut_ptr().write(value);
},
Kind::Inline(ptr) => unsafe {
ptr.as_ptr().write(value);
},
Kind::Dangling(_) => {}
}
}
/// Returns how many bytes of `T` occupies.
///
/// If this value is `0`, then the `T` is ZST (zero sized type).
#[inline]
pub const fn size(&self) -> usize {
self.allocated.ptr_size as usize
}
/// Returns the offset of `T` to the pointer of the ARENA.
///
/// If this value is `0`, then the `T` is ZST (zero sized type).
#[inline]
pub const fn offset(&self) -> usize {
self.allocated.ptr_offset as usize
}
/// Returns how many bytes of memory the value occupies.
///
/// If this value is `0`, then the `T` is ZST (zero sized type).
#[inline]
pub const fn memory_size(&self) -> usize {
self.allocated.memory_size as usize
}
/// Returns the offset to the pointer of the ARENA.
///
/// If this value is `0`, then the `T` is ZST (zero sized type).
#[inline]
pub const fn memory_offset(&self) -> usize {
self.allocated.memory_offset as usize
}
/// Returns a shared reference to the value.
///
/// # Safety
/// - The value must be initialized.
pub unsafe fn as_ref(&self) -> &T {
match &self.kind {
Kind::Slot(slot) => slot.as_ptr().as_ref().unwrap(),
Kind::Inline(ptr) => ptr.as_ref(),
Kind::Dangling(val) => val.as_ref(),
}
}
/// Returns a mutable reference to the value.
///
/// # Safety
/// - The value must be initialized.
pub unsafe fn as_mut(&mut self) -> &mut T {
match &mut self.kind {
Kind::Slot(slot) => slot.as_mut_ptr().as_mut().unwrap(),
Kind::Inline(ptr) => ptr.as_mut(),
Kind::Dangling(val) => val.as_mut(),
}
}
/// Returns the pointer to the `T`, the pointer may not be initialized.
/// If the pointer is not initialized, then [`NonNull::dangling()`] is returned.
pub fn as_mut_ptr(&mut self) -> NonNull<T> {
match &mut self.kind {
Kind::Slot(slot) => {
if slot.as_ptr().is_null() {
NonNull::dangling()
} else {
// SAFETY: we have checked that the pointer is not null.
unsafe { NonNull::new_unchecked(slot.as_mut_ptr()) }
}
}
Kind::Inline(ptr) => *ptr,
Kind::Dangling(val) => *val,
}
}
#[inline]
pub(super) const fn new(slot: MaybeUninit<T>, allocated: Meta, arena: &'a Arena) -> Self {
Self {
kind: Kind::Slot(slot),
arena,
detached: false,
allocated,
}
}
#[inline]
pub(super) const fn new_inline(value: NonNull<T>, allocated: Meta, arena: &'a Arena) -> Self {
Self {
kind: Kind::Inline(value),
arena,
detached: false,
allocated,
}
}
#[inline]
pub(super) const fn new_zst(arena: &'a Arena) -> Self {
Self {
kind: Kind::Dangling(NonNull::dangling()),
allocated: Meta::null(arena.ptr as _),
arena,
detached: false,
}
}
#[allow(clippy::wrong_self_convention)]
#[inline]
pub(super) fn to_owned(&mut self) -> Owned<T> {
self.detached = true;
Owned {
arena: self.arena.clone(),
kind: mem::take(&mut self.kind),
detached: false,
allocated: self.allocated,
}
}
}
impl<'a, T> Drop for RefMut<'a, T> {
fn drop(&mut self) {
match &mut self.kind {
Kind::Slot(slot) => {
if !self.detached {
unsafe {
if mem::needs_drop::<T>() {
let ptr = slot.as_mut_ptr();
if !ptr.is_null() {
ptr::drop_in_place(ptr);
}
}
}
// SAFETY: offset and offset + size are inbounds of the ARENA.
unsafe {
self
.arena
.dealloc(self.allocated.memory_offset, self.allocated.memory_size);
}
}
}
Kind::Inline(_) => {
if !self.detached {
// SAFETY: offset and offset + size are inbounds of the ARENA.
unsafe {
self
.arena
.dealloc(self.allocated.memory_offset, self.allocated.memory_size);
}
}
}
Kind::Dangling(_) => {}
}
}
}