Skip to contentSkip to conversation

Add prog_kfunc feature probe

RFC PATCH Superseded Tao Chen 2 participants 5 messages Jan 22, 2025 – Jan 23, 2025

Subsystems (4)

v1 of 7 Superseded Latest is v7 →

lore
Share & tools
lore

Tao Chen

author
#0 lore raw

cover Add prog_kfunc feature probe

More and more kfunc functions are being added to the kernel. Different prog types have different restrictions when using kfunc. Therefore, prog_kfunc probe is added to check whether it is supported, and the use of this api will be added to bpftool later.

Tao Chen (2):
libbpf: Add libbpf_probe_bpf_kfunc API selftests/bpf: Add libbpf_probe_bpf_kfunc API selftests

 tools/lib/bpf/libbpf.h                        | 16 ++++++++-
 tools/lib/bpf/libbpf.map                      |  1 +
 tools/lib/bpf/libbpf_probes.c                 | 36 +++++++++++++++++++
 .../selftests/bpf/prog_tests/libbpf_probes.c  | 30 ++++++++++++++++
 4 files changed, 82 insertions(+), 1 deletion(-)
Signature · 1 line
2.43.0
author
#1 lore raw

RFC PATCH 1/2 libbpf: Add libbpf_probe_bpf_kfunc API

Similarly to libbpf_probe_bpf_helper, the libbpf_probe_bpf_kfunc used to test the availability of the different eBPF kfuncs on the current system.

---
 tools/lib/bpf/libbpf.h        | 16 +++++++++++++++-
 tools/lib/bpf/libbpf.map      |  1 +
 tools/lib/bpf/libbpf_probes.c | 36 +++++++++++++++++++++++++++++++++++
 3 files changed, 52 insertions(+), 1 deletion(-)
