diff --git a/aya/src/programs/cgroup_device.rs b/aya/src/programs/cgroup_device.rs index 666fdc26..ccbd01ba 100644 --- a/aya/src/programs/cgroup_device.rs +++ b/aya/src/programs/cgroup_device.rs @@ -162,9 +162,7 @@ impl Link for CgroupDeviceLinkInner { id_as_key!(CgroupDeviceLinkInner, CgroupDeviceLinkIdInner); define_link_wrapper!( - /// The link used by [CgroupDevice] programs. CgroupDeviceLink, - /// The type returned by [CgroupDevice::attach]. Can be passed to [CgroupDevice::detach]. CgroupDeviceLinkId, CgroupDeviceLinkInner, CgroupDeviceLinkIdInner, diff --git a/aya/src/programs/cgroup_skb.rs b/aya/src/programs/cgroup_skb.rs index 86c809c5..28f053bb 100644 --- a/aya/src/programs/cgroup_skb.rs +++ b/aya/src/programs/cgroup_skb.rs @@ -177,9 +177,7 @@ impl Link for CgroupSkbLinkInner { id_as_key!(CgroupSkbLinkInner, CgroupSkbLinkIdInner); define_link_wrapper!( - /// The link used by [CgroupSkb] programs. CgroupSkbLink, - /// The type returned by [CgroupSkb::attach]. Can be passed to [CgroupSkb::detach]. CgroupSkbLinkId, CgroupSkbLinkInner, CgroupSkbLinkIdInner, diff --git a/aya/src/programs/cgroup_sock.rs b/aya/src/programs/cgroup_sock.rs index 52b86f2e..4b1b768e 100644 --- a/aya/src/programs/cgroup_sock.rs +++ b/aya/src/programs/cgroup_sock.rs @@ -153,9 +153,7 @@ impl Link for CgroupSockLinkInner { id_as_key!(CgroupSockLinkInner, CgroupSockLinkIdInner); define_link_wrapper!( - /// The link used by [CgroupSock] programs. CgroupSockLink, - /// The type returned by [CgroupSock::attach]. Can be passed to [CgroupSock::detach]. CgroupSockLinkId, CgroupSockLinkInner, CgroupSockLinkIdInner, diff --git a/aya/src/programs/cgroup_sock_addr.rs b/aya/src/programs/cgroup_sock_addr.rs index 26b3a7cf..1a11abfb 100644 --- a/aya/src/programs/cgroup_sock_addr.rs +++ b/aya/src/programs/cgroup_sock_addr.rs @@ -154,9 +154,7 @@ impl Link for CgroupSockAddrLinkInner { id_as_key!(CgroupSockAddrLinkInner, CgroupSockAddrLinkIdInner); define_link_wrapper!( - /// The link used by [CgroupSockAddr] programs. CgroupSockAddrLink, - /// The type returned by [CgroupSockAddr::attach]. Can be passed to [CgroupSockAddr::detach]. CgroupSockAddrLinkId, CgroupSockAddrLinkInner, CgroupSockAddrLinkIdInner, diff --git a/aya/src/programs/cgroup_sockopt.rs b/aya/src/programs/cgroup_sockopt.rs index b93fdf65..2bd9d6d7 100644 --- a/aya/src/programs/cgroup_sockopt.rs +++ b/aya/src/programs/cgroup_sockopt.rs @@ -153,9 +153,7 @@ impl Link for CgroupSockoptLinkInner { id_as_key!(CgroupSockoptLinkInner, CgroupSockoptLinkIdInner); define_link_wrapper!( - /// The link used by [CgroupSockopt] programs. CgroupSockoptLink, - /// The type returned by [CgroupSockopt::attach]. Can be passed to [CgroupSockopt::detach]. CgroupSockoptLinkId, CgroupSockoptLinkInner, CgroupSockoptLinkIdInner, diff --git a/aya/src/programs/cgroup_sysctl.rs b/aya/src/programs/cgroup_sysctl.rs index 5f6e8bc9..c98256bb 100644 --- a/aya/src/programs/cgroup_sysctl.rs +++ b/aya/src/programs/cgroup_sysctl.rs @@ -137,9 +137,7 @@ impl Link for CgroupSysctlLinkInner { id_as_key!(CgroupSysctlLinkInner, CgroupSysctlLinkIdInner); define_link_wrapper!( - /// The link used by [CgroupSysctl] programs. CgroupSysctlLink, - /// The type returned by [CgroupSysctl::attach]. Can be passed to [CgroupSysctl::detach]. CgroupSysctlLinkId, CgroupSysctlLinkInner, CgroupSysctlLinkIdInner, diff --git a/aya/src/programs/extension.rs b/aya/src/programs/extension.rs index ada87f6c..7feaba95 100644 --- a/aya/src/programs/extension.rs +++ b/aya/src/programs/extension.rs @@ -197,12 +197,4 @@ fn get_btf_info( Ok((btf_fd, btf_id)) } -define_link_wrapper!( - /// The link used by [Extension] programs. - ExtensionLink, - /// The type returned by [Extension::attach]. Can be passed to [Extension::detach]. - ExtensionLinkId, - FdLink, - FdLinkId, - Extension, -); +define_link_wrapper!(ExtensionLink, ExtensionLinkId, FdLink, FdLinkId, Extension); diff --git a/aya/src/programs/fentry.rs b/aya/src/programs/fentry.rs index 437f630b..0639ab2a 100644 --- a/aya/src/programs/fentry.rs +++ b/aya/src/programs/fentry.rs @@ -73,12 +73,4 @@ impl FEntry { } } -define_link_wrapper!( - /// The link used by [FEntry] programs. - FEntryLink, - /// The type returned by [FEntry::attach]. Can be passed to [FEntry::detach]. - FEntryLinkId, - FdLink, - FdLinkId, - FEntry, -); +define_link_wrapper!(FEntryLink, FEntryLinkId, FdLink, FdLinkId, FEntry); diff --git a/aya/src/programs/fexit.rs b/aya/src/programs/fexit.rs index 9a8ced2a..2a4a388e 100644 --- a/aya/src/programs/fexit.rs +++ b/aya/src/programs/fexit.rs @@ -73,12 +73,4 @@ impl FExit { } } -define_link_wrapper!( - /// The link used by [FExit] programs. - FExitLink, - /// The type returned by [FExit::attach]. Can be passed to [FExit::detach]. - FExitLinkId, - FdLink, - FdLinkId, - FExit, -); +define_link_wrapper!(FExitLink, FExitLinkId, FdLink, FdLinkId, FExit); diff --git a/aya/src/programs/flow_dissector.rs b/aya/src/programs/flow_dissector.rs index d477ffc2..e0b3685b 100644 --- a/aya/src/programs/flow_dissector.rs +++ b/aya/src/programs/flow_dissector.rs @@ -149,9 +149,7 @@ impl Link for FlowDissectorLinkInner { id_as_key!(FlowDissectorLinkInner, FlowDissectorLinkIdInner); define_link_wrapper!( - /// The link used by [FlowDissector] programs. FlowDissectorLink, - /// The type returned by [FlowDissector::attach]. Can be passed to [FlowDissector::detach]. FlowDissectorLinkId, FlowDissectorLinkInner, FlowDissectorLinkIdInner, diff --git a/aya/src/programs/iter.rs b/aya/src/programs/iter.rs index 4f74fec7..fb0d5279 100644 --- a/aya/src/programs/iter.rs +++ b/aya/src/programs/iter.rs @@ -118,15 +118,7 @@ impl TryFrom for IterLink { impl_try_into_fdlink!(IterLink, PerfLinkInner); -define_link_wrapper!( - /// The link used by [`Iter`] programs. - IterLink, - /// The type returned by [`Iter::attach`]. Can be passed to [`Iter::detach`]. - IterLinkId, - PerfLinkInner, - PerfLinkIdInner, - Iter, -); +define_link_wrapper!(IterLink, IterLinkId, PerfLinkInner, PerfLinkIdInner, Iter); impl IterLink { /// Converts [`IterLink`] into a [`File`] that can be used to retrieve the diff --git a/aya/src/programs/kprobe.rs b/aya/src/programs/kprobe.rs index 9d46be7f..46158ce6 100644 --- a/aya/src/programs/kprobe.rs +++ b/aya/src/programs/kprobe.rs @@ -104,9 +104,7 @@ impl KProbe { } define_link_wrapper!( - /// The link used by [KProbe] programs. KProbeLink, - /// The type returned by [KProbe::attach]. Can be passed to [KProbe::detach]. KProbeLinkId, PerfLinkInner, PerfLinkIdInner, diff --git a/aya/src/programs/links.rs b/aya/src/programs/links.rs index 6edbdb82..9040cc84 100644 --- a/aya/src/programs/links.rs +++ b/aya/src/programs/links.rs @@ -473,12 +473,18 @@ macro_rules! id_as_key { pub(crate) use id_as_key; macro_rules! define_link_wrapper { - (#[$doc1:meta] $wrapper:ident, #[$doc2:meta] $wrapper_id:ident, $base:ident, $base_id:ident, $program:ident,) => { - #[$doc2] + ($wrapper:ident, $wrapper_id:ident, $base:ident, $base_id:ident, $program:ident $(,)?) => { + /// The type returned by + #[doc = concat!("[`", stringify!($program), "::attach`]")] + /// . Can be passed to + #[doc = concat!("[`", stringify!($program), "::detach`]")] + /// . #[derive(Debug, Hash, Eq, PartialEq)] pub struct $wrapper_id($base_id); - #[$doc1] + /// The link used by + #[doc = concat!("[`", stringify!($program), "`]")] + /// programs. #[derive(Debug)] pub struct $wrapper(Option<$base>); diff --git a/aya/src/programs/lirc_mode2.rs b/aya/src/programs/lirc_mode2.rs index 31b77db4..c454e91c 100644 --- a/aya/src/programs/lirc_mode2.rs +++ b/aya/src/programs/lirc_mode2.rs @@ -121,7 +121,7 @@ impl LircMode2 { } } -/// The type returned by [LircMode2::attach]. Can be passed to [LircMode2::detach]. +/// The type returned by [`LircMode2::attach`]. Can be passed to [`LircMode2::detach`]. #[derive(Debug, Hash, Eq, PartialEq)] pub struct LircLinkId(RawFd, RawFd); diff --git a/aya/src/programs/lsm.rs b/aya/src/programs/lsm.rs index afa53ccc..ee591694 100644 --- a/aya/src/programs/lsm.rs +++ b/aya/src/programs/lsm.rs @@ -79,12 +79,4 @@ impl Lsm { } } -define_link_wrapper!( - /// The link used by [Lsm] programs. - LsmLink, - /// The type returned by [Lsm::attach]. Can be passed to [Lsm::detach]. - LsmLinkId, - FdLink, - FdLinkId, - Lsm, -); +define_link_wrapper!(LsmLink, LsmLinkId, FdLink, FdLinkId, Lsm); diff --git a/aya/src/programs/perf_event.rs b/aya/src/programs/perf_event.rs index 40a8d7e0..991227b1 100644 --- a/aya/src/programs/perf_event.rs +++ b/aya/src/programs/perf_event.rs @@ -203,9 +203,7 @@ impl TryFrom for PerfEventLink { } define_link_wrapper!( - /// The link used by [PerfEvent] programs. PerfEventLink, - /// The type returned by [PerfEvent::attach]. Can be passed to [PerfEvent::detach]. PerfEventLinkId, PerfLinkInner, PerfLinkIdInner, diff --git a/aya/src/programs/raw_trace_point.rs b/aya/src/programs/raw_trace_point.rs index 2abb6b51..bd2e3946 100644 --- a/aya/src/programs/raw_trace_point.rs +++ b/aya/src/programs/raw_trace_point.rs @@ -57,9 +57,7 @@ impl RawTracePoint { } define_link_wrapper!( - /// The link used by [RawTracePoint] programs. RawTracePointLink, - /// The type returned by [RawTracePoint::attach]. Can be passed to [RawTracePoint::detach]. RawTracePointLinkId, FdLink, FdLinkId, diff --git a/aya/src/programs/sk_lookup.rs b/aya/src/programs/sk_lookup.rs index 5a4c8d7c..21577583 100644 --- a/aya/src/programs/sk_lookup.rs +++ b/aya/src/programs/sk_lookup.rs @@ -82,12 +82,4 @@ impl SkLookup { } } -define_link_wrapper!( - /// The link used by [SkLookup] programs. - SkLookupLink, - /// The type returned by [SkLookup::attach]. Can be passed to [SkLookup::detach]. - SkLookupLinkId, - FdLink, - FdLinkId, - SkLookup, -); +define_link_wrapper!(SkLookupLink, SkLookupLinkId, FdLink, FdLinkId, SkLookup); diff --git a/aya/src/programs/sk_msg.rs b/aya/src/programs/sk_msg.rs index d97ee116..9cd73055 100644 --- a/aya/src/programs/sk_msg.rs +++ b/aya/src/programs/sk_msg.rs @@ -98,9 +98,7 @@ impl SkMsg { } define_link_wrapper!( - /// The link used by [SkMsg] programs. SkMsgLink, - /// The type returned by [SkMsg::attach]. Can be passed to [SkMsg::detach]. SkMsgLinkId, ProgAttachLink, ProgAttachLinkId, diff --git a/aya/src/programs/sk_skb.rs b/aya/src/programs/sk_skb.rs index f91ca7e0..79fcfea8 100644 --- a/aya/src/programs/sk_skb.rs +++ b/aya/src/programs/sk_skb.rs @@ -113,9 +113,7 @@ impl SkSkb { } define_link_wrapper!( - /// The link used by [SkSkb] programs. SkSkbLink, - /// The type returned by [SkSkb::attach]. Can be passed to [SkSkb::detach]. SkSkbLinkId, ProgAttachLink, ProgAttachLinkId, diff --git a/aya/src/programs/sock_ops.rs b/aya/src/programs/sock_ops.rs index 83413c60..01f3b100 100644 --- a/aya/src/programs/sock_ops.rs +++ b/aya/src/programs/sock_ops.rs @@ -132,9 +132,7 @@ impl Link for SockOpsLinkInner { id_as_key!(SockOpsLinkInner, SockOpsLinkIdInner); define_link_wrapper!( - /// The link used by [SockOps] programs. SockOpsLink, - /// The type returned by [SockOps::attach]. Can be passed to [SockOps::detach]. SockOpsLinkId, SockOpsLinkInner, SockOpsLinkIdInner, diff --git a/aya/src/programs/socket_filter.rs b/aya/src/programs/socket_filter.rs index 68c6c833..7db96bcc 100644 --- a/aya/src/programs/socket_filter.rs +++ b/aya/src/programs/socket_filter.rs @@ -120,7 +120,7 @@ impl SocketFilter { } } -/// The type returned by [SocketFilter::attach]. Can be passed to [SocketFilter::detach]. +/// The type returned by [`SocketFilter::attach`]. Can be passed to [`SocketFilter::detach`]. #[derive(Debug, Hash, Eq, PartialEq)] pub struct SocketFilterLinkId(RawFd, RawFd); diff --git a/aya/src/programs/tc.rs b/aya/src/programs/tc.rs index 5e54a946..58a0ecbf 100644 --- a/aya/src/programs/tc.rs +++ b/aya/src/programs/tc.rs @@ -463,9 +463,7 @@ impl TryFrom for SchedClassifierLink { } define_link_wrapper!( - /// The link used by [SchedClassifier] programs. SchedClassifierLink, - /// The type returned by [SchedClassifier::attach]. Can be passed to [SchedClassifier::detach]. SchedClassifierLinkId, TcLinkInner, TcLinkIdInner, diff --git a/aya/src/programs/tp_btf.rs b/aya/src/programs/tp_btf.rs index 45de7d28..873405c3 100644 --- a/aya/src/programs/tp_btf.rs +++ b/aya/src/programs/tp_btf.rs @@ -78,9 +78,7 @@ impl BtfTracePoint { } define_link_wrapper!( - /// The link used by [BtfTracePoint] programs. BtfTracePointLink, - /// The type returned by [BtfTracePoint::attach]. Can be passed to [BtfTracePoint::detach]. BtfTracePointLinkId, FdLink, FdLinkId, diff --git a/aya/src/programs/trace_point.rs b/aya/src/programs/trace_point.rs index c3d95b51..651e8b13 100644 --- a/aya/src/programs/trace_point.rs +++ b/aya/src/programs/trace_point.rs @@ -90,9 +90,7 @@ impl TracePoint { } define_link_wrapper!( - /// The link used by [TracePoint] programs. TracePointLink, - /// The type returned by [TracePoint::attach]. Can be passed to [TracePoint::detach]. TracePointLinkId, PerfLinkInner, PerfLinkIdInner, diff --git a/aya/src/programs/uprobe.rs b/aya/src/programs/uprobe.rs index a3d845d7..6dcd26e7 100644 --- a/aya/src/programs/uprobe.rs +++ b/aya/src/programs/uprobe.rs @@ -211,9 +211,7 @@ fn test_resolve_attach_path() { } define_link_wrapper!( - /// The link used by [UProbe] programs. UProbeLink, - /// The type returned by [UProbe::attach]. Can be passed to [UProbe::detach]. UProbeLinkId, PerfLinkInner, PerfLinkIdInner, diff --git a/aya/src/programs/xdp.rs b/aya/src/programs/xdp.rs index eb7c57b7..55ada66e 100644 --- a/aya/src/programs/xdp.rs +++ b/aya/src/programs/xdp.rs @@ -319,12 +319,4 @@ impl TryFrom for XdpLink { } } -define_link_wrapper!( - /// The link used by [Xdp] programs. - XdpLink, - /// The type returned by [Xdp::attach]. Can be passed to [Xdp::detach]. - XdpLinkId, - XdpLinkInner, - XdpLinkIdInner, - Xdp, -); +define_link_wrapper!(XdpLink, XdpLinkId, XdpLinkInner, XdpLinkIdInner, Xdp);