diff mbox series

[v2] eal: add strscpy function

Message ID 20180911150049.14755-1-gaetan.rivet@6wind.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers show
Series [v2] eal: add strscpy function | expand

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

Gaëtan Rivet Sept. 11, 2018, 3 p.m. UTC
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

Signed-off-by: Gaetan Rivet <gaetan.rivet@6wind.com>
Acked-by: Juhamatti Kuusisaari <juhamatti.kuusisaari@coriant.com>
---

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(+)

Comments

Ferruh Yigit Sept. 12, 2018, 1:29 p.m. UTC | #1
On 9/11/2018 4:00 PM, Gaetan Rivet wrote:
> 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
> 
> Signed-off-by: Gaetan Rivet <gaetan.rivet@6wind.com>
> Acked-by: Juhamatti Kuusisaari <juhamatti.kuusisaari@coriant.com>

Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>
Thomas Monjalon Sept. 19, 2018, 9:41 a.m. UTC | #2
12/09/2018 15:29, Ferruh Yigit:
> On 9/11/2018 4:00 PM, Gaetan Rivet wrote:
> > 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
> > 
> > Signed-off-by: Gaetan Rivet <gaetan.rivet@6wind.com>
> > Acked-by: Juhamatti Kuusisaari <juhamatti.kuusisaari@coriant.com>
> 
> Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>

Applied, thanks
diff mbox series

Patch

diff --git a/lib/librte_eal/common/eal_common_string_fns.c b/lib/librte_eal/common/eal_common_string_fns.c
index 6ac5f8289..60c5dd66f 100644
--- a/lib/librte_eal/common/eal_common_string_fns.c
+++ b/lib/librte_eal/common/eal_common_string_fns.c
@@ -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;
+}
diff --git a/lib/librte_eal/common/include/rte_string_fns.h b/lib/librte_eal/common/include/rte_string_fns.h
index 97597a148..ecd141b85 100644
--- a/lib/librte_eal/common/include/rte_string_fns.h
+++ b/lib/librte_eal/common/include/rte_string_fns.h
@@ -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
diff --git a/lib/librte_eal/rte_eal_version.map b/lib/librte_eal/rte_eal_version.map
index 344a43d32..2031d7b15 100644
--- a/lib/librte_eal/rte_eal_version.map
+++ b/lib/librte_eal/rte_eal_version.map
@@ -262,6 +262,13 @@  DPDK_18.08 {
 
 } DPDK_18.05;
 
+DPDK_18.11 {
+	global:
+
+	rte_strscpy;
+
+} DPDK_18.08;
+
 EXPERIMENTAL {
 	global: