Skip to contentSkip to conversation

strscpy() support to DPDK?

PATCH Superseded Kuusisaari, Juhamatti (Coriant - FI/Espoo) 4 participants 6 messages Sep 11, 2018 – Sep 19, 2018

lore
Share & tools
lore
#1 lore raw

PATCH 1/1 eal: add strscpy function

The strncpy function has long been deemed unsafe for use, in favor of strlcpy or snprintf.

While snprintf is standard and strlcpy is still largely available, they both have issues regarding error checking and performance.

Both will force reading the source buffer past the requested size if the input is not a proper c-string, and will return the expected number of bytes copied, meaning that error checking needs to verify that the number of bytes copied is not superior to the destination size.

This contributes to awkward code flow, unclear error checking and potential issues with malformed input.

The function strscpy has been discussed for some time already and has been made available in the linux kernel[1].

Propose this new function as a safe alternative.

[1]: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=30c44659f4a3e7e1f9f47e895591b4b40bf62671

---

I agree with the original email, here is a proposed implementation. I have added the function as part of 18.11 API proper, because this API is definitely not meant to change.

This is not meant to be enforced on existing code, or even on new code. But I think it is better to have it available.

 lib/librte_eal/common/eal_common_string_fns.c | 30 +++++++++++++++++++
 .../common/include/rte_string_fns.h           | 23 ++++++++++++++
 lib/librte_eal/rte_eal_version.map            |  7 +++++
 3 files changed, 60 insertions(+)
lib/librte_eal/common/eal_common_string_fns.c +30 -0
index 6ac5f8289..8a34d2422 100644
@@ -38,3 +38,33 @@ rte_strsplit(char *string, int stringlen,
 	errno = EINVAL;
 	return -1;
 }
+
+/* Copy src string into dst.
+ *
+ * Return negative value and NUL-terminate if dst is too short,
+ * Otherwise return number of bytes copied.
+ */
+ssize_t
+strscpy(char *dst, const char *src, size_t dsize)
+{
+	const char *osrc = src;
+	size_t nleft = dsize;
+
+	/* Copy as many bytes as will fit. */
+	if (nleft != 0) {
+		while (--nleft != 0) {
+			if ((*dst++ = *src++) == '\0')
+				break;
+		}
+	}
+
+	/* Not enough room in dst, add NUL and return error. */
+	if (nleft == 0) {
+		if (dsize != 0)
+			*dst = '\0';
+		return -E2BIG;
+	}
+
+	/* count does not include NUL */
+	return (src - osrc - 1);
+}
lib/librte_eal/common/include/rte_string_fns.h +23 -0
index 97597a148..46dd919b4 100644
@@ -76,6 +76,29 @@ rte_strlcpy(char *dst, const char *src, size_t size)
 #endif /* RTE_USE_LIBBSD */
 #endif /* BSDAPP */
 
+/**
+ * Copy string src to buffer dst of size dsize.
+ * At most dsize-1 chars will be copied.
+ * Always NUL-terminates, unless (dsize == 0).
+ * Returns number of bytes copied (terminating NUL-byte excluded) on success.
+ * Negative errno on error.
+ *
+ * @param dst
+ *   The destination string.
+ *
+ * @param src
+ *   The input string to be copied.
+ *
+ * @param dsize
+ *   Length in bytes of the destination buffer.
+ *
+ * @return
+ *   The number of bytes copied on success
+ *   -E2BIG if the destination buffer is too small.
+ */
+ssize_t
+strscpy(char *dst, const char *src, size_t dsize);
+
 #ifdef __cplusplus
 }
 #endif
lib/librte_eal/rte_eal_version.map +7 -0
index 344a43d32..fc7b50669 100644
@@ -262,6 +262,13 @@ DPDK_18.08 {
 
 } DPDK_18.05;
 
