Date:   Fri, 4 Oct 2019 23:58:09 +0200
From:   Daniel Borkmann <daniel@...earbox.net>
To:     Andrii Nakryiko <andrii.nakryiko@...il.com>
Cc:     Jakub Kicinski <jakub.kicinski@...ronome.com>,
        David Ahern <dsahern@...il.com>,
        Andrii Nakryiko <andriin@...com>, bpf <bpf@...r.kernel.org>,
        Networking <netdev@...r.kernel.org>,
        Alexei Starovoitov <ast@...com>,
        Kernel Team <kernel-team@...com>, Jiri Benc <jbenc@...hat.com>
Subject: Re: [PATCH v3 bpf-next 5/7] libbpf: move
 bpf_{helpers,endian,tracing}.h into libbpf

On Fri, Oct 04, 2019 at 11:06:13PM +0200, Daniel Borkmann wrote:
> On Fri, Oct 04, 2019 at 01:21:55PM -0700, Andrii Nakryiko wrote:
> > On Fri, Oct 4, 2019 at 11:30 AM Jakub Kicinski
> > <jakub.kicinski@...ronome.com> wrote:
> > > On Fri, 4 Oct 2019 09:00:42 -0700, Andrii Nakryiko wrote:
> > > > On Fri, Oct 4, 2019 at 8:44 AM David Ahern <dsahern@...il.com> wrote:
> > > >> > I'm not following you; my interpretation of your comment seems like you
> > > > > are making huge assumptions.
> > > > >
> > > > > I build bpf programs for specific kernel versions using the devel
> > > > > packages for the specific kernel of interest.
> > > >
> > > > Sure, and you can keep doing that, just don't include bpf_helpers.h?
> > > >
> > > > What I was saying, though, especially having in mind tracing BPF
> > > > programs that need to inspect kernel structures, is that it's quite
> > > > impractical to have to build many different versions of BPF programs
> > > > for each supported kernel version and distribute them in binary form.
> > > > So people usually use BCC and do compilation on-the-fly using BCC's
> > > > embedded Clang.
> > > >
> > > > BPF CO-RE is providing an alternative, which will allow to pre-compile
> > > > your program once for many different kernels you might be running your
> > > > program on. There is tooling that eliminates the need for system
> > > > headers. Instead we pre-generate a single vmlinux.h header with all
> > > > the types/enums/etc, that are then used w/ BPF CO-RE to build portable
> > > > BPF programs capable of working on multiple kernel versions.
> > > >
> > > > So what I was pointing out there was that this vmlinux.h would be
> > > > ideally generated from latest kernel and not having latest
> > > > BPF_FUNC_xxx shouldn't be a problem. But see below about situation
> > > > being worse.
> > >
> > > Surely for distroes tho - they would have kernel headers matching the
> > > kernel release they ship. If parts of libbpf from GH only work with
> > > the latest kernel, distroes should ship libbpf from the kernel source,
> > > rather than GH.
> > >
> > > > > > Nevertheless, it is a problem and thanks for bringing it up! I'd say
> > > > > > for now we should still go ahead with this move and try to solve with
> > > > > > issue once bpf_helpers.h is in libbpf. If bpf_helpers.h doesn't work
> > > > > > for someone, it's no worse than it is today when users don't have
> > > > > > bpf_helpers.h at all.
> > > > > >
> > > > >
> > > > > If this syncs to the github libbpf, it will be worse than today in the
> > > > > sense of compile failures if someone's header file ordering picks
> > > > > libbpf's bpf_helpers.h over whatever they are using today.
> > > >
> > > > Today bpf_helpers.h don't exist for users or am I missing something?
> > > > bpf_helpers.h right now are purely for selftests. But they are really
> > > > useful outside that context, so I'm making it available for everyone
> > > > by distributing with libbpf sources. If bpf_helpers.h doesn't work for
> > > > some specific use case, just don't use it (yet?).
> > > >
> > > > I'm still failing to see how it's worse than situation today.
> > >
> > > Having a header which works today, but may not work tomorrow is going
> > > to be pretty bad user experience :( No matter how many warnings you put
> > > in the source people will get caught off guard by this :(
> > >
> > > If you define the current state as "users can use all features of
> > > libbpf and nothing should break on libbpf update" (which is in my
> > > understanding a goal of the project, we bent over backwards trying
> > > to not break things) then adding this header will in fact make things
> > > worse. The statement in quotes would no longer be true, no?
> > 
> > So there are few things here.
> > 
> > 1. About "adding bpf_helpers.h will make things worse". I
> > categorically disagree, bpf_helpers.h doesn't exist in user land at
> > all and it's sorely missing. So adding it is strictly better
> > experience already. Right now people have to re-declare those helper
> > signatures and do all kinds of unnecessary hackery just to be able to
> > use BPF stuff, and they still can run into the same problem with
> > having too old kernel headers.
> 
> Right, so apps tend to ship their own uapi bpf.h header and helper
> signatures to avoid these issues. But question becomes once they
> start using soley bpf_helper.h (also in non-tracing context which
> is very reasonable to assume), then things might break with the patch
> as-is once they have a newer libbpf with more signatures than their
> linux/bpf.h defines (and yes, pulling from GH will have this problem),
> so we'd need to have an answer to that in order to avoid breaking
> compilation.
> 
> [...]
> > 2. As to the problem of running bleeding-edge libbpf against older
> > kernel. There are few possible solutions:
> > 
> > a. we hard-code all those BPF_FUNC_ constants. Super painful and not
> > nice, but will work.
> > 
> > b. copy/paste enum bpf_func_id definition into bpf_helpers.h itself
> > and try to keep it in sync with UAPI. Apart from obvious redundancy
> > that involves, we also will need to make sure this doesn't conflict
> > with vmlinux.h, so enum name should be different and each value should
> > be different (which means some wort of additional prefix or suffix).
> > 
> > c. BPF UAPI header has __BPF_FUNC_MAPPER macro "iterating" over all
> > defined values for a particular kernel version. We can use that and
> > additional macro trickery to conditionally define helpers. Again, we
> > need to keep in mind that w/ vmlinux.h there is no such macro, so this
> > should work as well.
> > 
> > I'm happy to hear opinions about these choices (maybe there are some
> > other I missed), but in any case I'd like to do it in a follow up
> > patch and land this one as is. It has already quite a lot packed in
> > it. I personally lean towards c) as it will have a benefit of not
> > declaring helpers that are not supported by kernel we are compiling
> > against, even though it requires additional macro trickery.
> > 
> > Opinions?
> 
> Was thinking about something like c) as well. So I tried to do a quick
> hack. Here is how it could work, but it needs a small change in the
> __BPF_FUNC_MAPPER(), at least I didn't find an immediate way around it:
> 
> static void (*__unspec)(void);
> static void *(*__map_lookup_elem)(void *map, const void *key);
> static int (*__map_update_elem)(void *map, const void *key, const void *value, unsigned long long flags);
> static int (*__map_delete_elem)(void *map, const void *key);
> static int (*__bpf_probe_read)(void *dst, int size, const void *unsafe_ptr);
> 
> #define __BPF_FUNC_MAPPER(FN, DELIM)    \
>         FN(unspec) DELIM                \
>         FN(map_lookup_elem) DELIM       \
>         FN(map_update_elem) DELIM       \
>         FN(map_delete_elem) DELIM
> 
> #define __BPF_ENUM_FN(x) BPF_FUNC_ ## x
> enum bpf_func_id {
> #define COM ,
>         __BPF_FUNC_MAPPER(__BPF_ENUM_FN, COM)
>         __BPF_FUNC_MAX_ID,
> };
> #undef __BPF_ENUM_FN
> 
> #define __BPF_ASSIGN_FN(x) typeof(__ ## x) x = (void *)BPF_FUNC_ ## x
> #define SEM ;
> __BPF_FUNC_MAPPER(__BPF_ASSIGN_FN, SEM)
> #undef __BPF_ASSIGN_FN
> 
> int main(void)
> {
>         return(unsigned long)map_lookup_elem(0, 0);
> }
> 
> It does seem to eat it:
> 
> $ gcc foo.c 
> $
> 
> In short, libbpf's bpf_helper.h would define signatures (or better: types) as
> above prefixed with __. The __BPF_FUNC_MAPPER() and the enum bpf_func_id {}
> is the one in the uapi header, so out of our control from libbpf pov. But
> aside from the signatures, the bpf_helper.h would have __BPF_ASSIGN_FN() and
> this would avoid the breakage issue. The only thing libbpf needs to have in
> the bpf_helper.h are the /latest/ signatures with /matching/ names.
> 
> Right now in the __BPF_FUNC_MAPPER() there is this comma, we probably need
> to make this a parameter, at least from a quick glance I didn't see a way
> to work around it.

