Struct NamespaceNode 

pub struct NamespaceNode {
    pub mount: MountInfo,
    pub entry: DirEntryHandle,
}

A node in a mount namespace.

This tree is a composite of the mount tree and the FsNode tree.

These nodes are used when traversing paths in a namespace in order to present the client the directory structure that includes the mounted filesystems.

Fields

mount: MountInfo

The mount where this namespace node is mounted.

A given FsNode can be mounted in multiple places in a namespace. This field distinguishes between them.

entry: DirEntryHandle

The FsNode that corresponds to this namespace entry.

Implementations

impl NamespaceNode

pub fn new(mount: Arc<Mount>, entry: DirEntryHandle) -> Self

pub fn new_anonymous(entry: DirEntryHandle) -> Self

Create a namespace node that is not mounted in a namespace.

pub fn new_anonymous_unrooted( current_task: &CurrentTask, node: FsNodeHandle, ) -> Self

Create a namespace node that is not mounted in a namespace and that refers to a node that is not rooted in a hierarchy and has no name.

pub fn open( &self, locked: &mut Locked<Unlocked>, current_task: &CurrentTask, flags: OpenFlags, access_check: AccessCheck, ) -> Result<FileHandle, Errno>

Create a FileObject corresponding to this namespace node.

This function is the primary way of instantiating FileObjects. Each FileObject records the NamespaceNode that created it in order to remember its path in the Namespace.

pub fn open_create_node<L>( &self, locked: &mut Locked<L>, current_task: &CurrentTask, name: &FsStr, mode: FileMode, dev: DeviceType, flags: OpenFlags, ) -> Result<NamespaceNode, Errno>

where L: LockEqualOrBefore<FileOpsCore>,

Create or open a node in the file system.

Works for any type of node other than a symlink.

Will return an existing node unless flags contains OpenFlags::EXCL.

pub fn into_active(self) -> ActiveNamespaceNode

pub fn into_mapping( self, mode: Option<FileWriteGuardMode>, ) -> Result<Arc<FileMapping>, Errno>

pub fn create_node<L>( &self, locked: &mut Locked<L>, current_task: &CurrentTask, name: &FsStr, mode: FileMode, dev: DeviceType, ) -> Result<NamespaceNode, Errno>

where L: LockEqualOrBefore<FileOpsCore>,

Create a node in the file system.

Works for any type of node other than a symlink.

Does not return an existing node.

pub fn create_symlink<L>( &self, locked: &mut Locked<L>, current_task: &CurrentTask, name: &FsStr, target: &FsStr, ) -> Result<NamespaceNode, Errno>

where L: LockEqualOrBefore<FileOpsCore>,

Create a symlink in the file system.

To create another type of node, use create_node.

pub fn create_tmpfile<L>( &self, locked: &mut Locked<L>, current_task: &CurrentTask, mode: FileMode, flags: OpenFlags, ) -> Result<NamespaceNode, Errno>

where L: LockEqualOrBefore<FileOpsCore>,

Creates an anonymous file.

The FileMode::IFMT of the FileMode is always FileMode::IFREG.

Used by O_TMPFILE.

pub fn link<L>( &self, locked: &mut Locked<L>, current_task: &CurrentTask, name: &FsStr, child: &FsNodeHandle, ) -> Result<NamespaceNode, Errno>

where L: LockEqualOrBefore<FileOpsCore>,

pub fn bind_socket<L>( &self, locked: &mut Locked<L>, current_task: &CurrentTask, name: &FsStr, socket: SocketHandle, socket_address: SocketAddress, mode: FileMode, ) -> Result<NamespaceNode, Errno>

where L: LockEqualOrBefore<FileOpsCore>,

pub fn unlink<L>( &self, locked: &mut Locked<L>, current_task: &CurrentTask, name: &FsStr, kind: UnlinkKind, must_be_directory: bool, ) -> Result<(), Errno>

where L: LockEqualOrBefore<FileOpsCore>,

pub fn lookup_child<L>( &self, locked: &mut Locked<L>, current_task: &CurrentTask, context: &mut LookupContext, basename: &FsStr, ) -> Result<NamespaceNode, Errno>

where L: LockEqualOrBefore<FileOpsCore>,

Traverse down a parent-to-child link in the namespace.

pub fn parent(&self) -> Option<NamespaceNode>

Traverse up a child-to-parent link in the namespace.

This traversal matches the child-to-parent link in the underlying FsNode except at mountpoints, where the link switches from one filesystem to another.

pub fn parent_within_mount(&self) -> Option<DirEntryHandle>

Returns the parent, but does not escape mounts i.e. returns None if this node is the root of a mount.

pub fn is_descendant_of(&self, ancestor: &NamespaceNode) -> bool

Whether this namespace node is a descendant of the given node.

Walks up the namespace node tree looking for ancestor. If ancestor is found, returns true. Otherwise, returns false.

pub fn mount_if_root(&self) -> Result<&Arc<Mount>, Errno>

If this node is the root of a mount, return it. Otherwise EINVAL.

pub fn path(&self, task: &Task) -> FsString

The path from the task’s root to this node.

pub fn path_escaping_chroot(&self) -> FsString

The path from the root of the namespace to this node.

pub fn path_from_root( &self, root: Option<&NamespaceNode>, ) -> PathWithReachability

Returns the path to this node, accounting for a custom root. A task may have a custom root set by chroot.

pub fn mount(&self, what: WhatToMount, flags: MountFlags) -> Result<(), Errno>

pub fn unmount(&self, flags: UnmountFlags) -> Result<(), Errno>

If this is the root of a filesystem, unmount. Otherwise return EINVAL.

pub fn rename<L>( locked: &mut Locked<L>, current_task: &CurrentTask, old_parent: &NamespaceNode, old_name: &FsStr, new_parent: &NamespaceNode, new_name: &FsStr, flags: RenameFlags, ) -> Result<(), Errno>

where L: LockEqualOrBefore<FileOpsCore>,

pub fn suid_and_sgid( &self, current_task: &CurrentTask, ) -> Result<UserAndOrGroupId, Errno>

pub fn update_atime(&self)

pub fn readlink<L>( &self, locked: &mut Locked<L>, current_task: &CurrentTask, ) -> Result<SymlinkTarget, Errno>

where L: LockEqualOrBefore<FileOpsCore>,

pub fn notify(&self, event_mask: InotifyMask)

pub fn check_access<L>( &self, locked: &mut Locked<L>, current_task: &CurrentTask, permission_flags: impl Into<PermissionFlags>, reason: CheckAccessReason, ) -> Result<(), Errno>

where L: LockEqualOrBefore<FileOpsCore>,

Check whether the node can be accessed in the current context with the specified access flags (read, write, or exec). Accounts for capabilities and whether the current user is the owner or is in the file’s group.

pub fn check_o_noatime_allowed( &self, current_task: &CurrentTask, ) -> Result<(), Errno>

Checks if O_NOATIME is allowed,

pub fn truncate<L>( &self, locked: &mut Locked<L>, current_task: &CurrentTask, length: u64, ) -> Result<(), Errno>

where L: LockBefore<BeforeFsNodeAppend>,

Trait Implementations

impl Clone for NamespaceNode

fn clone(&self) -> NamespaceNode

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for NamespaceNode

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a> From<&'a NamespaceNode> for Auditable<'a>

fn from(value: &'a NamespaceNode) -> Self

Converts to this type from the input type.

impl Hash for NamespaceNode

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for NamespaceNode

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for NamespaceNode