Commit | Line | Data |
---|---|---|
b2441318 | 1 | /* SPDX-License-Identifier: GPL-2.0 */ |
3c9f3681 JB |
2 | #ifndef _LINUX_STRING_HELPERS_H_ |
3 | #define _LINUX_STRING_HELPERS_H_ | |
4 | ||
994b6970 | 5 | #include <linux/bits.h> |
58eeba0b | 6 | #include <linux/ctype.h> |
fca76071 | 7 | #include <linux/string_choices.h> |
bfb3ba32 | 8 | #include <linux/string.h> |
3c9f3681 JB |
9 | #include <linux/types.h> |
10 | ||
acdb89b6 | 11 | struct device; |
21985319 | 12 | struct file; |
c6d24c32 | 13 | struct task_struct; |
21985319 | 14 | |
f1db99c0 AS |
15 | static inline bool string_is_terminated(const char *s, int len) |
16 | { | |
17 | return memchr(s, '\0', len) ? true : false; | |
18 | } | |
19 | ||
f0b7f8ad | 20 | /* Descriptions of the types of units to print in */ |
3c9f3681 JB |
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 */ | |
f0b7f8ad AS |
24 | STRING_UNITS_MASK = BIT(0), |
25 | ||
26 | /* Modifiers */ | |
27 | STRING_UNITS_NO_SPACE = BIT(30), | |
28 | STRING_UNITS_NO_BYTES = BIT(31), | |
3c9f3681 JB |
29 | }; |
30 | ||
f0b7f8ad | 31 | int string_get_size(u64 size, u64 blk_size, const enum string_size_units units, |
83feeb19 | 32 | char *buf, int len); |
3c9f3681 | 33 | |
f0b93323 CR |
34 | int parse_int_array_user(const char __user *from, size_t count, int **array); |
35 | ||
994b6970 AS |
36 | #define UNESCAPE_SPACE BIT(0) |
37 | #define UNESCAPE_OCTAL BIT(1) | |
38 | #define UNESCAPE_HEX BIT(2) | |
39 | #define UNESCAPE_SPECIAL BIT(3) | |
16c7fa05 AS |
40 | #define UNESCAPE_ANY \ |
41 | (UNESCAPE_SPACE | UNESCAPE_OCTAL | UNESCAPE_HEX | UNESCAPE_SPECIAL) | |
42 | ||
259fa5d7 AS |
43 | #define UNESCAPE_ALL_MASK GENMASK(3, 0) |
44 | ||
16c7fa05 AS |
45 | int string_unescape(char *src, char *dst, size_t size, unsigned int flags); |
46 | ||
47 | static inline int string_unescape_inplace(char *buf, unsigned int flags) | |
48 | { | |
49 | return string_unescape(buf, buf, 0, flags); | |
50 | } | |
51 | ||
52 | static inline int string_unescape_any(char *src, char *dst, size_t size) | |
53 | { | |
54 | return string_unescape(src, dst, size, UNESCAPE_ANY); | |
55 | } | |
56 | ||
57 | static inline int string_unescape_any_inplace(char *buf) | |
58 | { | |
59 | return string_unescape_any(buf, buf, 0); | |
60 | } | |
61 | ||
994b6970 AS |
62 | #define ESCAPE_SPACE BIT(0) |
63 | #define ESCAPE_SPECIAL BIT(1) | |
64 | #define ESCAPE_NULL BIT(2) | |
65 | #define ESCAPE_OCTAL BIT(3) | |
c8250381 AS |
66 | #define ESCAPE_ANY \ |
67 | (ESCAPE_SPACE | ESCAPE_OCTAL | ESCAPE_SPECIAL | ESCAPE_NULL) | |
994b6970 | 68 | #define ESCAPE_NP BIT(4) |
c8250381 | 69 | #define ESCAPE_ANY_NP (ESCAPE_ANY | ESCAPE_NP) |
994b6970 | 70 | #define ESCAPE_HEX BIT(5) |
a0809783 | 71 | #define ESCAPE_NA BIT(6) |
0362c27f | 72 | #define ESCAPE_NAP BIT(7) |
aec0d096 | 73 | #define ESCAPE_APPEND BIT(8) |
c8250381 | 74 | |
259fa5d7 AS |
75 | #define ESCAPE_ALL_MASK GENMASK(8, 0) |
76 | ||
41416f23 | 77 | int string_escape_mem(const char *src, size_t isz, char *dst, size_t osz, |
b40bdb7f | 78 | unsigned int flags, const char *only); |
c8250381 AS |
79 | |
80 | static inline int string_escape_mem_any_np(const char *src, size_t isz, | |
b40bdb7f | 81 | char *dst, size_t osz, const char *only) |
c8250381 | 82 | { |
b40bdb7f | 83 | return string_escape_mem(src, isz, dst, osz, ESCAPE_ANY_NP, only); |
c8250381 AS |
84 | } |
85 | ||
41416f23 | 86 | static inline int string_escape_str(const char *src, char *dst, size_t sz, |
b40bdb7f | 87 | unsigned int flags, const char *only) |
c8250381 | 88 | { |
b40bdb7f | 89 | return string_escape_mem(src, strlen(src), dst, sz, flags, only); |
c8250381 AS |
90 | } |
91 | ||
41416f23 | 92 | static inline int string_escape_str_any_np(const char *src, char *dst, |
b40bdb7f | 93 | size_t sz, const char *only) |
c8250381 | 94 | { |
b40bdb7f | 95 | return string_escape_str(src, dst, sz, ESCAPE_ANY_NP, only); |
c8250381 AS |
96 | } |
97 | ||
58eeba0b VP |
98 | static inline void string_upper(char *dst, const char *src) |
99 | { | |
100 | do { | |
101 | *dst++ = toupper(*src); | |
102 | } while (*src++); | |
103 | } | |
104 | ||
105 | static inline void string_lower(char *dst, const char *src) | |
106 | { | |
107 | do { | |
108 | *dst++ = tolower(*src); | |
109 | } while (*src++); | |
110 | } | |
111 | ||
b53f27e4 | 112 | char *kstrdup_quotable(const char *src, gfp_t gfp); |
0d044328 | 113 | char *kstrdup_quotable_cmdline(struct task_struct *task, gfp_t gfp); |
21985319 | 114 | char *kstrdup_quotable_file(struct file *file, gfp_t gfp); |
b53f27e4 | 115 | |
045ad464 AS |
116 | char *kstrdup_and_replace(const char *src, char old, char new, gfp_t gfp); |
117 | ||
418e0a35 | 118 | char **kasprintf_strarray(gfp_t gfp, const char *prefix, size_t n); |
0fd16012 BG |
119 | void kfree_strarray(char **array, size_t n); |
120 | ||
acdb89b6 AS |
121 | char **devm_kasprintf_strarray(struct device *dev, const char *prefix, size_t n); |
122 | ||
3c9f3681 | 123 | #endif |