[dpdk-stable] [PATCH] kvargs: fix processing a null list

[dpdk-stable] [PATCH] kvargs: fix processing a null list

[Thomas Monjalon]

In the doxygen description of rte_kvargs_process(), it is said:
	If *kvlist* is NULL function does nothing.
It has been added by mistake here instead of rte_kvargs_free().
Anyway, null list should be correctly handled in both functions.

Comments are fixed in both functions and NULL handling is added
to rte_kvargs_process().

Fixes: c34af7424e09 ("kvargs: fix freeing behaviour for null")
Cc: stable@dpdk.org

Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
---
 lib/librte_kvargs/rte_kvargs.c | 3 +++
 lib/librte_kvargs/rte_kvargs.h | 7 +++----
 2 files changed, 6 insertions(+), 4 deletions(-)

diff --git a/lib/librte_kvargs/rte_kvargs.c b/lib/librte_kvargs/rte_kvargs.c
index 427bfd5e5..f371bc5a0 100644
--- a/lib/librte_kvargs/rte_kvargs.c
+++ b/lib/librte_kvargs/rte_kvargs.c
@@ -138,6 +138,9 @@ rte_kvargs_process(const struct rte_kvargs *kvlist,
 	bool match = false;
 	unsigned i;
 
+	if (kvlist == NULL)
+		return 0;
+
 	for (i = 0; i < kvlist->count; i++) {
 		pair = &kvlist->pairs[i];
 		if (key_match == NULL || strcmp(pair->key, key_match) == 0) {
diff --git a/lib/librte_kvargs/rte_kvargs.h b/lib/librte_kvargs/rte_kvargs.h
index c7378b4e9..c7a97a8eb 100644
--- a/lib/librte_kvargs/rte_kvargs.h
+++ b/lib/librte_kvargs/rte_kvargs.h
@@ -110,7 +110,7 @@ struct rte_kvargs *rte_kvargs_parse_delim(const char *args,
  * rte_kvargs_parse().
  *
  * @param kvlist
- *   The rte_kvargs structure
+ *   The rte_kvargs structure. No error if NULL.
  */
 void rte_kvargs_free(struct rte_kvargs *kvlist);
 
@@ -119,11 +119,10 @@ void rte_kvargs_free(struct rte_kvargs *kvlist);
  *
  * For each key/value association that matches the given key, calls the
  * handler function with the for a given arg_name passing the value on the
- * dictionary for that key and a given extra argument. If *kvlist* is NULL
- * function does nothing.
+ * dictionary for that key and a given extra argument.
  *
  * @param kvlist
- *   The rte_kvargs structure
+ *   The rte_kvargs structure. No error if NULL.
  * @param key_match
  *   The key on which the handler should be called, or NULL to process handler
  *   on all associations
-- 
2.19.0

Re: [dpdk-stable] [PATCH] kvargs: fix processing a null list

[Olivier Matz]

On Tue, Oct 23, 2018 at 06:24:54PM +0200, Thomas Monjalon wrote:
> In the doxygen description of rte_kvargs_process(), it is said:
> 	If *kvlist* is NULL function does nothing.
> It has been added by mistake here instead of rte_kvargs_free().
> Anyway, null list should be correctly handled in both functions.
> 
> Comments are fixed in both functions and NULL handling is added
> to rte_kvargs_process().
> 
> Fixes: c34af7424e09 ("kvargs: fix freeing behaviour for null")
> Cc: stable@dpdk.org
> 
> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>

Acked-by: Olivier Matz <olivier.matz@6wind.com>

> @@ -119,11 +119,10 @@ void rte_kvargs_free(struct rte_kvargs *kvlist);
>   *
>   * For each key/value association that matches the given key, calls the
>   * handler function with the for a given arg_name passing the value on the
> - * dictionary for that key and a given extra argument. If *kvlist* is NULL
> - * function does nothing.
> + * dictionary for that key and a given extra argument.

It looks the rest of the api documentation is perfectible :)
I'll send a fix in another patch.

Thanks,
Olivier

Re: [dpdk-stable] [PATCH] kvargs: fix processing a null list

[Thomas Monjalon]

24/10/2018 11:34, Olivier Matz:
> On Tue, Oct 23, 2018 at 06:24:54PM +0200, Thomas Monjalon wrote:
> > In the doxygen description of rte_kvargs_process(), it is said:
> > 	If *kvlist* is NULL function does nothing.
> > It has been added by mistake here instead of rte_kvargs_free().
> > Anyway, null list should be correctly handled in both functions.
> > 
> > Comments are fixed in both functions and NULL handling is added
> > to rte_kvargs_process().
> > 
> > Fixes: c34af7424e09 ("kvargs: fix freeing behaviour for null")
> > Cc: stable@dpdk.org
> > 
> > Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
> 
> Acked-by: Olivier Matz <olivier.matz@6wind.com>

Applied

> > @@ -119,11 +119,10 @@ void rte_kvargs_free(struct rte_kvargs *kvlist);
> >   *
> >   * For each key/value association that matches the given key, calls the
> >   * handler function with the for a given arg_name passing the value on the
> > - * dictionary for that key and a given extra argument. If *kvlist* is NULL
> > - * function does nothing.
> > + * dictionary for that key and a given extra argument.
> 
> It looks the rest of the api documentation is perfectible :)
> I'll send a fix in another patch.

Yes please :)