Skip to contentSkip to conversation

kvargs: trim spaces at the beginning and end of key and values

PATCH In review Mesut Ali Ergin 3 participants 5 messages May 16, 2019 – Jul 1, 2019

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 kvargs: trim spaces at the beginning and end of key and values

When arguments delimited with RTE_KVARGS_PAIRS_DELIM happen to have spaces before and after the delimiter, the rte_kvargs_process() can not match them to the intended key. For example, the first argument below triggers the support-multi-driver handler as expected, but the second one silently fails to do so.

-w '84:00.0,support-multi-driver=1'
-w '84:00.0, support-multi-driver=1'

---
 lib/librte_kvargs/rte_kvargs.c | 32 ++++++++++++++++++++++++++++++--
 1 file changed, 30 insertions(+), 2 deletions(-)
lib/librte_kvargs/rte_kvargs.c +30 -2
index f7030c6..1f45bc6 100644
@@ -10,6 +10,32 @@
 
 #include "rte_kvargs.h"
 
+
+/* trim leading and trailing spaces */
+static char *
+trim_space(char *str)
+{
+	char *start, *end;
+
+	for (start = str; *start; start++) {
+		if (!isspace((unsigned char) start[0]))
+			break;
+	}
+
+	for (end = start + strlen(start); end > start + 1; end--) {
+		if (!isspace((unsigned char) end[-1]))
+			break;
+	}
+
+	*end = 0;
+
+	/* Shift from "start" to the beginning of the string */
+	if (start > str)
+		memmove(str, start, (end - start) + 1);
+
+	return str;
+}
+
 /*
  * Receive a string with a list of arguments following the pattern
  * key=value,key=value,... and insert them into the list.
@@ -38,8 +64,10 @@ rte_kvargs_tokenize(struct rte_kvargs *kvlist, const char *params)
 		if (i >= RTE_KVARGS_MAX)
 			return -1;
 
-		kvlist->pairs[i].key = strtok_r(str, RTE_KVARGS_KV_DELIM, &ctx2);
-		kvlist->pairs[i].value = strtok_r(NULL, RTE_KVARGS_KV_DELIM, &ctx2);
+		kvlist->pairs[i].key = trim_space(strtok_r(str,
+			RTE_KVARGS_KV_DELIM, &ctx2));
+		kvlist->pairs[i].value = trim_space(strtok_r(NULL,
+			RTE_KVARGS_KV_DELIM, &ctx2));
 		if (kvlist->pairs[i].key == NULL ||
 		    kvlist->pairs[i].value == NULL)
 			return -1;
Signature · 1 line
2.7.4
#1 lore raw
Quoted 6 lines · On Wed, 15 May 2019 22:41:07 -0700 Mesut Ali Ergin <[email protected]>…
lib/librte_kvargs/rte_kvargs.c +6 -0
+/* trim leading and trailing spaces */
+static char *
+trim_space(char *str)
+{
+	char *start, *end;
+

lib/librte_kvargs/rte_kvargs.c line 29

Quoted 10 lines
lib/librte_kvargs/rte_kvargs.c +10 -0
+	for (start = str; *start; start++) {
+		if (!isspace((unsigned char) start[0]))
+			break;
+	}
+
+	for (end = start + strlen(start); end > start + 1; end--) {
+		if (!isspace((unsigned char) end[-1]))
+			break;
+	}
+

Why not use existing string functions like strspn?

#2 lore raw
Quoted 23 lines

-----Original Message-----
From: Stephen Hemminger [mailto:[email protected]]
Sent: Thursday, May 16, 2019 9:37 AM
To: Ergin, Mesut A <[email protected]>
Cc: [email protected]; [email protected]
Subject: Re: [dpdk-dev] [PATCH] kvargs: trim spaces at the beginning and end of key and values

Quoted 10 lines · On Wed, 15 May 2019 22:41:07 -0700 Mesut Ali Ergin <[email protected]>…
lib/librte_kvargs/rte_kvargs.c +10 -0
+/* trim leading and trailing spaces */
+static char *
+trim_space(char *str)
+{
+	char *start, *end;
+
+	for (start = str; *start; start++) {
+		if (!isspace((unsigned char) start[0]))
+			break;
+	}
Quoted 8 lines

lib/librte_kvargs/rte_kvargs.c line 29

Quoted 6 lines
lib/librte_kvargs/rte_kvargs.c +6 -0
+
+	for (end = start + strlen(start); end > start + 1; end--) {
+		if (!isspace((unsigned char) end[-1]))
+			break;
+	}
+

Why not use existing string functions like strspn?

Had no particular reason not to use strspn. This was in use/tested in two apps shipping already, and I took the easy route. I could modify if you think it will be better.

#3 lore raw
Quoted 30 lines · Mesut A
Quoted 21 lines

-----Original Message-----
From: Stephen Hemminger [mailto:[email protected]]
Sent: Thursday, May 16, 2019 9:37 AM
To: Ergin, Mesut A <[email protected]>
Cc: [email protected]; [email protected]
Subject: Re: [dpdk-dev] [PATCH] kvargs: trim spaces at the beginning and end of key and values

Quoted 10 lines · On Wed, 15 May 2019 22:41:07 -0700 Mesut Ali Ergin <[email protected]>…
lib/librte_kvargs/rte_kvargs.c +10 -0
+/* trim leading and trailing spaces */
+static char *
+trim_space(char *str)
+{
+	char *start, *end;
+
+	for (start = str; *start; start++) {
+		if (!isspace((unsigned char) start[0]))
+			break;
+	}
Quoted 8 lines

lib/librte_kvargs/rte_kvargs.c line 29

Quoted 6 lines
lib/librte_kvargs/rte_kvargs.c +6 -0
+
+	for (end = start + strlen(start); end > start + 1; end--) {
+		if (!isspace((unsigned char) end[-1]))
+			break;
+	}
+  

Why not use existing string functions like strspn?

Quoted 1 line

Had no particular reason not to use strspn. This was in use/tested in two apps shipping already, and I took the easy route. I could modify if you think it will be better.

writing your own string handling code is often a source of bugs

#4 lore raw
In reply to Mesut Ali Ergin

Hi,

Quoted 54 lines · Mesut Ali Ergin

When arguments delimited with RTE_KVARGS_PAIRS_DELIM happen to have spaces before and after the delimiter, the rte_kvargs_process() can not match them to the intended key. For example, the first argument below triggers the support-multi-driver handler as expected, but the second one silently fails to do so.

(quoted diff) +0 -2
-w '84:00.0,support-multi-driver=1'
-w '84:00.0, support-multi-driver=1'
---
 lib/librte_kvargs/rte_kvargs.c | 32 ++++++++++++++++++++++++++++++--
 1 file changed, 30 insertions(+), 2 deletions(-)
lib/librte_kvargs/rte_kvargs.c +26 -0
index f7030c6..1f45bc6 100644
@@ -10,6 +10,32 @@
 
 #include "rte_kvargs.h"
 
+
+/* trim leading and trailing spaces */
+static char *
+trim_space(char *str)
+{
+	char *start, *end;
+
+	for (start = str; *start; start++) {
+		if (!isspace((unsigned char) start[0]))
+			break;
+	}
+
+	for (end = start + strlen(start); end > start + 1; end--) {
+		if (!isspace((unsigned char) end[-1]))
+			break;
+	}
+
+	*end = 0;
+
+	/* Shift from "start" to the beginning of the string */
+	if (start > str)
+		memmove(str, start, (end - start) + 1);
+
+	return str;
+}
+
 /*
  * Receive a string with a list of arguments following the pattern
  * key=value,key=value,... and insert them into the list.
@@ -38,8 +64,10 @@ rte_kvargs_tokenize(struct rte_kvargs *kvlist, const char *params)
 		if (i >= RTE_KVARGS_MAX)
 			return -1;

lib/librte_kvargs/rte_kvargs.c rte_kvargs_tokenize(struct rte_kvargs *kvlist, const char *params) · line 73

Quoted 10 lines
lib/librte_kvargs/rte_kvargs.c +4 -2
 
-		kvlist->pairs[i].key = strtok_r(str, RTE_KVARGS_KV_DELIM, &ctx2);
-		kvlist->pairs[i].value = strtok_r(NULL, RTE_KVARGS_KV_DELIM, &ctx2);
+		kvlist->pairs[i].key = trim_space(strtok_r(str,
+			RTE_KVARGS_KV_DELIM, &ctx2));
+		kvlist->pairs[i].value = trim_space(strtok_r(NULL,
+			RTE_KVARGS_KV_DELIM, &ctx2));
 		if (kvlist->pairs[i].key == NULL ||
 		    kvlist->pairs[i].value == NULL)
 			return -1;

Having a space in the kwvargs strings like in your example (-w '84:00.0, support-multi-driver=1') is wrong. I don't think we should fix this in kvargs library.

I you feel it is necessary, we could potentially add a comment in the API description to highlight this.

Thanks,
Olivier