bpftool.rst 2.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970
  1. .. SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
  2. ================
  3. BPFTOOL
  4. ================
  5. -------------------------------------------------------------------------------
  6. tool for inspection and simple manipulation of eBPF programs and maps
  7. -------------------------------------------------------------------------------
  8. :Manual section: 8
  9. .. include:: substitutions.rst
  10. SYNOPSIS
  11. ========
  12. **bpftool** [*OPTIONS*] *OBJECT* { *COMMAND* | **help** }
  13. **bpftool** **batch file** *FILE*
  14. **bpftool** **version**
  15. *OBJECT* := { **map** | **program** | **link** | **cgroup** | **perf** | **net** | **feature** |
  16. **btf** | **gen** | **struct_ops** | **iter** }
  17. *OPTIONS* := { { **-V** | **--version** } | |COMMON_OPTIONS| }
  18. *MAP-COMMANDS* :=
  19. { **show** | **list** | **create** | **dump** | **update** | **lookup** | **getnext** |
  20. **delete** | **pin** | **event_pipe** | **help** }
  21. *PROG-COMMANDS* := { **show** | **list** | **dump jited** | **dump xlated** | **pin** |
  22. **load** | **attach** | **detach** | **help** }
  23. *LINK-COMMANDS* := { **show** | **list** | **pin** | **detach** | **help** }
  24. *CGROUP-COMMANDS* := { **show** | **list** | **attach** | **detach** | **help** }
  25. *PERF-COMMANDS* := { **show** | **list** | **help** }
  26. *NET-COMMANDS* := { **show** | **list** | **help** }
  27. *FEATURE-COMMANDS* := { **probe** | **help** }
  28. *BTF-COMMANDS* := { **show** | **list** | **dump** | **help** }
  29. *GEN-COMMANDS* := { **object** | **skeleton** | **min_core_btf** | **help** }
  30. *STRUCT-OPS-COMMANDS* := { **show** | **list** | **dump** | **register** | **unregister** | **help** }
  31. *ITER-COMMANDS* := { **pin** | **help** }
  32. DESCRIPTION
  33. ===========
  34. *bpftool* allows for inspection and simple modification of BPF objects
  35. on the system.
  36. Note that format of the output of all tools is not guaranteed to be
  37. stable and should not be depended upon.
  38. OPTIONS
  39. =======
  40. .. include:: common_options.rst
  41. -m, --mapcompat
  42. Allow loading maps with unknown map definitions.
  43. -n, --nomount
  44. Do not automatically attempt to mount any virtual file system
  45. (such as tracefs or BPF virtual file system) when necessary.