Merge tag 'pstore-v4.12-rc2' of git://git.kernel.org/pub/scm/linux/kernel/git/kees...
[sfrench/cifs-2.6.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 void *memchr_inv(const void *s, int c, size_t n);
126 char *strreplace(char *s, char old, char new);
127
128 extern void kfree_const(const void *x);
129
130 extern char *kstrdup(const char *s, gfp_t gfp) __malloc;
131 extern const char *kstrdup_const(const char *s, gfp_t gfp);
132 extern char *kstrndup(const char *s, size_t len, gfp_t gfp);
133 extern void *kmemdup(const void *src, size_t len, gfp_t gfp);
134
135 extern char **argv_split(gfp_t gfp, const char *str, int *argcp);
136 extern void argv_free(char **argv);
137
138 extern bool sysfs_streq(const char *s1, const char *s2);
139 extern int kstrtobool(const char *s, bool *res);
140 static inline int strtobool(const char *s, bool *res)
141 {
142         return kstrtobool(s, res);
143 }
144
145 int match_string(const char * const *array, size_t n, const char *string);
146 int __sysfs_match_string(const char * const *array, size_t n, const char *s);
147
148 /**
149  * sysfs_match_string - matches given string in an array
150  * @_a: array of strings
151  * @_s: string to match with
152  *
153  * Helper for __sysfs_match_string(). Calculates the size of @a automatically.
154  */
155 #define sysfs_match_string(_a, _s) __sysfs_match_string(_a, ARRAY_SIZE(_a), _s)
156
157 #ifdef CONFIG_BINARY_PRINTF
158 int vbin_printf(u32 *bin_buf, size_t size, const char *fmt, va_list args);
159 int bstr_printf(char *buf, size_t size, const char *fmt, const u32 *bin_buf);
160 int bprintf(u32 *bin_buf, size_t size, const char *fmt, ...) __printf(3, 4);
161 #endif
162
163 extern ssize_t memory_read_from_buffer(void *to, size_t count, loff_t *ppos,
164                                        const void *from, size_t available);
165
166 /**
167  * strstarts - does @str start with @prefix?
168  * @str: string to examine
169  * @prefix: prefix to look for.
170  */
171 static inline bool strstarts(const char *str, const char *prefix)
172 {
173         return strncmp(str, prefix, strlen(prefix)) == 0;
174 }
175
176 size_t memweight(const void *ptr, size_t bytes);
177 void memzero_explicit(void *s, size_t count);
178
179 /**
180  * kbasename - return the last part of a pathname.
181  *
182  * @path: path to extract the filename from.
183  */
184 static inline const char *kbasename(const char *path)
185 {
186         const char *tail = strrchr(path, '/');
187         return tail ? tail + 1 : path;
188 }
189
190 #endif /* _LINUX_STRING_H_ */