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

   1 ================
   2 bpftool-prog
   3 ================
   4 -------------------------------------------------------------------------------
   5 tool for inspection and simple manipulation of eBPF progs
   6 -------------------------------------------------------------------------------
   7
   8 :Manual section: 8
   9
  10 SYNOPSIS
  11 ========
  12
  13         **bpftool** [*OPTIONS*] **prog** *COMMAND*
  14
  15         *OPTIONS* := { { **-j** | **--json** } [{ **-p** | **--pretty** }] | { **-f** | **--bpffs** } }
  16
  17         *COMMANDS* :=
  18         { **show** | **list** | **dump xlated** | **dump jited** | **pin** | **load**
  19         | **loadall** | **help** }
  20
  21 PROG COMMANDS
  22 =============
  23
  24 |       **bpftool** **prog { show | list }** [*PROG*]
  25 |       **bpftool** **prog dump xlated** *PROG* [{**file** *FILE* | **opcodes** | **visual** | **linum**}]
  26 |       **bpftool** **prog dump jited**  *PROG* [{**file** *FILE* | **opcodes** | **linum**}]
  27 |       **bpftool** **prog pin** *PROG* *FILE*
  28 |       **bpftool** **prog { load | loadall }** *OBJ* *PATH* [**type** *TYPE*] [**map** {**idx** *IDX* | **name** *NAME*} *MAP*] [**dev** *NAME*] [**pinmaps** *MAP_DIR*]
  29 |       **bpftool** **prog attach** *PROG* *ATTACH_TYPE* [*MAP*]
  30 |       **bpftool** **prog detach** *PROG* *ATTACH_TYPE* [*MAP*]
  31 |       **bpftool** **prog tracelog**
  32 |       **bpftool** **prog help**
  33 |
  34 |       *MAP* := { **id** *MAP_ID* | **pinned** *FILE* }
  35 |       *PROG* := { **id** *PROG_ID* | **pinned** *FILE* | **tag** *PROG_TAG* }
  36 |       *TYPE* := {
  37 |               **socket** | **kprobe** | **kretprobe** | **classifier** | **action** |
  38 |               **tracepoint** | **raw_tracepoint** | **xdp** | **perf_event** | **cgroup/skb** |
  39 |               **cgroup/sock** | **cgroup/dev** | **lwt_in** | **lwt_out** | **lwt_xmit** |
  40 |               **lwt_seg6local** | **sockops** | **sk_skb** | **sk_msg** | **lirc_mode2** |
  41 |               **cgroup/bind4** | **cgroup/bind6** | **cgroup/post_bind4** | **cgroup/post_bind6** |
  42 |               **cgroup/connect4** | **cgroup/connect6** | **cgroup/sendmsg4** | **cgroup/sendmsg6**
  43 |       }
  44 |       *ATTACH_TYPE* := {
  45 |               **msg_verdict** | **stream_verdict** | **stream_parser** | **flow_dissector**
  46 |       }
  47
  48
  49 DESCRIPTION
  50 ===========
  51         **bpftool prog { show | list }** [*PROG*]
  52                   Show information about loaded programs.  If *PROG* is
  53                   specified show information only about given program, otherwise
  54                   list all programs currently loaded on the system.
  55
  56                   Output will start with program ID followed by program type and
  57                   zero or more named attributes (depending on kernel version).
  58
  59                   Since Linux 5.1 the kernel can collect statistics on BPF
  60                   programs (such as the total time spent running the program,
  61                   and the number of times it was run). If available, bpftool
  62                   shows such statistics. However, the kernel does not collect
  63                   them by defaults, as it slightly impacts performance on each
  64                   program run. Activation or deactivation of the feature is
  65                   performed via the **kernel.bpf_stats_enabled** sysctl knob.
  66
  67         **bpftool prog dump xlated** *PROG* [{ **file** *FILE* | **opcodes** | **visual** | **linum** }]
  68                   Dump eBPF instructions of the program from the kernel. By
  69                   default, eBPF will be disassembled and printed to standard
  70                   output in human-readable format. In this case, **opcodes**
  71                   controls if raw opcodes should be printed as well.
  72
  73                   If **file** is specified, the binary image will instead be
  74                   written to *FILE*.
  75
  76                   If **visual** is specified, control flow graph (CFG) will be
  77                   built instead, and eBPF instructions will be presented with
  78                   CFG in DOT format, on standard output.
  79
  80                   If the prog has line_info available, the source line will
  81                   be displayed by default.  If **linum** is specified,
  82                   the filename, line number and line column will also be
  83                   displayed on top of the source line.
  84
  85         **bpftool prog dump jited**  *PROG* [{ **file** *FILE* | **opcodes** | **linum** }]
  86                   Dump jited image (host machine code) of the program.
  87                   If *FILE* is specified image will be written to a file,
  88                   otherwise it will be disassembled and printed to stdout.
  89
  90                   **opcodes** controls if raw opcodes will be printed.
  91
  92                   If the prog has line_info available, the source line will
  93                   be displayed by default.  If **linum** is specified,
  94                   the filename, line number and line column will also be
  95                   displayed on top of the source line.
  96
  97         **bpftool prog pin** *PROG* *FILE*
  98                   Pin program *PROG* as *FILE*.
  99
 100                   Note: *FILE* must be located in *bpffs* mount. It must not
 101                   contain a dot character ('.'), which is reserved for future
 102                   extensions of *bpffs*.
 103
 104         **bpftool prog { load | loadall }** *OBJ* *PATH* [**type** *TYPE*] [**map** {**idx** *IDX* | **name** *NAME*} *MAP*] [**dev** *NAME*] [**pinmaps** *MAP_DIR*]
 105                   Load bpf program(s) from binary *OBJ* and pin as *PATH*.
 106                   **bpftool prog load** pins only the first program from the
 107                   *OBJ* as *PATH*. **bpftool prog loadall** pins all programs
 108                   from the *OBJ* under *PATH* directory.
 109                   **type** is optional, if not specified program type will be
 110                   inferred from section names.
 111                   By default bpftool will create new maps as declared in the ELF
 112                   object being loaded.  **map** parameter allows for the reuse
 113                   of existing maps.  It can be specified multiple times, each
 114                   time for a different map.  *IDX* refers to index of the map
 115                   to be replaced in the ELF file counting from 0, while *NAME*
 116                   allows to replace a map by name.  *MAP* specifies the map to
 117                   use, referring to it by **id** or through a **pinned** file.
 118                   If **dev** *NAME* is specified program will be loaded onto
 119                   given networking device (offload).
 120                   Optional **pinmaps** argument can be provided to pin all
 121                   maps under *MAP_DIR* directory.
 122
 123                   Note: *PATH* must be located in *bpffs* mount. It must not
 124                   contain a dot character ('.'), which is reserved for future
 125                   extensions of *bpffs*.
 126
 127         **bpftool prog attach** *PROG* *ATTACH_TYPE* [*MAP*]
 128                   Attach bpf program *PROG* (with type specified by
 129                   *ATTACH_TYPE*). Most *ATTACH_TYPEs* require a *MAP*
 130                   parameter, with the exception of *flow_dissector* which is
 131                   attached to current networking name space.
 132
 133         **bpftool prog detach** *PROG* *ATTACH_TYPE* [*MAP*]
 134                   Detach bpf program *PROG* (with type specified by
 135                   *ATTACH_TYPE*). Most *ATTACH_TYPEs* require a *MAP*
 136                   parameter, with the exception of *flow_dissector* which is
 137                   detached from the current networking name space.
 138
 139         **bpftool prog tracelog**
 140                   Dump the trace pipe of the system to the console (stdout).
 141                   Hit <Ctrl+C> to stop printing. BPF programs can write to this
 142                   trace pipe at runtime with the **bpf_trace_printk()** helper.
 143                   This should be used only for debugging purposes. For
 144                   streaming data from BPF programs to user space, one can use
 145                   perf events (see also **bpftool-map**\ (8)).
 146
 147         **bpftool prog help**
 148                   Print short help message.
 149
 150 OPTIONS
 151 =======
 152         -h, --help
 153                   Print short generic help message (similar to **bpftool help**).
 154
 155         -V, --version
 156                   Print version number (similar to **bpftool version**).
 157
 158         -j, --json
 159                   Generate JSON output. For commands that cannot produce JSON, this
 160                   option has no effect.
 161
 162         -p, --pretty
 163                   Generate human-readable JSON output. Implies **-j**.
 164
 165         -f, --bpffs
 166                   When showing BPF programs, show file names of pinned
 167                   programs.
 168
 169         -m, --mapcompat
 170                   Allow loading maps with unknown map definitions.
 171
 172         -n, --nomount
 173                   Do not automatically attempt to mount any virtual file system
 174                   (such as tracefs or BPF virtual file system) when necessary.
 175
 176 EXAMPLES
 177 ========
 178 **# bpftool prog show**
 179
 180 ::
 181
 182     10: xdp  name some_prog  tag 005a3d2123620c8b  gpl run_time_ns 81632 run_cnt 10
 183             loaded_at 2017-09-29T20:11:00+0000  uid 0
 184             xlated 528B  jited 370B  memlock 4096B  map_ids 10
 185
 186 **# bpftool --json --pretty prog show**
 187
 188 ::
 189
 190     [{
 191             "id": 10,
 192             "type": "xdp",
 193             "tag": "005a3d2123620c8b",
 194             "gpl_compatible": true,
 195             "run_time_ns": 81632,
 196             "run_cnt": 10,
 197             "loaded_at": 1506715860,
 198             "uid": 0,
 199             "bytes_xlated": 528,
 200             "jited": true,
 201             "bytes_jited": 370,
 202             "bytes_memlock": 4096,
 203             "map_ids": [10
 204             ]
 205         }
 206     ]
 207
 208 |
 209 | **# bpftool prog dump xlated id 10 file /tmp/t**
 210 | **# ls -l /tmp/t**
 211
 212 ::
 213
 214     -rw------- 1 root root 560 Jul 22 01:42 /tmp/t
 215
 216 **# bpftool prog dump jited tag 005a3d2123620c8b**
 217
 218 ::
 219
 220     0:   push   %rbp
 221     1:   mov    %rsp,%rbp
 222     2:   sub    $0x228,%rsp
 223     3:   sub    $0x28,%rbp
 224     4:   mov    %rbx,0x0(%rbp)
 225
 226 |
 227 | **# mount -t bpf none /sys/fs/bpf/**
 228 | **# bpftool prog pin id 10 /sys/fs/bpf/prog**
 229 | **# bpftool prog load ./my_prog.o /sys/fs/bpf/prog2**
 230 | **# ls -l /sys/fs/bpf/**
 231
 232 ::
 233
 234     -rw------- 1 root root 0 Jul 22 01:43 prog
 235     -rw------- 1 root root 0 Jul 22 01:44 prog2
 236
 237 **# bpftool prog dump jited pinned /sys/fs/bpf/prog opcodes**
 238
 239 ::
 240
 241    0:   push   %rbp
 242         55
 243    1:   mov    %rsp,%rbp
 244         48 89 e5
 245    4:   sub    $0x228,%rsp
 246         48 81 ec 28 02 00 00
 247    b:   sub    $0x28,%rbp
 248         48 83 ed 28
 249    f:   mov    %rbx,0x0(%rbp)
 250         48 89 5d 00
 251
 252 |
 253 | **# bpftool prog load xdp1_kern.o /sys/fs/bpf/xdp1 type xdp map name rxcnt id 7**
 254 | **# bpftool prog show pinned /sys/fs/bpf/xdp1**
 255
 256 ::
 257
 258     9: xdp  name xdp_prog1  tag 539ec6ce11b52f98  gpl
 259             loaded_at 2018-06-25T16:17:31-0700  uid 0
 260             xlated 488B  jited 336B  memlock 4096B  map_ids 7
 261
 262 **# rm /sys/fs/bpf/xdp1**
 263
 264 SEE ALSO
 265 ========
 266         **bpf**\ (2),
 267         **bpf-helpers**\ (7),
 268         **bpftool**\ (8),
 269         **bpftool-map**\ (8),
 270         **bpftool-cgroup**\ (8),
 271         **bpftool-feature**\ (8),
 272         **bpftool-net**\ (8),
 273         **bpftool-perf**\ (8)