Two minor bpf doc updates
Subsystems (5)
Daniel Borkmann
maintainercover Two minor bpf doc updates
Two trivial doc follow-ups to i) remove deprecated kern_version mentioning in the design qa and ii) to mention stand-alone build and license of libbpf. Thanks!
Daniel Borkmann (2):
bpf, doc: update design qa to reflect kern_version requirement bpf, doc: add note for libbpf's stand-alone build
Documentation/bpf/bpf_design_QA.rst | 11 +++++------ tools/lib/bpf/README.rst | 14 ++++++++++++++ 2 files changed, 19 insertions(+), 6 deletions(-)
Signature · 1 line
2.9.5
Daniel Borkmann
maintainerPATCH 1/2 bpf, doc: update design qa to reflect kern_version requirement
Update the bpf_design_QA.rst to also reflect recent changes in 6c4fc209fcf9 ("bpf: remove useless version check for prog load").
--- Documentation/bpf/bpf_design_QA.rst | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-)
Documentation/bpf/bpf_design_QA.rst +5 -6
@@ -157,12 +157,11 @@ Q: Does BPF have a stable ABI? ------------------------------ A: YES. BPF instructions, arguments to BPF programs, set of helper functions and their arguments, recognized return codes are all part -of ABI. However when tracing programs are using bpf_probe_read() helper -to walk kernel internal datastructures and compile with kernel -internal headers these accesses can and will break with newer -kernels. The union bpf_attr -> kern_version is checked at load time -to prevent accidentally loading kprobe-based bpf programs written -for a different kernel. Networking programs don't do kern_version check. +of ABI. However there is one specific exception to tracing programs +which are using helpers like bpf_probe_read() to walk kernel internal +data structures and compile with kernel internal headers. Both of these +kernel internals are subject to change and can break with newer kernels +such that the program needs to be adapted accordingly. Q: How much stack space a BPF program uses? -------------------------------------------
Signature · 1 line
2.9.5
Daniel Borkmann
maintainerPATCH 2/2 bpf, doc: add note for libbpf's stand-alone build
In reply to Daniel BorkmannGiven this came up couple of times, add a note to libbpf's readme about the semi-automated mirror for a stand-alone build which is officially managed by BPF folks. While at it, also explicitly state the libbpf license in the readme file.
--- tools/lib/bpf/README.rst | 14 ++++++++++++++ 1 file changed, 14 insertions(+)
tools/lib/bpf/README.rst +14 -0
@@ -132,6 +132,20 @@ For example, if current state of ``libbpf.map`` is: Format of version script and ways to handle ABI changes, including incompatible ones, described in details in [1]. +Stand-alone build +================= + +Under https://github.com/libbpf/libbpf there is a (semi-)automated +mirror of the mainline's version of libbpf for a stand-alone build. + +However, all changes to libbpf's code base must be upstreamed through +the mainline kernel tree. + +License +======= + +libbpf is dual-licensed under LGPL 2.1 and BSD 2-Clause. + Links =====
Signature · 1 line
2.9.5
Alexei Starovoitov
AppliedQuoted 3 lines · Daniel Borkmann
Two trivial doc follow-ups to i) remove deprecated
kern_versionmentioning in the design qa and ii) to mention stand-alone build and license of libbpf. Thanks!
Applied, Thanks