Skip to contentSkip to conversation

lib/string: Add strscpy_pad() function

PATCH Superseded Tobin C. Harding 4 participants 7 messages Feb 25, 2019 – Feb 27, 2019

Subsystems (2)

v2 of 4 Superseded Latest is v4 →

lore
Share & tools
lore
#0 lore raw

v2 cover lib/string: Add strscpy_pad() function

Hi,

This patch set was formerly

Subject: [PATCH 0/6] lib: Add safe string funtions[sic]

And FTR can be seen here:

	https://lkml.org/lkml/2019/2/18/1428

The v1 patch set has been reduced to a single patch by dropping the strscpy_from_user() stuff and by rolling all the docs changes into the main patch as suggested.

This patch adds the function strscpy_pad() named after consensus was reached on the v1 email thread (linked to above).

Thanks to Kees for the extreme test case coverage. test_basic() is probably redundant but is left in for the benefit of any poor sucker who has to debug a regression using test_fully().

The test module is _not_ tied into kselftest. As discussed on v1, there are some issues with tools/testing/selftest/lib/ at the moment. I intend on working on those issues as suggested but it does not seem totally relevant to this patch so instead of slowing this one down with my poor knowledge of how kselftest works it seems better to do this separately.

thanks for looking at this,
Tobin.

Tobin C. Harding (1):
lib/string: Add strscpy_pad() function

 include/linux/string.h |   4 +
 lib/Kconfig.debug      |   3 +
 lib/Makefile           |   1 +
 lib/string.c           |  47 +++++++++--
 lib/test_strscpy.c     | 175 +++++++++++++++++++++++++++++++++++++++++
 5 files changed, 223 insertions(+), 7 deletions(-)
 create mode 100644 lib/test_strscpy.c
Signature · 1 line
2.20.1
#1 lore raw

PATCH v2 1/1 lib/string: Add strscpy_pad() function

We have a function to copy strings safely and we have a function to copy strings and zero the tail of the destination (if source string is shorter than destination buffer) but we do not have a function to do both at once. This means developers must write this themselves if they desire this functionality. This is a chore, and also leaves us open to off by one errors unnecessarily.

Add a function that calls strscpy() then memset()s the tail to zero if the source string is shorter than the destination buffer.

Add test module for the new code.

---
 include/linux/string.h |   4 +
 lib/Kconfig.debug      |   3 +
 lib/Makefile           |   1 +
 lib/string.c           |  47 +++++++++--
 lib/test_strscpy.c     | 175 +++++++++++++++++++++++++++++++++++++++++
 5 files changed, 223 insertions(+), 7 deletions(-)
 create mode 100644 lib/test_strscpy.c
include/linux/string.h +4 -0
index 7927b875f80c..bfe95bf5d07e 100644
@@ -31,6 +31,10 @@ size_t strlcpy(char *, const char *, size_t);
 #ifndef __HAVE_ARCH_STRSCPY
 ssize_t strscpy(char *, const char *, size_t);
 #endif
+
+/* Wraps calls to strscpy()/memset(), no arch specific code required */
+ssize_t strscpy_pad(char *dest, const char *src, size_t count);
+
 #ifndef __HAVE_ARCH_STRCAT
 extern char * strcat(char *, const char *);
 #endif
lib/Kconfig.debug +3 -0
index d4df5b24d75e..fb629a0c6272 100644
@@ -1805,6 +1805,9 @@ config TEST_HEXDUMP
 config TEST_STRING_HELPERS
 	tristate "Test functions located in the string_helpers module at runtime"
 
+config TEST_STRSCPY
+	tristate "Test strscpy*() family of functions  at runtime"
+
 config TEST_KSTRTOX
 	tristate "Test kstrto*() family of functions at runtime"
 
lib/Makefile +1 -0
index e1b59da71418..59519926cbc6 100644
@@ -42,6 +42,7 @@ obj-y += bcd.o div64.o sort.o parser.o debug_locks.o random32.o \
 obj-$(CONFIG_STRING_SELFTEST) += test_string.o
 obj-y += string_helpers.o
 obj-$(CONFIG_TEST_STRING_HELPERS) += test-string_helpers.o
+obj-$(CONFIG_TEST_STRSCPY) += test_strscpy.o
 obj-y += hexdump.o
 obj-$(CONFIG_TEST_HEXDUMP) += test_hexdump.o
 obj-y += kstrtox.o
