Struct Epoll 

pub struct Epoll {
    interest_list: RefCell<BTreeMap<(FdId, i32), EpollEventInterest>>,
    ready_events: RefCell<VecDeque<(FdId, i32)>>,
    queue: RefCell<VecDeque<ThreadId>>,
}

An Epoll file descriptor connects file handles and epoll events

Fields

interest_list: RefCell<BTreeMap<(FdId, i32), EpollEventInterest>>

A map of EpollEventInterests registered under this epoll instance. Each entry is differentiated using FdId and file descriptor value.

ready_events: RefCell<VecDeque<(FdId, i32)>>

The subset of interests that is currently considered “ready”. Stored separately so we can access it more efficiently. This is implemented as a queue so that for level-triggered epoll, all events eventually get returned from epoll_wait. The queue does not contain any duplicates.

queue: RefCell<VecDeque<ThreadId>>

The queue of threads blocked on this epoll instance.

Trait Implementations

impl Debug for Epoll

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

Formats the value using the given formatter.

impl Default for Epoll

fn default() -> Epoll

Returns the “default value” for a type.

impl FileDescription for Epoll

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 destroy<'tcx>( self, self_id: FdId, _communicate_allowed: bool, ecx: &mut MiriInterpCx<'tcx>, ) -> InterpResult<'tcx, Result<()>>

Destroys the file description. Only called when the last duplicate file descriptor is closed.

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

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 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

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.

impl UnixFileDescription for Epoll

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<()>>

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 epoll_active_events<'tcx>(&self) -> InterpResult<'tcx, EpollReadiness>

Return which epoll events are currently active.

impl VisitProvenance for Epoll

fn visit_provenance(&self, _visit: &mut VisitWith<'_>)

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: 112 bytes