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