lib/string.c +40 -7

65 lines not on this page · raw message

lib/test_strscpy.c new file +175 -0

175 lines not on this page · raw message

Signature · 1 line
2.20.1
#2 lore raw
Quoted 16 lines · Tobin C. Harding

We have a function to copy strings safely and we have a function to copy strings and zero the tail of the destination (if source string is shorter than destination buffer) but we do not have a function to do both at once. This means developers must write this themselves if they desire this functionality. This is a chore, and also leaves us open to off by one errors unnecessarily.

Add a function that calls strscpy() then memset()s the tail to zero if the source string is shorter than the destination buffer.

Add test module for the new code.

lib/test_strscpy.c

Quoted 4 lines
lib/test_strscpy.c new file +2 -0
@@ -0,0 +1,175 @@
 
+// SPDX-License-Identifier: GPL-2.0
 
+MODULE_LICENSE("GPL");

License mismatch.

Do we need a separate module for this test?

Signature · 2 lines
With Best Regards,
Andy Shevchenko
#3 lore raw
Quoted 18 lines · Andy Shevchenko
Quoted 16 lines · Tobin C. Harding

We have a function to copy strings safely and we have a function to copy strings and zero the tail of the destination (if source string is shorter than destination buffer) but we do not have a function to do both at once. This means developers must write this themselves if they desire this functionality. This is a chore, and also leaves us open to off by one errors unnecessarily.

Add a function that calls strscpy() then memset()s the tail to zero if the source string is shorter than the destination buffer.

Add test module for the new code.

lib/test_strscpy.c new file +0 -0
@@ -0,0 +1,175 @@
Quoted 5 lines

lib/test_strscpy.c

Quoted 3 lines
lib/test_strscpy.c new file +2 -0
+// SPDX-License-Identifier: GPL-2.0
 
+MODULE_LICENSE("GPL");

License mismatch.

Thanks, will re-spin with

// SPDX-License-Identifier: GPL-2.0+

Quoted 1 line

Do we need a separate module for this test?

Separate as in not in lib/test_string.h? I intend on moving the test into that file once I've done some cleanup in tools/testing/selftest/lib/

I also tried to do this without using a module using tools/testing/selftest/kselftest_harness.h but I could not get the compiler to see read the patched version of linux/include/linux/string.h?

Related question if you feel like answering it; why are test modules for lib/ in lib/ and not in tools/testing/?

Very much open to suggestions on current best practices for kernel testing.

thanks,
Tobin.

#4 lore raw
Quoted 39 lines · Tobin C. Harding
Quoted 18 lines · Andy Shevchenko
Quoted 16 lines · Tobin C. Harding

We have a function to copy strings safely and we have a function to copy strings and zero the tail of the destination (if source string is shorter than destination buffer) but we do not have a function to do both at once. This means developers must write this themselves if they desire this functionality. This is a chore, and also leaves us open to off by one errors unnecessarily.

Add a function that calls strscpy() then memset()s the tail to zero if the source string is shorter than the destination buffer.

Add test module for the new code.

lib/test_strscpy.c new file +0 -0
@@ -0,0 +1,175 @@
Quoted 5 lines

lib/test_strscpy.c

Quoted 3 lines
lib/test_strscpy.c new file +2 -0
+// SPDX-License-Identifier: GPL-2.0
 
+MODULE_LICENSE("GPL");

License mismatch.

Thanks, will re-spin with

// SPDX-License-Identifier: GPL-2.0+

Quoted 1 line

Do we need a separate module for this test?

Separate as in not in lib/test_string.h? I intend on moving the test into that file once I've done some cleanup in tools/testing/selftest/lib/

I also tried to do this without using a module using tools/testing/selftest/kselftest_harness.h but I could not get the compiler to see read the patched version of linux/include/linux/string.h?

Quoted 4 lines

Related question if you feel like answering it; why are test modules for lib/ in lib/ and not in tools/testing/?

Very much open to suggestions on current best practices for kernel testing.

