diff options
| author | Joe Stringer <joe@cilium.io> | 2021-03-02 09:19:46 -0800 |
|---|---|---|
| committer | Alexei Starovoitov <ast@kernel.org> | 2021-03-04 18:39:46 -0800 |
| commit | 6197e5b7b1b5acd1e9b04bdf3527c694d84a27e2 (patch) | |
| tree | 6527cf669c2bbc3e1025d5c761e66678c22caffc /Documentation/userspace-api/ebpf | |
| parent | accbd33a9b0328777899a85d148040e4d8921d87 (diff) | |
| download | linux-6197e5b7b1b5acd1e9b04bdf3527c694d84a27e2.tar.gz linux-6197e5b7b1b5acd1e9b04bdf3527c694d84a27e2.tar.bz2 linux-6197e5b7b1b5acd1e9b04bdf3527c694d84a27e2.zip | |
docs/bpf: Add bpf() syscall command reference
Generate the syscall command reference from the UAPI header file and
include it in the main bpf docs page.
Signed-off-by: Joe Stringer <joe@cilium.io>
Signed-off-by: Alexei Starovoitov <ast@kernel.org>
Reviewed-by: Quentin Monnet <quentin@isovalent.com>
Acked-by: Toke Høiland-Jørgensen <toke@redhat.com>
Link: https://lore.kernel.org/bpf/20210302171947.2268128-15-joe@cilium.io
Diffstat (limited to 'Documentation/userspace-api/ebpf')
| -rw-r--r-- | Documentation/userspace-api/ebpf/index.rst | 17 | ||||
| -rw-r--r-- | Documentation/userspace-api/ebpf/syscall.rst | 24 |
2 files changed, 41 insertions, 0 deletions
diff --git a/Documentation/userspace-api/ebpf/index.rst b/Documentation/userspace-api/ebpf/index.rst new file mode 100644 index 000000000000..473dfba78116 --- /dev/null +++ b/Documentation/userspace-api/ebpf/index.rst @@ -0,0 +1,17 @@ +.. SPDX-License-Identifier: GPL-2.0 + +eBPF Userspace API +================== + +eBPF is a kernel mechanism to provide a sandboxed runtime environment in the +Linux kernel for runtime extension and instrumentation without changing kernel +source code or loading kernel modules. eBPF programs can be attached to various +kernel subsystems, including networking, tracing and Linux security modules +(LSM). + +For internal kernel documentation on eBPF, see Documentation/bpf/index.rst. + +.. toctree:: + :maxdepth: 1 + + syscall diff --git a/Documentation/userspace-api/ebpf/syscall.rst b/Documentation/userspace-api/ebpf/syscall.rst new file mode 100644 index 000000000000..ea9918084221 --- /dev/null +++ b/Documentation/userspace-api/ebpf/syscall.rst @@ -0,0 +1,24 @@ +.. SPDX-License-Identifier: GPL-2.0 + +eBPF Syscall +------------ + +:Authors: - Alexei Starovoitov <ast@kernel.org> + - Joe Stringer <joe@wand.net.nz> + - Michael Kerrisk <mtk.manpages@gmail.com> + +The primary info for the bpf syscall is available in the `man-pages`_ +for `bpf(2)`_. + +bpf() subcommand reference +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. kernel-doc:: include/uapi/linux/bpf.h + :doc: eBPF Syscall Preamble + +.. kernel-doc:: include/uapi/linux/bpf.h + :doc: eBPF Syscall Commands + +.. Links: +.. _man-pages: https://www.kernel.org/doc/man-pages/ +.. _bpf(2): https://man7.org/linux/man-pages/man2/bpf.2.html |