Skip to contentSkip to conversation

Refactor perf_event sample user program with libbpf bpf_link

PATCH Applied Daniel T. Lee 3 participants 7 messages Mar 21, 2020 – Mar 23, 2020

Subsystems (5)
lore
Share & tools
lore
#0 lore raw

v5 cover Refactor perf_event sample user program with libbpf bpf_link

Currently, some samples are using ioctl for enabling perf_event and attaching BPF programs to this event. However, the bpf_program__attach of libbpf(using bpf_link) is much more intuitive than the previous method using ioctl.

bpf_program__attach_perf_event manages the enable of perf_event and attach of BPF programs to it, so there's no neeed to do this directly with ioctl.

In addition, bpf_link provides consistency in the use of API because it allows disable (detach, destroy) for multiple events to be treated as one bpf_link__destroy.

To refactor samples with using this libbpf API, the bpf_load in the samples were removed and migrated to libbbpf. Because read_trace_pipe is used in bpf_load, multiple samples cannot be migrated to libbpf, this function was moved to trace_helpers.

Changes in v2:
- check memory allocation is successful
- clean up allocated memory on error

Changes in v3:
- Improve pointer error check (IS_ERR())
- change to calloc for easier destroy of bpf_link
- remove perf_event fd list since bpf_link handles fd
- use newer bpf_object__{open/load} API instead of bpf_prog_load
- perf_event for _SC_NPROCESSORS_ONLN instead of _SC_NPROCESSORS_CONF
- sample specific chagnes...

Changes in v4:
- bpf_link *, bpf_object * set NULL on init & err for easier destroy
- close bpf object with bpf_object__close()

Changes in v5:
- on error, return error code with exit

Daniel T. Lee (2):
samples: bpf: move read_trace_pipe to trace_helpers
samples: bpf: refactor perf_event user program with libbpf bpf_link

 samples/bpf/Makefile                        |   8 +-
 samples/bpf/bpf_load.c                      |  20 ---
 samples/bpf/bpf_load.h                      |   1 -
 samples/bpf/sampleip_user.c                 |  98 +++++++++-----
 samples/bpf/trace_event_user.c              | 139 +++++++++++++-------
 samples/bpf/tracex1_user.c                  |   1 +
 samples/bpf/tracex5_user.c                  |   1 +
 tools/testing/selftests/bpf/trace_helpers.c |  23 ++++
 tools/testing/selftests/bpf/trace_helpers.h |   1 +
 9 files changed, 187 insertions(+), 105 deletions(-)
Signature · 1 line
2.25.1
#1 lore raw

PATCH v5 1/2 samples: bpf: move read_trace_pipe to trace_helpers

To reduce the reliance of trace samples (trace*_user) on bpf_load, move read_trace_pipe to trace_helpers. By moving this bpf_loader helper elsewhere, trace functions can be easily migrated to libbbpf.

---
 samples/bpf/Makefile                        |  4 ++--
 samples/bpf/bpf_load.c                      | 20 ------------------
 samples/bpf/bpf_load.h                      |  1 -
 samples/bpf/tracex1_user.c                  |  1 +
 samples/bpf/tracex5_user.c                  |  1 +
 tools/testing/selftests/bpf/trace_helpers.c | 23 +++++++++++++++++++++
 tools/testing/selftests/bpf/trace_helpers.h |  1 +
 7 files changed, 28 insertions(+), 23 deletions(-)
samples/bpf/Makefile +2 -2
index 79b0fee6943b..ff0061467dd3 100644
@@ -64,11 +64,11 @@ fds_example-objs := fds_example.o
 sockex1-objs := sockex1_user.o
 sockex2-objs := sockex2_user.o
 sockex3-objs := bpf_load.o sockex3_user.o
-tracex1-objs := bpf_load.o tracex1_user.o
+tracex1-objs := bpf_load.o tracex1_user.o $(TRACE_HELPERS)
 tracex2-objs := bpf_load.o tracex2_user.o
 tracex3-objs := bpf_load.o tracex3_user.o
 tracex4-objs := bpf_load.o tracex4_user.o
