2 * Convert integer string representation to an integer.
3 * If an integer doesn't fit into specified type, -E is returned.
5 * Integer starts with optional sign.
6 * kstrtou*() functions do not accept sign "-".
8 * Radix 0 means autodetection: leading "0x" implies radix 16,
9 * leading "0" implies radix 8, otherwise radix is 10.
10 * Autodetection hints work after optional sign, but not before.
12 * If -E is returned, result is not touched.
14 #include <linux/ctype.h>
15 #include <linux/errno.h>
16 #include <linux/kernel.h>
17 #include <linux/math64.h>
18 #include <linux/export.h>
19 #include <linux/types.h>
22 const char *_parse_integer_fixup_radix(const char *s, unsigned int *base)
26 if (_tolower(s[1]) == 'x' && isxdigit(s[2]))
33 if (*base == 16 && s[0] == '0' && _tolower(s[1]) == 'x')
39 * Convert non-negative integer string representation in explicitly given radix
41 * Return number of characters consumed maybe or-ed with overflow bit.
42 * If overflow occurs, result integer (incorrect) is still returned.
44 * Don't you dare use this function.
46 unsigned int _parse_integer(const char *s, unsigned int base, unsigned long long *p)
48 unsigned long long res;
58 if ('0' <= *s && *s <= '9')
60 else if ('a' <= _tolower(*s) && _tolower(*s) <= 'f')
61 val = _tolower(*s) - 'a' + 10;
68 * Check for overflow only if we are within range of
69 * it in the max base we support (16)
71 if (unlikely(res & (~0ull << 60))) {
72 if (res > div_u64(ULLONG_MAX - val, base))
75 res = res * base + val;
81 rv |= KSTRTOX_OVERFLOW;
85 static int _kstrtoull(const char *s, unsigned int base, unsigned long long *res)
87 unsigned long long _res;
90 s = _parse_integer_fixup_radix(s, &base);
91 rv = _parse_integer(s, base, &_res);
92 if (rv & KSTRTOX_OVERFLOW)
106 * kstrtoull - convert a string to an unsigned long long
107 * @s: The start of the string. The string must be null-terminated, and may also
108 * include a single newline before its terminating null. The first character
109 * may also be a plus sign, but not a minus sign.
110 * @base: The number base to use. The maximum supported base is 16. If base is
111 * given as 0, then the base of the string is automatically detected with the
112 * conventional semantics - If it begins with 0x the number will be parsed as a
113 * hexadecimal (case insensitive), if it otherwise begins with 0, it will be
114 * parsed as an octal number. Otherwise it will be parsed as a decimal.
115 * @res: Where to write the result of the conversion on success.
117 * Returns 0 on success, -ERANGE on overflow and -EINVAL on parsing error.
118 * Used as a replacement for the obsolete simple_strtoull. Return code must
121 int kstrtoull(const char *s, unsigned int base, unsigned long long *res)
125 return _kstrtoull(s, base, res);
127 EXPORT_SYMBOL(kstrtoull);
130 * kstrtoll - convert a string to a long long
131 * @s: The start of the string. The string must be null-terminated, and may also
132 * include a single newline before its terminating null. The first character
133 * may also be a plus sign or a minus sign.
134 * @base: The number base to use. The maximum supported base is 16. If base is
135 * given as 0, then the base of the string is automatically detected with the
136 * conventional semantics - If it begins with 0x the number will be parsed as a
137 * hexadecimal (case insensitive), if it otherwise begins with 0, it will be
138 * parsed as an octal number. Otherwise it will be parsed as a decimal.
139 * @res: Where to write the result of the conversion on success.
141 * Returns 0 on success, -ERANGE on overflow and -EINVAL on parsing error.
142 * Used as a replacement for the obsolete simple_strtoull. Return code must
145 int kstrtoll(const char *s, unsigned int base, long long *res)
147 unsigned long long tmp;
151 rv = _kstrtoull(s + 1, base, &tmp);
154 if ((long long)-tmp > 0)
158 rv = kstrtoull(s, base, &tmp);
161 if ((long long)tmp < 0)
167 EXPORT_SYMBOL(kstrtoll);
169 /* Internal, do not use. */
170 int _kstrtoul(const char *s, unsigned int base, unsigned long *res)
172 unsigned long long tmp;
175 rv = kstrtoull(s, base, &tmp);
178 if (tmp != (unsigned long long)(unsigned long)tmp)
183 EXPORT_SYMBOL(_kstrtoul);
185 /* Internal, do not use. */
186 int _kstrtol(const char *s, unsigned int base, long *res)
191 rv = kstrtoll(s, base, &tmp);
194 if (tmp != (long long)(long)tmp)
199 EXPORT_SYMBOL(_kstrtol);
202 * kstrtouint - convert a string to an unsigned int
203 * @s: The start of the string. The string must be null-terminated, and may also
204 * include a single newline before its terminating null. The first character
205 * may also be a plus sign, but not a minus sign.
206 * @base: The number base to use. The maximum supported base is 16. If base is
207 * given as 0, then the base of the string is automatically detected with the
208 * conventional semantics - If it begins with 0x the number will be parsed as a
209 * hexadecimal (case insensitive), if it otherwise begins with 0, it will be
210 * parsed as an octal number. Otherwise it will be parsed as a decimal.
211 * @res: Where to write the result of the conversion on success.
213 * Returns 0 on success, -ERANGE on overflow and -EINVAL on parsing error.
214 * Used as a replacement for the obsolete simple_strtoull. Return code must
217 int kstrtouint(const char *s, unsigned int base, unsigned int *res)
219 unsigned long long tmp;
222 rv = kstrtoull(s, base, &tmp);
225 if (tmp != (unsigned long long)(unsigned int)tmp)
230 EXPORT_SYMBOL(kstrtouint);
233 * kstrtoint - convert a string to an int
234 * @s: The start of the string. The string must be null-terminated, and may also
235 * include a single newline before its terminating null. The first character
236 * may also be a plus sign or a minus sign.
237 * @base: The number base to use. The maximum supported base is 16. If base is
238 * given as 0, then the base of the string is automatically detected with the
239 * conventional semantics - If it begins with 0x the number will be parsed as a
240 * hexadecimal (case insensitive), if it otherwise begins with 0, it will be
241 * parsed as an octal number. Otherwise it will be parsed as a decimal.
242 * @res: Where to write the result of the conversion on success.
244 * Returns 0 on success, -ERANGE on overflow and -EINVAL on parsing error.
245 * Used as a replacement for the obsolete simple_strtoull. Return code must
248 int kstrtoint(const char *s, unsigned int base, int *res)
253 rv = kstrtoll(s, base, &tmp);
256 if (tmp != (long long)(int)tmp)
261 EXPORT_SYMBOL(kstrtoint);
263 int kstrtou16(const char *s, unsigned int base, u16 *res)
265 unsigned long long tmp;
268 rv = kstrtoull(s, base, &tmp);
271 if (tmp != (unsigned long long)(u16)tmp)
276 EXPORT_SYMBOL(kstrtou16);
278 int kstrtos16(const char *s, unsigned int base, s16 *res)
283 rv = kstrtoll(s, base, &tmp);
286 if (tmp != (long long)(s16)tmp)
291 EXPORT_SYMBOL(kstrtos16);
293 int kstrtou8(const char *s, unsigned int base, u8 *res)
295 unsigned long long tmp;
298 rv = kstrtoull(s, base, &tmp);
301 if (tmp != (unsigned long long)(u8)tmp)
306 EXPORT_SYMBOL(kstrtou8);
308 int kstrtos8(const char *s, unsigned int base, s8 *res)
313 rv = kstrtoll(s, base, &tmp);
316 if (tmp != (long long)(s8)tmp)
321 EXPORT_SYMBOL(kstrtos8);
324 * kstrtobool - convert common user inputs into boolean values
328 * This routine returns 0 iff the first character is one of 'Yy1Nn0', or
329 * [oO][NnFf] for "on" and "off". Otherwise it will return -EINVAL. Value
330 * pointed to by res is updated upon finding a match.
332 int kstrtobool(const char *s, bool *res)
368 EXPORT_SYMBOL(kstrtobool);