eryx-vfs 0.5.0

Virtual filesystem implementation for eryx sandbox
Documentation 
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
169
170
171
172
173
174

//! WASI filesystem bindings for hybrid VFS.
//!
//! This module generates bindings for the `wasi:filesystem` interfaces with
//! our hybrid descriptor type that can route to either VFS or real filesystem.
//!
//! ## When to use this vs `bindings`
//!
//! - Use **this module** (`hybrid_bindings`) when you need to mix VFS storage with
//!   real filesystem passthrough. Paths are routed based on prefix:
//!   - VFS paths (e.g., `/data/*`) go to in-memory `VfsStorage`
//!   - Real paths (e.g., `/python-stdlib/*`) pass through to the host filesystem
//!
//!   This is what `SessionExecutor` uses to allow Python stdlib access while
//!   keeping user data sandboxed in the VFS.
//!
//! - Use **`bindings`** when you want a pure in-memory VFS with no real filesystem
//!   access at all. Good for fully sandboxed environments.

// Re-export the HybridDescriptor from the hybrid module
pub use crate::hybrid::HybridDescriptor;

/// Error type for hybrid VFS filesystem operations.
#[derive(Debug)]
pub struct HybridFsError(pub crate::VfsError);

impl std::fmt::Display for HybridFsError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}", self.0)
    }
}

impl std::error::Error for HybridFsError {}

impl From<crate::VfsError> for HybridFsError {
    fn from(err: crate::VfsError) -> Self {
        HybridFsError(err)
    }
}

impl From<wasmtime::component::ResourceTableError> for HybridFsError {
    fn from(err: wasmtime::component::ResourceTableError) -> Self {
        HybridFsError(crate::VfsError::Io(err.to_string()))
    }
}

impl From<std::io::Error> for HybridFsError {
    fn from(err: std::io::Error) -> Self {
        HybridFsError(crate::VfsError::Io(err.to_string()))
    }
}

/// Iterator for hybrid directory entries.
pub struct HybridReaddirIterator {
    entries: std::vec::IntoIter<types::DirectoryEntry>,
}

impl std::fmt::Debug for HybridReaddirIterator {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("HybridReaddirIterator")
            .field("remaining", &self.entries.len())
            .finish()
    }
}

impl HybridReaddirIterator {
    /// Create a new iterator from a list of directory entries.
    pub fn new(entries: Vec<types::DirectoryEntry>) -> Self {
        Self {
            entries: entries.into_iter(),
        }
    }

    /// Get the next directory entry.
    #[allow(clippy::should_implement_trait)]
    pub fn next(&mut self) -> Option<types::DirectoryEntry> {
        self.entries.next()
    }
}

impl HybridFsError {
    /// Convert to WASI error code.
    pub fn downcast(self) -> wasmtime::Result<types::ErrorCode> {
        Ok(vfs_error_to_error_code(&self.0))
    }
}

/// Convert VfsError to WASI ErrorCode.
pub fn vfs_error_to_error_code(err: &crate::VfsError) -> types::ErrorCode {
    match err {
        crate::VfsError::NotFound(_) => types::ErrorCode::NoEntry,
        crate::VfsError::AlreadyExists(_) => types::ErrorCode::Exist,
        crate::VfsError::NotDirectory(_) => types::ErrorCode::NotDirectory,
        crate::VfsError::NotFile(_) => types::ErrorCode::IsDirectory,
        crate::VfsError::DirectoryNotEmpty(_) => types::ErrorCode::NotEmpty,
        crate::VfsError::PermissionDenied(_) => types::ErrorCode::NotPermitted,
        crate::VfsError::InvalidPath(_) => types::ErrorCode::Invalid,
        crate::VfsError::Io(_) => types::ErrorCode::Io,
        crate::VfsError::Storage(_) => types::ErrorCode::Io,
        crate::VfsError::InvalidSeek(_) => types::ErrorCode::Invalid,
        crate::VfsError::Busy(_) => types::ErrorCode::Busy,
    }
}

