bpf: Document BPF_F_QUERY_EFFECTIVE flag
PATCH 1/1 bpf: Document BPF_F_QUERY_EFFECTIVE flag
Document BPF_F_QUERY_EFFECTIVE flag, mostly to clarify how it affects attach_flags what may not be obvious and what may lead to confision.
Specifically attach_flags is returned only for target_fd but if programs are inherited from an ancestor cgroup then returned attach_flags for current cgroup may be confusing. For example, two effective programs of same attach_type can be returned but w/o BPF_F_ALLOW_MULTI in attach_flags.
Simple repro:
# bpftool c s /sys/fs/cgroup/path/to/task ID AttachType AttachFlags Name # bpftool c s /sys/fs/cgroup/path/to/task effective ID AttachType AttachFlags Name 95043 ingress tw_ipt_ingress 95048 ingress tw_ingress
--- include/uapi/linux/bpf.h | 7 ++++++- tools/include/uapi/linux/bpf.h | 7 ++++++- 2 files changed, 12 insertions(+), 2 deletions(-)
include/uapi/linux/bpf.h +6 -1
@@ -357,7 +357,12 @@ enum bpf_attach_type {/* Enable memory-mapping BPF map */ #define BPF_F_MMAPABLE (1U << 10) -/* flags for BPF_PROG_QUERY */ +/* Flags for BPF_PROG_QUERY. */ + +/* Query effective (directly attached + inherited from ancestor cgroups) +* programs that will be executed for events within a cgroup. +* attach_flags with this flag are returned only for directly attached programs. +*/ #define BPF_F_QUERY_EFFECTIVE (1U << 0)enum bpf_stack_build_id_status {
tools/include/uapi/linux/bpf.h +6 -1
@@ -357,7 +357,12 @@ enum bpf_attach_type {/* Enable memory-mapping BPF map */ #define BPF_F_MMAPABLE (1U << 10) -/* flags for BPF_PROG_QUERY */ +/* Flags for BPF_PROG_QUERY. */ + +/* Query effective (directly attached + inherited from ancestor cgroups) +* programs that will be executed for events within a cgroup. +* attach_flags with this flag are returned only for directly attached programs. +*/ #define BPF_F_QUERY_EFFECTIVE (1U << 0)enum bpf_stack_build_id_status {
Signature · 1 line
2.17.1
Quoted 14 lines · Andrey Ignatov
Document
BPF_F_QUERY_EFFECTIVEflag, mostly to clarify how it affectsattach_flagswhat may not be obvious and what may lead to confision.Specifically
attach_flagsis returned only fortarget_fdbut if programs are inherited from an ancestor cgroup then returnedattach_flagsfor current cgroup may be confusing. For example, two effective programs of sameattach_typecan be returned but w/oBPF_F_ALLOW_MULTIinattach_flags.Simple repro:
Quoted 8 lines
# bpftool c s /sys/fs/cgroup/path/to/task ID AttachType AttachFlags Name # bpftool c s /sys/fs/cgroup/path/to/task effective ID AttachType AttachFlags Name 95043 ingress tw_ipt_ingress 95048 ingress tw_ingressSigned-off-by Andrey Ignatov <[email protected]>
With some nit below.
Quoted 10 lines
---
include/uapi/linux/bpf.h| 7 ++++++-tools/include/uapi/linux/bpf.h| 7 ++++++-2 files changed, 12 insertions(+), 2 deletions(-)include/uapi/linux/bpf.h +0
-0
include/uapi/linux/bpf.h enum bpf_attach_type { · line 364
Quoted 9 lines
include/uapi/linux/bpf.h +5
-1@@ -357,7 +357,12 @@ enum bpf_attach_type {/* Enable memory-mapping BPF map */ #define BPF_F_MMAPABLE (1U << 10) -/* flags for BPF_PROG_QUERY */ +/* Flags for BPF_PROG_QUERY. */ + +/* Query effective (directly attached + inherited from ancestor cgroups) +* programs that will be executed for events within a cgroup. +* attach_flags with this flag are returned only for directly attached programs.
This line is more than 75 byte long, I guess ./scripts/checkpatch.pl would complain about it?
Thanks,
Song
Song Liu <[email protected]> [Wed, 2020-01-08 08:31 -0800]:
[...]
Quoted 8 lines
Quoted 8 lines
include/uapi/linux/bpf.h +0
-0@@ -357,7 +357,12 @@ enum bpf_attach_type {/* Enable memory-mapping BPF map */ #define BPF_F_MMAPABLE (1U << 10)
Quoted 9 lines
include/uapi/linux/bpf.h enum bpf_attach_type { · line 364
Quoted 6 lines
include/uapi/linux/bpf.h +5
-1-/* flags for BPF_PROG_QUERY */ +/* Flags for BPF_PROG_QUERY. */ + +/* Query effective (directly attached + inherited from ancestor cgroups) +* programs that will be executed for events within a cgroup. +* attach_flags with this flag are returned only for directly attached programs. This line is more than 75 byte long, I guess
./scripts/checkpatch.plwould complain about it?
I run checkpatch.pl before sending it but it didn't complain:
% scripts/checkpatch.pl p/0001-bpf-Document-BPF_F_QUERY_EFFECTIVE-flag.patch
total: 0 errors, 0 warnings, 26 lines checked
p/0001-bpf-Document-BPF_F_QUERY_EFFECTIVE-flag.patch has no obvious style problems and is ready for submission.
I haven't debugged why, but this header has plenty of lines like this:
% awk 'length($0) >= 75' include/uapi/linux/bpf.h | wc -l 74
Signature · 1 line
Andrey Ignatov
Alexei Starovoitov
AppliedQuoted 26 lines · Andrey Ignatov
Song Liu <[email protected]> [Wed, 2020-01-08 08:31 -0800]:
[...]Quoted 8 lines
Quoted 8 lines
include/uapi/linux/bpf.h +0
-0@@ -357,7 +357,12 @@ enum bpf_attach_type {/* Enable memory-mapping BPF map */ #define BPF_F_MMAPABLE (1U << 10)Quoted 9 lines
include/uapi/linux/bpf.h enum bpf_attach_type { · line 364
Quoted 6 lines
include/uapi/linux/bpf.h +5
-1-/* flags for BPF_PROG_QUERY */ +/* Flags for BPF_PROG_QUERY. */ + +/* Query effective (directly attached + inherited from ancestor cgroups) +* programs that will be executed for events within a cgroup. +* attach_flags with this flag are returned only for directly attached programs. This line is more than 75 byte long, I guess
./scripts/checkpatch.plwould complain about it?I run checkpatch.pl before sending it but it didn't complain:
%
scripts/checkpatch.plp/0001-bpf-Document-BPF_F_QUERY_EFFECTIVE-flag.patch
total: 0 errors, 0 warnings, 26 lines checked
Quoted 6 lines
p/0001-bpf-Document-BPF_F_QUERY_EFFECTIVE-flag.patchhas no obvious style problems and is ready for submission.I haven't debugged why, but this header has plenty of lines like this:
% awk 'length($0) >= 75'
include/uapi/linux/bpf.h| wc -l 74
Applied. Thanks