+DPDK_18.11 {
+	global:
+
+	strscpy;
+
+} DPDK_18.08;
+
 EXPERIMENTAL {
 	global:
 
Signature · 1 line
2.18.0
#2 lore raw

Re: [PATCH v1] eal: add strscpy function

Quoted 132 lines

-----Original Message-----
From: dev [mailto:[email protected]] On Behalf Of Gaetan Rivet
Sent: Tuesday, September 11, 2018 1:04 PM
To: [email protected]
Cc: Gaetan Rivet <[email protected]>
Subject: [dpdk-dev] [PATCH v1] eal: add strscpy function

The strncpy function has long been deemed unsafe for use, in favor of strlcpy or snprintf.

While snprintf is standard and strlcpy is still largely available, they both have issues regarding error checking and performance.

Both will force reading the source buffer past the requested size if the input is not a proper c-string, and will return the expected number of bytes copied, meaning that error checking needs to verify that the number of bytes copied is not superior to the destination size.

This contributes to awkward code flow, unclear error checking and potential issues with malformed input.

The function strscpy has been discussed for some time already and has been made available in the linux kernel[1].

Propose this new function as a safe alternative.

[1]:
https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?i
d=30c44659f4a3e7e1f9f47e895591b4b40bf62671

---

I agree with the original email, here is a proposed implementation. I have added the function as part of 18.11 API proper, because this API is definitely not meant to change.

This is not meant to be enforced on existing code, or even on new code. But I think it is better to have it available.

 lib/librte_eal/common/eal_common_string_fns.c | 30
+++++++++++++++++++
 .../common/include/rte_string_fns.h           | 23 ++++++++++++++
 lib/librte_eal/rte_eal_version.map            |  7 +++++
 3 files changed, 60 insertions(+)
lib/librte_eal/common/eal_common_string_fns.c +30 -0
index 6ac5f8289..8a34d2422 100644
@@ -38,3 +38,33 @@ rte_strsplit(char *string, int stringlen,
 	errno = EINVAL;
 	return -1;
 }
+
+/* Copy src string into dst.
+ *
+ * Return negative value and NUL-terminate if dst is too short,
+ * Otherwise return number of bytes copied.
+ */
+ssize_t
+strscpy(char *dst, const char *src, size_t dsize)
+{
+	const char *osrc = src;
+	size_t nleft = dsize;
+
+	/* Copy as many bytes as will fit. */
+	if (nleft != 0) {
+		while (--nleft != 0) {
+			if ((*dst++ = *src++) == '\0')
+				break;
+		}
+	}
+
+	/* Not enough room in dst, add NUL and return error. */
+	if (nleft == 0) {
+		if (dsize != 0)
+			*dst = '\0';
+		return -E2BIG;
+	}
+
+	/* count does not include NUL */
+	return (src - osrc - 1);
+}
lib/librte_eal/common/include/rte_string_fns.h +5 -0
index 97597a148..46dd919b4 100644
@@ -76,6 +76,29 @@ rte_strlcpy(char *dst, const char *src, size_t size)
 #endif /* RTE_USE_LIBBSD */
 #endif /* BSDAPP */
 
+/**
+ * Copy string src to buffer dst of size dsize.
+ * At most dsize-1 chars will be copied.
+ * Always NUL-terminates, unless (dsize == 0).
+ * Returns number of bytes copied (terminating NUL-byte excluded) on

success.
+ * Negative errno on error.
+ *
+ * @param dst
+ * The destination string.
+ *
+ * @param src
+ * The input string to be copied.
+ *
+ * @param dsize
+ * Length in bytes of the destination buffer.
+ *
+ * @return
+ * The number of bytes copied on success
+ * -E2BIG if the destination buffer is too small.
+ */

lib/librte_eal/common/include/rte_string_fns.h +3 -0
+ssize_t
+strscpy(char *dst, const char *src, size_t dsize);
+
 #ifdef __cplusplus
 }
 #endif
lib/librte_eal/rte_eal_version.map +0 -0
index 344a43d32..fc7b50669 100644
@@ -262,6 +262,13 @@ DPDK_18.08 {
 
 } DPDK_18.05;

