Skip to contentSkip to conversation

bpf: Expose bpf_get_socket_cookie to tracing programs

PATCH Superseded Florent Revest 3 participants 6 messages Nov 26, 2020 – Dec 2, 2020

Subsystems (8)
Networking Kselftest BPF Tracing +4 more subsystems

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore
#0 lore raw

PATCH 1/2 bpf: Expose bpf_get_socket_cookie to tracing programs

This creates a new helper proto because the existing bpf_get_socket_cookie_sock_proto has a ARG_PTR_TO_CTX argument and only works for BPF programs where the context is a sock.

This helper could also be useful to other BPF program types such as LSM.

---
 kernel/trace/bpf_trace.c | 4 ++++
 net/core/filter.c        | 7 +++++++
 2 files changed, 11 insertions(+)
kernel/trace/bpf_trace.c +4 -0
index d255bc9b2bfa..14ad96579813 100644
@@ -1725,6 +1725,8 @@ raw_tp_prog_func_proto(enum bpf_func_id func_id, const struct bpf_prog *prog)
 	}
 }
 
+extern const struct bpf_func_proto bpf_get_socket_cookie_sock_tracing_proto;
+
 const struct bpf_func_proto *
 tracing_prog_func_proto(enum bpf_func_id func_id, const struct bpf_prog *prog)
 {
@@ -1748,6 +1750,8 @@ tracing_prog_func_proto(enum bpf_func_id func_id, const struct bpf_prog *prog)
 		return &bpf_sk_storage_get_tracing_proto;
 	case BPF_FUNC_sk_storage_delete:
 		return &bpf_sk_storage_delete_tracing_proto;
+	case BPF_FUNC_get_socket_cookie:
+		return &bpf_get_socket_cookie_sock_tracing_proto;
 #endif
 	case BPF_FUNC_seq_printf:
 		return prog->expected_attach_type == BPF_TRACE_ITER ?
net/core/filter.c +7 -0
index 2ca5eecebacf..177c4e5e529d 100644
@@ -4631,6 +4631,13 @@ static const struct bpf_func_proto bpf_get_socket_cookie_sock_proto = {
 	.arg1_type	= ARG_PTR_TO_CTX,
 };
 
+const struct bpf_func_proto bpf_get_socket_cookie_sock_tracing_proto = {
+	.func		= bpf_get_socket_cookie_sock,
+	.gpl_only	= false,
+	.ret_type	= RET_INTEGER,
+	.arg1_type      = ARG_PTR_TO_BTF_ID_SOCK_COMMON,
+};
+
 BPF_CALL_1(bpf_get_socket_cookie_sock_ops, struct bpf_sock_ops_kern *, ctx)
 {
 	return __sock_gen_cookie(ctx->sk);
Signature · 1 line
2.29.2.454.gaff20da3a2-goog
#1 lore raw

PATCH 2/2 bpf: Add a selftest for the tracing bpf_get_socket_cookie

This builds up on the existing socket cookie test which checks whether the bpf_get_socket_cookie helpers provide the same value in cgroup/connect6 and sockops programs for a socket created by the userspace part of the test.

Adding a tracing program to the existing objects requires a different attachment strategy and different headers.

---
 .../selftests/bpf/progs/socket_cookie_prog.c  | 41 ++++++++++++++++---
 .../selftests/bpf/test_socket_cookie.c        | 18 +++++---
 2 files changed, 49 insertions(+), 10 deletions(-)
tools/testing/selftests/bpf/progs/socket_cookie_prog.c +36 -5
index 0cb5656a22b0..a11026aeaaf1 100644
@@ -1,11 +1,13 @@
 // SPDX-License-Identifier: GPL-2.0
 // Copyright (c) 2018 Facebook
 
-#include <linux/bpf.h>
-#include <sys/socket.h>
+#include "vmlinux.h"
 
 #include <bpf/bpf_helpers.h>
 #include <bpf/bpf_endian.h>
+#include <bpf/bpf_tracing.h>
+
+#define AF_INET6 10
 
 struct socket_cookie {
 	__u64 cookie_key;
@@ -19,6 +21,14 @@ struct {
 	__type(value, struct socket_cookie);
 } socket_cookies SEC(".maps");
 
+/*
+ * These three programs get executed in a row on connect() syscalls. The
+ * userspace side of the test creates a client socket, issues a connect() on it
+ * and then checks that the local storage associated with this socket has:
+ * cookie_value == local_port << 8 | 0xFF
+ * The different parts of this cookie_value are appended by those hooks if they
+ * all agree on the output of bpf_get_socket_cookie().
+ */
 SEC("cgroup/connect6")
 int set_cookie(struct bpf_sock_addr *ctx)
 {
@@ -32,14 +42,14 @@ int set_cookie(struct bpf_sock_addr *ctx)
 	if (!p)
 		return 1;
 
-	p->cookie_value = 0xFF;
+	p->cookie_value = 0xF;
 	p->cookie_key = bpf_get_socket_cookie(ctx);
 
 	return 1;
 }
 
 SEC("sockops")
-int update_cookie(struct bpf_sock_ops *ctx)
+int update_cookie_sockops(struct bpf_sock_ops *ctx)
 {
 	struct bpf_sock *sk;
 	struct socket_cookie *p;
@@ -60,11 +70,32 @@ int update_cookie(struct bpf_sock_ops *ctx)
 	if (p->cookie_key != bpf_get_socket_cookie(ctx))
 		return 1;
 
-	p->cookie_value = (ctx->local_port << 8) | p->cookie_value;
+	p->cookie_value |= (ctx->local_port << 8);
 
 	return 1;
 }
 
+SEC("fexit/inet_stream_connect")
+int BPF_PROG(update_cookie_tracing, struct socket *sock,
+	     struct sockaddr *uaddr, int addr_len, int flags)
+{
+	struct socket_cookie *p;
+
+	if (uaddr->sa_family != AF_INET6)
+		return 0;
+
+	p = bpf_sk_storage_get(&socket_cookies, sock->sk, 0, 0);
+	if (!p)
+		return 0;
+
+	if (p->cookie_key != bpf_get_socket_cookie(sock->sk))
+		return 0;
+
+	p->cookie_value |= 0xF0;
+
+	return 0;
+}
+
 int _version SEC("version") = 1;
 
 char _license[] SEC("license") = "GPL";
tools/testing/selftests/bpf/test_socket_cookie.c +13 -5
index ca7ca87e91aa..0d955c65a4f8 100644
@@ -133,6 +133,7 @@ static int run_test(int cgfd)
 	struct bpf_prog_load_attr attr;
 	struct bpf_program *prog;
 	struct bpf_object *pobj;
+	struct bpf_link *link;
 	const char *prog_name;
 	int server_fd = -1;
 	int client_fd = -1;
@@ -153,11 +154,18 @@ static int run_test(int cgfd)
 	bpf_object__for_each_program(prog, pobj) {
 		prog_name = bpf_program__section_name(prog);
 
-		if (libbpf_attach_type_by_name(prog_name, &attach_type))
-			goto err;
-
-		err = bpf_prog_attach(bpf_program__fd(prog), cgfd, attach_type,
-				      BPF_F_ALLOW_OVERRIDE);
+		if (bpf_program__is_tracing(prog)) {
+			link = bpf_program__attach(prog);
+			err = !link;
+			continue;
+		} else {
+			if (libbpf_attach_type_by_name(prog_name, &attach_type))
+				goto err;
+
+			err = bpf_prog_attach(bpf_program__fd(prog), cgfd,
+					      attach_type,
+					      BPF_F_ALLOW_OVERRIDE);
+		}
 		if (err) {
 			log_err("Failed to attach prog %s", prog_name);
 			goto out;
Signature · 1 line
2.29.2.454.gaff20da3a2-goog
#2 lore raw

Re: [PATCH bpf-next 2/2] bpf: Add a selftest for the tracing bpf_get_socket_cookie

Quoted 5 lines · Florent Revest

This builds up on the existing socket cookie test which checks whether the bpf_get_socket_cookie helpers provide the same value in cgroup/connect6 and sockops programs for a socket created by the userspace part of the test.

Quoted 7 lines

Adding a tracing program to the existing objects requires a different attachment strategy and different headers.

---
  .../selftests/bpf/progs/socket_cookie_prog.c  | 41 ++++++++++++++++---
  .../selftests/bpf/test_socket_cookie.c        | 18 +++++---

Do you think it is possible to migrate test_socket_cookie.c to selftests/bpf/prog_tests so it can be part of test_progs so it will be regularly exercised?

Quoted 10 lines
  2 files changed, 49 insertions(+), 10 deletions(-)
tools/testing/selftests/bpf/progs/socket_cookie_prog.c +0 -0
index 0cb5656a22b0..a11026aeaaf1 100644
@@ -1,11 +1,13 @@
  // SPDX-License-Identifier: GPL-2.0
  // Copyright (c) 2018 Facebook
 

[...]

Quoted 37 lines
tools/testing/selftests/bpf/test_socket_cookie.c +13 -5
index ca7ca87e91aa..0d955c65a4f8 100644
@@ -133,6 +133,7 @@ static int run_test(int cgfd)
  	struct bpf_prog_load_attr attr;
  	struct bpf_program *prog;
  	struct bpf_object *pobj;
+	struct bpf_link *link;
  	const char *prog_name;
  	int server_fd = -1;
  	int client_fd = -1;
@@ -153,11 +154,18 @@ static int run_test(int cgfd)
  	bpf_object__for_each_program(prog, pobj) {
  		prog_name = bpf_program__section_name(prog);
 
-		if (libbpf_attach_type_by_name(prog_name, &attach_type))
-			goto err;
-
-		err = bpf_prog_attach(bpf_program__fd(prog), cgfd, attach_type,
-				      BPF_F_ALLOW_OVERRIDE);
+		if (bpf_program__is_tracing(prog)) {
+			link = bpf_program__attach(prog);
+			err = !link;
+			continue;
+		} else {
+			if (libbpf_attach_type_by_name(prog_name, &attach_type))
+				goto err;
+
+			err = bpf_prog_attach(bpf_program__fd(prog), cgfd,
+					      attach_type,
+					      BPF_F_ALLOW_OVERRIDE);
+		}
  		if (err) {
  			log_err("Failed to attach prog %s", prog_name);
  			goto out;
#3 lore raw

Re: [PATCH bpf-next 2/2] bpf: Add a selftest for the tracing bpf_get_socket_cookie

Quoted 18 lines · Yonghong Song
Quoted 10 lines · Florent Revest

This builds up on the existing socket cookie test which checks whether
the bpf_get_socket_cookie helpers provide the same value in cgroup/connect6 and sockops programs for a socket created by the userspace part of the test.

Adding a tracing program to the existing objects requires a different
attachment strategy and different headers.

Quoted 5 lines
---
  .../selftests/bpf/progs/socket_cookie_prog.c  | 41
++++++++++++++++---
  .../selftests/bpf/test_socket_cookie.c        | 18 +++++---
Quoted 3 lines

Do you think it is possible to migrate test_socket_cookie.c to selftests/bpf/prog_tests so it can be part of test_progs so it will be regularly exercised?

I suppose it's possible, I can give it a try :)

#4 lore raw

Re: [PATCH bpf-next 2/2] bpf: Add a selftest for the tracing bpf_get_socket_cookie

In reply to Florent Revest
Quoted 89 lines · Florent Revest

This builds up on the existing socket cookie test which checks whether the bpf_get_socket_cookie helpers provide the same value in cgroup/connect6 and sockops programs for a socket created by the userspace part of the test.

Adding a tracing program to the existing objects requires a different attachment strategy and different headers.

---
 .../selftests/bpf/progs/socket_cookie_prog.c  | 41 ++++++++++++++++---
 .../selftests/bpf/test_socket_cookie.c        | 18 +++++---
 2 files changed, 49 insertions(+), 10 deletions(-)
tools/testing/selftests/bpf/progs/socket_cookie_prog.c +27 -5
index 0cb5656a22b0..a11026aeaaf1 100644
@@ -1,11 +1,13 @@
 // SPDX-License-Identifier: GPL-2.0
 // Copyright (c) 2018 Facebook
 
-#include <linux/bpf.h>
-#include <sys/socket.h>
+#include "vmlinux.h"
 
 #include <bpf/bpf_helpers.h>
 #include <bpf/bpf_endian.h>
+#include <bpf/bpf_tracing.h>
+
+#define AF_INET6 10
 
 struct socket_cookie {
        __u64 cookie_key;
@@ -19,6 +21,14 @@ struct {
        __type(value, struct socket_cookie);
 } socket_cookies SEC(".maps");
 
+/*
+ * These three programs get executed in a row on connect() syscalls. The
+ * userspace side of the test creates a client socket, issues a connect() on it
+ * and then checks that the local storage associated with this socket has:
+ * cookie_value == local_port << 8 | 0xFF
+ * The different parts of this cookie_value are appended by those hooks if they
+ * all agree on the output of bpf_get_socket_cookie().
+ */
 SEC("cgroup/connect6")
 int set_cookie(struct bpf_sock_addr *ctx)
 {
@@ -32,14 +42,14 @@ int set_cookie(struct bpf_sock_addr *ctx)
        if (!p)
                return 1;
 
-       p->cookie_value = 0xFF;
+       p->cookie_value = 0xF;
        p->cookie_key = bpf_get_socket_cookie(ctx);
 
        return 1;
 }
 
 SEC("sockops")
-int update_cookie(struct bpf_sock_ops *ctx)
+int update_cookie_sockops(struct bpf_sock_ops *ctx)
 {
        struct bpf_sock *sk;
        struct socket_cookie *p;
@@ -60,11 +70,32 @@ int update_cookie(struct bpf_sock_ops *ctx)
        if (p->cookie_key != bpf_get_socket_cookie(ctx))
                return 1;
 
-       p->cookie_value = (ctx->local_port << 8) | p->cookie_value;
+       p->cookie_value |= (ctx->local_port << 8);
 
        return 1;
 }
 
+SEC("fexit/inet_stream_connect")
+int BPF_PROG(update_cookie_tracing, struct socket *sock,
+            struct sockaddr *uaddr, int addr_len, int flags)
+{
+       struct socket_cookie *p;
+
+       if (uaddr->sa_family != AF_INET6)
+               return 0;
+
+       p = bpf_sk_storage_get(&socket_cookies, sock->sk, 0, 0);
+       if (!p)
+               return 0;

tools/testing/selftests/bpf/progs/socket_cookie_prog.c int update_cookie(struct bpf_sock_ops *ctx) · line 99

Quoted 10 lines
tools/testing/selftests/bpf/progs/socket_cookie_prog.c +9 -0
+
+       if (p->cookie_key != bpf_get_socket_cookie(sock->sk))
+               return 0;
+
+       p->cookie_value |= 0xF0;
+
+       return 0;
+}
+
 int _version SEC("version") = 1;

please remove this, while you are at it

Quoted 16 lines
tools/testing/selftests/bpf/progs/socket_cookie_prog.c +0 -0
 char _license[] SEC("license") = "GPL";
tools/testing/selftests/bpf/test_socket_cookie.c +1 -0
index ca7ca87e91aa..0d955c65a4f8 100644
@@ -133,6 +133,7 @@ static int run_test(int cgfd)
        struct bpf_prog_load_attr attr;
        struct bpf_program *prog;
        struct bpf_object *pobj;
+       struct bpf_link *link;
        const char *prog_name;
        int server_fd = -1;
        int client_fd = -1;
@@ -153,11 +154,18 @@ static int run_test(int cgfd)
        bpf_object__for_each_program(prog, pobj) {

tools/testing/selftests/bpf/test_socket_cookie.c static int run_test(int cgfd) · line 159

Quoted 10 lines
tools/testing/selftests/bpf/test_socket_cookie.c +3 -5
                prog_name = bpf_program__section_name(prog);
 
-               if (libbpf_attach_type_by_name(prog_name, &attach_type))
-                       goto err;
-
-               err = bpf_prog_attach(bpf_program__fd(prog), cgfd, attach_type,
-                                     BPF_F_ALLOW_OVERRIDE);
+               if (bpf_program__is_tracing(prog)) {
+                       link = bpf_program__attach(prog);
+                       err = !link;

link is a pointer, so use libbpf_get_error()

tools/testing/selftests/bpf/test_socket_cookie.c static int run_test(int cgfd) · line 161

Quoted 2 lines
tools/testing/selftests/bpf/test_socket_cookie.c +2 -0
+                       continue;
+               } else {

else branch is not really necessary, just adds indentation unnecessarily

Quoted 13 lines
tools/testing/selftests/bpf/test_socket_cookie.c +7 -1
+                       if (libbpf_attach_type_by_name(prog_name, &attach_type))
+                               goto err;
+
+                       err = bpf_prog_attach(bpf_program__fd(prog), cgfd,
+                                             attach_type,
+                                             BPF_F_ALLOW_OVERRIDE);
+               }
                if (err) {
                        log_err("Failed to attach prog %s", prog_name);
                        goto out;
--

2.29.2.454.gaff20da3a2-goog

#5 lore raw
In reply to Florent Revest
Quoted 39 lines · Florent Revest

This creates a new helper proto because the existing bpf_get_socket_cookie_sock_proto has a ARG_PTR_TO_CTX argument and only works for BPF programs where the context is a sock.

This helper could also be useful to other BPF program types such as LSM.

---
  kernel/trace/bpf_trace.c | 4 ++++
  net/core/filter.c        | 7 +++++++
  2 files changed, 11 insertions(+)
kernel/trace/bpf_trace.c +4 -0
index d255bc9b2bfa..14ad96579813 100644
@@ -1725,6 +1725,8 @@ raw_tp_prog_func_proto(enum bpf_func_id func_id, const struct bpf_prog *prog)
  	}
  }
 
+extern const struct bpf_func_proto bpf_get_socket_cookie_sock_tracing_proto;
+
  const struct bpf_func_proto *
  tracing_prog_func_proto(enum bpf_func_id func_id, const struct bpf_prog *prog)
  {
@@ -1748,6 +1750,8 @@ tracing_prog_func_proto(enum bpf_func_id func_id, const struct bpf_prog *prog)
  		return &bpf_sk_storage_get_tracing_proto;
  	case BPF_FUNC_sk_storage_delete:
  		return &bpf_sk_storage_delete_tracing_proto;
+	case BPF_FUNC_get_socket_cookie:
+		return &bpf_get_socket_cookie_sock_tracing_proto;
  #endif
  	case BPF_FUNC_seq_printf:
  		return prog->expected_attach_type == BPF_TRACE_ITER ?
net/core/filter.c +0 -0
index 2ca5eecebacf..177c4e5e529d 100644

net/core/filter.c static const struct bpf_func_proto bpf_get_socket_cookie_sock_proto = { · line 4639

Quoted 9 lines
net/core/filter.c +6 -0
@@ -4631,6 +4631,13 @@ static const struct bpf_func_proto bpf_get_socket_cookie_sock_proto = {
  	.arg1_type	= ARG_PTR_TO_CTX,
  };
 
+const struct bpf_func_proto bpf_get_socket_cookie_sock_tracing_proto = {
+	.func		= bpf_get_socket_cookie_sock,
+	.gpl_only	= false,
+	.ret_type	= RET_INTEGER,
+	.arg1_type      = ARG_PTR_TO_BTF_ID_SOCK_COMMON,
+};

This seems correct to me. Could you add another helper description in uapi bpf.h? Currently we already have:
u64 bpf_get_socket_cookie(struct sk_buff *skb)
u64 bpf_get_socket_cookie(struct bpf_sock_addr *ctx)
u64 bpf_get_socket_cookie(struct bpf_sock_ops *ctx)

The btf-id based helper will be something like below
u64 bpf_get_socket_cookie(void *sk)

Quoted 5 lines
net/core/filter.c +1 -0
+
  BPF_CALL_1(bpf_get_socket_cookie_sock_ops, struct bpf_sock_ops_kern *, ctx)
  {
  	return __sock_gen_cookie(ctx->sk);