feat(tvix/eval/io): allow &mut self in EvalIO
It's okay if these calls mutate some internal state inside an implementation. Change-Id: I12bb11bde0310778c3da1275696bf7de058863a3 Reviewed-on: https://cl.tvl.fyi/c/depot/+/8571 Tested-by: BuildkiteCI Reviewed-by: tazjin <tazjin@tvl.su>
This commit is contained in:
parent
46ca98a7a2
commit
8bd7ced1fb
5 changed files with 34 additions and 29 deletions
1
tvix/Cargo.lock
generated
1
tvix/Cargo.lock
generated
|
@ -2708,6 +2708,7 @@ dependencies = [
|
||||||
"prost",
|
"prost",
|
||||||
"prost-build",
|
"prost-build",
|
||||||
"rayon",
|
"rayon",
|
||||||
|
"serde_json",
|
||||||
"sha2 0.10.6",
|
"sha2 0.10.6",
|
||||||
"sled",
|
"sled",
|
||||||
"tempfile",
|
"tempfile",
|
||||||
|
|
|
@ -40,7 +40,7 @@ impl EvalIO for NixCompatIO {
|
||||||
}
|
}
|
||||||
|
|
||||||
// Pass path imports through to `nix-store --add`
|
// Pass path imports through to `nix-store --add`
|
||||||
fn import_path(&self, path: &Path) -> Result<PathBuf, ErrorKind> {
|
fn import_path(&mut self, path: &Path) -> Result<PathBuf, ErrorKind> {
|
||||||
let path = path.to_owned();
|
let path = path.to_owned();
|
||||||
if let Some(path) = self.import_cache.borrow().get(&path) {
|
if let Some(path) = self.import_cache.borrow().get(&path) {
|
||||||
return Ok(path.to_path_buf());
|
return Ok(path.to_path_buf());
|
||||||
|
@ -58,7 +58,7 @@ impl EvalIO for NixCompatIO {
|
||||||
}
|
}
|
||||||
|
|
||||||
// Pass the rest of the functions through to `Self::underlying`
|
// Pass the rest of the functions through to `Self::underlying`
|
||||||
fn path_exists(&self, path: PathBuf) -> Result<bool, ErrorKind> {
|
fn path_exists(&mut self, path: PathBuf) -> Result<bool, ErrorKind> {
|
||||||
if path.starts_with("/__corepkgs__") {
|
if path.starts_with("/__corepkgs__") {
|
||||||
return Ok(true);
|
return Ok(true);
|
||||||
}
|
}
|
||||||
|
@ -66,7 +66,7 @@ impl EvalIO for NixCompatIO {
|
||||||
self.underlying.path_exists(path)
|
self.underlying.path_exists(path)
|
||||||
}
|
}
|
||||||
|
|
||||||
fn read_to_string(&self, path: PathBuf) -> Result<String, ErrorKind> {
|
fn read_to_string(&mut self, path: PathBuf) -> Result<String, ErrorKind> {
|
||||||
// Bundled version of corepkgs/fetchurl.nix. This workaround
|
// Bundled version of corepkgs/fetchurl.nix. This workaround
|
||||||
// is similar to what cppnix does for passing the path
|
// is similar to what cppnix does for passing the path
|
||||||
// through.
|
// through.
|
||||||
|
@ -80,7 +80,7 @@ impl EvalIO for NixCompatIO {
|
||||||
self.underlying.read_to_string(path)
|
self.underlying.read_to_string(path)
|
||||||
}
|
}
|
||||||
|
|
||||||
fn read_dir(&self, path: PathBuf) -> Result<Vec<(SmolStr, FileType)>, ErrorKind> {
|
fn read_dir(&mut self, path: PathBuf) -> Result<Vec<(SmolStr, FileType)>, ErrorKind> {
|
||||||
self.underlying.read_dir(path)
|
self.underlying.read_dir(path)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -34,14 +34,14 @@ pub enum FileType {
|
||||||
/// Defines how filesystem interaction occurs inside of tvix-eval.
|
/// Defines how filesystem interaction occurs inside of tvix-eval.
|
||||||
pub trait EvalIO {
|
pub trait EvalIO {
|
||||||
/// Verify whether the file at the specified path exists.
|
/// Verify whether the file at the specified path exists.
|
||||||
fn path_exists(&self, path: PathBuf) -> Result<bool, ErrorKind>;
|
fn path_exists(&mut self, path: PathBuf) -> Result<bool, ErrorKind>;
|
||||||
|
|
||||||
/// Read the file at the specified path to a string.
|
/// Read the file at the specified path to a string.
|
||||||
fn read_to_string(&self, path: PathBuf) -> Result<String, ErrorKind>;
|
fn read_to_string(&mut self, path: PathBuf) -> Result<String, ErrorKind>;
|
||||||
|
|
||||||
/// Read the directory at the specified path and return the names
|
/// Read the directory at the specified path and return the names
|
||||||
/// of its entries associated with their [`FileType`].
|
/// of its entries associated with their [`FileType`].
|
||||||
fn read_dir(&self, path: PathBuf) -> Result<Vec<(SmolStr, FileType)>, ErrorKind>;
|
fn read_dir(&mut self, path: PathBuf) -> Result<Vec<(SmolStr, FileType)>, ErrorKind>;
|
||||||
|
|
||||||
/// Import the given path. What this means depends on the
|
/// Import the given path. What this means depends on the
|
||||||
/// implementation, for example for a `std::io`-based
|
/// implementation, for example for a `std::io`-based
|
||||||
|
@ -50,7 +50,7 @@ pub trait EvalIO {
|
||||||
///
|
///
|
||||||
/// This is primarily used in the context of things like coercing
|
/// This is primarily used in the context of things like coercing
|
||||||
/// a local path to a string, or builtins like `path`.
|
/// a local path to a string, or builtins like `path`.
|
||||||
fn import_path(&self, path: &Path) -> Result<PathBuf, ErrorKind>;
|
fn import_path(&mut self, path: &Path) -> Result<PathBuf, ErrorKind>;
|
||||||
|
|
||||||
/// Returns the root of the store directory, if such a thing
|
/// Returns the root of the store directory, if such a thing
|
||||||
/// exists in the evaluation context.
|
/// exists in the evaluation context.
|
||||||
|
@ -66,21 +66,21 @@ pub struct StdIO;
|
||||||
|
|
||||||
#[cfg(feature = "impure")]
|
#[cfg(feature = "impure")]
|
||||||
impl EvalIO for StdIO {
|
impl EvalIO for StdIO {
|
||||||
fn path_exists(&self, path: PathBuf) -> Result<bool, ErrorKind> {
|
fn path_exists(&mut self, path: PathBuf) -> Result<bool, ErrorKind> {
|
||||||
path.try_exists().map_err(|e| ErrorKind::IO {
|
path.try_exists().map_err(|e| ErrorKind::IO {
|
||||||
path: Some(path),
|
path: Some(path),
|
||||||
error: Rc::new(e),
|
error: Rc::new(e),
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
fn read_to_string(&self, path: PathBuf) -> Result<String, ErrorKind> {
|
fn read_to_string(&mut self, path: PathBuf) -> Result<String, ErrorKind> {
|
||||||
std::fs::read_to_string(&path).map_err(|e| ErrorKind::IO {
|
std::fs::read_to_string(&path).map_err(|e| ErrorKind::IO {
|
||||||
path: Some(path),
|
path: Some(path),
|
||||||
error: Rc::new(e),
|
error: Rc::new(e),
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
fn read_dir(&self, path: PathBuf) -> Result<Vec<(SmolStr, FileType)>, ErrorKind> {
|
fn read_dir(&mut self, path: PathBuf) -> Result<Vec<(SmolStr, FileType)>, ErrorKind> {
|
||||||
let mut result = vec![];
|
let mut result = vec![];
|
||||||
|
|
||||||
let mk_err = |err| ErrorKind::IO {
|
let mk_err = |err| ErrorKind::IO {
|
||||||
|
@ -116,7 +116,7 @@ impl EvalIO for StdIO {
|
||||||
|
|
||||||
// this is a no-op for `std::io`, as the user can already refer to
|
// this is a no-op for `std::io`, as the user can already refer to
|
||||||
// the path directly
|
// the path directly
|
||||||
fn import_path(&self, path: &Path) -> Result<PathBuf, ErrorKind> {
|
fn import_path(&mut self, path: &Path) -> Result<PathBuf, ErrorKind> {
|
||||||
Ok(path.to_path_buf())
|
Ok(path.to_path_buf())
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -126,25 +126,25 @@ impl EvalIO for StdIO {
|
||||||
pub struct DummyIO;
|
pub struct DummyIO;
|
||||||
|
|
||||||
impl EvalIO for DummyIO {
|
impl EvalIO for DummyIO {
|
||||||
fn path_exists(&self, _: PathBuf) -> Result<bool, ErrorKind> {
|
fn path_exists(&mut self, _: PathBuf) -> Result<bool, ErrorKind> {
|
||||||
Err(ErrorKind::NotImplemented(
|
Err(ErrorKind::NotImplemented(
|
||||||
"I/O methods are not implemented in DummyIO",
|
"I/O methods are not implemented in DummyIO",
|
||||||
))
|
))
|
||||||
}
|
}
|
||||||
|
|
||||||
fn read_to_string(&self, _: PathBuf) -> Result<String, ErrorKind> {
|
fn read_to_string(&mut self, _: PathBuf) -> Result<String, ErrorKind> {
|
||||||
Err(ErrorKind::NotImplemented(
|
Err(ErrorKind::NotImplemented(
|
||||||
"I/O methods are not implemented in DummyIO",
|
"I/O methods are not implemented in DummyIO",
|
||||||
))
|
))
|
||||||
}
|
}
|
||||||
|
|
||||||
fn read_dir(&self, _: PathBuf) -> Result<Vec<(SmolStr, FileType)>, ErrorKind> {
|
fn read_dir(&mut self, _: PathBuf) -> Result<Vec<(SmolStr, FileType)>, ErrorKind> {
|
||||||
Err(ErrorKind::NotImplemented(
|
Err(ErrorKind::NotImplemented(
|
||||||
"I/O methods are not implemented in DummyIO",
|
"I/O methods are not implemented in DummyIO",
|
||||||
))
|
))
|
||||||
}
|
}
|
||||||
|
|
||||||
fn import_path(&self, _: &Path) -> Result<PathBuf, ErrorKind> {
|
fn import_path(&mut self, _: &Path) -> Result<PathBuf, ErrorKind> {
|
||||||
Err(ErrorKind::NotImplemented(
|
Err(ErrorKind::NotImplemented(
|
||||||
"I/O methods are not implemented in DummyIO",
|
"I/O methods are not implemented in DummyIO",
|
||||||
))
|
))
|
||||||
|
|
|
@ -63,7 +63,11 @@ impl NixSearchPathEntry {
|
||||||
///
|
///
|
||||||
/// For prefixed path, an entry matches if the prefix does.
|
/// For prefixed path, an entry matches if the prefix does.
|
||||||
// TODO(tazjin): verify these rules in the C++ impl, seems fishy.
|
// TODO(tazjin): verify these rules in the C++ impl, seems fishy.
|
||||||
fn resolve(&self, io: &dyn EvalIO, lookup_path: &Path) -> Result<Option<PathBuf>, ErrorKind> {
|
fn resolve(
|
||||||
|
&self,
|
||||||
|
io: &mut dyn EvalIO,
|
||||||
|
lookup_path: &Path,
|
||||||
|
) -> Result<Option<PathBuf>, ErrorKind> {
|
||||||
let path = match self {
|
let path = match self {
|
||||||
NixSearchPathEntry::Path(parent) => canonicalise(parent.join(lookup_path))?,
|
NixSearchPathEntry::Path(parent) => canonicalise(parent.join(lookup_path))?,
|
||||||
|
|
||||||
|
@ -112,7 +116,7 @@ pub struct NixSearchPath {
|
||||||
impl NixSearchPath {
|
impl NixSearchPath {
|
||||||
/// Attempt to resolve the given `path` within this [`NixSearchPath`] using the
|
/// Attempt to resolve the given `path` within this [`NixSearchPath`] using the
|
||||||
/// path resolution rules for `<...>`-style paths
|
/// path resolution rules for `<...>`-style paths
|
||||||
pub fn resolve<P>(&self, io: &dyn EvalIO, path: P) -> Result<PathBuf, ErrorKind>
|
pub fn resolve<P>(&self, io: &mut dyn EvalIO, path: P) -> Result<PathBuf, ErrorKind>
|
||||||
where
|
where
|
||||||
P: AsRef<Path>,
|
P: AsRef<Path>,
|
||||||
{
|
{
|
||||||
|
@ -188,16 +192,16 @@ mod tests {
|
||||||
#[test]
|
#[test]
|
||||||
fn simple_dir() {
|
fn simple_dir() {
|
||||||
let nix_search_path = NixSearchPath::from_str("./.").unwrap();
|
let nix_search_path = NixSearchPath::from_str("./.").unwrap();
|
||||||
let io = StdIO {};
|
let mut io = StdIO {};
|
||||||
let res = nix_search_path.resolve(&io, "src").unwrap();
|
let res = nix_search_path.resolve(&mut io, "src").unwrap();
|
||||||
assert_eq!(res, current_dir().unwrap().join("src").clean());
|
assert_eq!(res, current_dir().unwrap().join("src").clean());
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn failed_resolution() {
|
fn failed_resolution() {
|
||||||
let nix_search_path = NixSearchPath::from_str("./.").unwrap();
|
let nix_search_path = NixSearchPath::from_str("./.").unwrap();
|
||||||
let io = StdIO {};
|
let mut io = StdIO {};
|
||||||
let err = nix_search_path.resolve(&io, "nope").unwrap_err();
|
let err = nix_search_path.resolve(&mut io, "nope").unwrap_err();
|
||||||
assert!(
|
assert!(
|
||||||
matches!(err, ErrorKind::NixPathResolution(..)),
|
matches!(err, ErrorKind::NixPathResolution(..)),
|
||||||
"err = {err:?}"
|
"err = {err:?}"
|
||||||
|
@ -207,24 +211,24 @@ mod tests {
|
||||||
#[test]
|
#[test]
|
||||||
fn second_in_path() {
|
fn second_in_path() {
|
||||||
let nix_search_path = NixSearchPath::from_str("./.:/").unwrap();
|
let nix_search_path = NixSearchPath::from_str("./.:/").unwrap();
|
||||||
let io = StdIO {};
|
let mut io = StdIO {};
|
||||||
let res = nix_search_path.resolve(&io, "etc").unwrap();
|
let res = nix_search_path.resolve(&mut io, "etc").unwrap();
|
||||||
assert_eq!(res, Path::new("/etc"));
|
assert_eq!(res, Path::new("/etc"));
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn prefix() {
|
fn prefix() {
|
||||||
let nix_search_path = NixSearchPath::from_str("/:tvix=.").unwrap();
|
let nix_search_path = NixSearchPath::from_str("/:tvix=.").unwrap();
|
||||||
let io = StdIO {};
|
let mut io = StdIO {};
|
||||||
let res = nix_search_path.resolve(&io, "tvix/src").unwrap();
|
let res = nix_search_path.resolve(&mut io, "tvix/src").unwrap();
|
||||||
assert_eq!(res, current_dir().unwrap().join("src").clean());
|
assert_eq!(res, current_dir().unwrap().join("src").clean());
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn matching_prefix() {
|
fn matching_prefix() {
|
||||||
let nix_search_path = NixSearchPath::from_str("/:tvix=.").unwrap();
|
let nix_search_path = NixSearchPath::from_str("/:tvix=.").unwrap();
|
||||||
let io = StdIO {};
|
let mut io = StdIO {};
|
||||||
let res = nix_search_path.resolve(&io, "tvix").unwrap();
|
let res = nix_search_path.resolve(&mut io, "tvix").unwrap();
|
||||||
assert_eq!(res, current_dir().unwrap().clean());
|
assert_eq!(res, current_dir().unwrap().clean());
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -834,7 +834,7 @@ impl<'o> VM<'o> {
|
||||||
Value::UnresolvedPath(path) => {
|
Value::UnresolvedPath(path) => {
|
||||||
let resolved = self
|
let resolved = self
|
||||||
.nix_search_path
|
.nix_search_path
|
||||||
.resolve(&*self.io_handle, *path)
|
.resolve(&mut *self.io_handle, *path)
|
||||||
.with_span(&frame, self)?;
|
.with_span(&frame, self)?;
|
||||||
self.stack.push(resolved.into());
|
self.stack.push(resolved.into());
|
||||||
}
|
}
|
||||||
|
|
Loading…
Reference in a new issue