lib/librte_eal/rte_eal_version.map DPDK_18.08 { · line 273

Quoted 10 lines
lib/librte_eal/rte_eal_version.map +7 -0
 
+DPDK_18.11 {
+	global:
+
+	strscpy;
+
+} DPDK_18.08;
+
 EXPERIMENTAL {
 	global:
Quoted 2 lines
lib/librte_eal/rte_eal_version.map +0 -1
--

2.18.0

#3 lore raw

PATCH v2 1/1 eal: add strscpy function

The strncpy function has long been deemed unsafe for use, in favor of strlcpy or snprintf.

While snprintf is standard and strlcpy is still largely available, they both have issues regarding error checking and performance.

Both will force reading the source buffer past the requested size if the input is not a proper c-string, and will return the expected number of bytes copied, meaning that error checking needs to verify that the number of bytes copied is not superior to the destination size.

This contributes to awkward code flow, unclear error checking and potential issues with malformed input.

The function strscpy has been discussed for some time already and has been made available in the linux kernel[1].

Propose this new function as a safe alternative.

[1]: http://git.kernel.org/linus/30c44659f4a3

---

v2: use rte_prefix,
avoid assignment in if()

I agree with the original email, here is a proposed implementation. I have added the function as part of 18.11 API proper, because this API is definitely not meant to change.

This is not meant to be enforced on existing code, or even on new code. But I think it is better to have it available.

 lib/librte_eal/common/eal_common_string_fns.c | 26 +++++++++++++++++++
 .../common/include/rte_string_fns.h           | 23 ++++++++++++++++
 lib/librte_eal/rte_eal_version.map            |  7 +++++
 3 files changed, 56 insertions(+)
lib/librte_eal/common/eal_common_string_fns.c +26 -0
index 6ac5f8289..60c5dd66f 100644
@@ -38,3 +38,29 @@ rte_strsplit(char *string, int stringlen,
 	errno = EINVAL;
 	return -1;
 }
+
+/* Copy src string into dst.
+ *
+ * Return negative value and NUL-terminate if dst is too short,
+ * Otherwise return number of bytes copied.
+ */
+ssize_t
+rte_strscpy(char *dst, const char *src, size_t dsize)
+{
+	size_t nleft = dsize;
+	size_t res = 0;
+
+	/* Copy as many bytes as will fit. */
+	while (nleft != 0) {
+		dst[res] = src[res];
+		if (src[res] == '\0')
+			return res;
+		res++;
+		nleft--;
+	}
+
+	/* Not enough room in dst, set NUL and return error. */
+	if (res != 0)
+		dst[res - 1] = '\0';
+	return -E2BIG;
+}
lib/librte_eal/common/include/rte_string_fns.h +23 -0
index 97597a148..ecd141b85 100644
@@ -76,6 +76,29 @@ rte_strlcpy(char *dst, const char *src, size_t size)
 #endif /* RTE_USE_LIBBSD */
 #endif /* BSDAPP */
 
+/**
+ * Copy string src to buffer dst of size dsize.
+ * At most dsize-1 chars will be copied.
+ * Always NUL-terminates, unless (dsize == 0).
+ * Returns number of bytes copied (terminating NUL-byte excluded) on success ;
+ * negative errno on error.
+ *
+ * @param dst
+ *   The destination string.
+ *
+ * @param src
+ *   The input string to be copied.
+ *
+ * @param dsize
+ *   Length in bytes of the destination buffer.
+ *
+ * @return
+ *   The number of bytes copied on success
+ *   -E2BIG if the destination buffer is too small.
+ */
+ssize_t
+rte_strscpy(char *dst, const char *src, size_t dsize);
+
 #ifdef __cplusplus
 }
 #endif
lib/librte_eal/rte_eal_version.map +7 -0
index 344a43d32..2031d7b15 100644
@@ -262,6 +262,13 @@ DPDK_18.08 {
 
 } DPDK_18.05;
 
+DPDK_18.11 {
+	global:
+
+	rte_strscpy;
+
+} DPDK_18.08;
+
 EXPERIMENTAL {
 	global:
 
Signature · 1 line
2.18.0
Acked-by on v2 1/1
#4 lore raw

Re: [PATCH v2] eal: add strscpy function

Quoted 18 lines · Gaetan Rivet

The strncpy function has long been deemed unsafe for use, in favor of strlcpy or snprintf.

While snprintf is standard and strlcpy is still largely available, they both have issues regarding error checking and performance.

Both will force reading the source buffer past the requested size if the input is not a proper c-string, and will return the expected number of bytes copied, meaning that error checking needs to verify that the number of bytes copied is not superior to the destination size.

This contributes to awkward code flow, unclear error checking and potential issues with malformed input.

The function strscpy has been discussed for some time already and has been made available in the linux kernel[1].

Quoted 6 lines

Propose this new function as a safe alternative.

[1]: http://git.kernel.org/linus/30c44659f4a3

#5 lore raw

Re: [PATCH v2] eal: add strscpy function

12/09/2018 15:29, Ferruh Yigit:

Quoted 19 lines · Gaetan Rivet
Quoted 18 lines

The strncpy function has long been deemed unsafe for use, in favor of strlcpy or snprintf.

While snprintf is standard and strlcpy is still largely available, they both have issues regarding error checking and performance.

Both will force reading the source buffer past the requested size if the input is not a proper c-string, and will return the expected number of bytes copied, meaning that error checking needs to verify that the number of bytes copied is not superior to the destination size.

This contributes to awkward code flow, unclear error checking and potential issues with malformed input.

The function strscpy has been discussed for some time already and has been made available in the linux kernel[1].

Quoted 8 lines
Quoted 6 lines

Propose this new function as a safe alternative.

[1]: http://git.kernel.org/linus/30c44659f4a3

Applied, thanks