mirror of
https://mirrors.bfsu.edu.cn/git/linux.git
synced 2024-12-15 23:14:31 +08: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
179 lines
5.6 KiB
ReStructuredText
179 lines
5.6 KiB
ReStructuredText
.. SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
|
|
|
|
================
|
|
bpftool-net
|
|
================
|
|
-------------------------------------------------------------------------------
|
|
tool for inspection of netdev/tc related bpf prog attachments
|
|
-------------------------------------------------------------------------------
|
|
|
|
:Manual section: 8
|
|
|
|
.. include:: substitutions.rst
|
|
|
|
SYNOPSIS
|
|
========
|
|
|
|
**bpftool** [*OPTIONS*] **net** *COMMAND*
|
|
|
|
*OPTIONS* := { |COMMON_OPTIONS| }
|
|
|
|
*COMMANDS* :=
|
|
{ **show** | **list** | **attach** | **detach** | **help** }
|
|
|
|
NET COMMANDS
|
|
============
|
|
|
|
| **bpftool** **net** { **show** | **list** } [ **dev** *NAME* ]
|
|
| **bpftool** **net attach** *ATTACH_TYPE* *PROG* **dev** *NAME* [ **overwrite** ]
|
|
| **bpftool** **net detach** *ATTACH_TYPE* **dev** *NAME*
|
|
| **bpftool** **net help**
|
|
|
|
|
| *PROG* := { **id** *PROG_ID* | **pinned** *FILE* | **tag** *PROG_TAG* }
|
|
| *ATTACH_TYPE* := { **xdp** | **xdpgeneric** | **xdpdrv** | **xdpoffload** }
|
|
|
|
DESCRIPTION
|
|
===========
|
|
**bpftool net { show | list }** [ **dev** *NAME* ]
|
|
List bpf program attachments in the kernel networking subsystem.
|
|
|
|
Currently, only device driver xdp attachments and tc filter
|
|
classification/action attachments are implemented, i.e., for
|
|
program types **BPF_PROG_TYPE_SCHED_CLS**,
|
|
**BPF_PROG_TYPE_SCHED_ACT** and **BPF_PROG_TYPE_XDP**.
|
|
For programs attached to a particular cgroup, e.g.,
|
|
**BPF_PROG_TYPE_CGROUP_SKB**, **BPF_PROG_TYPE_CGROUP_SOCK**,
|
|
**BPF_PROG_TYPE_SOCK_OPS** and **BPF_PROG_TYPE_CGROUP_SOCK_ADDR**,
|
|
users can use **bpftool cgroup** to dump cgroup attachments.
|
|
For sk_{filter, skb, msg, reuseport} and lwt/seg6
|
|
bpf programs, users should consult other tools, e.g., iproute2.
|
|
|
|
The current output will start with all xdp program attachments, followed by
|
|
all tc class/qdisc bpf program attachments. Both xdp programs and
|
|
tc programs are ordered based on ifindex number. If multiple bpf
|
|
programs attached to the same networking device through **tc filter**,
|
|
the order will be first all bpf programs attached to tc classes, then
|
|
all bpf programs attached to non clsact qdiscs, and finally all
|
|
bpf programs attached to root and clsact qdisc.
|
|
|
|
**bpftool** **net attach** *ATTACH_TYPE* *PROG* **dev** *NAME* [ **overwrite** ]
|
|
Attach bpf program *PROG* to network interface *NAME* with
|
|
type specified by *ATTACH_TYPE*. Previously attached bpf program
|
|
can be replaced by the command used with **overwrite** option.
|
|
Currently, only XDP-related modes are supported for *ATTACH_TYPE*.
|
|
|
|
*ATTACH_TYPE* can be of:
|
|
**xdp** - try native XDP and fallback to generic XDP if NIC driver does not support it;
|
|
**xdpgeneric** - Generic XDP. runs at generic XDP hook when packet already enters receive path as skb;
|
|
**xdpdrv** - Native XDP. runs earliest point in driver's receive path;
|
|
**xdpoffload** - Offload XDP. runs directly on NIC on each packet reception;
|
|
|
|
**bpftool** **net detach** *ATTACH_TYPE* **dev** *NAME*
|
|
Detach bpf program attached to network interface *NAME* with
|
|
type specified by *ATTACH_TYPE*. To detach bpf program, same
|
|
*ATTACH_TYPE* previously used for attach must be specified.
|
|
Currently, only XDP-related modes are supported for *ATTACH_TYPE*.
|
|
|
|
**bpftool net help**
|
|
Print short help message.
|
|
|
|
OPTIONS
|
|
=======
|
|
.. include:: common_options.rst
|
|
|
|
EXAMPLES
|
|
========
|
|
|
|
| **# bpftool net**
|
|
|
|
::
|
|
|
|
xdp:
|
|
eth0(2) driver id 198
|
|
|
|
tc:
|
|
eth0(2) htb name prefix_matcher.o:[cls_prefix_matcher_htb] id 111727 act []
|
|
eth0(2) clsact/ingress fbflow_icmp id 130246 act []
|
|
eth0(2) clsact/egress prefix_matcher.o:[cls_prefix_matcher_clsact] id 111726
|
|
eth0(2) clsact/egress cls_fg_dscp id 108619 act []
|
|
eth0(2) clsact/egress fbflow_egress id 130245
|
|
|
|
|
|
|
| **# bpftool -jp net**
|
|
|
|
::
|
|
|
|
[{
|
|
"xdp": [{
|
|
"devname": "eth0",
|
|
"ifindex": 2,
|
|
"mode": "driver",
|
|
"id": 198
|
|
}
|
|
],
|
|
"tc": [{
|
|
"devname": "eth0",
|
|
"ifindex": 2,
|
|
"kind": "htb",
|
|
"name": "prefix_matcher.o:[cls_prefix_matcher_htb]",
|
|
"id": 111727,
|
|
"act": []
|
|
},{
|
|
"devname": "eth0",
|
|
"ifindex": 2,
|
|
"kind": "clsact/ingress",
|
|
"name": "fbflow_icmp",
|
|
"id": 130246,
|
|
"act": []
|
|
},{
|
|
"devname": "eth0",
|
|
"ifindex": 2,
|
|
"kind": "clsact/egress",
|
|
"name": "prefix_matcher.o:[cls_prefix_matcher_clsact]",
|
|
"id": 111726,
|
|
},{
|
|
"devname": "eth0",
|
|
"ifindex": 2,
|
|
"kind": "clsact/egress",
|
|
"name": "cls_fg_dscp",
|
|
"id": 108619,
|
|
"act": []
|
|
},{
|
|
"devname": "eth0",
|
|
"ifindex": 2,
|
|
"kind": "clsact/egress",
|
|
"name": "fbflow_egress",
|
|
"id": 130245,
|
|
}
|
|
]
|
|
}
|
|
]
|
|
|
|
|
|
|
| **# bpftool net attach xdpdrv id 16 dev enp6s0np0**
|
|
| **# bpftool net**
|
|
|
|
::
|
|
|
|
xdp:
|
|
enp6s0np0(4) driver id 16
|
|
|
|
|
|
|
| **# bpftool net attach xdpdrv id 16 dev enp6s0np0**
|
|
| **# bpftool net attach xdpdrv id 20 dev enp6s0np0 overwrite**
|
|
| **# bpftool net**
|
|
|
|
::
|
|
|
|
xdp:
|
|
enp6s0np0(4) driver id 20
|
|
|
|
|
|
|
| **# bpftool net attach xdpdrv id 16 dev enp6s0np0**
|
|
| **# bpftool net detach xdpdrv dev enp6s0np0**
|
|
| **# bpftool net**
|
|
|
|
::
|
|
|
|
xdp:
|