blob: f7f7770444bf55b1e5cee630d1af06c7deedf6da [file] [log] [blame]
Greg Kroah-Hartmanb2441312017-11-01 15:07:57 +01001// SPDX-License-Identifier: GPL-2.0
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/*
3 * linux/lib/string.c
4 *
5 * Copyright (C) 1991, 1992 Linus Torvalds
6 */
7
8/*
9 * stupid library routines.. The optimized versions should generally be found
10 * as inline code in <asm-xx/string.h>
11 *
12 * These are buggy as well..
13 *
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.
17 *
18 * * Sat Feb 09 2002, Jason Thomas <jason@topic.com.au>,
19 * Matthew Hawkins <matt@mh.dropbear.id.au>
20 * - Kissed strtok() goodbye
21 */
22
23#include <linux/types.h>
24#include <linux/string.h>
25#include <linux/ctype.h>
Paul Gortmaker8bc3bcc2011-11-16 21:29:17 -050026#include <linux/kernel.h>
27#include <linux/export.h>
Paul Gortmaker50af5ea2012-01-20 18:35:53 -050028#include <linux/bug.h>
Paul Gortmaker8bc3bcc2011-11-16 21:29:17 -050029#include <linux/errno.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070030
Chris Metcalf30035e42015-04-29 12:52:04 -040031#include <asm/byteorder.h>
32#include <asm/word-at-a-time.h>
33#include <asm/page.h>
34
Rasmus Villemoescd514e72014-10-13 15:54:25 -070035#ifndef __HAVE_ARCH_STRNCASECMP
Linus Torvalds1da177e2005-04-16 15:20:36 -070036/**
Rasmus Villemoescd514e72014-10-13 15:54:25 -070037 * strncasecmp - Case insensitive, length-limited string comparison
Linus Torvalds1da177e2005-04-16 15:20:36 -070038 * @s1: One string
39 * @s2: The other string
40 * @len: the maximum number of characters to compare
41 */
Rasmus Villemoescd514e72014-10-13 15:54:25 -070042int strncasecmp(const char *s1, const char *s2, size_t len)
Linus Torvalds1da177e2005-04-16 15:20:36 -070043{
44 /* Yes, Virginia, it had better be unsigned */
45 unsigned char c1, c2;
46
André Goddard Rosaa11d2b62010-03-05 13:43:11 -080047 if (!len)
48 return 0;
49
50 do {
51 c1 = *s1++;
52 c2 = *s2++;
53 if (!c1 || !c2)
54 break;
55 if (c1 == c2)
56 continue;
57 c1 = tolower(c1);
58 c2 = tolower(c2);
59 if (c1 != c2)
60 break;
61 } while (--len);
Linus Torvalds1da177e2005-04-16 15:20:36 -070062 return (int)c1 - (int)c2;
63}
Rasmus Villemoescd514e72014-10-13 15:54:25 -070064EXPORT_SYMBOL(strncasecmp);
65#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -070066
David S. Millerded220b2007-03-29 01:18:42 -070067#ifndef __HAVE_ARCH_STRCASECMP
68int strcasecmp(const char *s1, const char *s2)
69{
70 int c1, c2;
71
72 do {
73 c1 = tolower(*s1++);
74 c2 = tolower(*s2++);
75 } while (c1 == c2 && c1 != 0);
76 return c1 - c2;
77}
78EXPORT_SYMBOL(strcasecmp);
79#endif
80
Linus Torvalds1da177e2005-04-16 15:20:36 -070081#ifndef __HAVE_ARCH_STRCPY
82/**
83 * strcpy - Copy a %NUL terminated string
84 * @dest: Where to copy the string to
85 * @src: Where to copy the string from
86 */
Paolo 'Blaisorblade' Giarrusso0c281302005-05-05 16:15:17 -070087#undef strcpy
Jesper Juhl51a0f0f2005-10-30 15:02:11 -080088char *strcpy(char *dest, const char *src)
Linus Torvalds1da177e2005-04-16 15:20:36 -070089{
90 char *tmp = dest;
91
92 while ((*dest++ = *src++) != '\0')
93 /* nothing */;
94 return tmp;
95}
96EXPORT_SYMBOL(strcpy);
97#endif
98
99#ifndef __HAVE_ARCH_STRNCPY
100/**
Dan Carpenter0046dd92014-06-04 16:11:47 -0700101 * strncpy - Copy a length-limited, C-string
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102 * @dest: Where to copy the string to
103 * @src: Where to copy the string from
104 * @count: The maximum number of bytes to copy
105 *
106 * The result is not %NUL-terminated if the source exceeds
107 * @count bytes.
walter harms25279522005-05-05 16:16:20 -0700108 *
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.
111 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112 */
Jesper Juhl51a0f0f2005-10-30 15:02:11 -0800113char *strncpy(char *dest, const char *src, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114{
115 char *tmp = dest;
116
117 while (count) {
Jesper Juhl51a0f0f2005-10-30 15:02:11 -0800118 if ((*tmp = *src) != 0)
119 src++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120 tmp++;
121 count--;
122 }
123 return dest;
124}
125EXPORT_SYMBOL(strncpy);
126#endif
127
128#ifndef __HAVE_ARCH_STRLCPY
129/**
Dan Carpenter0046dd92014-06-04 16:11:47 -0700130 * strlcpy - Copy a C-string into a sized buffer
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131 * @dest: Where to copy the string to
132 * @src: Where to copy the string from
133 * @size: size of destination buffer
134 *
mchehab@s-opensource.com0e056eb2017-03-30 17:11:36 -0300135 * Compatible with ``*BSD``: the result is always a valid
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136 * 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.
139 */
140size_t strlcpy(char *dest, const char *src, size_t size)
141{
142 size_t ret = strlen(src);
143
144 if (size) {
Jesper Juhl51a0f0f2005-10-30 15:02:11 -0800145 size_t len = (ret >= size) ? size - 1 : ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146 memcpy(dest, src, len);
147 dest[len] = '\0';
148 }
149 return ret;
150}
151EXPORT_SYMBOL(strlcpy);
152#endif
153
Chris Metcalf30035e42015-04-29 12:52:04 -0400154#ifndef __HAVE_ARCH_STRSCPY
155/**
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
160 *
Tobin C. Harding2a368702019-04-05 12:58:58 +1100161 * Copy the string, or as much of it as fits, into the dest buffer. The
162 * behavior is undefined if the string buffers overlap. The destination
163 * buffer is always NUL terminated, unless it's zero-sized.
Chris Metcalf30035e42015-04-29 12:52:04 -0400164 *
165 * Preferred to strlcpy() since the API doesn't require reading memory
166 * from the src string beyond the specified "count" bytes, and since
167 * the return value is easier to error-check than strlcpy()'s.
168 * In addition, the implementation is robust to the string changing out
169 * from underneath it, unlike the current strlcpy() implementation.
170 *
171 * Preferred to strncpy() since it always returns a valid string, and
172 * doesn't unnecessarily force the tail of the destination buffer to be
Tobin C. Harding2a368702019-04-05 12:58:58 +1100173 * zeroed. If zeroing is desired please use strscpy_pad().
174 *
175 * Return: The number of characters copied (not including the trailing
176 * %NUL) or -E2BIG if the destination buffer wasn't big enough.
Chris Metcalf30035e42015-04-29 12:52:04 -0400177 */
178ssize_t strscpy(char *dest, const char *src, size_t count)
179{
180 const struct word_at_a_time constants = WORD_AT_A_TIME_CONSTANTS;
181 size_t max = count;
182 long res = 0;
183
184 if (count == 0)
185 return -E2BIG;
186
187#ifdef CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS
188 /*
189 * If src is unaligned, don't cross a page boundary,
190 * since we don't know if the next page is mapped.
191 */
192 if ((long)src & (sizeof(long) - 1)) {
193 size_t limit = PAGE_SIZE - ((long)src & (PAGE_SIZE - 1));
194 if (limit < max)
195 max = limit;
196 }
197#else
198 /* If src or dest is unaligned, don't do word-at-a-time. */
199 if (((long) dest | (long) src) & (sizeof(long) - 1))
200 max = 0;
201#endif
202
203 while (max >= sizeof(unsigned long)) {
204 unsigned long c, data;
205
Andrey Ryabinin1a3241f2018-02-01 21:00:50 +0300206 c = read_word_at_a_time(src+res);
Chris Metcalf30035e42015-04-29 12:52:04 -0400207 if (has_zero(c, &data, &constants)) {
208 data = prep_zero_mask(c, data, &constants);
209 data = create_zero_mask(data);
Chris Metcalf990486c2015-10-06 12:37:41 -0400210 *(unsigned long *)(dest+res) = c & zero_bytemask(data);
Chris Metcalf30035e42015-04-29 12:52:04 -0400211 return res + find_zero(data);
212 }
Chris Metcalf990486c2015-10-06 12:37:41 -0400213 *(unsigned long *)(dest+res) = c;
Chris Metcalf30035e42015-04-29 12:52:04 -0400214 res += sizeof(unsigned long);
215 count -= sizeof(unsigned long);
216 max -= sizeof(unsigned long);
217 }
218
219 while (count) {
220 char c;
221
222 c = src[res];
223 dest[res] = c;
224 if (!c)
225 return res;
226 res++;
227 count--;
228 }
229
230 /* Hit buffer length without finding a NUL; force NUL-termination. */
231 if (res)
232 dest[res-1] = '\0';
233
234 return -E2BIG;
235}
236EXPORT_SYMBOL(strscpy);
237#endif
238
Nick Desaulniers7c29fd82020-09-25 21:19:18 -0700239/**
240 * stpcpy - copy a string from src to dest returning a pointer to the new end
241 * of dest, including src's %NUL-terminator. May overrun dest.
242 * @dest: pointer to end of string being copied into. Must be large enough
243 * to receive copy.
244 * @src: pointer to the beginning of string being copied from. Must not overlap
245 * dest.
246 *
247 * stpcpy differs from strcpy in a key way: the return value is a pointer
248 * to the new %NUL-terminating character in @dest. (For strcpy, the return
249 * value is a pointer to the start of @dest). This interface is considered
250 * unsafe as it doesn't perform bounds checking of the inputs. As such it's
251 * not recommended for usage. Instead, its definition is provided in case
252 * the compiler lowers other libcalls to stpcpy.
253 */
254char *stpcpy(char *__restrict__ dest, const char *__restrict__ src);
255char *stpcpy(char *__restrict__ dest, const char *__restrict__ src)
256{
257 while ((*dest++ = *src++) != '\0')
258 /* nothing */;
259 return --dest;
260}
261EXPORT_SYMBOL(stpcpy);
262
Tobin C. Harding2a368702019-04-05 12:58:58 +1100263/**
264 * strscpy_pad() - Copy a C-string into a sized buffer
265 * @dest: Where to copy the string to
266 * @src: Where to copy the string from
267 * @count: Size of destination buffer
268 *
269 * Copy the string, or as much of it as fits, into the dest buffer. The
270 * behavior is undefined if the string buffers overlap. The destination
271 * buffer is always %NUL terminated, unless it's zero-sized.
272 *
273 * If the source string is shorter than the destination buffer, zeros
274 * the tail of the destination buffer.
275 *
276 * For full explanation of why you may want to consider using the
277 * 'strscpy' functions please see the function docstring for strscpy().
278 *
279 * Return: The number of characters copied (not including the trailing
280 * %NUL) or -E2BIG if the destination buffer wasn't big enough.
281 */
282ssize_t strscpy_pad(char *dest, const char *src, size_t count)
283{
284 ssize_t written;
285
286 written = strscpy(dest, src, count);
287 if (written < 0 || written == count - 1)
288 return written;
289
290 memset(dest + written + 1, 0, count - written - 1);
291
292 return written;
293}
294EXPORT_SYMBOL(strscpy_pad);
295
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296#ifndef __HAVE_ARCH_STRCAT
297/**
298 * strcat - Append one %NUL-terminated string to another
299 * @dest: The string to be appended to
300 * @src: The string to append to it
301 */
Paolo 'Blaisorblade' Giarrusso0c281302005-05-05 16:15:17 -0700302#undef strcat
Jesper Juhl51a0f0f2005-10-30 15:02:11 -0800303char *strcat(char *dest, const char *src)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304{
305 char *tmp = dest;
306
307 while (*dest)
308 dest++;
309 while ((*dest++ = *src++) != '\0')
310 ;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311 return tmp;
312}
313EXPORT_SYMBOL(strcat);
314#endif
315
316#ifndef __HAVE_ARCH_STRNCAT
317/**
Dan Carpenter0046dd92014-06-04 16:11:47 -0700318 * strncat - Append a length-limited, C-string to another
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319 * @dest: The string to be appended to
320 * @src: The string to append to it
321 * @count: The maximum numbers of bytes to copy
322 *
Robert P. J. Day72fd4a32007-02-10 01:45:59 -0800323 * Note that in contrast to strncpy(), strncat() ensures the result is
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324 * terminated.
325 */
Jesper Juhl51a0f0f2005-10-30 15:02:11 -0800326char *strncat(char *dest, const char *src, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327{
328 char *tmp = dest;
329
330 if (count) {
331 while (*dest)
332 dest++;
333 while ((*dest++ = *src++) != 0) {
334 if (--count == 0) {
335 *dest = '\0';
336 break;
337 }
338 }
339 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340 return tmp;
341}
342EXPORT_SYMBOL(strncat);
343#endif
344
345#ifndef __HAVE_ARCH_STRLCAT
346/**
Dan Carpenter0046dd92014-06-04 16:11:47 -0700347 * strlcat - Append a length-limited, C-string to another
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348 * @dest: The string to be appended to
349 * @src: The string to append to it
350 * @count: The size of the destination buffer.
351 */
352size_t strlcat(char *dest, const char *src, size_t count)
353{
354 size_t dsize = strlen(dest);
355 size_t len = strlen(src);
356 size_t res = dsize + len;
357
358 /* This would be a bug */
359 BUG_ON(dsize >= count);
360
361 dest += dsize;
362 count -= dsize;
363 if (len >= count)
364 len = count-1;
365 memcpy(dest, src, len);
366 dest[len] = 0;
367 return res;
368}
369EXPORT_SYMBOL(strlcat);
370#endif
371
372#ifndef __HAVE_ARCH_STRCMP
373/**
374 * strcmp - Compare two strings
375 * @cs: One string
376 * @ct: Another string
377 */
Paolo 'Blaisorblade' Giarrusso0c281302005-05-05 16:15:17 -0700378#undef strcmp
Jesper Juhl51a0f0f2005-10-30 15:02:11 -0800379int strcmp(const char *cs, const char *ct)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700380{
Linus Torvaldsa414f012009-11-18 22:31:52 +0100381 unsigned char c1, c2;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382
383 while (1) {
Linus Torvaldsa414f012009-11-18 22:31:52 +0100384 c1 = *cs++;
385 c2 = *ct++;
386 if (c1 != c2)
387 return c1 < c2 ? -1 : 1;
388 if (!c1)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700389 break;
390 }
Linus Torvaldsa414f012009-11-18 22:31:52 +0100391 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392}
393EXPORT_SYMBOL(strcmp);
394#endif
395
396#ifndef __HAVE_ARCH_STRNCMP
397/**
398 * strncmp - Compare two length-limited strings
399 * @cs: One string
400 * @ct: Another string
401 * @count: The maximum number of bytes to compare
402 */
Jesper Juhl51a0f0f2005-10-30 15:02:11 -0800403int strncmp(const char *cs, const char *ct, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404{
Linus Torvaldsa414f012009-11-18 22:31:52 +0100405 unsigned char c1, c2;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406
407 while (count) {
Linus Torvaldsa414f012009-11-18 22:31:52 +0100408 c1 = *cs++;
409 c2 = *ct++;
410 if (c1 != c2)
411 return c1 < c2 ? -1 : 1;
412 if (!c1)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413 break;
414 count--;
415 }
Linus Torvaldsa414f012009-11-18 22:31:52 +0100416 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417}
418EXPORT_SYMBOL(strncmp);
419#endif
420
421#ifndef __HAVE_ARCH_STRCHR
422/**
423 * strchr - Find the first occurrence of a character in a string
424 * @s: The string to be searched
425 * @c: The character to search for
426 */
Jesper Juhl51a0f0f2005-10-30 15:02:11 -0800427char *strchr(const char *s, int c)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428{
Jesper Juhl51a0f0f2005-10-30 15:02:11 -0800429 for (; *s != (char)c; ++s)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700430 if (*s == '\0')
431 return NULL;
Jesper Juhl51a0f0f2005-10-30 15:02:11 -0800432 return (char *)s;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433}
434EXPORT_SYMBOL(strchr);
435#endif
436
Grant Likely11d200e2014-03-14 17:00:14 +0000437#ifndef __HAVE_ARCH_STRCHRNUL
438/**
439 * strchrnul - Find and return a character in a string, or end of string
440 * @s: The string to be searched
441 * @c: The character to search for
442 *
443 * Returns pointer to first occurrence of 'c' in s. If c is not found, then
444 * return a pointer to the null byte at the end of s.
445 */
446char *strchrnul(const char *s, int c)
447{
448 while (*s && *s != (char)c)
449 s++;
450 return (char *)s;
451}
452EXPORT_SYMBOL(strchrnul);
453#endif
454
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455#ifndef __HAVE_ARCH_STRRCHR
456/**
457 * strrchr - Find the last occurrence of a character in a string
458 * @s: The string to be searched
459 * @c: The character to search for
460 */
Jesper Juhl51a0f0f2005-10-30 15:02:11 -0800461char *strrchr(const char *s, int c)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700462{
Rasmus Villemoes8da53d42015-02-13 14:36:44 -0800463 const char *last = NULL;
464 do {
465 if (*s == (char)c)
466 last = s;
467 } while (*s++);
468 return (char *)last;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469}
470EXPORT_SYMBOL(strrchr);
471#endif
472
473#ifndef __HAVE_ARCH_STRNCHR
474/**
475 * strnchr - Find a character in a length limited string
476 * @s: The string to be searched
477 * @count: The number of characters to be searched
478 * @c: The character to search for
479 */
480char *strnchr(const char *s, size_t count, int c)
481{
482 for (; count-- && *s != '\0'; ++s)
Jesper Juhl51a0f0f2005-10-30 15:02:11 -0800483 if (*s == (char)c)
484 return (char *)s;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700485 return NULL;
486}
487EXPORT_SYMBOL(strnchr);
488#endif
489
Pekka Enberg481fad42006-06-23 02:05:44 -0700490/**
Randy Dunlapa6cd13f2009-12-21 14:37:22 -0800491 * skip_spaces - Removes leading whitespace from @str.
492 * @str: The string to be stripped.
André Goddard Rosaf6533982009-12-14 18:01:04 -0800493 *
Randy Dunlapa6cd13f2009-12-21 14:37:22 -0800494 * Returns a pointer to the first non-whitespace character in @str.
André Goddard Rosaf6533982009-12-14 18:01:04 -0800495 */
496char *skip_spaces(const char *str)
497{
498 while (isspace(*str))
499 ++str;
500 return (char *)str;
501}
502EXPORT_SYMBOL(skip_spaces);
503
504/**
KOSAKI Motohiroca54cb82009-12-14 18:01:15 -0800505 * strim - Removes leading and trailing whitespace from @s.
Pekka Enberg481fad42006-06-23 02:05:44 -0700506 * @s: The string to be stripped.
507 *
508 * Note that the first trailing whitespace is replaced with a %NUL-terminator
509 * in the given string @s. Returns a pointer to the first non-whitespace
510 * character in @s.
511 */
KOSAKI Motohiroca54cb82009-12-14 18:01:15 -0800512char *strim(char *s)
Pekka Enberg481fad42006-06-23 02:05:44 -0700513{
514 size_t size;
515 char *end;
516
517 size = strlen(s);
Pekka Enberg481fad42006-06-23 02:05:44 -0700518 if (!size)
519 return s;
520
521 end = s + size - 1;
Michael Holzheu6e6d9fa2006-10-28 10:38:47 -0700522 while (end >= s && isspace(*end))
Pekka Enberg481fad42006-06-23 02:05:44 -0700523 end--;
524 *(end + 1) = '\0';
525
Michael Holzheu66f69582011-10-31 17:12:37 -0700526 return skip_spaces(s);
Pekka Enberg481fad42006-06-23 02:05:44 -0700527}
KOSAKI Motohiroca54cb82009-12-14 18:01:15 -0800528EXPORT_SYMBOL(strim);
Pekka Enberg481fad42006-06-23 02:05:44 -0700529
Linus Torvalds1da177e2005-04-16 15:20:36 -0700530#ifndef __HAVE_ARCH_STRLEN
531/**
532 * strlen - Find the length of a string
533 * @s: The string to be sized
534 */
Jesper Juhl51a0f0f2005-10-30 15:02:11 -0800535size_t strlen(const char *s)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700536{
537 const char *sc;
538
539 for (sc = s; *sc != '\0'; ++sc)
540 /* nothing */;
541 return sc - s;
542}
543EXPORT_SYMBOL(strlen);
544#endif
545
546#ifndef __HAVE_ARCH_STRNLEN
547/**
548 * strnlen - Find the length of a length-limited string
549 * @s: The string to be sized
550 * @count: The maximum number of bytes to search
551 */
Jesper Juhl51a0f0f2005-10-30 15:02:11 -0800552size_t strnlen(const char *s, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553{
554 const char *sc;
555
556 for (sc = s; count-- && *sc != '\0'; ++sc)
557 /* nothing */;
558 return sc - s;
559}
560EXPORT_SYMBOL(strnlen);
561#endif
562
563#ifndef __HAVE_ARCH_STRSPN
564/**
Robert P. J. Day72fd4a32007-02-10 01:45:59 -0800565 * strspn - Calculate the length of the initial substring of @s which only contain letters in @accept
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566 * @s: The string to be searched
567 * @accept: The string to search for
568 */
569size_t strspn(const char *s, const char *accept)
570{
571 const char *p;
572 const char *a;
573 size_t count = 0;
574
575 for (p = s; *p != '\0'; ++p) {
576 for (a = accept; *a != '\0'; ++a) {
577 if (*p == *a)
578 break;
579 }
580 if (*a == '\0')
581 return count;
582 ++count;
583 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584 return count;
585}
586
587EXPORT_SYMBOL(strspn);
588#endif
589
Kyle McMartin8833d322006-04-10 22:53:57 -0700590#ifndef __HAVE_ARCH_STRCSPN
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591/**
Robert P. J. Day72fd4a32007-02-10 01:45:59 -0800592 * strcspn - Calculate the length of the initial substring of @s which does not contain letters in @reject
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593 * @s: The string to be searched
594 * @reject: The string to avoid
595 */
596size_t strcspn(const char *s, const char *reject)
597{
598 const char *p;
599 const char *r;
600 size_t count = 0;
601
602 for (p = s; *p != '\0'; ++p) {
603 for (r = reject; *r != '\0'; ++r) {
604 if (*p == *r)
605 return count;
606 }
607 ++count;
608 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700609 return count;
Jesper Juhl51a0f0f2005-10-30 15:02:11 -0800610}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611EXPORT_SYMBOL(strcspn);
Kyle McMartin8833d322006-04-10 22:53:57 -0700612#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613
614#ifndef __HAVE_ARCH_STRPBRK
615/**
616 * strpbrk - Find the first occurrence of a set of characters
617 * @cs: The string to be searched
618 * @ct: The characters to search for
619 */
Jesper Juhl51a0f0f2005-10-30 15:02:11 -0800620char *strpbrk(const char *cs, const char *ct)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621{
Jesper Juhl51a0f0f2005-10-30 15:02:11 -0800622 const char *sc1, *sc2;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700623
Jesper Juhl51a0f0f2005-10-30 15:02:11 -0800624 for (sc1 = cs; *sc1 != '\0'; ++sc1) {
625 for (sc2 = ct; *sc2 != '\0'; ++sc2) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626 if (*sc1 == *sc2)
Jesper Juhl51a0f0f2005-10-30 15:02:11 -0800627 return (char *)sc1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628 }
629 }
630 return NULL;
631}
Kyle McMartin894b5772006-04-10 22:53:56 -0700632EXPORT_SYMBOL(strpbrk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633#endif
634
635#ifndef __HAVE_ARCH_STRSEP
636/**
637 * strsep - Split a string into tokens
638 * @s: The string to be searched
639 * @ct: The characters to search for
640 *
641 * strsep() updates @s to point after the token, ready for the next call.
642 *
643 * It returns empty tokens, too, behaving exactly like the libc function
644 * of that name. In fact, it was stolen from glibc2 and de-fancy-fied.
645 * Same semantics, slimmer shape. ;)
646 */
Jesper Juhl51a0f0f2005-10-30 15:02:11 -0800647char *strsep(char **s, const char *ct)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648{
Jesper Juhl51a0f0f2005-10-30 15:02:11 -0800649 char *sbegin = *s;
650 char *end;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651
652 if (sbegin == NULL)
653 return NULL;
654
655 end = strpbrk(sbegin, ct);
656 if (end)
657 *end++ = '\0';
658 *s = end;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659 return sbegin;
660}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700661EXPORT_SYMBOL(strsep);
662#endif
663
David Brownell34990cf2008-05-01 04:34:42 -0700664/**
665 * sysfs_streq - return true if strings are equal, modulo trailing newline
666 * @s1: one string
667 * @s2: another string
668 *
669 * This routine returns true iff two strings are equal, treating both
670 * NUL and newline-then-NUL as equivalent string terminations. It's
671 * geared for use with sysfs input strings, which generally terminate
672 * with newlines but are compared against values without newlines.
673 */
674bool sysfs_streq(const char *s1, const char *s2)
675{
676 while (*s1 && *s1 == *s2) {
677 s1++;
678 s2++;
679 }
680
681 if (*s1 == *s2)
682 return true;
683 if (!*s1 && *s2 == '\n' && !s2[1])
684 return true;
685 if (*s1 == '\n' && !s1[1] && !*s2)
686 return true;
687 return false;
688}
689EXPORT_SYMBOL(sysfs_streq);
690
Jonathan Camerond0f1fed2011-04-19 12:43:45 +0100691/**
Andy Shevchenko56b06082016-03-17 14:22:14 -0700692 * match_string - matches given string in an array
693 * @array: array of strings
694 * @n: number of strings in the array or -1 for NULL terminated arrays
695 * @string: string to match with
696 *
697 * Return:
698 * index of a @string in the @array if matches, or %-EINVAL otherwise.
699 */
700int match_string(const char * const *array, size_t n, const char *string)
701{
702 int index;
703 const char *item;
704
705 for (index = 0; index < n; index++) {
706 item = array[index];
707 if (!item)
708 break;
709 if (!strcmp(item, string))
710 return index;
711 }
712
713 return -EINVAL;
714}
715EXPORT_SYMBOL(match_string);
716
Heikki Krogeruse1fe7b62017-03-21 13:56:46 +0200717/**
718 * __sysfs_match_string - matches given string in an array
719 * @array: array of strings
720 * @n: number of strings in the array or -1 for NULL terminated arrays
721 * @str: string to match with
722 *
723 * Returns index of @str in the @array or -EINVAL, just like match_string().
724 * Uses sysfs_streq instead of strcmp for matching.
725 */
726int __sysfs_match_string(const char * const *array, size_t n, const char *str)
727{
728 const char *item;
729 int index;
730
731 for (index = 0; index < n; index++) {
732 item = array[index];
733 if (!item)
734 break;
735 if (sysfs_streq(item, str))
736 return index;
737 }
738
739 return -EINVAL;
740}
741EXPORT_SYMBOL(__sysfs_match_string);
742
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743#ifndef __HAVE_ARCH_MEMSET
744/**
745 * memset - Fill a region of memory with the given value
746 * @s: Pointer to the start of the area.
747 * @c: The byte to fill the area with
748 * @count: The size of the area.
749 *
750 * Do not use memset() to access IO space, use memset_io() instead.
751 */
Jesper Juhl51a0f0f2005-10-30 15:02:11 -0800752void *memset(void *s, int c, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700753{
Jesper Juhl850b9242005-10-30 15:02:13 -0800754 char *xs = s;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755
756 while (count--)
757 *xs++ = c;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758 return s;
759}
760EXPORT_SYMBOL(memset);
761#endif
762
Daniel Borkmannd4c5efd2014-08-26 23:16:35 -0400763/**
764 * memzero_explicit - Fill a region of memory (e.g. sensitive
765 * keying data) with 0s.
766 * @s: Pointer to the start of the area.
767 * @count: The size of the area.
768 *
Daniel Borkmann81553302015-01-06 00:27:45 +0100769 * Note: usually using memset() is just fine (!), but in cases
770 * where clearing out _local_ data at the end of a scope is
771 * necessary, memzero_explicit() should be used instead in
772 * order to prevent the compiler from optimising away zeroing.
773 *
Daniel Borkmannd4c5efd2014-08-26 23:16:35 -0400774 * memzero_explicit() doesn't need an arch-specific version as
775 * it just invokes the one of memset() implicitly.
776 */
777void memzero_explicit(void *s, size_t count)
778{
779 memset(s, 0, count);
Daniel Borkmann7829fb02015-04-30 04:13:52 +0200780 barrier_data(s);
Daniel Borkmannd4c5efd2014-08-26 23:16:35 -0400781}
782EXPORT_SYMBOL(memzero_explicit);
783
Matthew Wilcox3b3c4ba2017-09-08 16:13:48 -0700784#ifndef __HAVE_ARCH_MEMSET16
785/**
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
790 *
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.
794 */
795void *memset16(uint16_t *s, uint16_t v, size_t count)
796{
797 uint16_t *xs = s;
798
799 while (count--)
800 *xs++ = v;
801 return s;
802}
803EXPORT_SYMBOL(memset16);
804#endif
805
806#ifndef __HAVE_ARCH_MEMSET32
807/**
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
812 *
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.
816 */
817void *memset32(uint32_t *s, uint32_t v, size_t count)
818{
819 uint32_t *xs = s;
820
821 while (count--)
822 *xs++ = v;
823 return s;
824}
825EXPORT_SYMBOL(memset32);
826#endif
827
828#ifndef __HAVE_ARCH_MEMSET64
829/**
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
834 *
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.
838 */
839void *memset64(uint64_t *s, uint64_t v, size_t count)
840{
841 uint64_t *xs = s;
842
843 while (count--)
844 *xs++ = v;
845 return s;
846}
847EXPORT_SYMBOL(memset64);
848#endif
849
Linus Torvalds1da177e2005-04-16 15:20:36 -0700850#ifndef __HAVE_ARCH_MEMCPY
851/**
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.
856 *
857 * You should not use this function to access IO space, use memcpy_toio()
858 * or memcpy_fromio() instead.
859 */
Jesper Juhl51a0f0f2005-10-30 15:02:11 -0800860void *memcpy(void *dest, const void *src, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700861{
Jesper Juhl850b9242005-10-30 15:02:13 -0800862 char *tmp = dest;
Jan-Benedict Glaw4c416ab2006-04-10 22:54:09 -0700863 const char *s = src;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700864
865 while (count--)
866 *tmp++ = *s++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700867 return dest;
868}
869EXPORT_SYMBOL(memcpy);
870#endif
871
872#ifndef __HAVE_ARCH_MEMMOVE
873/**
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.
878 *
879 * Unlike memcpy(), memmove() copes with overlapping areas.
880 */
Jesper Juhl51a0f0f2005-10-30 15:02:11 -0800881void *memmove(void *dest, const void *src, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700882{
Paul Jackson82da2c32005-10-30 15:03:19 -0800883 char *tmp;
884 const char *s;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700885
886 if (dest <= src) {
Jesper Juhl850b9242005-10-30 15:02:13 -0800887 tmp = dest;
888 s = src;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700889 while (count--)
890 *tmp++ = *s++;
Jesper Juhl51a0f0f2005-10-30 15:02:11 -0800891 } else {
Jesper Juhl850b9242005-10-30 15:02:13 -0800892 tmp = dest;
893 tmp += count;
894 s = src;
895 s += count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700896 while (count--)
897 *--tmp = *--s;
Jesper Juhl51a0f0f2005-10-30 15:02:11 -0800898 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700899 return dest;
900}
901EXPORT_SYMBOL(memmove);
902#endif
903
904#ifndef __HAVE_ARCH_MEMCMP
905/**
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.
910 */
Paolo 'Blaisorblade' Giarrusso0c281302005-05-05 16:15:17 -0700911#undef memcmp
Andi Kleena7330c92014-02-08 08:52:06 +0100912__visible int memcmp(const void *cs, const void *ct, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700913{
914 const unsigned char *su1, *su2;
915 int res = 0;
916
Jesper Juhl51a0f0f2005-10-30 15:02:11 -0800917 for (su1 = cs, su2 = ct; 0 < count; ++su1, ++su2, count--)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700918 if ((res = *su1 - *su2) != 0)
919 break;
920 return res;
921}
922EXPORT_SYMBOL(memcmp);
923#endif
924
Nick Desaulniers34126712019-04-05 18:38:45 -0700925#ifndef __HAVE_ARCH_BCMP
926/**
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.
931 *
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.
936 */
937#undef bcmp
938int bcmp(const void *a, const void *b, size_t len)
939{
940 return memcmp(a, b, len);
941}
942EXPORT_SYMBOL(bcmp);
943#endif
944
Linus Torvalds1da177e2005-04-16 15:20:36 -0700945#ifndef __HAVE_ARCH_MEMSCAN
946/**
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.
951 *
952 * returns the address of the first occurrence of @c, or 1 byte past
953 * the area if @c is not found
954 */
Jesper Juhl51a0f0f2005-10-30 15:02:11 -0800955void *memscan(void *addr, int c, size_t size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700956{
Jesper Juhl850b9242005-10-30 15:02:13 -0800957 unsigned char *p = addr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700958
959 while (size) {
960 if (*p == c)
Jesper Juhl51a0f0f2005-10-30 15:02:11 -0800961 return (void *)p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700962 p++;
963 size--;
964 }
Jesper Juhl51a0f0f2005-10-30 15:02:11 -0800965 return (void *)p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700966}
967EXPORT_SYMBOL(memscan);
968#endif
969
970#ifndef __HAVE_ARCH_STRSTR
971/**
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
975 */
Jesper Juhl51a0f0f2005-10-30 15:02:11 -0800976char *strstr(const char *s1, const char *s2)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700977{
Li Zefand5f1fb52010-01-14 10:53:55 +0800978 size_t l1, l2;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700979
980 l2 = strlen(s2);
981 if (!l2)
Jesper Juhl51a0f0f2005-10-30 15:02:11 -0800982 return (char *)s1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700983 l1 = strlen(s1);
984 while (l1 >= l2) {
985 l1--;
Jesper Juhl51a0f0f2005-10-30 15:02:11 -0800986 if (!memcmp(s1, s2, l2))
987 return (char *)s1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700988 s1++;
989 }
990 return NULL;
991}
992EXPORT_SYMBOL(strstr);
993#endif
994
Li Zefand5f1fb52010-01-14 10:53:55 +0800995#ifndef __HAVE_ARCH_STRNSTR
996/**
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
1001 */
1002char *strnstr(const char *s1, const char *s2, size_t len)
1003{
André Goddard Rosad6a2eed2010-03-05 13:43:12 -08001004 size_t l2;
Li Zefand5f1fb52010-01-14 10:53:55 +08001005
1006 l2 = strlen(s2);
1007 if (!l2)
1008 return (char *)s1;
André Goddard Rosad6a2eed2010-03-05 13:43:12 -08001009 while (len >= l2) {
1010 len--;
Li Zefand5f1fb52010-01-14 10:53:55 +08001011 if (!memcmp(s1, s2, l2))
1012 return (char *)s1;
1013 s1++;
1014 }
1015 return NULL;
1016}
1017EXPORT_SYMBOL(strnstr);
1018#endif
1019
Linus Torvalds1da177e2005-04-16 15:20:36 -07001020#ifndef __HAVE_ARCH_MEMCHR
1021/**
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.
1026 *
1027 * returns the address of the first occurrence of @c, or %NULL
1028 * if @c is not found
1029 */
1030void *memchr(const void *s, int c, size_t n)
1031{
1032 const unsigned char *p = s;
1033 while (n-- != 0) {
1034 if ((unsigned char)c == *p++) {
Jesper Juhl51a0f0f2005-10-30 15:02:11 -08001035 return (void *)(p - 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001036 }
1037 }
1038 return NULL;
1039}
1040EXPORT_SYMBOL(memchr);
1041#endif
Akinobu Mita798248202011-10-31 17:08:07 -07001042
1043static void *check_bytes8(const u8 *start, u8 value, unsigned int bytes)
1044{
1045 while (bytes) {
1046 if (*start != value)
1047 return (void *)start;
1048 start++;
1049 bytes--;
1050 }
1051 return NULL;
1052}
1053
1054/**
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.
1059 *
1060 * returns the address of the first character other than @c, or %NULL
1061 * if the whole buffer contains just @c.
1062 */
1063void *memchr_inv(const void *start, int c, size_t bytes)
1064{
1065 u8 value = c;
1066 u64 value64;
1067 unsigned int words, prefix;
1068
1069 if (bytes <= 16)
1070 return check_bytes8(start, value, bytes);
1071
Akinobu Mitaf43804b2012-03-23 15:02:14 -07001072 value64 = value;
Linus Torvalds72d93102014-09-13 11:14:53 -07001073#if defined(CONFIG_ARCH_HAS_FAST_MULTIPLIER) && BITS_PER_LONG == 64
Andy Shevchenko3368e8f2015-11-10 14:45:14 -08001074 value64 *= 0x0101010101010101ULL;
Linus Torvalds72d93102014-09-13 11:14:53 -07001075#elif defined(CONFIG_ARCH_HAS_FAST_MULTIPLIER)
Akinobu Mitaf43804b2012-03-23 15:02:14 -07001076 value64 *= 0x01010101;
1077 value64 |= value64 << 32;
1078#else
1079 value64 |= value64 << 8;
1080 value64 |= value64 << 16;
1081 value64 |= value64 << 32;
1082#endif
Akinobu Mita798248202011-10-31 17:08:07 -07001083
Akinobu Mitaf43804b2012-03-23 15:02:14 -07001084 prefix = (unsigned long)start % 8;
Akinobu Mita798248202011-10-31 17:08:07 -07001085 if (prefix) {
Akinobu Mitaf43804b2012-03-23 15:02:14 -07001086 u8 *r;
1087
1088 prefix = 8 - prefix;
1089 r = check_bytes8(start, value, prefix);
Akinobu Mita798248202011-10-31 17:08:07 -07001090 if (r)
1091 return r;
1092 start += prefix;
1093 bytes -= prefix;
1094 }
1095
1096 words = bytes / 8;
1097
1098 while (words) {
1099 if (*(u64 *)start != value64)
1100 return check_bytes8(start, value, 8);
1101 start += 8;
1102 words--;
1103 }
1104
1105 return check_bytes8(start, value, bytes % 8);
1106}
1107EXPORT_SYMBOL(memchr_inv);
Rasmus Villemoes94df2902015-06-25 15:02:22 -07001108
1109/**
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.
1114 *
1115 * Returns pointer to the nul byte at the end of @s.
1116 */
1117char *strreplace(char *s, char old, char new)
1118{
1119 for (; *s; ++s)
1120 if (*s == old)
1121 *s = new;
1122 return s;
1123}
1124EXPORT_SYMBOL(strreplace);
Daniel Micay6974f0c2017-07-12 14:36:10 -07001125
1126void fortify_panic(const char *name)
1127{
1128 pr_emerg("detected buffer overflow in %s\n", name);
1129 BUG();
1130}
1131EXPORT_SYMBOL(fortify_panic);