Struct Anon 

pub struct Anon { /* private fields */ }

Implementations

impl Anon

pub fn new_for_binder_device() -> Self

Returns a new Anon instance for use in a binder device FD.

pub fn new_for_socket(kernel_private: bool) -> Self

Returns a new Anon instance for use as the FsNodeOps of a socket.

pub fn new_file_extended<L>( locked: &mut Locked<L>, current_task: &CurrentTask, ops: Box<dyn FileOps>, flags: OpenFlags, name: &'static str, info: FsNodeInfo, ) -> Result<FileHandle, Errno>

where L: LockEqualOrBefore<FileOpsCore>,

Returns a new anonymous file with the specified properties, and a unique FsNode.

pub fn new_file<L>( locked: &mut Locked<L>, current_task: &CurrentTask, ops: Box<dyn FileOps>, flags: OpenFlags, name: &'static str, ) -> Result<FileHandle, Errno>

where L: LockEqualOrBefore<FileOpsCore>,

Returns a new anonymous file with the specified properties, and a unique FsNode.

pub fn new_private_file<L>( locked: &mut Locked<L>, current_task: &CurrentTask, ops: Box<dyn FileOps>, flags: OpenFlags, name: &'static str, ) -> FileHandle

where L: LockEqualOrBefore<FileOpsCore>,

Returns a new anonymous file backed by a single “private” FsNode, to which no security labeling nor access-checks will be applied.

pub fn new_private_file_extended<L>( locked: &mut Locked<L>, current_task: &CurrentTask, ops: Box<dyn FileOps>, flags: OpenFlags, name: &'static str, info: FsNodeInfo, ) -> FileHandle

where L: LockEqualOrBefore<FileOpsCore>,

Returns a new private anonymous file, applying caller-supplied info.

pub fn is_private(fs_node: &FsNode) -> bool

Returns true if the fs_node is Anon and private to the Kernel/FileSystem, in which case it should not have access checks applied by the LSM layer. This may become part of FsNodeOps in future, if other private node use-cases are found.

Trait Implementations

impl FsNodeOps for Anon

fn lookup( &self, _locked: &mut Locked<FileOpsCore>, _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, _locked: &mut Locked<FileOpsCore>, _node: &FsNode, _current_task: &CurrentTask, _name: &FsStr, _mode: FileMode, _dev: DeviceType, _owner: FsCred, ) -> Result<FsNodeHandle, Errno>

Create and return the given child node.

fn mkdir( &self, _locked: &mut Locked<FileOpsCore>, _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, _locked: &mut Locked<FileOpsCore>, _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, _locked: &mut Locked<FileOpsCore>, _node: &FsNode, _current_task: &CurrentTask, _name: &FsStr, _child: &FsNodeHandle, ) -> Result<(), Errno>

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

fn create_file_ops( &self, _locked: &mut Locked<FileOpsCore>, _node: &FsNode, _current_task: &CurrentTask, _flags: OpenFlags, ) -> Result<Box<dyn FileOps>, Errno>

Build the FileOps for the file associated to this node.

fn internal_name(&self, _node: &FsNode) -> Option<FsString>

Returns a descriptive name for this node, suitable to report to userspace in situations where the node’s path is unavailable (e.g. because it is anonymous, and has no path). If no name is returned then a default name of the form “<class:[<node_id>]” will be used.

fn check_access( &self, _locked: &mut Locked<FileOpsCore>, node: &FsNode, current_task: &CurrentTask, access: PermissionFlags, info: &RwLock<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 create_tmpfile( &self, _node: &FsNode, _current_task: &CurrentTask, _mode: FileMode, _owner: FsCred, ) -> Result<FsNodeHandle, Errno>

Creates an anonymous file.

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

Reads the symlink from this node.

fn link( &self, _locked: &mut Locked<FileOpsCore>, _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, locked: &'a mut Locked<BeforeFsNodeAppend>, node: &'a FsNode, current_task: &CurrentTask, ) -> Result<(RwQueueReadGuard<'a, FsNodeAppend>, &'a mut Locked<FsNodeAppend>), 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 truncate( &self, _locked: &mut Locked<FileOpsCore>, _guard: &AppendLockGuard<'_>, _node: &FsNode, _current_task: &CurrentTask, _length: u64, ) -> Result<(), Errno>

Change the length of the file.

fn allocate( &self, _locked: &mut Locked<FileOpsCore>, _guard: &AppendLockGuard<'_>, _node: &FsNode, _current_task: &CurrentTask, _mode: FallocMode, _offset: u64, _length: u64, ) -> Result<(), Errno>

Manipulate allocated disk space for the file.

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

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

fn fetch_and_refresh_info<'a>( &self, _locked: &mut Locked<FileOpsCore>, _node: &FsNode, _current_task: &CurrentTask, info: &'a RwLock<FsNodeInfo>, ) -> Result<RwLockReadGuard<'a, FsNodeInfo>, Errno>

Update node.info as needed.

fn update_attributes( &self, _locked: &mut Locked<FileOpsCore>, _current_task: &CurrentTask, _info: &FsNodeInfo, _has: zxio_node_attr_has_t, ) -> Result<(), Errno>

Update node attributes persistently.

fn get_xattr( &self, _locked: &mut Locked<FileOpsCore>, _node: &FsNode, _current_task: &CurrentTask, _name: &FsStr, _max_size: usize, ) -> Result<ValueOrSize<FsString>, Errno>

Get an extended attribute on the node.

fn set_xattr( &self, _locked: &mut Locked<FileOpsCore>, _node: &FsNode, _current_task: &CurrentTask, _name: &FsStr, _value: &FsStr, _op: XattrOp, ) -> Result<(), Errno>

Set an extended attribute on the node.

fn remove_xattr( &self, _locked: &mut Locked<FileOpsCore>, _node: &FsNode, _current_task: &CurrentTask, _name: &FsStr, ) -> Result<(), Errno>

fn list_xattrs( &self, _locked: &mut Locked<FileOpsCore>, _node: &FsNode, _current_task: &CurrentTask, _max_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 forget( self: Box<Self>, _locked: &mut Locked<FileOpsCore>, _current_task: &CurrentTask, _info: FsNodeInfo, ) -> Result<(), Errno>

Called when the FsNode is freed by the Kernel.

fn enable_fsverity( &self, _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.