mod generated {
    pub use super::{HybridDescriptor, HybridFsError, HybridReaddirIterator};

    wasmtime::component::bindgen!({
        path: "wit",
        world: "virtual-filesystem",
        trappable_error_type: {
            "wasi:filesystem/types.error-code" => HybridFsError,
        },
        with: {
            // Map to our hybrid descriptor type
            "wasi:filesystem/types.descriptor": HybridDescriptor,
            "wasi:filesystem/types.directory-entry-stream": HybridReaddirIterator,
            // Use wasmtime-wasi-io for stream types
            "wasi:io/poll": wasmtime_wasi_io::bindings::wasi::io::poll,
            "wasi:io/streams": wasmtime_wasi_io::bindings::wasi::io::streams,
            "wasi:io/error": wasmtime_wasi_io::bindings::wasi::io::error,
            // Use wasmtime-wasi for clocks
            "wasi:clocks/wall-clock": wasmtime_wasi::p2::bindings::clocks::wall_clock,
        },
        imports: {
            "wasi:filesystem/types.[method]descriptor.advise": async | trappable,
            "wasi:filesystem/types.[method]descriptor.create-directory-at": async | trappable,
            "wasi:filesystem/types.[method]descriptor.get-flags": async | trappable,
            "wasi:filesystem/types.[method]descriptor.get-type": async | trappable,
            "wasi:filesystem/types.[method]descriptor.is-same-object": async | trappable,
            "wasi:filesystem/types.[method]descriptor.link-at": async | trappable,
            "wasi:filesystem/types.[method]descriptor.metadata-hash": async | trappable,
            "wasi:filesystem/types.[method]descriptor.metadata-hash-at": async | trappable,
            "wasi:filesystem/types.[method]descriptor.open-at": async | trappable,
            "wasi:filesystem/types.[method]descriptor.read": async | trappable,
            "wasi:filesystem/types.[method]descriptor.read-directory": async | trappable,
            "wasi:filesystem/types.[method]descriptor.readlink-at": async | trappable,
            "wasi:filesystem/types.[method]descriptor.remove-directory-at": async | trappable,
            "wasi:filesystem/types.[method]descriptor.rename-at": async | trappable,
            "wasi:filesystem/types.[method]descriptor.set-size": async | trappable,
            "wasi:filesystem/types.[method]descriptor.set-times": async | trappable,
            "wasi:filesystem/types.[method]descriptor.set-times-at": async | trappable,
            "wasi:filesystem/types.[method]descriptor.stat": async | trappable,
            "wasi:filesystem/types.[method]descriptor.stat-at": async | trappable,
            "wasi:filesystem/types.[method]descriptor.symlink-at": async | trappable,
            "wasi:filesystem/types.[method]descriptor.sync": async | trappable,
            "wasi:filesystem/types.[method]descriptor.sync-data": async | trappable,
            "wasi:filesystem/types.[method]descriptor.unlink-file-at": async | trappable,
            "wasi:filesystem/types.[method]descriptor.write": async | trappable,
            "wasi:filesystem/types.[method]directory-entry-stream.read-directory-entry": async | trappable,
            default: trappable,
        },
        require_store_data_send: true,
    });
}

pub use generated::wasi::filesystem::{preopens, types};

/// Result type for hybrid VFS filesystem operations.
pub type HybridFsResult<T> = Result<T, HybridFsError>;

// Re-export wasmtime-wasi types that we need
pub use wasmtime_wasi::{DirPerms, FilePerms};

use wasmtime::component::HasData;

use crate::hybrid::HybridVfsState;
use crate::storage::VfsStorage;

/// Marker type for implementing filesystem Host traits via HybridVfsState.
pub struct HybridFilesystem<S: VfsStorage + Clone + 'static>(std::marker::PhantomData<S>);

impl<S: VfsStorage + Clone + 'static> HasData for HybridFilesystem<S> {
    type Data<'a> = HybridVfsState<'a, S>;
}