c07ba629df
All bpftool commands support the options for JSON output and debug from libbpf. In addition, some commands support additional options corresponding to specific use cases. The list of options described in the man pages for the different commands are not always accurate. The messages for interactive help are mostly limited to HELP_SPEC_OPTIONS, and are even less representative of the actual set of options supported for the commands. Let's update the lists: - HELP_SPEC_OPTIONS is modified to contain the "default" options (JSON and debug), and to be extensible (no ending curly bracket). - All commands use HELP_SPEC_OPTIONS in their help message, and then complete the list with their specific options. - The lists of options in the man pages are updated. - The formatting of the list for bpftool.rst is adjusted to match formatting for the other man pages. This is for consistency, and also because it will be helpful in a future patch to automatically check that the files are synchronised. Signed-off-by: Quentin Monnet <quentin@isovalent.com> Signed-off-by: Andrii Nakryiko <andrii@kernel.org> Link: https://lore.kernel.org/bpf/20210730215435.7095-5-quentin@isovalent.com
85 lines
2.4 KiB
ReStructuredText
85 lines
2.4 KiB
ReStructuredText
==================
|
|
bpftool-struct_ops
|
|
==================
|
|
-------------------------------------------------------------------------------
|
|
tool to register/unregister/introspect BPF struct_ops
|
|
-------------------------------------------------------------------------------
|
|
|
|
:Manual section: 8
|
|
|
|
SYNOPSIS
|
|
========
|
|
|
|
**bpftool** [*OPTIONS*] **struct_ops** *COMMAND*
|
|
|
|
*OPTIONS* := { { **-j** | **--json** } [{ **-p** | **--pretty** }] | { **-d** | **--debug** } }
|
|
|
|
*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
|