Struct FStackConfig 

pub struct FStackConfig { /* private fields */ }

Builder for F-Stack / DPDK initialisation arguments.

Separates the config-file arguments (understood by F-Stack’s own parser) from extra EAL arguments (passed directly to DPDK’s rte_eal_init).

Examples

Docker / TAP development:

let cfg = FStackConfig::for_docker();

Bare metal with a real NIC bound via VFIO:

let cfg = FStackConfig::for_bare_metal();

Custom build:

let cfg = FStackConfig::new("config.ini")
    .with_eal_arg("--vdev=net_tap0,iface=dtap0,mac=fixed")
    .with_eal_arg("--no-pci");

Implementations

impl FStackConfig

pub fn new(config_file: impl Into<String>) -> Self

Create a config pointing at config_file with no extra EAL arguments.

pub fn with_eal_arg(self, arg: impl Into<String>) -> Self

Append a single extra EAL argument (e.g. "--no-pci").

pub fn for_docker() -> Self

Docker / TAP device profile.

Injects the three EAL arguments that are required when running DPDK inside a container with a TAP virtual interface instead of a real NIC:

• --vdev=net_tap0,iface=dtap0,mac=fixed — create a TAP-backed DPDK port tied to the kernel interface dtap0; mac=fixed makes the MAC deterministic so that it is stable across restarts. The kernel side of the TAP is automatically assigned a different MAC by entrypoint.sh (derived from the DPDK MAC by incrementing the last octet). The two MACs must differ: FreeBSD’s ether_input drops frames whose source MAC matches the interface MAC (anti-loop protection).
• --no-pci — skip PCI bus scan; without this DPDK could claim a PCI device and push the TAP device to port 1, breaking port_list=0.
• --iova-mode=va — force Virtual Address IOVA mode, required in containers / WSL2 where physical address access is unavailable.

Examples found in repository

examples/udp_echo.rs (line 31)

fn main() {
    // Docker/TAP configuration — swap for FStackConfig::for_bare_metal() on bare metal.
    let cfg = FStackConfig::for_docker();

    println!("Initializing F-Stack...");
    init_fstack(&cfg.config_args(), &cfg.eal_args());

    let bind_ip   = "0.0.0.0".to_string();
    let bind_port = 8080u16;

    println!("Creating UDP socket on {}:{}...", bind_ip, bind_port);
    let socket: UniquePtr<FStackUdpSocket> =
        create_udp_socket(&bind_ip, bind_port, on_packet);

    unsafe {
        GLOBAL_SOCKET = Some(&*socket as *const FStackUdpSocket);
    }

    println!("Starting F-Stack UDP event loop...");
    run_fstack(&socket);
}

examples/tcp_echo.rs (line 40)

fn main() {
    // Docker/TAP configuration — swap for FStackConfig::for_bare_metal() on bare metal.
    let cfg = FStackConfig::for_docker();

    println!("Initializing F-Stack...");
    init_fstack(&cfg.config_args(), &cfg.eal_args());

    let bind_ip   = "0.0.0.0".to_string();
    let bind_port = 8080u16;

    let tcp_opts = TcpSocketOptions::default()
        .nodelay(true)
        .quickack(true);

    println!("Creating TCP listener on {}:{}...", bind_ip, bind_port);
    let listener: UniquePtr<FStackTcpListener> =
        create_tcp_listener(&bind_ip, bind_port, &tcp_opts.to_ffi(), on_connect, on_data, on_disconnect);

    unsafe {
        GLOBAL_LISTENER = Some(&*listener as *const FStackTcpListener);
    }

    println!("Starting F-Stack TCP event loop...");
    run_fstack_tcp(&listener);
}

pub fn for_bare_metal() -> Self

Bare-metal / AWS profile.

No extra EAL arguments are needed: DPDK discovers the NIC via the allow= key in config.ini, PCI scanning is required, and IOVA mode is auto-detected based on whether IOMMU is present.

