mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git
synced 2024-10-31 00:17:44 +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
69 lines
2 KiB
ReStructuredText
69 lines
2 KiB
ReStructuredText
.. SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
|
|
|
|
================
|
|
bpftool-perf
|
|
================
|
|
-------------------------------------------------------------------------------
|
|
tool for inspection of perf related bpf prog attachments
|
|
-------------------------------------------------------------------------------
|
|
|
|
:Manual section: 8
|
|
|
|
.. include:: substitutions.rst
|
|
|
|
SYNOPSIS
|
|
========
|
|
|
|
**bpftool** [*OPTIONS*] **perf** *COMMAND*
|
|
|
|
*OPTIONS* := { |COMMON_OPTIONS| }
|
|
|
|
*COMMANDS* :=
|
|
{ **show** | **list** | **help** }
|
|
|
|
PERF COMMANDS
|
|
=============
|
|
|
|
| **bpftool** **perf** { **show** | **list** }
|
|
| **bpftool** **perf help**
|
|
|
|
DESCRIPTION
|
|
===========
|
|
**bpftool perf { show | list }**
|
|
List all raw_tracepoint, tracepoint, kprobe attachment in the system.
|
|
|
|
Output will start with process id and file descriptor in that process,
|
|
followed by bpf program id, attachment information, and attachment point.
|
|
The attachment point for raw_tracepoint/tracepoint is the trace probe name.
|
|
The attachment point for k[ret]probe is either symbol name and offset,
|
|
or a kernel virtual address.
|
|
The attachment point for u[ret]probe is the file name and the file offset.
|
|
|
|
**bpftool perf help**
|
|
Print short help message.
|
|
|
|
OPTIONS
|
|
=======
|
|
.. include:: common_options.rst
|
|
|
|
EXAMPLES
|
|
========
|
|
|
|
| **# bpftool perf**
|
|
|
|
::
|
|
|
|
pid 21711 fd 5: prog_id 5 kprobe func __x64_sys_write offset 0
|
|
pid 21765 fd 5: prog_id 7 kretprobe func __x64_sys_nanosleep offset 0
|
|
pid 21767 fd 5: prog_id 8 tracepoint sys_enter_nanosleep
|
|
pid 21800 fd 5: prog_id 9 uprobe filename /home/yhs/a.out offset 1159
|
|
|
|
|
|
|
| **# bpftool -j perf**
|
|
|
|
::
|
|
|
|
[{"pid":21711,"fd":5,"prog_id":5,"fd_type":"kprobe","func":"__x64_sys_write","offset":0}, \
|
|
{"pid":21765,"fd":5,"prog_id":7,"fd_type":"kretprobe","func":"__x64_sys_nanosleep","offset":0}, \
|
|
{"pid":21767,"fd":5,"prog_id":8,"fd_type":"tracepoint","tracepoint":"sys_enter_nanosleep"}, \
|
|
{"pid":21800,"fd":5,"prog_id":9,"fd_type":"uprobe","filename":"/home/yhs/a.out","offset":1159}]
|