~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

TOMOYO Linux Cross Reference
Linux/tools/bpf/bpftool/Documentation/bpftool-prog.rst

Version: ~ [ linux-6.12-rc7 ] ~ [ linux-6.11.7 ] ~ [ linux-6.10.14 ] ~ [ linux-6.9.12 ] ~ [ linux-6.8.12 ] ~ [ linux-6.7.12 ] ~ [ linux-6.6.60 ] ~ [ linux-6.5.13 ] ~ [ linux-6.4.16 ] ~ [ linux-6.3.13 ] ~ [ linux-6.2.16 ] ~ [ linux-6.1.116 ] ~ [ linux-6.0.19 ] ~ [ linux-5.19.17 ] ~ [ linux-5.18.19 ] ~ [ linux-5.17.15 ] ~ [ linux-5.16.20 ] ~ [ linux-5.15.171 ] ~ [ linux-5.14.21 ] ~ [ linux-5.13.19 ] ~ [ linux-5.12.19 ] ~ [ linux-5.11.22 ] ~ [ linux-5.10.229 ] ~ [ linux-5.9.16 ] ~ [ linux-5.8.18 ] ~ [ linux-5.7.19 ] ~ [ linux-5.6.19 ] ~ [ linux-5.5.19 ] ~ [ linux-5.4.285 ] ~ [ linux-5.3.18 ] ~ [ linux-5.2.21 ] ~ [ linux-5.1.21 ] ~ [ linux-5.0.21 ] ~ [ linux-4.20.17 ] ~ [ linux-4.19.323 ] ~ [ linux-4.18.20 ] ~ [ linux-4.17.19 ] ~ [ linux-4.16.18 ] ~ [ linux-4.15.18 ] ~ [ linux-4.14.336 ] ~ [ linux-4.13.16 ] ~ [ linux-4.12.14 ] ~ [ linux-4.11.12 ] ~ [ linux-4.10.17 ] ~ [ linux-4.9.337 ] ~ [ linux-4.4.302 ] ~ [ linux-3.10.108 ] ~ [ linux-2.6.32.71 ] ~ [ linux-2.6.0 ] ~ [ linux-2.4.37.11 ] ~ [ unix-v6-master ] ~ [ ccs-tools-1.8.12 ] ~ [ policy-sample ] ~
Architecture: ~ [ i386 ] ~ [ alpha ] ~ [ m68k ] ~ [ mips ] ~ [ ppc ] ~ [ sparc ] ~ [ sparc64 ] ~

Diff markup

Differences between /tools/bpf/bpftool/Documentation/bpftool-prog.rst (Version linux-6.12-rc7) and /tools/bpf/bpftool/Documentation/bpftool-prog.rst (Version linux-5.7.19)


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

~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

kernel.org | git.kernel.org | LWN.net | Project Home | SVN repository | Mail admin

Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.

sflogo.php