bpftool: use only nftw for file tree parsing
Subsystems (4)
A message that is not in the archive (sent off-list or not yet received): 20200716052926.10933-1-Tony.Ambardar () gmail ! com
PATCH v3 1/1 bpftool: use only nftw for file tree parsing
The bpftool sources include code to walk file trees, but use multiple frameworks to do so: nftw and fts. While nftw conforms to POSIX/SUSv3 and is widely available, fts is not conformant and less common, especially on non-glibc systems. The inconsistent framework usage hampers maintenance and portability of bpftool, in particular for embedded systems.
Standardize code usage by rewriting one fts-based function to use nftw and clean up some related function warnings by extending use of "const char *" arguments. This change helps in building bpftool against musl for OpenWrt.
Also fix an unsafe call to dirname() by duplicating the string to pass, since some implementations may directly alter it. The same approach is used in libbpf.c.
---
V3:
* clarify dirname() path copy in commit message
* fix whitespace and rearrange comment for clarity
* drop unnecessary initializers, rebalance Christmas tree
* fixup error message and drop others not previously present
* simplify malloc() + memset() -> calloc() and check for mem errors
V2:
* use _GNU_SOURCE to pull in getpagesize(), getline(), nftw() definitions
* use "const char *" in open_obj_pinned() and open_obj_pinned_any()
* make dirname() safely act on a string copy
--- tools/bpf/bpftool/common.c | 132 +++++++++++++++++++++---------------- tools/bpf/bpftool/main.h | 4 +- 2 files changed, 78 insertions(+), 58 deletions(-)
tools/bpf/bpftool/common.c +76 -56
@@ -1,10 +1,11 @@// SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) /* Copyright (C) 2017-2018 Netronome Systems, Inc. */ +#define _GNU_SOURCE#include <ctype.h> #include <errno.h> #include <fcntl.h> -#include <fts.h> +#include <ftw.h> #include <libgen.h> #include <mntent.h> #include <stdbool.h>
@@ -160,24 +161,35 @@ int mount_tracefs(const char *target)return err; } -int open_obj_pinned (char *path,bool quiet) +int open_obj_pinned (const char *path,bool quiet) { -int fd; +char *pname; +int fd =-1 ; - fd =bpf_obj_get (path); + pname =strdup (path); +if (!pname) { +if (!quiet) +p_err ("mem alloc failed" ); + goto out_ret; + } + + fd =bpf_obj_get (pname);if (fd <0 ) {if (!quiet) -p_err ("bpf obj get (%s): %s" , path, - errno ==EACCES && !is_bpffs (dirname (path)) ? +p_err ("bpf obj get (%s): %s" , pname, + errno ==EACCES && !is_bpffs (dirname (pname)) ?"directory not in bpf file system (bpffs)" :strerror (errno)); -return -1 ; + goto out_free; } +out_free: +free (pname); +out_ret:return fd; } -int open_obj_pinned_any (char *path,enum bpf_obj_type exp_type) +int open_obj_pinned_any (const char *path,enum bpf_obj_type exp_type) {enum bpf_obj_type type;int fd;
@@ -367,68 +379,76 @@ void print_hex_data_json(uint8_t *data, size_t len)jsonw_end_array (json_wtr); } +/* extra params for nftw cb*/ +static struct pinned_obj_table *build_fn_table; +static enum bpf_obj_type build_fn_type; + +static int do_build_table_cb (const char *fpath,const struct stat *sb, +int typeflag,struct FTW *ftwbuf) +{ +struct bpf_prog_info pinned_info; +__u32 len =sizeof (pinned_info); +struct pinned_obj *obj_node; +enum bpf_obj_type objtype; +int fd, err =0 ; + +if (typeflag !=FTW_F ) + goto out_ret; + fd =open_obj_pinned (fpath, true); +if (fd <0 ) + goto out_ret; + + objtype =get_fd_type (fd); +if (objtype != build_fn_type) + goto out_close; + +memset (&pinned_info,0 ,sizeof (pinned_info)); +if (bpf_obj_get_info_by_fd (fd, &pinned_info, &len)) + goto out_close; + + obj_node =calloc (1 ,sizeof (*obj_node)); +if (!obj_node) { + err =-1 ; + goto out_close; + } + + obj_node->id = pinned_info.id; + obj_node->path =strdup (fpath); +if (!obj_node->path) { + err =-1 ; +free (obj_node); + goto out_close; + } +hash_add (build_fn_table->table, &obj_node->hash, obj_node->id); + +out_close: +close (fd); +out_ret: +return err; +} +int build_pinned_obj_table (struct pinned_obj_table *tab,enum bpf_obj_type type) { -struct bpf_prog_info pinned_info = {}; -struct pinned_obj *obj_node =NULL ; -__u32 len =sizeof (pinned_info);struct mntent *mntent =NULL ; -enum bpf_obj_type objtype;FILE *mntfile =NULL ; -FTSENT *ftse =NULL ; -FTS *fts =NULL ; -int fd, err; +int flags =FTW_PHYS ; +int nopenfd =16 ; mntfile =setmntent ("/proc/mounts" ,"r" );if (!mntfile)return -1 ; + build_fn_table = tab; + build_fn_type = type; +while ((mntent =getmntent (mntfile))) { -char *path[] = { mntent->mnt_dir,NULL }; +char *path = mntent->mnt_dir;if (strncmp (mntent->mnt_type,"bpf" ,3 ) !=0 )continue ; - - fts =fts_open (path,0 ,NULL ); -if (!fts) -continue ; - -while ((ftse =fts_read (fts))) { -if (!(ftse->fts_info &FTS_F )) -continue ; - fd =open_obj_pinned (ftse->fts_path, true); -if (fd <0 ) -continue ; - - objtype =get_fd_type (fd); -if (objtype != type) { -close (fd); -continue ; - } -memset (&pinned_info,0 ,sizeof (pinned_info)); - err =bpf_obj_get_info_by_fd (fd, &pinned_info, &len); -if (err) { -close (fd); -continue ; - } - - obj_node =malloc (sizeof (*obj_node)); -if (!obj_node) { -close (fd); -fts_close (fts); -fclose (mntfile); -return -1 ; - } - -memset (obj_node,0 ,sizeof (*obj_node)); - obj_node->id = pinned_info.id; - obj_node->path =strdup (ftse->fts_path); -hash_add (tab->table, &obj_node->hash, obj_node->id); - -close (fd); - } -fts_close (fts); +if (nftw (path, do_build_table_cb, nopenfd, flags) ==-1 ) +break ; }fclose (mntfile);return 0 ;
tools/bpf/bpftool/main.h +2 -2
@@ -152,8 +152,8 @@ int cmd_select(const struct cmd *cmds, int argc, char **argv,int get_fd_type (int fd);const char *get_fd_type_name (enum bpf_obj_type type);char *get_fdinfo (int fd,const char *key); -int open_obj_pinned (char *path,bool quiet); -int open_obj_pinned_any (char *path,enum bpf_obj_type exp_type); +int open_obj_pinned (const char *path,bool quiet); +int open_obj_pinned_any (const char *path,enum bpf_obj_type exp_type);int mount_bpffs_for_pin (const char *name);int do_pin_any (int argc,char **argv,int (*get_fd_by_id)(int *,char ***));int do_pin_fd (int fd,const char *name);
Signature · 1 line
2.17.1
Quoted 42 lines · Tony Ambardar
The bpftool sources include code to walk file trees, but use multiple frameworks to do so: nftw and fts. While nftw conforms to POSIX/SUSv3 and is widely available, fts is not conformant and less common, especially on non-glibc systems. The inconsistent framework usage hampers maintenance and portability of bpftool, in particular for embedded systems.
Standardize code usage by rewriting one fts-based function to use nftw and clean up some related function warnings by extending use of "const char *" arguments. This change helps in building bpftool against musl for OpenWrt.
Also fix an unsafe call to
dirname()by duplicating the string to pass, since some implementations may directly alter it. The same approach is used inlibbpf.c.Signed-off-by Tony Ambardar <[email protected]>---
V3:
* clarifydirname()path copy in commit message
* fix whitespace and rearrange comment for clarity
* drop unnecessary initializers, rebalance Christmas tree
* fixup error message and drop others not previously present
* simplifymalloc()+memset()->calloc()and check for mem errorsV2:
* use_GNU_SOURCEto pull ingetpagesize(),getline(),nftw()definitions
* use "const char *" inopen_obj_pinned()andopen_obj_pinned_any()
* makedirname()safely act on a string copy--- tools/bpf/bpftool/common.c | 132 +++++++++++++++++++++---------------- tools/bpf/bpftool/main.h | 4 +- 2 files changed, 78 insertions(+), 58 deletions(-)tools/bpf/bpftool/common.c +0
-0int build_pinned_obj_table (struct pinned_obj_table *tab,enum bpf_obj_type type) {
[...]
Quoted 1 line
while ((mntent = getmntent(mntfile))) {
[...]
Quoted 1 line
tools/bpf/bpftool/common.c +0
-1-while ((ftse =fts_read (fts))) {
[...]
tools/bpf/bpftool/common.c void print_hex_data_json(uint8_t *data, size_t len) · line 451
Quoted 2 lines
tools/bpf/bpftool/common.c +2
-0+if (nftw (path, do_build_table_cb, nopenfd, flags) ==-1 ) +break ;
Sorry I missed that on the previous reviews; but I think a simple break out of the loop changes the previous behaviour, we should instead "return -1" from build_pinned_obj_table() if nftw() returns -1, as we were doing so far.
Looks good otherwise.
Quoted 3 lines
tools/bpf/bpftool/common.c +0
-0}fclose (mntfile);return 0 ;
Quoted 11 lines · Quentin Monnet
Quoted 9 lines · Tony Ambardar
The bpftool sources include code to walk file trees, but use multiple frameworks to do so: nftw and fts. While nftw conforms to POSIX/SUSv3 and is widely available, fts is not conformant and less common, especially on non-glibc systems. The inconsistent framework usage hampers maintenance and portability of bpftool, in particular for embedded systems.
Standardize code usage by rewriting one fts-based function to use nftw and clean up some related function warnings by extending use of "const char *" arguments. This change helps in building bpftool against musl for OpenWrt.
[...]
Quoted 14 lines
Quoted 3 lines
int build_pinned_obj_table(struct
pinned_obj_table*tab,
enumbpf_obj_typetype)
{[...]
Quoted 1 line
while ((mntent = getmntent(mntfile))) {[...]
Quoted 1 line
- while ((ftse =
fts_read(fts))) {[...]
Quoted 7 lines
tools/bpf/bpftool/common.c void print_hex_data_json(uint8_t *data, size_t len) · line 451
Quoted 2 lines
tools/bpf/bpftool/common.c +2
-0+if (nftw (path, do_build_table_cb, nopenfd, flags) ==-1 ) +break ;Sorry I missed that on the previous reviews; but I think a simple break out of the loop changes the previous behaviour, we should instead "return -1" from
build_pinned_obj_table()ifnftw()returns -1, as we were doing so far.
Thanks for the catch. Sorry, that's totally my fault: this was meant to be an "err = nftw(...)" with a "return err" on the common exit path, similar to the rest of the patch. Let me fix and resend.
Kind regards,
Tony
Quoted 5 lines
Looks good otherwise.
Quoted 3 lines
} fclose(mntfile); return 0;
PATCH v4 1/1 bpftool: use only nftw for file tree parsing
In reply to Tony AmbardarThe bpftool sources include code to walk file trees, but use multiple frameworks to do so: nftw and fts. While nftw conforms to POSIX/SUSv3 and is widely available, fts is not conformant and less common, especially on non-glibc systems. The inconsistent framework usage hampers maintenance and portability of bpftool, in particular for embedded systems.
Standardize code usage by rewriting one fts-based function to use nftw and clean up some related function warnings by extending use of "const char *" arguments. This change helps in building bpftool against musl for OpenWrt.
Also fix an unsafe call to dirname() by duplicating the string to pass, since some implementations may directly alter it. The same approach is used in libbpf.c.
---
V4:
* fix return value from build_pinned_obj_table()
V3:
* clarify dirname() path copy in commit message
* fix whitespace and rearrange comment for clarity
* drop unnecessary initializers, rebalance Christmas tree
* fixup error message and drop others not previously present
* simplify malloc() + memset() -> calloc() and check for mem errors
V2:
* use _GNU_SOURCE to pull in getpagesize(), getline(), nftw() definitions
* use "const char *" in open_obj_pinned() and open_obj_pinned_any()
* make dirname() safely act on a string copy
--- tools/bpf/bpftool/common.c | 136 +++++++++++++++++++++---------------- tools/bpf/bpftool/main.h | 4 +- 2 files changed, 81 insertions(+), 59 deletions(-)
tools/bpf/bpftool/common.c +79 -57
@@ -1,10 +1,11 @@// SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) /* Copyright (C) 2017-2018 Netronome Systems, Inc. */ +#define _GNU_SOURCE#include <ctype.h> #include <errno.h> #include <fcntl.h> -#include <fts.h> +#include <ftw.h> #include <libgen.h> #include <mntent.h> #include <stdbool.h>
@@ -160,24 +161,35 @@ int mount_tracefs(const char *target)return err; } -int open_obj_pinned (char *path,bool quiet) +int open_obj_pinned (const char *path,bool quiet) { -int fd; +char *pname; +int fd =-1 ; + + pname =strdup (path); +if (!pname) { +if (!quiet) +p_err ("mem alloc failed" ); + goto out_ret; + } - fd =bpf_obj_get (path); + fd =bpf_obj_get (pname);if (fd <0 ) {if (!quiet) -p_err ("bpf obj get (%s): %s" , path, - errno ==EACCES && !is_bpffs (dirname (path)) ? +p_err ("bpf obj get (%s): %s" , pname, + errno ==EACCES && !is_bpffs (dirname (pname)) ?"directory not in bpf file system (bpffs)" :strerror (errno)); -return -1 ; + goto out_free; } +out_free: +free (pname); +out_ret:return fd; } -int open_obj_pinned_any (char *path,enum bpf_obj_type exp_type) +int open_obj_pinned_any (const char *path,enum bpf_obj_type exp_type) {enum bpf_obj_type type;int fd;
@@ -367,71 +379,81 @@ void print_hex_data_json(uint8_t *data, size_t len)jsonw_end_array (json_wtr); } +/* extra params for nftw cb*/ +static struct pinned_obj_table *build_fn_table; +static enum bpf_obj_type build_fn_type; + +static int do_build_table_cb (const char *fpath,const struct stat *sb, +int typeflag,struct FTW *ftwbuf) +{ +struct bpf_prog_info pinned_info; +__u32 len =sizeof (pinned_info); +struct pinned_obj *obj_node; +enum bpf_obj_type objtype; +int fd, err =0 ; + +if (typeflag !=FTW_F ) + goto out_ret; + fd =open_obj_pinned (fpath, true); +if (fd <0 ) + goto out_ret; + + objtype =get_fd_type (fd); +if (objtype != build_fn_type) + goto out_close; + +memset (&pinned_info,0 ,sizeof (pinned_info)); +if (bpf_obj_get_info_by_fd (fd, &pinned_info, &len)) + goto out_close; + + obj_node =calloc (1 ,sizeof (*obj_node)); +if (!obj_node) { + err =-1 ; + goto out_close; + } + + obj_node->id = pinned_info.id; + obj_node->path =strdup (fpath); +if (!obj_node->path) { + err =-1 ; +free (obj_node); + goto out_close; + } +hash_add (build_fn_table->table, &obj_node->hash, obj_node->id); + +out_close: +close (fd); +out_ret: +return err; +} +int build_pinned_obj_table (struct pinned_obj_table *tab,enum bpf_obj_type type) { -struct bpf_prog_info pinned_info = {}; -struct pinned_obj *obj_node =NULL ; -__u32 len =sizeof (pinned_info);struct mntent *mntent =NULL ; -enum bpf_obj_type objtype;FILE *mntfile =NULL ; -FTSENT *ftse =NULL ; -FTS *fts =NULL ; -int fd, err; +int flags =FTW_PHYS ; +int nopenfd =16 ; +int err =0 ; mntfile =setmntent ("/proc/mounts" ,"r" );if (!mntfile)return -1 ; + build_fn_table = tab; + build_fn_type = type; +while ((mntent =getmntent (mntfile))) { -char *path[] = { mntent->mnt_dir,NULL }; +char *path = mntent->mnt_dir;if (strncmp (mntent->mnt_type,"bpf" ,3 ) !=0 )continue ; - - fts =fts_open (path,0 ,NULL ); -if (!fts) -continue ; - -while ((ftse =fts_read (fts))) { -if (!(ftse->fts_info &FTS_F )) -continue ; - fd =open_obj_pinned (ftse->fts_path, true); -if (fd <0 ) -continue ; - - objtype =get_fd_type (fd); -if (objtype != type) { -close (fd); -continue ; - } -memset (&pinned_info,0 ,sizeof (pinned_info)); - err =bpf_obj_get_info_by_fd (fd, &pinned_info, &len); -if (err) { -close (fd); -continue ; - } - - obj_node =malloc (sizeof (*obj_node)); -if (!obj_node) { -close (fd); -fts_close (fts); -fclose (mntfile); -return -1 ; - } - -memset (obj_node,0 ,sizeof (*obj_node)); - obj_node->id = pinned_info.id; - obj_node->path =strdup (ftse->fts_path); -hash_add (tab->table, &obj_node->hash, obj_node->id); - -close (fd); - } -fts_close (fts); + err =nftw (path, do_build_table_cb, nopenfd, flags); +if (err) +break ; }fclose (mntfile); -return 0 ; +return err; }void delete_pinned_obj_table (struct pinned_obj_table *tab)
tools/bpf/bpftool/main.h +2 -2
@@ -152,8 +152,8 @@ int cmd_select(const struct cmd *cmds, int argc, char **argv,int get_fd_type (int fd);const char *get_fd_type_name (enum bpf_obj_type type);char *get_fdinfo (int fd,const char *key); -int open_obj_pinned (char *path,bool quiet); -int open_obj_pinned_any (char *path,enum bpf_obj_type exp_type); +int open_obj_pinned (const char *path,bool quiet); +int open_obj_pinned_any (const char *path,enum bpf_obj_type exp_type);int mount_bpffs_for_pin (const char *name);int do_pin_any (int argc,char **argv,int (*get_fd_by_id)(int *,char ***));int do_pin_fd (int fd,const char *name);
Signature · 1 line
2.17.1
Quoted 10 lines · Tony Ambardar
The bpftool sources include code to walk file trees, but use multiple frameworks to do so: nftw and fts. While nftw conforms to POSIX/SUSv3 and is widely available, fts is not conformant and less common, especially on non-glibc systems. The inconsistent framework usage hampers maintenance and portability of bpftool, in particular for embedded systems.
Standardize code usage by rewriting one fts-based function to use nftw and clean up some related function warnings by extending use of "const char *" arguments. This change helps in building bpftool against musl for OpenWrt.
Quoted 5 lines
Also fix an unsafe call to
dirname()by duplicating the string to pass, since some implementations may directly alter it. The same approach is used inlibbpf.c.Signed-off-by Tony Ambardar <[email protected]>
All good for me this time, thank you!
Daniel Borkmann
maintainerQuoted 10 lines · Tony Ambardar
The bpftool sources include code to walk file trees, but use multiple frameworks to do so: nftw and fts. While nftw conforms to POSIX/SUSv3 and is widely available, fts is not conformant and less common, especially on non-glibc systems. The inconsistent framework usage hampers maintenance and portability of bpftool, in particular for embedded systems.
Standardize code usage by rewriting one fts-based function to use nftw and clean up some related function warnings by extending use of "const char *" arguments. This change helps in building bpftool against musl for OpenWrt.
Quoted 5 lines
Also fix an unsafe call to
dirname()by duplicating the string to pass, since some implementations may directly alter it. The same approach is used inlibbpf.c.Signed-off-by Tony Ambardar <[email protected]>
Lgtm, applied, thanks!
Quoted 12 lines · Daniel Borkmann
Quoted 10 lines · Tony Ambardar
The bpftool sources include code to walk file trees, but use multiple frameworks to do so: nftw and fts. While nftw conforms to POSIX/SUSv3 and is widely available, fts is not conformant and less common, especially on non-glibc systems. The inconsistent framework usage hampers maintenance and portability of bpftool, in particular for embedded systems.
Standardize code usage by rewriting one fts-based function to use nftw and clean up some related function warnings by extending use of "const char *" arguments. This change helps in building bpftool against musl for OpenWrt.
Quoted 7 lines
Quoted 5 lines
Also fix an unsafe call to
dirname()by duplicating the string to pass, since some implementations may directly alter it. The same approach is used inlibbpf.c.Signed-off-by Tony Ambardar <[email protected]>Lgtm, applied, thanks!
Thank you, and much appreciation to Quentin for helpful review and feedback.
Best regards,
Tony