From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 6875348C54; Sun, 7 Dec 2025 20:13:09 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id F17AA40395; Sun, 7 Dec 2025 20:12:55 +0100 (CET) Received: from mail-wm1-f53.google.com (mail-wm1-f53.google.com [209.85.128.53]) by mails.dpdk.org (Postfix) with ESMTP id 3DAED402F1 for ; Sun, 7 Dec 2025 20:12:54 +0100 (CET) Received: by mail-wm1-f53.google.com with SMTP id 5b1f17b1804b1-477a2ab455fso45603625e9.3 for ; Sun, 07 Dec 2025 11:12:54 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=networkplumber-org.20230601.gappssmtp.com; s=20230601; t=1765134774; x=1765739574; darn=dpdk.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=KZCZMnKmF3ShuSgPSmAFReArVnsNF4s9WZLWRjySBSM=; b=vFLH1T8PPxtqq+PL97HxMjK87zvaHlbmyMy0RkJVEqaFJZiIVLbTh4uea5aFvyZpms AF5VK4d+GQTboxLm5i6NAMsi3gBV3yunGFfWAwlmi5r1fdghlRD/x9zAwSHzs9EOiLhP YpDjWNlKuG3+iKxNBzG8yZBWr2RE+OSBsehPn80grmBXwFmI/AhQgf/Z+KyQAt953Dqa tqR0aWDnwicDm8NEjcLtxQeSUBhH29Lo7/D2J9isD/ybkkF9A34i4EPqpdVFS8qGfcBN sa/uZ7uRRSMwMN+pAfR3WCMFCMercRp41Rv0l1iRvy3TFBxOXGoQs4zN4PvOnpiB3Mue Jk9w== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1765134774; x=1765739574; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-gg:x-gm-message-state:from :to:cc:subject:date:message-id:reply-to; bh=KZCZMnKmF3ShuSgPSmAFReArVnsNF4s9WZLWRjySBSM=; b=Y81Gz17ZsiIKl19GeILsXYztqwh5Ef4R+3v2AGmdEghcVAdczrnTjYHk/aq5VKeL1p 6UhtH3hSI0PBkRO3+ygQuGjlIrMeVW669zV5okUJN4W4emt8kjBTbdcMDlvbjyEsIfbC LN1kba/ufzbF7DMIej/AsSx5x7J8bH4y3mes9Pukw41SqAtVR76AfBgF8QAH7WgJcbbR MVzCU1vJHa9SarKcVHvW5kRDx1lMbpibDt6uyuF5ZrLwTokyzcIpYU9cXl4H2bC4fWCz 24dSX6v6IDQsPXX0RArGT/TRsMc4CDfLLgUxHiI+bcSu+zQKJtxVVyEdTMyKVBDXe37o XlJA== X-Gm-Message-State: AOJu0YxnbP/xKJv+HTUXUPv68Nk7eASa+2HZT5hN+VMTNUVCTZLTT6Fe pBHT24bf0zQZYSjAryIT5TI/xta8gHHYUeK1TYXmrt4Uc48DLDsJsZhCBmAM/bFXKpnSRmTi4XP DlX9T X-Gm-Gg: ASbGncsdl/v6JebiQCQQ2NgP8EKzBDNVflijQ5htHGYRIQpxwI+3251h2tV+JY0+tCS GrM4boRENYMteDX0fcJHHO4Apo7Vw/eLjo+do9pgwN8k5YgMUZxo6jnY8THc17GHSzZuHY/h3Fj mxIEIC5LilXOpi04UGbKUpFSKFBXm6loIqaFX8uunyGFi8jhV1EWY5Oty8eqxt9DfYR+5Z1GSSX O2rutgD1vlne/O6fD5rp19avrIT+sRWTVPvQjTo+3pQqK3+tybBWbtdYXgwm2wtyNdC9QTJfE2k tfWujreplKkVHBfEPbopYTwQRJq3we5tubfFFh3aZj4sE+6CgoFrJ+QSWxL0z6JSC5z29wqMBSc IDw+W2tLooaqrbPBP4/Qxox4dEM2i1F5h0ymNkdOu+Qo9LH1oUtMW6Z/qpJat7bIPqXA5B5O5kN 0B1c+NQj8fPH3naAQ4GLZqDVxXnCkmFBGdvC/DlOoEn5AT885j5C+FLeobgkyz X-Google-Smtp-Source: AGHT+IFYZF4CmFA409OjQrdw316eyjrMyXaWIKoq+/VF7UYwfbZrHimpTRm/q9t6b0BXYIccwcxN/w== X-Received: by 2002:a05:600c:528a:b0:471:14f5:126f with SMTP id 5b1f17b1804b1-47939e49135mr59999995e9.33.1765134773807; Sun, 07 Dec 2025 11:12:53 -0800 (PST) Received: from phoenix.lan (204-195-96-226.wavecable.com. [204.195.96.226]) by smtp.gmail.com with ESMTPSA id 5b1f17b1804b1-479310b8e70sm205124205e9.5.2025.12.07.11.12.51 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 07 Dec 2025 11:12:53 -0800 (PST) From: Stephen Hemminger To: dev@dpdk.org Cc: Stephen Hemminger , Yipeng Wang , Sameh Gobriel , Bruce Richardson , Vladimir Medvedkin Subject: [PATCH v5 03/17] hash: add checks for hash name length Date: Sun, 7 Dec 2025 11:11:54 -0800 Message-ID: <20251207191242.165619-4-stephen@networkplumber.org> X-Mailer: git-send-email 2.51.0 In-Reply-To: <20251207191242.165619-1-stephen@networkplumber.org> References: <20251205022948.327743-1-stephen@networkplumber.org> <20251207191242.165619-1-stephen@networkplumber.org> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Add 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. Signed-off-by: Stephen Hemminger --- app/test/test_hash.c | 21 +++++++++++++ doc/guides/rel_notes/release_26_03.rst | 3 ++ lib/hash/rte_cuckoo_hash.c | 41 ++++++++++++++++++-------- lib/hash/rte_fbk_hash.c | 14 +++++++-- 4 files changed, 65 insertions(+), 14 deletions(-) diff --git a/app/test/test_hash.c b/app/test/test_hash.c index 5791fd7f4c..0b608a3d74 100644 --- a/app/test/test_hash.c +++ b/app/test/test_hash.c @@ -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"; diff --git a/doc/guides/rel_notes/release_26_03.rst b/doc/guides/rel_notes/release_26_03.rst index 15dabee7a1..a12bd41e86 100644 --- a/doc/guides/rel_notes/release_26_03.rst +++ b/doc/guides/rel_notes/release_26_03.rst @@ -84,6 +84,9 @@ API Changes Also, make sure to start the actual text at the margin. ======================================================= +* hash: Added name length validation to hash creation. + The hash name in hash parameters is now checked against RTE_HASH_NAMESIZE. + ABI Changes ----------- diff --git a/lib/hash/rte_cuckoo_hash.c b/lib/hash/rte_cuckoo_hash.c index 2c92c51624..f9c4a0e302 100644 --- a/lib/hash/rte_cuckoo_hash.c +++ b/lib/hash/rte_cuckoo_hash.c @@ -170,7 +170,6 @@ rte_hash_create(const struct rte_hash_parameters *params) void *buckets = NULL; void *buckets_ext = NULL; char ring_name[RTE_RING_NAMESIZE]; - char ext_ring_name[RTE_RING_NAMESIZE]; unsigned num_key_slots; unsigned int hw_trans_mem_support = 0, use_local_cache = 0; unsigned int ext_table_support = 0; @@ -222,6 +221,13 @@ rte_hash_create(const struct rte_hash_parameters *params) return NULL; } + if (strlen(params->name) >= RTE_HASH_NAMESIZE) { + rte_errno = ENAMETOOLONG; + HASH_LOG(ERR, "%s() name '%s' exceeds maximum length %d", + __func__, params->name, RTE_HASH_NAMESIZE); + return NULL; + } + /* Validate correct usage of extra options */ if ((params->extra_flag & RTE_HASH_EXTRA_FLAGS_RW_CONCURRENCY) && (params->extra_flag & RTE_HASH_EXTRA_FLAGS_RW_CONCURRENCY_LF)) { @@ -272,12 +278,16 @@ rte_hash_create(const struct rte_hash_parameters *params) else num_key_slots = params->entries + 1; - snprintf(ring_name, sizeof(ring_name), "HT_%s", params->name); + /* Ring name may get truncated, conflict detected on ring creation */ + if (snprintf(ring_name, sizeof(ring_name), "HT_%s", params->name) + >= (int)sizeof(ring_name)) + HASH_LOG(NOTICE, "ring name truncated to '%s'", ring_name); + /* Create ring (Dummy slot index is not enqueued) */ r = rte_ring_create_elem(ring_name, sizeof(uint32_t), rte_align32pow2(num_key_slots), params->socket_id, 0); if (r == NULL) { - HASH_LOG(ERR, "memory allocation failed"); + HASH_LOG(ERR, "ring creation failed: %s", rte_strerror(rte_errno)); goto err; } @@ -286,20 +296,25 @@ rte_hash_create(const struct rte_hash_parameters *params) /* Create ring for extendable buckets. */ if (ext_table_support) { - snprintf(ext_ring_name, sizeof(ext_ring_name), "HT_EXT_%s", - params->name); + char ext_ring_name[RTE_RING_NAMESIZE]; + + if (snprintf(ext_ring_name, sizeof(ext_ring_name), + "HT_EXT_%s", params->name) >= (int)sizeof(ext_ring_name)) + HASH_LOG(NOTICE, "external ring name truncated to '%s'", ext_ring_name); + r_ext = rte_ring_create_elem(ext_ring_name, sizeof(uint32_t), rte_align32pow2(num_buckets + 1), params->socket_id, 0); - if (r_ext == NULL) { - HASH_LOG(ERR, "ext buckets memory allocation " - "failed"); + HASH_LOG(ERR, "ext buckets ring create failed: %s", + rte_strerror(rte_errno)); goto err; } } - snprintf(hash_name, sizeof(hash_name), "HT_%s", params->name); + if (snprintf(hash_name, sizeof(hash_name), "HT_%s", params->name) + >= (int)sizeof(hash_name)) + HASH_LOG(NOTICE, "%s() hash name truncated to '%s'", __func__, hash_name); rte_mcfg_tailq_write_lock(); @@ -1606,8 +1621,9 @@ rte_hash_rcu_qsbr_add(struct rte_hash *h, struct rte_hash_rcu_config *cfg) /* No other things to do. */ } else if (cfg->mode == RTE_HASH_QSBR_MODE_DQ) { /* Init QSBR defer queue. */ - snprintf(rcu_dq_name, sizeof(rcu_dq_name), - "HASH_RCU_%s", h->name); + if (snprintf(rcu_dq_name, sizeof(rcu_dq_name), + "HASH_RCU_%s", h->name) >= (int)sizeof(rcu_dq_name)) + HASH_LOG(NOTICE, "HASH defer queue name truncated to: %s", rcu_dq_name); params.name = rcu_dq_name; params.size = cfg->dq_size; if (params.size == 0) @@ -1623,7 +1639,8 @@ rte_hash_rcu_qsbr_add(struct rte_hash *h, struct rte_hash_rcu_config *cfg) h->dq = rte_rcu_qsbr_dq_create(¶ms); if (h->dq == NULL) { rte_free(hash_rcu_cfg); - HASH_LOG(ERR, "HASH defer queue creation failed"); + HASH_LOG(ERR, "HASH defer queue creation failed: %s", + rte_strerror(rte_errno)); return 1; } } else { diff --git a/lib/hash/rte_fbk_hash.c b/lib/hash/rte_fbk_hash.c index 38b15a14d1..2304db7551 100644 --- a/lib/hash/rte_fbk_hash.c +++ b/lib/hash/rte_fbk_hash.c @@ -5,6 +5,7 @@ #include #include #include +#include #include #include @@ -83,7 +84,7 @@ rte_fbk_hash_create(const struct rte_fbk_hash_params *params) { struct rte_fbk_hash_table *ht = NULL; struct rte_tailq_entry *te; - char hash_name[RTE_FBK_HASH_NAMESIZE]; + char *hash_name = NULL; const uint32_t mem_size = sizeof(*ht) + (sizeof(ht->t[0]) * params->entries); uint32_t i; @@ -96,6 +97,7 @@ rte_fbk_hash_create(const struct rte_fbk_hash_params *params) /* Error checking of parameters. */ if ((!rte_is_power_of_2(params->entries)) || (!rte_is_power_of_2(params->entries_per_bucket)) || + (params->name == NULL) || (params->entries == 0) || (params->entries_per_bucket == 0) || (params->entries_per_bucket > params->entries) || @@ -105,7 +107,14 @@ rte_fbk_hash_create(const struct rte_fbk_hash_params *params) return NULL; } - snprintf(hash_name, sizeof(hash_name), "FBK_%s", params->name); + if (strlen(params->name) >= RTE_FBK_HASH_NAMESIZE) { + rte_errno = ENAMETOOLONG; + return NULL; + } + + /* don't care if hash_name is NULL */ + int unused __rte_unused; + unused = asprintf(&hash_name, "FBK_%s", params->name); rte_mcfg_tailq_write_lock(); @@ -170,6 +179,7 @@ rte_fbk_hash_create(const struct rte_fbk_hash_params *params) exit: rte_mcfg_tailq_write_unlock(); + free(hash_name); return ht; } -- 2.51.0