I just read Andy mirskFrom: "Tobin C. Harding" <[email protected]>
To: Andy Shevchenko <[email protected]>
Cc: "Tobin C. Harding" <[email protected]>,
Kees Cook <[email protected]>, Jann Horn <[email protected]>, Andy Shevchenko <[email protected]>, Randy Dunlap <[email protected]>,
Rasmus Villemoes <[email protected]>,
Stephen Rothwell <[email protected]>,
Andy Lutomirski <[email protected]>,
Daniel Micay <[email protected]>, Arnd Bergmann <[email protected]>, Miguel Ojeda <[email protected]>,
"Gustavo A. R. Silva" <[email protected]>,
Shuah Khan <[email protected]>,
Greg Kroah-Hartman <[email protected]>, Alexander Shishkin <[email protected]>, Kernel Hardening <[email protected]>, Linux Kernel Mailing List <[email protected]>
Bcc:
Subject: Re: [PATCH v2 1/1] lib/string: Add strscpy_pad() function Reply-To:
In-Reply-To: <[email protected]>
X-Mailer: Mutt 1.11.3 (2019-02-01)

Quoted 39 lines · Tobin C. Harding
Quoted 18 lines · Andy Shevchenko
Quoted 16 lines · Tobin C. Harding

We have a function to copy strings safely and we have a function to copy strings and zero the tail of the destination (if source string is shorter than destination buffer) but we do not have a function to do both at once. This means developers must write this themselves if they desire this functionality. This is a chore, and also leaves us open to off by one errors unnecessarily.

Add a function that calls strscpy() then memset()s the tail to zero if the source string is shorter than the destination buffer.

Add test module for the new code.

lib/test_strscpy.c new file +0 -0
@@ -0,0 +1,175 @@
Quoted 5 lines

lib/test_strscpy.c

Quoted 3 lines
lib/test_strscpy.c new file +2 -0
+// SPDX-License-Identifier: GPL-2.0
 
+MODULE_LICENSE("GPL");

License mismatch.

Thanks, will re-spin with

// SPDX-License-Identifier: GPL-2.0+

Quoted 1 line

Do we need a separate module for this test?

Separate as in not in lib/test_string.h? I intend on moving the test into that file once I've done some cleanup in tools/testing/selftest/lib/

I also tried to do this without using a module using tools/testing/selftest/kselftest_harness.h but I could not get the compiler to see read the patched version of linux/include/linux/string.h?

Quoted 4 lines

Related question if you feel like answering it; why are test modules for lib/ in lib/ and not in tools/testing/?

Very much open to suggestions on current best practices for kernel testing.

I just read Andy mirskFrom: "Tobin C. Harding" <[email protected]>
To: Andy Shevchenko <[email protected]>
Cc: "Tobin C. Harding" <[email protected]>,
Kees Cook <[email protected]>, Jann Horn <[email protected]>, Andy Shevchenko <[email protected]>, Randy Dunlap <[email protected]>,
Rasmus Villemoes <[email protected]>,
Stephen Rothwell <[email protected]>,
Andy Lutomirski <[email protected]>,
Daniel Micay <[email protected]>, Arnd Bergmann <[email protected]>, Miguel Ojeda <[email protected]>,
"Gustavo A. R. Silva" <[email protected]>,
Shuah Khan <[email protected]>,
Greg Kroah-Hartman <[email protected]>, Alexander Shishkin <[email protected]>, Kernel Hardening <[email protected]>, Linux Kernel Mailing List <[email protected]>
Bcc:
Subject: Re: [PATCH v2 1/1] lib/string: Add strscpy_pad() function Reply-To:
In-Reply-To: <[email protected]>
X-Mailer: Mutt 1.11.3 (2019-02-01)

Quoted 39 lines · Tobin C. Harding
Quoted 18 lines · Andy Shevchenko
Quoted 16 lines · Tobin C. Harding

We have a function to copy strings safely and we have a function to copy strings and zero the tail of the destination (if source string is shorter than destination buffer) but we do not have a function to do both at once. This means developers must write this themselves if they desire this functionality. This is a chore, and also leaves us open to off by one errors unnecessarily.

Add a function that calls strscpy() then memset()s the tail to zero if the source string is shorter than the destination buffer.

Add test module for the new code.

lib/test_strscpy.c new file +0 -0
@@ -0,0 +1,175 @@
Quoted 5 lines

lib/test_strscpy.c

Quoted 3 lines
lib/test_strscpy.c new file +2 -0
+// SPDX-License-Identifier: GPL-2.0
 
+MODULE_LICENSE("GPL");

License mismatch.

Thanks, will re-spin with

