| Message ID | 20180410144157.4831-5-quentin.monnet@netronome.com |
|---|---|
| State | RFC, archived |
| Delegated to: | BPF Maintainers |
| Headers | show |
| Series | bpf: document eBPF helpers and add a script to generate man page | expand |
On Tue, Apr 10, 2018 at 03:41:53PM +0100, Quentin Monnet wrote: > Add documentation for eBPF helper functions to bpf.h user header file. > This documentation can be parsed with the Python script provided in > another commit of the patch series, in order to provide a RST document > that can later be converted into a man page. > > The objective is to make the documentation easily understandable and > accessible to all eBPF developers, including beginners. > > This patch contains descriptions for the following helper functions, all > written by Daniel: > > - bpf_get_prandom_u32() > - bpf_get_smp_processor_id() > - bpf_get_cgroup_classid() > - bpf_get_route_realm() > - bpf_skb_load_bytes() > - bpf_csum_diff() > - bpf_skb_get_tunnel_opt() > - bpf_skb_set_tunnel_opt() > - bpf_skb_change_proto() > - bpf_skb_change_type() > > Cc: Daniel Borkmann <daniel@iogearbox.net> > Signed-off-by: Quentin Monnet <quentin.monnet@netronome.com> > --- > include/uapi/linux/bpf.h | 125 +++++++++++++++++++++++++++++++++++++++++++++++ > 1 file changed, 125 insertions(+) > > diff --git a/include/uapi/linux/bpf.h b/include/uapi/linux/bpf.h > index f3ea8824efbc..d147d9dd6a83 100644 > --- a/include/uapi/linux/bpf.h > +++ b/include/uapi/linux/bpf.h > @@ -473,6 +473,14 @@ union bpf_attr { > * The number of bytes written to the buffer, or a negative error > * in case of failure. > * > + * u32 bpf_prandom_u32(void) > + * Return > + * A random 32-bit unsigned value. there is no such helper. It's called bpf_get_prandom_u32(). I'd also add a note that it's using its own random state and cannot be used to infer seed of other random functions in the kernel. > + * > + * u32 bpf_get_smp_processor_id(void) > + * Return > + * The SMP (Symmetric multiprocessing) processor id. probably worth adding a note to explain that all bpf programs run with preemption disabled, so processor id is stable for the run of the program. > + * > * int bpf_skb_store_bytes(struct sk_buff *skb, u32 offset, const void *from, u32 len, u64 flags) > * Description > * Store *len* bytes from address *from* into the packet > @@ -604,6 +612,13 @@ union bpf_attr { > * Return > * 0 on success, or a negative error in case of failure. > * > + * u32 bpf_get_cgroup_classid(struct sk_buff *skb) > + * Description > + * Retrieve the classid for the current task, i.e. for the > + * net_cls (network classifier) cgroup to which *skb* belongs. please add that kernel should be configured with CONFIG_NET_CLS_CGROUP=y|m and mention Documentation/cgroup-v1/net_cls.txt Otherwise 'network classifier' is way too generic. I'd also mention that placing a task into net_cls controller disables all of cgroup-bpf. > + * Return > + * The classid, or 0 for the default unconfigured classid. > + * > * int bpf_skb_vlan_push(struct sk_buff *skb, __be16 vlan_proto, u16 vlan_tci) > * Description > * Push a *vlan_tci* (VLAN tag control information) of protocol > @@ -703,6 +718,14 @@ union bpf_attr { > * are **TC_ACT_REDIRECT** on success or **TC_ACT_SHOT** on > * error. > * > + * u32 bpf_get_route_realm(struct sk_buff *skb) > + * Description > + * Retrieve the realm or the route, that is to say the > + * **tclassid** field of the destination for the *skb*. Similarly this only works if CONFIG_IP_ROUTE_CLASSID is on. > + * Return > + * The realm of the route for the packet associated to *sdb*, or 0 > + * if none was found. > + * > * int bpf_perf_event_output(struct pt_reg *ctx, struct bpf_map *map, u64 flags, void *data, u64 size) > * Description > * Write perf raw sample into a perf event held by *map* of type > @@ -779,6 +802,21 @@ union bpf_attr { > * Return > * 0 on success, or a negative error in case of failure. > * > + * int bpf_skb_load_bytes(const struct sk_buff *skb, u32 offset, void *to, u32 len) > + * Description > + * This helper was provided as an easy way to load data from a > + * packet. It can be used to load *len* bytes from *offset* from > + * the packet associated to *skb*, into the buffer pointed by > + * *to*. > + * > + * Since Linux 4.7, this helper is deprecated in favor of > + * "direct packet access", enabling packet data to be manipulated > + * with *skb*\ **->data** and *skb*\ **->data_end** pointing > + * respectively to the first byte of packet data and to the byte > + * after the last byte of packet data. I wouldn't call it deprecated. It's still useful when programmer wants to read large quantities of data from the packet > + * Return > + * 0 on success, or a negative error in case of failure. > + * > * int bpf_get_stackid(struct pt_reg *ctx, struct bpf_map *map, u64 flags) > * Description > * Walk a user or a kernel stack and return its id. To achieve > @@ -814,6 +852,93 @@ union bpf_attr { > * The positive or null stack id on success, or a negative error > * in case of failure. > * > + * s64 bpf_csum_diff(__be32 *from, u32 from_size, __be32 *to, u32 to_size, __wsum seed) > + * Description > + * Compute a checksum difference, from the raw buffer pointed by > + * *from*, of length *from_size* (that must be a multiple of 4), > + * towards the raw buffer pointed by *to*, of size *to_size* > + * (same remark). An optional *seed* can be added to the value. > + * > + * This is flexible enough to be used in several ways: > + * > + * * With *from_size* == 0, *to_size* > 0 and *seed* set to > + * checksum, it can be used when pushing new data. > + * * With *from_size* > 0, *to_size* == 0 and *seed* set to > + * checksum, it can be used when removing data from a packet. > + * * With *from_size* > 0, *to_size* > 0 and *seed* set to 0, it > + * can be used to compute a diff. Note that *from_size* and > + * *to_size* do not need to be equal. > + * Return > + * The checksum result, or a negative error code in case of > + * failure. > + * > + * int bpf_skb_get_tunnel_opt(struct sk_buff *skb, u8 *opt, u32 size) > + * Description > + * Retrieve tunnel options metadata for the packet associated to > + * *skb*, and store the raw tunnel option data to the buffer *opt* > + * of *size*. > + * Return > + * The size of the option data retrieved. > + * > + * int bpf_skb_set_tunnel_opt(struct sk_buff *skb, u8 *opt, u32 size) > + * Description > + * Set tunnel options metadata for the packet associated to *skb* > + * to the option data contained in the raw buffer *opt* of *size*. > + * Return > + * 0 on success, or a negative error in case of failure. > + * > + * int bpf_skb_change_proto(struct sk_buff *skb, __be16 proto, u64 flags) > + * Description > + * Change the protocol of the *skb* to *proto*. Currently > + * supported are transition from IPv4 to IPv6, and from IPv6 to > + * IPv4. The helper takes care of the groundwork for the > + * transition, including resizing the socket buffer. The eBPF > + * program is expected to fill the new headers, if any, via > + * **skb_store_bytes**\ () and to recompute the checksums with > + * **bpf_l3_csum_replace**\ () and **bpf_l4_csum_replace**\ > + * (). > + * > + * Internally, the GSO type is marked as dodgy so that headers are > + * checked and segments are recalculated by the GSO/GRO engine. > + * The size for GSO target is adapted as well. > + * > + * All values for *flags* are reserved for future usage, and must > + * be left at zero. > + * > + * A call to this helper is susceptible to change data from the > + * packet. Therefore, at load time, all checks on pointers > + * previously done by the verifier are invalidated and must be > + * performed again. > + * Return > + * 0 on success, or a negative error in case of failure. > + * > + * int bpf_skb_change_type(struct sk_buff *skb, u32 type) > + * Description > + * Change the packet type for the packet associated to *skb*. This > + * comes down to setting *skb*\ **->pkt_type** to *type*, except > + * the eBPF program does not have a write access to *skb*\ > + * **->pkt_type** beside this helper. Using a helper here allows > + * for graceful handling of errors. > + * > + * The major use case is to change incoming *skb*s to > + * **PACKET_HOST** in a programmatic way instead of having to > + * recirculate via **redirect**\ (..., **BPF_F_INGRESS**), for > + * example. > + * > + * Note that *type* only allows certain values. At this time, they > + * are: > + * > + * **PACKET_HOST** > + * Packet is for us. > + * **PACKET_BROADCAST** > + * Send packet to all. > + * **PACKET_MULTICAST** > + * Send packet to group. > + * **PACKET_OTHERHOST** > + * Send packet to someone else. > + * Return > + * 0 on success, or a negative error in case of failure. > + * > * u64 bpf_get_current_task(void) > * Return > * A pointer to the current task struct. > -- > 2.14.1 >
2018-04-12 17:28 UTC-0700 ~ Alexei Starovoitov <alexei.starovoitov@gmail.com> > On Tue, Apr 10, 2018 at 03:41:53PM +0100, Quentin Monnet wrote: >> Add documentation for eBPF helper functions to bpf.h user header file. >> This documentation can be parsed with the Python script provided in >> another commit of the patch series, in order to provide a RST document >> that can later be converted into a man page. >> >> The objective is to make the documentation easily understandable and >> accessible to all eBPF developers, including beginners. >> >> This patch contains descriptions for the following helper functions, all >> written by Daniel: >> >> - bpf_get_prandom_u32() >> - bpf_get_smp_processor_id() >> - bpf_get_cgroup_classid() >> - bpf_get_route_realm() >> - bpf_skb_load_bytes() >> - bpf_csum_diff() >> - bpf_skb_get_tunnel_opt() >> - bpf_skb_set_tunnel_opt() >> - bpf_skb_change_proto() >> - bpf_skb_change_type() >> >> Cc: Daniel Borkmann <daniel@iogearbox.net> >> Signed-off-by: Quentin Monnet <quentin.monnet@netronome.com> >> --- >> include/uapi/linux/bpf.h | 125 +++++++++++++++++++++++++++++++++++++++++++++++ >> 1 file changed, 125 insertions(+) >> >> diff --git a/include/uapi/linux/bpf.h b/include/uapi/linux/bpf.h >> index f3ea8824efbc..d147d9dd6a83 100644 >> --- a/include/uapi/linux/bpf.h >> +++ b/include/uapi/linux/bpf.h [...] >> @@ -604,6 +612,13 @@ union bpf_attr { >> * Return >> * 0 on success, or a negative error in case of failure. >> * >> + * u32 bpf_get_cgroup_classid(struct sk_buff *skb) >> + * Description >> + * Retrieve the classid for the current task, i.e. for the >> + * net_cls (network classifier) cgroup to which *skb* belongs. > > please add that kernel should be configured with CONFIG_NET_CLS_CGROUP=y|m > and mention Documentation/cgroup-v1/net_cls.txt Ok. > Otherwise 'network classifier' is way too generic. I am not so familiar with cgroups. What would you suggest instead? > I'd also mention that placing a task into net_cls controller > disables all of cgroup-bpf. Could you please explain a bit more? Placing a task into the controller is using: echo <task_pid> > /sys/fs/cgroup/<my_cgroup_name>/tasks correct? Then if I do this, it disables all of cgroup-bpf. Does this mean that I loose the possibility to use or add BPF programs to all cgroup-related attach points for this cgroup? I think I missed something here. >> + * Return >> + * The classid, or 0 for the default unconfigured classid. >> + * >> * int bpf_skb_vlan_push(struct sk_buff *skb, __be16 vlan_proto, u16 vlan_tci) >> * Description >> * Push a *vlan_tci* (VLAN tag control information) of protocol I have no particular comments on the other items you reported on this patch, I will fix them. Thanks! Quentin
diff --git a/include/uapi/linux/bpf.h b/include/uapi/linux/bpf.h index f3ea8824efbc..d147d9dd6a83 100644 --- a/include/uapi/linux/bpf.h +++ b/include/uapi/linux/bpf.h @@ -473,6 +473,14 @@ union bpf_attr { * The number of bytes written to the buffer, or a negative error * in case of failure. * + * u32 bpf_prandom_u32(void) + * Return + * A random 32-bit unsigned value. + * + * u32 bpf_get_smp_processor_id(void) + * Return + * The SMP (Symmetric multiprocessing) processor id. + * * int bpf_skb_store_bytes(struct sk_buff *skb, u32 offset, const void *from, u32 len, u64 flags) * Description * Store *len* bytes from address *from* into the packet @@ -604,6 +612,13 @@ union bpf_attr { * Return * 0 on success, or a negative error in case of failure. * + * u32 bpf_get_cgroup_classid(struct sk_buff *skb) + * Description + * Retrieve the classid for the current task, i.e. for the + * net_cls (network classifier) cgroup to which *skb* belongs. + * Return + * The classid, or 0 for the default unconfigured classid. + * * int bpf_skb_vlan_push(struct sk_buff *skb, __be16 vlan_proto, u16 vlan_tci) * Description * Push a *vlan_tci* (VLAN tag control information) of protocol @@ -703,6 +718,14 @@ union bpf_attr { * are **TC_ACT_REDIRECT** on success or **TC_ACT_SHOT** on * error. * + * u32 bpf_get_route_realm(struct sk_buff *skb) + * Description + * Retrieve the realm or the route, that is to say the + * **tclassid** field of the destination for the *skb*. + * Return + * The realm of the route for the packet associated to *sdb*, or 0 + * if none was found. + * * int bpf_perf_event_output(struct pt_reg *ctx, struct bpf_map *map, u64 flags, void *data, u64 size) * Description * Write perf raw sample into a perf event held by *map* of type @@ -779,6 +802,21 @@ union bpf_attr { * Return * 0 on success, or a negative error in case of failure. * + * int bpf_skb_load_bytes(const struct sk_buff *skb, u32 offset, void *to, u32 len) + * Description + * This helper was provided as an easy way to load data from a + * packet. It can be used to load *len* bytes from *offset* from + * the packet associated to *skb*, into the buffer pointed by + * *to*. + * + * Since Linux 4.7, this helper is deprecated in favor of + * "direct packet access", enabling packet data to be manipulated + * with *skb*\ **->data** and *skb*\ **->data_end** pointing + * respectively to the first byte of packet data and to the byte + * after the last byte of packet data. + * Return + * 0 on success, or a negative error in case of failure. + * * int bpf_get_stackid(struct pt_reg *ctx, struct bpf_map *map, u64 flags) * Description * Walk a user or a kernel stack and return its id. To achieve @@ -814,6 +852,93 @@ union bpf_attr { * The positive or null stack id on success, or a negative error * in case of failure. * + * s64 bpf_csum_diff(__be32 *from, u32 from_size, __be32 *to, u32 to_size, __wsum seed) + * Description + * Compute a checksum difference, from the raw buffer pointed by + * *from*, of length *from_size* (that must be a multiple of 4), + * towards the raw buffer pointed by *to*, of size *to_size* + * (same remark). An optional *seed* can be added to the value. + * + * This is flexible enough to be used in several ways: + * + * * With *from_size* == 0, *to_size* > 0 and *seed* set to + * checksum, it can be used when pushing new data. + * * With *from_size* > 0, *to_size* == 0 and *seed* set to + * checksum, it can be used when removing data from a packet. + * * With *from_size* > 0, *to_size* > 0 and *seed* set to 0, it + * can be used to compute a diff. Note that *from_size* and + * *to_size* do not need to be equal. + * Return + * The checksum result, or a negative error code in case of + * failure. + * + * int bpf_skb_get_tunnel_opt(struct sk_buff *skb, u8 *opt, u32 size) + * Description + * Retrieve tunnel options metadata for the packet associated to + * *skb*, and store the raw tunnel option data to the buffer *opt* + * of *size*. + * Return + * The size of the option data retrieved. + * + * int bpf_skb_set_tunnel_opt(struct sk_buff *skb, u8 *opt, u32 size) + * Description + * Set tunnel options metadata for the packet associated to *skb* + * to the option data contained in the raw buffer *opt* of *size*. + * Return + * 0 on success, or a negative error in case of failure. + * + * int bpf_skb_change_proto(struct sk_buff *skb, __be16 proto, u64 flags) + * Description + * Change the protocol of the *skb* to *proto*. Currently + * supported are transition from IPv4 to IPv6, and from IPv6 to + * IPv4. The helper takes care of the groundwork for the + * transition, including resizing the socket buffer. The eBPF + * program is expected to fill the new headers, if any, via + * **skb_store_bytes**\ () and to recompute the checksums with + * **bpf_l3_csum_replace**\ () and **bpf_l4_csum_replace**\ + * (). + * + * Internally, the GSO type is marked as dodgy so that headers are + * checked and segments are recalculated by the GSO/GRO engine. + * The size for GSO target is adapted as well. + * + * All values for *flags* are reserved for future usage, and must + * be left at zero. + * + * A call to this helper is susceptible to change data from the + * packet. Therefore, at load time, all checks on pointers + * previously done by the verifier are invalidated and must be + * performed again. + * Return + * 0 on success, or a negative error in case of failure. + * + * int bpf_skb_change_type(struct sk_buff *skb, u32 type) + * Description + * Change the packet type for the packet associated to *skb*. This + * comes down to setting *skb*\ **->pkt_type** to *type*, except + * the eBPF program does not have a write access to *skb*\ + * **->pkt_type** beside this helper. Using a helper here allows + * for graceful handling of errors. + * + * The major use case is to change incoming *skb*s to + * **PACKET_HOST** in a programmatic way instead of having to + * recirculate via **redirect**\ (..., **BPF_F_INGRESS**), for + * example. + * + * Note that *type* only allows certain values. At this time, they + * are: + * + * **PACKET_HOST** + * Packet is for us. + * **PACKET_BROADCAST** + * Send packet to all. + * **PACKET_MULTICAST** + * Send packet to group. + * **PACKET_OTHERHOST** + * Send packet to someone else. + * Return + * 0 on success, or a negative error in case of failure. + * * u64 bpf_get_current_task(void) * Return * A pointer to the current task struct.
Add documentation for eBPF helper functions to bpf.h user header file. This documentation can be parsed with the Python script provided in another commit of the patch series, in order to provide a RST document that can later be converted into a man page. The objective is to make the documentation easily understandable and accessible to all eBPF developers, including beginners. This patch contains descriptions for the following helper functions, all written by Daniel: - bpf_get_prandom_u32() - bpf_get_smp_processor_id() - bpf_get_cgroup_classid() - bpf_get_route_realm() - bpf_skb_load_bytes() - bpf_csum_diff() - bpf_skb_get_tunnel_opt() - bpf_skb_set_tunnel_opt() - bpf_skb_change_proto() - bpf_skb_change_type() Cc: Daniel Borkmann <daniel@iogearbox.net> Signed-off-by: Quentin Monnet <quentin.monnet@netronome.com> --- include/uapi/linux/bpf.h | 125 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 125 insertions(+)