Struct aya::programs::xdp::Xdp

pub struct Xdp { /* private fields */ }

An XDP program.

eXpress Data Path (XDP) programs can be attached to the very early stages of network processing, where they can apply custom packet processing logic. When supported by the underlying network driver, XDP programs can execute directly on network cards, greatly reducing CPU load.

Minimum kernel version

The minimum kernel version required to use this feature is 4.8.

Examples

use aya::{Bpf, programs::{Xdp, XdpFlags}};
use std::convert::TryInto;

let program: &mut Xdp = bpf.program_mut("intercept_packets").unwrap().try_into()?;
program.attach("eth0", XdpFlags::default())?;

Implementations

impl Xdp

pub fn load(&mut self) -> Result<(), ProgramError>

Loads the program inside the kernel.

pub fn attach(
    &mut self,
    interface: &str,
    flags: XdpFlags
) -> Result<XdpLinkId, ProgramError>

Attaches the program to the given interface.

The returned value can be used to detach, see Xdp::detach.

Errors

If the given interface does not exist ProgramError::UnknownInterface is returned.

When attaching fails, ProgramError::SyscallError is returned for kernels >= 5.9.0, and instead XdpError::NetlinkError is returned for older kernels.

pub fn detach(&mut self, link_id: XdpLinkId) -> Result<(), ProgramError>

Detaches the program.

See Xdp::attach.

pub fn take_link(
    &mut self,
    link_id: XdpLinkId
) -> Result<OwnedLink<XdpLink>, ProgramError>

Takes ownership of the link referenced by the provided link_id.

The link will be detached on Drop and the caller is now responsible for managing its lifetime.

impl Xdp

pub fn unload(&mut self) -> Result<(), ProgramError>

Unloads the program from the kernel.

Links will be detached before unloading the program. Note that owned links obtained using take_link() will not be detached.

Trait Implementations

impl Debug for Xdp

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl ProgramFd for Xdp

fn fd(&self) -> Option<RawFd>

Returns the RawFd of the program if it has been loaded, or None

impl ProgramFd for &mut Xdp

fn fd(&self) -> Option<RawFd>

Returns the RawFd of the program if it has been loaded, or None

impl<'a> TryFrom<&'a Program> for &'a Xdp

type Error = ProgramError

The type returned in the event of a conversion error.

fn try_from(program: &'a Program) -> Result<&'a Xdp, ProgramError>

Performs the conversion.

impl<'a> TryFrom<&'a mut Program> for &'a mut Xdp

type Error = ProgramError

The type returned in the event of a conversion error.

fn try_from(program: &'a mut Program) -> Result<&'a mut Xdp, ProgramError>

Performs the conversion.