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

Source file repositories/reference/linux-study-clean/tools/bpf/bpftool/Documentation/bpftool-map.rst

File Facts

System
Linux kernel
Corpus path
tools/bpf/bpftool/Documentation/bpftool-map.rst
Extension
.rst
Size
9977 bytes
Lines
273
Domain
Support Tooling And Documentation
Bucket
tools
Inferred role
Support Tooling And Documentation: documentation
Status
atlas-only

Why This File Exists

Repository support layer: documentation, build tooling, samples, user-space helper tools, generated initramfs support, licenses, and validation utilities.

Dependency Surface

Detected Declarations

Annotated Snippet

.. SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)

================
bpftool-map
================
-------------------------------------------------------------------------------
tool for inspection and simple manipulation of eBPF maps
-------------------------------------------------------------------------------

:Manual section: 8

.. include:: substitutions.rst

SYNOPSIS
========

**bpftool** [*OPTIONS*] **map** *COMMAND*

*OPTIONS* := { |COMMON_OPTIONS| | { **-f** | **--bpffs** } | { **-n** | **--nomount** } }

*COMMANDS* :=
{ **show** | **list** | **create** | **dump** | **update** | **lookup** | **getnext** |
**delete** | **pin** | **help** }

MAP COMMANDS
=============

| **bpftool** **map** { **show** | **list** }   [*MAP*]
| **bpftool** **map create**     *FILE* **type** *TYPE* **key** *KEY_SIZE* **value** *VALUE_SIZE* \
|     **entries** *MAX_ENTRIES* **name** *NAME* [**flags** *FLAGS*] [**inner_map** *MAP*] \
|     [**offload_dev** *NAME*]
| **bpftool** **map dump**       *MAP*
| **bpftool** **map update**     *MAP* [**key** *DATA*] [**value** *VALUE*] [*UPDATE_FLAGS*]
| **bpftool** **map lookup**     *MAP* [**key** *DATA*]
| **bpftool** **map getnext**    *MAP* [**key** *DATA*]
| **bpftool** **map delete**     *MAP*  **key** *DATA*
| **bpftool** **map pin**        *MAP*  *FILE*
| **bpftool** **map event_pipe** *MAP* [**cpu** *N* **index** *M*]
| **bpftool** **map peek**       *MAP*
| **bpftool** **map push**       *MAP* **value** *VALUE*
| **bpftool** **map pop**        *MAP*
| **bpftool** **map enqueue**    *MAP* **value** *VALUE*
| **bpftool** **map dequeue**    *MAP*
| **bpftool** **map freeze**     *MAP*
| **bpftool** **map help**
|
| *MAP* := { **id** *MAP_ID* | **pinned** *FILE* | **name** *MAP_NAME* }
| *DATA* := { [**hex**] *BYTES* }
| *PROG* := { **id** *PROG_ID* | **pinned** *FILE* | **tag** *PROG_TAG* | **name** *PROG_NAME* }
| *VALUE* := { *DATA* | *MAP* | *PROG* }
| *UPDATE_FLAGS* := { **any** | **exist** | **noexist** }
| *TYPE* := { **hash** | **array** | **prog_array** | **perf_event_array** | **percpu_hash**
|     | **percpu_array** | **stack_trace** | **cgroup_array** | **lru_hash**
|     | **lru_percpu_hash** | **lpm_trie** | **array_of_maps** | **hash_of_maps**
|     | **devmap** | **devmap_hash** | **sockmap** | **cpumap** | **xskmap** | **sockhash**
|     | **cgroup_storage** | **reuseport_sockarray** | **percpu_cgroup_storage**
|     | **queue** | **stack** | **sk_storage** | **struct_ops** | **ringbuf** | **inode_storage**
|     | **task_storage** | **bloom_filter** | **user_ringbuf** | **cgrp_storage** | **arena**
|     | **insn_array** | **rhash** }

DESCRIPTION
===========
bpftool map { show | list }   [*MAP*]
    Show information about loaded maps.  If *MAP* is specified show information
    only about given maps, otherwise list all maps currently loaded on the
    system.  In case of **name**, *MAP* may match several maps which will all
    be shown.

    Output will start with map ID followed by map type and zero or more named
    attributes (depending on kernel version).

Annotation

Implementation Notes