-
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathio_uring_linux.go
More file actions
1861 lines (1633 loc) · 55 KB
/
io_uring_linux.go
File metadata and controls
1861 lines (1633 loc) · 55 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// ©Hayabusa Cloud Co., Ltd. 2026. All rights reserved.
// Use of this source code is governed by a MIT-style
// license that can be found in the LICENSE file.
//go:build linux
package uring
import (
"errors"
"fmt"
"runtime"
"sync/atomic"
"time"
"unsafe"
"code.hybscloud.com/dwcas"
"code.hybscloud.com/iobuf"
"code.hybscloud.com/iox"
"code.hybscloud.com/spin"
"code.hybscloud.com/zcall"
)
// These core `io_uring` definitions were refactored from
// `code.hybscloud.com/sox` into this package.
const (
IORING_SETUP_IOPOLL = zcall.IORING_SETUP_IOPOLL
IORING_SETUP_SQPOLL = zcall.IORING_SETUP_SQPOLL
IORING_SETUP_SQ_AFF = zcall.IORING_SETUP_SQ_AFF
IORING_SETUP_CQSIZE = zcall.IORING_SETUP_CQSIZE
IORING_SETUP_CLAMP = zcall.IORING_SETUP_CLAMP
IORING_SETUP_ATTACH_WQ = zcall.IORING_SETUP_ATTACH_WQ
IORING_SETUP_R_DISABLED = zcall.IORING_SETUP_R_DISABLED
IORING_SETUP_SUBMIT_ALL = zcall.IORING_SETUP_SUBMIT_ALL
IORING_SETUP_COOP_TASKRUN = zcall.IORING_SETUP_COOP_TASKRUN
IORING_SETUP_TASKRUN_FLAG = zcall.IORING_SETUP_TASKRUN_FLAG
IORING_SETUP_SQE128 = zcall.IORING_SETUP_SQE128
IORING_SETUP_CQE32 = zcall.IORING_SETUP_CQE32
IORING_SETUP_SINGLE_ISSUER = zcall.IORING_SETUP_SINGLE_ISSUER
IORING_SETUP_DEFER_TASKRUN = zcall.IORING_SETUP_DEFER_TASKRUN
IORING_SETUP_NO_MMAP = zcall.IORING_SETUP_NO_MMAP
IORING_SETUP_REGISTERED_FD_ONLY = zcall.IORING_SETUP_REGISTERED_FD_ONLY
IORING_SETUP_NO_SQARRAY = zcall.IORING_SETUP_NO_SQARRAY
IORING_SETUP_HYBRID_IOPOLL = zcall.IORING_SETUP_HYBRID_IOPOLL
IORING_SETUP_CQE_MIXED = zcall.IORING_SETUP_CQE_MIXED // Allow both 16b and 32b CQEs
IORING_SETUP_SQE_MIXED = zcall.IORING_SETUP_SQE_MIXED // Allow both 64b and 128b SQEs
)
const (
IORING_ENTER_GETEVENTS = zcall.IORING_ENTER_GETEVENTS
IORING_ENTER_SQ_WAKEUP = zcall.IORING_ENTER_SQ_WAKEUP
IORING_ENTER_SQ_WAIT = zcall.IORING_ENTER_SQ_WAIT
IORING_ENTER_EXT_ARG = zcall.IORING_ENTER_EXT_ARG
IORING_ENTER_REGISTERED_RING = zcall.IORING_ENTER_REGISTERED_RING
IORING_ENTER_ABS_TIMER = zcall.IORING_ENTER_ABS_TIMER // Absolute timeout
IORING_ENTER_EXT_ARG_REG = zcall.IORING_ENTER_EXT_ARG_REG // Use registered wait region
IORING_ENTER_NO_IOWAIT = zcall.IORING_ENTER_NO_IOWAIT // Skip I/O wait
)
const (
IORING_OFF_SQ_RING int64 = 0
IORING_OFF_CQ_RING int64 = 0x8000000
IORING_OFF_SQES int64 = 0x10000000
IORING_OFF_PBUF_RING = 0x80000000
IORING_OFF_PBUF_SHIFT = 16
IORING_OFF_MMAP_MASK = 0xf8000000
)
const (
IORING_SQ_NEED_WAKEUP = 1 << iota
IORING_SQ_CQ_OVERFLOW
IORING_SQ_TASKRUN
)
const (
IOSQE_FIXED_FILE = zcall.IOSQE_FIXED_FILE
IOSQE_IO_DRAIN = zcall.IOSQE_IO_DRAIN
IOSQE_IO_LINK = zcall.IOSQE_IO_LINK
IOSQE_IO_HARDLINK = zcall.IOSQE_IO_HARDLINK
IOSQE_ASYNC = zcall.IOSQE_ASYNC
IOSQE_BUFFER_SELECT = zcall.IOSQE_BUFFER_SELECT
IOSQE_CQE_SKIP_SUCCESS = zcall.IOSQE_CQE_SKIP_SUCCESS
)
const (
IORING_POLL_ADD_MULTI = 1 << iota
IORING_POLL_UPDATE_EVENTS
IORING_POLL_UPDATE_USER_DATA
IORING_POLL_ADD_LEVEL
)
const (
IORING_ASYNC_CANCEL_ALL = 1 << iota
IORING_ASYNC_CANCEL_FD
IORING_ASYNC_CANCEL_ANY
IORING_ASYNC_CANCEL_FD_FIXED
IORING_ASYNC_CANCEL_USERDATA
IORING_ASYNC_CANCEL_OP
)
const (
IORING_CQE_F_BUFFER = 1 << 0
IORING_CQE_F_MORE = 1 << 1
IORING_CQE_F_SOCK_NONEMPTY = 1 << 2
IORING_CQE_F_NOTIF = 1 << 3
IORING_CQE_F_BUF_MORE = 1 << 4 // Buffer partially consumed (incremental mode)
IORING_CQE_F_SKIP = 1 << 5 // Skip CQE (gap filler for ring wrap)
IORING_CQE_F_32 = 1 << 15 // 32-byte CQE in mixed mode
)
const (
IORING_CQE_BUFFER_SHIFT = 16
)
const (
IORING_REGISTER_BUFFERS = zcall.IORING_REGISTER_BUFFERS
IORING_UNREGISTER_BUFFERS = zcall.IORING_UNREGISTER_BUFFERS
IORING_REGISTER_FILES = zcall.IORING_REGISTER_FILES
IORING_UNREGISTER_FILES = zcall.IORING_UNREGISTER_FILES
IORING_REGISTER_EVENTFD = zcall.IORING_REGISTER_EVENTFD
IORING_UNREGISTER_EVENTFD = zcall.IORING_UNREGISTER_EVENTFD
IORING_REGISTER_FILES_UPDATE = zcall.IORING_REGISTER_FILES_UPDATE
IORING_REGISTER_EVENTFD_ASYNC = zcall.IORING_REGISTER_EVENTFD_ASYNC
IORING_REGISTER_PROBE = zcall.IORING_REGISTER_PROBE
IORING_REGISTER_PERSONALITY = zcall.IORING_REGISTER_PERSONALITY
IORING_UNREGISTER_PERSONALITY = zcall.IORING_UNREGISTER_PERSONALITY
IORING_REGISTER_RESTRICTIONS = zcall.IORING_REGISTER_RESTRICTIONS
IORING_REGISTER_ENABLE_RINGS = zcall.IORING_REGISTER_ENABLE_RINGS
IORING_REGISTER_FILES2 = zcall.IORING_REGISTER_FILES2
IORING_REGISTER_FILES_UPDATE2 = zcall.IORING_REGISTER_FILES_UPDATE2
IORING_REGISTER_BUFFERS2 = zcall.IORING_REGISTER_BUFFERS2
IORING_REGISTER_BUFFERS_UPDATE = zcall.IORING_REGISTER_BUFFERS_UPDATE
IORING_REGISTER_IOWQ_AFF = zcall.IORING_REGISTER_IOWQ_AFF
IORING_UNREGISTER_IOWQ_AFF = zcall.IORING_UNREGISTER_IOWQ_AFF
IORING_REGISTER_IOWQ_MAX_WORKERS = zcall.IORING_REGISTER_IOWQ_MAX_WORKERS
IORING_REGISTER_RING_FDS = zcall.IORING_REGISTER_RING_FDS
IORING_UNREGISTER_RING_FDS = zcall.IORING_UNREGISTER_RING_FDS
IORING_REGISTER_PBUF_RING = zcall.IORING_REGISTER_PBUF_RING
IORING_UNREGISTER_PBUF_RING = zcall.IORING_UNREGISTER_PBUF_RING
IORING_REGISTER_SYNC_CANCEL = zcall.IORING_REGISTER_SYNC_CANCEL
IORING_REGISTER_FILE_ALLOC_RANGE = zcall.IORING_REGISTER_FILE_ALLOC_RANGE
IORING_REGISTER_PBUF_STATUS = zcall.IORING_REGISTER_PBUF_STATUS
IORING_REGISTER_NAPI = zcall.IORING_REGISTER_NAPI
IORING_UNREGISTER_NAPI = zcall.IORING_UNREGISTER_NAPI
IORING_REGISTER_CLOCK = zcall.IORING_REGISTER_CLOCK // Register clock source
IORING_REGISTER_CLONE_BUFFERS = zcall.IORING_REGISTER_CLONE_BUFFERS // Clone buffers from another ring
IORING_REGISTER_SEND_MSG_RING = zcall.IORING_REGISTER_SEND_MSG_RING // Send MSG_RING without ring
IORING_REGISTER_ZCRX_IFQ = zcall.IORING_REGISTER_ZCRX_IFQ // Register ZCRX interface queue
IORING_REGISTER_RESIZE_RINGS = zcall.IORING_REGISTER_RESIZE_RINGS // Resize CQ ring
IORING_REGISTER_MEM_REGION = zcall.IORING_REGISTER_MEM_REGION // Memory region setup (6.19+)
IORING_REGISTER_QUERY = zcall.IORING_REGISTER_QUERY // Query ring state (6.19+)
IORING_REGISTER_ZCRX_CTRL = zcall.IORING_REGISTER_ZCRX_CTRL // ZCRX control operations (6.19+)
)
// IORING_REGISTER_USE_REGISTERED_RING is a flag that can be OR'd with register
// opcodes to use a registered ring fd instead of a regular fd.
const IORING_REGISTER_USE_REGISTERED_RING = zcall.IORING_REGISTER_USE_REGISTERED_RING
const (
IO_URING_OP_SUPPORTED = 1 << 0
)
const (
ioUringDefaultEntries = EntriesMedium
ioUringDefaultSqThreadCPU = 0 // CPU 0 is always valid
ioUringDefaultSqThreadIdle = 5 * time.Second
)
type ioUring struct {
_ noCopy
submit submitState
lifecycleLock spin.Lock
started atomic.Bool
closed atomic.Bool
params *ioUringParams
sq ioUringSq
cq ioUringCq
ringFd int
bufs [][]byte
files []int32 // registered file descriptors
ops []ioUringProbeOp
pollerFd int
}
type submitState struct {
lock spin.Lock
keepAlive []submitKeepAlive
keepAliveHead uint32
keepAliveExtFree *submitKeepAliveExt // protected by the shared-submit lock or the single-issuer caller contract
shared bool // shared reports whether submit-state operations may arrive from multiple goroutines and need internal locking
}
type submitSlot struct {
index uint32
tail uint32
sqe *ioUringSqe
sqe128 *ioUringSqe128
keep *submitKeepAlive
}
// ioUringFd represents a file descriptor in io_uring context.
type ioUringFd int32
type ioUringProbe struct {
lastOp uint8
opsLen uint8
resv uint16
resv2 [3]uint32
ops [256]ioUringProbeOp
}
type ioUringProbeOp struct {
op uint8
resv uint8
flags uint16
resv2 uint32
}
func newIoUring(entries int, opts ...func(params *ioUringParams)) (*ioUring, error) {
if entries < 1 {
return nil, ErrInvalidParam
}
params := new(ioUringParams)
*params = *ioUringDefaultParams
for _, opt := range opts {
opt(params)
}
fd, err := ioUringSetup(uint32(entries), params)
if err != nil {
return nil, err
}
uring := &ioUring{
submit: submitState{
lock: spin.Lock{},
keepAlive: make([]submitKeepAlive, int(params.sqEntries)),
shared: params.flags&IORING_SETUP_SINGLE_ISSUER == 0,
},
params: params,
sq: ioUringSq{
ringSz: params.sqOff.array + uint32(unsafe.Sizeof(uint32(0)))*params.sqEntries,
},
cq: ioUringCq{
ringSz: params.cqOff.cqes + uint32(cqeBytesFromFlags(params.flags))*params.cqEntries,
cqeStride: cqeStrideFromFlags(params.flags),
},
ringFd: fd,
bufs: [][]byte{},
pollerFd: -1,
}
if err := uring.remapRings(params); err != nil {
zcall.Close(uintptr(fd))
return nil, err
}
return uring, nil
}
func (slot submitSlot) reset() {
if slot.sqe128 != nil {
*slot.sqe128 = ioUringSqe128{}
return
}
*slot.sqe = ioUringSqe{}
}
func (slot submitSlot) inlineCmdData128() []byte {
if slot.sqe128 == nil {
return nil
}
return unsafe.Slice((*byte)(unsafe.Pointer(&slot.sqe128.pad[0])), uringCmd128DataMax)
}
func sqeBytesFromFlags(flags uint32) int {
if flags&IORING_SETUP_SQE128 != 0 {
return int(unsafe.Sizeof(ioUringSqe128{}))
}
return int(unsafe.Sizeof(ioUringSqe{}))
}
func sqeStrideFromFlags(flags uint32) uintptr {
return uintptr(sqeBytesFromFlags(flags))
}
func cqeBytesFromFlags(flags uint32) int {
if flags&IORING_SETUP_CQE32 != 0 {
return 2 * int(unsafe.Sizeof(ioUringCqe{}))
}
return int(unsafe.Sizeof(ioUringCqe{}))
}
func cqeStrideFromFlags(flags uint32) int {
return cqeBytesFromFlags(flags) / int(unsafe.Sizeof(ioUringCqe{}))
}
// ringMapSz returns the shared SQ/CQ mmap size for supported Linux kernels.
// Linux 6.18+ advertises IORING_FEAT_SINGLE_MMAP, but the mapping must still
// cover whichever ring layout is larger.
func (ur *ioUring) ringMapSz() uintptr {
return uintptr(max(ur.sq.ringSz, ur.cq.ringSz))
}
func (ur *ioUring) supportsOpcode(op uint8) bool {
for _, supported := range ur.ops {
if supported.op == op {
return true
}
}
return false
}
func (ur *ioUring) remapRings(params *ioUringParams) error {
ur.sq.ringSz = params.sqOff.array + uint32(unsafe.Sizeof(uint32(0)))*params.sqEntries
ur.cq.ringSz = params.cqOff.cqes + uint32(cqeBytesFromFlags(params.flags))*params.cqEntries
ur.cq.cqeStride = cqeStrideFromFlags(params.flags)
sqeStride := sqeStrideFromFlags(params.flags)
sqeMapSz := uintptr(params.sqEntries) * sqeStride
ringMapSz := ur.ringMapSz()
ptr, errno := zcall.Mmap(nil, ringMapSz, PROT_READ|PROT_WRITE, MAP_SHARED|MAP_POPULATE, uintptr(ur.ringFd), uintptr(IORING_OFF_SQ_RING))
if errno != 0 {
return errFromErrno(errno)
}
sqesPtr, errno := zcall.Mmap(nil, sqeMapSz, PROT_READ|PROT_WRITE, MAP_SHARED|MAP_POPULATE, uintptr(ur.ringFd), uintptr(IORING_OFF_SQES))
if errno != 0 {
zcall.Munmap(ptr, ringMapSz)
return errFromErrno(errno)
}
ur.sq.ringPtr = ptr
ur.sq.sqesPtr = sqesPtr
ur.sq.sqeStride = sqeStride
ur.sq.sqeMapSz = sqeMapSz
ur.sq.kHead = (*uint32)(unsafe.Add(ptr, params.sqOff.head))
ur.sq.kTail = (*uint32)(unsafe.Add(ptr, params.sqOff.tail))
ur.sq.kRingMask = (*uint32)(unsafe.Add(ptr, params.sqOff.ringMask))
ur.sq.kRingEntries = (*uint32)(unsafe.Add(ptr, params.sqOff.ringEntries))
ur.sq.kFlags = (*uint32)(unsafe.Add(ptr, params.sqOff.flags))
ur.sq.kDropped = (*uint32)(unsafe.Add(ptr, params.sqOff.dropped))
ur.sq.array = unsafe.Slice((*uint32)(unsafe.Add(ptr, params.sqOff.array)), int(params.sqEntries))
ur.cq.kHead = (*uint32)(unsafe.Add(ptr, params.cqOff.head))
ur.cq.kTail = (*uint32)(unsafe.Add(ptr, params.cqOff.tail))
ur.cq.kRingMask = (*uint32)(unsafe.Add(ptr, params.cqOff.ringMask))
ur.cq.kRingEntries = (*uint32)(unsafe.Add(ptr, params.cqOff.ringEntries))
ur.cq.kOverflow = (*uint32)(unsafe.Add(ptr, params.cqOff.overflow))
ur.cq.cqes = unsafe.Slice((*ioUringCqe)(unsafe.Add(ptr, params.cqOff.cqes)), int(params.cqEntries)*ur.cq.cqeStride)
return nil
}
func (ur *ioUring) registerProbe(probe *ioUringProbe) error {
n := uintptr(len(probe.ops))
_, errno := zcall.IoUringRegister(uintptr(ur.ringFd), IORING_REGISTER_PROBE, unsafe.Pointer(probe), n)
if errno != 0 {
return errFromErrno(errno)
}
ur.ops = make([]ioUringProbeOp, 0, probe.opsLen)
for i := range probe.opsLen {
if probe.ops[i].flags&IO_URING_OP_SUPPORTED < IO_URING_OP_SUPPORTED {
continue
}
ur.ops = append(ur.ops, probe.ops[i])
}
return nil
}
func (ur *ioUring) feature(feat uint32) bool {
return feat == ur.params.features&feat
}
func (ur *ioUring) registerBuffers(addr unsafe.Pointer, n, size int) error {
if ur.bufs != nil && len(ur.bufs) > 0 {
return ErrExists
}
if n < 1 || size < 1 || 0 != n&(n-1) || 0 != size&(size-1) {
return ErrInvalidParam
}
vectors := make([]IoVec, 0, n)
ur.bufs = make([][]byte, 0, n)
for i := range n {
base := unsafe.Add(addr, i*size)
vectors = append(vectors, IoVec{Base: (*byte)(base), Len: uint64(size)})
ur.bufs = append(ur.bufs, unsafe.Slice((*byte)(base), size))
}
data := uintptr(unsafe.Pointer(unsafe.SliceData(vectors)))
reg := ioUringRSrcRegister{nr: uint32(n), data: uint64(data)}
regSize := uintptr(unsafe.Sizeof(reg))
_, errno := zcall.IoUringRegister(uintptr(ur.ringFd), IORING_REGISTER_BUFFERS2, unsafe.Pointer(®), regSize)
runtime.KeepAlive(vectors)
if errno != 0 {
return errFromErrno(errno)
}
return nil
}
func (ur *ioUring) unregisterBuffers() error {
if ur.bufs == nil || len(ur.bufs) < 1 {
return ErrNotFound
}
_, errno := zcall.IoUringRegister(uintptr(ur.ringFd), IORING_UNREGISTER_BUFFERS, nil, 0)
if errno != 0 {
return errFromErrno(errno)
}
ur.bufs = [][]byte{}
return nil
}
// registerFiles registers file descriptors for use with IOSQE_FIXED_FILE.
// Using registered files reduces per-operation overhead by avoiding
// file reference management on each I/O operation.
func (ur *ioUring) registerFiles(fds []int32) error {
if ur.files != nil && len(ur.files) > 0 {
return ErrExists
}
if len(fds) < 1 {
return ErrInvalidParam
}
// Use IORING_REGISTER_FILES2 with rsrc_register struct for consistency
reg := ioUringRSrcRegister{
nr: uint32(len(fds)),
data: uint64(uintptr(unsafe.Pointer(unsafe.SliceData(fds)))),
}
regSize := uintptr(unsafe.Sizeof(reg))
_, errno := zcall.IoUringRegister(uintptr(ur.ringFd), IORING_REGISTER_FILES2, unsafe.Pointer(®), regSize)
if errno != 0 {
return errFromErrno(errno)
}
// Store a copy of the file descriptors
ur.files = make([]int32, len(fds))
copy(ur.files, fds)
return nil
}
// registerFilesSparse allocates a sparse file table of the given size.
// Entries are initially empty (-1) and can be populated with registerFilesUpdate.
// Sparse registration allows dynamic file management without pre-populating all entries.
func (ur *ioUring) registerFilesSparse(count uint32) error {
if ur.files != nil && len(ur.files) > 0 {
return ErrExists
}
if count < 1 {
return ErrInvalidParam
}
reg := ioUringRSrcRegister{
nr: count,
flags: IORING_RSRC_REGISTER_SPARSE,
}
regSize := uintptr(unsafe.Sizeof(reg))
_, errno := zcall.IoUringRegister(uintptr(ur.ringFd), IORING_REGISTER_FILES2, unsafe.Pointer(®), regSize)
if errno != 0 {
return errFromErrno(errno)
}
// Initialize sparse table with -1 (empty slots)
ur.files = make([]int32, count)
for i := range ur.files {
ur.files[i] = -1
}
return nil
}
// registerFilesUpdate updates registered files at the specified offset.
// Use -1 to clear a slot, or a valid fd to set it.
func (ur *ioUring) registerFilesUpdate(offset uint32, fds []int32) error {
if ur.files == nil || len(ur.files) < 1 {
return ErrNotFound
}
if len(fds) < 1 {
return ErrInvalidParam
}
if int(offset)+len(fds) > len(ur.files) {
return ErrInvalidParam
}
// io_uring_files_update struct layout
type ioUringFilesUpdate struct {
offset uint32
resv uint32
fds uint64
}
up := ioUringFilesUpdate{
offset: offset,
fds: uint64(uintptr(unsafe.Pointer(unsafe.SliceData(fds)))),
}
_, errno := zcall.IoUringRegister(uintptr(ur.ringFd), IORING_REGISTER_FILES_UPDATE, unsafe.Pointer(&up), uintptr(len(fds)))
if errno != 0 {
return errFromErrno(errno)
}
// Update local tracking
copy(ur.files[offset:], fds)
return nil
}
// unregisterFiles removes all registered file descriptors.
func (ur *ioUring) unregisterFiles() error {
if ur.files == nil || len(ur.files) < 1 {
return ErrNotFound
}
_, errno := zcall.IoUringRegister(uintptr(ur.ringFd), IORING_UNREGISTER_FILES, nil, 0)
if errno != 0 {
return errFromErrno(errno)
}
ur.files = nil
return nil
}
func (ur *ioUring) registerBufRing(entries int, groupID uint16) (*ioUringBufRing, []byte, error) {
r, backing, _, err := ur.registerBufRingWithFlags(entries, groupID, 0)
return r, backing, err
}
// registerBufRingWithFlags registers a buffer ring with specified flags.
// Supported flags:
// - IOU_PBUF_RING_MMAP: kernel allocates memory, use mmap to access
// - IOU_PBUF_RING_INC: incremental buffer consumption mode
//
// Returns the buffer ring pointer and the backing slice (nil for mmap mode).
// Caller must keep the backing slice reachable while the registration is live.
func (ur *ioUring) registerBufRingWithFlags(entries int, groupID uint16, flags uint16) (*ioUringBufRing, []byte, uintptr, error) {
if entries < 1 || entries > (1<<15) {
return nil, nil, 0, ErrInvalidParam
}
entries = roundToPowerOf2(entries)
var r *ioUringBufRing
var backing []byte
if flags&IOU_PBUF_RING_MMAP != 0 {
// Kernel allocates memory - register first, then mmap
reg := ioUringBufReg{
ringAddr: 0, // Kernel will allocate
ringEntries: uint32(entries),
bgid: groupID,
flags: flags,
}
_, errno := zcall.IoUringRegister(uintptr(ur.ringFd), IORING_REGISTER_PBUF_RING, unsafe.Pointer(®), 1)
if errno != 0 {
return nil, nil, 0, errFromErrno(errno)
}
// Calculate mmap offset for this buffer ring
offset := uintptr(IORING_OFF_PBUF_RING) | (uintptr(groupID) << IORING_OFF_PBUF_SHIFT)
size := uintptr(entries) * unsafe.Sizeof(ioUringBuf{})
// Map the kernel-allocated buffer ring
ptr, errno := zcall.Mmap(nil, size, PROT_READ|PROT_WRITE, MAP_SHARED|MAP_POPULATE, uintptr(ur.ringFd), offset)
if errno != 0 {
// Unregister on mmap failure
_ = ur.unregisterBufRing(groupID)
return nil, nil, 0, errFromErrno(errno)
}
r = (*ioUringBufRing)(ptr)
// backing is nil for mmap mode - kernel manages the memory
return r, nil, size, nil
} else {
// User allocates memory - keep the slice alive to prevent GC
backing = iobuf.AlignedMem(entries*int(unsafe.Sizeof(ioUringBuf{})), iobuf.PageSize)
// Direct conversion without going through uintptr to satisfy checkptr
r = (*ioUringBufRing)(unsafe.Pointer(unsafe.SliceData(backing)))
ringAddr := uint64(uintptr(unsafe.Pointer(r)))
reg := ioUringBufReg{
ringAddr: ringAddr,
ringEntries: uint32(entries),
bgid: groupID,
flags: flags,
}
_, errno := zcall.IoUringRegister(uintptr(ur.ringFd), IORING_REGISTER_PBUF_RING, unsafe.Pointer(®), 1)
if errno != 0 {
return nil, nil, 0, errFromErrno(errno)
}
}
return r, backing, 0, nil
}
func (ur *ioUring) unregisterBufRing(groupID uint16) error {
reg := ioUringBufReg{bgid: groupID}
_, errno := zcall.IoUringRegister(uintptr(ur.ringFd), IORING_UNREGISTER_PBUF_RING, unsafe.Pointer(®), 1)
if errno != 0 {
return errFromErrno(errno)
}
return nil
}
func (ur *ioUring) registerPoller(p poller) (int, error) {
if ur.closed.Load() {
return 0, ErrClosed
}
if ur.pollerFd >= 0 {
return 0, ErrExists
}
efd, errno := zcall.Eventfd2(0, zcall.EFD_NONBLOCK|zcall.EFD_CLOEXEC)
if errno != 0 {
return 0, errFromErrno(errno)
}
_, errno = zcall.IoUringRegister(uintptr(ur.ringFd), IORING_REGISTER_EVENTFD_ASYNC, unsafe.Pointer(&efd), 1)
if errno != 0 {
zcall.Close(uintptr(efd))
return 0, errFromErrno(errno)
}
err := p.add(int(efd), EPOLLIN|EPOLLET)
if err != nil {
_, _ = zcall.IoUringRegister(uintptr(ur.ringFd), IORING_UNREGISTER_EVENTFD, nil, 0)
zcall.Close(uintptr(efd))
return 0, err
}
ur.pollerFd = int(efd)
return int(efd), nil
}
func (ur *ioUring) stop() error {
if ur.closed.Load() {
return nil
}
ur.lifecycleLock.Lock()
defer ur.lifecycleLock.Unlock()
if ur.closed.Load() {
return nil
}
ur.closed.Store(true)
ur.lockSubmitState()
defer ur.unlockSubmitState()
ur.clearAllKeepAlive()
return ur.cleanupCoreRingResources()
}
func (ur *ioUring) closeAfterFatalResize(remapErr error) error {
ur.closed.Store(true)
ur.clearAllKeepAlive()
err := ur.cleanupCoreRingResources()
return errors.Join(remapErr, err)
}
func (ur *ioUring) cleanupCoreRingResources() error {
var err error
if ur.pollerFd >= 0 {
errno := zcall.Close(uintptr(ur.pollerFd))
if errno != 0 {
err = errors.Join(err, fmt.Errorf("close eventfd %d: %w", ur.pollerFd, errFromErrno(errno)))
}
ur.pollerFd = -1
}
ur.bufs = nil
ur.files = nil
ur.ops = nil
ur.unmapRings()
if ur.ringFd >= 0 {
errno := zcall.Close(uintptr(ur.ringFd))
if errno != 0 {
err = errors.Join(err, fmt.Errorf("close ring fd %d: %w", ur.ringFd, errFromErrno(errno)))
}
ur.ringFd = -1
}
return err
}
func (ur *ioUring) clearRingViews() {
ur.sq = ioUringSq{}
ur.cq = ioUringCq{}
}
func (ur *ioUring) unmapRings() {
if ur.sq.sqesPtr != nil {
zcall.Munmap(ur.sq.sqesPtr, ur.sq.sqeMapSz)
}
if ur.sq.ringPtr != nil {
zcall.Munmap(ur.sq.ringPtr, ur.ringMapSz())
}
ur.clearRingViews()
}
func (ur *ioUring) enable() error {
_, errno := zcall.IoUringRegister(uintptr(ur.ringFd), IORING_REGISTER_ENABLE_RINGS, nil, 0)
if errno != 0 {
return errFromErrno(errno)
}
return nil
}
// submitPacked3 submits a 3-argument operation with packed context.
func (ur *ioUring) submitPacked3(sqeCtx SQEContext, ioprio uint16, addr uint64, n int) error {
slot, err := ur.reserveSubmitSlot()
if err != nil {
return err
}
slot.fill3(sqeCtx, ioprio, addr, n)
mirrorExtendedSQE(sqeCtx, slot.sqe)
ur.publishSubmitSlot(slot, sqeCtx)
return nil
}
// submitPacked6 submits a 6-argument operation with packed context.
func (ur *ioUring) submitPacked6(sqeCtx SQEContext, ioprio uint16, off uint64, addr uint64, n int, uflags uint32) error {
slot, err := ur.reserveSubmitSlot()
if err != nil {
return err
}
slot.fill6(sqeCtx, ioprio, off, addr, n, uflags)
mirrorExtendedSQE(sqeCtx, slot.sqe)
ur.publishSubmitSlot(slot, sqeCtx)
return nil
}
// submitPacked9 submits a 9-argument operation with packed context.
func (ur *ioUring) submitPacked9(sqeCtx SQEContext, ioprio uint16, off uint64, addr uint64, n int, uflags uint32, personality uint16, spliceFdIn int32) error {
slot, err := ur.reserveSubmitSlot()
if err != nil {
return err
}
slot.fill9(sqeCtx, ioprio, off, addr, n, uflags, personality, spliceFdIn)
mirrorExtendedSQE(sqeCtx, slot.sqe)
ur.publishSubmitSlot(slot, sqeCtx)
return nil
}
// mirrorExtendedSQE copies the filled kernel SQE back into the ExtSQE so that
// ExtCQE.Op() and ExtCQE.FD() can read the submitted fields at completion time.
//
//go:nosplit
func mirrorExtendedSQE(sqeCtx SQEContext, e *ioUringSqe) {
if sqeCtx.IsExtended() {
sqeCtx.ExtSQE().SQE = *e
}
}
func (slot submitSlot) fill3(sqeCtx SQEContext, ioprio uint16, addr uint64, n int) {
e := slot.sqe
e.opcode = sqeCtx.Op()
e.flags = sqeCtx.Flags()
e.ioprio = ioprio
e.fd = sqeCtx.FD()
e.off = 0
e.addr = addr
e.len = uint32(n)
e.uflags = 0
e.bufIndex = 0
e.personality = 0
e.spliceFdIn = 0
e.pad = [2]uint64{}
}
func (slot submitSlot) fill6(sqeCtx SQEContext, ioprio uint16, off uint64, addr uint64, n int, uflags uint32) {
e := slot.sqe
e.opcode = sqeCtx.Op()
e.flags = sqeCtx.Flags()
e.ioprio = ioprio
e.fd = sqeCtx.FD()
e.off = off
e.addr = addr
e.len = uint32(n)
e.uflags = uflags
e.bufIndex = 0
e.personality = 0
e.spliceFdIn = 0
e.pad = [2]uint64{}
}
func (slot submitSlot) fill9(sqeCtx SQEContext, ioprio uint16, off uint64, addr uint64, n int, uflags uint32, personality uint16, spliceFdIn int32) {
e := slot.sqe
e.opcode = sqeCtx.Op()
e.flags = sqeCtx.Flags()
e.ioprio = ioprio
e.fd = sqeCtx.FD()
e.off = off
e.addr = addr
e.len = uint32(n)
e.uflags = uflags
e.bufIndex = sqeCtx.BufGroup()
e.personality = personality
e.spliceFdIn = spliceFdIn
e.pad = [2]uint64{}
}
// submitExtended copies ExtSQE.SQE into the reserved kernel SQE.
func (ur *ioUring) submitExtended(sqeCtx SQEContext) error {
ext := sqeCtx.ExtSQE()
slot, err := ur.reserveSubmitSlot()
if err != nil {
return err
}
*slot.sqe = ext.SQE
listenerTrackSubmit(ext)
ur.publishSubmitSlot(slot, sqeCtx)
return nil
}
func (ur *ioUring) sqCount() int {
h := atomic.LoadUint32(ur.sq.kHead)
t := atomic.LoadUint32(ur.sq.kTail)
return int(t - h)
}
// enter flushes published SQEs and drives deferred task work when needed.
// Single-issuer rings rely on caller serialization here so the fast path can
// avoid shared-submit locking.
func (ur *ioUring) enter() error {
ur.lockSubmitState()
if ur.closed.Load() || ur.sq.kFlags == nil || ur.sq.kHead == nil || ur.sq.kTail == nil {
ur.unlockSubmitState()
return ErrClosed
}
if err := ur.wakeSQPollLocked(); err != nil {
ur.unlockSubmitState()
return err
}
if err := ur.flushSubmitLocked(); err != nil {
ur.unlockSubmitState()
return err
}
ur.unlockSubmitState()
return nil
}
func (ur *ioUring) wakeSQPollLocked() error {
flags := atomic.LoadUint32(ur.sq.kFlags)
if flags&IORING_SQ_NEED_WAKEUP == 0 {
return nil
}
_, err := ioUringEnter(ur.ringFd, uintptr(ur.params.sqEntries), 0, IORING_ENTER_SQ_WAKEUP)
// ErrExists/ErrInProgress means another enter is already in progress.
if err != nil && err != ErrExists && err != ErrInProgress {
return err
}
return nil
}
func (ur *ioUring) flushSubmitLocked() error {
// Atomic loads pair with publishSubmitSlot's stores.
sqHead := atomic.LoadUint32(ur.sq.kHead)
sqTail := atomic.LoadUint32(ur.sq.kTail)
if ur.params.flags&IORING_SETUP_SQPOLL == 0 {
n := sqTail - sqHead
// DEFER_TASKRUN and COOP_TASKRUN may still need a zero-submit enter after
// the kernel has already consumed the SQEs.
needTaskrunKick := n == 0 && ur.params.flags&(IORING_SETUP_DEFER_TASKRUN|IORING_SETUP_COOP_TASKRUN) != 0
if n != 0 || needTaskrunKick {
_, err := ioUringEnter(ur.ringFd, uintptr(n), 0, IORING_ENTER_GETEVENTS)
// ErrExists/ErrInProgress means another enter is already in progress.
if err != nil && err != ErrExists && err != ErrInProgress {
ur.releaseConsumedKeepAlive()
return err
}
}
}
ur.releaseConsumedKeepAlive()
return nil
}
func (ur *ioUring) cqReady() bool {
h := atomic.LoadUint32(ur.cq.kHead)
t := atomic.LoadUint32(ur.cq.kTail)
return h != t
}
// observeCQEmptyLocked performs the nonblocking IOPOLL visibility enter at the
// empty-CQ boundary. A nil return means the CQ became visible and callers should
// reread head/tail; a non-nil return is the terminal empty/error verdict.
func (ur *ioUring) observeCQEmptyLocked() error {
if ur.params.flags&IORING_SETUP_IOPOLL == 0 {
return ur.cqEmptyErr()
}
if err := ur.poll(0); err != nil {
return err
}
if ur.cqReady() {
return nil
}
return ur.cqEmptyErr()
}
func (ur *ioUring) poll(n int) error {
if ur.params.flags&IORING_SETUP_IOPOLL == 0 {
return nil
}
h := atomic.LoadUint32(ur.sq.kHead)
t := atomic.LoadUint32(ur.sq.kTail)
submit := t - h
for {
_, err := ioUringEnter(ur.ringFd, uintptr(submit), uintptr(n), IORING_ENTER_GETEVENTS)
if err == ErrInterrupted {
submit = 0 // Already submitted, just retry the wait
continue
}
return err
}
}
func (ur *ioUring) cqEmptyErr() error {
overflowCount := uint32(0)
if ur.cq.kOverflow != nil {
overflowCount = atomic.LoadUint32(ur.cq.kOverflow)
}
if ur.sq.kFlags != nil && atomic.LoadUint32(ur.sq.kFlags)&IORING_SQ_CQ_OVERFLOW != 0 {
atomic.StoreUint32(&ur.cq.overflowSeen, overflowCount)
return ErrCQOverflow
}
if ur.cq.kOverflow == nil {
return iox.ErrWouldBlock
}
for {
seen := atomic.LoadUint32(&ur.cq.overflowSeen)
if seen == overflowCount {
return iox.ErrWouldBlock
}
if atomic.CompareAndSwapUint32(&ur.cq.overflowSeen, seen, overflowCount) {
return ErrCQOverflow
}
}
}
// wait spins for one CQE and returns a pointer directly into the CQ ring.
// The returned *ioUringCqe is borrowed: it remains valid only until the next
// CAS-advance of kHead (i.e., the next wait call). Callers must read all
// needed fields before any subsequent completion-queue operation.
func (ur *ioUring) wait() (*ioUringCqe, error) {
ur.lockSubmitState()
if ur.closed.Load() || ur.cq.kHead == nil || ur.cq.kTail == nil || ur.cq.kRingMask == nil || len(ur.cq.cqes) == 0 {
ur.unlockSubmitState()
return nil, ErrClosed
}
sw := spin.Wait{}
for {
h, t := atomic.LoadUint32(ur.cq.kHead), atomic.LoadUint32(ur.cq.kTail)
if h == t {
if err := ur.observeCQEmptyLocked(); err != nil {
ur.unlockSubmitState()
return nil, err
}
continue
}
// Acquire barrier makes CQE contents visible after reading head and tail.
dwcas.BarrierAcquire()
e := ur.cq.cqeAt(h & *ur.cq.kRingMask)
ok := atomic.CompareAndSwapUint32(ur.cq.kHead, h, h+1)
if ok {
ur.unlockSubmitState()
return e, nil
}
sw.Once()
}
}
// waitBatch snapshots and claims multiple CQEs with one CAS.
func (ur *ioUring) waitBatch(cqes []CQEView) (int, error) {
if len(cqes) == 0 {
return 0, nil
}
ur.lockSubmitState()
if ur.closed.Load() || ur.cq.kHead == nil || ur.cq.kTail == nil || ur.cq.kRingMask == nil || len(ur.cq.cqes) == 0 {
ur.unlockSubmitState()
return 0, ErrClosed
}
sw := spin.Wait{}
for {
h := atomic.LoadUint32(ur.cq.kHead)
t := atomic.LoadUint32(ur.cq.kTail)
if h == t {
if err := ur.observeCQEmptyLocked(); err != nil {
ur.unlockSubmitState()
return 0, err
}
continue