History

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.

Quentin Monnet committed 7 years ago

Commit 32e7dc21 parent 748c7c81 file · +19 −19Browse files

Unified · Split

include/uapi/linux/bpf.h+19−19
@@ -629,7 +629,7 @@ union bpf_attr { · 628 unmodified lines
629 * **BPF_F_INVALIDATE_HASH** (set *skb*\ **->hash**, *skb*\629 * **BPF_F_INVALIDATE_HASH** (set *skb*\ **->hash**, *skb*\
630 * **->swhash** and *skb*\ **->l4hash** to 0).630 * **->swhash** and *skb*\ **->l4hash** to 0).
631 *631 *
632 * A call to this helper is susceptible to change the underlaying632 * A call to this helper is susceptible to change the underlying
633 * packet buffer. Therefore, at load time, all checks on pointers633 * packet buffer. Therefore, at load time, all checks on pointers
634 * previously done by the verifier are invalidated and must be634 * previously done by the verifier are invalidated and must be
635 * performed again, if the helper is used in combination with635 * performed again, if the helper is used in combination with
@@ -654,7 +654,7 @@ union bpf_attr { · 18 unmodified lines
654 * flexibility and can handle sizes larger than 2 or 4 for the654 * flexibility and can handle sizes larger than 2 or 4 for the
655 * checksum to update.655 * checksum to update.
656 *656 *
657 * A call to this helper is susceptible to change the underlaying657 * A call to this helper is susceptible to change the underlying
658 * packet buffer. Therefore, at load time, all checks on pointers658 * packet buffer. Therefore, at load time, all checks on pointers
659 * previously done by the verifier are invalidated and must be659 * previously done by the verifier are invalidated and must be
660 * performed again, if the helper is used in combination with660 * performed again, if the helper is used in combination with
@@ -686,7 +686,7 @@ union bpf_attr { · 25 unmodified lines
686 * flexibility and can handle sizes larger than 2 or 4 for the686 * flexibility and can handle sizes larger than 2 or 4 for the
687 * checksum to update.687 * checksum to update.
688 *688 *
689 * A call to this helper is susceptible to change the underlaying689 * A call to this helper is susceptible to change the underlying
690 * packet buffer. Therefore, at load time, all checks on pointers690 * packet buffer. Therefore, at load time, all checks on pointers
691 * previously done by the verifier are invalidated and must be691 * previously done by the verifier are invalidated and must be
692 * performed again, if the helper is used in combination with692 * performed again, if the helper is used in combination with
@@ -741,7 +741,7 @@ union bpf_attr { · 48 unmodified lines
741 * efficient, but it is handled through an action code where the741 * efficient, but it is handled through an action code where the
742 * redirection happens only after the eBPF program has returned.742 * redirection happens only after the eBPF program has returned.
743 *743 *
744 * A call to this helper is susceptible to change the underlaying744 * A call to this helper is susceptible to change the underlying
745 * packet buffer. Therefore, at load time, all checks on pointers745 * packet buffer. Therefore, at load time, all checks on pointers
746 * previously done by the verifier are invalidated and must be746 * previously done by the verifier are invalidated and must be
747 * performed again, if the helper is used in combination with747 * performed again, if the helper is used in combination with
@@ -806,7 +806,7 @@ union bpf_attr { · 58 unmodified lines
806 * **ETH_P_8021Q** and **ETH_P_8021AD**, it is considered to806 * **ETH_P_8021Q** and **ETH_P_8021AD**, it is considered to
807 * be **ETH_P_8021Q**.807 * be **ETH_P_8021Q**.
808 *808 *
809 * A call to this helper is susceptible to change the underlaying809 * A call to this helper is susceptible to change the underlying
810 * packet buffer. Therefore, at load time, all checks on pointers810 * packet buffer. Therefore, at load time, all checks on pointers
811 * previously done by the verifier are invalidated and must be811 * previously done by the verifier are invalidated and must be
812 * performed again, if the helper is used in combination with812 * performed again, if the helper is used in combination with
@@ -818,7 +818,7 @@ union bpf_attr { · 5 unmodified lines
818 * Description818 * Description
819 * Pop a VLAN header from the packet associated to *skb*.819 * Pop a VLAN header from the packet associated to *skb*.
820 *820 *
821 * A call to this helper is susceptible to change the underlaying821 * A call to this helper is susceptible to change the underlying
822 * packet buffer. Therefore, at load time, all checks on pointers822 * packet buffer. Therefore, at load time, all checks on pointers
823 * previously done by the verifier are invalidated and must be823 * previously done by the verifier are invalidated and must be
824 * performed again, if the helper is used in combination with824 * performed again, if the helper is used in combination with
@@ -1168,7 +1168,7 @@ union bpf_attr { · 343 unmodified lines
1168 * All values for *flags* are reserved for future usage, and must1168 * All values for *flags* are reserved for future usage, and must
1169 * be left at zero.1169 * be left at zero.
1170 *1170 *
1171 * A call to this helper is susceptible to change the underlaying1171 * A call to this helper is susceptible to change the underlying
1172 * packet buffer. Therefore, at load time, all checks on pointers1172 * packet buffer. Therefore, at load time, all checks on pointers
1173 * previously done by the verifier are invalidated and must be1173 * previously done by the verifier are invalidated and must be
1174 * performed again, if the helper is used in combination with1174 * performed again, if the helper is used in combination with
@@ -1281,7 +1281,7 @@ union bpf_attr { · 106 unmodified lines
1281 * implicitly linearizes, unclones and drops offloads from the1281 * implicitly linearizes, unclones and drops offloads from the
1282 * *skb*.1282 * *skb*.
1283 *1283 *
1284 * A call to this helper is susceptible to change the underlaying1284 * A call to this helper is susceptible to change the underlying
1285 * packet buffer. Therefore, at load time, all checks on pointers1285 * packet buffer. Therefore, at load time, all checks on pointers
1286 * previously done by the verifier are invalidated and must be1286 * previously done by the verifier are invalidated and must be
1287 * performed again, if the helper is used in combination with1287 * performed again, if the helper is used in combination with
@@ -1317,7 +1317,7 @@ union bpf_attr { · 29 unmodified lines
1317 * **bpf_skb_pull_data()** to effectively unclone the *skb* from1317 * **bpf_skb_pull_data()** to effectively unclone the *skb* from
1318 * the very beginning in case it is indeed cloned.1318 * the very beginning in case it is indeed cloned.
1319 *1319 *
1320 * A call to this helper is susceptible to change the underlaying1320 * A call to this helper is susceptible to change the underlying
1321 * packet buffer. Therefore, at load time, all checks on pointers1321 * packet buffer. Therefore, at load time, all checks on pointers
1322 * previously done by the verifier are invalidated and must be1322 * previously done by the verifier are invalidated and must be
1323 * performed again, if the helper is used in combination with1323 * performed again, if the helper is used in combination with
@@ -1369,7 +1369,7 @@ union bpf_attr { · 45 unmodified lines
1369 * All values for *flags* are reserved for future usage, and must1369 * All values for *flags* are reserved for future usage, and must
1370 * be left at zero.1370 * be left at zero.
1371 *1371 *
1372 * A call to this helper is susceptible to change the underlaying1372 * A call to this helper is susceptible to change the underlying
1373 * packet buffer. Therefore, at load time, all checks on pointers1373 * packet buffer. Therefore, at load time, all checks on pointers
1374 * previously done by the verifier are invalidated and must be1374 * previously done by the verifier are invalidated and must be
1375 * performed again, if the helper is used in combination with1375 * performed again, if the helper is used in combination with
@@ -1384,7 +1384,7 @@ union bpf_attr { · 8 unmodified lines
1384 * can be used to prepare the packet for pushing or popping1384 * can be used to prepare the packet for pushing or popping
1385 * headers.1385 * headers.
1386 *1386 *
1387 * A call to this helper is susceptible to change the underlaying1387 * A call to this helper is susceptible to change the underlying
1388 * packet buffer. Therefore, at load time, all checks on pointers1388 * packet buffer. Therefore, at load time, all checks on pointers
1389 * previously done by the verifier are invalidated and must be1389 * previously done by the verifier are invalidated and must be
1390 * performed again, if the helper is used in combination with1390 * performed again, if the helper is used in combination with
@@ -1531,7 +1531,7 @@ union bpf_attr { · 140 unmodified lines
1531 * Use with ENCAP_L3/L4 flags to further specify the tunnel1531 * Use with ENCAP_L3/L4 flags to further specify the tunnel
1532 * type; **len** is the length of the inner MAC header.1532 * type; **len** is the length of the inner MAC header.
1533 *1533 *
1534 * A call to this helper is susceptible to change the underlaying1534 * A call to this helper is susceptible to change the underlying
1535 * packet buffer. Therefore, at load time, all checks on pointers1535 * packet buffer. Therefore, at load time, all checks on pointers
1536 * previously done by the verifier are invalidated and must be1536 * previously done by the verifier are invalidated and must be
1537 * performed again, if the helper is used in combination with1537 * performed again, if the helper is used in combination with
@@ -1610,7 +1610,7 @@ union bpf_attr { · 72 unmodified lines
1610 * more flexibility as the user is free to store whatever meta1610 * more flexibility as the user is free to store whatever meta
1611 * data they need.1611 * data they need.
1612 *1612 *
1613 * A call to this helper is susceptible to change the underlaying1613 * A call to this helper is susceptible to change the underlying
1614 * packet buffer. Therefore, at load time, all checks on pointers1614 * packet buffer. Therefore, at load time, all checks on pointers
1615 * previously done by the verifier are invalidated and must be1615 * previously done by the verifier are invalidated and must be
1616 * performed again, if the helper is used in combination with1616 * performed again, if the helper is used in combination with
@@ -1852,7 +1852,7 @@ union bpf_attr { · 235 unmodified lines
1852 * copied if necessary (i.e. if data was not linear and if start1852 * copied if necessary (i.e. if data was not linear and if start
1853 * and end pointers do not point to the same chunk).1853 * and end pointers do not point to the same chunk).
1854 *1854 *
1855 * A call to this helper is susceptible to change the underlaying1855 * A call to this helper is susceptible to change the underlying
1856 * packet buffer. Therefore, at load time, all checks on pointers1856 * packet buffer. Therefore, at load time, all checks on pointers
1857 * previously done by the verifier are invalidated and must be1857 * previously done by the verifier are invalidated and must be
1858 * performed again, if the helper is used in combination with1858 * performed again, if the helper is used in combination with
@@ -1886,7 +1886,7 @@ union bpf_attr { · 27 unmodified lines
1886 * only possible to shrink the packet as of this writing,1886 * only possible to shrink the packet as of this writing,
1887 * therefore *delta* must be a negative integer.1887 * therefore *delta* must be a negative integer.
1888 *1888 *
1889 * A call to this helper is susceptible to change the underlaying1889 * A call to this helper is susceptible to change the underlying
1890 * packet buffer. Therefore, at load time, all checks on pointers1890 * packet buffer. Therefore, at load time, all checks on pointers
1891 * previously done by the verifier are invalidated and must be1891 * previously done by the verifier are invalidated and must be
1892 * performed again, if the helper is used in combination with1892 * performed again, if the helper is used in combination with
@@ -2072,7 +2072,7 @@ union bpf_attr { · 179 unmodified lines
2072 * by bpf programs of types BPF_PROG_TYPE_LWT_IN and2072 * by bpf programs of types BPF_PROG_TYPE_LWT_IN and
2073 * BPF_PROG_TYPE_LWT_XMIT.2073 * BPF_PROG_TYPE_LWT_XMIT.
2074 *2074 *
2075 * A call to this helper is susceptible to change the underlaying2075 * A call to this helper is susceptible to change the underlying
2076 * packet buffer. Therefore, at load time, all checks on pointers2076 * packet buffer. Therefore, at load time, all checks on pointers
2077 * previously done by the verifier are invalidated and must be2077 * previously done by the verifier are invalidated and must be
2078 * performed again, if the helper is used in combination with2078 * performed again, if the helper is used in combination with
@@ -2087,7 +2087,7 @@ union bpf_attr { · 8 unmodified lines
2087 * inside the outermost IPv6 Segment Routing Header can be2087 * inside the outermost IPv6 Segment Routing Header can be
2088 * modified through this helper.2088 * modified through this helper.
2089 *2089 *
2090 * A call to this helper is susceptible to change the underlaying2090 * A call to this helper is susceptible to change the underlying
2091 * packet buffer. Therefore, at load time, all checks on pointers2091 * packet buffer. Therefore, at load time, all checks on pointers
2092 * previously done by the verifier are invalidated and must be2092 * previously done by the verifier are invalidated and must be
2093 * performed again, if the helper is used in combination with2093 * performed again, if the helper is used in combination with
@@ -2103,7 +2103,7 @@ union bpf_attr { · 9 unmodified lines
2103 * after the segments are accepted. *delta* can be as well2103 * after the segments are accepted. *delta* can be as well
2104 * positive (growing) as negative (shrinking).2104 * positive (growing) as negative (shrinking).
2105 *2105 *
2106 * A call to this helper is susceptible to change the underlaying2106 * A call to this helper is susceptible to change the underlying
2107 * packet buffer. Therefore, at load time, all checks on pointers2107 * packet buffer. Therefore, at load time, all checks on pointers
2108 * previously done by the verifier are invalidated and must be2108 * previously done by the verifier are invalidated and must be
2109 * performed again, if the helper is used in combination with2109 * performed again, if the helper is used in combination with
@@ -2132,7 +2132,7 @@ union bpf_attr { · 22 unmodified lines
2132 * encapsulation policy.2132 * encapsulation policy.
2133 * Type of param: **struct ipv6_sr_hdr**.2133 * Type of param: **struct ipv6_sr_hdr**.
2134 *2134 *
2135 * A call to this helper is susceptible to change the underlaying2135 * A call to this helper is susceptible to change the underlying
2136 * packet buffer. Therefore, at load time, all checks on pointers2136 * packet buffer. Therefore, at load time, all checks on pointers
2137 * previously done by the verifier are invalidated and must be2137 * previously done by the verifier are invalidated and must be
2138 * performed again, if the helper is used in combination with2138 * performed again, if the helper is used in combination with