xref: /openbmc/linux/lib/vsprintf.c (revision 95508cfa10503bbe5adb78bd1b2b56a01ab3dd2d)
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 {
3864e310fdaSJoe Perches 	u8	type;		/* format_type enum */
387ef0658f3SJoe Perches 	u8	flags;		/* flags to number() */
3884e310fdaSJoe Perches 	u8	base;		/* number base, 8, 10 or 16 only */
3894e310fdaSJoe Perches 	u8	qualifier;	/* number qualifier, one of 'hHlLtzZ' */
3904e310fdaSJoe Perches 	s16	field_width;	/* width of output field */
3914e310fdaSJoe Perches 	s16	precision;	/* # of digits/chars */
392fef20d9cSFrederic Weisbecker };
393fef20d9cSFrederic Weisbecker 
394cf3b429bSJoe Perches static noinline_for_stack
395cf3b429bSJoe Perches char *number(char *buf, char *end, unsigned long long num,
396fef20d9cSFrederic Weisbecker 	     struct printf_spec spec)
3971da177e4SLinus Torvalds {
3987c43d9a3SRasmus Villemoes 	/* put_dec requires 2-byte alignment of the buffer. */
3997c43d9a3SRasmus Villemoes 	char tmp[3 * sizeof(num)] __aligned(2);
4009b706aeeSDenys Vlasenko 	char sign;
4019b706aeeSDenys Vlasenko 	char locase;
402fef20d9cSFrederic Weisbecker 	int need_pfx = ((spec.flags & SPECIAL) && spec.base != 10);
4031da177e4SLinus Torvalds 	int i;
4047c203422SPierre Carrier 	bool is_zero = num == 0LL;
4051da177e4SLinus Torvalds 
4069b706aeeSDenys Vlasenko 	/* locase = 0 or 0x20. ORing digits or letters with 'locase'
4079b706aeeSDenys Vlasenko 	 * produces same digits or (maybe lowercased) letters */
408fef20d9cSFrederic Weisbecker 	locase = (spec.flags & SMALL);
409fef20d9cSFrederic Weisbecker 	if (spec.flags & LEFT)
410fef20d9cSFrederic Weisbecker 		spec.flags &= ~ZEROPAD;
4111da177e4SLinus Torvalds 	sign = 0;
412fef20d9cSFrederic Weisbecker 	if (spec.flags & SIGN) {
4131da177e4SLinus Torvalds 		if ((signed long long)num < 0) {
4141da177e4SLinus Torvalds 			sign = '-';
4151da177e4SLinus Torvalds 			num = -(signed long long)num;
416fef20d9cSFrederic Weisbecker 			spec.field_width--;
417fef20d9cSFrederic Weisbecker 		} else if (spec.flags & PLUS) {
4181da177e4SLinus Torvalds 			sign = '+';
419fef20d9cSFrederic Weisbecker 			spec.field_width--;
420fef20d9cSFrederic Weisbecker 		} else if (spec.flags & SPACE) {
4211da177e4SLinus Torvalds 			sign = ' ';
422fef20d9cSFrederic Weisbecker 			spec.field_width--;
4231da177e4SLinus Torvalds 		}
4241da177e4SLinus Torvalds 	}
425b39a7340SDenis Vlasenko 	if (need_pfx) {
426fef20d9cSFrederic Weisbecker 		if (spec.base == 16)
4277c203422SPierre Carrier 			spec.field_width -= 2;
4287c203422SPierre Carrier 		else if (!is_zero)
429fef20d9cSFrederic Weisbecker 			spec.field_width--;
4301da177e4SLinus Torvalds 	}
431b39a7340SDenis Vlasenko 
432b39a7340SDenis Vlasenko 	/* generate full string in tmp[], in reverse order */
4331da177e4SLinus Torvalds 	i = 0;
434133fd9f5SDenys Vlasenko 	if (num < spec.base)
4353ea8d440SRasmus Villemoes 		tmp[i++] = hex_asc_upper[num] | locase;
436fef20d9cSFrederic Weisbecker 	else if (spec.base != 10) { /* 8 or 16 */
437fef20d9cSFrederic Weisbecker 		int mask = spec.base - 1;
438b39a7340SDenis Vlasenko 		int shift = 3;
4397b9186f5SAndré Goddard Rosa 
4407b9186f5SAndré Goddard Rosa 		if (spec.base == 16)
4417b9186f5SAndré Goddard Rosa 			shift = 4;
442b39a7340SDenis Vlasenko 		do {
4433ea8d440SRasmus Villemoes 			tmp[i++] = (hex_asc_upper[((unsigned char)num) & mask] | locase);
444b39a7340SDenis Vlasenko 			num >>= shift;
445b39a7340SDenis Vlasenko 		} while (num);
4464277eeddSDenis Vlasenko 	} else { /* base 10 */
4474277eeddSDenis Vlasenko 		i = put_dec(tmp, num) - tmp;
4484277eeddSDenis Vlasenko 	}
449b39a7340SDenis Vlasenko 
450b39a7340SDenis Vlasenko 	/* printing 100 using %2d gives "100", not "00" */
451fef20d9cSFrederic Weisbecker 	if (i > spec.precision)
452fef20d9cSFrederic Weisbecker 		spec.precision = i;
453b39a7340SDenis Vlasenko 	/* leading space padding */
454fef20d9cSFrederic Weisbecker 	spec.field_width -= spec.precision;
45551be17dfSRasmus Villemoes 	if (!(spec.flags & (ZEROPAD | LEFT))) {
456fef20d9cSFrederic Weisbecker 		while (--spec.field_width >= 0) {
457f796937aSJeremy Fitzhardinge 			if (buf < end)
4581da177e4SLinus Torvalds 				*buf = ' ';
4591da177e4SLinus Torvalds 			++buf;
4601da177e4SLinus Torvalds 		}
4611da177e4SLinus Torvalds 	}
462b39a7340SDenis Vlasenko 	/* sign */
4631da177e4SLinus Torvalds 	if (sign) {
464f796937aSJeremy Fitzhardinge 		if (buf < end)
4651da177e4SLinus Torvalds 			*buf = sign;
4661da177e4SLinus Torvalds 		++buf;
4671da177e4SLinus Torvalds 	}
468b39a7340SDenis Vlasenko 	/* "0x" / "0" prefix */
469b39a7340SDenis Vlasenko 	if (need_pfx) {
4707c203422SPierre Carrier 		if (spec.base == 16 || !is_zero) {
471f796937aSJeremy Fitzhardinge 			if (buf < end)
4721da177e4SLinus Torvalds 				*buf = '0';
4731da177e4SLinus Torvalds 			++buf;
4747c203422SPierre Carrier 		}
475fef20d9cSFrederic Weisbecker 		if (spec.base == 16) {
476f796937aSJeremy Fitzhardinge 			if (buf < end)
4779b706aeeSDenys Vlasenko 				*buf = ('X' | locase);
4781da177e4SLinus Torvalds 			++buf;
4791da177e4SLinus Torvalds 		}
4801da177e4SLinus Torvalds 	}
481b39a7340SDenis Vlasenko 	/* zero or space padding */
482fef20d9cSFrederic Weisbecker 	if (!(spec.flags & LEFT)) {
483d1c1b121SRasmus Villemoes 		char c = ' ' + (spec.flags & ZEROPAD);
484d1c1b121SRasmus Villemoes 		BUILD_BUG_ON(' ' + ZEROPAD != '0');
485fef20d9cSFrederic Weisbecker 		while (--spec.field_width >= 0) {
486f796937aSJeremy Fitzhardinge 			if (buf < end)
4871da177e4SLinus Torvalds 				*buf = c;
4881da177e4SLinus Torvalds 			++buf;
4891da177e4SLinus Torvalds 		}
4901da177e4SLinus Torvalds 	}
491b39a7340SDenis Vlasenko 	/* hmm even more zero padding? */
492fef20d9cSFrederic Weisbecker 	while (i <= --spec.precision) {
493f796937aSJeremy Fitzhardinge 		if (buf < end)
4941da177e4SLinus Torvalds 			*buf = '0';
4951da177e4SLinus Torvalds 		++buf;
4961da177e4SLinus Torvalds 	}
497b39a7340SDenis Vlasenko 	/* actual digits of result */
498b39a7340SDenis Vlasenko 	while (--i >= 0) {
499f796937aSJeremy Fitzhardinge 		if (buf < end)
5001da177e4SLinus Torvalds 			*buf = tmp[i];
5011da177e4SLinus Torvalds 		++buf;
5021da177e4SLinus Torvalds 	}
503b39a7340SDenis Vlasenko 	/* trailing space padding */
504fef20d9cSFrederic Weisbecker 	while (--spec.field_width >= 0) {
505f796937aSJeremy Fitzhardinge 		if (buf < end)
5061da177e4SLinus Torvalds 			*buf = ' ';
5071da177e4SLinus Torvalds 		++buf;
5081da177e4SLinus Torvalds 	}
5097b9186f5SAndré Goddard Rosa 
5101da177e4SLinus Torvalds 	return buf;
5111da177e4SLinus Torvalds }
5121da177e4SLinus Torvalds 
513cfccde04SRasmus Villemoes static void move_right(char *buf, char *end, unsigned len, unsigned spaces)
5144b6ccca7SAl Viro {
5154b6ccca7SAl Viro 	size_t size;
5164b6ccca7SAl Viro 	if (buf >= end)	/* nowhere to put anything */
5174b6ccca7SAl Viro 		return;
5184b6ccca7SAl Viro 	size = end - buf;
5194b6ccca7SAl Viro 	if (size <= spaces) {
5204b6ccca7SAl Viro 		memset(buf, ' ', size);
5214b6ccca7SAl Viro 		return;
5224b6ccca7SAl Viro 	}
5234b6ccca7SAl Viro 	if (len) {
5244b6ccca7SAl Viro 		if (len > size - spaces)
5254b6ccca7SAl Viro 			len = size - spaces;
5264b6ccca7SAl Viro 		memmove(buf + spaces, buf, len);
5274b6ccca7SAl Viro 	}
5284b6ccca7SAl Viro 	memset(buf, ' ', spaces);
5294b6ccca7SAl Viro }
5304b6ccca7SAl Viro 
531cfccde04SRasmus Villemoes /*
532cfccde04SRasmus Villemoes  * Handle field width padding for a string.
533cfccde04SRasmus Villemoes  * @buf: current buffer position
534cfccde04SRasmus Villemoes  * @n: length of string
535cfccde04SRasmus Villemoes  * @end: end of output buffer
536cfccde04SRasmus Villemoes  * @spec: for field width and flags
537cfccde04SRasmus Villemoes  * Returns: new buffer position after padding.
538cfccde04SRasmus Villemoes  */
539cfccde04SRasmus Villemoes static noinline_for_stack
540cfccde04SRasmus Villemoes char *widen_string(char *buf, int n, char *end, struct printf_spec spec)
541cfccde04SRasmus Villemoes {
542cfccde04SRasmus Villemoes 	unsigned spaces;
543cfccde04SRasmus Villemoes 
544cfccde04SRasmus Villemoes 	if (likely(n >= spec.field_width))
545cfccde04SRasmus Villemoes 		return buf;
546cfccde04SRasmus Villemoes 	/* we want to pad the sucker */
547cfccde04SRasmus Villemoes 	spaces = spec.field_width - n;
548cfccde04SRasmus Villemoes 	if (!(spec.flags & LEFT)) {
549cfccde04SRasmus Villemoes 		move_right(buf - n, end, n, spaces);
550cfccde04SRasmus Villemoes 		return buf + spaces;
551cfccde04SRasmus Villemoes 	}
552cfccde04SRasmus Villemoes 	while (spaces--) {
553cfccde04SRasmus Villemoes 		if (buf < end)
554cfccde04SRasmus Villemoes 			*buf = ' ';
555cfccde04SRasmus Villemoes 		++buf;
556cfccde04SRasmus Villemoes 	}
557cfccde04SRasmus Villemoes 	return buf;
558cfccde04SRasmus Villemoes }
559cfccde04SRasmus Villemoes 
5604b6ccca7SAl Viro static noinline_for_stack
561*95508cfaSRasmus Villemoes char *string(char *buf, char *end, const char *s, struct printf_spec spec)
562*95508cfaSRasmus Villemoes {
563*95508cfaSRasmus Villemoes 	int len, i;
564*95508cfaSRasmus Villemoes 
565*95508cfaSRasmus Villemoes 	if ((unsigned long)s < PAGE_SIZE)
566*95508cfaSRasmus Villemoes 		s = "(null)";
567*95508cfaSRasmus Villemoes 
568*95508cfaSRasmus Villemoes 	len = strnlen(s, spec.precision);
569*95508cfaSRasmus Villemoes 
570*95508cfaSRasmus Villemoes 	if (!(spec.flags & LEFT)) {
571*95508cfaSRasmus Villemoes 		while (len < spec.field_width--) {
572*95508cfaSRasmus Villemoes 			if (buf < end)
573*95508cfaSRasmus Villemoes 				*buf = ' ';
574*95508cfaSRasmus Villemoes 			++buf;
575*95508cfaSRasmus Villemoes 		}
576*95508cfaSRasmus Villemoes 	}
577*95508cfaSRasmus Villemoes 	for (i = 0; i < len; ++i) {
578*95508cfaSRasmus Villemoes 		if (buf < end)
579*95508cfaSRasmus Villemoes 			*buf = *s;
580*95508cfaSRasmus Villemoes 		++buf; ++s;
581*95508cfaSRasmus Villemoes 	}
582*95508cfaSRasmus Villemoes 	while (len < spec.field_width--) {
583*95508cfaSRasmus Villemoes 		if (buf < end)
584*95508cfaSRasmus Villemoes 			*buf = ' ';
585*95508cfaSRasmus Villemoes 		++buf;
586*95508cfaSRasmus Villemoes 	}
587*95508cfaSRasmus Villemoes 
588*95508cfaSRasmus Villemoes 	return buf;
589*95508cfaSRasmus Villemoes }
590*95508cfaSRasmus Villemoes 
591*95508cfaSRasmus Villemoes static noinline_for_stack
5924b6ccca7SAl Viro char *dentry_name(char *buf, char *end, const struct dentry *d, struct printf_spec spec,
5934b6ccca7SAl Viro 		  const char *fmt)
5944b6ccca7SAl Viro {
5954b6ccca7SAl Viro 	const char *array[4], *s;
5964b6ccca7SAl Viro 	const struct dentry *p;
5974b6ccca7SAl Viro 	int depth;
5984b6ccca7SAl Viro 	int i, n;
5994b6ccca7SAl Viro 
6004b6ccca7SAl Viro 	switch (fmt[1]) {
6014b6ccca7SAl Viro 		case '2': case '3': case '4':
6024b6ccca7SAl Viro 			depth = fmt[1] - '0';
6034b6ccca7SAl Viro 			break;
6044b6ccca7SAl Viro 		default:
6054b6ccca7SAl Viro 			depth = 1;
6064b6ccca7SAl Viro 	}
6074b6ccca7SAl Viro 
6084b6ccca7SAl Viro 	rcu_read_lock();
6094b6ccca7SAl Viro 	for (i = 0; i < depth; i++, d = p) {
6104b6ccca7SAl Viro 		p = ACCESS_ONCE(d->d_parent);
6114b6ccca7SAl Viro 		array[i] = ACCESS_ONCE(d->d_name.name);
6124b6ccca7SAl Viro 		if (p == d) {
6134b6ccca7SAl Viro 			if (i)
6144b6ccca7SAl Viro 				array[i] = "";
6154b6ccca7SAl Viro 			i++;
6164b6ccca7SAl Viro 			break;
6174b6ccca7SAl Viro 		}
6184b6ccca7SAl Viro 	}
6194b6ccca7SAl Viro 	s = array[--i];
6204b6ccca7SAl Viro 	for (n = 0; n != spec.precision; n++, buf++) {
6214b6ccca7SAl Viro 		char c = *s++;
6224b6ccca7SAl Viro 		if (!c) {
6234b6ccca7SAl Viro 			if (!i)
6244b6ccca7SAl Viro 				break;
6254b6ccca7SAl Viro 			c = '/';
6264b6ccca7SAl Viro 			s = array[--i];
6274b6ccca7SAl Viro 		}
6284b6ccca7SAl Viro 		if (buf < end)
6294b6ccca7SAl Viro 			*buf = c;
6304b6ccca7SAl Viro 	}
6314b6ccca7SAl Viro 	rcu_read_unlock();
632cfccde04SRasmus Villemoes 	return widen_string(buf, n, end, spec);
6334b6ccca7SAl Viro }
6344b6ccca7SAl Viro 
6351031bc58SDmitry Monakhov #ifdef CONFIG_BLOCK
6361031bc58SDmitry Monakhov static noinline_for_stack
6371031bc58SDmitry Monakhov char *bdev_name(char *buf, char *end, struct block_device *bdev,
6381031bc58SDmitry Monakhov 		struct printf_spec spec, const char *fmt)
6391031bc58SDmitry Monakhov {
6401031bc58SDmitry Monakhov 	struct gendisk *hd = bdev->bd_disk;
6411031bc58SDmitry Monakhov 
6421031bc58SDmitry Monakhov 	buf = string(buf, end, hd->disk_name, spec);
6431031bc58SDmitry Monakhov 	if (bdev->bd_part->partno) {
6441031bc58SDmitry Monakhov 		if (isdigit(hd->disk_name[strlen(hd->disk_name)-1])) {
6451031bc58SDmitry Monakhov 			if (buf < end)
6461031bc58SDmitry Monakhov 				*buf = 'p';
6471031bc58SDmitry Monakhov 			buf++;
6481031bc58SDmitry Monakhov 		}
6491031bc58SDmitry Monakhov 		buf = number(buf, end, bdev->bd_part->partno, spec);
6501031bc58SDmitry Monakhov 	}
6511031bc58SDmitry Monakhov 	return buf;
6521031bc58SDmitry Monakhov }
6531031bc58SDmitry Monakhov #endif
6541031bc58SDmitry Monakhov 
655cf3b429bSJoe Perches static noinline_for_stack
656cf3b429bSJoe Perches char *symbol_string(char *buf, char *end, void *ptr,
657b0d33c2bSJoe Perches 		    struct printf_spec spec, const char *fmt)
6580fe1ef24SLinus Torvalds {
659b0d33c2bSJoe Perches 	unsigned long value;
6600fe1ef24SLinus Torvalds #ifdef CONFIG_KALLSYMS
6610fe1ef24SLinus Torvalds 	char sym[KSYM_SYMBOL_LEN];
662b0d33c2bSJoe Perches #endif
663b0d33c2bSJoe Perches 
664b0d33c2bSJoe Perches 	if (fmt[1] == 'R')
665b0d33c2bSJoe Perches 		ptr = __builtin_extract_return_addr(ptr);
666b0d33c2bSJoe Perches 	value = (unsigned long)ptr;
667b0d33c2bSJoe Perches 
668b0d33c2bSJoe Perches #ifdef CONFIG_KALLSYMS
669b0d33c2bSJoe Perches 	if (*fmt == 'B')
6700f77a8d3SNamhyung Kim 		sprint_backtrace(sym, value);
671b0d33c2bSJoe Perches 	else if (*fmt != 'f' && *fmt != 's')
6720fe1ef24SLinus Torvalds 		sprint_symbol(sym, value);
6730c8b946eSFrederic Weisbecker 	else
6744796dd20SStephen Boyd 		sprint_symbol_no_offset(sym, value);
6757b9186f5SAndré Goddard Rosa 
676fef20d9cSFrederic Weisbecker 	return string(buf, end, sym, spec);
6770fe1ef24SLinus Torvalds #else
678fef20d9cSFrederic Weisbecker 	spec.field_width = 2 * sizeof(void *);
679fef20d9cSFrederic Weisbecker 	spec.flags |= SPECIAL | SMALL | ZEROPAD;
680fef20d9cSFrederic Weisbecker 	spec.base = 16;
6817b9186f5SAndré Goddard Rosa 
682fef20d9cSFrederic Weisbecker 	return number(buf, end, value, spec);
6830fe1ef24SLinus Torvalds #endif
6840fe1ef24SLinus Torvalds }
6850fe1ef24SLinus Torvalds 
686cf3b429bSJoe Perches static noinline_for_stack
687cf3b429bSJoe Perches char *resource_string(char *buf, char *end, struct resource *res,
688fd95541eSBjorn Helgaas 		      struct printf_spec spec, const char *fmt)
689332d2e78SLinus Torvalds {
690332d2e78SLinus Torvalds #ifndef IO_RSRC_PRINTK_SIZE
69128405372SBjorn Helgaas #define IO_RSRC_PRINTK_SIZE	6
692332d2e78SLinus Torvalds #endif
693332d2e78SLinus Torvalds 
694332d2e78SLinus Torvalds #ifndef MEM_RSRC_PRINTK_SIZE
69528405372SBjorn Helgaas #define MEM_RSRC_PRINTK_SIZE	10
696332d2e78SLinus Torvalds #endif
6974da0b66cSBjorn Helgaas 	static const struct printf_spec io_spec = {
698fef20d9cSFrederic Weisbecker 		.base = 16,
6994da0b66cSBjorn Helgaas 		.field_width = IO_RSRC_PRINTK_SIZE,
700fef20d9cSFrederic Weisbecker 		.precision = -1,
701fef20d9cSFrederic Weisbecker 		.flags = SPECIAL | SMALL | ZEROPAD,
702fef20d9cSFrederic Weisbecker 	};
7034da0b66cSBjorn Helgaas 	static const struct printf_spec mem_spec = {
7044da0b66cSBjorn Helgaas 		.base = 16,
7054da0b66cSBjorn Helgaas 		.field_width = MEM_RSRC_PRINTK_SIZE,
7064da0b66cSBjorn Helgaas 		.precision = -1,
7074da0b66cSBjorn Helgaas 		.flags = SPECIAL | SMALL | ZEROPAD,
7084da0b66cSBjorn Helgaas 	};
7090f4050c7SBjorn Helgaas 	static const struct printf_spec bus_spec = {
7100f4050c7SBjorn Helgaas 		.base = 16,
7110f4050c7SBjorn Helgaas 		.field_width = 2,
7120f4050c7SBjorn Helgaas 		.precision = -1,
7130f4050c7SBjorn Helgaas 		.flags = SMALL | ZEROPAD,
7140f4050c7SBjorn Helgaas 	};
7154da0b66cSBjorn Helgaas 	static const struct printf_spec dec_spec = {
716c91d3376SBjorn Helgaas 		.base = 10,
717c91d3376SBjorn Helgaas 		.precision = -1,
718c91d3376SBjorn Helgaas 		.flags = 0,
719c91d3376SBjorn Helgaas 	};
7204da0b66cSBjorn Helgaas 	static const struct printf_spec str_spec = {
721fd95541eSBjorn Helgaas 		.field_width = -1,
722fd95541eSBjorn Helgaas 		.precision = 10,
723fd95541eSBjorn Helgaas 		.flags = LEFT,
724fd95541eSBjorn Helgaas 	};
7254da0b66cSBjorn Helgaas 	static const struct printf_spec flag_spec = {
726fd95541eSBjorn Helgaas 		.base = 16,
727fd95541eSBjorn Helgaas 		.precision = -1,
728fd95541eSBjorn Helgaas 		.flags = SPECIAL | SMALL,
729fd95541eSBjorn Helgaas 	};
730c7dabef8SBjorn Helgaas 
731c7dabef8SBjorn Helgaas 	/* 32-bit res (sizeof==4): 10 chars in dec, 10 in hex ("0x" + 8)
732c7dabef8SBjorn Helgaas 	 * 64-bit res (sizeof==8): 20 chars in dec, 18 in hex ("0x" + 16) */
733c7dabef8SBjorn Helgaas #define RSRC_BUF_SIZE		((2 * sizeof(resource_size_t)) + 4)
734c7dabef8SBjorn Helgaas #define FLAG_BUF_SIZE		(2 * sizeof(res->flags))
7359d7cca04SBjorn Helgaas #define DECODED_BUF_SIZE	sizeof("[mem - 64bit pref window disabled]")
736c7dabef8SBjorn Helgaas #define RAW_BUF_SIZE		sizeof("[mem - flags 0x]")
737c7dabef8SBjorn Helgaas 	char sym[max(2*RSRC_BUF_SIZE + DECODED_BUF_SIZE,
738c7dabef8SBjorn Helgaas 		     2*RSRC_BUF_SIZE + FLAG_BUF_SIZE + RAW_BUF_SIZE)];
739c7dabef8SBjorn Helgaas 
740332d2e78SLinus Torvalds 	char *p = sym, *pend = sym + sizeof(sym);
741c7dabef8SBjorn Helgaas 	int decode = (fmt[0] == 'R') ? 1 : 0;
7424da0b66cSBjorn Helgaas 	const struct printf_spec *specp;
743332d2e78SLinus Torvalds 
744332d2e78SLinus Torvalds 	*p++ = '[';
7454da0b66cSBjorn Helgaas 	if (res->flags & IORESOURCE_IO) {
746fd95541eSBjorn Helgaas 		p = string(p, pend, "io  ", str_spec);
7474da0b66cSBjorn Helgaas 		specp = &io_spec;
7484da0b66cSBjorn Helgaas 	} else if (res->flags & IORESOURCE_MEM) {
749fd95541eSBjorn Helgaas 		p = string(p, pend, "mem ", str_spec);
7504da0b66cSBjorn Helgaas 		specp = &mem_spec;
7514da0b66cSBjorn Helgaas 	} else if (res->flags & IORESOURCE_IRQ) {
752fd95541eSBjorn Helgaas 		p = string(p, pend, "irq ", str_spec);
7534da0b66cSBjorn Helgaas 		specp = &dec_spec;
7544da0b66cSBjorn Helgaas 	} else if (res->flags & IORESOURCE_DMA) {
755fd95541eSBjorn Helgaas 		p = string(p, pend, "dma ", str_spec);
7564da0b66cSBjorn Helgaas 		specp = &dec_spec;
7570f4050c7SBjorn Helgaas 	} else if (res->flags & IORESOURCE_BUS) {
7580f4050c7SBjorn Helgaas 		p = string(p, pend, "bus ", str_spec);
7590f4050c7SBjorn Helgaas 		specp = &bus_spec;
7604da0b66cSBjorn Helgaas 	} else {
761c7dabef8SBjorn Helgaas 		p = string(p, pend, "??? ", str_spec);
7624da0b66cSBjorn Helgaas 		specp = &mem_spec;
763c7dabef8SBjorn Helgaas 		decode = 0;
764fd95541eSBjorn Helgaas 	}
765d19cb803SBjorn Helgaas 	if (decode && res->flags & IORESOURCE_UNSET) {
766d19cb803SBjorn Helgaas 		p = string(p, pend, "size ", str_spec);
767d19cb803SBjorn Helgaas 		p = number(p, pend, resource_size(res), *specp);
768d19cb803SBjorn Helgaas 	} else {
7694da0b66cSBjorn Helgaas 		p = number(p, pend, res->start, *specp);
770c91d3376SBjorn Helgaas 		if (res->start != res->end) {
771332d2e78SLinus Torvalds 			*p++ = '-';
7724da0b66cSBjorn Helgaas 			p = number(p, pend, res->end, *specp);
773c91d3376SBjorn Helgaas 		}
774d19cb803SBjorn Helgaas 	}
775c7dabef8SBjorn Helgaas 	if (decode) {
776fd95541eSBjorn Helgaas 		if (res->flags & IORESOURCE_MEM_64)
777fd95541eSBjorn Helgaas 			p = string(p, pend, " 64bit", str_spec);
778fd95541eSBjorn Helgaas 		if (res->flags & IORESOURCE_PREFETCH)
779fd95541eSBjorn Helgaas 			p = string(p, pend, " pref", str_spec);
7809d7cca04SBjorn Helgaas 		if (res->flags & IORESOURCE_WINDOW)
7819d7cca04SBjorn Helgaas 			p = string(p, pend, " window", str_spec);
782fd95541eSBjorn Helgaas 		if (res->flags & IORESOURCE_DISABLED)
783fd95541eSBjorn Helgaas 			p = string(p, pend, " disabled", str_spec);
784c7dabef8SBjorn Helgaas 	} else {
785fd95541eSBjorn Helgaas 		p = string(p, pend, " flags ", str_spec);
786c7dabef8SBjorn Helgaas 		p = number(p, pend, res->flags, flag_spec);
787fd95541eSBjorn Helgaas 	}
788332d2e78SLinus Torvalds 	*p++ = ']';
789c7dabef8SBjorn Helgaas 	*p = '\0';
790332d2e78SLinus Torvalds 
791fef20d9cSFrederic Weisbecker 	return string(buf, end, sym, spec);
792332d2e78SLinus Torvalds }
793332d2e78SLinus Torvalds 
794cf3b429bSJoe Perches static noinline_for_stack
79531550a16SAndy Shevchenko char *hex_string(char *buf, char *end, u8 *addr, struct printf_spec spec,
79631550a16SAndy Shevchenko 		 const char *fmt)
79731550a16SAndy Shevchenko {
798360603a1SSteven Rostedt 	int i, len = 1;		/* if we pass '%ph[CDN]', field width remains
79931550a16SAndy Shevchenko 				   negative value, fallback to the default */
80031550a16SAndy Shevchenko 	char separator;
80131550a16SAndy Shevchenko 
80231550a16SAndy Shevchenko 	if (spec.field_width == 0)
80331550a16SAndy Shevchenko 		/* nothing to print */
80431550a16SAndy Shevchenko 		return buf;
80531550a16SAndy Shevchenko 
80631550a16SAndy Shevchenko 	if (ZERO_OR_NULL_PTR(addr))
80731550a16SAndy Shevchenko 		/* NULL pointer */
80831550a16SAndy Shevchenko 		return string(buf, end, NULL, spec);
80931550a16SAndy Shevchenko 
81031550a16SAndy Shevchenko 	switch (fmt[1]) {
81131550a16SAndy Shevchenko 	case 'C':
81231550a16SAndy Shevchenko 		separator = ':';
81331550a16SAndy Shevchenko 		break;
81431550a16SAndy Shevchenko 	case 'D':
81531550a16SAndy Shevchenko 		separator = '-';
81631550a16SAndy Shevchenko 		break;
81731550a16SAndy Shevchenko 	case 'N':
81831550a16SAndy Shevchenko 		separator = 0;
81931550a16SAndy Shevchenko 		break;
82031550a16SAndy Shevchenko 	default:
82131550a16SAndy Shevchenko 		separator = ' ';
82231550a16SAndy Shevchenko 		break;
82331550a16SAndy Shevchenko 	}
82431550a16SAndy Shevchenko 
82531550a16SAndy Shevchenko 	if (spec.field_width > 0)
82631550a16SAndy Shevchenko 		len = min_t(int, spec.field_width, 64);
82731550a16SAndy Shevchenko 
8289c98f235SRasmus Villemoes 	for (i = 0; i < len; ++i) {
8299c98f235SRasmus Villemoes 		if (buf < end)
8309c98f235SRasmus Villemoes 			*buf = hex_asc_hi(addr[i]);
8319c98f235SRasmus Villemoes 		++buf;
8329c98f235SRasmus Villemoes 		if (buf < end)
8339c98f235SRasmus Villemoes 			*buf = hex_asc_lo(addr[i]);
8349c98f235SRasmus Villemoes 		++buf;
83531550a16SAndy Shevchenko 
8369c98f235SRasmus Villemoes 		if (separator && i != len - 1) {
8379c98f235SRasmus Villemoes 			if (buf < end)
8389c98f235SRasmus Villemoes 				*buf = separator;
8399c98f235SRasmus Villemoes 			++buf;
8409c98f235SRasmus Villemoes 		}
84131550a16SAndy Shevchenko 	}
84231550a16SAndy Shevchenko 
84331550a16SAndy Shevchenko 	return buf;
84431550a16SAndy Shevchenko }
84531550a16SAndy Shevchenko 
84631550a16SAndy Shevchenko static noinline_for_stack
847dbc760bcSTejun Heo char *bitmap_string(char *buf, char *end, unsigned long *bitmap,
848dbc760bcSTejun Heo 		    struct printf_spec spec, const char *fmt)
849dbc760bcSTejun Heo {
850dbc760bcSTejun Heo 	const int CHUNKSZ = 32;
851dbc760bcSTejun Heo 	int nr_bits = max_t(int, spec.field_width, 0);
852dbc760bcSTejun Heo 	int i, chunksz;
853dbc760bcSTejun Heo 	bool first = true;
854dbc760bcSTejun Heo 
855dbc760bcSTejun Heo 	/* reused to print numbers */
856dbc760bcSTejun Heo 	spec = (struct printf_spec){ .flags = SMALL | ZEROPAD, .base = 16 };
857dbc760bcSTejun Heo 
858dbc760bcSTejun Heo 	chunksz = nr_bits & (CHUNKSZ - 1);
859dbc760bcSTejun Heo 	if (chunksz == 0)
860dbc760bcSTejun Heo 		chunksz = CHUNKSZ;
861dbc760bcSTejun Heo 
862dbc760bcSTejun Heo 	i = ALIGN(nr_bits, CHUNKSZ) - CHUNKSZ;
863dbc760bcSTejun Heo 	for (; i >= 0; i -= CHUNKSZ) {
864dbc760bcSTejun Heo 		u32 chunkmask, val;
865dbc760bcSTejun Heo 		int word, bit;
866dbc760bcSTejun Heo 
867dbc760bcSTejun Heo 		chunkmask = ((1ULL << chunksz) - 1);
868dbc760bcSTejun Heo 		word = i / BITS_PER_LONG;
869dbc760bcSTejun Heo 		bit = i % BITS_PER_LONG;
870dbc760bcSTejun Heo 		val = (bitmap[word] >> bit) & chunkmask;
871dbc760bcSTejun Heo 
872dbc760bcSTejun Heo 		if (!first) {
873dbc760bcSTejun Heo 			if (buf < end)
874dbc760bcSTejun Heo 				*buf = ',';
875dbc760bcSTejun Heo 			buf++;
876dbc760bcSTejun Heo 		}
877dbc760bcSTejun Heo 		first = false;
878dbc760bcSTejun Heo 
879dbc760bcSTejun Heo 		spec.field_width = DIV_ROUND_UP(chunksz, 4);
880dbc760bcSTejun Heo 		buf = number(buf, end, val, spec);
881dbc760bcSTejun Heo 
882dbc760bcSTejun Heo 		chunksz = CHUNKSZ;
883dbc760bcSTejun Heo 	}
884dbc760bcSTejun Heo 	return buf;
885dbc760bcSTejun Heo }
886dbc760bcSTejun Heo 
887dbc760bcSTejun Heo static noinline_for_stack
888dbc760bcSTejun Heo char *bitmap_list_string(char *buf, char *end, unsigned long *bitmap,
889dbc760bcSTejun Heo 			 struct printf_spec spec, const char *fmt)
890dbc760bcSTejun Heo {
891dbc760bcSTejun Heo 	int nr_bits = max_t(int, spec.field_width, 0);
892dbc760bcSTejun Heo 	/* current bit is 'cur', most recently seen range is [rbot, rtop] */
893dbc760bcSTejun Heo 	int cur, rbot, rtop;
894dbc760bcSTejun Heo 	bool first = true;
895dbc760bcSTejun Heo 
896dbc760bcSTejun Heo 	/* reused to print numbers */
897dbc760bcSTejun Heo 	spec = (struct printf_spec){ .base = 10 };
898dbc760bcSTejun Heo 
899dbc760bcSTejun Heo 	rbot = cur = find_first_bit(bitmap, nr_bits);
900dbc760bcSTejun Heo 	while (cur < nr_bits) {
901dbc760bcSTejun Heo 		rtop = cur;
902dbc760bcSTejun Heo 		cur = find_next_bit(bitmap, nr_bits, cur + 1);
903dbc760bcSTejun Heo 		if (cur < nr_bits && cur <= rtop + 1)
904dbc760bcSTejun Heo 			continue;
905dbc760bcSTejun Heo 
906dbc760bcSTejun Heo 		if (!first) {
907dbc760bcSTejun Heo 			if (buf < end)
908dbc760bcSTejun Heo 				*buf = ',';
909dbc760bcSTejun Heo 			buf++;
910dbc760bcSTejun Heo 		}
911dbc760bcSTejun Heo 		first = false;
912dbc760bcSTejun Heo 
913dbc760bcSTejun Heo 		buf = number(buf, end, rbot, spec);
914dbc760bcSTejun Heo 		if (rbot < rtop) {
915dbc760bcSTejun Heo 			if (buf < end)
916dbc760bcSTejun Heo 				*buf = '-';
917dbc760bcSTejun Heo 			buf++;
918dbc760bcSTejun Heo 
919dbc760bcSTejun Heo 			buf = number(buf, end, rtop, spec);
920dbc760bcSTejun Heo 		}
921dbc760bcSTejun Heo 
922dbc760bcSTejun Heo 		rbot = cur;
923dbc760bcSTejun Heo 	}
924dbc760bcSTejun Heo 	return buf;
925dbc760bcSTejun Heo }
926dbc760bcSTejun Heo 
927dbc760bcSTejun Heo static noinline_for_stack
928cf3b429bSJoe Perches char *mac_address_string(char *buf, char *end, u8 *addr,
9298a27f7c9SJoe Perches 			 struct printf_spec spec, const char *fmt)
930dd45c9cfSHarvey Harrison {
9318a27f7c9SJoe Perches 	char mac_addr[sizeof("xx:xx:xx:xx:xx:xx")];
932dd45c9cfSHarvey Harrison 	char *p = mac_addr;
933dd45c9cfSHarvey Harrison 	int i;
934bc7259a2SJoe Perches 	char separator;
93576597ff9SAndrei Emeltchenko 	bool reversed = false;
936bc7259a2SJoe Perches 
93776597ff9SAndrei Emeltchenko 	switch (fmt[1]) {
93876597ff9SAndrei Emeltchenko 	case 'F':
939bc7259a2SJoe Perches 		separator = '-';
94076597ff9SAndrei Emeltchenko 		break;
94176597ff9SAndrei Emeltchenko 
94276597ff9SAndrei Emeltchenko 	case 'R':
94376597ff9SAndrei Emeltchenko 		reversed = true;
94476597ff9SAndrei Emeltchenko 		/* fall through */
94576597ff9SAndrei Emeltchenko 
94676597ff9SAndrei Emeltchenko 	default:
947bc7259a2SJoe Perches 		separator = ':';
94876597ff9SAndrei Emeltchenko 		break;
949bc7259a2SJoe Perches 	}
950dd45c9cfSHarvey Harrison 
951dd45c9cfSHarvey Harrison 	for (i = 0; i < 6; i++) {
95276597ff9SAndrei Emeltchenko 		if (reversed)
95376597ff9SAndrei Emeltchenko 			p = hex_byte_pack(p, addr[5 - i]);
95476597ff9SAndrei Emeltchenko 		else
95555036ba7SAndy Shevchenko 			p = hex_byte_pack(p, addr[i]);
95676597ff9SAndrei Emeltchenko 
9578a27f7c9SJoe Perches 		if (fmt[0] == 'M' && i != 5)
958bc7259a2SJoe Perches 			*p++ = separator;
959dd45c9cfSHarvey Harrison 	}
960dd45c9cfSHarvey Harrison 	*p = '\0';
961dd45c9cfSHarvey Harrison 
962fef20d9cSFrederic Weisbecker 	return string(buf, end, mac_addr, spec);
963dd45c9cfSHarvey Harrison }
964dd45c9cfSHarvey Harrison 
965cf3b429bSJoe Perches static noinline_for_stack
966cf3b429bSJoe Perches char *ip4_string(char *p, const u8 *addr, const char *fmt)
967689afa7dSHarvey Harrison {
968689afa7dSHarvey Harrison 	int i;
9690159f24eSJoe Perches 	bool leading_zeros = (fmt[0] == 'i');
9700159f24eSJoe Perches 	int index;
9710159f24eSJoe Perches 	int step;
972689afa7dSHarvey Harrison 
9730159f24eSJoe Perches 	switch (fmt[2]) {
9740159f24eSJoe Perches 	case 'h':
9750159f24eSJoe Perches #ifdef __BIG_ENDIAN
9760159f24eSJoe Perches 		index = 0;
9770159f24eSJoe Perches 		step = 1;
9780159f24eSJoe Perches #else
9790159f24eSJoe Perches 		index = 3;
9800159f24eSJoe Perches 		step = -1;
9810159f24eSJoe Perches #endif
9820159f24eSJoe Perches 		break;
9830159f24eSJoe Perches 	case 'l':
9840159f24eSJoe Perches 		index = 3;
9850159f24eSJoe Perches 		step = -1;
9860159f24eSJoe Perches 		break;
9870159f24eSJoe Perches 	case 'n':
9880159f24eSJoe Perches 	case 'b':
9890159f24eSJoe Perches 	default:
9900159f24eSJoe Perches 		index = 0;
9910159f24eSJoe Perches 		step = 1;
9920159f24eSJoe Perches 		break;
9930159f24eSJoe Perches 	}
9948a27f7c9SJoe Perches 	for (i = 0; i < 4; i++) {
9957c43d9a3SRasmus Villemoes 		char temp[4] __aligned(2);	/* hold each IP quad in reverse order */
996133fd9f5SDenys Vlasenko 		int digits = put_dec_trunc8(temp, addr[index]) - temp;
9978a27f7c9SJoe Perches 		if (leading_zeros) {
9988a27f7c9SJoe Perches 			if (digits < 3)
9998a27f7c9SJoe Perches 				*p++ = '0';
10008a27f7c9SJoe Perches 			if (digits < 2)
10018a27f7c9SJoe Perches 				*p++ = '0';
10028a27f7c9SJoe Perches 		}
10038a27f7c9SJoe Perches 		/* reverse the digits in the quad */
10048a27f7c9SJoe Perches 		while (digits--)
10058a27f7c9SJoe Perches 			*p++ = temp[digits];
10068a27f7c9SJoe Perches 		if (i < 3)
10078a27f7c9SJoe Perches 			*p++ = '.';
10080159f24eSJoe Perches 		index += step;
10098a27f7c9SJoe Perches 	}
10108a27f7c9SJoe Perches 	*p = '\0';
10117b9186f5SAndré Goddard Rosa 
10128a27f7c9SJoe Perches 	return p;
10138a27f7c9SJoe Perches }
10148a27f7c9SJoe Perches 
1015cf3b429bSJoe Perches static noinline_for_stack
1016cf3b429bSJoe Perches char *ip6_compressed_string(char *p, const char *addr)
10178a27f7c9SJoe Perches {
10187b9186f5SAndré Goddard Rosa 	int i, j, range;
10198a27f7c9SJoe Perches 	unsigned char zerolength[8];
10208a27f7c9SJoe Perches 	int longest = 1;
10218a27f7c9SJoe Perches 	int colonpos = -1;
10228a27f7c9SJoe Perches 	u16 word;
10237b9186f5SAndré Goddard Rosa 	u8 hi, lo;
10248a27f7c9SJoe Perches 	bool needcolon = false;
1025eb78cd26SJoe Perches 	bool useIPv4;
1026eb78cd26SJoe Perches 	struct in6_addr in6;
1027eb78cd26SJoe Perches 
1028eb78cd26SJoe Perches 	memcpy(&in6, addr, sizeof(struct in6_addr));
1029eb78cd26SJoe Perches 
1030eb78cd26SJoe Perches 	useIPv4 = ipv6_addr_v4mapped(&in6) || ipv6_addr_is_isatap(&in6);
10318a27f7c9SJoe Perches 
10328a27f7c9SJoe Perches 	memset(zerolength, 0, sizeof(zerolength));
10338a27f7c9SJoe Perches 
10348a27f7c9SJoe Perches 	if (useIPv4)
10358a27f7c9SJoe Perches 		range = 6;
10368a27f7c9SJoe Perches 	else
10378a27f7c9SJoe Perches 		range = 8;
10388a27f7c9SJoe Perches 
10398a27f7c9SJoe Perches 	/* find position of longest 0 run */
10408a27f7c9SJoe Perches 	for (i = 0; i < range; i++) {
10418a27f7c9SJoe Perches 		for (j = i; j < range; j++) {
1042eb78cd26SJoe Perches 			if (in6.s6_addr16[j] != 0)
10438a27f7c9SJoe Perches 				break;
10448a27f7c9SJoe Perches 			zerolength[i]++;
10458a27f7c9SJoe Perches 		}
10468a27f7c9SJoe Perches 	}
10478a27f7c9SJoe Perches 	for (i = 0; i < range; i++) {
10488a27f7c9SJoe Perches 		if (zerolength[i] > longest) {
10498a27f7c9SJoe Perches 			longest = zerolength[i];
10508a27f7c9SJoe Perches 			colonpos = i;
10518a27f7c9SJoe Perches 		}
10528a27f7c9SJoe Perches 	}
105329cf519eSJoe Perches 	if (longest == 1)		/* don't compress a single 0 */
105429cf519eSJoe Perches 		colonpos = -1;
10558a27f7c9SJoe Perches 
10568a27f7c9SJoe Perches 	/* emit address */
10578a27f7c9SJoe Perches 	for (i = 0; i < range; i++) {
10588a27f7c9SJoe Perches 		if (i == colonpos) {
10598a27f7c9SJoe Perches 			if (needcolon || i == 0)
10608a27f7c9SJoe Perches 				*p++ = ':';
10618a27f7c9SJoe Perches 			*p++ = ':';
10628a27f7c9SJoe Perches 			needcolon = false;
10638a27f7c9SJoe Perches 			i += longest - 1;
10648a27f7c9SJoe Perches 			continue;
10658a27f7c9SJoe Perches 		}
10668a27f7c9SJoe Perches 		if (needcolon) {
10678a27f7c9SJoe Perches 			*p++ = ':';
10688a27f7c9SJoe Perches 			needcolon = false;
10698a27f7c9SJoe Perches 		}
10708a27f7c9SJoe Perches 		/* hex u16 without leading 0s */
1071eb78cd26SJoe Perches 		word = ntohs(in6.s6_addr16[i]);
10728a27f7c9SJoe Perches 		hi = word >> 8;
10738a27f7c9SJoe Perches 		lo = word & 0xff;
10748a27f7c9SJoe Perches 		if (hi) {
10758a27f7c9SJoe Perches 			if (hi > 0x0f)
107655036ba7SAndy Shevchenko 				p = hex_byte_pack(p, hi);
10778a27f7c9SJoe Perches 			else
10788a27f7c9SJoe Perches 				*p++ = hex_asc_lo(hi);
107955036ba7SAndy Shevchenko 			p = hex_byte_pack(p, lo);
10808a27f7c9SJoe Perches 		}
1081b5ff992bSAndré Goddard Rosa 		else if (lo > 0x0f)
108255036ba7SAndy Shevchenko 			p = hex_byte_pack(p, lo);
10838a27f7c9SJoe Perches 		else
10848a27f7c9SJoe Perches 			*p++ = hex_asc_lo(lo);
10858a27f7c9SJoe Perches 		needcolon = true;
10868a27f7c9SJoe Perches 	}
10878a27f7c9SJoe Perches 
10888a27f7c9SJoe Perches 	if (useIPv4) {
10898a27f7c9SJoe Perches 		if (needcolon)
10908a27f7c9SJoe Perches 			*p++ = ':';
10910159f24eSJoe Perches 		p = ip4_string(p, &in6.s6_addr[12], "I4");
10928a27f7c9SJoe Perches 	}
10938a27f7c9SJoe Perches 	*p = '\0';
10947b9186f5SAndré Goddard Rosa 
10958a27f7c9SJoe Perches 	return p;
10968a27f7c9SJoe Perches }
10978a27f7c9SJoe Perches 
1098cf3b429bSJoe Perches static noinline_for_stack
1099cf3b429bSJoe Perches char *ip6_string(char *p, const char *addr, const char *fmt)
11008a27f7c9SJoe Perches {
11018a27f7c9SJoe Perches 	int i;
11027b9186f5SAndré Goddard Rosa 
1103689afa7dSHarvey Harrison 	for (i = 0; i < 8; i++) {
110455036ba7SAndy Shevchenko 		p = hex_byte_pack(p, *addr++);
110555036ba7SAndy Shevchenko 		p = hex_byte_pack(p, *addr++);
11068a27f7c9SJoe Perches 		if (fmt[0] == 'I' && i != 7)
1107689afa7dSHarvey Harrison 			*p++ = ':';
1108689afa7dSHarvey Harrison 	}
1109689afa7dSHarvey Harrison 	*p = '\0';
11107b9186f5SAndré Goddard Rosa 
11118a27f7c9SJoe Perches 	return p;
11128a27f7c9SJoe Perches }
11138a27f7c9SJoe Perches 
1114cf3b429bSJoe Perches static noinline_for_stack
1115cf3b429bSJoe Perches char *ip6_addr_string(char *buf, char *end, const u8 *addr,
11168a27f7c9SJoe Perches 		      struct printf_spec spec, const char *fmt)
11178a27f7c9SJoe Perches {
11188a27f7c9SJoe Perches 	char ip6_addr[sizeof("xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:255.255.255.255")];
11198a27f7c9SJoe Perches 
11208a27f7c9SJoe Perches 	if (fmt[0] == 'I' && fmt[2] == 'c')
1121eb78cd26SJoe Perches 		ip6_compressed_string(ip6_addr, addr);
11228a27f7c9SJoe Perches 	else
1123eb78cd26SJoe Perches 		ip6_string(ip6_addr, addr, fmt);
1124689afa7dSHarvey Harrison 
1125fef20d9cSFrederic Weisbecker 	return string(buf, end, ip6_addr, spec);
1126689afa7dSHarvey Harrison }
1127689afa7dSHarvey Harrison 
1128cf3b429bSJoe Perches static noinline_for_stack
1129cf3b429bSJoe Perches char *ip4_addr_string(char *buf, char *end, const u8 *addr,
11308a27f7c9SJoe Perches 		      struct printf_spec spec, const char *fmt)
11314aa99606SHarvey Harrison {
11328a27f7c9SJoe Perches 	char ip4_addr[sizeof("255.255.255.255")];
11334aa99606SHarvey Harrison 
11340159f24eSJoe Perches 	ip4_string(ip4_addr, addr, fmt);
11354aa99606SHarvey Harrison 
1136fef20d9cSFrederic Weisbecker 	return string(buf, end, ip4_addr, spec);
11374aa99606SHarvey Harrison }
11384aa99606SHarvey Harrison 
1139cf3b429bSJoe Perches static noinline_for_stack
114010679643SDaniel Borkmann char *ip6_addr_string_sa(char *buf, char *end, const struct sockaddr_in6 *sa,
114110679643SDaniel Borkmann 			 struct printf_spec spec, const char *fmt)
114210679643SDaniel Borkmann {
114310679643SDaniel Borkmann 	bool have_p = false, have_s = false, have_f = false, have_c = false;
114410679643SDaniel Borkmann 	char ip6_addr[sizeof("[xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:255.255.255.255]") +
114510679643SDaniel Borkmann 		      sizeof(":12345") + sizeof("/123456789") +
114610679643SDaniel Borkmann 		      sizeof("%1234567890")];
114710679643SDaniel Borkmann 	char *p = ip6_addr, *pend = ip6_addr + sizeof(ip6_addr);
114810679643SDaniel Borkmann 	const u8 *addr = (const u8 *) &sa->sin6_addr;
114910679643SDaniel Borkmann 	char fmt6[2] = { fmt[0], '6' };
115010679643SDaniel Borkmann 	u8 off = 0;
115110679643SDaniel Borkmann 
115210679643SDaniel Borkmann 	fmt++;
115310679643SDaniel Borkmann 	while (isalpha(*++fmt)) {
115410679643SDaniel Borkmann 		switch (*fmt) {
115510679643SDaniel Borkmann 		case 'p':
115610679643SDaniel Borkmann 			have_p = true;
115710679643SDaniel Borkmann 			break;
115810679643SDaniel Borkmann 		case 'f':
115910679643SDaniel Borkmann 			have_f = true;
116010679643SDaniel Borkmann 			break;
116110679643SDaniel Borkmann 		case 's':
116210679643SDaniel Borkmann 			have_s = true;
116310679643SDaniel Borkmann 			break;
116410679643SDaniel Borkmann 		case 'c':
116510679643SDaniel Borkmann 			have_c = true;
116610679643SDaniel Borkmann 			break;
116710679643SDaniel Borkmann 		}
116810679643SDaniel Borkmann 	}
116910679643SDaniel Borkmann 
117010679643SDaniel Borkmann 	if (have_p || have_s || have_f) {
117110679643SDaniel Borkmann 		*p = '[';
117210679643SDaniel Borkmann 		off = 1;
117310679643SDaniel Borkmann 	}
117410679643SDaniel Borkmann 
117510679643SDaniel Borkmann 	if (fmt6[0] == 'I' && have_c)
117610679643SDaniel Borkmann 		p = ip6_compressed_string(ip6_addr + off, addr);
117710679643SDaniel Borkmann 	else
117810679643SDaniel Borkmann 		p = ip6_string(ip6_addr + off, addr, fmt6);
117910679643SDaniel Borkmann 
118010679643SDaniel Borkmann 	if (have_p || have_s || have_f)
118110679643SDaniel Borkmann 		*p++ = ']';
118210679643SDaniel Borkmann 
118310679643SDaniel Borkmann 	if (have_p) {
118410679643SDaniel Borkmann 		*p++ = ':';
118510679643SDaniel Borkmann 		p = number(p, pend, ntohs(sa->sin6_port), spec);
118610679643SDaniel Borkmann 	}
118710679643SDaniel Borkmann 	if (have_f) {
118810679643SDaniel Borkmann 		*p++ = '/';
118910679643SDaniel Borkmann 		p = number(p, pend, ntohl(sa->sin6_flowinfo &
119010679643SDaniel Borkmann 					  IPV6_FLOWINFO_MASK), spec);
119110679643SDaniel Borkmann 	}
119210679643SDaniel Borkmann 	if (have_s) {
119310679643SDaniel Borkmann 		*p++ = '%';
119410679643SDaniel Borkmann 		p = number(p, pend, sa->sin6_scope_id, spec);
119510679643SDaniel Borkmann 	}
119610679643SDaniel Borkmann 	*p = '\0';
119710679643SDaniel Borkmann 
119810679643SDaniel Borkmann 	return string(buf, end, ip6_addr, spec);
119910679643SDaniel Borkmann }
120010679643SDaniel Borkmann 
120110679643SDaniel Borkmann static noinline_for_stack
120210679643SDaniel Borkmann char *ip4_addr_string_sa(char *buf, char *end, const struct sockaddr_in *sa,
120310679643SDaniel Borkmann 			 struct printf_spec spec, const char *fmt)
120410679643SDaniel Borkmann {
120510679643SDaniel Borkmann 	bool have_p = false;
120610679643SDaniel Borkmann 	char *p, ip4_addr[sizeof("255.255.255.255") + sizeof(":12345")];
120710679643SDaniel Borkmann 	char *pend = ip4_addr + sizeof(ip4_addr);
120810679643SDaniel Borkmann 	const u8 *addr = (const u8 *) &sa->sin_addr.s_addr;
120910679643SDaniel Borkmann 	char fmt4[3] = { fmt[0], '4', 0 };
121010679643SDaniel Borkmann 
121110679643SDaniel Borkmann 	fmt++;
121210679643SDaniel Borkmann 	while (isalpha(*++fmt)) {
121310679643SDaniel Borkmann 		switch (*fmt) {
121410679643SDaniel Borkmann 		case 'p':
121510679643SDaniel Borkmann 			have_p = true;
121610679643SDaniel Borkmann 			break;
121710679643SDaniel Borkmann 		case 'h':
121810679643SDaniel Borkmann 		case 'l':
121910679643SDaniel Borkmann 		case 'n':
122010679643SDaniel Borkmann 		case 'b':
122110679643SDaniel Borkmann 			fmt4[2] = *fmt;
122210679643SDaniel Borkmann 			break;
122310679643SDaniel Borkmann 		}
122410679643SDaniel Borkmann 	}
122510679643SDaniel Borkmann 
122610679643SDaniel Borkmann 	p = ip4_string(ip4_addr, addr, fmt4);
122710679643SDaniel Borkmann 	if (have_p) {
122810679643SDaniel Borkmann 		*p++ = ':';
122910679643SDaniel Borkmann 		p = number(p, pend, ntohs(sa->sin_port), spec);
123010679643SDaniel Borkmann 	}
123110679643SDaniel Borkmann 	*p = '\0';
123210679643SDaniel Borkmann 
123310679643SDaniel Borkmann 	return string(buf, end, ip4_addr, spec);
123410679643SDaniel Borkmann }
123510679643SDaniel Borkmann 
123610679643SDaniel Borkmann static noinline_for_stack
123771dca95dSAndy Shevchenko char *escaped_string(char *buf, char *end, u8 *addr, struct printf_spec spec,
123871dca95dSAndy Shevchenko 		     const char *fmt)
123971dca95dSAndy Shevchenko {
124071dca95dSAndy Shevchenko 	bool found = true;
124171dca95dSAndy Shevchenko 	int count = 1;
124271dca95dSAndy Shevchenko 	unsigned int flags = 0;
124371dca95dSAndy Shevchenko 	int len;
124471dca95dSAndy Shevchenko 
124571dca95dSAndy Shevchenko 	if (spec.field_width == 0)
124671dca95dSAndy Shevchenko 		return buf;				/* nothing to print */
124771dca95dSAndy Shevchenko 
124871dca95dSAndy Shevchenko 	if (ZERO_OR_NULL_PTR(addr))
124971dca95dSAndy Shevchenko 		return string(buf, end, NULL, spec);	/* NULL pointer */
125071dca95dSAndy Shevchenko 
125171dca95dSAndy Shevchenko 
125271dca95dSAndy Shevchenko 	do {
125371dca95dSAndy Shevchenko 		switch (fmt[count++]) {
125471dca95dSAndy Shevchenko 		case 'a':
125571dca95dSAndy Shevchenko 			flags |= ESCAPE_ANY;
125671dca95dSAndy Shevchenko 			break;
125771dca95dSAndy Shevchenko 		case 'c':
125871dca95dSAndy Shevchenko 			flags |= ESCAPE_SPECIAL;
125971dca95dSAndy Shevchenko 			break;
126071dca95dSAndy Shevchenko 		case 'h':
126171dca95dSAndy Shevchenko 			flags |= ESCAPE_HEX;
126271dca95dSAndy Shevchenko 			break;
126371dca95dSAndy Shevchenko 		case 'n':
126471dca95dSAndy Shevchenko 			flags |= ESCAPE_NULL;
126571dca95dSAndy Shevchenko 			break;
126671dca95dSAndy Shevchenko 		case 'o':
126771dca95dSAndy Shevchenko 			flags |= ESCAPE_OCTAL;
126871dca95dSAndy Shevchenko 			break;
126971dca95dSAndy Shevchenko 		case 'p':
127071dca95dSAndy Shevchenko 			flags |= ESCAPE_NP;
127171dca95dSAndy Shevchenko 			break;
127271dca95dSAndy Shevchenko 		case 's':
127371dca95dSAndy Shevchenko 			flags |= ESCAPE_SPACE;
127471dca95dSAndy Shevchenko 			break;
127571dca95dSAndy Shevchenko 		default:
127671dca95dSAndy Shevchenko 			found = false;
127771dca95dSAndy Shevchenko 			break;
127871dca95dSAndy Shevchenko 		}
127971dca95dSAndy Shevchenko 	} while (found);
128071dca95dSAndy Shevchenko 
128171dca95dSAndy Shevchenko 	if (!flags)
128271dca95dSAndy Shevchenko 		flags = ESCAPE_ANY_NP;
128371dca95dSAndy Shevchenko 
128471dca95dSAndy Shevchenko 	len = spec.field_width < 0 ? 1 : spec.field_width;
128571dca95dSAndy Shevchenko 
128641416f23SRasmus Villemoes 	/*
128741416f23SRasmus Villemoes 	 * string_escape_mem() writes as many characters as it can to
128841416f23SRasmus Villemoes 	 * the given buffer, and returns the total size of the output
128941416f23SRasmus Villemoes 	 * had the buffer been big enough.
129041416f23SRasmus Villemoes 	 */
129141416f23SRasmus Villemoes 	buf += string_escape_mem(addr, len, buf, buf < end ? end - buf : 0, flags, NULL);
129271dca95dSAndy Shevchenko 
129371dca95dSAndy Shevchenko 	return buf;
129471dca95dSAndy Shevchenko }
129571dca95dSAndy Shevchenko 
129671dca95dSAndy Shevchenko static noinline_for_stack
1297cf3b429bSJoe Perches char *uuid_string(char *buf, char *end, const u8 *addr,
12989ac6e44eSJoe Perches 		  struct printf_spec spec, const char *fmt)
12999ac6e44eSJoe Perches {
13009ac6e44eSJoe Perches 	char uuid[sizeof("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx")];
13019ac6e44eSJoe Perches 	char *p = uuid;
13029ac6e44eSJoe Perches 	int i;
13039ac6e44eSJoe Perches 	static const u8 be[16] = {0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15};
13049ac6e44eSJoe Perches 	static const u8 le[16] = {3,2,1,0,5,4,7,6,8,9,10,11,12,13,14,15};
13059ac6e44eSJoe Perches 	const u8 *index = be;
13069ac6e44eSJoe Perches 	bool uc = false;
13079ac6e44eSJoe Perches 
13089ac6e44eSJoe Perches 	switch (*(++fmt)) {
13099ac6e44eSJoe Perches 	case 'L':
13109ac6e44eSJoe Perches 		uc = true;		/* fall-through */
13119ac6e44eSJoe Perches 	case 'l':
13129ac6e44eSJoe Perches 		index = le;
13139ac6e44eSJoe Perches 		break;
13149ac6e44eSJoe Perches 	case 'B':
13159ac6e44eSJoe Perches 		uc = true;
13169ac6e44eSJoe Perches 		break;
13179ac6e44eSJoe Perches 	}
13189ac6e44eSJoe Perches 
13199ac6e44eSJoe Perches 	for (i = 0; i < 16; i++) {
132055036ba7SAndy Shevchenko 		p = hex_byte_pack(p, addr[index[i]]);
13219ac6e44eSJoe Perches 		switch (i) {
13229ac6e44eSJoe Perches 		case 3:
13239ac6e44eSJoe Perches 		case 5:
13249ac6e44eSJoe Perches 		case 7:
13259ac6e44eSJoe Perches 		case 9:
13269ac6e44eSJoe Perches 			*p++ = '-';
13279ac6e44eSJoe Perches 			break;
13289ac6e44eSJoe Perches 		}
13299ac6e44eSJoe Perches 	}
13309ac6e44eSJoe Perches 
13319ac6e44eSJoe Perches 	*p = 0;
13329ac6e44eSJoe Perches 
13339ac6e44eSJoe Perches 	if (uc) {
13349ac6e44eSJoe Perches 		p = uuid;
13359ac6e44eSJoe Perches 		do {
13369ac6e44eSJoe Perches 			*p = toupper(*p);
13379ac6e44eSJoe Perches 		} while (*(++p));
13389ac6e44eSJoe Perches 	}
13399ac6e44eSJoe Perches 
13409ac6e44eSJoe Perches 	return string(buf, end, uuid, spec);
13419ac6e44eSJoe Perches }
13429ac6e44eSJoe Perches 
1343c8f44affSMichał Mirosław static
1344c8f44affSMichał Mirosław char *netdev_feature_string(char *buf, char *end, const u8 *addr,
1345c8f44affSMichał Mirosław 		      struct printf_spec spec)
1346c8f44affSMichał Mirosław {
1347c8f44affSMichał Mirosław 	spec.flags |= SPECIAL | SMALL | ZEROPAD;
1348c8f44affSMichał Mirosław 	if (spec.field_width == -1)
1349c8f44affSMichał Mirosław 		spec.field_width = 2 + 2 * sizeof(netdev_features_t);
1350c8f44affSMichał Mirosław 	spec.base = 16;
1351c8f44affSMichał Mirosław 
1352c8f44affSMichał Mirosław 	return number(buf, end, *(const netdev_features_t *)addr, spec);
1353c8f44affSMichał Mirosław }
1354c8f44affSMichał Mirosław 
1355aaf07621SJoe Perches static noinline_for_stack
1356aaf07621SJoe Perches char *address_val(char *buf, char *end, const void *addr,
1357aaf07621SJoe Perches 		  struct printf_spec spec, const char *fmt)
1358aaf07621SJoe Perches {
1359aaf07621SJoe Perches 	unsigned long long num;
1360aaf07621SJoe Perches 
1361aaf07621SJoe Perches 	spec.flags |= SPECIAL | SMALL | ZEROPAD;
1362aaf07621SJoe Perches 	spec.base = 16;
1363aaf07621SJoe Perches 
1364aaf07621SJoe Perches 	switch (fmt[1]) {
1365aaf07621SJoe Perches 	case 'd':
1366aaf07621SJoe Perches 		num = *(const dma_addr_t *)addr;
1367aaf07621SJoe Perches 		spec.field_width = sizeof(dma_addr_t) * 2 + 2;
1368aaf07621SJoe Perches 		break;
1369aaf07621SJoe Perches 	case 'p':
1370aaf07621SJoe Perches 	default:
1371aaf07621SJoe Perches 		num = *(const phys_addr_t *)addr;
1372aaf07621SJoe Perches 		spec.field_width = sizeof(phys_addr_t) * 2 + 2;
1373aaf07621SJoe Perches 		break;
1374aaf07621SJoe Perches 	}
1375aaf07621SJoe Perches 
1376aaf07621SJoe Perches 	return number(buf, end, num, spec);
1377aaf07621SJoe Perches }
1378aaf07621SJoe Perches 
1379900cca29SGeert Uytterhoeven static noinline_for_stack
1380900cca29SGeert Uytterhoeven char *clock(char *buf, char *end, struct clk *clk, struct printf_spec spec,
1381900cca29SGeert Uytterhoeven 	    const char *fmt)
1382900cca29SGeert Uytterhoeven {
1383900cca29SGeert Uytterhoeven 	if (!IS_ENABLED(CONFIG_HAVE_CLK) || !clk)
1384900cca29SGeert Uytterhoeven 		return string(buf, end, NULL, spec);
1385900cca29SGeert Uytterhoeven 
1386900cca29SGeert Uytterhoeven 	switch (fmt[1]) {
1387900cca29SGeert Uytterhoeven 	case 'r':
1388900cca29SGeert Uytterhoeven 		return number(buf, end, clk_get_rate(clk), spec);
1389900cca29SGeert Uytterhoeven 
1390900cca29SGeert Uytterhoeven 	case 'n':
1391900cca29SGeert Uytterhoeven 	default:
1392900cca29SGeert Uytterhoeven #ifdef CONFIG_COMMON_CLK
1393900cca29SGeert Uytterhoeven 		return string(buf, end, __clk_get_name(clk), spec);
1394900cca29SGeert Uytterhoeven #else
1395900cca29SGeert Uytterhoeven 		spec.base = 16;
1396900cca29SGeert Uytterhoeven 		spec.field_width = sizeof(unsigned long) * 2 + 2;
1397900cca29SGeert Uytterhoeven 		spec.flags |= SPECIAL | SMALL | ZEROPAD;
1398900cca29SGeert Uytterhoeven 		return number(buf, end, (unsigned long)clk, spec);
1399900cca29SGeert Uytterhoeven #endif
1400900cca29SGeert Uytterhoeven 	}
1401900cca29SGeert Uytterhoeven }
1402900cca29SGeert Uytterhoeven 
1403411f05f1SIngo Molnar int kptr_restrict __read_mostly;
1404455cd5abSDan Rosenberg 
14054d8a743cSLinus Torvalds /*
14064d8a743cSLinus Torvalds  * Show a '%p' thing.  A kernel extension is that the '%p' is followed
14074d8a743cSLinus Torvalds  * by an extra set of alphanumeric characters that are extended format
14084d8a743cSLinus Torvalds  * specifiers.
14094d8a743cSLinus Torvalds  *
1410332d2e78SLinus Torvalds  * Right now we handle:
14110fe1ef24SLinus Torvalds  *
14120c8b946eSFrederic Weisbecker  * - 'F' For symbolic function descriptor pointers with offset
14130c8b946eSFrederic Weisbecker  * - 'f' For simple symbolic function names without offset
14140efb4d20SSteven Rostedt  * - 'S' For symbolic direct pointers with offset
14150efb4d20SSteven Rostedt  * - 's' For symbolic direct pointers without offset
1416b0d33c2bSJoe Perches  * - '[FfSs]R' as above with __builtin_extract_return_addr() translation
14170f77a8d3SNamhyung Kim  * - 'B' For backtraced symbolic direct pointers with offset
1418c7dabef8SBjorn Helgaas  * - 'R' For decoded struct resource, e.g., [mem 0x0-0x1f 64bit pref]
1419c7dabef8SBjorn Helgaas  * - 'r' For raw struct resource, e.g., [mem 0x0-0x1f flags 0x201]
1420dbc760bcSTejun Heo  * - 'b[l]' For a bitmap, the number of bits is determined by the field
1421dbc760bcSTejun Heo  *       width which must be explicitly specified either as part of the
1422dbc760bcSTejun Heo  *       format string '%32b[l]' or through '%*b[l]', [l] selects
1423dbc760bcSTejun Heo  *       range-list format instead of hex format
1424dd45c9cfSHarvey Harrison  * - 'M' For a 6-byte MAC address, it prints the address in the
1425dd45c9cfSHarvey Harrison  *       usual colon-separated hex notation
14268a27f7c9SJoe Perches  * - 'm' For a 6-byte MAC address, it prints the hex address without colons
1427bc7259a2SJoe Perches  * - 'MF' For a 6-byte MAC FDDI address, it prints the address
1428c8e00060SJoe Perches  *       with a dash-separated hex notation
14297c59154eSAndy Shevchenko  * - '[mM]R' For a 6-byte MAC address, Reverse order (Bluetooth)
14308a27f7c9SJoe Perches  * - 'I' [46] for IPv4/IPv6 addresses printed in the usual way
14318a27f7c9SJoe Perches  *       IPv4 uses dot-separated decimal without leading 0's (1.2.3.4)
14328a27f7c9SJoe Perches  *       IPv6 uses colon separated network-order 16 bit hex with leading 0's
143310679643SDaniel Borkmann  *       [S][pfs]
143410679643SDaniel Borkmann  *       Generic IPv4/IPv6 address (struct sockaddr *) that falls back to
143510679643SDaniel Borkmann  *       [4] or [6] and is able to print port [p], flowinfo [f], scope [s]
14368a27f7c9SJoe Perches  * - 'i' [46] for 'raw' IPv4/IPv6 addresses
14378a27f7c9SJoe Perches  *       IPv6 omits the colons (01020304...0f)
14388a27f7c9SJoe Perches  *       IPv4 uses dot-separated decimal with leading 0's (010.123.045.006)
143910679643SDaniel Borkmann  *       [S][pfs]
144010679643SDaniel Borkmann  *       Generic IPv4/IPv6 address (struct sockaddr *) that falls back to
144110679643SDaniel Borkmann  *       [4] or [6] and is able to print port [p], flowinfo [f], scope [s]
144210679643SDaniel Borkmann  * - '[Ii][4S][hnbl]' IPv4 addresses in host, network, big or little endian order
144310679643SDaniel Borkmann  * - 'I[6S]c' for IPv6 addresses printed as specified by
144429cf519eSJoe Perches  *       http://tools.ietf.org/html/rfc5952
144571dca95dSAndy Shevchenko  * - 'E[achnops]' For an escaped buffer, where rules are defined by combination
144671dca95dSAndy Shevchenko  *                of the following flags (see string_escape_mem() for the
144771dca95dSAndy Shevchenko  *                details):
144871dca95dSAndy Shevchenko  *                  a - ESCAPE_ANY
144971dca95dSAndy Shevchenko  *                  c - ESCAPE_SPECIAL
145071dca95dSAndy Shevchenko  *                  h - ESCAPE_HEX
145171dca95dSAndy Shevchenko  *                  n - ESCAPE_NULL
145271dca95dSAndy Shevchenko  *                  o - ESCAPE_OCTAL
145371dca95dSAndy Shevchenko  *                  p - ESCAPE_NP
145471dca95dSAndy Shevchenko  *                  s - ESCAPE_SPACE
145571dca95dSAndy Shevchenko  *                By default ESCAPE_ANY_NP is used.
14569ac6e44eSJoe Perches  * - 'U' For a 16 byte UUID/GUID, it prints the UUID/GUID in the form
14579ac6e44eSJoe Perches  *       "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
14589ac6e44eSJoe Perches  *       Options for %pU are:
14599ac6e44eSJoe Perches  *         b big endian lower case hex (default)
14609ac6e44eSJoe Perches  *         B big endian UPPER case hex
14619ac6e44eSJoe Perches  *         l little endian lower case hex
14629ac6e44eSJoe Perches  *         L little endian UPPER case hex
14639ac6e44eSJoe Perches  *           big endian output byte order is:
14649ac6e44eSJoe Perches  *             [0][1][2][3]-[4][5]-[6][7]-[8][9]-[10][11][12][13][14][15]
14659ac6e44eSJoe Perches  *           little endian output byte order is:
14669ac6e44eSJoe Perches  *             [3][2][1][0]-[5][4]-[7][6]-[8][9]-[10][11][12][13][14][15]
14677db6f5fbSJoe Perches  * - 'V' For a struct va_format which contains a format string * and va_list *,
14687db6f5fbSJoe Perches  *       call vsnprintf(->format, *->va_list).
14697db6f5fbSJoe Perches  *       Implements a "recursive vsnprintf".
14707db6f5fbSJoe Perches  *       Do not use this feature without some mechanism to verify the
14717db6f5fbSJoe Perches  *       correctness of the format string and va_list arguments.
1472455cd5abSDan Rosenberg  * - 'K' For a kernel pointer that should be hidden from unprivileged users
1473c8f44affSMichał Mirosław  * - 'NF' For a netdev_features_t
147431550a16SAndy Shevchenko  * - 'h[CDN]' For a variable-length buffer, it prints it as a hex string with
147531550a16SAndy Shevchenko  *            a certain separator (' ' by default):
147631550a16SAndy Shevchenko  *              C colon
147731550a16SAndy Shevchenko  *              D dash
147831550a16SAndy Shevchenko  *              N no separator
147931550a16SAndy Shevchenko  *            The maximum supported length is 64 bytes of the input. Consider
148031550a16SAndy Shevchenko  *            to use print_hex_dump() for the larger input.
1481aaf07621SJoe Perches  * - 'a[pd]' For address types [p] phys_addr_t, [d] dma_addr_t and derivatives
1482aaf07621SJoe Perches  *           (default assumed to be phys_addr_t, passed by reference)
1483c0d92a57SOlof Johansson  * - 'd[234]' For a dentry name (optionally 2-4 last components)
1484c0d92a57SOlof Johansson  * - 'D[234]' Same as 'd' but for a struct file
14851031bc58SDmitry Monakhov  * - 'g' For block_device name (gendisk + partition number)
1486900cca29SGeert Uytterhoeven  * - 'C' For a clock, it prints the name (Common Clock Framework) or address
1487900cca29SGeert Uytterhoeven  *       (legacy clock framework) of the clock
1488900cca29SGeert Uytterhoeven  * - 'Cn' For a clock, it prints the name (Common Clock Framework) or address
1489900cca29SGeert Uytterhoeven  *        (legacy clock framework) of the clock
1490900cca29SGeert Uytterhoeven  * - 'Cr' For a clock, it prints the current rate of the clock
14915e4ee7b1SMartin Kletzander  *
14925e4ee7b1SMartin Kletzander  * ** Please update also Documentation/printk-formats.txt when making changes **
14939ac6e44eSJoe Perches  *
1494332d2e78SLinus Torvalds  * Note: The difference between 'S' and 'F' is that on ia64 and ppc64
1495332d2e78SLinus Torvalds  * function pointers are really function descriptors, which contain a
1496332d2e78SLinus Torvalds  * pointer to the real address.
14974d8a743cSLinus Torvalds  */
1498cf3b429bSJoe Perches static noinline_for_stack
1499cf3b429bSJoe Perches char *pointer(const char *fmt, char *buf, char *end, void *ptr,
1500fef20d9cSFrederic Weisbecker 	      struct printf_spec spec)
150178a8bf69SLinus Torvalds {
150280c9eb46SRasmus Villemoes 	const int default_width = 2 * sizeof(void *);
1503725fe002SGrant Likely 
15049f36e2c4SKees Cook 	if (!ptr && *fmt != 'K') {
15055e057981SJoe Perches 		/*
15065e057981SJoe Perches 		 * Print (null) with the same width as a pointer so it makes
15075e057981SJoe Perches 		 * tabular output look nice.
15085e057981SJoe Perches 		 */
15095e057981SJoe Perches 		if (spec.field_width == -1)
1510725fe002SGrant Likely 			spec.field_width = default_width;
1511fef20d9cSFrederic Weisbecker 		return string(buf, end, "(null)", spec);
15125e057981SJoe Perches 	}
1513d97106abSLinus Torvalds 
15140fe1ef24SLinus Torvalds 	switch (*fmt) {
15150fe1ef24SLinus Torvalds 	case 'F':
15160c8b946eSFrederic Weisbecker 	case 'f':
15170fe1ef24SLinus Torvalds 		ptr = dereference_function_descriptor(ptr);
15180fe1ef24SLinus Torvalds 		/* Fallthrough */
15190fe1ef24SLinus Torvalds 	case 'S':
15209ac6e44eSJoe Perches 	case 's':
15210f77a8d3SNamhyung Kim 	case 'B':
1522b0d33c2bSJoe Perches 		return symbol_string(buf, end, ptr, spec, fmt);
1523332d2e78SLinus Torvalds 	case 'R':
1524c7dabef8SBjorn Helgaas 	case 'r':
1525fd95541eSBjorn Helgaas 		return resource_string(buf, end, ptr, spec, fmt);
152631550a16SAndy Shevchenko 	case 'h':
152731550a16SAndy Shevchenko 		return hex_string(buf, end, ptr, spec, fmt);
1528dbc760bcSTejun Heo 	case 'b':
1529dbc760bcSTejun Heo 		switch (fmt[1]) {
1530dbc760bcSTejun Heo 		case 'l':
1531dbc760bcSTejun Heo 			return bitmap_list_string(buf, end, ptr, spec, fmt);
1532dbc760bcSTejun Heo 		default:
1533dbc760bcSTejun Heo 			return bitmap_string(buf, end, ptr, spec, fmt);
1534dbc760bcSTejun Heo 		}
15358a27f7c9SJoe Perches 	case 'M':			/* Colon separated: 00:01:02:03:04:05 */
15368a27f7c9SJoe Perches 	case 'm':			/* Contiguous: 000102030405 */
153776597ff9SAndrei Emeltchenko 					/* [mM]F (FDDI) */
153876597ff9SAndrei Emeltchenko 					/* [mM]R (Reverse order; Bluetooth) */
15398a27f7c9SJoe Perches 		return mac_address_string(buf, end, ptr, spec, fmt);
15408a27f7c9SJoe Perches 	case 'I':			/* Formatted IP supported
15418a27f7c9SJoe Perches 					 * 4:	1.2.3.4
15428a27f7c9SJoe Perches 					 * 6:	0001:0203:...:0708
15438a27f7c9SJoe Perches 					 * 6c:	1::708 or 1::1.2.3.4
15448a27f7c9SJoe Perches 					 */
15458a27f7c9SJoe Perches 	case 'i':			/* Contiguous:
15468a27f7c9SJoe Perches 					 * 4:	001.002.003.004
15478a27f7c9SJoe Perches 					 * 6:   000102...0f
15488a27f7c9SJoe Perches 					 */
15498a27f7c9SJoe Perches 		switch (fmt[1]) {
15508a27f7c9SJoe Perches 		case '6':
15518a27f7c9SJoe Perches 			return ip6_addr_string(buf, end, ptr, spec, fmt);
15528a27f7c9SJoe Perches 		case '4':
15538a27f7c9SJoe Perches 			return ip4_addr_string(buf, end, ptr, spec, fmt);
155410679643SDaniel Borkmann 		case 'S': {
155510679643SDaniel Borkmann 			const union {
155610679643SDaniel Borkmann 				struct sockaddr		raw;
155710679643SDaniel Borkmann 				struct sockaddr_in	v4;
155810679643SDaniel Borkmann 				struct sockaddr_in6	v6;
155910679643SDaniel Borkmann 			} *sa = ptr;
156010679643SDaniel Borkmann 
156110679643SDaniel Borkmann 			switch (sa->raw.sa_family) {
156210679643SDaniel Borkmann 			case AF_INET:
156310679643SDaniel Borkmann 				return ip4_addr_string_sa(buf, end, &sa->v4, spec, fmt);
156410679643SDaniel Borkmann 			case AF_INET6:
156510679643SDaniel Borkmann 				return ip6_addr_string_sa(buf, end, &sa->v6, spec, fmt);
156610679643SDaniel Borkmann 			default:
156710679643SDaniel Borkmann 				return string(buf, end, "(invalid address)", spec);
156810679643SDaniel Borkmann 			}}
15698a27f7c9SJoe Perches 		}
15704aa99606SHarvey Harrison 		break;
157171dca95dSAndy Shevchenko 	case 'E':
157271dca95dSAndy Shevchenko 		return escaped_string(buf, end, ptr, spec, fmt);
15739ac6e44eSJoe Perches 	case 'U':
15749ac6e44eSJoe Perches 		return uuid_string(buf, end, ptr, spec, fmt);
15757db6f5fbSJoe Perches 	case 'V':
15765756b76eSJan Beulich 		{
15775756b76eSJan Beulich 			va_list va;
15785756b76eSJan Beulich 
15795756b76eSJan Beulich 			va_copy(va, *((struct va_format *)ptr)->va);
15805756b76eSJan Beulich 			buf += vsnprintf(buf, end > buf ? end - buf : 0,
15815756b76eSJan Beulich 					 ((struct va_format *)ptr)->fmt, va);
15825756b76eSJan Beulich 			va_end(va);
15835756b76eSJan Beulich 			return buf;
15845756b76eSJan Beulich 		}
1585455cd5abSDan Rosenberg 	case 'K':
1586455cd5abSDan Rosenberg 		/*
1587455cd5abSDan Rosenberg 		 * %pK cannot be used in IRQ context because its test
1588455cd5abSDan Rosenberg 		 * for CAP_SYSLOG would be meaningless.
1589455cd5abSDan Rosenberg 		 */
15903715c530SDan Rosenberg 		if (kptr_restrict && (in_irq() || in_serving_softirq() ||
15913715c530SDan Rosenberg 				      in_nmi())) {
1592455cd5abSDan Rosenberg 			if (spec.field_width == -1)
1593725fe002SGrant Likely 				spec.field_width = default_width;
1594455cd5abSDan Rosenberg 			return string(buf, end, "pK-error", spec);
1595455cd5abSDan Rosenberg 		}
1596312b4e22SRyan Mallon 
1597312b4e22SRyan Mallon 		switch (kptr_restrict) {
1598312b4e22SRyan Mallon 		case 0:
1599312b4e22SRyan Mallon 			/* Always print %pK values */
1600312b4e22SRyan Mallon 			break;
1601312b4e22SRyan Mallon 		case 1: {
1602312b4e22SRyan Mallon 			/*
1603312b4e22SRyan Mallon 			 * Only print the real pointer value if the current
1604312b4e22SRyan Mallon 			 * process has CAP_SYSLOG and is running with the
1605312b4e22SRyan Mallon 			 * same credentials it started with. This is because
1606312b4e22SRyan Mallon 			 * access to files is checked at open() time, but %pK
1607312b4e22SRyan Mallon 			 * checks permission at read() time. We don't want to
1608312b4e22SRyan Mallon 			 * leak pointer values if a binary opens a file using
1609312b4e22SRyan Mallon 			 * %pK and then elevates privileges before reading it.
1610312b4e22SRyan Mallon 			 */
1611312b4e22SRyan Mallon 			const struct cred *cred = current_cred();
1612312b4e22SRyan Mallon 
1613312b4e22SRyan Mallon 			if (!has_capability_noaudit(current, CAP_SYSLOG) ||
1614312b4e22SRyan Mallon 			    !uid_eq(cred->euid, cred->uid) ||
1615312b4e22SRyan Mallon 			    !gid_eq(cred->egid, cred->gid))
161626297607SJoe Perches 				ptr = NULL;
161726297607SJoe Perches 			break;
1618312b4e22SRyan Mallon 		}
1619312b4e22SRyan Mallon 		case 2:
1620312b4e22SRyan Mallon 		default:
1621312b4e22SRyan Mallon 			/* Always print 0's for %pK */
1622312b4e22SRyan Mallon 			ptr = NULL;
1623312b4e22SRyan Mallon 			break;
1624312b4e22SRyan Mallon 		}
1625312b4e22SRyan Mallon 		break;
1626312b4e22SRyan Mallon 
1627c8f44affSMichał Mirosław 	case 'N':
1628c8f44affSMichał Mirosław 		switch (fmt[1]) {
1629c8f44affSMichał Mirosław 		case 'F':
1630c8f44affSMichał Mirosław 			return netdev_feature_string(buf, end, ptr, spec);
1631c8f44affSMichał Mirosław 		}
1632c8f44affSMichał Mirosław 		break;
16337d799210SStepan Moskovchenko 	case 'a':
1634aaf07621SJoe Perches 		return address_val(buf, end, ptr, spec, fmt);
16354b6ccca7SAl Viro 	case 'd':
16364b6ccca7SAl Viro 		return dentry_name(buf, end, ptr, spec, fmt);
1637900cca29SGeert Uytterhoeven 	case 'C':
1638900cca29SGeert Uytterhoeven 		return clock(buf, end, ptr, spec, fmt);
16394b6ccca7SAl Viro 	case 'D':
16404b6ccca7SAl Viro 		return dentry_name(buf, end,
16414b6ccca7SAl Viro 				   ((const struct file *)ptr)->f_path.dentry,
16424b6ccca7SAl Viro 				   spec, fmt);
16431031bc58SDmitry Monakhov #ifdef CONFIG_BLOCK
16441031bc58SDmitry Monakhov 	case 'g':
16451031bc58SDmitry Monakhov 		return bdev_name(buf, end, ptr, spec, fmt);
16461031bc58SDmitry Monakhov #endif
16471031bc58SDmitry Monakhov 
16480fe1ef24SLinus Torvalds 	}
1649fef20d9cSFrederic Weisbecker 	spec.flags |= SMALL;
1650fef20d9cSFrederic Weisbecker 	if (spec.field_width == -1) {
1651725fe002SGrant Likely 		spec.field_width = default_width;
1652fef20d9cSFrederic Weisbecker 		spec.flags |= ZEROPAD;
165378a8bf69SLinus Torvalds 	}
1654fef20d9cSFrederic Weisbecker 	spec.base = 16;
1655fef20d9cSFrederic Weisbecker 
1656fef20d9cSFrederic Weisbecker 	return number(buf, end, (unsigned long) ptr, spec);
1657fef20d9cSFrederic Weisbecker }
1658fef20d9cSFrederic Weisbecker 
1659fef20d9cSFrederic Weisbecker /*
1660fef20d9cSFrederic Weisbecker  * Helper function to decode printf style format.
1661fef20d9cSFrederic Weisbecker  * Each call decode a token from the format and return the
1662fef20d9cSFrederic Weisbecker  * number of characters read (or likely the delta where it wants
1663fef20d9cSFrederic Weisbecker  * to go on the next call).
1664fef20d9cSFrederic Weisbecker  * The decoded token is returned through the parameters
1665fef20d9cSFrederic Weisbecker  *
1666fef20d9cSFrederic Weisbecker  * 'h', 'l', or 'L' for integer fields
1667fef20d9cSFrederic Weisbecker  * 'z' support added 23/7/1999 S.H.
1668fef20d9cSFrederic Weisbecker  * 'z' changed to 'Z' --davidm 1/25/99
1669fef20d9cSFrederic Weisbecker  * 't' added for ptrdiff_t
1670fef20d9cSFrederic Weisbecker  *
1671fef20d9cSFrederic Weisbecker  * @fmt: the format string
1672fef20d9cSFrederic Weisbecker  * @type of the token returned
1673fef20d9cSFrederic Weisbecker  * @flags: various flags such as +, -, # tokens..
1674fef20d9cSFrederic Weisbecker  * @field_width: overwritten width
1675fef20d9cSFrederic Weisbecker  * @base: base of the number (octal, hex, ...)
1676fef20d9cSFrederic Weisbecker  * @precision: precision of a number
1677fef20d9cSFrederic Weisbecker  * @qualifier: qualifier of a number (long, size_t, ...)
1678fef20d9cSFrederic Weisbecker  */
1679cf3b429bSJoe Perches static noinline_for_stack
1680cf3b429bSJoe Perches int format_decode(const char *fmt, struct printf_spec *spec)
1681fef20d9cSFrederic Weisbecker {
1682fef20d9cSFrederic Weisbecker 	const char *start = fmt;
1683fef20d9cSFrederic Weisbecker 
1684fef20d9cSFrederic Weisbecker 	/* we finished early by reading the field width */
1685ed681a91SVegard Nossum 	if (spec->type == FORMAT_TYPE_WIDTH) {
1686fef20d9cSFrederic Weisbecker 		if (spec->field_width < 0) {
1687fef20d9cSFrederic Weisbecker 			spec->field_width = -spec->field_width;
1688fef20d9cSFrederic Weisbecker 			spec->flags |= LEFT;
1689fef20d9cSFrederic Weisbecker 		}
1690fef20d9cSFrederic Weisbecker 		spec->type = FORMAT_TYPE_NONE;
1691fef20d9cSFrederic Weisbecker 		goto precision;
1692fef20d9cSFrederic Weisbecker 	}
1693fef20d9cSFrederic Weisbecker 
1694fef20d9cSFrederic Weisbecker 	/* we finished early by reading the precision */
1695fef20d9cSFrederic Weisbecker 	if (spec->type == FORMAT_TYPE_PRECISION) {
1696fef20d9cSFrederic Weisbecker 		if (spec->precision < 0)
1697fef20d9cSFrederic Weisbecker 			spec->precision = 0;
1698fef20d9cSFrederic Weisbecker 
1699fef20d9cSFrederic Weisbecker 		spec->type = FORMAT_TYPE_NONE;
1700fef20d9cSFrederic Weisbecker 		goto qualifier;
1701fef20d9cSFrederic Weisbecker 	}
1702fef20d9cSFrederic Weisbecker 
1703fef20d9cSFrederic Weisbecker 	/* By default */
1704fef20d9cSFrederic Weisbecker 	spec->type = FORMAT_TYPE_NONE;
1705fef20d9cSFrederic Weisbecker 
1706fef20d9cSFrederic Weisbecker 	for (; *fmt ; ++fmt) {
1707fef20d9cSFrederic Weisbecker 		if (*fmt == '%')
1708fef20d9cSFrederic Weisbecker 			break;
1709fef20d9cSFrederic Weisbecker 	}
1710fef20d9cSFrederic Weisbecker 
1711fef20d9cSFrederic Weisbecker 	/* Return the current non-format string */
1712fef20d9cSFrederic Weisbecker 	if (fmt != start || !*fmt)
1713fef20d9cSFrederic Weisbecker 		return fmt - start;
1714fef20d9cSFrederic Weisbecker 
1715fef20d9cSFrederic Weisbecker 	/* Process flags */
1716fef20d9cSFrederic Weisbecker 	spec->flags = 0;
1717fef20d9cSFrederic Weisbecker 
1718fef20d9cSFrederic Weisbecker 	while (1) { /* this also skips first '%' */
1719fef20d9cSFrederic Weisbecker 		bool found = true;
1720fef20d9cSFrederic Weisbecker 
1721fef20d9cSFrederic Weisbecker 		++fmt;
1722fef20d9cSFrederic Weisbecker 
1723fef20d9cSFrederic Weisbecker 		switch (*fmt) {
1724fef20d9cSFrederic Weisbecker 		case '-': spec->flags |= LEFT;    break;
1725fef20d9cSFrederic Weisbecker 		case '+': spec->flags |= PLUS;    break;
1726fef20d9cSFrederic Weisbecker 		case ' ': spec->flags |= SPACE;   break;
1727fef20d9cSFrederic Weisbecker 		case '#': spec->flags |= SPECIAL; break;
1728fef20d9cSFrederic Weisbecker 		case '0': spec->flags |= ZEROPAD; break;
1729fef20d9cSFrederic Weisbecker 		default:  found = false;
1730fef20d9cSFrederic Weisbecker 		}
1731fef20d9cSFrederic Weisbecker 
1732fef20d9cSFrederic Weisbecker 		if (!found)
1733fef20d9cSFrederic Weisbecker 			break;
1734fef20d9cSFrederic Weisbecker 	}
1735fef20d9cSFrederic Weisbecker 
1736fef20d9cSFrederic Weisbecker 	/* get field width */
1737fef20d9cSFrederic Weisbecker 	spec->field_width = -1;
1738fef20d9cSFrederic Weisbecker 
1739fef20d9cSFrederic Weisbecker 	if (isdigit(*fmt))
1740fef20d9cSFrederic Weisbecker 		spec->field_width = skip_atoi(&fmt);
1741fef20d9cSFrederic Weisbecker 	else if (*fmt == '*') {
1742fef20d9cSFrederic Weisbecker 		/* it's the next argument */
1743ed681a91SVegard Nossum 		spec->type = FORMAT_TYPE_WIDTH;
1744fef20d9cSFrederic Weisbecker 		return ++fmt - start;
1745fef20d9cSFrederic Weisbecker 	}
1746fef20d9cSFrederic Weisbecker 
1747fef20d9cSFrederic Weisbecker precision:
1748fef20d9cSFrederic Weisbecker 	/* get the precision */
1749fef20d9cSFrederic Weisbecker 	spec->precision = -1;
1750fef20d9cSFrederic Weisbecker 	if (*fmt == '.') {
1751fef20d9cSFrederic Weisbecker 		++fmt;
1752fef20d9cSFrederic Weisbecker 		if (isdigit(*fmt)) {
1753fef20d9cSFrederic Weisbecker 			spec->precision = skip_atoi(&fmt);
1754fef20d9cSFrederic Weisbecker 			if (spec->precision < 0)
1755fef20d9cSFrederic Weisbecker 				spec->precision = 0;
1756fef20d9cSFrederic Weisbecker 		} else if (*fmt == '*') {
1757fef20d9cSFrederic Weisbecker 			/* it's the next argument */
1758adf26f84SVegard Nossum 			spec->type = FORMAT_TYPE_PRECISION;
1759fef20d9cSFrederic Weisbecker 			return ++fmt - start;
1760fef20d9cSFrederic Weisbecker 		}
1761fef20d9cSFrederic Weisbecker 	}
1762fef20d9cSFrederic Weisbecker 
1763fef20d9cSFrederic Weisbecker qualifier:
1764fef20d9cSFrederic Weisbecker 	/* get the conversion qualifier */
1765fef20d9cSFrederic Weisbecker 	spec->qualifier = -1;
176675fb8f26SAndy Shevchenko 	if (*fmt == 'h' || _tolower(*fmt) == 'l' ||
176775fb8f26SAndy Shevchenko 	    _tolower(*fmt) == 'z' || *fmt == 't') {
1768a4e94ef0SZhaolei 		spec->qualifier = *fmt++;
1769a4e94ef0SZhaolei 		if (unlikely(spec->qualifier == *fmt)) {
1770a4e94ef0SZhaolei 			if (spec->qualifier == 'l') {
1771fef20d9cSFrederic Weisbecker 				spec->qualifier = 'L';
1772fef20d9cSFrederic Weisbecker 				++fmt;
1773a4e94ef0SZhaolei 			} else if (spec->qualifier == 'h') {
1774a4e94ef0SZhaolei 				spec->qualifier = 'H';
1775a4e94ef0SZhaolei 				++fmt;
1776a4e94ef0SZhaolei 			}
1777fef20d9cSFrederic Weisbecker 		}
1778fef20d9cSFrederic Weisbecker 	}
1779fef20d9cSFrederic Weisbecker 
1780fef20d9cSFrederic Weisbecker 	/* default base */
1781fef20d9cSFrederic Weisbecker 	spec->base = 10;
1782fef20d9cSFrederic Weisbecker 	switch (*fmt) {
1783fef20d9cSFrederic Weisbecker 	case 'c':
1784fef20d9cSFrederic Weisbecker 		spec->type = FORMAT_TYPE_CHAR;
1785fef20d9cSFrederic Weisbecker 		return ++fmt - start;
1786fef20d9cSFrederic Weisbecker 
1787fef20d9cSFrederic Weisbecker 	case 's':
1788fef20d9cSFrederic Weisbecker 		spec->type = FORMAT_TYPE_STR;
1789fef20d9cSFrederic Weisbecker 		return ++fmt - start;
1790fef20d9cSFrederic Weisbecker 
1791fef20d9cSFrederic Weisbecker 	case 'p':
1792fef20d9cSFrederic Weisbecker 		spec->type = FORMAT_TYPE_PTR;
1793ffbfed03SRasmus Villemoes 		return ++fmt - start;
1794fef20d9cSFrederic Weisbecker 
1795fef20d9cSFrederic Weisbecker 	case '%':
1796fef20d9cSFrederic Weisbecker 		spec->type = FORMAT_TYPE_PERCENT_CHAR;
1797fef20d9cSFrederic Weisbecker 		return ++fmt - start;
1798fef20d9cSFrederic Weisbecker 
1799fef20d9cSFrederic Weisbecker 	/* integer number formats - set up the flags and "break" */
1800fef20d9cSFrederic Weisbecker 	case 'o':
1801fef20d9cSFrederic Weisbecker 		spec->base = 8;
1802fef20d9cSFrederic Weisbecker 		break;
1803fef20d9cSFrederic Weisbecker 
1804fef20d9cSFrederic Weisbecker 	case 'x':
1805fef20d9cSFrederic Weisbecker 		spec->flags |= SMALL;
1806fef20d9cSFrederic Weisbecker 
1807fef20d9cSFrederic Weisbecker 	case 'X':
1808fef20d9cSFrederic Weisbecker 		spec->base = 16;
1809fef20d9cSFrederic Weisbecker 		break;
1810fef20d9cSFrederic Weisbecker 
1811fef20d9cSFrederic Weisbecker 	case 'd':
1812fef20d9cSFrederic Weisbecker 	case 'i':
181339e874f8SFrederic Weisbecker 		spec->flags |= SIGN;
1814fef20d9cSFrederic Weisbecker 	case 'u':
1815fef20d9cSFrederic Weisbecker 		break;
1816fef20d9cSFrederic Weisbecker 
1817708d96fdSRyan Mallon 	case 'n':
1818708d96fdSRyan Mallon 		/*
1819b006f19bSRasmus Villemoes 		 * Since %n poses a greater security risk than
1820b006f19bSRasmus Villemoes 		 * utility, treat it as any other invalid or
1821b006f19bSRasmus Villemoes 		 * unsupported format specifier.
1822708d96fdSRyan Mallon 		 */
1823708d96fdSRyan Mallon 		/* Fall-through */
1824708d96fdSRyan Mallon 
1825fef20d9cSFrederic Weisbecker 	default:
1826b006f19bSRasmus Villemoes 		WARN_ONCE(1, "Please remove unsupported %%%c in format string\n", *fmt);
1827fef20d9cSFrederic Weisbecker 		spec->type = FORMAT_TYPE_INVALID;
1828fef20d9cSFrederic Weisbecker 		return fmt - start;
1829fef20d9cSFrederic Weisbecker 	}
1830fef20d9cSFrederic Weisbecker 
1831fef20d9cSFrederic Weisbecker 	if (spec->qualifier == 'L')
1832fef20d9cSFrederic Weisbecker 		spec->type = FORMAT_TYPE_LONG_LONG;
1833fef20d9cSFrederic Weisbecker 	else if (spec->qualifier == 'l') {
183451be17dfSRasmus Villemoes 		BUILD_BUG_ON(FORMAT_TYPE_ULONG + SIGN != FORMAT_TYPE_LONG);
183551be17dfSRasmus Villemoes 		spec->type = FORMAT_TYPE_ULONG + (spec->flags & SIGN);
183675fb8f26SAndy Shevchenko 	} else if (_tolower(spec->qualifier) == 'z') {
1837fef20d9cSFrederic Weisbecker 		spec->type = FORMAT_TYPE_SIZE_T;
1838fef20d9cSFrederic Weisbecker 	} else if (spec->qualifier == 't') {
1839fef20d9cSFrederic Weisbecker 		spec->type = FORMAT_TYPE_PTRDIFF;
1840a4e94ef0SZhaolei 	} else if (spec->qualifier == 'H') {
184151be17dfSRasmus Villemoes 		BUILD_BUG_ON(FORMAT_TYPE_UBYTE + SIGN != FORMAT_TYPE_BYTE);
184251be17dfSRasmus Villemoes 		spec->type = FORMAT_TYPE_UBYTE + (spec->flags & SIGN);
1843fef20d9cSFrederic Weisbecker 	} else if (spec->qualifier == 'h') {
184451be17dfSRasmus Villemoes 		BUILD_BUG_ON(FORMAT_TYPE_USHORT + SIGN != FORMAT_TYPE_SHORT);
184551be17dfSRasmus Villemoes 		spec->type = FORMAT_TYPE_USHORT + (spec->flags & SIGN);
1846fef20d9cSFrederic Weisbecker 	} else {
184751be17dfSRasmus Villemoes 		BUILD_BUG_ON(FORMAT_TYPE_UINT + SIGN != FORMAT_TYPE_INT);
184851be17dfSRasmus Villemoes 		spec->type = FORMAT_TYPE_UINT + (spec->flags & SIGN);
1849fef20d9cSFrederic Weisbecker 	}
1850fef20d9cSFrederic Weisbecker 
1851fef20d9cSFrederic Weisbecker 	return ++fmt - start;
185278a8bf69SLinus Torvalds }
185378a8bf69SLinus Torvalds 
18541da177e4SLinus Torvalds /**
18551da177e4SLinus Torvalds  * vsnprintf - Format a string and place it in a buffer
18561da177e4SLinus Torvalds  * @buf: The buffer to place the result into
18571da177e4SLinus Torvalds  * @size: The size of the buffer, including the trailing null space
18581da177e4SLinus Torvalds  * @fmt: The format string to use
18591da177e4SLinus Torvalds  * @args: Arguments for the format string
18601da177e4SLinus Torvalds  *
1861d7ec9a05SRasmus Villemoes  * This function generally follows C99 vsnprintf, but has some
1862d7ec9a05SRasmus Villemoes  * extensions and a few limitations:
1863d7ec9a05SRasmus Villemoes  *
1864d7ec9a05SRasmus Villemoes  * %n is unsupported
18655e4ee7b1SMartin Kletzander  * %p* is handled by pointer()
186620036fdcSAndi Kleen  *
18675e4ee7b1SMartin Kletzander  * See pointer() or Documentation/printk-formats.txt for more
18685e4ee7b1SMartin Kletzander  * extensive description.
18695e4ee7b1SMartin Kletzander  *
18705e4ee7b1SMartin Kletzander  * ** Please update the documentation in both places when making changes **
187180f548e0SAndrew Morton  *
18721da177e4SLinus Torvalds  * The return value is the number of characters which would
18731da177e4SLinus Torvalds  * be generated for the given input, excluding the trailing
18741da177e4SLinus Torvalds  * '\0', as per ISO C99. If you want to have the exact
18751da177e4SLinus Torvalds  * number of characters written into @buf as return value
187672fd4a35SRobert P. J. Day  * (not including the trailing '\0'), use vscnprintf(). If the
18771da177e4SLinus Torvalds  * return is greater than or equal to @size, the resulting
18781da177e4SLinus Torvalds  * string is truncated.
18791da177e4SLinus Torvalds  *
1880ba1835ebSUwe Kleine-König  * If you're not already dealing with a va_list consider using snprintf().
18811da177e4SLinus Torvalds  */
18821da177e4SLinus Torvalds int vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
18831da177e4SLinus Torvalds {
18841da177e4SLinus Torvalds 	unsigned long long num;
1885d4be151bSAndré Goddard Rosa 	char *str, *end;
1886fef20d9cSFrederic Weisbecker 	struct printf_spec spec = {0};
18871da177e4SLinus Torvalds 
1888f796937aSJeremy Fitzhardinge 	/* Reject out-of-range values early.  Large positive sizes are
1889f796937aSJeremy Fitzhardinge 	   used for unknown buffer sizes. */
18902aa2f9e2SRasmus Villemoes 	if (WARN_ON_ONCE(size > INT_MAX))
18911da177e4SLinus Torvalds 		return 0;
18921da177e4SLinus Torvalds 
18931da177e4SLinus Torvalds 	str = buf;
1894f796937aSJeremy Fitzhardinge 	end = buf + size;
18951da177e4SLinus Torvalds 
1896f796937aSJeremy Fitzhardinge 	/* Make sure end is always >= buf */
1897f796937aSJeremy Fitzhardinge 	if (end < buf) {
18981da177e4SLinus Torvalds 		end = ((void *)-1);
1899f796937aSJeremy Fitzhardinge 		size = end - buf;
19001da177e4SLinus Torvalds 	}
19011da177e4SLinus Torvalds 
1902fef20d9cSFrederic Weisbecker 	while (*fmt) {
1903fef20d9cSFrederic Weisbecker 		const char *old_fmt = fmt;
1904d4be151bSAndré Goddard Rosa 		int read = format_decode(fmt, &spec);
1905fef20d9cSFrederic Weisbecker 
1906fef20d9cSFrederic Weisbecker 		fmt += read;
1907fef20d9cSFrederic Weisbecker 
1908fef20d9cSFrederic Weisbecker 		switch (spec.type) {
1909fef20d9cSFrederic Weisbecker 		case FORMAT_TYPE_NONE: {
1910fef20d9cSFrederic Weisbecker 			int copy = read;
1911fef20d9cSFrederic Weisbecker 			if (str < end) {
1912fef20d9cSFrederic Weisbecker 				if (copy > end - str)
1913fef20d9cSFrederic Weisbecker 					copy = end - str;
1914fef20d9cSFrederic Weisbecker 				memcpy(str, old_fmt, copy);
1915fef20d9cSFrederic Weisbecker 			}
1916fef20d9cSFrederic Weisbecker 			str += read;
1917fef20d9cSFrederic Weisbecker 			break;
19181da177e4SLinus Torvalds 		}
19191da177e4SLinus Torvalds 
1920ed681a91SVegard Nossum 		case FORMAT_TYPE_WIDTH:
1921fef20d9cSFrederic Weisbecker 			spec.field_width = va_arg(args, int);
1922fef20d9cSFrederic Weisbecker 			break;
19231da177e4SLinus Torvalds 
1924fef20d9cSFrederic Weisbecker 		case FORMAT_TYPE_PRECISION:
1925fef20d9cSFrederic Weisbecker 			spec.precision = va_arg(args, int);
1926fef20d9cSFrederic Weisbecker 			break;
19271da177e4SLinus Torvalds 
1928d4be151bSAndré Goddard Rosa 		case FORMAT_TYPE_CHAR: {
1929d4be151bSAndré Goddard Rosa 			char c;
1930d4be151bSAndré Goddard Rosa 
1931fef20d9cSFrederic Weisbecker 			if (!(spec.flags & LEFT)) {
1932fef20d9cSFrederic Weisbecker 				while (--spec.field_width > 0) {
1933f796937aSJeremy Fitzhardinge 					if (str < end)
19341da177e4SLinus Torvalds 						*str = ' ';
19351da177e4SLinus Torvalds 					++str;
1936fef20d9cSFrederic Weisbecker 
19371da177e4SLinus Torvalds 				}
19381da177e4SLinus Torvalds 			}
19391da177e4SLinus Torvalds 			c = (unsigned char) va_arg(args, int);
1940f796937aSJeremy Fitzhardinge 			if (str < end)
19411da177e4SLinus Torvalds 				*str = c;
19421da177e4SLinus Torvalds 			++str;
1943fef20d9cSFrederic Weisbecker 			while (--spec.field_width > 0) {
1944f796937aSJeremy Fitzhardinge 				if (str < end)
19451da177e4SLinus Torvalds 					*str = ' ';
19461da177e4SLinus Torvalds 				++str;
19471da177e4SLinus Torvalds 			}
1948fef20d9cSFrederic Weisbecker 			break;
1949d4be151bSAndré Goddard Rosa 		}
19501da177e4SLinus Torvalds 
1951fef20d9cSFrederic Weisbecker 		case FORMAT_TYPE_STR:
1952fef20d9cSFrederic Weisbecker 			str = string(str, end, va_arg(args, char *), spec);
1953fef20d9cSFrederic Weisbecker 			break;
19541da177e4SLinus Torvalds 
1955fef20d9cSFrederic Weisbecker 		case FORMAT_TYPE_PTR:
1956ffbfed03SRasmus Villemoes 			str = pointer(fmt, str, end, va_arg(args, void *),
1957fef20d9cSFrederic Weisbecker 				      spec);
1958fef20d9cSFrederic Weisbecker 			while (isalnum(*fmt))
19594d8a743cSLinus Torvalds 				fmt++;
1960fef20d9cSFrederic Weisbecker 			break;
19611da177e4SLinus Torvalds 
1962fef20d9cSFrederic Weisbecker 		case FORMAT_TYPE_PERCENT_CHAR:
1963f796937aSJeremy Fitzhardinge 			if (str < end)
19641da177e4SLinus Torvalds 				*str = '%';
19651da177e4SLinus Torvalds 			++str;
19661da177e4SLinus Torvalds 			break;
19671da177e4SLinus Torvalds 
1968fef20d9cSFrederic Weisbecker 		case FORMAT_TYPE_INVALID:
1969b006f19bSRasmus Villemoes 			/*
1970b006f19bSRasmus Villemoes 			 * Presumably the arguments passed gcc's type
1971b006f19bSRasmus Villemoes 			 * checking, but there is no safe or sane way
1972b006f19bSRasmus Villemoes 			 * for us to continue parsing the format and
1973b006f19bSRasmus Villemoes 			 * fetching from the va_list; the remaining
1974b006f19bSRasmus Villemoes 			 * specifiers and arguments would be out of
1975b006f19bSRasmus Villemoes 			 * sync.
1976b006f19bSRasmus Villemoes 			 */
1977b006f19bSRasmus Villemoes 			goto out;
1978fef20d9cSFrederic Weisbecker 
1979fef20d9cSFrederic Weisbecker 		default:
1980fef20d9cSFrederic Weisbecker 			switch (spec.type) {
1981fef20d9cSFrederic Weisbecker 			case FORMAT_TYPE_LONG_LONG:
1982fef20d9cSFrederic Weisbecker 				num = va_arg(args, long long);
1983fef20d9cSFrederic Weisbecker 				break;
1984fef20d9cSFrederic Weisbecker 			case FORMAT_TYPE_ULONG:
1985fef20d9cSFrederic Weisbecker 				num = va_arg(args, unsigned long);
1986fef20d9cSFrederic Weisbecker 				break;
1987fef20d9cSFrederic Weisbecker 			case FORMAT_TYPE_LONG:
1988fef20d9cSFrederic Weisbecker 				num = va_arg(args, long);
1989fef20d9cSFrederic Weisbecker 				break;
1990fef20d9cSFrederic Weisbecker 			case FORMAT_TYPE_SIZE_T:
1991ef124960SJason Gunthorpe 				if (spec.flags & SIGN)
1992ef124960SJason Gunthorpe 					num = va_arg(args, ssize_t);
1993ef124960SJason Gunthorpe 				else
1994fef20d9cSFrederic Weisbecker 					num = va_arg(args, size_t);
1995fef20d9cSFrederic Weisbecker 				break;
1996fef20d9cSFrederic Weisbecker 			case FORMAT_TYPE_PTRDIFF:
1997fef20d9cSFrederic Weisbecker 				num = va_arg(args, ptrdiff_t);
1998fef20d9cSFrederic Weisbecker 				break;
1999a4e94ef0SZhaolei 			case FORMAT_TYPE_UBYTE:
2000a4e94ef0SZhaolei 				num = (unsigned char) va_arg(args, int);
2001a4e94ef0SZhaolei 				break;
2002a4e94ef0SZhaolei 			case FORMAT_TYPE_BYTE:
2003a4e94ef0SZhaolei 				num = (signed char) va_arg(args, int);
2004a4e94ef0SZhaolei 				break;
2005fef20d9cSFrederic Weisbecker 			case FORMAT_TYPE_USHORT:
2006fef20d9cSFrederic Weisbecker 				num = (unsigned short) va_arg(args, int);
2007fef20d9cSFrederic Weisbecker 				break;
2008fef20d9cSFrederic Weisbecker 			case FORMAT_TYPE_SHORT:
2009fef20d9cSFrederic Weisbecker 				num = (short) va_arg(args, int);
2010fef20d9cSFrederic Weisbecker 				break;
201139e874f8SFrederic Weisbecker 			case FORMAT_TYPE_INT:
201239e874f8SFrederic Weisbecker 				num = (int) va_arg(args, int);
2013fef20d9cSFrederic Weisbecker 				break;
2014fef20d9cSFrederic Weisbecker 			default:
2015fef20d9cSFrederic Weisbecker 				num = va_arg(args, unsigned int);
20161da177e4SLinus Torvalds 			}
2017fef20d9cSFrederic Weisbecker 
2018fef20d9cSFrederic Weisbecker 			str = number(str, end, num, spec);
20191da177e4SLinus Torvalds 		}
2020fef20d9cSFrederic Weisbecker 	}
2021fef20d9cSFrederic Weisbecker 
2022b006f19bSRasmus Villemoes out:
2023f796937aSJeremy Fitzhardinge 	if (size > 0) {
2024f796937aSJeremy Fitzhardinge 		if (str < end)
20251da177e4SLinus Torvalds 			*str = '\0';
2026f796937aSJeremy Fitzhardinge 		else
20270a6047eeSLinus Torvalds 			end[-1] = '\0';
2028f796937aSJeremy Fitzhardinge 	}
2029fef20d9cSFrederic Weisbecker 
2030f796937aSJeremy Fitzhardinge 	/* the trailing null byte doesn't count towards the total */
20311da177e4SLinus Torvalds 	return str-buf;
2032fef20d9cSFrederic Weisbecker 
20331da177e4SLinus Torvalds }
20341da177e4SLinus Torvalds EXPORT_SYMBOL(vsnprintf);
20351da177e4SLinus Torvalds 
20361da177e4SLinus Torvalds /**
20371da177e4SLinus Torvalds  * vscnprintf - Format a string and place it in a buffer
20381da177e4SLinus Torvalds  * @buf: The buffer to place the result into
20391da177e4SLinus Torvalds  * @size: The size of the buffer, including the trailing null space
20401da177e4SLinus Torvalds  * @fmt: The format string to use
20411da177e4SLinus Torvalds  * @args: Arguments for the format string
20421da177e4SLinus Torvalds  *
20431da177e4SLinus Torvalds  * The return value is the number of characters which have been written into
2044b921c69fSAnton Arapov  * the @buf not including the trailing '\0'. If @size is == 0 the function
20451da177e4SLinus Torvalds  * returns 0.
20461da177e4SLinus Torvalds  *
2047ba1835ebSUwe Kleine-König  * If you're not already dealing with a va_list consider using scnprintf().
204820036fdcSAndi Kleen  *
204920036fdcSAndi Kleen  * See the vsnprintf() documentation for format string extensions over C99.
20501da177e4SLinus Torvalds  */
20511da177e4SLinus Torvalds int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
20521da177e4SLinus Torvalds {
20531da177e4SLinus Torvalds 	int i;
20541da177e4SLinus Torvalds 
20551da177e4SLinus Torvalds 	i = vsnprintf(buf, size, fmt, args);
20567b9186f5SAndré Goddard Rosa 
2057b921c69fSAnton Arapov 	if (likely(i < size))
2058b921c69fSAnton Arapov 		return i;
2059b921c69fSAnton Arapov 	if (size != 0)
2060b921c69fSAnton Arapov 		return size - 1;
2061b921c69fSAnton Arapov 	return 0;
20621da177e4SLinus Torvalds }
20631da177e4SLinus Torvalds EXPORT_SYMBOL(vscnprintf);
20641da177e4SLinus Torvalds 
20651da177e4SLinus Torvalds /**
20661da177e4SLinus Torvalds  * snprintf - Format a string and place it in a buffer
20671da177e4SLinus Torvalds  * @buf: The buffer to place the result into
20681da177e4SLinus Torvalds  * @size: The size of the buffer, including the trailing null space
20691da177e4SLinus Torvalds  * @fmt: The format string to use
20701da177e4SLinus Torvalds  * @...: Arguments for the format string
20711da177e4SLinus Torvalds  *
20721da177e4SLinus Torvalds  * The return value is the number of characters which would be
20731da177e4SLinus Torvalds  * generated for the given input, excluding the trailing null,
20741da177e4SLinus Torvalds  * as per ISO C99.  If the return is greater than or equal to
20751da177e4SLinus Torvalds  * @size, the resulting string is truncated.
207620036fdcSAndi Kleen  *
207720036fdcSAndi Kleen  * See the vsnprintf() documentation for format string extensions over C99.
20781da177e4SLinus Torvalds  */
20791da177e4SLinus Torvalds int snprintf(char *buf, size_t size, const char *fmt, ...)
20801da177e4SLinus Torvalds {
20811da177e4SLinus Torvalds 	va_list args;
20821da177e4SLinus Torvalds 	int i;
20831da177e4SLinus Torvalds 
20841da177e4SLinus Torvalds 	va_start(args, fmt);
20851da177e4SLinus Torvalds 	i = vsnprintf(buf, size, fmt, args);
20861da177e4SLinus Torvalds 	va_end(args);
20877b9186f5SAndré Goddard Rosa 
20881da177e4SLinus Torvalds 	return i;
20891da177e4SLinus Torvalds }
20901da177e4SLinus Torvalds EXPORT_SYMBOL(snprintf);
20911da177e4SLinus Torvalds 
20921da177e4SLinus Torvalds /**
20931da177e4SLinus Torvalds  * scnprintf - Format a string and place it in a buffer
20941da177e4SLinus Torvalds  * @buf: The buffer to place the result into
20951da177e4SLinus Torvalds  * @size: The size of the buffer, including the trailing null space
20961da177e4SLinus Torvalds  * @fmt: The format string to use
20971da177e4SLinus Torvalds  * @...: Arguments for the format string
20981da177e4SLinus Torvalds  *
20991da177e4SLinus Torvalds  * The return value is the number of characters written into @buf not including
2100b903c0b8SChangli Gao  * the trailing '\0'. If @size is == 0 the function returns 0.
21011da177e4SLinus Torvalds  */
21021da177e4SLinus Torvalds 
21031da177e4SLinus Torvalds int scnprintf(char *buf, size_t size, const char *fmt, ...)
21041da177e4SLinus Torvalds {
21051da177e4SLinus Torvalds 	va_list args;
21061da177e4SLinus Torvalds 	int i;
21071da177e4SLinus Torvalds 
21081da177e4SLinus Torvalds 	va_start(args, fmt);
2109b921c69fSAnton Arapov 	i = vscnprintf(buf, size, fmt, args);
21101da177e4SLinus Torvalds 	va_end(args);
21117b9186f5SAndré Goddard Rosa 
2112b903c0b8SChangli Gao 	return i;
21131da177e4SLinus Torvalds }
21141da177e4SLinus Torvalds EXPORT_SYMBOL(scnprintf);
21151da177e4SLinus Torvalds 
21161da177e4SLinus Torvalds /**
21171da177e4SLinus Torvalds  * vsprintf - Format a string and place it in a buffer
21181da177e4SLinus Torvalds  * @buf: The buffer to place the result into
21191da177e4SLinus Torvalds  * @fmt: The format string to use
21201da177e4SLinus Torvalds  * @args: Arguments for the format string
21211da177e4SLinus Torvalds  *
21221da177e4SLinus Torvalds  * The function returns the number of characters written
212372fd4a35SRobert P. J. Day  * into @buf. Use vsnprintf() or vscnprintf() in order to avoid
21241da177e4SLinus Torvalds  * buffer overflows.
21251da177e4SLinus Torvalds  *
2126ba1835ebSUwe Kleine-König  * If you're not already dealing with a va_list consider using sprintf().
212720036fdcSAndi Kleen  *
212820036fdcSAndi Kleen  * See the vsnprintf() documentation for format string extensions over C99.
21291da177e4SLinus Torvalds  */
21301da177e4SLinus Torvalds int vsprintf(char *buf, const char *fmt, va_list args)
21311da177e4SLinus Torvalds {
21321da177e4SLinus Torvalds 	return vsnprintf(buf, INT_MAX, fmt, args);
21331da177e4SLinus Torvalds }
21341da177e4SLinus Torvalds EXPORT_SYMBOL(vsprintf);
21351da177e4SLinus Torvalds 
21361da177e4SLinus Torvalds /**
21371da177e4SLinus Torvalds  * sprintf - Format a string and place it in a buffer
21381da177e4SLinus Torvalds  * @buf: The buffer to place the result into
21391da177e4SLinus Torvalds  * @fmt: The format string to use
21401da177e4SLinus Torvalds  * @...: Arguments for the format string
21411da177e4SLinus Torvalds  *
21421da177e4SLinus Torvalds  * The function returns the number of characters written
214372fd4a35SRobert P. J. Day  * into @buf. Use snprintf() or scnprintf() in order to avoid
21441da177e4SLinus Torvalds  * buffer overflows.
214520036fdcSAndi Kleen  *
214620036fdcSAndi Kleen  * See the vsnprintf() documentation for format string extensions over C99.
21471da177e4SLinus Torvalds  */
21481da177e4SLinus Torvalds int sprintf(char *buf, const char *fmt, ...)
21491da177e4SLinus Torvalds {
21501da177e4SLinus Torvalds 	va_list args;
21511da177e4SLinus Torvalds 	int i;
21521da177e4SLinus Torvalds 
21531da177e4SLinus Torvalds 	va_start(args, fmt);
21541da177e4SLinus Torvalds 	i = vsnprintf(buf, INT_MAX, fmt, args);
21551da177e4SLinus Torvalds 	va_end(args);
21567b9186f5SAndré Goddard Rosa 
21571da177e4SLinus Torvalds 	return i;
21581da177e4SLinus Torvalds }
21591da177e4SLinus Torvalds EXPORT_SYMBOL(sprintf);
21601da177e4SLinus Torvalds 
21614370aa4aSLai Jiangshan #ifdef CONFIG_BINARY_PRINTF
21624370aa4aSLai Jiangshan /*
21634370aa4aSLai Jiangshan  * bprintf service:
21644370aa4aSLai Jiangshan  * vbin_printf() - VA arguments to binary data
21654370aa4aSLai Jiangshan  * bstr_printf() - Binary data to text string
21664370aa4aSLai Jiangshan  */
21674370aa4aSLai Jiangshan 
21684370aa4aSLai Jiangshan /**
21694370aa4aSLai Jiangshan  * vbin_printf - Parse a format string and place args' binary value in a buffer
21704370aa4aSLai Jiangshan  * @bin_buf: The buffer to place args' binary value
21714370aa4aSLai Jiangshan  * @size: The size of the buffer(by words(32bits), not characters)
21724370aa4aSLai Jiangshan  * @fmt: The format string to use
21734370aa4aSLai Jiangshan  * @args: Arguments for the format string
21744370aa4aSLai Jiangshan  *
21754370aa4aSLai Jiangshan  * The format follows C99 vsnprintf, except %n is ignored, and its argument
2176da3dae54SMasanari Iida  * is skipped.
21774370aa4aSLai Jiangshan  *
21784370aa4aSLai Jiangshan  * The return value is the number of words(32bits) which would be generated for
21794370aa4aSLai Jiangshan  * the given input.
21804370aa4aSLai Jiangshan  *
21814370aa4aSLai Jiangshan  * NOTE:
21824370aa4aSLai Jiangshan  * If the return value is greater than @size, the resulting bin_buf is NOT
21834370aa4aSLai Jiangshan  * valid for bstr_printf().
21844370aa4aSLai Jiangshan  */
21854370aa4aSLai Jiangshan int vbin_printf(u32 *bin_buf, size_t size, const char *fmt, va_list args)
21864370aa4aSLai Jiangshan {
2187fef20d9cSFrederic Weisbecker 	struct printf_spec spec = {0};
21884370aa4aSLai Jiangshan 	char *str, *end;
21894370aa4aSLai Jiangshan 
21904370aa4aSLai Jiangshan 	str = (char *)bin_buf;
21914370aa4aSLai Jiangshan 	end = (char *)(bin_buf + size);
21924370aa4aSLai Jiangshan 
21934370aa4aSLai Jiangshan #define save_arg(type)							\
21944370aa4aSLai Jiangshan do {									\
21954370aa4aSLai Jiangshan 	if (sizeof(type) == 8) {					\
21964370aa4aSLai Jiangshan 		unsigned long long value;				\
21974370aa4aSLai Jiangshan 		str = PTR_ALIGN(str, sizeof(u32));			\
21984370aa4aSLai Jiangshan 		value = va_arg(args, unsigned long long);		\
21994370aa4aSLai Jiangshan 		if (str + sizeof(type) <= end) {			\
22004370aa4aSLai Jiangshan 			*(u32 *)str = *(u32 *)&value;			\
22014370aa4aSLai Jiangshan 			*(u32 *)(str + 4) = *((u32 *)&value + 1);	\
22024370aa4aSLai Jiangshan 		}							\
22034370aa4aSLai Jiangshan 	} else {							\
22044370aa4aSLai Jiangshan 		unsigned long value;					\
22054370aa4aSLai Jiangshan 		str = PTR_ALIGN(str, sizeof(type));			\
22064370aa4aSLai Jiangshan 		value = va_arg(args, int);				\
22074370aa4aSLai Jiangshan 		if (str + sizeof(type) <= end)				\
22084370aa4aSLai Jiangshan 			*(typeof(type) *)str = (type)value;		\
22094370aa4aSLai Jiangshan 	}								\
22104370aa4aSLai Jiangshan 	str += sizeof(type);						\
22114370aa4aSLai Jiangshan } while (0)
22124370aa4aSLai Jiangshan 
2213fef20d9cSFrederic Weisbecker 	while (*fmt) {
2214d4be151bSAndré Goddard Rosa 		int read = format_decode(fmt, &spec);
22154370aa4aSLai Jiangshan 
2216fef20d9cSFrederic Weisbecker 		fmt += read;
2217fef20d9cSFrederic Weisbecker 
2218fef20d9cSFrederic Weisbecker 		switch (spec.type) {
2219fef20d9cSFrederic Weisbecker 		case FORMAT_TYPE_NONE:
2220d4be151bSAndré Goddard Rosa 		case FORMAT_TYPE_PERCENT_CHAR:
2221fef20d9cSFrederic Weisbecker 			break;
2222b006f19bSRasmus Villemoes 		case FORMAT_TYPE_INVALID:
2223b006f19bSRasmus Villemoes 			goto out;
2224fef20d9cSFrederic Weisbecker 
2225ed681a91SVegard Nossum 		case FORMAT_TYPE_WIDTH:
2226fef20d9cSFrederic Weisbecker 		case FORMAT_TYPE_PRECISION:
22274370aa4aSLai Jiangshan 			save_arg(int);
2228fef20d9cSFrederic Weisbecker 			break;
22294370aa4aSLai Jiangshan 
2230fef20d9cSFrederic Weisbecker 		case FORMAT_TYPE_CHAR:
22314370aa4aSLai Jiangshan 			save_arg(char);
2232fef20d9cSFrederic Weisbecker 			break;
2233fef20d9cSFrederic Weisbecker 
2234fef20d9cSFrederic Weisbecker 		case FORMAT_TYPE_STR: {
22354370aa4aSLai Jiangshan 			const char *save_str = va_arg(args, char *);
22364370aa4aSLai Jiangshan 			size_t len;
22376c356634SAndré Goddard Rosa 
22384370aa4aSLai Jiangshan 			if ((unsigned long)save_str > (unsigned long)-PAGE_SIZE
22394370aa4aSLai Jiangshan 					|| (unsigned long)save_str < PAGE_SIZE)
22400f4f81dcSAndré Goddard Rosa 				save_str = "(null)";
22416c356634SAndré Goddard Rosa 			len = strlen(save_str) + 1;
22426c356634SAndré Goddard Rosa 			if (str + len < end)
22436c356634SAndré Goddard Rosa 				memcpy(str, save_str, len);
22446c356634SAndré Goddard Rosa 			str += len;
2245fef20d9cSFrederic Weisbecker 			break;
22464370aa4aSLai Jiangshan 		}
2247fef20d9cSFrederic Weisbecker 
2248fef20d9cSFrederic Weisbecker 		case FORMAT_TYPE_PTR:
22494370aa4aSLai Jiangshan 			save_arg(void *);
22504370aa4aSLai Jiangshan 			/* skip all alphanumeric pointer suffixes */
2251fef20d9cSFrederic Weisbecker 			while (isalnum(*fmt))
22524370aa4aSLai Jiangshan 				fmt++;
2253fef20d9cSFrederic Weisbecker 			break;
2254fef20d9cSFrederic Weisbecker 
2255fef20d9cSFrederic Weisbecker 		default:
2256fef20d9cSFrederic Weisbecker 			switch (spec.type) {
2257fef20d9cSFrederic Weisbecker 
2258fef20d9cSFrederic Weisbecker 			case FORMAT_TYPE_LONG_LONG:
2259fef20d9cSFrederic Weisbecker 				save_arg(long long);
2260fef20d9cSFrederic Weisbecker 				break;
2261fef20d9cSFrederic Weisbecker 			case FORMAT_TYPE_ULONG:
2262fef20d9cSFrederic Weisbecker 			case FORMAT_TYPE_LONG:
2263fef20d9cSFrederic Weisbecker 				save_arg(unsigned long);
2264fef20d9cSFrederic Weisbecker 				break;
2265fef20d9cSFrederic Weisbecker 			case FORMAT_TYPE_SIZE_T:
2266fef20d9cSFrederic Weisbecker 				save_arg(size_t);
2267fef20d9cSFrederic Weisbecker 				break;
2268fef20d9cSFrederic Weisbecker 			case FORMAT_TYPE_PTRDIFF:
2269fef20d9cSFrederic Weisbecker 				save_arg(ptrdiff_t);
2270fef20d9cSFrederic Weisbecker 				break;
2271a4e94ef0SZhaolei 			case FORMAT_TYPE_UBYTE:
2272a4e94ef0SZhaolei 			case FORMAT_TYPE_BYTE:
2273a4e94ef0SZhaolei 				save_arg(char);
2274a4e94ef0SZhaolei 				break;
2275fef20d9cSFrederic Weisbecker 			case FORMAT_TYPE_USHORT:
2276fef20d9cSFrederic Weisbecker 			case FORMAT_TYPE_SHORT:
2277fef20d9cSFrederic Weisbecker 				save_arg(short);
2278fef20d9cSFrederic Weisbecker 				break;
2279fef20d9cSFrederic Weisbecker 			default:
2280fef20d9cSFrederic Weisbecker 				save_arg(int);
2281fef20d9cSFrederic Weisbecker 			}
2282fef20d9cSFrederic Weisbecker 		}
2283fef20d9cSFrederic Weisbecker 	}
2284fef20d9cSFrederic Weisbecker 
2285b006f19bSRasmus Villemoes out:
22867b9186f5SAndré Goddard Rosa 	return (u32 *)(PTR_ALIGN(str, sizeof(u32))) - bin_buf;
2287fef20d9cSFrederic Weisbecker #undef save_arg
22884370aa4aSLai Jiangshan }
22894370aa4aSLai Jiangshan EXPORT_SYMBOL_GPL(vbin_printf);
22904370aa4aSLai Jiangshan 
22914370aa4aSLai Jiangshan /**
22924370aa4aSLai Jiangshan  * bstr_printf - Format a string from binary arguments and place it in a buffer
22934370aa4aSLai Jiangshan  * @buf: The buffer to place the result into
22944370aa4aSLai Jiangshan  * @size: The size of the buffer, including the trailing null space
22954370aa4aSLai Jiangshan  * @fmt: The format string to use
22964370aa4aSLai Jiangshan  * @bin_buf: Binary arguments for the format string
22974370aa4aSLai Jiangshan  *
22984370aa4aSLai Jiangshan  * This function like C99 vsnprintf, but the difference is that vsnprintf gets
22994370aa4aSLai Jiangshan  * arguments from stack, and bstr_printf gets arguments from @bin_buf which is
23004370aa4aSLai Jiangshan  * a binary buffer that generated by vbin_printf.
23014370aa4aSLai Jiangshan  *
23024370aa4aSLai Jiangshan  * The format follows C99 vsnprintf, but has some extensions:
23030efb4d20SSteven Rostedt  *  see vsnprintf comment for details.
23044370aa4aSLai Jiangshan  *
23054370aa4aSLai Jiangshan  * The return value is the number of characters which would
23064370aa4aSLai Jiangshan  * be generated for the given input, excluding the trailing
23074370aa4aSLai Jiangshan  * '\0', as per ISO C99. If you want to have the exact
23084370aa4aSLai Jiangshan  * number of characters written into @buf as return value
23094370aa4aSLai Jiangshan  * (not including the trailing '\0'), use vscnprintf(). If the
23104370aa4aSLai Jiangshan  * return is greater than or equal to @size, the resulting
23114370aa4aSLai Jiangshan  * string is truncated.
23124370aa4aSLai Jiangshan  */
23134370aa4aSLai Jiangshan int bstr_printf(char *buf, size_t size, const char *fmt, const u32 *bin_buf)
23144370aa4aSLai Jiangshan {
2315fef20d9cSFrederic Weisbecker 	struct printf_spec spec = {0};
2316d4be151bSAndré Goddard Rosa 	char *str, *end;
2317d4be151bSAndré Goddard Rosa 	const char *args = (const char *)bin_buf;
23184370aa4aSLai Jiangshan 
2319762abb51SRasmus Villemoes 	if (WARN_ON_ONCE(size > INT_MAX))
23204370aa4aSLai Jiangshan 		return 0;
23214370aa4aSLai Jiangshan 
23224370aa4aSLai Jiangshan 	str = buf;
23234370aa4aSLai Jiangshan 	end = buf + size;
23244370aa4aSLai Jiangshan 
23254370aa4aSLai Jiangshan #define get_arg(type)							\
23264370aa4aSLai Jiangshan ({									\
23274370aa4aSLai Jiangshan 	typeof(type) value;						\
23284370aa4aSLai Jiangshan 	if (sizeof(type) == 8) {					\
23294370aa4aSLai Jiangshan 		args = PTR_ALIGN(args, sizeof(u32));			\
23304370aa4aSLai Jiangshan 		*(u32 *)&value = *(u32 *)args;				\
23314370aa4aSLai Jiangshan 		*((u32 *)&value + 1) = *(u32 *)(args + 4);		\
23324370aa4aSLai Jiangshan 	} else {							\
23334370aa4aSLai Jiangshan 		args = PTR_ALIGN(args, sizeof(type));			\
23344370aa4aSLai Jiangshan 		value = *(typeof(type) *)args;				\
23354370aa4aSLai Jiangshan 	}								\
23364370aa4aSLai Jiangshan 	args += sizeof(type);						\
23374370aa4aSLai Jiangshan 	value;								\
23384370aa4aSLai Jiangshan })
23394370aa4aSLai Jiangshan 
23404370aa4aSLai Jiangshan 	/* Make sure end is always >= buf */
23414370aa4aSLai Jiangshan 	if (end < buf) {
23424370aa4aSLai Jiangshan 		end = ((void *)-1);
23434370aa4aSLai Jiangshan 		size = end - buf;
23444370aa4aSLai Jiangshan 	}
23454370aa4aSLai Jiangshan 
2346fef20d9cSFrederic Weisbecker 	while (*fmt) {
2347fef20d9cSFrederic Weisbecker 		const char *old_fmt = fmt;
2348d4be151bSAndré Goddard Rosa 		int read = format_decode(fmt, &spec);
2349fef20d9cSFrederic Weisbecker 
2350fef20d9cSFrederic Weisbecker 		fmt += read;
2351fef20d9cSFrederic Weisbecker 
2352fef20d9cSFrederic Weisbecker 		switch (spec.type) {
2353fef20d9cSFrederic Weisbecker 		case FORMAT_TYPE_NONE: {
2354fef20d9cSFrederic Weisbecker 			int copy = read;
2355fef20d9cSFrederic Weisbecker 			if (str < end) {
2356fef20d9cSFrederic Weisbecker 				if (copy > end - str)
2357fef20d9cSFrederic Weisbecker 					copy = end - str;
2358fef20d9cSFrederic Weisbecker 				memcpy(str, old_fmt, copy);
2359fef20d9cSFrederic Weisbecker 			}
2360fef20d9cSFrederic Weisbecker 			str += read;
2361fef20d9cSFrederic Weisbecker 			break;
23624370aa4aSLai Jiangshan 		}
23634370aa4aSLai Jiangshan 
2364ed681a91SVegard Nossum 		case FORMAT_TYPE_WIDTH:
2365fef20d9cSFrederic Weisbecker 			spec.field_width = get_arg(int);
2366fef20d9cSFrederic Weisbecker 			break;
23674370aa4aSLai Jiangshan 
2368fef20d9cSFrederic Weisbecker 		case FORMAT_TYPE_PRECISION:
2369fef20d9cSFrederic Weisbecker 			spec.precision = get_arg(int);
2370fef20d9cSFrederic Weisbecker 			break;
23714370aa4aSLai Jiangshan 
2372d4be151bSAndré Goddard Rosa 		case FORMAT_TYPE_CHAR: {
2373d4be151bSAndré Goddard Rosa 			char c;
2374d4be151bSAndré Goddard Rosa 
2375fef20d9cSFrederic Weisbecker 			if (!(spec.flags & LEFT)) {
2376fef20d9cSFrederic Weisbecker 				while (--spec.field_width > 0) {
23774370aa4aSLai Jiangshan 					if (str < end)
23784370aa4aSLai Jiangshan 						*str = ' ';
23794370aa4aSLai Jiangshan 					++str;
23804370aa4aSLai Jiangshan 				}
23814370aa4aSLai Jiangshan 			}
23824370aa4aSLai Jiangshan 			c = (unsigned char) get_arg(char);
23834370aa4aSLai Jiangshan 			if (str < end)
23844370aa4aSLai Jiangshan 				*str = c;
23854370aa4aSLai Jiangshan 			++str;
2386fef20d9cSFrederic Weisbecker 			while (--spec.field_width > 0) {
23874370aa4aSLai Jiangshan 				if (str < end)
23884370aa4aSLai Jiangshan 					*str = ' ';
23894370aa4aSLai Jiangshan 				++str;
23904370aa4aSLai Jiangshan 			}
2391fef20d9cSFrederic Weisbecker 			break;
2392d4be151bSAndré Goddard Rosa 		}
23934370aa4aSLai Jiangshan 
2394fef20d9cSFrederic Weisbecker 		case FORMAT_TYPE_STR: {
23954370aa4aSLai Jiangshan 			const char *str_arg = args;
2396d4be151bSAndré Goddard Rosa 			args += strlen(str_arg) + 1;
2397fef20d9cSFrederic Weisbecker 			str = string(str, end, (char *)str_arg, spec);
2398fef20d9cSFrederic Weisbecker 			break;
23994370aa4aSLai Jiangshan 		}
24004370aa4aSLai Jiangshan 
2401fef20d9cSFrederic Weisbecker 		case FORMAT_TYPE_PTR:
2402ffbfed03SRasmus Villemoes 			str = pointer(fmt, str, end, get_arg(void *), spec);
2403fef20d9cSFrederic Weisbecker 			while (isalnum(*fmt))
24044370aa4aSLai Jiangshan 				fmt++;
2405fef20d9cSFrederic Weisbecker 			break;
24064370aa4aSLai Jiangshan 
2407fef20d9cSFrederic Weisbecker 		case FORMAT_TYPE_PERCENT_CHAR:
24084370aa4aSLai Jiangshan 			if (str < end)
24094370aa4aSLai Jiangshan 				*str = '%';
24104370aa4aSLai Jiangshan 			++str;
2411fef20d9cSFrederic Weisbecker 			break;
2412fef20d9cSFrederic Weisbecker 
2413b006f19bSRasmus Villemoes 		case FORMAT_TYPE_INVALID:
2414b006f19bSRasmus Villemoes 			goto out;
2415b006f19bSRasmus Villemoes 
2416d4be151bSAndré Goddard Rosa 		default: {
2417d4be151bSAndré Goddard Rosa 			unsigned long long num;
2418d4be151bSAndré Goddard Rosa 
2419fef20d9cSFrederic Weisbecker 			switch (spec.type) {
2420fef20d9cSFrederic Weisbecker 
2421fef20d9cSFrederic Weisbecker 			case FORMAT_TYPE_LONG_LONG:
24224370aa4aSLai Jiangshan 				num = get_arg(long long);
2423fef20d9cSFrederic Weisbecker 				break;
2424fef20d9cSFrederic Weisbecker 			case FORMAT_TYPE_ULONG:
2425fef20d9cSFrederic Weisbecker 			case FORMAT_TYPE_LONG:
2426fef20d9cSFrederic Weisbecker 				num = get_arg(unsigned long);
2427fef20d9cSFrederic Weisbecker 				break;
2428fef20d9cSFrederic Weisbecker 			case FORMAT_TYPE_SIZE_T:
24294370aa4aSLai Jiangshan 				num = get_arg(size_t);
2430fef20d9cSFrederic Weisbecker 				break;
2431fef20d9cSFrederic Weisbecker 			case FORMAT_TYPE_PTRDIFF:
24324370aa4aSLai Jiangshan 				num = get_arg(ptrdiff_t);
2433fef20d9cSFrederic Weisbecker 				break;
2434a4e94ef0SZhaolei 			case FORMAT_TYPE_UBYTE:
2435a4e94ef0SZhaolei 				num = get_arg(unsigned char);
2436a4e94ef0SZhaolei 				break;
2437a4e94ef0SZhaolei 			case FORMAT_TYPE_BYTE:
2438a4e94ef0SZhaolei 				num = get_arg(signed char);
2439a4e94ef0SZhaolei 				break;
2440fef20d9cSFrederic Weisbecker 			case FORMAT_TYPE_USHORT:
2441fef20d9cSFrederic Weisbecker 				num = get_arg(unsigned short);
2442fef20d9cSFrederic Weisbecker 				break;
2443fef20d9cSFrederic Weisbecker 			case FORMAT_TYPE_SHORT:
2444fef20d9cSFrederic Weisbecker 				num = get_arg(short);
2445fef20d9cSFrederic Weisbecker 				break;
2446fef20d9cSFrederic Weisbecker 			case FORMAT_TYPE_UINT:
24474370aa4aSLai Jiangshan 				num = get_arg(unsigned int);
2448fef20d9cSFrederic Weisbecker 				break;
2449fef20d9cSFrederic Weisbecker 			default:
2450fef20d9cSFrederic Weisbecker 				num = get_arg(int);
24514370aa4aSLai Jiangshan 			}
2452fef20d9cSFrederic Weisbecker 
2453fef20d9cSFrederic Weisbecker 			str = number(str, end, num, spec);
2454d4be151bSAndré Goddard Rosa 		} /* default: */
2455d4be151bSAndré Goddard Rosa 		} /* switch(spec.type) */
2456d4be151bSAndré Goddard Rosa 	} /* while(*fmt) */
2457fef20d9cSFrederic Weisbecker 
2458b006f19bSRasmus Villemoes out:
24594370aa4aSLai Jiangshan 	if (size > 0) {
24604370aa4aSLai Jiangshan 		if (str < end)
24614370aa4aSLai Jiangshan 			*str = '\0';
24624370aa4aSLai Jiangshan 		else
24634370aa4aSLai Jiangshan 			end[-1] = '\0';
24644370aa4aSLai Jiangshan 	}
2465fef20d9cSFrederic Weisbecker 
24664370aa4aSLai Jiangshan #undef get_arg
24674370aa4aSLai Jiangshan 
24684370aa4aSLai Jiangshan 	/* the trailing null byte doesn't count towards the total */
24694370aa4aSLai Jiangshan 	return str - buf;
24704370aa4aSLai Jiangshan }
24714370aa4aSLai Jiangshan EXPORT_SYMBOL_GPL(bstr_printf);
24724370aa4aSLai Jiangshan 
24734370aa4aSLai Jiangshan /**
24744370aa4aSLai Jiangshan  * bprintf - Parse a format string and place args' binary value in a buffer
24754370aa4aSLai Jiangshan  * @bin_buf: The buffer to place args' binary value
24764370aa4aSLai Jiangshan  * @size: The size of the buffer(by words(32bits), not characters)
24774370aa4aSLai Jiangshan  * @fmt: The format string to use
24784370aa4aSLai Jiangshan  * @...: Arguments for the format string
24794370aa4aSLai Jiangshan  *
24804370aa4aSLai Jiangshan  * The function returns the number of words(u32) written
24814370aa4aSLai Jiangshan  * into @bin_buf.
24824370aa4aSLai Jiangshan  */
24834370aa4aSLai Jiangshan int bprintf(u32 *bin_buf, size_t size, const char *fmt, ...)
24844370aa4aSLai Jiangshan {
24854370aa4aSLai Jiangshan 	va_list args;
24864370aa4aSLai Jiangshan 	int ret;
24874370aa4aSLai Jiangshan 
24884370aa4aSLai Jiangshan 	va_start(args, fmt);
24894370aa4aSLai Jiangshan 	ret = vbin_printf(bin_buf, size, fmt, args);
24904370aa4aSLai Jiangshan 	va_end(args);
24917b9186f5SAndré Goddard Rosa 
24924370aa4aSLai Jiangshan 	return ret;
24934370aa4aSLai Jiangshan }
24944370aa4aSLai Jiangshan EXPORT_SYMBOL_GPL(bprintf);
24954370aa4aSLai Jiangshan 
24964370aa4aSLai Jiangshan #endif /* CONFIG_BINARY_PRINTF */
24974370aa4aSLai Jiangshan 
24981da177e4SLinus Torvalds /**
24991da177e4SLinus Torvalds  * vsscanf - Unformat a buffer into a list of arguments
25001da177e4SLinus Torvalds  * @buf:	input buffer
25011da177e4SLinus Torvalds  * @fmt:	format of buffer
25021da177e4SLinus Torvalds  * @args:	arguments
25031da177e4SLinus Torvalds  */
25041da177e4SLinus Torvalds int vsscanf(const char *buf, const char *fmt, va_list args)
25051da177e4SLinus Torvalds {
25061da177e4SLinus Torvalds 	const char *str = buf;
25071da177e4SLinus Torvalds 	char *next;
25081da177e4SLinus Torvalds 	char digit;
25091da177e4SLinus Torvalds 	int num = 0;
2510ef0658f3SJoe Perches 	u8 qualifier;
251153809751SJan Beulich 	unsigned int base;
251253809751SJan Beulich 	union {
251353809751SJan Beulich 		long long s;
251453809751SJan Beulich 		unsigned long long u;
251553809751SJan Beulich 	} val;
2516ef0658f3SJoe Perches 	s16 field_width;
2517d4be151bSAndré Goddard Rosa 	bool is_sign;
25181da177e4SLinus Torvalds 
2519da99075cSJan Beulich 	while (*fmt) {
25201da177e4SLinus Torvalds 		/* skip any white space in format */
25211da177e4SLinus Torvalds 		/* white space in format matchs any amount of
25221da177e4SLinus Torvalds 		 * white space, including none, in the input.
25231da177e4SLinus Torvalds 		 */
25241da177e4SLinus Torvalds 		if (isspace(*fmt)) {
2525e7d2860bSAndré Goddard Rosa 			fmt = skip_spaces(++fmt);
2526e7d2860bSAndré Goddard Rosa 			str = skip_spaces(str);
25271da177e4SLinus Torvalds 		}
25281da177e4SLinus Torvalds 
25291da177e4SLinus Torvalds 		/* anything that is not a conversion must match exactly */
25301da177e4SLinus Torvalds 		if (*fmt != '%' && *fmt) {
25311da177e4SLinus Torvalds 			if (*fmt++ != *str++)
25321da177e4SLinus Torvalds 				break;
25331da177e4SLinus Torvalds 			continue;
25341da177e4SLinus Torvalds 		}
25351da177e4SLinus Torvalds 
25361da177e4SLinus Torvalds 		if (!*fmt)
25371da177e4SLinus Torvalds 			break;
25381da177e4SLinus Torvalds 		++fmt;
25391da177e4SLinus Torvalds 
25401da177e4SLinus Torvalds 		/* skip this conversion.
25411da177e4SLinus Torvalds 		 * advance both strings to next white space
25421da177e4SLinus Torvalds 		 */
25431da177e4SLinus Torvalds 		if (*fmt == '*') {
2544da99075cSJan Beulich 			if (!*str)
2545da99075cSJan Beulich 				break;
25468fccae2cSAndy Spencer 			while (!isspace(*fmt) && *fmt != '%' && *fmt)
25471da177e4SLinus Torvalds 				fmt++;
25481da177e4SLinus Torvalds 			while (!isspace(*str) && *str)
25491da177e4SLinus Torvalds 				str++;
25501da177e4SLinus Torvalds 			continue;
25511da177e4SLinus Torvalds 		}
25521da177e4SLinus Torvalds 
25531da177e4SLinus Torvalds 		/* get field width */
25541da177e4SLinus Torvalds 		field_width = -1;
255553809751SJan Beulich 		if (isdigit(*fmt)) {
25561da177e4SLinus Torvalds 			field_width = skip_atoi(&fmt);
255753809751SJan Beulich 			if (field_width <= 0)
255853809751SJan Beulich 				break;
255953809751SJan Beulich 		}
25601da177e4SLinus Torvalds 
25611da177e4SLinus Torvalds 		/* get conversion qualifier */
25621da177e4SLinus Torvalds 		qualifier = -1;
256375fb8f26SAndy Shevchenko 		if (*fmt == 'h' || _tolower(*fmt) == 'l' ||
256475fb8f26SAndy Shevchenko 		    _tolower(*fmt) == 'z') {
25651da177e4SLinus Torvalds 			qualifier = *fmt++;
25661da177e4SLinus Torvalds 			if (unlikely(qualifier == *fmt)) {
25671da177e4SLinus Torvalds 				if (qualifier == 'h') {
25681da177e4SLinus Torvalds 					qualifier = 'H';
25691da177e4SLinus Torvalds 					fmt++;
25701da177e4SLinus Torvalds 				} else if (qualifier == 'l') {
25711da177e4SLinus Torvalds 					qualifier = 'L';
25721da177e4SLinus Torvalds 					fmt++;
25731da177e4SLinus Torvalds 				}
25741da177e4SLinus Torvalds 			}
25751da177e4SLinus Torvalds 		}
25761da177e4SLinus Torvalds 
2577da99075cSJan Beulich 		if (!*fmt)
2578da99075cSJan Beulich 			break;
2579da99075cSJan Beulich 
2580da99075cSJan Beulich 		if (*fmt == 'n') {
2581da99075cSJan Beulich 			/* return number of characters read so far */
2582da99075cSJan Beulich 			*va_arg(args, int *) = str - buf;
2583da99075cSJan Beulich 			++fmt;
2584da99075cSJan Beulich 			continue;
2585da99075cSJan Beulich 		}
2586da99075cSJan Beulich 
2587da99075cSJan Beulich 		if (!*str)
25881da177e4SLinus Torvalds 			break;
25891da177e4SLinus Torvalds 
2590d4be151bSAndré Goddard Rosa 		base = 10;
25913f623ebaSFabian Frederick 		is_sign = false;
2592d4be151bSAndré Goddard Rosa 
25931da177e4SLinus Torvalds 		switch (*fmt++) {
25941da177e4SLinus Torvalds 		case 'c':
25951da177e4SLinus Torvalds 		{
25961da177e4SLinus Torvalds 			char *s = (char *)va_arg(args, char*);
25971da177e4SLinus Torvalds 			if (field_width == -1)
25981da177e4SLinus Torvalds 				field_width = 1;
25991da177e4SLinus Torvalds 			do {
26001da177e4SLinus Torvalds 				*s++ = *str++;
26011da177e4SLinus Torvalds 			} while (--field_width > 0 && *str);
26021da177e4SLinus Torvalds 			num++;
26031da177e4SLinus Torvalds 		}
26041da177e4SLinus Torvalds 		continue;
26051da177e4SLinus Torvalds 		case 's':
26061da177e4SLinus Torvalds 		{
26071da177e4SLinus Torvalds 			char *s = (char *)va_arg(args, char *);
26081da177e4SLinus Torvalds 			if (field_width == -1)
26094be929beSAlexey Dobriyan 				field_width = SHRT_MAX;
26101da177e4SLinus Torvalds 			/* first, skip leading white space in buffer */
2611e7d2860bSAndré Goddard Rosa 			str = skip_spaces(str);
26121da177e4SLinus Torvalds 
26131da177e4SLinus Torvalds 			/* now copy until next white space */
26147b9186f5SAndré Goddard Rosa 			while (*str && !isspace(*str) && field_width--)
26151da177e4SLinus Torvalds 				*s++ = *str++;
26161da177e4SLinus Torvalds 			*s = '\0';
26171da177e4SLinus Torvalds 			num++;
26181da177e4SLinus Torvalds 		}
26191da177e4SLinus Torvalds 		continue;
26201da177e4SLinus Torvalds 		case 'o':
26211da177e4SLinus Torvalds 			base = 8;
26221da177e4SLinus Torvalds 			break;
26231da177e4SLinus Torvalds 		case 'x':
26241da177e4SLinus Torvalds 		case 'X':
26251da177e4SLinus Torvalds 			base = 16;
26261da177e4SLinus Torvalds 			break;
26271da177e4SLinus Torvalds 		case 'i':
26281da177e4SLinus Torvalds 			base = 0;
26291da177e4SLinus Torvalds 		case 'd':
26303f623ebaSFabian Frederick 			is_sign = true;
26311da177e4SLinus Torvalds 		case 'u':
26321da177e4SLinus Torvalds 			break;
26331da177e4SLinus Torvalds 		case '%':
26341da177e4SLinus Torvalds 			/* looking for '%' in str */
26351da177e4SLinus Torvalds 			if (*str++ != '%')
26361da177e4SLinus Torvalds 				return num;
26371da177e4SLinus Torvalds 			continue;
26381da177e4SLinus Torvalds 		default:
26391da177e4SLinus Torvalds 			/* invalid format; stop here */
26401da177e4SLinus Torvalds 			return num;
26411da177e4SLinus Torvalds 		}
26421da177e4SLinus Torvalds 
26431da177e4SLinus Torvalds 		/* have some sort of integer conversion.
26441da177e4SLinus Torvalds 		 * first, skip white space in buffer.
26451da177e4SLinus Torvalds 		 */
2646e7d2860bSAndré Goddard Rosa 		str = skip_spaces(str);
26471da177e4SLinus Torvalds 
26481da177e4SLinus Torvalds 		digit = *str;
26491da177e4SLinus Torvalds 		if (is_sign && digit == '-')
26501da177e4SLinus Torvalds 			digit = *(str + 1);
26511da177e4SLinus Torvalds 
26521da177e4SLinus Torvalds 		if (!digit
26531da177e4SLinus Torvalds 		    || (base == 16 && !isxdigit(digit))
26541da177e4SLinus Torvalds 		    || (base == 10 && !isdigit(digit))
26551da177e4SLinus Torvalds 		    || (base == 8 && (!isdigit(digit) || digit > '7'))
26561da177e4SLinus Torvalds 		    || (base == 0 && !isdigit(digit)))
26571da177e4SLinus Torvalds 			break;
26581da177e4SLinus Torvalds 
265953809751SJan Beulich 		if (is_sign)
266053809751SJan Beulich 			val.s = qualifier != 'L' ?
266153809751SJan Beulich 				simple_strtol(str, &next, base) :
266253809751SJan Beulich 				simple_strtoll(str, &next, base);
266353809751SJan Beulich 		else
266453809751SJan Beulich 			val.u = qualifier != 'L' ?
266553809751SJan Beulich 				simple_strtoul(str, &next, base) :
266653809751SJan Beulich 				simple_strtoull(str, &next, base);
266753809751SJan Beulich 
266853809751SJan Beulich 		if (field_width > 0 && next - str > field_width) {
266953809751SJan Beulich 			if (base == 0)
267053809751SJan Beulich 				_parse_integer_fixup_radix(str, &base);
267153809751SJan Beulich 			while (next - str > field_width) {
267253809751SJan Beulich 				if (is_sign)
267353809751SJan Beulich 					val.s = div_s64(val.s, base);
267453809751SJan Beulich 				else
267553809751SJan Beulich 					val.u = div_u64(val.u, base);
267653809751SJan Beulich 				--next;
267753809751SJan Beulich 			}
267853809751SJan Beulich 		}
267953809751SJan Beulich 
26801da177e4SLinus Torvalds 		switch (qualifier) {
26811da177e4SLinus Torvalds 		case 'H':	/* that's 'hh' in format */
268253809751SJan Beulich 			if (is_sign)
268353809751SJan Beulich 				*va_arg(args, signed char *) = val.s;
268453809751SJan Beulich 			else
268553809751SJan Beulich 				*va_arg(args, unsigned char *) = val.u;
26861da177e4SLinus Torvalds 			break;
26871da177e4SLinus Torvalds 		case 'h':
268853809751SJan Beulich 			if (is_sign)
268953809751SJan Beulich 				*va_arg(args, short *) = val.s;
269053809751SJan Beulich 			else
269153809751SJan Beulich 				*va_arg(args, unsigned short *) = val.u;
26921da177e4SLinus Torvalds 			break;
26931da177e4SLinus Torvalds 		case 'l':
269453809751SJan Beulich 			if (is_sign)
269553809751SJan Beulich 				*va_arg(args, long *) = val.s;
269653809751SJan Beulich 			else
269753809751SJan Beulich 				*va_arg(args, unsigned long *) = val.u;
26981da177e4SLinus Torvalds 			break;
26991da177e4SLinus Torvalds 		case 'L':
270053809751SJan Beulich 			if (is_sign)
270153809751SJan Beulich 				*va_arg(args, long long *) = val.s;
270253809751SJan Beulich 			else
270353809751SJan Beulich 				*va_arg(args, unsigned long long *) = val.u;
27041da177e4SLinus Torvalds 			break;
27051da177e4SLinus Torvalds 		case 'Z':
27061da177e4SLinus Torvalds 		case 'z':
270753809751SJan Beulich 			*va_arg(args, size_t *) = val.u;
27081da177e4SLinus Torvalds 			break;
27091da177e4SLinus Torvalds 		default:
271053809751SJan Beulich 			if (is_sign)
271153809751SJan Beulich 				*va_arg(args, int *) = val.s;
271253809751SJan Beulich 			else
271353809751SJan Beulich 				*va_arg(args, unsigned int *) = val.u;
27141da177e4SLinus Torvalds 			break;
27151da177e4SLinus Torvalds 		}
27161da177e4SLinus Torvalds 		num++;
27171da177e4SLinus Torvalds 
27181da177e4SLinus Torvalds 		if (!next)
27191da177e4SLinus Torvalds 			break;
27201da177e4SLinus Torvalds 		str = next;
27211da177e4SLinus Torvalds 	}
2722c6b40d16SJohannes Berg 
27231da177e4SLinus Torvalds 	return num;
27241da177e4SLinus Torvalds }
27251da177e4SLinus Torvalds EXPORT_SYMBOL(vsscanf);
27261da177e4SLinus Torvalds 
27271da177e4SLinus Torvalds /**
27281da177e4SLinus Torvalds  * sscanf - Unformat a buffer into a list of arguments
27291da177e4SLinus Torvalds  * @buf:	input buffer
27301da177e4SLinus Torvalds  * @fmt:	formatting of buffer
27311da177e4SLinus Torvalds  * @...:	resulting arguments
27321da177e4SLinus Torvalds  */
27331da177e4SLinus Torvalds int sscanf(const char *buf, const char *fmt, ...)
27341da177e4SLinus Torvalds {
27351da177e4SLinus Torvalds 	va_list args;
27361da177e4SLinus Torvalds 	int i;
27371da177e4SLinus Torvalds 
27381da177e4SLinus Torvalds 	va_start(args, fmt);
27391da177e4SLinus Torvalds 	i = vsscanf(buf, fmt, args);
27401da177e4SLinus Torvalds 	va_end(args);
27417b9186f5SAndré Goddard Rosa 
27421da177e4SLinus Torvalds 	return i;
27431da177e4SLinus Torvalds }
27441da177e4SLinus Torvalds EXPORT_SYMBOL(sscanf);
2745