1 // SPDX-License-Identifier: GPL-2.0
5 * Copyright (C) 1991, 1992 Linus Torvalds
9 * stupid library routines.. The optimized versions should generally be found
10 * as inline code in <asm-xx/string.h>
12 * These are buggy as well..
14 * * Fri Jun 25 1999, Ingo Oeser <ioe@informatik.tu-chemnitz.de>
15 * - Added strsep() which will replace strtok() soon (because strsep() is
16 * reentrant and should be faster). Use only strsep() in new code, please.
18 * * Sat Feb 09 2002, Jason Thomas <jason@topic.com.au>,
19 * Matthew Hawkins <matt@mh.dropbear.id.au>
20 * - Kissed strtok() goodbye
23 #include <linux/types.h>
24 #include <linux/string.h>
25 #include <linux/ctype.h>
26 #include <linux/kernel.h>
27 #include <linux/export.h>
28 #include <linux/bug.h>
29 #include <linux/errno.h>
30 #include <linux/slab.h>
32 #include <asm/byteorder.h>
33 #include <asm/word-at-a-time.h>
36 #ifndef __HAVE_ARCH_STRNCASECMP
38 * strncasecmp - Case insensitive, length-limited string comparison
40 * @s2: The other string
41 * @len: the maximum number of characters to compare
43 int strncasecmp(const char *s1, const char *s2, size_t len)
45 /* Yes, Virginia, it had better be unsigned */
63 return (int)c1 - (int)c2;
65 EXPORT_SYMBOL(strncasecmp);
68 #ifndef __HAVE_ARCH_STRCASECMP
69 int strcasecmp(const char *s1, const char *s2)
76 } while (c1 == c2 && c1 != 0);
79 EXPORT_SYMBOL(strcasecmp);
82 #ifndef __HAVE_ARCH_STRCPY
84 * strcpy - Copy a %NUL terminated string
85 * @dest: Where to copy the string to
86 * @src: Where to copy the string from
89 char *strcpy(char *dest, const char *src)
93 while ((*dest++ = *src++) != '\0')
97 EXPORT_SYMBOL(strcpy);
100 #ifndef __HAVE_ARCH_STRNCPY
102 * strncpy - Copy a length-limited, C-string
103 * @dest: Where to copy the string to
104 * @src: Where to copy the string from
105 * @count: The maximum number of bytes to copy
107 * The result is not %NUL-terminated if the source exceeds
110 * In the case where the length of @src is less than that of
111 * count, the remainder of @dest will be padded with %NUL.
114 char *strncpy(char *dest, const char *src, size_t count)
119 if ((*tmp = *src) != 0)
126 EXPORT_SYMBOL(strncpy);
129 #ifndef __HAVE_ARCH_STRLCPY
131 * strlcpy - Copy a C-string into a sized buffer
132 * @dest: Where to copy the string to
133 * @src: Where to copy the string from
134 * @size: size of destination buffer
136 * Compatible with ``*BSD``: the result is always a valid
137 * NUL-terminated string that fits in the buffer (unless,
138 * of course, the buffer size is zero). It does not pad
139 * out the result like strncpy() does.
141 size_t strlcpy(char *dest, const char *src, size_t size)
143 size_t ret = strlen(src);
146 size_t len = (ret >= size) ? size - 1 : ret;
147 memcpy(dest, src, len);
152 EXPORT_SYMBOL(strlcpy);
155 #ifndef __HAVE_ARCH_STRSCPY
157 * strscpy - Copy a C-string into a sized buffer
158 * @dest: Where to copy the string to
159 * @src: Where to copy the string from
160 * @count: Size of destination buffer
162 * Copy the string, or as much of it as fits, into the dest buffer. The
163 * behavior is undefined if the string buffers overlap. The destination
164 * buffer is always NUL terminated, unless it's zero-sized.
166 * Preferred to strlcpy() since the API doesn't require reading memory
167 * from the src string beyond the specified "count" bytes, and since
168 * the return value is easier to error-check than strlcpy()'s.
169 * In addition, the implementation is robust to the string changing out
170 * from underneath it, unlike the current strlcpy() implementation.
172 * Preferred to strncpy() since it always returns a valid string, and
173 * doesn't unnecessarily force the tail of the destination buffer to be
174 * zeroed. If zeroing is desired please use strscpy_pad().
177 * * The number of characters copied (not including the trailing %NUL)
178 * * -E2BIG if count is 0 or @src was truncated.
180 ssize_t strscpy(char *dest, const char *src, size_t count)
182 const struct word_at_a_time constants = WORD_AT_A_TIME_CONSTANTS;
186 if (count == 0 || WARN_ON_ONCE(count > INT_MAX))
189 #ifdef CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS
191 * If src is unaligned, don't cross a page boundary,
192 * since we don't know if the next page is mapped.
194 if ((long)src & (sizeof(long) - 1)) {
195 size_t limit = PAGE_SIZE - ((long)src & (PAGE_SIZE - 1));
200 /* If src or dest is unaligned, don't do word-at-a-time. */
201 if (((long) dest | (long) src) & (sizeof(long) - 1))
205 while (max >= sizeof(unsigned long)) {
206 unsigned long c, data;
208 c = read_word_at_a_time(src+res);
209 if (has_zero(c, &data, &constants)) {
210 data = prep_zero_mask(c, data, &constants);
211 data = create_zero_mask(data);
212 *(unsigned long *)(dest+res) = c & zero_bytemask(data);
213 return res + find_zero(data);
215 *(unsigned long *)(dest+res) = c;
216 res += sizeof(unsigned long);
217 count -= sizeof(unsigned long);
218 max -= sizeof(unsigned long);
232 /* Hit buffer length without finding a NUL; force NUL-termination. */
238 EXPORT_SYMBOL(strscpy);
242 * strscpy_pad() - Copy a C-string into a sized buffer
243 * @dest: Where to copy the string to
244 * @src: Where to copy the string from
245 * @count: Size of destination buffer
247 * Copy the string, or as much of it as fits, into the dest buffer. The
248 * behavior is undefined if the string buffers overlap. The destination
249 * buffer is always %NUL terminated, unless it's zero-sized.
251 * If the source string is shorter than the destination buffer, zeros
252 * the tail of the destination buffer.
254 * For full explanation of why you may want to consider using the
255 * 'strscpy' functions please see the function docstring for strscpy().
258 * * The number of characters copied (not including the trailing %NUL)
259 * * -E2BIG if count is 0 or @src was truncated.
261 ssize_t strscpy_pad(char *dest, const char *src, size_t count)
265 written = strscpy(dest, src, count);
266 if (written < 0 || written == count - 1)
269 memset(dest + written + 1, 0, count - written - 1);
273 EXPORT_SYMBOL(strscpy_pad);
275 #ifndef __HAVE_ARCH_STRCAT
277 * strcat - Append one %NUL-terminated string to another
278 * @dest: The string to be appended to
279 * @src: The string to append to it
282 char *strcat(char *dest, const char *src)
288 while ((*dest++ = *src++) != '\0')
292 EXPORT_SYMBOL(strcat);
295 #ifndef __HAVE_ARCH_STRNCAT
297 * strncat - Append a length-limited, C-string to another
298 * @dest: The string to be appended to
299 * @src: The string to append to it
300 * @count: The maximum numbers of bytes to copy
302 * Note that in contrast to strncpy(), strncat() ensures the result is
305 char *strncat(char *dest, const char *src, size_t count)
312 while ((*dest++ = *src++) != 0) {
321 EXPORT_SYMBOL(strncat);
324 #ifndef __HAVE_ARCH_STRLCAT
326 * strlcat - Append a length-limited, C-string to another
327 * @dest: The string to be appended to
328 * @src: The string to append to it
329 * @count: The size of the destination buffer.
331 size_t strlcat(char *dest, const char *src, size_t count)
333 size_t dsize = strlen(dest);
334 size_t len = strlen(src);
335 size_t res = dsize + len;
337 /* This would be a bug */
338 BUG_ON(dsize >= count);
344 memcpy(dest, src, len);
348 EXPORT_SYMBOL(strlcat);
351 #ifndef __HAVE_ARCH_STRCMP
353 * strcmp - Compare two strings
355 * @ct: Another string
358 int strcmp(const char *cs, const char *ct)
360 unsigned char c1, c2;
366 return c1 < c2 ? -1 : 1;
372 EXPORT_SYMBOL(strcmp);
375 #ifndef __HAVE_ARCH_STRNCMP
377 * strncmp - Compare two length-limited strings
379 * @ct: Another string
380 * @count: The maximum number of bytes to compare
382 int strncmp(const char *cs, const char *ct, size_t count)
384 unsigned char c1, c2;
390 return c1 < c2 ? -1 : 1;
397 EXPORT_SYMBOL(strncmp);
400 #ifndef __HAVE_ARCH_STRCHR
402 * strchr - Find the first occurrence of a character in a string
403 * @s: The string to be searched
404 * @c: The character to search for
406 * Note that the %NUL-terminator is considered part of the string, and can
409 char *strchr(const char *s, int c)
411 for (; *s != (char)c; ++s)
416 EXPORT_SYMBOL(strchr);
419 #ifndef __HAVE_ARCH_STRCHRNUL
421 * strchrnul - Find and return a character in a string, or end of string
422 * @s: The string to be searched
423 * @c: The character to search for
425 * Returns pointer to first occurrence of 'c' in s. If c is not found, then
426 * return a pointer to the null byte at the end of s.
428 char *strchrnul(const char *s, int c)
430 while (*s && *s != (char)c)
434 EXPORT_SYMBOL(strchrnul);
438 * strnchrnul - Find and return a character in a length limited string,
440 * @s: The string to be searched
441 * @count: The number of characters to be searched
442 * @c: The character to search for
444 * Returns pointer to the first occurrence of 'c' in s. If c is not found,
445 * then return a pointer to the last character of the string.
447 char *strnchrnul(const char *s, size_t count, int c)
449 while (count-- && *s && *s != (char)c)
454 #ifndef __HAVE_ARCH_STRRCHR
456 * strrchr - Find the last occurrence of a character in a string
457 * @s: The string to be searched
458 * @c: The character to search for
460 char *strrchr(const char *s, int c)
462 const char *last = NULL;
469 EXPORT_SYMBOL(strrchr);
472 #ifndef __HAVE_ARCH_STRNCHR
474 * strnchr - Find a character in a length limited string
475 * @s: The string to be searched
476 * @count: The number of characters to be searched
477 * @c: The character to search for
479 * Note that the %NUL-terminator is considered part of the string, and can
482 char *strnchr(const char *s, size_t count, int c)
492 EXPORT_SYMBOL(strnchr);
496 * skip_spaces - Removes leading whitespace from @str.
497 * @str: The string to be stripped.
499 * Returns a pointer to the first non-whitespace character in @str.
501 char *skip_spaces(const char *str)
503 while (isspace(*str))
507 EXPORT_SYMBOL(skip_spaces);
510 * strim - Removes leading and trailing whitespace from @s.
511 * @s: The string to be stripped.
513 * Note that the first trailing whitespace is replaced with a %NUL-terminator
514 * in the given string @s. Returns a pointer to the first non-whitespace
527 while (end >= s && isspace(*end))
531 return skip_spaces(s);
533 EXPORT_SYMBOL(strim);
535 #ifndef __HAVE_ARCH_STRLEN
537 * strlen - Find the length of a string
538 * @s: The string to be sized
540 size_t strlen(const char *s)
544 for (sc = s; *sc != '\0'; ++sc)
548 EXPORT_SYMBOL(strlen);
551 #ifndef __HAVE_ARCH_STRNLEN
553 * strnlen - Find the length of a length-limited string
554 * @s: The string to be sized
555 * @count: The maximum number of bytes to search
557 size_t strnlen(const char *s, size_t count)
561 for (sc = s; count-- && *sc != '\0'; ++sc)
565 EXPORT_SYMBOL(strnlen);
568 #ifndef __HAVE_ARCH_STRSPN
570 * strspn - Calculate the length of the initial substring of @s which only contain letters in @accept
571 * @s: The string to be searched
572 * @accept: The string to search for
574 size_t strspn(const char *s, const char *accept)
580 for (p = s; *p != '\0'; ++p) {
581 for (a = accept; *a != '\0'; ++a) {
592 EXPORT_SYMBOL(strspn);
595 #ifndef __HAVE_ARCH_STRCSPN
597 * strcspn - Calculate the length of the initial substring of @s which does not contain letters in @reject
598 * @s: The string to be searched
599 * @reject: The string to avoid
601 size_t strcspn(const char *s, const char *reject)
607 for (p = s; *p != '\0'; ++p) {
608 for (r = reject; *r != '\0'; ++r) {
616 EXPORT_SYMBOL(strcspn);
619 #ifndef __HAVE_ARCH_STRPBRK
621 * strpbrk - Find the first occurrence of a set of characters
622 * @cs: The string to be searched
623 * @ct: The characters to search for
625 char *strpbrk(const char *cs, const char *ct)
627 const char *sc1, *sc2;
629 for (sc1 = cs; *sc1 != '\0'; ++sc1) {
630 for (sc2 = ct; *sc2 != '\0'; ++sc2) {
637 EXPORT_SYMBOL(strpbrk);
640 #ifndef __HAVE_ARCH_STRSEP
642 * strsep - Split a string into tokens
643 * @s: The string to be searched
644 * @ct: The characters to search for
646 * strsep() updates @s to point after the token, ready for the next call.
648 * It returns empty tokens, too, behaving exactly like the libc function
649 * of that name. In fact, it was stolen from glibc2 and de-fancy-fied.
650 * Same semantics, slimmer shape. ;)
652 char *strsep(char **s, const char *ct)
660 end = strpbrk(sbegin, ct);
666 EXPORT_SYMBOL(strsep);
670 * sysfs_streq - return true if strings are equal, modulo trailing newline
672 * @s2: another string
674 * This routine returns true iff two strings are equal, treating both
675 * NUL and newline-then-NUL as equivalent string terminations. It's
676 * geared for use with sysfs input strings, which generally terminate
677 * with newlines but are compared against values without newlines.
679 bool sysfs_streq(const char *s1, const char *s2)
681 while (*s1 && *s1 == *s2) {
688 if (!*s1 && *s2 == '\n' && !s2[1])
690 if (*s1 == '\n' && !s1[1] && !*s2)
694 EXPORT_SYMBOL(sysfs_streq);
697 * match_string - matches given string in an array
698 * @array: array of strings
699 * @n: number of strings in the array or -1 for NULL terminated arrays
700 * @string: string to match with
702 * This routine will look for a string in an array of strings up to the
703 * n-th element in the array or until the first NULL element.
705 * Historically the value of -1 for @n, was used to search in arrays that
706 * are NULL terminated. However, the function does not make a distinction
707 * when finishing the search: either @n elements have been compared OR
708 * the first NULL element was found.
711 * index of a @string in the @array if matches, or %-EINVAL otherwise.
713 int match_string(const char * const *array, size_t n, const char *string)
718 for (index = 0; index < n; index++) {
722 if (!strcmp(item, string))
728 EXPORT_SYMBOL(match_string);
731 * __sysfs_match_string - matches given string in an array
732 * @array: array of strings
733 * @n: number of strings in the array or -1 for NULL terminated arrays
734 * @str: string to match with
736 * Returns index of @str in the @array or -EINVAL, just like match_string().
737 * Uses sysfs_streq instead of strcmp for matching.
739 * This routine will look for a string in an array of strings up to the
740 * n-th element in the array or until the first NULL element.
742 * Historically the value of -1 for @n, was used to search in arrays that
743 * are NULL terminated. However, the function does not make a distinction
744 * when finishing the search: either @n elements have been compared OR
745 * the first NULL element was found.
747 int __sysfs_match_string(const char * const *array, size_t n, const char *str)
752 for (index = 0; index < n; index++) {
756 if (sysfs_streq(item, str))
762 EXPORT_SYMBOL(__sysfs_match_string);
764 #ifndef __HAVE_ARCH_MEMSET
766 * memset - Fill a region of memory with the given value
767 * @s: Pointer to the start of the area.
768 * @c: The byte to fill the area with
769 * @count: The size of the area.
771 * Do not use memset() to access IO space, use memset_io() instead.
773 void *memset(void *s, int c, size_t count)
781 EXPORT_SYMBOL(memset);
784 #ifndef __HAVE_ARCH_MEMSET16
786 * memset16() - Fill a memory area with a uint16_t
787 * @s: Pointer to the start of the area.
788 * @v: The value to fill the area with
789 * @count: The number of values to store
791 * Differs from memset() in that it fills with a uint16_t instead
792 * of a byte. Remember that @count is the number of uint16_ts to
793 * store, not the number of bytes.
795 void *memset16(uint16_t *s, uint16_t v, size_t count)
803 EXPORT_SYMBOL(memset16);
806 #ifndef __HAVE_ARCH_MEMSET32
808 * memset32() - Fill a memory area with a uint32_t
809 * @s: Pointer to the start of the area.
810 * @v: The value to fill the area with
811 * @count: The number of values to store
813 * Differs from memset() in that it fills with a uint32_t instead
814 * of a byte. Remember that @count is the number of uint32_ts to
815 * store, not the number of bytes.
817 void *memset32(uint32_t *s, uint32_t v, size_t count)
825 EXPORT_SYMBOL(memset32);
828 #ifndef __HAVE_ARCH_MEMSET64
830 * memset64() - Fill a memory area with a uint64_t
831 * @s: Pointer to the start of the area.
832 * @v: The value to fill the area with
833 * @count: The number of values to store
835 * Differs from memset() in that it fills with a uint64_t instead
836 * of a byte. Remember that @count is the number of uint64_ts to
837 * store, not the number of bytes.
839 void *memset64(uint64_t *s, uint64_t v, size_t count)
847 EXPORT_SYMBOL(memset64);
850 #ifndef __HAVE_ARCH_MEMCPY
852 * memcpy - Copy one area of memory to another
853 * @dest: Where to copy to
854 * @src: Where to copy from
855 * @count: The size of the area.
857 * You should not use this function to access IO space, use memcpy_toio()
858 * or memcpy_fromio() instead.
860 void *memcpy(void *dest, const void *src, size_t count)
869 EXPORT_SYMBOL(memcpy);
872 #ifndef __HAVE_ARCH_MEMMOVE
874 * memmove - Copy one area of memory to another
875 * @dest: Where to copy to
876 * @src: Where to copy from
877 * @count: The size of the area.
879 * Unlike memcpy(), memmove() copes with overlapping areas.
881 void *memmove(void *dest, const void *src, size_t count)
901 EXPORT_SYMBOL(memmove);
904 #ifndef __HAVE_ARCH_MEMCMP
906 * memcmp - Compare two areas of memory
907 * @cs: One area of memory
908 * @ct: Another area of memory
909 * @count: The size of the area.
912 __visible int memcmp(const void *cs, const void *ct, size_t count)
914 const unsigned char *su1, *su2;
917 for (su1 = cs, su2 = ct; 0 < count; ++su1, ++su2, count--)
918 if ((res = *su1 - *su2) != 0)
922 EXPORT_SYMBOL(memcmp);
925 #ifndef __HAVE_ARCH_BCMP
927 * bcmp - returns 0 if and only if the buffers have identical contents.
928 * @a: pointer to first buffer.
929 * @b: pointer to second buffer.
930 * @len: size of buffers.
932 * The sign or magnitude of a non-zero return value has no particular
933 * meaning, and architectures may implement their own more efficient bcmp(). So
934 * while this particular implementation is a simple (tail) call to memcmp, do
935 * not rely on anything but whether the return value is zero or non-zero.
938 int bcmp(const void *a, const void *b, size_t len)
940 return memcmp(a, b, len);
945 #ifndef __HAVE_ARCH_MEMSCAN
947 * memscan - Find a character in an area of memory.
948 * @addr: The memory area
949 * @c: The byte to search for
950 * @size: The size of the area.
952 * returns the address of the first occurrence of @c, or 1 byte past
953 * the area if @c is not found
955 void *memscan(void *addr, int c, size_t size)
957 unsigned char *p = addr;
967 EXPORT_SYMBOL(memscan);
970 #ifndef __HAVE_ARCH_STRSTR
972 * strstr - Find the first substring in a %NUL terminated string
973 * @s1: The string to be searched
974 * @s2: The string to search for
976 char *strstr(const char *s1, const char *s2)
986 if (!memcmp(s1, s2, l2))
992 EXPORT_SYMBOL(strstr);
995 #ifndef __HAVE_ARCH_STRNSTR
997 * strnstr - Find the first substring in a length-limited string
998 * @s1: The string to be searched
999 * @s2: The string to search for
1000 * @len: the maximum number of characters to search
1002 char *strnstr(const char *s1, const char *s2, size_t len)
1011 if (!memcmp(s1, s2, l2))
1017 EXPORT_SYMBOL(strnstr);
1020 #ifndef __HAVE_ARCH_MEMCHR
1022 * memchr - Find a character in an area of memory.
1023 * @s: The memory area
1024 * @c: The byte to search for
1025 * @n: The size of the area.
1027 * returns the address of the first occurrence of @c, or %NULL
1028 * if @c is not found
1030 void *memchr(const void *s, int c, size_t n)
1032 const unsigned char *p = s;
1034 if ((unsigned char)c == *p++) {
1035 return (void *)(p - 1);
1040 EXPORT_SYMBOL(memchr);
1043 static void *check_bytes8(const u8 *start, u8 value, unsigned int bytes)
1046 if (*start != value)
1047 return (void *)start;
1055 * memchr_inv - Find an unmatching character in an area of memory.
1056 * @start: The memory area
1057 * @c: Find a character other than c
1058 * @bytes: The size of the area.
1060 * returns the address of the first character other than @c, or %NULL
1061 * if the whole buffer contains just @c.
1063 void *memchr_inv(const void *start, int c, size_t bytes)
1067 unsigned int words, prefix;
1070 return check_bytes8(start, value, bytes);
1073 #if defined(CONFIG_ARCH_HAS_FAST_MULTIPLIER) && BITS_PER_LONG == 64
1074 value64 *= 0x0101010101010101ULL;
1075 #elif defined(CONFIG_ARCH_HAS_FAST_MULTIPLIER)
1076 value64 *= 0x01010101;
1077 value64 |= value64 << 32;
1079 value64 |= value64 << 8;
1080 value64 |= value64 << 16;
1081 value64 |= value64 << 32;
1084 prefix = (unsigned long)start % 8;
1088 prefix = 8 - prefix;
1089 r = check_bytes8(start, value, prefix);
1099 if (*(u64 *)start != value64)
1100 return check_bytes8(start, value, 8);
1105 return check_bytes8(start, value, bytes % 8);
1107 EXPORT_SYMBOL(memchr_inv);
1110 * strreplace - Replace all occurrences of character in string.
1111 * @s: The string to operate on.
1112 * @old: The character being replaced.
1113 * @new: The character @old is replaced with.
1115 * Returns pointer to the nul byte at the end of @s.
1117 char *strreplace(char *s, char old, char new)
1124 EXPORT_SYMBOL(strreplace);
1126 void fortify_panic(const char *name)
1128 pr_emerg("detected buffer overflow in %s\n", name);
1131 EXPORT_SYMBOL(fortify_panic);