// SPDX-License-Identifier: GPL-2.0+

Quoted 1 line

Do we need a separate module for this test?

Separate as in not in lib/test_string.h? I intend on moving the test into that file once I've done some cleanup in tools/testing/selftest/lib/

I also tried to do this without using a module using tools/testing/selftest/kselftest_harness.h but I could not get the compiler to see read the patched version of linux/include/linux/string.h?

Quoted 4 lines

Related question if you feel like answering it; why are test modules for lib/ in lib/ and not in tools/testing/?

Very much open to suggestions on current best practices for kernel testing.

I just read Andy Lutomirski's patch

[PATCH 2/2] uaccess: Add a selftest for strncpy_from_user()

That's a better approach for this one also, right? Put the test in string.c and ifdef guard it with a config option.

thanks,
Tobin.

#5 lore raw
In reply to Tobin C. Harding
Quoted 15 lines · Tobin C. Harding

We have a function to copy strings safely and we have a function to copy strings and zero the tail of the destination (if source string is shorter than destination buffer) but we do not have a function to do both at once. This means developers must write this themselves if they desire this functionality. This is a chore, and also leaves us open to off by one errors unnecessarily.

Add a function that calls strscpy() then memset()s the tail to zero if the source string is shorter than the destination buffer.

Add test module for the new code.

lib/string.c ssize_t strscpy(char *dest, const char *src, size_t count) · line 265

