bpf: add documentation for helpers bpf_spin_lock(), bpf_spin_unlock()
authorQuentin Monnet <quentin.monnet@netronome.com>
Thu, 14 Mar 2019 12:38:40 +0000 (12:38 +0000)
committerAlexei Starovoitov <ast@kernel.org>
Thu, 14 Mar 2019 21:03:21 +0000 (14:03 -0700)
commit0eb0978528d47699edd091dc2c337952ad8da436
treee1255bd0d21af73de66609364cb14d46457c5fd8
parent62369db2df8d1edfa040878203b446e023a16802
bpf: add documentation for helpers bpf_spin_lock(), bpf_spin_unlock()

Add documentation for the BPF spinlock-related helpers to the doc in
bpf.h. I added the constraints and restrictions coming with the use of
spinlocks for BPF: not all of it is directly related to the use of the
helper, but I thought it would be nice for users to find them in the man
page.

This list of restrictions is nearly a verbatim copy of the list in
Alexei's commit log for those helpers.

Signed-off-by: Quentin Monnet <quentin.monnet@netronome.com>
Reviewed-by: Jakub Kicinski <jakub.kicinski@netronome.com>
Signed-off-by: Alexei Starovoitov <ast@kernel.org>
include/uapi/linux/bpf.h