tvl-depot/tvix/eval/src/upvalues.rs
Griffin Smith 915ff5ac2a refactor(tvix/eval): Don't (ab)use PartialEq for Nix equality
Using rust's PartialEq trait to implement Nix equality semantics is
reasonably fraught with peril, both because the actual laws are
different than what nix expects, and (more importantly) because certain
things actually require extra context to compare for equality (for
example, thunks need to be forced). This converts the manual PartialEq
impl for Value (and all its descendants) to a *derived* PartialEq
impl (which requires a lot of extra PartialEq derives on miscellanious
other types within the codebase), and converts the previous
nix-semantics equality comparison into a new `nix_eq` method. This
returns an EvalResult, even though it can't currently return an error,
to allow it to fail when eg forcing thunks (which it will do soon).

Since the PartialEq impls for Value and NixAttrs are now quite boring,
this converts the generated proptests for those into handwritten ones
that cover `nix_eq` instead

Change-Id: If3da7171f88c22eda5b7a60030d8b00c3b76f672
Reviewed-on: https://cl.tvl.fyi/c/depot/+/6650
Autosubmit: grfn <grfn@gws.fyi>
Tested-by: BuildkiteCI
Reviewed-by: tazjin <tazjin@tvl.su>
2022-09-18 22:03:41 +00:00

84 lines
2.3 KiB
Rust

//! This module encapsulates some logic for upvalue handling, which is
//! relevant to both thunks (delayed computations for lazy-evaluation)
//! as well as closures (lambdas that capture variables from the
//! surrounding scope).
use std::{
cell::{Ref, RefMut},
ops::Index,
};
use crate::{opcode::UpvalueIdx, Value};
/// Structure for carrying upvalues inside of thunks & closures. The
/// implementation of this struct encapsulates the logic for capturing
/// and accessing upvalues.
#[derive(Clone, Debug, PartialEq)]
pub struct Upvalues {
upvalues: Vec<Value>,
with_stack: Option<Vec<Value>>,
}
impl Upvalues {
pub fn with_capacity(count: usize) -> Self {
Upvalues {
upvalues: Vec::with_capacity(count),
with_stack: None,
}
}
/// Push an upvalue at the end of the upvalue list.
pub fn push(&mut self, value: Value) {
self.upvalues.push(value);
}
/// Set the captured with stack.
pub fn set_with_stack(&mut self, with_stack: Vec<Value>) {
self.with_stack = Some(with_stack);
}
pub fn with_stack(&self) -> Option<&Vec<Value>> {
self.with_stack.as_ref()
}
pub fn with_stack_len(&self) -> usize {
match &self.with_stack {
None => 0,
Some(stack) => stack.len(),
}
}
}
impl Index<UpvalueIdx> for Upvalues {
type Output = Value;
fn index(&self, index: UpvalueIdx) -> &Self::Output {
&self.upvalues[index.0]
}
}
/// `UpvalueCarrier` is implemented by all types that carry upvalues.
pub trait UpvalueCarrier {
fn upvalue_count(&self) -> usize;
/// Read-only accessor for the stored upvalues.
fn upvalues(&self) -> Ref<'_, Upvalues>;
/// Mutable accessor for stored upvalues.
fn upvalues_mut(&self) -> RefMut<'_, Upvalues>;
/// Read an upvalue at the given index.
fn upvalue(&self, idx: UpvalueIdx) -> Ref<'_, Value> {
Ref::map(self.upvalues(), |v| &v.upvalues[idx.0])
}
/// Resolve deferred upvalues from the provided stack slice,
/// mutating them in the internal upvalue slots.
fn resolve_deferred_upvalues(&self, stack: &[Value]) {
for upvalue in self.upvalues_mut().upvalues.iter_mut() {
if let Value::DeferredUpvalue(idx) = upvalue {
*upvalue = stack[idx.0].clone();
}
}
}
}