tvl-depot/tvix/eval/src/upvalues.rs
Adam Joseph 0649474206 fix(tvix/eval): remove impl PartialEq for Value
It isn't possible to implement PartialEq properly for Value, because
any sensible implementation needs to force() thunks, which cannot be
done without a `&mut VM`.

The existing derive(PartialEq) has false negatives, which caused the
bug which cl/7142 fixed.  Fortunately that bug was easy to find, but
a silent false negative deep within the bowels of nixpkgs could be a
real nightmare to hunt down.

Let's just remove the PartialEq impl for Value, and the other
derive(PartialEq)'s that depend on it.

Signed-off-by: Adam Joseph <adam@westernsemico.com>
Change-Id: Iacd3726fefc7fc1edadcd7e9b586e04cf8466775
Reviewed-on: https://cl.tvl.fyi/c/depot/+/7144
Reviewed-by: kanepyork <rikingcoding@gmail.com>
Reviewed-by: tazjin <tazjin@tvl.su>
Tested-by: BuildkiteCI
2022-11-04 00:30:13 +00:00

86 lines
2.8 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).
//!
//! The upvalues of a scope are whatever data are needed at runtime
//! in order to resolve each free variable in the scope to a value.
//! "Upvalue" is a term taken from Lua.
use std::ops::Index;
use crate::{opcode::UpvalueIdx, Value};
/// Structure for carrying upvalues of an UpvalueCarrier. The
/// implementation of this struct encapsulates the logic for
/// capturing and accessing upvalues.
///
/// Nix's `with` cannot be used to shadow an enclosing binding --
/// like Rust's `use xyz::*` construct, but unlike Javascript's
/// `with (xyz)`. This means that Nix has two kinds of identifiers,
/// which can be distinguished at compile time:
///
/// - Static identifiers, which are bound in some enclosing scope by
/// `let`, `name:` or `{name}:`
/// - Dynamic identifiers, which are not bound in any enclosing
/// scope
#[derive(Clone, Debug)]
pub struct Upvalues {
/// The upvalues of static identifiers. Each static identifier
/// is assigned an integer identifier at compile time, which is
/// an index into this Vec.
static_upvalues: Vec<Value>,
/// The upvalues of dynamic identifiers, if any exist. This
/// consists of the value passed to each enclosing `with val;`,
/// from outermost to innermost.
with_stack: Option<Vec<Value>>,
}
impl Upvalues {
pub fn with_capacity(count: usize) -> Self {
Upvalues {
static_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.static_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(),
}
}
/// Resolve deferred upvalues from the provided stack slice,
/// mutating them in the internal upvalue slots.
pub fn resolve_deferred_upvalues(&mut self, stack: &[Value]) {
for upvalue in self.static_upvalues.iter_mut() {
if let Value::DeferredUpvalue(update_from_idx) = upvalue {
*upvalue = stack[update_from_idx.0].clone();
}
}
}
}
impl Index<UpvalueIdx> for Upvalues {
type Output = Value;
fn index(&self, index: UpvalueIdx) -> &Self::Output {
&self.static_upvalues[index.0]
}
}