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