Struct VirtualSocket 

struct VirtualSocket {
    readbuf: Option<RefCell<Buffer>>,
    peer_fd: OnceCell<WeakFileDescriptionRef<VirtualSocket>>,
    peer_lost_data: Cell<bool>,
    blocked_read_tid: RefCell<Vec<ThreadId>>,
    blocked_write_tid: RefCell<Vec<ThreadId>>,
    is_nonblock: Cell<bool>,
    fd_type: VirtualSocketType,
    delayed_readiness_updates: Rc<DelayedReadinessUpdates>,
    watched: ReadinessWatched,
}

One end of a pair of connected virtual sockets.

Fields

readbuf: Option<RefCell<Buffer>>

The buffer we are reading from, or None if this is the writing end of a pipe. (In that case, the peer FD will be the reading end of that pipe.)

peer_fd: OnceCell<WeakFileDescriptionRef<VirtualSocket>>

The VirtualSocket file descriptor that is our “peer”, and that holds the buffer we are writing to. This is a weak reference because the other side may be closed before us; all future writes will then trigger EPIPE.

peer_lost_data: Cell<bool>

Indicates whether the peer has lost data when the file description is closed. This flag is set to true if the peer’s readbuf is non-empty at the time of closure.

blocked_read_tid: RefCell<Vec<ThreadId>>

A list of thread ids blocked because the buffer was empty. Once another thread writes some bytes, these threads will be unblocked.

blocked_write_tid: RefCell<Vec<ThreadId>>

A list of thread ids blocked because the buffer was full. Once another thread reads some bytes, these threads will be unblocked.

is_nonblock: Cell<bool>

Whether this fd is non-blocking or not.

fd_type: VirtualSocketType

Differentiate between different virtual socket fd types.

delayed_readiness_updates: Rc<DelayedReadinessUpdates>

We need to update the peer_fd readiness when we get dropped, so we keep a reference to the readiness update queue

watched: ReadinessWatched

State for being watched by epoll.

Implementations

impl VirtualSocket

fn peer_fd(&self) -> &WeakFileDescriptionRef<VirtualSocket>

Trait Implementations

impl Debug for VirtualSocket

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

Formats the value using the given formatter.

impl Drop for VirtualSocket

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl FileDescription for VirtualSocket

fn name(&self) -> &'static str

fn metadata<'tcx>( &self, ) -> InterpResult<'tcx, Either<Result<Metadata>, &'static str>>

Returns the metadata for this FD, if available. This is either host metadata, or a non-file-backed-FD type. The latter is for new represented as a string storing a libc name so we only support that kind of metadata on Unix targets.

fn read<'tcx>( self: FileDescriptionRef<Self>, _communicate_allowed: bool, ptr: Pointer, len: usize, ecx: &mut MiriInterpCx<'tcx>, finish: DynMachineCallback<'tcx, Result<usize, IoError>>, ) -> InterpResult<'tcx>

Reads as much as possible into the given buffer ptr. len indicates how many bytes we should try to read.

fn write<'tcx>( self: FileDescriptionRef<Self>, _communicate_allowed: bool, ptr: Pointer, len: usize, ecx: &mut MiriInterpCx<'tcx>, finish: DynMachineCallback<'tcx, Result<usize, IoError>>, ) -> InterpResult<'tcx>

Writes as much as possible from the given buffer ptr. len indicates how many bytes we should try to write.

fn short_fd_operations(&self) -> bool

Determines whether this FD non-deterministically has its reads and writes shortened.

fn as_unix<'tcx>( self: FileDescriptionRef<Self>, _ecx: &MiriInterpCx<'tcx>, ) -> FileDescriptionRef<dyn UnixFileDescription>

fn get_flags<'tcx>( &self, ecx: &mut MiriInterpCx<'tcx>, ) -> InterpResult<'tcx, Scalar>

Implementation of fcntl(F_GETFL) for this FD.

fn set_flags<'tcx>( &self, flag: i32, ecx: &mut MiriInterpCx<'tcx>, ) -> InterpResult<'tcx, Scalar>

Implementation of fcntl(F_SETFL) for this FD.

fn readiness_watched(&self) -> Option<&ReadinessWatched>

Get the ReadinessWatched of the file description.

fn readiness(&self) -> Readiness

Get the current I/O readiness of the file description.

fn seek<'tcx>( &self, _communicate_allowed: bool, _offset: SeekFrom, ) -> InterpResult<'tcx, Result<u64>>

Seeks to the given offset (which can be relative to the beginning, end, or current position). Returns the new position from the start of the stream.

fn is_tty(&self, _communicate_allowed: bool) -> bool

impl UnixFileDescription for VirtualSocket

fn ioctl<'tcx>( &self, op: Scalar, arg: Option<&OpTy<'tcx>>, ecx: &mut MiriInterpCx<'tcx>, ) -> InterpResult<'tcx, i32>

Modifies device parameters. op is the device-dependent operation code. It’s either a c_long or c_int, depending on the target and whether it uses glibc or musl. arg is the optional third argument which exists depending on the operation code. It’s either an integer or a pointer.

fn as_socket<'tcx>( self: FileDescriptionRef<Self>, _ecx: &MiriInterpCx<'tcx>, ) -> Option<FileDescriptionRef<dyn UnixSocketFileDescription>>

Returns this file description as a Unix socket, if it represents one.

