1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _LINUX_STRING_H_
3 #define _LINUX_STRING_H_
6 #include <linux/compiler.h> /* for inline */
7 #include <linux/types.h> /* for size_t */
8 #include <linux/stddef.h> /* for NULL */
10 #include <uapi/linux/string.h>
12 extern char *strndup_user(const char __user
*, long);
13 extern void *memdup_user(const void __user
*, size_t);
14 extern void *memdup_user_nul(const void __user
*, size_t);
17 * Include machine specific inline routines
19 #include <asm/string.h>
21 #ifndef __HAVE_ARCH_STRCPY
22 extern char * strcpy(char *,const char *);
24 #ifndef __HAVE_ARCH_STRNCPY
25 extern char * strncpy(char *,const char *, __kernel_size_t
);
27 #ifndef __HAVE_ARCH_STRLCPY
28 size_t strlcpy(char *, const char *, size_t);
30 #ifndef __HAVE_ARCH_STRSCPY
31 ssize_t __must_check
strscpy(char *, const char *, size_t);
33 #ifndef __HAVE_ARCH_STRCAT
34 extern char * strcat(char *, const char *);
36 #ifndef __HAVE_ARCH_STRNCAT
37 extern char * strncat(char *, const char *, __kernel_size_t
);
39 #ifndef __HAVE_ARCH_STRLCAT
40 extern size_t strlcat(char *, const char *, __kernel_size_t
);
42 #ifndef __HAVE_ARCH_STRCMP
43 extern int strcmp(const char *,const char *);
45 #ifndef __HAVE_ARCH_STRNCMP
46 extern int strncmp(const char *,const char *,__kernel_size_t
);
48 #ifndef __HAVE_ARCH_STRCASECMP
49 extern int strcasecmp(const char *s1
, const char *s2
);
51 #ifndef __HAVE_ARCH_STRNCASECMP
52 extern int strncasecmp(const char *s1
, const char *s2
, size_t n
);
54 #ifndef __HAVE_ARCH_STRCHR
55 extern char * strchr(const char *,int);
57 #ifndef __HAVE_ARCH_STRCHRNUL
58 extern char * strchrnul(const char *,int);
60 #ifndef __HAVE_ARCH_STRNCHR
61 extern char * strnchr(const char *, size_t, int);
63 #ifndef __HAVE_ARCH_STRRCHR
64 extern char * strrchr(const char *,int);
66 extern char * __must_check
skip_spaces(const char *);
68 extern char *strim(char *);
70 static inline __must_check
char *strstrip(char *str
)
75 #ifndef __HAVE_ARCH_STRSTR
76 extern char * strstr(const char *, const char *);
78 #ifndef __HAVE_ARCH_STRNSTR
79 extern char * strnstr(const char *, const char *, size_t);
81 #ifndef __HAVE_ARCH_STRLEN
82 extern __kernel_size_t
strlen(const char *);
84 #ifndef __HAVE_ARCH_STRNLEN
85 extern __kernel_size_t
strnlen(const char *,__kernel_size_t
);
87 #ifndef __HAVE_ARCH_STRPBRK
88 extern char * strpbrk(const char *,const char *);
90 #ifndef __HAVE_ARCH_STRSEP
91 extern char * strsep(char **,const char *);
93 #ifndef __HAVE_ARCH_STRSPN
94 extern __kernel_size_t
strspn(const char *,const char *);
96 #ifndef __HAVE_ARCH_STRCSPN
97 extern __kernel_size_t
strcspn(const char *,const char *);
100 #ifndef __HAVE_ARCH_MEMSET
101 extern void * memset(void *,int,__kernel_size_t
);
104 #ifndef __HAVE_ARCH_MEMSET16
105 extern void *memset16(uint16_t *, uint16_t, __kernel_size_t
);
108 #ifndef __HAVE_ARCH_MEMSET32
109 extern void *memset32(uint32_t *, uint32_t, __kernel_size_t
);
112 #ifndef __HAVE_ARCH_MEMSET64
113 extern void *memset64(uint64_t *, uint64_t, __kernel_size_t
);
116 static inline void *memset_l(unsigned long *p
, unsigned long v
,
119 if (BITS_PER_LONG
== 32)
120 return memset32((uint32_t *)p
, v
, n
);
122 return memset64((uint64_t *)p
, v
, n
);
125 static inline void *memset_p(void **p
, void *v
, __kernel_size_t n
)
127 if (BITS_PER_LONG
== 32)
128 return memset32((uint32_t *)p
, (uintptr_t)v
, n
);
130 return memset64((uint64_t *)p
, (uintptr_t)v
, n
);
133 #ifndef __HAVE_ARCH_MEMCPY
134 extern void * memcpy(void *,const void *,__kernel_size_t
);
136 #ifndef __HAVE_ARCH_MEMMOVE
137 extern void * memmove(void *,const void *,__kernel_size_t
);
139 #ifndef __HAVE_ARCH_MEMSCAN
140 extern void * memscan(void *,int,__kernel_size_t
);
142 #ifndef __HAVE_ARCH_MEMCMP
143 extern int memcmp(const void *,const void *,__kernel_size_t
);
145 #ifndef __HAVE_ARCH_MEMCHR
146 extern void * memchr(const void *,int,__kernel_size_t
);
148 #ifndef __HAVE_ARCH_MEMCPY_MCSAFE
149 static inline __must_check
int memcpy_mcsafe(void *dst
, const void *src
,
152 memcpy(dst
, src
, cnt
);
156 #ifndef __HAVE_ARCH_MEMCPY_FLUSHCACHE
157 static inline void memcpy_flushcache(void *dst
, const void *src
, size_t cnt
)
159 memcpy(dst
, src
, cnt
);
162 void *memchr_inv(const void *s
, int c
, size_t n
);
163 char *strreplace(char *s
, char old
, char new);
165 extern void kfree_const(const void *x
);
167 extern char *kstrdup(const char *s
, gfp_t gfp
) __malloc
;
168 extern const char *kstrdup_const(const char *s
, gfp_t gfp
);
169 extern char *kstrndup(const char *s
, size_t len
, gfp_t gfp
);
170 extern void *kmemdup(const void *src
, size_t len
, gfp_t gfp
);
171 extern char *kmemdup_nul(const char *s
, size_t len
, gfp_t gfp
);
173 extern char **argv_split(gfp_t gfp
, const char *str
, int *argcp
);
174 extern void argv_free(char **argv
);
176 extern bool sysfs_streq(const char *s1
, const char *s2
);
177 extern int kstrtobool(const char *s
, bool *res
);
178 static inline int strtobool(const char *s
, bool *res
)
180 return kstrtobool(s
, res
);
183 int match_string(const char * const *array
, size_t n
, const char *string
);
184 int __sysfs_match_string(const char * const *array
, size_t n
, const char *s
);
187 * sysfs_match_string - matches given string in an array
188 * @_a: array of strings
189 * @_s: string to match with
191 * Helper for __sysfs_match_string(). Calculates the size of @a automatically.
193 #define sysfs_match_string(_a, _s) __sysfs_match_string(_a, ARRAY_SIZE(_a), _s)
195 #ifdef CONFIG_BINARY_PRINTF
196 int vbin_printf(u32
*bin_buf
, size_t size
, const char *fmt
, va_list args
);
197 int bstr_printf(char *buf
, size_t size
, const char *fmt
, const u32
*bin_buf
);
198 int bprintf(u32
*bin_buf
, size_t size
, const char *fmt
, ...) __printf(3, 4);
201 extern ssize_t
memory_read_from_buffer(void *to
, size_t count
, loff_t
*ppos
,
202 const void *from
, size_t available
);
205 * strstarts - does @str start with @prefix?
206 * @str: string to examine
207 * @prefix: prefix to look for.
209 static inline bool strstarts(const char *str
, const char *prefix
)
211 return strncmp(str
, prefix
, strlen(prefix
)) == 0;
214 size_t memweight(const void *ptr
, size_t bytes
);
215 void memzero_explicit(void *s
, size_t count
);
218 * kbasename - return the last part of a pathname.
220 * @path: path to extract the filename from.
222 static inline const char *kbasename(const char *path
)
224 const char *tail
= strrchr(path
, '/');
225 return tail
? tail
+ 1 : path
;
228 #define __FORTIFY_INLINE extern __always_inline __attribute__((gnu_inline))
229 #define __RENAME(x) __asm__(#x)
231 void fortify_panic(const char *name
) __noreturn __cold
;
232 void __read_overflow(void) __compiletime_error("detected read beyond size of object passed as 1st parameter");
233 void __read_overflow2(void) __compiletime_error("detected read beyond size of object passed as 2nd parameter");
234 void __read_overflow3(void) __compiletime_error("detected read beyond size of object passed as 3rd parameter");
235 void __write_overflow(void) __compiletime_error("detected write beyond size of object passed as 1st parameter");
237 #if !defined(__NO_FORTIFY) && defined(__OPTIMIZE__) && defined(CONFIG_FORTIFY_SOURCE)
238 __FORTIFY_INLINE
char *strncpy(char *p
, const char *q
, __kernel_size_t size
)
240 size_t p_size
= __builtin_object_size(p
, 0);
241 if (__builtin_constant_p(size
) && p_size
< size
)
244 fortify_panic(__func__
);
245 return __builtin_strncpy(p
, q
, size
);
248 __FORTIFY_INLINE
char *strcat(char *p
, const char *q
)
250 size_t p_size
= __builtin_object_size(p
, 0);
251 if (p_size
== (size_t)-1)
252 return __builtin_strcat(p
, q
);
253 if (strlcat(p
, q
, p_size
) >= p_size
)
254 fortify_panic(__func__
);
258 __FORTIFY_INLINE __kernel_size_t
strlen(const char *p
)
261 size_t p_size
= __builtin_object_size(p
, 0);
263 /* Work around gcc excess stack consumption issue */
264 if (p_size
== (size_t)-1 ||
265 (__builtin_constant_p(p
[p_size
- 1]) && p
[p_size
- 1] == '\0'))
266 return __builtin_strlen(p
);
267 ret
= strnlen(p
, p_size
);
269 fortify_panic(__func__
);
273 extern __kernel_size_t
__real_strnlen(const char *, __kernel_size_t
) __RENAME(strnlen
);
274 __FORTIFY_INLINE __kernel_size_t
strnlen(const char *p
, __kernel_size_t maxlen
)
276 size_t p_size
= __builtin_object_size(p
, 0);
277 __kernel_size_t ret
= __real_strnlen(p
, maxlen
< p_size
? maxlen
: p_size
);
278 if (p_size
<= ret
&& maxlen
!= ret
)
279 fortify_panic(__func__
);
283 /* defined after fortified strlen to reuse it */
284 extern size_t __real_strlcpy(char *, const char *, size_t) __RENAME(strlcpy
);
285 __FORTIFY_INLINE
size_t strlcpy(char *p
, const char *q
, size_t size
)
288 size_t p_size
= __builtin_object_size(p
, 0);
289 size_t q_size
= __builtin_object_size(q
, 0);
290 if (p_size
== (size_t)-1 && q_size
== (size_t)-1)
291 return __real_strlcpy(p
, q
, size
);
294 size_t len
= (ret
>= size
) ? size
- 1 : ret
;
295 if (__builtin_constant_p(len
) && len
>= p_size
)
298 fortify_panic(__func__
);
299 __builtin_memcpy(p
, q
, len
);
305 /* defined after fortified strlen and strnlen to reuse them */
306 __FORTIFY_INLINE
char *strncat(char *p
, const char *q
, __kernel_size_t count
)
308 size_t p_len
, copy_len
;
309 size_t p_size
= __builtin_object_size(p
, 0);
310 size_t q_size
= __builtin_object_size(q
, 0);
311 if (p_size
== (size_t)-1 && q_size
== (size_t)-1)
312 return __builtin_strncat(p
, q
, count
);
314 copy_len
= strnlen(q
, count
);
315 if (p_size
< p_len
+ copy_len
+ 1)
316 fortify_panic(__func__
);
317 __builtin_memcpy(p
+ p_len
, q
, copy_len
);
318 p
[p_len
+ copy_len
] = '\0';
322 __FORTIFY_INLINE
void *memset(void *p
, int c
, __kernel_size_t size
)
324 size_t p_size
= __builtin_object_size(p
, 0);
325 if (__builtin_constant_p(size
) && p_size
< size
)
328 fortify_panic(__func__
);
329 return __builtin_memset(p
, c
, size
);
332 __FORTIFY_INLINE
void *memcpy(void *p
, const void *q
, __kernel_size_t size
)
334 size_t p_size
= __builtin_object_size(p
, 0);
335 size_t q_size
= __builtin_object_size(q
, 0);
336 if (__builtin_constant_p(size
)) {
342 if (p_size
< size
|| q_size
< size
)
343 fortify_panic(__func__
);
344 return __builtin_memcpy(p
, q
, size
);
347 __FORTIFY_INLINE
void *memmove(void *p
, const void *q
, __kernel_size_t size
)
349 size_t p_size
= __builtin_object_size(p
, 0);
350 size_t q_size
= __builtin_object_size(q
, 0);
351 if (__builtin_constant_p(size
)) {
357 if (p_size
< size
|| q_size
< size
)
358 fortify_panic(__func__
);
359 return __builtin_memmove(p
, q
, size
);
362 extern void *__real_memscan(void *, int, __kernel_size_t
) __RENAME(memscan
);
363 __FORTIFY_INLINE
void *memscan(void *p
, int c
, __kernel_size_t size
)
365 size_t p_size
= __builtin_object_size(p
, 0);
366 if (__builtin_constant_p(size
) && p_size
< size
)
369 fortify_panic(__func__
);
370 return __real_memscan(p
, c
, size
);
373 __FORTIFY_INLINE
int memcmp(const void *p
, const void *q
, __kernel_size_t size
)
375 size_t p_size
= __builtin_object_size(p
, 0);
376 size_t q_size
= __builtin_object_size(q
, 0);
377 if (__builtin_constant_p(size
)) {
383 if (p_size
< size
|| q_size
< size
)
384 fortify_panic(__func__
);
385 return __builtin_memcmp(p
, q
, size
);
388 __FORTIFY_INLINE
void *memchr(const void *p
, int c
, __kernel_size_t size
)
390 size_t p_size
= __builtin_object_size(p
, 0);
391 if (__builtin_constant_p(size
) && p_size
< size
)
394 fortify_panic(__func__
);
395 return __builtin_memchr(p
, c
, size
);
398 void *__real_memchr_inv(const void *s
, int c
, size_t n
) __RENAME(memchr_inv
);
399 __FORTIFY_INLINE
void *memchr_inv(const void *p
, int c
, size_t size
)
401 size_t p_size
= __builtin_object_size(p
, 0);
402 if (__builtin_constant_p(size
) && p_size
< size
)
405 fortify_panic(__func__
);
406 return __real_memchr_inv(p
, c
, size
);
409 extern void *__real_kmemdup(const void *src
, size_t len
, gfp_t gfp
) __RENAME(kmemdup
);
410 __FORTIFY_INLINE
void *kmemdup(const void *p
, size_t size
, gfp_t gfp
)
412 size_t p_size
= __builtin_object_size(p
, 0);
413 if (__builtin_constant_p(size
) && p_size
< size
)
416 fortify_panic(__func__
);
417 return __real_kmemdup(p
, size
, gfp
);
420 /* defined after fortified strlen and memcpy to reuse them */
421 __FORTIFY_INLINE
char *strcpy(char *p
, const char *q
)
423 size_t p_size
= __builtin_object_size(p
, 0);
424 size_t q_size
= __builtin_object_size(q
, 0);
425 if (p_size
== (size_t)-1 && q_size
== (size_t)-1)
426 return __builtin_strcpy(p
, q
);
427 memcpy(p
, q
, strlen(q
) + 1);
434 * memcpy_and_pad - Copy one buffer to another with padding
435 * @dest: Where to copy to
436 * @dest_len: The destination buffer size
437 * @src: Where to copy from
438 * @count: The number of bytes to copy
439 * @pad: Character to use for padding if space is left in destination.
441 static inline void memcpy_and_pad(void *dest
, size_t dest_len
,
442 const void *src
, size_t count
, int pad
)
444 if (dest_len
> count
) {
445 memcpy(dest
, src
, count
);
446 memset(dest
+ count
, pad
, dest_len
- count
);
448 memcpy(dest
, src
, dest_len
);
451 #endif /* _LINUX_STRING_H_ */