tools/bpf/bpftool/Documentation/bpftool-map.rst

   1 ================
   2 bpftool-map
   3 ================
   4 -------------------------------------------------------------------------------
   5 tool for inspection and simple manipulation of eBPF maps
   6 -------------------------------------------------------------------------------
   7
   8 :Manual section: 8
   9
  10 SYNOPSIS
  11 ========
  12
  13         **bpftool** [*OPTIONS*] **map** *COMMAND*
  14
  15         *OPTIONS* := { { **-j** | **--json** } [{ **-p** | **--pretty** }] | { **-f** | **--bpffs** } }
  16
  17         *COMMANDS* :=
  18         { **show** | **dump** | **update** | **lookup** | **getnext** | **delete**
  19         | **pin** | **help** }
  20
  21 MAP COMMANDS
  22 =============
  23
  24 |       **bpftool** **map show**   [*MAP*]
  25 |       **bpftool** **map dump**    *MAP*
  26 |       **bpftool** **map update**  *MAP*  **key** *BYTES*   **value** *VALUE* [*UPDATE_FLAGS*]
  27 |       **bpftool** **map lookup**  *MAP*  **key** *BYTES*
  28 |       **bpftool** **map getnext** *MAP* [**key** *BYTES*]
  29 |       **bpftool** **map delete**  *MAP*  **key** *BYTES*
  30 |       **bpftool** **map pin**     *MAP*  *FILE*
  31 |       **bpftool** **map help**
  32 |
  33 |       *MAP* := { **id** *MAP_ID* | **pinned** *FILE* }
  34 |       *VALUE* := { *BYTES* | *MAP* | *PROGRAM* }
  35 |       *UPDATE_FLAGS* := { **any** | **exist** | **noexist** }
  36
  37 DESCRIPTION
  38 ===========
  39         **bpftool map show**   [*MAP*]
  40                   Show information about loaded maps.  If *MAP* is specified
  41                   show information only about given map, otherwise list all
  42                   maps currently loaded on the system.
  43
  44                   Output will start with map ID followed by map type and
  45                   zero or more named attributes (depending on kernel version).
  46
  47         **bpftool map dump**    *MAP*
  48                   Dump all entries in a given *MAP*.
  49
  50         **bpftool map update**  *MAP*  **key** *BYTES*   **value** *VALUE* [*UPDATE_FLAGS*]
  51                   Update map entry for a given *KEY*.
  52
  53                   *UPDATE_FLAGS* can be one of: **any** update existing entry
  54                   or add if doesn't exit; **exist** update only if entry already
  55                   exists; **noexist** update only if entry doesn't exist.
  56
  57         **bpftool map lookup**  *MAP*  **key** *BYTES*
  58                   Lookup **key** in the map.
  59
  60         **bpftool map getnext** *MAP* [**key** *BYTES*]
  61                   Get next key.  If *key* is not specified, get first key.
  62
  63         **bpftool map delete**  *MAP*  **key** *BYTES*
  64                   Remove entry from the map.
  65
  66         **bpftool map pin**     *MAP*  *FILE*
  67                   Pin map *MAP* as *FILE*.
  68
  69                   Note: *FILE* must be located in *bpffs* mount.
  70
  71         **bpftool map help**
  72                   Print short help message.
  73
  74 OPTIONS
  75 =======
  76         -h, --help
  77                   Print short generic help message (similar to **bpftool help**).
  78
  79         -v, --version
  80                   Print version number (similar to **bpftool version**).
  81
  82         -j, --json
  83                   Generate JSON output. For commands that cannot produce JSON, this
  84                   option has no effect.
  85
  86         -p, --pretty
  87                   Generate human-readable JSON output. Implies **-j**.
  88
  89         -f, --bpffs
  90                   Show file names of pinned maps.
  91
  92 EXAMPLES
  93 ========
  94 **# bpftool map show**
  95 ::
  96
  97   10: hash  name some_map  flags 0x0
  98         key 4B  value 8B  max_entries 2048  memlock 167936B
  99
 100 **# bpftool map update id 10 key 13 00 07 00 value 02 00 00 00 01 02 03 04**
 101
 102 **# bpftool map lookup id 10 key 0 1 2 3**
 103
 104 ::
 105
 106   key: 00 01 02 03 value: 00 01 02 03 04 05 06 07
 107
 108
 109 **# bpftool map dump id 10**
 110 ::
 111
 112   key: 00 01 02 03  value: 00 01 02 03 04 05 06 07
 113   key: 0d 00 07 00  value: 02 00 00 00 01 02 03 04
 114   Found 2 elements
 115
 116 **# bpftool map getnext id 10 key 0 1 2 3**
 117 ::
 118
 119   key:
 120   00 01 02 03
 121   next key:
 122   0d 00 07 00
 123
 124 |
 125 | **# mount -t bpf none /sys/fs/bpf/**
 126 | **# bpftool map pin id 10 /sys/fs/bpf/map**
 127 | **# bpftool map del pinned /sys/fs/bpf/map key 13 00 07 00**
 128
 129 SEE ALSO
 130 ========
 131         **bpftool**\ (8), **bpftool-prog**\ (8), **bpftool-cgroup**\ (8)