first steps in fixing buffer overflow
Subsystems (2)
cover first steps in fixing buffer overflow
This is preliminary work to fix the format overflow issues in EAL and related libraries. The biggest problem area still needing work is all the cases where the created path for <runtime_dir>/XXX could overflow the maximum limit which is only 108 characters due to Unix Domain socket restrictions.
Stephen Hemminger (8):
eal: use C library to parse filesystem table
hash: fix possible ring name overflow
eal: warn if thread name is truncated
eal: avoid format overflow when handling addresses
ethdev: avoid possible overflow in xstat names
efd: avoid overflowing ring name
eal: add check for sysfs path overflow
eal: limit maximum runtime directory and socket paths
lib/eal/common/eal_common_config.c | 6 ++- lib/eal/common/eal_common_memory.c | 2 +- lib/eal/common/eal_common_proc.c | 18 ++++----- lib/eal/common/eal_filesystem.h | 6 ++- lib/eal/linux/eal.c | 6 ++- lib/eal/linux/eal_hugepage_info.c | 64 +++++++++++------------------- lib/efd/rte_efd.c | 20 +++++++++- lib/ethdev/rte_ethdev.c | 27 +++++++++---- lib/hash/rte_cuckoo_hash.c | 33 +++++++++++---- 9 files changed, 110 insertions(+), 72 deletions(-)
Signature · 1 line
2.51.0
RFC 1/8 eal: use C library to parse filesystem table
Rather than doing parsing of /proc/mounts with open coded string handling, use the standard C library routines.
These exist in BSD and Linux.
It also avoids any possible issues with escaped strings etc which the library handles. See getmntent(3) man page.
--- lib/eal/linux/eal_hugepage_info.c | 58 ++++++++++--------------------- 1 file changed, 18 insertions(+), 40 deletions(-)
lib/eal/linux/eal_hugepage_info.c +18 -40
@@ -13,6 +13,7 @@#include <inttypes.h> #include <unistd.h> #include <errno.h> +#include <mntent.h> #include <sys/mman.h> #include <sys/stat.h>
@@ -195,23 +196,13 @@ get_default_hp_size(void)static int get_hugepage_dir (uint64_t hugepage_sz,char *hugedir,int len) { -enum proc_mount_fieldnames { -DEVICE =0 , -MOUNTPT , -FSTYPE , -OPTIONS , - _FIELDNAME_MAX - };static uint64_t default_size =0 ;const char proc_mounts[] ="/proc/mounts" ; -const char hugetlbfs_str[] ="hugetlbfs" ; -const size_t htlbfs_str_len =sizeof (hugetlbfs_str) -1 ;const char pagesize_opt[] ="pagesize=" ;const size_t pagesize_opt_len =sizeof (pagesize_opt) -1 ; -const char split_tok =' ' ; -char *splitstr[_FIELDNAME_MAX];char found[PATH_MAX ] ="" ;char buf[BUFSIZ ]; +struct mntent entry;const struct internal_config *internal_conf =eal_get_internal_configuration (); const size_t hugepage_dir_len = (internal_conf->hugepage_dir != NULL) ?
@@ -226,56 +217,43 @@ get_hugepage_dir(uint64_t hugepage_sz, char *hugedir, int len)return -1 ; } -FILE *fd =fopen (proc_mounts,"r" ); -if (fd ==NULL ) +FILE *mounts =setmntent (proc_mounts,"r" ); +if (mounts ==NULL )rte_panic ("Cannot open %s\n" , proc_mounts);if (default_size ==0 ) default_size =get_default_hp_size (); -while (fgets (buf,sizeof (buf), fd)){ +while (getmntent_r (mounts, &entry, buf,sizeof (buf))) {const char *pagesz_str; -size_t mountpt_len =0 ; - -if (rte_strsplit (buf,sizeof (buf), splitstr, _FIELDNAME_MAX, - split_tok) != _FIELDNAME_MAX) { -EAL_LOG (ERR ,"Error parsing %s" , proc_mounts); -break ;/* return NULL */ - } +uint64_t pagesz = default_size; +size_t mountpt_len; -if (strncmp (splitstr[FSTYPE ], hugetlbfs_str, htlbfs_str_len) !=0 ) +if (strcmp (entry.mnt_type,"hugetlbfs" ) !=0 )continue ; - pagesz_str =strstr (splitstr[OPTIONS ], pagesize_opt); + pagesz_str =strstr (entry.mnt_opts, pagesize_opt); +if (pagesz_str) + pagesz =rte_str_to_size (&pagesz_str[pagesize_opt_len]); -/* if no explicit page size, the default page size is compared */ -if (pagesz_str ==NULL ) { -if (hugepage_sz != default_size) -continue ; - } -/* there is an explicit page size, so check it */ -else { -uint64_t pagesz =rte_str_to_size (&pagesz_str[pagesize_opt_len]); -if (pagesz != hugepage_sz) -continue ; - } +if (pagesz != hugepage_sz) +continue ;/* * If no --huge-dir option has been given, we're done. */ if (internal_conf->hugepage_dir ==NULL ) { -strlcpy (found, splitstr[MOUNTPT ], len); +strlcpy (found, entry.mnt_dir, len);break ; } - mountpt_len =strlen (splitstr[MOUNTPT ]); + mountpt_len =strlen (entry.mnt_dir);/* * Ignore any mount that doesn't contain the --huge-dir directory * or where mount point is not a parent path of --huge-dir */ -if (strncmp (internal_conf->hugepage_dir, splitstr[MOUNTPT ], - mountpt_len) !=0 || +if (strncmp (internal_conf->hugepage_dir, entry.mnt_dir, mountpt_len) !=0 || (hugepage_dir_len > mountpt_len && internal_conf->hugepage_dir[mountpt_len] !='/' )) {continue ;
@@ -286,10 +264,10 @@ get_hugepage_dir(uint64_t hugepage_sz, char *hugedir, int len)* (so /mnt/1 is preferred over /mnt for matching /mnt/1/2)). */ if (mountpt_len >strlen (found)) -strlcpy (found, splitstr[MOUNTPT ], len); +strlcpy (found, entry.mnt_dir, len); }/* end while fgets */ -fclose (fd); +endmntent (mounts);if (found[0 ] !='\0' ) {/* If needed, return the requested dir, not the mount point. */
Signature · 1 line
2.51.0
RFC 2/8 hash: fix possible ring name overflow
In reply to Stephen HemmingerThe maximum possible hash parameter name will cause the generated ring names to overlow in snprintf(). Potentially causing conflicting ring names and trouble.
For reference:
RTE_MEMPOOL_NAMESIZE = 32
RTE_RING_NAMESIZE = 29
RTE_HASH_NAMESIZE = 32
The hash name is concatenated with a prefix like "HT_RCU_" the hash name string needs to be enforced as having space for the resulting string (ie 22).
Since the NAMESIZE's are part of ABI they can't change.
--- lib/hash/rte_cuckoo_hash.c | 33 ++++++++++++++++++++++++++------- 1 file changed, 26 insertions(+), 7 deletions(-)
lib/hash/rte_cuckoo_hash.c +26 -7
@@ -77,6 +77,11 @@ struct __rte_hash_rcu_dq_entry {uint32_t ext_bkt_idx; }; +#define HASH_QSBR_PREFIX "HT_RCU_" +#define HASH_EXT_PREFIX "HT_EXT_" +#define HASH_RING_PREFIX "HT_" + +RTE_EXPORT_SYMBOL (rte_hash_find_existing) struct rte_hash *rte_hash_find_existing (const char *name)
@@ -231,6 +236,20 @@ rte_hash_create(const struct rte_hash_parameters *params)return NULL ; } +/* +* The API for hash allows 32 characters but maximimu length +* would overflow ring name which is limited to 29 characters (RTE_RING_NAMESIZE). +* To avoid breaking ABI, enforce limit of 25 characters on +* the hash table name. +*/ +if (strnlen (params->name,RTE_HASH_NAMESIZE ) + >RTE_RING_NAMESIZE -sizeof (HASH_QSBR_PREFIX )) { + rte_errno =EINVAL ; +HASH_LOG (ERR ,"%s: hash name too long to fit in qsbr ring name" , + __func__); +return NULL ; + } +/* Check extra flags field to check extra options. */ if (params->extra_flag &RTE_HASH_EXTRA_FLAGS_TRANS_MEM_SUPPORT ) hw_trans_mem_support =1 ;
@@ -272,7 +291,7 @@ rte_hash_create(const struct rte_hash_parameters *params)else num_key_slots = params->entries +1 ; -snprintf (ring_name,sizeof (ring_name),"HT_%s" , params->name); +snprintf (ring_name,sizeof (ring_name),HASH_RING_PREFIX "%s" , params->name);/* Create ring (Dummy slot index is not enqueued) */ r =rte_ring_create_elem (ring_name,sizeof (uint32_t ),rte_align32pow2 (num_key_slots), params->socket_id,0 );
@@ -286,8 +305,8 @@ rte_hash_create(const struct rte_hash_parameters *params)/* Create ring for extendable buckets. */ if (ext_table_support) { -snprintf (ext_ring_name,sizeof (ext_ring_name),"HT_EXT_%s" , - params->name); +snprintf (ext_ring_name,sizeof (ext_ring_name), +HASH_EXT_PREFIX "%s" , params->name); r_ext =rte_ring_create_elem (ext_ring_name,sizeof (uint32_t ),rte_align32pow2 (num_buckets +1 ), params->socket_id,0 );
@@ -299,7 +318,7 @@ rte_hash_create(const struct rte_hash_parameters *params) } } -snprintf (hash_name,sizeof (hash_name),"HT_%s" , params->name); +snprintf (hash_name,sizeof (hash_name),HASH_RING_PREFIX "%s" , params->name);rte_mcfg_tailq_write_lock ();
@@ -1582,7 +1601,8 @@ rte_hash_rcu_qsbr_add(struct rte_hash *h, struct rte_hash_rcu_config *cfg)char rcu_dq_name[RTE_RCU_QSBR_DQ_NAMESIZE ];struct rte_hash_rcu_config *hash_rcu_cfg =NULL ; -if (h ==NULL || cfg ==NULL || cfg->v ==NULL ) { +if (h ==NULL || cfg ==NULL || cfg->v ==NULL || +strlen (h->name) >RTE_RCU_QSBR_DQ_NAMESIZE -sizeof (HASH_QSBR_PREFIX )) { rte_errno =EINVAL ;return 1 ; }
@@ -1606,8 +1626,7 @@ rte_hash_rcu_qsbr_add(struct rte_hash *h, struct rte_hash_rcu_config *cfg)/* No other things to do. */ }else if (cfg->mode ==RTE_HASH_QSBR_MODE_DQ ) {/* Init QSBR defer queue. */ -snprintf (rcu_dq_name,sizeof (rcu_dq_name), -"HASH_RCU_%s" , h->name); +snprintf (rcu_dq_name,sizeof (rcu_dq_name),HASH_QSBR_PREFIX "%s" , h->name); params.name = rcu_dq_name; params.size = cfg->dq_size;if (params.size ==0 )
Signature · 1 line
2.51.0
RFC 3/8 eal: warn if thread name is truncated
In reply to Stephen HemmingerThread name is very short 16 characters and therefore the name dpdk-worker-%d will overflow with more than 9999 worker cores. Error should be non-fatal since name only matters for debug.
--- lib/eal/linux/eal.c | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-)
lib/eal/linux/eal.c +4 -2
@@ -863,8 +863,10 @@ rte_eal_init(int argc, char **argv)rte_panic ("Cannot create thread\n" );/* Set thread_name for aid in debugging. */ -snprintf (thread_name,sizeof (thread_name), -"dpdk-worker%d" , i); + ret =snprintf (thread_name,sizeof (thread_name),"dpdk-worker%d" , i); +if (ret >=RTE_THREAD_NAME_SIZE ) +EAL_LOG (INFO ,"Worker thread name %s truncated" , thread_name); +rte_thread_set_name (lcore_config[i].thread_id, thread_name); ret = rte_thread_set_affinity_by_id(lcore_config[i].thread_id,
Signature · 1 line
2.51.0
RFC 4/8 eal: avoid format overflow when handling addresses
In reply to Stephen HemmingerThe largest possible string in this code 0xFFFFFFFFFFFFFFFF which will overflow with only 15 character buffer. Increase to 20.
--- lib/eal/common/eal_common_memory.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
lib/eal/common/eal_common_memory.c +1 -1
@@ -1153,7 +1153,7 @@ rte_eal_memory_init(void)#define EAL_MEMSEG_INFO_REQ "/eal/memseg_info"#define EAL_ELEMENT_LIST_REQ "/eal/mem_element_list"#define EAL_ELEMENT_INFO_REQ "/eal/mem_element_info" -#define ADDR_STR 15 +#define ADDR_STR 20/* 16 bytes 64 bit + 0x */ /* Telemetry callback handler to return heap stats for requested heap id. */
Signature · 1 line
2.51.0
RFC 5/8 ethdev: avoid possible overflow in xstat names
In reply to Stephen HemmingerThe compiler doesn't know that all the elements in the table of queue stats are short enough to avoid overflowing the snprintf. Add a condition that will not happen to warn if it ever does; maybe some day a new long named queue stat could be added.
--- lib/ethdev/rte_ethdev.c | 27 +++++++++++++++++++-------- 1 file changed, 19 insertions(+), 8 deletions(-)
lib/ethdev/rte_ethdev.c +19 -8
@@ -3501,10 +3501,16 @@ eth_basic_stats_get_names(struct rte_eth_dev *dev, num_q =RTE_MIN (dev->data->nb_rx_queues,RTE_ETHDEV_QUEUE_STAT_CNTRS );for (id_queue =0 ; id_queue < num_q; id_queue++) {for (idx =0 ; idx <RTE_NB_RXQ_STATS ; idx++) { -snprintf (xstats_names[cnt_used_entries].name, -sizeof (xstats_names[0 ].name), -"rx_q%u_%s" , - id_queue, eth_dev_rxq_stats_strings[idx].name); +unsigned int cc; + + cc =snprintf (xstats_names[cnt_used_entries].name,sizeof (xstats_names[0 ].name), +"rx_q%u_%s" , + id_queue, eth_dev_rxq_stats_strings[idx].name); + +/* could only happen if a long string was added to eth_dev_rxq_stats_strings */ +if (cc >=sizeof (xstats_names[0 ].name)) +RTE_ETHDEV_LOG_LINE (ERR ,"truncated rxq stat string '%s'" , + eth_dev_rxq_stats_strings[idx].name); cnt_used_entries++; }
@@ -3512,10 +3518,15 @@ eth_basic_stats_get_names(struct rte_eth_dev *dev, num_q =RTE_MIN (dev->data->nb_tx_queues,RTE_ETHDEV_QUEUE_STAT_CNTRS );for (id_queue =0 ; id_queue < num_q; id_queue++) {for (idx =0 ; idx <RTE_NB_TXQ_STATS ; idx++) { -snprintf (xstats_names[cnt_used_entries].name, -sizeof (xstats_names[0 ].name), -"tx_q%u_%s" , - id_queue, eth_dev_txq_stats_strings[idx].name); +unsigned int cc; + + cc =snprintf (xstats_names[cnt_used_entries].name,sizeof (xstats_names[0 ].name), +"tx_q%u_%s" , + id_queue, eth_dev_txq_stats_strings[idx].name); +/* could only happen if a long string was added to eth_dev_rxq_stats_strings */ +if (cc >=sizeof (xstats_names[0 ].name)) +RTE_ETHDEV_LOG_LINE (ERR ,"truncated txq stat string '%s'" , + eth_dev_txq_stats_strings[idx].name); cnt_used_entries++; } }
Signature · 1 line
2.51.0
RFC 6/8 efd: avoid overflowing ring name
In reply to Stephen HemmingerThe efd library allowed table name to be longer than would be safe when prefix was added for a ring name.
--- lib/efd/rte_efd.c | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-)
lib/efd/rte_efd.c +19 -1
@@ -36,6 +36,9 @@ RTE_LOG_REGISTER_DEFAULT(efd_logtype, INFO);#define EFD_LOG (level, ...) \ RTE_LOG_LINE(level, EFD, "" __VA_ARGS__) +/** Prefix used on ring name for hash */ +#define EFD_HASH_PREFIX "HT_" +#define EFD_KEY (key_idx, table) (table->keys + ((key_idx) * table->key_len))/** Hash function used to determine chunk_id and bin_id for a group */ #define EFD_HASH (key, table) \
@@ -527,6 +530,15 @@ rte_efd_create(const char *name, uint32_t max_num_rules, uint32_t key_len,return NULL ; } +/* +* The name is turned into a ring name which has a limit of +* RTE_RING_NAMESIZE. +*/ +if (name ==NULL ||strnlen (name,RTE_RING_NAMESIZE ) >=RTE_RING_NAMESIZE -sizeof (EFD_HASH_PREFIX )) { +EFD_LOG (ERR ,"Invalid name '%s'" , name); +return NULL ; + } +/* * Compute the minimum number of chunks (smallest power of 2) * that can hold all of the rules
@@ -698,7 +710,13 @@ rte_efd_create(const char *name, uint32_t max_num_rules, uint32_t key_len,TAILQ_INSERT_TAIL (efd_list, te, next);rte_mcfg_tailq_write_unlock (); -snprintf (ring_name,sizeof (ring_name),"HT_%s" , table->name); +int cc =snprintf (ring_name,sizeof (ring_name),EFD_HASH_PREFIX "%s" , table->name); +if (cc >=sizeof (ring_name)) { +EFD_LOG (ERR ,"ring name '%s%s' overflow" ,EFD_HASH_PREFIX , table->name); +rte_efd_free (table); +return NULL ; + } +/* Create ring (Dummy slot index is not enqueued) */ r =rte_ring_create (ring_name,rte_align32pow2 (table->max_num_rules), offline_cpu_socket,0 );
Signature · 1 line
2.51.0
RFC 7/8 eal: add check for sysfs path overflow
In reply to Stephen HemmingerIt shouldn't happen but in theory sysfs socket could overflow. Add a check for it.
--- lib/eal/linux/eal_hugepage_info.c | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-)
lib/eal/linux/eal_hugepage_info.c +5 -1
@@ -150,8 +150,12 @@ get_num_hugepages_on_node(const char *subdir, unsigned int socket, size_t sz)return 0 ; } -snprintf (path,sizeof (path),"%s/%s/%s" , +if (snprintf (path,sizeof (path),"%s/%s/%s" , socketpath, subdir, nr_hp_file) >=PATH_MAX ) { +EAL_LOG (NOTICE ,"Socket path %s/%s/%s is truncated" , socketpath, subdir, nr_hp_file); +return 0 ; + } +if (eal_parse_sysfs_value (path, &num_pages) <0 )return 0 ;
Signature · 1 line
2.51.0
RFC 8/8 eal: limit maximum runtime directory and socket paths
In reply to Stephen HemmingerLinux (and FreeBSD) has a limitation of 108 characters for any unix domain socket path. Therefore DPDK would not work if a really large runtime directory was used.
--- lib/eal/common/eal_common_config.c | 6 ++++-- lib/eal/common/eal_common_proc.c | 18 +++++++++--------- lib/eal/common/eal_filesystem.h | 6 +++++- 3 files changed, 18 insertions(+), 12 deletions(-)
lib/eal/common/eal_common_config.c +4 -2
@@ -6,6 +6,7 @@#include <eal_export.h> #include "eal_private.h" +#include "eal_filesystem.h" #include "eal_memcfg.h" /* early configuration structure, when memory config is not mmapped */
@@ -24,7 +25,7 @@ static struct rte_config rte_config = { };/* platform-specific runtime dir */ -static char runtime_dir[PATH_MAX ]; +static char runtime_dir[UNIX_PATH_MAX ];/* internal configuration */ static struct internal_config internal_config;
@@ -39,7 +40,8 @@ rte_eal_get_runtime_dir(void)int eal_set_runtime_dir (const char *run_dir) { -if (strlcpy (runtime_dir, run_dir,PATH_MAX ) >=PATH_MAX ) { +/* runtime directory limited by maximum allowable unix domain socket */ +if (strlcpy (runtime_dir, run_dir,UNIX_PATH_MAX ) >=UNIX_PATH_MAX ) {EAL_LOG (ERR ,"Runtime directory string too long" );return -1 ; }
lib/eal/common/eal_common_proc.c +9 -9
@@ -36,10 +36,10 @@static RTE_ATOMIC (int ) mp_fd =-1 ;static rte_thread_t mp_handle_tid; -static char mp_filter[PATH_MAX ];/* Filter for secondary process sockets */ -static char mp_dir_path[PATH_MAX ];/* The directory path for all mp sockets */ +static char mp_filter[UNIX_PATH_MAX ];/* Filter for secondary process sockets */ +static char mp_dir_path[UNIX_PATH_MAX ];/* The directory path for all mp sockets */ static pthread_mutex_t mp_mutex_action =PTHREAD_MUTEX_INITIALIZER ; -static char peer_name[PATH_MAX ]; +static char peer_name[UNIX_PATH_MAX ];struct action_entry {TAILQ_ENTRY (action_entry) next;
@@ -78,7 +78,7 @@ struct pending_request {REQUEST_TYPE_SYNC , REQUEST_TYPE_ASYNC } type; -char dst[PATH_MAX ]; +char dst[UNIX_PATH_MAX ];struct rte_mp_msg *request;struct rte_mp_msg *reply;int reply_received;
@@ -599,7 +599,7 @@ open_socket_fd(void)static void close_socket_fd (int fd) { -char path[PATH_MAX ]; +char path[UNIX_PATH_MAX ];close (fd);create_socket_path (peer_name, path,sizeof (path));
@@ -609,7 +609,7 @@ close_socket_fd(int fd)int rte_mp_channel_init (void ) { -char path[PATH_MAX ]; +char path[UNIX_PATH_MAX ];int dir_fd;const struct internal_config *internal_conf =eal_get_internal_configuration ();
@@ -779,7 +779,7 @@ mp_send(struct rte_mp_msg *msg, const char *peer, int type) }while ((ent =readdir (mp_dir))) { -char path[PATH_MAX ]; +char path[UNIX_PATH_MAX ];if (fnmatch (mp_filter, ent->d_name,0 ) !=0 )continue ;
@@ -1055,7 +1055,7 @@ rte_mp_request_sync(struct rte_mp_msg *req, struct rte_mp_reply *reply,pthread_mutex_lock (&pending_requests.lock);while ((ent =readdir (mp_dir))) { -char path[PATH_MAX ]; +char path[UNIX_PATH_MAX ];if (fnmatch (mp_filter, ent->d_name,0 ) !=0 )continue ;
@@ -1200,7 +1200,7 @@ rte_mp_request_async(struct rte_mp_msg *req, const struct timespec *ts, }while ((ent =readdir (mp_dir))) { -char path[PATH_MAX ]; +char path[UNIX_PATH_MAX ];if (fnmatch (mp_filter, ent->d_name,0 ) !=0 )continue ;
lib/eal/common/eal_filesystem.h +5 -1
@@ -45,10 +45,14 @@ eal_runtime_config_path(void)/** Path of primary/secondary communication unix socket file. */ #define MP_SOCKET_FNAME "mp_socket" + +/** Maximum length of unix domain socket path as defined in sys/un.h */ +#define UNIX_PATH_MAX 108 +static inline const char *eal_mp_socket_path (void ) { -static char buffer[PATH_MAX ];/* static so auto-zeroed */ +static char buffer[UNIX_PATH_MAX ];/* static so auto-zeroed */ snprintf (buffer,sizeof (buffer),"%s/%s" ,rte_eal_get_runtime_dir (),MP_SOCKET_FNAME );
Signature · 1 line
2.51.0
v2 cover lib: check for string overflow
In reply to Stephen HemmingerFirst draft of changes to fix format overflow issues in EAL and related libraries. This does introduce more restrictions on file prefix and some parameters because of more checking for overflow.
Stephen Hemminger (14):
eal: use C library to parse filesystem table
test: avoid long hash names
lpm: restrict name size
hash: avoid possible ring name overflow
graph: avoid overflowing comment buffer
eal: warn if thread name is truncated
eal: avoid format overflow when handling addresses
ethdev: avoid possible overflow in xstat names
vhost: check for overflow in xstat name
efd: avoid overflowing ring name
eal: add check for sysfs path overflow
eal: limit maximum runtime directory and socket paths
eal: check for hugefile path overflow
lib: enable format overflow warnings
app/test/test_hash.c | 29 +++++++---- lib/eal/common/eal_common_config.c | 6 ++- lib/eal/common/eal_common_memory.c | 2 +- lib/eal/common/eal_common_proc.c | 83 +++++++++++++++++++----------- lib/eal/common/eal_filesystem.h | 16 ++++-- lib/eal/linux/eal.c | 6 ++- lib/eal/linux/eal_hugepage_info.c | 64 +++++++++-------------- lib/eal/linux/eal_memalloc.c | 11 +++- lib/eal/linux/eal_memory.c | 9 +++- lib/efd/rte_efd.c | 15 +++++- lib/ethdev/rte_ethdev.c | 28 +++++++--- lib/graph/graph_pcap.c | 9 ++-- lib/hash/rte_cuckoo_hash.c | 21 +++++--- lib/hash/rte_hash.h | 6 ++- lib/lpm/rte_lpm.h | 2 +- lib/meson.build | 4 -- lib/vhost/vhost.c | 14 +++-- 17 files changed, 202 insertions(+), 123 deletions(-)
Signature · 1 line
2.51.0
RFC v2 1/14 eal: use C library to parse filesystem table
Rather than doing parsing of /proc/mounts with open coded string handling, use the standard C library routines.
These exist in BSD and Linux.
It also avoids any possible issues with escaped strings etc which the library handles. See getmntent(3) man page.
--- lib/eal/linux/eal_hugepage_info.c | 58 ++++++++++--------------------- 1 file changed, 18 insertions(+), 40 deletions(-)
lib/eal/linux/eal_hugepage_info.c +18 -40
@@ -13,6 +13,7 @@#include <inttypes.h> #include <unistd.h> #include <errno.h> +#include <mntent.h> #include <sys/mman.h> #include <sys/stat.h>
@@ -195,23 +196,13 @@ get_default_hp_size(void)static int get_hugepage_dir (uint64_t hugepage_sz,char *hugedir,int len) { -enum proc_mount_fieldnames { -DEVICE =0 , -MOUNTPT , -FSTYPE , -OPTIONS , - _FIELDNAME_MAX - };static uint64_t default_size =0 ;const char proc_mounts[] ="/proc/mounts" ; -const char hugetlbfs_str[] ="hugetlbfs" ; -const size_t htlbfs_str_len =sizeof (hugetlbfs_str) -1 ;const char pagesize_opt[] ="pagesize=" ;const size_t pagesize_opt_len =sizeof (pagesize_opt) -1 ; -const char split_tok =' ' ; -char *splitstr[_FIELDNAME_MAX];char found[PATH_MAX ] ="" ;char buf[BUFSIZ ]; +struct mntent entry;const struct internal_config *internal_conf =eal_get_internal_configuration (); const size_t hugepage_dir_len = (internal_conf->hugepage_dir != NULL) ?
@@ -226,56 +217,43 @@ get_hugepage_dir(uint64_t hugepage_sz, char *hugedir, int len)return -1 ; } -FILE *fd =fopen (proc_mounts,"r" ); -if (fd ==NULL ) +FILE *mounts =setmntent (proc_mounts,"r" ); +if (mounts ==NULL )rte_panic ("Cannot open %s\n" , proc_mounts);if (default_size ==0 ) default_size =get_default_hp_size (); -while (fgets (buf,sizeof (buf), fd)){ +while (getmntent_r (mounts, &entry, buf,sizeof (buf))) {const char *pagesz_str; -size_t mountpt_len =0 ; - -if (rte_strsplit (buf,sizeof (buf), splitstr, _FIELDNAME_MAX, - split_tok) != _FIELDNAME_MAX) { -EAL_LOG (ERR ,"Error parsing %s" , proc_mounts); -break ;/* return NULL */ - } +uint64_t pagesz = default_size; +size_t mountpt_len; -if (strncmp (splitstr[FSTYPE ], hugetlbfs_str, htlbfs_str_len) !=0 ) +if (strcmp (entry.mnt_type,"hugetlbfs" ) !=0 )continue ; - pagesz_str =strstr (splitstr[OPTIONS ], pagesize_opt); + pagesz_str =strstr (entry.mnt_opts, pagesize_opt); +if (pagesz_str) + pagesz =rte_str_to_size (&pagesz_str[pagesize_opt_len]); -/* if no explicit page size, the default page size is compared */ -if (pagesz_str ==NULL ) { -if (hugepage_sz != default_size) -continue ; - } -/* there is an explicit page size, so check it */ -else { -uint64_t pagesz =rte_str_to_size (&pagesz_str[pagesize_opt_len]); -if (pagesz != hugepage_sz) -continue ; - } +if (pagesz != hugepage_sz) +continue ;/* * If no --huge-dir option has been given, we're done. */ if (internal_conf->hugepage_dir ==NULL ) { -strlcpy (found, splitstr[MOUNTPT ], len); +strlcpy (found, entry.mnt_dir, len);break ; } - mountpt_len =strlen (splitstr[MOUNTPT ]); + mountpt_len =strlen (entry.mnt_dir);/* * Ignore any mount that doesn't contain the --huge-dir directory * or where mount point is not a parent path of --huge-dir */ -if (strncmp (internal_conf->hugepage_dir, splitstr[MOUNTPT ], - mountpt_len) !=0 || +if (strncmp (internal_conf->hugepage_dir, entry.mnt_dir, mountpt_len) !=0 || (hugepage_dir_len > mountpt_len && internal_conf->hugepage_dir[mountpt_len] !='/' )) {continue ;
@@ -286,10 +264,10 @@ get_hugepage_dir(uint64_t hugepage_sz, char *hugedir, int len)* (so /mnt/1 is preferred over /mnt for matching /mnt/1/2)). */ if (mountpt_len >strlen (found)) -strlcpy (found, splitstr[MOUNTPT ], len); +strlcpy (found, entry.mnt_dir, len); }/* end while fgets */ -fclose (fd); +endmntent (mounts);if (found[0 ] !='\0' ) {/* If needed, return the requested dir, not the mount point. */
Signature · 1 line
2.51.0
RFC v2 2/14 test: avoid long hash names
In reply to Stephen HemmingerThe test was using hash table names which were too long and would break if the hash library was checking the parameters.
--- app/test/test_hash.c | 29 +++++++++++++++++++---------- 1 file changed, 19 insertions(+), 10 deletions(-)
app/test/test_hash.c +19 -10
@@ -1399,8 +1399,16 @@ static int test_hash_creation_with_bad_parameters(void)return -1 ; } -memcpy (¶ms, &ut_params,sizeof (params)); - params.name ="creation_with_bad_parameters_0" ; + params = ut_params; + params.name ="really_long_name_of_22" ; + handle =rte_hash_create (¶ms); +if (handle !=NULL ) { +rte_hash_free (handle); +printf ("Impossible creating hash successfully with excessively long name\n" ); +return -1 ; + } + + params.name ="with_bad_parameters_0" ; params.entries =RTE_HASH_ENTRIES_MAX +1 ; handle =rte_hash_create (¶ms);if (handle !=NULL ) {
@@ -1410,7 +1418,7 @@ static int test_hash_creation_with_bad_parameters(void) }memcpy (¶ms, &ut_params,sizeof (params)); - params.name ="creation_with_bad_parameters_2" ; + params.name ="with_bad_parameters_2" ; params.entries =BUCKET_ENTRIES -1 ; handle =rte_hash_create (¶ms);if (handle !=NULL ) {
@@ -1420,7 +1428,7 @@ static int test_hash_creation_with_bad_parameters(void) }memcpy (¶ms, &ut_params,sizeof (params)); - params.name ="creation_with_bad_parameters_3" ; + params.name ="with_bad_parameters_3" ; params.key_len =0 ; handle =rte_hash_create (¶ms);if (handle !=NULL ) {
@@ -1430,7 +1438,7 @@ static int test_hash_creation_with_bad_parameters(void) }memcpy (¶ms, &ut_params,sizeof (params)); - params.name ="creation_with_bad_parameters_4" ; + params.name ="with_bad_parameters_4" ; params.socket_id =RTE_MAX_NUMA_NODES +1 ; handle =rte_hash_create (¶ms);if (handle !=NULL ) {
@@ -1510,7 +1518,8 @@ static int test_average_table_utilization(uint32_t ext_table)printf ("Measuring performance, please wait" );fflush (stdout); ut_params.entries =1 <<16 ; - ut_params.name ="test_average_utilization" ; +/* the maximum length of name is 21 characters */ + ut_params.name ="test_avge_utilization" ; ut_params.hash_func = rte_jhash;if (ext_table) ut_params.extra_flag |=RTE_HASH_EXTRA_FLAGS_EXT_TABLE ;
@@ -1898,7 +1907,7 @@ test_hash_rcu_qsbr_add(void)printf ("\n# Running RCU QSBR add tests\n" );memcpy (¶ms, &ut_params,sizeof (params)); - params.name ="test_hash_rcu_qsbr_add" ; + params.name ="test_hash_qsbr_add" ; params.extra_flag =RTE_HASH_EXTRA_FLAGS_RW_CONCURRENCY_LF |RTE_HASH_EXTRA_FLAGS_MULTI_WRITER_ADD ; g_handle =rte_hash_create (¶ms);
@@ -1976,7 +1985,7 @@ test_hash_rcu_qsbr_dq_mode(uint8_t ext_bkt) hash_extra_flag |=RTE_HASH_EXTRA_FLAGS_EXT_TABLE ;struct rte_hash_parameters params_pseudo_hash = { - .name ="test_hash_rcu_qsbr_dq_mode" , + .name ="test_hash_qsbr_mode" , .entries = total_entries, .key_len =sizeof (struct flow_key ), .hash_func = pseudo_hash,
@@ -2146,7 +2155,7 @@ test_hash_rcu_qsbr_sync_mode(uint8_t ext_bkt) hash_extra_flag |=RTE_HASH_EXTRA_FLAGS_EXT_TABLE ;struct rte_hash_parameters params_pseudo_hash = { - .name ="test_hash_rcu_qsbr_sync_mode" , + .name ="test_hash_qsbr_sync" , .entries = total_entries, .key_len =sizeof (struct flow_key ), .hash_func = pseudo_hash,
@@ -2250,7 +2259,7 @@ test_hash_rcu_qsbr_dq_reclaim(void)uint32_t reclaim_keys[8 ] = {10 ,11 ,12 ,13 ,14 ,15 ,16 ,17 };struct rte_hash_rcu_config rcu_cfg = {0 };struct rte_hash_parameters hash_params = { - .name ="test_hash_rcu_qsbr_dq_reclaim" , + .name ="test_qsbr_reclaim" , .entries = total_entries, .key_len =sizeof (uint32_t ), .hash_func =NULL ,
Signature · 1 line
2.51.0
Re: [RFC v2 02/14] test: avoid long hash names
Quoted 22 lines · Stephen Hemminger
The test was using hash table names which were too long and would break if the hash library was checking the parameters.
Fixes af75078fece3 ("first public release")Fixes 9c7d8eed1a45 ("test/hash: add RCU tests")Fixes 567bb951716f ("hash: reclaim RCU defer queue")Signed-off-by Stephen Hemminger <[email protected]>--- app/test/test_hash.c | 29 +++++++++++++++++++---------- 1 file changed, 19 insertions(+), 10 deletions(-)app/test/test_hash.c +0
-1@@ -1399,8 +1399,16 @@ static int test_hash_creation_with_bad_parameters(void)return -1 ; } -memcpy (¶ms, &ut_params,sizeof (params));
app/test/test_hash.c static int test_hash_creation_with_bad_parameters(void) · line 1410
Quoted 10 lines
app/test/test_hash.c +9
-1- params.name ="creation_with_bad_parameters_0" ; + params = ut_params; + params.name ="really_long_name_of_22" ; + handle =rte_hash_create (¶ms); +if (handle !=NULL ) { +rte_hash_free (handle); +printf ("Impossible creating hash successfully with excessively long name\n" ); +return -1 ; + } +
I'm not sure about this behaviour, for something like the hash name. I'd tend more towards having the hash library just truncate the name rather than returning an error if it was too long.
Also, I worry that this could break end-applications which were relying on previous behaviour of ignoring long names.
What do you/others think?
/Bruce
Re: [RFC v2 02/14] test: avoid long hash names
Quoted 38 lines · On Fri, 5 Dec 2025 08:29:39 +0000 Bruce Richardson…
Quoted 22 lines · Stephen Hemminger
The test was using hash table names which were too long and would break if the hash library was checking the parameters.
Fixes af75078fece3 ("first public release")Fixes 9c7d8eed1a45 ("test/hash: add RCU tests")Fixes 567bb951716f ("hash: reclaim RCU defer queue")Signed-off-by Stephen Hemminger <[email protected]>--- app/test/test_hash.c | 29 +++++++++++++++++++---------- 1 file changed, 19 insertions(+), 10 deletions(-)app/test/test_hash.c +0
-1@@ -1399,8 +1399,16 @@ static int test_hash_creation_with_bad_parameters(void)return -1 ; } -memcpy (¶ms, &ut_params,sizeof (params));app/test/test_hash.c static int test_hash_creation_with_bad_parameters(void) · line 1410
Quoted 10 lines
app/test/test_hash.c +9
-1- params.name ="creation_with_bad_parameters_0" ; + params = ut_params; + params.name ="really_long_name_of_22" ; + handle =rte_hash_create (¶ms); +if (handle !=NULL ) { +rte_hash_free (handle); +printf ("Impossible creating hash successfully with excessively long name\n" ); +return -1 ; + } +I'm not sure about this behaviour, for something like the hash name. I'd tend more towards having the hash library just truncate the name rather than returning an error if it was too long.
Quoted 4 lines
Also, I worry that this could break end-applications which were relying on previous behaviour of ignoring long names.
What do you/others think?
Truncating the name could create issues where two hashes end up sharing a ring underneath.
Re: [RFC v2 02/14] test: avoid long hash names
Quoted 41 lines · Stephen Hemminger
Quoted 38 lines · On Fri, 5 Dec 2025 08:29:39 +0000 Bruce Richardson…
Quoted 22 lines · Stephen Hemminger
The test was using hash table names which were too long and would break if the hash library was checking the parameters.
Fixes af75078fece3 ("first public release")Fixes 9c7d8eed1a45 ("test/hash: add RCU tests")Fixes 567bb951716f ("hash: reclaim RCU defer queue")Signed-off-by Stephen Hemminger <[email protected]>--- app/test/test_hash.c | 29 +++++++++++++++++++---------- 1 file changed, 19 insertions(+), 10 deletions(-)app/test/test_hash.c +0
-1@@ -1399,8 +1399,16 @@ static int test_hash_creation_with_bad_parameters(void)return -1 ; } -memcpy (¶ms, &ut_params,sizeof (params));app/test/test_hash.c static int test_hash_creation_with_bad_parameters(void) · line 1410
Quoted 10 lines
app/test/test_hash.c +9
-1- params.name ="creation_with_bad_parameters_0" ; + params = ut_params; + params.name ="really_long_name_of_22" ; + handle =rte_hash_create (¶ms); +if (handle !=NULL ) { +rte_hash_free (handle); +printf ("Impossible creating hash successfully with excessively long name\n" ); +return -1 ; + } +I'm not sure about this behaviour, for something like the hash name. I'd tend more towards having the hash library just truncate the name rather than returning an error if it was too long.
Quoted 8 lines
Quoted 4 lines
Also, I worry that this could break end-applications which were relying on previous behaviour of ignoring long names.
What do you/others think?
Truncating the name could create issues where two hashes end up sharing a ring underneath.
Yes, I realise that. However, we have been silently truncating for years without reported issues, therefore I think it is safer to go from "silently truncating" to "noisily truncating", rather than jumping straight to "failing the API".
RFC v2 3/14 lpm: restrict name size
In reply to Stephen HemmingerSince LPM uses ring internally with a prefix, limit the maximum allowed LPM name.
--- lib/lpm/rte_lpm.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
lib/lpm/rte_lpm.h +1 -1
@@ -26,7 +26,7 @@ extern "C" {#endif /** Max number of characters in LPM name. */ -#define RTE_LPM_NAMESIZE 32 +#define RTE_LPM_NAMESIZE (RTE_RING_NAMESIZE - sizeof("LPM_RCU_") + 1)/** Maximum depth value possible for IPv4 LPM. */ #define RTE_LPM_MAX_DEPTH 32
Signature · 1 line
2.51.0
RFC v2 4/14 hash: avoid possible ring name overflow
In reply to Stephen HemmingerThe maximum possible hash parameter name will cause the generated ring names to overflow in snprintf(). Potentially causing conflicting ring names and duplicate rings.
For reference:
RTE_MEMPOOL_NAMESIZE = 32
RTE_RING_NAMESIZE = 29
RTE_HASH_NAMESIZE = 32
This version changes RTE_HASH_NAMESIZE since not hardcoded into any ABI.
--- lib/hash/rte_cuckoo_hash.c | 21 +++++++++++++++------ lib/hash/rte_hash.h | 6 ++++-- 2 files changed, 19 insertions(+), 8 deletions(-)
lib/hash/rte_cuckoo_hash.c +15 -6
@@ -77,6 +77,10 @@ struct __rte_hash_rcu_dq_entry {uint32_t ext_bkt_idx; }; +#define HASH_QSBR_PREFIX "HT_RCU_" +#define HASH_EXT_PREFIX "HT_EXT_" +#define HASH_RING_PREFIX "HT_" +RTE_EXPORT_SYMBOL (rte_hash_find_existing) struct rte_hash *rte_hash_find_existing (const char *name)
@@ -222,6 +226,12 @@ rte_hash_create(const struct rte_hash_parameters *params)return NULL ; } +if (strnlen (params->name,RTE_HASH_NAMESIZE ) >=RTE_HASH_NAMESIZE ) { + rte_errno =ENAMETOOLONG ; +HASH_LOG (ERR ,"%s(): name '%s' too long" , __func__, params->name); +return NULL ; + } +/* Validate correct usage of extra options */ if ((params->extra_flag &RTE_HASH_EXTRA_FLAGS_RW_CONCURRENCY ) && (params->extra_flag &RTE_HASH_EXTRA_FLAGS_RW_CONCURRENCY_LF )) {
@@ -272,7 +282,7 @@ rte_hash_create(const struct rte_hash_parameters *params)else num_key_slots = params->entries +1 ; -snprintf (ring_name,sizeof (ring_name),"HT_%s" , params->name); +snprintf (ring_name,sizeof (ring_name),HASH_RING_PREFIX "%s" , params->name);/* Create ring (Dummy slot index is not enqueued) */ r =rte_ring_create_elem (ring_name,sizeof (uint32_t ),rte_align32pow2 (num_key_slots), params->socket_id,0 );
@@ -286,8 +296,8 @@ rte_hash_create(const struct rte_hash_parameters *params)/* Create ring for extendable buckets. */ if (ext_table_support) { -snprintf (ext_ring_name,sizeof (ext_ring_name),"HT_EXT_%s" , - params->name); +snprintf (ext_ring_name,sizeof (ext_ring_name), +HASH_EXT_PREFIX "%s" , params->name); r_ext =rte_ring_create_elem (ext_ring_name,sizeof (uint32_t ),rte_align32pow2 (num_buckets +1 ), params->socket_id,0 );
@@ -299,7 +309,7 @@ rte_hash_create(const struct rte_hash_parameters *params) } } -snprintf (hash_name,sizeof (hash_name),"HT_%s" , params->name); +snprintf (hash_name,sizeof (hash_name),HASH_RING_PREFIX "%s" , params->name);rte_mcfg_tailq_write_lock ();
@@ -1606,8 +1616,7 @@ rte_hash_rcu_qsbr_add(struct rte_hash *h, struct rte_hash_rcu_config *cfg)/* No other things to do. */ }else if (cfg->mode ==RTE_HASH_QSBR_MODE_DQ ) {/* Init QSBR defer queue. */ -snprintf (rcu_dq_name,sizeof (rcu_dq_name), -"HASH_RCU_%s" , h->name); +snprintf (rcu_dq_name,sizeof (rcu_dq_name),HASH_QSBR_PREFIX "%s" , h->name); params.name = rcu_dq_name; params.size = cfg->dq_size;if (params.size ==0 )
lib/hash/rte_hash.h +4 -2
@@ -24,8 +24,10 @@ extern "C" {/** Maximum size of hash table that can be created. */ #define RTE_HASH_ENTRIES_MAX (1 << 30) -/** Maximum number of characters in hash name.*/ -#define RTE_HASH_NAMESIZE 32 +/** Maximum number of characters in hash name. +* Limited by ring name (used internally) with prefix. +*/ +#define RTE_HASH_NAMESIZE (RTE_RING_NAMESIZE - sizeof("HT_EXT_") + 1)/** Maximum number of keys that can be searched for using rte_hash_lookup_bulk. */ #define RTE_HASH_LOOKUP_BULK_MAX 64
Signature · 1 line
2.51.0
RFC v2 5/14 graph: avoid overflowing comment buffer
In reply to Stephen HemmingerThe library builds a pcapng comment to put on each packet but the buffer is not big enough for the largest possible graph node name, etc. Change to use asprintf() to allow any string length. Note, if asprintf() fails it is better to still log the packet without comment so no data is lost.
--- lib/graph/graph_pcap.c | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-)
lib/graph/graph_pcap.c +6 -3
@@ -194,7 +194,7 @@ graph_pcap_dispatch(struct rte_graph *graph, uint16_t nb_objs) {struct rte_mbuf *mbuf_clones[RTE_GRAPH_BURST_SIZE ]; -char buffer[GRAPH_PCAP_BUF_SZ ]; +char *comment =NULL ;uint64_t i, num_packets;struct rte_mbuf *mbuf;ssize_t len;
@@ -207,19 +207,22 @@ graph_pcap_dispatch(struct rte_graph *graph,if (num_packets > nb_objs) num_packets = nb_objs; -snprintf (buffer,GRAPH_PCAP_BUF_SZ ,"%s: %s" , graph->name, node->name); +/* put a comment on all these packets */ +if (asprintf (&comment,"%s: %s" , graph->name, node->name) <0 ) +graph_err ("asprintf for comment failed." );for (i =0 ; i < num_packets; i++) {struct rte_mbuf *mc; mbuf = (struct rte_mbuf *)objs[i]; mc =rte_pcapng_copy (mbuf->port,0 , mbuf, pkt_mp, mbuf->pkt_len, -0 , buffer); +0 , comment);if (mc ==NULL )break ; mbuf_clones[i] = mc; } +free (comment);/* write it to capture file */ len =rte_pcapng_write_packets (pcapng_fd, mbuf_clones, i);
Signature · 1 line
2.51.0
RFC v2 6/14 eal: warn if thread name is truncated
In reply to Stephen HemmingerThread name is very short 16 characters and therefore the name dpdk-worker-%d will overflow with more than 9999 worker cores. Error should be non-fatal since name only matters for debug.
--- lib/eal/linux/eal.c | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-)
lib/eal/linux/eal.c +4 -2
@@ -863,8 +863,10 @@ rte_eal_init(int argc, char **argv)rte_panic ("Cannot create thread\n" );/* Set thread_name for aid in debugging. */ -snprintf (thread_name,sizeof (thread_name), -"dpdk-worker%d" , i); + ret =snprintf (thread_name,sizeof (thread_name),"dpdk-worker%d" , i); +if (ret >=RTE_THREAD_NAME_SIZE ) +EAL_LOG (INFO ,"Worker thread name %s truncated" , thread_name); +rte_thread_set_name (lcore_config[i].thread_id, thread_name); ret = rte_thread_set_affinity_by_id(lcore_config[i].thread_id,
Signature · 1 line
2.51.0
Re: [RFC v2 06/14] eal: warn if thread name is truncated
Quoted 6 lines · Stephen Hemminger
Thread name is very short 16 characters and therefore the name dpdk-worker-%d will overflow with more than 9999 worker cores. Error should be non-fatal since name only matters for debug.
Signed-off-by Stephen Hemminger <[email protected]>---
Can't see this issue being hit any time soon, but no harm.
Quoted 23 lines
lib/eal/linux/eal.c | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-)lib/eal/linux/eal.c +4
-2@@ -863,8 +863,10 @@ rte_eal_init(int argc, char **argv)rte_panic ("Cannot create thread\n" );/* Set thread_name for aid in debugging. */ -snprintf (thread_name,sizeof (thread_name), -"dpdk-worker%d" , i); + ret =snprintf (thread_name,sizeof (thread_name),"dpdk-worker%d" , i); +if (ret >=RTE_THREAD_NAME_SIZE ) +EAL_LOG (INFO ,"Worker thread name %s truncated" , thread_name); +rte_thread_set_name (lcore_config[i].thread_id, thread_name); ret = rte_thread_set_affinity_by_id(lcore_config[i].thread_id,Signature · 1 line
2.51.0
RFC v2 7/14 eal: avoid format overflow when handling addresses
In reply to Stephen HemmingerThe largest possible string in this code 0xFFFFFFFFFFFFFFFF which will overflow with only 15 character buffer. Increase to 20.
--- lib/eal/common/eal_common_memory.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
lib/eal/common/eal_common_memory.c +1 -1
@@ -1153,7 +1153,7 @@ rte_eal_memory_init(void)#define EAL_MEMSEG_INFO_REQ "/eal/memseg_info"#define EAL_ELEMENT_LIST_REQ "/eal/mem_element_list"#define EAL_ELEMENT_INFO_REQ "/eal/mem_element_info" -#define ADDR_STR 15 +#define ADDR_STR 20/* 16 bytes 64 bit + 0x */ /* Telemetry callback handler to return heap stats for requested heap id. */
Signature · 1 line
2.51.0
RFC v2 8/14 ethdev: avoid possible overflow in xstat names
In reply to Stephen HemmingerThe compiler doesn't know that all the elements in the table of queue stats are short enough to avoid overflowing the snprintf. Add a condition that will not happen to warn if it ever does; maybe some day a new long named queue stat could be added.
--- lib/ethdev/rte_ethdev.c | 28 ++++++++++++++++++++-------- 1 file changed, 20 insertions(+), 8 deletions(-)
lib/ethdev/rte_ethdev.c +20 -8
@@ -3501,10 +3501,17 @@ eth_basic_stats_get_names(struct rte_eth_dev *dev, num_q =RTE_MIN (dev->data->nb_rx_queues,RTE_ETHDEV_QUEUE_STAT_CNTRS );for (id_queue =0 ; id_queue < num_q; id_queue++) {for (idx =0 ; idx <RTE_NB_RXQ_STATS ; idx++) { -snprintf (xstats_names[cnt_used_entries].name, -sizeof (xstats_names[0 ].name), -"rx_q%u_%s" , - id_queue, eth_dev_rxq_stats_strings[idx].name); +unsigned int cc; + + cc =snprintf (xstats_names[cnt_used_entries].name, +sizeof (xstats_names[0 ].name), +"rx_q%u_%s" , + id_queue, eth_dev_rxq_stats_strings[idx].name); + +/* could only happen if a long string was added */ +if (cc >=sizeof (xstats_names[0 ].name)) +RTE_ETHDEV_LOG_LINE (ERR ,"truncated rxq stat string '%s'" , + eth_dev_rxq_stats_strings[idx].name); cnt_used_entries++; }
@@ -3512,10 +3519,15 @@ eth_basic_stats_get_names(struct rte_eth_dev *dev, num_q =RTE_MIN (dev->data->nb_tx_queues,RTE_ETHDEV_QUEUE_STAT_CNTRS );for (id_queue =0 ; id_queue < num_q; id_queue++) {for (idx =0 ; idx <RTE_NB_TXQ_STATS ; idx++) { -snprintf (xstats_names[cnt_used_entries].name, -sizeof (xstats_names[0 ].name), -"tx_q%u_%s" , - id_queue, eth_dev_txq_stats_strings[idx].name); +unsigned int cc; + + cc =snprintf (xstats_names[cnt_used_entries].name, +sizeof (xstats_names[0 ].name), +"tx_q%u_%s" , + id_queue, eth_dev_txq_stats_strings[idx].name); +if (cc >=sizeof (xstats_names[0 ].name)) +RTE_ETHDEV_LOG_LINE (ERR ,"truncated txq stat string '%s'" , + eth_dev_txq_stats_strings[idx].name); cnt_used_entries++; } }
Signature · 1 line
2.51.0
Re: [RFC v2 08/14] ethdev: avoid possible overflow in xstat names
Quoted 9 lines · Stephen Hemminger
The compiler doesn't know that all the elements in the table of queue stats are short enough to avoid overflowing the snprintf. Add a condition that will not happen to warn if it ever does; maybe some day a new long named queue stat could be added.
Signed-off-by Stephen Hemminger <[email protected]>--- lib/ethdev/rte_ethdev.c | 28 ++++++++++++++++++++-------- 1 file changed, 20 insertions(+), 8 deletions(-)
Quoted 50 lines
lib/ethdev/rte_ethdev.c +20
-8@@ -3501,10 +3501,17 @@ eth_basic_stats_get_names(struct rte_eth_dev *dev, num_q =RTE_MIN (dev->data->nb_rx_queues,RTE_ETHDEV_QUEUE_STAT_CNTRS );for (id_queue =0 ; id_queue < num_q; id_queue++) {for (idx =0 ; idx <RTE_NB_RXQ_STATS ; idx++) { -snprintf (xstats_names[cnt_used_entries].name, -sizeof (xstats_names[0 ].name), -"rx_q%u_%s" , - id_queue, eth_dev_rxq_stats_strings[idx].name); +unsigned int cc; + + cc =snprintf (xstats_names[cnt_used_entries].name, +sizeof (xstats_names[0 ].name), +"rx_q%u_%s" , + id_queue, eth_dev_rxq_stats_strings[idx].name); + +/* could only happen if a long string was added */ +if (cc >=sizeof (xstats_names[0 ].name)) +RTE_ETHDEV_LOG_LINE (ERR ,"truncated rxq stat string '%s'" , + eth_dev_rxq_stats_strings[idx].name); cnt_used_entries++; }@@ -3512,10 +3519,15 @@ eth_basic_stats_get_names(struct rte_eth_dev *dev, num_q =RTE_MIN (dev->data->nb_tx_queues,RTE_ETHDEV_QUEUE_STAT_CNTRS );for (id_queue =0 ; id_queue < num_q; id_queue++) {for (idx =0 ; idx <RTE_NB_TXQ_STATS ; idx++) { -snprintf (xstats_names[cnt_used_entries].name, -sizeof (xstats_names[0 ].name), -"tx_q%u_%s" , - id_queue, eth_dev_txq_stats_strings[idx].name); +unsigned int cc; + + cc =snprintf (xstats_names[cnt_used_entries].name, +sizeof (xstats_names[0 ].name), +"tx_q%u_%s" , + id_queue, eth_dev_txq_stats_strings[idx].name); +if (cc >=sizeof (xstats_names[0 ].name)) +RTE_ETHDEV_LOG_LINE (ERR ,"truncated txq stat string '%s'" , + eth_dev_txq_stats_strings[idx].name); cnt_used_entries++; } }Signature · 1 line
2.51.0
RFC v2 9/14 vhost: check for overflow in xstat name
In reply to Stephen HemmingerThe snprintf to format an xstat name could overflow if called with a long rte_vhost_stat_name. Check if that happens and warn.
--- lib/vhost/vhost.c | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-)
lib/vhost/vhost.c +10 -4
@@ -2200,6 +2200,7 @@ rte_vhost_vring_stats_get_names(int vid, uint16_t queue_id, {struct virtio_net *dev =get_device (vid);unsigned int i; +int ret;if (dev ==NULL )return -1 ;
@@ -2213,10 +2214,15 @@ rte_vhost_vring_stats_get_names(int vid, uint16_t queue_id,if (name ==NULL || size <VHOST_NB_VQ_STATS )return VHOST_NB_VQ_STATS ; -for (i =0 ; i <VHOST_NB_VQ_STATS ; i++) -snprintf (name[i].name,sizeof (name[i].name),"%s_q%u_%s" , - (queue_id &1 ) ?"rx" :"tx" , - queue_id /2 , vhost_vq_stat_strings[i].name); +for (i =0 ; i <VHOST_NB_VQ_STATS ; i++) { + ret =snprintf (name[i].name,sizeof (name[i].name),"%s_q%u_%s" , + (queue_id &1 ) ?"rx" :"tx" , + queue_id /2 , vhost_vq_stat_strings[i].name); +if (ret >= (int )sizeof (name[0 ].name)) +VHOST_CONFIG_LOG ("device" ,NOTICE ,"truncated xstat '%s_q%u_%s'" , + (queue_id &1 ) ?"rx" :"tx" , + queue_id /2 , vhost_vq_stat_strings[i].name); + }return VHOST_NB_VQ_STATS ; }
Signature · 1 line
2.51.0
RFC v2 10/14 efd: avoid overflowing ring name
In reply to Stephen HemmingerThe efd library allowed table name to be longer than would be safe when prefix was added for a ring name.
--- lib/efd/rte_efd.c | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-)
lib/efd/rte_efd.c +14 -1
@@ -36,6 +36,9 @@ RTE_LOG_REGISTER_DEFAULT(efd_logtype, INFO);#define EFD_LOG (level, ...) \ RTE_LOG_LINE(level, EFD, "" __VA_ARGS__) +/** Prefix used on ring name for hash */ +#define EFD_HASH_PREFIX "HT_" +#define EFD_KEY (key_idx, table) (table->keys + ((key_idx) * table->key_len))/** Hash function used to determine chunk_id and bin_id for a group */ #define EFD_HASH (key, table) \
@@ -527,6 +530,17 @@ rte_efd_create(const char *name, uint32_t max_num_rules, uint32_t key_len,return NULL ; } +if (name ==NULL ) { +EFD_LOG (ERR ,"Invalid name '%s'" , name); +return NULL ; + } + +if (snprintf (ring_name,sizeof (ring_name), +EFD_HASH_PREFIX "%s" , name) >= (int )sizeof (ring_name)) { +EFD_LOG (ERR ,"ring name '%s%s' overflow" ,EFD_HASH_PREFIX , table->name); +return NULL ; + } +/* * Compute the minimum number of chunks (smallest power of 2) * that can hold all of the rules
@@ -698,7 +712,6 @@ rte_efd_create(const char *name, uint32_t max_num_rules, uint32_t key_len,TAILQ_INSERT_TAIL (efd_list, te, next);rte_mcfg_tailq_write_unlock (); -snprintf (ring_name,sizeof (ring_name),"HT_%s" , table->name);/* Create ring (Dummy slot index is not enqueued) */ r =rte_ring_create (ring_name,rte_align32pow2 (table->max_num_rules), offline_cpu_socket,0 );
Signature · 1 line
2.51.0
Re: [RFC v2 10/14] efd: avoid overflowing ring name
Quoted 8 lines · Stephen Hemminger
The efd library allowed table name to be longer than would be safe when prefix was added for a ring name.
Signed-off-by Stephen Hemminger <[email protected]>--- lib/efd/rte_efd.c | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-)
Again, not convinced that truncating is a problem here, if we document that only N characters of the name are preserved. We can warn and continue rather than returning error.
/Bruce
Quoted 43 lines
lib/efd/rte_efd.c +14
-1@@ -36,6 +36,9 @@ RTE_LOG_REGISTER_DEFAULT(efd_logtype, INFO);#define EFD_LOG (level, ...) \ RTE_LOG_LINE(level, EFD, "" __VA_ARGS__) +/** Prefix used on ring name for hash */ +#define EFD_HASH_PREFIX "HT_" +#define EFD_KEY (key_idx, table) (table->keys + ((key_idx) * table->key_len))/** Hash function used to determine chunk_id and bin_id for a group */ #define EFD_HASH (key, table) \@@ -527,6 +530,17 @@ rte_efd_create(const char *name, uint32_t max_num_rules, uint32_t key_len,return NULL ; } +if (name ==NULL ) { +EFD_LOG (ERR ,"Invalid name '%s'" , name); +return NULL ; + } + +if (snprintf (ring_name,sizeof (ring_name), +EFD_HASH_PREFIX "%s" , name) >= (int )sizeof (ring_name)) { +EFD_LOG (ERR ,"ring name '%s%s' overflow" ,EFD_HASH_PREFIX , table->name); +return NULL ; + } +/* * Compute the minimum number of chunks (smallest power of 2) * that can hold all of the rules @@ -698,7 +712,6 @@ rte_efd_create(const char *name, uint32_t max_num_rules, uint32_t key_len,TAILQ_INSERT_TAIL (efd_list, te, next);rte_mcfg_tailq_write_unlock (); -snprintf (ring_name,sizeof (ring_name),"HT_%s" , table->name);/* Create ring (Dummy slot index is not enqueued) */ r =rte_ring_create (ring_name,rte_align32pow2 (table->max_num_rules), offline_cpu_socket,0 );Signature · 1 line
2.51.0
RFC v2 11/14 eal: add check for sysfs path overflow
In reply to Stephen HemmingerShouldn't happen but in theory sysfs socket could overflow. Add a check for it.
--- lib/eal/linux/eal_hugepage_info.c | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-)
lib/eal/linux/eal_hugepage_info.c +5 -1
@@ -150,8 +150,12 @@ get_num_hugepages_on_node(const char *subdir, unsigned int socket, size_t sz)return 0 ; } -snprintf (path,sizeof (path),"%s/%s/%s" , +if (snprintf (path,sizeof (path),"%s/%s/%s" , socketpath, subdir, nr_hp_file) >=PATH_MAX ) { +EAL_LOG (NOTICE ,"Socket path %s/%s/%s is truncated" , socketpath, subdir, nr_hp_file); +return 0 ; + } +if (eal_parse_sysfs_value (path, &num_pages) <0 )return 0 ;
Signature · 1 line
2.51.0
RFC v2 12/14 eal: limit maximum runtime directory and socket paths
In reply to Stephen HemmingerLinux (and FreeBSD) has a limitation of 108 characters for any unix domain socket path. Therefore DPDK would not work if a really large runtime directory was used.
--- lib/eal/common/eal_common_config.c | 6 ++- lib/eal/common/eal_common_proc.c | 83 +++++++++++++++++++----------- lib/eal/common/eal_filesystem.h | 6 ++- 3 files changed, 63 insertions(+), 32 deletions(-)
lib/eal/common/eal_common_config.c +4 -2
@@ -6,6 +6,7 @@#include <eal_export.h> #include "eal_private.h" +#include "eal_filesystem.h" #include "eal_memcfg.h" /* early configuration structure, when memory config is not mmapped */
@@ -24,7 +25,7 @@ static struct rte_config rte_config = { };/* platform-specific runtime dir */ -static char runtime_dir[PATH_MAX ]; +static char runtime_dir[UNIX_PATH_MAX ];/* internal configuration */ static struct internal_config internal_config;
@@ -39,7 +40,8 @@ rte_eal_get_runtime_dir(void)int eal_set_runtime_dir (const char *run_dir) { -if (strlcpy (runtime_dir, run_dir,PATH_MAX ) >=PATH_MAX ) { +/* runtime directory limited by maximum allowable unix domain socket */ +if (strlcpy (runtime_dir, run_dir,UNIX_PATH_MAX ) >=UNIX_PATH_MAX ) {EAL_LOG (ERR ,"Runtime directory string too long" );return -1 ; }
lib/eal/common/eal_common_proc.c +54 -29
166 lines not on this page · raw message
lib/eal/common/eal_filesystem.h +5 -1
@@ -45,10 +45,14 @@ eal_runtime_config_path(void)/** Path of primary/secondary communication unix socket file. */ #define MP_SOCKET_FNAME "mp_socket" + +/** Maximum length of unix domain socket path as defined in sys/un.h */ +#define UNIX_PATH_MAX 108 +static inline const char *eal_mp_socket_path (void ) { -static char buffer[PATH_MAX ];/* static so auto-zeroed */ +static char buffer[UNIX_PATH_MAX ];/* static so auto-zeroed */ snprintf (buffer,sizeof (buffer),"%s/%s" ,rte_eal_get_runtime_dir (),MP_SOCKET_FNAME );
Signature · 1 line
2.51.0
Re: [RFC v2 12/14] eal: limit maximum runtime directory and socket paths
Quoted 4 lines · Stephen Hemminger
Linux (and FreeBSD) has a limitation of 108 characters for any unix domain socket path. Therefore DPDK would not work if a really large runtime directory was used.
FreeBSD actually limits it to 104 [1]. Should reduce the define by that extra amount.
/Bruce
[1] https://man.freebsd.org/cgi/man.cgi?query=unix&sektion=4
Quoted 7 lines
Signed-off-by Stephen Hemminger <[email protected]>--- lib/eal/common/eal_common_config.c | 6 ++- lib/eal/common/eal_common_proc.c | 83 +++++++++++++++++++----------- lib/eal/common/eal_filesystem.h | 6 ++- 3 files changed, 63 insertions(+), 32 deletions(-)
RFC v2 13/14 eal: check for hugefile path overflow
In reply to Stephen HemmingerWhen constructing huge filename path, check for possible overflow of PATH_MAX.
--- lib/eal/common/eal_filesystem.h | 10 ++++++---- lib/eal/linux/eal_memalloc.c | 11 +++++++++-- lib/eal/linux/eal_memory.c | 9 +++++++-- 3 files changed, 22 insertions(+), 8 deletions(-)
lib/eal/common/eal_filesystem.h +6 -4
@@ -93,12 +93,14 @@ eal_hugepage_data_path(void)/** String format for hugepage map files. */ #define HUGEFILE_FMT "%s/%smap_%d" -static inline const char * +static inline __rte_warn_unused_result const char *eal_get_hugefile_path (char *buffer,size_t buflen,const char *hugedir,int f_id) { -snprintf (buffer, buflen,HUGEFILE_FMT , hugedir, -eal_get_hugefile_prefix (), f_id); -return buffer; +if (snprintf (buffer, buflen,HUGEFILE_FMT , hugedir, +eal_get_hugefile_prefix (), f_id) >= (int )buflen) +return NULL ; +else +return buffer; }/** define the default filename prefix for the %s values above */
lib/eal/linux/eal_memalloc.c +9 -2
@@ -260,6 +260,7 @@ get_seg_fd(char *path, int buflen, struct hugepage_info *hi, {int fd;int *out_fd; +const char *huge_path;struct stat st;int ret; const struct internal_config *internal_conf =
@@ -276,12 +277,18 @@ get_seg_fd(char *path, int buflen, struct hugepage_info *hi,if (internal_conf->single_file_segments) { out_fd = &fd_list[list_idx].memseg_list_fd; -eal_get_hugefile_path (path, buflen, hi->hugedir, list_idx); + huge_path =eal_get_hugefile_path (path, buflen, hi->hugedir, list_idx); }else { out_fd = &fd_list[list_idx].fds[seg_idx]; -eal_get_hugefile_path (path, buflen, hi->hugedir, + huge_path =eal_get_hugefile_path (path, buflen, hi->hugedir, list_idx *RTE_MAX_MEMSEG_PER_LIST + seg_idx); } +if (huge_path ==NULL ) { +EAL_LOG (DEBUG ,"%s(): hugefile path truncated: '%s'" , + __func__, path); +return -1 ; + } + fd = *out_fd;if (fd >=0 )return fd;
lib/eal/linux/eal_memory.c +7 -2
@@ -337,8 +337,13 @@ map_all_hugepages(struct hugepage_file *hugepg_tbl, struct hugepage_info *hpi, hf->file_id = i; hf->size = hugepage_sz; -eal_get_hugefile_path (hf->filepath,sizeof (hf->filepath), - hpi->hugedir, hf->file_id); +if (eal_get_hugefile_path (hf->filepath,sizeof (hf->filepath), + hpi->hugedir, hf->file_id) ==NULL ) { +EAL_LOG (DEBUG ,"%s(): huge file path '%s' truncated" , + __func__, hf->filepath); + goto out; + } + hf->filepath[sizeof (hf->filepath) -1 ] ='\0' ;/* try to create hugepage file */
Signature · 1 line
2.51.0
RFC v2 14/14 lib: enable format overflow warnings
In reply to Stephen HemmingerEnable compiler checking of format overflow
--- lib/meson.build | 4 ---- 1 file changed, 4 deletions(-)
lib/meson.build +0 -4
@@ -113,10 +113,6 @@ default_cflags = machine_args default_cflags += ['-DALLOW_EXPERIMENTAL_API'] default_cflags += ['-DALLOW_INTERNAL_API'] -if cc.has_argument('-Wno-format-truncation') - default_cflags += '-Wno-format-truncation' -endif - foreach l:libraries build = true reason = '<unknown reason>' # set if build == false to explain why
Signature · 1 line
2.51.0
v3 cover lib: find and fix possible string overflows
In reply to Stephen HemmingerChange all the libraries to find and fix cases where a string could overflow when formatting or using strclpy. This does provide early indication of possible problems where the file prefix is too long to fit in unix domain socket path, and where a hash table is being requested that has a name too long.
v3 - allow longer hash names but warn if ring names get truncated
- pickup some other places like latencystats and tailq
- add release note
- fix build on FreeBSD
Stephen Hemminger (16):
eal: use C library to parse filesystem table
lpm: restrict name size
hash: add checks for hash name length
graph: avoid overflowing comment buffer
latencystats: add check for string overflow
efd: handle possible name truncation
eal: warn if thread name is truncated
eal: avoid format overflow when handling addresses
eal: add check for sysfs path overflow
eal: limit maximum runtime directory and socket paths
eal: check for hugefile path overflow
eal: check tailq length
eal: handle long shared library path
ethdev: avoid possible overflow in xstat names
vhost: check for overflow in xstat name
lib: enable format overflow warnings
app/test/test_hash.c | 21 +++++++ doc/guides/rel_notes/release_26_03.rst | 3 + lib/eal/common/eal_common_config.c | 6 +- lib/eal/common/eal_common_memory.c | 2 +- lib/eal/common/eal_common_options.c | 17 ++++-- lib/eal/common/eal_common_proc.c | 83 +++++++++++++++++--------- lib/eal/common/eal_common_tailqs.c | 5 ++ lib/eal/common/eal_filesystem.h | 17 ++++-- lib/eal/linux/eal.c | 6 +- lib/eal/linux/eal_hugepage_info.c | 64 +++++++------------- lib/eal/linux/eal_memalloc.c | 11 +++- lib/eal/linux/eal_memory.c | 9 ++- lib/efd/rte_efd.c | 7 ++- lib/ethdev/rte_ethdev.c | 35 +++++++---- lib/graph/graph_pcap.c | 9 ++- lib/hash/rte_cuckoo_hash.c | 41 +++++++++---- lib/hash/rte_fbk_hash.c | 13 +++- lib/latencystats/rte_latencystats.c | 9 ++- lib/lpm/rte_lpm.h | 2 +- lib/meson.build | 4 -- lib/vhost/vhost.c | 14 +++-- 21 files changed, 248 insertions(+), 130 deletions(-)
Signature · 1 line
2.51.0
PATCH v3 1/16 eal: use C library to parse filesystem table
Rather than doing parsing of /proc/mounts with open coded string handling, use the standard C library routines.
These exist in BSD and Linux.
It also avoids any possible issues with escaped strings etc which the library handles. See getmntent(3) man page.
--- lib/eal/linux/eal_hugepage_info.c | 58 ++++++++++--------------------- 1 file changed, 18 insertions(+), 40 deletions(-)
lib/eal/linux/eal_hugepage_info.c +18 -40
@@ -13,6 +13,7 @@#include <inttypes.h> #include <unistd.h> #include <errno.h> +#include <mntent.h> #include <sys/mman.h> #include <sys/stat.h>
@@ -195,23 +196,13 @@ get_default_hp_size(void)static int get_hugepage_dir (uint64_t hugepage_sz,char *hugedir,int len) { -enum proc_mount_fieldnames { -DEVICE =0 , -MOUNTPT , -FSTYPE , -OPTIONS , - _FIELDNAME_MAX - };static uint64_t default_size =0 ;const char proc_mounts[] ="/proc/mounts" ; -const char hugetlbfs_str[] ="hugetlbfs" ; -const size_t htlbfs_str_len =sizeof (hugetlbfs_str) -1 ;const char pagesize_opt[] ="pagesize=" ;const size_t pagesize_opt_len =sizeof (pagesize_opt) -1 ; -const char split_tok =' ' ; -char *splitstr[_FIELDNAME_MAX];char found[PATH_MAX ] ="" ;char buf[BUFSIZ ]; +struct mntent entry;const struct internal_config *internal_conf =eal_get_internal_configuration (); const size_t hugepage_dir_len = (internal_conf->hugepage_dir != NULL) ?
@@ -226,56 +217,43 @@ get_hugepage_dir(uint64_t hugepage_sz, char *hugedir, int len)return -1 ; } -FILE *fd =fopen (proc_mounts,"r" ); -if (fd ==NULL ) +FILE *mounts =setmntent (proc_mounts,"r" ); +if (mounts ==NULL )rte_panic ("Cannot open %s\n" , proc_mounts);if (default_size ==0 ) default_size =get_default_hp_size (); -while (fgets (buf,sizeof (buf), fd)){ +while (getmntent_r (mounts, &entry, buf,sizeof (buf))) {const char *pagesz_str; -size_t mountpt_len =0 ; - -if (rte_strsplit (buf,sizeof (buf), splitstr, _FIELDNAME_MAX, - split_tok) != _FIELDNAME_MAX) { -EAL_LOG (ERR ,"Error parsing %s" , proc_mounts); -break ;/* return NULL */ - } +uint64_t pagesz = default_size; +size_t mountpt_len; -if (strncmp (splitstr[FSTYPE ], hugetlbfs_str, htlbfs_str_len) !=0 ) +if (strcmp (entry.mnt_type,"hugetlbfs" ) !=0 )continue ; - pagesz_str =strstr (splitstr[OPTIONS ], pagesize_opt); + pagesz_str =strstr (entry.mnt_opts, pagesize_opt); +if (pagesz_str) + pagesz =rte_str_to_size (&pagesz_str[pagesize_opt_len]); -/* if no explicit page size, the default page size is compared */ -if (pagesz_str ==NULL ) { -if (hugepage_sz != default_size) -continue ; - } -/* there is an explicit page size, so check it */ -else { -uint64_t pagesz =rte_str_to_size (&pagesz_str[pagesize_opt_len]); -if (pagesz != hugepage_sz) -continue ; - } +if (pagesz != hugepage_sz) +continue ;/* * If no --huge-dir option has been given, we're done. */ if (internal_conf->hugepage_dir ==NULL ) { -strlcpy (found, splitstr[MOUNTPT ], len); +strlcpy (found, entry.mnt_dir, len);break ; } - mountpt_len =strlen (splitstr[MOUNTPT ]); + mountpt_len =strlen (entry.mnt_dir);/* * Ignore any mount that doesn't contain the --huge-dir directory * or where mount point is not a parent path of --huge-dir */ -if (strncmp (internal_conf->hugepage_dir, splitstr[MOUNTPT ], - mountpt_len) !=0 || +if (strncmp (internal_conf->hugepage_dir, entry.mnt_dir, mountpt_len) !=0 || (hugepage_dir_len > mountpt_len && internal_conf->hugepage_dir[mountpt_len] !='/' )) {continue ;
@@ -286,10 +264,10 @@ get_hugepage_dir(uint64_t hugepage_sz, char *hugedir, int len)* (so /mnt/1 is preferred over /mnt for matching /mnt/1/2)). */ if (mountpt_len >strlen (found)) -strlcpy (found, splitstr[MOUNTPT ], len); +strlcpy (found, entry.mnt_dir, len); }/* end while fgets */ -fclose (fd); +endmntent (mounts);if (found[0 ] !='\0' ) {/* If needed, return the requested dir, not the mount point. */
Signature · 1 line
2.51.0
PATCH v3 2/16 lpm: restrict name size
In reply to Stephen HemmingerSince LPM uses ring internally with a prefix, limit the maximum allowed LPM name.
--- lib/lpm/rte_lpm.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
lib/lpm/rte_lpm.h +1 -1
@@ -26,7 +26,7 @@ extern "C" {#endif /** Max number of characters in LPM name. */ -#define RTE_LPM_NAMESIZE 32 +#define RTE_LPM_NAMESIZE (RTE_RING_NAMESIZE - sizeof("LPM_RCU_") + 1)/** Maximum depth value possible for IPv4 LPM. */ #define RTE_LPM_MAX_DEPTH 32
Signature · 1 line
2.51.0
PATCH v3 3/16 hash: add checks for hash name length
In reply to Stephen HemmingerAdd a missing check to the API that the name is within the current defined maximum name size. This name is then used internally to create ring names, those names could get truncated; if a name is truncated add message to log.
If ring creation fails it might be because of name conflict, so change the log message to decode error value.
Add additional tests as well.
--- app/test/test_hash.c | 21 +++++++++++++ doc/guides/rel_notes/release_26_03.rst | 3 ++ lib/hash/rte_cuckoo_hash.c | 41 ++++++++++++++++++-------- lib/hash/rte_fbk_hash.c | 13 ++++++-- 4 files changed, 64 insertions(+), 14 deletions(-)
app/test/test_hash.c +21 -0
@@ -1120,6 +1120,14 @@ fbk_hash_unit_test(void) .socket_id = RTE_MAX_NUMA_NODES + 1, /* invalid socket */ }; +/* try and create hash with an excessively long name */ +struct rte_fbk_hash_params invalid_params_long_name = { + .name ="four_byte_key_hash_name_length_32" , + .entries =4 , + .entries_per_bucket =2 , + .socket_id =0 , + }; +/* try to create two hashes with identical names * in this case, trying to create a second one will not * fail but will simply return pointer to the existing
@@ -1201,6 +1209,9 @@ fbk_hash_unit_test(void) handle =rte_fbk_hash_create (&invalid_params_7);RETURN_IF_ERROR_FBK (handle !=NULL ,"fbk hash creation should have failed" ); + handle =rte_fbk_hash_create (&invalid_params_long_name); +RETURN_IF_ERROR_FBK (handle !=NULL ,"fbk hash creation should have failed" ); +if (rte_eal_has_hugepages ()) { handle =rte_fbk_hash_create (&invalid_params_8); RETURN_IF_ERROR_FBK(handle != NULL,
@@ -1439,6 +1450,16 @@ static int test_hash_creation_with_bad_parameters(void)return -1 ; } +memcpy (¶ms, &ut_params,sizeof (params)); + params.name ="hash_creation_with_too_long_name" ; + params.socket_id =RTE_MAX_NUMA_NODES +1 ; + handle =rte_hash_create (¶ms); +if (handle !=NULL ) { +rte_hash_free (handle); +printf ("Impossible creating hash successfully with long name\n" ); +return -1 ; + } +/* test with same name should fail */ memcpy (¶ms, &ut_params,sizeof (params)); params.name ="same_name" ;
doc/guides/rel_notes/release_26_03.rst +3 -0
@@ -84,6 +84,9 @@ API Changes Also, make sure to start the actual text at the margin. ======================================================= +* hash: Added name length validation to hash creation. + The hash name in hash parameters is now checked against RTE_HASH_NAMESIZE. + ABI Changes -----------
lib/hash/rte_cuckoo_hash.c +29 -12
89 lines not on this page · raw message
lib/hash/rte_fbk_hash.c +11 -2
@@ -83,7 +83,7 @@ rte_fbk_hash_create(const struct rte_fbk_hash_params *params) {struct rte_fbk_hash_table *ht =NULL ;struct rte_tailq_entry *te; -char hash_name[RTE_FBK_HASH_NAMESIZE ]; +char *hash_name =NULL ;const uint32_t mem_size =sizeof (*ht) + (sizeof (ht->t[0 ]) * params->entries);uint32_t i;
@@ -96,6 +96,7 @@ rte_fbk_hash_create(const struct rte_fbk_hash_params *params)/* Error checking of parameters. */ if ((!rte_is_power_of_2(params->entries)) || (!rte_is_power_of_2(params->entries_per_bucket)) || + (params->name == NULL) || (params->entries == 0) || (params->entries_per_bucket == 0) || (params->entries_per_bucket > params->entries) ||
@@ -105,7 +106,14 @@ rte_fbk_hash_create(const struct rte_fbk_hash_params *params)return NULL ; } -snprintf (hash_name,sizeof (hash_name),"FBK_%s" , params->name); +if (strlen (params->name) >=RTE_FBK_HASH_NAMESIZE ) { + rte_errno =ENAMETOOLONG ; +return NULL ; + } + +/* don't care if hash_name is NULL */ + int unused __rte_unused; + unused =asprintf (&hash_name,"FBK_%s" , params->name);rte_mcfg_tailq_write_lock ();
@@ -170,6 +178,7 @@ rte_fbk_hash_create(const struct rte_fbk_hash_params *params) exit:rte_mcfg_tailq_write_unlock (); +free (hash_name);return ht; }
Signature · 1 line
2.51.0
PATCH v3 4/16 graph: avoid overflowing comment buffer
In reply to Stephen HemmingerThe library builds a pcapng comment to put on each packet but the buffer is not big enough for the largest possible graph node name, etc. Change to use asprintf() to allow any string length. Note, if asprintf() fails it is better to still log the packet without comment so no data is lost.
--- lib/graph/graph_pcap.c | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-)
lib/graph/graph_pcap.c +6 -3
@@ -194,7 +194,7 @@ graph_pcap_dispatch(struct rte_graph *graph, uint16_t nb_objs) {struct rte_mbuf *mbuf_clones[RTE_GRAPH_BURST_SIZE ]; -char buffer[GRAPH_PCAP_BUF_SZ ]; +char *comment =NULL ;uint64_t i, num_packets;struct rte_mbuf *mbuf;ssize_t len;
@@ -207,19 +207,22 @@ graph_pcap_dispatch(struct rte_graph *graph,if (num_packets > nb_objs) num_packets = nb_objs; -snprintf (buffer,GRAPH_PCAP_BUF_SZ ,"%s: %s" , graph->name, node->name); +/* put a comment on all these packets */ +if (asprintf (&comment,"%s: %s" , graph->name, node->name) <0 ) +graph_err ("asprintf for comment failed." );for (i =0 ; i < num_packets; i++) {struct rte_mbuf *mc; mbuf = (struct rte_mbuf *)objs[i]; mc =rte_pcapng_copy (mbuf->port,0 , mbuf, pkt_mp, mbuf->pkt_len, -0 , buffer); +0 , comment);if (mc ==NULL )break ; mbuf_clones[i] = mc; } +free (comment);/* write it to capture file */ len =rte_pcapng_write_packets (pcapng_fd, mbuf_clones, i);
Signature · 1 line
2.51.0
PATCH v3 5/16 latencystats: add check for string overflow
In reply to Stephen HemmingerThe copy of latency stat names could get truncated if in the future a new value is added. Add warning if that happens.
--- lib/latencystats/rte_latencystats.c | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-)
lib/latencystats/rte_latencystats.c +6 -3
@@ -405,9 +405,12 @@ rte_latencystats_get_names(struct rte_metric_name *names, uint16_t size)if (names ==NULL || size <NUM_LATENCY_STATS )return NUM_LATENCY_STATS ; -for (i =0 ; i <NUM_LATENCY_STATS ; i++) -strlcpy (names[i].name, lat_stats_strings[i].name, -sizeof (names[i].name)); +for (i =0 ; i <NUM_LATENCY_STATS ; i++) { +if (strlcpy (names[i].name, lat_stats_strings[i].name,sizeof (names[0 ].name)) + >=sizeof (names[0 ].name)) +LATENCY_STATS_LOG (NOTICE ,"Latency metric '%s' too long" , + lat_stats_strings[i].name); + }return NUM_LATENCY_STATS ; }
Signature · 1 line
2.51.0
PATCH v3 6/16 efd: handle possible name truncation
In reply to Stephen HemmingerIf the conversion of efd name to ring name gets truncated, then log it. And if the ring name than causes collision, make sure that log message includes error reason.
--- lib/efd/rte_efd.c | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-)
lib/efd/rte_efd.c +5 -2
@@ -698,12 +698,15 @@ rte_efd_create(const char *name, uint32_t max_num_rules, uint32_t key_len,TAILQ_INSERT_TAIL (efd_list, te, next);rte_mcfg_tailq_write_unlock (); -snprintf (ring_name,sizeof (ring_name),"HT_%s" , table->name); +if (snprintf (ring_name,sizeof (ring_name),"HT_%s" , table->name) + >= (int )sizeof (ring_name)) +EFD_LOG (NOTICE ,"EFD ring name truncated to '%s'" , ring_name); +/* Create ring (Dummy slot index is not enqueued) */ r =rte_ring_create (ring_name,rte_align32pow2 (table->max_num_rules), offline_cpu_socket,0 );if (r ==NULL ) { -EFD_LOG (ERR ,"memory allocation failed" ); +EFD_LOG (ERR ,"ring creation failed: %s" ,rte_strerror (rte_errno));rte_efd_free (table);return NULL ; }
Signature · 1 line
2.51.0
PATCH v3 7/16 eal: warn if thread name is truncated
In reply to Stephen HemmingerThread name is very short 16 characters and therefore the name dpdk-worker-%d will overflow with more than 9999 worker cores. Error should be non-fatal since name only matters for debug.
--- lib/eal/linux/eal.c | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-)
lib/eal/linux/eal.c +4 -2
@@ -863,8 +863,10 @@ rte_eal_init(int argc, char **argv)rte_panic ("Cannot create thread\n" );/* Set thread_name for aid in debugging. */ -snprintf (thread_name,sizeof (thread_name), -"dpdk-worker%d" , i); + ret =snprintf (thread_name,sizeof (thread_name),"dpdk-worker%d" , i); +if (ret >=RTE_THREAD_NAME_SIZE ) +EAL_LOG (INFO ,"Worker thread name %s truncated" , thread_name); +rte_thread_set_name (lcore_config[i].thread_id, thread_name); ret = rte_thread_set_affinity_by_id(lcore_config[i].thread_id,
Signature · 1 line
2.51.0
PATCH v3 8/16 eal: avoid format overflow when handling addresses
In reply to Stephen HemmingerThe largest possible string in this code 0xFFFFFFFFFFFFFFFF which will overflow with only 15 character buffer. Increase to 20.
--- lib/eal/common/eal_common_memory.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
lib/eal/common/eal_common_memory.c +1 -1
@@ -1153,7 +1153,7 @@ rte_eal_memory_init(void)#define EAL_MEMSEG_INFO_REQ "/eal/memseg_info"#define EAL_ELEMENT_LIST_REQ "/eal/mem_element_list"#define EAL_ELEMENT_INFO_REQ "/eal/mem_element_info" -#define ADDR_STR 15 +#define ADDR_STR 20/* 16 bytes 64 bit + 0x */ /* Telemetry callback handler to return heap stats for requested heap id. */
Signature · 1 line
2.51.0
PATCH v3 9/16 eal: add check for sysfs path overflow
In reply to Stephen HemmingerShouldn't happen but in theory sysfs socket could overflow. Add a check for it.
--- lib/eal/linux/eal_hugepage_info.c | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-)
lib/eal/linux/eal_hugepage_info.c +5 -1
@@ -150,8 +150,12 @@ get_num_hugepages_on_node(const char *subdir, unsigned int socket, size_t sz)return 0 ; } -snprintf (path,sizeof (path),"%s/%s/%s" , +if (snprintf (path,sizeof (path),"%s/%s/%s" , socketpath, subdir, nr_hp_file) >=PATH_MAX ) { +EAL_LOG (NOTICE ,"Socket path %s/%s/%s is truncated" , socketpath, subdir, nr_hp_file); +return 0 ; + } +if (eal_parse_sysfs_value (path, &num_pages) <0 )return 0 ;
Signature · 1 line
2.51.0
PATCH v3 10/16 eal: limit maximum runtime directory and socket paths
In reply to Stephen HemmingerLinux (and FreeBSD) has a limitation of 108 characters for any unix domain socket path. Therefore DPDK would not work if a really large runtime directory was used.
--- lib/eal/common/eal_common_config.c | 6 ++- lib/eal/common/eal_common_proc.c | 83 +++++++++++++++++++----------- lib/eal/common/eal_filesystem.h | 7 ++- 3 files changed, 64 insertions(+), 32 deletions(-)
lib/eal/common/eal_common_config.c +4 -2
@@ -6,6 +6,7 @@#include <eal_export.h> #include "eal_private.h" +#include "eal_filesystem.h" #include "eal_memcfg.h" /* early configuration structure, when memory config is not mmapped */
@@ -24,7 +25,7 @@ static struct rte_config rte_config = { };/* platform-specific runtime dir */ -static char runtime_dir[PATH_MAX ]; +static char runtime_dir[UNIX_PATH_MAX ];/* internal configuration */ static struct internal_config internal_config;
@@ -39,7 +40,8 @@ rte_eal_get_runtime_dir(void)int eal_set_runtime_dir (const char *run_dir) { -if (strlcpy (runtime_dir, run_dir,PATH_MAX ) >=PATH_MAX ) { +/* runtime directory limited by maximum allowable unix domain socket */ +if (strlcpy (runtime_dir, run_dir,UNIX_PATH_MAX ) >=UNIX_PATH_MAX ) {EAL_LOG (ERR ,"Runtime directory string too long" );return -1 ; }
lib/eal/common/eal_common_proc.c +54 -29
166 lines not on this page · raw message
lib/eal/common/eal_filesystem.h +6 -1
@@ -17,6 +17,7 @@#include <limits.h> #include <unistd.h> #include <stdlib.h> +#include <sys/un.h> #include <rte_string_fns.h> #include "eal_internal_cfg.h"
@@ -45,10 +46,14 @@ eal_runtime_config_path(void)/** Path of primary/secondary communication unix socket file. */ #define MP_SOCKET_FNAME "mp_socket" + +/** Maximum length of unix domain socket path. */ +#define UNIX_PATH_MAX (sizeof(((struct sockaddr_un *)0)->sun_path)) +static inline const char *eal_mp_socket_path (void ) { -static char buffer[PATH_MAX ];/* static so auto-zeroed */ +static char buffer[UNIX_PATH_MAX ];/* static so auto-zeroed */ snprintf (buffer,sizeof (buffer),"%s/%s" ,rte_eal_get_runtime_dir (),MP_SOCKET_FNAME );
Signature · 1 line
2.51.0
Re: [PATCH v3 10/16] eal: limit maximum runtime directory and socket paths
Quoted 1 line · Stephen Hemminger
Linux (and FreeBSD) has a limitation of 108 characters for
108 characters -> "just over 100 characters"
make it generic to cover both linux and bsd
Quoted 4 lines
any unix domain socket path. Therefore DPDK would not work if a really large runtime directory was used.
Signed-off-by Stephen Hemminger <[email protected]>
Re: [PATCH v3 10/16] eal: limit maximum runtime directory and socket paths
Quoted 5 lines · On Mon, 8 Dec 2025 08:58:22 +0000 Bruce Richardson…
Quoted 1 line · Stephen Hemminger
Linux (and FreeBSD) has a limitation of 108 characters for
108 characters -> "just over 100 characters"
Quoted 9 lines
make it generic to cover both linux and bsd
Quoted 4 lines
any unix domain socket path. Therefore DPDK would not work if a really large runtime directory was used.
Signed-off-by Stephen Hemminger <[email protected]>Acked-by Bruce Richardson <[email protected]>
Since Windows defines UNIX_PATH_MAX in afunix.h probably best to just compute the size based on sun_path which is what follow up patch does.
PATCH v3 11/16 eal: check for hugefile path overflow
In reply to Stephen HemmingerWhen constructing huge filename path, check for possible overflow of PATH_MAX.
--- lib/eal/common/eal_filesystem.h | 10 ++++++---- lib/eal/linux/eal_memalloc.c | 11 +++++++++-- lib/eal/linux/eal_memory.c | 9 +++++++-- 3 files changed, 22 insertions(+), 8 deletions(-)
lib/eal/common/eal_filesystem.h +6 -4
@@ -94,12 +94,14 @@ eal_hugepage_data_path(void)/** String format for hugepage map files. */ #define HUGEFILE_FMT "%s/%smap_%d" -static inline const char * +static inline __rte_warn_unused_result const char *eal_get_hugefile_path (char *buffer,size_t buflen,const char *hugedir,int f_id) { -snprintf (buffer, buflen,HUGEFILE_FMT , hugedir, -eal_get_hugefile_prefix (), f_id); -return buffer; +if (snprintf (buffer, buflen,HUGEFILE_FMT , hugedir, +eal_get_hugefile_prefix (), f_id) >= (int )buflen) +return NULL ; +else +return buffer; }/** define the default filename prefix for the %s values above */
lib/eal/linux/eal_memalloc.c +9 -2
@@ -260,6 +260,7 @@ get_seg_fd(char *path, int buflen, struct hugepage_info *hi, {int fd;int *out_fd; +const char *huge_path;struct stat st;int ret; const struct internal_config *internal_conf =
@@ -276,12 +277,18 @@ get_seg_fd(char *path, int buflen, struct hugepage_info *hi,if (internal_conf->single_file_segments) { out_fd = &fd_list[list_idx].memseg_list_fd; -eal_get_hugefile_path (path, buflen, hi->hugedir, list_idx); + huge_path =eal_get_hugefile_path (path, buflen, hi->hugedir, list_idx); }else { out_fd = &fd_list[list_idx].fds[seg_idx]; -eal_get_hugefile_path (path, buflen, hi->hugedir, + huge_path =eal_get_hugefile_path (path, buflen, hi->hugedir, list_idx *RTE_MAX_MEMSEG_PER_LIST + seg_idx); } +if (huge_path ==NULL ) { +EAL_LOG (DEBUG ,"%s(): hugefile path truncated: '%s'" , + __func__, path); +return -1 ; + } + fd = *out_fd;if (fd >=0 )return fd;
lib/eal/linux/eal_memory.c +7 -2
@@ -337,8 +337,13 @@ map_all_hugepages(struct hugepage_file *hugepg_tbl, struct hugepage_info *hpi, hf->file_id = i; hf->size = hugepage_sz; -eal_get_hugefile_path (hf->filepath,sizeof (hf->filepath), - hpi->hugedir, hf->file_id); +if (eal_get_hugefile_path (hf->filepath,sizeof (hf->filepath), + hpi->hugedir, hf->file_id) ==NULL ) { +EAL_LOG (DEBUG ,"%s(): huge file path '%s' truncated" , + __func__, hf->filepath); + goto out; + } + hf->filepath[sizeof (hf->filepath) -1 ] ='\0' ;/* try to create hugepage file */
Signature · 1 line
2.51.0
PATCH v3 12/16 eal: check tailq length
In reply to Stephen HemmingerThe tailq name should not be allowed to exceed limits.
--- lib/eal/common/eal_common_tailqs.c | 5 +++++ 1 file changed, 5 insertions(+)
lib/eal/common/eal_common_tailqs.c +5 -0
@@ -67,6 +67,11 @@ rte_eal_tailq_create(const char *name) {struct rte_tailq_head *head =NULL ; +if (strlen (name) >=sizeof (head->name)) { +EAL_LOG (ERR ,"tailq name '%s' is too long" , name); +return NULL ; + } +if (!rte_eal_tailq_lookup (name) && (rte_tailqs_count +1 <RTE_MAX_TAILQ )) {struct rte_mem_config *mcfg;
Signature · 1 line
2.51.0
Re: [PATCH v3 12/16] eal: check tailq length
Quoted 3 lines · Stephen Hemminger
The tailq name should not be allowed to exceed limits.
Signed-off-by Stephen Hemminger <[email protected]>
Quoted 4 lines
--- lib/eal/common/eal_common_tailqs.c | 5 +++++ 1 file changed, 5 insertions(+)
PATCH v3 13/16 eal: handle long shared library path
In reply to Stephen HemmingerInstead of a fixed size shared library path that could in theory get truncated when concatenating, use a dynamically allocated buffer via asprintf.
--- lib/eal/common/eal_common_options.c | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-)
lib/eal/common/eal_common_options.c +13 -4
@@ -570,7 +570,6 @@ static int eal_plugindir_init(const char *path) {struct dirent *dent =NULL ; -char sopath[PATH_MAX ];DIR *d =NULL ;if (path ==NULL || *path =='\0' )
@@ -584,19 +583,29 @@ eal_plugindir_init(const char *path) }while ((dent =readdir (d)) !=NULL ) { +char *sopath =NULL ;struct stat sb;if (!ends_with (dent->d_name,".so" ) && !ends_with (dent->d_name,".so." ABI_VERSION ))continue ; -snprintf (sopath,sizeof (sopath),"%s/%s" , path, dent->d_name); +if (asprintf (&sopath,"%s/%s" , path, dent->d_name) <0 ) { +EAL_LOG (ERR ,"failed to create full path %s/%s" , + path, dent->d_name); +continue ; + }/* if a regular file, add to list to load */ -if (!(stat (sopath, &sb) ==0 &&S_ISREG (sb.st_mode))) +if (!(stat (sopath, &sb) ==0 &&S_ISREG (sb.st_mode))) { +free (sopath);continue ; + } -if (eal_plugin_add (sopath) ==-1 ) +if (eal_plugin_add (sopath) ==-1 ) { +free (sopath);break ; + } +free (sopath); }closedir (d);
Signature · 1 line
2.51.0
PATCH v3 14/16 ethdev: avoid possible overflow in xstat names
In reply to Stephen HemmingerThe compiler doesn't know that all the elements in the table of queue stats are short enough to avoid overflowing the snprintf. Add a condition to warn if it ever does;
maybe some day a new long named queue stat could be added.
--- lib/ethdev/rte_ethdev.c | 35 ++++++++++++++++++++++++----------- 1 file changed, 24 insertions(+), 11 deletions(-)
lib/ethdev/rte_ethdev.c +24 -11
@@ -3489,9 +3489,10 @@ eth_basic_stats_get_names(struct rte_eth_dev *dev,uint16_t num_q;for (idx =0 ; idx <RTE_NB_STATS ; idx++) { -strlcpy (xstats_names[cnt_used_entries].name, - eth_dev_stats_strings[idx].name, -sizeof (xstats_names[0 ].name)); +if (strlcpy (xstats_names[cnt_used_entries].name, eth_dev_stats_strings[idx].name, +sizeof (xstats_names[0 ].name)) >=sizeof (xstats_names[0 ].name)) +RTE_ETHDEV_LOG_LINE (ERR ,"statistic name '%s' will be truncated" , + xstats_names[cnt_used_entries].name); cnt_used_entries++; }
@@ -3501,10 +3502,17 @@ eth_basic_stats_get_names(struct rte_eth_dev *dev, num_q =RTE_MIN (dev->data->nb_rx_queues,RTE_ETHDEV_QUEUE_STAT_CNTRS );for (id_queue =0 ; id_queue < num_q; id_queue++) {for (idx =0 ; idx <RTE_NB_RXQ_STATS ; idx++) { -snprintf (xstats_names[cnt_used_entries].name, -sizeof (xstats_names[0 ].name), -"rx_q%u_%s" , - id_queue, eth_dev_rxq_stats_strings[idx].name); +unsigned int cc; + + cc =snprintf (xstats_names[cnt_used_entries].name, +sizeof (xstats_names[0 ].name), +"rx_q%u_%s" , + id_queue, eth_dev_rxq_stats_strings[idx].name); + +/* could only happen if a long string was added */ +if (cc >=sizeof (xstats_names[0 ].name)) +RTE_ETHDEV_LOG_LINE (ERR ,"truncated rxq stat string '%s'" , + eth_dev_rxq_stats_strings[idx].name); cnt_used_entries++; }
@@ -3512,10 +3520,15 @@ eth_basic_stats_get_names(struct rte_eth_dev *dev, num_q =RTE_MIN (dev->data->nb_tx_queues,RTE_ETHDEV_QUEUE_STAT_CNTRS );for (id_queue =0 ; id_queue < num_q; id_queue++) {for (idx =0 ; idx <RTE_NB_TXQ_STATS ; idx++) { -snprintf (xstats_names[cnt_used_entries].name, -sizeof (xstats_names[0 ].name), -"tx_q%u_%s" , - id_queue, eth_dev_txq_stats_strings[idx].name); +unsigned int cc; + + cc =snprintf (xstats_names[cnt_used_entries].name, +sizeof (xstats_names[0 ].name), +"tx_q%u_%s" , + id_queue, eth_dev_txq_stats_strings[idx].name); +if (cc >=sizeof (xstats_names[0 ].name)) +RTE_ETHDEV_LOG_LINE (ERR ,"truncated txq stat string '%s'" , + eth_dev_txq_stats_strings[idx].name); cnt_used_entries++; } }
Signature · 1 line
2.51.0
PATCH v3 15/16 vhost: check for overflow in xstat name
In reply to Stephen HemmingerThe snprintf to format an xstat name could overflow if called with a long rte_vhost_stat_name. Check if that happens and warn.
--- lib/vhost/vhost.c | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-)
lib/vhost/vhost.c +10 -4
@@ -2200,6 +2200,7 @@ rte_vhost_vring_stats_get_names(int vid, uint16_t queue_id, {struct virtio_net *dev =get_device (vid);unsigned int i; +int ret;if (dev ==NULL )return -1 ;
@@ -2213,10 +2214,15 @@ rte_vhost_vring_stats_get_names(int vid, uint16_t queue_id,if (name ==NULL || size <VHOST_NB_VQ_STATS )return VHOST_NB_VQ_STATS ; -for (i =0 ; i <VHOST_NB_VQ_STATS ; i++) -snprintf (name[i].name,sizeof (name[i].name),"%s_q%u_%s" , - (queue_id &1 ) ?"rx" :"tx" , - queue_id /2 , vhost_vq_stat_strings[i].name); +for (i =0 ; i <VHOST_NB_VQ_STATS ; i++) { + ret =snprintf (name[i].name,sizeof (name[i].name),"%s_q%u_%s" , + (queue_id &1 ) ?"rx" :"tx" , + queue_id /2 , vhost_vq_stat_strings[i].name); +if (ret >= (int )sizeof (name[0 ].name)) +VHOST_CONFIG_LOG ("device" ,NOTICE ,"truncated xstat '%s_q%u_%s'" , + (queue_id &1 ) ?"rx" :"tx" , + queue_id /2 , vhost_vq_stat_strings[i].name); + }return VHOST_NB_VQ_STATS ; }
Signature · 1 line
2.51.0
PATCH v3 16/16 lib: enable format overflow warnings
In reply to Stephen HemmingerEnable compiler checking of format overflow
--- lib/meson.build | 4 ---- 1 file changed, 4 deletions(-)
lib/meson.build +0 -4
@@ -113,10 +113,6 @@ default_cflags = machine_args default_cflags += ['-DALLOW_EXPERIMENTAL_API'] default_cflags += ['-DALLOW_INTERNAL_API'] -if cc.has_argument('-Wno-format-truncation') - default_cflags += '-Wno-format-truncation' -endif - foreach l:libraries build = true reason = '<unknown reason>' # set if build == false to explain why
Signature · 1 line
2.51.0
v4 cover lib: find and fix possible string overflows
In reply to Stephen HemmingerChange all the libraries to find and fix cases where a string could overflow when formatting or using strclpy. This does provide early indication of possible problems where the file prefix is too long to fit in unix domain socket path, and where a hash table is being requested that has a name too long.
v4 - fix build on 32 bit and windows
Stephen Hemminger (16):
eal: use C library to parse filesystem table
lpm: restrict name size
hash: add checks for hash name length
graph: avoid overflowing comment buffer
latencystats: add check for string overflow
efd: handle possible name truncation
eal: warn if thread name is truncated
eal: avoid format overflow when handling addresses
eal: add check for sysfs path overflow
eal: limit maximum runtime directory and socket paths
eal: check for hugefile path overflow
eal: check tailq length
eal: handle long shared library path
ethdev: avoid possible overflow in xstat names
vhost: check for overflow in xstat name
lib: enable format overflow warnings
app/test/test_hash.c | 21 ++++++ doc/guides/rel_notes/release_26_03.rst | 3 + lib/eal/common/eal_common_config.c | 6 +- lib/eal/common/eal_common_memory.c | 2 +- lib/eal/common/eal_common_options.c | 17 +++-- lib/eal/common/eal_common_proc.c | 83 ++++++++++++++-------- lib/eal/common/eal_common_tailqs.c | 5 ++ lib/eal/common/eal_filesystem.h | 23 ++++-- lib/eal/freebsd/eal.c | 6 +- lib/eal/linux/eal.c | 6 +- lib/eal/linux/eal_hugepage_info.c | 98 ++++++++++++-------------- lib/eal/linux/eal_memalloc.c | 11 ++- lib/eal/linux/eal_memory.c | 9 ++- lib/eal/windows/eal.c | 6 +- lib/efd/rte_efd.c | 7 +- lib/ethdev/rte_ethdev.c | 35 ++++++--- lib/graph/graph_pcap.c | 9 ++- lib/hash/rte_cuckoo_hash.c | 41 +++++++---- lib/hash/rte_fbk_hash.c | 14 +++- lib/latencystats/rte_latencystats.c | 9 ++- lib/lpm/rte_lpm.c | 25 +++++-- lib/lpm/rte_lpm.h | 2 +- lib/meson.build | 4 -- lib/vhost/vhost.c | 14 ++-- 24 files changed, 303 insertions(+), 153 deletions(-)
Signature · 1 line
2.51.0
PATCH v4 1/16 eal: use C library to parse filesystem table
Rather than doing parsing of /proc/mounts with open coded string handling, use the standard C library routines.
These exist in BSD and Linux.
It also avoids any possible issues with escaped strings etc which the library handles. See getmntent(3) man page.
--- lib/eal/linux/eal_hugepage_info.c | 58 ++++++++++--------------------- 1 file changed, 18 insertions(+), 40 deletions(-)
lib/eal/linux/eal_hugepage_info.c +18 -40
@@ -13,6 +13,7 @@#include <inttypes.h> #include <unistd.h> #include <errno.h> +#include <mntent.h> #include <sys/mman.h> #include <sys/stat.h>
@@ -195,23 +196,13 @@ get_default_hp_size(void)static int get_hugepage_dir (uint64_t hugepage_sz,char *hugedir,int len) { -enum proc_mount_fieldnames { -DEVICE =0 , -MOUNTPT , -FSTYPE , -OPTIONS , - _FIELDNAME_MAX - };static uint64_t default_size =0 ;const char proc_mounts[] ="/proc/mounts" ; -const char hugetlbfs_str[] ="hugetlbfs" ; -const size_t htlbfs_str_len =sizeof (hugetlbfs_str) -1 ;const char pagesize_opt[] ="pagesize=" ;const size_t pagesize_opt_len =sizeof (pagesize_opt) -1 ; -const char split_tok =' ' ; -char *splitstr[_FIELDNAME_MAX];char found[PATH_MAX ] ="" ;char buf[BUFSIZ ]; +struct mntent entry;const struct internal_config *internal_conf =eal_get_internal_configuration (); const size_t hugepage_dir_len = (internal_conf->hugepage_dir != NULL) ?
@@ -226,56 +217,43 @@ get_hugepage_dir(uint64_t hugepage_sz, char *hugedir, int len)return -1 ; } -FILE *fd =fopen (proc_mounts,"r" ); -if (fd ==NULL ) +FILE *mounts =setmntent (proc_mounts,"r" ); +if (mounts ==NULL )rte_panic ("Cannot open %s\n" , proc_mounts);if (default_size ==0 ) default_size =get_default_hp_size (); -while (fgets (buf,sizeof (buf), fd)){ +while (getmntent_r (mounts, &entry, buf,sizeof (buf))) {const char *pagesz_str; -size_t mountpt_len =0 ; - -if (rte_strsplit (buf,sizeof (buf), splitstr, _FIELDNAME_MAX, - split_tok) != _FIELDNAME_MAX) { -EAL_LOG (ERR ,"Error parsing %s" , proc_mounts); -break ;/* return NULL */ - } +uint64_t pagesz = default_size; +size_t mountpt_len; -if (strncmp (splitstr[FSTYPE ], hugetlbfs_str, htlbfs_str_len) !=0 ) +if (strcmp (entry.mnt_type,"hugetlbfs" ) !=0 )continue ; - pagesz_str =strstr (splitstr[OPTIONS ], pagesize_opt); + pagesz_str =strstr (entry.mnt_opts, pagesize_opt); +if (pagesz_str) + pagesz =rte_str_to_size (&pagesz_str[pagesize_opt_len]); -/* if no explicit page size, the default page size is compared */ -if (pagesz_str ==NULL ) { -if (hugepage_sz != default_size) -continue ; - } -/* there is an explicit page size, so check it */ -else { -uint64_t pagesz =rte_str_to_size (&pagesz_str[pagesize_opt_len]); -if (pagesz != hugepage_sz) -continue ; - } +if (pagesz != hugepage_sz) +continue ;/* * If no --huge-dir option has been given, we're done. */ if (internal_conf->hugepage_dir ==NULL ) { -strlcpy (found, splitstr[MOUNTPT ], len); +strlcpy (found, entry.mnt_dir, len);break ; } - mountpt_len =strlen (splitstr[MOUNTPT ]); + mountpt_len =strlen (entry.mnt_dir);/* * Ignore any mount that doesn't contain the --huge-dir directory * or where mount point is not a parent path of --huge-dir */ -if (strncmp (internal_conf->hugepage_dir, splitstr[MOUNTPT ], - mountpt_len) !=0 || +if (strncmp (internal_conf->hugepage_dir, entry.mnt_dir, mountpt_len) !=0 || (hugepage_dir_len > mountpt_len && internal_conf->hugepage_dir[mountpt_len] !='/' )) {continue ;
@@ -286,10 +264,10 @@ get_hugepage_dir(uint64_t hugepage_sz, char *hugedir, int len)* (so /mnt/1 is preferred over /mnt for matching /mnt/1/2)). */ if (mountpt_len >strlen (found)) -strlcpy (found, splitstr[MOUNTPT ], len); +strlcpy (found, entry.mnt_dir, len); }/* end while fgets */ -fclose (fd); +endmntent (mounts);if (found[0 ] !='\0' ) {/* If needed, return the requested dir, not the mount point. */
Signature · 1 line
2.51.0
PATCH v4 2/16 lpm: restrict name size
In reply to Stephen HemmingerSince LPM uses ring internally with a prefix, limit the maximum allowed LPM name.
--- lib/lpm/rte_lpm.c | 25 +++++++++++++++++++------ lib/lpm/rte_lpm.h | 2 +- 2 files changed, 20 insertions(+), 7 deletions(-)
lib/lpm/rte_lpm.c +19 -6
@@ -5,6 +5,7 @@#include <string.h> #include <stdint.h> +#include <stdlib.h> #include <errno.h> #include <stdio.h> #include <sys/queue.h>
@@ -152,7 +153,6 @@ struct rte_lpm * rte_lpm_create(const char *name, int socket_id, const struct rte_lpm_config *config) { - char mem_name[RTE_LPM_NAMESIZE]; struct __rte_lpm *i_lpm;struct rte_lpm *lpm =NULL ;struct rte_tailq_entry *te;
@@ -170,7 +170,15 @@ rte_lpm_create(const char *name, int socket_id,return NULL ; } -snprintf (mem_name,sizeof (mem_name),"LPM_%s" , name); +if (strlen (name) >=RTE_LPM_NAMESIZE ) { + rte_errno =ENAMETOOLONG ; +return NULL ; + } + +/* This is only used for tracing, ok to be NULL */ +char *mem_name =NULL ; + int unused __rte_unused; + unused =asprintf (&mem_name,"LPM_%s" , name);rte_mcfg_tailq_write_lock ();
@@ -247,6 +255,7 @@ rte_lpm_create(const char *name, int socket_id, exit:rte_mcfg_tailq_write_unlock (); +free (mem_name);return lpm; }
@@ -309,7 +318,6 @@ int rte_lpm_rcu_qsbr_add(struct rte_lpm *lpm, struct rte_lpm_rcu_config *cfg) { struct rte_rcu_qsbr_dq_parameters params = {0}; -char rcu_dq_name[RTE_RCU_QSBR_DQ_NAMESIZE ];struct __rte_lpm *i_lpm;if (lpm ==NULL || cfg ==NULL ) {
@@ -326,9 +334,13 @@ rte_lpm_rcu_qsbr_add(struct rte_lpm *lpm, struct rte_lpm_rcu_config *cfg)if (cfg->mode ==RTE_LPM_QSBR_MODE_SYNC ) {/* No other things to do. */ }else if (cfg->mode ==RTE_LPM_QSBR_MODE_DQ ) { +char rcu_dq_name[RTE_RCU_QSBR_DQ_NAMESIZE ]; +/* Init QSBR defer queue. */ -snprintf (rcu_dq_name,sizeof (rcu_dq_name), -"LPM_RCU_%s" , i_lpm->name); +if (snprintf (rcu_dq_name,sizeof (rcu_dq_name), +"LPM_RCU_%s" , i_lpm->name) >= (int )sizeof (rcu_dq_name)) +LPM_LOG (NOTICE ,"LPM rcu defer queue name truncated" ); + params.name = rcu_dq_name; params.size = cfg->dq_size;if (params.size ==0 )
@@ -343,7 +355,8 @@ rte_lpm_rcu_qsbr_add(struct rte_lpm *lpm, struct rte_lpm_rcu_config *cfg) params.v = cfg->v; i_lpm->dq =rte_rcu_qsbr_dq_create (¶ms);if (i_lpm->dq ==NULL ) { -LPM_LOG (ERR ,"LPM defer queue creation failed" ); +LPM_LOG (ERR ,"LPM defer queue creation failed: %s" , +rte_strerror (rte_errno));return 1 ; } }else {
lib/lpm/rte_lpm.h +1 -1
@@ -26,7 +26,7 @@ extern "C" {#endif /** Max number of characters in LPM name. */ -#define RTE_LPM_NAMESIZE 32 +#define RTE_LPM_NAMESIZE RTE_RING_NAMESIZE/** Maximum depth value possible for IPv4 LPM. */ #define RTE_LPM_MAX_DEPTH 32
Signature · 1 line
2.51.0
PATCH v4 3/16 hash: add checks for hash name length
In reply to Stephen HemmingerAdd a missing check to the API that the name is within the current defined maximum name size. This name is then used internally to create ring names, those names could get truncated; if a name is truncated add message to log.
If ring creation fails it might be because of name conflict, so change the log message to decode error value.
Add additional tests as well.
--- app/test/test_hash.c | 21 +++++++++++++ doc/guides/rel_notes/release_26_03.rst | 3 ++ lib/hash/rte_cuckoo_hash.c | 41 ++++++++++++++++++-------- lib/hash/rte_fbk_hash.c | 14 +++++++-- 4 files changed, 65 insertions(+), 14 deletions(-)
app/test/test_hash.c +21 -0
@@ -1120,6 +1120,14 @@ fbk_hash_unit_test(void) .socket_id = RTE_MAX_NUMA_NODES + 1, /* invalid socket */ }; +/* try and create hash with an excessively long name */ +struct rte_fbk_hash_params invalid_params_long_name = { + .name ="four_byte_key_hash_name_length_32" , + .entries =4 , + .entries_per_bucket =2 , + .socket_id =0 , + }; +/* try to create two hashes with identical names * in this case, trying to create a second one will not * fail but will simply return pointer to the existing
@@ -1201,6 +1209,9 @@ fbk_hash_unit_test(void) handle =rte_fbk_hash_create (&invalid_params_7);RETURN_IF_ERROR_FBK (handle !=NULL ,"fbk hash creation should have failed" ); + handle =rte_fbk_hash_create (&invalid_params_long_name); +RETURN_IF_ERROR_FBK (handle !=NULL ,"fbk hash creation should have failed" ); +if (rte_eal_has_hugepages ()) { handle =rte_fbk_hash_create (&invalid_params_8); RETURN_IF_ERROR_FBK(handle != NULL,
@@ -1439,6 +1450,16 @@ static int test_hash_creation_with_bad_parameters(void)return -1 ; } +memcpy (¶ms, &ut_params,sizeof (params)); + params.name ="hash_creation_with_too_long_name" ; + params.socket_id =RTE_MAX_NUMA_NODES +1 ; + handle =rte_hash_create (¶ms); +if (handle !=NULL ) { +rte_hash_free (handle); +printf ("Impossible creating hash successfully with long name\n" ); +return -1 ; + } +/* test with same name should fail */ memcpy (¶ms, &ut_params,sizeof (params)); params.name ="same_name" ;
doc/guides/rel_notes/release_26_03.rst +3 -0
@@ -84,6 +84,9 @@ API Changes Also, make sure to start the actual text at the margin. ======================================================= +* hash: Added name length validation to hash creation. + The hash name in hash parameters is now checked against RTE_HASH_NAMESIZE. + ABI Changes -----------
lib/hash/rte_cuckoo_hash.c +29 -12
89 lines not on this page · raw message
lib/hash/rte_fbk_hash.c +12 -2
@@ -5,6 +5,7 @@#include <stdint.h> #include <stdio.h> #include <string.h> +#include <stdlib.h> #include <errno.h> #include <sys/queue.h>
@@ -83,7 +84,7 @@ rte_fbk_hash_create(const struct rte_fbk_hash_params *params) {struct rte_fbk_hash_table *ht =NULL ;struct rte_tailq_entry *te; -char hash_name[RTE_FBK_HASH_NAMESIZE ]; +char *hash_name =NULL ;const uint32_t mem_size =sizeof (*ht) + (sizeof (ht->t[0 ]) * params->entries);uint32_t i;
@@ -96,6 +97,7 @@ rte_fbk_hash_create(const struct rte_fbk_hash_params *params)/* Error checking of parameters. */ if ((!rte_is_power_of_2(params->entries)) || (!rte_is_power_of_2(params->entries_per_bucket)) || + (params->name == NULL) || (params->entries == 0) || (params->entries_per_bucket == 0) || (params->entries_per_bucket > params->entries) ||
@@ -105,7 +107,14 @@ rte_fbk_hash_create(const struct rte_fbk_hash_params *params)return NULL ; } -snprintf (hash_name,sizeof (hash_name),"FBK_%s" , params->name); +if (strlen (params->name) >=RTE_FBK_HASH_NAMESIZE ) { + rte_errno =ENAMETOOLONG ; +return NULL ; + } + +/* don't care if hash_name is NULL */ + int unused __rte_unused; + unused =asprintf (&hash_name,"FBK_%s" , params->name);rte_mcfg_tailq_write_lock ();
@@ -170,6 +179,7 @@ rte_fbk_hash_create(const struct rte_fbk_hash_params *params) exit:rte_mcfg_tailq_write_unlock (); +free (hash_name);return ht; }
Signature · 1 line
2.51.0
PATCH v4 4/16 graph: avoid overflowing comment buffer
In reply to Stephen HemmingerThe library builds a pcapng comment to put on each packet but the buffer is not big enough for the largest possible graph node name, etc. Change to use asprintf() to allow any string length. Note, if asprintf() fails it is better to still log the packet without comment so no data is lost.
--- lib/graph/graph_pcap.c | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-)
lib/graph/graph_pcap.c +6 -3
@@ -194,7 +194,7 @@ graph_pcap_dispatch(struct rte_graph *graph, uint16_t nb_objs) {struct rte_mbuf *mbuf_clones[RTE_GRAPH_BURST_SIZE ]; -char buffer[GRAPH_PCAP_BUF_SZ ]; +char *comment =NULL ;uint64_t i, num_packets;struct rte_mbuf *mbuf;ssize_t len;
@@ -207,19 +207,22 @@ graph_pcap_dispatch(struct rte_graph *graph,if (num_packets > nb_objs) num_packets = nb_objs; -snprintf (buffer,GRAPH_PCAP_BUF_SZ ,"%s: %s" , graph->name, node->name); +/* put a comment on all these packets */ +if (asprintf (&comment,"%s: %s" , graph->name, node->name) <0 ) +graph_err ("asprintf for comment failed." );for (i =0 ; i < num_packets; i++) {struct rte_mbuf *mc; mbuf = (struct rte_mbuf *)objs[i]; mc =rte_pcapng_copy (mbuf->port,0 , mbuf, pkt_mp, mbuf->pkt_len, -0 , buffer); +0 , comment);if (mc ==NULL )break ; mbuf_clones[i] = mc; } +free (comment);/* write it to capture file */ len =rte_pcapng_write_packets (pcapng_fd, mbuf_clones, i);
Signature · 1 line
2.51.0
PATCH v4 5/16 latencystats: add check for string overflow
In reply to Stephen HemmingerThe copy of latency stat names could get truncated if in the future a new value is added. Add warning if that happens.
--- lib/latencystats/rte_latencystats.c | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-)
lib/latencystats/rte_latencystats.c +6 -3
@@ -405,9 +405,12 @@ rte_latencystats_get_names(struct rte_metric_name *names, uint16_t size)if (names ==NULL || size <NUM_LATENCY_STATS )return NUM_LATENCY_STATS ; -for (i =0 ; i <NUM_LATENCY_STATS ; i++) -strlcpy (names[i].name, lat_stats_strings[i].name, -sizeof (names[i].name)); +for (i =0 ; i <NUM_LATENCY_STATS ; i++) { +if (strlcpy (names[i].name, lat_stats_strings[i].name,sizeof (names[0 ].name)) + >=sizeof (names[0 ].name)) +LATENCY_STATS_LOG (NOTICE ,"Latency metric '%s' too long" , + lat_stats_strings[i].name); + }return NUM_LATENCY_STATS ; }
Signature · 1 line
2.51.0
PATCH v4 6/16 efd: handle possible name truncation
In reply to Stephen HemmingerIf the conversion of efd name to ring name gets truncated, then log it. And if the ring name than causes collision, make sure that log message includes error reason.
--- lib/efd/rte_efd.c | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-)
lib/efd/rte_efd.c +5 -2
@@ -698,12 +698,15 @@ rte_efd_create(const char *name, uint32_t max_num_rules, uint32_t key_len,TAILQ_INSERT_TAIL (efd_list, te, next);rte_mcfg_tailq_write_unlock (); -snprintf (ring_name,sizeof (ring_name),"HT_%s" , table->name); +if (snprintf (ring_name,sizeof (ring_name),"HT_%s" , table->name) + >= (int )sizeof (ring_name)) +EFD_LOG (NOTICE ,"EFD ring name truncated to '%s'" , ring_name); +/* Create ring (Dummy slot index is not enqueued) */ r =rte_ring_create (ring_name,rte_align32pow2 (table->max_num_rules), offline_cpu_socket,0 );if (r ==NULL ) { -EFD_LOG (ERR ,"memory allocation failed" ); +EFD_LOG (ERR ,"ring creation failed: %s" ,rte_strerror (rte_errno));rte_efd_free (table);return NULL ; }
Signature · 1 line
2.51.0
PATCH v4 7/16 eal: warn if thread name is truncated
In reply to Stephen HemmingerThread name is very short 16 characters and therefore the name dpdk-worker-%d will overflow with more than 9999 worker cores. Error should be non-fatal since name only matters for debug.
--- lib/eal/freebsd/eal.c | 6 ++++-- lib/eal/linux/eal.c | 6 ++++-- lib/eal/windows/eal.c | 6 ++++-- 3 files changed, 12 insertions(+), 6 deletions(-)
lib/eal/freebsd/eal.c +4 -2
@@ -690,8 +690,10 @@ rte_eal_init(int argc, char **argv)rte_panic ("Cannot create thread\n" );/* Set thread_name for aid in debugging. */ -snprintf (thread_name,sizeof (thread_name), -"dpdk-worker%d" , i); + ret =snprintf (thread_name,sizeof (thread_name),"dpdk-worker%d" , i); +if (ret >=sizeof (thread_name)) +EAL_LOG (INFO ,"Worker thread name %s truncated" , thread_name); +rte_thread_set_name (lcore_config[i].thread_id, thread_name); ret = rte_thread_set_affinity_by_id(lcore_config[i].thread_id,
lib/eal/linux/eal.c +4 -2
@@ -863,8 +863,10 @@ rte_eal_init(int argc, char **argv)rte_panic ("Cannot create thread\n" );/* Set thread_name for aid in debugging. */ -snprintf (thread_name,sizeof (thread_name), -"dpdk-worker%d" , i); + ret =snprintf (thread_name,sizeof (thread_name),"dpdk-worker%d" , i); +if (ret >=RTE_THREAD_NAME_SIZE ) +EAL_LOG (INFO ,"Worker thread name %s truncated" , thread_name); +rte_thread_set_name (lcore_config[i].thread_id, thread_name); ret = rte_thread_set_affinity_by_id(lcore_config[i].thread_id,
lib/eal/windows/eal.c +4 -2
@@ -378,8 +378,10 @@ rte_eal_init(int argc, char **argv)rte_panic ("Cannot create thread\n" );/* Set thread name for aid in debugging. */ -snprintf (thread_name,sizeof (thread_name), -"dpdk-worker%d" , i); + ret =snprintf (thread_name,sizeof (thread_name),"dpdk-worker%d" , i); +if (ret >= (int )sizeof (thread_name)) +EAL_LOG (INFO ,"Worker thread name %s truncated" , thread_name); +rte_thread_set_name (lcore_config[i].thread_id, thread_name); ret = rte_thread_set_affinity_by_id(lcore_config[i].thread_id,
Signature · 1 line
2.51.0
PATCH v4 8/16 eal: avoid format overflow when handling addresses
In reply to Stephen HemmingerThe largest possible string in this code 0xFFFFFFFFFFFFFFFF which will overflow with only 15 character buffer. Increase to 20.
--- lib/eal/common/eal_common_memory.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
lib/eal/common/eal_common_memory.c +1 -1
@@ -1153,7 +1153,7 @@ rte_eal_memory_init(void)#define EAL_MEMSEG_INFO_REQ "/eal/memseg_info"#define EAL_ELEMENT_LIST_REQ "/eal/mem_element_list"#define EAL_ELEMENT_INFO_REQ "/eal/mem_element_info" -#define ADDR_STR 15 +#define ADDR_STR 20/* 16 bytes 64 bit + 0x */ /* Telemetry callback handler to return heap stats for requested heap id. */
Signature · 1 line
2.51.0
PATCH v4 9/16 eal: add check for sysfs path overflow
In reply to Stephen HemmingerShouldn't happen but in theory sysfs socket could overflow. Add a check for it.
--- lib/eal/linux/eal_hugepage_info.c | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-)
lib/eal/linux/eal_hugepage_info.c +5 -1
@@ -150,8 +150,12 @@ get_num_hugepages_on_node(const char *subdir, unsigned int socket, size_t sz)return 0 ; } -snprintf (path,sizeof (path),"%s/%s/%s" , +if (snprintf (path,sizeof (path),"%s/%s/%s" , socketpath, subdir, nr_hp_file) >=PATH_MAX ) { +EAL_LOG (NOTICE ,"Socket path %s/%s/%s is truncated" , socketpath, subdir, nr_hp_file); +return 0 ; + } +if (eal_parse_sysfs_value (path, &num_pages) <0 )return 0 ;
Signature · 1 line
2.51.0
PATCH v4 10/16 eal: limit maximum runtime directory and socket paths
In reply to Stephen HemmingerLinux (and FreeBSD) has a limitation of 108 characters for any unix domain socket path. Therefore DPDK would not work if a really large runtime directory was used.
--- lib/eal/common/eal_common_config.c | 6 ++- lib/eal/common/eal_common_proc.c | 83 +++++++++++++++++++----------- lib/eal/common/eal_filesystem.h | 13 ++++- 3 files changed, 70 insertions(+), 32 deletions(-)
lib/eal/common/eal_common_config.c +4 -2
@@ -6,6 +6,7 @@#include <eal_export.h> #include "eal_private.h" +#include "eal_filesystem.h" #include "eal_memcfg.h" /* early configuration structure, when memory config is not mmapped */
@@ -24,7 +25,7 @@ static struct rte_config rte_config = { };/* platform-specific runtime dir */ -static char runtime_dir[PATH_MAX ]; +static char runtime_dir[UNIX_PATH_MAX ];/* internal configuration */ static struct internal_config internal_config;
@@ -39,7 +40,8 @@ rte_eal_get_runtime_dir(void)int eal_set_runtime_dir (const char *run_dir) { -if (strlcpy (runtime_dir, run_dir,PATH_MAX ) >=PATH_MAX ) { +/* runtime directory limited by maximum allowable unix domain socket */ +if (strlcpy (runtime_dir, run_dir,UNIX_PATH_MAX ) >=UNIX_PATH_MAX ) {EAL_LOG (ERR ,"Runtime directory string too long" );return -1 ; }
lib/eal/common/eal_common_proc.c +54 -29
166 lines not on this page · raw message
lib/eal/common/eal_filesystem.h +12 -1
@@ -45,10 +45,21 @@ eal_runtime_config_path(void)/** Path of primary/secondary communication unix socket file. */ #define MP_SOCKET_FNAME "mp_socket" + +#ifdef RTE_EXEC_ENV_WINDOWS +#include <winsock2.h> +#include <afunix.h> +#else +#include <sys/un.h> + +/** Maximum length of unix domain socket path. */ +#define UNIX_PATH_MAX (sizeof(((struct sockaddr_un *)0)->sun_path)) +#endif +static inline const char *eal_mp_socket_path (void ) { -static char buffer[PATH_MAX ];/* static so auto-zeroed */ +static char buffer[UNIX_PATH_MAX ];/* static so auto-zeroed */ snprintf (buffer,sizeof (buffer),"%s/%s" ,rte_eal_get_runtime_dir (),MP_SOCKET_FNAME );
Signature · 1 line
2.51.0
PATCH v4 11/16 eal: check for hugefile path overflow
In reply to Stephen HemmingerWhen constructing huge filename path, check for possible overflow of PATH_MAX.
--- lib/eal/common/eal_filesystem.h | 10 ++++--- lib/eal/linux/eal_hugepage_info.c | 44 ++++++++++++++++++------------- lib/eal/linux/eal_memalloc.c | 11 ++++++-- lib/eal/linux/eal_memory.c | 9 +++++-- 4 files changed, 48 insertions(+), 26 deletions(-)
lib/eal/common/eal_filesystem.h +6 -4
@@ -100,12 +100,14 @@ eal_hugepage_data_path(void)/** String format for hugepage map files. */ #define HUGEFILE_FMT "%s/%smap_%d" -static inline const char * +static inline __rte_warn_unused_result const char *eal_get_hugefile_path (char *buffer,size_t buflen,const char *hugedir,int f_id) { -snprintf (buffer, buflen,HUGEFILE_FMT , hugedir, -eal_get_hugefile_prefix (), f_id); -return buffer; +if (snprintf (buffer, buflen,HUGEFILE_FMT , hugedir, +eal_get_hugefile_prefix (), f_id) >= (int )buflen) +return NULL ; +else +return buffer; }/** define the default filename prefix for the %s values above */
lib/eal/linux/eal_hugepage_info.c +26 -18
100 lines not on this page · raw message
lib/eal/linux/eal_memalloc.c +9 -2
@@ -260,6 +260,7 @@ get_seg_fd(char *path, int buflen, struct hugepage_info *hi, {int fd;int *out_fd; +const char *huge_path;struct stat st;int ret; const struct internal_config *internal_conf =
@@ -276,12 +277,18 @@ get_seg_fd(char *path, int buflen, struct hugepage_info *hi,if (internal_conf->single_file_segments) { out_fd = &fd_list[list_idx].memseg_list_fd; -eal_get_hugefile_path (path, buflen, hi->hugedir, list_idx); + huge_path =eal_get_hugefile_path (path, buflen, hi->hugedir, list_idx); }else { out_fd = &fd_list[list_idx].fds[seg_idx]; -eal_get_hugefile_path (path, buflen, hi->hugedir, + huge_path =eal_get_hugefile_path (path, buflen, hi->hugedir, list_idx *RTE_MAX_MEMSEG_PER_LIST + seg_idx); } +if (huge_path ==NULL ) { +EAL_LOG (DEBUG ,"%s(): hugefile path truncated: '%s'" , + __func__, path); +return -1 ; + } + fd = *out_fd;if (fd >=0 )return fd;
lib/eal/linux/eal_memory.c +7 -2
@@ -337,8 +337,13 @@ map_all_hugepages(struct hugepage_file *hugepg_tbl, struct hugepage_info *hpi, hf->file_id = i; hf->size = hugepage_sz; -eal_get_hugefile_path (hf->filepath,sizeof (hf->filepath), - hpi->hugedir, hf->file_id); +if (eal_get_hugefile_path (hf->filepath,sizeof (hf->filepath), + hpi->hugedir, hf->file_id) ==NULL ) { +EAL_LOG (DEBUG ,"%s(): huge file path '%s' truncated" , + __func__, hf->filepath); + goto out; + } + hf->filepath[sizeof (hf->filepath) -1 ] ='\0' ;/* try to create hugepage file */
Signature · 1 line
2.51.0
PATCH v4 12/16 eal: check tailq length
In reply to Stephen HemmingerThe tailq name should not be allowed to exceed limits.
--- lib/eal/common/eal_common_tailqs.c | 5 +++++ 1 file changed, 5 insertions(+)
lib/eal/common/eal_common_tailqs.c +5 -0
@@ -67,6 +67,11 @@ rte_eal_tailq_create(const char *name) {struct rte_tailq_head *head =NULL ; +if (strlen (name) >=sizeof (head->name)) { +EAL_LOG (ERR ,"tailq name '%s' is too long" , name); +return NULL ; + } +if (!rte_eal_tailq_lookup (name) && (rte_tailqs_count +1 <RTE_MAX_TAILQ )) {struct rte_mem_config *mcfg;
Signature · 1 line
2.51.0
PATCH v4 13/16 eal: handle long shared library path
In reply to Stephen HemmingerInstead of a fixed size shared library path that could in theory get truncated when concatenating, use a dynamically allocated buffer via asprintf.
--- lib/eal/common/eal_common_options.c | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-)
lib/eal/common/eal_common_options.c +13 -4
@@ -570,7 +570,6 @@ static int eal_plugindir_init(const char *path) {struct dirent *dent =NULL ; -char sopath[PATH_MAX ];DIR *d =NULL ;if (path ==NULL || *path =='\0' )
@@ -584,19 +583,29 @@ eal_plugindir_init(const char *path) }while ((dent =readdir (d)) !=NULL ) { +char *sopath =NULL ;struct stat sb;if (!ends_with (dent->d_name,".so" ) && !ends_with (dent->d_name,".so." ABI_VERSION ))continue ; -snprintf (sopath,sizeof (sopath),"%s/%s" , path, dent->d_name); +if (asprintf (&sopath,"%s/%s" , path, dent->d_name) <0 ) { +EAL_LOG (ERR ,"failed to create full path %s/%s" , + path, dent->d_name); +continue ; + }/* if a regular file, add to list to load */ -if (!(stat (sopath, &sb) ==0 &&S_ISREG (sb.st_mode))) +if (!(stat (sopath, &sb) ==0 &&S_ISREG (sb.st_mode))) { +free (sopath);continue ; + } -if (eal_plugin_add (sopath) ==-1 ) +if (eal_plugin_add (sopath) ==-1 ) { +free (sopath);break ; + } +free (sopath); }closedir (d);
Signature · 1 line
2.51.0
PATCH v4 14/16 ethdev: avoid possible overflow in xstat names
In reply to Stephen HemmingerThe compiler doesn't know that all the elements in the table of queue stats are short enough to avoid overflowing the snprintf. Add a condition to warn if it ever does;
maybe some day a new long named queue stat could be added.
--- lib/ethdev/rte_ethdev.c | 35 ++++++++++++++++++++++++----------- 1 file changed, 24 insertions(+), 11 deletions(-)
lib/ethdev/rte_ethdev.c +24 -11
@@ -3489,9 +3489,10 @@ eth_basic_stats_get_names(struct rte_eth_dev *dev,uint16_t num_q;for (idx =0 ; idx <RTE_NB_STATS ; idx++) { -strlcpy (xstats_names[cnt_used_entries].name, - eth_dev_stats_strings[idx].name, -sizeof (xstats_names[0 ].name)); +if (strlcpy (xstats_names[cnt_used_entries].name, eth_dev_stats_strings[idx].name, +sizeof (xstats_names[0 ].name)) >=sizeof (xstats_names[0 ].name)) +RTE_ETHDEV_LOG_LINE (ERR ,"statistic name '%s' will be truncated" , + xstats_names[cnt_used_entries].name); cnt_used_entries++; }
@@ -3501,10 +3502,17 @@ eth_basic_stats_get_names(struct rte_eth_dev *dev, num_q =RTE_MIN (dev->data->nb_rx_queues,RTE_ETHDEV_QUEUE_STAT_CNTRS );for (id_queue =0 ; id_queue < num_q; id_queue++) {for (idx =0 ; idx <RTE_NB_RXQ_STATS ; idx++) { -snprintf (xstats_names[cnt_used_entries].name, -sizeof (xstats_names[0 ].name), -"rx_q%u_%s" , - id_queue, eth_dev_rxq_stats_strings[idx].name); +unsigned int cc; + + cc =snprintf (xstats_names[cnt_used_entries].name, +sizeof (xstats_names[0 ].name), +"rx_q%u_%s" , + id_queue, eth_dev_rxq_stats_strings[idx].name); + +/* could only happen if a long string was added */ +if (cc >=sizeof (xstats_names[0 ].name)) +RTE_ETHDEV_LOG_LINE (ERR ,"truncated rxq stat string '%s'" , + eth_dev_rxq_stats_strings[idx].name); cnt_used_entries++; }
@@ -3512,10 +3520,15 @@ eth_basic_stats_get_names(struct rte_eth_dev *dev, num_q =RTE_MIN (dev->data->nb_tx_queues,RTE_ETHDEV_QUEUE_STAT_CNTRS );for (id_queue =0 ; id_queue < num_q; id_queue++) {for (idx =0 ; idx <RTE_NB_TXQ_STATS ; idx++) { -snprintf (xstats_names[cnt_used_entries].name, -sizeof (xstats_names[0 ].name), -"tx_q%u_%s" , - id_queue, eth_dev_txq_stats_strings[idx].name); +unsigned int cc; + + cc =snprintf (xstats_names[cnt_used_entries].name, +sizeof (xstats_names[0 ].name), +"tx_q%u_%s" , + id_queue, eth_dev_txq_stats_strings[idx].name); +if (cc >=sizeof (xstats_names[0 ].name)) +RTE_ETHDEV_LOG_LINE (ERR ,"truncated txq stat string '%s'" , + eth_dev_txq_stats_strings[idx].name); cnt_used_entries++; } }
Signature · 1 line
2.51.0
PATCH v4 15/16 vhost: check for overflow in xstat name
In reply to Stephen HemmingerThe snprintf to format an xstat name could overflow if called with a long rte_vhost_stat_name. Check if that happens and warn.
--- lib/vhost/vhost.c | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-)
lib/vhost/vhost.c +10 -4
@@ -2200,6 +2200,7 @@ rte_vhost_vring_stats_get_names(int vid, uint16_t queue_id, {struct virtio_net *dev =get_device (vid);unsigned int i; +int ret;if (dev ==NULL )return -1 ;
@@ -2213,10 +2214,15 @@ rte_vhost_vring_stats_get_names(int vid, uint16_t queue_id,if (name ==NULL || size <VHOST_NB_VQ_STATS )return VHOST_NB_VQ_STATS ; -for (i =0 ; i <VHOST_NB_VQ_STATS ; i++) -snprintf (name[i].name,sizeof (name[i].name),"%s_q%u_%s" , - (queue_id &1 ) ?"rx" :"tx" , - queue_id /2 , vhost_vq_stat_strings[i].name); +for (i =0 ; i <VHOST_NB_VQ_STATS ; i++) { + ret =snprintf (name[i].name,sizeof (name[i].name),"%s_q%u_%s" , + (queue_id &1 ) ?"rx" :"tx" , + queue_id /2 , vhost_vq_stat_strings[i].name); +if (ret >= (int )sizeof (name[0 ].name)) +VHOST_CONFIG_LOG ("device" ,NOTICE ,"truncated xstat '%s_q%u_%s'" , + (queue_id &1 ) ?"rx" :"tx" , + queue_id /2 , vhost_vq_stat_strings[i].name); + }return VHOST_NB_VQ_STATS ; }
Signature · 1 line
2.51.0
PATCH v4 16/16 lib: enable format overflow warnings
In reply to Stephen HemmingerEnable compiler checking of format overflow
--- lib/meson.build | 4 ---- 1 file changed, 4 deletions(-)
lib/meson.build +0 -4
@@ -113,10 +113,6 @@ default_cflags = machine_args default_cflags += ['-DALLOW_EXPERIMENTAL_API'] default_cflags += ['-DALLOW_INTERNAL_API'] -if cc.has_argument('-Wno-format-truncation') - default_cflags += '-Wno-format-truncation' -endif - foreach l:libraries build = true reason = '<unknown reason>' # set if build == false to explain why
Signature · 1 line
2.51.0
v5 cover lib: fix format overflows
In reply to Stephen HemmingerChange all the libraries to find and fix cases where a string could overflow when formatting or using strclpy. This does provide early indication of possible problems where the file prefix is too long to fit in unix domain socket path, and where a hash table is being requested that has a name too long.
Stephen Hemminger (17):
eal: use C library to parse filesystem table
lpm: restrict name size
hash: add checks for hash name length
graph: avoid overflowing comment buffer
latencystats: add check for string overflow
telemetry: avoid possible string overflow
efd: handle possible name truncation
eal: warn if thread name is truncated
eal: avoid format overflow when handling addresses
eal: add check for sysfs path overflow
eal: limit maximum runtime directory and socket paths
eal: check for hugefile path overflow
eal: check tailq length
eal: handle long shared library path
ethdev: avoid possible overflow in xstat names
vhost: check for overflow in xstat name
lib: enable format overflow warnings
app/test/test_hash.c | 21 ++++++ doc/guides/rel_notes/release_26_03.rst | 3 + lib/eal/common/eal_common_config.c | 6 +- lib/eal/common/eal_common_memory.c | 2 +- lib/eal/common/eal_common_options.c | 17 +++-- lib/eal/common/eal_common_proc.c | 83 ++++++++++++++-------- lib/eal/common/eal_common_tailqs.c | 5 ++ lib/eal/common/eal_filesystem.h | 23 ++++-- lib/eal/freebsd/eal.c | 6 +- lib/eal/linux/eal.c | 6 +- lib/eal/linux/eal_hugepage_info.c | 98 ++++++++++++-------------- lib/eal/linux/eal_memalloc.c | 11 ++- lib/eal/linux/eal_memory.c | 9 ++- lib/eal/windows/eal.c | 6 +- lib/efd/rte_efd.c | 7 +- lib/ethdev/rte_ethdev.c | 35 ++++++--- lib/graph/graph_pcap.c | 9 ++- lib/hash/rte_cuckoo_hash.c | 41 +++++++---- lib/hash/rte_fbk_hash.c | 14 +++- lib/latencystats/rte_latencystats.c | 9 ++- lib/lpm/rte_lpm.c | 25 +++++-- lib/lpm/rte_lpm.h | 2 +- lib/meson.build | 4 -- lib/telemetry/telemetry_legacy.c | 37 ++++++---- lib/vhost/vhost.c | 14 ++-- 25 files changed, 325 insertions(+), 168 deletions(-)
Signature · 1 line
2.51.0
PATCH v5 1/17 eal: use C library to parse filesystem table
Rather than doing parsing of /proc/mounts with open coded string handling, use the standard C library routines.
These exist in BSD and Linux.
It also avoids any possible issues with escaped strings etc which the library handles. See getmntent(3) man page.
--- lib/eal/linux/eal_hugepage_info.c | 58 ++++++++++--------------------- 1 file changed, 18 insertions(+), 40 deletions(-)
lib/eal/linux/eal_hugepage_info.c +18 -40
@@ -13,6 +13,7 @@#include <inttypes.h> #include <unistd.h> #include <errno.h> +#include <mntent.h> #include <sys/mman.h> #include <sys/stat.h>
@@ -195,23 +196,13 @@ get_default_hp_size(void)static int get_hugepage_dir (uint64_t hugepage_sz,char *hugedir,int len) { -enum proc_mount_fieldnames { -DEVICE =0 , -MOUNTPT , -FSTYPE , -OPTIONS , - _FIELDNAME_MAX - };static uint64_t default_size =0 ;const char proc_mounts[] ="/proc/mounts" ; -const char hugetlbfs_str[] ="hugetlbfs" ; -const size_t htlbfs_str_len =sizeof (hugetlbfs_str) -1 ;const char pagesize_opt[] ="pagesize=" ;const size_t pagesize_opt_len =sizeof (pagesize_opt) -1 ; -const char split_tok =' ' ; -char *splitstr[_FIELDNAME_MAX];char found[PATH_MAX ] ="" ;char buf[BUFSIZ ]; +struct mntent entry;const struct internal_config *internal_conf =eal_get_internal_configuration (); const size_t hugepage_dir_len = (internal_conf->hugepage_dir != NULL) ?
@@ -226,56 +217,43 @@ get_hugepage_dir(uint64_t hugepage_sz, char *hugedir, int len)return -1 ; } -FILE *fd =fopen (proc_mounts,"r" ); -if (fd ==NULL ) +FILE *mounts =setmntent (proc_mounts,"r" ); +if (mounts ==NULL )rte_panic ("Cannot open %s\n" , proc_mounts);if (default_size ==0 ) default_size =get_default_hp_size (); -while (fgets (buf,sizeof (buf), fd)){ +while (getmntent_r (mounts, &entry, buf,sizeof (buf))) {const char *pagesz_str; -size_t mountpt_len =0 ; - -if (rte_strsplit (buf,sizeof (buf), splitstr, _FIELDNAME_MAX, - split_tok) != _FIELDNAME_MAX) { -EAL_LOG (ERR ,"Error parsing %s" , proc_mounts); -break ;/* return NULL */ - } +uint64_t pagesz = default_size; +size_t mountpt_len; -if (strncmp (splitstr[FSTYPE ], hugetlbfs_str, htlbfs_str_len) !=0 ) +if (strcmp (entry.mnt_type,"hugetlbfs" ) !=0 )continue ; - pagesz_str =strstr (splitstr[OPTIONS ], pagesize_opt); + pagesz_str =strstr (entry.mnt_opts, pagesize_opt); +if (pagesz_str) + pagesz =rte_str_to_size (&pagesz_str[pagesize_opt_len]); -/* if no explicit page size, the default page size is compared */ -if (pagesz_str ==NULL ) { -if (hugepage_sz != default_size) -continue ; - } -/* there is an explicit page size, so check it */ -else { -uint64_t pagesz =rte_str_to_size (&pagesz_str[pagesize_opt_len]); -if (pagesz != hugepage_sz) -continue ; - } +if (pagesz != hugepage_sz) +continue ;/* * If no --huge-dir option has been given, we're done. */ if (internal_conf->hugepage_dir ==NULL ) { -strlcpy (found, splitstr[MOUNTPT ], len); +strlcpy (found, entry.mnt_dir, len);break ; } - mountpt_len =strlen (splitstr[MOUNTPT ]); + mountpt_len =strlen (entry.mnt_dir);/* * Ignore any mount that doesn't contain the --huge-dir directory * or where mount point is not a parent path of --huge-dir */ -if (strncmp (internal_conf->hugepage_dir, splitstr[MOUNTPT ], - mountpt_len) !=0 || +if (strncmp (internal_conf->hugepage_dir, entry.mnt_dir, mountpt_len) !=0 || (hugepage_dir_len > mountpt_len && internal_conf->hugepage_dir[mountpt_len] !='/' )) {continue ;
@@ -286,10 +264,10 @@ get_hugepage_dir(uint64_t hugepage_sz, char *hugedir, int len)* (so /mnt/1 is preferred over /mnt for matching /mnt/1/2)). */ if (mountpt_len >strlen (found)) -strlcpy (found, splitstr[MOUNTPT ], len); +strlcpy (found, entry.mnt_dir, len); }/* end while fgets */ -fclose (fd); +endmntent (mounts);if (found[0 ] !='\0' ) {/* If needed, return the requested dir, not the mount point. */
Signature · 1 line
2.51.0
PATCH v5 2/17 lpm: restrict name size
In reply to Stephen HemmingerSince LPM uses ring internally with a prefix, limit the maximum allowed LPM name.
--- lib/lpm/rte_lpm.c | 25 +++++++++++++++++++------ lib/lpm/rte_lpm.h | 2 +- 2 files changed, 20 insertions(+), 7 deletions(-)
lib/lpm/rte_lpm.c +19 -6
@@ -5,6 +5,7 @@#include <string.h> #include <stdint.h> +#include <stdlib.h> #include <errno.h> #include <stdio.h> #include <sys/queue.h>
@@ -152,7 +153,6 @@ struct rte_lpm * rte_lpm_create(const char *name, int socket_id, const struct rte_lpm_config *config) { - char mem_name[RTE_LPM_NAMESIZE]; struct __rte_lpm *i_lpm;struct rte_lpm *lpm =NULL ;struct rte_tailq_entry *te;
@@ -170,7 +170,15 @@ rte_lpm_create(const char *name, int socket_id,return NULL ; } -snprintf (mem_name,sizeof (mem_name),"LPM_%s" , name); +if (strlen (name) >=RTE_LPM_NAMESIZE ) { + rte_errno =ENAMETOOLONG ; +return NULL ; + } + +/* This is only used for tracing, ok to be NULL */ +char *mem_name =NULL ; + int unused __rte_unused; + unused =asprintf (&mem_name,"LPM_%s" , name);rte_mcfg_tailq_write_lock ();
@@ -247,6 +255,7 @@ rte_lpm_create(const char *name, int socket_id, exit:rte_mcfg_tailq_write_unlock (); +free (mem_name);return lpm; }
@@ -309,7 +318,6 @@ int rte_lpm_rcu_qsbr_add(struct rte_lpm *lpm, struct rte_lpm_rcu_config *cfg) { struct rte_rcu_qsbr_dq_parameters params = {0}; -char rcu_dq_name[RTE_RCU_QSBR_DQ_NAMESIZE ];struct __rte_lpm *i_lpm;if (lpm ==NULL || cfg ==NULL ) {
@@ -326,9 +334,13 @@ rte_lpm_rcu_qsbr_add(struct rte_lpm *lpm, struct rte_lpm_rcu_config *cfg)if (cfg->mode ==RTE_LPM_QSBR_MODE_SYNC ) {/* No other things to do. */ }else if (cfg->mode ==RTE_LPM_QSBR_MODE_DQ ) { +char rcu_dq_name[RTE_RCU_QSBR_DQ_NAMESIZE ]; +/* Init QSBR defer queue. */ -snprintf (rcu_dq_name,sizeof (rcu_dq_name), -"LPM_RCU_%s" , i_lpm->name); +if (snprintf (rcu_dq_name,sizeof (rcu_dq_name), +"LPM_RCU_%s" , i_lpm->name) >= (int )sizeof (rcu_dq_name)) +LPM_LOG (NOTICE ,"LPM rcu defer queue name truncated" ); + params.name = rcu_dq_name; params.size = cfg->dq_size;if (params.size ==0 )
@@ -343,7 +355,8 @@ rte_lpm_rcu_qsbr_add(struct rte_lpm *lpm, struct rte_lpm_rcu_config *cfg) params.v = cfg->v; i_lpm->dq =rte_rcu_qsbr_dq_create (¶ms);if (i_lpm->dq ==NULL ) { -LPM_LOG (ERR ,"LPM defer queue creation failed" ); +LPM_LOG (ERR ,"LPM defer queue creation failed: %s" , +rte_strerror (rte_errno));return 1 ; } }else {
lib/lpm/rte_lpm.h +1 -1
@@ -26,7 +26,7 @@ extern "C" {#endif /** Max number of characters in LPM name. */ -#define RTE_LPM_NAMESIZE 32 +#define RTE_LPM_NAMESIZE RTE_RING_NAMESIZE/** Maximum depth value possible for IPv4 LPM. */ #define RTE_LPM_MAX_DEPTH 32
Signature · 1 line
2.51.0
PATCH v5 3/17 hash: add checks for hash name length
In reply to Stephen HemmingerAdd a missing check to the API that the name is within the current defined maximum name size. This name is then used internally to create ring names, those names could get truncated; if a name is truncated add message to log.
If ring creation fails it might be because of name conflict, so change the log message to decode error value.
Add additional tests as well.
--- app/test/test_hash.c | 21 +++++++++++++ doc/guides/rel_notes/release_26_03.rst | 3 ++ lib/hash/rte_cuckoo_hash.c | 41 ++++++++++++++++++-------- lib/hash/rte_fbk_hash.c | 14 +++++++-- 4 files changed, 65 insertions(+), 14 deletions(-)
app/test/test_hash.c +21 -0
@@ -1120,6 +1120,14 @@ fbk_hash_unit_test(void) .socket_id = RTE_MAX_NUMA_NODES + 1, /* invalid socket */ }; +/* try and create hash with an excessively long name */ +struct rte_fbk_hash_params invalid_params_long_name = { + .name ="four_byte_key_hash_name_length_32" , + .entries =4 , + .entries_per_bucket =2 , + .socket_id =0 , + }; +/* try to create two hashes with identical names * in this case, trying to create a second one will not * fail but will simply return pointer to the existing
@@ -1201,6 +1209,9 @@ fbk_hash_unit_test(void) handle =rte_fbk_hash_create (&invalid_params_7);RETURN_IF_ERROR_FBK (handle !=NULL ,"fbk hash creation should have failed" ); + handle =rte_fbk_hash_create (&invalid_params_long_name); +RETURN_IF_ERROR_FBK (handle !=NULL ,"fbk hash creation should have failed" ); +if (rte_eal_has_hugepages ()) { handle =rte_fbk_hash_create (&invalid_params_8); RETURN_IF_ERROR_FBK(handle != NULL,
@@ -1439,6 +1450,16 @@ static int test_hash_creation_with_bad_parameters(void)return -1 ; } +memcpy (¶ms, &ut_params,sizeof (params)); + params.name ="hash_creation_with_too_long_name" ; + params.socket_id =RTE_MAX_NUMA_NODES +1 ; + handle =rte_hash_create (¶ms); +if (handle !=NULL ) { +rte_hash_free (handle); +printf ("Impossible creating hash successfully with long name\n" ); +return -1 ; + } +/* test with same name should fail */ memcpy (¶ms, &ut_params,sizeof (params)); params.name ="same_name" ;
doc/guides/rel_notes/release_26_03.rst +3 -0
@@ -84,6 +84,9 @@ API Changes Also, make sure to start the actual text at the margin. ======================================================= +* hash: Added name length validation to hash creation. + The hash name in hash parameters is now checked against RTE_HASH_NAMESIZE. + ABI Changes -----------
lib/hash/rte_cuckoo_hash.c +29 -12
89 lines not on this page · raw message
lib/hash/rte_fbk_hash.c +12 -2
@@ -5,6 +5,7 @@#include <stdint.h> #include <stdio.h> #include <string.h> +#include <stdlib.h> #include <errno.h> #include <sys/queue.h>
@@ -83,7 +84,7 @@ rte_fbk_hash_create(const struct rte_fbk_hash_params *params) {struct rte_fbk_hash_table *ht =NULL ;struct rte_tailq_entry *te; -char hash_name[RTE_FBK_HASH_NAMESIZE ]; +char *hash_name =NULL ;const uint32_t mem_size =sizeof (*ht) + (sizeof (ht->t[0 ]) * params->entries);uint32_t i;
@@ -96,6 +97,7 @@ rte_fbk_hash_create(const struct rte_fbk_hash_params *params)/* Error checking of parameters. */ if ((!rte_is_power_of_2(params->entries)) || (!rte_is_power_of_2(params->entries_per_bucket)) || + (params->name == NULL) || (params->entries == 0) || (params->entries_per_bucket == 0) || (params->entries_per_bucket > params->entries) ||
@@ -105,7 +107,14 @@ rte_fbk_hash_create(const struct rte_fbk_hash_params *params)return NULL ; } -snprintf (hash_name,sizeof (hash_name),"FBK_%s" , params->name); +if (strlen (params->name) >=RTE_FBK_HASH_NAMESIZE ) { + rte_errno =ENAMETOOLONG ; +return NULL ; + } + +/* don't care if hash_name is NULL */ + int unused __rte_unused; + unused =asprintf (&hash_name,"FBK_%s" , params->name);rte_mcfg_tailq_write_lock ();
@@ -170,6 +179,7 @@ rte_fbk_hash_create(const struct rte_fbk_hash_params *params) exit:rte_mcfg_tailq_write_unlock (); +free (hash_name);return ht; }
Signature · 1 line
2.51.0
PATCH v5 4/17 graph: avoid overflowing comment buffer
In reply to Stephen HemmingerThe library builds a pcapng comment to put on each packet but the buffer is not big enough for the largest possible graph node name, etc. Change to use asprintf() to allow any string length. Note, if asprintf() fails it is better to still log the packet without comment so no data is lost.
--- lib/graph/graph_pcap.c | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-)
lib/graph/graph_pcap.c +6 -3
@@ -194,7 +194,7 @@ graph_pcap_dispatch(struct rte_graph *graph, uint16_t nb_objs) {struct rte_mbuf *mbuf_clones[RTE_GRAPH_BURST_SIZE ]; -char buffer[GRAPH_PCAP_BUF_SZ ]; +char *comment =NULL ;uint64_t i, num_packets;struct rte_mbuf *mbuf;ssize_t len;
@@ -207,19 +207,22 @@ graph_pcap_dispatch(struct rte_graph *graph,if (num_packets > nb_objs) num_packets = nb_objs; -snprintf (buffer,GRAPH_PCAP_BUF_SZ ,"%s: %s" , graph->name, node->name); +/* put a comment on all these packets */ +if (asprintf (&comment,"%s: %s" , graph->name, node->name) <0 ) +graph_err ("asprintf for comment failed." );for (i =0 ; i < num_packets; i++) {struct rte_mbuf *mc; mbuf = (struct rte_mbuf *)objs[i]; mc =rte_pcapng_copy (mbuf->port,0 , mbuf, pkt_mp, mbuf->pkt_len, -0 , buffer); +0 , comment);if (mc ==NULL )break ; mbuf_clones[i] = mc; } +free (comment);/* write it to capture file */ len =rte_pcapng_write_packets (pcapng_fd, mbuf_clones, i);
Signature · 1 line
2.51.0
PATCH v5 5/17 latencystats: add check for string overflow
In reply to Stephen HemmingerThe copy of latency stat names could get truncated if in the future a new value is added. Add warning if that happens.
--- lib/latencystats/rte_latencystats.c | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-)
lib/latencystats/rte_latencystats.c +6 -3
@@ -405,9 +405,12 @@ rte_latencystats_get_names(struct rte_metric_name *names, uint16_t size)if (names ==NULL || size <NUM_LATENCY_STATS )return NUM_LATENCY_STATS ; -for (i =0 ; i <NUM_LATENCY_STATS ; i++) -strlcpy (names[i].name, lat_stats_strings[i].name, -sizeof (names[i].name)); +for (i =0 ; i <NUM_LATENCY_STATS ; i++) { +if (strlcpy (names[i].name, lat_stats_strings[i].name,sizeof (names[0 ].name)) + >=sizeof (names[0 ].name)) +LATENCY_STATS_LOG (NOTICE ,"Latency metric '%s' too long" , + lat_stats_strings[i].name); + }return NUM_LATENCY_STATS ; }
Signature · 1 line
2.51.0
PATCH v5 6/17 telemetry: avoid possible string overflow
In reply to Stephen HemmingerWhen registering client the input parameter could have a too large unix domain path. Improve the string handling by avoiding temporary buffer, and check the length.
--- lib/telemetry/telemetry_legacy.c | 37 +++++++++++++++++++------------- 1 file changed, 22 insertions(+), 15 deletions(-)
lib/telemetry/telemetry_legacy.c +22 -15
@@ -82,34 +82,41 @@ static int register_client(const char *cmd __rte_unused, const char *params, char *buffer __rte_unused, int buf_len __rte_unused) { + const char *colon = strchr(params, ':'); + +if (colon ==NULL ) { +fprintf (stderr,"Invalid client data: missing colon\n" ); +return -1 ; + } + #ifndef RTE_EXEC_ENV_WINDOWS pthread_t th; -char data[BUF_SIZE ]; -int fd; -int rc; -struct sockaddr_un addrs; -#endif /* !RTE_EXEC_ENV_WINDOWS */ + int fd, rc; + struct sockaddr_un addrs = { .sun_family = AF_UNIX }; -if (!strchr (params,':' )) { -fprintf (stderr,"Invalid data\n" ); + if (colon[1] != '"') { + fprintf(stderr, "Invalid client data: missing quote\n"); return -1; } -#ifndef RTE_EXEC_ENV_WINDOWS - strlcpy(data, strchr(params, ':'), sizeof(data)); - memmove(data, &data[strlen(":\"")], strlen(data)); - if (!strchr(data, '\"')) { - fprintf(stderr, "Invalid client data\n"); + + const char *endquote = strchr(colon + 1, '"'); + if (endquote == NULL) { + fprintf(stderr, "Invalid client data: missing end quote\n"); + return -1; + } + + size_t len = endquote - colon + 1; + if (len == 0 || len >= sizeof(addrs.sun_path)) { + fprintf(stderr, "Invalid client data: path length\n"); return -1; } - *strchr(data, '\"') = 0; + strncpy(addrs.sun_path, colon + 1, len); fd = socket(AF_UNIX, SOCK_SEQPACKET, 0); if (fd < 0) { perror("Failed to open socket"); return -1; } - addrs.sun_family = AF_UNIX; - strlcpy(addrs.sun_path, data, sizeof(addrs.sun_path)); if (connect(fd, (struct sockaddr *)&addrs, sizeof(addrs)) == -1) { perror("\nClient connection error\n");
Signature · 1 line
2.51.0
PATCH v5 7/17 efd: handle possible name truncation
In reply to Stephen HemmingerIf the conversion of efd name to ring name gets truncated, then log it. And if the ring name than causes collision, make sure that log message includes error reason.
--- lib/efd/rte_efd.c | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-)
lib/efd/rte_efd.c +5 -2
@@ -698,12 +698,15 @@ rte_efd_create(const char *name, uint32_t max_num_rules, uint32_t key_len,TAILQ_INSERT_TAIL (efd_list, te, next);rte_mcfg_tailq_write_unlock (); -snprintf (ring_name,sizeof (ring_name),"HT_%s" , table->name); +if (snprintf (ring_name,sizeof (ring_name),"HT_%s" , table->name) + >= (int )sizeof (ring_name)) +EFD_LOG (NOTICE ,"EFD ring name truncated to '%s'" , ring_name); +/* Create ring (Dummy slot index is not enqueued) */ r =rte_ring_create (ring_name,rte_align32pow2 (table->max_num_rules), offline_cpu_socket,0 );if (r ==NULL ) { -EFD_LOG (ERR ,"memory allocation failed" ); +EFD_LOG (ERR ,"ring creation failed: %s" ,rte_strerror (rte_errno));rte_efd_free (table);return NULL ; }
Signature · 1 line
2.51.0
PATCH v5 8/17 eal: warn if thread name is truncated
In reply to Stephen HemmingerThread name is very short 16 characters and therefore the name dpdk-worker-%d will overflow with more than 9999 worker cores. Error should be non-fatal since name only matters for debug.
--- lib/eal/freebsd/eal.c | 6 ++++-- lib/eal/linux/eal.c | 6 ++++-- lib/eal/windows/eal.c | 6 ++++-- 3 files changed, 12 insertions(+), 6 deletions(-)
lib/eal/freebsd/eal.c +4 -2
@@ -690,8 +690,10 @@ rte_eal_init(int argc, char **argv)rte_panic ("Cannot create thread\n" );/* Set thread_name for aid in debugging. */ -snprintf (thread_name,sizeof (thread_name), -"dpdk-worker%d" , i); + ret =snprintf (thread_name,sizeof (thread_name),"dpdk-worker%d" , i); +if (ret >= (int )sizeof (thread_name)) +EAL_LOG (INFO ,"Worker thread name %s truncated" , thread_name); +rte_thread_set_name (lcore_config[i].thread_id, thread_name); ret = rte_thread_set_affinity_by_id(lcore_config[i].thread_id,
lib/eal/linux/eal.c +4 -2
@@ -863,8 +863,10 @@ rte_eal_init(int argc, char **argv)rte_panic ("Cannot create thread\n" );/* Set thread_name for aid in debugging. */ -snprintf (thread_name,sizeof (thread_name), -"dpdk-worker%d" , i); + ret =snprintf (thread_name,sizeof (thread_name),"dpdk-worker%d" , i); +if (ret >=RTE_THREAD_NAME_SIZE ) +EAL_LOG (INFO ,"Worker thread name %s truncated" , thread_name); +rte_thread_set_name (lcore_config[i].thread_id, thread_name); ret = rte_thread_set_affinity_by_id(lcore_config[i].thread_id,
lib/eal/windows/eal.c +4 -2
@@ -378,8 +378,10 @@ rte_eal_init(int argc, char **argv)rte_panic ("Cannot create thread\n" );/* Set thread name for aid in debugging. */ -snprintf (thread_name,sizeof (thread_name), -"dpdk-worker%d" , i); + ret =snprintf (thread_name,sizeof (thread_name),"dpdk-worker%d" , i); +if (ret >= (int )sizeof (thread_name)) +EAL_LOG (INFO ,"Worker thread name %s truncated" , thread_name); +rte_thread_set_name (lcore_config[i].thread_id, thread_name); ret = rte_thread_set_affinity_by_id(lcore_config[i].thread_id,
Signature · 1 line
2.51.0
PATCH v5 9/17 eal: avoid format overflow when handling addresses
In reply to Stephen HemmingerThe largest possible string in this code 0xFFFFFFFFFFFFFFFF which will overflow with only 15 character buffer. Increase to 20.
--- lib/eal/common/eal_common_memory.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
lib/eal/common/eal_common_memory.c +1 -1
@@ -1153,7 +1153,7 @@ rte_eal_memory_init(void)#define EAL_MEMSEG_INFO_REQ "/eal/memseg_info"#define EAL_ELEMENT_LIST_REQ "/eal/mem_element_list"#define EAL_ELEMENT_INFO_REQ "/eal/mem_element_info" -#define ADDR_STR 15 +#define ADDR_STR 20/* 16 bytes 64 bit + 0x */ /* Telemetry callback handler to return heap stats for requested heap id. */
Signature · 1 line
2.51.0
PATCH v5 10/17 eal: add check for sysfs path overflow
In reply to Stephen HemmingerShouldn't happen but in theory sysfs socket could overflow. Add a check for it.
--- lib/eal/linux/eal_hugepage_info.c | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-)
lib/eal/linux/eal_hugepage_info.c +5 -1
@@ -150,8 +150,12 @@ get_num_hugepages_on_node(const char *subdir, unsigned int socket, size_t sz)return 0 ; } -snprintf (path,sizeof (path),"%s/%s/%s" , +if (snprintf (path,sizeof (path),"%s/%s/%s" , socketpath, subdir, nr_hp_file) >=PATH_MAX ) { +EAL_LOG (NOTICE ,"Socket path %s/%s/%s is truncated" , socketpath, subdir, nr_hp_file); +return 0 ; + } +if (eal_parse_sysfs_value (path, &num_pages) <0 )return 0 ;
Signature · 1 line
2.51.0
PATCH v5 11/17 eal: limit maximum runtime directory and socket paths
In reply to Stephen HemmingerLinux (and FreeBSD) has a limitation of 108 characters for any unix domain socket path. Therefore DPDK would not work if a really large runtime directory was used.
--- lib/eal/common/eal_common_config.c | 6 ++- lib/eal/common/eal_common_proc.c | 83 +++++++++++++++++++----------- lib/eal/common/eal_filesystem.h | 13 ++++- 3 files changed, 70 insertions(+), 32 deletions(-)
lib/eal/common/eal_common_config.c +4 -2
@@ -6,6 +6,7 @@#include <eal_export.h> #include "eal_private.h" +#include "eal_filesystem.h" #include "eal_memcfg.h" /* early configuration structure, when memory config is not mmapped */
@@ -24,7 +25,7 @@ static struct rte_config rte_config = { };/* platform-specific runtime dir */ -static char runtime_dir[PATH_MAX ]; +static char runtime_dir[UNIX_PATH_MAX ];/* internal configuration */ static struct internal_config internal_config;
@@ -39,7 +40,8 @@ rte_eal_get_runtime_dir(void)int eal_set_runtime_dir (const char *run_dir) { -if (strlcpy (runtime_dir, run_dir,PATH_MAX ) >=PATH_MAX ) { +/* runtime directory limited by maximum allowable unix domain socket */ +if (strlcpy (runtime_dir, run_dir,UNIX_PATH_MAX ) >=UNIX_PATH_MAX ) {EAL_LOG (ERR ,"Runtime directory string too long" );return -1 ; }
lib/eal/common/eal_common_proc.c +54 -29
166 lines not on this page · raw message
lib/eal/common/eal_filesystem.h +12 -1
@@ -45,10 +45,21 @@ eal_runtime_config_path(void)/** Path of primary/secondary communication unix socket file. */ #define MP_SOCKET_FNAME "mp_socket" + +#ifdef RTE_EXEC_ENV_WINDOWS +#include <winsock2.h> +#include <afunix.h> +#else +#include <sys/un.h> + +/** Maximum length of unix domain socket path. */ +#define UNIX_PATH_MAX (sizeof(((struct sockaddr_un *)0)->sun_path)) +#endif +static inline const char *eal_mp_socket_path (void ) { -static char buffer[PATH_MAX ];/* static so auto-zeroed */ +static char buffer[UNIX_PATH_MAX ];/* static so auto-zeroed */ snprintf (buffer,sizeof (buffer),"%s/%s" ,rte_eal_get_runtime_dir (),MP_SOCKET_FNAME );
Signature · 1 line
2.51.0
PATCH v5 12/17 eal: check for hugefile path overflow
In reply to Stephen HemmingerWhen constructing huge filename path, check for possible overflow of PATH_MAX.
--- lib/eal/common/eal_filesystem.h | 10 ++++--- lib/eal/linux/eal_hugepage_info.c | 44 ++++++++++++++++++------------- lib/eal/linux/eal_memalloc.c | 11 ++++++-- lib/eal/linux/eal_memory.c | 9 +++++-- 4 files changed, 48 insertions(+), 26 deletions(-)
lib/eal/common/eal_filesystem.h +6 -4
@@ -100,12 +100,14 @@ eal_hugepage_data_path(void)/** String format for hugepage map files. */ #define HUGEFILE_FMT "%s/%smap_%d" -static inline const char * +static inline __rte_warn_unused_result const char *eal_get_hugefile_path (char *buffer,size_t buflen,const char *hugedir,int f_id) { -snprintf (buffer, buflen,HUGEFILE_FMT , hugedir, -eal_get_hugefile_prefix (), f_id); -return buffer; +if (snprintf (buffer, buflen,HUGEFILE_FMT , hugedir, +eal_get_hugefile_prefix (), f_id) >= (int )buflen) +return NULL ; +else +return buffer; }/** define the default filename prefix for the %s values above */
lib/eal/linux/eal_hugepage_info.c +26 -18
100 lines not on this page · raw message
lib/eal/linux/eal_memalloc.c +9 -2
@@ -260,6 +260,7 @@ get_seg_fd(char *path, int buflen, struct hugepage_info *hi, {int fd;int *out_fd; +const char *huge_path;struct stat st;int ret; const struct internal_config *internal_conf =
@@ -276,12 +277,18 @@ get_seg_fd(char *path, int buflen, struct hugepage_info *hi,if (internal_conf->single_file_segments) { out_fd = &fd_list[list_idx].memseg_list_fd; -eal_get_hugefile_path (path, buflen, hi->hugedir, list_idx); + huge_path =eal_get_hugefile_path (path, buflen, hi->hugedir, list_idx); }else { out_fd = &fd_list[list_idx].fds[seg_idx]; -eal_get_hugefile_path (path, buflen, hi->hugedir, + huge_path =eal_get_hugefile_path (path, buflen, hi->hugedir, list_idx *RTE_MAX_MEMSEG_PER_LIST + seg_idx); } +if (huge_path ==NULL ) { +EAL_LOG (DEBUG ,"%s(): hugefile path truncated: '%s'" , + __func__, path); +return -1 ; + } + fd = *out_fd;if (fd >=0 )return fd;
lib/eal/linux/eal_memory.c +7 -2
@@ -337,8 +337,13 @@ map_all_hugepages(struct hugepage_file *hugepg_tbl, struct hugepage_info *hpi, hf->file_id = i; hf->size = hugepage_sz; -eal_get_hugefile_path (hf->filepath,sizeof (hf->filepath), - hpi->hugedir, hf->file_id); +if (eal_get_hugefile_path (hf->filepath,sizeof (hf->filepath), + hpi->hugedir, hf->file_id) ==NULL ) { +EAL_LOG (DEBUG ,"%s(): huge file path '%s' truncated" , + __func__, hf->filepath); + goto out; + } + hf->filepath[sizeof (hf->filepath) -1 ] ='\0' ;/* try to create hugepage file */
Signature · 1 line
2.51.0
PATCH v5 13/17 eal: check tailq length
In reply to Stephen HemmingerThe tailq name should not be allowed to exceed limits.
--- lib/eal/common/eal_common_tailqs.c | 5 +++++ 1 file changed, 5 insertions(+)
lib/eal/common/eal_common_tailqs.c +5 -0
@@ -67,6 +67,11 @@ rte_eal_tailq_create(const char *name) {struct rte_tailq_head *head =NULL ; +if (strlen (name) >=sizeof (head->name)) { +EAL_LOG (ERR ,"tailq name '%s' is too long" , name); +return NULL ; + } +if (!rte_eal_tailq_lookup (name) && (rte_tailqs_count +1 <RTE_MAX_TAILQ )) {struct rte_mem_config *mcfg;
Signature · 1 line
2.51.0
PATCH v5 14/17 eal: handle long shared library path
In reply to Stephen HemmingerInstead of a fixed size shared library path that could in theory get truncated when concatenating, use a dynamically allocated buffer via asprintf.
--- lib/eal/common/eal_common_options.c | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-)
lib/eal/common/eal_common_options.c +13 -4
@@ -570,7 +570,6 @@ static int eal_plugindir_init(const char *path) {struct dirent *dent =NULL ; -char sopath[PATH_MAX ];DIR *d =NULL ;if (path ==NULL || *path =='\0' )
@@ -584,19 +583,29 @@ eal_plugindir_init(const char *path) }while ((dent =readdir (d)) !=NULL ) { +char *sopath =NULL ;struct stat sb;if (!ends_with (dent->d_name,".so" ) && !ends_with (dent->d_name,".so." ABI_VERSION ))continue ; -snprintf (sopath,sizeof (sopath),"%s/%s" , path, dent->d_name); +if (asprintf (&sopath,"%s/%s" , path, dent->d_name) <0 ) { +EAL_LOG (ERR ,"failed to create full path %s/%s" , + path, dent->d_name); +continue ; + }/* if a regular file, add to list to load */ -if (!(stat (sopath, &sb) ==0 &&S_ISREG (sb.st_mode))) +if (!(stat (sopath, &sb) ==0 &&S_ISREG (sb.st_mode))) { +free (sopath);continue ; + } -if (eal_plugin_add (sopath) ==-1 ) +if (eal_plugin_add (sopath) ==-1 ) { +free (sopath);break ; + } +free (sopath); }closedir (d);
Signature · 1 line
2.51.0
PATCH v5 15/17 ethdev: avoid possible overflow in xstat names
In reply to Stephen HemmingerThe compiler doesn't know that all the elements in the table of queue stats are short enough to avoid overflowing the snprintf. Add a condition to warn if it ever does;
maybe some day a new long named queue stat could be added.
--- lib/ethdev/rte_ethdev.c | 35 ++++++++++++++++++++++++----------- 1 file changed, 24 insertions(+), 11 deletions(-)
lib/ethdev/rte_ethdev.c +24 -11
@@ -3489,9 +3489,10 @@ eth_basic_stats_get_names(struct rte_eth_dev *dev,uint16_t num_q;for (idx =0 ; idx <RTE_NB_STATS ; idx++) { -strlcpy (xstats_names[cnt_used_entries].name, - eth_dev_stats_strings[idx].name, -sizeof (xstats_names[0 ].name)); +if (strlcpy (xstats_names[cnt_used_entries].name, eth_dev_stats_strings[idx].name, +sizeof (xstats_names[0 ].name)) >=sizeof (xstats_names[0 ].name)) +RTE_ETHDEV_LOG_LINE (ERR ,"statistic name '%s' will be truncated" , + xstats_names[cnt_used_entries].name); cnt_used_entries++; }
@@ -3501,10 +3502,17 @@ eth_basic_stats_get_names(struct rte_eth_dev *dev, num_q =RTE_MIN (dev->data->nb_rx_queues,RTE_ETHDEV_QUEUE_STAT_CNTRS );for (id_queue =0 ; id_queue < num_q; id_queue++) {for (idx =0 ; idx <RTE_NB_RXQ_STATS ; idx++) { -snprintf (xstats_names[cnt_used_entries].name, -sizeof (xstats_names[0 ].name), -"rx_q%u_%s" , - id_queue, eth_dev_rxq_stats_strings[idx].name); +unsigned int cc; + + cc =snprintf (xstats_names[cnt_used_entries].name, +sizeof (xstats_names[0 ].name), +"rx_q%u_%s" , + id_queue, eth_dev_rxq_stats_strings[idx].name); + +/* could only happen if a long string was added */ +if (cc >=sizeof (xstats_names[0 ].name)) +RTE_ETHDEV_LOG_LINE (ERR ,"truncated rxq stat string '%s'" , + eth_dev_rxq_stats_strings[idx].name); cnt_used_entries++; }
@@ -3512,10 +3520,15 @@ eth_basic_stats_get_names(struct rte_eth_dev *dev, num_q =RTE_MIN (dev->data->nb_tx_queues,RTE_ETHDEV_QUEUE_STAT_CNTRS );for (id_queue =0 ; id_queue < num_q; id_queue++) {for (idx =0 ; idx <RTE_NB_TXQ_STATS ; idx++) { -snprintf (xstats_names[cnt_used_entries].name, -sizeof (xstats_names[0 ].name), -"tx_q%u_%s" , - id_queue, eth_dev_txq_stats_strings[idx].name); +unsigned int cc; + + cc =snprintf (xstats_names[cnt_used_entries].name, +sizeof (xstats_names[0 ].name), +"tx_q%u_%s" , + id_queue, eth_dev_txq_stats_strings[idx].name); +if (cc >=sizeof (xstats_names[0 ].name)) +RTE_ETHDEV_LOG_LINE (ERR ,"truncated txq stat string '%s'" , + eth_dev_txq_stats_strings[idx].name); cnt_used_entries++; } }
Signature · 1 line
2.51.0
PATCH v5 16/17 vhost: check for overflow in xstat name
In reply to Stephen HemmingerThe snprintf to format an xstat name could overflow if called with a long rte_vhost_stat_name. Check if that happens and warn.
--- lib/vhost/vhost.c | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-)
lib/vhost/vhost.c +10 -4
@@ -2200,6 +2200,7 @@ rte_vhost_vring_stats_get_names(int vid, uint16_t queue_id, {struct virtio_net *dev =get_device (vid);unsigned int i; +int ret;if (dev ==NULL )return -1 ;
@@ -2213,10 +2214,15 @@ rte_vhost_vring_stats_get_names(int vid, uint16_t queue_id,if (name ==NULL || size <VHOST_NB_VQ_STATS )return VHOST_NB_VQ_STATS ; -for (i =0 ; i <VHOST_NB_VQ_STATS ; i++) -snprintf (name[i].name,sizeof (name[i].name),"%s_q%u_%s" , - (queue_id &1 ) ?"rx" :"tx" , - queue_id /2 , vhost_vq_stat_strings[i].name); +for (i =0 ; i <VHOST_NB_VQ_STATS ; i++) { + ret =snprintf (name[i].name,sizeof (name[i].name),"%s_q%u_%s" , + (queue_id &1 ) ?"rx" :"tx" , + queue_id /2 , vhost_vq_stat_strings[i].name); +if (ret >= (int )sizeof (name[0 ].name)) +VHOST_CONFIG_LOG ("device" ,NOTICE ,"truncated xstat '%s_q%u_%s'" , + (queue_id &1 ) ?"rx" :"tx" , + queue_id /2 , vhost_vq_stat_strings[i].name); + }return VHOST_NB_VQ_STATS ; }
Signature · 1 line
2.51.0
PATCH v5 17/17 lib: enable format overflow warnings
In reply to Stephen HemmingerEnable compiler checking of format overflow
--- lib/meson.build | 4 ---- 1 file changed, 4 deletions(-)
lib/meson.build +0 -4
@@ -113,10 +113,6 @@ default_cflags = machine_args default_cflags += ['-DALLOW_EXPERIMENTAL_API'] default_cflags += ['-DALLOW_INTERNAL_API'] -if cc.has_argument('-Wno-format-truncation') - default_cflags += '-Wno-format-truncation' -endif - foreach l:libraries build = true reason = '<unknown reason>' # set if build == false to explain why
Signature · 1 line
2.51.0
Re: [PATCH v5 00/17] lib: fix format overflows
In reply to Stephen HemmingerRecheck-request: iol-intel-Performance
Re: [PATCH v5 00/17] lib: fix format overflows
There are a number more fixes needed.
Unfortunately all compilers and arch seem to hit different snags
Quoted 2 lines · On Wed, Dec 17, 2025, 08:22 Patrick Robb <[email protected]> wrote:
Recheck-request: iol-intel-Performance
v6 cover lib: fix format overflows
In reply to Stephen HemmingerChange all the libraries to find and fix cases where a string could overflow when formatting or using strclpy. This does provide early indication of possible problems where the file prefix is too long to fit in unix domain socket path, and where a hash table is being requested that has a name too long.
v6 - rebase and add length checks to cfgfile
Stephen Hemminger (18):
lpm: restrict name size
hash: add checks for hash name length
graph: avoid overflowing comment buffer
latencystats: add check for string overflow
telemetry: avoid possible string overflow
efd: handle possible name truncation
eal: use C library to parse filesystem table
eal: warn if thread name is truncated
eal: avoid format overflow when handling addresses
eal: add check for sysfs path overflow
eal: limit maximum runtime directory and socket paths
eal: check for hugefile path overflow
eal: check tailq length
eal: handle long shared library path
ethdev: avoid possible overflow in xstat names
vhost: check for overflow in xstat name
cfgfile: add length checks and increase line buffer
lib: enable format overflow warnings
app/test/test_hash.c | 21 ++++++ doc/guides/rel_notes/release_26_03.rst | 3 + lib/cfgfile/rte_cfgfile.c | 36 +++++++--- lib/eal/common/eal_common_config.c | 6 +- lib/eal/common/eal_common_memory.c | 2 +- lib/eal/common/eal_common_options.c | 17 +++-- lib/eal/common/eal_common_proc.c | 83 ++++++++++++++-------- lib/eal/common/eal_common_tailqs.c | 5 ++ lib/eal/common/eal_filesystem.h | 23 ++++-- lib/eal/freebsd/eal.c | 6 +- lib/eal/linux/eal.c | 6 +- lib/eal/linux/eal_hugepage_info.c | 98 ++++++++++++-------------- lib/eal/linux/eal_memalloc.c | 11 ++- lib/eal/linux/eal_memory.c | 9 ++- lib/eal/windows/eal.c | 6 +- lib/efd/rte_efd.c | 7 +- lib/ethdev/rte_ethdev.c | 35 ++++++--- lib/graph/graph_pcap.c | 9 ++- lib/hash/rte_cuckoo_hash.c | 41 +++++++---- lib/hash/rte_fbk_hash.c | 14 +++- lib/latencystats/rte_latencystats.c | 9 ++- lib/lpm/rte_lpm.c | 25 +++++-- lib/lpm/rte_lpm.h | 2 +- lib/meson.build | 4 -- lib/telemetry/telemetry_legacy.c | 37 ++++++---- lib/vhost/vhost.c | 14 ++-- 26 files changed, 352 insertions(+), 177 deletions(-)
Signature · 1 line
2.51.0
PATCH v6 1/18 lpm: restrict name size
Since LPM uses ring internally with a prefix, limit the maximum allowed LPM name.
--- lib/lpm/rte_lpm.c | 25 +++++++++++++++++++------ lib/lpm/rte_lpm.h | 2 +- 2 files changed, 20 insertions(+), 7 deletions(-)
lib/lpm/rte_lpm.c +19 -6
@@ -5,6 +5,7 @@#include <string.h> #include <stdint.h> +#include <stdlib.h> #include <errno.h> #include <stdio.h> #include <sys/queue.h>
@@ -152,7 +153,6 @@ struct rte_lpm * rte_lpm_create(const char *name, int socket_id, const struct rte_lpm_config *config) { - char mem_name[RTE_LPM_NAMESIZE]; struct __rte_lpm *i_lpm;struct rte_lpm *lpm =NULL ;struct rte_tailq_entry *te;
@@ -170,7 +170,15 @@ rte_lpm_create(const char *name, int socket_id,return NULL ; } -snprintf (mem_name,sizeof (mem_name),"LPM_%s" , name); +if (strlen (name) >=RTE_LPM_NAMESIZE ) { + rte_errno =ENAMETOOLONG ; +return NULL ; + } + +/* This is only used for tracing, ok to be NULL */ +char *mem_name =NULL ; + int unused __rte_unused; + unused =asprintf (&mem_name,"LPM_%s" , name);rte_mcfg_tailq_write_lock ();
@@ -247,6 +255,7 @@ rte_lpm_create(const char *name, int socket_id, exit:rte_mcfg_tailq_write_unlock (); +free (mem_name);return lpm; }
@@ -309,7 +318,6 @@ int rte_lpm_rcu_qsbr_add(struct rte_lpm *lpm, struct rte_lpm_rcu_config *cfg) { struct rte_rcu_qsbr_dq_parameters params = {0}; -char rcu_dq_name[RTE_RCU_QSBR_DQ_NAMESIZE ];struct __rte_lpm *i_lpm;if (lpm ==NULL || cfg ==NULL ) {
@@ -326,9 +334,13 @@ rte_lpm_rcu_qsbr_add(struct rte_lpm *lpm, struct rte_lpm_rcu_config *cfg)if (cfg->mode ==RTE_LPM_QSBR_MODE_SYNC ) {/* No other things to do. */ }else if (cfg->mode ==RTE_LPM_QSBR_MODE_DQ ) { +char rcu_dq_name[RTE_RCU_QSBR_DQ_NAMESIZE ]; +/* Init QSBR defer queue. */ -snprintf (rcu_dq_name,sizeof (rcu_dq_name), -"LPM_RCU_%s" , i_lpm->name); +if (snprintf (rcu_dq_name,sizeof (rcu_dq_name), +"LPM_RCU_%s" , i_lpm->name) >= (int )sizeof (rcu_dq_name)) +LPM_LOG (NOTICE ,"LPM rcu defer queue name truncated" ); + params.name = rcu_dq_name; params.size = cfg->dq_size;if (params.size ==0 )
@@ -343,7 +355,8 @@ rte_lpm_rcu_qsbr_add(struct rte_lpm *lpm, struct rte_lpm_rcu_config *cfg) params.v = cfg->v; i_lpm->dq =rte_rcu_qsbr_dq_create (¶ms);if (i_lpm->dq ==NULL ) { -LPM_LOG (ERR ,"LPM defer queue creation failed" ); +LPM_LOG (ERR ,"LPM defer queue creation failed: %s" , +rte_strerror (rte_errno));return 1 ; } }else {
lib/lpm/rte_lpm.h +1 -1
@@ -26,7 +26,7 @@ extern "C" {#endif /** Max number of characters in LPM name. */ -#define RTE_LPM_NAMESIZE 32 +#define RTE_LPM_NAMESIZE RTE_RING_NAMESIZE/** Maximum depth value possible for IPv4 LPM. */ #define RTE_LPM_MAX_DEPTH 32
Signature · 1 line
2.51.0
PATCH v6 2/18 hash: add checks for hash name length
In reply to Stephen HemmingerAdd a missing check to the API that the name is within the current defined maximum name size. This name is then used internally to create ring names, those names could get truncated; if a name is truncated add message to log.
If ring creation fails it might be because of name conflict, so change the log message to decode error value.
Add additional tests as well.
--- app/test/test_hash.c | 21 +++++++++++++ doc/guides/rel_notes/release_26_03.rst | 3 ++ lib/hash/rte_cuckoo_hash.c | 41 ++++++++++++++++++-------- lib/hash/rte_fbk_hash.c | 14 +++++++-- 4 files changed, 65 insertions(+), 14 deletions(-)
app/test/test_hash.c +21 -0
@@ -1120,6 +1120,14 @@ fbk_hash_unit_test(void) .socket_id = RTE_MAX_NUMA_NODES + 1, /* invalid socket */ }; +/* try and create hash with an excessively long name */ +struct rte_fbk_hash_params invalid_params_long_name = { + .name ="four_byte_key_hash_name_length_32" , + .entries =4 , + .entries_per_bucket =2 , + .socket_id =0 , + }; +/* try to create two hashes with identical names * in this case, trying to create a second one will not * fail but will simply return pointer to the existing
@@ -1201,6 +1209,9 @@ fbk_hash_unit_test(void) handle =rte_fbk_hash_create (&invalid_params_7);RETURN_IF_ERROR_FBK (handle !=NULL ,"fbk hash creation should have failed" ); + handle =rte_fbk_hash_create (&invalid_params_long_name); +RETURN_IF_ERROR_FBK (handle !=NULL ,"fbk hash creation should have failed" ); +if (rte_eal_has_hugepages ()) { handle =rte_fbk_hash_create (&invalid_params_8); RETURN_IF_ERROR_FBK(handle != NULL,
@@ -1439,6 +1450,16 @@ static int test_hash_creation_with_bad_parameters(void)return -1 ; } +memcpy (¶ms, &ut_params,sizeof (params)); + params.name ="hash_creation_with_too_long_name" ; + params.socket_id =RTE_MAX_NUMA_NODES +1 ; + handle =rte_hash_create (¶ms); +if (handle !=NULL ) { +rte_hash_free (handle); +printf ("Impossible creating hash successfully with long name\n" ); +return -1 ; + } +/* test with same name should fail */ memcpy (¶ms, &ut_params,sizeof (params)); params.name ="same_name" ;
doc/guides/rel_notes/release_26_03.rst +3 -0
@@ -84,6 +84,9 @@ API Changes Also, make sure to start the actual text at the margin. ======================================================= +* hash: Added name length validation to hash creation. + The hash name in hash parameters is now checked against RTE_HASH_NAMESIZE. + ABI Changes -----------
lib/hash/rte_cuckoo_hash.c +29 -12
89 lines not on this page · raw message
lib/hash/rte_fbk_hash.c +12 -2
@@ -5,6 +5,7 @@#include <stdint.h> #include <stdio.h> #include <string.h> +#include <stdlib.h> #include <errno.h> #include <sys/queue.h>
@@ -83,7 +84,7 @@ rte_fbk_hash_create(const struct rte_fbk_hash_params *params) {struct rte_fbk_hash_table *ht =NULL ;struct rte_tailq_entry *te; -char hash_name[RTE_FBK_HASH_NAMESIZE ]; +char *hash_name =NULL ;const uint32_t mem_size =sizeof (*ht) + (sizeof (ht->t[0 ]) * params->entries);uint32_t i;
@@ -96,6 +97,7 @@ rte_fbk_hash_create(const struct rte_fbk_hash_params *params)/* Error checking of parameters. */ if ((!rte_is_power_of_2(params->entries)) || (!rte_is_power_of_2(params->entries_per_bucket)) || + (params->name == NULL) || (params->entries == 0) || (params->entries_per_bucket == 0) || (params->entries_per_bucket > params->entries) ||
@@ -105,7 +107,14 @@ rte_fbk_hash_create(const struct rte_fbk_hash_params *params)return NULL ; } -snprintf (hash_name,sizeof (hash_name),"FBK_%s" , params->name); +if (strlen (params->name) >=RTE_FBK_HASH_NAMESIZE ) { + rte_errno =ENAMETOOLONG ; +return NULL ; + } + +/* don't care if hash_name is NULL */ + int unused __rte_unused; + unused =asprintf (&hash_name,"FBK_%s" , params->name);rte_mcfg_tailq_write_lock ();
@@ -170,6 +179,7 @@ rte_fbk_hash_create(const struct rte_fbk_hash_params *params) exit:rte_mcfg_tailq_write_unlock (); +free (hash_name);return ht; }
Signature · 1 line
2.51.0
PATCH v6 3/18 graph: avoid overflowing comment buffer
In reply to Stephen HemmingerThe library builds a pcapng comment to put on each packet but the buffer is not big enough for the largest possible graph node name, etc. Change to use asprintf() to allow any string length. Note, if asprintf() fails it is better to still log the packet without comment so no data is lost.
--- lib/graph/graph_pcap.c | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-)
lib/graph/graph_pcap.c +6 -3
@@ -194,7 +194,7 @@ graph_pcap_dispatch(struct rte_graph *graph, uint16_t nb_objs) {struct rte_mbuf *mbuf_clones[RTE_GRAPH_BURST_SIZE ]; -char buffer[GRAPH_PCAP_BUF_SZ ]; +char *comment =NULL ;uint64_t i, num_packets;struct rte_mbuf *mbuf;ssize_t len;
@@ -207,19 +207,22 @@ graph_pcap_dispatch(struct rte_graph *graph,if (num_packets > nb_objs) num_packets = nb_objs; -snprintf (buffer,GRAPH_PCAP_BUF_SZ ,"%s: %s" , graph->name, node->name); +/* put a comment on all these packets */ +if (asprintf (&comment,"%s: %s" , graph->name, node->name) <0 ) +graph_err ("asprintf for comment failed." );for (i =0 ; i < num_packets; i++) {struct rte_mbuf *mc; mbuf = (struct rte_mbuf *)objs[i]; mc =rte_pcapng_copy (mbuf->port,0 , mbuf, pkt_mp, mbuf->pkt_len, -0 , buffer); +0 , comment);if (mc ==NULL )break ; mbuf_clones[i] = mc; } +free (comment);/* write it to capture file */ len =rte_pcapng_write_packets (pcapng_fd, mbuf_clones, i);
Signature · 1 line
2.51.0
PATCH v6 4/18 latencystats: add check for string overflow
In reply to Stephen HemmingerThe copy of latency stat names could get truncated if in the future a new value is added. Add warning if that happens.
--- lib/latencystats/rte_latencystats.c | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-)
lib/latencystats/rte_latencystats.c +6 -3
@@ -405,9 +405,12 @@ rte_latencystats_get_names(struct rte_metric_name *names, uint16_t size)if (names ==NULL || size <NUM_LATENCY_STATS )return NUM_LATENCY_STATS ; -for (i =0 ; i <NUM_LATENCY_STATS ; i++) -strlcpy (names[i].name, lat_stats_strings[i].name, -sizeof (names[i].name)); +for (i =0 ; i <NUM_LATENCY_STATS ; i++) { +if (strlcpy (names[i].name, lat_stats_strings[i].name,sizeof (names[0 ].name)) + >=sizeof (names[0 ].name)) +LATENCY_STATS_LOG (NOTICE ,"Latency metric '%s' too long" , + lat_stats_strings[i].name); + }return NUM_LATENCY_STATS ; }
Signature · 1 line
2.51.0
PATCH v6 5/18 telemetry: avoid possible string overflow
In reply to Stephen HemmingerWhen registering client the input parameter could have a too large unix domain path. Improve the string handling by avoiding temporary buffer, and check the length.
--- lib/telemetry/telemetry_legacy.c | 37 +++++++++++++++++++------------- 1 file changed, 22 insertions(+), 15 deletions(-)
lib/telemetry/telemetry_legacy.c +22 -15
@@ -82,34 +82,41 @@ static int register_client(const char *cmd __rte_unused, const char *params, char *buffer __rte_unused, int buf_len __rte_unused) { + const char *colon = strchr(params, ':'); + +if (colon ==NULL ) { +fprintf (stderr,"Invalid client data: missing colon\n" ); +return -1 ; + } + #ifndef RTE_EXEC_ENV_WINDOWS pthread_t th; -char data[BUF_SIZE ]; -int fd; -int rc; -struct sockaddr_un addrs; -#endif /* !RTE_EXEC_ENV_WINDOWS */ + int fd, rc; + struct sockaddr_un addrs = { .sun_family = AF_UNIX }; -if (!strchr (params,':' )) { -fprintf (stderr,"Invalid data\n" ); + if (colon[1] != '"') { + fprintf(stderr, "Invalid client data: missing quote\n"); return -1; } -#ifndef RTE_EXEC_ENV_WINDOWS - strlcpy(data, strchr(params, ':'), sizeof(data)); - memmove(data, &data[strlen(":\"")], strlen(data)); - if (!strchr(data, '\"')) { - fprintf(stderr, "Invalid client data\n"); + + const char *endquote = strchr(colon + 1, '"'); + if (endquote == NULL) { + fprintf(stderr, "Invalid client data: missing end quote\n"); + return -1; + } + + size_t len = endquote - colon + 1; + if (len == 0 || len >= sizeof(addrs.sun_path)) { + fprintf(stderr, "Invalid client data: path length\n"); return -1; } - *strchr(data, '\"') = 0; + strncpy(addrs.sun_path, colon + 1, len); fd = socket(AF_UNIX, SOCK_SEQPACKET, 0); if (fd < 0) { perror("Failed to open socket"); return -1; } - addrs.sun_family = AF_UNIX; - strlcpy(addrs.sun_path, data, sizeof(addrs.sun_path)); if (connect(fd, (struct sockaddr *)&addrs, sizeof(addrs)) == -1) { perror("\nClient connection error\n");
Signature · 1 line
2.51.0
PATCH v6 6/18 efd: handle possible name truncation
In reply to Stephen HemmingerIf the conversion of efd name to ring name gets truncated, then log it. And if the ring name than causes collision, make sure that log message includes error reason.
--- lib/efd/rte_efd.c | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-)
lib/efd/rte_efd.c +5 -2
@@ -698,12 +698,15 @@ rte_efd_create(const char *name, uint32_t max_num_rules, uint32_t key_len,TAILQ_INSERT_TAIL (efd_list, te, next);rte_mcfg_tailq_write_unlock (); -snprintf (ring_name,sizeof (ring_name),"HT_%s" , table->name); +if (snprintf (ring_name,sizeof (ring_name),"HT_%s" , table->name) + >= (int )sizeof (ring_name)) +EFD_LOG (NOTICE ,"EFD ring name truncated to '%s'" , ring_name); +/* Create ring (Dummy slot index is not enqueued) */ r =rte_ring_create (ring_name,rte_align32pow2 (table->max_num_rules), offline_cpu_socket,0 );if (r ==NULL ) { -EFD_LOG (ERR ,"memory allocation failed" ); +EFD_LOG (ERR ,"ring creation failed: %s" ,rte_strerror (rte_errno));rte_efd_free (table);return NULL ; }
Signature · 1 line
2.51.0
PATCH v6 7/18 eal: use C library to parse filesystem table
In reply to Stephen HemmingerRather than doing parsing of /proc/mounts with open coded string handling, use the standard C library routines.
These exist in BSD and Linux.
It also avoids any possible issues with escaped strings etc which the library handles. See getmntent(3) man page.
--- lib/eal/linux/eal_hugepage_info.c | 58 ++++++++++--------------------- 1 file changed, 18 insertions(+), 40 deletions(-)
lib/eal/linux/eal_hugepage_info.c +18 -40
@@ -13,6 +13,7 @@#include <inttypes.h> #include <unistd.h> #include <errno.h> +#include <mntent.h> #include <sys/mman.h> #include <sys/stat.h>
@@ -195,23 +196,13 @@ get_default_hp_size(void)static int get_hugepage_dir (uint64_t hugepage_sz,char *hugedir,int len) { -enum proc_mount_fieldnames { -DEVICE =0 , -MOUNTPT , -FSTYPE , -OPTIONS , - _FIELDNAME_MAX - };static uint64_t default_size =0 ;const char proc_mounts[] ="/proc/mounts" ; -const char hugetlbfs_str[] ="hugetlbfs" ; -const size_t htlbfs_str_len =sizeof (hugetlbfs_str) -1 ;const char pagesize_opt[] ="pagesize=" ;const size_t pagesize_opt_len =sizeof (pagesize_opt) -1 ; -const char split_tok =' ' ; -char *splitstr[_FIELDNAME_MAX];char found[PATH_MAX ] ="" ;char buf[BUFSIZ ]; +struct mntent entry;const struct internal_config *internal_conf =eal_get_internal_configuration (); const size_t hugepage_dir_len = (internal_conf->hugepage_dir != NULL) ?
@@ -226,56 +217,43 @@ get_hugepage_dir(uint64_t hugepage_sz, char *hugedir, int len)return -1 ; } -FILE *fd =fopen (proc_mounts,"r" ); -if (fd ==NULL ) +FILE *mounts =setmntent (proc_mounts,"r" ); +if (mounts ==NULL )rte_panic ("Cannot open %s\n" , proc_mounts);if (default_size ==0 ) default_size =get_default_hp_size (); -while (fgets (buf,sizeof (buf), fd)){ +while (getmntent_r (mounts, &entry, buf,sizeof (buf))) {const char *pagesz_str; -size_t mountpt_len =0 ; - -if (rte_strsplit (buf,sizeof (buf), splitstr, _FIELDNAME_MAX, - split_tok) != _FIELDNAME_MAX) { -EAL_LOG (ERR ,"Error parsing %s" , proc_mounts); -break ;/* return NULL */ - } +uint64_t pagesz = default_size; +size_t mountpt_len; -if (strncmp (splitstr[FSTYPE ], hugetlbfs_str, htlbfs_str_len) !=0 ) +if (strcmp (entry.mnt_type,"hugetlbfs" ) !=0 )continue ; - pagesz_str =strstr (splitstr[OPTIONS ], pagesize_opt); + pagesz_str =strstr (entry.mnt_opts, pagesize_opt); +if (pagesz_str) + pagesz =rte_str_to_size (&pagesz_str[pagesize_opt_len]); -/* if no explicit page size, the default page size is compared */ -if (pagesz_str ==NULL ) { -if (hugepage_sz != default_size) -continue ; - } -/* there is an explicit page size, so check it */ -else { -uint64_t pagesz =rte_str_to_size (&pagesz_str[pagesize_opt_len]); -if (pagesz != hugepage_sz) -continue ; - } +if (pagesz != hugepage_sz) +continue ;/* * If no --huge-dir option has been given, we're done. */ if (internal_conf->hugepage_dir ==NULL ) { -strlcpy (found, splitstr[MOUNTPT ], len); +strlcpy (found, entry.mnt_dir, len);break ; } - mountpt_len =strlen (splitstr[MOUNTPT ]); + mountpt_len =strlen (entry.mnt_dir);/* * Ignore any mount that doesn't contain the --huge-dir directory * or where mount point is not a parent path of --huge-dir */ -if (strncmp (internal_conf->hugepage_dir, splitstr[MOUNTPT ], - mountpt_len) !=0 || +if (strncmp (internal_conf->hugepage_dir, entry.mnt_dir, mountpt_len) !=0 || (hugepage_dir_len > mountpt_len && internal_conf->hugepage_dir[mountpt_len] !='/' )) {continue ;
@@ -286,10 +264,10 @@ get_hugepage_dir(uint64_t hugepage_sz, char *hugedir, int len)* (so /mnt/1 is preferred over /mnt for matching /mnt/1/2)). */ if (mountpt_len >strlen (found)) -strlcpy (found, splitstr[MOUNTPT ], len); +strlcpy (found, entry.mnt_dir, len); }/* end while fgets */ -fclose (fd); +endmntent (mounts);if (found[0 ] !='\0' ) {/* If needed, return the requested dir, not the mount point. */
Signature · 1 line
2.51.0
PATCH v6 8/18 eal: warn if thread name is truncated
In reply to Stephen HemmingerThread name is very short 16 characters and therefore the name dpdk-worker-%d will overflow with more than 9999 worker cores. Error should be non-fatal since name only matters for debug.
--- lib/eal/freebsd/eal.c | 6 ++++-- lib/eal/linux/eal.c | 6 ++++-- lib/eal/windows/eal.c | 6 ++++-- 3 files changed, 12 insertions(+), 6 deletions(-)
lib/eal/freebsd/eal.c +4 -2
@@ -690,8 +690,10 @@ rte_eal_init(int argc, char **argv)rte_panic ("Cannot create thread\n" );/* Set thread_name for aid in debugging. */ -snprintf (thread_name,sizeof (thread_name), -"dpdk-worker%d" , i); + ret =snprintf (thread_name,sizeof (thread_name),"dpdk-worker%d" , i); +if (ret >= (int )sizeof (thread_name)) +EAL_LOG (INFO ,"Worker thread name %s truncated" , thread_name); +rte_thread_set_name (lcore_config[i].thread_id, thread_name); ret = rte_thread_set_affinity_by_id(lcore_config[i].thread_id,
lib/eal/linux/eal.c +4 -2
@@ -863,8 +863,10 @@ rte_eal_init(int argc, char **argv)rte_panic ("Cannot create thread\n" );/* Set thread_name for aid in debugging. */ -snprintf (thread_name,sizeof (thread_name), -"dpdk-worker%d" , i); + ret =snprintf (thread_name,sizeof (thread_name),"dpdk-worker%d" , i); +if (ret >=RTE_THREAD_NAME_SIZE ) +EAL_LOG (INFO ,"Worker thread name %s truncated" , thread_name); +rte_thread_set_name (lcore_config[i].thread_id, thread_name); ret = rte_thread_set_affinity_by_id(lcore_config[i].thread_id,
lib/eal/windows/eal.c +4 -2
@@ -378,8 +378,10 @@ rte_eal_init(int argc, char **argv)rte_panic ("Cannot create thread\n" );/* Set thread name for aid in debugging. */ -snprintf (thread_name,sizeof (thread_name), -"dpdk-worker%d" , i); + ret =snprintf (thread_name,sizeof (thread_name),"dpdk-worker%d" , i); +if (ret >= (int )sizeof (thread_name)) +EAL_LOG (INFO ,"Worker thread name %s truncated" , thread_name); +rte_thread_set_name (lcore_config[i].thread_id, thread_name); ret = rte_thread_set_affinity_by_id(lcore_config[i].thread_id,
Signature · 1 line
2.51.0
PATCH v6 9/18 eal: avoid format overflow when handling addresses
In reply to Stephen HemmingerThe largest possible string in this code 0xFFFFFFFFFFFFFFFF which will overflow with only 15 character buffer. Increase to 20.
--- lib/eal/common/eal_common_memory.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
lib/eal/common/eal_common_memory.c +1 -1
@@ -1153,7 +1153,7 @@ rte_eal_memory_init(void)#define EAL_MEMSEG_INFO_REQ "/eal/memseg_info"#define EAL_ELEMENT_LIST_REQ "/eal/mem_element_list"#define EAL_ELEMENT_INFO_REQ "/eal/mem_element_info" -#define ADDR_STR 15 +#define ADDR_STR 20/* 16 bytes 64 bit + 0x */ /* Telemetry callback handler to return heap stats for requested heap id. */
Signature · 1 line
2.51.0
PATCH v6 10/18 eal: add check for sysfs path overflow
In reply to Stephen HemmingerShouldn't happen but in theory sysfs socket could overflow. Add a check for it.
--- lib/eal/linux/eal_hugepage_info.c | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-)
lib/eal/linux/eal_hugepage_info.c +5 -1
@@ -150,8 +150,12 @@ get_num_hugepages_on_node(const char *subdir, unsigned int socket, size_t sz)return 0 ; } -snprintf (path,sizeof (path),"%s/%s/%s" , +if (snprintf (path,sizeof (path),"%s/%s/%s" , socketpath, subdir, nr_hp_file) >=PATH_MAX ) { +EAL_LOG (NOTICE ,"Socket path %s/%s/%s is truncated" , socketpath, subdir, nr_hp_file); +return 0 ; + } +if (eal_parse_sysfs_value (path, &num_pages) <0 )return 0 ;
Signature · 1 line
2.51.0
PATCH v6 11/18 eal: limit maximum runtime directory and socket paths
In reply to Stephen HemmingerLinux has a limitation of 108 characters (including null character) for AF_UNIX socket path. FreeBSD limit is smaller 104 characters and Windows has same definition (108) in afunix.h header.
In current code, EAL will fail in telemetry, so this should not break existing users.
EAL: Multi-process socket /var/run/dpdk/x7Q9mP2a...
EAL: Selected IOVA mode 'VA'
TELEMETRY: Error with socket binding, path too long
Now long string fails on command line parsing:
EAL: Runtime directory string too long
EAL: Cannot create runtime directory
EAL: Error parsing command line arguments.
--- lib/eal/common/eal_common_config.c | 6 ++- lib/eal/common/eal_common_proc.c | 83 +++++++++++++++++++----------- lib/eal/common/eal_filesystem.h | 13 ++++- 3 files changed, 70 insertions(+), 32 deletions(-)
lib/eal/common/eal_common_config.c +4 -2
@@ -6,6 +6,7 @@#include <eal_export.h> #include "eal_private.h" +#include "eal_filesystem.h" #include "eal_memcfg.h" /* early configuration structure, when memory config is not mmapped */
@@ -24,7 +25,7 @@ static struct rte_config rte_config = { };/* platform-specific runtime dir */ -static char runtime_dir[PATH_MAX ]; +static char runtime_dir[UNIX_PATH_MAX ];/* internal configuration */ static struct internal_config internal_config;
@@ -39,7 +40,8 @@ rte_eal_get_runtime_dir(void)int eal_set_runtime_dir (const char *run_dir) { -if (strlcpy (runtime_dir, run_dir,PATH_MAX ) >=PATH_MAX ) { +/* runtime directory limited by maximum allowable unix domain socket */ +if (strlcpy (runtime_dir, run_dir,UNIX_PATH_MAX ) >=UNIX_PATH_MAX ) {EAL_LOG (ERR ,"Runtime directory string too long" );return -1 ; }
lib/eal/common/eal_common_proc.c +54 -29
166 lines not on this page · raw message
lib/eal/common/eal_filesystem.h +12 -1
@@ -45,10 +45,21 @@ eal_runtime_config_path(void)/** Path of primary/secondary communication unix socket file. */ #define MP_SOCKET_FNAME "mp_socket" + +#ifdef RTE_EXEC_ENV_WINDOWS +#include <winsock2.h> +#include <afunix.h> +#else +#include <sys/un.h> + +/** Maximum length of unix domain socket path. */ +#define UNIX_PATH_MAX (sizeof(((struct sockaddr_un *)0)->sun_path)) +#endif +static inline const char *eal_mp_socket_path (void ) { -static char buffer[PATH_MAX ];/* static so auto-zeroed */ +static char buffer[UNIX_PATH_MAX ];/* static so auto-zeroed */ snprintf (buffer,sizeof (buffer),"%s/%s" ,rte_eal_get_runtime_dir (),MP_SOCKET_FNAME );
Signature · 1 line
2.51.0
PATCH v6 12/18 eal: check for hugefile path overflow
In reply to Stephen HemmingerWhen constructing huge filename path, check for possible overflow of PATH_MAX.
--- lib/eal/common/eal_filesystem.h | 10 ++++--- lib/eal/linux/eal_hugepage_info.c | 44 ++++++++++++++++++------------- lib/eal/linux/eal_memalloc.c | 11 ++++++-- lib/eal/linux/eal_memory.c | 9 +++++-- 4 files changed, 48 insertions(+), 26 deletions(-)
lib/eal/common/eal_filesystem.h +6 -4
@@ -100,12 +100,14 @@ eal_hugepage_data_path(void)/** String format for hugepage map files. */ #define HUGEFILE_FMT "%s/%smap_%d" -static inline const char * +static inline __rte_warn_unused_result const char *eal_get_hugefile_path (char *buffer,size_t buflen,const char *hugedir,int f_id) { -snprintf (buffer, buflen,HUGEFILE_FMT , hugedir, -eal_get_hugefile_prefix (), f_id); -return buffer; +if (snprintf (buffer, buflen,HUGEFILE_FMT , hugedir, +eal_get_hugefile_prefix (), f_id) >= (int )buflen) +return NULL ; +else +return buffer; }/** define the default filename prefix for the %s values above */
lib/eal/linux/eal_hugepage_info.c +26 -18
100 lines not on this page · raw message
lib/eal/linux/eal_memalloc.c +9 -2
@@ -260,6 +260,7 @@ get_seg_fd(char *path, int buflen, struct hugepage_info *hi, {int fd;int *out_fd; +const char *huge_path;struct stat st;int ret; const struct internal_config *internal_conf =
@@ -276,12 +277,18 @@ get_seg_fd(char *path, int buflen, struct hugepage_info *hi,if (internal_conf->single_file_segments) { out_fd = &fd_list[list_idx].memseg_list_fd; -eal_get_hugefile_path (path, buflen, hi->hugedir, list_idx); + huge_path =eal_get_hugefile_path (path, buflen, hi->hugedir, list_idx); }else { out_fd = &fd_list[list_idx].fds[seg_idx]; -eal_get_hugefile_path (path, buflen, hi->hugedir, + huge_path =eal_get_hugefile_path (path, buflen, hi->hugedir, list_idx *RTE_MAX_MEMSEG_PER_LIST + seg_idx); } +if (huge_path ==NULL ) { +EAL_LOG (DEBUG ,"%s(): hugefile path truncated: '%s'" , + __func__, path); +return -1 ; + } + fd = *out_fd;if (fd >=0 )return fd;
lib/eal/linux/eal_memory.c +7 -2
@@ -337,8 +337,13 @@ map_all_hugepages(struct hugepage_file *hugepg_tbl, struct hugepage_info *hpi, hf->file_id = i; hf->size = hugepage_sz; -eal_get_hugefile_path (hf->filepath,sizeof (hf->filepath), - hpi->hugedir, hf->file_id); +if (eal_get_hugefile_path (hf->filepath,sizeof (hf->filepath), + hpi->hugedir, hf->file_id) ==NULL ) { +EAL_LOG (DEBUG ,"%s(): huge file path '%s' truncated" , + __func__, hf->filepath); + goto out; + } + hf->filepath[sizeof (hf->filepath) -1 ] ='\0' ;/* try to create hugepage file */
Signature · 1 line
2.51.0
PATCH v6 13/18 eal: check tailq length
In reply to Stephen HemmingerThe tailq name should not be allowed to exceed limits.
--- lib/eal/common/eal_common_tailqs.c | 5 +++++ 1 file changed, 5 insertions(+)
lib/eal/common/eal_common_tailqs.c +5 -0
@@ -67,6 +67,11 @@ rte_eal_tailq_create(const char *name) {struct rte_tailq_head *head =NULL ; +if (strlen (name) >=sizeof (head->name)) { +EAL_LOG (ERR ,"tailq name '%s' is too long" , name); +return NULL ; + } +if (!rte_eal_tailq_lookup (name) && (rte_tailqs_count +1 <RTE_MAX_TAILQ )) {struct rte_mem_config *mcfg;
Signature · 1 line
2.51.0
PATCH v6 14/18 eal: handle long shared library path
In reply to Stephen HemmingerInstead of a fixed size shared library path that could in theory get truncated when concatenating, use a dynamically allocated buffer via asprintf.
--- lib/eal/common/eal_common_options.c | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-)
lib/eal/common/eal_common_options.c +13 -4
@@ -570,7 +570,6 @@ static int eal_plugindir_init(const char *path) {struct dirent *dent =NULL ; -char sopath[PATH_MAX ];DIR *d =NULL ;if (path ==NULL || *path =='\0' )
@@ -584,19 +583,29 @@ eal_plugindir_init(const char *path) }while ((dent =readdir (d)) !=NULL ) { +char *sopath =NULL ;struct stat sb;if (!ends_with (dent->d_name,".so" ) && !ends_with (dent->d_name,".so." ABI_VERSION ))continue ; -snprintf (sopath,sizeof (sopath),"%s/%s" , path, dent->d_name); +if (asprintf (&sopath,"%s/%s" , path, dent->d_name) <0 ) { +EAL_LOG (ERR ,"failed to create full path %s/%s" , + path, dent->d_name); +continue ; + }/* if a regular file, add to list to load */ -if (!(stat (sopath, &sb) ==0 &&S_ISREG (sb.st_mode))) +if (!(stat (sopath, &sb) ==0 &&S_ISREG (sb.st_mode))) { +free (sopath);continue ; + } -if (eal_plugin_add (sopath) ==-1 ) +if (eal_plugin_add (sopath) ==-1 ) { +free (sopath);break ; + } +free (sopath); }closedir (d);
Signature · 1 line
2.51.0
PATCH v6 15/18 ethdev: avoid possible overflow in xstat names
In reply to Stephen HemmingerThe compiler doesn't know that all the elements in the table of queue stats are short enough to avoid overflowing the snprintf. Add a condition to warn if it ever does;
maybe some day a new long named queue stat could be added.
--- lib/ethdev/rte_ethdev.c | 35 ++++++++++++++++++++++++----------- 1 file changed, 24 insertions(+), 11 deletions(-)
lib/ethdev/rte_ethdev.c +24 -11
@@ -3489,9 +3489,10 @@ eth_basic_stats_get_names(struct rte_eth_dev *dev,uint16_t num_q;for (idx =0 ; idx <RTE_NB_STATS ; idx++) { -strlcpy (xstats_names[cnt_used_entries].name, - eth_dev_stats_strings[idx].name, -sizeof (xstats_names[0 ].name)); +if (strlcpy (xstats_names[cnt_used_entries].name, eth_dev_stats_strings[idx].name, +sizeof (xstats_names[0 ].name)) >=sizeof (xstats_names[0 ].name)) +RTE_ETHDEV_LOG_LINE (ERR ,"statistic name '%s' will be truncated" , + xstats_names[cnt_used_entries].name); cnt_used_entries++; }
@@ -3501,10 +3502,17 @@ eth_basic_stats_get_names(struct rte_eth_dev *dev, num_q =RTE_MIN (dev->data->nb_rx_queues,RTE_ETHDEV_QUEUE_STAT_CNTRS );for (id_queue =0 ; id_queue < num_q; id_queue++) {for (idx =0 ; idx <RTE_NB_RXQ_STATS ; idx++) { -snprintf (xstats_names[cnt_used_entries].name, -sizeof (xstats_names[0 ].name), -"rx_q%u_%s" , - id_queue, eth_dev_rxq_stats_strings[idx].name); +unsigned int cc; + + cc =snprintf (xstats_names[cnt_used_entries].name, +sizeof (xstats_names[0 ].name), +"rx_q%u_%s" , + id_queue, eth_dev_rxq_stats_strings[idx].name); + +/* could only happen if a long string was added */ +if (cc >=sizeof (xstats_names[0 ].name)) +RTE_ETHDEV_LOG_LINE (ERR ,"truncated rxq stat string '%s'" , + eth_dev_rxq_stats_strings[idx].name); cnt_used_entries++; }
@@ -3512,10 +3520,15 @@ eth_basic_stats_get_names(struct rte_eth_dev *dev, num_q =RTE_MIN (dev->data->nb_tx_queues,RTE_ETHDEV_QUEUE_STAT_CNTRS );for (id_queue =0 ; id_queue < num_q; id_queue++) {for (idx =0 ; idx <RTE_NB_TXQ_STATS ; idx++) { -snprintf (xstats_names[cnt_used_entries].name, -sizeof (xstats_names[0 ].name), -"tx_q%u_%s" , - id_queue, eth_dev_txq_stats_strings[idx].name); +unsigned int cc; + + cc =snprintf (xstats_names[cnt_used_entries].name, +sizeof (xstats_names[0 ].name), +"tx_q%u_%s" , + id_queue, eth_dev_txq_stats_strings[idx].name); +if (cc >=sizeof (xstats_names[0 ].name)) +RTE_ETHDEV_LOG_LINE (ERR ,"truncated txq stat string '%s'" , + eth_dev_txq_stats_strings[idx].name); cnt_used_entries++; } }
Signature · 1 line
2.51.0
PATCH v6 16/18 vhost: check for overflow in xstat name
In reply to Stephen HemmingerThe snprintf to format an xstat name could overflow if called with a long rte_vhost_stat_name. Check if that happens and warn.
--- lib/vhost/vhost.c | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-)
lib/vhost/vhost.c +10 -4
@@ -2200,6 +2200,7 @@ rte_vhost_vring_stats_get_names(int vid, uint16_t queue_id, {struct virtio_net *dev =get_device (vid);unsigned int i; +int ret;if (dev ==NULL )return -1 ;
@@ -2213,10 +2214,15 @@ rte_vhost_vring_stats_get_names(int vid, uint16_t queue_id,if (name ==NULL || size <VHOST_NB_VQ_STATS )return VHOST_NB_VQ_STATS ; -for (i =0 ; i <VHOST_NB_VQ_STATS ; i++) -snprintf (name[i].name,sizeof (name[i].name),"%s_q%u_%s" , - (queue_id &1 ) ?"rx" :"tx" , - queue_id /2 , vhost_vq_stat_strings[i].name); +for (i =0 ; i <VHOST_NB_VQ_STATS ; i++) { + ret =snprintf (name[i].name,sizeof (name[i].name),"%s_q%u_%s" , + (queue_id &1 ) ?"rx" :"tx" , + queue_id /2 , vhost_vq_stat_strings[i].name); +if (ret >= (int )sizeof (name[0 ].name)) +VHOST_CONFIG_LOG ("device" ,NOTICE ,"truncated xstat '%s_q%u_%s'" , + (queue_id &1 ) ?"rx" :"tx" , + queue_id /2 , vhost_vq_stat_strings[i].name); + }return VHOST_NB_VQ_STATS ; }
Signature · 1 line
2.51.0
PATCH v6 17/18 cfgfile: add length checks and increase line buffer
In reply to Stephen HemmingerWhen adding values to config info, add string length checks instead of silently truncating. Increase the size of the buffer used to read from a config file so that there will be enough space for longest entries.
--- lib/cfgfile/rte_cfgfile.c | 36 +++++++++++++++++++++++++++--------- 1 file changed, 27 insertions(+), 9 deletions(-)
lib/cfgfile/rte_cfgfile.c +27 -9
@@ -2,6 +2,7 @@* Copyright(c) 2010-2014 Intel Corporation */ +#include <assert.h> #include <stdio.h> #include <stdlib.h> #include <string.h>
@@ -106,6 +107,9 @@ static int _add_entry(struct rte_cfgfile_section *section, const char *entryname, const char *entryvalue) { + if (strlen(entryname) >= CFG_NAME_LEN || strlen(entryvalue) >= CFG_VALUE_LEN) + return -ENAMETOOLONG; +/* resize entry structure if we don't have room for more entries */ if (section->num_entries == section->allocated_entries) { struct rte_cfgfile_entry *n_entries = realloc(
@@ -167,12 +171,16 @@ rte_cfgfile_load(const char *filename, int flags) &default_cfgfile_params); } +/* Need enough space for largest name and value */ +static_assert (LINE_MAX >CFG_NAME_LEN +CFG_VALUE_LEN +4 , +"not enough space for cfgfile name/value" ); +RTE_EXPORT_SYMBOL (rte_cfgfile_load_with_params) struct rte_cfgfile *rte_cfgfile_load_with_params (const char *filename,int flags,const struct rte_cfgfile_parameters *params) { -char buffer[CFG_NAME_LEN +CFG_VALUE_LEN +4 ]; +char buffer[LINE_MAX ];int lineno =0 ;struct rte_cfgfile *cfg;
@@ -219,7 +227,13 @@ rte_cfgfile_load_with_params(const char *filename, int flags, *end ='\0' ;_strip (&buffer[1 ], end - &buffer[1 ]); -rte_cfgfile_add_section (cfg, &buffer[1 ]); +int ret =rte_cfgfile_add_section (cfg, &buffer[1 ]); +if (ret !=0 ) { +CFG_LOG (ERR , +"line %d - add section failed: %s" , + lineno,strerror (-ret)); + goto error1; + } }else {/* key and value line */ char *split[2 ] = {NULL };
@@ -260,8 +274,13 @@ rte_cfgfile_load_with_params(const char *filename, int flags,if (cfg->num_sections ==0 ) goto error1; -_add_entry (&cfg->sections[cfg->num_sections -1 ], - split[0 ], split[1 ]); +int ret =_add_entry (&cfg->sections[cfg->num_sections -1 ], + split[0 ], split[1 ]); +if (ret !=0 ) { +CFG_LOG (ERR , +"line %d - add entry failed: %s" , lineno,strerror (-ret)); + goto error1; + } } }fclose (f);
@@ -341,6 +360,9 @@ rte_cfgfile_add_section(struct rte_cfgfile *cfg, const char *sectionname)if (sectionname ==NULL )return -EINVAL ; +if (strlen (sectionname) >=CFG_NAME_LEN ) +return -ENAMETOOLONG ; +/* resize overall struct if we don't have room for more sections */ if (cfg->num_sections == cfg->allocated_sections) {
@@ -376,8 +398,6 @@ int rte_cfgfile_add_entry(struct rte_cfgfile *cfg, const char *sectionname, const char *entryname, const char *entryvalue) { - int ret; - if ((cfg == NULL) || (sectionname == NULL) || (entryname == NULL) || (entryvalue == NULL)) return -EINVAL;
@@ -391,9 +411,7 @@ int rte_cfgfile_add_entry(struct rte_cfgfile *cfg,if (curr_section ==NULL )return -EINVAL ; - ret =_add_entry (curr_section, entryname, entryvalue); - -return ret; +return _add_entry (curr_section, entryname, entryvalue); }RTE_EXPORT_SYMBOL (rte_cfgfile_set_entry)
Signature · 1 line
2.51.0
PATCH v6 18/18 lib: enable format overflow warnings
In reply to Stephen HemmingerEnable compiler checking of format overflow
--- lib/meson.build | 4 ---- 1 file changed, 4 deletions(-)
lib/meson.build +0 -4
@@ -113,10 +113,6 @@ default_cflags = machine_args default_cflags += ['-DALLOW_EXPERIMENTAL_API'] default_cflags += ['-DALLOW_INTERNAL_API'] -if cc.has_argument('-Wno-format-truncation') - default_cflags += '-Wno-format-truncation' -endif - foreach l:libraries build = true reason = '<unknown reason>' # set if build == false to explain why
Signature · 1 line
2.51.0
v7 cover lib: fix format overflows
In reply to Stephen HemmingerChange all the libraries to find and fix cases where a string could overflow when formatting or using strclpy. This does provide early indication of possible problems where the file prefix is too long to fit in unix domain socket path, and where a hash table is being requested that has a name too long.
v7 - simplify and fix Windows build
Stephen Hemminger (18):
lpm: restrict name size
hash: add checks for hash name length
graph: avoid overflowing comment buffer
latencystats: add check for string overflow
telemetry: check for path overflow
efd: handle possible name truncation
eal: use C library to parse filesystem table
eal: warn if thread name is truncated
eal: avoid format overflow when handling addresses
eal: add check for sysfs path overflow
eal: limit maximum runtime directory and socket paths
eal: check for hugefile path overflow
eal: check tailq length
eal: handle long shared library path
ethdev: avoid possible overflow in xstat names
vhost: check for overflow in xstat name
cfgfile: add length checks and increase line buffer
lib: enable format overflow warnings
app/test/test_hash.c | 21 ++++++ doc/guides/rel_notes/release_26_03.rst | 3 + lib/cfgfile/rte_cfgfile.c | 43 ++++++++--- lib/eal/common/eal_common_config.c | 6 +- lib/eal/common/eal_common_memory.c | 2 +- lib/eal/common/eal_common_options.c | 17 +++-- lib/eal/common/eal_common_proc.c | 83 ++++++++++++++-------- lib/eal/common/eal_common_tailqs.c | 5 ++ lib/eal/common/eal_filesystem.h | 23 ++++-- lib/eal/freebsd/eal.c | 6 +- lib/eal/linux/eal.c | 6 +- lib/eal/linux/eal_hugepage_info.c | 98 ++++++++++++-------------- lib/eal/linux/eal_memalloc.c | 11 ++- lib/eal/linux/eal_memory.c | 9 ++- lib/eal/windows/eal.c | 6 +- lib/efd/rte_efd.c | 7 +- lib/ethdev/rte_ethdev.c | 35 ++++++--- lib/graph/graph_pcap.c | 9 ++- lib/hash/rte_cuckoo_hash.c | 41 +++++++---- lib/hash/rte_fbk_hash.c | 14 +++- lib/latencystats/rte_latencystats.c | 9 ++- lib/lpm/rte_lpm.c | 17 +++-- lib/meson.build | 4 -- lib/telemetry/telemetry_legacy.c | 7 +- lib/vhost/vhost.c | 14 ++-- 25 files changed, 335 insertions(+), 161 deletions(-)
Signature · 1 line
2.51.0
PATCH v7 1/18 lpm: restrict name size
Chec that lpm name size is within limits and add checks for truncation.
--- lib/lpm/rte_lpm.c | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-)
lib/lpm/rte_lpm.c +13 -4
@@ -5,6 +5,7 @@#include <string.h> #include <stdint.h> +#include <stdlib.h> #include <errno.h> #include <stdio.h> #include <sys/queue.h>
@@ -152,7 +153,7 @@ struct rte_lpm * rte_lpm_create(const char *name, int socket_id, const struct rte_lpm_config *config) { - char mem_name[RTE_LPM_NAMESIZE]; + char mem_name[RTE_LPM_NAMESIZE + sizeof("LPM_")];struct __rte_lpm *i_lpm;struct rte_lpm *lpm =NULL ;struct rte_tailq_entry *te;
@@ -170,6 +171,11 @@ rte_lpm_create(const char *name, int socket_id,return NULL ; } +if (strlen (name) >=RTE_LPM_NAMESIZE ) { + rte_errno =ENAMETOOLONG ; +return NULL ; + } +snprintf (mem_name,sizeof (mem_name),"LPM_%s" , name);rte_mcfg_tailq_write_lock ();
@@ -327,8 +333,10 @@ rte_lpm_rcu_qsbr_add(struct rte_lpm *lpm, struct rte_lpm_rcu_config *cfg)/* No other things to do. */ }else if (cfg->mode ==RTE_LPM_QSBR_MODE_DQ ) {/* Init QSBR defer queue. */ -snprintf (rcu_dq_name,sizeof (rcu_dq_name), -"LPM_RCU_%s" , i_lpm->name); +if (snprintf (rcu_dq_name,sizeof (rcu_dq_name), +"LPM_RCU_%s" , i_lpm->name) >= (int )sizeof (rcu_dq_name)) +LPM_LOG (NOTICE ,"LPM rcu defer queue name truncated" ); + params.name = rcu_dq_name; params.size = cfg->dq_size;if (params.size ==0 )
@@ -343,7 +351,8 @@ rte_lpm_rcu_qsbr_add(struct rte_lpm *lpm, struct rte_lpm_rcu_config *cfg) params.v = cfg->v; i_lpm->dq =rte_rcu_qsbr_dq_create (¶ms);if (i_lpm->dq ==NULL ) { -LPM_LOG (ERR ,"LPM defer queue creation failed" ); +LPM_LOG (ERR ,"LPM defer queue creation failed: %s" , +rte_strerror (rte_errno));return 1 ; } }else {
Signature · 1 line
2.51.0
PATCH v7 2/18 hash: add checks for hash name length
In reply to Stephen HemmingerAdd a missing check to the API that the name is within the current defined maximum name size. This name is then used internally to create ring names, those names could get truncated; if a name is truncated add message to log.
If ring creation fails it might be because of name conflict, so change the log message to decode error value.
Add additional tests as well.
--- app/test/test_hash.c | 21 +++++++++++++ doc/guides/rel_notes/release_26_03.rst | 3 ++ lib/hash/rte_cuckoo_hash.c | 41 ++++++++++++++++++-------- lib/hash/rte_fbk_hash.c | 14 +++++++-- 4 files changed, 65 insertions(+), 14 deletions(-)
app/test/test_hash.c +21 -0
@@ -1120,6 +1120,14 @@ fbk_hash_unit_test(void) .socket_id = RTE_MAX_NUMA_NODES + 1, /* invalid socket */ }; +/* try and create hash with an excessively long name */ +struct rte_fbk_hash_params invalid_params_long_name = { + .name ="four_byte_key_hash_name_length_32" , + .entries =4 , + .entries_per_bucket =2 , + .socket_id =0 , + }; +/* try to create two hashes with identical names * in this case, trying to create a second one will not * fail but will simply return pointer to the existing
@@ -1201,6 +1209,9 @@ fbk_hash_unit_test(void) handle =rte_fbk_hash_create (&invalid_params_7);RETURN_IF_ERROR_FBK (handle !=NULL ,"fbk hash creation should have failed" ); + handle =rte_fbk_hash_create (&invalid_params_long_name); +RETURN_IF_ERROR_FBK (handle !=NULL ,"fbk hash creation should have failed" ); +if (rte_eal_has_hugepages ()) { handle =rte_fbk_hash_create (&invalid_params_8); RETURN_IF_ERROR_FBK(handle != NULL,
@@ -1439,6 +1450,16 @@ static int test_hash_creation_with_bad_parameters(void)return -1 ; } +memcpy (¶ms, &ut_params,sizeof (params)); + params.name ="hash_creation_with_too_long_name" ; + params.socket_id =RTE_MAX_NUMA_NODES +1 ; + handle =rte_hash_create (¶ms); +if (handle !=NULL ) { +rte_hash_free (handle); +printf ("Impossible creating hash successfully with long name\n" ); +return -1 ; + } +/* test with same name should fail */ memcpy (¶ms, &ut_params,sizeof (params)); params.name ="same_name" ;
doc/guides/rel_notes/release_26_03.rst +3 -0
@@ -84,6 +84,9 @@ API Changes Also, make sure to start the actual text at the margin. ======================================================= +* hash: Added name length validation to hash creation. + The hash name in hash parameters is now checked against RTE_HASH_NAMESIZE. + ABI Changes -----------
lib/hash/rte_cuckoo_hash.c +29 -12
89 lines not on this page · raw message
lib/hash/rte_fbk_hash.c +12 -2
@@ -5,6 +5,7 @@#include <stdint.h> #include <stdio.h> #include <string.h> +#include <stdlib.h> #include <errno.h> #include <sys/queue.h>
@@ -83,7 +84,7 @@ rte_fbk_hash_create(const struct rte_fbk_hash_params *params) {struct rte_fbk_hash_table *ht =NULL ;struct rte_tailq_entry *te; -char hash_name[RTE_FBK_HASH_NAMESIZE ]; +char *hash_name =NULL ;const uint32_t mem_size =sizeof (*ht) + (sizeof (ht->t[0 ]) * params->entries);uint32_t i;
@@ -96,6 +97,7 @@ rte_fbk_hash_create(const struct rte_fbk_hash_params *params)/* Error checking of parameters. */ if ((!rte_is_power_of_2(params->entries)) || (!rte_is_power_of_2(params->entries_per_bucket)) || + (params->name == NULL) || (params->entries == 0) || (params->entries_per_bucket == 0) || (params->entries_per_bucket > params->entries) ||
@@ -105,7 +107,14 @@ rte_fbk_hash_create(const struct rte_fbk_hash_params *params)return NULL ; } -snprintf (hash_name,sizeof (hash_name),"FBK_%s" , params->name); +if (strlen (params->name) >=RTE_FBK_HASH_NAMESIZE ) { + rte_errno =ENAMETOOLONG ; +return NULL ; + } + +/* don't care if hash_name is NULL */ + int unused __rte_unused; + unused =asprintf (&hash_name,"FBK_%s" , params->name);rte_mcfg_tailq_write_lock ();
@@ -170,6 +179,7 @@ rte_fbk_hash_create(const struct rte_fbk_hash_params *params) exit:rte_mcfg_tailq_write_unlock (); +free (hash_name);return ht; }
Signature · 1 line
2.51.0
PATCH v7 3/18 graph: avoid overflowing comment buffer
In reply to Stephen HemmingerThe library builds a pcapng comment to put on each packet but the buffer is not big enough for the largest possible graph node name, etc. Change to use asprintf() to allow any string length. Note, if asprintf() fails it is better to still log the packet without comment so no data is lost.
--- lib/graph/graph_pcap.c | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-)
lib/graph/graph_pcap.c +6 -3
@@ -194,7 +194,7 @@ graph_pcap_dispatch(struct rte_graph *graph, uint16_t nb_objs) {struct rte_mbuf *mbuf_clones[RTE_GRAPH_BURST_SIZE ]; -char buffer[GRAPH_PCAP_BUF_SZ ]; +char *comment =NULL ;uint64_t i, num_packets;struct rte_mbuf *mbuf;ssize_t len;
@@ -207,19 +207,22 @@ graph_pcap_dispatch(struct rte_graph *graph,if (num_packets > nb_objs) num_packets = nb_objs; -snprintf (buffer,GRAPH_PCAP_BUF_SZ ,"%s: %s" , graph->name, node->name); +/* put a comment on all these packets */ +if (asprintf (&comment,"%s: %s" , graph->name, node->name) <0 ) +graph_err ("asprintf for comment failed." );for (i =0 ; i < num_packets; i++) {struct rte_mbuf *mc; mbuf = (struct rte_mbuf *)objs[i]; mc =rte_pcapng_copy (mbuf->port,0 , mbuf, pkt_mp, mbuf->pkt_len, -0 , buffer); +0 , comment);if (mc ==NULL )break ; mbuf_clones[i] = mc; } +free (comment);/* write it to capture file */ len =rte_pcapng_write_packets (pcapng_fd, mbuf_clones, i);
Signature · 1 line
2.51.0
PATCH v7 4/18 latencystats: add check for string overflow
In reply to Stephen HemmingerThe copy of latency stat names could get truncated if in the future a new value is added. Add warning if that happens.
--- lib/latencystats/rte_latencystats.c | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-)
lib/latencystats/rte_latencystats.c +6 -3
@@ -405,9 +405,12 @@ rte_latencystats_get_names(struct rte_metric_name *names, uint16_t size)if (names ==NULL || size <NUM_LATENCY_STATS )return NUM_LATENCY_STATS ; -for (i =0 ; i <NUM_LATENCY_STATS ; i++) -strlcpy (names[i].name, lat_stats_strings[i].name, -sizeof (names[i].name)); +for (i =0 ; i <NUM_LATENCY_STATS ; i++) { +if (strlcpy (names[i].name, lat_stats_strings[i].name,sizeof (names[0 ].name)) + >=sizeof (names[0 ].name)) +LATENCY_STATS_LOG (NOTICE ,"Latency metric '%s' too long" , + lat_stats_strings[i].name); + }return NUM_LATENCY_STATS ; }
Signature · 1 line
2.51.0
PATCH v7 5/18 telemetry: check for path overflow
In reply to Stephen HemmingerThe unix domain socket path is limited, check for overflow.
--- lib/telemetry/telemetry_legacy.c | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-)
lib/telemetry/telemetry_legacy.c +5 -2
@@ -102,14 +102,17 @@ register_client(const char *cmd __rte_unused, const char *params,return -1 ; } *strchr (data,'\"' ) =0 ; + addrs.sun_family =AF_UNIX ; +if (strlcpy (addrs.sun_path, data,sizeof (addrs.sun_path)) >=sizeof (addrs.sun_path)) { +fprintf (stderr,"Client path too long\n" ); +return -1 ; + } fd =socket (AF_UNIX ,SOCK_SEQPACKET ,0 );if (fd <0 ) {perror ("Failed to open socket" );return -1 ; } - addrs.sun_family =AF_UNIX ; -strlcpy (addrs.sun_path, data,sizeof (addrs.sun_path));if (connect (fd, (struct sockaddr *)&addrs,sizeof (addrs)) ==-1 ) {perror ("\nClient connection error\n" );
Signature · 1 line
2.51.0
PATCH v7 6/18 efd: handle possible name truncation
In reply to Stephen HemmingerIf the conversion of efd name to ring name gets truncated, then log it. And if the ring name than causes collision, make sure that log message includes error reason.
--- lib/efd/rte_efd.c | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-)
lib/efd/rte_efd.c +5 -2
@@ -698,12 +698,15 @@ rte_efd_create(const char *name, uint32_t max_num_rules, uint32_t key_len,TAILQ_INSERT_TAIL (efd_list, te, next);rte_mcfg_tailq_write_unlock (); -snprintf (ring_name,sizeof (ring_name),"HT_%s" , table->name); +if (snprintf (ring_name,sizeof (ring_name),"HT_%s" , table->name) + >= (int )sizeof (ring_name)) +EFD_LOG (NOTICE ,"EFD ring name truncated to '%s'" , ring_name); +/* Create ring (Dummy slot index is not enqueued) */ r =rte_ring_create (ring_name,rte_align32pow2 (table->max_num_rules), offline_cpu_socket,0 );if (r ==NULL ) { -EFD_LOG (ERR ,"memory allocation failed" ); +EFD_LOG (ERR ,"ring creation failed: %s" ,rte_strerror (rte_errno));rte_efd_free (table);return NULL ; }
Signature · 1 line
2.51.0
PATCH v7 7/18 eal: use C library to parse filesystem table
In reply to Stephen HemmingerRather than doing parsing of /proc/mounts with open coded string handling, use the standard C library routines.
These exist in BSD and Linux.
It also avoids any possible issues with escaped strings etc which the library handles. See getmntent(3) man page.
--- lib/eal/linux/eal_hugepage_info.c | 58 ++++++++++--------------------- 1 file changed, 18 insertions(+), 40 deletions(-)
lib/eal/linux/eal_hugepage_info.c +18 -40
@@ -13,6 +13,7 @@#include <inttypes.h> #include <unistd.h> #include <errno.h> +#include <mntent.h> #include <sys/mman.h> #include <sys/stat.h>
@@ -195,23 +196,13 @@ get_default_hp_size(void)static int get_hugepage_dir (uint64_t hugepage_sz,char *hugedir,int len) { -enum proc_mount_fieldnames { -DEVICE =0 , -MOUNTPT , -FSTYPE , -OPTIONS , - _FIELDNAME_MAX - };static uint64_t default_size =0 ;const char proc_mounts[] ="/proc/mounts" ; -const char hugetlbfs_str[] ="hugetlbfs" ; -const size_t htlbfs_str_len =sizeof (hugetlbfs_str) -1 ;const char pagesize_opt[] ="pagesize=" ;const size_t pagesize_opt_len =sizeof (pagesize_opt) -1 ; -const char split_tok =' ' ; -char *splitstr[_FIELDNAME_MAX];char found[PATH_MAX ] ="" ;char buf[BUFSIZ ]; +struct mntent entry;const struct internal_config *internal_conf =eal_get_internal_configuration (); const size_t hugepage_dir_len = (internal_conf->hugepage_dir != NULL) ?
@@ -226,56 +217,43 @@ get_hugepage_dir(uint64_t hugepage_sz, char *hugedir, int len)return -1 ; } -FILE *fd =fopen (proc_mounts,"r" ); -if (fd ==NULL ) +FILE *mounts =setmntent (proc_mounts,"r" ); +if (mounts ==NULL )rte_panic ("Cannot open %s\n" , proc_mounts);if (default_size ==0 ) default_size =get_default_hp_size (); -while (fgets (buf,sizeof (buf), fd)){ +while (getmntent_r (mounts, &entry, buf,sizeof (buf))) {const char *pagesz_str; -size_t mountpt_len =0 ; - -if (rte_strsplit (buf,sizeof (buf), splitstr, _FIELDNAME_MAX, - split_tok) != _FIELDNAME_MAX) { -EAL_LOG (ERR ,"Error parsing %s" , proc_mounts); -break ;/* return NULL */ - } +uint64_t pagesz = default_size; +size_t mountpt_len; -if (strncmp (splitstr[FSTYPE ], hugetlbfs_str, htlbfs_str_len) !=0 ) +if (strcmp (entry.mnt_type,"hugetlbfs" ) !=0 )continue ; - pagesz_str =strstr (splitstr[OPTIONS ], pagesize_opt); + pagesz_str =strstr (entry.mnt_opts, pagesize_opt); +if (pagesz_str) + pagesz =rte_str_to_size (&pagesz_str[pagesize_opt_len]); -/* if no explicit page size, the default page size is compared */ -if (pagesz_str ==NULL ) { -if (hugepage_sz != default_size) -continue ; - } -/* there is an explicit page size, so check it */ -else { -uint64_t pagesz =rte_str_to_size (&pagesz_str[pagesize_opt_len]); -if (pagesz != hugepage_sz) -continue ; - } +if (pagesz != hugepage_sz) +continue ;/* * If no --huge-dir option has been given, we're done. */ if (internal_conf->hugepage_dir ==NULL ) { -strlcpy (found, splitstr[MOUNTPT ], len); +strlcpy (found, entry.mnt_dir, len);break ; } - mountpt_len =strlen (splitstr[MOUNTPT ]); + mountpt_len =strlen (entry.mnt_dir);/* * Ignore any mount that doesn't contain the --huge-dir directory * or where mount point is not a parent path of --huge-dir */ -if (strncmp (internal_conf->hugepage_dir, splitstr[MOUNTPT ], - mountpt_len) !=0 || +if (strncmp (internal_conf->hugepage_dir, entry.mnt_dir, mountpt_len) !=0 || (hugepage_dir_len > mountpt_len && internal_conf->hugepage_dir[mountpt_len] !='/' )) {continue ;
@@ -286,10 +264,10 @@ get_hugepage_dir(uint64_t hugepage_sz, char *hugedir, int len)* (so /mnt/1 is preferred over /mnt for matching /mnt/1/2)). */ if (mountpt_len >strlen (found)) -strlcpy (found, splitstr[MOUNTPT ], len); +strlcpy (found, entry.mnt_dir, len); }/* end while fgets */ -fclose (fd); +endmntent (mounts);if (found[0 ] !='\0' ) {/* If needed, return the requested dir, not the mount point. */
Signature · 1 line
2.51.0
PATCH v7 8/18 eal: warn if thread name is truncated
In reply to Stephen HemmingerThread name is very short 16 characters and therefore the name dpdk-worker-%d will overflow with more than 9999 worker cores. Error should be non-fatal since name only matters for debug.
--- lib/eal/freebsd/eal.c | 6 ++++-- lib/eal/linux/eal.c | 6 ++++-- lib/eal/windows/eal.c | 6 ++++-- 3 files changed, 12 insertions(+), 6 deletions(-)
lib/eal/freebsd/eal.c +4 -2
@@ -690,8 +690,10 @@ rte_eal_init(int argc, char **argv)rte_panic ("Cannot create thread\n" );/* Set thread_name for aid in debugging. */ -snprintf (thread_name,sizeof (thread_name), -"dpdk-worker%d" , i); + ret =snprintf (thread_name,sizeof (thread_name),"dpdk-worker%d" , i); +if (ret >= (int )sizeof (thread_name)) +EAL_LOG (INFO ,"Worker thread name %s truncated" , thread_name); +rte_thread_set_name (lcore_config[i].thread_id, thread_name); ret = rte_thread_set_affinity_by_id(lcore_config[i].thread_id,
lib/eal/linux/eal.c +4 -2
@@ -863,8 +863,10 @@ rte_eal_init(int argc, char **argv)rte_panic ("Cannot create thread\n" );/* Set thread_name for aid in debugging. */ -snprintf (thread_name,sizeof (thread_name), -"dpdk-worker%d" , i); + ret =snprintf (thread_name,sizeof (thread_name),"dpdk-worker%d" , i); +if (ret >=RTE_THREAD_NAME_SIZE ) +EAL_LOG (INFO ,"Worker thread name %s truncated" , thread_name); +rte_thread_set_name (lcore_config[i].thread_id, thread_name); ret = rte_thread_set_affinity_by_id(lcore_config[i].thread_id,
lib/eal/windows/eal.c +4 -2
@@ -378,8 +378,10 @@ rte_eal_init(int argc, char **argv)rte_panic ("Cannot create thread\n" );/* Set thread name for aid in debugging. */ -snprintf (thread_name,sizeof (thread_name), -"dpdk-worker%d" , i); + ret =snprintf (thread_name,sizeof (thread_name),"dpdk-worker%d" , i); +if (ret >= (int )sizeof (thread_name)) +EAL_LOG (INFO ,"Worker thread name %s truncated" , thread_name); +rte_thread_set_name (lcore_config[i].thread_id, thread_name); ret = rte_thread_set_affinity_by_id(lcore_config[i].thread_id,
Signature · 1 line
2.51.0
PATCH v7 9/18 eal: avoid format overflow when handling addresses
In reply to Stephen HemmingerThe largest possible string in this code 0xFFFFFFFFFFFFFFFF which will overflow with only 15 character buffer. Increase to 20.
--- lib/eal/common/eal_common_memory.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
lib/eal/common/eal_common_memory.c +1 -1
@@ -1153,7 +1153,7 @@ rte_eal_memory_init(void)#define EAL_MEMSEG_INFO_REQ "/eal/memseg_info"#define EAL_ELEMENT_LIST_REQ "/eal/mem_element_list"#define EAL_ELEMENT_INFO_REQ "/eal/mem_element_info" -#define ADDR_STR 15 +#define ADDR_STR 20/* 16 bytes 64 bit + 0x */ /* Telemetry callback handler to return heap stats for requested heap id. */
Signature · 1 line
2.51.0
PATCH v7 10/18 eal: add check for sysfs path overflow
In reply to Stephen HemmingerShouldn't happen but in theory sysfs socket could overflow. Add a check for it.
--- lib/eal/linux/eal_hugepage_info.c | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-)
lib/eal/linux/eal_hugepage_info.c +5 -1
@@ -150,8 +150,12 @@ get_num_hugepages_on_node(const char *subdir, unsigned int socket, size_t sz)return 0 ; } -snprintf (path,sizeof (path),"%s/%s/%s" , +if (snprintf (path,sizeof (path),"%s/%s/%s" , socketpath, subdir, nr_hp_file) >=PATH_MAX ) { +EAL_LOG (NOTICE ,"Socket path %s/%s/%s is truncated" , socketpath, subdir, nr_hp_file); +return 0 ; + } +if (eal_parse_sysfs_value (path, &num_pages) <0 )return 0 ;
Signature · 1 line
2.51.0
PATCH v7 11/18 eal: limit maximum runtime directory and socket paths
In reply to Stephen HemmingerLinux has a limitation of 108 characters (including null character) for AF_UNIX socket path. FreeBSD limit is smaller 104 characters and Windows has same definition (108) in afunix.h header.
In current code, EAL will fail in telemetry, so this should not break existing users.
EAL: Multi-process socket /var/run/dpdk/x7Q9mP2a...
EAL: Selected IOVA mode 'VA'
TELEMETRY: Error with socket binding, path too long
Now long string fails on command line parsing:
EAL: Runtime directory string too long
EAL: Cannot create runtime directory
EAL: Error parsing command line arguments.
--- lib/eal/common/eal_common_config.c | 6 ++- lib/eal/common/eal_common_proc.c | 83 +++++++++++++++++++----------- lib/eal/common/eal_filesystem.h | 13 ++++- 3 files changed, 70 insertions(+), 32 deletions(-)
lib/eal/common/eal_common_config.c +4 -2
@@ -6,6 +6,7 @@#include <eal_export.h> #include "eal_private.h" +#include "eal_filesystem.h" #include "eal_memcfg.h" /* early configuration structure, when memory config is not mmapped */
@@ -24,7 +25,7 @@ static struct rte_config rte_config = { };/* platform-specific runtime dir */ -static char runtime_dir[PATH_MAX ]; +static char runtime_dir[UNIX_PATH_MAX ];/* internal configuration */ static struct internal_config internal_config;
@@ -39,7 +40,8 @@ rte_eal_get_runtime_dir(void)int eal_set_runtime_dir (const char *run_dir) { -if (strlcpy (runtime_dir, run_dir,PATH_MAX ) >=PATH_MAX ) { +/* runtime directory limited by maximum allowable unix domain socket */ +if (strlcpy (runtime_dir, run_dir,UNIX_PATH_MAX ) >=UNIX_PATH_MAX ) {EAL_LOG (ERR ,"Runtime directory string too long" );return -1 ; }
lib/eal/common/eal_common_proc.c +54 -29
166 lines not on this page · raw message
lib/eal/common/eal_filesystem.h +12 -1
@@ -45,10 +45,21 @@ eal_runtime_config_path(void)/** Path of primary/secondary communication unix socket file. */ #define MP_SOCKET_FNAME "mp_socket" + +#ifdef RTE_EXEC_ENV_WINDOWS +#include <winsock2.h> +#include <afunix.h> +#else +#include <sys/un.h> + +/** Maximum length of unix domain socket path. */ +#define UNIX_PATH_MAX (sizeof(((struct sockaddr_un *)0)->sun_path)) +#endif +static inline const char *eal_mp_socket_path (void ) { -static char buffer[PATH_MAX ];/* static so auto-zeroed */ +static char buffer[UNIX_PATH_MAX ];/* static so auto-zeroed */ snprintf (buffer,sizeof (buffer),"%s/%s" ,rte_eal_get_runtime_dir (),MP_SOCKET_FNAME );
Signature · 1 line
2.51.0
PATCH v7 12/18 eal: check for hugefile path overflow
In reply to Stephen HemmingerWhen constructing huge filename path, check for possible overflow of PATH_MAX.
--- lib/eal/common/eal_filesystem.h | 10 ++++--- lib/eal/linux/eal_hugepage_info.c | 44 ++++++++++++++++++------------- lib/eal/linux/eal_memalloc.c | 11 ++++++-- lib/eal/linux/eal_memory.c | 9 +++++-- 4 files changed, 48 insertions(+), 26 deletions(-)
lib/eal/common/eal_filesystem.h +6 -4
@@ -100,12 +100,14 @@ eal_hugepage_data_path(void)/** String format for hugepage map files. */ #define HUGEFILE_FMT "%s/%smap_%d" -static inline const char * +static inline __rte_warn_unused_result const char *eal_get_hugefile_path (char *buffer,size_t buflen,const char *hugedir,int f_id) { -snprintf (buffer, buflen,HUGEFILE_FMT , hugedir, -eal_get_hugefile_prefix (), f_id); -return buffer; +if (snprintf (buffer, buflen,HUGEFILE_FMT , hugedir, +eal_get_hugefile_prefix (), f_id) >= (int )buflen) +return NULL ; +else +return buffer; }/** define the default filename prefix for the %s values above */
lib/eal/linux/eal_hugepage_info.c +26 -18
100 lines not on this page · raw message
lib/eal/linux/eal_memalloc.c +9 -2
@@ -260,6 +260,7 @@ get_seg_fd(char *path, int buflen, struct hugepage_info *hi, {int fd;int *out_fd; +const char *huge_path;struct stat st;int ret; const struct internal_config *internal_conf =
@@ -276,12 +277,18 @@ get_seg_fd(char *path, int buflen, struct hugepage_info *hi,if (internal_conf->single_file_segments) { out_fd = &fd_list[list_idx].memseg_list_fd; -eal_get_hugefile_path (path, buflen, hi->hugedir, list_idx); + huge_path =eal_get_hugefile_path (path, buflen, hi->hugedir, list_idx); }else { out_fd = &fd_list[list_idx].fds[seg_idx]; -eal_get_hugefile_path (path, buflen, hi->hugedir, + huge_path =eal_get_hugefile_path (path, buflen, hi->hugedir, list_idx *RTE_MAX_MEMSEG_PER_LIST + seg_idx); } +if (huge_path ==NULL ) { +EAL_LOG (DEBUG ,"%s(): hugefile path truncated: '%s'" , + __func__, path); +return -1 ; + } + fd = *out_fd;if (fd >=0 )return fd;
lib/eal/linux/eal_memory.c +7 -2
@@ -337,8 +337,13 @@ map_all_hugepages(struct hugepage_file *hugepg_tbl, struct hugepage_info *hpi, hf->file_id = i; hf->size = hugepage_sz; -eal_get_hugefile_path (hf->filepath,sizeof (hf->filepath), - hpi->hugedir, hf->file_id); +if (eal_get_hugefile_path (hf->filepath,sizeof (hf->filepath), + hpi->hugedir, hf->file_id) ==NULL ) { +EAL_LOG (DEBUG ,"%s(): huge file path '%s' truncated" , + __func__, hf->filepath); + goto out; + } + hf->filepath[sizeof (hf->filepath) -1 ] ='\0' ;/* try to create hugepage file */
Signature · 1 line
2.51.0
PATCH v7 13/18 eal: check tailq length
In reply to Stephen HemmingerThe tailq name should not be allowed to exceed limits.
--- lib/eal/common/eal_common_tailqs.c | 5 +++++ 1 file changed, 5 insertions(+)
lib/eal/common/eal_common_tailqs.c +5 -0
@@ -67,6 +67,11 @@ rte_eal_tailq_create(const char *name) {struct rte_tailq_head *head =NULL ; +if (strlen (name) >=sizeof (head->name)) { +EAL_LOG (ERR ,"tailq name '%s' is too long" , name); +return NULL ; + } +if (!rte_eal_tailq_lookup (name) && (rte_tailqs_count +1 <RTE_MAX_TAILQ )) {struct rte_mem_config *mcfg;
Signature · 1 line
2.51.0
PATCH v7 14/18 eal: handle long shared library path
In reply to Stephen HemmingerInstead of a fixed size shared library path that could in theory get truncated when concatenating, use a dynamically allocated buffer via asprintf.
--- lib/eal/common/eal_common_options.c | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-)
lib/eal/common/eal_common_options.c +13 -4
@@ -570,7 +570,6 @@ static int eal_plugindir_init(const char *path) {struct dirent *dent =NULL ; -char sopath[PATH_MAX ];DIR *d =NULL ;if (path ==NULL || *path =='\0' )
@@ -584,19 +583,29 @@ eal_plugindir_init(const char *path) }while ((dent =readdir (d)) !=NULL ) { +char *sopath =NULL ;struct stat sb;if (!ends_with (dent->d_name,".so" ) && !ends_with (dent->d_name,".so." ABI_VERSION ))continue ; -snprintf (sopath,sizeof (sopath),"%s/%s" , path, dent->d_name); +if (asprintf (&sopath,"%s/%s" , path, dent->d_name) <0 ) { +EAL_LOG (ERR ,"failed to create full path %s/%s" , + path, dent->d_name); +continue ; + }/* if a regular file, add to list to load */ -if (!(stat (sopath, &sb) ==0 &&S_ISREG (sb.st_mode))) +if (!(stat (sopath, &sb) ==0 &&S_ISREG (sb.st_mode))) { +free (sopath);continue ; + } -if (eal_plugin_add (sopath) ==-1 ) +if (eal_plugin_add (sopath) ==-1 ) { +free (sopath);break ; + } +free (sopath); }closedir (d);
Signature · 1 line
2.51.0
PATCH v7 15/18 ethdev: avoid possible overflow in xstat names
In reply to Stephen HemmingerThe compiler doesn't know that all the elements in the table of queue stats are short enough to avoid overflowing the snprintf. Add a condition to warn if it ever does;
maybe some day a new long named queue stat could be added.
--- lib/ethdev/rte_ethdev.c | 35 ++++++++++++++++++++++++----------- 1 file changed, 24 insertions(+), 11 deletions(-)
lib/ethdev/rte_ethdev.c +24 -11
@@ -3489,9 +3489,10 @@ eth_basic_stats_get_names(struct rte_eth_dev *dev,uint16_t num_q;for (idx =0 ; idx <RTE_NB_STATS ; idx++) { -strlcpy (xstats_names[cnt_used_entries].name, - eth_dev_stats_strings[idx].name, -sizeof (xstats_names[0 ].name)); +if (strlcpy (xstats_names[cnt_used_entries].name, eth_dev_stats_strings[idx].name, +sizeof (xstats_names[0 ].name)) >=sizeof (xstats_names[0 ].name)) +RTE_ETHDEV_LOG_LINE (ERR ,"statistic name '%s' will be truncated" , + xstats_names[cnt_used_entries].name); cnt_used_entries++; }
@@ -3501,10 +3502,17 @@ eth_basic_stats_get_names(struct rte_eth_dev *dev, num_q =RTE_MIN (dev->data->nb_rx_queues,RTE_ETHDEV_QUEUE_STAT_CNTRS );for (id_queue =0 ; id_queue < num_q; id_queue++) {for (idx =0 ; idx <RTE_NB_RXQ_STATS ; idx++) { -snprintf (xstats_names[cnt_used_entries].name, -sizeof (xstats_names[0 ].name), -"rx_q%u_%s" , - id_queue, eth_dev_rxq_stats_strings[idx].name); +unsigned int cc; + + cc =snprintf (xstats_names[cnt_used_entries].name, +sizeof (xstats_names[0 ].name), +"rx_q%u_%s" , + id_queue, eth_dev_rxq_stats_strings[idx].name); + +/* could only happen if a long string was added */ +if (cc >=sizeof (xstats_names[0 ].name)) +RTE_ETHDEV_LOG_LINE (ERR ,"truncated rxq stat string '%s'" , + eth_dev_rxq_stats_strings[idx].name); cnt_used_entries++; }
@@ -3512,10 +3520,15 @@ eth_basic_stats_get_names(struct rte_eth_dev *dev, num_q =RTE_MIN (dev->data->nb_tx_queues,RTE_ETHDEV_QUEUE_STAT_CNTRS );for (id_queue =0 ; id_queue < num_q; id_queue++) {for (idx =0 ; idx <RTE_NB_TXQ_STATS ; idx++) { -snprintf (xstats_names[cnt_used_entries].name, -sizeof (xstats_names[0 ].name), -"tx_q%u_%s" , - id_queue, eth_dev_txq_stats_strings[idx].name); +unsigned int cc; + + cc =snprintf (xstats_names[cnt_used_entries].name, +sizeof (xstats_names[0 ].name), +"tx_q%u_%s" , + id_queue, eth_dev_txq_stats_strings[idx].name); +if (cc >=sizeof (xstats_names[0 ].name)) +RTE_ETHDEV_LOG_LINE (ERR ,"truncated txq stat string '%s'" , + eth_dev_txq_stats_strings[idx].name); cnt_used_entries++; } }
Signature · 1 line
2.51.0
PATCH v7 16/18 vhost: check for overflow in xstat name
In reply to Stephen HemmingerThe snprintf to format an xstat name could overflow if called with a long rte_vhost_stat_name. Check if that happens and warn.
--- lib/vhost/vhost.c | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-)
lib/vhost/vhost.c +10 -4
@@ -2200,6 +2200,7 @@ rte_vhost_vring_stats_get_names(int vid, uint16_t queue_id, {struct virtio_net *dev =get_device (vid);unsigned int i; +int ret;if (dev ==NULL )return -1 ;
@@ -2213,10 +2214,15 @@ rte_vhost_vring_stats_get_names(int vid, uint16_t queue_id,if (name ==NULL || size <VHOST_NB_VQ_STATS )return VHOST_NB_VQ_STATS ; -for (i =0 ; i <VHOST_NB_VQ_STATS ; i++) -snprintf (name[i].name,sizeof (name[i].name),"%s_q%u_%s" , - (queue_id &1 ) ?"rx" :"tx" , - queue_id /2 , vhost_vq_stat_strings[i].name); +for (i =0 ; i <VHOST_NB_VQ_STATS ; i++) { + ret =snprintf (name[i].name,sizeof (name[i].name),"%s_q%u_%s" , + (queue_id &1 ) ?"rx" :"tx" , + queue_id /2 , vhost_vq_stat_strings[i].name); +if (ret >= (int )sizeof (name[0 ].name)) +VHOST_CONFIG_LOG ("device" ,NOTICE ,"truncated xstat '%s_q%u_%s'" , + (queue_id &1 ) ?"rx" :"tx" , + queue_id /2 , vhost_vq_stat_strings[i].name); + }return VHOST_NB_VQ_STATS ; }
Signature · 1 line
2.51.0
PATCH v7 17/18 cfgfile: add length checks and increase line buffer
In reply to Stephen HemmingerWhen adding values to config info, add string length checks instead of silently truncating. Increase the size of the buffer used to read from a config file so that there will be enough space for longest entries.
--- lib/cfgfile/rte_cfgfile.c | 43 +++++++++++++++++++++++++++++++-------- 1 file changed, 34 insertions(+), 9 deletions(-)
lib/cfgfile/rte_cfgfile.c +34 -9
@@ -2,16 +2,24 @@* Copyright(c) 2010-2014 Intel Corporation */ +#include <assert.h> #include <stdio.h> #include <stdlib.h> #include <string.h> #include <ctype.h> #include <errno.h> +#include <limits.h> + +#ifndef LINE_MAX +#define LINE_MAX 2048 +#endif +#include <eal_export.h> #include <rte_string_fns.h> #include <rte_common.h> #include <rte_log.h> +#include "rte_cfgfile.h" struct rte_cfgfile_section {
@@ -106,6 +114,9 @@ static int _add_entry(struct rte_cfgfile_section *section, const char *entryname, const char *entryvalue) { + if (strlen(entryname) >= CFG_NAME_LEN || strlen(entryvalue) >= CFG_VALUE_LEN) + return -ENAMETOOLONG; +/* resize entry structure if we don't have room for more entries */ if (section->num_entries == section->allocated_entries) { struct rte_cfgfile_entry *n_entries = realloc(
@@ -167,12 +178,16 @@ rte_cfgfile_load(const char *filename, int flags) &default_cfgfile_params); } +/* Need enough space for largest name and value */ +static_assert (LINE_MAX >CFG_NAME_LEN +CFG_VALUE_LEN +4 , +"not enough space for cfgfile name/value" ); +RTE_EXPORT_SYMBOL (rte_cfgfile_load_with_params) struct rte_cfgfile *rte_cfgfile_load_with_params (const char *filename,int flags,const struct rte_cfgfile_parameters *params) { -char buffer[CFG_NAME_LEN +CFG_VALUE_LEN +4 ]; +char buffer[LINE_MAX ];int lineno =0 ;struct rte_cfgfile *cfg;
@@ -219,7 +234,13 @@ rte_cfgfile_load_with_params(const char *filename, int flags, *end ='\0' ;_strip (&buffer[1 ], end - &buffer[1 ]); -rte_cfgfile_add_section (cfg, &buffer[1 ]); +int ret =rte_cfgfile_add_section (cfg, &buffer[1 ]); +if (ret !=0 ) { +CFG_LOG (ERR , +"line %d - add section failed: %s" , + lineno,strerror (-ret)); + goto error1; + } }else {/* key and value line */ char *split[2 ] = {NULL };
@@ -260,8 +281,13 @@ rte_cfgfile_load_with_params(const char *filename, int flags,if (cfg->num_sections ==0 ) goto error1; -_add_entry (&cfg->sections[cfg->num_sections -1 ], - split[0 ], split[1 ]); +int ret =_add_entry (&cfg->sections[cfg->num_sections -1 ], + split[0 ], split[1 ]); +if (ret !=0 ) { +CFG_LOG (ERR , +"line %d - add entry failed: %s" , lineno,strerror (-ret)); + goto error1; + } } }fclose (f);
@@ -341,6 +367,9 @@ rte_cfgfile_add_section(struct rte_cfgfile *cfg, const char *sectionname)if (sectionname ==NULL )return -EINVAL ; +if (strlen (sectionname) >=CFG_NAME_LEN ) +return -ENAMETOOLONG ; +/* resize overall struct if we don't have room for more sections */ if (cfg->num_sections == cfg->allocated_sections) {
@@ -376,8 +405,6 @@ int rte_cfgfile_add_entry(struct rte_cfgfile *cfg, const char *sectionname, const char *entryname, const char *entryvalue) { - int ret; - if ((cfg == NULL) || (sectionname == NULL) || (entryname == NULL) || (entryvalue == NULL)) return -EINVAL;
@@ -391,9 +418,7 @@ int rte_cfgfile_add_entry(struct rte_cfgfile *cfg,if (curr_section ==NULL )return -EINVAL ; - ret =_add_entry (curr_section, entryname, entryvalue); - -return ret; +return _add_entry (curr_section, entryname, entryvalue); }RTE_EXPORT_SYMBOL (rte_cfgfile_set_entry)
Signature · 1 line
2.51.0
PATCH v7 18/18 lib: enable format overflow warnings
In reply to Stephen HemmingerEnable compiler checking of format overflow
--- lib/meson.build | 4 ---- 1 file changed, 4 deletions(-)
lib/meson.build +0 -4
@@ -113,10 +113,6 @@ default_cflags = machine_args default_cflags += ['-DALLOW_EXPERIMENTAL_API'] default_cflags += ['-DALLOW_INTERNAL_API'] -if cc.has_argument('-Wno-format-truncation') - default_cflags += '-Wno-format-truncation' -endif - foreach l:libraries build = true reason = '<unknown reason>' # set if build == false to explain why
Signature · 1 line
2.51.0
v8 cover fix format overflows in libraries
In reply to Stephen HemmingerChange all the libraries to find and fix cases where a string could overflow when formatting or using strclpy. This does provide early indication of possible problems where the file prefix is too long to fit in unix domain socket path, and where a hash table is being requested that has a name too long.
v8 - small changes such as adding updates to docbook comments
and avoiding asprintf where not needed
Stephen Hemminger (18):
lpm: restrict name size
hash: add checks for hash name length
graph: avoid overflowing comment buffer
latencystats: add check for string overflow
telemetry: check for path overflow
efd: handle possible name truncation
eal: use C library to parse filesystem table
eal: warn if thread name is truncated
eal: avoid format overflow when handling addresses
eal: add check for sysfs path overflow
eal: limit maximum runtime directory and socket paths
eal: check for hugefile path overflow
eal: check tailq length
eal: handle long shared library path
ethdev: avoid possible overflow in xstat names
vhost: check for overflow in xstat name
cfgfile: add length checks and increase line buffer
lib: enable format overflow warnings
app/test/test_hash.c | 21 ++++++ doc/guides/rel_notes/release_26_03.rst | 3 + lib/cfgfile/rte_cfgfile.c | 43 ++++++++--- lib/cfgfile/rte_cfgfile.h | 6 +- lib/eal/common/eal_common_config.c | 6 +- lib/eal/common/eal_common_memory.c | 2 +- lib/eal/common/eal_common_options.c | 17 +++-- lib/eal/common/eal_common_proc.c | 83 ++++++++++++++-------- lib/eal/common/eal_common_tailqs.c | 13 +++- lib/eal/common/eal_filesystem.h | 23 ++++-- lib/eal/freebsd/eal.c | 6 +- lib/eal/linux/eal.c | 6 +- lib/eal/linux/eal_hugepage_info.c | 98 ++++++++++++-------------- lib/eal/linux/eal_memalloc.c | 11 ++- lib/eal/linux/eal_memory.c | 9 ++- lib/eal/windows/eal.c | 6 +- lib/efd/rte_efd.c | 18 +++-- lib/ethdev/rte_ethdev.c | 35 ++++++--- lib/graph/graph_pcap.c | 9 ++- lib/hash/rte_cuckoo_hash.c | 41 +++++++---- lib/hash/rte_fbk_hash.c | 12 +++- lib/hash/rte_fbk_hash.h | 1 + lib/latencystats/rte_latencystats.c | 9 ++- lib/lpm/rte_lpm.c | 16 +++-- lib/lpm/rte_lpm.h | 1 + lib/meson.build | 4 -- lib/telemetry/telemetry_legacy.c | 7 +- lib/vhost/vhost.c | 14 ++-- 28 files changed, 354 insertions(+), 166 deletions(-)
Signature · 1 line
2.51.0
PATCH v8 1/18 lpm: restrict name size
Check that lpm name size is within limits and add checks for truncation.
--- lib/lpm/rte_lpm.c | 16 ++++++++++++---- lib/lpm/rte_lpm.h | 1 + 2 files changed, 13 insertions(+), 4 deletions(-)
lib/lpm/rte_lpm.c +12 -4
@@ -152,7 +152,7 @@ struct rte_lpm * rte_lpm_create(const char *name, int socket_id, const struct rte_lpm_config *config) { - char mem_name[RTE_LPM_NAMESIZE]; + char mem_name[RTE_LPM_NAMESIZE + sizeof("LPM_")];struct __rte_lpm *i_lpm;struct rte_lpm *lpm =NULL ;struct rte_tailq_entry *te;
@@ -170,6 +170,11 @@ rte_lpm_create(const char *name, int socket_id,return NULL ; } +if (strlen (name) >=RTE_LPM_NAMESIZE ) { + rte_errno =ENAMETOOLONG ; +return NULL ; + } +snprintf (mem_name,sizeof (mem_name),"LPM_%s" , name);rte_mcfg_tailq_write_lock ();
@@ -327,8 +332,10 @@ rte_lpm_rcu_qsbr_add(struct rte_lpm *lpm, struct rte_lpm_rcu_config *cfg)/* No other things to do. */ }else if (cfg->mode ==RTE_LPM_QSBR_MODE_DQ ) {/* Init QSBR defer queue. */ -snprintf (rcu_dq_name,sizeof (rcu_dq_name), -"LPM_RCU_%s" , i_lpm->name); +if (snprintf (rcu_dq_name,sizeof (rcu_dq_name), +"LPM_RCU_%s" , i_lpm->name) >= (int )sizeof (rcu_dq_name)) +LPM_LOG (NOTICE ,"LPM rcu defer queue name truncated" ); + params.name = rcu_dq_name; params.size = cfg->dq_size;if (params.size ==0 )
@@ -343,7 +350,8 @@ rte_lpm_rcu_qsbr_add(struct rte_lpm *lpm, struct rte_lpm_rcu_config *cfg) params.v = cfg->v; i_lpm->dq =rte_rcu_qsbr_dq_create (¶ms);if (i_lpm->dq ==NULL ) { -LPM_LOG (ERR ,"LPM defer queue creation failed" ); +LPM_LOG (ERR ,"LPM defer queue creation failed: %s" , +rte_strerror (rte_errno));return 1 ; } }else {
lib/lpm/rte_lpm.h +1 -0
@@ -180,6 +180,7 @@ rte_lpm_free(struct rte_lpm *lpm);* - ENOSPC - the maximum number of memzones has already been allocated * - EEXIST - a memzone with the same name already exists * - ENOMEM - no appropriate memory area found in which to create memzone +* - ENAMETOOLONG - LPM object name greater than RTE_LPM_NAMESIZE */ struct rte_lpm * rte_lpm_create(const char *name, int socket_id,
Signature · 1 line
2.51.0
PATCH v8 2/18 hash: add checks for hash name length
In reply to Stephen HemmingerAdd a missing check to the API that the name is within the current defined maximum name size. This name is then used internally to create ring names, those names could get truncated; if a name is truncated add message to log.
If ring creation fails it might be because of name conflict, so change the log message to decode error value.
Add additional tests as well.
--- app/test/test_hash.c | 21 +++++++++++++ doc/guides/rel_notes/release_26_03.rst | 3 ++ lib/hash/rte_cuckoo_hash.c | 41 ++++++++++++++++++-------- lib/hash/rte_fbk_hash.c | 12 ++++++-- lib/hash/rte_fbk_hash.h | 1 + 5 files changed, 63 insertions(+), 15 deletions(-)
app/test/test_hash.c +21 -0
@@ -1120,6 +1120,14 @@ fbk_hash_unit_test(void) .socket_id = RTE_MAX_NUMA_NODES + 1, /* invalid socket */ }; +/* try and create hash with an excessively long name */ +struct rte_fbk_hash_params invalid_params_long_name = { + .name ="four_byte_key_hash_name_length_32" , + .entries =4 , + .entries_per_bucket =2 , + .socket_id =0 , + }; +/* try to create two hashes with identical names * in this case, trying to create a second one will not * fail but will simply return pointer to the existing
@@ -1201,6 +1209,9 @@ fbk_hash_unit_test(void) handle =rte_fbk_hash_create (&invalid_params_7);RETURN_IF_ERROR_FBK (handle !=NULL ,"fbk hash creation should have failed" ); + handle =rte_fbk_hash_create (&invalid_params_long_name); +RETURN_IF_ERROR_FBK (handle !=NULL ,"fbk hash creation should have failed" ); +if (rte_eal_has_hugepages ()) { handle =rte_fbk_hash_create (&invalid_params_8); RETURN_IF_ERROR_FBK(handle != NULL,
@@ -1439,6 +1450,16 @@ static int test_hash_creation_with_bad_parameters(void)return -1 ; } +memcpy (¶ms, &ut_params,sizeof (params)); + params.name ="hash_creation_with_too_long_name" ; + params.socket_id =RTE_MAX_NUMA_NODES +1 ; + handle =rte_hash_create (¶ms); +if (handle !=NULL ) { +rte_hash_free (handle); +printf ("Impossible creating hash successfully with long name\n" ); +return -1 ; + } +/* test with same name should fail */ memcpy (¶ms, &ut_params,sizeof (params)); params.name ="same_name" ;
doc/guides/rel_notes/release_26_03.rst +3 -0
@@ -84,6 +84,9 @@ API Changes Also, make sure to start the actual text at the margin. ======================================================= +* hash: Added name length validation to hash creation. + The hash name in hash parameters is now checked against RTE_HASH_NAMESIZE. + ABI Changes -----------
lib/hash/rte_cuckoo_hash.c +29 -12
89 lines not on this page · raw message
lib/hash/rte_fbk_hash.c +9 -3
@@ -5,6 +5,7 @@#include <stdint.h> #include <stdio.h> #include <string.h> +#include <stdlib.h> #include <errno.h> #include <sys/queue.h>
@@ -83,7 +84,7 @@ rte_fbk_hash_create(const struct rte_fbk_hash_params *params) {struct rte_fbk_hash_table *ht =NULL ;struct rte_tailq_entry *te; -char hash_name[RTE_FBK_HASH_NAMESIZE ]; +char hash_name[RTE_FBK_HASH_NAMESIZE +sizeof ("FBK_" )];const uint32_t mem_size =sizeof (*ht) + (sizeof (ht->t[0 ]) * params->entries);uint32_t i;
@@ -96,6 +97,7 @@ rte_fbk_hash_create(const struct rte_fbk_hash_params *params)/* Error checking of parameters. */ if ((!rte_is_power_of_2(params->entries)) || (!rte_is_power_of_2(params->entries_per_bucket)) || + (params->name == NULL) || (params->entries == 0) || (params->entries_per_bucket == 0) || (params->entries_per_bucket > params->entries) ||
@@ -105,6 +107,11 @@ rte_fbk_hash_create(const struct rte_fbk_hash_params *params)return NULL ; } +if (strlen (params->name) >=RTE_FBK_HASH_NAMESIZE ) { + rte_errno =ENAMETOOLONG ; +return NULL ; + } +snprintf (hash_name,sizeof (hash_name),"FBK_%s" , params->name);rte_mcfg_tailq_write_lock ();
@@ -128,8 +135,7 @@ rte_fbk_hash_create(const struct rte_fbk_hash_params *params) }/* Allocate memory for table. */ - ht =rte_zmalloc_socket (hash_name, mem_size, -0 , params->socket_id); + ht =rte_zmalloc_socket (hash_name, mem_size,0 , params->socket_id);if (ht ==NULL ) {HASH_LOG (ERR ,"Failed to allocate fbk hash table" );rte_free (te);
lib/hash/rte_fbk_hash.h +1 -0
@@ -348,6 +348,7 @@ void rte_fbk_hash_free(struct rte_fbk_hash_table *ht);* - ENOSPC - the maximum number of memzones has already been allocated * - EEXIST - a memzone with the same name already exists * - ENOMEM - no appropriate memory area found in which to create memzone +* - ENAMETOOLONG - name is parameters exceeds RTE_FBK_HASH_NAMESIZE */ struct rte_fbk_hash_table *rte_fbk_hash_create (const struct rte_fbk_hash_params *params)
Signature · 1 line
2.51.0
PATCH v8 3/18 graph: avoid overflowing comment buffer
In reply to Stephen HemmingerThe library builds a pcapng comment to put on each packet but the buffer is not big enough for the largest possible graph node name, etc. Change to use asprintf() to allow any string length. Note, if asprintf() fails it is better to still log the packet without comment so no data is lost.
--- lib/graph/graph_pcap.c | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-)
lib/graph/graph_pcap.c +6 -3
@@ -194,7 +194,7 @@ graph_pcap_dispatch(struct rte_graph *graph, uint16_t nb_objs) {struct rte_mbuf *mbuf_clones[RTE_GRAPH_BURST_SIZE ]; -char buffer[GRAPH_PCAP_BUF_SZ ]; +char *comment =NULL ;uint64_t i, num_packets;struct rte_mbuf *mbuf;ssize_t len;
@@ -207,19 +207,22 @@ graph_pcap_dispatch(struct rte_graph *graph,if (num_packets > nb_objs) num_packets = nb_objs; -snprintf (buffer,GRAPH_PCAP_BUF_SZ ,"%s: %s" , graph->name, node->name); +/* put a comment on all these packets */ +if (asprintf (&comment,"%s: %s" , graph->name, node->name) <0 ) +graph_err ("asprintf for comment failed." );for (i =0 ; i < num_packets; i++) {struct rte_mbuf *mc; mbuf = (struct rte_mbuf *)objs[i]; mc =rte_pcapng_copy (mbuf->port,0 , mbuf, pkt_mp, mbuf->pkt_len, -0 , buffer); +0 , comment);if (mc ==NULL )break ; mbuf_clones[i] = mc; } +free (comment);/* write it to capture file */ len =rte_pcapng_write_packets (pcapng_fd, mbuf_clones, i);
Signature · 1 line
2.51.0
PATCH v8 4/18 latencystats: add check for string overflow
In reply to Stephen HemmingerThe copy of latency stat names could get truncated if in the future a new value is added. Add warning if that happens.
--- lib/latencystats/rte_latencystats.c | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-)
lib/latencystats/rte_latencystats.c +6 -3
@@ -405,9 +405,12 @@ rte_latencystats_get_names(struct rte_metric_name *names, uint16_t size)if (names ==NULL || size <NUM_LATENCY_STATS )return NUM_LATENCY_STATS ; -for (i =0 ; i <NUM_LATENCY_STATS ; i++) -strlcpy (names[i].name, lat_stats_strings[i].name, -sizeof (names[i].name)); +for (i =0 ; i <NUM_LATENCY_STATS ; i++) { +if (strlcpy (names[i].name, lat_stats_strings[i].name,sizeof (names[0 ].name)) + >=sizeof (names[0 ].name)) +LATENCY_STATS_LOG (NOTICE ,"Latency metric '%s' too long" , + lat_stats_strings[i].name); + }return NUM_LATENCY_STATS ; }
Signature · 1 line
2.51.0
PATCH v8 5/18 telemetry: check for path overflow
In reply to Stephen HemmingerThe unix domain socket path is limited, check for overflow.
--- lib/telemetry/telemetry_legacy.c | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-)
lib/telemetry/telemetry_legacy.c +5 -2
@@ -102,14 +102,17 @@ register_client(const char *cmd __rte_unused, const char *params,return -1 ; } *strchr (data,'\"' ) =0 ; + addrs.sun_family =AF_UNIX ; +if (strlcpy (addrs.sun_path, data,sizeof (addrs.sun_path)) >=sizeof (addrs.sun_path)) { +fprintf (stderr,"Client path too long\n" ); +return -1 ; + } fd =socket (AF_UNIX ,SOCK_SEQPACKET ,0 );if (fd <0 ) {perror ("Failed to open socket" );return -1 ; } - addrs.sun_family =AF_UNIX ; -strlcpy (addrs.sun_path, data,sizeof (addrs.sun_path));if (connect (fd, (struct sockaddr *)&addrs,sizeof (addrs)) ==-1 ) {perror ("\nClient connection error\n" );
Signature · 1 line
2.51.0
PATCH v8 6/18 efd: handle possible name truncation
In reply to Stephen HemmingerIf the conversion of efd name to ring name gets truncated, then log it. And if the ring name than causes collision, make sure that log message includes error reason.
--- lib/efd/rte_efd.c | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-)
lib/efd/rte_efd.c +14 -4
@@ -517,13 +517,20 @@ rte_efd_create(const char *name, uint32_t max_num_rules, uint32_t key_len, efd_list =RTE_TAILQ_CAST (rte_efd_tailq.head, rte_efd_list);if (online_cpu_socket_bitmask ==0 ) { -EFD_LOG (ERR ,"At least one CPU socket must be enabled " -"in the bitmask" ); +EFD_LOG (ERR ,"At least one CPU socket must be enabled in the bitmask" ); + rte_errno =EINVAL ;return NULL ; }if (max_num_rules ==0 ) {EFD_LOG (ERR ,"Max num rules must be higher than 0" ); + rte_errno =EINVAL ; +return NULL ; + } + +if (strlen (name) >=RTE_EFD_NAMESIZE ) { +EFD_LOG (ERR ,"Name is too long" ); + rte_errno =ENAMETOOLONG ;return NULL ; }
@@ -698,12 +705,15 @@ rte_efd_create(const char *name, uint32_t max_num_rules, uint32_t key_len,TAILQ_INSERT_TAIL (efd_list, te, next);rte_mcfg_tailq_write_unlock (); -snprintf (ring_name,sizeof (ring_name),"HT_%s" , table->name); +if (snprintf (ring_name,sizeof (ring_name),"HT_%s" , table->name) + >= (int )sizeof (ring_name)) +EFD_LOG (NOTICE ,"EFD ring name truncated to '%s'" , ring_name); +/* Create ring (Dummy slot index is not enqueued) */ r =rte_ring_create (ring_name,rte_align32pow2 (table->max_num_rules), offline_cpu_socket,0 );if (r ==NULL ) { -EFD_LOG (ERR ,"memory allocation failed" ); +EFD_LOG (ERR ,"ring creation failed: %s" ,rte_strerror (rte_errno));rte_efd_free (table);return NULL ; }
Signature · 1 line
2.51.0
PATCH v8 7/18 eal: use C library to parse filesystem table
In reply to Stephen HemmingerRather than doing parsing of /proc/mounts with open coded string handling, use the standard C library routines.
These exist in BSD and Linux.
It also avoids any possible issues with escaped strings etc which the library handles. See getmntent(3) man page.
--- lib/eal/linux/eal_hugepage_info.c | 58 ++++++++++--------------------- 1 file changed, 18 insertions(+), 40 deletions(-)
lib/eal/linux/eal_hugepage_info.c +18 -40
@@ -13,6 +13,7 @@#include <inttypes.h> #include <unistd.h> #include <errno.h> +#include <mntent.h> #include <sys/mman.h> #include <sys/stat.h>
@@ -195,23 +196,13 @@ get_default_hp_size(void)static int get_hugepage_dir (uint64_t hugepage_sz,char *hugedir,int len) { -enum proc_mount_fieldnames { -DEVICE =0 , -MOUNTPT , -FSTYPE , -OPTIONS , - _FIELDNAME_MAX - };static uint64_t default_size =0 ;const char proc_mounts[] ="/proc/mounts" ; -const char hugetlbfs_str[] ="hugetlbfs" ; -const size_t htlbfs_str_len =sizeof (hugetlbfs_str) -1 ;const char pagesize_opt[] ="pagesize=" ;const size_t pagesize_opt_len =sizeof (pagesize_opt) -1 ; -const char split_tok =' ' ; -char *splitstr[_FIELDNAME_MAX];char found[PATH_MAX ] ="" ;char buf[BUFSIZ ]; +struct mntent entry;const struct internal_config *internal_conf =eal_get_internal_configuration (); const size_t hugepage_dir_len = (internal_conf->hugepage_dir != NULL) ?
@@ -226,56 +217,43 @@ get_hugepage_dir(uint64_t hugepage_sz, char *hugedir, int len)return -1 ; } -FILE *fd =fopen (proc_mounts,"r" ); -if (fd ==NULL ) +FILE *mounts =setmntent (proc_mounts,"r" ); +if (mounts ==NULL )rte_panic ("Cannot open %s\n" , proc_mounts);if (default_size ==0 ) default_size =get_default_hp_size (); -while (fgets (buf,sizeof (buf), fd)){ +while (getmntent_r (mounts, &entry, buf,sizeof (buf))) {const char *pagesz_str; -size_t mountpt_len =0 ; - -if (rte_strsplit (buf,sizeof (buf), splitstr, _FIELDNAME_MAX, - split_tok) != _FIELDNAME_MAX) { -EAL_LOG (ERR ,"Error parsing %s" , proc_mounts); -break ;/* return NULL */ - } +uint64_t pagesz = default_size; +size_t mountpt_len; -if (strncmp (splitstr[FSTYPE ], hugetlbfs_str, htlbfs_str_len) !=0 ) +if (strcmp (entry.mnt_type,"hugetlbfs" ) !=0 )continue ; - pagesz_str =strstr (splitstr[OPTIONS ], pagesize_opt); + pagesz_str =strstr (entry.mnt_opts, pagesize_opt); +if (pagesz_str) + pagesz =rte_str_to_size (&pagesz_str[pagesize_opt_len]); -/* if no explicit page size, the default page size is compared */ -if (pagesz_str ==NULL ) { -if (hugepage_sz != default_size) -continue ; - } -/* there is an explicit page size, so check it */ -else { -uint64_t pagesz =rte_str_to_size (&pagesz_str[pagesize_opt_len]); -if (pagesz != hugepage_sz) -continue ; - } +if (pagesz != hugepage_sz) +continue ;/* * If no --huge-dir option has been given, we're done. */ if (internal_conf->hugepage_dir ==NULL ) { -strlcpy (found, splitstr[MOUNTPT ], len); +strlcpy (found, entry.mnt_dir, len);break ; } - mountpt_len =strlen (splitstr[MOUNTPT ]); + mountpt_len =strlen (entry.mnt_dir);/* * Ignore any mount that doesn't contain the --huge-dir directory * or where mount point is not a parent path of --huge-dir */ -if (strncmp (internal_conf->hugepage_dir, splitstr[MOUNTPT ], - mountpt_len) !=0 || +if (strncmp (internal_conf->hugepage_dir, entry.mnt_dir, mountpt_len) !=0 || (hugepage_dir_len > mountpt_len && internal_conf->hugepage_dir[mountpt_len] !='/' )) {continue ;
@@ -286,10 +264,10 @@ get_hugepage_dir(uint64_t hugepage_sz, char *hugedir, int len)* (so /mnt/1 is preferred over /mnt for matching /mnt/1/2)). */ if (mountpt_len >strlen (found)) -strlcpy (found, splitstr[MOUNTPT ], len); +strlcpy (found, entry.mnt_dir, len); }/* end while fgets */ -fclose (fd); +endmntent (mounts);if (found[0 ] !='\0' ) {/* If needed, return the requested dir, not the mount point. */
Signature · 1 line
2.51.0
PATCH v8 8/18 eal: warn if thread name is truncated
In reply to Stephen HemmingerThread name is very short 16 characters and therefore the name dpdk-worker-%d will overflow with more than 9999 worker cores. Error should be non-fatal since name only matters for debug.
--- lib/eal/freebsd/eal.c | 6 ++++-- lib/eal/linux/eal.c | 6 ++++-- lib/eal/windows/eal.c | 6 ++++-- 3 files changed, 12 insertions(+), 6 deletions(-)
lib/eal/freebsd/eal.c +4 -2
@@ -690,8 +690,10 @@ rte_eal_init(int argc, char **argv)rte_panic ("Cannot create thread\n" );/* Set thread_name for aid in debugging. */ -snprintf (thread_name,sizeof (thread_name), -"dpdk-worker%d" , i); + ret =snprintf (thread_name,sizeof (thread_name),"dpdk-worker%d" , i); +if (ret >= (int )sizeof (thread_name)) +EAL_LOG (INFO ,"Worker thread name %s truncated" , thread_name); +rte_thread_set_name (lcore_config[i].thread_id, thread_name); ret = rte_thread_set_affinity_by_id(lcore_config[i].thread_id,
lib/eal/linux/eal.c +4 -2
@@ -863,8 +863,10 @@ rte_eal_init(int argc, char **argv)rte_panic ("Cannot create thread\n" );/* Set thread_name for aid in debugging. */ -snprintf (thread_name,sizeof (thread_name), -"dpdk-worker%d" , i); + ret =snprintf (thread_name,sizeof (thread_name),"dpdk-worker%d" , i); +if (ret >=RTE_THREAD_NAME_SIZE ) +EAL_LOG (INFO ,"Worker thread name %s truncated" , thread_name); +rte_thread_set_name (lcore_config[i].thread_id, thread_name); ret = rte_thread_set_affinity_by_id(lcore_config[i].thread_id,
lib/eal/windows/eal.c +4 -2
@@ -378,8 +378,10 @@ rte_eal_init(int argc, char **argv)rte_panic ("Cannot create thread\n" );/* Set thread name for aid in debugging. */ -snprintf (thread_name,sizeof (thread_name), -"dpdk-worker%d" , i); + ret =snprintf (thread_name,sizeof (thread_name),"dpdk-worker%d" , i); +if (ret >= (int )sizeof (thread_name)) +EAL_LOG (INFO ,"Worker thread name %s truncated" , thread_name); +rte_thread_set_name (lcore_config[i].thread_id, thread_name); ret = rte_thread_set_affinity_by_id(lcore_config[i].thread_id,
Signature · 1 line
2.51.0
PATCH v8 9/18 eal: avoid format overflow when handling addresses
In reply to Stephen HemmingerThe largest possible string in this code 0xFFFFFFFFFFFFFFFF which will overflow with only 15 character buffer. Increase to 20.
--- lib/eal/common/eal_common_memory.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
lib/eal/common/eal_common_memory.c +1 -1
@@ -1153,7 +1153,7 @@ rte_eal_memory_init(void)#define EAL_MEMSEG_INFO_REQ "/eal/memseg_info"#define EAL_ELEMENT_LIST_REQ "/eal/mem_element_list"#define EAL_ELEMENT_INFO_REQ "/eal/mem_element_info" -#define ADDR_STR 15 +#define ADDR_STR 20/* 16 bytes 64 bit + 0x */ /* Telemetry callback handler to return heap stats for requested heap id. */
Signature · 1 line
2.51.0
PATCH v8 10/18 eal: add check for sysfs path overflow
In reply to Stephen HemmingerShouldn't happen but in theory sysfs socket could overflow. Add a check for it.
--- lib/eal/linux/eal_hugepage_info.c | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-)
lib/eal/linux/eal_hugepage_info.c +5 -1
@@ -150,8 +150,12 @@ get_num_hugepages_on_node(const char *subdir, unsigned int socket, size_t sz)return 0 ; } -snprintf (path,sizeof (path),"%s/%s/%s" , +if (snprintf (path,sizeof (path),"%s/%s/%s" , socketpath, subdir, nr_hp_file) >=PATH_MAX ) { +EAL_LOG (NOTICE ,"Socket path %s/%s/%s is truncated" , socketpath, subdir, nr_hp_file); +return 0 ; + } +if (eal_parse_sysfs_value (path, &num_pages) <0 )return 0 ;
Signature · 1 line
2.51.0
PATCH v8 11/18 eal: limit maximum runtime directory and socket paths
In reply to Stephen HemmingerLinux has a limitation of 108 characters (including null character) for AF_UNIX socket path. FreeBSD limit is smaller 104 characters and Windows has same definition (108) in afunix.h header.
In current code, EAL will fail in telemetry, so this should not break existing users.
EAL: Multi-process socket /var/run/dpdk/x7Q9mP2a...
EAL: Selected IOVA mode 'VA'
TELEMETRY: Error with socket binding, path too long
Now long string fails on command line parsing:
EAL: Runtime directory string too long
EAL: Cannot create runtime directory
EAL: Error parsing command line arguments.
--- lib/eal/common/eal_common_config.c | 6 ++- lib/eal/common/eal_common_proc.c | 83 +++++++++++++++++++----------- lib/eal/common/eal_filesystem.h | 13 ++++- 3 files changed, 70 insertions(+), 32 deletions(-)
lib/eal/common/eal_common_config.c +4 -2
@@ -6,6 +6,7 @@#include <eal_export.h> #include "eal_private.h" +#include "eal_filesystem.h" #include "eal_memcfg.h" /* early configuration structure, when memory config is not mmapped */
@@ -24,7 +25,7 @@ static struct rte_config rte_config = { };/* platform-specific runtime dir */ -static char runtime_dir[PATH_MAX ]; +static char runtime_dir[UNIX_PATH_MAX ];/* internal configuration */ static struct internal_config internal_config;
@@ -39,7 +40,8 @@ rte_eal_get_runtime_dir(void)int eal_set_runtime_dir (const char *run_dir) { -if (strlcpy (runtime_dir, run_dir,PATH_MAX ) >=PATH_MAX ) { +/* runtime directory limited by maximum allowable unix domain socket */ +if (strlcpy (runtime_dir, run_dir,UNIX_PATH_MAX ) >=UNIX_PATH_MAX ) {EAL_LOG (ERR ,"Runtime directory string too long" );return -1 ; }
lib/eal/common/eal_common_proc.c +54 -29
166 lines not on this page · raw message
lib/eal/common/eal_filesystem.h +12 -1
@@ -45,10 +45,21 @@ eal_runtime_config_path(void)/** Path of primary/secondary communication unix socket file. */ #define MP_SOCKET_FNAME "mp_socket" + +#ifdef RTE_EXEC_ENV_WINDOWS +#include <winsock2.h> +#include <afunix.h> +#else +#include <sys/un.h> + +/** Maximum length of unix domain socket path. */ +#define UNIX_PATH_MAX (sizeof(((struct sockaddr_un *)0)->sun_path)) +#endif +static inline const char *eal_mp_socket_path (void ) { -static char buffer[PATH_MAX ];/* static so auto-zeroed */ +static char buffer[UNIX_PATH_MAX ];/* static so auto-zeroed */ snprintf (buffer,sizeof (buffer),"%s/%s" ,rte_eal_get_runtime_dir (),MP_SOCKET_FNAME );
Signature · 1 line
2.51.0
PATCH v8 12/18 eal: check for hugefile path overflow
In reply to Stephen HemmingerWhen constructing huge filename path, check for possible overflow of PATH_MAX.
--- lib/eal/common/eal_filesystem.h | 10 ++++--- lib/eal/linux/eal_hugepage_info.c | 44 ++++++++++++++++++------------- lib/eal/linux/eal_memalloc.c | 11 ++++++-- lib/eal/linux/eal_memory.c | 9 +++++-- 4 files changed, 48 insertions(+), 26 deletions(-)
lib/eal/common/eal_filesystem.h +6 -4
@@ -100,12 +100,14 @@ eal_hugepage_data_path(void)/** String format for hugepage map files. */ #define HUGEFILE_FMT "%s/%smap_%d" -static inline const char * +static inline __rte_warn_unused_result const char *eal_get_hugefile_path (char *buffer,size_t buflen,const char *hugedir,int f_id) { -snprintf (buffer, buflen,HUGEFILE_FMT , hugedir, -eal_get_hugefile_prefix (), f_id); -return buffer; +if (snprintf (buffer, buflen,HUGEFILE_FMT , hugedir, +eal_get_hugefile_prefix (), f_id) >= (int )buflen) +return NULL ; +else +return buffer; }/** define the default filename prefix for the %s values above */
lib/eal/linux/eal_hugepage_info.c +26 -18
100 lines not on this page · raw message
lib/eal/linux/eal_memalloc.c +9 -2
@@ -260,6 +260,7 @@ get_seg_fd(char *path, int buflen, struct hugepage_info *hi, {int fd;int *out_fd; +const char *huge_path;struct stat st;int ret; const struct internal_config *internal_conf =
@@ -276,12 +277,18 @@ get_seg_fd(char *path, int buflen, struct hugepage_info *hi,if (internal_conf->single_file_segments) { out_fd = &fd_list[list_idx].memseg_list_fd; -eal_get_hugefile_path (path, buflen, hi->hugedir, list_idx); + huge_path =eal_get_hugefile_path (path, buflen, hi->hugedir, list_idx); }else { out_fd = &fd_list[list_idx].fds[seg_idx]; -eal_get_hugefile_path (path, buflen, hi->hugedir, + huge_path =eal_get_hugefile_path (path, buflen, hi->hugedir, list_idx *RTE_MAX_MEMSEG_PER_LIST + seg_idx); } +if (huge_path ==NULL ) { +EAL_LOG (DEBUG ,"%s(): hugefile path truncated: '%s'" , + __func__, path); +return -1 ; + } + fd = *out_fd;if (fd >=0 )return fd;
lib/eal/linux/eal_memory.c +7 -2
@@ -337,8 +337,13 @@ map_all_hugepages(struct hugepage_file *hugepg_tbl, struct hugepage_info *hpi, hf->file_id = i; hf->size = hugepage_sz; -eal_get_hugefile_path (hf->filepath,sizeof (hf->filepath), - hpi->hugedir, hf->file_id); +if (eal_get_hugefile_path (hf->filepath,sizeof (hf->filepath), + hpi->hugedir, hf->file_id) ==NULL ) { +EAL_LOG (DEBUG ,"%s(): huge file path '%s' truncated" , + __func__, hf->filepath); + goto out; + } + hf->filepath[sizeof (hf->filepath) -1 ] ='\0' ;/* try to create hugepage file */
Signature · 1 line
2.51.0
PATCH v8 13/18 eal: check tailq length
In reply to Stephen HemmingerThe tailq name should not be allowed to exceed limits.
--- lib/eal/common/eal_common_tailqs.c | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-)
lib/eal/common/eal_common_tailqs.c +12 -1
@@ -8,6 +8,7 @@#include <rte_eal.h> #include <rte_eal_memconfig.h> +#include <rte_errno.h> #include <rte_log.h> #include <rte_string_fns.h>
@@ -30,8 +31,10 @@ rte_eal_tailq_lookup(const char *name)unsigned i;struct rte_mem_config *mcfg =rte_eal_get_configuration ()->mem_config; -if (name ==NULL ) +if (name ==NULL ) { + rte_errno =EINVAL ;return NULL ; + } for (i = 0; i < RTE_MAX_TAILQ; i++) { if (!strncmp(name, mcfg->tailq_head[i].name,
@@ -39,6 +42,7 @@ rte_eal_tailq_lookup(const char *name)return &mcfg->tailq_head[i]; } + rte_errno =ENOENT ;return NULL ; }
@@ -67,6 +71,12 @@ rte_eal_tailq_create(const char *name) {struct rte_tailq_head *head =NULL ; +if (strlen (name) >=sizeof (head->name)) { +EAL_LOG (ERR ,"tailq name '%s' is too long" , name); + rte_errno =ENAMETOOLONG ; +return NULL ; + } +if (!rte_eal_tailq_lookup (name) && (rte_tailqs_count +1 <RTE_MAX_TAILQ )) {struct rte_mem_config *mcfg;
@@ -115,6 +125,7 @@ rte_eal_tailq_register(struct rte_tailq_elem *t)if (rte_eal_tailq_local_register (t) <0 ) {EAL_LOG (ERR ,"%s tailq is already registered" , t->name); + rte_errno =EEXIST ; goto error; }
Signature · 1 line
2.51.0
PATCH v8 14/18 eal: handle long shared library path
In reply to Stephen HemmingerInstead of a fixed size shared library path that could in theory get truncated when concatenating, use a dynamically allocated buffer via asprintf.
--- lib/eal/common/eal_common_options.c | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-)
lib/eal/common/eal_common_options.c +13 -4
@@ -570,7 +570,6 @@ static int eal_plugindir_init(const char *path) {struct dirent *dent =NULL ; -char sopath[PATH_MAX ];DIR *d =NULL ;if (path ==NULL || *path =='\0' )
@@ -584,19 +583,29 @@ eal_plugindir_init(const char *path) }while ((dent =readdir (d)) !=NULL ) { +char *sopath =NULL ;struct stat sb;if (!ends_with (dent->d_name,".so" ) && !ends_with (dent->d_name,".so." ABI_VERSION ))continue ; -snprintf (sopath,sizeof (sopath),"%s/%s" , path, dent->d_name); +if (asprintf (&sopath,"%s/%s" , path, dent->d_name) <0 ) { +EAL_LOG (ERR ,"failed to create full path %s/%s" , + path, dent->d_name); +continue ; + }/* if a regular file, add to list to load */ -if (!(stat (sopath, &sb) ==0 &&S_ISREG (sb.st_mode))) +if (!(stat (sopath, &sb) ==0 &&S_ISREG (sb.st_mode))) { +free (sopath);continue ; + } -if (eal_plugin_add (sopath) ==-1 ) +if (eal_plugin_add (sopath) ==-1 ) { +free (sopath);break ; + } +free (sopath); }closedir (d);
Signature · 1 line
2.51.0
PATCH v8 15/18 ethdev: avoid possible overflow in xstat names
In reply to Stephen HemmingerThe compiler doesn't know that all the elements in the table of queue stats are short enough to avoid overflowing the snprintf. Add a condition to warn if it ever does;
maybe some day a new long named queue stat could be added.
--- lib/ethdev/rte_ethdev.c | 35 ++++++++++++++++++++++++----------- 1 file changed, 24 insertions(+), 11 deletions(-)
lib/ethdev/rte_ethdev.c +24 -11
@@ -3489,9 +3489,10 @@ eth_basic_stats_get_names(struct rte_eth_dev *dev,uint16_t num_q;for (idx =0 ; idx <RTE_NB_STATS ; idx++) { -strlcpy (xstats_names[cnt_used_entries].name, - eth_dev_stats_strings[idx].name, -sizeof (xstats_names[0 ].name)); +if (strlcpy (xstats_names[cnt_used_entries].name, eth_dev_stats_strings[idx].name, +sizeof (xstats_names[0 ].name)) >=sizeof (xstats_names[0 ].name)) +RTE_ETHDEV_LOG_LINE (ERR ,"statistic name '%s' will be truncated" , + xstats_names[cnt_used_entries].name); cnt_used_entries++; }
@@ -3501,10 +3502,17 @@ eth_basic_stats_get_names(struct rte_eth_dev *dev, num_q =RTE_MIN (dev->data->nb_rx_queues,RTE_ETHDEV_QUEUE_STAT_CNTRS );for (id_queue =0 ; id_queue < num_q; id_queue++) {for (idx =0 ; idx <RTE_NB_RXQ_STATS ; idx++) { -snprintf (xstats_names[cnt_used_entries].name, -sizeof (xstats_names[0 ].name), -"rx_q%u_%s" , - id_queue, eth_dev_rxq_stats_strings[idx].name); +unsigned int cc; + + cc =snprintf (xstats_names[cnt_used_entries].name, +sizeof (xstats_names[0 ].name), +"rx_q%u_%s" , + id_queue, eth_dev_rxq_stats_strings[idx].name); + +/* could only happen if a long string was added */ +if (cc >=sizeof (xstats_names[0 ].name)) +RTE_ETHDEV_LOG_LINE (ERR ,"truncated rxq stat string '%s'" , + eth_dev_rxq_stats_strings[idx].name); cnt_used_entries++; }
@@ -3512,10 +3520,15 @@ eth_basic_stats_get_names(struct rte_eth_dev *dev, num_q =RTE_MIN (dev->data->nb_tx_queues,RTE_ETHDEV_QUEUE_STAT_CNTRS );for (id_queue =0 ; id_queue < num_q; id_queue++) {for (idx =0 ; idx <RTE_NB_TXQ_STATS ; idx++) { -snprintf (xstats_names[cnt_used_entries].name, -sizeof (xstats_names[0 ].name), -"tx_q%u_%s" , - id_queue, eth_dev_txq_stats_strings[idx].name); +unsigned int cc; + + cc =snprintf (xstats_names[cnt_used_entries].name, +sizeof (xstats_names[0 ].name), +"tx_q%u_%s" , + id_queue, eth_dev_txq_stats_strings[idx].name); +if (cc >=sizeof (xstats_names[0 ].name)) +RTE_ETHDEV_LOG_LINE (ERR ,"truncated txq stat string '%s'" , + eth_dev_txq_stats_strings[idx].name); cnt_used_entries++; } }
Signature · 1 line
2.51.0
PATCH v8 16/18 vhost: check for overflow in xstat name
In reply to Stephen HemmingerThe snprintf to format an xstat name could overflow if called with a long rte_vhost_stat_name. Check if that happens and warn.
--- lib/vhost/vhost.c | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-)
lib/vhost/vhost.c +10 -4
@@ -2200,6 +2200,7 @@ rte_vhost_vring_stats_get_names(int vid, uint16_t queue_id, {struct virtio_net *dev =get_device (vid);unsigned int i; +int ret;if (dev ==NULL )return -1 ;
@@ -2213,10 +2214,15 @@ rte_vhost_vring_stats_get_names(int vid, uint16_t queue_id,if (name ==NULL || size <VHOST_NB_VQ_STATS )return VHOST_NB_VQ_STATS ; -for (i =0 ; i <VHOST_NB_VQ_STATS ; i++) -snprintf (name[i].name,sizeof (name[i].name),"%s_q%u_%s" , - (queue_id &1 ) ?"rx" :"tx" , - queue_id /2 , vhost_vq_stat_strings[i].name); +for (i =0 ; i <VHOST_NB_VQ_STATS ; i++) { + ret =snprintf (name[i].name,sizeof (name[i].name),"%s_q%u_%s" , + (queue_id &1 ) ?"rx" :"tx" , + queue_id /2 , vhost_vq_stat_strings[i].name); +if (ret >= (int )sizeof (name[0 ].name)) +VHOST_CONFIG_LOG ("device" ,NOTICE ,"truncated xstat '%s_q%u_%s'" , + (queue_id &1 ) ?"rx" :"tx" , + queue_id /2 , vhost_vq_stat_strings[i].name); + }return VHOST_NB_VQ_STATS ; }
Signature · 1 line
2.51.0
PATCH v8 17/18 cfgfile: add length checks and increase line buffer
In reply to Stephen HemmingerWhen adding values to config info, add string length checks instead of silently truncating. Increase the size of the buffer used to read from a config file so that there will be enough space for longest entries.
--- lib/cfgfile/rte_cfgfile.c | 43 +++++++++++++++++++++++++++++++-------- lib/cfgfile/rte_cfgfile.h | 6 +++++- 2 files changed, 39 insertions(+), 10 deletions(-)
lib/cfgfile/rte_cfgfile.c +34 -9
@@ -2,16 +2,24 @@* Copyright(c) 2010-2014 Intel Corporation */ +#include <assert.h> #include <stdio.h> #include <stdlib.h> #include <string.h> #include <ctype.h> #include <errno.h> +#include <limits.h> + +#ifndef LINE_MAX +#define LINE_MAX 2048 +#endif +#include <eal_export.h> #include <rte_string_fns.h> #include <rte_common.h> #include <rte_log.h> +#include "rte_cfgfile.h" struct rte_cfgfile_section {
@@ -106,6 +114,9 @@ static int _add_entry(struct rte_cfgfile_section *section, const char *entryname, const char *entryvalue) { + if (strlen(entryname) >= CFG_NAME_LEN || strlen(entryvalue) >= CFG_VALUE_LEN) + return -ENAMETOOLONG; +/* resize entry structure if we don't have room for more entries */ if (section->num_entries == section->allocated_entries) { struct rte_cfgfile_entry *n_entries = realloc(
@@ -167,12 +178,16 @@ rte_cfgfile_load(const char *filename, int flags) &default_cfgfile_params); } +/* Need enough space for largest name and value */ +static_assert (LINE_MAX >CFG_NAME_LEN +CFG_VALUE_LEN +4 , +"not enough space for cfgfile name/value" ); +RTE_EXPORT_SYMBOL (rte_cfgfile_load_with_params) struct rte_cfgfile *rte_cfgfile_load_with_params (const char *filename,int flags,const struct rte_cfgfile_parameters *params) { -char buffer[CFG_NAME_LEN +CFG_VALUE_LEN +4 ]; +char buffer[LINE_MAX ];int lineno =0 ;struct rte_cfgfile *cfg;
@@ -219,7 +234,13 @@ rte_cfgfile_load_with_params(const char *filename, int flags, *end ='\0' ;_strip (&buffer[1 ], end - &buffer[1 ]); -rte_cfgfile_add_section (cfg, &buffer[1 ]); +int ret =rte_cfgfile_add_section (cfg, &buffer[1 ]); +if (ret !=0 ) { +CFG_LOG (ERR , +"line %d - add section failed: %s" , + lineno,strerror (-ret)); + goto error1; + } }else {/* key and value line */ char *split[2 ] = {NULL };
@@ -260,8 +281,13 @@ rte_cfgfile_load_with_params(const char *filename, int flags,if (cfg->num_sections ==0 ) goto error1; -_add_entry (&cfg->sections[cfg->num_sections -1 ], - split[0 ], split[1 ]); +int ret =_add_entry (&cfg->sections[cfg->num_sections -1 ], + split[0 ], split[1 ]); +if (ret !=0 ) { +CFG_LOG (ERR , +"line %d - add entry failed: %s" , lineno,strerror (-ret)); + goto error1; + } } }fclose (f);
@@ -341,6 +367,9 @@ rte_cfgfile_add_section(struct rte_cfgfile *cfg, const char *sectionname)if (sectionname ==NULL )return -EINVAL ; +if (strlen (sectionname) >=CFG_NAME_LEN ) +return -ENAMETOOLONG ; +/* resize overall struct if we don't have room for more sections */ if (cfg->num_sections == cfg->allocated_sections) {
@@ -376,8 +405,6 @@ int rte_cfgfile_add_entry(struct rte_cfgfile *cfg, const char *sectionname, const char *entryname, const char *entryvalue) { - int ret; - if ((cfg == NULL) || (sectionname == NULL) || (entryname == NULL) || (entryvalue == NULL)) return -EINVAL;
@@ -391,9 +418,7 @@ int rte_cfgfile_add_entry(struct rte_cfgfile *cfg,if (curr_section ==NULL )return -EINVAL ; - ret =_add_entry (curr_section, entryname, entryvalue); - -return ret; +return _add_entry (curr_section, entryname, entryvalue); }RTE_EXPORT_SYMBOL (rte_cfgfile_set_entry)
lib/cfgfile/rte_cfgfile.h +5 -1
@@ -131,7 +131,11 @@ rte_cfgfile_add_section(struct rte_cfgfile *cfg, const char *sectionname);* @param entryvalue * Entry value to add. * @return -* 0 on success, -EEXIST if entry already exist, -EINVAL if bad argument +* 0 on success +* -EEXIST if entry already exist +* -EINVAL if bad argument +* -ENAMETOOLONG - entry excess CFG_NAME_LEN +* or value exceeds CFG_VALUE_LEN */ int rte_cfgfile_add_entry(struct rte_cfgfile *cfg, const char *sectionname, const char *entryname,
Signature · 1 line
2.51.0
PATCH v8 18/18 lib: enable format overflow warnings
In reply to Stephen HemmingerEnable compiler checking of format overflow
--- lib/meson.build | 4 ---- 1 file changed, 4 deletions(-)
lib/meson.build +0 -4
@@ -113,10 +113,6 @@ default_cflags = machine_args default_cflags += ['-DALLOW_EXPERIMENTAL_API'] default_cflags += ['-DALLOW_INTERNAL_API'] -if cc.has_argument('-Wno-format-truncation') - default_cflags += '-Wno-format-truncation' -endif - foreach l:libraries build = true reason = '<unknown reason>' # set if build == false to explain why
Signature · 1 line
2.51.0
v9 cover fix format overflow in libraries
In reply to Stephen HemmingerChange all the libraries to find and fix cases where a string could overflow when formatting or using strclpy. This does provide early indication of possible problems where the file prefix is too long to fit in unix domain socket path, and where a hash table is being requested that has a name too long.
v9 - fix bug in creating socket path
- add more release notes
- workaround older mingw in ubuntu 22.04
Stephen Hemminger (18):
lpm: restrict name size
hash: add checks for hash name length
graph: avoid overflowing comment buffer
latencystats: add check for string overflow
telemetry: check for path overflow
efd: handle possible name truncation
eal: use C library to parse filesystem table
eal: warn if thread name is truncated
eal: avoid format overflow when handling addresses
eal: add check for sysfs path overflow
eal: limit maximum runtime directory and socket paths
eal: check for hugefile path overflow
eal: check tailq length
eal: handle long shared library path
ethdev: avoid possible overflow in xstat names
vhost: check for overflow in xstat name
cfgfile: add length checks and increase line buffer
lib: enable format overflow warnings
app/test/test_hash.c | 21 ++++++ doc/guides/rel_notes/release_26_03.rst | 13 ++++ lib/cfgfile/rte_cfgfile.c | 43 ++++++++--- lib/cfgfile/rte_cfgfile.h | 6 +- lib/eal/common/eal_common_config.c | 6 +- lib/eal/common/eal_common_memory.c | 2 +- lib/eal/common/eal_common_options.c | 17 +++-- lib/eal/common/eal_common_proc.c | 85 ++++++++++++++-------- lib/eal/common/eal_common_tailqs.c | 13 +++- lib/eal/common/eal_filesystem.h | 27 +++++-- lib/eal/freebsd/eal.c | 6 +- lib/eal/linux/eal.c | 6 +- lib/eal/linux/eal_hugepage_info.c | 98 ++++++++++++-------------- lib/eal/linux/eal_memalloc.c | 11 ++- lib/eal/linux/eal_memory.c | 9 ++- lib/eal/windows/eal.c | 6 +- lib/efd/rte_efd.c | 18 +++-- lib/ethdev/rte_ethdev.c | 35 ++++++--- lib/graph/graph_pcap.c | 9 ++- lib/hash/rte_cuckoo_hash.c | 41 +++++++---- lib/hash/rte_fbk_hash.c | 12 +++- lib/hash/rte_fbk_hash.h | 1 + lib/latencystats/rte_latencystats.c | 9 ++- lib/lpm/rte_lpm.c | 16 +++-- lib/lpm/rte_lpm.h | 1 + lib/meson.build | 4 -- lib/telemetry/telemetry_legacy.c | 7 +- lib/vhost/vhost.c | 14 ++-- 28 files changed, 368 insertions(+), 168 deletions(-)
Signature · 1 line
2.51.0
PATCH v9 1/18 lpm: restrict name size
Check that lpm name size is within limits.
--- doc/guides/rel_notes/release_26_03.rst | 7 +++++++ lib/lpm/rte_lpm.c | 16 ++++++++++++---- lib/lpm/rte_lpm.h | 1 + 3 files changed, 20 insertions(+), 4 deletions(-)
doc/guides/rel_notes/release_26_03.rst +7 -0
@@ -84,6 +84,13 @@ API Changes Also, make sure to start the actual text at the margin. ======================================================= +* **Added additional length checks for name parameter lengths.** + + Several library functions now have additional name length checks + instead of silently truncating. + + * lpm: name must be less than RTE_LPM_NAMESIZE. + ABI Changes -----------
lib/lpm/rte_lpm.c +12 -4
@@ -152,7 +152,7 @@ struct rte_lpm * rte_lpm_create(const char *name, int socket_id, const struct rte_lpm_config *config) { - char mem_name[RTE_LPM_NAMESIZE]; + char mem_name[RTE_LPM_NAMESIZE + sizeof("LPM_")];struct __rte_lpm *i_lpm;struct rte_lpm *lpm =NULL ;struct rte_tailq_entry *te;
@@ -170,6 +170,11 @@ rte_lpm_create(const char *name, int socket_id,return NULL ; } +if (strlen (name) >=RTE_LPM_NAMESIZE ) { + rte_errno =ENAMETOOLONG ; +return NULL ; + } +snprintf (mem_name,sizeof (mem_name),"LPM_%s" , name);rte_mcfg_tailq_write_lock ();
@@ -327,8 +332,10 @@ rte_lpm_rcu_qsbr_add(struct rte_lpm *lpm, struct rte_lpm_rcu_config *cfg)/* No other things to do. */ }else if (cfg->mode ==RTE_LPM_QSBR_MODE_DQ ) {/* Init QSBR defer queue. */ -snprintf (rcu_dq_name,sizeof (rcu_dq_name), -"LPM_RCU_%s" , i_lpm->name); +if (snprintf (rcu_dq_name,sizeof (rcu_dq_name), +"LPM_RCU_%s" , i_lpm->name) >= (int )sizeof (rcu_dq_name)) +LPM_LOG (NOTICE ,"LPM rcu defer queue name truncated" ); + params.name = rcu_dq_name; params.size = cfg->dq_size;if (params.size ==0 )
@@ -343,7 +350,8 @@ rte_lpm_rcu_qsbr_add(struct rte_lpm *lpm, struct rte_lpm_rcu_config *cfg) params.v = cfg->v; i_lpm->dq =rte_rcu_qsbr_dq_create (¶ms);if (i_lpm->dq ==NULL ) { -LPM_LOG (ERR ,"LPM defer queue creation failed" ); +LPM_LOG (ERR ,"LPM defer queue creation failed: %s" , +rte_strerror (rte_errno));return 1 ; } }else {
lib/lpm/rte_lpm.h +1 -0
@@ -180,6 +180,7 @@ rte_lpm_free(struct rte_lpm *lpm);* - ENOSPC - the maximum number of memzones has already been allocated * - EEXIST - a memzone with the same name already exists * - ENOMEM - no appropriate memory area found in which to create memzone +* - ENAMETOOLONG - LPM object name greater than RTE_LPM_NAMESIZE */ struct rte_lpm * rte_lpm_create(const char *name, int socket_id,
Signature · 1 line
2.51.0
PATCH v9 2/18 hash: add checks for hash name length
In reply to Stephen HemmingerAdd a missing check to the API that the name is within the current defined maximum name size. This name is then used internally to create ring names, those names could get truncated; if a name is truncated add message to log.
If ring creation fails it might be because of name conflict, so change the log message to decode error value.
Add additional tests as well.
--- app/test/test_hash.c | 21 +++++++++++++ doc/guides/rel_notes/release_26_03.rst | 3 ++ lib/hash/rte_cuckoo_hash.c | 41 ++++++++++++++++++-------- lib/hash/rte_fbk_hash.c | 12 ++++++-- lib/hash/rte_fbk_hash.h | 1 + 5 files changed, 63 insertions(+), 15 deletions(-)
app/test/test_hash.c +21 -0
@@ -1120,6 +1120,14 @@ fbk_hash_unit_test(void) .socket_id = RTE_MAX_NUMA_NODES + 1, /* invalid socket */ }; +/* try and create hash with an excessively long name */ +struct rte_fbk_hash_params invalid_params_long_name = { + .name ="four_byte_key_hash_name_length_32" , + .entries =4 , + .entries_per_bucket =2 , + .socket_id =0 , + }; +/* try to create two hashes with identical names * in this case, trying to create a second one will not * fail but will simply return pointer to the existing
@@ -1201,6 +1209,9 @@ fbk_hash_unit_test(void) handle =rte_fbk_hash_create (&invalid_params_7);RETURN_IF_ERROR_FBK (handle !=NULL ,"fbk hash creation should have failed" ); + handle =rte_fbk_hash_create (&invalid_params_long_name); +RETURN_IF_ERROR_FBK (handle !=NULL ,"fbk hash creation should have failed" ); +if (rte_eal_has_hugepages ()) { handle =rte_fbk_hash_create (&invalid_params_8); RETURN_IF_ERROR_FBK(handle != NULL,
@@ -1439,6 +1450,16 @@ static int test_hash_creation_with_bad_parameters(void)return -1 ; } +memcpy (¶ms, &ut_params,sizeof (params)); + params.name ="hash_creation_with_too_long_name" ; + params.socket_id =RTE_MAX_NUMA_NODES +1 ; + handle =rte_hash_create (¶ms); +if (handle !=NULL ) { +rte_hash_free (handle); +printf ("Impossible creating hash successfully with long name\n" ); +return -1 ; + } +/* test with same name should fail */ memcpy (¶ms, &ut_params,sizeof (params)); params.name ="same_name" ;
doc/guides/rel_notes/release_26_03.rst +3 -0
@@ -84,12 +84,15 @@ API Changes Also, make sure to start the actual text at the margin. ======================================================= + * **Added additional length checks for name parameter lengths.** Several library functions now have additional name length checks instead of silently truncating. * lpm: name must be less than RTE_LPM_NAMESIZE. + * hash: name parameter must be less than RTE_HASH_NAMESIZE. + ABI Changes
lib/hash/rte_cuckoo_hash.c +29 -12
89 lines not on this page · raw message
lib/hash/rte_fbk_hash.c +9 -3
@@ -5,6 +5,7 @@#include <stdint.h> #include <stdio.h> #include <string.h> +#include <stdlib.h> #include <errno.h> #include <sys/queue.h>
@@ -83,7 +84,7 @@ rte_fbk_hash_create(const struct rte_fbk_hash_params *params) {struct rte_fbk_hash_table *ht =NULL ;struct rte_tailq_entry *te; -char hash_name[RTE_FBK_HASH_NAMESIZE ]; +char hash_name[RTE_FBK_HASH_NAMESIZE +sizeof ("FBK_" )];const uint32_t mem_size =sizeof (*ht) + (sizeof (ht->t[0 ]) * params->entries);uint32_t i;
@@ -96,6 +97,7 @@ rte_fbk_hash_create(const struct rte_fbk_hash_params *params)/* Error checking of parameters. */ if ((!rte_is_power_of_2(params->entries)) || (!rte_is_power_of_2(params->entries_per_bucket)) || + (params->name == NULL) || (params->entries == 0) || (params->entries_per_bucket == 0) || (params->entries_per_bucket > params->entries) ||
@@ -105,6 +107,11 @@ rte_fbk_hash_create(const struct rte_fbk_hash_params *params)return NULL ; } +if (strlen (params->name) >=RTE_FBK_HASH_NAMESIZE ) { + rte_errno =ENAMETOOLONG ; +return NULL ; + } +snprintf (hash_name,sizeof (hash_name),"FBK_%s" , params->name);rte_mcfg_tailq_write_lock ();
@@ -128,8 +135,7 @@ rte_fbk_hash_create(const struct rte_fbk_hash_params *params) }/* Allocate memory for table. */ - ht =rte_zmalloc_socket (hash_name, mem_size, -0 , params->socket_id); + ht =rte_zmalloc_socket (hash_name, mem_size,0 , params->socket_id);if (ht ==NULL ) {HASH_LOG (ERR ,"Failed to allocate fbk hash table" );rte_free (te);
lib/hash/rte_fbk_hash.h +1 -0
@@ -348,6 +348,7 @@ void rte_fbk_hash_free(struct rte_fbk_hash_table *ht);* - ENOSPC - the maximum number of memzones has already been allocated * - EEXIST - a memzone with the same name already exists * - ENOMEM - no appropriate memory area found in which to create memzone +* - ENAMETOOLONG - name is parameters exceeds RTE_FBK_HASH_NAMESIZE */ struct rte_fbk_hash_table *rte_fbk_hash_create (const struct rte_fbk_hash_params *params)
Signature · 1 line
2.51.0
PATCH v9 3/18 graph: avoid overflowing comment buffer
In reply to Stephen HemmingerThe library builds a pcapng comment to put on each packet but the buffer is not big enough for the largest possible graph node name, etc. Change to use asprintf() to allow any string length. Note, if asprintf() fails it is better to still log the packet without comment so no data is lost.
--- lib/graph/graph_pcap.c | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-)
lib/graph/graph_pcap.c +6 -3
@@ -194,7 +194,7 @@ graph_pcap_dispatch(struct rte_graph *graph, uint16_t nb_objs) {struct rte_mbuf *mbuf_clones[RTE_GRAPH_BURST_SIZE ]; -char buffer[GRAPH_PCAP_BUF_SZ ]; +char *comment =NULL ;uint64_t i, num_packets;struct rte_mbuf *mbuf;ssize_t len;
@@ -207,19 +207,22 @@ graph_pcap_dispatch(struct rte_graph *graph,if (num_packets > nb_objs) num_packets = nb_objs; -snprintf (buffer,GRAPH_PCAP_BUF_SZ ,"%s: %s" , graph->name, node->name); +/* put a comment on all these packets */ +if (asprintf (&comment,"%s: %s" , graph->name, node->name) <0 ) +graph_err ("asprintf for comment failed." );for (i =0 ; i < num_packets; i++) {struct rte_mbuf *mc; mbuf = (struct rte_mbuf *)objs[i]; mc =rte_pcapng_copy (mbuf->port,0 , mbuf, pkt_mp, mbuf->pkt_len, -0 , buffer); +0 , comment);if (mc ==NULL )break ; mbuf_clones[i] = mc; } +free (comment);/* write it to capture file */ len =rte_pcapng_write_packets (pcapng_fd, mbuf_clones, i);
Signature · 1 line
2.51.0
PATCH v9 4/18 latencystats: add check for string overflow
In reply to Stephen HemmingerThe copy of latency stat names could get truncated if in the future a new value is added. Add warning if that happens.
--- lib/latencystats/rte_latencystats.c | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-)
lib/latencystats/rte_latencystats.c +6 -3
@@ -405,9 +405,12 @@ rte_latencystats_get_names(struct rte_metric_name *names, uint16_t size)if (names ==NULL || size <NUM_LATENCY_STATS )return NUM_LATENCY_STATS ; -for (i =0 ; i <NUM_LATENCY_STATS ; i++) -strlcpy (names[i].name, lat_stats_strings[i].name, -sizeof (names[i].name)); +for (i =0 ; i <NUM_LATENCY_STATS ; i++) { +if (strlcpy (names[i].name, lat_stats_strings[i].name,sizeof (names[0 ].name)) + >=sizeof (names[0 ].name)) +LATENCY_STATS_LOG (NOTICE ,"Latency metric '%s' too long" , + lat_stats_strings[i].name); + }return NUM_LATENCY_STATS ; }
Signature · 1 line
2.51.0
PATCH v9 5/18 telemetry: check for path overflow
In reply to Stephen HemmingerThe unix domain socket path is limited, check for overflow.
--- lib/telemetry/telemetry_legacy.c | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-)
lib/telemetry/telemetry_legacy.c +5 -2
@@ -102,14 +102,17 @@ register_client(const char *cmd __rte_unused, const char *params,return -1 ; } *strchr (data,'\"' ) =0 ; + addrs.sun_family =AF_UNIX ; +if (strlcpy (addrs.sun_path, data,sizeof (addrs.sun_path)) >=sizeof (addrs.sun_path)) { +fprintf (stderr,"Client path too long\n" ); +return -1 ; + } fd =socket (AF_UNIX ,SOCK_SEQPACKET ,0 );if (fd <0 ) {perror ("Failed to open socket" );return -1 ; } - addrs.sun_family =AF_UNIX ; -strlcpy (addrs.sun_path, data,sizeof (addrs.sun_path));if (connect (fd, (struct sockaddr *)&addrs,sizeof (addrs)) ==-1 ) {perror ("\nClient connection error\n" );
Signature · 1 line
2.51.0
PATCH v9 6/18 efd: handle possible name truncation
In reply to Stephen HemmingerIf the conversion of efd name to ring name gets truncated, then log it. And if the ring name than causes collision, make sure that log message includes error reason.
--- doc/guides/rel_notes/release_26_03.rst | 2 +- lib/efd/rte_efd.c | 18 ++++++++++++++---- 2 files changed, 15 insertions(+), 5 deletions(-)
doc/guides/rel_notes/release_26_03.rst +1 -1
@@ -92,7 +92,7 @@ API Changes * lpm: name must be less than RTE_LPM_NAMESIZE. * hash: name parameter must be less than RTE_HASH_NAMESIZE. - + * efd: name must be less than RTE_EFD_NAMESIZE. ABI Changes
lib/efd/rte_efd.c +14 -4
@@ -517,13 +517,20 @@ rte_efd_create(const char *name, uint32_t max_num_rules, uint32_t key_len, efd_list =RTE_TAILQ_CAST (rte_efd_tailq.head, rte_efd_list);if (online_cpu_socket_bitmask ==0 ) { -EFD_LOG (ERR ,"At least one CPU socket must be enabled " -"in the bitmask" ); +EFD_LOG (ERR ,"At least one CPU socket must be enabled in the bitmask" ); + rte_errno =EINVAL ;return NULL ; }if (max_num_rules ==0 ) {EFD_LOG (ERR ,"Max num rules must be higher than 0" ); + rte_errno =EINVAL ; +return NULL ; + } + +if (strlen (name) >=RTE_EFD_NAMESIZE ) { +EFD_LOG (ERR ,"Name is too long" ); + rte_errno =ENAMETOOLONG ;return NULL ; }
@@ -698,12 +705,15 @@ rte_efd_create(const char *name, uint32_t max_num_rules, uint32_t key_len,TAILQ_INSERT_TAIL (efd_list, te, next);rte_mcfg_tailq_write_unlock (); -snprintf (ring_name,sizeof (ring_name),"HT_%s" , table->name); +if (snprintf (ring_name,sizeof (ring_name),"HT_%s" , table->name) + >= (int )sizeof (ring_name)) +EFD_LOG (NOTICE ,"EFD ring name truncated to '%s'" , ring_name); +/* Create ring (Dummy slot index is not enqueued) */ r =rte_ring_create (ring_name,rte_align32pow2 (table->max_num_rules), offline_cpu_socket,0 );if (r ==NULL ) { -EFD_LOG (ERR ,"memory allocation failed" ); +EFD_LOG (ERR ,"ring creation failed: %s" ,rte_strerror (rte_errno));rte_efd_free (table);return NULL ; }
Signature · 1 line
2.51.0
PATCH v9 7/18 eal: use C library to parse filesystem table
In reply to Stephen HemmingerRather than doing parsing of /proc/mounts with open coded string handling, use the standard C library routines.
These exist in BSD and Linux.
It also avoids any possible issues with escaped strings etc which the library handles. See getmntent(3) man page.
--- lib/eal/linux/eal_hugepage_info.c | 58 ++++++++++--------------------- 1 file changed, 18 insertions(+), 40 deletions(-)
lib/eal/linux/eal_hugepage_info.c +18 -40
@@ -13,6 +13,7 @@#include <inttypes.h> #include <unistd.h> #include <errno.h> +#include <mntent.h> #include <sys/mman.h> #include <sys/stat.h>
@@ -195,23 +196,13 @@ get_default_hp_size(void)static int get_hugepage_dir (uint64_t hugepage_sz,char *hugedir,int len) { -enum proc_mount_fieldnames { -DEVICE =0 , -MOUNTPT , -FSTYPE , -OPTIONS , - _FIELDNAME_MAX - };static uint64_t default_size =0 ;const char proc_mounts[] ="/proc/mounts" ; -const char hugetlbfs_str[] ="hugetlbfs" ; -const size_t htlbfs_str_len =sizeof (hugetlbfs_str) -1 ;const char pagesize_opt[] ="pagesize=" ;const size_t pagesize_opt_len =sizeof (pagesize_opt) -1 ; -const char split_tok =' ' ; -char *splitstr[_FIELDNAME_MAX];char found[PATH_MAX ] ="" ;char buf[BUFSIZ ]; +struct mntent entry;const struct internal_config *internal_conf =eal_get_internal_configuration (); const size_t hugepage_dir_len = (internal_conf->hugepage_dir != NULL) ?
@@ -226,56 +217,43 @@ get_hugepage_dir(uint64_t hugepage_sz, char *hugedir, int len)return -1 ; } -FILE *fd =fopen (proc_mounts,"r" ); -if (fd ==NULL ) +FILE *mounts =setmntent (proc_mounts,"r" ); +if (mounts ==NULL )rte_panic ("Cannot open %s\n" , proc_mounts);if (default_size ==0 ) default_size =get_default_hp_size (); -while (fgets (buf,sizeof (buf), fd)){ +while (getmntent_r (mounts, &entry, buf,sizeof (buf))) {const char *pagesz_str; -size_t mountpt_len =0 ; - -if (rte_strsplit (buf,sizeof (buf), splitstr, _FIELDNAME_MAX, - split_tok) != _FIELDNAME_MAX) { -EAL_LOG (ERR ,"Error parsing %s" , proc_mounts); -break ;/* return NULL */ - } +uint64_t pagesz = default_size; +size_t mountpt_len; -if (strncmp (splitstr[FSTYPE ], hugetlbfs_str, htlbfs_str_len) !=0 ) +if (strcmp (entry.mnt_type,"hugetlbfs" ) !=0 )continue ; - pagesz_str =strstr (splitstr[OPTIONS ], pagesize_opt); + pagesz_str =strstr (entry.mnt_opts, pagesize_opt); +if (pagesz_str) + pagesz =rte_str_to_size (&pagesz_str[pagesize_opt_len]); -/* if no explicit page size, the default page size is compared */ -if (pagesz_str ==NULL ) { -if (hugepage_sz != default_size) -continue ; - } -/* there is an explicit page size, so check it */ -else { -uint64_t pagesz =rte_str_to_size (&pagesz_str[pagesize_opt_len]); -if (pagesz != hugepage_sz) -continue ; - } +if (pagesz != hugepage_sz) +continue ;/* * If no --huge-dir option has been given, we're done. */ if (internal_conf->hugepage_dir ==NULL ) { -strlcpy (found, splitstr[MOUNTPT ], len); +strlcpy (found, entry.mnt_dir, len);break ; } - mountpt_len =strlen (splitstr[MOUNTPT ]); + mountpt_len =strlen (entry.mnt_dir);/* * Ignore any mount that doesn't contain the --huge-dir directory * or where mount point is not a parent path of --huge-dir */ -if (strncmp (internal_conf->hugepage_dir, splitstr[MOUNTPT ], - mountpt_len) !=0 || +if (strncmp (internal_conf->hugepage_dir, entry.mnt_dir, mountpt_len) !=0 || (hugepage_dir_len > mountpt_len && internal_conf->hugepage_dir[mountpt_len] !='/' )) {continue ;
@@ -286,10 +264,10 @@ get_hugepage_dir(uint64_t hugepage_sz, char *hugedir, int len)* (so /mnt/1 is preferred over /mnt for matching /mnt/1/2)). */ if (mountpt_len >strlen (found)) -strlcpy (found, splitstr[MOUNTPT ], len); +strlcpy (found, entry.mnt_dir, len); }/* end while fgets */ -fclose (fd); +endmntent (mounts);if (found[0 ] !='\0' ) {/* If needed, return the requested dir, not the mount point. */
Signature · 1 line
2.51.0
RE: [PATCH v9 07/18] eal: use C library to parse filesystem table
Quoted 139 lines
Rather than doing parsing of
/proc/mountswith open coded string handling, use the standard C library routines.
These exist in BSD and Linux.It also avoids any possible issues with escaped strings etc which the library handles. See getmntent(3) man page.
Signed-off-by Stephen Hemminger <[email protected]>Acked-by Bruce Richardson <[email protected]>--- lib/eal/linux/eal_hugepage_info.c | 58 ++++++++++--------------------- 1 file changed, 18 insertions(+), 40 deletions(-)lib/eal/linux/eal_hugepage_info.c +16
-38@@ -13,6 +13,7 @@#include <inttypes.h> #include <unistd.h> #include <errno.h> +#include <mntent.h> #include <sys/mman.h> #include <sys/stat.h> @@ -195,23 +196,13 @@ get_default_hp_size(void)static int get_hugepage_dir (uint64_t hugepage_sz,char *hugedir,int len) { -enum proc_mount_fieldnames { -DEVICE =0 , -MOUNTPT , -FSTYPE , -OPTIONS , - _FIELDNAME_MAX - };static uint64_t default_size =0 ;const char proc_mounts[] ="/proc/mounts" ; -const char hugetlbfs_str[] ="hugetlbfs" ; -const size_t htlbfs_str_len =sizeof (hugetlbfs_str) -1 ;const char pagesize_opt[] ="pagesize=" ;const size_t pagesize_opt_len =sizeof (pagesize_opt) -1 ; -const char split_tok =' ' ; -char *splitstr[_FIELDNAME_MAX];char found[PATH_MAX ] ="" ;char buf[BUFSIZ ]; +struct mntent entry;const struct internal_config *internal_conf =eal_get_internal_configuration (); const size_t hugepage_dir_len = (internal_conf->hugepage_dir != NULL) ?@@ -226,56 +217,43 @@ get_hugepage_dir(uint64_t hugepage_sz, char *hugedir, int len)return -1 ; } -FILE *fd =fopen (proc_mounts,"r" ); -if (fd ==NULL ) +FILE *mounts =setmntent (proc_mounts,"r" ); +if (mounts ==NULL )rte_panic ("Cannot open %s\n" , proc_mounts);if (default_size ==0 ) default_size =get_default_hp_size (); -while (fgets (buf,sizeof (buf), fd)){ +while (getmntent_r (mounts, &entry, buf,sizeof (buf))) {const char *pagesz_str; -size_t mountpt_len =0 ; - -if (rte_strsplit (buf,sizeof (buf), splitstr, _FIELDNAME_MAX, - split_tok) != _FIELDNAME_MAX) { -EAL_LOG (ERR ,"Error parsing %s" , proc_mounts); -break ;/* return NULL */ - } +uint64_t pagesz = default_size; +size_t mountpt_len; -if (strncmp (splitstr[FSTYPE ], hugetlbfs_str, htlbfs_str_len) !=0 ) +if (strcmp (entry.mnt_type,"hugetlbfs" ) !=0 )continue ; - pagesz_str =strstr (splitstr[OPTIONS ], pagesize_opt); + pagesz_str =strstr (entry.mnt_opts, pagesize_opt); +if (pagesz_str) + pagesz =rte_str_to_size (&pagesz_str[pagesize_opt_len]); -/* if no explicit page size, the default page size is compared */ -if (pagesz_str ==NULL ) { -if (hugepage_sz != default_size) -continue ; - } -/* there is an explicit page size, so check it */ -else { -uint64_t pagesz =rte_str_to_size (&pagesz_str[pagesize_opt_len]); -if (pagesz != hugepage_sz) -continue ; - } +if (pagesz != hugepage_sz) +continue ;/* * If no --huge-dir option has been given, we're done. */ if (internal_conf->hugepage_dir ==NULL ) { -strlcpy (found, splitstr[MOUNTPT ], len); +strlcpy (found, entry.mnt_dir, len);break ; } - mountpt_len =strlen (splitstr[MOUNTPT ]); + mountpt_len =strlen (entry.mnt_dir);/* * Ignore any mount that doesn't contain the --huge-dir directory * or where mount point is not a parent path of --huge-dir */ - if (strncmp(internal_conf->hugepage_dir, splitstr[MOUNTPT], - mountpt_len) != 0 || + if (strncmp(internal_conf->hugepage_dir, entry.mnt_dir,
mountpt_len) != 0 ||lib/eal/linux/eal_hugepage_info.c +2
-2(hugepage_dir_len > mountpt_len && internal_conf->hugepage_dir[mountpt_len] != '/')) {continue ;@@ -286,10 +264,10 @@ get_hugepage_dir(uint64_t hugepage_sz, char *hugedir,int len) * (so /mnt/1 is preferred over /mnt for matching /mnt/1/2)). */ if (mountpt_len >strlen (found)) -strlcpy (found, splitstr[MOUNTPT ], len); +strlcpy (found, entry.mnt_dir, len); }/* end while fgets */ -fclose (fd); +endmntent (mounts);if (found[0 ] !='\0' ) {
Quoted 2 lines
/* If needed, return the requested dir, not the mount point. */
--
Quoted 2 lines
2.51.0
PATCH v9 8/18 eal: warn if thread name is truncated
In reply to Stephen HemmingerThread name is very short 16 characters and therefore the name dpdk-worker-%d will overflow with more than 9999 worker cores. Error should be non-fatal since name only matters for debug.
--- lib/eal/freebsd/eal.c | 6 ++++-- lib/eal/linux/eal.c | 6 ++++-- lib/eal/windows/eal.c | 6 ++++-- 3 files changed, 12 insertions(+), 6 deletions(-)
lib/eal/freebsd/eal.c +4 -2
@@ -690,8 +690,10 @@ rte_eal_init(int argc, char **argv)rte_panic ("Cannot create thread\n" );/* Set thread_name for aid in debugging. */ -snprintf (thread_name,sizeof (thread_name), -"dpdk-worker%d" , i); + ret =snprintf (thread_name,sizeof (thread_name),"dpdk-worker%d" , i); +if (ret >= (int )sizeof (thread_name)) +EAL_LOG (INFO ,"Worker thread name %s truncated" , thread_name); +rte_thread_set_name (lcore_config[i].thread_id, thread_name); ret = rte_thread_set_affinity_by_id(lcore_config[i].thread_id,
lib/eal/linux/eal.c +4 -2
@@ -863,8 +863,10 @@ rte_eal_init(int argc, char **argv)rte_panic ("Cannot create thread\n" );/* Set thread_name for aid in debugging. */ -snprintf (thread_name,sizeof (thread_name), -"dpdk-worker%d" , i); + ret =snprintf (thread_name,sizeof (thread_name),"dpdk-worker%d" , i); +if (ret >=RTE_THREAD_NAME_SIZE ) +EAL_LOG (INFO ,"Worker thread name %s truncated" , thread_name); +rte_thread_set_name (lcore_config[i].thread_id, thread_name); ret = rte_thread_set_affinity_by_id(lcore_config[i].thread_id,
lib/eal/windows/eal.c +4 -2
@@ -378,8 +378,10 @@ rte_eal_init(int argc, char **argv)rte_panic ("Cannot create thread\n" );/* Set thread name for aid in debugging. */ -snprintf (thread_name,sizeof (thread_name), -"dpdk-worker%d" , i); + ret =snprintf (thread_name,sizeof (thread_name),"dpdk-worker%d" , i); +if (ret >= (int )sizeof (thread_name)) +EAL_LOG (INFO ,"Worker thread name %s truncated" , thread_name); +rte_thread_set_name (lcore_config[i].thread_id, thread_name); ret = rte_thread_set_affinity_by_id(lcore_config[i].thread_id,
Signature · 1 line
2.51.0
PATCH v9 9/18 eal: avoid format overflow when handling addresses
In reply to Stephen HemmingerThe largest possible string in this code 0xFFFFFFFFFFFFFFFF which will overflow with only 15 character buffer. Increase to 20.
--- lib/eal/common/eal_common_memory.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
lib/eal/common/eal_common_memory.c +1 -1
@@ -1153,7 +1153,7 @@ rte_eal_memory_init(void)#define EAL_MEMSEG_INFO_REQ "/eal/memseg_info"#define EAL_ELEMENT_LIST_REQ "/eal/mem_element_list"#define EAL_ELEMENT_INFO_REQ "/eal/mem_element_info" -#define ADDR_STR 15 +#define ADDR_STR 20/* 16 bytes 64 bit + 0x */ /* Telemetry callback handler to return heap stats for requested heap id. */
Signature · 1 line
2.51.0
PATCH v9 10/18 eal: add check for sysfs path overflow
In reply to Stephen HemmingerShouldn't happen but in theory sysfs socket could overflow. Add a check for it.
--- lib/eal/linux/eal_hugepage_info.c | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-)
lib/eal/linux/eal_hugepage_info.c +5 -1
@@ -150,8 +150,12 @@ get_num_hugepages_on_node(const char *subdir, unsigned int socket, size_t sz)return 0 ; } -snprintf (path,sizeof (path),"%s/%s/%s" , +if (snprintf (path,sizeof (path),"%s/%s/%s" , socketpath, subdir, nr_hp_file) >=PATH_MAX ) { +EAL_LOG (NOTICE ,"Socket path %s/%s/%s is truncated" , socketpath, subdir, nr_hp_file); +return 0 ; + } +if (eal_parse_sysfs_value (path, &num_pages) <0 )return 0 ;
Signature · 1 line
2.51.0
PATCH v9 11/18 eal: limit maximum runtime directory and socket paths
In reply to Stephen HemmingerLinux has a limitation of 108 characters (including null character) for AF_UNIX socket path. FreeBSD limit is smaller 104 characters and Windows has same definition (108) in afunix.h header.
In current code, EAL will fail in telemetry, so this should not break existing users.
EAL: Multi-process socket /var/run/dpdk/x7Q9mP2a...
EAL: Selected IOVA mode 'VA'
TELEMETRY: Error with socket binding, path too long
Now long string fails on command line parsing:
EAL: Runtime directory string too long
EAL: Cannot create runtime directory
EAL: Error parsing command line arguments.
--- lib/eal/common/eal_common_config.c | 6 ++- lib/eal/common/eal_common_proc.c | 85 +++++++++++++++++++----------- lib/eal/common/eal_filesystem.h | 17 +++++- 3 files changed, 74 insertions(+), 34 deletions(-)
lib/eal/common/eal_common_config.c +4 -2
@@ -6,6 +6,7 @@#include <eal_export.h> #include "eal_private.h" +#include "eal_filesystem.h" #include "eal_memcfg.h" /* early configuration structure, when memory config is not mmapped */
@@ -24,7 +25,7 @@ static struct rte_config rte_config = { };/* platform-specific runtime dir */ -static char runtime_dir[PATH_MAX ]; +static char runtime_dir[UNIX_PATH_MAX ];/* internal configuration */ static struct internal_config internal_config;
@@ -39,7 +40,8 @@ rte_eal_get_runtime_dir(void)int eal_set_runtime_dir (const char *run_dir) { -if (strlcpy (runtime_dir, run_dir,PATH_MAX ) >=PATH_MAX ) { +/* runtime directory limited by maximum allowable unix domain socket */ +if (strlcpy (runtime_dir, run_dir,UNIX_PATH_MAX ) >=UNIX_PATH_MAX ) {EAL_LOG (ERR ,"Runtime directory string too long" );return -1 ; }
lib/eal/common/eal_common_proc.c +54 -31
176 lines not on this page · raw message
lib/eal/common/eal_filesystem.h +16 -1
@@ -45,10 +45,25 @@ eal_runtime_config_path(void)/** Path of primary/secondary communication unix socket file. */ #define MP_SOCKET_FNAME "mp_socket" + +#ifdef RTE_EXEC_ENV_WINDOWS +/* +* UNIX_PATH_MAX is defined in afunux.h but that file is not in MingGW 9 +* which is the version in Ubuntu 22.04, in future this can change. +* Also, Unix domain sockets are not uses in DPDK on Windows (yet). +*/ +#define UNIX_PATH_MAX 108 +#else +#include <sys/un.h> + +/** Maximum length of unix domain socket path. */ +#define UNIX_PATH_MAX (sizeof(((struct sockaddr_un *)0)->sun_path)) +#endif +static inline const char *eal_mp_socket_path (void ) { -static char buffer[PATH_MAX ];/* static so auto-zeroed */ +static char buffer[UNIX_PATH_MAX ];/* static so auto-zeroed */ snprintf (buffer,sizeof (buffer),"%s/%s" ,rte_eal_get_runtime_dir (),MP_SOCKET_FNAME );
Signature · 1 line
2.51.0
PATCH v9 12/18 eal: check for hugefile path overflow
In reply to Stephen HemmingerWhen constructing huge filename path, check for possible overflow of PATH_MAX.
--- lib/eal/common/eal_filesystem.h | 10 ++++--- lib/eal/linux/eal_hugepage_info.c | 44 ++++++++++++++++++------------- lib/eal/linux/eal_memalloc.c | 11 ++++++-- lib/eal/linux/eal_memory.c | 9 +++++-- 4 files changed, 48 insertions(+), 26 deletions(-)
lib/eal/common/eal_filesystem.h +6 -4
@@ -104,12 +104,14 @@ eal_hugepage_data_path(void)/** String format for hugepage map files. */ #define HUGEFILE_FMT "%s/%smap_%d" -static inline const char * +static inline __rte_warn_unused_result const char *eal_get_hugefile_path (char *buffer,size_t buflen,const char *hugedir,int f_id) { -snprintf (buffer, buflen,HUGEFILE_FMT , hugedir, -eal_get_hugefile_prefix (), f_id); -return buffer; +if (snprintf (buffer, buflen,HUGEFILE_FMT , hugedir, +eal_get_hugefile_prefix (), f_id) >= (int )buflen) +return NULL ; +else +return buffer; }/** define the default filename prefix for the %s values above */
lib/eal/linux/eal_hugepage_info.c +26 -18
100 lines not on this page · raw message
lib/eal/linux/eal_memalloc.c +9 -2
@@ -260,6 +260,7 @@ get_seg_fd(char *path, int buflen, struct hugepage_info *hi, {int fd;int *out_fd; +const char *huge_path;struct stat st;int ret; const struct internal_config *internal_conf =
@@ -276,12 +277,18 @@ get_seg_fd(char *path, int buflen, struct hugepage_info *hi,if (internal_conf->single_file_segments) { out_fd = &fd_list[list_idx].memseg_list_fd; -eal_get_hugefile_path (path, buflen, hi->hugedir, list_idx); + huge_path =eal_get_hugefile_path (path, buflen, hi->hugedir, list_idx); }else { out_fd = &fd_list[list_idx].fds[seg_idx]; -eal_get_hugefile_path (path, buflen, hi->hugedir, + huge_path =eal_get_hugefile_path (path, buflen, hi->hugedir, list_idx *RTE_MAX_MEMSEG_PER_LIST + seg_idx); } +if (huge_path ==NULL ) { +EAL_LOG (DEBUG ,"%s(): hugefile path truncated: '%s'" , + __func__, path); +return -1 ; + } + fd = *out_fd;if (fd >=0 )return fd;
lib/eal/linux/eal_memory.c +7 -2
@@ -337,8 +337,13 @@ map_all_hugepages(struct hugepage_file *hugepg_tbl, struct hugepage_info *hpi, hf->file_id = i; hf->size = hugepage_sz; -eal_get_hugefile_path (hf->filepath,sizeof (hf->filepath), - hpi->hugedir, hf->file_id); +if (eal_get_hugefile_path (hf->filepath,sizeof (hf->filepath), + hpi->hugedir, hf->file_id) ==NULL ) { +EAL_LOG (DEBUG ,"%s(): huge file path '%s' truncated" , + __func__, hf->filepath); + goto out; + } + hf->filepath[sizeof (hf->filepath) -1 ] ='\0' ;/* try to create hugepage file */
Signature · 1 line
2.51.0
PATCH v9 13/18 eal: check tailq length
In reply to Stephen HemmingerThe tailq name should not be allowed to exceed limits.
--- doc/guides/rel_notes/release_26_03.rst | 1 + lib/eal/common/eal_common_tailqs.c | 13 ++++++++++++- 2 files changed, 13 insertions(+), 1 deletion(-)
doc/guides/rel_notes/release_26_03.rst +1 -0
@@ -93,6 +93,7 @@ API Changes * lpm: name must be less than RTE_LPM_NAMESIZE. * hash: name parameter must be less than RTE_HASH_NAMESIZE. * efd: name must be less than RTE_EFD_NAMESIZE. + * tailq: name must be less than RTE_TAILQ_NAMESIZE. ABI Changes
lib/eal/common/eal_common_tailqs.c +12 -1
@@ -8,6 +8,7 @@#include <rte_eal.h> #include <rte_eal_memconfig.h> +#include <rte_errno.h> #include <rte_log.h> #include <rte_string_fns.h>
@@ -30,8 +31,10 @@ rte_eal_tailq_lookup(const char *name)unsigned i;struct rte_mem_config *mcfg =rte_eal_get_configuration ()->mem_config; -if (name ==NULL ) +if (name ==NULL ) { + rte_errno =EINVAL ;return NULL ; + } for (i = 0; i < RTE_MAX_TAILQ; i++) { if (!strncmp(name, mcfg->tailq_head[i].name,
@@ -39,6 +42,7 @@ rte_eal_tailq_lookup(const char *name)return &mcfg->tailq_head[i]; } + rte_errno =ENOENT ;return NULL ; }
@@ -67,6 +71,12 @@ rte_eal_tailq_create(const char *name) {struct rte_tailq_head *head =NULL ; +if (strlen (name) >=sizeof (head->name)) { +EAL_LOG (ERR ,"tailq name '%s' is too long" , name); + rte_errno =ENAMETOOLONG ; +return NULL ; + } +if (!rte_eal_tailq_lookup (name) && (rte_tailqs_count +1 <RTE_MAX_TAILQ )) {struct rte_mem_config *mcfg;
@@ -115,6 +125,7 @@ rte_eal_tailq_register(struct rte_tailq_elem *t)if (rte_eal_tailq_local_register (t) <0 ) {EAL_LOG (ERR ,"%s tailq is already registered" , t->name); + rte_errno =EEXIST ; goto error; }
Signature · 1 line
2.51.0
PATCH v9 14/18 eal: handle long shared library path
In reply to Stephen HemmingerInstead of a fixed size shared library path that could in theory get truncated when concatenating, use a dynamically allocated buffer via asprintf.
--- lib/eal/common/eal_common_options.c | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-)
lib/eal/common/eal_common_options.c +13 -4
@@ -570,7 +570,6 @@ static int eal_plugindir_init(const char *path) {struct dirent *dent =NULL ; -char sopath[PATH_MAX ];DIR *d =NULL ;if (path ==NULL || *path =='\0' )
@@ -584,19 +583,29 @@ eal_plugindir_init(const char *path) }while ((dent =readdir (d)) !=NULL ) { +char *sopath =NULL ;struct stat sb;if (!ends_with (dent->d_name,".so" ) && !ends_with (dent->d_name,".so." ABI_VERSION ))continue ; -snprintf (sopath,sizeof (sopath),"%s/%s" , path, dent->d_name); +if (asprintf (&sopath,"%s/%s" , path, dent->d_name) <0 ) { +EAL_LOG (ERR ,"failed to create full path %s/%s" , + path, dent->d_name); +continue ; + }/* if a regular file, add to list to load */ -if (!(stat (sopath, &sb) ==0 &&S_ISREG (sb.st_mode))) +if (!(stat (sopath, &sb) ==0 &&S_ISREG (sb.st_mode))) { +free (sopath);continue ; + } -if (eal_plugin_add (sopath) ==-1 ) +if (eal_plugin_add (sopath) ==-1 ) { +free (sopath);break ; + } +free (sopath); }closedir (d);
Signature · 1 line
2.51.0
PATCH v9 15/18 ethdev: avoid possible overflow in xstat names
In reply to Stephen HemmingerThe compiler doesn't know that all the elements in the table of queue stats are short enough to avoid overflowing the snprintf. Add a condition to warn if it ever does;
maybe some day a new long named queue stat could be added.
--- lib/ethdev/rte_ethdev.c | 35 ++++++++++++++++++++++++----------- 1 file changed, 24 insertions(+), 11 deletions(-)
lib/ethdev/rte_ethdev.c +24 -11
@@ -3489,9 +3489,10 @@ eth_basic_stats_get_names(struct rte_eth_dev *dev,uint16_t num_q;for (idx =0 ; idx <RTE_NB_STATS ; idx++) { -strlcpy (xstats_names[cnt_used_entries].name, - eth_dev_stats_strings[idx].name, -sizeof (xstats_names[0 ].name)); +if (strlcpy (xstats_names[cnt_used_entries].name, eth_dev_stats_strings[idx].name, +sizeof (xstats_names[0 ].name)) >=sizeof (xstats_names[0 ].name)) +RTE_ETHDEV_LOG_LINE (ERR ,"statistic name '%s' will be truncated" , + xstats_names[cnt_used_entries].name); cnt_used_entries++; }
@@ -3501,10 +3502,17 @@ eth_basic_stats_get_names(struct rte_eth_dev *dev, num_q =RTE_MIN (dev->data->nb_rx_queues,RTE_ETHDEV_QUEUE_STAT_CNTRS );for (id_queue =0 ; id_queue < num_q; id_queue++) {for (idx =0 ; idx <RTE_NB_RXQ_STATS ; idx++) { -snprintf (xstats_names[cnt_used_entries].name, -sizeof (xstats_names[0 ].name), -"rx_q%u_%s" , - id_queue, eth_dev_rxq_stats_strings[idx].name); +unsigned int cc; + + cc =snprintf (xstats_names[cnt_used_entries].name, +sizeof (xstats_names[0 ].name), +"rx_q%u_%s" , + id_queue, eth_dev_rxq_stats_strings[idx].name); + +/* could only happen if a long string was added */ +if (cc >=sizeof (xstats_names[0 ].name)) +RTE_ETHDEV_LOG_LINE (ERR ,"truncated rxq stat string '%s'" , + eth_dev_rxq_stats_strings[idx].name); cnt_used_entries++; }
@@ -3512,10 +3520,15 @@ eth_basic_stats_get_names(struct rte_eth_dev *dev, num_q =RTE_MIN (dev->data->nb_tx_queues,RTE_ETHDEV_QUEUE_STAT_CNTRS );for (id_queue =0 ; id_queue < num_q; id_queue++) {for (idx =0 ; idx <RTE_NB_TXQ_STATS ; idx++) { -snprintf (xstats_names[cnt_used_entries].name, -sizeof (xstats_names[0 ].name), -"tx_q%u_%s" , - id_queue, eth_dev_txq_stats_strings[idx].name); +unsigned int cc; + + cc =snprintf (xstats_names[cnt_used_entries].name, +sizeof (xstats_names[0 ].name), +"tx_q%u_%s" , + id_queue, eth_dev_txq_stats_strings[idx].name); +if (cc >=sizeof (xstats_names[0 ].name)) +RTE_ETHDEV_LOG_LINE (ERR ,"truncated txq stat string '%s'" , + eth_dev_txq_stats_strings[idx].name); cnt_used_entries++; } }
Signature · 1 line
2.51.0
PATCH v9 16/18 vhost: check for overflow in xstat name
In reply to Stephen HemmingerThe snprintf to format an xstat name could overflow if called with a long rte_vhost_stat_name. Check if that happens and warn.
--- lib/vhost/vhost.c | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-)
lib/vhost/vhost.c +10 -4
@@ -2200,6 +2200,7 @@ rte_vhost_vring_stats_get_names(int vid, uint16_t queue_id, {struct virtio_net *dev =get_device (vid);unsigned int i; +int ret;if (dev ==NULL )return -1 ;
@@ -2213,10 +2214,15 @@ rte_vhost_vring_stats_get_names(int vid, uint16_t queue_id,if (name ==NULL || size <VHOST_NB_VQ_STATS )return VHOST_NB_VQ_STATS ; -for (i =0 ; i <VHOST_NB_VQ_STATS ; i++) -snprintf (name[i].name,sizeof (name[i].name),"%s_q%u_%s" , - (queue_id &1 ) ?"rx" :"tx" , - queue_id /2 , vhost_vq_stat_strings[i].name); +for (i =0 ; i <VHOST_NB_VQ_STATS ; i++) { + ret =snprintf (name[i].name,sizeof (name[i].name),"%s_q%u_%s" , + (queue_id &1 ) ?"rx" :"tx" , + queue_id /2 , vhost_vq_stat_strings[i].name); +if (ret >= (int )sizeof (name[0 ].name)) +VHOST_CONFIG_LOG ("device" ,NOTICE ,"truncated xstat '%s_q%u_%s'" , + (queue_id &1 ) ?"rx" :"tx" , + queue_id /2 , vhost_vq_stat_strings[i].name); + }return VHOST_NB_VQ_STATS ; }
Signature · 1 line
2.51.0
PATCH v9 17/18 cfgfile: add length checks and increase line buffer
In reply to Stephen HemmingerWhen adding values to config info, add string length checks instead of silently truncating. Increase the size of the buffer used to read from a config file so that there will be enough space for longest entries.
--- doc/guides/rel_notes/release_26_03.rst | 2 ++ lib/cfgfile/rte_cfgfile.c | 43 ++++++++++++++++++++------ lib/cfgfile/rte_cfgfile.h | 6 +++- 3 files changed, 41 insertions(+), 10 deletions(-)
doc/guides/rel_notes/release_26_03.rst +2 -0
@@ -94,6 +94,8 @@ API Changes * hash: name parameter must be less than RTE_HASH_NAMESIZE. * efd: name must be less than RTE_EFD_NAMESIZE. * tailq: name must be less than RTE_TAILQ_NAMESIZE. + * cfgfile: name must be less than CFG_NAME_LEN + and value must be less than CFG_VALUE_LEN. ABI Changes
lib/cfgfile/rte_cfgfile.c +34 -9
106 lines not on this page · raw message
lib/cfgfile/rte_cfgfile.h +5 -1
@@ -131,7 +131,11 @@ rte_cfgfile_add_section(struct rte_cfgfile *cfg, const char *sectionname);* @param entryvalue * Entry value to add. * @return -* 0 on success, -EEXIST if entry already exist, -EINVAL if bad argument +* 0 on success +* -EEXIST if entry already exist +* -EINVAL if bad argument +* -ENAMETOOLONG - entry excess CFG_NAME_LEN +* or value exceeds CFG_VALUE_LEN */ int rte_cfgfile_add_entry(struct rte_cfgfile *cfg, const char *sectionname, const char *entryname,
Signature · 1 line
2.51.0
PATCH v9 18/18 lib: enable format overflow warnings
In reply to Stephen HemmingerEnable compiler checking of format overflow
--- lib/meson.build | 4 ---- 1 file changed, 4 deletions(-)
lib/meson.build +0 -4
@@ -113,10 +113,6 @@ default_cflags = machine_args default_cflags += ['-DALLOW_EXPERIMENTAL_API'] default_cflags += ['-DALLOW_INTERNAL_API'] -if cc.has_argument('-Wno-format-truncation') - default_cflags += '-Wno-format-truncation' -endif - foreach l:libraries build = true reason = '<unknown reason>' # set if build == false to explain why
Signature · 1 line
2.51.0
v10 cover fix format overflow warnings in libraries
In reply to Stephen HemmingerThis series fixes format overflow warnings that occur when building DPDK libraries with -Wformat-overflow enabled. The final patch in the series removes the -Wno-format-truncation flag from lib/meson.build, enabling these warnings by default.
The changes fall into several categories:
1. Add explicit name length validation to APIs that create named objects (lpm, hash, efd, tailq, cfgfile). These now return ENAMETOOLONG instead of silently truncating names.
2. Check snprintf() return values and log warnings when truncation occurs in non-fatal cases (thread names, xstat names, ring names).
3. Use asprintf() for dynamic allocation where fixed buffers are insufficient (graph pcap comments, hugepage paths, plugin paths).
4. Increase buffer sizes where the existing size was too small (telemetry address strings, cfgfile line buffer).
5. Replace PATH_MAX with UNIX_PATH_MAX for unix domain socket paths since the actual limit is 108 characters, not 4096.
6. Use standard C library functions where appropriate (getmntent_r for parsing /proc/mounts).
All API changes are documented in the release notes under a single entry describing the new name length checks.
v10:
- Fixed inconsistent comparison in eal thread name warning (now uses RTE_THREAD_NAME_SIZE on all platforms)
- Fixed typo "peerr" -> "peer" in eal_common_proc.c
Stephen Hemminger (18):
lpm: restrict name size
hash: add checks for hash name length
graph: avoid overflowing comment buffer
latencystats: add check for string overflow
telemetry: check for path overflow
efd: handle possible name truncation
eal: use C library to parse filesystem table
eal: warn if thread name is truncated
eal: avoid format overflow when handling addresses
eal: add check for sysfs path overflow
eal: limit maximum runtime directory and socket paths
eal: check for hugefile path overflow
eal: check tailq length
eal: handle long shared library path
ethdev: avoid possible overflow in xstat names
vhost: check for overflow in xstat name
cfgfile: add length checks and increase line buffer
lib: enable format overflow warnings
app/test/test_hash.c | 21 ++++++ doc/guides/rel_notes/release_26_03.rst | 13 ++++ lib/cfgfile/rte_cfgfile.c | 43 ++++++++--- lib/cfgfile/rte_cfgfile.h | 6 +- lib/eal/common/eal_common_config.c | 6 +- lib/eal/common/eal_common_memory.c | 2 +- lib/eal/common/eal_common_options.c | 17 +++-- lib/eal/common/eal_common_proc.c | 85 ++++++++++++++-------- lib/eal/common/eal_common_tailqs.c | 13 +++- lib/eal/common/eal_filesystem.h | 27 +++++-- lib/eal/freebsd/eal.c | 6 +- lib/eal/linux/eal.c | 6 +- lib/eal/linux/eal_hugepage_info.c | 98 ++++++++++++-------------- lib/eal/linux/eal_memalloc.c | 11 ++- lib/eal/linux/eal_memory.c | 9 ++- lib/eal/windows/eal.c | 6 +- lib/efd/rte_efd.c | 18 +++-- lib/ethdev/rte_ethdev.c | 35 ++++++--- lib/graph/graph_pcap.c | 9 ++- lib/hash/rte_cuckoo_hash.c | 41 +++++++---- lib/hash/rte_fbk_hash.c | 12 +++- lib/hash/rte_fbk_hash.h | 1 + lib/latencystats/rte_latencystats.c | 9 ++- lib/lpm/rte_lpm.c | 16 +++-- lib/lpm/rte_lpm.h | 1 + lib/meson.build | 4 -- lib/telemetry/telemetry_legacy.c | 7 +- lib/vhost/vhost.c | 14 ++-- 28 files changed, 368 insertions(+), 168 deletions(-)
Signature · 1 line
2.51.0
PATCH v10 1/18 lpm: restrict name size
Check that lpm name size is within limits.
--- doc/guides/rel_notes/release_26_03.rst | 7 +++++++ lib/lpm/rte_lpm.c | 16 ++++++++++++---- lib/lpm/rte_lpm.h | 1 + 3 files changed, 20 insertions(+), 4 deletions(-)
doc/guides/rel_notes/release_26_03.rst +7 -0
@@ -84,6 +84,13 @@ API Changes Also, make sure to start the actual text at the margin. ======================================================= +* **Added additional length checks for name parameter lengths.** + + Several library functions now have additional name length checks + instead of silently truncating. + + * lpm: name must be less than RTE_LPM_NAMESIZE. + ABI Changes -----------
lib/lpm/rte_lpm.c +12 -4
@@ -152,7 +152,7 @@ struct rte_lpm * rte_lpm_create(const char *name, int socket_id, const struct rte_lpm_config *config) { - char mem_name[RTE_LPM_NAMESIZE]; + char mem_name[RTE_LPM_NAMESIZE + sizeof("LPM_")];struct __rte_lpm *i_lpm;struct rte_lpm *lpm =NULL ;struct rte_tailq_entry *te;
@@ -170,6 +170,11 @@ rte_lpm_create(const char *name, int socket_id,return NULL ; } +if (strlen (name) >=RTE_LPM_NAMESIZE ) { + rte_errno =ENAMETOOLONG ; +return NULL ; + } +snprintf (mem_name,sizeof (mem_name),"LPM_%s" , name);rte_mcfg_tailq_write_lock ();
@@ -327,8 +332,10 @@ rte_lpm_rcu_qsbr_add(struct rte_lpm *lpm, struct rte_lpm_rcu_config *cfg)/* No other things to do. */ }else if (cfg->mode ==RTE_LPM_QSBR_MODE_DQ ) {/* Init QSBR defer queue. */ -snprintf (rcu_dq_name,sizeof (rcu_dq_name), -"LPM_RCU_%s" , i_lpm->name); +if (snprintf (rcu_dq_name,sizeof (rcu_dq_name), +"LPM_RCU_%s" , i_lpm->name) >= (int )sizeof (rcu_dq_name)) +LPM_LOG (NOTICE ,"LPM rcu defer queue name truncated" ); + params.name = rcu_dq_name; params.size = cfg->dq_size;if (params.size ==0 )
@@ -343,7 +350,8 @@ rte_lpm_rcu_qsbr_add(struct rte_lpm *lpm, struct rte_lpm_rcu_config *cfg) params.v = cfg->v; i_lpm->dq =rte_rcu_qsbr_dq_create (¶ms);if (i_lpm->dq ==NULL ) { -LPM_LOG (ERR ,"LPM defer queue creation failed" ); +LPM_LOG (ERR ,"LPM defer queue creation failed: %s" , +rte_strerror (rte_errno));return 1 ; } }else {
lib/lpm/rte_lpm.h +1 -0
@@ -180,6 +180,7 @@ rte_lpm_free(struct rte_lpm *lpm);* - ENOSPC - the maximum number of memzones has already been allocated * - EEXIST - a memzone with the same name already exists * - ENOMEM - no appropriate memory area found in which to create memzone +* - ENAMETOOLONG - LPM object name greater than RTE_LPM_NAMESIZE */ struct rte_lpm * rte_lpm_create(const char *name, int socket_id,
Signature · 1 line
2.51.0
PATCH v10 2/18 hash: add checks for hash name length
In reply to Stephen HemmingerAdd a missing check to the API that the name is within the current defined maximum name size. This name is then used internally to create ring names, those names could get truncated; if a name is truncated add message to log.
If ring creation fails it might be because of name conflict, so change the log message to decode error value.
Add additional tests as well.
--- app/test/test_hash.c | 21 +++++++++++++ doc/guides/rel_notes/release_26_03.rst | 3 ++ lib/hash/rte_cuckoo_hash.c | 41 ++++++++++++++++++-------- lib/hash/rte_fbk_hash.c | 12 ++++++-- lib/hash/rte_fbk_hash.h | 1 + 5 files changed, 63 insertions(+), 15 deletions(-)
app/test/test_hash.c +21 -0
@@ -1120,6 +1120,14 @@ fbk_hash_unit_test(void) .socket_id = RTE_MAX_NUMA_NODES + 1, /* invalid socket */ }; +/* try and create hash with an excessively long name */ +struct rte_fbk_hash_params invalid_params_long_name = { + .name ="four_byte_key_hash_name_length_32" , + .entries =4 , + .entries_per_bucket =2 , + .socket_id =0 , + }; +/* try to create two hashes with identical names * in this case, trying to create a second one will not * fail but will simply return pointer to the existing
@@ -1201,6 +1209,9 @@ fbk_hash_unit_test(void) handle =rte_fbk_hash_create (&invalid_params_7);RETURN_IF_ERROR_FBK (handle !=NULL ,"fbk hash creation should have failed" ); + handle =rte_fbk_hash_create (&invalid_params_long_name); +RETURN_IF_ERROR_FBK (handle !=NULL ,"fbk hash creation should have failed" ); +if (rte_eal_has_hugepages ()) { handle =rte_fbk_hash_create (&invalid_params_8); RETURN_IF_ERROR_FBK(handle != NULL,
@@ -1439,6 +1450,16 @@ static int test_hash_creation_with_bad_parameters(void)return -1 ; } +memcpy (¶ms, &ut_params,sizeof (params)); + params.name ="hash_creation_with_too_long_name" ; + params.socket_id =RTE_MAX_NUMA_NODES +1 ; + handle =rte_hash_create (¶ms); +if (handle !=NULL ) { +rte_hash_free (handle); +printf ("Impossible creating hash successfully with long name\n" ); +return -1 ; + } +/* test with same name should fail */ memcpy (¶ms, &ut_params,sizeof (params)); params.name ="same_name" ;
doc/guides/rel_notes/release_26_03.rst +3 -0
@@ -84,12 +84,15 @@ API Changes Also, make sure to start the actual text at the margin. ======================================================= + * **Added additional length checks for name parameter lengths.** Several library functions now have additional name length checks instead of silently truncating. * lpm: name must be less than RTE_LPM_NAMESIZE. + * hash: name parameter must be less than RTE_HASH_NAMESIZE. + ABI Changes
lib/hash/rte_cuckoo_hash.c +29 -12
89 lines not on this page · raw message
lib/hash/rte_fbk_hash.c +9 -3
@@ -5,6 +5,7 @@#include <stdint.h> #include <stdio.h> #include <string.h> +#include <stdlib.h> #include <errno.h> #include <sys/queue.h>
@@ -83,7 +84,7 @@ rte_fbk_hash_create(const struct rte_fbk_hash_params *params) {struct rte_fbk_hash_table *ht =NULL ;struct rte_tailq_entry *te; -char hash_name[RTE_FBK_HASH_NAMESIZE ]; +char hash_name[RTE_FBK_HASH_NAMESIZE +sizeof ("FBK_" )];const uint32_t mem_size =sizeof (*ht) + (sizeof (ht->t[0 ]) * params->entries);uint32_t i;
@@ -96,6 +97,7 @@ rte_fbk_hash_create(const struct rte_fbk_hash_params *params)/* Error checking of parameters. */ if ((!rte_is_power_of_2(params->entries)) || (!rte_is_power_of_2(params->entries_per_bucket)) || + (params->name == NULL) || (params->entries == 0) || (params->entries_per_bucket == 0) || (params->entries_per_bucket > params->entries) ||
@@ -105,6 +107,11 @@ rte_fbk_hash_create(const struct rte_fbk_hash_params *params)return NULL ; } +if (strlen (params->name) >=RTE_FBK_HASH_NAMESIZE ) { + rte_errno =ENAMETOOLONG ; +return NULL ; + } +snprintf (hash_name,sizeof (hash_name),"FBK_%s" , params->name);rte_mcfg_tailq_write_lock ();
@@ -128,8 +135,7 @@ rte_fbk_hash_create(const struct rte_fbk_hash_params *params) }/* Allocate memory for table. */ - ht =rte_zmalloc_socket (hash_name, mem_size, -0 , params->socket_id); + ht =rte_zmalloc_socket (hash_name, mem_size,0 , params->socket_id);if (ht ==NULL ) {HASH_LOG (ERR ,"Failed to allocate fbk hash table" );rte_free (te);
lib/hash/rte_fbk_hash.h +1 -0
@@ -348,6 +348,7 @@ void rte_fbk_hash_free(struct rte_fbk_hash_table *ht);* - ENOSPC - the maximum number of memzones has already been allocated * - EEXIST - a memzone with the same name already exists * - ENOMEM - no appropriate memory area found in which to create memzone +* - ENAMETOOLONG - name is parameters exceeds RTE_FBK_HASH_NAMESIZE */ struct rte_fbk_hash_table *rte_fbk_hash_create (const struct rte_fbk_hash_params *params)
Signature · 1 line
2.51.0
PATCH v10 3/18 graph: avoid overflowing comment buffer
In reply to Stephen HemmingerThe library builds a pcapng comment to put on each packet but the buffer is not big enough for the largest possible graph node name, etc. Change to use asprintf() to allow any string length. Note, if asprintf() fails it is better to still log the packet without comment so no data is lost.
--- lib/graph/graph_pcap.c | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-)
lib/graph/graph_pcap.c +6 -3
@@ -194,7 +194,7 @@ graph_pcap_dispatch(struct rte_graph *graph, uint16_t nb_objs) {struct rte_mbuf *mbuf_clones[RTE_GRAPH_BURST_SIZE ]; -char buffer[GRAPH_PCAP_BUF_SZ ]; +char *comment =NULL ;uint64_t i, num_packets;struct rte_mbuf *mbuf;ssize_t len;
@@ -207,19 +207,22 @@ graph_pcap_dispatch(struct rte_graph *graph,if (num_packets > nb_objs) num_packets = nb_objs; -snprintf (buffer,GRAPH_PCAP_BUF_SZ ,"%s: %s" , graph->name, node->name); +/* put a comment on all these packets */ +if (asprintf (&comment,"%s: %s" , graph->name, node->name) <0 ) +graph_err ("asprintf for comment failed." );for (i =0 ; i < num_packets; i++) {struct rte_mbuf *mc; mbuf = (struct rte_mbuf *)objs[i]; mc =rte_pcapng_copy (mbuf->port,0 , mbuf, pkt_mp, mbuf->pkt_len, -0 , buffer); +0 , comment);if (mc ==NULL )break ; mbuf_clones[i] = mc; } +free (comment);/* write it to capture file */ len =rte_pcapng_write_packets (pcapng_fd, mbuf_clones, i);
Signature · 1 line
2.51.0
PATCH v10 4/18 latencystats: add check for string overflow
In reply to Stephen HemmingerThe copy of latency stat names could get truncated if in the future a new value is added. Add warning if that happens.
--- lib/latencystats/rte_latencystats.c | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-)
lib/latencystats/rte_latencystats.c +6 -3
@@ -405,9 +405,12 @@ rte_latencystats_get_names(struct rte_metric_name *names, uint16_t size)if (names ==NULL || size <NUM_LATENCY_STATS )return NUM_LATENCY_STATS ; -for (i =0 ; i <NUM_LATENCY_STATS ; i++) -strlcpy (names[i].name, lat_stats_strings[i].name, -sizeof (names[i].name)); +for (i =0 ; i <NUM_LATENCY_STATS ; i++) { +if (strlcpy (names[i].name, lat_stats_strings[i].name,sizeof (names[0 ].name)) + >=sizeof (names[0 ].name)) +LATENCY_STATS_LOG (NOTICE ,"Latency metric '%s' too long" , + lat_stats_strings[i].name); + }return NUM_LATENCY_STATS ; }
Signature · 1 line
2.51.0
PATCH v10 5/18 telemetry: check for path overflow
In reply to Stephen HemmingerThe unix domain socket path is limited, check for overflow.
--- lib/telemetry/telemetry_legacy.c | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-)
lib/telemetry/telemetry_legacy.c +5 -2
@@ -102,14 +102,17 @@ register_client(const char *cmd __rte_unused, const char *params,return -1 ; } *strchr (data,'\"' ) =0 ; + addrs.sun_family =AF_UNIX ; +if (strlcpy (addrs.sun_path, data,sizeof (addrs.sun_path)) >=sizeof (addrs.sun_path)) { +fprintf (stderr,"Client path too long\n" ); +return -1 ; + } fd =socket (AF_UNIX ,SOCK_SEQPACKET ,0 );if (fd <0 ) {perror ("Failed to open socket" );return -1 ; } - addrs.sun_family =AF_UNIX ; -strlcpy (addrs.sun_path, data,sizeof (addrs.sun_path));if (connect (fd, (struct sockaddr *)&addrs,sizeof (addrs)) ==-1 ) {perror ("\nClient connection error\n" );
Signature · 1 line
2.51.0
PATCH v10 6/18 efd: handle possible name truncation
In reply to Stephen HemmingerIf the conversion of efd name to ring name gets truncated, then log it. And if the ring name than causes collision, make sure that log message includes error reason.
--- doc/guides/rel_notes/release_26_03.rst | 2 +- lib/efd/rte_efd.c | 18 ++++++++++++++---- 2 files changed, 15 insertions(+), 5 deletions(-)
doc/guides/rel_notes/release_26_03.rst +1 -1
@@ -92,7 +92,7 @@ API Changes * lpm: name must be less than RTE_LPM_NAMESIZE. * hash: name parameter must be less than RTE_HASH_NAMESIZE. - + * efd: name must be less than RTE_EFD_NAMESIZE. ABI Changes
lib/efd/rte_efd.c +14 -4
@@ -517,13 +517,20 @@ rte_efd_create(const char *name, uint32_t max_num_rules, uint32_t key_len, efd_list =RTE_TAILQ_CAST (rte_efd_tailq.head, rte_efd_list);if (online_cpu_socket_bitmask ==0 ) { -EFD_LOG (ERR ,"At least one CPU socket must be enabled " -"in the bitmask" ); +EFD_LOG (ERR ,"At least one CPU socket must be enabled in the bitmask" ); + rte_errno =EINVAL ;return NULL ; }if (max_num_rules ==0 ) {EFD_LOG (ERR ,"Max num rules must be higher than 0" ); + rte_errno =EINVAL ; +return NULL ; + } + +if (strlen (name) >=RTE_EFD_NAMESIZE ) { +EFD_LOG (ERR ,"Name is too long" ); + rte_errno =ENAMETOOLONG ;return NULL ; }
@@ -698,12 +705,15 @@ rte_efd_create(const char *name, uint32_t max_num_rules, uint32_t key_len,TAILQ_INSERT_TAIL (efd_list, te, next);rte_mcfg_tailq_write_unlock (); -snprintf (ring_name,sizeof (ring_name),"HT_%s" , table->name); +if (snprintf (ring_name,sizeof (ring_name),"HT_%s" , table->name) + >= (int )sizeof (ring_name)) +EFD_LOG (NOTICE ,"EFD ring name truncated to '%s'" , ring_name); +/* Create ring (Dummy slot index is not enqueued) */ r =rte_ring_create (ring_name,rte_align32pow2 (table->max_num_rules), offline_cpu_socket,0 );if (r ==NULL ) { -EFD_LOG (ERR ,"memory allocation failed" ); +EFD_LOG (ERR ,"ring creation failed: %s" ,rte_strerror (rte_errno));rte_efd_free (table);return NULL ; }
Signature · 1 line
2.51.0
PATCH v10 7/18 eal: use C library to parse filesystem table
In reply to Stephen HemmingerRather than doing parsing of /proc/mounts with open coded string handling, use the standard C library routines.
These exist in BSD and Linux.
It also avoids any possible issues with escaped strings etc which the library handles. See getmntent(3) man page.
--- lib/eal/linux/eal_hugepage_info.c | 58 ++++++++++--------------------- 1 file changed, 18 insertions(+), 40 deletions(-)
lib/eal/linux/eal_hugepage_info.c +18 -40
@@ -13,6 +13,7 @@#include <inttypes.h> #include <unistd.h> #include <errno.h> +#include <mntent.h> #include <sys/mman.h> #include <sys/stat.h>
@@ -195,23 +196,13 @@ get_default_hp_size(void)static int get_hugepage_dir (uint64_t hugepage_sz,char *hugedir,int len) { -enum proc_mount_fieldnames { -DEVICE =0 , -MOUNTPT , -FSTYPE , -OPTIONS , - _FIELDNAME_MAX - };static uint64_t default_size =0 ;const char proc_mounts[] ="/proc/mounts" ; -const char hugetlbfs_str[] ="hugetlbfs" ; -const size_t htlbfs_str_len =sizeof (hugetlbfs_str) -1 ;const char pagesize_opt[] ="pagesize=" ;const size_t pagesize_opt_len =sizeof (pagesize_opt) -1 ; -const char split_tok =' ' ; -char *splitstr[_FIELDNAME_MAX];char found[PATH_MAX ] ="" ;char buf[BUFSIZ ]; +struct mntent entry;const struct internal_config *internal_conf =eal_get_internal_configuration (); const size_t hugepage_dir_len = (internal_conf->hugepage_dir != NULL) ?
@@ -226,56 +217,43 @@ get_hugepage_dir(uint64_t hugepage_sz, char *hugedir, int len)return -1 ; } -FILE *fd =fopen (proc_mounts,"r" ); -if (fd ==NULL ) +FILE *mounts =setmntent (proc_mounts,"r" ); +if (mounts ==NULL )rte_panic ("Cannot open %s\n" , proc_mounts);if (default_size ==0 ) default_size =get_default_hp_size (); -while (fgets (buf,sizeof (buf), fd)){ +while (getmntent_r (mounts, &entry, buf,sizeof (buf))) {const char *pagesz_str; -size_t mountpt_len =0 ; - -if (rte_strsplit (buf,sizeof (buf), splitstr, _FIELDNAME_MAX, - split_tok) != _FIELDNAME_MAX) { -EAL_LOG (ERR ,"Error parsing %s" , proc_mounts); -break ;/* return NULL */ - } +uint64_t pagesz = default_size; +size_t mountpt_len; -if (strncmp (splitstr[FSTYPE ], hugetlbfs_str, htlbfs_str_len) !=0 ) +if (strcmp (entry.mnt_type,"hugetlbfs" ) !=0 )continue ; - pagesz_str =strstr (splitstr[OPTIONS ], pagesize_opt); + pagesz_str =strstr (entry.mnt_opts, pagesize_opt); +if (pagesz_str) + pagesz =rte_str_to_size (&pagesz_str[pagesize_opt_len]); -/* if no explicit page size, the default page size is compared */ -if (pagesz_str ==NULL ) { -if (hugepage_sz != default_size) -continue ; - } -/* there is an explicit page size, so check it */ -else { -uint64_t pagesz =rte_str_to_size (&pagesz_str[pagesize_opt_len]); -if (pagesz != hugepage_sz) -continue ; - } +if (pagesz != hugepage_sz) +continue ;/* * If no --huge-dir option has been given, we're done. */ if (internal_conf->hugepage_dir ==NULL ) { -strlcpy (found, splitstr[MOUNTPT ], len); +strlcpy (found, entry.mnt_dir, len);break ; } - mountpt_len =strlen (splitstr[MOUNTPT ]); + mountpt_len =strlen (entry.mnt_dir);/* * Ignore any mount that doesn't contain the --huge-dir directory * or where mount point is not a parent path of --huge-dir */ -if (strncmp (internal_conf->hugepage_dir, splitstr[MOUNTPT ], - mountpt_len) !=0 || +if (strncmp (internal_conf->hugepage_dir, entry.mnt_dir, mountpt_len) !=0 || (hugepage_dir_len > mountpt_len && internal_conf->hugepage_dir[mountpt_len] !='/' )) {continue ;
@@ -286,10 +264,10 @@ get_hugepage_dir(uint64_t hugepage_sz, char *hugedir, int len)* (so /mnt/1 is preferred over /mnt for matching /mnt/1/2)). */ if (mountpt_len >strlen (found)) -strlcpy (found, splitstr[MOUNTPT ], len); +strlcpy (found, entry.mnt_dir, len); }/* end while fgets */ -fclose (fd); +endmntent (mounts);if (found[0 ] !='\0' ) {/* If needed, return the requested dir, not the mount point. */
Signature · 1 line
2.51.0
PATCH v10 8/18 eal: warn if thread name is truncated
In reply to Stephen HemmingerThread name is very short 16 characters and therefore the name dpdk-worker-%d will overflow with more than 9999 worker cores. Error should be non-fatal since name only matters for debug.
--- lib/eal/freebsd/eal.c | 6 ++++-- lib/eal/linux/eal.c | 6 ++++-- lib/eal/windows/eal.c | 6 ++++-- 3 files changed, 12 insertions(+), 6 deletions(-)
lib/eal/freebsd/eal.c +4 -2
@@ -690,8 +690,10 @@ rte_eal_init(int argc, char **argv)rte_panic ("Cannot create thread\n" );/* Set thread_name for aid in debugging. */ -snprintf (thread_name,sizeof (thread_name), -"dpdk-worker%d" , i); + ret =snprintf (thread_name,sizeof (thread_name),"dpdk-worker%d" , i); +if (ret >=RTE_THREAD_NAME_SIZE ) +EAL_LOG (INFO ,"Worker thread name %s truncated" , thread_name); +rte_thread_set_name (lcore_config[i].thread_id, thread_name); ret = rte_thread_set_affinity_by_id(lcore_config[i].thread_id,
lib/eal/linux/eal.c +4 -2
@@ -863,8 +863,10 @@ rte_eal_init(int argc, char **argv)rte_panic ("Cannot create thread\n" );/* Set thread_name for aid in debugging. */ -snprintf (thread_name,sizeof (thread_name), -"dpdk-worker%d" , i); + ret =snprintf (thread_name,sizeof (thread_name),"dpdk-worker%d" , i); +if (ret >=RTE_THREAD_NAME_SIZE ) +EAL_LOG (INFO ,"Worker thread name %s truncated" , thread_name); +rte_thread_set_name (lcore_config[i].thread_id, thread_name); ret = rte_thread_set_affinity_by_id(lcore_config[i].thread_id,
lib/eal/windows/eal.c +4 -2
@@ -378,8 +378,10 @@ rte_eal_init(int argc, char **argv)rte_panic ("Cannot create thread\n" );/* Set thread name for aid in debugging. */ -snprintf (thread_name,sizeof (thread_name), -"dpdk-worker%d" , i); + ret =snprintf (thread_name,sizeof (thread_name),"dpdk-worker%d" , i); +if (ret >=RTE_THREAD_NAME_SIZE ) +EAL_LOG (INFO ,"Worker thread name %s truncated" , thread_name); +rte_thread_set_name (lcore_config[i].thread_id, thread_name); ret = rte_thread_set_affinity_by_id(lcore_config[i].thread_id,
Signature · 1 line
2.51.0
PATCH v10 9/18 eal: avoid format overflow when handling addresses
In reply to Stephen HemmingerThe largest possible string in this code 0xFFFFFFFFFFFFFFFF which will overflow with only 15 character buffer. Increase to 20.
--- lib/eal/common/eal_common_memory.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
lib/eal/common/eal_common_memory.c +1 -1
@@ -1153,7 +1153,7 @@ rte_eal_memory_init(void)#define EAL_MEMSEG_INFO_REQ "/eal/memseg_info"#define EAL_ELEMENT_LIST_REQ "/eal/mem_element_list"#define EAL_ELEMENT_INFO_REQ "/eal/mem_element_info" -#define ADDR_STR 15 +#define ADDR_STR 20/* 16 bytes 64 bit + 0x */ /* Telemetry callback handler to return heap stats for requested heap id. */
Signature · 1 line
2.51.0
PATCH v10 10/18 eal: add check for sysfs path overflow
In reply to Stephen HemmingerShouldn't happen but in theory sysfs socket could overflow. Add a check for it.
--- lib/eal/linux/eal_hugepage_info.c | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-)
lib/eal/linux/eal_hugepage_info.c +5 -1
@@ -150,8 +150,12 @@ get_num_hugepages_on_node(const char *subdir, unsigned int socket, size_t sz)return 0 ; } -snprintf (path,sizeof (path),"%s/%s/%s" , +if (snprintf (path,sizeof (path),"%s/%s/%s" , socketpath, subdir, nr_hp_file) >=PATH_MAX ) { +EAL_LOG (NOTICE ,"Socket path %s/%s/%s is truncated" , socketpath, subdir, nr_hp_file); +return 0 ; + } +if (eal_parse_sysfs_value (path, &num_pages) <0 )return 0 ;
Signature · 1 line
2.51.0
PATCH v10 11/18 eal: limit maximum runtime directory and socket paths
In reply to Stephen HemmingerLinux has a limitation of 108 characters (including null character) for AF_UNIX socket path. FreeBSD limit is smaller 104 characters and Windows has same definition (108) in afunix.h header.
In current code, EAL will fail in telemetry, so this should not break existing users.
EAL: Multi-process socket /var/run/dpdk/x7Q9mP2a...
EAL: Selected IOVA mode 'VA'
TELEMETRY: Error with socket binding, path too long
Now long string fails on command line parsing:
EAL: Runtime directory string too long
EAL: Cannot create runtime directory
EAL: Error parsing command line arguments.
--- lib/eal/common/eal_common_config.c | 6 ++- lib/eal/common/eal_common_proc.c | 85 +++++++++++++++++++----------- lib/eal/common/eal_filesystem.h | 17 +++++- 3 files changed, 74 insertions(+), 34 deletions(-)
lib/eal/common/eal_common_config.c +4 -2
@@ -6,6 +6,7 @@#include <eal_export.h> #include "eal_private.h" +#include "eal_filesystem.h" #include "eal_memcfg.h" /* early configuration structure, when memory config is not mmapped */
@@ -24,7 +25,7 @@ static struct rte_config rte_config = { };/* platform-specific runtime dir */ -static char runtime_dir[PATH_MAX ]; +static char runtime_dir[UNIX_PATH_MAX ];/* internal configuration */ static struct internal_config internal_config;
@@ -39,7 +40,8 @@ rte_eal_get_runtime_dir(void)int eal_set_runtime_dir (const char *run_dir) { -if (strlcpy (runtime_dir, run_dir,PATH_MAX ) >=PATH_MAX ) { +/* runtime directory limited by maximum allowable unix domain socket */ +if (strlcpy (runtime_dir, run_dir,UNIX_PATH_MAX ) >=UNIX_PATH_MAX ) {EAL_LOG (ERR ,"Runtime directory string too long" );return -1 ; }
lib/eal/common/eal_common_proc.c +54 -31
176 lines not on this page · raw message
lib/eal/common/eal_filesystem.h +16 -1
@@ -45,10 +45,25 @@ eal_runtime_config_path(void)/** Path of primary/secondary communication unix socket file. */ #define MP_SOCKET_FNAME "mp_socket" + +#ifdef RTE_EXEC_ENV_WINDOWS +/* +* UNIX_PATH_MAX is defined in afunux.h but that file is not in MingGW 9 +* which is the version in Ubuntu 22.04, in future this can change. +* Also, Unix domain sockets are not uses in DPDK on Windows (yet). +*/ +#define UNIX_PATH_MAX 108 +#else +#include <sys/un.h> + +/** Maximum length of unix domain socket path. */ +#define UNIX_PATH_MAX (sizeof(((struct sockaddr_un *)0)->sun_path)) +#endif +static inline const char *eal_mp_socket_path (void ) { -static char buffer[PATH_MAX ];/* static so auto-zeroed */ +static char buffer[UNIX_PATH_MAX ];/* static so auto-zeroed */ snprintf (buffer,sizeof (buffer),"%s/%s" ,rte_eal_get_runtime_dir (),MP_SOCKET_FNAME );
Signature · 1 line
2.51.0
PATCH v10 12/18 eal: check for hugefile path overflow
In reply to Stephen HemmingerWhen constructing huge filename path, check for possible overflow of PATH_MAX.
--- lib/eal/common/eal_filesystem.h | 10 ++++--- lib/eal/linux/eal_hugepage_info.c | 44 ++++++++++++++++++------------- lib/eal/linux/eal_memalloc.c | 11 ++++++-- lib/eal/linux/eal_memory.c | 9 +++++-- 4 files changed, 48 insertions(+), 26 deletions(-)
lib/eal/common/eal_filesystem.h +6 -4
@@ -104,12 +104,14 @@ eal_hugepage_data_path(void)/** String format for hugepage map files. */ #define HUGEFILE_FMT "%s/%smap_%d" -static inline const char * +static inline __rte_warn_unused_result const char *eal_get_hugefile_path (char *buffer,size_t buflen,const char *hugedir,int f_id) { -snprintf (buffer, buflen,HUGEFILE_FMT , hugedir, -eal_get_hugefile_prefix (), f_id); -return buffer; +if (snprintf (buffer, buflen,HUGEFILE_FMT , hugedir, +eal_get_hugefile_prefix (), f_id) >= (int )buflen) +return NULL ; +else +return buffer; }/** define the default filename prefix for the %s values above */
lib/eal/linux/eal_hugepage_info.c +26 -18
100 lines not on this page · raw message
lib/eal/linux/eal_memalloc.c +9 -2
@@ -260,6 +260,7 @@ get_seg_fd(char *path, int buflen, struct hugepage_info *hi, {int fd;int *out_fd; +const char *huge_path;struct stat st;int ret; const struct internal_config *internal_conf =
@@ -276,12 +277,18 @@ get_seg_fd(char *path, int buflen, struct hugepage_info *hi,if (internal_conf->single_file_segments) { out_fd = &fd_list[list_idx].memseg_list_fd; -eal_get_hugefile_path (path, buflen, hi->hugedir, list_idx); + huge_path =eal_get_hugefile_path (path, buflen, hi->hugedir, list_idx); }else { out_fd = &fd_list[list_idx].fds[seg_idx]; -eal_get_hugefile_path (path, buflen, hi->hugedir, + huge_path =eal_get_hugefile_path (path, buflen, hi->hugedir, list_idx *RTE_MAX_MEMSEG_PER_LIST + seg_idx); } +if (huge_path ==NULL ) { +EAL_LOG (DEBUG ,"%s(): hugefile path truncated: '%s'" , + __func__, path); +return -1 ; + } + fd = *out_fd;if (fd >=0 )return fd;
lib/eal/linux/eal_memory.c +7 -2
@@ -337,8 +337,13 @@ map_all_hugepages(struct hugepage_file *hugepg_tbl, struct hugepage_info *hpi, hf->file_id = i; hf->size = hugepage_sz; -eal_get_hugefile_path (hf->filepath,sizeof (hf->filepath), - hpi->hugedir, hf->file_id); +if (eal_get_hugefile_path (hf->filepath,sizeof (hf->filepath), + hpi->hugedir, hf->file_id) ==NULL ) { +EAL_LOG (DEBUG ,"%s(): huge file path '%s' truncated" , + __func__, hf->filepath); + goto out; + } + hf->filepath[sizeof (hf->filepath) -1 ] ='\0' ;/* try to create hugepage file */
Signature · 1 line
2.51.0
PATCH v10 13/18 eal: check tailq length
In reply to Stephen HemmingerThe tailq name should not be allowed to exceed limits.
--- doc/guides/rel_notes/release_26_03.rst | 1 + lib/eal/common/eal_common_tailqs.c | 13 ++++++++++++- 2 files changed, 13 insertions(+), 1 deletion(-)
doc/guides/rel_notes/release_26_03.rst +1 -0
@@ -93,6 +93,7 @@ API Changes * lpm: name must be less than RTE_LPM_NAMESIZE. * hash: name parameter must be less than RTE_HASH_NAMESIZE. * efd: name must be less than RTE_EFD_NAMESIZE. + * tailq: name must be less than RTE_TAILQ_NAMESIZE. ABI Changes
lib/eal/common/eal_common_tailqs.c +12 -1
@@ -8,6 +8,7 @@#include <rte_eal.h> #include <rte_eal_memconfig.h> +#include <rte_errno.h> #include <rte_log.h> #include <rte_string_fns.h>
@@ -30,8 +31,10 @@ rte_eal_tailq_lookup(const char *name)unsigned i;struct rte_mem_config *mcfg =rte_eal_get_configuration ()->mem_config; -if (name ==NULL ) +if (name ==NULL ) { + rte_errno =EINVAL ;return NULL ; + } for (i = 0; i < RTE_MAX_TAILQ; i++) { if (!strncmp(name, mcfg->tailq_head[i].name,
@@ -39,6 +42,7 @@ rte_eal_tailq_lookup(const char *name)return &mcfg->tailq_head[i]; } + rte_errno =ENOENT ;return NULL ; }
@@ -67,6 +71,12 @@ rte_eal_tailq_create(const char *name) {struct rte_tailq_head *head =NULL ; +if (strlen (name) >=sizeof (head->name)) { +EAL_LOG (ERR ,"tailq name '%s' is too long" , name); + rte_errno =ENAMETOOLONG ; +return NULL ; + } +if (!rte_eal_tailq_lookup (name) && (rte_tailqs_count +1 <RTE_MAX_TAILQ )) {struct rte_mem_config *mcfg;
@@ -115,6 +125,7 @@ rte_eal_tailq_register(struct rte_tailq_elem *t)if (rte_eal_tailq_local_register (t) <0 ) {EAL_LOG (ERR ,"%s tailq is already registered" , t->name); + rte_errno =EEXIST ; goto error; }
Signature · 1 line
2.51.0