Struct SocketFile 

pub struct SocketFile { /* private fields */ }

Implementations

impl SocketFile

pub fn from_socket<L>( locked: &mut Locked<L>, current_task: &CurrentTask, socket: SocketHandle, open_flags: OpenFlags, kernel_private: bool, ) -> Result<FileHandle, Errno>

where L: LockEqualOrBefore<FileOpsCore>,

Creates a FileHandle referring to a socket.

Parameters

• current_task: The current task.
• socket: The socket to refer to.
• open_flags: The OpenFlags which are used to create the FileObject.
• kernel_private: true if the socket will be used internally by the kernel, and should therefore not be security labeled nor access-checked.

pub fn new_socket<L>( locked: &mut Locked<L>, current_task: &CurrentTask, domain: SocketDomain, socket_type: SocketType, open_flags: OpenFlags, protocol: SocketProtocol, kernel_private: bool, ) -> Result<FileHandle, Errno>

where L: LockEqualOrBefore<FileOpsCore>,

Shortcut for Socket::new plus SocketFile::from_socket.

pub fn get_from_file( file: &FileHandle, ) -> Result<DowncastedFile<'_, Self>, Errno>

pub fn socket(&self) -> &SocketHandle

impl SocketFile

pub fn new(socket: SocketHandle) -> Box<Self>

pub fn sendmsg<L>( &self, locked: &mut Locked<L>, current_task: &CurrentTask, file: &FileObject, data: &mut dyn InputBuffer, dest_address: Option<SocketAddress>, ancillary_data: Vec<AncillaryData>, flags: SocketMessageFlags, ) -> Result<usize, Errno>

where L: LockEqualOrBefore<FileOpsCore>,

Writes the provided data into the socket in this file.

The provided control message is

Parameters

• task: The task that the user buffers belong to.
• file: The file that will be used for the blocking_op.
• data: The user buffers to read data from.
• control_bytes: Control message bytes to write to the socket.

pub fn recvmsg<L>( &self, locked: &mut Locked<L>, current_task: &CurrentTask, file: &FileObject, data: &mut dyn OutputBuffer, flags: SocketMessageFlags, deadline: Option<MonotonicInstant>, ) -> Result<MessageReadInfo, Errno>

where L: LockEqualOrBefore<FileOpsCore>,

Reads data from the socket in this file into data.

Parameters

• file: The file that will be used to wait if necessary.
• task: The task that the user buffers belong to.
• data: The user buffers to write to.

Returns the number of bytes read, as well as any control message that was encountered.

Trait Implementations

impl FileOps for SocketFile

fn to_handle( &self, file: &FileObject, current_task: &CurrentTask, ) -> Result<Option<NullableHandle>, Errno>

Return a handle that allows access to this file descritor through the zxio protocols.

If None is returned, the file will act as if it was a fd to /dev/null.

fn is_seekable(&self) -> bool

Returns whether the file is seekable.

fn seek( &self, _locked: &mut Locked<FileOpsCore>, _file: &FileObject, _current_task: &CurrentTask, _current_offset: off_t, _target: SeekTarget, ) -> Result<off_t, Errno>

Adjust the current_offset if the file is seekable.

fn sync( &self, file: &FileObject, _current_task: &CurrentTask, ) -> Result<(), Errno>

Syncs cached state associated with the file descriptor to persistent storage.

fn read( &self, locked: &mut Locked<FileOpsCore>, file: &FileObject, current_task: &CurrentTask, offset: usize, data: &mut dyn OutputBuffer, ) -> Result<usize, Errno>

Read from the file at an offset. If the file does not have persistent offsets (either directly, or because it is not seekable), offset will be 0 and can be ignored. Returns the number of bytes read.

fn write( &self, locked: &mut Locked<FileOpsCore>, file: &FileObject, current_task: &CurrentTask, offset: usize, data: &mut dyn InputBuffer, ) -> Result<usize, Errno>

