diff --git a/aya/src/programs/cgroup_skb.rs b/aya/src/programs/cgroup_skb.rs index 3f7bda409..278e8bfe5 100644 --- a/aya/src/programs/cgroup_skb.rs +++ b/aya/src/programs/cgroup_skb.rs @@ -1,3 +1,4 @@ +//! CGroup SKB programs. use std::{ hash::Hash, os::unix::prelude::{AsRawFd, RawFd}, diff --git a/aya/src/programs/cgroup_sock_addr.rs b/aya/src/programs/cgroup_sock_addr.rs index e8c5d9087..65f7822d4 100644 --- a/aya/src/programs/cgroup_sock_addr.rs +++ b/aya/src/programs/cgroup_sock_addr.rs @@ -1,3 +1,4 @@ +//! CGroup Sock Addr programs. use thiserror::Error; use crate::generated::bpf_attach_type; diff --git a/aya/src/programs/cgroup_sockopt.rs b/aya/src/programs/cgroup_sockopt.rs index c31ea11c3..8d52dac9e 100644 --- a/aya/src/programs/cgroup_sockopt.rs +++ b/aya/src/programs/cgroup_sockopt.rs @@ -1,3 +1,4 @@ +//! CGroup Sock Opt programs. use thiserror::Error; use std::{ diff --git a/aya/src/programs/cgroup_sysctl.rs b/aya/src/programs/cgroup_sysctl.rs index ce070f0e4..416c98a38 100644 --- a/aya/src/programs/cgroup_sysctl.rs +++ b/aya/src/programs/cgroup_sysctl.rs @@ -1,3 +1,4 @@ +//! CGroup Sysctl programs. use std::{ hash::Hash, os::unix::prelude::{AsRawFd, RawFd}, diff --git a/aya/src/programs/extension.rs b/aya/src/programs/extension.rs index c16e612af..9efe796a6 100644 --- a/aya/src/programs/extension.rs +++ b/aya/src/programs/extension.rs @@ -1,3 +1,4 @@ +//! Extension programs. use std::os::unix::prelude::{AsRawFd, RawFd}; use thiserror::Error; diff --git a/aya/src/programs/lirc_mode2.rs b/aya/src/programs/lirc_mode2.rs index 297a28d48..ca33f3b25 100644 --- a/aya/src/programs/lirc_mode2.rs +++ b/aya/src/programs/lirc_mode2.rs @@ -1,3 +1,4 @@ +//! Lirc programs use std::os::unix::prelude::{AsRawFd, RawFd}; use crate::{ diff --git a/aya/src/programs/mod.rs b/aya/src/programs/mod.rs index 81fc6b4f9..1a0519653 100644 --- a/aya/src/programs/mod.rs +++ b/aya/src/programs/mod.rs @@ -36,31 +36,31 @@ //! [`Bpf::program`]: crate::Bpf::program //! [`Bpf::program_mut`]: crate::Bpf::program_mut //! [`maps`]: crate::maps -mod cgroup_skb; -mod cgroup_sock_addr; -mod cgroup_sockopt; -mod cgroup_sysctl; -mod extension; -mod fentry; -mod fexit; -mod kprobe; +pub mod cgroup_skb; +pub mod cgroup_sock_addr; +pub mod cgroup_sockopt; +pub mod cgroup_sysctl; +pub mod extension; +pub mod fentry; +pub mod fexit; +pub mod kprobe; mod links; -mod lirc_mode2; -mod lsm; -mod perf_attach; +pub mod lirc_mode2; +pub mod lsm; +pub mod perf_attach; pub mod perf_event; mod probe; -mod raw_trace_point; -mod sk_msg; -mod sk_skb; -mod sock_ops; -mod socket_filter; +pub mod raw_trace_point; +pub mod sk_msg; +pub mod sk_skb; +pub mod sock_ops; +pub mod socket_filter; pub mod tc; -mod tp_btf; -mod trace_point; -mod uprobe; +pub mod tp_btf; +pub mod trace_point; +pub mod uprobe; mod utils; -mod xdp; +pub mod xdp; use libc::ENOSPC; use std::{ diff --git a/aya/src/programs/perf_attach.rs b/aya/src/programs/perf_attach.rs index a0c4a598e..844ad449d 100644 --- a/aya/src/programs/perf_attach.rs +++ b/aya/src/programs/perf_attach.rs @@ -1,3 +1,4 @@ +//! Perf Attach Links use libc::close; use std::os::unix::io::RawFd; @@ -7,9 +8,11 @@ use crate::{ PERF_EVENT_IOC_DISABLE, PERF_EVENT_IOC_ENABLE, PERF_EVENT_IOC_SET_BPF, }; +/// PerfLinkId is the identifer of a PerfLink #[derive(Debug, Hash, Eq, PartialEq)] pub struct PerfLinkId(RawFd); +/// PerfLink is the attachment type of PerfEvent programs #[derive(Debug)] pub struct PerfLink { perf_fd: RawFd, diff --git a/aya/src/programs/sk_msg.rs b/aya/src/programs/sk_msg.rs index 1d0f8a108..24749606f 100644 --- a/aya/src/programs/sk_msg.rs +++ b/aya/src/programs/sk_msg.rs @@ -1,3 +1,4 @@ +//! SkMsg program. use crate::{ generated::{bpf_attach_type::BPF_SK_MSG_VERDICT, bpf_prog_type::BPF_PROG_TYPE_SK_MSG}, maps::sock::SocketMap, diff --git a/aya/src/programs/sk_skb.rs b/aya/src/programs/sk_skb.rs index 4f7e72158..000ba2f0b 100644 --- a/aya/src/programs/sk_skb.rs +++ b/aya/src/programs/sk_skb.rs @@ -1,3 +1,4 @@ +//! SkSkb program. use crate::{ generated::{ bpf_attach_type::{BPF_SK_SKB_STREAM_PARSER, BPF_SK_SKB_STREAM_VERDICT}, diff --git a/aya/src/programs/sock_ops.rs b/aya/src/programs/sock_ops.rs index 64d1e8456..169ac8eef 100644 --- a/aya/src/programs/sock_ops.rs +++ b/aya/src/programs/sock_ops.rs @@ -1,3 +1,4 @@ +//! Sock Ops Program. use std::os::unix::io::AsRawFd; use crate::{ diff --git a/aya/src/programs/socket_filter.rs b/aya/src/programs/socket_filter.rs index 1b65e6cdf..ad8248b30 100644 --- a/aya/src/programs/socket_filter.rs +++ b/aya/src/programs/socket_filter.rs @@ -1,3 +1,4 @@ +//! Socket Filter program. use libc::{setsockopt, SOL_SOCKET}; use std::{ io, mem, diff --git a/aya/src/programs/trace_point.rs b/aya/src/programs/trace_point.rs index 8882f538e..43d356060 100644 --- a/aya/src/programs/trace_point.rs +++ b/aya/src/programs/trace_point.rs @@ -1,3 +1,4 @@ +//! Tracepoint programs. use std::{fs, io}; use thiserror::Error; diff --git a/aya/src/programs/xdp.rs b/aya/src/programs/xdp.rs index 098096403..713d4b7de 100644 --- a/aya/src/programs/xdp.rs +++ b/aya/src/programs/xdp.rs @@ -1,3 +1,4 @@ +//! eXpress Data Path (XDP) programs. use bitflags; use libc::if_nametoindex; use std::{ffi::CString, hash::Hash, io, os::unix::io::RawFd};