1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _LINUX_STRING_HELPERS_H_
3 #define _LINUX_STRING_HELPERS_H_
5 #include <linux/bits.h>
6 #include <linux/ctype.h>
7 #include <linux/string.h>
8 #include <linux/types.h>
14 static inline bool string_is_terminated(const char *s, int len)
16 return memchr(s, '\0', len) ? true : false;
19 /* Descriptions of the types of units to
21 enum string_size_units {
22 STRING_UNITS_10, /* use powers of 10^3 (standard SI) */
23 STRING_UNITS_2, /* use binary powers of 2^10 */
26 void string_get_size(u64 size, u64 blk_size, enum string_size_units units,
29 int parse_int_array_user(const char __user *from, size_t count, int **array);
31 #define UNESCAPE_SPACE BIT(0)
32 #define UNESCAPE_OCTAL BIT(1)
33 #define UNESCAPE_HEX BIT(2)
34 #define UNESCAPE_SPECIAL BIT(3)
35 #define UNESCAPE_ANY \
36 (UNESCAPE_SPACE | UNESCAPE_OCTAL | UNESCAPE_HEX | UNESCAPE_SPECIAL)
38 #define UNESCAPE_ALL_MASK GENMASK(3, 0)
40 int string_unescape(char *src, char *dst, size_t size, unsigned int flags);
42 static inline int string_unescape_inplace(char *buf, unsigned int flags)
44 return string_unescape(buf, buf, 0, flags);
47 static inline int string_unescape_any(char *src, char *dst, size_t size)
49 return string_unescape(src, dst, size, UNESCAPE_ANY);
52 static inline int string_unescape_any_inplace(char *buf)
54 return string_unescape_any(buf, buf, 0);
57 #define ESCAPE_SPACE BIT(0)
58 #define ESCAPE_SPECIAL BIT(1)
59 #define ESCAPE_NULL BIT(2)
60 #define ESCAPE_OCTAL BIT(3)
62 (ESCAPE_SPACE | ESCAPE_OCTAL | ESCAPE_SPECIAL | ESCAPE_NULL)
63 #define ESCAPE_NP BIT(4)
64 #define ESCAPE_ANY_NP (ESCAPE_ANY | ESCAPE_NP)
65 #define ESCAPE_HEX BIT(5)
66 #define ESCAPE_NA BIT(6)
67 #define ESCAPE_NAP BIT(7)
68 #define ESCAPE_APPEND BIT(8)
70 #define ESCAPE_ALL_MASK GENMASK(8, 0)
72 int string_escape_mem(const char *src, size_t isz, char *dst, size_t osz,
73 unsigned int flags, const char *only);
75 static inline int string_escape_mem_any_np(const char *src, size_t isz,
76 char *dst, size_t osz, const char *only)
78 return string_escape_mem(src, isz, dst, osz, ESCAPE_ANY_NP, only);
81 static inline int string_escape_str(const char *src, char *dst, size_t sz,
82 unsigned int flags, const char *only)
84 return string_escape_mem(src, strlen(src), dst, sz, flags, only);
87 static inline int string_escape_str_any_np(const char *src, char *dst,
88 size_t sz, const char *only)
90 return string_escape_str(src, dst, sz, ESCAPE_ANY_NP, only);
93 static inline void string_upper(char *dst, const char *src)
96 *dst++ = toupper(*src);
100 static inline void string_lower(char *dst, const char *src)
103 *dst++ = tolower(*src);
107 char *kstrdup_quotable(const char *src, gfp_t gfp);
108 char *kstrdup_quotable_cmdline(struct task_struct *task, gfp_t gfp);
109 char *kstrdup_quotable_file(struct file *file, gfp_t gfp);
111 char **kasprintf_strarray(gfp_t gfp, const char *prefix, size_t n);
112 void kfree_strarray(char **array, size_t n);
114 char **devm_kasprintf_strarray(struct device *dev, const char *prefix, size_t n);
116 static inline const char *str_yes_no(bool v)
118 return v ? "yes" : "no";
121 static inline const char *str_on_off(bool v)
123 return v ? "on" : "off";
126 static inline const char *str_enable_disable(bool v)
128 return v ? "enable" : "disable";
131 static inline const char *str_enabled_disabled(bool v)
133 return v ? "enabled" : "disabled";
136 static inline const char *str_read_write(bool v)
138 return v ? "read" : "write";