Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

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

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

include/uapi/linux/bpf.h

+19 −19
Original line number Diff line number Diff line
@@ -629,7 +629,7 @@ union bpf_attr { 
 * 		**BPF_F_INVALIDATE_HASH** (set *skb*\ **->hash**, *skb*\

 * 		**->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

 * 		previously done by the verifier are invalidated and must be

 * 		performed again, if the helper is used in combination with
@@ -654,7 +654,7 @@ union bpf_attr { 
 * 		flexibility and can handle sizes larger than 2 or 4 for the

 * 		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

 * 		previously done by the verifier are invalidated and must be

 * 		performed again, if the helper is used in combination with
@@ -686,7 +686,7 @@ union bpf_attr { 
 * 		flexibility and can handle sizes larger than 2 or 4 for the

 * 		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

 * 		previously done by the verifier are invalidated and must be

 * 		performed again, if the helper is used in combination with
@@ -741,7 +741,7 @@ union bpf_attr { 
 * 		efficient, but it is handled through an action code where the

 * 		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

 * 		previously done by the verifier are invalidated and must be

 * 		performed again, if the helper is used in combination with
@@ -806,7 +806,7 @@ union bpf_attr { 
 * 		**ETH_P_8021Q** and **ETH_P_8021AD**, it is considered to

 * 		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

 * 		previously done by the verifier are invalidated and must be

 * 		performed again, if the helper is used in combination with
@@ -818,7 +818,7 @@ union bpf_attr { 
 * 	Description

 * 		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

 * 		previously done by the verifier are invalidated and must be

 * 		performed again, if the helper is used in combination with
@@ -1168,7 +1168,7 @@ union bpf_attr { 
 * 		All values for *flags* are reserved for future usage, and must

 * 		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

 * 		previously done by the verifier are invalidated and must be

 * 		performed again, if the helper is used in combination with
@@ -1281,7 +1281,7 @@ union bpf_attr { 
 * 		implicitly linearizes, unclones and drops offloads from the

 * 		*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

 * 		previously done by the verifier are invalidated and must be

 * 		performed again, if the helper is used in combination with
@@ -1317,7 +1317,7 @@ union bpf_attr { 
 * 		**bpf_skb_pull_data()** to effectively unclone the *skb* from

 * 		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

 * 		previously done by the verifier are invalidated and must be

 * 		performed again, if the helper is used in combination with
@@ -1369,7 +1369,7 @@ union bpf_attr { 
 * 		All values for *flags* are reserved for future usage, and must

 * 		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

 * 		previously done by the verifier are invalidated and must be

 * 		performed again, if the helper is used in combination with
@@ -1384,7 +1384,7 @@ union bpf_attr { 
 * 		can be used to prepare the packet for pushing or popping

 * 		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

 * 		previously done by the verifier are invalidated and must be

 * 		performed again, if the helper is used in combination with
@@ -1531,7 +1531,7 @@ union bpf_attr { 
 *		  Use with ENCAP_L3/L4 flags to further specify the tunnel

 *		  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

 * 		previously done by the verifier are invalidated and must be

 * 		performed again, if the helper is used in combination with
@@ -1610,7 +1610,7 @@ union bpf_attr { 
 * 		more flexibility as the user is free to store whatever meta

 * 		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

 * 		previously done by the verifier are invalidated and must be

 * 		performed again, if the helper is used in combination with
@@ -1852,7 +1852,7 @@ union bpf_attr { 
 * 		copied if necessary (i.e. if data was not linear and if start

 * 		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

 * 		previously done by the verifier are invalidated and must be

 * 		performed again, if the helper is used in combination with
@@ -1886,7 +1886,7 @@ union bpf_attr { 
 * 		only possible to shrink the packet as of this writing,

 * 		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

 * 		previously done by the verifier are invalidated and must be

 * 		performed again, if the helper is used in combination with
@@ -2072,7 +2072,7 @@ union bpf_attr { 
 *		by bpf programs of types BPF_PROG_TYPE_LWT_IN and

 *		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

 * 		previously done by the verifier are invalidated and must be

 * 		performed again, if the helper is used in combination with
@@ -2087,7 +2087,7 @@ union bpf_attr { 
 *		inside the outermost IPv6 Segment Routing Header can be

 *		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

 * 		previously done by the verifier are invalidated and must be

 * 		performed again, if the helper is used in combination with
@@ -2103,7 +2103,7 @@ union bpf_attr { 
 *		after the segments are accepted. *delta* can be as well

 *		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

 * 		previously done by the verifier are invalidated and must be

 * 		performed again, if the helper is used in combination with
@@ -2132,7 +2132,7 @@ union bpf_attr { 
 *			encapsulation policy.

 *			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

 * 		previously done by the verifier are invalidated and must be

 * 		performed again, if the helper is used in combination with