Struct aya::programs::SockOps

pub struct SockOps { /* private fields */ }

A program used to work with sockets.

SockOps programs can access or set socket options, connection parameters, watch connection state changes and more. They are attached to cgroups.

Minimum kernel version

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

Examples

use std::fs::File;
use std::convert::TryInto;
use aya::programs::SockOps;

let file = File::open("/sys/fs/cgroup/unified")?;
let prog: &mut SockOps = bpf.program_mut("intercept_active_sockets").unwrap().try_into()?;
prog.load()?;
prog.attach(file)?;

Implementations

impl SockOps

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

Loads the program inside the kernel.

pub fn attach<T: AsRawFd>(
    &mut self,
    cgroup: T
) -> Result<SockOpsLinkId, ProgramError>

Attaches the program to the given cgroup.

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

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

Detaches the program.

See SockOps::attach.

pub fn take_link(
    &mut self,
    link_id: SockOpsLinkId
) -> Result<OwnedLink<SockOpsLink>, 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 SockOps

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 SockOps

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

Formats the value using the given formatter.

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

type Error = ProgramError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = ProgramError

The type returned in the event of a conversion error.

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

Performs the conversion.