first steps in fixing buffer overflow
Subsystems (2)
PATCH v10 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 v10 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 v10 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 v10 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 v10 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
v11 cover lib: improve string overflow safety
In reply to Stephen HemmingerThis series improves defensive programming by adding proper string length validation and overflow checking throughout DPDK libraries. The goal is to eliminate silent truncation of names and paths, provide meaningful error feedback, and enable compiler format overflow warnings.
Motivation
----------
Many DPDK APIs accept name parameters with defined maximum lengths (e.g., RTE_LPM_NAMESIZE, RTE_HASH_NAMESIZE). Previously, names exceeding these limits were silently truncated via snprintf/strlcpy, potentially causing subtle bugs like duplicate names or unexpected behavior. This series addresses these issues systematically.
Changes Overview
----------------
The patches fall into several categories:
1. API input validation (patches 1-2, 6, 13, 17):
- Add explicit length checks for name parameters in lpm, hash, efd, tailq, and cfgfile APIs
- Return ENAMETOOLONG when names exceed limits
- Document new error conditions in API headers
- Add corresponding unit tests
2. Internal buffer overflow detection (patches 3-5, 8-10, 12, 15-16):
- Check snprintf/strlcpy return values for truncation
- Log warnings when internal string operations truncate
- Increase buffer sizes where they were too small
- Use dynamic allocation (asprintf) where appropriate
3. Path handling improvements (patches 7, 11, 14):
- Use standard C library routines (getmntent) for parsing /proc/mounts
- Enforce UNIX_PATH_MAX for socket paths to fail early
- Handle arbitrarily long shared library paths
4. Error message improvements (patches 1-2, 6):
- Include rte_strerror() in failure messages
- Provide more context when operations fail
5. Enable compiler warnings (patch 18):
- Remove -Wno-format-truncation flag
- All preceding patches fix the warnings this would trigger
API Changes
-----------
The following APIs now return ENAMETOOLONG for oversized names:
- rte_lpm_create()
- rte_hash_create()
- rte_fbk_hash_create()
- rte_efd_create()
- rte_eal_tailq_create()
- rte_cfgfile_add_section()
- rte_cfgfile_add_entry()
These are documented in the release notes and header files.
Testing
-------
- Existing unit tests pass
- New test cases added for hash name length validation
- Build tested with format overflow warnings enabled
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 | 3 +- 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 | 92 ++++++++++++-------------- 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, 366 insertions(+), 165 deletions(-)
Signature · 1 line
2.51.0
PATCH v11 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 v11 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 in 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 v11 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 v11 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 v11 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 v11 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 v11 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 v11 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 v11 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 | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-)
lib/eal/common/eal_common_memory.c +2 -1
@@ -1153,8 +1153,9 @@ 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 +/* Address string is "0x" prefix + 16 hex digits + null */ +#define ADDR_STR 20/* Telemetry callback handler to return heap stats for requested heap id. */ static int
Signature · 1 line
2.51.0
PATCH v11 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 v11 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 v11 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 | 34 +++++++++++++++++++------------ lib/eal/linux/eal_memalloc.c | 11 ++++++++-- lib/eal/linux/eal_memory.c | 9 ++++++-- 4 files changed, 43 insertions(+), 21 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 +21 -13
@@ -68,11 +68,14 @@ create_shared_memory(const char *filename, const size_t mem_size)static int get_hp_sysfs_value (const char *subdir,const char *file,unsigned long *val) { -char path[PATH_MAX ]; +char *path =NULL ; +int ret; -snprintf (path,sizeof (path),"%s/%s/%s" , - sys_dir_path, subdir, file); -return eal_parse_sysfs_value (path, val); +if (asprintf (&path,"%s/%s/%s" , sys_dir_path, subdir, file) <0 ) +return -1 ; + ret =eal_parse_sysfs_value (path, val); +free (path); +return ret; }/* this function is only called from eal_hugepage_info_init which itself
@@ -133,13 +136,15 @@ get_num_hugepages(const char *subdir, size_t sz, unsigned int reusable_pages)static uint32_t get_num_hugepages_on_node (const char *subdir,unsigned int socket,size_t sz) { -char path[PATH_MAX ], socketpath[PATH_MAX ]; +char *path =NULL , *socketpath =NULL ;DIR *socketdir;unsigned long num_pages =0 ;const char *nr_hp_file ="free_hugepages" ; -snprintf (socketpath,sizeof (socketpath),"%s/node%u/hugepages" , - sys_pages_numa_dir_path, socket); +if (asprintf (&socketpath,"%s/node%u/hugepages" , sys_pages_numa_dir_path, socket) <0 ) { +EAL_LOG (ERR ,"Can not format node huge page path" ); + goto nopages; + } socketdir =opendir (socketpath);if (socketdir) {
@@ -147,17 +152,16 @@ get_num_hugepages_on_node(const char *subdir, unsigned int socket, size_t sz)closedir (socketdir); }else {/* Can't find socket dir, so ignore it */ -return 0 ; + goto nopages; } -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 (asprintf (&path,"%s/%s/%s" , socketpath, subdir, nr_hp_file) <0 ) { +EAL_LOG (ERR ,"Can not format free hugepages path" ); + goto nopages; }if (eal_parse_sysfs_value (path, &num_pages) <0 ) -return 0 ; + goto nopages;if (num_pages ==0 ) EAL_LOG(WARNING, "No free %zu kB hugepages reported on node %u",
@@ -170,6 +174,10 @@ get_num_hugepages_on_node(const char *subdir, unsigned int socket, size_t sz)if (num_pages >UINT32_MAX ) num_pages =UINT32_MAX ; +nopages: +free (path); +free (socketpath); +return num_pages; }
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 v11 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 v11 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
@@ -572,7 +572,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' )
@@ -586,19 +585,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, false) ==-1 ) +if (eal_plugin_add (sopath, false) ==-1 ) { +free (sopath);break ; + } +free (sopath); }closedir (d);
Signature · 1 line
2.51.0
PATCH v11 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
@@ -3488,9 +3488,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++; }
@@ -3500,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++; }
@@ -3511,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
PATCH v11 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 v11 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 v11 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
v12 cover lib: improve string overflow safety
In reply to Stephen HemmingerThis series improves defensive programming by adding proper string length validation and overflow checking throughout DPDK libraries. The goal is to eliminate silent truncation of names and paths, provide meaningful error feedback, and enable compiler format overflow warnings.
Motivation
----------
Many DPDK APIs accept name parameters with defined maximum lengths (e.g., RTE_LPM_NAMESIZE, RTE_HASH_NAMESIZE). Previously, names exceeding these limits were silently truncated via snprintf/strlcpy, potentially causing subtle bugs like duplicate names or unexpected behavior. This series addresses these issues systematically.
Changes Overview
----------------
The patches fall into several categories:
1. API input validation (patches 1-2, 6, 12, 16):
- Add explicit length checks for name parameters in lpm, hash, efd, tailq, and cfgfile APIs
- Return ENAMETOOLONG when names exceed limits
- Document new error conditions in API headers
- Add corresponding unit tests
2. Internal buffer overflow detection (patches 3-5, 8-9, 14-15):
- Check snprintf/strlcpy return values for truncation
- Log warnings when internal string operations truncate
- Increase buffer sizes where they were too small
- Use dynamic allocation (asprintf) where appropriate
3. Path handling improvements (patches 7, 10-11, 13):
- Use standard C library routines (getmntent) for parsing /proc/mounts
- Enforce UNIX_PATH_MAX for socket paths to fail early
- Handle arbitrarily long shared library paths
4. Error message improvements (patches 1-2, 6):
- Include rte_strerror() in failure messages
- Provide more context when operations fail
5. Enable compiler warnings (patch 17):
- Remove -Wno-format-truncation flag
- All preceding patches fix the warnings this would trigger
API Changes
-----------
The following APIs now return ENAMETOOLONG for oversized names:
- rte_lpm_create()
- rte_hash_create()
- rte_fbk_hash_create()
- rte_efd_create()
- rte_eal_tailq_create()
- rte_cfgfile_add_section()
- rte_cfgfile_add_entry()
These are documented in the release notes and header files.
Testing
-------
- Existing unit tests pass
- New test cases added for hash name length validation
- Build tested with format overflow warnings enabled
v12:
- Fix build if strlcpy is mapped to snprintf (no libbsd)
- Drop redundant "eal: add check for sysfs path overflow" patch; the sysfs path handling is now consolidated in the hugefile path overflow patch using asprintf
- Fix hash unit test to use SOCKET_ID_ANY instead of invalid socket ID when testing name length validation
- Remove extraneous blank line in cfgfile patch
v11:
- Rebase and address review feedback
Stephen Hemminger (17):
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: 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 | 42 +++++++++--- lib/cfgfile/rte_cfgfile.h | 6 +- lib/eal/common/eal_common_config.c | 6 +- lib/eal/common/eal_common_memory.c | 3 +- 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 | 90 ++++++++++++-------------- 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, 352 insertions(+), 166 deletions(-)
Signature · 55 lines
2.51.0 Stephen Hemminger (17): 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: 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 | 42 ++++++++-- lib/cfgfile/rte_cfgfile.h | 6 +- lib/eal/common/eal_common_config.c | 6 +- lib/eal/common/eal_common_memory.c | 3 +- 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 | 112 ++++++++++++------------- 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, 380 insertions(+), 170 deletions(-) -- 2.51.0
PATCH v12 1/17 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 v12 2/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 | 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 =SOCKET_ID_ANY ; + 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 in 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 v12 3/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 v12 4/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
Re: [PATCH v12 04/17] latencystats: add check for string overflow
Quoted 5 lines · Stephen Hemminger
The copy of latency stat names could get truncated if in the future a new value is added. Add warning if that happens.
Signed-off-by Stephen Hemminger <[email protected]>---
Quoted 26 lines
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 v12 5/17 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
Re: [PATCH v12 05/17] telemetry: check for path overflow
Quoted 4 lines · Stephen Hemminger
The unix domain socket path is limited, check for overflow.
Signed-off-by Stephen Hemminger <[email protected]>---
Quoted 30 lines
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 v12 6/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.
--- 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 v12 7/17 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 | 78 +++++++++++++------------------ 1 file changed, 33 insertions(+), 45 deletions(-)
lib/eal/linux/eal_hugepage_info.c +33 -45
@@ -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 *found =NULL ;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,45 @@ 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); + found =strdup (entry.mnt_dir); +if (found ==NULL ) +rte_panic ("Cannot dup %s" , entry.mnt_dir);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 ;
@@ -285,16 +265,24 @@ get_hugepage_dir(uint64_t hugepage_sz, char *hugedir, int len)* We found a match, but only prefer it if it's a longer match * (so /mnt/1 is preferred over /mnt for matching /mnt/1/2)). */ -if (mountpt_len >strlen (found)) -strlcpy (found, splitstr[MOUNTPT ], len); +if (mountpt_len >strlen (found)) { + found =realloc (found, mountpt_len +1 ); +if (found ==NULL ) +rte_panic ("Cannot realloc for %s" , entry.mnt_dir); +memcpy (found, entry.mnt_dir, mountpt_len +1 ); + } + }/* end while fgets */ -fclose (fd); +endmntent (mounts); -if (found[0 ] !='\0' ) { +if (found !=NULL ) {/* If needed, return the requested dir, not the mount point. */ -strlcpy (hugedir, internal_conf->hugepage_dir !=NULL ? - internal_conf->hugepage_dir : found, len); +if (internal_conf->hugepage_dir !=NULL ) +strlcpy (hugedir, internal_conf->hugepage_dir, len); +else +strlcpy (hugedir, found, len); +free (found);return 0 ; }
Signature · 1 line
2.51.0
PATCH v12 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 >=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 v12 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 | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-)
lib/eal/common/eal_common_memory.c +2 -1
@@ -1153,8 +1153,9 @@ 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 +/* Address string is "0x" prefix + 16 hex digits + null */ +#define ADDR_STR 20/* Telemetry callback handler to return heap stats for requested heap id. */ static int
Signature · 1 line
2.51.0
PATCH v12 10/17 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 v12 11/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 | 34 +++++++++++++++++++++---------- lib/eal/linux/eal_memalloc.c | 11 ++++++++-- lib/eal/linux/eal_memory.c | 9 ++++++-- 4 files changed, 45 insertions(+), 19 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 +23 -11
@@ -68,11 +68,14 @@ create_shared_memory(const char *filename, const size_t mem_size)static int get_hp_sysfs_value (const char *subdir,const char *file,unsigned long *val) { -char path[PATH_MAX ]; +char *path =NULL ; +int ret; -snprintf (path,sizeof (path),"%s/%s/%s" , - sys_dir_path, subdir, file); -return eal_parse_sysfs_value (path, val); +if (asprintf (&path,"%s/%s/%s" , sys_dir_path, subdir, file) <0 ) +return -1 ; + ret =eal_parse_sysfs_value (path, val); +free (path); +return ret; }/* this function is only called from eal_hugepage_info_init which itself
@@ -133,13 +136,15 @@ get_num_hugepages(const char *subdir, size_t sz, unsigned int reusable_pages)static uint32_t get_num_hugepages_on_node (const char *subdir,unsigned int socket,size_t sz) { -char path[PATH_MAX ], socketpath[PATH_MAX ]; +char *path =NULL , *socketpath =NULL ;DIR *socketdir;unsigned long num_pages =0 ;const char *nr_hp_file ="free_hugepages" ; -snprintf (socketpath,sizeof (socketpath),"%s/node%u/hugepages" , - sys_pages_numa_dir_path, socket); +if (asprintf (&socketpath,"%s/node%u/hugepages" , sys_pages_numa_dir_path, socket) <0 ) { +EAL_LOG (ERR ,"Can not format node huge page path" ); + goto nopages; + } socketdir =opendir (socketpath);if (socketdir) {
@@ -147,13 +152,16 @@ get_num_hugepages_on_node(const char *subdir, unsigned int socket, size_t sz)closedir (socketdir); }else {/* Can't find socket dir, so ignore it */ -return 0 ; + goto nopages; + } + +if (asprintf (&path,"%s/%s/%s" , socketpath, subdir, nr_hp_file) <0 ) { +EAL_LOG (ERR ,"Can not format free hugepages path" ); + goto nopages; } -snprintf (path,sizeof (path),"%s/%s/%s" , - socketpath, subdir, nr_hp_file);if (eal_parse_sysfs_value (path, &num_pages) <0 ) -return 0 ; + goto nopages;if (num_pages ==0 ) EAL_LOG(WARNING, "No free %zu kB hugepages reported on node %u",
@@ -166,6 +174,10 @@ get_num_hugepages_on_node(const char *subdir, unsigned int socket, size_t sz)if (num_pages >UINT32_MAX ) num_pages =UINT32_MAX ; +nopages: +free (path); +free (socketpath); +return num_pages; }
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 v12 12/17 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 v12 13/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
@@ -572,7 +572,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' )
@@ -586,19 +585,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, false) ==-1 ) +if (eal_plugin_add (sopath, false) ==-1 ) { +free (sopath);break ; + } +free (sopath); }closedir (d);
Signature · 1 line
2.51.0
PATCH v12 14/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
@@ -3488,9 +3488,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++; }
@@ -3500,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++; }
@@ -3511,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
PATCH v12 15/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 v12 16/17 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 | 42 ++++++++++++++++++++------ lib/cfgfile/rte_cfgfile.h | 6 +++- 3 files changed, 40 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 +33 -9
100 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 v12 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
v13 cover lib: improve string overflow safety
In reply to Stephen HemmingerThis series improves defensive programming by adding proper string length validation and overflow checking throughout DPDK libraries. The goal is to eliminate silent truncation of names and paths, provide meaningful error feedback, and enable compiler format overflow warnings.
Motivation
----------
Many DPDK APIs accept name parameters with defined maximum lengths (e.g., RTE_LPM_NAMESIZE, RTE_HASH_NAMESIZE). Previously, names exceeding these limits were silently truncated via snprintf/strlcpy, potentially causing subtle bugs like duplicate names or unexpected behavior. This series addresses these issues systematically.
Changes Overview
----------------
The patches fall into several categories:
1. API input validation (patches 1-2, 6, 12, 16):
- Add explicit length checks for name parameters in lpm, hash, efd, tailq, and cfgfile APIs
- Return ENAMETOOLONG when names exceed limits
- Document new error conditions in API headers
- Add corresponding unit tests
2. Internal buffer overflow detection (patches 3-5, 8-9, 14-15):
- Check snprintf/strlcpy return values for truncation
- Log warnings when internal string operations truncate
- Increase buffer sizes where they were too small
- Use dynamic allocation (asprintf) where appropriate
3. Path handling improvements (patches 7, 10-11, 13):
- Use standard C library routines (getmntent) for parsing /proc/mounts
- Enforce UNIX_PATH_MAX for socket paths to fail early
- Handle arbitrarily long shared library paths
4. Error message improvements (patches 1-2, 6):
- Include rte_strerror() in failure messages
- Provide more context when operations fail
5. Enable compiler warnings (patch 17):
- Remove -Wno-format-truncation flag
- All preceding patches fix the warnings this would trigger
API Changes
-----------
The following APIs now return ENAMETOOLONG for oversized names:
- rte_lpm_create()
- rte_hash_create()
- rte_fbk_hash_create()
- rte_efd_create()
- rte_eal_tailq_create()
- rte_cfgfile_add_section()
- rte_cfgfile_add_entry()
These are documented in the release notes and header files.
Testing
-------
- Existing unit tests pass
- New test cases added for hash name length validation
- Build tested with format overflow warnings enabled
v13 - fix and cleanup get_hugefile code
optimize using statfs() and no string handling needed. reword commit messages
Stephen Hemminger (17):
lpm: reject names that exceed maximum length
hash: reject names that exceed maximum 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: 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 | 42 ++++++-- lib/cfgfile/rte_cfgfile.h | 6 +- lib/eal/common/eal_common_config.c | 6 +- lib/eal/common/eal_common_memory.c | 3 +- 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 | 138 ++++++++++--------------- 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 | 17 ++- lib/lpm/rte_lpm.h | 1 + lib/meson.build | 4 - lib/telemetry/telemetry_legacy.c | 7 +- lib/vhost/vhost.c | 14 ++- 28 files changed, 377 insertions(+), 200 deletions(-)
Signature · 1 line
2.51.0
PATCH v13 1/17 lpm: reject names that exceed maximum length
Previously, rte_lpm_create() would silently truncate names longer than RTE_LPM_NAMESIZE via snprintf(). This could lead to unexpected behavior such as name collisions or failed lookups when the caller assumes the full name was used.
Add an explicit length check that returns ENAMETOOLONG when the name is too long, allowing the caller to handle the error appropriately.
Also fix the mem_name buffer size to account for the "LPM_" prefix, add a truncation warning for the RCU defer queue name, and improve the defer queue creation error message to include the actual error.
--- doc/guides/rel_notes/release_26_03.rst | 7 +++++++ lib/lpm/rte_lpm.c | 17 +++++++++++++---- lib/lpm/rte_lpm.h | 1 + 3 files changed, 21 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 +13 -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,11 @@ 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 to '%s'" , + rcu_dq_name); + 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 {
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 v13 2/17 hash: reject names that exceed maximum length
In reply to Stephen HemmingerAdd missing length validation to rte_hash_create() and rte_fbk_hash_create() that returns ENAMETOOLONG when the name exceeds RTE_HASH_NAMESIZE or RTE_FBK_HASH_NAMESIZE respectively. Previously these functions would silently truncate long names.
Also add truncation warnings for internally-generated ring names, improve error messages to include the actual error code, and add unit tests for the new validation.
--- 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 =SOCKET_ID_ANY ; + 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 in 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 v13 3/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 v13 4/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 v13 5/17 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 v13 6/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.
--- 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 v13 7/17 eal: use C library to parse filesystem table
In reply to Stephen HemmingerReplace open-coded string parsing of /proc/mounts with the standard getmntent(3) routines available on Linux and BSD.
When hugepage_dir is explicitly specified, use statfs() to validate the mount directly rather than scanning /proc/mounts.
Using the C library handles edge cases like escaped strings in mount paths automatically.
--- lib/eal/linux/eal_hugepage_info.c | 104 +++++++++--------------------- 1 file changed, 29 insertions(+), 75 deletions(-)
lib/eal/linux/eal_hugepage_info.c +29 -75
@@ -13,10 +13,13 @@#include <inttypes.h> #include <unistd.h> #include <errno.h> +#include <mntent.h> #include <sys/mman.h> #include <sys/stat.h> +#include <sys/statfs.h> #include <linux/mman.h> /* for hugetlb-related flags */ +#include <linux/magic.h> /* for HUGETLBFS_MAGIC */ #include <rte_lcore.h> #include <rte_debug.h>
@@ -195,109 +198,60 @@ 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 ];const struct internal_config *internal_conf =eal_get_internal_configuration (); -const size_t hugepage_dir_len = (internal_conf->hugepage_dir !=NULL ) ? -strlen (internal_conf->hugepage_dir) :0 ; -struct stat st; +struct mntent *mnt; +FILE *fp; -/* -* If the specified dir doesn't exist, we can't match it. -*/ -if (internal_conf->hugepage_dir !=NULL && -stat (internal_conf->hugepage_dir, &st) !=0 ) { -return -1 ; +/* Fast path: hugepage_dir explicitly specified */ +if (internal_conf->hugepage_dir !=NULL ) { +struct statfs sfs; + +/* Query info about mounted filesystem */ +if (statfs (internal_conf->hugepage_dir, &sfs) !=0 || + sfs.f_type !=HUGETLBFS_MAGIC || + (uint64_t )sfs.f_bsize != hugepage_sz) +return -1 ; + +strlcpy (hugedir, internal_conf->hugepage_dir, len); +return 0 ; } -FILE *fd =fopen (proc_mounts,"r" ); -if (fd ==NULL ) -rte_panic ("Cannot open %s\n" , proc_mounts); +/* Discover mount point from /proc/mounts */ + fp =setmntent ("/proc/mounts" ,"r" ); +if (fp ==NULL ) +rte_panic ("Cannot open /proc/mounts\n" );if (default_size ==0 ) default_size =get_default_hp_size (); -while (fgets (buf,sizeof (buf), fd)){ +while ((mnt =getmntent (fp)) !=NULL ) {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 */ - } -if (strncmp (splitstr[FSTYPE ], hugetlbfs_str, htlbfs_str_len) !=0 ) +if (strcmp (mnt->mnt_type,"hugetlbfs" ) !=0 )continue ; - pagesz_str =strstr (splitstr[OPTIONS ], pagesize_opt); + pagesz_str =hasmntopt (mnt,"pagesize" ); -/* 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 { + }else {uint64_t pagesz =rte_str_to_size (&pagesz_str[pagesize_opt_len]);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); -break ; - } - - mountpt_len =strlen (splitstr[MOUNTPT ]); - -/* -* 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 || - (hugepage_dir_len > mountpt_len && - internal_conf->hugepage_dir[mountpt_len] !='/' )) { -continue ; - } - -/* -* We found a match, but only prefer it if it's a longer match -* (so /mnt/1 is preferred over /mnt for matching /mnt/1/2)). -*/ -if (mountpt_len >strlen (found)) -strlcpy (found, splitstr[MOUNTPT ], len); - }/* end while fgets */ - -fclose (fd); - -if (found[0 ] !='\0' ) { -/* If needed, return the requested dir, not the mount point. */ -strlcpy (hugedir, internal_conf->hugepage_dir !=NULL ? - internal_conf->hugepage_dir : found, len); +/* Found a match */ +strlcpy (hugedir, mnt->mnt_dir, len); +endmntent (fp);return 0 ; } +endmntent (fp);return -1 ; }
Signature · 1 line
2.51.0
PATCH v13 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 >=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 v13 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 | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-)
lib/eal/common/eal_common_memory.c +2 -1
@@ -1153,8 +1153,9 @@ 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 +/* Address string is "0x" prefix + 16 hex digits + null */ +#define ADDR_STR 20/* Telemetry callback handler to return heap stats for requested heap id. */ static int
Signature · 1 line
2.51.0
PATCH v13 10/17 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 v13 11/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 | 34 +++++++++++++++++++++---------- lib/eal/linux/eal_memalloc.c | 11 ++++++++-- lib/eal/linux/eal_memory.c | 9 ++++++-- 4 files changed, 45 insertions(+), 19 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 +23 -11
@@ -70,11 +70,14 @@ create_shared_memory(const char *filename, const size_t mem_size)static int get_hp_sysfs_value (const char *subdir,const char *file,unsigned long *val) { -char path[PATH_MAX ]; +char *path =NULL ; +int ret; -snprintf (path,sizeof (path),"%s/%s/%s" , - sys_dir_path, subdir, file); -return eal_parse_sysfs_value (path, val); +if (asprintf (&path,"%s/%s/%s" , sys_dir_path, subdir, file) <0 ) +return -1 ; + ret =eal_parse_sysfs_value (path, val); +free (path); +return ret; }/* this function is only called from eal_hugepage_info_init which itself
@@ -135,13 +138,15 @@ get_num_hugepages(const char *subdir, size_t sz, unsigned int reusable_pages)static uint32_t get_num_hugepages_on_node (const char *subdir,unsigned int socket,size_t sz) { -char path[PATH_MAX ], socketpath[PATH_MAX ]; +char *path =NULL , *socketpath =NULL ;DIR *socketdir;unsigned long num_pages =0 ;const char *nr_hp_file ="free_hugepages" ; -snprintf (socketpath,sizeof (socketpath),"%s/node%u/hugepages" , - sys_pages_numa_dir_path, socket); +if (asprintf (&socketpath,"%s/node%u/hugepages" , sys_pages_numa_dir_path, socket) <0 ) { +EAL_LOG (ERR ,"Can not format node huge page path" ); + goto nopages; + } socketdir =opendir (socketpath);if (socketdir) {
@@ -149,13 +154,16 @@ get_num_hugepages_on_node(const char *subdir, unsigned int socket, size_t sz)closedir (socketdir); }else {/* Can't find socket dir, so ignore it */ -return 0 ; + goto nopages; + } + +if (asprintf (&path,"%s/%s/%s" , socketpath, subdir, nr_hp_file) <0 ) { +EAL_LOG (ERR ,"Can not format free hugepages path" ); + goto nopages; } -snprintf (path,sizeof (path),"%s/%s/%s" , - socketpath, subdir, nr_hp_file);if (eal_parse_sysfs_value (path, &num_pages) <0 ) -return 0 ; + goto nopages;if (num_pages ==0 ) EAL_LOG(WARNING, "No free %zu kB hugepages reported on node %u",
@@ -168,6 +176,10 @@ get_num_hugepages_on_node(const char *subdir, unsigned int socket, size_t sz)if (num_pages >UINT32_MAX ) num_pages =UINT32_MAX ; +nopages: +free (path); +free (socketpath); +return num_pages; }
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 v13 12/17 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 v13 13/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
@@ -572,7 +572,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' )
@@ -586,19 +585,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, false) ==-1 ) +if (eal_plugin_add (sopath, false) ==-1 ) { +free (sopath);break ; + } +free (sopath); }closedir (d);
Signature · 1 line
2.51.0
PATCH v13 14/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
@@ -3488,9 +3488,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++; }
@@ -3500,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++; }
@@ -3511,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
PATCH v13 15/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 v13 16/17 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 | 42 ++++++++++++++++++++------ lib/cfgfile/rte_cfgfile.h | 6 +++- 3 files changed, 40 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 +33 -9
100 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 exceeds 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 v13 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
v14 cover lib: improve string overflow safety
In reply to Stephen HemmingerThis series improves defensive programming by adding proper string length validation and overflow checking throughout DPDK libraries. The goal is to eliminate silent truncation of names and paths, provide meaningful error feedback, and enable compiler format overflow warnings.
Motivation
----------
Many DPDK APIs accept name parameters with defined maximum lengths (e.g., RTE_LPM_NAMESIZE, RTE_HASH_NAMESIZE). Previously, names exceeding these limits were silently truncated via snprintf/strlcpy, potentially causing subtle bugs like duplicate names or unexpected behavior. This series addresses these issues systematically.
Changes Overview
----------------
The patches fall into several categories:
1. API input validation (patches 1-2, 6, 12, 16):
- Add explicit length checks for name parameters in lpm, hash, efd, tailq, and cfgfile APIs
- Return ENAMETOOLONG when names exceed limits
- Document new error conditions in API headers
- Add corresponding unit tests
2. Internal buffer overflow detection (patches 3-5, 8-9, 14-15):
- Check snprintf/strlcpy return values for truncation
- Log warnings when internal string operations truncate
- Increase buffer sizes where they were too small
- Use dynamic allocation (asprintf) where appropriate
3. Path handling improvements (patches 7, 10-11, 13):
- Use standard C library routines (getmntent) for parsing /proc/mounts
- Enforce UNIX_PATH_MAX for socket paths to fail early
- Handle arbitrarily long shared library paths
4. Error message improvements (patches 1-2, 6):
- Include rte_strerror() in failure messages
- Provide more context when operations fail
5. Enable compiler warnings (patch 17):
- Remove -Wno-format-truncation flag
- All preceding patches fix the warnings this would trigger
API Changes
-----------
The following APIs now return ENAMETOOLONG for oversized names:
- rte_lpm_create()
- rte_hash_create()
- rte_fbk_hash_create()
- rte_efd_create()
- rte_eal_tailq_create()
- rte_cfgfile_add_section()
- rte_cfgfile_add_entry()
These are documented in the release notes and header files.
Testing
-------
- Existing unit tests pass
- New test cases added for hash name length validation
- Build tested with format overflow warnings enabled
v14 - fix build on 32 bit Ubuntu
- reword commit messages for clarity
v13 - fix and cleanup get_hugefile code
optimize using statfs() and no string handling needed. reword commit messages
Stephen Hemminger (17):
lpm: reject names that exceed maximum length
hash: reject names that exceed maximum 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: 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 | 42 ++++++-- lib/cfgfile/rte_cfgfile.h | 6 +- lib/eal/common/eal_common_config.c | 6 +- lib/eal/common/eal_common_memory.c | 3 +- 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 | 138 ++++++++++--------------- 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 | 17 ++- lib/lpm/rte_lpm.h | 1 + lib/meson.build | 4 - lib/telemetry/telemetry_legacy.c | 7 +- lib/vhost/vhost.c | 14 ++- 28 files changed, 377 insertions(+), 200 deletions(-)
Signature · 1 line
2.51.0
PATCH v14 1/17 lpm: reject names that exceed maximum length
Previously, rte_lpm_create() would silently truncate names longer than RTE_LPM_NAMESIZE via snprintf(). This could lead to unexpected behavior such as name collisions or failed lookups when the caller assumes the full name was used.
Add an explicit length check that returns ENAMETOOLONG when the name is too long, allowing the caller to handle the error appropriately.
Also fix the mem_name buffer size to account for the "LPM_" prefix, add a truncation warning for the RCU defer queue name, and improve the defer queue creation error message to include the actual error.
--- doc/guides/rel_notes/release_26_03.rst | 7 +++++++ lib/lpm/rte_lpm.c | 17 +++++++++++++---- lib/lpm/rte_lpm.h | 1 + 3 files changed, 21 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 +13 -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,11 @@ 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 to '%s'" , + rcu_dq_name); + 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 {
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 v14 2/17 hash: reject names that exceed maximum length
In reply to Stephen HemmingerAdd missing length validation to rte_hash_create() and rte_fbk_hash_create() that returns ENAMETOOLONG when the name exceeds RTE_HASH_NAMESIZE or RTE_FBK_HASH_NAMESIZE respectively. Previously these functions would silently truncate long names.
Also add truncation warnings for internally-generated ring names, improve error messages to include the actual error code, and add unit tests for the new validation.
--- 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 =SOCKET_ID_ANY ; + 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 in 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 v14 3/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
Re: [PATCH v14 03/17] graph: avoid overflowing comment buffer
Quoted 17 lines · Stephen Hemminger
The 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, ifasprintf()fails it is better to still log the packet without comment so no data is lost.Signed-off-by Stephen Hemminger <[email protected]>--- lib/graph/graph_pcap.c | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-)lib/graph/graph_pcap.c +0
-0
lib/graph/graph_pcap.c graph_pcap_dispatch(struct rte_graph *graph, · line 197
Quoted 4 lines
lib/graph/graph_pcap.c +0
-1@@ -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 ];
GRAPH_PCAP_BUF_SZ definition can be dropped, as it is not used anymore. I will fix while applying.
Signature · 1 line
David Marchand
PATCH v14 4/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 v14 5/17 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 v14 6/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.
--- 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 v14 7/17 eal: use C library to parse filesystem table
In reply to Stephen HemmingerReplace open-coded string parsing of /proc/mounts with the standard getmntent(3) routines available on Linux and BSD.
When hugepage_dir is explicitly specified, use statfs() to validate the mount directly rather than scanning /proc/mounts.
Using the C library handles edge cases like escaped strings in mount paths automatically.
--- lib/eal/linux/eal_hugepage_info.c | 104 +++++++++--------------------- 1 file changed, 29 insertions(+), 75 deletions(-)
lib/eal/linux/eal_hugepage_info.c +29 -75
@@ -13,10 +13,13 @@#include <inttypes.h> #include <unistd.h> #include <errno.h> +#include <mntent.h> #include <sys/mman.h> #include <sys/stat.h> +#include <sys/statfs.h> #include <linux/mman.h> /* for hugetlb-related flags */ +#include <linux/magic.h> /* for HUGETLBFS_MAGIC */ #include <rte_lcore.h> #include <rte_debug.h>
@@ -195,109 +198,60 @@ 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 ];const struct internal_config *internal_conf =eal_get_internal_configuration (); -const size_t hugepage_dir_len = (internal_conf->hugepage_dir !=NULL ) ? -strlen (internal_conf->hugepage_dir) :0 ; -struct stat st; +struct mntent *mnt; +FILE *fp; -/* -* If the specified dir doesn't exist, we can't match it. -*/ -if (internal_conf->hugepage_dir !=NULL && -stat (internal_conf->hugepage_dir, &st) !=0 ) { -return -1 ; +/* Fast path: hugepage_dir explicitly specified */ +if (internal_conf->hugepage_dir !=NULL ) { +struct statfs sfs; + +/* Query info about mounted filesystem */ +if (statfs (internal_conf->hugepage_dir, &sfs) !=0 || + (uint32_t )sfs.f_type !=HUGETLBFS_MAGIC || + (uint64_t )sfs.f_bsize != hugepage_sz) +return -1 ; + +strlcpy (hugedir, internal_conf->hugepage_dir, len); +return 0 ; } -FILE *fd =fopen (proc_mounts,"r" ); -if (fd ==NULL ) -rte_panic ("Cannot open %s\n" , proc_mounts); +/* Discover mount point from /proc/mounts */ + fp =setmntent ("/proc/mounts" ,"r" ); +if (fp ==NULL ) +rte_panic ("Cannot open /proc/mounts\n" );if (default_size ==0 ) default_size =get_default_hp_size (); -while (fgets (buf,sizeof (buf), fd)){ +while ((mnt =getmntent (fp)) !=NULL ) {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 */ - } -if (strncmp (splitstr[FSTYPE ], hugetlbfs_str, htlbfs_str_len) !=0 ) +if (strcmp (mnt->mnt_type,"hugetlbfs" ) !=0 )continue ; - pagesz_str =strstr (splitstr[OPTIONS ], pagesize_opt); + pagesz_str =hasmntopt (mnt,"pagesize" ); -/* 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 { + }else {uint64_t pagesz =rte_str_to_size (&pagesz_str[pagesize_opt_len]);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); -break ; - } - - mountpt_len =strlen (splitstr[MOUNTPT ]); - -/* -* 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 || - (hugepage_dir_len > mountpt_len && - internal_conf->hugepage_dir[mountpt_len] !='/' )) { -continue ; - } - -/* -* We found a match, but only prefer it if it's a longer match -* (so /mnt/1 is preferred over /mnt for matching /mnt/1/2)). -*/ -if (mountpt_len >strlen (found)) -strlcpy (found, splitstr[MOUNTPT ], len); - }/* end while fgets */ - -fclose (fd); - -if (found[0 ] !='\0' ) { -/* If needed, return the requested dir, not the mount point. */ -strlcpy (hugedir, internal_conf->hugepage_dir !=NULL ? - internal_conf->hugepage_dir : found, len); +/* Found a match */ +strlcpy (hugedir, mnt->mnt_dir, len); +endmntent (fp);return 0 ; } +endmntent (fp);return -1 ; }
Signature · 1 line
2.51.0
PATCH v14 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 >=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 v14 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 | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-)
lib/eal/common/eal_common_memory.c +2 -1
@@ -1153,8 +1153,9 @@ 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 +/* Address string is "0x" prefix + 16 hex digits + null */ +#define ADDR_STR 20/* Telemetry callback handler to return heap stats for requested heap id. */ static int
Signature · 1 line
2.51.0
PATCH v14 10/17 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 v14 11/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 | 34 +++++++++++++++++++++---------- lib/eal/linux/eal_memalloc.c | 11 ++++++++-- lib/eal/linux/eal_memory.c | 9 ++++++-- 4 files changed, 45 insertions(+), 19 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 +23 -11
@@ -70,11 +70,14 @@ create_shared_memory(const char *filename, const size_t mem_size)static int get_hp_sysfs_value (const char *subdir,const char *file,unsigned long *val) { -char path[PATH_MAX ]; +char *path =NULL ; +int ret; -snprintf (path,sizeof (path),"%s/%s/%s" , - sys_dir_path, subdir, file); -return eal_parse_sysfs_value (path, val); +if (asprintf (&path,"%s/%s/%s" , sys_dir_path, subdir, file) <0 ) +return -1 ; + ret =eal_parse_sysfs_value (path, val); +free (path); +return ret; }/* this function is only called from eal_hugepage_info_init which itself
@@ -135,13 +138,15 @@ get_num_hugepages(const char *subdir, size_t sz, unsigned int reusable_pages)static uint32_t get_num_hugepages_on_node (const char *subdir,unsigned int socket,size_t sz) { -char path[PATH_MAX ], socketpath[PATH_MAX ]; +char *path =NULL , *socketpath =NULL ;DIR *socketdir;unsigned long num_pages =0 ;const char *nr_hp_file ="free_hugepages" ; -snprintf (socketpath,sizeof (socketpath),"%s/node%u/hugepages" , - sys_pages_numa_dir_path, socket); +if (asprintf (&socketpath,"%s/node%u/hugepages" , sys_pages_numa_dir_path, socket) <0 ) { +EAL_LOG (ERR ,"Can not format node huge page path" ); + goto nopages; + } socketdir =opendir (socketpath);if (socketdir) {
@@ -149,13 +154,16 @@ get_num_hugepages_on_node(const char *subdir, unsigned int socket, size_t sz)closedir (socketdir); }else {/* Can't find socket dir, so ignore it */ -return 0 ; + goto nopages; + } + +if (asprintf (&path,"%s/%s/%s" , socketpath, subdir, nr_hp_file) <0 ) { +EAL_LOG (ERR ,"Can not format free hugepages path" ); + goto nopages; } -snprintf (path,sizeof (path),"%s/%s/%s" , - socketpath, subdir, nr_hp_file);if (eal_parse_sysfs_value (path, &num_pages) <0 ) -return 0 ; + goto nopages;if (num_pages ==0 ) EAL_LOG(WARNING, "No free %zu kB hugepages reported on node %u",
@@ -168,6 +176,10 @@ get_num_hugepages_on_node(const char *subdir, unsigned int socket, size_t sz)if (num_pages >UINT32_MAX ) num_pages =UINT32_MAX ; +nopages: +free (path); +free (socketpath); +return num_pages; }
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 v14 12/17 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 v14 13/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
@@ -572,7 +572,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' )
@@ -586,19 +585,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, false) ==-1 ) +if (eal_plugin_add (sopath, false) ==-1 ) { +free (sopath);break ; + } +free (sopath); }closedir (d);
Signature · 1 line
2.51.0
PATCH v14 14/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
@@ -3488,9 +3488,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++; }
@@ -3500,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++; }
@@ -3511,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
PATCH v14 15/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 v14 16/17 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 | 42 ++++++++++++++++++++------ lib/cfgfile/rte_cfgfile.h | 6 +++- 3 files changed, 40 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 +33 -9
100 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 exceeds 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 v14 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 v14 00/17] lib: improve string overflow safety
In reply to Stephen HemmingerHello,
Quoted 112 lines · Stephen Hemminger
This series improves defensive programming by adding proper string length validation and overflow checking throughout DPDK libraries. The goal is to eliminate silent truncation of names and paths, provide meaningful error feedback, and enable compiler format overflow warnings.
Motivation
----------
Many DPDK APIs accept name parameters with defined maximum lengths (e.g.,RTE_LPM_NAMESIZE,RTE_HASH_NAMESIZE). Previously, names exceeding these limits were silently truncated via snprintf/strlcpy, potentially causing subtle bugs like duplicate names or unexpected behavior. This series addresses these issues systematically.Changes Overview
----------------
The patches fall into several categories:1. API input validation (patches 1-2, 6, 12, 16):
- Add explicit length checks for name parameters in lpm, hash, efd, tailq, and cfgfile APIs
- Return ENAMETOOLONG when names exceed limits
- Document new error conditions in API headers
- Add corresponding unit tests2. Internal buffer overflow detection (patches 3-5, 8-9, 14-15):
- Check snprintf/strlcpy return values for truncation
- Log warnings when internal string operations truncate
- Increase buffer sizes where they were too small
- Use dynamic allocation (asprintf) where appropriate3. Path handling improvements (patches 7, 10-11, 13):
- Use standard C library routines (getmntent) for parsing/proc/mounts
- EnforceUNIX_PATH_MAXfor socket paths to fail early
- Handle arbitrarily long shared library paths4. Error message improvements (patches 1-2, 6):
- Includerte_strerror()in failure messages
- Provide more context when operations fail5. Enable compiler warnings (patch 17):
- Remove -Wno-format-truncation flag
- All preceding patches fix the warnings this would triggerAPI Changes
-----------
The following APIs now return ENAMETOOLONG for oversized names:
-rte_lpm_create()
-rte_hash_create()
-rte_fbk_hash_create()
-rte_efd_create()
-rte_eal_tailq_create()
-rte_cfgfile_add_section()
-rte_cfgfile_add_entry()These are documented in the release notes and header files.
Testing
-------
- Existing unit tests pass
- New test cases added for hash name length validation
- Build tested with format overflow warnings enabledv14 - fix build on 32 bit Ubuntu
- reword commit messages for clarityv13 - fix and cleanup
get_hugefilecode
optimize usingstatfs()and no string handling needed. reword commit messagesStephen Hemminger (17):
lpm: reject names that exceed maximum length
hash: reject names that exceed maximum 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: 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 warningsapp/test/test_hash.c | 21 ++++ doc/guides/rel_notes/release_26_03.rst | 13 +++ lib/cfgfile/rte_cfgfile.c | 42 ++++++-- lib/cfgfile/rte_cfgfile.h | 6 +- lib/eal/common/eal_common_config.c | 6 +- lib/eal/common/eal_common_memory.c | 3 +- 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 | 138 ++++++++++--------------- 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 ++-
Quoted 8 lines
lib/hash/rte_fbk_hash.h | 1 + lib/latencystats/rte_latencystats.c | 9 +- lib/lpm/rte_lpm.c | 17 ++- lib/lpm/rte_lpm.h | 1 + lib/meson.build | 4 - lib/telemetry/telemetry_legacy.c | 7 +- lib/vhost/vhost.c | 14 ++- 28 files changed, 377 insertions(+), 200 deletions(-)
Series applied, thanks.
Signature · 1 line
David Marchand