bpf: Update bpf_design_QA.rst to clarify that attaching to functions is not ABI
authorPaul E. McKenney <paulmck@kernel.org>
Tue, 2 Aug 2022 17:39:12 +0000 (10:39 -0700)
committerAlexei Starovoitov <ast@kernel.org>
Thu, 4 Aug 2022 20:17:24 +0000 (13:17 -0700)
This patch updates bpf_design_QA.rst to clarify that the ability to
attach a BPF program to an arbitrary function in the kernel does not
make that function become part of the Linux kernel's ABI.

[ paulmck: Apply Daniel Borkmann feedback. ]

Signed-off-by: Paul E. McKenney <paulmck@kernel.org>
Link: https://lore.kernel.org/r/20220802173913.4170192-2-paulmck@kernel.org
Signed-off-by: Alexei Starovoitov <ast@kernel.org>
Documentation/bpf/bpf_design_QA.rst

index 2ed9128cfbec8250d9173f6a42b5c43fc22da796..a06ae8a828e3dd321d5d9fc6a0ca4ccbe964dce8 100644 (file)
@@ -279,3 +279,15 @@ cc (congestion-control) implementations.  If any of these kernel
 functions has changed, both the in-tree and out-of-tree kernel tcp cc
 implementations have to be changed.  The same goes for the bpf
 programs and they have to be adjusted accordingly.
+
+Q: Attaching to arbitrary kernel functions is an ABI?
+-----------------------------------------------------
+Q: BPF programs can be attached to many kernel functions.  Do these
+kernel functions become part of the ABI?
+
+A: NO.
+
+The kernel function prototypes will change, and BPF programs attaching to
+them will need to change.  The BPF compile-once-run-everywhere (CO-RE)
+should be used in order to make it easier to adapt your BPF programs to
+different versions of the kernel.