]> git.proxmox.com Git - mirror_ubuntu-kernels.git/commit
bpf: add documentation for eBPF helpers (65-66)
authorQuentin Monnet <quentin.monnet@netronome.com>
Wed, 25 Apr 2018 17:17:00 +0000 (18:17 +0100)
committerDaniel Borkmann <daniel@iogearbox.net>
Thu, 26 Apr 2018 22:21:59 +0000 (00:21 +0200)
commit2d020dd771762d96d158a9deed41bc6b7480a8fe
tree79499784e1df57ca7105472067b280011b6de0bf
parentab12704099c2001915843a8b7885567ee6f1800e
bpf: add documentation for eBPF helpers (65-66)

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:

Helper from Nikita:
- bpf_xdp_adjust_tail()

Helper from Eyal:
- bpf_skb_get_xfrm_state()

v4:
- New patch (helpers did not exist yet for previous versions).

Cc: Nikita V. Shirokov <tehnerd@tehnerd.com>
Cc: Eyal Birger <eyal.birger@gmail.com>
Signed-off-by: Quentin Monnet <quentin.monnet@netronome.com>
Signed-off-by: Daniel Borkmann <daniel@iogearbox.net>
include/uapi/linux/bpf.h