Small kernel side change would look like below, seems useful regardless, imho.
Perhaps that approach where you'd only need signatures like above would also
resolve the 'concern' from gcc folks where they wanted a special helper attribute
thingy to achieve the same.

>From e89cd0d873ae07e82526ab573746212a5e1b69cb Mon Sep 17 00:00:00 2001
Message-Id: <e89cd0d873ae07e82526ab573746212a5e1b69cb.1570225802.git.daniel@...earbox.net>
From: Daniel Borkmann <daniel@...earbox.net>
Date: Fri, 4 Oct 2019 23:46:25 +0200
Subject: [PATCH] bpf: Allow __BPF_FUNC_MAPPER to be more customizable

Signed-off-by: Daniel Borkmann <daniel@...earbox.net>
---
 include/uapi/linux/bpf.h | 228 ++++++++++++++++++++-------------------
 1 file changed, 116 insertions(+), 112 deletions(-)

diff --git a/include/uapi/linux/bpf.h b/include/uapi/linux/bpf.h
index 77c6be96d676..0f7e733d4d54 100644
--- a/include/uapi/linux/bpf.h
+++ b/include/uapi/linux/bpf.h
@@ -2751,118 +2751,122 @@ union bpf_attr {
  *
  *		**-EPROTONOSUPPORT** IP packet version is not 4 or 6
  */
-#define __BPF_FUNC_MAPPER(FN)		\
-	FN(unspec),			\
-	FN(map_lookup_elem),		\
-	FN(map_update_elem),		\
-	FN(map_delete_elem),		\
-	FN(probe_read),			\
-	FN(ktime_get_ns),		\
-	FN(trace_printk),		\
-	FN(get_prandom_u32),		\
-	FN(get_smp_processor_id),	\
-	FN(skb_store_bytes),		\
-	FN(l3_csum_replace),		\
-	FN(l4_csum_replace),		\
-	FN(tail_call),			\
-	FN(clone_redirect),		\
-	FN(get_current_pid_tgid),	\
-	FN(get_current_uid_gid),	\
-	FN(get_current_comm),		\
-	FN(get_cgroup_classid),		\
-	FN(skb_vlan_push),		\
-	FN(skb_vlan_pop),		\
-	FN(skb_get_tunnel_key),		\
-	FN(skb_set_tunnel_key),		\
-	FN(perf_event_read),		\
-	FN(redirect),			\
-	FN(get_route_realm),		\
-	FN(perf_event_output),		\
-	FN(skb_load_bytes),		\
-	FN(get_stackid),		\
-	FN(csum_diff),			\
-	FN(skb_get_tunnel_opt),		\
-	FN(skb_set_tunnel_opt),		\
-	FN(skb_change_proto),		\
-	FN(skb_change_type),		\
-	FN(skb_under_cgroup),		\
-	FN(get_hash_recalc),		\
-	FN(get_current_task),		\
-	FN(probe_write_user),		\
-	FN(current_task_under_cgroup),	\
-	FN(skb_change_tail),		\
-	FN(skb_pull_data),		\
-	FN(csum_update),		\
-	FN(set_hash_invalid),		\
-	FN(get_numa_node_id),		\
-	FN(skb_change_head),		\
-	FN(xdp_adjust_head),		\
-	FN(probe_read_str),		\
-	FN(get_socket_cookie),		\
-	FN(get_socket_uid),		\
-	FN(set_hash),			\
-	FN(setsockopt),			\
-	FN(skb_adjust_room),		\
-	FN(redirect_map),		\
-	FN(sk_redirect_map),		\
-	FN(sock_map_update),		\
-	FN(xdp_adjust_meta),		\
-	FN(perf_event_read_value),	\
-	FN(perf_prog_read_value),	\
-	FN(getsockopt),			\
-	FN(override_return),		\
-	FN(sock_ops_cb_flags_set),	\
-	FN(msg_redirect_map),		\
-	FN(msg_apply_bytes),		\
-	FN(msg_cork_bytes),		\
-	FN(msg_pull_data),		\
-	FN(bind),			\
-	FN(xdp_adjust_tail),		\
-	FN(skb_get_xfrm_state),		\
-	FN(get_stack),			\
-	FN(skb_load_bytes_relative),	\
-	FN(fib_lookup),			\
-	FN(sock_hash_update),		\
-	FN(msg_redirect_hash),		\
-	FN(sk_redirect_hash),		\
-	FN(lwt_push_encap),		\
-	FN(lwt_seg6_store_bytes),	\
-	FN(lwt_seg6_adjust_srh),	\
-	FN(lwt_seg6_action),		\
-	FN(rc_repeat),			\
-	FN(rc_keydown),			\
-	FN(skb_cgroup_id),		\
-	FN(get_current_cgroup_id),	\
-	FN(get_local_storage),		\
-	FN(sk_select_reuseport),	\
-	FN(skb_ancestor_cgroup_id),	\
-	FN(sk_lookup_tcp),		\
-	FN(sk_lookup_udp),		\
-	FN(sk_release),			\
-	FN(map_push_elem),		\
-	FN(map_pop_elem),		\
-	FN(map_peek_elem),		\
-	FN(msg_push_data),		\
-	FN(msg_pop_data),		\
-	FN(rc_pointer_rel),		\
-	FN(spin_lock),			\
-	FN(spin_unlock),		\
-	FN(sk_fullsock),		\
-	FN(tcp_sock),			\
-	FN(skb_ecn_set_ce),		\
-	FN(get_listener_sock),		\
-	FN(skc_lookup_tcp),		\
-	FN(tcp_check_syncookie),	\
-	FN(sysctl_get_name),		\
-	FN(sysctl_get_current_value),	\
-	FN(sysctl_get_new_value),	\
-	FN(sysctl_set_new_value),	\
-	FN(strtol),			\
-	FN(strtoul),			\
-	FN(sk_storage_get),		\
-	FN(sk_storage_delete),		\
-	FN(send_signal),		\
-	FN(tcp_gen_syncookie),
+#define ____BPF_FUNC_MAPPER(FN, DL)	\
+	FN(unspec) DL			\
+	FN(map_lookup_elem) DL		\
+	FN(map_update_elem) DL		\
+	FN(map_delete_elem) DL		\
+	FN(probe_read) DL		\
+	FN(ktime_get_ns) DL		\
+	FN(trace_printk) DL		\
+	FN(get_prandom_u32) DL		\
+	FN(get_smp_processor_id) DL	\
+	FN(skb_store_bytes) DL		\
+	FN(l3_csum_replace) DL		\
+	FN(l4_csum_replace) DL		\
+	FN(tail_call) DL		\
+	FN(clone_redirect) DL		\
+	FN(get_current_pid_tgid) DL	\
+	FN(get_current_uid_gid) DL	\
+	FN(get_current_comm) DL		\
+	FN(get_cgroup_classid) DL	\
+	FN(skb_vlan_push) DL		\
+	FN(skb_vlan_pop) DL		\
+	FN(skb_get_tunnel_key) DL	\
+	FN(skb_set_tunnel_key) DL	\
+	FN(perf_event_read) DL		\
+	FN(redirect) DL			\
+	FN(get_route_realm) DL		\
+	FN(perf_event_output) DL	\
+	FN(skb_load_bytes) DL		\
+	FN(get_stackid) DL		\
+	FN(csum_diff) DL		\
+	FN(skb_get_tunnel_opt) DL	\
+	FN(skb_set_tunnel_opt) DL	\
+	FN(skb_change_proto) DL		\
+	FN(skb_change_type) DL		\
+	FN(skb_under_cgroup) DL		\
+	FN(get_hash_recalc) DL		\
+	FN(get_current_task) DL		\
+	FN(probe_write_user) DL		\
+	FN(current_task_under_cgroup) DL\
+	FN(skb_change_tail) DL		\
+	FN(skb_pull_data) DL		\
+	FN(csum_update) DL		\
+	FN(set_hash_invalid) DL		\
+	FN(get_numa_node_id) DL		\
+	FN(skb_change_head) DL		\
+	FN(xdp_adjust_head) DL		\
+	FN(probe_read_str) DL		\
+	FN(get_socket_cookie) DL	\
+	FN(get_socket_uid) DL		\
+	FN(set_hash) DL			\
+	FN(setsockopt) DL		\
+	FN(skb_adjust_room) DL		\
+	FN(redirect_map) DL		\
+	FN(sk_redirect_map) DL		\
+	FN(sock_map_update) DL		\
+	FN(xdp_adjust_meta) DL		\
+	FN(perf_event_read_value) DL	\
+	FN(perf_prog_read_value) DL	\
+	FN(getsockopt) DL		\
+	FN(override_return) DL		\
+	FN(sock_ops_cb_flags_set) DL	\
+	FN(msg_redirect_map) DL		\
+	FN(msg_apply_bytes) DL		\
+	FN(msg_cork_bytes) DL		\
+	FN(msg_pull_data) DL		\
+	FN(bind) DL			\
+	FN(xdp_adjust_tail) DL		\
+	FN(skb_get_xfrm_state) DL	\
+	FN(get_stack) DL		\
+	FN(skb_load_bytes_relative) DL	\
+	FN(fib_lookup) DL		\
+	FN(sock_hash_update) DL		\
+	FN(msg_redirect_hash) DL	\
+	FN(sk_redirect_hash) DL		\
+	FN(lwt_push_encap) DL		\
+	FN(lwt_seg6_store_bytes) DL	\
+	FN(lwt_seg6_adjust_srh) DL	\
+	FN(lwt_seg6_action) DL		\
+	FN(rc_repeat) DL		\
+	FN(rc_keydown) DL		\
+	FN(skb_cgroup_id) DL		\
+	FN(get_current_cgroup_id) DL	\
+	FN(get_local_storage) DL	\
+	FN(sk_select_reuseport) DL	\
+	FN(skb_ancestor_cgroup_id) DL	\
+	FN(sk_lookup_tcp) DL		\
+	FN(sk_lookup_udp) DL		\
+	FN(sk_release) DL		\
+	FN(map_push_elem) DL		\
+	FN(map_pop_elem) DL		\
+	FN(map_peek_elem) DL		\
+	FN(msg_push_data) DL		\
+	FN(msg_pop_data) DL		\
+	FN(rc_pointer_rel) DL		\
+	FN(spin_lock) DL		\
+	FN(spin_unlock) DL		\
+	FN(sk_fullsock) DL		\
+	FN(tcp_sock) DL			\
+	FN(skb_ecn_set_ce) DL		\
+	FN(get_listener_sock) DL	\
+	FN(skc_lookup_tcp) DL		\
+	FN(tcp_check_syncookie) DL	\
+	FN(sysctl_get_name) DL		\
+	FN(sysctl_get_current_value) DL	\
+	FN(sysctl_get_new_value) DL	\
+	FN(sysctl_set_new_value) DL	\
+	FN(strtol) DL			\
+	FN(strtoul) DL			\
+	FN(sk_storage_get) DL		\
+	FN(sk_storage_delete) DL	\
+	FN(send_signal) DL		\
+	FN(tcp_gen_syncookie) DL
+
+#define ____BPF_DELIM_COMMA ,
+#define __BPF_FUNC_MAPPER(FN) \
+	____BPF_FUNC_MAPPER(FN, ____BPF_DELIM_COMMA)
 
 /* integer value in 'imm' field of BPF_CALL instruction selects which helper
  * function eBPF program intends to call
-- 
2.21.0

Powered by blists - more mailing lists