blob: 4288e0158d47f0f6d0a3f8404592543328c6f947 [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>
Alexander Shishkince76d932018-10-05 15:43:05 +030030#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070031
Chris Metcalf30035e42015-04-29 12:52:04 -040032#include <asm/byteorder.h>
33#include <asm/word-at-a-time.h>
34#include <asm/page.h>
35
Rasmus Villemoescd514e72014-10-13 15:54:25 -070036#ifndef __HAVE_ARCH_STRNCASECMP
Linus Torvalds1da177e2005-04-16 15:20:36 -070037/**
Rasmus Villemoescd514e72014-10-13 15:54:25 -070038 * strncasecmp - Case insensitive, length-limited string comparison
Linus Torvalds1da177e2005-04-16 15:20:36 -070039 * @s1: One string
40 * @s2: The other string
41 * @len: the maximum number of characters to compare
42 */
Rasmus Villemoescd514e72014-10-13 15:54:25 -070043int strncasecmp(const char *s1, const char *s2, size_t len)
Linus Torvalds1da177e2005-04-16 15:20:36 -070044{
45 /* Yes, Virginia, it had better be unsigned */
46 unsigned char c1, c2;
47
André Goddard Rosaa11d2b62010-03-05 13:43:11 -080048 if (!len)
49 return 0;
50
51 do {
52 c1 = *s1++;
53 c2 = *s2++;
54 if (!c1 || !c2)
55 break;
56 if (c1 == c2)
57 continue;
58 c1 = tolower(c1);
59 c2 = tolower(c2);
60 if (c1 != c2)
61 break;
62 } while (--len);
Linus Torvalds1da177e2005-04-16 15:20:36 -070063 return (int)c1 - (int)c2;
64}
Rasmus Villemoescd514e72014-10-13 15:54:25 -070065EXPORT_SYMBOL(strncasecmp);
66#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -070067
David S. Millerded220b2007-03-29 01:18:42 -070068#ifndef __HAVE_ARCH_STRCASECMP
69int strcasecmp(const char *s1, const char *s2)
70{
71 int c1, c2;
72
73 do {
74 c1 = tolower(*s1++);
75 c2 = tolower(*s2++);
76 } while (c1 == c2 && c1 != 0);
77 return c1 - c2;
78}
79EXPORT_SYMBOL(strcasecmp);
80#endif
81
Linus Torvalds1da177e2005-04-16 15:20:36 -070082#ifndef __HAVE_ARCH_STRCPY
83/**
84 * strcpy - Copy a %NUL terminated string
85 * @dest: Where to copy the string to
86 * @src: Where to copy the string from
87 */
Paolo 'Blaisorblade' Giarrusso0c281302005-05-05 16:15:17 -070088#undef strcpy
Jesper Juhl51a0f0f2005-10-30 15:02:11 -080089char *strcpy(char *dest, const char *src)
Linus Torvalds1da177e2005-04-16 15:20:36 -070090{
91 char *tmp = dest;
92
93 while ((*dest++ = *src++) != '\0')
94 /* nothing */;
95 return tmp;
96}
97EXPORT_SYMBOL(strcpy);
98#endif
99
100#ifndef __HAVE_ARCH_STRNCPY
101/**
Dan Carpenter0046dd92014-06-04 16:11:47 -0700102 * strncpy - Copy a length-limited, C-string
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103 * @dest: Where to copy the string to
104 * @src: Where to copy the string from
105 * @count: The maximum number of bytes to copy
106 *
107 * The result is not %NUL-terminated if the source exceeds
108 * @count bytes.
walter harms25279522005-05-05 16:16:20 -0700109 *
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.
112 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113 */
Jesper Juhl51a0f0f2005-10-30 15:02:11 -0800114char *strncpy(char *dest, const char *src, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115{
116 char *tmp = dest;
117
118 while (count) {
Jesper Juhl51a0f0f2005-10-30 15:02:11 -0800119 if ((*tmp = *src) != 0)
120 src++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121 tmp++;
122 count--;
123 }
124 return dest;
125}
126EXPORT_SYMBOL(strncpy);
127#endif
128
129#ifndef __HAVE_ARCH_STRLCPY
130/**
Dan Carpenter0046dd92014-06-04 16:11:47 -0700131 * strlcpy - Copy a C-string into a sized buffer
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132 * @dest: Where to copy the string to
133 * @src: Where to copy the string from
134 * @size: size of destination buffer
135 *
mchehab@s-opensource.com0e056eb2017-03-30 17:11:36 -0300136 * Compatible with ``*BSD``: the result is always a valid
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137 * 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.
140 */
141size_t strlcpy(char *dest, const char *src, size_t size)
142{
143 size_t ret = strlen(src);
144
145 if (size) {
Jesper Juhl51a0f0f2005-10-30 15:02:11 -0800146 size_t len = (ret >= size) ? size - 1 : ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147 memcpy(dest, src, len);
148 dest[len] = '\0';
149 }
150 return ret;
151}
152EXPORT_SYMBOL(strlcpy);
153#endif
154
Chris Metcalf30035e42015-04-29 12:52:04 -0400155#ifndef __HAVE_ARCH_STRSCPY
156/**
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
161 *
Tobin C. Harding458a3bf2019-04-05 12:58:58 +1100162 * 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.
Chris Metcalf30035e42015-04-29 12:52:04 -0400165 *
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.
171 *
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
Tobin C. Harding458a3bf2019-04-05 12:58:58 +1100174 * zeroed. If zeroing is desired please use strscpy_pad().
175 *
Joe Perches917cda22019-09-25 16:46:13 -0700176 * Returns:
177 * * The number of characters copied (not including the trailing %NUL)
178 * * -E2BIG if count is 0 or @src was truncated.
Chris Metcalf30035e42015-04-29 12:52:04 -0400179 */
180ssize_t strscpy(char *dest, const char *src, size_t count)
181{
182 const struct word_at_a_time constants = WORD_AT_A_TIME_CONSTANTS;
183 size_t max = count;
184 long res = 0;
185
Kees Cook9a156462019-09-25 16:46:20 -0700186 if (count == 0 || WARN_ON_ONCE(count > INT_MAX))
Chris Metcalf30035e42015-04-29 12:52:04 -0400187 return -E2BIG;
188
189#ifdef CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS
190 /*
191 * If src is unaligned, don't cross a page boundary,
192 * since we don't know if the next page is mapped.
193 */
194 if ((long)src & (sizeof(long) - 1)) {
195 size_t limit = PAGE_SIZE - ((long)src & (PAGE_SIZE - 1));
196 if (limit < max)
197 max = limit;
198 }
199#else
200 /* If src or dest is unaligned, don't do word-at-a-time. */
201 if (((long) dest | (long) src) & (sizeof(long) - 1))
202 max = 0;
203#endif
204
205 while (max >= sizeof(unsigned long)) {
206 unsigned long c, data;
207
Andrey Ryabinin1a3241f2018-02-01 21:00:50 +0300208 c = read_word_at_a_time(src+res);
Chris Metcalf30035e42015-04-29 12:52:04 -0400209 if (has_zero(c, &data, &constants)) {
210 data = prep_zero_mask(c, data, &constants);
211 data = create_zero_mask(data);
Chris Metcalf990486c2015-10-06 12:37:41 -0400212 *(unsigned long *)(dest+res) = c & zero_bytemask(data);
Chris Metcalf30035e42015-04-29 12:52:04 -0400213 return res + find_zero(data);
214 }
Chris Metcalf990486c2015-10-06 12:37:41 -0400215 *(unsigned long *)(dest+res) = c;
Chris Metcalf30035e42015-04-29 12:52:04 -0400216 res += sizeof(unsigned long);
217 count -= sizeof(unsigned long);
218 max -= sizeof(unsigned long);
219 }
220
221 while (count) {
222 char c;
223
224 c = src[res];
225 dest[res] = c;
226 if (!c)
227 return res;
228 res++;
229 count--;
230 }
231
232 /* Hit buffer length without finding a NUL; force NUL-termination. */
233 if (res)
234 dest[res-1] = '\0';
235
236 return -E2BIG;
237}
238EXPORT_SYMBOL(strscpy);
239#endif
240
Tobin C. Harding458a3bf2019-04-05 12:58:58 +1100241/**
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
246 *
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.
250 *
251 * If the source string is shorter than the destination buffer, zeros
252 * the tail of the destination buffer.
253 *
254 * For full explanation of why you may want to consider using the
255 * 'strscpy' functions please see the function docstring for strscpy().
256 *
Joe Perches917cda22019-09-25 16:46:13 -0700257 * Returns:
258 * * The number of characters copied (not including the trailing %NUL)
259 * * -E2BIG if count is 0 or @src was truncated.
Tobin C. Harding458a3bf2019-04-05 12:58:58 +1100260 */
261ssize_t strscpy_pad(char *dest, const char *src, size_t count)
262{
263 ssize_t written;
264
265 written = strscpy(dest, src, count);
266 if (written < 0 || written == count - 1)
267 return written;
268
269 memset(dest + written + 1, 0, count - written - 1);
270
271 return written;
272}
273EXPORT_SYMBOL(strscpy_pad);
274
Nick Desaulniers1e1b6d62020-09-25 21:19:18 -0700275/**
276 * stpcpy - copy a string from src to dest returning a pointer to the new end
277 * of dest, including src's %NUL-terminator. May overrun dest.
278 * @dest: pointer to end of string being copied into. Must be large enough
279 * to receive copy.
280 * @src: pointer to the beginning of string being copied from. Must not overlap
281 * dest.
282 *
283 * stpcpy differs from strcpy in a key way: the return value is a pointer
284 * to the new %NUL-terminating character in @dest. (For strcpy, the return
285 * value is a pointer to the start of @dest). This interface is considered
286 * unsafe as it doesn't perform bounds checking of the inputs. As such it's
287 * not recommended for usage. Instead, its definition is provided in case
288 * the compiler lowers other libcalls to stpcpy.
289 */
290char *stpcpy(char *__restrict__ dest, const char *__restrict__ src);
291char *stpcpy(char *__restrict__ dest, const char *__restrict__ src)
292{
293 while ((*dest++ = *src++) != '\0')
294 /* nothing */;
295 return --dest;
296}
297EXPORT_SYMBOL(stpcpy);
298
Linus Torvalds1da177e2005-04-16 15:20:36 -0700299#ifndef __HAVE_ARCH_STRCAT
300/**
301 * strcat - Append one %NUL-terminated string to another
302 * @dest: The string to be appended to
303 * @src: The string to append to it
304 */
Paolo 'Blaisorblade' Giarrusso0c281302005-05-05 16:15:17 -0700305#undef strcat
Jesper Juhl51a0f0f2005-10-30 15:02:11 -0800306char *strcat(char *dest, const char *src)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700307{
308 char *tmp = dest;
309
310 while (*dest)
311 dest++;
312 while ((*dest++ = *src++) != '\0')
313 ;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314 return tmp;
315}
316EXPORT_SYMBOL(strcat);
317#endif
318
319#ifndef __HAVE_ARCH_STRNCAT
320/**
Dan Carpenter0046dd92014-06-04 16:11:47 -0700321 * strncat - Append a length-limited, C-string to another
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322 * @dest: The string to be appended to
323 * @src: The string to append to it
324 * @count: The maximum numbers of bytes to copy
325 *
Robert P. J. Day72fd4a32007-02-10 01:45:59 -0800326 * Note that in contrast to strncpy(), strncat() ensures the result is
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327 * terminated.
328 */
Jesper Juhl51a0f0f2005-10-30 15:02:11 -0800329char *strncat(char *dest, const char *src, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330{
331 char *tmp = dest;
332
333 if (count) {
334 while (*dest)
335 dest++;
336 while ((*dest++ = *src++) != 0) {
337 if (--count == 0) {
338 *dest = '\0';
339 break;
340 }
341 }
342 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343 return tmp;
344}
345EXPORT_SYMBOL(strncat);
346#endif
347
348#ifndef __HAVE_ARCH_STRLCAT
349/**
Dan Carpenter0046dd92014-06-04 16:11:47 -0700350 * strlcat - Append a length-limited, C-string to another
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351 * @dest: The string to be appended to
352 * @src: The string to append to it
353 * @count: The size of the destination buffer.
354 */
355size_t strlcat(char *dest, const char *src, size_t count)
356{
357 size_t dsize = strlen(dest);
358 size_t len = strlen(src);
359 size_t res = dsize + len;
360
361 /* This would be a bug */
362 BUG_ON(dsize >= count);
363
364 dest += dsize;
365 count -= dsize;
366 if (len >= count)
367 len = count-1;
368 memcpy(dest, src, len);
369 dest[len] = 0;
370 return res;
371}
372EXPORT_SYMBOL(strlcat);
373#endif
374
375#ifndef __HAVE_ARCH_STRCMP
376/**
377 * strcmp - Compare two strings
378 * @cs: One string
379 * @ct: Another string
380 */
Paolo 'Blaisorblade' Giarrusso0c281302005-05-05 16:15:17 -0700381#undef strcmp
Jesper Juhl51a0f0f2005-10-30 15:02:11 -0800382int strcmp(const char *cs, const char *ct)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383{
Linus Torvaldsa414f012009-11-18 22:31:52 +0100384 unsigned char c1, c2;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385
386 while (1) {
Linus Torvaldsa414f012009-11-18 22:31:52 +0100387 c1 = *cs++;
388 c2 = *ct++;
389 if (c1 != c2)
390 return c1 < c2 ? -1 : 1;
391 if (!c1)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392 break;
393 }
Linus Torvaldsa414f012009-11-18 22:31:52 +0100394 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395}
396EXPORT_SYMBOL(strcmp);
397#endif
398
399#ifndef __HAVE_ARCH_STRNCMP
400/**
401 * strncmp - Compare two length-limited strings
402 * @cs: One string
403 * @ct: Another string
404 * @count: The maximum number of bytes to compare
405 */
Jesper Juhl51a0f0f2005-10-30 15:02:11 -0800406int strncmp(const char *cs, const char *ct, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407{
Linus Torvaldsa414f012009-11-18 22:31:52 +0100408 unsigned char c1, c2;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409
410 while (count) {
Linus Torvaldsa414f012009-11-18 22:31:52 +0100411 c1 = *cs++;
412 c2 = *ct++;
413 if (c1 != c2)
414 return c1 < c2 ? -1 : 1;
415 if (!c1)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700416 break;
417 count--;
418 }
Linus Torvaldsa414f012009-11-18 22:31:52 +0100419 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420}
421EXPORT_SYMBOL(strncmp);
422#endif
423
424#ifndef __HAVE_ARCH_STRCHR
425/**
426 * strchr - Find the first occurrence of a character in a string
427 * @s: The string to be searched
428 * @c: The character to search for
Peter Rosinb0975712019-07-16 16:27:15 -0700429 *
430 * Note that the %NUL-terminator is considered part of the string, and can
431 * be searched for.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432 */
Jesper Juhl51a0f0f2005-10-30 15:02:11 -0800433char *strchr(const char *s, int c)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434{
Jesper Juhl51a0f0f2005-10-30 15:02:11 -0800435 for (; *s != (char)c; ++s)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700436 if (*s == '\0')
437 return NULL;
Jesper Juhl51a0f0f2005-10-30 15:02:11 -0800438 return (char *)s;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439}
440EXPORT_SYMBOL(strchr);
441#endif
442
Grant Likely11d200e2014-03-14 17:00:14 +0000443#ifndef __HAVE_ARCH_STRCHRNUL
444/**
445 * strchrnul - Find and return a character in a string, or end of string
446 * @s: The string to be searched
447 * @c: The character to search for
448 *
449 * Returns pointer to first occurrence of 'c' in s. If c is not found, then
450 * return a pointer to the null byte at the end of s.
451 */
452char *strchrnul(const char *s, int c)
453{
454 while (*s && *s != (char)c)
455 s++;
456 return (char *)s;
457}
458EXPORT_SYMBOL(strchrnul);
459#endif
460
Yury Norov0bee0ce2020-02-03 17:37:20 -0800461/**
462 * strnchrnul - Find and return a character in a length limited string,
463 * or end of string
464 * @s: The string to be searched
465 * @count: The number of characters to be searched
466 * @c: The character to search for
467 *
468 * Returns pointer to the first occurrence of 'c' in s. If c is not found,
469 * then return a pointer to the last character of the string.
470 */
471char *strnchrnul(const char *s, size_t count, int c)
472{
473 while (count-- && *s && *s != (char)c)
474 s++;
475 return (char *)s;
476}
477
Linus Torvalds1da177e2005-04-16 15:20:36 -0700478#ifndef __HAVE_ARCH_STRRCHR
479/**
480 * strrchr - Find the last occurrence of a character in a string
481 * @s: The string to be searched
482 * @c: The character to search for
483 */
Jesper Juhl51a0f0f2005-10-30 15:02:11 -0800484char *strrchr(const char *s, int c)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700485{
Rasmus Villemoes8da53d42015-02-13 14:36:44 -0800486 const char *last = NULL;
487 do {
488 if (*s == (char)c)
489 last = s;
490 } while (*s++);
491 return (char *)last;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700492}
493EXPORT_SYMBOL(strrchr);
494#endif
495
496#ifndef __HAVE_ARCH_STRNCHR
497/**
498 * strnchr - Find a character in a length limited string
499 * @s: The string to be searched
500 * @count: The number of characters to be searched
501 * @c: The character to search for
Peter Rosinb0975712019-07-16 16:27:15 -0700502 *
503 * Note that the %NUL-terminator is considered part of the string, and can
504 * be searched for.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505 */
506char *strnchr(const char *s, size_t count, int c)
507{
Peter Rosinb0975712019-07-16 16:27:15 -0700508 while (count--) {
Jesper Juhl51a0f0f2005-10-30 15:02:11 -0800509 if (*s == (char)c)
510 return (char *)s;
Peter Rosinb0975712019-07-16 16:27:15 -0700511 if (*s++ == '\0')
512 break;
513 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514 return NULL;
515}
516EXPORT_SYMBOL(strnchr);
517#endif
518
Pekka Enberg481fad42006-06-23 02:05:44 -0700519/**
Randy Dunlapa6cd13f2009-12-21 14:37:22 -0800520 * skip_spaces - Removes leading whitespace from @str.
521 * @str: The string to be stripped.
André Goddard Rosaf6533982009-12-14 18:01:04 -0800522 *
Randy Dunlapa6cd13f2009-12-21 14:37:22 -0800523 * Returns a pointer to the first non-whitespace character in @str.
André Goddard Rosaf6533982009-12-14 18:01:04 -0800524 */
525char *skip_spaces(const char *str)
526{
527 while (isspace(*str))
528 ++str;
529 return (char *)str;
530}
531EXPORT_SYMBOL(skip_spaces);
532
533/**
KOSAKI Motohiroca54cb82009-12-14 18:01:15 -0800534 * strim - Removes leading and trailing whitespace from @s.
Pekka Enberg481fad42006-06-23 02:05:44 -0700535 * @s: The string to be stripped.
536 *
537 * Note that the first trailing whitespace is replaced with a %NUL-terminator
538 * in the given string @s. Returns a pointer to the first non-whitespace
539 * character in @s.
540 */
KOSAKI Motohiroca54cb82009-12-14 18:01:15 -0800541char *strim(char *s)
Pekka Enberg481fad42006-06-23 02:05:44 -0700542{
543 size_t size;
544 char *end;
545
546 size = strlen(s);
Pekka Enberg481fad42006-06-23 02:05:44 -0700547 if (!size)
548 return s;
549
550 end = s + size - 1;
Michael Holzheu6e6d9fa2006-10-28 10:38:47 -0700551 while (end >= s && isspace(*end))
Pekka Enberg481fad42006-06-23 02:05:44 -0700552 end--;
553 *(end + 1) = '\0';
554
Michael Holzheu66f69582011-10-31 17:12:37 -0700555 return skip_spaces(s);
Pekka Enberg481fad42006-06-23 02:05:44 -0700556}
KOSAKI Motohiroca54cb82009-12-14 18:01:15 -0800557EXPORT_SYMBOL(strim);
Pekka Enberg481fad42006-06-23 02:05:44 -0700558
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559#ifndef __HAVE_ARCH_STRLEN
560/**
561 * strlen - Find the length of a string
562 * @s: The string to be sized
563 */
Jesper Juhl51a0f0f2005-10-30 15:02:11 -0800564size_t strlen(const char *s)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565{
566 const char *sc;
567
568 for (sc = s; *sc != '\0'; ++sc)
569 /* nothing */;
570 return sc - s;
571}
572EXPORT_SYMBOL(strlen);
573#endif
574
575#ifndef __HAVE_ARCH_STRNLEN
576/**
577 * strnlen - Find the length of a length-limited string
578 * @s: The string to be sized
579 * @count: The maximum number of bytes to search
580 */
Jesper Juhl51a0f0f2005-10-30 15:02:11 -0800581size_t strnlen(const char *s, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582{
583 const char *sc;
584
585 for (sc = s; count-- && *sc != '\0'; ++sc)
586 /* nothing */;
587 return sc - s;
588}
589EXPORT_SYMBOL(strnlen);
590#endif
591
592#ifndef __HAVE_ARCH_STRSPN
593/**
Robert P. J. Day72fd4a32007-02-10 01:45:59 -0800594 * strspn - Calculate the length of the initial substring of @s which only contain letters in @accept
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595 * @s: The string to be searched
596 * @accept: The string to search for
597 */
598size_t strspn(const char *s, const char *accept)
599{
600 const char *p;
601 const char *a;
602 size_t count = 0;
603
604 for (p = s; *p != '\0'; ++p) {
605 for (a = accept; *a != '\0'; ++a) {
606 if (*p == *a)
607 break;
608 }
609 if (*a == '\0')
610 return count;
611 ++count;
612 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613 return count;
614}
615
616EXPORT_SYMBOL(strspn);
617#endif
618
Kyle McMartin8833d322006-04-10 22:53:57 -0700619#ifndef __HAVE_ARCH_STRCSPN
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620/**
Robert P. J. Day72fd4a32007-02-10 01:45:59 -0800621 * strcspn - Calculate the length of the initial substring of @s which does not contain letters in @reject
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622 * @s: The string to be searched
623 * @reject: The string to avoid
624 */
625size_t strcspn(const char *s, const char *reject)
626{
627 const char *p;
628 const char *r;
629 size_t count = 0;
630
631 for (p = s; *p != '\0'; ++p) {
632 for (r = reject; *r != '\0'; ++r) {
633 if (*p == *r)
634 return count;
635 }
636 ++count;
637 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638 return count;
Jesper Juhl51a0f0f2005-10-30 15:02:11 -0800639}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640EXPORT_SYMBOL(strcspn);
Kyle McMartin8833d322006-04-10 22:53:57 -0700641#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700642
643#ifndef __HAVE_ARCH_STRPBRK
644/**
645 * strpbrk - Find the first occurrence of a set of characters
646 * @cs: The string to be searched
647 * @ct: The characters to search for
648 */
Jesper Juhl51a0f0f2005-10-30 15:02:11 -0800649char *strpbrk(const char *cs, const char *ct)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650{
Jesper Juhl51a0f0f2005-10-30 15:02:11 -0800651 const char *sc1, *sc2;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652
Jesper Juhl51a0f0f2005-10-30 15:02:11 -0800653 for (sc1 = cs; *sc1 != '\0'; ++sc1) {
654 for (sc2 = ct; *sc2 != '\0'; ++sc2) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655 if (*sc1 == *sc2)
Jesper Juhl51a0f0f2005-10-30 15:02:11 -0800656 return (char *)sc1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657 }
658 }
659 return NULL;
660}
Kyle McMartin894b5772006-04-10 22:53:56 -0700661EXPORT_SYMBOL(strpbrk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700662#endif
663
664#ifndef __HAVE_ARCH_STRSEP
665/**
666 * strsep - Split a string into tokens
667 * @s: The string to be searched
668 * @ct: The characters to search for
669 *
670 * strsep() updates @s to point after the token, ready for the next call.
671 *
672 * It returns empty tokens, too, behaving exactly like the libc function
673 * of that name. In fact, it was stolen from glibc2 and de-fancy-fied.
674 * Same semantics, slimmer shape. ;)
675 */
Jesper Juhl51a0f0f2005-10-30 15:02:11 -0800676char *strsep(char **s, const char *ct)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677{
Jesper Juhl51a0f0f2005-10-30 15:02:11 -0800678 char *sbegin = *s;
679 char *end;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700680
681 if (sbegin == NULL)
682 return NULL;
683
684 end = strpbrk(sbegin, ct);
685 if (end)
686 *end++ = '\0';
687 *s = end;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700688 return sbegin;
689}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700690EXPORT_SYMBOL(strsep);
691#endif
692
David Brownell34990cf2008-05-01 04:34:42 -0700693/**
694 * sysfs_streq - return true if strings are equal, modulo trailing newline
695 * @s1: one string
696 * @s2: another string
697 *
698 * This routine returns true iff two strings are equal, treating both
699 * NUL and newline-then-NUL as equivalent string terminations. It's
700 * geared for use with sysfs input strings, which generally terminate
701 * with newlines but are compared against values without newlines.
702 */
703bool sysfs_streq(const char *s1, const char *s2)
704{
705 while (*s1 && *s1 == *s2) {
706 s1++;
707 s2++;
708 }
709
710 if (*s1 == *s2)
711 return true;
712 if (!*s1 && *s2 == '\n' && !s2[1])
713 return true;
714 if (*s1 == '\n' && !s1[1] && !*s2)
715 return true;
716 return false;
717}
718EXPORT_SYMBOL(sysfs_streq);
719
Jonathan Camerond0f1fed2011-04-19 12:43:45 +0100720/**
Andy Shevchenko56b06082016-03-17 14:22:14 -0700721 * match_string - matches given string in an array
722 * @array: array of strings
723 * @n: number of strings in the array or -1 for NULL terminated arrays
724 * @string: string to match with
725 *
Alexandru Ardeleanc11d3fa2020-02-20 20:04:21 -0800726 * This routine will look for a string in an array of strings up to the
727 * n-th element in the array or until the first NULL element.
728 *
729 * Historically the value of -1 for @n, was used to search in arrays that
730 * are NULL terminated. However, the function does not make a distinction
731 * when finishing the search: either @n elements have been compared OR
732 * the first NULL element was found.
733 *
Andy Shevchenko56b06082016-03-17 14:22:14 -0700734 * Return:
735 * index of a @string in the @array if matches, or %-EINVAL otherwise.
736 */
737int match_string(const char * const *array, size_t n, const char *string)
738{
739 int index;
740 const char *item;
741
742 for (index = 0; index < n; index++) {
743 item = array[index];
744 if (!item)
745 break;
746 if (!strcmp(item, string))
747 return index;
748 }
749
750 return -EINVAL;
751}
752EXPORT_SYMBOL(match_string);
753
Heikki Krogeruse1fe7b62017-03-21 13:56:46 +0200754/**
755 * __sysfs_match_string - matches given string in an array
756 * @array: array of strings
757 * @n: number of strings in the array or -1 for NULL terminated arrays
758 * @str: string to match with
759 *
760 * Returns index of @str in the @array or -EINVAL, just like match_string().
761 * Uses sysfs_streq instead of strcmp for matching.
Alexandru Ardeleanc11d3fa2020-02-20 20:04:21 -0800762 *
763 * This routine will look for a string in an array of strings up to the
764 * n-th element in the array or until the first NULL element.
765 *
766 * Historically the value of -1 for @n, was used to search in arrays that
767 * are NULL terminated. However, the function does not make a distinction
768 * when finishing the search: either @n elements have been compared OR
769 * the first NULL element was found.
Heikki Krogeruse1fe7b62017-03-21 13:56:46 +0200770 */
771int __sysfs_match_string(const char * const *array, size_t n, const char *str)
772{
773 const char *item;
774 int index;
775
776 for (index = 0; index < n; index++) {
777 item = array[index];
778 if (!item)
779 break;
780 if (sysfs_streq(item, str))
781 return index;
782 }
783
784 return -EINVAL;
785}
786EXPORT_SYMBOL(__sysfs_match_string);
787
Linus Torvalds1da177e2005-04-16 15:20:36 -0700788#ifndef __HAVE_ARCH_MEMSET
789/**
790 * memset - Fill a region of memory with the given value
791 * @s: Pointer to the start of the area.
792 * @c: The byte to fill the area with
793 * @count: The size of the area.
794 *
795 * Do not use memset() to access IO space, use memset_io() instead.
796 */
Jesper Juhl51a0f0f2005-10-30 15:02:11 -0800797void *memset(void *s, int c, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700798{
Jesper Juhl850b9242005-10-30 15:02:13 -0800799 char *xs = s;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700800
801 while (count--)
802 *xs++ = c;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700803 return s;
804}
805EXPORT_SYMBOL(memset);
806#endif
807
Matthew Wilcox3b3c4ba2017-09-08 16:13:48 -0700808#ifndef __HAVE_ARCH_MEMSET16
809/**
810 * memset16() - Fill a memory area with a uint16_t
811 * @s: Pointer to the start of the area.
812 * @v: The value to fill the area with
813 * @count: The number of values to store
814 *
815 * Differs from memset() in that it fills with a uint16_t instead
816 * of a byte. Remember that @count is the number of uint16_ts to
817 * store, not the number of bytes.
818 */
819void *memset16(uint16_t *s, uint16_t v, size_t count)
820{
821 uint16_t *xs = s;
822
823 while (count--)
824 *xs++ = v;
825 return s;
826}
827EXPORT_SYMBOL(memset16);
828#endif
829
830#ifndef __HAVE_ARCH_MEMSET32
831/**
832 * memset32() - Fill a memory area with a uint32_t
833 * @s: Pointer to the start of the area.
834 * @v: The value to fill the area with
835 * @count: The number of values to store
836 *
837 * Differs from memset() in that it fills with a uint32_t instead
838 * of a byte. Remember that @count is the number of uint32_ts to
839 * store, not the number of bytes.
840 */
841void *memset32(uint32_t *s, uint32_t v, size_t count)
842{
843 uint32_t *xs = s;
844
845 while (count--)
846 *xs++ = v;
847 return s;
848}
849EXPORT_SYMBOL(memset32);
850#endif
851
852#ifndef __HAVE_ARCH_MEMSET64
853/**
854 * memset64() - Fill a memory area with a uint64_t
855 * @s: Pointer to the start of the area.
856 * @v: The value to fill the area with
857 * @count: The number of values to store
858 *
859 * Differs from memset() in that it fills with a uint64_t instead
860 * of a byte. Remember that @count is the number of uint64_ts to
861 * store, not the number of bytes.
862 */
863void *memset64(uint64_t *s, uint64_t v, size_t count)
864{
865 uint64_t *xs = s;
866
867 while (count--)
868 *xs++ = v;
869 return s;
870}
871EXPORT_SYMBOL(memset64);
872#endif
873
Linus Torvalds1da177e2005-04-16 15:20:36 -0700874#ifndef __HAVE_ARCH_MEMCPY
875/**
876 * memcpy - Copy one area of memory to another
877 * @dest: Where to copy to
878 * @src: Where to copy from
879 * @count: The size of the area.
880 *
881 * You should not use this function to access IO space, use memcpy_toio()
882 * or memcpy_fromio() instead.
883 */
Jesper Juhl51a0f0f2005-10-30 15:02:11 -0800884void *memcpy(void *dest, const void *src, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700885{
Jesper Juhl850b9242005-10-30 15:02:13 -0800886 char *tmp = dest;
Jan-Benedict Glaw4c416ab2006-04-10 22:54:09 -0700887 const char *s = src;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700888
889 while (count--)
890 *tmp++ = *s++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700891 return dest;
892}
893EXPORT_SYMBOL(memcpy);
894#endif
895
896#ifndef __HAVE_ARCH_MEMMOVE
897/**
898 * memmove - Copy one area of memory to another
899 * @dest: Where to copy to
900 * @src: Where to copy from
901 * @count: The size of the area.
902 *
903 * Unlike memcpy(), memmove() copes with overlapping areas.
904 */
Jesper Juhl51a0f0f2005-10-30 15:02:11 -0800905void *memmove(void *dest, const void *src, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700906{
Paul Jackson82da2c32005-10-30 15:03:19 -0800907 char *tmp;
908 const char *s;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700909
910 if (dest <= src) {
Jesper Juhl850b9242005-10-30 15:02:13 -0800911 tmp = dest;
912 s = src;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700913 while (count--)
914 *tmp++ = *s++;
Jesper Juhl51a0f0f2005-10-30 15:02:11 -0800915 } else {
Jesper Juhl850b9242005-10-30 15:02:13 -0800916 tmp = dest;
917 tmp += count;
918 s = src;
919 s += count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700920 while (count--)
921 *--tmp = *--s;
Jesper Juhl51a0f0f2005-10-30 15:02:11 -0800922 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700923 return dest;
924}
925EXPORT_SYMBOL(memmove);
926#endif
927
928#ifndef __HAVE_ARCH_MEMCMP
929/**
930 * memcmp - Compare two areas of memory
931 * @cs: One area of memory
932 * @ct: Another area of memory
933 * @count: The size of the area.
934 */
Paolo 'Blaisorblade' Giarrusso0c281302005-05-05 16:15:17 -0700935#undef memcmp
Andi Kleena7330c92014-02-08 08:52:06 +0100936__visible int memcmp(const void *cs, const void *ct, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700937{
938 const unsigned char *su1, *su2;
939 int res = 0;
940
Jesper Juhl51a0f0f2005-10-30 15:02:11 -0800941 for (su1 = cs, su2 = ct; 0 < count; ++su1, ++su2, count--)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700942 if ((res = *su1 - *su2) != 0)
943 break;
944 return res;
945}
946EXPORT_SYMBOL(memcmp);
947#endif
948
Nick Desaulniers5f074f32019-04-05 18:38:45 -0700949#ifndef __HAVE_ARCH_BCMP
950/**
951 * bcmp - returns 0 if and only if the buffers have identical contents.
952 * @a: pointer to first buffer.
953 * @b: pointer to second buffer.
954 * @len: size of buffers.
955 *
956 * The sign or magnitude of a non-zero return value has no particular
957 * meaning, and architectures may implement their own more efficient bcmp(). So
958 * while this particular implementation is a simple (tail) call to memcmp, do
959 * not rely on anything but whether the return value is zero or non-zero.
960 */
961#undef bcmp
962int bcmp(const void *a, const void *b, size_t len)
963{
964 return memcmp(a, b, len);
965}
966EXPORT_SYMBOL(bcmp);
967#endif
968
Linus Torvalds1da177e2005-04-16 15:20:36 -0700969#ifndef __HAVE_ARCH_MEMSCAN
970/**
971 * memscan - Find a character in an area of memory.
972 * @addr: The memory area
973 * @c: The byte to search for
974 * @size: The size of the area.
975 *
976 * returns the address of the first occurrence of @c, or 1 byte past
977 * the area if @c is not found
978 */
Jesper Juhl51a0f0f2005-10-30 15:02:11 -0800979void *memscan(void *addr, int c, size_t size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700980{
Jesper Juhl850b9242005-10-30 15:02:13 -0800981 unsigned char *p = addr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700982
983 while (size) {
984 if (*p == c)
Jesper Juhl51a0f0f2005-10-30 15:02:11 -0800985 return (void *)p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700986 p++;
987 size--;
988 }
Jesper Juhl51a0f0f2005-10-30 15:02:11 -0800989 return (void *)p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700990}
991EXPORT_SYMBOL(memscan);
992#endif
993
994#ifndef __HAVE_ARCH_STRSTR
995/**
996 * strstr - Find the first substring in a %NUL terminated string
997 * @s1: The string to be searched
998 * @s2: The string to search for
999 */
Jesper Juhl51a0f0f2005-10-30 15:02:11 -08001000char *strstr(const char *s1, const char *s2)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001001{
Li Zefand5f1fb52010-01-14 10:53:55 +08001002 size_t l1, l2;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001003
1004 l2 = strlen(s2);
1005 if (!l2)
Jesper Juhl51a0f0f2005-10-30 15:02:11 -08001006 return (char *)s1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001007 l1 = strlen(s1);
1008 while (l1 >= l2) {
1009 l1--;
Jesper Juhl51a0f0f2005-10-30 15:02:11 -08001010 if (!memcmp(s1, s2, l2))
1011 return (char *)s1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001012 s1++;
1013 }
1014 return NULL;
1015}
1016EXPORT_SYMBOL(strstr);
1017#endif
1018
Li Zefand5f1fb52010-01-14 10:53:55 +08001019#ifndef __HAVE_ARCH_STRNSTR
1020/**
1021 * strnstr - Find the first substring in a length-limited string
1022 * @s1: The string to be searched
1023 * @s2: The string to search for
1024 * @len: the maximum number of characters to search
1025 */
1026char *strnstr(const char *s1, const char *s2, size_t len)
1027{
André Goddard Rosad6a2eed2010-03-05 13:43:12 -08001028 size_t l2;
Li Zefand5f1fb52010-01-14 10:53:55 +08001029
1030 l2 = strlen(s2);
1031 if (!l2)
1032 return (char *)s1;
André Goddard Rosad6a2eed2010-03-05 13:43:12 -08001033 while (len >= l2) {
1034 len--;
Li Zefand5f1fb52010-01-14 10:53:55 +08001035 if (!memcmp(s1, s2, l2))
1036 return (char *)s1;
1037 s1++;
1038 }
1039 return NULL;
1040}
1041EXPORT_SYMBOL(strnstr);
1042#endif
1043
Linus Torvalds1da177e2005-04-16 15:20:36 -07001044#ifndef __HAVE_ARCH_MEMCHR
1045/**
1046 * memchr - Find a character in an area of memory.
1047 * @s: The memory area
1048 * @c: The byte to search for
1049 * @n: The size of the area.
1050 *
1051 * returns the address of the first occurrence of @c, or %NULL
1052 * if @c is not found
1053 */
1054void *memchr(const void *s, int c, size_t n)
1055{
1056 const unsigned char *p = s;
1057 while (n-- != 0) {
1058 if ((unsigned char)c == *p++) {
Jesper Juhl51a0f0f2005-10-30 15:02:11 -08001059 return (void *)(p - 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001060 }
1061 }
1062 return NULL;
1063}
1064EXPORT_SYMBOL(memchr);
1065#endif
Akinobu Mita798248202011-10-31 17:08:07 -07001066
1067static void *check_bytes8(const u8 *start, u8 value, unsigned int bytes)
1068{
1069 while (bytes) {
1070 if (*start != value)
1071 return (void *)start;
1072 start++;
1073 bytes--;
1074 }
1075 return NULL;
1076}
1077
1078/**
1079 * memchr_inv - Find an unmatching character in an area of memory.
1080 * @start: The memory area
1081 * @c: Find a character other than c
1082 * @bytes: The size of the area.
1083 *
1084 * returns the address of the first character other than @c, or %NULL
1085 * if the whole buffer contains just @c.
1086 */
1087void *memchr_inv(const void *start, int c, size_t bytes)
1088{
1089 u8 value = c;
1090 u64 value64;
1091 unsigned int words, prefix;
1092
1093 if (bytes <= 16)
1094 return check_bytes8(start, value, bytes);
1095
Akinobu Mitaf43804b2012-03-23 15:02:14 -07001096 value64 = value;
Linus Torvalds72d93102014-09-13 11:14:53 -07001097#if defined(CONFIG_ARCH_HAS_FAST_MULTIPLIER) && BITS_PER_LONG == 64
Andy Shevchenko3368e8f2015-11-10 14:45:14 -08001098 value64 *= 0x0101010101010101ULL;
Linus Torvalds72d93102014-09-13 11:14:53 -07001099#elif defined(CONFIG_ARCH_HAS_FAST_MULTIPLIER)
Akinobu Mitaf43804b2012-03-23 15:02:14 -07001100 value64 *= 0x01010101;
1101 value64 |= value64 << 32;
1102#else
1103 value64 |= value64 << 8;
1104 value64 |= value64 << 16;
1105 value64 |= value64 << 32;
1106#endif
Akinobu Mita798248202011-10-31 17:08:07 -07001107
Akinobu Mitaf43804b2012-03-23 15:02:14 -07001108 prefix = (unsigned long)start % 8;
Akinobu Mita798248202011-10-31 17:08:07 -07001109 if (prefix) {
Akinobu Mitaf43804b2012-03-23 15:02:14 -07001110 u8 *r;
1111
1112 prefix = 8 - prefix;
1113 r = check_bytes8(start, value, prefix);
Akinobu Mita798248202011-10-31 17:08:07 -07001114 if (r)
1115 return r;
1116 start += prefix;
1117 bytes -= prefix;
1118 }
1119
1120 words = bytes / 8;
1121
1122 while (words) {
1123 if (*(u64 *)start != value64)
1124 return check_bytes8(start, value, 8);
1125 start += 8;
1126 words--;
1127 }
1128
1129 return check_bytes8(start, value, bytes % 8);
1130}
1131EXPORT_SYMBOL(memchr_inv);
Rasmus Villemoes94df2902015-06-25 15:02:22 -07001132
1133/**
1134 * strreplace - Replace all occurrences of character in string.
1135 * @s: The string to operate on.
1136 * @old: The character being replaced.
1137 * @new: The character @old is replaced with.
1138 *
1139 * Returns pointer to the nul byte at the end of @s.
1140 */
1141char *strreplace(char *s, char old, char new)
1142{
1143 for (; *s; ++s)
1144 if (*s == old)
1145 *s = new;
1146 return s;
1147}
1148EXPORT_SYMBOL(strreplace);
Daniel Micay6974f0c2017-07-12 14:36:10 -07001149
1150void fortify_panic(const char *name)
1151{
1152 pr_emerg("detected buffer overflow in %s\n", name);
1153 BUG();
1154}
1155EXPORT_SYMBOL(fortify_panic);