Class IoUringIoHandler

java.lang.Object

io.netty.channel.uring.IoUringIoHandler

All Implemented Interfaces:

IoHandler

public final class IoUringIoHandler
extends Object
implements IoHandler

IoHandler which is implemented in terms of the Linux-specific io_uring API.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private final class	IoUringIoHandler.DefaultIoUringIoRegistration

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	closeCompleted
private final FileDescriptor	eventfd
private static final long	EVENTFD_TOKEN
private final AtomicBoolean	eventfdAsyncNotify
private boolean	eventFdClosing
private final ByteBuffer	eventfdReadBuf
private final long	eventfdReadBufAddress
private final CleanableDirectBuffer	eventfdReadBufCleanable
private long	eventfdReadSubmitted
private final ThreadAwareExecutor	executor
private final byte[]	inet4AddressArray
private final byte[]	inet6AddressArray
private static final long	INVALID_ID
private final IovArray	iovArray
private final IovArrayReferenceCollector	iovArrayReferenceCollector
private static final int	KERNEL_TIMESPEC_SIZE
private static final int	KERNEL_TIMESPEC_TV_NSEC_FIELD
private static final int	KERNEL_TIMESPEC_TV_SEC_FIELD
private static final InternalLogger	logger
private final MsgHdrMemoryArray	msgHdrMemoryArray
private int	nextRegistrationId
private final PendingOpMap	pendingOps
private final IntObjectMap<IoUringBufferRing>	registeredIoUringBufferRing
private final IntObjectMap<IoUringIoHandler.DefaultIoUringIoRegistration>	registrations
private final RingBuffer	ringBuffer
private static final long	RINGFD_TOKEN
private boolean	shuttingDown
private final ByteBuffer	timeoutMemory
private final long	timeoutMemoryAddress
private final CleanableDirectBuffer	timeoutMemoryCleanable
private static final int	WAKEUP_CLOSED
private final AtomicInteger	wakeupWriters

Constructor Summary

Constructors

Constructor	Description
IoUringIoHandler(ThreadAwareExecutor executor, IoUringIoHandlerConfig config)

Method Summary

Modifier and Type	Method	Description
private static IoUringIoHandle	cast(IoHandle handle)
private void	closeWakeupGate()
private void	completeRingClose()
void	destroy()	Destroy the IoHandler and free all its resources.
private void	drainEventFd()
(package private) IoUringBufferRing	findBufferRing(short bgId)
private boolean	handle(int res, int flags, long udata, ByteBuffer extraCqeData)
private void	handleEventFdRead()
private void	handleFastPath(int res, int flags, long udata, ByteBuffer extraCqeData)
private static void	handleLoopException(Throwable throwable)
private void	handleSlowPath(int res, int flags, long udata, ByteBuffer extraCqeData)
(package private) byte[]	inet4AddressArray()	byte[] that can be used as temporary storage to encode the ipv4 address
(package private) byte[]	inet6AddressArray()	byte[] that can be used as temporary storage to encode the ipv6 address
void	initialize()	Initialize this IoHandler.
(package private) IovArray	iovArray()
(package private) IovArrayReferenceCollector	iovArrayReferenceCollector()	Returns the IovArrayReferenceCollector paired with iovArray().
boolean	isCompatible(Class<? extends IoHandle> handleType)	Returns true if the given type is compatible with this IoHandler and so can be registered, false otherwise.
(package private) MsgHdrMemoryArray	msgHdrMemoryArray()
private boolean	needSubmit(int sqFlags)
private static IoUringBufferRing	newBufferRing(int ringFd, IoUringBufferRingConfig bufferRingConfig)
static IoHandlerFactory	newFactory()	Create a new IoHandlerFactory that can be used to create IoUringIoHandlers.
static IoHandlerFactory	newFactory(int ringSize)	Create a new IoHandlerFactory that can be used to create IoUringIoHandlers.
static IoHandlerFactory	newFactory(IoUringIoHandlerConfig config)	Create a new IoHandlerFactory that can be used to create IoUringIoHandlers.
private int	nextRegistrationId()
void	prepareToDestroy()	Prepare to destroy this IoHandler.
private int	processCompletionsAndHandleOverflow(SubmissionQueue submissionQueue, CompletionQueue completionQueue, CompletionCallback callback)
IoRegistration	register(IoHandle handle)	Register a IoHandle for IO.
int	run(IoHandlerContext context)	Run the IO handled by this IoHandler.
private int	submitAndClearNow(SubmissionQueue submissionQueue)
private int	submitAndClearNow0(SubmissionQueue submissionQueue)
private int	submitAndWaitWithTimeout(SubmissionQueue submissionQueue, boolean linkTimeout, long timeoutNanoSeconds)
private void	submitEventFdRead()
(package private) int	submitIfFullAndGetRemaining()
private void	traceCompletion(IoUringIoHandler.DefaultIoUringIoRegistration registration, int registrationId, byte op, int res)
void	wakeup()	Wakeup the IoHandler, which means if any operation blocks it should be unblocked and return as soon as possible.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

