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>
31 #include <asm/byteorder.h>
32 #include <asm/word-at-a-time.h>
35 #ifndef __HAVE_ARCH_STRNCASECMP
37 * strncasecmp - Case insensitive, length-limited string comparison
39 * @s2: The other string
40 * @len: the maximum number of characters to compare
42 int strncasecmp(const char *s1
, const char *s2
, size_t len
)
44 /* Yes, Virginia, it had better be unsigned */
62 return (int)c1
- (int)c2
;
64 EXPORT_SYMBOL(strncasecmp
);
67 #ifndef __HAVE_ARCH_STRCASECMP
68 int strcasecmp(const char *s1
, const char *s2
)
75 } while (c1
== c2
&& c1
!= 0);
78 EXPORT_SYMBOL(strcasecmp
);
81 #ifndef __HAVE_ARCH_STRCPY
83 * strcpy - Copy a %NUL terminated string
84 * @dest: Where to copy the string to
85 * @src: Where to copy the string from
88 char *strcpy(char *dest
, const char *src
)
92 while ((*dest
++ = *src
++) != '\0')
96 EXPORT_SYMBOL(strcpy
);
99 #ifndef __HAVE_ARCH_STRNCPY
101 * strncpy - Copy a length-limited, C-string
102 * @dest: Where to copy the string to
103 * @src: Where to copy the string from
104 * @count: The maximum number of bytes to copy
106 * The result is not %NUL-terminated if the source exceeds
109 * In the case where the length of @src is less than that of
110 * count, the remainder of @dest will be padded with %NUL.
113 char *strncpy(char *dest
, const char *src
, size_t count
)
118 if ((*tmp
= *src
) != 0)
125 EXPORT_SYMBOL(strncpy
);
128 #ifndef __HAVE_ARCH_STRLCPY
130 * strlcpy - Copy a C-string into a sized buffer
131 * @dest: Where to copy the string to
132 * @src: Where to copy the string from
133 * @size: size of destination buffer
135 * Compatible with ``*BSD``: the result is always a valid
136 * NUL-terminated string that fits in the buffer (unless,
137 * of course, the buffer size is zero). It does not pad
138 * out the result like strncpy() does.
140 size_t strlcpy(char *dest
, const char *src
, size_t size
)
142 size_t ret
= strlen(src
);
145 size_t len
= (ret
>= size
) ? size
- 1 : ret
;
146 memcpy(dest
, src
, len
);
151 EXPORT_SYMBOL(strlcpy
);
154 #ifndef __HAVE_ARCH_STRSCPY
156 * strscpy - Copy a C-string into a sized buffer
157 * @dest: Where to copy the string to
158 * @src: Where to copy the string from
159 * @count: Size of destination buffer
161 * Copy the string, or as much of it as fits, into the dest buffer.
162 * The routine returns the number of characters copied (not including
163 * the trailing NUL) or -E2BIG if the destination buffer wasn't big enough.
164 * The behavior is undefined if the string buffers overlap.
165 * The destination buffer is always NUL terminated, unless it's zero-sized.
167 * Preferred to strlcpy() since the API doesn't require reading memory
168 * from the src string beyond the specified "count" bytes, and since
169 * the return value is easier to error-check than strlcpy()'s.
170 * In addition, the implementation is robust to the string changing out
171 * from underneath it, unlike the current strlcpy() implementation.
173 * Preferred to strncpy() since it always returns a valid string, and
174 * doesn't unnecessarily force the tail of the destination buffer to be
175 * zeroed. If the zeroing is desired, it's likely cleaner to use strscpy()
176 * with an overflow test, then just memset() the tail of the dest buffer.
178 ssize_t
strscpy(char *dest
, const char *src
, size_t count
)
180 const struct word_at_a_time constants
= WORD_AT_A_TIME_CONSTANTS
;
187 #ifdef CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS
189 * If src is unaligned, don't cross a page boundary,
190 * since we don't know if the next page is mapped.
192 if ((long)src
& (sizeof(long) - 1)) {
193 size_t limit
= PAGE_SIZE
- ((long)src
& (PAGE_SIZE
- 1));
198 /* If src or dest is unaligned, don't do word-at-a-time. */
199 if (((long) dest
| (long) src
) & (sizeof(long) - 1))
203 while (max
>= sizeof(unsigned long)) {
204 unsigned long c
, data
;
206 c
= read_word_at_a_time(src
+res
);
207 if (has_zero(c
, &data
, &constants
)) {
208 data
= prep_zero_mask(c
, data
, &constants
);
209 data
= create_zero_mask(data
);
210 *(unsigned long *)(dest
+res
) = c
& zero_bytemask(data
);
211 return res
+ find_zero(data
);
213 *(unsigned long *)(dest
+res
) = c
;
214 res
+= sizeof(unsigned long);
215 count
-= sizeof(unsigned long);
216 max
-= sizeof(unsigned long);
230 /* Hit buffer length without finding a NUL; force NUL-termination. */
236 EXPORT_SYMBOL(strscpy
);
239 #ifndef __HAVE_ARCH_STRCAT
241 * strcat - Append one %NUL-terminated string to another
242 * @dest: The string to be appended to
243 * @src: The string to append to it
246 char *strcat(char *dest
, const char *src
)
252 while ((*dest
++ = *src
++) != '\0')
256 EXPORT_SYMBOL(strcat
);
259 #ifndef __HAVE_ARCH_STRNCAT
261 * strncat - Append a length-limited, C-string to another
262 * @dest: The string to be appended to
263 * @src: The string to append to it
264 * @count: The maximum numbers of bytes to copy
266 * Note that in contrast to strncpy(), strncat() ensures the result is
269 char *strncat(char *dest
, const char *src
, size_t count
)
276 while ((*dest
++ = *src
++) != 0) {
285 EXPORT_SYMBOL(strncat
);
288 #ifndef __HAVE_ARCH_STRLCAT
290 * strlcat - Append a length-limited, C-string to another
291 * @dest: The string to be appended to
292 * @src: The string to append to it
293 * @count: The size of the destination buffer.
295 size_t strlcat(char *dest
, const char *src
, size_t count
)
297 size_t dsize
= strlen(dest
);
298 size_t len
= strlen(src
);
299 size_t res
= dsize
+ len
;
301 /* This would be a bug */
302 BUG_ON(dsize
>= count
);
308 memcpy(dest
, src
, len
);
312 EXPORT_SYMBOL(strlcat
);
315 #ifndef __HAVE_ARCH_STRCMP
317 * strcmp - Compare two strings
319 * @ct: Another string
322 int strcmp(const char *cs
, const char *ct
)
324 unsigned char c1
, c2
;
330 return c1
< c2
? -1 : 1;
336 EXPORT_SYMBOL(strcmp
);
339 #ifndef __HAVE_ARCH_STRNCMP
341 * strncmp - Compare two length-limited strings
343 * @ct: Another string
344 * @count: The maximum number of bytes to compare
346 int strncmp(const char *cs
, const char *ct
, size_t count
)
348 unsigned char c1
, c2
;
354 return c1
< c2
? -1 : 1;
361 EXPORT_SYMBOL(strncmp
);
364 #ifndef __HAVE_ARCH_STRCHR
366 * strchr - Find the first occurrence of a character in a string
367 * @s: The string to be searched
368 * @c: The character to search for
370 char *strchr(const char *s
, int c
)
372 for (; *s
!= (char)c
; ++s
)
377 EXPORT_SYMBOL(strchr
);
380 #ifndef __HAVE_ARCH_STRCHRNUL
382 * strchrnul - Find and return a character in a string, or end of string
383 * @s: The string to be searched
384 * @c: The character to search for
386 * Returns pointer to first occurrence of 'c' in s. If c is not found, then
387 * return a pointer to the null byte at the end of s.
389 char *strchrnul(const char *s
, int c
)
391 while (*s
&& *s
!= (char)c
)
395 EXPORT_SYMBOL(strchrnul
);
398 #ifndef __HAVE_ARCH_STRRCHR
400 * strrchr - Find the last occurrence of a character in a string
401 * @s: The string to be searched
402 * @c: The character to search for
404 char *strrchr(const char *s
, int c
)
406 const char *last
= NULL
;
413 EXPORT_SYMBOL(strrchr
);
416 #ifndef __HAVE_ARCH_STRNCHR
418 * strnchr - Find a character in a length limited string
419 * @s: The string to be searched
420 * @count: The number of characters to be searched
421 * @c: The character to search for
423 char *strnchr(const char *s
, size_t count
, int c
)
425 for (; count
-- && *s
!= '\0'; ++s
)
430 EXPORT_SYMBOL(strnchr
);
434 * skip_spaces - Removes leading whitespace from @str.
435 * @str: The string to be stripped.
437 * Returns a pointer to the first non-whitespace character in @str.
439 char *skip_spaces(const char *str
)
441 while (isspace(*str
))
445 EXPORT_SYMBOL(skip_spaces
);
448 * strim - Removes leading and trailing whitespace from @s.
449 * @s: The string to be stripped.
451 * Note that the first trailing whitespace is replaced with a %NUL-terminator
452 * in the given string @s. Returns a pointer to the first non-whitespace
465 while (end
>= s
&& isspace(*end
))
469 return skip_spaces(s
);
471 EXPORT_SYMBOL(strim
);
473 #ifndef __HAVE_ARCH_STRLEN
475 * strlen - Find the length of a string
476 * @s: The string to be sized
478 size_t strlen(const char *s
)
482 for (sc
= s
; *sc
!= '\0'; ++sc
)
486 EXPORT_SYMBOL(strlen
);
489 #ifndef __HAVE_ARCH_STRNLEN
491 * strnlen - Find the length of a length-limited string
492 * @s: The string to be sized
493 * @count: The maximum number of bytes to search
495 size_t strnlen(const char *s
, size_t count
)
499 for (sc
= s
; count
-- && *sc
!= '\0'; ++sc
)
503 EXPORT_SYMBOL(strnlen
);
506 #ifndef __HAVE_ARCH_STRSPN
508 * strspn - Calculate the length of the initial substring of @s which only contain letters in @accept
509 * @s: The string to be searched
510 * @accept: The string to search for
512 size_t strspn(const char *s
, const char *accept
)
518 for (p
= s
; *p
!= '\0'; ++p
) {
519 for (a
= accept
; *a
!= '\0'; ++a
) {
530 EXPORT_SYMBOL(strspn
);
533 #ifndef __HAVE_ARCH_STRCSPN
535 * strcspn - Calculate the length of the initial substring of @s which does not contain letters in @reject
536 * @s: The string to be searched
537 * @reject: The string to avoid
539 size_t strcspn(const char *s
, const char *reject
)
545 for (p
= s
; *p
!= '\0'; ++p
) {
546 for (r
= reject
; *r
!= '\0'; ++r
) {
554 EXPORT_SYMBOL(strcspn
);
557 #ifndef __HAVE_ARCH_STRPBRK
559 * strpbrk - Find the first occurrence of a set of characters
560 * @cs: The string to be searched
561 * @ct: The characters to search for
563 char *strpbrk(const char *cs
, const char *ct
)
565 const char *sc1
, *sc2
;
567 for (sc1
= cs
; *sc1
!= '\0'; ++sc1
) {
568 for (sc2
= ct
; *sc2
!= '\0'; ++sc2
) {
575 EXPORT_SYMBOL(strpbrk
);
578 #ifndef __HAVE_ARCH_STRSEP
580 * strsep - Split a string into tokens
581 * @s: The string to be searched
582 * @ct: The characters to search for
584 * strsep() updates @s to point after the token, ready for the next call.
586 * It returns empty tokens, too, behaving exactly like the libc function
587 * of that name. In fact, it was stolen from glibc2 and de-fancy-fied.
588 * Same semantics, slimmer shape. ;)
590 char *strsep(char **s
, const char *ct
)
598 end
= strpbrk(sbegin
, ct
);
604 EXPORT_SYMBOL(strsep
);
608 * sysfs_streq - return true if strings are equal, modulo trailing newline
610 * @s2: another string
612 * This routine returns true iff two strings are equal, treating both
613 * NUL and newline-then-NUL as equivalent string terminations. It's
614 * geared for use with sysfs input strings, which generally terminate
615 * with newlines but are compared against values without newlines.
617 bool sysfs_streq(const char *s1
, const char *s2
)
619 while (*s1
&& *s1
== *s2
) {
626 if (!*s1
&& *s2
== '\n' && !s2
[1])
628 if (*s1
== '\n' && !s1
[1] && !*s2
)
632 EXPORT_SYMBOL(sysfs_streq
);
635 * match_string - matches given string in an array
636 * @array: array of strings
637 * @n: number of strings in the array or -1 for NULL terminated arrays
638 * @string: string to match with
641 * index of a @string in the @array if matches, or %-EINVAL otherwise.
643 int match_string(const char * const *array
, size_t n
, const char *string
)
648 for (index
= 0; index
< n
; index
++) {
652 if (!strcmp(item
, string
))
658 EXPORT_SYMBOL(match_string
);
661 * __sysfs_match_string - matches given string in an array
662 * @array: array of strings
663 * @n: number of strings in the array or -1 for NULL terminated arrays
664 * @str: string to match with
666 * Returns index of @str in the @array or -EINVAL, just like match_string().
667 * Uses sysfs_streq instead of strcmp for matching.
669 int __sysfs_match_string(const char * const *array
, size_t n
, const char *str
)
674 for (index
= 0; index
< n
; index
++) {
678 if (sysfs_streq(item
, str
))
684 EXPORT_SYMBOL(__sysfs_match_string
);
686 #ifndef __HAVE_ARCH_MEMSET
688 * memset - Fill a region of memory with the given value
689 * @s: Pointer to the start of the area.
690 * @c: The byte to fill the area with
691 * @count: The size of the area.
693 * Do not use memset() to access IO space, use memset_io() instead.
695 void *memset(void *s
, int c
, size_t count
)
703 EXPORT_SYMBOL(memset
);
707 * memzero_explicit - Fill a region of memory (e.g. sensitive
708 * keying data) with 0s.
709 * @s: Pointer to the start of the area.
710 * @count: The size of the area.
712 * Note: usually using memset() is just fine (!), but in cases
713 * where clearing out _local_ data at the end of a scope is
714 * necessary, memzero_explicit() should be used instead in
715 * order to prevent the compiler from optimising away zeroing.
717 * memzero_explicit() doesn't need an arch-specific version as
718 * it just invokes the one of memset() implicitly.
720 void memzero_explicit(void *s
, size_t count
)
725 EXPORT_SYMBOL(memzero_explicit
);
727 #ifndef __HAVE_ARCH_MEMSET16
729 * memset16() - Fill a memory area with a uint16_t
730 * @s: Pointer to the start of the area.
731 * @v: The value to fill the area with
732 * @count: The number of values to store
734 * Differs from memset() in that it fills with a uint16_t instead
735 * of a byte. Remember that @count is the number of uint16_ts to
736 * store, not the number of bytes.
738 void *memset16(uint16_t *s
, uint16_t v
, size_t count
)
746 EXPORT_SYMBOL(memset16
);
749 #ifndef __HAVE_ARCH_MEMSET32
751 * memset32() - Fill a memory area with a uint32_t
752 * @s: Pointer to the start of the area.
753 * @v: The value to fill the area with
754 * @count: The number of values to store
756 * Differs from memset() in that it fills with a uint32_t instead
757 * of a byte. Remember that @count is the number of uint32_ts to
758 * store, not the number of bytes.
760 void *memset32(uint32_t *s
, uint32_t v
, size_t count
)
768 EXPORT_SYMBOL(memset32
);
771 #ifndef __HAVE_ARCH_MEMSET64
773 * memset64() - Fill a memory area with a uint64_t
774 * @s: Pointer to the start of the area.
775 * @v: The value to fill the area with
776 * @count: The number of values to store
778 * Differs from memset() in that it fills with a uint64_t instead
779 * of a byte. Remember that @count is the number of uint64_ts to
780 * store, not the number of bytes.
782 void *memset64(uint64_t *s
, uint64_t v
, size_t count
)
790 EXPORT_SYMBOL(memset64
);
793 #ifndef __HAVE_ARCH_MEMCPY
795 * memcpy - Copy one area of memory to another
796 * @dest: Where to copy to
797 * @src: Where to copy from
798 * @count: The size of the area.
800 * You should not use this function to access IO space, use memcpy_toio()
801 * or memcpy_fromio() instead.
803 void *memcpy(void *dest
, const void *src
, size_t count
)
812 EXPORT_SYMBOL(memcpy
);
815 #ifndef __HAVE_ARCH_MEMMOVE
817 * memmove - Copy one area of memory to another
818 * @dest: Where to copy to
819 * @src: Where to copy from
820 * @count: The size of the area.
822 * Unlike memcpy(), memmove() copes with overlapping areas.
824 void *memmove(void *dest
, const void *src
, size_t count
)
844 EXPORT_SYMBOL(memmove
);
847 #ifndef __HAVE_ARCH_MEMCMP
849 * memcmp - Compare two areas of memory
850 * @cs: One area of memory
851 * @ct: Another area of memory
852 * @count: The size of the area.
855 __visible
int memcmp(const void *cs
, const void *ct
, size_t count
)
857 const unsigned char *su1
, *su2
;
860 for (su1
= cs
, su2
= ct
; 0 < count
; ++su1
, ++su2
, count
--)
861 if ((res
= *su1
- *su2
) != 0)
865 EXPORT_SYMBOL(memcmp
);
868 #ifndef __HAVE_ARCH_BCMP
870 * bcmp - returns 0 if and only if the buffers have identical contents.
871 * @a: pointer to first buffer.
872 * @b: pointer to second buffer.
873 * @len: size of buffers.
875 * The sign or magnitude of a non-zero return value has no particular
876 * meaning, and architectures may implement their own more efficient bcmp(). So
877 * while this particular implementation is a simple (tail) call to memcmp, do
878 * not rely on anything but whether the return value is zero or non-zero.
881 int bcmp(const void *a
, const void *b
, size_t len
)
883 return memcmp(a
, b
, len
);
888 #ifndef __HAVE_ARCH_MEMSCAN
890 * memscan - Find a character in an area of memory.
891 * @addr: The memory area
892 * @c: The byte to search for
893 * @size: The size of the area.
895 * returns the address of the first occurrence of @c, or 1 byte past
896 * the area if @c is not found
898 void *memscan(void *addr
, int c
, size_t size
)
900 unsigned char *p
= addr
;
910 EXPORT_SYMBOL(memscan
);
913 #ifndef __HAVE_ARCH_STRSTR
915 * strstr - Find the first substring in a %NUL terminated string
916 * @s1: The string to be searched
917 * @s2: The string to search for
919 char *strstr(const char *s1
, const char *s2
)
929 if (!memcmp(s1
, s2
, l2
))
935 EXPORT_SYMBOL(strstr
);
938 #ifndef __HAVE_ARCH_STRNSTR
940 * strnstr - Find the first substring in a length-limited string
941 * @s1: The string to be searched
942 * @s2: The string to search for
943 * @len: the maximum number of characters to search
945 char *strnstr(const char *s1
, const char *s2
, size_t len
)
954 if (!memcmp(s1
, s2
, l2
))
960 EXPORT_SYMBOL(strnstr
);
963 #ifndef __HAVE_ARCH_MEMCHR
965 * memchr - Find a character in an area of memory.
966 * @s: The memory area
967 * @c: The byte to search for
968 * @n: The size of the area.
970 * returns the address of the first occurrence of @c, or %NULL
973 void *memchr(const void *s
, int c
, size_t n
)
975 const unsigned char *p
= s
;
977 if ((unsigned char)c
== *p
++) {
978 return (void *)(p
- 1);
983 EXPORT_SYMBOL(memchr
);
986 static void *check_bytes8(const u8
*start
, u8 value
, unsigned int bytes
)
990 return (void *)start
;
998 * memchr_inv - Find an unmatching character in an area of memory.
999 * @start: The memory area
1000 * @c: Find a character other than c
1001 * @bytes: The size of the area.
1003 * returns the address of the first character other than @c, or %NULL
1004 * if the whole buffer contains just @c.
1006 void *memchr_inv(const void *start
, int c
, size_t bytes
)
1010 unsigned int words
, prefix
;
1013 return check_bytes8(start
, value
, bytes
);
1016 #if defined(CONFIG_ARCH_HAS_FAST_MULTIPLIER) && BITS_PER_LONG == 64
1017 value64
*= 0x0101010101010101ULL
;
1018 #elif defined(CONFIG_ARCH_HAS_FAST_MULTIPLIER)
1019 value64
*= 0x01010101;
1020 value64
|= value64
<< 32;
1022 value64
|= value64
<< 8;
1023 value64
|= value64
<< 16;
1024 value64
|= value64
<< 32;
1027 prefix
= (unsigned long)start
% 8;
1031 prefix
= 8 - prefix
;
1032 r
= check_bytes8(start
, value
, prefix
);
1042 if (*(u64
*)start
!= value64
)
1043 return check_bytes8(start
, value
, 8);
1048 return check_bytes8(start
, value
, bytes
% 8);
1050 EXPORT_SYMBOL(memchr_inv
);
1053 * strreplace - Replace all occurrences of character in string.
1054 * @s: The string to operate on.
1055 * @old: The character being replaced.
1056 * @new: The character @old is replaced with.
1058 * Returns pointer to the nul byte at the end of @s.
1060 char *strreplace(char *s
, char old
, char new)
1067 EXPORT_SYMBOL(strreplace
);
1069 void fortify_panic(const char *name
)
1071 pr_emerg("detected buffer overflow in %s\n", name
);
1074 EXPORT_SYMBOL(fortify_panic
);