Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
1/* SPDX-License-Identifier: GPL-2.0 */
2#ifndef _LINUX_STRING_HELPERS_H_
3#define _LINUX_STRING_HELPERS_H_
4
5#include <linux/types.h>
6
7struct file;
8
9/* Descriptions of the types of units to
10 * print in */
11enum string_size_units {
12 STRING_UNITS_10, /* use powers of 10^3 (standard SI) */
13 STRING_UNITS_2, /* use binary powers of 2^10 */
14};
15
16void string_get_size(u64 size, u64 blk_size, enum string_size_units units,
17 char *buf, int len);
18
19#define UNESCAPE_SPACE 0x01
20#define UNESCAPE_OCTAL 0x02
21#define UNESCAPE_HEX 0x04
22#define UNESCAPE_SPECIAL 0x08
23#define UNESCAPE_ANY \
24 (UNESCAPE_SPACE | UNESCAPE_OCTAL | UNESCAPE_HEX | UNESCAPE_SPECIAL)
25
26int string_unescape(char *src, char *dst, size_t size, unsigned int flags);
27
28static inline int string_unescape_inplace(char *buf, unsigned int flags)
29{
30 return string_unescape(buf, buf, 0, flags);
31}
32
33static inline int string_unescape_any(char *src, char *dst, size_t size)
34{
35 return string_unescape(src, dst, size, UNESCAPE_ANY);
36}
37
38static inline int string_unescape_any_inplace(char *buf)
39{
40 return string_unescape_any(buf, buf, 0);
41}
42
43#define ESCAPE_SPACE 0x01
44#define ESCAPE_SPECIAL 0x02
45#define ESCAPE_NULL 0x04
46#define ESCAPE_OCTAL 0x08
47#define ESCAPE_ANY \
48 (ESCAPE_SPACE | ESCAPE_OCTAL | ESCAPE_SPECIAL | ESCAPE_NULL)
49#define ESCAPE_NP 0x10
50#define ESCAPE_ANY_NP (ESCAPE_ANY | ESCAPE_NP)
51#define ESCAPE_HEX 0x20
52
53int string_escape_mem(const char *src, size_t isz, char *dst, size_t osz,
54 unsigned int flags, const char *only);
55
56static inline int string_escape_mem_any_np(const char *src, size_t isz,
57 char *dst, size_t osz, const char *only)
58{
59 return string_escape_mem(src, isz, dst, osz, ESCAPE_ANY_NP, only);
60}
61
62static inline int string_escape_str(const char *src, char *dst, size_t sz,
63 unsigned int flags, const char *only)
64{
65 return string_escape_mem(src, strlen(src), dst, sz, flags, only);
66}
67
68static inline int string_escape_str_any_np(const char *src, char *dst,
69 size_t sz, const char *only)
70{
71 return string_escape_str(src, dst, sz, ESCAPE_ANY_NP, only);
72}
73
74char *kstrdup_quotable(const char *src, gfp_t gfp);
75char *kstrdup_quotable_cmdline(struct task_struct *task, gfp_t gfp);
76char *kstrdup_quotable_file(struct file *file, gfp_t gfp);
77
78#endif