2005-04-16 15:20:36 -07:00
|
|
|
#ifndef _LINUX_STRING_H_
|
|
|
|
#define _LINUX_STRING_H_
|
|
|
|
|
|
|
|
|
|
|
|
#include <linux/compiler.h> /* for inline */
|
|
|
|
#include <linux/types.h> /* for size_t */
|
|
|
|
#include <linux/stddef.h> /* for NULL */
|
2009-03-06 17:21:46 +01:00
|
|
|
#include <stdarg.h>
|
2012-10-13 10:46:48 +01:00
|
|
|
#include <uapi/linux/string.h>
|
2005-04-16 15:20:36 -07:00
|
|
|
|
2006-03-24 03:18:42 -08:00
|
|
|
extern char *strndup_user(const char __user *, long);
|
2009-03-31 15:23:16 -07:00
|
|
|
extern void *memdup_user(const void __user *, size_t);
|
2015-12-24 00:06:05 -05:00
|
|
|
extern void *memdup_user_nul(const void __user *, size_t);
|
2006-03-24 03:18:42 -08:00
|
|
|
|
2005-04-16 15:20:36 -07:00
|
|
|
/*
|
|
|
|
* Include machine specific inline routines
|
|
|
|
*/
|
|
|
|
#include <asm/string.h>
|
|
|
|
|
|
|
|
#ifndef __HAVE_ARCH_STRCPY
|
|
|
|
extern char * strcpy(char *,const char *);
|
|
|
|
#endif
|
|
|
|
#ifndef __HAVE_ARCH_STRNCPY
|
|
|
|
extern char * strncpy(char *,const char *, __kernel_size_t);
|
|
|
|
#endif
|
|
|
|
#ifndef __HAVE_ARCH_STRLCPY
|
|
|
|
size_t strlcpy(char *, const char *, size_t);
|
|
|
|
#endif
|
2015-04-29 12:52:04 -04:00
|
|
|
#ifndef __HAVE_ARCH_STRSCPY
|
string: drop __must_check from strscpy() and restore strscpy() usages in cgroup
commit 08a77676f9c5fc69a681ccd2cd8140e65dcb26c7 upstream.
e7fd37ba1217 ("cgroup: avoid copying strings longer than the buffers")
converted possibly unsafe strncpy() usages in cgroup to strscpy().
However, although the callsites are completely fine with truncated
copied, because strscpy() is marked __must_check, it led to the
following warnings.
kernel/cgroup/cgroup.c: In function ‘cgroup_file_name’:
kernel/cgroup/cgroup.c:1400:10: warning: ignoring return value of ‘strscpy’, declared with attribute warn_unused_result [-Wunused-result]
strscpy(buf, cft->name, CGROUP_FILE_NAME_MAX);
^
To avoid the warnings, 50034ed49645 ("cgroup: use strlcpy() instead of
strscpy() to avoid spurious warning") switched them to strlcpy().
strlcpy() is worse than strlcpy() because it unconditionally runs
strlen() on the source string, and the only reason we switched to
strlcpy() here was because it was lacking __must_check, which doesn't
reflect any material differences between the two function. It's just
that someone added __must_check to strscpy() and not to strlcpy().
These basic string copy operations are used in variety of ways, and
one of not-so-uncommon use cases is safely handling truncated copies,
where the caller naturally doesn't care about the return value. The
__must_check doesn't match the actual use cases and forces users to
opt for inferior variants which lack __must_check by happenstance or
spread ugly (void) casts.
Remove __must_check from strscpy() and restore strscpy() usages in
cgroup.
Signed-off-by: Tejun Heo <tj@kernel.org>
Suggested-by: Linus Torvalds <torvalds@linux-foundation.org>
Cc: Ma Shimiao <mashimiao.fnst@cn.fujitsu.com>
Cc: Arnd Bergmann <arnd@arndb.de>
Cc: Chris Metcalf <cmetcalf@ezchip.com>
[backport only the string.h portion to remove build warnings starting to show up - gregkh]
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
2018-01-09 07:21:15 -08:00
|
|
|
ssize_t strscpy(char *, const char *, size_t);
|
2015-04-29 12:52:04 -04:00
|
|
|
#endif
|
2005-04-16 15:20:36 -07:00
|
|
|
#ifndef __HAVE_ARCH_STRCAT
|
|
|
|
extern char * strcat(char *, const char *);
|
|
|
|
#endif
|
|
|
|
#ifndef __HAVE_ARCH_STRNCAT
|
|
|
|
extern char * strncat(char *, const char *, __kernel_size_t);
|
|
|
|
#endif
|
|
|
|
#ifndef __HAVE_ARCH_STRLCAT
|
|
|
|
extern size_t strlcat(char *, const char *, __kernel_size_t);
|
|
|
|
#endif
|
|
|
|
#ifndef __HAVE_ARCH_STRCMP
|
|
|
|
extern int strcmp(const char *,const char *);
|
|
|
|
#endif
|
|
|
|
#ifndef __HAVE_ARCH_STRNCMP
|
|
|
|
extern int strncmp(const char *,const char *,__kernel_size_t);
|
|
|
|
#endif
|
2007-03-29 01:18:42 -07:00
|
|
|
#ifndef __HAVE_ARCH_STRCASECMP
|
|
|
|
extern int strcasecmp(const char *s1, const char *s2);
|
|
|
|
#endif
|
|
|
|
#ifndef __HAVE_ARCH_STRNCASECMP
|
|
|
|
extern int strncasecmp(const char *s1, const char *s2, size_t n);
|
|
|
|
#endif
|
2005-04-16 15:20:36 -07:00
|
|
|
#ifndef __HAVE_ARCH_STRCHR
|
|
|
|
extern char * strchr(const char *,int);
|
|
|
|
#endif
|
2014-03-14 17:00:14 +00:00
|
|
|
#ifndef __HAVE_ARCH_STRCHRNUL
|
|
|
|
extern char * strchrnul(const char *,int);
|
|
|
|
#endif
|
2005-04-16 15:20:36 -07:00
|
|
|
#ifndef __HAVE_ARCH_STRNCHR
|
|
|
|
extern char * strnchr(const char *, size_t, int);
|
|
|
|
#endif
|
|
|
|
#ifndef __HAVE_ARCH_STRRCHR
|
|
|
|
extern char * strrchr(const char *,int);
|
|
|
|
#endif
|
2009-12-14 18:01:04 -08:00
|
|
|
extern char * __must_check skip_spaces(const char *);
|
2009-12-14 18:01:15 -08:00
|
|
|
|
|
|
|
extern char *strim(char *);
|
|
|
|
|
|
|
|
static inline __must_check char *strstrip(char *str)
|
|
|
|
{
|
|
|
|
return strim(str);
|
|
|
|
}
|
|
|
|
|
2005-04-16 15:20:36 -07:00
|
|
|
#ifndef __HAVE_ARCH_STRSTR
|
2010-01-14 10:53:55 +08:00
|
|
|
extern char * strstr(const char *, const char *);
|
|
|
|
#endif
|
|
|
|
#ifndef __HAVE_ARCH_STRNSTR
|
|
|
|
extern char * strnstr(const char *, const char *, size_t);
|
2005-04-16 15:20:36 -07:00
|
|
|
#endif
|
|
|
|
#ifndef __HAVE_ARCH_STRLEN
|
|
|
|
extern __kernel_size_t strlen(const char *);
|
|
|
|
#endif
|
|
|
|
#ifndef __HAVE_ARCH_STRNLEN
|
|
|
|
extern __kernel_size_t strnlen(const char *,__kernel_size_t);
|
|
|
|
#endif
|
2006-04-10 22:53:57 -07:00
|
|
|
#ifndef __HAVE_ARCH_STRPBRK
|
|
|
|
extern char * strpbrk(const char *,const char *);
|
|
|
|
#endif
|
|
|
|
#ifndef __HAVE_ARCH_STRSEP
|
|
|
|
extern char * strsep(char **,const char *);
|
|
|
|
#endif
|
|
|
|
#ifndef __HAVE_ARCH_STRSPN
|
|
|
|
extern __kernel_size_t strspn(const char *,const char *);
|
|
|
|
#endif
|
|
|
|
#ifndef __HAVE_ARCH_STRCSPN
|
|
|
|
extern __kernel_size_t strcspn(const char *,const char *);
|
|
|
|
#endif
|
2005-04-16 15:20:36 -07:00
|
|
|
|
|
|
|
#ifndef __HAVE_ARCH_MEMSET
|
|
|
|
extern void * memset(void *,int,__kernel_size_t);
|
|
|
|
#endif
|
|
|
|
#ifndef __HAVE_ARCH_MEMCPY
|
|
|
|
extern void * memcpy(void *,const void *,__kernel_size_t);
|
|
|
|
#endif
|
|
|
|
#ifndef __HAVE_ARCH_MEMMOVE
|
|
|
|
extern void * memmove(void *,const void *,__kernel_size_t);
|
|
|
|
#endif
|
|
|
|
#ifndef __HAVE_ARCH_MEMSCAN
|
|
|
|
extern void * memscan(void *,int,__kernel_size_t);
|
|
|
|
#endif
|
|
|
|
#ifndef __HAVE_ARCH_MEMCMP
|
|
|
|
extern int memcmp(const void *,const void *,__kernel_size_t);
|
|
|
|
#endif
|
2019-04-05 18:38:45 -07:00
|
|
|
#ifndef __HAVE_ARCH_BCMP
|
|
|
|
extern int bcmp(const void *,const void *,__kernel_size_t);
|
|
|
|
#endif
|
2005-04-16 15:20:36 -07:00
|
|
|
#ifndef __HAVE_ARCH_MEMCHR
|
|
|
|
extern void * memchr(const void *,int,__kernel_size_t);
|
|
|
|
#endif
|
2011-10-31 17:08:07 -07:00
|
|
|
void *memchr_inv(const void *s, int c, size_t n);
|
2015-06-25 15:02:22 -07:00
|
|
|
char *strreplace(char *s, char old, char new);
|
2005-04-16 15:20:36 -07:00
|
|
|
|
2015-02-13 14:36:24 -08:00
|
|
|
extern void kfree_const(const void *x);
|
|
|
|
|
2016-05-19 17:10:55 -07:00
|
|
|
extern char *kstrdup(const char *s, gfp_t gfp) __malloc;
|
2015-02-13 14:36:24 -08:00
|
|
|
extern const char *kstrdup_const(const char *s, gfp_t gfp);
|
2007-07-17 18:37:02 -07:00
|
|
|
extern char *kstrndup(const char *s, size_t len, gfp_t gfp);
|
[PATCH] kmemdup: introduce
One of idiomatic ways to duplicate a region of memory is
dst = kmalloc(len, GFP_KERNEL);
if (!dst)
return -ENOMEM;
memcpy(dst, src, len);
which is neat code except a programmer needs to write size twice. Which
sometimes leads to mistakes. If len passed to kmalloc is smaller that len
passed to memcpy, it's straight overwrite-beyond-end. If len passed to
memcpy is smaller than len passed to kmalloc, it's either a) legit
behaviour ;-), or b) cloned buffer will contain garbage in second half.
Slight trolling of commit lists shows several duplications bugs
done exactly because of diverged lenghts:
Linux:
[CRYPTO]: Fix memcpy/memset args.
[PATCH] memcpy/memset fixes
OpenBSD:
kerberosV/src/lib/asn1: der_copy.c:1.4
If programmer is given only one place to play with lengths, I believe, such
mistakes could be avoided.
With kmemdup, the snippet above will be rewritten as:
dst = kmemdup(src, len, GFP_KERNEL);
if (!dst)
return -ENOMEM;
This also leads to smaller code (kzalloc effect). Quick grep shows
200+ places where kmemdup() can be used.
Signed-off-by: Alexey Dobriyan <adobriyan@gmail.com>
Signed-off-by: Andrew Morton <akpm@osdl.org>
Signed-off-by: Linus Torvalds <torvalds@osdl.org>
2006-09-30 23:27:20 -07:00
|
|
|
extern void *kmemdup(const void *src, size_t len, gfp_t gfp);
|
2017-07-04 17:25:02 +01:00
|
|
|
extern char *kmemdup_nul(const char *s, size_t len, gfp_t gfp);
|
2005-06-23 00:09:02 -07:00
|
|
|
|
2007-07-17 18:37:02 -07:00
|
|
|
extern char **argv_split(gfp_t gfp, const char *str, int *argcp);
|
|
|
|
extern void argv_free(char **argv);
|
|
|
|
|
2008-05-01 04:34:42 -07:00
|
|
|
extern bool sysfs_streq(const char *s1, const char *s2);
|
2016-03-17 14:22:50 -07:00
|
|
|
extern int kstrtobool(const char *s, bool *res);
|
|
|
|
static inline int strtobool(const char *s, bool *res)
|
|
|
|
{
|
|
|
|
return kstrtobool(s, res);
|
|
|
|
}
|
2008-05-01 04:34:42 -07:00
|
|
|
|
2016-03-17 14:22:14 -07:00
|
|
|
int match_string(const char * const *array, size_t n, const char *string);
|
2020-02-04 13:44:48 +02:00
|
|
|
int __sysfs_match_string(const char * const *array, size_t n, const char *s);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* sysfs_match_string - matches given string in an array
|
|
|
|
* @_a: array of strings
|
|
|
|
* @_s: string to match with
|
|
|
|
*
|
|
|
|
* Helper for __sysfs_match_string(). Calculates the size of @a automatically.
|
|
|
|
*/
|
|
|
|
#define sysfs_match_string(_a, _s) __sysfs_match_string(_a, ARRAY_SIZE(_a), _s)
|
2016-03-17 14:22:14 -07:00
|
|
|
|
2009-03-06 17:21:46 +01:00
|
|
|
#ifdef CONFIG_BINARY_PRINTF
|
|
|
|
int vbin_printf(u32 *bin_buf, size_t size, const char *fmt, va_list args);
|
|
|
|
int bstr_printf(char *buf, size_t size, const char *fmt, const u32 *bin_buf);
|
|
|
|
int bprintf(u32 *bin_buf, size_t size, const char *fmt, ...) __printf(3, 4);
|
|
|
|
#endif
|
|
|
|
|
2008-07-23 21:26:44 -07:00
|
|
|
extern ssize_t memory_read_from_buffer(void *to, size_t count, loff_t *ppos,
|
2014-08-26 23:16:35 -04:00
|
|
|
const void *from, size_t available);
|
2008-07-23 21:26:44 -07:00
|
|
|
|
2009-03-31 13:05:36 -06:00
|
|
|
/**
|
|
|
|
* strstarts - does @str start with @prefix?
|
|
|
|
* @str: string to examine
|
|
|
|
* @prefix: prefix to look for.
|
|
|
|
*/
|
|
|
|
static inline bool strstarts(const char *str, const char *prefix)
|
|
|
|
{
|
|
|
|
return strncmp(str, prefix, strlen(prefix)) == 0;
|
|
|
|
}
|
2012-07-30 14:40:55 -07:00
|
|
|
|
2014-08-26 23:16:35 -04:00
|
|
|
size_t memweight(const void *ptr, size_t bytes);
|
|
|
|
void memzero_explicit(void *s, size_t count);
|
2012-07-30 14:40:55 -07:00
|
|
|
|
2012-12-17 16:01:18 -08:00
|
|
|
/**
|
|
|
|
* kbasename - return the last part of a pathname.
|
|
|
|
*
|
|
|
|
* @path: path to extract the filename from.
|
|
|
|
*/
|
|
|
|
static inline const char *kbasename(const char *path)
|
|
|
|
{
|
|
|
|
const char *tail = strrchr(path, '/');
|
|
|
|
return tail ? tail + 1 : path;
|
|
|
|
}
|
|
|
|
|
2005-04-16 15:20:36 -07:00
|
|
|
#endif /* _LINUX_STRING_H_ */
|