1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16 package io.netty.channel.uring;
17
18 import io.netty.channel.DefaultFileRegion;
19 import io.netty.channel.unix.Buffer;
20 import io.netty.util.internal.ObjectUtil;
21 import io.netty.util.internal.logging.InternalLogger;
22 import io.netty.util.internal.logging.InternalLoggerFactory;
23 import io.netty.channel.unix.FileDescriptor;
24 import io.netty.channel.unix.PeerCredentials;
25 import io.netty.channel.unix.Unix;
26 import io.netty.util.internal.ClassInitializerUtil;
27 import io.netty.util.internal.NativeLibraryLoader;
28 import io.netty.util.internal.PlatformDependent;
29 import io.netty.util.internal.SystemPropertyUtil;
30 import io.netty.util.internal.ThrowableUtil;
31
32 import java.io.File;
33 import java.io.IOException;
34 import java.nio.channels.Selector;
35 import java.nio.file.Path;
36 import java.util.Arrays;
37 import java.util.Locale;
38
39 final class Native {
40 private static final InternalLogger logger = InternalLoggerFactory.getInstance(Native.class);
41
42 static {
43 Selector selector = null;
44 try {
45
46
47
48
49 selector = Selector.open();
50 } catch (IOException ignore) {
51
52 }
53
54
55
56
57
58
59 ClassInitializerUtil.tryLoadClasses(
60 Native.class,
61
62 PeerCredentials.class, java.io.FileDescriptor.class
63 );
64
65 File tmpDir = PlatformDependent.tmpdir();
66 Path tmpFile = tmpDir.toPath().resolve("netty_io_uring.tmp");
67 try {
68
69
70 Native.createFile(tmpFile.toString());
71 } catch (UnsatisfiedLinkError ignore) {
72
73 loadNativeLibrary();
74 } finally {
75 tmpFile.toFile().delete();
76 try {
77 if (selector != null) {
78 selector.close();
79 }
80 } catch (IOException ignore) {
81
82 }
83 }
84 Unix.registerInternal(Native::registerUnix);
85 }
86
87 static final int SOCK_NONBLOCK = NativeStaticallyReferencedJniMethods.sockNonblock();
88 static final int SOCK_CLOEXEC = NativeStaticallyReferencedJniMethods.sockCloexec();
89 static final short AF_INET = (short) NativeStaticallyReferencedJniMethods.afInet();
90 static final short AF_INET6 = (short) NativeStaticallyReferencedJniMethods.afInet6();
91 static final short AF_UNIX = (short) NativeStaticallyReferencedJniMethods.afUnix();
92 static final int SIZEOF_SOCKADDR_STORAGE = NativeStaticallyReferencedJniMethods.sizeofSockaddrStorage();
93 static final int SIZEOF_SOCKADDR_UN = NativeStaticallyReferencedJniMethods.sizeofSockaddrUn();
94 static final int SOCKADDR_UN_OFFSETOF_SUN_FAMILY =
95 NativeStaticallyReferencedJniMethods.sockaddrUnOffsetofSunFamily();
96 static final int SOCKADDR_UN_OFFSETOF_SUN_PATH =
97 NativeStaticallyReferencedJniMethods.sockaddrUnOffsetofSunPath();
98 static final int MAX_SUN_PATH_LEN =
99 NativeStaticallyReferencedJniMethods.maxSunPathLen();
100 static final int SIZEOF_SOCKADDR_IN = NativeStaticallyReferencedJniMethods.sizeofSockaddrIn();
101 static final int SIZEOF_SOCKADDR_IN6 = NativeStaticallyReferencedJniMethods.sizeofSockaddrIn6();
102 static final int SOCKADDR_IN_OFFSETOF_SIN_FAMILY =
103 NativeStaticallyReferencedJniMethods.sockaddrInOffsetofSinFamily();
104 static final int SOCKADDR_IN_OFFSETOF_SIN_PORT = NativeStaticallyReferencedJniMethods.sockaddrInOffsetofSinPort();
105 static final int SOCKADDR_IN_OFFSETOF_SIN_ADDR = NativeStaticallyReferencedJniMethods.sockaddrInOffsetofSinAddr();
106 static final int IN_ADDRESS_OFFSETOF_S_ADDR = NativeStaticallyReferencedJniMethods.inAddressOffsetofSAddr();
107 static final int SOCKADDR_IN6_OFFSETOF_SIN6_FAMILY =
108 NativeStaticallyReferencedJniMethods.sockaddrIn6OffsetofSin6Family();
109 static final int SOCKADDR_IN6_OFFSETOF_SIN6_PORT =
110 NativeStaticallyReferencedJniMethods.sockaddrIn6OffsetofSin6Port();
111 static final int SOCKADDR_IN6_OFFSETOF_SIN6_FLOWINFO =
112 NativeStaticallyReferencedJniMethods.sockaddrIn6OffsetofSin6Flowinfo();
113 static final int SOCKADDR_IN6_OFFSETOF_SIN6_ADDR =
114 NativeStaticallyReferencedJniMethods.sockaddrIn6OffsetofSin6Addr();
115 static final int SOCKADDR_IN6_OFFSETOF_SIN6_SCOPE_ID =
116 NativeStaticallyReferencedJniMethods.sockaddrIn6OffsetofSin6ScopeId();
117 static final int IN6_ADDRESS_OFFSETOF_S6_ADDR = NativeStaticallyReferencedJniMethods.in6AddressOffsetofS6Addr();
118 static final int SIZEOF_SIZE_T = NativeStaticallyReferencedJniMethods.sizeofSizeT();
119 static final int SIZEOF_IOVEC = NativeStaticallyReferencedJniMethods.sizeofIovec();
120 static final int CMSG_SPACE = NativeStaticallyReferencedJniMethods.cmsgSpace();
121 static final int CMSG_SPACE_FOR_FD = NativeStaticallyReferencedJniMethods.cmsgSpaceForFd();
122 static final int CMSG_LEN = NativeStaticallyReferencedJniMethods.cmsgLen();
123 static final int CMSG_LEN_FOR_FD = NativeStaticallyReferencedJniMethods.cmsgLenForFd();
124 static final int MSG_CONTROL_LEN_FOR_FD = NativeStaticallyReferencedJniMethods.msgControlLenForFd();
125 static final int CMSG_OFFSETOF_CMSG_LEN = NativeStaticallyReferencedJniMethods.cmsghdrOffsetofCmsgLen();
126 static final int CMSG_OFFSETOF_CMSG_LEVEL = NativeStaticallyReferencedJniMethods.cmsghdrOffsetofCmsgLevel();
127 static final int CMSG_OFFSETOF_CMSG_TYPE = NativeStaticallyReferencedJniMethods.cmsghdrOffsetofCmsgType();
128
129 static final int IO_URING_BUFFER_RING_TAIL = NativeStaticallyReferencedJniMethods.ioUringBufferRingOffsetTail();
130
131 static final int IOVEC_OFFSETOF_IOV_BASE = NativeStaticallyReferencedJniMethods.iovecOffsetofIovBase();
132 static final int IOVEC_OFFSETOF_IOV_LEN = NativeStaticallyReferencedJniMethods.iovecOffsetofIovLen();
133 static final int SIZEOF_MSGHDR = NativeStaticallyReferencedJniMethods.sizeofMsghdr();
134 static final int MSGHDR_OFFSETOF_MSG_NAME = NativeStaticallyReferencedJniMethods.msghdrOffsetofMsgName();
135 static final int MSGHDR_OFFSETOF_MSG_NAMELEN = NativeStaticallyReferencedJniMethods.msghdrOffsetofMsgNamelen();
136 static final int MSGHDR_OFFSETOF_MSG_IOV = NativeStaticallyReferencedJniMethods.msghdrOffsetofMsgIov();
137 static final int MSGHDR_OFFSETOF_MSG_IOVLEN = NativeStaticallyReferencedJniMethods.msghdrOffsetofMsgIovlen();
138 static final int MSGHDR_OFFSETOF_MSG_CONTROL = NativeStaticallyReferencedJniMethods.msghdrOffsetofMsgControl();
139 static final int MSGHDR_OFFSETOF_MSG_CONTROLLEN =
140 NativeStaticallyReferencedJniMethods.msghdrOffsetofMsgControllen();
141 static final int MSGHDR_OFFSETOF_MSG_FLAGS = NativeStaticallyReferencedJniMethods.msghdrOffsetofMsgFlags();
142 static final int POLLIN = NativeStaticallyReferencedJniMethods.pollin();
143 static final int POLLOUT = NativeStaticallyReferencedJniMethods.pollout();
144 static final int POLLRDHUP = NativeStaticallyReferencedJniMethods.pollrdhup();
145 static final int ERRNO_ECANCELED_NEGATIVE = -NativeStaticallyReferencedJniMethods.ecanceled();
146 static final int ERRNO_ETIME_NEGATIVE = -NativeStaticallyReferencedJniMethods.etime();
147 static final int ERRNO_NOBUFS_NEGATIVE = -NativeStaticallyReferencedJniMethods.enobufs();
148
149 static final int PAGE_SIZE = NativeStaticallyReferencedJniMethods.pageSize();
150 static final int MAX_SKB_FRAGS = NativeStaticallyReferencedJniMethods.maxSkbFrags();
151
152 static final int SIZEOF_IOURING_BUF = NativeStaticallyReferencedJniMethods.sizeofIoUringBuf();
153 static final int IOURING_BUFFER_OFFSETOF_ADDR = NativeStaticallyReferencedJniMethods.ioUringBufferOffsetAddr();
154 static final int IOURING_BUFFER_OFFSETOF_LEN = NativeStaticallyReferencedJniMethods.ioUringBufferOffsetLen();
155 static final int IOURING_BUFFER_OFFSETOF_BID = NativeStaticallyReferencedJniMethods.ioUringBufferOffsetBid();
156
157
158
159
160 static final byte IORING_OP_NOP = 0;
161 static final byte IORING_OP_READV = 1;
162 static final byte IORING_OP_WRITEV = 2;
163 static final byte IORING_OP_FSYNC = 3;
164 static final byte IORING_OP_READ_FIXED = 4;
165 static final byte IORING_OP_WRITE_FIXED = 5;
166 static final byte IORING_OP_POLL_ADD = 6;
167 static final byte IORING_OP_POLL_REMOVE = 7;
168 static final byte IORING_OP_SYNC_FILE_RANGE = 8;
169 static final byte IORING_OP_SENDMSG = 9;
170 static final byte IORING_OP_RECVMSG = 10;
171 static final byte IORING_OP_TIMEOUT = 11;
172 static final byte IORING_OP_TIMEOUT_REMOVE = 12;
173 static final byte IORING_OP_ACCEPT = 13;
174 static final byte IORING_OP_ASYNC_CANCEL = 14;
175 static final byte IORING_OP_LINK_TIMEOUT = 15;
176 static final byte IORING_OP_CONNECT = 16;
177 static final byte IORING_OP_FALLOCATE = 17;
178 static final byte IORING_OP_OPENAT = 18;
179 static final byte IORING_OP_CLOSE = 19;
180 static final byte IORING_OP_FILES_UPDATE = 20;
181 static final byte IORING_OP_STATX = 21;
182 static final byte IORING_OP_READ = 22;
183 static final byte IORING_OP_WRITE = 23;
184 static final byte IORING_OP_FADVISE = 24;
185 static final byte IORING_OP_MADVISE = 25;
186 static final byte IORING_OP_SEND = 26;
187 static final byte IORING_OP_RECV = 27;
188 static final byte IORING_OP_OPENAT2 = 28;
189 static final byte IORING_OP_EPOLL_CTL = 29;
190 static final byte IORING_OP_SPLICE = 30;
191 static final byte IORING_OP_PROVIDE_BUFFERS = 31;
192 static final byte IORING_OP_REMOVE_BUFFERS = 32;
193 static final byte IORING_OP_TEE = 33;
194 static final byte IORING_OP_SHUTDOWN = 34;
195 static final byte IORING_OP_RENAMEAT = 35;
196 static final byte IORING_OP_UNLINKAT = 36;
197 static final byte IORING_OP_MKDIRAT = 37;
198 static final byte IORING_OP_SYMLINKAT = 38;
199 static final byte IORING_OP_LINKAT = 39;
200 static final byte IORING_OP_MSG_RING = 40;
201 static final byte IORING_OP_FSETXATTR = 41;
202 static final byte IORING_OP_SETXATTR = 42;
203 static final byte IORING_OP_FGETXATTR = 43;
204 static final byte IORING_OP_GETXATTR = 44;
205 static final byte IORING_OP_SOCKET = 45;
206 static final byte IORING_OP_URING_CMD = 46;
207 static final byte IORING_OP_SEND_ZC = 47;
208 static final byte IORING_OP_SENDMSG_ZC = 48;
209 static final byte IORING_OP_READ_MULTISHOT = 49;
210 static final byte IORING_OP_WAITID = 50;
211 static final byte IORING_OP_FUTEX_WAIT = 51;
212 static final byte IORING_OP_FUTEX_WAKE = 52;
213 static final byte IORING_OP_FUTEX_WAITV = 53;
214 static final byte IORING_OP_FIXED_FD_INSTALL = 54;
215 static final byte IORING_OP_FTRUNCATE = 55;
216 static final byte IORING_OP_BIND = 56;
217 static final int IORING_CQE_F_BUFFER = 1 << 0;
218 static final int IORING_CQE_F_MORE = 1 << 1;
219 static final int IORING_CQE_F_SOCK_NONEMPTY = 1 << 2;
220 static final int IORING_CQE_F_NOTIF = 1 << 3;
221 static final int IORING_CQE_F_BUF_MORE = 1 << 4;
222 static final int IORING_CQE_F_SKIP = 1 << 5;
223 static final int IORING_CQE_F_32 = 1 << 15;
224 static final int IORING_SETUP_CQSIZE = 1 << 3;
225 static final int IORING_SETUP_CLAMP = 1 << 4;
226
227 static final int IORING_SETUP_R_DISABLED = 1 << 6;
228 static final int IORING_SETUP_SUBMIT_ALL = 1 << 7;
229 static final int IORING_SETUP_CQE32 = 1 << 11;
230
231 static final int IORING_SETUP_TASKRUN_FLAG = 1 << 9;
232 static final int IORING_SETUP_SINGLE_ISSUER = 1 << 12;
233 static final int IORING_SETUP_DEFER_TASKRUN = 1 << 13;
234 static final int IORING_SETUP_NO_SQARRAY = 1 << 16;
235 static final int IORING_SETUP_CQE_MIXED = 1 << 18;
236 static final int IORING_CQE_BUFFER_SHIFT = 16;
237
238 static final short IORING_POLL_ADD_MULTI = 1 << 0;
239
240 static final short IORING_RECVSEND_POLL_FIRST = 1 << 0;
241 static final short IORING_RECVSEND_BUNDLE = 1 << 4;
242 static final short IORING_RECV_MULTISHOT = 1 << 1;
243 static final short IORING_SEND_ZC_REPORT_USAGE = 1 << 3;
244
245 static final int IORING_NOTIF_USAGE_ZC_COPIED = 1 << 31;
246
247 static final short IORING_ACCEPT_MULTISHOT = 1 << 0;
248 static final short IORING_ACCEPT_DONTWAIT = 1 << 1;
249 static final short IORING_ACCEPT_POLL_FIRST = 1 << 2;
250
251 static final short IORING_NOP_CQE32 = 1 << 5;
252
253 static final int IORING_FEAT_NODROP = 1 << 1;
254 static final int IORING_FEAT_SUBMIT_STABLE = 1 << 2;
255 static final int IORING_FEAT_RECVSEND_BUNDLE = 1 << 14;
256 static final int IORING_FEAT_NO_IOWAIT = 1 << 17;
257
258 static final int IORING_SQ_NEED_WAKEUP = 1 << 0;
259 static final int IORING_SQ_CQ_OVERFLOW = 1 << 1;
260 static final int IORING_SQ_TASKRUN = 1 << 2;
261
262 static final int SPLICE_F_MOVE = 1;
263
264 static final int IOU_PBUF_RING_INC = 2;
265 static final int IO_URING_OP_SUPPORTED = 1;
266
267 static final int CQE_SIZE = 16;
268 static final int CQE32_SIZE = 32;
269
270 static String opToStr(byte op) {
271 switch (op) {
272 case IORING_OP_NOP: return "NOP";
273 case IORING_OP_READV: return "READV";
274 case IORING_OP_WRITEV: return "WRITEV";
275 case IORING_OP_FSYNC: return "FSYNC";
276 case IORING_OP_READ_FIXED: return "READ_FIXED";
277 case IORING_OP_WRITE_FIXED: return "WRITE_FIXED";
278 case IORING_OP_POLL_ADD: return "POLL_ADD";
279 case IORING_OP_POLL_REMOVE: return "POLL_REMOVE";
280 case IORING_OP_SYNC_FILE_RANGE: return "SYNC_FILE_RANGE";
281 case IORING_OP_SENDMSG: return "SENDMSG";
282 case IORING_OP_RECVMSG: return "RECVMSG";
283 case IORING_OP_TIMEOUT: return "TIMEOUT";
284 case IORING_OP_TIMEOUT_REMOVE: return "TIMEOUT_REMOVE";
285 case IORING_OP_ACCEPT: return "ACCEPT";
286 case IORING_OP_ASYNC_CANCEL: return "ASYNC_CANCEL";
287 case IORING_OP_LINK_TIMEOUT: return "LINK_TIMEOUT";
288 case IORING_OP_CONNECT: return "CONNECT";
289 case IORING_OP_FALLOCATE: return "FALLOCATE";
290 case IORING_OP_OPENAT: return "OPENAT";
291 case IORING_OP_CLOSE: return "CLOSE";
292 case IORING_OP_FILES_UPDATE: return "FILES_UPDATE";
293 case IORING_OP_STATX: return "STATX";
294 case IORING_OP_READ: return "READ";
295 case IORING_OP_WRITE: return "WRITE";
296 case IORING_OP_FADVISE: return "FADVISE";
297 case IORING_OP_MADVISE: return "MADVISE";
298 case IORING_OP_SEND: return "SEND";
299 case IORING_OP_RECV: return "RECV";
300 case IORING_OP_OPENAT2: return "OPENAT2";
301 case IORING_OP_EPOLL_CTL: return "EPOLL_CTL";
302 case IORING_OP_SPLICE: return "SPLICE";
303 case IORING_OP_PROVIDE_BUFFERS: return "PROVIDE_BUFFERS";
304 case IORING_OP_REMOVE_BUFFERS: return "REMOVE_BUFFERS";
305 case IORING_OP_TEE: return "TEE";
306 case IORING_OP_SHUTDOWN: return "SHUTDOWN";
307 case IORING_OP_RENAMEAT: return "RENAMEAT";
308 case IORING_OP_UNLINKAT: return "UNLINKAT";
309 case IORING_OP_MKDIRAT: return "MKDIRAT";
310 case IORING_OP_SYMLINKAT: return "SYMLINKAT";
311 case IORING_OP_LINKAT: return "LINKAT";
312 case IORING_OP_SEND_ZC: return "SEND_ZC";
313 case IORING_OP_SENDMSG_ZC: return "SENDMSG_ZC";
314 default: return "[OP CODE " + op + ']';
315 }
316 }
317
318 static final int IORING_ENTER_GETEVENTS = NativeStaticallyReferencedJniMethods.ioringEnterGetevents();
319 static final int IORING_ENTER_REGISTERED_RING = 1 << 4;
320 static final int IORING_ENTER_NO_IOWAIT = 1 << 7;
321 static final int IOSQE_ASYNC = NativeStaticallyReferencedJniMethods.iosqeAsync();
322 static final int IOSQE_LINK = NativeStaticallyReferencedJniMethods.iosqeLink();
323 static final int IOSQE_IO_DRAIN = NativeStaticallyReferencedJniMethods.iosqeDrain();
324 static final int IOSQE_BUFFER_SELECT = NativeStaticallyReferencedJniMethods.iosqeBufferSelect();
325 static final int IOSQE_CQE_SKIP_SUCCESS = 1 << 6;
326 static final int MSG_DONTWAIT = NativeStaticallyReferencedJniMethods.msgDontwait();
327 static final int MSG_FASTOPEN = NativeStaticallyReferencedJniMethods.msgFastopen();
328 static final int SOL_UDP = NativeStaticallyReferencedJniMethods.solUdp();
329 static final int SOL_SOCKET = NativeStaticallyReferencedJniMethods.solSocket();
330 static final int UDP_SEGMENT = NativeStaticallyReferencedJniMethods.udpSegment();
331 static final int SCM_RIGHTS = NativeStaticallyReferencedJniMethods.scmRights();
332 private static final int TFO_ENABLED_CLIENT_MASK = 0x1;
333 private static final int TFO_ENABLED_SERVER_MASK = 0x2;
334 private static final int TCP_FASTOPEN_MODE = NativeStaticallyReferencedJniMethods.tcpFastopenMode();
335
336
337
338
339 static final boolean IS_SUPPORTING_TCP_FASTOPEN_CLIENT =
340 (TCP_FASTOPEN_MODE & TFO_ENABLED_CLIENT_MASK) == TFO_ENABLED_CLIENT_MASK;
341
342
343
344
345 static final boolean IS_SUPPORTING_TCP_FASTOPEN_SERVER =
346 (TCP_FASTOPEN_MODE & TFO_ENABLED_SERVER_MASK) == TFO_ENABLED_SERVER_MASK;
347
348 private static final int[] REQUIRED_IORING_OPS = {
349 IORING_OP_POLL_ADD,
350 IORING_OP_TIMEOUT,
351 IORING_OP_ACCEPT,
352 IORING_OP_READ,
353 IORING_OP_WRITE,
354 IORING_OP_POLL_REMOVE,
355 IORING_OP_CONNECT,
356 IORING_OP_CLOSE,
357 IORING_OP_WRITEV,
358 IORING_OP_SENDMSG,
359 IORING_OP_RECVMSG,
360 IORING_OP_ASYNC_CANCEL,
361 IORING_OP_RECV,
362 IORING_OP_NOP,
363 IORING_OP_SHUTDOWN,
364 IORING_OP_SEND
365 };
366
367 static int setupFlags(boolean useSingleIssuer) {
368 int flags = Native.IORING_SETUP_R_DISABLED | Native.IORING_SETUP_CLAMP;
369 if (IoUring.isSetupSubmitAllSupported()) {
370 flags |= Native.IORING_SETUP_SUBMIT_ALL;
371 }
372
373 if (useSingleIssuer) {
374
375 if (IoUring.isSetupSingleIssuerSupported()) {
376 flags |= Native.IORING_SETUP_SINGLE_ISSUER;
377 }
378
379 if (IoUring.isSetupDeferTaskrunSupported()) {
380 flags |= Native.IORING_SETUP_DEFER_TASKRUN;
381 flags |= Native.IORING_SETUP_TASKRUN_FLAG;
382 }
383 }
384
385
386 if (IoUring.isIoringSetupNoSqarraySupported()) {
387 flags |= Native.IORING_SETUP_NO_SQARRAY;
388 }
389
390
391 if (IoUring.isSetupCqeMixedSupported()) {
392 flags |= Native.IORING_SETUP_CQE_MIXED;
393 }
394 return flags;
395 }
396
397 static RingBuffer createRingBuffer(int ringSize, int setupFlags) {
398 return createRingBuffer(ringSize, ringSize * 2, setupFlags);
399 }
400
401 static RingBuffer createRingBuffer(int ringSize, int cqeSize, int setupFlags) {
402 ObjectUtil.checkPositive(ringSize, "ringSize");
403 ObjectUtil.checkPositive(cqeSize, "cqeSize");
404 long[] values = ioUringSetup(ringSize, cqeSize, setupFlags);
405 assert values.length == 20;
406 long cqkhead = values[0];
407 long cqktail = values[1];
408 int cqringMask = (int) values[2];
409 int cqringEntries = (int) values[3];
410 long cqkflags = values[4];
411 long cqArrayAddress = values[5];
412 int cqringSize = (int) values[6];
413 long cqringAddress = values[7];
414 int cqringFd = (int) values[8];
415 int cqringCapacity = (int) values[9];
416 int cqeLength = (setupFlags & IORING_SETUP_CQE32) == 0 ? CQE_SIZE : CQE32_SIZE;
417 boolean extraCqeDataNeeded = (setupFlags & (IORING_SETUP_CQE32 | IORING_SETUP_CQE_MIXED)) != 0;
418 CompletionQueue completionQueue = new CompletionQueue(
419 Buffer.wrapMemoryAddressWithNativeOrder(cqkhead, Integer.BYTES),
420 Buffer.wrapMemoryAddressWithNativeOrder(cqktail, Integer.BYTES),
421 cqringMask,
422 cqringEntries,
423 Buffer.wrapMemoryAddressWithNativeOrder(cqkflags, Integer.BYTES),
424 Buffer.wrapMemoryAddressWithNativeOrder(cqArrayAddress, cqringEntries * cqeLength),
425 cqringSize,
426 cqringAddress,
427 cqringFd,
428 cqringCapacity, cqeLength, extraCqeDataNeeded);
429
430 long sqkhead = values[10];
431 long sqktail = values[11];
432 int sqringMask = (int) values[12];
433 int sqringEntries = (int) values[13];
434 long sqkflags = values[14];
435 long sqArrayAddress = values[15];
436 int sqringSize = (int) values[16];
437 long sqringAddress = values[17];
438 int sqringFd = (int) values[18];
439 SubmissionQueue submissionQueue = new SubmissionQueue(
440 Buffer.wrapMemoryAddressWithNativeOrder(sqkhead, Integer.BYTES),
441 Buffer.wrapMemoryAddressWithNativeOrder(sqktail, Integer.BYTES),
442 sqringMask,
443 sqringEntries,
444 Buffer.wrapMemoryAddressWithNativeOrder(sqkflags, Integer.BYTES),
445 Buffer.wrapMemoryAddressWithNativeOrder(sqArrayAddress, sqringEntries * SubmissionQueue.SQE_SIZE),
446 sqringSize,
447 sqringAddress,
448 sqringFd);
449 return new RingBuffer(submissionQueue, completionQueue, (int) values[19]);
450 }
451
452 static void checkAllIOSupported(IoUringProbe probe) {
453 if (!ioUringProbe(probe, REQUIRED_IORING_OPS)) {
454 throw new UnsupportedOperationException("Not all operations are supported: "
455 + Arrays.toString(REQUIRED_IORING_OPS));
456 }
457 }
458
459 static boolean isRecvMultishotSupported() {
460
461 return Native.ioUringSetupSupportsFlags(Native.IORING_SETUP_SINGLE_ISSUER);
462 }
463
464 static boolean isAcceptMultishotSupported(IoUringProbe probe) {
465
466 return ioUringProbe(probe, new int[] { Native.IORING_OP_SOCKET });
467 }
468
469 static boolean isCqeFSockNonEmptySupported(IoUringProbe probe) {
470
471 return ioUringProbe(probe, new int[] { Native.IORING_OP_SOCKET });
472 }
473
474 static boolean isSpliceSupported(IoUringProbe probe) {
475
476 return ioUringProbe(probe, new int[] { Native.IORING_OP_SPLICE });
477 }
478
479 static boolean isPollAddMultiShotSupported(IoUringProbe probe) {
480
481 return isCqeFSockNonEmptySupported(probe);
482 }
483
484 static boolean isSendZcSupported(IoUringProbe probe) {
485
486 return ioUringProbe(probe, new int[] { Native.IORING_OP_SEND_ZC });
487 }
488
489 static boolean isSendmsgZcSupported(IoUringProbe probe) {
490
491 return ioUringProbe(probe, new int[] { Native.IORING_OP_SENDMSG_ZC });
492 }
493
494
495
496
497
498
499 static boolean isRegisterIoWqWorkerSupported(int ringFd) {
500
501 int result = ioUringRegisterIoWqMaxWorkers(ringFd, 0, 0);
502 if (result >= 0) {
503 return true;
504 }
505
506 return false;
507 }
508
509 static boolean isRegisterBufferRingSupported(int ringFd, int flags) {
510 int entries = 2;
511 short bgid = 1;
512 long result = ioUringRegisterBufRing(ringFd, entries, bgid, flags);
513 if (result >= 0) {
514 ioUringUnRegisterBufRing(ringFd, result, entries, bgid);
515 return true;
516 }
517
518 return false;
519 }
520
521 static void checkKernelVersion(String kernelVersion) {
522 boolean enforceKernelVersion = SystemPropertyUtil.getBoolean(
523 "io.netty.transport.iouring.enforceKernelVersion", true);
524 boolean kernelSupported = checkKernelVersion(kernelVersion, 5, 9);
525 if (!kernelSupported) {
526 if (enforceKernelVersion) {
527 throw new UnsupportedOperationException(
528 "you need at least kernel version 5.9, current kernel version: " + kernelVersion);
529 } else {
530 logger.debug("Detected kernel " + kernelVersion + " does not match minimum version of 5.9, " +
531 "trying to use io_uring anyway");
532 }
533 }
534 }
535
536 private static boolean checkKernelVersion(String kernelVersion, int major, int minor) {
537 String[] versionComponents = kernelVersion.split("\\.");
538 if (versionComponents.length < 3) {
539 return false;
540 }
541 int nativeMajor;
542 try {
543 nativeMajor = Integer.parseInt(versionComponents[0]);
544 } catch (NumberFormatException e) {
545 return false;
546 }
547
548 if (nativeMajor < major) {
549 return false;
550 }
551
552 if (nativeMajor > major) {
553 return true;
554 }
555
556 int nativeMinor;
557 try {
558 nativeMinor = Integer.parseInt(versionComponents[1]);
559 } catch (NumberFormatException e) {
560 return false;
561 }
562
563 return nativeMinor >= minor;
564 }
565
566 static final class IoUringProbe {
567 final byte lastOp;
568 final byte opsLen;
569 final IoUringProbeOp[] ops;
570
571 IoUringProbe(int[] values) {
572 int idx = 0;
573 lastOp = (byte) values[idx++];
574 opsLen = (byte) values[idx++];
575 ops = new IoUringProbeOp[opsLen];
576 for (int i = 0; i < opsLen; i++) {
577 ops[i] = new IoUringProbeOp((byte) values[idx++], values[idx++]);
578 }
579 }
580 }
581
582 static class IoUringProbeOp {
583 final byte op;
584 final int flags;
585
586 IoUringProbeOp(byte op, int flags) {
587 this.op = op;
588 this.flags = flags;
589 }
590 }
591
592 static boolean ioUringProbe(IoUringProbe probe, int[] ops) {
593 IoUringProbeOp[] ioUringProbeOps = probe.ops;
594 if (ioUringProbeOps == null) {
595 return false;
596 }
597 for (int op : ops) {
598 if (op > probe.lastOp || (ioUringProbeOps[op].flags & IO_URING_OP_SUPPORTED) == 0) {
599 return false;
600 }
601 }
602 return true;
603 }
604
605 static native boolean ioUringSetupSupportsFlags(int setupFlags);
606 private static native long[] ioUringSetup(int entries, int cqeSize, int setupFlags);
607
608 static IoUringProbe ioUringProbe(int ringfd) {
609 int[] values = ioUringProbe0(ringfd);
610 if (values == null) {
611 return null;
612 }
613 return new IoUringProbe(values);
614 }
615 private static native int[] ioUringProbe0(int ringFd);
616
617 static native int ioUringRegisterIoWqMaxWorkers(int ringFd, int maxBoundedValue, int maxUnboundedValue);
618 static native int ioUringRegisterEnableRings(int ringFd);
619 static native int ioUringRegisterRingFds(int ringFds);
620
621 static native long ioUringRegisterBufRing(int ringFd, int entries, short bufferGroup, int flags);
622 static native int ioUringUnRegisterBufRing(int ringFd, long ioUringBufRingAddr, int entries, short bufferGroupId);
623 static native int ioUringBufRingSize(int entries);
624 static native int ioUringEnter(int ringFd, int toSubmit, int minComplete, int flags);
625
626 static native void eventFdWrite(int fd, long value);
627
628 static int getFd(DefaultFileRegion fileChannel) {
629 return getFd0(fileChannel);
630 }
631
632 private static native int getFd0(Object fileChannel);
633
634 static FileDescriptor newBlockingEventFd() {
635 return new FileDescriptor(blockingEventFd());
636 }
637
638 static native void ioUringExit(long submissionQueueArrayAddress, int submissionQueueRingEntries,
639 long submissionQueueRingAddress, int submissionQueueRingSize,
640 long completionQueueRingAddress, int completionQueueRingSize,
641 int ringFd, int enterRingFd);
642
643 private static native int blockingEventFd();
644
645
646 static native int createFile(String name);
647
648 private static native int registerUnix();
649
650 static native long cmsghdrData(long hdrAddr);
651
652 static native String kernelVersion();
653
654 private Native() {
655
656 }
657
658
659 private static void loadNativeLibrary() {
660 String name = PlatformDependent.normalizedOs().toLowerCase(Locale.ROOT).trim();
661 if (!name.startsWith("linux")) {
662 throw new IllegalStateException("Only supported on Linux");
663 }
664 String staticLibName = "netty_transport_native_io_uring42";
665 String sharedLibName = staticLibName + '_' + PlatformDependent.normalizedArch();
666 ClassLoader cl = PlatformDependent.getClassLoader(Native.class);
667 try {
668 NativeLibraryLoader.load(sharedLibName, cl);
669 } catch (UnsatisfiedLinkError e1) {
670 try {
671 NativeLibraryLoader.load(staticLibName, cl);
672 logger.info("Failed to load io_uring");
673 } catch (UnsatisfiedLinkError e2) {
674 ThrowableUtil.addSuppressed(e1, e2);
675 throw e1;
676 }
677 }
678 }
679 }