Quoted 7 lines
lib/string.c +7 -0
+ssize_t strscpy_pad(char *dest, const char *src, size_t count)
+{
+       ssize_t written;
+
+       written = strscpy(dest, src, count);
+       if (written < 0 || written == count - 1)
+               return written;

*thread merge* Yeah, good point. written will be -E2BIG for both count = 0 and count = 1.

Quoted 27 lines
lib/string.c +7 -0
+
+       memset(dest + written + 1, 0, count - written - 1);
+
+       return written;
+}
+EXPORT_SYMBOL(strscpy_pad);
+
 #ifndef __HAVE_ARCH_STRCAT
 /**
  * strcat - Append one %NUL-terminated string to another
lib/test_strscpy.c new file +11 -0
new file mode 100644
index 000000000000..5ec6a196f4e2
@@ -0,0 +1,175 @@
+// SPDX-License-Identifier: GPL-2.0
+
+#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
+
+#include <linux/init.h>
+#include <linux/kernel.h>
+#include <linux/module.h>
+#include <linux/printk.h>
+#include <linux/string.h>
+
+/*

lib/test_strscpy.c line 21

Quoted 10 lines
lib/test_strscpy.c new file +10 -0
+ * Kernel module for testing 'strscpy' family of functions.
+ */
+
+static unsigned total_tests __initdata;
+static unsigned failed_tests __initdata;
+
+static void __init do_test(int count, char *src, int expected,
+                          int chars, int terminator, int pad)
+{
+       char buf[6];

I would make this "6" a define, since you use it in more than one place. Actually... no, never mind. The other places can use "sizeof(buf)" instead of "6". Noted below...

But I'd add an explicit check for "expected + 1 < sizeof(buf)" just for future test-addition sanity.

lib/test_strscpy.c line 32

Quoted 11 lines
lib/test_strscpy.c new file +11 -0
+       int written;
+       int poison;
+       int index;
+       int i;
+       const char POISON = 'z';
+
+       total_tests++;
+       memset(buf, POISON, sizeof(buf));
+
+       /* Verify the return value */
+

Needless blank line.

lib/test_strscpy.c line 40

Quoted 8 lines
lib/test_strscpy.c new file +8 -0
+       written = strscpy_pad(buf, src, count);
+       if ((written) != (expected)) {
+               pr_err("%d != %d (written, expected)\n", written, expected);
+               goto fail;
+       }
+
+       /* Verify the state of the buffer */
+

Same.

Quoted 28 lines
lib/test_strscpy.c new file +28 -0
+       if (count && written == -E2BIG) {
+               if (strncmp(buf, src, count - 1) != 0) {
+                       pr_err("buffer state invalid for -E2BIG\n");
+                       goto fail;
+               }
+               if (buf[count - 1] != '\0') {
+                       pr_err("too big string is not null terminated correctly\n");
+                       goto fail;
+               }
+       }
+
+       /* Verify the copied content */
+       for (i = 0; i < chars; i++) {
+               if (buf[i] != src[i]) {
+                       pr_err("buf[i]==%c != src[i]==%c\n", buf[i], src[i]);
+                       goto fail;
+               }
+       }
+
+       /* Verify the null terminator */
+       if (terminator) {
+               if (buf[count - 1] != '\0') {
+                       pr_err("string is not null terminated correctly\n");
+                       goto fail;
+               }
+       }
+
+       /* Verify the padding */

lib/test_strscpy.c line 78

Quoted 10 lines
lib/test_strscpy.c new file +10 -0
+       for (i = 0; i < pad; i++) {
+               index = chars + terminator + i;
+               if (buf[index] != '\0') {
+                       pr_err("padding missing at index: %d\n", i);
+                       goto fail;
+               }
+       }
+
+       /* Verify the rest is left untouched */
+       poison = 6 - chars - terminator - pad;

instead of "6", use "sizeof(buf)".

lib/test_strscpy.c line 80

Quoted 2 lines
lib/test_strscpy.c new file +2 -0
+       for (i = 0; i < poison; i++) {
+               index = 6 - 1 - i; /* Check from the end back */

Same.

Quoted 56 lines
lib/test_strscpy.c new file +56 -0
+               if (buf[index] != POISON) {
+                       pr_err("poison value missing at index: %d\n", i);
+                       goto fail;
+               }
+       }
+
+       return;
+fail:
+       pr_info("%s(%d, '%s', %d, %d, %d, %d)\n", __func__,
+               count, src, expected, chars, terminator, pad);
+       failed_tests++;
+}
+
+static void __init test_fully(void)
+{
+       /* do_test(count, src, expected, chars, terminator, pad) */
+
+       do_test(0, "a", -E2BIG, 0, 0, 0);
+       do_test(0, "", -E2BIG, 0, 0, 0);
+
+       do_test(1, "a", -E2BIG, 0, 1, 0);
+       do_test(1, "", 0, 0, 1, 0);
+
+       do_test(2, "ab", -E2BIG, 1, 1, 0);
+       do_test(2, "a", 1, 1, 1, 0);
+       do_test(2, "", 0, 0, 1, 1);
+
+       do_test(3, "abc", -E2BIG, 2, 1, 0);
+       do_test(3, "ab", 2, 2, 1, 0);
+       do_test(3, "a", 1, 1, 1, 1);
+       do_test(3, "", 0, 0, 1, 2);
+
+       do_test(4, "abcd", -E2BIG, 3, 1, 0);
+       do_test(4, "abc", 3, 3, 1, 0);
+       do_test(4, "ab", 2, 2, 1, 1);
+       do_test(4, "a", 1, 1, 1, 2);
+       do_test(4, "", 0, 0, 1, 3);
+}
+
+static void __init test_basic(void)
+{
+       char buf[6];
+       int written;
+
+       memset(buf, 'a', sizeof(buf));
+
+       total_tests++;
+       written = strscpy_pad(buf, "bb", 4);
+       if (written != 2)
+               failed_tests++;
+
+       /* Correctly copied */
+       total_tests++;
+       if (buf[0] != 'b' || buf[1] != 'b')
+               failed_tests++;
+

lib/test_strscpy.c line 146

Quoted 10 lines
lib/test_strscpy.c new file +10 -0
+       /* Correctly padded */
+       total_tests++;
+       if (buf[2] != '\0' || buf[3] != '\0')
+               failed_tests++;
+
+       /* Only touched what it was supposed to */
+       total_tests++;
+       if (buf[4] != 'a' || buf[5] != 'a')
+               failed_tests++;
+}

I don't think you need to keep "test_basic". Anything it tests can be rewritten in terms of do_test().

Quoted 30 lines
lib/test_strscpy.c new file +29 -1
+
+static int __init test_strscpy_init(void)
+{
+       pr_info("loaded.\n");
+
+       test_basic();
+       if (failed_tests)
+               goto out;
+
+       test_fully();
+
+out:
+       if (failed_tests == 0)
+               pr_info("all %u tests passed\n", total_tests);
+       else
+               pr_warn("failed %u out of %u tests\n", failed_tests, total_tests);
+
+       return failed_tests ? -EINVAL : 0;
+}
+module_init(test_strscpy_init);
+
+static void __exit test_strscpy_exit(void)
+{
+       pr_info("unloaded.\n");
+}
+module_exit(test_strscpy_exit);
+
+MODULE_AUTHOR("Tobin C. Harding <[email protected]>");
+MODULE_LICENSE("GPL");
--
Quoted 2 lines

