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