Skip to content

L
linux
Commit 32e7dc28 authored by Quentin Monnet's avatar Quentin Monnet Committed by Daniel Borkmann
Browse files
Options

bpf: fix recurring typo in documentation for BPF helpers 

"Underlaying packet buffer" should be an "underlying" one, in the
warning about invalidated data and data_end pointers. Through
copy-and-paste, the typo occurred no fewer than 19 times in the
documentation. Let's fix it.
Signed-off-by: default avatarQuentin Monnet <quentin.monnet@netronome.com>
Acked-by: default avatarJakub Kicinski <jakub.kicinski@netronome.com>
Signed-off-by: default avatarDaniel Borkmann <daniel@iogearbox.net>
parent 748c7c82
Hide whitespace changes
Inline Side-by-side
Showing with 19 additions and 19 deletions
include/uapi/linux/bpf.h
View file @ 32e7dc28
...@@ -629,7 +629,7 @@ union bpf_attr { ...@@ -629,7 +629,7 @@ union bpf_attr {
* **BPF_F_INVALIDATE_HASH** (set *skb*\ **->hash**, *skb*\ * **BPF_F_INVALIDATE_HASH** (set *skb*\ **->hash**, *skb*\
* **->swhash** and *skb*\ **->l4hash** to 0). * **->swhash** and *skb*\ **->l4hash** to 0).
* *
* A call to this helper is susceptible to change the underlaying * A call to this helper is susceptible to change the underlying
* packet buffer. Therefore, at load time, all checks on pointers * packet buffer. Therefore, at load time, all checks on pointers
* previously done by the verifier are invalidated and must be * previously done by the verifier are invalidated and must be
* performed again, if the helper is used in combination with * performed again, if the helper is used in combination with
...@@ -654,7 +654,7 @@ union bpf_attr { ...@@ -654,7 +654,7 @@ union bpf_attr {
* flexibility and can handle sizes larger than 2 or 4 for the * flexibility and can handle sizes larger than 2 or 4 for the
* checksum to update. * checksum to update.
* *
* A call to this helper is susceptible to change the underlaying * A call to this helper is susceptible to change the underlying
* packet buffer. Therefore, at load time, all checks on pointers * packet buffer. Therefore, at load time, all checks on pointers
* previously done by the verifier are invalidated and must be * previously done by the verifier are invalidated and must be
* performed again, if the helper is used in combination with * performed again, if the helper is used in combination with
...@@ -686,7 +686,7 @@ union bpf_attr { ...@@ -686,7 +686,7 @@ union bpf_attr {
* flexibility and can handle sizes larger than 2 or 4 for the * flexibility and can handle sizes larger than 2 or 4 for the
* checksum to update. * checksum to update.
* *
* A call to this helper is susceptible to change the underlaying * A call to this helper is susceptible to change the underlying
* packet buffer. Therefore, at load time, all checks on pointers * packet buffer. Therefore, at load time, all checks on pointers
* previously done by the verifier are invalidated and must be * previously done by the verifier are invalidated and must be
* performed again, if the helper is used in combination with * performed again, if the helper is used in combination with
...@@ -741,7 +741,7 @@ union bpf_attr { ...@@ -741,7 +741,7 @@ union bpf_attr {
* efficient, but it is handled through an action code where the * efficient, but it is handled through an action code where the
* redirection happens only after the eBPF program has returned. * redirection happens only after the eBPF program has returned.
* *
* A call to this helper is susceptible to change the underlaying * A call to this helper is susceptible to change the underlying
* packet buffer. Therefore, at load time, all checks on pointers * packet buffer. Therefore, at load time, all checks on pointers
* previously done by the verifier are invalidated and must be * previously done by the verifier are invalidated and must be
* performed again, if the helper is used in combination with * performed again, if the helper is used in combination with
...@@ -806,7 +806,7 @@ union bpf_attr { ...@@ -806,7 +806,7 @@ union bpf_attr {
* **ETH_P_8021Q** and **ETH_P_8021AD**, it is considered to * **ETH_P_8021Q** and **ETH_P_8021AD**, it is considered to
* be **ETH_P_8021Q**. * be **ETH_P_8021Q**.
* *
* A call to this helper is susceptible to change the underlaying * A call to this helper is susceptible to change the underlying
* packet buffer. Therefore, at load time, all checks on pointers * packet buffer. Therefore, at load time, all checks on pointers
* previously done by the verifier are invalidated and must be * previously done by the verifier are invalidated and must be
* performed again, if the helper is used in combination with * performed again, if the helper is used in combination with
...@@ -818,7 +818,7 @@ union bpf_attr { ...@@ -818,7 +818,7 @@ union bpf_attr {
* Description * Description
* Pop a VLAN header from the packet associated to *skb*. * Pop a VLAN header from the packet associated to *skb*.
* *
* A call to this helper is susceptible to change the underlaying * A call to this helper is susceptible to change the underlying
* packet buffer. Therefore, at load time, all checks on pointers * packet buffer. Therefore, at load time, all checks on pointers
* previously done by the verifier are invalidated and must be * previously done by the verifier are invalidated and must be
* performed again, if the helper is used in combination with * performed again, if the helper is used in combination with
...@@ -1168,7 +1168,7 @@ union bpf_attr { ...@@ -1168,7 +1168,7 @@ union bpf_attr {
* All values for *flags* are reserved for future usage, and must * All values for *flags* are reserved for future usage, and must
* be left at zero. * be left at zero.
* *
* A call to this helper is susceptible to change the underlaying * A call to this helper is susceptible to change the underlying
* packet buffer. Therefore, at load time, all checks on pointers * packet buffer. Therefore, at load time, all checks on pointers
* previously done by the verifier are invalidated and must be * previously done by the verifier are invalidated and must be
* performed again, if the helper is used in combination with * performed again, if the helper is used in combination with
...@@ -1281,7 +1281,7 @@ union bpf_attr { ...@@ -1281,7 +1281,7 @@ union bpf_attr {
* implicitly linearizes, unclones and drops offloads from the * implicitly linearizes, unclones and drops offloads from the
* *skb*. * *skb*.
* *
* A call to this helper is susceptible to change the underlaying * A call to this helper is susceptible to change the underlying
* packet buffer. Therefore, at load time, all checks on pointers * packet buffer. Therefore, at load time, all checks on pointers
* previously done by the verifier are invalidated and must be * previously done by the verifier are invalidated and must be
* performed again, if the helper is used in combination with * performed again, if the helper is used in combination with
...@@ -1317,7 +1317,7 @@ union bpf_attr { ...@@ -1317,7 +1317,7 @@ union bpf_attr {
* **bpf_skb_pull_data()** to effectively unclone the *skb* from * **bpf_skb_pull_data()** to effectively unclone the *skb* from
* the very beginning in case it is indeed cloned. * the very beginning in case it is indeed cloned.
* *
* A call to this helper is susceptible to change the underlaying * A call to this helper is susceptible to change the underlying
* packet buffer. Therefore, at load time, all checks on pointers * packet buffer. Therefore, at load time, all checks on pointers
* previously done by the verifier are invalidated and must be * previously done by the verifier are invalidated and must be
* performed again, if the helper is used in combination with * performed again, if the helper is used in combination with
...@@ -1369,7 +1369,7 @@ union bpf_attr { ...@@ -1369,7 +1369,7 @@ union bpf_attr {
* All values for *flags* are reserved for future usage, and must * All values for *flags* are reserved for future usage, and must
* be left at zero. * be left at zero.
* *
* A call to this helper is susceptible to change the underlaying * A call to this helper is susceptible to change the underlying
* packet buffer. Therefore, at load time, all checks on pointers * packet buffer. Therefore, at load time, all checks on pointers
* previously done by the verifier are invalidated and must be * previously done by the verifier are invalidated and must be
* performed again, if the helper is used in combination with * performed again, if the helper is used in combination with
...@@ -1384,7 +1384,7 @@ union bpf_attr { ...@@ -1384,7 +1384,7 @@ union bpf_attr {
* can be used to prepare the packet for pushing or popping * can be used to prepare the packet for pushing or popping
* headers. * headers.
* *
* A call to this helper is susceptible to change the underlaying * A call to this helper is susceptible to change the underlying
* packet buffer. Therefore, at load time, all checks on pointers * packet buffer. Therefore, at load time, all checks on pointers
* previously done by the verifier are invalidated and must be * previously done by the verifier are invalidated and must be
* performed again, if the helper is used in combination with * performed again, if the helper is used in combination with
...@@ -1531,7 +1531,7 @@ union bpf_attr { ...@@ -1531,7 +1531,7 @@ union bpf_attr {
* Use with ENCAP_L3/L4 flags to further specify the tunnel * Use with ENCAP_L3/L4 flags to further specify the tunnel
* type; **len** is the length of the inner MAC header. * type; **len** is the length of the inner MAC header.
* *
* A call to this helper is susceptible to change the underlaying * A call to this helper is susceptible to change the underlying
* packet buffer. Therefore, at load time, all checks on pointers * packet buffer. Therefore, at load time, all checks on pointers
* previously done by the verifier are invalidated and must be * previously done by the verifier are invalidated and must be
* performed again, if the helper is used in combination with * performed again, if the helper is used in combination with
...@@ -1610,7 +1610,7 @@ union bpf_attr { ...@@ -1610,7 +1610,7 @@ union bpf_attr {
* more flexibility as the user is free to store whatever meta * more flexibility as the user is free to store whatever meta
* data they need. * data they need.
* *
* A call to this helper is susceptible to change the underlaying * A call to this helper is susceptible to change the underlying
* packet buffer. Therefore, at load time, all checks on pointers * packet buffer. Therefore, at load time, all checks on pointers
* previously done by the verifier are invalidated and must be * previously done by the verifier are invalidated and must be
* performed again, if the helper is used in combination with * performed again, if the helper is used in combination with
...@@ -1852,7 +1852,7 @@ union bpf_attr { ...@@ -1852,7 +1852,7 @@ union bpf_attr {
* copied if necessary (i.e. if data was not linear and if start * copied if necessary (i.e. if data was not linear and if start
* and end pointers do not point to the same chunk). * and end pointers do not point to the same chunk).
* *
* A call to this helper is susceptible to change the underlaying * A call to this helper is susceptible to change the underlying
* packet buffer. Therefore, at load time, all checks on pointers * packet buffer. Therefore, at load time, all checks on pointers
* previously done by the verifier are invalidated and must be * previously done by the verifier are invalidated and must be
* performed again, if the helper is used in combination with * performed again, if the helper is used in combination with
...@@ -1886,7 +1886,7 @@ union bpf_attr { ...@@ -1886,7 +1886,7 @@ union bpf_attr {
* only possible to shrink the packet as of this writing, * only possible to shrink the packet as of this writing,
* therefore *delta* must be a negative integer. * therefore *delta* must be a negative integer.
* *
* A call to this helper is susceptible to change the underlaying * A call to this helper is susceptible to change the underlying
* packet buffer. Therefore, at load time, all checks on pointers * packet buffer. Therefore, at load time, all checks on pointers
* previously done by the verifier are invalidated and must be * previously done by the verifier are invalidated and must be
* performed again, if the helper is used in combination with * performed again, if the helper is used in combination with
...@@ -2072,7 +2072,7 @@ union bpf_attr { ...@@ -2072,7 +2072,7 @@ union bpf_attr {
* by bpf programs of types BPF_PROG_TYPE_LWT_IN and * by bpf programs of types BPF_PROG_TYPE_LWT_IN and
* BPF_PROG_TYPE_LWT_XMIT. * BPF_PROG_TYPE_LWT_XMIT.
* *
* A call to this helper is susceptible to change the underlaying * A call to this helper is susceptible to change the underlying
* packet buffer. Therefore, at load time, all checks on pointers * packet buffer. Therefore, at load time, all checks on pointers
* previously done by the verifier are invalidated and must be * previously done by the verifier are invalidated and must be
* performed again, if the helper is used in combination with * performed again, if the helper is used in combination with
...@@ -2087,7 +2087,7 @@ union bpf_attr { ...@@ -2087,7 +2087,7 @@ union bpf_attr {
* inside the outermost IPv6 Segment Routing Header can be * inside the outermost IPv6 Segment Routing Header can be
* modified through this helper. * modified through this helper.
* *
* A call to this helper is susceptible to change the underlaying * A call to this helper is susceptible to change the underlying
* packet buffer. Therefore, at load time, all checks on pointers * packet buffer. Therefore, at load time, all checks on pointers
* previously done by the verifier are invalidated and must be * previously done by the verifier are invalidated and must be
* performed again, if the helper is used in combination with * performed again, if the helper is used in combination with
...@@ -2103,7 +2103,7 @@ union bpf_attr { ...@@ -2103,7 +2103,7 @@ union bpf_attr {
* after the segments are accepted. *delta* can be as well * after the segments are accepted. *delta* can be as well
* positive (growing) as negative (shrinking). * positive (growing) as negative (shrinking).
* *
* A call to this helper is susceptible to change the underlaying * A call to this helper is susceptible to change the underlying
* packet buffer. Therefore, at load time, all checks on pointers * packet buffer. Therefore, at load time, all checks on pointers
* previously done by the verifier are invalidated and must be * previously done by the verifier are invalidated and must be
* performed again, if the helper is used in combination with * performed again, if the helper is used in combination with
...@@ -2132,7 +2132,7 @@ union bpf_attr { ...@@ -2132,7 +2132,7 @@ union bpf_attr {
* encapsulation policy. * encapsulation policy.
* Type of param: **struct ipv6_sr_hdr**. * Type of param: **struct ipv6_sr_hdr**.
* *
* A call to this helper is susceptible to change the underlaying * A call to this helper is susceptible to change the underlying
* packet buffer. Therefore, at load time, all checks on pointers * packet buffer. Therefore, at load time, all checks on pointers
* previously done by the verifier are invalidated and must be * previously done by the verifier are invalidated and must be
* performed again, if the helper is used in combination with * performed again, if the helper is used in combination with
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7