diff mbox series

[bpf-next] bpftool: Restore support for BPF offload-enabled feature probing

Message ID 20220308113056.3779069-1-niklas.soderlund@corigine.com (mailing list archive)
State Superseded
Delegated to: BPF
Headers show
Series [bpf-next] bpftool: Restore support for BPF offload-enabled feature probing | expand

Checks

Context Check Description
netdev/tree_selection success Clearly marked for bpf-next
netdev/fixes_present success Fixes tag not required for -next series
netdev/subject_prefix success Link
netdev/cover_letter success Single patches do not need cover letters
netdev/patch_count success Link
netdev/header_inline success No static functions without inline keyword in header files
netdev/build_32bit success Errors and warnings before: 0 this patch: 0
netdev/cc_maintainers warning 10 maintainers not CCed: kuba@kernel.org paul@isovalent.com hawk@kernel.org kpsingh@kernel.org john.fastabend@gmail.com kafai@fb.com songliubraving@fb.com yhs@fb.com netdev@vger.kernel.org davem@davemloft.net
netdev/build_clang success Errors and warnings before: 0 this patch: 0
netdev/module_param success Was 0 now: 0
netdev/verify_signedoff success Signed-off-by tag matches author and committer
netdev/verify_fixes success No Fixes tag
netdev/build_allmodconfig_warn success Errors and warnings before: 0 this patch: 0
netdev/checkpatch success total: 0 errors, 0 warnings, 0 checks, 241 lines checked
netdev/kdoc success Errors and warnings before: 0 this patch: 0
netdev/source_inline success Was 0 now: 0
bpf/vmtest-bpf-next-PR success PR summary
bpf/vmtest-bpf-next success VM_Test

Commit Message

