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..
15 * - Added strsep() which will replace strtok() soon (because strsep() is
16 * reentrant and should be faster). Use only strsep() in new code, please.
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().
176 * Return: The number of characters copied (not including the trailing
177 * %NUL) or -E2BIG if the destination buffer wasn't big enough.
179 ssize_t strscpy(char *dest, const char *src, size_t count)
181 const struct word_at_a_time constants = WORD_AT_A_TIME_CONSTANTS;
188 #ifdef CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS
190 * If src is unaligned, don't cross a page boundary,
191 * since we don't know if the next page is mapped.
193 if ((long)src & (sizeof(long) - 1)) {
194 size_t limit = PAGE_SIZE - ((long)src & (PAGE_SIZE - 1));
199 /* If src or dest is unaligned, don't do word-at-a-time. */
200 if (((long) dest | (long) src) & (sizeof(long) - 1))
204 while (max >= sizeof(unsigned long)) {
205 unsigned long c, data;
207 c = read_word_at_a_time(src+res);
208 if (has_zero(c, &data, &constants)) {
209 data = prep_zero_mask(c, data, &constants);
210 data = create_zero_mask(data);
211 *(unsigned long *)(dest+res) = c & zero_bytemask(data);
212 return res + find_zero(data);
214 *(unsigned long *)(dest+res) = c;
215 res += sizeof(unsigned long);
216 count -= sizeof(unsigned long);
217 max -= sizeof(unsigned long);
231 /* Hit buffer length without finding a NUL; force NUL-termination. */
237 EXPORT_SYMBOL(strscpy);
241 * strscpy_pad() - Copy a C-string into a sized buffer
242 * @dest: Where to copy the string to
243 * @src: Where to copy the string from
244 * @count: Size of destination buffer
246 * Copy the string, or as much of it as fits, into the dest buffer. The
247 * behavior is undefined if the string buffers overlap. The destination
248 * buffer is always %NUL terminated, unless it's zero-sized.
250 * If the source string is shorter than the destination buffer, zeros
251 * the tail of the destination buffer.
253 * For full explanation of why you may want to consider using the
254 * 'strscpy' functions please see the function docstring for strscpy().
256 * Return: The number of characters copied (not including the trailing
257 * %NUL) or -E2BIG if the destination buffer wasn't big enough.
259 ssize_t strscpy_pad(char *dest, const char *src, size_t count)
263 written = strscpy(dest, src, count);
264 if (written < 0 || written == count - 1)
267 memset(dest + written + 1, 0, count - written - 1);
271 EXPORT_SYMBOL(strscpy_pad);
273 #ifndef __HAVE_ARCH_STRCAT
275 * strcat - Append one %NUL-terminated string to another
276 * @dest: The string to be appended to
277 * @src: The string to append to it
280 char *strcat(char *dest, const char *src)
286 while ((*dest++ = *src++) != '\0')
290 EXPORT_SYMBOL(strcat);
293 #ifndef __HAVE_ARCH_STRNCAT
295 * strncat - Append a length-limited, C-string to another
296 * @dest: The string to be appended to
297 * @src: The string to append to it
298 * @count: The maximum numbers of bytes to copy
300 * Note that in contrast to strncpy(), strncat() ensures the result is
303 char *strncat(char *dest, const char *src, size_t count)
310 while ((*dest++ = *src++) != 0) {
319 EXPORT_SYMBOL(strncat);
322 #ifndef __HAVE_ARCH_STRLCAT
324 * strlcat - Append a length-limited, C-string to another
325 * @dest: The string to be appended to
326 * @src: The string to append to it
327 * @count: The size of the destination buffer.
329 size_t strlcat(char *dest, const char *src, size_t count)
331 size_t dsize = strlen(dest);
332 size_t len = strlen(src);
333 size_t res = dsize + len;
335 /* This would be a bug */
336 BUG_ON(dsize >= count);
342 memcpy(dest, src, len);
346 EXPORT_SYMBOL(strlcat);
349 #ifndef __HAVE_ARCH_STRCMP
351 * strcmp - Compare two strings
353 * @ct: Another string
356 int strcmp(const char *cs, const char *ct)
358 unsigned char c1, c2;
364 return c1 < c2 ? -1 : 1;
370 EXPORT_SYMBOL(strcmp);
373 #ifndef __HAVE_ARCH_STRNCMP
375 * strncmp - Compare two length-limited strings
377 * @ct: Another string
378 * @count: The maximum number of bytes to compare
380 int strncmp(const char *cs, const char *ct, size_t count)
382 unsigned char c1, c2;
388 return c1 < c2 ? -1 : 1;
395 EXPORT_SYMBOL(strncmp);
398 #ifndef __HAVE_ARCH_STRCHR
400 * strchr - Find the first occurrence of a character in a string
401 * @s: The string to be searched
402 * @c: The character to search for
404 char *strchr(const char *s, int c)
406 for (; *s != (char)c; ++s)
411 EXPORT_SYMBOL(strchr);
414 #ifndef __HAVE_ARCH_STRCHRNUL
416 * strchrnul - Find and return a character in a string, or end of string
417 * @s: The string to be searched
418 * @c: The character to search for
420 * Returns pointer to first occurrence of 'c' in s. If c is not found, then
421 * return a pointer to the null byte at the end of s.
423 char *strchrnul(const char *s, int c)
425 while (*s && *s != (char)c)
429 EXPORT_SYMBOL(strchrnul);
432 #ifndef __HAVE_ARCH_STRRCHR
434 * strrchr - Find the last occurrence of a character in a string
435 * @s: The string to be searched
436 * @c: The character to search for
438 char *strrchr(const char *s, int c)
440 const char *last = NULL;
447 EXPORT_SYMBOL(strrchr);
450 #ifndef __HAVE_ARCH_STRNCHR
452 * strnchr - Find a character in a length limited string
453 * @s: The string to be searched
454 * @count: The number of characters to be searched
455 * @c: The character to search for
457 char *strnchr(const char *s, size_t count, int c)
459 for (; count-- && *s != '\0'; ++s)
464 EXPORT_SYMBOL(strnchr);
468 * skip_spaces - Removes leading whitespace from @str.
469 * @str: The string to be stripped.
471 * Returns a pointer to the first non-whitespace character in @str.
473 char *skip_spaces(const char *str)
475 while (isspace(*str))
479 EXPORT_SYMBOL(skip_spaces);
482 * strim - Removes leading and trailing whitespace from @s.
483 * @s: The string to be stripped.
485 * Note that the first trailing whitespace is replaced with a %NUL-terminator
486 * in the given string @s. Returns a pointer to the first non-whitespace
499 while (end >= s && isspace(*end))
503 return skip_spaces(s);
505 EXPORT_SYMBOL(strim);
507 #ifndef __HAVE_ARCH_STRLEN
509 * strlen - Find the length of a string
510 * @s: The string to be sized
512 size_t strlen(const char *s)
516 for (sc = s; *sc != '\0'; ++sc)
520 EXPORT_SYMBOL(strlen);
523 #ifndef __HAVE_ARCH_STRNLEN
525 * strnlen - Find the length of a length-limited string
526 * @s: The string to be sized
527 * @count: The maximum number of bytes to search
529 size_t strnlen(const char *s, size_t count)
533 for (sc = s; count-- && *sc != '\0'; ++sc)
537 EXPORT_SYMBOL(strnlen);
540 #ifndef __HAVE_ARCH_STRSPN
542 * strspn - Calculate the length of the initial substring of @s which only contain letters in @accept
543 * @s: The string to be searched
544 * @accept: The string to search for
546 size_t strspn(const char *s, const char *accept)
552 for (p = s; *p != '\0'; ++p) {
553 for (a = accept; *a != '\0'; ++a) {
564 EXPORT_SYMBOL(strspn);
567 #ifndef __HAVE_ARCH_STRCSPN
569 * strcspn - Calculate the length of the initial substring of @s which does not contain letters in @reject
570 * @s: The string to be searched
571 * @reject: The string to avoid
573 size_t strcspn(const char *s, const char *reject)
579 for (p = s; *p != '\0'; ++p) {
580 for (r = reject; *r != '\0'; ++r) {
588 EXPORT_SYMBOL(strcspn);
591 #ifndef __HAVE_ARCH_STRPBRK
593 * strpbrk - Find the first occurrence of a set of characters
594 * @cs: The string to be searched
595 * @ct: The characters to search for
597 char *strpbrk(const char *cs, const char *ct)
599 const char *sc1, *sc2;
601 for (sc1 = cs; *sc1 != '\0'; ++sc1) {
602 for (sc2 = ct; *sc2 != '\0'; ++sc2) {
609 EXPORT_SYMBOL(strpbrk);
612 #ifndef __HAVE_ARCH_STRSEP
614 * strsep - Split a string into tokens
615 * @s: The string to be searched
616 * @ct: The characters to search for
618 * strsep() updates @s to point after the token, ready for the next call.
620 * It returns empty tokens, too, behaving exactly like the libc function
621 * of that name. In fact, it was stolen from glibc2 and de-fancy-fied.
622 * Same semantics, slimmer shape. ;)
624 char *strsep(char **s, const char *ct)
632 end = strpbrk(sbegin, ct);
638 EXPORT_SYMBOL(strsep);
642 * sysfs_streq - return true if strings are equal, modulo trailing newline
644 * @s2: another string
646 * This routine returns true iff two strings are equal, treating both
647 * NUL and newline-then-NUL as equivalent string terminations. It's
648 * geared for use with sysfs input strings, which generally terminate
649 * with newlines but are compared against values without newlines.
651 bool sysfs_streq(const char *s1, const char *s2)
653 while (*s1 && *s1 == *s2) {
660 if (!*s1 && *s2 == '\n' && !s2[1])
662 if (*s1 == '\n' && !s1[1] && !*s2)
666 EXPORT_SYMBOL(sysfs_streq);
669 * match_string - matches given string in an array
670 * @array: array of strings
671 * @n: number of strings in the array or -1 for NULL terminated arrays
672 * @string: string to match with
675 * index of a @string in the @array if matches, or %-EINVAL otherwise.
677 int match_string(const char * const *array, size_t n, const char *string)
682 for (index = 0; index < n; index++) {
686 if (!strcmp(item, string))
692 EXPORT_SYMBOL(match_string);
695 * __sysfs_match_string - matches given string in an array
696 * @array: array of strings
697 * @n: number of strings in the array or -1 for NULL terminated arrays
698 * @str: string to match with
700 * Returns index of @str in the @array or -EINVAL, just like match_string().
701 * Uses sysfs_streq instead of strcmp for matching.
703 int __sysfs_match_string(const char * const *array, size_t n, const char *str)
708 for (index = 0; index < n; index++) {
712 if (sysfs_streq(item, str))
718 EXPORT_SYMBOL(__sysfs_match_string);
720 #ifndef __HAVE_ARCH_MEMSET
722 * memset - Fill a region of memory with the given value
723 * @s: Pointer to the start of the area.
724 * @c: The byte to fill the area with
725 * @count: The size of the area.
727 * Do not use memset() to access IO space, use memset_io() instead.
729 void *memset(void *s, int c, size_t count)
737 EXPORT_SYMBOL(memset);
741 * memzero_explicit - Fill a region of memory (e.g. sensitive
742 * keying data) with 0s.
743 * @s: Pointer to the start of the area.
744 * @count: The size of the area.
746 * Note: usually using memset() is just fine (!), but in cases
747 * where clearing out _local_ data at the end of a scope is
748 * necessary, memzero_explicit() should be used instead in
749 * order to prevent the compiler from optimising away zeroing.
751 * memzero_explicit() doesn't need an arch-specific version as
752 * it just invokes the one of memset() implicitly.
754 void memzero_explicit(void *s, size_t count)
759 EXPORT_SYMBOL(memzero_explicit);
761 #ifndef __HAVE_ARCH_MEMSET16
763 * memset16() - Fill a memory area with a uint16_t
764 * @s: Pointer to the start of the area.
765 * @v: The value to fill the area with
766 * @count: The number of values to store
768 * Differs from memset() in that it fills with a uint16_t instead
769 * of a byte. Remember that @count is the number of uint16_ts to
770 * store, not the number of bytes.
772 void *memset16(uint16_t *s, uint16_t v, size_t count)
780 EXPORT_SYMBOL(memset16);
783 #ifndef __HAVE_ARCH_MEMSET32
785 * memset32() - Fill a memory area with a uint32_t
786 * @s: Pointer to the start of the area.
787 * @v: The value to fill the area with
788 * @count: The number of values to store
790 * Differs from memset() in that it fills with a uint32_t instead
791 * of a byte. Remember that @count is the number of uint32_ts to
792 * store, not the number of bytes.
794 void *memset32(uint32_t *s, uint32_t v, size_t count)
802 EXPORT_SYMBOL(memset32);
805 #ifndef __HAVE_ARCH_MEMSET64
807 * memset64() - Fill a memory area with a uint64_t
808 * @s: Pointer to the start of the area.
809 * @v: The value to fill the area with
810 * @count: The number of values to store
812 * Differs from memset() in that it fills with a uint64_t instead
813 * of a byte. Remember that @count is the number of uint64_ts to
814 * store, not the number of bytes.
816 void *memset64(uint64_t *s, uint64_t v, size_t count)
824 EXPORT_SYMBOL(memset64);
827 #ifndef __HAVE_ARCH_MEMCPY
829 * memcpy - Copy one area of memory to another
830 * @dest: Where to copy to
831 * @src: Where to copy from
832 * @count: The size of the area.
834 * You should not use this function to access IO space, use memcpy_toio()
835 * or memcpy_fromio() instead.
837 void *memcpy(void *dest, const void *src, size_t count)
846 EXPORT_SYMBOL(memcpy);
849 #ifndef __HAVE_ARCH_MEMMOVE
851 * memmove - Copy one area of memory to another
852 * @dest: Where to copy to
853 * @src: Where to copy from
854 * @count: The size of the area.
856 * Unlike memcpy(), memmove() copes with overlapping areas.
858 void *memmove(void *dest, const void *src, size_t count)
878 EXPORT_SYMBOL(memmove);
881 #ifndef __HAVE_ARCH_MEMCMP
883 * memcmp - Compare two areas of memory
884 * @cs: One area of memory
885 * @ct: Another area of memory
886 * @count: The size of the area.
889 __visible int memcmp(const void *cs, const void *ct, size_t count)
891 const unsigned char *su1, *su2;
894 for (su1 = cs, su2 = ct; 0 < count; ++su1, ++su2, count--)
895 if ((res = *su1 - *su2) != 0)
899 EXPORT_SYMBOL(memcmp);
902 #ifndef __HAVE_ARCH_BCMP
904 * bcmp - returns 0 if and only if the buffers have identical contents.
905 * @a: pointer to first buffer.
906 * @b: pointer to second buffer.
907 * @len: size of buffers.
909 * The sign or magnitude of a non-zero return value has no particular
910 * meaning, and architectures may implement their own more efficient bcmp(). So
911 * while this particular implementation is a simple (tail) call to memcmp, do
912 * not rely on anything but whether the return value is zero or non-zero.
915 int bcmp(const void *a, const void *b, size_t len)
917 return memcmp(a, b, len);
922 #ifndef __HAVE_ARCH_MEMSCAN
924 * memscan - Find a character in an area of memory.
925 * @addr: The memory area
926 * @c: The byte to search for
927 * @size: The size of the area.
929 * returns the address of the first occurrence of @c, or 1 byte past
930 * the area if @c is not found
932 void *memscan(void *addr, int c, size_t size)
934 unsigned char *p = addr;
944 EXPORT_SYMBOL(memscan);
947 #ifndef __HAVE_ARCH_STRSTR
949 * strstr - Find the first substring in a %NUL terminated string
950 * @s1: The string to be searched
951 * @s2: The string to search for
953 char *strstr(const char *s1, const char *s2)
963 if (!memcmp(s1, s2, l2))
969 EXPORT_SYMBOL(strstr);
972 #ifndef __HAVE_ARCH_STRNSTR
974 * strnstr - Find the first substring in a length-limited string
975 * @s1: The string to be searched
976 * @s2: The string to search for
977 * @len: the maximum number of characters to search
979 char *strnstr(const char *s1, const char *s2, size_t len)
988 if (!memcmp(s1, s2, l2))
994 EXPORT_SYMBOL(strnstr);
997 #ifndef __HAVE_ARCH_MEMCHR
999 * memchr - Find a character in an area of memory.
1000 * @s: The memory area
1001 * @c: The byte to search for
1002 * @n: The size of the area.
1004 * returns the address of the first occurrence of @c, or %NULL
1005 * if @c is not found
1007 void *memchr(const void *s, int c, size_t n)
1009 const unsigned char *p = s;
1011 if ((unsigned char)c == *p++) {
1012 return (void *)(p - 1);
1017 EXPORT_SYMBOL(memchr);
1020 static void *check_bytes8(const u8 *start, u8 value, unsigned int bytes)
1023 if (*start != value)
1024 return (void *)start;
1032 * memchr_inv - Find an unmatching character in an area of memory.
1033 * @start: The memory area
1034 * @c: Find a character other than c
1035 * @bytes: The size of the area.
1037 * returns the address of the first character other than @c, or %NULL
1038 * if the whole buffer contains just @c.
1040 void *memchr_inv(const void *start, int c, size_t bytes)
1044 unsigned int words, prefix;
1047 return check_bytes8(start, value, bytes);
1050 #if defined(CONFIG_ARCH_HAS_FAST_MULTIPLIER) && BITS_PER_LONG == 64
1051 value64 *= 0x0101010101010101ULL;
1052 #elif defined(CONFIG_ARCH_HAS_FAST_MULTIPLIER)
1053 value64 *= 0x01010101;
1054 value64 |= value64 << 32;
1056 value64 |= value64 << 8;
1057 value64 |= value64 << 16;
1058 value64 |= value64 << 32;
1061 prefix = (unsigned long)start % 8;
1065 prefix = 8 - prefix;
1066 r = check_bytes8(start, value, prefix);
1076 if (*(u64 *)start != value64)
1077 return check_bytes8(start, value, 8);
1082 return check_bytes8(start, value, bytes % 8);
1084 EXPORT_SYMBOL(memchr_inv);
1087 * strreplace - Replace all occurrences of character in string.
1088 * @s: The string to operate on.
1089 * @old: The character being replaced.
1090 * @new: The character @old is replaced with.
1092 * Returns pointer to the nul byte at the end of @s.
1094 char *strreplace(char *s, char old, char new)
1101 EXPORT_SYMBOL(strreplace);
1103 void fortify_panic(const char *name)
1105 pr_emerg("detected buffer overflow in %s\n", name);
1108 EXPORT_SYMBOL(fortify_panic);