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
use std::net::SocketAddr;
use crate::buffer::fixed::MemoryRegion;
/// TLS configuration. Pass a pre-built rustls ServerConfig.
#[derive(Clone)]
pub struct TlsConfig {
/// Pre-built rustls ServerConfig. User loads certs/keys and configures ALPN etc.
pub server_config: std::sync::Arc<rustls::ServerConfig>,
}
/// TLS client configuration for outbound connections.
#[derive(Clone)]
pub struct TlsClientConfig {
/// Pre-built rustls ClientConfig. User configures root certs, ALPN, etc.
pub client_config: std::sync::Arc<rustls::ClientConfig>,
}
/// Configuration for the io_uring driver.
#[derive(Clone)]
pub struct Config {
/// Number of SQ entries. CQ will be 4x this.
pub sq_entries: u32,
/// Enable SQPOLL mode (kernel-side submission polling).
pub sqpoll: bool,
/// SQPOLL idle timeout in milliseconds.
pub sqpoll_idle_ms: u32,
/// Pin SQPOLL kernel thread to this CPU core. Only meaningful when sqpoll=true.
pub sqpoll_cpu: Option<u32>,
/// Recv buffer configuration (provided buffer ring) for TCP multishot recv.
pub recv_buffer: RecvBufferConfig,
/// Recv buffer configuration for UDP multishot recvmsg.
///
/// UDP uses a separate provided buffer ring from TCP so the two can be
/// sized independently. Each buffer must fit an `io_uring_recvmsg_out`
/// header (16 bytes) + `sockaddr_storage` (128 bytes) + the datagram
/// payload. Default: 128 buffers × 2048 bytes (room for a standard-MTU
/// datagram plus the multishot metadata); bump `buffer_size` if you
/// expect jumbo datagrams.
///
/// `bgid` must differ from `recv_buffer.bgid` when UDP is in use.
pub udp_recv_buffer: RecvBufferConfig,
/// User-registered memory regions (e.g., mmap'd storage arenas).
///
/// Regions listed here occupy slots `0..registered_regions.len()` at
/// startup. The remaining slots up to [`Config::max_registered_regions`] are
/// available for dynamic registration via
/// [`ShutdownHandle::register_region`](crate::ShutdownHandle::register_region).
pub registered_regions: Vec<MemoryRegion>,
/// Maximum number of fixed-buffer slots to reserve in the io_uring
/// registered-buffer table. Must be `>= registered_regions.len()`.
///
/// Slots beyond the initial regions are empty until filled by
/// [`ShutdownHandle::register_region`](crate::ShutdownHandle::register_region).
/// Cannot be grown after launch — io_uring's registered-buffer table is
/// fixed-size; expand by re-launching with a larger value.
///
/// Default: 64.
pub max_registered_regions: u16,
/// Worker/thread configuration.
pub worker: WorkerConfig,
/// TCP listen backlog.
pub backlog: i32,
/// Maximum number of direct file descriptors (connections).
pub max_connections: u32,
/// Initial capacity for per-connection recv accumulators.
pub recv_accumulator_capacity: usize,
/// Upper bound on a single per-connection recv accumulator. If the
/// application's parser keeps returning `NeedMore` while the peer
/// streams data, the accumulator grows indefinitely; setting this
/// closes the connection once the cap is exceeded, protecting the
/// worker from OOM.
///
/// **Default: `usize::MAX` (disabled).** A bounded value should be set
/// for any server that accepts data from untrusted peers. Sensible
/// values are 4–16× the typical request size; setting it too low
/// will close legitimate slow-consumer workloads (where kernel recv
/// CQEs batch faster than the handler runs).
pub recv_accumulator_max: usize,
/// Bound on the per-worker accept channel. If a worker can't drain its
/// queue fast enough, the acceptor will skip past it (and possibly
/// close the incoming fd if every worker is full) rather than
/// accumulating fds without backpressure. Default: 1024.
pub accept_queue_capacity: usize,
/// Number of connections assigned to each worker before moving to the
/// next one. `1` (the default) gives classic round-robin. Higher values
/// pack connections onto fewer workers at low connection counts, keeping
/// each active worker's CQE density high enough for io_uring batching to
/// pay off. Has no effect once total connections exceed
/// `conn_chunk_size * num_workers` — at that point every worker is
/// active and each gets the same number of connections as round-robin.
///
/// Rule of thumb: set to the minimum connections-per-worker at which
/// your workload sees good batching (typically 16–64). Default: 1.
pub conn_chunk_size: usize,
/// Number of copy-send pool slots. Each in-flight `send()` or copy part of a
/// `send_parts()` call holds one slot until the kernel completes the send.
/// Size this to cover your peak in-flight send count — exhaustion returns an
/// error to the handler. Memory cost: `send_copy_count * send_copy_slot_size`.
pub send_copy_count: u16,
/// Size of each copy-send pool slot in bytes. A single `send()` or the
/// combined copy parts of one `send_parts()` call must fit in one slot.
pub send_copy_slot_size: u32,
/// Number of InFlightSendSlab slots for in-flight scatter-gather sends
/// (i.e., `send_parts()` calls that include at least one guard).
/// Each slot is held until all ZC notifications arrive.
pub send_slab_slots: u16,
/// Deadline-based flush interval in microseconds during CQE processing.
/// When non-SQPOLL, if this many microseconds elapse since the last submit
/// while processing a CQE batch, pending SQEs are flushed mid-iteration.
/// 0 = disabled. Ignored when SQPOLL is active (kernel handles it).
pub flush_interval_us: u64,
/// Maximum time in microseconds that `submit_and_wait` will block before
/// returning to call `on_tick`. Prevents the event loop from stalling when
/// there are no pending completions (e.g., client-only mode between phases).
/// 0 = no timeout (block indefinitely until a CQE arrives).
/// Default: 1000 (1ms).
pub tick_timeout_us: u64,
/// Optional TLS configuration. When set, all accepted connections use TLS.
pub tls: Option<TlsConfig>,
/// Optional TLS client configuration for outbound `connect_tls()` calls.
pub tls_client: Option<TlsClientConfig>,
/// Enable TCP_NODELAY on all connections (accepted and outbound).
pub tcp_nodelay: bool,
/// Enable SO_TIMESTAMPING for kernel-level receive timestamps.
/// When enabled, connections use `RecvMsgMulti` instead of `RecvMulti`
/// to receive ancillary data containing kernel RX timestamps.
#[cfg(feature = "timestamps")]
pub timestamps: bool,
/// Maximum number of SQEs per IOSQE_IO_LINK chain. 0 disables chaining.
/// When disabled, sends exceeding MAX_IOVECS fall back to sequential
/// round-trips (one SQE at a time via on_send_complete).
/// Default: 16.
pub max_chain_length: u16,
/// Maximum number of standalone async tasks (not bound to connections)
/// per worker. Used with [`spawn()`](crate::spawn).
/// Default: 256.
pub standalone_task_capacity: u32,
/// Maximum number of concurrent timer slots per worker.
/// Used by [`sleep()`](crate::sleep) and [`timeout()`](crate::timeout).
/// Default: 256.
pub timer_slots: u32,
/// UDP bind addresses. Each worker creates its own socket with SO_REUSEPORT.
/// Empty = no UDP sockets.
pub udp_bind: Vec<SocketAddr>,
/// Optional peer to `connect(2)` each UDP socket to, parallel to
/// `udp_bind`. `None` leaves the socket unconnected (the usual UDP
/// server case); `Some(peer)` calls `connect()` so the kernel filters
/// incoming datagrams to that peer and the runtime can use the lighter
/// `RecvUdp`/`SendUdp` opcodes instead of `RecvMsgUdp`/`SendMsgUdp`.
/// Saves ~4 microseconds per round trip on single-shot client workloads.
/// Must have the same length as `udp_bind` (enforced at validation).
pub udp_connect_peers: Vec<Option<SocketAddr>>,
/// Number of concurrent in-flight UDP sends per socket. Each slot owns a
/// pre-allocated `sockaddr_storage` + `iovec` + `msghdr` triple used to
/// submit a `sendmsg` SQE; the slot is returned to the freelist on CQE.
/// Exhaustion returns [`crate::error::UdpSendError::PoolExhausted`].
/// Default: 64.
pub udp_send_slots: u16,
/// Maximum number of datagrams buffered per UDP socket awaiting a
/// consumer. The runtime fills this queue from `recvmsg` completions;
/// the application's `on_udp_bind` future drains it via
/// [`UdpCtx::recv_from`](crate::UdpCtx::recv_from). When the queue is
/// full, additional datagrams are dropped and
/// `udp::DATAGRAMS_DROPPED` is incremented — this guards against
/// unbounded memory growth when the handler future stalls, panics,
/// or returns early.
///
/// Default: 1024.
pub udp_recv_queue_capacity: usize,
/// Enable UDP Generic Receive Offload (GRO) on bound UDP sockets.
///
/// When set, the runtime calls `setsockopt(SOL_UDP, UDP_GRO)` so the
/// kernel coalesces consecutive same-flow datagrams into one `recvmsg`
/// delivery, carrying the per-segment size in a control message. The
/// runtime splits the coalesced payload back into individual datagrams
/// transparently, so [`UdpCtx::recv_batch`](crate::UdpCtx::recv_batch) /
/// [`recv_batch_timed`](crate::UdpCtx::recv_batch_timed) callbacks still
/// fire once per datagram. This cuts per-datagram syscall / wake overhead
/// dramatically for high-pps flows (e.g. QUIC at large payloads).
///
/// A coalesced datagram can be up to ~64 KiB, and on io_uring the
/// recvmsg header + sockaddr + control + payload share one provided
/// buffer, so enabling GRO requires `udp_recv_buffer.buffer_size` to be
/// large enough to hold a full coalesced datagram (validated at startup);
/// otherwise the kernel truncates and the datagram is dropped. Has no
/// effect on `connect(2)`-ed UDP sockets (they use the lighter `recv`
/// path, which carries no control message). Linux-only — a no-op on
/// other platforms. Default: false.
pub udp_gro: bool,
/// Optional NVMe passthrough configuration. When set, enables NVMe device
/// management and `IORING_OP_URING_CMD` submission for direct NVMe I/O.
pub nvme: Option<crate::nvme::NvmeConfig>,
/// Optional direct I/O configuration. When set, enables `O_DIRECT` file I/O
/// via io_uring `IORING_OP_READ` / `IORING_OP_WRITE`, bypassing the page cache.
pub direct_io: Option<crate::direct_io::DirectIoConfig>,
/// Optional buffered filesystem I/O configuration. When set, enables async
/// file open/read/write/stat/rename/unlink/mkdir via io_uring.
pub fs: Option<crate::fs::FsConfig>,
/// Number of dedicated DNS resolver threads. The resolver pool runs
/// `getaddrinfo` on background threads, keeping blocking DNS isolated
/// from the io_uring event loop.
///
/// 0 = disabled (no resolver pool; [`resolve()`](crate::resolve) will
/// return an error). Default: 2.
pub resolver_threads: usize,
/// Number of dedicated process spawner threads. The spawner pool runs
/// `posix_spawnp` + `pidfd_open` on background threads, keeping blocking
/// process creation isolated from the io_uring event loop.
///
/// 0 = disabled (no spawner pool; [`Command::spawn()`](crate::process::Command::spawn)
/// will return an error). Default: 1.
pub spawner_threads: usize,
/// Number of dedicated blocking threads. The blocking pool runs
/// user-provided closures on low-priority (`SCHED_IDLE`) background threads,
/// keeping CPU-bound or blocking work isolated from the io_uring event loop.
///
/// 0 = disabled (no blocking pool; [`spawn_blocking()`](crate::spawn_blocking)
/// will return an error). Default: 4.
pub blocking_threads: usize,
/// Number of dedicated disk I/O threads (mio backend only). The disk I/O
/// pool executes blocking filesystem syscalls (pread, pwrite, fsync, stat,
/// rename, unlink, mkdir) on background threads, enabling async file I/O
/// on non-Linux platforms.
///
/// 0 = disabled (filesystem/direct I/O operations return `Unsupported`).
/// Default: 2.
pub disk_io_threads: usize,
/// Maximum time in milliseconds to wait for a TLS close_notify send to
/// complete before force-closing the connection. When a TLS connection
/// sends close_notify but the send never completes (e.g., due to pool
/// exhaustion), this prevents the connection from hanging indefinitely.
/// Default: 5000.
pub close_notify_timeout_ms: u64,
}
impl Default for Config {
fn default() -> Self {
Self {
sq_entries: 256,
sqpoll: false,
sqpoll_idle_ms: 1000,
sqpoll_cpu: None,
recv_buffer: RecvBufferConfig::default(),
udp_recv_buffer: RecvBufferConfig {
ring_size: 128,
buffer_size: 2048,
bgid: 1,
},
registered_regions: Vec::new(),
max_registered_regions: 64,
worker: WorkerConfig::default(),
backlog: 1024,
max_connections: 16000,
recv_accumulator_capacity: 4096,
recv_accumulator_max: usize::MAX,
accept_queue_capacity: 1024,
conn_chunk_size: 1,
send_copy_count: 1024,
send_copy_slot_size: 16384,
send_slab_slots: 512,
flush_interval_us: 100,
tick_timeout_us: 1000,
tls: None,
tls_client: None,
tcp_nodelay: true,
#[cfg(feature = "timestamps")]
timestamps: false,
max_chain_length: 16,
standalone_task_capacity: 256,
timer_slots: 256,
udp_bind: Vec::new(),
udp_connect_peers: Vec::new(),
udp_send_slots: 64,
udp_recv_queue_capacity: 1024,
udp_gro: false,
nvme: None,
direct_io: None,
fs: Some(crate::fs::FsConfig::default()),
resolver_threads: 2,
spawner_threads: 1,
blocking_threads: 4,
disk_io_threads: 2,
close_notify_timeout_ms: 5000,
}
}
}
impl Config {
/// Validate configuration values. Returns an error if any value is out of range.
pub fn validate(&self) -> Result<(), crate::error::Error> {
if !self.recv_buffer.ring_size.is_power_of_two() {
return Err(crate::error::Error::RingSetup(
"recv_buffer.ring_size must be a power of two".into(),
));
}
if self.recv_buffer.buffer_size == 0 {
return Err(crate::error::Error::RingSetup(
"recv_buffer.buffer_size must be > 0".into(),
));
}
if self.max_connections == 0 || self.max_connections >= (1 << 24) {
return Err(crate::error::Error::RingSetup(
"max_connections must be > 0 and < 2^24".into(),
));
}
if self.timer_slots > 65535 {
return Err(crate::error::Error::RingSetup(
"timer_slots must be <= 65535".into(),
));
}
if self.send_copy_slot_size == 0 {
return Err(crate::error::Error::RingSetup(
"send_copy_slot_size must be > 0".into(),
));
}
if self.send_copy_count == 0 {
return Err(crate::error::Error::RingSetup(
"send_copy_count must be > 0".into(),
));
}
if self.sq_entries == 0 || !self.sq_entries.is_power_of_two() {
return Err(crate::error::Error::RingSetup(
"sq_entries must be > 0 and a power of two".into(),
));
}
if self.standalone_task_capacity >= (1 << 31) {
return Err(crate::error::Error::RingSetup(
"standalone_task_capacity must be < 2^31".into(),
));
}
if self.registered_regions.len() > self.max_registered_regions as usize {
return Err(crate::error::Error::RingSetup(format!(
"registered_regions ({}) exceed max_registered_regions ({})",
self.registered_regions.len(),
self.max_registered_regions,
)));
}
if !self.udp_bind.is_empty() && self.udp_send_slots == 0 {
return Err(crate::error::Error::RingSetup(
"udp_send_slots must be > 0 when udp_bind is non-empty".into(),
));
}
if !self.udp_connect_peers.is_empty() && self.udp_connect_peers.len() != self.udp_bind.len()
{
return Err(crate::error::Error::RingSetup(
"udp_connect_peers length must match udp_bind length".into(),
));
}
if !self.udp_bind.is_empty() && self.udp_recv_queue_capacity == 0 {
return Err(crate::error::Error::RingSetup(
"udp_recv_queue_capacity must be > 0 when udp_bind is non-empty".into(),
));
}
if !self.udp_bind.is_empty() {
if !self.udp_recv_buffer.ring_size.is_power_of_two() {
return Err(crate::error::Error::RingSetup(
"udp_recv_buffer.ring_size must be a power of two".into(),
));
}
// Ceiling is 256 KiB so UDP GRO (which coalesces up to ~64 KiB of
// payload plus the recvmsg header / sockaddr / control region into
// one provided buffer) can be sized to fit. Non-GRO callers
// typically stay near a single MTU.
if self.udp_recv_buffer.buffer_size == 0 || self.udp_recv_buffer.buffer_size > (1 << 18)
{
return Err(crate::error::Error::RingSetup(
"udp_recv_buffer.buffer_size must be > 0 and <= 262144".into(),
));
}
// Each datagram occupies one buffer that also holds the
// io_uring_recvmsg_out header (16 bytes) + sockaddr_storage
// (128 bytes). Below that floor the kernel can't fit even a
// zero-byte datagram plus the metadata.
if self.udp_recv_buffer.buffer_size < 160 {
return Err(crate::error::Error::RingSetup(
"udp_recv_buffer.buffer_size must be >= 160 to hold recvmsg header + sockaddr"
.into(),
));
}
// GRO coalesces up to ~64 KiB into a single delivery; the buffer
// must hold that plus the recvmsg header (16) + sockaddr (128) +
// control region, or the kernel truncates and the datagram is
// dropped silently. Require headroom past 64 KiB.
if self.udp_gro && self.udp_recv_buffer.buffer_size < (1 << 16) + 512 {
return Err(crate::error::Error::RingSetup(
"udp_recv_buffer.buffer_size must be >= 66048 when udp_gro is enabled \
(a coalesced GRO datagram is up to ~64 KiB plus recvmsg metadata)"
.into(),
));
}
if self.udp_recv_buffer.bgid == self.recv_buffer.bgid {
return Err(crate::error::Error::RingSetup(
"udp_recv_buffer.bgid must differ from recv_buffer.bgid".into(),
));
}
}
if self.close_notify_timeout_ms == 0 || self.close_notify_timeout_ms > 60000 {
return Err(crate::error::Error::RingSetup(
"close_notify_timeout_ms must be > 0 and <= 60000".into(),
));
}
Ok(())
}
}
/// Configuration for the provided buffer ring (multishot recv).
#[derive(Clone)]
pub struct RecvBufferConfig {
/// Number of buffers in the ring (must be power of 2).
pub ring_size: u16,
/// Size of each buffer in bytes.
pub buffer_size: u32,
/// Buffer group ID for the provided buffer ring.
pub bgid: u16,
}
impl Default for RecvBufferConfig {
fn default() -> Self {
Self {
ring_size: 256,
buffer_size: 16384,
bgid: 0,
}
}
}
/// Configuration for the thread-per-core worker model.
#[derive(Clone)]
pub struct WorkerConfig {
/// Number of worker threads.
///
/// `0` (the default) auto-detects and uses the number of **physical CPU
/// cores** — not logical CPUs. On SMT/hyperthreaded hardware this is half
/// the value returned by `nproc` or `available_parallelism()`. Ringline's
/// io_uring event loops are CPU-bound; two hyperthreads on the same
/// physical core share execution units and caches, so spawning one worker
/// per logical CPU induces contention without additional throughput.
///
/// Set explicitly to override (e.g. `threads = 1` for a single-threaded
/// server, or a larger value when you have many connections and the
/// per-worker CPU budget is low).
pub threads: usize,
/// Whether to pin each worker to a CPU core.
pub pin_to_core: bool,
/// Starting CPU core index for pinning.
pub core_offset: usize,
}
impl Default for WorkerConfig {
fn default() -> Self {
Self {
threads: 0,
pin_to_core: true,
core_offset: 0,
}
}
}
/// Builder for [`Config`] with discoverable methods and `build()` validation.
///
/// # Example
///
/// ```rust
/// use ringline::ConfigBuilder;
///
/// let config = ConfigBuilder::default()
/// .workers(4)
/// .max_connections(8000)
/// .sq_entries(512)
/// .tcp_nodelay(true)
/// .recv_buffer(256, 4096)
/// .send_pool(512, 8192)
/// .timer_slots(1024)
/// .build()
/// .expect("invalid config");
/// ```
#[derive(Default)]
pub struct ConfigBuilder {
config: Config,
}
impl ConfigBuilder {
/// Create a new builder with default config values.
pub fn new() -> Self {
Self::default()
}
// ── Worker settings ──────────────────────────────────────────────
/// Set the number of worker threads. 0 = number of CPUs.
pub fn workers(mut self, n: usize) -> Self {
self.config.worker.threads = n;
self
}
/// Enable or disable CPU core pinning.
pub fn pin_to_core(mut self, enable: bool) -> Self {
self.config.worker.pin_to_core = enable;
self
}
/// Set the starting CPU core index for pinning.
pub fn core_offset(mut self, offset: usize) -> Self {
self.config.worker.core_offset = offset;
self
}
// ── Connection settings ──────────────────────────────────────────
/// Set the maximum number of direct file descriptors (connections).
pub fn max_connections(mut self, n: u32) -> Self {
self.config.max_connections = n;
self
}
/// Set the TCP listen backlog.
pub fn backlog(mut self, n: i32) -> Self {
self.config.backlog = n;
self
}
/// Enable or disable TCP_NODELAY on all connections.
pub fn tcp_nodelay(mut self, enable: bool) -> Self {
self.config.tcp_nodelay = enable;
self
}
// ── io_uring settings ────────────────────────────────────────────
/// Set the number of SQ entries. CQ will be 4x this. Must be a power of 2.
pub fn sq_entries(mut self, n: u32) -> Self {
self.config.sq_entries = n;
self
}
/// Enable SQPOLL mode (kernel-side submission polling).
pub fn sqpoll(mut self, enable: bool) -> Self {
self.config.sqpoll = enable;
self
}
/// Set SQPOLL idle timeout in milliseconds (default: 1000).
pub fn sqpoll_idle_ms(mut self, ms: u32) -> Self {
self.config.sqpoll_idle_ms = ms;
self
}
/// Pin SQPOLL kernel thread to a specific CPU core.
pub fn sqpoll_cpu(mut self, cpu: u32) -> Self {
self.config.sqpoll_cpu = Some(cpu);
self
}
// ── Buffer settings ──────────────────────────────────────────────
/// Set recv buffer configuration.
pub fn recv_buffer(mut self, ring_size: u16, buffer_size: u32) -> Self {
self.config.recv_buffer.ring_size = ring_size;
self.config.recv_buffer.buffer_size = buffer_size;
self
}
/// Set the initial capacity for per-connection recv accumulators.
pub fn recv_accumulator_capacity(mut self, n: usize) -> Self {
self.config.recv_accumulator_capacity = n;
self
}
/// Set the number and size of copy-send pool slots.
pub fn send_pool(mut self, count: u16, slot_size: u32) -> Self {
self.config.send_copy_count = count;
self.config.send_copy_slot_size = slot_size;
self
}
/// Set the number of scatter-gather send slab slots.
pub fn send_slab_slots(mut self, n: u16) -> Self {
self.config.send_slab_slots = n;
self
}
// ── Task/timer settings ──────────────────────────────────────────
/// Set the maximum number of standalone async tasks per worker.
pub fn standalone_task_capacity(mut self, n: u32) -> Self {
self.config.standalone_task_capacity = n;
self
}
/// Set the maximum number of concurrent timer slots per worker.
pub fn timer_slots(mut self, n: u32) -> Self {
self.config.timer_slots = n;
self
}
// ── Timing settings ──────────────────────────────────────────────
/// Set the tick timeout in microseconds. 0 = block indefinitely.
pub fn tick_timeout_us(mut self, us: u64) -> Self {
self.config.tick_timeout_us = us;
self
}
/// Set the deadline-based flush interval in microseconds. 0 = disabled.
pub fn flush_interval_us(mut self, us: u64) -> Self {
self.config.flush_interval_us = us;
self
}
// ── Timestamp settings ────────────────────────────────────────────
/// Enable SO_TIMESTAMPING for kernel-level receive timestamps.
#[cfg(feature = "timestamps")]
pub fn timestamps(mut self, enable: bool) -> Self {
self.config.timestamps = enable;
self
}
// ── Chain settings ───────────────────────────────────────────────
/// Set the maximum number of SQEs per IO_LINK chain. 0 disables chaining.
pub fn max_chain_length(mut self, n: u16) -> Self {
self.config.max_chain_length = n;
self
}
// ── UDP settings ─────────────────────────────────────────────────
/// Add a UDP bind address. Can be called multiple times.
pub fn udp_bind(mut self, addr: SocketAddr) -> Self {
self.config.udp_bind.push(addr);
self.config.udp_connect_peers.push(None);
self
}
/// Add a UDP bind address that is then `connect(2)`ed to `peer`. The
/// kernel filters incoming datagrams to `peer` and the runtime can use
/// the lighter `RecvUdp`/`SendUdp` opcodes instead of the
/// `RecvMsgUdp`/`SendMsgUdp` pair. Saves ~4 microseconds per round trip
/// on single-shot client workloads.
pub fn udp_bind_connected(mut self, local: SocketAddr, peer: SocketAddr) -> Self {
self.config.udp_bind.push(local);
self.config.udp_connect_peers.push(Some(peer));
self
}
/// Set the number of concurrent in-flight UDP sends per socket.
pub fn udp_send_slots(mut self, n: u16) -> Self {
self.config.udp_send_slots = n;
self
}
/// Set the UDP recv buffer configuration (ring_size, buffer_size).
/// The `bgid` is left at its default; change it via `config_mut()` if
/// you need to override.
pub fn udp_recv_buffer(mut self, ring_size: u16, buffer_size: u32) -> Self {
self.config.udp_recv_buffer.ring_size = ring_size;
self.config.udp_recv_buffer.buffer_size = buffer_size;
self
}
/// Set the per-UDP-socket recv queue capacity.
///
/// Datagrams that arrive while the queue is full are dropped and
/// counted in `udp::DATAGRAMS_DROPPED`. Default: 1024.
pub fn udp_recv_queue_capacity(mut self, capacity: usize) -> Self {
self.config.udp_recv_queue_capacity = capacity;
self
}
/// Enable UDP GRO on bound UDP sockets. See [`Config::udp_gro`]. Remember
/// to size `udp_recv_buffer` to hold a full coalesced datagram (~64 KiB).
pub fn udp_gro(mut self, enabled: bool) -> Self {
self.config.udp_gro = enabled;
self
}
// ── Optional subsystems ──────────────────────────────────────────
/// Set NVMe passthrough configuration.
pub fn nvme(mut self, config: crate::nvme::NvmeConfig) -> Self {
self.config.nvme = Some(config);
self
}
/// Set direct I/O configuration.
pub fn direct_io(mut self, config: crate::direct_io::DirectIoConfig) -> Self {
self.config.direct_io = Some(config);
self
}
/// Set filesystem I/O configuration.
pub fn fs(mut self, config: crate::fs::FsConfig) -> Self {
self.config.fs = Some(config);
self
}
/// Set the number of DNS resolver threads. 0 = disabled.
pub fn resolver_threads(mut self, threads: usize) -> Self {
self.config.resolver_threads = threads;
self
}
/// Set the number of process spawner threads. 0 = disabled.
pub fn spawner_threads(mut self, threads: usize) -> Self {
self.config.spawner_threads = threads;
self
}
/// Set the number of blocking threads. 0 = disabled.
pub fn blocking_threads(mut self, threads: usize) -> Self {
self.config.blocking_threads = threads;
self
}
/// Set the number of disk I/O threads (mio backend only). 0 = disabled.
pub fn disk_io_threads(mut self, threads: usize) -> Self {
self.config.disk_io_threads = threads;
self
}
/// Set the TLS close_notify timeout in milliseconds. Default: 5000.
pub fn close_notify_timeout_ms(mut self, ms: u64) -> Self {
self.config.close_notify_timeout_ms = ms;
self
}
/// Set TLS server configuration.
pub fn tls(mut self, config: TlsConfig) -> Self {
self.config.tls = Some(config);
self
}
/// Set TLS client configuration for outbound connections.
pub fn tls_client(mut self, config: TlsClientConfig) -> Self {
self.config.tls_client = Some(config);
self
}
// ── Escape hatch ─────────────────────────────────────────────────
/// Get mutable access to the underlying config for fields not covered
/// by builder methods.
pub fn config_mut(&mut self) -> &mut Config {
&mut self.config
}
// ── Terminal ─────────────────────────────────────────────────────
/// Validate and build the final [`Config`].
pub fn build(self) -> Result<Config, crate::error::Error> {
self.config.validate()?;
Ok(self.config)
}
}
#[cfg(test)]
mod tests {
use super::*;
/// Helper: create a Config with a single field override.
/// Avoids clippy::field_reassign_with_default on the multi-field Config struct.
fn config_with(f: impl FnOnce(&mut Config)) -> Config {
let mut c = Config::default();
f(&mut c);
c
}
#[test]
fn validate_default_config_passes() {
Config::default()
.validate()
.expect("default config should be valid");
}
#[test]
fn validate_buffer_size_zero_rejected() {
assert!(
config_with(|c| c.recv_buffer.buffer_size = 0)
.validate()
.is_err()
);
}
#[test]
fn validate_buffer_size_accepted_65535() {
assert!(
config_with(|c| c.recv_buffer.buffer_size = 65535)
.validate()
.is_ok()
);
}
#[test]
fn validate_buffer_size_accepted_65536() {
// 65536 is the first value that previously caused a crash; it must now be
// accepted (the remaining-bytes counter is stored in the driver, not in the
// 16-bit CQE payload).
assert!(
config_with(|c| c.recv_buffer.buffer_size = 65536)
.validate()
.is_ok()
);
}
#[test]
fn validate_buffer_size_accepted_large() {
assert!(
config_with(|c| c.recv_buffer.buffer_size = 131072)
.validate()
.is_ok()
);
}
fn udp_config_with(f: impl FnOnce(&mut Config)) -> Config {
config_with(|c| {
c.udp_bind = vec!["127.0.0.1:0".parse().unwrap()];
f(c);
})
}
#[test]
fn validate_udp_gro_requires_large_buffer() {
// Default udp buffer (2048) is far too small for a coalesced datagram.
let err = udp_config_with(|c| c.udp_gro = true)
.validate()
.unwrap_err();
assert!(format!("{err}").contains("udp_gro"));
}
#[test]
fn validate_udp_gro_accepts_large_buffer() {
udp_config_with(|c| {
c.udp_gro = true;
c.udp_recv_buffer.buffer_size = 1 << 17;
})
.validate()
.expect("udp_gro with a 128 KiB buffer should be valid");
}
#[test]
fn validate_udp_buffer_ceiling_raised() {
// The ceiling moved from 64 KiB to 256 KiB to accommodate GRO.
udp_config_with(|c| c.udp_recv_buffer.buffer_size = 1 << 18)
.validate()
.expect("256 KiB udp buffer should be accepted");
assert!(
udp_config_with(|c| c.udp_recv_buffer.buffer_size = (1 << 18) + 1)
.validate()
.is_err()
);
}
#[test]
fn validate_ring_size_not_power_of_two_rejected() {
assert!(
config_with(|c| c.recv_buffer.ring_size = 3)
.validate()
.is_err()
);
}
#[test]
fn validate_sq_entries_not_power_of_two_rejected() {
assert!(config_with(|c| c.sq_entries = 3).validate().is_err());
}
#[test]
fn validate_sq_entries_zero_rejected() {
assert!(config_with(|c| c.sq_entries = 0).validate().is_err());
}
#[test]
fn validate_max_connections_zero_rejected() {
assert!(config_with(|c| c.max_connections = 0).validate().is_err());
}
#[test]
fn validate_max_connections_too_large_rejected() {
assert!(
config_with(|c| c.max_connections = 1 << 24)
.validate()
.is_err()
);
}
#[test]
fn validate_timer_slots_too_large_rejected() {
assert!(config_with(|c| c.timer_slots = 65536).validate().is_err());
}
#[test]
fn validate_send_copy_slot_size_zero_rejected() {
assert!(
config_with(|c| c.send_copy_slot_size = 0)
.validate()
.is_err()
);
}
#[test]
fn validate_send_copy_count_zero_rejected() {
assert!(config_with(|c| c.send_copy_count = 0).validate().is_err());
}
#[test]
fn validate_standalone_task_capacity_too_large_rejected() {
assert!(
config_with(|c| c.standalone_task_capacity = 1 << 31)
.validate()
.is_err()
);
}
}