1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _LINUX_STRING_HELPERS_H_
3 #define _LINUX_STRING_HELPERS_H_
4
5 #include <linux/bits.h>
6 #include <linux/ctype.h>
7 #include <linux/string.h>
8 #include <linux/types.h>
9
10 struct device;
11 struct file;
12 struct task_struct;
13
string_is_terminated(const char * s,int len)14 static inline bool string_is_terminated(const char *s, int len)
15 {
16 return memchr(s, '\0', len) ? true : false;
17 }
18
19 /* Descriptions of the types of units to
20 * print in */
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 */
24 };
25
26 void string_get_size(u64 size, u64 blk_size, enum string_size_units units,
27 char *buf, int len);
28
29 int parse_int_array_user(const char __user *from, size_t count, int **array);
30
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)
37
38 #define UNESCAPE_ALL_MASK GENMASK(3, 0)
39
40 int string_unescape(char *src, char *dst, size_t size, unsigned int flags);
41
string_unescape_inplace(char * buf,unsigned int flags)42 static inline int string_unescape_inplace(char *buf, unsigned int flags)
43 {
44 return string_unescape(buf, buf, 0, flags);
45 }
46
string_unescape_any(char * src,char * dst,size_t size)47 static inline int string_unescape_any(char *src, char *dst, size_t size)
48 {
49 return string_unescape(src, dst, size, UNESCAPE_ANY);
50 }
51
string_unescape_any_inplace(char * buf)52 static inline int string_unescape_any_inplace(char *buf)
53 {
54 return string_unescape_any(buf, buf, 0);
55 }
56
57 #define ESCAPE_SPACE BIT(0)
58 #define ESCAPE_SPECIAL BIT(1)
59 #define ESCAPE_NULL BIT(2)
60 #define ESCAPE_OCTAL BIT(3)
61 #define ESCAPE_ANY \
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)
69
70 #define ESCAPE_ALL_MASK GENMASK(8, 0)
71
72 int string_escape_mem(const char *src, size_t isz, char *dst, size_t osz,
73 unsigned int flags, const char *only);
74
string_escape_mem_any_np(const char * src,size_t isz,char * dst,size_t osz,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)
77 {
78 return string_escape_mem(src, isz, dst, osz, ESCAPE_ANY_NP, only);
79 }
80
string_escape_str(const char * src,char * dst,size_t sz,unsigned int flags,const char * only)81 static inline int string_escape_str(const char *src, char *dst, size_t sz,
82 unsigned int flags, const char *only)
83 {
84 return string_escape_mem(src, strlen(src), dst, sz, flags, only);
85 }
86
string_escape_str_any_np(const char * src,char * dst,size_t sz,const char * only)87 static inline int string_escape_str_any_np(const char *src, char *dst,
88 size_t sz, const char *only)
89 {
90 return string_escape_str(src, dst, sz, ESCAPE_ANY_NP, only);
91 }
92
string_upper(char * dst,const char * src)93 static inline void string_upper(char *dst, const char *src)
94 {
95 do {
96 *dst++ = toupper(*src);
97 } while (*src++);
98 }
99
string_lower(char * dst,const char * src)100 static inline void string_lower(char *dst, const char *src)
101 {
102 do {
103 *dst++ = tolower(*src);
104 } while (*src++);
105 }
106
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);
110
111 char **kasprintf_strarray(gfp_t gfp, const char *prefix, size_t n);
112 void kfree_strarray(char **array, size_t n);
113
114 char **devm_kasprintf_strarray(struct device *dev, const char *prefix, size_t n);
115
str_yes_no(bool v)116 static inline const char *str_yes_no(bool v)
117 {
118 return v ? "yes" : "no";
119 }
120
str_on_off(bool v)121 static inline const char *str_on_off(bool v)
122 {
123 return v ? "on" : "off";
124 }
125
str_enable_disable(bool v)126 static inline const char *str_enable_disable(bool v)
127 {
128 return v ? "enable" : "disable";
129 }
130
str_enabled_disabled(bool v)131 static inline const char *str_enabled_disabled(bool v)
132 {
133 return v ? "enabled" : "disabled";
134 }
135
str_read_write(bool v)136 static inline const char *str_read_write(bool v)
137 {
138 return v ? "read" : "write";
139 }
140
141 #endif
142