mirror of
https://github.com/torvalds/linux.git
synced 2024-11-21 19:41:42 +00:00
Documentation: bpf: correct spelling
Correct spelling problems for Documentation/bpf/ as reported by codespell. Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Cc: Andrii Nakryiko <andrii@kernel.org> Cc: Alexei Starovoitov <ast@kernel.org> Cc: Daniel Borkmann <daniel@iogearbox.net> Cc: bpf@vger.kernel.org Cc: Jonathan Corbet <corbet@lwn.net> Cc: linux-doc@vger.kernel.org Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com> Link: https://lore.kernel.org/r/20230128195046.13327-1-rdunlap@infradead.org Signed-off-by: Alexei Starovoitov <ast@kernel.org>
This commit is contained in:
parent
cb4a21ea59
commit
1d3cab43f4
@ -83,8 +83,8 @@ This prevents from accidentally exporting a symbol, that is not supposed
|
|||||||
to be a part of ABI what, in turn, improves both libbpf developer- and
|
to be a part of ABI what, in turn, improves both libbpf developer- and
|
||||||
user-experiences.
|
user-experiences.
|
||||||
|
|
||||||
ABI versionning
|
ABI versioning
|
||||||
---------------
|
--------------
|
||||||
|
|
||||||
To make future ABI extensions possible libbpf ABI is versioned.
|
To make future ABI extensions possible libbpf ABI is versioned.
|
||||||
Versioning is implemented by ``libbpf.map`` version script that is
|
Versioning is implemented by ``libbpf.map`` version script that is
|
||||||
@ -148,7 +148,7 @@ API documentation convention
|
|||||||
The libbpf API is documented via comments above definitions in
|
The libbpf API is documented via comments above definitions in
|
||||||
header files. These comments can be rendered by doxygen and sphinx
|
header files. These comments can be rendered by doxygen and sphinx
|
||||||
for well organized html output. This section describes the
|
for well organized html output. This section describes the
|
||||||
convention in which these comments should be formated.
|
convention in which these comments should be formatted.
|
||||||
|
|
||||||
Here is an example from btf.h:
|
Here is an example from btf.h:
|
||||||
|
|
||||||
|
@ -178,7 +178,7 @@ The following code snippet shows how to update an XSKMAP with an XSK entry.
|
|||||||
|
|
||||||
For an example on how create AF_XDP sockets, please see the AF_XDP-example and
|
For an example on how create AF_XDP sockets, please see the AF_XDP-example and
|
||||||
AF_XDP-forwarding programs in the `bpf-examples`_ directory in the `libxdp`_ repository.
|
AF_XDP-forwarding programs in the `bpf-examples`_ directory in the `libxdp`_ repository.
|
||||||
For a detailed explaination of the AF_XDP interface please see:
|
For a detailed explanation of the AF_XDP interface please see:
|
||||||
|
|
||||||
- `libxdp-readme`_.
|
- `libxdp-readme`_.
|
||||||
- `AF_XDP`_ kernel documentation.
|
- `AF_XDP`_ kernel documentation.
|
||||||
|
@ -124,7 +124,7 @@ buffer. Currently 4 are supported:
|
|||||||
|
|
||||||
- ``BPF_RB_AVAIL_DATA`` returns amount of unconsumed data in ring buffer;
|
- ``BPF_RB_AVAIL_DATA`` returns amount of unconsumed data in ring buffer;
|
||||||
- ``BPF_RB_RING_SIZE`` returns the size of ring buffer;
|
- ``BPF_RB_RING_SIZE`` returns the size of ring buffer;
|
||||||
- ``BPF_RB_CONS_POS``/``BPF_RB_PROD_POS`` returns current logical possition
|
- ``BPF_RB_CONS_POS``/``BPF_RB_PROD_POS`` returns current logical position
|
||||||
of consumer/producer, respectively.
|
of consumer/producer, respectively.
|
||||||
|
|
||||||
Returned values are momentarily snapshots of ring buffer state and could be
|
Returned values are momentarily snapshots of ring buffer state and could be
|
||||||
@ -146,7 +146,7 @@ Design and Implementation
|
|||||||
This reserve/commit schema allows a natural way for multiple producers, either
|
This reserve/commit schema allows a natural way for multiple producers, either
|
||||||
on different CPUs or even on the same CPU/in the same BPF program, to reserve
|
on different CPUs or even on the same CPU/in the same BPF program, to reserve
|
||||||
independent records and work with them without blocking other producers. This
|
independent records and work with them without blocking other producers. This
|
||||||
means that if BPF program was interruped by another BPF program sharing the
|
means that if BPF program was interrupted by another BPF program sharing the
|
||||||
same ring buffer, they will both get a record reserved (provided there is
|
same ring buffer, they will both get a record reserved (provided there is
|
||||||
enough space left) and can work with it and submit it independently. This
|
enough space left) and can work with it and submit it independently. This
|
||||||
applies to NMI context as well, except that due to using a spinlock during
|
applies to NMI context as well, except that due to using a spinlock during
|
||||||
|
@ -192,7 +192,7 @@ checked and found to be non-NULL, all copies can become PTR_TO_MAP_VALUEs.
|
|||||||
As well as range-checking, the tracked information is also used for enforcing
|
As well as range-checking, the tracked information is also used for enforcing
|
||||||
alignment of pointer accesses. For instance, on most systems the packet pointer
|
alignment of pointer accesses. For instance, on most systems the packet pointer
|
||||||
is 2 bytes after a 4-byte alignment. If a program adds 14 bytes to that to jump
|
is 2 bytes after a 4-byte alignment. If a program adds 14 bytes to that to jump
|
||||||
over the Ethernet header, then reads IHL and addes (IHL * 4), the resulting
|
over the Ethernet header, then reads IHL and adds (IHL * 4), the resulting
|
||||||
pointer will have a variable offset known to be 4n+2 for some n, so adding the 2
|
pointer will have a variable offset known to be 4n+2 for some n, so adding the 2
|
||||||
bytes (NET_IP_ALIGN) gives a 4-byte alignment and so word-sized accesses through
|
bytes (NET_IP_ALIGN) gives a 4-byte alignment and so word-sized accesses through
|
||||||
that pointer are safe.
|
that pointer are safe.
|
||||||
|
Loading…
Reference in New Issue
Block a user