-tracex5-objs := bpf_load.o tracex5_user.o
+tracex5-objs := bpf_load.o tracex5_user.o $(TRACE_HELPERS)
 tracex6-objs := bpf_load.o tracex6_user.o
 tracex7-objs := bpf_load.o tracex7_user.o
 test_probe_write_user-objs := bpf_load.o test_probe_write_user_user.o
samples/bpf/bpf_load.c +0 -20
index 4574b1939e49..c5ad528f046e 100644
@@ -665,23 +665,3 @@ int load_bpf_file_fixup_map(const char *path, fixup_map_cb fixup_map)
 {
 	return do_load_bpf_file(path, fixup_map);
 }
-
-void read_trace_pipe(void)
-{
-	int trace_fd;
-
-	trace_fd = open(DEBUGFS "trace_pipe", O_RDONLY, 0);
-	if (trace_fd < 0)
-		return;
-
-	while (1) {
-		static char buf[4096];
-		ssize_t sz;
-
-		sz = read(trace_fd, buf, sizeof(buf) - 1);
-		if (sz > 0) {
-			buf[sz] = 0;
-			puts(buf);
-		}
-	}
-}
samples/bpf/bpf_load.h +0 -1
index 814894a12974..4fcd258c616f 100644
@@ -53,6 +53,5 @@ extern int map_data_count;
 int load_bpf_file(char *path);
 int load_bpf_file_fixup_map(const char *path, fixup_map_cb fixup_map);
 
-void read_trace_pipe(void);
 int bpf_set_link_xdp_fd(int ifindex, int fd, __u32 flags);
 #endif
samples/bpf/tracex1_user.c +1 -0
index af8c20608ab5..55fddbd08702 100644
@@ -4,6 +4,7 @@
 #include <unistd.h>
 #include <bpf/bpf.h>
 #include "bpf_load.h"
