bpf: More sock_ops callbacks
Subsystems (8)
v5 cover bpf: More sock_ops callbacks
This patchset adds support for:
- direct R or R/W access to many tcp_sock fields
- passing up to 4 arguments to sock_ops BPF functions
- tcp_sock field bpf_sock_ops_flags for controlling callbacks
- optionally calling sock_ops BPF program when RTO fires
- optionally calling sock_ops BPF program when packet is retransmitted
- optionally calling sock_ops BPF program when TCP state changes
- access to tclass and sk_txhash
- new selftest
v2: Fixed commit message 0/11. The commit is to "bpf-next" but the patch
below used "bpf" and Patchwork didn't work correctly.
v3: Cleaned RTO callback as per Yuchung's comment
Added BPF enum for TCP states as per Alexei's comment
v4: Fixed compile warnings related to detecting changes between TCP
internal states and the BPF defined states.
v5: Fixed comment issues in some selftest files
Fixed accesss issue with u64 fields in bpf_sock_ops struct
Consists of the following patches:
[PATCH bpf-next v5 01/11] bpf: Make SOCK_OPS_GET_TCP size independent [PATCH bpf-next v5 02/11] bpf: Make SOCK_OPS_GET_TCP struct [PATCH bpf-next v5 03/11] bpf: Add write access to tcp_sock and sock [PATCH bpf-next v5 04/11] bpf: Support passing args to sock_ops bpf [PATCH bpf-next v5 05/11] bpf: Adds field bpf_sock_ops_flags to [PATCH bpf-next v5 06/11] bpf: Add sock_ops RTO callback [PATCH bpf-next v5 07/11] bpf: Add support for reading sk_state and [PATCH bpf-next v5 08/11] bpf: Add sock_ops R/W access to tclass & [PATCH bpf-next v5 09/11] bpf: Add BPF_SOCK_OPS_RETRANS_CB [PATCH bpf-next v5 10/11] bpf: Add BPF_SOCK_OPS_STATE_CB [PATCH bpf-next v5 11/11] bpf: add selftest for tcpbpf
include/linux/filter.h | 4 + include/linux/tcp.h | 8 + include/net/tcp.h | 66 ++++++++- include/uapi/linux/bpf.h | 61 +++++++- include/uapi/linux/tcp.h | 5 + net/core/filter.c | 254 +++++++++++++++++++++++++++++--- net/ipv4/tcp.c | 26 +++- net/ipv4/tcp_nv.c | 2 +- net/ipv4/tcp_output.c | 5 +- net/ipv4/tcp_timer.c | 7 + tools/include/uapi/linux/bpf.h | 70 ++++++++- tools/testing/selftests/bpf/Makefile | 5 +- tools/testing/selftests/bpf/tcp_client.py | 52 +++++++ tools/testing/selftests/bpf/tcp_server.py | 79 ++++++++++ tools/testing/selftests/bpf/test_tcpbpf.h | 14 ++ tools/testing/selftests/bpf/test_tcpbpf_kern.c | 109 ++++++++++++++ tools/testing/selftests/bpf/test_tcpbpf_user.c | 103 +++++++++++++ 17 files changed, 833 insertions(+), 37 deletions(-)
PATCH v5 1/11 bpf: Make SOCK_OPS_GET_TCP size independent
Make SOCK_OPS_GET_TCP helper macro size independent (before only worked with 4-byte fields.
--- net/core/filter.c | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-)
net/core/filter.c +8 -5
@@ -4468,9 +4468,10 @@ static u32 sock_ops_convert_ctx_access(enum bpf_access_type type,break ;/* Helper macro for adding read access to tcp_sock fields. */ -#define SOCK_OPS_GET_TCP32 (FIELD_NAME ) \ +#define SOCK_OPS_GET_TCP (FIELD_NAME ) \ do { \ - BUILD_BUG_ON(FIELD_SIZEOF(struct tcp_sock, FIELD_NAME) != 4); \ + BUILD_BUG_ON(FIELD_SIZEOF(struct tcp_sock, FIELD_NAME) > \ + FIELD_SIZEOF(struct bpf_sock_ops, FIELD_NAME)); \ *insn++ = BPF_LDX_MEM(BPF_FIELD_SIZEOF( \ struct bpf_sock_ops_kern, \ is_fullsock), \
@@ -4482,16 +4483,18 @@ static u32 sock_ops_convert_ctx_access(enum bpf_access_type type, struct bpf_sock_ops_kern, sk),\ si->dst_reg, si->src_reg, \ offsetof(struct bpf_sock_ops_kern, sk));\ - *insn++ =BPF_LDX_MEM (BPF_W , si->dst_reg, si->dst_reg, \ + *insn++ = BPF_LDX_MEM(FIELD_SIZEOF(struct tcp_sock, \ +FIELD_NAME ), si->dst_reg, \ + si->dst_reg, \ offsetof(struct tcp_sock , FIELD_NAME)); \ }while (0 )case offsetof(struct bpf_sock_ops , snd_cwnd): -SOCK_OPS_GET_TCP32 (snd_cwnd); +SOCK_OPS_GET_TCP (snd_cwnd);break ;case offsetof(struct bpf_sock_ops , srtt_us): -SOCK_OPS_GET_TCP32 (srtt_us); +SOCK_OPS_GET_TCP (srtt_us);break ; }return insn - insn_buf;
Signature · 1 line
2.9.5
PATCH v5 2/11 bpf: Make SOCK_OPS_GET_TCP struct independent
In reply to Lawrence BrakmoChanged SOCK_OPS_GET_TCP to SOCK_OPS_GET_FIELD and added 2 arguments so now it can also work with struct sock fields. The first argument is the name of the field in the bpf_sock_ops struct, the 2nd argument is the name of the field in the OBJ struct.
Previous: SOCK_OPS_GET_TCP(FIELD_NAME) New: SOCK_OPS_GET_FIELD(BPF_FIELD, OBJ_FIELD, OBJ)
Where OBJ is either "struct tcp_sock" or "struct sock" (without quotation). BPF_FIELD is the name of the field in the bpf_sock_ops struct and OBJ_FIELD is the name of the field in the OBJ struct.
Although the field names are currently the same, the kernel struct names could change in the future and this change makes it easier to support that.
Note that adding access to tcp_sock fields in sock_ops programs does not preclude the tcp_sock fields from being removed as long as we are willing to do one of the following:
1) Return a fixed value (e.x. 0 or 0xffffffff), or
2) Make the verifier fail if that field is accessed (i.e. program fails to load) so the user will know that field is no longer supported.
--- net/core/filter.c | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-)
net/core/filter.c +10 -10
@@ -4467,11 +4467,11 @@ static u32 sock_ops_convert_ctx_access(enum bpf_access_type type, is_fullsock));break ; -/* Helper macro for adding read access to tcp_sock fields. */ -#define SOCK_OPS_GET_TCP (FIELD_NAME ) \ +/* Helper macro for adding read access to tcp_sock or sock fields. */ +#define SOCK_OPS_GET_FIELD (BPF_FIELD ,OBJ_FIELD ,OBJ ) \ do { \ - BUILD_BUG_ON(FIELD_SIZEOF(struct tcp_sock, FIELD_NAME) > \ - FIELD_SIZEOF(struct bpf_sock_ops, FIELD_NAME)); \ + BUILD_BUG_ON(FIELD_SIZEOF(OBJ, OBJ_FIELD) > \ + FIELD_SIZEOF(struct bpf_sock_ops, BPF_FIELD)); \ *insn++ = BPF_LDX_MEM(BPF_FIELD_SIZEOF( \ struct bpf_sock_ops_kern, \ is_fullsock), \
@@ -4483,18 +4483,18 @@ static u32 sock_ops_convert_ctx_access(enum bpf_access_type type, struct bpf_sock_ops_kern, sk),\ si->dst_reg, si->src_reg, \ offsetof(struct bpf_sock_ops_kern, sk));\ - *insn++ = BPF_LDX_MEM(FIELD_SIZEOF(struct tcp_sock, \ -FIELD_NAME ), si->dst_reg, \ - si->dst_reg, \ - offsetof(struct tcp_sock , FIELD_NAME)); \ + *insn++ =BPF_LDX_MEM (BPF_FIELD_SIZEOF (OBJ , \ +OBJ_FIELD ), \ + si->dst_reg, si->dst_reg, \ + offsetof(OBJ , OBJ_FIELD)); \ }while (0 )case offsetof(struct bpf_sock_ops , snd_cwnd): -SOCK_OPS_GET_TCP (snd_cwnd); + SOCK_OPS_GET_FIELD(snd_cwnd, snd_cwnd, struct tcp_sock);break ;case offsetof(struct bpf_sock_ops , srtt_us): -SOCK_OPS_GET_TCP (srtt_us); + SOCK_OPS_GET_FIELD(srtt_us, srtt_us, struct tcp_sock);break ; }return insn - insn_buf;
Signature · 1 line
2.9.5
PATCH v5 3/11 bpf: Add write access to tcp_sock and sock fields
In reply to Lawrence BrakmoThis patch adds a macro, SOCK_OPS_SET_FIELD, for writing to struct tcp_sock or struct sock fields. This required adding a new field "temp" to struct bpf_sock_ops_kern for temporary storage that is used by sock_ops_convert_ctx_access. It is used to store and recover the contents of a register, so the register can be used to store the address of the sk. Since we cannot overwrite the dst_reg because it contains the pointer to ctx, nor the src_reg since it contains the value we want to store, we need an extra register to contain the address of the sk.
Also adds the macro SOCK_OPS_GET_OR_SET_FIELD that calls one of the GET or SET macros depending on the value of the TYPE field.
--- include/linux/filter.h | 3 +++ include/net/tcp.h | 2 +- net/core/filter.c | 48 ++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 52 insertions(+), 1 deletion(-)
include/linux/filter.h +3 -0
@@ -1007,6 +1007,9 @@ struct bpf_sock_ops_kern { u32 replylong[4]; };u32 is_fullsock; +u64 temp;/* Used by sock_ops_convert_ctx_access +* as temporary storaage of a register +*/ };#endif /* __LINUX_FILTER_H__ */
include/net/tcp.h +1 -1
@@ -2010,7 +2010,7 @@ static inline int tcp_call_bpf(struct sock *sk, int op)struct bpf_sock_ops_kern sock_ops;int ret; -memset (&sock_ops,0 ,sizeof (sock_ops)); +memset (&sock_ops,0 , offsetof(struct bpf_sock_ops_kern , temp));if (sk_fullsock (sk)) { sock_ops.is_fullsock =1 ;sock_owned_by_me (sk);
net/core/filter.c +48 -0
54 lines not on this page · raw message
Signature · 1 line
2.9.5
Re: [PATCH bpf-next v5 03/11] bpf: Add write access to tcp_sock and sock fields
Quoted 25 lines · Lawrence Brakmo
This patch adds a macro,
SOCK_OPS_SET_FIELD, for writing to structtcp_sockor struct sock fields. This required adding a new field "temp" to structbpf_sock_ops_kernfor temporary storage that is used bysock_ops_convert_ctx_access. It is used to store and recover the contents of a register, so the register can be used to store the address of the sk. Since we cannot overwrite thedst_regbecause it contains the pointer to ctx, nor thesrc_regsince it contains the value we want to store, we need an extra register to contain the address of the sk.Also adds the macro
SOCK_OPS_GET_OR_SET_FIELDthat calls one of the GET or SET macros depending on the value of the TYPE field.Signed-off-by Lawrence Brakmo <[email protected]>--- include/linux/filter.h | 3 +++ include/net/tcp.h | 2 +- net/core/filter.c | 48 ++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 52 insertions(+), 1 deletion(-)include/linux/filter.h +0
-0
include/linux/filter.h struct bpf_sock_ops_kern { · line 1011
Quoted 5 lines
include/linux/filter.h +2
-0@@ -1007,6 +1007,9 @@ struct bpf_sock_ops_kern {u32 replylong[4 ]; };u32 is_fullsock; +u64 temp;/* Used by sock_ops_convert_ctx_access +* as temporary storaage of a register
typo on storage
Quoted 9 lines
include/linux/filter.h +1
-0+ */ };#endif /* __LINUX_FILTER_H__ */ include/net/tcp.h +0
-0
include/net/tcp.h static inline int tcp_call_bpf(struct sock *sk, int op) · line 2014
Quoted 6 lines
include/net/tcp.h +1
-1@@ -2010,7 +2010,7 @@ static inline int tcp_call_bpf(struct sock *sk, int op)struct bpf_sock_ops_kern sock_ops;int ret; -memset (&sock_ops,0 ,sizeof (sock_ops)); +memset (&sock_ops,0 , offsetof(struct bpf_sock_ops_kern , temp));
This lacks proper comment, stating that every field added after .temp in struct bpf_sock_ops_kern is considered as scratch and could contain garbage.
Re: [PATCH bpf-next v5 03/11] bpf: Add write access to tcp_sock and sock fields
On 1/9/18, 3:22 PM, "[email protected] on behalf of Eric Dumazet" <[email protected] on behalf of [email protected]> wrote:
On Tue, 2018-01-09 at 13:06 -0800, Lawrence Brakmo wrote:
> This patch adds a macro, SOCK_OPS_SET_FIELD, for writing to
> struct tcp_sock or struct sock fields. This required adding a new
> field "temp" to struct bpf_sock_ops_kern for temporary storage that
> is used by sock_ops_convert_ctx_access. It is used to store and recover
> the contents of a register, so the register can be used to store the
> address of the sk. Since we cannot overwrite the dst_reg because it
> contains the pointer to ctx, nor the src_reg since it contains the value
> we want to store, we need an extra register to contain the address
> of the sk.
>
> Also adds the macro SOCK_OPS_GET_OR_SET_FIELD that calls one of the
> GET or SET macros depending on the value of the TYPE field.
>
> Signed-off-by: Lawrence Brakmo <[email protected]>
> ---
> include/linux/filter.h | 3 +++
> include/net/tcp.h | 2 +-
> net/core/filter.c | 48 ++++++++++++++++++++++++++++++++++++++++++++++++
> 3 files changed, 52 insertions(+), 1 deletion(-)
>
> diff --git a/include/linux/filter.h b/include/linux/filter.h
> index 425056c..139a9a3 100644
> --- a/include/linux/filter.h
> +++ b/include/linux/filter.h
> @@ -1007,6 +1007,9 @@ struct bpf_sock_ops_kern {
> u32 replylong[4];
> };
> u32 is_fullsock;
> + u64 temp; /* Used by sock_ops_convert_ctx_access
> + * as temporary storaage of a register
typo on storageThanks, will fix.
Quoted 9 lines
include/linux/filter.h +1
-0+ */ };#endif /* __LINUX_FILTER_H__ */ include/net/tcp.h +0
-0
include/net/tcp.h static inline int tcp_call_bpf(struct sock *sk, int op) · line 2014
Quoted 6 lines
include/net/tcp.h +1
-1@@ -2010,7 +2010,7 @@ static inline int tcp_call_bpf(struct sock *sk, int op)struct bpf_sock_ops_kern sock_ops;int ret; -memset (&sock_ops,0 ,sizeof (sock_ops)); +memset (&sock_ops,0 , offsetof(struct bpf_sock_ops_kern , temp));
This lacks proper comment, stating that every field added after .temp in struct bpf_sock_ops_kern is considered as scratch and could contain garbage.
I assumed that one would modify this initialization appropriately when adding a new field. But it would certainly make sense to indicate that new, non-scratch, fields should be added before temp so there would be no need to modify this initialization code. Makes sense?
PATCH v5 4/11 bpf: Support passing args to sock_ops bpf function
In reply to Lawrence BrakmoAdds support for passing up to 4 arguments to sock_ops bpf functions. It reusues the reply union, so the bpf_sock_ops structures are not increased in size.
--- include/linux/filter.h | 1 + include/net/tcp.h | 64 ++++++++++++++++++++++++++++++++++++++++++++---- include/uapi/linux/bpf.h | 5 ++-- net/ipv4/tcp.c | 2 +- net/ipv4/tcp_nv.c | 2 +- net/ipv4/tcp_output.c | 2 +- 6 files changed, 66 insertions(+), 10 deletions(-)
include/linux/filter.h +1 -0
@@ -1003,6 +1003,7 @@ struct bpf_sock_ops_kern {struct sock *sk;u32 op;union { +u32 args[4 ];u32 reply;u32 replylong[4 ]; };
include/net/tcp.h +59 -5
104 lines not on this page · raw message
include/uapi/linux/bpf.h +3 -2
@@ -948,8 +948,9 @@ struct bpf_map_info {struct bpf_sock_ops {__u32 op;union { -__u32 reply; -__u32 replylong[4 ]; +__u32 args[4 ];/* Optionally passed to bpf program */ +__u32 reply;/* Returned by bpf program */ +__u32 replylong[4 ];/* Optionally returned by bpf prog */ };__u32 family;__u32 remote_ip4;/* Stored in network byte order */
net/ipv4/tcp.c +1 -1
@@ -463,7 +463,7 @@ void tcp_init_transfer(struct sock *sk, int bpf_op)tcp_mtup_init (sk); icsk->icsk_af_ops->rebuild_header (sk);tcp_init_metrics (sk); -tcp_call_bpf (sk, bpf_op); +tcp_call_bpf (sk, bpf_op,0 ,NULL );tcp_init_congestion_control (sk);tcp_init_buffer_space (sk); }
net/ipv4/tcp_nv.c +1 -1
@@ -146,7 +146,7 @@ static void tcpnv_init(struct sock *sk)* within a datacenter, where we have reasonable estimates of * RTTs */ - base_rtt =tcp_call_bpf (sk,BPF_SOCK_OPS_BASE_RTT ); + base_rtt =tcp_call_bpf (sk,BPF_SOCK_OPS_BASE_RTT ,0 ,NULL );if (base_rtt >0 ) { ca->nv_base_rtt = base_rtt; ca->nv_lower_bound_rtt = (base_rtt *205 ) >>8 ;/* 80% */
net/ipv4/tcp_output.c +1 -1
@@ -3468,7 +3468,7 @@ int tcp_connect(struct sock *sk)struct sk_buff *buff;int err; -tcp_call_bpf (sk,BPF_SOCK_OPS_TCP_CONNECT_CB ); +tcp_call_bpf (sk,BPF_SOCK_OPS_TCP_CONNECT_CB ,0 ,NULL );if (inet_csk (sk)->icsk_af_ops->rebuild_header (sk))return -EHOSTUNREACH ;/* Routing failure or similar. */
Signature · 1 line
2.9.5
PATCH v5 5/11 bpf: Adds field bpf_sock_ops_flags to tcp_sock
In reply to Lawrence BrakmoAdds field bpf_sock_ops_flags to tcp_sock and bpf_sock_ops. Its primary use is to determine if there should be calls to sock_ops bpf program at various points in the TCP code. The field is initialized to zero, disabling the calls. A sock_ops BPF program can set, per connection and as necessary, when the connection is established.
It also adds support for reading and writting the field within a sock_ops BPF program.
Examples of where to call the bpf program:
1) When RTO fires
2) When a packet is retransmitted
3) When the connection terminates
4) When a packet is sent
5) When a packet is received
--- include/linux/tcp.h | 8 ++++++++ include/uapi/linux/bpf.h | 1 + net/core/filter.c | 7 +++++++ 3 files changed, 16 insertions(+)
include/linux/tcp.h +8 -0
@@ -373,6 +373,14 @@ struct tcp_sock {*/ struct request_sock *fastopen_rsk;u32 *saved_syn; + +/* Sock_ops bpf program related variables */ +#ifdef CONFIG_BPF +u32 bpf_sock_ops_flags;/* values defined in uapi/linux/tcp.h */ +#define BPF_SOCK_OPS_TEST_FLAG (TP ,ARG ) (TP->bpf_sock_ops_flags & ARG) +#else +#define BPF_SOCK_OPS_TEST_FLAG (TP ,ARG ) 0 +#endif };enum tsq_enum {
include/uapi/linux/bpf.h +1 -0
@@ -965,6 +965,7 @@ struct bpf_sock_ops {*/ __u32 snd_cwnd;__u32 srtt_us;/* Averaged RTT << 3 in usecs */ +__u32 bpf_sock_ops_flags;/* flags defined in uapi/linux/tcp.h */ };/* List of known BPF sock_ops operators.
net/core/filter.c +7 -0
@@ -3843,6 +3843,7 @@ static bool sock_ops_is_valid_access(int off, int size,switch (off) { case offsetof(struct bpf_sock_ops, op) ... offsetof(struct bpf_sock_ops, replylong[3]): +case offsetof(struct bpf_sock_ops , bpf_sock_ops_flags):break ;default :return false;
@@ -4544,6 +4545,12 @@ static u32 sock_ops_convert_ctx_access(enum bpf_access_type type,case offsetof(struct bpf_sock_ops , srtt_us): SOCK_OPS_GET_FIELD(srtt_us, srtt_us, struct tcp_sock);break ; + +case offsetof(struct bpf_sock_ops , bpf_sock_ops_flags): +SOCK_OPS_GET_OR_SET_FIELD (bpf_sock_ops_flags, + bpf_sock_ops_flags, + struct tcp_sock, type); +break ; }return insn - insn_buf; }
Signature · 1 line
2.9.5
Re: [PATCH bpf-next v5 05/11] bpf: Adds field bpf_sock_ops_flags to tcp_sock
Quoted 32 lines · Lawrence Brakmo
Adds field
bpf_sock_ops_flagstotcp_sockandbpf_sock_ops. Its primary use is to determine if there should be calls tosock_opsbpf program at various points in the TCP code. The field is initialized to zero, disabling the calls. Asock_opsBPF program can set, per connection and as necessary, when the connection is established.It also adds support for reading and writting the field within a
sock_opsBPF program.Examples of where to call the bpf program:
1) When RTO fires
2) When a packet is retransmitted
3) When the connection terminates
4) When a packet is sent
5) When a packet is receivedSigned-off-by Lawrence Brakmo <[email protected]>--- include/linux/tcp.h | 8 ++++++++ include/uapi/linux/bpf.h | 1 + net/core/filter.c | 7 +++++++ 3 files changed, 16 insertions(+)include/linux/tcp.h +0
-0@@ -373,6 +373,14 @@ struct tcp_sock {*/ struct request_sock *fastopen_rsk;u32 *saved_syn;
include/linux/tcp.h struct tcp_sock { · line 385
Quoted 10 lines
include/linux/tcp.h +8
-0+ +/* Sock_ops bpf program related variables */ +#ifdef CONFIG_BPF +u32 bpf_sock_ops_flags;/* values defined in uapi/linux/tcp.h */ +#define BPF_SOCK_OPS_TEST_FLAG (TP ,ARG ) (TP->bpf_sock_ops_flags & ARG) +#else +#define BPF_SOCK_OPS_TEST_FLAG (TP ,ARG ) 0 +#endif };
It looks like we add yet another TCP socket field for some feature that
is only used by you or FB :/
At least please try to fill a hole (on 64bit kernels), instead of adding one more.
Also, should not we reject attempts to use bits that are not yet supported by the kernel ?
If a BPF filter expects to be called for every retransmit, but kernel is too old, this wont work.
Re: [PATCH bpf-next v5 05/11] bpf: Adds field bpf_sock_ops_flags to tcp_sock
On 1/9/18, 3:31 PM, "Eric Dumazet" <[email protected]> wrote:
On Tue, 2018-01-09 at 13:06 -0800, Lawrence Brakmo wrote:
> Adds field bpf_sock_ops_flags to tcp_sock and bpf_sock_ops. Its primary
> use is to determine if there should be calls to sock_ops bpf program at
> various points in the TCP code. The field is initialized to zero,
> disabling the calls. A sock_ops BPF program can set, per connection and
> as necessary, when the connection is established.
>
> It also adds support for reading and writting the field within a
> sock_ops BPF program.
>
> Examples of where to call the bpf program:
>
> 1) When RTO fires
> 2) When a packet is retransmitted
> 3) When the connection terminates
> 4) When a packet is sent
> 5) When a packet is received
>
> Signed-off-by: Lawrence Brakmo <[email protected]>
> ---
> include/linux/tcp.h | 8 ++++++++
> include/uapi/linux/bpf.h | 1 +
> net/core/filter.c | 7 +++++++
> 3 files changed, 16 insertions(+)
>
> diff --git a/include/linux/tcp.h b/include/linux/tcp.h
> index 4f93f095..62f4388 100644
> --- a/include/linux/tcp.h
> +++ b/include/linux/tcp.h
> @@ -373,6 +373,14 @@ struct tcp_sock {
> */
> struct request_sock *fastopen_rsk;
> u32 *saved_syn;
> +
> +/* Sock_ops bpf program related variables */
> +#ifdef CONFIG_BPF
> + u32 bpf_sock_ops_flags; /* values defined in uapi/linux/tcp.h */
> +#define BPF_SOCK_OPS_TEST_FLAG(TP, ARG) (TP->bpf_sock_ops_flags & ARG)
> +#else
> +#define BPF_SOCK_OPS_TEST_FLAG(TP, ARG) 0
> +#endif
> };
>
It looks like we add yet another TCP socket field for some feature that
is only used by you or FB :/I am certainly hoping it will be used by others as well, but it is not possible until it is available (many people expressed interest at Netdev 2.2).
At least please try to fill a hole (on 64bit kernels), instead of adding one more.
Makes sense.
Also, should not we reject attempts to use bits that are not yet supported by the kernel ?
If a BPF filter expects to be called for every retransmit, but kernel is too old, this wont work.
Thanks, good point. I will add a helper function that returns which callbacks are supported by the current kernel so the bpf program can take appropriate action.
Eric, thank you for the feedback.
PATCH v5 6/11 bpf: Add sock_ops RTO callback
In reply to Lawrence BrakmoAdds an optional call to sock_ops BPF program based on whether the BPF_SOCK_OPS_RTO_CB_FLAG is set in bpf_sock_ops_flags.
The BPF program is passed 2 arguments: icsk_retransmits and whether the RTO has expired.
--- include/uapi/linux/bpf.h | 5 +++++ include/uapi/linux/tcp.h | 3 +++ net/ipv4/tcp_timer.c | 7 +++++++ 3 files changed, 15 insertions(+)
include/uapi/linux/bpf.h +5 -0
@@ -1001,6 +1001,11 @@ enum {* a congestion threshold. RTTs above * this indicate congestion */ + BPF_SOCK_OPS_RTO_CB, /* Called when an RTO has triggered. +* Arg1: value of icsk_retransmits +* Arg2: value of icsk_rto +* Arg3: whether RTO has expired +*/ };#define TCP_BPF_IW 1001/* Set TCP initial congestion window */
include/uapi/linux/tcp.h +3 -0
@@ -259,6 +259,9 @@ struct tcp_md5sig {__u8 tcpm_key[TCP_MD5SIG_MAXKEYLEN ];/* key (binary) */ }; +/* Definitions for bpf_sock_ops_flags */ +#define BPF_SOCK_OPS_RTO_CB_FLAG (1<<0) +/* INET_DIAG_MD5SIG */ struct tcp_diag_md5sig {__u8 tcpm_family;
net/ipv4/tcp_timer.c +7 -0
@@ -213,11 +213,18 @@ static int tcp_write_timeout(struct sock *sk) icsk->icsk_user_timeout); }tcp_fastopen_active_detect_blackhole (sk, expired); + +if (BPF_SOCK_OPS_TEST_FLAG (tp,BPF_SOCK_OPS_RTO_CB_FLAG )) +tcp_call_bpf_3arg (sk,BPF_SOCK_OPS_RTO_CB , + icsk->icsk_retransmits, + icsk->icsk_rto, (int )expired); +if (expired) {/* Has it gone just too far? */ tcp_write_err (sk);return 1 ; } +return 0 ; }
Signature · 1 line
2.9.5
PATCH v5 7/11 bpf: Add support for reading sk_state and more
In reply to Lawrence BrakmoAdd support for reading many more tcp_sock fields
state, same as sk->sk_state
rtt_min same as sk->rtt_min.s[0].v (current rtt_min)
snd_ssthresh
rcv_nxt
snd_nxt
snd_una
mss_cache
ecn_flags
rate_delivered
rate_interval_us
packets_out
retrans_out
total_retrans
segs_in
data_segs_in
segs_out
data_segs_out
bytes_received (__u64)
bytes_acked (__u64)
--- include/uapi/linux/bpf.h | 19 +++++++ net/core/filter.c | 136 ++++++++++++++++++++++++++++++++++++++++++----- 2 files changed, 141 insertions(+), 14 deletions(-)
include/uapi/linux/bpf.h +19 -0
@@ -966,6 +966,25 @@ struct bpf_sock_ops {__u32 snd_cwnd;__u32 srtt_us;/* Averaged RTT << 3 in usecs */ __u32 bpf_sock_ops_flags;/* flags defined in uapi/linux/tcp.h */ +__u32 state; +__u32 rtt_min; +__u32 snd_ssthresh; +__u32 rcv_nxt; +__u32 snd_nxt; +__u32 snd_una; +__u32 mss_cache; +__u32 ecn_flags; +__u32 rate_delivered; +__u32 rate_interval_us; +__u32 packets_out; +__u32 retrans_out; +__u32 total_retrans; +__u32 segs_in; +__u32 data_segs_in; +__u32 segs_out; +__u32 data_segs_out; +__u64 bytes_received; +__u64 bytes_acked; };/* List of known BPF sock_ops operators.
net/core/filter.c +122 -14
169 lines not on this page · raw message
Signature · 1 line
2.9.5
PATCH v5 8/11 bpf: Add sock_ops R/W access to tclass & sk_txhash
In reply to Lawrence BrakmoAdds direct R/W access to sk_txhash and access to tclass for ipv6 flows through getsockopt and setsockopt. Sample usage for tclass:
bpf_getsockopt(skops, SOL_IPV6, IPV6_TCLASS, &v, sizeof(v))
where skops is a pointer to the ctx (struct bpf_sock_ops).
--- include/uapi/linux/bpf.h | 1 + net/core/filter.c | 48 +++++++++++++++++++++++++++++++++++++++++++++++- 2 files changed, 48 insertions(+), 1 deletion(-)
include/uapi/linux/bpf.h +1 -0
@@ -985,6 +985,7 @@ struct bpf_sock_ops {__u32 data_segs_out;__u64 bytes_received;__u64 bytes_acked; +__u32 sk_txhash; };/* List of known BPF sock_ops operators.
net/core/filter.c +47 -1
78 lines not on this page · raw message
Signature · 1 line
2.9.5
PATCH v5 9/11 bpf: Add BPF_SOCK_OPS_RETRANS_CB
In reply to Lawrence BrakmoAdds support for calling sock_ops BPF program when there is a retransmission. Two arguments are used; one for the sequence number and other for the number of segments retransmitted. Does not include syn-ack retransmissions.
New op: BPF_SOCK_OPS_RETRANS_CB.
--- include/uapi/linux/bpf.h | 4 ++++ include/uapi/linux/tcp.h | 1 + net/ipv4/tcp_output.c | 3 +++ 3 files changed, 8 insertions(+)
include/uapi/linux/bpf.h +4 -0
@@ -1026,6 +1026,10 @@ enum {* Arg2: value of icsk_rto * Arg3: whether RTO has expired */ + BPF_SOCK_OPS_RETRANS_CB, /* Called when skb is retransmitted. +* Arg1: sequence number of 1st byte +* Arg2: # segments +*/ };#define TCP_BPF_IW 1001/* Set TCP initial congestion window */
include/uapi/linux/tcp.h +1 -0
@@ -261,6 +261,7 @@ struct tcp_md5sig {/* Definitions for bpf_sock_ops_flags */ #define BPF_SOCK_OPS_RTO_CB_FLAG (1<<0) +#define BPF_SOCK_OPS_RETRANS_CB_FLAG (1<<1)/* INET_DIAG_MD5SIG */ struct tcp_diag_md5sig {
net/ipv4/tcp_output.c +3 -0
@@ -2907,6 +2907,9 @@ int __tcp_retransmit_skb(struct sock *sk, struct sk_buff *skb, int segs)if (likely (!err)) {TCP_SKB_CB (skb)->sacked |=TCPCB_EVER_RETRANS ;trace_tcp_retransmit_skb (sk, skb); +if (BPF_SOCK_OPS_TEST_FLAG (tp,BPF_SOCK_OPS_RETRANS_CB_FLAG )) +tcp_call_bpf_2arg (sk,BPF_SOCK_OPS_RETRANS_CB , +TCP_SKB_CB (skb)->seq, segs); }else if (err != -EBUSY ) {NET_INC_STATS (sock_net (sk),LINUX_MIB_TCPRETRANSFAIL ); }
Signature · 1 line
2.9.5
PATCH v5 10/11 bpf: Add BPF_SOCK_OPS_STATE_CB
In reply to Lawrence BrakmoAdds support for calling sock_ops BPF program when there is a TCP state change. Two arguments are used; one for the old state and another for the new state.
There is a new enum in include/uapi/linux/bpf.h that exports the TCP states that prepends BPF_ to the current TCP state names. If it is ever necessary to change the internal TCP state values (other than adding more to the end), then it will become necessary to convert from the internal TCP state value to the BPF value before calling the BPF sock_ops function. There are a set of compile checks added in tcp.c to detect if the internal and BPF values differ so we can make the necessary fixes.
New op: BPF_SOCK_OPS_STATE_CB.
--- include/uapi/linux/bpf.h | 26 ++++++++++++++++++++++++++ include/uapi/linux/tcp.h | 1 + net/ipv4/tcp.c | 24 ++++++++++++++++++++++++ 3 files changed, 51 insertions(+)
include/uapi/linux/bpf.h +26 -0
@@ -1030,6 +1030,32 @@ enum {* Arg1: sequence number of 1st byte * Arg2: # segments */ + BPF_SOCK_OPS_STATE_CB, /* Called when TCP changes state. +* Arg1: old_state +* Arg2: new_state +*/ +}; + +/* List of TCP states. There is a build check in net/ipv4/tcp.c to detect +* changes between the TCP and BPF versions. Ideally this should never happen. +* If it does, we need to add code to convert them before calling +* the BPF sock_ops function. +*/ +enum { +BPF_TCP_ESTABLISHED =1 , +BPF_TCP_SYN_SENT , +BPF_TCP_SYN_RECV , +BPF_TCP_FIN_WAIT1 , +BPF_TCP_FIN_WAIT2 , +BPF_TCP_TIME_WAIT , +BPF_TCP_CLOSE , +BPF_TCP_CLOSE_WAIT , +BPF_TCP_LAST_ACK , +BPF_TCP_LISTEN , +BPF_TCP_CLOSING ,/* Now a valid state */ +BPF_TCP_NEW_SYN_RECV , + +BPF_TCP_MAX_STATES /* Leave at the end! */ };#define TCP_BPF_IW 1001/* Set TCP initial congestion window */
include/uapi/linux/tcp.h +1 -0
@@ -262,6 +262,7 @@ struct tcp_md5sig {/* Definitions for bpf_sock_ops_flags */ #define BPF_SOCK_OPS_RTO_CB_FLAG (1<<0)#define BPF_SOCK_OPS_RETRANS_CB_FLAG (1<<1) +#define BPF_SOCK_OPS_STATE_CB_FLAG (1<<2)/* INET_DIAG_MD5SIG */ struct tcp_diag_md5sig {
net/ipv4/tcp.c +24 -0
@@ -2042,6 +2042,30 @@ void tcp_set_state(struct sock *sk, int state) {int oldstate = sk->sk_state; +/* We defined a new enum for TCP states that are exported in BPF +* so as not force the internal TCP states to be frozen. The +* following checks will detect if an internal state value ever +* differs from the BPF value. If this ever happens, then we will +* need to remap the internal value to the BPF value before calling +* tcp_call_bpf_2arg. +*/ +BUILD_BUG_ON ((int )BPF_TCP_ESTABLISHED != (int )TCP_ESTABLISHED ); +BUILD_BUG_ON ((int )BPF_TCP_SYN_SENT != (int )TCP_SYN_SENT ); +BUILD_BUG_ON ((int )BPF_TCP_SYN_RECV != (int )TCP_SYN_RECV ); +BUILD_BUG_ON ((int )BPF_TCP_FIN_WAIT1 != (int )TCP_FIN_WAIT1 ); +BUILD_BUG_ON ((int )BPF_TCP_FIN_WAIT2 != (int )TCP_FIN_WAIT2 ); +BUILD_BUG_ON ((int )BPF_TCP_TIME_WAIT != (int )TCP_TIME_WAIT ); +BUILD_BUG_ON ((int )BPF_TCP_CLOSE != (int )TCP_CLOSE ); +BUILD_BUG_ON ((int )BPF_TCP_CLOSE_WAIT != (int )TCP_CLOSE_WAIT ); +BUILD_BUG_ON ((int )BPF_TCP_LAST_ACK != (int )TCP_LAST_ACK ); +BUILD_BUG_ON ((int )BPF_TCP_LISTEN != (int )TCP_LISTEN ); +BUILD_BUG_ON ((int )BPF_TCP_CLOSING != (int )TCP_CLOSING ); +BUILD_BUG_ON ((int )BPF_TCP_NEW_SYN_RECV != (int )TCP_NEW_SYN_RECV ); +BUILD_BUG_ON ((int )BPF_TCP_MAX_STATES != (int )TCP_MAX_STATES ); + +if (BPF_SOCK_OPS_TEST_FLAG (tcp_sk (sk),BPF_SOCK_OPS_STATE_CB_FLAG )) +tcp_call_bpf_2arg (sk,BPF_SOCK_OPS_STATE_CB , oldstate, state); +switch (state) {case TCP_ESTABLISHED :if (oldstate !=TCP_ESTABLISHED )
Signature · 1 line
2.9.5
PATCH v5 11/11 bpf: add selftest for tcpbpf
In reply to Lawrence BrakmoAdded a selftest for tcpbpf (sock_ops) that checks that the appropriate callbacks occured and that it can access tcp_sock fields and that their values are correct.
Run with command: ./test_tcpbpf_user
--- tools/include/uapi/linux/bpf.h | 70 +++++++++++++++- tools/testing/selftests/bpf/Makefile | 5 +- tools/testing/selftests/bpf/tcp_client.py | 52 ++++++++++++ tools/testing/selftests/bpf/tcp_server.py | 79 ++++++++++++++++++ tools/testing/selftests/bpf/test_tcpbpf.h | 14 ++++ tools/testing/selftests/bpf/test_tcpbpf_kern.c | 109 +++++++++++++++++++++++++ tools/testing/selftests/bpf/test_tcpbpf_user.c | 103 +++++++++++++++++++++++ 7 files changed, 427 insertions(+), 5 deletions(-) create mode 100755 tools/testing/selftests/bpf/tcp_client.py create mode 100755 tools/testing/selftests/bpf/tcp_server.py create mode 100644 tools/testing/selftests/bpf/test_tcpbpf.h create mode 100644 tools/testing/selftests/bpf/test_tcpbpf_kern.c create mode 100644 tools/testing/selftests/bpf/test_tcpbpf_user.c
tools/include/uapi/linux/bpf.h +67 -3
@@ -945,8 +945,9 @@ struct bpf_map_info {struct bpf_sock_ops {__u32 op;union { -__u32 reply; -__u32 replylong[4 ]; +__u32 args[4 ];/* Optionally passed to bpf program */ +__u32 reply;/* Returned by bpf program */ +__u32 replylong[4 ];/* Optionally returned by bpf prog */ };__u32 family;__u32 remote_ip4;/* Stored in network byte order */
@@ -955,6 +956,33 @@ struct bpf_sock_ops {__u32 local_ip6[4 ];/* Stored in network byte order */ __u32 remote_port;/* Stored in network byte order */ __u32 local_port;/* stored in host byte order */ +__u32 is_fullsock;/* Some TCP fields are only valid if +* there is a full socket. If not, the +* fields read as zero. +*/ +__u32 snd_cwnd; +__u32 srtt_us;/* Averaged RTT << 3 in usecs */ +__u32 bpf_sock_ops_flags;/* flags defined in uapi/linux/tcp.h */ +__u32 state; +__u32 rtt_min; +__u32 snd_ssthresh; +__u32 rcv_nxt; +__u32 snd_nxt; +__u32 snd_una; +__u32 mss_cache; +__u32 ecn_flags; +__u32 rate_delivered; +__u32 rate_interval_us; +__u32 packets_out; +__u32 retrans_out; +__u32 total_retrans; +__u32 segs_in; +__u32 data_segs_in; +__u32 segs_out; +__u32 data_segs_out; +__u64 bytes_received; +__u64 bytes_acked; +__u32 sk_txhash; };/* List of known BPF sock_ops operators.
@@ -990,6 +1018,41 @@ enum {* a congestion threshold. RTTs above * this indicate congestion */ +BPF_SOCK_OPS_RTO_CB ,/* Called when an RTO has triggered. +* Arg1: value of icsk_retransmits +* Arg2: value of icsk_rto +* Arg3: whether RTO has expired +*/ +BPF_SOCK_OPS_RETRANS_CB ,/* Called when skb is retransmitted. +* Arg1: sequence number of 1st byte +* Arg2: # segments +*/ + BPF_SOCK_OPS_STATE_CB, /* Called when TCP changes state. + * Arg1: old_state + * Arg2: new_state + */ +}; + +/* List of TCP states. There is a build check in net/ipv4/tcp.c to detect +* changes between the TCP and BPF versions. Ideally this should never happen. +* If it does, we need to add code to convert them before calling +* the BPF sock_ops function. +*/ +enum { +BPF_TCP_ESTABLISHED =1 , +BPF_TCP_SYN_SENT , +BPF_TCP_SYN_RECV , +BPF_TCP_FIN_WAIT1 , +BPF_TCP_FIN_WAIT2 , +BPF_TCP_TIME_WAIT , +BPF_TCP_CLOSE , +BPF_TCP_CLOSE_WAIT , +BPF_TCP_LAST_ACK , +BPF_TCP_LISTEN , +BPF_TCP_CLOSING ,/* Now a valid state */ +BPF_TCP_NEW_SYN_RECV , + +BPF_TCP_MAX_STATES /* Leave at the end! */ };#define TCP_BPF_IW 1001/* Set TCP initial congestion window */
@@ -1009,7 +1072,8 @@ struct bpf_perf_event_value {#define BPF_DEVCG_DEV_CHAR (1ULL << 1)struct bpf_cgroup_dev_ctx { -__u32 access_type;/* (access << 16) | type */ +/* access_type encoded as (BPF_DEVCG_ACC_* << 16) | BPF_DEVCG_DEV_* */ +__u32 access_type;__u32 major;__u32 minor; };
tools/testing/selftests/bpf/Makefile +3 -2
@@ -14,12 +14,13 @@ CFLAGS += -Wall -O2 -I$(APIDIR) -I$(LIBDIR) -I$(GENDIR) $(GENFLAGS) -I../../../i LDLIBS += -lcap -lelf -lrt TEST_GEN_PROGS = test_verifier test_tag test_maps test_lru_map test_lpm_map test_progs \ - test_align test_verifier_log test_dev_cgroup + test_align test_verifier_log test_dev_cgroup test_tcpbpf_user TEST_GEN_FILES = test_pkt_access.o test_xdp.o test_l4lb.o test_tcp_estats.o test_obj_id.o \ test_pkt_md_access.o test_xdp_redirect.o test_xdp_meta.o sockmap_parse_prog.o \ sockmap_verdict_prog.o dev_cgroup.o sample_ret0.o test_tracepoint.o \ - test_l4lb_noinline.o test_xdp_noinline.o test_stacktrace_map.o + test_l4lb_noinline.o test_xdp_noinline.o test_stacktrace_map.o \ + test_tcpbpf_kern.o TEST_PROGS := test_kmod.sh test_xdp_redirect.sh test_xdp_meta.sh \ test_offload.py
tools/testing/selftests/bpf/tcp_client.py new file +52 -0
52 lines not on this page · raw message
tools/testing/selftests/bpf/tcp_server.py new file +79 -0
79 lines not on this page · raw message
tools/testing/selftests/bpf/test_tcpbpf.h new file +14 -0
@@ -0,0 +1,14 @@ +// SPDX-License-Identifier: GPL-2.0 + +#ifndef _TEST_TCPBPF_H +#define _TEST_TCPBPF_H + +struct tcpbpf_globals { +__u32 event_map; +__u32 total_retrans; +__u32 data_segs_in; +__u32 data_segs_out; +__u64 bytes_received; +__u64 bytes_acked; +}; +#endif
tools/testing/selftests/bpf/test_tcpbpf_kern.c new file +109 -0
109 lines not on this page · raw message
tools/testing/selftests/bpf/test_tcpbpf_user.c new file +103 -0
103 lines not on this page · raw message
Signature · 1 line
2.9.5