0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 1) // SPDX-License-Identifier: GPL-2.0+
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 2)
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 3) #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 4)
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 5) #include <linux/string.h>
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 6)
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 7) #include "../tools/testing/selftests/kselftest_module.h"
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 8)
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 9) /*
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 10) * Kernel module for testing 'strscpy' family of functions.
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 11) */
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 12)
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 13) KSTM_MODULE_GLOBALS();
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 14)
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 15) /*
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 16) * tc() - Run a specific test case.
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 17) * @src: Source string, argument to strscpy_pad()
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 18) * @count: Size of destination buffer, argument to strscpy_pad()
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 19) * @expected: Expected return value from call to strscpy_pad()
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 20) * @terminator: 1 if there should be a terminating null byte 0 otherwise.
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 21) * @chars: Number of characters from the src string expected to be
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 22) * written to the dst buffer.
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 23) * @pad: Number of pad characters expected (in the tail of dst buffer).
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 24) * (@pad does not include the null terminator byte.)
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 25) *
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 26) * Calls strscpy_pad() and verifies the return value and state of the
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 27) * destination buffer after the call returns.
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 28) */
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 29) static int __init tc(char *src, int count, int expected,
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 30) int chars, int terminator, int pad)
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 31) {
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 32) int nr_bytes_poison;
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 33) int max_expected;
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 34) int max_count;
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 35) int written;
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 36) char buf[6];
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 37) int index, i;
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 38) const char POISON = 'z';
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 39)
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 40) total_tests++;
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 41)
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 42) if (!src) {
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 43) pr_err("null source string not supported\n");
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 44) return -1;
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 45) }
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 46)
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 47) memset(buf, POISON, sizeof(buf));
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 48) /* Future proofing test suite, validate args */
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 49) max_count = sizeof(buf) - 2; /* Space for null and to verify overflow */
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 50) max_expected = count - 1; /* Space for the null */
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 51) if (count > max_count) {
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 52) pr_err("count (%d) is too big (%d) ... aborting", count, max_count);
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 53) return -1;
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 54) }
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 55) if (expected > max_expected) {
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 56) pr_warn("expected (%d) is bigger than can possibly be returned (%d)",
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 57) expected, max_expected);
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 58) }
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 59)
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 60) written = strscpy_pad(buf, src, count);
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 61) if ((written) != (expected)) {
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 62) pr_err("%d != %d (written, expected)\n", written, expected);
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 63) goto fail;
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 64) }
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 65)
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 66) if (count && written == -E2BIG) {
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 67) if (strncmp(buf, src, count - 1) != 0) {
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 68) pr_err("buffer state invalid for -E2BIG\n");
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 69) goto fail;
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 70) }
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 71) if (buf[count - 1] != '\0') {
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 72) pr_err("too big string is not null terminated correctly\n");
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 73) goto fail;
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 74) }
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 75) }
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 76)
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 77) for (i = 0; i < chars; i++) {
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 78) if (buf[i] != src[i]) {
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 79) pr_err("buf[i]==%c != src[i]==%c\n", buf[i], src[i]);
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 80) goto fail;
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 81) }
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 82) }
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 83)
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 84) if (terminator) {
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 85) if (buf[count - 1] != '\0') {
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 86) pr_err("string is not null terminated correctly\n");
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 87) goto fail;
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 88) }
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 89) }
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 90)
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 91) for (i = 0; i < pad; i++) {
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 92) index = chars + terminator + i;
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 93) if (buf[index] != '\0') {
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 94) pr_err("padding missing at index: %d\n", i);
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 95) goto fail;
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 96) }
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 97) }
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 98)
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 99) nr_bytes_poison = sizeof(buf) - chars - terminator - pad;
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 100) for (i = 0; i < nr_bytes_poison; i++) {
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 101) index = sizeof(buf) - 1 - i; /* Check from the end back */
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 102) if (buf[index] != POISON) {
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 103) pr_err("poison value missing at index: %d\n", i);
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 104) goto fail;
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 105) }
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 106) }
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 107)
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 108) return 0;
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 109) fail:
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 110) failed_tests++;
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 111) return -1;
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 112) }
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 113)
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 114) static void __init selftest(void)
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 115) {
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 116) /*
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 117) * tc() uses a destination buffer of size 6 and needs at
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 118) * least 2 characters spare (one for null and one to check for
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 119) * overflow). This means we should only call tc() with
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 120) * strings up to a maximum of 4 characters long and 'count'
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 121) * should not exceed 4. To test with longer strings increase
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 122) * the buffer size in tc().
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 123) */
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 124)
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 125) /* tc(src, count, expected, chars, terminator, pad) */
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 126) KSTM_CHECK_ZERO(tc("a", 0, -E2BIG, 0, 0, 0));
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 127) KSTM_CHECK_ZERO(tc("", 0, -E2BIG, 0, 0, 0));
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 128)
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 129) KSTM_CHECK_ZERO(tc("a", 1, -E2BIG, 0, 1, 0));
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 130) KSTM_CHECK_ZERO(tc("", 1, 0, 0, 1, 0));
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 131)
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 132) KSTM_CHECK_ZERO(tc("ab", 2, -E2BIG, 1, 1, 0));
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 133) KSTM_CHECK_ZERO(tc("a", 2, 1, 1, 1, 0));
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 134) KSTM_CHECK_ZERO(tc("", 2, 0, 0, 1, 1));
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 135)
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 136) KSTM_CHECK_ZERO(tc("abc", 3, -E2BIG, 2, 1, 0));
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 137) KSTM_CHECK_ZERO(tc("ab", 3, 2, 2, 1, 0));
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 138) KSTM_CHECK_ZERO(tc("a", 3, 1, 1, 1, 1));
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 139) KSTM_CHECK_ZERO(tc("", 3, 0, 0, 1, 2));
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 140)
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 141) KSTM_CHECK_ZERO(tc("abcd", 4, -E2BIG, 3, 1, 0));
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 142) KSTM_CHECK_ZERO(tc("abc", 4, 3, 3, 1, 0));
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 143) KSTM_CHECK_ZERO(tc("ab", 4, 2, 2, 1, 1));
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 144) KSTM_CHECK_ZERO(tc("a", 4, 1, 1, 1, 2));
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 145) KSTM_CHECK_ZERO(tc("", 4, 0, 0, 1, 3));
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 146) }
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 147)
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 148) KSTM_MODULE_LOADERS(test_strscpy);
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 149) MODULE_AUTHOR("Tobin C. Harding <tobin@kernel.org>");
0b0600c8c97ab (Tobin C. Harding 2019-04-05 12:58:59 +1100 150) MODULE_LICENSE("GPL");
VisionFive2 Linux kernel
StarFive Tech Linux Kernel for VisionFive (JH7110) boards (mirror)
More than 9999 Commits
32 Branches
54 Tags