tools/lib/bpf/libbpf.h +15 -1
index 3020ee45303a..3b6d33578a16 100644
@@ -1680,7 +1680,21 @@ LIBBPF_API int libbpf_probe_bpf_map_type(enum bpf_map_type map_type, const void
  */
 LIBBPF_API int libbpf_probe_bpf_helper(enum bpf_prog_type prog_type,
 				       enum bpf_func_id helper_id, const void *opts);
-
+/**
+ * @brief **libbpf_probe_bpf_kfunc()** detects if host kernel supports the
+ * use of a given BPF kfunc from specified BPF program type.
+ * @param prog_type BPF program type used to check the support of BPF kfunc
+ * @param kfunc_id The btf ID of BPF kfunc to check support for
+ * @param opts reserved for future extensibility, should be NULL
+ * @return 1, if given combination of program type and kfunc is supported; 0,
+ * if the combination is not supported; negative error code if feature
+ * detection for provided input arguments failed or can't be performed
+ *
+ * Make sure the process has required set of CAP_* permissions (or runs as
+ * root) when performing feature checking.
+ */
+LIBBPF_API int libbpf_probe_bpf_kfunc(enum bpf_prog_type prog_type,
+				      int kfunc_id, const void *opts);
 /**
  * @brief **libbpf_num_possible_cpus()** is a helper function to get the
  * number of possible CPUs that the host kernel supports and expects.
tools/lib/bpf/libbpf.map +1 -0
index a8b2936a1646..e93fae101efd 100644
@@ -436,4 +436,5 @@ LIBBPF_1.6.0 {
 		bpf_linker__add_buf;
 		bpf_linker__add_fd;
 		bpf_linker__new_fd;
+		libbpf_probe_bpf_kfunc;
 } LIBBPF_1.5.0;
tools/lib/bpf/libbpf_probes.c +36 -0
index 9dfbe7750f56..bc1cf2afbe87 100644
@@ -413,6 +413,42 @@ int libbpf_probe_bpf_map_type(enum bpf_map_type map_type, const void *opts)
 	return libbpf_err(ret);
 }
 
+int libbpf_probe_bpf_kfunc(enum bpf_prog_type prog_type, int kfunc_id,
+			   const void *opts)
+{
+	struct bpf_insn insns[] = {
+		BPF_EXIT_INSN(),
+		BPF_EXIT_INSN(),
+	};
+	const size_t insn_cnt = ARRAY_SIZE(insns);
+	int err;
+	char buf[4096];
+
+	if (opts)
+		return libbpf_err(-EINVAL);
+
+	insns[0].code = BPF_JMP | BPF_CALL;
+	insns[0].src_reg = BPF_PSEUDO_KFUNC_CALL;
+	insns[0].imm = kfunc_id;
+
+	/* Now only support kfunc from vmlinux */
+	insns[0].off = 0;
+
+	buf[0] = '\0';
+	err = probe_prog_load(prog_type, insns, insn_cnt, buf, sizeof(buf));
+	if (err < 0)
+		return libbpf_err(err);
+
+	/* If BPF verifier recognizes BPF kfunc but it's not supported for
+	 * given BPF program type, it will emit "calling kernel function
+	 * bpf_cpumask_create is not allowed"
+	 */
+	if (err == 0 && strstr(buf, "not allowed"))
+		return 0;
+
+	return 1; /* assume supported */
+}
+
 int libbpf_probe_bpf_helper(enum bpf_prog_type prog_type, enum bpf_func_id helper_id,
 			    const void *opts)
 {
Signature · 1 line
2.43.0
#2 lore raw

Re: [RFC PATCH bpf-next 1/2] libbpf: Add libbpf_probe_bpf_kfunc API

Quoted 60 lines · Tao Chen

Similarly to libbpf_probe_bpf_helper, the libbpf_probe_bpf_kfunc used to test the availability of the different eBPF kfuncs on the current system.

---
 tools/lib/bpf/libbpf.h        | 16 +++++++++++++++-
 tools/lib/bpf/libbpf.map      |  1 +
 tools/lib/bpf/libbpf_probes.c | 36 +++++++++++++++++++++++++++++++++++
 3 files changed, 52 insertions(+), 1 deletion(-)
tools/lib/bpf/libbpf.h +15 -1
index 3020ee45303a..3b6d33578a16 100644
@@ -1680,7 +1680,21 @@ LIBBPF_API int libbpf_probe_bpf_map_type(enum bpf_map_type map_type, const void
  */
 LIBBPF_API int libbpf_probe_bpf_helper(enum bpf_prog_type prog_type,
                                       enum bpf_func_id helper_id, const void *opts);
-
+/**
+ * @brief **libbpf_probe_bpf_kfunc()** detects if host kernel supports the
+ * use of a given BPF kfunc from specified BPF program type.
+ * @param prog_type BPF program type used to check the support of BPF kfunc
+ * @param kfunc_id The btf ID of BPF kfunc to check support for
+ * @param opts reserved for future extensibility, should be NULL
+ * @return 1, if given combination of program type and kfunc is supported; 0,
+ * if the combination is not supported; negative error code if feature
+ * detection for provided input arguments failed or can't be performed
+ *
+ * Make sure the process has required set of CAP_* permissions (or runs as
+ * root) when performing feature checking.
+ */
+LIBBPF_API int libbpf_probe_bpf_kfunc(enum bpf_prog_type prog_type,
+                                     int kfunc_id, const void *opts);
 /**
  * @brief **libbpf_num_possible_cpus()** is a helper function to get the
  * number of possible CPUs that the host kernel supports and expects.
tools/lib/bpf/libbpf.map +1 -0
index a8b2936a1646..e93fae101efd 100644
@@ -436,4 +436,5 @@ LIBBPF_1.6.0 {
                bpf_linker__add_buf;
                bpf_linker__add_fd;
                bpf_linker__new_fd;
+               libbpf_probe_bpf_kfunc;
 } LIBBPF_1.5.0;
tools/lib/bpf/libbpf_probes.c +3 -0
index 9dfbe7750f56..bc1cf2afbe87 100644
@@ -413,6 +413,42 @@ int libbpf_probe_bpf_map_type(enum bpf_map_type map_type, const void *opts)
        return libbpf_err(ret);
 }
 
+int libbpf_probe_bpf_kfunc(enum bpf_prog_type prog_type, int kfunc_id,
+                          const void *opts)
+{

tools/lib/bpf/libbpf_probes.c int libbpf_probe_bpf_map_type(enum bpf_map_type map_type, const void *opts) · line 428

Quoted 10 lines
tools/lib/bpf/libbpf_probes.c +10 -0
+       struct bpf_insn insns[] = {
+               BPF_EXIT_INSN(),
+               BPF_EXIT_INSN(),
+       };
+       const size_t insn_cnt = ARRAY_SIZE(insns);
+       int err;
+       char buf[4096];
+
+       if (opts)
+               return libbpf_err(-EINVAL);

note how libbpf_probe_bpf_helper() rejects some program types because they can't be really loaded. Let's keep it consistent?

pw-bot: cr

tools/lib/bpf/libbpf_probes.c int libbpf_probe_bpf_map_type(enum bpf_map_type map_type, const void *opts) · line 435

Quoted 7 lines
tools/lib/bpf/libbpf_probes.c +7 -0
+
+       insns[0].code = BPF_JMP | BPF_CALL;
+       insns[0].src_reg = BPF_PSEUDO_KFUNC_CALL;
+       insns[0].imm = kfunc_id;
+
+       /* Now only support kfunc from vmlinux */
+       insns[0].off = 0;

why not support modules from the very beginning?

tools/lib/bpf/libbpf_probes.c int libbpf_probe_bpf_map_type(enum bpf_map_type map_type, const void *opts) · line 446

Quoted 11 lines
tools/lib/bpf/libbpf_probes.c +11 -0
+
+       buf[0] = '\0';
+       err = probe_prog_load(prog_type, insns, insn_cnt, buf, sizeof(buf));
+       if (err < 0)
+               return libbpf_err(err);
+
+       /* If BPF verifier recognizes BPF kfunc but it's not supported for
+        * given BPF program type, it will emit "calling kernel function
+        * bpf_cpumask_create is not allowed"
+        */
+       if (err == 0 && strstr(buf, "not allowed"))

Looking at kernel code, if kfunc ID is not recognized, it seems like the verifier won't print anything, is that right? If that's the case, then this API will behave differently from libbpf_probe_bpf_helper(), which isn't great.

Quoted 11 lines
tools/lib/bpf/libbpf_probes.c +5 -1
+               return 0;
+
+       return 1; /* assume supported */
+}
+
 int libbpf_probe_bpf_helper(enum bpf_prog_type prog_type, enum bpf_func_id helper_id,
                            const void *opts)
 {
--

2.43.0

author
#3 lore raw

Re: [RFC PATCH bpf-next 1/2] libbpf: Add libbpf_probe_bpf_kfunc API

Quoted 58 lines · Andrii Nakryiko
Quoted 57 lines · Tao Chen

Similarly to libbpf_probe_bpf_helper, the libbpf_probe_bpf_kfunc used to test the availability of the different eBPF kfuncs on the current system.

---
  tools/lib/bpf/libbpf.h        | 16 +++++++++++++++-
  tools/lib/bpf/libbpf.map      |  1 +
  tools/lib/bpf/libbpf_probes.c | 36 +++++++++++++++++++++++++++++++++++
  3 files changed, 52 insertions(+), 1 deletion(-)
tools/lib/bpf/libbpf.h +15 -1
index 3020ee45303a..3b6d33578a16 100644
@@ -1680,7 +1680,21 @@ LIBBPF_API int libbpf_probe_bpf_map_type(enum bpf_map_type map_type, const void
   */
  LIBBPF_API int libbpf_probe_bpf_helper(enum bpf_prog_type prog_type,
                                        enum bpf_func_id helper_id, const void *opts);
-
+/**
+ * @brief **libbpf_probe_bpf_kfunc()** detects if host kernel supports the
+ * use of a given BPF kfunc from specified BPF program type.
+ * @param prog_type BPF program type used to check the support of BPF kfunc
+ * @param kfunc_id The btf ID of BPF kfunc to check support for
+ * @param opts reserved for future extensibility, should be NULL
+ * @return 1, if given combination of program type and kfunc is supported; 0,
+ * if the combination is not supported; negative error code if feature
+ * detection for provided input arguments failed or can't be performed
+ *
+ * Make sure the process has required set of CAP_* permissions (or runs as
+ * root) when performing feature checking.
+ */
+LIBBPF_API int libbpf_probe_bpf_kfunc(enum bpf_prog_type prog_type,
+                                     int kfunc_id, const void *opts);
  /**
   * @brief **libbpf_num_possible_cpus()** is a helper function to get the
   * number of possible CPUs that the host kernel supports and expects.
tools/lib/bpf/libbpf.map +1 -0
index a8b2936a1646..e93fae101efd 100644
@@ -436,4 +436,5 @@ LIBBPF_1.6.0 {
                 bpf_linker__add_buf;
                 bpf_linker__add_fd;
                 bpf_linker__new_fd;
+               libbpf_probe_bpf_kfunc;
  } LIBBPF_1.5.0;
tools/lib/bpf/libbpf_probes.c +0 -0
index 9dfbe7750f56..bc1cf2afbe87 100644
@@ -413,6 +413,42 @@ int libbpf_probe_bpf_map_type(enum bpf_map_type map_type, const void *opts)
         return libbpf_err(ret);
  }
 
Quoted 17 lines

tools/lib/bpf/libbpf_probes.c int libbpf_probe_bpf_map_type(enum bpf_map_type map_type, const void *opts) · line 428

Quoted 13 lines
tools/lib/bpf/libbpf_probes.c +13 -0
+int libbpf_probe_bpf_kfunc(enum bpf_prog_type prog_type, int kfunc_id,
+                          const void *opts)
+{
+       struct bpf_insn insns[] = {
+               BPF_EXIT_INSN(),
+               BPF_EXIT_INSN(),
+       };
+       const size_t insn_cnt = ARRAY_SIZE(insns);
+       int err;
+       char buf[4096];
+
+       if (opts)
+               return libbpf_err(-EINVAL);

note how libbpf_probe_bpf_helper() rejects some program types because they can't be really loaded. Let's keep it consistent?

Hi andrii, thank you for your guidance, i will add it later.

Quoted 12 lines

pw-bot: cr

tools/lib/bpf/libbpf_probes.c int libbpf_probe_bpf_map_type(enum bpf_map_type map_type, const void *opts) · line 435

Quoted 7 lines
tools/lib/bpf/libbpf_probes.c +7 -0
+
+       insns[0].code = BPF_JMP | BPF_CALL;
+       insns[0].src_reg = BPF_PSEUDO_KFUNC_CALL;
+       insns[0].imm = kfunc_id;
+
+       /* Now only support kfunc from vmlinux */
+       insns[0].off = 0;

why not support modules from the very beginning?

So can we add a new parameter named like "off"? If it's a module, pass the BTF offset to insns[0].off. If it's vmlinux, pass 0.

Quoted 8 lines
Quoted 8 lines
tools/lib/bpf/libbpf_probes.c +8 -0
+
+       buf[0] = '\0';
+       err = probe_prog_load(prog_type, insns, insn_cnt, buf, sizeof(buf));
+       if (err < 0)
+               return libbpf_err(err);
+
+       /* If BPF verifier recognizes BPF kfunc but it's not supported for
+        * given BPF program type, it will emit "calling kernel function
Quoted 9 lines

tools/lib/bpf/libbpf_probes.c int libbpf_probe_bpf_map_type(enum bpf_map_type map_type, const void *opts) · line 446

Quoted 3 lines
tools/lib/bpf/libbpf_probes.c +3 -0
+        * bpf_cpumask_create is not allowed"
+        */
+       if (err == 0 && strstr(buf, "not allowed"))

Looking at kernel code, if kfunc ID is not recognized, it seems like the verifier won't print anything, is that right? If that's the case, then this API will behave differently from libbpf_probe_bpf_helper(), which isn't great.

You mean kfunc id is invalid? i try set kfunc id with -1 ret = libbpf_probe_bpf_kfunc(BPF_PROG_TYPE_SYSCALL, -1, NULL); And the verifier will print like:
"kernel btf_id 4294967295 is not a function"

So "not a function" may also be checked, i will add it in v2.

Quoted 11 lines
Quoted 11 lines
tools/lib/bpf/libbpf_probes.c +5 -1
+               return 0;
+
+       return 1; /* assume supported */
+}
+
  int libbpf_probe_bpf_helper(enum bpf_prog_type prog_type, enum bpf_func_id helper_id,
                             const void *opts)
  {
--

2.43.0

Signature · 2 lines
Best Regards
Dylane Chen
author
#4 lore raw

RFC PATCH 2/2 selftests/bpf: Add libbpf_probe_bpf_kfunc API selftests

In reply to Tao Chen

Add selftests for prog_kfunc feature probing.

---
 .../selftests/bpf/prog_tests/libbpf_probes.c  | 30 +++++++++++++++++++
 1 file changed, 30 insertions(+)
tools/testing/selftests/bpf/prog_tests/libbpf_probes.c +30 -0
index 4ed46ed58a7b..5f94971649db 100644
@@ -126,3 +126,33 @@ void test_libbpf_probe_helpers(void)
 		ASSERT_EQ(res, d->supported, buf);
 	}
 }
+
+void test_libbpf_probe_kfuncs(void)
+{
+	int ret, kfunc_id;
+	char kfunc[64] = "bpf_cpumask_create";
+	struct btf *btf;
+
+	btf = btf__parse("/sys/kernel/btf/vmlinux", NULL);
+	if (!ASSERT_OK_PTR(btf, "btf_parse"))
+		return;
+
+	kfunc_id = btf__find_by_name_kind(btf, kfunc, BTF_KIND_FUNC);
+	if (!ASSERT_GT(kfunc_id, 0, kfunc))
+		goto cleanup;
+	/* prog BPF_PROG_TYPE_SYSCALL supports kfunc bpf_cpumask_create */
+	ret = libbpf_probe_bpf_kfunc(BPF_PROG_TYPE_SYSCALL, kfunc_id, NULL);
+	ASSERT_EQ(ret, 1, kfunc);
+
+	/* prog BPF_PROG_TYPE_KPROBE does not support kfunc bpf_cpumask_create */
+	ret = libbpf_probe_bpf_kfunc(BPF_PROG_TYPE_KPROBE, kfunc_id, NULL);
+	ASSERT_EQ(ret, 0, kfunc);
+
+	/* invalid prog type */
+	ret = libbpf_probe_bpf_kfunc(100000, kfunc_id, NULL);
+	if (!ASSERT_LE(ret, 0, "invalid prog type:100000"))
+		goto cleanup;
+
+cleanup:
+	btf__free(btf);
+}
Signature · 1 line
2.43.0