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
|
//! Interface for injecting I/O-related functionality into tvix-eval.
//!
//! The Nix language contains several builtins (e.g. `builtins.readDir`), as
//! well as language feature (e.g. string-"coercion" of paths) that interact
//! with the filesystem.
//!
//! The language evaluator implemented by this crate does not depend on any
//! particular filesystem interaction model. Instead, this module provides a
//! trait that can be implemented by tvix-eval callers to provide the
//! functionality they desire.
//!
//! In theory this can be used to implement "mocked" filesystem interactions, or
//! interaction with remote filesystems, etc.
//!
//! In the context of Nix builds, callers also use this interface to determine
//! how store paths are opened and so on.
use std::{
io,
path::{Path, PathBuf},
};
#[cfg(target_family = "unix")]
use std::os::unix::ffi::OsStringExt;
/// Types of files as represented by `builtins.readDir` in Nix.
#[derive(Debug)]
pub enum FileType {
Directory,
Regular,
Symlink,
Unknown,
}
/// Represents all possible filesystem interactions that exist in the Nix
/// language, and that need to be executed somehow.
///
/// This trait is specifically *only* concerned with what is visible on the
/// level of the language. All internal implementation details are not part of
/// this trait.
pub trait EvalIO {
/// Verify whether the file at the specified path exists.
///
/// This is used for the following language evaluation cases:
///
/// * checking whether a file added to the `NIX_PATH` actually exists when
/// it is referenced in `<...>` brackets.
/// * `builtins.pathExists :: path -> bool`
fn path_exists(&self, path: &Path) -> Result<bool, io::Error>;
/// Read the file at the specified path to a string.
///
/// This is used for the following language evaluation cases:
///
/// * `builtins.readFile :: path -> string`
/// * `builtins.import :: path -> any`
fn read_to_string(&self, path: &Path) -> Result<String, io::Error>;
/// Read the directory at the specified path and return the names
/// of its entries associated with their [`FileType`].
///
/// This is used for the following language evaluation cases:
///
/// * `builtins.readDir :: path -> attrs<filename, filetype>`
fn read_dir(&self, path: &Path) -> Result<Vec<(bytes::Bytes, FileType)>, io::Error>;
/// Import the given path. What this means depends on the implementation,
/// for example for a `std::io`-based implementation this might be a no-op,
/// while for a Tvix store this might be a copy of the given files to the
/// store.
///
/// This is used for the following language evaluation cases:
///
/// * string coercion of path literals (e.g. `/foo/bar`), which are expected
/// to return a path
/// * `builtins.toJSON` on a path literal, also expected to return a path
fn import_path(&self, path: &Path) -> Result<PathBuf, io::Error>;
/// Returns the root of the store directory, if such a thing
/// exists in the evaluation context.
///
/// This is used for the following language evaluation cases:
///
/// * `builtins.storeDir :: string`
fn store_dir(&self) -> Option<String> {
None
}
}
/// Implementation of [`EvalIO`] that simply uses the equivalent
/// standard library functions, i.e. does local file-IO.
#[cfg(feature = "impure")]
pub struct StdIO;
// TODO: we might want to make this whole impl to be target_family = "unix".
#[cfg(feature = "impure")]
impl EvalIO for StdIO {
fn path_exists(&self, path: &Path) -> Result<bool, io::Error> {
path.try_exists()
}
fn read_to_string(&self, path: &Path) -> Result<String, io::Error> {
std::fs::read_to_string(path)
}
fn read_dir(&self, path: &Path) -> Result<Vec<(bytes::Bytes, FileType)>, io::Error> {
let mut result = vec![];
for entry in path.read_dir()? {
let entry = entry?;
let file_type = entry.metadata()?.file_type();
let val = if file_type.is_dir() {
FileType::Directory
} else if file_type.is_file() {
FileType::Regular
} else if file_type.is_symlink() {
FileType::Symlink
} else {
FileType::Unknown
};
result.push((entry.file_name().into_vec().into(), val))
}
Ok(result)
}
// this is a no-op for `std::io`, as the user can already refer to
// the path directly
fn import_path(&self, path: &Path) -> Result<PathBuf, io::Error> {
Ok(path.to_path_buf())
}
}
/// Dummy implementation of [`EvalIO`], can be used in contexts where
/// IO is not available but code should "pretend" that it is.
pub struct DummyIO;
impl EvalIO for DummyIO {
fn path_exists(&self, _: &Path) -> Result<bool, io::Error> {
Err(io::Error::new(
io::ErrorKind::Unsupported,
"I/O methods are not implemented in DummyIO",
))
}
fn read_to_string(&self, _: &Path) -> Result<String, io::Error> {
Err(io::Error::new(
io::ErrorKind::Unsupported,
"I/O methods are not implemented in DummyIO",
))
}
fn read_dir(&self, _: &Path) -> Result<Vec<(bytes::Bytes, FileType)>, io::Error> {
Err(io::Error::new(
io::ErrorKind::Unsupported,
"I/O methods are not implemented in DummyIO",
))
}
fn import_path(&self, _: &Path) -> Result<PathBuf, io::Error> {
Err(io::Error::new(
io::ErrorKind::Unsupported,
"I/O methods are not implemented in DummyIO",
))
}
}
|
