kpriv/linux-hardened
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

bpftool/docs: add description of btf dump C option

Browse source 
Document optional **c** option for btf dump subcommand.

Cc: Quentin Monnet <quentin.monnet@netronome.com>
Signed-off-by: Andrii Nakryiko <andriin@fb.com>
Reviewed-by: Quentin Monnet <quentin.monnet@netronome.com>
Signed-off-by: Alexei Starovoitov <ast@kernel.org>
This commit is contained in:
Andrii Nakryiko 2019-05-24 11:59:06 -07:00 committed by Alexei Starovoitov
parent 2119f2189d
commit 220ba45112
1 changed files with 20 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

35
tools/bpf/bpftool/Documentation/bpftool-btf.rst
View file

@ -19,10 +19,11 @@ SYNOPSIS
BTF COMMANDS BTF COMMANDS
============= =============
| **bpftool** **btf dump** *BTF_SRC* | **bpftool** **btf dump** *BTF_SRC* [**format** *FORMAT*]
| **bpftool** **btf help** | **bpftool** **btf help**
| |
| *BTF_SRC* := { **id** *BTF_ID* | **prog** *PROG* | **map** *MAP* [{**key** | **value** | **kv** | **all**}] | **file** *FILE* } | *BTF_SRC* := { **id** *BTF_ID* | **prog** *PROG* | **map** *MAP* [{**key** | **value** | **kv** | **all**}] | **file** *FILE* }
| *FORMAT* := { **raw** | **c** }
| *MAP* := { **id** *MAP_ID* | **pinned** *FILE* } | *MAP* := { **id** *MAP_ID* | **pinned** *FILE* }
| *PROG* := { **id** *PROG_ID* | **pinned** *FILE* | **tag** *PROG_TAG* } | *PROG* := { **id** *PROG_ID* | **pinned** *FILE* | **tag** *PROG_TAG* }
@ -31,23 +32,27 @@ DESCRIPTION
**bpftool btf dump** *BTF_SRC* **bpftool btf dump** *BTF_SRC*
Dump BTF entries from a given *BTF_SRC*. Dump BTF entries from a given *BTF_SRC*.
When **id** is specified, BTF object with that ID will be When **id** is specified, BTF object with that ID will be
loaded and all its BTF types emitted. loaded and all its BTF types emitted.
When **map** is provided, it's expected that map has When **map** is provided, it's expected that map has
associated BTF object with BTF types describing key and associated BTF object with BTF types describing key and
value. It's possible to select whether to dump only BTF value. It's possible to select whether to dump only BTF
type(s) associated with key (**key**), value (**value**), type(s) associated with key (**key**), value (**value**),
both key and value (**kv**), or all BTF types present in both key and value (**kv**), or all BTF types present in
associated BTF object (**all**). If not specified, **kv** associated BTF object (**all**). If not specified, **kv**
is assumed. is assumed.
When **prog** is provided, it's expected that program has When **prog** is provided, it's expected that program has
associated BTF object with BTF types. associated BTF object with BTF types.
When specifying *FILE*, an ELF file is expected, containing When specifying *FILE*, an ELF file is expected, containing
.BTF section with well-defined BTF binary format data, .BTF section with well-defined BTF binary format data,
typically produced by clang or pahole. typically produced by clang or pahole.
**format** option can be used to override default (raw)
output format. Raw (**raw**) or C-syntax (**c**) output
formats are supported.
**bpftool btf help** **bpftool btf help**
Print short help message. Print short help message.