bpf: add _impl suffix for kfuncs with implicit args
Subsystems (6)
v2 cover bpf: add _impl suffix for kfuncs with implicit args
We’re introducing support for implicit kfunc arguments and need to rename new kfuncs to comply with the naming convention. This new feature, will for each kfunc of the form:
bpf_foo_impl(args..., aux__prog)
generate a public BTF type:
bpf_foo(args...)
and the verifier will resolve calls to bpf_foo() to bpf_foo_impl(), supplying a valid struct bpf_prog_aux via aux__prog.
Three kfuncs added in 6.18 don’t follow this *_impl convention and therefore won’t participate in the new mechanism:
* bpf_task_work_schedule_resume()
* bpf_task_work_schedule_signal()
* bpf_stream_vprintk()
Rename them to align with the implicit-arg flow:bpf_task_work_schedule_resume() -> bpf_task_work_schedule_resume_impl() bpf_task_work_schedule_signal() -> bpf_task_work_schedule_signal_impl() bpf_stream_vprintk() -> bpf_stream_vprintk_impl()
The implicit-arg mechanism is not in tree yet, so callers must switch to the *_impl names for now. Once the new mechanism lands, the plain names (without _impl) will be reintroduced as BTF-visible entry points and will resolve to the _impl versions automatically.
---
Changes in v1:
- Split commit into 2
- Rebase on the correct branch
- Link to v1: https://lore.kernel.org/all/[email protected]/
---
Mykyta Yatsenko (2):
bpf:add _impl suffix for bpf_task_work_schedule* kfuncs bpf:add _impl suffix for bpf_stream_vprintk() kfunc
kernel/bpf/helpers.c | 26 +++++++++++--------- kernel/bpf/stream.c | 3 ++- kernel/bpf/verifier.c | 12 +++++----- tools/bpf/bpftool/Documentation/bpftool-prog.rst | 2 +- tools/lib/bpf/bpf_helpers.h | 28 +++++++++++----------- tools/testing/selftests/bpf/progs/stream_fail.c | 6 ++--- tools/testing/selftests/bpf/progs/task_work.c | 6 ++--- tools/testing/selftests/bpf/progs/task_work_fail.c | 8 +++---- .../testing/selftests/bpf/progs/task_work_stress.c | 4 ++-- 9 files changed, 50 insertions(+), 45 deletions(-)
---
base-commit: 6146a0f1dfae5d37442a9ddcba012add260bceb0
change-id: 20251104-implv2-d6c4be255026
Best regards,
Signature · 1 line
Mykyta Yatsenko <[email protected]>
PATCH v2 1/2 bpf:add _impl suffix for bpf_task_work_schedule* kfuncs
From: Mykyta Yatsenko <[email protected]>
Rename:
bpf_task_work_schedule_resume()->bpf_task_work_schedule_resume_impl() bpf_task_work_schedule_signal()->bpf_task_work_schedule_signal_impl()
This aligns task work scheduling kfuncs with the naming scheme required by the implicit-argument feature.
--- kernel/bpf/helpers.c | 24 +++++++++++++--------- kernel/bpf/verifier.c | 12 +++++------ tools/testing/selftests/bpf/progs/task_work.c | 6 +++--- tools/testing/selftests/bpf/progs/task_work_fail.c | 8 ++++---- .../testing/selftests/bpf/progs/task_work_stress.c | 4 ++-- 5 files changed, 29 insertions(+), 25 deletions(-)
kernel/bpf/helpers.c +14 -10
@@ -4169,7 +4169,8 @@ static int bpf_task_work_schedule(struct task_struct *task, struct bpf_task_work }/** -* bpf_task_work_schedule_signal - Schedule BPF callback using task_work_add with TWA_SIGNAL mode +* bpf_task_work_schedule_signal_impl - Schedule BPF callback using task_work_add with TWA_SIGNAL +* mode * @task: Task struct for which callback should be scheduled * @tw: Pointer to struct bpf_task_work in BPF map value for internal bookkeeping * @map__map: bpf_map that embeds struct bpf_task_work in the values
@@ -4178,15 +4179,17 @@ static int bpf_task_work_schedule(struct task_struct *task, struct bpf_task_work* * Return: 0 if task work has been scheduled successfully, negative error code otherwise */ -__bpf_kfunc int bpf_task_work_schedule_signal(struct task_struct *task, struct bpf_task_work *tw, -void *map__map,bpf_task_work_callback_t callback, -void *aux__prog) +__bpf_kfunc int bpf_task_work_schedule_signal_impl(struct task_struct *task, +struct bpf_task_work *tw,void *map__map, +bpf_task_work_callback_t callback, +void *aux__prog) {return bpf_task_work_schedule (task, tw, map__map, callback, aux__prog,TWA_SIGNAL ); }/** -* bpf_task_work_schedule_resume - Schedule BPF callback using task_work_add with TWA_RESUME mode +* bpf_task_work_schedule_resume_impl - Schedule BPF callback using task_work_add with TWA_RESUME +* mode * @task: Task struct for which callback should be scheduled * @tw: Pointer to struct bpf_task_work in BPF map value for internal bookkeeping * @map__map: bpf_map that embeds struct bpf_task_work in the values
@@ -4195,9 +4198,10 @@ __bpf_kfunc int bpf_task_work_schedule_signal(struct task_struct *task, struct b* * Return: 0 if task work has been scheduled successfully, negative error code otherwise */ -__bpf_kfunc int bpf_task_work_schedule_resume(struct task_struct *task, struct bpf_task_work *tw, -void *map__map,bpf_task_work_callback_t callback, -void *aux__prog) +__bpf_kfunc int bpf_task_work_schedule_resume_impl(struct task_struct *task, +struct bpf_task_work *tw,void *map__map, +bpf_task_work_callback_t callback, +void *aux__prog) {return bpf_task_work_schedule (task, tw, map__map, callback, aux__prog,TWA_RESUME ); }
@@ -4377,8 +4381,8 @@ BTF_ID_FLAGS(func, bpf_strnstr); BTF_ID_FLAGS(func, bpf_cgroup_read_xattr, KF_RCU)#endif BTF_ID_FLAGS(func, bpf_stream_vprintk, KF_TRUSTED_ARGS) -BTF_ID_FLAGS(func, bpf_task_work_schedule_signal, KF_TRUSTED_ARGS) -BTF_ID_FLAGS(func, bpf_task_work_schedule_resume, KF_TRUSTED_ARGS) +BTF_ID_FLAGS(func, bpf_task_work_schedule_signal_impl, KF_TRUSTED_ARGS) +BTF_ID_FLAGS(func, bpf_task_work_schedule_resume_impl, KF_TRUSTED_ARGS)BTF_KFUNCS_END (common_btf_ids) static const struct btf_kfunc_id_set common_kfunc_set = {
kernel/bpf/verifier.c +6 -6
@@ -12259,8 +12259,8 @@ enum special_kfunc_type { KF_bpf_res_spin_lock_irqsave, KF_bpf_res_spin_unlock_irqrestore, KF___bpf_trap, - KF_bpf_task_work_schedule_signal, - KF_bpf_task_work_schedule_resume, + KF_bpf_task_work_schedule_signal_impl, + KF_bpf_task_work_schedule_resume_impl, };BTF_ID_LIST (special_kfunc_list)
@@ -12331,13 +12331,13 @@ BTF_ID(func, bpf_res_spin_unlock) BTF_ID(func, bpf_res_spin_lock_irqsave) BTF_ID(func, bpf_res_spin_unlock_irqrestore) BTF_ID(func, __bpf_trap) -BTF_ID(func, bpf_task_work_schedule_signal) -BTF_ID(func, bpf_task_work_schedule_resume) +BTF_ID(func, bpf_task_work_schedule_signal_impl) +BTF_ID(func, bpf_task_work_schedule_resume_impl)static bool is_task_work_add_kfunc (u32 func_id) { -return func_id == special_kfunc_list[KF_bpf_task_work_schedule_signal] || - func_id == special_kfunc_list[KF_bpf_task_work_schedule_resume]; +return func_id == special_kfunc_list[KF_bpf_task_work_schedule_signal_impl] || + func_id == special_kfunc_list[KF_bpf_task_work_schedule_resume_impl]; }static bool is_kfunc_ret_null (struct bpf_kfunc_call_arg_meta *meta)
tools/testing/selftests/bpf/progs/task_work.c +3 -3
@@ -66,7 +66,7 @@ int oncpu_hash_map(struct pt_regs *args)if (!work)return 0 ; -bpf_task_work_schedule_resume (task, &work->tw, &hmap, process_work,NULL ); +bpf_task_work_schedule_resume_impl (task, &work->tw, &hmap, process_work,NULL );return 0 ; }
@@ -80,7 +80,7 @@ int oncpu_array_map(struct pt_regs *args) work =bpf_map_lookup_elem (&arrmap, &key);if (!work)return 0 ; -bpf_task_work_schedule_signal (task, &work->tw, &arrmap, process_work,NULL ); +bpf_task_work_schedule_signal_impl (task, &work->tw, &arrmap, process_work,NULL );return 0 ; }
@@ -102,6 +102,6 @@ int oncpu_lru_map(struct pt_regs *args) work =bpf_map_lookup_elem (&lrumap, &key);if (!work || work->data[0 ])return 0 ; -bpf_task_work_schedule_resume (task, &work->tw, &lrumap, process_work,NULL ); +bpf_task_work_schedule_resume_impl (task, &work->tw, &lrumap, process_work,NULL );return 0 ; }
tools/testing/selftests/bpf/progs/task_work_fail.c +4 -4
@@ -53,7 +53,7 @@ int mismatch_map(struct pt_regs *args) work =bpf_map_lookup_elem (&arrmap, &key);if (!work)return 0 ; -bpf_task_work_schedule_resume (task, &work->tw, &hmap, process_work,NULL ); +bpf_task_work_schedule_resume_impl (task, &work->tw, &hmap, process_work,NULL );return 0 ; }
@@ -65,7 +65,7 @@ int no_map_task_work(struct pt_regs *args)struct bpf_task_work tw; task =bpf_get_current_task_btf (); -bpf_task_work_schedule_resume (task, &tw, &hmap, process_work,NULL ); +bpf_task_work_schedule_resume_impl (task, &tw, &hmap, process_work,NULL );return 0 ; }
@@ -76,7 +76,7 @@ int task_work_null(struct pt_regs *args)struct task_struct *task; task =bpf_get_current_task_btf (); -bpf_task_work_schedule_resume (task,NULL , &hmap, process_work,NULL ); +bpf_task_work_schedule_resume_impl (task,NULL , &hmap, process_work,NULL );return 0 ; }
@@ -91,6 +91,6 @@ int map_null(struct pt_regs *args) work =bpf_map_lookup_elem (&arrmap, &key);if (!work)return 0 ; -bpf_task_work_schedule_resume (task, &work->tw,NULL , process_work,NULL ); +bpf_task_work_schedule_resume_impl (task, &work->tw,NULL , process_work,NULL );return 0 ; }
tools/testing/selftests/bpf/progs/task_work_stress.c +2 -2
@@ -51,8 +51,8 @@ int schedule_task_work(void *ctx)if (!work)return 0 ; } - err =bpf_task_work_schedule_signal (bpf_get_current_task_btf (), &work->tw, &hmap, - process_work,NULL ); + err =bpf_task_work_schedule_signal_impl (bpf_get_current_task_btf (), &work->tw, &hmap, + process_work,NULL );if (err)__sync_fetch_and_add (&schedule_error,1 );else
Signature · 1 line
2.51.1
Re: [PATCH bpf v2 1/2] bpf:add _impl suffix for bpf_task_work_schedule* kfuncs
Quoted 10 lines · Mykyta Yatsenko
From: Mykyta Yatsenko <[email protected]>
Rename:
bpf_task_work_schedule_resume()->bpf_task_work_schedule_resume_impl() bpf_task_work_schedule_signal()->bpf_task_work_schedule_signal_impl()This aligns task work scheduling kfuncs with the naming scheme required by the implicit-argument feature.
Quoted 9 lines
Signed-off-by Mykyta Yatsenko <[email protected]>--- kernel/bpf/helpers.c | 24 +++++++++++++--------- kernel/bpf/verifier.c | 12 +++++------ tools/testing/selftests/bpf/progs/task_work.c | 6 +++--- tools/testing/selftests/bpf/progs/task_work_fail.c | 8 ++++---- .../testing/selftests/bpf/progs/task_work_stress.c | 4 ++-- 5 files changed, 29 insertions(+), 25 deletions(-)
LGTM, thanks!
[...]
PATCH v2 2/2 bpf:add _impl suffix for bpf_stream_vprintk() kfunc
In reply to Mykyta YatsenkoFrom: Mykyta Yatsenko <[email protected]>
Rename bpf_stream_vprintk() to bpf_stream_vprintk_impl().
This aligns this recently added kfunc with the naming scheme required by the implicit-argument feature.
In future BTF type for bpf_stream_vprintk() will be generated and aux__prog argument filled by the valid struct implicitly.
--- kernel/bpf/helpers.c | 2 +- kernel/bpf/stream.c | 3 ++- tools/bpf/bpftool/Documentation/bpftool-prog.rst | 2 +- tools/lib/bpf/bpf_helpers.h | 28 ++++++++++++------------ tools/testing/selftests/bpf/progs/stream_fail.c | 6 ++--- 5 files changed, 21 insertions(+), 20 deletions(-)
kernel/bpf/helpers.c +1 -1
@@ -4380,7 +4380,7 @@ BTF_ID_FLAGS(func, bpf_strnstr);#if defined(CONFIG_BPF_LSM ) && defined(CONFIG_CGROUPS ) BTF_ID_FLAGS(func, bpf_cgroup_read_xattr, KF_RCU)#endif -BTF_ID_FLAGS(func, bpf_stream_vprintk, KF_TRUSTED_ARGS) +BTF_ID_FLAGS(func, bpf_stream_vprintk_impl, KF_TRUSTED_ARGS) BTF_ID_FLAGS(func, bpf_task_work_schedule_signal_impl, KF_TRUSTED_ARGS) BTF_ID_FLAGS(func, bpf_task_work_schedule_resume_impl, KF_TRUSTED_ARGS)BTF_KFUNCS_END (common_btf_ids)
kernel/bpf/stream.c +2 -1
@@ -355,7 +355,8 @@ __bpf_kfunc_start_defs();* Avoid using enum bpf_stream_id so that kfunc users don't have to pull in the * enum in headers. */ -__bpf_kfunc int bpf_stream_vprintk(int stream_id, const char *fmt__str, const void *args, u32 len__sz, void *aux__prog) +__bpf_kfunc int bpf_stream_vprintk_impl(int stream_id, const char *fmt__str, const void *args, +u32 len__sz,void *aux__prog) {struct bpf_bprintf_data data = { .get_bin_args = true,
tools/bpf/bpftool/Documentation/bpftool-prog.rst +1 -1
@@ -182,7 +182,7 @@ bpftool prog tracelog bpftool prog tracelog { stdout | stderr } *PROG* Dump the BPF stream of the program. BPF programs can write to these streams - at runtime with the **bpf_stream_vprintk**\ () kfunc. The kernel may write + at runtime with the **bpf_stream_vprintk_impl**\ () kfunc. The kernel may write error messages to the standard error stream. This facility should be used only for debugging purposes.
tools/lib/bpf/bpf_helpers.h +14 -14
@@ -315,20 +315,20 @@ enum libbpf_tristate { ___param, sizeof(___param)); \ }) -extern int bpf_stream_vprintk(int stream_id, const char *fmt__str, const void *args, - __u32 len__sz, void *aux__prog) __weak __ksym; - -#define bpf_stream_printk(stream_id, fmt, args...) \ -({ \ - static const char ___fmt[] = fmt; \ - unsigned long long ___param[___bpf_narg(args)]; \ - \ - _Pragma("GCC diagnostic push") \ - _Pragma("GCC diagnostic ignored \"-Wint-conversion\"") \ - ___bpf_fill(___param, args); \ - _Pragma("GCC diagnostic pop") \ - \ - bpf_stream_vprintk(stream_id, ___fmt, ___param, sizeof(___param), NULL);\ +extern int bpf_stream_vprintk_impl(int stream_id, const char *fmt__str, const void *args, + __u32 len__sz, void *aux__prog) __weak __ksym; + +#define bpf_stream_printk(stream_id, fmt, args...) \ +({ \ + static const char ___fmt[] = fmt; \ + unsigned long long ___param[___bpf_narg(args)]; \ + \ + _Pragma("GCC diagnostic push") \ + _Pragma("GCC diagnostic ignored \"-Wint-conversion\"") \ + ___bpf_fill(___param, args); \ + _Pragma("GCC diagnostic pop") \ + \ + bpf_stream_vprintk_impl(stream_id, ___fmt, ___param, sizeof(___param), NULL); \ })/* Use __bpf_printk when bpf_printk call has 3 or fewer fmt args
tools/testing/selftests/bpf/progs/stream_fail.c +3 -3
@@ -10,7 +10,7 @@ SEC("syscall") __failure __msg("Possibly NULL pointer passed")int stream_vprintk_null_arg (void *ctx) { -bpf_stream_vprintk (BPF_STDOUT ,"" ,NULL ,0 ,NULL ); +bpf_stream_vprintk_impl (BPF_STDOUT ,"" ,NULL ,0 ,NULL );return 0 ; }
@@ -18,7 +18,7 @@ SEC("syscall") __failure __msg("R3 type=scalar expected=")int stream_vprintk_scalar_arg (void *ctx) { -bpf_stream_vprintk (BPF_STDOUT ,"" , (void *)46 ,0 ,NULL ); +bpf_stream_vprintk_impl (BPF_STDOUT ,"" , (void *)46 ,0 ,NULL );return 0 ; }
@@ -26,7 +26,7 @@ SEC("syscall") __failure __msg("arg#1 doesn't point to a const string")int stream_vprintk_string_arg (void *ctx) { -bpf_stream_vprintk (BPF_STDOUT , ctx,NULL ,0 ,NULL ); +bpf_stream_vprintk_impl (BPF_STDOUT , ctx,NULL ,0 ,NULL );return 0 ; }
Signature · 1 line
2.51.1
Re: [PATCH bpf v2 2/2] bpf:add _impl suffix for bpf_stream_vprintk() kfunc
Quoted 9 lines · Mykyta Yatsenko
From: Mykyta Yatsenko <[email protected]>
Rename
bpf_stream_vprintk()tobpf_stream_vprintk_impl().This aligns this recently added kfunc with the naming scheme required by the implicit-argument feature.
In future BTF type forbpf_stream_vprintk()will be generated andaux__progargument filled by the valid struct implicitly.
How about this wording?
This makes bpf_stream_vprintk() follow the already established "_impl" suffix-based naming convention for kfuncs with the bpf_prog_aux argument provided by the verifier implicitly. This convention will be taken advantage of with the upcoming KF_IMPLICIT_ARGS feature to preserve backwards compatibility to BPF programs.
Other than that, LGTM.
Quoted 124 lines
Signed-off-by Mykyta Yatsenko <[email protected]>--- kernel/bpf/helpers.c | 2 +- kernel/bpf/stream.c | 3 ++- tools/bpf/bpftool/Documentation/bpftool-prog.rst | 2 +- tools/lib/bpf/bpf_helpers.h | 28 ++++++++++++------------ tools/testing/selftests/bpf/progs/stream_fail.c | 6 ++--- 5 files changed, 21 insertions(+), 20 deletions(-)kernel/bpf/helpers.c +1
-1@@ -4380,7 +4380,7 @@ BTF_ID_FLAGS(func, bpf_strnstr);#if defined(CONFIG_BPF_LSM ) && defined(CONFIG_CGROUPS ) BTF_ID_FLAGS(func, bpf_cgroup_read_xattr, KF_RCU)#endif -BTF_ID_FLAGS(func, bpf_stream_vprintk, KF_TRUSTED_ARGS) +BTF_ID_FLAGS(func, bpf_stream_vprintk_impl, KF_TRUSTED_ARGS) BTF_ID_FLAGS(func, bpf_task_work_schedule_signal_impl, KF_TRUSTED_ARGS) BTF_ID_FLAGS(func, bpf_task_work_schedule_resume_impl, KF_TRUSTED_ARGS)BTF_KFUNCS_END (common_btf_ids)kernel/bpf/stream.c +2
-1@@ -355,7 +355,8 @@ __bpf_kfunc_start_defs();* Avoid using enum bpf_stream_id so that kfunc users don't have to pull in the * enum in headers. */ -__bpf_kfunc int bpf_stream_vprintk(int stream_id, const char *fmt__str, const void *args, u32 len__sz, void *aux__prog) +__bpf_kfunc int bpf_stream_vprintk_impl(int stream_id, const char *fmt__str, const void *args, +u32 len__sz,void *aux__prog) {struct bpf_bprintf_data data = { .get_bin_args = true,tools/bpf/bpftool/Documentation/bpftool-prog.rst +1
-1@@ -182,7 +182,7 @@ bpftool prog tracelog bpftool prog tracelog { stdout | stderr } *PROG* Dump the BPF stream of the program. BPF programs can write to these streams - at runtime with the **bpf_stream_vprintk**\ () kfunc. The kernel may write + at runtime with the **bpf_stream_vprintk_impl**\ () kfunc. The kernel may write error messages to the standard error stream. This facility should be used only for debugging purposes.tools/lib/bpf/bpf_helpers.h +14
-14@@ -315,20 +315,20 @@ enum libbpf_tristate { ___param, sizeof(___param)); \ }) -extern int bpf_stream_vprintk(int stream_id, const char *fmt__str, const void *args, - __u32 len__sz, void *aux__prog) __weak __ksym; - -#define bpf_stream_printk(stream_id, fmt, args...) \ -({ \ - static const char ___fmt[] = fmt; \ - unsigned long long ___param[___bpf_narg(args)]; \ - \ - _Pragma("GCC diagnostic push") \ - _Pragma("GCC diagnostic ignored \"-Wint-conversion\"") \ - ___bpf_fill(___param, args); \ - _Pragma("GCC diagnostic pop") \ - \ - bpf_stream_vprintk(stream_id, ___fmt, ___param, sizeof(___param), NULL);\ +extern int bpf_stream_vprintk_impl(int stream_id, const char *fmt__str, const void *args, + __u32 len__sz, void *aux__prog) __weak __ksym; + +#define bpf_stream_printk(stream_id, fmt, args...) \ +({ \ + static const char ___fmt[] = fmt; \ + unsigned long long ___param[___bpf_narg(args)]; \ + \ + _Pragma("GCC diagnostic push") \ + _Pragma("GCC diagnostic ignored \"-Wint-conversion\"") \ + ___bpf_fill(___param, args); \ + _Pragma("GCC diagnostic pop") \ + \ + bpf_stream_vprintk_impl(stream_id, ___fmt, ___param, sizeof(___param), NULL); \ })/* Use __bpf_printk when bpf_printk call has 3 or fewer fmt args tools/testing/selftests/bpf/progs/stream_fail.c +3
-4@@ -10,7 +10,7 @@ SEC("syscall") __failure __msg("Possibly NULL pointer passed")int stream_vprintk_null_arg (void *ctx) { -bpf_stream_vprintk (BPF_STDOUT ,"" ,NULL ,0 ,NULL ); +bpf_stream_vprintk_impl (BPF_STDOUT ,"" ,NULL ,0 ,NULL );return 0 ; }@@ -18,7 +18,7 @@ SEC("syscall") __failure __msg("R3 type=scalar expected=")int stream_vprintk_scalar_arg (void *ctx) { -bpf_stream_vprintk (BPF_STDOUT ,"" , (void *)46 ,0 ,NULL ); +bpf_stream_vprintk_impl (BPF_STDOUT ,"" , (void *)46 ,0 ,NULL );return 0 ; }@@ -26,7 +26,7 @@ SEC("syscall") __failure __msg("arg#1 doesn't point to a const string")int stream_vprintk_string_arg (void *ctx) { -bpf_stream_vprintk (BPF_STDOUT , ctx,NULL ,0 ,NULL ); +bpf_stream_vprintk_impl (BPF_STDOUT , ctx,NULL ,0 ,NULL );return 0 ; } --2.51.1
Ihor Solodrai
reviewerQuoted 4 lines · Mykyta Yatsenko
We’re introducing support for implicit kfunc arguments and need to rename new kfuncs to comply with the naming convention. This new feature, will for each kfunc of the form:
Quoted 8 lines
bpf_foo_impl(args..., aux__prog)generate a public BTF type:
bpf_foo(args...)and the verifier will resolve calls to
bpf_foo()tobpf_foo_impl(), supplying a valid structbpf_prog_auxviaaux__prog.
Hi Mykyta, thank you for submitting this.
The explanation in this cover is inaccurate. There were a few discussions, and the "implicit" feature is in active development, so it is confusing... Let me try to elaborate.
Currently if a kfunc needs access to struct bpf_prog_aux data, it must have an explicit void *aux__prog argument in its declaration. Then on BPF side the users must pass a dummy value (conventionally NULL).
In the v6.18-rc4 these 4 functions are using aux__prog argument:
* bpf_wq_set_callback_impl (note existing _impl suffix)
* bpf_task_work_schedule_signal
* bpf_task_work_schedule_resume
* bpf_stream_vprintk
The goal of the KF_IMPLICIT_ARGS feature is to hide this argument from BPF programs, as it is supplied by the verifier.
With it, the kfuncs still require an explicit argument in the kernel declaration, for example:
__bpf_kfunc int bpf_foo(int arg, struct bpf_prog_aux *aux__implicit);
In order to hide it from the BPF users, the following functions will be produced in BTF from the above declaration:
/* no aux arg for BPF interface kfunc */
__bpf_kfunc int bpf_foo(int arg);
/* no kfunc decl_tag for _impl function */
int bpf_foo_impl(int arg, struct bpf_prog_aux *aux__implicit);Now the problem with existing aux__prog users that you're renaming in this patchset is that because they don't have an _impl suffix, their prototype will change, breaking binary compatibility with existing BPF programs. If we simply mark them as KF_IMPLICIT_ARGS, then they lose an argument in BTF, for example:
bpf_task_work_schedule_signal(task, tw, map__map, callback, aux__prog);
becomes
bpf_task_work_schedule_signal(task, tw, map__map, callback);
However, if we rename it to "bpf_task_work_schedule_signal_impl", then after KF_IMPLICIT_ARGS feature is implemented, we can *add a new kfunc* "bpf_task_work_schedule_signal" with an implicit arg.
This way we can avoid breaking BPF progs calling this kfunc, although renaming is still a disruption of course.
See links to previous discussions:
* https://lore.kernel.org/bpf/[email protected]/
* https://lore.kernel.org/bpf/[email protected]/
* https://lore.kernel.org/dwarves/[email protected]/
Quoted 44 lines
Three kfuncs added in 6.18 don’t follow this
*_implconvention and therefore won’t participate in the new mechanism:
*bpf_task_work_schedule_resume()
*bpf_task_work_schedule_signal()
*bpf_stream_vprintk()Rename them to align with the implicit-arg flow:
bpf_task_work_schedule_resume()->bpf_task_work_schedule_resume_impl()bpf_task_work_schedule_signal()->bpf_task_work_schedule_signal_impl()bpf_stream_vprintk()->bpf_stream_vprintk_impl()The implicit-arg mechanism is not in tree yet, so callers must switch to the
*_implnames for now. Once the new mechanism lands, the plain names (without_impl) will be reintroduced as BTF-visible entry points and will resolve to the_implversions automatically.Signed-off-by Mykyta Yatsenko <[email protected]>---
Changes in v1:
- Split commit into 2
- Rebase on the correct branch
- Link to v1: https://lore.kernel.org/all/[email protected]/---
Mykyta Yatsenko (2):
bpf:add_implsuffix for bpf_task_work_schedule* kfuncs bpf:add_implsuffix forbpf_stream_vprintk()kfunckernel/bpf/helpers.c | 26 +++++++++++--------- kernel/bpf/stream.c | 3 ++- kernel/bpf/verifier.c | 12 +++++----- tools/bpf/bpftool/Documentation/bpftool-prog.rst | 2 +- tools/lib/bpf/bpf_helpers.h | 28 +++++++++++----------- tools/testing/selftests/bpf/progs/stream_fail.c | 6 ++--- tools/testing/selftests/bpf/progs/task_work.c | 6 ++--- tools/testing/selftests/bpf/progs/task_work_fail.c | 8 +++---- .../testing/selftests/bpf/progs/task_work_stress.c | 4 ++-- 9 files changed, 50 insertions(+), 45 deletions(-)---
base-commit:6146a0f1dfae5d37442a9ddcba012add260bceb0
change-id: 20251104-implv2-d6c4be255026Best regards,
Quoted 64 lines · Ihor Solodrai
Quoted 4 lines · Mykyta Yatsenko
We’re introducing support for implicit kfunc arguments and need to rename new kfuncs to comply with the naming convention. This new feature, will for each kfunc of the form:
Quoted 8 lines
bpf_foo_impl(args..., aux__prog)generate a public BTF type:
bpf_foo(args...)and the verifier will resolve calls to
bpf_foo()tobpf_foo_impl(), supplying a valid structbpf_prog_auxviaaux__prog.Hi Mykyta, thank you for submitting this.
The explanation in this cover is inaccurate. There were a few discussions, and the "implicit" feature is in active development, so it is confusing... Let me try to elaborate.
Currently if a kfunc needs access to struct
bpf_prog_auxdata, it must have an explicit void*aux__progargument in its declaration. Then on BPF side the users must pass a dummy value (conventionally NULL).In the v6.18-rc4 these 4 functions are using
aux__progargument:
*bpf_wq_set_callback_impl(note existing_implsuffix)
*bpf_task_work_schedule_signal
*bpf_task_work_schedule_resume
*bpf_stream_vprintkThe goal of the
KF_IMPLICIT_ARGSfeature is to hide this argument from BPF programs, as it is supplied by the verifier.With it, the kfuncs still require an explicit argument in the kernel declaration, for example:
__bpf_kfunc int bpf_foo(int arg, struct bpf_prog_aux *aux__implicit);In order to hide it from the BPF users, the following functions will be produced in BTF from the above declaration:
/* no aux arg for BPF interface kfunc */ __bpf_kfunc int bpf_foo(int arg); /* no kfunc decl_tag for _impl function */ int bpf_foo_impl(int arg, struct bpf_prog_aux *aux__implicit);Now the problem with existing
aux__progusers that you're renaming in this patchset is that because they don't have an_implsuffix, their prototype will change, breaking binary compatibility with existing BPF programs. If we simply mark them asKF_IMPLICIT_ARGS, then they lose an argument in BTF, for example:bpf_task_work_schedule_signal(task, tw, map__map, callback, aux__prog);becomes
bpf_task_work_schedule_signal(task, tw, map__map, callback);However, if we rename it to "
bpf_task_work_schedule_signal_impl", then afterKF_IMPLICIT_ARGSfeature is implemented, we can *add a new kfunc* "bpf_task_work_schedule_signal" with an implicit arg.
Quoted 25 lines
This way we can avoid breaking BPF progs calling this kfunc, although renaming is still a disruption of course.
See links to previous discussions:
* https://lore.kernel.org/bpf/[email protected]/
* https://lore.kernel.org/bpf/[email protected]/
* https://lore.kernel.org/dwarves/[email protected]/Quoted 17 lines
Three kfuncs added in 6.18 don’t follow this
*_implconvention and therefore won’t participate in the new mechanism:
*bpf_task_work_schedule_resume()
*bpf_task_work_schedule_signal()
*bpf_stream_vprintk()Rename them to align with the implicit-arg flow:
bpf_task_work_schedule_resume()->bpf_task_work_schedule_resume_impl()bpf_task_work_schedule_signal()->bpf_task_work_schedule_signal_impl()bpf_stream_vprintk()->bpf_stream_vprintk_impl()The implicit-arg mechanism is not in tree yet, so callers must switch to the
*_implnames for now. Once the new mechanism lands, the plain names (without_impl) will be reintroduced as BTF-visible entry points and will resolve to the_implversions automatically.
TBH, it looks like both Mykyta's and Ihor's descriptions are a little bit too detailed and are more concerned with details of the upcoming feature.
What's important with these fixes is that we are fixing deviation from the previously established "_impl" suffix naming convention for these kfuncs that accept verifier-provided bpf_prog_aux arguments. Following uniform convention will allow for transparent backwards compatibility with the upcoming KF_IMPLICIT_ARGS feature, so this patch set aims to fix current deviation from the convention so as to eliminate unnecessary backwards incompatibility breakage in the future.
WDYT?
Quoted 28 lines
Quoted 27 lines
Signed-off-by Mykyta Yatsenko <[email protected]>---
Changes in v1:
- Split commit into 2
- Rebase on the correct branch
- Link to v1: https://lore.kernel.org/all/[email protected]/---
Mykyta Yatsenko (2):
bpf:add_implsuffix for bpf_task_work_schedule* kfuncs bpf:add_implsuffix forbpf_stream_vprintk()kfunckernel/bpf/helpers.c | 26 +++++++++++--------- kernel/bpf/stream.c | 3 ++- kernel/bpf/verifier.c | 12 +++++----- tools/bpf/bpftool/Documentation/bpftool-prog.rst | 2 +- tools/lib/bpf/bpf_helpers.h | 28 +++++++++++----------- tools/testing/selftests/bpf/progs/stream_fail.c | 6 ++--- tools/testing/selftests/bpf/progs/task_work.c | 6 ++--- tools/testing/selftests/bpf/progs/task_work_fail.c | 8 +++---- .../testing/selftests/bpf/progs/task_work_stress.c | 4 ++-- 9 files changed, 50 insertions(+), 45 deletions(-)---
base-commit:6146a0f1dfae5d37442a9ddcba012add260bceb0
change-id: 20251104-implv2-d6c4be255026Best regards,
Ihor Solodrai
reviewerQuoted 42 lines · Andrii Nakryiko
Quoted 15 lines · Ihor Solodrai
Quoted 4 lines · Mykyta Yatsenko
We’re introducing support for implicit kfunc arguments and need to rename new kfuncs to comply with the naming convention. This new feature, will for each kfunc of the form:
Quoted 8 lines
bpf_foo_impl(args..., aux__prog)generate a public BTF type:
bpf_foo(args...)and the verifier will resolve calls to
bpf_foo()tobpf_foo_impl(), supplying a valid structbpf_prog_auxviaaux__prog.Quoted 13 lines
Hi Mykyta, thank you for submitting this.
The explanation in this cover is inaccurate. There were a few discussions, and the "implicit" feature is in active development, so it is confusing... Let me try to elaborate.
[...]
Quoted 5 lines
The implicit-arg mechanism is not in tree yet, so callers must switch to the
*_implnames for now. Once the new mechanism lands, the plain names (without_impl) will be reintroduced as BTF-visible entry points and will resolve to the_implversions automatically.TBH, it looks like both Mykyta's and Ihor's descriptions are a little bit too detailed and are more concerned with details of the upcoming feature.
What's important with these fixes is that we are fixing deviation from the previously established "
_impl" suffix naming convention for these kfuncs that accept verifier-providedbpf_prog_auxarguments. Following uniform convention will allow for transparent backwards compatibility with the upcomingKF_IMPLICIT_ARGSfeature, so this patch set aims to fix current deviation from the convention so as to eliminate unnecessary backwards incompatibility breakage in the future.
Quoted 1 line
WDYT?
I agree. For this patches we didn't have to go into the details, but that has already happened :)
Quoted 29 lines
Quoted 29 lines
Quoted 28 lines
Signed-off-by Mykyta Yatsenko <[email protected]>---
Changes in v1:
- Split commit into 2
- Rebase on the correct branch
- Link to v1: https://lore.kernel.org/all/[email protected]/---
Mykyta Yatsenko (2):
bpf:add_implsuffix for bpf_task_work_schedule* kfuncs bpf:add_implsuffix forbpf_stream_vprintk()kfunckernel/bpf/helpers.c | 26 +++++++++++--------- kernel/bpf/stream.c | 3 ++- kernel/bpf/verifier.c | 12 +++++----- tools/bpf/bpftool/Documentation/bpftool-prog.rst | 2 +- tools/lib/bpf/bpf_helpers.h | 28 +++++++++++----------- tools/testing/selftests/bpf/progs/stream_fail.c | 6 ++--- tools/testing/selftests/bpf/progs/task_work.c | 6 ++--- tools/testing/selftests/bpf/progs/task_work_fail.c | 8 +++---- .../testing/selftests/bpf/progs/task_work_stress.c | 4 ++-- 9 files changed, 50 insertions(+), 45 deletions(-)---
base-commit:6146a0f1dfae5d37442a9ddcba012add260bceb0
change-id: 20251104-implv2-d6c4be255026Best regards,
Quoted 99 lines · Andrii Nakryiko
Quoted 62 lines · Ihor Solodrai
Quoted 4 lines · Mykyta Yatsenko
We’re introducing support for implicit kfunc arguments and need to rename new kfuncs to comply with the naming convention. This new feature, will for each kfunc of the form:
Quoted 8 lines
bpf_foo_impl(args..., aux__prog)generate a public BTF type:
bpf_foo(args...)and the verifier will resolve calls to
bpf_foo()tobpf_foo_impl(), supplying a valid structbpf_prog_auxviaaux__prog.Hi Mykyta, thank you for submitting this.
The explanation in this cover is inaccurate. There were a few discussions, and the "implicit" feature is in active development, so it is confusing... Let me try to elaborate.
Currently if a kfunc needs access to struct
bpf_prog_auxdata, it must have an explicit void*aux__progargument in its declaration. Then on BPF side the users must pass a dummy value (conventionally NULL).In the v6.18-rc4 these 4 functions are using
aux__progargument:
*bpf_wq_set_callback_impl(note existing_implsuffix)
*bpf_task_work_schedule_signal
*bpf_task_work_schedule_resume
*bpf_stream_vprintkThe goal of the
KF_IMPLICIT_ARGSfeature is to hide this argument from BPF programs, as it is supplied by the verifier.With it, the kfuncs still require an explicit argument in the kernel declaration, for example:
__bpf_kfunc int bpf_foo(int arg, struct bpf_prog_aux *aux__implicit);In order to hide it from the BPF users, the following functions will be produced in BTF from the above declaration:
/* no aux arg for BPF interface kfunc */ __bpf_kfunc int bpf_foo(int arg); /* no kfunc decl_tag for _impl function */ int bpf_foo_impl(int arg, struct bpf_prog_aux *aux__implicit);Now the problem with existing
aux__progusers that you're renaming in this patchset is that because they don't have an_implsuffix, their prototype will change, breaking binary compatibility with existing BPF programs. If we simply mark them asKF_IMPLICIT_ARGS, then they lose an argument in BTF, for example:bpf_task_work_schedule_signal(task, tw, map__map, callback, aux__prog);becomes
bpf_task_work_schedule_signal(task, tw, map__map, callback);However, if we rename it to "
bpf_task_work_schedule_signal_impl", then afterKF_IMPLICIT_ARGSfeature is implemented, we can *add a new kfunc* "bpf_task_work_schedule_signal" with an implicit arg.Quoted 24 lines
This way we can avoid breaking BPF progs calling this kfunc, although renaming is still a disruption of course.
See links to previous discussions:
* https://lore.kernel.org/bpf/[email protected]/
* https://lore.kernel.org/bpf/[email protected]/
* https://lore.kernel.org/dwarves/[email protected]/Quoted 16 lines
Three kfuncs added in 6.18 don’t follow this
*_implconvention and therefore won’t participate in the new mechanism:
*bpf_task_work_schedule_resume()
*bpf_task_work_schedule_signal()
*bpf_stream_vprintk()Rename them to align with the implicit-arg flow:
bpf_task_work_schedule_resume()->bpf_task_work_schedule_resume_impl()bpf_task_work_schedule_signal()->bpf_task_work_schedule_signal_impl()bpf_stream_vprintk()->bpf_stream_vprintk_impl()The implicit-arg mechanism is not in tree yet, so callers must switch to the
*_implnames for now. Once the new mechanism lands, the plain names (without_impl) will be reintroduced as BTF-visible entry points and will resolve to the_implversions automatically.TBH, it looks like both Mykyta's and Ihor's descriptions are a little bit too detailed and are more concerned with details of the upcoming feature.
What's important with these fixes is that we are fixing deviation from the previously established "
_impl" suffix naming convention for these kfuncs that accept verifier-providedbpf_prog_auxarguments. Following uniform convention will allow for transparent backwards compatibility with the upcomingKF_IMPLICIT_ARGSfeature, so this patch set aims to fix current deviation from the convention so as to eliminate unnecessary backwards incompatibility breakage in the future.
Quoted 1 line
WDYT?
Thanks, this message makes more sense, let me update commit descriptions and send v3.
Quoted 27 lines
Quoted 27 lines
Quoted 27 lines
Signed-off-by Mykyta Yatsenko <[email protected]>---
Changes in v1:
- Split commit into 2
- Rebase on the correct branch
- Link to v1: https://lore.kernel.org/all/[email protected]/---
Mykyta Yatsenko (2):
bpf:add_implsuffix for bpf_task_work_schedule* kfuncs bpf:add_implsuffix forbpf_stream_vprintk()kfunckernel/bpf/helpers.c | 26 +++++++++++--------- kernel/bpf/stream.c | 3 ++- kernel/bpf/verifier.c | 12 +++++----- tools/bpf/bpftool/Documentation/bpftool-prog.rst | 2 +- tools/lib/bpf/bpf_helpers.h | 28 +++++++++++----------- tools/testing/selftests/bpf/progs/stream_fail.c | 6 ++--- tools/testing/selftests/bpf/progs/task_work.c | 6 ++--- tools/testing/selftests/bpf/progs/task_work_fail.c | 8 +++---- .../testing/selftests/bpf/progs/task_work_stress.c | 4 ++-- 9 files changed, 50 insertions(+), 45 deletions(-)---
base-commit:6146a0f1dfae5d37442a9ddcba012add260bceb0
change-id: 20251104-implv2-d6c4be255026Best regards,