Blame view

lib/string_helpers.c 3.61 KB
3c9f3681d   James Bottomley   [SCSI] lib: add g...
1
2
3
4
  /*
   * Helpers for formatting and printing strings
   *
   * Copyright 31 August 2008 James Bottomley
16c7fa058   Andy Shevchenko   lib/string_helper...
5
   * Copyright (C) 2013, Intel Corporation
3c9f3681d   James Bottomley   [SCSI] lib: add g...
6
7
8
   */
  #include <linux/kernel.h>
  #include <linux/math64.h>
8bc3bcc93   Paul Gortmaker   lib: reduce the u...
9
  #include <linux/export.h>
16c7fa058   Andy Shevchenko   lib/string_helper...
10
  #include <linux/ctype.h>
3c9f3681d   James Bottomley   [SCSI] lib: add g...
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
  #include <linux/string_helpers.h>
  
  /**
   * string_get_size - get the size in the specified units
   * @size:	The size to be converted
   * @units:	units to use (powers of 1000 or 1024)
   * @buf:	buffer to format to
   * @len:	length of buffer
   *
   * This function returns a string formatted to 3 significant figures
   * giving the size in the required units.  Returns 0 on success or
   * error on failure.  @buf is always zero terminated.
   *
   */
  int string_get_size(u64 size, const enum string_size_units units,
  		    char *buf, int len)
  {
68aecfb97   Andrew Morton   lib/string_helper...
28
  	static const char *units_10[] = { "B", "kB", "MB", "GB", "TB", "PB",
3c9f3681d   James Bottomley   [SCSI] lib: add g...
29
  				   "EB", "ZB", "YB", NULL};
68aecfb97   Andrew Morton   lib/string_helper...
30
  	static const char *units_2[] = {"B", "KiB", "MiB", "GiB", "TiB", "PiB",
3c9f3681d   James Bottomley   [SCSI] lib: add g...
31
  				 "EiB", "ZiB", "YiB", NULL };
68aecfb97   Andrew Morton   lib/string_helper...
32
  	static const char **units_str[] = {
3c9f3681d   James Bottomley   [SCSI] lib: add g...
33
34
35
  		[STRING_UNITS_10] =  units_10,
  		[STRING_UNITS_2] = units_2,
  	};
68aecfb97   Andrew Morton   lib/string_helper...
36
  	static const unsigned int divisor[] = {
3c9f3681d   James Bottomley   [SCSI] lib: add g...
37
38
39
40
41
42
43
44
  		[STRING_UNITS_10] = 1000,
  		[STRING_UNITS_2] = 1024,
  	};
  	int i, j;
  	u64 remainder = 0, sf_cap;
  	char tmp[8];
  
  	tmp[0] = '\0';
a8659597b   H. Peter Anvin   [SCSI] lib: strin...
45
46
47
48
49
50
  	i = 0;
  	if (size >= divisor[units]) {
  		while (size >= divisor[units] && units_str[units][i]) {
  			remainder = do_div(size, divisor[units]);
  			i++;
  		}
3c9f3681d   James Bottomley   [SCSI] lib: add g...
51

a8659597b   H. Peter Anvin   [SCSI] lib: strin...
52
53
54
  		sf_cap = size;
  		for (j = 0; sf_cap*10 < 1000; j++)
  			sf_cap *= 10;
3c9f3681d   James Bottomley   [SCSI] lib: add g...
55

a8659597b   H. Peter Anvin   [SCSI] lib: strin...
56
57
58
59
60
61
62
  		if (j) {
  			remainder *= 1000;
  			do_div(remainder, divisor[units]);
  			snprintf(tmp, sizeof(tmp), ".%03lld",
  				 (unsigned long long)remainder);
  			tmp[j+1] = '\0';
  		}
3c9f3681d   James Bottomley   [SCSI] lib: add g...
63
  	}
a8659597b   H. Peter Anvin   [SCSI] lib: strin...
64
  	snprintf(buf, len, "%lld%s %s", (unsigned long long)size,
3c9f3681d   James Bottomley   [SCSI] lib: add g...
65
66
67
68
69
  		 tmp, units_str[units][i]);
  
  	return 0;
  }
  EXPORT_SYMBOL(string_get_size);
16c7fa058   Andy Shevchenko   lib/string_helper...
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
  
  static bool unescape_space(char **src, char **dst)
  {
  	char *p = *dst, *q = *src;
  
  	switch (*q) {
  	case 'n':
  		*p = '
  ';
  		break;
  	case 'r':
  		*p = '\r';
  		break;
  	case 't':
  		*p = '\t';
  		break;
  	case 'v':
  		*p = '\v';
  		break;
  	case 'f':
  		*p = '\f';
  		break;
  	default:
  		return false;
  	}
  	*dst += 1;
  	*src += 1;
  	return true;
  }
  
  static bool unescape_octal(char **src, char **dst)
  {
  	char *p = *dst, *q = *src;
  	u8 num;
  
  	if (isodigit(*q) == 0)
  		return false;
  
  	num = (*q++) & 7;
  	while (num < 32 && isodigit(*q) && (q - *src < 3)) {
  		num <<= 3;
  		num += (*q++) & 7;
  	}
  	*p = num;
  	*dst += 1;
  	*src = q;
  	return true;
  }
  
  static bool unescape_hex(char **src, char **dst)
  {
  	char *p = *dst, *q = *src;
  	int digit;
  	u8 num;
  
  	if (*q++ != 'x')
  		return false;
  
  	num = digit = hex_to_bin(*q++);
  	if (digit < 0)
  		return false;
  
  	digit = hex_to_bin(*q);
  	if (digit >= 0) {
  		q++;
  		num = (num << 4) | digit;
  	}
  	*p = num;
  	*dst += 1;
  	*src = q;
  	return true;
  }
  
  static bool unescape_special(char **src, char **dst)
  {
  	char *p = *dst, *q = *src;
  
  	switch (*q) {
  	case '\"':
  		*p = '\"';
  		break;
  	case '\\':
  		*p = '\\';
  		break;
  	case 'a':
  		*p = '\a';
  		break;
  	case 'e':
  		*p = '\e';
  		break;
  	default:
  		return false;
  	}
  	*dst += 1;
  	*src += 1;
  	return true;
  }
  
  int string_unescape(char *src, char *dst, size_t size, unsigned int flags)
  {
  	char *out = dst;
  
  	while (*src && --size) {
  		if (src[0] == '\\' && src[1] != '\0' && size > 1) {
  			src++;
  			size--;
  
  			if (flags & UNESCAPE_SPACE &&
  					unescape_space(&src, &out))
  				continue;
  
  			if (flags & UNESCAPE_OCTAL &&
  					unescape_octal(&src, &out))
  				continue;
  
  			if (flags & UNESCAPE_HEX &&
  					unescape_hex(&src, &out))
  				continue;
  
  			if (flags & UNESCAPE_SPECIAL &&
  					unescape_special(&src, &out))
  				continue;
  
  			*out++ = '\\';
  		}
  		*out++ = *src++;
  	}
  	*out = '\0';
  
  	return out - dst;
  }
  EXPORT_SYMBOL(string_unescape);