replace incorrect strscpy use in FORTIFY_SOURCE
[muen/linux.git] / include / linux / string.h
1 #ifndef _LINUX_STRING_H_
2 #define _LINUX_STRING_H_
3
4
5 #include <linux/compiler.h>     /* for inline */
6 #include <linux/types.h>        /* for size_t */
7 #include <linux/stddef.h>       /* for NULL */
8 #include <stdarg.h>
9 #include <uapi/linux/string.h>
10
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);
14
15 /*
16  * Include machine specific inline routines
17  */
18 #include <asm/string.h>
19
20 #ifndef __HAVE_ARCH_STRCPY
21 extern char * strcpy(char *,const char *);
22 #endif
23 #ifndef __HAVE_ARCH_STRNCPY
24 extern char * strncpy(char *,const char *, __kernel_size_t);
25 #endif
26 #ifndef __HAVE_ARCH_STRLCPY
27 size_t strlcpy(char *, const char *, size_t);
28 #endif
29 #ifndef __HAVE_ARCH_STRSCPY
30 ssize_t __must_check strscpy(char *, const char *, size_t);
31 #endif
32 #ifndef __HAVE_ARCH_STRCAT
33 extern char * strcat(char *, const char *);
34 #endif
35 #ifndef __HAVE_ARCH_STRNCAT
36 extern char * strncat(char *, const char *, __kernel_size_t);
37 #endif
38 #ifndef __HAVE_ARCH_STRLCAT
39 extern size_t strlcat(char *, const char *, __kernel_size_t);
40 #endif
41 #ifndef __HAVE_ARCH_STRCMP
42 extern int strcmp(const char *,const char *);
43 #endif
44 #ifndef __HAVE_ARCH_STRNCMP
45 extern int strncmp(const char *,const char *,__kernel_size_t);
46 #endif
47 #ifndef __HAVE_ARCH_STRCASECMP
48 extern int strcasecmp(const char *s1, const char *s2);
49 #endif
50 #ifndef __HAVE_ARCH_STRNCASECMP
51 extern int strncasecmp(const char *s1, const char *s2, size_t n);
52 #endif
53 #ifndef __HAVE_ARCH_STRCHR
54 extern char * strchr(const char *,int);
55 #endif
56 #ifndef __HAVE_ARCH_STRCHRNUL
57 extern char * strchrnul(const char *,int);
58 #endif
59 #ifndef __HAVE_ARCH_STRNCHR
60 extern char * strnchr(const char *, size_t, int);
61 #endif
62 #ifndef __HAVE_ARCH_STRRCHR
63 extern char * strrchr(const char *,int);
64 #endif
65 extern char * __must_check skip_spaces(const char *);
66
67 extern char *strim(char *);
68
69 static inline __must_check char *strstrip(char *str)
70 {
71         return strim(str);
72 }
73
74 #ifndef __HAVE_ARCH_STRSTR
75 extern char * strstr(const char *, const char *);
76 #endif
77 #ifndef __HAVE_ARCH_STRNSTR
78 extern char * strnstr(const char *, const char *, size_t);
79 #endif
80 #ifndef __HAVE_ARCH_STRLEN
81 extern __kernel_size_t strlen(const char *);
82 #endif
83 #ifndef __HAVE_ARCH_STRNLEN
84 extern __kernel_size_t strnlen(const char *,__kernel_size_t);
85 #endif
86 #ifndef __HAVE_ARCH_STRPBRK
87 extern char * strpbrk(const char *,const char *);
88 #endif
89 #ifndef __HAVE_ARCH_STRSEP
90 extern char * strsep(char **,const char *);
91 #endif
92 #ifndef __HAVE_ARCH_STRSPN
93 extern __kernel_size_t strspn(const char *,const char *);
94 #endif
95 #ifndef __HAVE_ARCH_STRCSPN
96 extern __kernel_size_t strcspn(const char *,const char *);
97 #endif
98
99 #ifndef __HAVE_ARCH_MEMSET
100 extern void * memset(void *,int,__kernel_size_t);
101 #endif
102 #ifndef __HAVE_ARCH_MEMCPY
103 extern void * memcpy(void *,const void *,__kernel_size_t);
104 #endif
105 #ifndef __HAVE_ARCH_MEMMOVE
106 extern void * memmove(void *,const void *,__kernel_size_t);
107 #endif
108 #ifndef __HAVE_ARCH_MEMSCAN
109 extern void * memscan(void *,int,__kernel_size_t);
110 #endif
111 #ifndef __HAVE_ARCH_MEMCMP
112 extern int memcmp(const void *,const void *,__kernel_size_t);
113 #endif
114 #ifndef __HAVE_ARCH_MEMCHR
115 extern void * memchr(const void *,int,__kernel_size_t);
116 #endif
117 #ifndef __HAVE_ARCH_MEMCPY_MCSAFE
118 static inline __must_check int memcpy_mcsafe(void *dst, const void *src,
119                 size_t cnt)
120 {
121         memcpy(dst, src, cnt);
122         return 0;
123 }
124 #endif
125 #ifndef __HAVE_ARCH_MEMCPY_FLUSHCACHE
126 static inline void memcpy_flushcache(void *dst, const void *src, size_t cnt)
127 {
128         memcpy(dst, src, cnt);
129 }
130 #endif
131 void *memchr_inv(const void *s, int c, size_t n);
132 char *strreplace(char *s, char old, char new);
133
134 extern void kfree_const(const void *x);
135
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);
140
141 extern char **argv_split(gfp_t gfp, const char *str, int *argcp);
142 extern void argv_free(char **argv);
143
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)
147 {
148         return kstrtobool(s, res);
149 }
150
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);
153
154 /**
155  * sysfs_match_string - matches given string in an array
156  * @_a: array of strings
157  * @_s: string to match with
158  *
159  * Helper for __sysfs_match_string(). Calculates the size of @a automatically.
160  */
161 #define sysfs_match_string(_a, _s) __sysfs_match_string(_a, ARRAY_SIZE(_a), _s)
162
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);
167 #endif
168
169 extern ssize_t memory_read_from_buffer(void *to, size_t count, loff_t *ppos,
170                                        const void *from, size_t available);
171
172 /**
173  * strstarts - does @str start with @prefix?
174  * @str: string to examine
175  * @prefix: prefix to look for.
176  */
177 static inline bool strstarts(const char *str, const char *prefix)
178 {
179         return strncmp(str, prefix, strlen(prefix)) == 0;
180 }
181
182 size_t memweight(const void *ptr, size_t bytes);
183 void memzero_explicit(void *s, size_t count);
184
185 /**
186  * kbasename - return the last part of a pathname.
187  *
188  * @path: path to extract the filename from.
189  */
190 static inline const char *kbasename(const char *path)
191 {
192         const char *tail = strrchr(path, '/');
193         return tail ? tail + 1 : path;
194 }
195
196 #define __FORTIFY_INLINE extern __always_inline __attribute__((gnu_inline))
197 #define __RENAME(x) __asm__(#x)
198
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");
203
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)
206 {
207         size_t p_size = __builtin_object_size(p, 0);
208         if (__builtin_constant_p(size) && p_size < size)
209                 __write_overflow();
210         if (p_size < size)
211                 fortify_panic(__func__);
212         return __builtin_strncpy(p, q, size);
213 }
214
215 __FORTIFY_INLINE char *strcat(char *p, const char *q)
216 {
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__);
222         return p;
223 }
224
225 __FORTIFY_INLINE __kernel_size_t strlen(const char *p)
226 {
227         __kernel_size_t ret;
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);
232         if (p_size <= ret)
233                 fortify_panic(__func__);
234         return ret;
235 }
236
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)
239 {
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__);
244         return ret;
245 }
246
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)
250 {
251         size_t ret;
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);
256         ret = strlen(q);
257         if (size) {
258                 size_t len = (ret >= size) ? size - 1 : ret;
259                 if (__builtin_constant_p(len) && len >= p_size)
260                         __write_overflow();
261                 if (len >= p_size)
262                         fortify_panic(__func__);
263                 __builtin_memcpy(p, q, len);
264                 p[len] = '\0';
265         }
266         return ret;
267 }
268
269 /* defined after fortified strlen and strnlen to reuse them */
270 __FORTIFY_INLINE char *strncat(char *p, const char *q, __kernel_size_t count)
271 {
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);
277         p_len = strlen(p);
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';
283         return p;
284 }
285
286 __FORTIFY_INLINE void *memset(void *p, int c, __kernel_size_t size)
287 {
288         size_t p_size = __builtin_object_size(p, 0);
289         if (__builtin_constant_p(size) && p_size < size)
290                 __write_overflow();
291         if (p_size < size)
292                 fortify_panic(__func__);
293         return __builtin_memset(p, c, size);
294 }
295
296 __FORTIFY_INLINE void *memcpy(void *p, const void *q, __kernel_size_t size)
297 {
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)) {
301                 if (p_size < size)
302                         __write_overflow();
303                 if (q_size < size)
304                         __read_overflow2();
305         }
306         if (p_size < size || q_size < size)
307                 fortify_panic(__func__);
308         return __builtin_memcpy(p, q, size);
309 }
310
311 __FORTIFY_INLINE void *memmove(void *p, const void *q, __kernel_size_t size)
312 {
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)) {
316                 if (p_size < size)
317                         __write_overflow();
318                 if (q_size < size)
319                         __read_overflow2();
320         }
321         if (p_size < size || q_size < size)
322                 fortify_panic(__func__);
323         return __builtin_memmove(p, q, size);
324 }
325
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)
328 {
329         size_t p_size = __builtin_object_size(p, 0);
330         if (__builtin_constant_p(size) && p_size < size)
331                 __read_overflow();
332         if (p_size < size)
333                 fortify_panic(__func__);
334         return __real_memscan(p, c, size);
335 }
336
337 __FORTIFY_INLINE int memcmp(const void *p, const void *q, __kernel_size_t size)
338 {
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)) {
342                 if (p_size < size)
343                         __read_overflow();
344                 if (q_size < size)
345                         __read_overflow2();
346         }
347         if (p_size < size || q_size < size)
348                 fortify_panic(__func__);
349         return __builtin_memcmp(p, q, size);
350 }
351
352 __FORTIFY_INLINE void *memchr(const void *p, int c, __kernel_size_t size)
353 {
354         size_t p_size = __builtin_object_size(p, 0);
355         if (__builtin_constant_p(size) && p_size < size)
356                 __read_overflow();
357         if (p_size < size)
358                 fortify_panic(__func__);
359         return __builtin_memchr(p, c, size);
360 }
361
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)
364 {
365         size_t p_size = __builtin_object_size(p, 0);
366         if (__builtin_constant_p(size) && p_size < size)
367                 __read_overflow();
368         if (p_size < size)
369                 fortify_panic(__func__);
370         return __real_memchr_inv(p, c, size);
371 }
372
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)
375 {
376         size_t p_size = __builtin_object_size(p, 0);
377         if (__builtin_constant_p(size) && p_size < size)
378                 __read_overflow();
379         if (p_size < size)
380                 fortify_panic(__func__);
381         return __real_kmemdup(p, size, gfp);
382 }
383
384 /* defined after fortified strlen and memcpy to reuse them */
385 __FORTIFY_INLINE char *strcpy(char *p, const char *q)
386 {
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);
392         return p;
393 }
394
395 #endif
396
397 #endif /* _LINUX_STRING_H_ */