Struct aya::programs::cgroup_skb::CgroupSkb

pub struct CgroupSkb { /* private fields */ }

A program used to inspect or filter network activity for a given cgroup.

CgroupSkb programs can be used to inspect or filter network activity generated on all the sockets belonging to a given cgroup. They can be attached to both ingress and egress.

Minimum kernel version

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

Examples

use std::fs::File;
use std::convert::TryInto;
use aya::programs::{CgroupSkb, CgroupSkbAttachType};

let file = File::open("/sys/fs/cgroup/unified")?;
let egress: &mut CgroupSkb = bpf.program_mut("egress_filter").unwrap().try_into()?;
egress.load()?;
egress.attach(file, CgroupSkbAttachType::Egress)?;

Implementations

impl CgroupSkb

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

Loads the program inside the kernel.

pub fn expected_attach_type(&self) -> &Option<CgroupSkbAttachType>

Returns the expected attach type of the program.

CgroupSkb programs can specify the expected attach type in their ELF section name, eg cgroup_skb/ingress or cgroup_skb/egress. This method returns None for programs defined with the generic section cgroup/skb.

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

Attaches the program to the given cgroup.

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

pub fn take_link(
    &mut self,
    link_id: CgroupSkbLinkId
) -> Result<OwnedLink<CgroupSkbLink>, 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.

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

Detaches the program.

See CgroupSkb::attach.

impl CgroupSkb

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 CgroupSkb

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

Formats the value using the given formatter.

impl ProgramFd for CgroupSkb

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

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

impl ProgramFd for &mut CgroupSkb

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 CgroupSkb

type Error = ProgramError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = ProgramError

The type returned in the event of a conversion error.

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

Performs the conversion.