Before changing anything about memcpy(), memmove(), and memset(), add
run-time tests to check basic behaviors for any regressions.

Signed-off-by: Kees Cook <keesc...@chromium.org>
---
 lib/Kconfig.debug |   3 +
 lib/Makefile      |   1 +
 lib/test_memcpy.c | 285 ++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 289 insertions(+)
 create mode 100644 lib/test_memcpy.c

diff --git a/lib/Kconfig.debug b/lib/Kconfig.debug
index 4654e838d68b..d315db9702de 100644
--- a/lib/Kconfig.debug
+++ b/lib/Kconfig.debug
@@ -2220,6 +2220,9 @@ config TEST_XARRAY
 config TEST_OVERFLOW
        tristate "Test check_*_overflow() functions at runtime"
 
+config TEST_MEMCPY
+       tristate "Test memcpy*(), memmove*(), and memset*() functions at 
runtime"
+
 config TEST_RHASHTABLE
        tristate "Perform selftest on resizable hash table"
        help
diff --git a/lib/Makefile b/lib/Makefile
index 40b4bf0bc847..083a19336e20 100644
--- a/lib/Makefile
+++ b/lib/Makefile
@@ -77,6 +77,7 @@ obj-$(CONFIG_TEST_MIN_HEAP) += test_min_heap.o
 obj-$(CONFIG_TEST_LKM) += test_module.o
 obj-$(CONFIG_TEST_VMALLOC) += test_vmalloc.o
 obj-$(CONFIG_TEST_OVERFLOW) += test_overflow.o
+obj-$(CONFIG_TEST_MEMCPY) += test_memcpy.o
 obj-$(CONFIG_TEST_RHASHTABLE) += test_rhashtable.o
 obj-$(CONFIG_TEST_SORT) += test_sort.o
 obj-$(CONFIG_TEST_USER_COPY) += test_user_copy.o
