Commit 72b43bde authored by Ji Rongfeng's avatar Ji Rongfeng Committed by Martin KaFai Lau
Browse files

bpf: Update bpf_{g,s}etsockopt() documentation 



* append missing optnames to the end
* simplify bpf_getsockopt()'s doc

Signed-off-by: default avatarJi Rongfeng <SikoJobs@outlook.com>
Link: https://lore.kernel.org/r/DU0P192MB15479B86200B1216EC90E162D6099@DU0P192MB1547.EURP192.PROD.OUTLOOK.COM


Signed-off-by: default avatarMartin KaFai Lau <martin.lau@kernel.org>
parent 539886a3

include/uapi/linux/bpf.h

+12 −9
Original line number Diff line number Diff line
@@ -2584,14 +2584,19 @@ union bpf_attr { 
 * 		* **SOL_SOCKET**, which supports the following *optname*\ s:

 * 		  **SO_RCVBUF**, **SO_SNDBUF**, **SO_MAX_PACING_RATE**,

 * 		  **SO_PRIORITY**, **SO_RCVLOWAT**, **SO_MARK**,

 * 		  **SO_BINDTODEVICE**, **SO_KEEPALIVE**.

 * 		  **SO_BINDTODEVICE**, **SO_KEEPALIVE**, **SO_REUSEADDR**,

 * 		  **SO_REUSEPORT**, **SO_BINDTOIFINDEX**, **SO_TXREHASH**.

 * 		* **IPPROTO_TCP**, which supports the following *optname*\ s:

 * 		  **TCP_CONGESTION**, **TCP_BPF_IW**,

 * 		  **TCP_BPF_SNDCWND_CLAMP**, **TCP_SAVE_SYN**,

 * 		  **TCP_KEEPIDLE**, **TCP_KEEPINTVL**, **TCP_KEEPCNT**,

 *		  **TCP_SYNCNT**, **TCP_USER_TIMEOUT**, **TCP_NOTSENT_LOWAT**.

 * 		  **TCP_SYNCNT**, **TCP_USER_TIMEOUT**, **TCP_NOTSENT_LOWAT**,

 * 		  **TCP_NODELAY**, **TCP_MAXSEG**, **TCP_WINDOW_CLAMP**,

 * 		  **TCP_THIN_LINEAR_TIMEOUTS**, **TCP_BPF_DELACK_MAX**,

 * 		  **TCP_BPF_RTO_MIN**.

 * 		* **IPPROTO_IP**, which supports *optname* **IP_TOS**.

 * 		* **IPPROTO_IPV6**, which supports *optname* **IPV6_TCLASS**.

 * 		* **IPPROTO_IPV6**, which supports the following *optname*\ s:

 * 		  **IPV6_TCLASS**, **IPV6_AUTOFLOWLABEL**.

 * 	Return

 * 		0 on success, or a negative error in case of failure.

 *
@@ -2808,12 +2813,10 @@ union bpf_attr { 
 * 		  and **BPF_CGROUP_INET6_CONNECT**.

 *

 * 		This helper actually implements a subset of **getsockopt()**.

 * 		It supports the following *level*\ s:

 *

 * 		* **IPPROTO_TCP**, which supports *optname*

 * 		  **TCP_CONGESTION**.

 * 		* **IPPROTO_IP**, which supports *optname* **IP_TOS**.

 * 		* **IPPROTO_IPV6**, which supports *optname* **IPV6_TCLASS**.

 * 		It supports the same set of *optname*\ s that is supported by

 * 		the **bpf_setsockopt**\ () helper.  The exceptions are

 * 		**TCP_BPF_*** is **bpf_setsockopt**\ () only and

 * 		**TCP_SAVED_SYN** is **bpf_getsockopt**\ () only.

 * 	Return

 * 		0 on success, or a negative error in case of failure.

 *

tools/include/uapi/linux/bpf.h

+13 −10
Original line number Diff line number Diff line
@@ -2584,14 +2584,19 @@ union bpf_attr { 
 * 		* **SOL_SOCKET**, which supports the following *optname*\ s:

 * 		  **SO_RCVBUF**, **SO_SNDBUF**, **SO_MAX_PACING_RATE**,

 * 		  **SO_PRIORITY**, **SO_RCVLOWAT**, **SO_MARK**,

 * 		  **SO_BINDTODEVICE**, **SO_KEEPALIVE**.

 * 		  **SO_BINDTODEVICE**, **SO_KEEPALIVE**, **SO_REUSEADDR**,

 * 		  **SO_REUSEPORT**, **SO_BINDTOIFINDEX**, **SO_TXREHASH**.

 * 		* **IPPROTO_TCP**, which supports the following *optname*\ s:

 * 		  **TCP_CONGESTION**, **TCP_BPF_IW**,

 * 		  **TCP_BPF_SNDCWND_CLAMP**, **TCP_SAVE_SYN**,

 * 		  **TCP_KEEPIDLE**, **TCP_KEEPINTVL**, **TCP_KEEPCNT**,

 *		  **TCP_SYNCNT**, **TCP_USER_TIMEOUT**, **TCP_NOTSENT_LOWAT**.

 * 		  **TCP_SYNCNT**, **TCP_USER_TIMEOUT**, **TCP_NOTSENT_LOWAT**,

 * 		  **TCP_NODELAY**, **TCP_MAXSEG**, **TCP_WINDOW_CLAMP**,

 * 		  **TCP_THIN_LINEAR_TIMEOUTS**, **TCP_BPF_DELACK_MAX**,

 * 		  **TCP_BPF_RTO_MIN**.

 * 		* **IPPROTO_IP**, which supports *optname* **IP_TOS**.

 * 		* **IPPROTO_IPV6**, which supports *optname* **IPV6_TCLASS**.

 * 		* **IPPROTO_IPV6**, which supports the following *optname*\ s:

 * 		  **IPV6_TCLASS**, **IPV6_AUTOFLOWLABEL**.

 * 	Return

 * 		0 on success, or a negative error in case of failure.

 *
@@ -2647,7 +2652,7 @@ union bpf_attr { 
 * 	Return

 * 		0 on success, or a negative error in case of failure.

 *

 * long bpf_redirect_map(struct bpf_map *map, u32 key, u64 flags)

 * long bpf_redirect_map(struct bpf_map *map, u64 key, u64 flags)

 * 	Description

 * 		Redirect the packet to the endpoint referenced by *map* at

 * 		index *key*. Depending on its type, this *map* can contain
@@ -2808,12 +2813,10 @@ union bpf_attr { 
 * 		  and **BPF_CGROUP_INET6_CONNECT**.

 *

 * 		This helper actually implements a subset of **getsockopt()**.

 * 		It supports the following *level*\ s:

 *

 * 		* **IPPROTO_TCP**, which supports *optname*

 * 		  **TCP_CONGESTION**.

 * 		* **IPPROTO_IP**, which supports *optname* **IP_TOS**.

 * 		* **IPPROTO_IPV6**, which supports *optname* **IPV6_TCLASS**.

 * 		It supports the same set of *optname*\ s that is supported by

 * 		the **bpf_setsockopt**\ () helper.  The exceptions are

 * 		**TCP_BPF_*** is **bpf_setsockopt**\ () only and

 * 		**TCP_SAVED_SYN** is **bpf_getsockopt**\ () only.

 * 	Return

 * 		0 on success, or a negative error in case of failure.

 *