blob: dabe643eb5fadcde8d00a02df9aba03faa9c2592 [file] [log] [blame]
James Bottomley3c9f3682008-08-31 10:13:54 -05001#ifndef _LINUX_STRING_HELPERS_H_
2#define _LINUX_STRING_HELPERS_H_
3
4#include <linux/types.h>
5
6/* Descriptions of the types of units to
7 * print in */
8enum string_size_units {
9 STRING_UNITS_10, /* use powers of 10^3 (standard SI) */
10 STRING_UNITS_2, /* use binary powers of 2^10 */
11};
12
James Bottomleyb9f28d82015-03-05 18:47:01 -080013void string_get_size(u64 size, u64 blk_size, enum string_size_units units,
Rasmus Villemoesd1214c62015-02-12 15:01:50 -080014 char *buf, int len);
James Bottomley3c9f3682008-08-31 10:13:54 -050015
Andy Shevchenko16c7fa02013-04-30 15:27:30 -070016#define UNESCAPE_SPACE 0x01
17#define UNESCAPE_OCTAL 0x02
18#define UNESCAPE_HEX 0x04
19#define UNESCAPE_SPECIAL 0x08
20#define UNESCAPE_ANY \
21 (UNESCAPE_SPACE | UNESCAPE_OCTAL | UNESCAPE_HEX | UNESCAPE_SPECIAL)
22
Andy Shevchenko16c7fa02013-04-30 15:27:30 -070023int string_unescape(char *src, char *dst, size_t size, unsigned int flags);
24
25static inline int string_unescape_inplace(char *buf, unsigned int flags)
26{
27 return string_unescape(buf, buf, 0, flags);
28}
29
30static inline int string_unescape_any(char *src, char *dst, size_t size)
31{
32 return string_unescape(src, dst, size, UNESCAPE_ANY);
33}
34
35static inline int string_unescape_any_inplace(char *buf)
36{
37 return string_unescape_any(buf, buf, 0);
38}
39
Andy Shevchenkoc8250382014-10-13 15:55:16 -070040#define ESCAPE_SPACE 0x01
41#define ESCAPE_SPECIAL 0x02
42#define ESCAPE_NULL 0x04
43#define ESCAPE_OCTAL 0x08
44#define ESCAPE_ANY \
45 (ESCAPE_SPACE | ESCAPE_OCTAL | ESCAPE_SPECIAL | ESCAPE_NULL)
46#define ESCAPE_NP 0x10
47#define ESCAPE_ANY_NP (ESCAPE_ANY | ESCAPE_NP)
48#define ESCAPE_HEX 0x20
49
Rasmus Villemoes41416f22015-04-15 16:17:28 -070050int string_escape_mem(const char *src, size_t isz, char *dst, size_t osz,
Kees Cookb40bdb72015-09-09 15:37:16 -070051 unsigned int flags, const char *only);
Andy Shevchenkoc8250382014-10-13 15:55:16 -070052
53static inline int string_escape_mem_any_np(const char *src, size_t isz,
Kees Cookb40bdb72015-09-09 15:37:16 -070054 char *dst, size_t osz, const char *only)
Andy Shevchenkoc8250382014-10-13 15:55:16 -070055{
Kees Cookb40bdb72015-09-09 15:37:16 -070056 return string_escape_mem(src, isz, dst, osz, ESCAPE_ANY_NP, only);
Andy Shevchenkoc8250382014-10-13 15:55:16 -070057}
58
Rasmus Villemoes41416f22015-04-15 16:17:28 -070059static inline int string_escape_str(const char *src, char *dst, size_t sz,
Kees Cookb40bdb72015-09-09 15:37:16 -070060 unsigned int flags, const char *only)
Andy Shevchenkoc8250382014-10-13 15:55:16 -070061{
Kees Cookb40bdb72015-09-09 15:37:16 -070062 return string_escape_mem(src, strlen(src), dst, sz, flags, only);
Andy Shevchenkoc8250382014-10-13 15:55:16 -070063}
64
Rasmus Villemoes41416f22015-04-15 16:17:28 -070065static inline int string_escape_str_any_np(const char *src, char *dst,
Kees Cookb40bdb72015-09-09 15:37:16 -070066 size_t sz, const char *only)
Andy Shevchenkoc8250382014-10-13 15:55:16 -070067{
Kees Cookb40bdb72015-09-09 15:37:16 -070068 return string_escape_str(src, dst, sz, ESCAPE_ANY_NP, only);
Andy Shevchenkoc8250382014-10-13 15:55:16 -070069}
70
James Bottomley3c9f3682008-08-31 10:13:54 -050071#endif