Write to the file with an offset. If the file does not have persistent offsets (either directly, or because it is not seekable), offset will be 0 and can be ignored. Returns the number of bytes written.

fn wait_async( &self, locked: &mut Locked<FileOpsCore>, _file: &FileObject, current_task: &CurrentTask, waiter: &Waiter, events: FdEvents, handler: EventHandler, ) -> Option<WaitCanceler>

Establish a one-shot, edge-triggered, asynchronous wait for the given FdEvents for the given file and task. Returns None if this file does not support blocking waits.

fn query_events( &self, locked: &mut Locked<FileOpsCore>, _file: &FileObject, current_task: &CurrentTask, ) -> Result<FdEvents, Errno>

The events currently active on this file.

fn ioctl( &self, locked: &mut Locked<Unlocked>, file: &FileObject, current_task: &CurrentTask, request: u32, arg: SyscallArg, ) -> Result<SyscallResult, Errno>

fn close( self: Box<Self>, locked: &mut Locked<FileOpsCore>, _file: &FileObjectState, current_task: &CurrentTask, )

Called when the FileObject is destroyed.

fn open( &self, _locked: &mut Locked<FileOpsCore>, _file: &FileObject, _current_task: &CurrentTask, ) -> Result<(), Errno>

Called when the FileObject is opened/created

fn flush( &self, _locked: &mut Locked<FileOpsCore>, _file: &FileObject, _current_task: &CurrentTask, )

Called every time close() is called on this file, even if the file is not ready to be released.

fn has_persistent_offsets(&self) -> bool

Returns whether the file has meaningful seek offsets. Returning false is only optimization and will makes FileObject never hold the offset lock when calling read and write.

fn writes_update_seek_offset(&self) -> bool

Returns true if write() operations on the file will update the seek offset.

fn data_sync( &self, file: &FileObject, current_task: &CurrentTask, ) -> Result<(), Errno>

Syncs cached data, and only enough metadata to retrieve said data, to persistent storage.

fn get_memory( &self, _locked: &mut Locked<FileOpsCore>, _file: &FileObject, _current_task: &CurrentTask, _length: Option<usize>, _prot: ProtectionFlags, ) -> Result<Arc<MemoryObject>, Errno>

Returns a VMO representing this file. At least the requested protection flags must be set on the VMO. Reading or writing the VMO must read or write the file. If this is not possible given the requested protection, an error must be returned. The length is a hint for the desired size of the VMO. The returned VMO may be larger or smaller than the requested length. This method is typically called by Self::mmap.

fn mmap( &self, locked: &mut Locked<FileOpsCore>, file: &FileObject, current_task: &CurrentTask, addr: DesiredAddress, memory_offset: u64, length: usize, prot_flags: ProtectionFlags, options: MappingOptions, filename: NamespaceNode, ) -> Result<UserAddress, Errno>

Responds to an mmap call. The default implementation calls Self::get_memory to get a VMO and then maps it with [crate::mm::MemoryManager::map]. Only implement this trait method if your file needs to control mapping, or record where a VMO gets mapped.

fn readdir( &self, _locked: &mut Locked<FileOpsCore>, _file: &FileObject, _current_task: &CurrentTask, _sink: &mut dyn DirentSink, ) -> Result<(), Errno>

Respond to a getdents or getdents64 calls.

fn fcntl( &self, _file: &FileObject, _current_task: &CurrentTask, cmd: u32, _arg: u64, ) -> Result<SyscallResult, Errno>

fn as_thread_group_key( &self, _file: &FileObject, ) -> Result<ThreadGroupKey, Errno>

Returns the associated pid_t.

fn readahead( &self, _file: &FileObject, _current_task: &CurrentTask, _offset: usize, _length: usize, ) -> Result<(), Errno>

fn extra_fdinfo( &self, _locked: &mut Locked<FileOpsCore>, _file: &FileHandle, _current_task: &CurrentTask, ) -> Option<FsString>

Extra information that is included in the /proc//fdfino/ entry.