+#include "trace_helpers.h"
 
 int main(int ac, char **argv)
 {
samples/bpf/tracex5_user.c +1 -0
index c4ab91c89494..c2317b39e0d2 100644
@@ -8,6 +8,7 @@
 #include <bpf/bpf.h>
 #include "bpf_load.h"
 #include <sys/resource.h>
+#include "trace_helpers.h"
 
 /* install fake seccomp program to enable seccomp code path inside the kernel,
  * so that our kprobe attached to seccomp_phase1() can be triggered
tools/testing/selftests/bpf/trace_helpers.c +23 -0
index 7f989b3e4e22..4d0e913bbb22 100644
@@ -4,12 +4,15 @@
 #include <string.h>
 #include <assert.h>
 #include <errno.h>
+#include <fcntl.h>
 #include <poll.h>
 #include <unistd.h>
 #include <linux/perf_event.h>
 #include <sys/mman.h>
 #include "trace_helpers.h"
 
+#define DEBUGFS "/sys/kernel/debug/tracing/"
+
 #define MAX_SYMS 300000
 static struct ksym syms[MAX_SYMS];
 static int sym_cnt;
@@ -86,3 +89,23 @@ long ksym_get_addr(const char *name)
 
 	return 0;
 }
+
+void read_trace_pipe(void)
+{
+	int trace_fd;
+
+	trace_fd = open(DEBUGFS "trace_pipe", O_RDONLY, 0);
+	if (trace_fd < 0)
+		return;
+
+	while (1) {
+		static char buf[4096];
+		ssize_t sz;
+
+		sz = read(trace_fd, buf, sizeof(buf) - 1);
+		if (sz > 0) {
+			buf[sz] = 0;
+			puts(buf);
+		}
+	}
+}
tools/testing/selftests/bpf/trace_helpers.h +1 -0
index 0383c9b8adc1..25ef597dd03f 100644
@@ -12,5 +12,6 @@ struct ksym {
 int load_kallsyms(void);
 struct ksym *ksym_search(long key);
 long ksym_get_addr(const char *name);
+void read_trace_pipe(void);
 
 #endif
Signature · 1 line
2.25.1
Acked-by on v5 1/2
#2 lore raw

Re: [PATCH bpf-next v5 1/2] samples: bpf: move read_trace_pipe to trace_helpers

Quoted 7 lines · Daniel T. Lee

To reduce the reliance of trace samples (trace*_user) on bpf_load, move read_trace_pipe to trace_helpers. By moving this bpf_loader helper elsewhere, trace functions can be easily migrated to libbbpf.

---

Quoted 9 lines
 samples/bpf/Makefile                        |  4 ++--
 samples/bpf/bpf_load.c                      | 20 ------------------
 samples/bpf/bpf_load.h                      |  1 -
 samples/bpf/tracex1_user.c                  |  1 +
 samples/bpf/tracex5_user.c                  |  1 +
 tools/testing/selftests/bpf/trace_helpers.c | 23 +++++++++++++++++++++
 tools/testing/selftests/bpf/trace_helpers.h |  1 +
 7 files changed, 28 insertions(+), 23 deletions(-)

[...]

#3 lore raw

PATCH v5 2/2 samples: bpf: refactor perf_event user program with libbpf bpf_link

In reply to Daniel T. Lee

The bpf_program__attach of libbpf(using bpf_link) is much more intuitive than the previous method using ioctl.

bpf_program__attach_perf_event manages the enable of perf_event and attach of BPF programs to it, so there's no neeed to do this directly with ioctl.

In addition, bpf_link provides consistency in the use of API because it allows disable (detach, destroy) for multiple events to be treated as one bpf_link__destroy. Also, bpf_link__destroy manages the close() of perf_event fd.

This commit refactors samples that attach the bpf program to perf_event by using libbbpf instead of ioctl. Also the bpf_load in the samples were removed and migrated to use libbbpf API.

---
Changes in v2:
- check memory allocation is successful
- clean up allocated memory on error

Changes in v3:
- Improve pointer error check (IS_ERR())
- change to calloc for easier destroy of bpf_link
- remove perf_event fd list since bpf_link handles fd
- use newer bpf_object__{open/load} API instead of bpf_prog_load
- perf_event for _SC_NPROCESSORS_ONLN instead of _SC_NPROCESSORS_CONF
- find program with name explicitly instead of bpf_program__next
- unconditional bpf_link__destroy() on cleanup

Changes in v4:
- bpf_link *, bpf_object * set NULL on init & err for easier destroy
- close bpf object with bpf_object__close()

Changes in v5:
- on error, return error code with exit

 samples/bpf/Makefile           |   4 +-
 samples/bpf/sampleip_user.c    |  98 +++++++++++++++--------
 samples/bpf/trace_event_user.c | 139 ++++++++++++++++++++++-----------
 3 files changed, 159 insertions(+), 82 deletions(-)
samples/bpf/Makefile +2 -2
index ff0061467dd3..424f6fe7ce38 100644
@@ -88,8 +88,8 @@ xdp2-objs := xdp1_user.o
 xdp_router_ipv4-objs := xdp_router_ipv4_user.o
 test_current_task_under_cgroup-objs := bpf_load.o $(CGROUP_HELPERS) \
 				       test_current_task_under_cgroup_user.o
-trace_event-objs := bpf_load.o trace_event_user.o $(TRACE_HELPERS)
-sampleip-objs := bpf_load.o sampleip_user.o $(TRACE_HELPERS)
+trace_event-objs := trace_event_user.o $(TRACE_HELPERS)
+sampleip-objs := sampleip_user.o $(TRACE_HELPERS)
 tc_l2_redirect-objs := bpf_load.o tc_l2_redirect_user.o
 lwt_len_hist-objs := bpf_load.o lwt_len_hist_user.o
 xdp_tx_iptunnel-objs := xdp_tx_iptunnel_user.o
samples/bpf/sampleip_user.c +64 -34

172 lines not on this page · raw message

samples/bpf/trace_event_user.c +93 -46

232 lines not on this page · raw message

Signature · 1 line
2.25.1
Acked-by on v5 2/2
#4 lore raw

Re: [PATCH bpf-next v5 2/2] samples: bpf: refactor perf_event user program with libbpf bpf_link

Quoted 13 lines · Daniel T. Lee

The bpf_program__attach of libbpf(using bpf_link) is much more intuitive than the previous method using ioctl.

bpf_program__attach_perf_event manages the enable of perf_event and attach of BPF programs to it, so there's no neeed to do this directly with ioctl.

In addition, bpf_link provides consistency in the use of API because it allows disable (detach, destroy) for multiple events to be treated as one bpf_link__destroy. Also, bpf_link__destroy manages the close() of perf_event fd.

Quoted 7 lines

This commit refactors samples that attach the bpf program to perf_event by using libbbpf instead of ioctl. Also the bpf_load in the samples were removed and migrated to use libbbpf API.

---

LGTM.

Quoted 25 lines

Changes in v2:
- check memory allocation is successful
- clean up allocated memory on error

Changes in v3:
- Improve pointer error check (IS_ERR())
- change to calloc for easier destroy of bpf_link
- remove perf_event fd list since bpf_link handles fd
- use newer bpf_object__{open/load} API instead of bpf_prog_load
- perf_event for _SC_NPROCESSORS_ONLN instead of _SC_NPROCESSORS_CONF
- find program with name explicitly instead of bpf_program__next
- unconditional bpf_link__destroy() on cleanup

Changes in v4:
- bpf_link *, bpf_object * set NULL on init & err for easier destroy
- close bpf object with bpf_object__close()

Changes in v5:
- on error, return error code with exit

 samples/bpf/Makefile           |   4 +-
 samples/bpf/sampleip_user.c    |  98 +++++++++++++++--------
 samples/bpf/trace_event_user.c | 139 ++++++++++++++++++++++-----------
 3 files changed, 159 insertions(+), 82 deletions(-)

[...]

#5 lore raw

Re: [PATCH bpf-next v5 2/2] samples: bpf: refactor perf_event user program with libbpf bpf_link

Thank you for your time and effort for the review :)

Best,
Daniel

Quoted 54 lines · Andrii Nakryiko
Quoted 13 lines · Daniel T. Lee

The bpf_program__attach of libbpf(using bpf_link) is much more intuitive than the previous method using ioctl.

bpf_program__attach_perf_event manages the enable of perf_event and attach of BPF programs to it, so there's no neeed to do this directly with ioctl.

In addition, bpf_link provides consistency in the use of API because it allows disable (detach, destroy) for multiple events to be treated as one bpf_link__destroy. Also, bpf_link__destroy manages the close() of perf_event fd.

Quoted 7 lines

This commit refactors samples that attach the bpf program to perf_event by using libbbpf instead of ioctl. Also the bpf_load in the samples were removed and migrated to use libbbpf API.

---

LGTM.

Quoted 25 lines

Changes in v2:
- check memory allocation is successful
- clean up allocated memory on error

Changes in v3:
- Improve pointer error check (IS_ERR())
- change to calloc for easier destroy of bpf_link
- remove perf_event fd list since bpf_link handles fd
- use newer bpf_object__{open/load} API instead of bpf_prog_load
- perf_event for _SC_NPROCESSORS_ONLN instead of _SC_NPROCESSORS_CONF
- find program with name explicitly instead of bpf_program__next
- unconditional bpf_link__destroy() on cleanup

Changes in v4:
- bpf_link *, bpf_object * set NULL on init & err for easier destroy
- close bpf object with bpf_object__close()

Changes in v5:
- on error, return error code with exit

 samples/bpf/Makefile           |   4 +-
 samples/bpf/sampleip_user.c    |  98 +++++++++++++++--------
 samples/bpf/trace_event_user.c | 139 ++++++++++++++++++++++-----------
 3 files changed, 159 insertions(+), 82 deletions(-)

[...]

maintainer Applied
#6 lore raw
In reply to Daniel T. Lee
Quoted 9 lines · Daniel T. Lee

Currently, some samples are using ioctl for enabling perf_event and attaching BPF programs to this event. However, the bpf_program__attach of libbpf(using bpf_link) is much more intuitive than the previous method using ioctl.

bpf_program__attach_perf_event manages the enable of perf_event and attach of BPF programs to it, so there's no neeed to do this directly with ioctl.

Quoted 8 lines

In addition, bpf_link provides consistency in the use of API because it allows disable (detach, destroy) for multiple events to be treated as one bpf_link__destroy.

To refactor samples with using this libbpf API, the bpf_load in the samples were removed and migrated to libbbpf. Because read_trace_pipe is used in bpf_load, multiple samples cannot be migrated to libbpf, this function was moved to trace_helpers.

Applied, thanks!