logger

private static final InternalLogger logger

WAKEUP_CLOSED

private static final int WAKEUP_CLOSED

See Also:

• Constant Field Values

ringBuffer

private final RingBuffer ringBuffer

registeredIoUringBufferRing

private final IntObjectMap<IoUringBufferRing> registeredIoUringBufferRing

registrations

private final IntObjectMap<IoUringIoHandler.DefaultIoUringIoRegistration> registrations

inet4AddressArray

private final byte[] inet4AddressArray

inet6AddressArray

private final byte[] inet6AddressArray

eventfdAsyncNotify

private final AtomicBoolean eventfdAsyncNotify

wakeupWriters

private final AtomicInteger wakeupWriters

eventfd

private final FileDescriptor eventfd

eventfdReadBufCleanable

private final CleanableDirectBuffer eventfdReadBufCleanable

eventfdReadBuf

private final ByteBuffer eventfdReadBuf

eventfdReadBufAddress

private final long eventfdReadBufAddress

timeoutMemoryCleanable

private final CleanableDirectBuffer timeoutMemoryCleanable

timeoutMemory

private final ByteBuffer timeoutMemory

timeoutMemoryAddress

private final long timeoutMemoryAddress

iovArray

private final IovArray iovArray

iovArrayReferenceCollector

private final IovArrayReferenceCollector iovArrayReferenceCollector

msgHdrMemoryArray

private final MsgHdrMemoryArray msgHdrMemoryArray

eventfdReadSubmitted

private long eventfdReadSubmitted

eventFdClosing

private boolean eventFdClosing

shuttingDown

private volatile boolean shuttingDown

closeCompleted

private boolean closeCompleted

pendingOps

private final PendingOpMap pendingOps

nextRegistrationId

private int nextRegistrationId

INVALID_ID

private static final long INVALID_ID

See Also:

• Constant Field Values

EVENTFD_TOKEN

private static final long EVENTFD_TOKEN

RINGFD_TOKEN

private static final long RINGFD_TOKEN

KERNEL_TIMESPEC_SIZE

private static final int KERNEL_TIMESPEC_SIZE

See Also:

• Constant Field Values

KERNEL_TIMESPEC_TV_SEC_FIELD

private static final int KERNEL_TIMESPEC_TV_SEC_FIELD

See Also:

• Constant Field Values

KERNEL_TIMESPEC_TV_NSEC_FIELD

private static final int KERNEL_TIMESPEC_TV_NSEC_FIELD

See Also:

• Constant Field Values

executor

private final ThreadAwareExecutor executor

Constructor Details

IoUringIoHandler

IoUringIoHandler(ThreadAwareExecutor executor,
 IoUringIoHandlerConfig config)

Method Details

initialize

public void initialize()

Description copied from interface: IoHandler

Initialize this IoHandler.

Specified by:

initialize in interface IoHandler

run

public int run(IoHandlerContext context)

Description copied from interface: IoHandler

Run the IO handled by this IoHandler. The IoHandlerContext should be used to ensure we not execute too long and so block the processing of other task that are scheduled on the ThreadAwareExecutor. This is done by taking IoHandlerContext.delayNanos(long) or IoHandlerContext.deadlineNanos() into account.

Specified by:

run in interface IoHandler

Parameters:

context - the IoHandlerContext.

Returns:

the number of IoHandle for which I/O was handled. Internal events such as wakeups and timer expirations must not be included in this count.

submitIfFullAndGetRemaining

int submitIfFullAndGetRemaining()

needSubmit

private boolean needSubmit(int sqFlags)

processCompletionsAndHandleOverflow

