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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
use std::collections::VecDeque;
use std::io;
use std::net::SocketAddr;
use std::os::fd::RawFd;
use std::sync::Arc;
use std::sync::atomic::AtomicBool;
use std::time::Duration;
use io_uring::cqueue;
use crate::accumulator::AccumulatorTable;
use crate::backend::ProvidedBufRing;
use crate::backend::Ring;
use crate::buffer::fixed::FixedBufferRegistry;
use crate::buffer::send_copy::SendCopyPool;
use crate::buffer::send_slab::InFlightSendSlab;
use crate::chain::SendChainTable;
use crate::completion::{OpTag, UserData};
use crate::config::Config;
use crate::connection::{ConnectionTable, RecvMode};
use crate::handler::{BuiltSend, ConnSendState, DriverCtx};
/// One in-flight UDP send slot. Owns the `sockaddr` + `iovec` + `msghdr`
/// triple referenced by a single `sendmsg` SQE; returned to the freelist
/// once the CQE arrives.
pub(crate) struct UdpSendSlot {
pub send_addr: Box<libc::sockaddr_storage>,
#[allow(dead_code)] // referenced via raw pointer in msghdr
pub send_iov: Box<libc::iovec>,
pub send_msghdr: Box<libc::msghdr>,
/// Pinned per-slot scratch for `UDP_SEGMENT` cmsg. Sized to hold
/// one `cmsghdr` + a `u16` segment size; only consulted when
/// `send_to_gso` is used. Heap-stable so the kernel's view (via
/// `msg_control`) stays valid until the CQE arrives.
pub send_cmsg_buf: Box<[u8; UDP_GSO_CMSG_LEN]>,
}
/// Size of the per-slot control-message buffer used for
/// `UDP_SEGMENT` cmsgs. CMSG_SPACE(sizeof(u16)) on x86-64 is 24
/// (cmsghdr is 16 bytes, payload aligned to 8). 32 is comfortable
/// over-allocation that survives any reasonable cmsg layout change.
pub(crate) const UDP_GSO_CMSG_LEN: usize = 32;
/// Pack a UDP send slot index and copy-pool slot into a 32-bit CQE payload.
/// High 16 bits = send-slot index; low 16 bits = copy-pool slot.
#[inline]
pub(crate) fn encode_udp_send_payload(slot_idx: u16, pool_slot: u16) -> u32 {
((slot_idx as u32) << 16) | (pool_slot as u32)
}
/// Inverse of [`encode_udp_send_payload`]: returns `(slot_idx, pool_slot)`.
#[inline]
pub(crate) fn decode_udp_send_payload(payload: u32) -> (u16, u16) {
((payload >> 16) as u16, (payload & 0xFFFF) as u16)
}
/// Per-worker UDP socket state.
pub(crate) struct UdpSocketState {
/// Fixed file table index for this socket.
pub fd_index: u32,
/// Bound address.
#[allow(dead_code)] // stored for diagnostics
pub local_addr: SocketAddr,
/// If `Some`, the socket has been `connect(2)`ed to this peer at setup
/// time and the runtime uses the lighter `RecvUdp`/`SendUdp` opcodes
/// instead of `RecvMsgUdp`/`SendMsgUdp`.
pub connected_peer: Option<SocketAddr>,
/// `msghdr` template used by `IORING_OP_RECVMSG_MULTISHOT`. The kernel
/// reads its `msg_namelen`/`msg_controllen`/etc. to decide how to carve
/// up each provided buffer into `[io_uring_recvmsg_out][name][control]
/// [payload]`. `RecvMsgOut::parse` reads the same template on the CQE
/// side. Must stay heap-stable for the lifetime of the multishot.
pub recv_msghdr: Box<libc::msghdr>,
/// Whether `UDP_GRO` was enabled on this socket. When true, each recvmsg
/// delivery may carry a `UDP_GRO` control message whose value is the
/// segment size used to split the coalesced payload back into datagrams.
pub gro: bool,
// ── Send state: fixed-size ring of per-SQE slots + a stack-freelist ──
pub send_slots: Box<[UdpSendSlot]>,
pub send_freelist: Vec<u16>,
}
/// A kernel recv buffer held in-place for zero-copy access.
///
/// The pointer is into `ProvidedBufRing::buf_backing`, which is allocated once
/// and never resized, so it remains valid until the bid is replenished.
#[derive(Clone, Copy)]
pub(crate) struct PendingRecvBuf {
pub(crate) bid: u16,
pub(crate) len: u32,
pub(crate) ptr: *const u8,
}
/// I/O driver encapsulating all infrastructure state (ring, buffers, connections).
///
/// `AsyncEventLoop` is composed of a `Driver` + handler + executor.
///
/// # Drop order (load-bearing)
///
/// `ring` MUST be declared first so it drops *last*. `ProvidedBufRing` and
/// `InFlightSendSlab` reference kernel-pinned memory whose lifetime is tied
/// to the `io_uring` instance: the kernel only releases its DMA references
/// when `io_uring_release` runs. Dropping the buffer pools before the ring
/// would let `munmap` race against in-flight ZC notifications — a UAF.
///
/// The `driver_field_order` test below validates this ordering; do not
/// reorder these fields without updating both the assertion and the
/// shutdown drain in `run_shutdown`.
pub(crate) struct Driver {
pub(crate) ring: Ring,
pub(crate) connections: ConnectionTable,
pub(crate) fixed_buffers: FixedBufferRegistry,
pub(crate) provided_bufs: ProvidedBufRing,
/// Provided buffer ring backing UDP multishot recvmsg. `None` when no UDP
/// sockets are configured.
pub(crate) udp_provided_bufs: Option<ProvidedBufRing>,
/// Buffer IDs from `udp_provided_bufs` that have been consumed and need
/// to be handed back to the kernel. Drained each tick.
pub(crate) udp_pending_replenish: Vec<u16>,
pub(crate) send_copy_pool: SendCopyPool,
pub(crate) send_slab: InFlightSendSlab,
pub(crate) accumulators: AccumulatorTable,
pub(crate) pending_replenish: Vec<u16>,
/// Per-connection pending recv buffer for zero-copy recv. When `Some`, the
/// buffer ID has NOT been pushed to `pending_replenish` and must be
/// replenished when the slot is cleared.
pub(crate) pending_recv_bufs: Vec<Option<PendingRecvBuf>>,
/// Per-connection original data length for in-flight SendRecvBuf operations.
/// Set when `forward_recv_buf` initiates a send; used by `handle_send_recv_buf`
/// to compute the correct offset on partial sends (since buf_size != data_len).
pub(crate) send_recv_buf_original_lens: Vec<u32>,
/// Per-connection remaining bytes for in-flight SendRecvBuf operations.
/// Tracks how many bytes still need to be sent (decremented on each partial send).
/// Stored here rather than in the CQE payload so that buffer sizes > u16::MAX are
/// supported (the old encoding packed remaining into the high 16 bits of the payload).
pub(crate) send_recv_buf_remaining: Vec<u32>,
/// Per-connection multi-buffer zero-copy recv hold. When `recv_forward` is
/// set for a connection, incoming provided buffers are pushed here (bids NOT
/// replenished) instead of copied into the accumulator, then forwarded back
/// in one coalesced `sendmsg` via `forward_held`. Backpressure is natural:
/// unreplenished bids deplete the provided-buffer ring (ENOBUFS) until a
/// forward completes and replenishes them.
pub(crate) recv_hold: Vec<std::collections::VecDeque<PendingRecvBuf>>,
/// Per-connection opt-in flag for the zero-copy recv-forward path.
pub(crate) recv_forward: Vec<bool>,
pub(crate) accept_rx: Option<crossbeam_channel::Receiver<(RawFd, SocketAddr)>>,
pub(crate) eventfd: RawFd,
pub(crate) eventfd_buf: [u8; 8],
/// Wake handle for cross-thread wakeup (wraps the eventfd).
pub(crate) wake_handle: crate::wakeup::WakeFd,
/// Deadline-based flush interval. None = disabled (SQPOLL or explicit 0).
pub(crate) flush_interval: Option<Duration>,
pub(crate) shutdown_flag: Arc<AtomicBool>,
pub(crate) shutdown_local: bool,
pub(crate) tls_table: Option<crate::tls::TlsTable>,
pub(crate) tls_scratch: Vec<u8>,
/// Pre-allocated sockaddr storage for outbound connect SQEs.
pub(crate) connect_addrs: Vec<libc::sockaddr_storage>,
/// Pre-allocated timespec storage for connect timeouts.
pub(crate) connect_timespecs: Vec<io_uring::types::Timespec>,
/// Pre-allocated batch buffer for draining CQEs.
/// Tuple: (user_data, result, flags, big_cqe). The big_cqe field
/// contains the extra 16 bytes from Entry32 CQEs (used by NVMe passthrough).
pub(crate) cqe_batch: Vec<(u64, i32, u32, [u64; 2])>,
/// Per-worker channel for DNS resolve responses from the resolver pool.
pub(crate) resolve_rx: Option<crossbeam_channel::Receiver<crate::resolver::ResolveResponse>>,
/// Per-worker sender for resolve responses (cloned into each request).
pub(crate) resolve_tx: Option<crossbeam_channel::Sender<crate::resolver::ResolveResponse>>,
/// Shared resolver pool (for submitting requests).
pub(crate) resolver: Option<std::sync::Arc<crate::resolver::ResolverPool>>,
/// Per-worker channel for spawn responses from the spawner pool.
pub(crate) spawn_rx: Option<crossbeam_channel::Receiver<crate::spawner::SpawnResponse>>,
/// Per-worker sender for spawn responses (cloned into each request).
pub(crate) spawn_tx: Option<crossbeam_channel::Sender<crate::spawner::SpawnResponse>>,
/// Shared spawner pool (for submitting requests).
pub(crate) spawner: Option<std::sync::Arc<crate::spawner::SpawnerPool>>,
/// Per-worker channel for blocking responses from the blocking pool.
pub(crate) blocking_rx: Option<crossbeam_channel::Receiver<crate::blocking::BlockingResponse>>,
/// Per-worker sender for blocking responses (cloned into each request).
pub(crate) blocking_tx: Option<crossbeam_channel::Sender<crate::blocking::BlockingResponse>>,
/// Shared blocking pool (for submitting requests).
pub(crate) blocking_pool: Option<std::sync::Arc<crate::blocking::BlockingPool>>,
/// Region-registry control channel — drained each tick to apply
/// dynamic fixed-buffer registrations from
/// [`ShutdownHandle::register_region`](crate::ShutdownHandle::register_region).
pub(crate) region_rx: crate::region_registry::RegionControlRx,
/// Whether to set TCP_NODELAY on connections.
pub(crate) tcp_nodelay: bool,
/// Whether SO_TIMESTAMPING is enabled for connections.
#[cfg(feature = "timestamps")]
pub(crate) timestamps: bool,
/// Pinned msghdr template for RecvMsgMulti with SO_TIMESTAMPING.
/// Used as the SQE template and for parsing CQE buffers via RecvMsgOut.
#[cfg(feature = "timestamps")]
pub(crate) recvmsg_msghdr: Box<libc::msghdr>,
/// Per-connection send chain tracking for IOSQE_IO_LINK chains.
pub(crate) chain_table: SendChainTable,
/// Maximum SQEs per chain (0 = disabled).
pub(crate) max_chain_length: u16,
/// Per-connection send queues for serializing sends (one in-flight at a time).
pub(crate) send_queues: Vec<ConnSendState>,
/// Connection indices that currently have a `close_notify_deadline`
/// armed (TLS graceful-shutdown timeout). The event loop's
/// `check_close_notify_deadlines` iterates this set instead of
/// walking every entry in `send_queues`, which is critical for
/// non-TLS workloads — without this, the per-iteration deadline
/// scan dominates worker CPU at high request rates.
pub(crate) close_notify_armed: Vec<u32>,
/// Tick timeout duration. When set, a timeout SQE ensures the event loop
/// wakes periodically even when no I/O completions are pending.
pub(crate) tick_timeout_ts: Option<io_uring::types::Timespec>,
/// Whether a tick timeout SQE is currently in-flight.
pub(crate) tick_timeout_armed: bool,
/// Monotonic tick counter for backoff-based retry scheduling.
pub(crate) tick_count: u64,
/// Whether the eventfd read SQE is currently armed.
pub(crate) eventfd_armed: bool,
/// Pending ZC send retries: (conn_index, generation, slab_idx, retries). Drained each tick.
pub(crate) pending_zc_retries: Vec<(u32, u32, u16, u8)>,
/// Pending copy send retries: (conn_index, generation, pool_slot, retries). Drained each tick.
pub(crate) pending_copy_retries: Vec<(u32, u32, u16, u8)>,
/// Pending PollAdd-on-POLLOUT retries from the EAGAIN backpressure
/// path: (conn_index, generation, pool_slot, retries). Drained each tick.
/// Only used when `submit_send_pollout` itself failed (SQ full at
/// the time the EAGAIN CQE arrived).
pub(crate) pending_send_pollout_retries: Vec<(u32, u32, u16, u8)>,
/// Pending coalesced-send retries: (conn_index, generation, slab_idx, retries).
/// Drained each tick — used when resubmitting a coalesced `sendmsg` (partial
/// remainder or POLLOUT rearm) found the SQ full.
pub(crate) pending_coalesced_retries: Vec<(u32, u32, u16, u8)>,
/// Pending recv-forward send resubmissions that failed (SQ full):
/// (conn_index, generation, slab_idx, retries). Drained each tick.
pub(crate) pending_recv_forward_retries: Vec<(u32, u32, u16, u8)>,
/// Pending close retries: (conn_index, retries). Drained each tick.
pub(crate) pending_close_retries: Vec<(u32, u8)>,
/// Per-worker UDP socket state.
pub(crate) udp_sockets: Vec<UdpSocketState>,
/// NVMe device tracking table. `None` when NVMe is not configured.
pub(crate) nvme_devices: Option<crate::nvme::NvmeDeviceTable>,
/// NVMe command slab for tracking in-flight commands. `None` when NVMe is not configured.
pub(crate) nvme_cmd_slab: Option<crate::nvme::NvmeCmdSlab>,
/// Base offset in the fixed file table for NVMe device fds.
/// NVMe devices are registered at `nvme_fd_base + device_index`.
pub(crate) nvme_fd_base: u32,
/// Direct I/O file tracking table. `None` when direct I/O is not configured.
pub(crate) direct_io_files: Option<crate::direct_io::DirectIoFileTable>,
/// Direct I/O command slab for tracking in-flight commands. `None` when not configured.
pub(crate) direct_io_cmd_slab: Option<crate::direct_io::DirectIoCmdSlab>,
/// Base offset in the fixed file table for direct I/O file fds.
pub(crate) direct_io_fd_base: u32,
/// Filesystem file tracking table. `None` when fs is not configured.
pub(crate) fs_files: Option<crate::fs::FsFileTable>,
/// Filesystem command slab for tracking in-flight commands. `None` when not configured.
pub(crate) fs_cmd_slab: Option<crate::fs::FsCmdSlab>,
/// Base offset in the fixed file table for filesystem file fds.
pub(crate) fs_fd_base: u32,
}
impl Driver {
/// Create a new driver for a worker thread.
#[allow(clippy::too_many_arguments)]
pub(crate) fn new(
config: &Config,
accept_rx: Option<crossbeam_channel::Receiver<(RawFd, SocketAddr)>>,
eventfd: RawFd,
shutdown_flag: Arc<AtomicBool>,
resolve_rx: Option<crossbeam_channel::Receiver<crate::resolver::ResolveResponse>>,
resolve_tx: Option<crossbeam_channel::Sender<crate::resolver::ResolveResponse>>,
resolver: Option<std::sync::Arc<crate::resolver::ResolverPool>>,
spawn_rx: Option<crossbeam_channel::Receiver<crate::spawner::SpawnResponse>>,
spawn_tx: Option<crossbeam_channel::Sender<crate::spawner::SpawnResponse>>,
spawner: Option<std::sync::Arc<crate::spawner::SpawnerPool>>,
blocking_rx: Option<crossbeam_channel::Receiver<crate::blocking::BlockingResponse>>,
blocking_tx: Option<crossbeam_channel::Sender<crate::blocking::BlockingResponse>>,
blocking_pool: Option<std::sync::Arc<crate::blocking::BlockingPool>>,
region_rx: crate::region_registry::RegionControlRx,
) -> Result<Self, crate::error::Error> {
config.validate()?;
let ring = Ring::setup(config)?;
let fixed_buffers =
FixedBufferRegistry::new(&config.registered_regions, config.max_registered_regions);
let provided_bufs = ProvidedBufRing::new(
config.recv_buffer.bgid,
config.recv_buffer.ring_size,
config.recv_buffer.buffer_size,
)?;
let udp_count = config.udp_bind.len() as u32;
let udp_provided_bufs = if udp_count > 0 {
Some(ProvidedBufRing::new(
config.udp_recv_buffer.bgid,
config.udp_recv_buffer.ring_size,
config.udp_recv_buffer.buffer_size,
)?)
} else {
None
};
let nvme_max = config
.nvme
.as_ref()
.map(|n| n.max_devices as u32)
.unwrap_or(0);
let direct_io_max = config
.direct_io
.as_ref()
.map(|d| d.max_files as u32)
.unwrap_or(0);
let fs_max = config.fs.as_ref().map(|f| f.max_files as u32).unwrap_or(0);
// Register resources with the kernel
ring.register_buffers(&fixed_buffers)?;
ring.register_files_sparse(
config.max_connections + udp_count + nvme_max + direct_io_max + fs_max,
)?;
ring.register_buf_ring(&provided_bufs)?;
if let Some(ref udp_bufs) = udp_provided_bufs {
ring.register_buf_ring(udp_bufs)?;
}
let connections = ConnectionTable::new(config.max_connections);
let send_copy_pool = SendCopyPool::new(config.send_copy_count, config.send_copy_slot_size);
let send_slab = InFlightSendSlab::new(config.send_slab_slots);
let accumulators = AccumulatorTable::new_with_max(
config.max_connections,
config.recv_accumulator_capacity,
config.recv_accumulator_max,
);
// Deadline flush: disabled when SQPOLL (kernel polls SQ) or interval is 0.
let flush_interval = if config.sqpoll || config.flush_interval_us == 0 {
None
} else {
Some(Duration::from_micros(config.flush_interval_us))
};
let tls_table = {
let has_server = config.tls.is_some();
let has_client = config.tls_client.is_some();
if has_server || has_client {
Some(crate::tls::TlsTable::new(
config.max_connections,
config.tls.as_ref().map(|tc| tc.server_config.clone()),
config
.tls_client
.as_ref()
.map(|tc| tc.client_config.clone()),
))
} else {
None
}
};
let tls_scratch = vec![0u8; 16384];
let mut connect_addrs = Vec::with_capacity(config.max_connections as usize);
connect_addrs.resize(config.max_connections as usize, unsafe {
std::mem::zeroed()
});
let mut connect_timespecs = Vec::with_capacity(config.max_connections as usize);
connect_timespecs.resize(
config.max_connections as usize,
io_uring::types::Timespec::new(),
);
let mut send_queues = Vec::with_capacity(config.max_connections as usize);
for _ in 0..config.max_connections {
send_queues.push(ConnSendState::new());
}
// Set up UDP sockets.
let mut udp_sockets = Vec::with_capacity(config.udp_bind.len());
for (udp_idx, bind_addr) in config.udp_bind.iter().enumerate() {
let fd_index = config.max_connections + udp_idx as u32;
let connect_peer = config.udp_connect_peers.get(udp_idx).copied().flatten();
let state = Self::setup_udp_socket(
&ring,
*bind_addr,
connect_peer,
fd_index,
config.udp_send_slots,
config.udp_gro,
)?;
udp_sockets.push(state);
}
let mut driver = Driver {
ring,
connections,
fixed_buffers,
provided_bufs,
udp_provided_bufs,
udp_pending_replenish: Vec::new(),
send_copy_pool,
send_slab,
accumulators,
pending_replenish: Vec::with_capacity(config.recv_buffer.ring_size as usize),
pending_recv_bufs: vec![None; config.max_connections as usize],
send_recv_buf_original_lens: vec![0; config.max_connections as usize],
send_recv_buf_remaining: vec![0; config.max_connections as usize],
recv_hold: (0..config.max_connections)
.map(|_| std::collections::VecDeque::new())
.collect(),
recv_forward: vec![false; config.max_connections as usize],
accept_rx,
eventfd,
eventfd_buf: [0u8; 8],
wake_handle: crate::wakeup::WakeFd::from_raw_fd(eventfd),
flush_interval,
shutdown_flag,
shutdown_local: false,
tls_table,
tls_scratch,
connect_addrs,
connect_timespecs,
cqe_batch: Vec::with_capacity(config.sq_entries as usize * 4),
tcp_nodelay: config.tcp_nodelay,
#[cfg(feature = "timestamps")]
timestamps: config.timestamps,
#[cfg(feature = "timestamps")]
recvmsg_msghdr: {
let mut hdr: Box<libc::msghdr> = Box::new(unsafe { std::mem::zeroed() });
// TCP: no source address needed.
hdr.msg_namelen = 0;
// Room for SCM_TIMESTAMPING cmsg: cmsghdr(16) + 3×timespec(48) = 64 bytes.
hdr.msg_controllen = 64;
hdr
},
chain_table: SendChainTable::new(config.max_connections),
max_chain_length: config.max_chain_length,
send_queues,
close_notify_armed: Vec::new(),
tick_timeout_ts: if config.tick_timeout_us > 0 {
Some(
io_uring::types::Timespec::new()
.sec(config.tick_timeout_us / 1_000_000)
.nsec((config.tick_timeout_us % 1_000_000) as u32 * 1000),
)
} else {
None
},
tick_timeout_armed: false,
tick_count: 0,
eventfd_armed: false,
pending_zc_retries: Vec::new(),
pending_copy_retries: Vec::new(),
pending_send_pollout_retries: Vec::new(),
pending_coalesced_retries: Vec::new(),
pending_recv_forward_retries: Vec::new(),
pending_close_retries: Vec::new(),
udp_sockets,
nvme_devices: config
.nvme
.as_ref()
.map(|n| crate::nvme::NvmeDeviceTable::new(n.max_devices)),
nvme_cmd_slab: config
.nvme
.as_ref()
.map(|n| crate::nvme::NvmeCmdSlab::new(n.max_commands_in_flight)),
nvme_fd_base: config.max_connections + udp_count,
direct_io_files: config
.direct_io
.as_ref()
.map(|d| crate::direct_io::DirectIoFileTable::new(d.max_files)),
direct_io_cmd_slab: config
.direct_io
.as_ref()
.map(|d| crate::direct_io::DirectIoCmdSlab::new(d.max_commands_in_flight)),
direct_io_fd_base: config.max_connections + udp_count + nvme_max,
fs_files: config
.fs
.as_ref()
.map(|f| crate::fs::FsFileTable::new(f.max_files)),
fs_cmd_slab: config
.fs
.as_ref()
.map(|f| crate::fs::FsCmdSlab::new(f.max_commands_in_flight)),
fs_fd_base: config.max_connections + udp_count + nvme_max + direct_io_max,
resolve_rx,
resolve_tx,
resolver,
spawn_rx,
spawn_tx,
spawner,
blocking_rx,
blocking_tx,
blocking_pool,
region_rx,
};
// Arm multishot recv for each UDP socket against the UDP buffer
// group. One SQE per socket stays live in the kernel and fans out a
// CQE per datagram until the buffer ring is exhausted. Connected
// sockets use the lighter `RecvUdp` opcode (no recvmsg metadata);
// unconnected sockets use `RecvMsgUdp` so the kernel returns the
// peer address in each CQE buffer.
let udp_bgid = config.udp_recv_buffer.bgid;
for udp_idx in 0..driver.udp_sockets.len() {
let fd_index = driver.udp_sockets[udp_idx].fd_index;
let result = if driver.udp_sockets[udp_idx].connected_peer.is_some() {
let ud = UserData::encode(OpTag::RecvUdp, udp_idx as u32, 0);
driver
.ring
.submit_multishot_recv_udp(fd_index, udp_bgid, ud)
} else {
let ud = UserData::encode(OpTag::RecvMsgUdp, udp_idx as u32, 0);
let msghdr_ptr = &*driver.udp_sockets[udp_idx].recv_msghdr as *const libc::msghdr;
driver
.ring
.submit_recvmsg_multishot(fd_index, msghdr_ptr, udp_bgid, ud)
};
result.map_err(|e| {
crate::error::Error::RingSetup(format!(
"failed to submit initial UDP multishot recv: {e}"
))
})?;
}
Ok(driver)
}
/// Construct a [`DriverCtx`] by borrowing driver fields.
///
/// Borrows `self` mutably, so callers cannot access individual driver
/// fields while the returned `DriverCtx` is live. For cases requiring
/// simultaneous access to specific fields (e.g., accumulators + ctx),
/// construct `DriverCtx` inline with explicit field borrows.
pub(crate) fn make_ctx(&mut self) -> DriverCtx<'_> {
DriverCtx {
ring: &mut self.ring,
connections: &mut self.connections,
fixed_buffers: &mut self.fixed_buffers,
send_copy_pool: &mut self.send_copy_pool,
send_slab: &mut self.send_slab,
tls_table: match self.tls_table {
Some(ref mut t) => t as *mut crate::tls::TlsTable,
None => std::ptr::null_mut(),
},
shutdown_requested: &mut self.shutdown_local,
connect_addrs: &mut self.connect_addrs,
tcp_nodelay: self.tcp_nodelay,
#[cfg(feature = "timestamps")]
timestamps: self.timestamps,
#[cfg(feature = "timestamps")]
recvmsg_msghdr: &*self.recvmsg_msghdr as *const libc::msghdr,
connect_timespecs: &mut self.connect_timespecs,
chain_table: &mut self.chain_table,
max_chain_length: self.max_chain_length,
send_queues: &mut self.send_queues,
close_notify_armed: &mut self.close_notify_armed,
udp_sockets: &mut self.udp_sockets,
nvme_devices: &mut self.nvme_devices,
nvme_cmd_slab: &mut self.nvme_cmd_slab,
nvme_fd_base: self.nvme_fd_base,
direct_io_files: &mut self.direct_io_files,
direct_io_cmd_slab: &mut self.direct_io_cmd_slab,
direct_io_fd_base: self.direct_io_fd_base,
fs_files: &mut self.fs_files,
fs_cmd_slab: &mut self.fs_cmd_slab,
fs_fd_base: self.fs_fd_base,
pending_close_retries: &mut self.pending_close_retries,
}
}
pub(crate) fn close_connection(&mut self, conn_index: u32) {
if let Some(conn) = self.connections.get_mut(conn_index) {
if matches!(conn.recv_mode, RecvMode::Closed) {
return; // already closing — avoid double Close SQE
}
conn.recv_mode = RecvMode::Closed;
} else {
return;
}
// Replenish any held (not-yet-forwarded) zero-copy recv buffers so their
// bids aren't leaked, and clear the opt-in flag for slot reuse. An
// in-flight forward's bids live in its slab entry (already drained from
// recv_hold) and are replenished by its own completion handler.
if self.recv_forward[conn_index as usize] {
for pending in self.recv_hold[conn_index as usize].drain(..) {
self.pending_replenish.push(pending.bid);
}
self.recv_forward[conn_index as usize] = false;
}
// Cancel any active chain — per-SQE resources released as CQEs arrive.
self.chain_table.cancel(conn_index);
// Defer the actual `Close` SQE until every queued send has
// drained through the regular `submit_next_queued` cycle and
// its CQE has been handled. Two earlier mistakes are worth
// calling out:
//
// (a) The original code called `drain_conn_send_queue`,
// which freed slab/pool resources for queued sends
// *without ever submitting them* — silently dropping
// every byte queued behind the in-flight send.
//
// (b) An interim attempt pushed all queued SQEs in parallel
// at close time, but io_uring doesn't strictly order
// independent SQEs, so the kernel could process them
// out of order and scramble the byte stream. (Visible
// in release mode where the SQEs land close together.)
//
// The current strategy preserves the queue's serialized
// drain: leave in_flight + queue alone, mark `close_pending`,
// and let `note_send_finalized` (called from `handle_send` /
// `handle_send_pollout` after each completion) submit the
// deferred `Close` once both `in_flight` is false and the
// queue is empty.
let state = &mut self.send_queues[conn_index as usize];
state.close_pending = true;
if state.in_flight {
// Something is in-flight; wait for its CQE to drain the queue.
return;
}
// Nothing in-flight but queue has items — push them into the SQ
// so their CQEs can fire and continue the serialized drain cycle.
if !state.queue.is_empty() {
let pushed = self.flush_queued_sends_or_release(conn_index);
if pushed == 0 {
// SQ was full and we gave up — the queue was drained
// by flush_queued_sends_or_release, so finalize immediately.
self.try_finalize_close(conn_index);
}
} else {
self.try_finalize_close(conn_index);
}
}
/// Submit the deferred `Close` SQE once every pending send for
/// this connection has either completed or been finally given up
/// on. Called from `close_connection` (immediate-fast-path) and
/// from `note_send_finalized` after each per-send CQE.
pub(crate) fn try_finalize_close(&mut self, conn_index: u32) {
let state = &self.send_queues[conn_index as usize];
let drained = !state.in_flight && state.queue.is_empty();
if !(state.close_pending && drained) {
return;
}
self.send_queues[conn_index as usize].close_pending = false;
// Disarm from the close_notify deadline set. swap_remove is
// O(n) but the set is bounded by concurrent TLS shutdowns
// (typically 0 or single digits) — well below the cost we just
// saved by not walking every connection slot in the deadline
// check.
if let Some(pos) = self
.close_notify_armed
.iter()
.position(|&i| i == conn_index)
{
self.close_notify_armed.swap_remove(pos);
}
if self.ring.submit_close(conn_index).is_err() {
crate::metrics::RING.increment(crate::metrics::ring::CLOSE_SUBMIT_FAILURES);
let retries = self
.pending_close_retries
.iter()
.map(|(idx, r)| (*idx, (*r + 1)))
.collect::<Vec<_>>();
self.pending_close_retries.clear();
for (idx, retry) in retries {
if retry < 5 {
self.pending_close_retries.push((idx, retry));
}
}
}
}
/// Hook called from the send-path CQE handlers after the queue
/// state has been updated — submits a deferred `Close` if the
/// connection was waiting and the queue is now drained.
pub(crate) fn note_send_finalized(&mut self, conn_index: u32) {
self.try_finalize_close(conn_index);
}
/// Push all queued sends for a connection into the SQ. Returns the
/// number of sends successfully submitted. On SQ full, drains the
/// remaining queue (releasing slab/pool resources) and sets
/// `in_flight = false`.
pub(crate) fn flush_queued_sends_or_release(&mut self, conn_index: u32) -> usize {
let state = &mut self.send_queues[conn_index as usize];
let mut pushed = 0usize;
while let Some(built) = state.queue.pop_front() {
match unsafe { self.ring.push_sqe(built.entry) } {
Ok(()) => {
pushed += 1;
}
Err(_) => {
// SQ full — release this entry and drain remaining queue.
Self::release_built_resources(
&mut self.send_slab,
&mut self.send_copy_pool,
built.pool_slot,
built.slab_idx,
);
Self::release_queued_sends(
&mut state.queue,
&mut self.send_slab,
&mut self.send_copy_pool,
);
state.in_flight = false;
break;
}
}
}
pushed
}
/// Pop the next queued send for a connection and submit it to the ring.
/// Returns true if a send was submitted, false if the queue was empty
/// (in which case in_flight is set to false).
pub(crate) fn submit_next_queued(&mut self, conn_index: u32) -> bool {
use crate::buffer::send_slab::MAX_IOVECS;
let ci = conn_index as usize;
// Coalesce a run of consecutive plaintext copy sends (pool_slot set, no
// ZC slab) at the front of the queue into a single `sendmsg`, so more
// than one queued message is pipelined per CQE round-trip. Order is
// preserved (one SQE; iovec order = FIFO queue order). ZC-guard sends
// and recv-buffer forwards are not coalescable and fall through to the
// single-submit path below.
let coalescable =
|b: &crate::handler::BuiltSend| b.pool_slot != u16::MAX && b.slab_idx == u16::MAX;
let n = {
let q = &self.send_queues[ci].queue;
let mut n = 0;
while n < MAX_IOVECS {
match q.get(n) {
Some(b) if coalescable(b) => n += 1,
_ => break,
}
}
n
};
if n >= 2 {
let mut pool_slots = [u16::MAX; MAX_IOVECS];
{
let q = &self.send_queues[ci].queue;
for (i, slot) in pool_slots.iter_mut().enumerate().take(n) {
*slot = q[i].pool_slot;
}
}
let mut iovecs = [libc::iovec {
iov_base: std::ptr::null_mut(),
iov_len: 0,
}; MAX_IOVECS];
let mut total: u32 = 0;
for i in 0..n {
let (ptr, len) = self.send_copy_pool.current_ptr_remaining(pool_slots[i]);
iovecs[i] = libc::iovec {
iov_base: ptr as *mut libc::c_void,
iov_len: len as usize,
};
total += len;
}
// Only commit to coalescing if the slab has room; otherwise fall
// through to single-submit (nothing popped yet).
if let Some((slab_idx, msg_ptr)) =
self.send_slab
.allocate_coalesced(conn_index, &iovecs[..n], &pool_slots[..n], total)
{
for _ in 0..n {
self.send_queues[ci].queue.pop_front();
}
match self
.ring
.submit_send_msg_coalesced(conn_index, msg_ptr, slab_idx)
{
Ok(()) => return true,
Err(_) => {
// SQ full — release the coalesced slab entry + its pool
// slots, drain the rest of the queue, clear in_flight.
for &s in &pool_slots[..n] {
self.send_copy_pool.release(s);
}
self.send_slab.release(slab_idx);
let state = &mut self.send_queues[ci];
Self::release_queued_sends(
&mut state.queue,
&mut self.send_slab,
&mut self.send_copy_pool,
);
state.in_flight = false;
state.shutdown_pending = false;
self.try_finalize_close(conn_index);
return false;
}
}
}
// slab full → fall through to single-submit
}
let state = &mut self.send_queues[ci];
match state.queue.pop_front() {
Some(built) => {
let pool_slot = built.pool_slot;
let slab_idx = built.slab_idx;
match unsafe { self.ring.push_sqe(built.entry) } {
Ok(()) => true,
Err(_) => {
// SQ full — release this entry and drain remaining queue.
Self::release_built_resources(
&mut self.send_slab,
&mut self.send_copy_pool,
pool_slot,
slab_idx,
);
Self::release_queued_sends(
&mut state.queue,
&mut self.send_slab,
&mut self.send_copy_pool,
);
state.in_flight = false;
state.shutdown_pending = false;
// If a deferred close was pending, fire it now that
// the queue is drained.
self.try_finalize_close(conn_index);
false
}
}
}
None => {
state.in_flight = false;
// Submit deferred shutdown_write now that the send queue is drained.
if state.shutdown_pending {
state.shutdown_pending = false;
let _ = self.ring.submit_shutdown(conn_index);
}
false
}
}
}
/// Submit a built send SQE or queue it if a send is already in-flight.
///
/// This is the Driver-level equivalent of `DriverCtx::submit_or_queue`,
/// used by zero-copy forward paths that bypass DriverCtx.
pub(crate) fn submit_or_queue_send(
&mut self,
conn_index: u32,
built: crate::handler::BuiltSend,
) -> io::Result<()> {
let state = &mut self.send_queues[conn_index as usize];
if state.in_flight {
state.queue.push_back(built);
Ok(())
} else {
let entry = built.entry.clone();
match unsafe { self.ring.push_sqe(entry) } {
Ok(()) => {
state.in_flight = true;
Ok(())
}
Err(e) => {
// For SendRecvBuf, pool_slot and slab_idx are u16::MAX (no resources).
// The caller is responsible for replenishing the recv buffer bid on error.
if built.slab_idx != u16::MAX {
let pool_slot = self.send_slab.release(built.slab_idx);
if pool_slot != u16::MAX {
self.send_copy_pool.release(pool_slot);
}
} else if built.pool_slot != u16::MAX {
self.send_copy_pool.release(built.pool_slot);
}
Err(e)
}
}
}
}
/// Drain and release all queued sends for a connection.
pub(crate) fn drain_conn_send_queue(&mut self, conn_index: u32) {
let state = &mut self.send_queues[conn_index as usize];
Self::release_queued_sends(
&mut state.queue,
&mut self.send_slab,
&mut self.send_copy_pool,
);
state.in_flight = false;
}
/// Release all entries from a send queue.
pub(crate) fn release_queued_sends(
queue: &mut VecDeque<BuiltSend>,
send_slab: &mut InFlightSendSlab,
send_copy_pool: &mut SendCopyPool,
) {
for built in queue.drain(..) {
Self::release_built_resources(
send_slab,
send_copy_pool,
built.pool_slot,
built.slab_idx,
);
}
}
/// Release pool slot and/or slab entry for a single BuiltSend.
pub(crate) fn release_built_resources(
send_slab: &mut InFlightSendSlab,
send_copy_pool: &mut SendCopyPool,
pool_slot: u16,
slab_idx: u16,
) {
if slab_idx != u16::MAX {
let ps = send_slab.release(slab_idx);
if ps != u16::MAX {
send_copy_pool.release(ps);
}
} else if pool_slot != u16::MAX {
send_copy_pool.release(pool_slot);
}
}
/// Create a UDP socket, bind with SO_REUSEPORT, register in fixed file table.
fn setup_udp_socket(
ring: &Ring,
bind_addr: SocketAddr,
connect_peer: Option<SocketAddr>,
fd_index: u32,
send_slots: u16,
udp_gro: bool,
) -> Result<UdpSocketState, crate::error::Error> {
let domain = if bind_addr.is_ipv4() {
libc::AF_INET
} else {
libc::AF_INET6
};
let fd = unsafe { libc::socket(domain, libc::SOCK_DGRAM | libc::SOCK_NONBLOCK, 0) };
if fd < 0 {
return Err(crate::error::Error::Io(std::io::Error::last_os_error()));
}
// Set SO_REUSEPORT for multi-worker binding.
let optval: libc::c_int = 1;
unsafe {
libc::setsockopt(
fd,
libc::SOL_SOCKET,
libc::SO_REUSEPORT,
&optval as *const _ as *const libc::c_void,
std::mem::size_of::<libc::c_int>() as libc::socklen_t,
);
}
// Enable UDP GRO. Opt-in, so a failure is hard rather than silent —
// the caller has deliberately enlarged recv buffers expecting
// coalescing, and quietly running without it would mislead.
if udp_gro {
let on: libc::c_int = 1;
let rc = unsafe {
libc::setsockopt(
fd,
libc::SOL_UDP,
crate::backend::udp_gro::UDP_GRO,
&on as *const _ as *const libc::c_void,
std::mem::size_of::<libc::c_int>() as libc::socklen_t,
)
};
if rc < 0 {
let err = std::io::Error::last_os_error();
unsafe { libc::close(fd) };
return Err(crate::error::Error::Io(err));
}
}
// Bind.
let mut storage: libc::sockaddr_storage = unsafe { std::mem::zeroed() };
let addr_len = crate::backend::socket_addr_to_sockaddr(bind_addr, &mut storage);
let ret =
unsafe { libc::bind(fd, &storage as *const _ as *const libc::sockaddr, addr_len) };
if ret < 0 {
let err = std::io::Error::last_os_error();
unsafe {
libc::close(fd);
}
return Err(crate::error::Error::Io(err));
}
// If a peer was supplied, connect(2) the socket before registering
// the fd. The kernel will filter incoming datagrams to this peer and
// we can use the lighter Recv/Send opcodes for this socket.
if let Some(peer) = connect_peer {
let mut peer_storage: libc::sockaddr_storage = unsafe { std::mem::zeroed() };
let peer_len = crate::backend::socket_addr_to_sockaddr(peer, &mut peer_storage);
let ret = unsafe {
libc::connect(
fd,
&peer_storage as *const _ as *const libc::sockaddr,
peer_len,
)
};
if ret < 0 {
let err = std::io::Error::last_os_error();
unsafe {
libc::close(fd);
}
return Err(crate::error::Error::Io(err));
}
}
// Register in the fixed file table, then close the original fd.
ring.register_files_update(fd_index, &[fd])?;
unsafe {
libc::close(fd);
}
// Build the msghdr *template* for multishot recvmsg. The kernel only
// reads `msg_namelen` / `msg_controllen` / `msg_iovlen` from this;
// the actual name/control/payload land inside a buffer from the
// provided buffer ring (laid out as `io_uring_recvmsg_out` + name +
// control + payload). No iov is needed for multishot.
let mut recv_msghdr: Box<libc::msghdr> = Box::new(unsafe { std::mem::zeroed() });
recv_msghdr.msg_namelen = std::mem::size_of::<libc::sockaddr_storage>() as u32;
// When GRO is on, reserve control space so the kernel can attach the
// UDP_GRO cmsg (segment size) inside each provided buffer. The kernel
// reads this length off the template; `rearm_udp_recvmsg` only resets
// `msg_namelen`, so this reservation survives re-arming. 0 keeps the
// control region inert for non-GRO sockets.
recv_msghdr.msg_controllen = if udp_gro {
crate::backend::udp_gro::UDP_GRO_CMSG_LEN
} else {
0
};
recv_msghdr.msg_iov = std::ptr::null_mut();
recv_msghdr.msg_iovlen = 0;
// Allocate send slot ring. Each slot owns its own (addr, iov, msghdr)
// so multiple sendmsg SQEs can be in-flight concurrently.
let mut slots: Vec<UdpSendSlot> = Vec::with_capacity(send_slots as usize);
for _ in 0..send_slots {
let mut send_addr: Box<libc::sockaddr_storage> =
Box::new(unsafe { std::mem::zeroed() });
let mut send_iov = Box::new(libc::iovec {
iov_base: std::ptr::null_mut(),
iov_len: 0,
});
let mut send_msghdr: Box<libc::msghdr> = Box::new(unsafe { std::mem::zeroed() });
let mut send_cmsg_buf: Box<[u8; UDP_GSO_CMSG_LEN]> = Box::new([0u8; UDP_GSO_CMSG_LEN]);
send_msghdr.msg_name = &mut *send_addr as *mut _ as *mut libc::c_void;
send_msghdr.msg_iov = &mut *send_iov as *mut libc::iovec;
send_msghdr.msg_iovlen = 1;
// `msg_control` always points at our pinned cmsg buffer;
// `msg_controllen = 0` for non-GSO sends keeps it inert.
send_msghdr.msg_control = send_cmsg_buf.as_mut_ptr() as *mut libc::c_void;
send_msghdr.msg_controllen = 0;
slots.push(UdpSendSlot {
send_addr,
send_iov,
send_msghdr,
send_cmsg_buf,
});
}
let send_slots_box = slots.into_boxed_slice();
// Freelist is a LIFO stack of free slot indices (reverse order so slot 0 is popped first).
let send_freelist: Vec<u16> = (0..send_slots).rev().collect();
Ok(UdpSocketState {
fd_index,
local_addr: bind_addr,
connected_peer: connect_peer,
recv_msghdr,
gro: udp_gro,
send_slots: send_slots_box,
send_freelist,
})
}
/// Send a UDP datagram via the copy pool.
///
/// Allocates one of the socket's pre-allocated send slots (bounded by
/// `Config::udp_send_slots`) and submits a `sendmsg` SQE. Multiple sends
/// can be in flight concurrently; returns `PoolExhausted` when no free
/// send slot or copy-pool slot is available.
///
/// When `gso_segment_size` is `Some(s)`, attaches a `UDP_SEGMENT`
/// control message: the kernel splits `data` into back-to-back
/// `s`-byte datagrams and emits each as a separate UDP packet from
/// the *same* `sendmsg` call. This is Linux's GSO offload — one
/// syscall, N datagrams. The pool slot still holds `data` end-to-
/// end, so the per-datagram cost is just an iovec entry plus
/// kernel-side segmentation work.
pub(crate) fn udp_send_to(
&mut self,
udp_index: u32,
peer: SocketAddr,
data: &[u8],
gso_segment_size: Option<u16>,
) -> Result<(), crate::error::UdpSendError> {
let idx = udp_index as usize;
if idx >= self.udp_sockets.len() {
return Err(crate::error::UdpSendError::Io(std::io::Error::other(
"invalid UDP socket index",
)));
}
// Reject oversize datagrams up front with a non-retryable error so
// callers don't burn cycles awaiting `send_ready` on data that will
// never fit. `send_copy_pool::copy_in` would also fail here, but it
// collapses size and exhaustion into a single `None` — losing the
// distinction the API needs.
let slot_size = self.send_copy_pool.slot_size() as usize;
if data.len() > slot_size {
return Err(crate::error::UdpSendError::Io(std::io::Error::new(
std::io::ErrorKind::InvalidInput,
format!(
"datagram size {} exceeds send_copy_slot_size {}",
data.len(),
slot_size
),
)));
}
if let Some(seg) = gso_segment_size
&& (seg == 0 || (seg as usize) > data.len())
{
return Err(crate::error::UdpSendError::Io(std::io::Error::new(
std::io::ErrorKind::InvalidInput,
format!(
"GSO segment size {} invalid for {}-byte buffer",
seg,
data.len()
),
)));
}
let slot_idx = self.udp_sockets[idx]
.send_freelist
.pop()
.ok_or(crate::error::UdpSendError::PoolExhausted)?;
let (pool_slot, ptr, len) = match self.send_copy_pool.copy_in(data) {
Some(v) => v,
None => {
// Return the send slot to the freelist before reporting exhaustion.
self.udp_sockets[idx].send_freelist.push(slot_idx);
return Err(crate::error::UdpSendError::PoolExhausted);
}
};
let fd_index = self.udp_sockets[idx].fd_index;
// Fast path: if the socket is connect(2)ed to this peer and there is
// no GSO segmenting, skip msghdr setup and submit the lighter `Send`
// opcode. The kernel uses the socket's connected peer and the SQE
// carries no sockaddr / iovec / cmsg. Saves a kernel msghdr
// copy_from_user per send.
let use_send_fast_path = gso_segment_size.is_none()
&& self.udp_sockets[idx]
.connected_peer
.is_some_and(|p| p == peer);
if use_send_fast_path {
let payload = encode_udp_send_payload(slot_idx, pool_slot);
let ud = UserData::encode(OpTag::SendUdp, udp_index, payload);
return match self.ring.submit_send_udp(fd_index, ptr, len, ud) {
Ok(()) => {
crate::metrics::UDP.increment(crate::metrics::udp::DATAGRAMS_SENT);
Ok(())
}
Err(_) => {
self.send_copy_pool.release(pool_slot);
self.udp_sockets[idx].send_freelist.push(slot_idx);
Err(crate::error::UdpSendError::SubmissionQueueFull)
}
};
}
let slot = &mut self.udp_sockets[idx].send_slots[slot_idx as usize];
let addr_len = crate::backend::socket_addr_to_sockaddr(peer, &mut slot.send_addr);
slot.send_iov.iov_base = ptr as *mut libc::c_void;
slot.send_iov.iov_len = len as usize;
slot.send_msghdr.msg_namelen = addr_len;
// Wire up (or tear down) the `UDP_SEGMENT` control message in
// the pinned per-slot cmsg buffer. We do not touch
// `slot.send_cmsg_buf` for non-GSO sends — `msg_controllen = 0`
// tells the kernel to ignore it.
if let Some(seg_size) = gso_segment_size {
let cmsg_total = unsafe { libc::CMSG_SPACE(std::mem::size_of::<u16>() as u32) };
debug_assert!(
(cmsg_total as usize) <= UDP_GSO_CMSG_LEN,
"UDP_GSO_CMSG_LEN too small for cmsg_space"
);
let buf = slot.send_cmsg_buf.as_mut_ptr();
// SAFETY: `slot.send_cmsg_buf` is pinned in the slot
// (Box-allocated, lives until the slot is dropped). We
// populate exactly the bytes the kernel will read.
unsafe {
std::ptr::write_bytes(buf, 0, UDP_GSO_CMSG_LEN);
slot.send_msghdr.msg_control = buf as *mut libc::c_void;
slot.send_msghdr.msg_controllen = cmsg_total as _;
let cmsg = libc::CMSG_FIRSTHDR(&*slot.send_msghdr);
(*cmsg).cmsg_level = libc::IPPROTO_UDP;
(*cmsg).cmsg_type = libc::UDP_SEGMENT;
(*cmsg).cmsg_len = libc::CMSG_LEN(std::mem::size_of::<u16>() as u32) as _;
let data_ptr = libc::CMSG_DATA(cmsg) as *mut u16;
std::ptr::write_unaligned(data_ptr, seg_size);
}
} else {
slot.send_msghdr.msg_controllen = 0;
}
let msghdr_ptr = &*slot.send_msghdr as *const libc::msghdr;
let payload = encode_udp_send_payload(slot_idx, pool_slot);
let ud = UserData::encode(OpTag::SendMsgUdp, udp_index, payload);
match self.ring.submit_sendmsg(fd_index, msghdr_ptr, ud) {
Ok(()) => {
crate::metrics::UDP.increment(crate::metrics::udp::DATAGRAMS_SENT);
Ok(())
}
Err(_) => {
self.send_copy_pool.release(pool_slot);
self.udp_sockets[idx].send_freelist.push(slot_idx);
Err(crate::error::UdpSendError::SubmissionQueueFull)
}
}
}
/// Re-arm the UDP multishot recvmsg for a socket. Called when the kernel
/// tears the multishot down (e.g. on `ENOBUFS` after the buffer ring
/// emptied) — the CQE handler pushes the hint here once replenishment
/// has refilled the ring.
pub(crate) fn rearm_udp_recvmsg(&mut self, udp_index: u32, bgid: u16) {
let idx = udp_index as usize;
if idx >= self.udp_sockets.len() {
return;
}
// Reset msg_namelen in case the kernel cleared it during teardown.
self.udp_sockets[idx].recv_msghdr.msg_namelen =
std::mem::size_of::<libc::sockaddr_storage>() as u32;
let fd_index = self.udp_sockets[idx].fd_index;
let result = if self.udp_sockets[idx].connected_peer.is_some() {
let ud = UserData::encode(OpTag::RecvUdp, udp_index, 0);
self.ring.submit_multishot_recv_udp(fd_index, bgid, ud)
} else {
let ud = UserData::encode(OpTag::RecvMsgUdp, udp_index, 0);
let msghdr_ptr = &*self.udp_sockets[idx].recv_msghdr as *const libc::msghdr;
self.ring
.submit_recvmsg_multishot(fd_index, msghdr_ptr, bgid, ud)
};
if result.is_err() {
crate::metrics::RING.increment(crate::metrics::ring::SQE_SUBMIT_FAILURES);
}
}
/// Shutdown: close all connections, drain remaining CQEs, close eventfd.
pub(crate) fn run_shutdown(&mut self) {
// 1. Close all active connections and drain their send queues.
let max = self.connections.max_slots();
for i in 0..max {
if self.connections.get(i).is_some() {
self.drain_conn_send_queue(i);
// Best effort: kernel cleans up fds on thread/process exit.
let _ = self.ring.submit_close(i);
}
}
// 2. Submit + drain loop until all connections are closed.
// Arm a timeout SQE each iteration so submit_and_wait(1) never blocks
// indefinitely (the tick timeout from the main loop is not armed here).
let shutdown_ts = io_uring::types::Timespec::new().nsec(100_000_000); // 100ms
for _ in 0..100 {
if self.connections.active_count() == 0 && !self.send_slab.has_in_flight() {
break;
}
let ud = UserData::encode(OpTag::TickTimeout, 0, 0);
// Best effort: the 100-iteration bound prevents infinite block.
let _ = self.ring.submit_tick_timeout(&shutdown_ts, ud.raw());
if self.ring.submit_and_wait(1).is_err() {
break;
}
self.cqe_batch.clear();
{
let cq = self.ring.ring.completion();
for cqe in cq {
self.cqe_batch.push((
cqe.user_data(),
cqe.result(),
cqe.flags(),
*cqe.big_cqe(),
));
}
}
for i in 0..self.cqe_batch.len() {
let (user_data_raw, result, flags, _big_cqe) = self.cqe_batch[i];
let ud = UserData(user_data_raw);
let tag = match ud.tag() {
Some(t) => t,
None => continue,
};
match tag {
OpTag::Send => {
let pool_slot = ud.payload() as u16;
self.send_copy_pool.release(pool_slot);
}
OpTag::SendMsgZc => {
let slab_idx = ud.payload() as u16;
if !self.send_slab.in_use(slab_idx) {
continue;
}
if cqueue::notif(flags) {
self.send_slab.dec_pending_notifs(slab_idx);
if self.send_slab.should_release(slab_idx) {
let pool_slot = self.send_slab.release(slab_idx);
if pool_slot != u16::MAX {
self.send_copy_pool.release(pool_slot);
}
}
} else {
// Only expect a ZC notification when result > 0.
// On error/zero, no notification arrives — incrementing
// would permanently leak the slab entry.
if result > 0 {
self.send_slab.inc_pending_notifs(slab_idx);
}
self.send_slab.mark_awaiting_notifications(slab_idx);
if self.send_slab.should_release(slab_idx) {
let pool_slot = self.send_slab.release(slab_idx);
if pool_slot != u16::MAX {
self.send_copy_pool.release(pool_slot);
}
}
}
}
OpTag::Close => {
let conn_index = ud.conn_index();
if let Some(ref mut tls_table) = self.tls_table {
tls_table.remove(conn_index);
}
self.connections.release(conn_index);
}
OpTag::TlsSend => {
let pool_slot = ud.payload() as u16;
self.send_copy_pool.release(pool_slot);
}
_ => {}
}
}
}
// 3. Unregister the provided buffer rings before Driver is dropped
// (which munmaps the ring memory). Without this, the kernel holds a
// dangling pointer to the freed mmap region.
if self
.ring
.unregister_buf_ring(self.provided_bufs.bgid())
.is_err()
{
crate::metrics::RING.increment(crate::metrics::ring::SQE_SUBMIT_FAILURES);
}
if let Some(ref udp_bufs) = self.udp_provided_bufs
&& self.ring.unregister_buf_ring(udp_bufs.bgid()).is_err()
{
crate::metrics::RING.increment(crate::metrics::ring::SQE_SUBMIT_FAILURES);
}
// The eventfd is owned by `ShutdownHandle::Drop` (it holds the
// matching `WakeHandle`), so don't close it here — the handle's
// wake clones live longer than the worker thread, and a
// double-close would race against fd-number reuse.
}
}
#[cfg(test)]
mod field_order_tests {
//! Drop-order proof for the kernel/DMA fields of `Driver`.
//!
//! Rust drops struct fields in *declaration* order, so `ring` (declared
//! first) drops last. We can't directly observe `Driver` dropping (it
//! owns a real `io_uring`), but we can verify the property in a mirror
//! struct with the same field ordering and `Drop`-instrumented stand-ins.
use std::cell::RefCell;
use std::sync::Mutex;
static DROP_ORDER: Mutex<Vec<&'static str>> = Mutex::new(Vec::new());
struct DropMarker(&'static str);
impl Drop for DropMarker {
fn drop(&mut self) {
DROP_ORDER.lock().unwrap().push(self.0);
}
}
/// Mirrors the head of `Driver`'s field declaration order. If a future
/// edit moves `ring` out of first position, the order recorded here
/// will diverge from `["send_slab", "provided_bufs", "ring"]` and the
/// test will fail loudly.
#[allow(dead_code)]
struct DriverFieldOrderMirror {
ring: DropMarker,
// `connections`, `fixed_buffers` etc. interleave here in the real
// struct; only the kernel-DMA-sensitive ones matter for this test.
provided_bufs: DropMarker,
send_slab: DropMarker,
}
#[test]
fn ring_drops_after_buffer_pools() {
// Reset.
DROP_ORDER.lock().unwrap().clear();
// Sanity: if someone re-orders the mirror to put ring last, this
// test will catch it.
let _ = RefCell::new(()); // silence stray-lifetime lints
{
let _m = DriverFieldOrderMirror {
ring: DropMarker("ring"),
provided_bufs: DropMarker("provided_bufs"),
send_slab: DropMarker("send_slab"),
};
} // drop runs here
let order = DROP_ORDER.lock().unwrap().clone();
assert_eq!(
order,
vec!["ring", "provided_bufs", "send_slab"],
"DriverFieldOrderMirror dropped in the wrong order — \
reorder the fields to match `Driver`'s declaration so \
`ring` is declared *first* and therefore drops *last*",
);
// The real assertion: in the *real* Driver, `ring` must be
// declared before the DMA-sensitive fields.
let src = include_str!("driver.rs");
let ring_pos = src
.find("pub(crate) ring: Ring,")
.expect("Driver::ring field signature not found — was it renamed?");
let provided_pos = src
.find("pub(crate) provided_bufs: ProvidedBufRing,")
.expect("Driver::provided_bufs field signature not found");
let send_slab_pos = src
.find("pub(crate) send_slab: InFlightSendSlab,")
.expect("Driver::send_slab field signature not found");
assert!(
ring_pos < provided_pos,
"Driver::ring must be declared before Driver::provided_bufs \
so it drops *after* it (kernel DMA reference safety)",
);
assert!(
ring_pos < send_slab_pos,
"Driver::ring must be declared before Driver::send_slab \
so it drops *after* it (ZC user-memory guards safety)",
);
}
}