xref: /freebsd/lib/libc/stdlib/strtol.c (revision d9dc1603d6e48cca84cad3ebe859129131b8387c)
158f0484fSRodney W. Grimes /*-
28a16b7a1SPedro F. Giffuni  * SPDX-License-Identifier: BSD-3-Clause
38a16b7a1SPedro F. Giffuni  *
458f0484fSRodney W. Grimes  * Copyright (c) 1990, 1993
558f0484fSRodney W. Grimes  *	The Regents of the University of California.  All rights reserved.
658f0484fSRodney W. Grimes  *
73c87aa1dSDavid Chisnall  * Copyright (c) 2011 The FreeBSD Foundation
85b5fa75aSEd Maste  *
93c87aa1dSDavid Chisnall  * Portions of this software were developed by David Chisnall
103c87aa1dSDavid Chisnall  * under sponsorship from the FreeBSD Foundation.
113c87aa1dSDavid Chisnall  *
1258f0484fSRodney W. Grimes  * Redistribution and use in source and binary forms, with or without
1358f0484fSRodney W. Grimes  * modification, are permitted provided that the following conditions
1458f0484fSRodney W. Grimes  * are met:
1558f0484fSRodney W. Grimes  * 1. Redistributions of source code must retain the above copyright
1658f0484fSRodney W. Grimes  *    notice, this list of conditions and the following disclaimer.
1758f0484fSRodney W. Grimes  * 2. Redistributions in binary form must reproduce the above copyright
1858f0484fSRodney W. Grimes  *    notice, this list of conditions and the following disclaimer in the
1958f0484fSRodney W. Grimes  *    documentation and/or other materials provided with the distribution.
20580b4d18SEd Maste  * 3. Neither the name of the University nor the names of its contributors
2158f0484fSRodney W. Grimes  *    may be used to endorse or promote products derived from this software
2258f0484fSRodney W. Grimes  *    without specific prior written permission.
2358f0484fSRodney W. Grimes  *
2458f0484fSRodney W. Grimes  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
2558f0484fSRodney W. Grimes  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
2658f0484fSRodney W. Grimes  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
2758f0484fSRodney W. Grimes  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
2858f0484fSRodney W. Grimes  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
2958f0484fSRodney W. Grimes  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
3058f0484fSRodney W. Grimes  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
3158f0484fSRodney W. Grimes  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
3258f0484fSRodney W. Grimes  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
3358f0484fSRodney W. Grimes  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
3458f0484fSRodney W. Grimes  * SUCH DAMAGE.
3558f0484fSRodney W. Grimes  */
3658f0484fSRodney W. Grimes 
3758f0484fSRodney W. Grimes #if defined(LIBC_SCCS) && !defined(lint)
3858f0484fSRodney W. Grimes static char sccsid[] = "@(#)strtol.c	8.1 (Berkeley) 6/4/93";
3958f0484fSRodney W. Grimes #endif /* LIBC_SCCS and not lint */
40333fc21eSDavid E. O'Brien #include <sys/cdefs.h>
4158f0484fSRodney W. Grimes #include <limits.h>
4258f0484fSRodney W. Grimes #include <ctype.h>
4358f0484fSRodney W. Grimes #include <errno.h>
4458f0484fSRodney W. Grimes #include <stdlib.h>
453c87aa1dSDavid Chisnall #include "xlocale_private.h"
4658f0484fSRodney W. Grimes 
4758f0484fSRodney W. Grimes /*
4858f0484fSRodney W. Grimes  * Convert a string to a long integer.
4958f0484fSRodney W. Grimes  *
504e6b1570SAndrey A. Chernov  * Assumes that the upper and lower case
5158f0484fSRodney W. Grimes  * alphabets and digits are each contiguous.
5258f0484fSRodney W. Grimes  */
5358f0484fSRodney W. Grimes long
543c87aa1dSDavid Chisnall strtol_l(const char * __restrict nptr, char ** __restrict endptr, int base,
553c87aa1dSDavid Chisnall 		locale_t locale)
5658f0484fSRodney W. Grimes {
577e302fc7SAndrey A. Chernov 	const char *s;
587e302fc7SAndrey A. Chernov 	unsigned long acc;
59f34b139cSAndrey A. Chernov 	char c;
607e302fc7SAndrey A. Chernov 	unsigned long cutoff;
61f34b139cSAndrey A. Chernov 	int neg, any, cutlim;
623c87aa1dSDavid Chisnall 	FIX_LOCALE(locale);
6358f0484fSRodney W. Grimes 
6458f0484fSRodney W. Grimes 	/*
6558f0484fSRodney W. Grimes 	 * Skip white space and pick up leading +/- sign if any.
6658f0484fSRodney W. Grimes 	 * If base is 0, allow 0x for hex and 0 for octal, else
6758f0484fSRodney W. Grimes 	 * assume decimal; if base is already 16, allow 0x.
6858f0484fSRodney W. Grimes 	 */
694e6b1570SAndrey A. Chernov 	s = nptr;
7058f0484fSRodney W. Grimes 	do {
7158f0484fSRodney W. Grimes 		c = *s++;
723c87aa1dSDavid Chisnall 	} while (isspace_l((unsigned char)c, locale));
7358f0484fSRodney W. Grimes 	if (c == '-') {
7458f0484fSRodney W. Grimes 		neg = 1;
7558f0484fSRodney W. Grimes 		c = *s++;
764e6b1570SAndrey A. Chernov 	} else {
774e6b1570SAndrey A. Chernov 		neg = 0;
784e6b1570SAndrey A. Chernov 		if (c == '+')
7958f0484fSRodney W. Grimes 			c = *s++;
804e6b1570SAndrey A. Chernov 	}
8158f0484fSRodney W. Grimes 	if ((base == 0 || base == 16) &&
822571c7f7SAndrey A. Chernov 	    c == '0' && (*s == 'x' || *s == 'X') &&
83db0e25eeSAndrey A. Chernov 	    ((s[1] >= '0' && s[1] <= '9') ||
842571c7f7SAndrey A. Chernov 	    (s[1] >= 'A' && s[1] <= 'F') ||
85db0e25eeSAndrey A. Chernov 	    (s[1] >= 'a' && s[1] <= 'f'))) {
8658f0484fSRodney W. Grimes 		c = s[1];
8758f0484fSRodney W. Grimes 		s += 2;
8858f0484fSRodney W. Grimes 		base = 16;
8958f0484fSRodney W. Grimes 	}
90*d9dc1603SDag-Erling Smørgrav 	if ((base == 0 || base == 2) &&
91*d9dc1603SDag-Erling Smørgrav 	    c == '0' && (*s == 'b' || *s == 'B') &&
92*d9dc1603SDag-Erling Smørgrav 	    (s[1] >= '0' && s[1] <= '1')) {
93*d9dc1603SDag-Erling Smørgrav 		c = s[1];
94*d9dc1603SDag-Erling Smørgrav 		s += 2;
95*d9dc1603SDag-Erling Smørgrav 		base = 2;
96*d9dc1603SDag-Erling Smørgrav 	}
9758f0484fSRodney W. Grimes 	if (base == 0)
9858f0484fSRodney W. Grimes 		base = c == '0' ? 8 : 10;
99f4fc08f3SAndrey A. Chernov 	acc = any = 0;
100b9004c11SBill Fenner 	if (base < 2 || base > 36)
1014e6b1570SAndrey A. Chernov 		goto noconv;
10258f0484fSRodney W. Grimes 
10358f0484fSRodney W. Grimes 	/*
10458f0484fSRodney W. Grimes 	 * Compute the cutoff value between legal numbers and illegal
10558f0484fSRodney W. Grimes 	 * numbers.  That is the largest legal value, divided by the
10658f0484fSRodney W. Grimes 	 * base.  An input number that is greater than this value, if
10758f0484fSRodney W. Grimes 	 * followed by a legal input character, is too big.  One that
10858f0484fSRodney W. Grimes 	 * is equal to this value may be valid or not; the limit
10958f0484fSRodney W. Grimes 	 * between valid and invalid numbers is then based on the last
11058f0484fSRodney W. Grimes 	 * digit.  For instance, if the range for longs is
11158f0484fSRodney W. Grimes 	 * [-2147483648..2147483647] and the input base is 10,
11258f0484fSRodney W. Grimes 	 * cutoff will be set to 214748364 and cutlim to either
11358f0484fSRodney W. Grimes 	 * 7 (neg==0) or 8 (neg==1), meaning that if we have accumulated
11458f0484fSRodney W. Grimes 	 * a value > 214748364, or equal but the next digit is > 7 (or 8),
11558f0484fSRodney W. Grimes 	 * the number is too big, and we will return a range error.
11658f0484fSRodney W. Grimes 	 *
1174e6b1570SAndrey A. Chernov 	 * Set 'any' if any `digits' consumed; make it negative to indicate
11858f0484fSRodney W. Grimes 	 * overflow.
11958f0484fSRodney W. Grimes 	 */
1207e302fc7SAndrey A. Chernov 	cutoff = neg ? (unsigned long)-(LONG_MIN + LONG_MAX) + LONG_MAX
1214e6b1570SAndrey A. Chernov 	    : LONG_MAX;
1224e6b1570SAndrey A. Chernov 	cutlim = cutoff % base;
1234e6b1570SAndrey A. Chernov 	cutoff /= base;
124f4fc08f3SAndrey A. Chernov 	for ( ; ; c = *s++) {
125f34b139cSAndrey A. Chernov 		if (c >= '0' && c <= '9')
126f34b139cSAndrey A. Chernov 			c -= '0';
127f34b139cSAndrey A. Chernov 		else if (c >= 'A' && c <= 'Z')
128f34b139cSAndrey A. Chernov 			c -= 'A' - 10;
129f34b139cSAndrey A. Chernov 		else if (c >= 'a' && c <= 'z')
130f34b139cSAndrey A. Chernov 			c -= 'a' - 10;
13158f0484fSRodney W. Grimes 		else
13258f0484fSRodney W. Grimes 			break;
133f34b139cSAndrey A. Chernov 		if (c >= base)
13458f0484fSRodney W. Grimes 			break;
135f34b139cSAndrey A. Chernov 		if (any < 0 || acc > cutoff || (acc == cutoff && c > cutlim))
13658f0484fSRodney W. Grimes 			any = -1;
13758f0484fSRodney W. Grimes 		else {
13858f0484fSRodney W. Grimes 			any = 1;
13958f0484fSRodney W. Grimes 			acc *= base;
140f34b139cSAndrey A. Chernov 			acc += c;
14158f0484fSRodney W. Grimes 		}
14258f0484fSRodney W. Grimes 	}
14358f0484fSRodney W. Grimes 	if (any < 0) {
14458f0484fSRodney W. Grimes 		acc = neg ? LONG_MIN : LONG_MAX;
14558f0484fSRodney W. Grimes 		errno = ERANGE;
1464e6b1570SAndrey A. Chernov 	} else if (!any) {
1474e6b1570SAndrey A. Chernov noconv:
1484e6b1570SAndrey A. Chernov 		errno = EINVAL;
14958f0484fSRodney W. Grimes 	} else if (neg)
15058f0484fSRodney W. Grimes 		acc = -acc;
1514e6b1570SAndrey A. Chernov 	if (endptr != NULL)
15258f0484fSRodney W. Grimes 		*endptr = (char *)(any ? s - 1 : nptr);
15358f0484fSRodney W. Grimes 	return (acc);
15458f0484fSRodney W. Grimes }
1553c87aa1dSDavid Chisnall long
1563c87aa1dSDavid Chisnall strtol(const char * __restrict nptr, char ** __restrict endptr, int base)
1573c87aa1dSDavid Chisnall {
1583c87aa1dSDavid Chisnall 	return strtol_l(nptr, endptr, base, __get_locale());
1593c87aa1dSDavid Chisnall }
160