~ [ 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.17.15)


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

~ [ 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