^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 1) ================
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 2) bpftool-prog
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 3) ================
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 4) -------------------------------------------------------------------------------
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 5) tool for inspection and simple manipulation of eBPF progs
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 6) -------------------------------------------------------------------------------
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 7)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 8) :Manual section: 8
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 9)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 10) SYNOPSIS
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 11) ========
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 12)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 13) **bpftool** [*OPTIONS*] **prog** *COMMAND*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 14)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 15) *OPTIONS* := { { **-j** | **--json** } [{ **-p** | **--pretty** }] | { **-f** | **--bpffs** } }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 16)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 17) *COMMANDS* :=
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 18) { **show** | **list** | **dump xlated** | **dump jited** | **pin** | **load**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 19) | **loadall** | **help** }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 20)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 21) PROG COMMANDS
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 22) =============
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 23)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 24) | **bpftool** **prog** { **show** | **list** } [*PROG*]
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 25) | **bpftool** **prog dump xlated** *PROG* [{**file** *FILE* | **opcodes** | **visual** | **linum**}]
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 26) | **bpftool** **prog dump jited** *PROG* [{**file** *FILE* | **opcodes** | **linum**}]
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 27) | **bpftool** **prog pin** *PROG* *FILE*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 28) | **bpftool** **prog** { **load** | **loadall** } *OBJ* *PATH* [**type** *TYPE*] [**map** {**idx** *IDX* | **name** *NAME*} *MAP*] [**dev** *NAME*] [**pinmaps** *MAP_DIR*]
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 29) | **bpftool** **prog attach** *PROG* *ATTACH_TYPE* [*MAP*]
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 30) | **bpftool** **prog detach** *PROG* *ATTACH_TYPE* [*MAP*]
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 31) | **bpftool** **prog tracelog**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 32) | **bpftool** **prog run** *PROG* **data_in** *FILE* [**data_out** *FILE* [**data_size_out** *L*]] [**ctx_in** *FILE* [**ctx_out** *FILE* [**ctx_size_out** *M*]]] [**repeat** *N*]
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 33) | **bpftool** **prog profile** *PROG* [**duration** *DURATION*] *METRICs*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 34) | **bpftool** **prog help**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 35) |
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 36) | *MAP* := { **id** *MAP_ID* | **pinned** *FILE* }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 37) | *PROG* := { **id** *PROG_ID* | **pinned** *FILE* | **tag** *PROG_TAG* | **name** *PROG_NAME* }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 38) | *TYPE* := {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 39) | **socket** | **kprobe** | **kretprobe** | **classifier** | **action** |
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 40) | **tracepoint** | **raw_tracepoint** | **xdp** | **perf_event** | **cgroup/skb** |
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 41) | **cgroup/sock** | **cgroup/dev** | **lwt_in** | **lwt_out** | **lwt_xmit** |
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 42) | **lwt_seg6local** | **sockops** | **sk_skb** | **sk_msg** | **lirc_mode2** |
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 43) | **cgroup/bind4** | **cgroup/bind6** | **cgroup/post_bind4** | **cgroup/post_bind6** |
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 44) | **cgroup/connect4** | **cgroup/connect6** | **cgroup/getpeername4** | **cgroup/getpeername6** |
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 45) | **cgroup/getsockname4** | **cgroup/getsockname6** | **cgroup/sendmsg4** | **cgroup/sendmsg6** |
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 46) | **cgroup/recvmsg4** | **cgroup/recvmsg6** | **cgroup/sysctl** |
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 47) | **cgroup/getsockopt** | **cgroup/setsockopt** | **cgroup/sock_release** |
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 48) | **struct_ops** | **fentry** | **fexit** | **freplace** | **sk_lookup**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 49) | }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 50) | *ATTACH_TYPE* := {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 51) | **msg_verdict** | **stream_verdict** | **stream_parser** | **flow_dissector**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 52) | }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 53) | *METRICs* := {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 54) | **cycles** | **instructions** | **l1d_loads** | **llc_misses**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 55) | }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 56)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 57)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 58) DESCRIPTION
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 59) ===========
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 60) **bpftool prog { show | list }** [*PROG*]
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 61) Show information about loaded programs. If *PROG* is
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 62) specified show information only about given programs,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 63) otherwise list all programs currently loaded on the system.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 64) In case of **tag** or **name**, *PROG* may match several
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 65) programs which will all be shown.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 66)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 67) Output will start with program ID followed by program type and
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 68) zero or more named attributes (depending on kernel version).
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 69)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 70) Since Linux 5.1 the kernel can collect statistics on BPF
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 71) programs (such as the total time spent running the program,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 72) and the number of times it was run). If available, bpftool
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 73) shows such statistics. However, the kernel does not collect
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 74) them by defaults, as it slightly impacts performance on each
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 75) program run. Activation or deactivation of the feature is
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 76) performed via the **kernel.bpf_stats_enabled** sysctl knob.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 77)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 78) Since Linux 5.8 bpftool is able to discover information about
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 79) processes that hold open file descriptors (FDs) against BPF
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 80) programs. On such kernels bpftool will automatically emit this
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 81) information as well.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 82)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 83) **bpftool prog dump xlated** *PROG* [{ **file** *FILE* | **opcodes** | **visual** | **linum** }]
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 84) Dump eBPF instructions of the programs from the kernel. By
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 85) default, eBPF will be disassembled and printed to standard
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 86) output in human-readable format. In this case, **opcodes**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 87) controls if raw opcodes should be printed as well.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 88)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 89) In case of **tag** or **name**, *PROG* may match several
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 90) programs which will all be dumped. However, if **file** or
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 91) **visual** is specified, *PROG* must match a single program.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 92)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 93) If **file** is specified, the binary image will instead be
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 94) written to *FILE*.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 95)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 96) If **visual** is specified, control flow graph (CFG) will be
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 97) built instead, and eBPF instructions will be presented with
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 98) CFG in DOT format, on standard output.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 99)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 100) If the programs have line_info available, the source line will
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 101) be displayed by default. If **linum** is specified,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 102) the filename, line number and line column will also be
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 103) displayed on top of the source line.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 104)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 105) **bpftool prog dump jited** *PROG* [{ **file** *FILE* | **opcodes** | **linum** }]
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 106) Dump jited image (host machine code) of the program.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 107)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 108) If *FILE* is specified image will be written to a file,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 109) otherwise it will be disassembled and printed to stdout.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 110) *PROG* must match a single program when **file** is specified.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 111)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 112) **opcodes** controls if raw opcodes will be printed.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 113)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 114) If the prog has line_info available, the source line will
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 115) be displayed by default. If **linum** is specified,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 116) the filename, line number and line column will also be
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 117) displayed on top of the source line.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 118)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 119) **bpftool prog pin** *PROG* *FILE*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 120) Pin program *PROG* as *FILE*.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 121)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 122) Note: *FILE* must be located in *bpffs* mount. It must not
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 123) contain a dot character ('.'), which is reserved for future
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 124) extensions of *bpffs*.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 125)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 126) **bpftool prog { load | loadall }** *OBJ* *PATH* [**type** *TYPE*] [**map** {**idx** *IDX* | **name** *NAME*} *MAP*] [**dev** *NAME*] [**pinmaps** *MAP_DIR*]
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 127) Load bpf program(s) from binary *OBJ* and pin as *PATH*.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 128) **bpftool prog load** pins only the first program from the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 129) *OBJ* as *PATH*. **bpftool prog loadall** pins all programs
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 130) from the *OBJ* under *PATH* directory.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 131) **type** is optional, if not specified program type will be
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 132) inferred from section names.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 133) By default bpftool will create new maps as declared in the ELF
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 134) object being loaded. **map** parameter allows for the reuse
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 135) of existing maps. It can be specified multiple times, each
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 136) time for a different map. *IDX* refers to index of the map
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 137) to be replaced in the ELF file counting from 0, while *NAME*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 138) allows to replace a map by name. *MAP* specifies the map to
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 139) use, referring to it by **id** or through a **pinned** file.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 140) If **dev** *NAME* is specified program will be loaded onto
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 141) given networking device (offload).
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 142) Optional **pinmaps** argument can be provided to pin all
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 143) maps under *MAP_DIR* directory.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 144)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 145) Note: *PATH* must be located in *bpffs* mount. It must not
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 146) contain a dot character ('.'), which is reserved for future
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 147) extensions of *bpffs*.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 148)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 149) **bpftool prog attach** *PROG* *ATTACH_TYPE* [*MAP*]
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 150) Attach bpf program *PROG* (with type specified by
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 151) *ATTACH_TYPE*). Most *ATTACH_TYPEs* require a *MAP*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 152) parameter, with the exception of *flow_dissector* which is
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 153) attached to current networking name space.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 154)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 155) **bpftool prog detach** *PROG* *ATTACH_TYPE* [*MAP*]
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 156) Detach bpf program *PROG* (with type specified by
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 157) *ATTACH_TYPE*). Most *ATTACH_TYPEs* require a *MAP*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 158) parameter, with the exception of *flow_dissector* which is
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 159) detached from the current networking name space.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 160)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 161) **bpftool prog tracelog**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 162) Dump the trace pipe of the system to the console (stdout).
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 163) Hit <Ctrl+C> to stop printing. BPF programs can write to this
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 164) trace pipe at runtime with the **bpf_trace_printk**\ () helper.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 165) This should be used only for debugging purposes. For
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 166) streaming data from BPF programs to user space, one can use
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 167) perf events (see also **bpftool-map**\ (8)).
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 168)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 169) **bpftool prog run** *PROG* **data_in** *FILE* [**data_out** *FILE* [**data_size_out** *L*]] [**ctx_in** *FILE* [**ctx_out** *FILE* [**ctx_size_out** *M*]]] [**repeat** *N*]
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 170) Run BPF program *PROG* in the kernel testing infrastructure
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 171) for BPF, meaning that the program works on the data and
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 172) context provided by the user, and not on actual packets or
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 173) monitored functions etc. Return value and duration for the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 174) test run are printed out to the console.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 175)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 176) Input data is read from the *FILE* passed with **data_in**.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 177) If this *FILE* is "**-**", input data is read from standard
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 178) input. Input context, if any, is read from *FILE* passed with
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 179) **ctx_in**. Again, "**-**" can be used to read from standard
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 180) input, but only if standard input is not already in use for
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 181) input data. If a *FILE* is passed with **data_out**, output
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 182) data is written to that file. Similarly, output context is
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 183) written to the *FILE* passed with **ctx_out**. For both
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 184) output flows, "**-**" can be used to print to the standard
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 185) output (as plain text, or JSON if relevant option was
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 186) passed). If output keywords are omitted, output data and
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 187) context are discarded. Keywords **data_size_out** and
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 188) **ctx_size_out** are used to pass the size (in bytes) for the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 189) output buffers to the kernel, although the default of 32 kB
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 190) should be more than enough for most cases.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 191)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 192) Keyword **repeat** is used to indicate the number of
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 193) consecutive runs to perform. Note that output data and
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 194) context printed to files correspond to the last of those
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 195) runs. The duration printed out at the end of the runs is an
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 196) average over all runs performed by the command.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 197)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 198) Not all program types support test run. Among those which do,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 199) not all of them can take the **ctx_in**/**ctx_out**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 200) arguments. bpftool does not perform checks on program types.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 201)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 202) **bpftool prog profile** *PROG* [**duration** *DURATION*] *METRICs*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 203) Profile *METRICs* for bpf program *PROG* for *DURATION*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 204) seconds or until user hits <Ctrl+C>. *DURATION* is optional.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 205) If *DURATION* is not specified, the profiling will run up to
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 206) **UINT_MAX** seconds.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 207)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 208) **bpftool prog help**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 209) Print short help message.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 210)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 211) OPTIONS
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 212) =======
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 213) .. include:: common_options.rst
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 214)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 215) -f, --bpffs
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 216) When showing BPF programs, show file names of pinned
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 217) programs.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 218)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 219) -m, --mapcompat
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 220) Allow loading maps with unknown map definitions.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 221)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 222) -n, --nomount
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 223) Do not automatically attempt to mount any virtual file system
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 224) (such as tracefs or BPF virtual file system) when necessary.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 225)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 226) EXAMPLES
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 227) ========
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 228) **# bpftool prog show**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 229)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 230) ::
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 231)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 232) 10: xdp name some_prog tag 005a3d2123620c8b gpl run_time_ns 81632 run_cnt 10
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 233) loaded_at 2017-09-29T20:11:00+0000 uid 0
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 234) xlated 528B jited 370B memlock 4096B map_ids 10
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 235) pids systemd(1)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 236)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 237) **# bpftool --json --pretty prog show**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 238)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 239) ::
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 240)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 241) [{
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 242) "id": 10,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 243) "type": "xdp",
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 244) "tag": "005a3d2123620c8b",
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 245) "gpl_compatible": true,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 246) "run_time_ns": 81632,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 247) "run_cnt": 10,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 248) "loaded_at": 1506715860,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 249) "uid": 0,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 250) "bytes_xlated": 528,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 251) "jited": true,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 252) "bytes_jited": 370,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 253) "bytes_memlock": 4096,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 254) "map_ids": [10
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 255) ],
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 256) "pids": [{
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 257) "pid": 1,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 258) "comm": "systemd"
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 259) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 260) ]
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 261) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 262) ]
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 263)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 264) |
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 265) | **# bpftool prog dump xlated id 10 file /tmp/t**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 266) | **$ ls -l /tmp/t**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 267)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 268) ::
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 269)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 270) -rw------- 1 root root 560 Jul 22 01:42 /tmp/t
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 271)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 272) **# bpftool prog dump jited tag 005a3d2123620c8b**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 273)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 274) ::
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 275)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 276) 0: push %rbp
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 277) 1: mov %rsp,%rbp
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 278) 2: sub $0x228,%rsp
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 279) 3: sub $0x28,%rbp
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 280) 4: mov %rbx,0x0(%rbp)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 281)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 282) |
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 283) | **# mount -t bpf none /sys/fs/bpf/**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 284) | **# bpftool prog pin id 10 /sys/fs/bpf/prog**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 285) | **# bpftool prog load ./my_prog.o /sys/fs/bpf/prog2**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 286) | **# ls -l /sys/fs/bpf/**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 287)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 288) ::
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 289)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 290) -rw------- 1 root root 0 Jul 22 01:43 prog
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 291) -rw------- 1 root root 0 Jul 22 01:44 prog2
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 292)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 293) **# bpftool prog dump jited pinned /sys/fs/bpf/prog opcodes**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 294)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 295) ::
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 296)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 297) 0: push %rbp
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 298) 55
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 299) 1: mov %rsp,%rbp
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 300) 48 89 e5
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 301) 4: sub $0x228,%rsp
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 302) 48 81 ec 28 02 00 00
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 303) b: sub $0x28,%rbp
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 304) 48 83 ed 28
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 305) f: mov %rbx,0x0(%rbp)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 306) 48 89 5d 00
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 307)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 308) |
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 309) | **# bpftool prog load xdp1_kern.o /sys/fs/bpf/xdp1 type xdp map name rxcnt id 7**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 310) | **# bpftool prog show pinned /sys/fs/bpf/xdp1**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 311)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 312) ::
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 313)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 314) 9: xdp name xdp_prog1 tag 539ec6ce11b52f98 gpl
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 315) loaded_at 2018-06-25T16:17:31-0700 uid 0
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 316) xlated 488B jited 336B memlock 4096B map_ids 7
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 317)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 318) **# rm /sys/fs/bpf/xdp1**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 319)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 320) |
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 321) | **# bpftool prog profile id 337 duration 10 cycles instructions llc_misses**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 322)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 323) ::
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 324)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 325) 51397 run_cnt
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 326) 40176203 cycles (83.05%)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 327) 42518139 instructions # 1.06 insns per cycle (83.39%)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 328) 123 llc_misses # 2.89 LLC misses per million insns (83.15%)
Orange Pi5 kernel
Deprecated Linux kernel 5.10.110 for OrangePi 5/5B/5+ boards
3 Commits
0 Branches
0 Tags