Blame view

lib/kstrtox.c 9.42 KB
33ee3b2e2   Alexey Dobriyan   kstrto*: converti...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
  /*
   * Convert integer string representation to an integer.
   * If an integer doesn't fit into specified type, -E is returned.
   *
   * Integer starts with optional sign.
   * kstrtou*() functions do not accept sign "-".
   *
   * Radix 0 means autodetection: leading "0x" implies radix 16,
   * leading "0" implies radix 8, otherwise radix is 10.
   * Autodetection hints work after optional sign, but not before.
   *
   * If -E is returned, result is not touched.
   */
  #include <linux/ctype.h>
  #include <linux/errno.h>
  #include <linux/kernel.h>
  #include <linux/math64.h>
8bc3bcc93   Paul Gortmaker   lib: reduce the u...
18
  #include <linux/export.h>
33ee3b2e2   Alexey Dobriyan   kstrto*: converti...
19
  #include <linux/types.h>
c196e32a1   Alexey Dobriyan   lib: add kstrto*_...
20
  #include <asm/uaccess.h>
1dff46d69   Alexey Dobriyan   lib/kstrtox: comm...
21
  #include "kstrtox.h"
33ee3b2e2   Alexey Dobriyan   kstrto*: converti...
22

1dff46d69   Alexey Dobriyan   lib/kstrtox: comm...
23
  const char *_parse_integer_fixup_radix(const char *s, unsigned int *base)
33ee3b2e2   Alexey Dobriyan   kstrto*: converti...
24
  {
1dff46d69   Alexey Dobriyan   lib/kstrtox: comm...
25
  	if (*base == 0) {
33ee3b2e2   Alexey Dobriyan   kstrto*: converti...
26
27
  		if (s[0] == '0') {
  			if (_tolower(s[1]) == 'x' && isxdigit(s[2]))
1dff46d69   Alexey Dobriyan   lib/kstrtox: comm...
28
  				*base = 16;
33ee3b2e2   Alexey Dobriyan   kstrto*: converti...
29
  			else
1dff46d69   Alexey Dobriyan   lib/kstrtox: comm...
30
  				*base = 8;
33ee3b2e2   Alexey Dobriyan   kstrto*: converti...
31
  		} else
1dff46d69   Alexey Dobriyan   lib/kstrtox: comm...
32
  			*base = 10;
33ee3b2e2   Alexey Dobriyan   kstrto*: converti...
33
  	}
1dff46d69   Alexey Dobriyan   lib/kstrtox: comm...
34
  	if (*base == 16 && s[0] == '0' && _tolower(s[1]) == 'x')
33ee3b2e2   Alexey Dobriyan   kstrto*: converti...
35
  		s += 2;
1dff46d69   Alexey Dobriyan   lib/kstrtox: comm...
36
37
38
39
40
41
42
43
44
45
46
  	return s;
  }
  
  /*
   * Convert non-negative integer string representation in explicitly given radix
   * to an integer.
   * Return number of characters consumed maybe or-ed with overflow bit.
   * If overflow occurs, result integer (incorrect) is still returned.
   *
   * Don't you dare use this function.
   */
690d137f4   David Howells   Reduce the number...
47
  unsigned int _parse_integer(const char *s, unsigned int base, unsigned long long *p)
