[bpf-next,v2,0/7] tools: bpftool: update, synchronise and validate types and options

Message

Quentin Monnet July 30, 2021, 9:54 p.m. UTC

To work with the different program types, map types, attach types etc.
supported by eBPF, bpftool needs occasional updates to learn about the new
features supported by the kernel. When such types translate into new
keyword for the command line, updates are expected in several locations:
typically, the help message displayed from bpftool itself, the manual page,
and the bash completion file should be updated. The options used by the
different commands for bpftool should also remain synchronised at those
locations.

Several omissions have occurred in the past, and a number of types are
still missing today. This set is an attempt to improve the situation. It
brings up-to-date the lists of types or options in bpftool, and also adds a
Python script to the BPF selftests to automatically check that most of
these lists remain synchronised.

v2:
- Reformat some lines in the bash completion file.
- Do not reformat attach types, to preserve git-blame history.
- Do not call Python script from tools/testing/selftests/bpf/Makefile.

Quentin Monnet (7):
  tools: bpftool: slightly ease bash completion updates
  selftests/bpf: check consistency between bpftool source, doc,
    completion
  tools: bpftool: complete and synchronise attach or map types
  tools: bpftool: update and synchronise option list in doc and help msg
  selftests/bpf: update bpftool's consistency script for checking
    options
  tools: bpftool: document and add bash completion for -L, -B options
  tools: bpftool: complete metrics list in "bpftool prog profile" doc

 .../bpf/bpftool/Documentation/bpftool-btf.rst |  48 +-
 .../bpftool/Documentation/bpftool-cgroup.rst  |   3 +-
 .../bpftool/Documentation/bpftool-feature.rst |   2 +-
 .../bpf/bpftool/Documentation/bpftool-gen.rst |   9 +-
 .../bpftool/Documentation/bpftool-iter.rst    |   2 +
 .../bpftool/Documentation/bpftool-link.rst    |   3 +-
 .../bpf/bpftool/Documentation/bpftool-map.rst |   3 +-
 .../bpf/bpftool/Documentation/bpftool-net.rst |   2 +-
 .../bpftool/Documentation/bpftool-perf.rst    |   2 +-
 .../bpftool/Documentation/bpftool-prog.rst    |  36 +-
 .../Documentation/bpftool-struct_ops.rst      |   2 +-
 tools/bpf/bpftool/Documentation/bpftool.rst   |  12 +-
 tools/bpf/bpftool/bash-completion/bpftool     |  66 +-
 tools/bpf/bpftool/btf.c                       |   3 +-
 tools/bpf/bpftool/cgroup.c                    |   3 +-
 tools/bpf/bpftool/common.c                    |   6 +
 tools/bpf/bpftool/feature.c                   |   1 +
 tools/bpf/bpftool/gen.c                       |   3 +-
 tools/bpf/bpftool/iter.c                      |   2 +
 tools/bpf/bpftool/link.c                      |   3 +-
 tools/bpf/bpftool/main.c                      |   3 +-
 tools/bpf/bpftool/main.h                      |   3 +-
 tools/bpf/bpftool/map.c                       |   5 +-
 tools/bpf/bpftool/net.c                       |   1 +
 tools/bpf/bpftool/perf.c                      |   5 +-
 tools/bpf/bpftool/prog.c                      |   8 +-
 tools/bpf/bpftool/struct_ops.c                |   2 +-
 .../selftests/bpf/test_bpftool_synctypes.py   | 586 ++++++++++++++++++
 28 files changed, 763 insertions(+), 61 deletions(-)
 create mode 100755 tools/testing/selftests/bpf/test_bpftool_synctypes.py

Comments

[e-mail] July 30, 2021, 10:50 p.m. UTC | #1

Hello:

This series was applied to bpf/bpf-next.git (refs/heads/master):

On Fri, 30 Jul 2021 22:54:28 +0100 you wrote:
> To work with the different program types, map types, attach types etc.
> supported by eBPF, bpftool needs occasional updates to learn about the new
> features supported by the kernel. When such types translate into new
> keyword for the command line, updates are expected in several locations:
> typically, the help message displayed from bpftool itself, the manual page,
> and the bash completion file should be updated. The options used by the
> different commands for bpftool should also remain synchronised at those
> locations.
> 
> [...]

Here is the summary with links:
  - [bpf-next,v2,1/7] tools: bpftool: slightly ease bash completion updates
    https://git.kernel.org/bpf/bpf-next/c/510b4d4c5d4c
  - [bpf-next,v2,2/7] selftests/bpf: check consistency between bpftool source, doc, completion
    https://git.kernel.org/bpf/bpf-next/c/a2b5944fb4e0
  - [bpf-next,v2,3/7] tools: bpftool: complete and synchronise attach or map types
    https://git.kernel.org/bpf/bpf-next/c/b544342e52fc
  - [bpf-next,v2,4/7] tools: bpftool: update and synchronise option list in doc and help msg
    https://git.kernel.org/bpf/bpf-next/c/c07ba629df97
  - [bpf-next,v2,5/7] selftests/bpf: update bpftool's consistency script for checking options
    https://git.kernel.org/bpf/bpf-next/c/da87772f086f
  - [bpf-next,v2,6/7] tools: bpftool: document and add bash completion for -L, -B options
    https://git.kernel.org/bpf/bpf-next/c/8cc8c6357c8f
  - [bpf-next,v2,7/7] tools: bpftool: complete metrics list in "bpftool prog profile" doc
    https://git.kernel.org/bpf/bpf-next/c/475a23c2c15f

You are awesome, thank you!
--
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html