4 * Copyright (C) 1991, 1992 Linus Torvalds
7 /* vsprintf.c -- Lars Wirzenius & Linus Torvalds. */
9 * Wirzenius wrote this portably, Torvalds fucked it up :-)
13 * Fri Jul 13 2001 Crutcher Dunnavant <crutcher+kernel@datastacks.com>
14 * - changed to provide snprintf and vsnprintf functions
15 * So Feb 1 16:51:32 CET 2004 Juergen Quade <quade@hsnr.de>
16 * - scnprintf and vscnprintf
20 #include <linux/clk.h>
21 #include <linux/clk-provider.h>
22 #include <linux/module.h> /* for KSYM_SYMBOL_LEN */
23 #include <linux/types.h>
24 #include <linux/string.h>
25 #include <linux/ctype.h>
26 #include <linux/kernel.h>
27 #include <linux/kallsyms.h>
28 #include <linux/math64.h>
29 #include <linux/uaccess.h>
30 #include <linux/ioport.h>
31 #include <linux/dcache.h>
32 #include <linux/cred.h>
33 #include <net/addrconf.h>
35 #include <linux/blkdev.h>
38 #include <asm/page.h> /* for PAGE_SIZE */
39 #include <asm/sections.h> /* for dereference_function_descriptor() */
40 #include <asm/byteorder.h> /* cpu_to_le16 */
42 #include <linux/string_helpers.h>
46 * simple_strtoull - convert a string to an unsigned long long
47 * @cp: The start of the string
48 * @endp: A pointer to the end of the parsed string will be placed here
49 * @base: The number base to use
51 * This function is obsolete. Please use kstrtoull instead.
53 unsigned long long simple_strtoull(const char *cp, char **endp, unsigned int base)
55 unsigned long long result;
58 cp = _parse_integer_fixup_radix(cp, &base);
59 rv = _parse_integer(cp, base, &result);
61 cp += (rv & ~KSTRTOX_OVERFLOW);
68 EXPORT_SYMBOL(simple_strtoull);
71 * simple_strtoul - convert a string to an unsigned long
72 * @cp: The start of the string
73 * @endp: A pointer to the end of the parsed string will be placed here
74 * @base: The number base to use
76 * This function is obsolete. Please use kstrtoul instead.
78 unsigned long simple_strtoul(const char *cp, char **endp, unsigned int base)
80 return simple_strtoull(cp, endp, base);
82 EXPORT_SYMBOL(simple_strtoul);
85 * simple_strtol - convert a string to a signed long
86 * @cp: The start of the string
87 * @endp: A pointer to the end of the parsed string will be placed here
88 * @base: The number base to use
90 * This function is obsolete. Please use kstrtol instead.
92 long simple_strtol(const char *cp, char **endp, unsigned int base)
95 return -simple_strtoul(cp + 1, endp, base);
97 return simple_strtoul(cp, endp, base);
99 EXPORT_SYMBOL(simple_strtol);
102 * simple_strtoll - convert a string to a signed long long
103 * @cp: The start of the string
104 * @endp: A pointer to the end of the parsed string will be placed here
105 * @base: The number base to use
107 * This function is obsolete. Please use kstrtoll instead.
109 long long simple_strtoll(const char *cp, char **endp, unsigned int base)
112 return -simple_strtoull(cp + 1, endp, base);
114 return simple_strtoull(cp, endp, base);
116 EXPORT_SYMBOL(simple_strtoll);
118 static noinline_for_stack
119 int skip_atoi(const char **s)
124 i = i*10 + *((*s)++) - '0';
125 } while (isdigit(**s));
131 * Decimal conversion is by far the most typical, and is used for
132 * /proc and /sys data. This directly impacts e.g. top performance
133 * with many processes running. We optimize it for speed by emitting
134 * two characters at a time, using a 200 byte lookup table. This
135 * roughly halves the number of multiplications compared to computing
136 * the digits one at a time. Implementation strongly inspired by the
137 * previous version, which in turn used ideas described at
138 * <http://www.cs.uiowa.edu/~jones/bcd/divide.html> (with permission
139 * from the author, Douglas W. Jones).
141 * It turns out there is precisely one 26 bit fixed-point
142 * approximation a of 64/100 for which x/100 == (x * (u64)a) >> 32
143 * holds for all x in [0, 10^8-1], namely a = 0x28f5c29. The actual
144 * range happens to be somewhat larger (x <= 1073741898), but that's
145 * irrelevant for our purpose.
147 * For dividing a number in the range [10^4, 10^6-1] by 100, we still
148 * need a 32x32->64 bit multiply, so we simply use the same constant.
150 * For dividing a number in the range [100, 10^4-1] by 100, there are
151 * several options. The simplest is (x * 0x147b) >> 19, which is valid
152 * for all x <= 43698.
155 static const u16 decpair[100] = {
156 #define _(x) (__force u16) cpu_to_le16(((x % 10) | ((x / 10) << 8)) + 0x3030)
157 _( 0), _( 1), _( 2), _( 3), _( 4), _( 5), _( 6), _( 7), _( 8), _( 9),
158 _(10), _(11), _(12), _(13), _(14), _(15), _(16), _(17), _(18), _(19),
159 _(20), _(21), _(22), _(23), _(24), _(25), _(26), _(27), _(28), _(29),
160 _(30), _(31), _(32), _(33), _(34), _(35), _(36), _(37), _(38), _(39),
161 _(40), _(41), _(42), _(43), _(44), _(45), _(46), _(47), _(48), _(49),
162 _(50), _(51), _(52), _(53), _(54), _(55), _(56), _(57), _(58), _(59),
163 _(60), _(61), _(62), _(63), _(64), _(65), _(66), _(67), _(68), _(69),
164 _(70), _(71), _(72), _(73), _(74), _(75), _(76), _(77), _(78), _(79),
165 _(80), _(81), _(82), _(83), _(84), _(85), _(86), _(87), _(88), _(89),
166 _(90), _(91), _(92), _(93), _(94), _(95), _(96), _(97), _(98), _(99),
171 * This will print a single '0' even if r == 0, since we would
172 * immediately jump to out_r where two 0s would be written but only
173 * one of them accounted for in buf. This is needed by ip4_string
174 * below. All other callers pass a non-zero value of r.
176 static noinline_for_stack
177 char *put_dec_trunc8(char *buf, unsigned r)
185 /* 100 <= r < 10^8 */
186 q = (r * (u64)0x28f5c29) >> 32;
187 *((u16 *)buf) = decpair[r - 100*q];
194 /* 100 <= q < 10^6 */
195 r = (q * (u64)0x28f5c29) >> 32;
196 *((u16 *)buf) = decpair[q - 100*r];
203 /* 100 <= r < 10^4 */
204 q = (r * 0x147b) >> 19;
205 *((u16 *)buf) = decpair[r - 100*q];
212 *((u16 *)buf) = decpair[r];
213 buf += r < 10 ? 1 : 2;
217 #if BITS_PER_LONG == 64 && BITS_PER_LONG_LONG == 64
218 static noinline_for_stack
219 char *put_dec_full8(char *buf, unsigned r)
224 q = (r * (u64)0x28f5c29) >> 32;
225 *((u16 *)buf) = decpair[r - 100*q];
229 r = (q * (u64)0x28f5c29) >> 32;
230 *((u16 *)buf) = decpair[q - 100*r];
234 q = (r * 0x147b) >> 19;
235 *((u16 *)buf) = decpair[r - 100*q];
239 *((u16 *)buf) = decpair[q];
244 static noinline_for_stack
245 char *put_dec(char *buf, unsigned long long n)
247 if (n >= 100*1000*1000)
248 buf = put_dec_full8(buf, do_div(n, 100*1000*1000));
249 /* 1 <= n <= 1.6e11 */
250 if (n >= 100*1000*1000)
251 buf = put_dec_full8(buf, do_div(n, 100*1000*1000));
253 return put_dec_trunc8(buf, n);
256 #elif BITS_PER_LONG == 32 && BITS_PER_LONG_LONG == 64
259 put_dec_full4(char *buf, unsigned r)
264 q = (r * 0x147b) >> 19;
265 *((u16 *)buf) = decpair[r - 100*q];
268 *((u16 *)buf) = decpair[q];
272 * Call put_dec_full4 on x % 10000, return x / 10000.
273 * The approximation x/10000 == (x * 0x346DC5D7) >> 43
274 * holds for all x < 1,128,869,999. The largest value this
275 * helper will ever be asked to convert is 1,125,520,955.
276 * (second call in the put_dec code, assuming n is all-ones).
278 static noinline_for_stack
279 unsigned put_dec_helper4(char *buf, unsigned x)
281 uint32_t q = (x * (uint64_t)0x346DC5D7) >> 43;
283 put_dec_full4(buf, x - q * 10000);
287 /* Based on code by Douglas W. Jones found at
288 * <http://www.cs.uiowa.edu/~jones/bcd/decimal.html#sixtyfour>
289 * (with permission from the author).
290 * Performs no 64-bit division and hence should be fast on 32-bit machines.
293 char *put_dec(char *buf, unsigned long long n)
295 uint32_t d3, d2, d1, q, h;
297 if (n < 100*1000*1000)
298 return put_dec_trunc8(buf, n);
300 d1 = ((uint32_t)n >> 16); /* implicit "& 0xffff" */
303 d3 = (h >> 16); /* implicit "& 0xffff" */
305 /* n = 2^48 d3 + 2^32 d2 + 2^16 d1 + d0
306 = 281_4749_7671_0656 d3 + 42_9496_7296 d2 + 6_5536 d1 + d0 */
307 q = 656 * d3 + 7296 * d2 + 5536 * d1 + ((uint32_t)n & 0xffff);
308 q = put_dec_helper4(buf, q);
310 q += 7671 * d3 + 9496 * d2 + 6 * d1;
311 q = put_dec_helper4(buf+4, q);
313 q += 4749 * d3 + 42 * d2;
314 q = put_dec_helper4(buf+8, q);
319 buf = put_dec_trunc8(buf, q);
320 else while (buf[-1] == '0')
329 * Convert passed number to decimal string.
330 * Returns the length of string. On buffer overflow, returns 0.
332 * If speed is not important, use snprintf(). It's easy to read the code.
334 int num_to_str(char *buf, int size, unsigned long long num)
336 /* put_dec requires 2-byte alignment of the buffer. */
337 char tmp[sizeof(num) * 3] __aligned(2);
340 /* put_dec() may work incorrectly for num = 0 (generate "", not "0") */
345 len = put_dec(tmp, num) - tmp;
350 for (idx = 0; idx < len; ++idx)
351 buf[idx] = tmp[len - idx - 1];
355 #define SIGN 1 /* unsigned/signed, must be 1 */
356 #define LEFT 2 /* left justified */
357 #define PLUS 4 /* show plus */
358 #define SPACE 8 /* space if plus */
359 #define ZEROPAD 16 /* pad with zero, must be 16 == '0' - ' ' */
360 #define SMALL 32 /* use lowercase in hex (must be 32 == 0x20) */
361 #define SPECIAL 64 /* prefix hex with "0x", octal with "0" */
364 FORMAT_TYPE_NONE, /* Just a string part */
366 FORMAT_TYPE_PRECISION,
370 FORMAT_TYPE_PERCENT_CHAR,
372 FORMAT_TYPE_LONG_LONG,
386 u8 type; /* format_type enum */
387 u8 flags; /* flags to number() */
388 u8 base; /* number base, 8, 10 or 16 only */
389 u8 qualifier; /* number qualifier, one of 'hHlLtzZ' */
390 s16 field_width; /* width of output field */
391 s16 precision; /* # of digits/chars */
394 static noinline_for_stack
395 char *number(char *buf, char *end, unsigned long long num,
396 struct printf_spec spec)
398 /* put_dec requires 2-byte alignment of the buffer. */
399 char tmp[3 * sizeof(num)] __aligned(2);
402 int need_pfx = ((spec.flags & SPECIAL) && spec.base != 10);
404 bool is_zero = num == 0LL;
406 /* locase = 0 or 0x20. ORing digits or letters with 'locase'
407 * produces same digits or (maybe lowercased) letters */
408 locase = (spec.flags & SMALL);
409 if (spec.flags & LEFT)
410 spec.flags &= ~ZEROPAD;
412 if (spec.flags & SIGN) {
413 if ((signed long long)num < 0) {
415 num = -(signed long long)num;
417 } else if (spec.flags & PLUS) {
420 } else if (spec.flags & SPACE) {
427 spec.field_width -= 2;
432 /* generate full string in tmp[], in reverse order */
435 tmp[i++] = hex_asc_upper[num] | locase;
436 else if (spec.base != 10) { /* 8 or 16 */
437 int mask = spec.base - 1;
443 tmp[i++] = (hex_asc_upper[((unsigned char)num) & mask] | locase);
446 } else { /* base 10 */
447 i = put_dec(tmp, num) - tmp;
450 /* printing 100 using %2d gives "100", not "00" */
451 if (i > spec.precision)
453 /* leading space padding */
454 spec.field_width -= spec.precision;
455 if (!(spec.flags & (ZEROPAD | LEFT))) {
456 while (--spec.field_width >= 0) {
468 /* "0x" / "0" prefix */
470 if (spec.base == 16 || !is_zero) {
475 if (spec.base == 16) {
477 *buf = ('X' | locase);
481 /* zero or space padding */
482 if (!(spec.flags & LEFT)) {
483 char c = ' ' + (spec.flags & ZEROPAD);
484 BUILD_BUG_ON(' ' + ZEROPAD != '0');
485 while (--spec.field_width >= 0) {
491 /* hmm even more zero padding? */
492 while (i <= --spec.precision) {
497 /* actual digits of result */
503 /* trailing space padding */
504 while (--spec.field_width >= 0) {
513 static noinline_for_stack
514 char *string(char *buf, char *end, const char *s, struct printf_spec spec)
518 if ((unsigned long)s < PAGE_SIZE)
521 len = strnlen(s, spec.precision);
523 if (!(spec.flags & LEFT)) {
524 while (len < spec.field_width--) {
530 for (i = 0; i < len; ++i) {
535 while (len < spec.field_width--) {
544 static void widen(char *buf, char *end, unsigned len, unsigned spaces)
547 if (buf >= end) /* nowhere to put anything */
550 if (size <= spaces) {
551 memset(buf, ' ', size);
555 if (len > size - spaces)
557 memmove(buf + spaces, buf, len);
559 memset(buf, ' ', spaces);
562 static noinline_for_stack
563 char *dentry_name(char *buf, char *end, const struct dentry *d, struct printf_spec spec,
566 const char *array[4], *s;
567 const struct dentry *p;
572 case '2': case '3': case '4':
573 depth = fmt[1] - '0';
580 for (i = 0; i < depth; i++, d = p) {
581 p = ACCESS_ONCE(d->d_parent);
582 array[i] = ACCESS_ONCE(d->d_name.name);
591 for (n = 0; n != spec.precision; n++, buf++) {
603 if (n < spec.field_width) {
604 /* we want to pad the sucker */
605 unsigned spaces = spec.field_width - n;
606 if (!(spec.flags & LEFT)) {
607 widen(buf - n, end, n, spaces);
620 static noinline_for_stack
621 char *bdev_name(char *buf, char *end, struct block_device *bdev,
622 struct printf_spec spec, const char *fmt)
624 struct gendisk *hd = bdev->bd_disk;
626 buf = string(buf, end, hd->disk_name, spec);
627 if (bdev->bd_part->partno) {
628 if (isdigit(hd->disk_name[strlen(hd->disk_name)-1])) {
633 buf = number(buf, end, bdev->bd_part->partno, spec);
639 static noinline_for_stack
640 char *symbol_string(char *buf, char *end, void *ptr,
641 struct printf_spec spec, const char *fmt)
644 #ifdef CONFIG_KALLSYMS
645 char sym[KSYM_SYMBOL_LEN];
649 ptr = __builtin_extract_return_addr(ptr);
650 value = (unsigned long)ptr;
652 #ifdef CONFIG_KALLSYMS
654 sprint_backtrace(sym, value);
655 else if (*fmt != 'f' && *fmt != 's')
656 sprint_symbol(sym, value);
658 sprint_symbol_no_offset(sym, value);
660 return string(buf, end, sym, spec);
662 spec.field_width = 2 * sizeof(void *);
663 spec.flags |= SPECIAL | SMALL | ZEROPAD;
666 return number(buf, end, value, spec);
670 static noinline_for_stack
671 char *resource_string(char *buf, char *end, struct resource *res,
672 struct printf_spec spec, const char *fmt)
674 #ifndef IO_RSRC_PRINTK_SIZE
675 #define IO_RSRC_PRINTK_SIZE 6
678 #ifndef MEM_RSRC_PRINTK_SIZE
679 #define MEM_RSRC_PRINTK_SIZE 10
681 static const struct printf_spec io_spec = {
683 .field_width = IO_RSRC_PRINTK_SIZE,
685 .flags = SPECIAL | SMALL | ZEROPAD,
687 static const struct printf_spec mem_spec = {
689 .field_width = MEM_RSRC_PRINTK_SIZE,
691 .flags = SPECIAL | SMALL | ZEROPAD,
693 static const struct printf_spec bus_spec = {
697 .flags = SMALL | ZEROPAD,
699 static const struct printf_spec dec_spec = {
704 static const struct printf_spec str_spec = {
709 static const struct printf_spec flag_spec = {
712 .flags = SPECIAL | SMALL,
715 /* 32-bit res (sizeof==4): 10 chars in dec, 10 in hex ("0x" + 8)
716 * 64-bit res (sizeof==8): 20 chars in dec, 18 in hex ("0x" + 16) */
717 #define RSRC_BUF_SIZE ((2 * sizeof(resource_size_t)) + 4)
718 #define FLAG_BUF_SIZE (2 * sizeof(res->flags))
719 #define DECODED_BUF_SIZE sizeof("[mem - 64bit pref window disabled]")
720 #define RAW_BUF_SIZE sizeof("[mem - flags 0x]")
721 char sym[max(2*RSRC_BUF_SIZE + DECODED_BUF_SIZE,
722 2*RSRC_BUF_SIZE + FLAG_BUF_SIZE + RAW_BUF_SIZE)];
724 char *p = sym, *pend = sym + sizeof(sym);
725 int decode = (fmt[0] == 'R') ? 1 : 0;
726 const struct printf_spec *specp;
729 if (res->flags & IORESOURCE_IO) {
730 p = string(p, pend, "io ", str_spec);
732 } else if (res->flags & IORESOURCE_MEM) {
733 p = string(p, pend, "mem ", str_spec);
735 } else if (res->flags & IORESOURCE_IRQ) {
736 p = string(p, pend, "irq ", str_spec);
738 } else if (res->flags & IORESOURCE_DMA) {
739 p = string(p, pend, "dma ", str_spec);
741 } else if (res->flags & IORESOURCE_BUS) {
742 p = string(p, pend, "bus ", str_spec);
745 p = string(p, pend, "??? ", str_spec);
749 if (decode && res->flags & IORESOURCE_UNSET) {
750 p = string(p, pend, "size ", str_spec);
751 p = number(p, pend, resource_size(res), *specp);
753 p = number(p, pend, res->start, *specp);
754 if (res->start != res->end) {
756 p = number(p, pend, res->end, *specp);
760 if (res->flags & IORESOURCE_MEM_64)
761 p = string(p, pend, " 64bit", str_spec);
762 if (res->flags & IORESOURCE_PREFETCH)
763 p = string(p, pend, " pref", str_spec);
764 if (res->flags & IORESOURCE_WINDOW)
765 p = string(p, pend, " window", str_spec);
766 if (res->flags & IORESOURCE_DISABLED)
767 p = string(p, pend, " disabled", str_spec);
769 p = string(p, pend, " flags ", str_spec);
770 p = number(p, pend, res->flags, flag_spec);
775 return string(buf, end, sym, spec);
778 static noinline_for_stack
779 char *hex_string(char *buf, char *end, u8 *addr, struct printf_spec spec,
782 int i, len = 1; /* if we pass '%ph[CDN]', field width remains
783 negative value, fallback to the default */
786 if (spec.field_width == 0)
787 /* nothing to print */
790 if (ZERO_OR_NULL_PTR(addr))
792 return string(buf, end, NULL, spec);
809 if (spec.field_width > 0)
810 len = min_t(int, spec.field_width, 64);
812 for (i = 0; i < len; ++i) {
814 *buf = hex_asc_hi(addr[i]);
817 *buf = hex_asc_lo(addr[i]);
820 if (separator && i != len - 1) {
830 static noinline_for_stack
831 char *bitmap_string(char *buf, char *end, unsigned long *bitmap,
832 struct printf_spec spec, const char *fmt)
834 const int CHUNKSZ = 32;
835 int nr_bits = max_t(int, spec.field_width, 0);
839 /* reused to print numbers */
840 spec = (struct printf_spec){ .flags = SMALL | ZEROPAD, .base = 16 };
842 chunksz = nr_bits & (CHUNKSZ - 1);
846 i = ALIGN(nr_bits, CHUNKSZ) - CHUNKSZ;
847 for (; i >= 0; i -= CHUNKSZ) {
851 chunkmask = ((1ULL << chunksz) - 1);
852 word = i / BITS_PER_LONG;
853 bit = i % BITS_PER_LONG;
854 val = (bitmap[word] >> bit) & chunkmask;
863 spec.field_width = DIV_ROUND_UP(chunksz, 4);
864 buf = number(buf, end, val, spec);
871 static noinline_for_stack
872 char *bitmap_list_string(char *buf, char *end, unsigned long *bitmap,
873 struct printf_spec spec, const char *fmt)
875 int nr_bits = max_t(int, spec.field_width, 0);
876 /* current bit is 'cur', most recently seen range is [rbot, rtop] */
880 /* reused to print numbers */
881 spec = (struct printf_spec){ .base = 10 };
883 rbot = cur = find_first_bit(bitmap, nr_bits);
884 while (cur < nr_bits) {
886 cur = find_next_bit(bitmap, nr_bits, cur + 1);
887 if (cur < nr_bits && cur <= rtop + 1)
897 buf = number(buf, end, rbot, spec);
903 buf = number(buf, end, rtop, spec);
911 static noinline_for_stack
912 char *mac_address_string(char *buf, char *end, u8 *addr,
913 struct printf_spec spec, const char *fmt)
915 char mac_addr[sizeof("xx:xx:xx:xx:xx:xx")];
919 bool reversed = false;
935 for (i = 0; i < 6; i++) {
937 p = hex_byte_pack(p, addr[5 - i]);
939 p = hex_byte_pack(p, addr[i]);
941 if (fmt[0] == 'M' && i != 5)
946 return string(buf, end, mac_addr, spec);
949 static noinline_for_stack
950 char *ip4_string(char *p, const u8 *addr, const char *fmt)
953 bool leading_zeros = (fmt[0] == 'i');
978 for (i = 0; i < 4; i++) {
979 char temp[4] __aligned(2); /* hold each IP quad in reverse order */
980 int digits = put_dec_trunc8(temp, addr[index]) - temp;
987 /* reverse the digits in the quad */
999 static noinline_for_stack
1000 char *ip6_compressed_string(char *p, const char *addr)
1003 unsigned char zerolength[8];
1008 bool needcolon = false;
1010 struct in6_addr in6;
1012 memcpy(&in6, addr, sizeof(struct in6_addr));
1014 useIPv4 = ipv6_addr_v4mapped(&in6) || ipv6_addr_is_isatap(&in6);
1016 memset(zerolength, 0, sizeof(zerolength));
1023 /* find position of longest 0 run */
1024 for (i = 0; i < range; i++) {
1025 for (j = i; j < range; j++) {
1026 if (in6.s6_addr16[j] != 0)
1031 for (i = 0; i < range; i++) {
1032 if (zerolength[i] > longest) {
1033 longest = zerolength[i];
1037 if (longest == 1) /* don't compress a single 0 */
1041 for (i = 0; i < range; i++) {
1042 if (i == colonpos) {
1043 if (needcolon || i == 0)
1054 /* hex u16 without leading 0s */
1055 word = ntohs(in6.s6_addr16[i]);
1060 p = hex_byte_pack(p, hi);
1062 *p++ = hex_asc_lo(hi);
1063 p = hex_byte_pack(p, lo);
1066 p = hex_byte_pack(p, lo);
1068 *p++ = hex_asc_lo(lo);
1075 p = ip4_string(p, &in6.s6_addr[12], "I4");
1082 static noinline_for_stack
1083 char *ip6_string(char *p, const char *addr, const char *fmt)
1087 for (i = 0; i < 8; i++) {
1088 p = hex_byte_pack(p, *addr++);
1089 p = hex_byte_pack(p, *addr++);
1090 if (fmt[0] == 'I' && i != 7)
1098 static noinline_for_stack
1099 char *ip6_addr_string(char *buf, char *end, const u8 *addr,
1100 struct printf_spec spec, const char *fmt)
1102 char ip6_addr[sizeof("xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:255.255.255.255")];
1104 if (fmt[0] == 'I' && fmt[2] == 'c')
1105 ip6_compressed_string(ip6_addr, addr);
1107 ip6_string(ip6_addr, addr, fmt);
1109 return string(buf, end, ip6_addr, spec);
1112 static noinline_for_stack
1113 char *ip4_addr_string(char *buf, char *end, const u8 *addr,
1114 struct printf_spec spec, const char *fmt)
1116 char ip4_addr[sizeof("255.255.255.255")];
1118 ip4_string(ip4_addr, addr, fmt);
1120 return string(buf, end, ip4_addr, spec);
1123 static noinline_for_stack
1124 char *ip6_addr_string_sa(char *buf, char *end, const struct sockaddr_in6 *sa,
1125 struct printf_spec spec, const char *fmt)
1127 bool have_p = false, have_s = false, have_f = false, have_c = false;
1128 char ip6_addr[sizeof("[xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:255.255.255.255]") +
1129 sizeof(":12345") + sizeof("/123456789") +
1130 sizeof("%1234567890")];
1131 char *p = ip6_addr, *pend = ip6_addr + sizeof(ip6_addr);
1132 const u8 *addr = (const u8 *) &sa->sin6_addr;
1133 char fmt6[2] = { fmt[0], '6' };
1137 while (isalpha(*++fmt)) {
1154 if (have_p || have_s || have_f) {
1159 if (fmt6[0] == 'I' && have_c)
1160 p = ip6_compressed_string(ip6_addr + off, addr);
1162 p = ip6_string(ip6_addr + off, addr, fmt6);
1164 if (have_p || have_s || have_f)
1169 p = number(p, pend, ntohs(sa->sin6_port), spec);
1173 p = number(p, pend, ntohl(sa->sin6_flowinfo &
1174 IPV6_FLOWINFO_MASK), spec);
1178 p = number(p, pend, sa->sin6_scope_id, spec);
1182 return string(buf, end, ip6_addr, spec);
1185 static noinline_for_stack
1186 char *ip4_addr_string_sa(char *buf, char *end, const struct sockaddr_in *sa,
1187 struct printf_spec spec, const char *fmt)
1189 bool have_p = false;
1190 char *p, ip4_addr[sizeof("255.255.255.255") + sizeof(":12345")];
1191 char *pend = ip4_addr + sizeof(ip4_addr);
1192 const u8 *addr = (const u8 *) &sa->sin_addr.s_addr;
1193 char fmt4[3] = { fmt[0], '4', 0 };
1196 while (isalpha(*++fmt)) {
1210 p = ip4_string(ip4_addr, addr, fmt4);
1213 p = number(p, pend, ntohs(sa->sin_port), spec);
1217 return string(buf, end, ip4_addr, spec);
1220 static noinline_for_stack
1221 char *escaped_string(char *buf, char *end, u8 *addr, struct printf_spec spec,
1226 unsigned int flags = 0;
1229 if (spec.field_width == 0)
1230 return buf; /* nothing to print */
1232 if (ZERO_OR_NULL_PTR(addr))
1233 return string(buf, end, NULL, spec); /* NULL pointer */
1237 switch (fmt[count++]) {
1239 flags |= ESCAPE_ANY;
1242 flags |= ESCAPE_SPECIAL;
1245 flags |= ESCAPE_HEX;
1248 flags |= ESCAPE_NULL;
1251 flags |= ESCAPE_OCTAL;
1257 flags |= ESCAPE_SPACE;
1266 flags = ESCAPE_ANY_NP;
1268 len = spec.field_width < 0 ? 1 : spec.field_width;
1271 * string_escape_mem() writes as many characters as it can to
1272 * the given buffer, and returns the total size of the output
1273 * had the buffer been big enough.
1275 buf += string_escape_mem(addr, len, buf, buf < end ? end - buf : 0, flags, NULL);
1280 static noinline_for_stack
1281 char *uuid_string(char *buf, char *end, const u8 *addr,
1282 struct printf_spec spec, const char *fmt)
1284 char uuid[sizeof("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx")];
1287 static const u8 be[16] = {0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15};
1288 static const u8 le[16] = {3,2,1,0,5,4,7,6,8,9,10,11,12,13,14,15};
1289 const u8 *index = be;
1294 uc = true; /* fall-through */
1303 for (i = 0; i < 16; i++) {
1304 p = hex_byte_pack(p, addr[index[i]]);
1324 return string(buf, end, uuid, spec);
1328 char *netdev_feature_string(char *buf, char *end, const u8 *addr,
1329 struct printf_spec spec)
1331 spec.flags |= SPECIAL | SMALL | ZEROPAD;
1332 if (spec.field_width == -1)
1333 spec.field_width = 2 + 2 * sizeof(netdev_features_t);
1336 return number(buf, end, *(const netdev_features_t *)addr, spec);
1339 static noinline_for_stack
1340 char *address_val(char *buf, char *end, const void *addr,
1341 struct printf_spec spec, const char *fmt)
1343 unsigned long long num;
1345 spec.flags |= SPECIAL | SMALL | ZEROPAD;
1350 num = *(const dma_addr_t *)addr;
1351 spec.field_width = sizeof(dma_addr_t) * 2 + 2;
1355 num = *(const phys_addr_t *)addr;
1356 spec.field_width = sizeof(phys_addr_t) * 2 + 2;
1360 return number(buf, end, num, spec);
1363 static noinline_for_stack
1364 char *clock(char *buf, char *end, struct clk *clk, struct printf_spec spec,
1367 if (!IS_ENABLED(CONFIG_HAVE_CLK) || !clk)
1368 return string(buf, end, NULL, spec);
1372 return number(buf, end, clk_get_rate(clk), spec);
1376 #ifdef CONFIG_COMMON_CLK
1377 return string(buf, end, __clk_get_name(clk), spec);
1380 spec.field_width = sizeof(unsigned long) * 2 + 2;
1381 spec.flags |= SPECIAL | SMALL | ZEROPAD;
1382 return number(buf, end, (unsigned long)clk, spec);
1387 int kptr_restrict __read_mostly;
1390 * Show a '%p' thing. A kernel extension is that the '%p' is followed
1391 * by an extra set of alphanumeric characters that are extended format
1394 * Right now we handle:
1396 * - 'F' For symbolic function descriptor pointers with offset
1397 * - 'f' For simple symbolic function names without offset
1398 * - 'S' For symbolic direct pointers with offset
1399 * - 's' For symbolic direct pointers without offset
1400 * - '[FfSs]R' as above with __builtin_extract_return_addr() translation
1401 * - 'B' For backtraced symbolic direct pointers with offset
1402 * - 'R' For decoded struct resource, e.g., [mem 0x0-0x1f 64bit pref]
1403 * - 'r' For raw struct resource, e.g., [mem 0x0-0x1f flags 0x201]
1404 * - 'b[l]' For a bitmap, the number of bits is determined by the field
1405 * width which must be explicitly specified either as part of the
1406 * format string '%32b[l]' or through '%*b[l]', [l] selects
1407 * range-list format instead of hex format
1408 * - 'M' For a 6-byte MAC address, it prints the address in the
1409 * usual colon-separated hex notation
1410 * - 'm' For a 6-byte MAC address, it prints the hex address without colons
1411 * - 'MF' For a 6-byte MAC FDDI address, it prints the address
1412 * with a dash-separated hex notation
1413 * - '[mM]R' For a 6-byte MAC address, Reverse order (Bluetooth)
1414 * - 'I' [46] for IPv4/IPv6 addresses printed in the usual way
1415 * IPv4 uses dot-separated decimal without leading 0's (1.2.3.4)
1416 * IPv6 uses colon separated network-order 16 bit hex with leading 0's
1418 * Generic IPv4/IPv6 address (struct sockaddr *) that falls back to
1419 * [4] or [6] and is able to print port [p], flowinfo [f], scope [s]
1420 * - 'i' [46] for 'raw' IPv4/IPv6 addresses
1421 * IPv6 omits the colons (01020304...0f)
1422 * IPv4 uses dot-separated decimal with leading 0's (010.123.045.006)
1424 * Generic IPv4/IPv6 address (struct sockaddr *) that falls back to
1425 * [4] or [6] and is able to print port [p], flowinfo [f], scope [s]
1426 * - '[Ii][4S][hnbl]' IPv4 addresses in host, network, big or little endian order
1427 * - 'I[6S]c' for IPv6 addresses printed as specified by
1428 * http://tools.ietf.org/html/rfc5952
1429 * - 'E[achnops]' For an escaped buffer, where rules are defined by combination
1430 * of the following flags (see string_escape_mem() for the
1433 * c - ESCAPE_SPECIAL
1439 * By default ESCAPE_ANY_NP is used.
1440 * - 'U' For a 16 byte UUID/GUID, it prints the UUID/GUID in the form
1441 * "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
1442 * Options for %pU are:
1443 * b big endian lower case hex (default)
1444 * B big endian UPPER case hex
1445 * l little endian lower case hex
1446 * L little endian UPPER case hex
1447 * big endian output byte order is:
1448 * [0][1][2][3]-[4][5]-[6][7]-[8][9]-[10][11][12][13][14][15]
1449 * little endian output byte order is:
1450 * [3][2][1][0]-[5][4]-[7][6]-[8][9]-[10][11][12][13][14][15]
1451 * - 'V' For a struct va_format which contains a format string * and va_list *,
1452 * call vsnprintf(->format, *->va_list).
1453 * Implements a "recursive vsnprintf".
1454 * Do not use this feature without some mechanism to verify the
1455 * correctness of the format string and va_list arguments.
1456 * - 'K' For a kernel pointer that should be hidden from unprivileged users
1457 * - 'NF' For a netdev_features_t
1458 * - 'h[CDN]' For a variable-length buffer, it prints it as a hex string with
1459 * a certain separator (' ' by default):
1463 * The maximum supported length is 64 bytes of the input. Consider
1464 * to use print_hex_dump() for the larger input.
1465 * - 'a[pd]' For address types [p] phys_addr_t, [d] dma_addr_t and derivatives
1466 * (default assumed to be phys_addr_t, passed by reference)
1467 * - 'd[234]' For a dentry name (optionally 2-4 last components)
1468 * - 'D[234]' Same as 'd' but for a struct file
1469 * - 'g' For block_device name (gendisk + partition number)
1470 * - 'C' For a clock, it prints the name (Common Clock Framework) or address
1471 * (legacy clock framework) of the clock
1472 * - 'Cn' For a clock, it prints the name (Common Clock Framework) or address
1473 * (legacy clock framework) of the clock
1474 * - 'Cr' For a clock, it prints the current rate of the clock
1476 * ** Please update also Documentation/printk-formats.txt when making changes **
1478 * Note: The difference between 'S' and 'F' is that on ia64 and ppc64
1479 * function pointers are really function descriptors, which contain a
1480 * pointer to the real address.
1482 static noinline_for_stack
1483 char *pointer(const char *fmt, char *buf, char *end, void *ptr,
1484 struct printf_spec spec)
1486 const int default_width = 2 * sizeof(void *);
1488 if (!ptr && *fmt != 'K') {
1490 * Print (null) with the same width as a pointer so it makes
1491 * tabular output look nice.
1493 if (spec.field_width == -1)
1494 spec.field_width = default_width;
1495 return string(buf, end, "(null)", spec);
1501 ptr = dereference_function_descriptor(ptr);
1506 return symbol_string(buf, end, ptr, spec, fmt);
1509 return resource_string(buf, end, ptr, spec, fmt);
1511 return hex_string(buf, end, ptr, spec, fmt);
1515 return bitmap_list_string(buf, end, ptr, spec, fmt);
1517 return bitmap_string(buf, end, ptr, spec, fmt);
1519 case 'M': /* Colon separated: 00:01:02:03:04:05 */
1520 case 'm': /* Contiguous: 000102030405 */
1522 /* [mM]R (Reverse order; Bluetooth) */
1523 return mac_address_string(buf, end, ptr, spec, fmt);
1524 case 'I': /* Formatted IP supported
1526 * 6: 0001:0203:...:0708
1527 * 6c: 1::708 or 1::1.2.3.4
1529 case 'i': /* Contiguous:
1530 * 4: 001.002.003.004
1535 return ip6_addr_string(buf, end, ptr, spec, fmt);
1537 return ip4_addr_string(buf, end, ptr, spec, fmt);
1540 struct sockaddr raw;
1541 struct sockaddr_in v4;
1542 struct sockaddr_in6 v6;
1545 switch (sa->raw.sa_family) {
1547 return ip4_addr_string_sa(buf, end, &sa->v4, spec, fmt);
1549 return ip6_addr_string_sa(buf, end, &sa->v6, spec, fmt);
1551 return string(buf, end, "(invalid address)", spec);
1556 return escaped_string(buf, end, ptr, spec, fmt);
1558 return uuid_string(buf, end, ptr, spec, fmt);
1563 va_copy(va, *((struct va_format *)ptr)->va);
1564 buf += vsnprintf(buf, end > buf ? end - buf : 0,
1565 ((struct va_format *)ptr)->fmt, va);
1571 * %pK cannot be used in IRQ context because its test
1572 * for CAP_SYSLOG would be meaningless.
1574 if (kptr_restrict && (in_irq() || in_serving_softirq() ||
1576 if (spec.field_width == -1)
1577 spec.field_width = default_width;
1578 return string(buf, end, "pK-error", spec);
1581 switch (kptr_restrict) {
1583 /* Always print %pK values */
1587 * Only print the real pointer value if the current
1588 * process has CAP_SYSLOG and is running with the
1589 * same credentials it started with. This is because
1590 * access to files is checked at open() time, but %pK
1591 * checks permission at read() time. We don't want to
1592 * leak pointer values if a binary opens a file using
1593 * %pK and then elevates privileges before reading it.
1595 const struct cred *cred = current_cred();
1597 if (!has_capability_noaudit(current, CAP_SYSLOG) ||
1598 !uid_eq(cred->euid, cred->uid) ||
1599 !gid_eq(cred->egid, cred->gid))
1605 /* Always print 0's for %pK */
1614 return netdev_feature_string(buf, end, ptr, spec);
1618 return address_val(buf, end, ptr, spec, fmt);
1620 return dentry_name(buf, end, ptr, spec, fmt);
1622 return clock(buf, end, ptr, spec, fmt);
1624 return dentry_name(buf, end,
1625 ((const struct file *)ptr)->f_path.dentry,
1629 return bdev_name(buf, end, ptr, spec, fmt);
1633 spec.flags |= SMALL;
1634 if (spec.field_width == -1) {
1635 spec.field_width = default_width;
1636 spec.flags |= ZEROPAD;
1640 return number(buf, end, (unsigned long) ptr, spec);
1644 * Helper function to decode printf style format.
1645 * Each call decode a token from the format and return the
1646 * number of characters read (or likely the delta where it wants
1647 * to go on the next call).
1648 * The decoded token is returned through the parameters
1650 * 'h', 'l', or 'L' for integer fields
1651 * 'z' support added 23/7/1999 S.H.
1652 * 'z' changed to 'Z' --davidm 1/25/99
1653 * 't' added for ptrdiff_t
1655 * @fmt: the format string
1656 * @type of the token returned
1657 * @flags: various flags such as +, -, # tokens..
1658 * @field_width: overwritten width
1659 * @base: base of the number (octal, hex, ...)
1660 * @precision: precision of a number
1661 * @qualifier: qualifier of a number (long, size_t, ...)
1663 static noinline_for_stack
1664 int format_decode(const char *fmt, struct printf_spec *spec)
1666 const char *start = fmt;
1668 /* we finished early by reading the field width */
1669 if (spec->type == FORMAT_TYPE_WIDTH) {
1670 if (spec->field_width < 0) {
1671 spec->field_width = -spec->field_width;
1672 spec->flags |= LEFT;
1674 spec->type = FORMAT_TYPE_NONE;
1678 /* we finished early by reading the precision */
1679 if (spec->type == FORMAT_TYPE_PRECISION) {
1680 if (spec->precision < 0)
1681 spec->precision = 0;
1683 spec->type = FORMAT_TYPE_NONE;
1688 spec->type = FORMAT_TYPE_NONE;
1690 for (; *fmt ; ++fmt) {
1695 /* Return the current non-format string */
1696 if (fmt != start || !*fmt)
1702 while (1) { /* this also skips first '%' */
1708 case '-': spec->flags |= LEFT; break;
1709 case '+': spec->flags |= PLUS; break;
1710 case ' ': spec->flags |= SPACE; break;
1711 case '#': spec->flags |= SPECIAL; break;
1712 case '0': spec->flags |= ZEROPAD; break;
1713 default: found = false;
1720 /* get field width */
1721 spec->field_width = -1;
1724 spec->field_width = skip_atoi(&fmt);
1725 else if (*fmt == '*') {
1726 /* it's the next argument */
1727 spec->type = FORMAT_TYPE_WIDTH;
1728 return ++fmt - start;
1732 /* get the precision */
1733 spec->precision = -1;
1736 if (isdigit(*fmt)) {
1737 spec->precision = skip_atoi(&fmt);
1738 if (spec->precision < 0)
1739 spec->precision = 0;
1740 } else if (*fmt == '*') {
1741 /* it's the next argument */
1742 spec->type = FORMAT_TYPE_PRECISION;
1743 return ++fmt - start;
1748 /* get the conversion qualifier */
1749 spec->qualifier = -1;
1750 if (*fmt == 'h' || _tolower(*fmt) == 'l' ||
1751 _tolower(*fmt) == 'z' || *fmt == 't') {
1752 spec->qualifier = *fmt++;
1753 if (unlikely(spec->qualifier == *fmt)) {
1754 if (spec->qualifier == 'l') {
1755 spec->qualifier = 'L';
1757 } else if (spec->qualifier == 'h') {
1758 spec->qualifier = 'H';
1768 spec->type = FORMAT_TYPE_CHAR;
1769 return ++fmt - start;
1772 spec->type = FORMAT_TYPE_STR;
1773 return ++fmt - start;
1776 spec->type = FORMAT_TYPE_PTR;
1777 return ++fmt - start;
1780 spec->type = FORMAT_TYPE_PERCENT_CHAR;
1781 return ++fmt - start;
1783 /* integer number formats - set up the flags and "break" */
1789 spec->flags |= SMALL;
1797 spec->flags |= SIGN;
1803 * Since %n poses a greater security risk than
1804 * utility, treat it as any other invalid or
1805 * unsupported format specifier.
1810 WARN_ONCE(1, "Please remove unsupported %%%c in format string\n", *fmt);
1811 spec->type = FORMAT_TYPE_INVALID;
1815 if (spec->qualifier == 'L')
1816 spec->type = FORMAT_TYPE_LONG_LONG;
1817 else if (spec->qualifier == 'l') {
1818 BUILD_BUG_ON(FORMAT_TYPE_ULONG + SIGN != FORMAT_TYPE_LONG);
1819 spec->type = FORMAT_TYPE_ULONG + (spec->flags & SIGN);
1820 } else if (_tolower(spec->qualifier) == 'z') {
1821 spec->type = FORMAT_TYPE_SIZE_T;
1822 } else if (spec->qualifier == 't') {
1823 spec->type = FORMAT_TYPE_PTRDIFF;
1824 } else if (spec->qualifier == 'H') {
1825 BUILD_BUG_ON(FORMAT_TYPE_UBYTE + SIGN != FORMAT_TYPE_BYTE);
1826 spec->type = FORMAT_TYPE_UBYTE + (spec->flags & SIGN);
1827 } else if (spec->qualifier == 'h') {
1828 BUILD_BUG_ON(FORMAT_TYPE_USHORT + SIGN != FORMAT_TYPE_SHORT);
1829 spec->type = FORMAT_TYPE_USHORT + (spec->flags & SIGN);
1831 BUILD_BUG_ON(FORMAT_TYPE_UINT + SIGN != FORMAT_TYPE_INT);
1832 spec->type = FORMAT_TYPE_UINT + (spec->flags & SIGN);
1835 return ++fmt - start;
1839 * vsnprintf - Format a string and place it in a buffer
1840 * @buf: The buffer to place the result into
1841 * @size: The size of the buffer, including the trailing null space
1842 * @fmt: The format string to use
1843 * @args: Arguments for the format string
1845 * This function generally follows C99 vsnprintf, but has some
1846 * extensions and a few limitations:
1849 * %p* is handled by pointer()
1851 * See pointer() or Documentation/printk-formats.txt for more
1852 * extensive description.
1854 * ** Please update the documentation in both places when making changes **
1856 * The return value is the number of characters which would
1857 * be generated for the given input, excluding the trailing
1858 * '\0', as per ISO C99. If you want to have the exact
1859 * number of characters written into @buf as return value
1860 * (not including the trailing '\0'), use vscnprintf(). If the
1861 * return is greater than or equal to @size, the resulting
1862 * string is truncated.
1864 * If you're not already dealing with a va_list consider using snprintf().
1866 int vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
1868 unsigned long long num;
1870 struct printf_spec spec = {0};
1872 /* Reject out-of-range values early. Large positive sizes are
1873 used for unknown buffer sizes. */
1874 if (WARN_ON_ONCE(size > INT_MAX))
1880 /* Make sure end is always >= buf */
1887 const char *old_fmt = fmt;
1888 int read = format_decode(fmt, &spec);
1892 switch (spec.type) {
1893 case FORMAT_TYPE_NONE: {
1896 if (copy > end - str)
1898 memcpy(str, old_fmt, copy);
1904 case FORMAT_TYPE_WIDTH:
1905 spec.field_width = va_arg(args, int);
1908 case FORMAT_TYPE_PRECISION:
1909 spec.precision = va_arg(args, int);
1912 case FORMAT_TYPE_CHAR: {
1915 if (!(spec.flags & LEFT)) {
1916 while (--spec.field_width > 0) {
1923 c = (unsigned char) va_arg(args, int);
1927 while (--spec.field_width > 0) {
1935 case FORMAT_TYPE_STR:
1936 str = string(str, end, va_arg(args, char *), spec);
1939 case FORMAT_TYPE_PTR:
1940 str = pointer(fmt, str, end, va_arg(args, void *),
1942 while (isalnum(*fmt))
1946 case FORMAT_TYPE_PERCENT_CHAR:
1952 case FORMAT_TYPE_INVALID:
1954 * Presumably the arguments passed gcc's type
1955 * checking, but there is no safe or sane way
1956 * for us to continue parsing the format and
1957 * fetching from the va_list; the remaining
1958 * specifiers and arguments would be out of
1964 switch (spec.type) {
1965 case FORMAT_TYPE_LONG_LONG:
1966 num = va_arg(args, long long);
1968 case FORMAT_TYPE_ULONG:
1969 num = va_arg(args, unsigned long);
1971 case FORMAT_TYPE_LONG:
1972 num = va_arg(args, long);
1974 case FORMAT_TYPE_SIZE_T:
1975 if (spec.flags & SIGN)
1976 num = va_arg(args, ssize_t);
1978 num = va_arg(args, size_t);
1980 case FORMAT_TYPE_PTRDIFF:
1981 num = va_arg(args, ptrdiff_t);
1983 case FORMAT_TYPE_UBYTE:
1984 num = (unsigned char) va_arg(args, int);
1986 case FORMAT_TYPE_BYTE:
1987 num = (signed char) va_arg(args, int);
1989 case FORMAT_TYPE_USHORT:
1990 num = (unsigned short) va_arg(args, int);
1992 case FORMAT_TYPE_SHORT:
1993 num = (short) va_arg(args, int);
1995 case FORMAT_TYPE_INT:
1996 num = (int) va_arg(args, int);
1999 num = va_arg(args, unsigned int);
2002 str = number(str, end, num, spec);
2014 /* the trailing null byte doesn't count towards the total */
2018 EXPORT_SYMBOL(vsnprintf);
2021 * vscnprintf - Format a string and place it in a buffer
2022 * @buf: The buffer to place the result into
2023 * @size: The size of the buffer, including the trailing null space
2024 * @fmt: The format string to use
2025 * @args: Arguments for the format string
2027 * The return value is the number of characters which have been written into
2028 * the @buf not including the trailing '\0'. If @size is == 0 the function
2031 * If you're not already dealing with a va_list consider using scnprintf().
2033 * See the vsnprintf() documentation for format string extensions over C99.
2035 int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
2039 i = vsnprintf(buf, size, fmt, args);
2041 if (likely(i < size))
2047 EXPORT_SYMBOL(vscnprintf);
2050 * snprintf - Format a string and place it in a buffer
2051 * @buf: The buffer to place the result into
2052 * @size: The size of the buffer, including the trailing null space
2053 * @fmt: The format string to use
2054 * @...: Arguments for the format string
2056 * The return value is the number of characters which would be
2057 * generated for the given input, excluding the trailing null,
2058 * as per ISO C99. If the return is greater than or equal to
2059 * @size, the resulting string is truncated.
2061 * See the vsnprintf() documentation for format string extensions over C99.
2063 int snprintf(char *buf, size_t size, const char *fmt, ...)
2068 va_start(args, fmt);
2069 i = vsnprintf(buf, size, fmt, args);
2074 EXPORT_SYMBOL(snprintf);
2077 * scnprintf - Format a string and place it in a buffer
2078 * @buf: The buffer to place the result into
2079 * @size: The size of the buffer, including the trailing null space
2080 * @fmt: The format string to use
2081 * @...: Arguments for the format string
2083 * The return value is the number of characters written into @buf not including
2084 * the trailing '\0'. If @size is == 0 the function returns 0.
2087 int scnprintf(char *buf, size_t size, const char *fmt, ...)
2092 va_start(args, fmt);
2093 i = vscnprintf(buf, size, fmt, args);
2098 EXPORT_SYMBOL(scnprintf);
2101 * vsprintf - Format a string and place it in a buffer
2102 * @buf: The buffer to place the result into
2103 * @fmt: The format string to use
2104 * @args: Arguments for the format string
2106 * The function returns the number of characters written
2107 * into @buf. Use vsnprintf() or vscnprintf() in order to avoid
2110 * If you're not already dealing with a va_list consider using sprintf().
2112 * See the vsnprintf() documentation for format string extensions over C99.
2114 int vsprintf(char *buf, const char *fmt, va_list args)
2116 return vsnprintf(buf, INT_MAX, fmt, args);
2118 EXPORT_SYMBOL(vsprintf);
2121 * sprintf - Format a string and place it in a buffer
2122 * @buf: The buffer to place the result into
2123 * @fmt: The format string to use
2124 * @...: Arguments for the format string
2126 * The function returns the number of characters written
2127 * into @buf. Use snprintf() or scnprintf() in order to avoid
2130 * See the vsnprintf() documentation for format string extensions over C99.
2132 int sprintf(char *buf, const char *fmt, ...)
2137 va_start(args, fmt);
2138 i = vsnprintf(buf, INT_MAX, fmt, args);
2143 EXPORT_SYMBOL(sprintf);
2145 #ifdef CONFIG_BINARY_PRINTF
2148 * vbin_printf() - VA arguments to binary data
2149 * bstr_printf() - Binary data to text string
2153 * vbin_printf - Parse a format string and place args' binary value in a buffer
2154 * @bin_buf: The buffer to place args' binary value
2155 * @size: The size of the buffer(by words(32bits), not characters)
2156 * @fmt: The format string to use
2157 * @args: Arguments for the format string
2159 * The format follows C99 vsnprintf, except %n is ignored, and its argument
2162 * The return value is the number of words(32bits) which would be generated for
2166 * If the return value is greater than @size, the resulting bin_buf is NOT
2167 * valid for bstr_printf().
2169 int vbin_printf(u32 *bin_buf, size_t size, const char *fmt, va_list args)
2171 struct printf_spec spec = {0};
2174 str = (char *)bin_buf;
2175 end = (char *)(bin_buf + size);
2177 #define save_arg(type) \
2179 if (sizeof(type) == 8) { \
2180 unsigned long long value; \
2181 str = PTR_ALIGN(str, sizeof(u32)); \
2182 value = va_arg(args, unsigned long long); \
2183 if (str + sizeof(type) <= end) { \
2184 *(u32 *)str = *(u32 *)&value; \
2185 *(u32 *)(str + 4) = *((u32 *)&value + 1); \
2188 unsigned long value; \
2189 str = PTR_ALIGN(str, sizeof(type)); \
2190 value = va_arg(args, int); \
2191 if (str + sizeof(type) <= end) \
2192 *(typeof(type) *)str = (type)value; \
2194 str += sizeof(type); \
2198 int read = format_decode(fmt, &spec);
2202 switch (spec.type) {
2203 case FORMAT_TYPE_NONE:
2204 case FORMAT_TYPE_PERCENT_CHAR:
2206 case FORMAT_TYPE_INVALID:
2209 case FORMAT_TYPE_WIDTH:
2210 case FORMAT_TYPE_PRECISION:
2214 case FORMAT_TYPE_CHAR:
2218 case FORMAT_TYPE_STR: {
2219 const char *save_str = va_arg(args, char *);
2222 if ((unsigned long)save_str > (unsigned long)-PAGE_SIZE
2223 || (unsigned long)save_str < PAGE_SIZE)
2224 save_str = "(null)";
2225 len = strlen(save_str) + 1;
2226 if (str + len < end)
2227 memcpy(str, save_str, len);
2232 case FORMAT_TYPE_PTR:
2234 /* skip all alphanumeric pointer suffixes */
2235 while (isalnum(*fmt))
2240 switch (spec.type) {
2242 case FORMAT_TYPE_LONG_LONG:
2243 save_arg(long long);
2245 case FORMAT_TYPE_ULONG:
2246 case FORMAT_TYPE_LONG:
2247 save_arg(unsigned long);
2249 case FORMAT_TYPE_SIZE_T:
2252 case FORMAT_TYPE_PTRDIFF:
2253 save_arg(ptrdiff_t);
2255 case FORMAT_TYPE_UBYTE:
2256 case FORMAT_TYPE_BYTE:
2259 case FORMAT_TYPE_USHORT:
2260 case FORMAT_TYPE_SHORT:
2270 return (u32 *)(PTR_ALIGN(str, sizeof(u32))) - bin_buf;
2273 EXPORT_SYMBOL_GPL(vbin_printf);
2276 * bstr_printf - Format a string from binary arguments and place it in a buffer
2277 * @buf: The buffer to place the result into
2278 * @size: The size of the buffer, including the trailing null space
2279 * @fmt: The format string to use
2280 * @bin_buf: Binary arguments for the format string
2282 * This function like C99 vsnprintf, but the difference is that vsnprintf gets
2283 * arguments from stack, and bstr_printf gets arguments from @bin_buf which is
2284 * a binary buffer that generated by vbin_printf.
2286 * The format follows C99 vsnprintf, but has some extensions:
2287 * see vsnprintf comment for details.
2289 * The return value is the number of characters which would
2290 * be generated for the given input, excluding the trailing
2291 * '\0', as per ISO C99. If you want to have the exact
2292 * number of characters written into @buf as return value
2293 * (not including the trailing '\0'), use vscnprintf(). If the
2294 * return is greater than or equal to @size, the resulting
2295 * string is truncated.
2297 int bstr_printf(char *buf, size_t size, const char *fmt, const u32 *bin_buf)
2299 struct printf_spec spec = {0};
2301 const char *args = (const char *)bin_buf;
2303 if (WARN_ON_ONCE(size > INT_MAX))
2309 #define get_arg(type) \
2311 typeof(type) value; \
2312 if (sizeof(type) == 8) { \
2313 args = PTR_ALIGN(args, sizeof(u32)); \
2314 *(u32 *)&value = *(u32 *)args; \
2315 *((u32 *)&value + 1) = *(u32 *)(args + 4); \
2317 args = PTR_ALIGN(args, sizeof(type)); \
2318 value = *(typeof(type) *)args; \
2320 args += sizeof(type); \
2324 /* Make sure end is always >= buf */
2331 const char *old_fmt = fmt;
2332 int read = format_decode(fmt, &spec);
2336 switch (spec.type) {
2337 case FORMAT_TYPE_NONE: {
2340 if (copy > end - str)
2342 memcpy(str, old_fmt, copy);
2348 case FORMAT_TYPE_WIDTH:
2349 spec.field_width = get_arg(int);
2352 case FORMAT_TYPE_PRECISION:
2353 spec.precision = get_arg(int);
2356 case FORMAT_TYPE_CHAR: {
2359 if (!(spec.flags & LEFT)) {
2360 while (--spec.field_width > 0) {
2366 c = (unsigned char) get_arg(char);
2370 while (--spec.field_width > 0) {
2378 case FORMAT_TYPE_STR: {
2379 const char *str_arg = args;
2380 args += strlen(str_arg) + 1;
2381 str = string(str, end, (char *)str_arg, spec);
2385 case FORMAT_TYPE_PTR:
2386 str = pointer(fmt, str, end, get_arg(void *), spec);
2387 while (isalnum(*fmt))
2391 case FORMAT_TYPE_PERCENT_CHAR:
2397 case FORMAT_TYPE_INVALID:
2401 unsigned long long num;
2403 switch (spec.type) {
2405 case FORMAT_TYPE_LONG_LONG:
2406 num = get_arg(long long);
2408 case FORMAT_TYPE_ULONG:
2409 case FORMAT_TYPE_LONG:
2410 num = get_arg(unsigned long);
2412 case FORMAT_TYPE_SIZE_T:
2413 num = get_arg(size_t);
2415 case FORMAT_TYPE_PTRDIFF:
2416 num = get_arg(ptrdiff_t);
2418 case FORMAT_TYPE_UBYTE:
2419 num = get_arg(unsigned char);
2421 case FORMAT_TYPE_BYTE:
2422 num = get_arg(signed char);
2424 case FORMAT_TYPE_USHORT:
2425 num = get_arg(unsigned short);
2427 case FORMAT_TYPE_SHORT:
2428 num = get_arg(short);
2430 case FORMAT_TYPE_UINT:
2431 num = get_arg(unsigned int);
2437 str = number(str, end, num, spec);
2439 } /* switch(spec.type) */
2452 /* the trailing null byte doesn't count towards the total */
2455 EXPORT_SYMBOL_GPL(bstr_printf);
2458 * bprintf - Parse a format string and place args' binary value in a buffer
2459 * @bin_buf: The buffer to place args' binary value
2460 * @size: The size of the buffer(by words(32bits), not characters)
2461 * @fmt: The format string to use
2462 * @...: Arguments for the format string
2464 * The function returns the number of words(u32) written
2467 int bprintf(u32 *bin_buf, size_t size, const char *fmt, ...)
2472 va_start(args, fmt);
2473 ret = vbin_printf(bin_buf, size, fmt, args);
2478 EXPORT_SYMBOL_GPL(bprintf);
2480 #endif /* CONFIG_BINARY_PRINTF */
2483 * vsscanf - Unformat a buffer into a list of arguments
2484 * @buf: input buffer
2485 * @fmt: format of buffer
2488 int vsscanf(const char *buf, const char *fmt, va_list args)
2490 const char *str = buf;
2498 unsigned long long u;
2504 /* skip any white space in format */
2505 /* white space in format matchs any amount of
2506 * white space, including none, in the input.
2508 if (isspace(*fmt)) {
2509 fmt = skip_spaces(++fmt);
2510 str = skip_spaces(str);
2513 /* anything that is not a conversion must match exactly */
2514 if (*fmt != '%' && *fmt) {
2515 if (*fmt++ != *str++)
2524 /* skip this conversion.
2525 * advance both strings to next white space
2530 while (!isspace(*fmt) && *fmt != '%' && *fmt)
2532 while (!isspace(*str) && *str)
2537 /* get field width */
2539 if (isdigit(*fmt)) {
2540 field_width = skip_atoi(&fmt);
2541 if (field_width <= 0)
2545 /* get conversion qualifier */
2547 if (*fmt == 'h' || _tolower(*fmt) == 'l' ||
2548 _tolower(*fmt) == 'z') {
2550 if (unlikely(qualifier == *fmt)) {
2551 if (qualifier == 'h') {
2554 } else if (qualifier == 'l') {
2565 /* return number of characters read so far */
2566 *va_arg(args, int *) = str - buf;
2580 char *s = (char *)va_arg(args, char*);
2581 if (field_width == -1)
2585 } while (--field_width > 0 && *str);
2591 char *s = (char *)va_arg(args, char *);
2592 if (field_width == -1)
2593 field_width = SHRT_MAX;
2594 /* first, skip leading white space in buffer */
2595 str = skip_spaces(str);
2597 /* now copy until next white space */
2598 while (*str && !isspace(*str) && field_width--)
2618 /* looking for '%' in str */
2623 /* invalid format; stop here */
2627 /* have some sort of integer conversion.
2628 * first, skip white space in buffer.
2630 str = skip_spaces(str);
2633 if (is_sign && digit == '-')
2637 || (base == 16 && !isxdigit(digit))
2638 || (base == 10 && !isdigit(digit))
2639 || (base == 8 && (!isdigit(digit) || digit > '7'))
2640 || (base == 0 && !isdigit(digit)))
2644 val.s = qualifier != 'L' ?
2645 simple_strtol(str, &next, base) :
2646 simple_strtoll(str, &next, base);
2648 val.u = qualifier != 'L' ?
2649 simple_strtoul(str, &next, base) :
2650 simple_strtoull(str, &next, base);
2652 if (field_width > 0 && next - str > field_width) {
2654 _parse_integer_fixup_radix(str, &base);
2655 while (next - str > field_width) {
2657 val.s = div_s64(val.s, base);
2659 val.u = div_u64(val.u, base);
2664 switch (qualifier) {
2665 case 'H': /* that's 'hh' in format */
2667 *va_arg(args, signed char *) = val.s;
2669 *va_arg(args, unsigned char *) = val.u;
2673 *va_arg(args, short *) = val.s;
2675 *va_arg(args, unsigned short *) = val.u;
2679 *va_arg(args, long *) = val.s;
2681 *va_arg(args, unsigned long *) = val.u;
2685 *va_arg(args, long long *) = val.s;
2687 *va_arg(args, unsigned long long *) = val.u;
2691 *va_arg(args, size_t *) = val.u;
2695 *va_arg(args, int *) = val.s;
2697 *va_arg(args, unsigned int *) = val.u;
2709 EXPORT_SYMBOL(vsscanf);
2712 * sscanf - Unformat a buffer into a list of arguments
2713 * @buf: input buffer
2714 * @fmt: formatting of buffer
2715 * @...: resulting arguments
2717 int sscanf(const char *buf, const char *fmt, ...)
2722 va_start(args, fmt);
2723 i = vsscanf(buf, fmt, args);
2728 EXPORT_SYMBOL(sscanf);