//! Garbage-collecting context for variables. use std::{ collections::HashMap, fmt::{self, Display, Formatter}, sync::{ atomic::{AtomicUsize, Ordering}, Arc, PoisonError, RwLock, RwLockReadGuard, RwLockWriteGuard, Weak, }, }; use crate::{Constructor, Identifier, StructType, Type, Value}; pub type Associations = HashMap; static ID_COUNTER: AtomicUsize = AtomicUsize::new(0); fn next_id() -> usize { ID_COUNTER.fetch_add(1, Ordering::SeqCst) } /// Garbage-collecting context for variables. #[derive(Debug, Clone)] pub struct Context { inner: Arc, } impl Context { pub fn new() -> Self { Self::with_data(HashMap::new()) } pub fn with_data(data: Associations) -> Self { Self { inner: Arc::new(ContextInner { associations: RwLock::new(data), parent: None, is_immutable: false, id: next_id(), }), } } pub fn with_data_immutable(data: Associations) -> Self { Self { inner: Arc::new(ContextInner { associations: RwLock::new(data), parent: None, is_immutable: true, id: next_id(), }), } } /// Creates a deep copy of another context. pub fn with_data_from(other: &Self) -> Result { let mut associations = HashMap::new(); for (identifier, (context_data, position)) in other.inner.associations.read()?.iter() { associations.insert(identifier.clone(), (context_data.clone(), *position)); } Ok(Self::with_data(associations)) } pub fn create_child(&self) -> Self { Self { inner: Arc::new(ContextInner { associations: RwLock::new(HashMap::new()), parent: Some(Arc::downgrade(&self.inner)), is_immutable: false, id: next_id(), }), } } pub fn id(&self) -> usize { self.inner.id } /// Returns the number of associated identifiers in the context. pub fn association_count(&self) -> Result { self.inner.association_count() } /// Returns a boolean indicating whether the identifier is in the context. pub fn contains(&self, identifier: &Identifier) -> Result { self.inner.contains(identifier) } /// Returns the full ContextData and Span if the context contains the given identifier. pub fn get( &self, identifier: &Identifier, ) -> Result, ContextError> { self.inner.get(identifier) } /// Returns the type associated with the given identifier. pub fn get_type(&self, identifier: &Identifier) -> Result, ContextError> { self.inner.get_type(identifier) } /// Returns the ContextData associated with the identifier. pub fn get_data(&self, identifier: &Identifier) -> Result, ContextError> { self.inner.get_data(identifier) } /// Returns the value associated with the identifier. pub fn get_variable_value( &self, identifier: &Identifier, ) -> Result, ContextError> { self.inner.get_variable_value(identifier) } /// Returns the constructor associated with the identifier. pub fn get_constructor( &self, identifier: &Identifier, ) -> Result, ContextError> { self.inner.get_constructor(identifier) } /// Returns the constructor type associated with the identifier. pub fn get_constructor_type( &self, identifier: &Identifier, ) -> Result, ContextError> { self.inner.get_constructor_type(identifier) } /// Associates an identifier with a variable type, with a position given for garbage collection. pub fn set_variable_type( &self, identifier: Identifier, r#type: Type, ) -> Result<(), ContextError> { self.inner.set_variable_type(identifier, r#type) } /// Associates an identifier with a variable value. pub fn set_variable_value( &self, identifier: Identifier, value: Value, ) -> Result<(), ContextError> { self.inner.set_variable_value(identifier, value) } /// Associates an identifier with a constructor. pub fn set_constructor( &self, identifier: Identifier, constructor: Constructor, ) -> Result<(), ContextError> { self.inner.set_constructor(identifier, constructor) } /// Associates an identifier with a constructor type, with a position given for garbage /// collection. pub fn set_constructor_type( &self, identifier: Identifier, struct_type: StructType, ) -> Result<(), ContextError> { self.inner.set_constructor_type(identifier, struct_type) } /// Collects garbage up to the given position, removing all variables with lesser positions. pub fn collect_garbage(&self, position: usize) -> Result<(), ContextError> { self.inner.collect_garbage(position) } /// Updates an associated identifier's last known position, allowing it to live longer in the /// program. Returns a boolean indicating whether the identifier was found. If the identifier is /// not found in the current context, the parent context is searched but parent context's /// position is not updated. pub fn set_position( &self, identifier: &Identifier, position: usize, ) -> Result { self.inner.set_position(identifier, position) } /// Recovers the context from a poisoned state by recovering data from an error. /// /// This method is not used. pub fn _recover_from_poison(&mut self, recovered: &RwLockReadGuard) { log::debug!("Context is recovering from poison error"); let mut new_associations = HashMap::new(); for (identifier, (context_data, position)) in recovered.iter() { new_associations.insert(identifier.clone(), (context_data.clone(), *position)); } self.inner = Arc::new(ContextInner { associations: RwLock::new(new_associations), parent: None, is_immutable: false, id: next_id(), }); } } impl Default for Context { fn default() -> Self { Self::new() } } #[derive(Debug)] pub struct ContextInner { id: usize, associations: RwLock, parent: Option>, is_immutable: bool, } impl ContextInner { fn parent(&self) -> Option> { self.parent.as_ref().and_then(|parent| parent.upgrade()) } /// Returns the number of associated identifiers in the context. pub fn association_count(&self) -> Result { Ok(self.associations.read()?.len()) } /// Returns a boolean indicating whether the identifier is in the context. pub fn contains(&self, identifier: &Identifier) -> Result { if self.associations.read()?.contains_key(identifier) { Ok(true) } else if let Some(parent) = &self.parent { if let Some(parent) = parent.upgrade() { parent.contains(identifier) } else { Ok(false) } } else { Ok(false) } } /// Returns the full ContextData and Span if the context contains the given identifier. pub fn get( &self, identifier: &Identifier, ) -> Result, ContextError> { if let Some((variable_data, position)) = self.associations.read()?.get(identifier) { return Ok(Some((variable_data.clone(), *position))); } else if let Some(parent) = &self.parent { if let Some(parent) = parent.upgrade() { return parent.get(identifier); } } Ok(None) } /// Returns the type associated with the given identifier. pub fn get_type(&self, identifier: &Identifier) -> Result, ContextError> { match self.associations.read()?.get(identifier) { Some((ContextData::VariableType(r#type), _)) => return Ok(Some(r#type.clone())), Some((ContextData::VariableValue(value), _)) => return Ok(Some(value.r#type())), Some((ContextData::ConstructorType(struct_type), _)) => { return Ok(Some(Type::Struct(struct_type.clone()))) } _ => {} } if let Some(parent) = &self.parent { if let Some(parent) = parent.upgrade() { return parent.get_type(identifier); } } Ok(None) } /// Returns the ContextData associated with the identifier. pub fn get_data(&self, identifier: &Identifier) -> Result, ContextError> { if let Some((variable_data, _)) = self.associations.read()?.get(identifier) { return Ok(Some(variable_data.clone())); } else if let Some(parent) = &self.parent { if let Some(parent) = parent.upgrade() { return parent.get_data(identifier); } } Ok(None) } /// Returns the value associated with the identifier. pub fn get_variable_value( &self, identifier: &Identifier, ) -> Result, ContextError> { if let Some((ContextData::VariableValue(value), _)) = self.associations.read()?.get(identifier) { return Ok(Some(value.clone())); } else if let Some(parent) = &self.parent { if let Some(parent) = parent.upgrade() { return parent.get_variable_value(identifier); } } Ok(None) } /// Returns the constructor associated with the identifier. pub fn get_constructor( &self, identifier: &Identifier, ) -> Result, ContextError> { if let Some((ContextData::Constructor(constructor), _)) = self.associations.read()?.get(identifier) { return Ok(Some(constructor.clone())); } else if let Some(parent) = &self.parent { if let Some(parent) = parent.upgrade() { return parent.get_constructor(identifier); } } Ok(None) } /// Returns the constructor type associated with the identifier. pub fn get_constructor_type( &self, identifier: &Identifier, ) -> Result, ContextError> { let read_associations = self.associations.read()?; if let Some((context_data, _)) = read_associations.get(identifier) { return match context_data { ContextData::Constructor(constructor) => Ok(Some(constructor.struct_type.clone())), ContextData::ConstructorType(struct_type) => Ok(Some(struct_type.clone())), _ => Ok(None), }; } else if let Some(parent) = &self.parent { if let Some(parent) = parent.upgrade() { return parent.get_constructor_type(identifier); } } Ok(None) } /// Associates an identifier with a variable type. pub fn set_variable_type( &self, identifier: Identifier, r#type: Type, ) -> Result<(), ContextError> { if self.is_immutable { return Err(ContextError::CannotMutateImmutableContext); } log::trace!("Setting {identifier} to type {type} in context {}", self.id); let mut associations = self.associations.write()?; let last_position = associations .get(&identifier) .map(|(_, last_position)| *last_position) .unwrap_or_default(); associations.insert( identifier, (ContextData::VariableType(r#type), last_position), ); Ok(()) } /// Associates an identifier with a variable value. pub fn set_variable_value( &self, identifier: Identifier, value: Value, ) -> Result<(), ContextError> { if self.is_immutable { return Err(ContextError::CannotMutateImmutableContext); } log::trace!( "Setting {identifier} to value {value} in context {}", self.id ); let mut associations = self.associations.write()?; let last_position = associations .get(&identifier) .map(|(_, last_position)| *last_position) .unwrap_or_default(); associations.insert( identifier, (ContextData::VariableValue(value), last_position), ); Ok(()) } /// Associates an identifier with a constructor. pub fn set_constructor( &self, identifier: Identifier, constructor: Constructor, ) -> Result<(), ContextError> { if self.is_immutable { return Err(ContextError::CannotMutateImmutableContext); } log::trace!( "Setting {identifier} to constructor {constructor:?} in context {}", self.id ); let mut associations = self.associations.write()?; let last_position = associations .get(&identifier) .map(|(_, last_position)| *last_position) .unwrap_or_default(); associations.insert( identifier, (ContextData::Constructor(constructor), last_position), ); Ok(()) } /// Associates an identifier with a constructor type, with a position given for garbage /// collection. pub fn set_constructor_type( &self, identifier: Identifier, struct_type: StructType, ) -> Result<(), ContextError> { if self.is_immutable { return Err(ContextError::CannotMutateImmutableContext); } log::trace!( "Setting {identifier} to constructor of type {struct_type} in context {}", self.id ); let mut variables = self.associations.write()?; let last_position = variables .get(&identifier) .map(|(_, last_position)| *last_position) .unwrap_or_default(); variables.insert( identifier, (ContextData::ConstructorType(struct_type), last_position), ); Ok(()) } /// Collects garbage up to the given position, removing all variables with lesser positions. pub fn collect_garbage(&self, position: usize) -> Result<(), ContextError> { if self.is_immutable { return Err(ContextError::CannotMutateImmutableContext); } log::trace!("Collecting garbage up to {position} in context {}", self.id); let mut variables = self.associations.write()?; variables.retain(|identifier, (_, last_used)| { let should_drop = position >= *last_used; if should_drop { log::trace!("Removing {identifier} from context {}", self.id); } !should_drop }); variables.shrink_to_fit(); Ok(()) } /// Updates an associated identifier's last known position, allowing it to live longer in the /// program. Returns a boolean indicating whether the identifier was found. If the identifier is /// not found in the current context, the parent context is searched but parent context's /// position is not updated. pub fn set_position( &self, identifier: &Identifier, position: usize, ) -> Result { let found = self.update_position_if_found(identifier, position)?; if found { return Ok(true); } let found_in_ancestor = if let Some(parent) = &self.parent() { if parent.is_immutable { false } else { parent.update_position_if_found(identifier, position)? } } else { false }; if found_in_ancestor { return Ok(true); } let mut associations = self.associations.write()?; log::trace!( "Reserving {identifier} at position {position:?} in context {}", self.id ); associations.insert(identifier.clone(), (ContextData::Reserved, position)); Ok(false) } fn update_position_if_found( &self, identifier: &Identifier, position: usize, ) -> Result { if self.is_immutable { return Err(ContextError::CannotMutateImmutableContext); } let mut associations = self.associations.write()?; if let Some((_, last_position)) = associations.get_mut(identifier) { log::trace!( "Updating {identifier}'s last position to {position:?} in context {}", self.id ); *last_position = position; Ok(true) } else { Ok(false) } } } #[derive(Debug, Clone)] pub enum ContextData { Constructor(Constructor), ConstructorType(StructType), VariableValue(Value), VariableType(Type), Reserved, } #[derive(Debug, Clone)] pub enum ContextError { CannotMutateImmutableContext, PoisonErrorRecovered(Arc), } impl From>> for ContextError { fn from(error: PoisonError>) -> Self { let associations = error.into_inner().clone(); Self::PoisonErrorRecovered(Arc::new(associations)) } } impl From>> for ContextError { fn from(error: PoisonError>) -> Self { let associations = error.into_inner().clone(); Self::PoisonErrorRecovered(Arc::new(associations)) } } impl PartialEq for ContextError { fn eq(&self, other: &Self) -> bool { match (self, other) { (Self::CannotMutateImmutableContext, Self::CannotMutateImmutableContext) => true, (Self::PoisonErrorRecovered(left), Self::PoisonErrorRecovered(right)) => { Arc::ptr_eq(left, right) } _ => false, } } } impl Display for ContextError { fn fmt(&self, f: &mut Formatter) -> fmt::Result { match self { Self::CannotMutateImmutableContext => write!(f, "Cannot mutate immutable context"), Self::PoisonErrorRecovered(associations) => { write!( f, "Context poisoned with {} associations recovered", associations.len() ) } } } } #[cfg(test)] mod tests { use crate::{parse, Vm}; use super::*; #[test] fn context_removes_variables() { let source = " let x = 5; let y = 10; let z = x + y; z "; let ast = parse(source).unwrap(); let context = ast.context.clone(); assert_eq!(Vm.run(ast), Ok(Some(Value::integer(15)))); assert_eq!(context.association_count().unwrap(), 0); } #[test] fn garbage_collector_does_not_break_loops() { let source = " let mut z = 0; while z < 10 { z += 1; } "; let ast = parse(source).unwrap(); let context = ast.context.clone(); assert_eq!(Vm.run(ast), Ok(None)); assert_eq!(context.association_count().unwrap(), 0); } }