diff --git a/lib/test_memcpy.c b/lib/test_memcpy.c
new file mode 100644
index 000000000000..7c64120a68a9
--- /dev/null
+++ b/lib/test_memcpy.c
@@ -0,0 +1,285 @@
+// SPDX-License-Identifier: GPL-2.0
+/*
+ * Test cases for memcpy(), memmove(), and memset().
+ */
+#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
+
+#include <linux/device.h>
+#include <linux/init.h>
+#include <linux/kernel.h>
+#include <linux/mm.h>
+#include <linux/module.h>
+#include <linux/overflow.h>
+#include <linux/slab.h>
+#include <linux/types.h>
+#include <linux/vmalloc.h>
+
+struct some_bytes {
+       union {
+               u8 data[32];
+               struct {
+                       u32 one;
+                       u16 two;
+                       u8  three;
+                       /* 1 byte hole */
+                       u32 four[4];
+               };
+       };
+};
+
+#define check(instance, v) do {        \
+       int i;  \
+       BUILD_BUG_ON(sizeof(instance.data) != 32);      \
+       for (i = 0; i < sizeof(instance.data); i++) {   \
+               if (instance.data[i] != v) {    \
+                       pr_err("line %d: '%s' not initialized to 0x%02x @ %d 
(saw 0x%02x)\n", \
+                               __LINE__, #instance, v, i, instance.data[i]);   
\
+                       return 1;       \
+               }       \
+       }       \
+} while (0)
+
+#define compare(name, one, two) do { \
+       int i; \
+       BUILD_BUG_ON(sizeof(one) != sizeof(two)); \
+       for (i = 0; i < sizeof(one); i++) {     \
+               if (one.data[i] != two.data[i]) {       \
+                       pr_err("line %d: %s.data[%d] (0x%02x) != %s.data[%d] 
(0x%02x)\n", \
+                               __LINE__, #one, i, one.data[i], \
+                               #two, i, two.data[i]);  \
+                       return 1;       \
+               }       \
+       }       \
+       pr_info("ok: " TEST_OP "() " name "\n");        \
+} while (0)
+
+static int __init test_memcpy(void)
+{
+#define TEST_OP "memcpy"
+       struct some_bytes control = {
+               .data = { 0x20, 0x20, 0x20, 0x20, 0x20, 0x20, 0x20, 0x20,
+                         0x20, 0x20, 0x20, 0x20, 0x20, 0x20, 0x20, 0x20,
+                         0x20, 0x20, 0x20, 0x20, 0x20, 0x20, 0x20, 0x20,
+                         0x20, 0x20, 0x20, 0x20, 0x20, 0x20, 0x20, 0x20,
+                       },
+       };
+       struct some_bytes zero = { };
+       struct some_bytes middle = {
+               .data = { 0x20, 0x20, 0x20, 0x20, 0x20, 0x20, 0x20, 0x20,
+                         0x20, 0x20, 0x20, 0x20, 0x00, 0x00, 0x00, 0x00,
+                         0x00, 0x00, 0x00, 0x20, 0x20, 0x20, 0x20, 0x20,
+                         0x20, 0x20, 0x20, 0x20, 0x20, 0x20, 0x20, 0x20,
+                       },
+       };
+       struct some_bytes three = {
+               .data = { 0x00, 0x20, 0x20, 0x20, 0x20, 0x20, 0x20, 0x20,
+                         0x20, 0x00, 0x00, 0x20, 0x20, 0x20, 0x20, 0x20,
+                         0x20, 0x20, 0x20, 0x20, 0x20, 0x20, 0x20, 0x20,
+                         0x20, 0x20, 0x20, 0x20, 0x20, 0x20, 0x20, 0x20,
+                       },
+       };
+       struct some_bytes dest = { };
+       int count;
+       u8 *ptr;
+
+       /* Verify static initializers. */
+       check(control, 0x20);
+       check(zero, 0);
+       compare("static initializers", dest, zero);
+
+       /* Verify assignment. */
+       dest = control;
+       compare("direct assignment", dest, control);
+
+       /* Verify complete overwrite. */
+       memcpy(dest.data, zero.data, sizeof(dest.data));
+       compare("complete overwrite", dest, zero);
+
+       /* Verify middle overwrite. */
+       dest = control;
+       memcpy(dest.data + 12, zero.data, 7);
+       compare("middle overwrite", dest, middle);
+
+       /* Verify argument side-effects aren't repeated. */
+       dest = control;
+       ptr = dest.data;
+       count = 1;
+       memcpy(ptr++, zero.data, count++);
+       ptr += 8;
+       memcpy(ptr++, zero.data, count++);
+       compare("argument side-effects", dest, three);
+
+       return 0;
+#undef TEST_OP
+}
+
+static int __init test_memmove(void)
+{
+#define TEST_OP "memmove"
+       struct some_bytes control = {
+               .data = { 0x99, 0x99, 0x99, 0x99, 0x99, 0x99, 0x99, 0x99,
+                         0x99, 0x99, 0x99, 0x99, 0x99, 0x99, 0x99, 0x99,
+                         0x99, 0x99, 0x99, 0x99, 0x99, 0x99, 0x99, 0x99,
+                         0x99, 0x99, 0x99, 0x99, 0x99, 0x99, 0x99, 0x99,
+                       },
+       };
+       struct some_bytes zero = { };
+       struct some_bytes middle = {
+               .data = { 0x99, 0x99, 0x99, 0x99, 0x99, 0x99, 0x99, 0x99,
+                         0x99, 0x99, 0x99, 0x99, 0x00, 0x00, 0x00, 0x00,
+                         0x00, 0x00, 0x00, 0x99, 0x99, 0x99, 0x99, 0x99,
+                         0x99, 0x99, 0x99, 0x99, 0x99, 0x99, 0x99, 0x99,
+                       },
+       };
+       struct some_bytes five = {
+               .data = { 0x00, 0x00, 0x99, 0x99, 0x99, 0x99, 0x99, 0x99,
+                         0x99, 0x99, 0x00, 0x00, 0x00, 0x99, 0x99, 0x99,
+                         0x99, 0x99, 0x99, 0x99, 0x99, 0x99, 0x99, 0x99,
+                         0x99, 0x99, 0x99, 0x99, 0x99, 0x99, 0x99, 0x99,
+                       },
+       };
+       struct some_bytes overlap = {
+               .data = { 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07,
+                         0x08, 0x09, 0x0A, 0x0B, 0x0C, 0x0D, 0x0E, 0x0F,
+                         0x99, 0x99, 0x99, 0x99, 0x99, 0x99, 0x99, 0x99,
+                         0x99, 0x99, 0x99, 0x99, 0x99, 0x99, 0x99, 0x99,
+                       },
+       };
+       struct some_bytes overlap_expected = {
+               .data = { 0x00, 0x01, 0x00, 0x01, 0x02, 0x03, 0x04, 0x07,
+                         0x08, 0x09, 0x0A, 0x0B, 0x0C, 0x0D, 0x0E, 0x0F,
+                         0x99, 0x99, 0x99, 0x99, 0x99, 0x99, 0x99, 0x99,
+                         0x99, 0x99, 0x99, 0x99, 0x99, 0x99, 0x99, 0x99,
+                       },
+       };
+       struct some_bytes dest = { };
+       int count;
+       u8 *ptr;
+
+       /* Verify static initializers. */
+       check(control, 0x99);
+       check(zero, 0);
+       compare("static initializers", zero, dest);
+
+       /* Verify assignment. */
+       dest = control;
+       compare("direct assignment", dest, control);
+
+       /* Verify complete overwrite. */
+       memmove(dest.data, zero.data, sizeof(dest.data));
+       compare("complete overwrite", dest, zero);
+
+       /* Verify middle overwrite. */
+       dest = control;
+       memmove(dest.data + 12, zero.data, 7);
+       compare("middle overwrite", dest, middle);
+
+       /* Verify argument side-effects aren't repeated. */
+       dest = control;
+       ptr = dest.data;
+       count = 2;
+       memmove(ptr++, zero.data, count++);
+       ptr += 9;
+       memmove(ptr++, zero.data, count++);
+       compare("argument side-effects", dest, five);
+
+       /* Verify overlapping overwrite is correct. */
+       ptr = &overlap.data[2];
+       memmove(ptr, overlap.data, 5);
+       compare("overlapping write", overlap, overlap_expected);
+
+       return 0;
+#undef TEST_OP
+}
+
+static int __init test_memset(void)
+{
+#define TEST_OP "memset"
+       struct some_bytes control = {
+               .data = { 0x30, 0x30, 0x30, 0x30, 0x30, 0x30, 0x30, 0x30,
+                         0x30, 0x30, 0x30, 0x30, 0x30, 0x30, 0x30, 0x30,
+                         0x30, 0x30, 0x30, 0x30, 0x30, 0x30, 0x30, 0x30,
+                         0x30, 0x30, 0x30, 0x30, 0x30, 0x30, 0x30, 0x30,
+                       },
+       };
+       struct some_bytes complete = {
+               .data = { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
+                         0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
+                         0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
+                         0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
+                       },
+       };
+       struct some_bytes middle = {
+               .data = { 0x30, 0x30, 0x30, 0x30, 0x31, 0x31, 0x31, 0x31,
+                         0x31, 0x31, 0x31, 0x31, 0x31, 0x31, 0x31, 0x31,
+                         0x31, 0x31, 0x31, 0x31, 0x30, 0x30, 0x30, 0x30,
+                         0x30, 0x30, 0x30, 0x30, 0x30, 0x30, 0x30, 0x30,
+                       },
+       };
+       struct some_bytes three = {
+               .data = { 0x60, 0x30, 0x30, 0x30, 0x30, 0x30, 0x30, 0x30,
+                         0x30, 0x61, 0x61, 0x30, 0x30, 0x30, 0x30, 0x30,
+                         0x30, 0x30, 0x30, 0x30, 0x30, 0x30, 0x30, 0x30,
+                         0x30, 0x30, 0x30, 0x30, 0x30, 0x30, 0x30, 0x30,
+                       },
+       };
+       struct some_bytes dest = { };
+       int count, value;
+       u8 *ptr;
+
+       /* Verify static initializers. */
+       check(control, 0x30);
+       check(dest, 0);
+
+       /* Verify assignment. */
+       dest = control;
+       compare("direct assignment", dest, control);
+
+       /* Verify complete overwrite. */
+       memset(dest.data, 0xff, sizeof(dest.data));
+       compare("complete overwrite", dest, complete);
+
+       /* Verify middle overwrite. */
+       dest = control;
+       memset(dest.data + 4, 0x31, 16);
+       compare("middle overwrite", dest, middle);
+
+       /* Verify argument side-effects aren't repeated. */
+       dest = control;
+       ptr = dest.data;
+       value = 0x60;
+       count = 1;
+       memset(ptr++, value++, count++);
+       ptr += 8;
+       memset(ptr++, value++, count++);
+       compare("argument side-effects", dest, three);
+
+       return 0;
+#undef TEST_OP
+}
+
+
+static int __init test_memcpy_init(void)
+{
+       int err = 0;
+
+       err |= test_memcpy();
+       err |= test_memmove();
+       err |= test_memset();
+
+       if (err) {
+               pr_warn("FAIL!\n");
+               err = -EINVAL;
+       } else {
+               pr_info("all tests passed\n");
+       }
+
+       return err;
+}
+
+static void __exit test_memcpy_exit(void)
+{ }
+
+module_init(test_memcpy_init);
+module_exit(test_memcpy_exit);
+MODULE_LICENSE("GPL");
-- 
2.30.2

Reply via email to