private int processCompletionsAndHandleOverflow(SubmissionQueue submissionQueue,
 CompletionQueue completionQueue,
 CompletionCallback callback)

submitAndClearNow

private int submitAndClearNow(SubmissionQueue submissionQueue)

submitAndClearNow0

private int submitAndClearNow0(SubmissionQueue submissionQueue)

newBufferRing

private static IoUringBufferRing newBufferRing(int ringFd,
 IoUringBufferRingConfig bufferRingConfig)
                                        throws Errors.NativeIoException

Throws:

Errors.NativeIoException

findBufferRing

IoUringBufferRing findBufferRing(short bgId)

handleLoopException

private static void handleLoopException(Throwable throwable)

handle

private boolean handle(int res,
 int flags,
 long udata,
 ByteBuffer extraCqeData)

handleFastPath

private void handleFastPath(int res,
 int flags,
 long udata,
 ByteBuffer extraCqeData)

handleSlowPath

private void handleSlowPath(int res,
 int flags,
 long udata,
 ByteBuffer extraCqeData)

traceCompletion

private void traceCompletion(IoUringIoHandler.DefaultIoUringIoRegistration registration,
 int registrationId,
 byte op,
 int res)

handleEventFdRead

private void handleEventFdRead()

submitEventFdRead

private void submitEventFdRead()

submitAndWaitWithTimeout

private int submitAndWaitWithTimeout(SubmissionQueue submissionQueue,
 boolean linkTimeout,
 long timeoutNanoSeconds)

prepareToDestroy

public void prepareToDestroy()

Description copied from interface: IoHandler

Prepare to destroy this IoHandler. This method will be called before IoHandler.destroy() and may be called multiple times.

Specified by:

prepareToDestroy in interface IoHandler

destroy

public void destroy()

Description copied from interface: IoHandler

Destroy the IoHandler and free all its resources. Once destroyed using the IoHandler will cause undefined behaviour.

Specified by:

destroy in interface IoHandler

drainEventFd

private void drainEventFd()

completeRingClose

private void completeRingClose()

register

public IoRegistration register(IoHandle handle)
                        throws Exception

Description copied from interface: IoHandler

Register a IoHandle for IO.

Specified by:

register in interface IoHandler

Parameters:

handle - the IoHandle to register.

Throws:

Exception - thrown if an error happens during registration.

nextRegistrationId

private int nextRegistrationId()

cast

private static IoUringIoHandle cast(IoHandle handle)

wakeup

public void wakeup()

Description copied from interface: IoHandler

Wakeup the IoHandler, which means if any operation blocks it should be unblocked and return as soon as possible.

Specified by:

wakeup in interface IoHandler

closeWakeupGate

private void closeWakeupGate()

isCompatible

public boolean isCompatible(Class<? extends IoHandle> handleType)

Description copied from interface: IoHandler

Returns true if the given type is compatible with this IoHandler and so can be registered, false otherwise.

Specified by:

isCompatible in interface IoHandler

Parameters:

handleType - the type of the IoHandle.

Returns:

if compatible of not.

iovArray

IovArray iovArray()

iovArrayReferenceCollector

IovArrayReferenceCollector iovArrayReferenceCollector()

Returns the IovArrayReferenceCollector paired with iovArray(). A plain getter: callers are expected to have already called iovArray() to make room, so this must not itself submit-and-clear.

msgHdrMemoryArray

MsgHdrMemoryArray msgHdrMemoryArray()

inet4AddressArray

byte[] inet4AddressArray()

byte[] that can be used as temporary storage to encode the ipv4 address

inet6AddressArray

byte[] inet6AddressArray()

byte[] that can be used as temporary storage to encode the ipv6 address

newFactory

public static IoHandlerFactory newFactory()

Create a new IoHandlerFactory that can be used to create IoUringIoHandlers.

Returns:

factory

newFactory

public static IoHandlerFactory newFactory(int ringSize)

Create a new IoHandlerFactory that can be used to create IoUringIoHandlers. Each IoUringIoHandler will use a ring of size ringSize.

Parameters:

ringSize - the size of the ring.

Returns:

factory

newFactory

public static IoHandlerFactory newFactory(IoUringIoHandlerConfig config)

Create a new IoHandlerFactory that can be used to create IoUringIoHandlers. Each IoUringIoHandler will use same option

Parameters:

config - the io_uring configuration

Returns:

factory