GNU Linux-libre 4.9.314-gnu1
[releases.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 strscpy(char *, const char *, size_t);
31 #endif
32
33 /* Wraps calls to strscpy()/memset(), no arch specific code required */
34 ssize_t strscpy_pad(char *dest, const char *src, size_t count);
35
36 #ifndef __HAVE_ARCH_STRCAT
37 extern char * strcat(char *, const char *);
38 #endif
39 #ifndef __HAVE_ARCH_STRNCAT
40 extern char * strncat(char *, const char *, __kernel_size_t);
41 #endif
42 #ifndef __HAVE_ARCH_STRLCAT
43 extern size_t strlcat(char *, const char *, __kernel_size_t);
44 #endif
45 #ifndef __HAVE_ARCH_STRCMP
46 extern int strcmp(const char *,const char *);
47 #endif
48 #ifndef __HAVE_ARCH_STRNCMP
49 extern int strncmp(const char *,const char *,__kernel_size_t);
50 #endif
51 #ifndef __HAVE_ARCH_STRCASECMP
52 extern int strcasecmp(const char *s1, const char *s2);
53 #endif
54 #ifndef __HAVE_ARCH_STRNCASECMP
55 extern int strncasecmp(const char *s1, const char *s2, size_t n);
56 #endif
57 #ifndef __HAVE_ARCH_STRCHR
58 extern char * strchr(const char *,int);
59 #endif
60 #ifndef __HAVE_ARCH_STRCHRNUL
61 extern char * strchrnul(const char *,int);
62 #endif
63 #ifndef __HAVE_ARCH_STRNCHR
64 extern char * strnchr(const char *, size_t, int);
65 #endif
66 #ifndef __HAVE_ARCH_STRRCHR
67 extern char * strrchr(const char *,int);
68 #endif
69 extern char * __must_check skip_spaces(const char *);
70
71 extern char *strim(char *);
72
73 static inline __must_check char *strstrip(char *str)
74 {
75         return strim(str);
76 }
77
78 #ifndef __HAVE_ARCH_STRSTR
79 extern char * strstr(const char *, const char *);
80 #endif
81 #ifndef __HAVE_ARCH_STRNSTR
82 extern char * strnstr(const char *, const char *, size_t);
83 #endif
84 #ifndef __HAVE_ARCH_STRLEN
85 extern __kernel_size_t strlen(const char *);
86 #endif
87 #ifndef __HAVE_ARCH_STRNLEN
88 extern __kernel_size_t strnlen(const char *,__kernel_size_t);
89 #endif
90 #ifndef __HAVE_ARCH_STRPBRK
91 extern char * strpbrk(const char *,const char *);
92 #endif
93 #ifndef __HAVE_ARCH_STRSEP
94 extern char * strsep(char **,const char *);
95 #endif
96 #ifndef __HAVE_ARCH_STRSPN
97 extern __kernel_size_t strspn(const char *,const char *);
98 #endif
99 #ifndef __HAVE_ARCH_STRCSPN
100 extern __kernel_size_t strcspn(const char *,const char *);
101 #endif
102
103 #ifndef __HAVE_ARCH_MEMSET
104 extern void * memset(void *,int,__kernel_size_t);
105 #endif
106
107 #ifndef __HAVE_ARCH_MEMSET16
108 extern void *memset16(uint16_t *, uint16_t, __kernel_size_t);
109 #endif
110
111 #ifndef __HAVE_ARCH_MEMSET32
112 extern void *memset32(uint32_t *, uint32_t, __kernel_size_t);
113 #endif
114
115 #ifndef __HAVE_ARCH_MEMSET64
116 extern void *memset64(uint64_t *, uint64_t, __kernel_size_t);
117 #endif
118
119 static inline void *memset_l(unsigned long *p, unsigned long v,
120                 __kernel_size_t n)
121 {
122         if (BITS_PER_LONG == 32)
123                 return memset32((uint32_t *)p, v, n);
124         else
125                 return memset64((uint64_t *)p, v, n);
126 }
127
128 static inline void *memset_p(void **p, void *v, __kernel_size_t n)
129 {
130         if (BITS_PER_LONG == 32)
131                 return memset32((uint32_t *)p, (uintptr_t)v, n);
132         else
133                 return memset64((uint64_t *)p, (uintptr_t)v, n);
134 }
135
136 #ifndef __HAVE_ARCH_MEMCPY
137 extern void * memcpy(void *,const void *,__kernel_size_t);
138 #endif
139 #ifndef __HAVE_ARCH_MEMMOVE
140 extern void * memmove(void *,const void *,__kernel_size_t);
141 #endif
142 #ifndef __HAVE_ARCH_MEMSCAN
143 extern void * memscan(void *,int,__kernel_size_t);
144 #endif
145 #ifndef __HAVE_ARCH_MEMCMP
146 extern int memcmp(const void *,const void *,__kernel_size_t);
147 #endif
148 #ifndef __HAVE_ARCH_BCMP
149 extern int bcmp(const void *,const void *,__kernel_size_t);
150 #endif
151 #ifndef __HAVE_ARCH_MEMCHR
152 extern void * memchr(const void *,int,__kernel_size_t);
153 #endif
154 void *memchr_inv(const void *s, int c, size_t n);
155 char *strreplace(char *s, char old, char new);
156
157 extern void kfree_const(const void *x);
158
159 extern char *kstrdup(const char *s, gfp_t gfp) __malloc;
160 extern const char *kstrdup_const(const char *s, gfp_t gfp);
161 extern char *kstrndup(const char *s, size_t len, gfp_t gfp);
162 extern void *kmemdup(const void *src, size_t len, gfp_t gfp);
163 extern char *kmemdup_nul(const char *s, size_t len, gfp_t gfp);
164
165 extern char **argv_split(gfp_t gfp, const char *str, int *argcp);
166 extern void argv_free(char **argv);
167
168 extern bool sysfs_streq(const char *s1, const char *s2);
169 extern int kstrtobool(const char *s, bool *res);
170 static inline int strtobool(const char *s, bool *res)
171 {
172         return kstrtobool(s, res);
173 }
174
175 int match_string(const char * const *array, size_t n, const char *string);
176
177 #ifdef CONFIG_BINARY_PRINTF
178 int vbin_printf(u32 *bin_buf, size_t size, const char *fmt, va_list args);
179 int bstr_printf(char *buf, size_t size, const char *fmt, const u32 *bin_buf);
180 int bprintf(u32 *bin_buf, size_t size, const char *fmt, ...) __printf(3, 4);
181 #endif
182
183 extern ssize_t memory_read_from_buffer(void *to, size_t count, loff_t *ppos,
184                                        const void *from, size_t available);
185
186 /**
187  * strstarts - does @str start with @prefix?
188  * @str: string to examine
189  * @prefix: prefix to look for.
190  */
191 static inline bool strstarts(const char *str, const char *prefix)
192 {
193         return strncmp(str, prefix, strlen(prefix)) == 0;
194 }
195
196 size_t memweight(const void *ptr, size_t bytes);
197 void memzero_explicit(void *s, size_t count);
198
199 /**
200  * kbasename - return the last part of a pathname.
201  *
202  * @path: path to extract the filename from.
203  */
204 static inline const char *kbasename(const char *path)
205 {
206         const char *tail = strrchr(path, '/');
207         return tail ? tail + 1 : path;
208 }
209
210 #endif /* _LINUX_STRING_H_ */