Crate netring 

netring

High-performance zero-copy packet I/O for Linux.

netring provides packet capture and injection via AF_PACKET (TPACKET_V3 block-based mmap ring buffers) and AF_XDP (kernel-bypass via XDP sockets). It offers both a high-level ergonomic API and a low-level batch API for maximum throughput.

Quick Start

// High-level: flat packet iterator
let mut cap = netring::Capture::new("eth0").unwrap();
for pkt in cap.packets().take(100) {
    println!("[{}] {} bytes", pkt.timestamp(), pkt.len());
}

// Low-level: batch processing with sequence gap detection
use netring::{AfPacketRxBuilder, PacketSource};
use std::time::Duration;

let mut rx = AfPacketRxBuilder::default()
    .interface("eth0")
    .block_size(1 << 22)
    .build()
    .unwrap();

while let Some(batch) = rx.next_batch_blocking(Duration::from_millis(100)).unwrap() {
    println!("seq={} pkts={} timed_out={}",
        batch.seq_num(), batch.len(), batch.timed_out());
    for pkt in &batch {
        process(pkt.data());
    }
    // batch dropped → block returned to kernel
}

Features

Feature	Default	Description
af-xdp	off	AF_XDP kernel-bypass packet I/O (pure Rust, no native deps)
tokio	off	Async capture via AsyncFd (wait_readable + next_batch)
channel	off	Thread + bounded channel adapter (runtime-agnostic)
parse	off	Packet header parsing via etherparse

API Levels

Level	Types	When to Use
High	Capture, Injector	Simple capture/inject with iterators and builders
Low	AfPacketRx, AfPacketTx	Batch processing, sequence tracking, custom poll logic
AF_XDP	XdpSocket, XdpSocketBuilder	Kernel-bypass via AF_XDP (feature: af-xdp)
Async	AsyncCapture, ChannelCapture	Integration with tokio or any async runtime

Default Configuration

Parameter	Default	Description
block_size	4 MiB	Ring buffer block size
block_count	64	Number of blocks (256 MiB total)
frame_size	2048	Minimum frame size
block_timeout_ms	60	Block retirement timeout
fill_rxhash	true	Kernel fills RX flow hash

Performance Tuning

Profile	block_size	block_count	timeout_ms	Notes
High throughput	4 MiB	128–256	60	+ FanoutMode::Cpu + thread pinning
Low latency	256 KiB	64	1–10	+ busy_poll_us(50)
Memory-constrained	1 MiB	16	100	16 MiB total ring
Jumbo frames	4 MiB	64	60	frame_size(65536)

See docs/TUNING_GUIDE.md for detailed tuning advice.

Fanout Modes

Distribute packets across multiple sockets for multi-threaded capture:

Mode	Strategy
Hash	Flow hash (same flow → same socket)
Cpu	Route to CPU that received the NIC interrupt
LoadBalance	Round-robin
Rollover	Fill one socket, overflow to next
Random	Random distribution
QueueMapping	NIC hardware queue mapping

use netring::{Capture, FanoutMode, FanoutFlags};

let cap = Capture::builder()
    .interface("eth0")
    .fanout(FanoutMode::Cpu, 42)
    .fanout_flags(FanoutFlags::ROLLOVER | FanoutFlags::DEFRAG)
    .build()
    .unwrap();

Statistics

let stats = cap.stats().unwrap();
println!("received: {}, dropped: {}, frozen: {}",
    stats.packets, stats.drops, stats.freeze_count);

Reading stats resets the kernel counters — call periodically for rate calculation.

System Requirements

• Linux kernel 3.2+ (for TPACKET_V3), 5.4+ (for AF_XDP)
• Rust 1.85+ (edition 2024)

Capabilities

Capability	Required For
CAP_NET_RAW	Creating AF_PACKET / AF_XDP sockets
CAP_IPC_LOCK	MAP_LOCKED (or sufficient RLIMIT_MEMLOCK)
CAP_NET_ADMIN	Promiscuous mode

# Recommended: use justfile (sudo only once for setcap)
just setcap          # grants CAP_NET_RAW on all binaries
just test            # runs without sudo
just capture eth0    # runs without sudo

# Manual alternative
sudo setcap cap_net_raw+ep target/release/examples/capture

Examples

just setcap                  # grant capabilities once (needs sudo)
just capture eth0            # basic packet capture
just batch eth0              # low-level batch API with sequence gap detection
just fanout eth0 4           # multi-threaded fanout capture
just inject lo               # packet injection
just stats eth0              # live statistics monitor (pkt/s, drops)
just low-latency eth0        # low-latency tuning demo
just dpi eth0                # deep packet inspection (HTTP/TLS/DNS/SSH detection)
just channel eth0            # channel adapter (runtime-agnostic)
just async eth0              # async capture with tokio
just ebpf                    # eBPF/aya integration demo (AsFd verification)
cargo run --example xdp_send --features af-xdp -- lo  # AF_XDP TX-only

Documentation

• Architecture — system design, lifetime model, ring layout
• API Overview — all types, methods, and configuration
• Tuning Guide — performance profiles, system tuning, monitoring
• Troubleshooting — common errors and fixes

License

Licensed under either of Apache License, Version 2.0 or MIT License at your option.

Re-exports

pub use capture::Capture;

pub use capture::CaptureBuilder;

pub use config::BpfFilter;

pub use config::BpfInsn;

pub use config::FanoutFlags;

pub use config::FanoutMode;

pub use config::RingProfile;

pub use config::TimestampSource;

pub use error::Error;

pub use inject::Injector;

pub use inject::InjectorBuilder;

pub use interface::InterfaceInfo;

pub use interface::interface_info;

pub use packet::OwnedPacket;

pub use packet::Packet;

pub use packet::PacketBatch;

pub use packet::PacketDirection;

pub use packet::PacketStatus;

pub use packet::Timestamp;

pub use stats::CaptureStats;

pub use traits::PacketSink;

pub use traits::PacketSource;

pub use afpacket::rx::AfPacketRx;

pub use afpacket::rx::AfPacketRxBuilder;

pub use afpacket::tx::AfPacketTx;

pub use afpacket::tx::AfPacketTxBuilder;

pub use afpacket::tx::TxSlot;

pub use afxdp::XdpSocket;

pub use afxdp::XdpSocketBuilder;

pub use bridge::Bridge;

pub use bridge::BridgeAction;

pub use bridge::BridgeBuilder;

pub use bridge::BridgeDirection;

pub use bridge::BridgeStats;

pub use async_adapters::channel::ChannelCapture;

pub use async_adapters::tokio_adapter::AsyncCapture;

pub use traits::AsyncPacketSource;

Modules

afpacket

AF_PACKET backend implementation.

afxdp

AF_XDP backend for kernel-bypass packet I/O.

async_adapters

Async and channel adapters for packet capture.

bridge

Bidirectional packet bridge between two interfaces (IPS mode).

capture

High-level packet capture API.

config

Configuration types: fanout, BPF filters, timestamps.

error

Error types for netring.

inject

High-level packet injection.

interface

Interface capability detection.

packet

Packet types: zero-copy views, batch iteration, timestamps, and owned packets.

stats

Capture statistics.

traits

Core traits for packet capture and injection.