Niklas Söderlund March 8, 2022, 11:30 a.m. UTC
Commit 1a56c18e6c2e4e74 ("bpftool: Stop supporting BPF offload-enabled
feature probing") removed the support to probe for BPF offload features.
This is still something that is useful for NFP NIC that can support
offloading of BPF programs.

The reason for the dropped support was that libbpf starting with v1.0
would drop support for passing the ifindex to the BPF prog/map/helper
feature probing APIs. In order to keep this useful feature for NFP
restore the functionality by moving it directly into bpftool.

The code restored is a simplified version of the code that existed in
libbpf which supposed passing the ifindex. The simplification is that it
only targets the cases where ifindex is given and call into libbpf for
the cases where it's not.

Before restoring support for probing offload features:

  # bpftool feature probe dev ens4np0
  Scanning system call availability...
  bpf() syscall is available

  Scanning eBPF program types...

  Scanning eBPF map types...

  Scanning eBPF helper functions...
  eBPF helpers supported for program type sched_cls:
  eBPF helpers supported for program type xdp:

  Scanning miscellaneous eBPF features...
  Large program size limit is NOT available
  Bounded loop support is NOT available
  ISA extension v2 is NOT available
  ISA extension v3 is NOT available

With support for probing offload features restored:

  # bpftool feature probe dev ens4np0
  Scanning system call availability...
  bpf() syscall is available

  Scanning eBPF program types...
  eBPF program_type sched_cls is available
  eBPF program_type xdp is available

  Scanning eBPF map types...
  eBPF map_type hash is available
  eBPF map_type array is available
  eBPF map_type prog_array is NOT available
  eBPF map_type perf_event_array is NOT available
  eBPF map_type percpu_hash is NOT available
  eBPF map_type percpu_array is NOT available
  eBPF map_type stack_trace is NOT available
  eBPF map_type cgroup_array is NOT available
  eBPF map_type lru_hash is NOT available
  eBPF map_type lru_percpu_hash is NOT available
  eBPF map_type lpm_trie is NOT available
  eBPF map_type array_of_maps is NOT available
  eBPF map_type hash_of_maps is NOT available
  eBPF map_type devmap is NOT available
  eBPF map_type sockmap is NOT available
  eBPF map_type cpumap is NOT available
  eBPF map_type xskmap is NOT available
  eBPF map_type sockhash is NOT available
  eBPF map_type cgroup_storage is NOT available
  eBPF map_type reuseport_sockarray is NOT available
  eBPF map_type percpu_cgroup_storage is NOT available
  eBPF map_type queue is NOT available
  eBPF map_type stack is NOT available
  eBPF map_type sk_storage is NOT available
  eBPF map_type devmap_hash is NOT available
  eBPF map_type struct_ops is NOT available
  eBPF map_type ringbuf is NOT available
  eBPF map_type inode_storage is NOT available
  eBPF map_type task_storage is NOT available
  eBPF map_type bloom_filter is NOT available

  Scanning eBPF helper functions...
  eBPF helpers supported for program type sched_cls:
  	- bpf_map_lookup_elem
  	- bpf_get_prandom_u32
  	- bpf_perf_event_output
  eBPF helpers supported for program type xdp:
  	- bpf_map_lookup_elem
  	- bpf_get_prandom_u32
  	- bpf_perf_event_output
  	- bpf_xdp_adjust_head
  	- bpf_xdp_adjust_tail

  Scanning miscellaneous eBPF features...
  Large program size limit is NOT available
  Bounded loop support is NOT available
  ISA extension v2 is NOT available
  ISA extension v3 is NOT available

Signed-off-by: Niklas Söderlund <niklas.soderlund@corigine.com>
Signed-off-by: Simon Horman <simon.horman@corigine.com>
---
 tools/bpf/bpftool/feature.c | 185 +++++++++++++++++++++++++++++++++---
 1 file changed, 170 insertions(+), 15 deletions(-)

Comments

Quentin Monnet March 8, 2022, 2:23 p.m. UTC | #1
2022-03-08 12:30 UTC+0100 ~ Niklas Söderlund <niklas.soderlund@corigine.com>
> Commit 1a56c18e6c2e4e74 ("bpftool: Stop supporting BPF offload-enabled
> feature probing") removed the support to probe for BPF offload features.
> This is still something that is useful for NFP NIC that can support
> offloading of BPF programs.
> 
> The reason for the dropped support was that libbpf starting with v1.0
> would drop support for passing the ifindex to the BPF prog/map/helper
> feature probing APIs. In order to keep this useful feature for NFP
> restore the functionality by moving it directly into bpftool.
> 
> The code restored is a simplified version of the code that existed in
> libbpf which supposed passing the ifindex. The simplification is that it
> only targets the cases where ifindex is given and call into libbpf for
> the cases where it's not.
> 
> Before restoring support for probing offload features:
> 
>   # bpftool feature probe dev ens4np0
>   Scanning system call availability...
>   bpf() syscall is available
> 
>   Scanning eBPF program types...
> 
>   Scanning eBPF map types...
> 
>   Scanning eBPF helper functions...
>   eBPF helpers supported for program type sched_cls:
>   eBPF helpers supported for program type xdp:
> 
>   Scanning miscellaneous eBPF features...
>   Large program size limit is NOT available
>   Bounded loop support is NOT available
>   ISA extension v2 is NOT available
>   ISA extension v3 is NOT available
> 
> With support for probing offload features restored:
> 
>   # bpftool feature probe dev ens4np0
>   Scanning system call availability...
>   bpf() syscall is available
> 
>   Scanning eBPF program types...
>   eBPF program_type sched_cls is available
>   eBPF program_type xdp is available
> 
>   Scanning eBPF map types...
>   eBPF map_type hash is available
>   eBPF map_type array is available
>   eBPF map_type prog_array is NOT available
>   eBPF map_type perf_event_array is NOT available
>   eBPF map_type percpu_hash is NOT available
>   eBPF map_type percpu_array is NOT available
>   eBPF map_type stack_trace is NOT available
>   eBPF map_type cgroup_array is NOT available
>   eBPF map_type lru_hash is NOT available
>   eBPF map_type lru_percpu_hash is NOT available
>   eBPF map_type lpm_trie is NOT available
>   eBPF map_type array_of_maps is NOT available
>   eBPF map_type hash_of_maps is NOT available
>   eBPF map_type devmap is NOT available
>   eBPF map_type sockmap is NOT available
>   eBPF map_type cpumap is NOT available
>   eBPF map_type xskmap is NOT available
>   eBPF map_type sockhash is NOT available
>   eBPF map_type cgroup_storage is NOT available
>   eBPF map_type reuseport_sockarray is NOT available
>   eBPF map_type percpu_cgroup_storage is NOT available
>   eBPF map_type queue is NOT available
>   eBPF map_type stack is NOT available
>   eBPF map_type sk_storage is NOT available
>   eBPF map_type devmap_hash is NOT available
>   eBPF map_type struct_ops is NOT available
>   eBPF map_type ringbuf is NOT available
>   eBPF map_type inode_storage is NOT available
>   eBPF map_type task_storage is NOT available
>   eBPF map_type bloom_filter is NOT available
> 
>   Scanning eBPF helper functions...
>   eBPF helpers supported for program type sched_cls:
>   	- bpf_map_lookup_elem
>   	- bpf_get_prandom_u32
>   	- bpf_perf_event_output
>   eBPF helpers supported for program type xdp:
>   	- bpf_map_lookup_elem
>   	- bpf_get_prandom_u32
>   	- bpf_perf_event_output
>   	- bpf_xdp_adjust_head
>   	- bpf_xdp_adjust_tail
> 
>   Scanning miscellaneous eBPF features...
>   Large program size limit is NOT available
>   Bounded loop support is NOT available
>   ISA extension v2 is NOT available
>   ISA extension v3 is NOT available
> 
> Signed-off-by: Niklas Söderlund <niklas.soderlund@corigine.com>
> Signed-off-by: Simon Horman <simon.horman@corigine.com>
> ---
>  tools/bpf/bpftool/feature.c | 185 +++++++++++++++++++++++++++++++++---
>  1 file changed, 170 insertions(+), 15 deletions(-)
> 
> diff --git a/tools/bpf/bpftool/feature.c b/tools/bpf/bpftool/feature.c
> index 9c894b1447de8cf0..4943beb1823111c8 100644
> --- a/tools/bpf/bpftool/feature.c
> +++ b/tools/bpf/bpftool/feature.c
> @@ -3,6 +3,7 @@
>  
>  #include <ctype.h>
>  #include <errno.h>
> +#include <fcntl.h>
>  #include <string.h>
>  #include <unistd.h>
>  #include <net/if.h>
> @@ -45,6 +46,11 @@ static bool run_as_unprivileged;
>  
>  /* Miscellaneous utility functions */
>  
> +static bool grep(const char *buffer, const char *pattern)
> +{
> +	return !!strstr(buffer, pattern);
> +}
> +
>  static bool check_procfs(void)
>  {
>  	struct statfs st_fs;
> @@ -135,6 +141,32 @@ static void print_end_section(void)
>  
>  /* Probing functions */
>  
> +static int get_vendor_id(int ifindex)
> +{
> +	char ifname[IF_NAMESIZE], path[64], buf[8];
> +	ssize_t len;
> +	int fd;
> +
> +	if (!if_indextoname(ifindex, ifname))
> +		return -1;
> +
> +	snprintf(path, sizeof(path), "/sys/class/net/%s/device/vendor", ifname);
> +
> +	fd = open(path, O_RDONLY | O_CLOEXEC);
> +	if (fd < 0)
> +		return -1;
> +
> +	len = read(fd, buf, sizeof(buf));
> +	close(fd);
> +	if (len < 0)
> +		return -1;
> +	if (len >= (ssize_t)sizeof(buf))
> +		return -1;
> +	buf[len] = '\0';
> +
> +	return strtol(buf, NULL, 0);
> +}
> +
>  static int read_procfs(const char *path)
>  {
>  	char *endptr, *line = NULL;
> @@ -478,6 +510,69 @@ static bool probe_bpf_syscall(const char *define_prefix)
>  	return res;
>  }
>  
> +static int
> +probe_prog_load_ifindex(enum bpf_prog_type prog_type,
> +			const struct bpf_insn *insns, size_t insns_cnt,
> +			char *log_buf, size_t log_buf_sz,
> +			__u32 ifindex)
> +{
> +	LIBBPF_OPTS(bpf_prog_load_opts, opts,
> +		    .log_buf = log_buf,
> +		    .log_size = log_buf_sz,
> +		    .log_level = log_buf ? 1 : 0,
> +		    .prog_ifindex = ifindex,
> +		   );
> +	const char *exp_msg = NULL;
> +	int fd, err, exp_err = 0;
> +	char buf[4096];
> +
> +	switch (prog_type) {
> +	case BPF_PROG_TYPE_SCHED_CLS:
> +	case BPF_PROG_TYPE_XDP:
> +		break;
> +	default:
> +		return -EOPNOTSUPP;

This will not be caught in probe_prog_type_ifindex(), where you only
check for the errno value, will it? You should also check the return
code from probe_prog_load_ifindex()? (Same thing in probe_helper_ifindex()).

You could also get rid of this switch entirely, because the function is
never called with a program type other than TC or XDP (given that you
already check in probe_prog_type(), and helper probes are only run
against supported program tyeps).

> +	}
> +
> +	fd = bpf_prog_load(prog_type, NULL, "GPL", insns, insns_cnt, &opts);
> +	err = -errno;
> +	if (fd >= 0)
> +		close(fd);
> +	if (exp_err) {

exp_err is always 0, you don't need this part. I think this is a
leftover of the previous libbpf probes.

> +		if (fd >= 0 || err != exp_err)
> +			return 0;
> +		if (exp_msg && !strstr(buf, exp_msg))
> +			return 0;
> +		return 1;
> +	}
> +	return fd >= 0 ? 1 : 0;
> +}
> +
> +static bool probe_prog_type_ifindex(enum bpf_prog_type prog_type, __u32 ifindex)
> +{
> +	struct bpf_insn insns[2] = {
> +		BPF_MOV64_IMM(BPF_REG_0, 0),
> +		BPF_EXIT_INSN()
> +	};
> +
> +	switch (prog_type) {
> +	case BPF_PROG_TYPE_SCHED_CLS:
> +		/* nfp returns -EINVAL on exit(0) with TC offload */
> +		insns[0].imm = 2;
> +		break;
> +	case BPF_PROG_TYPE_XDP:
> +		break;
> +	default:
> +		return false;
> +	}
> +
> +	errno = 0;
> +	probe_prog_load_ifindex(prog_type, insns, ARRAY_SIZE(insns), NULL, 0,
> +				ifindex);
> +
> +	return errno != EINVAL && errno != EOPNOTSUPP;
> +}
> +
>  static void
>  probe_prog_type(enum bpf_prog_type prog_type, bool *supported_types,
>  		const char *define_prefix, __u32 ifindex)
> @@ -488,11 +583,19 @@ probe_prog_type(enum bpf_prog_type prog_type, bool *supported_types,
>  	bool res;
>  
>  	if (ifindex) {
> -		p_info("BPF offload feature probing is not supported");
> -		return;
> +		switch (prog_type) {
> +		case BPF_PROG_TYPE_SCHED_CLS:
> +		case BPF_PROG_TYPE_XDP:
> +			break;
> +		default:
> +			return;
> +		}

Here we skip the probe entirely (we don't print a result, even negative)
for types that are not supported by the SmartNICs today. But for map
types, the equivalent switch is in probe_map_type_ifindex(), and it
skips the actual bpf() syscall but it doesn't skip the part where we
print a result.

This means that the output for program types shows the result for just
TC/XDP, while the output for map types shows the result for all maps
known to bpftool, even if we “know” they are not supported for offload.
This shows in your commit description. Could we harmonise between maps
and programs? I don't mind much either way you choose, printing all or
printing few.

Thanks,
Quentin
Niklas Söderlund March 8, 2022, 2:47 p.m. UTC | #2
Hi Quentin,

On 2022-03-08 14:23:30 +0000, Quentin Monnet wrote:
> 2022-03-08 12:30 UTC+0100 ~ Niklas Söderlund <niklas.soderlund@corigine.com>
> > Commit 1a56c18e6c2e4e74 ("bpftool: Stop supporting BPF offload-enabled
> > feature probing") removed the support to probe for BPF offload features.
> > This is still something that is useful for NFP NIC that can support
> > offloading of BPF programs.
> > 
> > The reason for the dropped support was that libbpf starting with v1.0
> > would drop support for passing the ifindex to the BPF prog/map/helper
> > feature probing APIs. In order to keep this useful feature for NFP
> > restore the functionality by moving it directly into bpftool.
> > 
> > The code restored is a simplified version of the code that existed in
> > libbpf which supposed passing the ifindex. The simplification is that it
> > only targets the cases where ifindex is given and call into libbpf for
> > the cases where it's not.
> > 
> > Before restoring support for probing offload features:
> > 
> >   # bpftool feature probe dev ens4np0
> >   Scanning system call availability...
> >   bpf() syscall is available
> > 
> >   Scanning eBPF program types...
> > 
> >   Scanning eBPF map types...
> > 
> >   Scanning eBPF helper functions...
> >   eBPF helpers supported for program type sched_cls:
> >   eBPF helpers supported for program type xdp:
> > 
> >   Scanning miscellaneous eBPF features...
> >   Large program size limit is NOT available
> >   Bounded loop support is NOT available
> >   ISA extension v2 is NOT available
> >   ISA extension v3 is NOT available
> > 
> > With support for probing offload features restored:
> > 
> >   # bpftool feature probe dev ens4np0
> >   Scanning system call availability...
> >   bpf() syscall is available
> > 
> >   Scanning eBPF program types...
> >   eBPF program_type sched_cls is available
> >   eBPF program_type xdp is available
> > 
> >   Scanning eBPF map types...
> >   eBPF map_type hash is available
> >   eBPF map_type array is available
> >   eBPF map_type prog_array is NOT available
> >   eBPF map_type perf_event_array is NOT available
> >   eBPF map_type percpu_hash is NOT available
> >   eBPF map_type percpu_array is NOT available
> >   eBPF map_type stack_trace is NOT available
> >   eBPF map_type cgroup_array is NOT available
> >   eBPF map_type lru_hash is NOT available
> >   eBPF map_type lru_percpu_hash is NOT available
> >   eBPF map_type lpm_trie is NOT available
> >   eBPF map_type array_of_maps is NOT available
> >   eBPF map_type hash_of_maps is NOT available
> >   eBPF map_type devmap is NOT available
> >   eBPF map_type sockmap is NOT available
> >   eBPF map_type cpumap is NOT available
> >   eBPF map_type xskmap is NOT available
> >   eBPF map_type sockhash is NOT available
> >   eBPF map_type cgroup_storage is NOT available
> >   eBPF map_type reuseport_sockarray is NOT available
> >   eBPF map_type percpu_cgroup_storage is NOT available
> >   eBPF map_type queue is NOT available
> >   eBPF map_type stack is NOT available
> >   eBPF map_type sk_storage is NOT available
> >   eBPF map_type devmap_hash is NOT available
> >   eBPF map_type struct_ops is NOT available
> >   eBPF map_type ringbuf is NOT available
> >   eBPF map_type inode_storage is NOT available
> >   eBPF map_type task_storage is NOT available
> >   eBPF map_type bloom_filter is NOT available
> > 
> >   Scanning eBPF helper functions...
> >   eBPF helpers supported for program type sched_cls:
> >   	- bpf_map_lookup_elem
> >   	- bpf_get_prandom_u32
> >   	- bpf_perf_event_output
> >   eBPF helpers supported for program type xdp:
> >   	- bpf_map_lookup_elem
> >   	- bpf_get_prandom_u32
> >   	- bpf_perf_event_output
> >   	- bpf_xdp_adjust_head
> >   	- bpf_xdp_adjust_tail
> > 
> >   Scanning miscellaneous eBPF features...
> >   Large program size limit is NOT available
> >   Bounded loop support is NOT available
> >   ISA extension v2 is NOT available
> >   ISA extension v3 is NOT available
> > 
> > Signed-off-by: Niklas Söderlund <niklas.soderlund@corigine.com>
> > Signed-off-by: Simon Horman <simon.horman@corigine.com>
> > ---
> >  tools/bpf/bpftool/feature.c | 185 +++++++++++++++++++++++++++++++++---
> >  1 file changed, 170 insertions(+), 15 deletions(-)
> > 
> > diff --git a/tools/bpf/bpftool/feature.c b/tools/bpf/bpftool/feature.c
> > index 9c894b1447de8cf0..4943beb1823111c8 100644
> > --- a/tools/bpf/bpftool/feature.c
> > +++ b/tools/bpf/bpftool/feature.c
> > @@ -3,6 +3,7 @@
> >  
> >  #include <ctype.h>
> >  #include <errno.h>
> > +#include <fcntl.h>
> >  #include <string.h>
> >  #include <unistd.h>
> >  #include <net/if.h>
> > @@ -45,6 +46,11 @@ static bool run_as_unprivileged;
> >  
> >  /* Miscellaneous utility functions */
> >  
> > +static bool grep(const char *buffer, const char *pattern)
> > +{
> > +	return !!strstr(buffer, pattern);
> > +}
> > +
> >  static bool check_procfs(void)
> >  {
> >  	struct statfs st_fs;
> > @@ -135,6 +141,32 @@ static void print_end_section(void)
> >  
> >  /* Probing functions */
> >  
> > +static int get_vendor_id(int ifindex)
> > +{
> > +	char ifname[IF_NAMESIZE], path[64], buf[8];
> > +	ssize_t len;
> > +	int fd;
> > +
> > +	if (!if_indextoname(ifindex, ifname))
> > +		return -1;
> > +
> > +	snprintf(path, sizeof(path), "/sys/class/net/%s/device/vendor", ifname);
> > +
> > +	fd = open(path, O_RDONLY | O_CLOEXEC);
> > +	if (fd < 0)
> > +		return -1;
> > +
> > +	len = read(fd, buf, sizeof(buf));
> > +	close(fd);
> > +	if (len < 0)
> > +		return -1;
> > +	if (len >= (ssize_t)sizeof(buf))
> > +		return -1;
> > +	buf[len] = '\0';
> > +
> > +	return strtol(buf, NULL, 0);
> > +}
> > +
> >  static int read_procfs(const char *path)
> >  {
> >  	char *endptr, *line = NULL;
> > @@ -478,6 +510,69 @@ static bool probe_bpf_syscall(const char *define_prefix)
> >  	return res;
> >  }
> >  
> > +static int
> > +probe_prog_load_ifindex(enum bpf_prog_type prog_type,
> > +			const struct bpf_insn *insns, size_t insns_cnt,
> > +			char *log_buf, size_t log_buf_sz,
> > +			__u32 ifindex)
> > +{
> > +	LIBBPF_OPTS(bpf_prog_load_opts, opts,
> > +		    .log_buf = log_buf,
> > +		    .log_size = log_buf_sz,
> > +		    .log_level = log_buf ? 1 : 0,
> > +		    .prog_ifindex = ifindex,
> > +		   );
> > +	const char *exp_msg = NULL;
> > +	int fd, err, exp_err = 0;
> > +	char buf[4096];
> > +
> > +	switch (prog_type) {
> > +	case BPF_PROG_TYPE_SCHED_CLS:
> > +	case BPF_PROG_TYPE_XDP:
> > +		break;
> > +	default:
> > +		return -EOPNOTSUPP;
> 
> This will not be caught in probe_prog_type_ifindex(), where you only
> check for the errno value, will it? You should also check the return
> code from probe_prog_load_ifindex()? (Same thing in probe_helper_ifindex()).
> 
> You could also get rid of this switch entirely, because the function is
> never called with a program type other than TC or XDP (given that you
> already check in probe_prog_type(), and helper probes are only run
> against supported program tyeps).

I agree with this comment. I only kept the return code here as that is 
how it was treated in the libbpf version in the code. I will improve on 
this and strip it out.

> 
> > +	}
> > +
> > +	fd = bpf_prog_load(prog_type, NULL, "GPL", insns, insns_cnt, &opts);
> > +	err = -errno;
> > +	if (fd >= 0)
> > +		close(fd);
> > +	if (exp_err) {
> 
> exp_err is always 0, you don't need this part. I think this is a
> leftover of the previous libbpf probes.

Thanks, not sure how I missed that.

> 
> > +		if (fd >= 0 || err != exp_err)
> > +			return 0;
> > +		if (exp_msg && !strstr(buf, exp_msg))
> > +			return 0;
> > +		return 1;
> > +	}
> > +	return fd >= 0 ? 1 : 0;
> > +}
> > +
> > +static bool probe_prog_type_ifindex(enum bpf_prog_type prog_type, __u32 ifindex)
> > +{
> > +	struct bpf_insn insns[2] = {
> > +		BPF_MOV64_IMM(BPF_REG_0, 0),
> > +		BPF_EXIT_INSN()
> > +	};
> > +
> > +	switch (prog_type) {
> > +	case BPF_PROG_TYPE_SCHED_CLS:
> > +		/* nfp returns -EINVAL on exit(0) with TC offload */
> > +		insns[0].imm = 2;
> > +		break;
> > +	case BPF_PROG_TYPE_XDP:
> > +		break;
> > +	default:
> > +		return false;
> > +	}
> > +
> > +	errno = 0;
> > +	probe_prog_load_ifindex(prog_type, insns, ARRAY_SIZE(insns), NULL, 0,
> > +				ifindex);
> > +
> > +	return errno != EINVAL && errno != EOPNOTSUPP;
> > +}
> > +
> >  static void
> >  probe_prog_type(enum bpf_prog_type prog_type, bool *supported_types,
> >  		const char *define_prefix, __u32 ifindex)
> > @@ -488,11 +583,19 @@ probe_prog_type(enum bpf_prog_type prog_type, bool *supported_types,
> >  	bool res;
> >  
> >  	if (ifindex) {
> > -		p_info("BPF offload feature probing is not supported");
> > -		return;
> > +		switch (prog_type) {
> > +		case BPF_PROG_TYPE_SCHED_CLS:
> > +		case BPF_PROG_TYPE_XDP:
> > +			break;
> > +		default:
> > +			return;
> > +		}
> 
> Here we skip the probe entirely (we don't print a result, even negative)
> for types that are not supported by the SmartNICs today. But for map
> types, the equivalent switch is in probe_map_type_ifindex(), and it
> skips the actual bpf() syscall but it doesn't skip the part where we
> print a result.
> 
> This means that the output for program types shows the result for just
> TC/XDP, while the output for map types shows the result for all maps
> known to bpftool, even if we “know” they are not supported for offload.
> This shows in your commit description. Could we harmonise between maps
> and programs? I don't mind much either way you choose, printing all or
> printing few.

This is how the output looked before the support for offload-enabled 
feature probing was dropped. I agree it would make sens to harmonise the 
two but did not want to do that at the same time as restoring the 
feature. But as you agree it's a good idea and I need to do a v2 anyway 
I will do so already.

I think aligning on how it's done for maps makes most sens.

> 
> Thanks,
> Quentin
Quentin Monnet March 8, 2022, 9:43 p.m. UTC | #3
On Tue, 8 Mar 2022 at 14:47, Niklas Söderlund
<niklas.soderlund@corigine.com> wrote:
>
> Hi Quentin,
>
> On 2022-03-08 14:23:30 +0000, Quentin Monnet wrote:
> > 2022-03-08 12:30 UTC+0100 ~ Niklas Söderlund <niklas.soderlund@corigine.com>
> > > Commit 1a56c18e6c2e4e74 ("bpftool: Stop supporting BPF offload-enabled
> > > feature probing") removed the support to probe for BPF offload features.
> > > This is still something that is useful for NFP NIC that can support
> > > offloading of BPF programs.
> > >
> > > The reason for the dropped support was that libbpf starting with v1.0
> > > would drop support for passing the ifindex to the BPF prog/map/helper
> > > feature probing APIs. In order to keep this useful feature for NFP
> > > restore the functionality by moving it directly into bpftool.
> > >
> > > The code restored is a simplified version of the code that existed in
> > > libbpf which supposed passing the ifindex. The simplification is that it
> > > only targets the cases where ifindex is given and call into libbpf for
> > > the cases where it's not.
> > >
> > > Before restoring support for probing offload features:
> > >
> > >   # bpftool feature probe dev ens4np0
> > >   Scanning system call availability...
> > >   bpf() syscall is available
> > >
> > >   Scanning eBPF program types...
> > >
> > >   Scanning eBPF map types...
> > >
> > >   Scanning eBPF helper functions...
> > >   eBPF helpers supported for program type sched_cls:
> > >   eBPF helpers supported for program type xdp:
> > >
> > >   Scanning miscellaneous eBPF features...
> > >   Large program size limit is NOT available
> > >   Bounded loop support is NOT available
> > >   ISA extension v2 is NOT available
> > >   ISA extension v3 is NOT available
> > >
> > > With support for probing offload features restored:
> > >
> > >   # bpftool feature probe dev ens4np0
> > >   Scanning system call availability...
> > >   bpf() syscall is available
> > >
> > >   Scanning eBPF program types...
> > >   eBPF program_type sched_cls is available
> > >   eBPF program_type xdp is available
> > >
> > >   Scanning eBPF map types...
> > >   eBPF map_type hash is available
> > >   eBPF map_type array is available
> > >   eBPF map_type prog_array is NOT available
> > >   eBPF map_type perf_event_array is NOT available
> > >   eBPF map_type percpu_hash is NOT available
> > >   eBPF map_type percpu_array is NOT available
> > >   eBPF map_type stack_trace is NOT available
> > >   eBPF map_type cgroup_array is NOT available
> > >   eBPF map_type lru_hash is NOT available
> > >   eBPF map_type lru_percpu_hash is NOT available
> > >   eBPF map_type lpm_trie is NOT available
> > >   eBPF map_type array_of_maps is NOT available
> > >   eBPF map_type hash_of_maps is NOT available
> > >   eBPF map_type devmap is NOT available
> > >   eBPF map_type sockmap is NOT available
> > >   eBPF map_type cpumap is NOT available
> > >   eBPF map_type xskmap is NOT available
> > >   eBPF map_type sockhash is NOT available
> > >   eBPF map_type cgroup_storage is NOT available
> > >   eBPF map_type reuseport_sockarray is NOT available
> > >   eBPF map_type percpu_cgroup_storage is NOT available
> > >   eBPF map_type queue is NOT available
> > >   eBPF map_type stack is NOT available
> > >   eBPF map_type sk_storage is NOT available
> > >   eBPF map_type devmap_hash is NOT available
> > >   eBPF map_type struct_ops is NOT available
> > >   eBPF map_type ringbuf is NOT available
> > >   eBPF map_type inode_storage is NOT available
> > >   eBPF map_type task_storage is NOT available
> > >   eBPF map_type bloom_filter is NOT available
> > >
> > >   Scanning eBPF helper functions...
> > >   eBPF helpers supported for program type sched_cls:
> > >     - bpf_map_lookup_elem
> > >     - bpf_get_prandom_u32
> > >     - bpf_perf_event_output
> > >   eBPF helpers supported for program type xdp:
> > >     - bpf_map_lookup_elem
> > >     - bpf_get_prandom_u32
> > >     - bpf_perf_event_output
> > >     - bpf_xdp_adjust_head
> > >     - bpf_xdp_adjust_tail
> > >
> > >   Scanning miscellaneous eBPF features...
> > >   Large program size limit is NOT available
> > >   Bounded loop support is NOT available
> > >   ISA extension v2 is NOT available
> > >   ISA extension v3 is NOT available
> > >
> > > Signed-off-by: Niklas Söderlund <niklas.soderlund@corigine.com>
> > > Signed-off-by: Simon Horman <simon.horman@corigine.com>
> > > ---
> > >  tools/bpf/bpftool/feature.c | 185 +++++++++++++++++++++++++++++++++---
> > >  1 file changed, 170 insertions(+), 15 deletions(-)
> > >
> > > diff --git a/tools/bpf/bpftool/feature.c b/tools/bpf/bpftool/feature.c
> > > index 9c894b1447de8cf0..4943beb1823111c8 100644
> > > --- a/tools/bpf/bpftool/feature.c
> > > +++ b/tools/bpf/bpftool/feature.c
> > > @@ -3,6 +3,7 @@
> > >
> > >  #include <ctype.h>
> > >  #include <errno.h>
> > > +#include <fcntl.h>
> > >  #include <string.h>
> > >  #include <unistd.h>
> > >  #include <net/if.h>
> > > @@ -45,6 +46,11 @@ static bool run_as_unprivileged;
> > >
> > >  /* Miscellaneous utility functions */
> > >
> > > +static bool grep(const char *buffer, const char *pattern)
> > > +{
> > > +   return !!strstr(buffer, pattern);
> > > +}
> > > +
> > >  static bool check_procfs(void)
> > >  {
> > >     struct statfs st_fs;
> > > @@ -135,6 +141,32 @@ static void print_end_section(void)
> > >
> > >  /* Probing functions */
> > >
> > > +static int get_vendor_id(int ifindex)
> > > +{
> > > +   char ifname[IF_NAMESIZE], path[64], buf[8];
> > > +   ssize_t len;
> > > +   int fd;
> > > +
> > > +   if (!if_indextoname(ifindex, ifname))
> > > +           return -1;
> > > +
> > > +   snprintf(path, sizeof(path), "/sys/class/net/%s/device/vendor", ifname);
> > > +
> > > +   fd = open(path, O_RDONLY | O_CLOEXEC);
> > > +   if (fd < 0)
> > > +           return -1;
> > > +
> > > +   len = read(fd, buf, sizeof(buf));
> > > +   close(fd);
> > > +   if (len < 0)
> > > +           return -1;
> > > +   if (len >= (ssize_t)sizeof(buf))
> > > +           return -1;
> > > +   buf[len] = '\0';
> > > +
> > > +   return strtol(buf, NULL, 0);
> > > +}
> > > +
> > >  static int read_procfs(const char *path)
> > >  {
> > >     char *endptr, *line = NULL;
> > > @@ -478,6 +510,69 @@ static bool probe_bpf_syscall(const char *define_prefix)
> > >     return res;
> > >  }
> > >
> > > +static int
> > > +probe_prog_load_ifindex(enum bpf_prog_type prog_type,
> > > +                   const struct bpf_insn *insns, size_t insns_cnt,
> > > +                   char *log_buf, size_t log_buf_sz,
> > > +                   __u32 ifindex)
> > > +{
> > > +   LIBBPF_OPTS(bpf_prog_load_opts, opts,
> > > +               .log_buf = log_buf,
> > > +               .log_size = log_buf_sz,
> > > +               .log_level = log_buf ? 1 : 0,
> > > +               .prog_ifindex = ifindex,
> > > +              );
> > > +   const char *exp_msg = NULL;
> > > +   int fd, err, exp_err = 0;
> > > +   char buf[4096];
> > > +
> > > +   switch (prog_type) {
> > > +   case BPF_PROG_TYPE_SCHED_CLS:
> > > +   case BPF_PROG_TYPE_XDP:
> > > +           break;
> > > +   default:
> > > +           return -EOPNOTSUPP;
> >
> > This will not be caught in probe_prog_type_ifindex(), where you only
> > check for the errno value, will it? You should also check the return
> > code from probe_prog_load_ifindex()? (Same thing in probe_helper_ifindex()).
> >
> > You could also get rid of this switch entirely, because the function is
> > never called with a program type other than TC or XDP (given that you
> > already check in probe_prog_type(), and helper probes are only run
> > against supported program tyeps).
>
> I agree with this comment. I only kept the return code here as that is
> how it was treated in the libbpf version in the code. I will improve on
> this and strip it out.
>
> >
> > > +   }
> > > +
> > > +   fd = bpf_prog_load(prog_type, NULL, "GPL", insns, insns_cnt, &opts);
> > > +   err = -errno;
> > > +   if (fd >= 0)
> > > +           close(fd);
> > > +   if (exp_err) {
> >
> > exp_err is always 0, you don't need this part. I think this is a
> > leftover of the previous libbpf probes.
>
> Thanks, not sure how I missed that.
>
> >
> > > +           if (fd >= 0 || err != exp_err)
> > > +                   return 0;
> > > +           if (exp_msg && !strstr(buf, exp_msg))
> > > +                   return 0;
> > > +           return 1;
> > > +   }
> > > +   return fd >= 0 ? 1 : 0;
> > > +}
> > > +
> > > +static bool probe_prog_type_ifindex(enum bpf_prog_type prog_type, __u32 ifindex)
> > > +{
> > > +   struct bpf_insn insns[2] = {
> > > +           BPF_MOV64_IMM(BPF_REG_0, 0),
> > > +           BPF_EXIT_INSN()
> > > +   };
> > > +
> > > +   switch (prog_type) {
> > > +   case BPF_PROG_TYPE_SCHED_CLS:
> > > +           /* nfp returns -EINVAL on exit(0) with TC offload */
> > > +           insns[0].imm = 2;
> > > +           break;
> > > +   case BPF_PROG_TYPE_XDP:
> > > +           break;
> > > +   default:
> > > +           return false;
> > > +   }
> > > +
> > > +   errno = 0;
> > > +   probe_prog_load_ifindex(prog_type, insns, ARRAY_SIZE(insns), NULL, 0,
> > > +                           ifindex);
> > > +
> > > +   return errno != EINVAL && errno != EOPNOTSUPP;
> > > +}
> > > +
> > >  static void
> > >  probe_prog_type(enum bpf_prog_type prog_type, bool *supported_types,
> > >             const char *define_prefix, __u32 ifindex)
> > > @@ -488,11 +583,19 @@ probe_prog_type(enum bpf_prog_type prog_type, bool *supported_types,
> > >     bool res;
> > >
> > >     if (ifindex) {
> > > -           p_info("BPF offload feature probing is not supported");
> > > -           return;
> > > +           switch (prog_type) {
> > > +           case BPF_PROG_TYPE_SCHED_CLS:
> > > +           case BPF_PROG_TYPE_XDP:
> > > +                   break;
> > > +           default:
> > > +                   return;
> > > +           }
> >
> > Here we skip the probe entirely (we don't print a result, even negative)
> > for types that are not supported by the SmartNICs today. But for map
> > types, the equivalent switch is in probe_map_type_ifindex(), and it
> > skips the actual bpf() syscall but it doesn't skip the part where we
> > print a result.
> >
> > This means that the output for program types shows the result for just
> > TC/XDP, while the output for map types shows the result for all maps
> > known to bpftool, even if we “know” they are not supported for offload.
> > This shows in your commit description. Could we harmonise between maps
> > and programs? I don't mind much either way you choose, printing all or
> > printing few.
>
> This is how the output looked before the support for offload-enabled
> feature probing was dropped. I agree it would make sens to harmonise the
> two but did not want to do that at the same time as restoring the
> feature. But as you agree it's a good idea and I need to do a v2 anyway
> I will do so already.

So I looked a bit more into it. I couldn't remember the reason why
we'd probe all maps but not all prog types, but the commit log has a
hint:

    Among the program types, only the ones that can be offloaded are probed.
    All map types are probed, as there is no specific rule telling which one
    could or could not be supported by a device in the future. All helpers
    are probed (but only for offload-able program types).

I think at the time, I was referring, for program types, to this check
in bpf_prog_offload_init() in kernel/bpf/offload.c.

    if (attr->prog_type != BPF_PROG_TYPE_SCHED_CLS &&
        attr->prog_type != BPF_PROG_TYPE_XDP)
        return -EINVAL;

This makes it impossible to have other types offloaded; but there's no
equivalent for maps, so we could theoretically have any map type
supported. So maybe not such a bad thing, filtering out non-relevant
program types but allowing out-of-kernel drivers to probe all map
types. Maybe keep this part unchanged for v2, after all?

Quentin
Niklas Söderlund March 8, 2022, 10:26 p.m. UTC | #4
Hi Quentin,

On 2022-03-08 21:43:07 +0000, Quentin Monnet wrote:

> So I looked a bit more into it. I couldn't remember the reason why
> we'd probe all maps but not all prog types, but the commit log has a
> hint:
> 
>     Among the program types, only the ones that can be offloaded are probed.
>     All map types are probed, as there is no specific rule telling which one
>     could or could not be supported by a device in the future. All helpers
>     are probed (but only for offload-able program types).
> 
> I think at the time, I was referring, for program types, to this check
> in bpf_prog_offload_init() in kernel/bpf/offload.c.
> 
>     if (attr->prog_type != BPF_PROG_TYPE_SCHED_CLS &&
>         attr->prog_type != BPF_PROG_TYPE_XDP)
>         return -EINVAL;
> 
> This makes it impossible to have other types offloaded; but there's no
> equivalent for maps, so we could theoretically have any map type
> supported. So maybe not such a bad thing, filtering out non-relevant
> program types but allowing out-of-kernel drivers to probe all map
> types. Maybe keep this part unchanged for v2, after all?

Thanks for following up with this information. With this background I 
agree, lets keep it as it was for v2.
diff mbox series

Patch

diff --git a/tools/bpf/bpftool/feature.c b/tools/bpf/bpftool/feature.c
index 9c894b1447de8cf0..4943beb1823111c8 100644
--- a/tools/bpf/bpftool/feature.c
+++ b/tools/bpf/bpftool/feature.c
@@ -3,6 +3,7 @@ 
 
 #include <ctype.h>
 #include <errno.h>
+#include <fcntl.h>
 #include <string.h>
 #include <unistd.h>
 #include <net/if.h>
@@ -45,6 +46,11 @@  static bool run_as_unprivileged;
 
 /* Miscellaneous utility functions */
 
+static bool grep(const char *buffer, const char *pattern)
+{
+	return !!strstr(buffer, pattern);
+}
+
 static bool check_procfs(void)
 {
 	struct statfs st_fs;
@@ -135,6 +141,32 @@  static void print_end_section(void)
 
 /* Probing functions */
 
+static int get_vendor_id(int ifindex)
+{
+	char ifname[IF_NAMESIZE], path[64], buf[8];
+	ssize_t len;
+	int fd;
+
+	if (!if_indextoname(ifindex, ifname))
+		return -1;
+
+	snprintf(path, sizeof(path), "/sys/class/net/%s/device/vendor", ifname);
+
+	fd = open(path, O_RDONLY | O_CLOEXEC);
+	if (fd < 0)
+		return -1;
+
+	len = read(fd, buf, sizeof(buf));
+	close(fd);
+	if (len < 0)
+		return -1;
+	if (len >= (ssize_t)sizeof(buf))
+		return -1;
+	buf[len] = '\0';
+
+	return strtol(buf, NULL, 0);
+}
+
 static int read_procfs(const char *path)
 {
 	char *endptr, *line = NULL;
@@ -478,6 +510,69 @@  static bool probe_bpf_syscall(const char *define_prefix)
 	return res;
 }
 
+static int
+probe_prog_load_ifindex(enum bpf_prog_type prog_type,
+			const struct bpf_insn *insns, size_t insns_cnt,
+			char *log_buf, size_t log_buf_sz,
+			__u32 ifindex)
+{
+	LIBBPF_OPTS(bpf_prog_load_opts, opts,
+		    .log_buf = log_buf,
+		    .log_size = log_buf_sz,
+		    .log_level = log_buf ? 1 : 0,
+		    .prog_ifindex = ifindex,
+		   );
+	const char *exp_msg = NULL;
+	int fd, err, exp_err = 0;
+	char buf[4096];
+
+	switch (prog_type) {
+	case BPF_PROG_TYPE_SCHED_CLS:
+	case BPF_PROG_TYPE_XDP:
+		break;
+	default:
+		return -EOPNOTSUPP;
+	}
+
+	fd = bpf_prog_load(prog_type, NULL, "GPL", insns, insns_cnt, &opts);
+	err = -errno;
+	if (fd >= 0)
+		close(fd);
+	if (exp_err) {
+		if (fd >= 0 || err != exp_err)
+			return 0;
+		if (exp_msg && !strstr(buf, exp_msg))
+			return 0;
+		return 1;
+	}
+	return fd >= 0 ? 1 : 0;
+}
+
+static bool probe_prog_type_ifindex(enum bpf_prog_type prog_type, __u32 ifindex)
+{
+	struct bpf_insn insns[2] = {
+		BPF_MOV64_IMM(BPF_REG_0, 0),
+		BPF_EXIT_INSN()
+	};
+
+	switch (prog_type) {
+	case BPF_PROG_TYPE_SCHED_CLS:
+		/* nfp returns -EINVAL on exit(0) with TC offload */
+		insns[0].imm = 2;
+		break;
+	case BPF_PROG_TYPE_XDP:
+		break;
+	default:
+		return false;
+	}
+
+	errno = 0;
+	probe_prog_load_ifindex(prog_type, insns, ARRAY_SIZE(insns), NULL, 0,
+				ifindex);
+
+	return errno != EINVAL && errno != EOPNOTSUPP;
+}
+
 static void
 probe_prog_type(enum bpf_prog_type prog_type, bool *supported_types,
 		const char *define_prefix, __u32 ifindex)
@@ -488,11 +583,19 @@  probe_prog_type(enum bpf_prog_type prog_type, bool *supported_types,
 	bool res;
 
 	if (ifindex) {
-		p_info("BPF offload feature probing is not supported");
-		return;
+		switch (prog_type) {
+		case BPF_PROG_TYPE_SCHED_CLS:
+		case BPF_PROG_TYPE_XDP:
+			break;
+		default:
+			return;
+		}
+
+		res = probe_prog_type_ifindex(prog_type, ifindex);
+	} else {
+		res = libbpf_probe_bpf_prog_type(prog_type, NULL);
 	}
 
-	res = libbpf_probe_bpf_prog_type(prog_type, NULL);
 #ifdef USE_LIBCAP
 	/* Probe may succeed even if program load fails, for unprivileged users
 	 * check that we did not fail because of insufficient permissions
@@ -521,6 +624,35 @@  probe_prog_type(enum bpf_prog_type prog_type, bool *supported_types,
 			   define_prefix);
 }
 
+static bool probe_map_type_ifindex(enum bpf_map_type map_type, __u32 ifindex)
+{
+	LIBBPF_OPTS(bpf_map_create_opts, opts);
+	int key_size, value_size, max_entries;
+	int fd;
+
+	opts.map_ifindex = ifindex;
+
+	key_size	= sizeof(__u32);
+	value_size	= sizeof(__u32);
+	max_entries	= 1;
+
+	switch (map_type) {
+	case BPF_MAP_TYPE_HASH:
+	case BPF_MAP_TYPE_ARRAY:
+		break;
+	default:
+		return false;
+	}
+
+	fd = bpf_map_create(map_type, NULL, key_size, value_size, max_entries,
+			    &opts);
+
+	if (fd >= 0)
+		close(fd);
+
+	return fd >= 0;
+}
+
 static void
 probe_map_type(enum bpf_map_type map_type, const char *define_prefix,
 	       __u32 ifindex)
@@ -530,12 +662,10 @@  probe_map_type(enum bpf_map_type map_type, const char *define_prefix,
 	size_t maxlen;
 	bool res;
 
-	if (ifindex) {
-		p_info("BPF offload feature probing is not supported");
-		return;
-	}
-
-	res = libbpf_probe_bpf_map_type(map_type, NULL);
+	if (ifindex)
+		res = probe_map_type_ifindex(map_type, ifindex);
+	else
+		res = libbpf_probe_bpf_map_type(map_type, NULL);
 
 	/* Probe result depends on the success of map creation, no additional
 	 * check required for unprivileged users
@@ -559,6 +689,33 @@  probe_map_type(enum bpf_map_type map_type, const char *define_prefix,
 			   define_prefix);
 }
 
+static bool
+probe_helper_ifindex(enum bpf_func_id id, enum bpf_prog_type prog_type,
+		     __u32 ifindex)
+{
+	struct bpf_insn insns[2] = {
+		BPF_EMIT_CALL(id),
+		BPF_EXIT_INSN()
+	};
+	char buf[4096] = {};
+	bool res;
+
+	probe_prog_load_ifindex(prog_type, insns, ARRAY_SIZE(insns), buf,
+				sizeof(buf), ifindex);
+	res = !grep(buf, "invalid func ") && !grep(buf, "unknown func ");
+
+	switch (get_vendor_id(ifindex)) {
+	case 0x19ee: /* Netronome specific */
+		res = res && !grep(buf, "not supported by FW") &&
+			!grep(buf, "unsupported function id");
+		break;
+	default:
+		break;
+	}
+
+	return res;
+}
+
 static void
 probe_helper_for_progtype(enum bpf_prog_type prog_type, bool supported_type,
 			  const char *define_prefix, unsigned int id,
@@ -567,12 +724,10 @@  probe_helper_for_progtype(enum bpf_prog_type prog_type, bool supported_type,
 	bool res = false;
 
 	if (supported_type) {
-		if (ifindex) {
-			p_info("BPF offload feature probing is not supported");
-			return;
-		}
-
-		res = libbpf_probe_bpf_helper(prog_type, id, NULL);
+		if (ifindex)
+			res = probe_helper_ifindex(id, prog_type, ifindex);
+		else
+			res = libbpf_probe_bpf_helper(prog_type, id, NULL);
 #ifdef USE_LIBCAP
 		/* Probe may succeed even if program load fails, for
 		 * unprivileged users check that we did not fail because of