1dff46d69   Alexey Dobriyan   lib/kstrtox: comm...
48
  {
690d137f4   David Howells   Reduce the number...
49
  	unsigned long long res;
1dff46d69   Alexey Dobriyan   lib/kstrtox: comm...
50
51
  	unsigned int rv;
  	int overflow;
33ee3b2e2   Alexey Dobriyan   kstrto*: converti...
52

690d137f4   David Howells   Reduce the number...
53
  	res = 0;
1dff46d69   Alexey Dobriyan   lib/kstrtox: comm...
54
55
  	rv = 0;
  	overflow = 0;
33ee3b2e2   Alexey Dobriyan   kstrto*: converti...
56
57
58
59
60
61
62
  	while (*s) {
  		unsigned int val;
  
  		if ('0' <= *s && *s <= '9')
  			val = *s - '0';
  		else if ('a' <= _tolower(*s) && _tolower(*s) <= 'f')
  			val = _tolower(*s) - 'a' + 10;
78be959e3   Alexey Dobriyan   kstrtox: simpler ...
63
  		else
1dff46d69   Alexey Dobriyan   lib/kstrtox: comm...
64
  			break;
33ee3b2e2   Alexey Dobriyan   kstrto*: converti...
65
66
  
  		if (val >= base)
1dff46d69   Alexey Dobriyan   lib/kstrtox: comm...
67
  			break;
690d137f4   David Howells   Reduce the number...
68
69
70
71
72
73
74
75
76
  		/*
  		 * Check for overflow only if we are within range of
  		 * it in the max base we support (16)
  		 */
  		if (unlikely(res & (~0ull << 60))) {
  			if (res > div_u64(ULLONG_MAX - val, base))
  				overflow = 1;
  		}
  		res = res * base + val;
1dff46d69   Alexey Dobriyan   lib/kstrtox: comm...
77
  		rv++;
33ee3b2e2   Alexey Dobriyan   kstrto*: converti...
78
79
  		s++;
  	}
690d137f4   David Howells   Reduce the number...
80
  	*p = res;
1dff46d69   Alexey Dobriyan   lib/kstrtox: comm...
81
82
83
84
85
86
87
88
89
90
91
92
93
94
  	if (overflow)
  		rv |= KSTRTOX_OVERFLOW;
  	return rv;
  }
  
  static int _kstrtoull(const char *s, unsigned int base, unsigned long long *res)
  {
  	unsigned long long _res;
  	unsigned int rv;
  
  	s = _parse_integer_fixup_radix(s, &base);
  	rv = _parse_integer(s, base, &_res);
  	if (rv & KSTRTOX_OVERFLOW)
  		return -ERANGE;
1dff46d69   Alexey Dobriyan   lib/kstrtox: comm...
95
96
97
98
99
100
101
  	if (rv == 0)
  		return -EINVAL;
  	s += rv;
  	if (*s == '
  ')
  		s++;
  	if (*s)
33ee3b2e2   Alexey Dobriyan   kstrto*: converti...
102
  		return -EINVAL;
1dff46d69   Alexey Dobriyan   lib/kstrtox: comm...
103
  	*res = _res;
33ee3b2e2   Alexey Dobriyan   kstrto*: converti...
104
105
  	return 0;
  }
4c925d603   Eldad Zack   kstrto*: add docu...
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
  /**
   * kstrtoull - convert a string to an unsigned long long
   * @s: The start of the string. The string must be null-terminated, and may also
   *  include a single newline before its terminating null. The first character
   *  may also be a plus sign, but not a minus sign.
   * @base: The number base to use. The maximum supported base is 16. If base is
   *  given as 0, then the base of the string is automatically detected with the
   *  conventional semantics - If it begins with 0x the number will be parsed as a
   *  hexadecimal (case insensitive), if it otherwise begins with 0, it will be
   *  parsed as an octal number. Otherwise it will be parsed as a decimal.
   * @res: Where to write the result of the conversion on success.
   *
   * Returns 0 on success, -ERANGE on overflow and -EINVAL on parsing error.
   * Used as a replacement for the obsolete simple_strtoull. Return code must
   * be checked.
   */
33ee3b2e2   Alexey Dobriyan   kstrto*: converti...
122
123
124
125
126
127
128
  int kstrtoull(const char *s, unsigned int base, unsigned long long *res)
  {
  	if (s[0] == '+')
  		s++;
  	return _kstrtoull(s, base, res);
  }
  EXPORT_SYMBOL(kstrtoull);
4c925d603   Eldad Zack   kstrto*: add docu...
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
  /**
   * kstrtoll - convert a string to a long long
   * @s: The start of the string. The string must be null-terminated, and may also
   *  include a single newline before its terminating null. The first character
   *  may also be a plus sign or a minus sign.
   * @base: The number base to use. The maximum supported base is 16. If base is
   *  given as 0, then the base of the string is automatically detected with the
   *  conventional semantics - If it begins with 0x the number will be parsed as a
   *  hexadecimal (case insensitive), if it otherwise begins with 0, it will be
   *  parsed as an octal number. Otherwise it will be parsed as a decimal.
   * @res: Where to write the result of the conversion on success.
   *
   * Returns 0 on success, -ERANGE on overflow and -EINVAL on parsing error.
   * Used as a replacement for the obsolete simple_strtoull. Return code must
   * be checked.
   */
33ee3b2e2   Alexey Dobriyan   kstrto*: converti...
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
  int kstrtoll(const char *s, unsigned int base, long long *res)
  {
  	unsigned long long tmp;
  	int rv;
  
  	if (s[0] == '-') {
  		rv = _kstrtoull(s + 1, base, &tmp);
  		if (rv < 0)
  			return rv;
  		if ((long long)(-tmp) >= 0)
  			return -ERANGE;
  		*res = -tmp;
  	} else {
  		rv = kstrtoull(s, base, &tmp);
  		if (rv < 0)
  			return rv;
  		if ((long long)tmp < 0)
  			return -ERANGE;
  		*res = tmp;
  	}
  	return 0;
  }
  EXPORT_SYMBOL(kstrtoll);
  
  /* Internal, do not use. */
  int _kstrtoul(const char *s, unsigned int base, unsigned long *res)
  {
  	unsigned long long tmp;
  	int rv;
  
  	rv = kstrtoull(s, base, &tmp);
  	if (rv < 0)
  		return rv;
  	if (tmp != (unsigned long long)(unsigned long)tmp)
  		return -ERANGE;
  	*res = tmp;
  	return 0;
  }
  EXPORT_SYMBOL(_kstrtoul);
  
  /* Internal, do not use. */
  int _kstrtol(const char *s, unsigned int base, long *res)
  {
  	long long tmp;
  	int rv;
  
  	rv = kstrtoll(s, base, &tmp);
  	if (rv < 0)
  		return rv;
  	if (tmp != (long long)(long)tmp)
  		return -ERANGE;
  	*res = tmp;
  	return 0;
  }
  EXPORT_SYMBOL(_kstrtol);
4c925d603   Eldad Zack   kstrto*: add docu...
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
  /**
   * kstrtouint - convert a string to an unsigned int
   * @s: The start of the string. The string must be null-terminated, and may also
   *  include a single newline before its terminating null. The first character
   *  may also be a plus sign, but not a minus sign.
   * @base: The number base to use. The maximum supported base is 16. If base is
   *  given as 0, then the base of the string is automatically detected with the
   *  conventional semantics - If it begins with 0x the number will be parsed as a
   *  hexadecimal (case insensitive), if it otherwise begins with 0, it will be
   *  parsed as an octal number. Otherwise it will be parsed as a decimal.
   * @res: Where to write the result of the conversion on success.
   *
   * Returns 0 on success, -ERANGE on overflow and -EINVAL on parsing error.
   * Used as a replacement for the obsolete simple_strtoull. Return code must
   * be checked.
   */
33ee3b2e2   Alexey Dobriyan   kstrto*: converti...
216
217
218
219
220
221
222
223
224
225
226
227
228
229
  int kstrtouint(const char *s, unsigned int base, unsigned int *res)
  {
  	unsigned long long tmp;
  	int rv;
  
  	rv = kstrtoull(s, base, &tmp);
  	if (rv < 0)
  		return rv;
  	if (tmp != (unsigned long long)(unsigned int)tmp)
  		return -ERANGE;
  	*res = tmp;
  	return 0;
  }
  EXPORT_SYMBOL(kstrtouint);
4c925d603   Eldad Zack   kstrto*: add docu...
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
  /**
   * kstrtoint - convert a string to an int
   * @s: The start of the string. The string must be null-terminated, and may also
   *  include a single newline before its terminating null. The first character
   *  may also be a plus sign or a minus sign.
   * @base: The number base to use. The maximum supported base is 16. If base is
   *  given as 0, then the base of the string is automatically detected with the
   *  conventional semantics - If it begins with 0x the number will be parsed as a
   *  hexadecimal (case insensitive), if it otherwise begins with 0, it will be
   *  parsed as an octal number. Otherwise it will be parsed as a decimal.
   * @res: Where to write the result of the conversion on success.
   *
   * Returns 0 on success, -ERANGE on overflow and -EINVAL on parsing error.
   * Used as a replacement for the obsolete simple_strtoull. Return code must
   * be checked.
   */
33ee3b2e2   Alexey Dobriyan   kstrto*: converti...
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
  int kstrtoint(const char *s, unsigned int base, int *res)
  {
  	long long tmp;
  	int rv;
  
  	rv = kstrtoll(s, base, &tmp);
  	if (rv < 0)
  		return rv;
  	if (tmp != (long long)(int)tmp)
  		return -ERANGE;
  	*res = tmp;
  	return 0;
  }
  EXPORT_SYMBOL(kstrtoint);
  
  int kstrtou16(const char *s, unsigned int base, u16 *res)
  {
  	unsigned long long tmp;
  	int rv;
  
  	rv = kstrtoull(s, base, &tmp);
  	if (rv < 0)
  		return rv;
  	if (tmp != (unsigned long long)(u16)tmp)
  		return -ERANGE;
  	*res = tmp;
  	return 0;
  }
  EXPORT_SYMBOL(kstrtou16);
  
  int kstrtos16(const char *s, unsigned int base, s16 *res)
  {
  	long long tmp;
  	int rv;
  
  	rv = kstrtoll(s, base, &tmp);
  	if (rv < 0)
  		return rv;
  	if (tmp != (long long)(s16)tmp)
  		return -ERANGE;
  	*res = tmp;
  	return 0;
  }
  EXPORT_SYMBOL(kstrtos16);
  
  int kstrtou8(const char *s, unsigned int base, u8 *res)
  {
  	unsigned long long tmp;
  	int rv;
  
  	rv = kstrtoull(s, base, &tmp);
  	if (rv < 0)
  		return rv;
  	if (tmp != (unsigned long long)(u8)tmp)
  		return -ERANGE;
  	*res = tmp;
  	return 0;
  }
  EXPORT_SYMBOL(kstrtou8);
  
  int kstrtos8(const char *s, unsigned int base, s8 *res)
  {
  	long long tmp;
  	int rv;
  
  	rv = kstrtoll(s, base, &tmp);
  	if (rv < 0)
  		return rv;
  	if (tmp != (long long)(s8)tmp)
  		return -ERANGE;
  	*res = tmp;
  	return 0;
  }
  EXPORT_SYMBOL(kstrtos8);
c196e32a1   Alexey Dobriyan   lib: add kstrto*_...
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
  
  #define kstrto_from_user(f, g, type)					\
  int f(const char __user *s, size_t count, unsigned int base, type *res)	\
  {									\
  	/* sign, base 2 representation, newline, terminator */		\
  	char buf[1 + sizeof(type) * 8 + 1 + 1];				\
  									\
  	count = min(count, sizeof(buf) - 1);				\
  	if (copy_from_user(buf, s, count))				\
  		return -EFAULT;						\
  	buf[count] = '\0';						\
  	return g(buf, base, res);					\
  }									\
  EXPORT_SYMBOL(f)
  
  kstrto_from_user(kstrtoull_from_user,	kstrtoull,	unsigned long long);
  kstrto_from_user(kstrtoll_from_user,	kstrtoll,	long long);
  kstrto_from_user(kstrtoul_from_user,	kstrtoul,	unsigned long);
  kstrto_from_user(kstrtol_from_user,	kstrtol,	long);
  kstrto_from_user(kstrtouint_from_user,	kstrtouint,	unsigned int);
  kstrto_from_user(kstrtoint_from_user,	kstrtoint,	int);
  kstrto_from_user(kstrtou16_from_user,	kstrtou16,	u16);
  kstrto_from_user(kstrtos16_from_user,	kstrtos16,	s16);
  kstrto_from_user(kstrtou8_from_user,	kstrtou8,	u8);
  kstrto_from_user(kstrtos8_from_user,	kstrtos8,	s8);