Skip to content

Enhance and rework logging controls in libbpf

Andrii Nakryiko bpf 3 versions Applied

Status from this message: Applied, Thanks

Get series with b4
b4 am [email protected]

Versions newest first · linked by author and title

  1. v3 Latest12 patches 1 replyApplied
  2. v212 patches 3 repliesSuperseded
  3. v112 patches 1 replySuperseded

Changes in v3 from the cover letter

- added log_buf selftests for bpf_prog_load() and bpf_btf_load();
- fix !log_buf in bpf_prog_load (John);
- fix log_level==0 in bpf_btf_load (thanks selftest!);

Patches in v3 Applied

#Subject and filesSizeRepliesApplied
1/12libbpf: fix bpf_prog_load() log_buf logic for log_level 0tools/lib/bpf/bpf.c+16 -130 replies
2/12libbpf: add OPTS-based bpf_btf_load() APItools/lib/bpf/bpf.c tools/lib/bpf/bpf.h tools/lib/bpf/libbpf.map +1 more+69 -120 replies
3/12libbpf: allow passing preallocated log_buf when loading BTF into kerneltools/lib/bpf/btf.c tools/lib/bpf/libbpf_internal.h+56 -230 replies
4/12libbpf: allow passing user log setting through bpf_object_open_optstools/lib/bpf/bpf.h tools/lib/bpf/libbpf.c tools/lib/bpf/libbpf.h+65 -30 replies
5/12libbpf: improve logging around BPF program loadingtools/lib/bpf/libbpf.c tools/testing/selftests/bpf/prog_tests/bpf_tcp_ca.c+23 -210 replies
6/12libbpf: preserve kernel error code and remove kprobe prog type guessingtools/lib/bpf/libbpf.c+2 -170 replies
7/12libbpf: add per-program log buffer setter and gettertools/lib/bpf/libbpf.c tools/lib/bpf/libbpf.h tools/lib/bpf/libbpf.map+84 -170 replies
8/12libbpf: deprecate bpf_object__load_xattr()tools/lib/bpf/libbpf.c tools/lib/bpf/libbpf.h+11 -130 replies
9/12selftests/bpf: replace all uses of bpf_load_btf() with bpf_btf_load()tools/testing/selftests/bpf/map_tests/sk_storage_map.c tools/testing/selftests/bpf/prog_tests/btf.c tools/testing/selftests/bpf/test_verifier.c+32 -220 replies
10/12selftests/bpf: add test for libbpf's custom log_buf behaviortools/testing/selftests/bpf/prog_tests/log_buf.c tools/testing/selftests/bpf/progs/test_log_buf.c+300 -00 replies
11/12selftests/bpf: remove the only use of deprecated bpf_object__load_xattr()tools/testing/selftests/bpf/testing_helpers.c+5 -50 replies
12/12bpftool: switch bpf_object__load_xattr() to bpf_object__load()tools/bpf/bpftool/gen.c tools/bpf/bpftool/prog.c tools/bpf/bpftool/struct_ops.c+21 -290 replies

Reviews trailers per patch

No Reviewed-by, Acked-by or Tested-by trailers for v3 yet.

Read the v3 thread

Cover letter [PATCH v3 bpf-next 00/12] Enhance and rework logging controls in libbpf

Add new open options and per-program setters to control BTF and program loading log verboseness and allow providing custom log buffers to capture logs of interest. Note how custom log_buf and log_level are orthogonal, which matches previous (alas less customizable) behavior of libbpf, even though it sort of worked by accident: if someone specified log_level = 1 in bpf_object__load_xattr(), first attempt to load any BPF program resulted in wasted bpf() syscall with -EINVAL due to !!log_buf != !!log_level. Then on retry libbpf would allocated log_buffer and try again, after which prog loading would succeed and libbpf would print verbose program loading log through its print callback.

This behavior is now documented and made more efficient, not wasting unnecessary syscall. But additionally, log_level can be controlled globally on a per-bpf_object level through bpf_object_open_opts, as well as on a per-program basis with bpf_program__set_log_buf() and bpf_program__set_log_level() APIs.

Now that we have a more future-proof way to set log_level, deprecate bpf_object__load_xattr().

v2->v3:
- added log_buf selftests for bpf_prog_load() and bpf_btf_load();
- fix !log_buf in bpf_prog_load (John);
- fix log_level==0 in bpf_btf_load (thanks selftest!);

v1->v2:
- fix log_level == 0 handling of bpf_prog_load, add as patch #1 (Alexei);
- add comments explaining log_buf_size overflow prevention (Alexei).

Andrii Nakryiko (12):
libbpf: fix bpf_prog_load() log_buf logic for log_level 0
libbpf: add OPTS-based bpf_btf_load() API
libbpf: allow passing preallocated log_buf when loading BTF into
kernel
libbpf: allow passing user log setting through bpf_object_open_opts
libbpf: improve logging around BPF program loading
libbpf: preserve kernel error code and remove kprobe prog type
guessing
libbpf: add per-program log buffer setter and getter
libbpf: deprecate bpf_object__load_xattr()
selftests/bpf: replace all uses of bpf_load_btf() with bpf_btf_load() selftests/bpf: add test for libbpf's custom log_buf behavior selftests/bpf: remove the only use of deprecated
bpf_object__load_xattr()
bpftool: switch bpf_object__load_xattr() to bpf_object__load()

 tools/bpf/bpftool/gen.c                       |  11 +-
 tools/bpf/bpftool/prog.c                      |  24 +-
 tools/bpf/bpftool/struct_ops.c                |  15 +-
 tools/lib/bpf/bpf.c                           |  88 ++++--
 tools/lib/bpf/bpf.h                           |  22 +-
 tools/lib/bpf/btf.c                           |  78 +++--
 tools/lib/bpf/libbpf.c                        | 194 +++++++-----
 tools/lib/bpf/libbpf.h                        |  49 +++-
 tools/lib/bpf/libbpf.map                      |   3 +
 tools/lib/bpf/libbpf_internal.h               |   1 +
 tools/lib/bpf/libbpf_probes.c                 |   2 +-
 .../selftests/bpf/map_tests/sk_storage_map.c  |   2 +-
 .../selftests/bpf/prog_tests/bpf_tcp_ca.c     |   6 +-
 tools/testing/selftests/bpf/prog_tests/btf.c  |  50 ++--
 .../selftests/bpf/prog_tests/log_buf.c        | 276 ++++++++++++++++++
 .../selftests/bpf/progs/test_log_buf.c        |  24 ++
 tools/testing/selftests/bpf/test_verifier.c   |   2 +-
 tools/testing/selftests/bpf/testing_helpers.c |  10 +-
 18 files changed, 683 insertions(+), 174 deletions(-)
 create mode 100644 tools/testing/selftests/bpf/prog_tests/log_buf.c
 create mode 100644 tools/testing/selftests/bpf/progs/test_log_buf.c
Signature · 1 line
2.30.2