bpf: Add bpf_ktime_get_real_ns
Subsystems (11)
PATCH v7 1/2 bpf: Add bpf_ktime_get_real_ns
From: Bimmy Pujari <[email protected]>
The existing bpf helper functions to get timestamp return the time elapsed since system boot. This timestamp is not particularly useful where epoch timestamp is required or more than one server is involved and time sync is required. Instead, you want to use CLOCK_REALTIME, which provides epoch timestamp. Hence adding a new helper bfp_ktime_get_real_ns() based around CLOCK_REALTIME.
--- drivers/media/rc/bpf-lirc.c | 2 ++ include/linux/bpf.h | 1 + include/uapi/linux/bpf.h | 11 +++++++++++ kernel/bpf/core.c | 1 + kernel/bpf/helpers.c | 14 ++++++++++++++ kernel/trace/bpf_trace.c | 2 ++ tools/include/uapi/linux/bpf.h | 11 +++++++++++ 7 files changed, 42 insertions(+)
drivers/media/rc/bpf-lirc.c +2 -0
@@ -105,6 +105,8 @@ lirc_mode2_func_proto(enum bpf_func_id func_id, const struct bpf_prog *prog)return &bpf_ktime_get_ns_proto;case BPF_FUNC_ktime_get_boot_ns:return &bpf_ktime_get_boot_ns_proto; +case BPF_FUNC_ktime_get_real_ns: +return &bpf_ktime_get_real_ns_proto;case BPF_FUNC_tail_call:return &bpf_tail_call_proto;case BPF_FUNC_get_prandom_u32:
include/linux/bpf.h +1 -0
@@ -1791,6 +1791,7 @@ extern const struct bpf_func_proto bpf_get_numa_node_id_proto;extern const struct bpf_func_proto bpf_tail_call_proto;extern const struct bpf_func_proto bpf_ktime_get_ns_proto;extern const struct bpf_func_proto bpf_ktime_get_boot_ns_proto; +extern const struct bpf_func_proto bpf_ktime_get_real_ns_proto;extern const struct bpf_func_proto bpf_get_current_pid_tgid_proto;extern const struct bpf_func_proto bpf_get_current_uid_gid_proto;extern const struct bpf_func_proto bpf_get_current_comm_proto;
include/uapi/linux/bpf.h +11 -0
@@ -3665,6 +3665,16 @@ union bpf_attr {* Return * The helper returns **TC_ACT_REDIRECT** on success or * **TC_ACT_SHOT** on error. +* +* u64 bpf_ktime_get_real_ns(void) +* Description +* Return the real time since epoch in nanoseconds. +* See: **clock_gettime**\ (**CLOCK_REALTIME**) +* +* As REALCLOCK can jump around, this helper should not be used to +* measure passage of time. +* Return +* Current *ktime*. */ #define __BPF_FUNC_MAPPER (FN ) \ FN(unspec), \
@@ -3820,6 +3830,7 @@ union bpf_attr {FN (seq_printf_btf), \FN (skb_cgroup_classid), \FN (redirect_neigh), \ +FN (ktime_get_real_ns), \/* */ /* integer value in 'imm' field of BPF_CALL instruction selects which helper
kernel/bpf/core.c +1 -0
@@ -2211,6 +2211,7 @@ const struct bpf_func_proto bpf_get_smp_processor_id_proto __weak;const struct bpf_func_proto bpf_get_numa_node_id_proto__weak ;const struct bpf_func_proto bpf_ktime_get_ns_proto__weak ;const struct bpf_func_proto bpf_ktime_get_boot_ns_proto__weak ; +const struct bpf_func_proto bpf_ktime_get_real_ns_proto__weak ;const struct bpf_func_proto bpf_get_current_pid_tgid_proto__weak ;const struct bpf_func_proto bpf_get_current_uid_gid_proto__weak ;
kernel/bpf/helpers.c +14 -0
@@ -167,6 +167,18 @@ const struct bpf_func_proto bpf_ktime_get_boot_ns_proto = { .ret_type = RET_INTEGER, }; +BPF_CALL_0 (bpf_ktime_get_real_ns) +{ +/* NMI safe access to clock realtime */ +return ktime_get_real_fast_ns (); +} + +const struct bpf_func_proto bpf_ktime_get_real_ns_proto = { + .func = bpf_ktime_get_real_ns, + .gpl_only = false, + .ret_type =RET_INTEGER , +}; +BPF_CALL_0 (bpf_get_current_pid_tgid) {struct task_struct *task = current;
@@ -657,6 +669,8 @@ bpf_base_func_proto(enum bpf_func_id func_id)return &bpf_ktime_get_ns_proto;case BPF_FUNC_ktime_get_boot_ns:return &bpf_ktime_get_boot_ns_proto; +case BPF_FUNC_ktime_get_real_ns: +return &bpf_ktime_get_real_ns_proto;case BPF_FUNC_ringbuf_output:return &bpf_ringbuf_output_proto;case BPF_FUNC_ringbuf_reserve:
kernel/trace/bpf_trace.c +2 -0
@@ -1259,6 +1259,8 @@ bpf_tracing_func_proto(enum bpf_func_id func_id, const struct bpf_prog *prog)return &bpf_ktime_get_ns_proto;case BPF_FUNC_ktime_get_boot_ns:return &bpf_ktime_get_boot_ns_proto; +case BPF_FUNC_ktime_get_real_ns: +return &bpf_ktime_get_real_ns_proto;case BPF_FUNC_tail_call:return &bpf_tail_call_proto;case BPF_FUNC_get_current_pid_tgid:
tools/include/uapi/linux/bpf.h +11 -0
@@ -3665,6 +3665,16 @@ union bpf_attr {* Return * The helper returns **TC_ACT_REDIRECT** on success or * **TC_ACT_SHOT** on error. +* +* u64 bpf_ktime_get_real_ns(void) +* Description +* Return the real time since epoch in nanoseconds. +* See: **clock_gettime**\ (**CLOCK_REALTIME**) +* +* As REALCLOCK can jump around, this helper should not be used to +* measure passage of time. +* Return +* Current *ktime*. */ #define __BPF_FUNC_MAPPER (FN ) \ FN(unspec), \
@@ -3820,6 +3830,7 @@ union bpf_attr {FN (seq_printf_btf), \FN (skb_cgroup_classid), \FN (redirect_neigh), \ +FN (ktime_get_real_ns), \/* */ /* integer value in 'imm' field of BPF_CALL instruction selects which helper
Signature · 1 line
2.17.1
PATCH v7 2/2 selftests/bpf: Selftest for real time helper
From: Bimmy Pujari <[email protected]>
Add test validating that bpf_ktime_get_real_ns works fine.
--- .../selftests/bpf/prog_tests/ktime_real.c | 42 +++++++++++++++++++ .../bpf/progs/test_ktime_get_real_ns.c | 36 ++++++++++++++++ 2 files changed, 78 insertions(+) create mode 100644 tools/testing/selftests/bpf/prog_tests/ktime_real.c create mode 100644 tools/testing/selftests/bpf/progs/test_ktime_get_real_ns.c
tools/testing/selftests/bpf/prog_tests/ktime_real.c new file +42 -0
@@ -0,0 +1,42 @@ +// SPDX-License-Identifier: GPL-2.0 +#include <test_progs.h> +#include <network_helpers.h> + +static void *time_thread (void *arg) +{ +__u32 duration, retval; +int err, prog_fd = *(u32 *) arg; + + err =bpf_prog_test_run (prog_fd,10000 , &pkt_v4,sizeof (pkt_v4), +NULL ,NULL , &retval, &duration); +CHECK (err || retval,"" , +"err %d errno %d retval %d duration %d\n" , + err, errno, retval, duration); +pthread_exit (arg); +} + +void test_ktime_real (void ) +{ +const char *file ="./test_ktime_get_real_ns.o" ; +struct bpf_object *obj =NULL ; +pthread_t thread_id; +int prog_fd; +int err =0 ; +void *ret; + + err =bpf_prog_load (file,BPF_PROG_TYPE_CGROUP_SKB , &obj, &prog_fd); +if (CHECK_FAIL (err)) { +printf ("test_ktime_get_real_ns:bpf_prog_load errno %d\n" , errno); + goto close_prog; + } + +if (CHECK_FAIL (pthread_create (&thread_id,NULL , + &time_thread, &prog_fd))) + goto close_prog; + +if (CHECK_FAIL (pthread_join (thread_id, &ret) || + ret != (void *)&prog_fd)) + goto close_prog; +close_prog: +bpf_object__close (obj); +}
tools/testing/selftests/bpf/progs/test_ktime_get_real_ns.c new file +36 -0
@@ -0,0 +1,36 @@ +// SPDX-License-Identifier: GPL-2.0 +#include <linux/bpf.h> +#include <linux/version.h> +#include <bpf/bpf_helpers.h> + +struct { + __uint(type, BPF_MAP_TYPE_ARRAY); + __uint(max_entries, 1); + __type(key, int); + __type(value, unsigned long long); +} time_map SEC(".maps"); + +SEC("realtime_helper") +int realtime_helper_test (struct __sk_buff *skb) +{ +unsigned long long *lasttime; +unsigned long long curtime; +int key =0 ; +int err =0 ; + + lasttime =bpf_map_lookup_elem (&time_map, &key); +if (!lasttime) + goto err; + + curtime =bpf_ktime_get_real_ns (); +if (curtime <= *lasttime) { + err =1 ; + goto err; + } + *lasttime = curtime; + +err: +return err; +} + +char _license[] SEC("license") = "GPL";
Signature · 1 line
2.17.1
Re: [PATCH bpf-next v7 2/2] selftests/bpf: Selftest for real time helper
Quoted 8 lines · On Wed, Sep 30, 2020 at 07:05:04PM -0700, [email protected] wrote:
tools/testing/selftests/bpf/progs/test_ktime_get_real_ns.c new file +8
-0+SEC("realtime_helper") +int realtime_helper_test (struct __sk_buff *skb) +{ +unsigned long long *lasttime; +unsigned long long curtime; +int key =0 ; +int err =0 ; +
tools/testing/selftests/bpf/progs/test_ktime_get_real_ns.c line 30
Quoted 10 lines
tools/testing/selftests/bpf/progs/test_ktime_get_real_ns.c new file +10
-0+ lasttime =bpf_map_lookup_elem (&time_map, &key); +if (!lasttime) + goto err; + + curtime =bpf_ktime_get_real_ns (); +if (curtime <= *lasttime) { + err =1 ; + goto err; + } + *lasttime = curtime;
so the test is doing exactly what comment in patch 1 is saying not to do. I'm sorry but Andrii's comments are correct. If the authors of the patch cannot make it right we should not add this helper to general audience. Just because POSIX allows it it doesn't mean that it did the good choice.
RE: [PATCH bpf-next v7 2/2] selftests/bpf: Selftest for real time helper
Thanks everyone for putting your valuable time to review these patches. Can any one from you suggest the best way to test this function in selftest?
Regards
Bimmy
-----Original Message-----
From: Alexei Starovoitov <[email protected]>
Sent: Wednesday, September 30, 2020 10:35 PM
To: Pujari, Bimmy <[email protected]>
Cc: [email protected]; [email protected]; [email protected]; [email protected]; [email protected]; [email protected]; [email protected]; Nikravesh, Ashkan <[email protected]>; Alvarez, Daniel A <[email protected]>
Subject: Re: [PATCH bpf-next v7 2/2] selftests/bpf: Selftest for real time helper
Quoted 7 lines · On Wed, Sep 30, 2020 at 07:05:04PM -0700, [email protected] wrote:
tools/testing/selftests/bpf/progs/test_ktime_get_real_ns.c new file +7
-0+SEC("realtime_helper") +int realtime_helper_test (struct __sk_buff *skb) { +unsigned long long *lasttime; +unsigned long long curtime; +int key =0 ; +int err =0 ; +
tools/testing/selftests/bpf/progs/test_ktime_get_real_ns.c line 30
Quoted 10 lines
tools/testing/selftests/bpf/progs/test_ktime_get_real_ns.c new file +10
-0+ lasttime =bpf_map_lookup_elem (&time_map, &key); +if (!lasttime) + goto err; + + curtime =bpf_ktime_get_real_ns (); +if (curtime <= *lasttime) { + err =1 ; + goto err; + } + *lasttime = curtime;
so the test is doing exactly what comment in patch 1 is saying not to do.
I'm sorry but Andrii's comments are correct. If the authors of the patch cannot make it right we should not add this helper to general audience. Just because POSIX allows it it doesn't mean that it did the good choice.
Re: [PATCH bpf-next v7 2/2] selftests/bpf: Selftest for real time helper
Quoted 2 lines · Bimmy
Thanks everyone for putting your valuable time to review these patches. Can any one from you suggest the best way to test this function in selftest?
Don't bother. This helper is no go.
Please trim your replies next time and do not top post.
Re: [PATCH bpf-next v7 2/2] selftests/bpf: Selftest for real time helper
Quoted 1 line
Don't bother. This helper is no go.
I disagree on the 'no go' -- I do think we should have this helper.
The problem is it should only be used in some limited circumstances - for example when processing packets coming in off the wire with real times in them... For example for something like measuring delay of ntp frames. This is of course testable but annoying (create a fake ntp frame with gettimeofday injected timestamp in it, run it through bpf, see what processing delay it reports).
Lets not make bpf even harder to use then it already is...
Re: [PATCH bpf-next v7 2/2] selftests/bpf: Selftest for real time helper
Quoted 3 lines · Maciej Żenczykowski
Quoted 1 line
Don't bother. This helper is no go.
I disagree on the 'no go' -- I do think we should have this helper.
+1
Quoted 3 lines
Lets not make bpf even harder to use then it already is...
Logging is done using time of day; that is not a posix mistake but a real need. Users do not file complaints based on a server's boot time or some random monotonic time; they report a problem based on time-of-day. Allowing bpf programs to timeofday makes it easier to troubleshoot and correlate kernel side events to userspace logs.