fn pread<'tcx>( &self, _communicate_allowed: bool, _offset: u64, _ptr: Pointer, _len: usize, _ecx: &mut MiriInterpCx<'tcx>, _finish: DynMachineCallback<'tcx, Result<usize, IoError>>, ) -> InterpResult<'tcx>

Reads as much as possible into the given buffer ptr from a given offset. len indicates how many bytes we should try to read. dest is where the return value should be stored: number of bytes read, or -1 in case of error.

fn pwrite<'tcx>( &self, _communicate_allowed: bool, _ptr: Pointer, _len: usize, _offset: u64, _ecx: &mut MiriInterpCx<'tcx>, _finish: DynMachineCallback<'tcx, Result<usize, IoError>>, ) -> InterpResult<'tcx>

Writes as much as possible from the given buffer ptr starting at a given offset. ptr is the pointer to the user supplied read buffer. len indicates how many bytes we should try to write. dest is where the return value should be stored: number of bytes written, or -1 in case of error.

fn flock<'tcx>( &self, _communicate_allowed: bool, _op: FlockOp, ) -> InterpResult<'tcx, Result<()>>

impl UnixSocketFileDescription for VirtualSocket

fn send<'tcx>( self: FileDescriptionRef<Self>, _communicate_allowed: bool, ptr: Pointer, len: usize, is_non_block: bool, ecx: &mut MiriInterpCx<'tcx>, finish: DynMachineCallback<'tcx, Result<usize, IoError>>, ) -> InterpResult<'tcx>

Send data from the given buffer ptr into the socket. len indicates how many bytes we should try to send. is_non_block specifies whether the send operation is non-blocking. After a successful send, finish should be called with the amount of bytes sent.

fn recv<'tcx>( self: FileDescriptionRef<Self>, _communicate_allowed: bool, ptr: Pointer, len: usize, is_peek: bool, is_non_block: bool, ecx: &mut MiriInterpCx<'tcx>, finish: DynMachineCallback<'tcx, Result<usize, IoError>>, ) -> InterpResult<'tcx>

Receive data on the socket into the given buffer ptr. len indicates how many bytes we should try to receive. is_peek specifies whether the receive removes the bytes from the receive buffer (false) or leaves them in the receive buffer (true). is_non_block specifies whether the receive operation is non-blocking. After a successful receive, finish should be called with the amount of bytes received.

fn bind<'tcx>( self: FileDescriptionRef<Self>, _communicate_allowed: bool, _address: SocketAddr, _ecx: &mut MiriInterpCx<'tcx>, ) -> InterpResult<'tcx, Result<(), IoError>>

Bind the socket to address.

fn listen<'tcx>( self: FileDescriptionRef<Self>, _communicate_allowed: bool, _backlog: i32, _ecx: &mut MiriInterpCx<'tcx>, ) -> InterpResult<'tcx, Result<(), IoError>>

Start listening on the socket. backlog specifies how many pending incoming connections can exist at the same time before new requests are rejected.

fn accept<'tcx>( self: FileDescriptionRef<Self>, _communicate_allowed: bool, _is_client_sock_non_block: bool, _ecx: &mut MiriInterpCx<'tcx>, _finish: DynMachineCallback<'tcx, Result<(i32, SocketAddr), IoError>>, ) -> InterpResult<'tcx>

Accept an incoming connection on the socket. is_client_sock_non_block specifies whether the newly accepted client connection should be non-blocking. After a successful accept, finish should be called with a tuple containing the file descriptor of the peer socket and it’s address.

fn connect<'tcx>( self: FileDescriptionRef<Self>, _communicate_allowed: bool, _address: SocketAddr, _ecx: &mut MiriInterpCx<'tcx>, _finish: DynMachineCallback<'tcx, Result<(), IoError>>, ) -> InterpResult<'tcx>

Connect the socket to address.

fn setsockopt<'tcx>( self: FileDescriptionRef<Self>, _level: i32, _option: i32, _value_ptr: Pointer, _value_len: u64, _ecx: &mut MiriInterpCx<'tcx>, ) -> InterpResult<'tcx, Result<(), IoError>>

Set the socket option option on level. value_ptr points to the new value of the socket option, and value_len contains the amount of bytes the value uses at value_ptr.

fn getsockopt<'tcx>( self: FileDescriptionRef<Self>, _level: i32, _option: i32, _ecx: &mut MiriInterpCx<'tcx>, ) -> InterpResult<'tcx, Result<MPlaceTy<'tcx>, IoError>>

Get the value of a socket option option on level.

fn getsockname<'tcx>( self: FileDescriptionRef<Self>, _communicate_allowed: bool, _ecx: &mut MiriInterpCx<'tcx>, ) -> InterpResult<'tcx, Result<SocketAddr, IoError>>

Get the local address of the socket.

fn getpeername<'tcx>( self: FileDescriptionRef<Self>, _communicate_allowed: bool, _ecx: &mut MiriInterpCx<'tcx>, _finish: DynMachineCallback<'tcx, Result<SocketAddr, IoError>>, ) -> InterpResult<'tcx>

Get the remote address of the socket.

fn shutdown<'tcx>( self: FileDescriptionRef<Self>, _communicate_allowed: bool, _how: Shutdown, _ecx: &mut MiriInterpCx<'tcx>, ) -> InterpResult<'tcx, Result<(), IoError>>

Shut down the read and/or the write end of the socket.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 304 bytes