Struct MemoryRegularNode 

pub struct MemoryRegularNode { /* private fields */ }

Implementations

impl MemoryRegularNode

pub fn new() -> Result<Self, Errno>

Create a new writable file node based on a blank VMO.

pub fn from_memory(memory: Arc<MemoryObject>) -> Self

Create a new file node based on an existing VMO. Attempts to open the file for writing will fail unless [memory] has both the WRITE and RESIZE rights.

Trait Implementations

impl FsNodeOps for MemoryRegularNode

fn lookup( &self, _node: &FsNode, _current_task: &CurrentTask, _name: &FsStr, ) -> Result<FsNodeHandle, Errno>

Find an existing child node and populate the child parameter. Return the node.

fn mknod( &self, _node: &FsNode, _current_task: &CurrentTask, _name: &FsStr, _mode: FileMode, _dev: DeviceId, _owner: FsCred, ) -> Result<FsNodeHandle, Errno>

Create and return the given child node.

fn mkdir( &self, _node: &FsNode, _current_task: &CurrentTask, _name: &FsStr, _mode: FileMode, _owner: FsCred, ) -> Result<FsNodeHandle, Errno>

Create and return the given child node as a subdirectory.

fn create_symlink( &self, _node: &FsNode, _current_task: &CurrentTask, _name: &FsStr, _target: &FsStr, _owner: FsCred, ) -> Result<FsNodeHandle, Errno>

Creates a symlink with the given target path.

fn unlink( &self, _node: &FsNode, _current_task: &CurrentTask, _name: &FsStr, _child: &FsNodeHandle, ) -> Result<(), Errno>

Remove the child with the given name, if the child exists.

fn get_xattr( &self, _node: &FsNode, _current_task: &CurrentTask, name: &FsStr, _size: usize, ) -> Result<ValueOrSize<FsString>, Errno>

Get an extended attribute on the node.

fn set_xattr( &self, _node: &FsNode, _current_task: &CurrentTask, name: &FsStr, value: &FsStr, op: XattrOp, ) -> Result<(), Errno>

Set an extended attribute on the node.

fn remove_xattr( &self, _node: &FsNode, _current_task: &CurrentTask, name: &FsStr, ) -> Result<(), Errno>

fn list_xattrs( &self, _node: &FsNode, _current_task: &CurrentTask, _size: usize, ) -> Result<ValueOrSize<Vec<FsString>>, Errno>

An implementation can systematically return a value. Otherwise, if max_size is 0, it can instead return the size of the 0 separated string needed to represent the value, and can return an ERANGE error if max_size is not 0, and lesser than the required size.

fn initial_info(&self, info: &mut FsNodeInfo)

Update the supplied info with initial state (e.g. size) for the node.

fn create_file_ops( &self, node: &FsNode, _current_task: &CurrentTask, flags: OpenFlags, ) -> Result<Box<dyn FileOps>, Errno>

Build the FileOps for the file associated to this node.

fn truncate( &self, _guard: &AppendLockWriteGuard<'_>, node: &FsNode, _current_task: &CurrentTask, length: u64, ) -> Result<(), Errno>

Change the length of the file.

fn allocate( &self, _guard: &AppendLockWriteGuard<'_>, node: &FsNode, _current_task: &CurrentTask, mode: FallocMode, offset: u64, length: u64, ) -> Result<(), Errno>

Manipulate allocated disk space for the file.

fn check_access( &self, node: &FsNode, current_task: &CurrentTask, access: PermissionFlags, info: &DynamicLockDepRwLock<FsNodeInfo>, reason: CheckAccessReason, audit_context: Auditable<'_>, ) -> Result<(), Errno>

Delegate the access check to the node.

fn create_dir_entry_ops(&self) -> Box<dyn DirEntryOps>

Build the DirEntryOps for a new [DirEntry] that will be associated to this node.

fn has_lookup_pipelined(&self) -> bool

Returns whether this node supports pipelined lookups.

fn lookup_pipelined( &self, _node: &FsNode, _current_task: &CurrentTask, _names: &[&FsStr], ) -> LookupVec<Result<FsNodeHandle, Errno>>

Find multiple children nodes in sequence.

fn create_tmpfile( &self, _node: &FsNode, _current_task: &CurrentTask, _mode: FileMode, _owner: FsCred, ) -> Result<FsNodeHandle, Errno>

Creates an anonymous file.

fn readlink( &self, _node: &FsNode, _current_task: &CurrentTask, ) -> Result<SymlinkTarget, Errno>

Reads the symlink from this node.

fn link( &self, _node: &FsNode, _current_task: &CurrentTask, _name: &FsStr, _child: &FsNodeHandle, ) -> Result<(), Errno>

Create a hard link with the given name to the given child.

fn append_lock_read<'a>( &'a self, node: &'a FsNode, current_task: &CurrentTask, ) -> Result<AppendLockGuard<'a>, Errno>

Acquire the necessary append lock for the operations that depend on them. Should be done before calling allocate or truncate to avoid lock ordering issues.

fn append_lock_write<'a>( &'a self, node: &'a FsNode, current_task: &CurrentTask, ) -> Result<AppendLockWriteGuard<'a>, Errno>

Acquire the necessary append lock for operations that need exclusive access (e.g., write append).

fn fetch_and_refresh_info<'a>( &self, _node: &FsNode, _current_task: &CurrentTask, info: &'a DynamicLockDepRwLock<FsNodeInfo>, ) -> Result<LockDepReadGuard<'a, FsNodeInfo>, Errno>

Update node.info as needed.

fn sync(&self, _node: &FsNode, _current_task: &CurrentTask) -> Result<(), Errno>

Syncs cached data to persistent storage.

fn update_attributes( &self, _node: &FsNode, _current_task: &CurrentTask, _info: &FsNodeInfo, _has: zxio_node_attr_has_t, ) -> Result<(), Errno>

Update node attributes persistently.

fn forget( self: Box<Self>, _current_task: &CurrentTask, _info: FsNodeInfo, ) -> Result<(), Errno>

Called when the FsNode is freed by the Kernel.

fn enable_fsverity( &self, _node: &FsNode, _current_task: &CurrentTask, _descriptor: &fsverity_descriptor, ) -> Result<(), Errno>

Marks that FS-Verity is being built. Writes fsverity descriptor and merkle tree, the latter computed by the filesystem. This should ensure there are no writable file handles. Returns EEXIST if the file was already fsverity-enabled. Returns EBUSY if this ioctl was already running on this file.

fn get_fsverity_descriptor( &self, _log_blocksize: u8, ) -> Result<fsverity_descriptor, Errno>

Read fsverity descriptor, if the node is fsverity-enabled. Else returns ENODATA.

fn node_key(&self, node: &FsNode) -> ino_t

The key used to identify this node in the file system’s node cache.

fn get_size( &self, node: &FsNode, current_task: &CurrentTask, ) -> Result<usize, Errno>

Returns the size of the file.