mirror of
https://github.com/torvalds/linux
synced 2024-10-15 15:59:15 +00:00
docs/bpf: Fix sphinx warnings for cpumap
Sphinx version >=3.1 warns about duplicate function declarations in the CPUMAP documentation. This is because the function name is the same for kernel and user space BPF progs but the parameters and return types they take is what differs. This patch moves from using the ``c:function::`` directive to using the ``code-block:: c`` directive. The patches also fix the indentation for the text associated with the "new" code block delcarations. The missing support of c:namespace-push:: and c:namespace-pop:: directives by helper scripts for kernel documentation prevents using the ``c:function::`` directive with proper namespacing. Signed-off-by: Maryam Tahhan <mtahhan@redhat.com> Signed-off-by: Daniel Borkmann <daniel@iogearbox.net> Link: https://lore.kernel.org/bpf/20221123092321.88558-2-mtahhan@redhat.com
This commit is contained in:
parent
c742cb7c3e
commit
3685b0dc0d
|
@ -30,7 +30,10 @@ Usage
|
||||||
|
|
||||||
Kernel BPF
|
Kernel BPF
|
||||||
----------
|
----------
|
||||||
.. c:function::
|
bpf_redirect_map()
|
||||||
|
^^^^^^^^^^^^^^^^^^
|
||||||
|
.. code-block:: c
|
||||||
|
|
||||||
long bpf_redirect_map(struct bpf_map *map, u32 key, u64 flags)
|
long bpf_redirect_map(struct bpf_map *map, u32 key, u64 flags)
|
||||||
|
|
||||||
Redirect the packet to the endpoint referenced by ``map`` at index ``key``.
|
Redirect the packet to the endpoint referenced by ``map`` at index ``key``.
|
||||||
|
@ -41,13 +44,16 @@ Kernel BPF
|
||||||
codes up to ``XDP_TX``, as chosen by the caller.
|
codes up to ``XDP_TX``, as chosen by the caller.
|
||||||
|
|
||||||
User space
|
User space
|
||||||
---------
|
----------
|
||||||
.. note::
|
.. note::
|
||||||
CPUMAP entries can only be updated/looked up/deleted from user space and not
|
CPUMAP entries can only be updated/looked up/deleted from user space and not
|
||||||
from an eBPF program. Trying to call these functions from a kernel eBPF
|
from an eBPF program. Trying to call these functions from a kernel eBPF
|
||||||
program will result in the program failing to load and a verifier warning.
|
program will result in the program failing to load and a verifier warning.
|
||||||
|
|
||||||
.. c:function::
|
bpf_map_update_elem()
|
||||||
|
^^^^^^^^^^^^^^^^^^^^^
|
||||||
|
.. code-block:: c
|
||||||
|
|
||||||
int bpf_map_update_elem(int fd, const void *key, const void *value, __u64 flags);
|
int bpf_map_update_elem(int fd, const void *key, const void *value, __u64 flags);
|
||||||
|
|
||||||
CPU entries can be added or updated using the ``bpf_map_update_elem()``
|
CPU entries can be added or updated using the ``bpf_map_update_elem()``
|
||||||
|
@ -69,13 +75,19 @@ Userspace
|
||||||
- BPF_NOEXIST: Create a new element only if it did not exist.
|
- BPF_NOEXIST: Create a new element only if it did not exist.
|
||||||
- BPF_EXIST: Update an existing element.
|
- BPF_EXIST: Update an existing element.
|
||||||
|
|
||||||
.. c:function::
|
bpf_map_lookup_elem()
|
||||||
|
^^^^^^^^^^^^^^^^^^^^^
|
||||||
|
.. code-block:: c
|
||||||
|
|
||||||
int bpf_map_lookup_elem(int fd, const void *key, void *value);
|
int bpf_map_lookup_elem(int fd, const void *key, void *value);
|
||||||
|
|
||||||
CPU entries can be retrieved using the ``bpf_map_lookup_elem()``
|
CPU entries can be retrieved using the ``bpf_map_lookup_elem()``
|
||||||
helper.
|
helper.
|
||||||
|
|
||||||
.. c:function::
|
bpf_map_delete_elem()
|
||||||
|
^^^^^^^^^^^^^^^^^^^^^
|
||||||
|
.. code-block:: c
|
||||||
|
|
||||||
int bpf_map_delete_elem(int fd, const void *key);
|
int bpf_map_delete_elem(int fd, const void *key);
|
||||||
|
|
||||||
CPU entries can be deleted using the ``bpf_map_delete_elem()``
|
CPU entries can be deleted using the ``bpf_map_delete_elem()``
|
||||||
|
@ -142,7 +154,7 @@ The following code snippet shows how to declare a ``BPF_MAP_TYPE_CPUMAP`` called
|
||||||
}
|
}
|
||||||
|
|
||||||
User space
|
User space
|
||||||
---------
|
----------
|
||||||
|
|
||||||
The following code snippet shows how to dynamically set the max_entries for a
|
The following code snippet shows how to dynamically set the max_entries for a
|
||||||
CPUMAP to the max number of cpus available on the system.
|
CPUMAP to the max number of cpus available on the system.
|
||||||
|
|
Loading…
Reference in a new issue