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/types.h> 8 9 struct file; 10 struct task_struct; 11 12 /* Descriptions of the types of units to 13 * print in */ 14 enum string_size_units { 15 STRING_UNITS_10, /* use powers of 10^3 (standard SI) */ 16 STRING_UNITS_2, /* use binary powers of 2^10 */ 17 }; 18 19 void string_get_size(u64 size, u64 blk_size, enum string_size_units units, 20 char *buf, int len); 21 22 #define UNESCAPE_SPACE BIT(0) 23 #define UNESCAPE_OCTAL BIT(1) 24 #define UNESCAPE_HEX BIT(2) 25 #define UNESCAPE_SPECIAL BIT(3) 26 #define UNESCAPE_ANY \ 27 (UNESCAPE_SPACE | UNESCAPE_OCTAL | UNESCAPE_HEX | UNESCAPE_SPECIAL) 28 29 int string_unescape(char *src, char *dst, size_t size, unsigned int flags); 30 31 static inline int string_unescape_inplace(char *buf, unsigned int flags) 32 { 33 return string_unescape(buf, buf, 0, flags); 34 } 35 36 static inline int string_unescape_any(char *src, char *dst, size_t size) 37 { 38 return string_unescape(src, dst, size, UNESCAPE_ANY); 39 } 40 41 static inline int string_unescape_any_inplace(char *buf) 42 { 43 return string_unescape_any(buf, buf, 0); 44 } 45 46 #define ESCAPE_SPACE BIT(0) 47 #define ESCAPE_SPECIAL BIT(1) 48 #define ESCAPE_NULL BIT(2) 49 #define ESCAPE_OCTAL BIT(3) 50 #define ESCAPE_ANY \ 51 (ESCAPE_SPACE | ESCAPE_OCTAL | ESCAPE_SPECIAL | ESCAPE_NULL) 52 #define ESCAPE_NP BIT(4) 53 #define ESCAPE_ANY_NP (ESCAPE_ANY | ESCAPE_NP) 54 #define ESCAPE_HEX BIT(5) 55 #define ESCAPE_NA BIT(6) 56 #define ESCAPE_NAP BIT(7) 57 #define ESCAPE_APPEND BIT(8) 58 59 int string_escape_mem(const char *src, size_t isz, char *dst, size_t osz, 60 unsigned int flags, const char *only); 61 62 int string_escape_mem_ascii(const char *src, size_t isz, char *dst, 63 size_t osz); 64 65 static inline int string_escape_mem_any_np(const char *src, size_t isz, 66 char *dst, size_t osz, const char *only) 67 { 68 return string_escape_mem(src, isz, dst, osz, ESCAPE_ANY_NP, only); 69 } 70 71 static inline int string_escape_str(const char *src, char *dst, size_t sz, 72 unsigned int flags, const char *only) 73 { 74 return string_escape_mem(src, strlen(src), dst, sz, flags, only); 75 } 76 77 static inline int string_escape_str_any_np(const char *src, char *dst, 78 size_t sz, const char *only) 79 { 80 return string_escape_str(src, dst, sz, ESCAPE_ANY_NP, only); 81 } 82 83 static inline void string_upper(char *dst, const char *src) 84 { 85 do { 86 *dst++ = toupper(*src); 87 } while (*src++); 88 } 89 90 static inline void string_lower(char *dst, const char *src) 91 { 92 do { 93 *dst++ = tolower(*src); 94 } while (*src++); 95 } 96 97 char *kstrdup_quotable(const char *src, gfp_t gfp); 98 char *kstrdup_quotable_cmdline(struct task_struct *task, gfp_t gfp); 99 char *kstrdup_quotable_file(struct file *file, gfp_t gfp); 100 101 void kfree_strarray(char **array, size_t n); 102 103 #endif 104