bpf, xdp: Add tracepoint to xdp attaching failure
Subsystems (7)
v4 cover bpf, xdp: Add tracepoint to xdp attaching failure
This series introduces a new tracepoint in bpf_xdp_link_attach(). By this tracepoint, error message will be captured when error happens in dev_xdp_attach(), e.g. invalid attaching flags.
v3 -> v4:
* Fix selftest-crashed issue.
Leon Hwang (2):
bpf, xdp: Add tracepoint to xdp attaching failure selftests/bpf: Add testcase for xdp attaching failure tracepoint
include/trace/events/xdp.h | 17 +++++ net/core/dev.c | 5 +- .../selftests/bpf/prog_tests/xdp_attach.c | 65 +++++++++++++++++++ .../bpf/progs/test_xdp_attach_fail.c | 54 +++++++++++++++ 4 files changed, 140 insertions(+), 1 deletion(-) create mode 100644 tools/testing/selftests/bpf/progs/test_xdp_attach_fail.c
base-commit: a33d978500acd8fb67efac9773ba0a8502c1ff06
Signature · 1 line
2.41.0
PATCH v4 1/2 bpf, xdp: Add tracepoint to xdp attaching failure
When error happens in dev_xdp_attach(), it should have a way to tell users the error message like the netlink approach.
To avoid breaking uapi, adding a tracepoint in bpf_xdp_link_attach() is an appropriate way to notify users the error message.
Hence, bpf libraries are able to retrieve the error message by this tracepoint, and then report the error message to users.
--- include/trace/events/xdp.h | 17 +++++++++++++++++ net/core/dev.c | 5 ++++- 2 files changed, 21 insertions(+), 1 deletion(-)
include/trace/events/xdp.h +17 -0
@@ -404,6 +404,23 @@ TRACE_EVENT(mem_return_failed, ) ); +TRACE_EVENT (bpf_xdp_link_attach_failed, + + TP_PROTO(const char *msg), + +TP_ARGS (msg), + +TP_STRUCT__entry ( +__string (msg, msg) + ), + +TP_fast_assign ( + __assign_str(msg, msg); + ), + +TP_printk ("errmsg=%s" ,__get_str (msg)) +); +#endif /* _TRACE_XDP_H */ #include <trace/define_trace.h>
net/core/dev.c +4 -1
@@ -133,6 +133,7 @@#include <trace/events/net.h> #include <trace/events/skb.h> #include <trace/events/qdisc.h> +#include <trace/events/xdp.h> #include <linux/inetdevice.h> #include <linux/cpu_rmap.h> #include <linux/static_key.h>
@@ -9472,6 +9473,7 @@ int bpf_xdp_link_attach(const union bpf_attr *attr, struct bpf_prog *prog)struct bpf_link_primer link_primer;struct bpf_xdp_link *link;struct net_device *dev; +struct netlink_ext_ack extack;int err, fd;rtnl_lock ();
@@ -9497,12 +9499,13 @@ int bpf_xdp_link_attach(const union bpf_attr *attr, struct bpf_prog *prog) goto unlock; } - err =dev_xdp_attach_link (dev,NULL , link); + err =dev_xdp_attach_link (dev, &extack, link);rtnl_unlock ();if (err) { link->dev =NULL ;bpf_link_cleanup (&link_primer); +trace_bpf_xdp_link_attach_failed (extack._msg); goto out_put_dev; }
Signature · 1 line
2.41.0
Jakub Kicinski
maintainernet/core/dev.c int bpf_xdp_link_attach(const union bpf_attr *attr, struct bpf_prog *prog) · line 9476
Quoted 5 lines · On Sun, 30 Jul 2023 19:49:50 +0800 Leon Hwang wrote:
net/core/dev.c +1
-0@@ -9472,6 +9473,7 @@ int bpf_xdp_link_attach(const union bpf_attr *attr, struct bpf_prog *prog)struct bpf_link_primer link_primer;struct bpf_xdp_link *link;struct net_device *dev; +struct netlink_ext_ack extack;
This is not initialized. Also, while fixing that, move it up to maintain the line order by decreasing line length.
Quoted 15 lines
net/core/dev.c +2
-1int err, fd;rtnl_lock ();@@ -9497,12 +9499,13 @@ int bpf_xdp_link_attach(const union bpf_attr *attr, struct bpf_prog *prog) goto unlock; } - err =dev_xdp_attach_link (dev,NULL , link); + err =dev_xdp_attach_link (dev, &extack, link);rtnl_unlock ();if (err) { link->dev =NULL ;bpf_link_cleanup (&link_primer); +trace_bpf_xdp_link_attach_failed (extack._msg);
Quoted 10 lines · Jakub Kicinski
net/core/dev.c int bpf_xdp_link_attach(const union bpf_attr *attr, struct bpf_prog *prog) · line 9476
Quoted 5 lines · On Sun, 30 Jul 2023 19:49:50 +0800 Leon Hwang wrote:
net/core/dev.c +1
-0@@ -9472,6 +9473,7 @@ int bpf_xdp_link_attach(const union bpf_attr *attr, struct bpf_prog *prog)struct bpf_link_primer link_primer;struct bpf_xdp_link *link;struct net_device *dev; +struct netlink_ext_ack extack;This is not initialized. Also, while fixing that, move it up to maintain the line order by decreasing line length.
Thank you for your reviewing.
I'll fix it by initializing extack and moving the line to its appropriate position.
Thanks,
Leon
Quoted 15 lines
Quoted 15 lines
net/core/dev.c +2
-1int err, fd;rtnl_lock ();@@ -9497,12 +9499,13 @@ int bpf_xdp_link_attach(const union bpf_attr *attr, struct bpf_prog *prog) goto unlock; } - err =dev_xdp_attach_link (dev,NULL , link); + err =dev_xdp_attach_link (dev, &extack, link);rtnl_unlock ();if (err) { link->dev =NULL ;bpf_link_cleanup (&link_primer); +trace_bpf_xdp_link_attach_failed (extack._msg);
PATCH v4 2/2 selftests/bpf: Add testcase for xdp attaching failure tracepoint
In reply to Leon HwangAdd a test case for the tracepoint of xdp attaching failure by bpf tracepoint when attach XDP to a device with invalid flags option.
The bpf tracepoint retrieves error message from the tracepoint, and then put the error message to a perf buffer. The testing code receives error message from perf buffer, and then ASSERT "Invalid XDP flags for BPF link attachment".
--- .../selftests/bpf/prog_tests/xdp_attach.c | 65 +++++++++++++++++++ .../bpf/progs/test_xdp_attach_fail.c | 54 +++++++++++++++ 2 files changed, 119 insertions(+) create mode 100644 tools/testing/selftests/bpf/progs/test_xdp_attach_fail.c
tools/testing/selftests/bpf/prog_tests/xdp_attach.c +65 -0
@@ -1,5 +1,6 @@// SPDX-License-Identifier: GPL-2.0 #include <test_progs.h> +#include "test_xdp_attach_fail.skel.h" #define IFINDEX_LO 1#define XDP_FLAGS_REPLACE (1U << 4)
@@ -85,10 +86,74 @@ static void test_xdp_attach(const char *file)bpf_object__close (obj1); } +#define ERRMSG_LEN 64 + +struct xdp_errmsg { +char msg[ERRMSG_LEN ]; +}; + +static void on_xdp_errmsg (void *ctx,int cpu,void *data,__u32 size) +{ +struct xdp_errmsg *ctx_errmg = ctx, *tp_errmsg = data; + +memcpy (&ctx_errmg->msg, &tp_errmsg->msg,ERRMSG_LEN ); +} + +static const char tgt_errmsg[] ="Invalid XDP flags for BPF link attachment" ; + +static void test_xdp_attach_fail (const char *file) +{ +int err, fd_xdp; +struct bpf_object *obj =NULL ; +struct test_xdp_attach_fail *skel =NULL ; +struct perf_buffer *pb =NULL ; +struct xdp_errmsg errmsg = {}; + +LIBBPF_OPTS (bpf_link_create_opts, opts); + + skel =test_xdp_attach_fail__open_and_load (); +if (!ASSERT_OK_PTR (skel,"test_xdp_attach_fail__open_and_load" )) + goto out_close; + + err =test_xdp_attach_fail__attach (skel); +if (!ASSERT_EQ (err,0 ,"test_xdp_attach_fail__attach" )) + goto out_close; + +/* set up perf buffer */ + pb =perf_buffer__new (bpf_map__fd (skel->maps.xdp_errmsg_pb),1 , + on_xdp_errmsg,NULL , &errmsg,NULL ); +if (!ASSERT_OK_PTR (pb,"perf_buffer__new" )) + goto out_close; + + err =bpf_prog_test_load (file,BPF_PROG_TYPE_XDP , &obj, &fd_xdp); +if (!ASSERT_EQ (err,0 ,"bpf_prog_test_load" )) + goto out_close; + + opts.flags =0xFF ;// invalid flags to fail to attach XDP prog + err =bpf_link_create (fd_xdp,IFINDEX_LO ,BPF_XDP , &opts); +if (!ASSERT_EQ (err, -EINVAL ,"bpf_link_create" )) + goto out_close; + +/* read perf buffer */ + err =perf_buffer__poll (pb,100 ); +if (!ASSERT_GT (err,-1 ,"perf_buffer__poll" )) + goto out_close; + +ASSERT_STRNEQ ((const char *) errmsg.msg, tgt_errmsg, +42 /* strlen(tgt_errmsg) */ ,"check error message" ); + +out_close: +perf_buffer__free (pb); +bpf_object__close (obj); +test_xdp_attach_fail__destroy (skel); +} +void serial_test_xdp_attach (void ) {if (test__start_subtest ("xdp_attach" ))test_xdp_attach ("./test_xdp.bpf.o" );if (test__start_subtest ("xdp_attach_dynptr" ))test_xdp_attach ("./test_xdp_dynptr.bpf.o" ); +if (test__start_subtest ("xdp_attach_failed" )) +test_xdp_attach_fail ("./xdp_dummy.bpf.o" ); }
tools/testing/selftests/bpf/progs/test_xdp_attach_fail.c new file +54 -0
54 lines not on this page · raw message
Signature · 1 line
2.41.0
This patch is very important to help us to debug the xdp program. At the same time, we can make some monitoring tools to observe the kernel status by using this trace event
李者璈 & Zheaoli
Email: [email protected]
Github: https://github.com/Zheaoli
Quoted 25 lines · Leon Hwang <[email protected]> 于2023年7月30日周日 19:50写道:
This series introduces a new tracepoint in
bpf_xdp_link_attach(). By this tracepoint, error message will be captured when error happens indev_xdp_attach(), e.g. invalid attaching flags.v3 -> v4:
* Fix selftest-crashed issue.Leon Hwang (2):
bpf, xdp: Add tracepoint to xdp attaching failure selftests/bpf: Add testcase for xdp attaching failure tracepointinclude/trace/events/xdp.h | 17 +++++ net/core/dev.c | 5 +- .../selftests/bpf/prog_tests/xdp_attach.c | 65 +++++++++++++++++++ .../bpf/progs/test_xdp_attach_fail.c | 54 +++++++++++++++ 4 files changed, 140 insertions(+), 1 deletion(-) create mode 100644 tools/testing/selftests/bpf/progs/test_xdp_attach_fail.cbase-commit:
a33d978500acd8fb67efac9773ba0a8502c1ff06--
2.41.0
Quoted 9 lines · Manjusaka
This patch is very important to help us to debug the xdp program. At the same time, we can make some monitoring tools to observe the kernel status by using this trace event
李者璈 & Zheaoli
Email: [email protected]
Github: https://github.com/Zheaoli
Thank you for your feedback.
I'm glad that it's helpful for you.
Thanks,
Leon