string/test-strnlen.c

   1 /* Test strlen functions.
   2    Copyright (C) 1999-2023 Free Software Foundation, Inc.
   3    This file is part of the GNU C Library.
   4
   5    The GNU C Library is free software; you can redistribute it and/or
   6    modify it under the terms of the GNU Lesser General Public
   7    License as published by the Free Software Foundation; either
   8    version 2.1 of the License, or (at your option) any later version.
   9
  10    The GNU C Library is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13    Lesser General Public License for more details.
  14
  15    You should have received a copy of the GNU Lesser General Public
  16    License along with the GNU C Library; if not, see
  17    <https://www.gnu.org/licenses/>.  */
  18
  19 #define TEST_MAIN
  20 #ifndef WIDE
  21 # define TEST_NAME "strnlen"
  22 #else
  23 # define TEST_NAME "wcsnlen"
  24 #endif /* !WIDE */
  25 #include "test-string.h"
  26
  27 #ifndef WIDE
  28 # define STRNLEN strnlen
  29 # define MEMSET memset
  30 # define CHAR char
  31 # define BIG_CHAR CHAR_MAX
  32 # define MIDDLE_CHAR 127
  33 # define SIMPLE_STRNLEN simple_strnlen
  34 #else
  35 # include <wchar.h>
  36 # define STRNLEN wcsnlen
  37 # define MEMSET wmemset
  38 # define CHAR wchar_t
  39 # define BIG_CHAR WCHAR_MAX
  40 # define MIDDLE_CHAR 1121
  41 # define SIMPLE_STRNLEN simple_wcsnlen
  42 #endif /* !WIDE */
  43
  44 typedef size_t (*proto_t) (const CHAR *, size_t);
  45
  46 IMPL (STRNLEN, 1)
  47
  48 /* Naive implementation to verify results.  */
  49 size_t
  50 SIMPLE_STRNLEN (const CHAR *s, size_t maxlen)
  51 {
  52   size_t i;
  53
  54   for (i = 0; i < maxlen && s[i]; ++i);
  55   return i;
  56 }
  57
  58 static void
  59 do_one_test (impl_t *impl, const CHAR *s, size_t maxlen, size_t exp_len)
  60 {
  61   size_t len = CALL (impl, s, maxlen);
  62   if (len != exp_len)
  63     {
  64       error (0, 0, "Wrong result in function %s %zd %zd", impl->name,
  65              len, exp_len);
  66       ret = 1;
  67       return;
  68     }
  69 }
  70
  71 static void
  72 do_test (size_t align, size_t len, size_t maxlen, int max_char)
  73 {
  74   size_t i;
  75
  76   align &= (getpagesize () / sizeof (CHAR) - 1);
  77   if ((align + len) * sizeof (CHAR) >= page_size)
  78     return;
  79
  80   CHAR *buf = (CHAR *) (buf1);
  81
  82   for (i = 0; i < len; ++i)
  83     buf[align + i] = 1 + 11111 * i % max_char;
  84   buf[align + len] = 0;
  85
  86   FOR_EACH_IMPL (impl, 0)
  87     do_one_test (impl, (CHAR *) (buf + align), maxlen, MIN (len, maxlen));
  88 }
  89
  90 static void
  91 do_overflow_tests (void)
  92 {
  93   size_t i, j, al_idx, repeats, len;
  94   const size_t one = 1;
  95   uintptr_t buf_addr = (uintptr_t) buf1;
  96   const size_t alignments[] = { 0, 1, 7, 9, 31, 33, 63, 65, 95, 97, 127, 129 };
  97
  98   for (al_idx = 0; al_idx < sizeof (alignments) / sizeof (alignments[0]);
  99        al_idx++)
 100     {
 101       for (repeats = 0; repeats < 2; ++repeats)
 102         {
 103           size_t align = repeats ? (getpagesize () - alignments[al_idx])
 104                                  : alignments[al_idx];
 105           align /= sizeof (CHAR);
 106           for (i = 0; i < 750; ++i)
 107             {
 108               do_test (align, i, SIZE_MAX, BIG_CHAR);
 109
 110               do_test (align, i, SIZE_MAX - i, BIG_CHAR);
 111               do_test (align, i, i - buf_addr, BIG_CHAR);
 112               do_test (align, i, -buf_addr - i, BIG_CHAR);
 113               do_test (align, i, SIZE_MAX - buf_addr - i, BIG_CHAR);
 114               do_test (align, i, SIZE_MAX - buf_addr + i, BIG_CHAR);
 115
 116               len = 0;
 117               for (j = 8 * sizeof (size_t) - 1; j; --j)
 118                 {
 119                   len |= one << j;
 120                   do_test (align, i, len, BIG_CHAR);
 121                   do_test (align, i, len - i, BIG_CHAR);
 122                   do_test (align, i, len + i, BIG_CHAR);
 123                   do_test (align, i, len - buf_addr - i, BIG_CHAR);
 124                   do_test (align, i, len - buf_addr + i, BIG_CHAR);
 125
 126                   do_test (align, i, ~len - i, BIG_CHAR);
 127                   do_test (align, i, ~len + i, BIG_CHAR);
 128                   do_test (align, i, ~len - buf_addr - i, BIG_CHAR);
 129                   do_test (align, i, ~len - buf_addr + i, BIG_CHAR);
 130
 131                   do_test (align, i, -buf_addr, BIG_CHAR);
 132                   do_test (align, i, j - buf_addr, BIG_CHAR);
 133                   do_test (align, i, -buf_addr - j, BIG_CHAR);
 134                 }
 135             }
 136         }
 137     }
 138 }
 139
 140 static void
 141 do_random_tests (void)
 142 {
 143   size_t i, j, n, align, len;
 144   CHAR *p = (CHAR *) (buf1 + page_size - 512 * sizeof (CHAR));
 145
 146   for (n = 0; n < ITERATIONS; n++)
 147     {
 148       align = random () & 15;
 149       len = random () & 511;
 150       if (len + align > 510)
 151         len = 511 - align - (random () & 7);
 152       j = len + align + 64;
 153       if (j > 512)
 154         j = 512;
 155
 156       for (i = 0; i < j; i++)
 157         {
 158           if (i == len + align)
 159             p[i] = 0;
 160           else
 161             {
 162               p[i] = random () & 255;
 163               if (i >= align && i < len + align && !p[i])
 164                 p[i] = (random () & 127) + 1;
 165             }
 166         }
 167
 168       FOR_EACH_IMPL (impl, 1)
 169         {
 170           if (len > 0
 171               && CALL (impl, (CHAR *) (p + align), len - 1) != len - 1)
 172             {
 173               error (0, 0, "Iteration %zd (limited) - wrong result in function %s (%zd) %zd != %zd, p %p",
 174                      n, impl->name, align,
 175                      CALL (impl, (CHAR *) (p + align), len - 1), len - 1, p);
 176               ret = 1;
 177             }
 178           if (CALL (impl, (CHAR *) (p + align), len) != len)
 179             {
 180               error (0, 0, "Iteration %zd (exact) - wrong result in function %s (%zd) %zd != %zd, p %p",
 181                      n, impl->name, align,
 182                      CALL (impl, (CHAR *) (p + align), len), len, p);
 183               ret = 1;
 184             }
 185           if (CALL (impl, (CHAR *) (p + align), len + 1) != len)
 186             {
 187               error (0, 0, "Iteration %zd (long) - wrong result in function %s (%zd) %zd != %zd, p %p",
 188                      n, impl->name, align,
 189                      CALL (impl, (CHAR *) (p + align), len + 1), len, p);
 190               ret = 1;
 191             }
 192         }
 193     }
 194 }
 195
 196 /* Tests meant to unveil fail on implementation that does not access bytes
 197    around the page boundary accordingly.  */
 198 static void
 199 do_page_tests (void)
 200 {
 201   size_t i, exp_len, start_offset, offset;
 202   /* Calculate the null character offset.  */
 203   size_t last_offset = (page_size / sizeof (CHAR)) - 1;
 204
 205   CHAR *s = (CHAR *) buf2;
 206   MEMSET (s, 65, (last_offset - 1));
 207   s[last_offset] = 0;
 208
 209   /* Place short strings ending at page boundary.  */
 210   offset = last_offset;
 211   for (i = 0; i < 128; i++)
 212     {
 213       /* Decrease offset to stress several sizes and alignments.  */
 214       offset--;
 215       exp_len = last_offset - offset;
 216       FOR_EACH_IMPL (impl, 0)
 217         {
 218           /* Varies maxlen value to cover the cases where it is:
 219                - larger than length;
 220                - slightly greater than length;
 221                - equal to length;
 222                - slightly less than length.  */
 223           do_one_test (impl, (CHAR *) (s + offset), page_size, exp_len);
 224           do_one_test (impl, (CHAR *) (s + offset), exp_len + 1, exp_len);
 225           do_one_test (impl, (CHAR *) (s + offset), exp_len, exp_len);
 226           if (exp_len > 0)
 227             do_one_test (impl, (CHAR *) (s + offset), exp_len - 1, exp_len - 1);
 228         }
 229     }
 230
 231   /* Place long strings ending at page boundary.  */
 232   start_offset = (last_offset + 1) / 2;
 233   for (i = 0; i < 64; ++i)
 234     {
 235       /* Increase offset to stress several alignments.  */
 236       offset = start_offset + i;
 237       if (offset >= (last_offset + 1))
 238         break;
 239       exp_len = last_offset - offset;
 240       FOR_EACH_IMPL (impl, 0)
 241         {
 242           /* Checks only for maxlen much larger than length because smaller
 243              values are already covered in do_random_tests function.  */
 244           do_one_test (impl, (CHAR *) (s + offset), page_size, exp_len);
 245         }
 246     }
 247 }
 248
 249 /* Tests meant to unveil fail on implementations that access bytes
 250    beyond the maxium length.  */
 251
 252 static void
 253 do_page_2_tests (void)
 254 {
 255   size_t i, exp_len, offset;
 256   size_t last_offset = page_size / sizeof (CHAR);
 257
 258   CHAR *s = (CHAR *) buf2;
 259   MEMSET (s, 65, last_offset);
 260
 261   /* Place short strings ending at page boundary without the null
 262      byte.  */
 263   offset = last_offset;
 264   for (i = 0; i < 128; i++)
 265     {
 266       /* Decrease offset to stress several sizes and alignments.  */
 267       offset--;
 268       exp_len = last_offset - offset;
 269       FOR_EACH_IMPL (impl, 0)
 270         {
 271           /* If an implementation goes beyond EXP_LEN, it will trigger
 272              the segfault.  */
 273           do_one_test (impl, (CHAR *) (s + offset), exp_len, exp_len);
 274         }
 275     }
 276 }
 277
 278 int
 279 test_main (void)
 280 {
 281   size_t i, length, char_per_page;
 282
 283   test_init ();
 284
 285   printf ("%20s", "");
 286   FOR_EACH_IMPL (impl, 0)
 287     printf ("\t%s", impl->name);
 288   putchar ('\n');
 289
 290   for (i = 1; i < 8; ++i)
 291     {
 292       do_test (0, i, i - 1, MIDDLE_CHAR);
 293       do_test (0, i, i, MIDDLE_CHAR);
 294       do_test (0, i, i + 1, MIDDLE_CHAR);
 295     }
 296
 297   for (i = 1; i < 8; ++i)
 298     {
 299       do_test (i, i, i - 1, MIDDLE_CHAR);
 300       do_test (i, i, i, MIDDLE_CHAR);
 301       do_test (i, i, i + 1, MIDDLE_CHAR);
 302     }
 303
 304   for (i = 2; i <= 10; ++i)
 305     {
 306       do_test (0, 1 << i, 5000, MIDDLE_CHAR);
 307       do_test (1, 1 << i, 5000, MIDDLE_CHAR);
 308     }
 309
 310   for (i = 1; i < 8; ++i)
 311     do_test (0, i, 5000, BIG_CHAR);
 312
 313   for (i = 1; i < 8; ++i)
 314     do_test (i, i, 5000, BIG_CHAR);
 315
 316   for (i = 2; i <= 10; ++i)
 317     {
 318       do_test (0, 1 << i, 5000, BIG_CHAR);
 319       do_test (1, 1 << i, 5000, BIG_CHAR);
 320     }
 321
 322   char_per_page = getpagesize () / sizeof (CHAR);
 323
 324   for (i = 0; i <= 127; i++)
 325     for (length = i; length <= 512; length++)
 326       {
 327         do_test (i, length, 512, BIG_CHAR);
 328         do_test (char_per_page - i, length, 512, BIG_CHAR);
 329       }
 330
 331   do_random_tests ();
 332   do_page_tests ();
 333   do_page_2_tests ();
 334   do_overflow_tests ();
 335   return ret;
 336 }
 337
 338 #include <support/test-driver.c>