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 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569
//! # Broom //! //! An ergonomic tracing garbage collector that supports mark 'n sweep garbage collection. //! //! ## Example //! //! ``` //! use broom::prelude::*; //! //! // The type you want the heap to contain //! pub enum Object { //! Num(f64), //! List(Vec<Handle<Self>>), //! } //! //! // Tell the garbage collector how to explore a graph of this object //! impl Trace<Self> for Object { //! fn trace(&self, tracer: &mut Tracer<Self>) { //! match self { //! Object::Num(_) => {}, //! Object::List(objects) => objects.trace(tracer), //! } //! } //! } //! //! // Create a new heap //! let mut heap = Heap::default(); //! //! // Temporary objects are cheaper than rooted objects, but don't survive heap cleans //! let a = heap.insert_temp(Object::Num(42.0)); //! let b = heap.insert_temp(Object::Num(1337.0)); //! //! // Turn the numbers into a rooted list //! let c = heap.insert(Object::List(vec![a, b])); //! //! // Change one of the numbers - this is safe, even if the object is self-referential! //! *heap.get_mut(a).unwrap() = Object::Num(256.0); //! //! // Create another number object //! let d = heap.insert_temp(Object::Num(0.0)); //! //! // Clean up unused heap objects //! heap.clean(); //! //! // a, b and c are all kept alive because c is rooted and a and b are its children //! assert!(heap.contains(a)); //! assert!(heap.contains(b)); //! assert!(heap.contains(c)); //! //! // Because `d` was temporary and unused, it did not survive the heap clean //! assert!(!heap.contains(d)); //! //! ``` pub mod trace; use std::{ cmp::{PartialEq, Eq}, rc::Rc, hash::{Hash, Hasher}, }; use hashbrown::{HashMap, HashSet}; use crate::trace::*; /// Common items that you'll probably need often. pub mod prelude { pub use super::{ Heap, Handle, Rooted, trace::{Trace, Tracer}, }; } type Generation = usize; /// A heap for storing objects. /// /// [`Heap`] is the centre of `broom`'s universe. It's the singleton through with manipulation of /// objects occurs. It can be used to create, access, mutate and garbage-collect objects. /// /// Note that heaps, and the objects associated with them, are *not* compatible: this means that /// you may not create trace routes (see [`Trace`]) that cross the boundary between different heaps. pub struct Heap<T> { last_sweep: usize, object_sweeps: HashMap<Handle<T>, usize>, obj_counter: Generation, objects: HashSet<Handle<T>>, rooted: HashMap<Handle<T>, Rc<()>>, } impl<T> Default for Heap<T> { fn default() -> Self { Self { last_sweep: 0, object_sweeps: HashMap::default(), obj_counter: 0, objects: HashSet::default(), rooted: HashMap::default(), } } } impl<T: Trace<T>> Heap<T> { /// Create an empty heap. pub fn new() -> Self { Self::default() } fn new_generation(&mut self) -> Generation { self.obj_counter += 1; self.obj_counter } /// Adds a new object to this heap that will be cleared upon the next garbage collection, if /// not attached to the object tree. pub fn insert_temp(&mut self, object: T) -> Handle<T> { let ptr = Box::into_raw(Box::new(object)); let gen = self.new_generation(); let handle = Handle { gen, ptr }; self.objects.insert(handle); handle } /// Adds a new object to this heap that will not be cleared by garbage collection until all /// rooted handles have been dropped. pub fn insert(&mut self, object: T) -> Rooted<T> { let handle = self.insert_temp(object); let rc = Rc::new(()); self.rooted.insert(handle, rc.clone()); Rooted { rc, handle, } } /// Upgrade a handle (that will be cleared by the garbage collector) into a rooted handle (that /// will not). pub fn make_rooted(&mut self, handle: impl AsRef<Handle<T>>) -> Rooted<T> { let handle = handle.as_ref(); debug_assert!(self.contains(handle)); Rooted { rc: self.rooted .entry(*handle) .or_insert_with(|| Rc::new(())) .clone(), handle: *handle, } } /// Count the number of heap-allocated objects in this heap pub fn len(&self) -> usize { self.objects.len() } /// Return true if the heap contains the specified handle pub fn contains(&self, handle: impl AsRef<Handle<T>>) -> bool { let handle = handle.as_ref(); self.objects.contains(&handle) } /// Get a reference to a heap object if it exists on this heap. pub fn get(&self, handle: impl AsRef<Handle<T>>) -> Option<&T> { let handle = handle.as_ref(); if self.contains(handle) { Some(unsafe { &*handle.ptr }) } else { None } } /// Get a reference to a heap object without checking whether it is still alive or that it /// belongs to this heap. /// /// If either invariant is not upheld, calling this function results in undefined /// behaviour. pub unsafe fn get_unchecked(&self, handle: impl AsRef<Handle<T>>) -> &T { let handle = handle.as_ref(); debug_assert!(self.contains(handle)); &*handle.ptr } /// Get a mutable reference to a heap object pub fn get_mut(&mut self, handle: impl AsRef<Handle<T>>) -> Option<&mut T> { let handle = handle.as_ref(); if self.contains(handle) { Some(unsafe { &mut *handle.ptr }) } else { None } } /// Get a mutable reference to a heap object without first checking that it is still alive or /// that it belongs to this heap. /// /// If either invariant is not upheld, calling this function results in undefined /// behaviour. Provided they are upheld, this function provides zero-cost access. pub fn get_mut_unchecked(&mut self, handle: impl AsRef<Handle<T>>) -> &mut T { let handle = handle.as_ref(); debug_assert!(self.contains(handle)); unsafe { &mut *handle.ptr } } /// Clean orphaned objects from the heap, excluding those that can be reached from the given /// handle iterator. /// /// This function is useful in circumstances in which you wish to keep certain items alive over /// a garbage collection without the addition cost of a [`Rooted`] handle. An example of this /// might be stack items in a garbage-collected language pub fn clean_excluding(&mut self, excluding: impl IntoIterator<Item=Handle<T>>) { let new_sweep = self.last_sweep + 1; let mut tracer = Tracer { new_sweep, object_sweeps: &mut self.object_sweeps, objects: &self.objects, }; // Mark self.rooted .retain(|handle, rc| { if Rc::strong_count(rc) > 1 { tracer.mark(*handle); unsafe { (&*handle.ptr).trace(&mut tracer); } true } else { false } }); let objects = &self.objects; excluding .into_iter() .filter(|handle| objects.contains(&handle)) .for_each(|handle| { tracer.mark(handle); unsafe { (&*handle.ptr).trace(&mut tracer); } }); // Sweep let object_sweeps = &mut self.object_sweeps; self.objects .retain(|handle| { if object_sweeps .get(handle) .map(|sweep| *sweep == new_sweep) .unwrap_or(false) { true } else { object_sweeps.remove(handle); drop(unsafe { Box::from_raw(handle.ptr) }); false } }); self.last_sweep = new_sweep; } /// Clean orphaned objects from the heap. pub fn clean(&mut self) { self.clean_excluding(std::iter::empty()); } } impl<T> Drop for Heap<T> { fn drop(&mut self) { for handle in &self.objects { drop(unsafe { Box::from_raw(handle.ptr) }); } } } /// A handle to a heap object. /// /// [`Handle`] may be cheaply copied as is necessary to serve your needs. It's even legal for it /// to outlive the object it refers to, provided it is no longer used to access it afterwards. #[derive(Debug)] pub struct Handle<T> { gen: Generation, ptr: *mut T, } impl<T> Handle<T> { /// Get a reference to the object this handle refers to without checking any invariants. /// /// **You almost certainly do not want to use this function: consider [`Heap::get`] or /// [`Heap::get_unchecked`] instead; both are safer than this function.** /// /// The following invariants must be upheld by you, the responsible programmer: /// /// - The object *must* still be alive (i.e: accessible from the heap it was created on) /// - The object *must not* be mutably accessible elsewhere (i.e: has any live references to /// it) by any other part of the program. Immutable references are permitted. Other handles /// (i.e: [`Handle`] or [`Rooted`] are also permitted, provided they are not in use. /// - That a garbage collection of the heap this object belongs to does not occur while the /// reference this function creates is live. /// /// If *any* of these invariants are not upheld, undefined behaviour will result when using /// this function. If all are upheld, this function provides zero-cost access to underlying /// object. pub unsafe fn get_unchecked(&self) -> &T { &*self.ptr } /// Get a mutable reference to the object this handle refers to without checking any /// invariants. /// /// **You almost certainly do not want to use this function: consider [`Heap::mutate`] or /// [`Heap::mutate_unchecked`] instead; both are safer than this function.** /// /// The following invariants must be upheld by you, the responsible programmer: /// /// - The object *must* still be alive (i.e: accessible from the heap it was created on) /// - The object *must not* be accessible elsewhere (i.e: has any live references to it), /// either mutably or immutably, by any other part of the program. Other handles (i.e: /// [`Handle`] or [`Rooted`] are permitted, provided they are not in use. /// - That a garbage collection of the heap this object belongs to does not occur while the /// reference this function creates is live. /// /// If *any* of these invariants are not upheld, undefined behaviour will result when using /// this function. If all are upheld, this function provides zero-cost access to underlying /// object. pub unsafe fn get_mut_unchecked(&self) -> &mut T { &mut *self.ptr } } impl<T> Copy for Handle<T> {} impl<T> Clone for Handle<T> { fn clone(&self) -> Self { Self { gen: self.gen, ptr: self.ptr } } } impl<T> PartialEq<Self> for Handle<T> { fn eq(&self, other: &Self) -> bool { self.gen == other.gen && self.ptr == other.ptr } } impl<T> Eq for Handle<T> {} impl<T> Hash for Handle<T> { fn hash<H: Hasher>(&self, state: &mut H) { self.gen.hash(state); self.ptr.hash(state); } } impl<T> AsRef<Handle<T>> for Handle<T> { fn as_ref(&self) -> &Handle<T> { self } } impl<T> From<Rooted<T>> for Handle<T> { fn from(rooted: Rooted<T>) -> Self { rooted.handle } } /// A handle to a heap object that guarantees the object will not be cleaned up by the garbage /// collector. /// /// [`Rooted`] may be cheaply copied as is necessary to serve your needs. It's even legal for it /// to outlive the object it refers to, provided it is no longer used to access it afterwards. #[derive(Debug)] pub struct Rooted<T> { // TODO: Is an Rc the best we can do? It might be better instead to store the strong count with // the object to avoid an extra allocation. rc: Rc<()>, handle: Handle<T>, } impl<T> Clone for Rooted<T> { fn clone(&self) -> Self { Self { rc: self.rc.clone(), handle: self.handle, } } } impl<T> AsRef<Handle<T>> for Rooted<T> { fn as_ref(&self) -> &Handle<T> { &self.handle } } impl<T> Rooted<T> { pub fn into_handle(self) -> Handle<T> { self.handle } pub fn handle(&self) -> Handle<T> { self.handle } } #[cfg(test)] mod tests { use super::*; use std::sync::atomic::{AtomicUsize, Ordering}; enum Value<'a> { Base(&'a AtomicUsize), Refs(&'a AtomicUsize, Handle<Value<'a>>, Handle<Value<'a>>), } impl<'a> Trace<Self> for Value<'a> { fn trace(&self, tracer: &mut Tracer<Self>) { match self { Value::Base(_) => {}, Value::Refs(_, a, b) => { a.trace(tracer); b.trace(tracer); }, } } } impl<'a> Drop for Value<'a> { fn drop(&mut self) { match self { Value::Base(count) | Value::Refs(count, _, _) => count.fetch_sub(1, Ordering::Relaxed), }; } } #[test] fn basic() { let count: AtomicUsize = AtomicUsize::new(0); let new_count = || { count.fetch_add(1, Ordering::Relaxed); &count }; let mut heap = Heap::default(); let a = heap.insert(Value::Base(new_count())); heap.clean(); assert_eq!(heap.contains(&a), true); let a = a.into_handle(); heap.clean(); assert_eq!(heap.contains(&a), false); drop(heap); assert_eq!(count.load(Ordering::Acquire), 0); } #[test] fn ownership() { let count: AtomicUsize = AtomicUsize::new(0); let new_count = || { count.fetch_add(1, Ordering::Relaxed); &count }; let mut heap = Heap::default(); let a = heap.insert(Value::Base(new_count())).handle(); let b = heap.insert(Value::Base(new_count())).handle(); let c = heap.insert(Value::Base(new_count())).handle(); let d = heap.insert(Value::Refs(new_count(), a, c)); let e = heap.insert(Value::Base(new_count())).handle(); heap.clean(); assert_eq!(heap.contains(&a), true); assert_eq!(heap.contains(&b), false); assert_eq!(heap.contains(&c), true); assert_eq!(heap.contains(&d), true); assert_eq!(heap.contains(&e), false); let a = heap.insert_temp(Value::Base(new_count())); heap.clean(); assert_eq!(heap.contains(&a), false); let a = heap.insert_temp(Value::Base(new_count())); let a = heap.make_rooted(a); heap.clean(); assert_eq!(heap.contains(&a), true); drop(heap); assert_eq!(count.load(Ordering::Acquire), 0); } #[test] fn recursive() { let count: AtomicUsize = AtomicUsize::new(0); let new_count = || { count.fetch_add(1, Ordering::Relaxed); &count }; let mut heap = Heap::default(); let a = heap.insert(Value::Base(new_count())); let b = heap.insert(Value::Base(new_count())); *heap.get_mut(&a).unwrap() = Value::Refs(new_count(), a.handle(), b.handle()); heap.clean(); assert_eq!(heap.contains(&a), true); assert_eq!(heap.contains(&b), true); let a = a.into_handle(); heap.clean(); assert_eq!(heap.contains(&a), false); assert_eq!(heap.contains(&b), true); drop(heap); assert_eq!(count.load(Ordering::Acquire), 0); } #[test] fn temporary() { let count: AtomicUsize = AtomicUsize::new(0); let new_count = || { count.fetch_add(1, Ordering::Relaxed); &count }; let mut heap = Heap::default(); let a = heap.insert_temp(Value::Base(new_count())); heap.clean(); assert_eq!(heap.contains(&a), false); let a = heap.insert_temp(Value::Base(new_count())); let b = heap.insert(Value::Refs(new_count(), a, a)); heap.clean(); assert_eq!(heap.contains(&a), true); assert_eq!(heap.contains(&b), true); let a = heap.insert_temp(Value::Base(new_count())); heap.clean_excluding(Some(a)); assert_eq!(heap.contains(&a), true); drop(heap); assert_eq!(count.load(Ordering::Acquire), 0); } }