xref: /openbmc/linux/lib/vsprintf.c (revision 5b17aecfcdd3dc82c237677f5efc9a44deeaa39e)
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>
200d1d7a55SStephen Boyd #include <linux/clk.h>
21900cca29SGeert Uytterhoeven #include <linux/clk-provider.h>
228bc3bcc9SPaul Gortmaker #include <linux/module.h>	/* for KSYM_SYMBOL_LEN */
231da177e4SLinus Torvalds #include <linux/types.h>
241da177e4SLinus Torvalds #include <linux/string.h>
251da177e4SLinus Torvalds #include <linux/ctype.h>
261da177e4SLinus Torvalds #include <linux/kernel.h>
270fe1ef24SLinus Torvalds #include <linux/kallsyms.h>
2853809751SJan Beulich #include <linux/math64.h>
290fe1ef24SLinus Torvalds #include <linux/uaccess.h>
30332d2e78SLinus Torvalds #include <linux/ioport.h>
314b6ccca7SAl Viro #include <linux/dcache.h>
32312b4e22SRyan Mallon #include <linux/cred.h>
338a27f7c9SJoe Perches #include <net/addrconf.h>
341031bc58SDmitry Monakhov #ifdef CONFIG_BLOCK
351031bc58SDmitry Monakhov #include <linux/blkdev.h>
361031bc58SDmitry Monakhov #endif
371da177e4SLinus Torvalds 
384e57b681STim Schmielau #include <asm/page.h>		/* for PAGE_SIZE */
39deac93dfSJames Bottomley #include <asm/sections.h>	/* for dereference_function_descriptor() */
407c43d9a3SRasmus Villemoes #include <asm/byteorder.h>	/* cpu_to_le16 */
411da177e4SLinus Torvalds 
4271dca95dSAndy Shevchenko #include <linux/string_helpers.h>
431dff46d6SAlexey Dobriyan #include "kstrtox.h"
44aa46a63eSHarvey Harrison 
451da177e4SLinus Torvalds /**
461da177e4SLinus Torvalds  * simple_strtoull - convert a string to an unsigned long long
471da177e4SLinus Torvalds  * @cp: The start of the string
481da177e4SLinus Torvalds  * @endp: A pointer to the end of the parsed string will be placed here
491da177e4SLinus Torvalds  * @base: The number base to use
50462e4711SEldad Zack  *
51462e4711SEldad Zack  * This function is obsolete. Please use kstrtoull instead.
521da177e4SLinus Torvalds  */
531da177e4SLinus Torvalds unsigned long long simple_strtoull(const char *cp, char **endp, unsigned int base)
541da177e4SLinus Torvalds {
551dff46d6SAlexey Dobriyan 	unsigned long long result;
561dff46d6SAlexey Dobriyan 	unsigned int rv;
571da177e4SLinus Torvalds 
581dff46d6SAlexey Dobriyan 	cp = _parse_integer_fixup_radix(cp, &base);
591dff46d6SAlexey Dobriyan 	rv = _parse_integer(cp, base, &result);
601dff46d6SAlexey Dobriyan 	/* FIXME */
611dff46d6SAlexey Dobriyan 	cp += (rv & ~KSTRTOX_OVERFLOW);
62aa46a63eSHarvey Harrison 
631da177e4SLinus Torvalds 	if (endp)
641da177e4SLinus Torvalds 		*endp = (char *)cp;
657b9186f5SAndré Goddard Rosa 
661da177e4SLinus Torvalds 	return result;
671da177e4SLinus Torvalds }
681da177e4SLinus Torvalds EXPORT_SYMBOL(simple_strtoull);
691da177e4SLinus Torvalds 
701da177e4SLinus Torvalds /**
71922ac25cSAndré Goddard Rosa  * simple_strtoul - convert a string to an unsigned long
72922ac25cSAndré Goddard Rosa  * @cp: The start of the string
73922ac25cSAndré Goddard Rosa  * @endp: A pointer to the end of the parsed string will be placed here
74922ac25cSAndré Goddard Rosa  * @base: The number base to use
75462e4711SEldad Zack  *
76462e4711SEldad Zack  * This function is obsolete. Please use kstrtoul instead.
77922ac25cSAndré Goddard Rosa  */
78922ac25cSAndré Goddard Rosa unsigned long simple_strtoul(const char *cp, char **endp, unsigned int base)
79922ac25cSAndré Goddard Rosa {
80922ac25cSAndré Goddard Rosa 	return simple_strtoull(cp, endp, base);
81922ac25cSAndré Goddard Rosa }
82922ac25cSAndré Goddard Rosa EXPORT_SYMBOL(simple_strtoul);
83922ac25cSAndré Goddard Rosa 
84922ac25cSAndré Goddard Rosa /**
85922ac25cSAndré Goddard Rosa  * simple_strtol - convert a string to a signed long
86922ac25cSAndré Goddard Rosa  * @cp: The start of the string
87922ac25cSAndré Goddard Rosa  * @endp: A pointer to the end of the parsed string will be placed here
88922ac25cSAndré Goddard Rosa  * @base: The number base to use
89462e4711SEldad Zack  *
90462e4711SEldad Zack  * This function is obsolete. Please use kstrtol instead.
91922ac25cSAndré Goddard Rosa  */
92922ac25cSAndré Goddard Rosa long simple_strtol(const char *cp, char **endp, unsigned int base)
93922ac25cSAndré Goddard Rosa {
94922ac25cSAndré Goddard Rosa 	if (*cp == '-')
95922ac25cSAndré Goddard Rosa 		return -simple_strtoul(cp + 1, endp, base);
96922ac25cSAndré Goddard Rosa 
97922ac25cSAndré Goddard Rosa 	return simple_strtoul(cp, endp, base);
98922ac25cSAndré Goddard Rosa }
99922ac25cSAndré Goddard Rosa EXPORT_SYMBOL(simple_strtol);
100922ac25cSAndré Goddard Rosa 
101922ac25cSAndré Goddard Rosa /**
1021da177e4SLinus Torvalds  * simple_strtoll - convert a string to a signed long long
1031da177e4SLinus Torvalds  * @cp: The start of the string
1041da177e4SLinus Torvalds  * @endp: A pointer to the end of the parsed string will be placed here
1051da177e4SLinus Torvalds  * @base: The number base to use
106462e4711SEldad Zack  *
107462e4711SEldad Zack  * This function is obsolete. Please use kstrtoll instead.
1081da177e4SLinus Torvalds  */
1091da177e4SLinus Torvalds long long simple_strtoll(const char *cp, char **endp, unsigned int base)
1101da177e4SLinus Torvalds {
1111da177e4SLinus Torvalds 	if (*cp == '-')
1121da177e4SLinus Torvalds 		return -simple_strtoull(cp + 1, endp, base);
1137b9186f5SAndré Goddard Rosa 
1141da177e4SLinus Torvalds 	return simple_strtoull(cp, endp, base);
1151da177e4SLinus Torvalds }
11698d5ce0dSHans Verkuil EXPORT_SYMBOL(simple_strtoll);
1171da177e4SLinus Torvalds 
118cf3b429bSJoe Perches static noinline_for_stack
119cf3b429bSJoe Perches int skip_atoi(const char **s)
1201da177e4SLinus Torvalds {
1211da177e4SLinus Torvalds 	int i = 0;
1221da177e4SLinus Torvalds 
12343e5b666SRasmus Villemoes 	do {
1241da177e4SLinus Torvalds 		i = i*10 + *((*s)++) - '0';
12543e5b666SRasmus Villemoes 	} while (isdigit(**s));
1267b9186f5SAndré Goddard Rosa 
1271da177e4SLinus Torvalds 	return i;
1281da177e4SLinus Torvalds }
1291da177e4SLinus Torvalds 
1307c43d9a3SRasmus Villemoes /*
1317c43d9a3SRasmus Villemoes  * Decimal conversion is by far the most typical, and is used for
1327c43d9a3SRasmus Villemoes  * /proc and /sys data. This directly impacts e.g. top performance
1337c43d9a3SRasmus Villemoes  * with many processes running. We optimize it for speed by emitting
1347c43d9a3SRasmus Villemoes  * two characters at a time, using a 200 byte lookup table. This
1357c43d9a3SRasmus Villemoes  * roughly halves the number of multiplications compared to computing
1367c43d9a3SRasmus Villemoes  * the digits one at a time. Implementation strongly inspired by the
1377c43d9a3SRasmus Villemoes  * previous version, which in turn used ideas described at
1387c43d9a3SRasmus Villemoes  * <http://www.cs.uiowa.edu/~jones/bcd/divide.html> (with permission
1397c43d9a3SRasmus Villemoes  * from the author, Douglas W. Jones).
1407c43d9a3SRasmus Villemoes  *
1417c43d9a3SRasmus Villemoes  * It turns out there is precisely one 26 bit fixed-point
1427c43d9a3SRasmus Villemoes  * approximation a of 64/100 for which x/100 == (x * (u64)a) >> 32
1437c43d9a3SRasmus Villemoes  * holds for all x in [0, 10^8-1], namely a = 0x28f5c29. The actual
1447c43d9a3SRasmus Villemoes  * range happens to be somewhat larger (x <= 1073741898), but that's
1457c43d9a3SRasmus Villemoes  * irrelevant for our purpose.
1467c43d9a3SRasmus Villemoes  *
1477c43d9a3SRasmus Villemoes  * For dividing a number in the range [10^4, 10^6-1] by 100, we still
1487c43d9a3SRasmus Villemoes  * need a 32x32->64 bit multiply, so we simply use the same constant.
1497c43d9a3SRasmus Villemoes  *
1507c43d9a3SRasmus Villemoes  * For dividing a number in the range [100, 10^4-1] by 100, there are
1517c43d9a3SRasmus Villemoes  * several options. The simplest is (x * 0x147b) >> 19, which is valid
1527c43d9a3SRasmus Villemoes  * for all x <= 43698.
153133fd9f5SDenys Vlasenko  */
1544277eeddSDenis Vlasenko 
1557c43d9a3SRasmus Villemoes static const u16 decpair[100] = {
1567c43d9a3SRasmus Villemoes #define _(x) (__force u16) cpu_to_le16(((x % 10) | ((x / 10) << 8)) + 0x3030)
1577c43d9a3SRasmus Villemoes 	_( 0), _( 1), _( 2), _( 3), _( 4), _( 5), _( 6), _( 7), _( 8), _( 9),
1587c43d9a3SRasmus Villemoes 	_(10), _(11), _(12), _(13), _(14), _(15), _(16), _(17), _(18), _(19),
1597c43d9a3SRasmus Villemoes 	_(20), _(21), _(22), _(23), _(24), _(25), _(26), _(27), _(28), _(29),
1607c43d9a3SRasmus Villemoes 	_(30), _(31), _(32), _(33), _(34), _(35), _(36), _(37), _(38), _(39),
1617c43d9a3SRasmus Villemoes 	_(40), _(41), _(42), _(43), _(44), _(45), _(46), _(47), _(48), _(49),
1627c43d9a3SRasmus Villemoes 	_(50), _(51), _(52), _(53), _(54), _(55), _(56), _(57), _(58), _(59),
1637c43d9a3SRasmus Villemoes 	_(60), _(61), _(62), _(63), _(64), _(65), _(66), _(67), _(68), _(69),
1647c43d9a3SRasmus Villemoes 	_(70), _(71), _(72), _(73), _(74), _(75), _(76), _(77), _(78), _(79),
1657c43d9a3SRasmus Villemoes 	_(80), _(81), _(82), _(83), _(84), _(85), _(86), _(87), _(88), _(89),
1667c43d9a3SRasmus Villemoes 	_(90), _(91), _(92), _(93), _(94), _(95), _(96), _(97), _(98), _(99),
1677c43d9a3SRasmus Villemoes #undef _
1687c43d9a3SRasmus Villemoes };
1694277eeddSDenis Vlasenko 
1707b9186f5SAndré Goddard Rosa /*
1717c43d9a3SRasmus Villemoes  * This will print a single '0' even if r == 0, since we would
172675cf53cSRasmus Villemoes  * immediately jump to out_r where two 0s would be written but only
173675cf53cSRasmus Villemoes  * one of them accounted for in buf. This is needed by ip4_string
174675cf53cSRasmus Villemoes  * below. All other callers pass a non-zero value of r.
175133fd9f5SDenys Vlasenko */
176133fd9f5SDenys Vlasenko static noinline_for_stack
177133fd9f5SDenys Vlasenko char *put_dec_trunc8(char *buf, unsigned r)
178133fd9f5SDenys Vlasenko {
179133fd9f5SDenys Vlasenko 	unsigned q;
1804277eeddSDenis Vlasenko 
1817c43d9a3SRasmus Villemoes 	/* 1 <= r < 10^8 */
1827c43d9a3SRasmus Villemoes 	if (r < 100)
1837c43d9a3SRasmus Villemoes 		goto out_r;
184cb239d0aSGeorge Spelvin 
1857c43d9a3SRasmus Villemoes 	/* 100 <= r < 10^8 */
1867c43d9a3SRasmus Villemoes 	q = (r * (u64)0x28f5c29) >> 32;
1877c43d9a3SRasmus Villemoes 	*((u16 *)buf) = decpair[r - 100*q];
1887c43d9a3SRasmus Villemoes 	buf += 2;
1897c43d9a3SRasmus Villemoes 
1907c43d9a3SRasmus Villemoes 	/* 1 <= q < 10^6 */
1917c43d9a3SRasmus Villemoes 	if (q < 100)
1927c43d9a3SRasmus Villemoes 		goto out_q;
1937c43d9a3SRasmus Villemoes 
1947c43d9a3SRasmus Villemoes 	/*  100 <= q < 10^6 */
1957c43d9a3SRasmus Villemoes 	r = (q * (u64)0x28f5c29) >> 32;
1967c43d9a3SRasmus Villemoes 	*((u16 *)buf) = decpair[q - 100*r];
1977c43d9a3SRasmus Villemoes 	buf += 2;
1987c43d9a3SRasmus Villemoes 
1997c43d9a3SRasmus Villemoes 	/* 1 <= r < 10^4 */
2007c43d9a3SRasmus Villemoes 	if (r < 100)
2017c43d9a3SRasmus Villemoes 		goto out_r;
2027c43d9a3SRasmus Villemoes 
2037c43d9a3SRasmus Villemoes 	/* 100 <= r < 10^4 */
2047c43d9a3SRasmus Villemoes 	q = (r * 0x147b) >> 19;
2057c43d9a3SRasmus Villemoes 	*((u16 *)buf) = decpair[r - 100*q];
2067c43d9a3SRasmus Villemoes 	buf += 2;
2077c43d9a3SRasmus Villemoes out_q:
2087c43d9a3SRasmus Villemoes 	/* 1 <= q < 100 */
2097c43d9a3SRasmus Villemoes 	r = q;
2107c43d9a3SRasmus Villemoes out_r:
2117c43d9a3SRasmus Villemoes 	/* 1 <= r < 100 */
2127c43d9a3SRasmus Villemoes 	*((u16 *)buf) = decpair[r];
213675cf53cSRasmus Villemoes 	buf += r < 10 ? 1 : 2;
214133fd9f5SDenys Vlasenko 	return buf;
215133fd9f5SDenys Vlasenko }
216133fd9f5SDenys Vlasenko 
2177c43d9a3SRasmus Villemoes #if BITS_PER_LONG == 64 && BITS_PER_LONG_LONG == 64
2187c43d9a3SRasmus Villemoes static noinline_for_stack
2197c43d9a3SRasmus Villemoes char *put_dec_full8(char *buf, unsigned r)
2207c43d9a3SRasmus Villemoes {
2217c43d9a3SRasmus Villemoes 	unsigned q;
222133fd9f5SDenys Vlasenko 
2237c43d9a3SRasmus Villemoes 	/* 0 <= r < 10^8 */
2247c43d9a3SRasmus Villemoes 	q = (r * (u64)0x28f5c29) >> 32;
2257c43d9a3SRasmus Villemoes 	*((u16 *)buf) = decpair[r - 100*q];
2267c43d9a3SRasmus Villemoes 	buf += 2;
227133fd9f5SDenys Vlasenko 
2287c43d9a3SRasmus Villemoes 	/* 0 <= q < 10^6 */
2297c43d9a3SRasmus Villemoes 	r = (q * (u64)0x28f5c29) >> 32;
2307c43d9a3SRasmus Villemoes 	*((u16 *)buf) = decpair[q - 100*r];
2317c43d9a3SRasmus Villemoes 	buf += 2;
232133fd9f5SDenys Vlasenko 
2337c43d9a3SRasmus Villemoes 	/* 0 <= r < 10^4 */
2347c43d9a3SRasmus Villemoes 	q = (r * 0x147b) >> 19;
2357c43d9a3SRasmus Villemoes 	*((u16 *)buf) = decpair[r - 100*q];
2367c43d9a3SRasmus Villemoes 	buf += 2;
2377c43d9a3SRasmus Villemoes 
2387c43d9a3SRasmus Villemoes 	/* 0 <= q < 100 */
2397c43d9a3SRasmus Villemoes 	*((u16 *)buf) = decpair[q];
2407c43d9a3SRasmus Villemoes 	buf += 2;
2417c43d9a3SRasmus Villemoes 	return buf;
2427c43d9a3SRasmus Villemoes }
2437c43d9a3SRasmus Villemoes 
2447c43d9a3SRasmus Villemoes static noinline_for_stack
245133fd9f5SDenys Vlasenko char *put_dec(char *buf, unsigned long long n)
246133fd9f5SDenys Vlasenko {
247133fd9f5SDenys Vlasenko 	if (n >= 100*1000*1000)
2487c43d9a3SRasmus Villemoes 		buf = put_dec_full8(buf, do_div(n, 100*1000*1000));
2497c43d9a3SRasmus Villemoes 	/* 1 <= n <= 1.6e11 */
2507c43d9a3SRasmus Villemoes 	if (n >= 100*1000*1000)
2517c43d9a3SRasmus Villemoes 		buf = put_dec_full8(buf, do_div(n, 100*1000*1000));
2527c43d9a3SRasmus Villemoes 	/* 1 <= n < 1e8 */
253133fd9f5SDenys Vlasenko 	return put_dec_trunc8(buf, n);
254133fd9f5SDenys Vlasenko }
255133fd9f5SDenys Vlasenko 
2567c43d9a3SRasmus Villemoes #elif BITS_PER_LONG == 32 && BITS_PER_LONG_LONG == 64
257133fd9f5SDenys Vlasenko 
2587c43d9a3SRasmus Villemoes static void
2597c43d9a3SRasmus Villemoes put_dec_full4(char *buf, unsigned r)
260133fd9f5SDenys Vlasenko {
2617c43d9a3SRasmus Villemoes 	unsigned q;
2627c43d9a3SRasmus Villemoes 
2637c43d9a3SRasmus Villemoes 	/* 0 <= r < 10^4 */
2647c43d9a3SRasmus Villemoes 	q = (r * 0x147b) >> 19;
2657c43d9a3SRasmus Villemoes 	*((u16 *)buf) = decpair[r - 100*q];
2667c43d9a3SRasmus Villemoes 	buf += 2;
2677c43d9a3SRasmus Villemoes 	/* 0 <= q < 100 */
2687c43d9a3SRasmus Villemoes 	*((u16 *)buf) = decpair[q];
2692359172aSGeorge Spelvin }
2702359172aSGeorge Spelvin 
2712359172aSGeorge Spelvin /*
2722359172aSGeorge Spelvin  * Call put_dec_full4 on x % 10000, return x / 10000.
2732359172aSGeorge Spelvin  * The approximation x/10000 == (x * 0x346DC5D7) >> 43
2742359172aSGeorge Spelvin  * holds for all x < 1,128,869,999.  The largest value this
2752359172aSGeorge Spelvin  * helper will ever be asked to convert is 1,125,520,955.
2767c43d9a3SRasmus Villemoes  * (second call in the put_dec code, assuming n is all-ones).
2772359172aSGeorge Spelvin  */
2787c43d9a3SRasmus Villemoes static noinline_for_stack
2792359172aSGeorge Spelvin unsigned put_dec_helper4(char *buf, unsigned x)
2802359172aSGeorge Spelvin {
2812359172aSGeorge Spelvin         uint32_t q = (x * (uint64_t)0x346DC5D7) >> 43;
2822359172aSGeorge Spelvin 
2832359172aSGeorge Spelvin         put_dec_full4(buf, x - q * 10000);
2842359172aSGeorge Spelvin         return q;
285133fd9f5SDenys Vlasenko }
286133fd9f5SDenys Vlasenko 
287133fd9f5SDenys Vlasenko /* Based on code by Douglas W. Jones found at
288133fd9f5SDenys Vlasenko  * <http://www.cs.uiowa.edu/~jones/bcd/decimal.html#sixtyfour>
289133fd9f5SDenys Vlasenko  * (with permission from the author).
290133fd9f5SDenys Vlasenko  * Performs no 64-bit division and hence should be fast on 32-bit machines.
291133fd9f5SDenys Vlasenko  */
292133fd9f5SDenys Vlasenko static
293133fd9f5SDenys Vlasenko char *put_dec(char *buf, unsigned long long n)
294133fd9f5SDenys Vlasenko {
295133fd9f5SDenys Vlasenko 	uint32_t d3, d2, d1, q, h;
296133fd9f5SDenys Vlasenko 
297133fd9f5SDenys Vlasenko 	if (n < 100*1000*1000)
298133fd9f5SDenys Vlasenko 		return put_dec_trunc8(buf, n);
299133fd9f5SDenys Vlasenko 
300133fd9f5SDenys Vlasenko 	d1  = ((uint32_t)n >> 16); /* implicit "& 0xffff" */
301133fd9f5SDenys Vlasenko 	h   = (n >> 32);
302133fd9f5SDenys Vlasenko 	d2  = (h      ) & 0xffff;
303133fd9f5SDenys Vlasenko 	d3  = (h >> 16); /* implicit "& 0xffff" */
304133fd9f5SDenys Vlasenko 
3057c43d9a3SRasmus Villemoes 	/* n = 2^48 d3 + 2^32 d2 + 2^16 d1 + d0
3067c43d9a3SRasmus Villemoes 	     = 281_4749_7671_0656 d3 + 42_9496_7296 d2 + 6_5536 d1 + d0 */
307133fd9f5SDenys Vlasenko 	q   = 656 * d3 + 7296 * d2 + 5536 * d1 + ((uint32_t)n & 0xffff);
3082359172aSGeorge Spelvin 	q = put_dec_helper4(buf, q);
309133fd9f5SDenys Vlasenko 
3102359172aSGeorge Spelvin 	q += 7671 * d3 + 9496 * d2 + 6 * d1;
3112359172aSGeorge Spelvin 	q = put_dec_helper4(buf+4, q);
312133fd9f5SDenys Vlasenko 
3132359172aSGeorge Spelvin 	q += 4749 * d3 + 42 * d2;
3142359172aSGeorge Spelvin 	q = put_dec_helper4(buf+8, q);
315133fd9f5SDenys Vlasenko 
3162359172aSGeorge Spelvin 	q += 281 * d3;
3172359172aSGeorge Spelvin 	buf += 12;
3182359172aSGeorge Spelvin 	if (q)
3192359172aSGeorge Spelvin 		buf = put_dec_trunc8(buf, q);
3202359172aSGeorge Spelvin 	else while (buf[-1] == '0')
321133fd9f5SDenys Vlasenko 		--buf;
3227b9186f5SAndré Goddard Rosa 
3234277eeddSDenis Vlasenko 	return buf;
3244277eeddSDenis Vlasenko }
325133fd9f5SDenys Vlasenko 
326133fd9f5SDenys Vlasenko #endif
3274277eeddSDenis Vlasenko 
3281ac101a5SKAMEZAWA Hiroyuki /*
3291ac101a5SKAMEZAWA Hiroyuki  * Convert passed number to decimal string.
3301ac101a5SKAMEZAWA Hiroyuki  * Returns the length of string.  On buffer overflow, returns 0.
3311ac101a5SKAMEZAWA Hiroyuki  *
3321ac101a5SKAMEZAWA Hiroyuki  * If speed is not important, use snprintf(). It's easy to read the code.
3331ac101a5SKAMEZAWA Hiroyuki  */
3341ac101a5SKAMEZAWA Hiroyuki int num_to_str(char *buf, int size, unsigned long long num)
3351ac101a5SKAMEZAWA Hiroyuki {
3367c43d9a3SRasmus Villemoes 	/* put_dec requires 2-byte alignment of the buffer. */
3377c43d9a3SRasmus Villemoes 	char tmp[sizeof(num) * 3] __aligned(2);
3381ac101a5SKAMEZAWA Hiroyuki 	int idx, len;
3391ac101a5SKAMEZAWA Hiroyuki 
340133fd9f5SDenys Vlasenko 	/* put_dec() may work incorrectly for num = 0 (generate "", not "0") */
341133fd9f5SDenys Vlasenko 	if (num <= 9) {
342133fd9f5SDenys Vlasenko 		tmp[0] = '0' + num;
343133fd9f5SDenys Vlasenko 		len = 1;
344133fd9f5SDenys Vlasenko 	} else {
3451ac101a5SKAMEZAWA Hiroyuki 		len = put_dec(tmp, num) - tmp;
346133fd9f5SDenys Vlasenko 	}
3471ac101a5SKAMEZAWA Hiroyuki 
3481ac101a5SKAMEZAWA Hiroyuki 	if (len > size)
3491ac101a5SKAMEZAWA Hiroyuki 		return 0;
3501ac101a5SKAMEZAWA Hiroyuki 	for (idx = 0; idx < len; ++idx)
3511ac101a5SKAMEZAWA Hiroyuki 		buf[idx] = tmp[len - idx - 1];
3521ac101a5SKAMEZAWA Hiroyuki 	return len;
3531ac101a5SKAMEZAWA Hiroyuki }
3541ac101a5SKAMEZAWA Hiroyuki 
35551be17dfSRasmus Villemoes #define SIGN	1		/* unsigned/signed, must be 1 */
356d1c1b121SRasmus Villemoes #define LEFT	2		/* left justified */
3571da177e4SLinus Torvalds #define PLUS	4		/* show plus */
3581da177e4SLinus Torvalds #define SPACE	8		/* space if plus */
359d1c1b121SRasmus Villemoes #define ZEROPAD	16		/* pad with zero, must be 16 == '0' - ' ' */
360b89dc5d6SBjorn Helgaas #define SMALL	32		/* use lowercase in hex (must be 32 == 0x20) */
361b89dc5d6SBjorn Helgaas #define SPECIAL	64		/* prefix hex with "0x", octal with "0" */
3621da177e4SLinus Torvalds 
363fef20d9cSFrederic Weisbecker enum format_type {
364fef20d9cSFrederic Weisbecker 	FORMAT_TYPE_NONE, /* Just a string part */
365ed681a91SVegard Nossum 	FORMAT_TYPE_WIDTH,
366fef20d9cSFrederic Weisbecker 	FORMAT_TYPE_PRECISION,
367fef20d9cSFrederic Weisbecker 	FORMAT_TYPE_CHAR,
368fef20d9cSFrederic Weisbecker 	FORMAT_TYPE_STR,
369fef20d9cSFrederic Weisbecker 	FORMAT_TYPE_PTR,
370fef20d9cSFrederic Weisbecker 	FORMAT_TYPE_PERCENT_CHAR,
371fef20d9cSFrederic Weisbecker 	FORMAT_TYPE_INVALID,
372fef20d9cSFrederic Weisbecker 	FORMAT_TYPE_LONG_LONG,
373fef20d9cSFrederic Weisbecker 	FORMAT_TYPE_ULONG,
374fef20d9cSFrederic Weisbecker 	FORMAT_TYPE_LONG,
375a4e94ef0SZhaolei 	FORMAT_TYPE_UBYTE,
376a4e94ef0SZhaolei 	FORMAT_TYPE_BYTE,
377fef20d9cSFrederic Weisbecker 	FORMAT_TYPE_USHORT,
378fef20d9cSFrederic Weisbecker 	FORMAT_TYPE_SHORT,
379fef20d9cSFrederic Weisbecker 	FORMAT_TYPE_UINT,
380fef20d9cSFrederic Weisbecker 	FORMAT_TYPE_INT,
381fef20d9cSFrederic Weisbecker 	FORMAT_TYPE_SIZE_T,
382fef20d9cSFrederic Weisbecker 	FORMAT_TYPE_PTRDIFF
383fef20d9cSFrederic Weisbecker };
384fef20d9cSFrederic Weisbecker 
385fef20d9cSFrederic Weisbecker struct printf_spec {
386d0484193SRasmus Villemoes 	unsigned int	type:8;		/* format_type enum */
387d0484193SRasmus Villemoes 	signed int	field_width:24;	/* width of output field */
388d0484193SRasmus Villemoes 	unsigned int	flags:8;	/* flags to number() */
389d0484193SRasmus Villemoes 	unsigned int	base:8;		/* number base, 8, 10 or 16 only */
390d0484193SRasmus Villemoes 	signed int	precision:16;	/* # of digits/chars */
391d0484193SRasmus Villemoes } __packed;
3924d72ba01SRasmus Villemoes #define FIELD_WIDTH_MAX ((1 << 23) - 1)
3934d72ba01SRasmus Villemoes #define PRECISION_MAX ((1 << 15) - 1)
394fef20d9cSFrederic Weisbecker 
395cf3b429bSJoe Perches static noinline_for_stack
396cf3b429bSJoe Perches char *number(char *buf, char *end, unsigned long long num,
397fef20d9cSFrederic Weisbecker 	     struct printf_spec spec)
3981da177e4SLinus Torvalds {
3997c43d9a3SRasmus Villemoes 	/* put_dec requires 2-byte alignment of the buffer. */
4007c43d9a3SRasmus Villemoes 	char tmp[3 * sizeof(num)] __aligned(2);
4019b706aeeSDenys Vlasenko 	char sign;
4029b706aeeSDenys Vlasenko 	char locase;
403fef20d9cSFrederic Weisbecker 	int need_pfx = ((spec.flags & SPECIAL) && spec.base != 10);
4041da177e4SLinus Torvalds 	int i;
4057c203422SPierre Carrier 	bool is_zero = num == 0LL;
4061c7a8e62SRasmus Villemoes 	int field_width = spec.field_width;
4071c7a8e62SRasmus Villemoes 	int precision = spec.precision;
4081da177e4SLinus Torvalds 
409d0484193SRasmus Villemoes 	BUILD_BUG_ON(sizeof(struct printf_spec) != 8);
410d0484193SRasmus Villemoes 
4119b706aeeSDenys Vlasenko 	/* locase = 0 or 0x20. ORing digits or letters with 'locase'
4129b706aeeSDenys Vlasenko 	 * produces same digits or (maybe lowercased) letters */
413fef20d9cSFrederic Weisbecker 	locase = (spec.flags & SMALL);
414fef20d9cSFrederic Weisbecker 	if (spec.flags & LEFT)
415fef20d9cSFrederic Weisbecker 		spec.flags &= ~ZEROPAD;
4161da177e4SLinus Torvalds 	sign = 0;
417fef20d9cSFrederic Weisbecker 	if (spec.flags & SIGN) {
4181da177e4SLinus Torvalds 		if ((signed long long)num < 0) {
4191da177e4SLinus Torvalds 			sign = '-';
4201da177e4SLinus Torvalds 			num = -(signed long long)num;
4211c7a8e62SRasmus Villemoes 			field_width--;
422fef20d9cSFrederic Weisbecker 		} else if (spec.flags & PLUS) {
4231da177e4SLinus Torvalds 			sign = '+';
4241c7a8e62SRasmus Villemoes 			field_width--;
425fef20d9cSFrederic Weisbecker 		} else if (spec.flags & SPACE) {
4261da177e4SLinus Torvalds 			sign = ' ';
4271c7a8e62SRasmus Villemoes 			field_width--;
4281da177e4SLinus Torvalds 		}
4291da177e4SLinus Torvalds 	}
430b39a7340SDenis Vlasenko 	if (need_pfx) {
431fef20d9cSFrederic Weisbecker 		if (spec.base == 16)
4321c7a8e62SRasmus Villemoes 			field_width -= 2;
4337c203422SPierre Carrier 		else if (!is_zero)
4341c7a8e62SRasmus Villemoes 			field_width--;
4351da177e4SLinus Torvalds 	}
436b39a7340SDenis Vlasenko 
437b39a7340SDenis Vlasenko 	/* generate full string in tmp[], in reverse order */
4381da177e4SLinus Torvalds 	i = 0;
439133fd9f5SDenys Vlasenko 	if (num < spec.base)
4403ea8d440SRasmus Villemoes 		tmp[i++] = hex_asc_upper[num] | locase;
441fef20d9cSFrederic Weisbecker 	else if (spec.base != 10) { /* 8 or 16 */
442fef20d9cSFrederic Weisbecker 		int mask = spec.base - 1;
443b39a7340SDenis Vlasenko 		int shift = 3;
4447b9186f5SAndré Goddard Rosa 
4457b9186f5SAndré Goddard Rosa 		if (spec.base == 16)
4467b9186f5SAndré Goddard Rosa 			shift = 4;
447b39a7340SDenis Vlasenko 		do {
4483ea8d440SRasmus Villemoes 			tmp[i++] = (hex_asc_upper[((unsigned char)num) & mask] | locase);
449b39a7340SDenis Vlasenko 			num >>= shift;
450b39a7340SDenis Vlasenko 		} while (num);
4514277eeddSDenis Vlasenko 	} else { /* base 10 */
4524277eeddSDenis Vlasenko 		i = put_dec(tmp, num) - tmp;
4534277eeddSDenis Vlasenko 	}
454b39a7340SDenis Vlasenko 
455b39a7340SDenis Vlasenko 	/* printing 100 using %2d gives "100", not "00" */
4561c7a8e62SRasmus Villemoes 	if (i > precision)
4571c7a8e62SRasmus Villemoes 		precision = i;
458b39a7340SDenis Vlasenko 	/* leading space padding */
4591c7a8e62SRasmus Villemoes 	field_width -= precision;
46051be17dfSRasmus Villemoes 	if (!(spec.flags & (ZEROPAD | LEFT))) {
4611c7a8e62SRasmus Villemoes 		while (--field_width >= 0) {
462f796937aSJeremy Fitzhardinge 			if (buf < end)
4631da177e4SLinus Torvalds 				*buf = ' ';
4641da177e4SLinus Torvalds 			++buf;
4651da177e4SLinus Torvalds 		}
4661da177e4SLinus Torvalds 	}
467b39a7340SDenis Vlasenko 	/* sign */
4681da177e4SLinus Torvalds 	if (sign) {
469f796937aSJeremy Fitzhardinge 		if (buf < end)
4701da177e4SLinus Torvalds 			*buf = sign;
4711da177e4SLinus Torvalds 		++buf;
4721da177e4SLinus Torvalds 	}
473b39a7340SDenis Vlasenko 	/* "0x" / "0" prefix */
474b39a7340SDenis Vlasenko 	if (need_pfx) {
4757c203422SPierre Carrier 		if (spec.base == 16 || !is_zero) {
476f796937aSJeremy Fitzhardinge 			if (buf < end)
4771da177e4SLinus Torvalds 				*buf = '0';
4781da177e4SLinus Torvalds 			++buf;
4797c203422SPierre Carrier 		}
480fef20d9cSFrederic Weisbecker 		if (spec.base == 16) {
481f796937aSJeremy Fitzhardinge 			if (buf < end)
4829b706aeeSDenys Vlasenko 				*buf = ('X' | locase);
4831da177e4SLinus Torvalds 			++buf;
4841da177e4SLinus Torvalds 		}
4851da177e4SLinus Torvalds 	}
486b39a7340SDenis Vlasenko 	/* zero or space padding */
487fef20d9cSFrederic Weisbecker 	if (!(spec.flags & LEFT)) {
488d1c1b121SRasmus Villemoes 		char c = ' ' + (spec.flags & ZEROPAD);
489d1c1b121SRasmus Villemoes 		BUILD_BUG_ON(' ' + ZEROPAD != '0');
4901c7a8e62SRasmus Villemoes 		while (--field_width >= 0) {
491f796937aSJeremy Fitzhardinge 			if (buf < end)
4921da177e4SLinus Torvalds 				*buf = c;
4931da177e4SLinus Torvalds 			++buf;
4941da177e4SLinus Torvalds 		}
4951da177e4SLinus Torvalds 	}
496b39a7340SDenis Vlasenko 	/* hmm even more zero padding? */
4971c7a8e62SRasmus Villemoes 	while (i <= --precision) {
498f796937aSJeremy Fitzhardinge 		if (buf < end)
4991da177e4SLinus Torvalds 			*buf = '0';
5001da177e4SLinus Torvalds 		++buf;
5011da177e4SLinus Torvalds 	}
502b39a7340SDenis Vlasenko 	/* actual digits of result */
503b39a7340SDenis Vlasenko 	while (--i >= 0) {
504f796937aSJeremy Fitzhardinge 		if (buf < end)
5051da177e4SLinus Torvalds 			*buf = tmp[i];
5061da177e4SLinus Torvalds 		++buf;
5071da177e4SLinus Torvalds 	}
508b39a7340SDenis Vlasenko 	/* trailing space padding */
5091c7a8e62SRasmus Villemoes 	while (--field_width >= 0) {
510f796937aSJeremy Fitzhardinge 		if (buf < end)
5111da177e4SLinus Torvalds 			*buf = ' ';
5121da177e4SLinus Torvalds 		++buf;
5131da177e4SLinus Torvalds 	}
5147b9186f5SAndré Goddard Rosa 
5151da177e4SLinus Torvalds 	return buf;
5161da177e4SLinus Torvalds }
5171da177e4SLinus Torvalds 
5183cab1e71SAndy Shevchenko static noinline_for_stack
5193cab1e71SAndy Shevchenko char *special_hex_number(char *buf, char *end, unsigned long long num, int size)
5203cab1e71SAndy Shevchenko {
5213cab1e71SAndy Shevchenko 	struct printf_spec spec;
5223cab1e71SAndy Shevchenko 
5233cab1e71SAndy Shevchenko 	spec.type = FORMAT_TYPE_PTR;
5243cab1e71SAndy Shevchenko 	spec.field_width = 2 + 2 * size;	/* 0x + hex */
5253cab1e71SAndy Shevchenko 	spec.flags = SPECIAL | SMALL | ZEROPAD;
5263cab1e71SAndy Shevchenko 	spec.base = 16;
5273cab1e71SAndy Shevchenko 	spec.precision = -1;
5283cab1e71SAndy Shevchenko 
5293cab1e71SAndy Shevchenko 	return number(buf, end, num, spec);
5303cab1e71SAndy Shevchenko }
5313cab1e71SAndy Shevchenko 
532cfccde04SRasmus Villemoes static void move_right(char *buf, char *end, unsigned len, unsigned spaces)
5334b6ccca7SAl Viro {
5344b6ccca7SAl Viro 	size_t size;
5354b6ccca7SAl Viro 	if (buf >= end)	/* nowhere to put anything */
5364b6ccca7SAl Viro 		return;
5374b6ccca7SAl Viro 	size = end - buf;
5384b6ccca7SAl Viro 	if (size <= spaces) {
5394b6ccca7SAl Viro 		memset(buf, ' ', size);
5404b6ccca7SAl Viro 		return;
5414b6ccca7SAl Viro 	}
5424b6ccca7SAl Viro 	if (len) {
5434b6ccca7SAl Viro 		if (len > size - spaces)
5444b6ccca7SAl Viro 			len = size - spaces;
5454b6ccca7SAl Viro 		memmove(buf + spaces, buf, len);
5464b6ccca7SAl Viro 	}
5474b6ccca7SAl Viro 	memset(buf, ' ', spaces);
5484b6ccca7SAl Viro }
5494b6ccca7SAl Viro 
550cfccde04SRasmus Villemoes /*
551cfccde04SRasmus Villemoes  * Handle field width padding for a string.
552cfccde04SRasmus Villemoes  * @buf: current buffer position
553cfccde04SRasmus Villemoes  * @n: length of string
554cfccde04SRasmus Villemoes  * @end: end of output buffer
555cfccde04SRasmus Villemoes  * @spec: for field width and flags
556cfccde04SRasmus Villemoes  * Returns: new buffer position after padding.
557cfccde04SRasmus Villemoes  */
558cfccde04SRasmus Villemoes static noinline_for_stack
559cfccde04SRasmus Villemoes char *widen_string(char *buf, int n, char *end, struct printf_spec spec)
560cfccde04SRasmus Villemoes {
561cfccde04SRasmus Villemoes 	unsigned spaces;
562cfccde04SRasmus Villemoes 
563cfccde04SRasmus Villemoes 	if (likely(n >= spec.field_width))
564cfccde04SRasmus Villemoes 		return buf;
565cfccde04SRasmus Villemoes 	/* we want to pad the sucker */
566cfccde04SRasmus Villemoes 	spaces = spec.field_width - n;
567cfccde04SRasmus Villemoes 	if (!(spec.flags & LEFT)) {
568cfccde04SRasmus Villemoes 		move_right(buf - n, end, n, spaces);
569cfccde04SRasmus Villemoes 		return buf + spaces;
570cfccde04SRasmus Villemoes 	}
571cfccde04SRasmus Villemoes 	while (spaces--) {
572cfccde04SRasmus Villemoes 		if (buf < end)
573cfccde04SRasmus Villemoes 			*buf = ' ';
574cfccde04SRasmus Villemoes 		++buf;
575cfccde04SRasmus Villemoes 	}
576cfccde04SRasmus Villemoes 	return buf;
577cfccde04SRasmus Villemoes }
578cfccde04SRasmus Villemoes 
5794b6ccca7SAl Viro static noinline_for_stack
58095508cfaSRasmus Villemoes char *string(char *buf, char *end, const char *s, struct printf_spec spec)
58195508cfaSRasmus Villemoes {
58234fc8b90SRasmus Villemoes 	int len = 0;
58334fc8b90SRasmus Villemoes 	size_t lim = spec.precision;
58495508cfaSRasmus Villemoes 
58595508cfaSRasmus Villemoes 	if ((unsigned long)s < PAGE_SIZE)
58695508cfaSRasmus Villemoes 		s = "(null)";
58795508cfaSRasmus Villemoes 
58834fc8b90SRasmus Villemoes 	while (lim--) {
58934fc8b90SRasmus Villemoes 		char c = *s++;
59034fc8b90SRasmus Villemoes 		if (!c)
59134fc8b90SRasmus Villemoes 			break;
59295508cfaSRasmus Villemoes 		if (buf < end)
59334fc8b90SRasmus Villemoes 			*buf = c;
59495508cfaSRasmus Villemoes 		++buf;
59534fc8b90SRasmus Villemoes 		++len;
59695508cfaSRasmus Villemoes 	}
59734fc8b90SRasmus Villemoes 	return widen_string(buf, len, end, spec);
59895508cfaSRasmus Villemoes }
59995508cfaSRasmus Villemoes 
60095508cfaSRasmus Villemoes static noinline_for_stack
6014b6ccca7SAl Viro char *dentry_name(char *buf, char *end, const struct dentry *d, struct printf_spec spec,
6024b6ccca7SAl Viro 		  const char *fmt)
6034b6ccca7SAl Viro {
6044b6ccca7SAl Viro 	const char *array[4], *s;
6054b6ccca7SAl Viro 	const struct dentry *p;
6064b6ccca7SAl Viro 	int depth;
6074b6ccca7SAl Viro 	int i, n;
6084b6ccca7SAl Viro 
6094b6ccca7SAl Viro 	switch (fmt[1]) {
6104b6ccca7SAl Viro 		case '2': case '3': case '4':
6114b6ccca7SAl Viro 			depth = fmt[1] - '0';
6124b6ccca7SAl Viro 			break;
6134b6ccca7SAl Viro 		default:
6144b6ccca7SAl Viro 			depth = 1;
6154b6ccca7SAl Viro 	}
6164b6ccca7SAl Viro 
6174b6ccca7SAl Viro 	rcu_read_lock();
6184b6ccca7SAl Viro 	for (i = 0; i < depth; i++, d = p) {
6194b6ccca7SAl Viro 		p = ACCESS_ONCE(d->d_parent);
6204b6ccca7SAl Viro 		array[i] = ACCESS_ONCE(d->d_name.name);
6214b6ccca7SAl Viro 		if (p == d) {
6224b6ccca7SAl Viro 			if (i)
6234b6ccca7SAl Viro 				array[i] = "";
6244b6ccca7SAl Viro 			i++;
6254b6ccca7SAl Viro 			break;
6264b6ccca7SAl Viro 		}
6274b6ccca7SAl Viro 	}
6284b6ccca7SAl Viro 	s = array[--i];
6294b6ccca7SAl Viro 	for (n = 0; n != spec.precision; n++, buf++) {
6304b6ccca7SAl Viro 		char c = *s++;
6314b6ccca7SAl Viro 		if (!c) {
6324b6ccca7SAl Viro 			if (!i)
6334b6ccca7SAl Viro 				break;
6344b6ccca7SAl Viro 			c = '/';
6354b6ccca7SAl Viro 			s = array[--i];
6364b6ccca7SAl Viro 		}
6374b6ccca7SAl Viro 		if (buf < end)
6384b6ccca7SAl Viro 			*buf = c;
6394b6ccca7SAl Viro 	}
6404b6ccca7SAl Viro 	rcu_read_unlock();
641cfccde04SRasmus Villemoes 	return widen_string(buf, n, end, spec);
6424b6ccca7SAl Viro }
6434b6ccca7SAl Viro 
6441031bc58SDmitry Monakhov #ifdef CONFIG_BLOCK
6451031bc58SDmitry Monakhov static noinline_for_stack
6461031bc58SDmitry Monakhov char *bdev_name(char *buf, char *end, struct block_device *bdev,
6471031bc58SDmitry Monakhov 		struct printf_spec spec, const char *fmt)
6481031bc58SDmitry Monakhov {
6491031bc58SDmitry Monakhov 	struct gendisk *hd = bdev->bd_disk;
6501031bc58SDmitry Monakhov 
6511031bc58SDmitry Monakhov 	buf = string(buf, end, hd->disk_name, spec);
6521031bc58SDmitry Monakhov 	if (bdev->bd_part->partno) {
6531031bc58SDmitry Monakhov 		if (isdigit(hd->disk_name[strlen(hd->disk_name)-1])) {
6541031bc58SDmitry Monakhov 			if (buf < end)
6551031bc58SDmitry Monakhov 				*buf = 'p';
6561031bc58SDmitry Monakhov 			buf++;
6571031bc58SDmitry Monakhov 		}
6581031bc58SDmitry Monakhov 		buf = number(buf, end, bdev->bd_part->partno, spec);
6591031bc58SDmitry Monakhov 	}
6601031bc58SDmitry Monakhov 	return buf;
6611031bc58SDmitry Monakhov }
6621031bc58SDmitry Monakhov #endif
6631031bc58SDmitry Monakhov 
664cf3b429bSJoe Perches static noinline_for_stack
665cf3b429bSJoe Perches char *symbol_string(char *buf, char *end, void *ptr,
666b0d33c2bSJoe Perches 		    struct printf_spec spec, const char *fmt)
6670fe1ef24SLinus Torvalds {
668b0d33c2bSJoe Perches 	unsigned long value;
6690fe1ef24SLinus Torvalds #ifdef CONFIG_KALLSYMS
6700fe1ef24SLinus Torvalds 	char sym[KSYM_SYMBOL_LEN];
671b0d33c2bSJoe Perches #endif
672b0d33c2bSJoe Perches 
673b0d33c2bSJoe Perches 	if (fmt[1] == 'R')
674b0d33c2bSJoe Perches 		ptr = __builtin_extract_return_addr(ptr);
675b0d33c2bSJoe Perches 	value = (unsigned long)ptr;
676b0d33c2bSJoe Perches 
677b0d33c2bSJoe Perches #ifdef CONFIG_KALLSYMS
678b0d33c2bSJoe Perches 	if (*fmt == 'B')
6790f77a8d3SNamhyung Kim 		sprint_backtrace(sym, value);
680b0d33c2bSJoe Perches 	else if (*fmt != 'f' && *fmt != 's')
6810fe1ef24SLinus Torvalds 		sprint_symbol(sym, value);
6820c8b946eSFrederic Weisbecker 	else
6834796dd20SStephen Boyd 		sprint_symbol_no_offset(sym, value);
6847b9186f5SAndré Goddard Rosa 
685fef20d9cSFrederic Weisbecker 	return string(buf, end, sym, spec);
6860fe1ef24SLinus Torvalds #else
6873cab1e71SAndy Shevchenko 	return special_hex_number(buf, end, value, sizeof(void *));
6880fe1ef24SLinus Torvalds #endif
6890fe1ef24SLinus Torvalds }
6900fe1ef24SLinus Torvalds 
691cf3b429bSJoe Perches static noinline_for_stack
692cf3b429bSJoe Perches char *resource_string(char *buf, char *end, struct resource *res,
693fd95541eSBjorn Helgaas 		      struct printf_spec spec, const char *fmt)
694332d2e78SLinus Torvalds {
695332d2e78SLinus Torvalds #ifndef IO_RSRC_PRINTK_SIZE
69628405372SBjorn Helgaas #define IO_RSRC_PRINTK_SIZE	6
697332d2e78SLinus Torvalds #endif
698332d2e78SLinus Torvalds 
699332d2e78SLinus Torvalds #ifndef MEM_RSRC_PRINTK_SIZE
70028405372SBjorn Helgaas #define MEM_RSRC_PRINTK_SIZE	10
701332d2e78SLinus Torvalds #endif
7024da0b66cSBjorn Helgaas 	static const struct printf_spec io_spec = {
703fef20d9cSFrederic Weisbecker 		.base = 16,
7044da0b66cSBjorn Helgaas 		.field_width = IO_RSRC_PRINTK_SIZE,
705fef20d9cSFrederic Weisbecker 		.precision = -1,
706fef20d9cSFrederic Weisbecker 		.flags = SPECIAL | SMALL | ZEROPAD,
707fef20d9cSFrederic Weisbecker 	};
7084da0b66cSBjorn Helgaas 	static const struct printf_spec mem_spec = {
7094da0b66cSBjorn Helgaas 		.base = 16,
7104da0b66cSBjorn Helgaas 		.field_width = MEM_RSRC_PRINTK_SIZE,
7114da0b66cSBjorn Helgaas 		.precision = -1,
7124da0b66cSBjorn Helgaas 		.flags = SPECIAL | SMALL | ZEROPAD,
7134da0b66cSBjorn Helgaas 	};
7140f4050c7SBjorn Helgaas 	static const struct printf_spec bus_spec = {
7150f4050c7SBjorn Helgaas 		.base = 16,
7160f4050c7SBjorn Helgaas 		.field_width = 2,
7170f4050c7SBjorn Helgaas 		.precision = -1,
7180f4050c7SBjorn Helgaas 		.flags = SMALL | ZEROPAD,
7190f4050c7SBjorn Helgaas 	};
7204da0b66cSBjorn Helgaas 	static const struct printf_spec dec_spec = {
721c91d3376SBjorn Helgaas 		.base = 10,
722c91d3376SBjorn Helgaas 		.precision = -1,
723c91d3376SBjorn Helgaas 		.flags = 0,
724c91d3376SBjorn Helgaas 	};
7254da0b66cSBjorn Helgaas 	static const struct printf_spec str_spec = {
726fd95541eSBjorn Helgaas 		.field_width = -1,
727fd95541eSBjorn Helgaas 		.precision = 10,
728fd95541eSBjorn Helgaas 		.flags = LEFT,
729fd95541eSBjorn Helgaas 	};
7304da0b66cSBjorn Helgaas 	static const struct printf_spec flag_spec = {
731fd95541eSBjorn Helgaas 		.base = 16,
732fd95541eSBjorn Helgaas 		.precision = -1,
733fd95541eSBjorn Helgaas 		.flags = SPECIAL | SMALL,
734fd95541eSBjorn Helgaas 	};
735c7dabef8SBjorn Helgaas 
736c7dabef8SBjorn Helgaas 	/* 32-bit res (sizeof==4): 10 chars in dec, 10 in hex ("0x" + 8)
737c7dabef8SBjorn Helgaas 	 * 64-bit res (sizeof==8): 20 chars in dec, 18 in hex ("0x" + 16) */
738c7dabef8SBjorn Helgaas #define RSRC_BUF_SIZE		((2 * sizeof(resource_size_t)) + 4)
739c7dabef8SBjorn Helgaas #define FLAG_BUF_SIZE		(2 * sizeof(res->flags))
7409d7cca04SBjorn Helgaas #define DECODED_BUF_SIZE	sizeof("[mem - 64bit pref window disabled]")
741c7dabef8SBjorn Helgaas #define RAW_BUF_SIZE		sizeof("[mem - flags 0x]")
742c7dabef8SBjorn Helgaas 	char sym[max(2*RSRC_BUF_SIZE + DECODED_BUF_SIZE,
743c7dabef8SBjorn Helgaas 		     2*RSRC_BUF_SIZE + FLAG_BUF_SIZE + RAW_BUF_SIZE)];
744c7dabef8SBjorn Helgaas 
745332d2e78SLinus Torvalds 	char *p = sym, *pend = sym + sizeof(sym);
746c7dabef8SBjorn Helgaas 	int decode = (fmt[0] == 'R') ? 1 : 0;
7474da0b66cSBjorn Helgaas 	const struct printf_spec *specp;
748332d2e78SLinus Torvalds 
749332d2e78SLinus Torvalds 	*p++ = '[';
7504da0b66cSBjorn Helgaas 	if (res->flags & IORESOURCE_IO) {
751fd95541eSBjorn Helgaas 		p = string(p, pend, "io  ", str_spec);
7524da0b66cSBjorn Helgaas 		specp = &io_spec;
7534da0b66cSBjorn Helgaas 	} else if (res->flags & IORESOURCE_MEM) {
754fd95541eSBjorn Helgaas 		p = string(p, pend, "mem ", str_spec);
7554da0b66cSBjorn Helgaas 		specp = &mem_spec;
7564da0b66cSBjorn Helgaas 	} else if (res->flags & IORESOURCE_IRQ) {
757fd95541eSBjorn Helgaas 		p = string(p, pend, "irq ", str_spec);
7584da0b66cSBjorn Helgaas 		specp = &dec_spec;
7594da0b66cSBjorn Helgaas 	} else if (res->flags & IORESOURCE_DMA) {
760fd95541eSBjorn Helgaas 		p = string(p, pend, "dma ", str_spec);
7614da0b66cSBjorn Helgaas 		specp = &dec_spec;
7620f4050c7SBjorn Helgaas 	} else if (res->flags & IORESOURCE_BUS) {
7630f4050c7SBjorn Helgaas 		p = string(p, pend, "bus ", str_spec);
7640f4050c7SBjorn Helgaas 		specp = &bus_spec;
7654da0b66cSBjorn Helgaas 	} else {
766c7dabef8SBjorn Helgaas 		p = string(p, pend, "??? ", str_spec);
7674da0b66cSBjorn Helgaas 		specp = &mem_spec;
768c7dabef8SBjorn Helgaas 		decode = 0;
769fd95541eSBjorn Helgaas 	}
770d19cb803SBjorn Helgaas 	if (decode && res->flags & IORESOURCE_UNSET) {
771d19cb803SBjorn Helgaas 		p = string(p, pend, "size ", str_spec);
772d19cb803SBjorn Helgaas 		p = number(p, pend, resource_size(res), *specp);
773d19cb803SBjorn Helgaas 	} else {
7744da0b66cSBjorn Helgaas 		p = number(p, pend, res->start, *specp);
775c91d3376SBjorn Helgaas 		if (res->start != res->end) {
776332d2e78SLinus Torvalds 			*p++ = '-';
7774da0b66cSBjorn Helgaas 			p = number(p, pend, res->end, *specp);
778c91d3376SBjorn Helgaas 		}
779d19cb803SBjorn Helgaas 	}
780c7dabef8SBjorn Helgaas 	if (decode) {
781fd95541eSBjorn Helgaas 		if (res->flags & IORESOURCE_MEM_64)
782fd95541eSBjorn Helgaas 			p = string(p, pend, " 64bit", str_spec);
783fd95541eSBjorn Helgaas 		if (res->flags & IORESOURCE_PREFETCH)
784fd95541eSBjorn Helgaas 			p = string(p, pend, " pref", str_spec);
7859d7cca04SBjorn Helgaas 		if (res->flags & IORESOURCE_WINDOW)
7869d7cca04SBjorn Helgaas 			p = string(p, pend, " window", str_spec);
787fd95541eSBjorn Helgaas 		if (res->flags & IORESOURCE_DISABLED)
788fd95541eSBjorn Helgaas 			p = string(p, pend, " disabled", str_spec);
789c7dabef8SBjorn Helgaas 	} else {
790fd95541eSBjorn Helgaas 		p = string(p, pend, " flags ", str_spec);
791c7dabef8SBjorn Helgaas 		p = number(p, pend, res->flags, flag_spec);
792fd95541eSBjorn Helgaas 	}
793332d2e78SLinus Torvalds 	*p++ = ']';
794c7dabef8SBjorn Helgaas 	*p = '\0';
795332d2e78SLinus Torvalds 
796fef20d9cSFrederic Weisbecker 	return string(buf, end, sym, spec);
797332d2e78SLinus Torvalds }
798332d2e78SLinus Torvalds 
799cf3b429bSJoe Perches static noinline_for_stack
80031550a16SAndy Shevchenko char *hex_string(char *buf, char *end, u8 *addr, struct printf_spec spec,
80131550a16SAndy Shevchenko 		 const char *fmt)
80231550a16SAndy Shevchenko {
803360603a1SSteven Rostedt 	int i, len = 1;		/* if we pass '%ph[CDN]', field width remains
80431550a16SAndy Shevchenko 				   negative value, fallback to the default */
80531550a16SAndy Shevchenko 	char separator;
80631550a16SAndy Shevchenko 
80731550a16SAndy Shevchenko 	if (spec.field_width == 0)
80831550a16SAndy Shevchenko 		/* nothing to print */
80931550a16SAndy Shevchenko 		return buf;
81031550a16SAndy Shevchenko 
81131550a16SAndy Shevchenko 	if (ZERO_OR_NULL_PTR(addr))
81231550a16SAndy Shevchenko 		/* NULL pointer */
81331550a16SAndy Shevchenko 		return string(buf, end, NULL, spec);
81431550a16SAndy Shevchenko 
81531550a16SAndy Shevchenko 	switch (fmt[1]) {
81631550a16SAndy Shevchenko 	case 'C':
81731550a16SAndy Shevchenko 		separator = ':';
81831550a16SAndy Shevchenko 		break;
81931550a16SAndy Shevchenko 	case 'D':
82031550a16SAndy Shevchenko 		separator = '-';
82131550a16SAndy Shevchenko 		break;
82231550a16SAndy Shevchenko 	case 'N':
82331550a16SAndy Shevchenko 		separator = 0;
82431550a16SAndy Shevchenko 		break;
82531550a16SAndy Shevchenko 	default:
82631550a16SAndy Shevchenko 		separator = ' ';
82731550a16SAndy Shevchenko 		break;
82831550a16SAndy Shevchenko 	}
82931550a16SAndy Shevchenko 
83031550a16SAndy Shevchenko 	if (spec.field_width > 0)
83131550a16SAndy Shevchenko 		len = min_t(int, spec.field_width, 64);
83231550a16SAndy Shevchenko 
8339c98f235SRasmus Villemoes 	for (i = 0; i < len; ++i) {
8349c98f235SRasmus Villemoes 		if (buf < end)
8359c98f235SRasmus Villemoes 			*buf = hex_asc_hi(addr[i]);
8369c98f235SRasmus Villemoes 		++buf;
8379c98f235SRasmus Villemoes 		if (buf < end)
8389c98f235SRasmus Villemoes 			*buf = hex_asc_lo(addr[i]);
8399c98f235SRasmus Villemoes 		++buf;
84031550a16SAndy Shevchenko 
8419c98f235SRasmus Villemoes 		if (separator && i != len - 1) {
8429c98f235SRasmus Villemoes 			if (buf < end)
8439c98f235SRasmus Villemoes 				*buf = separator;
8449c98f235SRasmus Villemoes 			++buf;
8459c98f235SRasmus Villemoes 		}
84631550a16SAndy Shevchenko 	}
84731550a16SAndy Shevchenko 
84831550a16SAndy Shevchenko 	return buf;
84931550a16SAndy Shevchenko }
85031550a16SAndy Shevchenko 
85131550a16SAndy Shevchenko static noinline_for_stack
852dbc760bcSTejun Heo char *bitmap_string(char *buf, char *end, unsigned long *bitmap,
853dbc760bcSTejun Heo 		    struct printf_spec spec, const char *fmt)
854dbc760bcSTejun Heo {
855dbc760bcSTejun Heo 	const int CHUNKSZ = 32;
856dbc760bcSTejun Heo 	int nr_bits = max_t(int, spec.field_width, 0);
857dbc760bcSTejun Heo 	int i, chunksz;
858dbc760bcSTejun Heo 	bool first = true;
859dbc760bcSTejun Heo 
860dbc760bcSTejun Heo 	/* reused to print numbers */
861dbc760bcSTejun Heo 	spec = (struct printf_spec){ .flags = SMALL | ZEROPAD, .base = 16 };
862dbc760bcSTejun Heo 
863dbc760bcSTejun Heo 	chunksz = nr_bits & (CHUNKSZ - 1);
864dbc760bcSTejun Heo 	if (chunksz == 0)
865dbc760bcSTejun Heo 		chunksz = CHUNKSZ;
866dbc760bcSTejun Heo 
867dbc760bcSTejun Heo 	i = ALIGN(nr_bits, CHUNKSZ) - CHUNKSZ;
868dbc760bcSTejun Heo 	for (; i >= 0; i -= CHUNKSZ) {
869dbc760bcSTejun Heo 		u32 chunkmask, val;
870dbc760bcSTejun Heo 		int word, bit;
871dbc760bcSTejun Heo 
872dbc760bcSTejun Heo 		chunkmask = ((1ULL << chunksz) - 1);
873dbc760bcSTejun Heo 		word = i / BITS_PER_LONG;
874dbc760bcSTejun Heo 		bit = i % BITS_PER_LONG;
875dbc760bcSTejun Heo 		val = (bitmap[word] >> bit) & chunkmask;
876dbc760bcSTejun Heo 
877dbc760bcSTejun Heo 		if (!first) {
878dbc760bcSTejun Heo 			if (buf < end)
879dbc760bcSTejun Heo 				*buf = ',';
880dbc760bcSTejun Heo 			buf++;
881dbc760bcSTejun Heo 		}
882dbc760bcSTejun Heo 		first = false;
883dbc760bcSTejun Heo 
884dbc760bcSTejun Heo 		spec.field_width = DIV_ROUND_UP(chunksz, 4);
885dbc760bcSTejun Heo 		buf = number(buf, end, val, spec);
886dbc760bcSTejun Heo 
887dbc760bcSTejun Heo 		chunksz = CHUNKSZ;
888dbc760bcSTejun Heo 	}
889dbc760bcSTejun Heo 	return buf;
890dbc760bcSTejun Heo }
891dbc760bcSTejun Heo 
892dbc760bcSTejun Heo static noinline_for_stack
893dbc760bcSTejun Heo char *bitmap_list_string(char *buf, char *end, unsigned long *bitmap,
894dbc760bcSTejun Heo 			 struct printf_spec spec, const char *fmt)
895dbc760bcSTejun Heo {
896dbc760bcSTejun Heo 	int nr_bits = max_t(int, spec.field_width, 0);
897dbc760bcSTejun Heo 	/* current bit is 'cur', most recently seen range is [rbot, rtop] */
898dbc760bcSTejun Heo 	int cur, rbot, rtop;
899dbc760bcSTejun Heo 	bool first = true;
900dbc760bcSTejun Heo 
901dbc760bcSTejun Heo 	/* reused to print numbers */
902dbc760bcSTejun Heo 	spec = (struct printf_spec){ .base = 10 };
903dbc760bcSTejun Heo 
904dbc760bcSTejun Heo 	rbot = cur = find_first_bit(bitmap, nr_bits);
905dbc760bcSTejun Heo 	while (cur < nr_bits) {
906dbc760bcSTejun Heo 		rtop = cur;
907dbc760bcSTejun Heo 		cur = find_next_bit(bitmap, nr_bits, cur + 1);
908dbc760bcSTejun Heo 		if (cur < nr_bits && cur <= rtop + 1)
909dbc760bcSTejun Heo 			continue;
910dbc760bcSTejun Heo 
911dbc760bcSTejun Heo 		if (!first) {
912dbc760bcSTejun Heo 			if (buf < end)
913dbc760bcSTejun Heo 				*buf = ',';
914dbc760bcSTejun Heo 			buf++;
915dbc760bcSTejun Heo 		}
916dbc760bcSTejun Heo 		first = false;
917dbc760bcSTejun Heo 
918dbc760bcSTejun Heo 		buf = number(buf, end, rbot, spec);
919dbc760bcSTejun Heo 		if (rbot < rtop) {
920dbc760bcSTejun Heo 			if (buf < end)
921dbc760bcSTejun Heo 				*buf = '-';
922dbc760bcSTejun Heo 			buf++;
923dbc760bcSTejun Heo 
924dbc760bcSTejun Heo 			buf = number(buf, end, rtop, spec);
925dbc760bcSTejun Heo 		}
926dbc760bcSTejun Heo 
927dbc760bcSTejun Heo 		rbot = cur;
928dbc760bcSTejun Heo 	}
929dbc760bcSTejun Heo 	return buf;
930dbc760bcSTejun Heo }
931dbc760bcSTejun Heo 
932dbc760bcSTejun Heo static noinline_for_stack
933cf3b429bSJoe Perches char *mac_address_string(char *buf, char *end, u8 *addr,
9348a27f7c9SJoe Perches 			 struct printf_spec spec, const char *fmt)
935dd45c9cfSHarvey Harrison {
9368a27f7c9SJoe Perches 	char mac_addr[sizeof("xx:xx:xx:xx:xx:xx")];
937dd45c9cfSHarvey Harrison 	char *p = mac_addr;
938dd45c9cfSHarvey Harrison 	int i;
939bc7259a2SJoe Perches 	char separator;
94076597ff9SAndrei Emeltchenko 	bool reversed = false;
941bc7259a2SJoe Perches 
94276597ff9SAndrei Emeltchenko 	switch (fmt[1]) {
94376597ff9SAndrei Emeltchenko 	case 'F':
944bc7259a2SJoe Perches 		separator = '-';
94576597ff9SAndrei Emeltchenko 		break;
94676597ff9SAndrei Emeltchenko 
94776597ff9SAndrei Emeltchenko 	case 'R':
94876597ff9SAndrei Emeltchenko 		reversed = true;
94976597ff9SAndrei Emeltchenko 		/* fall through */
95076597ff9SAndrei Emeltchenko 
95176597ff9SAndrei Emeltchenko 	default:
952bc7259a2SJoe Perches 		separator = ':';
95376597ff9SAndrei Emeltchenko 		break;
954bc7259a2SJoe Perches 	}
955dd45c9cfSHarvey Harrison 
956dd45c9cfSHarvey Harrison 	for (i = 0; i < 6; i++) {
95776597ff9SAndrei Emeltchenko 		if (reversed)
95876597ff9SAndrei Emeltchenko 			p = hex_byte_pack(p, addr[5 - i]);
95976597ff9SAndrei Emeltchenko 		else
96055036ba7SAndy Shevchenko 			p = hex_byte_pack(p, addr[i]);
96176597ff9SAndrei Emeltchenko 
9628a27f7c9SJoe Perches 		if (fmt[0] == 'M' && i != 5)
963bc7259a2SJoe Perches 			*p++ = separator;
964dd45c9cfSHarvey Harrison 	}
965dd45c9cfSHarvey Harrison 	*p = '\0';
966dd45c9cfSHarvey Harrison 
967fef20d9cSFrederic Weisbecker 	return string(buf, end, mac_addr, spec);
968dd45c9cfSHarvey Harrison }
969dd45c9cfSHarvey Harrison 
970cf3b429bSJoe Perches static noinline_for_stack
971cf3b429bSJoe Perches char *ip4_string(char *p, const u8 *addr, const char *fmt)
972689afa7dSHarvey Harrison {
973689afa7dSHarvey Harrison 	int i;
9740159f24eSJoe Perches 	bool leading_zeros = (fmt[0] == 'i');
9750159f24eSJoe Perches 	int index;
9760159f24eSJoe Perches 	int step;
977689afa7dSHarvey Harrison 
9780159f24eSJoe Perches 	switch (fmt[2]) {
9790159f24eSJoe Perches 	case 'h':
9800159f24eSJoe Perches #ifdef __BIG_ENDIAN
9810159f24eSJoe Perches 		index = 0;
9820159f24eSJoe Perches 		step = 1;
9830159f24eSJoe Perches #else
9840159f24eSJoe Perches 		index = 3;
9850159f24eSJoe Perches 		step = -1;
9860159f24eSJoe Perches #endif
9870159f24eSJoe Perches 		break;
9880159f24eSJoe Perches 	case 'l':
9890159f24eSJoe Perches 		index = 3;
9900159f24eSJoe Perches 		step = -1;
9910159f24eSJoe Perches 		break;
9920159f24eSJoe Perches 	case 'n':
9930159f24eSJoe Perches 	case 'b':
9940159f24eSJoe Perches 	default:
9950159f24eSJoe Perches 		index = 0;
9960159f24eSJoe Perches 		step = 1;
9970159f24eSJoe Perches 		break;
9980159f24eSJoe Perches 	}
9998a27f7c9SJoe Perches 	for (i = 0; i < 4; i++) {
10007c43d9a3SRasmus Villemoes 		char temp[4] __aligned(2);	/* hold each IP quad in reverse order */
1001133fd9f5SDenys Vlasenko 		int digits = put_dec_trunc8(temp, addr[index]) - temp;
10028a27f7c9SJoe Perches 		if (leading_zeros) {
10038a27f7c9SJoe Perches 			if (digits < 3)
10048a27f7c9SJoe Perches 				*p++ = '0';
10058a27f7c9SJoe Perches 			if (digits < 2)
10068a27f7c9SJoe Perches 				*p++ = '0';
10078a27f7c9SJoe Perches 		}
10088a27f7c9SJoe Perches 		/* reverse the digits in the quad */
10098a27f7c9SJoe Perches 		while (digits--)
10108a27f7c9SJoe Perches 			*p++ = temp[digits];
10118a27f7c9SJoe Perches 		if (i < 3)
10128a27f7c9SJoe Perches 			*p++ = '.';
10130159f24eSJoe Perches 		index += step;
10148a27f7c9SJoe Perches 	}
10158a27f7c9SJoe Perches 	*p = '\0';
10167b9186f5SAndré Goddard Rosa 
10178a27f7c9SJoe Perches 	return p;
10188a27f7c9SJoe Perches }
10198a27f7c9SJoe Perches 
1020cf3b429bSJoe Perches static noinline_for_stack
1021cf3b429bSJoe Perches char *ip6_compressed_string(char *p, const char *addr)
10228a27f7c9SJoe Perches {
10237b9186f5SAndré Goddard Rosa 	int i, j, range;
10248a27f7c9SJoe Perches 	unsigned char zerolength[8];
10258a27f7c9SJoe Perches 	int longest = 1;
10268a27f7c9SJoe Perches 	int colonpos = -1;
10278a27f7c9SJoe Perches 	u16 word;
10287b9186f5SAndré Goddard Rosa 	u8 hi, lo;
10298a27f7c9SJoe Perches 	bool needcolon = false;
1030eb78cd26SJoe Perches 	bool useIPv4;
1031eb78cd26SJoe Perches 	struct in6_addr in6;
1032eb78cd26SJoe Perches 
1033eb78cd26SJoe Perches 	memcpy(&in6, addr, sizeof(struct in6_addr));
1034eb78cd26SJoe Perches 
1035eb78cd26SJoe Perches 	useIPv4 = ipv6_addr_v4mapped(&in6) || ipv6_addr_is_isatap(&in6);
10368a27f7c9SJoe Perches 
10378a27f7c9SJoe Perches 	memset(zerolength, 0, sizeof(zerolength));
10388a27f7c9SJoe Perches 
10398a27f7c9SJoe Perches 	if (useIPv4)
10408a27f7c9SJoe Perches 		range = 6;
10418a27f7c9SJoe Perches 	else
10428a27f7c9SJoe Perches 		range = 8;
10438a27f7c9SJoe Perches 
10448a27f7c9SJoe Perches 	/* find position of longest 0 run */
10458a27f7c9SJoe Perches 	for (i = 0; i < range; i++) {
10468a27f7c9SJoe Perches 		for (j = i; j < range; j++) {
1047eb78cd26SJoe Perches 			if (in6.s6_addr16[j] != 0)
10488a27f7c9SJoe Perches 				break;
10498a27f7c9SJoe Perches 			zerolength[i]++;
10508a27f7c9SJoe Perches 		}
10518a27f7c9SJoe Perches 	}
10528a27f7c9SJoe Perches 	for (i = 0; i < range; i++) {
10538a27f7c9SJoe Perches 		if (zerolength[i] > longest) {
10548a27f7c9SJoe Perches 			longest = zerolength[i];
10558a27f7c9SJoe Perches 			colonpos = i;
10568a27f7c9SJoe Perches 		}
10578a27f7c9SJoe Perches 	}
105829cf519eSJoe Perches 	if (longest == 1)		/* don't compress a single 0 */
105929cf519eSJoe Perches 		colonpos = -1;
10608a27f7c9SJoe Perches 
10618a27f7c9SJoe Perches 	/* emit address */
10628a27f7c9SJoe Perches 	for (i = 0; i < range; i++) {
10638a27f7c9SJoe Perches 		if (i == colonpos) {
10648a27f7c9SJoe Perches 			if (needcolon || i == 0)
10658a27f7c9SJoe Perches 				*p++ = ':';
10668a27f7c9SJoe Perches 			*p++ = ':';
10678a27f7c9SJoe Perches 			needcolon = false;
10688a27f7c9SJoe Perches 			i += longest - 1;
10698a27f7c9SJoe Perches 			continue;
10708a27f7c9SJoe Perches 		}
10718a27f7c9SJoe Perches 		if (needcolon) {
10728a27f7c9SJoe Perches 			*p++ = ':';
10738a27f7c9SJoe Perches 			needcolon = false;
10748a27f7c9SJoe Perches 		}
10758a27f7c9SJoe Perches 		/* hex u16 without leading 0s */
1076eb78cd26SJoe Perches 		word = ntohs(in6.s6_addr16[i]);
10778a27f7c9SJoe Perches 		hi = word >> 8;
10788a27f7c9SJoe Perches 		lo = word & 0xff;
10798a27f7c9SJoe Perches 		if (hi) {
10808a27f7c9SJoe Perches 			if (hi > 0x0f)
108155036ba7SAndy Shevchenko 				p = hex_byte_pack(p, hi);
10828a27f7c9SJoe Perches 			else
10838a27f7c9SJoe Perches 				*p++ = hex_asc_lo(hi);
108455036ba7SAndy Shevchenko 			p = hex_byte_pack(p, lo);
10858a27f7c9SJoe Perches 		}
1086b5ff992bSAndré Goddard Rosa 		else if (lo > 0x0f)
108755036ba7SAndy Shevchenko 			p = hex_byte_pack(p, lo);
10888a27f7c9SJoe Perches 		else
10898a27f7c9SJoe Perches 			*p++ = hex_asc_lo(lo);
10908a27f7c9SJoe Perches 		needcolon = true;
10918a27f7c9SJoe Perches 	}
10928a27f7c9SJoe Perches 
10938a27f7c9SJoe Perches 	if (useIPv4) {
10948a27f7c9SJoe Perches 		if (needcolon)
10958a27f7c9SJoe Perches 			*p++ = ':';
10960159f24eSJoe Perches 		p = ip4_string(p, &in6.s6_addr[12], "I4");
10978a27f7c9SJoe Perches 	}
10988a27f7c9SJoe Perches 	*p = '\0';
10997b9186f5SAndré Goddard Rosa 
11008a27f7c9SJoe Perches 	return p;
11018a27f7c9SJoe Perches }
11028a27f7c9SJoe Perches 
1103cf3b429bSJoe Perches static noinline_for_stack
1104cf3b429bSJoe Perches char *ip6_string(char *p, const char *addr, const char *fmt)
11058a27f7c9SJoe Perches {
11068a27f7c9SJoe Perches 	int i;
11077b9186f5SAndré Goddard Rosa 
1108689afa7dSHarvey Harrison 	for (i = 0; i < 8; i++) {
110955036ba7SAndy Shevchenko 		p = hex_byte_pack(p, *addr++);
111055036ba7SAndy Shevchenko 		p = hex_byte_pack(p, *addr++);
11118a27f7c9SJoe Perches 		if (fmt[0] == 'I' && i != 7)
1112689afa7dSHarvey Harrison 			*p++ = ':';
1113689afa7dSHarvey Harrison 	}
1114689afa7dSHarvey Harrison 	*p = '\0';
11157b9186f5SAndré Goddard Rosa 
11168a27f7c9SJoe Perches 	return p;
11178a27f7c9SJoe Perches }
11188a27f7c9SJoe Perches 
1119cf3b429bSJoe Perches static noinline_for_stack
1120cf3b429bSJoe Perches char *ip6_addr_string(char *buf, char *end, const u8 *addr,
11218a27f7c9SJoe Perches 		      struct printf_spec spec, const char *fmt)
11228a27f7c9SJoe Perches {
11238a27f7c9SJoe Perches 	char ip6_addr[sizeof("xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:255.255.255.255")];
11248a27f7c9SJoe Perches 
11258a27f7c9SJoe Perches 	if (fmt[0] == 'I' && fmt[2] == 'c')
1126eb78cd26SJoe Perches 		ip6_compressed_string(ip6_addr, addr);
11278a27f7c9SJoe Perches 	else
1128eb78cd26SJoe Perches 		ip6_string(ip6_addr, addr, fmt);
1129689afa7dSHarvey Harrison 
1130fef20d9cSFrederic Weisbecker 	return string(buf, end, ip6_addr, spec);
1131689afa7dSHarvey Harrison }
1132689afa7dSHarvey Harrison 
1133cf3b429bSJoe Perches static noinline_for_stack
1134cf3b429bSJoe Perches char *ip4_addr_string(char *buf, char *end, const u8 *addr,
11358a27f7c9SJoe Perches 		      struct printf_spec spec, const char *fmt)
11364aa99606SHarvey Harrison {
11378a27f7c9SJoe Perches 	char ip4_addr[sizeof("255.255.255.255")];
11384aa99606SHarvey Harrison 
11390159f24eSJoe Perches 	ip4_string(ip4_addr, addr, fmt);
11404aa99606SHarvey Harrison 
1141fef20d9cSFrederic Weisbecker 	return string(buf, end, ip4_addr, spec);
11424aa99606SHarvey Harrison }
11434aa99606SHarvey Harrison 
1144cf3b429bSJoe Perches static noinline_for_stack
114510679643SDaniel Borkmann char *ip6_addr_string_sa(char *buf, char *end, const struct sockaddr_in6 *sa,
114610679643SDaniel Borkmann 			 struct printf_spec spec, const char *fmt)
114710679643SDaniel Borkmann {
114810679643SDaniel Borkmann 	bool have_p = false, have_s = false, have_f = false, have_c = false;
114910679643SDaniel Borkmann 	char ip6_addr[sizeof("[xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:255.255.255.255]") +
115010679643SDaniel Borkmann 		      sizeof(":12345") + sizeof("/123456789") +
115110679643SDaniel Borkmann 		      sizeof("%1234567890")];
115210679643SDaniel Borkmann 	char *p = ip6_addr, *pend = ip6_addr + sizeof(ip6_addr);
115310679643SDaniel Borkmann 	const u8 *addr = (const u8 *) &sa->sin6_addr;
115410679643SDaniel Borkmann 	char fmt6[2] = { fmt[0], '6' };
115510679643SDaniel Borkmann 	u8 off = 0;
115610679643SDaniel Borkmann 
115710679643SDaniel Borkmann 	fmt++;
115810679643SDaniel Borkmann 	while (isalpha(*++fmt)) {
115910679643SDaniel Borkmann 		switch (*fmt) {
116010679643SDaniel Borkmann 		case 'p':
116110679643SDaniel Borkmann 			have_p = true;
116210679643SDaniel Borkmann 			break;
116310679643SDaniel Borkmann 		case 'f':
116410679643SDaniel Borkmann 			have_f = true;
116510679643SDaniel Borkmann 			break;
116610679643SDaniel Borkmann 		case 's':
116710679643SDaniel Borkmann 			have_s = true;
116810679643SDaniel Borkmann 			break;
116910679643SDaniel Borkmann 		case 'c':
117010679643SDaniel Borkmann 			have_c = true;
117110679643SDaniel Borkmann 			break;
117210679643SDaniel Borkmann 		}
117310679643SDaniel Borkmann 	}
117410679643SDaniel Borkmann 
117510679643SDaniel Borkmann 	if (have_p || have_s || have_f) {
117610679643SDaniel Borkmann 		*p = '[';
117710679643SDaniel Borkmann 		off = 1;
117810679643SDaniel Borkmann 	}
117910679643SDaniel Borkmann 
118010679643SDaniel Borkmann 	if (fmt6[0] == 'I' && have_c)
118110679643SDaniel Borkmann 		p = ip6_compressed_string(ip6_addr + off, addr);
118210679643SDaniel Borkmann 	else
118310679643SDaniel Borkmann 		p = ip6_string(ip6_addr + off, addr, fmt6);
118410679643SDaniel Borkmann 
118510679643SDaniel Borkmann 	if (have_p || have_s || have_f)
118610679643SDaniel Borkmann 		*p++ = ']';
118710679643SDaniel Borkmann 
118810679643SDaniel Borkmann 	if (have_p) {
118910679643SDaniel Borkmann 		*p++ = ':';
119010679643SDaniel Borkmann 		p = number(p, pend, ntohs(sa->sin6_port), spec);
119110679643SDaniel Borkmann 	}
119210679643SDaniel Borkmann 	if (have_f) {
119310679643SDaniel Borkmann 		*p++ = '/';
119410679643SDaniel Borkmann 		p = number(p, pend, ntohl(sa->sin6_flowinfo &
119510679643SDaniel Borkmann 					  IPV6_FLOWINFO_MASK), spec);
119610679643SDaniel Borkmann 	}
119710679643SDaniel Borkmann 	if (have_s) {
119810679643SDaniel Borkmann 		*p++ = '%';
119910679643SDaniel Borkmann 		p = number(p, pend, sa->sin6_scope_id, spec);
120010679643SDaniel Borkmann 	}
120110679643SDaniel Borkmann 	*p = '\0';
120210679643SDaniel Borkmann 
120310679643SDaniel Borkmann 	return string(buf, end, ip6_addr, spec);
120410679643SDaniel Borkmann }
120510679643SDaniel Borkmann 
120610679643SDaniel Borkmann static noinline_for_stack
120710679643SDaniel Borkmann char *ip4_addr_string_sa(char *buf, char *end, const struct sockaddr_in *sa,
120810679643SDaniel Borkmann 			 struct printf_spec spec, const char *fmt)
120910679643SDaniel Borkmann {
121010679643SDaniel Borkmann 	bool have_p = false;
121110679643SDaniel Borkmann 	char *p, ip4_addr[sizeof("255.255.255.255") + sizeof(":12345")];
121210679643SDaniel Borkmann 	char *pend = ip4_addr + sizeof(ip4_addr);
121310679643SDaniel Borkmann 	const u8 *addr = (const u8 *) &sa->sin_addr.s_addr;
121410679643SDaniel Borkmann 	char fmt4[3] = { fmt[0], '4', 0 };
121510679643SDaniel Borkmann 
121610679643SDaniel Borkmann 	fmt++;
121710679643SDaniel Borkmann 	while (isalpha(*++fmt)) {
121810679643SDaniel Borkmann 		switch (*fmt) {
121910679643SDaniel Borkmann 		case 'p':
122010679643SDaniel Borkmann 			have_p = true;
122110679643SDaniel Borkmann 			break;
122210679643SDaniel Borkmann 		case 'h':
122310679643SDaniel Borkmann 		case 'l':
122410679643SDaniel Borkmann 		case 'n':
122510679643SDaniel Borkmann 		case 'b':
122610679643SDaniel Borkmann 			fmt4[2] = *fmt;
122710679643SDaniel Borkmann 			break;
122810679643SDaniel Borkmann 		}
122910679643SDaniel Borkmann 	}
123010679643SDaniel Borkmann 
123110679643SDaniel Borkmann 	p = ip4_string(ip4_addr, addr, fmt4);
123210679643SDaniel Borkmann 	if (have_p) {
123310679643SDaniel Borkmann 		*p++ = ':';
123410679643SDaniel Borkmann 		p = number(p, pend, ntohs(sa->sin_port), spec);
123510679643SDaniel Borkmann 	}
123610679643SDaniel Borkmann 	*p = '\0';
123710679643SDaniel Borkmann 
123810679643SDaniel Borkmann 	return string(buf, end, ip4_addr, spec);
123910679643SDaniel Borkmann }
124010679643SDaniel Borkmann 
124110679643SDaniel Borkmann static noinline_for_stack
124271dca95dSAndy Shevchenko char *escaped_string(char *buf, char *end, u8 *addr, struct printf_spec spec,
124371dca95dSAndy Shevchenko 		     const char *fmt)
124471dca95dSAndy Shevchenko {
124571dca95dSAndy Shevchenko 	bool found = true;
124671dca95dSAndy Shevchenko 	int count = 1;
124771dca95dSAndy Shevchenko 	unsigned int flags = 0;
124871dca95dSAndy Shevchenko 	int len;
124971dca95dSAndy Shevchenko 
125071dca95dSAndy Shevchenko 	if (spec.field_width == 0)
125171dca95dSAndy Shevchenko 		return buf;				/* nothing to print */
125271dca95dSAndy Shevchenko 
125371dca95dSAndy Shevchenko 	if (ZERO_OR_NULL_PTR(addr))
125471dca95dSAndy Shevchenko 		return string(buf, end, NULL, spec);	/* NULL pointer */
125571dca95dSAndy Shevchenko 
125671dca95dSAndy Shevchenko 
125771dca95dSAndy Shevchenko 	do {
125871dca95dSAndy Shevchenko 		switch (fmt[count++]) {
125971dca95dSAndy Shevchenko 		case 'a':
126071dca95dSAndy Shevchenko 			flags |= ESCAPE_ANY;
126171dca95dSAndy Shevchenko 			break;
126271dca95dSAndy Shevchenko 		case 'c':
126371dca95dSAndy Shevchenko 			flags |= ESCAPE_SPECIAL;
126471dca95dSAndy Shevchenko 			break;
126571dca95dSAndy Shevchenko 		case 'h':
126671dca95dSAndy Shevchenko 			flags |= ESCAPE_HEX;
126771dca95dSAndy Shevchenko 			break;
126871dca95dSAndy Shevchenko 		case 'n':
126971dca95dSAndy Shevchenko 			flags |= ESCAPE_NULL;
127071dca95dSAndy Shevchenko 			break;
127171dca95dSAndy Shevchenko 		case 'o':
127271dca95dSAndy Shevchenko 			flags |= ESCAPE_OCTAL;
127371dca95dSAndy Shevchenko 			break;
127471dca95dSAndy Shevchenko 		case 'p':
127571dca95dSAndy Shevchenko 			flags |= ESCAPE_NP;
127671dca95dSAndy Shevchenko 			break;
127771dca95dSAndy Shevchenko 		case 's':
127871dca95dSAndy Shevchenko 			flags |= ESCAPE_SPACE;
127971dca95dSAndy Shevchenko 			break;
128071dca95dSAndy Shevchenko 		default:
128171dca95dSAndy Shevchenko 			found = false;
128271dca95dSAndy Shevchenko 			break;
128371dca95dSAndy Shevchenko 		}
128471dca95dSAndy Shevchenko 	} while (found);
128571dca95dSAndy Shevchenko 
128671dca95dSAndy Shevchenko 	if (!flags)
128771dca95dSAndy Shevchenko 		flags = ESCAPE_ANY_NP;
128871dca95dSAndy Shevchenko 
128971dca95dSAndy Shevchenko 	len = spec.field_width < 0 ? 1 : spec.field_width;
129071dca95dSAndy Shevchenko 
129141416f23SRasmus Villemoes 	/*
129241416f23SRasmus Villemoes 	 * string_escape_mem() writes as many characters as it can to
129341416f23SRasmus Villemoes 	 * the given buffer, and returns the total size of the output
129441416f23SRasmus Villemoes 	 * had the buffer been big enough.
129541416f23SRasmus Villemoes 	 */
129641416f23SRasmus Villemoes 	buf += string_escape_mem(addr, len, buf, buf < end ? end - buf : 0, flags, NULL);
129771dca95dSAndy Shevchenko 
129871dca95dSAndy Shevchenko 	return buf;
129971dca95dSAndy Shevchenko }
130071dca95dSAndy Shevchenko 
130171dca95dSAndy Shevchenko static noinline_for_stack
1302cf3b429bSJoe Perches char *uuid_string(char *buf, char *end, const u8 *addr,
13039ac6e44eSJoe Perches 		  struct printf_spec spec, const char *fmt)
13049ac6e44eSJoe Perches {
13059ac6e44eSJoe Perches 	char uuid[sizeof("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx")];
13069ac6e44eSJoe Perches 	char *p = uuid;
13079ac6e44eSJoe Perches 	int i;
13089ac6e44eSJoe Perches 	static const u8 be[16] = {0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15};
13099ac6e44eSJoe Perches 	static const u8 le[16] = {3,2,1,0,5,4,7,6,8,9,10,11,12,13,14,15};
13109ac6e44eSJoe Perches 	const u8 *index = be;
13119ac6e44eSJoe Perches 	bool uc = false;
13129ac6e44eSJoe Perches 
13139ac6e44eSJoe Perches 	switch (*(++fmt)) {
13149ac6e44eSJoe Perches 	case 'L':
13159ac6e44eSJoe Perches 		uc = true;		/* fall-through */
13169ac6e44eSJoe Perches 	case 'l':
13179ac6e44eSJoe Perches 		index = le;
13189ac6e44eSJoe Perches 		break;
13199ac6e44eSJoe Perches 	case 'B':
13209ac6e44eSJoe Perches 		uc = true;
13219ac6e44eSJoe Perches 		break;
13229ac6e44eSJoe Perches 	}
13239ac6e44eSJoe Perches 
13249ac6e44eSJoe Perches 	for (i = 0; i < 16; i++) {
132555036ba7SAndy Shevchenko 		p = hex_byte_pack(p, addr[index[i]]);
13269ac6e44eSJoe Perches 		switch (i) {
13279ac6e44eSJoe Perches 		case 3:
13289ac6e44eSJoe Perches 		case 5:
13299ac6e44eSJoe Perches 		case 7:
13309ac6e44eSJoe Perches 		case 9:
13319ac6e44eSJoe Perches 			*p++ = '-';
13329ac6e44eSJoe Perches 			break;
13339ac6e44eSJoe Perches 		}
13349ac6e44eSJoe Perches 	}
13359ac6e44eSJoe Perches 
13369ac6e44eSJoe Perches 	*p = 0;
13379ac6e44eSJoe Perches 
13389ac6e44eSJoe Perches 	if (uc) {
13399ac6e44eSJoe Perches 		p = uuid;
13409ac6e44eSJoe Perches 		do {
13419ac6e44eSJoe Perches 			*p = toupper(*p);
13429ac6e44eSJoe Perches 		} while (*(++p));
13439ac6e44eSJoe Perches 	}
13449ac6e44eSJoe Perches 
13459ac6e44eSJoe Perches 	return string(buf, end, uuid, spec);
13469ac6e44eSJoe Perches }
13479ac6e44eSJoe Perches 
1348*5b17aecfSAndy Shevchenko static noinline_for_stack
1349*5b17aecfSAndy Shevchenko char *netdev_bits(char *buf, char *end, const void *addr, const char *fmt)
1350c8f44affSMichał Mirosław {
1351*5b17aecfSAndy Shevchenko 	unsigned long long num;
1352*5b17aecfSAndy Shevchenko 	int size;
1353*5b17aecfSAndy Shevchenko 
1354*5b17aecfSAndy Shevchenko 	switch (fmt[1]) {
1355*5b17aecfSAndy Shevchenko 	case 'F':
1356*5b17aecfSAndy Shevchenko 		num = *(const netdev_features_t *)addr;
1357*5b17aecfSAndy Shevchenko 		size = sizeof(netdev_features_t);
1358*5b17aecfSAndy Shevchenko 		break;
1359*5b17aecfSAndy Shevchenko 	default:
1360*5b17aecfSAndy Shevchenko 		num = (unsigned long)addr;
1361*5b17aecfSAndy Shevchenko 		size = sizeof(unsigned long);
1362*5b17aecfSAndy Shevchenko 		break;
1363*5b17aecfSAndy Shevchenko 	}
1364c8f44affSMichał Mirosław 
13653cab1e71SAndy Shevchenko 	return special_hex_number(buf, end, num, size);
1366c8f44affSMichał Mirosław }
1367c8f44affSMichał Mirosław 
1368aaf07621SJoe Perches static noinline_for_stack
13693cab1e71SAndy Shevchenko char *address_val(char *buf, char *end, const void *addr, const char *fmt)
1370aaf07621SJoe Perches {
1371aaf07621SJoe Perches 	unsigned long long num;
13723cab1e71SAndy Shevchenko 	int size;
1373aaf07621SJoe Perches 
1374aaf07621SJoe Perches 	switch (fmt[1]) {
1375aaf07621SJoe Perches 	case 'd':
1376aaf07621SJoe Perches 		num = *(const dma_addr_t *)addr;
13773cab1e71SAndy Shevchenko 		size = sizeof(dma_addr_t);
1378aaf07621SJoe Perches 		break;
1379aaf07621SJoe Perches 	case 'p':
1380aaf07621SJoe Perches 	default:
1381aaf07621SJoe Perches 		num = *(const phys_addr_t *)addr;
13823cab1e71SAndy Shevchenko 		size = sizeof(phys_addr_t);
1383aaf07621SJoe Perches 		break;
1384aaf07621SJoe Perches 	}
1385aaf07621SJoe Perches 
13863cab1e71SAndy Shevchenko 	return special_hex_number(buf, end, num, size);
1387aaf07621SJoe Perches }
1388aaf07621SJoe Perches 
1389900cca29SGeert Uytterhoeven static noinline_for_stack
1390900cca29SGeert Uytterhoeven char *clock(char *buf, char *end, struct clk *clk, struct printf_spec spec,
1391900cca29SGeert Uytterhoeven 	    const char *fmt)
1392900cca29SGeert Uytterhoeven {
1393900cca29SGeert Uytterhoeven 	if (!IS_ENABLED(CONFIG_HAVE_CLK) || !clk)
1394900cca29SGeert Uytterhoeven 		return string(buf, end, NULL, spec);
1395900cca29SGeert Uytterhoeven 
1396900cca29SGeert Uytterhoeven 	switch (fmt[1]) {
1397900cca29SGeert Uytterhoeven 	case 'r':
1398900cca29SGeert Uytterhoeven 		return number(buf, end, clk_get_rate(clk), spec);
1399900cca29SGeert Uytterhoeven 
1400900cca29SGeert Uytterhoeven 	case 'n':
1401900cca29SGeert Uytterhoeven 	default:
1402900cca29SGeert Uytterhoeven #ifdef CONFIG_COMMON_CLK
1403900cca29SGeert Uytterhoeven 		return string(buf, end, __clk_get_name(clk), spec);
1404900cca29SGeert Uytterhoeven #else
14053cab1e71SAndy Shevchenko 		return special_hex_number(buf, end, (unsigned long)clk, sizeof(unsigned long));
1406900cca29SGeert Uytterhoeven #endif
1407900cca29SGeert Uytterhoeven 	}
1408900cca29SGeert Uytterhoeven }
1409900cca29SGeert Uytterhoeven 
1410411f05f1SIngo Molnar int kptr_restrict __read_mostly;
1411455cd5abSDan Rosenberg 
14124d8a743cSLinus Torvalds /*
14134d8a743cSLinus Torvalds  * Show a '%p' thing.  A kernel extension is that the '%p' is followed
14144d8a743cSLinus Torvalds  * by an extra set of alphanumeric characters that are extended format
14154d8a743cSLinus Torvalds  * specifiers.
14164d8a743cSLinus Torvalds  *
1417332d2e78SLinus Torvalds  * Right now we handle:
14180fe1ef24SLinus Torvalds  *
14190c8b946eSFrederic Weisbecker  * - 'F' For symbolic function descriptor pointers with offset
14200c8b946eSFrederic Weisbecker  * - 'f' For simple symbolic function names without offset
14210efb4d20SSteven Rostedt  * - 'S' For symbolic direct pointers with offset
14220efb4d20SSteven Rostedt  * - 's' For symbolic direct pointers without offset
1423b0d33c2bSJoe Perches  * - '[FfSs]R' as above with __builtin_extract_return_addr() translation
14240f77a8d3SNamhyung Kim  * - 'B' For backtraced symbolic direct pointers with offset
1425c7dabef8SBjorn Helgaas  * - 'R' For decoded struct resource, e.g., [mem 0x0-0x1f 64bit pref]
1426c7dabef8SBjorn Helgaas  * - 'r' For raw struct resource, e.g., [mem 0x0-0x1f flags 0x201]
1427dbc760bcSTejun Heo  * - 'b[l]' For a bitmap, the number of bits is determined by the field
1428dbc760bcSTejun Heo  *       width which must be explicitly specified either as part of the
1429dbc760bcSTejun Heo  *       format string '%32b[l]' or through '%*b[l]', [l] selects
1430dbc760bcSTejun Heo  *       range-list format instead of hex format
1431dd45c9cfSHarvey Harrison  * - 'M' For a 6-byte MAC address, it prints the address in the
1432dd45c9cfSHarvey Harrison  *       usual colon-separated hex notation
14338a27f7c9SJoe Perches  * - 'm' For a 6-byte MAC address, it prints the hex address without colons
1434bc7259a2SJoe Perches  * - 'MF' For a 6-byte MAC FDDI address, it prints the address
1435c8e00060SJoe Perches  *       with a dash-separated hex notation
14367c59154eSAndy Shevchenko  * - '[mM]R' For a 6-byte MAC address, Reverse order (Bluetooth)
14378a27f7c9SJoe Perches  * - 'I' [46] for IPv4/IPv6 addresses printed in the usual way
14388a27f7c9SJoe Perches  *       IPv4 uses dot-separated decimal without leading 0's (1.2.3.4)
14398a27f7c9SJoe Perches  *       IPv6 uses colon separated network-order 16 bit hex with leading 0's
144010679643SDaniel Borkmann  *       [S][pfs]
144110679643SDaniel Borkmann  *       Generic IPv4/IPv6 address (struct sockaddr *) that falls back to
144210679643SDaniel Borkmann  *       [4] or [6] and is able to print port [p], flowinfo [f], scope [s]
14438a27f7c9SJoe Perches  * - 'i' [46] for 'raw' IPv4/IPv6 addresses
14448a27f7c9SJoe Perches  *       IPv6 omits the colons (01020304...0f)
14458a27f7c9SJoe Perches  *       IPv4 uses dot-separated decimal with leading 0's (010.123.045.006)
144610679643SDaniel Borkmann  *       [S][pfs]
144710679643SDaniel Borkmann  *       Generic IPv4/IPv6 address (struct sockaddr *) that falls back to
144810679643SDaniel Borkmann  *       [4] or [6] and is able to print port [p], flowinfo [f], scope [s]
144910679643SDaniel Borkmann  * - '[Ii][4S][hnbl]' IPv4 addresses in host, network, big or little endian order
145010679643SDaniel Borkmann  * - 'I[6S]c' for IPv6 addresses printed as specified by
145129cf519eSJoe Perches  *       http://tools.ietf.org/html/rfc5952
145271dca95dSAndy Shevchenko  * - 'E[achnops]' For an escaped buffer, where rules are defined by combination
145371dca95dSAndy Shevchenko  *                of the following flags (see string_escape_mem() for the
145471dca95dSAndy Shevchenko  *                details):
145571dca95dSAndy Shevchenko  *                  a - ESCAPE_ANY
145671dca95dSAndy Shevchenko  *                  c - ESCAPE_SPECIAL
145771dca95dSAndy Shevchenko  *                  h - ESCAPE_HEX
145871dca95dSAndy Shevchenko  *                  n - ESCAPE_NULL
145971dca95dSAndy Shevchenko  *                  o - ESCAPE_OCTAL
146071dca95dSAndy Shevchenko  *                  p - ESCAPE_NP
146171dca95dSAndy Shevchenko  *                  s - ESCAPE_SPACE
146271dca95dSAndy Shevchenko  *                By default ESCAPE_ANY_NP is used.
14639ac6e44eSJoe Perches  * - 'U' For a 16 byte UUID/GUID, it prints the UUID/GUID in the form
14649ac6e44eSJoe Perches  *       "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
14659ac6e44eSJoe Perches  *       Options for %pU are:
14669ac6e44eSJoe Perches  *         b big endian lower case hex (default)
14679ac6e44eSJoe Perches  *         B big endian UPPER case hex
14689ac6e44eSJoe Perches  *         l little endian lower case hex
14699ac6e44eSJoe Perches  *         L little endian UPPER case hex
14709ac6e44eSJoe Perches  *           big endian output byte order is:
14719ac6e44eSJoe Perches  *             [0][1][2][3]-[4][5]-[6][7]-[8][9]-[10][11][12][13][14][15]
14729ac6e44eSJoe Perches  *           little endian output byte order is:
14739ac6e44eSJoe Perches  *             [3][2][1][0]-[5][4]-[7][6]-[8][9]-[10][11][12][13][14][15]
14747db6f5fbSJoe Perches  * - 'V' For a struct va_format which contains a format string * and va_list *,
14757db6f5fbSJoe Perches  *       call vsnprintf(->format, *->va_list).
14767db6f5fbSJoe Perches  *       Implements a "recursive vsnprintf".
14777db6f5fbSJoe Perches  *       Do not use this feature without some mechanism to verify the
14787db6f5fbSJoe Perches  *       correctness of the format string and va_list arguments.
1479455cd5abSDan Rosenberg  * - 'K' For a kernel pointer that should be hidden from unprivileged users
1480c8f44affSMichał Mirosław  * - 'NF' For a netdev_features_t
148131550a16SAndy Shevchenko  * - 'h[CDN]' For a variable-length buffer, it prints it as a hex string with
148231550a16SAndy Shevchenko  *            a certain separator (' ' by default):
148331550a16SAndy Shevchenko  *              C colon
148431550a16SAndy Shevchenko  *              D dash
148531550a16SAndy Shevchenko  *              N no separator
148631550a16SAndy Shevchenko  *            The maximum supported length is 64 bytes of the input. Consider
148731550a16SAndy Shevchenko  *            to use print_hex_dump() for the larger input.
1488aaf07621SJoe Perches  * - 'a[pd]' For address types [p] phys_addr_t, [d] dma_addr_t and derivatives
1489aaf07621SJoe Perches  *           (default assumed to be phys_addr_t, passed by reference)
1490c0d92a57SOlof Johansson  * - 'd[234]' For a dentry name (optionally 2-4 last components)
1491c0d92a57SOlof Johansson  * - 'D[234]' Same as 'd' but for a struct file
14921031bc58SDmitry Monakhov  * - 'g' For block_device name (gendisk + partition number)
1493900cca29SGeert Uytterhoeven  * - 'C' For a clock, it prints the name (Common Clock Framework) or address
1494900cca29SGeert Uytterhoeven  *       (legacy clock framework) of the clock
1495900cca29SGeert Uytterhoeven  * - 'Cn' For a clock, it prints the name (Common Clock Framework) or address
1496900cca29SGeert Uytterhoeven  *        (legacy clock framework) of the clock
1497900cca29SGeert Uytterhoeven  * - 'Cr' For a clock, it prints the current rate of the clock
14985e4ee7b1SMartin Kletzander  *
14995e4ee7b1SMartin Kletzander  * ** Please update also Documentation/printk-formats.txt when making changes **
15009ac6e44eSJoe Perches  *
1501332d2e78SLinus Torvalds  * Note: The difference between 'S' and 'F' is that on ia64 and ppc64
1502332d2e78SLinus Torvalds  * function pointers are really function descriptors, which contain a
1503332d2e78SLinus Torvalds  * pointer to the real address.
15044d8a743cSLinus Torvalds  */
1505cf3b429bSJoe Perches static noinline_for_stack
1506cf3b429bSJoe Perches char *pointer(const char *fmt, char *buf, char *end, void *ptr,
1507fef20d9cSFrederic Weisbecker 	      struct printf_spec spec)
150878a8bf69SLinus Torvalds {
150980c9eb46SRasmus Villemoes 	const int default_width = 2 * sizeof(void *);
1510725fe002SGrant Likely 
15119f36e2c4SKees Cook 	if (!ptr && *fmt != 'K') {
15125e057981SJoe Perches 		/*
15135e057981SJoe Perches 		 * Print (null) with the same width as a pointer so it makes
15145e057981SJoe Perches 		 * tabular output look nice.
15155e057981SJoe Perches 		 */
15165e057981SJoe Perches 		if (spec.field_width == -1)
1517725fe002SGrant Likely 			spec.field_width = default_width;
1518fef20d9cSFrederic Weisbecker 		return string(buf, end, "(null)", spec);
15195e057981SJoe Perches 	}
1520d97106abSLinus Torvalds 
15210fe1ef24SLinus Torvalds 	switch (*fmt) {
15220fe1ef24SLinus Torvalds 	case 'F':
15230c8b946eSFrederic Weisbecker 	case 'f':
15240fe1ef24SLinus Torvalds 		ptr = dereference_function_descriptor(ptr);
15250fe1ef24SLinus Torvalds 		/* Fallthrough */
15260fe1ef24SLinus Torvalds 	case 'S':
15279ac6e44eSJoe Perches 	case 's':
15280f77a8d3SNamhyung Kim 	case 'B':
1529b0d33c2bSJoe Perches 		return symbol_string(buf, end, ptr, spec, fmt);
1530332d2e78SLinus Torvalds 	case 'R':
1531c7dabef8SBjorn Helgaas 	case 'r':
1532fd95541eSBjorn Helgaas 		return resource_string(buf, end, ptr, spec, fmt);
153331550a16SAndy Shevchenko 	case 'h':
153431550a16SAndy Shevchenko 		return hex_string(buf, end, ptr, spec, fmt);
1535dbc760bcSTejun Heo 	case 'b':
1536dbc760bcSTejun Heo 		switch (fmt[1]) {
1537dbc760bcSTejun Heo 		case 'l':
1538dbc760bcSTejun Heo 			return bitmap_list_string(buf, end, ptr, spec, fmt);
1539dbc760bcSTejun Heo 		default:
1540dbc760bcSTejun Heo 			return bitmap_string(buf, end, ptr, spec, fmt);
1541dbc760bcSTejun Heo 		}
15428a27f7c9SJoe Perches 	case 'M':			/* Colon separated: 00:01:02:03:04:05 */
15438a27f7c9SJoe Perches 	case 'm':			/* Contiguous: 000102030405 */
154476597ff9SAndrei Emeltchenko 					/* [mM]F (FDDI) */
154576597ff9SAndrei Emeltchenko 					/* [mM]R (Reverse order; Bluetooth) */
15468a27f7c9SJoe Perches 		return mac_address_string(buf, end, ptr, spec, fmt);
15478a27f7c9SJoe Perches 	case 'I':			/* Formatted IP supported
15488a27f7c9SJoe Perches 					 * 4:	1.2.3.4
15498a27f7c9SJoe Perches 					 * 6:	0001:0203:...:0708
15508a27f7c9SJoe Perches 					 * 6c:	1::708 or 1::1.2.3.4
15518a27f7c9SJoe Perches 					 */
15528a27f7c9SJoe Perches 	case 'i':			/* Contiguous:
15538a27f7c9SJoe Perches 					 * 4:	001.002.003.004
15548a27f7c9SJoe Perches 					 * 6:   000102...0f
15558a27f7c9SJoe Perches 					 */
15568a27f7c9SJoe Perches 		switch (fmt[1]) {
15578a27f7c9SJoe Perches 		case '6':
15588a27f7c9SJoe Perches 			return ip6_addr_string(buf, end, ptr, spec, fmt);
15598a27f7c9SJoe Perches 		case '4':
15608a27f7c9SJoe Perches 			return ip4_addr_string(buf, end, ptr, spec, fmt);
156110679643SDaniel Borkmann 		case 'S': {
156210679643SDaniel Borkmann 			const union {
156310679643SDaniel Borkmann 				struct sockaddr		raw;
156410679643SDaniel Borkmann 				struct sockaddr_in	v4;
156510679643SDaniel Borkmann 				struct sockaddr_in6	v6;
156610679643SDaniel Borkmann 			} *sa = ptr;
156710679643SDaniel Borkmann 
156810679643SDaniel Borkmann 			switch (sa->raw.sa_family) {
156910679643SDaniel Borkmann 			case AF_INET:
157010679643SDaniel Borkmann 				return ip4_addr_string_sa(buf, end, &sa->v4, spec, fmt);
157110679643SDaniel Borkmann 			case AF_INET6:
157210679643SDaniel Borkmann 				return ip6_addr_string_sa(buf, end, &sa->v6, spec, fmt);
157310679643SDaniel Borkmann 			default:
157410679643SDaniel Borkmann 				return string(buf, end, "(invalid address)", spec);
157510679643SDaniel Borkmann 			}}
15768a27f7c9SJoe Perches 		}
15774aa99606SHarvey Harrison 		break;
157871dca95dSAndy Shevchenko 	case 'E':
157971dca95dSAndy Shevchenko 		return escaped_string(buf, end, ptr, spec, fmt);
15809ac6e44eSJoe Perches 	case 'U':
15819ac6e44eSJoe Perches 		return uuid_string(buf, end, ptr, spec, fmt);
15827db6f5fbSJoe Perches 	case 'V':
15835756b76eSJan Beulich 		{
15845756b76eSJan Beulich 			va_list va;
15855756b76eSJan Beulich 
15865756b76eSJan Beulich 			va_copy(va, *((struct va_format *)ptr)->va);
15875756b76eSJan Beulich 			buf += vsnprintf(buf, end > buf ? end - buf : 0,
15885756b76eSJan Beulich 					 ((struct va_format *)ptr)->fmt, va);
15895756b76eSJan Beulich 			va_end(va);
15905756b76eSJan Beulich 			return buf;
15915756b76eSJan Beulich 		}
1592455cd5abSDan Rosenberg 	case 'K':
1593455cd5abSDan Rosenberg 		/*
1594455cd5abSDan Rosenberg 		 * %pK cannot be used in IRQ context because its test
1595455cd5abSDan Rosenberg 		 * for CAP_SYSLOG would be meaningless.
1596455cd5abSDan Rosenberg 		 */
15973715c530SDan Rosenberg 		if (kptr_restrict && (in_irq() || in_serving_softirq() ||
15983715c530SDan Rosenberg 				      in_nmi())) {
1599455cd5abSDan Rosenberg 			if (spec.field_width == -1)
1600725fe002SGrant Likely 				spec.field_width = default_width;
1601455cd5abSDan Rosenberg 			return string(buf, end, "pK-error", spec);
1602455cd5abSDan Rosenberg 		}
1603312b4e22SRyan Mallon 
1604312b4e22SRyan Mallon 		switch (kptr_restrict) {
1605312b4e22SRyan Mallon 		case 0:
1606312b4e22SRyan Mallon 			/* Always print %pK values */
1607312b4e22SRyan Mallon 			break;
1608312b4e22SRyan Mallon 		case 1: {
1609312b4e22SRyan Mallon 			/*
1610312b4e22SRyan Mallon 			 * Only print the real pointer value if the current
1611312b4e22SRyan Mallon 			 * process has CAP_SYSLOG and is running with the
1612312b4e22SRyan Mallon 			 * same credentials it started with. This is because
1613312b4e22SRyan Mallon 			 * access to files is checked at open() time, but %pK
1614312b4e22SRyan Mallon 			 * checks permission at read() time. We don't want to
1615312b4e22SRyan Mallon 			 * leak pointer values if a binary opens a file using
1616312b4e22SRyan Mallon 			 * %pK and then elevates privileges before reading it.
1617312b4e22SRyan Mallon 			 */
1618312b4e22SRyan Mallon 			const struct cred *cred = current_cred();
1619312b4e22SRyan Mallon 
1620312b4e22SRyan Mallon 			if (!has_capability_noaudit(current, CAP_SYSLOG) ||
1621312b4e22SRyan Mallon 			    !uid_eq(cred->euid, cred->uid) ||
1622312b4e22SRyan Mallon 			    !gid_eq(cred->egid, cred->gid))
162326297607SJoe Perches 				ptr = NULL;
162426297607SJoe Perches 			break;
1625312b4e22SRyan Mallon 		}
1626312b4e22SRyan Mallon 		case 2:
1627312b4e22SRyan Mallon 		default:
1628312b4e22SRyan Mallon 			/* Always print 0's for %pK */
1629312b4e22SRyan Mallon 			ptr = NULL;
1630312b4e22SRyan Mallon 			break;
1631312b4e22SRyan Mallon 		}
1632312b4e22SRyan Mallon 		break;
1633312b4e22SRyan Mallon 
1634c8f44affSMichał Mirosław 	case 'N':
1635*5b17aecfSAndy Shevchenko 		return netdev_bits(buf, end, ptr, fmt);
16367d799210SStepan Moskovchenko 	case 'a':
16373cab1e71SAndy Shevchenko 		return address_val(buf, end, ptr, fmt);
16384b6ccca7SAl Viro 	case 'd':
16394b6ccca7SAl Viro 		return dentry_name(buf, end, ptr, spec, fmt);
1640900cca29SGeert Uytterhoeven 	case 'C':
1641900cca29SGeert Uytterhoeven 		return clock(buf, end, ptr, spec, fmt);
16424b6ccca7SAl Viro 	case 'D':
16434b6ccca7SAl Viro 		return dentry_name(buf, end,
16444b6ccca7SAl Viro 				   ((const struct file *)ptr)->f_path.dentry,
16454b6ccca7SAl Viro 				   spec, fmt);
16461031bc58SDmitry Monakhov #ifdef CONFIG_BLOCK
16471031bc58SDmitry Monakhov 	case 'g':
16481031bc58SDmitry Monakhov 		return bdev_name(buf, end, ptr, spec, fmt);
16491031bc58SDmitry Monakhov #endif
16501031bc58SDmitry Monakhov 
16510fe1ef24SLinus Torvalds 	}
1652fef20d9cSFrederic Weisbecker 	spec.flags |= SMALL;
1653fef20d9cSFrederic Weisbecker 	if (spec.field_width == -1) {
1654725fe002SGrant Likely 		spec.field_width = default_width;
1655fef20d9cSFrederic Weisbecker 		spec.flags |= ZEROPAD;
165678a8bf69SLinus Torvalds 	}
1657fef20d9cSFrederic Weisbecker 	spec.base = 16;
1658fef20d9cSFrederic Weisbecker 
1659fef20d9cSFrederic Weisbecker 	return number(buf, end, (unsigned long) ptr, spec);
1660fef20d9cSFrederic Weisbecker }
1661fef20d9cSFrederic Weisbecker 
1662fef20d9cSFrederic Weisbecker /*
1663fef20d9cSFrederic Weisbecker  * Helper function to decode printf style format.
1664fef20d9cSFrederic Weisbecker  * Each call decode a token from the format and return the
1665fef20d9cSFrederic Weisbecker  * number of characters read (or likely the delta where it wants
1666fef20d9cSFrederic Weisbecker  * to go on the next call).
1667fef20d9cSFrederic Weisbecker  * The decoded token is returned through the parameters
1668fef20d9cSFrederic Weisbecker  *
1669fef20d9cSFrederic Weisbecker  * 'h', 'l', or 'L' for integer fields
1670fef20d9cSFrederic Weisbecker  * 'z' support added 23/7/1999 S.H.
1671fef20d9cSFrederic Weisbecker  * 'z' changed to 'Z' --davidm 1/25/99
1672fef20d9cSFrederic Weisbecker  * 't' added for ptrdiff_t
1673fef20d9cSFrederic Weisbecker  *
1674fef20d9cSFrederic Weisbecker  * @fmt: the format string
1675fef20d9cSFrederic Weisbecker  * @type of the token returned
1676fef20d9cSFrederic Weisbecker  * @flags: various flags such as +, -, # tokens..
1677fef20d9cSFrederic Weisbecker  * @field_width: overwritten width
1678fef20d9cSFrederic Weisbecker  * @base: base of the number (octal, hex, ...)
1679fef20d9cSFrederic Weisbecker  * @precision: precision of a number
1680fef20d9cSFrederic Weisbecker  * @qualifier: qualifier of a number (long, size_t, ...)
1681fef20d9cSFrederic Weisbecker  */
1682cf3b429bSJoe Perches static noinline_for_stack
1683cf3b429bSJoe Perches int format_decode(const char *fmt, struct printf_spec *spec)
1684fef20d9cSFrederic Weisbecker {
1685fef20d9cSFrederic Weisbecker 	const char *start = fmt;
1686d0484193SRasmus Villemoes 	char qualifier;
1687fef20d9cSFrederic Weisbecker 
1688fef20d9cSFrederic Weisbecker 	/* we finished early by reading the field width */
1689ed681a91SVegard Nossum 	if (spec->type == FORMAT_TYPE_WIDTH) {
1690fef20d9cSFrederic Weisbecker 		if (spec->field_width < 0) {
1691fef20d9cSFrederic Weisbecker 			spec->field_width = -spec->field_width;
1692fef20d9cSFrederic Weisbecker 			spec->flags |= LEFT;
1693fef20d9cSFrederic Weisbecker 		}
1694fef20d9cSFrederic Weisbecker 		spec->type = FORMAT_TYPE_NONE;
1695fef20d9cSFrederic Weisbecker 		goto precision;
1696fef20d9cSFrederic Weisbecker 	}
1697fef20d9cSFrederic Weisbecker 
1698fef20d9cSFrederic Weisbecker 	/* we finished early by reading the precision */
1699fef20d9cSFrederic Weisbecker 	if (spec->type == FORMAT_TYPE_PRECISION) {
1700fef20d9cSFrederic Weisbecker 		if (spec->precision < 0)
1701fef20d9cSFrederic Weisbecker 			spec->precision = 0;
1702fef20d9cSFrederic Weisbecker 
1703fef20d9cSFrederic Weisbecker 		spec->type = FORMAT_TYPE_NONE;
1704fef20d9cSFrederic Weisbecker 		goto qualifier;
1705fef20d9cSFrederic Weisbecker 	}
1706fef20d9cSFrederic Weisbecker 
1707fef20d9cSFrederic Weisbecker 	/* By default */
1708fef20d9cSFrederic Weisbecker 	spec->type = FORMAT_TYPE_NONE;
1709fef20d9cSFrederic Weisbecker 
1710fef20d9cSFrederic Weisbecker 	for (; *fmt ; ++fmt) {
1711fef20d9cSFrederic Weisbecker 		if (*fmt == '%')
1712fef20d9cSFrederic Weisbecker 			break;
1713fef20d9cSFrederic Weisbecker 	}
1714fef20d9cSFrederic Weisbecker 
1715fef20d9cSFrederic Weisbecker 	/* Return the current non-format string */
1716fef20d9cSFrederic Weisbecker 	if (fmt != start || !*fmt)
1717fef20d9cSFrederic Weisbecker 		return fmt - start;
1718fef20d9cSFrederic Weisbecker 
1719fef20d9cSFrederic Weisbecker 	/* Process flags */
1720fef20d9cSFrederic Weisbecker 	spec->flags = 0;
1721fef20d9cSFrederic Weisbecker 
1722fef20d9cSFrederic Weisbecker 	while (1) { /* this also skips first '%' */
1723fef20d9cSFrederic Weisbecker 		bool found = true;
1724fef20d9cSFrederic Weisbecker 
1725fef20d9cSFrederic Weisbecker 		++fmt;
1726fef20d9cSFrederic Weisbecker 
1727fef20d9cSFrederic Weisbecker 		switch (*fmt) {
1728fef20d9cSFrederic Weisbecker 		case '-': spec->flags |= LEFT;    break;
1729fef20d9cSFrederic Weisbecker 		case '+': spec->flags |= PLUS;    break;
1730fef20d9cSFrederic Weisbecker 		case ' ': spec->flags |= SPACE;   break;
1731fef20d9cSFrederic Weisbecker 		case '#': spec->flags |= SPECIAL; break;
1732fef20d9cSFrederic Weisbecker 		case '0': spec->flags |= ZEROPAD; break;
1733fef20d9cSFrederic Weisbecker 		default:  found = false;
1734fef20d9cSFrederic Weisbecker 		}
1735fef20d9cSFrederic Weisbecker 
1736fef20d9cSFrederic Weisbecker 		if (!found)
1737fef20d9cSFrederic Weisbecker 			break;
1738fef20d9cSFrederic Weisbecker 	}
1739fef20d9cSFrederic Weisbecker 
1740fef20d9cSFrederic Weisbecker 	/* get field width */
1741fef20d9cSFrederic Weisbecker 	spec->field_width = -1;
1742fef20d9cSFrederic Weisbecker 
1743fef20d9cSFrederic Weisbecker 	if (isdigit(*fmt))
1744fef20d9cSFrederic Weisbecker 		spec->field_width = skip_atoi(&fmt);
1745fef20d9cSFrederic Weisbecker 	else if (*fmt == '*') {
1746fef20d9cSFrederic Weisbecker 		/* it's the next argument */
1747ed681a91SVegard Nossum 		spec->type = FORMAT_TYPE_WIDTH;
1748fef20d9cSFrederic Weisbecker 		return ++fmt - start;
1749fef20d9cSFrederic Weisbecker 	}
1750fef20d9cSFrederic Weisbecker 
1751fef20d9cSFrederic Weisbecker precision:
1752fef20d9cSFrederic Weisbecker 	/* get the precision */
1753fef20d9cSFrederic Weisbecker 	spec->precision = -1;
1754fef20d9cSFrederic Weisbecker 	if (*fmt == '.') {
1755fef20d9cSFrederic Weisbecker 		++fmt;
1756fef20d9cSFrederic Weisbecker 		if (isdigit(*fmt)) {
1757fef20d9cSFrederic Weisbecker 			spec->precision = skip_atoi(&fmt);
1758fef20d9cSFrederic Weisbecker 			if (spec->precision < 0)
1759fef20d9cSFrederic Weisbecker 				spec->precision = 0;
1760fef20d9cSFrederic Weisbecker 		} else if (*fmt == '*') {
1761fef20d9cSFrederic Weisbecker 			/* it's the next argument */
1762adf26f84SVegard Nossum 			spec->type = FORMAT_TYPE_PRECISION;
1763fef20d9cSFrederic Weisbecker 			return ++fmt - start;
1764fef20d9cSFrederic Weisbecker 		}
1765fef20d9cSFrederic Weisbecker 	}
1766fef20d9cSFrederic Weisbecker 
1767fef20d9cSFrederic Weisbecker qualifier:
1768fef20d9cSFrederic Weisbecker 	/* get the conversion qualifier */
1769d0484193SRasmus Villemoes 	qualifier = 0;
177075fb8f26SAndy Shevchenko 	if (*fmt == 'h' || _tolower(*fmt) == 'l' ||
177175fb8f26SAndy Shevchenko 	    _tolower(*fmt) == 'z' || *fmt == 't') {
1772d0484193SRasmus Villemoes 		qualifier = *fmt++;
1773d0484193SRasmus Villemoes 		if (unlikely(qualifier == *fmt)) {
1774d0484193SRasmus Villemoes 			if (qualifier == 'l') {
1775d0484193SRasmus Villemoes 				qualifier = 'L';
1776fef20d9cSFrederic Weisbecker 				++fmt;
1777d0484193SRasmus Villemoes 			} else if (qualifier == 'h') {
1778d0484193SRasmus Villemoes 				qualifier = 'H';
1779a4e94ef0SZhaolei 				++fmt;
1780a4e94ef0SZhaolei 			}
1781fef20d9cSFrederic Weisbecker 		}
1782fef20d9cSFrederic Weisbecker 	}
1783fef20d9cSFrederic Weisbecker 
1784fef20d9cSFrederic Weisbecker 	/* default base */
1785fef20d9cSFrederic Weisbecker 	spec->base = 10;
1786fef20d9cSFrederic Weisbecker 	switch (*fmt) {
1787fef20d9cSFrederic Weisbecker 	case 'c':
1788fef20d9cSFrederic Weisbecker 		spec->type = FORMAT_TYPE_CHAR;
1789fef20d9cSFrederic Weisbecker 		return ++fmt - start;
1790fef20d9cSFrederic Weisbecker 
1791fef20d9cSFrederic Weisbecker 	case 's':
1792fef20d9cSFrederic Weisbecker 		spec->type = FORMAT_TYPE_STR;
1793fef20d9cSFrederic Weisbecker 		return ++fmt - start;
1794fef20d9cSFrederic Weisbecker 
1795fef20d9cSFrederic Weisbecker 	case 'p':
1796fef20d9cSFrederic Weisbecker 		spec->type = FORMAT_TYPE_PTR;
1797ffbfed03SRasmus Villemoes 		return ++fmt - start;
1798fef20d9cSFrederic Weisbecker 
1799fef20d9cSFrederic Weisbecker 	case '%':
1800fef20d9cSFrederic Weisbecker 		spec->type = FORMAT_TYPE_PERCENT_CHAR;
1801fef20d9cSFrederic Weisbecker 		return ++fmt - start;
1802fef20d9cSFrederic Weisbecker 
1803fef20d9cSFrederic Weisbecker 	/* integer number formats - set up the flags and "break" */
1804fef20d9cSFrederic Weisbecker 	case 'o':
1805fef20d9cSFrederic Weisbecker 		spec->base = 8;
1806fef20d9cSFrederic Weisbecker 		break;
1807fef20d9cSFrederic Weisbecker 
1808fef20d9cSFrederic Weisbecker 	case 'x':
1809fef20d9cSFrederic Weisbecker 		spec->flags |= SMALL;
1810fef20d9cSFrederic Weisbecker 
1811fef20d9cSFrederic Weisbecker 	case 'X':
1812fef20d9cSFrederic Weisbecker 		spec->base = 16;
1813fef20d9cSFrederic Weisbecker 		break;
1814fef20d9cSFrederic Weisbecker 
1815fef20d9cSFrederic Weisbecker 	case 'd':
1816fef20d9cSFrederic Weisbecker 	case 'i':
181739e874f8SFrederic Weisbecker 		spec->flags |= SIGN;
1818fef20d9cSFrederic Weisbecker 	case 'u':
1819fef20d9cSFrederic Weisbecker 		break;
1820fef20d9cSFrederic Weisbecker 
1821708d96fdSRyan Mallon 	case 'n':
1822708d96fdSRyan Mallon 		/*
1823b006f19bSRasmus Villemoes 		 * Since %n poses a greater security risk than
1824b006f19bSRasmus Villemoes 		 * utility, treat it as any other invalid or
1825b006f19bSRasmus Villemoes 		 * unsupported format specifier.
1826708d96fdSRyan Mallon 		 */
1827708d96fdSRyan Mallon 		/* Fall-through */
1828708d96fdSRyan Mallon 
1829fef20d9cSFrederic Weisbecker 	default:
1830b006f19bSRasmus Villemoes 		WARN_ONCE(1, "Please remove unsupported %%%c in format string\n", *fmt);
1831fef20d9cSFrederic Weisbecker 		spec->type = FORMAT_TYPE_INVALID;
1832fef20d9cSFrederic Weisbecker 		return fmt - start;
1833fef20d9cSFrederic Weisbecker 	}
1834fef20d9cSFrederic Weisbecker 
1835d0484193SRasmus Villemoes 	if (qualifier == 'L')
1836fef20d9cSFrederic Weisbecker 		spec->type = FORMAT_TYPE_LONG_LONG;
1837d0484193SRasmus Villemoes 	else if (qualifier == 'l') {
183851be17dfSRasmus Villemoes 		BUILD_BUG_ON(FORMAT_TYPE_ULONG + SIGN != FORMAT_TYPE_LONG);
183951be17dfSRasmus Villemoes 		spec->type = FORMAT_TYPE_ULONG + (spec->flags & SIGN);
1840d0484193SRasmus Villemoes 	} else if (_tolower(qualifier) == 'z') {
1841fef20d9cSFrederic Weisbecker 		spec->type = FORMAT_TYPE_SIZE_T;
1842d0484193SRasmus Villemoes 	} else if (qualifier == 't') {
1843fef20d9cSFrederic Weisbecker 		spec->type = FORMAT_TYPE_PTRDIFF;
1844d0484193SRasmus Villemoes 	} else if (qualifier == 'H') {
184551be17dfSRasmus Villemoes 		BUILD_BUG_ON(FORMAT_TYPE_UBYTE + SIGN != FORMAT_TYPE_BYTE);
184651be17dfSRasmus Villemoes 		spec->type = FORMAT_TYPE_UBYTE + (spec->flags & SIGN);
1847d0484193SRasmus Villemoes 	} else if (qualifier == 'h') {
184851be17dfSRasmus Villemoes 		BUILD_BUG_ON(FORMAT_TYPE_USHORT + SIGN != FORMAT_TYPE_SHORT);
184951be17dfSRasmus Villemoes 		spec->type = FORMAT_TYPE_USHORT + (spec->flags & SIGN);
1850fef20d9cSFrederic Weisbecker 	} else {
185151be17dfSRasmus Villemoes 		BUILD_BUG_ON(FORMAT_TYPE_UINT + SIGN != FORMAT_TYPE_INT);
185251be17dfSRasmus Villemoes 		spec->type = FORMAT_TYPE_UINT + (spec->flags & SIGN);
1853fef20d9cSFrederic Weisbecker 	}
1854fef20d9cSFrederic Weisbecker 
1855fef20d9cSFrederic Weisbecker 	return ++fmt - start;
185678a8bf69SLinus Torvalds }
185778a8bf69SLinus Torvalds 
18584d72ba01SRasmus Villemoes static void
18594d72ba01SRasmus Villemoes set_field_width(struct printf_spec *spec, int width)
18604d72ba01SRasmus Villemoes {
18614d72ba01SRasmus Villemoes 	spec->field_width = width;
18624d72ba01SRasmus Villemoes 	if (WARN_ONCE(spec->field_width != width, "field width %d too large", width)) {
18634d72ba01SRasmus Villemoes 		spec->field_width = clamp(width, -FIELD_WIDTH_MAX, FIELD_WIDTH_MAX);
18644d72ba01SRasmus Villemoes 	}
18654d72ba01SRasmus Villemoes }
18664d72ba01SRasmus Villemoes 
18674d72ba01SRasmus Villemoes static void
18684d72ba01SRasmus Villemoes set_precision(struct printf_spec *spec, int prec)
18694d72ba01SRasmus Villemoes {
18704d72ba01SRasmus Villemoes 	spec->precision = prec;
18714d72ba01SRasmus Villemoes 	if (WARN_ONCE(spec->precision != prec, "precision %d too large", prec)) {
18724d72ba01SRasmus Villemoes 		spec->precision = clamp(prec, 0, PRECISION_MAX);
18734d72ba01SRasmus Villemoes 	}
18744d72ba01SRasmus Villemoes }
18754d72ba01SRasmus Villemoes 
18761da177e4SLinus Torvalds /**
18771da177e4SLinus Torvalds  * vsnprintf - Format a string and place it in a buffer
18781da177e4SLinus Torvalds  * @buf: The buffer to place the result into
18791da177e4SLinus Torvalds  * @size: The size of the buffer, including the trailing null space
18801da177e4SLinus Torvalds  * @fmt: The format string to use
18811da177e4SLinus Torvalds  * @args: Arguments for the format string
18821da177e4SLinus Torvalds  *
1883d7ec9a05SRasmus Villemoes  * This function generally follows C99 vsnprintf, but has some
1884d7ec9a05SRasmus Villemoes  * extensions and a few limitations:
1885d7ec9a05SRasmus Villemoes  *
1886d7ec9a05SRasmus Villemoes  * %n is unsupported
18875e4ee7b1SMartin Kletzander  * %p* is handled by pointer()
188820036fdcSAndi Kleen  *
18895e4ee7b1SMartin Kletzander  * See pointer() or Documentation/printk-formats.txt for more
18905e4ee7b1SMartin Kletzander  * extensive description.
18915e4ee7b1SMartin Kletzander  *
18925e4ee7b1SMartin Kletzander  * ** Please update the documentation in both places when making changes **
189380f548e0SAndrew Morton  *
18941da177e4SLinus Torvalds  * The return value is the number of characters which would
18951da177e4SLinus Torvalds  * be generated for the given input, excluding the trailing
18961da177e4SLinus Torvalds  * '\0', as per ISO C99. If you want to have the exact
18971da177e4SLinus Torvalds  * number of characters written into @buf as return value
189872fd4a35SRobert P. J. Day  * (not including the trailing '\0'), use vscnprintf(). If the
18991da177e4SLinus Torvalds  * return is greater than or equal to @size, the resulting
19001da177e4SLinus Torvalds  * string is truncated.
19011da177e4SLinus Torvalds  *
1902ba1835ebSUwe Kleine-König  * If you're not already dealing with a va_list consider using snprintf().
19031da177e4SLinus Torvalds  */
19041da177e4SLinus Torvalds int vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
19051da177e4SLinus Torvalds {
19061da177e4SLinus Torvalds 	unsigned long long num;
1907d4be151bSAndré Goddard Rosa 	char *str, *end;
1908fef20d9cSFrederic Weisbecker 	struct printf_spec spec = {0};
19091da177e4SLinus Torvalds 
1910f796937aSJeremy Fitzhardinge 	/* Reject out-of-range values early.  Large positive sizes are
1911f796937aSJeremy Fitzhardinge 	   used for unknown buffer sizes. */
19122aa2f9e2SRasmus Villemoes 	if (WARN_ON_ONCE(size > INT_MAX))
19131da177e4SLinus Torvalds 		return 0;
19141da177e4SLinus Torvalds 
19151da177e4SLinus Torvalds 	str = buf;
1916f796937aSJeremy Fitzhardinge 	end = buf + size;
19171da177e4SLinus Torvalds 
1918f796937aSJeremy Fitzhardinge 	/* Make sure end is always >= buf */
1919f796937aSJeremy Fitzhardinge 	if (end < buf) {
19201da177e4SLinus Torvalds 		end = ((void *)-1);
1921f796937aSJeremy Fitzhardinge 		size = end - buf;
19221da177e4SLinus Torvalds 	}
19231da177e4SLinus Torvalds 
1924fef20d9cSFrederic Weisbecker 	while (*fmt) {
1925fef20d9cSFrederic Weisbecker 		const char *old_fmt = fmt;
1926d4be151bSAndré Goddard Rosa 		int read = format_decode(fmt, &spec);
1927fef20d9cSFrederic Weisbecker 
1928fef20d9cSFrederic Weisbecker 		fmt += read;
1929fef20d9cSFrederic Weisbecker 
1930fef20d9cSFrederic Weisbecker 		switch (spec.type) {
1931fef20d9cSFrederic Weisbecker 		case FORMAT_TYPE_NONE: {
1932fef20d9cSFrederic Weisbecker 			int copy = read;
1933fef20d9cSFrederic Weisbecker 			if (str < end) {
1934fef20d9cSFrederic Weisbecker 				if (copy > end - str)
1935fef20d9cSFrederic Weisbecker 					copy = end - str;
1936fef20d9cSFrederic Weisbecker 				memcpy(str, old_fmt, copy);
1937fef20d9cSFrederic Weisbecker 			}
1938fef20d9cSFrederic Weisbecker 			str += read;
1939fef20d9cSFrederic Weisbecker 			break;
19401da177e4SLinus Torvalds 		}
19411da177e4SLinus Torvalds 
1942ed681a91SVegard Nossum 		case FORMAT_TYPE_WIDTH:
19434d72ba01SRasmus Villemoes 			set_field_width(&spec, va_arg(args, int));
1944fef20d9cSFrederic Weisbecker 			break;
19451da177e4SLinus Torvalds 
1946fef20d9cSFrederic Weisbecker 		case FORMAT_TYPE_PRECISION:
19474d72ba01SRasmus Villemoes 			set_precision(&spec, va_arg(args, int));
1948fef20d9cSFrederic Weisbecker 			break;
19491da177e4SLinus Torvalds 
1950d4be151bSAndré Goddard Rosa 		case FORMAT_TYPE_CHAR: {
1951d4be151bSAndré Goddard Rosa 			char c;
1952d4be151bSAndré Goddard Rosa 
1953fef20d9cSFrederic Weisbecker 			if (!(spec.flags & LEFT)) {
1954fef20d9cSFrederic Weisbecker 				while (--spec.field_width > 0) {
1955f796937aSJeremy Fitzhardinge 					if (str < end)
19561da177e4SLinus Torvalds 						*str = ' ';
19571da177e4SLinus Torvalds 					++str;
1958fef20d9cSFrederic Weisbecker 
19591da177e4SLinus Torvalds 				}
19601da177e4SLinus Torvalds 			}
19611da177e4SLinus Torvalds 			c = (unsigned char) va_arg(args, int);
1962f796937aSJeremy Fitzhardinge 			if (str < end)
19631da177e4SLinus Torvalds 				*str = c;
19641da177e4SLinus Torvalds 			++str;
1965fef20d9cSFrederic Weisbecker 			while (--spec.field_width > 0) {
1966f796937aSJeremy Fitzhardinge 				if (str < end)
19671da177e4SLinus Torvalds 					*str = ' ';
19681da177e4SLinus Torvalds 				++str;
19691da177e4SLinus Torvalds 			}
1970fef20d9cSFrederic Weisbecker 			break;
1971d4be151bSAndré Goddard Rosa 		}
19721da177e4SLinus Torvalds 
1973fef20d9cSFrederic Weisbecker 		case FORMAT_TYPE_STR:
1974fef20d9cSFrederic Weisbecker 			str = string(str, end, va_arg(args, char *), spec);
1975fef20d9cSFrederic Weisbecker 			break;
19761da177e4SLinus Torvalds 
1977fef20d9cSFrederic Weisbecker 		case FORMAT_TYPE_PTR:
1978ffbfed03SRasmus Villemoes 			str = pointer(fmt, str, end, va_arg(args, void *),
1979fef20d9cSFrederic Weisbecker 				      spec);
1980fef20d9cSFrederic Weisbecker 			while (isalnum(*fmt))
19814d8a743cSLinus Torvalds 				fmt++;
1982fef20d9cSFrederic Weisbecker 			break;
19831da177e4SLinus Torvalds 
1984fef20d9cSFrederic Weisbecker 		case FORMAT_TYPE_PERCENT_CHAR:
1985f796937aSJeremy Fitzhardinge 			if (str < end)
19861da177e4SLinus Torvalds 				*str = '%';
19871da177e4SLinus Torvalds 			++str;
19881da177e4SLinus Torvalds 			break;
19891da177e4SLinus Torvalds 
1990fef20d9cSFrederic Weisbecker 		case FORMAT_TYPE_INVALID:
1991b006f19bSRasmus Villemoes 			/*
1992b006f19bSRasmus Villemoes 			 * Presumably the arguments passed gcc's type
1993b006f19bSRasmus Villemoes 			 * checking, but there is no safe or sane way
1994b006f19bSRasmus Villemoes 			 * for us to continue parsing the format and
1995b006f19bSRasmus Villemoes 			 * fetching from the va_list; the remaining
1996b006f19bSRasmus Villemoes 			 * specifiers and arguments would be out of
1997b006f19bSRasmus Villemoes 			 * sync.
1998b006f19bSRasmus Villemoes 			 */
1999b006f19bSRasmus Villemoes 			goto out;
2000fef20d9cSFrederic Weisbecker 
2001fef20d9cSFrederic Weisbecker 		default:
2002fef20d9cSFrederic Weisbecker 			switch (spec.type) {
2003fef20d9cSFrederic Weisbecker 			case FORMAT_TYPE_LONG_LONG:
2004fef20d9cSFrederic Weisbecker 				num = va_arg(args, long long);
2005fef20d9cSFrederic Weisbecker 				break;
2006fef20d9cSFrederic Weisbecker 			case FORMAT_TYPE_ULONG:
2007fef20d9cSFrederic Weisbecker 				num = va_arg(args, unsigned long);
2008fef20d9cSFrederic Weisbecker 				break;
2009fef20d9cSFrederic Weisbecker 			case FORMAT_TYPE_LONG:
2010fef20d9cSFrederic Weisbecker 				num = va_arg(args, long);
2011fef20d9cSFrederic Weisbecker 				break;
2012fef20d9cSFrederic Weisbecker 			case FORMAT_TYPE_SIZE_T:
2013ef124960SJason Gunthorpe 				if (spec.flags & SIGN)
2014ef124960SJason Gunthorpe 					num = va_arg(args, ssize_t);
2015ef124960SJason Gunthorpe 				else
2016fef20d9cSFrederic Weisbecker 					num = va_arg(args, size_t);
2017fef20d9cSFrederic Weisbecker 				break;
2018fef20d9cSFrederic Weisbecker 			case FORMAT_TYPE_PTRDIFF:
2019fef20d9cSFrederic Weisbecker 				num = va_arg(args, ptrdiff_t);
2020fef20d9cSFrederic Weisbecker 				break;
2021a4e94ef0SZhaolei 			case FORMAT_TYPE_UBYTE:
2022a4e94ef0SZhaolei 				num = (unsigned char) va_arg(args, int);
2023a4e94ef0SZhaolei 				break;
2024a4e94ef0SZhaolei 			case FORMAT_TYPE_BYTE:
2025a4e94ef0SZhaolei 				num = (signed char) va_arg(args, int);
2026a4e94ef0SZhaolei 				break;
2027fef20d9cSFrederic Weisbecker 			case FORMAT_TYPE_USHORT:
2028fef20d9cSFrederic Weisbecker 				num = (unsigned short) va_arg(args, int);
2029fef20d9cSFrederic Weisbecker 				break;
2030fef20d9cSFrederic Weisbecker 			case FORMAT_TYPE_SHORT:
2031fef20d9cSFrederic Weisbecker 				num = (short) va_arg(args, int);
2032fef20d9cSFrederic Weisbecker 				break;
203339e874f8SFrederic Weisbecker 			case FORMAT_TYPE_INT:
203439e874f8SFrederic Weisbecker 				num = (int) va_arg(args, int);
2035fef20d9cSFrederic Weisbecker 				break;
2036fef20d9cSFrederic Weisbecker 			default:
2037fef20d9cSFrederic Weisbecker 				num = va_arg(args, unsigned int);
20381da177e4SLinus Torvalds 			}
2039fef20d9cSFrederic Weisbecker 
2040fef20d9cSFrederic Weisbecker 			str = number(str, end, num, spec);
20411da177e4SLinus Torvalds 		}
2042fef20d9cSFrederic Weisbecker 	}
2043fef20d9cSFrederic Weisbecker 
2044b006f19bSRasmus Villemoes out:
2045f796937aSJeremy Fitzhardinge 	if (size > 0) {
2046f796937aSJeremy Fitzhardinge 		if (str < end)
20471da177e4SLinus Torvalds 			*str = '\0';
2048f796937aSJeremy Fitzhardinge 		else
20490a6047eeSLinus Torvalds 			end[-1] = '\0';
2050f796937aSJeremy Fitzhardinge 	}
2051fef20d9cSFrederic Weisbecker 
2052f796937aSJeremy Fitzhardinge 	/* the trailing null byte doesn't count towards the total */
20531da177e4SLinus Torvalds 	return str-buf;
2054fef20d9cSFrederic Weisbecker 
20551da177e4SLinus Torvalds }
20561da177e4SLinus Torvalds EXPORT_SYMBOL(vsnprintf);
20571da177e4SLinus Torvalds 
20581da177e4SLinus Torvalds /**
20591da177e4SLinus Torvalds  * vscnprintf - Format a string and place it in a buffer
20601da177e4SLinus Torvalds  * @buf: The buffer to place the result into
20611da177e4SLinus Torvalds  * @size: The size of the buffer, including the trailing null space
20621da177e4SLinus Torvalds  * @fmt: The format string to use
20631da177e4SLinus Torvalds  * @args: Arguments for the format string
20641da177e4SLinus Torvalds  *
20651da177e4SLinus Torvalds  * The return value is the number of characters which have been written into
2066b921c69fSAnton Arapov  * the @buf not including the trailing '\0'. If @size is == 0 the function
20671da177e4SLinus Torvalds  * returns 0.
20681da177e4SLinus Torvalds  *
2069ba1835ebSUwe Kleine-König  * If you're not already dealing with a va_list consider using scnprintf().
207020036fdcSAndi Kleen  *
207120036fdcSAndi Kleen  * See the vsnprintf() documentation for format string extensions over C99.
20721da177e4SLinus Torvalds  */
20731da177e4SLinus Torvalds int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
20741da177e4SLinus Torvalds {
20751da177e4SLinus Torvalds 	int i;
20761da177e4SLinus Torvalds 
20771da177e4SLinus Torvalds 	i = vsnprintf(buf, size, fmt, args);
20787b9186f5SAndré Goddard Rosa 
2079b921c69fSAnton Arapov 	if (likely(i < size))
2080b921c69fSAnton Arapov 		return i;
2081b921c69fSAnton Arapov 	if (size != 0)
2082b921c69fSAnton Arapov 		return size - 1;
2083b921c69fSAnton Arapov 	return 0;
20841da177e4SLinus Torvalds }
20851da177e4SLinus Torvalds EXPORT_SYMBOL(vscnprintf);
20861da177e4SLinus Torvalds 
20871da177e4SLinus Torvalds /**
20881da177e4SLinus Torvalds  * snprintf - Format a string and place it in a buffer
20891da177e4SLinus Torvalds  * @buf: The buffer to place the result into
20901da177e4SLinus Torvalds  * @size: The size of the buffer, including the trailing null space
20911da177e4SLinus Torvalds  * @fmt: The format string to use
20921da177e4SLinus Torvalds  * @...: Arguments for the format string
20931da177e4SLinus Torvalds  *
20941da177e4SLinus Torvalds  * The return value is the number of characters which would be
20951da177e4SLinus Torvalds  * generated for the given input, excluding the trailing null,
20961da177e4SLinus Torvalds  * as per ISO C99.  If the return is greater than or equal to
20971da177e4SLinus Torvalds  * @size, the resulting string is truncated.
209820036fdcSAndi Kleen  *
209920036fdcSAndi Kleen  * See the vsnprintf() documentation for format string extensions over C99.
21001da177e4SLinus Torvalds  */
21011da177e4SLinus Torvalds int snprintf(char *buf, size_t size, const char *fmt, ...)
21021da177e4SLinus Torvalds {
21031da177e4SLinus Torvalds 	va_list args;
21041da177e4SLinus Torvalds 	int i;
21051da177e4SLinus Torvalds 
21061da177e4SLinus Torvalds 	va_start(args, fmt);
21071da177e4SLinus Torvalds 	i = vsnprintf(buf, size, fmt, args);
21081da177e4SLinus Torvalds 	va_end(args);
21097b9186f5SAndré Goddard Rosa 
21101da177e4SLinus Torvalds 	return i;
21111da177e4SLinus Torvalds }
21121da177e4SLinus Torvalds EXPORT_SYMBOL(snprintf);
21131da177e4SLinus Torvalds 
21141da177e4SLinus Torvalds /**
21151da177e4SLinus Torvalds  * scnprintf - Format a string and place it in a buffer
21161da177e4SLinus Torvalds  * @buf: The buffer to place the result into
21171da177e4SLinus Torvalds  * @size: The size of the buffer, including the trailing null space
21181da177e4SLinus Torvalds  * @fmt: The format string to use
21191da177e4SLinus Torvalds  * @...: Arguments for the format string
21201da177e4SLinus Torvalds  *
21211da177e4SLinus Torvalds  * The return value is the number of characters written into @buf not including
2122b903c0b8SChangli Gao  * the trailing '\0'. If @size is == 0 the function returns 0.
21231da177e4SLinus Torvalds  */
21241da177e4SLinus Torvalds 
21251da177e4SLinus Torvalds int scnprintf(char *buf, size_t size, const char *fmt, ...)
21261da177e4SLinus Torvalds {
21271da177e4SLinus Torvalds 	va_list args;
21281da177e4SLinus Torvalds 	int i;
21291da177e4SLinus Torvalds 
21301da177e4SLinus Torvalds 	va_start(args, fmt);
2131b921c69fSAnton Arapov 	i = vscnprintf(buf, size, fmt, args);
21321da177e4SLinus Torvalds 	va_end(args);
21337b9186f5SAndré Goddard Rosa 
2134b903c0b8SChangli Gao 	return i;
21351da177e4SLinus Torvalds }
21361da177e4SLinus Torvalds EXPORT_SYMBOL(scnprintf);
21371da177e4SLinus Torvalds 
21381da177e4SLinus Torvalds /**
21391da177e4SLinus Torvalds  * vsprintf - Format a string and place it in a buffer
21401da177e4SLinus Torvalds  * @buf: The buffer to place the result into
21411da177e4SLinus Torvalds  * @fmt: The format string to use
21421da177e4SLinus Torvalds  * @args: Arguments for the format string
21431da177e4SLinus Torvalds  *
21441da177e4SLinus Torvalds  * The function returns the number of characters written
214572fd4a35SRobert P. J. Day  * into @buf. Use vsnprintf() or vscnprintf() in order to avoid
21461da177e4SLinus Torvalds  * buffer overflows.
21471da177e4SLinus Torvalds  *
2148ba1835ebSUwe Kleine-König  * If you're not already dealing with a va_list consider using sprintf().
214920036fdcSAndi Kleen  *
215020036fdcSAndi Kleen  * See the vsnprintf() documentation for format string extensions over C99.
21511da177e4SLinus Torvalds  */
21521da177e4SLinus Torvalds int vsprintf(char *buf, const char *fmt, va_list args)
21531da177e4SLinus Torvalds {
21541da177e4SLinus Torvalds 	return vsnprintf(buf, INT_MAX, fmt, args);
21551da177e4SLinus Torvalds }
21561da177e4SLinus Torvalds EXPORT_SYMBOL(vsprintf);
21571da177e4SLinus Torvalds 
21581da177e4SLinus Torvalds /**
21591da177e4SLinus Torvalds  * sprintf - Format a string and place it in a buffer
21601da177e4SLinus Torvalds  * @buf: The buffer to place the result into
21611da177e4SLinus Torvalds  * @fmt: The format string to use
21621da177e4SLinus Torvalds  * @...: Arguments for the format string
21631da177e4SLinus Torvalds  *
21641da177e4SLinus Torvalds  * The function returns the number of characters written
216572fd4a35SRobert P. J. Day  * into @buf. Use snprintf() or scnprintf() in order to avoid
21661da177e4SLinus Torvalds  * buffer overflows.
216720036fdcSAndi Kleen  *
216820036fdcSAndi Kleen  * See the vsnprintf() documentation for format string extensions over C99.
21691da177e4SLinus Torvalds  */
21701da177e4SLinus Torvalds int sprintf(char *buf, const char *fmt, ...)
21711da177e4SLinus Torvalds {
21721da177e4SLinus Torvalds 	va_list args;
21731da177e4SLinus Torvalds 	int i;
21741da177e4SLinus Torvalds 
21751da177e4SLinus Torvalds 	va_start(args, fmt);
21761da177e4SLinus Torvalds 	i = vsnprintf(buf, INT_MAX, fmt, args);
21771da177e4SLinus Torvalds 	va_end(args);
21787b9186f5SAndré Goddard Rosa 
21791da177e4SLinus Torvalds 	return i;
21801da177e4SLinus Torvalds }
21811da177e4SLinus Torvalds EXPORT_SYMBOL(sprintf);
21821da177e4SLinus Torvalds 
21834370aa4aSLai Jiangshan #ifdef CONFIG_BINARY_PRINTF
21844370aa4aSLai Jiangshan /*
21854370aa4aSLai Jiangshan  * bprintf service:
21864370aa4aSLai Jiangshan  * vbin_printf() - VA arguments to binary data
21874370aa4aSLai Jiangshan  * bstr_printf() - Binary data to text string
21884370aa4aSLai Jiangshan  */
21894370aa4aSLai Jiangshan 
21904370aa4aSLai Jiangshan /**
21914370aa4aSLai Jiangshan  * vbin_printf - Parse a format string and place args' binary value in a buffer
21924370aa4aSLai Jiangshan  * @bin_buf: The buffer to place args' binary value
21934370aa4aSLai Jiangshan  * @size: The size of the buffer(by words(32bits), not characters)
21944370aa4aSLai Jiangshan  * @fmt: The format string to use
21954370aa4aSLai Jiangshan  * @args: Arguments for the format string
21964370aa4aSLai Jiangshan  *
21974370aa4aSLai Jiangshan  * The format follows C99 vsnprintf, except %n is ignored, and its argument
2198da3dae54SMasanari Iida  * is skipped.
21994370aa4aSLai Jiangshan  *
22004370aa4aSLai Jiangshan  * The return value is the number of words(32bits) which would be generated for
22014370aa4aSLai Jiangshan  * the given input.
22024370aa4aSLai Jiangshan  *
22034370aa4aSLai Jiangshan  * NOTE:
22044370aa4aSLai Jiangshan  * If the return value is greater than @size, the resulting bin_buf is NOT
22054370aa4aSLai Jiangshan  * valid for bstr_printf().
22064370aa4aSLai Jiangshan  */
22074370aa4aSLai Jiangshan int vbin_printf(u32 *bin_buf, size_t size, const char *fmt, va_list args)
22084370aa4aSLai Jiangshan {
2209fef20d9cSFrederic Weisbecker 	struct printf_spec spec = {0};
22104370aa4aSLai Jiangshan 	char *str, *end;
22114370aa4aSLai Jiangshan 
22124370aa4aSLai Jiangshan 	str = (char *)bin_buf;
22134370aa4aSLai Jiangshan 	end = (char *)(bin_buf + size);
22144370aa4aSLai Jiangshan 
22154370aa4aSLai Jiangshan #define save_arg(type)							\
22164370aa4aSLai Jiangshan do {									\
22174370aa4aSLai Jiangshan 	if (sizeof(type) == 8) {					\
22184370aa4aSLai Jiangshan 		unsigned long long value;				\
22194370aa4aSLai Jiangshan 		str = PTR_ALIGN(str, sizeof(u32));			\
22204370aa4aSLai Jiangshan 		value = va_arg(args, unsigned long long);		\
22214370aa4aSLai Jiangshan 		if (str + sizeof(type) <= end) {			\
22224370aa4aSLai Jiangshan 			*(u32 *)str = *(u32 *)&value;			\
22234370aa4aSLai Jiangshan 			*(u32 *)(str + 4) = *((u32 *)&value + 1);	\
22244370aa4aSLai Jiangshan 		}							\
22254370aa4aSLai Jiangshan 	} else {							\
22264370aa4aSLai Jiangshan 		unsigned long value;					\
22274370aa4aSLai Jiangshan 		str = PTR_ALIGN(str, sizeof(type));			\
22284370aa4aSLai Jiangshan 		value = va_arg(args, int);				\
22294370aa4aSLai Jiangshan 		if (str + sizeof(type) <= end)				\
22304370aa4aSLai Jiangshan 			*(typeof(type) *)str = (type)value;		\
22314370aa4aSLai Jiangshan 	}								\
22324370aa4aSLai Jiangshan 	str += sizeof(type);						\
22334370aa4aSLai Jiangshan } while (0)
22344370aa4aSLai Jiangshan 
2235fef20d9cSFrederic Weisbecker 	while (*fmt) {
2236d4be151bSAndré Goddard Rosa 		int read = format_decode(fmt, &spec);
22374370aa4aSLai Jiangshan 
2238fef20d9cSFrederic Weisbecker 		fmt += read;
2239fef20d9cSFrederic Weisbecker 
2240fef20d9cSFrederic Weisbecker 		switch (spec.type) {
2241fef20d9cSFrederic Weisbecker 		case FORMAT_TYPE_NONE:
2242d4be151bSAndré Goddard Rosa 		case FORMAT_TYPE_PERCENT_CHAR:
2243fef20d9cSFrederic Weisbecker 			break;
2244b006f19bSRasmus Villemoes 		case FORMAT_TYPE_INVALID:
2245b006f19bSRasmus Villemoes 			goto out;
2246fef20d9cSFrederic Weisbecker 
2247ed681a91SVegard Nossum 		case FORMAT_TYPE_WIDTH:
2248fef20d9cSFrederic Weisbecker 		case FORMAT_TYPE_PRECISION:
22494370aa4aSLai Jiangshan 			save_arg(int);
2250fef20d9cSFrederic Weisbecker 			break;
22514370aa4aSLai Jiangshan 
2252fef20d9cSFrederic Weisbecker 		case FORMAT_TYPE_CHAR:
22534370aa4aSLai Jiangshan 			save_arg(char);
2254fef20d9cSFrederic Weisbecker 			break;
2255fef20d9cSFrederic Weisbecker 
2256fef20d9cSFrederic Weisbecker 		case FORMAT_TYPE_STR: {
22574370aa4aSLai Jiangshan 			const char *save_str = va_arg(args, char *);
22584370aa4aSLai Jiangshan 			size_t len;
22596c356634SAndré Goddard Rosa 
22604370aa4aSLai Jiangshan 			if ((unsigned long)save_str > (unsigned long)-PAGE_SIZE
22614370aa4aSLai Jiangshan 					|| (unsigned long)save_str < PAGE_SIZE)
22620f4f81dcSAndré Goddard Rosa 				save_str = "(null)";
22636c356634SAndré Goddard Rosa 			len = strlen(save_str) + 1;
22646c356634SAndré Goddard Rosa 			if (str + len < end)
22656c356634SAndré Goddard Rosa 				memcpy(str, save_str, len);
22666c356634SAndré Goddard Rosa 			str += len;
2267fef20d9cSFrederic Weisbecker 			break;
22684370aa4aSLai Jiangshan 		}
2269fef20d9cSFrederic Weisbecker 
2270fef20d9cSFrederic Weisbecker 		case FORMAT_TYPE_PTR:
22714370aa4aSLai Jiangshan 			save_arg(void *);
22724370aa4aSLai Jiangshan 			/* skip all alphanumeric pointer suffixes */
2273fef20d9cSFrederic Weisbecker 			while (isalnum(*fmt))
22744370aa4aSLai Jiangshan 				fmt++;
2275fef20d9cSFrederic Weisbecker 			break;
2276fef20d9cSFrederic Weisbecker 
2277fef20d9cSFrederic Weisbecker 		default:
2278fef20d9cSFrederic Weisbecker 			switch (spec.type) {
2279fef20d9cSFrederic Weisbecker 
2280fef20d9cSFrederic Weisbecker 			case FORMAT_TYPE_LONG_LONG:
2281fef20d9cSFrederic Weisbecker 				save_arg(long long);
2282fef20d9cSFrederic Weisbecker 				break;
2283fef20d9cSFrederic Weisbecker 			case FORMAT_TYPE_ULONG:
2284fef20d9cSFrederic Weisbecker 			case FORMAT_TYPE_LONG:
2285fef20d9cSFrederic Weisbecker 				save_arg(unsigned long);
2286fef20d9cSFrederic Weisbecker 				break;
2287fef20d9cSFrederic Weisbecker 			case FORMAT_TYPE_SIZE_T:
2288fef20d9cSFrederic Weisbecker 				save_arg(size_t);
2289fef20d9cSFrederic Weisbecker 				break;
2290fef20d9cSFrederic Weisbecker 			case FORMAT_TYPE_PTRDIFF:
2291fef20d9cSFrederic Weisbecker 				save_arg(ptrdiff_t);
2292fef20d9cSFrederic Weisbecker 				break;
2293a4e94ef0SZhaolei 			case FORMAT_TYPE_UBYTE:
2294a4e94ef0SZhaolei 			case FORMAT_TYPE_BYTE:
2295a4e94ef0SZhaolei 				save_arg(char);
2296a4e94ef0SZhaolei 				break;
2297fef20d9cSFrederic Weisbecker 			case FORMAT_TYPE_USHORT:
2298fef20d9cSFrederic Weisbecker 			case FORMAT_TYPE_SHORT:
2299fef20d9cSFrederic Weisbecker 				save_arg(short);
2300fef20d9cSFrederic Weisbecker 				break;
2301fef20d9cSFrederic Weisbecker 			default:
2302fef20d9cSFrederic Weisbecker 				save_arg(int);
2303fef20d9cSFrederic Weisbecker 			}
2304fef20d9cSFrederic Weisbecker 		}
2305fef20d9cSFrederic Weisbecker 	}
2306fef20d9cSFrederic Weisbecker 
2307b006f19bSRasmus Villemoes out:
23087b9186f5SAndré Goddard Rosa 	return (u32 *)(PTR_ALIGN(str, sizeof(u32))) - bin_buf;
2309fef20d9cSFrederic Weisbecker #undef save_arg
23104370aa4aSLai Jiangshan }
23114370aa4aSLai Jiangshan EXPORT_SYMBOL_GPL(vbin_printf);
23124370aa4aSLai Jiangshan 
23134370aa4aSLai Jiangshan /**
23144370aa4aSLai Jiangshan  * bstr_printf - Format a string from binary arguments and place it in a buffer
23154370aa4aSLai Jiangshan  * @buf: The buffer to place the result into
23164370aa4aSLai Jiangshan  * @size: The size of the buffer, including the trailing null space
23174370aa4aSLai Jiangshan  * @fmt: The format string to use
23184370aa4aSLai Jiangshan  * @bin_buf: Binary arguments for the format string
23194370aa4aSLai Jiangshan  *
23204370aa4aSLai Jiangshan  * This function like C99 vsnprintf, but the difference is that vsnprintf gets
23214370aa4aSLai Jiangshan  * arguments from stack, and bstr_printf gets arguments from @bin_buf which is
23224370aa4aSLai Jiangshan  * a binary buffer that generated by vbin_printf.
23234370aa4aSLai Jiangshan  *
23244370aa4aSLai Jiangshan  * The format follows C99 vsnprintf, but has some extensions:
23250efb4d20SSteven Rostedt  *  see vsnprintf comment for details.
23264370aa4aSLai Jiangshan  *
23274370aa4aSLai Jiangshan  * The return value is the number of characters which would
23284370aa4aSLai Jiangshan  * be generated for the given input, excluding the trailing
23294370aa4aSLai Jiangshan  * '\0', as per ISO C99. If you want to have the exact
23304370aa4aSLai Jiangshan  * number of characters written into @buf as return value
23314370aa4aSLai Jiangshan  * (not including the trailing '\0'), use vscnprintf(). If the
23324370aa4aSLai Jiangshan  * return is greater than or equal to @size, the resulting
23334370aa4aSLai Jiangshan  * string is truncated.
23344370aa4aSLai Jiangshan  */
23354370aa4aSLai Jiangshan int bstr_printf(char *buf, size_t size, const char *fmt, const u32 *bin_buf)
23364370aa4aSLai Jiangshan {
2337fef20d9cSFrederic Weisbecker 	struct printf_spec spec = {0};
2338d4be151bSAndré Goddard Rosa 	char *str, *end;
2339d4be151bSAndré Goddard Rosa 	const char *args = (const char *)bin_buf;
23404370aa4aSLai Jiangshan 
2341762abb51SRasmus Villemoes 	if (WARN_ON_ONCE(size > INT_MAX))
23424370aa4aSLai Jiangshan 		return 0;
23434370aa4aSLai Jiangshan 
23444370aa4aSLai Jiangshan 	str = buf;
23454370aa4aSLai Jiangshan 	end = buf + size;
23464370aa4aSLai Jiangshan 
23474370aa4aSLai Jiangshan #define get_arg(type)							\
23484370aa4aSLai Jiangshan ({									\
23494370aa4aSLai Jiangshan 	typeof(type) value;						\
23504370aa4aSLai Jiangshan 	if (sizeof(type) == 8) {					\
23514370aa4aSLai Jiangshan 		args = PTR_ALIGN(args, sizeof(u32));			\
23524370aa4aSLai Jiangshan 		*(u32 *)&value = *(u32 *)args;				\
23534370aa4aSLai Jiangshan 		*((u32 *)&value + 1) = *(u32 *)(args + 4);		\
23544370aa4aSLai Jiangshan 	} else {							\
23554370aa4aSLai Jiangshan 		args = PTR_ALIGN(args, sizeof(type));			\
23564370aa4aSLai Jiangshan 		value = *(typeof(type) *)args;				\
23574370aa4aSLai Jiangshan 	}								\
23584370aa4aSLai Jiangshan 	args += sizeof(type);						\
23594370aa4aSLai Jiangshan 	value;								\
23604370aa4aSLai Jiangshan })
23614370aa4aSLai Jiangshan 
23624370aa4aSLai Jiangshan 	/* Make sure end is always >= buf */
23634370aa4aSLai Jiangshan 	if (end < buf) {
23644370aa4aSLai Jiangshan 		end = ((void *)-1);
23654370aa4aSLai Jiangshan 		size = end - buf;
23664370aa4aSLai Jiangshan 	}
23674370aa4aSLai Jiangshan 
2368fef20d9cSFrederic Weisbecker 	while (*fmt) {
2369fef20d9cSFrederic Weisbecker 		const char *old_fmt = fmt;
2370d4be151bSAndré Goddard Rosa 		int read = format_decode(fmt, &spec);
2371fef20d9cSFrederic Weisbecker 
2372fef20d9cSFrederic Weisbecker 		fmt += read;
2373fef20d9cSFrederic Weisbecker 
2374fef20d9cSFrederic Weisbecker 		switch (spec.type) {
2375fef20d9cSFrederic Weisbecker 		case FORMAT_TYPE_NONE: {
2376fef20d9cSFrederic Weisbecker 			int copy = read;
2377fef20d9cSFrederic Weisbecker 			if (str < end) {
2378fef20d9cSFrederic Weisbecker 				if (copy > end - str)
2379fef20d9cSFrederic Weisbecker 					copy = end - str;
2380fef20d9cSFrederic Weisbecker 				memcpy(str, old_fmt, copy);
2381fef20d9cSFrederic Weisbecker 			}
2382fef20d9cSFrederic Weisbecker 			str += read;
2383fef20d9cSFrederic Weisbecker 			break;
23844370aa4aSLai Jiangshan 		}
23854370aa4aSLai Jiangshan 
2386ed681a91SVegard Nossum 		case FORMAT_TYPE_WIDTH:
23874d72ba01SRasmus Villemoes 			set_field_width(&spec, get_arg(int));
2388fef20d9cSFrederic Weisbecker 			break;
23894370aa4aSLai Jiangshan 
2390fef20d9cSFrederic Weisbecker 		case FORMAT_TYPE_PRECISION:
23914d72ba01SRasmus Villemoes 			set_precision(&spec, get_arg(int));
2392fef20d9cSFrederic Weisbecker 			break;
23934370aa4aSLai Jiangshan 
2394d4be151bSAndré Goddard Rosa 		case FORMAT_TYPE_CHAR: {
2395d4be151bSAndré Goddard Rosa 			char c;
2396d4be151bSAndré Goddard Rosa 
2397fef20d9cSFrederic Weisbecker 			if (!(spec.flags & LEFT)) {
2398fef20d9cSFrederic Weisbecker 				while (--spec.field_width > 0) {
23994370aa4aSLai Jiangshan 					if (str < end)
24004370aa4aSLai Jiangshan 						*str = ' ';
24014370aa4aSLai Jiangshan 					++str;
24024370aa4aSLai Jiangshan 				}
24034370aa4aSLai Jiangshan 			}
24044370aa4aSLai Jiangshan 			c = (unsigned char) get_arg(char);
24054370aa4aSLai Jiangshan 			if (str < end)
24064370aa4aSLai Jiangshan 				*str = c;
24074370aa4aSLai Jiangshan 			++str;
2408fef20d9cSFrederic Weisbecker 			while (--spec.field_width > 0) {
24094370aa4aSLai Jiangshan 				if (str < end)
24104370aa4aSLai Jiangshan 					*str = ' ';
24114370aa4aSLai Jiangshan 				++str;
24124370aa4aSLai Jiangshan 			}
2413fef20d9cSFrederic Weisbecker 			break;
2414d4be151bSAndré Goddard Rosa 		}
24154370aa4aSLai Jiangshan 
2416fef20d9cSFrederic Weisbecker 		case FORMAT_TYPE_STR: {
24174370aa4aSLai Jiangshan 			const char *str_arg = args;
2418d4be151bSAndré Goddard Rosa 			args += strlen(str_arg) + 1;
2419fef20d9cSFrederic Weisbecker 			str = string(str, end, (char *)str_arg, spec);
2420fef20d9cSFrederic Weisbecker 			break;
24214370aa4aSLai Jiangshan 		}
24224370aa4aSLai Jiangshan 
2423fef20d9cSFrederic Weisbecker 		case FORMAT_TYPE_PTR:
2424ffbfed03SRasmus Villemoes 			str = pointer(fmt, str, end, get_arg(void *), spec);
2425fef20d9cSFrederic Weisbecker 			while (isalnum(*fmt))
24264370aa4aSLai Jiangshan 				fmt++;
2427fef20d9cSFrederic Weisbecker 			break;
24284370aa4aSLai Jiangshan 
2429fef20d9cSFrederic Weisbecker 		case FORMAT_TYPE_PERCENT_CHAR:
24304370aa4aSLai Jiangshan 			if (str < end)
24314370aa4aSLai Jiangshan 				*str = '%';
24324370aa4aSLai Jiangshan 			++str;
2433fef20d9cSFrederic Weisbecker 			break;
2434fef20d9cSFrederic Weisbecker 
2435b006f19bSRasmus Villemoes 		case FORMAT_TYPE_INVALID:
2436b006f19bSRasmus Villemoes 			goto out;
2437b006f19bSRasmus Villemoes 
2438d4be151bSAndré Goddard Rosa 		default: {
2439d4be151bSAndré Goddard Rosa 			unsigned long long num;
2440d4be151bSAndré Goddard Rosa 
2441fef20d9cSFrederic Weisbecker 			switch (spec.type) {
2442fef20d9cSFrederic Weisbecker 
2443fef20d9cSFrederic Weisbecker 			case FORMAT_TYPE_LONG_LONG:
24444370aa4aSLai Jiangshan 				num = get_arg(long long);
2445fef20d9cSFrederic Weisbecker 				break;
2446fef20d9cSFrederic Weisbecker 			case FORMAT_TYPE_ULONG:
2447fef20d9cSFrederic Weisbecker 			case FORMAT_TYPE_LONG:
2448fef20d9cSFrederic Weisbecker 				num = get_arg(unsigned long);
2449fef20d9cSFrederic Weisbecker 				break;
2450fef20d9cSFrederic Weisbecker 			case FORMAT_TYPE_SIZE_T:
24514370aa4aSLai Jiangshan 				num = get_arg(size_t);
2452fef20d9cSFrederic Weisbecker 				break;
2453fef20d9cSFrederic Weisbecker 			case FORMAT_TYPE_PTRDIFF:
24544370aa4aSLai Jiangshan 				num = get_arg(ptrdiff_t);
2455fef20d9cSFrederic Weisbecker 				break;
2456a4e94ef0SZhaolei 			case FORMAT_TYPE_UBYTE:
2457a4e94ef0SZhaolei 				num = get_arg(unsigned char);
2458a4e94ef0SZhaolei 				break;
2459a4e94ef0SZhaolei 			case FORMAT_TYPE_BYTE:
2460a4e94ef0SZhaolei 				num = get_arg(signed char);
2461a4e94ef0SZhaolei 				break;
2462fef20d9cSFrederic Weisbecker 			case FORMAT_TYPE_USHORT:
2463fef20d9cSFrederic Weisbecker 				num = get_arg(unsigned short);
2464fef20d9cSFrederic Weisbecker 				break;
2465fef20d9cSFrederic Weisbecker 			case FORMAT_TYPE_SHORT:
2466fef20d9cSFrederic Weisbecker 				num = get_arg(short);
2467fef20d9cSFrederic Weisbecker 				break;
2468fef20d9cSFrederic Weisbecker 			case FORMAT_TYPE_UINT:
24694370aa4aSLai Jiangshan 				num = get_arg(unsigned int);
2470fef20d9cSFrederic Weisbecker 				break;
2471fef20d9cSFrederic Weisbecker 			default:
2472fef20d9cSFrederic Weisbecker 				num = get_arg(int);
24734370aa4aSLai Jiangshan 			}
2474fef20d9cSFrederic Weisbecker 
2475fef20d9cSFrederic Weisbecker 			str = number(str, end, num, spec);
2476d4be151bSAndré Goddard Rosa 		} /* default: */
2477d4be151bSAndré Goddard Rosa 		} /* switch(spec.type) */
2478d4be151bSAndré Goddard Rosa 	} /* while(*fmt) */
2479fef20d9cSFrederic Weisbecker 
2480b006f19bSRasmus Villemoes out:
24814370aa4aSLai Jiangshan 	if (size > 0) {
24824370aa4aSLai Jiangshan 		if (str < end)
24834370aa4aSLai Jiangshan 			*str = '\0';
24844370aa4aSLai Jiangshan 		else
24854370aa4aSLai Jiangshan 			end[-1] = '\0';
24864370aa4aSLai Jiangshan 	}
2487fef20d9cSFrederic Weisbecker 
24884370aa4aSLai Jiangshan #undef get_arg
24894370aa4aSLai Jiangshan 
24904370aa4aSLai Jiangshan 	/* the trailing null byte doesn't count towards the total */
24914370aa4aSLai Jiangshan 	return str - buf;
24924370aa4aSLai Jiangshan }
24934370aa4aSLai Jiangshan EXPORT_SYMBOL_GPL(bstr_printf);
24944370aa4aSLai Jiangshan 
24954370aa4aSLai Jiangshan /**
24964370aa4aSLai Jiangshan  * bprintf - Parse a format string and place args' binary value in a buffer
24974370aa4aSLai Jiangshan  * @bin_buf: The buffer to place args' binary value
24984370aa4aSLai Jiangshan  * @size: The size of the buffer(by words(32bits), not characters)
24994370aa4aSLai Jiangshan  * @fmt: The format string to use
25004370aa4aSLai Jiangshan  * @...: Arguments for the format string
25014370aa4aSLai Jiangshan  *
25024370aa4aSLai Jiangshan  * The function returns the number of words(u32) written
25034370aa4aSLai Jiangshan  * into @bin_buf.
25044370aa4aSLai Jiangshan  */
25054370aa4aSLai Jiangshan int bprintf(u32 *bin_buf, size_t size, const char *fmt, ...)
25064370aa4aSLai Jiangshan {
25074370aa4aSLai Jiangshan 	va_list args;
25084370aa4aSLai Jiangshan 	int ret;
25094370aa4aSLai Jiangshan 
25104370aa4aSLai Jiangshan 	va_start(args, fmt);
25114370aa4aSLai Jiangshan 	ret = vbin_printf(bin_buf, size, fmt, args);
25124370aa4aSLai Jiangshan 	va_end(args);
25137b9186f5SAndré Goddard Rosa 
25144370aa4aSLai Jiangshan 	return ret;
25154370aa4aSLai Jiangshan }
25164370aa4aSLai Jiangshan EXPORT_SYMBOL_GPL(bprintf);
25174370aa4aSLai Jiangshan 
25184370aa4aSLai Jiangshan #endif /* CONFIG_BINARY_PRINTF */
25194370aa4aSLai Jiangshan 
25201da177e4SLinus Torvalds /**
25211da177e4SLinus Torvalds  * vsscanf - Unformat a buffer into a list of arguments
25221da177e4SLinus Torvalds  * @buf:	input buffer
25231da177e4SLinus Torvalds  * @fmt:	format of buffer
25241da177e4SLinus Torvalds  * @args:	arguments
25251da177e4SLinus Torvalds  */
25261da177e4SLinus Torvalds int vsscanf(const char *buf, const char *fmt, va_list args)
25271da177e4SLinus Torvalds {
25281da177e4SLinus Torvalds 	const char *str = buf;
25291da177e4SLinus Torvalds 	char *next;
25301da177e4SLinus Torvalds 	char digit;
25311da177e4SLinus Torvalds 	int num = 0;
2532ef0658f3SJoe Perches 	u8 qualifier;
253353809751SJan Beulich 	unsigned int base;
253453809751SJan Beulich 	union {
253553809751SJan Beulich 		long long s;
253653809751SJan Beulich 		unsigned long long u;
253753809751SJan Beulich 	} val;
2538ef0658f3SJoe Perches 	s16 field_width;
2539d4be151bSAndré Goddard Rosa 	bool is_sign;
25401da177e4SLinus Torvalds 
2541da99075cSJan Beulich 	while (*fmt) {
25421da177e4SLinus Torvalds 		/* skip any white space in format */
25431da177e4SLinus Torvalds 		/* white space in format matchs any amount of
25441da177e4SLinus Torvalds 		 * white space, including none, in the input.
25451da177e4SLinus Torvalds 		 */
25461da177e4SLinus Torvalds 		if (isspace(*fmt)) {
2547e7d2860bSAndré Goddard Rosa 			fmt = skip_spaces(++fmt);
2548e7d2860bSAndré Goddard Rosa 			str = skip_spaces(str);
25491da177e4SLinus Torvalds 		}
25501da177e4SLinus Torvalds 
25511da177e4SLinus Torvalds 		/* anything that is not a conversion must match exactly */
25521da177e4SLinus Torvalds 		if (*fmt != '%' && *fmt) {
25531da177e4SLinus Torvalds 			if (*fmt++ != *str++)
25541da177e4SLinus Torvalds 				break;
25551da177e4SLinus Torvalds 			continue;
25561da177e4SLinus Torvalds 		}
25571da177e4SLinus Torvalds 
25581da177e4SLinus Torvalds 		if (!*fmt)
25591da177e4SLinus Torvalds 			break;
25601da177e4SLinus Torvalds 		++fmt;
25611da177e4SLinus Torvalds 
25621da177e4SLinus Torvalds 		/* skip this conversion.
25631da177e4SLinus Torvalds 		 * advance both strings to next white space
25641da177e4SLinus Torvalds 		 */
25651da177e4SLinus Torvalds 		if (*fmt == '*') {
2566da99075cSJan Beulich 			if (!*str)
2567da99075cSJan Beulich 				break;
25688fccae2cSAndy Spencer 			while (!isspace(*fmt) && *fmt != '%' && *fmt)
25691da177e4SLinus Torvalds 				fmt++;
25701da177e4SLinus Torvalds 			while (!isspace(*str) && *str)
25711da177e4SLinus Torvalds 				str++;
25721da177e4SLinus Torvalds 			continue;
25731da177e4SLinus Torvalds 		}
25741da177e4SLinus Torvalds 
25751da177e4SLinus Torvalds 		/* get field width */
25761da177e4SLinus Torvalds 		field_width = -1;
257753809751SJan Beulich 		if (isdigit(*fmt)) {
25781da177e4SLinus Torvalds 			field_width = skip_atoi(&fmt);
257953809751SJan Beulich 			if (field_width <= 0)
258053809751SJan Beulich 				break;
258153809751SJan Beulich 		}
25821da177e4SLinus Torvalds 
25831da177e4SLinus Torvalds 		/* get conversion qualifier */
25841da177e4SLinus Torvalds 		qualifier = -1;
258575fb8f26SAndy Shevchenko 		if (*fmt == 'h' || _tolower(*fmt) == 'l' ||
258675fb8f26SAndy Shevchenko 		    _tolower(*fmt) == 'z') {
25871da177e4SLinus Torvalds 			qualifier = *fmt++;
25881da177e4SLinus Torvalds 			if (unlikely(qualifier == *fmt)) {
25891da177e4SLinus Torvalds 				if (qualifier == 'h') {
25901da177e4SLinus Torvalds 					qualifier = 'H';
25911da177e4SLinus Torvalds 					fmt++;
25921da177e4SLinus Torvalds 				} else if (qualifier == 'l') {
25931da177e4SLinus Torvalds 					qualifier = 'L';
25941da177e4SLinus Torvalds 					fmt++;
25951da177e4SLinus Torvalds 				}
25961da177e4SLinus Torvalds 			}
25971da177e4SLinus Torvalds 		}
25981da177e4SLinus Torvalds 
2599da99075cSJan Beulich 		if (!*fmt)
2600da99075cSJan Beulich 			break;
2601da99075cSJan Beulich 
2602da99075cSJan Beulich 		if (*fmt == 'n') {
2603da99075cSJan Beulich 			/* return number of characters read so far */
2604da99075cSJan Beulich 			*va_arg(args, int *) = str - buf;
2605da99075cSJan Beulich 			++fmt;
2606da99075cSJan Beulich 			continue;
2607da99075cSJan Beulich 		}
2608da99075cSJan Beulich 
2609da99075cSJan Beulich 		if (!*str)
26101da177e4SLinus Torvalds 			break;
26111da177e4SLinus Torvalds 
2612d4be151bSAndré Goddard Rosa 		base = 10;
26133f623ebaSFabian Frederick 		is_sign = false;
2614d4be151bSAndré Goddard Rosa 
26151da177e4SLinus Torvalds 		switch (*fmt++) {
26161da177e4SLinus Torvalds 		case 'c':
26171da177e4SLinus Torvalds 		{
26181da177e4SLinus Torvalds 			char *s = (char *)va_arg(args, char*);
26191da177e4SLinus Torvalds 			if (field_width == -1)
26201da177e4SLinus Torvalds 				field_width = 1;
26211da177e4SLinus Torvalds 			do {
26221da177e4SLinus Torvalds 				*s++ = *str++;
26231da177e4SLinus Torvalds 			} while (--field_width > 0 && *str);
26241da177e4SLinus Torvalds 			num++;
26251da177e4SLinus Torvalds 		}
26261da177e4SLinus Torvalds 		continue;
26271da177e4SLinus Torvalds 		case 's':
26281da177e4SLinus Torvalds 		{
26291da177e4SLinus Torvalds 			char *s = (char *)va_arg(args, char *);
26301da177e4SLinus Torvalds 			if (field_width == -1)
26314be929beSAlexey Dobriyan 				field_width = SHRT_MAX;
26321da177e4SLinus Torvalds 			/* first, skip leading white space in buffer */
2633e7d2860bSAndré Goddard Rosa 			str = skip_spaces(str);
26341da177e4SLinus Torvalds 
26351da177e4SLinus Torvalds 			/* now copy until next white space */
26367b9186f5SAndré Goddard Rosa 			while (*str && !isspace(*str) && field_width--)
26371da177e4SLinus Torvalds 				*s++ = *str++;
26381da177e4SLinus Torvalds 			*s = '\0';
26391da177e4SLinus Torvalds 			num++;
26401da177e4SLinus Torvalds 		}
26411da177e4SLinus Torvalds 		continue;
26421da177e4SLinus Torvalds 		case 'o':
26431da177e4SLinus Torvalds 			base = 8;
26441da177e4SLinus Torvalds 			break;
26451da177e4SLinus Torvalds 		case 'x':
26461da177e4SLinus Torvalds 		case 'X':
26471da177e4SLinus Torvalds 			base = 16;
26481da177e4SLinus Torvalds 			break;
26491da177e4SLinus Torvalds 		case 'i':
26501da177e4SLinus Torvalds 			base = 0;
26511da177e4SLinus Torvalds 		case 'd':
26523f623ebaSFabian Frederick 			is_sign = true;
26531da177e4SLinus Torvalds 		case 'u':
26541da177e4SLinus Torvalds 			break;
26551da177e4SLinus Torvalds 		case '%':
26561da177e4SLinus Torvalds 			/* looking for '%' in str */
26571da177e4SLinus Torvalds 			if (*str++ != '%')
26581da177e4SLinus Torvalds 				return num;
26591da177e4SLinus Torvalds 			continue;
26601da177e4SLinus Torvalds 		default:
26611da177e4SLinus Torvalds 			/* invalid format; stop here */
26621da177e4SLinus Torvalds 			return num;
26631da177e4SLinus Torvalds 		}
26641da177e4SLinus Torvalds 
26651da177e4SLinus Torvalds 		/* have some sort of integer conversion.
26661da177e4SLinus Torvalds 		 * first, skip white space in buffer.
26671da177e4SLinus Torvalds 		 */
2668e7d2860bSAndré Goddard Rosa 		str = skip_spaces(str);
26691da177e4SLinus Torvalds 
26701da177e4SLinus Torvalds 		digit = *str;
26711da177e4SLinus Torvalds 		if (is_sign && digit == '-')
26721da177e4SLinus Torvalds 			digit = *(str + 1);
26731da177e4SLinus Torvalds 
26741da177e4SLinus Torvalds 		if (!digit
26751da177e4SLinus Torvalds 		    || (base == 16 && !isxdigit(digit))
26761da177e4SLinus Torvalds 		    || (base == 10 && !isdigit(digit))
26771da177e4SLinus Torvalds 		    || (base == 8 && (!isdigit(digit) || digit > '7'))
26781da177e4SLinus Torvalds 		    || (base == 0 && !isdigit(digit)))
26791da177e4SLinus Torvalds 			break;
26801da177e4SLinus Torvalds 
268153809751SJan Beulich 		if (is_sign)
268253809751SJan Beulich 			val.s = qualifier != 'L' ?
268353809751SJan Beulich 				simple_strtol(str, &next, base) :
268453809751SJan Beulich 				simple_strtoll(str, &next, base);
268553809751SJan Beulich 		else
268653809751SJan Beulich 			val.u = qualifier != 'L' ?
268753809751SJan Beulich 				simple_strtoul(str, &next, base) :
268853809751SJan Beulich 				simple_strtoull(str, &next, base);
268953809751SJan Beulich 
269053809751SJan Beulich 		if (field_width > 0 && next - str > field_width) {
269153809751SJan Beulich 			if (base == 0)
269253809751SJan Beulich 				_parse_integer_fixup_radix(str, &base);
269353809751SJan Beulich 			while (next - str > field_width) {
269453809751SJan Beulich 				if (is_sign)
269553809751SJan Beulich 					val.s = div_s64(val.s, base);
269653809751SJan Beulich 				else
269753809751SJan Beulich 					val.u = div_u64(val.u, base);
269853809751SJan Beulich 				--next;
269953809751SJan Beulich 			}
270053809751SJan Beulich 		}
270153809751SJan Beulich 
27021da177e4SLinus Torvalds 		switch (qualifier) {
27031da177e4SLinus Torvalds 		case 'H':	/* that's 'hh' in format */
270453809751SJan Beulich 			if (is_sign)
270553809751SJan Beulich 				*va_arg(args, signed char *) = val.s;
270653809751SJan Beulich 			else
270753809751SJan Beulich 				*va_arg(args, unsigned char *) = val.u;
27081da177e4SLinus Torvalds 			break;
27091da177e4SLinus Torvalds 		case 'h':
271053809751SJan Beulich 			if (is_sign)
271153809751SJan Beulich 				*va_arg(args, short *) = val.s;
271253809751SJan Beulich 			else
271353809751SJan Beulich 				*va_arg(args, unsigned short *) = val.u;
27141da177e4SLinus Torvalds 			break;
27151da177e4SLinus Torvalds 		case 'l':
271653809751SJan Beulich 			if (is_sign)
271753809751SJan Beulich 				*va_arg(args, long *) = val.s;
271853809751SJan Beulich 			else
271953809751SJan Beulich 				*va_arg(args, unsigned long *) = val.u;
27201da177e4SLinus Torvalds 			break;
27211da177e4SLinus Torvalds 		case 'L':
272253809751SJan Beulich 			if (is_sign)
272353809751SJan Beulich 				*va_arg(args, long long *) = val.s;
272453809751SJan Beulich 			else
272553809751SJan Beulich 				*va_arg(args, unsigned long long *) = val.u;
27261da177e4SLinus Torvalds 			break;
27271da177e4SLinus Torvalds 		case 'Z':
27281da177e4SLinus Torvalds 		case 'z':
272953809751SJan Beulich 			*va_arg(args, size_t *) = val.u;
27301da177e4SLinus Torvalds 			break;
27311da177e4SLinus Torvalds 		default:
273253809751SJan Beulich 			if (is_sign)
273353809751SJan Beulich 				*va_arg(args, int *) = val.s;
273453809751SJan Beulich 			else
273553809751SJan Beulich 				*va_arg(args, unsigned int *) = val.u;
27361da177e4SLinus Torvalds 			break;
27371da177e4SLinus Torvalds 		}
27381da177e4SLinus Torvalds 		num++;
27391da177e4SLinus Torvalds 
27401da177e4SLinus Torvalds 		if (!next)
27411da177e4SLinus Torvalds 			break;
27421da177e4SLinus Torvalds 		str = next;
27431da177e4SLinus Torvalds 	}
2744c6b40d16SJohannes Berg 
27451da177e4SLinus Torvalds 	return num;
27461da177e4SLinus Torvalds }
27471da177e4SLinus Torvalds EXPORT_SYMBOL(vsscanf);
27481da177e4SLinus Torvalds 
27491da177e4SLinus Torvalds /**
27501da177e4SLinus Torvalds  * sscanf - Unformat a buffer into a list of arguments
27511da177e4SLinus Torvalds  * @buf:	input buffer
27521da177e4SLinus Torvalds  * @fmt:	formatting of buffer
27531da177e4SLinus Torvalds  * @...:	resulting arguments
27541da177e4SLinus Torvalds  */
27551da177e4SLinus Torvalds int sscanf(const char *buf, const char *fmt, ...)
27561da177e4SLinus Torvalds {
27571da177e4SLinus Torvalds 	va_list args;
27581da177e4SLinus Torvalds 	int i;
27591da177e4SLinus Torvalds 
27601da177e4SLinus Torvalds 	va_start(args, fmt);
27611da177e4SLinus Torvalds 	i = vsscanf(buf, fmt, args);
27621da177e4SLinus Torvalds 	va_end(args);
27637b9186f5SAndré Goddard Rosa 
27641da177e4SLinus Torvalds 	return i;
27651da177e4SLinus Torvalds }
27661da177e4SLinus Torvalds EXPORT_SYMBOL(sscanf);
2767