1 // SPDX-License-Identifier: GPL-2.0
5 * Copyright (C) 1991, 1992 Linus Torvalds
9 * This file should be used only for "library" routines that may have
10 * alternative implementations on specific architectures (generally
11 * found in <asm-xx/string.h>), or get overloaded by FORTIFY_SOURCE.
12 * (Specifically, this file is built with __NO_FORTIFY.)
14 * Other helper functions should live in string_helpers.c.
18 #include <linux/bits.h>
19 #include <linux/bug.h>
20 #include <linux/ctype.h>
21 #include <linux/errno.h>
22 #include <linux/limits.h>
23 #include <linux/linkage.h>
24 #include <linux/stddef.h>
25 #include <linux/string.h>
26 #include <linux/types.h>
29 #include <asm/rwonce.h>
30 #include <asm/unaligned.h>
31 #include <asm/word-at-a-time.h>
33 #ifndef __HAVE_ARCH_STRNCASECMP
35 * strncasecmp - Case insensitive, length-limited string comparison
37 * @s2: The other string
38 * @len: the maximum number of characters to compare
40 int strncasecmp(const char *s1, const char *s2, size_t len)
42 /* Yes, Virginia, it had better be unsigned */
60 return (int)c1 - (int)c2;
62 EXPORT_SYMBOL(strncasecmp);
65 #ifndef __HAVE_ARCH_STRCASECMP
66 int strcasecmp(const char *s1, const char *s2)
73 } while (c1 == c2 && c1 != 0);
76 EXPORT_SYMBOL(strcasecmp);
79 #ifndef __HAVE_ARCH_STRCPY
80 char *strcpy(char *dest, const char *src)
84 while ((*dest++ = *src++) != '\0')
88 EXPORT_SYMBOL(strcpy);
91 #ifndef __HAVE_ARCH_STRNCPY
92 char *strncpy(char *dest, const char *src, size_t count)
97 if ((*tmp = *src) != 0)
104 EXPORT_SYMBOL(strncpy);
107 ssize_t sized_strscpy(char *dest, const char *src, size_t count)
109 const struct word_at_a_time constants = WORD_AT_A_TIME_CONSTANTS;
113 if (count == 0 || WARN_ON_ONCE(count > INT_MAX))
116 #ifdef CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS
118 * If src is unaligned, don't cross a page boundary,
119 * since we don't know if the next page is mapped.
121 if ((long)src & (sizeof(long) - 1)) {
122 size_t limit = PAGE_SIZE - ((long)src & (PAGE_SIZE - 1));
127 /* If src or dest is unaligned, don't do word-at-a-time. */
128 if (((long) dest | (long) src) & (sizeof(long) - 1))
133 * read_word_at_a_time() below may read uninitialized bytes after the
134 * trailing zero and use them in comparisons. Disable this optimization
135 * under KMSAN to prevent false positive reports.
137 if (IS_ENABLED(CONFIG_KMSAN))
140 while (max >= sizeof(unsigned long)) {
141 unsigned long c, data;
143 c = read_word_at_a_time(src+res);
144 if (has_zero(c, &data, &constants)) {
145 data = prep_zero_mask(c, data, &constants);
146 data = create_zero_mask(data);
147 *(unsigned long *)(dest+res) = c & zero_bytemask(data);
148 return res + find_zero(data);
150 *(unsigned long *)(dest+res) = c;
151 res += sizeof(unsigned long);
152 count -= sizeof(unsigned long);
153 max -= sizeof(unsigned long);
167 /* Hit buffer length without finding a NUL; force NUL-termination. */
173 EXPORT_SYMBOL(sized_strscpy);
176 * stpcpy - copy a string from src to dest returning a pointer to the new end
177 * of dest, including src's %NUL-terminator. May overrun dest.
178 * @dest: pointer to end of string being copied into. Must be large enough
180 * @src: pointer to the beginning of string being copied from. Must not overlap
183 * stpcpy differs from strcpy in a key way: the return value is a pointer
184 * to the new %NUL-terminating character in @dest. (For strcpy, the return
185 * value is a pointer to the start of @dest). This interface is considered
186 * unsafe as it doesn't perform bounds checking of the inputs. As such it's
187 * not recommended for usage. Instead, its definition is provided in case
188 * the compiler lowers other libcalls to stpcpy.
190 char *stpcpy(char *__restrict__ dest, const char *__restrict__ src);
191 char *stpcpy(char *__restrict__ dest, const char *__restrict__ src)
193 while ((*dest++ = *src++) != '\0')
197 EXPORT_SYMBOL(stpcpy);
199 #ifndef __HAVE_ARCH_STRCAT
200 char *strcat(char *dest, const char *src)
206 while ((*dest++ = *src++) != '\0')
210 EXPORT_SYMBOL(strcat);
213 #ifndef __HAVE_ARCH_STRNCAT
214 char *strncat(char *dest, const char *src, size_t count)
221 while ((*dest++ = *src++) != 0) {
230 EXPORT_SYMBOL(strncat);
233 #ifndef __HAVE_ARCH_STRLCAT
234 size_t strlcat(char *dest, const char *src, size_t count)
236 size_t dsize = strlen(dest);
237 size_t len = strlen(src);
238 size_t res = dsize + len;
240 /* This would be a bug */
241 BUG_ON(dsize >= count);
247 __builtin_memcpy(dest, src, len);
251 EXPORT_SYMBOL(strlcat);
254 #ifndef __HAVE_ARCH_STRCMP
256 * strcmp - Compare two strings
258 * @ct: Another string
260 int strcmp(const char *cs, const char *ct)
262 unsigned char c1, c2;
268 return c1 < c2 ? -1 : 1;
274 EXPORT_SYMBOL(strcmp);
277 #ifndef __HAVE_ARCH_STRNCMP
279 * strncmp - Compare two length-limited strings
281 * @ct: Another string
282 * @count: The maximum number of bytes to compare
284 int strncmp(const char *cs, const char *ct, size_t count)
286 unsigned char c1, c2;
292 return c1 < c2 ? -1 : 1;
299 EXPORT_SYMBOL(strncmp);
302 #ifndef __HAVE_ARCH_STRCHR
304 * strchr - Find the first occurrence of a character in a string
305 * @s: The string to be searched
306 * @c: The character to search for
308 * Note that the %NUL-terminator is considered part of the string, and can
311 char *strchr(const char *s, int c)
313 for (; *s != (char)c; ++s)
318 EXPORT_SYMBOL(strchr);
321 #ifndef __HAVE_ARCH_STRCHRNUL
323 * strchrnul - Find and return a character in a string, or end of string
324 * @s: The string to be searched
325 * @c: The character to search for
327 * Returns pointer to first occurrence of 'c' in s. If c is not found, then
328 * return a pointer to the null byte at the end of s.
330 char *strchrnul(const char *s, int c)
332 while (*s && *s != (char)c)
336 EXPORT_SYMBOL(strchrnul);
340 * strnchrnul - Find and return a character in a length limited string,
342 * @s: The string to be searched
343 * @count: The number of characters to be searched
344 * @c: The character to search for
346 * Returns pointer to the first occurrence of 'c' in s. If c is not found,
347 * then return a pointer to the last character of the string.
349 char *strnchrnul(const char *s, size_t count, int c)
351 while (count-- && *s && *s != (char)c)
356 #ifndef __HAVE_ARCH_STRRCHR
358 * strrchr - Find the last occurrence of a character in a string
359 * @s: The string to be searched
360 * @c: The character to search for
362 char *strrchr(const char *s, int c)
364 const char *last = NULL;
371 EXPORT_SYMBOL(strrchr);
374 #ifndef __HAVE_ARCH_STRNCHR
376 * strnchr - Find a character in a length limited string
377 * @s: The string to be searched
378 * @count: The number of characters to be searched
379 * @c: The character to search for
381 * Note that the %NUL-terminator is considered part of the string, and can
384 char *strnchr(const char *s, size_t count, int c)
394 EXPORT_SYMBOL(strnchr);
397 #ifndef __HAVE_ARCH_STRLEN
398 size_t strlen(const char *s)
402 for (sc = s; *sc != '\0'; ++sc)
406 EXPORT_SYMBOL(strlen);
409 #ifndef __HAVE_ARCH_STRNLEN
410 size_t strnlen(const char *s, size_t count)
414 for (sc = s; count-- && *sc != '\0'; ++sc)
418 EXPORT_SYMBOL(strnlen);
421 #ifndef __HAVE_ARCH_STRSPN
423 * strspn - Calculate the length of the initial substring of @s which only contain letters in @accept
424 * @s: The string to be searched
425 * @accept: The string to search for
427 size_t strspn(const char *s, const char *accept)
431 for (p = s; *p != '\0'; ++p) {
432 if (!strchr(accept, *p))
437 EXPORT_SYMBOL(strspn);
440 #ifndef __HAVE_ARCH_STRCSPN
442 * strcspn - Calculate the length of the initial substring of @s which does not contain letters in @reject
443 * @s: The string to be searched
444 * @reject: The string to avoid
446 size_t strcspn(const char *s, const char *reject)
450 for (p = s; *p != '\0'; ++p) {
451 if (strchr(reject, *p))
456 EXPORT_SYMBOL(strcspn);
459 #ifndef __HAVE_ARCH_STRPBRK
461 * strpbrk - Find the first occurrence of a set of characters
462 * @cs: The string to be searched
463 * @ct: The characters to search for
465 char *strpbrk(const char *cs, const char *ct)
469 for (sc = cs; *sc != '\0'; ++sc) {
475 EXPORT_SYMBOL(strpbrk);
478 #ifndef __HAVE_ARCH_STRSEP
480 * strsep - Split a string into tokens
481 * @s: The string to be searched
482 * @ct: The characters to search for
484 * strsep() updates @s to point after the token, ready for the next call.
486 * It returns empty tokens, too, behaving exactly like the libc function
487 * of that name. In fact, it was stolen from glibc2 and de-fancy-fied.
488 * Same semantics, slimmer shape. ;)
490 char *strsep(char **s, const char *ct)
498 end = strpbrk(sbegin, ct);
504 EXPORT_SYMBOL(strsep);
507 #ifndef __HAVE_ARCH_MEMSET
509 * memset - Fill a region of memory with the given value
510 * @s: Pointer to the start of the area.
511 * @c: The byte to fill the area with
512 * @count: The size of the area.
514 * Do not use memset() to access IO space, use memset_io() instead.
516 void *memset(void *s, int c, size_t count)
524 EXPORT_SYMBOL(memset);
527 #ifndef __HAVE_ARCH_MEMSET16
529 * memset16() - Fill a memory area with a uint16_t
530 * @s: Pointer to the start of the area.
531 * @v: The value to fill the area with
532 * @count: The number of values to store
534 * Differs from memset() in that it fills with a uint16_t instead
535 * of a byte. Remember that @count is the number of uint16_ts to
536 * store, not the number of bytes.
538 void *memset16(uint16_t *s, uint16_t v, size_t count)
546 EXPORT_SYMBOL(memset16);
549 #ifndef __HAVE_ARCH_MEMSET32
551 * memset32() - Fill a memory area with a uint32_t
552 * @s: Pointer to the start of the area.
553 * @v: The value to fill the area with
554 * @count: The number of values to store
556 * Differs from memset() in that it fills with a uint32_t instead
557 * of a byte. Remember that @count is the number of uint32_ts to
558 * store, not the number of bytes.
560 void *memset32(uint32_t *s, uint32_t v, size_t count)
568 EXPORT_SYMBOL(memset32);
571 #ifndef __HAVE_ARCH_MEMSET64
573 * memset64() - Fill a memory area with a uint64_t
574 * @s: Pointer to the start of the area.
575 * @v: The value to fill the area with
576 * @count: The number of values to store
578 * Differs from memset() in that it fills with a uint64_t instead
579 * of a byte. Remember that @count is the number of uint64_ts to
580 * store, not the number of bytes.
582 void *memset64(uint64_t *s, uint64_t v, size_t count)
590 EXPORT_SYMBOL(memset64);
593 #ifndef __HAVE_ARCH_MEMCPY
595 * memcpy - Copy one area of memory to another
596 * @dest: Where to copy to
597 * @src: Where to copy from
598 * @count: The size of the area.
600 * You should not use this function to access IO space, use memcpy_toio()
601 * or memcpy_fromio() instead.
603 void *memcpy(void *dest, const void *src, size_t count)
612 EXPORT_SYMBOL(memcpy);
615 #ifndef __HAVE_ARCH_MEMMOVE
617 * memmove - Copy one area of memory to another
618 * @dest: Where to copy to
619 * @src: Where to copy from
620 * @count: The size of the area.
622 * Unlike memcpy(), memmove() copes with overlapping areas.
624 void *memmove(void *dest, const void *src, size_t count)
644 EXPORT_SYMBOL(memmove);
647 #ifndef __HAVE_ARCH_MEMCMP
649 * memcmp - Compare two areas of memory
650 * @cs: One area of memory
651 * @ct: Another area of memory
652 * @count: The size of the area.
655 __visible int memcmp(const void *cs, const void *ct, size_t count)
657 const unsigned char *su1, *su2;
660 #ifdef CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS
661 if (count >= sizeof(unsigned long)) {
662 const unsigned long *u1 = cs;
663 const unsigned long *u2 = ct;
665 if (get_unaligned(u1) != get_unaligned(u2))
669 count -= sizeof(unsigned long);
670 } while (count >= sizeof(unsigned long));
675 for (su1 = cs, su2 = ct; 0 < count; ++su1, ++su2, count--)
676 if ((res = *su1 - *su2) != 0)
680 EXPORT_SYMBOL(memcmp);
683 #ifndef __HAVE_ARCH_BCMP
685 * bcmp - returns 0 if and only if the buffers have identical contents.
686 * @a: pointer to first buffer.
687 * @b: pointer to second buffer.
688 * @len: size of buffers.
690 * The sign or magnitude of a non-zero return value has no particular
691 * meaning, and architectures may implement their own more efficient bcmp(). So
692 * while this particular implementation is a simple (tail) call to memcmp, do
693 * not rely on anything but whether the return value is zero or non-zero.
695 int bcmp(const void *a, const void *b, size_t len)
697 return memcmp(a, b, len);
702 #ifndef __HAVE_ARCH_MEMSCAN
704 * memscan - Find a character in an area of memory.
705 * @addr: The memory area
706 * @c: The byte to search for
707 * @size: The size of the area.
709 * returns the address of the first occurrence of @c, or 1 byte past
710 * the area if @c is not found
712 void *memscan(void *addr, int c, size_t size)
714 unsigned char *p = addr;
717 if (*p == (unsigned char)c)
724 EXPORT_SYMBOL(memscan);
727 #ifndef __HAVE_ARCH_STRSTR
729 * strstr - Find the first substring in a %NUL terminated string
730 * @s1: The string to be searched
731 * @s2: The string to search for
733 char *strstr(const char *s1, const char *s2)
743 if (!memcmp(s1, s2, l2))
749 EXPORT_SYMBOL(strstr);
752 #ifndef __HAVE_ARCH_STRNSTR
754 * strnstr - Find the first substring in a length-limited string
755 * @s1: The string to be searched
756 * @s2: The string to search for
757 * @len: the maximum number of characters to search
759 char *strnstr(const char *s1, const char *s2, size_t len)
768 if (!memcmp(s1, s2, l2))
774 EXPORT_SYMBOL(strnstr);
777 #ifndef __HAVE_ARCH_MEMCHR
779 * memchr - Find a character in an area of memory.
780 * @s: The memory area
781 * @c: The byte to search for
782 * @n: The size of the area.
784 * returns the address of the first occurrence of @c, or %NULL
787 void *memchr(const void *s, int c, size_t n)
789 const unsigned char *p = s;
791 if ((unsigned char)c == *p++) {
792 return (void *)(p - 1);
797 EXPORT_SYMBOL(memchr);
800 static void *check_bytes8(const u8 *start, u8 value, unsigned int bytes)
804 return (void *)start;
812 * memchr_inv - Find an unmatching character in an area of memory.
813 * @start: The memory area
814 * @c: Find a character other than c
815 * @bytes: The size of the area.
817 * returns the address of the first character other than @c, or %NULL
818 * if the whole buffer contains just @c.
820 void *memchr_inv(const void *start, int c, size_t bytes)
824 unsigned int words, prefix;
827 return check_bytes8(start, value, bytes);
830 #if defined(CONFIG_ARCH_HAS_FAST_MULTIPLIER) && BITS_PER_LONG == 64
831 value64 *= 0x0101010101010101ULL;
832 #elif defined(CONFIG_ARCH_HAS_FAST_MULTIPLIER)
833 value64 *= 0x01010101;
834 value64 |= value64 << 32;
836 value64 |= value64 << 8;
837 value64 |= value64 << 16;
838 value64 |= value64 << 32;
841 prefix = (unsigned long)start % 8;
846 r = check_bytes8(start, value, prefix);
856 if (*(u64 *)start != value64)
857 return check_bytes8(start, value, 8);
862 return check_bytes8(start, value, bytes % 8);
864 EXPORT_SYMBOL(memchr_inv);