2.20.1

Otherwise, yes, looks good!

Signature · 1 line
Kees Cook
#6 lore raw
Quoted 239 lines · Kees Cook
Quoted 15 lines · Tobin C. Harding

We have a function to copy strings safely and we have a function to copy strings and zero the tail of the destination (if source string is shorter than destination buffer) but we do not have a function to do both at once. This means developers must write this themselves if they desire this functionality. This is a chore, and also leaves us open to off by one errors unnecessarily.

Add a function that calls strscpy() then memset()s the tail to zero if the source string is shorter than the destination buffer.

Add test module for the new code.

lib/string.c ssize_t strscpy(char *dest, const char *src, size_t count) · line 265

Quoted 7 lines
lib/string.c +7 -0
+ssize_t strscpy_pad(char *dest, const char *src, size_t count)
+{
+       ssize_t written;
+
+       written = strscpy(dest, src, count);
+       if (written < 0 || written == count - 1)
+               return written;

*thread merge* Yeah, good point. written will be -E2BIG for both count = 0 and count = 1.

Quoted 27 lines
lib/string.c +7 -0
+
+       memset(dest + written + 1, 0, count - written - 1);
+
+       return written;
+}
+EXPORT_SYMBOL(strscpy_pad);
+
 #ifndef __HAVE_ARCH_STRCAT
 /**
  * strcat - Append one %NUL-terminated string to another
lib/test_strscpy.c new file +11 -0
new file mode 100644
index 000000000000..5ec6a196f4e2
@@ -0,0 +1,175 @@
+// SPDX-License-Identifier: GPL-2.0
+
+#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
+
+#include <linux/init.h>
+#include <linux/kernel.h>
+#include <linux/module.h>
+#include <linux/printk.h>
+#include <linux/string.h>
+
+/*

lib/test_strscpy.c line 21

Quoted 10 lines
lib/test_strscpy.c new file +10 -0
+ * Kernel module for testing 'strscpy' family of functions.
+ */
+
+static unsigned total_tests __initdata;
+static unsigned failed_tests __initdata;
+
+static void __init do_test(int count, char *src, int expected,
+                          int chars, int terminator, int pad)
+{
+       char buf[6];

I would make this "6" a define, since you use it in more than one place. Actually... no, never mind. The other places can use "sizeof(buf)" instead of "6". Noted below...

But I'd add an explicit check for "expected + 1 < sizeof(buf)" just for future test-addition sanity.

lib/test_strscpy.c line 32

Quoted 11 lines
lib/test_strscpy.c new file +11 -0
+       int written;
+       int poison;
+       int index;
+       int i;
+       const char POISON = 'z';
+
+       total_tests++;
+       memset(buf, POISON, sizeof(buf));
+
+       /* Verify the return value */
+

Needless blank line.

lib/test_strscpy.c line 40

Quoted 8 lines
lib/test_strscpy.c new file +8 -0
+       written = strscpy_pad(buf, src, count);
+       if ((written) != (expected)) {
+               pr_err("%d != %d (written, expected)\n", written, expected);
+               goto fail;
+       }
+
+       /* Verify the state of the buffer */
+

Same.

Quoted 28 lines
lib/test_strscpy.c new file +28 -0
+       if (count && written == -E2BIG) {
+               if (strncmp(buf, src, count - 1) != 0) {
+                       pr_err("buffer state invalid for -E2BIG\n");
+                       goto fail;
+               }
+               if (buf[count - 1] != '\0') {
+                       pr_err("too big string is not null terminated correctly\n");
+                       goto fail;
+               }
+       }
+
+       /* Verify the copied content */
+       for (i = 0; i < chars; i++) {
+               if (buf[i] != src[i]) {
+                       pr_err("buf[i]==%c != src[i]==%c\n", buf[i], src[i]);
+                       goto fail;
+               }
+       }
+
+       /* Verify the null terminator */
+       if (terminator) {
+               if (buf[count - 1] != '\0') {
+                       pr_err("string is not null terminated correctly\n");
+                       goto fail;
+               }
+       }
+
+       /* Verify the padding */

lib/test_strscpy.c line 78

Quoted 10 lines
lib/test_strscpy.c new file +10 -0
+       for (i = 0; i < pad; i++) {
+               index = chars + terminator + i;
+               if (buf[index] != '\0') {
+                       pr_err("padding missing at index: %d\n", i);
+                       goto fail;
+               }
+       }
+
+       /* Verify the rest is left untouched */
+       poison = 6 - chars - terminator - pad;

instead of "6", use "sizeof(buf)".

lib/test_strscpy.c line 80

Quoted 2 lines
lib/test_strscpy.c new file +2 -0
+       for (i = 0; i < poison; i++) {
+               index = 6 - 1 - i; /* Check from the end back */

Same.

Quoted 56 lines
lib/test_strscpy.c new file +56 -0
+               if (buf[index] != POISON) {
+                       pr_err("poison value missing at index: %d\n", i);
+                       goto fail;
+               }
+       }
+
+       return;
+fail:
+       pr_info("%s(%d, '%s', %d, %d, %d, %d)\n", __func__,
+               count, src, expected, chars, terminator, pad);
+       failed_tests++;
+}
+
+static void __init test_fully(void)
+{
+       /* do_test(count, src, expected, chars, terminator, pad) */
+
+       do_test(0, "a", -E2BIG, 0, 0, 0);
+       do_test(0, "", -E2BIG, 0, 0, 0);
+
+       do_test(1, "a", -E2BIG, 0, 1, 0);
+       do_test(1, "", 0, 0, 1, 0);
+
+       do_test(2, "ab", -E2BIG, 1, 1, 0);
+       do_test(2, "a", 1, 1, 1, 0);
+       do_test(2, "", 0, 0, 1, 1);
+
+       do_test(3, "abc", -E2BIG, 2, 1, 0);
+       do_test(3, "ab", 2, 2, 1, 0);
+       do_test(3, "a", 1, 1, 1, 1);
+       do_test(3, "", 0, 0, 1, 2);
+
+       do_test(4, "abcd", -E2BIG, 3, 1, 0);
+       do_test(4, "abc", 3, 3, 1, 0);
+       do_test(4, "ab", 2, 2, 1, 1);
+       do_test(4, "a", 1, 1, 1, 2);
+       do_test(4, "", 0, 0, 1, 3);
+}
+
+static void __init test_basic(void)
+{
+       char buf[6];
+       int written;
+
+       memset(buf, 'a', sizeof(buf));
+
+       total_tests++;
+       written = strscpy_pad(buf, "bb", 4);
+       if (written != 2)
+               failed_tests++;
+
+       /* Correctly copied */
+       total_tests++;
+       if (buf[0] != 'b' || buf[1] != 'b')
+               failed_tests++;
+

lib/test_strscpy.c line 146

Quoted 10 lines
lib/test_strscpy.c new file +10 -0
+       /* Correctly padded */
+       total_tests++;
+       if (buf[2] != '\0' || buf[3] != '\0')
+               failed_tests++;
+
+       /* Only touched what it was supposed to */
+       total_tests++;
+       if (buf[4] != 'a' || buf[5] != 'a')
+               failed_tests++;
+}

I don't think you need to keep "test_basic". Anything it tests can be rewritten in terms of do_test().

Quoted 26 lines
lib/test_strscpy.c new file +26 -0
+
+static int __init test_strscpy_init(void)
+{
+       pr_info("loaded.\n");
+
+       test_basic();
+       if (failed_tests)
+               goto out;
+
+       test_fully();
+
+out:
+       if (failed_tests == 0)
+               pr_info("all %u tests passed\n", total_tests);
+       else
+               pr_warn("failed %u out of %u tests\n", failed_tests, total_tests);
+
+       return failed_tests ? -EINVAL : 0;
+}
+module_init(test_strscpy_init);
+
+static void __exit test_strscpy_exit(void)
+{
+       pr_info("unloaded.\n");
+}
+module_exit(test_strscpy_exit);
Quoted 8 lines
Quoted 6 lines
lib/test_strscpy.c new file +3 -1
+
+MODULE_AUTHOR("Tobin C. Harding <[email protected]>");
+MODULE_LICENSE("GPL");
--

2.20.1

Otherwise, yes, looks good!

Cool, thanks. Will fix up as suggested and re-spin.

Tobin