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


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