xref: /openbmc/linux/lib/vsprintf.c (revision 9b706aee7d92d6ac3002547aea12e3eaa0a750ae)
11da177e4SLinus Torvalds /*
21da177e4SLinus Torvalds  *  linux/lib/vsprintf.c
31da177e4SLinus Torvalds  *
41da177e4SLinus Torvalds  *  Copyright (C) 1991, 1992  Linus Torvalds
51da177e4SLinus Torvalds  */
61da177e4SLinus Torvalds 
71da177e4SLinus Torvalds /* vsprintf.c -- Lars Wirzenius & Linus Torvalds. */
81da177e4SLinus Torvalds /*
91da177e4SLinus Torvalds  * Wirzenius wrote this portably, Torvalds fucked it up :-)
101da177e4SLinus Torvalds  */
111da177e4SLinus Torvalds 
121da177e4SLinus Torvalds /*
131da177e4SLinus Torvalds  * Fri Jul 13 2001 Crutcher Dunnavant <crutcher+kernel@datastacks.com>
141da177e4SLinus Torvalds  * - changed to provide snprintf and vsnprintf functions
151da177e4SLinus Torvalds  * So Feb  1 16:51:32 CET 2004 Juergen Quade <quade@hsnr.de>
161da177e4SLinus Torvalds  * - scnprintf and vscnprintf
171da177e4SLinus Torvalds  */
181da177e4SLinus Torvalds 
191da177e4SLinus Torvalds #include <stdarg.h>
201da177e4SLinus Torvalds #include <linux/module.h>
211da177e4SLinus Torvalds #include <linux/types.h>
221da177e4SLinus Torvalds #include <linux/string.h>
231da177e4SLinus Torvalds #include <linux/ctype.h>
241da177e4SLinus Torvalds #include <linux/kernel.h>
251da177e4SLinus Torvalds 
264e57b681STim Schmielau #include <asm/page.h>		/* for PAGE_SIZE */
271da177e4SLinus Torvalds #include <asm/div64.h>
281da177e4SLinus Torvalds 
29*9b706aeeSDenys Vlasenko /* Works only for digits and letters, but small and fast */
30*9b706aeeSDenys Vlasenko #define TOLOWER(x) ((x) | 0x20)
31*9b706aeeSDenys Vlasenko 
321da177e4SLinus Torvalds /**
331da177e4SLinus Torvalds  * simple_strtoul - convert a string to an unsigned long
341da177e4SLinus Torvalds  * @cp: The start of the string
351da177e4SLinus Torvalds  * @endp: A pointer to the end of the parsed string will be placed here
361da177e4SLinus Torvalds  * @base: The number base to use
371da177e4SLinus Torvalds  */
381da177e4SLinus Torvalds unsigned long simple_strtoul(const char *cp,char **endp,unsigned int base)
391da177e4SLinus Torvalds {
401da177e4SLinus Torvalds 	unsigned long result = 0,value;
411da177e4SLinus Torvalds 
421da177e4SLinus Torvalds 	if (!base) {
431da177e4SLinus Torvalds 		base = 10;
441da177e4SLinus Torvalds 		if (*cp == '0') {
451da177e4SLinus Torvalds 			base = 8;
461da177e4SLinus Torvalds 			cp++;
47*9b706aeeSDenys Vlasenko 			if ((TOLOWER(*cp) == 'x') && isxdigit(cp[1])) {
481da177e4SLinus Torvalds 				cp++;
491da177e4SLinus Torvalds 				base = 16;
501da177e4SLinus Torvalds 			}
511da177e4SLinus Torvalds 		}
521da177e4SLinus Torvalds 	} else if (base == 16) {
53*9b706aeeSDenys Vlasenko 		if (cp[0] == '0' && TOLOWER(cp[1]) == 'x')
541da177e4SLinus Torvalds 			cp += 2;
551da177e4SLinus Torvalds 	}
561da177e4SLinus Torvalds 	while (isxdigit(*cp) &&
57*9b706aeeSDenys Vlasenko 	       (value = isdigit(*cp) ? *cp-'0' : TOLOWER(*cp)-'a'+10) < base) {
581da177e4SLinus Torvalds 		result = result*base + value;
591da177e4SLinus Torvalds 		cp++;
601da177e4SLinus Torvalds 	}
611da177e4SLinus Torvalds 	if (endp)
621da177e4SLinus Torvalds 		*endp = (char *)cp;
631da177e4SLinus Torvalds 	return result;
641da177e4SLinus Torvalds }
651da177e4SLinus Torvalds 
661da177e4SLinus Torvalds EXPORT_SYMBOL(simple_strtoul);
671da177e4SLinus Torvalds 
681da177e4SLinus Torvalds /**
691da177e4SLinus Torvalds  * simple_strtol - convert a string to a signed long
701da177e4SLinus Torvalds  * @cp: The start of the string
711da177e4SLinus Torvalds  * @endp: A pointer to the end of the parsed string will be placed here
721da177e4SLinus Torvalds  * @base: The number base to use
731da177e4SLinus Torvalds  */
741da177e4SLinus Torvalds long simple_strtol(const char *cp,char **endp,unsigned int base)
751da177e4SLinus Torvalds {
761da177e4SLinus Torvalds 	if(*cp=='-')
771da177e4SLinus Torvalds 		return -simple_strtoul(cp+1,endp,base);
781da177e4SLinus Torvalds 	return simple_strtoul(cp,endp,base);
791da177e4SLinus Torvalds }
801da177e4SLinus Torvalds 
811da177e4SLinus Torvalds EXPORT_SYMBOL(simple_strtol);
821da177e4SLinus Torvalds 
831da177e4SLinus Torvalds /**
841da177e4SLinus Torvalds  * simple_strtoull - convert a string to an unsigned long long
851da177e4SLinus Torvalds  * @cp: The start of the string
861da177e4SLinus Torvalds  * @endp: A pointer to the end of the parsed string will be placed here
871da177e4SLinus Torvalds  * @base: The number base to use
881da177e4SLinus Torvalds  */
891da177e4SLinus Torvalds unsigned long long simple_strtoull(const char *cp,char **endp,unsigned int base)
901da177e4SLinus Torvalds {
911da177e4SLinus Torvalds 	unsigned long long result = 0,value;
921da177e4SLinus Torvalds 
931da177e4SLinus Torvalds 	if (!base) {
941da177e4SLinus Torvalds 		base = 10;
951da177e4SLinus Torvalds 		if (*cp == '0') {
961da177e4SLinus Torvalds 			base = 8;
971da177e4SLinus Torvalds 			cp++;
98*9b706aeeSDenys Vlasenko 			if ((TOLOWER(*cp) == 'x') && isxdigit(cp[1])) {
991da177e4SLinus Torvalds 				cp++;
1001da177e4SLinus Torvalds 				base = 16;
1011da177e4SLinus Torvalds 			}
1021da177e4SLinus Torvalds 		}
1031da177e4SLinus Torvalds 	} else if (base == 16) {
104*9b706aeeSDenys Vlasenko 		if (cp[0] == '0' && TOLOWER(cp[1]) == 'x')
1051da177e4SLinus Torvalds 			cp += 2;
1061da177e4SLinus Torvalds 	}
107*9b706aeeSDenys Vlasenko 	while (isxdigit(*cp)
108*9b706aeeSDenys Vlasenko 	 && (value = isdigit(*cp) ? *cp-'0' : TOLOWER(*cp)-'a'+10) < base) {
1091da177e4SLinus Torvalds 		result = result*base + value;
1101da177e4SLinus Torvalds 		cp++;
1111da177e4SLinus Torvalds 	}
1121da177e4SLinus Torvalds 	if (endp)
1131da177e4SLinus Torvalds 		*endp = (char *)cp;
1141da177e4SLinus Torvalds 	return result;
1151da177e4SLinus Torvalds }
1161da177e4SLinus Torvalds 
1171da177e4SLinus Torvalds EXPORT_SYMBOL(simple_strtoull);
1181da177e4SLinus Torvalds 
1191da177e4SLinus Torvalds /**
1201da177e4SLinus Torvalds  * simple_strtoll - convert a string to a signed long long
1211da177e4SLinus Torvalds  * @cp: The start of the string
1221da177e4SLinus Torvalds  * @endp: A pointer to the end of the parsed string will be placed here
1231da177e4SLinus Torvalds  * @base: The number base to use
1241da177e4SLinus Torvalds  */
1251da177e4SLinus Torvalds long long simple_strtoll(const char *cp,char **endp,unsigned int base)
1261da177e4SLinus Torvalds {
1271da177e4SLinus Torvalds 	if(*cp=='-')
1281da177e4SLinus Torvalds 		return -simple_strtoull(cp+1,endp,base);
1291da177e4SLinus Torvalds 	return simple_strtoull(cp,endp,base);
1301da177e4SLinus Torvalds }
1311da177e4SLinus Torvalds 
13206b2a76dSYi Yang 
13306b2a76dSYi Yang /**
13406b2a76dSYi Yang  * strict_strtoul - convert a string to an unsigned long strictly
13506b2a76dSYi Yang  * @cp: The string to be converted
13606b2a76dSYi Yang  * @base: The number base to use
13706b2a76dSYi Yang  * @res: The converted result value
13806b2a76dSYi Yang  *
13906b2a76dSYi Yang  * strict_strtoul converts a string to an unsigned long only if the
14006b2a76dSYi Yang  * string is really an unsigned long string, any string containing
14106b2a76dSYi Yang  * any invalid char at the tail will be rejected and -EINVAL is returned,
14206b2a76dSYi Yang  * only a newline char at the tail is acceptible because people generally
14306b2a76dSYi Yang  * change a module parameter in the following way:
14406b2a76dSYi Yang  *
14506b2a76dSYi Yang  * 	echo 1024 > /sys/module/e1000/parameters/copybreak
14606b2a76dSYi Yang  *
14706b2a76dSYi Yang  * echo will append a newline to the tail.
14806b2a76dSYi Yang  *
14906b2a76dSYi Yang  * It returns 0 if conversion is successful and *res is set to the converted
15006b2a76dSYi Yang  * value, otherwise it returns -EINVAL and *res is set to 0.
15106b2a76dSYi Yang  *
15206b2a76dSYi Yang  * simple_strtoul just ignores the successive invalid characters and
15306b2a76dSYi Yang  * return the converted value of prefix part of the string.
15406b2a76dSYi Yang  */
15506b2a76dSYi Yang int strict_strtoul(const char *cp, unsigned int base, unsigned long *res);
15606b2a76dSYi Yang 
15706b2a76dSYi Yang /**
15806b2a76dSYi Yang  * strict_strtol - convert a string to a long strictly
15906b2a76dSYi Yang  * @cp: The string to be converted
16006b2a76dSYi Yang  * @base: The number base to use
16106b2a76dSYi Yang  * @res: The converted result value
16206b2a76dSYi Yang  *
16306b2a76dSYi Yang  * strict_strtol is similiar to strict_strtoul, but it allows the first
16406b2a76dSYi Yang  * character of a string is '-'.
16506b2a76dSYi Yang  *
16606b2a76dSYi Yang  * It returns 0 if conversion is successful and *res is set to the converted
16706b2a76dSYi Yang  * value, otherwise it returns -EINVAL and *res is set to 0.
16806b2a76dSYi Yang  */
16906b2a76dSYi Yang int strict_strtol(const char *cp, unsigned int base, long *res);
17006b2a76dSYi Yang 
17106b2a76dSYi Yang /**
17206b2a76dSYi Yang  * strict_strtoull - convert a string to an unsigned long long strictly
17306b2a76dSYi Yang  * @cp: The string to be converted
17406b2a76dSYi Yang  * @base: The number base to use
17506b2a76dSYi Yang  * @res: The converted result value
17606b2a76dSYi Yang  *
17706b2a76dSYi Yang  * strict_strtoull converts a string to an unsigned long long only if the
17806b2a76dSYi Yang  * string is really an unsigned long long string, any string containing
17906b2a76dSYi Yang  * any invalid char at the tail will be rejected and -EINVAL is returned,
18006b2a76dSYi Yang  * only a newline char at the tail is acceptible because people generally
18106b2a76dSYi Yang  * change a module parameter in the following way:
18206b2a76dSYi Yang  *
18306b2a76dSYi Yang  * 	echo 1024 > /sys/module/e1000/parameters/copybreak
18406b2a76dSYi Yang  *
18506b2a76dSYi Yang  * echo will append a newline to the tail of the string.
18606b2a76dSYi Yang  *
18706b2a76dSYi Yang  * It returns 0 if conversion is successful and *res is set to the converted
18806b2a76dSYi Yang  * value, otherwise it returns -EINVAL and *res is set to 0.
18906b2a76dSYi Yang  *
19006b2a76dSYi Yang  * simple_strtoull just ignores the successive invalid characters and
19106b2a76dSYi Yang  * return the converted value of prefix part of the string.
19206b2a76dSYi Yang  */
19306b2a76dSYi Yang int strict_strtoull(const char *cp, unsigned int base, unsigned long long *res);
19406b2a76dSYi Yang 
19506b2a76dSYi Yang /**
19606b2a76dSYi Yang  * strict_strtoll - convert a string to a long long strictly
19706b2a76dSYi Yang  * @cp: The string to be converted
19806b2a76dSYi Yang  * @base: The number base to use
19906b2a76dSYi Yang  * @res: The converted result value
20006b2a76dSYi Yang  *
20106b2a76dSYi Yang  * strict_strtoll is similiar to strict_strtoull, but it allows the first
20206b2a76dSYi Yang  * character of a string is '-'.
20306b2a76dSYi Yang  *
20406b2a76dSYi Yang  * It returns 0 if conversion is successful and *res is set to the converted
20506b2a76dSYi Yang  * value, otherwise it returns -EINVAL and *res is set to 0.
20606b2a76dSYi Yang  */
20706b2a76dSYi Yang int strict_strtoll(const char *cp, unsigned int base, long long *res);
20806b2a76dSYi Yang 
20906b2a76dSYi Yang #define define_strict_strtoux(type, valtype)				\
21006b2a76dSYi Yang int strict_strtou##type(const char *cp, unsigned int base, valtype *res)\
21106b2a76dSYi Yang {									\
21206b2a76dSYi Yang 	char *tail;							\
21306b2a76dSYi Yang 	valtype val;							\
21406b2a76dSYi Yang 	size_t len;							\
21506b2a76dSYi Yang 									\
21606b2a76dSYi Yang 	*res = 0;							\
21706b2a76dSYi Yang 	len = strlen(cp);						\
21806b2a76dSYi Yang 	if (len == 0)							\
21906b2a76dSYi Yang 		return -EINVAL;						\
22006b2a76dSYi Yang 									\
22106b2a76dSYi Yang 	val = simple_strtoul(cp, &tail, base);				\
22206b2a76dSYi Yang 	if ((*tail == '\0') ||						\
22306b2a76dSYi Yang 		((len == (size_t)(tail - cp) + 1) && (*tail == '\n'))) {\
22406b2a76dSYi Yang 		*res = val;						\
22506b2a76dSYi Yang 		return 0;						\
22606b2a76dSYi Yang 	}								\
22706b2a76dSYi Yang 									\
22806b2a76dSYi Yang 	return -EINVAL;							\
22906b2a76dSYi Yang }									\
23006b2a76dSYi Yang 
23106b2a76dSYi Yang #define define_strict_strtox(type, valtype)				\
23206b2a76dSYi Yang int strict_strto##type(const char *cp, unsigned int base, valtype *res)	\
23306b2a76dSYi Yang {									\
23406b2a76dSYi Yang 	int ret;							\
23506b2a76dSYi Yang 	if (*cp == '-') {						\
23606b2a76dSYi Yang 		ret = strict_strtou##type(cp+1, base, res);		\
23706b2a76dSYi Yang 		if (ret != 0)						\
23806b2a76dSYi Yang 			*res = -(*res);					\
23906b2a76dSYi Yang 	} else								\
24006b2a76dSYi Yang 		ret = strict_strtou##type(cp, base, res);		\
24106b2a76dSYi Yang 									\
24206b2a76dSYi Yang 	return ret;							\
24306b2a76dSYi Yang }									\
24406b2a76dSYi Yang 
24506b2a76dSYi Yang define_strict_strtoux(l, unsigned long)
24606b2a76dSYi Yang define_strict_strtox(l, long)
24706b2a76dSYi Yang define_strict_strtoux(ll, unsigned long long)
24806b2a76dSYi Yang define_strict_strtox(ll, long long)
24906b2a76dSYi Yang 
25006b2a76dSYi Yang EXPORT_SYMBOL(strict_strtoul);
25106b2a76dSYi Yang EXPORT_SYMBOL(strict_strtol);
25206b2a76dSYi Yang EXPORT_SYMBOL(strict_strtoll);
25306b2a76dSYi Yang EXPORT_SYMBOL(strict_strtoull);
25406b2a76dSYi Yang 
2551da177e4SLinus Torvalds static int skip_atoi(const char **s)
2561da177e4SLinus Torvalds {
2571da177e4SLinus Torvalds 	int i=0;
2581da177e4SLinus Torvalds 
2591da177e4SLinus Torvalds 	while (isdigit(**s))
2601da177e4SLinus Torvalds 		i = i*10 + *((*s)++) - '0';
2611da177e4SLinus Torvalds 	return i;
2621da177e4SLinus Torvalds }
2631da177e4SLinus Torvalds 
2644277eeddSDenis Vlasenko /* Decimal conversion is by far the most typical, and is used
2654277eeddSDenis Vlasenko  * for /proc and /sys data. This directly impacts e.g. top performance
2664277eeddSDenis Vlasenko  * with many processes running. We optimize it for speed
2674277eeddSDenis Vlasenko  * using code from
2684277eeddSDenis Vlasenko  * http://www.cs.uiowa.edu/~jones/bcd/decimal.html
2694277eeddSDenis Vlasenko  * (with permission from the author, Douglas W. Jones). */
2704277eeddSDenis Vlasenko 
2714277eeddSDenis Vlasenko /* Formats correctly any integer in [0,99999].
2724277eeddSDenis Vlasenko  * Outputs from one to five digits depending on input.
2734277eeddSDenis Vlasenko  * On i386 gcc 4.1.2 -O2: ~250 bytes of code. */
2744277eeddSDenis Vlasenko static char* put_dec_trunc(char *buf, unsigned q)
2754277eeddSDenis Vlasenko {
2764277eeddSDenis Vlasenko 	unsigned d3, d2, d1, d0;
2774277eeddSDenis Vlasenko 	d1 = (q>>4) & 0xf;
2784277eeddSDenis Vlasenko 	d2 = (q>>8) & 0xf;
2794277eeddSDenis Vlasenko 	d3 = (q>>12);
2804277eeddSDenis Vlasenko 
2814277eeddSDenis Vlasenko 	d0 = 6*(d3 + d2 + d1) + (q & 0xf);
2824277eeddSDenis Vlasenko 	q = (d0 * 0xcd) >> 11;
2834277eeddSDenis Vlasenko 	d0 = d0 - 10*q;
2844277eeddSDenis Vlasenko 	*buf++ = d0 + '0'; /* least significant digit */
2854277eeddSDenis Vlasenko 	d1 = q + 9*d3 + 5*d2 + d1;
2864277eeddSDenis Vlasenko 	if (d1 != 0) {
2874277eeddSDenis Vlasenko 		q = (d1 * 0xcd) >> 11;
2884277eeddSDenis Vlasenko 		d1 = d1 - 10*q;
2894277eeddSDenis Vlasenko 		*buf++ = d1 + '0'; /* next digit */
2904277eeddSDenis Vlasenko 
2914277eeddSDenis Vlasenko 		d2 = q + 2*d2;
2924277eeddSDenis Vlasenko 		if ((d2 != 0) || (d3 != 0)) {
2934277eeddSDenis Vlasenko 			q = (d2 * 0xd) >> 7;
2944277eeddSDenis Vlasenko 			d2 = d2 - 10*q;
2954277eeddSDenis Vlasenko 			*buf++ = d2 + '0'; /* next digit */
2964277eeddSDenis Vlasenko 
2974277eeddSDenis Vlasenko 			d3 = q + 4*d3;
2984277eeddSDenis Vlasenko 			if (d3 != 0) {
2994277eeddSDenis Vlasenko 				q = (d3 * 0xcd) >> 11;
3004277eeddSDenis Vlasenko 				d3 = d3 - 10*q;
3014277eeddSDenis Vlasenko 				*buf++ = d3 + '0';  /* next digit */
3024277eeddSDenis Vlasenko 				if (q != 0)
3034277eeddSDenis Vlasenko 					*buf++ = q + '0';  /* most sign. digit */
3044277eeddSDenis Vlasenko 			}
3054277eeddSDenis Vlasenko 		}
3064277eeddSDenis Vlasenko 	}
3074277eeddSDenis Vlasenko 	return buf;
3084277eeddSDenis Vlasenko }
3094277eeddSDenis Vlasenko /* Same with if's removed. Always emits five digits */
3104277eeddSDenis Vlasenko static char* put_dec_full(char *buf, unsigned q)
3114277eeddSDenis Vlasenko {
3124277eeddSDenis Vlasenko 	/* BTW, if q is in [0,9999], 8-bit ints will be enough, */
3134277eeddSDenis Vlasenko 	/* but anyway, gcc produces better code with full-sized ints */
3144277eeddSDenis Vlasenko 	unsigned d3, d2, d1, d0;
3154277eeddSDenis Vlasenko 	d1 = (q>>4) & 0xf;
3164277eeddSDenis Vlasenko 	d2 = (q>>8) & 0xf;
3174277eeddSDenis Vlasenko 	d3 = (q>>12);
3184277eeddSDenis Vlasenko 
3194277eeddSDenis Vlasenko 	/* Possible ways to approx. divide by 10 */
3204277eeddSDenis Vlasenko 	/* gcc -O2 replaces multiply with shifts and adds */
3214277eeddSDenis Vlasenko 	// (x * 0xcd) >> 11: 11001101 - shorter code than * 0x67 (on i386)
3224277eeddSDenis Vlasenko 	// (x * 0x67) >> 10:  1100111
3234277eeddSDenis Vlasenko 	// (x * 0x34) >> 9:    110100 - same
3244277eeddSDenis Vlasenko 	// (x * 0x1a) >> 8:     11010 - same
3254277eeddSDenis Vlasenko 	// (x * 0x0d) >> 7:      1101 - same, shortest code (on i386)
3264277eeddSDenis Vlasenko 
3274277eeddSDenis Vlasenko 	d0 = 6*(d3 + d2 + d1) + (q & 0xf);
3284277eeddSDenis Vlasenko 	q = (d0 * 0xcd) >> 11;
3294277eeddSDenis Vlasenko 	d0 = d0 - 10*q;
3304277eeddSDenis Vlasenko 	*buf++ = d0 + '0';
3314277eeddSDenis Vlasenko 	d1 = q + 9*d3 + 5*d2 + d1;
3324277eeddSDenis Vlasenko 		q = (d1 * 0xcd) >> 11;
3334277eeddSDenis Vlasenko 		d1 = d1 - 10*q;
3344277eeddSDenis Vlasenko 		*buf++ = d1 + '0';
3354277eeddSDenis Vlasenko 
3364277eeddSDenis Vlasenko 		d2 = q + 2*d2;
3374277eeddSDenis Vlasenko 			q = (d2 * 0xd) >> 7;
3384277eeddSDenis Vlasenko 			d2 = d2 - 10*q;
3394277eeddSDenis Vlasenko 			*buf++ = d2 + '0';
3404277eeddSDenis Vlasenko 
3414277eeddSDenis Vlasenko 			d3 = q + 4*d3;
3424277eeddSDenis Vlasenko 				q = (d3 * 0xcd) >> 11; /* - shorter code */
3434277eeddSDenis Vlasenko 				/* q = (d3 * 0x67) >> 10; - would also work */
3444277eeddSDenis Vlasenko 				d3 = d3 - 10*q;
3454277eeddSDenis Vlasenko 				*buf++ = d3 + '0';
3464277eeddSDenis Vlasenko 					*buf++ = q + '0';
3474277eeddSDenis Vlasenko 	return buf;
3484277eeddSDenis Vlasenko }
3494277eeddSDenis Vlasenko /* No inlining helps gcc to use registers better */
3504277eeddSDenis Vlasenko static noinline char* put_dec(char *buf, unsigned long long num)
3514277eeddSDenis Vlasenko {
3524277eeddSDenis Vlasenko 	while (1) {
3534277eeddSDenis Vlasenko 		unsigned rem;
3544277eeddSDenis Vlasenko 		if (num < 100000)
3554277eeddSDenis Vlasenko 			return put_dec_trunc(buf, num);
3564277eeddSDenis Vlasenko 		rem = do_div(num, 100000);
3574277eeddSDenis Vlasenko 		buf = put_dec_full(buf, rem);
3584277eeddSDenis Vlasenko 	}
3594277eeddSDenis Vlasenko }
3604277eeddSDenis Vlasenko 
3611da177e4SLinus Torvalds #define ZEROPAD	1		/* pad with zero */
3621da177e4SLinus Torvalds #define SIGN	2		/* unsigned/signed long */
3631da177e4SLinus Torvalds #define PLUS	4		/* show plus */
3641da177e4SLinus Torvalds #define SPACE	8		/* space if plus */
3651da177e4SLinus Torvalds #define LEFT	16		/* left justified */
366*9b706aeeSDenys Vlasenko #define SMALL	32		/* Must be 32 == 0x20 */
367*9b706aeeSDenys Vlasenko #define SPECIAL	64		/* 0x */
3681da177e4SLinus Torvalds 
3691da177e4SLinus Torvalds static char *number(char *buf, char *end, unsigned long long num, int base, int size, int precision, int type)
3701da177e4SLinus Torvalds {
371*9b706aeeSDenys Vlasenko 	/* we are called with base 8, 10 or 16, only, thus don't need "G..."  */
372*9b706aeeSDenys Vlasenko 	static const char digits[16] = "0123456789ABCDEF"; /* "GHIJKLMNOPQRSTUVWXYZ"; */
373*9b706aeeSDenys Vlasenko 
374*9b706aeeSDenys Vlasenko 	char tmp[66];
375*9b706aeeSDenys Vlasenko 	char sign;
376*9b706aeeSDenys Vlasenko 	char locase;
377b39a7340SDenis Vlasenko 	int need_pfx = ((type & SPECIAL) && base != 10);
3781da177e4SLinus Torvalds 	int i;
3791da177e4SLinus Torvalds 
380*9b706aeeSDenys Vlasenko 	/* locase = 0 or 0x20. ORing digits or letters with 'locase'
381*9b706aeeSDenys Vlasenko 	 * produces same digits or (maybe lowercased) letters */
382*9b706aeeSDenys Vlasenko 	locase = (type & SMALL);
3831da177e4SLinus Torvalds 	if (type & LEFT)
3841da177e4SLinus Torvalds 		type &= ~ZEROPAD;
3851da177e4SLinus Torvalds 	sign = 0;
3861da177e4SLinus Torvalds 	if (type & SIGN) {
3871da177e4SLinus Torvalds 		if ((signed long long) num < 0) {
3881da177e4SLinus Torvalds 			sign = '-';
3891da177e4SLinus Torvalds 			num = - (signed long long) num;
3901da177e4SLinus Torvalds 			size--;
3911da177e4SLinus Torvalds 		} else if (type & PLUS) {
3921da177e4SLinus Torvalds 			sign = '+';
3931da177e4SLinus Torvalds 			size--;
3941da177e4SLinus Torvalds 		} else if (type & SPACE) {
3951da177e4SLinus Torvalds 			sign = ' ';
3961da177e4SLinus Torvalds 			size--;
3971da177e4SLinus Torvalds 		}
3981da177e4SLinus Torvalds 	}
399b39a7340SDenis Vlasenko 	if (need_pfx) {
400b39a7340SDenis Vlasenko 		size--;
4011da177e4SLinus Torvalds 		if (base == 16)
4021da177e4SLinus Torvalds 			size--;
4031da177e4SLinus Torvalds 	}
404b39a7340SDenis Vlasenko 
405b39a7340SDenis Vlasenko 	/* generate full string in tmp[], in reverse order */
4061da177e4SLinus Torvalds 	i = 0;
4071da177e4SLinus Torvalds 	if (num == 0)
4081da177e4SLinus Torvalds 		tmp[i++] = '0';
4094277eeddSDenis Vlasenko 	/* Generic code, for any base:
4104277eeddSDenis Vlasenko 	else do {
411*9b706aeeSDenys Vlasenko 		tmp[i++] = (digits[do_div(num,base)] | locase);
4124277eeddSDenis Vlasenko 	} while (num != 0);
4134277eeddSDenis Vlasenko 	*/
414b39a7340SDenis Vlasenko 	else if (base != 10) { /* 8 or 16 */
415b39a7340SDenis Vlasenko 		int mask = base - 1;
416b39a7340SDenis Vlasenko 		int shift = 3;
417b39a7340SDenis Vlasenko 		if (base == 16) shift = 4;
418b39a7340SDenis Vlasenko 		do {
419*9b706aeeSDenys Vlasenko 			tmp[i++] = (digits[((unsigned char)num) & mask] | locase);
420b39a7340SDenis Vlasenko 			num >>= shift;
421b39a7340SDenis Vlasenko 		} while (num);
4224277eeddSDenis Vlasenko 	} else { /* base 10 */
4234277eeddSDenis Vlasenko 		i = put_dec(tmp, num) - tmp;
4244277eeddSDenis Vlasenko 	}
425b39a7340SDenis Vlasenko 
426b39a7340SDenis Vlasenko 	/* printing 100 using %2d gives "100", not "00" */
4271da177e4SLinus Torvalds 	if (i > precision)
4281da177e4SLinus Torvalds 		precision = i;
429b39a7340SDenis Vlasenko 	/* leading space padding */
4301da177e4SLinus Torvalds 	size -= precision;
4311da177e4SLinus Torvalds 	if (!(type & (ZEROPAD+LEFT))) {
432b39a7340SDenis Vlasenko 		while(--size >= 0) {
433f796937aSJeremy Fitzhardinge 			if (buf < end)
4341da177e4SLinus Torvalds 				*buf = ' ';
4351da177e4SLinus Torvalds 			++buf;
4361da177e4SLinus Torvalds 		}
4371da177e4SLinus Torvalds 	}
438b39a7340SDenis Vlasenko 	/* sign */
4391da177e4SLinus Torvalds 	if (sign) {
440f796937aSJeremy Fitzhardinge 		if (buf < end)
4411da177e4SLinus Torvalds 			*buf = sign;
4421da177e4SLinus Torvalds 		++buf;
4431da177e4SLinus Torvalds 	}
444b39a7340SDenis Vlasenko 	/* "0x" / "0" prefix */
445b39a7340SDenis Vlasenko 	if (need_pfx) {
446f796937aSJeremy Fitzhardinge 		if (buf < end)
4471da177e4SLinus Torvalds 			*buf = '0';
4481da177e4SLinus Torvalds 		++buf;
449b39a7340SDenis Vlasenko 		if (base == 16) {
450f796937aSJeremy Fitzhardinge 			if (buf < end)
451*9b706aeeSDenys Vlasenko 				*buf = ('X' | locase);
4521da177e4SLinus Torvalds 			++buf;
4531da177e4SLinus Torvalds 		}
4541da177e4SLinus Torvalds 	}
455b39a7340SDenis Vlasenko 	/* zero or space padding */
4561da177e4SLinus Torvalds 	if (!(type & LEFT)) {
457b39a7340SDenis Vlasenko 		char c = (type & ZEROPAD) ? '0' : ' ';
458b39a7340SDenis Vlasenko 		while (--size >= 0) {
459f796937aSJeremy Fitzhardinge 			if (buf < end)
4601da177e4SLinus Torvalds 				*buf = c;
4611da177e4SLinus Torvalds 			++buf;
4621da177e4SLinus Torvalds 		}
4631da177e4SLinus Torvalds 	}
464b39a7340SDenis Vlasenko 	/* hmm even more zero padding? */
465b39a7340SDenis Vlasenko 	while (i <= --precision) {
466f796937aSJeremy Fitzhardinge 		if (buf < end)
4671da177e4SLinus Torvalds 			*buf = '0';
4681da177e4SLinus Torvalds 		++buf;
4691da177e4SLinus Torvalds 	}
470b39a7340SDenis Vlasenko 	/* actual digits of result */
471b39a7340SDenis Vlasenko 	while (--i >= 0) {
472f796937aSJeremy Fitzhardinge 		if (buf < end)
4731da177e4SLinus Torvalds 			*buf = tmp[i];
4741da177e4SLinus Torvalds 		++buf;
4751da177e4SLinus Torvalds 	}
476b39a7340SDenis Vlasenko 	/* trailing space padding */
477b39a7340SDenis Vlasenko 	while (--size >= 0) {
478f796937aSJeremy Fitzhardinge 		if (buf < end)
4791da177e4SLinus Torvalds 			*buf = ' ';
4801da177e4SLinus Torvalds 		++buf;
4811da177e4SLinus Torvalds 	}
4821da177e4SLinus Torvalds 	return buf;
4831da177e4SLinus Torvalds }
4841da177e4SLinus Torvalds 
4851da177e4SLinus Torvalds /**
4861da177e4SLinus Torvalds  * vsnprintf - Format a string and place it in a buffer
4871da177e4SLinus Torvalds  * @buf: The buffer to place the result into
4881da177e4SLinus Torvalds  * @size: The size of the buffer, including the trailing null space
4891da177e4SLinus Torvalds  * @fmt: The format string to use
4901da177e4SLinus Torvalds  * @args: Arguments for the format string
4911da177e4SLinus Torvalds  *
4921da177e4SLinus Torvalds  * The return value is the number of characters which would
4931da177e4SLinus Torvalds  * be generated for the given input, excluding the trailing
4941da177e4SLinus Torvalds  * '\0', as per ISO C99. If you want to have the exact
4951da177e4SLinus Torvalds  * number of characters written into @buf as return value
49672fd4a35SRobert P. J. Day  * (not including the trailing '\0'), use vscnprintf(). If the
4971da177e4SLinus Torvalds  * return is greater than or equal to @size, the resulting
4981da177e4SLinus Torvalds  * string is truncated.
4991da177e4SLinus Torvalds  *
5001da177e4SLinus Torvalds  * Call this function if you are already dealing with a va_list.
50172fd4a35SRobert P. J. Day  * You probably want snprintf() instead.
5021da177e4SLinus Torvalds  */
5031da177e4SLinus Torvalds int vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
5041da177e4SLinus Torvalds {
5051da177e4SLinus Torvalds 	int len;
5061da177e4SLinus Torvalds 	unsigned long long num;
5071da177e4SLinus Torvalds 	int i, base;
5081da177e4SLinus Torvalds 	char *str, *end, c;
5091da177e4SLinus Torvalds 	const char *s;
5101da177e4SLinus Torvalds 
5111da177e4SLinus Torvalds 	int flags;		/* flags to number() */
5121da177e4SLinus Torvalds 
5131da177e4SLinus Torvalds 	int field_width;	/* width of output field */
5141da177e4SLinus Torvalds 	int precision;		/* min. # of digits for integers; max
5151da177e4SLinus Torvalds 				   number of chars for from string */
5161da177e4SLinus Torvalds 	int qualifier;		/* 'h', 'l', or 'L' for integer fields */
5171da177e4SLinus Torvalds 				/* 'z' support added 23/7/1999 S.H.    */
5181da177e4SLinus Torvalds 				/* 'z' changed to 'Z' --davidm 1/25/99 */
51980322306SAl Viro 				/* 't' added for ptrdiff_t */
5201da177e4SLinus Torvalds 
521f796937aSJeremy Fitzhardinge 	/* Reject out-of-range values early.  Large positive sizes are
522f796937aSJeremy Fitzhardinge 	   used for unknown buffer sizes. */
5231da177e4SLinus Torvalds 	if (unlikely((int) size < 0)) {
5241da177e4SLinus Torvalds 		/* There can be only one.. */
525b39a7340SDenis Vlasenko 		static char warn = 1;
5261da177e4SLinus Torvalds 		WARN_ON(warn);
5271da177e4SLinus Torvalds 		warn = 0;
5281da177e4SLinus Torvalds 		return 0;
5291da177e4SLinus Torvalds 	}
5301da177e4SLinus Torvalds 
5311da177e4SLinus Torvalds 	str = buf;
532f796937aSJeremy Fitzhardinge 	end = buf + size;
5331da177e4SLinus Torvalds 
534f796937aSJeremy Fitzhardinge 	/* Make sure end is always >= buf */
535f796937aSJeremy Fitzhardinge 	if (end < buf) {
5361da177e4SLinus Torvalds 		end = ((void *)-1);
537f796937aSJeremy Fitzhardinge 		size = end - buf;
5381da177e4SLinus Torvalds 	}
5391da177e4SLinus Torvalds 
5401da177e4SLinus Torvalds 	for (; *fmt ; ++fmt) {
5411da177e4SLinus Torvalds 		if (*fmt != '%') {
542f796937aSJeremy Fitzhardinge 			if (str < end)
5431da177e4SLinus Torvalds 				*str = *fmt;
5441da177e4SLinus Torvalds 			++str;
5451da177e4SLinus Torvalds 			continue;
5461da177e4SLinus Torvalds 		}
5471da177e4SLinus Torvalds 
5481da177e4SLinus Torvalds 		/* process flags */
5491da177e4SLinus Torvalds 		flags = 0;
5501da177e4SLinus Torvalds 		repeat:
5511da177e4SLinus Torvalds 			++fmt;		/* this also skips first '%' */
5521da177e4SLinus Torvalds 			switch (*fmt) {
5531da177e4SLinus Torvalds 				case '-': flags |= LEFT; goto repeat;
5541da177e4SLinus Torvalds 				case '+': flags |= PLUS; goto repeat;
5551da177e4SLinus Torvalds 				case ' ': flags |= SPACE; goto repeat;
5561da177e4SLinus Torvalds 				case '#': flags |= SPECIAL; goto repeat;
5571da177e4SLinus Torvalds 				case '0': flags |= ZEROPAD; goto repeat;
5581da177e4SLinus Torvalds 			}
5591da177e4SLinus Torvalds 
5601da177e4SLinus Torvalds 		/* get field width */
5611da177e4SLinus Torvalds 		field_width = -1;
5621da177e4SLinus Torvalds 		if (isdigit(*fmt))
5631da177e4SLinus Torvalds 			field_width = skip_atoi(&fmt);
5641da177e4SLinus Torvalds 		else if (*fmt == '*') {
5651da177e4SLinus Torvalds 			++fmt;
5661da177e4SLinus Torvalds 			/* it's the next argument */
5671da177e4SLinus Torvalds 			field_width = va_arg(args, int);
5681da177e4SLinus Torvalds 			if (field_width < 0) {
5691da177e4SLinus Torvalds 				field_width = -field_width;
5701da177e4SLinus Torvalds 				flags |= LEFT;
5711da177e4SLinus Torvalds 			}
5721da177e4SLinus Torvalds 		}
5731da177e4SLinus Torvalds 
5741da177e4SLinus Torvalds 		/* get the precision */
5751da177e4SLinus Torvalds 		precision = -1;
5761da177e4SLinus Torvalds 		if (*fmt == '.') {
5771da177e4SLinus Torvalds 			++fmt;
5781da177e4SLinus Torvalds 			if (isdigit(*fmt))
5791da177e4SLinus Torvalds 				precision = skip_atoi(&fmt);
5801da177e4SLinus Torvalds 			else if (*fmt == '*') {
5811da177e4SLinus Torvalds 				++fmt;
5821da177e4SLinus Torvalds 				/* it's the next argument */
5831da177e4SLinus Torvalds 				precision = va_arg(args, int);
5841da177e4SLinus Torvalds 			}
5851da177e4SLinus Torvalds 			if (precision < 0)
5861da177e4SLinus Torvalds 				precision = 0;
5871da177e4SLinus Torvalds 		}
5881da177e4SLinus Torvalds 
5891da177e4SLinus Torvalds 		/* get the conversion qualifier */
5901da177e4SLinus Torvalds 		qualifier = -1;
5911da177e4SLinus Torvalds 		if (*fmt == 'h' || *fmt == 'l' || *fmt == 'L' ||
59280322306SAl Viro 		    *fmt =='Z' || *fmt == 'z' || *fmt == 't') {
5931da177e4SLinus Torvalds 			qualifier = *fmt;
5941da177e4SLinus Torvalds 			++fmt;
5951da177e4SLinus Torvalds 			if (qualifier == 'l' && *fmt == 'l') {
5961da177e4SLinus Torvalds 				qualifier = 'L';
5971da177e4SLinus Torvalds 				++fmt;
5981da177e4SLinus Torvalds 			}
5991da177e4SLinus Torvalds 		}
6001da177e4SLinus Torvalds 
6011da177e4SLinus Torvalds 		/* default base */
6021da177e4SLinus Torvalds 		base = 10;
6031da177e4SLinus Torvalds 
6041da177e4SLinus Torvalds 		switch (*fmt) {
6051da177e4SLinus Torvalds 			case 'c':
6061da177e4SLinus Torvalds 				if (!(flags & LEFT)) {
6071da177e4SLinus Torvalds 					while (--field_width > 0) {
608f796937aSJeremy Fitzhardinge 						if (str < end)
6091da177e4SLinus Torvalds 							*str = ' ';
6101da177e4SLinus Torvalds 						++str;
6111da177e4SLinus Torvalds 					}
6121da177e4SLinus Torvalds 				}
6131da177e4SLinus Torvalds 				c = (unsigned char) va_arg(args, int);
614f796937aSJeremy Fitzhardinge 				if (str < end)
6151da177e4SLinus Torvalds 					*str = c;
6161da177e4SLinus Torvalds 				++str;
6171da177e4SLinus Torvalds 				while (--field_width > 0) {
618f796937aSJeremy Fitzhardinge 					if (str < end)
6191da177e4SLinus Torvalds 						*str = ' ';
6201da177e4SLinus Torvalds 					++str;
6211da177e4SLinus Torvalds 				}
6221da177e4SLinus Torvalds 				continue;
6231da177e4SLinus Torvalds 
6241da177e4SLinus Torvalds 			case 's':
6251da177e4SLinus Torvalds 				s = va_arg(args, char *);
6261da177e4SLinus Torvalds 				if ((unsigned long)s < PAGE_SIZE)
6271da177e4SLinus Torvalds 					s = "<NULL>";
6281da177e4SLinus Torvalds 
6291da177e4SLinus Torvalds 				len = strnlen(s, precision);
6301da177e4SLinus Torvalds 
6311da177e4SLinus Torvalds 				if (!(flags & LEFT)) {
6321da177e4SLinus Torvalds 					while (len < field_width--) {
633f796937aSJeremy Fitzhardinge 						if (str < end)
6341da177e4SLinus Torvalds 							*str = ' ';
6351da177e4SLinus Torvalds 						++str;
6361da177e4SLinus Torvalds 					}
6371da177e4SLinus Torvalds 				}
6381da177e4SLinus Torvalds 				for (i = 0; i < len; ++i) {
639f796937aSJeremy Fitzhardinge 					if (str < end)
6401da177e4SLinus Torvalds 						*str = *s;
6411da177e4SLinus Torvalds 					++str; ++s;
6421da177e4SLinus Torvalds 				}
6431da177e4SLinus Torvalds 				while (len < field_width--) {
644f796937aSJeremy Fitzhardinge 					if (str < end)
6451da177e4SLinus Torvalds 						*str = ' ';
6461da177e4SLinus Torvalds 					++str;
6471da177e4SLinus Torvalds 				}
6481da177e4SLinus Torvalds 				continue;
6491da177e4SLinus Torvalds 
6501da177e4SLinus Torvalds 			case 'p':
651*9b706aeeSDenys Vlasenko 				flags |= SMALL;
6521da177e4SLinus Torvalds 				if (field_width == -1) {
6531da177e4SLinus Torvalds 					field_width = 2*sizeof(void *);
6541da177e4SLinus Torvalds 					flags |= ZEROPAD;
6551da177e4SLinus Torvalds 				}
6561da177e4SLinus Torvalds 				str = number(str, end,
6571da177e4SLinus Torvalds 						(unsigned long) va_arg(args, void *),
6581da177e4SLinus Torvalds 						16, field_width, precision, flags);
6591da177e4SLinus Torvalds 				continue;
6601da177e4SLinus Torvalds 
6611da177e4SLinus Torvalds 
6621da177e4SLinus Torvalds 			case 'n':
6631da177e4SLinus Torvalds 				/* FIXME:
6641da177e4SLinus Torvalds 				* What does C99 say about the overflow case here? */
6651da177e4SLinus Torvalds 				if (qualifier == 'l') {
6661da177e4SLinus Torvalds 					long * ip = va_arg(args, long *);
6671da177e4SLinus Torvalds 					*ip = (str - buf);
6681da177e4SLinus Torvalds 				} else if (qualifier == 'Z' || qualifier == 'z') {
6691da177e4SLinus Torvalds 					size_t * ip = va_arg(args, size_t *);
6701da177e4SLinus Torvalds 					*ip = (str - buf);
6711da177e4SLinus Torvalds 				} else {
6721da177e4SLinus Torvalds 					int * ip = va_arg(args, int *);
6731da177e4SLinus Torvalds 					*ip = (str - buf);
6741da177e4SLinus Torvalds 				}
6751da177e4SLinus Torvalds 				continue;
6761da177e4SLinus Torvalds 
6771da177e4SLinus Torvalds 			case '%':
678f796937aSJeremy Fitzhardinge 				if (str < end)
6791da177e4SLinus Torvalds 					*str = '%';
6801da177e4SLinus Torvalds 				++str;
6811da177e4SLinus Torvalds 				continue;
6821da177e4SLinus Torvalds 
6831da177e4SLinus Torvalds 				/* integer number formats - set up the flags and "break" */
6841da177e4SLinus Torvalds 			case 'o':
6851da177e4SLinus Torvalds 				base = 8;
6861da177e4SLinus Torvalds 				break;
6871da177e4SLinus Torvalds 
6881da177e4SLinus Torvalds 			case 'x':
689*9b706aeeSDenys Vlasenko 				flags |= SMALL;
690*9b706aeeSDenys Vlasenko 			case 'X':
6911da177e4SLinus Torvalds 				base = 16;
6921da177e4SLinus Torvalds 				break;
6931da177e4SLinus Torvalds 
6941da177e4SLinus Torvalds 			case 'd':
6951da177e4SLinus Torvalds 			case 'i':
6961da177e4SLinus Torvalds 				flags |= SIGN;
6971da177e4SLinus Torvalds 			case 'u':
6981da177e4SLinus Torvalds 				break;
6991da177e4SLinus Torvalds 
7001da177e4SLinus Torvalds 			default:
701f796937aSJeremy Fitzhardinge 				if (str < end)
7021da177e4SLinus Torvalds 					*str = '%';
7031da177e4SLinus Torvalds 				++str;
7041da177e4SLinus Torvalds 				if (*fmt) {
705f796937aSJeremy Fitzhardinge 					if (str < end)
7061da177e4SLinus Torvalds 						*str = *fmt;
7071da177e4SLinus Torvalds 					++str;
7081da177e4SLinus Torvalds 				} else {
7091da177e4SLinus Torvalds 					--fmt;
7101da177e4SLinus Torvalds 				}
7111da177e4SLinus Torvalds 				continue;
7121da177e4SLinus Torvalds 		}
7131da177e4SLinus Torvalds 		if (qualifier == 'L')
7141da177e4SLinus Torvalds 			num = va_arg(args, long long);
7151da177e4SLinus Torvalds 		else if (qualifier == 'l') {
7161da177e4SLinus Torvalds 			num = va_arg(args, unsigned long);
7171da177e4SLinus Torvalds 			if (flags & SIGN)
7181da177e4SLinus Torvalds 				num = (signed long) num;
7191da177e4SLinus Torvalds 		} else if (qualifier == 'Z' || qualifier == 'z') {
7201da177e4SLinus Torvalds 			num = va_arg(args, size_t);
72180322306SAl Viro 		} else if (qualifier == 't') {
72280322306SAl Viro 			num = va_arg(args, ptrdiff_t);
7231da177e4SLinus Torvalds 		} else if (qualifier == 'h') {
7241da177e4SLinus Torvalds 			num = (unsigned short) va_arg(args, int);
7251da177e4SLinus Torvalds 			if (flags & SIGN)
7261da177e4SLinus Torvalds 				num = (signed short) num;
7271da177e4SLinus Torvalds 		} else {
7281da177e4SLinus Torvalds 			num = va_arg(args, unsigned int);
7291da177e4SLinus Torvalds 			if (flags & SIGN)
7301da177e4SLinus Torvalds 				num = (signed int) num;
7311da177e4SLinus Torvalds 		}
7321da177e4SLinus Torvalds 		str = number(str, end, num, base,
7331da177e4SLinus Torvalds 				field_width, precision, flags);
7341da177e4SLinus Torvalds 	}
735f796937aSJeremy Fitzhardinge 	if (size > 0) {
736f796937aSJeremy Fitzhardinge 		if (str < end)
7371da177e4SLinus Torvalds 			*str = '\0';
738f796937aSJeremy Fitzhardinge 		else
7390a6047eeSLinus Torvalds 			end[-1] = '\0';
740f796937aSJeremy Fitzhardinge 	}
741f796937aSJeremy Fitzhardinge 	/* the trailing null byte doesn't count towards the total */
7421da177e4SLinus Torvalds 	return str-buf;
7431da177e4SLinus Torvalds }
7441da177e4SLinus Torvalds 
7451da177e4SLinus Torvalds EXPORT_SYMBOL(vsnprintf);
7461da177e4SLinus Torvalds 
7471da177e4SLinus Torvalds /**
7481da177e4SLinus Torvalds  * vscnprintf - Format a string and place it in a buffer
7491da177e4SLinus Torvalds  * @buf: The buffer to place the result into
7501da177e4SLinus Torvalds  * @size: The size of the buffer, including the trailing null space
7511da177e4SLinus Torvalds  * @fmt: The format string to use
7521da177e4SLinus Torvalds  * @args: Arguments for the format string
7531da177e4SLinus Torvalds  *
7541da177e4SLinus Torvalds  * The return value is the number of characters which have been written into
7551da177e4SLinus Torvalds  * the @buf not including the trailing '\0'. If @size is <= 0 the function
7561da177e4SLinus Torvalds  * returns 0.
7571da177e4SLinus Torvalds  *
7581da177e4SLinus Torvalds  * Call this function if you are already dealing with a va_list.
75972fd4a35SRobert P. J. Day  * You probably want scnprintf() instead.
7601da177e4SLinus Torvalds  */
7611da177e4SLinus Torvalds int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
7621da177e4SLinus Torvalds {
7631da177e4SLinus Torvalds 	int i;
7641da177e4SLinus Torvalds 
7651da177e4SLinus Torvalds 	i=vsnprintf(buf,size,fmt,args);
7661da177e4SLinus Torvalds 	return (i >= size) ? (size - 1) : i;
7671da177e4SLinus Torvalds }
7681da177e4SLinus Torvalds 
7691da177e4SLinus Torvalds EXPORT_SYMBOL(vscnprintf);
7701da177e4SLinus Torvalds 
7711da177e4SLinus Torvalds /**
7721da177e4SLinus Torvalds  * snprintf - Format a string and place it in a buffer
7731da177e4SLinus Torvalds  * @buf: The buffer to place the result into
7741da177e4SLinus Torvalds  * @size: The size of the buffer, including the trailing null space
7751da177e4SLinus Torvalds  * @fmt: The format string to use
7761da177e4SLinus Torvalds  * @...: Arguments for the format string
7771da177e4SLinus Torvalds  *
7781da177e4SLinus Torvalds  * The return value is the number of characters which would be
7791da177e4SLinus Torvalds  * generated for the given input, excluding the trailing null,
7801da177e4SLinus Torvalds  * as per ISO C99.  If the return is greater than or equal to
7811da177e4SLinus Torvalds  * @size, the resulting string is truncated.
7821da177e4SLinus Torvalds  */
7831da177e4SLinus Torvalds int snprintf(char * buf, size_t size, const char *fmt, ...)
7841da177e4SLinus Torvalds {
7851da177e4SLinus Torvalds 	va_list args;
7861da177e4SLinus Torvalds 	int i;
7871da177e4SLinus Torvalds 
7881da177e4SLinus Torvalds 	va_start(args, fmt);
7891da177e4SLinus Torvalds 	i=vsnprintf(buf,size,fmt,args);
7901da177e4SLinus Torvalds 	va_end(args);
7911da177e4SLinus Torvalds 	return i;
7921da177e4SLinus Torvalds }
7931da177e4SLinus Torvalds 
7941da177e4SLinus Torvalds EXPORT_SYMBOL(snprintf);
7951da177e4SLinus Torvalds 
7961da177e4SLinus Torvalds /**
7971da177e4SLinus Torvalds  * scnprintf - Format a string and place it in a buffer
7981da177e4SLinus Torvalds  * @buf: The buffer to place the result into
7991da177e4SLinus Torvalds  * @size: The size of the buffer, including the trailing null space
8001da177e4SLinus Torvalds  * @fmt: The format string to use
8011da177e4SLinus Torvalds  * @...: Arguments for the format string
8021da177e4SLinus Torvalds  *
8031da177e4SLinus Torvalds  * The return value is the number of characters written into @buf not including
804ea6f3281SMartin Peschke  * the trailing '\0'. If @size is <= 0 the function returns 0.
8051da177e4SLinus Torvalds  */
8061da177e4SLinus Torvalds 
8071da177e4SLinus Torvalds int scnprintf(char * buf, size_t size, const char *fmt, ...)
8081da177e4SLinus Torvalds {
8091da177e4SLinus Torvalds 	va_list args;
8101da177e4SLinus Torvalds 	int i;
8111da177e4SLinus Torvalds 
8121da177e4SLinus Torvalds 	va_start(args, fmt);
8131da177e4SLinus Torvalds 	i = vsnprintf(buf, size, fmt, args);
8141da177e4SLinus Torvalds 	va_end(args);
8151da177e4SLinus Torvalds 	return (i >= size) ? (size - 1) : i;
8161da177e4SLinus Torvalds }
8171da177e4SLinus Torvalds EXPORT_SYMBOL(scnprintf);
8181da177e4SLinus Torvalds 
8191da177e4SLinus Torvalds /**
8201da177e4SLinus Torvalds  * vsprintf - Format a string and place it in a buffer
8211da177e4SLinus Torvalds  * @buf: The buffer to place the result into
8221da177e4SLinus Torvalds  * @fmt: The format string to use
8231da177e4SLinus Torvalds  * @args: Arguments for the format string
8241da177e4SLinus Torvalds  *
8251da177e4SLinus Torvalds  * The function returns the number of characters written
82672fd4a35SRobert P. J. Day  * into @buf. Use vsnprintf() or vscnprintf() in order to avoid
8271da177e4SLinus Torvalds  * buffer overflows.
8281da177e4SLinus Torvalds  *
8291da177e4SLinus Torvalds  * Call this function if you are already dealing with a va_list.
83072fd4a35SRobert P. J. Day  * You probably want sprintf() instead.
8311da177e4SLinus Torvalds  */
8321da177e4SLinus Torvalds int vsprintf(char *buf, const char *fmt, va_list args)
8331da177e4SLinus Torvalds {
8341da177e4SLinus Torvalds 	return vsnprintf(buf, INT_MAX, fmt, args);
8351da177e4SLinus Torvalds }
8361da177e4SLinus Torvalds 
8371da177e4SLinus Torvalds EXPORT_SYMBOL(vsprintf);
8381da177e4SLinus Torvalds 
8391da177e4SLinus Torvalds /**
8401da177e4SLinus Torvalds  * sprintf - Format a string and place it in a buffer
8411da177e4SLinus Torvalds  * @buf: The buffer to place the result into
8421da177e4SLinus Torvalds  * @fmt: The format string to use
8431da177e4SLinus Torvalds  * @...: Arguments for the format string
8441da177e4SLinus Torvalds  *
8451da177e4SLinus Torvalds  * The function returns the number of characters written
84672fd4a35SRobert P. J. Day  * into @buf. Use snprintf() or scnprintf() in order to avoid
8471da177e4SLinus Torvalds  * buffer overflows.
8481da177e4SLinus Torvalds  */
8491da177e4SLinus Torvalds int sprintf(char * buf, const char *fmt, ...)
8501da177e4SLinus Torvalds {
8511da177e4SLinus Torvalds 	va_list args;
8521da177e4SLinus Torvalds 	int i;
8531da177e4SLinus Torvalds 
8541da177e4SLinus Torvalds 	va_start(args, fmt);
8551da177e4SLinus Torvalds 	i=vsnprintf(buf, INT_MAX, fmt, args);
8561da177e4SLinus Torvalds 	va_end(args);
8571da177e4SLinus Torvalds 	return i;
8581da177e4SLinus Torvalds }
8591da177e4SLinus Torvalds 
8601da177e4SLinus Torvalds EXPORT_SYMBOL(sprintf);
8611da177e4SLinus Torvalds 
8621da177e4SLinus Torvalds /**
8631da177e4SLinus Torvalds  * vsscanf - Unformat a buffer into a list of arguments
8641da177e4SLinus Torvalds  * @buf:	input buffer
8651da177e4SLinus Torvalds  * @fmt:	format of buffer
8661da177e4SLinus Torvalds  * @args:	arguments
8671da177e4SLinus Torvalds  */
8681da177e4SLinus Torvalds int vsscanf(const char * buf, const char * fmt, va_list args)
8691da177e4SLinus Torvalds {
8701da177e4SLinus Torvalds 	const char *str = buf;
8711da177e4SLinus Torvalds 	char *next;
8721da177e4SLinus Torvalds 	char digit;
8731da177e4SLinus Torvalds 	int num = 0;
8741da177e4SLinus Torvalds 	int qualifier;
8751da177e4SLinus Torvalds 	int base;
8761da177e4SLinus Torvalds 	int field_width;
8771da177e4SLinus Torvalds 	int is_sign = 0;
8781da177e4SLinus Torvalds 
8791da177e4SLinus Torvalds 	while(*fmt && *str) {
8801da177e4SLinus Torvalds 		/* skip any white space in format */
8811da177e4SLinus Torvalds 		/* white space in format matchs any amount of
8821da177e4SLinus Torvalds 		 * white space, including none, in the input.
8831da177e4SLinus Torvalds 		 */
8841da177e4SLinus Torvalds 		if (isspace(*fmt)) {
8851da177e4SLinus Torvalds 			while (isspace(*fmt))
8861da177e4SLinus Torvalds 				++fmt;
8871da177e4SLinus Torvalds 			while (isspace(*str))
8881da177e4SLinus Torvalds 				++str;
8891da177e4SLinus Torvalds 		}
8901da177e4SLinus Torvalds 
8911da177e4SLinus Torvalds 		/* anything that is not a conversion must match exactly */
8921da177e4SLinus Torvalds 		if (*fmt != '%' && *fmt) {
8931da177e4SLinus Torvalds 			if (*fmt++ != *str++)
8941da177e4SLinus Torvalds 				break;
8951da177e4SLinus Torvalds 			continue;
8961da177e4SLinus Torvalds 		}
8971da177e4SLinus Torvalds 
8981da177e4SLinus Torvalds 		if (!*fmt)
8991da177e4SLinus Torvalds 			break;
9001da177e4SLinus Torvalds 		++fmt;
9011da177e4SLinus Torvalds 
9021da177e4SLinus Torvalds 		/* skip this conversion.
9031da177e4SLinus Torvalds 		 * advance both strings to next white space
9041da177e4SLinus Torvalds 		 */
9051da177e4SLinus Torvalds 		if (*fmt == '*') {
9061da177e4SLinus Torvalds 			while (!isspace(*fmt) && *fmt)
9071da177e4SLinus Torvalds 				fmt++;
9081da177e4SLinus Torvalds 			while (!isspace(*str) && *str)
9091da177e4SLinus Torvalds 				str++;
9101da177e4SLinus Torvalds 			continue;
9111da177e4SLinus Torvalds 		}
9121da177e4SLinus Torvalds 
9131da177e4SLinus Torvalds 		/* get field width */
9141da177e4SLinus Torvalds 		field_width = -1;
9151da177e4SLinus Torvalds 		if (isdigit(*fmt))
9161da177e4SLinus Torvalds 			field_width = skip_atoi(&fmt);
9171da177e4SLinus Torvalds 
9181da177e4SLinus Torvalds 		/* get conversion qualifier */
9191da177e4SLinus Torvalds 		qualifier = -1;
9201da177e4SLinus Torvalds 		if (*fmt == 'h' || *fmt == 'l' || *fmt == 'L' ||
9211da177e4SLinus Torvalds 		    *fmt == 'Z' || *fmt == 'z') {
9221da177e4SLinus Torvalds 			qualifier = *fmt++;
9231da177e4SLinus Torvalds 			if (unlikely(qualifier == *fmt)) {
9241da177e4SLinus Torvalds 				if (qualifier == 'h') {
9251da177e4SLinus Torvalds 					qualifier = 'H';
9261da177e4SLinus Torvalds 					fmt++;
9271da177e4SLinus Torvalds 				} else if (qualifier == 'l') {
9281da177e4SLinus Torvalds 					qualifier = 'L';
9291da177e4SLinus Torvalds 					fmt++;
9301da177e4SLinus Torvalds 				}
9311da177e4SLinus Torvalds 			}
9321da177e4SLinus Torvalds 		}
9331da177e4SLinus Torvalds 		base = 10;
9341da177e4SLinus Torvalds 		is_sign = 0;
9351da177e4SLinus Torvalds 
9361da177e4SLinus Torvalds 		if (!*fmt || !*str)
9371da177e4SLinus Torvalds 			break;
9381da177e4SLinus Torvalds 
9391da177e4SLinus Torvalds 		switch(*fmt++) {
9401da177e4SLinus Torvalds 		case 'c':
9411da177e4SLinus Torvalds 		{
9421da177e4SLinus Torvalds 			char *s = (char *) va_arg(args,char*);
9431da177e4SLinus Torvalds 			if (field_width == -1)
9441da177e4SLinus Torvalds 				field_width = 1;
9451da177e4SLinus Torvalds 			do {
9461da177e4SLinus Torvalds 				*s++ = *str++;
9471da177e4SLinus Torvalds 			} while (--field_width > 0 && *str);
9481da177e4SLinus Torvalds 			num++;
9491da177e4SLinus Torvalds 		}
9501da177e4SLinus Torvalds 		continue;
9511da177e4SLinus Torvalds 		case 's':
9521da177e4SLinus Torvalds 		{
9531da177e4SLinus Torvalds 			char *s = (char *) va_arg(args, char *);
9541da177e4SLinus Torvalds 			if(field_width == -1)
9551da177e4SLinus Torvalds 				field_width = INT_MAX;
9561da177e4SLinus Torvalds 			/* first, skip leading white space in buffer */
9571da177e4SLinus Torvalds 			while (isspace(*str))
9581da177e4SLinus Torvalds 				str++;
9591da177e4SLinus Torvalds 
9601da177e4SLinus Torvalds 			/* now copy until next white space */
9611da177e4SLinus Torvalds 			while (*str && !isspace(*str) && field_width--) {
9621da177e4SLinus Torvalds 				*s++ = *str++;
9631da177e4SLinus Torvalds 			}
9641da177e4SLinus Torvalds 			*s = '\0';
9651da177e4SLinus Torvalds 			num++;
9661da177e4SLinus Torvalds 		}
9671da177e4SLinus Torvalds 		continue;
9681da177e4SLinus Torvalds 		case 'n':
9691da177e4SLinus Torvalds 			/* return number of characters read so far */
9701da177e4SLinus Torvalds 		{
9711da177e4SLinus Torvalds 			int *i = (int *)va_arg(args,int*);
9721da177e4SLinus Torvalds 			*i = str - buf;
9731da177e4SLinus Torvalds 		}
9741da177e4SLinus Torvalds 		continue;
9751da177e4SLinus Torvalds 		case 'o':
9761da177e4SLinus Torvalds 			base = 8;
9771da177e4SLinus Torvalds 			break;
9781da177e4SLinus Torvalds 		case 'x':
9791da177e4SLinus Torvalds 		case 'X':
9801da177e4SLinus Torvalds 			base = 16;
9811da177e4SLinus Torvalds 			break;
9821da177e4SLinus Torvalds 		case 'i':
9831da177e4SLinus Torvalds                         base = 0;
9841da177e4SLinus Torvalds 		case 'd':
9851da177e4SLinus Torvalds 			is_sign = 1;
9861da177e4SLinus Torvalds 		case 'u':
9871da177e4SLinus Torvalds 			break;
9881da177e4SLinus Torvalds 		case '%':
9891da177e4SLinus Torvalds 			/* looking for '%' in str */
9901da177e4SLinus Torvalds 			if (*str++ != '%')
9911da177e4SLinus Torvalds 				return num;
9921da177e4SLinus Torvalds 			continue;
9931da177e4SLinus Torvalds 		default:
9941da177e4SLinus Torvalds 			/* invalid format; stop here */
9951da177e4SLinus Torvalds 			return num;
9961da177e4SLinus Torvalds 		}
9971da177e4SLinus Torvalds 
9981da177e4SLinus Torvalds 		/* have some sort of integer conversion.
9991da177e4SLinus Torvalds 		 * first, skip white space in buffer.
10001da177e4SLinus Torvalds 		 */
10011da177e4SLinus Torvalds 		while (isspace(*str))
10021da177e4SLinus Torvalds 			str++;
10031da177e4SLinus Torvalds 
10041da177e4SLinus Torvalds 		digit = *str;
10051da177e4SLinus Torvalds 		if (is_sign && digit == '-')
10061da177e4SLinus Torvalds 			digit = *(str + 1);
10071da177e4SLinus Torvalds 
10081da177e4SLinus Torvalds 		if (!digit
10091da177e4SLinus Torvalds                     || (base == 16 && !isxdigit(digit))
10101da177e4SLinus Torvalds                     || (base == 10 && !isdigit(digit))
10111da177e4SLinus Torvalds                     || (base == 8 && (!isdigit(digit) || digit > '7'))
10121da177e4SLinus Torvalds                     || (base == 0 && !isdigit(digit)))
10131da177e4SLinus Torvalds 				break;
10141da177e4SLinus Torvalds 
10151da177e4SLinus Torvalds 		switch(qualifier) {
10161da177e4SLinus Torvalds 		case 'H':	/* that's 'hh' in format */
10171da177e4SLinus Torvalds 			if (is_sign) {
10181da177e4SLinus Torvalds 				signed char *s = (signed char *) va_arg(args,signed char *);
10191da177e4SLinus Torvalds 				*s = (signed char) simple_strtol(str,&next,base);
10201da177e4SLinus Torvalds 			} else {
10211da177e4SLinus Torvalds 				unsigned char *s = (unsigned char *) va_arg(args, unsigned char *);
10221da177e4SLinus Torvalds 				*s = (unsigned char) simple_strtoul(str, &next, base);
10231da177e4SLinus Torvalds 			}
10241da177e4SLinus Torvalds 			break;
10251da177e4SLinus Torvalds 		case 'h':
10261da177e4SLinus Torvalds 			if (is_sign) {
10271da177e4SLinus Torvalds 				short *s = (short *) va_arg(args,short *);
10281da177e4SLinus Torvalds 				*s = (short) simple_strtol(str,&next,base);
10291da177e4SLinus Torvalds 			} else {
10301da177e4SLinus Torvalds 				unsigned short *s = (unsigned short *) va_arg(args, unsigned short *);
10311da177e4SLinus Torvalds 				*s = (unsigned short) simple_strtoul(str, &next, base);
10321da177e4SLinus Torvalds 			}
10331da177e4SLinus Torvalds 			break;
10341da177e4SLinus Torvalds 		case 'l':
10351da177e4SLinus Torvalds 			if (is_sign) {
10361da177e4SLinus Torvalds 				long *l = (long *) va_arg(args,long *);
10371da177e4SLinus Torvalds 				*l = simple_strtol(str,&next,base);
10381da177e4SLinus Torvalds 			} else {
10391da177e4SLinus Torvalds 				unsigned long *l = (unsigned long*) va_arg(args,unsigned long*);
10401da177e4SLinus Torvalds 				*l = simple_strtoul(str,&next,base);
10411da177e4SLinus Torvalds 			}
10421da177e4SLinus Torvalds 			break;
10431da177e4SLinus Torvalds 		case 'L':
10441da177e4SLinus Torvalds 			if (is_sign) {
10451da177e4SLinus Torvalds 				long long *l = (long long*) va_arg(args,long long *);
10461da177e4SLinus Torvalds 				*l = simple_strtoll(str,&next,base);
10471da177e4SLinus Torvalds 			} else {
10481da177e4SLinus Torvalds 				unsigned long long *l = (unsigned long long*) va_arg(args,unsigned long long*);
10491da177e4SLinus Torvalds 				*l = simple_strtoull(str,&next,base);
10501da177e4SLinus Torvalds 			}
10511da177e4SLinus Torvalds 			break;
10521da177e4SLinus Torvalds 		case 'Z':
10531da177e4SLinus Torvalds 		case 'z':
10541da177e4SLinus Torvalds 		{
10551da177e4SLinus Torvalds 			size_t *s = (size_t*) va_arg(args,size_t*);
10561da177e4SLinus Torvalds 			*s = (size_t) simple_strtoul(str,&next,base);
10571da177e4SLinus Torvalds 		}
10581da177e4SLinus Torvalds 		break;
10591da177e4SLinus Torvalds 		default:
10601da177e4SLinus Torvalds 			if (is_sign) {
10611da177e4SLinus Torvalds 				int *i = (int *) va_arg(args, int*);
10621da177e4SLinus Torvalds 				*i = (int) simple_strtol(str,&next,base);
10631da177e4SLinus Torvalds 			} else {
10641da177e4SLinus Torvalds 				unsigned int *i = (unsigned int*) va_arg(args, unsigned int*);
10651da177e4SLinus Torvalds 				*i = (unsigned int) simple_strtoul(str,&next,base);
10661da177e4SLinus Torvalds 			}
10671da177e4SLinus Torvalds 			break;
10681da177e4SLinus Torvalds 		}
10691da177e4SLinus Torvalds 		num++;
10701da177e4SLinus Torvalds 
10711da177e4SLinus Torvalds 		if (!next)
10721da177e4SLinus Torvalds 			break;
10731da177e4SLinus Torvalds 		str = next;
10741da177e4SLinus Torvalds 	}
1075c6b40d16SJohannes Berg 
1076c6b40d16SJohannes Berg 	/*
1077c6b40d16SJohannes Berg 	 * Now we've come all the way through so either the input string or the
1078c6b40d16SJohannes Berg 	 * format ended. In the former case, there can be a %n at the current
1079c6b40d16SJohannes Berg 	 * position in the format that needs to be filled.
1080c6b40d16SJohannes Berg 	 */
1081c6b40d16SJohannes Berg 	if (*fmt == '%' && *(fmt + 1) == 'n') {
1082c6b40d16SJohannes Berg 		int *p = (int *)va_arg(args, int *);
1083c6b40d16SJohannes Berg 		*p = str - buf;
1084c6b40d16SJohannes Berg 	}
1085c6b40d16SJohannes Berg 
10861da177e4SLinus Torvalds 	return num;
10871da177e4SLinus Torvalds }
10881da177e4SLinus Torvalds 
10891da177e4SLinus Torvalds EXPORT_SYMBOL(vsscanf);
10901da177e4SLinus Torvalds 
10911da177e4SLinus Torvalds /**
10921da177e4SLinus Torvalds  * sscanf - Unformat a buffer into a list of arguments
10931da177e4SLinus Torvalds  * @buf:	input buffer
10941da177e4SLinus Torvalds  * @fmt:	formatting of buffer
10951da177e4SLinus Torvalds  * @...:	resulting arguments
10961da177e4SLinus Torvalds  */
10971da177e4SLinus Torvalds int sscanf(const char * buf, const char * fmt, ...)
10981da177e4SLinus Torvalds {
10991da177e4SLinus Torvalds 	va_list args;
11001da177e4SLinus Torvalds 	int i;
11011da177e4SLinus Torvalds 
11021da177e4SLinus Torvalds 	va_start(args,fmt);
11031da177e4SLinus Torvalds 	i = vsscanf(buf,fmt,args);
11041da177e4SLinus Torvalds 	va_end(args);
11051da177e4SLinus Torvalds 	return i;
11061da177e4SLinus Torvalds }
11071da177e4SLinus Torvalds 
11081da177e4SLinus Torvalds EXPORT_SYMBOL(sscanf);
1109