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