Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
1/* SPDX-License-Identifier: GPL-2.0 */
2#ifndef _LINUX_STRING_H_
3#define _LINUX_STRING_H_
4
5#include <linux/args.h>
6#include <linux/array_size.h>
7#include <linux/cleanup.h> /* for DEFINE_FREE() */
8#include <linux/compiler.h> /* for inline */
9#include <linux/types.h> /* for size_t */
10#include <linux/stddef.h> /* for NULL */
11#include <linux/err.h> /* for ERR_PTR() */
12#include <linux/errno.h> /* for E2BIG */
13#include <linux/overflow.h> /* for check_mul_overflow() */
14#include <linux/stdarg.h>
15#include <uapi/linux/string.h>
16
17extern char *strndup_user(const char __user *, long);
18extern void *memdup_user(const void __user *, size_t) __realloc_size(2);
19extern void *vmemdup_user(const void __user *, size_t) __realloc_size(2);
20extern void *memdup_user_nul(const void __user *, size_t);
21
22/**
23 * memdup_array_user - duplicate array from user space
24 * @src: source address in user space
25 * @n: number of array members to copy
26 * @size: size of one array member
27 *
28 * Return: an ERR_PTR() on failure. Result is physically
29 * contiguous, to be freed by kfree().
30 */
31static inline __realloc_size(2, 3)
32void *memdup_array_user(const void __user *src, size_t n, size_t size)
33{
34 size_t nbytes;
35
36 if (check_mul_overflow(n, size, &nbytes))
37 return ERR_PTR(-EOVERFLOW);
38
39 return memdup_user(src, nbytes);
40}
41
42/**
43 * vmemdup_array_user - duplicate array from user space
44 * @src: source address in user space
45 * @n: number of array members to copy
46 * @size: size of one array member
47 *
48 * Return: an ERR_PTR() on failure. Result may be not
49 * physically contiguous. Use kvfree() to free.
50 */
51static inline __realloc_size(2, 3)
52void *vmemdup_array_user(const void __user *src, size_t n, size_t size)
53{
54 size_t nbytes;
55
56 if (check_mul_overflow(n, size, &nbytes))
57 return ERR_PTR(-EOVERFLOW);
58
59 return vmemdup_user(src, nbytes);
60}
61
62/*
63 * Include machine specific inline routines
64 */
65#include <asm/string.h>
66
67#ifndef __HAVE_ARCH_STRCPY
68extern char * strcpy(char *,const char *);
69#endif
70#ifndef __HAVE_ARCH_STRNCPY
71extern char * strncpy(char *,const char *, __kernel_size_t);
72#endif
73ssize_t sized_strscpy(char *, const char *, size_t);
74
75/*
76 * The 2 argument style can only be used when dst is an array with a
77 * known size.
78 */
79#define __strscpy0(dst, src, ...) \
80 sized_strscpy(dst, src, sizeof(dst) + __must_be_array(dst) + \
81 __must_be_cstr(dst) + __must_be_cstr(src))
82#define __strscpy1(dst, src, size) \
83 sized_strscpy(dst, src, size + __must_be_cstr(dst) + __must_be_cstr(src))
84
85#define __strscpy_pad0(dst, src, ...) \
86 sized_strscpy_pad(dst, src, sizeof(dst) + __must_be_array(dst) + \
87 __must_be_cstr(dst) + __must_be_cstr(src))
88#define __strscpy_pad1(dst, src, size) \
89 sized_strscpy_pad(dst, src, size + __must_be_cstr(dst) + __must_be_cstr(src))
90
91/**
92 * strscpy - Copy a C-string into a sized buffer
93 * @dst: Where to copy the string to
94 * @src: Where to copy the string from
95 * @...: Size of destination buffer (optional)
96 *
97 * Copy the source string @src, or as much of it as fits, into the
98 * destination @dst buffer. The behavior is undefined if the string
99 * buffers overlap. The destination @dst buffer is always NUL terminated,
100 * unless it's zero-sized.
101 *
102 * The size argument @... is only required when @dst is not an array, or
103 * when the copy needs to be smaller than sizeof(@dst).
104 *
105 * Preferred to strncpy() since it always returns a valid string, and
106 * doesn't unnecessarily force the tail of the destination buffer to be
107 * zero padded. If padding is desired please use strscpy_pad().
108 *
109 * Returns the number of characters copied in @dst (not including the
110 * trailing %NUL) or -E2BIG if @size is 0 or the copy from @src was
111 * truncated.
112 */
113#define strscpy(dst, src, ...) \
114 CONCATENATE(__strscpy, COUNT_ARGS(__VA_ARGS__))(dst, src, __VA_ARGS__)
115
116#define sized_strscpy_pad(dest, src, count) ({ \
117 char *__dst = (dest); \
118 const char *__src = (src); \
119 const size_t __count = (count); \
120 ssize_t __wrote; \
121 \
122 __wrote = sized_strscpy(__dst, __src, __count); \
123 if (__wrote >= 0 && __wrote < __count) \
124 memset(__dst + __wrote + 1, 0, __count - __wrote - 1); \
125 __wrote; \
126})
127
128/**
129 * strscpy_pad() - Copy a C-string into a sized buffer
130 * @dst: Where to copy the string to
131 * @src: Where to copy the string from
132 * @...: Size of destination buffer
133 *
134 * Copy the string, or as much of it as fits, into the dest buffer. The
135 * behavior is undefined if the string buffers overlap. The destination
136 * buffer is always %NUL terminated, unless it's zero-sized.
137 *
138 * If the source string is shorter than the destination buffer, the
139 * remaining bytes in the buffer will be filled with %NUL bytes.
140 *
141 * For full explanation of why you may want to consider using the
142 * 'strscpy' functions please see the function docstring for strscpy().
143 *
144 * Returns:
145 * * The number of characters copied (not including the trailing %NULs)
146 * * -E2BIG if count is 0 or @src was truncated.
147 */
148#define strscpy_pad(dst, src, ...) \
149 CONCATENATE(__strscpy_pad, COUNT_ARGS(__VA_ARGS__))(dst, src, __VA_ARGS__)
150
151#ifndef __HAVE_ARCH_STRCAT
152extern char * strcat(char *, const char *);
153#endif
154#ifndef __HAVE_ARCH_STRNCAT
155extern char * strncat(char *, const char *, __kernel_size_t);
156#endif
157#ifndef __HAVE_ARCH_STRLCAT
158extern size_t strlcat(char *, const char *, __kernel_size_t);
159#endif
160#ifndef __HAVE_ARCH_STRCMP
161extern int strcmp(const char *,const char *);
162#endif
163#ifndef __HAVE_ARCH_STRNCMP
164extern int strncmp(const char *,const char *,__kernel_size_t);
165#endif
166#ifndef __HAVE_ARCH_STRCASECMP
167extern int strcasecmp(const char *s1, const char *s2);
168#endif
169#ifndef __HAVE_ARCH_STRNCASECMP
170extern int strncasecmp(const char *s1, const char *s2, size_t n);
171#endif
172#ifndef __HAVE_ARCH_STRCHR
173extern char * strchr(const char *,int);
174#endif
175#ifndef __HAVE_ARCH_STRCHRNUL
176extern char * strchrnul(const char *,int);
177#endif
178extern char * strnchrnul(const char *, size_t, int);
179#ifndef __HAVE_ARCH_STRNCHR
180extern char * strnchr(const char *, size_t, int);
181#endif
182#ifndef __HAVE_ARCH_STRRCHR
183extern char * strrchr(const char *,int);
184#endif
185extern char * __must_check skip_spaces(const char *);
186
187extern char *strim(char *);
188
189static inline __must_check char *strstrip(char *str)
190{
191 return strim(str);
192}
193
194#ifndef __HAVE_ARCH_STRSTR
195extern char * strstr(const char *, const char *);
196#endif
197#ifndef __HAVE_ARCH_STRNSTR
198extern char * strnstr(const char *, const char *, size_t);
199#endif
200#ifndef __HAVE_ARCH_STRLEN
201extern __kernel_size_t strlen(const char *);
202#endif
203#ifndef __HAVE_ARCH_STRNLEN
204extern __kernel_size_t strnlen(const char *,__kernel_size_t);
205#endif
206#ifndef __HAVE_ARCH_STRPBRK
207extern char * strpbrk(const char *,const char *);
208#endif
209#ifndef __HAVE_ARCH_STRSEP
210extern char * strsep(char **,const char *);
211#endif
212#ifndef __HAVE_ARCH_STRSPN
213extern __kernel_size_t strspn(const char *,const char *);
214#endif
215#ifndef __HAVE_ARCH_STRCSPN
216extern __kernel_size_t strcspn(const char *,const char *);
217#endif
218
219#ifndef __HAVE_ARCH_MEMSET
220extern void * memset(void *,int,__kernel_size_t);
221#endif
222
223#ifndef __HAVE_ARCH_MEMSET16
224extern void *memset16(uint16_t *, uint16_t, __kernel_size_t);
225#endif
226
227#ifndef __HAVE_ARCH_MEMSET32
228extern void *memset32(uint32_t *, uint32_t, __kernel_size_t);
229#endif
230
231#ifndef __HAVE_ARCH_MEMSET64
232extern void *memset64(uint64_t *, uint64_t, __kernel_size_t);
233#endif
234
235static inline void *memset_l(unsigned long *p, unsigned long v,
236 __kernel_size_t n)
237{
238 if (BITS_PER_LONG == 32)
239 return memset32((uint32_t *)p, v, n);
240 else
241 return memset64((uint64_t *)p, v, n);
242}
243
244static inline void *memset_p(void **p, void *v, __kernel_size_t n)
245{
246 if (BITS_PER_LONG == 32)
247 return memset32((uint32_t *)p, (uintptr_t)v, n);
248 else
249 return memset64((uint64_t *)p, (uintptr_t)v, n);
250}
251
252extern void **__memcat_p(void **a, void **b);
253#define memcat_p(a, b) ({ \
254 BUILD_BUG_ON_MSG(!__same_type(*(a), *(b)), \
255 "type mismatch in memcat_p()"); \
256 (typeof(*a) *)__memcat_p((void **)(a), (void **)(b)); \
257})
258
259#ifndef __HAVE_ARCH_MEMCPY
260extern void * memcpy(void *,const void *,__kernel_size_t);
261#endif
262#ifndef __HAVE_ARCH_MEMMOVE
263extern void * memmove(void *,const void *,__kernel_size_t);
264#endif
265#ifndef __HAVE_ARCH_MEMSCAN
266extern void * memscan(void *,int,__kernel_size_t);
267#endif
268#ifndef __HAVE_ARCH_MEMCMP
269extern int memcmp(const void *,const void *,__kernel_size_t);
270#endif
271#ifndef __HAVE_ARCH_BCMP
272extern int bcmp(const void *,const void *,__kernel_size_t);
273#endif
274#ifndef __HAVE_ARCH_MEMCHR
275extern void * memchr(const void *,int,__kernel_size_t);
276#endif
277#ifndef __HAVE_ARCH_MEMCPY_FLUSHCACHE
278static inline void memcpy_flushcache(void *dst, const void *src, size_t cnt)
279{
280 memcpy(dst, src, cnt);
281}
282#endif
283
284void *memchr_inv(const void *s, int c, size_t n);
285char *strreplace(char *str, char old, char new);
286
287/**
288 * mem_is_zero - Check if an area of memory is all 0's.
289 * @s: The memory area
290 * @n: The size of the area
291 *
292 * Return: True if the area of memory is all 0's.
293 */
294static inline bool mem_is_zero(const void *s, size_t n)
295{
296 return !memchr_inv(s, 0, n);
297}
298
299extern void kfree_const(const void *x);
300
301extern char *kstrdup(const char *s, gfp_t gfp) __malloc;
302extern const char *kstrdup_const(const char *s, gfp_t gfp);
303extern char *kstrndup(const char *s, size_t len, gfp_t gfp);
304extern void *kmemdup_noprof(const void *src, size_t len, gfp_t gfp) __realloc_size(2);
305#define kmemdup(...) alloc_hooks(kmemdup_noprof(__VA_ARGS__))
306
307extern void *kvmemdup(const void *src, size_t len, gfp_t gfp) __realloc_size(2);
308extern char *kmemdup_nul(const char *s, size_t len, gfp_t gfp);
309extern void *kmemdup_array(const void *src, size_t count, size_t element_size, gfp_t gfp)
310 __realloc_size(2, 3);
311
312/* lib/argv_split.c */
313extern char **argv_split(gfp_t gfp, const char *str, int *argcp);
314extern void argv_free(char **argv);
315
316DEFINE_FREE(argv_free, char **, if (!IS_ERR_OR_NULL(_T)) argv_free(_T))
317
318/* lib/cmdline.c */
319extern int get_option(char **str, int *pint);
320extern char *get_options(const char *str, int nints, int *ints);
321extern unsigned long long memparse(const char *ptr, char **retptr);
322extern bool parse_option_str(const char *str, const char *option);
323extern char *next_arg(char *args, char **param, char **val);
324
325extern bool sysfs_streq(const char *s1, const char *s2);
326int match_string(const char * const *array, size_t n, const char *string);
327int __sysfs_match_string(const char * const *array, size_t n, const char *s);
328
329/**
330 * sysfs_match_string - matches given string in an array
331 * @_a: array of strings
332 * @_s: string to match with
333 *
334 * Helper for __sysfs_match_string(). Calculates the size of @a automatically.
335 */
336#define sysfs_match_string(_a, _s) __sysfs_match_string(_a, ARRAY_SIZE(_a), _s)
337
338#ifdef CONFIG_BINARY_PRINTF
339__printf(3, 0) int vbin_printf(u32 *bin_buf, size_t size, const char *fmt, va_list args);
340__printf(3, 0) int bstr_printf(char *buf, size_t size, const char *fmt, const u32 *bin_buf);
341#endif
342
343extern ssize_t memory_read_from_buffer(void *to, size_t count, loff_t *ppos,
344 const void *from, size_t available);
345
346int ptr_to_hashval(const void *ptr, unsigned long *hashval_out);
347
348size_t memweight(const void *ptr, size_t bytes);
349
350/**
351 * memzero_explicit - Fill a region of memory (e.g. sensitive
352 * keying data) with 0s.
353 * @s: Pointer to the start of the area.
354 * @count: The size of the area.
355 *
356 * Note: usually using memset() is just fine (!), but in cases
357 * where clearing out _local_ data at the end of a scope is
358 * necessary, memzero_explicit() should be used instead in
359 * order to prevent the compiler from optimising away zeroing.
360 *
361 * memzero_explicit() doesn't need an arch-specific version as
362 * it just invokes the one of memset() implicitly.
363 */
364static inline void memzero_explicit(void *s, size_t count)
365{
366 memset(s, 0, count);
367 barrier_data(s);
368}
369
370/**
371 * kbasename - return the last part of a pathname.
372 *
373 * @path: path to extract the filename from.
374 *
375 * Returns:
376 * Pointer to the filename portion inside @path. If no '/' exists,
377 * returns @path unchanged.
378 */
379static inline const char *kbasename(const char *path)
380{
381 const char *tail = strrchr(path, '/');
382 return tail ? tail + 1 : path;
383}
384
385#if !defined(__NO_FORTIFY) && defined(__OPTIMIZE__) && defined(CONFIG_FORTIFY_SOURCE)
386#include <linux/fortify-string.h>
387#endif
388#ifndef unsafe_memcpy
389#define unsafe_memcpy(dst, src, bytes, justification) \
390 memcpy(dst, src, bytes)
391#endif
392
393void memcpy_and_pad(void *dest, size_t dest_len, const void *src, size_t count,
394 int pad);
395
396/**
397 * strtomem_pad - Copy NUL-terminated string to non-NUL-terminated buffer
398 *
399 * @dest: Pointer of destination character array (marked as __nonstring)
400 * @src: Pointer to NUL-terminated string
401 * @pad: Padding character to fill any remaining bytes of @dest after copy
402 *
403 * This is a replacement for strncpy() uses where the destination is not
404 * a NUL-terminated string, but with bounds checking on the source size, and
405 * an explicit padding character. If padding is not required, use strtomem().
406 *
407 * Note that the size of @dest is not an argument, as the length of @dest
408 * must be discoverable by the compiler.
409 */
410#define strtomem_pad(dest, src, pad) do { \
411 const size_t _dest_len = __must_be_byte_array(dest) + \
412 __must_be_noncstr(dest) + \
413 ARRAY_SIZE(dest); \
414 const size_t _src_len = __must_be_cstr(src) + \
415 __builtin_object_size(src, 1); \
416 \
417 BUILD_BUG_ON(!__builtin_constant_p(_dest_len) || \
418 _dest_len == (size_t)-1); \
419 memcpy_and_pad(dest, _dest_len, src, \
420 strnlen(src, min(_src_len, _dest_len)), pad); \
421} while (0)
422
423/**
424 * strtomem - Copy NUL-terminated string to non-NUL-terminated buffer
425 *
426 * @dest: Pointer of destination character array (marked as __nonstring)
427 * @src: Pointer to NUL-terminated string
428 *
429 * This is a replacement for strncpy() uses where the destination is not
430 * a NUL-terminated string, but with bounds checking on the source size, and
431 * without trailing padding. If padding is required, use strtomem_pad().
432 *
433 * Note that the size of @dest is not an argument, as the length of @dest
434 * must be discoverable by the compiler.
435 */
436#define strtomem(dest, src) do { \
437 const size_t _dest_len = __must_be_byte_array(dest) + \
438 __must_be_noncstr(dest) + \
439 ARRAY_SIZE(dest); \
440 const size_t _src_len = __must_be_cstr(src) + \
441 __builtin_object_size(src, 1); \
442 \
443 BUILD_BUG_ON(!__builtin_constant_p(_dest_len) || \
444 _dest_len == (size_t)-1); \
445 memcpy(dest, src, strnlen(src, min(_src_len, _dest_len))); \
446} while (0)
447
448/**
449 * memtostr - Copy a possibly non-NUL-term string to a NUL-term string
450 * @dest: Pointer to destination NUL-terminates string
451 * @src: Pointer to character array (likely marked as __nonstring)
452 *
453 * This is a replacement for strncpy() uses where the source is not
454 * a NUL-terminated string.
455 *
456 * Note that sizes of @dest and @src must be known at compile-time.
457 */
458#define memtostr(dest, src) do { \
459 const size_t _dest_len = __must_be_byte_array(dest) + \
460 __must_be_cstr(dest) + \
461 ARRAY_SIZE(dest); \
462 const size_t _src_len = __must_be_noncstr(src) + \
463 __builtin_object_size(src, 1); \
464 const size_t _src_chars = strnlen(src, _src_len); \
465 const size_t _copy_len = min(_dest_len - 1, _src_chars); \
466 \
467 BUILD_BUG_ON(!__builtin_constant_p(_dest_len) || \
468 !__builtin_constant_p(_src_len) || \
469 _dest_len == 0 || _dest_len == (size_t)-1 || \
470 _src_len == 0 || _src_len == (size_t)-1); \
471 memcpy(dest, src, _copy_len); \
472 dest[_copy_len] = '\0'; \
473} while (0)
474
475/**
476 * memtostr_pad - Copy a possibly non-NUL-term string to a NUL-term string
477 * with NUL padding in the destination
478 * @dest: Pointer to destination NUL-terminates string
479 * @src: Pointer to character array (likely marked as __nonstring)
480 *
481 * This is a replacement for strncpy() uses where the source is not
482 * a NUL-terminated string.
483 *
484 * Note that sizes of @dest and @src must be known at compile-time.
485 */
486#define memtostr_pad(dest, src) do { \
487 const size_t _dest_len = __must_be_byte_array(dest) + \
488 __must_be_cstr(dest) + \
489 ARRAY_SIZE(dest); \
490 const size_t _src_len = __must_be_noncstr(src) + \
491 __builtin_object_size(src, 1); \
492 const size_t _src_chars = strnlen(src, _src_len); \
493 const size_t _copy_len = min(_dest_len - 1, _src_chars); \
494 \
495 BUILD_BUG_ON(!__builtin_constant_p(_dest_len) || \
496 !__builtin_constant_p(_src_len) || \
497 _dest_len == 0 || _dest_len == (size_t)-1 || \
498 _src_len == 0 || _src_len == (size_t)-1); \
499 memcpy(dest, src, _copy_len); \
500 memset(&dest[_copy_len], 0, _dest_len - _copy_len); \
501} while (0)
502
503/**
504 * memset_after - Set a value after a struct member to the end of a struct
505 *
506 * @obj: Address of target struct instance
507 * @v: Byte value to repeatedly write
508 * @member: after which struct member to start writing bytes
509 *
510 * This is good for clearing padding following the given member.
511 */
512#define memset_after(obj, v, member) \
513({ \
514 u8 *__ptr = (u8 *)(obj); \
515 typeof(v) __val = (v); \
516 memset(__ptr + offsetofend(typeof(*(obj)), member), __val, \
517 sizeof(*(obj)) - offsetofend(typeof(*(obj)), member)); \
518})
519
520/**
521 * memset_startat - Set a value starting at a member to the end of a struct
522 *
523 * @obj: Address of target struct instance
524 * @v: Byte value to repeatedly write
525 * @member: struct member to start writing at
526 *
527 * Note that if there is padding between the prior member and the target
528 * member, memset_after() should be used to clear the prior padding.
529 */
530#define memset_startat(obj, v, member) \
531({ \
532 u8 *__ptr = (u8 *)(obj); \
533 typeof(v) __val = (v); \
534 memset(__ptr + offsetof(typeof(*(obj)), member), __val, \
535 sizeof(*(obj)) - offsetof(typeof(*(obj)), member)); \
536})
537
538/**
539 * str_has_prefix - Test if a string has a given prefix
540 * @str: The string to test
541 * @prefix: The string to see if @str starts with
542 *
543 * A common way to test a prefix of a string is to do:
544 * strncmp(str, prefix, sizeof(prefix) - 1)
545 *
546 * But this can lead to bugs due to typos, or if prefix is a pointer
547 * and not a constant. Instead use str_has_prefix().
548 *
549 * Returns:
550 * * strlen(@prefix) if @str starts with @prefix
551 * * 0 if @str does not start with @prefix
552 */
553static __always_inline size_t str_has_prefix(const char *str, const char *prefix)
554{
555 size_t len = strlen(prefix);
556 return strncmp(str, prefix, len) == 0 ? len : 0;
557}
558
559/**
560 * strstarts - does @str start with @prefix?
561 * @str: string to examine
562 * @prefix: prefix to look for.
563 *
564 * Returns:
565 * True if @str begins with @prefix. False in all other cases.
566 */
567static inline bool strstarts(const char *str, const char *prefix)
568{
569 return strncmp(str, prefix, strlen(prefix)) == 0;
570}
571
572/**
573 * strends - Check if a string ends with another string.
574 * @str: NULL-terminated string to check against @suffix
575 * @suffix: NULL-terminated string defining the suffix to look for in @str
576 *
577 * Returns:
578 * True if @str ends with @suffix. False in all other cases.
579 */
580static inline bool __attribute__((nonnull(1, 2)))
581strends(const char *str, const char *suffix)
582{
583 unsigned int str_len = strlen(str), suffix_len = strlen(suffix);
584
585 if (str_len < suffix_len)
586 return false;
587
588 return !(strcmp(str + str_len - suffix_len, suffix));
589}
590
591#endif /* _LINUX_STRING_H_ */