tools/bpf/bpftool/Documentation/bpftool-net.rst

   1 ================
   2 bpftool-net
   3 ================
   4 -------------------------------------------------------------------------------
   5 tool for inspection of netdev/tc related bpf prog attachments
   6 -------------------------------------------------------------------------------
   7
   8 :Manual section: 8
   9
  10 SYNOPSIS
  11 ========
  12
  13         **bpftool** [*OPTIONS*] **net** *COMMAND*
  14
  15         *OPTIONS* := { [{ **-j** | **--json** }] [{ **-p** | **--pretty** }] }
  16
  17         *COMMANDS* :=
  18         { **show** | **list** | **attach** | **detach** | **help** }
  19
  20 NET COMMANDS
  21 ============
  22
  23 |       **bpftool** **net** { **show** | **list** } [ **dev** *NAME* ]
  24 |       **bpftool** **net attach** *ATTACH_TYPE* *PROG* **dev** *NAME* [ **overwrite** ]
  25 |       **bpftool** **net detach** *ATTACH_TYPE* **dev** *NAME*
  26 |       **bpftool** **net help**
  27 |
  28 |       *PROG* := { **id** *PROG_ID* | **pinned** *FILE* | **tag** *PROG_TAG* }
  29 |       *ATTACH_TYPE* := { **xdp** | **xdpgeneric** | **xdpdrv** | **xdpoffload** }
  30
  31 DESCRIPTION
  32 ===========
  33         **bpftool net { show | list }** [ **dev** *NAME* ]
  34                   List bpf program attachments in the kernel networking subsystem.
  35
  36                   Currently, only device driver xdp attachments and tc filter
  37                   classification/action attachments are implemented, i.e., for
  38                   program types **BPF_PROG_TYPE_SCHED_CLS**,
  39                   **BPF_PROG_TYPE_SCHED_ACT** and **BPF_PROG_TYPE_XDP**.
  40                   For programs attached to a particular cgroup, e.g.,
  41                   **BPF_PROG_TYPE_CGROUP_SKB**, **BPF_PROG_TYPE_CGROUP_SOCK**,
  42                   **BPF_PROG_TYPE_SOCK_OPS** and **BPF_PROG_TYPE_CGROUP_SOCK_ADDR**,
  43                   users can use **bpftool cgroup** to dump cgroup attachments.
  44                   For sk_{filter, skb, msg, reuseport} and lwt/seg6
  45                   bpf programs, users should consult other tools, e.g., iproute2.
  46
  47                   The current output will start with all xdp program attachments, followed by
  48                   all tc class/qdisc bpf program attachments. Both xdp programs and
  49                   tc programs are ordered based on ifindex number. If multiple bpf
  50                   programs attached to the same networking device through **tc filter**,
  51                   the order will be first all bpf programs attached to tc classes, then
  52                   all bpf programs attached to non clsact qdiscs, and finally all
  53                   bpf programs attached to root and clsact qdisc.
  54
  55         **bpftool** **net attach** *ATTACH_TYPE* *PROG* **dev** *NAME* [ **overwrite** ]
  56                   Attach bpf program *PROG* to network interface *NAME* with
  57                   type specified by *ATTACH_TYPE*. Previously attached bpf program
  58                   can be replaced by the command used with **overwrite** option.
  59                   Currently, only XDP-related modes are supported for *ATTACH_TYPE*.
  60
  61                   *ATTACH_TYPE* can be of:
  62                   **xdp** - try native XDP and fallback to generic XDP if NIC driver does not support it;
  63                   **xdpgeneric** - Generic XDP. runs at generic XDP hook when packet already enters receive path as skb;
  64                   **xdpdrv** - Native XDP. runs earliest point in driver's receive path;
  65                   **xdpoffload** - Offload XDP. runs directly on NIC on each packet reception;
  66
  67         **bpftool** **net detach** *ATTACH_TYPE* **dev** *NAME*
  68                   Detach bpf program attached to network interface *NAME* with
  69                   type specified by *ATTACH_TYPE*. To detach bpf program, same
  70                   *ATTACH_TYPE* previously used for attach must be specified.
  71                   Currently, only XDP-related modes are supported for *ATTACH_TYPE*.
  72
  73         **bpftool net help**
  74                   Print short help message.
  75
  76 OPTIONS
  77 =======
  78         .. include:: common_options.rst
  79
  80 EXAMPLES
  81 ========
  82
  83 | **# bpftool net**
  84
  85 ::
  86
  87       xdp:
  88       eth0(2) driver id 198
  89
  90       tc:
  91       eth0(2) htb name prefix_matcher.o:[cls_prefix_matcher_htb] id 111727 act []
  92       eth0(2) clsact/ingress fbflow_icmp id 130246 act []
  93       eth0(2) clsact/egress prefix_matcher.o:[cls_prefix_matcher_clsact] id 111726
  94       eth0(2) clsact/egress cls_fg_dscp id 108619 act []
  95       eth0(2) clsact/egress fbflow_egress id 130245
  96
  97 |
  98 | **# bpftool -jp net**
  99
 100 ::
 101
 102     [{
 103             "xdp": [{
 104                     "devname": "eth0",
 105                     "ifindex": 2,
 106                     "mode": "driver",
 107                     "id": 198
 108                 }
 109             ],
 110             "tc": [{
 111                     "devname": "eth0",
 112                     "ifindex": 2,
 113                     "kind": "htb",
 114                     "name": "prefix_matcher.o:[cls_prefix_matcher_htb]",
 115                     "id": 111727,
 116                     "act": []
 117                 },{
 118                     "devname": "eth0",
 119                     "ifindex": 2,
 120                     "kind": "clsact/ingress",
 121                     "name": "fbflow_icmp",
 122                     "id": 130246,
 123                     "act": []
 124                 },{
 125                     "devname": "eth0",
 126                     "ifindex": 2,
 127                     "kind": "clsact/egress",
 128                     "name": "prefix_matcher.o:[cls_prefix_matcher_clsact]",
 129                     "id": 111726,
 130                 },{
 131                     "devname": "eth0",
 132                     "ifindex": 2,
 133                     "kind": "clsact/egress",
 134                     "name": "cls_fg_dscp",
 135                     "id": 108619,
 136                     "act": []
 137                 },{
 138                     "devname": "eth0",
 139                     "ifindex": 2,
 140                     "kind": "clsact/egress",
 141                     "name": "fbflow_egress",
 142                     "id": 130245,
 143                 }
 144             ]
 145         }
 146     ]
 147
 148 |
 149 | **# bpftool net attach xdpdrv id 16 dev enp6s0np0**
 150 | **# bpftool net**
 151
 152 ::
 153
 154       xdp:
 155       enp6s0np0(4) driver id 16
 156
 157 |
 158 | **# bpftool net attach xdpdrv id 16 dev enp6s0np0**
 159 | **# bpftool net attach xdpdrv id 20 dev enp6s0np0 overwrite**
 160 | **# bpftool net**
 161
 162 ::
 163
 164       xdp:
 165       enp6s0np0(4) driver id 20
 166
 167 |
 168 | **# bpftool net attach xdpdrv id 16 dev enp6s0np0**
 169 | **# bpftool net detach xdpdrv dev enp6s0np0**
 170 | **# bpftool net**
 171
 172 ::
 173
 174       xdp: