mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git
synced 2024-10-02 07:04:24 +00:00
b623181520
test_bpftool_synctypes.py helps detecting inconsistencies in bpftool
between the different list of types and options scattered in the
sources, the documentation, and the bash completion. For options that
apply to all bpftool commands, the script had a hardcoded list of
values, and would use them to check whether the man pages are
up-to-date. When writing the script, it felt acceptable to have this
list in order to avoid to open and parse bpftool's main.h every time,
and because the list of global options in bpftool doesn't change so
often.
However, this is prone to omissions, and we recently added a new
-l|--legacy option which was described in common_options.rst, but not
listed in the options summary of each manual page. The script did not
complain, because it keeps comparing the hardcoded list to the (now)
outdated list in the header file.
To address the issue, this commit brings the following changes:
- Options that are common to all bpftool commands (--json, --pretty, and
--debug) are moved to a dedicated file, and used in the definition of
a RST substitution. This substitution is used in the sources of all
the man pages.
- This list of common options is updated, with the addition of the new
-l|--legacy option.
- The script test_bpftool_synctypes.py is updated to compare:
- Options specific to a command, found in C files, for the
interactive help messages, with the same specific options from the
relevant man page for that command.
- Common options, checked just once: the list in main.h is
compared with the new list in substitutions.rst.
Signed-off-by: Quentin Monnet <quentin@isovalent.com>
Signed-off-by: Daniel Borkmann <daniel@iogearbox.net>
Link: https://lore.kernel.org/bpf/20211115225844.33943-3-quentin@isovalent.com
88 lines
2.4 KiB
ReStructuredText
88 lines
2.4 KiB
ReStructuredText
.. SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
|
|
|
|
==================
|
|
bpftool-struct_ops
|
|
==================
|
|
-------------------------------------------------------------------------------
|
|
tool to register/unregister/introspect BPF struct_ops
|
|
-------------------------------------------------------------------------------
|
|
|
|
:Manual section: 8
|
|
|
|
.. include:: substitutions.rst
|
|
|
|
SYNOPSIS
|
|
========
|
|
|
|
**bpftool** [*OPTIONS*] **struct_ops** *COMMAND*
|
|
|
|
*OPTIONS* := { |COMMON_OPTIONS| }
|
|
|
|
*COMMANDS* :=
|
|
{ **show** | **list** | **dump** | **register** | **unregister** | **help** }
|
|
|
|
STRUCT_OPS COMMANDS
|
|
===================
|
|
|
|
| **bpftool** **struct_ops { show | list }** [*STRUCT_OPS_MAP*]
|
|
| **bpftool** **struct_ops dump** [*STRUCT_OPS_MAP*]
|
|
| **bpftool** **struct_ops register** *OBJ*
|
|
| **bpftool** **struct_ops unregister** *STRUCT_OPS_MAP*
|
|
| **bpftool** **struct_ops help**
|
|
|
|
|
| *STRUCT_OPS_MAP* := { **id** *STRUCT_OPS_MAP_ID* | **name** *STRUCT_OPS_MAP_NAME* }
|
|
| *OBJ* := /a/file/of/bpf_struct_ops.o
|
|
|
|
|
|
DESCRIPTION
|
|
===========
|
|
**bpftool struct_ops { show | list }** [*STRUCT_OPS_MAP*]
|
|
Show brief information about the struct_ops in the system.
|
|
If *STRUCT_OPS_MAP* is specified, it shows information only
|
|
for the given struct_ops. Otherwise, it lists all struct_ops
|
|
currently existing in the system.
|
|
|
|
Output will start with struct_ops map ID, followed by its map
|
|
name and its struct_ops's kernel type.
|
|
|
|
**bpftool struct_ops dump** [*STRUCT_OPS_MAP*]
|
|
Dump details information about the struct_ops in the system.
|
|
If *STRUCT_OPS_MAP* is specified, it dumps information only
|
|
for the given struct_ops. Otherwise, it dumps all struct_ops
|
|
currently existing in the system.
|
|
|
|
**bpftool struct_ops register** *OBJ*
|
|
Register bpf struct_ops from *OBJ*. All struct_ops under
|
|
the ELF section ".struct_ops" will be registered to
|
|
its kernel subsystem.
|
|
|
|
**bpftool struct_ops unregister** *STRUCT_OPS_MAP*
|
|
Unregister the *STRUCT_OPS_MAP* from the kernel subsystem.
|
|
|
|
**bpftool struct_ops help**
|
|
Print short help message.
|
|
|
|
OPTIONS
|
|
=======
|
|
.. include:: common_options.rst
|
|
|
|
EXAMPLES
|
|
========
|
|
**# bpftool struct_ops show**
|
|
|
|
::
|
|
|
|
100: dctcp tcp_congestion_ops
|
|
105: cubic tcp_congestion_ops
|
|
|
|
**# bpftool struct_ops unregister id 105**
|
|
|
|
::
|
|
|
|
Unregistered tcp_congestion_ops cubic id 105
|
|
|
|
**# bpftool struct_ops register bpf_cubic.o**
|
|
|
|
::
|
|
|
|
Registered tcp_congestion_ops cubic id 110
|