pub fn config_args(&self) -> Vec<String>

The arguments passed to ff_load_config (F-Stack’s config parser).

Examples found in repository

examples/udp_echo.rs (line 34)

fn main() {
    // Docker/TAP configuration — swap for FStackConfig::for_bare_metal() on bare metal.
    let cfg = FStackConfig::for_docker();

    println!("Initializing F-Stack...");
    init_fstack(&cfg.config_args(), &cfg.eal_args());

    let bind_ip   = "0.0.0.0".to_string();
    let bind_port = 8080u16;

    println!("Creating UDP socket on {}:{}...", bind_ip, bind_port);
    let socket: UniquePtr<FStackUdpSocket> =
        create_udp_socket(&bind_ip, bind_port, on_packet);

    unsafe {
        GLOBAL_SOCKET = Some(&*socket as *const FStackUdpSocket);
    }

    println!("Starting F-Stack UDP event loop...");
    run_fstack(&socket);
}

examples/tcp_echo.rs (line 43)

fn main() {
    // Docker/TAP configuration — swap for FStackConfig::for_bare_metal() on bare metal.
    let cfg = FStackConfig::for_docker();

    println!("Initializing F-Stack...");
    init_fstack(&cfg.config_args(), &cfg.eal_args());

    let bind_ip   = "0.0.0.0".to_string();
    let bind_port = 8080u16;

    let tcp_opts = TcpSocketOptions::default()
        .nodelay(true)
        .quickack(true);

    println!("Creating TCP listener on {}:{}...", bind_ip, bind_port);
    let listener: UniquePtr<FStackTcpListener> =
        create_tcp_listener(&bind_ip, bind_port, &tcp_opts.to_ffi(), on_connect, on_data, on_disconnect);

    unsafe {
        GLOBAL_LISTENER = Some(&*listener as *const FStackTcpListener);
    }

    println!("Starting F-Stack TCP event loop...");
    run_fstack_tcp(&listener);
}

pub fn eal_args(&self) -> Vec<String>

Extra EAL arguments injected into dpdk_argv after ff_load_config.

Examples found in repository

examples/udp_echo.rs (line 34)

fn main() {
    // Docker/TAP configuration — swap for FStackConfig::for_bare_metal() on bare metal.
    let cfg = FStackConfig::for_docker();

    println!("Initializing F-Stack...");
    init_fstack(&cfg.config_args(), &cfg.eal_args());

    let bind_ip   = "0.0.0.0".to_string();
    let bind_port = 8080u16;

    println!("Creating UDP socket on {}:{}...", bind_ip, bind_port);
    let socket: UniquePtr<FStackUdpSocket> =
        create_udp_socket(&bind_ip, bind_port, on_packet);

    unsafe {
        GLOBAL_SOCKET = Some(&*socket as *const FStackUdpSocket);
    }

    println!("Starting F-Stack UDP event loop...");
    run_fstack(&socket);
}

examples/tcp_echo.rs (line 43)

fn main() {
    // Docker/TAP configuration — swap for FStackConfig::for_bare_metal() on bare metal.
    let cfg = FStackConfig::for_docker();

    println!("Initializing F-Stack...");
    init_fstack(&cfg.config_args(), &cfg.eal_args());

    let bind_ip   = "0.0.0.0".to_string();
    let bind_port = 8080u16;

    let tcp_opts = TcpSocketOptions::default()
        .nodelay(true)
        .quickack(true);

    println!("Creating TCP listener on {}:{}...", bind_ip, bind_port);
    let listener: UniquePtr<FStackTcpListener> =
        create_tcp_listener(&bind_ip, bind_port, &tcp_opts.to_ffi(), on_connect, on_data, on_disconnect);

    unsafe {
        GLOBAL_LISTENER = Some(&*listener as *const FStackTcpListener);
    }

    println!("Starting F-Stack TCP event loop...");
    run_fstack_tcp(&listener);
}