1 #ifndef _LINUX_STRING_H_
2 #define _LINUX_STRING_H_
5 #include <linux/compiler.h> /* for inline */
6 #include <linux/types.h> /* for size_t */
7 #include <linux/stddef.h> /* for NULL */
9 #include <uapi/linux/string.h>
11 extern char *strndup_user(const char __user *, long);
12 extern void *memdup_user(const void __user *, size_t);
13 extern void *memdup_user_nul(const void __user *, size_t);
16 * Include machine specific inline routines
18 #include <asm/string.h>
20 #ifndef __HAVE_ARCH_STRCPY
21 extern char * strcpy(char *,const char *);
23 #ifndef __HAVE_ARCH_STRNCPY
24 extern char * strncpy(char *,const char *, __kernel_size_t);
26 #ifndef __HAVE_ARCH_STRLCPY
27 size_t strlcpy(char *, const char *, size_t);
29 #ifndef __HAVE_ARCH_STRSCPY
30 ssize_t __must_check strscpy(char *, const char *, size_t);
32 #ifndef __HAVE_ARCH_STRCAT
33 extern char * strcat(char *, const char *);
35 #ifndef __HAVE_ARCH_STRNCAT
36 extern char * strncat(char *, const char *, __kernel_size_t);
38 #ifndef __HAVE_ARCH_STRLCAT
39 extern size_t strlcat(char *, const char *, __kernel_size_t);
41 #ifndef __HAVE_ARCH_STRCMP
42 extern int strcmp(const char *,const char *);
44 #ifndef __HAVE_ARCH_STRNCMP
45 extern int strncmp(const char *,const char *,__kernel_size_t);
47 #ifndef __HAVE_ARCH_STRCASECMP
48 extern int strcasecmp(const char *s1, const char *s2);
50 #ifndef __HAVE_ARCH_STRNCASECMP
51 extern int strncasecmp(const char *s1, const char *s2, size_t n);
53 #ifndef __HAVE_ARCH_STRCHR
54 extern char * strchr(const char *,int);
56 #ifndef __HAVE_ARCH_STRCHRNUL
57 extern char * strchrnul(const char *,int);
59 #ifndef __HAVE_ARCH_STRNCHR
60 extern char * strnchr(const char *, size_t, int);
62 #ifndef __HAVE_ARCH_STRRCHR
63 extern char * strrchr(const char *,int);
65 extern char * __must_check skip_spaces(const char *);
67 extern char *strim(char *);
69 static inline __must_check char *strstrip(char *str)
74 #ifndef __HAVE_ARCH_STRSTR
75 extern char * strstr(const char *, const char *);
77 #ifndef __HAVE_ARCH_STRNSTR
78 extern char * strnstr(const char *, const char *, size_t);
80 #ifndef __HAVE_ARCH_STRLEN
81 extern __kernel_size_t strlen(const char *);
83 #ifndef __HAVE_ARCH_STRNLEN
84 extern __kernel_size_t strnlen(const char *,__kernel_size_t);
86 #ifndef __HAVE_ARCH_STRPBRK
87 extern char * strpbrk(const char *,const char *);
89 #ifndef __HAVE_ARCH_STRSEP
90 extern char * strsep(char **,const char *);
92 #ifndef __HAVE_ARCH_STRSPN
93 extern __kernel_size_t strspn(const char *,const char *);
95 #ifndef __HAVE_ARCH_STRCSPN
96 extern __kernel_size_t strcspn(const char *,const char *);
99 #ifndef __HAVE_ARCH_MEMSET
100 extern void * memset(void *,int,__kernel_size_t);
102 #ifndef __HAVE_ARCH_MEMCPY
103 extern void * memcpy(void *,const void *,__kernel_size_t);
105 #ifndef __HAVE_ARCH_MEMMOVE
106 extern void * memmove(void *,const void *,__kernel_size_t);
108 #ifndef __HAVE_ARCH_MEMSCAN
109 extern void * memscan(void *,int,__kernel_size_t);
111 #ifndef __HAVE_ARCH_MEMCMP
112 extern int memcmp(const void *,const void *,__kernel_size_t);
114 #ifndef __HAVE_ARCH_MEMCHR
115 extern void * memchr(const void *,int,__kernel_size_t);
117 #ifndef __HAVE_ARCH_MEMCPY_MCSAFE
118 static inline __must_check int memcpy_mcsafe(void *dst, const void *src,
121 memcpy(dst, src, cnt);
125 #ifndef __HAVE_ARCH_MEMCPY_FLUSHCACHE
126 static inline void memcpy_flushcache(void *dst, const void *src, size_t cnt)
128 memcpy(dst, src, cnt);
131 void *memchr_inv(const void *s, int c, size_t n);
132 char *strreplace(char *s, char old, char new);
134 extern void kfree_const(const void *x);
136 extern char *kstrdup(const char *s, gfp_t gfp) __malloc;
137 extern const char *kstrdup_const(const char *s, gfp_t gfp);
138 extern char *kstrndup(const char *s, size_t len, gfp_t gfp);
139 extern void *kmemdup(const void *src, size_t len, gfp_t gfp);
141 extern char **argv_split(gfp_t gfp, const char *str, int *argcp);
142 extern void argv_free(char **argv);
144 extern bool sysfs_streq(const char *s1, const char *s2);
145 extern int kstrtobool(const char *s, bool *res);
146 static inline int strtobool(const char *s, bool *res)
148 return kstrtobool(s, res);
151 int match_string(const char * const *array, size_t n, const char *string);
152 int __sysfs_match_string(const char * const *array, size_t n, const char *s);
155 * sysfs_match_string - matches given string in an array
156 * @_a: array of strings
157 * @_s: string to match with
159 * Helper for __sysfs_match_string(). Calculates the size of @a automatically.
161 #define sysfs_match_string(_a, _s) __sysfs_match_string(_a, ARRAY_SIZE(_a), _s)
163 #ifdef CONFIG_BINARY_PRINTF
164 int vbin_printf(u32 *bin_buf, size_t size, const char *fmt, va_list args);
165 int bstr_printf(char *buf, size_t size, const char *fmt, const u32 *bin_buf);
166 int bprintf(u32 *bin_buf, size_t size, const char *fmt, ...) __printf(3, 4);
169 extern ssize_t memory_read_from_buffer(void *to, size_t count, loff_t *ppos,
170 const void *from, size_t available);
173 * strstarts - does @str start with @prefix?
174 * @str: string to examine
175 * @prefix: prefix to look for.
177 static inline bool strstarts(const char *str, const char *prefix)
179 return strncmp(str, prefix, strlen(prefix)) == 0;
182 size_t memweight(const void *ptr, size_t bytes);
183 void memzero_explicit(void *s, size_t count);
186 * kbasename - return the last part of a pathname.
188 * @path: path to extract the filename from.
190 static inline const char *kbasename(const char *path)
192 const char *tail = strrchr(path, '/');
193 return tail ? tail + 1 : path;
196 #define __FORTIFY_INLINE extern __always_inline __attribute__((gnu_inline))
197 #define __RENAME(x) __asm__(#x)
199 void fortify_panic(const char *name) __noreturn __cold;
200 void __read_overflow(void) __compiletime_error("detected read beyond size of object passed as 1st parameter");
201 void __read_overflow2(void) __compiletime_error("detected read beyond size of object passed as 2nd parameter");
202 void __write_overflow(void) __compiletime_error("detected write beyond size of object passed as 1st parameter");
204 #if !defined(__NO_FORTIFY) && defined(__OPTIMIZE__) && defined(CONFIG_FORTIFY_SOURCE)
205 __FORTIFY_INLINE char *strncpy(char *p, const char *q, __kernel_size_t size)
207 size_t p_size = __builtin_object_size(p, 0);
208 if (__builtin_constant_p(size) && p_size < size)
211 fortify_panic(__func__);
212 return __builtin_strncpy(p, q, size);
215 __FORTIFY_INLINE char *strcat(char *p, const char *q)
217 size_t p_size = __builtin_object_size(p, 0);
218 if (p_size == (size_t)-1)
219 return __builtin_strcat(p, q);
220 if (strlcat(p, q, p_size) >= p_size)
221 fortify_panic(__func__);
225 __FORTIFY_INLINE __kernel_size_t strlen(const char *p)
228 size_t p_size = __builtin_object_size(p, 0);
229 if (p_size == (size_t)-1)
230 return __builtin_strlen(p);
231 ret = strnlen(p, p_size);
233 fortify_panic(__func__);
237 extern __kernel_size_t __real_strnlen(const char *, __kernel_size_t) __RENAME(strnlen);
238 __FORTIFY_INLINE __kernel_size_t strnlen(const char *p, __kernel_size_t maxlen)
240 size_t p_size = __builtin_object_size(p, 0);
241 __kernel_size_t ret = __real_strnlen(p, maxlen < p_size ? maxlen : p_size);
242 if (p_size <= ret && maxlen != ret)
243 fortify_panic(__func__);
247 /* defined after fortified strlen to reuse it */
248 extern size_t __real_strlcpy(char *, const char *, size_t) __RENAME(strlcpy);
249 __FORTIFY_INLINE size_t strlcpy(char *p, const char *q, size_t size)
252 size_t p_size = __builtin_object_size(p, 0);
253 size_t q_size = __builtin_object_size(q, 0);
254 if (p_size == (size_t)-1 && q_size == (size_t)-1)
255 return __real_strlcpy(p, q, size);
258 size_t len = (ret >= size) ? size - 1 : ret;
259 if (__builtin_constant_p(len) && len >= p_size)
262 fortify_panic(__func__);
263 __builtin_memcpy(p, q, len);
269 /* defined after fortified strlen and strnlen to reuse them */
270 __FORTIFY_INLINE char *strncat(char *p, const char *q, __kernel_size_t count)
272 size_t p_len, copy_len;
273 size_t p_size = __builtin_object_size(p, 0);
274 size_t q_size = __builtin_object_size(q, 0);
275 if (p_size == (size_t)-1 && q_size == (size_t)-1)
276 return __builtin_strncat(p, q, count);
278 copy_len = strnlen(q, count);
279 if (p_size < p_len + copy_len + 1)
280 fortify_panic(__func__);
281 __builtin_memcpy(p + p_len, q, copy_len);
282 p[p_len + copy_len] = '\0';
286 __FORTIFY_INLINE void *memset(void *p, int c, __kernel_size_t size)
288 size_t p_size = __builtin_object_size(p, 0);
289 if (__builtin_constant_p(size) && p_size < size)
292 fortify_panic(__func__);
293 return __builtin_memset(p, c, size);
296 __FORTIFY_INLINE void *memcpy(void *p, const void *q, __kernel_size_t size)
298 size_t p_size = __builtin_object_size(p, 0);
299 size_t q_size = __builtin_object_size(q, 0);
300 if (__builtin_constant_p(size)) {
306 if (p_size < size || q_size < size)
307 fortify_panic(__func__);
308 return __builtin_memcpy(p, q, size);
311 __FORTIFY_INLINE void *memmove(void *p, const void *q, __kernel_size_t size)
313 size_t p_size = __builtin_object_size(p, 0);
314 size_t q_size = __builtin_object_size(q, 0);
315 if (__builtin_constant_p(size)) {
321 if (p_size < size || q_size < size)
322 fortify_panic(__func__);
323 return __builtin_memmove(p, q, size);
326 extern void *__real_memscan(void *, int, __kernel_size_t) __RENAME(memscan);
327 __FORTIFY_INLINE void *memscan(void *p, int c, __kernel_size_t size)
329 size_t p_size = __builtin_object_size(p, 0);
330 if (__builtin_constant_p(size) && p_size < size)
333 fortify_panic(__func__);
334 return __real_memscan(p, c, size);
337 __FORTIFY_INLINE int memcmp(const void *p, const void *q, __kernel_size_t size)
339 size_t p_size = __builtin_object_size(p, 0);
340 size_t q_size = __builtin_object_size(q, 0);
341 if (__builtin_constant_p(size)) {
347 if (p_size < size || q_size < size)
348 fortify_panic(__func__);
349 return __builtin_memcmp(p, q, size);
352 __FORTIFY_INLINE void *memchr(const void *p, int c, __kernel_size_t size)
354 size_t p_size = __builtin_object_size(p, 0);
355 if (__builtin_constant_p(size) && p_size < size)
358 fortify_panic(__func__);
359 return __builtin_memchr(p, c, size);
362 void *__real_memchr_inv(const void *s, int c, size_t n) __RENAME(memchr_inv);
363 __FORTIFY_INLINE void *memchr_inv(const void *p, int c, 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_memchr_inv(p, c, size);
373 extern void *__real_kmemdup(const void *src, size_t len, gfp_t gfp) __RENAME(kmemdup);
374 __FORTIFY_INLINE void *kmemdup(const void *p, size_t size, gfp_t gfp)
376 size_t p_size = __builtin_object_size(p, 0);
377 if (__builtin_constant_p(size) && p_size < size)
380 fortify_panic(__func__);
381 return __real_kmemdup(p, size, gfp);
384 /* defined after fortified strlen and memcpy to reuse them */
385 __FORTIFY_INLINE char *strcpy(char *p, const char *q)
387 size_t p_size = __builtin_object_size(p, 0);
388 size_t q_size = __builtin_object_size(q, 0);
389 if (p_size == (size_t)-1 && q_size == (size_t)-1)
390 return __builtin_strcpy(p, q);
391 memcpy(p, q, strlen(q) + 1);
397 #endif /* _LINUX_STRING_H_ */