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
use super::Resource;
use crate::prelude::*;
use alloc::collections::BTreeSet;
use core::any::Any;
use core::fmt;
#[derive(Debug)]
/// Errors returned by operations on `ResourceTable`
pub enum ResourceTableError {
/// ResourceTable has no free keys
Full,
/// Resource not present in table
NotPresent,
/// Resource present in table, but with a different type
WrongType,
/// Resource cannot be deleted because child resources exist in the table. Consult wit docs for
/// the particular resource to see which methods may return child resources.
HasChildren,
}
impl fmt::Display for ResourceTableError {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match self {
Self::Full => write!(f, "resource table has no free keys"),
Self::NotPresent => write!(f, "resource not present"),
Self::WrongType => write!(f, "resource is of another type"),
Self::HasChildren => write!(f, "resource has children"),
}
}
}
#[cfg(feature = "std")]
impl std::error::Error for ResourceTableError {}
/// The `ResourceTable` type maps a `Resource<T>` to its `T`.
#[derive(Debug)]
pub struct ResourceTable {
entries: Vec<Entry>,
free_head: Option<usize>,
}
#[derive(Debug)]
enum Entry {
Free { next: Option<usize> },
Occupied { entry: TableEntry },
}
impl Entry {
pub fn occupied(&self) -> Option<&TableEntry> {
match self {
Self::Occupied { entry } => Some(entry),
Self::Free { .. } => None,
}
}
pub fn occupied_mut(&mut self) -> Option<&mut TableEntry> {
match self {
Self::Occupied { entry } => Some(entry),
Self::Free { .. } => None,
}
}
}
/// This structure tracks parent and child relationships for a given table entry.
///
/// Parents and children are referred to by table index. We maintain the
/// following invariants to prevent orphans and cycles:
/// * parent can only be assigned on creating the entry.
/// * parent, if some, must exist when creating the entry.
/// * whenever a child is created, its index is added to children.
/// * whenever a child is deleted, its index is removed from children.
/// * an entry with children may not be deleted.
#[derive(Debug)]
struct TableEntry {
/// The entry in the table, as a boxed dynamically-typed object
entry: Box<dyn Any + Send>,
/// The index of the parent of this entry, if it has one.
parent: Option<u32>,
/// The indices of any children of this entry.
children: BTreeSet<u32>,
}
impl TableEntry {
fn new(entry: Box<dyn Any + Send>, parent: Option<u32>) -> Self {
Self {
entry,
parent,
children: BTreeSet::new(),
}
}
fn add_child(&mut self, child: u32) {
debug_assert!(!self.children.contains(&child));
self.children.insert(child);
}
fn remove_child(&mut self, child: u32) {
let was_removed = self.children.remove(&child);
debug_assert!(was_removed);
}
}
impl ResourceTable {
/// Create an empty table
pub fn new() -> Self {
ResourceTable {
entries: Vec::new(),
free_head: None,
}
}
/// Create an empty table with at least the specified capacity.
pub fn with_capacity(capacity: usize) -> Self {
ResourceTable {
entries: Vec::with_capacity(capacity),
free_head: None,
}
}
/// Inserts a new value `T` into this table, returning a corresponding
/// `Resource<T>` which can be used to refer to it after it was inserted.
pub fn push<T>(&mut self, entry: T) -> Result<Resource<T>, ResourceTableError>
where
T: Send + 'static,
{
let idx = self.push_(TableEntry::new(Box::new(entry), None))?;
Ok(Resource::new_own(idx))
}
/// Pop an index off of the free list, if it's not empty.
fn pop_free_list(&mut self) -> Option<usize> {
if let Some(ix) = self.free_head {
// Advance free_head to the next entry if one is available.
match &self.entries[ix] {
Entry::Free { next } => self.free_head = *next,
Entry::Occupied { .. } => unreachable!(),
}
Some(ix)
} else {
None
}
}
/// Free an entry in the table, returning its [`TableEntry`]. Add the index to the free list.
fn free_entry(&mut self, ix: usize) -> TableEntry {
let entry = match core::mem::replace(
&mut self.entries[ix],
Entry::Free {
next: self.free_head,
},
) {
Entry::Occupied { entry } => entry,
Entry::Free { .. } => unreachable!(),
};
self.free_head = Some(ix);
entry
}
/// Push a new entry into the table, returning its handle. This will prefer to use free entries
/// if they exist, falling back on pushing new entries onto the end of the table.
fn push_(&mut self, e: TableEntry) -> Result<u32, ResourceTableError> {
if let Some(free) = self.pop_free_list() {
self.entries[free] = Entry::Occupied { entry: e };
Ok(free.try_into().unwrap())
} else {
let ix = self
.entries
.len()
.try_into()
.map_err(|_| ResourceTableError::Full)?;
self.entries.push(Entry::Occupied { entry: e });
Ok(ix)
}
}
fn occupied(&self, key: u32) -> Result<&TableEntry, ResourceTableError> {
self.entries
.get(key as usize)
.and_then(Entry::occupied)
.ok_or(ResourceTableError::NotPresent)
}
fn occupied_mut(&mut self, key: u32) -> Result<&mut TableEntry, ResourceTableError> {
self.entries
.get_mut(key as usize)
.and_then(Entry::occupied_mut)
.ok_or(ResourceTableError::NotPresent)
}
/// Insert a resource at the next available index, and track that it has a
/// parent resource.
///
/// The parent must exist to create a child. All children resources must
/// be destroyed before a parent can be destroyed - otherwise
/// [`ResourceTable::delete`] will fail with
/// [`ResourceTableError::HasChildren`].
///
/// Parent-child relationships are tracked inside the table to ensure that
/// a parent resource is not deleted while it has live children. This
/// allows child resources to hold "references" to a parent by table
/// index, to avoid needing e.g. an `Arc<Mutex<parent>>` and the associated
/// locking overhead and design issues, such as child existence extending
/// lifetime of parent referent even after parent resource is destroyed,
/// possibility for deadlocks.
///
/// Parent-child relationships may not be modified once created. There
/// is no way to observe these relationships through the [`ResourceTable`]
/// methods except for erroring on deletion, or the [`std::fmt::Debug`]
/// impl.
pub fn push_child<T, U>(
&mut self,
entry: T,
parent: &Resource<U>,
) -> Result<Resource<T>, ResourceTableError>
where
T: Send + 'static,
U: 'static,
{
let parent = parent.rep();
self.occupied(parent)?;
let child = self.push_(TableEntry::new(Box::new(entry), Some(parent)))?;
self.occupied_mut(parent)?.add_child(child);
Ok(Resource::new_own(child))
}
/// Get an immutable reference to a resource of a given type at a given
/// index.
///
/// Multiple shared references can be borrowed at any given time.
pub fn get<T: Any + Sized>(&self, key: &Resource<T>) -> Result<&T, ResourceTableError> {
self.get_(key.rep())?
.downcast_ref()
.ok_or(ResourceTableError::WrongType)
}
fn get_(&self, key: u32) -> Result<&dyn Any, ResourceTableError> {
let r = self.occupied(key)?;
Ok(&*r.entry)
}
/// Get an mutable reference to a resource of a given type at a given
/// index.
pub fn get_mut<T: Any + Sized>(
&mut self,
key: &Resource<T>,
) -> Result<&mut T, ResourceTableError> {
self.get_any_mut(key.rep())?
.downcast_mut()
.ok_or(ResourceTableError::WrongType)
}
/// Returns the raw `Any` at the `key` index provided.
pub fn get_any_mut(&mut self, key: u32) -> Result<&mut dyn Any, ResourceTableError> {
let r = self.occupied_mut(key)?;
Ok(&mut *r.entry)
}
/// Same as `delete`, but typed
pub fn delete<T>(&mut self, resource: Resource<T>) -> Result<T, ResourceTableError>
where
T: Any,
{
debug_assert!(resource.owned());
let entry = self.delete_entry(resource.rep())?;
match entry.entry.downcast() {
Ok(t) => Ok(*t),
Err(_e) => Err(ResourceTableError::WrongType),
}
}
fn delete_entry(&mut self, key: u32) -> Result<TableEntry, ResourceTableError> {
if !self.occupied(key)?.children.is_empty() {
return Err(ResourceTableError::HasChildren);
}
let e = self.free_entry(key as usize);
if let Some(parent) = e.parent {
// Remove deleted resource from parent's child list.
// Parent must still be present because it can't be deleted while still having
// children:
self.occupied_mut(parent)
.expect("missing parent")
.remove_child(key);
}
Ok(e)
}
/// Zip the values of the map with mutable references to table entries corresponding to each
/// key. As the keys in the `HashMap` are unique, this iterator can give mutable references
/// with the same lifetime as the mutable reference to the [ResourceTable].
#[cfg(feature = "std")]
pub fn iter_entries<'a, T>(
&'a mut self,
map: std::collections::HashMap<u32, T>,
) -> impl Iterator<Item = (Result<&'a mut dyn Any, ResourceTableError>, T)> {
map.into_iter().map(move |(k, v)| {
let item = self
.occupied_mut(k)
.map(|e| Box::as_mut(&mut e.entry))
// Safety: extending the lifetime of the mutable reference.
.map(|item| unsafe { &mut *(item as *mut dyn Any) });
(item, v)
})
}
/// Iterate over all children belonging to the provided parent
pub fn iter_children<T>(
&self,
parent: &Resource<T>,
) -> Result<impl Iterator<Item = &(dyn Any + Send)>, ResourceTableError>
where
T: 'static,
{
let parent_entry = self.occupied(parent.rep())?;
Ok(parent_entry.children.iter().map(|child_index| {
let child = self.occupied(*child_index).expect("missing child");
child.entry.as_ref()
}))
}
}
impl Default for ResourceTable {
fn default() -> Self {
ResourceTable::new()
}
}
#[test]
pub fn test_free_list() {
let mut table = ResourceTable::new();
let x = table.push(()).unwrap();
assert_eq!(x.rep(), 0);
let y = table.push(()).unwrap();
assert_eq!(y.rep(), 1);
// Deleting x should put it on the free list, so the next entry should have the same rep.
table.delete(x).unwrap();
let x = table.push(()).unwrap();
assert_eq!(x.rep(), 0);
// Deleting x and then y should yield indices 1 and then 0 for new entries.
table.delete(x).unwrap();
table.delete(y).unwrap();
let y = table.push(()).unwrap();
assert_eq!(y.rep(), 1);
let x = table.push(()).unwrap();
assert_eq!(x.rep(), 0);
// As the free list is empty, this entry will have a new id.
let x = table.push(()).unwrap();
assert_eq!(x.rep(), 2);
}