[v2] hash: separate param checks in hash create func
Checks
Commit Message
Separated name, entries and key_len parameter checks in
rte_hash_create(). Also made the error messages more
informative/verbose to help with debugging. Also added myself to the
mailing list.
Signed-off-by: Niall Meade <niall.meade@intel.com>
---
v2:
* change hash log messages to be one line
I had name set to NULL in the parameters I was passing to
rte_hash_create() and the error message I got didn't specify which
parameter was invalid.
---
.mailmap | 1 +
lib/hash/rte_cuckoo_hash.c | 21 +++++++++++++++++----
2 files changed, 18 insertions(+), 4 deletions(-)
Comments
On Thu, 10 Oct 2024 16:46:02 +0000
Niall Meade <niall.meade@intel.com> wrote:
> --------------------------------------------------------------
> Intel Research and Development Ireland Limited
> Registered in Ireland
> Registered Office: Collinstown Industrial Park, Leixlip, County Kildare
> Registered Number: 308263
>
>
> This e-mail and any attachments may contain confidential material for the sole
> use of the intended recipient(s). Any review or distribution by others is
> strictly prohibited. If you are not the intended recipient, please contact the
> sender and delete all copies.
Fix your lawyer footer. Technically any patches sent to public mailing lists
would have to be legally dropped.
On Thu, 10 Oct 2024 16:46:02 +0000
Niall Meade <niall.meade@intel.com> wrote:
> diff --git a/lib/hash/rte_cuckoo_hash.c b/lib/hash/rte_cuckoo_hash.c
> index 577b5839d3..2569f7d977 100644
> --- a/lib/hash/rte_cuckoo_hash.c
> +++ b/lib/hash/rte_cuckoo_hash.c
> @@ -190,11 +190,17 @@ rte_hash_create(const struct rte_hash_parameters *params)
>
> /* Check for valid parameters */
> if ((params->entries > RTE_HASH_ENTRIES_MAX) ||
> - (params->entries < RTE_HASH_BUCKET_ENTRIES) ||
> - (params->name == NULL) ||
> - (params->key_len == 0)) {
> + (params->entries < RTE_HASH_BUCKET_ENTRIES)) {
> rte_errno = EINVAL;
> - HASH_LOG(ERR, "%s has invalid parameters", __func__);
> + HASH_LOG(ERR, "%s() entries (%u) must be in range [%d, %d] inclusive",
> + __func__, params->entries, RTE_HASH_BUCKET_ENTRIES,
> + RTE_HASH_ENTRIES_MAX);
Need to indent function args here.
> + return NULL;
> + }
Noticed this function is inconstitent about setting rte_errno.
Not sure if it matters.
@@ -1055,6 +1055,7 @@ Nelson Escobar <neescoba@cisco.com>
Nemanja Marjanovic <nemanja.marjanovic@intel.com>
Netanel Belgazal <netanel@amazon.com>
Netanel Gonen <netanelg@mellanox.com>
+Niall Meade <niall.meade@intel.com>
Niall Power <niall.power@intel.com>
Nicholas Pratte <npratte@iol.unh.edu>
Nick Connolly <nick.connolly@arm.com> <nick.connolly@mayadata.io>
@@ -190,11 +190,17 @@ rte_hash_create(const struct rte_hash_parameters *params)
/* Check for valid parameters */
if ((params->entries > RTE_HASH_ENTRIES_MAX) ||
- (params->entries < RTE_HASH_BUCKET_ENTRIES) ||
- (params->name == NULL) ||
- (params->key_len == 0)) {
+ (params->entries < RTE_HASH_BUCKET_ENTRIES)) {
rte_errno = EINVAL;
- HASH_LOG(ERR, "%s has invalid parameters", __func__);
+ HASH_LOG(ERR, "%s() entries (%u) must be in range [%d, %d] inclusive",
+ __func__, params->entries, RTE_HASH_BUCKET_ENTRIES,
+ RTE_HASH_ENTRIES_MAX);
+ return NULL;
+ }
+
+ if (params->key_len == 0) {
+ rte_errno = EINVAL;
+ HASH_LOG(ERR, "%s() key_len must be greater than 0", __func__);
return NULL;
}
@@ -204,6 +210,13 @@ rte_hash_create(const struct rte_hash_parameters *params)
return NULL;
}
+ if (params->name == NULL) {
+ rte_errno = EINVAL;
+ HASH_LOG(ERR, "%s() has invalid parameters, name can't be NULL",
+ __func__);
+ 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)) {