xref: /openbmc/linux/lib/vsprintf.c (revision 1c7a8e622e84c9164dd665f5ad4879eac71bdc1e)
11da177e4SLinus Torvalds /*
21da177e4SLinus Torvalds  *  linux/lib/vsprintf.c
31da177e4SLinus Torvalds  *
41da177e4SLinus Torvalds  *  Copyright (C) 1991, 1992  Linus Torvalds
51da177e4SLinus Torvalds  */
61da177e4SLinus Torvalds 
71da177e4SLinus Torvalds /* vsprintf.c -- Lars Wirzenius & Linus Torvalds. */
81da177e4SLinus Torvalds /*
91da177e4SLinus Torvalds  * Wirzenius wrote this portably, Torvalds fucked it up :-)
101da177e4SLinus Torvalds  */
111da177e4SLinus Torvalds 
121da177e4SLinus Torvalds /*
131da177e4SLinus Torvalds  * Fri Jul 13 2001 Crutcher Dunnavant <crutcher+kernel@datastacks.com>
141da177e4SLinus Torvalds  * - changed to provide snprintf and vsnprintf functions
151da177e4SLinus Torvalds  * So Feb  1 16:51:32 CET 2004 Juergen Quade <quade@hsnr.de>
161da177e4SLinus Torvalds  * - scnprintf and vscnprintf
171da177e4SLinus Torvalds  */
181da177e4SLinus Torvalds 
191da177e4SLinus Torvalds #include <stdarg.h>
200d1d7a55SStephen Boyd #include <linux/clk.h>
21900cca29SGeert Uytterhoeven #include <linux/clk-provider.h>
228bc3bcc9SPaul Gortmaker #include <linux/module.h>	/* for KSYM_SYMBOL_LEN */
231da177e4SLinus Torvalds #include <linux/types.h>
241da177e4SLinus Torvalds #include <linux/string.h>
251da177e4SLinus Torvalds #include <linux/ctype.h>
261da177e4SLinus Torvalds #include <linux/kernel.h>
270fe1ef24SLinus Torvalds #include <linux/kallsyms.h>
2853809751SJan Beulich #include <linux/math64.h>
290fe1ef24SLinus Torvalds #include <linux/uaccess.h>
30332d2e78SLinus Torvalds #include <linux/ioport.h>
314b6ccca7SAl Viro #include <linux/dcache.h>
32312b4e22SRyan Mallon #include <linux/cred.h>
338a27f7c9SJoe Perches #include <net/addrconf.h>
341031bc58SDmitry Monakhov #ifdef CONFIG_BLOCK
351031bc58SDmitry Monakhov #include <linux/blkdev.h>
361031bc58SDmitry Monakhov #endif
371da177e4SLinus Torvalds 
384e57b681STim Schmielau #include <asm/page.h>		/* for PAGE_SIZE */
39deac93dfSJames Bottomley #include <asm/sections.h>	/* for dereference_function_descriptor() */
407c43d9a3SRasmus Villemoes #include <asm/byteorder.h>	/* cpu_to_le16 */
411da177e4SLinus Torvalds 
4271dca95dSAndy Shevchenko #include <linux/string_helpers.h>
431dff46d6SAlexey Dobriyan #include "kstrtox.h"
44aa46a63eSHarvey Harrison 
451da177e4SLinus Torvalds /**
461da177e4SLinus Torvalds  * simple_strtoull - convert a string to an unsigned long long
471da177e4SLinus Torvalds  * @cp: The start of the string
481da177e4SLinus Torvalds  * @endp: A pointer to the end of the parsed string will be placed here
491da177e4SLinus Torvalds  * @base: The number base to use
50462e4711SEldad Zack  *
51462e4711SEldad Zack  * This function is obsolete. Please use kstrtoull instead.
521da177e4SLinus Torvalds  */
531da177e4SLinus Torvalds unsigned long long simple_strtoull(const char *cp, char **endp, unsigned int base)
541da177e4SLinus Torvalds {
551dff46d6SAlexey Dobriyan 	unsigned long long result;
561dff46d6SAlexey Dobriyan 	unsigned int rv;
571da177e4SLinus Torvalds 
581dff46d6SAlexey Dobriyan 	cp = _parse_integer_fixup_radix(cp, &base);
591dff46d6SAlexey Dobriyan 	rv = _parse_integer(cp, base, &result);
601dff46d6SAlexey Dobriyan 	/* FIXME */
611dff46d6SAlexey Dobriyan 	cp += (rv & ~KSTRTOX_OVERFLOW);
62aa46a63eSHarvey Harrison 
631da177e4SLinus Torvalds 	if (endp)
641da177e4SLinus Torvalds 		*endp = (char *)cp;
657b9186f5SAndré Goddard Rosa 
661da177e4SLinus Torvalds 	return result;
671da177e4SLinus Torvalds }
681da177e4SLinus Torvalds EXPORT_SYMBOL(simple_strtoull);
691da177e4SLinus Torvalds 
701da177e4SLinus Torvalds /**
71922ac25cSAndré Goddard Rosa  * simple_strtoul - convert a string to an unsigned long
72922ac25cSAndré Goddard Rosa  * @cp: The start of the string
73922ac25cSAndré Goddard Rosa  * @endp: A pointer to the end of the parsed string will be placed here
74922ac25cSAndré Goddard Rosa  * @base: The number base to use
75462e4711SEldad Zack  *
76462e4711SEldad Zack  * This function is obsolete. Please use kstrtoul instead.
77922ac25cSAndré Goddard Rosa  */
78922ac25cSAndré Goddard Rosa unsigned long simple_strtoul(const char *cp, char **endp, unsigned int base)
79922ac25cSAndré Goddard Rosa {
80922ac25cSAndré Goddard Rosa 	return simple_strtoull(cp, endp, base);
81922ac25cSAndré Goddard Rosa }
82922ac25cSAndré Goddard Rosa EXPORT_SYMBOL(simple_strtoul);
83922ac25cSAndré Goddard Rosa 
84922ac25cSAndré Goddard Rosa /**
85922ac25cSAndré Goddard Rosa  * simple_strtol - convert a string to a signed long
86922ac25cSAndré Goddard Rosa  * @cp: The start of the string
87922ac25cSAndré Goddard Rosa  * @endp: A pointer to the end of the parsed string will be placed here
88922ac25cSAndré Goddard Rosa  * @base: The number base to use
89462e4711SEldad Zack  *
90462e4711SEldad Zack  * This function is obsolete. Please use kstrtol instead.
91922ac25cSAndré Goddard Rosa  */
92922ac25cSAndré Goddard Rosa long simple_strtol(const char *cp, char **endp, unsigned int base)
93922ac25cSAndré Goddard Rosa {
94922ac25cSAndré Goddard Rosa 	if (*cp == '-')
95922ac25cSAndré Goddard Rosa 		return -simple_strtoul(cp + 1, endp, base);
96922ac25cSAndré Goddard Rosa 
97922ac25cSAndré Goddard Rosa 	return simple_strtoul(cp, endp, base);
98922ac25cSAndré Goddard Rosa }
99922ac25cSAndré Goddard Rosa EXPORT_SYMBOL(simple_strtol);
100922ac25cSAndré Goddard Rosa 
101922ac25cSAndré Goddard Rosa /**
1021da177e4SLinus Torvalds  * simple_strtoll - convert a string to a signed long long
1031da177e4SLinus Torvalds  * @cp: The start of the string
1041da177e4SLinus Torvalds  * @endp: A pointer to the end of the parsed string will be placed here
1051da177e4SLinus Torvalds  * @base: The number base to use
106462e4711SEldad Zack  *
107462e4711SEldad Zack  * This function is obsolete. Please use kstrtoll instead.
1081da177e4SLinus Torvalds  */
1091da177e4SLinus Torvalds long long simple_strtoll(const char *cp, char **endp, unsigned int base)
1101da177e4SLinus Torvalds {
1111da177e4SLinus Torvalds 	if (*cp == '-')
1121da177e4SLinus Torvalds 		return -simple_strtoull(cp + 1, endp, base);
1137b9186f5SAndré Goddard Rosa 
1141da177e4SLinus Torvalds 	return simple_strtoull(cp, endp, base);
1151da177e4SLinus Torvalds }
11698d5ce0dSHans Verkuil EXPORT_SYMBOL(simple_strtoll);
1171da177e4SLinus Torvalds 
118cf3b429bSJoe Perches static noinline_for_stack
119cf3b429bSJoe Perches int skip_atoi(const char **s)
1201da177e4SLinus Torvalds {
1211da177e4SLinus Torvalds 	int i = 0;
1221da177e4SLinus Torvalds 
12343e5b666SRasmus Villemoes 	do {
1241da177e4SLinus Torvalds 		i = i*10 + *((*s)++) - '0';
12543e5b666SRasmus Villemoes 	} while (isdigit(**s));
1267b9186f5SAndré Goddard Rosa 
1271da177e4SLinus Torvalds 	return i;
1281da177e4SLinus Torvalds }
1291da177e4SLinus Torvalds 
1307c43d9a3SRasmus Villemoes /*
1317c43d9a3SRasmus Villemoes  * Decimal conversion is by far the most typical, and is used for
1327c43d9a3SRasmus Villemoes  * /proc and /sys data. This directly impacts e.g. top performance
1337c43d9a3SRasmus Villemoes  * with many processes running. We optimize it for speed by emitting
1347c43d9a3SRasmus Villemoes  * two characters at a time, using a 200 byte lookup table. This
1357c43d9a3SRasmus Villemoes  * roughly halves the number of multiplications compared to computing
1367c43d9a3SRasmus Villemoes  * the digits one at a time. Implementation strongly inspired by the
1377c43d9a3SRasmus Villemoes  * previous version, which in turn used ideas described at
1387c43d9a3SRasmus Villemoes  * <http://www.cs.uiowa.edu/~jones/bcd/divide.html> (with permission
1397c43d9a3SRasmus Villemoes  * from the author, Douglas W. Jones).
1407c43d9a3SRasmus Villemoes  *
1417c43d9a3SRasmus Villemoes  * It turns out there is precisely one 26 bit fixed-point
1427c43d9a3SRasmus Villemoes  * approximation a of 64/100 for which x/100 == (x * (u64)a) >> 32
1437c43d9a3SRasmus Villemoes  * holds for all x in [0, 10^8-1], namely a = 0x28f5c29. The actual
1447c43d9a3SRasmus Villemoes  * range happens to be somewhat larger (x <= 1073741898), but that's
1457c43d9a3SRasmus Villemoes  * irrelevant for our purpose.
1467c43d9a3SRasmus Villemoes  *
1477c43d9a3SRasmus Villemoes  * For dividing a number in the range [10^4, 10^6-1] by 100, we still
1487c43d9a3SRasmus Villemoes  * need a 32x32->64 bit multiply, so we simply use the same constant.
1497c43d9a3SRasmus Villemoes  *
1507c43d9a3SRasmus Villemoes  * For dividing a number in the range [100, 10^4-1] by 100, there are
1517c43d9a3SRasmus Villemoes  * several options. The simplest is (x * 0x147b) >> 19, which is valid
1527c43d9a3SRasmus Villemoes  * for all x <= 43698.
153133fd9f5SDenys Vlasenko  */
1544277eeddSDenis Vlasenko 
1557c43d9a3SRasmus Villemoes static const u16 decpair[100] = {
1567c43d9a3SRasmus Villemoes #define _(x) (__force u16) cpu_to_le16(((x % 10) | ((x / 10) << 8)) + 0x3030)
1577c43d9a3SRasmus Villemoes 	_( 0), _( 1), _( 2), _( 3), _( 4), _( 5), _( 6), _( 7), _( 8), _( 9),
1587c43d9a3SRasmus Villemoes 	_(10), _(11), _(12), _(13), _(14), _(15), _(16), _(17), _(18), _(19),
1597c43d9a3SRasmus Villemoes 	_(20), _(21), _(22), _(23), _(24), _(25), _(26), _(27), _(28), _(29),
1607c43d9a3SRasmus Villemoes 	_(30), _(31), _(32), _(33), _(34), _(35), _(36), _(37), _(38), _(39),
1617c43d9a3SRasmus Villemoes 	_(40), _(41), _(42), _(43), _(44), _(45), _(46), _(47), _(48), _(49),
1627c43d9a3SRasmus Villemoes 	_(50), _(51), _(52), _(53), _(54), _(55), _(56), _(57), _(58), _(59),
1637c43d9a3SRasmus Villemoes 	_(60), _(61), _(62), _(63), _(64), _(65), _(66), _(67), _(68), _(69),
1647c43d9a3SRasmus Villemoes 	_(70), _(71), _(72), _(73), _(74), _(75), _(76), _(77), _(78), _(79),
1657c43d9a3SRasmus Villemoes 	_(80), _(81), _(82), _(83), _(84), _(85), _(86), _(87), _(88), _(89),
1667c43d9a3SRasmus Villemoes 	_(90), _(91), _(92), _(93), _(94), _(95), _(96), _(97), _(98), _(99),
1677c43d9a3SRasmus Villemoes #undef _
1687c43d9a3SRasmus Villemoes };
1694277eeddSDenis Vlasenko 
1707b9186f5SAndré Goddard Rosa /*
1717c43d9a3SRasmus Villemoes  * This will print a single '0' even if r == 0, since we would
172675cf53cSRasmus Villemoes  * immediately jump to out_r where two 0s would be written but only
173675cf53cSRasmus Villemoes  * one of them accounted for in buf. This is needed by ip4_string
174675cf53cSRasmus Villemoes  * below. All other callers pass a non-zero value of r.
175133fd9f5SDenys Vlasenko */
176133fd9f5SDenys Vlasenko static noinline_for_stack
177133fd9f5SDenys Vlasenko char *put_dec_trunc8(char *buf, unsigned r)
178133fd9f5SDenys Vlasenko {
179133fd9f5SDenys Vlasenko 	unsigned q;
1804277eeddSDenis Vlasenko 
1817c43d9a3SRasmus Villemoes 	/* 1 <= r < 10^8 */
1827c43d9a3SRasmus Villemoes 	if (r < 100)
1837c43d9a3SRasmus Villemoes 		goto out_r;
184cb239d0aSGeorge Spelvin 
1857c43d9a3SRasmus Villemoes 	/* 100 <= r < 10^8 */
1867c43d9a3SRasmus Villemoes 	q = (r * (u64)0x28f5c29) >> 32;
1877c43d9a3SRasmus Villemoes 	*((u16 *)buf) = decpair[r - 100*q];
1887c43d9a3SRasmus Villemoes 	buf += 2;
1897c43d9a3SRasmus Villemoes 
1907c43d9a3SRasmus Villemoes 	/* 1 <= q < 10^6 */
1917c43d9a3SRasmus Villemoes 	if (q < 100)
1927c43d9a3SRasmus Villemoes 		goto out_q;
1937c43d9a3SRasmus Villemoes 
1947c43d9a3SRasmus Villemoes 	/*  100 <= q < 10^6 */
1957c43d9a3SRasmus Villemoes 	r = (q * (u64)0x28f5c29) >> 32;
1967c43d9a3SRasmus Villemoes 	*((u16 *)buf) = decpair[q - 100*r];
1977c43d9a3SRasmus Villemoes 	buf += 2;
1987c43d9a3SRasmus Villemoes 
1997c43d9a3SRasmus Villemoes 	/* 1 <= r < 10^4 */
2007c43d9a3SRasmus Villemoes 	if (r < 100)
2017c43d9a3SRasmus Villemoes 		goto out_r;
2027c43d9a3SRasmus Villemoes 
2037c43d9a3SRasmus Villemoes 	/* 100 <= r < 10^4 */
2047c43d9a3SRasmus Villemoes 	q = (r * 0x147b) >> 19;
2057c43d9a3SRasmus Villemoes 	*((u16 *)buf) = decpair[r - 100*q];
2067c43d9a3SRasmus Villemoes 	buf += 2;
2077c43d9a3SRasmus Villemoes out_q:
2087c43d9a3SRasmus Villemoes 	/* 1 <= q < 100 */
2097c43d9a3SRasmus Villemoes 	r = q;
2107c43d9a3SRasmus Villemoes out_r:
2117c43d9a3SRasmus Villemoes 	/* 1 <= r < 100 */
2127c43d9a3SRasmus Villemoes 	*((u16 *)buf) = decpair[r];
213675cf53cSRasmus Villemoes 	buf += r < 10 ? 1 : 2;
214133fd9f5SDenys Vlasenko 	return buf;
215133fd9f5SDenys Vlasenko }
216133fd9f5SDenys Vlasenko 
2177c43d9a3SRasmus Villemoes #if BITS_PER_LONG == 64 && BITS_PER_LONG_LONG == 64
2187c43d9a3SRasmus Villemoes static noinline_for_stack
2197c43d9a3SRasmus Villemoes char *put_dec_full8(char *buf, unsigned r)
2207c43d9a3SRasmus Villemoes {
2217c43d9a3SRasmus Villemoes 	unsigned q;
222133fd9f5SDenys Vlasenko 
2237c43d9a3SRasmus Villemoes 	/* 0 <= r < 10^8 */
2247c43d9a3SRasmus Villemoes 	q = (r * (u64)0x28f5c29) >> 32;
2257c43d9a3SRasmus Villemoes 	*((u16 *)buf) = decpair[r - 100*q];
2267c43d9a3SRasmus Villemoes 	buf += 2;
227133fd9f5SDenys Vlasenko 
2287c43d9a3SRasmus Villemoes 	/* 0 <= q < 10^6 */
2297c43d9a3SRasmus Villemoes 	r = (q * (u64)0x28f5c29) >> 32;
2307c43d9a3SRasmus Villemoes 	*((u16 *)buf) = decpair[q - 100*r];
2317c43d9a3SRasmus Villemoes 	buf += 2;
232133fd9f5SDenys Vlasenko 
2337c43d9a3SRasmus Villemoes 	/* 0 <= r < 10^4 */
2347c43d9a3SRasmus Villemoes 	q = (r * 0x147b) >> 19;
2357c43d9a3SRasmus Villemoes 	*((u16 *)buf) = decpair[r - 100*q];
2367c43d9a3SRasmus Villemoes 	buf += 2;
2377c43d9a3SRasmus Villemoes 
2387c43d9a3SRasmus Villemoes 	/* 0 <= q < 100 */
2397c43d9a3SRasmus Villemoes 	*((u16 *)buf) = decpair[q];
2407c43d9a3SRasmus Villemoes 	buf += 2;
2417c43d9a3SRasmus Villemoes 	return buf;
2427c43d9a3SRasmus Villemoes }
2437c43d9a3SRasmus Villemoes 
2447c43d9a3SRasmus Villemoes static noinline_for_stack
245133fd9f5SDenys Vlasenko char *put_dec(char *buf, unsigned long long n)
246133fd9f5SDenys Vlasenko {
247133fd9f5SDenys Vlasenko 	if (n >= 100*1000*1000)
2487c43d9a3SRasmus Villemoes 		buf = put_dec_full8(buf, do_div(n, 100*1000*1000));
2497c43d9a3SRasmus Villemoes 	/* 1 <= n <= 1.6e11 */
2507c43d9a3SRasmus Villemoes 	if (n >= 100*1000*1000)
2517c43d9a3SRasmus Villemoes 		buf = put_dec_full8(buf, do_div(n, 100*1000*1000));
2527c43d9a3SRasmus Villemoes 	/* 1 <= n < 1e8 */
253133fd9f5SDenys Vlasenko 	return put_dec_trunc8(buf, n);
254133fd9f5SDenys Vlasenko }
255133fd9f5SDenys Vlasenko 
2567c43d9a3SRasmus Villemoes #elif BITS_PER_LONG == 32 && BITS_PER_LONG_LONG == 64
257133fd9f5SDenys Vlasenko 
2587c43d9a3SRasmus Villemoes static void
2597c43d9a3SRasmus Villemoes put_dec_full4(char *buf, unsigned r)
260133fd9f5SDenys Vlasenko {
2617c43d9a3SRasmus Villemoes 	unsigned q;
2627c43d9a3SRasmus Villemoes 
2637c43d9a3SRasmus Villemoes 	/* 0 <= r < 10^4 */
2647c43d9a3SRasmus Villemoes 	q = (r * 0x147b) >> 19;
2657c43d9a3SRasmus Villemoes 	*((u16 *)buf) = decpair[r - 100*q];
2667c43d9a3SRasmus Villemoes 	buf += 2;
2677c43d9a3SRasmus Villemoes 	/* 0 <= q < 100 */
2687c43d9a3SRasmus Villemoes 	*((u16 *)buf) = decpair[q];
2692359172aSGeorge Spelvin }
2702359172aSGeorge Spelvin 
2712359172aSGeorge Spelvin /*
2722359172aSGeorge Spelvin  * Call put_dec_full4 on x % 10000, return x / 10000.
2732359172aSGeorge Spelvin  * The approximation x/10000 == (x * 0x346DC5D7) >> 43
2742359172aSGeorge Spelvin  * holds for all x < 1,128,869,999.  The largest value this
2752359172aSGeorge Spelvin  * helper will ever be asked to convert is 1,125,520,955.
2767c43d9a3SRasmus Villemoes  * (second call in the put_dec code, assuming n is all-ones).
2772359172aSGeorge Spelvin  */
2787c43d9a3SRasmus Villemoes static noinline_for_stack
2792359172aSGeorge Spelvin unsigned put_dec_helper4(char *buf, unsigned x)
2802359172aSGeorge Spelvin {
2812359172aSGeorge Spelvin         uint32_t q = (x * (uint64_t)0x346DC5D7) >> 43;
2822359172aSGeorge Spelvin 
2832359172aSGeorge Spelvin         put_dec_full4(buf, x - q * 10000);
2842359172aSGeorge Spelvin         return q;
285133fd9f5SDenys Vlasenko }
286133fd9f5SDenys Vlasenko 
287133fd9f5SDenys Vlasenko /* Based on code by Douglas W. Jones found at
288133fd9f5SDenys Vlasenko  * <http://www.cs.uiowa.edu/~jones/bcd/decimal.html#sixtyfour>
289133fd9f5SDenys Vlasenko  * (with permission from the author).
290133fd9f5SDenys Vlasenko  * Performs no 64-bit division and hence should be fast on 32-bit machines.
291133fd9f5SDenys Vlasenko  */
292133fd9f5SDenys Vlasenko static
293133fd9f5SDenys Vlasenko char *put_dec(char *buf, unsigned long long n)
294133fd9f5SDenys Vlasenko {
295133fd9f5SDenys Vlasenko 	uint32_t d3, d2, d1, q, h;
296133fd9f5SDenys Vlasenko 
297133fd9f5SDenys Vlasenko 	if (n < 100*1000*1000)
298133fd9f5SDenys Vlasenko 		return put_dec_trunc8(buf, n);
299133fd9f5SDenys Vlasenko 
300133fd9f5SDenys Vlasenko 	d1  = ((uint32_t)n >> 16); /* implicit "& 0xffff" */
301133fd9f5SDenys Vlasenko 	h   = (n >> 32);
302133fd9f5SDenys Vlasenko 	d2  = (h      ) & 0xffff;
303133fd9f5SDenys Vlasenko 	d3  = (h >> 16); /* implicit "& 0xffff" */
304133fd9f5SDenys Vlasenko 
3057c43d9a3SRasmus Villemoes 	/* n = 2^48 d3 + 2^32 d2 + 2^16 d1 + d0
3067c43d9a3SRasmus Villemoes 	     = 281_4749_7671_0656 d3 + 42_9496_7296 d2 + 6_5536 d1 + d0 */
307133fd9f5SDenys Vlasenko 	q   = 656 * d3 + 7296 * d2 + 5536 * d1 + ((uint32_t)n & 0xffff);
3082359172aSGeorge Spelvin 	q = put_dec_helper4(buf, q);
309133fd9f5SDenys Vlasenko 
3102359172aSGeorge Spelvin 	q += 7671 * d3 + 9496 * d2 + 6 * d1;
3112359172aSGeorge Spelvin 	q = put_dec_helper4(buf+4, q);
312133fd9f5SDenys Vlasenko 
3132359172aSGeorge Spelvin 	q += 4749 * d3 + 42 * d2;
3142359172aSGeorge Spelvin 	q = put_dec_helper4(buf+8, q);
315133fd9f5SDenys Vlasenko 
3162359172aSGeorge Spelvin 	q += 281 * d3;
3172359172aSGeorge Spelvin 	buf += 12;
3182359172aSGeorge Spelvin 	if (q)
3192359172aSGeorge Spelvin 		buf = put_dec_trunc8(buf, q);
3202359172aSGeorge Spelvin 	else while (buf[-1] == '0')
321133fd9f5SDenys Vlasenko 		--buf;
3227b9186f5SAndré Goddard Rosa 
3234277eeddSDenis Vlasenko 	return buf;
3244277eeddSDenis Vlasenko }
325133fd9f5SDenys Vlasenko 
326133fd9f5SDenys Vlasenko #endif
3274277eeddSDenis Vlasenko 
3281ac101a5SKAMEZAWA Hiroyuki /*
3291ac101a5SKAMEZAWA Hiroyuki  * Convert passed number to decimal string.
3301ac101a5SKAMEZAWA Hiroyuki  * Returns the length of string.  On buffer overflow, returns 0.
3311ac101a5SKAMEZAWA Hiroyuki  *
3321ac101a5SKAMEZAWA Hiroyuki  * If speed is not important, use snprintf(). It's easy to read the code.
3331ac101a5SKAMEZAWA Hiroyuki  */
3341ac101a5SKAMEZAWA Hiroyuki int num_to_str(char *buf, int size, unsigned long long num)
3351ac101a5SKAMEZAWA Hiroyuki {
3367c43d9a3SRasmus Villemoes 	/* put_dec requires 2-byte alignment of the buffer. */
3377c43d9a3SRasmus Villemoes 	char tmp[sizeof(num) * 3] __aligned(2);
3381ac101a5SKAMEZAWA Hiroyuki 	int idx, len;
3391ac101a5SKAMEZAWA Hiroyuki 
340133fd9f5SDenys Vlasenko 	/* put_dec() may work incorrectly for num = 0 (generate "", not "0") */
341133fd9f5SDenys Vlasenko 	if (num <= 9) {
342133fd9f5SDenys Vlasenko 		tmp[0] = '0' + num;
343133fd9f5SDenys Vlasenko 		len = 1;
344133fd9f5SDenys Vlasenko 	} else {
3451ac101a5SKAMEZAWA Hiroyuki 		len = put_dec(tmp, num) - tmp;
346133fd9f5SDenys Vlasenko 	}
3471ac101a5SKAMEZAWA Hiroyuki 
3481ac101a5SKAMEZAWA Hiroyuki 	if (len > size)
3491ac101a5SKAMEZAWA Hiroyuki 		return 0;
3501ac101a5SKAMEZAWA Hiroyuki 	for (idx = 0; idx < len; ++idx)
3511ac101a5SKAMEZAWA Hiroyuki 		buf[idx] = tmp[len - idx - 1];
3521ac101a5SKAMEZAWA Hiroyuki 	return len;
3531ac101a5SKAMEZAWA Hiroyuki }
3541ac101a5SKAMEZAWA Hiroyuki 
35551be17dfSRasmus Villemoes #define SIGN	1		/* unsigned/signed, must be 1 */
356d1c1b121SRasmus Villemoes #define LEFT	2		/* left justified */
3571da177e4SLinus Torvalds #define PLUS	4		/* show plus */
3581da177e4SLinus Torvalds #define SPACE	8		/* space if plus */
359d1c1b121SRasmus Villemoes #define ZEROPAD	16		/* pad with zero, must be 16 == '0' - ' ' */
360b89dc5d6SBjorn Helgaas #define SMALL	32		/* use lowercase in hex (must be 32 == 0x20) */
361b89dc5d6SBjorn Helgaas #define SPECIAL	64		/* prefix hex with "0x", octal with "0" */
3621da177e4SLinus Torvalds 
363fef20d9cSFrederic Weisbecker enum format_type {
364fef20d9cSFrederic Weisbecker 	FORMAT_TYPE_NONE, /* Just a string part */
365ed681a91SVegard Nossum 	FORMAT_TYPE_WIDTH,
366fef20d9cSFrederic Weisbecker 	FORMAT_TYPE_PRECISION,
367fef20d9cSFrederic Weisbecker 	FORMAT_TYPE_CHAR,
368fef20d9cSFrederic Weisbecker 	FORMAT_TYPE_STR,
369fef20d9cSFrederic Weisbecker 	FORMAT_TYPE_PTR,
370fef20d9cSFrederic Weisbecker 	FORMAT_TYPE_PERCENT_CHAR,
371fef20d9cSFrederic Weisbecker 	FORMAT_TYPE_INVALID,
372fef20d9cSFrederic Weisbecker 	FORMAT_TYPE_LONG_LONG,
373fef20d9cSFrederic Weisbecker 	FORMAT_TYPE_ULONG,
374fef20d9cSFrederic Weisbecker 	FORMAT_TYPE_LONG,
375a4e94ef0SZhaolei 	FORMAT_TYPE_UBYTE,
376a4e94ef0SZhaolei 	FORMAT_TYPE_BYTE,
377fef20d9cSFrederic Weisbecker 	FORMAT_TYPE_USHORT,
378fef20d9cSFrederic Weisbecker 	FORMAT_TYPE_SHORT,
379fef20d9cSFrederic Weisbecker 	FORMAT_TYPE_UINT,
380fef20d9cSFrederic Weisbecker 	FORMAT_TYPE_INT,
381fef20d9cSFrederic Weisbecker 	FORMAT_TYPE_SIZE_T,
382fef20d9cSFrederic Weisbecker 	FORMAT_TYPE_PTRDIFF
383fef20d9cSFrederic Weisbecker };
384fef20d9cSFrederic Weisbecker 
385fef20d9cSFrederic Weisbecker struct printf_spec {
386d0484193SRasmus Villemoes 	unsigned int	type:8;		/* format_type enum */
387d0484193SRasmus Villemoes 	signed int	field_width:24;	/* width of output field */
388d0484193SRasmus Villemoes 	unsigned int	flags:8;	/* flags to number() */
389d0484193SRasmus Villemoes 	unsigned int	base:8;		/* number base, 8, 10 or 16 only */
390d0484193SRasmus Villemoes 	signed int	precision:16;	/* # of digits/chars */
391d0484193SRasmus Villemoes } __packed;
392fef20d9cSFrederic Weisbecker 
393cf3b429bSJoe Perches static noinline_for_stack
394cf3b429bSJoe Perches char *number(char *buf, char *end, unsigned long long num,
395fef20d9cSFrederic Weisbecker 	     struct printf_spec spec)
3961da177e4SLinus Torvalds {
3977c43d9a3SRasmus Villemoes 	/* put_dec requires 2-byte alignment of the buffer. */
3987c43d9a3SRasmus Villemoes 	char tmp[3 * sizeof(num)] __aligned(2);
3999b706aeeSDenys Vlasenko 	char sign;
4009b706aeeSDenys Vlasenko 	char locase;
401fef20d9cSFrederic Weisbecker 	int need_pfx = ((spec.flags & SPECIAL) && spec.base != 10);
4021da177e4SLinus Torvalds 	int i;
4037c203422SPierre Carrier 	bool is_zero = num == 0LL;
404*1c7a8e62SRasmus Villemoes 	int field_width = spec.field_width;
405*1c7a8e62SRasmus Villemoes 	int precision = spec.precision;
4061da177e4SLinus Torvalds 
407d0484193SRasmus Villemoes 	BUILD_BUG_ON(sizeof(struct printf_spec) != 8);
408d0484193SRasmus Villemoes 
4099b706aeeSDenys Vlasenko 	/* locase = 0 or 0x20. ORing digits or letters with 'locase'
4109b706aeeSDenys Vlasenko 	 * produces same digits or (maybe lowercased) letters */
411fef20d9cSFrederic Weisbecker 	locase = (spec.flags & SMALL);
412fef20d9cSFrederic Weisbecker 	if (spec.flags & LEFT)
413fef20d9cSFrederic Weisbecker 		spec.flags &= ~ZEROPAD;
4141da177e4SLinus Torvalds 	sign = 0;
415fef20d9cSFrederic Weisbecker 	if (spec.flags & SIGN) {
4161da177e4SLinus Torvalds 		if ((signed long long)num < 0) {
4171da177e4SLinus Torvalds 			sign = '-';
4181da177e4SLinus Torvalds 			num = -(signed long long)num;
419*1c7a8e62SRasmus Villemoes 			field_width--;
420fef20d9cSFrederic Weisbecker 		} else if (spec.flags & PLUS) {
4211da177e4SLinus Torvalds 			sign = '+';
422*1c7a8e62SRasmus Villemoes 			field_width--;
423fef20d9cSFrederic Weisbecker 		} else if (spec.flags & SPACE) {
4241da177e4SLinus Torvalds 			sign = ' ';
425*1c7a8e62SRasmus Villemoes 			field_width--;
4261da177e4SLinus Torvalds 		}
4271da177e4SLinus Torvalds 	}
428b39a7340SDenis Vlasenko 	if (need_pfx) {
429fef20d9cSFrederic Weisbecker 		if (spec.base == 16)
430*1c7a8e62SRasmus Villemoes 			field_width -= 2;
4317c203422SPierre Carrier 		else if (!is_zero)
432*1c7a8e62SRasmus Villemoes 			field_width--;
4331da177e4SLinus Torvalds 	}
434b39a7340SDenis Vlasenko 
435b39a7340SDenis Vlasenko 	/* generate full string in tmp[], in reverse order */
4361da177e4SLinus Torvalds 	i = 0;
437133fd9f5SDenys Vlasenko 	if (num < spec.base)
4383ea8d440SRasmus Villemoes 		tmp[i++] = hex_asc_upper[num] | locase;
439fef20d9cSFrederic Weisbecker 	else if (spec.base != 10) { /* 8 or 16 */
440fef20d9cSFrederic Weisbecker 		int mask = spec.base - 1;
441b39a7340SDenis Vlasenko 		int shift = 3;
4427b9186f5SAndré Goddard Rosa 
4437b9186f5SAndré Goddard Rosa 		if (spec.base == 16)
4447b9186f5SAndré Goddard Rosa 			shift = 4;
445b39a7340SDenis Vlasenko 		do {
4463ea8d440SRasmus Villemoes 			tmp[i++] = (hex_asc_upper[((unsigned char)num) & mask] | locase);
447b39a7340SDenis Vlasenko 			num >>= shift;
448b39a7340SDenis Vlasenko 		} while (num);
4494277eeddSDenis Vlasenko 	} else { /* base 10 */
4504277eeddSDenis Vlasenko 		i = put_dec(tmp, num) - tmp;
4514277eeddSDenis Vlasenko 	}
452b39a7340SDenis Vlasenko 
453b39a7340SDenis Vlasenko 	/* printing 100 using %2d gives "100", not "00" */
454*1c7a8e62SRasmus Villemoes 	if (i > precision)
455*1c7a8e62SRasmus Villemoes 		precision = i;
456b39a7340SDenis Vlasenko 	/* leading space padding */
457*1c7a8e62SRasmus Villemoes 	field_width -= precision;
45851be17dfSRasmus Villemoes 	if (!(spec.flags & (ZEROPAD | LEFT))) {
459*1c7a8e62SRasmus Villemoes 		while (--field_width >= 0) {
460f796937aSJeremy Fitzhardinge 			if (buf < end)
4611da177e4SLinus Torvalds 				*buf = ' ';
4621da177e4SLinus Torvalds 			++buf;
4631da177e4SLinus Torvalds 		}
4641da177e4SLinus Torvalds 	}
465b39a7340SDenis Vlasenko 	/* sign */
4661da177e4SLinus Torvalds 	if (sign) {
467f796937aSJeremy Fitzhardinge 		if (buf < end)
4681da177e4SLinus Torvalds 			*buf = sign;
4691da177e4SLinus Torvalds 		++buf;
4701da177e4SLinus Torvalds 	}
471b39a7340SDenis Vlasenko 	/* "0x" / "0" prefix */
472b39a7340SDenis Vlasenko 	if (need_pfx) {
4737c203422SPierre Carrier 		if (spec.base == 16 || !is_zero) {
474f796937aSJeremy Fitzhardinge 			if (buf < end)
4751da177e4SLinus Torvalds 				*buf = '0';
4761da177e4SLinus Torvalds 			++buf;
4777c203422SPierre Carrier 		}
478fef20d9cSFrederic Weisbecker 		if (spec.base == 16) {
479f796937aSJeremy Fitzhardinge 			if (buf < end)
4809b706aeeSDenys Vlasenko 				*buf = ('X' | locase);
4811da177e4SLinus Torvalds 			++buf;
4821da177e4SLinus Torvalds 		}
4831da177e4SLinus Torvalds 	}
484b39a7340SDenis Vlasenko 	/* zero or space padding */
485fef20d9cSFrederic Weisbecker 	if (!(spec.flags & LEFT)) {
486d1c1b121SRasmus Villemoes 		char c = ' ' + (spec.flags & ZEROPAD);
487d1c1b121SRasmus Villemoes 		BUILD_BUG_ON(' ' + ZEROPAD != '0');
488*1c7a8e62SRasmus Villemoes 		while (--field_width >= 0) {
489f796937aSJeremy Fitzhardinge 			if (buf < end)
4901da177e4SLinus Torvalds 				*buf = c;
4911da177e4SLinus Torvalds 			++buf;
4921da177e4SLinus Torvalds 		}
4931da177e4SLinus Torvalds 	}
494b39a7340SDenis Vlasenko 	/* hmm even more zero padding? */
495*1c7a8e62SRasmus Villemoes 	while (i <= --precision) {
496f796937aSJeremy Fitzhardinge 		if (buf < end)
4971da177e4SLinus Torvalds 			*buf = '0';
4981da177e4SLinus Torvalds 		++buf;
4991da177e4SLinus Torvalds 	}
500b39a7340SDenis Vlasenko 	/* actual digits of result */
501b39a7340SDenis Vlasenko 	while (--i >= 0) {
502f796937aSJeremy Fitzhardinge 		if (buf < end)
5031da177e4SLinus Torvalds 			*buf = tmp[i];
5041da177e4SLinus Torvalds 		++buf;
5051da177e4SLinus Torvalds 	}
506b39a7340SDenis Vlasenko 	/* trailing space padding */
507*1c7a8e62SRasmus Villemoes 	while (--field_width >= 0) {
508f796937aSJeremy Fitzhardinge 		if (buf < end)
5091da177e4SLinus Torvalds 			*buf = ' ';
5101da177e4SLinus Torvalds 		++buf;
5111da177e4SLinus Torvalds 	}
5127b9186f5SAndré Goddard Rosa 
5131da177e4SLinus Torvalds 	return buf;
5141da177e4SLinus Torvalds }
5151da177e4SLinus Torvalds 
516cfccde04SRasmus Villemoes static void move_right(char *buf, char *end, unsigned len, unsigned spaces)
5174b6ccca7SAl Viro {
5184b6ccca7SAl Viro 	size_t size;
5194b6ccca7SAl Viro 	if (buf >= end)	/* nowhere to put anything */
5204b6ccca7SAl Viro 		return;
5214b6ccca7SAl Viro 	size = end - buf;
5224b6ccca7SAl Viro 	if (size <= spaces) {
5234b6ccca7SAl Viro 		memset(buf, ' ', size);
5244b6ccca7SAl Viro 		return;
5254b6ccca7SAl Viro 	}
5264b6ccca7SAl Viro 	if (len) {
5274b6ccca7SAl Viro 		if (len > size - spaces)
5284b6ccca7SAl Viro 			len = size - spaces;
5294b6ccca7SAl Viro 		memmove(buf + spaces, buf, len);
5304b6ccca7SAl Viro 	}
5314b6ccca7SAl Viro 	memset(buf, ' ', spaces);
5324b6ccca7SAl Viro }
5334b6ccca7SAl Viro 
534cfccde04SRasmus Villemoes /*
535cfccde04SRasmus Villemoes  * Handle field width padding for a string.
536cfccde04SRasmus Villemoes  * @buf: current buffer position
537cfccde04SRasmus Villemoes  * @n: length of string
538cfccde04SRasmus Villemoes  * @end: end of output buffer
539cfccde04SRasmus Villemoes  * @spec: for field width and flags
540cfccde04SRasmus Villemoes  * Returns: new buffer position after padding.
541cfccde04SRasmus Villemoes  */
542cfccde04SRasmus Villemoes static noinline_for_stack
543cfccde04SRasmus Villemoes char *widen_string(char *buf, int n, char *end, struct printf_spec spec)
544cfccde04SRasmus Villemoes {
545cfccde04SRasmus Villemoes 	unsigned spaces;
546cfccde04SRasmus Villemoes 
547cfccde04SRasmus Villemoes 	if (likely(n >= spec.field_width))
548cfccde04SRasmus Villemoes 		return buf;
549cfccde04SRasmus Villemoes 	/* we want to pad the sucker */
550cfccde04SRasmus Villemoes 	spaces = spec.field_width - n;
551cfccde04SRasmus Villemoes 	if (!(spec.flags & LEFT)) {
552cfccde04SRasmus Villemoes 		move_right(buf - n, end, n, spaces);
553cfccde04SRasmus Villemoes 		return buf + spaces;
554cfccde04SRasmus Villemoes 	}
555cfccde04SRasmus Villemoes 	while (spaces--) {
556cfccde04SRasmus Villemoes 		if (buf < end)
557cfccde04SRasmus Villemoes 			*buf = ' ';
558cfccde04SRasmus Villemoes 		++buf;
559cfccde04SRasmus Villemoes 	}
560cfccde04SRasmus Villemoes 	return buf;
561cfccde04SRasmus Villemoes }
562cfccde04SRasmus Villemoes 
5634b6ccca7SAl Viro static noinline_for_stack
56495508cfaSRasmus Villemoes char *string(char *buf, char *end, const char *s, struct printf_spec spec)
56595508cfaSRasmus Villemoes {
56634fc8b90SRasmus Villemoes 	int len = 0;
56734fc8b90SRasmus Villemoes 	size_t lim = spec.precision;
56895508cfaSRasmus Villemoes 
56995508cfaSRasmus Villemoes 	if ((unsigned long)s < PAGE_SIZE)
57095508cfaSRasmus Villemoes 		s = "(null)";
57195508cfaSRasmus Villemoes 
57234fc8b90SRasmus Villemoes 	while (lim--) {
57334fc8b90SRasmus Villemoes 		char c = *s++;
57434fc8b90SRasmus Villemoes 		if (!c)
57534fc8b90SRasmus Villemoes 			break;
57695508cfaSRasmus Villemoes 		if (buf < end)
57734fc8b90SRasmus Villemoes 			*buf = c;
57895508cfaSRasmus Villemoes 		++buf;
57934fc8b90SRasmus Villemoes 		++len;
58095508cfaSRasmus Villemoes 	}
58134fc8b90SRasmus Villemoes 	return widen_string(buf, len, end, spec);
58295508cfaSRasmus Villemoes }
58395508cfaSRasmus Villemoes 
58495508cfaSRasmus Villemoes static noinline_for_stack
5854b6ccca7SAl Viro char *dentry_name(char *buf, char *end, const struct dentry *d, struct printf_spec spec,
5864b6ccca7SAl Viro 		  const char *fmt)
5874b6ccca7SAl Viro {
5884b6ccca7SAl Viro 	const char *array[4], *s;
5894b6ccca7SAl Viro 	const struct dentry *p;
5904b6ccca7SAl Viro 	int depth;
5914b6ccca7SAl Viro 	int i, n;
5924b6ccca7SAl Viro 
5934b6ccca7SAl Viro 	switch (fmt[1]) {
5944b6ccca7SAl Viro 		case '2': case '3': case '4':
5954b6ccca7SAl Viro 			depth = fmt[1] - '0';
5964b6ccca7SAl Viro 			break;
5974b6ccca7SAl Viro 		default:
5984b6ccca7SAl Viro 			depth = 1;
5994b6ccca7SAl Viro 	}
6004b6ccca7SAl Viro 
6014b6ccca7SAl Viro 	rcu_read_lock();
6024b6ccca7SAl Viro 	for (i = 0; i < depth; i++, d = p) {
6034b6ccca7SAl Viro 		p = ACCESS_ONCE(d->d_parent);
6044b6ccca7SAl Viro 		array[i] = ACCESS_ONCE(d->d_name.name);
6054b6ccca7SAl Viro 		if (p == d) {
6064b6ccca7SAl Viro 			if (i)
6074b6ccca7SAl Viro 				array[i] = "";
6084b6ccca7SAl Viro 			i++;
6094b6ccca7SAl Viro 			break;
6104b6ccca7SAl Viro 		}
6114b6ccca7SAl Viro 	}
6124b6ccca7SAl Viro 	s = array[--i];
6134b6ccca7SAl Viro 	for (n = 0; n != spec.precision; n++, buf++) {
6144b6ccca7SAl Viro 		char c = *s++;
6154b6ccca7SAl Viro 		if (!c) {
6164b6ccca7SAl Viro 			if (!i)
6174b6ccca7SAl Viro 				break;
6184b6ccca7SAl Viro 			c = '/';
6194b6ccca7SAl Viro 			s = array[--i];
6204b6ccca7SAl Viro 		}
6214b6ccca7SAl Viro 		if (buf < end)
6224b6ccca7SAl Viro 			*buf = c;
6234b6ccca7SAl Viro 	}
6244b6ccca7SAl Viro 	rcu_read_unlock();
625cfccde04SRasmus Villemoes 	return widen_string(buf, n, end, spec);
6264b6ccca7SAl Viro }
6274b6ccca7SAl Viro 
6281031bc58SDmitry Monakhov #ifdef CONFIG_BLOCK
6291031bc58SDmitry Monakhov static noinline_for_stack
6301031bc58SDmitry Monakhov char *bdev_name(char *buf, char *end, struct block_device *bdev,
6311031bc58SDmitry Monakhov 		struct printf_spec spec, const char *fmt)
6321031bc58SDmitry Monakhov {
6331031bc58SDmitry Monakhov 	struct gendisk *hd = bdev->bd_disk;
6341031bc58SDmitry Monakhov 
6351031bc58SDmitry Monakhov 	buf = string(buf, end, hd->disk_name, spec);
6361031bc58SDmitry Monakhov 	if (bdev->bd_part->partno) {
6371031bc58SDmitry Monakhov 		if (isdigit(hd->disk_name[strlen(hd->disk_name)-1])) {
6381031bc58SDmitry Monakhov 			if (buf < end)
6391031bc58SDmitry Monakhov 				*buf = 'p';
6401031bc58SDmitry Monakhov 			buf++;
6411031bc58SDmitry Monakhov 		}
6421031bc58SDmitry Monakhov 		buf = number(buf, end, bdev->bd_part->partno, spec);
6431031bc58SDmitry Monakhov 	}
6441031bc58SDmitry Monakhov 	return buf;
6451031bc58SDmitry Monakhov }
6461031bc58SDmitry Monakhov #endif
6471031bc58SDmitry Monakhov 
648cf3b429bSJoe Perches static noinline_for_stack
649cf3b429bSJoe Perches char *symbol_string(char *buf, char *end, void *ptr,
650b0d33c2bSJoe Perches 		    struct printf_spec spec, const char *fmt)
6510fe1ef24SLinus Torvalds {
652b0d33c2bSJoe Perches 	unsigned long value;
6530fe1ef24SLinus Torvalds #ifdef CONFIG_KALLSYMS
6540fe1ef24SLinus Torvalds 	char sym[KSYM_SYMBOL_LEN];
655b0d33c2bSJoe Perches #endif
656b0d33c2bSJoe Perches 
657b0d33c2bSJoe Perches 	if (fmt[1] == 'R')
658b0d33c2bSJoe Perches 		ptr = __builtin_extract_return_addr(ptr);
659b0d33c2bSJoe Perches 	value = (unsigned long)ptr;
660b0d33c2bSJoe Perches 
661b0d33c2bSJoe Perches #ifdef CONFIG_KALLSYMS
662b0d33c2bSJoe Perches 	if (*fmt == 'B')
6630f77a8d3SNamhyung Kim 		sprint_backtrace(sym, value);
664b0d33c2bSJoe Perches 	else if (*fmt != 'f' && *fmt != 's')
6650fe1ef24SLinus Torvalds 		sprint_symbol(sym, value);
6660c8b946eSFrederic Weisbecker 	else
6674796dd20SStephen Boyd 		sprint_symbol_no_offset(sym, value);
6687b9186f5SAndré Goddard Rosa 
669fef20d9cSFrederic Weisbecker 	return string(buf, end, sym, spec);
6700fe1ef24SLinus Torvalds #else
671fef20d9cSFrederic Weisbecker 	spec.field_width = 2 * sizeof(void *);
672fef20d9cSFrederic Weisbecker 	spec.flags |= SPECIAL | SMALL | ZEROPAD;
673fef20d9cSFrederic Weisbecker 	spec.base = 16;
6747b9186f5SAndré Goddard Rosa 
675fef20d9cSFrederic Weisbecker 	return number(buf, end, value, spec);
6760fe1ef24SLinus Torvalds #endif
6770fe1ef24SLinus Torvalds }
6780fe1ef24SLinus Torvalds 
679cf3b429bSJoe Perches static noinline_for_stack
680cf3b429bSJoe Perches char *resource_string(char *buf, char *end, struct resource *res,
681fd95541eSBjorn Helgaas 		      struct printf_spec spec, const char *fmt)
682332d2e78SLinus Torvalds {
683332d2e78SLinus Torvalds #ifndef IO_RSRC_PRINTK_SIZE
68428405372SBjorn Helgaas #define IO_RSRC_PRINTK_SIZE	6
685332d2e78SLinus Torvalds #endif
686332d2e78SLinus Torvalds 
687332d2e78SLinus Torvalds #ifndef MEM_RSRC_PRINTK_SIZE
68828405372SBjorn Helgaas #define MEM_RSRC_PRINTK_SIZE	10
689332d2e78SLinus Torvalds #endif
6904da0b66cSBjorn Helgaas 	static const struct printf_spec io_spec = {
691fef20d9cSFrederic Weisbecker 		.base = 16,
6924da0b66cSBjorn Helgaas 		.field_width = IO_RSRC_PRINTK_SIZE,
693fef20d9cSFrederic Weisbecker 		.precision = -1,
694fef20d9cSFrederic Weisbecker 		.flags = SPECIAL | SMALL | ZEROPAD,
695fef20d9cSFrederic Weisbecker 	};
6964da0b66cSBjorn Helgaas 	static const struct printf_spec mem_spec = {
6974da0b66cSBjorn Helgaas 		.base = 16,
6984da0b66cSBjorn Helgaas 		.field_width = MEM_RSRC_PRINTK_SIZE,
6994da0b66cSBjorn Helgaas 		.precision = -1,
7004da0b66cSBjorn Helgaas 		.flags = SPECIAL | SMALL | ZEROPAD,
7014da0b66cSBjorn Helgaas 	};
7020f4050c7SBjorn Helgaas 	static const struct printf_spec bus_spec = {
7030f4050c7SBjorn Helgaas 		.base = 16,
7040f4050c7SBjorn Helgaas 		.field_width = 2,
7050f4050c7SBjorn Helgaas 		.precision = -1,
7060f4050c7SBjorn Helgaas 		.flags = SMALL | ZEROPAD,
7070f4050c7SBjorn Helgaas 	};
7084da0b66cSBjorn Helgaas 	static const struct printf_spec dec_spec = {
709c91d3376SBjorn Helgaas 		.base = 10,
710c91d3376SBjorn Helgaas 		.precision = -1,
711c91d3376SBjorn Helgaas 		.flags = 0,
712c91d3376SBjorn Helgaas 	};
7134da0b66cSBjorn Helgaas 	static const struct printf_spec str_spec = {
714fd95541eSBjorn Helgaas 		.field_width = -1,
715fd95541eSBjorn Helgaas 		.precision = 10,
716fd95541eSBjorn Helgaas 		.flags = LEFT,
717fd95541eSBjorn Helgaas 	};
7184da0b66cSBjorn Helgaas 	static const struct printf_spec flag_spec = {
719fd95541eSBjorn Helgaas 		.base = 16,
720fd95541eSBjorn Helgaas 		.precision = -1,
721fd95541eSBjorn Helgaas 		.flags = SPECIAL | SMALL,
722fd95541eSBjorn Helgaas 	};
723c7dabef8SBjorn Helgaas 
724c7dabef8SBjorn Helgaas 	/* 32-bit res (sizeof==4): 10 chars in dec, 10 in hex ("0x" + 8)
725c7dabef8SBjorn Helgaas 	 * 64-bit res (sizeof==8): 20 chars in dec, 18 in hex ("0x" + 16) */
726c7dabef8SBjorn Helgaas #define RSRC_BUF_SIZE		((2 * sizeof(resource_size_t)) + 4)
727c7dabef8SBjorn Helgaas #define FLAG_BUF_SIZE		(2 * sizeof(res->flags))
7289d7cca04SBjorn Helgaas #define DECODED_BUF_SIZE	sizeof("[mem - 64bit pref window disabled]")
729c7dabef8SBjorn Helgaas #define RAW_BUF_SIZE		sizeof("[mem - flags 0x]")
730c7dabef8SBjorn Helgaas 	char sym[max(2*RSRC_BUF_SIZE + DECODED_BUF_SIZE,
731c7dabef8SBjorn Helgaas 		     2*RSRC_BUF_SIZE + FLAG_BUF_SIZE + RAW_BUF_SIZE)];
732c7dabef8SBjorn Helgaas 
733332d2e78SLinus Torvalds 	char *p = sym, *pend = sym + sizeof(sym);
734c7dabef8SBjorn Helgaas 	int decode = (fmt[0] == 'R') ? 1 : 0;
7354da0b66cSBjorn Helgaas 	const struct printf_spec *specp;
736332d2e78SLinus Torvalds 
737332d2e78SLinus Torvalds 	*p++ = '[';
7384da0b66cSBjorn Helgaas 	if (res->flags & IORESOURCE_IO) {
739fd95541eSBjorn Helgaas 		p = string(p, pend, "io  ", str_spec);
7404da0b66cSBjorn Helgaas 		specp = &io_spec;
7414da0b66cSBjorn Helgaas 	} else if (res->flags & IORESOURCE_MEM) {
742fd95541eSBjorn Helgaas 		p = string(p, pend, "mem ", str_spec);
7434da0b66cSBjorn Helgaas 		specp = &mem_spec;
7444da0b66cSBjorn Helgaas 	} else if (res->flags & IORESOURCE_IRQ) {
745fd95541eSBjorn Helgaas 		p = string(p, pend, "irq ", str_spec);
7464da0b66cSBjorn Helgaas 		specp = &dec_spec;
7474da0b66cSBjorn Helgaas 	} else if (res->flags & IORESOURCE_DMA) {
748fd95541eSBjorn Helgaas 		p = string(p, pend, "dma ", str_spec);
7494da0b66cSBjorn Helgaas 		specp = &dec_spec;
7500f4050c7SBjorn Helgaas 	} else if (res->flags & IORESOURCE_BUS) {
7510f4050c7SBjorn Helgaas 		p = string(p, pend, "bus ", str_spec);
7520f4050c7SBjorn Helgaas 		specp = &bus_spec;
7534da0b66cSBjorn Helgaas 	} else {
754c7dabef8SBjorn Helgaas 		p = string(p, pend, "??? ", str_spec);
7554da0b66cSBjorn Helgaas 		specp = &mem_spec;
756c7dabef8SBjorn Helgaas 		decode = 0;
757fd95541eSBjorn Helgaas 	}
758d19cb803SBjorn Helgaas 	if (decode && res->flags & IORESOURCE_UNSET) {
759d19cb803SBjorn Helgaas 		p = string(p, pend, "size ", str_spec);
760d19cb803SBjorn Helgaas 		p = number(p, pend, resource_size(res), *specp);
761d19cb803SBjorn Helgaas 	} else {
7624da0b66cSBjorn Helgaas 		p = number(p, pend, res->start, *specp);
763c91d3376SBjorn Helgaas 		if (res->start != res->end) {
764332d2e78SLinus Torvalds 			*p++ = '-';
7654da0b66cSBjorn Helgaas 			p = number(p, pend, res->end, *specp);
766c91d3376SBjorn Helgaas 		}
767d19cb803SBjorn Helgaas 	}
768c7dabef8SBjorn Helgaas 	if (decode) {
769fd95541eSBjorn Helgaas 		if (res->flags & IORESOURCE_MEM_64)
770fd95541eSBjorn Helgaas 			p = string(p, pend, " 64bit", str_spec);
771fd95541eSBjorn Helgaas 		if (res->flags & IORESOURCE_PREFETCH)
772fd95541eSBjorn Helgaas 			p = string(p, pend, " pref", str_spec);
7739d7cca04SBjorn Helgaas 		if (res->flags & IORESOURCE_WINDOW)
7749d7cca04SBjorn Helgaas 			p = string(p, pend, " window", str_spec);
775fd95541eSBjorn Helgaas 		if (res->flags & IORESOURCE_DISABLED)
776fd95541eSBjorn Helgaas 			p = string(p, pend, " disabled", str_spec);
777c7dabef8SBjorn Helgaas 	} else {
778fd95541eSBjorn Helgaas 		p = string(p, pend, " flags ", str_spec);
779c7dabef8SBjorn Helgaas 		p = number(p, pend, res->flags, flag_spec);
780fd95541eSBjorn Helgaas 	}
781332d2e78SLinus Torvalds 	*p++ = ']';
782c7dabef8SBjorn Helgaas 	*p = '\0';
783332d2e78SLinus Torvalds 
784fef20d9cSFrederic Weisbecker 	return string(buf, end, sym, spec);
785332d2e78SLinus Torvalds }
786332d2e78SLinus Torvalds 
787cf3b429bSJoe Perches static noinline_for_stack
78831550a16SAndy Shevchenko char *hex_string(char *buf, char *end, u8 *addr, struct printf_spec spec,
78931550a16SAndy Shevchenko 		 const char *fmt)
79031550a16SAndy Shevchenko {
791360603a1SSteven Rostedt 	int i, len = 1;		/* if we pass '%ph[CDN]', field width remains
79231550a16SAndy Shevchenko 				   negative value, fallback to the default */
79331550a16SAndy Shevchenko 	char separator;
79431550a16SAndy Shevchenko 
79531550a16SAndy Shevchenko 	if (spec.field_width == 0)
79631550a16SAndy Shevchenko 		/* nothing to print */
79731550a16SAndy Shevchenko 		return buf;
79831550a16SAndy Shevchenko 
79931550a16SAndy Shevchenko 	if (ZERO_OR_NULL_PTR(addr))
80031550a16SAndy Shevchenko 		/* NULL pointer */
80131550a16SAndy Shevchenko 		return string(buf, end, NULL, spec);
80231550a16SAndy Shevchenko 
80331550a16SAndy Shevchenko 	switch (fmt[1]) {
80431550a16SAndy Shevchenko 	case 'C':
80531550a16SAndy Shevchenko 		separator = ':';
80631550a16SAndy Shevchenko 		break;
80731550a16SAndy Shevchenko 	case 'D':
80831550a16SAndy Shevchenko 		separator = '-';
80931550a16SAndy Shevchenko 		break;
81031550a16SAndy Shevchenko 	case 'N':
81131550a16SAndy Shevchenko 		separator = 0;
81231550a16SAndy Shevchenko 		break;
81331550a16SAndy Shevchenko 	default:
81431550a16SAndy Shevchenko 		separator = ' ';
81531550a16SAndy Shevchenko 		break;
81631550a16SAndy Shevchenko 	}
81731550a16SAndy Shevchenko 
81831550a16SAndy Shevchenko 	if (spec.field_width > 0)
81931550a16SAndy Shevchenko 		len = min_t(int, spec.field_width, 64);
82031550a16SAndy Shevchenko 
8219c98f235SRasmus Villemoes 	for (i = 0; i < len; ++i) {
8229c98f235SRasmus Villemoes 		if (buf < end)
8239c98f235SRasmus Villemoes 			*buf = hex_asc_hi(addr[i]);
8249c98f235SRasmus Villemoes 		++buf;
8259c98f235SRasmus Villemoes 		if (buf < end)
8269c98f235SRasmus Villemoes 			*buf = hex_asc_lo(addr[i]);
8279c98f235SRasmus Villemoes 		++buf;
82831550a16SAndy Shevchenko 
8299c98f235SRasmus Villemoes 		if (separator && i != len - 1) {
8309c98f235SRasmus Villemoes 			if (buf < end)
8319c98f235SRasmus Villemoes 				*buf = separator;
8329c98f235SRasmus Villemoes 			++buf;
8339c98f235SRasmus Villemoes 		}
83431550a16SAndy Shevchenko 	}
83531550a16SAndy Shevchenko 
83631550a16SAndy Shevchenko 	return buf;
83731550a16SAndy Shevchenko }
83831550a16SAndy Shevchenko 
83931550a16SAndy Shevchenko static noinline_for_stack
840dbc760bcSTejun Heo char *bitmap_string(char *buf, char *end, unsigned long *bitmap,
841dbc760bcSTejun Heo 		    struct printf_spec spec, const char *fmt)
842dbc760bcSTejun Heo {
843dbc760bcSTejun Heo 	const int CHUNKSZ = 32;
844dbc760bcSTejun Heo 	int nr_bits = max_t(int, spec.field_width, 0);
845dbc760bcSTejun Heo 	int i, chunksz;
846dbc760bcSTejun Heo 	bool first = true;
847dbc760bcSTejun Heo 
848dbc760bcSTejun Heo 	/* reused to print numbers */
849dbc760bcSTejun Heo 	spec = (struct printf_spec){ .flags = SMALL | ZEROPAD, .base = 16 };
850dbc760bcSTejun Heo 
851dbc760bcSTejun Heo 	chunksz = nr_bits & (CHUNKSZ - 1);
852dbc760bcSTejun Heo 	if (chunksz == 0)
853dbc760bcSTejun Heo 		chunksz = CHUNKSZ;
854dbc760bcSTejun Heo 
855dbc760bcSTejun Heo 	i = ALIGN(nr_bits, CHUNKSZ) - CHUNKSZ;
856dbc760bcSTejun Heo 	for (; i >= 0; i -= CHUNKSZ) {
857dbc760bcSTejun Heo 		u32 chunkmask, val;
858dbc760bcSTejun Heo 		int word, bit;
859dbc760bcSTejun Heo 
860dbc760bcSTejun Heo 		chunkmask = ((1ULL << chunksz) - 1);
861dbc760bcSTejun Heo 		word = i / BITS_PER_LONG;
862dbc760bcSTejun Heo 		bit = i % BITS_PER_LONG;
863dbc760bcSTejun Heo 		val = (bitmap[word] >> bit) & chunkmask;
864dbc760bcSTejun Heo 
865dbc760bcSTejun Heo 		if (!first) {
866dbc760bcSTejun Heo 			if (buf < end)
867dbc760bcSTejun Heo 				*buf = ',';
868dbc760bcSTejun Heo 			buf++;
869dbc760bcSTejun Heo 		}
870dbc760bcSTejun Heo 		first = false;
871dbc760bcSTejun Heo 
872dbc760bcSTejun Heo 		spec.field_width = DIV_ROUND_UP(chunksz, 4);
873dbc760bcSTejun Heo 		buf = number(buf, end, val, spec);
874dbc760bcSTejun Heo 
875dbc760bcSTejun Heo 		chunksz = CHUNKSZ;
876dbc760bcSTejun Heo 	}
877dbc760bcSTejun Heo 	return buf;
878dbc760bcSTejun Heo }
879dbc760bcSTejun Heo 
880dbc760bcSTejun Heo static noinline_for_stack
881dbc760bcSTejun Heo char *bitmap_list_string(char *buf, char *end, unsigned long *bitmap,
882dbc760bcSTejun Heo 			 struct printf_spec spec, const char *fmt)
883dbc760bcSTejun Heo {
884dbc760bcSTejun Heo 	int nr_bits = max_t(int, spec.field_width, 0);
885dbc760bcSTejun Heo 	/* current bit is 'cur', most recently seen range is [rbot, rtop] */
886dbc760bcSTejun Heo 	int cur, rbot, rtop;
887dbc760bcSTejun Heo 	bool first = true;
888dbc760bcSTejun Heo 
889dbc760bcSTejun Heo 	/* reused to print numbers */
890dbc760bcSTejun Heo 	spec = (struct printf_spec){ .base = 10 };
891dbc760bcSTejun Heo 
892dbc760bcSTejun Heo 	rbot = cur = find_first_bit(bitmap, nr_bits);
893dbc760bcSTejun Heo 	while (cur < nr_bits) {
894dbc760bcSTejun Heo 		rtop = cur;
895dbc760bcSTejun Heo 		cur = find_next_bit(bitmap, nr_bits, cur + 1);
896dbc760bcSTejun Heo 		if (cur < nr_bits && cur <= rtop + 1)
897dbc760bcSTejun Heo 			continue;
898dbc760bcSTejun Heo 
899dbc760bcSTejun Heo 		if (!first) {
900dbc760bcSTejun Heo 			if (buf < end)
901dbc760bcSTejun Heo 				*buf = ',';
902dbc760bcSTejun Heo 			buf++;
903dbc760bcSTejun Heo 		}
904dbc760bcSTejun Heo 		first = false;
905dbc760bcSTejun Heo 
906dbc760bcSTejun Heo 		buf = number(buf, end, rbot, spec);
907dbc760bcSTejun Heo 		if (rbot < rtop) {
908dbc760bcSTejun Heo 			if (buf < end)
909dbc760bcSTejun Heo 				*buf = '-';
910dbc760bcSTejun Heo 			buf++;
911dbc760bcSTejun Heo 
912dbc760bcSTejun Heo 			buf = number(buf, end, rtop, spec);
913dbc760bcSTejun Heo 		}
914dbc760bcSTejun Heo 
915dbc760bcSTejun Heo 		rbot = cur;
916dbc760bcSTejun Heo 	}
917dbc760bcSTejun Heo 	return buf;
918dbc760bcSTejun Heo }
919dbc760bcSTejun Heo 
920dbc760bcSTejun Heo static noinline_for_stack
921cf3b429bSJoe Perches char *mac_address_string(char *buf, char *end, u8 *addr,
9228a27f7c9SJoe Perches 			 struct printf_spec spec, const char *fmt)
923dd45c9cfSHarvey Harrison {
9248a27f7c9SJoe Perches 	char mac_addr[sizeof("xx:xx:xx:xx:xx:xx")];
925dd45c9cfSHarvey Harrison 	char *p = mac_addr;
926dd45c9cfSHarvey Harrison 	int i;
927bc7259a2SJoe Perches 	char separator;
92876597ff9SAndrei Emeltchenko 	bool reversed = false;
929bc7259a2SJoe Perches 
93076597ff9SAndrei Emeltchenko 	switch (fmt[1]) {
93176597ff9SAndrei Emeltchenko 	case 'F':
932bc7259a2SJoe Perches 		separator = '-';
93376597ff9SAndrei Emeltchenko 		break;
93476597ff9SAndrei Emeltchenko 
93576597ff9SAndrei Emeltchenko 	case 'R':
93676597ff9SAndrei Emeltchenko 		reversed = true;
93776597ff9SAndrei Emeltchenko 		/* fall through */
93876597ff9SAndrei Emeltchenko 
93976597ff9SAndrei Emeltchenko 	default:
940bc7259a2SJoe Perches 		separator = ':';
94176597ff9SAndrei Emeltchenko 		break;
942bc7259a2SJoe Perches 	}
943dd45c9cfSHarvey Harrison 
944dd45c9cfSHarvey Harrison 	for (i = 0; i < 6; i++) {
94576597ff9SAndrei Emeltchenko 		if (reversed)
94676597ff9SAndrei Emeltchenko 			p = hex_byte_pack(p, addr[5 - i]);
94776597ff9SAndrei Emeltchenko 		else
94855036ba7SAndy Shevchenko 			p = hex_byte_pack(p, addr[i]);
94976597ff9SAndrei Emeltchenko 
9508a27f7c9SJoe Perches 		if (fmt[0] == 'M' && i != 5)
951bc7259a2SJoe Perches 			*p++ = separator;
952dd45c9cfSHarvey Harrison 	}
953dd45c9cfSHarvey Harrison 	*p = '\0';
954dd45c9cfSHarvey Harrison 
955fef20d9cSFrederic Weisbecker 	return string(buf, end, mac_addr, spec);
956dd45c9cfSHarvey Harrison }
957dd45c9cfSHarvey Harrison 
958cf3b429bSJoe Perches static noinline_for_stack
959cf3b429bSJoe Perches char *ip4_string(char *p, const u8 *addr, const char *fmt)
960689afa7dSHarvey Harrison {
961689afa7dSHarvey Harrison 	int i;
9620159f24eSJoe Perches 	bool leading_zeros = (fmt[0] == 'i');
9630159f24eSJoe Perches 	int index;
9640159f24eSJoe Perches 	int step;
965689afa7dSHarvey Harrison 
9660159f24eSJoe Perches 	switch (fmt[2]) {
9670159f24eSJoe Perches 	case 'h':
9680159f24eSJoe Perches #ifdef __BIG_ENDIAN
9690159f24eSJoe Perches 		index = 0;
9700159f24eSJoe Perches 		step = 1;
9710159f24eSJoe Perches #else
9720159f24eSJoe Perches 		index = 3;
9730159f24eSJoe Perches 		step = -1;
9740159f24eSJoe Perches #endif
9750159f24eSJoe Perches 		break;
9760159f24eSJoe Perches 	case 'l':
9770159f24eSJoe Perches 		index = 3;
9780159f24eSJoe Perches 		step = -1;
9790159f24eSJoe Perches 		break;
9800159f24eSJoe Perches 	case 'n':
9810159f24eSJoe Perches 	case 'b':
9820159f24eSJoe Perches 	default:
9830159f24eSJoe Perches 		index = 0;
9840159f24eSJoe Perches 		step = 1;
9850159f24eSJoe Perches 		break;
9860159f24eSJoe Perches 	}
9878a27f7c9SJoe Perches 	for (i = 0; i < 4; i++) {
9887c43d9a3SRasmus Villemoes 		char temp[4] __aligned(2);	/* hold each IP quad in reverse order */
989133fd9f5SDenys Vlasenko 		int digits = put_dec_trunc8(temp, addr[index]) - temp;
9908a27f7c9SJoe Perches 		if (leading_zeros) {
9918a27f7c9SJoe Perches 			if (digits < 3)
9928a27f7c9SJoe Perches 				*p++ = '0';
9938a27f7c9SJoe Perches 			if (digits < 2)
9948a27f7c9SJoe Perches 				*p++ = '0';
9958a27f7c9SJoe Perches 		}
9968a27f7c9SJoe Perches 		/* reverse the digits in the quad */
9978a27f7c9SJoe Perches 		while (digits--)
9988a27f7c9SJoe Perches 			*p++ = temp[digits];
9998a27f7c9SJoe Perches 		if (i < 3)
10008a27f7c9SJoe Perches 			*p++ = '.';
10010159f24eSJoe Perches 		index += step;
10028a27f7c9SJoe Perches 	}
10038a27f7c9SJoe Perches 	*p = '\0';
10047b9186f5SAndré Goddard Rosa 
10058a27f7c9SJoe Perches 	return p;
10068a27f7c9SJoe Perches }
10078a27f7c9SJoe Perches 
1008cf3b429bSJoe Perches static noinline_for_stack
1009cf3b429bSJoe Perches char *ip6_compressed_string(char *p, const char *addr)
10108a27f7c9SJoe Perches {
10117b9186f5SAndré Goddard Rosa 	int i, j, range;
10128a27f7c9SJoe Perches 	unsigned char zerolength[8];
10138a27f7c9SJoe Perches 	int longest = 1;
10148a27f7c9SJoe Perches 	int colonpos = -1;
10158a27f7c9SJoe Perches 	u16 word;
10167b9186f5SAndré Goddard Rosa 	u8 hi, lo;
10178a27f7c9SJoe Perches 	bool needcolon = false;
1018eb78cd26SJoe Perches 	bool useIPv4;
1019eb78cd26SJoe Perches 	struct in6_addr in6;
1020eb78cd26SJoe Perches 
1021eb78cd26SJoe Perches 	memcpy(&in6, addr, sizeof(struct in6_addr));
1022eb78cd26SJoe Perches 
1023eb78cd26SJoe Perches 	useIPv4 = ipv6_addr_v4mapped(&in6) || ipv6_addr_is_isatap(&in6);
10248a27f7c9SJoe Perches 
10258a27f7c9SJoe Perches 	memset(zerolength, 0, sizeof(zerolength));
10268a27f7c9SJoe Perches 
10278a27f7c9SJoe Perches 	if (useIPv4)
10288a27f7c9SJoe Perches 		range = 6;
10298a27f7c9SJoe Perches 	else
10308a27f7c9SJoe Perches 		range = 8;
10318a27f7c9SJoe Perches 
10328a27f7c9SJoe Perches 	/* find position of longest 0 run */
10338a27f7c9SJoe Perches 	for (i = 0; i < range; i++) {
10348a27f7c9SJoe Perches 		for (j = i; j < range; j++) {
1035eb78cd26SJoe Perches 			if (in6.s6_addr16[j] != 0)
10368a27f7c9SJoe Perches 				break;
10378a27f7c9SJoe Perches 			zerolength[i]++;
10388a27f7c9SJoe Perches 		}
10398a27f7c9SJoe Perches 	}
10408a27f7c9SJoe Perches 	for (i = 0; i < range; i++) {
10418a27f7c9SJoe Perches 		if (zerolength[i] > longest) {
10428a27f7c9SJoe Perches 			longest = zerolength[i];
10438a27f7c9SJoe Perches 			colonpos = i;
10448a27f7c9SJoe Perches 		}
10458a27f7c9SJoe Perches 	}
104629cf519eSJoe Perches 	if (longest == 1)		/* don't compress a single 0 */
104729cf519eSJoe Perches 		colonpos = -1;
10488a27f7c9SJoe Perches 
10498a27f7c9SJoe Perches 	/* emit address */
10508a27f7c9SJoe Perches 	for (i = 0; i < range; i++) {
10518a27f7c9SJoe Perches 		if (i == colonpos) {
10528a27f7c9SJoe Perches 			if (needcolon || i == 0)
10538a27f7c9SJoe Perches 				*p++ = ':';
10548a27f7c9SJoe Perches 			*p++ = ':';
10558a27f7c9SJoe Perches 			needcolon = false;
10568a27f7c9SJoe Perches 			i += longest - 1;
10578a27f7c9SJoe Perches 			continue;
10588a27f7c9SJoe Perches 		}
10598a27f7c9SJoe Perches 		if (needcolon) {
10608a27f7c9SJoe Perches 			*p++ = ':';
10618a27f7c9SJoe Perches 			needcolon = false;
10628a27f7c9SJoe Perches 		}
10638a27f7c9SJoe Perches 		/* hex u16 without leading 0s */
1064eb78cd26SJoe Perches 		word = ntohs(in6.s6_addr16[i]);
10658a27f7c9SJoe Perches 		hi = word >> 8;
10668a27f7c9SJoe Perches 		lo = word & 0xff;
10678a27f7c9SJoe Perches 		if (hi) {
10688a27f7c9SJoe Perches 			if (hi > 0x0f)
106955036ba7SAndy Shevchenko 				p = hex_byte_pack(p, hi);
10708a27f7c9SJoe Perches 			else
10718a27f7c9SJoe Perches 				*p++ = hex_asc_lo(hi);
107255036ba7SAndy Shevchenko 			p = hex_byte_pack(p, lo);
10738a27f7c9SJoe Perches 		}
1074b5ff992bSAndré Goddard Rosa 		else if (lo > 0x0f)
107555036ba7SAndy Shevchenko 			p = hex_byte_pack(p, lo);
10768a27f7c9SJoe Perches 		else
10778a27f7c9SJoe Perches 			*p++ = hex_asc_lo(lo);
10788a27f7c9SJoe Perches 		needcolon = true;
10798a27f7c9SJoe Perches 	}
10808a27f7c9SJoe Perches 
10818a27f7c9SJoe Perches 	if (useIPv4) {
10828a27f7c9SJoe Perches 		if (needcolon)
10838a27f7c9SJoe Perches 			*p++ = ':';
10840159f24eSJoe Perches 		p = ip4_string(p, &in6.s6_addr[12], "I4");
10858a27f7c9SJoe Perches 	}
10868a27f7c9SJoe Perches 	*p = '\0';
10877b9186f5SAndré Goddard Rosa 
10888a27f7c9SJoe Perches 	return p;
10898a27f7c9SJoe Perches }
10908a27f7c9SJoe Perches 
1091cf3b429bSJoe Perches static noinline_for_stack
1092cf3b429bSJoe Perches char *ip6_string(char *p, const char *addr, const char *fmt)
10938a27f7c9SJoe Perches {
10948a27f7c9SJoe Perches 	int i;
10957b9186f5SAndré Goddard Rosa 
1096689afa7dSHarvey Harrison 	for (i = 0; i < 8; i++) {
109755036ba7SAndy Shevchenko 		p = hex_byte_pack(p, *addr++);
109855036ba7SAndy Shevchenko 		p = hex_byte_pack(p, *addr++);
10998a27f7c9SJoe Perches 		if (fmt[0] == 'I' && i != 7)
1100689afa7dSHarvey Harrison 			*p++ = ':';
1101689afa7dSHarvey Harrison 	}
1102689afa7dSHarvey Harrison 	*p = '\0';
11037b9186f5SAndré Goddard Rosa 
11048a27f7c9SJoe Perches 	return p;
11058a27f7c9SJoe Perches }
11068a27f7c9SJoe Perches 
1107cf3b429bSJoe Perches static noinline_for_stack
1108cf3b429bSJoe Perches char *ip6_addr_string(char *buf, char *end, const u8 *addr,
11098a27f7c9SJoe Perches 		      struct printf_spec spec, const char *fmt)
11108a27f7c9SJoe Perches {
11118a27f7c9SJoe Perches 	char ip6_addr[sizeof("xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:255.255.255.255")];
11128a27f7c9SJoe Perches 
11138a27f7c9SJoe Perches 	if (fmt[0] == 'I' && fmt[2] == 'c')
1114eb78cd26SJoe Perches 		ip6_compressed_string(ip6_addr, addr);
11158a27f7c9SJoe Perches 	else
1116eb78cd26SJoe Perches 		ip6_string(ip6_addr, addr, fmt);
1117689afa7dSHarvey Harrison 
1118fef20d9cSFrederic Weisbecker 	return string(buf, end, ip6_addr, spec);
1119689afa7dSHarvey Harrison }
1120689afa7dSHarvey Harrison 
1121cf3b429bSJoe Perches static noinline_for_stack
1122cf3b429bSJoe Perches char *ip4_addr_string(char *buf, char *end, const u8 *addr,
11238a27f7c9SJoe Perches 		      struct printf_spec spec, const char *fmt)
11244aa99606SHarvey Harrison {
11258a27f7c9SJoe Perches 	char ip4_addr[sizeof("255.255.255.255")];
11264aa99606SHarvey Harrison 
11270159f24eSJoe Perches 	ip4_string(ip4_addr, addr, fmt);
11284aa99606SHarvey Harrison 
1129fef20d9cSFrederic Weisbecker 	return string(buf, end, ip4_addr, spec);
11304aa99606SHarvey Harrison }
11314aa99606SHarvey Harrison 
1132cf3b429bSJoe Perches static noinline_for_stack
113310679643SDaniel Borkmann char *ip6_addr_string_sa(char *buf, char *end, const struct sockaddr_in6 *sa,
113410679643SDaniel Borkmann 			 struct printf_spec spec, const char *fmt)
113510679643SDaniel Borkmann {
113610679643SDaniel Borkmann 	bool have_p = false, have_s = false, have_f = false, have_c = false;
113710679643SDaniel Borkmann 	char ip6_addr[sizeof("[xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:255.255.255.255]") +
113810679643SDaniel Borkmann 		      sizeof(":12345") + sizeof("/123456789") +
113910679643SDaniel Borkmann 		      sizeof("%1234567890")];
114010679643SDaniel Borkmann 	char *p = ip6_addr, *pend = ip6_addr + sizeof(ip6_addr);
114110679643SDaniel Borkmann 	const u8 *addr = (const u8 *) &sa->sin6_addr;
114210679643SDaniel Borkmann 	char fmt6[2] = { fmt[0], '6' };
114310679643SDaniel Borkmann 	u8 off = 0;
114410679643SDaniel Borkmann 
114510679643SDaniel Borkmann 	fmt++;
114610679643SDaniel Borkmann 	while (isalpha(*++fmt)) {
114710679643SDaniel Borkmann 		switch (*fmt) {
114810679643SDaniel Borkmann 		case 'p':
114910679643SDaniel Borkmann 			have_p = true;
115010679643SDaniel Borkmann 			break;
115110679643SDaniel Borkmann 		case 'f':
115210679643SDaniel Borkmann 			have_f = true;
115310679643SDaniel Borkmann 			break;
115410679643SDaniel Borkmann 		case 's':
115510679643SDaniel Borkmann 			have_s = true;
115610679643SDaniel Borkmann 			break;
115710679643SDaniel Borkmann 		case 'c':
115810679643SDaniel Borkmann 			have_c = true;
115910679643SDaniel Borkmann 			break;
116010679643SDaniel Borkmann 		}
116110679643SDaniel Borkmann 	}
116210679643SDaniel Borkmann 
116310679643SDaniel Borkmann 	if (have_p || have_s || have_f) {
116410679643SDaniel Borkmann 		*p = '[';
116510679643SDaniel Borkmann 		off = 1;
116610679643SDaniel Borkmann 	}
116710679643SDaniel Borkmann 
116810679643SDaniel Borkmann 	if (fmt6[0] == 'I' && have_c)
116910679643SDaniel Borkmann 		p = ip6_compressed_string(ip6_addr + off, addr);
117010679643SDaniel Borkmann 	else
117110679643SDaniel Borkmann 		p = ip6_string(ip6_addr + off, addr, fmt6);
117210679643SDaniel Borkmann 
117310679643SDaniel Borkmann 	if (have_p || have_s || have_f)
117410679643SDaniel Borkmann 		*p++ = ']';
117510679643SDaniel Borkmann 
117610679643SDaniel Borkmann 	if (have_p) {
117710679643SDaniel Borkmann 		*p++ = ':';
117810679643SDaniel Borkmann 		p = number(p, pend, ntohs(sa->sin6_port), spec);
117910679643SDaniel Borkmann 	}
118010679643SDaniel Borkmann 	if (have_f) {
118110679643SDaniel Borkmann 		*p++ = '/';
118210679643SDaniel Borkmann 		p = number(p, pend, ntohl(sa->sin6_flowinfo &
118310679643SDaniel Borkmann 					  IPV6_FLOWINFO_MASK), spec);
118410679643SDaniel Borkmann 	}
118510679643SDaniel Borkmann 	if (have_s) {
118610679643SDaniel Borkmann 		*p++ = '%';
118710679643SDaniel Borkmann 		p = number(p, pend, sa->sin6_scope_id, spec);
118810679643SDaniel Borkmann 	}
118910679643SDaniel Borkmann 	*p = '\0';
119010679643SDaniel Borkmann 
119110679643SDaniel Borkmann 	return string(buf, end, ip6_addr, spec);
119210679643SDaniel Borkmann }
119310679643SDaniel Borkmann 
119410679643SDaniel Borkmann static noinline_for_stack
119510679643SDaniel Borkmann char *ip4_addr_string_sa(char *buf, char *end, const struct sockaddr_in *sa,
119610679643SDaniel Borkmann 			 struct printf_spec spec, const char *fmt)
119710679643SDaniel Borkmann {
119810679643SDaniel Borkmann 	bool have_p = false;
119910679643SDaniel Borkmann 	char *p, ip4_addr[sizeof("255.255.255.255") + sizeof(":12345")];
120010679643SDaniel Borkmann 	char *pend = ip4_addr + sizeof(ip4_addr);
120110679643SDaniel Borkmann 	const u8 *addr = (const u8 *) &sa->sin_addr.s_addr;
120210679643SDaniel Borkmann 	char fmt4[3] = { fmt[0], '4', 0 };
120310679643SDaniel Borkmann 
120410679643SDaniel Borkmann 	fmt++;
120510679643SDaniel Borkmann 	while (isalpha(*++fmt)) {
120610679643SDaniel Borkmann 		switch (*fmt) {
120710679643SDaniel Borkmann 		case 'p':
120810679643SDaniel Borkmann 			have_p = true;
120910679643SDaniel Borkmann 			break;
121010679643SDaniel Borkmann 		case 'h':
121110679643SDaniel Borkmann 		case 'l':
121210679643SDaniel Borkmann 		case 'n':
121310679643SDaniel Borkmann 		case 'b':
121410679643SDaniel Borkmann 			fmt4[2] = *fmt;
121510679643SDaniel Borkmann 			break;
121610679643SDaniel Borkmann 		}
121710679643SDaniel Borkmann 	}
121810679643SDaniel Borkmann 
121910679643SDaniel Borkmann 	p = ip4_string(ip4_addr, addr, fmt4);
122010679643SDaniel Borkmann 	if (have_p) {
122110679643SDaniel Borkmann 		*p++ = ':';
122210679643SDaniel Borkmann 		p = number(p, pend, ntohs(sa->sin_port), spec);
122310679643SDaniel Borkmann 	}
122410679643SDaniel Borkmann 	*p = '\0';
122510679643SDaniel Borkmann 
122610679643SDaniel Borkmann 	return string(buf, end, ip4_addr, spec);
122710679643SDaniel Borkmann }
122810679643SDaniel Borkmann 
122910679643SDaniel Borkmann static noinline_for_stack
123071dca95dSAndy Shevchenko char *escaped_string(char *buf, char *end, u8 *addr, struct printf_spec spec,
123171dca95dSAndy Shevchenko 		     const char *fmt)
123271dca95dSAndy Shevchenko {
123371dca95dSAndy Shevchenko 	bool found = true;
123471dca95dSAndy Shevchenko 	int count = 1;
123571dca95dSAndy Shevchenko 	unsigned int flags = 0;
123671dca95dSAndy Shevchenko 	int len;
123771dca95dSAndy Shevchenko 
123871dca95dSAndy Shevchenko 	if (spec.field_width == 0)
123971dca95dSAndy Shevchenko 		return buf;				/* nothing to print */
124071dca95dSAndy Shevchenko 
124171dca95dSAndy Shevchenko 	if (ZERO_OR_NULL_PTR(addr))
124271dca95dSAndy Shevchenko 		return string(buf, end, NULL, spec);	/* NULL pointer */
124371dca95dSAndy Shevchenko 
124471dca95dSAndy Shevchenko 
124571dca95dSAndy Shevchenko 	do {
124671dca95dSAndy Shevchenko 		switch (fmt[count++]) {
124771dca95dSAndy Shevchenko 		case 'a':
124871dca95dSAndy Shevchenko 			flags |= ESCAPE_ANY;
124971dca95dSAndy Shevchenko 			break;
125071dca95dSAndy Shevchenko 		case 'c':
125171dca95dSAndy Shevchenko 			flags |= ESCAPE_SPECIAL;
125271dca95dSAndy Shevchenko 			break;
125371dca95dSAndy Shevchenko 		case 'h':
125471dca95dSAndy Shevchenko 			flags |= ESCAPE_HEX;
125571dca95dSAndy Shevchenko 			break;
125671dca95dSAndy Shevchenko 		case 'n':
125771dca95dSAndy Shevchenko 			flags |= ESCAPE_NULL;
125871dca95dSAndy Shevchenko 			break;
125971dca95dSAndy Shevchenko 		case 'o':
126071dca95dSAndy Shevchenko 			flags |= ESCAPE_OCTAL;
126171dca95dSAndy Shevchenko 			break;
126271dca95dSAndy Shevchenko 		case 'p':
126371dca95dSAndy Shevchenko 			flags |= ESCAPE_NP;
126471dca95dSAndy Shevchenko 			break;
126571dca95dSAndy Shevchenko 		case 's':
126671dca95dSAndy Shevchenko 			flags |= ESCAPE_SPACE;
126771dca95dSAndy Shevchenko 			break;
126871dca95dSAndy Shevchenko 		default:
126971dca95dSAndy Shevchenko 			found = false;
127071dca95dSAndy Shevchenko 			break;
127171dca95dSAndy Shevchenko 		}
127271dca95dSAndy Shevchenko 	} while (found);
127371dca95dSAndy Shevchenko 
127471dca95dSAndy Shevchenko 	if (!flags)
127571dca95dSAndy Shevchenko 		flags = ESCAPE_ANY_NP;
127671dca95dSAndy Shevchenko 
127771dca95dSAndy Shevchenko 	len = spec.field_width < 0 ? 1 : spec.field_width;
127871dca95dSAndy Shevchenko 
127941416f23SRasmus Villemoes 	/*
128041416f23SRasmus Villemoes 	 * string_escape_mem() writes as many characters as it can to
128141416f23SRasmus Villemoes 	 * the given buffer, and returns the total size of the output
128241416f23SRasmus Villemoes 	 * had the buffer been big enough.
128341416f23SRasmus Villemoes 	 */
128441416f23SRasmus Villemoes 	buf += string_escape_mem(addr, len, buf, buf < end ? end - buf : 0, flags, NULL);
128571dca95dSAndy Shevchenko 
128671dca95dSAndy Shevchenko 	return buf;
128771dca95dSAndy Shevchenko }
128871dca95dSAndy Shevchenko 
128971dca95dSAndy Shevchenko static noinline_for_stack
1290cf3b429bSJoe Perches char *uuid_string(char *buf, char *end, const u8 *addr,
12919ac6e44eSJoe Perches 		  struct printf_spec spec, const char *fmt)
12929ac6e44eSJoe Perches {
12939ac6e44eSJoe Perches 	char uuid[sizeof("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx")];
12949ac6e44eSJoe Perches 	char *p = uuid;
12959ac6e44eSJoe Perches 	int i;
12969ac6e44eSJoe Perches 	static const u8 be[16] = {0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15};
12979ac6e44eSJoe Perches 	static const u8 le[16] = {3,2,1,0,5,4,7,6,8,9,10,11,12,13,14,15};
12989ac6e44eSJoe Perches 	const u8 *index = be;
12999ac6e44eSJoe Perches 	bool uc = false;
13009ac6e44eSJoe Perches 
13019ac6e44eSJoe Perches 	switch (*(++fmt)) {
13029ac6e44eSJoe Perches 	case 'L':
13039ac6e44eSJoe Perches 		uc = true;		/* fall-through */
13049ac6e44eSJoe Perches 	case 'l':
13059ac6e44eSJoe Perches 		index = le;
13069ac6e44eSJoe Perches 		break;
13079ac6e44eSJoe Perches 	case 'B':
13089ac6e44eSJoe Perches 		uc = true;
13099ac6e44eSJoe Perches 		break;
13109ac6e44eSJoe Perches 	}
13119ac6e44eSJoe Perches 
13129ac6e44eSJoe Perches 	for (i = 0; i < 16; i++) {
131355036ba7SAndy Shevchenko 		p = hex_byte_pack(p, addr[index[i]]);
13149ac6e44eSJoe Perches 		switch (i) {
13159ac6e44eSJoe Perches 		case 3:
13169ac6e44eSJoe Perches 		case 5:
13179ac6e44eSJoe Perches 		case 7:
13189ac6e44eSJoe Perches 		case 9:
13199ac6e44eSJoe Perches 			*p++ = '-';
13209ac6e44eSJoe Perches 			break;
13219ac6e44eSJoe Perches 		}
13229ac6e44eSJoe Perches 	}
13239ac6e44eSJoe Perches 
13249ac6e44eSJoe Perches 	*p = 0;
13259ac6e44eSJoe Perches 
13269ac6e44eSJoe Perches 	if (uc) {
13279ac6e44eSJoe Perches 		p = uuid;
13289ac6e44eSJoe Perches 		do {
13299ac6e44eSJoe Perches 			*p = toupper(*p);
13309ac6e44eSJoe Perches 		} while (*(++p));
13319ac6e44eSJoe Perches 	}
13329ac6e44eSJoe Perches 
13339ac6e44eSJoe Perches 	return string(buf, end, uuid, spec);
13349ac6e44eSJoe Perches }
13359ac6e44eSJoe Perches 
1336c8f44affSMichał Mirosław static
1337c8f44affSMichał Mirosław char *netdev_feature_string(char *buf, char *end, const u8 *addr,
1338c8f44affSMichał Mirosław 		      struct printf_spec spec)
1339c8f44affSMichał Mirosław {
1340c8f44affSMichał Mirosław 	spec.flags |= SPECIAL | SMALL | ZEROPAD;
1341c8f44affSMichał Mirosław 	if (spec.field_width == -1)
1342c8f44affSMichał Mirosław 		spec.field_width = 2 + 2 * sizeof(netdev_features_t);
1343c8f44affSMichał Mirosław 	spec.base = 16;
1344c8f44affSMichał Mirosław 
1345c8f44affSMichał Mirosław 	return number(buf, end, *(const netdev_features_t *)addr, spec);
1346c8f44affSMichał Mirosław }
1347c8f44affSMichał Mirosław 
1348aaf07621SJoe Perches static noinline_for_stack
1349aaf07621SJoe Perches char *address_val(char *buf, char *end, const void *addr,
1350aaf07621SJoe Perches 		  struct printf_spec spec, const char *fmt)
1351aaf07621SJoe Perches {
1352aaf07621SJoe Perches 	unsigned long long num;
1353aaf07621SJoe Perches 
1354aaf07621SJoe Perches 	spec.flags |= SPECIAL | SMALL | ZEROPAD;
1355aaf07621SJoe Perches 	spec.base = 16;
1356aaf07621SJoe Perches 
1357aaf07621SJoe Perches 	switch (fmt[1]) {
1358aaf07621SJoe Perches 	case 'd':
1359aaf07621SJoe Perches 		num = *(const dma_addr_t *)addr;
1360aaf07621SJoe Perches 		spec.field_width = sizeof(dma_addr_t) * 2 + 2;
1361aaf07621SJoe Perches 		break;
1362aaf07621SJoe Perches 	case 'p':
1363aaf07621SJoe Perches 	default:
1364aaf07621SJoe Perches 		num = *(const phys_addr_t *)addr;
1365aaf07621SJoe Perches 		spec.field_width = sizeof(phys_addr_t) * 2 + 2;
1366aaf07621SJoe Perches 		break;
1367aaf07621SJoe Perches 	}
1368aaf07621SJoe Perches 
1369aaf07621SJoe Perches 	return number(buf, end, num, spec);
1370aaf07621SJoe Perches }
1371aaf07621SJoe Perches 
1372900cca29SGeert Uytterhoeven static noinline_for_stack
1373900cca29SGeert Uytterhoeven char *clock(char *buf, char *end, struct clk *clk, struct printf_spec spec,
1374900cca29SGeert Uytterhoeven 	    const char *fmt)
1375900cca29SGeert Uytterhoeven {
1376900cca29SGeert Uytterhoeven 	if (!IS_ENABLED(CONFIG_HAVE_CLK) || !clk)
1377900cca29SGeert Uytterhoeven 		return string(buf, end, NULL, spec);
1378900cca29SGeert Uytterhoeven 
1379900cca29SGeert Uytterhoeven 	switch (fmt[1]) {
1380900cca29SGeert Uytterhoeven 	case 'r':
1381900cca29SGeert Uytterhoeven 		return number(buf, end, clk_get_rate(clk), spec);
1382900cca29SGeert Uytterhoeven 
1383900cca29SGeert Uytterhoeven 	case 'n':
1384900cca29SGeert Uytterhoeven 	default:
1385900cca29SGeert Uytterhoeven #ifdef CONFIG_COMMON_CLK
1386900cca29SGeert Uytterhoeven 		return string(buf, end, __clk_get_name(clk), spec);
1387900cca29SGeert Uytterhoeven #else
1388900cca29SGeert Uytterhoeven 		spec.base = 16;
1389900cca29SGeert Uytterhoeven 		spec.field_width = sizeof(unsigned long) * 2 + 2;
1390900cca29SGeert Uytterhoeven 		spec.flags |= SPECIAL | SMALL | ZEROPAD;
1391900cca29SGeert Uytterhoeven 		return number(buf, end, (unsigned long)clk, spec);
1392900cca29SGeert Uytterhoeven #endif
1393900cca29SGeert Uytterhoeven 	}
1394900cca29SGeert Uytterhoeven }
1395900cca29SGeert Uytterhoeven 
1396411f05f1SIngo Molnar int kptr_restrict __read_mostly;
1397455cd5abSDan Rosenberg 
13984d8a743cSLinus Torvalds /*
13994d8a743cSLinus Torvalds  * Show a '%p' thing.  A kernel extension is that the '%p' is followed
14004d8a743cSLinus Torvalds  * by an extra set of alphanumeric characters that are extended format
14014d8a743cSLinus Torvalds  * specifiers.
14024d8a743cSLinus Torvalds  *
1403332d2e78SLinus Torvalds  * Right now we handle:
14040fe1ef24SLinus Torvalds  *
14050c8b946eSFrederic Weisbecker  * - 'F' For symbolic function descriptor pointers with offset
14060c8b946eSFrederic Weisbecker  * - 'f' For simple symbolic function names without offset
14070efb4d20SSteven Rostedt  * - 'S' For symbolic direct pointers with offset
14080efb4d20SSteven Rostedt  * - 's' For symbolic direct pointers without offset
1409b0d33c2bSJoe Perches  * - '[FfSs]R' as above with __builtin_extract_return_addr() translation
14100f77a8d3SNamhyung Kim  * - 'B' For backtraced symbolic direct pointers with offset
1411c7dabef8SBjorn Helgaas  * - 'R' For decoded struct resource, e.g., [mem 0x0-0x1f 64bit pref]
1412c7dabef8SBjorn Helgaas  * - 'r' For raw struct resource, e.g., [mem 0x0-0x1f flags 0x201]
1413dbc760bcSTejun Heo  * - 'b[l]' For a bitmap, the number of bits is determined by the field
1414dbc760bcSTejun Heo  *       width which must be explicitly specified either as part of the
1415dbc760bcSTejun Heo  *       format string '%32b[l]' or through '%*b[l]', [l] selects
1416dbc760bcSTejun Heo  *       range-list format instead of hex format
1417dd45c9cfSHarvey Harrison  * - 'M' For a 6-byte MAC address, it prints the address in the
1418dd45c9cfSHarvey Harrison  *       usual colon-separated hex notation
14198a27f7c9SJoe Perches  * - 'm' For a 6-byte MAC address, it prints the hex address without colons
1420bc7259a2SJoe Perches  * - 'MF' For a 6-byte MAC FDDI address, it prints the address
1421c8e00060SJoe Perches  *       with a dash-separated hex notation
14227c59154eSAndy Shevchenko  * - '[mM]R' For a 6-byte MAC address, Reverse order (Bluetooth)
14238a27f7c9SJoe Perches  * - 'I' [46] for IPv4/IPv6 addresses printed in the usual way
14248a27f7c9SJoe Perches  *       IPv4 uses dot-separated decimal without leading 0's (1.2.3.4)
14258a27f7c9SJoe Perches  *       IPv6 uses colon separated network-order 16 bit hex with leading 0's
142610679643SDaniel Borkmann  *       [S][pfs]
142710679643SDaniel Borkmann  *       Generic IPv4/IPv6 address (struct sockaddr *) that falls back to
142810679643SDaniel Borkmann  *       [4] or [6] and is able to print port [p], flowinfo [f], scope [s]
14298a27f7c9SJoe Perches  * - 'i' [46] for 'raw' IPv4/IPv6 addresses
14308a27f7c9SJoe Perches  *       IPv6 omits the colons (01020304...0f)
14318a27f7c9SJoe Perches  *       IPv4 uses dot-separated decimal with leading 0's (010.123.045.006)
143210679643SDaniel Borkmann  *       [S][pfs]
143310679643SDaniel Borkmann  *       Generic IPv4/IPv6 address (struct sockaddr *) that falls back to
143410679643SDaniel Borkmann  *       [4] or [6] and is able to print port [p], flowinfo [f], scope [s]
143510679643SDaniel Borkmann  * - '[Ii][4S][hnbl]' IPv4 addresses in host, network, big or little endian order
143610679643SDaniel Borkmann  * - 'I[6S]c' for IPv6 addresses printed as specified by
143729cf519eSJoe Perches  *       http://tools.ietf.org/html/rfc5952
143871dca95dSAndy Shevchenko  * - 'E[achnops]' For an escaped buffer, where rules are defined by combination
143971dca95dSAndy Shevchenko  *                of the following flags (see string_escape_mem() for the
144071dca95dSAndy Shevchenko  *                details):
144171dca95dSAndy Shevchenko  *                  a - ESCAPE_ANY
144271dca95dSAndy Shevchenko  *                  c - ESCAPE_SPECIAL
144371dca95dSAndy Shevchenko  *                  h - ESCAPE_HEX
144471dca95dSAndy Shevchenko  *                  n - ESCAPE_NULL
144571dca95dSAndy Shevchenko  *                  o - ESCAPE_OCTAL
144671dca95dSAndy Shevchenko  *                  p - ESCAPE_NP
144771dca95dSAndy Shevchenko  *                  s - ESCAPE_SPACE
144871dca95dSAndy Shevchenko  *                By default ESCAPE_ANY_NP is used.
14499ac6e44eSJoe Perches  * - 'U' For a 16 byte UUID/GUID, it prints the UUID/GUID in the form
14509ac6e44eSJoe Perches  *       "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
14519ac6e44eSJoe Perches  *       Options for %pU are:
14529ac6e44eSJoe Perches  *         b big endian lower case hex (default)
14539ac6e44eSJoe Perches  *         B big endian UPPER case hex
14549ac6e44eSJoe Perches  *         l little endian lower case hex
14559ac6e44eSJoe Perches  *         L little endian UPPER case hex
14569ac6e44eSJoe Perches  *           big endian output byte order is:
14579ac6e44eSJoe Perches  *             [0][1][2][3]-[4][5]-[6][7]-[8][9]-[10][11][12][13][14][15]
14589ac6e44eSJoe Perches  *           little endian output byte order is:
14599ac6e44eSJoe Perches  *             [3][2][1][0]-[5][4]-[7][6]-[8][9]-[10][11][12][13][14][15]
14607db6f5fbSJoe Perches  * - 'V' For a struct va_format which contains a format string * and va_list *,
14617db6f5fbSJoe Perches  *       call vsnprintf(->format, *->va_list).
14627db6f5fbSJoe Perches  *       Implements a "recursive vsnprintf".
14637db6f5fbSJoe Perches  *       Do not use this feature without some mechanism to verify the
14647db6f5fbSJoe Perches  *       correctness of the format string and va_list arguments.
1465455cd5abSDan Rosenberg  * - 'K' For a kernel pointer that should be hidden from unprivileged users
1466c8f44affSMichał Mirosław  * - 'NF' For a netdev_features_t
146731550a16SAndy Shevchenko  * - 'h[CDN]' For a variable-length buffer, it prints it as a hex string with
146831550a16SAndy Shevchenko  *            a certain separator (' ' by default):
146931550a16SAndy Shevchenko  *              C colon
147031550a16SAndy Shevchenko  *              D dash
147131550a16SAndy Shevchenko  *              N no separator
147231550a16SAndy Shevchenko  *            The maximum supported length is 64 bytes of the input. Consider
147331550a16SAndy Shevchenko  *            to use print_hex_dump() for the larger input.
1474aaf07621SJoe Perches  * - 'a[pd]' For address types [p] phys_addr_t, [d] dma_addr_t and derivatives
1475aaf07621SJoe Perches  *           (default assumed to be phys_addr_t, passed by reference)
1476c0d92a57SOlof Johansson  * - 'd[234]' For a dentry name (optionally 2-4 last components)
1477c0d92a57SOlof Johansson  * - 'D[234]' Same as 'd' but for a struct file
14781031bc58SDmitry Monakhov  * - 'g' For block_device name (gendisk + partition number)
1479900cca29SGeert Uytterhoeven  * - 'C' For a clock, it prints the name (Common Clock Framework) or address
1480900cca29SGeert Uytterhoeven  *       (legacy clock framework) of the clock
1481900cca29SGeert Uytterhoeven  * - 'Cn' For a clock, it prints the name (Common Clock Framework) or address
1482900cca29SGeert Uytterhoeven  *        (legacy clock framework) of the clock
1483900cca29SGeert Uytterhoeven  * - 'Cr' For a clock, it prints the current rate of the clock
14845e4ee7b1SMartin Kletzander  *
14855e4ee7b1SMartin Kletzander  * ** Please update also Documentation/printk-formats.txt when making changes **
14869ac6e44eSJoe Perches  *
1487332d2e78SLinus Torvalds  * Note: The difference between 'S' and 'F' is that on ia64 and ppc64
1488332d2e78SLinus Torvalds  * function pointers are really function descriptors, which contain a
1489332d2e78SLinus Torvalds  * pointer to the real address.
14904d8a743cSLinus Torvalds  */
1491cf3b429bSJoe Perches static noinline_for_stack
1492cf3b429bSJoe Perches char *pointer(const char *fmt, char *buf, char *end, void *ptr,
1493fef20d9cSFrederic Weisbecker 	      struct printf_spec spec)
149478a8bf69SLinus Torvalds {
149580c9eb46SRasmus Villemoes 	const int default_width = 2 * sizeof(void *);
1496725fe002SGrant Likely 
14979f36e2c4SKees Cook 	if (!ptr && *fmt != 'K') {
14985e057981SJoe Perches 		/*
14995e057981SJoe Perches 		 * Print (null) with the same width as a pointer so it makes
15005e057981SJoe Perches 		 * tabular output look nice.
15015e057981SJoe Perches 		 */
15025e057981SJoe Perches 		if (spec.field_width == -1)
1503725fe002SGrant Likely 			spec.field_width = default_width;
1504fef20d9cSFrederic Weisbecker 		return string(buf, end, "(null)", spec);
15055e057981SJoe Perches 	}
1506d97106abSLinus Torvalds 
15070fe1ef24SLinus Torvalds 	switch (*fmt) {
15080fe1ef24SLinus Torvalds 	case 'F':
15090c8b946eSFrederic Weisbecker 	case 'f':
15100fe1ef24SLinus Torvalds 		ptr = dereference_function_descriptor(ptr);
15110fe1ef24SLinus Torvalds 		/* Fallthrough */
15120fe1ef24SLinus Torvalds 	case 'S':
15139ac6e44eSJoe Perches 	case 's':
15140f77a8d3SNamhyung Kim 	case 'B':
1515b0d33c2bSJoe Perches 		return symbol_string(buf, end, ptr, spec, fmt);
1516332d2e78SLinus Torvalds 	case 'R':
1517c7dabef8SBjorn Helgaas 	case 'r':
1518fd95541eSBjorn Helgaas 		return resource_string(buf, end, ptr, spec, fmt);
151931550a16SAndy Shevchenko 	case 'h':
152031550a16SAndy Shevchenko 		return hex_string(buf, end, ptr, spec, fmt);
1521dbc760bcSTejun Heo 	case 'b':
1522dbc760bcSTejun Heo 		switch (fmt[1]) {
1523dbc760bcSTejun Heo 		case 'l':
1524dbc760bcSTejun Heo 			return bitmap_list_string(buf, end, ptr, spec, fmt);
1525dbc760bcSTejun Heo 		default:
1526dbc760bcSTejun Heo 			return bitmap_string(buf, end, ptr, spec, fmt);
1527dbc760bcSTejun Heo 		}
15288a27f7c9SJoe Perches 	case 'M':			/* Colon separated: 00:01:02:03:04:05 */
15298a27f7c9SJoe Perches 	case 'm':			/* Contiguous: 000102030405 */
153076597ff9SAndrei Emeltchenko 					/* [mM]F (FDDI) */
153176597ff9SAndrei Emeltchenko 					/* [mM]R (Reverse order; Bluetooth) */
15328a27f7c9SJoe Perches 		return mac_address_string(buf, end, ptr, spec, fmt);
15338a27f7c9SJoe Perches 	case 'I':			/* Formatted IP supported
15348a27f7c9SJoe Perches 					 * 4:	1.2.3.4
15358a27f7c9SJoe Perches 					 * 6:	0001:0203:...:0708
15368a27f7c9SJoe Perches 					 * 6c:	1::708 or 1::1.2.3.4
15378a27f7c9SJoe Perches 					 */
15388a27f7c9SJoe Perches 	case 'i':			/* Contiguous:
15398a27f7c9SJoe Perches 					 * 4:	001.002.003.004
15408a27f7c9SJoe Perches 					 * 6:   000102...0f
15418a27f7c9SJoe Perches 					 */
15428a27f7c9SJoe Perches 		switch (fmt[1]) {
15438a27f7c9SJoe Perches 		case '6':
15448a27f7c9SJoe Perches 			return ip6_addr_string(buf, end, ptr, spec, fmt);
15458a27f7c9SJoe Perches 		case '4':
15468a27f7c9SJoe Perches 			return ip4_addr_string(buf, end, ptr, spec, fmt);
154710679643SDaniel Borkmann 		case 'S': {
154810679643SDaniel Borkmann 			const union {
154910679643SDaniel Borkmann 				struct sockaddr		raw;
155010679643SDaniel Borkmann 				struct sockaddr_in	v4;
155110679643SDaniel Borkmann 				struct sockaddr_in6	v6;
155210679643SDaniel Borkmann 			} *sa = ptr;
155310679643SDaniel Borkmann 
155410679643SDaniel Borkmann 			switch (sa->raw.sa_family) {
155510679643SDaniel Borkmann 			case AF_INET:
155610679643SDaniel Borkmann 				return ip4_addr_string_sa(buf, end, &sa->v4, spec, fmt);
155710679643SDaniel Borkmann 			case AF_INET6:
155810679643SDaniel Borkmann 				return ip6_addr_string_sa(buf, end, &sa->v6, spec, fmt);
155910679643SDaniel Borkmann 			default:
156010679643SDaniel Borkmann 				return string(buf, end, "(invalid address)", spec);
156110679643SDaniel Borkmann 			}}
15628a27f7c9SJoe Perches 		}
15634aa99606SHarvey Harrison 		break;
156471dca95dSAndy Shevchenko 	case 'E':
156571dca95dSAndy Shevchenko 		return escaped_string(buf, end, ptr, spec, fmt);
15669ac6e44eSJoe Perches 	case 'U':
15679ac6e44eSJoe Perches 		return uuid_string(buf, end, ptr, spec, fmt);
15687db6f5fbSJoe Perches 	case 'V':
15695756b76eSJan Beulich 		{
15705756b76eSJan Beulich 			va_list va;
15715756b76eSJan Beulich 
15725756b76eSJan Beulich 			va_copy(va, *((struct va_format *)ptr)->va);
15735756b76eSJan Beulich 			buf += vsnprintf(buf, end > buf ? end - buf : 0,
15745756b76eSJan Beulich 					 ((struct va_format *)ptr)->fmt, va);
15755756b76eSJan Beulich 			va_end(va);
15765756b76eSJan Beulich 			return buf;
15775756b76eSJan Beulich 		}
1578455cd5abSDan Rosenberg 	case 'K':
1579455cd5abSDan Rosenberg 		/*
1580455cd5abSDan Rosenberg 		 * %pK cannot be used in IRQ context because its test
1581455cd5abSDan Rosenberg 		 * for CAP_SYSLOG would be meaningless.
1582455cd5abSDan Rosenberg 		 */
15833715c530SDan Rosenberg 		if (kptr_restrict && (in_irq() || in_serving_softirq() ||
15843715c530SDan Rosenberg 				      in_nmi())) {
1585455cd5abSDan Rosenberg 			if (spec.field_width == -1)
1586725fe002SGrant Likely 				spec.field_width = default_width;
1587455cd5abSDan Rosenberg 			return string(buf, end, "pK-error", spec);
1588455cd5abSDan Rosenberg 		}
1589312b4e22SRyan Mallon 
1590312b4e22SRyan Mallon 		switch (kptr_restrict) {
1591312b4e22SRyan Mallon 		case 0:
1592312b4e22SRyan Mallon 			/* Always print %pK values */
1593312b4e22SRyan Mallon 			break;
1594312b4e22SRyan Mallon 		case 1: {
1595312b4e22SRyan Mallon 			/*
1596312b4e22SRyan Mallon 			 * Only print the real pointer value if the current
1597312b4e22SRyan Mallon 			 * process has CAP_SYSLOG and is running with the
1598312b4e22SRyan Mallon 			 * same credentials it started with. This is because
1599312b4e22SRyan Mallon 			 * access to files is checked at open() time, but %pK
1600312b4e22SRyan Mallon 			 * checks permission at read() time. We don't want to
1601312b4e22SRyan Mallon 			 * leak pointer values if a binary opens a file using
1602312b4e22SRyan Mallon 			 * %pK and then elevates privileges before reading it.
1603312b4e22SRyan Mallon 			 */
1604312b4e22SRyan Mallon 			const struct cred *cred = current_cred();
1605312b4e22SRyan Mallon 
1606312b4e22SRyan Mallon 			if (!has_capability_noaudit(current, CAP_SYSLOG) ||
1607312b4e22SRyan Mallon 			    !uid_eq(cred->euid, cred->uid) ||
1608312b4e22SRyan Mallon 			    !gid_eq(cred->egid, cred->gid))
160926297607SJoe Perches 				ptr = NULL;
161026297607SJoe Perches 			break;
1611312b4e22SRyan Mallon 		}
1612312b4e22SRyan Mallon 		case 2:
1613312b4e22SRyan Mallon 		default:
1614312b4e22SRyan Mallon 			/* Always print 0's for %pK */
1615312b4e22SRyan Mallon 			ptr = NULL;
1616312b4e22SRyan Mallon 			break;
1617312b4e22SRyan Mallon 		}
1618312b4e22SRyan Mallon 		break;
1619312b4e22SRyan Mallon 
1620c8f44affSMichał Mirosław 	case 'N':
1621c8f44affSMichał Mirosław 		switch (fmt[1]) {
1622c8f44affSMichał Mirosław 		case 'F':
1623c8f44affSMichał Mirosław 			return netdev_feature_string(buf, end, ptr, spec);
1624c8f44affSMichał Mirosław 		}
1625c8f44affSMichał Mirosław 		break;
16267d799210SStepan Moskovchenko 	case 'a':
1627aaf07621SJoe Perches 		return address_val(buf, end, ptr, spec, fmt);
16284b6ccca7SAl Viro 	case 'd':
16294b6ccca7SAl Viro 		return dentry_name(buf, end, ptr, spec, fmt);
1630900cca29SGeert Uytterhoeven 	case 'C':
1631900cca29SGeert Uytterhoeven 		return clock(buf, end, ptr, spec, fmt);
16324b6ccca7SAl Viro 	case 'D':
16334b6ccca7SAl Viro 		return dentry_name(buf, end,
16344b6ccca7SAl Viro 				   ((const struct file *)ptr)->f_path.dentry,
16354b6ccca7SAl Viro 				   spec, fmt);
16361031bc58SDmitry Monakhov #ifdef CONFIG_BLOCK
16371031bc58SDmitry Monakhov 	case 'g':
16381031bc58SDmitry Monakhov 		return bdev_name(buf, end, ptr, spec, fmt);
16391031bc58SDmitry Monakhov #endif
16401031bc58SDmitry Monakhov 
16410fe1ef24SLinus Torvalds 	}
1642fef20d9cSFrederic Weisbecker 	spec.flags |= SMALL;
1643fef20d9cSFrederic Weisbecker 	if (spec.field_width == -1) {
1644725fe002SGrant Likely 		spec.field_width = default_width;
1645fef20d9cSFrederic Weisbecker 		spec.flags |= ZEROPAD;
164678a8bf69SLinus Torvalds 	}
1647fef20d9cSFrederic Weisbecker 	spec.base = 16;
1648fef20d9cSFrederic Weisbecker 
1649fef20d9cSFrederic Weisbecker 	return number(buf, end, (unsigned long) ptr, spec);
1650fef20d9cSFrederic Weisbecker }
1651fef20d9cSFrederic Weisbecker 
1652fef20d9cSFrederic Weisbecker /*
1653fef20d9cSFrederic Weisbecker  * Helper function to decode printf style format.
1654fef20d9cSFrederic Weisbecker  * Each call decode a token from the format and return the
1655fef20d9cSFrederic Weisbecker  * number of characters read (or likely the delta where it wants
1656fef20d9cSFrederic Weisbecker  * to go on the next call).
1657fef20d9cSFrederic Weisbecker  * The decoded token is returned through the parameters
1658fef20d9cSFrederic Weisbecker  *
1659fef20d9cSFrederic Weisbecker  * 'h', 'l', or 'L' for integer fields
1660fef20d9cSFrederic Weisbecker  * 'z' support added 23/7/1999 S.H.
1661fef20d9cSFrederic Weisbecker  * 'z' changed to 'Z' --davidm 1/25/99
1662fef20d9cSFrederic Weisbecker  * 't' added for ptrdiff_t
1663fef20d9cSFrederic Weisbecker  *
1664fef20d9cSFrederic Weisbecker  * @fmt: the format string
1665fef20d9cSFrederic Weisbecker  * @type of the token returned
1666fef20d9cSFrederic Weisbecker  * @flags: various flags such as +, -, # tokens..
1667fef20d9cSFrederic Weisbecker  * @field_width: overwritten width
1668fef20d9cSFrederic Weisbecker  * @base: base of the number (octal, hex, ...)
1669fef20d9cSFrederic Weisbecker  * @precision: precision of a number
1670fef20d9cSFrederic Weisbecker  * @qualifier: qualifier of a number (long, size_t, ...)
1671fef20d9cSFrederic Weisbecker  */
1672cf3b429bSJoe Perches static noinline_for_stack
1673cf3b429bSJoe Perches int format_decode(const char *fmt, struct printf_spec *spec)
1674fef20d9cSFrederic Weisbecker {
1675fef20d9cSFrederic Weisbecker 	const char *start = fmt;
1676d0484193SRasmus Villemoes 	char qualifier;
1677fef20d9cSFrederic Weisbecker 
1678fef20d9cSFrederic Weisbecker 	/* we finished early by reading the field width */
1679ed681a91SVegard Nossum 	if (spec->type == FORMAT_TYPE_WIDTH) {
1680fef20d9cSFrederic Weisbecker 		if (spec->field_width < 0) {
1681fef20d9cSFrederic Weisbecker 			spec->field_width = -spec->field_width;
1682fef20d9cSFrederic Weisbecker 			spec->flags |= LEFT;
1683fef20d9cSFrederic Weisbecker 		}
1684fef20d9cSFrederic Weisbecker 		spec->type = FORMAT_TYPE_NONE;
1685fef20d9cSFrederic Weisbecker 		goto precision;
1686fef20d9cSFrederic Weisbecker 	}
1687fef20d9cSFrederic Weisbecker 
1688fef20d9cSFrederic Weisbecker 	/* we finished early by reading the precision */
1689fef20d9cSFrederic Weisbecker 	if (spec->type == FORMAT_TYPE_PRECISION) {
1690fef20d9cSFrederic Weisbecker 		if (spec->precision < 0)
1691fef20d9cSFrederic Weisbecker 			spec->precision = 0;
1692fef20d9cSFrederic Weisbecker 
1693fef20d9cSFrederic Weisbecker 		spec->type = FORMAT_TYPE_NONE;
1694fef20d9cSFrederic Weisbecker 		goto qualifier;
1695fef20d9cSFrederic Weisbecker 	}
1696fef20d9cSFrederic Weisbecker 
1697fef20d9cSFrederic Weisbecker 	/* By default */
1698fef20d9cSFrederic Weisbecker 	spec->type = FORMAT_TYPE_NONE;
1699fef20d9cSFrederic Weisbecker 
1700fef20d9cSFrederic Weisbecker 	for (; *fmt ; ++fmt) {
1701fef20d9cSFrederic Weisbecker 		if (*fmt == '%')
1702fef20d9cSFrederic Weisbecker 			break;
1703fef20d9cSFrederic Weisbecker 	}
1704fef20d9cSFrederic Weisbecker 
1705fef20d9cSFrederic Weisbecker 	/* Return the current non-format string */
1706fef20d9cSFrederic Weisbecker 	if (fmt != start || !*fmt)
1707fef20d9cSFrederic Weisbecker 		return fmt - start;
1708fef20d9cSFrederic Weisbecker 
1709fef20d9cSFrederic Weisbecker 	/* Process flags */
1710fef20d9cSFrederic Weisbecker 	spec->flags = 0;
1711fef20d9cSFrederic Weisbecker 
1712fef20d9cSFrederic Weisbecker 	while (1) { /* this also skips first '%' */
1713fef20d9cSFrederic Weisbecker 		bool found = true;
1714fef20d9cSFrederic Weisbecker 
1715fef20d9cSFrederic Weisbecker 		++fmt;
1716fef20d9cSFrederic Weisbecker 
1717fef20d9cSFrederic Weisbecker 		switch (*fmt) {
1718fef20d9cSFrederic Weisbecker 		case '-': spec->flags |= LEFT;    break;
1719fef20d9cSFrederic Weisbecker 		case '+': spec->flags |= PLUS;    break;
1720fef20d9cSFrederic Weisbecker 		case ' ': spec->flags |= SPACE;   break;
1721fef20d9cSFrederic Weisbecker 		case '#': spec->flags |= SPECIAL; break;
1722fef20d9cSFrederic Weisbecker 		case '0': spec->flags |= ZEROPAD; break;
1723fef20d9cSFrederic Weisbecker 		default:  found = false;
1724fef20d9cSFrederic Weisbecker 		}
1725fef20d9cSFrederic Weisbecker 
1726fef20d9cSFrederic Weisbecker 		if (!found)
1727fef20d9cSFrederic Weisbecker 			break;
1728fef20d9cSFrederic Weisbecker 	}
1729fef20d9cSFrederic Weisbecker 
1730fef20d9cSFrederic Weisbecker 	/* get field width */
1731fef20d9cSFrederic Weisbecker 	spec->field_width = -1;
1732fef20d9cSFrederic Weisbecker 
1733fef20d9cSFrederic Weisbecker 	if (isdigit(*fmt))
1734fef20d9cSFrederic Weisbecker 		spec->field_width = skip_atoi(&fmt);
1735fef20d9cSFrederic Weisbecker 	else if (*fmt == '*') {
1736fef20d9cSFrederic Weisbecker 		/* it's the next argument */
1737ed681a91SVegard Nossum 		spec->type = FORMAT_TYPE_WIDTH;
1738fef20d9cSFrederic Weisbecker 		return ++fmt - start;
1739fef20d9cSFrederic Weisbecker 	}
1740fef20d9cSFrederic Weisbecker 
1741fef20d9cSFrederic Weisbecker precision:
1742fef20d9cSFrederic Weisbecker 	/* get the precision */
1743fef20d9cSFrederic Weisbecker 	spec->precision = -1;
1744fef20d9cSFrederic Weisbecker 	if (*fmt == '.') {
1745fef20d9cSFrederic Weisbecker 		++fmt;
1746fef20d9cSFrederic Weisbecker 		if (isdigit(*fmt)) {
1747fef20d9cSFrederic Weisbecker 			spec->precision = skip_atoi(&fmt);
1748fef20d9cSFrederic Weisbecker 			if (spec->precision < 0)
1749fef20d9cSFrederic Weisbecker 				spec->precision = 0;
1750fef20d9cSFrederic Weisbecker 		} else if (*fmt == '*') {
1751fef20d9cSFrederic Weisbecker 			/* it's the next argument */
1752adf26f84SVegard Nossum 			spec->type = FORMAT_TYPE_PRECISION;
1753fef20d9cSFrederic Weisbecker 			return ++fmt - start;
1754fef20d9cSFrederic Weisbecker 		}
1755fef20d9cSFrederic Weisbecker 	}
1756fef20d9cSFrederic Weisbecker 
1757fef20d9cSFrederic Weisbecker qualifier:
1758fef20d9cSFrederic Weisbecker 	/* get the conversion qualifier */
1759d0484193SRasmus Villemoes 	qualifier = 0;
176075fb8f26SAndy Shevchenko 	if (*fmt == 'h' || _tolower(*fmt) == 'l' ||
176175fb8f26SAndy Shevchenko 	    _tolower(*fmt) == 'z' || *fmt == 't') {
1762d0484193SRasmus Villemoes 		qualifier = *fmt++;
1763d0484193SRasmus Villemoes 		if (unlikely(qualifier == *fmt)) {
1764d0484193SRasmus Villemoes 			if (qualifier == 'l') {
1765d0484193SRasmus Villemoes 				qualifier = 'L';
1766fef20d9cSFrederic Weisbecker 				++fmt;
1767d0484193SRasmus Villemoes 			} else if (qualifier == 'h') {
1768d0484193SRasmus Villemoes 				qualifier = 'H';
1769a4e94ef0SZhaolei 				++fmt;
1770a4e94ef0SZhaolei 			}
1771fef20d9cSFrederic Weisbecker 		}
1772fef20d9cSFrederic Weisbecker 	}
1773fef20d9cSFrederic Weisbecker 
1774fef20d9cSFrederic Weisbecker 	/* default base */
1775fef20d9cSFrederic Weisbecker 	spec->base = 10;
1776fef20d9cSFrederic Weisbecker 	switch (*fmt) {
1777fef20d9cSFrederic Weisbecker 	case 'c':
1778fef20d9cSFrederic Weisbecker 		spec->type = FORMAT_TYPE_CHAR;
1779fef20d9cSFrederic Weisbecker 		return ++fmt - start;
1780fef20d9cSFrederic Weisbecker 
1781fef20d9cSFrederic Weisbecker 	case 's':
1782fef20d9cSFrederic Weisbecker 		spec->type = FORMAT_TYPE_STR;
1783fef20d9cSFrederic Weisbecker 		return ++fmt - start;
1784fef20d9cSFrederic Weisbecker 
1785fef20d9cSFrederic Weisbecker 	case 'p':
1786fef20d9cSFrederic Weisbecker 		spec->type = FORMAT_TYPE_PTR;
1787ffbfed03SRasmus Villemoes 		return ++fmt - start;
1788fef20d9cSFrederic Weisbecker 
1789fef20d9cSFrederic Weisbecker 	case '%':
1790fef20d9cSFrederic Weisbecker 		spec->type = FORMAT_TYPE_PERCENT_CHAR;
1791fef20d9cSFrederic Weisbecker 		return ++fmt - start;
1792fef20d9cSFrederic Weisbecker 
1793fef20d9cSFrederic Weisbecker 	/* integer number formats - set up the flags and "break" */
1794fef20d9cSFrederic Weisbecker 	case 'o':
1795fef20d9cSFrederic Weisbecker 		spec->base = 8;
1796fef20d9cSFrederic Weisbecker 		break;
1797fef20d9cSFrederic Weisbecker 
1798fef20d9cSFrederic Weisbecker 	case 'x':
1799fef20d9cSFrederic Weisbecker 		spec->flags |= SMALL;
1800fef20d9cSFrederic Weisbecker 
1801fef20d9cSFrederic Weisbecker 	case 'X':
1802fef20d9cSFrederic Weisbecker 		spec->base = 16;
1803fef20d9cSFrederic Weisbecker 		break;
1804fef20d9cSFrederic Weisbecker 
1805fef20d9cSFrederic Weisbecker 	case 'd':
1806fef20d9cSFrederic Weisbecker 	case 'i':
180739e874f8SFrederic Weisbecker 		spec->flags |= SIGN;
1808fef20d9cSFrederic Weisbecker 	case 'u':
1809fef20d9cSFrederic Weisbecker 		break;
1810fef20d9cSFrederic Weisbecker 
1811708d96fdSRyan Mallon 	case 'n':
1812708d96fdSRyan Mallon 		/*
1813b006f19bSRasmus Villemoes 		 * Since %n poses a greater security risk than
1814b006f19bSRasmus Villemoes 		 * utility, treat it as any other invalid or
1815b006f19bSRasmus Villemoes 		 * unsupported format specifier.
1816708d96fdSRyan Mallon 		 */
1817708d96fdSRyan Mallon 		/* Fall-through */
1818708d96fdSRyan Mallon 
1819fef20d9cSFrederic Weisbecker 	default:
1820b006f19bSRasmus Villemoes 		WARN_ONCE(1, "Please remove unsupported %%%c in format string\n", *fmt);
1821fef20d9cSFrederic Weisbecker 		spec->type = FORMAT_TYPE_INVALID;
1822fef20d9cSFrederic Weisbecker 		return fmt - start;
1823fef20d9cSFrederic Weisbecker 	}
1824fef20d9cSFrederic Weisbecker 
1825d0484193SRasmus Villemoes 	if (qualifier == 'L')
1826fef20d9cSFrederic Weisbecker 		spec->type = FORMAT_TYPE_LONG_LONG;
1827d0484193SRasmus Villemoes 	else if (qualifier == 'l') {
182851be17dfSRasmus Villemoes 		BUILD_BUG_ON(FORMAT_TYPE_ULONG + SIGN != FORMAT_TYPE_LONG);
182951be17dfSRasmus Villemoes 		spec->type = FORMAT_TYPE_ULONG + (spec->flags & SIGN);
1830d0484193SRasmus Villemoes 	} else if (_tolower(qualifier) == 'z') {
1831fef20d9cSFrederic Weisbecker 		spec->type = FORMAT_TYPE_SIZE_T;
1832d0484193SRasmus Villemoes 	} else if (qualifier == 't') {
1833fef20d9cSFrederic Weisbecker 		spec->type = FORMAT_TYPE_PTRDIFF;
1834d0484193SRasmus Villemoes 	} else if (qualifier == 'H') {
183551be17dfSRasmus Villemoes 		BUILD_BUG_ON(FORMAT_TYPE_UBYTE + SIGN != FORMAT_TYPE_BYTE);
183651be17dfSRasmus Villemoes 		spec->type = FORMAT_TYPE_UBYTE + (spec->flags & SIGN);
1837d0484193SRasmus Villemoes 	} else if (qualifier == 'h') {
183851be17dfSRasmus Villemoes 		BUILD_BUG_ON(FORMAT_TYPE_USHORT + SIGN != FORMAT_TYPE_SHORT);
183951be17dfSRasmus Villemoes 		spec->type = FORMAT_TYPE_USHORT + (spec->flags & SIGN);
1840fef20d9cSFrederic Weisbecker 	} else {
184151be17dfSRasmus Villemoes 		BUILD_BUG_ON(FORMAT_TYPE_UINT + SIGN != FORMAT_TYPE_INT);
184251be17dfSRasmus Villemoes 		spec->type = FORMAT_TYPE_UINT + (spec->flags & SIGN);
1843fef20d9cSFrederic Weisbecker 	}
1844fef20d9cSFrederic Weisbecker 
1845fef20d9cSFrederic Weisbecker 	return ++fmt - start;
184678a8bf69SLinus Torvalds }
184778a8bf69SLinus Torvalds 
18481da177e4SLinus Torvalds /**
18491da177e4SLinus Torvalds  * vsnprintf - Format a string and place it in a buffer
18501da177e4SLinus Torvalds  * @buf: The buffer to place the result into
18511da177e4SLinus Torvalds  * @size: The size of the buffer, including the trailing null space
18521da177e4SLinus Torvalds  * @fmt: The format string to use
18531da177e4SLinus Torvalds  * @args: Arguments for the format string
18541da177e4SLinus Torvalds  *
1855d7ec9a05SRasmus Villemoes  * This function generally follows C99 vsnprintf, but has some
1856d7ec9a05SRasmus Villemoes  * extensions and a few limitations:
1857d7ec9a05SRasmus Villemoes  *
1858d7ec9a05SRasmus Villemoes  * %n is unsupported
18595e4ee7b1SMartin Kletzander  * %p* is handled by pointer()
186020036fdcSAndi Kleen  *
18615e4ee7b1SMartin Kletzander  * See pointer() or Documentation/printk-formats.txt for more
18625e4ee7b1SMartin Kletzander  * extensive description.
18635e4ee7b1SMartin Kletzander  *
18645e4ee7b1SMartin Kletzander  * ** Please update the documentation in both places when making changes **
186580f548e0SAndrew Morton  *
18661da177e4SLinus Torvalds  * The return value is the number of characters which would
18671da177e4SLinus Torvalds  * be generated for the given input, excluding the trailing
18681da177e4SLinus Torvalds  * '\0', as per ISO C99. If you want to have the exact
18691da177e4SLinus Torvalds  * number of characters written into @buf as return value
187072fd4a35SRobert P. J. Day  * (not including the trailing '\0'), use vscnprintf(). If the
18711da177e4SLinus Torvalds  * return is greater than or equal to @size, the resulting
18721da177e4SLinus Torvalds  * string is truncated.
18731da177e4SLinus Torvalds  *
1874ba1835ebSUwe Kleine-König  * If you're not already dealing with a va_list consider using snprintf().
18751da177e4SLinus Torvalds  */
18761da177e4SLinus Torvalds int vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
18771da177e4SLinus Torvalds {
18781da177e4SLinus Torvalds 	unsigned long long num;
1879d4be151bSAndré Goddard Rosa 	char *str, *end;
1880fef20d9cSFrederic Weisbecker 	struct printf_spec spec = {0};
18811da177e4SLinus Torvalds 
1882f796937aSJeremy Fitzhardinge 	/* Reject out-of-range values early.  Large positive sizes are
1883f796937aSJeremy Fitzhardinge 	   used for unknown buffer sizes. */
18842aa2f9e2SRasmus Villemoes 	if (WARN_ON_ONCE(size > INT_MAX))
18851da177e4SLinus Torvalds 		return 0;
18861da177e4SLinus Torvalds 
18871da177e4SLinus Torvalds 	str = buf;
1888f796937aSJeremy Fitzhardinge 	end = buf + size;
18891da177e4SLinus Torvalds 
1890f796937aSJeremy Fitzhardinge 	/* Make sure end is always >= buf */
1891f796937aSJeremy Fitzhardinge 	if (end < buf) {
18921da177e4SLinus Torvalds 		end = ((void *)-1);
1893f796937aSJeremy Fitzhardinge 		size = end - buf;
18941da177e4SLinus Torvalds 	}
18951da177e4SLinus Torvalds 
1896fef20d9cSFrederic Weisbecker 	while (*fmt) {
1897fef20d9cSFrederic Weisbecker 		const char *old_fmt = fmt;
1898d4be151bSAndré Goddard Rosa 		int read = format_decode(fmt, &spec);
1899fef20d9cSFrederic Weisbecker 
1900fef20d9cSFrederic Weisbecker 		fmt += read;
1901fef20d9cSFrederic Weisbecker 
1902fef20d9cSFrederic Weisbecker 		switch (spec.type) {
1903fef20d9cSFrederic Weisbecker 		case FORMAT_TYPE_NONE: {
1904fef20d9cSFrederic Weisbecker 			int copy = read;
1905fef20d9cSFrederic Weisbecker 			if (str < end) {
1906fef20d9cSFrederic Weisbecker 				if (copy > end - str)
1907fef20d9cSFrederic Weisbecker 					copy = end - str;
1908fef20d9cSFrederic Weisbecker 				memcpy(str, old_fmt, copy);
1909fef20d9cSFrederic Weisbecker 			}
1910fef20d9cSFrederic Weisbecker 			str += read;
1911fef20d9cSFrederic Weisbecker 			break;
19121da177e4SLinus Torvalds 		}
19131da177e4SLinus Torvalds 
1914ed681a91SVegard Nossum 		case FORMAT_TYPE_WIDTH:
1915fef20d9cSFrederic Weisbecker 			spec.field_width = va_arg(args, int);
1916fef20d9cSFrederic Weisbecker 			break;
19171da177e4SLinus Torvalds 
1918fef20d9cSFrederic Weisbecker 		case FORMAT_TYPE_PRECISION:
1919fef20d9cSFrederic Weisbecker 			spec.precision = va_arg(args, int);
1920fef20d9cSFrederic Weisbecker 			break;
19211da177e4SLinus Torvalds 
1922d4be151bSAndré Goddard Rosa 		case FORMAT_TYPE_CHAR: {
1923d4be151bSAndré Goddard Rosa 			char c;
1924d4be151bSAndré Goddard Rosa 
1925fef20d9cSFrederic Weisbecker 			if (!(spec.flags & LEFT)) {
1926fef20d9cSFrederic Weisbecker 				while (--spec.field_width > 0) {
1927f796937aSJeremy Fitzhardinge 					if (str < end)
19281da177e4SLinus Torvalds 						*str = ' ';
19291da177e4SLinus Torvalds 					++str;
1930fef20d9cSFrederic Weisbecker 
19311da177e4SLinus Torvalds 				}
19321da177e4SLinus Torvalds 			}
19331da177e4SLinus Torvalds 			c = (unsigned char) va_arg(args, int);
1934f796937aSJeremy Fitzhardinge 			if (str < end)
19351da177e4SLinus Torvalds 				*str = c;
19361da177e4SLinus Torvalds 			++str;
1937fef20d9cSFrederic Weisbecker 			while (--spec.field_width > 0) {
1938f796937aSJeremy Fitzhardinge 				if (str < end)
19391da177e4SLinus Torvalds 					*str = ' ';
19401da177e4SLinus Torvalds 				++str;
19411da177e4SLinus Torvalds 			}
1942fef20d9cSFrederic Weisbecker 			break;
1943d4be151bSAndré Goddard Rosa 		}
19441da177e4SLinus Torvalds 
1945fef20d9cSFrederic Weisbecker 		case FORMAT_TYPE_STR:
1946fef20d9cSFrederic Weisbecker 			str = string(str, end, va_arg(args, char *), spec);
1947fef20d9cSFrederic Weisbecker 			break;
19481da177e4SLinus Torvalds 
1949fef20d9cSFrederic Weisbecker 		case FORMAT_TYPE_PTR:
1950ffbfed03SRasmus Villemoes 			str = pointer(fmt, str, end, va_arg(args, void *),
1951fef20d9cSFrederic Weisbecker 				      spec);
1952fef20d9cSFrederic Weisbecker 			while (isalnum(*fmt))
19534d8a743cSLinus Torvalds 				fmt++;
1954fef20d9cSFrederic Weisbecker 			break;
19551da177e4SLinus Torvalds 
1956fef20d9cSFrederic Weisbecker 		case FORMAT_TYPE_PERCENT_CHAR:
1957f796937aSJeremy Fitzhardinge 			if (str < end)
19581da177e4SLinus Torvalds 				*str = '%';
19591da177e4SLinus Torvalds 			++str;
19601da177e4SLinus Torvalds 			break;
19611da177e4SLinus Torvalds 
1962fef20d9cSFrederic Weisbecker 		case FORMAT_TYPE_INVALID:
1963b006f19bSRasmus Villemoes 			/*
1964b006f19bSRasmus Villemoes 			 * Presumably the arguments passed gcc's type
1965b006f19bSRasmus Villemoes 			 * checking, but there is no safe or sane way
1966b006f19bSRasmus Villemoes 			 * for us to continue parsing the format and
1967b006f19bSRasmus Villemoes 			 * fetching from the va_list; the remaining
1968b006f19bSRasmus Villemoes 			 * specifiers and arguments would be out of
1969b006f19bSRasmus Villemoes 			 * sync.
1970b006f19bSRasmus Villemoes 			 */
1971b006f19bSRasmus Villemoes 			goto out;
1972fef20d9cSFrederic Weisbecker 
1973fef20d9cSFrederic Weisbecker 		default:
1974fef20d9cSFrederic Weisbecker 			switch (spec.type) {
1975fef20d9cSFrederic Weisbecker 			case FORMAT_TYPE_LONG_LONG:
1976fef20d9cSFrederic Weisbecker 				num = va_arg(args, long long);
1977fef20d9cSFrederic Weisbecker 				break;
1978fef20d9cSFrederic Weisbecker 			case FORMAT_TYPE_ULONG:
1979fef20d9cSFrederic Weisbecker 				num = va_arg(args, unsigned long);
1980fef20d9cSFrederic Weisbecker 				break;
1981fef20d9cSFrederic Weisbecker 			case FORMAT_TYPE_LONG:
1982fef20d9cSFrederic Weisbecker 				num = va_arg(args, long);
1983fef20d9cSFrederic Weisbecker 				break;
1984fef20d9cSFrederic Weisbecker 			case FORMAT_TYPE_SIZE_T:
1985ef124960SJason Gunthorpe 				if (spec.flags & SIGN)
1986ef124960SJason Gunthorpe 					num = va_arg(args, ssize_t);
1987ef124960SJason Gunthorpe 				else
1988fef20d9cSFrederic Weisbecker 					num = va_arg(args, size_t);
1989fef20d9cSFrederic Weisbecker 				break;
1990fef20d9cSFrederic Weisbecker 			case FORMAT_TYPE_PTRDIFF:
1991fef20d9cSFrederic Weisbecker 				num = va_arg(args, ptrdiff_t);
1992fef20d9cSFrederic Weisbecker 				break;
1993a4e94ef0SZhaolei 			case FORMAT_TYPE_UBYTE:
1994a4e94ef0SZhaolei 				num = (unsigned char) va_arg(args, int);
1995a4e94ef0SZhaolei 				break;
1996a4e94ef0SZhaolei 			case FORMAT_TYPE_BYTE:
1997a4e94ef0SZhaolei 				num = (signed char) va_arg(args, int);
1998a4e94ef0SZhaolei 				break;
1999fef20d9cSFrederic Weisbecker 			case FORMAT_TYPE_USHORT:
2000fef20d9cSFrederic Weisbecker 				num = (unsigned short) va_arg(args, int);
2001fef20d9cSFrederic Weisbecker 				break;
2002fef20d9cSFrederic Weisbecker 			case FORMAT_TYPE_SHORT:
2003fef20d9cSFrederic Weisbecker 				num = (short) va_arg(args, int);
2004fef20d9cSFrederic Weisbecker 				break;
200539e874f8SFrederic Weisbecker 			case FORMAT_TYPE_INT:
200639e874f8SFrederic Weisbecker 				num = (int) va_arg(args, int);
2007fef20d9cSFrederic Weisbecker 				break;
2008fef20d9cSFrederic Weisbecker 			default:
2009fef20d9cSFrederic Weisbecker 				num = va_arg(args, unsigned int);
20101da177e4SLinus Torvalds 			}
2011fef20d9cSFrederic Weisbecker 
2012fef20d9cSFrederic Weisbecker 			str = number(str, end, num, spec);
20131da177e4SLinus Torvalds 		}
2014fef20d9cSFrederic Weisbecker 	}
2015fef20d9cSFrederic Weisbecker 
2016b006f19bSRasmus Villemoes out:
2017f796937aSJeremy Fitzhardinge 	if (size > 0) {
2018f796937aSJeremy Fitzhardinge 		if (str < end)
20191da177e4SLinus Torvalds 			*str = '\0';
2020f796937aSJeremy Fitzhardinge 		else
20210a6047eeSLinus Torvalds 			end[-1] = '\0';
2022f796937aSJeremy Fitzhardinge 	}
2023fef20d9cSFrederic Weisbecker 
2024f796937aSJeremy Fitzhardinge 	/* the trailing null byte doesn't count towards the total */
20251da177e4SLinus Torvalds 	return str-buf;
2026fef20d9cSFrederic Weisbecker 
20271da177e4SLinus Torvalds }
20281da177e4SLinus Torvalds EXPORT_SYMBOL(vsnprintf);
20291da177e4SLinus Torvalds 
20301da177e4SLinus Torvalds /**
20311da177e4SLinus Torvalds  * vscnprintf - Format a string and place it in a buffer
20321da177e4SLinus Torvalds  * @buf: The buffer to place the result into
20331da177e4SLinus Torvalds  * @size: The size of the buffer, including the trailing null space
20341da177e4SLinus Torvalds  * @fmt: The format string to use
20351da177e4SLinus Torvalds  * @args: Arguments for the format string
20361da177e4SLinus Torvalds  *
20371da177e4SLinus Torvalds  * The return value is the number of characters which have been written into
2038b921c69fSAnton Arapov  * the @buf not including the trailing '\0'. If @size is == 0 the function
20391da177e4SLinus Torvalds  * returns 0.
20401da177e4SLinus Torvalds  *
2041ba1835ebSUwe Kleine-König  * If you're not already dealing with a va_list consider using scnprintf().
204220036fdcSAndi Kleen  *
204320036fdcSAndi Kleen  * See the vsnprintf() documentation for format string extensions over C99.
20441da177e4SLinus Torvalds  */
20451da177e4SLinus Torvalds int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
20461da177e4SLinus Torvalds {
20471da177e4SLinus Torvalds 	int i;
20481da177e4SLinus Torvalds 
20491da177e4SLinus Torvalds 	i = vsnprintf(buf, size, fmt, args);
20507b9186f5SAndré Goddard Rosa 
2051b921c69fSAnton Arapov 	if (likely(i < size))
2052b921c69fSAnton Arapov 		return i;
2053b921c69fSAnton Arapov 	if (size != 0)
2054b921c69fSAnton Arapov 		return size - 1;
2055b921c69fSAnton Arapov 	return 0;
20561da177e4SLinus Torvalds }
20571da177e4SLinus Torvalds EXPORT_SYMBOL(vscnprintf);
20581da177e4SLinus Torvalds 
20591da177e4SLinus Torvalds /**
20601da177e4SLinus Torvalds  * snprintf - Format a string and place it in a buffer
20611da177e4SLinus Torvalds  * @buf: The buffer to place the result into
20621da177e4SLinus Torvalds  * @size: The size of the buffer, including the trailing null space
20631da177e4SLinus Torvalds  * @fmt: The format string to use
20641da177e4SLinus Torvalds  * @...: Arguments for the format string
20651da177e4SLinus Torvalds  *
20661da177e4SLinus Torvalds  * The return value is the number of characters which would be
20671da177e4SLinus Torvalds  * generated for the given input, excluding the trailing null,
20681da177e4SLinus Torvalds  * as per ISO C99.  If the return is greater than or equal to
20691da177e4SLinus Torvalds  * @size, the resulting string is truncated.
207020036fdcSAndi Kleen  *
207120036fdcSAndi Kleen  * See the vsnprintf() documentation for format string extensions over C99.
20721da177e4SLinus Torvalds  */
20731da177e4SLinus Torvalds int snprintf(char *buf, size_t size, const char *fmt, ...)
20741da177e4SLinus Torvalds {
20751da177e4SLinus Torvalds 	va_list args;
20761da177e4SLinus Torvalds 	int i;
20771da177e4SLinus Torvalds 
20781da177e4SLinus Torvalds 	va_start(args, fmt);
20791da177e4SLinus Torvalds 	i = vsnprintf(buf, size, fmt, args);
20801da177e4SLinus Torvalds 	va_end(args);
20817b9186f5SAndré Goddard Rosa 
20821da177e4SLinus Torvalds 	return i;
20831da177e4SLinus Torvalds }
20841da177e4SLinus Torvalds EXPORT_SYMBOL(snprintf);
20851da177e4SLinus Torvalds 
20861da177e4SLinus Torvalds /**
20871da177e4SLinus Torvalds  * scnprintf - Format a string and place it in a buffer
20881da177e4SLinus Torvalds  * @buf: The buffer to place the result into
20891da177e4SLinus Torvalds  * @size: The size of the buffer, including the trailing null space
20901da177e4SLinus Torvalds  * @fmt: The format string to use
20911da177e4SLinus Torvalds  * @...: Arguments for the format string
20921da177e4SLinus Torvalds  *
20931da177e4SLinus Torvalds  * The return value is the number of characters written into @buf not including
2094b903c0b8SChangli Gao  * the trailing '\0'. If @size is == 0 the function returns 0.
20951da177e4SLinus Torvalds  */
20961da177e4SLinus Torvalds 
20971da177e4SLinus Torvalds int scnprintf(char *buf, size_t size, const char *fmt, ...)
20981da177e4SLinus Torvalds {
20991da177e4SLinus Torvalds 	va_list args;
21001da177e4SLinus Torvalds 	int i;
21011da177e4SLinus Torvalds 
21021da177e4SLinus Torvalds 	va_start(args, fmt);
2103b921c69fSAnton Arapov 	i = vscnprintf(buf, size, fmt, args);
21041da177e4SLinus Torvalds 	va_end(args);
21057b9186f5SAndré Goddard Rosa 
2106b903c0b8SChangli Gao 	return i;
21071da177e4SLinus Torvalds }
21081da177e4SLinus Torvalds EXPORT_SYMBOL(scnprintf);
21091da177e4SLinus Torvalds 
21101da177e4SLinus Torvalds /**
21111da177e4SLinus Torvalds  * vsprintf - Format a string and place it in a buffer
21121da177e4SLinus Torvalds  * @buf: The buffer to place the result into
21131da177e4SLinus Torvalds  * @fmt: The format string to use
21141da177e4SLinus Torvalds  * @args: Arguments for the format string
21151da177e4SLinus Torvalds  *
21161da177e4SLinus Torvalds  * The function returns the number of characters written
211772fd4a35SRobert P. J. Day  * into @buf. Use vsnprintf() or vscnprintf() in order to avoid
21181da177e4SLinus Torvalds  * buffer overflows.
21191da177e4SLinus Torvalds  *
2120ba1835ebSUwe Kleine-König  * If you're not already dealing with a va_list consider using sprintf().
212120036fdcSAndi Kleen  *
212220036fdcSAndi Kleen  * See the vsnprintf() documentation for format string extensions over C99.
21231da177e4SLinus Torvalds  */
21241da177e4SLinus Torvalds int vsprintf(char *buf, const char *fmt, va_list args)
21251da177e4SLinus Torvalds {
21261da177e4SLinus Torvalds 	return vsnprintf(buf, INT_MAX, fmt, args);
21271da177e4SLinus Torvalds }
21281da177e4SLinus Torvalds EXPORT_SYMBOL(vsprintf);
21291da177e4SLinus Torvalds 
21301da177e4SLinus Torvalds /**
21311da177e4SLinus Torvalds  * sprintf - Format a string and place it in a buffer
21321da177e4SLinus Torvalds  * @buf: The buffer to place the result into
21331da177e4SLinus Torvalds  * @fmt: The format string to use
21341da177e4SLinus Torvalds  * @...: Arguments for the format string
21351da177e4SLinus Torvalds  *
21361da177e4SLinus Torvalds  * The function returns the number of characters written
213772fd4a35SRobert P. J. Day  * into @buf. Use snprintf() or scnprintf() in order to avoid
21381da177e4SLinus Torvalds  * buffer overflows.
213920036fdcSAndi Kleen  *
214020036fdcSAndi Kleen  * See the vsnprintf() documentation for format string extensions over C99.
21411da177e4SLinus Torvalds  */
21421da177e4SLinus Torvalds int sprintf(char *buf, const char *fmt, ...)
21431da177e4SLinus Torvalds {
21441da177e4SLinus Torvalds 	va_list args;
21451da177e4SLinus Torvalds 	int i;
21461da177e4SLinus Torvalds 
21471da177e4SLinus Torvalds 	va_start(args, fmt);
21481da177e4SLinus Torvalds 	i = vsnprintf(buf, INT_MAX, fmt, args);
21491da177e4SLinus Torvalds 	va_end(args);
21507b9186f5SAndré Goddard Rosa 
21511da177e4SLinus Torvalds 	return i;
21521da177e4SLinus Torvalds }
21531da177e4SLinus Torvalds EXPORT_SYMBOL(sprintf);
21541da177e4SLinus Torvalds 
21554370aa4aSLai Jiangshan #ifdef CONFIG_BINARY_PRINTF
21564370aa4aSLai Jiangshan /*
21574370aa4aSLai Jiangshan  * bprintf service:
21584370aa4aSLai Jiangshan  * vbin_printf() - VA arguments to binary data
21594370aa4aSLai Jiangshan  * bstr_printf() - Binary data to text string
21604370aa4aSLai Jiangshan  */
21614370aa4aSLai Jiangshan 
21624370aa4aSLai Jiangshan /**
21634370aa4aSLai Jiangshan  * vbin_printf - Parse a format string and place args' binary value in a buffer
21644370aa4aSLai Jiangshan  * @bin_buf: The buffer to place args' binary value
21654370aa4aSLai Jiangshan  * @size: The size of the buffer(by words(32bits), not characters)
21664370aa4aSLai Jiangshan  * @fmt: The format string to use
21674370aa4aSLai Jiangshan  * @args: Arguments for the format string
21684370aa4aSLai Jiangshan  *
21694370aa4aSLai Jiangshan  * The format follows C99 vsnprintf, except %n is ignored, and its argument
2170da3dae54SMasanari Iida  * is skipped.
21714370aa4aSLai Jiangshan  *
21724370aa4aSLai Jiangshan  * The return value is the number of words(32bits) which would be generated for
21734370aa4aSLai Jiangshan  * the given input.
21744370aa4aSLai Jiangshan  *
21754370aa4aSLai Jiangshan  * NOTE:
21764370aa4aSLai Jiangshan  * If the return value is greater than @size, the resulting bin_buf is NOT
21774370aa4aSLai Jiangshan  * valid for bstr_printf().
21784370aa4aSLai Jiangshan  */
21794370aa4aSLai Jiangshan int vbin_printf(u32 *bin_buf, size_t size, const char *fmt, va_list args)
21804370aa4aSLai Jiangshan {
2181fef20d9cSFrederic Weisbecker 	struct printf_spec spec = {0};
21824370aa4aSLai Jiangshan 	char *str, *end;
21834370aa4aSLai Jiangshan 
21844370aa4aSLai Jiangshan 	str = (char *)bin_buf;
21854370aa4aSLai Jiangshan 	end = (char *)(bin_buf + size);
21864370aa4aSLai Jiangshan 
21874370aa4aSLai Jiangshan #define save_arg(type)							\
21884370aa4aSLai Jiangshan do {									\
21894370aa4aSLai Jiangshan 	if (sizeof(type) == 8) {					\
21904370aa4aSLai Jiangshan 		unsigned long long value;				\
21914370aa4aSLai Jiangshan 		str = PTR_ALIGN(str, sizeof(u32));			\
21924370aa4aSLai Jiangshan 		value = va_arg(args, unsigned long long);		\
21934370aa4aSLai Jiangshan 		if (str + sizeof(type) <= end) {			\
21944370aa4aSLai Jiangshan 			*(u32 *)str = *(u32 *)&value;			\
21954370aa4aSLai Jiangshan 			*(u32 *)(str + 4) = *((u32 *)&value + 1);	\
21964370aa4aSLai Jiangshan 		}							\
21974370aa4aSLai Jiangshan 	} else {							\
21984370aa4aSLai Jiangshan 		unsigned long value;					\
21994370aa4aSLai Jiangshan 		str = PTR_ALIGN(str, sizeof(type));			\
22004370aa4aSLai Jiangshan 		value = va_arg(args, int);				\
22014370aa4aSLai Jiangshan 		if (str + sizeof(type) <= end)				\
22024370aa4aSLai Jiangshan 			*(typeof(type) *)str = (type)value;		\
22034370aa4aSLai Jiangshan 	}								\
22044370aa4aSLai Jiangshan 	str += sizeof(type);						\
22054370aa4aSLai Jiangshan } while (0)
22064370aa4aSLai Jiangshan 
2207fef20d9cSFrederic Weisbecker 	while (*fmt) {
2208d4be151bSAndré Goddard Rosa 		int read = format_decode(fmt, &spec);
22094370aa4aSLai Jiangshan 
2210fef20d9cSFrederic Weisbecker 		fmt += read;
2211fef20d9cSFrederic Weisbecker 
2212fef20d9cSFrederic Weisbecker 		switch (spec.type) {
2213fef20d9cSFrederic Weisbecker 		case FORMAT_TYPE_NONE:
2214d4be151bSAndré Goddard Rosa 		case FORMAT_TYPE_PERCENT_CHAR:
2215fef20d9cSFrederic Weisbecker 			break;
2216b006f19bSRasmus Villemoes 		case FORMAT_TYPE_INVALID:
2217b006f19bSRasmus Villemoes 			goto out;
2218fef20d9cSFrederic Weisbecker 
2219ed681a91SVegard Nossum 		case FORMAT_TYPE_WIDTH:
2220fef20d9cSFrederic Weisbecker 		case FORMAT_TYPE_PRECISION:
22214370aa4aSLai Jiangshan 			save_arg(int);
2222fef20d9cSFrederic Weisbecker 			break;
22234370aa4aSLai Jiangshan 
2224fef20d9cSFrederic Weisbecker 		case FORMAT_TYPE_CHAR:
22254370aa4aSLai Jiangshan 			save_arg(char);
2226fef20d9cSFrederic Weisbecker 			break;
2227fef20d9cSFrederic Weisbecker 
2228fef20d9cSFrederic Weisbecker 		case FORMAT_TYPE_STR: {
22294370aa4aSLai Jiangshan 			const char *save_str = va_arg(args, char *);
22304370aa4aSLai Jiangshan 			size_t len;
22316c356634SAndré Goddard Rosa 
22324370aa4aSLai Jiangshan 			if ((unsigned long)save_str > (unsigned long)-PAGE_SIZE
22334370aa4aSLai Jiangshan 					|| (unsigned long)save_str < PAGE_SIZE)
22340f4f81dcSAndré Goddard Rosa 				save_str = "(null)";
22356c356634SAndré Goddard Rosa 			len = strlen(save_str) + 1;
22366c356634SAndré Goddard Rosa 			if (str + len < end)
22376c356634SAndré Goddard Rosa 				memcpy(str, save_str, len);
22386c356634SAndré Goddard Rosa 			str += len;
2239fef20d9cSFrederic Weisbecker 			break;
22404370aa4aSLai Jiangshan 		}
2241fef20d9cSFrederic Weisbecker 
2242fef20d9cSFrederic Weisbecker 		case FORMAT_TYPE_PTR:
22434370aa4aSLai Jiangshan 			save_arg(void *);
22444370aa4aSLai Jiangshan 			/* skip all alphanumeric pointer suffixes */
2245fef20d9cSFrederic Weisbecker 			while (isalnum(*fmt))
22464370aa4aSLai Jiangshan 				fmt++;
2247fef20d9cSFrederic Weisbecker 			break;
2248fef20d9cSFrederic Weisbecker 
2249fef20d9cSFrederic Weisbecker 		default:
2250fef20d9cSFrederic Weisbecker 			switch (spec.type) {
2251fef20d9cSFrederic Weisbecker 
2252fef20d9cSFrederic Weisbecker 			case FORMAT_TYPE_LONG_LONG:
2253fef20d9cSFrederic Weisbecker 				save_arg(long long);
2254fef20d9cSFrederic Weisbecker 				break;
2255fef20d9cSFrederic Weisbecker 			case FORMAT_TYPE_ULONG:
2256fef20d9cSFrederic Weisbecker 			case FORMAT_TYPE_LONG:
2257fef20d9cSFrederic Weisbecker 				save_arg(unsigned long);
2258fef20d9cSFrederic Weisbecker 				break;
2259fef20d9cSFrederic Weisbecker 			case FORMAT_TYPE_SIZE_T:
2260fef20d9cSFrederic Weisbecker 				save_arg(size_t);
2261fef20d9cSFrederic Weisbecker 				break;
2262fef20d9cSFrederic Weisbecker 			case FORMAT_TYPE_PTRDIFF:
2263fef20d9cSFrederic Weisbecker 				save_arg(ptrdiff_t);
2264fef20d9cSFrederic Weisbecker 				break;
2265a4e94ef0SZhaolei 			case FORMAT_TYPE_UBYTE:
2266a4e94ef0SZhaolei 			case FORMAT_TYPE_BYTE:
2267a4e94ef0SZhaolei 				save_arg(char);
2268a4e94ef0SZhaolei 				break;
2269fef20d9cSFrederic Weisbecker 			case FORMAT_TYPE_USHORT:
2270fef20d9cSFrederic Weisbecker 			case FORMAT_TYPE_SHORT:
2271fef20d9cSFrederic Weisbecker 				save_arg(short);
2272fef20d9cSFrederic Weisbecker 				break;
2273fef20d9cSFrederic Weisbecker 			default:
2274fef20d9cSFrederic Weisbecker 				save_arg(int);
2275fef20d9cSFrederic Weisbecker 			}
2276fef20d9cSFrederic Weisbecker 		}
2277fef20d9cSFrederic Weisbecker 	}
2278fef20d9cSFrederic Weisbecker 
2279b006f19bSRasmus Villemoes out:
22807b9186f5SAndré Goddard Rosa 	return (u32 *)(PTR_ALIGN(str, sizeof(u32))) - bin_buf;
2281fef20d9cSFrederic Weisbecker #undef save_arg
22824370aa4aSLai Jiangshan }
22834370aa4aSLai Jiangshan EXPORT_SYMBOL_GPL(vbin_printf);
22844370aa4aSLai Jiangshan 
22854370aa4aSLai Jiangshan /**
22864370aa4aSLai Jiangshan  * bstr_printf - Format a string from binary arguments and place it in a buffer
22874370aa4aSLai Jiangshan  * @buf: The buffer to place the result into
22884370aa4aSLai Jiangshan  * @size: The size of the buffer, including the trailing null space
22894370aa4aSLai Jiangshan  * @fmt: The format string to use
22904370aa4aSLai Jiangshan  * @bin_buf: Binary arguments for the format string
22914370aa4aSLai Jiangshan  *
22924370aa4aSLai Jiangshan  * This function like C99 vsnprintf, but the difference is that vsnprintf gets
22934370aa4aSLai Jiangshan  * arguments from stack, and bstr_printf gets arguments from @bin_buf which is
22944370aa4aSLai Jiangshan  * a binary buffer that generated by vbin_printf.
22954370aa4aSLai Jiangshan  *
22964370aa4aSLai Jiangshan  * The format follows C99 vsnprintf, but has some extensions:
22970efb4d20SSteven Rostedt  *  see vsnprintf comment for details.
22984370aa4aSLai Jiangshan  *
22994370aa4aSLai Jiangshan  * The return value is the number of characters which would
23004370aa4aSLai Jiangshan  * be generated for the given input, excluding the trailing
23014370aa4aSLai Jiangshan  * '\0', as per ISO C99. If you want to have the exact
23024370aa4aSLai Jiangshan  * number of characters written into @buf as return value
23034370aa4aSLai Jiangshan  * (not including the trailing '\0'), use vscnprintf(). If the
23044370aa4aSLai Jiangshan  * return is greater than or equal to @size, the resulting
23054370aa4aSLai Jiangshan  * string is truncated.
23064370aa4aSLai Jiangshan  */
23074370aa4aSLai Jiangshan int bstr_printf(char *buf, size_t size, const char *fmt, const u32 *bin_buf)
23084370aa4aSLai Jiangshan {
2309fef20d9cSFrederic Weisbecker 	struct printf_spec spec = {0};
2310d4be151bSAndré Goddard Rosa 	char *str, *end;
2311d4be151bSAndré Goddard Rosa 	const char *args = (const char *)bin_buf;
23124370aa4aSLai Jiangshan 
2313762abb51SRasmus Villemoes 	if (WARN_ON_ONCE(size > INT_MAX))
23144370aa4aSLai Jiangshan 		return 0;
23154370aa4aSLai Jiangshan 
23164370aa4aSLai Jiangshan 	str = buf;
23174370aa4aSLai Jiangshan 	end = buf + size;
23184370aa4aSLai Jiangshan 
23194370aa4aSLai Jiangshan #define get_arg(type)							\
23204370aa4aSLai Jiangshan ({									\
23214370aa4aSLai Jiangshan 	typeof(type) value;						\
23224370aa4aSLai Jiangshan 	if (sizeof(type) == 8) {					\
23234370aa4aSLai Jiangshan 		args = PTR_ALIGN(args, sizeof(u32));			\
23244370aa4aSLai Jiangshan 		*(u32 *)&value = *(u32 *)args;				\
23254370aa4aSLai Jiangshan 		*((u32 *)&value + 1) = *(u32 *)(args + 4);		\
23264370aa4aSLai Jiangshan 	} else {							\
23274370aa4aSLai Jiangshan 		args = PTR_ALIGN(args, sizeof(type));			\
23284370aa4aSLai Jiangshan 		value = *(typeof(type) *)args;				\
23294370aa4aSLai Jiangshan 	}								\
23304370aa4aSLai Jiangshan 	args += sizeof(type);						\
23314370aa4aSLai Jiangshan 	value;								\
23324370aa4aSLai Jiangshan })
23334370aa4aSLai Jiangshan 
23344370aa4aSLai Jiangshan 	/* Make sure end is always >= buf */
23354370aa4aSLai Jiangshan 	if (end < buf) {
23364370aa4aSLai Jiangshan 		end = ((void *)-1);
23374370aa4aSLai Jiangshan 		size = end - buf;
23384370aa4aSLai Jiangshan 	}
23394370aa4aSLai Jiangshan 
2340fef20d9cSFrederic Weisbecker 	while (*fmt) {
2341fef20d9cSFrederic Weisbecker 		const char *old_fmt = fmt;
2342d4be151bSAndré Goddard Rosa 		int read = format_decode(fmt, &spec);
2343fef20d9cSFrederic Weisbecker 
2344fef20d9cSFrederic Weisbecker 		fmt += read;
2345fef20d9cSFrederic Weisbecker 
2346fef20d9cSFrederic Weisbecker 		switch (spec.type) {
2347fef20d9cSFrederic Weisbecker 		case FORMAT_TYPE_NONE: {
2348fef20d9cSFrederic Weisbecker 			int copy = read;
2349fef20d9cSFrederic Weisbecker 			if (str < end) {
2350fef20d9cSFrederic Weisbecker 				if (copy > end - str)
2351fef20d9cSFrederic Weisbecker 					copy = end - str;
2352fef20d9cSFrederic Weisbecker 				memcpy(str, old_fmt, copy);
2353fef20d9cSFrederic Weisbecker 			}
2354fef20d9cSFrederic Weisbecker 			str += read;
2355fef20d9cSFrederic Weisbecker 			break;
23564370aa4aSLai Jiangshan 		}
23574370aa4aSLai Jiangshan 
2358ed681a91SVegard Nossum 		case FORMAT_TYPE_WIDTH:
2359fef20d9cSFrederic Weisbecker 			spec.field_width = get_arg(int);
2360fef20d9cSFrederic Weisbecker 			break;
23614370aa4aSLai Jiangshan 
2362fef20d9cSFrederic Weisbecker 		case FORMAT_TYPE_PRECISION:
2363fef20d9cSFrederic Weisbecker 			spec.precision = get_arg(int);
2364fef20d9cSFrederic Weisbecker 			break;
23654370aa4aSLai Jiangshan 
2366d4be151bSAndré Goddard Rosa 		case FORMAT_TYPE_CHAR: {
2367d4be151bSAndré Goddard Rosa 			char c;
2368d4be151bSAndré Goddard Rosa 
2369fef20d9cSFrederic Weisbecker 			if (!(spec.flags & LEFT)) {
2370fef20d9cSFrederic Weisbecker 				while (--spec.field_width > 0) {
23714370aa4aSLai Jiangshan 					if (str < end)
23724370aa4aSLai Jiangshan 						*str = ' ';
23734370aa4aSLai Jiangshan 					++str;
23744370aa4aSLai Jiangshan 				}
23754370aa4aSLai Jiangshan 			}
23764370aa4aSLai Jiangshan 			c = (unsigned char) get_arg(char);
23774370aa4aSLai Jiangshan 			if (str < end)
23784370aa4aSLai Jiangshan 				*str = c;
23794370aa4aSLai Jiangshan 			++str;
2380fef20d9cSFrederic Weisbecker 			while (--spec.field_width > 0) {
23814370aa4aSLai Jiangshan 				if (str < end)
23824370aa4aSLai Jiangshan 					*str = ' ';
23834370aa4aSLai Jiangshan 				++str;
23844370aa4aSLai Jiangshan 			}
2385fef20d9cSFrederic Weisbecker 			break;
2386d4be151bSAndré Goddard Rosa 		}
23874370aa4aSLai Jiangshan 
2388fef20d9cSFrederic Weisbecker 		case FORMAT_TYPE_STR: {
23894370aa4aSLai Jiangshan 			const char *str_arg = args;
2390d4be151bSAndré Goddard Rosa 			args += strlen(str_arg) + 1;
2391fef20d9cSFrederic Weisbecker 			str = string(str, end, (char *)str_arg, spec);
2392fef20d9cSFrederic Weisbecker 			break;
23934370aa4aSLai Jiangshan 		}
23944370aa4aSLai Jiangshan 
2395fef20d9cSFrederic Weisbecker 		case FORMAT_TYPE_PTR:
2396ffbfed03SRasmus Villemoes 			str = pointer(fmt, str, end, get_arg(void *), spec);
2397fef20d9cSFrederic Weisbecker 			while (isalnum(*fmt))
23984370aa4aSLai Jiangshan 				fmt++;
2399fef20d9cSFrederic Weisbecker 			break;
24004370aa4aSLai Jiangshan 
2401fef20d9cSFrederic Weisbecker 		case FORMAT_TYPE_PERCENT_CHAR:
24024370aa4aSLai Jiangshan 			if (str < end)
24034370aa4aSLai Jiangshan 				*str = '%';
24044370aa4aSLai Jiangshan 			++str;
2405fef20d9cSFrederic Weisbecker 			break;
2406fef20d9cSFrederic Weisbecker 
2407b006f19bSRasmus Villemoes 		case FORMAT_TYPE_INVALID:
2408b006f19bSRasmus Villemoes 			goto out;
2409b006f19bSRasmus Villemoes 
2410d4be151bSAndré Goddard Rosa 		default: {
2411d4be151bSAndré Goddard Rosa 			unsigned long long num;
2412d4be151bSAndré Goddard Rosa 
2413fef20d9cSFrederic Weisbecker 			switch (spec.type) {
2414fef20d9cSFrederic Weisbecker 
2415fef20d9cSFrederic Weisbecker 			case FORMAT_TYPE_LONG_LONG:
24164370aa4aSLai Jiangshan 				num = get_arg(long long);
2417fef20d9cSFrederic Weisbecker 				break;
2418fef20d9cSFrederic Weisbecker 			case FORMAT_TYPE_ULONG:
2419fef20d9cSFrederic Weisbecker 			case FORMAT_TYPE_LONG:
2420fef20d9cSFrederic Weisbecker 				num = get_arg(unsigned long);
2421fef20d9cSFrederic Weisbecker 				break;
2422fef20d9cSFrederic Weisbecker 			case FORMAT_TYPE_SIZE_T:
24234370aa4aSLai Jiangshan 				num = get_arg(size_t);
2424fef20d9cSFrederic Weisbecker 				break;
2425fef20d9cSFrederic Weisbecker 			case FORMAT_TYPE_PTRDIFF:
24264370aa4aSLai Jiangshan 				num = get_arg(ptrdiff_t);
2427fef20d9cSFrederic Weisbecker 				break;
2428a4e94ef0SZhaolei 			case FORMAT_TYPE_UBYTE:
2429a4e94ef0SZhaolei 				num = get_arg(unsigned char);
2430a4e94ef0SZhaolei 				break;
2431a4e94ef0SZhaolei 			case FORMAT_TYPE_BYTE:
2432a4e94ef0SZhaolei 				num = get_arg(signed char);
2433a4e94ef0SZhaolei 				break;
2434fef20d9cSFrederic Weisbecker 			case FORMAT_TYPE_USHORT:
2435fef20d9cSFrederic Weisbecker 				num = get_arg(unsigned short);
2436fef20d9cSFrederic Weisbecker 				break;
2437fef20d9cSFrederic Weisbecker 			case FORMAT_TYPE_SHORT:
2438fef20d9cSFrederic Weisbecker 				num = get_arg(short);
2439fef20d9cSFrederic Weisbecker 				break;
2440fef20d9cSFrederic Weisbecker 			case FORMAT_TYPE_UINT:
24414370aa4aSLai Jiangshan 				num = get_arg(unsigned int);
2442fef20d9cSFrederic Weisbecker 				break;
2443fef20d9cSFrederic Weisbecker 			default:
2444fef20d9cSFrederic Weisbecker 				num = get_arg(int);
24454370aa4aSLai Jiangshan 			}
2446fef20d9cSFrederic Weisbecker 
2447fef20d9cSFrederic Weisbecker 			str = number(str, end, num, spec);
2448d4be151bSAndré Goddard Rosa 		} /* default: */
2449d4be151bSAndré Goddard Rosa 		} /* switch(spec.type) */
2450d4be151bSAndré Goddard Rosa 	} /* while(*fmt) */
2451fef20d9cSFrederic Weisbecker 
2452b006f19bSRasmus Villemoes out:
24534370aa4aSLai Jiangshan 	if (size > 0) {
24544370aa4aSLai Jiangshan 		if (str < end)
24554370aa4aSLai Jiangshan 			*str = '\0';
24564370aa4aSLai Jiangshan 		else
24574370aa4aSLai Jiangshan 			end[-1] = '\0';
24584370aa4aSLai Jiangshan 	}
2459fef20d9cSFrederic Weisbecker 
24604370aa4aSLai Jiangshan #undef get_arg
24614370aa4aSLai Jiangshan 
24624370aa4aSLai Jiangshan 	/* the trailing null byte doesn't count towards the total */
24634370aa4aSLai Jiangshan 	return str - buf;
24644370aa4aSLai Jiangshan }
24654370aa4aSLai Jiangshan EXPORT_SYMBOL_GPL(bstr_printf);
24664370aa4aSLai Jiangshan 
24674370aa4aSLai Jiangshan /**
24684370aa4aSLai Jiangshan  * bprintf - Parse a format string and place args' binary value in a buffer
24694370aa4aSLai Jiangshan  * @bin_buf: The buffer to place args' binary value
24704370aa4aSLai Jiangshan  * @size: The size of the buffer(by words(32bits), not characters)
24714370aa4aSLai Jiangshan  * @fmt: The format string to use
24724370aa4aSLai Jiangshan  * @...: Arguments for the format string
24734370aa4aSLai Jiangshan  *
24744370aa4aSLai Jiangshan  * The function returns the number of words(u32) written
24754370aa4aSLai Jiangshan  * into @bin_buf.
24764370aa4aSLai Jiangshan  */
24774370aa4aSLai Jiangshan int bprintf(u32 *bin_buf, size_t size, const char *fmt, ...)
24784370aa4aSLai Jiangshan {
24794370aa4aSLai Jiangshan 	va_list args;
24804370aa4aSLai Jiangshan 	int ret;
24814370aa4aSLai Jiangshan 
24824370aa4aSLai Jiangshan 	va_start(args, fmt);
24834370aa4aSLai Jiangshan 	ret = vbin_printf(bin_buf, size, fmt, args);
24844370aa4aSLai Jiangshan 	va_end(args);
24857b9186f5SAndré Goddard Rosa 
24864370aa4aSLai Jiangshan 	return ret;
24874370aa4aSLai Jiangshan }
24884370aa4aSLai Jiangshan EXPORT_SYMBOL_GPL(bprintf);
24894370aa4aSLai Jiangshan 
24904370aa4aSLai Jiangshan #endif /* CONFIG_BINARY_PRINTF */
24914370aa4aSLai Jiangshan 
24921da177e4SLinus Torvalds /**
24931da177e4SLinus Torvalds  * vsscanf - Unformat a buffer into a list of arguments
24941da177e4SLinus Torvalds  * @buf:	input buffer
24951da177e4SLinus Torvalds  * @fmt:	format of buffer
24961da177e4SLinus Torvalds  * @args:	arguments
24971da177e4SLinus Torvalds  */
24981da177e4SLinus Torvalds int vsscanf(const char *buf, const char *fmt, va_list args)
24991da177e4SLinus Torvalds {
25001da177e4SLinus Torvalds 	const char *str = buf;
25011da177e4SLinus Torvalds 	char *next;
25021da177e4SLinus Torvalds 	char digit;
25031da177e4SLinus Torvalds 	int num = 0;
2504ef0658f3SJoe Perches 	u8 qualifier;
250553809751SJan Beulich 	unsigned int base;
250653809751SJan Beulich 	union {
250753809751SJan Beulich 		long long s;
250853809751SJan Beulich 		unsigned long long u;
250953809751SJan Beulich 	} val;
2510ef0658f3SJoe Perches 	s16 field_width;
2511d4be151bSAndré Goddard Rosa 	bool is_sign;
25121da177e4SLinus Torvalds 
2513da99075cSJan Beulich 	while (*fmt) {
25141da177e4SLinus Torvalds 		/* skip any white space in format */
25151da177e4SLinus Torvalds 		/* white space in format matchs any amount of
25161da177e4SLinus Torvalds 		 * white space, including none, in the input.
25171da177e4SLinus Torvalds 		 */
25181da177e4SLinus Torvalds 		if (isspace(*fmt)) {
2519e7d2860bSAndré Goddard Rosa 			fmt = skip_spaces(++fmt);
2520e7d2860bSAndré Goddard Rosa 			str = skip_spaces(str);
25211da177e4SLinus Torvalds 		}
25221da177e4SLinus Torvalds 
25231da177e4SLinus Torvalds 		/* anything that is not a conversion must match exactly */
25241da177e4SLinus Torvalds 		if (*fmt != '%' && *fmt) {
25251da177e4SLinus Torvalds 			if (*fmt++ != *str++)
25261da177e4SLinus Torvalds 				break;
25271da177e4SLinus Torvalds 			continue;
25281da177e4SLinus Torvalds 		}
25291da177e4SLinus Torvalds 
25301da177e4SLinus Torvalds 		if (!*fmt)
25311da177e4SLinus Torvalds 			break;
25321da177e4SLinus Torvalds 		++fmt;
25331da177e4SLinus Torvalds 
25341da177e4SLinus Torvalds 		/* skip this conversion.
25351da177e4SLinus Torvalds 		 * advance both strings to next white space
25361da177e4SLinus Torvalds 		 */
25371da177e4SLinus Torvalds 		if (*fmt == '*') {
2538da99075cSJan Beulich 			if (!*str)
2539da99075cSJan Beulich 				break;
25408fccae2cSAndy Spencer 			while (!isspace(*fmt) && *fmt != '%' && *fmt)
25411da177e4SLinus Torvalds 				fmt++;
25421da177e4SLinus Torvalds 			while (!isspace(*str) && *str)
25431da177e4SLinus Torvalds 				str++;
25441da177e4SLinus Torvalds 			continue;
25451da177e4SLinus Torvalds 		}
25461da177e4SLinus Torvalds 
25471da177e4SLinus Torvalds 		/* get field width */
25481da177e4SLinus Torvalds 		field_width = -1;
254953809751SJan Beulich 		if (isdigit(*fmt)) {
25501da177e4SLinus Torvalds 			field_width = skip_atoi(&fmt);
255153809751SJan Beulich 			if (field_width <= 0)
255253809751SJan Beulich 				break;
255353809751SJan Beulich 		}
25541da177e4SLinus Torvalds 
25551da177e4SLinus Torvalds 		/* get conversion qualifier */
25561da177e4SLinus Torvalds 		qualifier = -1;
255775fb8f26SAndy Shevchenko 		if (*fmt == 'h' || _tolower(*fmt) == 'l' ||
255875fb8f26SAndy Shevchenko 		    _tolower(*fmt) == 'z') {
25591da177e4SLinus Torvalds 			qualifier = *fmt++;
25601da177e4SLinus Torvalds 			if (unlikely(qualifier == *fmt)) {
25611da177e4SLinus Torvalds 				if (qualifier == 'h') {
25621da177e4SLinus Torvalds 					qualifier = 'H';
25631da177e4SLinus Torvalds 					fmt++;
25641da177e4SLinus Torvalds 				} else if (qualifier == 'l') {
25651da177e4SLinus Torvalds 					qualifier = 'L';
25661da177e4SLinus Torvalds 					fmt++;
25671da177e4SLinus Torvalds 				}
25681da177e4SLinus Torvalds 			}
25691da177e4SLinus Torvalds 		}
25701da177e4SLinus Torvalds 
2571da99075cSJan Beulich 		if (!*fmt)
2572da99075cSJan Beulich 			break;
2573da99075cSJan Beulich 
2574da99075cSJan Beulich 		if (*fmt == 'n') {
2575da99075cSJan Beulich 			/* return number of characters read so far */
2576da99075cSJan Beulich 			*va_arg(args, int *) = str - buf;
2577da99075cSJan Beulich 			++fmt;
2578da99075cSJan Beulich 			continue;
2579da99075cSJan Beulich 		}
2580da99075cSJan Beulich 
2581da99075cSJan Beulich 		if (!*str)
25821da177e4SLinus Torvalds 			break;
25831da177e4SLinus Torvalds 
2584d4be151bSAndré Goddard Rosa 		base = 10;
25853f623ebaSFabian Frederick 		is_sign = false;
2586d4be151bSAndré Goddard Rosa 
25871da177e4SLinus Torvalds 		switch (*fmt++) {
25881da177e4SLinus Torvalds 		case 'c':
25891da177e4SLinus Torvalds 		{
25901da177e4SLinus Torvalds 			char *s = (char *)va_arg(args, char*);
25911da177e4SLinus Torvalds 			if (field_width == -1)
25921da177e4SLinus Torvalds 				field_width = 1;
25931da177e4SLinus Torvalds 			do {
25941da177e4SLinus Torvalds 				*s++ = *str++;
25951da177e4SLinus Torvalds 			} while (--field_width > 0 && *str);
25961da177e4SLinus Torvalds 			num++;
25971da177e4SLinus Torvalds 		}
25981da177e4SLinus Torvalds 		continue;
25991da177e4SLinus Torvalds 		case 's':
26001da177e4SLinus Torvalds 		{
26011da177e4SLinus Torvalds 			char *s = (char *)va_arg(args, char *);
26021da177e4SLinus Torvalds 			if (field_width == -1)
26034be929beSAlexey Dobriyan 				field_width = SHRT_MAX;
26041da177e4SLinus Torvalds 			/* first, skip leading white space in buffer */
2605e7d2860bSAndré Goddard Rosa 			str = skip_spaces(str);
26061da177e4SLinus Torvalds 
26071da177e4SLinus Torvalds 			/* now copy until next white space */
26087b9186f5SAndré Goddard Rosa 			while (*str && !isspace(*str) && field_width--)
26091da177e4SLinus Torvalds 				*s++ = *str++;
26101da177e4SLinus Torvalds 			*s = '\0';
26111da177e4SLinus Torvalds 			num++;
26121da177e4SLinus Torvalds 		}
26131da177e4SLinus Torvalds 		continue;
26141da177e4SLinus Torvalds 		case 'o':
26151da177e4SLinus Torvalds 			base = 8;
26161da177e4SLinus Torvalds 			break;
26171da177e4SLinus Torvalds 		case 'x':
26181da177e4SLinus Torvalds 		case 'X':
26191da177e4SLinus Torvalds 			base = 16;
26201da177e4SLinus Torvalds 			break;
26211da177e4SLinus Torvalds 		case 'i':
26221da177e4SLinus Torvalds 			base = 0;
26231da177e4SLinus Torvalds 		case 'd':
26243f623ebaSFabian Frederick 			is_sign = true;
26251da177e4SLinus Torvalds 		case 'u':
26261da177e4SLinus Torvalds 			break;
26271da177e4SLinus Torvalds 		case '%':
26281da177e4SLinus Torvalds 			/* looking for '%' in str */
26291da177e4SLinus Torvalds 			if (*str++ != '%')
26301da177e4SLinus Torvalds 				return num;
26311da177e4SLinus Torvalds 			continue;
26321da177e4SLinus Torvalds 		default:
26331da177e4SLinus Torvalds 			/* invalid format; stop here */
26341da177e4SLinus Torvalds 			return num;
26351da177e4SLinus Torvalds 		}
26361da177e4SLinus Torvalds 
26371da177e4SLinus Torvalds 		/* have some sort of integer conversion.
26381da177e4SLinus Torvalds 		 * first, skip white space in buffer.
26391da177e4SLinus Torvalds 		 */
2640e7d2860bSAndré Goddard Rosa 		str = skip_spaces(str);
26411da177e4SLinus Torvalds 
26421da177e4SLinus Torvalds 		digit = *str;
26431da177e4SLinus Torvalds 		if (is_sign && digit == '-')
26441da177e4SLinus Torvalds 			digit = *(str + 1);
26451da177e4SLinus Torvalds 
26461da177e4SLinus Torvalds 		if (!digit
26471da177e4SLinus Torvalds 		    || (base == 16 && !isxdigit(digit))
26481da177e4SLinus Torvalds 		    || (base == 10 && !isdigit(digit))
26491da177e4SLinus Torvalds 		    || (base == 8 && (!isdigit(digit) || digit > '7'))
26501da177e4SLinus Torvalds 		    || (base == 0 && !isdigit(digit)))
26511da177e4SLinus Torvalds 			break;
26521da177e4SLinus Torvalds 
265353809751SJan Beulich 		if (is_sign)
265453809751SJan Beulich 			val.s = qualifier != 'L' ?
265553809751SJan Beulich 				simple_strtol(str, &next, base) :
265653809751SJan Beulich 				simple_strtoll(str, &next, base);
265753809751SJan Beulich 		else
265853809751SJan Beulich 			val.u = qualifier != 'L' ?
265953809751SJan Beulich 				simple_strtoul(str, &next, base) :
266053809751SJan Beulich 				simple_strtoull(str, &next, base);
266153809751SJan Beulich 
266253809751SJan Beulich 		if (field_width > 0 && next - str > field_width) {
266353809751SJan Beulich 			if (base == 0)
266453809751SJan Beulich 				_parse_integer_fixup_radix(str, &base);
266553809751SJan Beulich 			while (next - str > field_width) {
266653809751SJan Beulich 				if (is_sign)
266753809751SJan Beulich 					val.s = div_s64(val.s, base);
266853809751SJan Beulich 				else
266953809751SJan Beulich 					val.u = div_u64(val.u, base);
267053809751SJan Beulich 				--next;
267153809751SJan Beulich 			}
267253809751SJan Beulich 		}
267353809751SJan Beulich 
26741da177e4SLinus Torvalds 		switch (qualifier) {
26751da177e4SLinus Torvalds 		case 'H':	/* that's 'hh' in format */
267653809751SJan Beulich 			if (is_sign)
267753809751SJan Beulich 				*va_arg(args, signed char *) = val.s;
267853809751SJan Beulich 			else
267953809751SJan Beulich 				*va_arg(args, unsigned char *) = val.u;
26801da177e4SLinus Torvalds 			break;
26811da177e4SLinus Torvalds 		case 'h':
268253809751SJan Beulich 			if (is_sign)
268353809751SJan Beulich 				*va_arg(args, short *) = val.s;
268453809751SJan Beulich 			else
268553809751SJan Beulich 				*va_arg(args, unsigned short *) = val.u;
26861da177e4SLinus Torvalds 			break;
26871da177e4SLinus Torvalds 		case 'l':
268853809751SJan Beulich 			if (is_sign)
268953809751SJan Beulich 				*va_arg(args, long *) = val.s;
269053809751SJan Beulich 			else
269153809751SJan Beulich 				*va_arg(args, unsigned long *) = val.u;
26921da177e4SLinus Torvalds 			break;
26931da177e4SLinus Torvalds 		case 'L':
269453809751SJan Beulich 			if (is_sign)
269553809751SJan Beulich 				*va_arg(args, long long *) = val.s;
269653809751SJan Beulich 			else
269753809751SJan Beulich 				*va_arg(args, unsigned long long *) = val.u;
26981da177e4SLinus Torvalds 			break;
26991da177e4SLinus Torvalds 		case 'Z':
27001da177e4SLinus Torvalds 		case 'z':
270153809751SJan Beulich 			*va_arg(args, size_t *) = val.u;
27021da177e4SLinus Torvalds 			break;
27031da177e4SLinus Torvalds 		default:
270453809751SJan Beulich 			if (is_sign)
270553809751SJan Beulich 				*va_arg(args, int *) = val.s;
270653809751SJan Beulich 			else
270753809751SJan Beulich 				*va_arg(args, unsigned int *) = val.u;
27081da177e4SLinus Torvalds 			break;
27091da177e4SLinus Torvalds 		}
27101da177e4SLinus Torvalds 		num++;
27111da177e4SLinus Torvalds 
27121da177e4SLinus Torvalds 		if (!next)
27131da177e4SLinus Torvalds 			break;
27141da177e4SLinus Torvalds 		str = next;
27151da177e4SLinus Torvalds 	}
2716c6b40d16SJohannes Berg 
27171da177e4SLinus Torvalds 	return num;
27181da177e4SLinus Torvalds }
27191da177e4SLinus Torvalds EXPORT_SYMBOL(vsscanf);
27201da177e4SLinus Torvalds 
27211da177e4SLinus Torvalds /**
27221da177e4SLinus Torvalds  * sscanf - Unformat a buffer into a list of arguments
27231da177e4SLinus Torvalds  * @buf:	input buffer
27241da177e4SLinus Torvalds  * @fmt:	formatting of buffer
27251da177e4SLinus Torvalds  * @...:	resulting arguments
27261da177e4SLinus Torvalds  */
27271da177e4SLinus Torvalds int sscanf(const char *buf, const char *fmt, ...)
27281da177e4SLinus Torvalds {
27291da177e4SLinus Torvalds 	va_list args;
27301da177e4SLinus Torvalds 	int i;
27311da177e4SLinus Torvalds 
27321da177e4SLinus Torvalds 	va_start(args, fmt);
27331da177e4SLinus Torvalds 	i = vsscanf(buf, fmt, args);
27341da177e4SLinus Torvalds 	va_end(args);
27357b9186f5SAndré Goddard Rosa 
27361da177e4SLinus Torvalds 	return i;
27371da177e4SLinus Torvalds }
27381da177e4SLinus Torvalds EXPORT_SYMBOL(sscanf);
2739